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>
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32 #include <libical/ical.h>
33 #include <ne_session.h>
35 #include <ne_request.h>
37 #include <ne_redirect.h>
40 #include "asterisk/module.h"
41 #include "asterisk/calendar.h"
42 #include "asterisk/lock.h"
43 #include "asterisk/config.h"
44 #include "asterisk/astobj2.h"
46 static void *exchangecal_load_calendar(void *data);
47 static void *unref_exchangecal(void *obj);
48 static int exchangecal_write_event(struct ast_calendar_event *event);
50 static struct ast_calendar_tech exchangecal_tech = {
52 .description = "MS Exchange calendars",
54 .load_calendar = exchangecal_load_calendar,
55 .unref_calendar = unref_exchangecal,
56 .write_event = exchangecal_write_event,
59 struct exchangecal_pvt {
60 AST_DECLARE_STRING_FIELDS(
61 AST_STRING_FIELD(url);
62 AST_STRING_FIELD(user);
63 AST_STRING_FIELD(secret);
65 struct ast_calendar *owner;
68 struct ao2_container *events;
77 struct exchangecal_pvt *pvt;
80 static int parse_tag(void *data, char *name, char **atts, int type)
82 struct xmlstate *state = data;
85 if ((tmp = strchr(name, ':'))) {
91 ast_copy_string(state->tag, tmp, sizeof(state->tag));
95 if (!strcasecmp(state->tag, "response")) {
96 struct ast_calendar_event *event;
98 state->in_response = 1;
99 if (!(event = ast_calendar_event_alloc(state->pvt->owner))) {
103 } else if (!strcasecmp(state->tag, "propstat")) {
104 state->in_propstat = 1;
105 } else if (!strcasecmp(state->tag, "prop")) {
111 if (!strcasecmp(state->tag, "response")) {
112 struct ao2_container *events = state->pvt->events;
113 struct ast_calendar_event *event = state->ptr;
115 state->in_response = 0;
116 if (ast_strlen_zero(event->uid)) {
117 ast_log(LOG_ERROR, "This event has no UID, something has gone wrong\n");
118 event = ast_calendar_unref_event(event);
121 ao2_link(events, event);
122 event = ast_calendar_unref_event(event);
123 } else if (!strcasecmp(state->tag, "propstat")) {
124 state->in_propstat = 0;
125 } else if (!strcasecmp(state->tag, "prop")) {
137 static time_t mstime_to_time_t(char *mstime)
141 for (read = write = mstime; *read; read++) {
147 if (*read == '-' || *read == ':')
153 tt = icaltime_from_string(mstime);
154 return icaltime_as_timet(tt);
157 static enum ast_calendar_busy_state msbusy_to_bs(const char *msbusy)
159 if (!strcasecmp(msbusy, "FREE")) {
160 return AST_CALENDAR_BS_FREE;
161 } else if (!strcasecmp(msbusy, "TENTATIVE")) {
162 return AST_CALENDAR_BS_BUSY_TENTATIVE;
164 return AST_CALENDAR_BS_BUSY;
168 static int parse_cdata(void *data, char *value, size_t len)
171 struct xmlstate *state = data;
172 struct ast_calendar_event *event = state->ptr;
175 str = ast_skip_blanks(value);
177 if (str == value + len)
180 if (!(str = ast_calloc(1, len + 1))) {
183 memcpy(str, value, len);
184 if (!(state->in_response && state->in_propstat && state->in_prop)) {
188 /* We use ast_string_field_build here because libiksemel is parsing CDATA with < as
189 * new elements which is a bit odd and shouldn't happen */
190 if (!strcasecmp(state->tag, "subject")) {
191 ast_string_field_build(event, summary, "%s%s", event->summary, str);
192 } else if (!strcasecmp(state->tag, "location")) {
193 ast_string_field_build(event, location, "%s%s", event->location, str);
194 } else if (!strcasecmp(state->tag, "uid")) {
195 ast_string_field_build(event, uid, "%s%s", event->location, str);
196 } else if (!strcasecmp(state->tag, "organizer")) {
197 ast_string_field_build(event, organizer, "%s%s", event->organizer, str);
198 } else if (!strcasecmp(state->tag, "textdescription")) {
199 ast_string_field_build(event, description, "%s%s", event->description, str);
200 } else if (!strcasecmp(state->tag, "dtstart")) {
201 event->start = mstime_to_time_t(str);
202 } else if (!strcasecmp(state->tag, "dtend")) {
203 event->end = mstime_to_time_t(str);
204 } else if (!strcasecmp(state->tag, "busystatus")) {
205 event->busy_state = msbusy_to_bs(str);
206 } else if (!strcasecmp(state->tag, "reminderoffset")) {
207 /*XXX Currently we rely on event->start being set first which means we rely on the response order
208 * which technically should be fine since the query returns in the order we ask for, but ... */
209 event->alarm = event->start - atoi(str);
216 static void exchangecal_destructor(void *obj)
218 struct exchangecal_pvt *pvt = obj;
220 ast_debug(1, "Destroying pvt for Exchange calendar %s\n", pvt->owner->name);
222 ne_session_destroy(pvt->session);
224 ast_string_field_free_memory(pvt);
226 ao2_callback(pvt->events, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL);
228 ao2_ref(pvt->events, -1);
231 static void *unref_exchangecal(void *obj)
233 struct exchangecal_pvt *pvt = obj;
239 /* It is very important to use the return value of this function as a realloc could occur */
240 static struct ast_str *generate_exchange_uuid(struct ast_str *uid)
242 unsigned short val[8];
245 for (x = 0; x < 8; x++) {
246 val[x] = ast_random();
248 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]);
253 static int is_valid_uuid(struct ast_str *uid)
257 if (ast_str_strlen(uid) != 36) {
261 for (i = 0; i < ast_str_strlen(uid); i++) {
262 if (i == 8 || i == 13 || i == 18 || i == 23) {
263 if (ast_str_buffer(uid)[i] != '-') {
266 } 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))) {
274 static struct ast_str *xml_encode_str(struct ast_str *dst, const char *src)
279 for (tmp = src; *tmp; tmp++) {
282 strcpy(buf, """);
286 strcpy(buf, "'");
290 strcpy(buf, "&");
302 sprintf(buf, "%c", *tmp);
305 ast_str_append(&dst, 0, "%s", buf);
311 static struct ast_str *epoch_to_exchange_time(struct ast_str *dst, time_t epoch)
313 icaltimezone *utc = icaltimezone_get_utc_timezone();
314 icaltimetype tt = icaltime_from_timet_with_zone(epoch, 0, utc);
318 ast_copy_string(tmp, icaltime_as_ical_string(tt), sizeof(tmp));
319 for (i = 0; tmp[i]; i++) {
320 ast_str_append(&dst, 0, "%c", tmp[i]);
321 if (i == 3 || i == 5)
322 ast_str_append(&dst, 0, "%c", '-');
323 if (i == 10 || i == 12)
324 ast_str_append(&dst, 0, "%c", ':');
326 ast_str_append(&dst, 0, "%s", ".000");
332 static struct ast_str *bs_to_exchange_bs(struct ast_str *dst, enum ast_calendar_busy_state bs)
335 case AST_CALENDAR_BS_BUSY:
336 ast_str_set(&dst, 0, "%s", "BUSY");
339 case AST_CALENDAR_BS_BUSY_TENTATIVE:
340 ast_str_set(&dst, 0, "%s", "TENTATIVE");
344 ast_str_set(&dst, 0, "%s", "FREE");
350 static int fetch_response_reader(void *data, const char *block, size_t len)
352 struct ast_str **response = data;
355 if (!(tmp = ast_malloc(len + 1))) {
358 memcpy(tmp, block, len);
360 ast_str_append(response, 0, "%s", tmp);
366 static int auth_credentials(void *userdata, const char *realm, int attempts, char *username, char *secret)
368 struct exchangecal_pvt *pvt = userdata;
371 ast_log(LOG_WARNING, "Invalid username or password for Exchange calendar '%s'\n", pvt->owner->name);
375 ne_strnzcpy(username, pvt->user, NE_ABUFSIZ);
376 ne_strnzcpy(secret, pvt->secret, NE_ABUFSIZ);
381 static struct ast_str *exchangecal_request(struct exchangecal_pvt *pvt, const char *method, struct ast_str *req_body, struct ast_str *subdir)
383 struct ast_str *response;
389 ast_log(LOG_ERROR, "There is no private!\n");
393 if (!(response = ast_str_create(512))) {
394 ast_log(LOG_ERROR, "Could not allocate memory for response.\n");
398 snprintf(buf, sizeof(buf), "%s%s", pvt->uri.path, subdir ? ast_str_buffer(subdir) : "");
400 req = ne_request_create(pvt->session, method, buf);
401 ne_add_response_body_reader(req, ne_accept_2xx, fetch_response_reader, &response);
402 ne_set_request_body_buffer(req, ast_str_buffer(req_body), ast_str_strlen(req_body));
403 ne_add_request_header(req, "Content-type", "text/xml");
405 ret = ne_request_dispatch(req);
407 if (ret != NE_OK || !ast_str_strlen(response)) {
408 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));
416 static int exchangecal_write_event(struct ast_calendar_event *event)
418 struct ast_str *body = NULL, *response = NULL, *subdir = NULL;
419 struct ast_str *uid = NULL, *summary = NULL, *description = NULL, *organizer = NULL,
420 *location = NULL, *start = NULL, *end = NULL, *busystate = NULL;
424 ast_log(LOG_WARNING, "No event passed!\n");
428 if (!(event->start && event->end)) {
429 ast_log(LOG_WARNING, "The event must contain a start and an end\n");
432 if (!(body = ast_str_create(512)) ||
433 !(subdir = ast_str_create(32)) ||
434 !(response = ast_str_create(512))) {
435 ast_log(LOG_ERROR, "Could not allocate memory for request and response!\n");
439 if (!(uid = ast_str_create(32)) ||
440 !(summary = ast_str_create(32)) ||
441 !(description = ast_str_create(32)) ||
442 !(organizer = ast_str_create(32)) ||
443 !(location = ast_str_create(32)) ||
444 !(start = ast_str_create(32)) ||
445 !(end = ast_str_create(32)) ||
446 !(busystate = ast_str_create(32))) {
447 ast_log(LOG_ERROR, "Unable to allocate memory for request values\n");
451 if (ast_strlen_zero(event->uid)) {
452 uid = generate_exchange_uuid(uid);
454 ast_str_set(&uid, 36, "%s", event->uid);
457 if (!is_valid_uuid(uid)) {
458 ast_log(LOG_WARNING, "An invalid uid was provided, you may leave this field blank to have one generated for you\n");
462 summary = xml_encode_str(summary, event->summary);
463 description = xml_encode_str(description, event->description);
464 organizer = xml_encode_str(organizer, event->organizer);
465 location = xml_encode_str(location, event->location);
466 start = epoch_to_exchange_time(start, event->start);
467 end = epoch_to_exchange_time(end, event->end);
468 busystate = bs_to_exchange_bs(busystate, event->busy_state);
470 ast_str_append(&body, 0,
471 "<?xml version=\"1.0\"?>\n"
472 "<a:propertyupdate\n"
473 " xmlns:a=\"DAV:\"\n"
474 " xmlns:e=\"http://schemas.microsoft.com/exchange/\"\n"
475 " xmlns:mapi=\"http://schemas.microsoft.com/mapi/\"\n"
476 " xmlns:mapit=\"http://schemas.microsoft.com/mapi/proptag/\"\n"
477 " xmlns:x=\"xml:\" xmlns:cal=\"urn:schemas:calendar:\"\n"
478 " xmlns:dt=\"uuid:%s/\"\n" /* uid */
479 " xmlns:header=\"urn:schemas:mailheader:\"\n"
480 " xmlns:mail=\"urn:schemas:httpmail:\"\n"
484 " <a:contentclass>urn:content-classes:appointment</a:contentclass>\n"
485 " <e:outlookmessageclass>IPM.Appointment</e:outlookmessageclass>\n"
486 " <mail:subject>%s</mail:subject>\n" /* summary */
487 " <mail:description>%s</mail:description>\n" /* description */
488 " <header:to>%s</header:to>\n" /* organizer */
489 " <cal:location>%s</cal:location>\n" /* location */
490 " <cal:dtstart dt:dt=\"dateTime.tz\">%s</cal:dtstart>\n" /* start */
491 " <cal:dtend dt:dt=\"dateTime.tz\">%s</cal:dtend>\n" /* end */
492 " <cal:instancetype dt:dt=\"int\">0</cal:instancetype>\n"
493 " <cal:busystatus>%s</cal:busystatus>\n" /* busy_state (BUSY, FREE, BUSY_TENTATIVE) */
494 " <cal:meetingstatus>CONFIRMED</cal:meetingstatus>\n"
495 " <cal:alldayevent dt:dt=\"boolean\">0</cal:alldayevent>\n" /* XXX need to add event support for all day events */
496 " <cal:responserequested dt:dt=\"boolean\">0</cal:responserequested>\n"
497 " <mapi:finvited dt:dt=\"boolean\">1</mapi:finvited>\n"
500 "</a:propertyupdate>\n",
501 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));
502 ast_verb(0, "\n\n%s\n\n", ast_str_buffer(body));
503 ast_str_set(&subdir, 0, "/Calendar/%s.eml", ast_str_buffer(uid));
505 response = exchangecal_request(event->owner->tech_pvt, "PROPPATCH", body, subdir);
516 ast_free(description);
547 static struct ast_str *exchangecal_get_events_between(struct exchangecal_pvt *pvt, time_t start_time, time_t end_time)
549 struct ast_str *body, *response;
550 char start[80], end[80];
551 struct timeval tv = {0,};
554 tv.tv_sec = start_time;
555 ast_localtime(&tv, &tm, "UTC");
556 ast_strftime(start, sizeof(start), "%Y/%m/%d %T", &tm);
558 tv.tv_sec = end_time;
559 ast_localtime(&tv, &tm, "UTC");
560 ast_strftime(end, sizeof(end), "%Y/%m/%d %T", &tm);
562 if (!(body = ast_str_create(512))) {
563 ast_log(LOG_ERROR, "Could not allocate memory for body of request!\n");
567 ast_str_append(&body, 0,
568 "<?xml version=\"1.0\"?>\n"
569 "<g:searchrequest xmlns:g=\"DAV:\">\n"
570 " <g:sql> SELECT \"urn:schemas:calendar:location\", \"urn:schemas:httpmail:subject\",\n"
571 " \"urn:schemas:calendar:dtstart\", \"urn:schemas:calendar:dtend\",\n"
572 " \"urn:schemas:calendar:busystatus\", \"urn:schemas:calendar:instancetype\",\n"
573 " \"urn:schemas:calendar:uid\", \"urn:schemas:httpmail:textdescription\",\n"
574 " \"urn:schemas:calendar:organizer\", \"urn:schemas:calendar:reminderoffset\"\n"
575 " FROM Scope('SHALLOW TRAVERSAL OF \"%s/Calendar\"')\n"
576 " WHERE NOT \"urn:schemas:calendar:instancetype\" = 1\n"
577 " AND \"DAV:contentclass\" = 'urn:content-classes:appointment'\n"
578 " AND NOT (\"urn:schemas:calendar:dtend\" < '%s'\n"
579 " OR \"urn:schemas:calendar:dtstart\" > '%s')\n"
580 " ORDER BY \"urn:schemas:calendar:dtstart\" ASC\n"
582 "</g:searchrequest>\n", pvt->url, start, end);
584 ast_debug(5, "Request:\n%s\n", ast_str_buffer(body));
585 response = exchangecal_request(pvt, "SEARCH", body, NULL);
586 ast_debug(5, "Response:\n%s\n", ast_str_buffer(response));
592 static int update_exchangecal(struct exchangecal_pvt *pvt)
594 struct xmlstate state;
595 struct timeval now = ast_tvnow();
597 struct ast_str *response;
602 end = now.tv_sec + 60 * pvt->owner->timeframe;
603 if (!(response = exchangecal_get_events_between(pvt, start, end))) {
607 p = iks_sax_new(&state, parse_tag, parse_cdata);
608 iks_parse(p, ast_str_buffer(response), ast_str_strlen(response), 1);
609 ast_calendar_merge_events(pvt->owner, pvt->events);
615 static void *exchangecal_load_calendar(void *void_data)
617 struct exchangecal_pvt *pvt;
618 const struct ast_config *cfg;
619 struct ast_variable *v;
620 struct ast_calendar *cal = void_data;
621 ast_mutex_t refreshlock;
623 if (!(cal && (cfg = ast_calendar_config_acquire()))) {
624 ast_log(LOG_ERROR, "You must enable calendar support for res_exchangecal to load\n");
628 if (ao2_trylock(cal)) {
629 if (cal->unloading) {
630 ast_log(LOG_WARNING, "Unloading module, load_calendar cancelled.\n");
632 ast_log(LOG_WARNING, "Could not lock calendar, aborting!\n");
634 ast_calendar_config_release();
638 if (!(pvt = ao2_alloc(sizeof(*pvt), exchangecal_destructor))) {
639 ast_log(LOG_ERROR, "Could not allocate exchangecal_pvt structure for calendar: %s\n", cal->name);
640 ast_calendar_config_release();
646 if (!(pvt->events = ast_calendar_event_container_alloc())) {
647 ast_log(LOG_ERROR, "Could not allocate space for fetching events for calendar: %s\n", cal->name);
648 pvt = unref_exchangecal(pvt);
650 ast_calendar_config_release();
654 if (ast_string_field_init(pvt, 32)) {
655 ast_log(LOG_ERROR, "Couldn't allocate string field space for calendar: %s\n", cal->name);
656 pvt = unref_exchangecal(pvt);
658 ast_calendar_config_release();
662 for (v = ast_variable_browse(cfg, cal->name); v; v = v->next) {
663 if (!strcasecmp(v->name, "url")) {
664 ast_string_field_set(pvt, url, v->value);
665 } else if (!strcasecmp(v->name, "user")) {
666 ast_string_field_set(pvt, user, v->value);
667 } else if (!strcasecmp(v->name, "secret")) {
668 ast_string_field_set(pvt, secret, v->value);
672 ast_calendar_config_release();
674 if (ast_strlen_zero(pvt->url)) {
675 ast_log(LOG_WARNING, "No URL was specified for Exchange calendar '%s' - skipping.\n", cal->name);
676 pvt = unref_exchangecal(pvt);
681 if (ne_uri_parse(pvt->url, &pvt->uri) || pvt->uri.host == NULL || pvt->uri.path == NULL) {
682 ast_log(LOG_WARNING, "Could not parse url '%s' for Exchange calendar '%s' - skipping.\n", pvt->url, cal->name);
683 pvt = unref_exchangecal(pvt);
688 if (pvt->uri.scheme == NULL) {
689 pvt->uri.scheme = "http";
692 if (pvt->uri.port == 0) {
693 pvt->uri.port = ne_uri_defaultport(pvt->uri.scheme);
696 pvt->session = ne_session_create(pvt->uri.scheme, pvt->uri.host, pvt->uri.port);
697 ne_redirect_register(pvt->session);
698 ne_set_server_auth(pvt->session, auth_credentials, pvt);
699 if (!strcasecmp(pvt->uri.scheme, "https")) {
700 ne_ssl_trust_default_ca(pvt->session);
705 ast_mutex_init(&refreshlock);
707 /* Load it the first time */
708 update_exchangecal(pvt);
712 /* The only writing from another thread will be if unload is true */
714 struct timeval tv = ast_tvnow();
715 struct timespec ts = {0,};
717 ts.tv_sec = tv.tv_sec + (60 * pvt->owner->refresh);
719 ast_mutex_lock(&refreshlock);
720 while (!pvt->owner->unloading) {
721 if (ast_cond_timedwait(&pvt->owner->unload, &refreshlock, &ts) == ETIMEDOUT) {
725 ast_mutex_unlock(&refreshlock);
727 if (pvt->owner->unloading) {
728 ast_debug(10, "Skipping refresh since we got a shutdown signal\n");
732 ast_debug(10, "Refreshing after %d minute timeout\n", pvt->owner->refresh);
734 update_exchangecal(pvt);
740 static int load_module(void)
743 if (ast_calendar_register(&exchangecal_tech)) {
745 return AST_MODULE_LOAD_DECLINE;
748 return AST_MODULE_LOAD_SUCCESS;
751 static int unload_module(void)
753 ast_calendar_unregister(&exchangecal_tech);
758 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Asterisk MS Exchange Calendar Integration",
760 .unload = unload_module,
761 .load_pri = AST_MODPRI_DEVSTATE_PLUGIN,