Asterisk - The Open Source Telephony Project  21.4.1
res_calendar_caldav.c
Go to the documentation of this file.
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2008 - 2009, Digium, Inc.
5  *
6  * Terry Wilson <twilson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18 
19 /*! \file
20  * \brief Resource for handling CalDAV calendars
21  */
22 
23 /*** MODULEINFO
24  <depend>res_calendar</depend>
25  <depend>neon</depend>
26  <depend>ical</depend>
27  <depend>libxml2</depend>
28  <support_level>extended</support_level>
29 ***/
30 
31 #include "asterisk.h"
32 
33 #include <libical/ical.h>
34 #include <ne_session.h>
35 #include <ne_uri.h>
36 #include <ne_request.h>
37 #include <ne_auth.h>
38 #include <ne_redirect.h>
39 #include <libxml/xmlreader.h>
40 
41 #include "asterisk/module.h"
42 #include "asterisk/channel.h"
43 #include "asterisk/calendar.h"
44 #include "asterisk/lock.h"
45 #include "asterisk/config.h"
46 #include "asterisk/astobj2.h"
47 
48 static void *caldav_load_calendar(void *data);
49 static void *unref_caldav(void *obj);
50 static int caldav_write_event(struct ast_calendar_event *event);
51 
52 static struct ast_calendar_tech caldav_tech = {
53  .type = "caldav",
54  .description = "CalDAV calendars",
55  .module = AST_MODULE,
56  .load_calendar = caldav_load_calendar,
57  .unref_calendar = unref_caldav,
58  .write_event = caldav_write_event,
59 };
60 
61 struct caldav_pvt {
63  AST_STRING_FIELD(url);
65  AST_STRING_FIELD(secret);
66  );
67  struct ast_calendar *owner;
68  ne_uri uri;
69  ne_session *session;
70  struct ao2_container *events;
71 };
72 
73 static void caldav_destructor(void *obj)
74 {
75  struct caldav_pvt *pvt = obj;
76 
77  ast_debug(1, "Destroying pvt for CalDAV calendar %s\n", pvt->owner->name);
78  if (pvt->session) {
79  ne_session_destroy(pvt->session);
80  }
81  ne_uri_free(&pvt->uri);
83 
84  ao2_callback(pvt->events, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL);
85 
86  ao2_ref(pvt->events, -1);
87 }
88 
89 static void *unref_caldav(void *obj)
90 {
91  struct caldav_pvt *pvt = obj;
92 
93  ao2_ref(pvt, -1);
94  return NULL;
95 }
96 
97 static int fetch_response_reader(void *data, const char *block, size_t len)
98 {
99  struct ast_str **response = data;
100  unsigned char *tmp;
101 
102  if (!(tmp = ast_malloc(len + 1))) {
103  return -1;
104  }
105  memcpy(tmp, block, len);
106  tmp[len] = '\0';
107  ast_str_append(response, 0, "%s", tmp);
108  ast_free(tmp);
109 
110  return 0;
111 }
112 
113 static int auth_credentials(void *userdata, const char *realm, int attempts, char *username, char *secret)
114 {
115  struct caldav_pvt *pvt = userdata;
116 
117  if (attempts > 1) {
118  ast_log(LOG_WARNING, "Invalid username or password for CalDAV calendar '%s'\n", pvt->owner->name);
119  return -1;
120  }
121 
122  ne_strnzcpy(username, pvt->user, NE_ABUFSIZ);
123  ne_strnzcpy(secret, pvt->secret, NE_ABUFSIZ);
124 
125  return 0;
126 }
127 
128 static int debug_response_handler(void *userdata, ne_request *req, const ne_status *st)
129 {
130  if (st->code < 200 || st->code > 299) {
131  if (st->code == 401) {
132  ast_debug(1, "Got a 401 from the server but we expect this to happen when authenticating, %d: %s\n", st->code, st->reason_phrase);
133  } else {
134  ast_debug(1, "Unexpected response from server, %d: %s\n", st->code, st->reason_phrase);
135  }
136  return 0;
137  }
138  return 1;
139 }
140 
141 static struct ast_str *caldav_request(struct caldav_pvt *pvt, const char *method, struct ast_str *req_body, struct ast_str *subdir, const char *content_type)
142 {
143  struct ast_str *response;
144  ne_request *req;
145  int ret;
146  char buf[1000];
147 
148  if (!pvt) {
149  ast_log(LOG_ERROR, "There is no private!\n");
150  return NULL;
151  }
152 
153  if (!(response = ast_str_create(512))) {
154  ast_log(LOG_ERROR, "Could not allocate memory for response.\n");
155  return NULL;
156  }
157 
158  snprintf(buf, sizeof(buf), "%s%s", pvt->uri.path, subdir ? ast_str_buffer(subdir) : "");
159 
160  req = ne_request_create(pvt->session, method, buf);
161  ne_add_response_body_reader(req, debug_response_handler, fetch_response_reader, &response);
162  ne_set_request_body_buffer(req, ast_str_buffer(req_body), ast_str_strlen(req_body));
163  ne_add_request_header(req, "Content-type", ast_strlen_zero(content_type) ? "text/xml" : content_type);
164  ne_add_request_header(req, "Depth", "1");
165 
166  ret = ne_request_dispatch(req);
167  ne_request_destroy(req);
168 
169  if (ret != NE_OK) {
170  ast_log(LOG_WARNING, "Unknown response to CalDAV calendar %s, request %s to %s: %s\n", pvt->owner->name, method, buf, ne_get_error(pvt->session));
171  ast_free(response);
172  return NULL;
173  }
174 
175  return response;
176 }
177 
178 static int caldav_write_event(struct ast_calendar_event *event)
179 {
180  struct caldav_pvt *pvt;
181  struct ast_str *body = NULL, *response = NULL, *subdir = NULL;
182  icalcomponent *calendar, *icalevent;
183  icaltimezone *utc = icaltimezone_get_utc_timezone();
184  int ret = -1;
185 
186  if (!event) {
187  ast_log(LOG_WARNING, "No event passed!\n");
188  return -1;
189  }
190 
191  if (!(event->start && event->end)) {
192  ast_log(LOG_WARNING, "The event must contain a start and an end\n");
193  return -1;
194  }
195  if (!(body = ast_str_create(512)) ||
196  !(subdir = ast_str_create(32))) {
197  ast_log(LOG_ERROR, "Could not allocate memory for request!\n");
198  goto write_cleanup;
199  }
200 
201  pvt = event->owner->tech_pvt;
202 
203  if (ast_strlen_zero(event->uid)) {
204  unsigned short val[8];
205  int x;
206  for (x = 0; x < 8; x++) {
207  val[x] = ast_random();
208  }
209  ast_string_field_build(event, uid, "%04x%04x-%04x-%04x-%04x-%04x%04x%04x",
210  (unsigned)val[0], (unsigned)val[1], (unsigned)val[2],
211  (unsigned)val[3], (unsigned)val[4], (unsigned)val[5],
212  (unsigned)val[6], (unsigned)val[7]);
213  }
214 
215  calendar = icalcomponent_new(ICAL_VCALENDAR_COMPONENT);
216  icalcomponent_add_property(calendar, icalproperty_new_version("2.0"));
217  icalcomponent_add_property(calendar, icalproperty_new_prodid("-//Digium, Inc.//res_caldav//EN"));
218 
219  icalevent = icalcomponent_new(ICAL_VEVENT_COMPONENT);
220  icalcomponent_add_property(icalevent, icalproperty_new_dtstamp(icaltime_current_time_with_zone(utc)));
221  icalcomponent_add_property(icalevent, icalproperty_new_uid(event->uid));
222  icalcomponent_add_property(icalevent, icalproperty_new_dtstart(icaltime_from_timet_with_zone(event->start, 0, utc)));
223  icalcomponent_add_property(icalevent, icalproperty_new_dtend(icaltime_from_timet_with_zone(event->end, 0, utc)));
224  if (!ast_strlen_zero(event->organizer)) {
225  icalcomponent_add_property(icalevent, icalproperty_new_organizer(event->organizer));
226  }
227  if (!ast_strlen_zero(event->summary)) {
228  icalcomponent_add_property(icalevent, icalproperty_new_summary(event->summary));
229  }
230  if (!ast_strlen_zero(event->description)) {
231  icalcomponent_add_property(icalevent, icalproperty_new_description(event->description));
232  }
233  if (!ast_strlen_zero(event->location)) {
234  icalcomponent_add_property(icalevent, icalproperty_new_location(event->location));
235  }
236  if (!ast_strlen_zero(event->categories)) {
237  icalcomponent_add_property(icalevent, icalproperty_new_categories(event->categories));
238  }
239  if (event->priority > 0) {
240  icalcomponent_add_property(icalevent, icalproperty_new_priority(event->priority));
241  }
242 
243  switch (event->busy_state) {
244  case AST_CALENDAR_BS_BUSY:
245  icalcomponent_add_property(icalevent, icalproperty_new_status(ICAL_STATUS_CONFIRMED));
246  break;
247 
248  case AST_CALENDAR_BS_BUSY_TENTATIVE:
249  icalcomponent_add_property(icalevent, icalproperty_new_status(ICAL_STATUS_TENTATIVE));
250  break;
251 
252  default:
253  icalcomponent_add_property(icalevent, icalproperty_new_status(ICAL_STATUS_NONE));
254  }
255 
256  icalcomponent_add_component(calendar, icalevent);
257 
258  ast_str_append(&body, 0, "%s", icalcomponent_as_ical_string(calendar));
259  ast_str_set(&subdir, 0, "%s%s.ics", pvt->url[strlen(pvt->url) - 1] == '/' ? "" : "/", event->uid);
260 
261  if ((response = caldav_request(pvt, "PUT", body, subdir, "text/calendar"))) {
262  ret = 0;
263  }
264 
265 write_cleanup:
266  if (body) {
267  ast_free(body);
268  }
269  if (response) {
270  ast_free(response);
271  }
272  if (subdir) {
273  ast_free(subdir);
274  }
275 
276  return ret;
277 }
278 
279 static struct ast_str *caldav_get_events_between(struct caldav_pvt *pvt, time_t start_time, time_t end_time)
280 {
281  struct ast_str *body, *response;
282  icaltimezone *utc = icaltimezone_get_utc_timezone();
283  icaltimetype start, end;
284  const char *start_str, *end_str;
285 
286  if (!(body = ast_str_create(512))) {
287  ast_log(LOG_ERROR, "Could not allocate memory for body of request!\n");
288  return NULL;
289  }
290 
291  start = icaltime_from_timet_with_zone(start_time, 0, utc);
292  end = icaltime_from_timet_with_zone(end_time, 0, utc);
293  start_str = icaltime_as_ical_string(start);
294  end_str = icaltime_as_ical_string(end);
295 
296  /* If I was really being efficient, I would store a collection of event URIs and etags,
297  * first doing a query of just the etag and seeing if anything had changed. If it had,
298  * then I would do a request for each of the events that had changed, and only bother
299  * updating those. Oh well. */
300  ast_str_append(&body, 0,
301  "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n"
302  "<C:calendar-query xmlns:D=\"DAV:\" xmlns:C=\"urn:ietf:params:xml:ns:caldav\">\n"
303  " <D:prop>\n"
304  " <C:calendar-data>\n"
305  " <C:expand start=\"%s\" end=\"%s\"/>\n"
306  " </C:calendar-data>\n"
307  " </D:prop>\n"
308  " <C:filter>\n"
309  " <C:comp-filter name=\"VCALENDAR\">\n"
310  " <C:comp-filter name=\"VEVENT\">\n"
311  " <C:time-range start=\"%s\" end=\"%s\"/>\n"
312  " </C:comp-filter>\n"
313  " </C:comp-filter>\n"
314  " </C:filter>\n"
315  "</C:calendar-query>\n", start_str, end_str, start_str, end_str);
316 
317  response = caldav_request(pvt, "REPORT", body, NULL, NULL);
318  ast_free(body);
319  if (response && !ast_str_strlen(response)) {
320  ast_free(response);
321  return NULL;
322  }
323 
324  return response;
325 }
326 
327 static time_t icalfloat_to_timet(icaltimetype time)
328 {
329  struct ast_tm tm = {0,};
330  struct timeval tv;
331 
332  tm.tm_mday = time.day;
333  tm.tm_mon = time.month - 1;
334  tm.tm_year = time.year - 1900;
335  tm.tm_hour = time.hour;
336  tm.tm_min = time.minute;
337  tm.tm_sec = time.second;
338  tm.tm_isdst = -1;
339  tv = ast_mktime(&tm, NULL);
340 
341  return tv.tv_sec;
342 }
343 
344 /* span->start & span->end may be dates or floating times which have no timezone,
345  * which would mean that they should apply to the local timezone for all recipients.
346  * For example, if a meeting was set for 1PM-2PM floating time, people in different time
347  * zones would not be scheduled at the same local times. Dates are often treated as
348  * floating times, so all day events will need to be converted--so we can trust the
349  * span here, and instead will grab the start and end from the component, which will
350  * allow us to test for floating times or dates.
351  */
352 static void caldav_add_event(icalcomponent *comp, struct icaltime_span *span, void *data)
353 {
354  struct caldav_pvt *pvt = data;
355  struct ast_calendar_event *event;
356  icaltimezone *utc = icaltimezone_get_utc_timezone();
357  icaltimetype start, end, tmp;
358  icalcomponent *valarm;
359  icalproperty *prop;
360  struct icaltriggertype trigger;
361 
362  if (!(pvt && pvt->owner)) {
363  ast_log(LOG_ERROR, "Require a private structure with an owner\n");
364  return;
365  }
366 
367  if (!(event = ast_calendar_event_alloc(pvt->owner))) {
368  ast_log(LOG_ERROR, "Could not allocate an event!\n");
369  return;
370  }
371 
372  start = icalcomponent_get_dtstart(comp);
373  end = icalcomponent_get_dtend(comp);
374 
375  event->start = icaltime_get_tzid(start) ? span->start : icalfloat_to_timet(start);
376  event->end = icaltime_get_tzid(end) ? span->end : icalfloat_to_timet(end);
377  event->busy_state = span->is_busy ? AST_CALENDAR_BS_BUSY : AST_CALENDAR_BS_FREE;
378 
379  if ((prop = icalcomponent_get_first_property(comp, ICAL_SUMMARY_PROPERTY))) {
380  ast_string_field_set(event, summary, icalproperty_get_value_as_string(prop));
381  }
382 
383  if ((prop = icalcomponent_get_first_property(comp, ICAL_DESCRIPTION_PROPERTY))) {
384  ast_string_field_set(event, description, icalproperty_get_value_as_string(prop));
385  }
386 
387  if ((prop = icalcomponent_get_first_property(comp, ICAL_ORGANIZER_PROPERTY))) {
388  ast_string_field_set(event, organizer, icalproperty_get_value_as_string(prop));
389  }
390 
391  if ((prop = icalcomponent_get_first_property(comp, ICAL_LOCATION_PROPERTY))) {
392  ast_string_field_set(event, location, icalproperty_get_value_as_string(prop));
393  }
394 
395  if ((prop = icalcomponent_get_first_property(comp, ICAL_CATEGORIES_PROPERTY))) {
396  ast_string_field_set(event, categories, icalproperty_get_value_as_string(prop));
397  }
398 
399  if ((prop = icalcomponent_get_first_property(comp, ICAL_PRIORITY_PROPERTY))) {
400  event->priority = icalvalue_get_integer(icalproperty_get_value(prop));
401  }
402 
403  if ((prop = icalcomponent_get_first_property(comp, ICAL_UID_PROPERTY))) {
404  ast_string_field_set(event, uid, icalproperty_get_value_as_string(prop));
405  } else {
406  ast_log(LOG_WARNING, "No UID found, but one is required. Generating, but updates may not be accurate\n");
407  if (!ast_strlen_zero(event->summary)) {
408  ast_string_field_set(event, uid, event->summary);
409  } else {
410  char tmp[AST_TIME_T_LEN];
411  ast_time_t_to_string(event->start, tmp, sizeof(tmp));
412  ast_string_field_set(event, uid, tmp);
413  }
414  }
415 
416  /* Get the attendees */
417  for (prop = icalcomponent_get_first_property(comp, ICAL_ATTENDEE_PROPERTY);
418  prop; prop = icalcomponent_get_next_property(comp, ICAL_ATTENDEE_PROPERTY)) {
419  struct ast_calendar_attendee *attendee;
420  const char *data;
421 
422  if (!(attendee = ast_calloc(1, sizeof(*attendee)))) {
423  event = ast_calendar_unref_event(event);
424  return;
425  }
426  data = icalproperty_get_attendee(prop);
427  if (ast_strlen_zero(data)) {
428  ast_free(attendee);
429  continue;
430  }
431  attendee->data = ast_strdup(data);
432  AST_LIST_INSERT_TAIL(&event->attendees, attendee, next);
433  }
434 
435 
436  /* Only set values for alarm based on VALARM. Can be overriden in main/calendar.c by autoreminder
437  * therefore, go ahead and add events even if their is no VALARM or it is malformed
438  * Currently we are only getting the first VALARM and are handling repitition in main/calendar.c from calendar.conf */
439  if (!(valarm = icalcomponent_get_first_component(comp, ICAL_VALARM_COMPONENT))) {
440  ao2_link(pvt->events, event);
441  event = ast_calendar_unref_event(event);
442  return;
443  }
444 
445  if (!(prop = icalcomponent_get_first_property(valarm, ICAL_TRIGGER_PROPERTY))) {
446  ast_log(LOG_WARNING, "VALARM has no TRIGGER, skipping!\n");
447  ao2_link(pvt->events, event);
448  event = ast_calendar_unref_event(event);
449  return;
450  }
451 
452  trigger = icalproperty_get_trigger(prop);
453 
454  if (icaltriggertype_is_null_trigger(trigger)) {
455  ast_log(LOG_WARNING, "Bad TRIGGER for VALARM, skipping!\n");
456  ao2_link(pvt->events, event);
457  event = ast_calendar_unref_event(event);
458  return;
459  }
460 
461  if (!icaltime_is_null_time(trigger.time)) { /* This is an absolute time */
462  tmp = icaltime_convert_to_zone(trigger.time, utc);
463  event->alarm = icaltime_as_timet_with_zone(tmp, utc);
464  } else { /* Offset from either dtstart or dtend */
465  /* XXX Technically you can check RELATED to see if the event fires from the END of the event
466  * But, I'm not sure I've ever seen anyone implement it in calendaring software, so I'm ignoring for now */
467  tmp = icaltime_add(start, trigger.duration);
468  event->alarm = icaltime_as_timet_with_zone(tmp, icaltime_get_timezone(start));
469  }
470 
471  ao2_link(pvt->events, event);
472  event = ast_calendar_unref_event(event);
473 
474  return;
475 }
476 
477 struct xmlstate {
478  int in_caldata;
479  struct caldav_pvt *pvt;
480  struct ast_str *cdata;
481  time_t start;
482  time_t end;
483 };
484 
485 static const xmlChar *caldav_node_localname = BAD_CAST "calendar-data";
486 static const xmlChar *caldav_node_nsuri = BAD_CAST "urn:ietf:params:xml:ns:caldav";
487 
488 static void handle_start_element(xmlTextReaderPtr reader, struct xmlstate *state)
489 {
490  const xmlChar *localname = xmlTextReaderConstLocalName(reader);
491  const xmlChar *uri = xmlTextReaderConstNamespaceUri(reader);
492 
493  if (!xmlStrEqual(localname, caldav_node_localname) || !xmlStrEqual(uri, caldav_node_nsuri)) {
494  return;
495  }
496 
497  state->in_caldata = 1;
498  ast_str_reset(state->cdata);
499 }
500 
501 static void handle_end_element(xmlTextReaderPtr reader, struct xmlstate *state)
502 {
503  struct icaltimetype start, end;
504  icaltimezone *utc = icaltimezone_get_utc_timezone();
505  icalcomponent *iter;
506  icalcomponent *comp;
507  const xmlChar *localname = xmlTextReaderConstLocalName(reader);
508  const xmlChar *uri = xmlTextReaderConstNamespaceUri(reader);
509 
510  if (!xmlStrEqual(localname, caldav_node_localname) || !xmlStrEqual(uri, caldav_node_nsuri)) {
511  return;
512  }
513 
514  state->in_caldata = 0;
515  if (!(state->cdata && ast_str_strlen(state->cdata))) {
516  return;
517  }
518  /* XXX Parse the calendar blurb for recurrence events in the time range,
519  * create an event, and add it to pvt->events */
520  start = icaltime_from_timet_with_zone(state->start, 0, utc);
521  end = icaltime_from_timet_with_zone(state->end, 0, utc);
522  comp = icalparser_parse_string(ast_str_buffer(state->cdata));
523 
524  for (iter = icalcomponent_get_first_component(comp, ICAL_VEVENT_COMPONENT);
525  iter;
526  iter = icalcomponent_get_next_component(comp, ICAL_VEVENT_COMPONENT))
527  {
528  icalcomponent_foreach_recurrence(iter, start, end, caldav_add_event, state->pvt);
529  }
530 
531  icalcomponent_free(comp);
532 }
533 
534 static void handle_characters(xmlTextReaderPtr reader, struct xmlstate *state)
535 {
536  xmlChar *text;
537 
538  if (!state->in_caldata) {
539  return;
540  }
541 
542  text = xmlTextReaderValue(reader);
543  if (text) {
544  ast_str_append(&state->cdata, 0, "%s", text);
545  xmlFree(text);
546  }
547 }
548 
549 static void parse_error_handler(void *arg, const char *msg,
550  xmlParserSeverities severity, xmlTextReaderLocatorPtr locator)
551 {
552  switch (severity) {
553  case XML_PARSER_SEVERITY_VALIDITY_WARNING:
554  case XML_PARSER_SEVERITY_WARNING:
555  ast_log(LOG_WARNING, "While parsing CalDAV response at line %d: %s\n",
556  xmlTextReaderLocatorLineNumber(locator),
557  msg);
558  break;
559  case XML_PARSER_SEVERITY_VALIDITY_ERROR:
560  case XML_PARSER_SEVERITY_ERROR:
561  default:
562  ast_log(LOG_ERROR, "While parsing CalDAV response at line %d: %s\n",
563  xmlTextReaderLocatorLineNumber(locator),
564  msg);
565  break;
566  }
567 }
568 
569 static int update_caldav(struct caldav_pvt *pvt)
570 {
571  struct timeval now = ast_tvnow();
572  time_t start, end;
573  struct ast_str *response;
574  xmlTextReaderPtr reader;
575  struct xmlstate state = {
576  .in_caldata = 0,
577  .pvt = pvt
578  };
579 
580  start = now.tv_sec;
581  end = now.tv_sec + 60 * pvt->owner->timeframe;
582  if (!(response = caldav_get_events_between(pvt, start, end))) {
583  return -1;
584  }
585 
586  if (!(state.cdata = ast_str_create(512))) {
587  ast_free(response);
588  return -1;
589  }
590 
591  state.start = start;
592  state.end = end;
593 
594  reader = xmlReaderForMemory(
595  ast_str_buffer(response),
596  ast_str_strlen(response),
597  NULL,
598  NULL,
599  0);
600 
601  if (reader) {
602  int res;
603 
604  xmlTextReaderSetErrorHandler(reader, parse_error_handler, NULL);
605 
606  res = xmlTextReaderRead(reader);
607  while (res == 1) {
608  int node_type = xmlTextReaderNodeType(reader);
609  switch (node_type) {
610  case XML_READER_TYPE_ELEMENT:
611  handle_start_element(reader, &state);
612  break;
613  case XML_READER_TYPE_END_ELEMENT:
614  handle_end_element(reader, &state);
615  break;
616  case XML_READER_TYPE_TEXT:
617  case XML_READER_TYPE_CDATA:
618  handle_characters(reader, &state);
619  break;
620  default:
621  break;
622  }
623  res = xmlTextReaderRead(reader);
624  }
625  xmlFreeTextReader(reader);
626  }
627 
628  ast_calendar_merge_events(pvt->owner, pvt->events);
629 
630  ast_free(response);
631  ast_free(state.cdata);
632 
633  return 0;
634 }
635 
636 static int verify_cert(void *userdata, int failures, const ne_ssl_certificate *cert)
637 {
638  /* Verify all certs */
639  return 0;
640 }
641 
642 static void *caldav_load_calendar(void *void_data)
643 {
644  struct caldav_pvt *pvt;
645  const struct ast_config *cfg;
646  struct ast_variable *v;
647  struct ast_calendar *cal = void_data;
648  ast_mutex_t refreshlock;
649 
650  if (!(cal && (cfg = ast_calendar_config_acquire()))) {
651  ast_log(LOG_ERROR, "You must enable calendar support for res_caldav to load\n");
652  return NULL;
653  }
654 
655  if (ao2_trylock(cal)) {
656  if (cal->unloading) {
657  ast_log(LOG_WARNING, "Unloading module, load_calendar cancelled.\n");
658  } else {
659  ast_log(LOG_WARNING, "Could not lock calendar, aborting!\n");
660  }
662  return NULL;
663  }
664 
665  if (!(pvt = ao2_alloc(sizeof(*pvt), caldav_destructor))) {
666  ast_log(LOG_ERROR, "Could not allocate caldav_pvt structure for calendar: %s\n", cal->name);
668  return NULL;
669  }
670 
671  pvt->owner = cal;
672 
673  if (!(pvt->events = ast_calendar_event_container_alloc())) {
674  ast_log(LOG_ERROR, "Could not allocate space for fetching events for calendar: %s\n", cal->name);
675  pvt = unref_caldav(pvt);
676  ao2_unlock(cal);
678  return NULL;
679  }
680 
681  if (ast_string_field_init(pvt, 32)) {
682  ast_log(LOG_ERROR, "Couldn't allocate string field space for calendar: %s\n", cal->name);
683  pvt = unref_caldav(pvt);
684  ao2_unlock(cal);
686  return NULL;
687  }
688 
689  for (v = ast_variable_browse(cfg, cal->name); v; v = v->next) {
690  if (!strcasecmp(v->name, "url")) {
691  ast_string_field_set(pvt, url, v->value);
692  } else if (!strcasecmp(v->name, "user")) {
693  ast_string_field_set(pvt, user, v->value);
694  } else if (!strcasecmp(v->name, "secret")) {
695  ast_string_field_set(pvt, secret, v->value);
696  }
697  }
698 
700 
701  if (ast_strlen_zero(pvt->url)) {
702  ast_log(LOG_WARNING, "No URL was specified for CalDAV calendar '%s' - skipping.\n", cal->name);
703  pvt = unref_caldav(pvt);
704  ao2_unlock(cal);
705  return NULL;
706  }
707 
708  if (ne_uri_parse(pvt->url, &pvt->uri) || pvt->uri.host == NULL || pvt->uri.path == NULL) {
709  ast_log(LOG_WARNING, "Could not parse url '%s' for CalDAV calendar '%s' - skipping.\n", pvt->url, cal->name);
710  pvt = unref_caldav(pvt);
711  ao2_unlock(cal);
712  return NULL;
713  }
714 
715  if (pvt->uri.scheme == NULL) {
716  pvt->uri.scheme = "http";
717  }
718 
719  if (pvt->uri.port == 0) {
720  pvt->uri.port = ne_uri_defaultport(pvt->uri.scheme);
721  }
722 
723  pvt->session = ne_session_create(pvt->uri.scheme, pvt->uri.host, pvt->uri.port);
724  ne_redirect_register(pvt->session);
725  ne_set_server_auth(pvt->session, auth_credentials, pvt);
726  if (!strcasecmp(pvt->uri.scheme, "https")) {
727  ne_ssl_trust_default_ca(pvt->session);
728  ne_ssl_set_verify(pvt->session, verify_cert, NULL);
729  }
730 
731  cal->tech_pvt = pvt;
732 
733  ast_mutex_init(&refreshlock);
734 
735  /* Load it the first time */
736  update_caldav(pvt);
737 
738  ao2_unlock(cal);
739 
740  /* The only writing from another thread will be if unload is true */
741  for (;;) {
742  struct timeval tv = ast_tvnow();
743  struct timespec ts = {0,};
744 
745  ts.tv_sec = tv.tv_sec + (60 * pvt->owner->refresh);
746 
747  ast_mutex_lock(&refreshlock);
748  while (!pvt->owner->unloading) {
749  if (ast_cond_timedwait(&pvt->owner->unload, &refreshlock, &ts) == ETIMEDOUT) {
750  break;
751  }
752  }
753  ast_mutex_unlock(&refreshlock);
754 
755  if (pvt->owner->unloading) {
756  ast_debug(10, "Skipping refresh since we got a shutdown signal\n");
757  return NULL;
758  }
759 
760  ast_debug(10, "Refreshing after %d minute timeout\n", pvt->owner->refresh);
761 
762  update_caldav(pvt);
763  }
764 
765  return NULL;
766 }
767 
768 static int load_module(void)
769 {
770  ne_sock_init();
771  if (ast_calendar_register(&caldav_tech)) {
772  ne_sock_exit();
774  }
775 
777 }
778 
779 static int unload_module(void)
780 {
781  ast_calendar_unregister(&caldav_tech);
782  ne_sock_exit();
783  return 0;
784 }
785 
786 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Asterisk CalDAV Calendar Integration",
787  .support_level = AST_MODULE_SUPPORT_EXTENDED,
788  .load = load_module,
789  .unload = unload_module,
790  .load_pri = AST_MODPRI_DEVSTATE_PLUGIN,
791  .requires = "res_calendar",
792 );
struct ast_variable * next
Asterisk locking-related definitions:
int ast_calendar_register(struct ast_calendar_tech *tech)
Register a new calendar technology.
Definition: res_calendar.c:551
Asterisk main include file. File version handling, generic pbx functions.
int ast_time_t_to_string(time_t time, char *buf, size_t length)
Converts to a string representation of a time_t as decimal seconds since the epoch. Returns -1 on failure, zero otherwise.
Definition: time.c:152
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:761
#define ao2_callback(c, flags, cb_fn, arg)
ao2_callback() is a generic function that applies cb_fn() to all objects in a container, as described below.
Definition: astobj2.h:1693
Structure for variables, used for configurations and for channel variables.
Definition: astman.c:222
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition: strings.h:1139
enum ast_calendar_busy_state busy_state
Definition: calendar.h:109
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition: time.h:159
#define AST_DECLARE_STRING_FIELDS(field_list)
Declare the fields needed in a structure.
Definition: stringfields.h:341
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
int timeframe
Definition: calendar.h:135
int tm_year
Definition: localtime.h:41
int ast_str_set(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Set a dynamic string using variable arguments.
Definition: strings.h:1113
void ast_calendar_merge_events(struct ast_calendar *cal, struct ao2_container *new_events)
Add an event to the list of events for a calendar.
Configuration File Parser.
General Asterisk PBX channel definitions.
#define ast_string_field_init(x, size)
Initialize a field pool and fields.
Definition: stringfields.h:359
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
struct ao2_container * ast_calendar_event_container_alloc(void)
Allocate an astobj2 container for ast_calendar_event objects.
Definition: res_calendar.c:691
#define AST_STRING_FIELD(name)
Declare a string field.
Definition: stringfields.h:303
int tm_mon
Definition: localtime.h:40
A general API for managing calendar events with Asterisk.
static struct stasis_rest_handlers events
REST handler for /api-docs/events.json.
#define ast_malloc(len)
A wrapper for malloc()
Definition: astmm.h:191
#define ast_debug(level,...)
Log a DEBUG message.
int tm_mday
Definition: localtime.h:39
const ast_string_field name
Definition: calendar.h:129
struct ast_calendar_event * ast_calendar_event_alloc(struct ast_calendar *cal)
Allocate an astobj2 ast_calendar_event object.
Definition: res_calendar.c:669
#define AST_LIST_INSERT_TAIL(head, elm, field)
Appends a list entry to the tail of a list.
Definition: linkedlists.h:731
Support for dynamic strings.
Definition: strings.h:623
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
const struct ast_config * ast_calendar_config_acquire(void)
Grab and lock pointer to the calendar config (read only)
Definition: res_calendar.c:260
Module has failed to load, may be in an inconsistent state.
Definition: module.h:78
struct ast_calendar_event * ast_calendar_unref_event(struct ast_calendar_event *event)
Unreference an ast_calendar_event.
Definition: res_calendar.c:323
int tm_hour
Definition: localtime.h:38
structure to hold users read from users.conf
#define ast_string_field_build(x, field, fmt, args...)
Set a field to a complex (built) value.
Definition: stringfields.h:555
int tm_sec
Definition: localtime.h:36
void ast_str_reset(struct ast_str *buf)
Reset the content of a dynamic string. Useful before a series of ast_str_append.
Definition: strings.h:693
void ast_calendar_unregister(struct ast_calendar_tech *tech)
Unregister a new calendar technology.
Definition: res_calendar.c:589
size_t ast_str_strlen(const struct ast_str *buf)
Returns the current length of the string stored within buf.
Definition: strings.h:730
struct timeval ast_mktime(struct ast_tm *const tmp, const char *zone)
Timezone-independent version of mktime(3).
Definition: localtime.c:2357
Individual calendaring technology data.
Definition: calendar.h:71
int tm_isdst
Definition: localtime.h:44
Generic container type.
Asterisk calendar structure.
Definition: calendar.h:119
Calendar events.
Definition: calendar.h:95
void ast_calendar_config_release(void)
Release the calendar config.
Definition: res_calendar.c:272
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition: module.h:46
Asterisk module definitions.
#define ast_string_field_free_memory(x)
free all memory - to be called before destroying the object
Definition: stringfields.h:374
int tm_min
Definition: localtime.h:37
Structure for mutex and tracking information.
Definition: lock.h:135
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition: strings.h:659
#define ast_string_field_set(x, field, data)
Set a field to a simple string value.
Definition: stringfields.h:521
#define ao2_link(container, obj)
Add an object to a container.
Definition: astobj2.h:1532