o

�
b�s�@s�dZd
dl
mZ
d
dlmZmZmZ
d
dlmZ
dd�Z	ddi
Z
Gd	d
�d
�ZeZd&dd�
Z
d
d�Zdd�Zdd�Zdd�ZGdd�de�ZGdd�d�ZGdd�de�Zee�
Gdd�d��
ZGdd�de�Zdd �ZGd!d"�d"ej�ZGd#d$�d$�Zd%S)'z�
DOM-like XML processing support.

This module provides support for parsing XML into DOM-like object structures
and serializing such structures to an XML string representation, optimized
for use in streaming XML applications.
�)
�cast)�	Attribute�	Interface�implementer)
�suxc
Cs(|�d
d�}
t
|
�
dkr|
Sd|
dfS)zSInternal method for splitting a prefixed Element name into its
    respective parts�
:�
�Nr
)�split�len)�name�ntok�r�;/usr/lib/python3/dist-packages/twisted/words/xish/domish.py�_splitPrefixs

rz$http://www.w3.org/XML/1998/namespace�xmlc@s<eZ
dZd
Zddd�
Zdd�Zdd�Zd	d
�Zdd
d�
ZdS)�_ListSerializerz=Internal class which serializes an Element tree into a bufferNcCsFg|_i|_
|
r|j
�|
�

|j
�t�

t��g
|pg|_d
|_dS�Nr
)�	writelist�prefixes�update�
G_PREFIXES�values�prefixStack�
prefixCounter)�selfr�prefixesInScoperrr�__init__'s







z_ListSerializer.__init__c

Csd
�|j
�
S)N�)�joinr�
rrrr�getValue0s
z_ListSerializer.getValuecCs0|
|jv
rd
|j
|j|
<|j
d|_
|j|
S)Nzxn%dr)rr�r�urirrr�	getPrefix3s





z_ListSerializer.getPrefixcCs<|j}t
d
t|j�
dd
d
�D]}|
||vr
dSqdS)N���rTF�r�ranger�r�prefix�stack�
irrr�
prefixInScope9s



�z_ListSerializer.prefixInScoperrc
Cs�|jj
}t|
t�r||
�

dSt|
t�r|t|
�
�

dS|
j}|
j}|
j|}}|
j	�
�D]	\}}	||j|	<q-|j�
t
|
j	���
�

|durH|}|durN|}d}
||ksY||jvrc|�|�
}
|�|
�
}|
sl|d
|�

n!|d|
�d|���

|s�|d|
�d|�d��

|jd�
|
�

d}||kr�||ks�|
r�|s�|d	|�

|
j	�
�D]\}}	|d|�d|	�d��

q�|
j�
�D]J\}}
t|t�r�|\}}|�|�
}|�|�
s�|d|�d|�d��

|jd�
|�

|d
|�d|�dt|
d��d��

q�|d
|�dt|
d��d��

q�|dk�
r|d
�

dSt|
j�
dk�
r?|d
�

|
jD]
}|j||d�
�
q|
�
s3|d|�

n|d|
�d|�d
��

n|d�

|j��
dS)Nz<%s�
<rz xmlns:z='�
'r%Tz xmlns='%s'�
 rr
�
>)
�
defaultUriz</%s>z</z/>)r�append�
isinstance�
SerializedXML�str�escapeToXmlrr#r1�
localPrefixes�itemsrr�list�keysr$r,�
attributes�tupler�children�	serialize�pop)r�elem�closeElementr1�writerr#�currentDefaultUri�
p�
ur)�inScope�
k�
v�attr_uri�	attr_name�attr_prefix�
crrrr>@sl





























$







z_ListSerializer.serialize�NN)rr)	�__name__�
__module__�__qualname__�__doc__rr!r$r,r>rrrrr$s

	rcCsH|�d
