friend.c 42.4 KB
Newer Older
aymeric's avatar
aymeric committed
1 2 3 4
/***************************************************************************
 *            friend.c
 *
 *  Sat May 15 15:25:16 2004
5
 *  Copyright  2004-2009  Simon Morlat
aymeric's avatar
aymeric committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
 *  Email
 ****************************************************************************/

/*
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Library General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#include "linphonecore.h"
#include "private.h"
#include "lpconfig.h"

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
#ifdef FRIENDS_SQL_STORAGE_ENABLED
#ifndef _WIN32
#if !defined(ANDROID) && !defined(__QNXNTO__)
#	include <langinfo.h>
#	include <iconv.h>
#	include <string.h>
#endif
#else
#include <Windows.h>
#endif

#define MAX_PATH_SIZE 1024
#include "sqlite3.h"
#endif

aymeric's avatar
aymeric committed
44 45 46
const char *linphone_online_status_to_string(LinphoneOnlineStatus ss){
	const char *str=NULL;
	switch(ss){
47
		case LinphoneStatusOnline:
aymeric's avatar
aymeric committed
48 49
		str=_("Online");
		break;
50
		case LinphoneStatusBusy:
aymeric's avatar
aymeric committed
51 52
		str=_("Busy");
		break;
53
		case LinphoneStatusBeRightBack:
aymeric's avatar
aymeric committed
54 55
		str=_("Be right back");
		break;
56
		case LinphoneStatusAway:
aymeric's avatar
aymeric committed
57 58
		str=_("Away");
		break;
59
		case LinphoneStatusOnThePhone:
aymeric's avatar
aymeric committed
60 61
		str=_("On the phone");
		break;
62
		case LinphoneStatusOutToLunch:
aymeric's avatar
aymeric committed
63 64
		str=_("Out to lunch");
		break;
65
		case LinphoneStatusDoNotDisturb:
aymeric's avatar
aymeric committed
66 67
		str=_("Do not disturb");
		break;
68
		case LinphoneStatusMoved:
aymeric's avatar
aymeric committed
69 70
		str=_("Moved");
		break;
71
		case LinphoneStatusAltService:
aymeric's avatar
aymeric committed
72 73
		str=_("Using another messaging service");
		break;
74
		case LinphoneStatusOffline:
aymeric's avatar
aymeric committed
75 76
		str=_("Offline");
		break;
77
		case LinphoneStatusPending:
aymeric's avatar
aymeric committed
78 79
		str=_("Pending");
		break;
80 81
		case LinphoneStatusVacation:
		str=_("Vacation");
aymeric's avatar
aymeric committed
82
		default:
Gautier Pelloux-Prayer's avatar
Gautier Pelloux-Prayer committed
83
		str=_("Unknown status");
aymeric's avatar
aymeric committed
84 85 86 87
	}
	return str;
}

Simon Morlat's avatar
Simon Morlat committed
88
static int friend_compare(const void * a, const void * b){
89 90
	LinphoneAddress *fa=((LinphoneFriend*)a)->uri;
	LinphoneAddress *fb=((LinphoneFriend*)b)->uri;
91
	if (linphone_address_weak_equal(fa,fb)) return 0;
Simon Morlat's avatar
Simon Morlat committed
92
	return 1;
aymeric's avatar
aymeric committed
93 94 95
}


Ghislain MARY's avatar
Ghislain MARY committed
96
MSList *linphone_find_friend_by_address(MSList *fl, const LinphoneAddress *addr, LinphoneFriend **lf){
aymeric's avatar
aymeric committed
97 98 99
	MSList *res=NULL;
	LinphoneFriend dummy;
	if (lf!=NULL) *lf=NULL;
100
	dummy.uri=(LinphoneAddress*)addr;
aymeric's avatar
aymeric committed
101 102 103 104 105 106
	res=ms_list_find_custom(fl,friend_compare,&dummy);
	if (lf!=NULL && res!=NULL) *lf=(LinphoneFriend*)res->data;
	return res;
}

void __linphone_friend_do_subscribe(LinphoneFriend *fr){
Simon Morlat's avatar
Simon Morlat committed
107
	LinphoneCore *lc=fr->lc;
108

109
	if (fr->outsub==NULL){
aymeric's avatar
aymeric committed
110
		/* people for which we don't have yet an answer should appear as offline */
111
		fr->presence=NULL;
112
		/*
113
		if (fr->lc->vtable.notify_recv)
114
			fr->lc->vtable.notify_recv(fr->lc,(LinphoneFriend*)fr);
115
		 */
116 117 118 119
	}else{
		sal_op_release(fr->outsub);
		fr->outsub=NULL;
	}
Simon Morlat's avatar
Simon Morlat committed
120 121
	fr->outsub=sal_op_new(lc->sal);
	linphone_configure_op(lc,fr->outsub,fr->uri,NULL,TRUE);
Simon Morlat's avatar
Simon Morlat committed
122
	sal_subscribe_presence(fr->outsub,NULL,NULL,lp_config_get_int(lc->config,"sip","subscribe_expires",600));
123
	fr->subscribe_active=TRUE;
aymeric's avatar
aymeric committed
124 125
}

126
LinphoneFriend * linphone_friend_new(void){
127 128 129 130
	LinphoneFriend *obj = belle_sip_object_new(LinphoneFriend);
	obj->pol = LinphoneSPAccept;
	obj->presence = NULL;
	obj->subscribe = TRUE;
131
	obj->vcard = NULL;
132
	obj->storage_id = 0;
133
	return obj;
aymeric's avatar
aymeric committed
134 135
}

