e f* @ s d Z d d l Z d d l Z d d l m Z d d l m Z d d l m Z d d l m
Z d d l m Z d d l m
Z
e d Z e e d
BZ e d Z e e BZ e e d Z e e d
Z e e d Be d Z e e BZ e e d BZ e e BZ e e d Z d d Z Gd d d Z Gd d d e Z Gd d d e Z Gd d d e Z Gd d d e Z Gd d d e Z! Gd d d e Z" Gd! d" d" e Z# Gd# d$ d$ e Z$ Gd% d& d& e Z% Gd' d( d( e Z& Gd) d* d* e& Z' Gd+ d, d, e Z( Gd- d. d. e Z) Gd/ d0 d0 e Z* Gd1 d2 d2 e Z+ Gd3 d4 d4 e Z, Gd5 d6 d6 e Z- Gd7 d8 d8 e Z. Gd9 d: d: e Z/ Gd; d< d< e Z0 Gd= d> d> e Z1 Gd? d@ d@ e Z2 GdA dB dB e Z3 GdC dD dD e Z4 GdE dF dF e Z5 GdG dH dH e Z6 GdI dJ dJ e Z7 GdK dL dL e Z8 GdM dN dN e Z9 GdO dP dP e Z: GdQ dR dR e Z; GdS dT dT e Z< GdU dV dV e< Z= GdW dX dX e Z> GdY dZ dZ e Z? Gd[ d\ d\ e Z@ Gd] d^ d^ e ZA Gd_ d` d` e ZB Gda db db eB ZC Gdc dd dd eB ZD Gde df df e ZE Gdg dh dh e ZF Gdi dj dj e ZG Gdk dl dl eH ZI Gdm dn dn eI ZJ Gdo dp dp eI ZK Gdq dr dr eJ ZL eK d ds ZM eK dt du ZN eK dv dw ZO e jP dx jQ dy jR e jS ZT e jP dz jQ dy jR e jU d{ d| jU d} d~ jV ZW e jP d jX ZY e jP dz jQ dy jR e jU d{ d| jU d} d~ jV ZZ e jP dz jQ dy jR e jU d{ d| jU d} d~ jV Z[ e jP dz jQ dy jR e jU d{ d| jU d} d~ jV Z\ d d Z] d d Z^ d d Z_ d d Z` d d Za d d Zb d d Zc d d Zd d d Ze d d Zf d d Zg d d Zh d d Zi d d Zj d d Zk d d Zl d d Zm d d Zn d d Zo d d Zp d d Zq d d Zr d d Zs d d Zt d d Zu d d Zv d d Zw d d Zx d d Zy d d Zz d d Z{ d d Z| d d Z} d d Z~ d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d S)al Header value parser implementing various email-related RFC parsing rules.
The parsing methods defined in this module implement various email related
parsing rules. Principal among them is RFC 5322, which is the followon
to RFC 2822 and primarily a clarification of the former. It also implements
RFC 2047 encoded word decoding.
RFC 5322 goes to considerable trouble to maintain backward compatibility with
RFC 822 in the parse phase, while cleaning up the structure on the generation
phase. This parser supports correct RFC 5322 generation by tagging white space
as folding white space only when folding is allowed in the non-obsolete rule
sets. Actually, the parser is even more generous when accepting input than RFC
5322 mandates, following the spirit of Postel's Law, which RFC 5322 encourages.
Where possible deviations from the standard are annotated on the 'defects'
attribute of tokens that deviate.
The general structure of the parser follows RFC 5322, and uses its terminology
where there is a direct correspondence. Where the implementation requires a
somewhat different structure than that used by the formal grammar, new terms
that mimic the closest existing terms are used. Thus, it really helps to have
a copy of RFC 5322 handy when studying this code.
Input to the parser is a string that has already been unfolded according to
RFC 5322 rules. According to the RFC this unfolding is the very first step, and
this parser leaves the unfolding step to a higher level message parser, which
will have already detected the line breaks that need unfolding while
determining the beginning and end of each header.
The output of the parser is a TokenList object, which is a list subclass. A
TokenList is a recursive data structure. The terminal nodes of the structure
are Terminal objects, which are subclasses of str. These do not correspond
directly to terminal objects in the formal grammar, but are instead more
practical higher level combinations of true terminals.
All TokenList and Terminal objects have a 'value' attribute, which produces the
semantically meaningful value of that part of the parse subtree. The value of
all whitespace tokens (no matter how many sub-tokens they may contain) is a
single space, as per the RFC rules. This includes 'CFWS', which is herein
included in the general class of whitespace tokens. There is one exception to
the rule that whitespace tokens are collapsed into single spaces in values: in
the value of a 'bare-quoted-string' (a quoted-string with no leading or
trailing whitespace), any whitespace that appeared between the quotation marks
is preserved in the returned value. Note that in all Terminal strings quoted
pairs are turned into their unquoted values.
All TokenList and Terminal objects also have a string value, which attempts to
be a "canonical" representation of the RFC-compliant form of the substring that
produced the parsed subtree, including minimal use of quoted pair quoting.
Whitespace runs are not collapsed.
Comment tokens also have a 'content' attribute providing the string found
between the parens (including any nested comments) with whitespace preserved.
All TokenList and Terminal objects have a 'defects' attribute which is a
possibly empty list all of the defects found while creating the token. Defects
may appear on any token in the tree, and a composite list of all defects in the
subtree is available through the 'all_defects' attribute of any node. (For
Terminal notes x.defects == x.all_defects.)
Each object in a parse tree is called a 'token', and each has a 'token_type'
attribute that gives the name from the RFC 5322 grammar that it represents.
Not all RFC 5322 nodes are produced, and there is one non-RFC 5322 node that
may be produced: 'ptext'. A 'ptext' is a string of printable ascii characters.
It is returned in place of lists of (ctext/quoted-pair) and
(qtext/quoted-pair).
XXX: provide complete list of token types.
N) hexdigits) OrderedDict)
itemgetter)_encoded_words)errors)utilsz (z
()<>@,:;.\"[].z."(z/?=z*'%%c C s* d t | j d d j d d d S)N"\z\\z\")strreplace)value r ?/opt/alt/python34/lib64/python3.4/email/_header_value_parser.py quote_string` s r c @ s[ e Z d Z d d Z d d Z d d Z d d Z d d
Z d d d
Z d S)_Foldedc C sC | | _ | | _ d | _ d | _ d | _ g | _ g | _ d S)Nr T)maxlenpolicylastlen stickyspace firstlinedonecurrent)selfr r r r r __init__i s z_Folded.__init__c C sC | j j | j | j j | j j | j j d | _ d S)Nr )r extendr appendr linesepclearr )r r r r newliner s
z_Folded.newlinec C s | j r | j n d S)N)r r! )r r r r finalizex s z_Folded.finalizec C s d j | j S)N )joinr )r r r r __str__| s z_Folded.__str__c C s | j j | d S)N)r r )r stokenr r r r s z_Folded.appendNc C s | d k r t | } n t | } | j d k r7t | j } | j | | | j k r | j j | j | j | 7_ | j j | | j | 7_ d | _ d | _ d S| j r| j } | d k r | j t | 7_ | t | 7} n | j
| d S| r| d | j k r| j | } d | k oM| k n r| | } | j j | j d | | j | d | _ | } n | j | j j | j | j j | | | | _ d | _ d | _ d S| j s| j n | j j | j | j j | d | _ d | _ d S| j | | j k rp| j j | | j | 7_ d S| | j k r| j | j j | | | _ d Sd S)NFT r ) r
lenr r r r r r has_fwspop_leading_fws_foldr! )r tokenr& lZstickyspace_lenwsZmarginZtrimr r r append_if_fits sf
z_Folded.append_if_fits) __name__
__module__ __qualname__r r! r" r% r r/ r r r r r g s r c s- e Z d Z d Z f d d Z d d Z f d d Z e d d Z e d
d Z e d d
Z
d d Z d d Z d d Z
e d d Z d d Z e d d Z d d Z d d Z d d Z d d! Z d" d# d$ Z d" d% d& Z d" d' d( Z S)) TokenListNc s t j | | g | _ d S)N)superr defects)r argskw) __class__r r r s zTokenList.__init__c C s d j d d | D S)Nr# c s s | ] } t | Vq d S)N)r
).0xr r r s z$TokenList.__str__..)r$ )r r r r r% s zTokenList.__str__c s d j | j j t j S)Nz{}({}))formatr8 r0 r4 __repr__)r )r8 r r r= s zTokenList.__repr__c C s d j d d | D S)Nr# c s s! | ] } | j r | j Vq d S)N)r )r9 r: r r r r; s z"TokenList.value..)r$ )r r r r r s zTokenList.valuec C s t d d | D | j S)Nc s s | ] } | j Vq d S)N) all_defects)r9 r: r r r r; s z(TokenList.all_defects..)sumr5 )r r r r r> s zTokenList.all_defectsc c s | j } g } x | D] } | j re | re t | d k rJ | d n | | V| j qe n | j } | j | | r | | V| g } q q W| r t | d k r | d n | | Vn d S)Nr' r )r8 startswith_fwsr( r pop_trailing_wsr )r klassthisr, Zend_wsr r r parts s
'
zTokenList.partsc C s | d j S)Nr )r@ )r r r r r@
s zTokenList.startswith_fwsc C s. | d j d k r | j d S| d j S)Nr fws)
token_typepopr* )r r r r r*
s
zTokenList.pop_leading_fwsc C s. | d j d k r | j d S| d j S)Nr' cfwsrI rI )rF rG rA )r r r r rA s
zTokenList.pop_trailing_wsc C s" x | D] } | j r d Sq Wd S)NTF)r) )r partr r r r) s
zTokenList.has_fwsc C s | d j S)Nr )has_leading_comment)r r r r rK s z TokenList.has_leading_commentc C s+ g } x | D] } | j | j q
W| S)N)r comments)r rL r, r r r rL ! s
zTokenList.commentsc C sE | j p t d } t | | } | j | | j t | S)Nz+inf)Zmax_line_lengthfloatr r+ r" r
)r r r foldedr r r fold( s
zTokenList.foldc C s g } | j } | r( | j | n | d j d k rJ | j d n d } | j t j t | | | j | d j | S)Nr' rE r# rI rI )r* r rF rG _ewencoder
r$ )r charsetresr. Ztrailerr r r as_encoded_word0 s (
zTokenList.as_encoded_wordc C s= g } x' | D] } | j | j | | q
Wd j | S)Nr# )r
cte_encoder$ )r rR r rS rJ r r r rU < s
zTokenList.cte_encodec C s; x4| j D])} t | } t | } y t | j d Wn^ t k
r t d d | j D rt d } n d } | j | | j } t | } Yn X| j | | r q
n | j
} | d k r t | j d | _ | j | r q
q n | j
r | j | q
n | j | | j q
Wd S)Nzus-asciic s s! | ] } t | t j Vq d S)N)
isinstancer UndecodableBytesDefect)r9 r: r r r r; I s z"TokenList._fold..z unknown-8bitzutf-8r )rD r
r( rQ UnicodeEncodeErroranyr> rU r r/ r* rG r r) r+ r r! )r rN rJ tstrtlenrR r. r r r r+ B s0
zTokenList._foldr# c C s# t d j | j d d d S)N
indentr# )printr$ _pp)r r] r r r pprintd s zTokenList.pprintc C s d j | j d d S)Nr\ r] r# )r$ r_ )r r] r r r ppstrg s zTokenList.ppstrc c s d j | | j j | j VxH | D]@ } t | d sN | d j | Vq$ | j | d Dd Hq$ W| j r d j | j } n d } d j | | Vd S)Nz{}{}/{}(r_ z* !! invalid element in token list: {!r}z z Defects: {}r# z{}){})r< r8 r0 rF hasattrr_ r5 )r r] r, Zextrar r r r_ j s
z
TokenList._pp)r0 r1 r2 rF r r% r= propertyr r> rD r@ r* rA r) rK rL rO rT rU r+ r` ra r_ r r )r8 r r3 s( + "r3 c @ s4 e Z d Z e d d Z e d d Z d S)WhiteSpaceTokenListc C s d S)N r )r r r r r ~ s zWhiteSpaceTokenList.valuec C s d d | D S)Nc S s( g | ] } | j d k r | j q S)comment)rF content)r9 r: r r r
s z0WhiteSpaceTokenList.comments..r )r r r r rL s z WhiteSpaceTokenList.commentsN)r0 r1 r2 rc r rL r r r r rd | s rd c @ s. e Z d Z d Z d d Z d d Z d S)UnstructuredTokenList unstructuredc C s) d } x | j D]} t | } d } y t | j d Wnt k
rUt d d | j D rt d } n d } | d k r<t d j | j | d | g j | } t
d d | j d | D } t | } t | }
| |
| j k r<| j | d =| j
| | |
| _ w q<n | j | } d } Yn X| j | | r| r t | j d
} q q n | s| r| j | q n | j } | d k rt | | _ | j | rq qn | j r| j | q n | j
| | j d } q Wd S) NFzus-asciic s s! | ] } t | t j Vq d S)N)rV r rW )r9 r: r r r r; s z.UnstructuredTokenList._fold..z unknown-8bitzutf-8r# c s s | ] } t | Vq d S)N)r( )r9 r: r r r r; s Tr' )rD r
rQ rX rY r> get_unstructuredr$ r rT r? r( r r r r/ Z _fold_as_ewr* r r) rO r! ) r rN last_ewrJ rZ is_ewrR chunkZ
oldlastlenschunklchunkr. r r r r+ sT
/&
zUnstructuredTokenList._foldc C s g } d } x | D] } t | } y | j d | j | Wq t k
r | d k r | j | j | | t | } n9 t d j | | d | g } | j | j Yq Xq Wd j | S)Nzus-asciir# ) r
rQ r rX rU r( rk r$ rT )r rR r rS rl rJ sparttlr r r rU s
& z UnstructuredTokenList.cte_encodeN)r0 r1 r2 rF r+ rU r r r r ri s 4ri c @ s. e Z d Z d Z d d Z d d Z d S)Phrasephrasec C sX d } xK| j D]@} t | } t | } d } y t | j d Wnt k
rt d d | j D r d } n d } | d k r| j r| d j d k r | j r | j
d } n d } xF t | D]8 \ } }
|
j d
k r t |
d d | | .z unknown-8bitzutf-8r' rH r# zbare-quoted-stringc s s | ] } t | Vq d S)N)r( )r9 r: r r r r; s Tz
quoted-stringrI rI )rD r
r( rQ rX rY r> rK rF rL rG enumerateri rk r$ r rT r r r? r r/ r+ )r rN rl rJ rZ r[ Zhas_ewrR remainderir, rn ro rp r r r r+ sL
!/
z Phrase._foldc C s g } d } d } x| D]} t | } y | j d | j | Wn&t k
rqd } | d k r | j s t | } n | j | j | | n | j sm| d j d k r | j r | j d
} n d } xF t
| D]8 \ } }
|
j d k r t |
d d | | rs c @ s e Z d Z d Z d S)WordZwordN)r0 r1 r2 rF r r r r rx 0 s rx c @ s" e Z d Z d Z d d Z d S)CFWSListrH c C s
t | j S)N)boolrL )r r r r rK 9 s z CFWSList.has_leading_commentN)r0 r1 r2 rF rK r r r r ry 5 s ry c @ s e Z d Z d Z d S)AtomatomN)r0 r1 r2 rF r r r r r{ = s r{ c @ s e Z d Z d Z d S)Tokenr, N)r0 r1 r2 rF r r r r r} B s r} c @ s: e Z d Z d Z d Z d Z d Z e d d Z d S) EncodedWordz encoded-wordNc C s3 | j d k r | j St j t | | j d S)N)cterP rQ r
rR )r r r r encodedN s zEncodedWord.encoded) r0 r1 r2 rF r rR langrc r r r r r r~ G s
r~ c @ sL e Z d Z d Z e d d Z e d d Z e d d Z d S) QuotedStringz
quoted-stringc C s+ x$ | D] } | j d k r | j Sq Wd S)Nzbare-quoted-string)rF r )r r: r r r rg Z s
zQuotedString.contentc C sY g } xC | D]; } | j d k r8 | j t | q
| j | j q
Wd j | S)Nzbare-quoted-stringr# )rF r r
r r$ )r rS r: r r r quoted_value` s
zQuotedString.quoted_valuec C s+ x$ | D] } | j d k r | j Sq Wd S)Nzbare-quoted-string)rF r )r r, r r r stripped_valuej s
zQuotedString.stripped_valueN)r0 r1 r2 rF rc rg r r r r r r r V s
r c @ s4 e Z d Z d Z d d Z e d d Z d S)BareQuotedStringzbare-quoted-stringc C s t d j d d | D S)Nr# c s s | ] } t | Vq d S)N)r
)r9 r: r r r r; v s z+BareQuotedString.__str__..)r r$ )r r r r r% u s zBareQuotedString.__str__c C s d j d d | D S)Nr# c s s | ] } t | Vq d S)N)r
)r9 r: r r r r; z s z)BareQuotedString.value..)r$ )r r r r r x s zBareQuotedString.valueN)r0 r1 r2 rF r% rc r r r r r r q s r c @ sR e Z d Z d Z d d Z d d Z e d d Z e d d Z d
S) Commentrf c s8 d j t d g f d d D d g g g S)Nr# r c s g | ] } j | q Sr )quote)r9 r: )r r r rh s z#Comment.__str__..))r$ r? )r r )r r r% s
zComment.__str__c C sG | j d k r t | St | j d d j d d j d d S)Nrf r z\\r z\(r z\))rF r
r )r r r r r r s
z
Comment.quotec C s d j d d | D S)Nr# c s s | ] } t | Vq d S)N)r
)r9 r: r r r r; s z"Comment.content..)r$ )r r r r rg s zComment.contentc C s
| j g S)N)rg )r r r r rL s zComment.commentsN) r0 r1 r2 rF r% r rc rg rL r r r r r } s
r c @ sL e Z d Z d Z e d d Z e d d Z e d d Z d S) AddressListz address-listc C s d d | D S)Nc S s% g | ] } | j d k r | q S)address)rF )r9 r: r r r rh s z)AddressList.addresses..r )r r r r addresses s zAddressList.addressesc C s t d d | D g S)Nc s s' | ] } | j d k r | j Vq d S)r N)rF mailboxes)r9 r: r r r r; s z(AddressList.mailboxes..)r? )r r r r r s zAddressList.mailboxesc C s t d d | D g S)Nc s s' | ] } | j d k r | j Vq d S)r N)rF
all_mailboxes)r9 r: r r r r; s z,AddressList.all_mailboxes..)r? )r r r r r s zAddressList.all_mailboxesN)r0 r1 r2 rF rc r r r r r r r r s r c @ sL e Z d Z d Z e d d Z e d d Z e d d Z d S) Addressr c C s" | d j d k r | d j Sd S)Nr group)rF display_name)r r r r r s zAddress.display_namec C s@ | d j d k r | d g S| d j d k r5 g S| d j S)Nr mailboxzinvalid-mailbox)rF r )r r r r r s
zAddress.mailboxesc C sG | d j d k r | d g S| d j d k r< | d g S| d j S)Nr r zinvalid-mailbox)rF r )r r r r r s
zAddress.all_mailboxesN)r0 r1 r2 rF rc r r r r r r r r s r c @ s: e Z d Z d Z e d d Z e d d Z d S) MailboxListz mailbox-listc C s d d | D S)Nc S s% g | ] } | j d k r | q S)r )rF )r9 r: r r r rh s z)MailboxList.mailboxes..r )r r r r r s zMailboxList.mailboxesc C s d d | D S)Nc S s% g | ] } | j d k r | q S)r invalid-mailbox)zmailboxr )rF )r9 r: r r r rh s z-MailboxList.all_mailboxes..r )r r r r r s zMailboxList.all_mailboxesN)r0 r1 r2 rF rc r r r r r r r s r c @ s: e Z d Z d Z e d d Z e d d Z d S) GroupListz
group-listc C s) | s | d j d k r g S| d j S)Nr z mailbox-list)rF r )r r r r r s zGroupList.mailboxesc C s) | s | d j d k r g S| d j S)Nr z mailbox-list)rF r )r r r r r s zGroupList.all_mailboxesN)r0 r1 r2 rF rc r r r r r r r s r c @ sL e Z d Z d Z e d d Z e d d Z e d d Z d S) Groupr c C s" | d j d k r g S| d j S)N z
group-list)rF r )r r r r r s zGroup.mailboxesc C s" | d j d k r g S| d j S)Nr z
group-list)rF r )r r r r r s zGroup.all_mailboxesc C s | d j S)Nr )r )r r r r r s zGroup.display_nameN)r0 r1 r2 rF rc r r r r r r r r s r c @ sp e Z d Z d Z e d d Z e d d Z e d d Z e d d Z e d
d Z d S)
NameAddrz name-addrc C s! t | d k r d S| d j S)Nr' r )r( r )r r r r r s zNameAddr.display_namec C s | d j S)Nr' rI )
local_part)r r r r r s zNameAddr.local_partc C s | d j S)Nr' rI )domain)r r r r r s zNameAddr.domainc C s | d j S)Nr' rI )route)r r r r r s zNameAddr.routec C s | d j S)Nr' rI ) addr_spec)r r r r r
s zNameAddr.addr_specN)
r0 r1 r2 rF rc r r r r r r r r r r s r c @ s^ e Z d Z d Z e d d Z e d d Z e d d Z e d d Z d
S) AngleAddrz
angle-addrc C s+ x$ | D] } | j d k r | j Sq Wd S)Nz addr-spec)rF r )r r: r r r r s
zAngleAddr.local_partc C s+ x$ | D] } | j d k r | j Sq Wd S)Nz addr-spec)rF r )r r: r r r r s
zAngleAddr.domainc C s+ x$ | D] } | j d k r | j Sq Wd S)Nz obs-route)rF domains)r r: r r r r " s
zAngleAddr.routec C s/ x( | D] } | j d k r | j Sq Wd Sd S)Nz addr-specz<>)rF r )r r: r r r r ( s
zAngleAddr.addr_specN) r0 r1 r2 rF rc r r r r r r r r r s
r c @ s( e Z d Z d Z e d d Z d S)ObsRoutez obs-routec C s d d | D S)Nc S s( g | ] } | j d k r | j q S)r )rF r )r9 r: r r r rh 7 s z$ObsRoute.domains..r )r r r r r 5 s zObsRoute.domainsN)r0 r1 r2 rF rc r r r r r r 1 s r c @ sp e Z d Z d Z e d d Z e d d Z e d d Z e d d Z e d
d Z d S)
Mailboxr c C s" | d j d k r | d j Sd S)Nr z name-addr)rF r )r r r r r > s zMailbox.display_namec C s | d j S)Nr )r )r r r r r C s zMailbox.local_partc C s | d j S)Nr )r )r r r r r G s zMailbox.domainc C s" | d j d k r | d j Sd S)Nr z name-addr)rF r )r r r r r K s z
Mailbox.routec C s | d j S)Nr )r )r r r r r P s zMailbox.addr_specN)
r0 r1 r2 rF rc r r r r r r r r r r : s r c @ s: e Z d Z d Z e d d Z e Z Z Z Z d S)InvalidMailboxzinvalid-mailboxc C s d S)Nr )r r r r r Y s zInvalidMailbox.display_nameN)
r0 r1 r2 rF rc r r r r r r r r r r U s r c s. e Z d Z d Z e f d d Z S)Domainr c s d j t j j S)Nr# )r$ r4 r split)r )r8 r r r d s z
Domain.domain)r0 r1 r2 rF rc r r r )r8 r r ` s r c @ s e Z d Z d Z d S)DotAtomzdot-atomN)r0 r1 r2 rF r r r r r i s r c @ s e Z d Z d Z d S) DotAtomTextz
dot-atom-textN)r0 r1 r2 rF r r r r r n s r c @ s^ e Z d Z d Z e d d Z e d d Z e d d Z e d d Z d
S) AddrSpecz addr-specc C s | d j S)Nr )r )r r r r r w s zAddrSpec.local_partc C s! t | d k r d S| d j S)N r' rI )r( r )r r r r r { s zAddrSpec.domainc C sJ t | d k r | d j S| d j j | d j | d j j S)Nr r r' r )r( r rstriplstrip)r r r r r s zAddrSpec.valuec C sh t | j } t | t | t k r= t | j } n | j } | j d k rd | d | j S| S)N@)setr r(
DOT_ATOM_ENDSr r )r ZnamesetZlpr r r r s zAddrSpec.addr_specN) r0 r1 r2 rF rc r r r r r r r r r s s
r c @ s e Z d Z d Z d S) ObsLocalPartzobs-local-partN)r0 r1 r2 rF r r r r r s r c s@ e Z d Z d Z e d d Z e f d d Z S) DisplayNamez display-namec C s t | } | d j d k r/ | j d n8 | d d j d k rg t | d d d | d s zTerminal.all_defectsr# c sI d j | | j j | j t j | j s3 d n d j | j g S)Nz
{}{}/{}({}){}r# z {})r< r8 r0 rF r4 r= r5 )r r] )r8 r r r_ s z Terminal._ppc C sJ t | } y | j d | SWn" t k
rE t j | | SYn Xd S)Nzus-ascii)r
rQ rX rP )r rR r r r r r rU s
zTerminal.cte_encodec C s d S)Nr )r r r r rA s zTerminal.pop_trailing_wsc C s d S)Nr )r r r r r* s zTerminal.pop_leading_fwsc C s g S)Nr )r r r r rL s zTerminal.commentsc C s d S)NFr )r r r r rK s z Terminal.has_leading_commentc C s t | | j f S)N)r
rF )r r r r __getnewargs__ s zTerminal.__getnewargs__)r0 r1 r2 r r= rc r> r_ rU rA r* rL rK r r r )r8 r r s r c @ s4 e Z d Z e d d Z d d Z d Z d S)WhiteSpaceTerminalc C s d S)Nre r )r r r r r s zWhiteSpaceTerminal.valuec C s d S)NTr )r r r r r@ s z!WhiteSpaceTerminal.startswith_fwsTN)r0 r1 r2 rc r r@ r) r r r r r s r c @ s@ e Z d Z e d d Z d d Z d Z d d Z d S)
ValueTerminalc C s | S)Nr )r r r r r s zValueTerminal.valuec C s d S)NFr )r r r r r@ s z ValueTerminal.startswith_fwsFc C s t j t | | S)N)rP rQ r
)r rR r r r rT s z ValueTerminal.as_encoded_wordN)r0 r1 r2 rc r r@ r) rT r r r r r s r c @ sF e Z d Z e d d Z e d d Z d d Z d Z d S) EWWhiteSpaceTerminalc C s d S)Nr# r )r r r r r s zEWWhiteSpaceTerminal.valuec C s | d d S)Nr )r r r r r $ s z EWWhiteSpaceTerminal.encodedc C s d S)Nr# r )r r r r r% ( s z EWWhiteSpaceTerminal.__str__TN)r0 r1 r2 rc r r r% r) r r r r r s r r ,zlist-separatorr zroute-component-markerz([{}]+)r# z[^{}]+r z\\]z\]z[\x00-\x20\x7F]c C s] t | } | r. | j j t j | n t j | rY | j j t j d n d S)z@If input token contains ASCII non-printables, register a defect.z*Non-ASCII characters found in header tokenN)_non_printable_finderr5 r r ZNonPrintableDefectr r rW )xtextZnon_printablesr r r _validate_xtextV s r c C s t | d ^ } } g } d } d } x t t | D]k } | | d k rq | re d } d } qq d } q: n | r d } n | | | k r Pn | j | | q: W| d } d j | d j | | d g | | f S)ak Scan printables/quoted-pairs until endchars and return unquoted ptext.
This function turns a run of qcontent, ccontent-without-comments, or
dtext-with-quoted-printables into a single string by unquoting any
quoted printables. It returns the string, the remaining value, and
a flag that is True iff there were any quoted printables decoded.
r' Fr Tr# N)
_wsp_splitterranger( r r$ )r endcharsZfragmentrv Zvcharsescapehad_qpposr r r _get_ptext_to_endchars` s$
r c C s? | j } t | d t | t | d } | | f S)zFWS = 1*WSP
This isn't the RFC definition. We're using fws to represent tokens where
folding can be done, but when we are parsing the *un*folding has already
been done so we don't need to watch out for CRLF.
NrE )r r r( )r ZnewvaluerE r r r get_fws~ s )r c
C sK t } | j d s3 t j d j | n | d d j d d ^ } } | | d d k r t j d j | n d j | } t | d k r | d t k r | d t k r | j d d ^ } } | d | } n t | j d k r$| j j
t j d n | | _ d j | } y' t
j d | d \ } } } } Wn- t k
rt j d
j | j Yn X| | _ | | _ | j j | x | r@| d t k rt | \ }
} | j
|
qn t | d ^ } } t | d } t | | j
| d j | } qW| | f S) zE encoded-word = "=?" charset "?" encoding "?" encoded-text "?="
z=?z"expected encoded word but found {}r Nz?=r' r# r z whitespace inside encoded wordz!encoded word format invalid: '{}'vtext)r~
startswithr HeaderParseErrorr< r r$ r( r r5 r r r rP r r rR r r WSPr r r r )
r Zewr rv Zremstrr r rR r r5 r, charsr r r r get_encoded_word sH "2
'
r c C s t } xq| r|| d t k rG t | \ } } | j | q n | j d r/y t | \ } } Wn t j k
r Yq/Xd } t | d k r | d j d k r | j
j t j d d } q n | r t | d k r | d
j d k r t | d d | d
This is not the RFC ctext, since we are handling nested comments in comment
and unquoting quoted-pairs here. We allow anything except the '()'
characters, but if we find any ASCII other than the RFC defined printable
ASCII an NonPrintableDefect is added to the token's defects list. Since
quoted pairs are converted to their unquoted values, what is returned is
a 'ptext' token. In this case it is a WhiteSpaceTerminal, so it's value
is ' '.
z()r )r r r )r r _r r r get_qp_ctext s
r c C s; t | d \ } } } t | d } t | | | f S)ao qcontent = qtext / quoted-pair
We allow anything except the DQUOTE character, but if we find any ASCII
other than the RFC defined printable ASCII an NonPrintableDefect is
added to the token's defects list. Any quoted pairs are converted to their
unquoted values, so what is returned is a 'ptext' token. In this case it
is a ValueTerminal.
r r )r r r )r r r r r r get_qcontent s
r c C sr t | } | s- t j d j | n | j } | t | d } t | d } t | | | f S)zatext =
We allow any non-ATOM_ENDS in atext, but add an InvalidATextDefect to
the token's defects list if we find non-atext characters.
z expected atext but found '{}'Natext)_non_atom_end_matcherr r r< r r( r r )r mr r r r get_atext s
r
c C sT | d d k r+ t j d j | n t } | d d } x | r| d d k r| d t k r t | \ } } n | d d d k r y/ t | \ } } | j j t j d Wqt j k
r t
| \ } } YqXn t
| \ } } | j | qG W| s@| j j t j d | | f S| | d d f S)
zbare-quoted-string = DQUOTE *([FWS] qcontent) [FWS] DQUOTE
A quoted-string without the leading or trailing white space. Its
value is the text between the quote marks, with whitespace
preserved and quoted pairs decoded.
r r zexpected '"' but found '{}'r' Nr z=?z!encoded word inside quoted stringz"end of header inside quoted string) r r r< r r r r r5 r r r )r Zbare_quoted_stringr, r r r get_bare_quoted_string s,
r c C s
| r1 | d d k r1 t j d j | n t } | d d } x | r | d d k r | d t k r t | \ } } n7 | d d k r t | \ } } n t | \ } } | j | qM W| s | j j t j
d | | f S| | d d f S)zcomment = "(" *([FWS] ccontent) [FWS] ")"
ccontent = ctext / quoted-pair / comment
We handle nested comments here, and quoted-pair in our qp-ctext routine.
r r zexpected '(' but found '{}'r' Nr z end of header inside comment) r r r< r r r get_commentr r r5 r )r rf r, r r r r ; s"
r c C st t } x^ | ri | d t k ri | d t k rG t | \ } } n t | \ } } | j | q W| | f S)z,CFWS = (1*([FWS] comment) [FWS]) / FWS
r )ry CFWS_LEADERr r r r )r rH r, r r r get_cfwsT s r c C s t } | rA | d t k rA t | \ } } | j | n t | \ } } | j | | r | d t k r t | \ } } | j | n | | f S)zquoted-string = [CFWS] [CFWS]
'bare-quoted-string' is an intermediate class defined by this
parser and not by the RFC grammar. It is the quoted string
without any attached CFWS.
r )r r
r r r )r Z
quoted_stringr, r r r get_quoted_stringa s
r c C s% t } | rA | d t k rA t | \ } } | j | n | rr | d t k rr t j d j | n | j d r y t | \ } } Wq t j k
r t
| \ } } Yq Xn t
| \ } } | j | | r| d t k rt | \ } } | j | n | | f S)zPatom = [CFWS] 1*atext [CFWS]
An atom could be an rfc2047 encoded word.
r z expected atom but found '{}'z=?) r{ r
r r ATOM_ENDSr r r< r r r
)r r| r, r r r get_atoms s$
r c C s t } | s | d t k r; t j d j | n xo | r | d t k r t | \ } } | j | | r> | d d k r> | j t | d d } q> q> W| d t k r t j d j d | n | | f S)z( dot-text = 1*atext *("." 1*atext)
r z8expected atom at a start of dot-atom-text but found '{}'r r' Nz4expected atom at end of dot-atom-text but found '{}'rI )r r r r r< r
r r )r Z
dot_atom_textr, r r r get_dot_atom_text s
r c C s t } | d t k r; t | \ } } | j | n | j d r y t | \ } } Wq t j k
r t | \ } } Yq Xn t | \ } } | j | | r | d t k r t | \ } } | j | n | | f S)z dot-atom = [CFWS] dot-atom-text [CFWS]
Any place we can have a dot atom, we could instead have an rfc2047 encoded
word.
r z=?) r r
r r r r r r r )r Zdot_atomr, r r r get_dot_atom s
r c C s | d t k r% t | \ } } n d } | d d k rP t | \ } } n= | d t k r{ t j d j | n t | \ } } | d k r | g | d d | d t k r>| d d k r | j t | j j t j d | d d } q` y t | \ } } WnV t j k
r-| d t
k r&t | \ } } | j j t j d n Yn X| j | q` W| | f S)a phrase = 1*word / obs-phrase
obs-phrase = word *(word / "." / CFWS)
This means a phrase can be a sequence of words, periods, and CFWS in any
order as long as it starts with at least one word. If anything other than
words is detected, an ObsoleteHeaderDefect is added to the token's defect
list. We also accept a phrase that starts with CFWS followed by a dot;
this is registered as an InvalidHeaderDefect, since it is not supported by
even the obsolete grammar.
z phrase does not start with wordr r zperiod in 'phrase'r' Nzcomment found without atom) rs r r r r r5 r PHRASE_ENDSr ObsoleteHeaderDefectr
r )r rt r, r r r
get_phrase s.
r c C s t } d } | d t k r4 t | \ } } n | sU t j d j | n y t | \ } } Wnr t j k
r y t | \ } } WnD t j k
r | d d k r | d t k r n t } Yn XYn X| d k r| g | d d | d j d k r>| j j t j d n | j rSd | _ n | | f S)z' obs-local-part = word *("." word)
Fr r r zinvalid repeated '.'Tr' Nzmisplaced-specialz/'\' character outside of quoted-string/ccontentr zmissing '.' between wordsrH z!Invalid leading '.' in local partr z"Invalid trailing '.' in local partzinvalid-obs-local-partrI rI rI r )
r r r5 r r r r r rF r r r
r )r r Zlast_non_ws_was_dotr, r r r r & sV )
r c C s] t | d \ } } } t | d } | rI | j j t j d n t | | | f S)a dtext = / obs-dtext
obs-dtext = obs-NO-WS-CTL / quoted-pair
We allow anything except the excluded characters, but if we find any
ASCII other than the RFC defined printable ASCII an NonPrintableDefect is
added to the token's defects list. Quoted pairs are converted to their
unquoted values, so what is returned is a ptext token, in this case a
ValueTerminal. If there were quoted-printables, an ObsoleteHeaderDefect is
added to the returned token's defect list.
z[]r z(quoted printable found in domain-literal)r r r5 r r r r )r r r r r r get_dtextU s
r c C s: | r
d S| j t j d | j t d d d S)NFz"end of input inside domain-literalr zdomain-literal-endT)r r r r )r domain_literalr r r _check_for_early_dl_endi s
r c C s t } | d t k r; t | \ } } | j | n | sS t j d n | d d k r~ t j d j | n | d d } t | | r | | f S| j t d d | d t k r t
| \ } } | j | n t | \ } } | j | t | | r'| | f S| d t k rYt
| \ } } | j | n t | | rr| | f S| d d k rt j d j | n | j t d d
| d d } | r| d t k rt | \ } } | j | n | | f S) zB domain-literal = [CFWS] "[" *([FWS] dtext) [FWS] "]" [CFWS]
r zexpected domain-literal[z6expected '[' at start of domain-literal but found '{}'r' Nzdomain-literal-startr z4expected ']' at end of domain-literal but found '{}'zdomain-literal-end) r r
r r r r r< r r r r r )r r r, r r r get_domain_literalq sD
r" c C s t } d } | d t k r4 t | \ } } n | sU t j d j | n | d d k r t | \ } } | d k r | g | d d " [CFWS] / obs-angle-addr
obs-angle-addr = [CFWS] "<" obs-route addr-spec ">" [CFWS]
r zangle-addr-endz null addr-spec in angle-addrz*obsolete route specification in angle-addrz.expected addr-spec or obs-route but found '{}'z"missing trailing '>' on angle-addr)
r r
r r r r r< r r5 r r$ r( r )r Z
angle_addrr, r r r get_angle_addr sJ
r+ c C sR t } t | \ } } | j | d d | j d d | _ | | f S)z display-name = phrase
Because this is simply a name-rule, we don't return a display-name
token containing a phrase, but rather a display-name token with
the content of the phrase.
N)r r r r5 )r r r, r r r get_display_name# s
r, c C sJ t } d } | d t k rU t | \ } } | sU t j d j | qU n | d d k r | d t k r t j d j | n t | \ } } | s t j d j | n | d k r | g | d d d .zinvalid-mailbox)
r r- r r r$ r< rY r> rF r )r r r, r r r get_mailboxP s
r. c C s t } xv | r | d | k r | d t k r_ | j t | d d | d d } q t | \ } } | j | q W| | f S)z Read everything up to one of the chars in endchars.
This is outside the formal grammar. The InvalidMailbox TokenList that is
returned acts like a Mailbox, but the data attributes are None.
r zmisplaced-specialr' N)r r r r r )r r Zinvalid_mailboxr, r r r get_invalid_mailboxe s
r/ c C sY t } xC| rN| d d k rNy# t | \ } } | j | Wnft j k
rd } | d t k r t | \ } } | s | d d k r | j | | j j t j d qt | d \ } } | d k r | g | d d
We allow any non-TOKEN_ENDS in ttext, but add defects to the token's
defects list if we find non-ttext characters. We also register defects for
*any* non-printables even though the RFC doesn't exclude all of them,
because we follow the spirit of RFC 5322.
z expected ttext but found '{}'Nttext)_non_token_end_matcherr r r< r r( r r )r r r= r r r get_ttext s
r? c C s t } | rA | d t k rA t | \ } } | j | n | rr | d t k rr t j d j | n t | \ } } | j | | r | d t k r t | \ } } | j | n | | f S)ztoken = [CFWS] 1*ttext [CFWS]
The RFC equivalent of ttext is any US-ASCII chars except space, ctls, or
tspecials. We also exclude tabs even though the RFC doesn't.
The RFC implies the CFWS but is not explicit about it in the BNF.
r z expected token but found '{}') r} r
r r
TOKEN_ENDSr r r< r? )r Zmtokenr, r r r get_token s
rA c C sr t | } | s- t j d j | n | j } | t | d } t | d } t | | | f S)aQ attrtext = 1*(any non-ATTRIBUTE_ENDS character)
We allow any non-ATTRIBUTE_ENDS in attrtext, but add defects to the
token's defects list if we find non-attrtext characters. We also register
defects for *any* non-printables even though the RFC doesn't exclude all of
them, because we follow the spirit of RFC 5322.
z expected attrtext but found {!r}Nr )_non_attribute_end_matcherr r r< r r( r r )r r r r r r get_attrtext s
rC c C s t } | rA | d t k rA t | \ } } | j | n | rr | d t k rr t j d j | n t | \ } } | j | | r | d t k r t | \ } } | j | n | | f S)aH [CFWS] 1*attrtext [CFWS]
This version of the BNF makes the CFWS explicit, and as usual we use a
value terminal for the actual run of characters. The RFC equivalent of
attrtext is the token characters, with the subtraction of '*', "'", and '%'.
We include tab in the excluded set just as we do for token.
r z expected token but found '{}') r r
r r ATTRIBUTE_ENDSr r r< rC )r r r, r r r
get_attribute s
rE c C sr t | } | s- t j d j | n | j } | t | d } t | d } t | | | f S)zattrtext = 1*(any non-ATTRIBUTE_ENDS character plus '%')
This is a special parsing routine so that we get a value that
includes % escapes as a single string (which we decode as a single
string later).
z)expected extended attrtext but found {!r}Nzextended-attrtext)#_non_extended_attribute_end_matcherr r r< r r( r r )r r r r r r get_extended_attrtext s
rG c C s t } | rA | d t k rA t | \ } } | j | n | rr | d t k rr t j d j | n t | \ } } | j | | r | d t k r t | \ } } | j | n | | f S)z [CFWS] 1*extended_attrtext [CFWS]
This is like the non-extended version except we allow % characters, so that
we can pick up an encoded value as a single string.
r z expected token but found '{}') r r
r r EXTENDED_ATTRIBUTE_ENDSr r r< rG )r r r, r r r get_extended_attribute
s
rI c C s< t } | s | d d k r; t j d j | n | j t d d | d d } | sy | d j r t j d j | n d } x8 | r | d j r | | d 7} | d d } q W| d d k r
| d k r
| j j t j d
n t | | _
| j t | d | | f S) a6 '*' digits
The formal BNF is more complicated because leading 0s are not allowed. We
check for that and add a defect. We also assume no CFWS is allowed between
the '*' and the digits, though the RFC is not crystal clear on that.
The caller should already have dealt with leading CFWS.
r *z Expected section but found {}zsection-markerr' Nz$Expected section number but found {}r# 0z§ion numberhas an invalid leading 0r7 ) r r r r< r r r9 r5 ZInvalidHeaderErrorr: r )r r r7 r r r get_section
s$ rL c C s t } | s! t j d n d } | d t k rL t | \ } } n | sm t j d j | n | d d k r t | \ } } n t | \ } } | d k r | g | d d
s
rN c C s t } t | \ } } | j | | s? | d d k rk | j j t j d j | | | f S| d d k r y, t | \ } } d | _ | j | Wn t j k
r Yn X| s t j d n | d d k r | j t
d d | d d } d | _ q n | d d
k r>t j d n | j t
d
d | d d } d } | r| d t k rt
| \ } } | j | n d } | } | j r| r| d d
k rt | \ } } | j } d } | j d k rP| r | d d k r d } qt | \ } } | r| d d k rd } qn0 y t | \ } } Wn Yn X| sd } n | r| j j t j d | j | x7 | D]/ }
|
j d k rg |
d d <|
} PqqW| } qd } | j j t j d n | r0| d d k r0d } n t | \ } } | j s[| j d k r| sr| d d k r| j | | d k r| } n | | f S| j j t j d n | s| j j t j d | j | | d k rE| | f SnF| d k rXx! | D] }
|
j d k rPqqW|
j d k | j |
|
j | _ n | d d k rt j d j | n | j t
d d | d d } | r | d d k r t | \ } } | j | | j | _ | s| d d k r t j d j | q n | j t
d d | d d } | d k rt } xN | r| d t k rt | \ } } n t | \ } } | j | q]W| } n t | \ } } | j | | d k r| } n | | f S)aY attribute [section] ["*"] [CFWS] "=" value
The CFWS is implied by the RFC but not made explicit in the BNF. This
simplified form of the BNF from the RFC is made to conform with the RFC BNF
through some extra checks. We do it this way because it makes both error
recovery and working with the resulting parse tree easier.
r r0 z)Parameter contains name ({}) but no valuerJ TzIncomplete parameterzextended-parameter-markerr' N=z Parameter not followed by '='zparameter-separatorr F'z5Quoted string value for extended parameter is invalidzbare-quoted-stringzZParameter marked as extended but appears to have a quoted string value that is non-encodedzcApparent initial-extended-value but attribute was not marked as extended or was not initial sectionz(Missing required charset/lang delimiterszextended-attrtextr z=Expected RFC2231 char/lang encoding delimiter, but found {!r}zRFC2231 delimiterz;Expected RFC2231 char/lang encoding delimiter, but found {}) r rE r r5 r r r< rL r r r r r
r r r r rC rG rF rN r rR r r r r r ) r r r, r rv ZappendtoZqstringZ inner_valueZ
semi_validr trM r r r
get_parameterT
s
rR c C s t } x| ry# t | \ } } | j | Wnt j k
rF} z d } | d t k rx t | \ } } n | s | j | | S| d d k r | d k r | j | n | j j t j d n] t | \ } } | r| g | d d t } d } | s2 | j j t j d | Sy t | \ } } WnH t j k
r | j j t j d j | t | | | SYn X| j | | s | d d k r | j j t j d | r t | | n | S| j
j j | _
| j t d d | d d } y t | \ } } WnH t j k
r| j j t j d
j | t | | | SYn X| j | | j
j j | _ | s| S| d d k r| j j t j d j | | `
| ` t | | | S| j t d d
| j t | d d | S)z maintype "/" subtype *( ";" parameter )
The maintype and substype are tokens. Theoretically they could
be checked against the official IANA list + x-token, but we
don't do that.
Fz"Missing content type specificationz(Expected content maintype but found {!r}r /zInvalid content typezcontent-type-separatorr' Nz'Expected content subtype but found {!r}r0 z rB rF r r r r rk r r r
r r r r r r r r r r r r r r" r# r$ r( r+ r, r- r. r/ r1 r2 r3 r4 r6 r; r< r? rA rC rE rG rI rL rN rR rS rT rW rX rY r r r r D s
T J_ '#
U3 $ 0 0 0 !
* 8
& ' / ' $ ) . 9 % > D 4 9