?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
filetransfer: use 'deallocate' callback in sipe_file_transfer
[siplcs.git] / src / core / sipe-groupchat.c
blobc1397f867c4cdcd67f37a4bfba2f71e5dd93d55e
1 /**
2 * @file sipe-groupchat.c
3 *
4 * pidgin-sipe
5 *
6 * Copyright (C) 2010-2013 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 /**
24 * This module implements the OCS2007R2 Group Chat functionality
25 *
26 * Documentation references:
27 *
28 * Microsoft TechNet: Key Protocols and Windows Services Used by Group Chat
29 * <http://technet.microsoft.com/en-us/library/ee323484%28office.13%29.aspx>
30 * Microsoft TechNet: Group Chat Call Flows
31 * <http://technet.microsoft.com/en-us/library/ee323524%28office.13%29.aspx>
32 * Microsoft Office Communications Server 2007 R2 Technical Reference Guide
33 * <http://go.microsoft.com/fwlink/?LinkID=159649>
34 * Microsoft DevNet: [MS-XCCOSIP] Extensible Chat Control Over SIP
35 * <http://msdn.microsoft.com/en-us/library/hh624112.aspx>
36 * RFC 4028: Session Timers in the Session Initiation Protocol (SIP)
37 * <http://www.rfc-editor.org/rfc/rfc4028.txt>
38 *
39 *
40 * @TODO:
41 *
42 * -.cmd:getserverinfo
43 * <sib domain="<DOMAIN>" infoType="123" />
44 * rpl:getservinfo
45 * <sib infoType="123"
46 * serverTime="2010-09-14T14:26:17.6206356Z"
47 * searchLimit="999"
48 * messageSizeLimit="512"
49 * storySizeLimit="4096"
50 * rootUri="ma-cat://<DOMAIN>/<GUID>"
51 * dbVersion="3ea3a5a8-ef36-46cf-898f-7a5133931d63"
52 * />
53 *
54 * is there any information in there we would need/use?
55 *
56 * - cmd:getpref/rpl:getpref/cmd:setpref/rpl:setpref
57 * probably useless, as libpurple stores configuration locally
58 *
59 * can store base64 encoded "free text" in key/value fashion
60 * <cmd id="cmd:getpref" seqid="x">
61 * <data>
62 * <pref label="kedzie.GroupChannels"
63 * seqid="71"
64 * createdefault="true" />
65 * </data>
66 * </cmd>
67 * <cmd id="cmd:setpref" seqid="x">
68 * <data>
69 * <pref label="kedzie.GroupChannels"
70 * seqid="71"
71 * createdefault="false"
72 * content="<BASE64 text>" />
73 * </data>
74 * </cmd>
75 *
76 * use this to sync chats in buddy list on multiple clients?
77 *
78 * - cmd:getinv
79 * <inv inviteId="1" domain="<DOMAIN>" />
80 * rpl:getinv
81 * ???
82 *
83 * according to documentation should provide list of outstanding invites.
84 * [no log file examples]
85 * should we automatically join those channels or ask user to join/add?
86 *
87 * - chatserver_command_message()
88 * needs to support multiple <grpchat> nodes?
89 * [no log file examples]
90 *
91 * - create/delete chat rooms
92 * [no log file examples]
93 * are these related to this functionality?
94 *
95 * <cmd id="cmd:nodespermcreatechild" seqid="1">
96 * <data />
97 * </cmd>
98 * <rpl id="rpl:nodespermcreatechild" seqid="1">
99 * <commandid seqid="1" envid="xxx" />
100 * <resp code="200">SUCCESS_OK</resp>
101 * <data />
102 * </rpl>
103 *
104 * - file transfer (uses HTTPS PUT/GET via a filestore server)
105 * [no log file examples]
106 *
107 */
108
109 #ifdef HAVE_CONFIG_H
110 #include "config.h"
111 #endif
112
113 #include <stdlib.h>
114 #include <string.h>
115
116 #include <glib.h>
117
118 #include "sipe-common.h"
119 #include "sipmsg.h"
120 #include "sip-transport.h"
121 #include "sipe-backend.h"
122 #include "sipe-chat.h"
123 #include "sipe-core.h"
124 #include "sipe-core-private.h"
125 #include "sipe-dialog.h"
126 #include "sipe-groupchat.h"
127 #include "sipe-im.h"
128 #include "sipe-nls.h"
129 #include "sipe-schedule.h"
130 #include "sipe-session.h"
131 #include "sipe-utils.h"
132 #include "sipe-xml.h"
133
134 #define GROUPCHAT_RETRY_TIMEOUT 5*60 /* seconds */
135
136 /**
137 * aib node - magic numbers?
138 *
139 * Example:
140 * <aib key="3984" value="0,1,2,3,4,5,7,9,10,12,13,14,15,16,17" />
141 * <aib key="12276" value="6,8,11" />
142 *
143 * "value" corresponds to the "id" attribute in uib nodes.
144 *
145 * @TODO: Confirm "guessed" meaning of the magic numbers:
146 * 3984 = normal users
147 * 12276 = channel operators
148 */
149 #define GROUPCHAT_AIB_KEY_USER "3984"
150 #define GROUPCHAT_AIB_KEY_CHANOP "12276"
151
152 struct sipe_groupchat {
153 struct sip_session *session;
154 gchar *domain;
155 GSList *join_queue;
156 GHashTable *uri_to_chat_session;
157 GHashTable *msgs;
158 guint envid;
159 guint expires;
160 gboolean connected;
161 };
162
163 struct sipe_groupchat_msg {
164 GHashTable *container;
165 struct sipe_chat_session *session;
166 gchar *content;
167 gchar *xccos;
168 guint envid;
169 };
170
171 /* GDestroyNotify */
172 static void sipe_groupchat_msg_free(gpointer data) {
173 struct sipe_groupchat_msg *msg = data;
174 g_free(msg->content);
175 g_free(msg->xccos);
176 g_free(msg);
177 }
178
179 /* GDestroyNotify */
180 static void sipe_groupchat_msg_remove(gpointer data) {
181 struct sipe_groupchat_msg *msg = data;
182 g_hash_table_remove(msg->container, &msg->envid);
183 }
184
185 static void sipe_groupchat_allocate(struct sipe_core_private *sipe_private)
186 {
187 struct sipe_groupchat *groupchat = g_new0(struct sipe_groupchat, 1);
188
189 groupchat->uri_to_chat_session = g_hash_table_new(g_str_hash, g_str_equal);
190 groupchat->msgs = g_hash_table_new_full(g_int_hash, g_int_equal,
191 NULL,
192 sipe_groupchat_msg_free);
193 groupchat->envid = rand();
194 groupchat->connected = FALSE;
195 sipe_private->groupchat = groupchat;
196 }
197
198 static void sipe_groupchat_free_join_queue(struct sipe_groupchat *groupchat)
199 {
200 sipe_utils_slist_free_full(groupchat->join_queue, g_free);
201 groupchat->join_queue = NULL;
202 }
203
204 void sipe_groupchat_free(struct sipe_core_private *sipe_private)
205 {
206 struct sipe_groupchat *groupchat = sipe_private->groupchat;
207 if (groupchat) {
208 sipe_groupchat_free_join_queue(groupchat);
209 g_hash_table_destroy(groupchat->msgs);
210 g_hash_table_destroy(groupchat->uri_to_chat_session);
211 g_free(groupchat->domain);
212 g_free(groupchat);
213 sipe_private->groupchat = NULL;
214 }
215 }
216
217 static struct sipe_groupchat_msg *generate_xccos_message(struct sipe_groupchat *groupchat,
218 const gchar *content)
219 {
220 struct sipe_groupchat_msg *msg = g_new0(struct sipe_groupchat_msg, 1);
221
222 msg->container = groupchat->msgs;
223 msg->envid = groupchat->envid++;
224 msg->xccos = g_strdup_printf("<xccos ver=\"1\" envid=\"%u\" xmlns=\"urn:parlano:xml:ns:xccos\">"
225 "%s"
226 "</xccos>",
227 msg->envid,
228 content);
229
230 g_hash_table_insert(groupchat->msgs, &msg->envid, msg);
231
232 return(msg);
233 }
234
235 /**
236 * Create short-lived dialog with ocschat@<domain> (or user specified value)
237 * This initiates the Group Chat feature
238 */
239 void sipe_groupchat_init(struct sipe_core_private *sipe_private)
240 {
241 const gchar *setting = sipe_backend_setting(SIPE_CORE_PUBLIC,
242 SIPE_SETTING_GROUPCHAT_USER);
243 const gchar *persistent = sipe_private->persistentChatPool_uri;
244 gboolean user_set = !is_empty(setting);
245 gboolean provisioned = !is_empty(persistent);
246 gchar **parts = g_strsplit(user_set ? setting :
247 provisioned ? persistent :
248 sipe_private->username, "@", 2);
249 gboolean domain_found = !is_empty(parts[1]);
250 const gchar *user = "ocschat";
251 const gchar *domain = parts[domain_found ? 1 : 0];
252 gchar *chat_uri;
253 struct sip_session *session;
254 struct sipe_groupchat *groupchat;
255
256 /* User specified or provisioned URI is valid 'user@company.com' */
257 if ((user_set || provisioned) && domain_found && !is_empty(parts[0]))
258 user = parts[0];
259
260 SIPE_DEBUG_INFO("sipe_groupchat_init: username '%s' setting '%s' persistent '%s' split '%s'/'%s' GC user %s@%s",
261 sipe_private->username, setting ? setting : "(null)",
262 persistent ? persistent : "(null)",
263 parts[0], parts[1] ? parts[1] : "(null)", user, domain);
264
265 if (!sipe_private->groupchat)
266 sipe_groupchat_allocate(sipe_private);
267 groupchat = sipe_private->groupchat;
268
269 chat_uri = g_strdup_printf("sip:%s@%s", user, domain);
270 session = sipe_session_find_or_add_im(sipe_private,
271 chat_uri);
272 session->is_groupchat = TRUE;
273 sipe_im_invite(sipe_private, session, chat_uri,
274 NULL, NULL, NULL, FALSE);
275
276 g_free(groupchat->domain);
277 groupchat->domain = g_strdup(domain);
278
279 g_free(chat_uri);
280 g_strfreev(parts);
281 }
282
283 /* sipe_schedule_action */
284 static void groupchat_init_retry_cb(struct sipe_core_private *sipe_private,
285 SIPE_UNUSED_PARAMETER gpointer data)
286 {
287 sipe_groupchat_init(sipe_private);
288 }
289
290 static void groupchat_init_retry(struct sipe_core_private *sipe_private)
291 {
292 struct sipe_groupchat *groupchat = sipe_private->groupchat;
293
294 SIPE_DEBUG_INFO_NOFORMAT("groupchat_init_retry: trying again later...");
295
296 groupchat->session = NULL;
297 groupchat->connected = FALSE;
298
299 sipe_schedule_seconds(sipe_private,
300 "<+groupchat-retry>",
301 NULL,
302 GROUPCHAT_RETRY_TIMEOUT,
303 groupchat_init_retry_cb,
304 NULL);
305 }
306
307 void sipe_groupchat_invite_failed(struct sipe_core_private *sipe_private,
308 struct sip_session *session)
309 {
310 struct sipe_groupchat *groupchat = sipe_private->groupchat;
311 const gchar *setting = sipe_backend_setting(SIPE_CORE_PUBLIC,
312 SIPE_SETTING_GROUPCHAT_USER);
313 gboolean retry = FALSE;
314
315 if (groupchat->session) {
316 /* response to group chat server invite */
317 SIPE_DEBUG_ERROR_NOFORMAT("can't connect to group chat server!");
318
319 /* group chat server exists, but communication failed */
320 retry = TRUE;
321 } else {
322 /* response to initial invite */
323 SIPE_DEBUG_INFO_NOFORMAT("no group chat server found.");
324 }
325
326 sipe_session_close(sipe_private, session);
327
328 if (!is_empty(setting)) {
329 gchar *msg = g_strdup_printf(_("Group Chat Proxy setting is incorrect:\n\n\t%s\n\nPlease update your Account."),
330 setting);
331 sipe_backend_notify_error(SIPE_CORE_PUBLIC,
332 _("Couldn't find Group Chat server!"),
333 msg);
334 g_free(msg);
335
336 /* user specified group chat settings: we should retry */
337 retry = TRUE;
338 }
339
340 if (retry) {
341 groupchat_init_retry(sipe_private);
342 } else {
343 SIPE_DEBUG_INFO_NOFORMAT("disabling group chat feature.");
344 }
345 }
346
347 static gchar *generate_chanid_node(const gchar *uri, guint key)
348 {
349 /* ma-chan://<domain>/<value> */
350 gchar **parts = g_strsplit(uri, "/", 4);
351 gchar *chanid = NULL;
352
353 if (parts[2] && parts[3]) {
354 chanid = g_strdup_printf("<chanid key=\"%d\" domain=\"%s\" value=\"%s\"/>",
355 key, parts[2], parts[3]);
356 } else {
357 SIPE_DEBUG_ERROR("generate_chanid_node: mal-formed URI '%s'",
358 uri);
359 }
360 g_strfreev(parts);
361
362 return chanid;
363 }
364
365 /* TransCallback */
366 static void groupchat_update_cb(struct sipe_core_private *sipe_private,
367 gpointer data);
368 static gboolean groupchat_expired_session_response(struct sipe_core_private *sipe_private,
369 struct sipmsg *msg,
370 SIPE_UNUSED_PARAMETER struct transaction *trans)
371 {
372 struct sipe_groupchat *groupchat = sipe_private->groupchat;
373
374 /* 481 Call Leg Does Not Exist -> server dropped session */
375 if (msg->response == 481) {
376 struct sip_session *session = groupchat->session;
377 struct sip_dialog *dialog = sipe_dialog_find(session,
378 session->with);
379
380 if (dialog) {
381 /* close dialog from our side */
382 sip_transport_bye(sipe_private, dialog);
383 sipe_dialog_remove(session, session->with);
384 /* dialog is no longer valid */
385 }
386
387 /* re-initialize groupchat session */
388 groupchat->session = NULL;
389 groupchat->connected = FALSE;
390 sipe_groupchat_init(sipe_private);
391 } else {
392 sipe_schedule_seconds(sipe_private,
393 "<+groupchat-expires>",
394 NULL,
395 groupchat->expires,
396 groupchat_update_cb,
397 NULL);
398 }
399
400 return(TRUE);
401 }
402
403 /* sipe_schedule_action */
404 static void groupchat_update_cb(struct sipe_core_private *sipe_private,
405 SIPE_UNUSED_PARAMETER gpointer data)
406 {
407 struct sipe_groupchat *groupchat = sipe_private->groupchat;
408
409 if (groupchat->session) {
410 struct sip_dialog *dialog = sipe_dialog_find(groupchat->session,
411 groupchat->session->with);
412
413 if (dialog)
414 sip_transport_update(sipe_private,
415 dialog,
416 groupchat_expired_session_response);
417 }
418 }
419
420 static struct sipe_groupchat_msg *chatserver_command(struct sipe_core_private *sipe_private,
421 const gchar *cmd);
422
423 void sipe_groupchat_invite_response(struct sipe_core_private *sipe_private,
424 struct sip_dialog *dialog,
425 struct sipmsg *response)
426 {
427 struct sipe_groupchat *groupchat = sipe_private->groupchat;
428
429 SIPE_DEBUG_INFO_NOFORMAT("sipe_groupchat_invite_response");
430
431 if (!groupchat->session) {
432 /* response to initial invite */
433 struct sipe_groupchat_msg *msg = generate_xccos_message(groupchat,
434 "<cmd id=\"cmd:requri\" seqid=\"1\"><data/></cmd>");
435 const gchar *session_expires = sipmsg_find_header(response,
436 "Session-Expires");
437
438 sip_transport_info(sipe_private,
439 "Content-Type: text/plain\r\n",
440 msg->xccos,
441 dialog,
442 NULL);
443 sipe_groupchat_msg_remove(msg);
444
445 if (session_expires) {
446 groupchat->expires = strtoul(session_expires, NULL, 10);
447
448 if (groupchat->expires) {
449 SIPE_DEBUG_INFO("sipe_groupchat_invite_response: session expires in %d seconds",
450 groupchat->expires);
451
452 if (groupchat->expires > 10)
453 groupchat->expires -= 10;
454 sipe_schedule_seconds(sipe_private,
455 "<+groupchat-expires>",
456 NULL,
457 groupchat->expires,
458 groupchat_update_cb,
459 NULL);
460 }
461 }
462
463 } else {
464 /* response to group chat server invite */
465 gchar *invcmd;
466
467 SIPE_DEBUG_INFO_NOFORMAT("connection to group chat server established.");
468
469 groupchat->connected = TRUE;
470
471 /* Any queued joins? */
472 if (groupchat->join_queue) {
473 GString *cmd = g_string_new("<cmd id=\"cmd:bjoin\" seqid=\"1\">"
474 "<data>");
475 GSList *entry;
476 guint i = 0;
477
478 /* We used g_slist_prepend() to create the list */
479 groupchat->join_queue = entry = g_slist_reverse(groupchat->join_queue);
480 while (entry) {
481 gchar *chanid = generate_chanid_node(entry->data, i++);
482 g_string_append(cmd, chanid);
483 g_free(chanid);
484 entry = entry->next;
485 }
486 sipe_groupchat_free_join_queue(groupchat);
487
488 g_string_append(cmd, "</data></cmd>");
489 chatserver_command(sipe_private, cmd->str);
490 g_string_free(cmd, TRUE);
491 }
492
493 /* Request outstanding invites from server */
494 invcmd = g_strdup_printf("<cmd id=\"cmd:getinv\" seqid=\"1\">"
495 "<data>"
496 "<inv inviteId=\"1\" domain=\"%s\"/>"
497 "</data>"
498 "</cmd>", groupchat->domain);
499 chatserver_command(sipe_private, invcmd);
500 g_free(invcmd);
501 }
502 }
503
504 static void chatserver_command_error_notify(struct sipe_core_private *sipe_private,
505 struct sipe_chat_session *chat_session,
506 const gchar *content)
507 {
508 gchar *label = g_strdup_printf(_("This message was not delivered to chat room '%s'"),
509 chat_session->title);
510 gchar *errmsg = g_strdup_printf("%s:\n<font color=\"#888888\"></b>%s<b></font>",
511 label, content);
512 g_free(label);
513 sipe_backend_notify_message_error(SIPE_CORE_PUBLIC,
514 chat_session->backend,
515 NULL,
516 errmsg);
517 g_free(errmsg);
518 }
519
520 /* TransCallback */
521 static gboolean chatserver_command_response(struct sipe_core_private *sipe_private,
522 struct sipmsg *msg,
523 struct transaction *trans)
524 {
525 if (msg->response != 200) {
526 struct sipe_groupchat_msg *gmsg = trans->payload->data;
527 struct sipe_chat_session *chat_session = gmsg->session;
528
529 SIPE_DEBUG_INFO("chatserver_command_response: failure %d", msg->response);
530
531 if (chat_session)
532 chatserver_command_error_notify(sipe_private,
533 chat_session,
534 gmsg->content);
535
536 groupchat_expired_session_response(sipe_private, msg, trans);
537 }
538 return TRUE;
539 }
540
541 static struct sipe_groupchat_msg *chatserver_command(struct sipe_core_private *sipe_private,
542 const gchar *cmd)
543 {
544 struct sipe_groupchat *groupchat = sipe_private->groupchat;
545 struct sipe_groupchat_msg *msg = NULL;
546
547 if (groupchat->session) {
548 struct sip_dialog *dialog = sipe_dialog_find(groupchat->session,
549 groupchat->session->with);
550
551 if (dialog) {
552 struct transaction_payload *payload = g_new0(struct transaction_payload, 1);
553 struct transaction *trans;
554
555 msg = generate_xccos_message(groupchat, cmd);
556 trans = sip_transport_info(sipe_private,
557 "Content-Type: text/plain\r\n",
558 msg->xccos,
559 dialog,
560 chatserver_command_response);
561
562 payload->destroy = sipe_groupchat_msg_remove;
563 payload->data = msg;
564 trans->payload = payload;
565 }
566 }
567
568 return(msg);
569 }
570
571 static void chatserver_response_uri(struct sipe_core_private *sipe_private,
572 struct sip_session *session,
573 SIPE_UNUSED_PARAMETER guint result,
574 SIPE_UNUSED_PARAMETER const gchar *message,
575 const sipe_xml *xml)
576 {
577 const sipe_xml *uib = sipe_xml_child(xml, "uib");
578 const gchar *uri = sipe_xml_attribute(uib, "uri");
579
580 /* drop connection to ocschat@<domain> again */
581 sipe_session_close(sipe_private, session);
582
583 if (uri) {
584 struct sipe_groupchat *groupchat = sipe_private->groupchat;
585
586 SIPE_DEBUG_INFO("chatserver_response_uri: '%s'", uri);
587
588 groupchat->session = session = sipe_session_find_or_add_im(sipe_private,
589 uri);
590
591 session->is_groupchat = TRUE;
592 sipe_im_invite(sipe_private, session, uri, NULL, NULL, NULL, FALSE);
593 } else {
594 SIPE_DEBUG_WARNING_NOFORMAT("chatserver_response_uri: no server URI found!");
595 groupchat_init_retry(sipe_private);
596 }
597 }
598
599 static void chatserver_response_channel_search(struct sipe_core_private *sipe_private,
600 SIPE_UNUSED_PARAMETER struct sip_session *session,
601 guint result,
602 const gchar *message,
603 const sipe_xml *xml)
604 {
605 struct sipe_core_public *sipe_public = SIPE_CORE_PUBLIC;
606
607 if (result != 200) {
608 sipe_backend_notify_error(sipe_public,
609 _("Error retrieving room list"),
610 message);
611 } else {
612 const sipe_xml *chanib;
613
614 for (chanib = sipe_xml_child(xml, "chanib");
615 chanib;
616 chanib = sipe_xml_twin(chanib)) {
617 const gchar *name = sipe_xml_attribute(chanib, "name");
618 const gchar *desc = sipe_xml_attribute(chanib, "description");
619 const gchar *uri = sipe_xml_attribute(chanib, "uri");
620 const sipe_xml *node;
621 guint user_count = 0;
622 guint32 flags = 0;
623
624 /* information */
625 for (node = sipe_xml_child(chanib, "info");
626 node;
627 node = sipe_xml_twin(node)) {
628 const gchar *id = sipe_xml_attribute(node, "id");
629 gchar *data;
630
631 if (!id) continue;
632
633 data = sipe_xml_data(node);
634 if (data) {
635 if (sipe_strcase_equal(id, "urn:parlano:ma:info:ucnt")) {
636 user_count = g_ascii_strtoll(data, NULL, 10);
637 } else if (sipe_strcase_equal(id, "urn:parlano:ma:info:visibilty")) {
638 if (sipe_strcase_equal(data, "private")) {
639 flags |= SIPE_GROUPCHAT_ROOM_PRIVATE;
640 }
641 }
642 g_free(data);
643 }
644 }
645
646 /* properties */
647 for (node = sipe_xml_child(chanib, "prop");
648 node;
649 node = sipe_xml_twin(node)) {
650 const gchar *id = sipe_xml_attribute(node, "id");
651 gchar *data;
652
653 if (!id) continue;
654
655 data = sipe_xml_data(node);
656 if (data) {
657 gboolean value = sipe_strcase_equal(data, "true");
658 g_free(data);
659
660 if (value) {
661 guint32 add = 0;
662 if (sipe_strcase_equal(id, "urn:parlano:ma:prop:filepost")) {
663 add = SIPE_GROUPCHAT_ROOM_FILEPOST;
664 } else if (sipe_strcase_equal(id, "urn:parlano:ma:prop:invite")) {
665 add = SIPE_GROUPCHAT_ROOM_INVITE;
666 } else if (sipe_strcase_equal(id, "urn:parlano:ma:prop:logged")) {
667 add = SIPE_GROUPCHAT_ROOM_LOGGED;
668 }
669 flags |= add;
670 }
671 }
672 }
673
674 SIPE_DEBUG_INFO("group chat channel '%s': '%s' (%s) with %u users, flags 0x%x",
675 name, desc, uri, user_count, flags);
676 sipe_backend_groupchat_room_add(sipe_public,
677 uri, name, desc,
678 user_count, flags);
679 }
680 }
681
682 sipe_backend_groupchat_room_terminate(sipe_public);
683 }
684
685 static gboolean is_chanop(const sipe_xml *aib)
686 {
687 return sipe_strequal(sipe_xml_attribute(aib, "key"),
688 GROUPCHAT_AIB_KEY_CHANOP);
689 }
690
691 static void add_user(struct sipe_chat_session *chat_session,
692 const gchar *uri,
693 gboolean new, gboolean chanop)
694 {
695 SIPE_DEBUG_INFO("add_user: %s%s%s to room %s (%s)",
696 new ? "new " : "",
697 chanop ? "chanop " : "",
698 uri,
699 chat_session->title, chat_session->id);
700 sipe_backend_chat_add(chat_session->backend, uri, new);
701 if (chanop)
702 sipe_backend_chat_operator(chat_session->backend, uri);
703 }
704
705 static void chatserver_response_join(struct sipe_core_private *sipe_private,
706 SIPE_UNUSED_PARAMETER struct sip_session *session,
707 guint result,
708 const gchar *message,
709 const sipe_xml *xml)
710 {
711 if (result != 200) {
712 sipe_backend_notify_error(SIPE_CORE_PUBLIC,
713 _("Error joining chat room"),
714 message);
715 } else {
716 struct sipe_groupchat *groupchat = sipe_private->groupchat;
717 const sipe_xml *node;
718 GHashTable *user_ids = g_hash_table_new(g_str_hash, g_str_equal);
719
720 /* Extract user IDs & URIs and generate ID -> URI map */
721 for (node = sipe_xml_child(xml, "uib");
722 node;
723 node = sipe_xml_twin(node)) {
724 const gchar *id = sipe_xml_attribute(node, "id");
725 const gchar *uri = sipe_xml_attribute(node, "uri");
726 if (id && uri)
727 g_hash_table_insert(user_ids,
728 (gpointer) id,
729 (gpointer) uri);
730 }
731
732 /* Process channel data */
733 for (node = sipe_xml_child(xml, "chanib");
734 node;
735 node = sipe_xml_twin(node)) {
736 const gchar *uri = sipe_xml_attribute(node, "uri");
737
738 if (uri) {
739 struct sipe_chat_session *chat_session = g_hash_table_lookup(groupchat->uri_to_chat_session,
740 uri);
741 gboolean new = (chat_session == NULL);
742 const gchar *attr = sipe_xml_attribute(node, "name");
743 gchar *self = sip_uri_self(sipe_private);
744 const sipe_xml *aib;
745
746 if (new) {
747 chat_session = sipe_chat_create_session(SIPE_CHAT_TYPE_GROUPCHAT,
748 sipe_xml_attribute(node,
749 "uri"),
750 attr ? attr : "");
751 g_hash_table_insert(groupchat->uri_to_chat_session,
752 chat_session->id,
753 chat_session);
754
755 SIPE_DEBUG_INFO("joined room '%s' (%s)",
756 chat_session->title,
757 chat_session->id);
758 chat_session->backend = sipe_backend_chat_create(SIPE_CORE_PUBLIC,
759 chat_session,
760 chat_session->title,
761 self);
762 } else {
763 SIPE_DEBUG_INFO("rejoining room '%s' (%s)",
764 chat_session->title,
765 chat_session->id);
766 sipe_backend_chat_rejoin(SIPE_CORE_PUBLIC,
767 chat_session->backend,
768 self,
769 chat_session->title);
770 }
771 g_free(self);
772
773 attr = sipe_xml_attribute(node, "topic");
774 if (attr) {
775 sipe_backend_chat_topic(chat_session->backend,
776 attr);
777 }
778
779 /* Process user map for channel */
780 for (aib = sipe_xml_child(node, "aib");
781 aib;
782 aib = sipe_xml_twin(aib)) {
783 const gchar *value = sipe_xml_attribute(aib, "value");
784 gboolean chanop = is_chanop(aib);
785 gchar **ids = g_strsplit(value, ",", 0);
786
787 if (ids) {
788 gchar **uid = ids;
789
790 while (*uid) {
791 const gchar *uri = g_hash_table_lookup(user_ids,
792 *uid);
793 if (uri)
794 add_user(chat_session,
795 uri,
796 FALSE,
797 chanop);
798 uid++;
799 }
800
801 g_strfreev(ids);
802 }
803 }
804
805 /* Request last 25 entries from channel history */
806 self = g_strdup_printf("<cmd id=\"cmd:bccontext\" seqid=\"1\">"
807 "<data>"
808 "<chanib uri=\"%s\"/>"
809 "<bcq><last cnt=\"25\"/></bcq>"
810 "</data>"
811 "</cmd>", chat_session->id);
812 chatserver_command(sipe_private, self);
813 g_free(self);
814 }
815 }
816
817 g_hash_table_destroy(user_ids);
818 }
819 }
820
821 static void chatserver_grpchat_message(struct sipe_core_private *sipe_private,
822 const sipe_xml *grpchat);
823
824 static void chatserver_response_history(SIPE_UNUSED_PARAMETER struct sipe_core_private *sipe_private,
825 SIPE_UNUSED_PARAMETER struct sip_session *session,
826 SIPE_UNUSED_PARAMETER guint result,
827 SIPE_UNUSED_PARAMETER const gchar *message,
828 const sipe_xml *xml)
829 {
830 const sipe_xml *grpchat;
831
832 for (grpchat = sipe_xml_child(xml, "chanib/msg");
833 grpchat;
834 grpchat = sipe_xml_twin(grpchat))
835 if (sipe_strequal(sipe_xml_attribute(grpchat, "id"),
836 "grpchat"))
837 chatserver_grpchat_message(sipe_private, grpchat);
838 }
839
840 static void chatserver_response_part(struct sipe_core_private *sipe_private,
841 SIPE_UNUSED_PARAMETER struct sip_session *session,
842 guint result,
843 const gchar *message,
844 const sipe_xml *xml)
845 {
846 if (result != 200) {
847 SIPE_DEBUG_WARNING("chatserver_response_part: failed with %d: %s. Dropping room",
848 result, message);
849 } else {
850 struct sipe_groupchat *groupchat = sipe_private->groupchat;
851 const gchar *uri = sipe_xml_attribute(sipe_xml_child(xml, "chanib"),
852 "uri");
853 struct sipe_chat_session *chat_session;
854
855 if (uri &&
856 (chat_session = g_hash_table_lookup(groupchat->uri_to_chat_session,
857 uri))) {
858
859 SIPE_DEBUG_INFO("leaving room '%s' (%s)",
860 chat_session->title, chat_session->id);
861
862 g_hash_table_remove(groupchat->uri_to_chat_session,
863 uri);
864 sipe_chat_remove_session(chat_session);
865
866 } else {
867 SIPE_DEBUG_WARNING("chatserver_response_part: unknown chat room uri '%s'",
868 uri ? uri : "");
869 }
870 }
871 }
872
873 static void chatserver_notice_join(struct sipe_core_private *sipe_private,
874 SIPE_UNUSED_PARAMETER struct sip_session *session,
875 SIPE_UNUSED_PARAMETER guint result,
876 SIPE_UNUSED_PARAMETER const gchar *message,
877 const sipe_xml *xml)
878 {
879 struct sipe_groupchat *groupchat = sipe_private->groupchat;
880 const sipe_xml *uib;
881
882 for (uib = sipe_xml_child(xml, "uib");
883 uib;
884 uib = sipe_xml_twin(uib)) {
885 const gchar *uri = sipe_xml_attribute(uib, "uri");
886
887 if (uri) {
888 const sipe_xml *aib;
889
890 for (aib = sipe_xml_child(uib, "aib");
891 aib;
892 aib = sipe_xml_twin(aib)) {
893 const gchar *domain = sipe_xml_attribute(aib, "domain");
894 const gchar *path = sipe_xml_attribute(aib, "value");
895
896 if (domain && path) {
897 gchar *room_uri = g_strdup_printf("ma-chan://%s/%s",
898 domain, path);
899 struct sipe_chat_session *chat_session = g_hash_table_lookup(groupchat->uri_to_chat_session,
900 room_uri);
901 if (chat_session)
902 add_user(chat_session,
903 uri,
904 TRUE,
905 is_chanop(aib));
906
907 g_free(room_uri);
908 }
909 }
910 }
911 }
912 }
913
914 static void chatserver_notice_part(struct sipe_core_private *sipe_private,
915 SIPE_UNUSED_PARAMETER struct sip_session *session,
916 SIPE_UNUSED_PARAMETER guint result,
917 SIPE_UNUSED_PARAMETER const gchar *message,
918 const sipe_xml *xml)
919 {
920 struct sipe_groupchat *groupchat = sipe_private->groupchat;
921 const sipe_xml *chanib;
922
923 for (chanib = sipe_xml_child(xml, "chanib");
924 chanib;
925 chanib = sipe_xml_twin(chanib)) {
926 const gchar *room_uri = sipe_xml_attribute(chanib, "uri");
927
928 if (room_uri) {
929 struct sipe_chat_session *chat_session = g_hash_table_lookup(groupchat->uri_to_chat_session,
930 room_uri);
931
932 if (chat_session) {
933 const sipe_xml *uib;
934
935 for (uib = sipe_xml_child(chanib, "uib");
936 uib;
937 uib = sipe_xml_twin(uib)) {
938 const gchar *uri = sipe_xml_attribute(uib, "uri");
939
940 if (uri) {
941 SIPE_DEBUG_INFO("remove_user: %s from room %s (%s)",
942 uri,
943 chat_session->title,
944 chat_session->id);
945 sipe_backend_chat_remove(chat_session->backend,
946 uri);
947 }
948 }
949 }
950 }
951 }
952 }
953
954 static const struct response {
955 const gchar *key;
956 void (* const handler)(struct sipe_core_private *,
957 struct sip_session *,
958 guint result, const gchar *,
959 const sipe_xml *xml);
960 } response_table[] = {
961 { "rpl:requri", chatserver_response_uri },
962 { "rpl:chansrch", chatserver_response_channel_search },
963 { "rpl:join", chatserver_response_join },
964 { "rpl:bjoin", chatserver_response_join },
965 { "rpl:bccontext", chatserver_response_history },
966 { "rpl:part", chatserver_response_part },
967 { "ntc:join", chatserver_notice_join },
968 { "ntc:bjoin", chatserver_notice_join },
969 { "ntc:part", chatserver_notice_part },
970 { NULL, NULL }
971 };
972
973 /* Handles rpl:XXX & ntc:YYY */
974 static void chatserver_response(struct sipe_core_private *sipe_private,
975 const sipe_xml *reply,
976 struct sip_session *session)
977 {
978 do {
979 const sipe_xml *resp, *data;
980 const gchar *id;
981 gchar *message;
982 guint result = 500;
983 const struct response *r;
984
985 id = sipe_xml_attribute(reply, "id");
986 if (!id) {
987 SIPE_DEBUG_INFO_NOFORMAT("chatserver_response: no reply ID found!");
988 continue;
989 }
990
991 resp = sipe_xml_child(reply, "resp");
992 if (resp) {
993 result = sipe_xml_int_attribute(resp, "code", 500);
994 message = sipe_xml_data(resp);
995 } else {
996 message = g_strdup("");
997 }
998
999 data = sipe_xml_child(reply, "data");
1000
1001 SIPE_DEBUG_INFO("chatserver_response: '%s' result (%d) %s",
1002 id, result, message ? message : "");
1003
1004 for (r = response_table; r->key; r++) {
1005 if (sipe_strcase_equal(id, r->key)) {
1006 (*r->handler)(sipe_private, session, result, message, data);
1007 break;
1008 }
1009 }
1010 if (!r->key) {
1011 SIPE_DEBUG_INFO_NOFORMAT("chatserver_response: ignoring unknown response");
1012 }
1013
1014 g_free(message);
1015 } while ((reply = sipe_xml_twin(reply)) != NULL);
1016 }
1017
1018 static void chatserver_grpchat_message(struct sipe_core_private *sipe_private,
1019 const sipe_xml *grpchat)
1020 {
1021 struct sipe_groupchat *groupchat = sipe_private->groupchat;
1022 const gchar *uri = sipe_xml_attribute(grpchat, "chanUri");
1023 const gchar *from = sipe_xml_attribute(grpchat, "author");
1024 time_t when = sipe_utils_str_to_time(sipe_xml_attribute(grpchat, "ts"));
1025 gchar *text = sipe_xml_data(sipe_xml_child(grpchat, "chat"));
1026 struct sipe_chat_session *chat_session;
1027 gchar *escaped;
1028
1029 if (!uri || !from) {
1030 SIPE_DEBUG_INFO("chatserver_grpchat_message: message '%s' received without chat room URI or author!",
1031 text ? text : "");
1032 g_free(text);
1033 return;
1034 }
1035
1036 chat_session = g_hash_table_lookup(groupchat->uri_to_chat_session,
1037 uri);
1038 if (!chat_session) {
1039 SIPE_DEBUG_INFO("chatserver_grpchat_message: message '%s' from '%s' received from unknown chat room '%s'!",
1040 text ? text : "", from, uri);
1041 g_free(text);
1042 return;
1043 }
1044
1045 /* libxml2 decodes all entities, but the backend expects HTML */
1046 escaped = g_markup_escape_text(text, -1);
1047 g_free(text);
1048 sipe_backend_chat_message(SIPE_CORE_PUBLIC, chat_session->backend,
1049 from, when, escaped);
1050 g_free(escaped);
1051 }
1052
1053 void process_incoming_info_groupchat(struct sipe_core_private *sipe_private,
1054 struct sipmsg *msg,
1055 struct sip_session *session)
1056 {
1057 sipe_xml *xml = sipe_xml_parse(msg->body, msg->bodylen);
1058 const sipe_xml *node;
1059 const gchar *callid;
1060 struct sip_dialog *dialog;
1061
1062 callid = sipmsg_find_header(msg, "Call-ID");
1063 dialog = sipe_dialog_find(session, session->with);
1064 if (sipe_strequal(callid, dialog->callid)) {
1065
1066 sip_transport_response(sipe_private, msg, 200, "OK", NULL);
1067
1068 if (((node = sipe_xml_child(xml, "rpl")) != NULL) ||
1069 ((node = sipe_xml_child(xml, "ntc")) != NULL)) {
1070 chatserver_response(sipe_private, node, session);
1071 } else if ((node = sipe_xml_child(xml, "grpchat")) != NULL) {
1072 chatserver_grpchat_message(sipe_private, node);
1073 } else {
1074 SIPE_DEBUG_INFO_NOFORMAT("process_incoming_info_groupchat: ignoring unknown response");
1075 }
1076
1077 } else {
1078 /*
1079 * Our last session got disconnected without proper shutdown,
1080 * e.g. by Pidgin crashing or network connection loss. When
1081 * we reconnect to the group chat the server will send INFO
1082 * messages to the current *AND* the obsolete Call-ID, until
1083 * the obsolete session expires.
1084 *
1085 * Ignore these INFO messages to avoid, e.g. duplicate texts,
1086 * and respond with an error so that the server knows that we
1087 * consider this dialog to be terminated.
1088 */
1089 SIPE_DEBUG_INFO("process_incoming_info_groupchat: ignoring unsolicited INFO message to obsolete Call-ID: %s",
1090 callid);
1091
1092 sip_transport_response(sipe_private, msg, 487, "Request Terminated", NULL);
1093 }
1094
1095 sipe_xml_free(xml);
1096 }
1097
1098 void sipe_groupchat_send(struct sipe_core_private *sipe_private,
1099 struct sipe_chat_session *chat_session,
1100 const gchar *what)
1101 {
1102 struct sipe_groupchat *groupchat = sipe_private->groupchat;
1103 gchar *cmd, *self, *timestamp, *tmp;
1104 gchar **lines, **strvp;
1105 struct sipe_groupchat_msg *msg;
1106
1107 if (!groupchat || !chat_session)
1108 return;
1109
1110 SIPE_DEBUG_INFO("sipe_groupchat_send: '%s' to %s",
1111 what, chat_session->id);
1112
1113 self = sip_uri_self(sipe_private);
1114 timestamp = sipe_utils_time_to_str(time(NULL));
1115
1116 /**
1117 * 'what' is already XML-escaped, e.g.
1118 *
1119 * " -> &quot;
1120 * > -> &gt;
1121 * < -> &lt;
1122 * & -> &amp;
1123 *
1124 * Group Chat only accepts plain text, not full HTML. So we have to
1125 * strip all HTML tags and XML escape the text.
1126 *
1127 * Line breaks are encoded as <br> and therefore need to be replaced
1128 * before stripping. In order to prevent HTML stripping to strip line
1129 * endings, we need to split the text into lines on <br>.
1130 */
1131 lines = g_strsplit(what, "<br>", 0);
1132 for (strvp = lines; *strvp; strvp++) {
1133 /* replace array entry with HTML stripped & XML escaped version */
1134 gchar *stripped = sipe_backend_markup_strip_html(*strvp);
1135 gchar *escaped = g_markup_escape_text(stripped, -1);
1136 g_free(stripped);
1137 g_free(*strvp);
1138 *strvp = escaped;
1139 }
1140 tmp = g_strjoinv("\r\n", lines);
1141 g_strfreev(lines);
1142 cmd = g_strdup_printf("<grpchat id=\"grpchat\" seqid=\"1\" chanUri=\"%s\" author=\"%s\" ts=\"%s\">"
1143 "<chat>%s</chat>"
1144 "</grpchat>",
1145 chat_session->id, self, timestamp, tmp);
1146 g_free(tmp);
1147 g_free(timestamp);
1148 g_free(self);
1149 msg = chatserver_command(sipe_private, cmd);
1150 g_free(cmd);
1151
1152 if (msg) {
1153 msg->session = chat_session;
1154 msg->content = g_strdup(what);
1155 } else {
1156 chatserver_command_error_notify(sipe_private,
1157 chat_session,
1158 what);
1159 }
1160 }
1161
1162 void sipe_groupchat_leave(struct sipe_core_private *sipe_private,
1163 struct sipe_chat_session *chat_session)
1164 {
1165 struct sipe_groupchat *groupchat = sipe_private->groupchat;
1166 gchar *cmd;
1167
1168 if (!groupchat || !chat_session)
1169 return;
1170
1171 SIPE_DEBUG_INFO("sipe_groupchat_leave: %s", chat_session->id);
1172
1173 cmd = g_strdup_printf("<cmd id=\"cmd:part\" seqid=\"1\">"
1174 "<data>"
1175 "<chanib uri=\"%s\"/>"
1176 "</data>"
1177 "</cmd>", chat_session->id);
1178 chatserver_command(sipe_private, cmd);
1179 g_free(cmd);
1180 }
1181
1182 gboolean sipe_core_groupchat_query_rooms(struct sipe_core_public *sipe_public)
1183 {
1184 struct sipe_core_private *sipe_private = SIPE_CORE_PRIVATE;
1185 struct sipe_groupchat *groupchat = sipe_private->groupchat;
1186
1187 if (!groupchat || !groupchat->connected)
1188 return FALSE;
1189
1190 chatserver_command(sipe_private,
1191 "<cmd id=\"cmd:chansrch\" seqid=\"1\">"
1192 "<data>"
1193 "<qib qtype=\"BYNAME\" criteria=\"\" extended=\"false\"/>"
1194 "</data>"
1195 "</cmd>");
1196
1197 return TRUE;
1198 }
1199
1200 void sipe_core_groupchat_join(struct sipe_core_public *sipe_public,
1201 const gchar *uri)
1202 {
1203 struct sipe_core_private *sipe_private = SIPE_CORE_PRIVATE;
1204 struct sipe_groupchat *groupchat = sipe_private->groupchat;
1205
1206 if (!g_str_has_prefix(uri, "ma-chan://"))
1207 return;
1208
1209 if (!groupchat) {
1210 /* This happens when a user has set auto-join on a channel */
1211 sipe_groupchat_allocate(sipe_private);
1212 groupchat = sipe_private->groupchat;
1213 }
1214
1215 if (groupchat->connected) {
1216 struct sipe_chat_session *chat_session = g_hash_table_lookup(groupchat->uri_to_chat_session,
1217 uri);
1218
1219 /* Already joined? */
1220 if (chat_session) {
1221
1222 /* Yes, update backend session */
1223 SIPE_DEBUG_INFO("sipe_core_groupchat_join: show '%s' (%s)",
1224 chat_session->title,
1225 chat_session->id);
1226 sipe_backend_chat_show(chat_session->backend);
1227
1228 } else {
1229 /* No, send command out directly */
1230 gchar *chanid = generate_chanid_node(uri, 0);
1231 if (chanid) {
1232 gchar *cmd = g_strdup_printf("<cmd id=\"cmd:join\" seqid=\"1\">"
1233 "<data>%s</data>"
1234 "</cmd>",
1235 chanid);
1236 SIPE_DEBUG_INFO("sipe_core_groupchat_join: join %s",
1237 uri);
1238 chatserver_command(sipe_private, cmd);
1239 g_free(cmd);
1240 g_free(chanid);
1241 }
1242 }
1243 } else {
1244 /* Add it to the queue but avoid duplicates */
1245 if (!g_slist_find_custom(groupchat->join_queue, uri,
1246 sipe_strcompare)) {
1247 SIPE_DEBUG_INFO_NOFORMAT("sipe_core_groupchat_join: URI queued");
1248 groupchat->join_queue = g_slist_prepend(groupchat->join_queue,
1249 g_strdup(uri));
1250 }
1251 }
1252 }
1253
1254 void sipe_groupchat_rejoin(struct sipe_core_private *sipe_private,
1255 struct sipe_chat_session *chat_session)
1256 {
1257 struct sipe_groupchat *groupchat = sipe_private->groupchat;
1258
1259 if (!groupchat) {
1260 /* First rejoined channel after reconnect will trigger this */
1261 sipe_groupchat_allocate(sipe_private);
1262 groupchat = sipe_private->groupchat;
1263 }
1264
1265 /* Remember "old" session, so that we don't recreate it at join */
1266 g_hash_table_insert(groupchat->uri_to_chat_session,
1267 chat_session->id,
1268 chat_session);
1269 sipe_core_groupchat_join(SIPE_CORE_PUBLIC, chat_session->id);
1270 }
1271
1272 /*
1273 Local Variables:
1274 mode: c
1275 c-file-style: "bsd"
1276 indent-tabs-mode: t
1277 tab-width: 8
1278 End:
1279 */
A third-party Pidgin plugin for Microsoft LCS/OCS