o pj{ @sdZddlZddlZddlZddlmZddlmZddlm Z m Z m Z m Z m Z mZmZmZmZmZmZddlmZmZddlmZddlmZdd lmZdd lmZdd lm Z dd l!m"Z"dd l#m$Z$ddl%m&Z&ddl'm(Z(ddl)m*Z*m+Z+ddl,m-Z-m.Z.m/Z/ddl0m1Z1m2Z2m3Z3m4Z4ddl5m6Z6m7Z7m8Z8ddZ9de:de7de:fddZ;Gddde(j<Z=Gddde=Z>Gdd d e(j<Z?Gd!d"d"e(j<Z@Gd#d$d$e*ZAGd%d&d&e*ZBGd'd(d(e*ZCGd)d*d*e*ZDGd+d,d,ZEd-ZFGd.d/d/ejGejHZId0ee e eJfded1fd2d3ZKee8Gd4d5d5ZLGd6d7d7e*ZMd8d9ZNd:ZOeZPee8Gd;d<d<ZQee8Gd=d>d>ZRhd?ZSGd@dAdAZTeTZU B dIde7dCe6dDee:dEee e"gdFfdeVf dGdHZWdS)JzG twisted.web.util and twisted.web.template merged to avoid cyclic deps N) OrderedDictescape) IOAnyAnyStrCallableDictListMappingOptionalTupleUnioncast)handler make_parser)Locator) implementer)Deferred)Logger)urlpath)Failure)FilePath)fullyQualifiedName)resource)Elementrenderer) Flattenableflatten flattenString)CDATACommentTagslot) IRenderableIRequestITemplateLoadercCsdt|dS)aK Wraps 
 tags around some text and HTML-escape it.

    This is here since once twisted.web.html was deprecated it was hard to
    migrate the html.PRE from current code to twisted.web.template.

    For new code consider using twisted.web.template.

    @return: Escaped text wrapped in 
 tags.
    @rtype: C{str}
    z
z
r)textr(} provider

    @raise TypeError: If the type of C{URL} a L{str} instead of L{bytes}.

    @return: A L{bytes} containing HTML which tries to convince the client
        agent
        to visit the new location even if it doesn't respect the I{FOUND}
        response code.  This is intended to be returned from a render method,
        eg::

            def render_GET(self, request):
                return redirectTo(b"http://example.com/", request)
    zURL must be bytessContent-Typestext/html; charset=utf-8s

    
        
    
    
    click here
    

surlutf-8)
isinstancebytes	TypeError	setHeaderredirectrdecodeencode)r+r,contentr(r(r)
redirectTo;s


r7cs:eZdZdZdZdeffddZddZdd	ZZ	S)
Redirectz
    Resource that redirects to a specific URL.

    @ivar url: Redirect target URL to put in the I{Location} response header.
    @type url: L{bytes}
    Turlcst||_dSN)super__init__r9selfr9	__class__r(r)r<ns

