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         gboolean migrated;
  67         gboolean shutting_down;
  68 };
  69
  70 static void sipe_ucs_deferred_free(struct sipe_core_private *sipe_private,
  71                                    struct ucs_deferred *data)
  72 {
  73         if (data->cb)
  74                 /* Callback: aborted */
  75                 (*data->cb)(sipe_private, NULL, data->cb_data);
  76         g_free(data->body);
  77         g_free(data);
  78 }
  79
  80 static void sipe_ucs_request_free(struct sipe_core_private *sipe_private,
  81                                   struct ucs_request *data)
  82 {
  83         if (data->request)
  84                 sipe_http_request_cancel(data->request);
  85         if (data->cb)
  86                 /* Callback: aborted */
  87                 (*data->cb)(sipe_private, NULL, data->cb_data);
  88         g_free(data);
  89 }
  90
  91 static void sipe_ucs_http_response(struct sipe_core_private *sipe_private,
  92                                    guint status,
  93                                    SIPE_UNUSED_PARAMETER GSList *headers,
  94                                    const gchar *body,
  95                                    gpointer callback_data)
  96 {
  97         struct ucs_request *data = callback_data;
  98         struct sipe_ucs *ucs = sipe_private->ucs;
  99
 100         SIPE_DEBUG_INFO("sipe_ucs_http_response: code %d", status);
 101         data->request = NULL;
 102
 103         if ((status == SIPE_HTTP_STATUS_OK) && body) {
 104                 sipe_xml *xml = sipe_xml_parse(body, strlen(body));
 105                 const sipe_xml *soap_body = sipe_xml_child(xml, "Body");
 106                 /* Callback: success */
 107                 (*data->cb)(sipe_private, soap_body, data->cb_data);
 108                 sipe_xml_free(xml);
 109         } else {
 110                 /* Callback: failed */
 111                 (*data->cb)(sipe_private, NULL, data->cb_data);
 112         }
 113
 114         /* already been called */
 115         data->cb = NULL;
 116
 117         ucs->pending_requests = g_slist_remove(ucs->pending_requests,
 118                                                data);
 119         sipe_ucs_request_free(sipe_private, data);
 120 }
 121
 122 static gboolean sipe_ucs_http_request(struct sipe_core_private *sipe_private,
 123                                       const gchar *body,
 124                                       ucs_callback *callback,
 125                                       gpointer callback_data)
 126 {
 127         struct sipe_ucs *ucs = sipe_private->ucs;
 128         gboolean success = FALSE;
 129
 130         if (ucs->shutting_down) {
 131                 SIPE_DEBUG_ERROR("sipe_ucs_http_request: new UCS request during shutdown: THIS SHOULD NOT HAPPEN! Debugging information:\n"
 132                                  "Body:   %s\n",
 133                                  body ? body : "<EMPTY>");
 134
 135         } else if (ucs->ews_url) {
 136                 struct ucs_request *data = g_new0(struct ucs_request, 1);
 137                 gchar *soap = g_strdup_printf("<?xml version=\"1.0\"?>\r\n"
 138                                               "<soap:Envelope"
 139                                               " xmlns:m=\"http://schemas.microsoft.com/exchange/services/2006/messages\""
 140                                               " xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\""
 141                                               " xmlns:t=\"http://schemas.microsoft.com/exchange/services/2006/types\""
 142                                               " >"
 143                                               " <soap:Header>"
 144                                               "  <t:RequestServerVersion Version=\"Exchange2013\" />"
 145                                               " </soap:Header>"
 146                                               " <soap:Body>"
 147                                               "  %s"
 148                                               " </soap:Body>"
 149                                               "</soap:Envelope>",
 150                                               body);
 151                 struct sipe_http_request *request = sipe_http_request_post(sipe_private,
 152                                                                            ucs->ews_url,
 153                                                                            NULL,
 154                                                                            soap,
 155                                                                            "text/xml; charset=UTF-8",
 156                                                                            sipe_ucs_http_response,
 157                                                                            data);
 158                 g_free(soap);
 159
 160                 if (request) {
 161                         data->cb      = callback;
 162                         data->cb_data = callback_data;
 163                         data->request = request;
 164
 165                         ucs->pending_requests = g_slist_prepend(ucs->pending_requests,
 166                                                                 data);
 167
 168                         sipe_core_email_authentication(sipe_private,
 169                                                        request);
 170                         sipe_http_request_allow_redirect(request);
 171                         sipe_http_request_ready(request);
 172
 173                         success = TRUE;
 174                 } else {
 175                         SIPE_DEBUG_ERROR_NOFORMAT("sipe_ucs_http_request: failed to create HTTP connection");
 176                         g_free(data);
 177                 }
 178
 179         } else {
 180                 struct ucs_deferred *data = g_new0(struct ucs_deferred, 1);
 181                 data->cb      = callback;
 182                 data->cb_data = callback_data;
 183                 data->body    = g_strdup(body);
 184
 185                 ucs->deferred_requests = g_slist_prepend(ucs->deferred_requests,
 186                                                          data);
 187                 success = TRUE;
 188         }
 189
 190         return(success);
 191 }
 192
 193 static void sipe_ucs_get_user_photo_response(struct sipe_core_private *sipe_private,
 194                                              const sipe_xml *body,
 195                                              gpointer callback_data)
 196 {
 197         gchar *uri = callback_data;
 198         const sipe_xml *node = sipe_xml_child(body,
 199                                               "GetUserPhotoResponse/PictureData");
 200
 201         if (node) {
 202                 gchar *base64;
 203                 gsize photo_size;
 204                 guchar *photo;
 205                 guchar digest[SIPE_DIGEST_SHA1_LENGTH];
 206                 gchar *digest_string;
 207
 208                 /* decode photo data */
 209                 base64 = sipe_xml_data(node);
 210                 photo = g_base64_decode(base64, &photo_size);
 211                 g_free(base64);
 212
 213                 /* EWS doesn't provide a hash -> calculate SHA-1 digest */
 214                 sipe_digest_sha1(photo, photo_size, digest);
 215                 digest_string = buff_to_hex_str(digest,
 216                                                 SIPE_DIGEST_SHA1_LENGTH);
 217
 218                 /* backend frees "photo" */
 219                 sipe_backend_buddy_set_photo(SIPE_CORE_PUBLIC,
 220                                              uri,
 221                                              photo,
 222                                              photo_size,
 223                                              digest_string);
 224                 g_free(digest_string);
 225         }
 226
 227         g_free(uri);
 228 }
 229
 230 void sipe_ucs_get_photo(struct sipe_core_private *sipe_private,
 231                         const gchar *uri)
 232 {
 233         gchar *payload = g_strdup(uri);
 234         gchar *body = g_strdup_printf("<m:GetUserPhoto>"
 235                                       " <m:Email>%s</m:Email>"
 236                                       " <m:SizeRequested>HR48x48</m:SizeRequested>"
 237                                       "</m:GetUserPhoto>",
 238                                       sipe_get_no_sip_uri(uri));
 239
 240         if (!sipe_ucs_http_request(sipe_private,
 241                                    body,
 242                                    sipe_ucs_get_user_photo_response,
 243                                    payload))
 244                 g_free(payload);
 245
 246         g_free(body);
 247 }
 248
 249 static void sipe_ucs_ignore_response(SIPE_UNUSED_PARAMETER struct sipe_core_private *sipe_private,
 250                                      SIPE_UNUSED_PARAMETER const sipe_xml *body,
 251                                      SIPE_UNUSED_PARAMETER gpointer callback_data)
 252 {
 253         SIPE_DEBUG_INFO_NOFORMAT("sipe_ucs_ignore_response: done");
 254 }
 255
 256 void sipe_ucs_group_rename(struct sipe_core_private *sipe_private,
 257                            struct sipe_group *group,
 258                            const gchar *new_name)
 259 {
 260         /* new_name can contain restricted characters */
 261         gchar *body = g_markup_printf_escaped("<m:SetImGroup>"
 262                                               " <m:GroupId Id=\"%s\" ChangeKey=\"%s\"/>"
 263                                               " <m:NewDisplayName>%s</m:NewDisplayName>"
 264                                               "</m:SetImGroup>",
 265                                               group->exchange_key,
 266                                               group->change_key,
 267                                               new_name);
 268
 269         sipe_ucs_http_request(sipe_private,
 270                               body,
 271                               sipe_ucs_ignore_response,
 272                               NULL);
 273         g_free(body);
 274 }
 275
 276 static void sipe_ucs_get_im_item_list_response(struct sipe_core_private *sipe_private,
 277                                                const sipe_xml *body,
 278                                                SIPE_UNUSED_PARAMETER gpointer callback_data)
 279 {
 280         const sipe_xml *node = sipe_xml_child(body,
 281                                               "GetImItemListResponse/ImItemList");
 282
 283         if (node) {
 284                 const sipe_xml *persona_node;
 285                 const sipe_xml *group_node;
 286
 287                 /* Start processing contact list */
 288                 sipe_backend_buddy_list_processing_start(SIPE_CORE_PUBLIC);
 289
 290                 for (persona_node = sipe_xml_child(node, "Personas/Persona");
 291                      persona_node;
 292                      persona_node = sipe_xml_twin(persona_node)) {
 293                         gchar *address = sipe_xml_data(sipe_xml_child(persona_node,
 294                                                                       "ImAddress"));
 295                         const gchar *key = NULL;
 296                         const gchar *change = NULL;
 297                         const sipe_xml *attr_node;
 298
 299                         /* extract Exchange key - not sure if this is correct */
 300                         for (attr_node = sipe_xml_child(persona_node,
 301                                                         "Attributions/Attribution");
 302                              attr_node;
 303                              attr_node = sipe_xml_twin(attr_node)) {
 304                                 const sipe_xml *id_node = sipe_xml_child(attr_node,
 305                                                                          "SourceId");
 306                                 gchar *type = sipe_xml_data(sipe_xml_child(attr_node,
 307                                                                            "DisplayName"));
 308                                 if (id_node &&
 309                                     sipe_strequal(type, "Lync Contacts")) {
 310                                         key = sipe_xml_attribute(id_node, "Id");
 311                                         change = sipe_xml_attribute(id_node, "ChangeKey");
 312                                         g_free(type);
 313                                         break;
 314                                 }
 315                                 g_free(type);
 316                         }
 317
 318                         if (!(is_empty(address) || is_empty(key) || is_empty(change))) {
 319                                 gchar *uri = sip_uri_from_name(address);
 320                                 struct sipe_buddy *buddy = sipe_buddy_add(sipe_private,
 321                                                                           uri,
 322                                                                           key,
 323                                                                           change);
 324                                 g_free(uri);
 325
 326                                 SIPE_DEBUG_INFO("sipe_ucs_get_im_item_list_response: persona URI '%s' key '%s' change '%s'",
 327                                                 buddy->name, key, change);
 328                         }
 329                         g_free(address);
 330                 }
 331
 332                 for (group_node = sipe_xml_child(node, "Groups/ImGroup");
 333                      group_node;
 334                      group_node = sipe_xml_twin(group_node)) {
 335                         const sipe_xml *id_node = sipe_xml_child(group_node,
 336                                                                  "ExchangeStoreId");
 337                         const gchar *key = sipe_xml_attribute(id_node, "Id");
 338                         const gchar *change = sipe_xml_attribute(id_node, "ChangeKey");
 339
 340                         if (!(is_empty(key) || is_empty(change))) {
 341                                 gchar *name = sipe_xml_data(sipe_xml_child(group_node,
 342                                                                            "DisplayName"));
 343                                 struct sipe_group *group = sipe_group_add(sipe_private,
 344                                                                           name,
 345                                                                           key,
 346                                                                           change,
 347                                                                           0);
 348                                 const sipe_xml *member_node;
 349
 350                                 g_free(name);
 351
 352                                 if (group) {
 353                                         SIPE_DEBUG_INFO("sipe_ucs_get_im_item_list_response: group '%s' key '%s' change '%s'",
 354                                                         group->name, key, change);
 355
 356                                         for (member_node = sipe_xml_child(group_node,
 357                                                                           "MemberCorrelationKey/ItemId");
 358                                              member_node;
 359                                              member_node = sipe_xml_twin(member_node)) {
 360                                                 struct sipe_buddy *buddy = sipe_buddy_find_by_exchange_key(sipe_private,
 361                                                                                                            sipe_xml_attribute(member_node,
 362                                                                                                                               "Id"));
 363                                                 if (buddy)
 364                                                         sipe_buddy_add_to_group(sipe_private,
 365                                                                                 buddy,
 366                                                                                 group,
 367                                                                                 /* alias will be set via buddy presence update */
 368                                                                                 NULL);
 369                                         }
 370                                 }
 371                         }
 372                 }
 373
 374                 /* Finished processing contact list */
 375                 sipe_buddy_cleanup_local_list(sipe_private);
 376                 sipe_backend_buddy_list_processing_finish(SIPE_CORE_PUBLIC);
 377                 sipe_subscribe_presence_initial(sipe_private);
 378         }
 379 }
 380
 381 static void ucs_ews_autodiscover_cb(struct sipe_core_private *sipe_private,
 382                                     const struct sipe_ews_autodiscover_data *ews_data,
 383                                     SIPE_UNUSED_PARAMETER gpointer callback_data)
 384 {
 385         struct sipe_ucs *ucs = sipe_private->ucs;
 386         const gchar *ews_url;
 387
 388         if (!ucs || !ews_data)
 389                 return;
 390
 391         ews_url = ews_data->ews_url;
 392         if (is_empty(ews_url)) {
 393                 SIPE_DEBUG_ERROR_NOFORMAT("ucs_ews_autodiscover_cb: can't detect EWS URL, contact list operations will not work!");
 394                 return;
 395         }
 396
 397         SIPE_DEBUG_INFO("ucs_ews_autodiscover_cb: EWS URL '%s'", ews_url);
 398         ucs->ews_url = g_strdup(ews_url);
 399
 400         /* Request migrated contact list */
 401         if (ucs->migrated)
 402                 sipe_ucs_http_request(sipe_private,
 403                                       "<m:GetImItemList/>",
 404                                       sipe_ucs_get_im_item_list_response,
 405                                       NULL);
 406
 407         /* EWS URL is valid, send all deferred requests now */
 408         if (ucs->deferred_requests) {
 409                 GSList *entry = ucs->deferred_requests;
 410                 while (entry) {
 411                         struct ucs_deferred *data = entry->data;
 412
 413                         sipe_ucs_http_request(sipe_private,
 414                                               data->body,
 415                                               data->cb,
 416                                               data->cb_data);
 417
 418                         /* callback & data has been forwarded */
 419                         data->cb = NULL;
 420                         sipe_ucs_deferred_free(sipe_private, data);
 421
 422                         entry = entry->next;
 423                 }
 424                 g_slist_free(ucs->deferred_requests);
 425                 ucs->deferred_requests = NULL;
 426         }
 427 }
 428
 429 gboolean sipe_ucs_is_migrated(struct sipe_core_private *sipe_private)
 430 {
 431         return(sipe_private->ucs ? sipe_private->ucs->migrated : FALSE);
 432 }
 433
 434 void sipe_ucs_init(struct sipe_core_private *sipe_private,
 435                    gboolean migrated)
 436 {
 437         struct sipe_ucs *ucs;
 438
 439         if (sipe_private->ucs)
 440                 return;
 441
 442         sipe_private->ucs = ucs = g_new0(struct sipe_ucs, 1);
 443         ucs->migrated = migrated;
 444
 445         sipe_ews_autodiscover_start(sipe_private,
 446                                     ucs_ews_autodiscover_cb,
 447                                     NULL);
 448 }
 449
 450 void sipe_ucs_free(struct sipe_core_private *sipe_private)
 451 {
 452         struct sipe_ucs *ucs = sipe_private->ucs;
 453
 454         if (!ucs)
 455                 return;
 456
 457         /* UCS stack is shutting down: reject all new requests */
 458         ucs->shutting_down = TRUE;
 459
 460         if (ucs->deferred_requests) {
 461                 GSList *entry = ucs->deferred_requests;
 462                 while (entry) {
 463                         sipe_ucs_deferred_free(sipe_private, entry->data);
 464                         entry = entry->next;
 465                 }
 466                 g_slist_free(ucs->deferred_requests);
 467         }
 468
 469         if (ucs->pending_requests) {
 470                 GSList *entry = ucs->pending_requests;
 471                 while (entry) {
 472                         sipe_ucs_request_free(sipe_private, entry->data);
 473                         entry = entry->next;
 474                 }
 475                 g_slist_free(ucs->pending_requests);
 476         }
 477
 478         g_free(ucs->ews_url);
 479         g_free(ucs);
 480         sipe_private->ucs = NULL;
 481 }
 482
 483 /*
 484   Local Variables:
 485   mode: c
 486   c-file-style: "bsd"
 487   indent-tabs-mode: t
 488   tab-width: 8
 489   End:
 490 */