ucs: add unique ID when creating new group
[siplcs.git] / src / core / sipe-ucs.c
blob2cee131790e2e980bf584a2b1b33cc123f702638
1 /**
2 * @file sipe-ucs.c
4 * pidgin-sipe
6 * Copyright (C) 2013 SIPE Project <http://sipe.sourceforge.net/>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * Implementation for Unified Contact Store [MS-OXWSCOS]
25 * <http://msdn.microsoft.com/en-us/library/jj194130.aspx>
28 #include <string.h>
30 #include <glib.h>
32 #include "sipe-backend.h"
33 #include "sipe-buddy.h"
34 #include "sipe-common.h"
35 #include "sipe-core.h"
36 #include "sipe-core-private.h"
37 #include "sipe-digest.h"
38 #include "sipe-ews-autodiscover.h"
39 #include "sipe-group.h"
40 #include "sipe-http.h"
41 #include "sipe-subscriptions.h"
42 #include "sipe-ucs.h"
43 #include "sipe-utils.h"
44 #include "sipe-xml.h"
46 typedef void (ucs_callback)(struct sipe_core_private *sipe_private,
47 const sipe_xml *body,
48 gpointer callback_data);
50 struct ucs_deferred {
51 ucs_callback *cb;
52 gpointer cb_data;
53 gchar *body;
56 struct ucs_request {
57 ucs_callback *cb;
58 gpointer cb_data;
59 struct sipe_http_request *request;
62 struct sipe_ucs {
63 gchar *ews_url;
64 GSList *deferred_requests;
65 GSList *pending_requests;
66 guint group_id;
67 gboolean migrated;
68 gboolean shutting_down;
71 static void sipe_ucs_deferred_free(struct sipe_core_private *sipe_private,
72 struct ucs_deferred *data)
74 if (data->cb)
75 /* Callback: aborted */
76 (*data->cb)(sipe_private, NULL, data->cb_data);
77 g_free(data->body);
78 g_free(data);
81 static void sipe_ucs_request_free(struct sipe_core_private *sipe_private,
82 struct ucs_request *data)
84 if (data->request)
85 sipe_http_request_cancel(data->request);
86 if (data->cb)
87 /* Callback: aborted */
88 (*data->cb)(sipe_private, NULL, data->cb_data);
89 g_free(data);
92 static void sipe_ucs_http_response(struct sipe_core_private *sipe_private,
93 guint status,
94 SIPE_UNUSED_PARAMETER GSList *headers,
95 const gchar *body,
96 gpointer callback_data)
98 struct ucs_request *data = callback_data;
99 struct sipe_ucs *ucs = sipe_private->ucs;
101 SIPE_DEBUG_INFO("sipe_ucs_http_response: code %d", status);
102 data->request = NULL;
104 if ((status == SIPE_HTTP_STATUS_OK) && body) {
105 sipe_xml *xml = sipe_xml_parse(body, strlen(body));
106 const sipe_xml *soap_body = sipe_xml_child(xml, "Body");
107 /* Callback: success */
108 (*data->cb)(sipe_private, soap_body, data->cb_data);
109 sipe_xml_free(xml);
110 } else {
111 /* Callback: failed */
112 (*data->cb)(sipe_private, NULL, data->cb_data);
115 /* already been called */
116 data->cb = NULL;
118 ucs->pending_requests = g_slist_remove(ucs->pending_requests,
119 data);
120 sipe_ucs_request_free(sipe_private, data);
123 static gboolean sipe_ucs_http_request(struct sipe_core_private *sipe_private,
124 const gchar *body,
125 ucs_callback *callback,
126 gpointer callback_data)
128 struct sipe_ucs *ucs = sipe_private->ucs;
129 gboolean success = FALSE;
131 if (ucs->shutting_down) {
132 SIPE_DEBUG_ERROR("sipe_ucs_http_request: new UCS request during shutdown: THIS SHOULD NOT HAPPEN! Debugging information:\n"
133 "Body: %s\n",
134 body ? body : "<EMPTY>");
136 } else if (ucs->ews_url) {
137 struct ucs_request *data = g_new0(struct ucs_request, 1);
138 gchar *soap = g_strdup_printf("<?xml version=\"1.0\"?>\r\n"
139 "<soap:Envelope"
140 " xmlns:m=\"http://schemas.microsoft.com/exchange/services/2006/messages\""
141 " xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\""
142 " xmlns:t=\"http://schemas.microsoft.com/exchange/services/2006/types\""
143 " >"
144 " <soap:Header>"
145 " <t:RequestServerVersion Version=\"Exchange2013\" />"
146 " </soap:Header>"
147 " <soap:Body>"
148 " %s"
149 " </soap:Body>"
150 "</soap:Envelope>",
151 body);
152 struct sipe_http_request *request = sipe_http_request_post(sipe_private,
153 ucs->ews_url,
154 NULL,
155 soap,
156 "text/xml; charset=UTF-8",
157 sipe_ucs_http_response,
158 data);
159 g_free(soap);
161 if (request) {
162 data->cb = callback;
163 data->cb_data = callback_data;
164 data->request = request;
166 ucs->pending_requests = g_slist_prepend(ucs->pending_requests,
167 data);
169 sipe_core_email_authentication(sipe_private,
170 request);
171 sipe_http_request_allow_redirect(request);
172 sipe_http_request_ready(request);
174 success = TRUE;
175 } else {
176 SIPE_DEBUG_ERROR_NOFORMAT("sipe_ucs_http_request: failed to create HTTP connection");
177 g_free(data);
180 } else {
181 struct ucs_deferred *data = g_new0(struct ucs_deferred, 1);
182 data->cb = callback;
183 data->cb_data = callback_data;
184 data->body = g_strdup(body);
186 ucs->deferred_requests = g_slist_prepend(ucs->deferred_requests,
187 data);
188 success = TRUE;
191 return(success);
194 static void sipe_ucs_get_user_photo_response(struct sipe_core_private *sipe_private,
195 const sipe_xml *body,
196 gpointer callback_data)
198 gchar *uri = callback_data;
199 const sipe_xml *node = sipe_xml_child(body,
200 "GetUserPhotoResponse/PictureData");
202 if (node) {
203 gchar *base64;
204 gsize photo_size;
205 guchar *photo;
206 guchar digest[SIPE_DIGEST_SHA1_LENGTH];
207 gchar *digest_string;
209 /* decode photo data */
210 base64 = sipe_xml_data(node);
211 photo = g_base64_decode(base64, &photo_size);
212 g_free(base64);
214 /* EWS doesn't provide a hash -> calculate SHA-1 digest */
215 sipe_digest_sha1(photo, photo_size, digest);
216 digest_string = buff_to_hex_str(digest,
217 SIPE_DIGEST_SHA1_LENGTH);
219 /* backend frees "photo" */
220 sipe_backend_buddy_set_photo(SIPE_CORE_PUBLIC,
221 uri,
222 photo,
223 photo_size,
224 digest_string);
225 g_free(digest_string);
228 g_free(uri);
231 void sipe_ucs_get_photo(struct sipe_core_private *sipe_private,
232 const gchar *uri)
234 gchar *payload = g_strdup(uri);
235 gchar *body = g_strdup_printf("<m:GetUserPhoto>"
236 " <m:Email>%s</m:Email>"
237 " <m:SizeRequested>HR48x48</m:SizeRequested>"
238 "</m:GetUserPhoto>",
239 sipe_get_no_sip_uri(uri));
241 if (!sipe_ucs_http_request(sipe_private,
242 body,
243 sipe_ucs_get_user_photo_response,
244 payload))
245 g_free(payload);
247 g_free(body);
250 static void sipe_ucs_ignore_response(SIPE_UNUSED_PARAMETER struct sipe_core_private *sipe_private,
251 SIPE_UNUSED_PARAMETER const sipe_xml *body,
252 SIPE_UNUSED_PARAMETER gpointer callback_data)
254 SIPE_DEBUG_INFO_NOFORMAT("sipe_ucs_ignore_response: done");
257 void sipe_ucs_group_rename(struct sipe_core_private *sipe_private,
258 struct sipe_group *group,
259 const gchar *new_name)
261 /* new_name can contain restricted characters */
262 gchar *body = g_markup_printf_escaped("<m:SetImGroup>"
263 " <m:GroupId Id=\"%s\" ChangeKey=\"%s\"/>"
264 " <m:NewDisplayName>%s</m:NewDisplayName>"
265 "</m:SetImGroup>",
266 group->exchange_key,
267 group->change_key,
268 new_name);
270 sipe_ucs_http_request(sipe_private,
271 body,
272 sipe_ucs_ignore_response,
273 NULL);
274 g_free(body);
277 void sipe_ucs_group_remove(struct sipe_core_private *sipe_private,
278 struct sipe_group *group)
280 gchar *body = g_strdup_printf("<m:RemoveImGroup>"
281 " <m:GroupId Id=\"%s\" ChangeKey=\"%s\"/>"
282 "</m:RemoveImGroup>",
283 group->exchange_key,
284 group->change_key);
286 sipe_ucs_http_request(sipe_private,
287 body,
288 sipe_ucs_ignore_response,
289 NULL);
290 g_free(body);
293 static void sipe_ucs_get_im_item_list_response(struct sipe_core_private *sipe_private,
294 const sipe_xml *body,
295 SIPE_UNUSED_PARAMETER gpointer callback_data)
297 const sipe_xml *node = sipe_xml_child(body,
298 "GetImItemListResponse/ImItemList");
300 if (node) {
301 const sipe_xml *persona_node;
302 const sipe_xml *group_node;
304 /* Start processing contact list */
305 sipe_backend_buddy_list_processing_start(SIPE_CORE_PUBLIC);
307 for (persona_node = sipe_xml_child(node, "Personas/Persona");
308 persona_node;
309 persona_node = sipe_xml_twin(persona_node)) {
310 gchar *address = sipe_xml_data(sipe_xml_child(persona_node,
311 "ImAddress"));
312 const gchar *key = NULL;
313 const gchar *change = NULL;
314 const sipe_xml *attr_node;
316 /* extract Exchange key - not sure if this is correct */
317 for (attr_node = sipe_xml_child(persona_node,
318 "Attributions/Attribution");
319 attr_node;
320 attr_node = sipe_xml_twin(attr_node)) {
321 const sipe_xml *id_node = sipe_xml_child(attr_node,
322 "SourceId");
323 gchar *type = sipe_xml_data(sipe_xml_child(attr_node,
324 "DisplayName"));
325 if (id_node &&
326 sipe_strequal(type, "Lync Contacts")) {
327 key = sipe_xml_attribute(id_node, "Id");
328 change = sipe_xml_attribute(id_node, "ChangeKey");
329 g_free(type);
330 break;
332 g_free(type);
335 if (!(is_empty(address) || is_empty(key) || is_empty(change))) {
336 gchar *uri = sip_uri_from_name(address);
337 struct sipe_buddy *buddy = sipe_buddy_add(sipe_private,
338 uri,
339 key,
340 change);
341 g_free(uri);
343 SIPE_DEBUG_INFO("sipe_ucs_get_im_item_list_response: persona URI '%s' key '%s' change '%s'",
344 buddy->name, key, change);
346 g_free(address);
349 for (group_node = sipe_xml_child(node, "Groups/ImGroup");
350 group_node;
351 group_node = sipe_xml_twin(group_node)) {
352 const sipe_xml *id_node = sipe_xml_child(group_node,
353 "ExchangeStoreId");
354 const gchar *key = sipe_xml_attribute(id_node, "Id");
355 const gchar *change = sipe_xml_attribute(id_node, "ChangeKey");
357 if (!(is_empty(key) || is_empty(change))) {
358 gchar *name = sipe_xml_data(sipe_xml_child(group_node,
359 "DisplayName"));
360 struct sipe_group *group = sipe_group_add(sipe_private,
361 name,
362 key,
363 change,
364 /* sipe_group must have unique ID */
365 ++sipe_private->ucs->group_id);
366 const sipe_xml *member_node;
368 g_free(name);
370 if (group) {
371 SIPE_DEBUG_INFO("sipe_ucs_get_im_item_list_response: group '%s' key '%s' change '%s'",
372 group->name, key, change);
374 for (member_node = sipe_xml_child(group_node,
375 "MemberCorrelationKey/ItemId");
376 member_node;
377 member_node = sipe_xml_twin(member_node)) {
378 struct sipe_buddy *buddy = sipe_buddy_find_by_exchange_key(sipe_private,
379 sipe_xml_attribute(member_node,
380 "Id"));
381 if (buddy)
382 sipe_buddy_add_to_group(sipe_private,
383 buddy,
384 group,
385 /* alias will be set via buddy presence update */
386 NULL);
392 /* Finished processing contact list */
393 sipe_buddy_cleanup_local_list(sipe_private);
394 sipe_backend_buddy_list_processing_finish(SIPE_CORE_PUBLIC);
395 sipe_subscribe_presence_initial(sipe_private);
399 static void ucs_ews_autodiscover_cb(struct sipe_core_private *sipe_private,
400 const struct sipe_ews_autodiscover_data *ews_data,
401 SIPE_UNUSED_PARAMETER gpointer callback_data)
403 struct sipe_ucs *ucs = sipe_private->ucs;
404 const gchar *ews_url;
406 if (!ucs || !ews_data)
407 return;
409 ews_url = ews_data->ews_url;
410 if (is_empty(ews_url)) {
411 SIPE_DEBUG_ERROR_NOFORMAT("ucs_ews_autodiscover_cb: can't detect EWS URL, contact list operations will not work!");
412 return;
415 SIPE_DEBUG_INFO("ucs_ews_autodiscover_cb: EWS URL '%s'", ews_url);
416 ucs->ews_url = g_strdup(ews_url);
418 /* Request migrated contact list */
419 if (ucs->migrated)
420 sipe_ucs_http_request(sipe_private,
421 "<m:GetImItemList/>",
422 sipe_ucs_get_im_item_list_response,
423 NULL);
425 /* EWS URL is valid, send all deferred requests now */
426 if (ucs->deferred_requests) {
427 GSList *entry = ucs->deferred_requests;
428 while (entry) {
429 struct ucs_deferred *data = entry->data;
431 sipe_ucs_http_request(sipe_private,
432 data->body,
433 data->cb,
434 data->cb_data);
436 /* callback & data has been forwarded */
437 data->cb = NULL;
438 sipe_ucs_deferred_free(sipe_private, data);
440 entry = entry->next;
442 g_slist_free(ucs->deferred_requests);
443 ucs->deferred_requests = NULL;
447 gboolean sipe_ucs_is_migrated(struct sipe_core_private *sipe_private)
449 return(sipe_private->ucs ? sipe_private->ucs->migrated : FALSE);
452 void sipe_ucs_init(struct sipe_core_private *sipe_private,
453 gboolean migrated)
455 struct sipe_ucs *ucs;
457 if (sipe_private->ucs)
458 return;
460 sipe_private->ucs = ucs = g_new0(struct sipe_ucs, 1);
461 ucs->migrated = migrated;
463 sipe_ews_autodiscover_start(sipe_private,
464 ucs_ews_autodiscover_cb,
465 NULL);
468 void sipe_ucs_free(struct sipe_core_private *sipe_private)
470 struct sipe_ucs *ucs = sipe_private->ucs;
472 if (!ucs)
473 return;
475 /* UCS stack is shutting down: reject all new requests */
476 ucs->shutting_down = TRUE;
478 if (ucs->deferred_requests) {
479 GSList *entry = ucs->deferred_requests;
480 while (entry) {
481 sipe_ucs_deferred_free(sipe_private, entry->data);
482 entry = entry->next;
484 g_slist_free(ucs->deferred_requests);
487 if (ucs->pending_requests) {
488 GSList *entry = ucs->pending_requests;
489 while (entry) {
490 sipe_ucs_request_free(sipe_private, entry->data);
491 entry = entry->next;
493 g_slist_free(ucs->pending_requests);
496 g_free(ucs->ews_url);
497 g_free(ucs);
498 sipe_private->ucs = NULL;
502 Local Variables:
503 mode: c
504 c-file-style: "bsd"
505 indent-tabs-mode: t
506 tab-width: 8
507 End: