?  search:
summary | log | graphiclog1 | graphiclog2 | refs | edit | fork

cfba3f41e688e0c9488612c9660e44e4b6c93a8c
[siplcs.git] / src / purple / purple-plugin.c
blobcfba3f41e688e0c9488612c9660e44e4b6c93a8c
1 /**
2 * @file purple-plugin.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 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26
27 #include <string.h>
28 #include <time.h>
29
30 #include <glib.h>
31
32 #include "sipe-common.h"
33
34 /* Flag needed for correct version of PURPLE_INIT_PLUGIN() */
35 #ifndef PURPLE_PLUGINS
36 #define PURPLE_PLUGINS
37 #endif
38
39 /* for LOCALEDIR
40 * as it's determined on runtime, as Pidgin installation can be anywhere.
41 */
42 #ifdef _WIN32
43 #include "win32/win32dep.h"
44 #endif
45
46 #include "accountopt.h"
47 #include "blist.h"
48 #include "connection.h"
49 #include "core.h"
50 #include "dnssrv.h"
51 #ifdef HAVE_VV
52 #include "media.h"
53 #endif
54 #include "prpl.h"
55 #include "plugin.h"
56 #include "request.h"
57 #include "status.h"
58 /*
59 * NOTE: Currently PURPLE_VERSION_CHECK(2,y,z) returns FALSE for libpurple >= 3.0.0.
60 * See also <http://developer.pidgin.im/ticket/14551>
61 *
62 * As a workaround an additional PURPLE_VERSION_CHECK(3,0,0) needs to be added.
63 */
64 #include "version.h"
65
66 #include "sipe-backend.h"
67 #include "sipe-core.h"
68 #include "sipe-nls.h"
69
70 #define _PurpleMessageFlags PurpleMessageFlags
71 #include "purple-private.h"
72
73 /* Backward compatibility when compiling against 2.4.x API */
74 #if !PURPLE_VERSION_CHECK(2,5,0) && !PURPLE_VERSION_CHECK(3,0,0)
75 #define PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY 0x0100
76 #endif
77
78 /*
79 * NOTE: this flag means two things:
80 *
81 * - is Single Sign-On supported, and
82 * - is Kerberos supported
83 */
84 #if defined(HAVE_LIBKRB5) || defined(HAVE_SSPI)
85 #define PURPLE_SIPE_SSO_AND_KERBEROS 1
86 #else
87 #define PURPLE_SIPE_SSO_AND_KERBEROS 0
88 #endif
89
90 /* Sipe core activity <-> Purple status mapping */
91 static const gchar * const activity_to_purple_map[SIPE_ACTIVITY_NUM_TYPES] = {
92 /* SIPE_ACTIVITY_UNSET */ "unset", /* == purple_primitive_get_id_from_type(PURPLE_STATUS_UNSET) */
93 /* SIPE_ACTIVITY_AVAILABLE */ "available", /* == purple_primitive_get_id_from_type(PURPLE_STATUS_AVAILABLE) */
94 /* SIPE_ACTIVITY_ONLINE */ "online",
95 /* SIPE_ACTIVITY_INACTIVE */ "idle",
96 /* SIPE_ACTIVITY_BUSY */ "busy",
97 /* SIPE_ACTIVITY_BUSYIDLE */ "busyidle",
98 /* SIPE_ACTIVITY_DND */ "do-not-disturb",
99 /* SIPE_ACTIVITY_BRB */ "be-right-back",
100 /* SIPE_ACTIVITY_AWAY */ "away", /* == purple_primitive_get_id_from_type(PURPLE_STATUS_AWAY) */
101 /* SIPE_ACTIVITY_LUNCH */ "out-to-lunch",
102 /* SIPE_ACTIVITY_INVISIBLE */ "invisible", /* == purple_primitive_get_id_from_type(PURPLE_STATUS_INVISIBLE) */
103 /* SIPE_ACTIVITY_OFFLINE */ "offline", /* == purple_primitive_get_id_from_type(PURPLE_STATUS_OFFLINE) */
104 /* SIPE_ACTIVITY_ON_PHONE */ "on-the-phone",
105 /* SIPE_ACTIVITY_IN_CONF */ "in-a-conference",
106 /* SIPE_ACTIVITY_IN_MEETING */ "in-a-meeting",
107 /* SIPE_ACTIVITY_OOF */ "out-of-office",
108 /* SIPE_ACTIVITY_URGENT_ONLY */ "urgent-interruptions-only",
109 };
110
111 GHashTable *purple_token_map;
112
113 static void sipe_purple_activity_init(void)
114 {
115 guint index;
116
117 purple_token_map = g_hash_table_new(g_str_hash, g_str_equal);
118 for (index = SIPE_ACTIVITY_UNSET;
119 index < SIPE_ACTIVITY_NUM_TYPES;
120 index++) {
121 g_hash_table_insert(purple_token_map,
122 (gchar *) activity_to_purple_map[index],
123 GUINT_TO_POINTER(index));
124 }
125 }
126
127 static void sipe_purple_activity_shutdown(void)
128 {
129 g_hash_table_destroy(purple_token_map);
130 }
131
132 const gchar *sipe_purple_activity_to_token(guint type)
133 {
134 return(activity_to_purple_map[type]);
135 }
136
137 guint sipe_purple_token_to_activity(const gchar *token)
138 {
139 return(GPOINTER_TO_UINT(g_hash_table_lookup(purple_token_map, token)));
140 }
141
142 gchar *sipe_backend_version(void)
143 {
144 return(g_strdup_printf("Purple/%s", purple_core_get_version()));
145 }
146
147 /* PurplePluginProtocolInfo function calls & data structure */
148 static const char *sipe_list_icon(SIPE_UNUSED_PARAMETER PurpleAccount *a,
149 SIPE_UNUSED_PARAMETER PurpleBuddy *b)
150 {
151 return "sipe";
152 }
153
154 static gchar *sipe_purple_status_text(PurpleBuddy *buddy)
155 {
156 const PurpleStatus *status = purple_presence_get_active_status(purple_buddy_get_presence(buddy));
157 return sipe_core_buddy_status(PURPLE_BUDDY_TO_SIPE_CORE_PUBLIC,
158 buddy->name,
159 sipe_purple_token_to_activity(purple_status_get_id(status)),
160 purple_status_get_name(status));
161 }
162
163 static void sipe_purple_tooltip_text(PurpleBuddy *buddy,
164 PurpleNotifyUserInfo *user_info,
165 SIPE_UNUSED_PARAMETER gboolean full)
166 {
167 const PurplePresence *presence = purple_buddy_get_presence(buddy);
168 sipe_core_buddy_tooltip_info(PURPLE_BUDDY_TO_SIPE_CORE_PUBLIC,
169 buddy->name,
170 purple_status_get_name(purple_presence_get_active_status(presence)),
171 purple_presence_is_online(presence),
172 (struct sipe_backend_buddy_tooltip *) user_info);
173 }
174
175 static GList *sipe_purple_status_types(SIPE_UNUSED_PARAMETER PurpleAccount *acc)
176 {
177 PurpleStatusType *type;
178 GList *types = NULL;
179
180 /* Macros to reduce code repetition.
181 Translators: noun */
182 #define SIPE_ADD_STATUS(prim,id,name,user) type = purple_status_type_new_with_attrs( \
183 prim, id, name, \
184 TRUE, user, FALSE, \
185 SIPE_PURPLE_STATUS_ATTR_ID_MESSAGE, _("Message"), purple_value_new(PURPLE_TYPE_STRING), \
186 NULL); \
187 types = g_list_append(types, type);
188
189 /* Online */
190 SIPE_ADD_STATUS(PURPLE_STATUS_AVAILABLE,
191 NULL,
192 NULL,
193 TRUE);
194
195 /* Busy */
196 SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
197 sipe_purple_activity_to_token(SIPE_ACTIVITY_BUSY),
198 sipe_core_activity_description(SIPE_ACTIVITY_BUSY),
199 TRUE);
200
201 /* Do Not Disturb */
202 SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
203 sipe_purple_activity_to_token(SIPE_ACTIVITY_DND),
204 NULL,
205 TRUE);
206
207 /* In a call */
208 SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
209 sipe_purple_activity_to_token(SIPE_ACTIVITY_ON_PHONE),
210 sipe_core_activity_description(SIPE_ACTIVITY_ON_PHONE),
211 FALSE);
212
213 /* In a conference call */
214 SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
215 sipe_purple_activity_to_token(SIPE_ACTIVITY_IN_CONF),
216 sipe_core_activity_description(SIPE_ACTIVITY_IN_CONF),
217 FALSE);
218
219 /* Away */
220 /* Goes first in the list as
221 * purple picks the first status with the AWAY type
222 * for idle.
223 */
224 SIPE_ADD_STATUS(PURPLE_STATUS_AWAY,
225 NULL,
226 NULL,
227 TRUE);
228
229 /* Be Right Back */
230 SIPE_ADD_STATUS(PURPLE_STATUS_AWAY,
231 sipe_purple_activity_to_token(SIPE_ACTIVITY_BRB),
232 sipe_core_activity_description(SIPE_ACTIVITY_BRB),
233 TRUE);
234
235 /* Appear Offline */
236 SIPE_ADD_STATUS(PURPLE_STATUS_INVISIBLE,
237 NULL,
238 NULL,
239 TRUE);
240
241 /* Offline */
242 type = purple_status_type_new(PURPLE_STATUS_OFFLINE,
243 NULL,
244 NULL,
245 TRUE);
246 types = g_list_append(types, type);
247
248 return types;
249 }
250
251 static GList *sipe_purple_blist_node_menu(PurpleBlistNode *node)
252 {
253 if(PURPLE_BLIST_NODE_IS_BUDDY(node)) {
254 return sipe_purple_buddy_menu((PurpleBuddy *) node);
255 } else if(PURPLE_BLIST_NODE_IS_CHAT(node)) {
256 return sipe_purple_chat_menu((PurpleChat *)node);
257 } else {
258 return NULL;
259 }
260 }
261
262 static guint get_authentication_type(PurpleAccount *account)
263 {
264 const gchar *auth = purple_account_get_string(account, "authentication", "ntlm");
265
266 /* map option list to type - default is NTLM */
267 guint authentication_type = SIPE_AUTHENTICATION_TYPE_NTLM;
268 #if PURPLE_SIPE_SSO_AND_KERBEROS
269 if (sipe_strequal(auth, "krb5")) {
270 authentication_type = SIPE_AUTHENTICATION_TYPE_KERBEROS;
271 }
272 #endif
273 if (sipe_strequal(auth, "tls-dsk")) {
274 authentication_type = SIPE_AUTHENTICATION_TYPE_TLS_DSK;
275 }
276
277 return(authentication_type);
278 }
279
280 static gboolean get_sso_flag(PurpleAccount *account)
281 {
282 #if PURPLE_SIPE_SSO_AND_KERBEROS
283 /*
284 * NOTE: the default must be *OFF*, i.e. it is up to the user to tell
285 * SIPE that it is OK to use Single Sign-On or not.
286 */
287 return(purple_account_get_bool(account, "sso", FALSE));
288 #else
289 (void) account; /* keep compiler happy */
290 return(FALSE);
291 #endif
292 }
293
294 static gboolean get_dont_publish_flag(PurpleAccount *account)
295 {
296 /* default is to publish calendar information */
297 return(purple_account_get_bool(account, "dont-publish", FALSE));
298 }
299
300 static void connect_to_core(PurpleConnection *gc,
301 PurpleAccount *account,
302 const gchar *password)
303 {
304 const gchar *username = purple_account_get_username(account);
305 const gchar *email = purple_account_get_string(account, "email", NULL);
306 const gchar *email_url = purple_account_get_string(account, "email_url", NULL);
307 const gchar *transport = purple_account_get_string(account, "transport", "auto");
308 struct sipe_core_public *sipe_public;
309 gchar **username_split;
310 gchar *login_domain = NULL;
311 gchar *login_account = NULL;
312 const gchar *errmsg;
313 guint transport_type;
314 struct sipe_backend_private *purple_private;
315 gboolean sso = get_sso_flag(account);
316
317 /* username format: <username>,[<optional login>] */
318 SIPE_DEBUG_INFO("sipe_purple_login: username '%s'", username);
319 username_split = g_strsplit(username, ",", 2);
320
321 /* login name is ignored when SSO has been selected */
322 if (!sso) {
323 /* login name specified? */
324 if (username_split[1] && strlen(username_split[1])) {
325 /* Allowed domain-account separators are / or \ */
326 gchar **domain_user = g_strsplit_set(username_split[1], "/\\", 2);
327 gboolean has_domain = domain_user[1] != NULL;
328 SIPE_DEBUG_INFO("sipe_purple_login: login '%s'", username_split[1]);
329 login_domain = has_domain ? g_strdup(domain_user[0]) : NULL;
330 login_account = g_strdup(domain_user[has_domain ? 1 : 0]);
331 SIPE_DEBUG_INFO("sipe_purple_login: auth domain '%s' user '%s'",
332 login_domain ? login_domain : "",
333 login_account);
334 g_strfreev(domain_user);
335 } else {
336 /* No -> duplicate username */
337 login_account = g_strdup(username_split[0]);
338 }
339 }
340
341 sipe_public = sipe_core_allocate(username_split[0],
342 sso,
343 login_domain, login_account,
344 password,
345 email,
346 email_url,
347 &errmsg);
348 g_free(login_domain);
349 g_free(login_account);
350 g_strfreev(username_split);
351
352 if (!sipe_public) {
353 #if PURPLE_VERSION_CHECK(3,0,0)
354 purple_connection_error(
355 #else
356 purple_connection_error_reason(
357 #endif
358 gc,
359 PURPLE_CONNECTION_ERROR_INVALID_USERNAME,
360 errmsg);
361 return;
362 }
363
364 sipe_public->backend_private = purple_private = g_new0(struct sipe_backend_private, 1);
365 purple_private->public = sipe_public;
366 purple_private->gc = gc;
367 purple_private->account = account;
368
369 sipe_purple_chat_setup_rejoin(purple_private);
370
371 SIPE_CORE_FLAG_UNSET(DONT_PUBLISH);
372 if (get_dont_publish_flag(account))
373 SIPE_CORE_FLAG_SET(DONT_PUBLISH);
374
375 gc->proto_data = sipe_public;
376 gc->flags |= PURPLE_CONNECTION_HTML | PURPLE_CONNECTION_FORMATTING_WBFO | PURPLE_CONNECTION_NO_BGCOLOR |
377 PURPLE_CONNECTION_NO_FONTSIZE | PURPLE_CONNECTION_NO_URLDESC | PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY;
378 purple_connection_set_display_name(gc, sipe_public->sip_name);
379 purple_connection_update_progress(gc, _("Connecting"), 1, 2);
380
381 username_split = g_strsplit(purple_account_get_string(account, "server", ""), ":", 2);
382 if (sipe_strequal(transport, "auto")) {
383 transport_type = (username_split[0] == NULL) ?
384 SIPE_TRANSPORT_AUTO : SIPE_TRANSPORT_TLS;
385 } else if (sipe_strequal(transport, "tls")) {
386 transport_type = SIPE_TRANSPORT_TLS;
387 } else {
388 transport_type = SIPE_TRANSPORT_TCP;
389 }
390 sipe_core_transport_sip_connect(sipe_public,
391 transport_type,
392 get_authentication_type(account),
393 username_split[0],
394 username_split[0] ? username_split[1] : NULL);
395 g_strfreev(username_split);
396 }
397
398 static void password_required_cb(PurpleConnection *gc,
399 SIPE_UNUSED_PARAMETER PurpleRequestFields *fields)
400 {
401 if (!PURPLE_CONNECTION_IS_VALID(gc))
402 return;
403
404 #if PURPLE_VERSION_CHECK(3,0,0)
405 purple_connection_error(
406 #else
407 purple_connection_error_reason(
408 #endif
409 gc,
410 PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED,
411 _("Password required"));
412 }
413
414 static void password_ok_cb(PurpleConnection *gc,
415 PurpleRequestFields *fields)
416 {
417 const gchar *password;
418
419 if (!PURPLE_CONNECTION_IS_VALID(gc))
420 return;
421
422 password = purple_request_fields_get_string(fields, "password");
423
424 if (password && strlen(password)) {
425 PurpleAccount *account = purple_connection_get_account(gc);
426
427 if (purple_request_fields_get_bool(fields, "remember"))
428 purple_account_set_remember_password(account, TRUE);
429 purple_account_set_password(account, password
430 #if PURPLE_VERSION_CHECK(3,0,0)
431 , NULL, NULL
432 #endif
433 );
434
435 /* Now we have a password and we can connect */
436 connect_to_core(gc, account, password);
437
438 } else
439 /* reject an empty password */
440 password_required_cb(gc, fields);
441 }
442
443 static void sipe_purple_login(PurpleAccount *account)
444 {
445 PurpleConnection *gc = purple_account_get_connection(account);
446 const gchar *password = purple_connection_get_password(gc);
447
448 /* Password required? */
449 if (sipe_core_transport_sip_requires_password(get_authentication_type(account),
450 get_sso_flag(account)) &&
451 (!password || !strlen(password)))
452 /* No password set - request one from user */
453 purple_account_request_password(account,
454 G_CALLBACK(password_ok_cb),
455 G_CALLBACK(password_required_cb),
456 gc);
457 else
458 /* No password required or saved password - connect now */
459 connect_to_core(gc, account, password);
460
461 }
462
463 static void sipe_purple_close(PurpleConnection *gc)
464 {
465 struct sipe_core_public *sipe_public = PURPLE_GC_TO_SIPE_CORE_PUBLIC;
466
467 if (sipe_public) {
468 struct sipe_backend_private *purple_private = sipe_public->backend_private;
469
470 sipe_core_deallocate(sipe_public);
471
472 /* anything left after that must be in pending state... */
473 sipe_purple_dns_query_cancel_all(purple_private);
474 sipe_purple_transport_close_all(purple_private);
475
476 if (purple_private->roomlist_map)
477 g_hash_table_destroy(purple_private->roomlist_map);
478 sipe_purple_chat_destroy_rejoin(purple_private);
479 g_free(purple_private);
480 gc->proto_data = NULL;
481 }
482 }
483
484 static int sipe_purple_send_im(PurpleConnection *gc,
485 const char *who,
486 const char *what,
487 SIPE_UNUSED_PARAMETER PurpleMessageFlags flags)
488 {
489 sipe_core_im_send(PURPLE_GC_TO_SIPE_CORE_PUBLIC, who, what);
490 return 1;
491 }
492
493 static unsigned int sipe_purple_send_typing(PurpleConnection *gc,
494 const char *who,
495 PurpleTypingState state)
496 {
497 gboolean typing = (state == PURPLE_TYPING);
498
499 /* only enable this debug output while testing
500 SIPE_DEBUG_INFO("sipe_purple_send_typing: '%s' state %d", who, state); */
501
502 sipe_core_user_feedback_typing(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
503 who,
504 typing);
505
506 /* tell libpurple to send typing indications every 4 seconds */
507 return(typing ? 4 : 0);
508 }
509
510 static void sipe_purple_get_info(PurpleConnection *gc, const char *who)
511 {
512 sipe_core_buddy_get_info(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
513 who);
514 }
515
516 static void sipe_purple_add_permit(PurpleConnection *gc, const char *name)
517 {
518 sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, TRUE);
519 }
520
521 static void sipe_purple_add_deny(PurpleConnection *gc, const char *name)
522 {
523 sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, FALSE);
524 }
525
526 static void sipe_purple_keep_alive(PurpleConnection *gc)
527 {
528 struct sipe_core_public *sipe_public = PURPLE_GC_TO_SIPE_CORE_PUBLIC;
529 struct sipe_backend_private *purple_private = sipe_public->backend_private;
530 time_t now = time(NULL);
531
532 if ((sipe_public->keepalive_timeout > 0) &&
533 ((guint) (now - purple_private->last_keepalive) >= sipe_public->keepalive_timeout) &&
534 ((guint) (now - gc->last_received) >= sipe_public->keepalive_timeout)
535 ) {
536 sipe_core_transport_sip_keepalive(sipe_public);
537 purple_private->last_keepalive = now;
538 }
539 }
540
541 static void sipe_purple_alias_buddy(PurpleConnection *gc, const char *name,
542 const char *alias)
543 {
544 sipe_core_group_set_alias(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, alias);
545 }
546
547 static void sipe_purple_group_rename(PurpleConnection *gc,
548 const char *old_name,
549 PurpleGroup *group,
550 SIPE_UNUSED_PARAMETER GList *moved_buddies)
551 {
552 sipe_core_group_rename(PURPLE_GC_TO_SIPE_CORE_PUBLIC, old_name, group->name);
553 }
554
555 static void sipe_purple_convo_closed(PurpleConnection *gc,
556 const char *who)
557 {
558 sipe_core_im_close(PURPLE_GC_TO_SIPE_CORE_PUBLIC, who);
559 }
560
561 static void sipe_purple_group_remove(PurpleConnection *gc, PurpleGroup *group)
562 {
563 sipe_core_group_remove(PURPLE_GC_TO_SIPE_CORE_PUBLIC, group->name);
564 }
565
566 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
567 static GHashTable *
568 sipe_purple_get_account_text_table(SIPE_UNUSED_PARAMETER PurpleAccount *account)
569 {
570 GHashTable *table;
571 table = g_hash_table_new(g_str_hash, g_str_equal);
572 g_hash_table_insert(table, "login_label", (gpointer)_("user@company.com"));
573 return table;
574 }
575
576 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
577 #ifdef HAVE_VV
578
579 static void
580 sipe_purple_sigusr1_handler(SIPE_UNUSED_PARAMETER int signum)
581 {
582 capture_pipeline("PURPLE_SIPE_PIPELINE");
583 }
584
585 static gboolean sipe_purple_initiate_media(PurpleAccount *account, const char *who,
586 SIPE_UNUSED_PARAMETER PurpleMediaSessionType type)
587 {
588 sipe_core_media_initiate_call(PURPLE_ACCOUNT_TO_SIPE_CORE_PUBLIC,
589 who,
590 (type & PURPLE_MEDIA_VIDEO));
591 return TRUE;
592 }
593
594 static PurpleMediaCaps sipe_purple_get_media_caps(SIPE_UNUSED_PARAMETER PurpleAccount *account,
595 SIPE_UNUSED_PARAMETER const char *who)
596 {
597 return PURPLE_MEDIA_CAPS_AUDIO
598 | PURPLE_MEDIA_CAPS_AUDIO_VIDEO
599 | PURPLE_MEDIA_CAPS_MODIFY_SESSION;
600 }
601 #endif
602 #endif
603 #endif
604
605 /*
606 * Simplistic source upward compatibility path for newer libpurple APIs
607 *
608 * Usually we compile with -Werror=missing-field-initializers if GCC supports
609 * it. But that means that the compilation of this structure can fail if the
610 * newer API has added additional plugin callbacks. For the benefit of the
611 * user we downgrade it to a warning here.
612 *
613 * Diagnostic #pragma was added in GCC 4.2.0
614 * Diagnostic push/pop was added in GCC 4.6.0
615 */
616 #ifdef __GNUC__
617 #if (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 2)
618 #if __GNUC_MINOR__ >= 6
619 #pragma GCC diagnostic push
620 #endif
621 #pragma GCC diagnostic warning "-Wmissing-field-initializers"
622 #endif
623 #endif
624 static PurplePluginProtocolInfo sipe_prpl_info =
625 {
626 #if PURPLE_VERSION_CHECK(3,0,0)
627 sizeof(PurplePluginProtocolInfo), /* struct_size */
628 #endif
629 OPT_PROTO_CHAT_TOPIC |
630 OPT_PROTO_PASSWORD_OPTIONAL,
631 NULL, /* user_splits */
632 NULL, /* protocol_options */
633 NO_BUDDY_ICONS, /* icon_spec */
634 sipe_list_icon, /* list_icon */
635 NULL, /* list_emblems */
636 sipe_purple_status_text, /* status_text */
637 sipe_purple_tooltip_text, /* tooltip_text */ // add custom info to contact tooltip
638 sipe_purple_status_types, /* away_states */
639 sipe_purple_blist_node_menu, /* blist_node_menu */
640 sipe_purple_chat_info, /* chat_info */
641 sipe_purple_chat_info_defaults, /* chat_info_defaults */
642 sipe_purple_login, /* login */
643 sipe_purple_close, /* close */
644 sipe_purple_send_im, /* send_im */
645 NULL, /* set_info */ // TODO maybe
646 sipe_purple_send_typing, /* send_typing */
647 sipe_purple_get_info, /* get_info */
648 sipe_purple_set_status, /* set_status */
649 sipe_purple_set_idle, /* set_idle */
650 NULL, /* change_passwd */
651 sipe_purple_add_buddy, /* add_buddy */
652 NULL, /* add_buddies */
653 sipe_purple_remove_buddy, /* remove_buddy */
654 NULL, /* remove_buddies */
655 sipe_purple_add_permit, /* add_permit */
656 sipe_purple_add_deny, /* add_deny */
657 sipe_purple_add_deny, /* rem_permit */
658 sipe_purple_add_permit, /* rem_deny */
659 NULL, /* set_permit_deny */
660 sipe_purple_chat_join, /* join_chat */
661 NULL, /* reject_chat */
662 NULL, /* get_chat_name */
663 sipe_purple_chat_invite, /* chat_invite */
664 sipe_purple_chat_leave, /* chat_leave */
665 NULL, /* chat_whisper */
666 sipe_purple_chat_send, /* chat_send */
667 sipe_purple_keep_alive, /* keepalive */
668 NULL, /* register_user */
669 NULL, /* get_cb_info */ // deprecated
670 #if !PURPLE_VERSION_CHECK(3,0,0)
671 NULL, /* get_cb_away */ // deprecated
672 #endif
673 sipe_purple_alias_buddy, /* alias_buddy */
674 sipe_purple_group_buddy, /* group_buddy */
675 sipe_purple_group_rename, /* rename_group */
676 NULL, /* buddy_free */
677 sipe_purple_convo_closed, /* convo_closed */
678 purple_normalize_nocase, /* normalize */
679 NULL, /* set_buddy_icon */
680 sipe_purple_group_remove, /* remove_group */
681 NULL, /* get_cb_real_name */ // TODO?
682 NULL, /* set_chat_topic */
683 NULL, /* find_blist_chat */
684 sipe_purple_roomlist_get_list, /* roomlist_get_list */
685 sipe_purple_roomlist_cancel, /* roomlist_cancel */
686 NULL, /* roomlist_expand_category */
687 NULL, /* can_receive_file */
688 sipe_purple_ft_send_file, /* send_file */
689 sipe_purple_ft_new_xfer, /* new_xfer */
690 NULL, /* offline_message */
691 NULL, /* whiteboard_prpl_ops */
692 NULL, /* send_raw */
693 NULL, /* roomlist_room_serialize */
694 NULL, /* unregister_user */
695 NULL, /* send_attention */
696 NULL, /* get_attention_types */
697 #if !PURPLE_VERSION_CHECK(2,5,0) && !PURPLE_VERSION_CHECK(3,0,0)
698 /* Backward compatibility when compiling against 2.4.x API */
699 (void (*)(void)) /* _purple_reserved4 */
700 #endif
701 #if !PURPLE_VERSION_CHECK(3,0,0)
702 sizeof(PurplePluginProtocolInfo), /* struct_size */
703 #endif
704 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
705 sipe_purple_get_account_text_table, /* get_account_text_table */
706 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
707 #ifdef HAVE_VV
708 sipe_purple_initiate_media, /* initiate_media */
709 sipe_purple_get_media_caps, /* get_media_caps */
710 #else
711 NULL, /* initiate_media */
712 NULL, /* get_media_caps */
713 #endif
714 #if PURPLE_VERSION_CHECK(2,7,0) || PURPLE_VERSION_CHECK(3,0,0)
715 NULL, /* get_moods */
716 NULL, /* set_public_alias */
717 NULL, /* get_public_alias */
718 #if PURPLE_VERSION_CHECK(2,8,0)
719 NULL, /* add_buddy_with_invite */
720 NULL, /* add_buddies_with_invite */
721 #endif
722 #endif
723 #endif
724 #endif
725 };
726 #ifdef __GNUC__
727 #if (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 6)
728 #pragma GCC diagnostic pop
729 #endif
730 #endif
731 /* Original GCC error checking restored from here on... (see above) */
732
733 /* PurplePluginInfo function calls & data structure */
734 static gboolean sipe_purple_plugin_load(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
735 {
736 #ifdef HAVE_VV
737 struct sigaction action;
738 memset(&action, 0, sizeof (action));
739 action.sa_handler = sipe_purple_sigusr1_handler;
740 sigaction(SIGUSR1, &action, NULL);
741 #endif
742 return TRUE;
743 }
744
745 static gboolean sipe_purple_plugin_unload(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
746 {
747 #ifdef HAVE_VV
748 struct sigaction action;
749 memset(&action, 0, sizeof (action));
750 action.sa_handler = SIG_DFL;
751 sigaction(SIGUSR1, &action, NULL);
752 #endif
753 return TRUE;
754 }
755
756 static void sipe_purple_plugin_destroy(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
757 {
758 GList *entry;
759
760 sipe_purple_activity_shutdown();
761 sipe_core_destroy();
762
763 entry = sipe_prpl_info.protocol_options;
764 while (entry) {
765 purple_account_option_destroy(entry->data);
766 entry = g_list_delete_link(entry, entry);
767 }
768 sipe_prpl_info.protocol_options = NULL;
769
770 entry = sipe_prpl_info.user_splits;
771 while (entry) {
772 purple_account_user_split_destroy(entry->data);
773 entry = g_list_delete_link(entry, entry);
774 }
775 sipe_prpl_info.user_splits = NULL;
776 }
777
778 static void sipe_purple_show_about_plugin(PurplePluginAction *action)
779 {
780 gchar *tmp = sipe_core_about();
781 purple_notify_formatted((PurpleConnection *) action->context,
782 NULL, " ", NULL, tmp, NULL, NULL);
783 g_free(tmp);
784 }
785
786 static void sipe_purple_find_contact_cb(PurpleConnection *gc,
787 PurpleRequestFields *fields)
788 {
789 GList *entries = purple_request_field_group_get_fields(purple_request_fields_get_groups(fields)->data);
790 const gchar *given_name = NULL;
791 const gchar *surname = NULL;
792 const gchar *email = NULL;
793 const gchar *company = NULL;
794 const gchar *country = NULL;
795
796 while (entries) {
797 PurpleRequestField *field = entries->data;
798 const char *id = purple_request_field_get_id(field);
799 const char *value = purple_request_field_string_get_value(field);
800
801 SIPE_DEBUG_INFO("sipe_purple_find_contact_cb: %s = '%s'", id, value ? value : "");
802
803 if (value) {
804 if (strcmp(id, "given") == 0) {
805 given_name = value;
806 } else if (strcmp(id, "surname") == 0) {
807 surname = value;
808 } else if (strcmp(id, "email") == 0) {
809 email = value;
810 } else if (strcmp(id, "company") == 0) {
811 company = value;
812 } else if (strcmp(id, "country") == 0) {
813 country = value;
814 }
815 }
816
817 entries = g_list_next(entries);
818 };
819
820 sipe_core_buddy_search(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
821 NULL,
822 given_name,
823 surname,
824 email,
825 company,
826 country);
827 }
828
829 static void sipe_purple_show_find_contact(PurplePluginAction *action)
830 {
831 PurpleConnection *gc = (PurpleConnection *) action->context;
832 PurpleRequestFields *fields;
833 PurpleRequestFieldGroup *group;
834 PurpleRequestField *field;
835
836 fields = purple_request_fields_new();
837 group = purple_request_field_group_new(NULL);
838 purple_request_fields_add_group(fields, group);
839
840 field = purple_request_field_string_new("given", _("First name"), NULL, FALSE);
841 purple_request_field_group_add_field(group, field);
842 field = purple_request_field_string_new("surname", _("Last name"), NULL, FALSE);
843 purple_request_field_group_add_field(group, field);
844 field = purple_request_field_string_new("email", _("Email"), NULL, FALSE);
845 purple_request_field_group_add_field(group, field);
846 field = purple_request_field_string_new("company", _("Company"), NULL, FALSE);
847 purple_request_field_group_add_field(group, field);
848 field = purple_request_field_string_new("country", _("Country"), NULL, FALSE);
849 purple_request_field_group_add_field(group, field);
850
851 purple_request_fields(gc,
852 _("Search"),
853 _("Search for a contact"),
854 _("Enter the information for the person you wish to find. Empty fields will be ignored."),
855 fields,
856 _("_Search"), G_CALLBACK(sipe_purple_find_contact_cb),
857 _("_Cancel"), NULL,
858 purple_connection_get_account(gc), NULL, NULL, gc);
859 }
860
861 static void sipe_purple_join_conference_cb(PurpleConnection *gc,
862 PurpleRequestFields *fields)
863 {
864 GList *entries = purple_request_field_group_get_fields(purple_request_fields_get_groups(fields)->data);
865
866 if (entries) {
867 PurpleRequestField *field = entries->data;
868 const char *id = purple_request_field_get_id(field);
869 const char *value = purple_request_field_string_get_value(field);
870
871 if (!sipe_strequal(id, "meetingLocation"))
872 return;
873
874 sipe_core_conf_create(PURPLE_GC_TO_SIPE_CORE_PUBLIC, value);
875 }
876 }
877
878 #ifdef HAVE_VV
879
880 static void sipe_purple_phone_call_cb(PurpleConnection *gc,
881 PurpleRequestFields *fields)
882 {
883 GList *entries = purple_request_field_group_get_fields(purple_request_fields_get_groups(fields)->data);
884
885 if (entries) {
886 PurpleRequestField *field = entries->data;
887 const char *id = purple_request_field_get_id(field);
888 const char *value = purple_request_field_string_get_value(field);
889
890 if (!sipe_strequal(id, "phoneNumber"))
891 return;
892
893 sipe_core_media_phone_call(PURPLE_GC_TO_SIPE_CORE_PUBLIC, value);
894 }
895 }
896
897 static void sipe_purple_phone_call(PurplePluginAction *action)
898 {
899 PurpleConnection *gc = (PurpleConnection *) action->context;
900 PurpleRequestFields *fields;
901 PurpleRequestFieldGroup *group;
902 PurpleRequestField *field;
903
904 fields = purple_request_fields_new();
905 group = purple_request_field_group_new(NULL);
906 purple_request_fields_add_group(fields, group);
907
908 field = purple_request_field_string_new("phoneNumber", _("Phone number"), NULL, FALSE);
909 purple_request_field_group_add_field(group, field);
910
911 purple_request_fields(gc,
912 _("Call a phone number"),
913 _("Call a phone number"),
914 NULL,
915 fields,
916 _("_Call"), G_CALLBACK(sipe_purple_phone_call_cb),
917 _("_Cancel"), NULL,
918 purple_connection_get_account(gc), NULL, NULL, gc);
919 }
920
921 static void sipe_purple_test_call(PurplePluginAction *action)
922 {
923 PurpleConnection *gc = (PurpleConnection *) action->context;
924 sipe_core_media_test_call(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
925 }
926 #endif
927
928 static void sipe_purple_show_join_conference(PurplePluginAction *action)
929 {
930 PurpleConnection *gc = (PurpleConnection *) action->context;
931 PurpleRequestFields *fields;
932 PurpleRequestFieldGroup *group;
933 PurpleRequestField *field;
934
935 fields = purple_request_fields_new();
936 group = purple_request_field_group_new(NULL);
937 purple_request_fields_add_group(fields, group);
938
939 field = purple_request_field_string_new("meetingLocation", _("Meeting location"), NULL, FALSE);
940 purple_request_field_group_add_field(group, field);
941
942 purple_request_fields(gc,
943 _("Join conference"),
944 _("Join scheduled conference"),
945 _("Enter meeting location string you received in the invitation.\n"
946 "\n"
947 "Valid location will be something like\n"
948 "meet:sip:someone@company.com;gruu;opaque=app:conf:focus:id:abcdef1234\n"
949 "conf:sip:someone@company.com;gruu;opaque=app:conf:focus:id:abcdef1234\n"
950 "or\n"
951 "https://meet.company.com/someone/abcdef1234"),
952 fields,
953 _("_Join"), G_CALLBACK(sipe_purple_join_conference_cb),
954 _("_Cancel"), NULL,
955 purple_connection_get_account(gc), NULL, NULL, gc);
956 }
957
958 static void sipe_purple_republish_calendar(PurplePluginAction *action)
959 {
960 PurpleConnection *gc = (PurpleConnection *) action->context;
961 PurpleAccount *account = purple_connection_get_account(gc);
962
963 if (get_dont_publish_flag(account)) {
964 sipe_backend_notify_error(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
965 _("Publishing of calendar information has been disabled"),
966 NULL);
967 } else {
968 sipe_core_update_calendar(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
969 }
970 }
971
972 static void sipe_purple_reset_status(PurplePluginAction *action)
973 {
974 PurpleConnection *gc = (PurpleConnection *) action->context;
975 PurpleAccount *account = purple_connection_get_account(gc);
976
977 if (get_dont_publish_flag(account)) {
978 sipe_backend_notify_error(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
979 _("Publishing of calendar information has been disabled"),
980 NULL);
981 } else {
982 sipe_core_reset_status(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
983 }
984 }
985
986 static GList *sipe_purple_actions(SIPE_UNUSED_PARAMETER PurplePlugin *plugin,
987 SIPE_UNUSED_PARAMETER gpointer context)
988 {
989 GList *menu = NULL;
990 PurplePluginAction *act;
991
992 act = purple_plugin_action_new(_("About SIPE plugin..."), sipe_purple_show_about_plugin);
993 menu = g_list_prepend(menu, act);
994
995 act = purple_plugin_action_new(_("Contact search..."), sipe_purple_show_find_contact);
996 menu = g_list_prepend(menu, act);
997
998 #ifdef HAVE_VV
999 act = purple_plugin_action_new(_("Call a phone number..."), sipe_purple_phone_call);
1000 menu = g_list_prepend(menu, act);
1001
1002 act = purple_plugin_action_new(_("Test call"), sipe_purple_test_call);
1003 menu = g_list_prepend(menu, act);
1004 #endif
1005
1006 act = purple_plugin_action_new(_("Join scheduled conference..."), sipe_purple_show_join_conference);
1007 menu = g_list_prepend(menu, act);
1008
1009 act = purple_plugin_action_new(_("Republish Calendar"), sipe_purple_republish_calendar);
1010 menu = g_list_prepend(menu, act);
1011
1012 act = purple_plugin_action_new(_("Reset status"), sipe_purple_reset_status);
1013 menu = g_list_prepend(menu, act);
1014
1015 return g_list_reverse(menu);
1016 }
1017
1018 static PurplePluginInfo sipe_purple_info = {
1019 PURPLE_PLUGIN_MAGIC,
1020 PURPLE_MAJOR_VERSION,
1021 PURPLE_MINOR_VERSION,
1022 PURPLE_PLUGIN_PROTOCOL, /**< type */
1023 NULL, /**< ui_requirement */
1024 0, /**< flags */
1025 NULL, /**< dependencies */
1026 PURPLE_PRIORITY_DEFAULT, /**< priority */
1027 "prpl-sipe", /**< id */
1028 "Office Communicator", /**< name */
1029 PACKAGE_VERSION, /**< version */
1030 "Microsoft Office Communicator Protocol Plugin", /**< summary */
1031 "A plugin for the extended SIP/SIMPLE protocol used by " /**< description */
1032 "Microsoft Live/Office Communications/Lync Server (LCS2005/OCS2007+)", /**< description */
1033 "Stefan Becker <chemobejk@gmail.com>, " /**< author */
1034 "Jakub Adam <jakub.adam@tieto.com>, " /**< author */
1035 "Anibal Avelar <avelar@gmail.com> (retired), " /**< author */
1036 "pier11 <pier11@operamail.com> (retired), " /**< author */
1037 "Gabriel Burt <gburt@novell.com> (retired)", /**< author */
1038 PACKAGE_URL, /**< homepage */
1039 sipe_purple_plugin_load, /**< load */
1040 sipe_purple_plugin_unload, /**< unload */
1041 sipe_purple_plugin_destroy, /**< destroy */
1042 NULL, /**< ui_info */
1043 &sipe_prpl_info, /**< extra_info */
1044 NULL,
1045 sipe_purple_actions,
1046 NULL,
1047 NULL,
1048 NULL,
1049 NULL
1050 };
1051
1052 static void sipe_purple_init_plugin(PurplePlugin *plugin)
1053 {
1054 PurpleAccountUserSplit *split;
1055 PurpleAccountOption *option;
1056
1057 /* This needs to be called first */
1058 sipe_core_init(LOCALEDIR);
1059 sipe_purple_activity_init();
1060
1061 purple_plugin_register(plugin);
1062
1063 /**
1064 * When adding new string settings please make sure to keep these
1065 * in sync:
1066 *
1067 * api/sipe-backend.h
1068 * purple-settings.c:setting_name[]
1069 */
1070 split = purple_account_user_split_new(_("Login\n user or DOMAIN\\user or\n user@company.com"), NULL, ',');
1071 purple_account_user_split_set_reverse(split, FALSE);
1072 sipe_prpl_info.user_splits = g_list_append(sipe_prpl_info.user_splits, split);
1073
1074 option = purple_account_option_string_new(_("Server[:Port]\n(leave empty for auto-discovery)"), "server", "");
1075 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1076
1077 option = purple_account_option_list_new(_("Connection type"), "transport", NULL);
1078 purple_account_option_add_list_item(option, _("Auto"), "auto");
1079 purple_account_option_add_list_item(option, _("SSL/TLS"), "tls");
1080 purple_account_option_add_list_item(option, _("TCP"), "tcp");
1081 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1082
1083 /*option = purple_account_option_bool_new(_("Publish status (note: everyone may watch you)"), "doservice", TRUE);
1084 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);*/
1085
1086 option = purple_account_option_string_new(_("User Agent"), "useragent", "");
1087 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1088
1089 option = purple_account_option_list_new(_("Authentication scheme"), "authentication", NULL);
1090 purple_account_option_add_list_item(option, _("NTLM"), "ntlm");
1091 #if PURPLE_SIPE_SSO_AND_KERBEROS
1092 purple_account_option_add_list_item(option, _("Kerberos"), "krb5");
1093 #endif
1094 purple_account_option_add_list_item(option, _("TLS-DSK"), "tls-dsk");
1095 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1096
1097 #if PURPLE_SIPE_SSO_AND_KERBEROS
1098 /*
1099 * When the user selects Single Sign-On then SIPE will ignore the
1100 * settings for "login name" and "password". Instead it will use the
1101 * default credentials provided by the OS.
1102 *
1103 * NOTE: the default must be *OFF*, i.e. it is up to the user to tell
1104 * SIPE that it is OK to use Single Sign-On or not.
1105 *
1106 * Configurations that are known to support Single Sign-On:
1107 *
1108 * - Windows, host joined to domain, SIPE with SSPI: NTLM
1109 * - Windows, host joined to domain, SIPE with SSPI: Kerberos
1110 * - SIPE with libkrb5, valid TGT in cache (kinit): Kerberos
1111 */
1112 option = purple_account_option_bool_new(_("Use Single Sign-On"), "sso", FALSE);
1113 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1114 #endif
1115
1116 /** Example (Exchange): https://server.company.com/EWS/Exchange.asmx
1117 * Example (Domino) : https://[domino_server]/[mail_database_name].nsf
1118 */
1119 option = purple_account_option_bool_new(_("Don't publish my calendar information"), "dont-publish", FALSE);
1120 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1121
1122 option = purple_account_option_string_new(_("Email services URL\n(leave empty for auto-discovery)"), "email_url", "");
1123 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1124
1125 option = purple_account_option_string_new(_("Email address\n(if different from Username)"), "email", "");
1126 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1127
1128 /** Example (Exchange): DOMAIN\user or user@company.com
1129 * Example (Domino) : email_address
1130 */
1131 option = purple_account_option_string_new(_("Email login\n(if different from Login)"), "email_login", "");
1132 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1133
1134 option = purple_account_option_string_new(_("Email password\n(if different from Password)"), "email_password", "");
1135 #if PURPLE_VERSION_CHECK(3,0,0)
1136 purple_account_option_string_set_masked(
1137 #else
1138 purple_account_option_set_masked(
1139 #endif
1140 option, TRUE);
1141 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1142
1143 /** Example (federated domain): company.com (i.e. ocschat@company.com)
1144 * Example (non-default user): user@company.com
1145 */
1146 option = purple_account_option_string_new(_("Group Chat Proxy\n company.com or user@company.com\n(leave empty to determine from Username)"), "groupchat_user", "");
1147 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1148 }
1149
1150 /* This macro makes the code a purple plugin */
1151 PURPLE_INIT_PLUGIN(sipe, sipe_purple_init_plugin, sipe_purple_info);
1152
1153 /*
1154 Local Variables:
1155 mode: c
1156 c-file-style: "bsd"
1157 indent-tabs-mode: t
1158 tab-width: 8
1159 End:
1160 */
A third-party Pidgin plugin for Microsoft LCS/OCS