6 * Copyright (C) 2010-11 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-group.h"
86 #include "sipe-groupchat.h"
87 #include "sipe-media.h"
88 #include "sipe-mime.h"
90 #include "sipe-ocs2007.h"
91 #include "sipe-schedule.h"
92 #include "sipe-session.h"
93 #include "sipe-status.h"
94 #include "sipe-subscriptions.h"
96 #include "sipe-utils.h"
98 /* locale_dir is unused if ENABLE_NLS is not defined */
99 void sipe_core_init(SIPE_UNUSED_PARAMETER
const char *locale_dir
)
105 SIPE_DEBUG_INFO("bindtextdomain = %s",
106 bindtextdomain(PACKAGE_NAME
, locale_dir
));
107 SIPE_DEBUG_INFO("bind_textdomain_codeset = %s",
108 bind_textdomain_codeset(PACKAGE_NAME
, "UTF-8"));
109 textdomain(PACKAGE_NAME
);
111 /* Initialization for crypto backend (production mode) */
112 sipe_crypto_init(TRUE
);
117 void sipe_core_destroy(void)
120 sipe_status_shutdown();
121 sipe_mime_shutdown();
122 sipe_crypto_shutdown();
126 gchar
*sipe_core_about(void)
128 return g_strdup_printf(
130 * Non-translatable parts, like markup, are hard-coded
131 * into the format string. This requires more translatable
132 * texts but it makes the translations less error prone.
134 "<b><font size=\"+1\">SIPE " PACKAGE_VERSION
" </font></b><br/>"
137 "<li> - Microsoft Lync Server 2010</li><br/>"
138 "<li> - Microsoft Office Communications Server 2007 R2</li><br/>"
139 "<li> - Microsoft Office Communications Server 2007</li><br/>"
140 "<li> - Microsoft Live Communications Server 2005</li><br/>"
141 "<li> - Microsoft Live Communications Server 2003</li><br/>"
142 "<li> - Reuters Messaging</li><br/>"
144 /* 2 */ "%s: <a href=\"" PACKAGE_URL
"\">" PACKAGE_URL
"</a><br/>"
145 /* 3,4 */ "%s: <a href=\"http://sourceforge.net/projects/sipe/forums/forum/688534\">%s</a><br/>"
146 /* 5,6 */ "%s: <a href=\"" PACKAGE_BUGREPORT
"\">%s</a><br/>"
147 /* 7 */ "%s: <a href=\"" SIPE_TRANSLATIONS_URL
"\">Transifex.net</a><br/>"
148 /* 8 */ "%s: GPLv2+<br/>"
152 " - Reuters Messaging network<br/>"
153 " - Deutsche Bank<br/>"
154 " - Merrill Lynch<br/>"
163 " - Alcatel-Lucent<br/>"
166 /* 10,11 */ "%s<a href=\"" SIPE_TRANSLATIONS_URL
"\">Transifex.net</a>%s.<br/>"
168 /* 12 */ "<b>%s:</b><br/>"
169 " - Anibal Avelar<br/>"
170 " - Gabriel Burt<br/>"
171 " - Stefan Becker<br/>"
174 " - Tomáš Hrabčík<br/>"
178 /* The next 13 texts make up the SIPE about note text */
179 /* About note, part 1/13: introduction */
180 _("A third-party plugin implementing extended version of SIP/SIMPLE used by various products"),
181 /* About note, part 2/13: home page URL (label) */
183 /* About note, part 3/13: support forum URL (label) */
185 /* About note, part 4/13: support forum name (hyperlink text) */
187 /* About note, part 5/13: bug tracker URL (label) */
188 _("Report Problems"),
189 /* About note, part 6/13: bug tracker URL (hyperlink text) */
191 /* About note, part 7/13: translation service URL (label) */
193 /* About note, part 8/13: license type (label) */
195 /* About note, part 9/13: known users */
196 _("We support users in such organizations as"),
197 /* About note, part 10/13: translation request, text before Transifex.net URL */
198 /* append a space if text is not empty */
199 _("Please help us to translate SIPE to your native language here at "),
200 /* About note, part 11/13: translation request, text after Transifex.net URL */
201 /* start with a space if text is not empty */
202 _(" using convenient web interface"),
203 /* About note, part 12/13: author list (header) */
205 /* About note, part 13/13: Localization credit */
206 /* PLEASE NOTE: do *NOT* simply translate the english original */
207 /* but write something similar to the following sentence: */
208 /* "Localization for <language name> (<language code>): <name>" */
209 _("Original texts in English (en): SIPE developers")
213 static guint
sipe_ht_hash_nick(const char *nick
)
215 char *lc
= g_utf8_strdown(nick
, -1);
216 guint bucket
= g_str_hash(lc
);
222 static gboolean
sipe_ht_equals_nick(const char *nick1
, const char *nick2
)
224 char *nick1_norm
= NULL
;
225 char *nick2_norm
= NULL
;
228 if (nick1
== NULL
&& nick2
== NULL
) return TRUE
;
229 if (nick1
== NULL
|| nick2
== NULL
||
230 !g_utf8_validate(nick1
, -1, NULL
) ||
231 !g_utf8_validate(nick2
, -1, NULL
)) return FALSE
;
233 nick1_norm
= g_utf8_casefold(nick1
, -1);
234 nick2_norm
= g_utf8_casefold(nick2
, -1);
235 equal
= g_utf8_collate(nick1_norm
, nick2_norm
) == 0;
242 struct sipe_core_public
*sipe_core_allocate(const gchar
*signin_name
,
243 const gchar
*login_domain
,
244 const gchar
*login_account
,
245 const gchar
*password
,
247 const gchar
*email_url
,
248 const gchar
**errmsg
)
250 struct sipe_core_private
*sipe_private
;
253 SIPE_DEBUG_INFO("sipe_core_allocate: signin_name '%s'", signin_name
);
255 /* ensure that sign-in name doesn't contain invalid characters */
256 if (strpbrk(signin_name
, "\t\v\r\n") != NULL
) {
257 *errmsg
= _("SIP Exchange user name contains invalid characters");
261 /* ensure that sign-in name format is name@domain */
262 if (!strchr(signin_name
, '@') ||
263 g_str_has_prefix(signin_name
, "@") ||
264 g_str_has_suffix(signin_name
, "@")) {
265 *errmsg
= _("User name should be a valid SIP URI\nExample: user@company.com");
269 /* ensure that email format is name@domain (if provided) */
270 if (!is_empty(email
) &&
271 (!strchr(email
, '@') ||
272 g_str_has_prefix(email
, "@") ||
273 g_str_has_suffix(email
, "@")))
275 *errmsg
= _("Email address should be valid if provided\nExample: user@company.com");
279 /* ensure that user name doesn't contain spaces */
280 user_domain
= g_strsplit(signin_name
, "@", 2);
281 SIPE_DEBUG_INFO("sipe_core_allocate: user '%s' domain '%s'", user_domain
[0], user_domain
[1]);
282 if (strchr(user_domain
[0], ' ') != NULL
) {
283 g_strfreev(user_domain
);
284 *errmsg
= _("SIP Exchange user name contains whitespace");
288 /* ensure that email_url is in proper format if enabled (if provided).
289 * Example (Exchange): https://server.company.com/EWS/Exchange.asmx
290 * Example (Domino) : https://[domino_server]/[mail_database_name].nsf
292 if (!is_empty(email_url
)) {
293 char *tmp
= g_ascii_strdown(email_url
, -1);
294 if (!g_str_has_prefix(tmp
, "https://"))
297 g_strfreev(user_domain
);
298 *errmsg
= _("Email services URL should be valid if provided\n"
299 "Example: https://exchange.corp.com/EWS/Exchange.asmx\n"
300 "Example: https://domino.corp.com/maildatabase.nsf");
306 sipe_private
= g_new0(struct sipe_core_private
, 1);
307 SIPE_CORE_PRIVATE_FLAG_UNSET(SUBSCRIBED_BUDDIES
);
308 SIPE_CORE_PRIVATE_FLAG_UNSET(INITIAL_PUBLISH
);
309 sipe_private
->username
= g_strdup(signin_name
);
310 sipe_private
->email
= is_empty(email
) ? g_strdup(signin_name
) : g_strdup(email
);
311 sipe_private
->authdomain
= is_empty(login_domain
) ? NULL
: g_strdup(login_domain
);
312 sipe_private
->authuser
= is_empty(login_account
) ? NULL
: g_strdup(login_account
);
313 sipe_private
->password
= g_strdup(password
);
314 sipe_private
->public.sip_name
= g_strdup(user_domain
[0]);
315 sipe_private
->public.sip_domain
= g_strdup(user_domain
[1]);
316 g_strfreev(user_domain
);
318 sipe_private
->buddies
= g_hash_table_new((GHashFunc
)sipe_ht_hash_nick
, (GEqualFunc
)sipe_ht_equals_nick
);
319 sipe_private
->our_publications
= g_hash_table_new_full(g_str_hash
, g_str_equal
,
320 g_free
, (GDestroyNotify
)g_hash_table_destroy
);
321 sipe_subscriptions_init(sipe_private
);
322 sipe_status_set_activity(sipe_private
, SIPE_ACTIVITY_UNSET
);
324 return((struct sipe_core_public
*)sipe_private
);
327 void sipe_core_connection_cleanup(struct sipe_core_private
*sipe_private
)
329 g_free(sipe_private
->epid
);
330 sipe_private
->epid
= NULL
;
332 sip_transport_disconnect(sipe_private
);
334 sipe_schedule_cancel_all(sipe_private
);
336 if (sipe_private
->allowed_events
) {
337 GSList
*entry
= sipe_private
->allowed_events
;
343 g_slist_free(sipe_private
->allowed_events
);
345 sipe_ocs2007_free(sipe_private
);
347 sipe_core_buddy_menu_free(SIPE_CORE_PUBLIC
);
349 if (sipe_private
->contact
)
350 g_free(sipe_private
->contact
);
351 sipe_private
->contact
= NULL
;
352 if (sipe_private
->register_callid
)
353 g_free(sipe_private
->register_callid
);
354 sipe_private
->register_callid
= NULL
;
356 if (sipe_private
->focus_factory_uri
)
357 g_free(sipe_private
->focus_factory_uri
);
358 sipe_private
->focus_factory_uri
= NULL
;
360 if (sipe_private
->calendar
) {
361 sipe_cal_calendar_free(sipe_private
->calendar
);
363 sipe_private
->calendar
= NULL
;
365 sipe_groupchat_free(sipe_private
);
368 void sipe_core_deallocate(struct sipe_core_public
*sipe_public
)
370 struct sipe_core_private
*sipe_private
= SIPE_CORE_PRIVATE
;
373 if (sipe_private
->media_call
) {
374 sipe_media_handle_going_offline(sipe_private
->media_call
);
378 /* leave all conversations */
379 if (sipe_private
->sessions
) {
381 while ((entry
= sipe_private
->sessions
) != NULL
) {
382 sipe_session_close(sipe_private
, entry
->data
);
386 sipe_conf_cancel_unaccepted(sipe_private
, NULL
);
388 if (sipe_private
->csta
) {
389 sip_csta_close(sipe_private
);
392 sipe_certificate_free(sipe_private
);
393 sipe_svc_free(sipe_private
);
395 if (sipe_backend_connection_is_valid(SIPE_CORE_PUBLIC
)) {
396 sipe_subscriptions_unsubscribe(sipe_private
);
397 sip_transport_deregister(sipe_private
);
400 sipe_core_connection_cleanup(sipe_private
);
401 g_free(sipe_private
->public.sip_name
);
402 g_free(sipe_private
->public.sip_domain
);
403 g_free(sipe_private
->username
);
404 g_free(sipe_private
->email
);
405 g_free(sipe_private
->password
);
406 g_free(sipe_private
->authdomain
);
407 g_free(sipe_private
->authuser
);
408 g_free(sipe_private
->status
);
409 g_free(sipe_private
->note
);
410 g_free(sipe_private
->ocs2005_user_states
);
412 sipe_buddy_free_all(sipe_private
);
413 g_hash_table_destroy(sipe_private
->buddies
);
414 g_hash_table_destroy(sipe_private
->our_publications
);
415 g_hash_table_destroy(sipe_private
->user_state_publications
);
416 sipe_subscriptions_destroy(sipe_private
);
418 if (sipe_private
->groups
) {
419 GSList
*entry
= sipe_private
->groups
;
421 struct sipe_group
*group
= entry
->data
;
427 g_slist_free(sipe_private
->groups
);
429 if (sipe_private
->our_publication_keys
) {
430 GSList
*entry
= sipe_private
->our_publication_keys
;
436 g_slist_free(sipe_private
->our_publication_keys
);
439 g_free(sipe_private
->test_call_bot_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
);
446 g_free(sipe_private
->dlx_uri
);
447 g_free(sipe_private
);