zRedirect.__init__cCst|j|Sr:)r7r9)r>r,r(r(r)renderrszRedirect.rendercC|Sr:r(r>namer,r(r(r)getChilduzRedirect.getChild)
__name__
__module____qualname____doc__isLeafr0r<rArE
__classcell__r(r(r?r)r8dsr8c@s eZdZdZddZddZdS)ChildRedirectorFcCs>|ddkr|ds|dstd|t||dS)Nz://z../zvIt seems you've given me a redirect (%s) that is a child of myself! That's not good, it'll cause an infinite redirect.)find
startswith
ValueErrorr8r<r=r(r(r)r<}szChildRedirector.__init__cCs(|j}|ds|d7}||7}t|S)NrO)r9endswithrM)r>rDr,newUrlr(r(r)rEs

zChildRedirector.getChildN)rGrHrIrKr<rEr(r(r(r)rMzsrMc@s&eZdZdZdZdedefddZdS)ParentRedirectu
    Redirect to the nearest directory and strip any query string.

    This generates redirects like::

        /              →  /
        /foo           →  /
        /foo?bar       →  /
        /foo/          →  /foo/
        /foo/bar       →  /foo/
        /foo/bar?baz   →  /foo/

    However, the generated I{Location} header contains an absolute URL rather
    than a path.

    The response is the same regardless of HTTP method.
    r,r-cCs$ttj|d}t||S)zN
        Respond to all requests by redirecting to nearest directory.
        ascii)strrURLPathfromRequestherer5r7)r>r,r[r(r(r)rAs
zParentRedirect.renderN)rGrHrIrJrKr%r0rAr(r(r(r)rUsrUc@s<eZdZdZdZddZddZddZd	d
ZddZ	d
S)DeferredResourcezT
    I wrap up a Deferred that will eventually result in a Resource
    object.
    rVcCstj|||_dSr:)rResourcer<d)r>r^r(r(r)r<
zDeferredResource.__init__cCrBr:r(rCr(r(r)rErFzDeferredResource.getChildcCs*|j|j||j|ddlm}|S)Nr)NOT_DONE_YET)r^addCallback_cbChild
addErrback_ebChildtwisted.web.serverr`)r>r,r`r(r(r)rAszDeferredResource.rendercCs|t||dSr:)rArgetChildForRequest)r>childr,r(r(r)rbszDeferredResource._cbChildcCs||dSr:)processingFailed)r>reasonr,r(r(r)rdzDeferredResource._ebChildN)
rGrHrIrJrKr<rErArbrdr(r(r(r)r\sr\c@s0eZdZdZddZeddZeddZdS)	_SourceLineElementa
    L{_SourceLineElement} is an L{IRenderable} which can render a single line of
    source code.

    @ivar number: A C{int} giving the line number of the source code to be
        rendered.
    @ivar source: A C{str} giving the source code to be rendered.
    cCst||||_||_dSr:)rr<numbersource)r>loaderrlrmr(r(r)r<s
z_SourceLineElement.__init__cCs||jddS)zA
        Render the line of source as a child of C{tag}.
        z  u  )rmreplacer>r,tagr(r(r)
sourceLinesz_SourceLineElement.sourceLinecCs|t|jS)z>
        Render the line number as a child of C{tag}.
        )rXrlrpr(r(r)
lineNumberz_SourceLineElement.lineNumberN)rGrHrIrJr<rrrrsr(r(r(r)rks	
rkc@s,eZdZdZddZddZeddZdS)	_SourceFragmentElementa
    L{_SourceFragmentElement} is an L{IRenderable} which can render several lines
    of source code near the line number of a particular frame object.

    @ivar frame: A L{Failure}-style frame object
        for which to load a source line to render.  This is really a tuple
        holding some information from a frame object.  See
        L{Failure.frames} for specifics.
    cCt||||_dSr:rr<framer>rnrxr(r(r)r<r_z_SourceFragmentElement.__init__ccsH|jd}|jd}t|d|dD]
}|t||fVqdS)a$
        Find the source line references by C{self.frame} and yield, in source
        line order, it and the previous and following lines.

        @return: A generator which yields two-tuples.  Each tuple gives a source
            line number and the contents of that source line.
        rVN)rxrange	linecachegetlinerstrip)r>filenamerssnipLineNumberr(r(r)_getSourceLiness

z&_SourceFragmentElement._getSourceLinesccs\|D]&\}}|}||jdkrd}nd}t|did|i}t|||VqdS)z
        Render the source line indicated by C{self.frame} and several
        surrounding lines.  The active line will be given a I{class} of
        C{"snippetHighlightLine"}.  Other lines will be given a I{class} of
        C{"snippetLine"}.
        rzsnippetHighlightLinesnippetLineclassNr()rclonerx	TagLoaderrk)r>r,rqrsrrnewTagcssClassrnr(r(r)sourceLinessz"_SourceFragmentElement.sourceLinesN)rGrHrIrJr<rrrr(r(r(r)rus

ruc@sHeZdZdZddZeddZeddZedd	Zed
dZ	dS)