d�}|�dd�}|�dd�}|
dkr"|�dd	�}|�d
d�}|S)a
Escape text to proper XML form, per section 2.3 in the XML specification.

    @type text: C{str}
    @param text: Text to escape

    @type isattrib: C{bool}
    @param isattrib: Triggers escaping of characters necessary for use as
                     attribute values
    �
&�&amp;r-�&lt;r0�&gt;rr.�&apos;�
"�&quot;�
�replace)�text�isattribrrrr6�s






r6c

Cs@|�d
d�}|�dd�}|�dd�}|�dd�}|�d	d
�}|S)NrTr-rUr0rVr.rXrWrSrRrY�
r[rrr�unescapeFromXml�s





r^ccs �|D]
}|
�|�
r
|V
qd
S)z Filters items in a list by classN)
�
providedBy)r9�int�
nrrr�generateOnlyInterface�s�


��rbccs4�|D]}t�
|�
r|j|
kr|j|kr|V
qd
S)z;Filters Element items in a list with matching name and URI.N)�IElementr_rr#)r9rr#rarrr�generateElementsQNamed�s�

��rdccs*�|D]}t�
|�
r|j|
kr|V
qd
S)zFFilters Element items in a list with matching name, regardless of URI.N)rcr_r)r9rrarrr�generateElementsNamed�s�

��rec
@�eZ
dZd
ZdS)r4z/Marker class for pre-serialized XML in the DOM.N�rNrOrPrQrrrrr4��
r4c@s(eZ
dZd
Zdd�Zdd�Zdd�ZdS)	�	Namespacez7Convenience object for tracking namespace declarations.cCs
|
|_dS�
N�
�_urir"rrrr��

zNamespace.__init__cC�
|j|
fSrjrk�rrarrr�__getattr__�rmzNamespace.__getattr__cCrnrjrkrorrr�__getitem__�rmzNamespace.__getitem__N)rNrOrPrQrrprqrrrrri�s

ric@sleZ
dZd
Zed�
Zed�
Zed�
Zed�
Zed�
Z	ed�
Z
ed�
Zddd
�
Zddd�
Z
dd�Zdd�Zd	S)rcz�
    Interface to XML element nodes.

    See L{Element} for a detailed example of its general use.

    Warning: this Interface is not yet complete!
    z Element's namespace URI z Element's local name z) Default namespace URI of child elements z" Dictionary of element attributes z List of child nodes z' Reference to element's parent element z Dictionary of local prefixes Nrrc
C�d
S)a�Serializes object to a (partial) XML document

        @param prefixes: dictionary that maps namespace URIs to suggested
                         prefix names.
        @type prefixes: L{dict}

        @param closeElement: flag that determines whether to include the
            closing tag of the element in the serialized string. A value of
            C{0} only generates the element's start tag. A value of C{1} yields
            a complete serialization.
        @type closeElement: L{int}

        @param defaultUri: Initial default namespace URI. This is most useful
            for partial rendering, where the logical parent element (of which
            the starttag was already serialized) declares a default namespace
            that should be inherited.
        @type defaultUri: L{str}

        @param prefixesInScope: list of prefixes that are assumed to be
            declared by ancestors.
        @type prefixesInScope: L{list}

        @return: (partial) serialized XML
        @rtype: L{str}
        Nr)rrAr1rrrr�toXml��zIElement.toXmlc
Crr)a<
        Create an element and add as child.

        The new element is added to this element as a child, and will have
        this element as its parent.

        @param name: element name. This can be either a L{str} object that
            contains the local name, or a tuple of (uri, local_name) for a
            fully qualified name. In the former case, the namespace URI is
            inherited from this element.
        @type name: L{str} or L{tuple} of (L{str}, L{str})

        @param defaultUri: default namespace URI for child elements. If
            L{None}, this is inherited from this element.
        @type defaultUri: L{str}

        @param content: text contained by the new element.
        @type content: L{str}

        @return: the created element
        @rtype: object providing L{IElement}
        Nr)rr1�contentrrr�
addElement
rtzIElement.addElementc