Ghislain MARY's avatar
Ghislain MARY committed
136
LinphoneFriend *linphone_friend_new_with_address(const char *addr){
jehan's avatar
jehan committed
137
	LinphoneAddress* linphone_address = linphone_address_new(addr);
Sylvain Berfini's avatar
Sylvain Berfini committed
138 139
	LinphoneFriend *fr;

jehan's avatar
jehan committed
140 141 142 143
	if (linphone_address == NULL) {
		ms_error("Cannot create friend for address [%s]",addr?addr:"null");
		return NULL;
	}
Sylvain Berfini's avatar
Sylvain Berfini committed
144
	fr=linphone_friend_new();
Ghislain MARY's avatar
Ghislain MARY committed
145
	linphone_friend_set_address(fr,linphone_address);
146
	linphone_address_unref(linphone_address);
aymeric's avatar
aymeric committed
147 148 149
	return fr;
}

Simon Morlat's avatar
Simon Morlat committed
150
void linphone_friend_set_user_data(LinphoneFriend *lf, void *data){
151
	lf->user_data=data;
Simon Morlat's avatar
Simon Morlat committed
152 153 154
}

void* linphone_friend_get_user_data(const LinphoneFriend *lf){
155
	return lf->user_data;
Simon Morlat's avatar
Simon Morlat committed
156 157
}

158 159
bool_t linphone_friend_in_list(const LinphoneFriend *lf) {
	return lf->friend_list != NULL;
160 161
}

smorlat's avatar
smorlat committed
162
void linphone_core_interpret_friend_uri(LinphoneCore *lc, const char *uri, char **result){
163
	LinphoneAddress *fr=NULL;
164
	*result=NULL;
165
	fr=linphone_address_new(uri);
166
	if (fr==NULL){
smorlat's avatar
smorlat committed
167 168
		char *tmp=NULL;
		if (strchr(uri,'@')!=NULL){
169
			LinphoneAddress *u;
smorlat's avatar
smorlat committed
170 171
			/*try adding sip:*/
			tmp=ms_strdup_printf("sip:%s",uri);
172
			u=linphone_address_new(tmp);
173 174 175
			if (u!=NULL){
				*result=tmp;
			}
smorlat's avatar
smorlat committed
176 177
		}else if (lc->default_proxy!=NULL){
			/*try adding domain part from default current proxy*/
178
			LinphoneAddress * id=linphone_address_new(linphone_core_get_identity(lc));
179
			if ((id!=NULL) && (uri[0] != '\0')){
180
				linphone_address_set_display_name(id,NULL);
181 182
				linphone_address_set_username(id,uri);
				*result=linphone_address_as_string(id);
183
				linphone_address_unref(id);
smorlat's avatar
smorlat committed
184 185
			}
		}
186
		if (*result){
smorlat's avatar
smorlat committed
187
			/*looks good */
188 189 190 191
			ms_message("%s interpreted as %s",uri,*result);
		}else{
			ms_warning("Fail to interpret friend uri %s",uri);
		}
jehan's avatar
jehan committed
192 193
	}else {
		*result=linphone_address_as_string(fr);
194
		linphone_address_unref(fr);
jehan's avatar
jehan committed
195
	}
smorlat's avatar
smorlat committed
196
}
aymeric's avatar
aymeric committed
197

198 199 200 201
const LinphoneAddress *linphone_friend_get_address(const LinphoneFriend *lf){
	return lf->uri;
}

202
int linphone_friend_set_address(LinphoneFriend *lf, const LinphoneAddress *addr){
203
	LinphoneAddress *fr = linphone_address_clone(addr);
204
	LinphoneVcard *vcard = NULL;
205
	
206
	linphone_address_clean(fr);
207
	if (lf->uri != NULL) linphone_address_unref(lf->uri);
208 209
	lf->uri = fr;
	
210 211 212 213 214
	vcard = linphone_friend_get_vcard(lf);
	if (vcard) {
		linphone_vcard_edit_main_sip_address(vcard, linphone_address_as_string_uri_only(fr));
	}
	
aymeric's avatar
aymeric committed
215 216 217
	return 0;
}

218 219 220 221 222 223 224 225 226 227 228 229 230 231
void linphone_friend_add_address(LinphoneFriend *lf, const LinphoneAddress *addr) {
	LinphoneVcard *vcard = NULL;
	if (!lf || !addr) {
		return;
	}
	
	vcard = linphone_friend_get_vcard(lf);
	if (!vcard) {
		return;
	}
	
	linphone_vcard_add_sip_address(vcard, linphone_address_as_string_uri_only(addr));
}

Sylvain Berfini's avatar
Sylvain Berfini committed
232
MSList* linphone_friend_get_addresses(LinphoneFriend *lf) {
233 234 235
	LinphoneVcard *vcard = NULL;
	MSList *sipAddresses = NULL;
	MSList *addresses = NULL;
Sylvain Berfini's avatar
Sylvain Berfini committed
236
	MSList *iterator = NULL;
237 238 239 240 241 242 243 244 245 246 247
	
	if (!lf) {
		return NULL;
	}
	
	vcard = linphone_friend_get_vcard(lf);
	if (!vcard) {
		return NULL;
	}
	
	sipAddresses = linphone_vcard_get_sip_addresses(vcard);
Sylvain Berfini's avatar
Sylvain Berfini committed
248 249 250
	iterator = sipAddresses;
	while (iterator) {
		const char *sipAddress = (const char *)iterator->data;
251 252
		LinphoneAddress *addr = linphone_address_new(sipAddress);
		if (addr) {
Sylvain Berfini's avatar
Sylvain Berfini committed
253
			addresses = ms_list_append(addresses, addr);
254
		}
Sylvain Berfini's avatar
Sylvain Berfini committed
255
		iterator = ms_list_next(iterator);
256
	}
Sylvain Berfini's avatar
Sylvain Berfini committed
257
	if (sipAddresses) ms_list_free(sipAddresses);
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
	return addresses;
}