_FrameElementa
    L{_FrameElement} is an L{IRenderable} which can render details about one
    frame from a L{Failure}.

    @ivar frame: A L{Failure}-style frame object
        for which to load a source line to render.  This is really a tuple
        holding some information from a frame object.  See
        L{Failure.frames} for specifics.
    cCrvr:rwryr(r(r)r<%r_z_FrameElement.__init__cC||jdS)zY
        Render the name of the file this frame references as a child of C{tag}.
        rVrxrpr(r(r)r)rtz_FrameElement.filenamecCs|t|jdS)zc
        Render the source line number this frame references as a child of
        C{tag}.
        rz)rXrxrpr(r(r)rs0sz_FrameElement.lineNumbercCr)zV
        Render the function name this frame references as a child of C{tag}.
        rrrpr(r(r)function8rtz_FrameElement.functioncCstt||jS)zn
        Render the source code surrounding the line this frame references,
        replacing C{tag}.
        )rurrxrpr(r(r)rm?sz_FrameElement.sourceN)
rGrHrIrJr<rrrsrrmr(r(r(r)rs



rc@s$eZdZdZddZeddZdS)
_StackElementzW
    L{_StackElement} renders an L{IRenderable} which can render a list of frames.
    cCrvr:)rr<stackFrames)r>rnrr(r(r)r<Mr_z_StackElement.__init__csfdd|jDS)zW
        Render the list of frames in this L{_StackElement}, replacing C{tag}.
        csg|]}tt|qSr()rrr).0rxrqr(r)
Vsz(_StackElement.frames..)rrpr(rr)framesQs
z_StackElement.framesN)rGrHrIrJr<rrr(r(r(r)rHs
rc@seZdZdZddedfddZddeedeedeefd	d
Zdeedeeddfdd
ZdeedeefddZ	dS)
_NSContextzL
    A mapping from XML namespaces onto their prefixes in the document.
    NparentcCs,||_|durt|j|_dSddi|_dS)ze
        Pull out the parent's namespaces, if there's no parent then default to
        XML.
        Nz$http://www.w3.org/XML/1998/namespacexml)rrnss)r>rr(r(r)r<`sz_NSContext.__init__kr^r-cCs|j||S)z\
        Get a prefix for a namespace.

        @param d: The default prefix value.
        )rget)r>rr^r(r(r)rksz_NSContext.getvcCs|j||dS)zH
        Proxy through to setting the prefix for the namespace.
        N)r__setitem__)r>rrr(r(r)rssz_NSContext.__setitem__cCs|j|S)zH
        Proxy through to getting the prefix for the namespace.
        )r__getitem__)r>rr(r(r)rysz_NSContext.__getitem__r:)
rGrHrIrJrr<rXrrrr(r(r(r)r[s$rz4http://twistedmatrix.com/ns/twisted.web.template/0.1c	@sNeZdZdZdeefddZdeddfdd	Zd1d
dZ	d1dd
Z
dededdfddZdeededdfddZdeeddfddZ
deeefdeedeeeeefefddfddZdeddfddZd eeefdeeddfd!d"Zd ed#ed$eddfd%d&Zd'eddfd(d)Zd1d*d+Zd1d,d-Zd.eddfd/d0ZdS)2_ToStanzd
    A SAX parser which converts an XML document to the Twisted STAN
    Document Object Model.
    sourceFilenamecCs||_t|_d|_dS)zP
        @param sourceFilename: the filename the XML was loaded out of.
        FN)rr	prefixMapinCDATA)r>rr(r(r)r<s
z_ToStan.__init__locatorr-NcC
||_dS)zY
        Set the document locator, which knows about line and character numbers.
        N)r)r>rr(r(r)setDocumentLocators
z_ToStan.setDocumentLocatorcCsg|_|j|_g|_g|_dS)z*
        Initialise the document.
        N)documentcurrentstack