Crr)a�

        Adds a node as child of this element.

        The C{node} will be added to the list of childs of this element, and
        will have this element set as its parent when C{node} provides
        L{IElement}. If C{node} is a L{str} and the current last child is
        character data (L{str}), the text from C{node} is appended to the
        existing last child.

        @param node: the child node.
        @type node: L{str} or object implementing L{IElement}
        Nr)
�noderrr�addChild'
rtzIElement.addChildc


Crr)aC

        Adds character data to this element.

        If the current last child of this element is a string, the text will
        be appended to that string. Otherwise, the text will be added as a new
        child.

        @param text: The character data to be added to this element.
        @type text: L{str}
        Nrr]rrr�
addContent5
rtzIElement.addContent�NrrNrM)rNrOrPrQrr#rr1r;r=�parentr7rsrvrxryrrrrrc�s








rcc@s�eZ
dZd
ZdZd0dd�
Zdd�Zdd	�Zd
d�Zdd
�Z	dd�Z
dd�Ze
Zdd�Z
d1dd�
Zdd�Zdd�Zdd�Zdd�Zdedefd d!�Zd2d"d#�
Zd$d%�Zd&d'�Zd2d(d)�
Zd3d,d-�
Zd.d/�ZdS)4�ElementaPRepresents an XML element node.

    An Element contains a series of attributes (name/value pairs), content
    (character data), and other child Element objects. When building a document
    with markup (such as HTML or XML), use this object as the starting point.

    Element objects fully support XML Namespaces. The fully qualified name of
    the XML Element it represents is stored in the C{uri} and C{name}
    attributes, where C{uri} holds the namespace URI. There is also a default
    namespace, for child elements. This is stored in the C{defaultUri}
    attribute. Note that C{''} means the empty namespace.

    Serialization of Elements through C{toXml()} will use these attributes
    for generating proper serialized XML. When both C{uri} and C{defaultUri}
    are not None in the Element and all of its descendents, serialization
    proceeds as expected:

      >>> from twisted.words.xish import domish
      >>> root = domish.Element(('myns', 'root'))
      >>> root.addElement('child', content='test')
      <twisted.words.xish.domish.Element object at 0x83002ac>
      >>> root.toXml()
      u"<root xmlns='myns'><child>test</child></root>"

    For partial serialization, needed for streaming XML, a special value for
    namespace URIs can be used: L{None}.

    Using L{None} as the value for C{uri} means: this element is in whatever
    namespace inherited by the closest logical ancestor when the complete XML
    document has been serialized. The serialized start tag will have a
    non-prefixed name, and no xmlns declaration will be generated.

    Similarly, L{None} for C{defaultUri} means: the default namespace for my
    child elements is inherited from the logical ancestors of this element,
    when the complete XML document has been serialized.

    To illustrate, an example from a Jabber stream. Assume the start tag of the
    root element of the stream has already been serialized, along with several
    complete child elements, and sent off, looking like this::

      <stream:stream xmlns:stream='http://etherx.jabber.org/streams'
                     xmlns='jabber:client' to='example.com'>
        ...

    Now suppose we want to send a complete element represented by an
    object C{message} created like:

      >>> message = domish.Element((None, 'message'))
      >>> message['to'] = 'user@example.com'
      >>> message.addElement('body', content='Hi!')
      <twisted.words.xish.domish.Element object at 0x8276e8c>
      >>> message.toXml()
      u"<message to='user@example.com'><body>Hi!</body></message>"

    As, you can see, this XML snippet has no xmlns declaration. When sent
    off, it inherits the C{jabber:client} namespace from the root element.
    Note that this renders the same as using C{''} instead of L{None}:

      >>> presence = domish.Element(('', 'presence'))
      >>> presence.toXml()
      u"<presence/>"

    However, if this object has a parent defined, the difference becomes
    clear:

      >>> child = message.addElement(('http://example.com/', 'envelope'))
      >>> child.addChild(presence)
      <twisted.words.xish.domish.Element object at 0x8276fac>
      >>> message.toXml()
      u"<message to='user@example.com'><body>Hi!</body><envelope xmlns='http://example.com/'><presence xmlns=''/></envelope></message>"

    As, you can see, the <presence/> element is now in the empty namespace, not
    in the default namespace of the parent or the streams'.

    @type uri: L{str} or None
    @ivar uri: URI of this Element's name

    @type name: L{str}
    @ivar name: Name of this Element

    @type defaultUri: L{str} or None
    @ivar defaultUri: URI this Element exists within

    @type children: L{list}
    @ivar children: List of child Elements and content

    @type parent: L{Element}
    @ivar parent: Reference to the parent Element, if any.

    @type attributes: L{dict}
    @ivar attributes: Dictionary of attributes associated with this Element.

    @type localPrefixes: L{dict}
    @ivar localPrefixes: Dictionary of namespace declarations on this
                         element. The key is the prefix to bind the
                         namespace uri to.
    r