void linphone_friend_remove_address(LinphoneFriend *lf, const LinphoneAddress *addr) {
	LinphoneVcard *vcard = NULL;
	if (!lf || !addr) {
		return;
	}
	
	vcard = linphone_friend_get_vcard(lf);
	if (!vcard) {
		return;
	}
	
	linphone_vcard_remove_sip_address(vcard, linphone_address_as_string_uri_only(addr));
}

void linphone_friend_add_phone_number(LinphoneFriend *lf, const char *phone) {
	LinphoneVcard *vcard = NULL;
	if (!lf || !phone) {
		return;
	}
	
	vcard = linphone_friend_get_vcard(lf);
	if (!vcard) {
		return;
	}
	
	linphone_vcard_add_phone_number(vcard, phone);
}

Sylvain Berfini's avatar
Sylvain Berfini committed
289
MSList* linphone_friend_get_phone_numbers(LinphoneFriend *lf) {
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
	LinphoneVcard *vcard = NULL;
	
	if (!lf) {
		return NULL;
	}
	
	vcard = linphone_friend_get_vcard(lf);
	if (!vcard) {
		return NULL;
	}
	
	return linphone_vcard_get_phone_numbers(vcard);
}

void linphone_friend_remove_phone_number(LinphoneFriend *lf, const char *phone) {
	LinphoneVcard *vcard = NULL;
	if (!lf || !phone) {
		return;
	}
	
	vcard = linphone_friend_get_vcard(lf);
	if (!vcard) {
		return;
	}
	
	linphone_vcard_remove_phone_number(vcard, phone);
}

aymeric's avatar
aymeric committed
318
int linphone_friend_set_name(LinphoneFriend *lf, const char *name){
319
	LinphoneAddress *fr = lf->uri;
320
	LinphoneVcard *vcard = NULL;
321
	bool_t vcard_created = FALSE;
322 323 324 325
	
	vcard = linphone_friend_get_vcard(lf);
	if (!vcard) {
		linphone_friend_create_vcard(lf, name);
326
		vcard = linphone_friend_get_vcard(lf);
327 328
		vcard_created = TRUE;
	}
329
	if (vcard) {
330
		linphone_vcard_set_full_name(vcard, name);
331 332 333 334 335
		if (fr && vcard_created) { // SIP address wasn't set yet, let's do it
			linphone_vcard_edit_main_sip_address(vcard, linphone_address_as_string_uri_only(fr));
		}
	}
	
336
	if (!fr && !vcard) {
337 338
		ms_warning("linphone_friend_set_address() must be called before linphone_friend_set_name() to be able to set display name.");
		return -1;
339 340
	} else if (fr) {
		linphone_address_set_display_name(fr, name);
341 342
	}
	
aymeric's avatar
aymeric committed
343 344 345
	return 0;
}

jehan's avatar
jehan committed
346
int linphone_friend_enable_subscribes(LinphoneFriend *fr, bool_t val){
aymeric's avatar
aymeric committed
347 348 349 350
	fr->subscribe=val;
	return 0;
}

Sylvain Berfini's avatar
Sylvain Berfini committed
351
int linphone_friend_set_inc_subscribe_policy(LinphoneFriend *fr, LinphoneSubscribePolicy pol) {
aymeric's avatar
aymeric committed
352 353 354 355
	fr->pol=pol;
	return 0;
}

356
void linphone_friend_notify(LinphoneFriend *lf, LinphonePresenceModel *presence){
357 358 359 360 361 362 363 364 365
	MSList *elem;
	if (lf->insubs){
		char *addr=linphone_address_as_string(linphone_friend_get_address(lf));
		ms_message("Want to notify %s",addr);
		ms_free(addr);
	}
	for(elem=lf->insubs; elem!=NULL; elem=elem->next){
		SalOp *op = (SalOp*)elem->data;
		sal_notify_presence(op,(SalPresenceModel *)presence);
aymeric's avatar
aymeric committed
366 367 368
	}
}

369
void linphone_friend_add_incoming_subscription(LinphoneFriend *lf, SalOp *op){
370
	/*ownership of the op is transfered from sal to the LinphoneFriend*/
371 372 373 374
	lf->insubs = ms_list_append(lf->insubs, op);
}

void linphone_friend_remove_incoming_subscription(LinphoneFriend *lf, SalOp *op){
375 376
	if (ms_list_find(lf->insubs, op)){
		sal_op_release(op);
Simon Morlat's avatar
Simon Morlat committed
377
		lf->insubs = ms_list_remove(lf->insubs, op);
378
	}
379

380 381
}

aymeric's avatar
aymeric committed
382
static void linphone_friend_unsubscribe(LinphoneFriend *lf){
383 384
	if (lf->outsub!=NULL) {
		sal_unsubscribe(lf->outsub);
385
		lf->subscribe_active=FALSE;
aymeric's avatar
aymeric committed
386 387 388
	}
}