xmlnsAttrsr>r(r(r)
startDocuments
z_ToStan.startDocumentcCdS)z!
        Document ended.
        Nr(rr(r(r)endDocumentz_ToStan.endDocumenttargetdatacCr)z6
        Processing instructions are ignored.
        Nr()r>rrr(r(r)processingInstructionrz_ToStan.processingInstructionprefixuricCsVt|j|_||j|<|tkrdS|dur|jd|fdS|jd||fdS)z
        Set up the prefix mapping, which maps fully qualified namespace URIs
        onto namespace prefixes.

        This gets called before startElementNS whenever an C{xmlns} attribute
        is seen.
        Nxmlnszxmlns:%s)rrTEMPLATE_NAMESPACErappend)r>rrr(r(r)startPrefixMappings	
z_ToStan.startPrefixMappingcCs"|jj}|dusJd||_dS)zb
        "Pops the stack" on the prefix mapping.

        Gets called after endElementNS.
        Nz$More prefix mapping ends than starts)rr)r>rrr(r(r)endPrefixMappings
z_ToStan.endPrefixMappingnamespaceAndNameqnameattrscCsP|j}|j}|j}|\}}|tkrO|dkrd}n3|dkrOz|d}	Wnty1d}	Ynwt|d|	|||d}
|j|
|j	|
|
j
|_	dSd}t|}t|
D]\}}
|\}}|tkrhq[|dkrq|
}||=q[t}|
D]\\}}}
|j|}|dur|}n|d	|}|
||<qy|tkr|d
kr|jstdtdd
|vrtdtdtd||||d}||jdj|d
<|j||j
|_	dS|jr|t|jg|_|tkr|dur|j|}|dur|j|d	|}t|ttttttftf|||||d}|j||j	||j
|_	dS)a]
        Gets called when we encounter a new xmlns attribute.

        @param namespaceAndName: a (namespace, name) tuple, where name
            determines which type of action to take, if the namespace matches
            L{TEMPLATE_NAMESPACE}.
        @param qname: ignored.
        @param attrs: attributes on the element being started.
        transparentr#)NdefaultN)NrD)rrrscolumnNumberrA:attrz<{z}attr> as top-level elementrDz }attr> requires a name attribute)rArrsrrN)
attributesrArrsr)rr
getLineNumbergetColumnNumberrKeyErrorr#rrrchildrenrlistitemsrrAssertionErrorr"rrupdaterrrr0rX)r>rrrrrsrnsrDrslrArrattrNSjustTheNamenonTemplateAttrsattrNsattrNamensPrefixattrKeyelrr(r(r)startElementNSs

	




z_ToStan.startElementNSchcCs*|jr
|jd|dS|j|dS)zm
        Called when we receive some characters.  CDATA characters get passed
        through as is.
        rNN)rrrr)r>rr(r(r)
charactersEsz_ToStan.charactersrDcCs.|j|jr|jdj|_dS|j|_dS)z
        A namespace tag is closed.  Pop the stack, if there's anything left in
        it, otherwise return to the document's namespace.
        rNN)rpoprrr)r>rDrr(r(r)endElementNSOs
z_ToStan.endElementNSpublicIdsystemIdcCrz#
        DTDs are ignored.
        Nr()r>rDrrr(r(r)startDTDZrz_ToStan.startDTDargscGrrr()r>rr(r(r)endDTD_rz_ToStan.endDTDcCsd|_|jgdS)zO
        We're starting to be in a CDATA element, make a note of this.
        TN)rrrrr(r(r)
startCDATAdsz_ToStan.startCDATAcCs*d|_d|j}|jt|dS)z
        We're no longer in a CDATA element.  Collect up the characters we've
        parsed and put them in a new CDATA object.
        FrN)rjoinrrrrr )r>commentr(r(r)endCDATAksz_ToStan.endCDATAr6cCs|jt|dS)z=
        Add an XML comment which we've encountered.
        N)rrr!)r>r6r(r(r)rtsz_ToStan.comment)r-N)rGrHrIrJrrXr<rrrrrrrr
