m &UIc@sdZdkZdkZdkZdkZdkZdkZdkZdkZdk Z dk Z y dk Z Wne j o dZ nXdZdZdZdZdZdddZd eifd YZd efd YZd efdYZdeifdYZdefdYZdeifdYZdeifdYZdeifdYZdeifdYZdeifdYZdefdYZ dS(s Additional handlers for the logging package for Python. The core package is based on PEP 282 and comments thereto in comp.lang.python, and influenced by Apache's log4j system. Should work under Python versions >= 1.5.2, except that source line information is not available unless 'sys._getframe()' is. Copyright (C) 2001-2004 Vinay Sajip. All Rights Reserved. To use, simply 'import logging' and log away! Ni<#i=#i>#i?#iii<tBaseRotatingHandlercBs#tZdZedZdZRS(s Base class for handlers that rotate log files at a certain point. Not meant to be instantiated directly. Instead, use RotatingFileHandler or TimedRotatingFileHandler. cCsFtdjo d}ntii||||||_||_dS(sA Use the specified filename for streamed logging N( tcodecstNonetencodingtloggingt FileHandlert__init__tselftfilenametmode(RRR R((t-/data/zmath/lib/python2.4/logging/handlers.pyR7s    cCsky5|i|o|intii||Wn/ttfj o n|i |nXdS(s Emit a record. Output the record to the file, catering for rollover as described in doRollover(). N( RtshouldRollovertrecordt doRolloverRRtemittKeyboardInterruptt SystemExitt handleError(RR ((R RAs(t__name__t __module__t__doc__RRR(((R R1s  tRotatingFileHandlercBs5tZdZdddedZdZdZRS(s Handler for logging to a set of files, which switches from one file to the next when the current file reaches a certain size. taicCsC|djo d}nti||||||_||_dS(s Open the specified file and use it as the stream for logging. By default, the file grows indefinitely. You can specify particular values of maxBytes and backupCount to allow the file to rollover at a predetermined size. Rollover occurs whenever the current log file is nearly maxBytes in length. If backupCount is >= 1, the system will successively create new files with the same pathname as the base file, but with extensions ".1", ".2" etc. appended to it. For example, with a backupCount of 5 and a base file name of "app.log", you would get "app.log", "app.log.1", "app.log.2", ... through to "app.log.5". The file being written to is always "app.log" - when it gets filled up, it is closed and renamed to "app.log.1", and if files "app.log.1", "app.log.2" etc. exist, then they are renamed to "app.log.2", "app.log.3" etc. respectively. If maxBytes is zero, rollover never occurs. iRN(tmaxBytesR RRRRRt backupCount(RRR RRR((R RVs    cCsC|ii|idjoxt|idddD]{}d|i|f}d|i|df}t i i |o8t i i |ot i |nt i ||q7q7W|id}t i i |ot i |nt i |i|n|io"ti|id|i|_nt|id|_dS(s< Do a rollover, as described in __init__(). iiis%s.%ds.1twN(RtstreamtcloseRtrangetit baseFilenametsfntdfntostpathtexiststremovetrenameRRtopen(RRRR ((R R qs$   "cCsi|idjoUd|i|}|iidd|iit||ijodSqendS(s Determine if rollover should occur. Basically, see if the supplied record would cause the file to exceed the size limit we have. is%s iiN( RRtformatR tmsgRtseekttelltlen(RR R(((R R s# (RRRRRR R (((R RQs  tTimedRotatingFileHandlercBs5tZdZdddedZdZdZRS(s Handler for logging to a file, rotating the log file at certain timed intervals. If backupCount is > 0, when rollover is done, no more than backupCount files are kept - the oldest ones are deleted. thiicCsti||d|ti||_||_t t i } |idjod|_ d|_ nY|idjod|_ d|_ n3|idjodd|_ d |_ n |id jp|id joddd |_ d |_ n|iidoddd d|_ t|idjotd|in|iddjp|iddjotd|int |id|_d |_ ntd|i|i ||_ | |i |_|id jp|iidot i| } | d} | d}| d} t| d|d| } | | |_|ido| d}||ijo1||id}|i|ddd |_n||ijo1d|i|}|i|ddd |_qqndS(NRtSis%Y-%m-%d_%H-%M-%StMi<s%Y-%m-%d_%H-%MtHs %Y-%m-%d_%HtDtMIDNIGHTis%Y-%m-%dtWiisHYou must specify a day for weekly rollover from 0 to 6 (0 is Monday): %st0t6s-Invalid day specified for weekly rollover: %ss'Invalid rollover interval specified: %siiii(RRRRRtstringtuppertwhenRtintttimet currentTimetintervaltsuffixt startswithR+t ValueErrort dayOfWeekt rolloverAtt localtimettt currentHourt currentMinutet currentSecondt _MIDNIGHTtrtdayt daysToWait(RRR8R<RRRJRERIRFRHR;RDRC((R RsT         (  #      cCs.tti}||ijodSndS(s Determine if rollover should occur record is not used, as we are just comparing times, but it is needed so the method siguratures are the same iiN(R9R:RCRRA(RR RC((R R s cCs:|ii|i|i}ti|}|i dti |i |}t ii|ot i|nt i|i ||idjoOti|i d}t||ijo|it i|dqn|io"ti|i d|i|_nt|i d|_|i|i|_dS(sx do a rollover; in this case, a date/time stamp is appended to the filename when the rollover happens. However, you want the file to be named for the start of the interval, not the current time. If there is a backup count, then we have to get a list of matching filenames, sort them and remove the one with the oldest suffix. t.is.20*RN(RRRRAR<RCR:RBt timeTupleRtstrftimeR=R R!R"R#R$R%RtglobtsR+tsortRRR&(RROR RCRL((R R s"    "(RRRRRR R (((R R,s S t SocketHandlercBsVtZdZdZdZdZdZdZdZdZ dZ RS( s A handler class which writes logging records, in pickle format, to a streaming socket. The socket is kept open across logging calls. If the peer resets it, an attempt is made to reconnect on the next call. The pickle which is sent is that of the LogRecord's attribute dictionary (__dict__), so that the receiver does not need to have the logging module installed in order to process the logging event. To unpickle the record at the receiving end into a LogRecord, use the makeLogRecord function. cCs\tii|||_||_d|_d|_d|_ d|_ d|_ d|_ dS(s  Initializes the handler with a specific host address and port. The attribute 'closeOnError' is set to 1 - which means that if a socket error occurs, the socket is silently closed and then reopened on the next logging call. if1.0f30.0f2.0N( RtHandlerRRthosttportRtsockt closeOnErrort retryTimet retryStarttretryMaxt retryFactor(RRSRT((R R*s       cCs5tititi}|i|i|if|S(sr A factory method which allows subclasses to define the precise type of socket they want. N(tsockettAF_INETt SOCK_STREAMROtconnectRRSRT(RRO((R t makeSocket?scCsti}|idjo d}n||ij}|oy|i|_d|_Wq|idjo|i|_ n7|i |i |_ |i |i jo|i |_ n||i |_qXndS(s Try to create a socket, using an exponential backoff with a max retry time. Thanks to Robert Olson for the original patch (SF #815911) which has been slightly refactored. iN( R:tnowRRWRtattemptR_RURXt retryPeriodRZRY(RR`Ra((R t createSocketHs    cCs|idjo|in|ioy|t|ido|ii|nRd}t|}x<|djo.|ii ||}||}||}qgWWqt i j o|iid|_qXndS(s Send a pickled string to the socket. This function allows for partial sends which can happen when the network is busy. tsendalliN(RRURRcthasattrRdROt sentsofarR+tlefttsendtsentR[terrorR(RRORiRfRg((R Rhds"     cCsu|i}|o|i|}d|_nti|i d}|o ||_nt i dt |}||S(s Pickles the record in binary format with a length prefix, and returns it ready for transmission across the socket. is>LN(R texc_infoteiRR'tdummyRtcPickletdumpst__dict__ROtstructtpackR+tslen(RR RmRlRORs((R t makePickles   cCsE|io$|io|iid|_ntii||dS(s Handle an error during logging. An error has occurred during logging. Most likely cause - connection lost. Close the socket so that we can retry on the next event. N( RRVRURRRRRRR (RR ((R Rs   cCsVy |i|}|i|Wn/ttfj o n|i|nXdS(s Emit a record. Pickles the record and writes it to the socket in binary format. If there is an error with the socket, silently drop the packet. If there was a problem with the socket, re-establishes the socket. N(RRtR RORhRRR(RR RO((R RscCs8|io|iid|_ntii|dS(s$ Closes the socket. N(RRURRRRR(R((R Rs    ( RRRRR_RcRhRtRRR(((R RQs       tDatagramHandlercBs)tZdZdZdZdZRS(s A handler class which writes logging records, in pickle format, to a datagram socket. The pickle which is sent is that of the LogRecord's attribute dictionary (__dict__), so that the receiver does not need to have the logging module installed in order to process the logging event. To unpickle the record at the receiving end into a LogRecord, use the makeLogRecord function. cCs ti|||d|_dS(sP Initializes the handler with a specific host address and port. iN(RQRRRSRTRV(RRSRT((R RscCstititi}|S(su The factory method of SocketHandler is here overridden to create a UDP socket (SOCK_DGRAM). N(R[R\t SOCK_DGRAMRO(RRO((R R_scCsA|idjo|in|ii||i|ifdS(s Send a pickled string to a socket. This function no longer allows for partial sends which can happen when the network is busy - UDP does not guarantee delivery and can deliver packets out of sequence. N(RRURRctsendtoRORSRT(RRO((R Rhs(RRRRR_Rh(((R Rus   t SysLogHandlercBstZdZdZdZdZdZdZdZdZ dZ dZ dZ dZ dZdZdZdZdZd Zd Zd Zd Zd ZdZdZdZdZdZdZhde<de<de<de <de<de<de<de <de<de<de<de%scCsZt|tijo|i|}nt|tijo|i|}n|d>|BS(s Encode the facility and priority. You can pass in strings or integers - if strings are passed, the facility_names and priority_names mapping dictionaries are used to convert them to integers. iN(RRRRRtfacility_namestprioritytpriority_names(RRR((R tencodePriorityYs cCs/|io|iintii|dS(s$ Closes the socket. N(RRR[RRRR(R((R Rfs cCs|i|}|i|i|iti|i |f}yu|i oQy|i i |Wqt i j o'|i|i|i i |qXn|i i||iWn/ttfj o n|i|nXdS(s Emit a record. The record is formatted, and then sent to the syslog server. If exception information is present, it is NOT sent to the server. N(RR'R R(tlog_format_stringRRR6tlowert levelnameRR[RhRjRRRwRRR(RR R(((R Rns" ('RRRt LOG_EMERGt LOG_ALERTtLOG_CRITtLOG_ERRt LOG_WARNINGt LOG_NOTICEtLOG_INFOt LOG_DEBUGtLOG_KERNtLOG_USERtLOG_MAILt LOG_DAEMONtLOG_AUTHt LOG_SYSLOGtLOG_LPRtLOG_NEWStLOG_UUCPtLOG_CRONt LOG_AUTHPRIVt LOG_LOCAL0t LOG_LOCAL1t LOG_LOCAL2t LOG_LOCAL3t LOG_LOCAL4t LOG_LOCAL5t LOG_LOCAL6t LOG_LOCAL7RRtSYSLOG_UDP_PORTRRRRRR(((R RxsH  r  t SMTPHandlerc BsztZdZdZdZddddddd gZed d d d ddddddddg ZdZdZ RS(sK A handler class which sends an SMTP email for each logging event. cCstii|t|tijo"|\}}||_||_ n||_d|_ ||_ t|tijo |g}n||_ ||_dS(s Initialize the handler. Initialize the instance with the from and to addresses and subject line of the email. To specify a non-standard SMTP port, use the (host, port) tuple format for the mailhost argument. N(RRRRRRtmailhostRt TupleTypeRSRTtmailportRtfromaddrttoaddrsRtsubject(RRRRRRSRT((R Rs        cCs|iS(s Determine the subject for the email. If you want to specify a subject line which is record-dependent, override this method. N(RR(RR ((R t getSubjectstMontTuetWedtThutFritSattSuntJantFebtMartAprtMaytJuntJultAugtSeptOcttNovtDecc Csatiti\ }}} }}}}}} d|i || |i |||||f}|S(s Return the current date and time formatted for a MIME header. Needed for Python 1.5.2 (no email package available) s#%s, %02d %3s %4d %02d:%02d:%02d GMTN(R:tgmtimetyeartmonthRIthhtmmtsstwdtytzRt weekdaynamet monthnameRO( RRRRORRRRRRRI((R t date_times0-cCsydk}ydkl}Wn|i}nX|i}|p |i}n|i|i |}|i |}d|iti|id|i|||f}|i|i|i||iWn/ttfj o n|i|nXdS(sd Emit a record. Format the record and send it to the specified addressees. N(s formatdates-From: %s To: %s Subject: %s Date: %s %st,(tsmtplibt email.Utilst formatdateRRRRTt SMTP_PORTtSMTPRtsmtpR'R R(RR6tjoinRRtsendmailtquitRRR(RR RRR(RRT((R Rs&    7( RRRRRRRRRR(((R Rs   - tNTEventLogHandlercBsJtZdZeddZdZdZdZdZdZ RS(s A handler class which sends events to the NT Event Log. Adds a registry entry for the specified application name. If no dllname is provided, win32service.pyd (which contains some basic message placeholders) is used. Note that use of these placeholders will make your event logs big, as the entire message source is held in the log. If you want slimmer logs, you have to pass in the name of your own DLL which contains the message definitions you want to use in the event log. t ApplicationcCs:tii|ydk}dk}||_||_|pKt i i |ii }t i i |d}t i i |dd}n||_||_|ii||||i|_hti|i<ti|i<ti|i<ti|i<ti|i<|_Wn!tj odGHd|_nXdS(Niswin32service.pydsWThe Python Win32 extensions for NT (service, event logging) appear not to be available.(RRRRRtwin32evtlogutilt win32evtlogtappnamet_welutdllnameR!R"tsplitt__file__RtlogtypetAddSourceToRegistrytEVENTLOG_ERROR_TYPEtdeftypetDEBUGtEVENTLOG_INFORMATION_TYPEtINFOtWARNINGtEVENTLOG_WARNING_TYPEtERRORtCRITICALttypemapt ImportErrorR(RRRRRR((R Rs"     XcCsdS(sy Return the message ID for the event record. If you are using your own messages, you could do this by having the msg passed to the logger being an ID rather than a formatting string. Then, in here, you could use a dictionary lookup to get the message ID. This version returns 1, which is the base message ID in win32service.pyd. iN((RR ((R t getMessageIDscCsdS(s Return the event category for the record. Override this if you want to specify your own categories. This version returns 0. iN((RR ((R tgetEventCategory scCs|ii|i|iS(s Return the event type for the record. Override this if you want to specify your own types. This version does a mapping using the handler's typemap attribute, which is set up in __init__() to a dictionary which contains mappings for DEBUG, INFO, WARNING, ERROR and CRITICAL. If you are using your own levels you will either need to override this method or place a suitable dictionary in the handler's typemap attribute. N(RR tgetR tlevelnoR(RR ((R t getEventTypes cCs|ioyb|i|}|i|}|i|}|i |}|ii |i ||||gWqt tfj o q|i|qXndS(s Emit a record. Determine the message ID, event category and event type. Then log the message in the NT event log. N(RRR R tidR tcatRRR'R(t ReportEventRRRR(RR RR(RR((R R"s &cCstii|dS(sS Clean up this handler. You can remove the application name from the registry as a source of event log entries. However, if you do this, you will not be able to see the events as you intended in the Event Log Viewer - it needs to be able to access the registry to get the DLL name. N(RRRRR(R((R R5s ( RRRRRR R RRR(((R Rs  t HTTPHandlercBs,tZdZddZdZdZRS(s^ A class which sends records to a Web server, using either GET or POST semantics. tGETcCs^tii|ti|}|ddgjo tdn||_||_ ||_dS(sr Initialize the instance with the host, the request URL, and the method ("GET" or "POST") RtPOSTsmethod must be GET or POSTN( RRRRRR6R7tmethodR?RSturl(RRSRR((R RGs   cCs|iS(s Default implementation of mapping the log record into a dict that is sent as the CGI data. Overwrite in your class. Contributed by Franz Glasner. N(R Rp(RR ((R t mapLogRecordTsc Csyedk}dk}|i}|i|}|i}|i|i|} |i djoAt i |ddjo d}nd}|d|| f}n|i|i |t i |d}|djo|| }n|id||i d jo0|id d |id tt| n|i|i d jo|i| n|iWn/ttfj o n|i|nXdS( sh Emit a record. Send the record to the Web server as an URL-encoded dictionary NRt?it&s%c%st:tHostRs Content-types!application/x-www-form-urlencodedsContent-length(thttplibturllibRRStHTTPR-Rt urlencodeRR tdataRR6tfindtsept putrequestRt putheadertstrR+t endheadersRhtgetreplyRRR( RR RR$RR-RRSRR"((R R\s:       (RRRRRR(((R RBs  tBufferingHandlercBs;tZdZdZdZdZdZdZRS(s A handler class which buffers logging records in memory. Whenever each record is added to the buffer, a check is made to see if the buffer should be flushed. If it should, then flush() is expected to do what's needed. cCs&tii|||_g|_dS(s> Initialize the handler with the buffer size. N(RRRRRtcapacitytbuffer(RR+((R Rs cCst|i|ijS(s Should the handler flush its buffer? Returns true if the buffer is up to capacity. This method can be overridden to implement custom flushing strategies. N(R+RR,R+(RR ((R t shouldFlushscCs2|ii||i|o|indS(s Emit a record. Append the record. If shouldFlush() tells us to, call flush() to process the buffer. N(RR,tappendR R-tflush(RR ((R RscCs g|_dS(sw Override to implement custom flushing behaviour. This version just zaps the buffer to empty. N(RR,(R((R R/scCs|itii|dS(sp Close the handler. This version just flushes and chains to the parent class' close(). N(RR/RRRR(R((R Rs (RRRRR-RR/R(((R R*s   t MemoryHandlercBsDtZdZeiedZdZdZdZ dZ RS(s A handler class which buffers logging records in memory, periodically flushing them to a target handler. Flushing occurs whenever the buffer is full, or when an event of a certain severity or greater is seen. cCs&ti||||_||_dS(s Initialize the handler with the buffer size, the level at which flushing should occur and an optional target. Note that without a target being set either here or via setTarget(), a MemoryHandler is no use to anyone! N(R*RRR+t flushLevelttarget(RR+R1R2((R Rs cCs)t|i|ijp|i|ijS(sP Check for buffer full or a record at the flushLevel or higher. N(R+RR,R+R RR1(RR ((R R-scCs ||_dS(s: Set the target handler for this handler. N(R2R(RR2((R t setTargetscCs?|io1x!|iD]}|ii|qWg|_ndS(s For a MemoryHandler, flushing means just sending the buffered records to the target, if there is one. Override if you want different behaviour. N(RR2R,R thandle(RR ((R R/s   cCs$|id|_ti|dS(sD Flush, set the target to None and lose the buffer. N(RR/RR2R*R(R((R Rs  ( RRRRRRRR-R3R/R(((R R0s    (!RtsysRR[RR!R6RnRqR:RNRR RtDEFAULT_TCP_LOGGING_PORTtDEFAULT_UDP_LOGGING_PORTtDEFAULT_HTTP_LOGGING_PORTtDEFAULT_SOAP_LOGGING_PORTRRGRRRR,RRRQRuRxRRRR*R0(RuRRR,RR6RqR8R7RRGR9RNRnR0R6RRR5RRRR[RxR*R:RQR!((R Rs,Z   G&Rd@3