src/purple/purple-plugin-common.c

   1 /**
   2  * @file purple-plugin-common.c
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010-2016 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 <glib.h>
  28 #include <string.h>
  29
  30 #include "sipe-common.h"
  31
  32 #include "account.h"
  33 #include "accountopt.h"
  34 #include "core.h"
  35 #include "notify.h"
  36 #include "request.h"
  37 #include "version.h"
  38
  39 /* Backward compatibility when compiling against 2.4.x API */
  40 #if !PURPLE_VERSION_CHECK(2,5,0) && !PURPLE_VERSION_CHECK(3,0,0)
  41 #define PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY 0x0100
  42 #endif
  43
  44 #if PURPLE_VERSION_CHECK(3,0,0)
  45 #define PURPLE_TYPE_STRING G_TYPE_STRING
  46 #define SIPE_PURPLE_ACTION_TO_CONNECTION              action->connection
  47 #else
  48 #include "blist.h"
  49 #define PURPLE_CONNECTION_FLAG_ALLOW_CUSTOM_SMILEY    PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY
  50 #define PURPLE_CONNECTION_FLAG_FORMATTING_WBFO        PURPLE_CONNECTION_FORMATTING_WBFO
  51 #define PURPLE_CONNECTION_FLAG_HTML                   PURPLE_CONNECTION_HTML
  52 #define PURPLE_CONNECTION_FLAG_NO_BGCOLOR             PURPLE_CONNECTION_NO_BGCOLOR
  53 #define PURPLE_CONNECTION_FLAG_NO_FONTSIZE            PURPLE_CONNECTION_NO_FONTSIZE
  54 #define PURPLE_CONNECTION_FLAG_NO_URLDESC             PURPLE_CONNECTION_NO_URLDESC
  55 #define PURPLE_IS_BUDDY(n)                            PURPLE_BLIST_NODE_IS_BUDDY(n)
  56 #define PURPLE_IS_CHAT(n)                             PURPLE_BLIST_NODE_IS_CHAT(n)
  57 #define PURPLE_IM_TYPING                              PURPLE_TYPING
  58 #define PURPLE_IM_NOT_TYPING                          PURPLE_NOT_TYPING
  59 #define purple_account_option_string_set_masked(o, f) purple_account_option_set_masked(o, f)
  60 #define purple_connection_error(g, e, m)              purple_connection_error_reason(g, e, m)
  61 #define purple_connection_get_flags(gc)               0
  62 #define purple_connection_set_protocol_data(gc, p)    gc->proto_data = p
  63 #define purple_connection_set_flags(gc, f)            gc->flags |= f
  64 #define purple_protocol_action_new(l, c)              purple_plugin_action_new(l, c)
  65 #define PurpleProtocolAction                          PurplePluginAction
  66 #define SIPE_PURPLE_ACTION_TO_CONNECTION              action->context
  67 #endif
  68
  69 #include "sipe-backend.h"
  70 #include "sipe-core.h"
  71 #include "sipe-nls.h"
  72
  73 #include "purple-private.h"
  74
  75 /*
  76  * NOTE: this flag means two things:
  77  *
  78  *  - is Single Sign-On supported, and
  79  *  - is Kerberos supported
  80  */
  81 #if defined(HAVE_GSSAPI_GSSAPI_H) || defined(HAVE_SSPI)
  82 #define PURPLE_SIPE_SSO_AND_KERBEROS 1
  83 #else
  84 #define PURPLE_SIPE_SSO_AND_KERBEROS 0
  85 #endif
  86
  87 /*
  88  * SIPE core activity <-> Purple status mapping
  89  *
  90  * NOTE: this needs to be kept in sync with sipe_purple_status_types()
  91  */
  92 static const gchar * const activity_to_purple_map[SIPE_ACTIVITY_NUM_TYPES] = {
  93 /* SIPE_ACTIVITY_UNSET       */ "unset",     /* == purple_primitive_get_id_from_type(PURPLE_STATUS_UNSET) */
  94 /* SIPE_ACTIVITY_AVAILABLE   */ "available", /* == purple_primitive_get_id_from_type(PURPLE_STATUS_AVAILABLE) */
  95 /* SIPE_ACTIVITY_ONLINE      */ "online",
  96 /* SIPE_ACTIVITY_INACTIVE    */ "idle",
  97 /* SIPE_ACTIVITY_BUSY        */ "busy",
  98 /* SIPE_ACTIVITY_BUSYIDLE    */ "busyidle",
  99 /* SIPE_ACTIVITY_DND         */ "do-not-disturb",
 100 /* SIPE_ACTIVITY_BRB         */ "be-right-back",
 101 /* SIPE_ACTIVITY_AWAY        */ "away",      /* == purple_primitive_get_id_from_type(PURPLE_STATUS_AWAY) */
 102 /* SIPE_ACTIVITY_LUNCH       */ "out-to-lunch",
 103 /* SIPE_ACTIVITY_INVISIBLE   */ "invisible", /* == purple_primitive_get_id_from_type(PURPLE_STATUS_INVISIBLE) */
 104 /* SIPE_ACTIVITY_OFFLINE     */ "offline",   /* == purple_primitive_get_id_from_type(PURPLE_STATUS_OFFLINE) */
 105 /* SIPE_ACTIVITY_ON_PHONE    */ "on-the-phone",
 106 /* SIPE_ACTIVITY_IN_CONF     */ "in-a-conference",
 107 /* SIPE_ACTIVITY_IN_MEETING  */ "in-a-meeting",
 108 /* SIPE_ACTIVITY_OOF         */ "out-of-office",
 109 /* SIPE_ACTIVITY_URGENT_ONLY */ "urgent-interruptions-only",
 110 /* SIPE_ACTIVIY_NUM_TYPES == 17 -> compare to sipe_purple_status_types() */
 111 };
 112
 113 GHashTable *purple_token_map;
 114
 115 static void sipe_purple_activity_init(void)
 116 {
 117         guint index;
 118
 119         purple_token_map = g_hash_table_new(g_str_hash, g_str_equal);
 120         for (index = SIPE_ACTIVITY_UNSET;
 121              index < SIPE_ACTIVITY_NUM_TYPES;
 122              index++) {
 123                 g_hash_table_insert(purple_token_map,
 124                                     (gchar *) activity_to_purple_map[index],
 125                                     GUINT_TO_POINTER(index));
 126         }
 127 }
 128
 129 static void sipe_purple_activity_shutdown(void)
 130 {
 131         g_hash_table_destroy(purple_token_map);
 132 }
 133
 134 const gchar *sipe_purple_activity_to_token(guint type)
 135 {
 136         return(activity_to_purple_map[type]);
 137 }
 138
 139 guint sipe_purple_token_to_activity(const gchar *token)
 140 {
 141         return(GPOINTER_TO_UINT(g_hash_table_lookup(purple_token_map, token)));
 142 }
 143
 144 gchar *sipe_backend_version(void)
 145 {
 146         return(g_strdup_printf("Purple/%s", purple_core_get_version()));
 147 }
 148
 149 const char *sipe_purple_list_icon(SIPE_UNUSED_PARAMETER PurpleAccount *a,
 150                                   SIPE_UNUSED_PARAMETER PurpleBuddy *b)
 151 {
 152         return "sipe";
 153 }
 154
 155 gchar *sipe_purple_status_text(PurpleBuddy *buddy)
 156 {
 157         const PurpleStatus *status = purple_presence_get_active_status(purple_buddy_get_presence(buddy));
 158         return sipe_core_buddy_status(PURPLE_BUDDY_TO_SIPE_CORE_PUBLIC,
 159                                       purple_buddy_get_name(buddy),
 160                                       sipe_purple_token_to_activity(purple_status_get_id(status)),
 161                                       purple_status_get_name(status));
 162 }
 163
 164 void sipe_purple_tooltip_text(PurpleBuddy *buddy,
 165                               PurpleNotifyUserInfo *user_info,
 166                               SIPE_UNUSED_PARAMETER gboolean full)
 167 {
 168         const PurplePresence *presence = purple_buddy_get_presence(buddy);
 169         sipe_core_buddy_tooltip_info(PURPLE_BUDDY_TO_SIPE_CORE_PUBLIC,
 170                                      purple_buddy_get_name(buddy),
 171                                      purple_status_get_name(purple_presence_get_active_status(presence)),
 172                                      purple_presence_is_online(presence),
 173                                      (struct sipe_backend_buddy_tooltip *) user_info);
 174 }
 175
 176 GList *sipe_purple_status_types(SIPE_UNUSED_PARAMETER PurpleAccount *acc)
 177 {
 178         PurpleStatusType *type;
 179         GList *types = NULL;
 180
 181         /* Macro to reduce code repetition
 182            Translators: noun */
 183 #define SIPE_ADD_STATUS(prim,activity,user) type = purple_status_type_new_with_attrs( \
 184                 prim, \
 185                 sipe_purple_activity_to_token(activity), \
 186                 sipe_core_activity_description(activity), \
 187                 TRUE, user, FALSE,          \
 188                 SIPE_PURPLE_STATUS_ATTR_ID_MESSAGE, _("Message"), purple_value_new(PURPLE_TYPE_STRING), \
 189                 NULL);                      \
 190         types = g_list_append(types, type);
 191
 192         /*
 193          * NOTE: needs to be kept in sync with activity_to_purple_map[],
 194          *       i.e. for each SIPE_ACTIVITY_xxx value there must be an
 195          *       entry on this list.
 196          *
 197          * NOTE: the following code is sorted by purple primitive type not
 198          *       by SIPE_ACTIVITY_xxx value.
 199          */
 200
 201         /*  1: Unset - special case: no entry needed */
 202
 203         /*
 204          * Status list entries for primitive type AVAILABLE
 205          *
 206          *  2: Available */
 207         SIPE_ADD_STATUS(PURPLE_STATUS_AVAILABLE,
 208                         SIPE_ACTIVITY_AVAILABLE,
 209                         TRUE);
 210
 211         /*  3: Online */
 212         SIPE_ADD_STATUS(PURPLE_STATUS_AVAILABLE,
 213                         SIPE_ACTIVITY_ONLINE,
 214                         FALSE);
 215
 216         /*  4: Inactive (Idle) */
 217         SIPE_ADD_STATUS(PURPLE_STATUS_AVAILABLE,
 218                         SIPE_ACTIVITY_INACTIVE,
 219                         FALSE);
 220
 221         /*
 222          * Status list entries for primitive type UNAVAILABLE
 223          *
 224          *  5: Busy */
 225         SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
 226                         SIPE_ACTIVITY_BUSY,
 227                         TRUE);
 228
 229         /*  6: Busy-Idle */
 230         SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
 231                         SIPE_ACTIVITY_BUSYIDLE,
 232                         FALSE);
 233
 234         /*  7: Do Not Disturb */
 235         SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
 236                         SIPE_ACTIVITY_DND,
 237                         TRUE);
 238
 239         /*  8: In a call */
 240         SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
 241                         SIPE_ACTIVITY_ON_PHONE,
 242                         FALSE);
 243
 244         /*  9: In a conference call */
 245         SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
 246                         SIPE_ACTIVITY_IN_CONF,
 247                         FALSE);
 248
 249         /* 10: In a meeting */
 250         SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
 251                         SIPE_ACTIVITY_IN_MEETING,
 252                         FALSE);
 253
 254         /* 11: Urgent interruptions only */
 255         SIPE_ADD_STATUS(PURPLE_STATUS_UNAVAILABLE,
 256                         SIPE_ACTIVITY_URGENT_ONLY,
 257                         FALSE);
 258
 259         /*
 260          * Status list entries for primitive type AWAY
 261          *
 262          * 12: Away - special case: needs to go first in the list as purple
 263          *            picks the first status with primitive type AWAY for idle
 264          */
 265         SIPE_ADD_STATUS(PURPLE_STATUS_AWAY,
 266                         SIPE_ACTIVITY_AWAY,
 267                         TRUE);
 268
 269         /* 13: Be Right Back */
 270         SIPE_ADD_STATUS(PURPLE_STATUS_AWAY,
 271                         SIPE_ACTIVITY_BRB,
 272                         TRUE);
 273
 274         /* 14: Out to lunch */
 275         SIPE_ADD_STATUS(PURPLE_STATUS_AWAY,
 276                         SIPE_ACTIVITY_LUNCH,
 277                         FALSE);
 278
 279         /*
 280          * Status list entries for primitive type EXTENDED_AWAY
 281          *
 282          * 15: Out of office */
 283         SIPE_ADD_STATUS(PURPLE_STATUS_EXTENDED_AWAY,
 284                         SIPE_ACTIVITY_OOF,
 285                         FALSE);
 286
 287         /*
 288          * Status list entries for primitive type INVISIBLE
 289          *
 290          * 16: Appear Offline */
 291         SIPE_ADD_STATUS(PURPLE_STATUS_INVISIBLE,
 292                         SIPE_ACTIVITY_INVISIBLE,
 293                         TRUE);
 294
 295         /*
 296          * Status list entries for primitive type OFFLINE
 297          *
 298          * NOTE: this is always the last entry. Compare the number
 299          *       with the comment in activity_to_purple_map[].
 300          *
 301          * 17: Offline - special case: no message text */
 302         type = purple_status_type_new(PURPLE_STATUS_OFFLINE,
 303                                       NULL,
 304                                       NULL,
 305                                       TRUE);
 306         types = g_list_append(types, type);
 307
 308         return types;
 309 }
 310
 311 GList *sipe_purple_blist_node_menu(PurpleBlistNode *node)
 312 {
 313         if (PURPLE_IS_BUDDY(node))
 314         {
 315                 return sipe_purple_buddy_menu((PurpleBuddy *) node);
 316         } else
 317         if (PURPLE_IS_CHAT(node))
 318         {
 319                 return sipe_purple_chat_menu((PurpleChat *)node);
 320         } else {
 321                 return NULL;
 322         }
 323 }
 324
 325 static guint get_authentication_type(PurpleAccount *account)
 326 {
 327         const gchar *auth = purple_account_get_string(account, "authentication", "ntlm");
 328
 329         /* map option list to type - default is automatic */
 330         guint authentication_type = SIPE_AUTHENTICATION_TYPE_AUTOMATIC;
 331         if (sipe_strequal(auth, "ntlm")) {
 332                 authentication_type = SIPE_AUTHENTICATION_TYPE_NTLM;
 333         } else
 334 #if PURPLE_SIPE_SSO_AND_KERBEROS
 335         if (sipe_strequal(auth, "krb5")) {
 336                 authentication_type = SIPE_AUTHENTICATION_TYPE_KERBEROS;
 337         } else
 338 #endif
 339         if (sipe_strequal(auth, "tls-dsk")) {
 340                 authentication_type = SIPE_AUTHENTICATION_TYPE_TLS_DSK;
 341         }
 342
 343         return(authentication_type);
 344 }
 345
 346 static gboolean get_sso_flag(PurpleAccount *account)
 347 {
 348 #if PURPLE_SIPE_SSO_AND_KERBEROS
 349         /*
 350          * NOTE: the default must be *OFF*, i.e. it is up to the user to tell
 351          *       SIPE that it is OK to use Single Sign-On or not.
 352          */
 353         return(purple_account_get_bool(account, "sso", FALSE));
 354 #else
 355         (void) account; /* keep compiler happy */
 356         return(FALSE);
 357 #endif
 358 }
 359
 360 static gboolean get_dont_publish_flag(PurpleAccount *account)
 361 {
 362         /* default is to publish calendar information */
 363         return(purple_account_get_bool(account, "dont-publish", FALSE));
 364 }
 365
 366 static void connect_to_core(PurpleConnection *gc,
 367                             PurpleAccount *account,
 368                             const gchar *password)
 369 {
 370         const gchar *username  = purple_account_get_username(account);
 371         const gchar *email     = purple_account_get_string(account, "email", NULL);
 372         const gchar *email_url = purple_account_get_string(account, "email_url", NULL);
 373         const gchar *transport = purple_account_get_string(account, "transport", "auto");
 374         struct sipe_core_public *sipe_public;
 375         gchar **username_split;
 376         const gchar *errmsg;
 377         guint transport_type;
 378         struct sipe_backend_private *purple_private;
 379
 380         /* username format: <username>,[<optional login>] */
 381         SIPE_DEBUG_INFO("sipe_purple_login: username '%s'", username);
 382         username_split = g_strsplit(username, ",", 2);
 383
 384         sipe_public = sipe_core_allocate(username_split[0],
 385                                          get_sso_flag(account),
 386                                          username_split[1],
 387                                          password,
 388                                          email,
 389                                          email_url,
 390                                          &errmsg);
 391         g_strfreev(username_split);
 392
 393         if (!sipe_public) {
 394                 purple_connection_error(gc,
 395                                         PURPLE_CONNECTION_ERROR_INVALID_USERNAME,
 396                                         errmsg);
 397                 return;
 398         }
 399
 400         sipe_public->backend_private = purple_private = g_new0(struct sipe_backend_private, 1);
 401         purple_private->public = sipe_public;
 402         purple_private->gc = gc;
 403         purple_private->account = account;
 404
 405         sipe_purple_chat_setup_rejoin(purple_private);
 406
 407         SIPE_CORE_FLAG_UNSET(DONT_PUBLISH);
 408         if (get_dont_publish_flag(account))
 409                 SIPE_CORE_FLAG_SET(DONT_PUBLISH);
 410
 411         purple_connection_set_protocol_data(gc, sipe_public);
 412         purple_connection_set_flags(gc,
 413                                     purple_connection_get_flags(gc) |
 414                                     PURPLE_CONNECTION_FLAG_HTML |
 415                                     PURPLE_CONNECTION_FLAG_FORMATTING_WBFO |
 416                                     PURPLE_CONNECTION_FLAG_NO_BGCOLOR |
 417                                     PURPLE_CONNECTION_FLAG_NO_FONTSIZE |
 418                                     PURPLE_CONNECTION_FLAG_NO_URLDESC |
 419                                     PURPLE_CONNECTION_FLAG_ALLOW_CUSTOM_SMILEY);
 420         purple_connection_set_display_name(gc, sipe_public->sip_name);
 421         purple_connection_update_progress(gc, _("Connecting"), 1, 2);
 422
 423         username_split = g_strsplit(purple_account_get_string(account, "server", ""), ":", 2);
 424         if (sipe_strequal(transport, "auto")) {
 425                 transport_type = (username_split[0] == NULL) ?
 426                         SIPE_TRANSPORT_AUTO : SIPE_TRANSPORT_TLS;
 427         } else if (sipe_strequal(transport, "tls")) {
 428                 transport_type = SIPE_TRANSPORT_TLS;
 429         } else {
 430                 transport_type = SIPE_TRANSPORT_TCP;
 431         }
 432         sipe_core_transport_sip_connect(sipe_public,
 433                                         transport_type,
 434                                         get_authentication_type(account),
 435                                         username_split[0],
 436                                         username_split[0] ? username_split[1] : NULL);
 437         g_strfreev(username_split);
 438 }
 439
 440 static void password_required_cb(PurpleConnection *gc,
 441                                  SIPE_UNUSED_PARAMETER PurpleRequestFields *fields)
 442 {
 443 #if !PURPLE_VERSION_CHECK(3,0,0)
 444         if (!PURPLE_CONNECTION_IS_VALID(gc)) {
 445                 return;
 446         }
 447 #endif
 448
 449         purple_connection_error(gc,
 450                                 PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED,
 451                                 _("Password required"));
 452 }
 453
 454 static void password_ok_cb(PurpleConnection *gc,
 455                            PurpleRequestFields *fields)
 456 {
 457         const gchar *password;
 458
 459 #if !PURPLE_VERSION_CHECK(3,0,0)
 460         if (!PURPLE_CONNECTION_IS_VALID(gc)) {
 461                 return;
 462         }
 463 #endif
 464
 465         password = purple_request_fields_get_string(fields, "password");
 466
 467         if (password && strlen(password)) {
 468                 PurpleAccount *account = purple_connection_get_account(gc);
 469
 470                 if (purple_request_fields_get_bool(fields, "remember"))
 471                         purple_account_set_remember_password(account, TRUE);
 472                 purple_account_set_password(account, password
 473 #if PURPLE_VERSION_CHECK(3,0,0)
 474                                             , NULL, NULL
 475 #endif
 476                                            );
 477
 478                 /* Now we have a password and we can connect */
 479                 connect_to_core(gc, account, password);
 480
 481         } else
 482                 /* reject an empty password */
 483                 password_required_cb(gc, fields);
 484 }
 485
 486 void sipe_purple_login(PurpleAccount *account)
 487 {
 488         PurpleConnection *gc = purple_account_get_connection(account);
 489         const gchar *password = purple_connection_get_password(gc);
 490
 491         /* Password required? */
 492         if (sipe_core_transport_sip_requires_password(get_authentication_type(account),
 493                                                       get_sso_flag(account)) &&
 494             (!password || !strlen(password)))
 495                 /* No password set - request one from user */
 496                 purple_account_request_password(account,
 497                                                 G_CALLBACK(password_ok_cb),
 498                                                 G_CALLBACK(password_required_cb),
 499                                                 gc);
 500         else
 501                 /* No password required or saved password - connect now */
 502                 connect_to_core(gc, account, password);
 503
 504 }
 505
 506 void sipe_purple_close(PurpleConnection *gc)
 507 {
 508         struct sipe_core_public *sipe_public = PURPLE_GC_TO_SIPE_CORE_PUBLIC;
 509
 510         if (sipe_public) {
 511                 struct sipe_backend_private *purple_private = sipe_public->backend_private;
 512
 513                 sipe_core_deallocate(sipe_public);
 514
 515                 /* anything left after that must be in pending state... */
 516                 sipe_purple_dns_query_cancel_all(purple_private);
 517                 sipe_purple_transport_close_all(purple_private);
 518
 519                 if (purple_private->roomlist_map)
 520                         g_hash_table_destroy(purple_private->roomlist_map);
 521                 sipe_purple_chat_destroy_rejoin(purple_private);
 522
 523                 if (purple_private->deferred_status_timeout)
 524                         purple_timeout_remove(purple_private->deferred_status_timeout);
 525                 g_free(purple_private->deferred_status_note);
 526
 527                 g_free(purple_private);
 528                 purple_connection_set_protocol_data(gc, NULL);
 529         }
 530 }
 531
 532 unsigned int sipe_purple_send_typing(PurpleConnection *gc,
 533                                      const char *who,
 534                                      PurpleIMTypingState state)
 535 {
 536         gboolean typing = (state == PURPLE_IM_TYPING);
 537
 538         /* only enable this debug output while testing
 539            SIPE_DEBUG_INFO("sipe_purple_send_typing: '%s' state %d", who, state); */
 540
 541         /*
 542          * libpurple calls this function with PURPLE_NOT_TYPING *after*
 543          * calling sipe_purple_send_im() with the message. This causes
 544          * SIPE core to send out two SIP messages to the same dialog in
 545          * short succession without waiting for the response to the first
 546          * one. Some servers then reject the first one with
 547          *
 548          *    SIP/2.0 500 Stale CSeq Value
 549          *
 550          * which triggers a "message not delivered" error for the user.
 551          *
 552          * Work around this by filtering out PURPLE_NOT_TYPING events.
 553          */
 554         if (state != PURPLE_IM_NOT_TYPING)
 555                 sipe_core_user_feedback_typing(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 556                                                who,
 557                                                typing);
 558
 559         /* tell libpurple to send typing indications every 4 seconds */
 560         return(typing ? 4 : 0);
 561 }
 562
 563 void sipe_purple_get_info(PurpleConnection *gc, const char *who)
 564 {
 565         sipe_core_buddy_get_info(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 566                                  who);
 567 }
 568
 569 void sipe_purple_add_permit(PurpleConnection *gc, const char *name)
 570 {
 571         sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, TRUE);
 572 }
 573
 574 void sipe_purple_add_deny(PurpleConnection *gc, const char *name)
 575 {
 576         sipe_core_contact_allow_deny(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, FALSE);
 577 }
 578
 579 void sipe_purple_alias_buddy(PurpleConnection *gc, const char *name,
 580                              const char *alias)
 581 {
 582         sipe_core_group_set_alias(PURPLE_GC_TO_SIPE_CORE_PUBLIC, name, alias);
 583 }
 584
 585 void sipe_purple_group_rename(PurpleConnection *gc, const char *old_name,
 586                               PurpleGroup *group,
 587                               SIPE_UNUSED_PARAMETER GList *moved_buddies)
 588 {
 589         sipe_core_group_rename(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 590                                old_name,
 591                                purple_group_get_name(group));
 592 }
 593
 594 void sipe_purple_convo_closed(PurpleConnection *gc, const char *who)
 595 {
 596         sipe_core_im_close(PURPLE_GC_TO_SIPE_CORE_PUBLIC, who);
 597 }
 598
 599 void sipe_purple_group_remove(PurpleConnection *gc, PurpleGroup *group)
 600 {
 601         sipe_core_group_remove(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 602                                purple_group_get_name(group));
 603 }
 604
 605 #if PURPLE_VERSION_CHECK(2,5,0) || PURPLE_VERSION_CHECK(3,0,0)
 606 GHashTable *
 607 sipe_purple_get_account_text_table(SIPE_UNUSED_PARAMETER PurpleAccount *account)
 608 {
 609         GHashTable *table;
 610         table = g_hash_table_new(g_str_hash, g_str_equal);
 611         g_hash_table_insert(table, "login_label", (gpointer)_("user@company.com"));
 612         return table;
 613 }
 614
 615 #if PURPLE_VERSION_CHECK(2,6,0) || PURPLE_VERSION_CHECK(3,0,0)
 616 #ifdef HAVE_VV
 617
 618 static void
 619 sipe_purple_sigusr1_handler(SIPE_UNUSED_PARAMETER int signum)
 620 {
 621         capture_pipeline("PURPLE_SIPE_PIPELINE");
 622 }
 623
 624 gboolean sipe_purple_initiate_media(PurpleAccount *account, const char *who,
 625                                     SIPE_UNUSED_PARAMETER PurpleMediaSessionType type)
 626 {
 627         sipe_core_media_initiate_call(PURPLE_ACCOUNT_TO_SIPE_CORE_PUBLIC,
 628                                       who,
 629                                       (type & PURPLE_MEDIA_VIDEO));
 630         return TRUE;
 631 }
 632
 633 PurpleMediaCaps sipe_purple_get_media_caps(SIPE_UNUSED_PARAMETER PurpleAccount *account,
 634                                            SIPE_UNUSED_PARAMETER const char *who)
 635 {
 636         return   PURPLE_MEDIA_CAPS_AUDIO
 637                | PURPLE_MEDIA_CAPS_AUDIO_VIDEO
 638                | PURPLE_MEDIA_CAPS_MODIFY_SESSION;
 639 }
 640 #endif
 641 #endif
 642 #endif
 643
 644 /* PurplePluginInfo function calls & data structure */
 645 gboolean sipe_purple_plugin_load(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
 646 {
 647 #ifdef HAVE_VV
 648         struct sigaction action;
 649         memset(&action, 0, sizeof (action));
 650         action.sa_handler = sipe_purple_sigusr1_handler;
 651         sigaction(SIGUSR1, &action, NULL);
 652 #endif
 653
 654         sipe_purple_activity_init();
 655
 656         return TRUE;
 657 }
 658
 659 gboolean sipe_purple_plugin_unload(SIPE_UNUSED_PARAMETER PurplePlugin *plugin)
 660 {
 661 #ifdef HAVE_VV
 662         struct sigaction action;
 663         memset(&action, 0, sizeof (action));
 664         action.sa_handler = SIG_DFL;
 665         sigaction(SIGUSR1, &action, NULL);
 666 #endif
 667
 668         sipe_purple_activity_shutdown();
 669
 670         return TRUE;
 671 }
 672
 673 static void sipe_purple_show_about_plugin(PurpleProtocolAction *action)
 674 {
 675         gchar *tmp = sipe_core_about();
 676         purple_notify_formatted(SIPE_PURPLE_ACTION_TO_CONNECTION,
 677                                 NULL, " ", NULL, tmp, NULL, NULL);
 678         g_free(tmp);
 679 }
 680
 681 static void sipe_purple_join_conference_cb(PurpleConnection *gc,
 682                                            PurpleRequestFields *fields)
 683 {
 684         GList *entries = purple_request_field_group_get_fields(purple_request_fields_get_groups(fields)->data);
 685
 686         if (entries) {
 687                 const gchar *location = purple_request_fields_get_string(fields,
 688                                                                          "meetingLocation");
 689                 const gchar *organizer = purple_request_fields_get_string(fields,
 690                                                                           "meetingOrganizer");
 691                 const gchar *meeting_id = purple_request_fields_get_string(fields,
 692                                                                            "meetingID");
 693                 sipe_core_conf_create(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 694                                       location,
 695                                       organizer,
 696                                       meeting_id);
 697         }
 698 }
 699
 700 #ifdef HAVE_VV
 701
 702 static void sipe_purple_phone_call_cb(PurpleConnection *gc,
 703                                       PurpleRequestFields *fields)
 704 {
 705         GList *entries = purple_request_field_group_get_fields(purple_request_fields_get_groups(fields)->data);
 706
 707         if (entries)
 708                 sipe_core_media_phone_call(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 709                                            purple_request_fields_get_string(fields,
 710                                                                             "phoneNumber"));
 711 }
 712
 713 static void sipe_purple_phone_call(PurpleProtocolAction *action)
 714 {
 715         PurpleConnection *gc = SIPE_PURPLE_ACTION_TO_CONNECTION;
 716         PurpleRequestFields *fields;
 717         PurpleRequestFieldGroup *group;
 718         PurpleRequestField *field;
 719
 720         fields = purple_request_fields_new();
 721         group = purple_request_field_group_new(NULL);
 722         purple_request_fields_add_group(fields, group);
 723
 724         field = purple_request_field_string_new("phoneNumber", _("Phone number"), NULL, FALSE);
 725         purple_request_field_group_add_field(group, field);
 726
 727         purple_request_fields(gc,
 728                               _("Call a phone number"),
 729                               _("Call a phone number"),
 730                               NULL,
 731                               fields,
 732                               _("_Call"), G_CALLBACK(sipe_purple_phone_call_cb),
 733                               _("_Cancel"), NULL,
 734 #if PURPLE_VERSION_CHECK(3,0,0)
 735                               purple_request_cpar_from_connection(gc),
 736 #else
 737                               purple_connection_get_account(gc), NULL, NULL,
 738 #endif
 739                               gc);
 740 }
 741
 742 static void sipe_purple_test_call(PurpleProtocolAction *action)
 743 {
 744         PurpleConnection *gc = SIPE_PURPLE_ACTION_TO_CONNECTION;
 745         sipe_core_media_test_call(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
 746 }
 747 #endif
 748
 749 static void sipe_purple_show_join_conference(PurpleProtocolAction *action)
 750 {
 751         PurpleConnection *gc = SIPE_PURPLE_ACTION_TO_CONNECTION;
 752         PurpleRequestFields *fields;
 753         PurpleRequestFieldGroup *group;
 754         PurpleRequestField *field;
 755
 756         fields = purple_request_fields_new();
 757         group = purple_request_field_group_new(NULL);
 758         purple_request_fields_add_group(fields, group);
 759
 760         field = purple_request_field_string_new("meetingLocation", _("Meeting location"), NULL, FALSE);
 761         purple_request_field_group_add_field(group, field);
 762         field = purple_request_field_label_new("separator", _("Alternatively"));
 763         purple_request_field_group_add_field(group, field);
 764         field = purple_request_field_string_new("meetingOrganizer", _("Organizer email"), NULL, FALSE);
 765         purple_request_field_group_add_field(group, field);
 766         field = purple_request_field_string_new("meetingID", _("Meeting ID"), NULL, FALSE);
 767         purple_request_field_group_add_field(group, field);
 768
 769         purple_request_fields(gc,
 770                               _("Join conference"),
 771                               _("Join scheduled conference"),
 772                               _("Enter meeting location string you received in the invitation.\n"
 773                                 "\n"
 774                                 "Valid location will be something like\n"
 775                                 "meet:sip:someone@company.com;gruu;opaque=app:conf:focus:id:abcdef1234\n"
 776                                 "conf:sip:someone@company.com;gruu;opaque=app:conf:focus:id:abcdef1234\n"
 777                                 "or\n"
 778                                 "https://meet.company.com/someone/abcdef1234"),
 779                               fields,
 780                               _("_Join"), G_CALLBACK(sipe_purple_join_conference_cb),
 781                               _("_Cancel"), NULL,
 782 #if PURPLE_VERSION_CHECK(3,0,0)
 783                               purple_request_cpar_from_connection(gc),
 784 #else
 785                               purple_connection_get_account(gc), NULL, NULL,
 786 #endif
 787                               gc);
 788 }
 789
 790 static void sipe_purple_republish_calendar(PurpleProtocolAction *action)
 791 {
 792         PurpleConnection *gc = SIPE_PURPLE_ACTION_TO_CONNECTION;
 793         PurpleAccount *account = purple_connection_get_account(gc);
 794
 795         if (get_dont_publish_flag(account)) {
 796                 sipe_backend_notify_error(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 797                                           _("Publishing of calendar information has been disabled"),
 798                                           NULL);
 799         } else {
 800                 sipe_core_update_calendar(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
 801         }
 802 }
 803
 804 static void sipe_purple_reset_status(PurpleProtocolAction *action)
 805 {
 806         PurpleConnection *gc = SIPE_PURPLE_ACTION_TO_CONNECTION;
 807         PurpleAccount *account = purple_connection_get_account(gc);
 808
 809         if (get_dont_publish_flag(account)) {
 810                 sipe_backend_notify_error(PURPLE_GC_TO_SIPE_CORE_PUBLIC,
 811                                           _("Publishing of calendar information has been disabled"),
 812                                           NULL);
 813         } else {
 814                 sipe_core_reset_status(PURPLE_GC_TO_SIPE_CORE_PUBLIC);
 815         }
 816 }
 817
 818 GList *sipe_purple_actions()
 819 {
 820         GList *menu = NULL;
 821         PurpleProtocolAction *act;
 822
 823         act = purple_protocol_action_new(_("About SIPE plugin..."), sipe_purple_show_about_plugin);
 824         menu = g_list_prepend(menu, act);
 825
 826         act = purple_protocol_action_new(_("Contact search..."), sipe_purple_show_find_contact);
 827         menu = g_list_prepend(menu, act);
 828
 829 #ifdef HAVE_VV
 830         act = purple_protocol_action_new(_("Call a phone number..."), sipe_purple_phone_call);
 831         menu = g_list_prepend(menu, act);
 832
 833         act = purple_protocol_action_new(_("Test call"), sipe_purple_test_call);
 834         menu = g_list_prepend(menu, act);
 835 #endif
 836
 837         act = purple_protocol_action_new(_("Join scheduled conference..."), sipe_purple_show_join_conference);
 838         menu = g_list_prepend(menu, act);
 839
 840         act = purple_protocol_action_new(_("Republish Calendar"), sipe_purple_republish_calendar);
 841         menu = g_list_prepend(menu, act);
 842
 843         act = purple_protocol_action_new(_("Reset status"), sipe_purple_reset_status);
 844         menu = g_list_prepend(menu, act);
 845
 846         return g_list_reverse(menu);
 847 }
 848
 849 GList * sipe_purple_account_options()
 850 {
 851         PurpleAccountOption *option;
 852         GList *options = NULL;
 853
 854         /**
 855          * When adding new string settings please make sure to keep these
 856          * in sync:
 857          *
 858          *     api/sipe-backend.h
 859          *     purple-settings.c:setting_name[]
 860          */
 861         option = purple_account_option_string_new(_("Server[:Port]\n(leave empty for auto-discovery)"), "server", "");
 862         options = g_list_append(options, option);
 863
 864         option = purple_account_option_list_new(_("Connection type"), "transport", NULL);
 865         purple_account_option_add_list_item(option, _("Auto"), "auto");
 866         purple_account_option_add_list_item(option, _("SSL/TLS"), "tls");
 867         purple_account_option_add_list_item(option, _("TCP"), "tcp");
 868         options = g_list_append(options, option);
 869
 870         /*option = purple_account_option_bool_new(_("Publish status (note: everyone may watch you)"), "doservice", TRUE);
 871         sipe_prpl_info.protocol_options = g_list_append(sipe_prpl_info.protocol_options, option);*/
 872
 873         option = purple_account_option_string_new(_("User Agent"), "useragent", "");
 874         options = g_list_append(options, option);
 875
 876         option = purple_account_option_list_new(_("Authentication scheme"), "authentication", NULL);
 877         purple_account_option_add_list_item(option, _("Auto"), "auto");
 878         purple_account_option_add_list_item(option, _("NTLM"), "ntlm");
 879 #if PURPLE_SIPE_SSO_AND_KERBEROS
 880         purple_account_option_add_list_item(option, _("Kerberos"), "krb5");
 881 #endif
 882         purple_account_option_add_list_item(option, _("TLS-DSK"), "tls-dsk");
 883         options = g_list_append(options, option);
 884
 885 #if PURPLE_SIPE_SSO_AND_KERBEROS
 886         /*
 887          * When the user selects Single Sign-On then SIPE will ignore the
 888          * settings for "login name" and "password". Instead it will use the
 889          * default credentials provided by the OS.
 890          *
 891          * NOTE: the default must be *OFF*, i.e. it is up to the user to tell
 892          *       SIPE that it is OK to use Single Sign-On or not.
 893          *
 894          * Configurations that are known to support Single Sign-On:
 895          *
 896          *  - Windows, host joined to domain, SIPE with SSPI: NTLM
 897          *  - Windows, host joined to domain, SIPE with SSPI: Kerberos
 898          *  - SIPE with libkrb5, valid TGT in cache (kinit):  Kerberos
 899          */
 900         option = purple_account_option_bool_new(_("Use Single Sign-On"), "sso", FALSE);
 901         options = g_list_append(options, option);
 902 #endif
 903
 904         /** Example (Exchange): https://server.company.com/EWS/Exchange.asmx
 905          *  Example (Domino)  : https://[domino_server]/[mail_database_name].nsf
 906          */
 907         option = purple_account_option_bool_new(_("Don't publish my calendar information"), "dont-publish", FALSE);
 908         options = g_list_append(options, option);
 909
 910         option = purple_account_option_string_new(_("Email services URL\n(leave empty for auto-discovery)"), "email_url", "");
 911         options = g_list_append(options, option);
 912
 913         option = purple_account_option_string_new(_("Email address\n(if different from Username)"), "email", "");
 914         options = g_list_append(options, option);
 915
 916         /** Example (Exchange): DOMAIN\user  or  user@company.com
 917          *  Example (Domino)  : email_address
 918          */
 919         option = purple_account_option_string_new(_("Email login\n(if different from Login)"), "email_login", "");
 920         options = g_list_append(options, option);
 921
 922         option = purple_account_option_string_new(_("Email password\n(if different from Password)"), "email_password", "");
 923         purple_account_option_string_set_masked(option, TRUE);
 924         options = g_list_append(options, option);
 925
 926         /** Example (federated domain): company.com      (i.e. ocschat@company.com)
 927          *  Example (non-default user): user@company.com
 928          */
 929         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", "");
 930         options = g_list_append(options, option);
 931
 932 #ifdef HAVE_APPSHARE
 933         option = purple_account_option_string_new(_("Remote desktop client"), "rdp_client", "remmina");
 934         options = g_list_append(options, option);
 935 #endif
 936
 937 #ifdef HAVE_SRTP
 938         option = purple_account_option_list_new(_("Media encryption"), "encryption-policy", NULL);
 939         purple_account_option_add_list_item(option, _("Obey server policy"), "obey-server");
 940         purple_account_option_add_list_item(option, _("Always"), "required");
 941         purple_account_option_add_list_item(option, _("Optional"), "optional");
 942         purple_account_option_add_list_item(option, _("Disabled"), "disabled");
 943         options = g_list_append(options, option);
 944 #endif
 945
 946         return options;
 947 }
 948
 949 gpointer sipe_purple_user_split()
 950 {
 951         PurpleAccountUserSplit *split =
 952                         purple_account_user_split_new(_("Login\n   user  or  DOMAIN\\user  or\n   user@company.com"), NULL, ',');
 953         purple_account_user_split_set_reverse(split, FALSE);
 954
 955         return split;
 956 }
 957
 958 /*
 959   Local Variables:
 960   mode: c
 961   c-file-style: "bsd"
 962   indent-tabs-mode: t
 963   tab-width: 8
 964   End:
 965 */