gFdZddlZddlmZddlmZmZmZmZddlm Z m Z ddlm ZddlmZmZdZd ZGd d eZGd d eZGddeZGddeZGddeZGddeZGddeZGddeZGddeZedxZZeej>e_edej@e_ edejBd e_!edejDe_"ed!ejFe_$ed!ejJe_&ed"ejNd# e_'eejPe_)ed$ejTd% e_+edejXe_,ed&ejZd' e_.ed$ej^d( e_/eej`e_0eejbe_1ee_ ee jde_3ed&ejhd)e_ ed$ejje_5edejle_6edejne_7ed&ejpd* e_8ed$ejre_9edejte_:edejPe_(edejvd e_;edejxd e_<ed&ejzd e_=ed&ej|d+ e_ed&ej~d+ e_ed&ejd, e_A[[[[y)-aCherryPy tools. A "tool" is any helper, adapted to CP. Tools are usually designed to be used in a variety of ways (although some may only offer one if they choose): Library calls All tools are callables that can be used wherever needed. The arguments are straightforward and should be detailed within the docstring. Function decorators All tools, when called, may be used as decorators which configure individual CherryPy page handlers (methods on the CherryPy tree). That is, "@tools.anytool()" should "turn on" the tool via the decorated function's _cp_config attribute. CherryPy config If a tool exposes a "_setup" callable, it will be called once per Request (if the feature is "turned on" via config). Tools may be implemented as any object with a namespace. The builtins are generally either modules or instances of the tools.Tool class. Nexpose)cptoolsencodingstatic jsontools)sessions xmlrpcutil)caching) auth_basic auth_digestcddl}t||jr |j}|j}|j d|j S)z?Return the names of all static arguments to the given function.rN)types isinstance MethodType__func____code__ co_varnames co_argcount)funcrcos &/opt/Tautulli/lib/cherrypy/_cptools.py_getargsr"s>$(()}} B >>/2>> **zCherryPy Tools cannot be turned on directly. Instead, turn them on via config, or use them as decorators on your page handlers.cjeZdZdZdZd dZedZejdZdZ d dZ d Z d Z y) ToolzA registered function for use with CherryPy request-processing hooks. help(tool.callable) should give you more information about this Tool. toolsNc||_||_||_||_|jj|_|j yN)_pointcallable_name _priority__doc___setargs)selfpointr!nameprioritys r__init__z Tool.__init__;s8    !}},,  rc ttrAttributeError _attr_errorr&s ronzTool.onC [))rc ttrr,)r&values rr0zTool.onGr1rc8 t|jD]}t||dy#ttf$rLt |jdr3t|jj D]}t||dYyYyt$rYyt$rYywxYw)z,Copy func parameter names to obj attributes.N__call__) rr!setattr TypeErrorr-hasattrr5NotImplementedError IndexError)r&args rr%z Tool._setargsKs  . )c4( )>* -t}}j1#DMM$:$:;-CD#t,-2 #     s'*ABBBBc|r|j}ni}tjjj|j }|j |vr|j||j d|vr|d=|S)z5Return a dict of configuration entries for this Tool.r0)copycherrypyservingrequesttoolmaps namespacer"update)r&dconftms r _merged_argszTool._merged_args^sh 668DD    % % . .t~~ > ::  KK4:: ' 4<T  rcJ|rtdjzfd}|S)zCompile-time decorator (turn on the tool in config). For example:: @expose @tools.proxy() def whats_my_base(self): return cherrypy.request.base zQThe %r Tool does not accept positional arguments; you must use keyword arguments.ct|dsi|_jdzjzdz}d|j|dz<j D]\}}||j||z<|S)N _cp_config.Tr0)r8rJrBr"items)fsubspacekvkwargsr&s rtool_decoratorz%Tool.__call__..tool_decorator}sr1l+! ~~+djj83>H,0ALLD )  /1-. X\* /Hr)r7r")r&argsrQrRs` ` rr5z Tool.__call__ns4 I"jj)* * rc$|j}|jdd}|!t|jd|j}t j jjj|j|jfd|i|yHook this tool into cherrypy.request. The standard CherryPy request object will automatically call this method when the tool is "turned on" in config. r)N) rGpopgetattrr!r#r>r?r@hooksattachr r&rEps r_setupz Tool._setup|   " HHZ & 9 z4>>BA  &&--dkk4== B78 B<@ Br)N2r) __name__ __module__ __qualname__r$rBr*propertyr0setterr%rGr5r]rrrr2sT I**YY**& 2 Brrc*eZdZdZddZdZdZdZy) HandlerToolaTool which is called 'before main', that may skip normal handlers. If the tool successfully handles the request (by setting response.body), if should return True. This will cause CherryPy to skip any 'normal' page handler. If the tool did not handle the request, it should return False to tell CherryPy to continue on and call the normal page handler. If the tool is declared AS a page handler (see the 'handler' method), returning False will raise NotFound. Nc4tj|d||y)Nbefore_handlerrr*r&r!r(s rr*zHandlerTool.__init__s d,h=rc,tfd}|S)zUse this tool as a CherryPy page handler. For example:: class Root: nav = tools.staticdir.handler(section="/nav", dir="nav", root=absDir) cjij}|stjtjj j Sr)r!rGr>NotFoundr?responsebody)akwhandledrSrQr&s r handle_funcz(HandlerTool.handler..handle_funcsM#dmmTGT->->v-FGG''))##,,11 1rr)r&rSrQrts``` rhandlerzHandlerTool.handlers  2  2 rc h|jdi|r dtjj_yyNre)r!r>r?r@ru)r&rQs r_wrapperzHandlerTool._wrappers, 4== "6 "/3H   $ $ , #rc$|j}|jdd}|!t|jd|j}t j jjj|j|jfd|i|yrU) rGrWrXr!r#r>r?r@rYrZr rxr[s rr]zHandlerTool._setupr^rr)r`rarbr$r*rurxr]rerrrgrgs >"4 Brrgc"eZdZdZ ddZdZy)HandlerWrapperToola)Tool which wraps request.handler in a provided wrapper function. The 'newhandler' arg must be a handler wrapper function that takes a 'next_handler' argument, plus ``*args`` and ``**kwargs``. Like all page handler functions, it must return an iterable for use as cherrypy.response.body. For example, to allow your 'inner' page handlers to return dicts which then get interpolated into a template:: def interpolator(next_handler, *args, **kwargs): filename = cherrypy.request.config.get('template') cherrypy.response.template = env.get_template(filename) response_dict = next_handler(*args, **kwargs) return cherrypy.response.template.render(**response_dict) cherrypy.tools.jinja = HandlerWrapperTool(interpolator) Nc<||_||_||_||_yr) newhandlerr r"r#)r&r}r'r(r)s rr*zHandlerWrapperTool.__init__s$  !rctjjjfd}|tjj_y)Nc0jg|i|Sr)r})rSrQ innerfuncr&s rwrapz)HandlerWrapperTool.callable..wraps"4??9>t>v> >r)r>r?r@ru)r&rSrQrrs` @rr!zHandlerWrapperTool.callables3$$,,44  ?+/  (r)riNr_)r`rarbr$r*r!rerrr{r{s$AE"0rr{c$eZdZdZddZdZdZy) ErrorToolzATool which is used to replace the default request.error_response.Nc4tj|d||yrrjrks rr*zErrorTool.__init__s dD(D1rcD|jdi|jyrw)r!rGr/s rrxzErrorTool._wrappers ,))+,rcV|jtjj_y)rVN)rxr>r?r@error_responser/s rr]zErrorTool._setups 37--  /rr)r`rarbr$r*rxr]rerrrrsK2-@rrc(eZdZdZdZdZdZdZy) SessionToolarSession Tool for CherryPy. sessions.locking When 'implicit' (the default), the session will be locked for you, just before running the page handler. When 'early', the session will be locked before reading the request body. This is off by default for safety reasons; for example, a large upload would block the session, denying an AJAX progress meter (`issue `_). When 'explicit' (or any other value), you need to call cherrypy.session.acquire_lock() yourself before using session data. cNtj|dtjy)Nbefore_request_body)rr* _sessionsinitr/s rr*zSessionTool.__init__s d19>>BrcTtjjjyr)r>r?session acquire_lockr/s r _lock_sessionzSessionTool._lock_sessions  --/rc\tjjj}|j }|j dd}|!t |jd|j}|j|j|jfd|i||j dd}|dk(r|jd|jn%|dk(r|jd|jd n |jd tj|jd tjy) rVr)Nlockingimplicitriearlyr<r)before_finalizeon_end_request)r>r?r@rYrGrWrXr!r#rZr rrsaveclose)r&rYrEr\rs rr]zSessionTool._setups   ((..  " HHZ & 9 z4>>BA T[[$--D!DtD((9j1 j LL)4+=+= >   LL.0B0B"$  &  & 7 %y7rctjj}|jdt fd|j j D}tjdi|y)zz)SessionTool.regenerate..<s( 1H}F sNre) r>r?r regeneratedictrGrLrset_response_cookie)r&sessrErs @rrzSessionTool.regenerate5sb'' P ))+113   %%--rN)r`rarbr$r*rr]rrerrrrs"C08< .rrc(eZdZdZddiZedZy)XMLRPCControllera]A Controller (page handler collection) for XML-RPC. To use it, have your controllers subclass this base class (it will turn on the tool for you). You can also supply the following optional config entries:: tools.xmlrpc.encoding: 'utf-8' tools.xmlrpc.allow_none: 0 XML-RPC is a rather discontinuous layer over HTTP; dispatching to the appropriate handler must first be performed according to the URL, and then a second dispatch step must take place according to the RPC method specified in the request body. It also allows a superfluous "/RPC2" prefix in the URL, supplies its own handler args in the body, and requires a 200 OK "Fault" response instead of 404 when the desired method is not found. Therefore, XML-RPC cannot be implemented for CherryPy via a Tool alone. This Controller acts as the dispatch target for the first half (based on the URL); it then reads the RPC method from the request body and does its own second dispatch step based on that method. It also reads body params, and returns a Fault on error. The XMLRPCDispatcher strips any /RPC2 prefix; if you aren't using /RPC2 in your URL's, you can safely skip turning on the XMLRPCDispatcher. Otherwise, you need to use declare it in config:: request.dispatch: cherrypy.dispatch.XMLRPCDispatcher() ztools.xmlrpc.onTctj\}}|}t|jdD]}t ||d}|rt |ddr |||zi|}nt dzt jjjdjdi}tj||jdd|jd d t jjjS) NrKexposedFzmethod "%s" is not supportedrxmlrpcrzutf-8 allow_noner)_xmlrpc process_bodystrsplitrX Exceptionr>r?r@rAgetrespondrorp) r&vpathparams rpcparams rpcmethod subhandlerattrrprEs rdefaultzXMLRPCController.defaultis&335 9  N((- 9D T48J 9 '*i? 1=f=D:TAB B''009==hKW5q1 3((---rN)r`rarbr$rJrrrerrrrDs&D$T*J . .rrc eZdZy)SessionAuthToolN)r`rarbrerrrrsrrc*eZdZdZdZde_dZy) CachingToolzCaching Tool for CherryPy.c tjj}tjdi|rd|_y|j r-|jjdtjdyy)Nrdrre) r>r?r@_cachingrru cacheablerYrZ tee_output)r&rQr@s rrxzCachingTool._wrappers\""** << !& !"GO   $$%68K8K.1%3!rZc|j}|jdd}tjjj j d|jfd|i|y)z#Hook caching into cherrypy.request.r)Nri)rGrWr>r?r@rYrZrxr[s rr]zCachingTool._setups\  " HHZ &  &&--.>  B78 B<@ BrN)r`rarbr$rxr)r]rerrrrs$3HBrrc.eZdZdZdZdZdZdZdZy)ToolboxzA collection of Tools. This object also functions as a config namespace handler for itself. Custom toolboxes should be added to each Application's toolboxes dict. c||_yr)rB)r&rBs rr*zToolbox.__init__s "rct|tr$|j||_|j|_tj |||yr)rrr"rBobject __setattr__)r&r(r3s rrzToolbox.__setattr__s: eT "{{"" "nnEO4u-rcxixtjjj|j<fd}|S)z9Populate request.toolmaps from tools specified in config.c^|jdd\}}j|i}|||<y)NrK)r setdefault)rOrPtoolnamer;bucketmaps rpopulatez#Toolbox.__enter__..populates/GGCOMHc^^Hb1FF3Kr)r>r?r@rArB)r&rrs @r __enter__zToolbox.__enter__s4BDD  ))$..9C rctjjjj |j }|rH|j D]4\}}|j ddst||}|j6yy)z/Run tool._setup() for each tool in our toolmap.r0FN) r>r?r@rArrBrLrXr])r&exc_typeexc_valexc_tbrr(settingstools r__exit__zToolbox.__exit__sl&&//33DNNC "%))+ "h<<e,"4.DKKM " rc fd}|S)zb Return a decorator which registers the function at the given hook point. ctjd|j}t|fi}t|||S)Nr()rr`rr6)r attr_namerrQr'r&s r decoratorz#Toolbox.register..decorators9 64==9It.v.D D)T *Krre)r&r'rQrs``` rregisterzToolbox.registers   rN) r`rarbr$r*rrrrrerrrrs #." rrron_start_resourcerrbefore_error_responserrrKriFPr rr)Br$r>cherrypy._helperr cherrypy.librrrrr rr rr rr r rr.rrrgr{rrrrrrdefault_toolbox_d session_authallowproxyresponse_headers log_tracebacklog_tracebackslog_request_headers log_headers log_hooksredirect err_redirectvalidate_etagsetagsdecodeResponseEncoderencodegzip staticdir staticfileon_errorrrexpiresignore_headersreferertrailing_slashflattenacceptautovaryjson_injson_out basic_auth digest_authconvert_paramsrrerrrs20#==E,0+F `B6`BF/B$/Bd00D@@*C.$C.L;.v;.| k B$B.0f0fw''"!'"6"67 #W]] 3 %w}}r B.0H0HI0'2G2GH-w/J/JK$g&7&7#F G,,- !7#9#9B G & 8 !8#;#;b I  (--" =6++, F--. m g&& ' )8<< C #X%5%5 6 .0F0FG ' 9 )7+A+ABO #W__ 5 $gnn 5 &(8(89 &(8(81E '):):R H #Y%7%7"E %z'<'