|
Server : Apache/2.4.41 (Ubuntu) System : Linux vmi1525618.contaboserver.net 5.4.0-105-generic #119-Ubuntu SMP Mon Mar 7 18:49:24 UTC 2022 x86_64 User : www-data ( 33) PHP Version : 8.2.12 Disable Function : NONE Directory : /lib/python3/dist-packages/certbot/__pycache__/ |
Upload File : |
U
�]�_ � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z ddl m
Z
ddl mZ ddl mZ ddl mZ ddlmZ ddlmZ e�e�ZG d d
� d
e�ZdS ) zGReverter class saves configuration checkpoints and allows for recovery.� N)� constants)�errors)�
interfaces)�util)�os)�
filesystemc @ s� e Zd ZdZdd� Zdd� Zd*dd�Zd d
� Zd d � Zd
d� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)S )+�Reverteraf Reverter Class - save and revert configuration checkpoints.
This class can be used by the plugins, especially Installers, to
undo changes made to the user's system. Modifications to files and
commands to do undo actions taken by the plugin should be registered
with this class before the action is taken.
Once a change has been registered with this class, there are three
states the change can be in. First, the change can be a temporary
change. This should be used for changes that will soon be reverted,
such as config changes for the purpose of solving a challenge.
Changes are added to this state through calls to
:func:`~add_to_temp_checkpoint` and reverted when
:func:`~revert_temporary_config` or :func:`~recovery_routine` is
called.
The second state a change can be in is in progress. These changes
are not temporary, however, they also have not been finalized in a
checkpoint. A change must become in progress before it can be
finalized. Changes are added to this state through calls to
:func:`~add_to_checkpoint` and reverted when
:func:`~recovery_routine` is called.
The last state a change can be in is finalized in a checkpoint. A
change is put into this state by first becoming an in progress
change and then calling :func:`~finalize_checkpoint`. Changes
in this state can be reverted through calls to
:func:`~rollback_checkpoints`.
As a final note, creating new files and registering undo commands
are handled specially and use the methods
:func:`~register_file_creation` and :func:`~register_undo_command`
respectively. Both of these methods can be used to create either
temporary or in progress changes.
.. note:: Consider moving everything over to CSV format.
:param config: Configuration.
:type config: :class:`certbot.interfaces.IConfig`
c C s || _ t�|jtj| j j� d S )N)�configr �make_or_verify_dir�
backup_dirr �CONFIG_DIRS_MODE�strict_permissions)�selfr � r �2/usr/lib/python3/dist-packages/certbot/reverter.py�__init__B s �zReverter.__init__c C sX t j�| jj�rTz| �| jj� W n0 tjk
rR t� d| jj� t�d��Y nX dS )a Reload users original configuration files after a temporary save.
This function should reinstall the users original configuration files
for all saves with temporary=True
:raises .ReverterError: when unable to revert config
z$Incomplete or failed recovery for %sz!Unable to revert temporary configN)
r �path�isdirr �temp_checkpoint_dir�_recover_checkpointr �
ReverterError�logger�critical�r r r r �revert_temporary_configH s �z Reverter.revert_temporary_config� c C s z t |�}W n( tk
r4 t�d� t�d��Y nX |dk rRt�d� t�d��t�| jj �}|�
� |sxt� d� n t |�|k r�t� d|t |�� |dkr�|r�tj
�| jj |�� �}z| �|� W n* tjk
r� t�d� t�d��Y nX |d8 }q�d S )
ay Revert 'rollback' number of configuration checkpoints.
:param int rollback: Number of checkpoints to reverse. A str num will be
cast to an integer. So "2" is also acceptable.
:raises .ReverterError:
if there is a problem with the input or if the function is
unable to correctly revert the configuration checkpoints
z,Rollback argument must be a positive integerz
Invalid Inputr zHCertbot hasn't modified your configuration, so rollback isn't available.z0Unable to rollback %d checkpoints, only %d existz)Failed to load checkpoint during rollbackz)Unable to load checkpoint during rollbackr N)�int�
ValueErrorr �errorr r r �listdirr r �sort�warning�lenr �join�popr r )r Zrollback�backups�cp_dirr r r �rollback_checkpoints\ s:
� �
�
z Reverter.rollback_checkpointsc
C s� t jdtdd� t�| jj�}|jdd� |s<t� d� dS z|D ] }t
|� qBW n( t k
rz t �
d�| jj���Y nX g }|D �]}|�t�t
|��� tj�| jj|�}ttj�|d ���}|�|�� � W 5 Q R X |�d
� ttj�|d ���.}|�� �� }|D ]}|�d �|�� �q
W 5 Q R X tj�tj�|d
���r�ttj�|d
���8} |�d� | �� �� }|D ]}|�d �|�� �qrW 5 Q R X |�d� q�tj�tj �j d�|�ddd� dS )a Displays all saved checkpoints.
All checkpoints are printed by
:meth:`certbot.interfaces.IDisplay.notification`.
.. todo:: Decide on a policy for error handling, OSError IOError...
:raises .errors.ReverterError: If invalid directory structure.
a The view_config_changes method has been deprecated and will be removed in a future release. If you were using this method to implement the view_config_changes method of IInstaller, know that that method has been removed from the plugin interface and is no longer used by Certbot.� )�
stacklevelT)�reversez3Certbot has not saved backups of your configurationNzInvalid directories in {0}�
CHANGES_SINCEzAffected files:� FILEPATHSz {0}� NEW_FILESzNew Configuration Files:�
F)Zforce_interactive�pause) �warnings�warn�DeprecationWarningr r r r r r �info�floatr r r �format�append�time�ctimer r# �open�read�
splitlines�isfile�zopeZ componentZ
getUtilityr ZIDisplayZ notification)
r r% Zbkup�outputZcur_dirZ
changes_fd�paths_fd� filepathsr �new_fdr r r �view_config_changes� sR �
�
�z Reverter.view_config_changesc C s | � | jj||� dS )z�Add files to temporary checkpoint.
:param set save_files: set of filepaths to save
:param str save_notes: notes about changes during the save
N)�_add_to_checkpoint_dirr r �r �
save_files�
save_notesr r r �add_to_temp_checkpoint� s
�z Reverter.add_to_temp_checkpointc C s | � |� | �| jj||� dS )z�Add files to a permanent checkpoint.
:param set save_files: set of filepaths to save
:param str save_notes: notes about changes during the save
N)�_check_tempfile_savesrC r �in_progress_dirrD r r r �add_to_checkpoint� s
�zReverter.add_to_checkpointc
C s t �|tj| jj� | �tj� |d��\}}t
|�}|D ]�}||kr8t � d|� z>t
�|tj� |tj�|�d t|� �� |�d�|�� W n< tk
r� |�� t �d||� t�d�||���Y nX |d7 }q8|�� ttj� |d�d ��}|�|� W 5 Q R X d
S ) ag Add save files to checkpoint directory.
:param str cp_dir: Checkpoint directory filepath
:param set save_files: set of files to save
:param str save_notes: notes about changes made during the save
:raises IOError: if unable to open cp_dir + FILEPATHS file
:raises .ReverterError: if unable to add checkpoint
r, zCreating backup of %s�_�{0}
z&Unable to add file %s to checkpoint %sz(Unable to add file {0} to checkpoint {1}r r+ �aN)r r
r r r r
�_read_and_appendr r r# r" r �debug�shutil�copy2�basename�str�writer5 �IOError�closer r r r9 ) r r& rE rF �op_fdZexisting_filepaths�idx�filenameZnotes_fdr r r rC � sF � � � � ��
z Reverter._add_to_checkpoint_dirc C s: t j�|�r$t|d�}|�� �� }ng }t|d�}||fS )z�Reads the file lines and returns a file obj.
Read the file returning the lines, and a pointer to the end of the file.
zr+�w)r r r< r9 r: r; )r �filepathrW �linesr r r rN s
zReverter._read_and_appendc
C s6 t j�t j�|d��r*| �t j�|d�� t j�t j�|d��r�zjtt j�|d���N}|�� �� }t|�D ]2\}}t �
t j�|t j� |�d t |� �|� qjW 5 Q R X W n2 t
tfk
r� t�d|� t�d| ��Y nX | �t j�|d�� zt �|� W n0 tk
�r0 t�d|� t�d| ��Y nX dS )a Recover a specific checkpoint.
Recover a specific checkpoint provided by cp_dir
Note: this function does not reload augeas.
:param str cp_dir: checkpoint directory file path
:raises errors.ReverterError: If unable to recover checkpoint
�COMMANDSr, rK z Unable to recover files from %sr- z Unable to remove directory: %sN)r r r< r# �_run_undo_commandsr9 r: r; � enumeraterP rQ rR rS rU �OSErrorr r r r �_remove_contained_filesZrmtree)r r& r? r@ rX r r r r r s4
�� �
�z Reverter._recover_checkpointc C s� t jd dkrddini }t|df|��Z}t�|�}tt|��D ]<}zt�|� W q@ t j
k
rz t � dd�
|�� Y q@X q@W 5 Q R X dS ) zRun all commands in a file.r r( �newline� �rz Unable to run undo command: %s� N)�sys� version_infor9 �csv�reader�reversed�listr Z
run_scriptr ZSubprocessErrorr r r# )r r[ �kwargsZcsvfileZ csvreader�commandr r r r^ : s
�zReverter._run_undo_commandsc C s� g }t j�| jjd�}t j�|�rJt|d��}|�|�� � � � W 5 Q R X t j�| jjd�}t j�|�r�t|d��}|�|�� � � � W 5 Q R X |D ]}||kr�t
� d| ��q�dS )z�Verify save isn't overwriting any temporary files.
:param set save_files: Set of files about to be saved.
:raises certbot.errors.ReverterError:
when save is attempting to overwrite a temporary file.
r, rd r- z+Attempting to overwrite challenge file - %sN) r r r# r r r< r9 �extendr: r; r r )r rE Zprotected_filesZ temp_pathZ protected_fd�new_pathrY r r r rH J s ��z Reverter._check_tempfile_savesc G s� |st �d��| �|�}d}zxz>| �tj�|d��\}}|D ] }||kr<|�d� |�� q<W n4 t
t fk
r� t �
d|� t �d� |���Y nX W 5 |dk r�|�� X dS )aA Register the creation of all files during certbot execution.
Call this method before writing to the file to make sure that the
file will be cleaned up if the program exits unexpectedly.
(Before a save occurs)
:param bool temporary: If the file creation registry is for
a temp or permanent save.
:param \*files: file paths (str) to be registered
:raises certbot.errors.ReverterError: If
call does not contain necessary parameters or if the file creation
is unable to be registered.
z,Forgot to provide files to registration callNr- rL z(Unable to register file creation(s) - %sz)Unable to register file creation(s) - {0})r r � _get_cp_dirrV rN r r r# rT r5 rU r` r r )r � temporary�filesr& rA Zex_filesr r r r �register_file_creationh s
�z Reverter.register_file_creationc C s� t j�| �|�d�}d}tjd dkr.ddini }ztzBt j�|�rRt|df|�}nt|df|�}t �
|�}|� |� W n, t t
fk
r� t�d � t�d
��Y nX W 5 |dk r�|�� X dS ) a� Register a command to be run to undo actions taken.
.. warning:: This function does not enforce order of operations in terms
of file modification vs. command registration. All undo commands
are run first before all normal files are reverted to their previous
state. If you need to maintain strict order, you may create
checkpoints before and after the the command registration. This
function may be improved in the future based on demand.
:param bool temporary: Whether the command should be saved in the
IN_PROGRESS or TEMPORARY checkpoints.
:param command: Command to be run.
:type command: list of str
r] Nr r( rb rc rM rZ z Unable to register undo commandz Unable to register undo command.)r r r# rp rf rg rV r< r9 rh �writerZwriterowrU r` r r r r )r rq rm Z commands_fpZ command_filerl Z csvwriterr r r �register_undo_command� s
�z Reverter.register_undo_commandc C s. |r| j j}n| j j}t�|tj| j j� |S )z%Return the proper reverter directory.)r r rI r r
r r r
)r rq r& r r r rp � s
�zReverter._get_cp_dirc C sh | � � tj�| jj�rdz| �| jj� W n8 tjk
rb t �
d| jj� t�d| jj ��Y nX dS )aC Revert configuration to most recent finalized checkpoint.
Remove all changes (temporary and permanent) that have not been
finalized. This is useful to protect against crashes and other
execution interruptions.
:raises .errors.ReverterError: If unable to recover the configuration
z=Incomplete or failed recovery for IN_PROGRESS checkpoint - %sN) r r r r r rI r r r r r r r r r �recovery_routine� s ���zReverter.recovery_routinec C s� t j�|�sdS zTt|d��@}|�� �� }|D ](}t j�|�rJt �|� q.t� d|� q.W 5 Q R X W n4 t
t fk
r� t� d|� t
�d�|���Y nX dS )a Erase all files contained within file_list.
:param str file_list: file containing list of file paths to be deleted
:returns: Success
:rtype: bool
:raises certbot.errors.ReverterError: If
all files within file_list cannot be removed
Frd zVFile: %s - Could not be found to be deleted
- Certbot probably shut down unexpectedlyz.Unable to remove filepaths contained within %sz/Unable to remove filepaths contained within {0}T)r r r< r9 r: r; �lexists�remover r! rU r` r r r r5 )r Z file_listZlist_fdr@ r r r r ra � s. � ���
z Reverter._remove_contained_filesc
C s t j�| jj�sdS t j�| jjd�}t j�| jjd�}t j�|�snt�d� t |d��}|�
d� W 5 Q R X zXt |d��8}|�
d| � t |d��}|�
|� � � W 5 Q R X W 5 Q R X t �
||� W n> ttfk
�r t�d � t�d
t�� � t�d ��Y nX | �� dS ) aZ Finalize the checkpoint.
Timestamps and permanently saves all changes made through the use
of :func:`~add_to_checkpoint` and :func:`~register_file_creation`
:param str title: Title describing checkpoint
:raises certbot.errors.ReverterError: when the
checkpoint is not able to be finalized.
Nr+ zCHANGES_SINCE.tmpz/Rollback checkpoint is empty (no changes made?)rZ z No changes
z -- %s --
rd z,Unable to finalize checkpoint - adding titlezException was:
%szUnable to add title)r r r r rI r# �existsr r3 r9 rT r: rP ZmoverU r` r rO � traceback�
format_excr r �_timestamp_progress_dir)r �titleZchanges_since_pathZchanges_since_tmp_path�fZ changes_tmpZ changes_origr r r �finalize_checkpoint s&
"
z Reverter.finalize_checkpointc C s� t t�� �}t�tj�| jjd��}dd� |D �}|�|� |� � |d |krxt t
|d �d �}t � d||� |}n<t
|�dkr�|d |kr�t �d|� t t
|d �d �}|}|S )
zBDetermine the timestamp of the checkpoint, enforcing monotonicity.z[0-9]*c S s g | ]}t j�|��qS r )r r rR )�.0�dr r r �
<listcomp>0 s z2Reverter._checkpoint_timestamp.<locals>.<listcomp>���r zyCurrent timestamp %s does not correspond to newest reverter checkpoint; your clock probably jumped. Time travelling to %s���z6Race condition with timestamp %s, incrementing by 0.01g{�G�z�?)rS r7 �globr r r# r r r6 r r4 r r! r" rO )r � timestampZothersZ
timetravelr r r �_checkpoint_timestamp, s"
� z Reverter._checkpoint_timestampc C s� t j�d�D ]X}| �� }tj�| jj|�}zt �
| jj |� W dS t k
rb t
�d|� Y q X q t
�d| jj |� t�d��dS )zTimestamp the checkpoint.r( Nz1Extreme, unexpected race condition, retrying (%s)z'Unable to finalize checkpoint, %s -> %sz&Unable to finalize checkpoint renaming)�sixZmoves�ranger� r r r# r r r �replacerI r` r r! r r r )r rK r� Z final_dirr r r r| A s ��z Reverter._timestamp_progress_dirN)r )�__name__�
__module__� __qualname__�__doc__r r r' rB rG rJ rC rN r r^ rH rs ru rp rv ra r r� r| r r r r r s( )
*:
-' '& &)r )r� rh r� ZloggingrP rf r7 rz r0 r� Zzope.componentr= Zcertbotr r r r Zcertbot.compatr r Z getLoggerr� r �objectr r r r r �<module> s$