soap: fix crash in temporary hack
[siplcs.git] / src / core / sipe-domino.c
blobfafae09bba1d49bec6ef7d665a097a506db9b473
1 /**
2 * @file sipe-domino.c
4 * pidgin-sipe
6 * Copyright (C) 2010-2013 SIPE Project <http://sipe.sourceforge.net/>
7 * Copyright (C) 2010 pier11 <pier11@operamail.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 /**
26 For communication with Lotus Domino groupware server.
28 Server requirements: Domino 5.0.2 and above with Web Access.
30 1) Tries to read user's notes.ini for mail database name.
31 Windows registry keys for notes.ini location:
32 HKEY_CURRENT_USER\Software\Lotus\Notes\6.0\NotesIniPath
34 2) Authenticates to server (HTTPS POST, plaintext login/password over SSL)
35 https://[domino_server]/[databasename].nsf/?Login
36 Content-Type=application/x-www-form-urlencoded
37 Username=[email]&Password=[password] (params are url-encoded)
38 Saves auth cookie.
39 Set-Cookie=DomAuthSessId=17D0428F7B9D57D4D0B064AE42FD21F9; path=/
41 3) Queries Calendar data (HTTPS GET, result is XML)
42 https://[domino_server]/[databasename].nsf/[viewname]?ReadViewEntries
43 https://[domino_server]/[databasename].nsf/($Calendar)?ReadViewEntries&KeyType=time&StartKey=20090805T000000Z&UntilKey=20090806T000000Z&Count=-1&TZType=UTC
44 Uses auth cookie.
45 Cookie=DomAuthSessId=17D0428F7B9D57D4D0B064AE42FD21F9
47 It is able to retrieve our Calendar information (Meetings schedule,
48 subject and location) from Lotus Domino for subsequent publishing.
50 Ref. for more implementation details:
51 https://sourceforge.net/tracker/?func=detail&aid=2945346&group_id=194563&atid=949934
53 Similar functionality for iCalendar/CalDAV/Google would be great to implement too.
56 #ifdef HAVE_CONFIG_H
57 #include "config.h"
58 #endif
60 #include <string.h>
61 #include <ctype.h>
62 #include <stdio.h>
63 #include <errno.h>
64 #include <time.h>
66 #include <glib.h>
68 /* for registry read */
69 #ifdef _WIN32
70 #include "sipe-win32dep.h"
71 #endif
73 #include "sipe-backend.h"
74 #include "sipe-common.h"
75 #include "sipe-cal.h"
76 #include "sipe-core.h"
77 #include "sipe-core-private.h"
78 #include "sipe-domino.h"
79 #include "sipe-http.h"
80 #include "sipe-nls.h"
81 #include "sipe-utils.h"
82 #include "sipe-xml.h"
84 /**
85 * POST request for Login to Domino server
86 * @param email (%s) Should be URL-encoded. Ex.: alice@cosmo.local
87 * @param password (%s) Should be URL-encoded.
89 #define SIPE_DOMINO_LOGIN_REQUEST \
90 "Username=%s&Password=%s"
92 /**
93 * GET request to Domino server
94 * to obtain our Calendar information.
95 * @param start_time (%s) Ex.: 20090805T000000Z
96 * @param end_time (%s) Ex.: 20090806T000000Z
98 #define SIPE_DOMINO_CALENDAR_REQUEST \
99 "/($Calendar)?ReadViewEntries&KeyType=time&StartKey=%s&UntilKey=%s&Count=-1&TZType=UTC"
102 <?xml version="1.0" encoding="UTF-8"?>
103 <viewentries timestamp="20100416T112140,02Z" toplevelentries="77" rangeentries="
104 1000">
105 <viewentry position="77" unid="C3A77CC76EAA7D08802576FD0043D7D0" noteid="27B42" siblings="77">
106 <entrydata columnnumber="0" name="$134">
107 <datetime>20100423T103000,00Z</datetime>
108 </entrydata>
109 <entrydata columnnumber="1" name="$149">
110 <number>158</number>
111 </entrydata>
112 <entrydata columnnumber="2" name="$144">
113 <datetime>20100423T103000,00Z</datetime>
114 </entrydata>
115 <entrydata columnnumber="3" name="$145">
116 <text>-</text>
117 </entrydata>
118 <entrydata columnnumber="4" name="$146">
119 <datetime>20100423T120000,00Z</datetime>
120 </entrydata>
121 <entrydata columnnumber="5" name="$147">
122 <textlist>
123 <text>G. S. ..I. L. T. Hall</text>
124 <text>Location: Auditorium - W. House</text>
125 <text>Chair: S. S.</text>
126 </textlist>
127 </entrydata>
128 </viewentry>
129 <viewentry .........
130 </viewentries>
133 #define VIEWENTITY_START0_TIME "$134"
134 #define VIEWENTITY_START_TIME "$144"
135 #define VIEWENTITY_END_TIME "$146"
136 #define VIEWENTITY_TEXT_LIST "$147"
139 static int
140 sipe_domino_get_slot_no(time_t fb_start, time_t in)
142 return (in - fb_start) / SIPE_FREE_BUSY_GRANULARITY_SEC;
145 static char *
146 sipe_domino_get_free_busy(time_t fb_start,
147 GSList *cal_events)
149 GSList *entry = cal_events;
150 char *res;
152 if (!cal_events) return NULL;
154 res = g_strnfill(SIPE_FREE_BUSY_PERIOD_SEC / SIPE_FREE_BUSY_GRANULARITY_SEC,
155 SIPE_CAL_FREE + '0');
157 while (entry) {
158 struct sipe_cal_event *cal_event = entry->data;
159 int start = sipe_domino_get_slot_no(fb_start, cal_event->start_time);
160 int end = sipe_domino_get_slot_no(fb_start, (cal_event->end_time - 1));
161 int i;
163 for (i = start; i <= end; i++) {
164 res[i] = SIPE_CAL_BUSY + '0';
166 entry = entry->next;
168 SIPE_DEBUG_INFO("sipe_domino_get_free_busy: res=\n%s", res);
169 return res;
172 static void sipe_domino_process_calendar_response(struct sipe_core_private *sipe_private,
173 guint status,
174 GSList *headers,
175 const gchar *body,
176 gpointer data)
178 struct sipe_calendar *cal = data;
179 const gchar *content_type = sipe_utils_nameval_find(headers, "Content-Type");
181 SIPE_DEBUG_INFO_NOFORMAT("sipe_domino_process_calendar_response: cb started.");
183 cal->request = NULL;
185 if (content_type && !g_str_has_prefix(content_type, "text/xml")) {
186 cal->is_domino_disabled = TRUE;
187 SIPE_DEBUG_INFO_NOFORMAT("sipe_domino_process_calendar_response: not XML, disabling.");
188 return;
191 if ((status == SIPE_HTTP_STATUS_OK) && body) {
192 const sipe_xml *node, *node2, *node3;
193 sipe_xml *xml;
195 SIPE_DEBUG_INFO("sipe_domino_process_calendar_response: SUCCESS, ret=%d", status);
196 xml = sipe_xml_parse(body, strlen(body));
198 sipe_cal_events_free(cal->cal_events);
199 cal->cal_events = NULL;
200 /* viewentry */
201 for (node = sipe_xml_child(xml, "viewentry");
202 node;
203 node = sipe_xml_twin(node))
205 struct sipe_cal_event *cal_event = g_new0(struct sipe_cal_event, 1);
206 cal->cal_events = g_slist_append(cal->cal_events, cal_event);
207 cal_event->cal_status = SIPE_CAL_BUSY;
208 cal_event->is_meeting = TRUE;
210 /* SIPE_DEBUG_INFO("viewentry unid=%s", sipe_xml_attribute(node, "unid")); */
212 /* entrydata */
213 for (node2 = sipe_xml_child(node, "entrydata");
214 node2;
215 node2 = sipe_xml_twin(node2))
217 const char *name = sipe_xml_attribute(node2, "name");
219 SIPE_DEBUG_INFO("\tentrydata name=%s", name);
221 if (sipe_strequal(name, VIEWENTITY_START0_TIME) ||
222 sipe_strequal(name, VIEWENTITY_START_TIME) ||
223 sipe_strequal(name, VIEWENTITY_END_TIME))
225 char *tmp = sipe_xml_data(sipe_xml_child(node2, "datetime"));
226 time_t time_val = sipe_utils_str_to_time(tmp);
228 if (sipe_strequal(name, VIEWENTITY_START_TIME)) {
229 cal_event->start_time = time_val;
230 } else if (sipe_strequal(name, VIEWENTITY_END_TIME)) {
231 cal_event->end_time = time_val;
234 SIPE_DEBUG_INFO("\t\tdatetime=%s", asctime(gmtime(&time_val)));
235 g_free(tmp);
236 } else if (sipe_strequal(name, VIEWENTITY_TEXT_LIST)) {
237 int i = 0;
239 /* test */
240 for (node3 = sipe_xml_child(node2, "textlist/text");
241 node3;
242 node3 = sipe_xml_twin(node3))
244 char *tmp = sipe_xml_data(node3);
246 if (!tmp) continue;
248 SIPE_DEBUG_INFO("\t\ttext=%s", tmp);
249 if (i == 0) {
250 cal_event->subject = g_strdup(tmp);
251 SIPE_DEBUG_INFO("\t\t*Subj.=%s", tmp);
252 } else {
253 /* plain English, don't localize! */
254 if (!g_ascii_strncasecmp(tmp, "Location:", 9)) {
255 if (strlen(tmp) > 9) {
256 cal_event->location = g_strdup(g_strstrip(tmp+9));
257 SIPE_DEBUG_INFO("\t\t*Loc.=%s", cal_event->location);
259 /* Translators: (!) should be as in localized Lotus Notes to be able to extract meeting location */
260 } else if (g_str_has_prefix(tmp, _("Location:"))) {
261 guint len = strlen(_("Location:"));
262 if (strlen(tmp) > len) {
263 cal_event->location = g_strdup(g_strstrip(tmp+len));
264 SIPE_DEBUG_INFO("\t\t*Loc.=%s", cal_event->location);
268 i++;
269 g_free(tmp);
274 sipe_xml_free(xml);
276 /* creates FreeBusy from cal->cal_events */
277 g_free(cal->free_busy);
278 cal->free_busy = sipe_domino_get_free_busy(cal->fb_start, cal->cal_events);
280 /* update SIP server */
281 cal->is_updated = TRUE;
282 sipe_cal_presence_publish(sipe_private, TRUE);
284 } else if (!headers) {
285 SIPE_DEBUG_INFO("sipe_domino_process_calendar_response: rather FAILURE, ret=%d", status);
288 sipe_http_session_close(cal->session);
289 cal->session = NULL;
292 /* Domino doesn't like '-' and ':' in ISO timestamps */
293 static gchar *
294 sipe_domino_time_to_str(time_t timestamp)
296 char *res, *tmp;
298 res = sipe_utils_time_to_str(timestamp);
299 res = sipe_utils_str_replace((tmp = res), "-", "");
300 g_free(tmp);
301 res = sipe_utils_str_replace((tmp = res), ":", "");
302 g_free(tmp);
304 return res;
307 static void sipe_domino_send_http_request(struct sipe_calendar *cal)
309 if (cal->request) {
310 sipe_core_email_authentication(cal->sipe_private,
311 cal->request);
312 sipe_http_request_session(cal->request, cal->session);
313 sipe_http_request_ready(cal->request);
317 static void sipe_domino_do_calendar_request(struct sipe_calendar *cal)
319 if (cal->domino_url) {
320 char *url_req;
321 char *url;
322 time_t end;
323 time_t now = time(NULL);
324 char *start_str;
325 char *end_str;
326 struct tm *now_tm;
328 SIPE_DEBUG_INFO_NOFORMAT("sipe_domino_do_calendar_request: going Calendar req.");
330 now_tm = gmtime(&now);
331 /* start -1 day, 00:00:00 */
332 now_tm->tm_sec = 0;
333 now_tm->tm_min = 0;
334 now_tm->tm_hour = 0;
335 cal->fb_start = sipe_mktime_tz(now_tm, "UTC");
336 cal->fb_start -= 24*60*60;
337 /* end = start + 4 days - 1 sec */
338 end = cal->fb_start + SIPE_FREE_BUSY_PERIOD_SEC - 1;
340 start_str = sipe_domino_time_to_str(cal->fb_start);
341 end_str = sipe_domino_time_to_str(end);
343 url_req = g_strdup_printf(SIPE_DOMINO_CALENDAR_REQUEST, start_str, end_str);
344 g_free(start_str);
345 g_free(end_str);
347 url = g_strconcat(cal->domino_url, url_req, NULL);
348 g_free(url_req);
349 cal->request = sipe_http_request_get(cal->sipe_private,
350 url,
351 NULL,
352 sipe_domino_process_calendar_response,
353 cal);
354 g_free(url);
356 sipe_domino_send_http_request(cal);
360 static void sipe_domino_process_login_response(SIPE_UNUSED_PARAMETER struct sipe_core_private *sipe_private,
361 guint status,
362 GSList *headers,
363 /* temporary? */
364 SIPE_UNUSED_PARAMETER const gchar *body,
365 gpointer data)
367 struct sipe_calendar *cal = data;
369 SIPE_DEBUG_INFO_NOFORMAT("sipe_domino_process_login_response: cb started.");
371 cal->request = NULL;
373 if ((status >= SIPE_HTTP_STATUS_OK) &&
374 (status < SIPE_HTTP_STATUS_CLIENT_ERROR)) {
375 SIPE_DEBUG_INFO("sipe_domino_process_login_response: rather SUCCESS, ret=%d", status);
377 /* next query */
378 sipe_domino_do_calendar_request(cal);
380 } else if (!headers ||
381 (status >= SIPE_HTTP_STATUS_CLIENT_ERROR)) {
382 SIPE_DEBUG_INFO("sipe_domino_process_login_response: rather FAILURE, ret=%d", status);
384 /* stop here */
385 /* cal->is_domino_disabled = TRUE; */
389 static gchar *sipe_domino_uri_escape(const gchar *string)
391 gchar *escaped;
393 if (!string) return(NULL);
394 if (!g_utf8_validate(string, -1, NULL)) return(NULL);
396 #if GLIB_CHECK_VERSION(2,16,0)
397 escaped = g_uri_escape_string(string, NULL, FALSE);
398 #else
399 /* loosely based on libpurple/util.c:purple_url_encode() */
401 GString *buf = g_string_new(NULL);
403 while (*string) {
404 gunichar c = g_utf8_get_char(string);
406 /* If the character is an ASCII character and is alphanumeric
407 * no need to escape */
408 if (c < 128 &&
409 (isalnum(c) || c == '-' || c == '.' || c == '_' || c == '~')) {
410 g_string_append_c(buf, c);
411 } else {
412 gchar *p, utf_char[6];
413 guint bytes = g_unichar_to_utf8(c, utf_char);
415 p = utf_char;
416 while (bytes-- > 0) {
417 g_string_append_printf(buf,
418 "%%%02X",
419 *p++ & 0xff);
423 string = g_utf8_next_char(string);
426 escaped = g_string_free(buf, FALSE);
428 #endif
430 return(escaped);
433 static void
434 sipe_domino_do_login_request(struct sipe_calendar *cal)
436 if (cal->domino_url) {
437 struct sipe_core_private *sipe_private = cal->sipe_private;
438 char *body;
439 const char *content_type = "application/x-www-form-urlencoded";
440 char *login_url = g_strconcat(cal->domino_url, "/?Login", NULL);
441 char *user;
442 gchar *password = sipe_private->email_password ? sipe_private->email_password : sipe_private->password;
444 SIPE_DEBUG_INFO_NOFORMAT("sipe_domino_do_login_request: going Login req.");
446 if (!password) return;
448 /* @TODO replace purple_url_encode() with non-purple equiv. */
449 user = sipe_domino_uri_escape(cal->email);
450 password = sipe_domino_uri_escape(password);
452 body = g_strdup_printf(SIPE_DOMINO_LOGIN_REQUEST, user, password);
453 g_free(user);
454 g_free(password);
456 cal->request = sipe_http_request_post(sipe_private,
457 login_url,
458 NULL,
459 body,
460 content_type,
461 sipe_domino_process_login_response,
462 cal);
463 g_free(login_url);
464 g_free(body);
466 sipe_domino_send_http_request(cal);
470 /* in notes.ni
471 MailFile=mail5\mhe111bm.nsf
472 MailServer=CN=MSGM2222/OU=srv/O=xxcom
474 Output values should be freed if requested.
476 static void
477 sipe_domino_read_notes_ini(const char *filename_with_path, char **mail_server, char **mail_file)
479 char rbuf[256];
480 FILE *fp = fopen(filename_with_path, "r+");
482 if (fp) {
483 while (fgets(rbuf, sizeof (rbuf), fp)) {
484 char *prop = "MailFile=";
485 guint prop_len = strlen(prop);
487 /* SIPE_DEBUG_INFO("\t%s (%"G_GSIZE_FORMAT")", rbuf, strlen(rbuf)); */
488 if (mail_file && !g_ascii_strncasecmp(rbuf, prop, prop_len) && (strlen(rbuf) > prop_len)) {
489 *mail_file = g_strdup(g_strstrip((rbuf+prop_len)));
492 prop = "MailServer=";
493 prop_len = strlen(prop);
495 if (mail_server && !g_ascii_strncasecmp(rbuf, prop, prop_len) && (strlen(rbuf) > prop_len)) {
496 *mail_server = g_strdup(g_strstrip((rbuf+prop_len)));
499 fclose(fp);
500 } else {
501 SIPE_DEBUG_ERROR("sipe_domino_read_notes_ini(): could not open `%s': %s", filename_with_path, g_strerror (errno));
506 @param protocol Ex.: https
507 @param mail_server Ex.: CN=MSGM2222/OU=srv/O=xxcom
508 @param mail_file Ex.: mail5\mhe111bm.nsf
510 @return Ex.: https://msgm2222/mail5/mhe111bm.nsf
512 static char *
513 sipe_domino_compose_url(const char *protocol, const char *mail_server, const char *mail_file)
515 const char *ptr;
516 char *tmp, *tmp2, *tmp3;
518 g_return_val_if_fail(protocol, NULL);
519 g_return_val_if_fail(mail_server, NULL);
520 g_return_val_if_fail(mail_file, NULL);
522 /* mail_server: exptacting just common name */
523 if ((ptr = strstr(mail_server, "/"))) {
524 tmp = g_strndup(mail_server, (ptr-mail_server));
525 } else {
526 tmp = g_strdup(mail_server);
528 if ((!g_ascii_strncasecmp(tmp, "CN=", 3))) {
529 tmp2 = g_strdup(tmp+3);
530 } else {
531 tmp2 = g_strdup(tmp);
533 g_free(tmp);
534 tmp = g_ascii_strdown(tmp2, -1);
535 g_free(tmp2);
537 /* mail_file */
538 tmp3 = sipe_utils_str_replace(mail_file, "\\", "/");
540 tmp2 = g_strconcat(protocol, "://", tmp, "/", tmp3, NULL);
541 g_free(tmp);
542 g_free(tmp3);
544 return tmp2;
547 void
548 sipe_domino_update_calendar(struct sipe_core_private *sipe_private)
550 struct sipe_calendar* cal;
552 SIPE_DEBUG_INFO_NOFORMAT("sipe_domino_update_calendar: started.");
554 sipe_cal_calendar_init(sipe_private);
556 /* check if URL is valid if provided */
557 cal = sipe_private->calendar;
558 if (cal && !is_empty(cal->domino_url)) {
559 char *tmp = g_ascii_strdown(cal->domino_url, -1);
560 if (!g_str_has_suffix(tmp, ".nsf")) {
561 /* not valid Domino mail services URL */
562 cal->is_domino_disabled = TRUE;
563 SIPE_DEBUG_INFO_NOFORMAT("sipe_domino_update_calendar: invalid Domino URI supplied, disabling.");
565 g_free(tmp);
568 /* Autodiscovery.
569 * Searches location of notes.ini in Registry, reads it, extracts mail server and mail file,
570 * composes HTTPS URL to Domino web, basing on that
572 if (cal && is_empty(cal->domino_url)) {
573 char *path = NULL;
574 #ifdef _WIN32
575 /* fine for Notes 8.5 too */
576 path = wpurple_read_reg_expand_string(HKEY_CURRENT_USER, "Software\\Lotus\\Notes\\8.0", "NotesIniPath");
577 if (is_empty(path)) {
578 g_free(path);
579 path = wpurple_read_reg_expand_string(HKEY_CURRENT_USER, "Software\\Lotus\\Notes\\7.0", "NotesIniPath");
580 if (is_empty(path)) {
581 g_free(path);
582 path = wpurple_read_reg_expand_string(HKEY_CURRENT_USER, "Software\\Lotus\\Notes\\6.0", "NotesIniPath");
583 if (is_empty(path)) {
584 g_free(path);
585 path = wpurple_read_reg_expand_string(HKEY_CURRENT_USER, "Software\\Lotus\\Notes\\5.0", "NotesIniPath");
589 SIPE_DEBUG_INFO("sipe_domino_update_calendar: notes.ini path:\n%s", path ? path : "");
590 #else
591 /* How to know location of notes.ini on *NIX ? */
592 #endif
594 /* get server url */
595 if (path) {
596 char *mail_server = NULL;
597 char *mail_file = NULL;
599 sipe_domino_read_notes_ini(path, &mail_server, &mail_file);
600 g_free(path);
601 SIPE_DEBUG_INFO("sipe_domino_update_calendar: mail_server=%s", mail_server ? mail_server : "");
602 SIPE_DEBUG_INFO("sipe_domino_update_calendar: mail_file=%s", mail_file ? mail_file : "");
604 g_free(cal->domino_url);
605 cal->domino_url = sipe_domino_compose_url("https", mail_server, mail_file);
606 g_free(mail_server);
607 g_free(mail_file);
608 SIPE_DEBUG_INFO("sipe_domino_update_calendar: cal->domino_url=%s", cal->domino_url ? cal->domino_url : "");
609 } else {
610 /* No domino_url, no path discovered, disabling */
611 cal->is_domino_disabled = TRUE;
612 SIPE_DEBUG_INFO_NOFORMAT("sipe_domino_update_calendar: Domino URI hasn't been discovered, neither provided, disabling.");
616 if (cal) {
618 if (cal->is_domino_disabled) {
619 SIPE_DEBUG_INFO_NOFORMAT("sipe_domino_update_calendar: disabled, exiting.");
620 return;
623 /* re-create session */
624 sipe_http_session_close(cal->session);
625 cal->session = sipe_http_session_start();
627 sipe_domino_do_login_request(cal);
630 SIPE_DEBUG_INFO_NOFORMAT("sipe_domino_update_calendar: finished.");
634 Local Variables:
635 mode: c
636 c-file-style: "bsd"
637 indent-tabs-mode: t
638 tab-width: 8
639 End: