src/purple/purple-plugin.c

   1 /**
   2  * @file purple-plugin.c
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010-12 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #include <string.h>
  28 #include <time.h>
  29
  30 #include <glib.h>
  31
  32 #include "sipe-common.h"
  33
  34 /* Flag needed for correct version of PURPLE_INIT_PLUGIN() */
  35 #ifndef PURPLE_PLUGINS
  36 #define PURPLE_PLUGINS
  37 #endif
  38
  39 /* for LOCALEDIR
  40  * as it's determined on runtime, as Pidgin installation can be anywhere.
  41  */
  42 #ifdef _WIN32
  43 #include "win32/win32dep.h"
  44 #endif
  45
  46 #include "accountopt.h"
  47 #include "blist.h"
  48 #include "connection.h"
  49 #include "core.h"
  50 #include "dnssrv.h"
  51 #ifdef HAVE_VV
  52 #include "media.h"
  53 #endif
  54 #include "prpl.h"
  55 #include "plugin.h"
  56 #include "request.h"
  57 #include "status.h"
  58 /*
  59  * NOTE: Currently PURPLE_VERSION_CHECK(2,y,z) returns FALSE for libpurple >= 3.0.0.
  60  *       See also <http://developer.pidgin.im/ticket/14551>
  61  *
  62  * As a workaround an additional PURPLE_VERSION_CHECK(3,0,0) needs to be added.
  63  */
  64 #include "version.h"
  65
  66 #include "sipe-backend.h"
  67 #include "sipe-core.h"
  68 #include "sipe-nls.h"
  69
  70 #define _PurpleMessageFlags PurpleMessageFlags
  71 #include "purple-private.h"
  72
  73 /* Backward compatibility when compiling against 2.4.x API */
  74 #if !PURPLE_VERSION_CHECK(2,5,0) && !PURPLE_VERSION_CHECK(3,0,0)
  75 #define PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY 0x0100
  76 #endif
  77
  78 /* 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",
  97 };
  98
  99 GHashTable *purple_token_map;
 100
 101 static void sipe_purple_activity_init(void)
 102 {
 103         guint index;
 104
 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;
 108              index++) {
 109                 g_hash_table_insert(purple_token_map,
 110                                     (gchar *) activity_to_purple_map[index],
 111                                     GUINT_TO_POINTER(index));
 112         }
 113 }
 114
 115 static void sipe_purple_activity_shutdown(void)
 116 {
 117         g_hash_table_destroy(purple_token_map);
 118 }
 119
 120 const gchar *sipe_purple_activity_to_token(guint type)
 121 {
 122         return(activity_to_purple_map[type]);
 123 }
 124
 125 guint sipe_purple_token_to_activity(const gchar *token)
 126 {
 127         return(GPOINTER_TO_UINT(g_hash_table_lookup(purple_token_map, token)));
 128 }
 129
 130 gchar *sipe_backend_version(void)
 131 {
 132         return(g_strdup_printf("Purple/%s", purple_core_get_version()));
 133 }
 134
 135 /* PurplePluginProtocolInfo function calls & data structure */
 136 static const char *sipe_list_icon(SIPE_UNUSED_PARAMETER PurpleAccount *a,
 137                                   SIPE_UNUSED_PARAMETER PurpleBuddy *b)
 138 {
 139         return "sipe";
 140 }
 141
 142 static gchar *sipe_purple_status_text(PurpleBuddy *buddy)
 143 {
 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,
 146                                       buddy->name,
 147                                       sipe_purple_token_to_activity(purple_status_get_id(status)),
 148                                       purple_status_get_name(status));
 149 }
 150
 151 static void sipe_purple_tooltip_text(PurpleBuddy *buddy,
 152                                      PurpleNotifyUserInfo *user_info,
 153                                      SIPE_UNUSED_PARAMETER gboolean full)
 154 {
 155         const PurplePresence *presence = purple_buddy_get_presence(buddy);
 156         sipe_core_buddy_tooltip_info(PURPLE_BUDDY_TO_SIPE_CORE_PUBLIC,
 157                                      buddy->name,
 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);
 161 }
 162
 163 static GList *sipe_purple_status_types(SIPE_UNUSED_PARAMETER PurpleAccount *acc)
 164 {
 165         PurpleStatusType *type;
 166         GList *types = NULL;
 167
 168         /* Macros to reduce code repetition.
 169            Translators: noun */
 170 #define SIPE_ADD_STATUS(prim,id,name,user) type = purple_status_type_new_with_attrs( \
 171                 prim, id, name,             \
 172                 TRUE, user, FALSE,          \
 173                 SIPE_PURPLE_STATUS_ATTR_ID_MESSAGE, _("Message"), purple_value_new(PURPLE_TYPE_STRING), \
 174                 NULL);                      \
 175         types = g_list_append(types, type);
 176
 177         /* Online */
 178         SIPE_ADD_STATUS(PURPLE_STATUS_AVAILABLE,
 179                         NULL,
 180                         NULL,
 181                         TRUE);
 182
 183         /* Busy */
 184         SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
 185                         sipe_purple_activity_to_token(SIPE_ACTIVITY_BUSY),
 186                         sipe_core_activity_description(SIPE_ACTIVITY_BUSY),
 187                         TRUE);
 188
 189         /* Do Not Disturb */
 190         SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
 191                         sipe_purple_activity_to_token(SIPE_ACTIVITY_DND),
 192                         NULL,
 193                         TRUE);
 194
 195         /* Away */
 196         /* Goes first in the list as
 197          * purple picks the first status with the AWAY type
 198          * for idle.
 199          */
 200         SIPE_ADD_STATUS(PURPLE_STATUS_AWAY,
 201                         NULL,
 202                         NULL,
 203                         TRUE);
 204
 205         /* Be Right Back */
 206         SIPE_ADD_STATUS(PURPLE_STATUS_AWAY,
 207                         sipe_purple_activity_to_token(SIPE_ACTIVITY_BRB),
 208                         sipe_core_activity_description(SIPE_ACTIVITY_BRB),
 209                         TRUE);
 210
 211         /* Appear Offline */
 212         SIPE_ADD_STATUS(PURPLE_STATUS_INVISIBLE,
 213                         NULL,
 214                         NULL,
 215                         TRUE);
 216
 217         /* Offline */
 218         type = purple_status_type_new(PURPLE_STATUS_OFFLINE,
 219                                       NULL,
 220                                       NULL,
 221                                       TRUE);
 222         types = g_list_append(types, type);
 223
 224         return types;
 225 }
 226
 227 static GList *sipe_purple_blist_node_menu(PurpleBlistNode *node)
 228 {
 229         if(PURPLE_BLIST_NODE_IS_BUDDY(node)) {
 230                 return sipe_purple_buddy_menu((PurpleBuddy *) node);
 231         } else if(PURPLE_BLIST_NODE_IS_CHAT(node)) {
 232                 return sipe_purple_chat_menu((PurpleChat *)node);
 233         } else {
 234                 return NULL;
 235         }
 236 }
 237
 238 static void sipe_purple_login(PurpleAccount *account)
 239 {
 240         PurpleConnection *gc   = purple_account_get_connection(account);
 241         const gchar *username  = purple_account_get_username(account);
 242         const gchar *email     = purple_account_get_string(account, "email", NULL);
 243         const gchar *email_url = purple_account_get_string(account, "email_url", NULL);
 244         const gchar *transport = purple_account_get_string(account, "transport", "auto");
 245         const gchar *auth      = purple_account_get_string(account, "authentication", "ntlm");
 246         struct sipe_core_public *sipe_public;
 247         gchar **username_split;
 248         gchar *login_domain = NULL;
 249         gchar *login_account = NULL;
 250         const gchar *errmsg;
 251         guint type;
 252         struct sipe_backend_private *purple_private;
 253
 254         /* username format: <username>,[<optional login>] */
 255         SIPE_DEBUG_INFO("sipe_purple_login: username '%s'", username);
 256         username_split = g_strsplit(username, ",", 2);
 257
 258         /* login name specified? */
 259         if (username_split[1] && strlen(username_split[1])) {
 260                 /* Allowed domain-account separators are / or \ */
 261                 gchar **domain_user = g_strsplit_set(username_split[1], "/\\", 2);
 262                 gboolean has_domain = domain_user[1] != NULL;
 263                 SIPE_DEBUG_INFO("sipe_purple_login: login '%s'", username_split[1]);
 264                 login_domain  = has_domain ? g_strdup(domain_user[0]) : NULL;
 265                 login_account = g_strdup(domain_user[has_domain ? 1 : 0]);
 266                 SIPE_DEBUG_INFO("sipe_purple_login: auth domain '%s' user '%s'",
 267                                 login_domain ? login_domain : "",
 268                                 login_account);
 269                 g_strfreev(domain_user);
 270         }
 271
 272         sipe_public = sipe_core_allocate(username_split[0],
 273                                          login_domain, login_account,
 274                                          purple_connection_get_password(gc),
 275                                          email,
 276                                          email_url,
 277                                          &errmsg);
 278         g_free(login_domain);
 279         g_free(login_account);
 280         g_strfreev(username_split);
 281
 282         if (!sipe_public) {
 283 #if PURPLE_VERSION_CHECK(3,0,0)
 284                 purple_connection_error(
 285 #else
 286                 purple_connection_error_reason(
 287 #endif
 288                                                gc,
 289                                                PURPLE_CONNECTION_ERROR_INVALID_USERNAME,
 290                                                errmsg);
 291                 return;
 292         }
 293
 294         sipe_public->backend_private = purple_private = g_new0(struct sipe_backend_private, 1);
 295         purple_private->public = sipe_public;
 296         purple_private->gc = gc;
 297         purple_private->account = account;
 298
 299         sipe_purple_chat_setup_rejoin(purple_private);
 300
 301         /* map option list to flags - default is NTLM */
 302         SIPE_CORE_FLAG_UNSET(KRB5);
 303         SIPE_CORE_FLAG_UNSET(TLS_DSK);
 304 #if defined(HAVE_LIBKRB5) || defined(HAVE_SSPI)
 305         if (sipe_strequal(auth, "krb5")) {
 306                 SIPE_CORE_FLAG_SET(KRB5);
 307         } else
 308 #endif
 309 #ifndef HAVE_SSPI
 310         /*
 311          * @TODO: SSL handshake support isn't implemented in sip-sec-sspi.c.
 312          *        So ignore configuration setting for now.
 313          */
 314         if (sipe_strequal(auth, "tls-dsk")) {
 315                 SIPE_CORE_FLAG_SET(TLS_DSK);
 316         }
 317 #endif
 318
 319         /* @TODO: is this correct?
 320            "sso" is only available when Kerberos/SSPI support is compiled in */
 321         if (purple_account_get_bool(account, "sso", TRUE))
 322                 SIPE_CORE_FLAG_SET(SSO);
 323
 324         gc->proto_data = sipe_public;
 325         gc->flags |= PURPLE_CONNECTION_HTML | PURPLE_CONNECTION_FORMATTING_WBFO | PURPLE_CONNECTION_NO_BGCOLOR |
 326                 PURPLE_CONNECTION_NO_FONTSIZE | PURPLE_CONNECTION_NO_URLDESC | PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY;
 327         purple_connection_set_display_name(gc, sipe_public->sip_name);
 328         purple_connection_update_progress(gc, _("Connecting"), 1, 2);
 329
 330         username_split = g_strsplit(purple_account_get_string(account, "server", ""), ":", 2);
 331         if (sipe_strequal(transport, "auto")) {
 332                 type = (username_split[0] == NULL) ?
 333                         SIPE_TRANSPORT_AUTO : SIPE_TRANSPORT_TLS;
 334         } else if (sipe_strequal(transport, "tls")) {
 335                 type = SIPE_TRANSPORT_TLS;
 336         } else {
 337                 type = SIPE_TRANSPORT_TCP;
 338         }
 339         sipe_core_transport_sip_connect(sipe_public,
 340                                         type,
 341                                         username_split[0],
 342                                         username_split[0] ? username_split[1] : NULL);
 343         g_strfreev(username_split);
 344 }
 345
 346 static void sipe_purple_close(PurpleConnection *gc)
 347 {
 348         struct sipe_core_public *sipe_public = PURPLE_GC_TO_SIPE_CORE_PUBLIC;
 349
 350         if (sipe_public) {
 351                 struct sipe_backend_private *purple_private = sipe_public->backend_private;
 352
 353                 sipe_core_deallocate(sipe_public);
 354
 355                 if (purple_private->roomlist_map)
 356                         g_hash_table_destroy(purple_private->roomlist_map);
 357                 sipe_purple_chat_destroy_rejoin(purple_private);
 358                 g_free(purple_private);
 359                 gc->proto_data = NULL;
 360         }
 361 }
 362
 363 static int sipe_purple_send_im(PurpleConnection *gc,
 364                                const char *who,
 365                                const char *what,
 366                                SIPE_UNUSED_PARAMETER PurpleMessageFlags flags)
 367 {
 368         sipe_core_im_send(PURPLE_GC_TO_SIPE_CORE_PUBLIC, who, what);
 369         return 1;
 370 }
 371
 372 #define SIPE_TYPING_SEND_TIMEOUT 4
 373
 374 static unsigned int sipe_purple_send_typing(PurpleConnection *gc,
 375                                             const char *who,
 376                                             PurpleTypingState state)
 377 {
 378         if (state == PURPLE_NOT_TYPING)
 379                 return 0;
 380
 381         sipe_core_user_feedback_typing(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 382                                        who);
 383
 384         return SIPE_TYPING_SEND_TIMEOUT;
 385 }
 386
 387 static void sipe_purple_get_info(PurpleConnection *gc, const char *who)
 388 {
 389         sipe_core_buddy_get_info(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 390                                  who);
 391 }
 392
 393 static void sipe_purple_add_permit(PurpleConnection *gc, const char *name)
 394 {
 395         sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, TRUE);
 396 }
 397
 398 static void sipe_purple_add_deny(PurpleConnection *gc, const char *name)
 399 {
 400         sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, FALSE);
 401 }
 402
 403 static void sipe_purple_keep_alive(PurpleConnection *gc)
 404 {
 405         struct sipe_core_public *sipe_public = PURPLE_GC_TO_SIPE_CORE_PUBLIC;
 406         struct sipe_backend_private *purple_private = sipe_public->backend_private;
 407         time_t now = time(NULL);
 408
 409         if ((sipe_public->keepalive_timeout > 0) &&
 410             ((guint) (now - purple_private->last_keepalive) >= sipe_public->keepalive_timeout) &&
 411             ((guint) (now - gc->last_received) >= sipe_public->keepalive_timeout)
 412                 ) {
 413                 sipe_core_transport_sip_keepalive(sipe_public);
 414                 purple_private->last_keepalive = now;
 415         }
 416 }
 417
 418 static void sipe_purple_alias_buddy(PurpleConnection *gc, const char *name,
 419                                     SIPE_UNUSED_PARAMETER const char *alias)
 420 {
 421         sipe_core_group_set_user(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name);
 422 }
 423
 424 static void sipe_purple_group_rename(PurpleConnection *gc,
 425                                      const char *old_name,
 426                                      PurpleGroup *group,
 427                                      SIPE_UNUSED_PARAMETER GList *moved_buddies)
 428 {
 429         sipe_core_group_rename(PURPLE_GC_TO_SIPE_CORE_PUBLIC, old_name, group->name);
 430 }
 431
 432 static void sipe_purple_convo_closed(PurpleConnection *gc,
 433                                      const char *who)
 434 {
 435         sipe_core_im_close(PURPLE_GC_TO_SIPE_CORE_PUBLIC, who);
 436 }
 437
 438 static void sipe_purple_group_remove(PurpleConnection *gc, PurpleGroup *group)
 439 {
 440         sipe_core_group_remove(PURPLE_GC_TO_SIPE_CORE_PUBLIC, group->name);
 441 }
 442
 443 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
 444 static GHashTable *
 445 sipe_purple_get_account_text_table(SIPE_UNUSED_PARAMETER PurpleAccount *account)
 446 {
 447         GHashTable *table;
 448         table = g_hash_table_new(g_str_hash, g_str_equal);
 449         g_hash_table_insert(table, "login_label", (gpointer)_("user@company.com"));
 450         return table;
 451 }
 452
 453 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
 454 #ifdef HAVE_VV
 455
 456 static void
 457 sipe_purple_sigusr1_handler(SIPE_UNUSED_PARAMETER int signum)
 458 {
 459         capture_pipeline("PURPLE_SIPE_PIPELINE");
 460 }
 461
 462 static gboolean sipe_purple_initiate_media(PurpleAccount *account, const char *who,
 463                                            SIPE_UNUSED_PARAMETER PurpleMediaSessionType type)
 464 {
 465         sipe_core_media_initiate_call(PURPLE_ACCOUNT_TO_SIPE_CORE_PUBLIC,
 466                                       who,
 467                                       (type & PURPLE_MEDIA_VIDEO));
 468         return TRUE;
 469 }
 470
 471 static PurpleMediaCaps sipe_purple_get_media_caps(SIPE_UNUSED_PARAMETER PurpleAccount *account,
 472                                                   SIPE_UNUSED_PARAMETER const char *who)
 473 {
 474         return   PURPLE_MEDIA_CAPS_AUDIO
 475                | PURPLE_MEDIA_CAPS_AUDIO_VIDEO
 476                | PURPLE_MEDIA_CAPS_MODIFY_SESSION;
 477 }
 478 #endif
 479 #endif
 480 #endif
 481
 482 /*
 483  * Simplistic source upward compatibility path for newer libpurple APIs
 484  *
 485  * Usually we compile with -Werror=missing-field-initializers if GCC supports
 486  * it. But that means that the compilation of this structure can fail if the
 487  * newer API has added additional plugin callbacks. For the benefit of the
 488  * user we downgrade it to a warning here.
 489  *
 490  * Diagnostic #pragma was added in GCC 4.2.0
 491  * Diagnostic push/pop was added in GCC 4.6.0
 492  */
 493 #ifdef __GNUC__
 494 #if (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 2)
 495 #if __GNUC_MINOR__ >= 6
 496 #pragma GCC diagnostic push
 497 #endif
 498 #pragma GCC diagnostic warning "-Wmissing-field-initializers"
 499 #endif
 500 #endif
 501 static PurplePluginProtocolInfo sipe_prpl_info =
 502 {
 503 #if PURPLE_VERSION_CHECK(3,0,0)
 504         sizeof(PurplePluginProtocolInfo),       /* struct_size */
 505 #endif
 506         OPT_PROTO_CHAT_TOPIC,
 507         NULL,                                   /* user_splits */
 508         NULL,                                   /* protocol_options */
 509         NO_BUDDY_ICONS,                         /* icon_spec */
 510         sipe_list_icon,                         /* list_icon */
 511         NULL,                                   /* list_emblems */
 512         sipe_purple_status_text,                /* status_text */
 513         sipe_purple_tooltip_text,               /* tooltip_text */      // add custom info to contact tooltip
 514         sipe_purple_status_types,               /* away_states */
 515         sipe_purple_blist_node_menu,            /* blist_node_menu */
 516         sipe_purple_chat_info,                  /* chat_info */
 517         sipe_purple_chat_info_defaults,         /* chat_info_defaults */
 518         sipe_purple_login,                      /* login */
 519         sipe_purple_close,                      /* close */
 520         sipe_purple_send_im,                    /* send_im */
 521         NULL,                                   /* set_info */          // TODO maybe
 522         sipe_purple_send_typing,                /* send_typing */
 523         sipe_purple_get_info,                   /* get_info */
 524         sipe_purple_set_status,                 /* set_status */
 525         sipe_purple_set_idle,                   /* set_idle */
 526         NULL,                                   /* change_passwd */
 527         sipe_purple_add_buddy,                  /* add_buddy */
 528         NULL,                                   /* add_buddies */
 529         sipe_purple_remove_buddy,               /* remove_buddy */
 530         NULL,                                   /* remove_buddies */
 531         sipe_purple_add_permit,                 /* add_permit */
 532         sipe_purple_add_deny,                   /* add_deny */
 533         sipe_purple_add_deny,                   /* rem_permit */
 534         sipe_purple_add_permit,                 /* rem_deny */
 535         NULL,                                   /* set_permit_deny */
 536         sipe_purple_chat_join,                  /* join_chat */
 537         NULL,                                   /* reject_chat */
 538         NULL,                                   /* get_chat_name */
 539         sipe_purple_chat_invite,                /* chat_invite */
 540         sipe_purple_chat_leave,                 /* chat_leave */
 541         NULL,                                   /* chat_whisper */
 542         sipe_purple_chat_send,                  /* chat_send */
 543         sipe_purple_keep_alive,                 /* keepalive */
 544         NULL,                                   /* register_user */
 545         NULL,                                   /* get_cb_info */       // deprecated
 546 #if !PURPLE_VERSION_CHECK(3,0,0)
 547         NULL,                                   /* get_cb_away */       // deprecated
 548 #endif
 549         sipe_purple_alias_buddy,                /* alias_buddy */
 550         sipe_purple_group_buddy,                /* group_buddy */
 551         sipe_purple_group_rename,               /* rename_group */
 552         NULL,                                   /* buddy_free */
 553         sipe_purple_convo_closed,               /* convo_closed */
 554         purple_normalize_nocase,                /* normalize */
 555         NULL,                                   /* set_buddy_icon */
 556         sipe_purple_group_remove,               /* remove_group */
 557         NULL,                                   /* get_cb_real_name */  // TODO?
 558         NULL,                                   /* set_chat_topic */
 559         NULL,                                   /* find_blist_chat */
 560         sipe_purple_roomlist_get_list,          /* roomlist_get_list */
 561         sipe_purple_roomlist_cancel,            /* roomlist_cancel */
 562         NULL,                                   /* roomlist_expand_category */
 563         NULL,                                   /* can_receive_file */
 564         sipe_purple_ft_send_file,               /* send_file */
 565         sipe_purple_ft_new_xfer,                /* new_xfer */
 566         NULL,                                   /* offline_message */
 567         NULL,                                   /* whiteboard_prpl_ops */
 568         NULL,                                   /* send_raw */
 569         NULL,                                   /* roomlist_room_serialize */
 570         NULL,                                   /* unregister_user */
 571         NULL,                                   /* send_attention */
 572         NULL,                                   /* get_attention_types */
 573 #if !PURPLE_VERSION_CHECK(2,5,0) && !PURPLE_VERSION_CHECK(3,0,0)
 574         /* Backward compatibility when compiling against 2.4.x API */
 575         (void (*)(void))                        /* _purple_reserved4 */
 576 #endif
 577 #if !PURPLE_VERSION_CHECK(3,0,0)
 578         sizeof(PurplePluginProtocolInfo),       /* struct_size */
 579 #endif
 580 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
 581         sipe_purple_get_account_text_table,     /* get_account_text_table */
 582 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
 583 #ifdef HAVE_VV
 584         sipe_purple_initiate_media,             /* initiate_media */
 585         sipe_purple_get_media_caps,             /* get_media_caps */
 586 #else
 587         NULL,                                   /* initiate_media */
 588         NULL,                                   /* get_media_caps */
 589 #endif
 590 #if PURPLE_VERSION_CHECK(2,7,0) || PURPLE_VERSION_CHECK(3,0,0)
 591         NULL,                                   /* get_moods */
 592         NULL,                                   /* set_public_alias */
 593         NULL,                                   /* get_public_alias */
 594 #if PURPLE_VERSION_CHECK(2,8,0)
 595         NULL,                                   /* add_buddy_with_invite */
 596         NULL,                                   /* add_buddies_with_invite */
 597 #endif
 598 #endif
 599 #endif
 600 #endif
 601 };
 602 #ifdef __GNUC__
 603 #if (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 6)
 604 #pragma GCC diagnostic pop
 605 #endif
 606 #endif
 607 /* Original GCC error checking restored from here on... (see above) */
 608
 609 /* PurplePluginInfo function calls & data structure */
 610 static gboolean sipe_purple_plugin_load(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
 611 {
 612 #ifdef HAVE_VV
 613         struct sigaction action;
 614         memset(&action, 0, sizeof (action));
 615         action.sa_handler = sipe_purple_sigusr1_handler;
 616         sigaction(SIGUSR1, &action, NULL);
 617 #endif
 618         return TRUE;
 619 }
 620
 621 static gboolean sipe_purple_plugin_unload(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
 622 {
 623 #ifdef HAVE_VV
 624         struct sigaction action;
 625         memset(&action, 0, sizeof (action));
 626         action.sa_handler = SIG_DFL;
 627         sigaction(SIGUSR1, &action, NULL);
 628 #endif
 629         return TRUE;
 630 }
 631
 632 static void sipe_purple_plugin_destroy(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
 633 {
 634         GList *entry;
 635
 636         sipe_purple_activity_shutdown();
 637         sipe_core_destroy();
 638
 639         entry = sipe_prpl_info.protocol_options;
 640         while (entry) {
 641                 purple_account_option_destroy(entry->data);
 642                 entry = g_list_delete_link(entry, entry);
 643         }
 644         sipe_prpl_info.protocol_options = NULL;
 645
 646         entry = sipe_prpl_info.user_splits;
 647         while (entry) {
 648                 purple_account_user_split_destroy(entry->data);
 649                 entry = g_list_delete_link(entry, entry);
 650         }
 651         sipe_prpl_info.user_splits = NULL;
 652 }
 653
 654 static void sipe_purple_show_about_plugin(PurplePluginAction *action)
 655 {
 656         gchar *tmp = sipe_core_about();
 657         purple_notify_formatted((PurpleConnection *) action->context,
 658                                 NULL, " ", NULL, tmp, NULL, NULL);
 659         g_free(tmp);
 660 }
 661
 662 static void sipe_purple_find_contact_cb(PurpleConnection *gc,
 663                                         PurpleRequestFields *fields)
 664 {
 665         GList *entries = purple_request_field_group_get_fields(purple_request_fields_get_groups(fields)->data);
 666         const gchar *given_name = NULL;
 667         const gchar *surname    = NULL;
 668         const gchar *email      = NULL;
 669         const gchar *company    = NULL;
 670         const gchar *country    = NULL;
 671
 672         while (entries) {
 673                 PurpleRequestField *field = entries->data;
 674                 const char *id = purple_request_field_get_id(field);
 675                 const char *value = purple_request_field_string_get_value(field);
 676
 677                 SIPE_DEBUG_INFO("sipe_purple_find_contact_cb: %s = '%s'", id, value ? value : "");
 678
 679                 if (value) {
 680                         if (strcmp(id, "given") == 0) {
 681                                 given_name = value;
 682                         } else if (strcmp(id, "surname") == 0) {
 683                                 surname = value;
 684                         } else if (strcmp(id, "email") == 0) {
 685                                 email = value;
 686                         } else if (strcmp(id, "company") == 0) {
 687                                 company = value;
 688                         } else if (strcmp(id, "country") == 0) {
 689                                 country = value;
 690                         }
 691                 }
 692
 693                 entries = g_list_next(entries);
 694         };
 695
 696         sipe_core_buddy_search(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 697                                given_name,
 698                                surname,
 699                                email,
 700                                company,
 701                                country);
 702 }
 703
 704 static void sipe_purple_show_find_contact(PurplePluginAction *action)
 705 {
 706         PurpleConnection *gc = (PurpleConnection *) action->context;
 707         PurpleRequestFields *fields;
 708         PurpleRequestFieldGroup *group;
 709         PurpleRequestField *field;
 710
 711         fields = purple_request_fields_new();
 712         group = purple_request_field_group_new(NULL);
 713         purple_request_fields_add_group(fields, group);
 714
 715         field = purple_request_field_string_new("given", _("First name"), NULL, FALSE);
 716         purple_request_field_group_add_field(group, field);
 717         field = purple_request_field_string_new("surname", _("Last name"), NULL, FALSE);
 718         purple_request_field_group_add_field(group, field);
 719         field = purple_request_field_string_new("email", _("Email"), NULL, FALSE);
 720         purple_request_field_group_add_field(group, field);
 721         field = purple_request_field_string_new("company", _("Company"), NULL, FALSE);
 722         purple_request_field_group_add_field(group, field);
 723         field = purple_request_field_string_new("country", _("Country"), NULL, FALSE);
 724         purple_request_field_group_add_field(group, field);
 725
 726         purple_request_fields(gc,
 727                 _("Search"),
 728                 _("Search for a contact"),
 729                 _("Enter the information for the person you wish to find. Empty fields will be ignored."),
 730                 fields,
 731                 _("_Search"), G_CALLBACK(sipe_purple_find_contact_cb),
 732                 _("_Cancel"), NULL,
 733                 purple_connection_get_account(gc), NULL, NULL, gc);
 734 }
 735
 736 static void sipe_purple_join_conference_cb(PurpleConnection *gc,
 737                                            PurpleRequestFields *fields)
 738 {
 739         GList *entries = purple_request_field_group_get_fields(purple_request_fields_get_groups(fields)->data);
 740
 741         if (entries) {
 742                 PurpleRequestField *field = entries->data;
 743                 const char *id = purple_request_field_get_id(field);
 744                 const char *value = purple_request_field_string_get_value(field);
 745
 746                 if (!sipe_strequal(id, "meetingLocation"))
 747                         return;
 748
 749                 sipe_core_conf_create(PURPLE_GC_TO_SIPE_CORE_PUBLIC, value);
 750         }
 751 }
 752
 753 #ifdef HAVE_VV
 754 static void sipe_purple_test_call(PurplePluginAction *action)
 755 {
 756         PurpleConnection *gc = (PurpleConnection *) action->context;
 757         sipe_core_media_test_call(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
 758 }
 759 #endif
 760
 761 static void sipe_purple_show_join_conference(PurplePluginAction *action)
 762 {
 763         PurpleConnection *gc = (PurpleConnection *) action->context;
 764         PurpleRequestFields *fields;
 765         PurpleRequestFieldGroup *group;
 766         PurpleRequestField *field;
 767
 768         fields = purple_request_fields_new();
 769         group = purple_request_field_group_new(NULL);
 770         purple_request_fields_add_group(fields, group);
 771
 772         field = purple_request_field_string_new("meetingLocation", _("Meeting location"), NULL, FALSE);
 773         purple_request_field_group_add_field(group, field);
 774
 775         purple_request_fields(gc,
 776                 _("Join conference"),
 777                 _("Join scheduled conference"),
 778                 _("Enter meeting location string you received in the invitation.\n"
 779                   "\n"
 780                   "Valid location will be something like\n"
 781                   "meet:sip:someone@company.com;gruu;opaque=app:conf:focus:id:abcdef1234"),
 782                 fields,
 783                 _("_Join"), G_CALLBACK(sipe_purple_join_conference_cb),
 784                 _("_Cancel"), NULL,
 785                 purple_connection_get_account(gc), NULL, NULL, gc);
 786 }
 787
 788 static void sipe_purple_republish_calendar(PurplePluginAction *action)
 789 {
 790         PurpleConnection *gc = (PurpleConnection *) action->context;
 791         sipe_core_update_calendar(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
 792 }
 793
 794 static void sipe_purple_reset_status(PurplePluginAction *action)
 795 {
 796         PurpleConnection *gc = (PurpleConnection *) action->context;
 797         sipe_core_reset_status(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
 798 }
 799
 800 static GList *sipe_purple_actions(SIPE_UNUSED_PARAMETER PurplePlugin *plugin,
 801                                   SIPE_UNUSED_PARAMETER gpointer context)
 802 {
 803         GList *menu = NULL;
 804         PurplePluginAction *act;
 805
 806         act = purple_plugin_action_new(_("About SIPE plugin..."), sipe_purple_show_about_plugin);
 807         menu = g_list_prepend(menu, act);
 808
 809         act = purple_plugin_action_new(_("Contact search..."), sipe_purple_show_find_contact);
 810         menu = g_list_prepend(menu, act);
 811
 812 #ifdef HAVE_VV
 813         act = purple_plugin_action_new(_("Test call"), sipe_purple_test_call);
 814         menu = g_list_prepend(menu, act);
 815 #endif
 816
 817         act = purple_plugin_action_new(_("Join scheduled conference..."), sipe_purple_show_join_conference);
 818         menu = g_list_prepend(menu, act);
 819
 820         act = purple_plugin_action_new(_("Republish Calendar"), sipe_purple_republish_calendar);
 821         menu = g_list_prepend(menu, act);
 822
 823         act = purple_plugin_action_new(_("Reset status"), sipe_purple_reset_status);
 824         menu = g_list_prepend(menu, act);
 825
 826         return g_list_reverse(menu);
 827 }
 828
 829 static PurplePluginInfo sipe_purple_info = {
 830         PURPLE_PLUGIN_MAGIC,
 831         PURPLE_MAJOR_VERSION,
 832         PURPLE_MINOR_VERSION,
 833         PURPLE_PLUGIN_PROTOCOL,                           /**< type           */
 834         NULL,                                             /**< ui_requirement */
 835         0,                                                /**< flags          */
 836         NULL,                                             /**< dependencies   */
 837         PURPLE_PRIORITY_DEFAULT,                          /**< priority       */
 838         "prpl-sipe",                                      /**< id             */
 839         "Office Communicator",                            /**< name           */
 840         PACKAGE_VERSION,                                  /**< version        */
 841         "Microsoft Office Communicator Protocol Plugin",  /**< summary        */
 842         "A plugin for the extended SIP/SIMPLE protocol used by "          /**< description */
 843         "Microsoft Live/Office Communications Server (LCS2005/OCS2007+)", /**< description */
 844         "Anibal Avelar <avelar@gmail.com>, "              /**< author         */
 845         "Gabriel Burt <gburt@novell.com>, "               /**< author         */
 846         "Stefan Becker <stefan.becker@nokia.com>, "       /**< author         */
 847         "pier11 <pier11@operamail.com>",                  /**< author         */
 848         PACKAGE_URL,                                      /**< homepage       */
 849         sipe_purple_plugin_load,                          /**< load           */
 850         sipe_purple_plugin_unload,                        /**< unload         */
 851         sipe_purple_plugin_destroy,                       /**< destroy        */
 852         NULL,                                             /**< ui_info        */
 853         &sipe_prpl_info,                                  /**< extra_info     */
 854         NULL,
 855         sipe_purple_actions,
 856         NULL,
 857         NULL,
 858         NULL,
 859         NULL
 860 };
 861
 862 static void sipe_purple_init_plugin(PurplePlugin *plugin)
 863 {
 864         PurpleAccountUserSplit *split;
 865         PurpleAccountOption *option;
 866
 867         /* This needs to be called first */
 868         sipe_core_init(LOCALEDIR);
 869         sipe_purple_activity_init();
 870
 871         purple_plugin_register(plugin);
 872
 873         /**
 874          * When adding new string settings please make sure to keep these
 875          * in sync:
 876          *
 877          *     api/sipe-backend.h
 878          *     purple-settings.c:setting_name[]
 879          */
 880         split = purple_account_user_split_new(_("Login\n   user  or  DOMAIN\\user  or\n   user@company.com"), NULL, ',');
 881         purple_account_user_split_set_reverse(split, FALSE);
 882         sipe_prpl_info.user_splits = g_list_append(sipe_prpl_info.user_splits, split);
 883
 884         option = purple_account_option_string_new(_("Server[:Port]\n(leave empty for auto-discovery)"), "server", "");
 885         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 886
 887         option = purple_account_option_list_new(_("Connection type"), "transport", NULL);
 888         purple_account_option_add_list_item(option, _("Auto"), "auto");
 889         purple_account_option_add_list_item(option, _("SSL/TLS"), "tls");
 890         purple_account_option_add_list_item(option, _("TCP"), "tcp");
 891         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 892
 893         /*option = purple_account_option_bool_new(_("Publish status (note: everyone may watch you)"), "doservice", TRUE);
 894         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);*/
 895
 896         option = purple_account_option_string_new(_("User Agent"), "useragent", "");
 897         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 898
 899         option = purple_account_option_list_new(_("Authentication scheme"), "authentication", NULL);
 900         purple_account_option_add_list_item(option, _("NTLM"), "ntlm");
 901 #if defined(HAVE_LIBKRB5) || defined(HAVE_SSPI)
 902         purple_account_option_add_list_item(option, _("Kerberos"), "krb5");
 903 #endif
 904 #ifndef HAVE_SSPI
 905         /* see above */
 906         purple_account_option_add_list_item(option, _("TLS-DSK"), "tls-dsk");
 907 #endif
 908         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 909
 910 #if defined(HAVE_LIBKRB5) || defined(HAVE_SSPI)
 911         /* Suitable for sspi/NTLM, sspi/Kerberos and krb5 security mechanisms
 912          * No login/password is taken into account if this option present,
 913          * instead used default credentials stored in OS.
 914          */
 915         option = purple_account_option_bool_new(_("Use Single Sign-On"), "sso", TRUE);
 916         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 917 #endif
 918
 919         /** Example (Exchange): https://server.company.com/EWS/Exchange.asmx
 920          *  Example (Domino)  : https://[domino_server]/[mail_database_name].nsf
 921          */
 922         option = purple_account_option_string_new(_("Email services URL\n(leave empty for auto-discovery)"), "email_url", "");
 923         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 924
 925         option = purple_account_option_string_new(_("Email address\n(if different from Username)"), "email", "");
 926         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 927
 928         /** Example (Exchange): DOMAIN\user  or  user@company.com
 929          *  Example (Domino)  : email_address
 930          */
 931         option = purple_account_option_string_new(_("Email login\n(if different from Login)"), "email_login", "");
 932         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 933
 934         option = purple_account_option_string_new(_("Email password\n(if different from Password)"), "email_password", "");
 935         purple_account_option_set_masked(option, TRUE);
 936         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 937
 938         /** Example (federated domain): company.com      (i.e. ocschat@company.com)
 939          *  Example (non-default user): user@company.com
 940          */
 941         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", "");
 942         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 943 }
 944
 945 /* This macro makes the code a purple plugin */
 946 PURPLE_INIT_PLUGIN(sipe, sipe_purple_init_plugin, sipe_purple_info);
 947
 948 /*
 949   Local Variables:
 950   mode: c
 951   c-file-style: "bsd"
 952   indent-tabs-mode: t
 953   tab-width: 8
 954   End:
 955 */