HEX

File: //lib/python3.6/site-packages/ipapython/__pycache__/admintool.cpython-36.pyc
3

�d[e�/�@s�dZddlZddlZddlZddlZddlmZddlmZddl	m
Z
ddl	mZddlm
Z
dZdZd	Zeje�ZGd
d�de�ZGdd
�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��cs.eZdZdZd�fdd�	Zedd��Z�ZS)	�ScriptErrorzBAn exception that records an error message and a return value
    �rcs&|dkrd}tt|�j|�||_dS)Nr
)�superr	�__init__�rval)�self�msgr
)�	__class__��/usr/lib/python3.6/admintool.pyr.szScriptError.__init__cCst|�S)N)�str)rrrrr4szScriptError.msg)r
r)�__name__�
__module__�__qualname__�__doc__r�propertyr�
__classcell__rr)rrr	+sr	c@s�eZdZdZdZdZdZdZe�Z	e
dd��Ze
d#dd��Ze
dd	��Z
e
d
d��Ze
dd
��Zdd�Zdd�Zd$dd�Zdd�Zd%dd�Zd&dd�Zdd�Zdd�Zdd �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.
    NcCs0tjtj|jtj�|jd�}||_|j|�dS)zACreate an option parser shared across all instances of this class)r�usageZ	formatter�descriptionN)	rZIPAOptionParserr�VERSIONrZIPAFormatterr�
option_parser�add_options)�cls�parserrrr�make_parserds


zAdminTool.make_parserFcCsrt|d�}|jddddddd�|r:|jd	d
ddddd�|jdd
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()rZ
add_optionZadd_option_group)r r!Zdebug_option�grouprrrrms





zAdminTool.add_optionscCstj|jtj��dS)zKRun this command with sys.argv, exit process with the return value
        N)�sys�exit�main�argv)r rrr�run_cli�szAdminTool.run_clicCsT||jkr|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
        rN)�_option_parsersr"r�
parse_args�get_command_class�execute)r r1�options�argsZ
command_classZcommandrrrr0�s


zAdminTool.maincCs|S)Nr)r r7r8rrrr5�szAdminTool.get_command_classcCs$||_||_d|_|jj|�|_dS)NF)r7r8�log_file_initializedrZ
get_safe_opts�safe_options)rr7r8rrrr�szAdminTool.__init__cCs�|jdd�d}y$|j�|j�|j�|j�}Wnttk
r�}zXt|t�rf|jrf|j|krf|j}t	j
�d}|j|�\}}|r�|j||||�|SWYdd}~XnX|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_filerrN)�_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_messagerrrr6�s&

zAdminTool.executecCs<|r tj�dkr td|jd��|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.
        rzMust be root to run %srz8The --quiet and --verbose options are mutually exclusiveN)�os�getegidr	�command_namer7r#r))rZ
needs_rootrrrr=�s
zAdminTool.validate_optionscCsdS)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)rrrrr>�szAdminTool.ask_for_options�wcCsXtj�}x2|jD](}t|tj�r|jtjkr|j|�PqW|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�	getLoggerZhandlersrBZ
StreamHandler�streamr.�stderrZ
removeHandlerr<�
log_file_namer9)rrOZroot_loggerZhandlerrrrr?�s
zAdminTool.setup_loggingcCs�|r
d}n|jjr"|jj}||_n|j}|jjr>d}d}d}nd}d}|jjrTd}nd}t|||||d�|r|tjd|�n|s�tjd�dS)Nz$%(name)s: %(levelname)s: %(message)sTz%(message)sF)�console_format�filemode�debugr#z
Logging to %szNot logging to a file)r7r*rTr#r)r�loggerrW)rrOr;rTrUr#rWrrrr<�s,zAdminTool._setup_loggingcCsPt|t�r|j|jfSt|t�rDt|jt�r6d|jfSt|j�dfSt|�dfS)zMGiven an exception, return a message (or None) and process exit code
        Nr)rBr	rr
�
SystemExit�code�intr)rrHrrrrDs


zAdminTool.handle_errorcCsHtjd|j|j|j�tjdtj�tjdtj�tjdtj	tj�dS)aNActual 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)
rXrWrMr8r:rZVENDOR_VERSIONr�platform�name)rrrrr@&s

z
AdminTool.runcCs�tjddjtj|���tjd|jt|�j|�|r@tjd|�|dkrLdSd|j}|j	rr|t
krr|d|j7}tjd|�dS)Nz%sr
z(The %s command failed, exception: %s: %srzThe %s command failed.z See %s for more information)rXrW�joinrI�	format_tbrM�typer�errorr9�SERVER_NOT_CONFIGUREDrT)rrJrGrHZ	backtrace�messagerrrrE6s
zAdminTool.log_failurecCstjd|j�dS)NzThe %s command was successful)rX�inforM)rrrrrFFszAdminTool.log_success)F)F)rN)rNF)rrrrrMrTrr�dictr3�classmethodr"rr2r0r5rr6r=r>r?r<rDr@rErFrrrrr9s,#	


&
r)rrPr.rKrIZoptparserZipaplatform.osinforZ	ipapythonrrZipapython.ipa_log_managerr�SUCCESSZSERVER_INSTALL_ERRORrbrQrrX�	Exceptionr	rrrrr�<module>s