2 * @file purple-plugin.c
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
32 #include "sipe-common.h"
34 /* Flag needed for correct version of PURPLE_INIT_PLUGIN() */
35 #ifndef PURPLE_PLUGINS
36 #define PURPLE_PLUGINS
40 * as it's determined on runtime, as Pidgin installation can be anywhere.
43 #include "win32/win32dep.h"
46 #include "accountopt.h"
48 #include "connection.h"
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>
62 * As a workaround an additional PURPLE_VERSION_CHECK(3,0,0) needs to be added.
66 #include "sipe-backend.h"
67 #include "sipe-core.h"
70 #define _PurpleMessageFlags PurpleMessageFlags
71 #include "purple-private.h"
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
79 * NOTE: this flag means two things:
81 * - is Single Sign-On supported, and
82 * - is Kerberos supported
84 #if defined(HAVE_LIBKRB5) || defined(HAVE_SSPI)
85 #define PURPLE_SIPE_SSO_AND_KERBEROS 1
87 #define PURPLE_SIPE_SSO_AND_KERBEROS 0
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",
111 GHashTable
*purple_token_map
;
113 static void sipe_purple_activity_init(void)
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
;
121 g_hash_table_insert(purple_token_map
,
122 (gchar
*) activity_to_purple_map
[index
],
123 GUINT_TO_POINTER(index
));
127 static void sipe_purple_activity_shutdown(void)
129 g_hash_table_destroy(purple_token_map
);
132 const gchar
*sipe_purple_activity_to_token(guint type
)
134 return(activity_to_purple_map
[type
]);
137 guint
sipe_purple_token_to_activity(const gchar
*token
)
139 return(GPOINTER_TO_UINT(g_hash_table_lookup(purple_token_map
, token
)));
142 gchar
*sipe_backend_version(void)
144 return(g_strdup_printf("Purple/%s", purple_core_get_version()));
147 /* PurplePluginProtocolInfo function calls & data structure */
148 static const char *sipe_list_icon(SIPE_UNUSED_PARAMETER PurpleAccount
*a
,
149 SIPE_UNUSED_PARAMETER PurpleBuddy
*b
)
154 static gchar
*sipe_purple_status_text(PurpleBuddy
*buddy
)
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
,
159 sipe_purple_token_to_activity(purple_status_get_id(status
)),
160 purple_status_get_name(status
));
163 static void sipe_purple_tooltip_text(PurpleBuddy
*buddy
,
164 PurpleNotifyUserInfo
*user_info
,
165 SIPE_UNUSED_PARAMETER gboolean full
)
167 const PurplePresence
*presence
= purple_buddy_get_presence(buddy
);
168 sipe_core_buddy_tooltip_info(PURPLE_BUDDY_TO_SIPE_CORE_PUBLIC
,
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
);
175 static GList
*sipe_purple_status_types(SIPE_UNUSED_PARAMETER PurpleAccount
*acc
)
177 PurpleStatusType
*type
;
180 /* Macros to reduce code repetition.
182 #define SIPE_ADD_STATUS(prim,id,name,user) type = purple_status_type_new_with_attrs( \
185 SIPE_PURPLE_STATUS_ATTR_ID_MESSAGE, _("Message"), purple_value_new(PURPLE_TYPE_STRING), \
187 types = g_list_append(types, type);
190 SIPE_ADD_STATUS(PURPLE_STATUS_AVAILABLE
,
196 SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE
,
197 sipe_purple_activity_to_token(SIPE_ACTIVITY_BUSY
),
198 sipe_core_activity_description(SIPE_ACTIVITY_BUSY
),
202 SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE
,
203 sipe_purple_activity_to_token(SIPE_ACTIVITY_DND
),
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
),
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
),
220 /* Goes first in the list as
221 * purple picks the first status with the AWAY type
224 SIPE_ADD_STATUS(PURPLE_STATUS_AWAY
,
230 SIPE_ADD_STATUS(PURPLE_STATUS_AWAY
,
231 sipe_purple_activity_to_token(SIPE_ACTIVITY_BRB
),
232 sipe_core_activity_description(SIPE_ACTIVITY_BRB
),
236 SIPE_ADD_STATUS(PURPLE_STATUS_INVISIBLE
,
242 type
= purple_status_type_new(PURPLE_STATUS_OFFLINE
,
246 types
= g_list_append(types
, type
);
251 static GList
*sipe_purple_blist_node_menu(PurpleBlistNode
*node
)
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
);
262 static guint
get_authentication_type(PurpleAccount
*account
)
264 const gchar
*auth
= purple_account_get_string(account
, "authentication", "ntlm");
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
;
273 if (sipe_strequal(auth
, "tls-dsk")) {
274 authentication_type
= SIPE_AUTHENTICATION_TYPE_TLS_DSK
;
277 return(authentication_type
);
280 static gboolean
get_sso_flag(PurpleAccount
*account
)
282 #if PURPLE_SIPE_SSO_AND_KERBEROS
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.
287 return(purple_account_get_bool(account
, "sso", FALSE
));
289 (void) account
; /* keep compiler happy */
294 static gboolean
get_dont_publish_flag(PurpleAccount
*account
)
296 /* default is to publish calendar information */
297 return(purple_account_get_bool(account
, "dont-publish", FALSE
));
300 static void connect_to_core(PurpleConnection
*gc
,
301 PurpleAccount
*account
,
302 const gchar
*password
)
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
;
313 guint transport_type
;
314 struct sipe_backend_private
*purple_private
;
315 gboolean sso
= get_sso_flag(account
);
317 /* username format: <username>,[<optional login>] */
318 SIPE_DEBUG_INFO("sipe_purple_login: username '%s'", username
);
319 username_split
= g_strsplit(username
, ",", 2);
321 /* login name is ignored when SSO has been selected */
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
: "",
334 g_strfreev(domain_user
);
336 /* No -> duplicate username */
337 login_account
= g_strdup(username_split
[0]);
341 sipe_public
= sipe_core_allocate(username_split
[0],
343 login_domain
, login_account
,
348 g_free(login_domain
);
349 g_free(login_account
);
350 g_strfreev(username_split
);
353 #if PURPLE_VERSION_CHECK(3,0,0)
354 purple_connection_error(
356 purple_connection_error_reason(
359 PURPLE_CONNECTION_ERROR_INVALID_USERNAME
,
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
;
369 sipe_purple_chat_setup_rejoin(purple_private
);
371 SIPE_CORE_FLAG_UNSET(DONT_PUBLISH
);
372 if (get_dont_publish_flag(account
))
373 SIPE_CORE_FLAG_SET(DONT_PUBLISH
);
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);
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
;
388 transport_type
= SIPE_TRANSPORT_TCP
;
390 sipe_core_transport_sip_connect(sipe_public
,
392 get_authentication_type(account
),
394 username_split
[0] ? username_split
[1] : NULL
);
395 g_strfreev(username_split
);
398 static void password_required_cb(PurpleConnection
*gc
,
399 SIPE_UNUSED_PARAMETER PurpleRequestFields
*fields
)
401 if (!PURPLE_CONNECTION_IS_VALID(gc
))
404 #if PURPLE_VERSION_CHECK(3,0,0)
405 purple_connection_error(
407 purple_connection_error_reason(
410 PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED
,
411 _("Password required"));
414 static void password_ok_cb(PurpleConnection
*gc
,
415 PurpleRequestFields
*fields
)
417 const gchar
*password
;
419 if (!PURPLE_CONNECTION_IS_VALID(gc
))
422 password
= purple_request_fields_get_string(fields
, "password");
424 if (password
&& strlen(password
)) {
425 PurpleAccount
*account
= purple_connection_get_account(gc
);
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)
435 /* Now we have a password and we can connect */
436 connect_to_core(gc
, account
, password
);
439 /* reject an empty password */
440 password_required_cb(gc
, fields
);
443 static void sipe_purple_login(PurpleAccount
*account
)
445 PurpleConnection
*gc
= purple_account_get_connection(account
);
446 const gchar
*password
= purple_connection_get_password(gc
);
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
),
458 /* No password required or saved password - connect now */
459 connect_to_core(gc
, account
, password
);
463 static void sipe_purple_close(PurpleConnection
*gc
)
465 struct sipe_core_public
*sipe_public
= PURPLE_GC_TO_SIPE_CORE_PUBLIC
;
468 struct sipe_backend_private
*purple_private
= sipe_public
->backend_private
;
470 sipe_core_deallocate(sipe_public
);
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
);
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
;
484 static int sipe_purple_send_im(PurpleConnection
*gc
,
487 SIPE_UNUSED_PARAMETER PurpleMessageFlags flags
)
489 sipe_core_im_send(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, who
, what
);
493 static unsigned int sipe_purple_send_typing(PurpleConnection
*gc
,
495 PurpleTypingState state
)
497 gboolean typing
= (state
== PURPLE_TYPING
);
499 /* only enable this debug output while testing
500 SIPE_DEBUG_INFO("sipe_purple_send_typing: '%s' state %d", who, state); */
503 * libpurple calls this function with PURPLE_NOT_TYPING *after*
504 * calling sipe_purple_send_im() with the message. This causes
505 * SIPE core to send out two SIP messages to the same dialog in
506 * short succession without waiting for the response to the first
507 * one. Some servers then reject the first one with
509 * SIP/2.0 500 Stale CSeq Value
511 * which triggers a "message not delivered" error for the user.
513 * Work around this by filtering out PURPLE_NOT_TYPING events.
515 if (state
!= PURPLE_NOT_TYPING
)
516 sipe_core_user_feedback_typing(PURPLE_GC_TO_SIPE_CORE_PUBLIC
,
520 /* tell libpurple to send typing indications every 4 seconds */
521 return(typing
? 4 : 0);
524 static void sipe_purple_get_info(PurpleConnection
*gc
, const char *who
)
526 sipe_core_buddy_get_info(PURPLE_GC_TO_SIPE_CORE_PUBLIC
,
530 static void sipe_purple_add_permit(PurpleConnection
*gc
, const char *name
)
532 sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, name
, TRUE
);
535 static void sipe_purple_add_deny(PurpleConnection
*gc
, const char *name
)
537 sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, name
, FALSE
);
540 static void sipe_purple_keep_alive(PurpleConnection
*gc
)
542 struct sipe_core_public
*sipe_public
= PURPLE_GC_TO_SIPE_CORE_PUBLIC
;
543 struct sipe_backend_private
*purple_private
= sipe_public
->backend_private
;
544 time_t now
= time(NULL
);
546 if ((sipe_public
->keepalive_timeout
> 0) &&
547 ((guint
) (now
- purple_private
->last_keepalive
) >= sipe_public
->keepalive_timeout
) &&
548 ((guint
) (now
- gc
->last_received
) >= sipe_public
->keepalive_timeout
)
550 sipe_core_transport_sip_keepalive(sipe_public
);
551 purple_private
->last_keepalive
= now
;
555 static void sipe_purple_alias_buddy(PurpleConnection
*gc
, const char *name
,
558 sipe_core_group_set_alias(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, name
, alias
);
561 static void sipe_purple_group_rename(PurpleConnection
*gc
,
562 const char *old_name
,
564 SIPE_UNUSED_PARAMETER GList
*moved_buddies
)
566 sipe_core_group_rename(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, old_name
, group
->name
);
569 static void sipe_purple_convo_closed(PurpleConnection
*gc
,
572 sipe_core_im_close(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, who
);
575 static void sipe_purple_group_remove(PurpleConnection
*gc
, PurpleGroup
*group
)
577 sipe_core_group_remove(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, group
->name
);
580 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
582 sipe_purple_get_account_text_table(SIPE_UNUSED_PARAMETER PurpleAccount
*account
)
585 table
= g_hash_table_new(g_str_hash
, g_str_equal
);
586 g_hash_table_insert(table
, "login_label", (gpointer
)_("user@company.com"));
590 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
594 sipe_purple_sigusr1_handler(SIPE_UNUSED_PARAMETER
int signum
)
596 capture_pipeline("PURPLE_SIPE_PIPELINE");
599 static gboolean
sipe_purple_initiate_media(PurpleAccount
*account
, const char *who
,
600 SIPE_UNUSED_PARAMETER PurpleMediaSessionType type
)
602 sipe_core_media_initiate_call(PURPLE_ACCOUNT_TO_SIPE_CORE_PUBLIC
,
604 (type
& PURPLE_MEDIA_VIDEO
));
608 static PurpleMediaCaps
sipe_purple_get_media_caps(SIPE_UNUSED_PARAMETER PurpleAccount
*account
,
609 SIPE_UNUSED_PARAMETER
const char *who
)
611 return PURPLE_MEDIA_CAPS_AUDIO
612 | PURPLE_MEDIA_CAPS_AUDIO_VIDEO
613 | PURPLE_MEDIA_CAPS_MODIFY_SESSION
;
620 * Simplistic source upward compatibility path for newer libpurple APIs
622 * Usually we compile with -Werror=missing-field-initializers if GCC supports
623 * it. But that means that the compilation of this structure can fail if the
624 * newer API has added additional plugin callbacks. For the benefit of the
625 * user we downgrade it to a warning here.
627 * Diagnostic #pragma was added in GCC 4.2.0
628 * Diagnostic push/pop was added in GCC 4.6.0
631 #if (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 2)
632 #if __GNUC_MINOR__ >= 6
633 #pragma GCC diagnostic push
635 #pragma GCC diagnostic warning "-Wmissing-field-initializers"
638 static PurplePluginProtocolInfo sipe_prpl_info
=
640 #if PURPLE_VERSION_CHECK(3,0,0)
641 sizeof(PurplePluginProtocolInfo
), /* struct_size */
643 OPT_PROTO_CHAT_TOPIC
|
644 OPT_PROTO_PASSWORD_OPTIONAL
,
645 NULL
, /* user_splits */
646 NULL
, /* protocol_options */
647 NO_BUDDY_ICONS
, /* icon_spec */
648 sipe_list_icon
, /* list_icon */
649 NULL
, /* list_emblems */
650 sipe_purple_status_text
, /* status_text */
651 sipe_purple_tooltip_text
, /* tooltip_text */ // add custom info to contact tooltip
652 sipe_purple_status_types
, /* away_states */
653 sipe_purple_blist_node_menu
, /* blist_node_menu */
654 sipe_purple_chat_info
, /* chat_info */
655 sipe_purple_chat_info_defaults
, /* chat_info_defaults */
656 sipe_purple_login
, /* login */
657 sipe_purple_close
, /* close */
658 sipe_purple_send_im
, /* send_im */
659 NULL
, /* set_info */ // TODO maybe
660 sipe_purple_send_typing
, /* send_typing */
661 sipe_purple_get_info
, /* get_info */
662 sipe_purple_set_status
, /* set_status */
663 sipe_purple_set_idle
, /* set_idle */
664 NULL
, /* change_passwd */
665 sipe_purple_add_buddy
, /* add_buddy */
666 NULL
, /* add_buddies */
667 sipe_purple_remove_buddy
, /* remove_buddy */
668 NULL
, /* remove_buddies */
669 sipe_purple_add_permit
, /* add_permit */
670 sipe_purple_add_deny
, /* add_deny */
671 sipe_purple_add_deny
, /* rem_permit */
672 sipe_purple_add_permit
, /* rem_deny */
673 NULL
, /* set_permit_deny */
674 sipe_purple_chat_join
, /* join_chat */
675 NULL
, /* reject_chat */
676 NULL
, /* get_chat_name */
677 sipe_purple_chat_invite
, /* chat_invite */
678 sipe_purple_chat_leave
, /* chat_leave */
679 NULL
, /* chat_whisper */
680 sipe_purple_chat_send
, /* chat_send */
681 sipe_purple_keep_alive
, /* keepalive */
682 NULL
, /* register_user */
683 NULL
, /* get_cb_info */ // deprecated
684 #if !PURPLE_VERSION_CHECK(3,0,0)
685 NULL
, /* get_cb_away */ // deprecated
687 sipe_purple_alias_buddy
, /* alias_buddy */
688 sipe_purple_group_buddy
, /* group_buddy */
689 sipe_purple_group_rename
, /* rename_group */
690 NULL
, /* buddy_free */
691 sipe_purple_convo_closed
, /* convo_closed */
692 purple_normalize_nocase
, /* normalize */
693 NULL
, /* set_buddy_icon */
694 sipe_purple_group_remove
, /* remove_group */
695 NULL
, /* get_cb_real_name */ // TODO?
696 NULL
, /* set_chat_topic */
697 NULL
, /* find_blist_chat */
698 sipe_purple_roomlist_get_list
, /* roomlist_get_list */
699 sipe_purple_roomlist_cancel
, /* roomlist_cancel */
700 NULL
, /* roomlist_expand_category */
701 NULL
, /* can_receive_file */
702 sipe_purple_ft_send_file
, /* send_file */
703 sipe_purple_ft_new_xfer
, /* new_xfer */
704 NULL
, /* offline_message */
705 NULL
, /* whiteboard_prpl_ops */
707 NULL
, /* roomlist_room_serialize */
708 NULL
, /* unregister_user */
709 NULL
, /* send_attention */
710 NULL
, /* get_attention_types */
711 #if !PURPLE_VERSION_CHECK(2,5,0) && !PURPLE_VERSION_CHECK(3,0,0)
712 /* Backward compatibility when compiling against 2.4.x API */
713 (void (*)(void)) /* _purple_reserved4 */
715 #if !PURPLE_VERSION_CHECK(3,0,0)
716 sizeof(PurplePluginProtocolInfo
), /* struct_size */
718 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
719 sipe_purple_get_account_text_table
, /* get_account_text_table */
720 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
722 sipe_purple_initiate_media
, /* initiate_media */
723 sipe_purple_get_media_caps
, /* get_media_caps */
725 NULL
, /* initiate_media */
726 NULL
, /* get_media_caps */
728 #if PURPLE_VERSION_CHECK(2,7,0) || PURPLE_VERSION_CHECK(3,0,0)
729 NULL
, /* get_moods */
730 NULL
, /* set_public_alias */
731 NULL
, /* get_public_alias */
732 #if PURPLE_VERSION_CHECK(2,8,0)
733 NULL
, /* add_buddy_with_invite */
734 NULL
, /* add_buddies_with_invite */
741 #if (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 6)
742 #pragma GCC diagnostic pop
745 /* Original GCC error checking restored from here on... (see above) */
747 /* PurplePluginInfo function calls & data structure */
748 static gboolean
sipe_purple_plugin_load(SIPE_UNUSED_PARAMETER PurplePlugin
*plugin
)
751 struct sigaction action
;
752 memset(&action
, 0, sizeof (action
));
753 action
.sa_handler
= sipe_purple_sigusr1_handler
;
754 sigaction(SIGUSR1
, &action
, NULL
);
759 static gboolean
sipe_purple_plugin_unload(SIPE_UNUSED_PARAMETER PurplePlugin
*plugin
)
762 struct sigaction action
;
763 memset(&action
, 0, sizeof (action
));
764 action
.sa_handler
= SIG_DFL
;
765 sigaction(SIGUSR1
, &action
, NULL
);
770 static void sipe_purple_plugin_destroy(SIPE_UNUSED_PARAMETER PurplePlugin
*plugin
)
774 sipe_purple_activity_shutdown();
777 entry
= sipe_prpl_info
.protocol_options
;
779 purple_account_option_destroy(entry
->data
);
780 entry
= g_list_delete_link(entry
, entry
);
782 sipe_prpl_info
.protocol_options
= NULL
;
784 entry
= sipe_prpl_info
.user_splits
;
786 purple_account_user_split_destroy(entry
->data
);
787 entry
= g_list_delete_link(entry
, entry
);
789 sipe_prpl_info
.user_splits
= NULL
;
792 static void sipe_purple_show_about_plugin(PurplePluginAction
*action
)
794 gchar
*tmp
= sipe_core_about();
795 purple_notify_formatted((PurpleConnection
*) action
->context
,
796 NULL
, " ", NULL
, tmp
, NULL
, NULL
);
800 static void sipe_purple_find_contact_cb(PurpleConnection
*gc
,
801 PurpleRequestFields
*fields
)
803 GList
*entries
= purple_request_field_group_get_fields(purple_request_fields_get_groups(fields
)->data
);
804 const gchar
*given_name
= NULL
;
805 const gchar
*surname
= NULL
;
806 const gchar
*email
= NULL
;
807 const gchar
*company
= NULL
;
808 const gchar
*country
= NULL
;
811 PurpleRequestField
*field
= entries
->data
;
812 const char *id
= purple_request_field_get_id(field
);
813 const char *value
= purple_request_field_string_get_value(field
);
815 SIPE_DEBUG_INFO("sipe_purple_find_contact_cb: %s = '%s'", id
, value
? value
: "");
818 if (strcmp(id
, "given") == 0) {
820 } else if (strcmp(id
, "surname") == 0) {
822 } else if (strcmp(id
, "email") == 0) {
824 } else if (strcmp(id
, "company") == 0) {
826 } else if (strcmp(id
, "country") == 0) {
831 entries
= g_list_next(entries
);
834 sipe_core_buddy_search(PURPLE_GC_TO_SIPE_CORE_PUBLIC
,
843 static void sipe_purple_show_find_contact(PurplePluginAction
*action
)
845 PurpleConnection
*gc
= (PurpleConnection
*) action
->context
;
846 PurpleRequestFields
*fields
;
847 PurpleRequestFieldGroup
*group
;
848 PurpleRequestField
*field
;
850 fields
= purple_request_fields_new();
851 group
= purple_request_field_group_new(NULL
);
852 purple_request_fields_add_group(fields
, group
);
854 field
= purple_request_field_string_new("given", _("First name"), NULL
, FALSE
);
855 purple_request_field_group_add_field(group
, field
);
856 field
= purple_request_field_string_new("surname", _("Last name"), NULL
, FALSE
);
857 purple_request_field_group_add_field(group
, field
);
858 field
= purple_request_field_string_new("email", _("Email"), NULL
, FALSE
);
859 purple_request_field_group_add_field(group
, field
);
860 field
= purple_request_field_string_new("company", _("Company"), NULL
, FALSE
);
861 purple_request_field_group_add_field(group
, field
);
862 field
= purple_request_field_string_new("country", _("Country"), NULL
, FALSE
);
863 purple_request_field_group_add_field(group
, field
);
865 purple_request_fields(gc
,
867 _("Search for a contact"),
868 _("Enter the information for the person you wish to find. Empty fields will be ignored."),
870 _("_Search"), G_CALLBACK(sipe_purple_find_contact_cb
),
872 purple_connection_get_account(gc
), NULL
, NULL
, gc
);
875 static void sipe_purple_join_conference_cb(PurpleConnection
*gc
,
876 PurpleRequestFields
*fields
)
878 GList
*entries
= purple_request_field_group_get_fields(purple_request_fields_get_groups(fields
)->data
);
881 PurpleRequestField
*field
= entries
->data
;
882 const char *id
= purple_request_field_get_id(field
);
883 const char *value
= purple_request_field_string_get_value(field
);
885 if (!sipe_strequal(id
, "meetingLocation"))
888 sipe_core_conf_create(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, value
);
894 static void sipe_purple_phone_call_cb(PurpleConnection
*gc
,
895 PurpleRequestFields
*fields
)
897 GList
*entries
= purple_request_field_group_get_fields(purple_request_fields_get_groups(fields
)->data
);
900 PurpleRequestField
*field
= entries
->data
;
901 const char *id
= purple_request_field_get_id(field
);
902 const char *value
= purple_request_field_string_get_value(field
);
904 if (!sipe_strequal(id
, "phoneNumber"))
907 sipe_core_media_phone_call(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, value
);
911 static void sipe_purple_phone_call(PurplePluginAction
*action
)
913 PurpleConnection
*gc
= (PurpleConnection
*) action
->context
;
914 PurpleRequestFields
*fields
;
915 PurpleRequestFieldGroup
*group
;
916 PurpleRequestField
*field
;
918 fields
= purple_request_fields_new();
919 group
= purple_request_field_group_new(NULL
);
920 purple_request_fields_add_group(fields
, group
);
922 field
= purple_request_field_string_new("phoneNumber", _("Phone number"), NULL
, FALSE
);
923 purple_request_field_group_add_field(group
, field
);
925 purple_request_fields(gc
,
926 _("Call a phone number"),
927 _("Call a phone number"),
930 _("_Call"), G_CALLBACK(sipe_purple_phone_call_cb
),
932 purple_connection_get_account(gc
), NULL
, NULL
, gc
);
935 static void sipe_purple_test_call(PurplePluginAction
*action
)
937 PurpleConnection
*gc
= (PurpleConnection
*) action
->context
;
938 sipe_core_media_test_call(PURPLE_GC_TO_SIPE_CORE_PUBLIC
);
942 static void sipe_purple_show_join_conference(PurplePluginAction
*action
)
944 PurpleConnection
*gc
= (PurpleConnection
*) action
->context
;
945 PurpleRequestFields
*fields
;
946 PurpleRequestFieldGroup
*group
;
947 PurpleRequestField
*field
;
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"
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"
965 "https://meet.company.com/someone/abcdef1234"),
967 _("_Join"), G_CALLBACK(sipe_purple_join_conference_cb
),
969 purple_connection_get_account(gc
), NULL
, NULL
, gc
);
972 static void sipe_purple_republish_calendar(PurplePluginAction
*action
)
974 PurpleConnection
*gc
= (PurpleConnection
*) action
->context
;
975 PurpleAccount
*account
= purple_connection_get_account(gc
);
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"),
982 sipe_core_update_calendar(PURPLE_GC_TO_SIPE_CORE_PUBLIC
);
986 static void sipe_purple_reset_status(PurplePluginAction
*action
)
988 PurpleConnection
*gc
= (PurpleConnection
*) action
->context
;
989 PurpleAccount
*account
= purple_connection_get_account(gc
);
991 if (get_dont_publish_flag(account
)) {
992 sipe_backend_notify_error(PURPLE_GC_TO_SIPE_CORE_PUBLIC
,
993 _("Publishing of calendar information has been disabled"),
996 sipe_core_reset_status(PURPLE_GC_TO_SIPE_CORE_PUBLIC
);
1000 static GList
*sipe_purple_actions(SIPE_UNUSED_PARAMETER PurplePlugin
*plugin
,
1001 SIPE_UNUSED_PARAMETER gpointer context
)
1004 PurplePluginAction
*act
;
1006 act
= purple_plugin_action_new(_("About SIPE plugin..."), sipe_purple_show_about_plugin
);
1007 menu
= g_list_prepend(menu
, act
);
1009 act
= purple_plugin_action_new(_("Contact search..."), sipe_purple_show_find_contact
);
1010 menu
= g_list_prepend(menu
, act
);
1013 act
= purple_plugin_action_new(_("Call a phone number..."), sipe_purple_phone_call
);
1014 menu
= g_list_prepend(menu
, act
);
1016 act
= purple_plugin_action_new(_("Test call"), sipe_purple_test_call
);
1017 menu
= g_list_prepend(menu
, act
);
1020 act
= purple_plugin_action_new(_("Join scheduled conference..."), sipe_purple_show_join_conference
);
1021 menu
= g_list_prepend(menu
, act
);
1023 act
= purple_plugin_action_new(_("Republish Calendar"), sipe_purple_republish_calendar
);
1024 menu
= g_list_prepend(menu
, act
);
1026 act
= purple_plugin_action_new(_("Reset status"), sipe_purple_reset_status
);
1027 menu
= g_list_prepend(menu
, act
);
1029 return g_list_reverse(menu
);
1032 static PurplePluginInfo sipe_purple_info
= {
1033 PURPLE_PLUGIN_MAGIC
,
1034 PURPLE_MAJOR_VERSION
,
1035 PURPLE_MINOR_VERSION
,
1036 PURPLE_PLUGIN_PROTOCOL
, /**< type */
1037 NULL
, /**< ui_requirement */
1039 NULL
, /**< dependencies */
1040 PURPLE_PRIORITY_DEFAULT
, /**< priority */
1041 "prpl-sipe", /**< id */
1042 "Office Communicator", /**< name */
1043 PACKAGE_VERSION
, /**< version */
1044 "Microsoft Office Communicator Protocol Plugin", /**< summary */
1045 "A plugin for the extended SIP/SIMPLE protocol used by " /**< description */
1046 "Microsoft Live/Office Communications/Lync Server (LCS2005/OCS2007+)", /**< description */
1047 "Stefan Becker <chemobejk@gmail.com>, " /**< author */
1048 "Jakub Adam <jakub.adam@tieto.com>, " /**< author */
1049 "Anibal Avelar <avelar@gmail.com> (retired), " /**< author */
1050 "pier11 <pier11@operamail.com> (retired), " /**< author */
1051 "Gabriel Burt <gburt@novell.com> (retired)", /**< author */
1052 PACKAGE_URL
, /**< homepage */
1053 sipe_purple_plugin_load
, /**< load */
1054 sipe_purple_plugin_unload
, /**< unload */
1055 sipe_purple_plugin_destroy
, /**< destroy */
1056 NULL
, /**< ui_info */
1057 &sipe_prpl_info
, /**< extra_info */
1059 sipe_purple_actions
,
1066 static void sipe_purple_init_plugin(PurplePlugin
*plugin
)
1068 PurpleAccountUserSplit
*split
;
1069 PurpleAccountOption
*option
;
1071 /* This needs to be called first */
1072 sipe_core_init(LOCALEDIR
);
1073 sipe_purple_activity_init();
1075 purple_plugin_register(plugin
);
1078 * When adding new string settings please make sure to keep these
1081 * api/sipe-backend.h
1082 * purple-settings.c:setting_name[]
1084 split
= purple_account_user_split_new(_("Login\n user or DOMAIN\\user or\n user@company.com"), NULL
, ',');
1085 purple_account_user_split_set_reverse(split
, FALSE
);
1086 sipe_prpl_info
.user_splits
= g_list_append(sipe_prpl_info
.user_splits
, split
);
1088 option
= purple_account_option_string_new(_("Server[:Port]\n(leave empty for auto-discovery)"), "server", "");
1089 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
1091 option
= purple_account_option_list_new(_("Connection type"), "transport", NULL
);
1092 purple_account_option_add_list_item(option
, _("Auto"), "auto");
1093 purple_account_option_add_list_item(option
, _("SSL/TLS"), "tls");
1094 purple_account_option_add_list_item(option
, _("TCP"), "tcp");
1095 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
1097 /*option = purple_account_option_bool_new(_("Publish status (note: everyone may watch you)"), "doservice", TRUE);
1098 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);*/
1100 option
= purple_account_option_string_new(_("User Agent"), "useragent", "");
1101 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
1103 option
= purple_account_option_list_new(_("Authentication scheme"), "authentication", NULL
);
1104 purple_account_option_add_list_item(option
, _("NTLM"), "ntlm");
1105 #if PURPLE_SIPE_SSO_AND_KERBEROS
1106 purple_account_option_add_list_item(option
, _("Kerberos"), "krb5");
1108 purple_account_option_add_list_item(option
, _("TLS-DSK"), "tls-dsk");
1109 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
1111 #if PURPLE_SIPE_SSO_AND_KERBEROS
1113 * When the user selects Single Sign-On then SIPE will ignore the
1114 * settings for "login name" and "password". Instead it will use the
1115 * default credentials provided by the OS.
1117 * NOTE: the default must be *OFF*, i.e. it is up to the user to tell
1118 * SIPE that it is OK to use Single Sign-On or not.
1120 * Configurations that are known to support Single Sign-On:
1122 * - Windows, host joined to domain, SIPE with SSPI: NTLM
1123 * - Windows, host joined to domain, SIPE with SSPI: Kerberos
1124 * - SIPE with libkrb5, valid TGT in cache (kinit): Kerberos
1126 option
= purple_account_option_bool_new(_("Use Single Sign-On"), "sso", FALSE
);
1127 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
1130 /** Example (Exchange): https://server.company.com/EWS/Exchange.asmx
1131 * Example (Domino) : https://[domino_server]/[mail_database_name].nsf
1133 option
= purple_account_option_bool_new(_("Don't publish my calendar information"), "dont-publish", FALSE
);
1134 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
1136 option
= purple_account_option_string_new(_("Email services URL\n(leave empty for auto-discovery)"), "email_url", "");
1137 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
1139 option
= purple_account_option_string_new(_("Email address\n(if different from Username)"), "email", "");
1140 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
1142 /** Example (Exchange): DOMAIN\user or user@company.com
1143 * Example (Domino) : email_address
1145 option
= purple_account_option_string_new(_("Email login\n(if different from Login)"), "email_login", "");
1146 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
1148 option
= purple_account_option_string_new(_("Email password\n(if different from Password)"), "email_password", "");
1149 #if PURPLE_VERSION_CHECK(3,0,0)
1150 purple_account_option_string_set_masked(
1152 purple_account_option_set_masked(
1155 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
1157 /** Example (federated domain): company.com (i.e. ocschat@company.com)
1158 * Example (non-default user): user@company.com
1160 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", "");
1161 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
1164 /* This macro makes the code a purple plugin */
1165 PURPLE_INIT_PLUGIN(sipe
, sipe_purple_init_plugin
, sipe_purple_info
);