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 MS Exchange calendars
26 <depend>iksemel</depend>
27 <support_level>core</support_level>
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34 #include <libical/ical.h>
35 #include <ne_session.h>
37 #include <ne_request.h>
39 #include <ne_redirect.h>
42 #include "asterisk/module.h"
43 #include "asterisk/calendar.h"
44 #include "asterisk/lock.h"
45 #include "asterisk/config.h"
46 #include "asterisk/astobj2.h"
47 #include "asterisk/uuid.h"
49 static void *exchangecal_load_calendar(void *data);
50 static void *unref_exchangecal(void *obj);
51 static int exchangecal_write_event(struct ast_calendar_event *event);
53 static struct ast_calendar_tech exchangecal_tech = {
55 .description = "MS Exchange calendars",
57 .load_calendar = exchangecal_load_calendar,
58 .unref_calendar = unref_exchangecal,
59 .write_event = exchangecal_write_event,
62 struct exchangecal_pvt {
63 AST_DECLARE_STRING_FIELDS(
64 AST_STRING_FIELD(url);
65 AST_STRING_FIELD(user);
66 AST_STRING_FIELD(secret);
68 struct ast_calendar *owner;
71 struct ao2_container *events;
80 struct exchangecal_pvt *pvt;
83 static int parse_tag(void *data, char *name, char **atts, int type)
85 struct xmlstate *state = data;
88 if ((tmp = strchr(name, ':'))) {
94 ast_copy_string(state->tag, tmp, sizeof(state->tag));
98 if (!strcasecmp(state->tag, "response")) {
99 struct ast_calendar_event *event;
101 state->in_response = 1;
102 if (!(event = ast_calendar_event_alloc(state->pvt->owner))) {
106 } else if (!strcasecmp(state->tag, "propstat")) {
107 state->in_propstat = 1;
108 } else if (!strcasecmp(state->tag, "prop")) {
114 if (!strcasecmp(state->tag, "response")) {
115 struct ao2_container *events = state->pvt->events;
116 struct ast_calendar_event *event = state->ptr;
118 state->in_response = 0;
119 if (ast_strlen_zero(event->uid)) {
120 ast_log(LOG_ERROR, "This event has no UID, something has gone wrong\n");
121 event = ast_calendar_unref_event(event);
124 ao2_link(events, event);
125 event = ast_calendar_unref_event(event);
126 } else if (!strcasecmp(state->tag, "propstat")) {
127 state->in_propstat = 0;
128 } else if (!strcasecmp(state->tag, "prop")) {
140 static time_t mstime_to_time_t(char *mstime)
144 for (read = write = mstime; *read; read++) {
150 if (*read == '-' || *read == ':')
156 tt = icaltime_from_string(mstime);
157 return icaltime_as_timet(tt);
160 static enum ast_calendar_busy_state msbusy_to_bs(const char *msbusy)
162 if (!strcasecmp(msbusy, "FREE")) {
163 return AST_CALENDAR_BS_FREE;
164 } else if (!strcasecmp(msbusy, "TENTATIVE")) {
165 return AST_CALENDAR_BS_BUSY_TENTATIVE;
167 return AST_CALENDAR_BS_BUSY;
171 static int parse_cdata(void *data, char *value, size_t len)
174 struct xmlstate *state = data;
175 struct ast_calendar_event *event = state->ptr;
178 str = ast_skip_blanks(value);
180 if (str == value + len)
183 if (!(str = ast_calloc(1, len + 1))) {
186 memcpy(str, value, len);
187 if (!(state->in_response && state->in_propstat && state->in_prop)) {
191 /* We use ast_string_field_build here because libiksemel is parsing CDATA with < as
192 * new elements which is a bit odd and shouldn't happen */
193 if (!strcasecmp(state->tag, "subject")) {
194 ast_string_field_build(event, summary, "%s%s", event->summary, str);
195 } else if (!strcasecmp(state->tag, "location")) {
196 ast_string_field_build(event, location, "%s%s", event->location, str);
197 } else if (!strcasecmp(state->tag, "uid")) {
198 ast_string_field_build(event, uid, "%s%s", event->location, str);
199 } else if (!strcasecmp(state->tag, "organizer")) {
200 ast_string_field_build(event, organizer, "%s%s", event->organizer, str);
201 } else if (!strcasecmp(state->tag, "textdescription")) {
202 ast_string_field_build(event, description, "%s%s", event->description, str);
203 } else if (!strcasecmp(state->tag, "dtstart")) {
204 event->start = mstime_to_time_t(str);
205 } else if (!strcasecmp(state->tag, "dtend")) {
206 event->end = mstime_to_time_t(str);
207 } else if (!strcasecmp(state->tag, "busystatus")) {
208 event->busy_state = msbusy_to_bs(str);
209 } else if (!strcasecmp(state->tag, "reminderoffset")) {
210 /*XXX Currently we rely on event->start being set first which means we rely on the response order
211 * which technically should be fine since the query returns in the order we ask for, but ... */
212 event->alarm = event->start - atoi(str);
219 static void exchangecal_destructor(void *obj)
221 struct exchangecal_pvt *pvt = obj;
223 ast_debug(1, "Destroying pvt for Exchange calendar %s\n", pvt->owner->name);
225 ne_session_destroy(pvt->session);
227 ast_string_field_free_memory(pvt);
229 ao2_callback(pvt->events, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL);
231 ao2_ref(pvt->events, -1);
234 static void *unref_exchangecal(void *obj)
236 struct exchangecal_pvt *pvt = obj;
242 /* It is very important to use the return value of this function as a realloc could occur */
243 static struct ast_str *generate_exchange_uuid(struct ast_str *uid)
245 char buffer[AST_UUID_STR_LEN];
246 struct ast_uuid *uuid = ast_uuid_generate();
252 ast_str_set(&uid, 0, "%s", ast_uuid_to_str(uuid, buffer, AST_UUID_STR_LEN));
259 static int is_valid_uuid(struct ast_str *uid)
261 struct ast_uuid *uuid = ast_str_to_uuid(ast_str_buffer(uid));
271 static struct ast_str *xml_encode_str(struct ast_str *dst, const char *src)
276 for (tmp = src; *tmp; tmp++) {
279 strcpy(buf, """);
283 strcpy(buf, "'");
287 strcpy(buf, "&");
299 sprintf(buf, "%c", *tmp);
302 ast_str_append(&dst, 0, "%s", buf);
308 static struct ast_str *epoch_to_exchange_time(struct ast_str *dst, time_t epoch)
310 icaltimezone *utc = icaltimezone_get_utc_timezone();
311 icaltimetype tt = icaltime_from_timet_with_zone(epoch, 0, utc);
315 ast_copy_string(tmp, icaltime_as_ical_string(tt), sizeof(tmp));
316 for (i = 0; tmp[i]; i++) {
317 ast_str_append(&dst, 0, "%c", tmp[i]);
318 if (i == 3 || i == 5)
319 ast_str_append(&dst, 0, "%c", '-');
320 if (i == 10 || i == 12)
321 ast_str_append(&dst, 0, "%c", ':');
323 ast_str_append(&dst, 0, "%s", ".000");
329 static struct ast_str *bs_to_exchange_bs(struct ast_str *dst, enum ast_calendar_busy_state bs)
332 case AST_CALENDAR_BS_BUSY:
333 ast_str_set(&dst, 0, "%s", "BUSY");
336 case AST_CALENDAR_BS_BUSY_TENTATIVE:
337 ast_str_set(&dst, 0, "%s", "TENTATIVE");
341 ast_str_set(&dst, 0, "%s", "FREE");
347 static int fetch_response_reader(void *data, const char *block, size_t len)
349 struct ast_str **response = data;
352 if (!(tmp = ast_malloc(len + 1))) {
355 memcpy(tmp, block, len);
357 ast_str_append(response, 0, "%s", tmp);
363 static int auth_credentials(void *userdata, const char *realm, int attempts, char *username, char *secret)
365 struct exchangecal_pvt *pvt = userdata;
368 ast_log(LOG_WARNING, "Invalid username or password for Exchange calendar '%s'\n", pvt->owner->name);
372 ne_strnzcpy(username, pvt->user, NE_ABUFSIZ);
373 ne_strnzcpy(secret, pvt->secret, NE_ABUFSIZ);
378 static struct ast_str *exchangecal_request(struct exchangecal_pvt *pvt, const char *method, struct ast_str *req_body, struct ast_str *subdir)
380 struct ast_str *response;
386 ast_log(LOG_ERROR, "There is no private!\n");
390 if (!(response = ast_str_create(512))) {
391 ast_log(LOG_ERROR, "Could not allocate memory for response.\n");
395 snprintf(buf, sizeof(buf), "%s%s", pvt->uri.path, subdir ? ast_str_buffer(subdir) : "");
397 req = ne_request_create(pvt->session, method, buf);
398 ne_add_response_body_reader(req, ne_accept_2xx, fetch_response_reader, &response);
399 ne_set_request_body_buffer(req, ast_str_buffer(req_body), ast_str_strlen(req_body));
400 ne_add_request_header(req, "Content-type", "text/xml");
402 ret = ne_request_dispatch(req);
403 ne_request_destroy(req);
405 if (ret != NE_OK || !ast_str_strlen(response)) {
406 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));
414 static int exchangecal_write_event(struct ast_calendar_event *event)
416 struct ast_str *body = NULL, *response = NULL, *subdir = NULL;
417 struct ast_str *uid = NULL, *summary = NULL, *description = NULL, *organizer = NULL,
418 *location = NULL, *start = NULL, *end = NULL, *busystate = NULL;
422 ast_log(LOG_WARNING, "No event passed!\n");
426 if (!(event->start && event->end)) {
427 ast_log(LOG_WARNING, "The event must contain a start and an end\n");
430 if (!(body = ast_str_create(512)) ||
431 !(subdir = ast_str_create(32))) {
432 ast_log(LOG_ERROR, "Could not allocate memory for request!\n");
436 if (!(uid = ast_str_create(32)) ||
437 !(summary = ast_str_create(32)) ||
438 !(description = ast_str_create(32)) ||
439 !(organizer = ast_str_create(32)) ||
440 !(location = ast_str_create(32)) ||
441 !(start = ast_str_create(32)) ||
442 !(end = ast_str_create(32)) ||
443 !(busystate = ast_str_create(32))) {
444 ast_log(LOG_ERROR, "Unable to allocate memory for request values\n");
448 if (ast_strlen_zero(event->uid)) {
449 uid = generate_exchange_uuid(uid);
451 ast_str_set(&uid, 36, "%s", event->uid);
454 if (!is_valid_uuid(uid)) {
455 ast_log(LOG_WARNING, "An invalid uid was provided, you may leave this field blank to have one generated for you\n");
459 summary = xml_encode_str(summary, event->summary);
460 description = xml_encode_str(description, event->description);
461 organizer = xml_encode_str(organizer, event->organizer);
462 location = xml_encode_str(location, event->location);
463 start = epoch_to_exchange_time(start, event->start);
464 end = epoch_to_exchange_time(end, event->end);
465 busystate = bs_to_exchange_bs(busystate, event->busy_state);
467 ast_str_append(&body, 0,
468 "<?xml version=\"1.0\"?>\n"
469 "<a:propertyupdate\n"
470 " xmlns:a=\"DAV:\"\n"
471 " xmlns:e=\"http://schemas.microsoft.com/exchange/\"\n"
472 " xmlns:mapi=\"http://schemas.microsoft.com/mapi/\"\n"
473 " xmlns:mapit=\"http://schemas.microsoft.com/mapi/proptag/\"\n"
474 " xmlns:x=\"xml:\" xmlns:cal=\"urn:schemas:calendar:\"\n"
475 " xmlns:dt=\"uuid:%s/\"\n" /* uid */
476 " xmlns:header=\"urn:schemas:mailheader:\"\n"
477 " xmlns:mail=\"urn:schemas:httpmail:\"\n"
481 " <a:contentclass>urn:content-classes:appointment</a:contentclass>\n"
482 " <e:outlookmessageclass>IPM.Appointment</e:outlookmessageclass>\n"
483 " <mail:subject>%s</mail:subject>\n" /* summary */
484 " <mail:description>%s</mail:description>\n" /* description */
485 " <header:to>%s</header:to>\n" /* organizer */
486 " <cal:location>%s</cal:location>\n" /* location */
487 " <cal:dtstart dt:dt=\"dateTime.tz\">%s</cal:dtstart>\n" /* start */
488 " <cal:dtend dt:dt=\"dateTime.tz\">%s</cal:dtend>\n" /* end */
489 " <cal:instancetype dt:dt=\"int\">0</cal:instancetype>\n"
490 " <cal:busystatus>%s</cal:busystatus>\n" /* busy_state (BUSY, FREE, BUSY_TENTATIVE) */
491 " <cal:meetingstatus>CONFIRMED</cal:meetingstatus>\n"
492 " <cal:alldayevent dt:dt=\"boolean\">0</cal:alldayevent>\n" /* XXX need to add event support for all day events */
493 " <cal:responserequested dt:dt=\"boolean\">0</cal:responserequested>\n"
494 " <mapi:finvited dt:dt=\"boolean\">1</mapi:finvited>\n"
497 "</a:propertyupdate>\n",
498 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));
499 ast_verb(0, "\n\n%s\n\n", ast_str_buffer(body));
500 ast_str_set(&subdir, 0, "/Calendar/%s.eml", ast_str_buffer(uid));
502 if ((response = exchangecal_request(event->owner->tech_pvt, "PROPPATCH", body, subdir))) {
514 ast_free(description);
545 static struct ast_str *exchangecal_get_events_between(struct exchangecal_pvt *pvt, time_t start_time, time_t end_time)
547 struct ast_str *body, *response;
548 char start[80], end[80];
549 struct timeval tv = {0,};
552 tv.tv_sec = start_time;
553 ast_localtime(&tv, &tm, "UTC");
554 ast_strftime(start, sizeof(start), "%Y/%m/%d %T", &tm);
556 tv.tv_sec = end_time;
557 ast_localtime(&tv, &tm, "UTC");
558 ast_strftime(end, sizeof(end), "%Y/%m/%d %T", &tm);
560 if (!(body = ast_str_create(512))) {
561 ast_log(LOG_ERROR, "Could not allocate memory for body of request!\n");
565 ast_str_append(&body, 0,
566 "<?xml version=\"1.0\"?>\n"
567 "<g:searchrequest xmlns:g=\"DAV:\">\n"
568 " <g:sql> SELECT \"urn:schemas:calendar:location\", \"urn:schemas:httpmail:subject\",\n"
569 " \"urn:schemas:calendar:dtstart\", \"urn:schemas:calendar:dtend\",\n"
570 " \"urn:schemas:calendar:busystatus\", \"urn:schemas:calendar:instancetype\",\n"
571 " \"urn:schemas:calendar:uid\", \"urn:schemas:httpmail:textdescription\",\n"
572 " \"urn:schemas:calendar:organizer\", \"urn:schemas:calendar:reminderoffset\"\n"
573 " FROM Scope('SHALLOW TRAVERSAL OF \"%s/Calendar\"')\n"
574 " WHERE NOT \"urn:schemas:calendar:instancetype\" = 1\n"
575 " AND \"DAV:contentclass\" = 'urn:content-classes:appointment'\n"
576 " AND NOT (\"urn:schemas:calendar:dtend\" < '%s'\n"
577 " OR \"urn:schemas:calendar:dtstart\" > '%s')\n"
578 " ORDER BY \"urn:schemas:calendar:dtstart\" ASC\n"
580 "</g:searchrequest>\n", pvt->url, start, end);
582 ast_debug(5, "Request:\n%s\n", ast_str_buffer(body));
583 response = exchangecal_request(pvt, "SEARCH", body, NULL);
584 ast_debug(5, "Response:\n%s\n", ast_str_buffer(response));
590 static int update_exchangecal(struct exchangecal_pvt *pvt)
592 struct xmlstate state;
593 struct timeval now = ast_tvnow();
595 struct ast_str *response;
600 end = now.tv_sec + 60 * pvt->owner->timeframe;
601 if (!(response = exchangecal_get_events_between(pvt, start, end))) {
605 p = iks_sax_new(&state, parse_tag, parse_cdata);
606 iks_parse(p, ast_str_buffer(response), ast_str_strlen(response), 1);
607 ast_calendar_merge_events(pvt->owner, pvt->events);
613 static void *exchangecal_load_calendar(void *void_data)
615 struct exchangecal_pvt *pvt;
616 const struct ast_config *cfg;
617 struct ast_variable *v;
618 struct ast_calendar *cal = void_data;
619 ast_mutex_t refreshlock;
621 if (!(cal && (cfg = ast_calendar_config_acquire()))) {
622 ast_log(LOG_ERROR, "You must enable calendar support for res_exchangecal to load\n");
626 if (ao2_trylock(cal)) {
627 if (cal->unloading) {
628 ast_log(LOG_WARNING, "Unloading module, load_calendar cancelled.\n");
630 ast_log(LOG_WARNING, "Could not lock calendar, aborting!\n");
632 ast_calendar_config_release();
636 if (!(pvt = ao2_alloc(sizeof(*pvt), exchangecal_destructor))) {
637 ast_log(LOG_ERROR, "Could not allocate exchangecal_pvt structure for calendar: %s\n", cal->name);
638 ast_calendar_config_release();
644 if (!(pvt->events = ast_calendar_event_container_alloc())) {
645 ast_log(LOG_ERROR, "Could not allocate space for fetching events for calendar: %s\n", cal->name);
646 pvt = unref_exchangecal(pvt);
648 ast_calendar_config_release();
652 if (ast_string_field_init(pvt, 32)) {
653 ast_log(LOG_ERROR, "Couldn't allocate string field space for calendar: %s\n", cal->name);
654 pvt = unref_exchangecal(pvt);
656 ast_calendar_config_release();
660 for (v = ast_variable_browse(cfg, cal->name); v; v = v->next) {
661 if (!strcasecmp(v->name, "url")) {
662 ast_string_field_set(pvt, url, v->value);
663 } else if (!strcasecmp(v->name, "user")) {
664 ast_string_field_set(pvt, user, v->value);
665 } else if (!strcasecmp(v->name, "secret")) {
666 ast_string_field_set(pvt, secret, v->value);
670 ast_calendar_config_release();
672 if (ast_strlen_zero(pvt->url)) {
673 ast_log(LOG_WARNING, "No URL was specified for Exchange calendar '%s' - skipping.\n", cal->name);
674 pvt = unref_exchangecal(pvt);
679 if (ne_uri_parse(pvt->url, &pvt->uri) || pvt->uri.host == NULL || pvt->uri.path == NULL) {
680 ast_log(LOG_WARNING, "Could not parse url '%s' for Exchange calendar '%s' - skipping.\n", pvt->url, cal->name);
681 pvt = unref_exchangecal(pvt);
686 if (pvt->uri.scheme == NULL) {
687 pvt->uri.scheme = "http";
690 if (pvt->uri.port == 0) {
691 pvt->uri.port = ne_uri_defaultport(pvt->uri.scheme);
694 pvt->session = ne_session_create(pvt->uri.scheme, pvt->uri.host, pvt->uri.port);
695 ne_redirect_register(pvt->session);
696 ne_set_server_auth(pvt->session, auth_credentials, pvt);
697 if (!strcasecmp(pvt->uri.scheme, "https")) {
698 ne_ssl_trust_default_ca(pvt->session);
703 ast_mutex_init(&refreshlock);
705 /* Load it the first time */
706 update_exchangecal(pvt);
710 /* The only writing from another thread will be if unload is true */
712 struct timeval tv = ast_tvnow();
713 struct timespec ts = {0,};
715 ts.tv_sec = tv.tv_sec + (60 * pvt->owner->refresh);
717 ast_mutex_lock(&refreshlock);
718 while (!pvt->owner->unloading) {
719 if (ast_cond_timedwait(&pvt->owner->unload, &refreshlock, &ts) == ETIMEDOUT) {
723 ast_mutex_unlock(&refreshlock);
725 if (pvt->owner->unloading) {
726 ast_debug(10, "Skipping refresh since we got a shutdown signal\n");
730 ast_debug(10, "Refreshing after %d minute timeout\n", pvt->owner->refresh);
732 update_exchangecal(pvt);
738 static int load_module(void)
741 if (ast_calendar_register(&exchangecal_tech)) {
743 return AST_MODULE_LOAD_DECLINE;
746 return AST_MODULE_LOAD_SUCCESS;
749 static int unload_module(void)
751 ast_calendar_unregister(&exchangecal_tech);
756 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Asterisk MS Exchange Calendar Integration",
758 .unload = unload_module,
759 .load_pri = AST_MODPRI_DEVSTATE_PLUGIN,