NcCsX|pi|_|
\|_
|_|d
ur|j
|j��v
r|j
|_n||_|p"i|_g|_d
|_d
S)a�

        @param qname: Tuple of (uri, name)
        @param defaultUri: The default URI of the element; defaults to the URI
                           specified in C{qname}
        @param attribs: Dictionary of attributes
        @param localPrefixes: Dictionary of namespace declarations on this
                              element. The key is the prefix to bind the
                              namespace uri to.
        N)r7r#rrr1r;r=r{)r�qnamer1�attribsr7rrrr�
s










zElement.__init__cCs>|jD]}t
�|�
r|j|
kr|
Sq|
�d
�
rt|
�
�
dS)N�
_)r=rcr_r�
startswith�AttributeError)r�keyrarrrrp�
s


�

zElement.__getattr__cCs|j|�
|
�
Srj�r;�_dqa�rr�rrrrq�
s
zElement.__getitem__cCs|j|�
|
�
=dSrjr�r�rrr�__delitem__�
s
zElement.__delitem__cCs||j|�
|
�
<dSrjr�)rr��valuerrr�__setitem__�
s
zElement.__setitem__c
Cs"|jD]}
t
|
t�r|

Sqd
S)z9
        Retrieve the first CData (content) node
        r)r=r3r5rorrr�__unicode__�
s




�zElement.__unicode__c

Cst|�
�
d
�
S)zH
        Retrieve the first character data node as UTF-8 bytes.
        zutf-8)r5�encoder rrr�	__bytes__�
szElement.__bytes__cCst|
t
�r
|
d
s
|
dS|
S)z$Dequalify an attribute key as neededr
r)r3r<)r�attrrrrr��
s
zElement._dqacCs|j�
|
|�S)
z.Retrieve the value of attribname, if it exists)r;�get)r�
attribname�defaultrrr�getAttribute�
szElement.getAttributecCs|�|
�
|j
vS)
z+Determine if the specified attribute exists)r�r;)r�attribrrr�hasAttribute�
szElement.hasAttributecCs|j�
|�|
�
d
�|kS)zbSafely compare the value of an attribute against a provided value.

        L{None}-safe.
        N)r;r�r�)rr�r�rrr�compareAttribute�
szElement.compareAttributecCs&|j}||
}||||
<|||<d
S)z!Swap the values of two attribute.N)
r;)r�left�right�
d�
lrrr�swapAttributeValues�
s


zElement.swapAttributeValuescCs t�
|
�
r||
_|j�|
�

|
S)
zAdd a child to this Element.)rcr_r{r=r2)rrwrrrrxs



zElement.addChildr[�returncCspt|
t
�std
|
�dt|
�
j�d��
�
|j}t|�
dkr,t|dt
�r,|d|
|d<n|�|
�

