3
گa�! � @ s� U d Z ddlZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z dd l
m Z dd
l
m Z dd l
m
Z
dd lmZ ddlm Z eje�Zejdd
�dd�Zeee d�dd�Zeedd�dd�Zejdd
�dd�Ze � Z ee edd�dd�Z ejdd
�dd �Z g Z ee edd�d d �Z!dd �d d!�Z"ejee edd"�d#d$�Z#ejee edd"�d%d&�Z$eee ee%dd'�d(d)�Z&eeed*�d+d,�Z'eee d-�d.d/�Z(dS )0z;Facilities for implementing hooks that call shell commands.� N)�List)�Optional)�Set)�
configuration)�errors)�util)�
filesystem)�misc)�os)�ops)�config�returnc C s4 t | jd� t | jd� t | jd� t | jd� dS )z#Check hook commands are executable.ZpreZpostZdeploy�renewN)�
validate_hook�pre_hook� post_hook� deploy_hook�
renew_hook)r � r �/usr/lib/python3.6/hooks.py�validate_hooks s r )� shell_cmdr
c C s. t j| �s"tj| � t j| �s"dS tjj| �S )z�Extract the program run by a shell command.
:param str shell_cmd: command to be executed
:returns: basename of command or None if the command isn't found
:rtype: str or None
N)r Z
exe_exists� plug_utilZ path_surgeryr
�path�basename)r r r r �_prog s
r )r � hook_namer
c C s\ | rX| j dd�d }t|�sXtjd }tjj|�r@dj||�}ndj|||�}tj|��dS )z�Check that a command provided as a hook is plausibly executable.
:raises .errors.HookCommandNotFound: if the command is not found
N� r �PATHz3{1}-hook command {0} exists, but is not executable.z>Unable to find {2}-hook command {0} in the PATH.
(PATH is {1})) �splitr r
�environr �exists�formatr ZHookCommandNotFound)r r �cmdr �msgr r r r - s
r c C sB | j dkr,| jr,xt| j�D ] }t|� q W | j}|r>t|� dS )a� Run pre-hooks if they exist and haven't already been run.
When Certbot is running with the renew subcommand, this function
runs any hooks found in the config.renewal_pre_hooks_dir (if they
have not already been run) followed by any pre-hook in the config.
If hooks in config.renewal_pre_hooks_dir are run and the pre-hook in
the config is a path to one of these scripts, it is not run twice.
:param configuration.NamespaceConfig config: Certbot settings
r N)�verb�directory_hooks�
list_hooksZrenewal_pre_hooks_dir�_run_pre_hook_if_necessaryr )r �hookr# r r r r ? s r )�commandr
c C s. | t krtjd| � ntd| � t j| � dS )z�Run the specified pre-hook if we haven't already.
If we've already run this exact command before, a message is logged
saying the pre-hook was skipped.
:param str command: pre-hook to be run
z*Pre-hook command already run, skipping: %szpre-hookN)�executed_pre_hooks�logger�info� _run_hook�add)r* r r r r( W s
r( c C sR | j }| jdkr@| jr2xt| j�D ] }t|� q"W |rNt|� n|rNtd|� dS )a� Run post-hooks if defined.
This function also registers any executables found in
config.renewal_post_hooks_dir to be run when Certbot is used with
the renew subcommand.
If the verb is renew, we delay executing any post-hooks until
:func:`run_saved_post_hooks` is called. In this case, this function
registers all hooks found in config.renewal_post_hooks_dir to be
called followed by any post-hook in the config. If the post-hook in
the config is a path to an executable in the post-hook directory, it
is not scheduled to be run twice.
:param configuration.NamespaceConfig config: Certbot settings
r z post-hookN)r r% r& r' Zrenewal_post_hooks_dir�_run_eventuallyr. )r r# r) r r r r g s
r c C s | t krt j| � dS )z�Registers a post-hook to be run eventually.
All commands given to this function will be run exactly once in the
order they were given when :func:`run_saved_post_hooks` is called.
:param str command: post-hook to register to be run
N)�
post_hooks�append)r* r r r r0 � s r0 )r
c C s xt D ]} td| � qW dS )zGRun any post hooks that were saved up in the course of the 'renew' verbz post-hookN)r1 r. )r# r r r �run_saved_post_hooks� s
r3 )r �domains� lineage_pathr
c C s | j rt| j ||| j� dS )a Run post-issuance hook if defined.
:param configuration.NamespaceConfig config: Certbot settings
:param domains: domains in the obtained certificate
:type domains: `list` of `str`
:param str lineage_path: live directory path for the new cert
N)r �_run_deploy_hook�dry_run)r r4 r5 r r r r � s
r c C sp t � }| jr:x,t| j�D ] }t|||| j� |j|� qW | jrl| j|krZtj d| j� nt| j||| j� dS )a] Run post-renewal hooks.
This function runs any hooks found in
config.renewal_deploy_hooks_dir followed by any renew-hook in the
config. If the renew-hook in the config is a path to a script in
config.renewal_deploy_hooks_dir, it is not run twice.
If Certbot is doing a dry run, no hooks are run and messages are
logged saying that they were skipped.
:param configuration.NamespaceConfig config: Certbot settings
:param domains: domains in the obtained certificate
:type domains: `list` of `str`
:param str lineage_path: live directory path for the new cert
z0Skipping deploy-hook '%s' as it was already run.N)
�setr& r' Zrenewal_deploy_hooks_dirr6 r7 r/ r r, r- )r r4 r5 Zexecuted_dir_hooksr) r r r r � s
r )r* r4 r5 r7 r
c C s< |rt jd| � dS dj|�tjd< |tjd< td| � dS )a Run the specified deploy-hook (if not doing a dry run).
If dry_run is True, command is not run and a message is logged
saying that it was skipped. If dry_run is False, the hook is run
after setting the appropriate environment variables.
:param str command: command to run as a deploy-hook
:param domains: domains in the obtained certificate
:type domains: `list` of `str`
:param str lineage_path: live directory path for the new cert
:param bool dry_run: True iff Certbot is doing a dry run
z)Dry run: skipping deploy hook command: %sN� ZRENEWED_DOMAINSZRENEWED_LINEAGEz deploy-hook)r, r- �joinr
r r. )r* r4 r5 r7 r r r r6 � s
r6 )�cmd_namer r
c C s6 t j| |tj� d�\}}}tjd| � d�|||� |S )z�Run a hook command.
:param str cmd_name: the user facing name of the hook being run
:param shell_cmd: shell command to execute
:type shell_cmd: `list` of `str` or `str`
:returns: stderr if there was any)�envzHook '�')r Zexecute_command_statusr Z env_no_snap_for_external_calls� display_opsZreport_executed_command)r; r �
returncode�err�outr r r r. � s r. )�dir_pathr
c s. � fdd�t j� �D �}dd� |D �}t|�S )z�List paths to all hooks found in dir_path in sorted order.
:param str dir_path: directory to search
:returns: `list` of `str`
:rtype: sorted list of absolute paths to executables in dir_path
c 3 s | ]}t jj� |�V qd S )N)r
r r: )�.0�f)rB r r � <genexpr>� s z list_hooks.<locals>.<genexpr>c S s& g | ] }t j|�r|jd � r|�qS )�~)r Z
is_executable�endswith)rC r r r r �
<listcomp>� s z list_hooks.<locals>.<listcomp>)r
�listdir�sorted)rB ZallpathsZhooksr )rB r r' � s r' ))�__doc__ZloggingZtypingr r r Zcertbotr r r Zcertbot.compatr r r
Zcertbot.displayr r> Zcertbot.pluginsr Z getLogger�__name__r, ZNamespaceConfigr �strr r r r8 r+ r( r r1 r0 r3 r r �boolr6 r. r' r r r r �<module> s<