3
گa: @ s d Z ddlZddlZddlZddlZddlZddlZddlZddlm Z ddl
m Z ddl
m Z ddl
m
Z
ddl
mZ ddl
mZ dd lmZ dd
lmZ dd lmZ dd lmZ dd
lmZ ddlmZ dZdZej e Z ddddZ ej ddddZ!ej e"e"eej#e"f dddZ$G dd dej%Z&G d d d ej'j(Z(G d d d ej%Z)e(e e dd d!d"Z*ee+ e+e e,e,e"dd#d$d%Z-e"dd&d'd(Z.dS ))a Logging 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.
The `logging` module is useful for recording messages about about what
Certbot is doing under the hood, but do not necessarily need to be shown
to the user on the terminal. The default verbosity is WARNING.
The preferred method to display important information to the user is to
use `certbot.display.util` and `certbot.display.ops`.
N)
TracebackType)Any)IO)Optional)Tuple)Type)messages)
configuration)errors)util) constants)osz %(message)sz.%(asctime)s:%(levelname)s:%(name)s:%(message)s)returnc C s t } | jtjt | jtj t| }t }|jtjt |jt
j tj }|jtj |j
| |j
| tjtj tjt|dtjkdtjkpdtjk| jdt_dS )a Setup logging before command line arguments are parsed.
Terminal logging is setup using
`certbot._internal.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--debugz--quietz-q)debugquietlog_pathN) TempHandler setFormatterlogging FormatterFILE_FMTsetLevelDEBUG
MemoryHandlerColoredStreamHandlerCLI_FMTr QUIET_LOGGING_LEVEL getLogger
addHandlerr Zatexit_registerZshutdown functoolspartialpre_arg_parse_except_hooksysargvpath
excepthook) temp_handlermemory_handlerZstream_handler root_logger r) /usr/lib/python3.6/log.pypre_arg_parse_setup5 s"
r+ )configr c
C s( t | dt\}}tj }d }}x,|jD ]"}t|tr<|}q(t|tr(|}q(W d}|j| |j | t
|dd}|j | |j dd |j
|r|j
| jrtj} n0| jdk rtjt| jd } ntj| jd } |j| tjd| | js td | tjd
tj t | j| j|d t_ dS ) a Setup 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.configuration.NamespaceConfig config: Configuration object
zletsencrypt.logNz9Previously configured logging handlers have been removed!targetT)force
z Root logging level set at %dzSaving debug log to )file)r r r ) setup_log_file_handlerr r r handlers
isinstancer r r Z
removeHandlergetattrZ setTargetflushcloser r r Z
verbose_levelZDEFAULT_LOGGING_LEVELintZ
verbose_countr loggerr printr" stderrr r post_arg_parse_except_hookr% )
r, Z file_handlerZ file_pathr( r' Zstderr_handlerhandlermsgr& levelr) r) r* post_arg_parse_setup] s<
r? )r, logfilefmtr c C s t j| jd| j tjj| j|}ytjj |d| j
d}W n4 t k
rn } zt j
t jj|W Y dd}~X nX |j |jtj tj|d}|j| ||fS )a Setup file debug logging.
:param certbot.configuration.NamespaceConfig 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
i )ZmaxBytesZ backupCountN)rA i )r Zset_up_core_dirZlogs_dirZstrict_permissionsr
r$ joinr r2 ZRotatingFileHandlerZmax_log_backupsIOErrorr
ErrorZ PERM_ERR_FMTformatZ
doRolloverr r r r )r, r@ rA Z
log_file_pathr< errorZhandler_formatterr) r) r* r1 s $
r1 c sD e Zd ZdZd ee dd fdd
Zeje d fdd Z
Z S )
r a6 Sends 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
N)streamr c s4 t j| |d kr tjj n|j | _tj| _d S )N) super__init__r" r: isattycoloredr ZWARNING red_level)selfrI ) __class__r) r* rK s
z ColoredStreamHandler.__init__)recordr c s6 t j|}| jr2|j| jkr2djtj|tjfS |S )zFormats the string representation of record.
:param logging.LogRecord record: Record to be formatted
:returns: Formatted, string representation of record
:rtype: str
) rJ rG rM ZlevelnorN rD r Z ANSI_SGR_REDZANSI_SGR_RESET)rO rQ out)rP r) r* rG s zColoredStreamHandler.format)N) __name__
__module__ __qualname____doc__r r rK r LogRecordstrrG
__classcell__r) r) )rP r* r s
r c sl e Zd ZdZdeej edd fdd
Zdd fdd Z de
dd fd d
Z ej e
dddZ
ZS )r zBuffers 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' )r- capacityr c s t j||d d S )N)r- )rJ rK )rO r- r\ )rP r) r* rK s zMemoryHandler.__init__)r c s t | d}t j || _dS )z;Close the memory handler, but don't set the target to None.r- N)r4 rJ r6 r- )rO r- )rP r) r* r6 s
zMemoryHandler.closeF)r. r c s |rt j 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)rJ r5 )rO r. )rP r) r* r5 s
zMemoryHandler.flush)rQ r c C s dS )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) )rO rQ r) r) r* shouldFlush s zMemoryHandler.shouldFlush)Nr[ )F)rT rU rV rW r r Handlerr7 rK r6 boolr5 rX r] rZ r) r) )rP r* r s
r c sN e Zd ZdZdd fdd Zejdd fdd Zdd fd d
Z Z S ) 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
N)r c sH t j | _tjj| jd| _tj| jddd}t j | | d| _
d S )Nlogwi )modechmodT) tempfileZmkdtemp_workdirr
r$ rD r Z safe_openrJ rK _delete)rO rI )rP r) r* rK s
zTempHandler.__init__)rQ r c s d| _ t j| dS )zlLog the specified logging record.
:param logging.LogRecord record: Record to be formatted
FN)rf rJ emit)rO rQ )rP r) r* rg s zTempHandler.emitc
sH | j z0| jj | jr&tj| j d| _t j W d| j X dS )zuClose the handler and the temporary log file.
The temporary log file is deleted if it wasn't used.
FN) acquirerI r6 rf shutilZrmtreere rJ release)rO )rP r) r* r6 s
zTempHandler.close)
rT rU rV rW rK r rX rg r6 rZ r) r) )rP r* r s
r )r' argskwargsr c O s" zt || W d| jdd X dS )a A 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
NT)r. )r; r5 )r' rk rl r) r) r* r! . s r! )exc_type exc_valuetracer r r r c s | ||f} fdd}|s(t | t rT| tkrDtjd tjd tjd|d ntjd|d t | tj rtjt
| | tjd t j |rt
|j
d\}}} tj| n tj| |}
tjd j|
j | d
S ) aa 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 bool quiet: True if Certbot is running in quiet mode
:param str log_path: path to file or directory containing the log
c s rt jdS t S )N )r" exitexit_with_advicer) )r r r) r* ] s z,post_arg_parse_except_hook..z Exiting due to user request.rp zExiting abnormally:)exc_infoz An unexpected error occurred:z:: rR N)
issubclass ExceptionKeyboardInterruptr8 rH r" rq r r
rF rY r Z
is_acme_error partition tracebackformat_exception_onlyrD rstrip) rm rn ro r r r rt Z exit_func_Zexc_stroutputr) )r r r* r; J s$
r; )r r c C sH d}t jj| r"|d| d7 }n|d| d7 }|d7 }tj| dS )zPrint a link to the community forums, the debug log path, 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
zSAsk for help or search for solutions at https://community.letsencrypt.org. See the z logfiles in zlogfile z+or re-run Certbot with -v for more details.N)r
r$ isdirr" rq )r r= r) r) r* rr } s rr )/rW r r Zlogging.handlersri r" rd ry typesr Ztypingr r r r r Zacmer Zcertbotr r
r Zcertbot._internalr Zcertbot.compatr
r r r rT r8 r+ ZNamespaceConfigr? rY r^ r1 Z
StreamHandlerr r2 r r r!
BaseExceptionr_ r; rr r) r) r) r* sF
(4 -01