U ÝÁ]â_ã@sºdZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl m Z ddl mZddl mZddl mZddlmZddlmZe e¡ZGd d „d eƒZdS) zGReverter class saves configuration checkpoints and allows for recovery.éN)Ú constants)Úerrors)Ú interfaces)Úutil)Úos)Ú filesystemc@sªeZdZdZdd„Zdd„Zd*dd„Zd d „Zd d „Zd d„Z dd„Z dd„Z dd„Z dd„Z dd„Zdd„Zdd„Zdd„Zdd „Zd!d"„Zd#d$„Zd%d&„Zd'd(„Zd)S)+ÚReverterafReverter 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` cCs ||_t |jtj|jj¡dS)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__Bs ÿzReverter.__init__cCsXtj |jj¡rTz| |jj¡Wn0tjk rRt  d|jj¡t d¡‚YnXdS)aReload 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©rrrrÚrevert_temporary_configHs þz Reverter.revert_temporary_configécCsz t|ƒ}Wn(tk r4t d¡t d¡‚YnX|dkrRt d¡t d¡‚t |jj ¡}|  ¡|sxt  d¡nt |ƒ|kr–t  d|t |ƒ¡|dkrü|rütj  |jj | ¡¡}z| |¡Wn*tjk rðt d¡t d¡‚YnX|d8}q–d S) ayRevert '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 InputrzHCertbot 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 rollbackrN)ÚintÚ ValueErrorrÚerrorrrrÚlistdirr r ÚsortÚwarningÚlenrÚjoinÚpoprr)rZrollbackÚbackupsÚcp_dirrrrÚrollback_checkpoints\s:     ÿ ÿ  ÿ zReverter.rollback_checkpointsc CsÄtjdtddt |jj¡}|jdd|st  |tj  |tj |¡dt|ƒ¡¡| d |¡¡Wn<tk rÊ| ¡t  d||¡t d ||¡¡‚YnX|d7}q8| ¡ttj  |d¡d ƒ}| |¡W5QRXd S) agAdd 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}rr+ÚaN)rr rr r r Ú_read_and_appendrrr#r"rÚdebugÚshutilÚcopy2ÚbasenameÚstrÚwriter5ÚIOErrorÚcloserrrr9) rr&rErFÚop_fdZexisting_filepathsÚidxÚfilenameZnotes_fdrrrrCÖsF ÿ ÿ  ÿþÿÿ  zReverter._add_to_checkpoint_dircCs:tj |¡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)rrr<r9r:r;)rÚfilepathrWÚlinesrrrrNs    zReverter._read_and_appendc Cs6tj tj |d¡¡r*| tj |d¡¡tj tj |d¡¡rÞzjttj |d¡ƒN}| ¡ ¡}t|ƒD]2\}}t   tj |tj  |¡dt |ƒ¡|¡qjW5QRXWn2t tfk rÜt d|¡t d|¡‚YnX| tj |d¡¡zt  |¡Wn0tk r0t d|¡t d|¡‚YnXdS)aRecover 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,rKzUnable to recover files from %sr-zUnable to remove directory: %sN)rrr<r#Ú_run_undo_commandsr9r:r;Ú enumeraterPrQrRrSrUÚOSErrorrrrrÚ_remove_contained_filesZrmtree)rr&r?r@rXrrrrrs4   þþ ÿ  ÿzReverter._recover_checkpointc CsŒtjddkrddini}t|df|ŽZ}t |¡}tt|ƒƒD]<}zt |¡Wq@t j k rzt   dd  |¡¡Yq@Xq@W5QRXdS) zRun all commands in a file.rr(ÚnewlineÚÚrzUnable to run undo command: %sú N)ÚsysÚ version_infor9ÚcsvÚreaderÚreversedÚlistrZ run_scriptrZSubprocessErrorrrr#)rr[ÚkwargsZcsvfileZ csvreaderÚcommandrrrr^:s ÿzReverter._run_undo_commandsc Cs´g}tj |jjd¡}tj |¡rJt|dƒ}| | ¡  ¡¡W5QRXtj |jjd¡}tj |¡rt|dƒ}| | ¡  ¡¡W5QRX|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,rdr-z+Attempting to overwrite challenge file - %sN) rrr#r rr<r9Úextendr:r;rr)rrEZprotected_filesZ temp_pathZ protected_fdÚnew_pathrYrrrrHJs     ÿÿzReverter._check_tempfile_savesc Gs¬|st d¡‚| |¡}d}zxz>| tj |d¡¡\}}|D]}||kr<| d  |¡¡qttfk rt d ¡t d t ¡¡t d ¡‚YnX| ¡dS) aZFinalize 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?)rZz No changes z -- %s -- rdz,Unable to finalize checkpoint - adding titlezException was: %szUnable to add title)rrrr rIr#Úexistsrr3r9rTr:rPZmoverUr`rrOÚ tracebackÚ format_excrrÚ_timestamp_progress_dir)rÚtitleZchanges_since_pathZchanges_since_tmp_pathÚfZ changes_tmpZ changes_origrrrÚfinalize_checkpoints&      " zReverter.finalize_checkpointcCs¸tt ¡ƒ}t tj |jjd¡¡}dd„|Dƒ}| |¡|  ¡|d|krxtt |dƒdƒ}t   d||¡|}n0sz2Reverter._checkpoint_timestamp..éÿÿÿÿrzyCurrent 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„?)rSr7Úglobrrr#r r r6r r4rr!r"rO)rÚ timestampZothersZ timetravelrrrÚ_checkpoint_timestamp,s"   þ zReverter._checkpoint_timestampc Cs†tj d¡D]X}| ¡}tj |jj|¡}zt   |jj |¡WdSt k rbt  d|¡Yq Xq 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‡rrr#r r rÚreplacerIr`rr!rrr)rrKr†Z final_dirrrrr|As þÿz Reverter._timestamp_progress_dirN)r)Ú__name__Ú __module__Ú __qualname__Ú__doc__rrr'rBrGrJrCrNrr^rHrsrurprvrarr‡r|rrrrrs() *:  -''& &)r)rŽrhr…ZloggingrPrfr7rzr0rˆZzope.componentr=ZcertbotrrrrZcertbot.compatrrZ getLoggerr‹rÚobjectrrrrrÚs$