rrrrrobjectrrrrr(r(r(r)rs2




x"


	rflrcCst}|tjd|tjd|tjd|tjdtt|dd}|	||
||tj||
||jS)z
    Perform a SAX parse of an XML document with the _ToStan class.

    @param fl: The XML document to be parsed.

    @return: a C{list} of Stan objects.
    rrVrDN)r
setFeaturerfeature_validationfeature_namespacesfeature_external_gesfeature_external_pesrgetattrsetContentHandlersetEntityResolversetPropertyproperty_lexical_handlerparser)rparsersr(r(r)
_flatsaxParse{s


rc@s8eZdZdZdeeeffddZdedfddZ	d	S)
	XMLStringzH
    An L{ITemplateLoader} that loads and parses XML from a string.
    rcCs(t|ts
|d}tt||_dS)z
        Run the parser on a L{io.StringIO} copy of the string.

        @param s: The string from which to load the XML.
        @type s: L{str}, or a UTF-8 encoded L{bytes}.
        utf8N)r/rXr4rioStringIO_loadedTemplate)r>rr(r(r)r<s

zXMLString.__init__r-rcCs|jS)zM
        Return the document.

        @return: the loaded document.
        )rrr(r(r)loadszXMLString.loadN)
rGrHrIrJrrXr0r<r
rr(r(r(r)rs
rc@sFeZdZdZedZdddZeddZedd	Z	ed
dZ
dS)
FailureElementa
    L{FailureElement} is an L{IRenderable} which can render detailed information
    about a L{Failure}.

    @ivar failure: The L{Failure} instance which
        will be rendered.

    @since: 12.1
    ao


  

  

    : 
  

  

    

      

        : in
        
      

      

        

          
          
        

      

    

  

  

    : 
  



NcCst||||_dSr:)rr<failure)r>rrnr(r(r)r<r_zFailureElement.__init__cCs|t|jjS)zA
        Render the exception type as a child of C{tag}.
        )rrtyperpr(r(r)rszFailureElement.typecCs|t|jjdS)zB
        Render the exception value as a child of C{tag}.
        r)rXrvaluer5rpr(r(r)rszFailureElement.valuecCstt||jjS)z
        Render all the frames in the wrapped
        L{Failure}'s traceback stack, replacing
        C{tag}.
        )rrrrrpr(r(r)	tracebackszFailureElement.tracebackr:)rGrHrIrJrrnr<rrrrr(r(r(r)rs

M

rcCsNg}tdt||jt|dtr|ddddS|ddS)a
    Construct an HTML representation of the given failure.

    Consider using L{FailureElement} instead.

    @type myFailure: L{Failure}

    @rtype: L{bytes}
    @return: A string containing the HTML representation of the given failure.
    Nrr.rWxmlcharrefreplace)	rraddBothrr/r0r4r5raiseException)	myFailureresultr(r(r)
formatFailure#s
rrVc@s,eZdZdZd
ddZdedfddZd	S)rzJ
    An L{ITemplateLoader} that loads an existing flattenable object.
    rqrcCr)z>
        @param tag: The object which will be loaded.
        Nr)r>rqr(r(r)r<IszTagLoader.__init__r-cCs|jgSr:rrr(r(r)rQszTagLoader.loadN)rqr)rGrHrIrJr<r
rr(r(r(r)rCs
rc@sPeZdZdZdefddZdedfddZdefd	d
Z	dedfddZ
d
S)XMLFilezF
    An L{ITemplateLoader} that loads and parses XML from a file.
    pathcCs,t|ts
tjdtddd|_	||_dS)zf
        Run the parser on a file.

        @param path: The file from which to load the XML.
        zhPassing filenames or file objects to XMLFile is deprecated since Twisted 12.1.  Pass a FilePath instead.rz)category
