a
}|g, @ s0 d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z dd lm
Z
dd
lm Z dd lm Z dd lm
Z
dd
lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ejdkrddlmZ nddlZe e Z ej ej ej!gZ"G dd dZ#G dd de
Z$dS )z.Utilities for plugins discovery and selection. N)Callable)cast)Dict)Iterable)Iterator)List)Mapping)Optional)Type)Union)
configuration)errors)
interfaces) constants)os)Error)
c @ sV e Zd ZdZdZejddddZee e
dddZ e eje dd d
Z
ee d d d
Zee d ddZee d ddZee
d ddZee e
dddZee
d ddZd*eej ejdddZee
d d d Z e e
e f d d d Z ee
d d d!Z eee! d d"d#Z"ee
d d$d%Z#e d d&d'Z$e d d(d)Z%dS )+PluginEntryPointzPlugin entry point.N) entry_pointreturnc C s2 | || _| | _|| _d | _d | _d | _d S N)entry_point_to_plugin_namenameload
plugin_clsr Zwarning_message _initialized _prepared)selfr r C/usr/lib/python3.9/site-packages/certbot/_internal/plugins/disco.py__init__( s
zPluginEntryPoint.__init__r r c C s || j krdS dS )z(Check if the name refers to this plugin.TFr r r r r r
check_name0 s
zPluginEntryPoint.check_namec C s |j S )z)Unique plugin name for an ``entry_point``r# )clsr r r r r 6 s z+PluginEntryPoint.entry_point_to_plugin_namer c C s | j jS )zDescription of the plugin.)r descriptionr r r r r( ; s z PluginEntryPoint.descriptionc C s d | j| jS )z$Description with name. Handy for UI.z {0} ({1}))formatr( r r) r r r description_with_name@ s z&PluginEntryPoint.description_with_namec C s t | jd| jS )z Long description of the plugin.long_description)getattrr r( r) r r r r, E s z!PluginEntryPoint.long_descriptionc C s t | jddS )z%Should this plugin be hidden from UI?hiddenF)r- r r) r r r r. J s zPluginEntryPoint.hidden
ifaces_groupsr c s | pt fdd|D S )z1Does plugin implement specified interface groups?c 3 s$ | ] }t fd d|D V qdS )c 3 s | ]}t j|V qd S r )
issubclassr .0Zifacer) r r R s z4PluginEntryPoint.ifaces...N)all)r3 ifacesr) r r r4 Q s z*PluginEntryPoint.ifaces..)anyr r0 r r) r r6 O s zPluginEntryPoint.ifacesc C s
| j duS )z(Has the plugin been initialized already?N)r r) r r r initializedV s z PluginEntryPoint.initializedconfigr c C s | j s| || j| _ | j S )z Memoized plugin initialization.)r r r r r; r r r init[ s zPluginEntryPoint.initc C s | j std| | jduS )z%Has the plugin been prepared already?z$.prepared called on uninitialized %rN)r9 loggerdebugr r) r r r preparedc s zPluginEntryPoint.preparedc
C s | j du rtd| jdu rz| j W n tjyh } z$tjd| |dd || _W Y d}~nd}~0 tjy } z$tjd| |dd || _W Y d}~nLd}~0 tj y } z$tjd| |dd || _W Y d}~nd}~0 0 d| _t
t t t
f | jS )z Memoized plugin preparation.NzPlugin is not initialized.zMisconfigured %r: %sT)exc_infozNo installation (%r): %szOther error:(%r): %s)r
ValueErrorr preparer
MisconfigurationErrorr> r? ZNoInstallationError PluginErrorr r boolr )r errorr r r rC j s$
zPluginEntryPoint.preparec C s t | jtjS )zIs plugin misconfigured?)
isinstancer r
rD r) r r r
misconfigured s z PluginEntryPoint.misconfiguredc C s t | jtr| jS dS )zGReturn the Exception raised during plugin setup, or None if all is wellN)rH r Exceptionr) r r r problem s zPluginEntryPoint.problemc C s | j du p| jS )z4Is plugin available, i.e. prepared or misconfigured?T)r rI r) r r r available s zPluginEntryPoint.availablec C s d | jS )NzPluginEntryPoint#{0})r* r r) r r r __repr__ s zPluginEntryPoint.__repr__c s~ d jd jjd d fddtD d jg} jrt|d j
rt|d d
|S ) Nz* {0}zDescription: {0}zInterfaces: {0}z, c 3 s | ]}t j|r|jV qd S r )r1 r __name__r2 r) r r r4 s z+PluginEntryPoint.__str__..zEntry point: {0}zInitialized: {0}z Prep: {0}
) r* r r r( joinPLUGIN_INTERFACESr r9 appendr= r@ rC )r linesr r) r __str__ s
zPluginEntryPoint.__str__)N)&rN
__module__ __qualname____doc____hash__importlib_metadata
EntryPointr! r strrF r% classmethodr propertyr( r+ r, r. r r
r6 r9 r NamespaceConfigr Pluginr= r@ r r rC rI rJ rK rL rM rT r r r r r " s: r c @ s8 e Zd ZdZeeef ddddZed dddZ ee
j e eef dd d
d Z
eed d
dZee dddZedddZejeej dddZeegef d dddZd dddZ e e d dd d Z ee ee!f dd d Z"d dd d!Z#eje$e d"d#d$Z%edd%d&Z&edd'd(Z'dS ))PluginsRegistryzPlugins registry.N)pluginsr c C s t t| | _d S r )dictsorteditems_plugins)r ra r r r r! s zPluginsRegistry.__init__r' c C s i }t d}|r |dng }tj| ttjt j
d}ttjt j d}|| D ]V}z| || W qX t
y } z(td|j d| d|W Y d}~qXd}~0 0 qX| |S )zFind plugins using Python package entry points.
See https://packaging.python.org/en/latest/specifications/entry-points/ for more info on
entry points.
ZCERTBOT_PLUGIN_PATH:)groupzThe 'z ' plugin errored while loading: z. You may need to remove or update this plugin. The Certbot log will contain the full error details and this should be reported to the plugin developer.N)r getenvsplitsyspathextendlistrY entry_pointsr Z SETUPTOOLS_PLUGINS_ENTRY_POINTZ"OLD_SETUPTOOLS_PLUGINS_ENTRY_POINT_load_entry_pointrJ r
rE module)r& ra Zplugin_paths_stringZ plugin_pathsrn Zold_entry_pointsr er r r find_all s(
zPluginsRegistry.find_all)r ra r c C s t |}|j|v rd||j }|jj}|jj}|r:|j nd}|rL|j nd}td|j||t|jt j
r~|||j< n t d| d S )Nunknownz+Duplicate plugin name {0} from {1} and {2}.z)%r does not inherit from Plugin, skipping)
r r r ZdistlowerrJ r* r1 r r r_ r> Zwarning) r& r ra plugin_epZother_epZ plugin1_distZ plugin2_distZplugin1Zplugin2r r r ro s
z!PluginsRegistry._load_entry_pointr" c C s
| j | S r )re r$ r r r __getitem__ s zPluginsRegistry.__getitem__c C s
t | jS r )iterre r) r r r __iter__ s zPluginsRegistry.__iter__c C s
t | jS r )lenre r) r r r __len__ s zPluginsRegistry.__len__r: c s fdd| j D S )z'Initialize all plugins in the registry.c s g | ]}| qS r )r= r3 ru r; r r
z(PluginsRegistry.init..re valuesr< r r| r r= s
zPluginsRegistry.init)predr c s t | fdd| j D S )z"Filter plugins based on predicate.c s i | ]\}} |r||qS r r )r3 r ru r r r
s z*PluginsRegistry.filter..)typere rd )r r r r r filter s zPluginsRegistry.filterc C s | dd S )z#Filter plugins based on visibility.c S s | j S r )r. )ru r r r r~ z)PluginsRegistry.visible..r r) r r r visible s zPluginsRegistry.visibler/ c s | fddS )z#Filter plugins based on interfaces.c s
| j S r )r6 p_epr0 r r r r~ z(PluginsRegistry.ifaces..r r8 r r r r6 s zPluginsRegistry.ifacesc C s dd | j D S )z$Prepare all plugins in the registry.c S s g | ] }| qS r )rC r{ r r r r} r~ z+PluginsRegistry.prepare..r r) r r r rC s zPluginsRegistry.preparec C s | dd S )z%Filter plugins based on availability.c S s | j S r )rL r r r r r r~ z+PluginsRegistry.available..r r) r r r rL s zPluginsRegistry.available)pluginr c s( fdd| j D }|r$|d S dS )aM Find an initialized plugin.
This is particularly useful for finding a name for the plugin::
# plugin is an instance providing Plugin, initialized
# somewhere else in the code
plugin_registry.find_init(plugin).name
Returns ``None`` if ``plugin`` is not found in the registry.
c s" g | ]}|j r| u r|qS r )r9 r= r{ r r r r} s z-PluginsRegistry.find_init..r Nr )r r Z
candidatesr r r find_init s
zPluginsRegistry.find_initc C s& d | jjddd | j D S )Nz{0}({1}),c s s | ]}t |V qd S r )reprr3 r r r r r4 s z+PluginsRegistry.__repr__..)r* __class__rN rP re r r) r r r rM s
zPluginsRegistry.__repr__c C s$ | j s
dS ddd | j D S )Nz
No pluginsz
c s s | ]}t |V qd S r )r[ r r r r r4 r~ z*PluginsRegistry.__str__..)re rP r r) r r r rT s zPluginsRegistry.__str__)(rN rU rV rW r r[ r r! r\ rr rY rZ r ro rv r rx intrz r r^ r r r_ r= r rF r r r r
r6 r r rC rL r r rM rT r r r r r` s( r` )%rW Zloggingrj typingr r r r r r r r r
r Zcertbotr r
r Zcertbot._internalr Zcertbot.compatr Zcertbot.errorsr version_infoimportlib.metadatametadatarY Z getLoggerrN r> Z
AuthenticatorZ Installerr_ rQ r r` r r r r s4