Viewing: admintool.cpython-36.pyc
3 �d[e�/ � @ s� d Z ddlZddlZddlZddlZddlmZ ddlmZ ddl m Z ddl m Z ddl m Z dZdZd Zeje�ZG d d � d e�ZG d d � d �ZdS )z�A common framework for command-line admin tools, e.g. install scripts Handles common operations like option parsing and logging � N)� OptionGroup)�osinfo)�version)�config)�standard_logging_setup� � c s. e Zd ZdZd� fdd� Zedd� �Z� ZS ) � ScriptErrorzBAn exception that records an error message and a return value � r c s& |d kr d}t t| �j|� || _d S )Nr )�superr �__init__�rval)�self�msgr )� __class__� � /usr/lib/python3.6/admintool.pyr . s zScriptError.__init__c C s t | �S )N)�str)r r r r r 4 s zScriptError.msg)r r )�__name__� __module__� __qualname__�__doc__r �propertyr � __classcell__r r )r r r + s r c @ s� e Zd ZdZdZdZdZdZe� Z e dd� �Z e d#dd��Z e dd � �Z e d d � �Ze d d � �Zdd� Zdd� Zd$dd�Zdd� Zd%dd�Zd&dd�Zdd � Zd d � Zd d � Zd!d"� ZdS )'� AdminToola~ Base class for command-line admin tools To run the tool, call the main() classmethod with a list of command-line arguments. Alternatively, call run_cli() to run with command-line arguments in sys.argv, and call sys.exit() with the return value. Some commands actually represent multiple related tools, e.g. ``ipa-server-install`` and ``ipa-server-install --uninstall`` would be represented by separate classes. Only their options are the same. To handle this, AdminTool provides classmethods for option parsing and selecting the appropriate command class. A class-wide option parser is made by calling add_options. The options are then parsed into options and arguments, and get_command_class is called with those to retrieve the class. That class is then instantiated and run. Running consists of a few steps: - validating options or the environment (validate_options) - setting up logging (setup_logging) - running the actual command (run) Any unhandled exceptions are handled in handle_error. And at the end, either log_success or log_failure is called. Class attributes to define in subclasses: command_name - shown in logs log_file_name - if None, logging is to stderr only usage - text shown in help description - text shown in help See the setup_logging method for more info on logging. Nc C s0 t jtj| jt j� | jd�}|| _| j|� dS )zACreate an option parser shared across all instances of this class)r �usageZ formatter� descriptionN) r ZIPAOptionParserr �VERSIONr Z IPAFormatterr � option_parser� add_options)�cls�parserr r r � make_parserd s zAdminTool.make_parserFc C sr t |d�}|jddddddd� |r:|jd d dddd d� |jd d ddddd� |jdddddd� |j|� dS )z�Add command-specific options to the option parser :param parser: The parser to add options to :param debug_option: Add a --debug option as an alias to --verbose zLogging and output optionsz-vz --verbose�verboseF� store_truezprint debugging information)�dest�default�action�helpz-dz--debugz alias for --verbose (deprecated)z-qz--quiet�quietzoutput only errorsz --log-file�log_fileN�FILEzlog to the given file)r% r& �metavarr( )r Z add_optionZadd_option_group)r r! Z debug_option�groupr r r r m s zAdminTool.add_optionsc C s t j| jt j�� dS )zKRun this command with sys.argv, exit process with the return value N)�sys�exit�main�argv)r r r r �run_cli� s zAdminTool.run_clic C sT | | j kr | j� | j| j | < | jj|dd� �\}}| j||�}|||�}|j� S )z�The main entry point Parses command-line arguments, selects the actual command class to use based on them, and runs that command. :param argv: Command-line arguments. :return: Command exit code r N)�_option_parsersr" r � parse_args�get_command_class�execute)r r1 �options�argsZ command_classZcommandr r r r0 � s zAdminTool.mainc C s | S )Nr )r r7 r8 r r r r5 � s zAdminTool.get_command_classc C s$ || _ || _d| _| jj|�| _d S )NF)r7 r8 �log_file_initializedr Z get_safe_opts� safe_options)r r7 r8 r r r r � s zAdminTool.__init__c C s� | j dd� d}y$| j� | j� | j� | j� }W nt tk r� } zXt|t�rf|jrf|j|krf|j}t j � d }| j |�\}}|r�| j ||||� |S W Y dd}~X nX | j � |S )z�Do everything needed after options are parsed This includes validating options, setting up logging, doing the actual work, and handling the result. T)�no_filer r N)�_setup_logging�validate_options�ask_for_options� setup_logging�run� BaseException� isinstancer r r. �exc_info� handle_error� log_failure� log_success)r � return_value� exception� traceback� error_messager r r r6 � s& zAdminTool.executec C s< |r t j� dkr td| j d��| jjr8| jjr8td��dS )z�Validate self.options It's also possible to compute and store information that will be useful later, but no changes to the system should be made here. r zMust be root to run %sr z8The --quiet and --verbose options are mutually exclusiveN)�os�getegidr � command_namer7 r# r) )r Z needs_rootr r r r= � s zAdminTool.validate_optionsc C s dS )a* Ask for missing options interactively Similar to validate_options. This is separate method because we want any validation errors to abort the script before bothering the user with prompts. Any options that might be asked for should also be validated here. Nr )r r r r r> � s zAdminTool.ask_for_options�wc C sX t j� }x2|jD ](}t|t j�r|jtjkr|j|� P qW | j |d� | j rTd| _ dS )a% Set up logging :param _to_file: Setting this to false will disable logging to file. For internal use. If the --log-file option was given or if a filename is in self.log_file_name, the tool will log to that file. In this case, all messages are logged. What is logged to the console depends on command-line options: the default is INFO; --quiet sets ERROR; --verbose sets DEBUG. Rules of thumb for logging levels: - CRITICAL for fatal errors - ERROR for critical things that the admin must see, even with --quiet - WARNING for things that need to stand out in the log - INFO to display normal messages - DEBUG to spam about everything the program does - a plain print for things that should not be log (for example, interactive prompting) To log, use a module-level logger. Logging to file is only set up after option validation and prompting; before that, all output will go to the console only. )� log_file_modeTN) �logging� getLoggerZhandlersrB Z StreamHandler�streamr. �stderrZ removeHandlerr< � log_file_namer9 )r rO Z root_loggerZhandlerr r r r? � s zAdminTool.setup_loggingc C s� |r d }n | j jr"| j j}|| _n| j}| j jr>d}d}d}nd}d}| j jrTd}nd}t|||||d� |r|tjd|� n|s�tjd� d S )Nz$%(name)s: %(levelname)s: %(message)sTz %(message)sF)�console_format�filemode�debugr# z Logging to %szNot logging to a file)r7 r* rT r# r) r �loggerrW )r rO r; rT rU r# rW r r r r< � s, zAdminTool._setup_loggingc C sP t |t�r|j|jfS t |t�rDt |jt�r6d|jfS t|j�dfS t|�dfS )zMGiven an exception, return a message (or None) and process exit code Nr )rB r r r � SystemExit�code�intr )r rH r r r rD s zAdminTool.handle_errorc C sH t jd| j| j| j� t jdtj� t jdtj� t jdtj tj� dS )aN Actual running of the command This is where the hard work is done. The base implementation logs the invocation of the command. If this method returns (i.e. doesn't raise an exception), the tool is assumed to have run successfully, and the return value is used as the SystemExit code. z0%s was invoked with arguments %s and options: %szIPA version %szIPA platform %szIPA os-release %s %sN) rX rW rM r8 r: r ZVENDOR_VERSIONr �platform�name)r r r r r@ & s z AdminTool.runc C s� t jddjtj|��� t jd| jt|�j|� |r@t jd|� |dkrLd S d| j }| j rr|t krr|d| j 7 }t jd|� d S )Nz%sr z(The %s command failed, exception: %s: %sr zThe %s command failed.z See %s for more information) rX rW �joinrI � format_tbrM �typer �errorr9 �SERVER_NOT_CONFIGUREDrT )r rJ rG rH Z backtrace�messager r r rE 6 s zAdminTool.log_failurec C s t jd| j� d S )Nz The %s command was successful)rX �inforM )r r r r rF F s zAdminTool.log_success)F)F)rN )rN F)r r r r rM rT r r �dictr3 � classmethodr" r r2 r0 r5 r r6 r= r> r? r< rD r@ rE rF r r r r r 9 s, # & r )r rP r. rK rI Zoptparser Zipaplatform.osinfor Z ipapythonr r Zipapython.ipa_log_managerr �SUCCESSZSERVER_INSTALL_ERRORrb rQ r rX � Exceptionr r r r r r �<module> s
Return