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