U ]1@sdZddlmZddlZddlZddlZddlZddlZddlZddl Z ddl m Z ddl m Z ddl mZddl mZddlmZd Zd ZeeZd d Zd dZddZGdddejZGdddejjZGdddejZddZddZ ddZ!dS)aLogging utilities for Certbot. The best way to use this module is through `pre_arg_parse_setup` and `post_arg_parse_setup`. `pre_arg_parse_setup` configures a minimal terminal logger and ensures a detailed log is written to a secure temporary file if Certbot exits before `post_arg_parse_setup` is called. `post_arg_parse_setup` relies on the parsed command line arguments and does the full logging setup with terminal and rotating file handling as configured by the user. Any logged messages before `post_arg_parse_setup` is called are sent to the rotating file handler. Special care is taken by both methods to ensure all errors are logged and properly flushed before program exit. )print_functionN)messages) constants)errors)util)osz %(message)sz.%(asctime)s:%(levelname)s:%(name)s:%(message)scCst}|tt|tjt|}t}|tt |t j t }|tj| || |ttjtjt|dtjk|jdt_dS)aSetup logging before command line arguments are parsed. Terminal logging is setup using `certbot.constants.QUIET_LOGGING_LEVEL` so Certbot is as quiet as possible. File logging is setup so that logging messages are buffered in memory. If Certbot exits before `post_arg_parse_setup` is called, these buffered messages are written to a temporary file. If Certbot doesn't exit, `post_arg_parse_setup` writes the messages to the normal log files. This function also sets `logging.shutdown` to be called on program exit which automatically flushes logging handlers and `sys.excepthook` to properly log/display fatal exceptions. z--debugdebuglog_pathN) TempHandler setFormatterlogging FormatterFILE_FMTsetLevelDEBUG MemoryHandlerColoredStreamHandlerCLI_FMTrQUIET_LOGGING_LEVEL getLogger addHandlerrZatexit_registerZshutdown functoolspartialpre_arg_parse_except_hooksysargvpath excepthook) temp_handlermemory_handlerZstream_handler root_loggerr"-/usr/lib/python3/dist-packages/certbot/log.pypre_arg_parse_setup(s$      r$c Cst|dt\}}tj|}t}d}}|jD]"}t|t rF|}q2t|t r2|}q2d}|dk rj|dk srt || || ||j} |||jdd|| |jrtj} n |j d} || td| td|tjt|j|d t_dS) aSetup logging after command line arguments are parsed. This function assumes `pre_arg_parse_setup` was called earlier and the root logging configuration has not been modified. A rotating file logging handler is created and the buffered log messages are sent to that handler. Terminal logging output is set to the level requested by the user. :param certbot.interface.IConfig config: Configuration object zletsencrypt.logNz9Previously configured logging handlers have been removed!Tforce zRoot logging level set at %dzSaving debug log to %sr)setup_log_file_handlerrrrdirnamer rhandlers isinstancerrAssertionErrorrZ removeHandlertargetZ setTargetflushclosequietrrZ verbose_countrloggerr inforrpost_arg_parse_except_hookrr) configZ file_handlerZ file_pathlogs_dirr!r Zstderr_handlerhandlermsgrlevelr"r"r#post_arg_parse_setupNsB             r9c Cst|jd|jtj|j|}ztjj |d|j d}Wn4t k rn}zt tj|W5d}~XYnX||tjtj|d}||||fS)aSetup file debug logging. :param certbot.interface.IConfig config: Configuration object :param str logfile: basename for the log file :param str fmt: logging format string :returns: file handler and absolute path to the log file :rtype: tuple ii)ZmaxBytesZ backupCountN)fmt)rZset_up_core_dirr5Zstrict_permissionsrrjoinr r*ZRotatingFileHandlerZmax_log_backupsIOErrorrErrorZ PERM_ERR_FMTformatZ doRolloverrrrr )r4Zlogfiler:Z log_file_pathr6errorZhandler_formatterr"r"r#r(|s  $   r(cs.eZdZdZdfdd ZfddZZS)ra6Sends colored logging output to a stream. If the specified stream is not a tty, the class works like the standard `logging.StreamHandler`. Default red_level is `logging.WARNING`. :ivar bool colored: True if output should be colored :ivar bool red_level: The level at which to output Ncs8tt|||dkr"tjn||_tj|_ dS)N) superr__init__rstderrisattycoloredr ZWARNING red_levelselfstream __class__r"r#rAs zColoredStreamHandler.__init__cs:tt||}|jr6|j|jkr6dtj|tj fS|S)zFormats the string representation of record. :param logging.LogRecord record: Record to be formatted :returns: Formatted, string representation of record :rtype: str ) r@rr>rDZlevelnorEr;rZ ANSI_SGR_REDZANSI_SGR_RESET)rGrecordoutrIr"r#r>s zColoredStreamHandler.format)N)__name__ __module__ __qualname____doc__rAr> __classcell__r"r"rIr#rs rcsDeZdZdZd fdd ZfddZdfd d Zd d ZZS)rzBuffers logging messages in memory until the buffer is flushed. This differs from `logging.handlers.MemoryHandler` in that flushing only happens when flush(force=True) is called. N'cstt|j||ddS)N)r-)r@rrA)rGr-ZcapacityrIr"r#rAszMemoryHandler.__init__cs|j}tt|||_dS)z;Close the memory handler, but don't set the target to None.N)r-r@rr/)rGr-rIr"r#r/szMemoryHandler.closeFcs|rtt|dS)zFlush the buffer if force=True. If force=False, this call is a noop. :param bool force: True if the buffer should be flushed. N)r@rr.)rGr&rIr"r#r.s zMemoryHandler.flushcCsdS)zShould the buffer be automatically flushed? :param logging.LogRecord record: log record to be considered :returns: False because the buffer should never be auto-flushed :rtype: bool Fr"rGrLr"r"r# shouldFlushs zMemoryHandler.shouldFlush)NrS)F) rNrOrPrQrAr/r.rUrRr"r"rIr#rs   rcs8eZdZdZfddZfddZfddZZS)r a Safely logs messages to a temporary file. The file is created with permissions 600. If no log records are sent to this handler, the temporary file is deleted when the handler is closed. :ivar str path: file system path to the temporary log file csHt|_tj|jd|_tj|jddd}tt | |d|_ dS)Nlogwi)modechmodT) tempfileZmkdtemp_workdirrrr;rZ safe_openr@r rA_deleterFrIr"r#rAs  zTempHandler.__init__csd|_tt||dS)zlLog the specified logging record. :param logging.LogRecord record: Record to be formatted FN)r\r@r emitrTrIr"r#r]szTempHandler.emitcsL|z4|j|jr&t|jd|_tt |W5|XdS)zuClose the handler and the temporary log file. The temporary log file is deleted if it wasn't used. FN) acquirereleaserHr/r\shutilZrmtreer[r@r )rGrIr"r#r/s  zTempHandler.close)rNrOrPrQrAr]r/rRr"r"rIr#r s  r c Os"zt||W5|jddXdS)aA simple wrapper around post_arg_parse_except_hook. The additional functionality provided by this wrapper is the memory handler will be flushed before Certbot exits. This allows us to write logging messages to a temporary file if we crashed before logging was fully configured. Since sys.excepthook isn't called on SystemExit exceptions, the memory handler will not be flushed in this case which prevents us from creating temporary log files when argparse exits because a command line argument was invalid or -h, --help, or --version was provided on the command line. :param MemoryHandler memory_handler: memory handler to flush :param tuple args: args for post_arg_parse_except_hook :param dict kwargs: kwargs for post_arg_parse_except_hook Tr%N)r.r3)r argskwargsr"r"r#rsrcCs|||f}|st|ts8tjtjks(ttjd|dnftj d|dt|t j r\t |tdt|rt|d\}}}t|nt||dt|dS)a!Logs fatal exceptions and reports them to the user. If debug is True, the full exception and traceback is shown to the user, otherwise, it is suppressed. sys.exit is always called with a nonzero status. :param type exc_type: type of the raised exception :param BaseException exc_value: raised exception :param traceback trace: traceback of where the exception was raised :param bool debug: True if the traceback should be shown to the user :param str log_path: path to file or directory containing the log zExiting abnormally:)exc_infozAn unexpected error occurred:z:: N) issubclass Exceptionrrr ZERRORr,r1r?r rr=rexitrZ is_acme_errorstr partition tracebackprint_exceptionexit_with_log_path)exc_type exc_valueZtracer r rc_Zexc_strr"r"r#r3/s      r3cCsDd}tj|r |d|7}n|d|7}|d7}t|dS)zPrint a message about the log location and exit. The message is printed to stderr and the program will exit with a nonzero status. :param str log_path: path to file or directory containing the log zPlease see the zlogfiles in {0} zlogfile '{0}' zfor more details.N)rrisdirr>rrf)r r7r"r"r#rkRs  rk)"rQZ __future__rrr Zlogging.handlersr`rrZriZacmerZcertbotrrrZcertbot.compatrrrrrNr1r$r9r(Z StreamHandlerrr*rr rr3rkr"r"r"r#s2       &. ,-#