U Acj(@sdZddlZddlZddlZddlmZmZddlmZm Z ddl m Z m Z m Z mZddlmZddlmZmZmZmZmZmZmZmZGdd d ejZd d ZGd d d ejZddZdS)z9 Support for creating a service which runs a web server. N)servicestrports) interfacesreactor) deprecatereflect threadpoolusage)pb)demodistribresourcescriptserverstatictwcgiwsgic@s"eZdZdZdZddddgddd d gd d d d ggZdddgdddggZedddej j fdge j e de de dddZdZddZddZeZd d!Zd"d#Zd$d%ZeZd&d'ZeZd(d)Zd*d+Zd,d-Zd.d/Zd0d1Zd2d3ZeZd4d5Z d6d7Z!d8d9Z"d:d;Z#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. notracebacksnzY(DEPRECATED: Tracebacks are disabled by default. See --enable-tracebacks to turn them on.display-tracebackszShow uncaught exceptions during rendering tracebacks to the client. WARNING: This may be a security risk and expose private data!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)r r__init__selfr(3/tmp/pip-unpacked-wheel-nrvc_22y/twisted/web/tap.pyr%Xs  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)rgetDeprecationWarningStringopt_port incrementalVersionwarningswarnDeprecationWarningr'r#msgr(r(r)r2`s 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)rr1 opt_httpsr3r4r5r6r7r8r(r(r)r:ms 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_listenxszOptions.opt_listencCs|d|dS)zr Add the name of a file used to check for directory indexes. [default: index, index.html] rNr;)r'Z indexNamer(r(r) opt_indexszOptions.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_userszOptions.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'rCr(r(r)opt_paths  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) isinstancerrAr UsageErrorsplitr namedClassrE)r'procextklassr(r(r) opt_processors zOptions.opt_processorcCst|}||d<dS)zN Create a Resource subclass with a zero-argument constructor. r N)rrL)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|YnXt}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: aftershutdownr N)rZnamedAnyAttributeError ValueErrorr rJrZ ThreadPoolrZcallWhenRunningstartZaddSystemEventTriggerstoprZ WSGIResource)r'rRZ applicationpoolr(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)rIrrAr rJ defaultType)r'r\r(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.*NrIrrAr rJZ 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'rNr(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". :rHr!N)rKr<strip)r'headerrRvaluer(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<rZ namedModule ImportErrorr rJformatlenrBrC expanduserjoinr r?userSocketName)r'Z sslStrportrCr(r(r) postOptionss(  zOptions.postOptions)$__name__ __module__ __qualname____doc__ZsynopsisZ optParametersZoptFlagsr<r r?rmr Z CompletionsZ CompleteFilesZcompDataZlongdescr%r2Zopt_pr:r=r>Zopt_ir@Zopt_urFrPrQrSr[r]Zopt_mr`rarfrnr(r(r(r)rsx        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)makePersonalServerFactorysrtc@seZdZddZddZdS)_AddHeadersResourcecCs||_||_dSN)_originalResource_headers)r'ZoriginalResourceheadersr(r(r)r%sz_AddHeadersResource.__init__cCs,|jD]\}}|j||q|j||Srv)rxZresponseHeadersZ addRawHeaderrwgetChildWithDefault)r'rRrequestrvr(r(r)rzsz'_AddHeadersResource.getChildWithDefaultN)rorprqr%rzr(r(r(r)rusruc Cst}|dr0|d}|dr8|d|d_nt}t|tjrT|j t j ||drjt ||d}|drt j||dd}n t |}|drd|_|drtd td d d d }tj|tdd|drt|}|dD]}t||}||q|S)Nr rr!r)ZlogPathrTrz--notracebacksr*rr-r.rr")rZ MultiServiceZ indexNamesr ZTestrIrrAregistryZ setComponentrZIServiceCollectionrurZSiteZdisplayTracebacksrZ_getDeprecationWarningStringr3r4r5r6r7rtrZsetServiceParent)configsr rsr9r#Zsvcr(r(r) makeServices6     r)rrrBr5r3Ztwisted.applicationrrZtwisted.internetrrZtwisted.pythonrrrr Ztwisted.spreadr Z twisted.webr r r rrrrrrrtResourcerurr(r(r(r)s (s