a
}|g< @ s d Z ddlZddlZddlZddlZddlZddlZddlZddlm Z ddl
m Z ddl
m Z ddl
m
Z
ddl
mZ ddl
mZ dd l
mZ dd
lmZ dd lmZ dd lmZ dd
lmZ ddlmZ dd
lmZ ddlm Z dZ dZ e e Z!ddddZ"ej#ddddZ$ej#e%e%eej&e%f dddZ'G dd d ej(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&Z0e%dd'd(d)Z1dS )*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)cast)IO)Optional)Tuple)Type)messages)
configuration)errors)util) constants)osz %(message)sz.%(asctime)s:%(levelname)s:%(name)s:%(message)sreturnc C s t } | tt | tj t| }t }|tt |tj
t }|tj | | | | t
tj tjt|dtjv dtjv pdtjv | 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-qdebugquietlog_pathN) TempHandler setFormatterlogging FormatterFILE_FMTsetLevelDEBUG
MemoryHandlerColoredStreamHandlerCLI_FMTWARNING getLogger
addHandlerr Zatexit_registerZshutdown functoolspartialpre_arg_parse_except_hooksysargvpath
excepthook) temp_handlermemory_handlerZstream_handler root_logger r, 9/usr/lib/python3.9/site-packages/certbot/_internal/log.pypre_arg_parse_setup7 s$
r. )configr c
C s< t | dt\}}t }d }}|jD ]"}t|tr:|}q&t|tr&|}q&d}|dur^|dusfJ ||| | | t
|dd}| | |j dd |
|r|
| jrtj} n0| jdurtjt| jd } ntj| jd } || td| | 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!targetTforce
z Root logging level set at %dzSaving debug log to )filer ) setup_log_file_handlerr r r handlers
isinstancer r r! Z
removeHandlergetattrZ setTargetflushcloser r
QUIET_LOGGING_LEVELZ
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_setupb sB
rD )r/ logfilefmtr c
C s t | jd| j tj| j|}ztjj |d| j
d}W n6 t yp } z t
t j|W Y d}~n
d}~0 0 | |tj tj|d}|| ||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 i )ZmaxBytesZ backupCountN)rF )r Zset_up_core_dirZlogs_dirZstrict_permissionsr r' joinr r6 ZRotatingFileHandlerZmax_log_backupsOSErrorr ErrorZ PERM_ERR_FMTformatZ
doRolloverr r r r )r/ rE rF Z
log_file_pathrA errorZhandler_formatterr, r, r- r5 s
(
r5 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 | |d u r tj n| | _tj| _d S )N) super__init__r% r? isattycoloredr r red_levelselfrL __class__r, r- rN s
z ColoredStreamHandler.__init__recordr c s6 t |}| jr2|j| jkr2dtj|tjfS |S )zFormats the string representation of record.
:param logging.LogRecord record: Record to be formatted
:returns: Formatted, string representation of record
:rtype: str
) rM rJ rP ZlevelnorQ rG r Z ANSI_SGR_REDZANSI_SGR_RESET)rS rW outrT r, r- rJ s zColoredStreamHandler.format)N) __name__
__module__ __qualname____doc__r r rN r LogRecordstrrJ
__classcell__r, r, rT 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' )r0 capacityr c s t j||d d S )N)r0 )rM rN )rS r0 rb rT r, r- rN s zMemoryHandler.__init__r c s t | d}t || _dS )z;Close the memory handler, but don't set the target to None.r0 N)r8 rM r: r0 )rS r0 rT r, r- r: s
zMemoryHandler.closeF)r2 r c s |rt 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)rM r9 )rS r2 rT r, r- r9 s
zMemoryHandler.flushrV 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, rS rW r, r, r- shouldFlush s zMemoryHandler.shouldFlush)Nra )F)rZ r[ r\ r] r r Handlerr< rN r: boolr9 r^ rd r` r, r, rT 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
Nr c sL t jdd| _tj| jd| _tj| jddd}t | | d| _
d S )Nz certbot-log-)prefixlogwi )modechmodT) tempfileZmkdtemp_workdirr r' rG r Z safe_openrM rN _deleterR rT r, r- rN
s zTempHandler.__init__rV c s d| _ t | dS )zlLog the specified logging record.
:param logging.LogRecord record: Record to be formatted
FN)rn rM emitrc rT r, r- ro s zTempHandler.emitc sP | z8| j | jr&t| j d| _t W | n
| 0 dS )zuClose the handler and the temporary log file.
The temporary log file is deleted if it wasn't used.
FN) acquirerL r: rn shutilrmtreerm rM release)rS rT r, r- r: s
zTempHandler.close)
rZ r[ r\ r] rN r r^ ro r: r` r, r, rT r- r s
r )r* argskwargsr c O s2 z t |i | W | jdd n| jdd 0 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
Tr1 N)r@ r9 )r* rt ru r, r, r- r$ 3 s r$ )exc_type exc_valuetracer r r r c s | ||f}dd fdd }|s,t | tshtjtjks.exit_funcz Exiting due to user request.ry zExiting abnormally:)exc_infoz An unexpected error occurred:rX )
issubclass Exceptionr
r; r ZERRORKeyboardInterruptr= rK r% rz r r rI r_ r Z
is_acme_error display_utilZdescribe_acme_errorr tracebackformat_exception_onlyrG rstrip) rv rw rx r r r r~ r} outputr, r| r- r@ O s$
r@ )r r c C sH d}t j| r"|d| d7 }n|d| d7 }|d7 }t| 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% rz )r rB r, r, r- r{ s r{ )2r] r" r Zlogging.handlersrq r% rl r typesr typingr r r r r r Zacmer Zcertbotr
r r Zcertbot._internalr
Zcertbot._internal.displayr Zcertbot.compatr r r r rZ r= r. ZNamespaceConfigrD r_ re r5 Z
StreamHandlerr r6 r r r$
BaseExceptionrf r@ r{ r, r, r, r- sP
+4 -0 5