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         /* In a call */
 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),
 199                         FALSE);
 200
 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),
 205                         FALSE);
 206
 207         /* Away */
 208         /* Goes first in the list as
 209          * purple picks the first status with the AWAY type
 210          * for idle.
 211          */
 212         SIPE_ADD_STATUS(PURPLE_STATUS_AWAY,
 213                         NULL,
 214                         NULL,
 215                         TRUE);
 216
 217         /* Be Right Back */
 218         SIPE_ADD_STATUS(PURPLE_STATUS_AWAY,
 219                         sipe_purple_activity_to_token(SIPE_ACTIVITY_BRB),
 220                         sipe_core_activity_description(SIPE_ACTIVITY_BRB),
 221                         TRUE);
 222
 223         /* Appear Offline */
 224         SIPE_ADD_STATUS(PURPLE_STATUS_INVISIBLE,
 225                         NULL,
 226                         NULL,
 227                         TRUE);
 228
 229         /* Offline */
 230         type = purple_status_type_new(PURPLE_STATUS_OFFLINE,
 231                                       NULL,
 232                                       NULL,
 233                                       TRUE);
 234         types = g_list_append(types, type);
 235
 236         return types;
 237 }
 238
 239 static GList *sipe_purple_blist_node_menu(PurpleBlistNode *node)
 240 {
 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);
 245         } else {
 246                 return NULL;
 247         }
 248 }
 249
 250 static void sipe_purple_login(PurpleAccount *account)
 251 {
 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;
 262         const gchar *errmsg;
 263         guint type;
 264         struct sipe_backend_private *purple_private;
 265
 266         /* username format: <username>,[<optional login>] */
 267         SIPE_DEBUG_INFO("sipe_purple_login: username '%s'", username);
 268         username_split = g_strsplit(username, ",", 2);
 269
 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 : "",
 280                                 login_account);
 281                 g_strfreev(domain_user);
 282         }
 283
 284         sipe_public = sipe_core_allocate(username_split[0],
 285                                          login_domain, login_account,
 286                                          purple_connection_get_password(gc),
 287                                          email,
 288                                          email_url,
 289                                          &errmsg);
 290         g_free(login_domain);
 291         g_free(login_account);
 292         g_strfreev(username_split);
 293
 294         if (!sipe_public) {
 295 #if PURPLE_VERSION_CHECK(3,0,0)
 296                 purple_connection_error(
 297 #else
 298                 purple_connection_error_reason(
 299 #endif
 300                                                gc,
 301                                                PURPLE_CONNECTION_ERROR_INVALID_USERNAME,
 302                                                errmsg);
 303                 return;
 304         }
 305
 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;
 310
 311         sipe_purple_chat_setup_rejoin(purple_private);
 312
 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);
 320         } else
 321 #endif
 322 #ifndef HAVE_SSPI
 323         /*
 324          * @TODO: SSL handshake support isn't implemented in sip-sec-sspi.c.
 325          *        So ignore configuration setting for now.
 326          */
 327         if (sipe_strequal(auth, "tls-dsk")) {
 328                 SIPE_CORE_FLAG_SET(TLS_DSK);
 329         }
 330 #endif
 331
 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);
 336
 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);
 342
 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;
 349         } else {
 350                 type = SIPE_TRANSPORT_TCP;
 351         }
 352         sipe_core_transport_sip_connect(sipe_public,
 353                                         type,
 354                                         username_split[0],
 355                                         username_split[0] ? username_split[1] : NULL);
 356         g_strfreev(username_split);
 357 }
 358
 359 static void sipe_purple_close(PurpleConnection *gc)
 360 {
 361         struct sipe_core_public *sipe_public = PURPLE_GC_TO_SIPE_CORE_PUBLIC;
 362
 363         if (sipe_public) {
 364                 struct sipe_backend_private *purple_private = sipe_public->backend_private;
 365
 366                 sipe_core_deallocate(sipe_public);
 367
 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;
 373         }
 374 }
 375
 376 static int sipe_purple_send_im(PurpleConnection *gc,
 377                                const char *who,
 378                                const char *what,
 379                                SIPE_UNUSED_PARAMETER PurpleMessageFlags flags)
 380 {
 381         sipe_core_im_send(PURPLE_GC_TO_SIPE_CORE_PUBLIC, who, what);
 382         return 1;
 383 }
 384
 385 #define SIPE_TYPING_SEND_TIMEOUT 4
 386
 387 static unsigned int sipe_purple_send_typing(PurpleConnection *gc,
 388                                             const char *who,
 389                                             PurpleTypingState state)
 390 {
 391         if (state == PURPLE_NOT_TYPING)
 392                 return 0;
 393
 394         sipe_core_user_feedback_typing(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 395                                        who);
 396
 397         return SIPE_TYPING_SEND_TIMEOUT;
 398 }
 399
 400 static void sipe_purple_get_info(PurpleConnection *gc, const char *who)
 401 {
 402         sipe_core_buddy_get_info(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 403                                  who);
 404 }
 405
 406 static void sipe_purple_add_permit(PurpleConnection *gc, const char *name)
 407 {
 408         sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, TRUE);
 409 }
 410
 411 static void sipe_purple_add_deny(PurpleConnection *gc, const char *name)
 412 {
 413         sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, FALSE);
 414 }
 415
 416 static void sipe_purple_keep_alive(PurpleConnection *gc)
 417 {
 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);
 421
 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)
 425                 ) {
 426                 sipe_core_transport_sip_keepalive(sipe_public);
 427                 purple_private->last_keepalive = now;
 428         }
 429 }
 430
 431 static void sipe_purple_alias_buddy(PurpleConnection *gc, const char *name,
 432                                     SIPE_UNUSED_PARAMETER const char *alias)
 433 {
 434         sipe_core_group_set_user(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name);
 435 }
 436
 437 static void sipe_purple_group_rename(PurpleConnection *gc,
 438                                      const char *old_name,
 439                                      PurpleGroup *group,
 440                                      SIPE_UNUSED_PARAMETER GList *moved_buddies)
 441 {
 442         sipe_core_group_rename(PURPLE_GC_TO_SIPE_CORE_PUBLIC, old_name, group->name);
 443 }
 444
 445 static void sipe_purple_convo_closed(PurpleConnection *gc,
 446                                      const char *who)
 447 {
 448         sipe_core_im_close(PURPLE_GC_TO_SIPE_CORE_PUBLIC, who);
 449 }
 450
 451 static void sipe_purple_group_remove(PurpleConnection *gc, PurpleGroup *group)
 452 {
 453         sipe_core_group_remove(PURPLE_GC_TO_SIPE_CORE_PUBLIC, group->name);
 454 }
 455
 456 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
 457 static GHashTable *
 458 sipe_purple_get_account_text_table(SIPE_UNUSED_PARAMETER PurpleAccount *account)
 459 {
 460         GHashTable *table;
 461         table = g_hash_table_new(g_str_hash, g_str_equal);
 462         g_hash_table_insert(table, "login_label", (gpointer)_("user@company.com"));
 463         return table;
 464 }
 465
 466 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
 467 #ifdef HAVE_VV
 468
 469 static void
 470 sipe_purple_sigusr1_handler(SIPE_UNUSED_PARAMETER int signum)
 471 {
 472         capture_pipeline("PURPLE_SIPE_PIPELINE");
 473 }
 474
 475 static gboolean sipe_purple_initiate_media(PurpleAccount *account, const char *who,
 476                                            SIPE_UNUSED_PARAMETER PurpleMediaSessionType type)
 477 {
 478         sipe_core_media_initiate_call(PURPLE_ACCOUNT_TO_SIPE_CORE_PUBLIC,
 479                                       who,
 480                                       (type & PURPLE_MEDIA_VIDEO));
 481         return TRUE;
 482 }
 483
 484 static PurpleMediaCaps sipe_purple_get_media_caps(SIPE_UNUSED_PARAMETER PurpleAccount *account,
 485                                                   SIPE_UNUSED_PARAMETER const char *who)
 486 {
 487         return   PURPLE_MEDIA_CAPS_AUDIO
 488                | PURPLE_MEDIA_CAPS_AUDIO_VIDEO
 489                | PURPLE_MEDIA_CAPS_MODIFY_SESSION;
 490 }
 491 #endif
 492 #endif
 493 #endif
 494
 495 /*
 496  * Simplistic source upward compatibility path for newer libpurple APIs
 497  *
 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.
 502  *
 503  * Diagnostic #pragma was added in GCC 4.2.0
 504  * Diagnostic push/pop was added in GCC 4.6.0
 505  */
 506 #ifdef __GNUC__
 507 #if (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 2)
 508 #if __GNUC_MINOR__ >= 6
 509 #pragma GCC diagnostic push
 510 #endif
 511 #pragma GCC diagnostic warning "-Wmissing-field-initializers"
 512 #endif
 513 #endif
 514 static PurplePluginProtocolInfo sipe_prpl_info =
 515 {
 516 #if PURPLE_VERSION_CHECK(3,0,0)
 517         sizeof(PurplePluginProtocolInfo),       /* struct_size */
 518 #endif
 519         OPT_PROTO_CHAT_TOPIC,
 520         NULL,                                   /* user_splits */
 521         NULL,                                   /* protocol_options */
 522         NO_BUDDY_ICONS,                         /* icon_spec */
 523         sipe_list_icon,                         /* list_icon */
 524         NULL,                                   /* list_emblems */
 525         sipe_purple_status_text,                /* status_text */
 526         sipe_purple_tooltip_text,               /* tooltip_text */      // add custom info to contact tooltip
 527         sipe_purple_status_types,               /* away_states */
 528         sipe_purple_blist_node_menu,            /* blist_node_menu */
 529         sipe_purple_chat_info,                  /* chat_info */
 530         sipe_purple_chat_info_defaults,         /* chat_info_defaults */
 531         sipe_purple_login,                      /* login */
 532         sipe_purple_close,                      /* close */
 533         sipe_purple_send_im,                    /* send_im */
 534         NULL,                                   /* set_info */          // TODO maybe
 535         sipe_purple_send_typing,                /* send_typing */
 536         sipe_purple_get_info,                   /* get_info */
 537         sipe_purple_set_status,                 /* set_status */
 538         sipe_purple_set_idle,                   /* set_idle */
 539         NULL,                                   /* change_passwd */
 540         sipe_purple_add_buddy,                  /* add_buddy */
 541         NULL,                                   /* add_buddies */
 542         sipe_purple_remove_buddy,               /* remove_buddy */
 543         NULL,                                   /* remove_buddies */
 544         sipe_purple_add_permit,                 /* add_permit */
 545         sipe_purple_add_deny,                   /* add_deny */
 546         sipe_purple_add_deny,                   /* rem_permit */
 547         sipe_purple_add_permit,                 /* rem_deny */
 548         NULL,                                   /* set_permit_deny */
 549         sipe_purple_chat_join,                  /* join_chat */
 550         NULL,                                   /* reject_chat */
 551         NULL,                                   /* get_chat_name */
 552         sipe_purple_chat_invite,                /* chat_invite */
 553         sipe_purple_chat_leave,                 /* chat_leave */
 554         NULL,                                   /* chat_whisper */
 555         sipe_purple_chat_send,                  /* chat_send */
 556         sipe_purple_keep_alive,                 /* keepalive */
 557         NULL,                                   /* register_user */
 558         NULL,                                   /* get_cb_info */       // deprecated
 559 #if !PURPLE_VERSION_CHECK(3,0,0)
 560         NULL,                                   /* get_cb_away */       // deprecated
 561 #endif
 562         sipe_purple_alias_buddy,                /* alias_buddy */
 563         sipe_purple_group_buddy,                /* group_buddy */
 564         sipe_purple_group_rename,               /* rename_group */
 565         NULL,                                   /* buddy_free */
 566         sipe_purple_convo_closed,               /* convo_closed */
 567         purple_normalize_nocase,                /* normalize */
 568         NULL,                                   /* set_buddy_icon */
 569         sipe_purple_group_remove,               /* remove_group */
 570         NULL,                                   /* get_cb_real_name */  // TODO?
 571         NULL,                                   /* set_chat_topic */
 572         NULL,                                   /* find_blist_chat */
 573         sipe_purple_roomlist_get_list,          /* roomlist_get_list */
 574         sipe_purple_roomlist_cancel,            /* roomlist_cancel */
 575         NULL,                                   /* roomlist_expand_category */
 576         NULL,                                   /* can_receive_file */
 577         sipe_purple_ft_send_file,               /* send_file */
 578         sipe_purple_ft_new_xfer,                /* new_xfer */
 579         NULL,                                   /* offline_message */
 580         NULL,                                   /* whiteboard_prpl_ops */
 581         NULL,                                   /* send_raw */
 582         NULL,                                   /* roomlist_room_serialize */
 583         NULL,                                   /* unregister_user */
 584         NULL,                                   /* send_attention */
 585         NULL,                                   /* get_attention_types */
 586 #if !PURPLE_VERSION_CHECK(2,5,0) && !PURPLE_VERSION_CHECK(3,0,0)
 587         /* Backward compatibility when compiling against 2.4.x API */
 588         (void (*)(void))                        /* _purple_reserved4 */
 589 #endif
 590 #if !PURPLE_VERSION_CHECK(3,0,0)
 591         sizeof(PurplePluginProtocolInfo),       /* struct_size */
 592 #endif
 593 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
 594         sipe_purple_get_account_text_table,     /* get_account_text_table */
 595 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
 596 #ifdef HAVE_VV
 597         sipe_purple_initiate_media,             /* initiate_media */
 598         sipe_purple_get_media_caps,             /* get_media_caps */
 599 #else
 600         NULL,                                   /* initiate_media */
 601         NULL,                                   /* get_media_caps */
 602 #endif
 603 #if PURPLE_VERSION_CHECK(2,7,0) || PURPLE_VERSION_CHECK(3,0,0)
 604         NULL,                                   /* get_moods */
 605         NULL,                                   /* set_public_alias */
 606         NULL,                                   /* get_public_alias */
 607 #if PURPLE_VERSION_CHECK(2,8,0)
 608         NULL,                                   /* add_buddy_with_invite */
 609         NULL,                                   /* add_buddies_with_invite */
 610 #endif
 611 #endif
 612 #endif
 613 #endif
 614 };
 615 #ifdef __GNUC__
 616 #if (__GNUC__ >= 4) && (__GNUC_MINOR__ >= 6)
 617 #pragma GCC diagnostic pop
 618 #endif
 619 #endif
 620 /* Original GCC error checking restored from here on... (see above) */
 621
 622 /* PurplePluginInfo function calls & data structure */
 623 static gboolean sipe_purple_plugin_load(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
 624 {
 625 #ifdef HAVE_VV
 626         struct sigaction action;
 627         memset(&action, 0, sizeof (action));
 628         action.sa_handler = sipe_purple_sigusr1_handler;
 629         sigaction(SIGUSR1, &action, NULL);
 630 #endif
 631         return TRUE;
 632 }
 633
 634 static gboolean sipe_purple_plugin_unload(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
 635 {
 636 #ifdef HAVE_VV
 637         struct sigaction action;
 638         memset(&action, 0, sizeof (action));
 639         action.sa_handler = SIG_DFL;
 640         sigaction(SIGUSR1, &action, NULL);
 641 #endif
 642         return TRUE;
 643 }
 644
 645 static void sipe_purple_plugin_destroy(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
 646 {
 647         GList *entry;
 648
 649         sipe_purple_activity_shutdown();
 650         sipe_core_destroy();
 651
 652         entry = sipe_prpl_info.protocol_options;
 653         while (entry) {
 654                 purple_account_option_destroy(entry->data);
 655                 entry = g_list_delete_link(entry, entry);
 656         }
 657         sipe_prpl_info.protocol_options = NULL;
 658
 659         entry = sipe_prpl_info.user_splits;
 660         while (entry) {
 661                 purple_account_user_split_destroy(entry->data);
 662                 entry = g_list_delete_link(entry, entry);
 663         }
 664         sipe_prpl_info.user_splits = NULL;
 665 }
 666
 667 static void sipe_purple_show_about_plugin(PurplePluginAction *action)
 668 {
 669         gchar *tmp = sipe_core_about();
 670         purple_notify_formatted((PurpleConnection *) action->context,
 671                                 NULL, " ", NULL, tmp, NULL, NULL);
 672         g_free(tmp);
 673 }
 674
 675 static void sipe_purple_find_contact_cb(PurpleConnection *gc,
 676                                         PurpleRequestFields *fields)
 677 {
 678         GList *entries = purple_request_field_group_get_fields(purple_request_fields_get_groups(fields)->data);
 679         const gchar *given_name = NULL;
 680         const gchar *surname    = NULL;
 681         const gchar *email      = NULL;
 682         const gchar *company    = NULL;
 683         const gchar *country    = NULL;
 684
 685         while (entries) {
 686                 PurpleRequestField *field = entries->data;
 687                 const char *id = purple_request_field_get_id(field);
 688                 const char *value = purple_request_field_string_get_value(field);
 689
 690                 SIPE_DEBUG_INFO("sipe_purple_find_contact_cb: %s = '%s'", id, value ? value : "");
 691
 692                 if (value) {
 693                         if (strcmp(id, "given") == 0) {
 694                                 given_name = value;
 695                         } else if (strcmp(id, "surname") == 0) {
 696                                 surname = value;
 697                         } else if (strcmp(id, "email") == 0) {
 698                                 email = value;
 699                         } else if (strcmp(id, "company") == 0) {
 700                                 company = value;
 701                         } else if (strcmp(id, "country") == 0) {
 702                                 country = value;
 703                         }
 704                 }
 705
 706                 entries = g_list_next(entries);
 707         };
 708
 709         sipe_core_buddy_search(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 710                                given_name,
 711                                surname,
 712                                email,
 713                                company,
 714                                country);
 715 }
 716
 717 static void sipe_purple_show_find_contact(PurplePluginAction *action)
 718 {
 719         PurpleConnection *gc = (PurpleConnection *) action->context;
 720         PurpleRequestFields *fields;
 721         PurpleRequestFieldGroup *group;
 722         PurpleRequestField *field;
 723
 724         fields = purple_request_fields_new();
 725         group = purple_request_field_group_new(NULL);
 726         purple_request_fields_add_group(fields, group);
 727
 728         field = purple_request_field_string_new("given", _("First name"), NULL, FALSE);
 729         purple_request_field_group_add_field(group, field);
 730         field = purple_request_field_string_new("surname", _("Last name"), NULL, FALSE);
 731         purple_request_field_group_add_field(group, field);
 732         field = purple_request_field_string_new("email", _("Email"), NULL, FALSE);
 733         purple_request_field_group_add_field(group, field);
 734         field = purple_request_field_string_new("company", _("Company"), NULL, FALSE);
 735         purple_request_field_group_add_field(group, field);
 736         field = purple_request_field_string_new("country", _("Country"), NULL, FALSE);
 737         purple_request_field_group_add_field(group, field);
 738
 739         purple_request_fields(gc,
 740                 _("Search"),
 741                 _("Search for a contact"),
 742                 _("Enter the information for the person you wish to find. Empty fields will be ignored."),
 743                 fields,
 744                 _("_Search"), G_CALLBACK(sipe_purple_find_contact_cb),
 745                 _("_Cancel"), NULL,
 746                 purple_connection_get_account(gc), NULL, NULL, gc);
 747 }
 748
 749 static void sipe_purple_join_conference_cb(PurpleConnection *gc,
 750                                            PurpleRequestFields *fields)
 751 {
 752         GList *entries = purple_request_field_group_get_fields(purple_request_fields_get_groups(fields)->data);
 753
 754         if (entries) {
 755                 PurpleRequestField *field = entries->data;
 756                 const char *id = purple_request_field_get_id(field);
 757                 const char *value = purple_request_field_string_get_value(field);
 758
 759                 if (!sipe_strequal(id, "meetingLocation"))
 760                         return;
 761
 762                 sipe_core_conf_create(PURPLE_GC_TO_SIPE_CORE_PUBLIC, value);
 763         }
 764 }
 765
 766 #ifdef HAVE_VV
 767 static void sipe_purple_test_call(PurplePluginAction *action)
 768 {
 769         PurpleConnection *gc = (PurpleConnection *) action->context;
 770         sipe_core_media_test_call(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
 771 }
 772 #endif
 773
 774 static void sipe_purple_show_join_conference(PurplePluginAction *action)
 775 {
 776         PurpleConnection *gc = (PurpleConnection *) action->context;
 777         PurpleRequestFields *fields;
 778         PurpleRequestFieldGroup *group;
 779         PurpleRequestField *field;
 780
 781         fields = purple_request_fields_new();
 782         group = purple_request_field_group_new(NULL);
 783         purple_request_fields_add_group(fields, group);
 784
 785         field = purple_request_field_string_new("meetingLocation", _("Meeting location"), NULL, FALSE);
 786         purple_request_field_group_add_field(group, field);
 787
 788         purple_request_fields(gc,
 789                 _("Join conference"),
 790                 _("Join scheduled conference"),
 791                 _("Enter meeting location string you received in the invitation.\n"
 792                   "\n"
 793                   "Valid location will be something like\n"
 794                   "meet:sip:someone@company.com;gruu;opaque=app:conf:focus:id:abcdef1234\n"
 795                   "or\n"
 796                   "https://meet.company.com/someone/abcdef1234"),
 797                 fields,
 798                 _("_Join"), G_CALLBACK(sipe_purple_join_conference_cb),
 799                 _("_Cancel"), NULL,
 800                 purple_connection_get_account(gc), NULL, NULL, gc);
 801 }
 802
 803 static void sipe_purple_republish_calendar(PurplePluginAction *action)
 804 {
 805         PurpleConnection *gc = (PurpleConnection *) action->context;
 806         sipe_core_update_calendar(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
 807 }
 808
 809 static void sipe_purple_reset_status(PurplePluginAction *action)
 810 {
 811         PurpleConnection *gc = (PurpleConnection *) action->context;
 812         sipe_core_reset_status(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
 813 }
 814
 815 static GList *sipe_purple_actions(SIPE_UNUSED_PARAMETER PurplePlugin *plugin,
 816                                   SIPE_UNUSED_PARAMETER gpointer context)
 817 {
 818         GList *menu = NULL;
 819         PurplePluginAction *act;
 820
 821         act = purple_plugin_action_new(_("About SIPE plugin..."), sipe_purple_show_about_plugin);
 822         menu = g_list_prepend(menu, act);
 823
 824         act = purple_plugin_action_new(_("Contact search..."), sipe_purple_show_find_contact);
 825         menu = g_list_prepend(menu, act);
 826
 827 #ifdef HAVE_VV
 828         act = purple_plugin_action_new(_("Test call"), sipe_purple_test_call);
 829         menu = g_list_prepend(menu, act);
 830 #endif
 831
 832         act = purple_plugin_action_new(_("Join scheduled conference..."), sipe_purple_show_join_conference);
 833         menu = g_list_prepend(menu, act);
 834
 835         act = purple_plugin_action_new(_("Republish Calendar"), sipe_purple_republish_calendar);
 836         menu = g_list_prepend(menu, act);
 837
 838         act = purple_plugin_action_new(_("Reset status"), sipe_purple_reset_status);
 839         menu = g_list_prepend(menu, act);
 840
 841         return g_list_reverse(menu);
 842 }
 843
 844 static PurplePluginInfo sipe_purple_info = {
 845         PURPLE_PLUGIN_MAGIC,
 846         PURPLE_MAJOR_VERSION,
 847         PURPLE_MINOR_VERSION,
 848         PURPLE_PLUGIN_PROTOCOL,                           /**< type           */
 849         NULL,                                             /**< ui_requirement */
 850         0,                                                /**< flags          */
 851         NULL,                                             /**< dependencies   */
 852         PURPLE_PRIORITY_DEFAULT,                          /**< priority       */
 853         "prpl-sipe",                                      /**< id             */
 854         "Office Communicator",                            /**< name           */
 855         PACKAGE_VERSION,                                  /**< version        */
 856         "Microsoft Office Communicator Protocol Plugin",  /**< summary        */
 857         "A plugin for the extended SIP/SIMPLE protocol used by "          /**< description */
 858         "Microsoft Live/Office Communications Server (LCS2005/OCS2007+)", /**< description */
 859         "Anibal Avelar <avelar@gmail.com>, "              /**< author         */
 860         "Gabriel Burt <gburt@novell.com>, "               /**< author         */
 861         "Stefan Becker <stefan.becker@nokia.com>, "       /**< author         */
 862         "pier11 <pier11@operamail.com>",                  /**< author         */
 863         PACKAGE_URL,                                      /**< homepage       */
 864         sipe_purple_plugin_load,                          /**< load           */
 865         sipe_purple_plugin_unload,                        /**< unload         */
 866         sipe_purple_plugin_destroy,                       /**< destroy        */
 867         NULL,                                             /**< ui_info        */
 868         &sipe_prpl_info,                                  /**< extra_info     */
 869         NULL,
 870         sipe_purple_actions,
 871         NULL,
 872         NULL,
 873         NULL,
 874         NULL
 875 };
 876
 877 static void sipe_purple_init_plugin(PurplePlugin *plugin)
 878 {
 879         PurpleAccountUserSplit *split;
 880         PurpleAccountOption *option;
 881
 882         /* This needs to be called first */
 883         sipe_core_init(LOCALEDIR);
 884         sipe_purple_activity_init();
 885
 886         purple_plugin_register(plugin);
 887
 888         /**
 889          * When adding new string settings please make sure to keep these
 890          * in sync:
 891          *
 892          *     api/sipe-backend.h
 893          *     purple-settings.c:setting_name[]
 894          */
 895         split = purple_account_user_split_new(_("Login\n   user  or  DOMAIN\\user  or\n   user@company.com"), NULL, ',');
 896         purple_account_user_split_set_reverse(split, FALSE);
 897         sipe_prpl_info.user_splits = g_list_append(sipe_prpl_info.user_splits, split);
 898
 899         option = purple_account_option_string_new(_("Server[:Port]\n(leave empty for auto-discovery)"), "server", "");
 900         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 901
 902         option = purple_account_option_list_new(_("Connection type"), "transport", NULL);
 903         purple_account_option_add_list_item(option, _("Auto"), "auto");
 904         purple_account_option_add_list_item(option, _("SSL/TLS"), "tls");
 905         purple_account_option_add_list_item(option, _("TCP"), "tcp");
 906         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 907
 908         /*option = purple_account_option_bool_new(_("Publish status (note: everyone may watch you)"), "doservice", TRUE);
 909         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);*/
 910
 911         option = purple_account_option_string_new(_("User Agent"), "useragent", "");
 912         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 913
 914         option = purple_account_option_list_new(_("Authentication scheme"), "authentication", NULL);
 915         purple_account_option_add_list_item(option, _("NTLM"), "ntlm");
 916 #if defined(HAVE_LIBKRB5) || defined(HAVE_SSPI)
 917         purple_account_option_add_list_item(option, _("Kerberos"), "krb5");
 918 #endif
 919 #ifndef HAVE_SSPI
 920         /* see above */
 921         purple_account_option_add_list_item(option, _("TLS-DSK"), "tls-dsk");
 922 #endif
 923         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 924
 925 #if defined(HAVE_LIBKRB5) || defined(HAVE_SSPI)
 926         /* Suitable for sspi/NTLM, sspi/Kerberos and krb5 security mechanisms
 927          * No login/password is taken into account if this option present,
 928          * instead used default credentials stored in OS.
 929          */
 930         option = purple_account_option_bool_new(_("Use Single Sign-On"), "sso", TRUE);
 931         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 932 #endif
 933
 934         /** Example (Exchange): https://server.company.com/EWS/Exchange.asmx
 935          *  Example (Domino)  : https://[domino_server]/[mail_database_name].nsf
 936          */
 937         option = purple_account_option_string_new(_("Email services URL\n(leave empty for auto-discovery)"), "email_url", "");
 938         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 939
 940         option = purple_account_option_string_new(_("Email address\n(if different from Username)"), "email", "");
 941         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 942
 943         /** Example (Exchange): DOMAIN\user  or  user@company.com
 944          *  Example (Domino)  : email_address
 945          */
 946         option = purple_account_option_string_new(_("Email login\n(if different from Login)"), "email_login", "");
 947         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 948
 949         option = purple_account_option_string_new(_("Email password\n(if different from Password)"), "email_password", "");
 950         purple_account_option_set_masked(option, TRUE);
 951         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 952
 953         /** Example (federated domain): company.com      (i.e. ocschat@company.com)
 954          *  Example (non-default user): user@company.com
 955          */
 956         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", "");
 957         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);
 958 }
 959
 960 /* This macro makes the code a purple plugin */
 961 PURPLE_INIT_PLUGIN(sipe, sipe_purple_init_plugin, sipe_purple_info);
 962
 963 /*
 964   Local Variables:
 965   mode: c
 966   c-file-style: "bsd"
 967   indent-tabs-mode: t
 968   tab-width: 8
 969   End:
 970 */