gidZddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ejZ GddeZGddeZ ddlZddlZGd d eZGd d eZGddeZGddej.ZGddej2ZGddeZGddeZGddeZy#e$rd \ZZYywxYw)z2Site services for use with a Web Site Process Bus.N) text_or_bytes)ntobc(eZdZdZdZ dZdZdZy) SimplePluginzCPlugin base class which auto-subscribes methods for known channels.Nc||_yNbusselfr s -/opt/Tautulli/lib/cherrypy/process/plugins.py__init__zSimplePlugin.__init__(s c|jjD].}t||d}||jj||0y)z>Register this object as a (multi-channel) listener on the bus.N)r listenersgetattr subscriber channelmethods r rzSimplePlugin.subscribe+sCxx)) 4GT7D1F!""7F3  4rc|jjD].}t||d}||jj||0y)z0Unregister this object as a listener on the bus.N)r rr unsubscribers r rzSimplePlugin.unsubscribe3sCxx)) 6GT7D1F!$$Wf5  6r)__name__ __module__ __qualname____doc__r rrrrr rr!sM C46rrceZdZdZiZ iZ eejD].\Z Z e jdse jdr*e ee <0[ [ dZ d dZ dZdZd Zdd Zd d Zd Zy) SignalHandleraRegister bus channels (and listeners) for system signals. You can modify what signals your application listens for, and what it does when it receives signals, by modifying :attr:`SignalHandler.handlers`, a dict of {signal name: callback} pairs. The default set is:: handlers = {'SIGTERM': self.bus.exit, 'SIGHUP': self.handle_SIGHUP, 'SIGUSR1': self.bus.graceful, } The :func:`SignalHandler.handle_SIGHUP`` method calls :func:`bus.restart()` if the process is daemonized, but :func:`bus.exit()` if the process is attached to a TTY. This is because Unix window managers tend to send SIGHUP to terminal windows when the user closes them. Feel free to add signals which are not available on every platform. The :class:`SignalHandler` will ignore errors raised from attempting to register handlers for unknown signals. SIGSIG_c||_|jj|j|jjd|_t j dddk(rd|jd=|jj|jd<|jjd|j|jd<i|_ tj|_ y)N)SIGTERMSIGHUPSIGUSR1javar%SIGUSR2zASIGUSR1 cannot be set on the JVM platform. Using SIGUSR2 instead.SIGINT) r exit handle_SIGHUPgracefulhandlerssysplatformlog_jython_SIGINT_handler_previous_handlersosgetpid _original_pidr s r rzSignalHandler.__init___s$(HHMM#'#5#5$(HH$5$5 << v % i('+xx'8'8DMM) $ HHLL2 3&*&A&ADMM( #"$YY[rNcn|jjd|jjy)Nz%Keyboard Interrupt: shutting down bus)r r0r*)r signumframes r r1z$SignalHandler._jython_SIGINT_handlerrs   <=  rc|jtjk7xr2tjtj j  S)aReturn boolean indicating if the current process is running as a daemon. The criteria to determine the `daemon` condition is to verify if the current pid is not the same as the one that got used on the initial construction of the plugin *and* the stdin is not connected to a terminal. The sole validation of the tty is not enough when the plugin is executing inside other process like in a CI tool (Buildbot, Jenkins). )r5r3r4isattyr.stdinfilenor s r _is_daemonizedzSignalHandler._is_daemonizedws>   "))+ - . #))**,- - rc|jjD]\}} |j||y#t$rY'wxYw)z#Subscribe self.handlers to signals.N)r-items set_handler ValueError)r sigfuncs r rzSignalHandler.subscribesK,,. IC   d+   s7 AAc |jjD]\}}|j|}|/|jj d|zt j }n"|jj d|d|d t j||}|$|jj d|d|dd y#t$r(|jj d |d|dd d YwxYw)z'Unsubscribe self.handlers from signals.Nz Restoring %s handler to SIG_DFL.z Restoring z handler .z Restored old z%, but our handler was not registered.levelzUnable to restore (TrI traceback) r2r@signalsr r0_signalSIG_DFLsignalrB)r r7handlersigname our_handlers r rzSignalHandler.unsubscribes#66<<> KOFGll6*G ?'IJ!// 7GLM K%nnVW= &HHLL")7"4;=!? K K %w079TK Ks??G @,,v.F~~fd&9&9:*.'   HHLL,w6 7 HH  w 1  @ !5!>?? @s B44C c|j|}|jjd|z|jj|y)z?Python signal handler (self.set_handler subscribes it for you).zCaught signal %s.N)rMr r0publish)r r7r8rRs r rWzSignalHandler._handle_signals8,,v&  (723 !rc|jr6|jjd|jjy|jjd|jj y)z!Restart if daemonized, else exit.z+SIGHUP caught while daemonized. Restarting.z*SIGHUP caught but not daemonized. Exiting.N)r>r r0restartr*r=s r r+zSignalHandler.handle_SIGHUPsO    HHLLF G HH    HHLLE F HHMMOrNNr)rrrrr-rMvarsrNr@kv startswithrr1r>rrrArWr+rrr rr<s.HOG-W ##%1 << q||F';GAJ 1)&  $K*28" rrr^ceZdZdZd dZedZejdZedZejdZedZ e jd Z d Z d e _ y) DropPrivilegeszDrop privileges. uid/gid arguments not available on Windows. Special thanks to `Gavin Baker `_. Nchtj||d|_||_||_||_yNF)rr finalizeduidgidumask)r r rjrhris r rzDropPrivileges.__init__s.dC( rc|jS)zAThe uid under which to run. Availability: Unix. )_uidr=s r rhzDropPrivileges.uid yyrc|Ut'|jjddd}||_yt|trtj |d}||_y)Nz'pwd module not available; ignoring uid.rGrH)pwdr r0rUrgetpwnamrlr vals r rhzDropPrivileges.uid[ ?{ F#%' C/ll3'* rc|jS)zAThe gid under which to run. Availability: Unix. )_gidr=s r rizDropPrivileges.gidrmrc|Ut'|jjddd}||_yt|trtj |d}||_y)Nz'grp module not available; ignoring gid.rGrHro)grpr r0rUrgetgrnamrvrrs r rizDropPrivileges.gidrtrc|jS)zThe default permission mode for newly created files and directories. Usually expressed in octal format, for example, ``0644``. Availability: Unix, Windows. )_umaskr=s r rjzDropPrivileges.umasks{{rc| tj||_y||_y#t$r)|jj ddd}Y||_ywxYw)Nz-umask function not available; ignoring umask.rGrH)r3rjAttributeErrorr r0r{rrs r rjzDropPrivileges.umasksZ ?   c "  L#%'  s$(AAcd}|jr=|j |j|jj d|zn|j6|j*t st r|jj ddn|jj d|z|j4tj|jtjg|jtj|j|jj d|z|jr<|j|jj d|jzd |_y|j%|jj d dd |_ytj|j}|jj d ||jfzd |_y) Ncd\}}tr*tjtjd}tr*t j tj d}||fS)z+Return the current (uid, gid) if available.r^r)rpgetpwuidr3getuidrxgetgrgidgetgid)namegroups r current_idsz)DropPrivileges.start..current_ids$sM$KD%||BIIK03 RYY[1!4; rz"Already running as uid: %r gid: %rzuid/gid not setrGrHzStarted as uid: %r gid: %rzRunning as uid: %r gid: %rzumask already set to: %03oz umask not setzumask old: %03o, new: %03oT) rgrhrir r0rprxr3setgid setgroupssetuidrj)r r old_umasks r startzDropPrivileges.start"s  >>HH$)9 A(]+,xxDHH$4#HHLL!2"L= 9KMIJ88'IIdhh'LL$88'IIdhh' 9KMIJ >>zz% 9DJJFGzz! _B 7  HHTZZ0  9'456rM)NNN) rrrrrpropertyrhsetterrirjrpriorityrrr rdrds  ZZ ZZ \\(XENrrdcLeZdZdZ d dZdZde_eddddfdZy) DaemonizeraDaemonize the running script. Use this with a Web Site Process Bus via:: Daemonizer(bus).subscribe() When this component finishes, the process is completely decoupled from the parent environment. Please note that when this component is used, the return code from the parent process will still be 0 if a startup error occurs in the forked children. Errors in the initial daemonizing process still return proper exit codes. Therefore, if you use this plugin to daemonize, don't use the return code as an accurate indicator of whether the process fully started. In fact, that return code only indicates if the process successfully finished the first fork. /dev/nullchtj||||_||_||_d|_yrf)rrr;stdoutstderrrg)r r r;rrs r rzDaemonizer.__init__bs.dC(   rc~|jr|jjdtjdk7r2|jjdtj zd|j |j|j|j|jjd|_y)NzAlready deamonized.zHThere are %r active threads. Daemonizing now may cause strange failures.rGrHT) rgr r0 threading active_count enumerate daemonizer;rrr=s r rzDaemonizer.startjs >> HHLL. /  ! ! #q ( HHLLG",,./68  : tzz4;; TXX\\JrAcyrr)msgs r zDaemonizer.src tjjtjjd}t dD]Z}ddg|} t j }|dkDr||t jd|dk(sGt j\t jdt|d} t|d } t|d } t j| jtj jt j| jtjjt j| jtjj|d t j"zy#t$r9}tj|jt||dzYd}~pd}~wwxYw) Nz>{sys.argv[0]}: fork #{n} failed: ({exc.errno}) {exc.strerror} roz Forking once.zForking twice.rr)r.excnrza+zDaemonized to PID: %s)r.rflushrranger3fork_exitOSErrorr*formatsetsidrjopendup2r<r;r4) r;rrlogger error_tmplrrpidrsisoses r rzDaemonizer.daemonize}ss   N !H D"$45d;C Jggi73KHHQKqy    %  &$  &$   SYY--/0  SZZ..01  SZZ..01&45' J**stax*HII Js6F>> H.G;;HN)rrr) rrrrrrr staticmethodrrrr rrQs? 7B#"ENk+#*6*6rrc0eZdZdZdZdZde_dZy)PIDFilez!Maintain a PID file via a WSPBus.cLtj||||_d|_yrf)rrpidfilerg)r r rs r rzPIDFile.__init__s dC( rctj}|jr-|jj d|d|j dyt |j d5}|jtd|zdddd|jj d|d|j dd|_y#1swY=xYw) NzPID z already written to rFwbz%s utf8z written to T) r3r4rgr r0rrwriter)r rfs r rz PIDFile.startsiik >> HHLLCN OdllD) 4QVc\623 4 HHLLCF G!DN 4 4s $B??CFc tj|j|jj d|jzy#t t f$rt$rYywxYw)NzPID file removed: %r.)r3removerr r0KeyboardInterrupt SystemExit Exceptionr=s r r*z PIDFile.exitsS  IIdll # HHLL04<<? @!:.     sAA A%$A%N)rrrrrrrr*rrr rrs+ "ENrrc(eZdZdZfdZdZxZS)PerpetualTimeraA responsive subclass of threading.Timer whose run() method repeats. Use this timer only when you really need a very interruptible timer; this checks its 'finished' condition up to 20 times a second, which can results in pretty high CPU usage cZ|jdd|_tt||i|y)z:Override parent constructor to allow 'bus' to be provided.r N)popr superrr)r argskwargs __class__s r rzPerpetualTimer.__init__s)::eT* nd,d=f=rc^ |jj|j|jjry |j|j i|j h#t$r9|jr+|jjd|jzddwxYw)NTz,Error in perpetual timer thread function %r.rJrK) finishedwaitintervalisSetfunctionrrrr r0r=s r runzPerpetualTimer.runs MM  t}} -}}""$  tyy8DKK8   88HHLLF &-/4!A  s &A**AB,)rrrrrr __classcell__rs@r rrs> rrc6eZdZdZgidffd ZdZdZxZS)BackgroundTaskaA subclass of threading.Thread whose run() method repeats. Use this class for most repeating tasks. It uses time.sleep() to wait for each interval, which isn't very responsive; that is, even if you call self.cancel(), you'll have to wait until the sleep() call finishes before the thread stops. To compensate, it defaults to being daemonic, which means it won't delay stopping the whole process. Nctt| ||_||_||_||_d|_||_d|_ y)NFT) rrrrrrrrunningr daemon)r rrrrr rs r rzBackgroundTask.__init__sC nd,.        rcd|_yrf)rr=s r cancelzBackgroundTask.cancels  rcvd|_|jratj|j|jsy |j|j i|j |jr`yy#t$r9|jr+|jjd|jzddwxYw)NTz,Error in background task thread function %r.rJrK) rtimesleeprrrrrr r0r=s r rzBackgroundTask.runs ll JJt}} %<<  tyy8DKK8 ll  88HHLL!O#'=="18:d!L  s &A66AB8)rrrrrrrrrs@r rrs 1324  rrcJeZdZdZdZ dZ dZ d dZdZde_ dZ dZ y) MonitorzAWSPBus listener to periodically run a callback in its own thread.N<chtj||||_||_d|_||_yr)rrcallback frequencythreadr)r r rrrs r rzMonitor.__init__s.dC(  "  rc|jdkDr|jxs|jj}|j{t |j|j |j|_||j_|jj|jjd|zy|jjd|zyy)z0Start our callback in its own background thread.rNr zStarted monitor thread %r.z"Monitor thread %r already started.) rrrrrrrr rr0)r threadnames r rz Monitor.start$s >>A =dnn&=&=J{{",T^^T]]15; #-   !!# 9JFG AJNO rrc$|jA|jjd|jzxs|jj y|jt jur|jj}|jj|jjs8|jjd|z|jj|jjd|zd|_y)z+Stop our callback's background task thread.NzNo thread running for %s.z Joining %rStopped thread %r.) rr r0rrrrcurrent_threadrrjoin)r rs r stopz Monitor.stop2s ;;  HHLL4#>&*nn&=&= ?{{)":":"<<{{'' ""${{))HHLL!45KK$$& 1D89DKrcD|j|jy)z:Stop the callback's background task thread and restart it.N)rrr=s r r,zMonitor.gracefulAs  r)rN) rrrrrrrrrrrr,rrr rrs=KH,I4 F PEN rrceZdZdZdZ dZ dZ ddZdZde_ dZ e d Z e d Ze d Ze d Zd Zy) AutoreloaderaQMonitor which re-executes the process when files change. This :ref:`plugin` restarts the process (via :func:`os.execv`) if any of the files it monitors change (or is deleted). By default, the autoreloader monitors all imported modules; you can add to the set by adding to ``autoreload.files``:: cherrypy.engine.autoreload.files.add(myFile) If there are imported files you do *not* wish to monitor, you can adjust the ``match`` attribute, a regular expression. For example, to stop monitoring cherrypy itself:: cherrypy.engine.autoreload.match = r'^(?!cherrypy).+' Like all :class:`Monitor` plugins, the autoreload plugin takes a ``frequency`` argument. The default is 1 second; that is, the autoreloader will examine files once each second. Nr.*ci|_t|_||_tj |||j |yr)mtimessetfilesmatchrrr)r r rrs r rzAutoreloader.__init__es1 U  sDHHi8rcT|ji|_tj|y)z2Start our own background task thread for self.run.N)rrrrr=s r rzAutoreloader.startks ;; DK drrc Lttj|jjt t j j}tt j j|}ttdt|j|S)z1Return a Set of sys.modules filenames to monitor.N) filterrecompilerlistr.moduleskeysmapgetr_file_for_module)r search_mod_namesmodss r sysfileszAutoreloader.sysfilesrsn! JJtzz " ( ( !!# $ 3;;??$456$D$9$94 @ABBrcJ|j|xs|j|S)z(Return the relevant file for the module.)_archive_for_zip_module_file_for_file_moduleclsmodules r rzAutoreloader._file_for_module{s*  ' ' / 1((0 rcN |jjS#t$rYywxYw)z7Return the archive filename for the module if relevant.N) __loader__archiver})rs r rz$Autoreloader._archive_for_zip_modules+ $$,, ,   s  $$ct |jxr|j|jS#t$rYywxYw)zReturn the file for the module.N)__file___make_absoluter}rs r rz"Autoreloader._file_for_file_modules7 ??Js'9'9&//'J J   s (+ 77ctjj|r|Stjjtjj t |S)z8Ensure filename is absolute to avoid effect of os.chdir.)r3pathisabsnormpathr_module__file__base)filenames r rzAutoreloader._make_absolutesB77==2x GG  RWW\\*=xH I rcr|j|jzD]}|s|jdr|dd}|jj |d}|< t j |j}||jvr||j|<z|||kDs|jjd|z|jj|jjd|jjz|jjyy#t$rd}YwxYw)z:Reload the process if registered files have been modified.z.pycNrzRestarting because %s changed.r)rrendswithrrr3statst_mtimerr r0rrrr])r roldtimemtimes r rzAutoreloader.runs $**4 H$$V,'}H++//(A6?!GGH-66E 4;;.,1DKK)} %E%-&./ **, %9%)[[%5%5&67((*9 ! E!sD(( D65D6)rr)rrrrrrrrrrr classmethodrrrrrrrrr rrGs( E5IF E;9  ENC    rrc2eZdZdZdZ dZdZdZdZeZ y) ThreadManageraManager for HTTP request threads. If you have control over thread creation and destruction, publish to the 'acquire_thread' and 'release_thread' channels (for each thread). This will register/unregister the current thread and publish to 'start_thread' and 'stop_thread' listeners in the bus as needed. If threads are created and destroyed by code you do not control (e.g., Apache), then, at the beginning of every HTTP request, publish to 'acquire_thread' only. You should not publish to 'release_thread' in this case, since you do not know whether the thread will be re-used or not. The bus will call 'stop_thread' listeners for you when it stops. Nci|_tj|||jjj dt |jjj dt |jjj dt |jjj dt y)Nacquire_thread start_threadrelease_thread stop_thread)threadsrrr r setdefaultrr s r rzThreadManager.__init__s dC( %%&6> %%nce< %%&6> %%mSU;rctj}||jvrDt|jdz}||j|<|jj d|yy)zRun 'start_thread' listeners for the current thread. If the current thread has already been seen, any 'start_thread' listeners will not be run again. rr!N)_thread get_identr$lenr r[r thread_identis r r zThreadManager.acquire_threadsZ ((* t|| +DLL!A%A)*DLL & HH  ^Q / ,rctj}|jj|d}||jj d|yy)z;Release the current thread and run 'stop_thread' listeners.Nr#)r'r(r$rr r[r*s r r"zThreadManager.release_threadsD((* LL  \4 0 = HH  ]A . rc|jjD]!\}}|jjd|#|jj y)z8Release all threads and run all 'stop_thread' listeners.r#N)r$r@r r[clearr*s r rzThreadManager.stopsF#||113 /OL! HH  ]A . / r) rrrrr$rr r"rr,rrr rrs, G6< 0/ Hrr)rr3rrPrNr.rrr'cherrypy._cpcompatrrgetcwdrobjectrrrprx ImportErrorrdrrTimerrThreadrrrrrrr r6s8  ,#$ biik6666TFTn t\tnW6W6tl:Y__:'Y%%'T5l5pq7qh6L6KHCsC CC