389
void linphone_friend_invalidate_subscription(LinphoneFriend *lf){
390 391
	LinphoneCore *lc=lf->lc;

Simon Morlat's avatar
Simon Morlat committed
392 393 394 395 396
	if (lf->outsub!=NULL) {
		sal_op_release(lf->outsub);
		lf->outsub=NULL;
		lf->subscribe_active=FALSE;
	}
397 398 399 400

	/* Notify application that we no longer know the presence activity */
	if (lf->presence != NULL) {
		linphone_presence_model_unref(lf->presence);
401 402
		lf->presence = linphone_presence_model_new_with_activity(LinphonePresenceActivityOffline,"unknown activity");
		linphone_core_notify_notify_presence_received(lc,lf);
403 404
	}

405
	lf->initial_subscribes_sent=FALSE;
Simon Morlat's avatar
Simon Morlat committed
406 407
}

408
void linphone_friend_close_subscriptions(LinphoneFriend *lf){
aymeric's avatar
aymeric committed
409
	linphone_friend_unsubscribe(lf);
410
	ms_list_for_each(lf->insubs, (MSIterateFunc) sal_notify_presence_close);
411
	lf->insubs = ms_list_free_with_data(lf->insubs, (MSIterateFunc)sal_op_release);
412 413
}

414
static void _linphone_friend_release_ops(LinphoneFriend *lf){
415
	lf->insubs = ms_list_free_with_data(lf->insubs, (MSIterateFunc) sal_op_release);
416 417 418 419
	if (lf->outsub){
		sal_op_release(lf->outsub);
		lf->outsub=NULL;
	}
420 421 422 423
}

static void _linphone_friend_destroy(LinphoneFriend *lf){
	_linphone_friend_release_ops(lf);
424
	if (lf->presence != NULL) linphone_presence_model_unref(lf->presence);
425
	if (lf->uri!=NULL) linphone_address_unref(lf->uri);
426
	if (lf->info!=NULL) buddy_info_free(lf->info);
427
	if (lf->vcard != NULL) linphone_vcard_free(lf->vcard);
aymeric's avatar
aymeric committed
428 429
}

430 431 432 433 434 435 436 437 438 439 440
static belle_sip_error_code _linphone_friend_marshall(belle_sip_object_t *obj, char* buff, size_t buff_size, size_t *offset) {
	LinphoneFriend *lf = (LinphoneFriend*)obj;
	belle_sip_error_code err = BELLE_SIP_OK;
	if (lf->uri){
		char *tmp = linphone_address_as_string(lf->uri);
		err = belle_sip_snprintf(buff, buff_size, offset, "%s", tmp);
		ms_free(tmp);
	}
	return err;
}

441
const char * linphone_friend_get_name(const LinphoneFriend *lf) {
442 443 444 445 446 447 448
	if (lf && lf->vcard) {
		return linphone_vcard_get_full_name(lf->vcard);
	} else if (lf && lf->uri) {
		LinphoneAddress *fr = lf->uri;
		return linphone_address_get_display_name(fr);
	}
	return NULL;
449 450
}

aymeric's avatar
aymeric committed
451 452 453 454 455 456 457 458 459
bool_t linphone_friend_get_send_subscribe(const LinphoneFriend *lf){
	return lf->subscribe;
}

LinphoneSubscribePolicy linphone_friend_get_inc_subscribe_policy(const LinphoneFriend *lf){
	return lf->pol;
}

LinphoneOnlineStatus linphone_friend_get_status(const LinphoneFriend *lf){
460 461
	LinphoneOnlineStatus online_status = LinphoneStatusOffline;
	LinphonePresenceBasicStatus basic_status = LinphonePresenceBasicStatusClosed;
462
	LinphonePresenceActivity *activity = NULL;
463 464 465 466
	unsigned int nb_activities = 0;

	if (lf->presence != NULL) {
		basic_status = linphone_presence_model_get_basic_status(lf->presence);
467
		nb_activities = linphone_presence_model_get_nb_activities(lf->presence);
468 469 470 471 472 473 474 475 476 477
		online_status = (basic_status == LinphonePresenceBasicStatusOpen) ? LinphoneStatusOnline : LinphoneStatusOffline;
		if (nb_activities > 1) {
			char *tmp = NULL;
			const LinphoneAddress *addr = linphone_friend_get_address(lf);
			if (addr) tmp = linphone_address_as_string(addr);
			ms_warning("Friend %s has several activities, get status from the first one", tmp ? tmp : "unknown");
			if (tmp) ms_free(tmp);
			nb_activities = 1;
		}
		if (nb_activities == 1) {
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
			activity = linphone_presence_model_get_activity(lf->presence);
			switch (linphone_presence_activity_get_type(activity)) {
				case LinphonePresenceActivityBreakfast:
				case LinphonePresenceActivityDinner:
				case LinphonePresenceActivityLunch:
				case LinphonePresenceActivityMeal:
					online_status = LinphoneStatusOutToLunch;
					break;
				case LinphonePresenceActivityAppointment:
				case LinphonePresenceActivityMeeting:
				case LinphonePresenceActivityPerformance:
				case LinphonePresenceActivityPresentation:
				case LinphonePresenceActivitySpectator:
				case LinphonePresenceActivityWorking:
				case LinphonePresenceActivityWorship:
					online_status = LinphoneStatusDoNotDisturb;
					break;
				case LinphonePresenceActivityAway:
				case LinphonePresenceActivitySleeping:
					online_status = LinphoneStatusAway;
					break;
				case LinphonePresenceActivityHoliday:
				case LinphonePresenceActivityTravel:
				case LinphonePresenceActivityVacation:
					online_status = LinphoneStatusVacation;
					break;
				case LinphonePresenceActivityBusy:
				case LinphonePresenceActivityLookingForWork:
				case LinphonePresenceActivityPlaying:
				case LinphonePresenceActivityShopping:
				case LinphonePresenceActivityTV:
					online_status = LinphoneStatusBusy;
					break;
				case LinphonePresenceActivityInTransit:
				case LinphonePresenceActivitySteering:
					online_status = LinphoneStatusBeRightBack;
					break;
				case LinphonePresenceActivityOnThePhone:
					online_status = LinphoneStatusOnThePhone;
					break;
				case LinphonePresenceActivityOther:
				case LinphonePresenceActivityPermanentAbsence:
					online_status = LinphoneStatusMoved;
					break;
				case LinphonePresenceActivityUnknown:
					/* Rely on the basic status information. */
					break;
				case LinphonePresenceActivityOnline:
					/* Should not happen! */
527
					/*ms_warning("LinphonePresenceActivityOnline should not happen here!");*/
528 529 530
					break;
				case LinphonePresenceActivityOffline:
					online_status = LinphoneStatusOffline;
531
					break;
532 533 534 535 536 537 538
			}
		}
	}

	return online_status;
}