tt
|d�S)z#Add some text data to this Element.zExpected str not z (�
)r
r%)	r3r5�	TypeError�typerNr=rr2r)rr[rLrrrrys






zElement.addContentcCs^t|
t
�r|dur
|
d
}t|
|�}n|dur|j}t||
f|�}|�|�

|r-|�|�

|Sr)r3r<r|r1rxry)rrr1ru�childrrrrvs









zElement.addElementcCs|j�
t|
�
�

d
S)z=Add a pre-serialized chunk o' XML as a child of this Element.N)r=r2r4)r�rawxmlstringrrr�	addRawXml#szElement.addRawXmlc

Cs d
tj
|jd<tj
dt_
dS)z[Add a unique (across a given Python session) id attribute to this
        Element.
        zH_%d�idrN)r|�
_idCounterr;r rrr�addUniqueId's
zElement.addUniqueIdcCs"|d
ur
t|j
t�St|j
||
�S)a�

        Iterate across all children of this Element that are Elements.

        Returns a generator over the child elements. If both the C{uri} and
        C{name} parameters are set, the returned generator will only yield
        on elements matching the qualified name.

        @param uri: Optional element URI.
        @type uri: L{str}
        @param name: Optional element name.
        @type name: L{str}
        @return: Iterator that yields objects implementing L{IElement}.
        N)rbr=rcrd)rr#rrrr�elements.s
zElement.elementsrrcCs$t|
|d
�}|j
|||d�
|��S)z4Serialize this Element and all children to a string.)rr)rAr1)�SerializerClassr>r!)rrrAr1r�
srrrrsAs

z
Element.toXmlc
Cs"|jD]}
t
�|
�
r|

SqdSrj)r=rcr_)rrLrrr�firstChildElementGs





�zElement.firstChildElement)NNNrjrMrz)rNrOrPrQr�rrprqr�r�r�r��__str__r�r�r�r�r�rxr5ryrvr�r�r�rsr�rrrrr|B
s0b

	



r|c
@rf)�ParserErrorz,Exception thrown when a parsing error occursNrgrrrrr�Nrhr�c
Cs:zt�}|WSt
y


td
urtd�
�
t�}|YSw)z�Preferred method to construct an ElementStream

    Uses Expat-based stream if available, and falls back to Sux if necessary.
    NzNo parsers available :()�ExpatElementStream�ImportError�SuxElementStream�	Exception)
�esrrr�
elementStreamTs






�r�c@sdeZ
dZd
d�Zdd�Zdd�Zdd�Zd	d
�Zdd�Zd
d�Z	dddddd�Z
dd�Zdd�ZdS)r�c

Cs<|��
d|_
d|_d|_d|_d|_d
|_g|_g|_dS)NF)	�connectionMade�DocumentStartEvent�ElementEvent�DocumentEndEvent�currElem�rootElem�documentStarted�defaultNsStackrr rrrrds









zSuxElementStream.__init__c
Cs8z|�|
�

WdSt
jy
}
ztt|�
�
�
d}~w
wrj)�dataReceivedr�
ParseErrorr�r5�r�buffer�
errr�parseos



��zSuxElementStream.parsecCsF|j}t
d
t|j�
dd
d
�D]}|
||vr |||

SqdS)Nr%rr&r(rrr�findUrius


�zSuxElementStream.findUricCsX
d}i}i}d}t|�
��
D]\}}|�d
�
r+t|�
\}	}
|	dur$|}n|||
<||=q|j�|�

|durEt|j�
dkrC|jd}nd}t|
�
\}}
|durR|}n|�|�
}|�
�D]\}}t|�
\}
}|
durn|||<q[t	|�
||�|
�
|f<q[t
||
f|||�}
|j�|�

|jr�|jdur�|
|_dS|j�
|
�
|_dS|
|_d|_|�|
�

dS)N�xmlnsr
r%rT)r9r8r�rrr2rr�r�r^r|r�r�rxr�r�)rrr;r1r7r~r#rGrH�
xrDr)rar�rrr�gotTagStart~sF









