6 * Copyright (C) 2010-2013 SIPE Project <http://sipe.sourceforge.net/>
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.
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.
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
23 * Some notes on the history of this project/code/copyrights:
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
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
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).
40 * - the original copyright notices from sipe.c have been moved to this
41 * file (see below) and *MUST* be preserved!
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"
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.
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>
58 * Thanks to Google's Summer of Code Program and the helpful mentors
60 *------------------- Copyright notices from "sipe.c" ---------------
72 #include "sipe-common.h"
75 #include "sip-transport.h"
76 #include "sipe-backend.h"
77 #include "sipe-buddy.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"
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"
99 #include "sipe-utils.h"
100 #include "sipe-webticket.h"
102 #ifdef PACKAGE_GIT_COMMIT
103 #define SIPE_CORE_VERSION PACKAGE_VERSION " (git commit " PACKAGE_GIT_COMMIT ")"
105 #define SIPE_CORE_VERSION PACKAGE_VERSION
108 /* locale_dir is unused if ENABLE_NLS is not defined */
109 void sipe_core_init(SIPE_UNUSED_PARAMETER
const char *locale_dir
)
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
);
121 /* Initialization for crypto backend (production mode) */
122 sipe_crypto_init(TRUE
);
127 void sipe_core_destroy(void)
130 sipe_status_shutdown();
131 sipe_mime_shutdown();
132 sipe_crypto_shutdown();
136 gchar
*sipe_core_about(void)
138 return g_strdup_printf(
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.
144 "<b><font size=\"+1\">SIPE " SIPE_CORE_VERSION
" </font></b><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/>"
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/>"
164 " - Reuters Messaging network<br/>"
165 " - Deutsche Bank<br/>"
166 " - Merrill Lynch<br/>"
175 " - Alcatel-Lucent<br/>"
178 /* 10,11 */ "%s<a href=\"" SIPE_TRANSLATIONS_URL
"\">Transifex.com</a>%s.<br/>"
180 /* 12 */ "<b>%s:</b><br/>"
181 " - Anibal Avelar<br/>"
182 " - Gabriel Burt<br/>"
183 " - Stefan Becker<br/>"
186 " - Tomáš Hrabčík<br/>"
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) */
195 /* About note, part 3/13: support forum URL (label) */
197 /* About note, part 4/13: support forum name (hyperlink text) */
199 /* About note, part 5/13: bug tracker URL (label) */
200 _("Report Problems"),
201 /* About note, part 6/13: bug tracker URL (hyperlink text) */
203 /* About note, part 7/13: translation service URL (label) */
205 /* About note, part 8/13: license type (label) */
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) */
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")
225 struct sipe_core_public
*sipe_core_allocate(const gchar
*signin_name
,
227 const gchar
*login_domain
,
228 const gchar
*login_account
,
229 const gchar
*password
,
231 const gchar
*email_url
,
232 const gchar
**errmsg
)
234 struct sipe_core_private
*sipe_private
;
237 SIPE_DEBUG_INFO("sipe_core_allocate: SIPE version " SIPE_CORE_VERSION
" signin_name '%s'", signin_name
);
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");
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");
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");
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
, "@")))
265 *errmsg
= _("Email address should be valid if provided\nExample: user@company.com");
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");
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
282 if (!is_empty(email_url
)) {
283 char *tmp
= g_ascii_strdown(email_url
, -1);
284 if (!g_str_has_prefix(tmp
, "https://"))
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");
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
);
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
);
311 sipe_buddy_init(sipe_private
);
312 sipe_private
->our_publications
= g_hash_table_new_full(g_str_hash
, g_str_equal
,
313 g_free
, (GDestroyNotify
)g_hash_table_destroy
);
314 sipe_subscriptions_init(sipe_private
);
315 sipe_ews_autodiscover_init(sipe_private
);
316 sipe_status_set_activity(sipe_private
, SIPE_ACTIVITY_UNSET
);
318 return((struct sipe_core_public
*)sipe_private
);
321 void sipe_core_backend_initialized(struct sipe_core_private
*sipe_private
,
322 guint authentication
)
326 sipe_private
->authentication_type
= authentication
;
328 /* user specified email login? */
329 value
= sipe_backend_setting(SIPE_CORE_PUBLIC
, SIPE_SETTING_EMAIL_LOGIN
);
330 if (!is_empty(value
)) {
331 /* Allowed domain-account separators are / or \ */
332 gchar
**domain_user
= g_strsplit_set(value
, "/\\", 2);
333 gboolean has_domain
= domain_user
[1] != NULL
;
335 sipe_private
->email_authdomain
= has_domain
? g_strdup(domain_user
[0]) : NULL
;
336 sipe_private
->email_authuser
= g_strdup(domain_user
[has_domain
? 1 : 0]);
337 sipe_private
->email_password
= g_strdup(sipe_backend_setting(SIPE_CORE_PUBLIC
,
338 SIPE_SETTING_EMAIL_PASSWORD
));
339 g_strfreev(domain_user
);
343 void sipe_core_connection_cleanup(struct sipe_core_private
*sipe_private
)
345 g_free(sipe_private
->epid
);
346 sipe_private
->epid
= NULL
;
348 sipe_http_free(sipe_private
);
349 sip_transport_disconnect(sipe_private
);
351 sipe_schedule_cancel_all(sipe_private
);
353 if (sipe_private
->allowed_events
)
354 sipe_utils_slist_free_full(sipe_private
->allowed_events
, g_free
);
356 sipe_ocs2007_free(sipe_private
);
358 sipe_core_buddy_menu_free(SIPE_CORE_PUBLIC
);
360 if (sipe_private
->contact
)
361 g_free(sipe_private
->contact
);
362 sipe_private
->contact
= NULL
;
363 if (sipe_private
->register_callid
)
364 g_free(sipe_private
->register_callid
);
365 sipe_private
->register_callid
= NULL
;
367 if (sipe_private
->focus_factory_uri
)
368 g_free(sipe_private
->focus_factory_uri
);
369 sipe_private
->focus_factory_uri
= NULL
;
371 sipe_groupchat_free(sipe_private
);
374 void sipe_core_deallocate(struct sipe_core_public
*sipe_public
)
376 struct sipe_core_private
*sipe_private
= SIPE_CORE_PRIVATE
;
379 if (sipe_private
->media_call
) {
380 sipe_media_handle_going_offline(sipe_private
->media_call
);
384 /* leave all conversations */
385 if (sipe_private
->sessions
) {
387 while ((entry
= sipe_private
->sessions
) != NULL
) {
388 sipe_session_close(sipe_private
, entry
->data
);
392 sipe_conf_cancel_unaccepted(sipe_private
, NULL
);
394 if (sipe_private
->csta
) {
395 sip_csta_close(sipe_private
);
398 /* pending service requests must be cancelled first */
399 sipe_svc_free(sipe_private
);
400 sipe_webticket_free(sipe_private
);
402 if (sipe_backend_connection_is_valid(SIPE_CORE_PUBLIC
)) {
403 sipe_subscriptions_unsubscribe(sipe_private
);
404 sip_transport_deregister(sipe_private
);
407 sipe_core_connection_cleanup(sipe_private
);
408 sipe_ews_autodiscover_free(sipe_private
);
409 sipe_ucs_free(sipe_private
);
410 sipe_cal_calendar_free(sipe_private
->calendar
);
411 sipe_certificate_free(sipe_private
);
413 g_free(sipe_private
->public.sip_name
);
414 g_free(sipe_private
->public.sip_domain
);
415 g_free(sipe_private
->username
);
416 g_free(sipe_private
->email_password
);
417 g_free(sipe_private
->email_authuser
);
418 g_free(sipe_private
->email_authdomain
);
419 g_free(sipe_private
->email
);
420 g_free(sipe_private
->password
);
421 g_free(sipe_private
->authdomain
);
422 g_free(sipe_private
->authuser
);
423 g_free(sipe_private
->status
);
424 g_free(sipe_private
->note
);
425 g_free(sipe_private
->ocs2005_user_states
);
427 sipe_buddy_free(sipe_private
);
428 g_hash_table_destroy(sipe_private
->our_publications
);
429 g_hash_table_destroy(sipe_private
->user_state_publications
);
430 sipe_subscriptions_destroy(sipe_private
);
432 if (sipe_private
->groups
) {
434 while ((entry
= sipe_private
->groups
) != NULL
)
435 sipe_group_free(sipe_private
, entry
->data
);
438 if (sipe_private
->our_publication_keys
)
439 sipe_utils_slist_free_full(sipe_private
->our_publication_keys
, g_free
);
442 g_free(sipe_private
->test_call_bot_uri
);
443 g_free(sipe_private
->uc_line_uri
);
444 g_free(sipe_private
->mras_uri
);
445 g_free(sipe_private
->media_relay_username
);
446 g_free(sipe_private
->media_relay_password
);
447 sipe_media_relay_list_free(sipe_private
->media_relays
);
450 g_free(sipe_private
->persistentChatPool_uri
);
451 g_free(sipe_private
->addressbook_uri
);
452 g_free(sipe_private
->dlx_uri
);
453 g_free(sipe_private
);
456 void sipe_core_email_authentication(struct sipe_core_private
*sipe_private
,
457 struct sipe_http_request
*request
)
459 if (sipe_private
->email_authuser
) {
460 sipe_http_request_authentication(request
,
461 sipe_private
->email_authdomain
,
462 sipe_private
->email_authuser
,
463 sipe_private
->email_password
);