src/purple/purple-plugin-common.c

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