src/core/sipe-chat.c

   1 /**
   2  * @file sipe-chat.c
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2009-2016 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <time.h>
  30
  31 #include <glib.h>
  32
  33 #include "sipe-common.h"
  34 #include "sipmsg.h"
  35 #include "sip-transport.h"
  36 #include "sipe-backend.h"
  37 #include "sipe-chat.h"
  38 #include "sipe-conf.h"
  39 #include "sipe-core.h"
  40 #include "sipe-core-private.h"
  41 #include "sipe-dialog.h"
  42 #include "sipe-groupchat.h"
  43 #include "sipe-im.h"
  44 #include "sipe-nls.h"
  45 #include "sipe-schedule.h"
  46 #include "sipe-session.h"
  47 #include "sipe-utils.h"
  48 #include "sipe-xml.h"
  49
  50 /**
  51  * Invite @who to chat
  52  *
  53  * @param sipe_private SIPE core private data
  54  * @param session SIPE session for chat
  55  * @param who URI whom to invite to chat.
  56  */
  57 static void
  58 sipe_invite_to_chat(struct sipe_core_private *sipe_private,
  59                     struct sip_session *session,
  60                     const gchar *who);
  61
  62 static GList *chat_sessions = NULL;
  63
  64 struct sipe_chat_session *sipe_chat_create_session(enum sipe_chat_type type,
  65                                                    const gchar *id,
  66                                                    const gchar *title)
  67 {
  68         struct sipe_chat_session *session = g_new0(struct sipe_chat_session, 1);
  69         if (id)
  70                 session->id = g_strdup(id);
  71         session->title = g_strdup(title);
  72         session->type  = type;
  73         chat_sessions  = g_list_prepend(chat_sessions, session);
  74         return(session);
  75 }
  76
  77 void sipe_chat_remove_session(struct sipe_chat_session *session)
  78 {
  79         chat_sessions = g_list_remove(chat_sessions, session);
  80         sipe_backend_chat_session_destroy(session->backend);
  81         g_free(session->title);
  82         g_free(session->id);
  83         g_free(session->join_url);
  84         g_free(session->dial_in_conf_id);
  85         g_free(session->organizer);
  86         g_free(session);
  87 }
  88
  89 void sipe_chat_destroy(void)
  90 {
  91         while (chat_sessions) {
  92                 struct sipe_chat_session *chat_session = chat_sessions->data;
  93                 SIPE_DEBUG_INFO("sipe_chat_destroy: '%s' (%s)",
  94                                 chat_session->title, chat_session->id);
  95                 sipe_chat_remove_session(chat_session);
  96         }
  97 }
  98
  99 const gchar *sipe_core_chat_id(SIPE_UNUSED_PARAMETER struct sipe_core_public *sipe_public,
 100                                struct sipe_chat_session *chat_session)
 101 {
 102         return(chat_session->id);
 103 }
 104
 105 void sipe_core_chat_invite(struct sipe_core_public *sipe_public,
 106                            struct sipe_chat_session *chat_session,
 107                            const char *name)
 108 {
 109         struct sipe_core_private *sipe_private = SIPE_CORE_PRIVATE;
 110
 111         SIPE_DEBUG_INFO("sipe_core_chat_create: who '%s'", name);
 112
 113         switch (chat_session->type) {
 114         case SIPE_CHAT_TYPE_MULTIPARTY:
 115         case SIPE_CHAT_TYPE_CONFERENCE:
 116                 {
 117                         struct sip_session *session = sipe_session_find_chat(sipe_private,
 118                                                                              chat_session);
 119
 120                         if (session) {
 121                                 gchar *uri = sip_uri(name);
 122                                 sipe_invite_to_chat(sipe_private, session, uri);
 123                                 g_free(uri);
 124                         }
 125                 }
 126                 break;
 127         case SIPE_CHAT_TYPE_GROUPCHAT:
 128                 /* @TODO */
 129                 SIPE_DEBUG_INFO_NOFORMAT("GROUP CHAT: INVITE NOT IMPLEMENTED!");
 130                 break;
 131         default:
 132                 break;
 133         }
 134 }
 135
 136 void sipe_core_chat_rejoin(struct sipe_core_public *sipe_public,
 137                            struct sipe_chat_session *chat_session)
 138 {
 139         struct sipe_core_private *sipe_private = SIPE_CORE_PRIVATE;
 140
 141         SIPE_DEBUG_INFO("sipe_core_chat_rejoin: '%s'", chat_session->title);
 142
 143         switch (chat_session->type) {
 144         case SIPE_CHAT_TYPE_MULTIPARTY:
 145                 {
 146                         struct sip_session *session = sipe_session_add_chat(sipe_private,
 147                                                                             chat_session,
 148                                                                             TRUE,
 149                                                                             NULL);
 150                         gchar *self = sip_uri_self(sipe_private);
 151
 152                         sipe_invite_to_chat(sipe_private, session, self);
 153                         sipe_backend_chat_rejoin(SIPE_CORE_PUBLIC,
 154                                                  chat_session->backend,
 155                                                  self,
 156                                                  chat_session->title);
 157                         g_free(self);
 158                 }
 159                 break;
 160         case SIPE_CHAT_TYPE_CONFERENCE:
 161                 sipe_conf_create(sipe_private, chat_session, NULL);
 162                 break;
 163         case SIPE_CHAT_TYPE_GROUPCHAT:
 164                 sipe_groupchat_rejoin(sipe_private, chat_session);
 165                 break;
 166         default:
 167                 break;
 168         }
 169 }
 170
 171 void sipe_core_chat_leave(struct sipe_core_public *sipe_public,
 172                           struct sipe_chat_session *chat_session)
 173 {
 174         struct sipe_core_private *sipe_private = SIPE_CORE_PRIVATE;
 175
 176         SIPE_DEBUG_INFO("sipe_core_chat_leave: '%s'", chat_session->title);
 177
 178         switch (chat_session->type) {
 179         case SIPE_CHAT_TYPE_MULTIPARTY:
 180         case SIPE_CHAT_TYPE_CONFERENCE:
 181                 {
 182                         struct sip_session *session = sipe_session_find_chat(sipe_private,
 183                                                                              chat_session);
 184
 185                         if (session) {
 186                                 sipe_session_close(sipe_private, session);
 187                         }
 188                 }
 189                 break;
 190         case SIPE_CHAT_TYPE_GROUPCHAT:
 191                 sipe_groupchat_leave(sipe_private, chat_session);
 192                 break;
 193         default:
 194                 break;
 195         }
 196 }
 197
 198 void sipe_core_chat_send(struct sipe_core_public *sipe_public,
 199                          struct sipe_chat_session *chat_session,
 200                          const char *what)
 201 {
 202         struct sipe_core_private *sipe_private = SIPE_CORE_PRIVATE;
 203
 204         SIPE_DEBUG_INFO("sipe_core_chat_send: '%s' to '%s'",
 205                         what, chat_session->title);
 206
 207         switch (chat_session->type) {
 208         case SIPE_CHAT_TYPE_MULTIPARTY:
 209         case SIPE_CHAT_TYPE_CONFERENCE:
 210                 {
 211                         struct sip_session *session = sipe_session_find_chat(sipe_private,
 212                                                                              chat_session);
 213
 214                         if (session) {
 215                                 sipe_session_enqueue_message(session,
 216                                                              what,
 217                                                              NULL);
 218                                 sipe_im_process_queue(sipe_private, session);
 219                         }
 220                 }
 221                 break;
 222         case SIPE_CHAT_TYPE_GROUPCHAT:
 223                 sipe_groupchat_send(sipe_private, chat_session, what);
 224                 break;
 225         default:
 226                 break;
 227         }
 228 }
 229
 230 gchar *
 231 sipe_chat_get_name(void)
 232 {
 233         /**
 234          * A non-volatile ID counter.
 235          * Should survive connection drop & reconnect.
 236          */
 237         static guint chat_seq = 0;
 238
 239         /* Generate next ID */
 240         gchar *chat_name = g_strdup_printf(_("Chat #%d"), ++chat_seq);
 241         SIPE_DEBUG_INFO("sipe_chat_get_name: added new: %s", chat_name);
 242
 243         return chat_name;
 244 }
 245
 246 static void
 247 sipe_refer(struct sipe_core_private *sipe_private,
 248            struct sip_session *session,
 249            const gchar *who)
 250 {
 251         gchar *hdr;
 252         gchar *contact;
 253         struct sip_dialog *dialog = sipe_dialog_find(session,
 254                                                      session->chat_session->id);
 255         const char *ourtag = dialog && dialog->ourtag ? dialog->ourtag : NULL;
 256
 257         contact = get_contact(sipe_private);
 258         hdr = g_strdup_printf(
 259                 "Contact: %s\r\n"
 260                 "Refer-to: <%s>\r\n"
 261                 "Referred-By: <sip:%s>%s%s;epid=%s\r\n"
 262                 "Require: com.microsoft.rtc-multiparty\r\n",
 263                 contact,
 264                 who,
 265                 sipe_private->username,
 266                 ourtag ? ";tag=" : "",
 267                 ourtag ? ourtag : "",
 268                 sip_transport_epid(sipe_private));
 269
 270         sip_transport_request(sipe_private,
 271                               "REFER",
 272                               session->chat_session->id,
 273                               session->chat_session->id,
 274                               hdr,
 275                               NULL,
 276                               dialog,
 277                               NULL);
 278
 279         g_free(hdr);
 280         g_free(contact);
 281 }
 282
 283 static gboolean
 284 sipe_is_election_finished(struct sip_session *session)
 285 {
 286         gboolean res = TRUE;
 287
 288         SIPE_DIALOG_FOREACH {
 289                 if (dialog->election_vote == 0) {
 290                         res = FALSE;
 291                         break;
 292                 }
 293         } SIPE_DIALOG_FOREACH_END;
 294
 295         if (res) {
 296                 session->is_voting_in_progress = FALSE;
 297         }
 298         return res;
 299 }
 300
 301 static gboolean
 302 process_info_response(struct sipe_core_private *sipe_private,
 303                       struct sipmsg *msg,
 304                       struct transaction *trans);
 305
 306 static void
 307 sipe_send_election_set_rm(struct sipe_core_private *sipe_private,
 308                           struct sip_dialog *dialog)
 309 {
 310         const gchar *hdr = "Content-Type: application/x-ms-mim\r\n";
 311
 312         gchar *body = g_strdup_printf(
 313                 "<?xml version=\"1.0\"?>\r\n"
 314                 "<action xmlns=\"http://schemas.microsoft.com/sip/multiparty/\">"
 315                 "<SetRM uri=\"sip:%s\"/></action>\r\n",
 316                 sipe_private->username);
 317
 318         sip_transport_info(sipe_private,
 319                            hdr,
 320                            body,
 321                            dialog,
 322                            process_info_response);
 323
 324         g_free(body);
 325 }
 326
 327 void
 328 sipe_process_pending_invite_queue(struct sipe_core_private *sipe_private,
 329                                   struct sip_session *session)
 330 {
 331         gchar *invitee;
 332         GSList *entry = session->pending_invite_queue;
 333
 334         while (entry) {
 335                 invitee = entry->data;
 336                 sipe_invite_to_chat(sipe_private, session, invitee);
 337                 entry = session->pending_invite_queue = g_slist_remove(session->pending_invite_queue, invitee);
 338                 g_free(invitee);
 339         }
 340 }
 341
 342 void sipe_chat_set_roster_manager(struct sip_session *session,
 343                                   const gchar *roster_manager)
 344 {
 345         struct sipe_chat_session *chat_session = session->chat_session;
 346
 347         g_free(chat_session->id);
 348         chat_session->id = NULL;
 349         if (roster_manager)
 350                 chat_session->id = g_strdup(roster_manager);
 351 }
 352
 353 static void
 354 sipe_election_result(struct sipe_core_private *sipe_private,
 355                      void *sess)
 356 {
 357         struct sip_session *session = (struct sip_session *)sess;
 358         const gchar *rival = NULL;
 359
 360         if (session->chat_session->id) {
 361                 SIPE_DEBUG_INFO(
 362                         "sipe_election_result: RM has already been elected in the meantime. It is %s",
 363                         session->chat_session->id);
 364                 return;
 365         }
 366
 367         session->is_voting_in_progress = FALSE;
 368
 369         SIPE_DIALOG_FOREACH {
 370                 if (dialog->election_vote < 0) {
 371                         rival = dialog->with;
 372                         break;
 373                 }
 374         } SIPE_DIALOG_FOREACH_END;
 375
 376         if (rival) {
 377                 SIPE_DEBUG_INFO("sipe_election_result: we loose RM election to %s", rival);
 378         } else {
 379                 gchar *self = sip_uri_self(sipe_private);
 380
 381                 SIPE_DEBUG_INFO_NOFORMAT("sipe_election_result: we have won RM election!");
 382
 383                 sipe_chat_set_roster_manager(session, self);
 384                 g_free(self);
 385
 386                 SIPE_DIALOG_FOREACH {
 387                         /* send SetRM to each chat participant*/
 388                         sipe_send_election_set_rm(sipe_private, dialog);
 389                 } SIPE_DIALOG_FOREACH_END;
 390         }
 391         session->bid = 0;
 392
 393         sipe_process_pending_invite_queue(sipe_private, session);
 394 }
 395
 396 static gboolean
 397 process_info_response(struct sipe_core_private *sipe_private,
 398                       struct sipmsg *msg,
 399                       SIPE_UNUSED_PARAMETER struct transaction *trans)
 400 {
 401         const gchar *contenttype = sipmsg_find_header(msg, "Content-Type");
 402         const gchar *callid = sipmsg_find_header(msg, "Call-ID");
 403         struct sip_dialog *dialog;
 404         struct sip_session *session;
 405
 406         session = sipe_session_find_chat_by_callid(sipe_private, callid);
 407         if (!session) {
 408                 SIPE_DEBUG_INFO("process_info_response: failed find dialog for callid %s, exiting.", callid);
 409                 return FALSE;
 410         }
 411
 412         if (msg->response == 200 && g_str_has_prefix(contenttype, "application/x-ms-mim")) {
 413                 sipe_xml *xn_action                    = sipe_xml_parse(msg->body, msg->bodylen);
 414                 const sipe_xml *xn_request_rm_response = sipe_xml_child(xn_action, "RequestRMResponse");
 415                 const sipe_xml *xn_set_rm_response     = sipe_xml_child(xn_action, "SetRMResponse");
 416
 417                 if (xn_request_rm_response) {
 418                         const char *with = sipe_xml_attribute(xn_request_rm_response, "uri");
 419                         const char *allow = sipe_xml_attribute(xn_request_rm_response, "allow");
 420
 421                         dialog = sipe_dialog_find(session, with);
 422                         if (!dialog) {
 423                                 SIPE_DEBUG_INFO("process_info_response: failed find dialog for %s, exiting.", with);
 424                                 sipe_xml_free(xn_action);
 425                                 return FALSE;
 426                         }
 427
 428                         if (allow && !g_ascii_strcasecmp(allow, "true")) {
 429                                 SIPE_DEBUG_INFO("process_info_response: %s has voted PRO", with);
 430                                 dialog->election_vote = 1;
 431                         } else if (allow && !g_ascii_strcasecmp(allow, "false")) {
 432                                 SIPE_DEBUG_INFO("process_info_response: %s has voted CONTRA", with);
 433                                 dialog->election_vote = -1;
 434                         }
 435
 436                         if (sipe_is_election_finished(session)) {
 437                                 sipe_election_result(sipe_private,
 438                                                      session);
 439                         }
 440
 441                 } else if (xn_set_rm_response) {
 442
 443                 }
 444                 sipe_xml_free(xn_action);
 445
 446         }
 447
 448         return TRUE;
 449 }
 450
 451 static void
 452 sipe_send_election_request_rm(struct sipe_core_private *sipe_private,
 453                               struct sip_dialog *dialog,
 454                               int bid)
 455 {
 456         const gchar *hdr = "Content-Type: application/x-ms-mim\r\n";
 457
 458         gchar *body = g_strdup_printf(
 459                 "<?xml version=\"1.0\"?>\r\n"
 460                 "<action xmlns=\"http://schemas.microsoft.com/sip/multiparty/\">"
 461                 "<RequestRM uri=\"sip:%s\" bid=\"%d\"/></action>\r\n",
 462                 sipe_private->username, bid);
 463
 464         sip_transport_info(sipe_private,
 465                            hdr,
 466                            body,
 467                            dialog,
 468                            process_info_response);
 469
 470         g_free(body);
 471 }
 472
 473 static void
 474 sipe_election_start(struct sipe_core_private *sipe_private,
 475                     struct sip_session *session)
 476 {
 477         if (session->is_voting_in_progress) {
 478                 SIPE_DEBUG_INFO_NOFORMAT("sipe_election_start: other election is in progress, exiting.");
 479                 return;
 480         } else {
 481                 session->is_voting_in_progress = TRUE;
 482         }
 483         session->bid = rand();
 484
 485         SIPE_DEBUG_INFO("sipe_election_start: RM election has initiated. Our bid=%d", session->bid);
 486
 487         SIPE_DIALOG_FOREACH {
 488                 /* reset election_vote for each chat participant */
 489                 dialog->election_vote = 0;
 490
 491                 /* send RequestRM to each chat participant*/
 492                 sipe_send_election_request_rm(sipe_private, dialog, session->bid);
 493         } SIPE_DIALOG_FOREACH_END;
 494
 495         sipe_schedule_seconds(sipe_private,
 496                               "<+election-result>",
 497                               session,
 498                               15,
 499                               sipe_election_result,
 500                               NULL);
 501 }
 502
 503 static void
 504 sipe_invite_to_chat(struct sipe_core_private *sipe_private,
 505                     struct sip_session *session,
 506                     const gchar *who)
 507 {
 508         /* a conference */
 509         if (session->chat_session->type == SIPE_CHAT_TYPE_CONFERENCE)
 510         {
 511                 sipe_invite_conf(sipe_private, session, who);
 512         }
 513         else /* a multi-party chat */
 514         {
 515                 gchar *self = sip_uri_self(sipe_private);
 516                 if (session->chat_session->id) {
 517                         if (sipe_strcase_equal(session->chat_session->id, self)) {
 518                                 sipe_im_invite(sipe_private, session, who, NULL, NULL, NULL, FALSE);
 519                         } else {
 520                                 sipe_refer(sipe_private, session, who);
 521                         }
 522                 } else {
 523                         SIPE_DEBUG_INFO_NOFORMAT("sipe_invite_to_chat: no RM available");
 524
 525                         session->pending_invite_queue = sipe_utils_slist_insert_unique_sorted(session->pending_invite_queue,
 526                                                                                               g_strdup(who),
 527                                                                                               (GCompareFunc)strcmp,
 528                                                                                               g_free);
 529                         sipe_election_start(sipe_private, session);
 530                 }
 531                 g_free(self);
 532         }
 533 }
 534
 535 /*
 536   Local Variables:
 537   mode: c
 538   c-file-style: "bsd"
 539   indent-tabs-mode: t
 540   tab-width: 8
 541   End:
 542 */