src/core/sipe-ucs.c

   1 /**
   2  * @file sipe-ucs.c
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2013 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  *
   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.
  13  *
  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.
  18  *
  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
  22  *
  23  *
  24  * Implementation for Unified Contact Store [MS-OXWSCOS]
  25  *  <http://msdn.microsoft.com/en-us/library/jj194130.aspx>
  26  */
  27
  28 #include <string.h>
  29
  30 #include <glib.h>
  31
  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"
  45
  46 typedef void (ucs_callback)(struct sipe_core_private *sipe_private,
  47                             const sipe_xml *body,
  48                             gpointer callback_data);
  49
  50 struct ucs_deferred {
  51         ucs_callback *cb;
  52         gpointer cb_data;
  53         gchar *body;
  54 };
  55
  56 struct ucs_request {
  57         ucs_callback *cb;
  58         gpointer cb_data;
  59         struct sipe_http_request *request;
  60 };
  61
  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;
  69 };
  70
  71 static void sipe_ucs_deferred_free(struct sipe_core_private *sipe_private,
  72                                    struct ucs_deferred *data)
  73 {
  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);
  79 }
  80
  81 static void sipe_ucs_request_free(struct sipe_core_private *sipe_private,
  82                                   struct ucs_request *data)
  83 {
  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);
  90 }
  91
  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)
  97 {
  98         struct ucs_request *data = callback_data;
  99         struct sipe_ucs *ucs = sipe_private->ucs;
 100
 101         SIPE_DEBUG_INFO("sipe_ucs_http_response: code %d", status);
 102         data->request = NULL;
 103
 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);
 113         }
 114
 115         /* already been called */
 116         data->cb = NULL;
 117
 118         ucs->pending_requests = g_slist_remove(ucs->pending_requests,
 119                                                data);
 120         sipe_ucs_request_free(sipe_private, data);
 121 }
 122
 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)
 127 {
 128         struct sipe_ucs *ucs = sipe_private->ucs;
 129         gboolean success = FALSE;
 130
 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>");
 135
 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);
 160
 161                 if (request) {
 162                         data->cb      = callback;
 163                         data->cb_data = callback_data;
 164                         data->request = request;
 165
 166                         ucs->pending_requests = g_slist_prepend(ucs->pending_requests,
 167                                                                 data);
 168
 169                         sipe_core_email_authentication(sipe_private,
 170                                                        request);
 171                         sipe_http_request_allow_redirect(request);
 172                         sipe_http_request_ready(request);
 173
 174                         success = TRUE;
 175                 } else {
 176                         SIPE_DEBUG_ERROR_NOFORMAT("sipe_ucs_http_request: failed to create HTTP connection");
 177                         g_free(data);
 178                 }
 179
 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);
 185
 186                 ucs->deferred_requests = g_slist_prepend(ucs->deferred_requests,
 187                                                          data);
 188                 success = TRUE;
 189         }
 190
 191         return(success);
 192 }
 193
 194 static void sipe_ucs_get_user_photo_response(struct sipe_core_private *sipe_private,
 195                                              const sipe_xml *body,
 196                                              gpointer callback_data)
 197 {
 198         gchar *uri = callback_data;
 199         const sipe_xml *node = sipe_xml_child(body,
 200                                               "GetUserPhotoResponse/PictureData");
 201
 202         if (node) {
 203                 gchar *base64;
 204                 gsize photo_size;
 205                 guchar *photo;
 206                 guchar digest[SIPE_DIGEST_SHA1_LENGTH];
 207                 gchar *digest_string;
 208
 209                 /* decode photo data */
 210                 base64 = sipe_xml_data(node);
 211                 photo = g_base64_decode(base64, &photo_size);
 212                 g_free(base64);
 213
 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);
 218
 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);
 226         }
 227
 228         g_free(uri);
 229 }
 230
 231 void sipe_ucs_get_photo(struct sipe_core_private *sipe_private,
 232                         const gchar *uri)
 233 {
 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));
 240
 241         if (!sipe_ucs_http_request(sipe_private,
 242                                    body,
 243                                    sipe_ucs_get_user_photo_response,
 244                                    payload))
 245                 g_free(payload);
 246
 247         g_free(body);
 248 }
 249
 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)
 253 {
 254         SIPE_DEBUG_INFO_NOFORMAT("sipe_ucs_ignore_response: done");
 255 }
 256
 257 void sipe_ucs_group_remove_buddy(struct sipe_core_private *sipe_private,
 258                                  struct sipe_group *group,
 259                                  struct sipe_buddy *buddy)
 260 {
 261         if (group) {
 262                 /*
 263                  * If a contact is removed from last group, it will also be
 264                  * removed from contact list completely. The documentation has
 265                  * a RemoveContactFromImList operation, but that doesn't seem
 266                  * to work at all, i.e. it is always rejected by the server.
 267                  */
 268                 gchar *body = g_strdup_printf("<m:RemoveImContactFromGroup>"
 269                                               " <m:ContactId Id=\"%s\" ChangeKey=\"%s\"/>"
 270                                               " <m:GroupId Id=\"%s\" ChangeKey=\"%s\"/>"
 271                                               "</m:RemoveImContactFromGroup>",
 272                                               buddy->exchange_key,
 273                                               buddy->change_key,
 274                                               group->exchange_key,
 275                                               group->change_key);
 276
 277                 sipe_ucs_http_request(sipe_private,
 278                                       body,
 279                                       sipe_ucs_ignore_response,
 280                                       NULL);
 281                 g_free(body);
 282         }
 283 }
 284
 285 static struct sipe_group *ucs_create_group(struct sipe_core_private *sipe_private,
 286                                            const sipe_xml *group_node)
 287 {
 288         const sipe_xml *id_node = sipe_xml_child(group_node,
 289                                                  "ExchangeStoreId");
 290         const gchar *key = sipe_xml_attribute(id_node, "Id");
 291         const gchar *change = sipe_xml_attribute(id_node, "ChangeKey");
 292         struct sipe_group *group = NULL;
 293
 294         if (!(is_empty(key) || is_empty(change))) {
 295                 gchar *name = sipe_xml_data(sipe_xml_child(group_node,
 296                                                            "DisplayName"));
 297                 group = sipe_group_add(sipe_private,
 298                                        name,
 299                                        key,
 300                                        change,
 301                                        /* sipe_group must have unique ID */
 302                                        ++sipe_private->ucs->group_id);
 303                 g_free(name);
 304         }
 305
 306         return(group);
 307 }
 308
 309 static void sipe_ucs_add_im_group_response(struct sipe_core_private *sipe_private,
 310                                            const sipe_xml *body,
 311                                            gpointer callback_data)
 312 {
 313         gchar *who = callback_data;
 314         const sipe_xml *group_node = sipe_xml_child(body,
 315                                                     "AddImGroupResponse/ImGroup");
 316         struct sipe_group *group = ucs_create_group(sipe_private, group_node);
 317
 318         if (group)
 319                 sipe_group_add_buddy(sipe_private, group, who);
 320
 321         g_free(who);
 322 }
 323
 324 void sipe_ucs_group_create(struct sipe_core_private *sipe_private,
 325                            const gchar *name,
 326                            const gchar *who)
 327 {
 328         /* new_name can contain restricted characters */
 329         gchar *body = g_markup_printf_escaped("<m:AddImGroup>"
 330                                               " <m:DisplayName>%s</m:DisplayName>"
 331                                               "</m:AddImGroup>",
 332                                               name);
 333
 334         sipe_ucs_http_request(sipe_private,
 335                               body,
 336                               sipe_ucs_add_im_group_response,
 337                               g_strdup(who));
 338         g_free(body);
 339 }
 340
 341 void sipe_ucs_group_rename(struct sipe_core_private *sipe_private,
 342                            struct sipe_group *group,
 343                            const gchar *new_name)
 344 {
 345         /* new_name can contain restricted characters */
 346         gchar *body = g_markup_printf_escaped("<m:SetImGroup>"
 347                                               " <m:GroupId Id=\"%s\" ChangeKey=\"%s\"/>"
 348                                               " <m:NewDisplayName>%s</m:NewDisplayName>"
 349                                               "</m:SetImGroup>",
 350                                               group->exchange_key,
 351                                               group->change_key,
 352                                               new_name);
 353
 354         sipe_ucs_http_request(sipe_private,
 355                               body,
 356                               sipe_ucs_ignore_response,
 357                               NULL);
 358         g_free(body);
 359 }
 360
 361 void sipe_ucs_group_remove(struct sipe_core_private *sipe_private,
 362                            struct sipe_group *group)
 363 {
 364         gchar *body = g_strdup_printf("<m:RemoveImGroup>"
 365                                       " <m:GroupId Id=\"%s\" ChangeKey=\"%s\"/>"
 366                                       "</m:RemoveImGroup>",
 367                                       group->exchange_key,
 368                                       group->change_key);
 369
 370         sipe_ucs_http_request(sipe_private,
 371                               body,
 372                               sipe_ucs_ignore_response,
 373                               NULL);
 374         g_free(body);
 375 }
 376
 377 static void sipe_ucs_get_im_item_list_response(struct sipe_core_private *sipe_private,
 378                                                const sipe_xml *body,
 379                                                SIPE_UNUSED_PARAMETER gpointer callback_data)
 380 {
 381         const sipe_xml *node = sipe_xml_child(body,
 382                                               "GetImItemListResponse/ImItemList");
 383
 384         if (node) {
 385                 const sipe_xml *persona_node;
 386                 const sipe_xml *group_node;
 387
 388                 /* Start processing contact list */
 389                 if (SIPE_CORE_PRIVATE_FLAG_IS(SUBSCRIBED_BUDDIES))
 390                         sipe_buddy_update_start(sipe_private);
 391                 else
 392                         sipe_backend_buddy_list_processing_start(SIPE_CORE_PUBLIC);
 393
 394                 for (persona_node = sipe_xml_child(node, "Personas/Persona");
 395                      persona_node;
 396                      persona_node = sipe_xml_twin(persona_node)) {
 397                         gchar *address = sipe_xml_data(sipe_xml_child(persona_node,
 398                                                                       "ImAddress"));
 399                         const gchar *key = NULL;
 400                         const gchar *change = NULL;
 401                         const sipe_xml *attr_node;
 402
 403                         /* extract Exchange key - not sure if this is correct */
 404                         for (attr_node = sipe_xml_child(persona_node,
 405                                                         "Attributions/Attribution");
 406                              attr_node;
 407                              attr_node = sipe_xml_twin(attr_node)) {
 408                                 const sipe_xml *id_node = sipe_xml_child(attr_node,
 409                                                                          "SourceId");
 410                                 gchar *type = sipe_xml_data(sipe_xml_child(attr_node,
 411                                                                            "DisplayName"));
 412                                 if (id_node &&
 413                                     sipe_strequal(type, "Lync Contacts")) {
 414                                         key = sipe_xml_attribute(id_node, "Id");
 415                                         change = sipe_xml_attribute(id_node, "ChangeKey");
 416                                         g_free(type);
 417                                         break;
 418                                 }
 419                                 g_free(type);
 420                         }
 421
 422                         if (!(is_empty(address) || is_empty(key) || is_empty(change))) {
 423                                 gchar *uri = sip_uri_from_name(address);
 424                                 struct sipe_buddy *buddy = sipe_buddy_add(sipe_private,
 425                                                                           uri,
 426                                                                           key,
 427                                                                           change);
 428                                 g_free(uri);
 429
 430                                 SIPE_DEBUG_INFO("sipe_ucs_get_im_item_list_response: persona URI '%s' key '%s' change '%s'",
 431                                                 buddy->name, key, change);
 432                         }
 433                         g_free(address);
 434                 }
 435
 436                 for (group_node = sipe_xml_child(node, "Groups/ImGroup");
 437                      group_node;
 438                      group_node = sipe_xml_twin(group_node)) {
 439                         struct sipe_group *group = ucs_create_group(sipe_private,
 440                                                                     group_node);
 441
 442                         if (group) {
 443                                 const sipe_xml *member_node;
 444
 445                                 for (member_node = sipe_xml_child(group_node,
 446                                                                   "MemberCorrelationKey/ItemId");
 447                                      member_node;
 448                                      member_node = sipe_xml_twin(member_node)) {
 449                                         struct sipe_buddy *buddy = sipe_buddy_find_by_exchange_key(sipe_private,
 450                                                                                                    sipe_xml_attribute(member_node,
 451                                                                                                                       "Id"));
 452                                         if (buddy)
 453                                                 sipe_buddy_add_to_group(sipe_private,
 454                                                                         buddy,
 455                                                                         group,
 456                                                                         /* alias will be set via buddy presence update */
 457                                                                         NULL);
 458                                 }
 459                         }
 460                 }
 461
 462                 /* Finished processing contact list */
 463                 if (SIPE_CORE_PRIVATE_FLAG_IS(SUBSCRIBED_BUDDIES))
 464                         sipe_buddy_update_finish(sipe_private);
 465                 else {
 466                         sipe_buddy_cleanup_local_list(sipe_private);
 467                         sipe_backend_buddy_list_processing_finish(SIPE_CORE_PUBLIC);
 468                         sipe_subscribe_presence_initial(sipe_private);
 469                 }
 470         }
 471 }
 472
 473 static void ucs_get_im_item_list(struct sipe_core_private *sipe_private)
 474 {
 475         if (sipe_private->ucs->migrated)
 476                 sipe_ucs_http_request(sipe_private,
 477                                       "<m:GetImItemList/>",
 478                                       sipe_ucs_get_im_item_list_response,
 479                                       NULL);
 480 }
 481
 482 static void ucs_ews_autodiscover_cb(struct sipe_core_private *sipe_private,
 483                                     const struct sipe_ews_autodiscover_data *ews_data,
 484                                     SIPE_UNUSED_PARAMETER gpointer callback_data)
 485 {
 486         struct sipe_ucs *ucs = sipe_private->ucs;
 487         const gchar *ews_url;
 488
 489         if (!ucs || !ews_data)
 490                 return;
 491
 492         ews_url = ews_data->ews_url;
 493         if (is_empty(ews_url)) {
 494                 SIPE_DEBUG_ERROR_NOFORMAT("ucs_ews_autodiscover_cb: can't detect EWS URL, contact list operations will not work!");
 495                 return;
 496         }
 497
 498         SIPE_DEBUG_INFO("ucs_ews_autodiscover_cb: EWS URL '%s'", ews_url);
 499         ucs->ews_url = g_strdup(ews_url);
 500
 501         ucs_get_im_item_list(sipe_private);
 502
 503         /* EWS URL is valid, send all deferred requests now */
 504         if (ucs->deferred_requests) {
 505                 GSList *entry = ucs->deferred_requests;
 506                 while (entry) {
 507                         struct ucs_deferred *data = entry->data;
 508
 509                         sipe_ucs_http_request(sipe_private,
 510                                               data->body,
 511                                               data->cb,
 512                                               data->cb_data);
 513
 514                         /* callback & data has been forwarded */
 515                         data->cb = NULL;
 516                         sipe_ucs_deferred_free(sipe_private, data);
 517
 518                         entry = entry->next;
 519                 }
 520                 g_slist_free(ucs->deferred_requests);
 521                 ucs->deferred_requests = NULL;
 522         }
 523 }
 524
 525 gboolean sipe_ucs_is_migrated(struct sipe_core_private *sipe_private)
 526 {
 527         return(sipe_private->ucs ? sipe_private->ucs->migrated : FALSE);
 528 }
 529
 530 void sipe_ucs_init(struct sipe_core_private *sipe_private,
 531                    gboolean migrated)
 532 {
 533         struct sipe_ucs *ucs;
 534
 535         if (sipe_private->ucs) {
 536                 /* contact list update trigger -> request list again */
 537                 if (SIPE_CORE_PRIVATE_FLAG_IS(SUBSCRIBED_BUDDIES))
 538                         ucs_get_im_item_list(sipe_private);
 539
 540                 return;
 541         }
 542
 543         sipe_private->ucs = ucs = g_new0(struct sipe_ucs, 1);
 544         ucs->migrated = migrated;
 545
 546         sipe_ews_autodiscover_start(sipe_private,
 547                                     ucs_ews_autodiscover_cb,
 548                                     NULL);
 549 }
 550
 551 void sipe_ucs_free(struct sipe_core_private *sipe_private)
 552 {
 553         struct sipe_ucs *ucs = sipe_private->ucs;
 554
 555         if (!ucs)
 556                 return;
 557
 558         /* UCS stack is shutting down: reject all new requests */
 559         ucs->shutting_down = TRUE;
 560
 561         if (ucs->deferred_requests) {
 562                 GSList *entry = ucs->deferred_requests;
 563                 while (entry) {
 564                         sipe_ucs_deferred_free(sipe_private, entry->data);
 565                         entry = entry->next;
 566                 }
 567                 g_slist_free(ucs->deferred_requests);
 568         }
 569
 570         if (ucs->pending_requests) {
 571                 GSList *entry = ucs->pending_requests;
 572                 while (entry) {
 573                         sipe_ucs_request_free(sipe_private, entry->data);
 574                         entry = entry->next;
 575                 }
 576                 g_slist_free(ucs->pending_requests);
 577         }
 578
 579         g_free(ucs->ews_url);
 580         g_free(ucs);
 581         sipe_private->ucs = NULL;
 582 }
 583
 584 /*
 585   Local Variables:
 586   mode: c
 587   c-file-style: "bsd"
 588   indent-tabs-mode: t
 589   tab-width: 8
 590   End:
 591 */