539
const LinphonePresenceModel * linphone_friend_get_presence_model(LinphoneFriend *lf) {
540 541 542
	return lf->presence;
}

543 544 545 546 547 548 549
void linphone_friend_set_presence_model(LinphoneFriend *lf, LinphonePresenceModel *presence) {
	if (lf->presence != NULL) {
		linphone_presence_model_unref(lf->presence);
	}
	lf->presence = presence;
}

550 551 552 553
bool_t linphone_friend_is_presence_received(const LinphoneFriend *lf) {
	return lf->presence_received;
}

554 555 556
BuddyInfo * linphone_friend_get_info(const LinphoneFriend *lf){
	return lf->info;
}
aymeric's avatar
aymeric committed
557

558 559 560 561 562 563 564 565
/*
 * updates the subscriptions.
 * If only_when_registered is TRUE, subscribe will be sent only if the friend's corresponding proxy config is in registered.
 * Otherwise if the proxy config goes to unregistered state, the subscription refresh will be suspended.
 * An optional proxy whose state has changed can be passed to optimize the processing.
**/
void linphone_friend_update_subscribes(LinphoneFriend *fr, LinphoneProxyConfig *proxy, bool_t only_when_registered){
	int can_subscribe=1;
566

567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
	if (only_when_registered && (fr->subscribe || fr->subscribe_active)){
		LinphoneProxyConfig *cfg=linphone_core_lookup_known_proxy(fr->lc,fr->uri);
		if (proxy && proxy!=cfg) return;
		if (cfg && cfg->state!=LinphoneRegistrationOk){
			char *tmp=linphone_address_as_string(fr->uri);
			ms_message("Friend [%s] belongs to proxy config with identity [%s], but this one isn't registered. Subscription is suspended.",
				   tmp,linphone_proxy_config_get_identity(cfg));
			ms_free(tmp);
			can_subscribe=0;
		}
	}
	if (can_subscribe && fr->subscribe && fr->subscribe_active==FALSE){
		ms_message("Sending a new SUBSCRIBE");
		__linphone_friend_do_subscribe(fr);
	}else if (can_subscribe && fr->subscribe_active && !fr->subscribe){
		linphone_friend_unsubscribe(fr);
	}else if (!can_subscribe && fr->outsub){
		fr->subscribe_active=FALSE;
		sal_op_stop_refreshing(fr->outsub);
	}
}

589
void linphone_friend_save(LinphoneFriend *fr, LinphoneCore *lc) {
590 591 592
#ifdef FRIENDS_SQL_STORAGE_ENABLED
	linphone_core_store_friend_in_db(lc, fr);
#else
593
	linphone_core_write_friends_config(lc);
594
#endif
595 596 597
}

void linphone_friend_apply(LinphoneFriend *fr, LinphoneCore *lc) {
598 599
	LinphonePresenceModel *model;

600
	if (!fr->uri) {
aymeric's avatar
aymeric committed
601 602 603
		ms_warning("No sip url defined.");
		return;
	}
jehan's avatar
jehan committed
604

605 606
	if (fr->inc_subscribe_pending) {
		switch(fr->pol) {
aymeric's avatar
aymeric committed
607
			case LinphoneSPWait:
608
				model = linphone_presence_model_new_with_activity(LinphonePresenceActivityOther, "Waiting for user acceptance");
609
				linphone_friend_notify(fr, model);
610
				linphone_presence_model_unref(model);
aymeric's avatar
aymeric committed
611 612
				break;
			case LinphoneSPAccept:
613 614
				if (fr->lc)
					linphone_friend_notify(fr, fr->lc->presence_model);
aymeric's avatar
aymeric committed
615 616
				break;
			case LinphoneSPDeny:
617
				linphone_friend_notify(fr, NULL);
aymeric's avatar
aymeric committed
618 619
				break;
		}
620 621 622
		fr->inc_subscribe_pending = FALSE;
	}
	if (fr->lc) {
623
		linphone_friend_list_update_subscriptions(fr->friend_list, NULL, linphone_core_should_subscribe_friends_only_when_registered(fr->lc));
aymeric's avatar
aymeric committed
624
	}
625
	ms_debug("linphone_friend_apply() done.");
626
	lc->bl_refresh=TRUE;
627
	fr->commit=FALSE;
aymeric's avatar
aymeric committed
628 629
}

