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