OwlCyberSecurity - MANAGER
Edit File: _flatten.pyc
� `��ac @` s� d Z d d l m Z m Z d d l m Z d d l m Z d d l m Z d d l m Z y d d l m Z Wn e k r� d � Z n Xd d l m Z m Z m Z d d l m Z m Z d d l m Z m Z m Z m Z m Z m Z d d l m Z m Z m Z d d l! m" Z" d � Z# d � Z$ d � Z% d � Z& d � Z' d d � Z) d � Z* d � Z+ d � Z, d � Z- d � Z. d S( su Context-free flattener/serializer for rendering Python objects, possibly complex or arbitrarily nested, as strings. i ( t divisiont absolute_import( t BytesIO( t exc_info( t GeneratorType( t extract_tb( t iscoroutinec O` s t S( N( t False( t argst kwargs( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyR s ( t unicodet nativeStringt iteritems( t Deferredt ensureDeferred( t Tagt slott voidElementst Commentt CDATAt CharRef( t UnfilledSlott UnsupportedTypet FlattenerError( t IRenderablec C` sO t | t � r! | j d � } n | j d d � j d d � j d d � } | S( s� Escape some character or UTF-8 byte data for inclusion in an HTML or XML document, by replacing metacharacters (C{&<>}) with their entity equivalents (C{&<>}). This is used as an input to L{_flattenElement}'s C{dataEscaper} parameter. @type data: C{bytes} or C{unicode} @param data: The string to escape. @rtype: C{bytes} @return: The quoted form of C{data}. If C{data} is unicode, return a utf-8 encoded string. s utf-8t &s &t <s <t >s >( t isinstanceR t encodet replace( t data( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt escapeForContent s c C` s t | t � r | j d � S| S( s� Escape some character or UTF-8 byte data for inclusion in the top level of an attribute. L{attributeEscapingDoneOutside} actually passes the data through unchanged, because L{writeWithAttributeEscaping} handles the quoting of the text within attributes outside the generator returned by L{_flattenElement}; this is used as the C{dataEscaper} argument to that L{_flattenElement} call so that that generator does not redundantly escape its text output. @type data: C{bytes} or C{unicode} @param data: The string to escape. @return: The string, unchanged, except for encoding. @rtype: C{bytes} s utf-8( R R R ( R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt attributeEscapingDoneOutside8 s c ` s � f d � } | S( sU Decorate a C{write} callable so that all output written is properly quoted for inclusion within an XML attribute value. If a L{Tag <twisted.web.template.Tag>} C{x} is flattened within the context of the contents of another L{Tag <twisted.web.template.Tag>} C{y}, the metacharacters (C{<>&"}) delimiting C{x} should be passed through unchanged, but the textual content of C{x} should still be quoted, as usual. For example: C{<y><x>&</x></y>}. That is the default behavior of L{_flattenElement} when L{escapeForContent} is passed as the C{dataEscaper}. However, when a L{Tag <twisted.web.template.Tag>} C{x} is flattened within the context of an I{attribute} of another L{Tag <twisted.web.template.Tag>} C{y}, then the metacharacters delimiting C{x} should be quoted so that it can be parsed from the attribute's value. In the DOM itself, this is not a valid thing to do, but given that renderers and slots may be freely moved around in a L{twisted.web.template} template, it is a condition which may arise in a document and must be handled in a way which produces valid output. So, for example, you should be able to get C{<y attr="<x />" />}. This should also be true for other XML/HTML meta-constructs such as comments and CDATA, so if you were to serialize a L{comment <twisted.web.template.Comment>} in an attribute you should get C{<y attr="<-- comment -->" />}. Therefore in order to capture these meta-characters, flattening is done with C{write} callable that is wrapped with L{writeWithAttributeEscaping}. The final case, and hopefully the much more common one as compared to serializing L{Tag <twisted.web.template.Tag>} and arbitrary L{IRenderable} objects within an attribute, is to serialize a simple string, and those should be passed through for L{writeWithAttributeEscaping} to quote without applying a second, redundant level of quoting. @param write: A callable which will be invoked with the escaped L{bytes}. @return: A callable that writes data with escaping. c ` s � t | � j d d � � d S( Nt "s "( R R ( R ( t write( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt _writet s ( ( R# R$ ( ( R# sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt writeWithAttributeEscapingN s &c C` s1 t | t � r! | j d � } n | j d d � S( s� Escape CDATA for inclusion in a document. @type data: L{str} or L{unicode} @param data: The string to escape. @rtype: L{str} @return: The quoted form of C{data}. If C{data} is unicode, return a utf-8 encoded string. s utf-8s ]]>s ]]]]><![CDATA[>( R R R R ( R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt escapedCDATAz s c C` sf t | t � r! | j d � } n | j d d � j d d � } | rb | d d k rb | d 7} n | S( s� Escape a comment for inclusion in a document. @type data: L{str} or L{unicode} @param data: The string to escape. @rtype: C{str} @return: The quoted form of C{data}. If C{data} is unicode, return a utf-8 encoded string. s utf-8s --s - - R s >i����t -t ( R R R R ( R ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt escapedComment� s c C` s^ xW | d d d � D]& } | d k r | | k r | | Sq W| d k rN | St | � � d S( sK Find the value of the named slot in the given stack of slot data. Ni����( t NoneR ( t namet slotDatat defaultt slotFrame( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt _getSlotValue� s c #` s� | | | � � f d � � t | t t f � rC | | | � � n`t | t � rx t | j � | j � } � | � Vn+t | t � r� | d � | t | j � � | d � n�t | t � r� | d � | t | j � � | d � n�t | t � r�� j | j � | j d k rp| j } | j t � } d | _ | j | � } | � | � } � | � V� j � d S| j s�� | j � Vd S| d � t | j t � r�| j j d � } n | j } | | � xt t | j � D]c \ } } t | t � r | j d � } n | d | d � � | t d t | � �V| d � q�W| j sat | � t k r�| d � � | j t � V| d | d � q�| d � nt | t t t! f � r�x� | D] } � | � Vq�Wn� t | t" � r d | j# f } | | j d � � n� t | t$ � r3| j% � f d � � Vnp t& | � ret' | � } | j% � f d � � Vn> t( j) | � r�| j � � } � | d | �Vn t* | � � d S( s< Make C{root} slightly more flat by yielding all its immediate contents as strings, deferreds or generators that are recursive calls to itself. @param request: A request object which will be passed to L{IRenderable.render}. @param root: An object to be made flatter. This may be of type C{unicode}, L{str}, L{slot}, L{Tag <twisted.web.template.Tag>}, L{tuple}, L{list}, L{types.GeneratorType}, L{Deferred}, or an object that implements L{IRenderable}. @param write: A callable which will be invoked with each L{bytes} produced by flattening C{root}. @param slotData: A L{list} of L{dict} mapping L{str} slot names to data with which those slots will be replaced. @param renderFactory: If not L{None}, an object that provides L{IRenderable}. @param dataEscaper: A 1-argument callable which takes L{bytes} or L{unicode} and returns L{bytes}, quoted as appropriate for the rendering context. This is really only one of two values: L{attributeEscapingDoneOutside} or L{escapeForContent}, depending on whether the rendering context is within an attribute or not. See the explanation in L{writeWithAttributeEscaping}. @return: An iterator that eventually yields L{bytes} that should be written to the output. However it may also yield other iterators or L{Deferred}s; if it yields another iterator, the caller will iterate it; if it yields a L{Deferred}, the result of that L{Deferred} will either be L{bytes}, in which case it's written, or another generator, in which case it is iterated. See L{_flattenTree} for the trampoline that consumes said values. @rtype: An iterator which yields L{bytes}, L{Deferred}, and more iterators of the same type. c ` s t � | | � | | � S( N( t _flattenElement( t newRoott dataEscapert renderFactoryR# ( t requestR, ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt keepGoing� s s <![CDATA[s ]]>s <!--s -->NR t asciiR( s ="R# R" R s </s />s &#%d;c ` s | � | � f S( N( ( t result( R5 ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt <lambda> t c ` s | � | � f S( N( ( R7 ( R5 ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyR8 R9 R3 (+ R t bytesR R R/ R+ R- R R& R R R) R t appendR, t renderR* t cloneR t lookupRenderMethodt popt tagNamet childrenR R t attributesR! R% R R R t tuplet listR R t ordinalR t addCallbackR R R t providedByR ( R4 t rootR# R, R3 R2 t slotValuet rendererNamet rootClonet renderMethodR7 R@ t kt vt elementt escapedt d( ( R5 R4 R, sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyR0 � s~ ( c #` s' t | | | g d t � g � x� r"y! � d j } t � d � } Wn� t k re � j � q! t k r� } � j � g } x% � D] } | j | j j d � q� W| j | j d � t | | t t � d � � � q! Xt | t � r� f d � } | j | � Vq! � j | � q! Wd S( s\ Make C{root} into an iterable of L{bytes} and L{Deferred} by doing a depth first traversal of the tree. @param request: A request object which will be passed to L{IRenderable.render}. @param root: An object to be made flatter. This may be of type C{unicode}, L{bytes}, L{slot}, L{Tag <twisted.web.template.Tag>}, L{tuple}, L{list}, L{types.GeneratorType}, L{Deferred}, or something providing L{IRenderable}. @param write: A callable which will be invoked with each L{bytes} produced by flattening C{root}. @return: An iterator which yields objects of type L{bytes} and L{Deferred}. A L{Deferred} is only yielded when one is encountered in the process of flattening C{root}. The returned iterator must not be iterated again until the L{Deferred} is called back. i����RH i c ` s | \ } } � j | � | S( N( R; ( t originalAndToFlattent originalt toFlatten( t stack( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt cbxM s N( R0 R* R t gi_framet nextt StopIterationR? t ExceptionR; t f_localsR R R R R RF ( R4 RH R# t frameRO t et rootst generatorRV ( ( RU sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt _flattenTree( s$ #c ` s{ xt t rv y t � � } Wn. t k r9 � j d � n9 � j � n) X� � � f d � } | j | � j � Pq Wd S( s� Take strings from an iterator and pass them to a writer function. @param state: An iterator of L{str} and L{Deferred}. L{str} instances will be passed to C{write}. L{Deferred} instances will be waited on before resuming iteration of C{state}. @param write: A callable which will be invoked with each L{str} produced by iterating C{state}. @param result: A L{Deferred} which will be called back when C{state} has been completely flattened into C{write} or which will be errbacked if an exception in a generator passed to C{state} or an errback from a L{Deferred} from state occurs. @return: L{None} c ` s t � � � � | S( N( t _writeFlattenedData( RS ( R7 t stateR# ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt cbyp s N( t TrueRX RY t callbackR* t errbackt addCallbacks( Rb R# R7 RO Rc ( ( R7 Rb R# sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyRa V s c C` s/ t � } t | | | � } t | | | � | S( s� Incrementally write out a string representation of C{root} using C{write}. In order to create a string representation, C{root} will be decomposed into simpler objects which will themselves be decomposed and so on until strings or objects which can easily be converted to strings are encountered. @param request: A request object which will be passed to the C{render} method of any L{IRenderable} provider which is encountered. @param root: An object to be made flatter. This may be of type L{unicode}, L{bytes}, L{slot}, L{Tag <twisted.web.template.Tag>}, L{tuple}, L{list}, L{types.GeneratorType}, L{Deferred}, or something that provides L{IRenderable}. @param write: A callable which will be invoked with each L{bytes} produced by flattening C{root}. @return: A L{Deferred} which will be called back when C{root} has been completely flattened into C{write} or which will be errbacked if an unexpected exception occurs. ( R R` Ra ( R4 RH R# R7 Rb ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt flattenx s c ` s8 t � � t | | � j � } | j � f d � � | S( s� Collate a string representation of C{root} into a single string. This is basically gluing L{flatten} to an L{io.BytesIO} and returning the results. See L{flatten} for the exact meanings of C{request} and C{root}. @return: A L{Deferred} which will be called back with a single string as its result when C{root} has been completely flattened into C{write} or which will be errbacked if an unexpected exception occurs. c ` s � j � S( N( t getvalue( t _( t io( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyR8 � R9 ( R Rh R# RF ( R4 RH RQ ( ( Rk sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt flattenString� s N(/ t __doc__t __future__R R Rk R t sysR t typesR t tracebackR t inspectR t ImportErrort twisted.python.compatR R R t twisted.internet.deferR R t twisted.web._stanR R R R R R t twisted.web.errorR R R t twisted.web.iwebR R R! R% R& R) R* R/ R0 R` Ra Rh Rl ( ( ( sW /opt/cpanel-ccs/.develop/virtualenv/lib/python2.7/site-packages/twisted/web/_flatten.pyt <module> s2 . , { . "