630
void linphone_friend_edit(LinphoneFriend *fr) {
631 632 633
	if (fr && fr->vcard) {
		linphone_vcard_compute_md5_hash(fr->vcard);
	}
aymeric's avatar
aymeric committed
634 635
}

636
void linphone_friend_done(LinphoneFriend *fr) {
637
	ms_return_if_fail(fr);
638
	if (!fr->lc || !fr->friend_list) return;
639 640
	linphone_friend_apply(fr, fr->lc);
	linphone_friend_save(fr, fr->lc);
641 642
	
	if (fr && fr->vcard) {
643
		if (linphone_vcard_compare_md5_hash(fr->vcard) != 0) {
644
			ms_debug("vCard's md5 has changed, mark friend as dirty");
645
			fr->friend_list->dirty_friends_to_update = ms_list_append(fr->friend_list->dirty_friends_to_update, linphone_friend_ref(fr));
646 647
		}
	}
aymeric's avatar
aymeric committed
648 649
}

650 651 652 653
#if __clang__ || ((__GNUC__ == 4 && __GNUC_MINOR__ >= 6) || __GNUC__ > 4)
#pragma GCC diagnostic push
#endif
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
654
LinphoneFriend * linphone_core_create_friend(LinphoneCore *lc) {
655 656 657
	LinphoneFriend * lf = linphone_friend_new();
	lf->lc = lc;
	return lf;
658 659 660
}

LinphoneFriend * linphone_core_create_friend_with_address(LinphoneCore *lc, const char *address) {
661 662 663 664
	LinphoneFriend * lf = linphone_friend_new_with_address(address);
	if (lf)
		lf->lc = lc;
	return lf;
665
}
666 667 668
#if __clang__ || ((__GNUC__ == 4 && __GNUC_MINOR__ >= 6) || __GNUC__ > 4)
#pragma GCC diagnostic pop
#endif
669

670
void linphone_core_add_friend(LinphoneCore *lc, LinphoneFriend *lf) {
671
	if (linphone_friend_list_add_friend(linphone_core_get_default_friend_list(lc), lf) != LinphoneFriendListOK) return;
672
	if (ms_list_find(lc->subscribers, lf)) {
673 674 675 676
		/*if this friend was in the pending subscriber list, now remove it from this list*/
		lc->subscribers = ms_list_remove(lc->subscribers, lf);
		linphone_friend_unref(lf);
	}
677 678
	if (linphone_core_ready(lc)) linphone_friend_apply(lf, lc);
	else lf->commit = TRUE;
679
	linphone_friend_save(lf, lc);
aymeric's avatar
aymeric committed
680 681
}

682
void linphone_core_remove_friend(LinphoneCore *lc, LinphoneFriend *lf) {
683 684 685 686
	if (lf && lf->friend_list) {
		if (linphone_friend_list_remove_friend(lf->friend_list, lf) == LinphoneFriendListNonExistentFriend) {
			ms_error("linphone_core_remove_friend(): friend [%p] is not part of core's list.", lf);
		}
aymeric's avatar
aymeric committed
687 688 689
	}
}

690 691 692 693 694 695
void linphone_core_update_friends_subscriptions(LinphoneCore *lc, LinphoneProxyConfig *cfg, bool_t only_when_registered) {
	MSList *lists = lc->friends_lists;
	while (lists) {
		LinphoneFriendList *list = (LinphoneFriendList *)lists->data;
		linphone_friend_list_update_subscriptions(list, cfg, only_when_registered);
		lists = ms_list_next(lists);
Simon Morlat's avatar
Simon Morlat committed
696
	}
697 698 699 700 701
}

bool_t linphone_core_should_subscribe_friends_only_when_registered(const LinphoneCore *lc){
	return lp_config_get_int(lc->config,"sip","subscribe_presence_only_when_registered",1);
}
702

703 704
void linphone_core_send_initial_subscribes(LinphoneCore *lc) {
	MSList *lists = lc->friends_lists;
Ghislain MARY's avatar
Ghislain MARY committed
705 706 707 708
	bool_t proxy_config_for_rls_presence_uri_domain = FALSE;
	LinphoneAddress *rls_address = NULL;
	const MSList *elem;

709 710
	if (lc->initial_subscribes_sent) return;
	lc->initial_subscribes_sent=TRUE;
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
	while (lists) {
		LinphoneFriendList *list = (LinphoneFriendList *)lists->data;
		if (list->rls_uri != NULL) {
			rls_address = linphone_core_create_address(lc, list->rls_uri);
			if (rls_address != NULL) {
				const char *rls_domain = linphone_address_get_domain(rls_address);
				if (rls_domain != NULL) {
					for (elem = linphone_core_get_proxy_config_list(lc); elem != NULL; elem = elem->next) {
						LinphoneProxyConfig *cfg = (LinphoneProxyConfig *)elem->data;
						const char *proxy_domain = linphone_proxy_config_get_domain(cfg);
						if (strcmp(rls_domain, proxy_domain) == 0) {
							proxy_config_for_rls_presence_uri_domain = TRUE;
							break;
						}
					}
Ghislain MARY's avatar
Ghislain MARY committed
726
				}
727 728
				linphone_address_unref(rls_address);
			}
729 730 731 732 733
		}
		if (proxy_config_for_rls_presence_uri_domain == TRUE) {
			ms_message("Presence list activated so do not send initial subscribes it will be done when registered");
		} else {
			linphone_core_update_friends_subscriptions(lc,NULL,linphone_core_should_subscribe_friends_only_when_registered(lc));
Ghislain MARY's avatar
Ghislain MARY committed
734
		}
735
		lists = ms_list_next(lists);
Ghislain MARY's avatar
Ghislain MARY committed
736
	}
Simon Morlat's avatar
Simon Morlat committed
737 738
}

