src/core/sipe-core.c

   1 /**
   2  * @file sipe-core.c
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010-2013 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  * Some notes on the history of this project/code/copyrights:
  24  *
  25  *  - the project is called SIPE, but originally the code was only written
  26  *    for the libpurple framework, i.e. Pidgin. Hence the package name is
  27  *    "pidgin-sipe".
  28  *
  29  *  - in the beginning almost all of the code was located in a module
  30  *    called "sipe.c". During the effort to remove the libpurple
  31  *    dependencies from the SIPE core, thousands of lines of code got
  32  *    shifted out of sipe.c, mostly to newly created modules and sipe.c
  33  *    ceased to exist.
  34  *
  35  *  - it would have been tedious to track down the original author or
  36  *    copyright and preserve them for each line of code that was moved.
  37  *    Therefore the new modules started with a fresh copyright notice
  38  *    (like the one above).
  39  *
  40  *  - the original copyright notices from sipe.c have been moved to this
  41  *    file (see below) and *MUST* be preserved!
  42  *
  43  *  - if necessary the author of a line of code in question can still be
  44  *    reconstructed from the git repository information.
  45  *    See also "man git-blame"
  46  *
  47  *  - if you think your copyright should be restored for a piece of code,
  48  *    then please contact the SIPE project to fix the source files ASAP.
  49  *
  50  *------------------- Copyright notices from "sipe.c" ---------------
  51  * Copyright (C) 2010-11 SIPE Project <http://sipe.sourceforge.net/>
  52  * Copyright (C) 2009-10 pier11 <pier11@operamail.com>
  53  * Copyright (C) 2008    Novell, Inc.
  54  * Copyright (C) 2007-09 Anibal Avelar <debianmx@gmail.com>
  55  * Copyright (C) 2005    Thomas Butter <butter@uni-mannheim.de>
  56  *
  57  * ***
  58  * Thanks to Google's Summer of Code Program and the helpful mentors
  59  * ***
  60  *------------------- Copyright notices from "sipe.c" ---------------
  61  */
  62
  63 #ifdef HAVE_CONFIG_H
  64 #include "config.h"
  65 #endif
  66
  67 #include <stdlib.h>
  68 #include <string.h>
  69
  70 #include <glib.h>
  71
  72 #include "sipe-common.h"
  73 #include "sip-csta.h"
  74 #include "sip-sec.h"
  75 #include "sip-transport.h"
  76 #include "sipe-backend.h"
  77 #include "sipe-buddy.h"
  78 #include "sipe-cal.h"
  79 #include "sipe-certificate.h"
  80 #include "sipe-chat.h"
  81 #include "sipe-conf.h"
  82 #include "sipe-core.h"
  83 #include "sipe-core-private.h"
  84 #include "sipe-crypt.h"
  85 #include "sipe-ews-autodiscover.h"
  86 #include "sipe-group.h"
  87 #include "sipe-groupchat.h"
  88 #include "sipe-http.h"
  89 #include "sipe-media.h"
  90 #include "sipe-mime.h"
  91 #include "sipe-nls.h"
  92 #include "sipe-ocs2007.h"
  93 #include "sipe-schedule.h"
  94 #include "sipe-session.h"
  95 #include "sipe-status.h"
  96 #include "sipe-subscriptions.h"
  97 #include "sipe-svc.h"
  98 #include "sipe-ucs.h"
  99 #include "sipe-utils.h"
 100 #include "sipe-webticket.h"
 101
 102 #ifdef PACKAGE_GIT_COMMIT
 103 #define SIPE_CORE_VERSION PACKAGE_VERSION " (git commit " PACKAGE_GIT_COMMIT ")"
 104 #else
 105 #define SIPE_CORE_VERSION PACKAGE_VERSION
 106 #endif
 107
 108 /* locale_dir is unused if ENABLE_NLS is not defined */
 109 void sipe_core_init(SIPE_UNUSED_PARAMETER const char *locale_dir)
 110 {
 111         srand(time(NULL));
 112         sip_sec_init();
 113
 114 #ifdef ENABLE_NLS
 115         SIPE_DEBUG_INFO("bindtextdomain = %s",
 116                         bindtextdomain(PACKAGE_NAME, locale_dir));
 117         SIPE_DEBUG_INFO("bind_textdomain_codeset = %s",
 118                         bind_textdomain_codeset(PACKAGE_NAME, "UTF-8"));
 119         textdomain(PACKAGE_NAME);
 120 #endif
 121         /* Initialization for crypto backend (production mode) */
 122         sipe_crypto_init(TRUE);
 123         sipe_mime_init();
 124         sipe_status_init();
 125 }
 126
 127 void sipe_core_destroy(void)
 128 {
 129         sipe_chat_destroy();
 130         sipe_status_shutdown();
 131         sipe_mime_shutdown();
 132         sipe_crypto_shutdown();
 133         sip_sec_destroy();
 134 }
 135
 136 gchar *sipe_core_about(void)
 137 {
 138         return g_strdup_printf(
 139                 /*
 140                  * Non-translatable parts, like markup, are hard-coded
 141                  * into the format string. This requires more translatable
 142                  * texts but it makes the translations less error prone.
 143                  */
 144                 "<b><font size=\"+1\">SIPE " SIPE_CORE_VERSION " </font></b><br/>"
 145                 "<br/>"
 146                 /* 1 */   "%s:<br/>"
 147                 "<li> - Microsoft Office 365</li><br/>"
 148                 "<li> - Microsoft Business Productivity Online Suite (BPOS)</li><br/>"
 149                 "<li> - Microsoft Lync Server</li><br/>"
 150                 "<li> - Microsoft Office Communications Server 2007 R2</li><br/>"
 151                 "<li> - Microsoft Office Communications Server 2007</li><br/>"
 152                 "<li> - Microsoft Live Communications Server 2005</li><br/>"
 153                 "<li> - Microsoft Live Communications Server 2003</li><br/>"
 154                 "<li> - Reuters Messaging</li><br/>"
 155                 "<br/>"
 156                 /* 2 */   "%s: <a href=\"" PACKAGE_URL "\">" PACKAGE_URL "</a><br/>"
 157                 /* 3,4 */ "%s: <a href=\"http://sourceforge.net/p/sipe/discussion/688534/\">%s</a><br/>"
 158                 /* 5,6 */   "%s: <a href=\"" PACKAGE_BUGREPORT "\">%s</a><br/>"
 159                 /* 7 */   "%s: <a href=\"" SIPE_TRANSLATIONS_URL "\">Transifex.com</a><br/>"
 160                 /* 8 */   "%s: GPLv2+<br/>"
 161                 "<br/>"
 162                 /* 9 */  "%s:<br/>"
 163                 " - CERN<br/>"
 164                 " - Reuters Messaging network<br/>"
 165                 " - Deutsche Bank<br/>"
 166                 " - Merrill Lynch<br/>"
 167                 " - Wachovia<br/>"
 168                 " - Intel<br/>"
 169                 " - Nokia<br/>"
 170                 " - HP<br/>"
 171                 " - Symantec<br/>"
 172                 " - Accenture<br/>"
 173                 " - Capgemini<br/>"
 174                 " - Siemens<br/>"
 175                 " - Alcatel-Lucent<br/>"
 176                 " - BT<br/>"
 177                 "<br/>"
 178                 /* 10,11 */ "%s<a href=\"" SIPE_TRANSLATIONS_URL "\">Transifex.com</a>%s.<br/>"
 179                 "<br/>"
 180                 /* 12 */  "<b>%s:</b><br/>"
 181                 " - Anibal Avelar<br/>"
 182                 " - Gabriel Burt<br/>"
 183                 " - Stefan Becker<br/>"
 184                 " - pier11<br/>"
 185                 " - Jakub Adam<br/>"
 186                 " - Tomáš Hrabčík<br/>"
 187                 "<br/>"
 188                 /* 13 */  "%s<br/>"
 189                 ,
 190                 /* The next 13 texts make up the SIPE about note text */
 191                 /* About note, part 1/13: introduction */
 192                 _("A third-party plugin implementing extended version of SIP/SIMPLE used by various products"),
 193                 /* About note, part 2/13: home page URL (label) */
 194                 _("Home Page"),
 195                 /* About note, part 3/13: support forum URL (label) */
 196                 _("Support"),
 197                 /* About note, part 4/13: support forum name (hyperlink text) */
 198                 _("Help Forum"),
 199                 /* About note, part 5/13: bug tracker URL (label) */
 200                 _("Report Problems"),
 201                 /* About note, part 6/13: bug tracker URL (hyperlink text) */
 202                 _("Bug Tracker"),
 203                 /* About note, part 7/13: translation service URL (label) */
 204                 _("Translations"),
 205                 /* About note, part 8/13: license type (label) */
 206                 _("License"),
 207                 /* About note, part 9/13: known users */
 208                 _("We support users in such organizations as"),
 209                 /* About note, part 10/13: translation request, text before Transifex.com URL */
 210                 /* append a space if text is not empty */
 211                 _("Please help us to translate SIPE to your native language here at "),
 212                 /* About note, part 11/13: translation request, text after Transifex.com URL */
 213                 /* start with a space if text is not empty */
 214                 _(" using convenient web interface"),
 215                 /* About note, part 12/13: author list (header) */
 216                 _("Authors"),
 217                 /* About note, part 13/13: Localization credit */
 218                 /* PLEASE NOTE: do *NOT* simply translate the english original */
 219                 /* but write something similar to the following sentence: */
 220                 /* "Localization for <language name> (<language code>): <name>" */
 221                 _("Original texts in English (en): SIPE developers")
 222                 );
 223 }
 224
 225 struct sipe_core_public *sipe_core_allocate(const gchar *signin_name,
 226                                             gboolean sso,
 227                                             const gchar *login_domain,
 228                                             const gchar *login_account,
 229                                             const gchar *password,
 230                                             const gchar *email,
 231                                             const gchar *email_url,
 232                                             const gchar **errmsg)
 233 {
 234         struct sipe_core_private *sipe_private;
 235         gchar **user_domain;
 236
 237         SIPE_DEBUG_INFO("sipe_core_allocate: SIPE version " SIPE_CORE_VERSION " signin_name '%s'", signin_name);
 238
 239         /* ensure that sign-in name doesn't contain invalid characters */
 240         if (strpbrk(signin_name, "\t\v\r\n") != NULL) {
 241                 *errmsg = _("SIP Exchange user name contains invalid characters");
 242                 return NULL;
 243         }
 244
 245         /* ensure that sign-in name format is name@domain */
 246         if (!strchr(signin_name, '@') ||
 247             g_str_has_prefix(signin_name, "@") ||
 248             g_str_has_suffix(signin_name, "@")) {
 249                 *errmsg = _("User name should be a valid SIP URI\nExample: user@company.com");
 250                 return NULL;
 251         }
 252
 253         /* ensure that Login & Password are valid when SSO is not selected */
 254         if (!sso && (is_empty(login_account) || is_empty(password))) {
 255                 *errmsg = _("Login and password are required when Single Sign-On is not enabled");
 256                 return NULL;
 257         }
 258
 259         /* ensure that email format is name@domain (if provided) */
 260         if (!is_empty(email) &&
 261             (!strchr(email, '@') ||
 262              g_str_has_prefix(email, "@") ||
 263              g_str_has_suffix(email, "@")))
 264         {
 265                 *errmsg = _("Email address should be valid if provided\nExample: user@company.com");
 266                 return NULL;
 267         }
 268
 269         /* ensure that user name doesn't contain spaces */
 270         user_domain = g_strsplit(signin_name, "@", 2);
 271         SIPE_DEBUG_INFO("sipe_core_allocate: user '%s' domain '%s'", user_domain[0], user_domain[1]);
 272         if (strchr(user_domain[0], ' ') != NULL) {
 273                 g_strfreev(user_domain);
 274                 *errmsg = _("SIP Exchange user name contains whitespace");
 275                 return NULL;
 276         }
 277
 278         /* ensure that email_url is in proper format if enabled (if provided).
 279          * Example (Exchange): https://server.company.com/EWS/Exchange.asmx
 280          * Example (Domino)  : https://[domino_server]/[mail_database_name].nsf
 281          */
 282         if (!is_empty(email_url)) {
 283                 char *tmp = g_ascii_strdown(email_url, -1);
 284                 if (!g_str_has_prefix(tmp, "https://"))
 285                 {
 286                         g_free(tmp);
 287                         g_strfreev(user_domain);
 288                         *errmsg = _("Email services URL should be valid if provided\n"
 289                                     "Example: https://exchange.corp.com/EWS/Exchange.asmx\n"
 290                                     "Example: https://domino.corp.com/maildatabase.nsf");
 291                         return NULL;
 292                 }
 293                 g_free(tmp);
 294         }
 295
 296         sipe_private = g_new0(struct sipe_core_private, 1);
 297         SIPE_CORE_PRIVATE_FLAG_UNSET(SUBSCRIBED_BUDDIES);
 298         SIPE_CORE_PRIVATE_FLAG_UNSET(INITIAL_PUBLISH);
 299         SIPE_CORE_PRIVATE_FLAG_UNSET(SSO);
 300         if (sso)
 301                 SIPE_CORE_PRIVATE_FLAG_SET(SSO);
 302         sipe_private->username   = g_strdup(signin_name);
 303         sipe_private->email      = is_empty(email) ? g_strdup(signin_name) : g_strdup(email);
 304         sipe_private->authdomain = sso             ? NULL                  : g_strdup(login_domain);
 305         sipe_private->authuser   = sso             ? NULL                  : g_strdup(login_account);
 306         sipe_private->password   = sso             ? NULL                  : g_strdup(password);
 307         sipe_private->public.sip_name   = g_strdup(user_domain[0]);
 308         sipe_private->public.sip_domain = g_strdup(user_domain[1]);
 309         g_strfreev(user_domain);
 310
 311         sipe_group_init(sipe_private);
 312         sipe_buddy_init(sipe_private);
 313         sipe_private->our_publications = g_hash_table_new_full(g_str_hash, g_str_equal,
 314                                                                g_free, (GDestroyNotify)g_hash_table_destroy);
 315         sipe_subscriptions_init(sipe_private);
 316         sipe_ews_autodiscover_init(sipe_private);
 317         sipe_status_set_activity(sipe_private, SIPE_ACTIVITY_UNSET);
 318
 319         return((struct sipe_core_public *)sipe_private);
 320 }
 321
 322 void sipe_core_backend_initialized(struct sipe_core_private *sipe_private,
 323                                    guint authentication)
 324 {
 325         const gchar *value;
 326
 327         sipe_private->authentication_type = authentication;
 328
 329         /* user specified email login? */
 330         value = sipe_backend_setting(SIPE_CORE_PUBLIC, SIPE_SETTING_EMAIL_LOGIN);
 331         if (!is_empty(value)) {
 332                 /* Allowed domain-account separators are / or \ */
 333                 gchar **domain_user = g_strsplit_set(value, "/\\", 2);
 334                 gboolean has_domain = domain_user[1] != NULL;
 335
 336                 sipe_private->email_authdomain = has_domain ? g_strdup(domain_user[0]) : NULL;
 337                 sipe_private->email_authuser   = g_strdup(domain_user[has_domain ? 1 : 0]);
 338                 sipe_private->email_password   = g_strdup(sipe_backend_setting(SIPE_CORE_PUBLIC,
 339                                                                                SIPE_SETTING_EMAIL_PASSWORD));
 340                 g_strfreev(domain_user);
 341         }
 342 }
 343
 344 void sipe_core_connection_cleanup(struct sipe_core_private *sipe_private)
 345 {
 346         g_free(sipe_private->epid);
 347         sipe_private->epid = NULL;
 348
 349         sipe_http_free(sipe_private);
 350         sip_transport_disconnect(sipe_private);
 351
 352         sipe_schedule_cancel_all(sipe_private);
 353
 354         if (sipe_private->allowed_events)
 355                 sipe_utils_slist_free_full(sipe_private->allowed_events, g_free);
 356
 357         sipe_ocs2007_free(sipe_private);
 358
 359         sipe_core_buddy_menu_free(SIPE_CORE_PUBLIC);
 360
 361         if (sipe_private->contact)
 362                 g_free(sipe_private->contact);
 363         sipe_private->contact = NULL;
 364         if (sipe_private->register_callid)
 365                 g_free(sipe_private->register_callid);
 366         sipe_private->register_callid = NULL;
 367
 368         if (sipe_private->focus_factory_uri)
 369                 g_free(sipe_private->focus_factory_uri);
 370         sipe_private->focus_factory_uri = NULL;
 371
 372         sipe_groupchat_free(sipe_private);
 373 }
 374
 375 void sipe_core_deallocate(struct sipe_core_public *sipe_public)
 376 {
 377         struct sipe_core_private *sipe_private = SIPE_CORE_PRIVATE;
 378
 379 #ifdef HAVE_VV
 380         if (sipe_private->media_call) {
 381                 sipe_media_handle_going_offline(sipe_private->media_call);
 382         }
 383 #endif
 384
 385         /* leave all conversations */
 386         if (sipe_private->sessions) {
 387                 GSList *entry;
 388                 while ((entry = sipe_private->sessions) != NULL) {
 389                         sipe_session_close(sipe_private, entry->data);
 390                 }
 391         }
 392
 393         sipe_conf_cancel_unaccepted(sipe_private, NULL);
 394
 395         if (sipe_private->csta) {
 396                 sip_csta_close(sipe_private);
 397         }
 398
 399         /* pending service requests must be cancelled first */
 400         sipe_svc_free(sipe_private);
 401         sipe_webticket_free(sipe_private);
 402         sipe_ucs_free(sipe_private);
 403
 404         if (sipe_backend_connection_is_valid(SIPE_CORE_PUBLIC)) {
 405                 sipe_subscriptions_unsubscribe(sipe_private);
 406                 sip_transport_deregister(sipe_private);
 407         }
 408
 409         sipe_core_connection_cleanup(sipe_private);
 410         sipe_ews_autodiscover_free(sipe_private);
 411         sipe_cal_calendar_free(sipe_private->calendar);
 412         sipe_certificate_free(sipe_private);
 413
 414         g_free(sipe_private->public.sip_name);
 415         g_free(sipe_private->public.sip_domain);
 416         g_free(sipe_private->username);
 417         g_free(sipe_private->email_password);
 418         g_free(sipe_private->email_authuser);
 419         g_free(sipe_private->email_authdomain);
 420         g_free(sipe_private->email);
 421         g_free(sipe_private->password);
 422         g_free(sipe_private->authdomain);
 423         g_free(sipe_private->authuser);
 424         g_free(sipe_private->status);
 425         g_free(sipe_private->note);
 426         g_free(sipe_private->ocs2005_user_states);
 427
 428         sipe_buddy_free(sipe_private);
 429         g_hash_table_destroy(sipe_private->our_publications);
 430         g_hash_table_destroy(sipe_private->user_state_publications);
 431         sipe_subscriptions_destroy(sipe_private);
 432         sipe_group_free(sipe_private);
 433
 434         if (sipe_private->our_publication_keys)
 435                 sipe_utils_slist_free_full(sipe_private->our_publication_keys, g_free);
 436
 437 #ifdef HAVE_VV
 438         g_free(sipe_private->test_call_bot_uri);
 439         g_free(sipe_private->uc_line_uri);
 440         g_free(sipe_private->mras_uri);
 441         g_free(sipe_private->media_relay_username);
 442         g_free(sipe_private->media_relay_password);
 443         sipe_media_relay_list_free(sipe_private->media_relays);
 444 #endif
 445
 446         g_free(sipe_private->persistentChatPool_uri);
 447         g_free(sipe_private->addressbook_uri);
 448         g_free(sipe_private->dlx_uri);
 449         g_free(sipe_private);
 450 }
 451
 452 void sipe_core_email_authentication(struct sipe_core_private *sipe_private,
 453                                     struct sipe_http_request *request)
 454 {
 455         if (sipe_private->email_authuser) {
 456                 sipe_http_request_authentication(request,
 457                                                  sipe_private->email_authdomain,
 458                                                  sipe_private->email_authuser,
 459                                                  sipe_private->email_password);
 460         }
 461 }
 462
 463 /*
 464   Local Variables:
 465   mode: c
 466   c-file-style: "bsd"
 467   indent-tabs-mode: t
 468   tab-width: 8
 469   End:
 470 */