2 * @file purple-plugin.c
6 * Copyright (C) 2010-12 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
78 /* Sipe core activity <-> Purple status mapping */
79 static const gchar
* const activity_to_purple_map
[SIPE_ACTIVITY_NUM_TYPES
] = {
80 /* SIPE_ACTIVITY_UNSET */ "unset", /* == purple_primitive_get_id_from_type(PURPLE_STATUS_UNSET) */
81 /* SIPE_ACTIVITY_AVAILABLE */ "available", /* == purple_primitive_get_id_from_type(PURPLE_STATUS_AVAILABLE) */
82 /* SIPE_ACTIVITY_ONLINE */ "online",
83 /* SIPE_ACTIVITY_INACTIVE */ "idle",
84 /* SIPE_ACTIVITY_BUSY */ "busy",
85 /* SIPE_ACTIVITY_BUSYIDLE */ "busyidle",
86 /* SIPE_ACTIVITY_DND */ "do-not-disturb",
87 /* SIPE_ACTIVITY_BRB */ "be-right-back",
88 /* SIPE_ACTIVITY_AWAY */ "away", /* == purple_primitive_get_id_from_type(PURPLE_STATUS_AWAY) */
89 /* SIPE_ACTIVITY_LUNCH */ "out-to-lunch",
90 /* SIPE_ACTIVITY_INVISIBLE */ "invisible", /* == purple_primitive_get_id_from_type(PURPLE_STATUS_INVISIBLE) */
91 /* SIPE_ACTIVITY_OFFLINE */ "offline", /* == purple_primitive_get_id_from_type(PURPLE_STATUS_OFFLINE) */
92 /* SIPE_ACTIVITY_ON_PHONE */ "on-the-phone",
93 /* SIPE_ACTIVITY_IN_CONF */ "in-a-conference",
94 /* SIPE_ACTIVITY_IN_MEETING */ "in-a-meeting",
95 /* SIPE_ACTIVITY_OOF */ "out-of-office",
96 /* SIPE_ACTIVITY_URGENT_ONLY */ "urgent-interruptions-only",
99 GHashTable
*purple_token_map
;
101 static void sipe_purple_activity_init(void)
105 purple_token_map
= g_hash_table_new(g_str_hash
, g_str_equal
);
106 for (index
= SIPE_ACTIVITY_UNSET
;
107 index
< SIPE_ACTIVITY_NUM_TYPES
;
109 g_hash_table_insert(purple_token_map
,
110 (gchar
*) activity_to_purple_map
[index
],
111 GUINT_TO_POINTER(index
));
115 static void sipe_purple_activity_shutdown(void)
117 g_hash_table_destroy(purple_token_map
);
120 const gchar
*sipe_purple_activity_to_token(guint type
)
122 return(activity_to_purple_map
[type
]);
125 guint
sipe_purple_token_to_activity(const gchar
*token
)
127 return(GPOINTER_TO_UINT(g_hash_table_lookup(purple_token_map
, token
)));
130 gchar
*sipe_backend_version(void)
132 return(g_strdup_printf("Purple/%s", purple_core_get_version()));
135 /* PurplePluginProtocolInfo function calls & data structure */
136 static const char *sipe_list_icon(SIPE_UNUSED_PARAMETER PurpleAccount
*a
,
137 SIPE_UNUSED_PARAMETER PurpleBuddy
*b
)
142 static gchar
*sipe_purple_status_text(PurpleBuddy
*buddy
)
144 const PurpleStatus
*status
= purple_presence_get_active_status(purple_buddy_get_presence(buddy
));
145 return sipe_core_buddy_status(PURPLE_BUDDY_TO_SIPE_CORE_PUBLIC
,
147 sipe_purple_token_to_activity(purple_status_get_id(status
)),
148 purple_status_get_name(status
));
151 static void sipe_purple_tooltip_text(PurpleBuddy
*buddy
,
152 PurpleNotifyUserInfo
*user_info
,
153 SIPE_UNUSED_PARAMETER gboolean full
)
155 const PurplePresence
*presence
= purple_buddy_get_presence(buddy
);
156 sipe_core_buddy_tooltip_info(PURPLE_BUDDY_TO_SIPE_CORE_PUBLIC
,
158 purple_status_get_name(purple_presence_get_active_status(presence
)),
159 purple_presence_is_online(presence
),
160 (struct sipe_backend_buddy_tooltip
*) user_info
);
163 static GList
*sipe_purple_status_types(SIPE_UNUSED_PARAMETER PurpleAccount
*acc
)
165 PurpleStatusType
*type
;
168 /* Macros to reduce code repetition.
170 #define SIPE_ADD_STATUS(prim,id,name,user) type = purple_status_type_new_with_attrs( \
173 SIPE_PURPLE_STATUS_ATTR_ID_MESSAGE, _("Message"), purple_value_new(PURPLE_TYPE_STRING), \
175 types = g_list_append(types, type);
178 SIPE_ADD_STATUS(PURPLE_STATUS_AVAILABLE
,
184 SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE
,
185 sipe_purple_activity_to_token(SIPE_ACTIVITY_BUSY
),
186 sipe_core_activity_description(SIPE_ACTIVITY_BUSY
),
190 SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE
,
191 sipe_purple_activity_to_token(SIPE_ACTIVITY_DND
),
196 SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE
,
197 sipe_purple_activity_to_token(SIPE_ACTIVITY_ON_PHONE
),
198 sipe_core_activity_description(SIPE_ACTIVITY_ON_PHONE
),
201 /* In a conference call */
202 SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE
,
203 sipe_purple_activity_to_token(SIPE_ACTIVITY_IN_CONF
),
204 sipe_core_activity_description(SIPE_ACTIVITY_IN_CONF
),
208 /* Goes first in the list as
209 * purple picks the first status with the AWAY type
212 SIPE_ADD_STATUS(PURPLE_STATUS_AWAY
,
218 SIPE_ADD_STATUS(PURPLE_STATUS_AWAY
,
219 sipe_purple_activity_to_token(SIPE_ACTIVITY_BRB
),
220 sipe_core_activity_description(SIPE_ACTIVITY_BRB
),
224 SIPE_ADD_STATUS(PURPLE_STATUS_INVISIBLE
,
230 type
= purple_status_type_new(PURPLE_STATUS_OFFLINE
,
234 types
= g_list_append(types
, type
);
239 static GList
*sipe_purple_blist_node_menu(PurpleBlistNode
*node
)
241 if(PURPLE_BLIST_NODE_IS_BUDDY(node
)) {
242 return sipe_purple_buddy_menu((PurpleBuddy
*) node
);
243 } else if(PURPLE_BLIST_NODE_IS_CHAT(node
)) {
244 return sipe_purple_chat_menu((PurpleChat
*)node
);
250 static void sipe_purple_login(PurpleAccount
*account
)
252 PurpleConnection
*gc
= purple_account_get_connection(account
);
253 const gchar
*username
= purple_account_get_username(account
);
254 const gchar
*email
= purple_account_get_string(account
, "email", NULL
);
255 const gchar
*email_url
= purple_account_get_string(account
, "email_url", NULL
);
256 const gchar
*transport
= purple_account_get_string(account
, "transport", "auto");
257 const gchar
*auth
= purple_account_get_string(account
, "authentication", "ntlm");
258 struct sipe_core_public
*sipe_public
;
259 gchar
**username_split
;
260 gchar
*login_domain
= NULL
;
261 gchar
*login_account
= NULL
;
264 struct sipe_backend_private
*purple_private
;
266 /* username format: <username>,[<optional login>] */
267 SIPE_DEBUG_INFO("sipe_purple_login: username '%s'", username
);
268 username_split
= g_strsplit(username
, ",", 2);
270 /* login name specified? */
271 if (username_split
[1] && strlen(username_split
[1])) {
272 /* Allowed domain-account separators are / or \ */
273 gchar
**domain_user
= g_strsplit_set(username_split
[1], "/\\", 2);
274 gboolean has_domain
= domain_user
[1] != NULL
;
275 SIPE_DEBUG_INFO("sipe_purple_login: login '%s'", username_split
[1]);
276 login_domain
= has_domain
? g_strdup(domain_user
[0]) : NULL
;
277 login_account
= g_strdup(domain_user
[has_domain
? 1 : 0]);
278 SIPE_DEBUG_INFO("sipe_purple_login: auth domain '%s' user '%s'",
279 login_domain
? login_domain
: "",
281 g_strfreev(domain_user
);
284 sipe_public
= sipe_core_allocate(username_split
[0],
285 login_domain
, login_account
,
286 purple_connection_get_password(gc
),
290 g_free(login_domain
);
291 g_free(login_account
);
292 g_strfreev(username_split
);
295 #if PURPLE_VERSION_CHECK(3,0,0)
296 purple_connection_error(
298 purple_connection_error_reason(
301 PURPLE_CONNECTION_ERROR_INVALID_USERNAME
,
306 sipe_public
->backend_private
= purple_private
= g_new0(struct sipe_backend_private
, 1);
307 purple_private
->public = sipe_public
;
308 purple_private
->gc
= gc
;
309 purple_private
->account
= account
;
311 sipe_purple_chat_setup_rejoin(purple_private
);
313 /* map option list to flags - default is NTLM */
314 SIPE_CORE_FLAG_UNSET(KRB5
);
315 SIPE_CORE_FLAG_UNSET(TLS_DSK
);
316 SIPE_CORE_FLAG_UNSET(SSO
);
317 #if defined(HAVE_LIBKRB5) || defined(HAVE_SSPI)
318 if (sipe_strequal(auth
, "krb5")) {
319 SIPE_CORE_FLAG_SET(KRB5
);
324 * @TODO: SSL handshake support isn't implemented in sip-sec-sspi.c.
325 * So ignore configuration setting for now.
327 if (sipe_strequal(auth
, "tls-dsk")) {
328 SIPE_CORE_FLAG_SET(TLS_DSK
);
332 /* @TODO: is this correct?
333 "sso" is only available when Kerberos/SSPI support is compiled in */
334 if (purple_account_get_bool(account
, "sso", TRUE
))
335 SIPE_CORE_FLAG_SET(SSO
);
337 gc
->proto_data
= sipe_public
;
338 gc
->flags
|= PURPLE_CONNECTION_HTML
| PURPLE_CONNECTION_FORMATTING_WBFO
| PURPLE_CONNECTION_NO_BGCOLOR
|
339 PURPLE_CONNECTION_NO_FONTSIZE
| PURPLE_CONNECTION_NO_URLDESC
| PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY
;
340 purple_connection_set_display_name(gc
, sipe_public
->sip_name
);
341 purple_connection_update_progress(gc
, _("Connecting"), 1, 2);
343 username_split
= g_strsplit(purple_account_get_string(account
, "server", ""), ":", 2);
344 if (sipe_strequal(transport
, "auto")) {
345 type
= (username_split
[0] == NULL
) ?
346 SIPE_TRANSPORT_AUTO
: SIPE_TRANSPORT_TLS
;
347 } else if (sipe_strequal(transport
, "tls")) {
348 type
= SIPE_TRANSPORT_TLS
;
350 type
= SIPE_TRANSPORT_TCP
;
352 sipe_core_transport_sip_connect(sipe_public
,
355 username_split
[0] ? username_split
[1] : NULL
);
356 g_strfreev(username_split
);
359 static void sipe_purple_close(PurpleConnection
*gc
)
361 struct sipe_core_public
*sipe_public
= PURPLE_GC_TO_SIPE_CORE_PUBLIC
;
364 struct sipe_backend_private
*purple_private
= sipe_public
->backend_private
;
366 sipe_core_deallocate(sipe_public
);
368 if (purple_private
->roomlist_map
)
369 g_hash_table_destroy(purple_private
->roomlist_map
);
370 sipe_purple_chat_destroy_rejoin(purple_private
);
371 g_free(purple_private
);
372 gc
->proto_data
= NULL
;
376 static int sipe_purple_send_im(PurpleConnection
*gc
,
379 SIPE_UNUSED_PARAMETER PurpleMessageFlags flags
)
381 sipe_core_im_send(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, who
, what
);
385 #define SIPE_TYPING_SEND_TIMEOUT 4
387 static unsigned int sipe_purple_send_typing(PurpleConnection
*gc
,
389 PurpleTypingState state
)
391 if (state
== PURPLE_NOT_TYPING
)
394 sipe_core_user_feedback_typing(PURPLE_GC_TO_SIPE_CORE_PUBLIC
,
397 return SIPE_TYPING_SEND_TIMEOUT
;
400 static void sipe_purple_get_info(PurpleConnection
*gc
, const char *who
)
402 sipe_core_buddy_get_info(PURPLE_GC_TO_SIPE_CORE_PUBLIC
,
406 static void sipe_purple_add_permit(PurpleConnection
*gc
, const char *name
)
408 sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, name
, TRUE
);
411 static void sipe_purple_add_deny(PurpleConnection
*gc
, const char *name
)
413 sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, name
, FALSE
);
416 static void sipe_purple_keep_alive(PurpleConnection
*gc
)
418 struct sipe_core_public
*sipe_public
= PURPLE_GC_TO_SIPE_CORE_PUBLIC
;
419 struct sipe_backend_private
*purple_private
= sipe_public
->backend_private
;
420 time_t now
= time(NULL
);
422 if ((sipe_public
->keepalive_timeout
> 0) &&
423 ((guint
) (now
- purple_private
->last_keepalive
) >= sipe_public
->keepalive_timeout
) &&
424 ((guint
) (now
- gc
->last_received
) >= sipe_public
->keepalive_timeout
)
426 sipe_core_transport_sip_keepalive(sipe_public
);
427 purple_private
->last_keepalive
= now
;
431 static void sipe_purple_alias_buddy(PurpleConnection
*gc
, const char *name
,
434 sipe_core_group_set_alias(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, name
, alias
);
437 static void sipe_purple_group_rename(PurpleConnection
*gc
,
438 const char *old_name
,
440 SIPE_UNUSED_PARAMETER GList
*moved_buddies
)
442 sipe_core_group_rename(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, old_name
, group
->name
);
445 static void sipe_purple_convo_closed(PurpleConnection
*gc
,
448 sipe_core_im_close(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, who
);
451 static void sipe_purple_group_remove(PurpleConnection
*gc
, PurpleGroup
*group
)
453 sipe_core_group_remove(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, group
->name
);
456 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
458 sipe_purple_get_account_text_table(SIPE_UNUSED_PARAMETER PurpleAccount
*account
)
461 table
= g_hash_table_new(g_str_hash
, g_str_equal
);
462 g_hash_table_insert(table
, "login_label", (gpointer
)_("user@company.com"));
466 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
470 sipe_purple_sigusr1_handler(SIPE_UNUSED_PARAMETER
int signum
)
472 capture_pipeline("PURPLE_SIPE_PIPELINE");
475 static gboolean
sipe_purple_initiate_media(PurpleAccount
*account
, const char *who
,
476 SIPE_UNUSED_PARAMETER PurpleMediaSessionType type
)
478 sipe_core_media_initiate_call(PURPLE_ACCOUNT_TO_SIPE_CORE_PUBLIC
,
480 (type
& PURPLE_MEDIA_VIDEO
));
484 static PurpleMediaCaps
sipe_purple_get_media_caps(SIPE_UNUSED_PARAMETER PurpleAccount
*account
,
485 SIPE_UNUSED_PARAMETER
const char *who
)
487 return PURPLE_MEDIA_CAPS_AUDIO
488 | PURPLE_MEDIA_CAPS_AUDIO_VIDEO
489 | PURPLE_MEDIA_CAPS_MODIFY_SESSION
;
496 * Simplistic source upward compatibility path for newer libpurple APIs
498 * Usually we compile with -Werror=missing-field-initializers if GCC supports
499 * it. But that means that the compilation of this structure can fail if the
500 * newer API has added additional plugin callbacks. For the benefit of the
501 * user we downgrade it to a warning here.
503 * Diagnostic #pragma was added in GCC 4.2.0
504 * Diagnostic push/pop was added in GCC 4.6.0
507 #if (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 2)
508 #if __GNUC_MINOR__ >= 6
509 #pragma GCC diagnostic push
511 #pragma GCC diagnostic warning "-Wmissing-field-initializers"
514 static PurplePluginProtocolInfo sipe_prpl_info
=
516 #if PURPLE_VERSION_CHECK(3,0,0)
517 sizeof(PurplePluginProtocolInfo
), /* struct_size */
520 * NOTE: Do *NOT* add OPT_PROTO_PASSWORD_OPTIONAL here, because it
521 * breaks the "ask for password" functionality for non-Kerberos
522 * users when Kerberos is compiled in!
524 * Kerberos users: I know this sucks. If you don't like it, then
525 * please improve libpurple to make this a run-time feature instead
526 * of a compile-time feature.
528 OPT_PROTO_CHAT_TOPIC
,
529 NULL
, /* user_splits */
530 NULL
, /* protocol_options */
531 NO_BUDDY_ICONS
, /* icon_spec */
532 sipe_list_icon
, /* list_icon */
533 NULL
, /* list_emblems */
534 sipe_purple_status_text
, /* status_text */
535 sipe_purple_tooltip_text
, /* tooltip_text */ // add custom info to contact tooltip
536 sipe_purple_status_types
, /* away_states */
537 sipe_purple_blist_node_menu
, /* blist_node_menu */
538 sipe_purple_chat_info
, /* chat_info */
539 sipe_purple_chat_info_defaults
, /* chat_info_defaults */
540 sipe_purple_login
, /* login */
541 sipe_purple_close
, /* close */
542 sipe_purple_send_im
, /* send_im */
543 NULL
, /* set_info */ // TODO maybe
544 sipe_purple_send_typing
, /* send_typing */
545 sipe_purple_get_info
, /* get_info */
546 sipe_purple_set_status
, /* set_status */
547 sipe_purple_set_idle
, /* set_idle */
548 NULL
, /* change_passwd */
549 sipe_purple_add_buddy
, /* add_buddy */
550 NULL
, /* add_buddies */
551 sipe_purple_remove_buddy
, /* remove_buddy */
552 NULL
, /* remove_buddies */
553 sipe_purple_add_permit
, /* add_permit */
554 sipe_purple_add_deny
, /* add_deny */
555 sipe_purple_add_deny
, /* rem_permit */
556 sipe_purple_add_permit
, /* rem_deny */
557 NULL
, /* set_permit_deny */
558 sipe_purple_chat_join
, /* join_chat */
559 NULL
, /* reject_chat */
560 NULL
, /* get_chat_name */
561 sipe_purple_chat_invite
, /* chat_invite */
562 sipe_purple_chat_leave
, /* chat_leave */
563 NULL
, /* chat_whisper */
564 sipe_purple_chat_send
, /* chat_send */
565 sipe_purple_keep_alive
, /* keepalive */
566 NULL
, /* register_user */
567 NULL
, /* get_cb_info */ // deprecated
568 #if !PURPLE_VERSION_CHECK(3,0,0)
569 NULL
, /* get_cb_away */ // deprecated
571 sipe_purple_alias_buddy
, /* alias_buddy */
572 sipe_purple_group_buddy
, /* group_buddy */
573 sipe_purple_group_rename
, /* rename_group */
574 NULL
, /* buddy_free */
575 sipe_purple_convo_closed
, /* convo_closed */
576 purple_normalize_nocase
, /* normalize */
577 NULL
, /* set_buddy_icon */
578 sipe_purple_group_remove
, /* remove_group */
579 NULL
, /* get_cb_real_name */ // TODO?
580 NULL
, /* set_chat_topic */
581 NULL
, /* find_blist_chat */
582 sipe_purple_roomlist_get_list
, /* roomlist_get_list */
583 sipe_purple_roomlist_cancel
, /* roomlist_cancel */
584 NULL
, /* roomlist_expand_category */
585 NULL
, /* can_receive_file */
586 sipe_purple_ft_send_file
, /* send_file */
587 sipe_purple_ft_new_xfer
, /* new_xfer */
588 NULL
, /* offline_message */
589 NULL
, /* whiteboard_prpl_ops */
591 NULL
, /* roomlist_room_serialize */
592 NULL
, /* unregister_user */
593 NULL
, /* send_attention */
594 NULL
, /* get_attention_types */
595 #if !PURPLE_VERSION_CHECK(2,5,0) && !PURPLE_VERSION_CHECK(3,0,0)
596 /* Backward compatibility when compiling against 2.4.x API */
597 (void (*)(void)) /* _purple_reserved4 */
599 #if !PURPLE_VERSION_CHECK(3,0,0)
600 sizeof(PurplePluginProtocolInfo
), /* struct_size */
602 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
603 sipe_purple_get_account_text_table
, /* get_account_text_table */
604 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
606 sipe_purple_initiate_media
, /* initiate_media */
607 sipe_purple_get_media_caps
, /* get_media_caps */
609 NULL
, /* initiate_media */
610 NULL
, /* get_media_caps */
612 #if PURPLE_VERSION_CHECK(2,7,0) || PURPLE_VERSION_CHECK(3,0,0)
613 NULL
, /* get_moods */
614 NULL
, /* set_public_alias */
615 NULL
, /* get_public_alias */
616 #if PURPLE_VERSION_CHECK(2,8,0)
617 NULL
, /* add_buddy_with_invite */
618 NULL
, /* add_buddies_with_invite */
625 #if (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 6)
626 #pragma GCC diagnostic pop
629 /* Original GCC error checking restored from here on... (see above) */
631 /* PurplePluginInfo function calls & data structure */
632 static gboolean
sipe_purple_plugin_load(SIPE_UNUSED_PARAMETER PurplePlugin
*plugin
)
635 struct sigaction action
;
636 memset(&action
, 0, sizeof (action
));
637 action
.sa_handler
= sipe_purple_sigusr1_handler
;
638 sigaction(SIGUSR1
, &action
, NULL
);
643 static gboolean
sipe_purple_plugin_unload(SIPE_UNUSED_PARAMETER PurplePlugin
*plugin
)
646 struct sigaction action
;
647 memset(&action
, 0, sizeof (action
));
648 action
.sa_handler
= SIG_DFL
;
649 sigaction(SIGUSR1
, &action
, NULL
);
654 static void sipe_purple_plugin_destroy(SIPE_UNUSED_PARAMETER PurplePlugin
*plugin
)
658 sipe_purple_activity_shutdown();
661 entry
= sipe_prpl_info
.protocol_options
;
663 purple_account_option_destroy(entry
->data
);
664 entry
= g_list_delete_link(entry
, entry
);
666 sipe_prpl_info
.protocol_options
= NULL
;
668 entry
= sipe_prpl_info
.user_splits
;
670 purple_account_user_split_destroy(entry
->data
);
671 entry
= g_list_delete_link(entry
, entry
);
673 sipe_prpl_info
.user_splits
= NULL
;
676 static void sipe_purple_show_about_plugin(PurplePluginAction
*action
)
678 gchar
*tmp
= sipe_core_about();
679 purple_notify_formatted((PurpleConnection
*) action
->context
,
680 NULL
, " ", NULL
, tmp
, NULL
, NULL
);
684 static void sipe_purple_find_contact_cb(PurpleConnection
*gc
,
685 PurpleRequestFields
*fields
)
687 GList
*entries
= purple_request_field_group_get_fields(purple_request_fields_get_groups(fields
)->data
);
688 const gchar
*given_name
= NULL
;
689 const gchar
*surname
= NULL
;
690 const gchar
*email
= NULL
;
691 const gchar
*company
= NULL
;
692 const gchar
*country
= NULL
;
695 PurpleRequestField
*field
= entries
->data
;
696 const char *id
= purple_request_field_get_id(field
);
697 const char *value
= purple_request_field_string_get_value(field
);
699 SIPE_DEBUG_INFO("sipe_purple_find_contact_cb: %s = '%s'", id
, value
? value
: "");
702 if (strcmp(id
, "given") == 0) {
704 } else if (strcmp(id
, "surname") == 0) {
706 } else if (strcmp(id
, "email") == 0) {
708 } else if (strcmp(id
, "company") == 0) {
710 } else if (strcmp(id
, "country") == 0) {
715 entries
= g_list_next(entries
);
718 sipe_core_buddy_search(PURPLE_GC_TO_SIPE_CORE_PUBLIC
,
727 static void sipe_purple_show_find_contact(PurplePluginAction
*action
)
729 PurpleConnection
*gc
= (PurpleConnection
*) action
->context
;
730 PurpleRequestFields
*fields
;
731 PurpleRequestFieldGroup
*group
;
732 PurpleRequestField
*field
;
734 fields
= purple_request_fields_new();
735 group
= purple_request_field_group_new(NULL
);
736 purple_request_fields_add_group(fields
, group
);
738 field
= purple_request_field_string_new("given", _("First name"), NULL
, FALSE
);
739 purple_request_field_group_add_field(group
, field
);
740 field
= purple_request_field_string_new("surname", _("Last name"), NULL
, FALSE
);
741 purple_request_field_group_add_field(group
, field
);
742 field
= purple_request_field_string_new("email", _("Email"), NULL
, FALSE
);
743 purple_request_field_group_add_field(group
, field
);
744 field
= purple_request_field_string_new("company", _("Company"), NULL
, FALSE
);
745 purple_request_field_group_add_field(group
, field
);
746 field
= purple_request_field_string_new("country", _("Country"), NULL
, FALSE
);
747 purple_request_field_group_add_field(group
, field
);
749 purple_request_fields(gc
,
751 _("Search for a contact"),
752 _("Enter the information for the person you wish to find. Empty fields will be ignored."),
754 _("_Search"), G_CALLBACK(sipe_purple_find_contact_cb
),
756 purple_connection_get_account(gc
), NULL
, NULL
, gc
);
759 static void sipe_purple_join_conference_cb(PurpleConnection
*gc
,
760 PurpleRequestFields
*fields
)
762 GList
*entries
= purple_request_field_group_get_fields(purple_request_fields_get_groups(fields
)->data
);
765 PurpleRequestField
*field
= entries
->data
;
766 const char *id
= purple_request_field_get_id(field
);
767 const char *value
= purple_request_field_string_get_value(field
);
769 if (!sipe_strequal(id
, "meetingLocation"))
772 sipe_core_conf_create(PURPLE_GC_TO_SIPE_CORE_PUBLIC
, value
);
777 static void sipe_purple_test_call(PurplePluginAction
*action
)
779 PurpleConnection
*gc
= (PurpleConnection
*) action
->context
;
780 sipe_core_media_test_call(PURPLE_GC_TO_SIPE_CORE_PUBLIC
);
784 static void sipe_purple_show_join_conference(PurplePluginAction
*action
)
786 PurpleConnection
*gc
= (PurpleConnection
*) action
->context
;
787 PurpleRequestFields
*fields
;
788 PurpleRequestFieldGroup
*group
;
789 PurpleRequestField
*field
;
791 fields
= purple_request_fields_new();
792 group
= purple_request_field_group_new(NULL
);
793 purple_request_fields_add_group(fields
, group
);
795 field
= purple_request_field_string_new("meetingLocation", _("Meeting location"), NULL
, FALSE
);
796 purple_request_field_group_add_field(group
, field
);
798 purple_request_fields(gc
,
799 _("Join conference"),
800 _("Join scheduled conference"),
801 _("Enter meeting location string you received in the invitation.\n"
803 "Valid location will be something like\n"
804 "meet:sip:someone@company.com;gruu;opaque=app:conf:focus:id:abcdef1234\n"
806 "https://meet.company.com/someone/abcdef1234"),
808 _("_Join"), G_CALLBACK(sipe_purple_join_conference_cb
),
810 purple_connection_get_account(gc
), NULL
, NULL
, gc
);
813 static void sipe_purple_republish_calendar(PurplePluginAction
*action
)
815 PurpleConnection
*gc
= (PurpleConnection
*) action
->context
;
816 sipe_core_update_calendar(PURPLE_GC_TO_SIPE_CORE_PUBLIC
);
819 static void sipe_purple_reset_status(PurplePluginAction
*action
)
821 PurpleConnection
*gc
= (PurpleConnection
*) action
->context
;
822 sipe_core_reset_status(PURPLE_GC_TO_SIPE_CORE_PUBLIC
);
825 static GList
*sipe_purple_actions(SIPE_UNUSED_PARAMETER PurplePlugin
*plugin
,
826 SIPE_UNUSED_PARAMETER gpointer context
)
829 PurplePluginAction
*act
;
831 act
= purple_plugin_action_new(_("About SIPE plugin..."), sipe_purple_show_about_plugin
);
832 menu
= g_list_prepend(menu
, act
);
834 act
= purple_plugin_action_new(_("Contact search..."), sipe_purple_show_find_contact
);
835 menu
= g_list_prepend(menu
, act
);
838 act
= purple_plugin_action_new(_("Test call"), sipe_purple_test_call
);
839 menu
= g_list_prepend(menu
, act
);
842 act
= purple_plugin_action_new(_("Join scheduled conference..."), sipe_purple_show_join_conference
);
843 menu
= g_list_prepend(menu
, act
);
845 act
= purple_plugin_action_new(_("Republish Calendar"), sipe_purple_republish_calendar
);
846 menu
= g_list_prepend(menu
, act
);
848 act
= purple_plugin_action_new(_("Reset status"), sipe_purple_reset_status
);
849 menu
= g_list_prepend(menu
, act
);
851 return g_list_reverse(menu
);
854 static PurplePluginInfo sipe_purple_info
= {
856 PURPLE_MAJOR_VERSION
,
857 PURPLE_MINOR_VERSION
,
858 PURPLE_PLUGIN_PROTOCOL
, /**< type */
859 NULL
, /**< ui_requirement */
861 NULL
, /**< dependencies */
862 PURPLE_PRIORITY_DEFAULT
, /**< priority */
863 "prpl-sipe", /**< id */
864 "Office Communicator", /**< name */
865 PACKAGE_VERSION
, /**< version */
866 "Microsoft Office Communicator Protocol Plugin", /**< summary */
867 "A plugin for the extended SIP/SIMPLE protocol used by " /**< description */
868 "Microsoft Live/Office Communications Server (LCS2005/OCS2007+)", /**< description */
869 "Anibal Avelar <avelar@gmail.com>, " /**< author */
870 "Gabriel Burt <gburt@novell.com>, " /**< author */
871 "Stefan Becker <stefan.becker@nokia.com>, " /**< author */
872 "pier11 <pier11@operamail.com>", /**< author */
873 PACKAGE_URL
, /**< homepage */
874 sipe_purple_plugin_load
, /**< load */
875 sipe_purple_plugin_unload
, /**< unload */
876 sipe_purple_plugin_destroy
, /**< destroy */
877 NULL
, /**< ui_info */
878 &sipe_prpl_info
, /**< extra_info */
887 static void sipe_purple_init_plugin(PurplePlugin
*plugin
)
889 PurpleAccountUserSplit
*split
;
890 PurpleAccountOption
*option
;
892 /* This needs to be called first */
893 sipe_core_init(LOCALEDIR
);
894 sipe_purple_activity_init();
896 purple_plugin_register(plugin
);
899 * When adding new string settings please make sure to keep these
903 * purple-settings.c:setting_name[]
905 split
= purple_account_user_split_new(_("Login\n user or DOMAIN\\user or\n user@company.com"), NULL
, ',');
906 purple_account_user_split_set_reverse(split
, FALSE
);
907 sipe_prpl_info
.user_splits
= g_list_append(sipe_prpl_info
.user_splits
, split
);
909 option
= purple_account_option_string_new(_("Server[:Port]\n(leave empty for auto-discovery)"), "server", "");
910 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
912 option
= purple_account_option_list_new(_("Connection type"), "transport", NULL
);
913 purple_account_option_add_list_item(option
, _("Auto"), "auto");
914 purple_account_option_add_list_item(option
, _("SSL/TLS"), "tls");
915 purple_account_option_add_list_item(option
, _("TCP"), "tcp");
916 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
918 /*option = purple_account_option_bool_new(_("Publish status (note: everyone may watch you)"), "doservice", TRUE);
919 sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);*/
921 option
= purple_account_option_string_new(_("User Agent"), "useragent", "");
922 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
924 option
= purple_account_option_list_new(_("Authentication scheme"), "authentication", NULL
);
925 purple_account_option_add_list_item(option
, _("NTLM"), "ntlm");
926 #if defined(HAVE_LIBKRB5) || defined(HAVE_SSPI)
927 purple_account_option_add_list_item(option
, _("Kerberos"), "krb5");
931 purple_account_option_add_list_item(option
, _("TLS-DSK"), "tls-dsk");
933 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
935 #if defined(HAVE_LIBKRB5) || defined(HAVE_SSPI)
936 /* Suitable for sspi/NTLM, sspi/Kerberos and krb5 security mechanisms
937 * No login/password is taken into account if this option present,
938 * instead used default credentials stored in OS.
940 option
= purple_account_option_bool_new(_("Use Single Sign-On"), "sso", TRUE
);
941 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
944 /** Example (Exchange): https://server.company.com/EWS/Exchange.asmx
945 * Example (Domino) : https://[domino_server]/[mail_database_name].nsf
947 option
= purple_account_option_string_new(_("Email services URL\n(leave empty for auto-discovery)"), "email_url", "");
948 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
950 option
= purple_account_option_string_new(_("Email address\n(if different from Username)"), "email", "");
951 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
953 /** Example (Exchange): DOMAIN\user or user@company.com
954 * Example (Domino) : email_address
956 option
= purple_account_option_string_new(_("Email login\n(if different from Login)"), "email_login", "");
957 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
959 option
= purple_account_option_string_new(_("Email password\n(if different from Password)"), "email_password", "");
960 purple_account_option_set_masked(option
, TRUE
);
961 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
963 /** Example (federated domain): company.com (i.e. ocschat@company.com)
964 * Example (non-default user): user@company.com
966 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", "");
967 sipe_prpl_info
.protocol_options
= g_list_append(sipe_prpl_info
.protocol_options
, option
);
970 /* This macro makes the code a purple plugin */
971 PURPLE_INIT_PLUGIN(sipe
, sipe_purple_init_plugin
, sipe_purple_info
);