739 740 741 742 743 744 745
void linphone_core_invalidate_friend_subscriptions(LinphoneCore *lc) {
	MSList *lists = lc->friends_lists;
	while (lists) {
		LinphoneFriendList *list = (LinphoneFriendList *)lists->data;
		linphone_friend_list_invalidate_subscriptions(list);
		lists = ms_list_next(lists);
	}		
Simon Morlat's avatar
Simon Morlat committed
746
	lc->initial_subscribes_sent=FALSE;
747 748
}

749
void linphone_friend_set_ref_key(LinphoneFriend *lf, const char *key){
750
	if (lf->refkey != NULL) {
751
		ms_free(lf->refkey);
752 753 754 755 756 757 758
		lf->refkey = NULL;
	}
	if (key) {
		lf->refkey = ms_strdup(key);
	}
	if (lf->lc) {
		linphone_friend_save(lf, lf->lc);
759 760 761 762 763 764 765
	}
}

const char *linphone_friend_get_ref_key(const LinphoneFriend *lf){
	return lf->refkey;
}

766 767 768 769 770 771 772 773 774
LinphoneFriend *linphone_core_find_friend(const LinphoneCore *lc, const LinphoneAddress *addr) {
	MSList *lists = lc->friends_lists;
	LinphoneFriend *lf = NULL;
	while (lists && !lf) {
		LinphoneFriendList *list = (LinphoneFriendList *)lists->data;
		lf = linphone_friend_list_find_friend_by_address(list, addr);
		lists = ms_list_next(lists);
	}
	return lf;
Simon Morlat's avatar
Simon Morlat committed
775 776
}

777 778 779 780 781 782 783 784 785
LinphoneFriend *linphone_core_get_friend_by_address(const LinphoneCore *lc, const char *uri) {
	MSList *lists = lc->friends_lists;
	LinphoneFriend *lf = NULL;
	while (lists && !lf) {
		LinphoneFriendList *list = (LinphoneFriendList *)lists->data;
		lf = linphone_friend_list_find_friend_by_uri(list, uri);
		lists = ms_list_next(lists);
	}
	return lf;
786 787
}

788 789 790 791 792 793 794 795 796
LinphoneFriend *linphone_core_get_friend_by_ref_key(const LinphoneCore *lc, const char *key) {
	MSList *lists = lc->friends_lists;
	LinphoneFriend *lf = NULL;
	while (lists && !lf) {
		LinphoneFriendList *list = (LinphoneFriendList *)lists->data;
		lf = linphone_friend_list_find_friend_by_ref_key(list, key);
		lists = ms_list_next(lists);
	}
	return lf;
797 798
}

smorlat's avatar
smorlat committed
799
#define key_compare(s1,s2)	strcmp(s1,s2)
aymeric's avatar
aymeric committed
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825

LinphoneSubscribePolicy __policy_str_to_enum(const char* pol){
	if (key_compare("accept",pol)==0){
		return LinphoneSPAccept;
	}
	if (key_compare("deny",pol)==0){
		return LinphoneSPDeny;
	}
	if (key_compare("wait",pol)==0){
		return LinphoneSPWait;
	}
	ms_warning("Unrecognized subscribe policy: %s",pol);
	return LinphoneSPWait;
}

LinphoneProxyConfig *__index_to_proxy(LinphoneCore *lc, int index){
	if (index>=0) return (LinphoneProxyConfig*)ms_list_nth_data(lc->sip_conf.proxies,index);
	else return NULL;
}

LinphoneFriend * linphone_friend_new_from_config_file(LinphoneCore *lc, int index){
	const char *tmp;
	char item[50];
	int a;
	LinphoneFriend *lf;
	LpConfig *config=lc->config;
826

aymeric's avatar
aymeric committed
827
	sprintf(item,"friend_%i",index);
828

aymeric's avatar
aymeric committed
829 830 831
	if (!lp_config_has_section(config,item)){
		return NULL;
	}
832

aymeric's avatar
aymeric committed
833 834 835 836
	tmp=lp_config_get_string(config,item,"url",NULL);
	if (tmp==NULL) {
		return NULL;
	}
837
	lf=linphone_core_create_friend_with_address(lc, tmp);
aymeric's avatar
aymeric committed
838 839 840 841 842 843 844 845 846 847
	if (lf==NULL) {
		return NULL;
	}
	tmp=lp_config_get_string(config,item,"pol",NULL);
	if (tmp==NULL) linphone_friend_set_inc_subscribe_policy(lf,LinphoneSPWait);
	else{
		linphone_friend_set_inc_subscribe_policy(lf,__policy_str_to_enum(tmp));
	}
	a=lp_config_get_int(config,item,"subscribe",0);
	linphone_friend_send_subscribe(lf,a);
848 849
	a = lp_config_get_int(config, item, "presence_received", 0);
	lf->presence_received = (bool_t)a;
850

851
	linphone_friend_set_ref_key(lf,lp_config_get_string(config,item,"refkey",NULL));
aymeric's avatar
aymeric committed
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
	return lf;
}

const char *__policy_enum_to_str(LinphoneSubscribePolicy pol){
	switch(pol){
		case LinphoneSPAccept:
			return "accept";
			break;
		case LinphoneSPDeny:
			return "deny";
			break;
		case LinphoneSPWait:
			return "wait";
			break;
	}
	ms_warning("Invalid policy enum value.");
	return "wait";
}

