?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
adium/purple: Better solution to auto-detect for Adium
[siplcs.git] / src / purple / purple-plugin.c
blobee1e53caab1ab8db025f1c982e3cd8c44031d776
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 #ifndef HAVE_SSPI
274 /*
275 * @TODO: SSL handshake support isn't implemented in sip-sec-sspi.c.
276 * So ignore configuration setting for now.
277 */
278 if (sipe_strequal(auth, "tls-dsk")) {
279 authentication_type = SIPE_AUTHENTICATION_TYPE_TLS_DSK;
280 }
281 #endif
282
283 return(authentication_type);
284 }
285
286 static gboolean get_sso_flag(PurpleAccount *account)
287 {
288 #if PURPLE_SIPE_SSO_AND_KERBEROS
289 /*
290 * NOTE: the default must be *OFF*, i.e. it is up to the user to tell
291 * SIPE that it is OK to use Single Sign-On or not.
292 */
293 return(purple_account_get_bool(account, "sso", FALSE));
294 #else
295 return(FALSE);
296 #endif
297 }
298
299 static void connect_to_core(PurpleConnection *gc,
300 PurpleAccount *account,
301 const gchar *password)
302 {
303 const gchar *username = purple_account_get_username(account);
304 const gchar *email = purple_account_get_string(account, "email", NULL);
305 const gchar *email_url = purple_account_get_string(account, "email_url", NULL);
306 const gchar *transport = purple_account_get_string(account, "transport", "auto");
307 struct sipe_core_public *sipe_public;
308 gchar **username_split;
309 gchar *login_domain = NULL;
310 gchar *login_account = NULL;
311 const gchar *errmsg;
312 guint transport_type;
313 struct sipe_backend_private *purple_private;
314
315 /* username format: <username>,[<optional login>] */
316 SIPE_DEBUG_INFO("sipe_purple_login: username '%s'", username);
317 username_split = g_strsplit(username, ",", 2);
318
319 /* login name specified? */
320 if (username_split[1] && strlen(username_split[1])) {
321 /* Allowed domain-account separators are / or \ */
322 gchar **domain_user = g_strsplit_set(username_split[1], "/\\", 2);
323 gboolean has_domain = domain_user[1] != NULL;
324 SIPE_DEBUG_INFO("sipe_purple_login: login '%s'", username_split[1]);
325 login_domain = has_domain ? g_strdup(domain_user[0]) : NULL;
326 login_account = g_strdup(domain_user[has_domain ? 1 : 0]);
327 SIPE_DEBUG_INFO("sipe_purple_login: auth domain '%s' user '%s'",
328 login_domain ? login_domain : "",
329 login_account);
330 g_strfreev(domain_user);
331 }
332
333 sipe_public = sipe_core_allocate(username_split[0],
334 login_domain, login_account,
335 password,
336 email,
337 email_url,
338 &errmsg);
339 g_free(login_domain);
340 g_free(login_account);
341 g_strfreev(username_split);
342
343 if (!sipe_public) {
344 #if PURPLE_VERSION_CHECK(3,0,0)
345 purple_connection_error(
346 #else
347 purple_connection_error_reason(
348 #endif
349 gc,
350 PURPLE_CONNECTION_ERROR_INVALID_USERNAME,
351 errmsg);
352 return;
353 }
354
355 sipe_public->backend_private = purple_private = g_new0(struct sipe_backend_private, 1);
356 purple_private->public = sipe_public;
357 purple_private->gc = gc;
358 purple_private->account = account;
359
360 sipe_purple_chat_setup_rejoin(purple_private);
361
362 SIPE_CORE_FLAG_UNSET(SSO);
363 if (get_sso_flag(account))
364 SIPE_CORE_FLAG_SET(SSO);
365
366 gc->proto_data = sipe_public;
367 gc->flags |= PURPLE_CONNECTION_HTML | PURPLE_CONNECTION_FORMATTING_WBFO | PURPLE_CONNECTION_NO_BGCOLOR |
368 PURPLE_CONNECTION_NO_FONTSIZE | PURPLE_CONNECTION_NO_URLDESC | PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY;
369 purple_connection_set_display_name(gc, sipe_public->sip_name);
370 purple_connection_update_progress(gc, _("Connecting"), 1, 2);
371
372 username_split = g_strsplit(purple_account_get_string(account, "server", ""), ":", 2);
373 if (sipe_strequal(transport, "auto")) {
374 transport_type = (username_split[0] == NULL) ?
375 SIPE_TRANSPORT_AUTO : SIPE_TRANSPORT_TLS;
376 } else if (sipe_strequal(transport, "tls")) {
377 transport_type = SIPE_TRANSPORT_TLS;
378 } else {
379 transport_type = SIPE_TRANSPORT_TCP;
380 }
381 sipe_core_transport_sip_connect(sipe_public,
382 transport_type,
383 get_authentication_type(account),
384 username_split[0],
385 username_split[0] ? username_split[1] : NULL);
386 g_strfreev(username_split);
387 }
388
389 static void password_required_cb(PurpleConnection *gc,
390 SIPE_UNUSED_PARAMETER PurpleRequestFields *fields)
391 {
392 if (!PURPLE_CONNECTION_IS_VALID(gc))
393 return;
394
395 #if PURPLE_VERSION_CHECK(3,0,0)
396 purple_connection_error(
397 #else
398 purple_connection_error_reason(
399 #endif
400 gc,
401 PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED,
402 _("Password required"));
403 }
404
405 static void password_ok_cb(PurpleConnection *gc,
406 PurpleRequestFields *fields)
407 {
408 const gchar *password;
409
410 if (!PURPLE_CONNECTION_IS_VALID(gc))
411 return;
412
413 password = purple_request_fields_get_string(fields, "password");
414
415 if (password && strlen(password)) {
416 PurpleAccount *account = purple_connection_get_account(gc);
417
418 if (purple_request_fields_get_bool(fields, "remember"))
419 purple_account_set_remember_password(account, TRUE);
420 purple_account_set_password(account, password);
421
422 /* Now we have a password and we can connect */
423 connect_to_core(gc, account, password);
424
425 } else
426 /* reject an empty password */
427 password_required_cb(gc, fields);
428 }
429
430 static void sipe_purple_login(PurpleAccount *account)
431 {
432 PurpleConnection *gc = purple_account_get_connection(account);
433 const gchar *password = purple_connection_get_password(gc);
434
435 /* Password required? */
436 if (sipe_core_transport_sip_requires_password(get_authentication_type(account),
437 get_sso_flag(account)) &&
438 (!password || !strlen(password)))
439 /* No password set - request one from user */
440 purple_account_request_password(account,
441 G_CALLBACK(password_ok_cb),
442 G_CALLBACK(password_required_cb),
443 gc);
444 else
445 /* No password required or saved password - connect now */
446 connect_to_core(gc, account, password);
447
448 }
449
450 static void sipe_purple_close(PurpleConnection *gc)
451 {
452 struct sipe_core_public *sipe_public = PURPLE_GC_TO_SIPE_CORE_PUBLIC;
453
454 if (sipe_public) {
455 struct sipe_backend_private *purple_private = sipe_public->backend_private;
456
457 sipe_core_deallocate(sipe_public);
458
459 if (purple_private->roomlist_map)
460 g_hash_table_destroy(purple_private->roomlist_map);
461 sipe_purple_chat_destroy_rejoin(purple_private);
462 g_free(purple_private);
463 gc->proto_data = NULL;
464 }
465 }
466
467 static int sipe_purple_send_im(PurpleConnection *gc,
468 const char *who,
469 const char *what,
470 SIPE_UNUSED_PARAMETER PurpleMessageFlags flags)
471 {
472 sipe_core_im_send(PURPLE_GC_TO_SIPE_CORE_PUBLIC, who, what);
473 return 1;
474 }
475
476 #define SIPE_TYPING_SEND_TIMEOUT 4
477
478 static unsigned int sipe_purple_send_typing(PurpleConnection *gc,
479 const char *who,
480 PurpleTypingState state)
481 {
482 if (state == PURPLE_NOT_TYPING)
483 return 0;
484
485 sipe_core_user_feedback_typing(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
486 who);
487
488 return SIPE_TYPING_SEND_TIMEOUT;
489 }
490
491 static void sipe_purple_get_info(PurpleConnection *gc, const char *who)
492 {
493 sipe_core_buddy_get_info(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
494 who);
495 }
496
497 static void sipe_purple_add_permit(PurpleConnection *gc, const char *name)
498 {
499 sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, TRUE);
500 }
501
502 static void sipe_purple_add_deny(PurpleConnection *gc, const char *name)
503 {
504 sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, FALSE);
505 }
506
507 static void sipe_purple_keep_alive(PurpleConnection *gc)
508 {
509 struct sipe_core_public *sipe_public = PURPLE_GC_TO_SIPE_CORE_PUBLIC;
510 struct sipe_backend_private *purple_private = sipe_public->backend_private;
511 time_t now = time(NULL);
512
513 if ((sipe_public->keepalive_timeout > 0) &&
514 ((guint) (now - purple_private->last_keepalive) >= sipe_public->keepalive_timeout) &&
515 ((guint) (now - gc->last_received) >= sipe_public->keepalive_timeout)
516 ) {
517 sipe_core_transport_sip_keepalive(sipe_public);
518 purple_private->last_keepalive = now;
519 }
520 }
521
522 static void sipe_purple_alias_buddy(PurpleConnection *gc, const char *name,
523 const char *alias)
524 {
525 sipe_core_group_set_alias(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, alias);
526 }
527
528 static void sipe_purple_group_rename(PurpleConnection *gc,
529 const char *old_name,
530 PurpleGroup *group,
531 SIPE_UNUSED_PARAMETER GList *moved_buddies)
532 {
533 sipe_core_group_rename(PURPLE_GC_TO_SIPE_CORE_PUBLIC, old_name, group->name);
534 }
535
536 static void sipe_purple_convo_closed(PurpleConnection *gc,
537 const char *who)
538 {
539 sipe_core_im_close(PURPLE_GC_TO_SIPE_CORE_PUBLIC, who);
540 }
541
542 static void sipe_purple_group_remove(PurpleConnection *gc, PurpleGroup *group)
543 {
544 sipe_core_group_remove(PURPLE_GC_TO_SIPE_CORE_PUBLIC, group->name);
545 }
546
547 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
548 static GHashTable *
549 sipe_purple_get_account_text_table(SIPE_UNUSED_PARAMETER PurpleAccount *account)
550 {
551 GHashTable *table;
552 table = g_hash_table_new(g_str_hash, g_str_equal);
553 g_hash_table_insert(table, "login_label", (gpointer)_("user@company.com"));
554 return table;
555 }
556
557 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
558 #ifdef HAVE_VV
559
560 static void
561 sipe_purple_sigusr1_handler(SIPE_UNUSED_PARAMETER int signum)
562 {
563 capture_pipeline("PURPLE_SIPE_PIPELINE");
564 }
565
566 static gboolean sipe_purple_initiate_media(PurpleAccount *account, const char *who,
567 SIPE_UNUSED_PARAMETER PurpleMediaSessionType type)
568 {
569 sipe_core_media_initiate_call(PURPLE_ACCOUNT_TO_SIPE_CORE_PUBLIC,
570 who,
571 (type & PURPLE_MEDIA_VIDEO));
572 return TRUE;
573 }
574
575 static PurpleMediaCaps sipe_purple_get_media_caps(SIPE_UNUSED_PARAMETER PurpleAccount *account,
576 SIPE_UNUSED_PARAMETER const char *who)
577 {
578 return PURPLE_MEDIA_CAPS_AUDIO
579 | PURPLE_MEDIA_CAPS_AUDIO_VIDEO
580 | PURPLE_MEDIA_CAPS_MODIFY_SESSION;
581 }
582 #endif
583 #endif
584 #endif
585
586 /*
587 * Simplistic source upward compatibility path for newer libpurple APIs
588 *
589 * Usually we compile with -Werror=missing-field-initializers if GCC supports
590 * it. But that means that the compilation of this structure can fail if the
591 * newer API has added additional plugin callbacks. For the benefit of the
592 * user we downgrade it to a warning here.
593 *
594 * Diagnostic #pragma was added in GCC 4.2.0
595 * Diagnostic push/pop was added in GCC 4.6.0
596 */
597 #ifdef __GNUC__
598 #if (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 2)
599 #if __GNUC_MINOR__ >= 6
600 #pragma GCC diagnostic push
601 #endif
602 #pragma GCC diagnostic warning "-Wmissing-field-initializers"
603 #endif
604 #endif
605 static PurplePluginProtocolInfo sipe_prpl_info =
606 {
607 #if PURPLE_VERSION_CHECK(3,0,0)
608 sizeof(PurplePluginProtocolInfo), /* struct_size */
609 #endif
610 OPT_PROTO_CHAT_TOPIC |
611 OPT_PROTO_PASSWORD_OPTIONAL,
612 NULL, /* user_splits */
613 NULL, /* protocol_options */
614 NO_BUDDY_ICONS, /* icon_spec */
615 sipe_list_icon, /* list_icon */
616 NULL, /* list_emblems */
617 sipe_purple_status_text, /* status_text */
618 sipe_purple_tooltip_text, /* tooltip_text */ // add custom info to contact tooltip
619 sipe_purple_status_types, /* away_states */
620 sipe_purple_blist_node_menu, /* blist_node_menu */
621 sipe_purple_chat_info, /* chat_info */
622 sipe_purple_chat_info_defaults, /* chat_info_defaults */
623 sipe_purple_login, /* login */
624 sipe_purple_close, /* close */
625 sipe_purple_send_im, /* send_im */
626 NULL, /* set_info */ // TODO maybe
627 sipe_purple_send_typing, /* send_typing */
628 sipe_purple_get_info, /* get_info */
629 sipe_purple_set_status, /* set_status */
630 sipe_purple_set_idle, /* set_idle */
631 NULL, /* change_passwd */
632 sipe_purple_add_buddy, /* add_buddy */
633 NULL, /* add_buddies */
634 sipe_purple_remove_buddy, /* remove_buddy */
635 NULL, /* remove_buddies */
636 sipe_purple_add_permit, /* add_permit */
637 sipe_purple_add_deny, /* add_deny */
638 sipe_purple_add_deny, /* rem_permit */
639 sipe_purple_add_permit, /* rem_deny */
640 NULL, /* set_permit_deny */
641 sipe_purple_chat_join, /* join_chat */
642 NULL, /* reject_chat */
643 NULL, /* get_chat_name */
644 sipe_purple_chat_invite, /* chat_invite */
645 sipe_purple_chat_leave, /* chat_leave */
646 NULL, /* chat_whisper */
647 sipe_purple_chat_send, /* chat_send */
648 sipe_purple_keep_alive, /* keepalive */
649 NULL, /* register_user */
650 NULL, /* get_cb_info */ // deprecated
651 #if !PURPLE_VERSION_CHECK(3,0,0)
652 NULL, /* get_cb_away */ // deprecated
653 #endif
654 sipe_purple_alias_buddy, /* alias_buddy */
655 sipe_purple_group_buddy, /* group_buddy */
656 sipe_purple_group_rename, /* rename_group */
657 NULL, /* buddy_free */
658 sipe_purple_convo_closed, /* convo_closed */
659 purple_normalize_nocase, /* normalize */
660 NULL, /* set_buddy_icon */
661 sipe_purple_group_remove, /* remove_group */
662 NULL, /* get_cb_real_name */ // TODO?
663 NULL, /* set_chat_topic */
664 NULL, /* find_blist_chat */
665 sipe_purple_roomlist_get_list, /* roomlist_get_list */
666 sipe_purple_roomlist_cancel, /* roomlist_cancel */
667 NULL, /* roomlist_expand_category */
668 NULL, /* can_receive_file */
669 sipe_purple_ft_send_file, /* send_file */
670 sipe_purple_ft_new_xfer, /* new_xfer */
671 NULL, /* offline_message */
672 NULL, /* whiteboard_prpl_ops */
673 NULL, /* send_raw */
674 NULL, /* roomlist_room_serialize */
675 NULL, /* unregister_user */
676 NULL, /* send_attention */
677 NULL, /* get_attention_types */
678 #if !PURPLE_VERSION_CHECK(2,5,0) && !PURPLE_VERSION_CHECK(3,0,0)
679 /* Backward compatibility when compiling against 2.4.x API */
680 (void (*)(void)) /* _purple_reserved4 */
681 #endif
682 #if !PURPLE_VERSION_CHECK(3,0,0)
683 sizeof(PurplePluginProtocolInfo), /* struct_size */
684 #endif
685 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
686 sipe_purple_get_account_text_table, /* get_account_text_table */
687 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
688 #ifdef HAVE_VV
689 sipe_purple_initiate_media, /* initiate_media */
690 sipe_purple_get_media_caps, /* get_media_caps */
691 #else
692 NULL, /* initiate_media */
693 NULL, /* get_media_caps */
694 #endif
695 #if PURPLE_VERSION_CHECK(2,7,0) || PURPLE_VERSION_CHECK(3,0,0)
696 NULL, /* get_moods */
697 NULL, /* set_public_alias */
698 NULL, /* get_public_alias */
699 #if PURPLE_VERSION_CHECK(2,8,0)
700 NULL, /* add_buddy_with_invite */
701 NULL, /* add_buddies_with_invite */
702 #endif
703 #endif
704 #endif
705 #endif
706 };
707 #ifdef __GNUC__
708 #if (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 6)
709 #pragma GCC diagnostic pop
710 #endif
711 #endif
712 /* Original GCC error checking restored from here on... (see above) */
713
714 /* PurplePluginInfo function calls & data structure */
715 static gboolean sipe_purple_plugin_load(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
716 {
717 #ifdef HAVE_VV
718 struct sigaction action;
719 memset(&action, 0, sizeof (action));
720 action.sa_handler = sipe_purple_sigusr1_handler;
721 sigaction(SIGUSR1, &action, NULL);
722 #endif
723 return TRUE;
724 }
725
726 static gboolean sipe_purple_plugin_unload(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
727 {
728 #ifdef HAVE_VV
729 struct sigaction action;
730 memset(&action, 0, sizeof (action));
731 action.sa_handler = SIG_DFL;
732 sigaction(SIGUSR1, &action, NULL);
733 #endif
734 return TRUE;
735 }
736
737 static void sipe_purple_plugin_destroy(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
738 {
739 GList *entry;
740
741 sipe_purple_activity_shutdown();
742 sipe_core_destroy();
743
744 entry = sipe_prpl_info.protocol_options;
745 while (entry) {
746 purple_account_option_destroy(entry->data);
747 entry = g_list_delete_link(entry, entry);
748 }
749 sipe_prpl_info.protocol_options = NULL;
750
751 entry = sipe_prpl_info.user_splits;
752 while (entry) {
753 purple_account_user_split_destroy(entry->data);
754 entry = g_list_delete_link(entry, entry);
755 }
756 sipe_prpl_info.user_splits = NULL;
757 }
758
759 static void sipe_purple_show_about_plugin(PurplePluginAction *action)
760 {
761 gchar *tmp = sipe_core_about();
762 purple_notify_formatted((PurpleConnection *) action->context,
763 NULL, " ", NULL, tmp, NULL, NULL);
764 g_free(tmp);
765 }
766
767 static void sipe_purple_find_contact_cb(PurpleConnection *gc,
768 PurpleRequestFields *fields)
769 {
770 GList *entries = purple_request_field_group_get_fields(purple_request_fields_get_groups(fields)->data);
771 const gchar *given_name = NULL;
772 const gchar *surname = NULL;
773 const gchar *email = NULL;
774 const gchar *company = NULL;
775 const gchar *country = NULL;
776
777 while (entries) {
778 PurpleRequestField *field = entries->data;
779 const char *id = purple_request_field_get_id(field);
780 const char *value = purple_request_field_string_get_value(field);
781
782 SIPE_DEBUG_INFO("sipe_purple_find_contact_cb: %s = '%s'", id, value ? value : "");
783
784 if (value) {
785 if (strcmp(id, "given") == 0) {
786 given_name = value;
787 } else if (strcmp(id, "surname") == 0) {
788 surname = value;
789 } else if (strcmp(id, "email") == 0) {
790 email = value;
791 } else if (strcmp(id, "company") == 0) {
792 company = value;
793 } else if (strcmp(id, "country") == 0) {
794 country = value;
795 }
796 }
797
798 entries = g_list_next(entries);
799 };
800
801 sipe_core_buddy_search(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
802 NULL,
803 given_name,
804 surname,
805 email,
806 company,
807 country);
808 }
809
810 static void sipe_purple_show_find_contact(PurplePluginAction *action)
811 {
812 PurpleConnection *gc = (PurpleConnection *) action->context;
813 PurpleRequestFields *fields;
814 PurpleRequestFieldGroup *group;
815 PurpleRequestField *field;
816
817 fields = purple_request_fields_new();
818 group = purple_request_field_group_new(NULL);
819 purple_request_fields_add_group(fields, group);
820
821 field = purple_request_field_string_new("given", _("First name"), NULL, FALSE);
822 purple_request_field_group_add_field(group, field);
823 field = purple_request_field_string_new("surname", _("Last name"), NULL, FALSE);
824 purple_request_field_group_add_field(group, field);
825 field = purple_request_field_string_new("email", _("Email"), NULL, FALSE);
826 purple_request_field_group_add_field(group, field);
827 field = purple_request_field_string_new("company", _("Company"), NULL, FALSE);
828 purple_request_field_group_add_field(group, field);
829 field = purple_request_field_string_new("country", _("Country"), NULL, FALSE);
830 purple_request_field_group_add_field(group, field);
831
832 purple_request_fields(gc,
833 _("Search"),
834 _("Search for a contact"),
835 _("Enter the information for the person you wish to find. Empty fields will be ignored."),
836 fields,
837 _("_Search"), G_CALLBACK(sipe_purple_find_contact_cb),
838 _("_Cancel"), NULL,
839 purple_connection_get_account(gc), NULL, NULL, gc);
840 }
841
842 static void sipe_purple_join_conference_cb(PurpleConnection *gc,
843 PurpleRequestFields *fields)
844 {
845 GList *entries = purple_request_field_group_get_fields(purple_request_fields_get_groups(fields)->data);
846
847 if (entries) {
848 PurpleRequestField *field = entries->data;
849 const char *id = purple_request_field_get_id(field);
850 const char *value = purple_request_field_string_get_value(field);
851
852 if (!sipe_strequal(id, "meetingLocation"))
853 return;
854
855 sipe_core_conf_create(PURPLE_GC_TO_SIPE_CORE_PUBLIC, value);
856 }
857 }
858
859 #ifdef HAVE_VV
860 static void sipe_purple_test_call(PurplePluginAction *action)
861 {
862 PurpleConnection *gc = (PurpleConnection *) action->context;
863 sipe_core_media_test_call(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
864 }
865 #endif
866
867 static void sipe_purple_show_join_conference(PurplePluginAction *action)
868 {
869 PurpleConnection *gc = (PurpleConnection *) action->context;
870 PurpleRequestFields *fields;
871 PurpleRequestFieldGroup *group;
872 PurpleRequestField *field;
873
874 fields = purple_request_fields_new();
875 group = purple_request_field_group_new(NULL);
876 purple_request_fields_add_group(fields, group);
877
878 field = purple_request_field_string_new("meetingLocation", _("Meeting location"), NULL, FALSE);
879 purple_request_field_group_add_field(group, field);
880
881 purple_request_fields(gc,
882 _("Join conference"),
883 _("Join scheduled conference"),
884 _("Enter meeting location string you received in the invitation.\n"
885 "\n"
886 "Valid location will be something like\n"
887 "meet:sip:someone@company.com;gruu;opaque=app:conf:focus:id:abcdef1234\n"
888 "conf:sip:someone@company.com;gruu;opaque=app:conf:focus:id:abcdef1234\n"
889 "or\n"
890 "https://meet.company.com/someone/abcdef1234"),
891 fields,
892 _("_Join"), G_CALLBACK(sipe_purple_join_conference_cb),
893 _("_Cancel"), NULL,
894 purple_connection_get_account(gc), NULL, NULL, gc);
895 }
896
897 static void sipe_purple_republish_calendar(PurplePluginAction *action)
898 {
899 PurpleConnection *gc = (PurpleConnection *) action->context;
900 sipe_core_update_calendar(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
901 }
902
903 static void sipe_purple_reset_status(PurplePluginAction *action)
904 {
905 PurpleConnection *gc = (PurpleConnection *) action->context;
906 sipe_core_reset_status(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
907 }
908
909 static GList *sipe_purple_actions(SIPE_UNUSED_PARAMETER PurplePlugin *plugin,
910 SIPE_UNUSED_PARAMETER gpointer context)
911 {
912 GList *menu = NULL;
913 PurplePluginAction *act;
914
915 act = purple_plugin_action_new(_("About SIPE plugin..."), sipe_purple_show_about_plugin);
916 menu = g_list_prepend(menu, act);
917
918 act = purple_plugin_action_new(_("Contact search..."), sipe_purple_show_find_contact);
919 menu = g_list_prepend(menu, act);
920
921 #ifdef HAVE_VV
922 act = purple_plugin_action_new(_("Test call"), sipe_purple_test_call);
923 menu = g_list_prepend(menu, act);
924 #endif
925
926 act = purple_plugin_action_new(_("Join scheduled conference..."), sipe_purple_show_join_conference);
927 menu = g_list_prepend(menu, act);
928
929 act = purple_plugin_action_new(_("Republish Calendar"), sipe_purple_republish_calendar);
930 menu = g_list_prepend(menu, act);
931
932 act = purple_plugin_action_new(_("Reset status"), sipe_purple_reset_status);
933 menu = g_list_prepend(menu, act);
934
935 return g_list_reverse(menu);
936 }
937
938 static PurplePluginInfo sipe_purple_info = {
939 PURPLE_PLUGIN_MAGIC,
940 PURPLE_MAJOR_VERSION,
941 PURPLE_MINOR_VERSION,
942 PURPLE_PLUGIN_PROTOCOL, /**< type */
943 NULL, /**< ui_requirement */
944 0, /**< flags */
945 NULL, /**< dependencies */
946 PURPLE_PRIORITY_DEFAULT, /**< priority */
947 "prpl-sipe", /**< id */
948 "Office Communicator", /**< name */
949 PACKAGE_VERSION, /**< version */
950 "Microsoft Office Communicator Protocol Plugin", /**< summary */
951 "A plugin for the extended SIP/SIMPLE protocol used by " /**< description */
952 "Microsoft Live/Office Communications Server (LCS2005/OCS2007+)", /**< description */
953 "Anibal Avelar <avelar@gmail.com>, " /**< author */
954 "Gabriel Burt <gburt@novell.com>, " /**< author */
955 "Stefan Becker <stefan.becker@nokia.com>, " /**< author */
956 "pier11 <pier11@operamail.com>", /**< author */
957 PACKAGE_URL, /**< homepage */
958 sipe_purple_plugin_load, /**< load */
959 sipe_purple_plugin_unload, /**< unload */
960 sipe_purple_plugin_destroy, /**< destroy */
961 NULL, /**< ui_info */
962 &sipe_prpl_info, /**< extra_info */
963 NULL,
964 sipe_purple_actions,
965 NULL,
966 NULL,
967 NULL,
968 NULL
969 };
970
971 static void sipe_purple_init_plugin(PurplePlugin *plugin)
972 {
973 PurpleAccountUserSplit *split;
974 PurpleAccountOption *option;
975
976 /* This needs to be called first */
977 sipe_core_init(LOCALEDIR);
978 sipe_purple_activity_init();
979
980 purple_plugin_register(plugin);
981
982 /**
983 * When adding new string settings please make sure to keep these
984 * in sync:
985 *
986 * api/sipe-backend.h
987 * purple-settings.c:setting_name[]
988 */
989 split = purple_account_user_split_new(_("Login\n user or DOMAIN\\user or\n user@company.com"), NULL, ',');
990 purple_account_user_split_set_reverse(split, FALSE);
991 sipe_prpl_info.user_splits = g_list_append(sipe_prpl_info.user_splits, split);
992
993 option = purple_account_option_string_new(_("Server[:Port]\n(leave empty for auto-discovery)"), "server", "");
994 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
995
996 option = purple_account_option_list_new(_("Connection type"), "transport", NULL);
997 purple_account_option_add_list_item(option, _("Auto"), "auto");
998 purple_account_option_add_list_item(option, _("SSL/TLS"), "tls");
999 purple_account_option_add_list_item(option, _("TCP"), "tcp");
1000 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1001
1002 /*option = purple_account_option_bool_new(_("Publish status (note: everyone may watch you)"), "doservice", TRUE);
1003 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);*/
1004
1005 option = purple_account_option_string_new(_("User Agent"), "useragent", "");
1006 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1007
1008 option = purple_account_option_list_new(_("Authentication scheme"), "authentication", NULL);
1009 purple_account_option_add_list_item(option, _("NTLM"), "ntlm");
1010 #if PURPLE_SIPE_SSO_AND_KERBEROS
1011 purple_account_option_add_list_item(option, _("Kerberos"), "krb5");
1012 #endif
1013 #ifndef HAVE_SSPI
1014 /* see above */
1015 purple_account_option_add_list_item(option, _("TLS-DSK"), "tls-dsk");
1016 #endif
1017 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1018
1019 #if PURPLE_SIPE_SSO_AND_KERBEROS
1020 /*
1021 * When the user selects Single Sign-On then SIPE will ignore the
1022 * settings for "login name" and "password". Instead it will use the
1023 * default credentials provided by the OS.
1024 *
1025 * NOTE: the default must be *OFF*, i.e. it is up to the user to tell
1026 * SIPE that it is OK to use Single Sign-On or not.
1027 *
1028 * Configurations that are known to support Single Sign-On:
1029 *
1030 * - Windows, host joined to domain, SIPE with SSPI: NTLM
1031 * - Windows, host joined to domain, SIPE with SSPI: Kerberos
1032 * - SIPE with libkrb5, valid TGT in cache (kinit): Kerberos
1033 */
1034 option = purple_account_option_bool_new(_("Use Single Sign-On"), "sso", FALSE);
1035 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1036 #endif
1037
1038 /** Example (Exchange): https://server.company.com/EWS/Exchange.asmx
1039 * Example (Domino) : https://[domino_server]/[mail_database_name].nsf
1040 */
1041 option = purple_account_option_string_new(_("Email services URL\n(leave empty for auto-discovery)"), "email_url", "");
1042 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1043
1044 option = purple_account_option_string_new(_("Email address\n(if different from Username)"), "email", "");
1045 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1046
1047 /** Example (Exchange): DOMAIN\user or user@company.com
1048 * Example (Domino) : email_address
1049 */
1050 option = purple_account_option_string_new(_("Email login\n(if different from Login)"), "email_login", "");
1051 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1052
1053 option = purple_account_option_string_new(_("Email password\n(if different from Password)"), "email_password", "");
1054 #if PURPLE_VERSION_CHECK(3,0,0)
1055 purple_account_option_string_set_masked(
1056 #else
1057 purple_account_option_set_masked(
1058 #endif
1059 option, TRUE);
1060 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1061
1062 /** Example (federated domain): company.com (i.e. ocschat@company.com)
1063 * Example (non-default user): user@company.com
1064 */
1065 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", "");
1066 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
1067 }
1068
1069 /* This macro makes the code a purple plugin */
1070 PURPLE_INIT_PLUGIN(sipe, sipe_purple_init_plugin, sipe_purple_info);
1071
1072 /*
1073 Local Variables:
1074 mode: c
1075 c-file-style: "bsd"
1076 indent-tabs-mode: t
1077 tab-width: 8
1078 End:
1079 */
A third-party Pidgin plugin for Microsoft LCS/OCS