#include "webcit.h"
-#define CAL "urn:ietf:params:xml:ns:caldav:" // Shorthand for the XML namespace of CalDAV
-#define CALLEN sizeof(CAL)-1 // And the length of that string
+#define CALDAV "urn:ietf:params:xml:ns:caldav:" // Shorthand for the XML namespace of CalDAV
+#define CALDAVLEN sizeof(CALDAV)-1 // And the length of that string
+
+const char *the_beginning_of_time = "19010101T010101Z";
+const char *the_end_of_time = "99991231T235959Z";
// A CalDAV REPORT can only be one type. This is stored in the report_type member.
enum cr_type {
cr_freebusy_query
};
-
// Data type for CalDAV Report Parameters.
// As we slog our way through the XML we learn what the client is asking for
// and build up the contents of this data type.
StrBuf *Hrefs; // list of items requested by a `calendar-multiget` REPORT
Array *filters; // If the query contains a FILTER stanza, the filter criteria are populated here
int filter_nest; // tag nesting level where a FILTER stanza begins
+ int in_prop; // nonzero if we are within the parsing a <DAV::prop> stanza?
+ int yes_getetag; // nonzero if client has requested the "getetag" property
+ int yes_calendar_data; // nonzero if client has requested the "calendar-data" property
};
// end logging
#endif
+ // if we are already within a webdav prop stanza, child nodes name properties the client wants to receive.
+ if (crp->in_prop) {
+ syslog(LOG_DEBUG, "\033[41m\033[37m\033[1mprop:%s\033[0m", el);
+
+ if (!strcasecmp(el, "DAV::getetag")) {
+ crp->yes_getetag = 1;
+ }
+ else if (!strcasecmp(el, CALDAV"calendar-data")) {
+ crp->yes_calendar_data = 1;
+ }
+
+ return;
+ }
+
+ // webdav prop (not caldav "prop") element
+ if (!strcasecmp(el, "DAV::prop")) {
+ ++crp->in_prop;
+ syslog(LOG_DEBUG, "\033[41m\033[37m\033[1mprop:%d\033[0m", crp->in_prop);
+ }
+
+ // webdav allprop (not caldav "allprop") element
+ if (!strcasecmp(el, "DAV::allprop")) {
+ crp->yes_getetag = 1;
+ crp->yes_calendar_data = 1;
+ }
+
// RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
- if (!strcasecmp(el, CAL"calendar-query")) {
+ if (!strcasecmp(el, CALDAV"calendar-query")) {
crp->report_type = cr_calendar_query;
}
// RFC4791 7.9 "calendar-multiget" REPORT - Client will supply a list of specific hrefs.
- else if (!strcasecmp(el, CAL"calendar-multiget")) {
+ else if (!strcasecmp(el, CALDAV"calendar-multiget")) {
crp->report_type = cr_calendar_multiget;
}
// RFC4791 7.10 "free-busy-query" REPORT
- else if (!strcasecmp(el, CAL"free-busy-query")) {
+ else if (!strcasecmp(el, CALDAV"free-busy-query")) {
crp->report_type = cr_freebusy_query;
}
// RFC4791 9.7 create a filter array if this query contains a "filter" stanza
- else if (!strcasecmp(el, CAL"filter")) {
+ else if (!strcasecmp(el, CALDAV"filter")) {
crp->filters = array_new(SIZ);
crp->filter_nest = crp->comp_filter_nesting_level;
}
// Handle the filters defined in RFC4791 9.7.1 through 9.7.5
- else if ( ( (!strcasecmp(el, CAL"comp-filter"))
- || (!strcasecmp(el, CAL"prop-filter"))
- || (!strcasecmp(el, CAL"param-filter"))
- || (!strcasecmp(el, CAL"is-not-defined"))
- || (!strcasecmp(el, CAL"text-match"))
- || (!strcasecmp(el, CAL"time-range"))
+ else if ( ( (!strcasecmp(el, CALDAV"comp-filter"))
+ || (!strcasecmp(el, CALDAV"prop-filter"))
+ || (!strcasecmp(el, CALDAV"param-filter"))
+ || (!strcasecmp(el, CALDAV"is-not-defined"))
+ || (!strcasecmp(el, CALDAV"text-match"))
+ || (!strcasecmp(el, CALDAV"time-range"))
)
&& (crp->filters) // Make sure we actually allocated an array
) {
- if (!strcasecmp(el, CAL"comp-filter")) {
+ if (!strcasecmp(el, CALDAV"comp-filter")) {
++crp->comp_filter_nesting_level;
}
char newfilter[SIZ];
int a = 0;
int len = snprintf(newfilter, SIZ, "%d|", crp->comp_filter_nesting_level - crp->filter_nest - 1);
- len += snprintf(&newfilter[len], SIZ-len, "%s", &el[CALLEN]); // filter name without the namespace
+ len += snprintf(&newfilter[len], SIZ-len, "%s", &el[CALDAVLEN]); // filter name without the namespace
while (attr[a]) {
len += snprintf(&newfilter[len], SIZ-len, "|%s", attr[a++]); // now save the attributes
}
array_append(crp->filters, newfilter);
}
-
}
// end logging
#endif
- if (!strcasecmp(el, CAL"comp-filter")) {
- --crp->comp_filter_nesting_level;
+ // webdav prop (not caldav "prop") filter
+ if (!strcasecmp(el, "DAV::prop")) {
+ --crp->in_prop;
+ syslog(LOG_DEBUG, "\033[41m\033[37m\033[1mprop:%d\033[0m", crp->in_prop);
}
+ if (!strcasecmp(el, CALDAV"comp-filter")) {
+ --crp->comp_filter_nesting_level;
+ }
if ((!strcasecmp(el, "DAV::href")) || (!strcasecmp(el, "DAV:href"))) {
if (crp->Hrefs == NULL) { // append crp->Chardata to crp->Hrefs
// Called by multiple REPORT types to actually perform the output in "multiget" format.
// We need to already know the source message number and the href, but also already have the output data.
-void cal_multiget_out(long msgnum, StrBuf *ThisHref, StrBuf *Caldata, StrBuf *ReportOut) {
+void cal_multiget_out(long msgnum, StrBuf *ThisHref, StrBuf *Caldata, StrBuf *ReportOut, struct cr_params *crp) {
StrBufAppendPrintf(ReportOut, "<D:response>");
StrBufAppendPrintf(ReportOut, "<D:href>");
StrBufAppendPrintf(ReportOut, "HTTP/1.1 200 OK");
StrBufAppendPrintf(ReportOut, "</D:status>");
StrBufAppendPrintf(ReportOut, "<D:prop>");
- StrBufAppendPrintf(ReportOut, "<D:getetag>");
- StrBufAppendPrintf(ReportOut, "%ld", msgnum);
- StrBufAppendPrintf(ReportOut, "</D:getetag>");
- StrBufAppendPrintf(ReportOut, "<C:calendar-data>");
- StrBufXMLEscAppend(ReportOut, Caldata, NULL, 0, 0);
- StrBufAppendPrintf(ReportOut, "</C:calendar-data>");
+
+ if (crp->yes_getetag) {
+ StrBufAppendPrintf(ReportOut, "<D:getetag>");
+ StrBufAppendPrintf(ReportOut, "%ld", msgnum);
+ StrBufAppendPrintf(ReportOut, "</D:getetag>");
+ }
+
+ if (crp->yes_calendar_data) {
+ StrBufAppendPrintf(ReportOut, "<C:calendar-data>");
+ StrBufXMLEscAppend(ReportOut, Caldata, NULL, 0, 0);
+ StrBufAppendPrintf(ReportOut, "</C:calendar-data>");
+ }
+
StrBufAppendPrintf(ReportOut, "</D:prop>");
}
else {
// Called by caldav_report() to output a single item.
// Our policy is to throw away the list of properties the client asked for, and just send everything.
-void caldav_report_one_item(struct http_transaction *h, struct ctdlsession *c, StrBuf *ReportOut, StrBuf *ThisHref) {
+void caldav_report_one_item(struct http_transaction *h, struct ctdlsession *c, StrBuf *ReportOut, StrBuf *ThisHref, struct cr_params *crp) {
long msgnum;
StrBuf *Caldata = NULL;
char *euid;
Caldata = NULL;
}
- cal_multiget_out(msgnum, ThisHref, Caldata, ReportOut);
+ cal_multiget_out(msgnum, ThisHref, Caldata, ReportOut, crp);
if (Caldata != NULL) {
FreeStrBuf(&Caldata);
}
+// Compare function for "time-range" tests (RFC4791 section 9.9)
+// Returns nonzero if the supplied icalcomponent occurs within the specified time range
+//
+// IMPLEMENTATION NOTE:
+// ical_ctdl_is_overlap() works because icaltime_compare() is really smart.
+// It looks at the time zone of the dtstart/dtend and can apparently go back up the icalcomponent
+// hierarchy to find its time zone data. I tested this by creating an event with a fictional
+// time zone and it did the right thing. It even showed the fictional name to me. This saves us
+// from having to convert everything to UTC before comparing. Nice!
+//
+int caldav_time_range_filter_matches(icalcomponent *cal, char *start_str, char *end_str) {
+
+ struct icaltimetype search_start = icaltime_from_string(start_str); // time range being searched
+ struct icaltimetype search_end = icaltime_from_string(end_str);
+
+ struct icaltimetype dtstart = icalcomponent_get_dtstart(cal); // time of event
+ struct icaltimetype dtend = icalcomponent_get_dtend(cal);
+ if (icaltime_is_null_time(dtend)) {
+ dtend = dtstart;
+ }
+
+ // If it is a recurring event, RRULE is available at this level. We can handle it here.
+ icalproperty *rrule = icalcomponent_get_first_property(cal, ICAL_RRULE_PROPERTY);
+ if (rrule) {
+ struct icaldurationtype dur = icaltime_subtract(dtend, dtstart); // recurrences need duration to find dtend
+ struct icalrecurrencetype recur = icalproperty_get_rrule(rrule);
+ icalrecur_iterator *ritr = icalrecur_iterator_new(recur, dtstart); // iterate through recurrences
+ while (dtstart = icalrecur_iterator_next(ritr), !icaltime_is_null_time(dtstart)) {
+ dtend = icaltime_add(dtstart, dur);
+
+ // Does THIS recurrence match the query? If so, free the memory we used and stop iterating.
+ if (ical_ctdl_is_overlap(dtstart, dtend, search_start, search_end)) {
+ icalrecur_iterator_free(ritr);
+ return(1);
+ }
+ }
+
+ icalrecur_iterator_free(ritr);
+ return(0); // compared all recurrences, no match was found for any of them
+ }
+
+ // For non recurring events, do a simple time range compare.
+ return(ical_ctdl_is_overlap(dtstart, dtend, search_start, search_end)); // We have a convenience function for this.
+}
+
+
// Recursive function to apply CalDAV FILTERS to a calendar item.
// Returns zero if the calendar item was disqualified by a filter, nonzero if the calendar item still qualifies.
int caldav_apply_filters(void *cal, Array *filters, int apply_at_level) {
- int f = 0; // filter number iterator
- int qual = 1; // 0 for disqualify, 1 for qualify
+ int f = 0; // filter number iterator
+ int qual = 1; // 0 for disqualify, 1 for qualify
int previous_level = -1;
int disregard_further_comp_filters = 0;
++num_tokens;
}
int this_rule_level = atoi(t[0]);
- syslog(LOG_DEBUG, "caldav_apply_filters() filter=%d, level=%d, <%s>", f, this_rule_level, array_get_element_at(filters, f) );
+ // syslog(LOG_DEBUG, "caldav_apply_filters() filter=%d, level=%d, <%s>", f, this_rule_level, array_get_element_at(filters, f) );
// Handle the individual filters defined in RFC4791 9.7.1 through 9.7.5
if (apply_at_level < previous_level) {
- syslog(LOG_DEBUG, "caldav: walking back down");
+ // syslog(LOG_DEBUG, "caldav: walking back down");
return(qual);
}
else if (this_rule_level != apply_at_level) {
- syslog(LOG_DEBUG, "caldav: apply_at_level=%d, this_rule_level=%d, skipping this rule", apply_at_level, this_rule_level);
+ // syslog(LOG_DEBUG, "caldav: apply_at_level=%d, this_rule_level=%d, skipping this rule", apply_at_level, this_rule_level);
}
else if ( (!strcasecmp(t[1], "comp-filter")) // RFC4791 9.7.1 - filter by component
&& (!disregard_further_comp_filters) // one is enough to succeed
) {
- syslog(LOG_DEBUG, "component filter at level %d", this_rule_level);
+ // syslog(LOG_DEBUG, "component filter at level %d", this_rule_level);
// comp-filter requires exactly one parameter (name="VXXXX")
if (num_tokens < 4) {
&& (!strcasecmp(t[2], "name"))
) {
if (icalcomponent_isa(cal) == icalcomponent_string_to_kind(t[3]) ) {
- syslog(LOG_DEBUG, "caldav: component at level %d is <%s>, looking for <%s>, recursing...",
- apply_at_level,
- icalcomponent_kind_to_string(icalcomponent_isa(cal)), t[3]
- );
+ // syslog(LOG_DEBUG, "caldav: component at level %d is <%s>, looking for <%s>, recursing...",
+ //apply_at_level,
+ //icalcomponent_kind_to_string(icalcomponent_isa(cal)), t[3]
+ //);
// We have a match. Drill down into the subcomponents.
}
else {
- syslog(LOG_DEBUG, "caldav: component at level %d is <%s>, looking for <%s>, rejecting",
- apply_at_level,
- icalcomponent_kind_to_string(icalcomponent_isa(cal)),
- t[3]
- );
+ //syslog(LOG_DEBUG, "caldav: component at level %d is <%s>, looking for <%s>, rejecting",
+ //apply_at_level,
+ //icalcomponent_kind_to_string(icalcomponent_isa(cal)),
+ //t[3]
+ //);
return(0);
}
}
syslog(LOG_DEBUG, "text match filter at level %d FIXME not implemented yet", this_rule_level);
}
- else if (!strcasecmp(t[1], "time-range")) {
- syslog(LOG_DEBUG, "time range filter at level %d FIXME not implemented yet", this_rule_level);
- for (int i=0; i<num_tokens; ++i) {
- syslog(LOG_DEBUG, "token %2d : <%s>", i, t[i]);
+ else if (!strcasecmp(t[1], "time-range")) { // RFC4791 9.9
+ syslog(LOG_DEBUG, "time range filter at level %d", this_rule_level);
+ char *tr_start = (char *)the_beginning_of_time; // default if not specified
+ char *tr_end = (char *)the_end_of_time; // default if not specified
+ for (int i=2; (i+1)<num_tokens; i+=2) {
+ if (!strcasecmp(t[i], "start")) {
+ tr_start = t[i+1];
+ }
+ else if (!strcasecmp(t[i], "end")) {
+ tr_end = t[i+1];
+ }
+ }
+ if (caldav_time_range_filter_matches(cal, tr_start, tr_end)) {
+ syslog(LOG_DEBUG, "time range matches");
+ }
+ else {
+ syslog(LOG_DEBUG, "time range does not match -- rejecting");
+ qual = 0;
}
}
++f;
}
- syslog(LOG_DEBUG, "caldav: we reached the end of level %d , returning %d", apply_at_level, qual);
+ // syslog(LOG_DEBUG, "caldav: we reached the end of level %d , returning %d", apply_at_level, qual);
return(qual);
}
StrBuf *ReportOut = NewStrBuf();
StrBufAppendPrintf(ReportOut,
"<?xml version=\"1.0\" encoding=\"utf-8\"?>"
- "<D:multistatus "
- "xmlns:D=\"DAV:\" "
- "xmlns:C=\"urn:ietf:params:xml:ns:caldav\""
- ">"
+ "<D:multistatus xmlns:D=\"DAV:\" xmlns:C=\"urn:ietf:params:xml:ns:caldav\">"
);
// RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
StrBuf *one_item = fetch_ical(c, m);
icalcomponent *cal = icalcomponent_new_from_string(ChrPtr(one_item));
- // Does this calendar item qualify for output?
- int qualify = 1;
-
- // If there was a filter stanza, run this calendar item through the filters.
- syslog(LOG_DEBUG, "Evaluating message \033[33m%ld\033[0m...", m);
- qualify = caldav_apply_filters(cal, crp.filters, 0);
- syslog(LOG_DEBUG, "Message %ld %s\033[0m qualify", m, (qualify ? "\033[32mDOES" : "\033[31mDOES NOT"));
- syslog(LOG_DEBUG, "");
+ // Does this calendar item qualify for output? Run this calendar item through the filters.
+ // syslog(LOG_DEBUG, "Evaluating message \033[33m%ld\033[0m...", m);
+ if (caldav_apply_filters(cal, crp.filters, 0)) {
+ syslog(LOG_DEBUG, "Message %ld \033[32mQUALIFIES\033[0m", m);
- // Did this calendar item match the query? If so, output it.
- if (qualify) {
// FIXME need to populate the Href instead of NULL
- cal_multiget_out(m, NULL, one_item, ReportOut);
+ StrBuf *FIXME = NewStrBufPlain(HKEY("https://FIX.ME.COM/WOW/EEK"));
+ cal_multiget_out(m, FIXME, one_item, ReportOut, &crp);
+
+ }
+ else {
+ syslog(LOG_DEBUG, "Message %ld \033[31mDOES NOT QUALIFY\033[0m", m);
}
+ // syslog(LOG_DEBUG, "");
icalcomponent_free(cal);
FreeStrBuf(&one_item);
const char *pvset = NULL;
while (StrBufExtract_NextToken(ThisHref, crp.Hrefs, &pvset, '|') >= 0) {
StrBufTrim(ThisHref); // remove leading/trailing whitespace from the href
- caldav_report_one_item(h, c, ReportOut, ThisHref);
+ caldav_report_one_item(h, c, ReportOut, ThisHref, &crp);
}
FreeStrBuf(&ThisHref);
}
projects / citadel.git / blobdiff