ifddlZddlZddlmZmZmZddlmZmZddl m Z m Z m Z ddl mZddlmZddlmZdd lmZmZmZmZdd lmZdd lmZdd lmZdd lmZddlm Z!ddlm"Z#e r ddlmZ$dd lmZ%eZ&e!Z de de'de(fdZ)dZ*GddeZ+eGddeZ,dS)N) dataclassfieldreplace)Enumauto) TYPE_CHECKINGAnyOptional) TypesFactory)Searcher) Collation)CalendarObjectResourceEventJournalTodo)Calendar)cdav)error)_build_search_xml_query)_collation_to_caldav)_filter_search_results)rfeaturespropreturncddlm}|dkrdn|}d|}||jvr||S|dS)uCheck if is-not-defined search is supported for a specific property. Checks the property-specific sub-feature (e.g. search.is-not-defined.category or search.is-not-defined.dtend) if one is defined, otherwise falls back to the parent search.is-not-defined feature. The ``categories`` → ``category`` mapping exists because the feature is named after the singular form while the iCalendar property is plural. r) FeatureSet categoriescategoryzsearch.is-not-defined.zsearch.is-not-defined)compatibility_hintsrFEATURES is_supported)rrr feature_prop sub_features H/root/projects/butler/venv/lib/python3.11/site-packages/caldav/search.py_is_not_defined_supportedr& sm0/////!%!5!5::4L9<99Kj)))$$[111  !8 9 99)_property_filters_property_operator_property_locale_property_collationcveZdZdZeZeZeZeZeZ dS) SearchActionzNActions yielded by the search generator to be executed by sync/async wrappers.N) __name__ __module__ __qualname____doc__rRECURSIVE_SEARCHSEARCH_WITH_COMPTYPESREQUEST_REPORT LOAD_OBJECTRETURNr'r%r-r-<sMXXtvv DFFTVVN$&&K TVVFFFr'r-ceZdZUdZdZeded<eeZ eed<eddZ ed ed < d(d e d e de de dedzde dzddffd Z d)dee dzde ddfdZdede de deejdzde dzde dzde dzfdZ d*dede de deejdzde de deefdZ d+dede de deejdzde de de deefd Z d*dd!de de deejdzde de ded"fd#Z d+dd!de de deejdzde de de ded"fd$Z d,d%eede dzde de deef d&Zd-d'ZxZS).CalDAVSearcheraThe baseclass (which is generic, and not CalDAV-specific) allows building up a search query search logic. The base class also allows for simple client-side filtering (and at some point in the future, more complex client-side filtering). The CalDAV protocol is difficult, ambigiuous and does not offer all kind of searches. Client-side filtering may be needed to smoothen over differences in how the different servers handle search queries, as well as allowing for more complex searches. A search may be performed by first setting up a CalDAVSearcher, populate it with filter options, and then initiate the search. The recommended approach (as of 3.0) is to create the searcher from a calendar: ``searcher = calendar.searcher(event=True, start=..., end=...)`` ``searcher.add_property_filter("SUMMARY", "meeting")`` ``results = searcher.search()`` For simple searches, the direct method call still works: ``calendar.search(event=True, start=..., end=..., ...)`` The ``todo``, ``event`` and ``journal`` parameters are booleans for filtering the component type. It's currently recommended to set one and only one of them to True, as of 2025-11 there is no guarantees for correct behaviour if setting two of them. Also, if none is given (the default), all objects should be returned - however, all examples in the CalDAV RFC filters things by component, and the different servers do different things when confronted with a search missing component type. With the correct ``compatibility_hints`` (``davclient.features``) configured for the caldav server, the algorithms will ensure correct behaviour. Both the iCalendar standard and the (Cal)DAV standard defines "properties". Make sure not to confuse those. iCalendar properties used for filtering can be passed using ``searcher.add_property_filter``. Nr comp_class)default_factory_explicit_operatorsF)defaultreprr _calendarTkeyvalueoperatorcase_sensitive collationlocalerc|T|j|t||||||dSt|||||dS)a Adds a filter for some specific iCalendar property. Examples of valid iCalendar properties: SUMMARY, LOCATION, DESCRIPTION, DTSTART, STATUS, CLASS, etc :param key: iCalendar property name (e.g., SUMMARY). Special virtual property "category" (singular) is also supported for substring matching within category names :param value: Filter value, should adhere to the type defined in the RFC :param operator: Comparison operator ("contains", "==", "undef"). If not specified, the server decides the matching behavior (usually substring search per RFC). If explicitly set to "contains" and the server doesn't support substring search, client-side filtering is used (may transfer more data from server). :param case_sensitive: If False, text comparisons are case-insensitive. Note: CalDAV standard case-insensitivity only applies to ASCII characters. :param collation: Advanced collation strategy for text comparison. May not work on all servers. :param locale: Locale string (e.g., "de_DE") for locale-aware collation. Only used with collation=Collation.LOCALE. May not work on all servers. **Supported operators:** * **contains** - substring match (e.g., "rain" matches "Training session" and "Singing in the rain") * **==** - exact match required, enforced client-side * **undef** - matches if property is not defined (value parameter ignored) **Special handling for categories:** - **"categories"** (plural): Exact category name matching - "contains": subset check (all filter categories must be in component) - "==": exact set equality (same categories, order doesn't matter) - Commas in filter values split into multiple categories - **"category"** (singular): Substring matching within category names - "contains": substring match (e.g., "out" matches "outdoor") - "==": exact match to at least one category name - Commas in filter values treated as literal characters Examples: # Case-insensitive search searcher.add_property_filter("SUMMARY", "meeting", case_sensitive=False) # Explicit substring search (guaranteed via client-side if needed) searcher.add_property_filter("LOCATION", "room", operator="contains") # Exact match searcher.add_property_filter("STATUS", "CONFIRMED", operator="==") N)rCrDrE)r<addlowersuperadd_property_filter)selfr@rArBrCrDrE __class__s r%rJz"CalDAVSearcher.add_property_filterusz    $ ( ( 5 5 5 GG ' 'UHniY_ ` ` ` ` ` GG ' '-# (     r'filters_to_removeclear_all_filtersci}tD]S}|ri||< |rGt||||<|D]}|||dSTt |fi|}|r|s|jt |z |_|S)aCreate a clone of this searcher with specified property filters removed. This is used for compatibility workarounds where we need to remove certain filters from the server query and apply them client-side instead. :param filters_to_remove: List of property filter keys to remove (e.g., ["categories", "category"]) :param clear_all_filters: If True, remove all property filters :return: Cloned searcher with filters removed N)_PROPERTY_FILTER_ATTRSgetattrcopypoprr<set)rKrMrN replacementsattrr@clones r%_clone_without_filtersz%CalDAVSearcher._clone_without_filterss *  D  %' T""" %,T4%8%8%=%=%?%? T",66C &**355556-- --  Z%6 Z(,(@3GXCYCY(YE % r'calendar server_expandsplit_expandedpropsxml post_filter_hacksc #PKjtdjjdt }jsjsjsj o |dko|du} | r|sd}d}|gjrj rWj sPdj vsGd j vs>jjd rjjd sd}j s|sd}j rB|s@jjd s!jjd rd}j s|r"j rjstjdjjdsj r~|durzdjD} | rU| } t(j| ||||ddffV} t(j| |||fVdSjjdsmdj vs d j vr[|durWdd g} t(j| ||||ddffV} t(j| |||fVdS|dur}fdjD} | rV| } t(j| ||||ddffV} t(j| d||fVdSjjdso|durkfdjD}|rV|} t(j| ||||ddffV} t(j| d||fVdSjjdskj sjr]j rVd} t(j| ||||ddffV} t(j| |||fVdSjrCj dur9t1d} d| _ d| _ | sjjdrjjdrsjjdrjjdr5g}dD]/}t(j| |d||d|ffV}||0nt(j| |d||d|ffV}g} t5}|D]:}|j|vr/||j| |;n|}|r/t=|t s;|j ds!!||||\}_jsVjjds7j d_ t(j"||||||ffV}t(j|fVdS t(j#|j|ffV\}} nf#tj$rT}jjj$r=js6d|j%vr-t(j"||||||ffV}t(j|fVYd}~dSd}~wwxYw| s6js/|d kr)t(j"||||||ffV}t(j|fVdS| s|d krj rzd!jD}|rU|} t(j| ||||ddffV}t(j||||fVdSg}| D]N} t(j&|fV||)#tN$rtQjd"d#YKwxYw|} d$| D} | |||} | D]#} t(j&|fV#tN$rY wxYwt(j)| fVdS)%aNCore search implementation as a generator yielding actions. This generator contains all the search logic and yields (action, data) tuples that the caller (sync or async) executes. Results are sent back via .send(). Yields: Tuples of (SearchAction, data) where data depends on action type NzgNo calendar provided. Either pass a calendar to search() or create the searcher via calendar.searcher()zsearch.comp-typebrokenFno_comp_filterTrrzsearch.text.case-sensitivezsearch.time-range.accuratez%save-load.event.recurrences.exceptionz%search.recurrences.expanded.exceptionz!can't expand without a date rangez search.textc$g|] \}}|dk |Sundefr7.0rops r% z/CalDAVSearcher._search_impl..+s(!!!!rg  r'zsearch.text.categorycZg|]'\}}|dk tjj|%|(Srd)r&clientr)rgrrhrYs r%riz/CalDAVSearcher._search_impl..OsC+++D"==)B8?C[]a)b)b= ==r')r^r[rZzsearch.text.substringcHg|]}|jv j|dk|S)contains)r<r))rgrrKs r%riz/CalDAVSearcher._search_impl..jsE!!!43338OPT8UYc8c8c8c8c8cr'zsearch.combined-is-logical-and)rN)include_completedz)search.recurrences.includes-implicit.todoz1search.recurrences.includes-implicit.todo.pending)ignore_completed1ignore_completed2ignore_completed3calendar-query)r\filtersr_zsearch.comp-type-optional400insistc$g|] \}}|dk |Srdr7rfs r%riz/CalDAVSearcher._search_impl..s)%%%%T2BRYMMDMMMr'z@Server does not want to reveal details about the calendar object)exc_infoc:g|]}||Sr7) has_component)rgos r%riz/CalDAVSearcher._search_impl..6s';;;):):;1;;;r')*r? ValueErrorrkrr"strr:todoeventjournalrnexpandr(startendr ReportErrorr)itemsrXr-r2r6filterrextendrTurlrGappend isinstancetagendswithbuild_search_xml_queryr3r4backward_compatibility_modereasonr5 Exceptionloggingsort)rKrYrZr[r\r]r^r_comp_type_supportrbtext_filter_propsrWobjectsundef_props_without_supportexplicit_containsmatcheshacksresult match_setitemorig_xmlresponseerrnon_undef_filtersobj2rzobjs`` r% _search_implzCalDAVSearcher._search_impls $  ~H  >  %O4AABTVYZZ _ G GTZ G4< )!X- )5(    *)K   Y #5 { t555T333?+889UVV4?+889UVV4K{ #= #"N K !! !O,99:abb !(556]^^  ! !M ; M- M: MTX M'(KLLL (55mDD & 5((!!%)%<%B%B%D%D!!! ! 334EFF 1Hm^UCQUW[\! !'KKnmTT (556LMM !777:I_;_;_5((//z0JKKE--TSWXG # G[.-PP    F e # #++++ $ 7 = = ? ?+++ ' + 334OPP 1Hm^UCQUW[\! !'KK$('5&3  (556MNN 5((!!!! 3!!!  ! 334EFF 1Hm^UCQUW[\! !'KK$('5&3  '445UVV z TX )  77$7OOE$5-PSUY[_`%G %+ G[.-XXF> 9y /588DD999E&*E # EL# O,99-HH O,99:Z[[  !0==C   /<<K \++E$5-sDRWX$FNN6**** +!1HmUE3fU! GI ) )89,,MM$(+++NN4((( ) H z#s33 CG%)##0422!22 2 D%&- 2  22 + ,2222n$#04 ""!"" " D%&- "  """ + ,""""B$(##   ,- D[     $ %     4!!!!!!!!r'r9)-rr dataclassesrrrenumrrtypingrr r icalendar.propr icalendar_searcherr icalendar_searcher.collationr calendarobjectresourcerrrr collectionrelementsrlibroperations.search_opsrrcollation_to_caldavrrrr_icalendar_typesr|rr&rPr-r9r7r'r%rs$1111111111//////////''''''''''''222222PPPPPPPPPPPP ::::::NNNNNNRRRRRR6655555<>>+::3:4::::(4 f !f !f !f !f !Xf !f ! f !f !f !r'