2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 2008 - 2009, Digium, Inc.
6 * Terry Wilson <twilson@digium.com>
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.
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.
20 * \brief Resource for handling iCalnedar calendars
26 <depend>iksemel</depend>
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32 #include <libical/ical.h>
33 #include <neon/ne_session.h>
34 #include <neon/ne_uri.h>
35 #include <neon/ne_request.h>
36 #include <neon/ne_auth.h>
39 #include "asterisk/module.h"
40 #include "asterisk/calendar.h"
41 #include "asterisk/lock.h"
42 #include "asterisk/config.h"
43 #include "asterisk/astobj2.h"
45 static void *exchangecal_load_calendar(void *data);
46 static void *unref_exchangecal(void *obj);
47 static int exchangecal_write_event(struct ast_calendar_event *event);
49 static struct ast_calendar_tech exchangecal_tech = {
51 .description = "MS Exchange calendars",
53 .load_calendar = exchangecal_load_calendar,
54 .unref_calendar = unref_exchangecal,
55 .write_event = exchangecal_write_event,
58 struct exchangecal_pvt {
59 AST_DECLARE_STRING_FIELDS(
60 AST_STRING_FIELD(url);
61 AST_STRING_FIELD(user);
62 AST_STRING_FIELD(secret);
64 struct ast_calendar *owner;
67 struct ao2_container *events;
76 struct exchangecal_pvt *pvt;
79 static int parse_tag(void *data, char *name, char **atts, int type)
81 struct xmlstate *state = data;
84 if ((tmp = strchr(name, ':'))) {
90 ast_copy_string(state->tag, tmp, sizeof(state->tag));
94 if (!strcasecmp(state->tag, "response")) {
95 struct ast_calendar_event *event;
97 state->in_response = 1;
98 if (!(event = ast_calendar_event_alloc(state->pvt->owner))) {
102 } else if (!strcasecmp(state->tag, "propstat")) {
103 state->in_propstat = 1;
104 } else if (!strcasecmp(state->tag, "prop")) {
110 if (!strcasecmp(state->tag, "response")) {
111 struct ao2_container *events = state->pvt->events;
112 struct ast_calendar_event *event = state->ptr;
114 state->in_response = 0;
115 if (ast_strlen_zero(event->uid)) {
116 ast_log(LOG_ERROR, "This event has no UID, something has gone wrong\n");
117 event = ast_calendar_unref_event(event);
120 ao2_link(events, event);
121 event = ast_calendar_unref_event(event);
122 } else if (!strcasecmp(state->tag, "propstat")) {
123 state->in_propstat = 0;
124 } else if (!strcasecmp(state->tag, "prop")) {
136 static time_t mstime_to_time_t(char *mstime)
140 for (read = write = mstime; *read; read++) {
146 if (*read == '-' || *read == ':')
152 tt = icaltime_from_string(mstime);
153 return icaltime_as_timet(tt);
156 static enum ast_calendar_busy_state msbusy_to_bs(const char *msbusy)
158 if (!strcasecmp(msbusy, "FREE")) {
159 return AST_CALENDAR_BS_FREE;
160 } else if (!strcasecmp(msbusy, "TENTATIVE")) {
161 return AST_CALENDAR_BS_BUSY_TENTATIVE;
163 return AST_CALENDAR_BS_BUSY;
167 static int parse_cdata(void *data, char *value, size_t len)
170 struct xmlstate *state = data;
171 struct ast_calendar_event *event = state->ptr;
174 str = ast_skip_blanks(value);
176 if (str == value + len)
179 if (!(str = ast_calloc(1, len + 1))) {
182 memcpy(str, value, len);
183 if (!(state->in_response && state->in_propstat && state->in_prop)) {
187 /* We use ast_string_field_build here because libiksemel is parsing CDATA with < as
188 * new elements which is a bit odd and shouldn't happen */
189 if (!strcasecmp(state->tag, "subject")) {
190 ast_string_field_build(event, summary, "%s%s", event->summary, str);
191 } else if (!strcasecmp(state->tag, "location")) {
192 ast_string_field_build(event, location, "%s%s", event->location, str);
193 } else if (!strcasecmp(state->tag, "uid")) {
194 ast_string_field_build(event, uid, "%s%s", event->location, str);
195 } else if (!strcasecmp(state->tag, "organizer")) {
196 ast_string_field_build(event, organizer, "%s%s", event->organizer, str);
197 } else if (!strcasecmp(state->tag, "textdescription")) {
198 ast_string_field_build(event, description, "%s%s", event->description, str);
199 } else if (!strcasecmp(state->tag, "dtstart")) {
200 event->start = mstime_to_time_t(str);
201 } else if (!strcasecmp(state->tag, "dtend")) {
202 event->end = mstime_to_time_t(str);
203 } else if (!strcasecmp(state->tag, "busystatus")) {
204 event->busy_state = msbusy_to_bs(str);
205 } else if (!strcasecmp(state->tag, "reminderoffset")) {
206 /*XXX Currently we rely on event->start being set first which means we rely on the response order
207 * which technically should be fine since the query returns in the order we ask for, but ... */
208 event->alarm = event->start - atoi(str);
215 static int cb_true(void *user_data, void *arg, int flags)
220 static void exchangecal_destructor(void *obj)
222 struct exchangecal_pvt *pvt = obj;
224 ast_debug(1, "Destroying pvt for Exchange calendar %s\n", pvt->owner->name);
226 ne_session_destroy(pvt->session);
228 ast_string_field_free_memory(pvt);
230 ao2_callback(pvt->events, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, cb_true, NULL);
232 ao2_ref(pvt->events, -1);
235 static void *unref_exchangecal(void *obj)
237 struct exchangecal_pvt *pvt = obj;
243 /* It is very important to use the return value of this function as a realloc could occur */
244 static struct ast_str *generate_exchange_uuid(struct ast_str *uid)
246 unsigned short val[8];
249 for (x = 0; x < 8; x++) {
250 val[x] = ast_random();
252 ast_str_set(&uid, 0, "%04x%04x-%04x-%04x-%04x-%04x%04x%04x", val[0], val[1], val[2], val[3], val[4], val[5], val[6], val[7]);
257 static int is_valid_uuid(struct ast_str *uid)
261 if (ast_str_strlen(uid) != 36) {
265 for (i = 0; i < ast_str_strlen(uid); i++) {
266 if (i == 8 || i == 13 || i == 18 || i == 23) {
267 if (ast_str_buffer(uid)[i] != '-') {
270 } else if (!((ast_str_buffer(uid)[i] > 47 && ast_str_buffer(uid)[i] < 58) || (ast_str_buffer(uid)[i] > 96 && ast_str_buffer(uid)[i] < 103))) {
278 static struct ast_str *xml_encode_str(struct ast_str *dst, const char *src)
283 for (tmp = src; *tmp; tmp++) {
286 strcpy(buf, """);
290 strcpy(buf, "'");
294 strcpy(buf, "&");
306 sprintf(buf, "%c", *tmp);
309 ast_str_append(&dst, 0, "%s", buf);
315 static struct ast_str *epoch_to_exchange_time(struct ast_str *dst, time_t epoch)
317 icaltimezone *utc = icaltimezone_get_utc_timezone();
318 icaltimetype tt = icaltime_from_timet_with_zone(epoch, 0, utc);
322 ast_copy_string(tmp, icaltime_as_ical_string(tt), sizeof(tmp));
323 for (i = 0; tmp[i]; i++) {
324 ast_str_append(&dst, 0, "%c", tmp[i]);
325 if (i == 3 || i == 5)
326 ast_str_append(&dst, 0, "%c", '-');
327 if (i == 10 || i == 12)
328 ast_str_append(&dst, 0, "%c", ':');
330 ast_str_append(&dst, 0, "%s", ".000");
336 static struct ast_str *bs_to_exchange_bs(struct ast_str *dst, enum ast_calendar_busy_state bs)
339 case AST_CALENDAR_BS_BUSY:
340 ast_str_set(&dst, 0, "%s", "BUSY");
343 case AST_CALENDAR_BS_BUSY_TENTATIVE:
344 ast_str_set(&dst, 0, "%s", "TENTATIVE");
348 ast_str_set(&dst, 0, "%s", "FREE");
354 static int fetch_response_reader(void *data, const char *block, size_t len)
356 struct ast_str **response = data;
359 if (!(tmp = ast_malloc(len + 1))) {
362 memcpy(tmp, block, len);
364 ast_str_append(response, 0, "%s", tmp);
370 static int auth_credentials(void *userdata, const char *realm, int attempts, char *username, char *secret)
372 struct exchangecal_pvt *pvt = userdata;
375 ast_log(LOG_WARNING, "Invalid username or password for Exchange calendar '%s'\n", pvt->owner->name);
379 ne_strnzcpy(username, pvt->user, NE_ABUFSIZ);
380 ne_strnzcpy(secret, pvt->secret, NE_ABUFSIZ);
385 static struct ast_str *exchangecal_request(struct exchangecal_pvt *pvt, const char *method, struct ast_str *req_body, struct ast_str *subdir)
387 struct ast_str *response;
393 ast_log(LOG_ERROR, "There is no private!\n");
397 if (!(response = ast_str_create(512))) {
398 ast_log(LOG_ERROR, "Could not allocate memory for response.\n");
402 snprintf(buf, sizeof(buf), "%s%s", pvt->uri.path, subdir ? ast_str_buffer(subdir) : "");
404 req = ne_request_create(pvt->session, method, buf);
405 ne_add_response_body_reader(req, ne_accept_2xx, fetch_response_reader, &response);
406 ne_set_request_body_buffer(req, ast_str_buffer(req_body), ast_str_strlen(req_body));
407 ne_add_request_header(req, "Content-type", "text/xml");
409 ret = ne_request_dispatch(req);
411 if (ret != NE_OK || !ast_str_strlen(response)) {
412 ast_log(LOG_WARNING, "Unknown response to CalDAV calendar %s, request %s to %s: %s\n", pvt->owner->name, method, pvt->url, ne_get_error(pvt->session));
420 static int exchangecal_write_event(struct ast_calendar_event *event)
422 struct ast_str *body = NULL, *response = NULL, *subdir = NULL;
423 struct ast_str *uid = NULL, *summary = NULL, *description = NULL, *organizer = NULL,
424 *location = NULL, *start = NULL, *end = NULL, *busystate = NULL;
428 ast_log(LOG_WARNING, "No event passed!\n");
432 if (!(event->start && event->end)) {
433 ast_log(LOG_WARNING, "The event must contain a start and an end\n");
436 if (!(body = ast_str_create(512)) ||
437 !(subdir = ast_str_create(32)) ||
438 !(response = ast_str_create(512))) {
439 ast_log(LOG_ERROR, "Could not allocate memory for request and response!\n");
443 if (!(uid = ast_str_create(32)) ||
444 !(summary = ast_str_create(32)) ||
445 !(description = ast_str_create(32)) ||
446 !(organizer = ast_str_create(32)) ||
447 !(location = ast_str_create(32)) ||
448 !(start = ast_str_create(32)) ||
449 !(end = ast_str_create(32)) ||
450 !(busystate = ast_str_create(32))) {
451 ast_log(LOG_ERROR, "Unable to allocate memory for request values\n");
455 if (ast_strlen_zero(event->uid)) {
456 uid = generate_exchange_uuid(uid);
458 ast_str_set(&uid, 36, "%s", event->uid);
461 if (!is_valid_uuid(uid)) {
462 ast_log(LOG_WARNING, "An invalid uid was provided, you may leave this field blank to have one generated for you\n");
466 summary = xml_encode_str(summary, event->summary);
467 description = xml_encode_str(description, event->description);
468 organizer = xml_encode_str(organizer, event->organizer);
469 location = xml_encode_str(location, event->location);
470 start = epoch_to_exchange_time(start, event->start);
471 end = epoch_to_exchange_time(end, event->end);
472 busystate = bs_to_exchange_bs(busystate, event->busy_state);
474 ast_str_append(&body, 0,
475 "<?xml version=\"1.0\"?>\n"
476 "<a:propertyupdate\n"
477 " xmlns:a=\"DAV:\"\n"
478 " xmlns:e=\"http://schemas.microsoft.com/exchange/\"\n"
479 " xmlns:mapi=\"http://schemas.microsoft.com/mapi/\"\n"
480 " xmlns:mapit=\"http://schemas.microsoft.com/mapi/proptag/\"\n"
481 " xmlns:x=\"xml:\" xmlns:cal=\"urn:schemas:calendar:\"\n"
482 " xmlns:dt=\"uuid:%s/\"\n" /* uid */
483 " xmlns:header=\"urn:schemas:mailheader:\"\n"
484 " xmlns:mail=\"urn:schemas:httpmail:\"\n"
488 " <a:contentclass>urn:content-classes:appointment</a:contentclass>\n"
489 " <e:outlookmessageclass>IPM.Appointment</e:outlookmessageclass>\n"
490 " <mail:subject>%s</mail:subject>\n" /* summary */
491 " <mail:description>%s</mail:description>\n" /* description */
492 " <header:to>%s</header:to>\n" /* organizer */
493 " <cal:location>%s</cal:location>\n" /* location */
494 " <cal:dtstart dt:dt=\"dateTime.tz\">%s</cal:dtstart>\n" /* start */
495 " <cal:dtend dt:dt=\"dateTime.tz\">%s</cal:dtend>\n" /* end */
496 " <cal:instancetype dt:dt=\"int\">0</cal:instancetype>\n"
497 " <cal:busystatus>%s</cal:busystatus>\n" /* busy_state (BUSY, FREE, BUSY_TENTATIVE) */
498 " <cal:meetingstatus>CONFIRMED</cal:meetingstatus>\n"
499 " <cal:alldayevent dt:dt=\"boolean\">0</cal:alldayevent>\n" /* XXX need to add event support for all day events */
500 " <cal:responserequested dt:dt=\"boolean\">0</cal:responserequested>\n"
501 " <mapi:finvited dt:dt=\"boolean\">1</mapi:finvited>\n"
504 "</a:propertyupdate>\n",
505 ast_str_buffer(uid), ast_str_buffer(summary), ast_str_buffer(description), ast_str_buffer(organizer), ast_str_buffer(location), ast_str_buffer(start), ast_str_buffer(end), ast_str_buffer(busystate));
506 ast_verb(0, "\n\n%s\n\n", ast_str_buffer(body));
507 ast_str_set(&subdir, 0, "/Calendar/%s.eml", ast_str_buffer(uid));
509 response = exchangecal_request(event->owner->tech_pvt, "PROPPATCH", body, subdir);
520 ast_free(description);
551 static struct ast_str *exchangecal_get_events_between(struct exchangecal_pvt *pvt, time_t start_time, time_t end_time)
553 struct ast_str *body, *response;
554 char start[80], end[80];
555 struct timeval tv = {0,};
558 tv.tv_sec = start_time;
559 ast_localtime(&tv, &tm, "UTC");
560 ast_strftime(start, sizeof(start), "%Y/%m/%d %T", &tm);
562 tv.tv_sec = end_time;
563 ast_localtime(&tv, &tm, "UTC");
564 ast_strftime(end, sizeof(end), "%Y/%m/%d %T", &tm);
566 if (!(body = ast_str_create(512))) {
567 ast_log(LOG_ERROR, "Could not allocate memory for body of request!\n");
571 ast_str_append(&body, 0,
572 "<?xml version=\"1.0\"?>\n"
573 "<g:searchrequest xmlns:g=\"DAV:\">\n"
574 " <g:sql> SELECT \"urn:schemas:calendar:location\", \"urn:schemas:httpmail:subject\",\n"
575 " \"urn:schemas:calendar:dtstart\", \"urn:schemas:calendar:dtend\",\n"
576 " \"urn:schemas:calendar:busystatus\", \"urn:schemas:calendar:instancetype\",\n"
577 " \"urn:schemas:calendar:uid\", \"urn:schemas:httpmail:textdescription\",\n"
578 " \"urn:schemas:calendar:organizer\", \"urn:schemas:calendar:reminderoffset\"\n"
579 " FROM Scope('SHALLOW TRAVERSAL OF \"%s/Calendar\"')\n"
580 " WHERE NOT \"urn:schemas:calendar:instancetype\" = 1\n"
581 " AND \"DAV:contentclass\" = 'urn:content-classes:appointment'\n"
582 " AND NOT (\"urn:schemas:calendar:dtend\" < '%s'\n"
583 " OR \"urn:schemas:calendar:dtstart\" > '%s')\n"
584 " ORDER BY \"urn:schemas:calendar:dtstart\" ASC\n"
586 "</g:searchrequest>\n", pvt->url, start, end);
588 ast_debug(5, "Request:\n%s\n", ast_str_buffer(body));
589 response = exchangecal_request(pvt, "SEARCH", body, NULL);
590 ast_debug(5, "Response:\n%s\n", ast_str_buffer(response));
596 static int update_exchangecal(struct exchangecal_pvt *pvt)
598 struct xmlstate state;
599 struct timeval now = ast_tvnow();
601 struct ast_str *response;
606 end = now.tv_sec + 60 * pvt->owner->timeframe;
607 if (!(response = exchangecal_get_events_between(pvt, start, end))) {
611 p = iks_sax_new(&state, parse_tag, parse_cdata);
612 iks_parse(p, ast_str_buffer(response), ast_str_strlen(response), 1);
613 ast_calendar_merge_events(pvt->owner, pvt->events);
619 static void *exchangecal_load_calendar(void *void_data)
621 struct exchangecal_pvt *pvt;
622 const struct ast_config *cfg;
623 struct ast_variable *v;
624 struct ast_calendar *cal = void_data;
625 ast_mutex_t refreshlock;
627 if (!(cal && (cfg = ast_calendar_config_acquire()))) {
628 ast_log(LOG_ERROR, "You must enable calendar support for res_exchangecal to load\n");
632 if (ao2_trylock(cal)) {
633 if (cal->unloading) {
634 ast_log(LOG_WARNING, "Unloading module, load_calendar cancelled.\n");
636 ast_log(LOG_WARNING, "Could not lock calendar, aborting!\n");
638 ast_calendar_config_release();
642 if (!(pvt = ao2_alloc(sizeof(*pvt), exchangecal_destructor))) {
643 ast_log(LOG_ERROR, "Could not allocate exchangecal_pvt structure for calendar: %s\n", cal->name);
644 ast_calendar_config_release();
650 if (!(pvt->events = ast_calendar_event_container_alloc())) {
651 ast_log(LOG_ERROR, "Could not allocate space for fetching events for calendar: %s\n", cal->name);
652 pvt = unref_exchangecal(pvt);
654 ast_calendar_config_release();
658 if (ast_string_field_init(pvt, 32)) {
659 ast_log(LOG_ERROR, "Couldn't allocate string field space for calendar: %s\n", cal->name);
660 pvt = unref_exchangecal(pvt);
662 ast_calendar_config_release();
666 for (v = ast_variable_browse(cfg, cal->name); v; v = v->next) {
667 if (!strcasecmp(v->name, "url")) {
668 ast_string_field_set(pvt, url, v->value);
669 } else if (!strcasecmp(v->name, "user")) {
670 ast_string_field_set(pvt, user, v->value);
671 } else if (!strcasecmp(v->name, "secret")) {
672 ast_string_field_set(pvt, secret, v->value);
676 ast_calendar_config_release();
678 if (ast_strlen_zero(pvt->url)) {
679 ast_log(LOG_WARNING, "No URL was specified for Exchange calendar '%s' - skipping.\n", cal->name);
680 pvt = unref_exchangecal(pvt);
685 if (ne_uri_parse(pvt->url, &pvt->uri) || pvt->uri.host == NULL || pvt->uri.path == NULL) {
686 ast_log(LOG_WARNING, "Could not parse url '%s' for Exchange calendar '%s' - skipping.\n", pvt->url, cal->name);
687 pvt = unref_exchangecal(pvt);
692 if (pvt->uri.scheme == NULL) {
693 pvt->uri.scheme = "http";
696 if (pvt->uri.port == 0) {
697 pvt->uri.port = ne_uri_defaultport(pvt->uri.scheme);
700 pvt->session = ne_session_create(pvt->uri.scheme, pvt->uri.host, pvt->uri.port);
701 ne_set_server_auth(pvt->session, auth_credentials, pvt);
702 if (!strncasecmp(pvt->uri.scheme, "https", sizeof(pvt->uri.scheme))) {
703 ne_ssl_trust_default_ca(pvt->session);
708 ast_mutex_init(&refreshlock);
710 /* Load it the first time */
711 update_exchangecal(pvt);
715 /* The only writing from another thread will be if unload is true */
717 struct timeval tv = ast_tvnow();
718 struct timespec ts = {0,};
720 ts.tv_sec = tv.tv_sec + (60 * pvt->owner->refresh);
722 ast_mutex_lock(&refreshlock);
723 while (!pvt->owner->unloading) {
724 if (ast_cond_timedwait(&pvt->owner->unload, &refreshlock, &ts) == ETIMEDOUT) {
728 ast_mutex_unlock(&refreshlock);
730 if (pvt->owner->unloading) {
731 ast_debug(10, "Skipping refresh since we got a shutdown signal\n");
735 ast_debug(10, "Refreshing after %d minute timeout\n", pvt->owner->refresh);
737 update_exchangecal(pvt);
743 static int load_module(void)
746 if (ast_calendar_register(&exchangecal_tech)) {
748 return AST_MODULE_LOAD_DECLINE;
751 return AST_MODULE_LOAD_SUCCESS;
754 static int unload_module(void)
756 ast_calendar_unregister(&exchangecal_tech);
761 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Asterisk MS Exchange Calendar Integration",
763 .unload = unload_module,