void linphone_friend_write_to_config_file(LpConfig *config, LinphoneFriend *lf, int index){
	char key[50];
	char *tmp;
874
	const char *refkey;
875

aymeric's avatar
aymeric committed
876
	sprintf(key,"friend_%i",index);
877

aymeric's avatar
aymeric committed
878 879 880 881
	if (lf==NULL){
		lp_config_clean_section(config,key);
		return;
	}
882
	if (lf->uri!=NULL){
883
		tmp=linphone_address_as_string(lf->uri);
aymeric's avatar
aymeric committed
884 885 886 887
		if (tmp==NULL) {
			return;
		}
		lp_config_set_string(config,key,"url",tmp);
Simon Morlat's avatar
Simon Morlat committed
888
		ms_free(tmp);
aymeric's avatar
aymeric committed
889 890 891
	}
	lp_config_set_string(config,key,"pol",__policy_enum_to_str(lf->pol));
	lp_config_set_int(config,key,"subscribe",lf->subscribe);
892
	lp_config_set_int(config, key, "presence_received", lf->presence_received);
893 894 895 896 897

	refkey=linphone_friend_get_ref_key(lf);
	if (refkey){
		lp_config_set_string(config,key,"refkey",refkey);
	}
aymeric's avatar
aymeric committed
898
}
899

900
void linphone_core_write_friends_config(LinphoneCore* lc) {
901 902
	MSList *elem;
	int i;
903
	int store_friends;
904 905 906
#ifdef FRIENDS_SQL_STORAGE_ENABLED
	return;
#endif
907
	if (! linphone_core_ready(lc)) return; /*dont write config when reading it !*/
908 909
	store_friends = lp_config_get_int(lc->config, "misc", "store_friends", 1);
	if (store_friends) {
910 911
		
		for (elem=linphone_core_get_default_friend_list(lc)->friends,i=0; elem!=NULL; elem=ms_list_next(elem),i++){
912 913 914
			linphone_friend_write_to_config_file(lc->config,(LinphoneFriend*)elem->data,i);
		}
		linphone_friend_write_to_config_file(lc->config,NULL,i);	/* set the end */
915 916 917
	}
}

918 919 920 921
LinphoneCore *linphone_friend_get_core(const LinphoneFriend *fr){
	return fr->lc;
}

922 923 924 925 926 927 928 929 930 931 932 933 934 935
LinphoneFriend *linphone_friend_ref(LinphoneFriend *lf) {
	belle_sip_object_ref(lf);
	return lf;
}

void linphone_friend_unref(LinphoneFriend *lf) {
	belle_sip_object_unref(lf);
}

/* DEPRECATED */
void linphone_friend_destroy(LinphoneFriend *lf) {
	linphone_friend_unref(lf);
}

936
LinphoneVcard* linphone_friend_get_vcard(LinphoneFriend *fr) {
937 938 939 940
	if (fr) {
		return fr->vcard;
	}
	return NULL;
941 942
}

943
void linphone_friend_set_vcard(LinphoneFriend *fr, LinphoneVcard *vcard) {
944 945 946 947
	if (!fr) {
		return;
	}
	
948 949 950 951
	if (fr->vcard) {
		linphone_vcard_free(fr->vcard);
	}
	fr->vcard = vcard;
952
	linphone_friend_save(fr, fr->lc);
953 954
}

955
bool_t linphone_friend_create_vcard(LinphoneFriend *fr, const char *name) {
956
	LinphoneVcard *vcard = NULL;
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
	const char *fullName = NULL;
	LinphoneAddress *addr = NULL;
	
	if (!fr || fr->vcard) {
		ms_error("Friend is either null or already has a vcard");
		return FALSE;
	}
	
	addr = fr->uri;
	if (!addr && !name) {
		ms_error("friend doesn't have an URI and name parameter is null");
		return FALSE;
	}
	
	if (name) {
		fullName = name;
	} else {
		const char *displayName = linphone_address_get_display_name(addr);
		if (!displayName) {
976 977 978
			fullName = linphone_address_get_username(addr);
		} else {
			fullName = displayName;
979 980 981 982 983 984 985 986 987 988
		}
	}
	
	if (!fullName) {
		ms_error("Couldn't determine the name to use for the vCard");
		return FALSE;
	}
	
	vcard = linphone_vcard_new();
	linphone_vcard_set_full_name(vcard, fullName);
989
	linphone_friend_set_vcard(fr, vcard);
990 991 992
	return TRUE;
}

993
LinphoneFriend *linphone_friend_new_from_vcard(LinphoneVcard *vcard) {
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
	LinphoneAddress* linphone_address = NULL;
	LinphoneFriend *fr;
	const char *name = NULL;
	MSList *sipAddresses = NULL;

	if (vcard == NULL) {
		ms_error("Cannot create friend from null vcard");
		return NULL;
	}
	name = linphone_vcard_get_full_name(vcard);
	sipAddresses = linphone_vcard_get_sip_addresses(vcard);
	
	fr = linphone_friend_new();
1007
	// Currently presence takes too much time when dealing with hundreds of friends, so I disabled it for now
1008 1009 1010
	fr->pol = LinphoneSPDeny;
	fr->subscribe = FALSE;
	
1011 1012 1013 1014 1015
	if (sipAddresses) {
		const char *sipAddress = (const char *)sipAddresses->data;
		linphone_address = linphone_address_new(sipAddress);
		if (linphone_address) {
			linphone_friend_set_address(fr, linphone_address);
1016
			linphone_address_unref(linphone_address);
1017
		}