def date_search(client, calendar, start, end=None):
"""
Perform a time-interval search in the `calendar`.
"""
rc = []
# build the request
expand = cdav.Expand(start, end)
data = cdav.CalendarData() + expand
prop = dav.Prop() + data
range = cdav.TimeRange(start, end)
vevent = cdav.CompFilter("VEVENT") + range
vcal = cdav.CompFilter("VCALENDAR") + vevent
filter = cdav.Filter() + vcal
root = cdav.CalendarQuery() + [prop, filter]
q = etree.tostring(root.xmlelement(),
encoding="utf-8",
xml_declaration=True)
response = client.report(calendar.url.path, q, 1)
for r in response.tree.findall(".//" + dav.Response.tag):
status = r.find(".//" + dav.Status.tag)
if status.text.endswith("200 OK"):
href = r.find(dav.Href.tag).text
data = r.find(".//" + cdav.CalendarData.tag).text
rc.append((url.make(calendar.url, href), data))
else:
raise error.ReportError(r.raw)
return rc
def date_search(self, start, end=None, compfilter="VEVENT", expand="maybe"):
# type (TimeStamp, TimeStamp, str, str) -> CalendarObjectResource
"""
Search events by date in the calendar. Recurring events are
expanded if they are occuring during the specified time frame
and if an end timestamp is given.
Parameters:
* start = datetime.today().
* end = same as above.
* compfilter = defaults to events only. Set to None to fetch all
calendar components.
* expand - should recurrent events be expanded? (to preserve
backward-compatibility the default "maybe" will be changed into True
unless the date_search is open-ended)
Returns:
* [CalendarObjectResource(), ...]
"""
matches = []
# build the request
## for backward compatibility - expand should be false
## in an open-ended date search, otherwise true
if expand == 'maybe':
expand = end
# Some servers will raise an error if we send the expand flag
# but don't set any end-date - expand doesn't make much sense
# if we have one recurring event describing an indefinite
# series of events. I think it's appropriate to raise an error
# in this case.
if not end and expand:
raise error.ReportError("an open-ended date search cannot be expanded")
elif expand:
data = cdav.CalendarData() + cdav.Expand(start, end)
else:
data = cdav.CalendarData()
prop = dav.Prop() + data
query = cdav.TimeRange(start, end)
if compfilter:
query = cdav.CompFilter(compfilter) + query
vcalendar = cdav.CompFilter("VCALENDAR") + query
filter = cdav.Filter() + vcalendar
root = cdav.CalendarQuery() + [prop, filter]
response = self._query(root, 1, 'report')
results = self._handle_prop_response(
response=response, props=[cdav.CalendarData()])
for r in results:
matches.append(
Event(self.client, url=self.url.join(r),
data=results[r][cdav.CalendarData.tag], parent=self))
return matches
def date_search(self, start, end=None, compfilter="VEVENT"):
"""
Search events by date in the calendar. Recurring events are
expanded if they are occuring during the specified time frame
and if an end timestamp is given.
Parameters:
* start = datetime.today().
* end = same as above.
* compfilter = defaults to events only. Set to None to fetch all
calendar components.
Returns:
* [CalendarObjectResource(), ...]
"""
matches = []
# build the request
# Some servers will raise an error if we send the expand flag
# but don't set any end-date - expand doesn't make much sense
# if we have one recurring event describing an indefinite
# series of events. Hence, if the end date is not set, we
# skip asking for expanded events.
if end:
data = cdav.CalendarData() + cdav.Expand(start, end)
else:
data = cdav.CalendarData()
prop = dav.Prop() + data
query = cdav.TimeRange(start, end)
if compfilter:
query = cdav.CompFilter(compfilter) + query
vcalendar = cdav.CompFilter("VCALENDAR") + query
filter = cdav.Filter() + vcalendar
root = cdav.CalendarQuery() + [prop, filter]
response = self._query(root, 1, 'report')
results = self._handle_prop_response(response=response,
props=[cdav.CalendarData()])
for r in results:
matches.append(
Event(self.client,
url=self.url.join(r),
data=results[r][cdav.CalendarData.tag],
parent=self))
return matches
def freebusy_request(self, start, end):
"""
Search the calendar, but return only the free/busy information.
Parameters:
* start = datetime.today().
* end = same as above.
Returns:
* [FreeBusy(), ...]
"""
root = cdav.FreeBusyQuery() + [cdav.TimeRange(start, end)]
response = self._query(root, 1, 'report')
return FreeBusy(self, response.raw)
def date_search(self, start, end=None):
"""
Search events by date in the calendar. Recurring events are expanded
if they have an occurence during the specified time frame.
Parameters:
* start = datetime.today().
* end = same as above.
Returns:
* [Event(), ...]
"""
matches = []
# build the request
expand = cdav.Expand(start, end)
data = cdav.CalendarData() + expand
prop = dav.Prop() + data
range = cdav.TimeRange(start, end)
vevent = cdav.CompFilter("VEVENT") + range
vcalendar = cdav.CompFilter("VCALENDAR") + vevent
filter = cdav.Filter() + vcalendar
root = cdav.CalendarQuery() + [prop, filter]
q = etree.tostring(root.xmlelement(), encoding="utf-8",
xml_declaration=True)
response = self.client.report(self.url, q, 1)
for r in response.tree.findall(".//" + dav.Response.tag):
status = r.find(".//" + dav.Status.tag)
if status.text.endswith("200 OK"):
href = URL.objectify(r.find(dav.Href.tag).text)
href = self.url.join(href)
data = r.find(".//" + cdav.CalendarData.tag).text
e = Event(self.client, url=href, data=data, parent=self)
matches.append(e)
else:
raise error.ReportError(response.raw)
return matches
def build_date_search_query(self,
start,
end=None,
compfilter="VEVENT",
expand="maybe"):
"""
Split out from the date_search-method below. The idea is that
maybe the generated query can be amended, i.e. to filter out
by category etc. To be followed up in
https://github.com/python-caldav/caldav/issues/16
"""
## for backward compatibility - expand should be false
## in an open-ended date search, otherwise true
if expand == 'maybe':
expand = end
# Some servers will raise an error if we send the expand flag
# but don't set any end-date - expand doesn't make much sense
# if we have one recurring event describing an indefinite
# series of events. I think it's appropriate to raise an error
# in this case.
if not end and expand:
raise error.ReportError(
"an open-ended date search cannot be expanded")
elif expand:
data = cdav.CalendarData() + cdav.Expand(start, end)
else:
data = cdav.CalendarData()
prop = dav.Prop() + data
query = cdav.TimeRange(start, end)
if compfilter:
query = cdav.CompFilter(compfilter) + query
vcalendar = cdav.CompFilter("VCALENDAR") + query
filter = cdav.Filter() + vcalendar
root = cdav.CalendarQuery() + [prop, filter]
return root