�













zSuxElementStream.gotTagStartcC�2|jdu
rt
|
t�r|
�d
�
}
|j�|
�

dSdS�N�ascii�r�r3�bytes�decodery�r�datarrr�gotText��







�zSuxElementStream.gotTextcCr�r�r�r�rrr�gotCData�r�zSuxElementStream.gotCDatac
CsdSrjrr�rrr�
gotComment�szSuxElementStream.gotCommentrRr-r0r.rW)�amp�lt�gt�apos�quotcCs<|
tj
vrtj
|
}t|t�r|�d
�
}|j�|�

dSdSr�)r��entitiesr3r�r�r�ry)r�	entityRefr�rrr�gotEntityReference�s







�z#SuxElementStream.gotEntityReferencecCs�|jdur	t
d
�
�
t|
�
\}}
|dur|jd}n|�|�
}|jdur<|jj|
ks/|jj|kr3t
d�
�
|��
d|_dS|jj|
ksH|jj|krLt
d�
�
|j	�
�
|j�
�
|jjdurl|j|j_|�|j�

d|_dS|jj|_dS)Nz%Element closed after end of document.r%zMismatched root elementszMalformed element close)
r�r�rr�r�r�rr#r�rr?r{r�)rrr)r#rrr�	gotTagEnd�s(
















zSuxElementStream.gotTagEndN)
rNrOrPrr�r�r�r�r�r�r�r�r�rrrrr�cs 
	?



�	r�c@sDeZ
dZd
d�Zdd�Zdd�Zdd�Zd	d
�Zdd�Zd
d�Z	dS)r�c
Cs�d
dl}
d|_
d|_d|_|
j|_|
�dd�|_|j|j_|j	|j_
|j|j_|j
|j_|j|j_d|_dg
|_d
|_i|_dS)Nr
zUTF-8r/r)�pyexpatr�r�r��error�ParserCreate�parser�_onStartElement�StartElementHandler�
_onEndElement�EndElementHandler�_onCdata�CharacterDataHandler�_onStartNamespace�StartNamespaceDeclHandler�_onEndNamespace�EndNamespaceDeclHandlerr�r�r�r7)rr�rrrrs



















zExpatElementStream.__init__c
Cs:z	|j�
|
�

WdS|jy
}
ztt|�
�
�
d}~w
wrj)r��Parser�r�r5r�rrrr�s



��zExpatElementStream.parsec
Cs�|
�d
d�}t
|�
dkrd|
f}i}g}|��D]\}}d
|vr5|�d
d�}|||d|df<|�|�

q|�|�

|D]}||=q=t||jd||j�}	i|_|jdkrk|j	dkrf|j	j
�|	�

|j	|	_|	|_	dSd|_|�|	�

dS)Nr/rrr
r%)
�rsplitrr8r2rr|r�r7r�r�r=r{r�)
rr�attrsr}�newAttrs�toDeleterGrH�aqnamer�rrrr�$s.








�










z"ExpatElementStream._onStartElementcCsF|jdur|�
�
dS|jjdur|�|j�

d|_dS|jj|_dSrj)r�r�r{r�)rrrrrr�Js




z ExpatElementStream._onEndElementcCs|jdkr
|j�
|
�

dSdSrj)r�ryr�rrrr�Zs


�zExpatElementStream._onCdatacCs&|
dur|j�
|�

dS||j|
<dSrj)r�r2r7)rr)r#rrrr�^s
z$ExpatElementStream._onStartNamespacecCs|
dur|j�
�
dSdSrj)r�r?)rr)rrrr�fs
�z"ExpatElementStream._onEndNamespaceN)
rNrOrPrr�r�r�r�r�r�rrrrr�s
&r�N)
r
)rQ�typingr�zope.interfacerrr�twisted.webrrrrr�r6r^rbrdrer5r4rircr|r�r�r��	XMLParserr�r�rrrr�<module>
s2
x
	
_

)