U  W[v&@sdZddlmZmZddlZddlZddlZddlmZm Z ddl m Z m Z ddl mZmZmZmZddlmZddlmZdd lmZmZmZmZmZmZdd lmZGd d d ejZd dZGdddejZ ddZ!dS)z9 Support for creating a service which runs a web server. )absolute_importdivisionN)servicestrports) interfacesreactor)usagereflect threadpool deprecate)pb)distrib)resourceserverstaticscriptdemowsgi)twcgic@seZdZdZdZddddgddd d gd d d d ggZdddggZedddej j fdge j e de de dddZdZddZddZeZddZd d!Zd"d#ZeZd$d%ZeZd&d'Zd(d)Zd*d+Zd,d-Zd.d/Zd0d1ZeZd2d3Z d4d5Z!d6d7Z"d8d9Z#dS):OptionszB Define the options accepted by the I{twistd web} plugin. z [web options]logfilelNz/Path to web CLF (Combined Log Format) log file. certificatecz server.pemz=(DEPRECATED: use --listen) SSL certificate to use for HTTPS. privkeykz<(DEPRECATED: use --listen) SSL certificate to use for HTTPS. notracebacksnzcDo not display tracebacks in broken web pages. Displaying tracebacks to users may be security risk!personalzvInstead of generating a webserver, generate a ResourcePublisher which listens on the port given by --listen, or ~/%s zif --listen is not specified.z*.logz*.pem)rrr)Z optActionszThis starts a webserver. If you specify no arguments, it will be a demo webserver that has the Test class from twisted.web.demo in it.cCs@tj|g|d<d|d<g|d<g|d<d|d<|d<dS)Nindexesroot extraHeadersportsporthttps)rr__init__selfr)1/usr/lib/python3/dist-packages/twisted/web/tap.pyr&?s  zOptions.__init__c Cs6t|jtdddd}tj|tdd||d<dS) zh (DEPRECATED: use --listen) Strports description of port to start the server on Twistedrcategory stacklevelr$N)r getDeprecationWarningStringopt_port incrementalVersionwarningswarnDeprecationWarningr(r$msgr)r)r*r3Hs zOptions.opt_portc Cs6t|jtdddd}tj|tdd||d<dS) zW (DEPRECATED: use --listen) Port to listen on for Secure HTTP. r+r,r-rr.r/r%N)r r2 opt_httpsr4r5r6r7r8r9r)r)r*r;Ts zOptions.opt_httpscCs|d|dS)zi Add an strports description of port to start the server on. [default: tcp:8080] r#Nappend)r(r$r)r)r* opt_listen_szOptions.opt_listencCs|d|dS)zr Add the name of a file used to check for directory indexes. [default: index, index.html] r Nr<)r(Z indexNamer)r)r* opt_indexgszOptions.opt_indexcCst|d<dS)zc Makes a server with ~/public_html and ~/.twistd-web-pb support for users. r!N)r UserDirectoryr'r)r)r*opt_userqszOptions.opt_usercCs>ttj||d<tjtjd|d_t j |djd<dS)z is either a specific file or a directory to be set as the root of the web server. Use this if you have a directory full of HTML, cgi, epy, or rpy files or any other files that you want to be served up raw. r!)z.epyz.rpyz.cgiN) rFileospathabspathrZ PythonScriptZResourceScript processorsrZ CGIScript)r(rDr)r)r*opt_path{s  zOptions.opt_pathcCsBt|dtjstd|dd\}}t||dj|<dS)zh `ext=class' where `class' is added as a Processor for files ending with `ext'. r!z*You can only use --processor after --path.=N) isinstancerrBr UsageErrorsplitr namedClassrF)r(procextklassr)r)r* opt_processors zOptions.opt_processorcCst|}||d<dS)zN Create a Resource subclass with a zero-argument constructor. r!N)r rM)r(Z classNameZclassObjr)r)r* opt_classs zOptions.opt_classcCst||d<dS)zP An .rpy file to be used as the root resource of the webserver. r!N)rZResourceScriptWrapper)r(namer)r)r*opt_resource_scriptszOptions.opt_resource_scriptc Csrzt|}Wn(ttfk r6td|fYnXt}t |j t dd|j t t|||d<dS)zo The FQPN of a WSGI application object to serve as the root resource of the webserver. zNo such WSGI application: %rZafterZshutdownr!N)r ZnamedAnyAttributeError ValueErrorrrKr Z ThreadPoolrZcallWhenRunningstartZaddSystemEventTriggerstoprZ WSGIResource)r(rSZ applicationZpoolr)r)r*opt_wsgis zOptions.opt_wsgicCs(t|dtjstd||d_dS)zA Specify the default mime-type for static files. r!z*You can only use --mime_type after --path.N)rJrrBrrK defaultType)r(rZr)r)r* opt_mime_types zOptions.opt_mime_typecCs,t|dtjstd|dddS)zT Specify whether or not a request for 'foo' should return 'foo.ext' r!z1You can only use --allow_ignore_ext after --path.*NrJrrBrrKZ ignoreExtr'r)r)r*opt_allow_ignore_exts zOptions.opt_allow_ignore_extcCs,t|dtjstd|d|dS)zT Specify an extension to ignore. These will be processed in order. r!z+You can only use --ignore_ext after --path.Nr])r(rOr)r)r*opt_ignore_exts zOptions.opt_ignore_extcCs.|dd\}}|d||fdS)z Specify an additional header to be included in all responses. Specified as "HeaderName: HeaderValue". :rIr"N)rLr=strip)r(headerrSvaluer)r)r*opt_add_headerszOptions.opt_add_headercCs|ddk r|d|d|ddk rztdWntk rVtdYnXd|d|d|d }|d|t|dd kr|d rtj tj d t j j}|dd |n|dddS)a@ Set up conditional defaults and check for dependencies. If SSL is not available but an HTTPS server was configured, raise a L{UsageError} indicating that this is not possible. If no server port was supplied, select a default appropriate for the other options supplied. r$Nr#r%z OpenSSL.SSLzSSL support not installedz$ssl:port={}:privateKey={}:certKey={}rrrr~zunix:ztcp:8080)r=r Z namedModule ImportErrorrrKformatlenrCrD expanduserjoinr r@userSocketName)r(Z sslStrportrDr)r)r* postOptionss(  zOptions.postOptions)$__name__ __module__ __qualname____doc__ZsynopsisZ optParametersZoptFlagsr=r r@rkrZ CompletionsZ CompleteFilesZcompDataZlongdescr&r3Zopt_pr;r>r?Zopt_irAZopt_urGrQrRrTrYr[Zopt_mr^r_rdrlr)r)r)r*rsh        rcCstt|S)z Create and return a factory which will respond to I{distrib} requests against the given site. @type site: L{twisted.web.server.Site} @rtype: L{twisted.internet.protocol.Factory} )r ZPBServerFactoryr ZResourcePublisher)siter)r)r*makePersonalServerFactorysrrc@seZdZddZddZdS)_AddHeadersResourcecCs||_||_dSN)_originalResource_headers)r(ZoriginalResourceZheadersr)r)r*r& sz_AddHeadersResource.__init__cCs,|jD]\}}|j||q|j||Srt)rvZresponseHeadersZ addRawHeaderrugetChildWithDefault)r(rSZrequestrvr)r)r*rwsz'_AddHeadersResource.getChildWithDefaultN)rmrnror&rwr)r)r)r*rssrscCst}|dr0|d}|dr8|d|d_nt}t|tjrT|j t j ||drjt ||d}|drt j||dd}n t |}|d |_|drt|}|dD]}t||}||q|S) Nr!r r"r)ZlogPathrrr#)rZ MultiServiceZ indexNamesrZTestrJrrBregistryZ setComponentrZIServiceCollectionrsrZSiteZdisplayTracebacksrrrZsetServiceParent)Zconfigsr!rqr$Zsvcr)r)r* makeServices(      r{)"rpZ __future__rrrCr6r4Ztwisted.applicationrrZtwisted.internetrrZtwisted.pythonrr r r Ztwisted.spreadr Z twisted.webr rrrrrrrrrrZResourcersr{r)r)r)r*s     e