o .jo@szdZddlZddlZddlmZddlmZmZddlm Z m Z m Z ddl m Z ddlmZddlmZdd lmZdd lmZmZdd lmZdd lmZdd lmZddlmZe r^e Ze e!Z"eGdddZ#eGdddZ$eGdddZ%de&de&fddZ'de&dBddfddZ(de&dBde)fddZ*deddfd d!Z+d,d%d&Z,d'ede fd(d)Z-Gd*d+d+Z.dS)-zI DAV response parsing: base class, result types and XML parse functions. N)Iterable) dataclassfield) TYPE_CHECKINGAnycast)unquote)etree)_Element)FreeBusy)cdavdav) BaseElement)error) to_normal_str)URLc@s@eZdZUdZeed<eedZeee fed<dZ e ed<dS)PropfindResultz:Parsed result of a PROPFIND request for a single resource.hrefdefault_factory propertiesstatusN) __name__ __module__ __qualname____doc__str__annotations__rdictrrrintr!r!D/home/thesage/.local/lib/python3.10/site-packages/caldav/response.pyr!s rc@sFeZdZUdZeed<dZedBed<dZedBed<dZe ed<dS)CalendarQueryResultzRParsed result of a calendar-query or calendar-multiget REPORT for a single object.rNetag calendar_datarr) rrrrrrr$r%rr r!r!r!r"r#*s r#c@sNeZdZUdZeedZeeed<eedZ ee ed<dZ e dBed<dS)SyncCollectionResultz*Parsed result of a sync-collection REPORT.rchangeddeletedN sync_token) rrrrrlistr'r#rr(rr)r!r!r!r"r&4s r&textreturncCs6d|vr |dd}t|}d|vrtt|j}|S)uNormalize an href string from a DAV response element. Handles the Confluence double-encoding bug (%2540 → %40) and converts absolute URLs to path-only strings so callers always work with paths. z%2540z%40:)replacerrpath)r+rr!r!r"_normalize_hrefBs  r0rcs0durdStfdddDstdS)z{Validate a status string like "HTTP/1.1 404 Not Found". 200, 201, 207 and 404 are considered acceptable statuses. Nc3s|]}|vVqdSNr!).0coderr!r" Ysz#_validate_status..)z 200 z 201 z 207  404 )anyr ResponseErrorr4r!r4r"_validate_statusRs  r9cCsD|sdS|}t|dkr zt|dWStyYdSwdS)zHExtract integer status code from a status string like "HTTP/1.1 200 OK".r)splitlenr ValueError)rpartsr!r!r"_status_to_code]s  r@treez_Element | list[_Element]cCsH|jdkrt|dkr|djtjjkr|dS|jtjjkr!|S|gS)uStrip outer elements to reach the multistatus response children. The general format is …… but sometimes the multistatus and/or xml wrapper is absent. xmlr)tagr=r MultiStatus)rAr!r!r"_strip_to_multistatusjs (rE propstatslist[_Element]dict[str, Any]cCsi}|D];}|tjj}|dur|jrd|jvrq|tjj}|dur&q|D]}t|dkr7|j||j<q(t|||j<q(q|S)z;Extract properties from propstat elements into a flat dict.Nr6r)findr StatusrCr+Propr=_element_to_value)rFrpropstat status_elempropchildr!r!r"_extract_propertiesws rQelemcCsFt|dkr |jS|j}|tjjkrdd|DS|tjjkr&dd|DS|tjjkr?dd|D}t|dkr=|dS|S|tjjkrLdd|DS|tj jkrh|D]}|jtj jkre|jre|jSqTdSg}|D]&}|jrx| |jql| d r| | d qlt|dkr| |jqlt|dkr|dS|r|S|S) z0Convert a complex XML element to a Python value.rcSs g|] }|dr|dqS)name)getr2rPr!r!r" s z%_element_to_value..cS&g|]}|jtjjkr|jr|jqSr!rCr Hrefr+rUr!r!r"rV&cSrWr!rXrUr!r!r"rVrZr;cSsg|]}|jqSr!)rCrUr!r!r"rVsNrS) r=r+rCr SupportedCalendarComponentSetCalendarUserAddressSetCalendarHomeSetr ResourceTypeCurrentUserPrincipalrYappendrT)rRrChrefsrPchildren_textsr!r!r"rLs@           rLc @s~eZdZUdZdZedBed<dZeed<dZ e ed<dZ eed<d Z e ed <dZeed <dZeed <dZeeeBdBed <dZedBed<dGddd eddfddZe dHdede d e ddfddZdGddd eddfddZedefddZdeeeBfddZdeddfdd Z ! "  #dId$d%ZdJd'd(Z dKd*d+Z!dLd-d.Z"dede#eeeedBffd/d0Z$de%fd1d2Z&de%eeffd3d4Z'ed5d6Z(de%ee%eefffd7d8Z)de%ee%eefffd9d:Z* dMd;ededBdeeeBdBf d?d@Z+de%ee%eefffdAdBZ,   dNdCe-e.dBdDe-edBd>edBde%ee%eefffdEdFZ/dS)O DAVResponsez Base class containing shared response parsing logic. This class provides the XML parsing and response extraction methods that are common to both sync and async DAV responses. NrAheadersrr_rawF huge_treereason davclientresults _sync_tokenresponseResponser,cCs|||dSr1)_init_from_response)selfrlrir!r!r"__init__zDAVResponse.__init__body status_codecCshGddd}|}||_||_|r|jdddnd|_||}||_d|_d|_d|_| ||S)u>Construct a DAVResponse from raw bytes — intended for tests.c@s*eZdZUiZeed<dZdZdZdZ dS)z-DAVResponse.from_bytes.._FakeResponserdrreOKN) rrrrdrrrtcontentr+rhr!r!r!r" _FakeResponses rxzutf-8r.)errorsreN) rtrwdecoder+__new__rgrirjrkrn)clsrsrtrgrxfakeobjr!r!r" from_bytess  zDAVResponse.from_bytesc sJ|j|_|j|_tdt|jtdt|j|j|_||_|r)|j |_ |j ddddg}gd}t fdd |D}t fd d |D}rd|sd|sd|jd krd|j rdt d z t|jd }Wntttfy{d}Ynw|dks|jsd|_d|_tdnKztj|jtjd|j dd|_Wn(ty|rtjtjkr|stj}ntj}|dt|jdd|rƂYnwtjtjkrttj|jddt|drt|jt|jtr|j dd|_nt|jtr|j dd|_|j|_zt!|ddp|j"|_"WdSt#y$d|_"YdSw)a Initialize response from an HTTP response object. This shared method extracts headers, status, and parses XML content. Both DAVResponse and AsyncDAVResponse should call this from their __init__. Args: response: The HTTP response object from niquests davclient: Optional reference to the DAVClient for huge_tree setting zresponse headers: zresponse status: z Content-Typereztext/xmlzapplication/xml)z text/plain text/calendarzapplication/octet-streamc3|]}|VqdSr1 startswithr2x content_typer!r"r5z2DAVResponse._init_from_response..c3rr1rrrr!r"r5rizUnexpected content type: zContent-LengthrNzNo content deliveredT)remove_blank_textrg)parserz8Expected some valid XML from the server, but got this: )exc_info pretty_printrfs  z  reason_phrase)$rdrtrlogdebugrrwrfrirgrTr7r+r weirdnessr KeyErrorr> TypeErrorrAr XML XMLParser ExceptionlevelloggingDEBUGinfotostringhasattr isinstancebytesr.getattrrhAttributeError) rorlri xml_types no_xml_types expect_xml expect_no_xmlcontent_length_logr!rr"rns         zDAVResponse._init_from_responsecCs,t|dstjtt|jdd|_t|jS)z,Return the raw response content as a string.rfTr)rr rrr rArfrror!r!r"raw=s  zDAVResponse.rawcCs t|jS)a  The general format of inbound data is something like this: (...) (...) (...) but sometimes the multistatus and/or xml element is missing in self.tree. We don't want to bother with the multistatus and xml tags, we just want the response list. An "Element" in the lxml library is a list-like object, so we should typically return the element right above the responses. If there is nothing but a response, return it as a list with one element. (The equivalent of this method could probably be found with a simple XPath query, but I'm not much into XPath) )rErArr!r!r"rEDs z!DAVResponse._strip_to_multistatuscCs t|dS)a status is a string like "HTTP/1.1 404 Not Found". 200, 207 and 404 are considered good statuses. The SOGo caldav server even returns "201 created" when doing a sync-report, to indicate that a resource was created after the last sync-token. This makes sense to me, but I've only seen it from SOGo, and it's not in accordance with the examples in rfc6578. N)r9)rorr!r!r"validate_status\s zDAVResponse.validate_statusrFrGtuple[str | None, str | None]cCsfd}d}|D](}|tjj}|durq|D]}|jtjjkr#|j}q|jtjjkr-|j}qq||fS)z?Extract (etag, calendar_data) from a list of propstat elements.N)rIr rKrCr CalendarDatar+GetEtag)rorFr$r%rMrOrPr!r!r"_extract_calendar_query_propsgsz)DAVResponse._extract_calendar_query_propslist[PropfindResult]cCs|jdkrgS|jdvrtd|j|jdurgSg}|D]0}|jtjjkr0|j|_ q"|jtj jkr8q"| |\}}}| t |t||rMt|nddq"|S)z9Parse the response body as a PROPFIND multi-status reply.rrrzPROPFIND failed with status Nr)rrr)rrr8rArErCr SyncTokenr+rkrm_parse_responser`rrQr@)rorjrRrrFrr!r!r"parse_propfindxs,    zDAVResponse.parse_propfindlist[CalendarQueryResult]c Cs|jdvrtd|j|jdurgSg}|D]*}|jtjjkr%q||\}}}| |\}}| t ||||r@t |nddq|S)zNParse the response body as a calendar-query or calendar-multiget REPORT reply.rzREPORT failed with status Nrrr$r%r) rrr8rArErCr rmrrr`r#r@)rorjrRrrFrr$r%r!r!r"parse_calendar_querys&   z DAVResponse.parse_calendar_queryr&c Cs|jdvrtd|j|jdurtSg}g}d}|D]E}|jtjjkr1|j }|j |_ q |jtj jkr9q | |\}}}|rGt |nd}|dkrS||q ||\} } |t|| | |dq t|||dS)z:Parse the response body as a sync-collection REPORT reply.rz#sync-collection failed with status Nrrr)r'r(r))rrr8rAr&rErCr rr+rkrmrr@r`rr#) ror'r(r)rRrrF status_strrtr$r%r!r!r"parse_sync_collections:    z!DAVResponse.parse_sync_collectioncCs>d}d}g}d}t|jtjjk|D]t}|jtjjkr1t| |j}t|||q|jtjjkrFt| t |jpCd}q|jtj jkrS| |q|jdkrct|jdkd}q|jdkr| }tt |dkt|d jd kd}qtd |qt||rtd |vtt|||fS) z One response should contain one or zero status children, one href tag and zero or more propstats. Find them, assert there isn't more in the response and return those three fields NFrez{DAV:}responsedescriptionzNo resources foundTz {DAV:}errorr;rz&{https://purelymail.com}does-not-existz$unexpected element found in response404)rassert_rCr rmrJr+rrYr0PropStatr` getchildrenr=rrr)rorlrrrF check_404rRchildrenr!r!r"rs:        zDAVResponse._parse_responsecCsi|_i|jd<t|jjtjjk|jD]4}t|jtjjk||}|D] }| dr>|||jd|dd<q)t |||d|j|<q)q|jS)aParses an RFC6638 freebusy scheduling request response The response from the server is asserted to be a scheduling-response, with freebusy status for one or more wanted attendee - potentially with error status for all or some of the wanted attendees. Returns: Dict with: * email addresses -> FreeBusy status (raw data) * errors - dict with email addresses -> error messages ry:errN)parentdata) objectsrrrArCr ScheduleResponserm_parse_scheduling_responseendswithr )rorrlparsed_responserr!r!r""_parse_scheduling_response_objectss    z.DAVResponse._parse_scheduling_response_objectscCsi}d}d}d}|D]C}|jtjjkr/t|dkr+t|djtjjk|dj}q |j}q |jtj jkr:|j}q |jtj jkrE|j}q t d|jt|t|| dsd|||d<|rj|||<|S)a3 Parses one attendee response from a RFC6638 freebusy scheduling request Returns: * ``{ recipient => calendar_data }`` if everything is OK, * ``{f"{recipient}:err": status}`` if things are not OK, * a dict with both elements if things are partially OK Nr;rzunexpected attribute 2.0r) rCr Recipientr=rrr rYr+ RequestStatusrDAVErrorr)rorlret recipientrr%rr!r!r"rs,      z&DAVResponse._parse_scheduling_responsecCsbz|j}Wn tyd}Ynw|dur/|jdur$|jdtjjng}|r-|djnd}|S)Nz.//r)rkrrAfindallr rrCr+)ror)tokensr!r!r"r)4s  "zDAVResponse.sync_tokenc CsJi|_i|_d|jvr|jd|_|}|D]}|jtjjkr%|j|_ qt |jtj jk| |\}}}||jvrFi|j|<||j|<|D]X}d}|tjj}t |du|dur||jdur|t t|dk|d7}||jd|jvr|qH|tjjD]}|d7}|D] } | |j|| j<qqt |t|kqHq|jS)zNInternal implementation of find_objects_and_props without deprecation warning.z Schedule-TagrNr;r6)rstatusesrd schedule_tagrErCr rr+rkrrrmrrIrJr=riterfindrK) ro responsesrrrFrrMcntrOthepropr!r!r"_find_objects_and_propsFs@       z#DAVResponse._find_objects_and_propscCstjdtdd|S)aNCheck the response from the server, check that it is on an expected format, find hrefs and props from it and check statuses delivered. The parsed data will be put into self.objects, a dict {href: {proptag: prop_element}}. Further parsing of the prop_element has to be done by the caller. self.sync_token will be populated if found, self.objects will be populated. .. deprecated:: Use ``response.results`` instead, which provides pre-parsed property values. This method will be removed in a future version. zfind_objects_and_props() is deprecated. Use response.results instead, which provides pre-parsed property values from the protocol layer.r:) stacklevel)warningswarnDeprecationWarningrrr!r!r"find_objects_and_propsys z"DAVResponse.find_objects_and_propsproptag props_foundmulti_value_allowedxpathc Cs2g}||vr||}|D]9}|tjjkr8|ddr(|ddkr(q|ddr8|ddvr8qtd|dd |d q|sZt |dkrZ|j rY| |j n*|r^|nd }| |} g}| D]} t | | j r}| | j qi| | jqi|r|S|sdSt t |dk|dS) Nrz content-typer;rversion)2rzIf you see this, please add a report at https://github.com/python-caldav/caldav/issues/209 - in _expand_simple_prop, dealing with z, extra item found: =.z.//*)itemsr rrClowerrrrjoinr=r+r`rr) rorrrrvaluesprop_xmlitem_xpathleafsleafr!r!r"_expand_simple_props@     zDAVResponse._expand_simple_propcOs|j|i|Sr1)_expand_simple_props)rolargskwargsr!r!r"expand_simple_propsrqzDAVResponse.expand_simple_propspropsmulti_value_propscCs|pg}|pg}t|ds||jD]6}|j|}|D]}|jdur%q|j|j||d||j<q|D]}|jdurs>              +