iT>dZddlmZddlZddlmZmZddlmZddl m Z m Z m Z ddl mZddlmZmZdd lmZdd lmZe rdd lmZejd ZGd deZGddeZGddZd*dZ d+d,d(Z d-d.d)Z dS)/z Base class for DAV clients. This module contains the BaseDAVClient class which provides shared functionality for both sync (DAVClient) and async (AsyncDAVClient) clients. ) annotationsN)ABCabstractmethod)Mapping) TYPE_CHECKINGAnyNoReturn)error)extract_auth_typesselect_auth_type) to_normal_str)URL) FeatureSetcaldavceZdZUdZdgZgdZdZded<dZded<dZ ded <dZ ded <dZ d ed <dZ d ed<d8dZ d9dZd:d;dZdd$Zd?d(Zd@d+ZdAd/ZdBdCd3ZdDdEd6Zed:dFd7ZdS)G BaseDAVClienta Base class for DAV clients providing shared authentication and configuration logic. This abstract base class contains common functionality used by both DAVClient (sync) and AsyncDAVClient (async). Subclasses must implement the abstract methods for their specific HTTP library. Shared functionality: - Authentication type extraction and selection - Feature set management - Common properties (username, password, auth_type, etc.) z0{urn:ietf:params:xml:ns:caldav}calendar-home-set)z{DAV:}resourcetypez{DAV:}displaynamez?{urn:ietf:params:xml:ns:caldav}supported-calendar-component-setz){http://apple.com/ns/ical/}calendar-colorz&{http://calendarserver.org/ns/}getctagN str | Noneusernamepassword Any | Noneauth auth_typezFeatureSet | Nonefeaturesrurlstrreturnc|r<|ds't|j|S|S)zMake a URL absolute by joining with the client's base URL if needed. Args: url: URL string, possibly relative (e.g., "/calendars/user/") Returns: Absolute URL string. http) startswithrrjoin)selfrs M/root/projects/butler/venv/lib/python3.11/site-packages/caldav/base_client.py_make_absolute_urlz BaseDAVClient._make_absolute_url:s@  +s~~f-- +tx}}S))** * headerset[str]c t|S)aExtract authentication types from WWW-Authenticate header. Parses the WWW-Authenticate header value and extracts the authentication scheme names (e.g., "basic", "digest", "bearer"). Args: header: WWW-Authenticate header value from server response. Returns: Set of lowercase auth type strings. Example: >>> client.extract_auth_types('Basic realm="test", Digest realm="test"') {'basic', 'digest'} )r )r!r%s r"r z BaseDAVClient.extract_auth_typesGs "&)))r$ auth_typeslist[str] | NonecB|j}|s|stjd|r!|r||vrtjd|d||sZ|rXt|t |jt |j}|s d|vr|jstjd|S)a Select the best authentication type from available options. This method implements the shared logic for choosing an auth type based on configured credentials and server-supported types. Args: auth_types: List of acceptable auth types from server. Returns: Selected auth type string, or None if no suitable type found. Raises: AuthorizationError: If configuration conflicts with server capabilities. zlNo auth-type given. This shouldn't happen. Raise an issue at https://github.com/python-caldav/caldav/issues/zConfiguration specifies to use z, but server only accepts )reason) has_username has_passwordbearerzeServer provides bearer auth, but no password given. The bearer token should be configured as password)rr AuthorizationErrorr boolrr)r!r(rs r"_select_auth_typezBaseDAVClient._select_auth_typeYs  N   *T   )  (C(C*888+588   Z (!$-00!$-00I Z!7!7 !7.H r$methodbodyheadersMapping[str, str] | Nonetuple[URL, dict]c 4|pi}|j}||||dkrd|vr|d=tj|}t d|dt|d|dt|||fS)zCombine headers, strip Content-Type for empty bodies, objectify URL, and log. Returns: (url_obj, combined_headers) ready to pass to the HTTP library. Nz Content-Typezsending request - method=z, url=z , headers=z body: ) r4copyupdater objectifylogdebugrr )r!rr2r3r4combined_headersurl_objs r"_prepare_requestzBaseDAVClient._prepare_requests-R<,,..((( LDBJJN>N,N,N 0-$$  H H Hc'll H H' H H2?2E2E H H   (((r$ status_codeintr0cJ|dkod|vo|j o|jduo|jduS)zReturn True when a 401 response warrants auth negotiation. True when: status is 401, WWW-Authenticate header present, no auth object yet, and credentials are configured. izWWW-AuthenticateN)rrr)r!rAr4s r"_should_negotiate_authz$BaseDAVClient._should_negotiate_authsL 3  *"g- *I  * T) * T)  r$www_authenticateNonec||}|||jstddS)zBuild auth object from a WWW-Authenticate header value. Raises: NotImplementedError: If the server offers no supported auth method. zhThe server does not provide any of the currently supported authentication methods: basic, digest, bearerN)r build_auth_objectrNotImplementedError)r!rEr(s r"_build_auth_from_401z"BaseDAVClient._build_auth_from_401sX ,,-=>>  z***y %J   r$url_str reason_sourcer cd |j}n#t$rd}YnwxYwtj||)zFRaise AuthorizationError, extracting reason from reason_source.reason.z None given)rr+)r+AttributeErrorr r/)r!rKrLr+s r"_raise_authorization_errorz(BaseDAVClient._raise_authorization_errorsK "")FF " " "!FFF "&76BBBBs  namebytescddlm}ddlm}m}|rX|||gzgz||zgng}| |z|| |gz}| | S)z:Build the XML body for a principal-property-search REPORT.r)etreecdavdav)value) lxmlrScaldav.elementsrUrVPropertySearchProp DisplayNameMatchPrincipalPropertySearchCalendarHomeSettostring xmlelement)r!rPrSrUrV name_filterquerys r"_build_principal_search_queryz+BaseDAVClient._build_principal_search_querys-------- S   ! !SXXZZ3??3D3D2E%E$F FY]I^I^ ^ _ _   ' ' ) ) xxzz4//113??3D3DE F  ~~e..00111r$principal_dictdictlistc ddlm}m}ddlm}m}g}|D]}||}|jj|vr||jjj} tj ||jj tj ||jj ||j j} tj | tj | j | } tj t| dktj | d tj | d | dj} ||| } ||||| | |S)zFParse principal-property-search REPORT results into Principal objects.r) CalendarSet PrincipalrT)clientr)rlrrPcalendar_home_set)caldav.collectionrirjrYrUrVr\tagtextr assert_ getchildrenitemsr_lenappend)r!rerirjrUrVretxprPchschs_hrefchs_urlrms r" _parse_principal_search_responsez.BaseDAVClient._parse_principal_search_responses<<<<<<<<--------  Aq!A"!++S_().D Ma 34@@BBB C C C Ma 34::<<< = = =D(,-C Mciikk/ * * * Mch, ' ' '((H M#h--1, - - - Mhqk//111 2 2 2 Mhqk55777 8 8 8qk&G + 4W E E E  JJ 14K\]]]     r$calendarstartendc4||d||S)zGet events from a calendar, optionally filtered by date range. For sync clients returns a list directly. For async clients returns a coroutine that must be awaited. T)eventr~rsearch_calendar)r!r}r~rs r" get_eventszBaseDAVClient.get_eventss! ##HD3#OOOr$Finclude_completedc2||d|S)zGet todos from a calendar. For sync clients returns a list directly. For async clients returns a coroutine that must be awaited. T)todorr)r!r}rs r" get_todoszBaseDAVClient.get_todoss ##H4K\#]]]r$cdS)a5 Build authentication object based on configured credentials. This method must be implemented by subclasses to create the appropriate auth object for their HTTP library (requests, httpx, etc.). Args: auth_types: List of acceptable auth types from server. N)r!r(s r"rHzBaseDAVClient.build_auth_objects  r$)rrrr)r%rrr&N)r(r)rr) rrr2rr3rr4r5rr6)rArBr4rrr0)rErrrF)rKrrLrrr )rPrrrQ)rerfrrgNN)r}rr~rrrrr)F)r}rrr0rr)r(r)rrF)__name__ __module__ __qualname____doc__CALENDAR_HOME_SET_PROPSCALENDAR_LIST_PROPSr__annotations__rrrrrr#r r1r@rDrJrOrdr|rrrrHrr$r"rrs   RR HHD I    "&H&&&&COOOO    ****$-----^))))0         CCCC2222$6PPPPP^^^^^     ^    r$rcNeZdZdZd d fd ZedZd Zd Zd Z xZ S)CalendarCollectiona A list of calendars that can be used as a context manager. This class extends list to provide automatic cleanup of the underlying DAV client connection when used with a `with` statement. Example:: from caldav import get_calendars # As context manager (recommended) - auto-closes connection with get_calendars(url="...", username="...", password="...") as calendars: for cal in calendars: print(cal.get_display_name()) # Without context manager - must close manually calendars = get_calendars(url="...", username="...", password="...") # ... use calendars ... if calendars: calendars[0].client.close() N calendars list | Nonerlrc\t|pg||_dSr)super__init___client)r!rrl __class__s r"rzCalendarCollection.__init__&s* b))) r$c@|jr|jS|r |djSdS)z(The underlying DAV client, if available.rN)rrlr!s r"rlzCalendarCollection.client*s/ < <   "7> !tr$c|Srrrs r" __enter__zCalendarCollection.__enter__4s r$c.|dSNFcloser!exc_typeexc_valexc_tbs r"__exit__zCalendarCollection.__exit__7 ur$c|jr|jdS|r!|djdSdS)+Close the underlying DAV client connection.rN)rrrlrs r"rzCalendarCollection.close;sV < # L    # GN " " " " " # #r$r)rrrlr) rrrrrpropertyrlrrr __classcell__)rs@r"rrs,X#######r$rcfeZdZdZdddZedZedZd Zd Z d Z d Z d Z dS)CalendarResulta A single calendar result that can be used as a context manager. This wrapper holds a single Calendar (or None) and provides automatic cleanup of the underlying DAV client connection when used with a `with` statement. Example:: from caldav import get_calendar # As context manager (recommended) - auto-closes connection with get_calendar(calendar_name="Work", url="...") as calendar: if calendar: events = calendar.date_search(start=..., end=...) # Without context manager result = get_calendar(calendar_name="Work", url="...") calendar = result.calendar # or just use result directly # ... use calendar ... result.close() Nr}rrlc"||_||_dSr) _calendarr)r!r}rls r"rzCalendarResult.__init__[s! r$c|jS)z#The calendar, or None if not found.rrs r"r}zCalendarResult.calendar_s ~r$cH|jr|jS|jr |jjSdS)zThe underlying DAV client.N)rrrlrs r"rlzCalendarResult.clientds0 < <  > )>( (tr$c|jSrrrs r"rzCalendarResult.__enter__ms ~r$c.|dSrrrs r"rzCalendarResult.__exit__prr$cD|j}|r|dSdS)rN)rlr)r!rls r"rzCalendarResult.closets,   LLNNNNN  r$c|jduSrrrs r"__bool__zCalendarResult.__bool__{s~T))r$c`|jtd|dt|j|S)Nz"No calendar found, cannot access '')rrNgetattr)r!rPs r" __getattr__zCalendarResult.__getattr__~s6 > ! !Md!M!M!MNN Nt~t,,,r$r)r}rrlr) rrrrrrr}rlrrrrrrr$r"rrCs.XX***-----r$robjrrrgcf|sgSt|ttfr|gSt|S)z8Convert a string or None to a list for uniform handling.) isinstancerrQrg)rs r"_normalize_to_listrs8  #U|$$u 99r$TF client_classtype calendar_urlr calendar_namecheck_config_filer0 config_filerconfig_section testconfig environmentrP raise_errorsc  ddl} | jd fd} td|||||||d| } |  rtdt S| | jid}|st | Sg}t |}t |}|D]j}d t|vr|| }n|| }| |j id |r| |k|D]1}| |jd |id|d}|r| |2|s|s|s| |j id}|r|}t || S)a Get calendars from a CalDAV server with configuration from multiple sources. This function creates a client, connects to the server, and returns calendar objects based on the specified criteria. Configuration is read from various sources (explicit parameters, environment variables, config files). The returned CalendarCollection can be used as a context manager to ensure the underlying connection is properly closed. Args: client_class: The client class to use (DAVClient or AsyncDAVClient). calendar_url: URL(s) or ID(s) of specific calendars to fetch. Can be a string or list of strings. If the value contains '/', it's treated as a URL; otherwise as a calendar ID. calendar_name: Name(s) of specific calendars to fetch by display name. Can be a string or list of strings. check_config_file: Whether to look for config files (default: True). config_file: Explicit path to config file. config_section: Section name in config file (default: "default"). testconfig: Whether to use test server configuration. environment: Whether to read from environment variables (default: True). name: Name of test server to use (for testconfig). raise_errors: If True, raise exceptions on errors; if False, log and skip. **config_data: Connection parameters (url, username, password, etc.) Returns: CalendarCollection of Calendar objects matching the criteria. If no calendar_url or calendar_name specified, returns all calendars. Example:: from caldav import get_calendars # As context manager (recommended) with get_calendars(url="https://...", username="...", password="...") as calendars: for cal in calendars: print(cal.get_display_name()) # Without context manager - connection closed on garbage collection calendars = get_calendars(url="https://...", username="...", password="...") rNrc |di|}|td||S#t$r)}d|d|rYd}~dSd}~wwxYw)z>Try a method call, handling errors based on raise_errors flag.NzMethod returned None: z(Problems fetching calendar information: z - r) ValueError Exceptionr )methkwargserrmsgrver<rs r"_tryzget_calendars.._trys $....C{ !B&!B!BCCCJ    IIOOOAOO P P P 44444  s! AAA)rrrrrrrPz4Could not create DAV client - no configuration foundzgetting principal)rl/)cal_url)cal_idz calendar rPzcalendar by name 'rzgetting all calendarsr) logging getLogger get_davclientrr principalrrr}get_display_nameru get_calendars)rrrrrrrrrPr config_datarrrlrr calendar_urlscalendar_namesrr}cal_nameall_calsr<s ` @r"rrs+nNNN ' H % %C       !+%      F~  USTT T!###V%r+>??I 1!0000I&|44M' 66N!'' #g,,   ))')::HH )))99H 4)2/D7/D/D E E '   X & & &#''4   X  , , , ,    '   X & & & !]!>!4 /5LMM  ! I i 7 7 77r$c 8ddlm}|jd ||||||d|} | dS| dd} | dd} | dd} | dd|d i| } | | | _| | | _| | | _| S) aS Get a DAV client instance with configuration from multiple sources. This is the canonical implementation used by both sync and async clients. Configuration is read from various sources in priority order: 1. Explicit parameters (url=, username=, password=, etc.) 2. Test server config (if testconfig=True or PYTHON_CALDAV_USE_TEST_SERVER env var) 3. Environment variables (CALDAV_URL, CALDAV_USERNAME, CALDAV_PASSWORD) 4. Config file (CALDAV_CONFIG_FILE env var or ~/.config/caldav/) Args: client_class: The client class to instantiate (DAVClient or AsyncDAVClient). check_config_file: Whether to look for config files (default: True). config_file: Explicit path to config file. config_section: Section name in config file (default: "default"). testconfig: Whether to use test server configuration. environment: Whether to read from environment variables (default: True). name: Name of test server to use (for testconfig). **config_data: Explicit connection parameters passed to client constructor. Common parameters include: - url: CalDAV server URL, domain, or email address - username: Username for authentication - password: Password for authentication - ssl_verify_cert: Whether to verify SSL certificates - auth_type: Authentication type ("basic", "digest", "bearer") Returns: Client instance, or None if no configuration is found. Example (sync):: from caldav import get_davclient client = get_davclient(url="https://caldav.example.com", username="user", password="pass") Example (async):: from caldav.async_davclient import get_davclient client = await get_davclient(url="https://caldav.example.com", username="user", password="pass") r)config)rrrrrrPN_setup _teardown _server_nameprotocolr)rrget_connection_paramspopsetupteardown server_name)rrrrrrrPrr conn_params setup_func teardown_funcrrls r"rr sd/&.+%   Kt400JOOK66M//.$77KOOJ%%%\ ( (K ( (F!  '( Mr$)rrrrg) NNTNNFTNF)rrrrrrrr0rrrrrr0rr0rPrrr0rr)TNNFTN)rrrr0rrrrrr0rr0rPrrr)!r __future__rrabcrrcollections.abcrtypingrrr caldav.libr caldav.lib.authr r caldav.lib.python_utilitiesr caldav.lib.urlrcaldav.compatibility_hintsrrr<rrgrrrrrrr$r"rs#"""""##############//////////@@@@@@@@5555556555555g!!r r r r r Cr r r j1#1#1#1#1#1#1#1#h>->->->->->->->-B $ $""!%}8}8}8}8}8D#"!%UUUUUUUr$