stacklevelN)r/rwarningswarnDeprecationWarningr_path)r>rr(r(r)r<[s
zXMLFile.__init__r-rcCsNt|jtst|jS|jd}t|WdS1s wYdS)zP
        Read and parse the XML.

        @return: the loaded document.
        rN)r/r
rropen)r>fr(r(r)_loadDocos

$zXMLFile._loadDoccCsd|jdS)Nz)r
rr(r(r)__repr__{rjzXMLFile.__repr__cCs|jdur
||_|jS)zl
        Return the document, first loading it if necessary.

        @return: the loaded document.
        N)rrrr(r(r)r~s

zXMLFile.loadN)rGrHrIrJrr<r
rrXrrr(r(r(r)rUsr>xabipqrubrdddldtemh1h2h3h4h5h6hrliolrprttdthtrttulbdibdobigcoldeldfndirdivimginskbdmapnavpresubsupvarwbrabbrareabasebodycitecodefontformheadhtmllinkmarkmenumetarubysampspantimeasideaudioembedrxinputlabelmeterparamsmallstyletabletbodytfoottheadtitlevideoappletbuttoncanvascenterfigurefooterheaderhgroupiframekeygenlegendroptionoutputscriptselectrmstrikestrongacronymaddressarticlecaptioncommanddetailsisindexsectionsummarybasefontcolgroupdatalistfieldsetframesetnoframesnoscriptoptgroupprogresstextarea
blockquote
figcaptionc@s"eZdZdZdedefddZdS)_TagFactorya
    A factory for L{Tag} objects; the implementation of the L{tags} object.

    This allows for the syntactic convenience of C{from twisted.web.html import
    tags; tags.a(href="linked-page.html")}, where 'a' can be basically any HTML
    tag.

    The class is not exposed publicly because you only ever need one of these,
    and we already made it for you.

    @see: L{tags}
    tagNamer-cCs8|dkrtdS|d}|tvrtd|t|S)Nrr_zunknown tag )r"r~VALID_HTML_TAG_NAMESAttributeError)r>rr(r(r)__getattr__s
z_TagFactory.__getattr__N)rGrHrIrJrXr"rr(r(r(r)r	s
relementdoctype_failElementrcs|dur|ddurtt|j}dtdttdffdd}ddtd	tdtfd
d}|||	|t
S)a
    Render an element or other L{IRenderable}.

    @param request: The L{IRequest} being rendered to.
    @param element: An L{IRenderable} which will be rendered.
    @param doctype: A L{bytes} which will be written as the first line of
        the request, or L{None} to disable writing of a doctype.  The argument
        should not include a trailing newline and will default to the HTML5
        doctype C{''}.

    @returns: NOT_DONE_YET

    @since: 12.1
    N
rr-csTtjd|dtdd}|dur#|jr#dusJt|jSddS)Nz/An error occurred while rendering the response.)rsitesr
An error occurred while rendering the response.
)
_moduleLogrrdisplayTracebacksrwrite)rrrr,r(r)ebAszrenderElement..eb)r,rr,cSs||Sr:)finish)rr,r(r(r)rRszrenderElement..finish)rrrrrrrr%rcrr`)r,rrrr^rrr(rr)
renderElement$s

 

r)rN)XrJrr|rcollectionsrrGrtypingrrrrr	r
rrr
rrxml.saxrrxml.sax.xmlreaderrzope.interfacertwisted.internet.deferrtwisted.loggerrtwisted.pythonrtwisted.python.failurertwisted.python.filepathrtwisted.python.reflectrtwisted.webrtwisted.web._elementrrtwisted.web._flattenrrrtwisted.web._stanr r!r"r#twisted.web.iwebr$r%r&r*r0r7r]r8rMrUr\rkrurrrrContentHandlerEntityResolverrrXrrrrr`rrrrrtagsrrr(r(r(r)s|4
)..%"yt7|