1
/* $Id: pjsua_pres.c 3553 2011-05-05 06:14:19Z nanang $ */
3
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
4
* Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation; either version 2 of the License, or
9
* (at your option) any later version.
11
* This program is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public License
17
* along with this program; if not, write to the Free Software
18
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
#include <pjsua-lib/pjsua.h>
21
#include <pjsua-lib/pjsua_internal.h>
24
#define THIS_FILE "pjsua_pres.c"
27
static void subscribe_buddy_presence(pjsua_buddy_id buddy_id);
28
static void unsubscribe_buddy_presence(pjsua_buddy_id buddy_id);
34
static pjsua_buddy_id find_buddy(const pjsip_uri *uri)
36
const pjsip_sip_uri *sip_uri;
39
uri = (const pjsip_uri*) pjsip_uri_get_uri((pjsip_uri*)uri);
41
if (!PJSIP_URI_SCHEME_IS_SIP(uri) && !PJSIP_URI_SCHEME_IS_SIPS(uri))
42
return PJSUA_INVALID_ID;
44
sip_uri = (const pjsip_sip_uri*) uri;
46
for (i=0; i<PJ_ARRAY_SIZE(pjsua_var.buddy); ++i) {
47
const pjsua_buddy *b = &pjsua_var.buddy[i];
49
if (!pjsua_buddy_is_valid(i))
52
if (pj_stricmp(&sip_uri->user, &b->name)==0 &&
53
pj_stricmp(&sip_uri->host, &b->host)==0 &&
54
(sip_uri->port==(int)b->port || (sip_uri->port==0 && b->port==5060)))
61
return PJSUA_INVALID_ID;
66
#define LOCK_ALL (LOCK_DIALOG | LOCK_PJSUA)
68
/* Buddy lock object */
76
/* Acquire lock to the specified buddy_id */
77
pj_status_t lock_buddy(const char *title,
78
pjsua_buddy_id buddy_id,
79
struct buddy_lock *lck,
82
enum { MAX_RETRY=50 };
83
pj_bool_t has_pjsua_lock = PJ_FALSE;
86
PJ_UNUSED_ARG(_unused_);
88
pj_bzero(lck, sizeof(*lck));
90
for (retry=0; retry<MAX_RETRY; ++retry) {
92
if (PJSUA_TRY_LOCK() != PJ_SUCCESS) {
93
pj_thread_sleep(retry/10);
97
has_pjsua_lock = PJ_TRUE;
98
lck->flag = LOCK_PJSUA;
99
lck->buddy = &pjsua_var.buddy[buddy_id];
101
if (lck->buddy->dlg == NULL)
104
if (pjsip_dlg_try_inc_lock(lck->buddy->dlg) != PJ_SUCCESS) {
107
has_pjsua_lock = PJ_FALSE;
109
pj_thread_sleep(retry/10);
113
lck->dlg = lck->buddy->dlg;
114
lck->flag = LOCK_DIALOG;
120
if (lck->flag == 0) {
121
if (has_pjsua_lock == PJ_FALSE)
122
PJ_LOG(1,(THIS_FILE, "Timed-out trying to acquire PJSUA mutex "
123
"(possibly system has deadlocked) in %s",
126
PJ_LOG(1,(THIS_FILE, "Timed-out trying to acquire dialog mutex "
127
"(possibly system has deadlocked) in %s",
135
/* Release buddy lock */
136
static void unlock_buddy(struct buddy_lock *lck)
138
if (lck->flag & LOCK_DIALOG)
139
pjsip_dlg_dec_lock(lck->dlg);
141
if (lck->flag & LOCK_PJSUA)
147
* Get total number of buddies.
149
PJ_DEF(unsigned) pjsua_get_buddy_count(void)
151
return pjsua_var.buddy_cnt;
158
PJ_DEF(pjsua_buddy_id) pjsua_buddy_find(const pj_str_t *uri_str)
163
pjsua_buddy_id buddy_id;
165
pool = pjsua_pool_create("buddyfind", 512, 512);
166
pj_strdup_with_null(pool, &input, uri_str);
168
uri = pjsip_parse_uri(pool, input.ptr, input.slen, 0);
170
buddy_id = PJSUA_INVALID_ID;
173
buddy_id = find_buddy(uri);
177
pj_pool_release(pool);
184
* Check if buddy ID is valid.
186
PJ_DEF(pj_bool_t) pjsua_buddy_is_valid(pjsua_buddy_id buddy_id)
188
return buddy_id>=0 && buddy_id<(int)PJ_ARRAY_SIZE(pjsua_var.buddy) &&
189
pjsua_var.buddy[buddy_id].uri.slen != 0;
196
PJ_DEF(pj_status_t) pjsua_enum_buddies( pjsua_buddy_id ids[],
201
PJ_ASSERT_RETURN(ids && count, PJ_EINVAL);
205
for (i=0, c=0; c<*count && i<PJ_ARRAY_SIZE(pjsua_var.buddy); ++i) {
206
if (!pjsua_var.buddy[i].uri.slen)
221
* Get detailed buddy info.
223
PJ_DEF(pj_status_t) pjsua_buddy_get_info( pjsua_buddy_id buddy_id,
224
pjsua_buddy_info *info)
227
struct buddy_lock lck;
231
PJ_ASSERT_RETURN(pjsua_buddy_is_valid(buddy_id), PJ_EINVAL);
233
pj_bzero(info, sizeof(pjsua_buddy_info));
235
status = lock_buddy("pjsua_buddy_get_info()", buddy_id, &lck, 0);
236
if (status != PJ_SUCCESS)
240
info->id = buddy->index;
241
if (pjsua_var.buddy[buddy_id].uri.slen == 0) {
247
info->uri.ptr = info->buf_ + total;
248
pj_strncpy(&info->uri, &buddy->uri, sizeof(info->buf_)-total);
249
total += info->uri.slen;
252
info->contact.ptr = info->buf_ + total;
253
pj_strncpy(&info->contact, &buddy->contact, sizeof(info->buf_)-total);
254
total += info->contact.slen;
256
/* Presence status */
257
pj_memcpy(&info->pres_status, &buddy->status, sizeof(pjsip_pres_status));
259
/* status and status text */
260
if (buddy->sub == NULL || buddy->status.info_cnt==0) {
261
info->status = PJSUA_BUDDY_STATUS_UNKNOWN;
262
info->status_text = pj_str("?");
263
} else if (pjsua_var.buddy[buddy_id].status.info[0].basic_open) {
264
info->status = PJSUA_BUDDY_STATUS_ONLINE;
266
/* copy RPID information */
267
info->rpid = buddy->status.info[0].rpid;
269
if (info->rpid.note.slen)
270
info->status_text = info->rpid.note;
272
info->status_text = pj_str("Online");
275
info->status = PJSUA_BUDDY_STATUS_OFFLINE;
276
info->rpid = buddy->status.info[0].rpid;
278
if (info->rpid.note.slen)
279
info->status_text = info->rpid.note;
281
info->status_text = pj_str("Offline");
285
info->monitor_pres = buddy->monitor;
287
/* subscription state and termination reason */
288
info->sub_term_code = buddy->term_code;
290
info->sub_state = pjsip_evsub_get_state(buddy->sub);
291
info->sub_state_name = pjsip_evsub_get_state_name(buddy->sub);
292
if (info->sub_state == PJSIP_EVSUB_STATE_TERMINATED &&
293
total < sizeof(info->buf_))
295
info->sub_term_reason.ptr = info->buf_ + total;
296
pj_strncpy(&info->sub_term_reason,
297
pjsip_evsub_get_termination_reason(buddy->sub),
298
sizeof(info->buf_) - total);
299
total += info->sub_term_reason.slen;
301
info->sub_term_reason = pj_str("");
303
} else if (total < sizeof(info->buf_)) {
304
info->sub_state_name = "NULL";
305
info->sub_term_reason.ptr = info->buf_ + total;
306
pj_strncpy(&info->sub_term_reason, &buddy->term_reason,
307
sizeof(info->buf_) - total);
308
total += info->sub_term_reason.slen;
310
info->sub_state_name = "NULL";
311
info->sub_term_reason = pj_str("");
319
* Set the user data associated with the buddy object.
321
PJ_DEF(pj_status_t) pjsua_buddy_set_user_data( pjsua_buddy_id buddy_id,
324
struct buddy_lock lck;
327
PJ_ASSERT_RETURN(pjsua_buddy_is_valid(buddy_id), PJ_EINVAL);
329
status = lock_buddy("pjsua_buddy_set_user_data()", buddy_id, &lck, 0);
330
if (status != PJ_SUCCESS)
333
pjsua_var.buddy[buddy_id].user_data = user_data;
342
* Get the user data associated with the budy object.
344
PJ_DEF(void*) pjsua_buddy_get_user_data(pjsua_buddy_id buddy_id)
346
struct buddy_lock lck;
350
PJ_ASSERT_RETURN(pjsua_buddy_is_valid(buddy_id), NULL);
352
status = lock_buddy("pjsua_buddy_get_user_data()", buddy_id, &lck, 0);
353
if (status != PJ_SUCCESS)
356
user_data = pjsua_var.buddy[buddy_id].user_data;
365
* Reset buddy descriptor.
367
static void reset_buddy(pjsua_buddy_id id)
369
pj_pool_t *pool = pjsua_var.buddy[id].pool;
370
pj_bzero(&pjsua_var.buddy[id], sizeof(pjsua_var.buddy[id]));
371
pjsua_var.buddy[id].pool = pool;
372
pjsua_var.buddy[id].index = id;
379
PJ_DEF(pj_status_t) pjsua_buddy_add( const pjsua_buddy_config *cfg,
380
pjsua_buddy_id *p_buddy_id)
382
pjsip_name_addr *url;
384
pjsip_sip_uri *sip_uri;
388
PJ_ASSERT_RETURN(pjsua_var.buddy_cnt <=
389
PJ_ARRAY_SIZE(pjsua_var.buddy),
394
/* Find empty slot */
395
for (index=0; index<(int)PJ_ARRAY_SIZE(pjsua_var.buddy); ++index) {
396
if (pjsua_var.buddy[index].uri.slen == 0)
400
/* Expect to find an empty slot */
401
if (index == PJ_ARRAY_SIZE(pjsua_var.buddy)) {
403
/* This shouldn't happen */
404
pj_assert(!"index < PJ_ARRAY_SIZE(pjsua_var.buddy)");
408
buddy = &pjsua_var.buddy[index];
410
/* Create pool for this buddy */
412
pj_pool_reset(buddy->pool);
414
char name[PJ_MAX_OBJ_NAME];
415
pj_ansi_snprintf(name, sizeof(name), "buddy%03d", index);
416
buddy->pool = pjsua_pool_create(name, 512, 256);
419
/* Init buffers for presence subscription status */
420
buddy->term_reason.ptr = (char*)
421
pj_pool_alloc(buddy->pool,
422
PJSUA_BUDDY_SUB_TERM_REASON_LEN);
424
/* Get name and display name for buddy */
425
pj_strdup_with_null(buddy->pool, &tmp, &cfg->uri);
426
url = (pjsip_name_addr*)pjsip_parse_uri(buddy->pool, tmp.ptr, tmp.slen,
427
PJSIP_PARSE_URI_AS_NAMEADDR);
430
pjsua_perror(THIS_FILE, "Unable to add buddy", PJSIP_EINVALIDURI);
431
pj_pool_release(buddy->pool);
434
return PJSIP_EINVALIDURI;
437
/* Only support SIP schemes */
438
if (!PJSIP_URI_SCHEME_IS_SIP(url) && !PJSIP_URI_SCHEME_IS_SIPS(url)) {
439
pj_pool_release(buddy->pool);
442
return PJSIP_EINVALIDSCHEME;
445
/* Reset buddy, to make sure everything is cleared with default
451
pjsua_var.buddy[index].uri = tmp;
453
sip_uri = (pjsip_sip_uri*) pjsip_uri_get_uri(url->uri);
454
pjsua_var.buddy[index].name = sip_uri->user;
455
pjsua_var.buddy[index].display = url->display;
456
pjsua_var.buddy[index].host = sip_uri->host;
457
pjsua_var.buddy[index].port = sip_uri->port;
458
pjsua_var.buddy[index].monitor = cfg->subscribe;
459
if (pjsua_var.buddy[index].port == 0)
460
pjsua_var.buddy[index].port = 5060;
463
pjsua_var.buddy[index].user_data = (void*)cfg->user_data;
468
pjsua_var.buddy_cnt++;
472
pjsua_buddy_subscribe_pres(index, cfg->subscribe);
481
PJ_DEF(pj_status_t) pjsua_buddy_del(pjsua_buddy_id buddy_id)
483
struct buddy_lock lck;
486
PJ_ASSERT_RETURN(buddy_id>=0 &&
487
buddy_id<(int)PJ_ARRAY_SIZE(pjsua_var.buddy),
490
if (pjsua_var.buddy[buddy_id].uri.slen == 0) {
494
status = lock_buddy("pjsua_buddy_del()", buddy_id, &lck, 0);
495
if (status != PJ_SUCCESS)
498
/* Unsubscribe presence */
499
pjsua_buddy_subscribe_pres(buddy_id, PJ_FALSE);
501
/* Not interested with further events for this buddy */
502
if (pjsua_var.buddy[buddy_id].sub) {
503
pjsip_evsub_set_mod_data(pjsua_var.buddy[buddy_id].sub,
504
pjsua_var.mod.id, NULL);
508
pjsua_var.buddy[buddy_id].uri.slen = 0;
509
pjsua_var.buddy_cnt--;
512
if (pjsua_var.buddy[buddy_id].timer.id) {
513
pjsua_cancel_timer(&pjsua_var.buddy[buddy_id].timer);
514
pjsua_var.buddy[buddy_id].timer.id = PJ_FALSE;
517
/* Reset buddy struct */
518
reset_buddy(buddy_id);
526
* Enable/disable buddy's presence monitoring.
528
PJ_DEF(pj_status_t) pjsua_buddy_subscribe_pres( pjsua_buddy_id buddy_id,
531
struct buddy_lock lck;
534
PJ_ASSERT_RETURN(pjsua_buddy_is_valid(buddy_id), PJ_EINVAL);
536
status = lock_buddy("pjsua_buddy_subscribe_pres()", buddy_id, &lck, 0);
537
if (status != PJ_SUCCESS)
540
lck.buddy->monitor = subscribe;
542
pjsua_buddy_update_pres(buddy_id);
550
* Update buddy's presence.
552
PJ_DEF(pj_status_t) pjsua_buddy_update_pres(pjsua_buddy_id buddy_id)
554
struct buddy_lock lck;
557
PJ_ASSERT_RETURN(pjsua_buddy_is_valid(buddy_id), PJ_EINVAL);
559
status = lock_buddy("pjsua_buddy_update_pres()", buddy_id, &lck, 0);
560
if (status != PJ_SUCCESS)
563
/* Is this an unsubscribe request? */
564
if (!lck.buddy->monitor) {
565
unsubscribe_buddy_presence(buddy_id);
570
/* Ignore if presence is already active for the buddy */
571
if (lck.buddy->sub) {
576
/* Initiate presence subscription */
577
subscribe_buddy_presence(buddy_id);
586
* Dump presence subscriptions to log file.
588
PJ_DEF(void) pjsua_pres_dump(pj_bool_t verbose)
597
* When no detail is required, just dump number of server and client
600
if (verbose == PJ_FALSE) {
604
for (acc_id=0; acc_id<PJ_ARRAY_SIZE(pjsua_var.acc); ++acc_id) {
606
if (!pjsua_var.acc[acc_id].valid)
609
if (!pj_list_empty(&pjsua_var.acc[acc_id].pres_srv_list)) {
610
struct pjsua_srv_pres *uapres;
612
uapres = pjsua_var.acc[acc_id].pres_srv_list.next;
613
while (uapres != &pjsua_var.acc[acc_id].pres_srv_list) {
615
uapres = uapres->next;
620
PJ_LOG(3,(THIS_FILE, "Number of server/UAS subscriptions: %d",
625
for (i=0; i<PJ_ARRAY_SIZE(pjsua_var.buddy); ++i) {
626
if (pjsua_var.buddy[i].uri.slen == 0)
628
if (pjsua_var.buddy[i].sub) {
633
PJ_LOG(3,(THIS_FILE, "Number of client/UAC subscriptions: %d",
641
* Dumping all server (UAS) subscriptions
643
PJ_LOG(3,(THIS_FILE, "Dumping pjsua server subscriptions:"));
645
for (acc_id=0; acc_id<(int)PJ_ARRAY_SIZE(pjsua_var.acc); ++acc_id) {
647
if (!pjsua_var.acc[acc_id].valid)
650
PJ_LOG(3,(THIS_FILE, " %.*s",
651
(int)pjsua_var.acc[acc_id].cfg.id.slen,
652
pjsua_var.acc[acc_id].cfg.id.ptr));
654
if (pj_list_empty(&pjsua_var.acc[acc_id].pres_srv_list)) {
656
PJ_LOG(3,(THIS_FILE, " - none - "));
659
struct pjsua_srv_pres *uapres;
661
uapres = pjsua_var.acc[acc_id].pres_srv_list.next;
662
while (uapres != &pjsua_var.acc[acc_id].pres_srv_list) {
664
PJ_LOG(3,(THIS_FILE, " %10s %s",
665
pjsip_evsub_get_state_name(uapres->sub),
668
uapres = uapres->next;
674
* Dumping all client (UAC) subscriptions
676
PJ_LOG(3,(THIS_FILE, "Dumping pjsua client subscriptions:"));
678
if (pjsua_var.buddy_cnt == 0) {
680
PJ_LOG(3,(THIS_FILE, " - no buddy list - "));
683
for (i=0; i<PJ_ARRAY_SIZE(pjsua_var.buddy); ++i) {
685
if (pjsua_var.buddy[i].uri.slen == 0)
688
if (pjsua_var.buddy[i].sub) {
689
PJ_LOG(3,(THIS_FILE, " %10s %.*s",
690
pjsip_evsub_get_state_name(pjsua_var.buddy[i].sub),
691
(int)pjsua_var.buddy[i].uri.slen,
692
pjsua_var.buddy[i].uri.ptr));
694
PJ_LOG(3,(THIS_FILE, " %10s %.*s",
696
(int)pjsua_var.buddy[i].uri.slen,
697
pjsua_var.buddy[i].uri.ptr));
706
/***************************************************************************
707
* Server subscription.
711
static pj_bool_t pres_on_rx_request(pjsip_rx_data *rdata);
713
/* The module instance. */
714
static pjsip_module mod_pjsua_pres =
716
NULL, NULL, /* prev, next. */
717
{ "mod-pjsua-pres", 14 }, /* Name. */
719
PJSIP_MOD_PRIORITY_APPLICATION, /* Priority */
724
&pres_on_rx_request, /* on_rx_request() */
725
NULL, /* on_rx_response() */
726
NULL, /* on_tx_request. */
727
NULL, /* on_tx_response() */
728
NULL, /* on_tsx_state() */
733
/* Callback called when *server* subscription state has changed. */
734
static void pres_evsub_on_srv_state( pjsip_evsub *sub, pjsip_event *event)
736
pjsua_srv_pres *uapres;
738
PJ_UNUSED_ARG(event);
742
uapres = (pjsua_srv_pres*) pjsip_evsub_get_mod_data(sub, pjsua_var.mod.id);
744
pjsip_evsub_state state;
746
PJ_LOG(4,(THIS_FILE, "Server subscription to %s is %s",
747
uapres->remote, pjsip_evsub_get_state_name(sub)));
749
state = pjsip_evsub_get_state(sub);
751
if (pjsua_var.ua_cfg.cb.on_srv_subscribe_state) {
754
from = uapres->dlg->remote.info_str;
755
(*pjsua_var.ua_cfg.cb.on_srv_subscribe_state)(uapres->acc_id,
760
if (state == PJSIP_EVSUB_STATE_TERMINATED) {
761
pjsip_evsub_set_mod_data(sub, pjsua_var.mod.id, NULL);
762
pj_list_erase(uapres);
769
/* This is called when request is received.
770
* We need to check for incoming SUBSCRIBE request.
772
static pj_bool_t pres_on_rx_request(pjsip_rx_data *rdata)
777
pjsip_method *req_method = &rdata->msg_info.msg->line.req.method;
778
pjsua_srv_pres *uapres;
780
pjsip_evsub_user pres_cb;
782
pjsip_status_code st_code;
784
pjsip_expires_hdr *expires_hdr;
785
pjsua_msg_data msg_data;
788
if (pjsip_method_cmp(req_method, pjsip_get_subscribe_method()) != 0)
791
/* Incoming SUBSCRIBE: */
793
/* Don't want to accept the request if shutdown is in progress */
794
if (pjsua_var.thread_quit_flag) {
795
pjsip_endpt_respond_stateless(pjsua_var.endpt, rdata,
796
PJSIP_SC_TEMPORARILY_UNAVAILABLE, NULL,
803
/* Find which account for the incoming request. */
804
acc_id = pjsua_acc_find_for_incoming(rdata);
805
acc = &pjsua_var.acc[acc_id];
807
PJ_LOG(4,(THIS_FILE, "Creating server subscription, using account %d",
810
/* Create suitable Contact header */
811
if (acc->contact.slen) {
812
contact = acc->contact;
814
status = pjsua_acc_create_uas_contact(rdata->tp_info.pool, &contact,
816
if (status != PJ_SUCCESS) {
817
pjsua_perror(THIS_FILE, "Unable to generate Contact header",
820
pjsip_endpt_respond_stateless(pjsua_var.endpt, rdata, 400, NULL,
826
/* Create UAS dialog: */
827
status = pjsip_dlg_create_uas(pjsip_ua_instance(), rdata,
829
if (status != PJ_SUCCESS) {
830
pjsua_perror(THIS_FILE,
831
"Unable to create UAS dialog for subscription",
834
pjsip_endpt_respond_stateless(pjsua_var.endpt, rdata, 400, NULL,
839
/* Set credentials and preference. */
840
pjsip_auth_clt_set_credentials(&dlg->auth_sess, acc->cred_cnt, acc->cred);
841
pjsip_auth_clt_set_prefs(&dlg->auth_sess, &acc->cfg.auth_pref);
844
pj_bzero(&pres_cb, sizeof(pres_cb));
845
pres_cb.on_evsub_state = &pres_evsub_on_srv_state;
847
/* Create server presence subscription: */
848
status = pjsip_pres_create_uas( dlg, &pres_cb, rdata, &sub);
849
if (status != PJ_SUCCESS) {
850
int code = PJSIP_ERRNO_TO_SIP_STATUS(status);
851
pjsip_tx_data *tdata;
853
pjsua_perror(THIS_FILE, "Unable to create server subscription",
856
if (code==599 || code > 699 || code < 300) {
860
status = pjsip_dlg_create_response(dlg, rdata, code, NULL, &tdata);
861
if (status == PJ_SUCCESS) {
862
status = pjsip_dlg_send_response(dlg, pjsip_rdata_get_tsx(rdata),
870
/* If account is locked to specific transport, then lock dialog
871
* to this transport too.
873
if (acc->cfg.transport_id != PJSUA_INVALID_ID) {
874
pjsip_tpselector tp_sel;
876
pjsua_init_tpselector(acc->cfg.transport_id, &tp_sel);
877
pjsip_dlg_set_transport(dlg, &tp_sel);
880
/* Attach our data to the subscription: */
881
uapres = PJ_POOL_ALLOC_T(dlg->pool, pjsua_srv_pres);
883
uapres->remote = (char*) pj_pool_alloc(dlg->pool, PJSIP_MAX_URL_SIZE);
884
uapres->acc_id = acc_id;
886
status = pjsip_uri_print(PJSIP_URI_IN_REQ_URI, dlg->remote.info->uri,
887
uapres->remote, PJSIP_MAX_URL_SIZE);
889
pj_ansi_strcpy(uapres->remote, "<-- url is too long-->");
891
uapres->remote[status] = '\0';
893
pjsip_evsub_add_header(sub, &acc->cfg.sub_hdr_list);
894
pjsip_evsub_set_mod_data(sub, pjsua_var.mod.id, uapres);
896
/* Add server subscription to the list: */
897
pj_list_push_back(&pjsua_var.acc[acc_id].pres_srv_list, uapres);
900
/* Capture the value of Expires header. */
901
expires_hdr = (pjsip_expires_hdr*)
902
pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_EXPIRES,
905
uapres->expires = expires_hdr->ivalue;
907
uapres->expires = -1;
909
st_code = (pjsip_status_code)200;
910
reason = pj_str("OK");
911
pjsua_msg_data_init(&msg_data);
913
/* Notify application callback, if any */
914
if (pjsua_var.ua_cfg.cb.on_incoming_subscribe) {
915
pjsua_buddy_id buddy_id;
917
buddy_id = find_buddy(rdata->msg_info.from->uri);
919
(*pjsua_var.ua_cfg.cb.on_incoming_subscribe)(acc_id, uapres, buddy_id,
920
&dlg->remote.info_str,
921
rdata, &st_code, &reason,
925
/* Handle rejection case */
926
if (st_code >= 300) {
927
pjsip_tx_data *tdata;
929
/* Create response */
930
status = pjsip_dlg_create_response(dlg, rdata, st_code,
932
if (status != PJ_SUCCESS) {
933
pjsua_perror(THIS_FILE, "Error creating response", status);
934
pj_list_erase(uapres);
935
pjsip_pres_terminate(sub, PJ_FALSE);
940
/* Add header list, if any */
941
pjsua_process_msg_data(tdata, &msg_data);
943
/* Send the response */
944
status = pjsip_dlg_send_response(dlg, pjsip_rdata_get_tsx(rdata),
946
if (status != PJ_SUCCESS) {
947
pjsua_perror(THIS_FILE, "Error sending response", status);
948
/* This is not fatal */
951
/* Terminate presence subscription */
952
pj_list_erase(uapres);
953
pjsip_pres_terminate(sub, PJ_FALSE);
958
/* Create and send 2xx response to the SUBSCRIBE request: */
959
status = pjsip_pres_accept(sub, rdata, st_code, &msg_data.hdr_list);
960
if (status != PJ_SUCCESS) {
961
pjsua_perror(THIS_FILE, "Unable to accept presence subscription",
963
pj_list_erase(uapres);
964
pjsip_pres_terminate(sub, PJ_FALSE);
969
/* If code is 200, send NOTIFY now */
970
if (st_code == 200) {
971
pjsua_pres_notify(acc_id, uapres, PJSIP_EVSUB_STATE_ACTIVE,
972
NULL, NULL, PJ_TRUE, &msg_data);
986
PJ_DEF(pj_status_t) pjsua_pres_notify( pjsua_acc_id acc_id,
987
pjsua_srv_pres *srv_pres,
988
pjsip_evsub_state ev_state,
989
const pj_str_t *state_str,
990
const pj_str_t *reason,
992
const pjsua_msg_data *msg_data)
995
pjsip_pres_status pres_status;
996
pjsua_buddy_id buddy_id;
997
pjsip_tx_data *tdata;
1000
/* Check parameters */
1001
PJ_ASSERT_RETURN(acc_id!=-1 && srv_pres, PJ_EINVAL);
1003
/* Check that account ID is valid */
1004
PJ_ASSERT_RETURN(acc_id>=0 && acc_id<(int)PJ_ARRAY_SIZE(pjsua_var.acc),
1006
/* Check that account is valid */
1007
PJ_ASSERT_RETURN(pjsua_var.acc[acc_id].valid, PJ_EINVALIDOP);
1011
acc = &pjsua_var.acc[acc_id];
1013
/* Check that the server presence subscription is still valid */
1014
if (pj_list_find_node(&acc->pres_srv_list, srv_pres) == NULL) {
1015
/* Subscription has been terminated */
1017
return PJ_EINVALIDOP;
1020
/* Set our online status: */
1021
pj_bzero(&pres_status, sizeof(pres_status));
1022
pres_status.info_cnt = 1;
1023
pres_status.info[0].basic_open = acc->online_status;
1024
pres_status.info[0].id = acc->cfg.pidf_tuple_id;
1025
//Both pjsua_var.local_uri and pjsua_var.contact_uri are enclosed in "<" and ">"
1026
//causing XML parsing to fail.
1027
//pres_status.info[0].contact = pjsua_var.local_uri;
1028
/* add RPID information */
1029
pj_memcpy(&pres_status.info[0].rpid, &acc->rpid,
1030
sizeof(pjrpid_element));
1032
pjsip_pres_set_status(srv_pres->sub, &pres_status);
1034
/* Check expires value. If it's zero, send our presense state but
1035
* set subscription state to TERMINATED.
1037
if (srv_pres->expires == 0)
1038
ev_state = PJSIP_EVSUB_STATE_TERMINATED;
1040
/* Create and send the NOTIFY to active subscription: */
1041
status = pjsip_pres_notify(srv_pres->sub, ev_state, state_str,
1043
if (status == PJ_SUCCESS) {
1044
/* Force removal of message body if msg_body==FALSE */
1046
tdata->msg->body = NULL;
1048
pjsua_process_msg_data(tdata, msg_data);
1049
status = pjsip_pres_send_request( srv_pres->sub, tdata);
1052
if (status != PJ_SUCCESS) {
1053
pjsua_perror(THIS_FILE, "Unable to create/send NOTIFY",
1055
pj_list_erase(srv_pres);
1056
pjsip_pres_terminate(srv_pres->sub, PJ_FALSE);
1062
/* Subscribe to buddy's presence if we're not subscribed */
1063
buddy_id = find_buddy(srv_pres->dlg->remote.info->uri);
1064
if (buddy_id != PJSUA_INVALID_ID) {
1065
pjsua_buddy *b = &pjsua_var.buddy[buddy_id];
1066
if (b->monitor && b->sub == NULL) {
1067
PJ_LOG(4,(THIS_FILE, "Received SUBSCRIBE from buddy %d, "
1068
"activating outgoing subscription", buddy_id));
1069
subscribe_buddy_presence(buddy_id);
1080
* Client presence publication callback.
1082
static void publish_cb(struct pjsip_publishc_cbparam *param)
1084
pjsua_acc *acc = (pjsua_acc*) param->token;
1086
if (param->code/100 != 2 || param->status != PJ_SUCCESS) {
1088
pjsip_publishc_destroy(param->pubc);
1089
acc->publish_sess = NULL;
1091
if (param->status != PJ_SUCCESS) {
1092
char errmsg[PJ_ERR_MSG_SIZE];
1094
pj_strerror(param->status, errmsg, sizeof(errmsg));
1095
PJ_LOG(1,(THIS_FILE,
1096
"Client publication (PUBLISH) failed, status=%d, msg=%s",
1097
param->status, errmsg));
1098
} else if (param->code == 412) {
1099
/* 412 (Conditional Request Failed)
1100
* The PUBLISH refresh has failed, retry with new one.
1102
pjsua_pres_init_publish_acc(acc->index);
1105
PJ_LOG(1,(THIS_FILE,
1106
"Client publication (PUBLISH) failed (%d/%.*s)",
1107
param->code, (int)param->reason.slen,
1108
param->reason.ptr));
1112
if (param->expiration < 1) {
1113
/* Could happen if server "forgot" to include Expires header
1114
* in the response. We will not renew, so destroy the pubc.
1116
pjsip_publishc_destroy(param->pubc);
1117
acc->publish_sess = NULL;
1124
* Send PUBLISH request.
1126
static pj_status_t send_publish(int acc_id, pj_bool_t active)
1128
pjsua_acc_config *acc_cfg = &pjsua_var.acc[acc_id].cfg;
1129
pjsua_acc *acc = &pjsua_var.acc[acc_id];
1130
pjsip_pres_status pres_status;
1131
pjsip_tx_data *tdata;
1135
/* Create PUBLISH request */
1140
status = pjsip_publishc_publish(acc->publish_sess, PJ_TRUE, &tdata);
1141
if (status != PJ_SUCCESS) {
1142
pjsua_perror(THIS_FILE, "Error creating PUBLISH request", status);
1146
/* Set our online status: */
1147
pj_bzero(&pres_status, sizeof(pres_status));
1148
pres_status.info_cnt = 1;
1149
pres_status.info[0].basic_open = acc->online_status;
1150
pres_status.info[0].id = acc->cfg.pidf_tuple_id;
1151
/* .. including RPID information */
1152
pj_memcpy(&pres_status.info[0].rpid, &acc->rpid,
1153
sizeof(pjrpid_element));
1155
/* Be careful not to send PIDF with presence entity ID containing
1158
if ((bpos=pj_strchr(&acc_cfg->id, '<')) != NULL) {
1159
char *epos = pj_strchr(&acc_cfg->id, '>');
1160
if (epos - bpos < 2) {
1161
pj_assert(!"Unexpected invalid URI");
1162
status = PJSIP_EINVALIDURI;
1165
entity.ptr = bpos+1;
1166
entity.slen = epos - bpos - 1;
1168
entity = acc_cfg->id;
1171
/* Create and add PIDF message body */
1172
status = pjsip_pres_create_pidf(tdata->pool, &pres_status,
1173
&entity, &tdata->msg->body);
1174
if (status != PJ_SUCCESS) {
1175
pjsua_perror(THIS_FILE, "Error creating PIDF for PUBLISH request",
1177
pjsip_tx_data_dec_ref(tdata);
1181
status = pjsip_publishc_unpublish(acc->publish_sess, &tdata);
1182
if (status != PJ_SUCCESS) {
1183
pjsua_perror(THIS_FILE, "Error creating PUBLISH request", status);
1188
/* Add headers etc */
1189
pjsua_process_msg_data(tdata, NULL);
1191
/* Send the PUBLISH request */
1192
status = pjsip_publishc_send(acc->publish_sess, tdata);
1193
if (status == PJ_EPENDING) {
1194
PJ_LOG(3,(THIS_FILE, "Previous request is in progress, "
1195
"PUBLISH request is queued"));
1196
} else if (status != PJ_SUCCESS) {
1197
pjsua_perror(THIS_FILE, "Error sending PUBLISH request", status);
1201
acc->publish_state = acc->online_status;
1205
if (acc->publish_sess) {
1206
pjsip_publishc_destroy(acc->publish_sess);
1207
acc->publish_sess = NULL;
1213
/* Create client publish session */
1214
pj_status_t pjsua_pres_init_publish_acc(int acc_id)
1216
const pj_str_t STR_PRESENCE = { "presence", 8 };
1217
pjsua_acc_config *acc_cfg = &pjsua_var.acc[acc_id].cfg;
1218
pjsua_acc *acc = &pjsua_var.acc[acc_id];
1221
/* Create and init client publication session */
1222
if (acc_cfg->publish_enabled) {
1224
/* Create client publication */
1225
status = pjsip_publishc_create(pjsua_var.endpt, &acc_cfg->publish_opt,
1227
&acc->publish_sess);
1228
if (status != PJ_SUCCESS) {
1229
acc->publish_sess = NULL;
1233
/* Initialize client publication */
1234
status = pjsip_publishc_init(acc->publish_sess, &STR_PRESENCE,
1235
&acc_cfg->id, &acc_cfg->id,
1237
PJSUA_PUBLISH_EXPIRATION);
1238
if (status != PJ_SUCCESS) {
1239
acc->publish_sess = NULL;
1243
/* Add credential for authentication */
1244
if (acc->cred_cnt) {
1245
pjsip_publishc_set_credentials(acc->publish_sess, acc->cred_cnt,
1250
pjsip_publishc_set_route_set(acc->publish_sess, &acc->route_set);
1252
/* Send initial PUBLISH request */
1253
if (acc->online_status != 0) {
1254
status = send_publish(acc_id, PJ_TRUE);
1255
if (status != PJ_SUCCESS)
1260
acc->publish_sess = NULL;
1267
/* Init presence for account */
1268
pj_status_t pjsua_pres_init_acc(int acc_id)
1270
pjsua_acc *acc = &pjsua_var.acc[acc_id];
1272
/* Init presence subscription */
1273
pj_list_init(&acc->pres_srv_list);
1279
/* Unpublish presence publication */
1280
void pjsua_pres_unpublish(pjsua_acc *acc)
1282
if (acc->publish_sess) {
1283
pjsua_acc_config *acc_cfg = &acc->cfg;
1285
acc->online_status = PJ_FALSE;
1286
send_publish(acc->index, PJ_FALSE);
1287
/* By ticket #364, don't destroy the session yet (let the callback
1289
if (acc->publish_sess) {
1290
pjsip_publishc_destroy(acc->publish_sess);
1291
acc->publish_sess = NULL;
1294
acc_cfg->publish_enabled = PJ_FALSE;
1298
/* Terminate server subscription for the account */
1299
void pjsua_pres_delete_acc(int acc_id)
1301
pjsua_acc *acc = &pjsua_var.acc[acc_id];
1302
pjsua_srv_pres *uapres;
1304
uapres = pjsua_var.acc[acc_id].pres_srv_list.next;
1306
/* Notify all subscribers that we're no longer available */
1307
while (uapres != &acc->pres_srv_list) {
1309
pjsip_pres_status pres_status;
1310
pj_str_t reason = { "noresource", 10 };
1311
pjsua_srv_pres *next;
1312
pjsip_tx_data *tdata;
1314
next = uapres->next;
1316
pjsip_pres_get_status(uapres->sub, &pres_status);
1318
pres_status.info[0].basic_open = pjsua_var.acc[acc_id].online_status;
1319
pjsip_pres_set_status(uapres->sub, &pres_status);
1321
if (pjsip_pres_notify(uapres->sub,
1322
PJSIP_EVSUB_STATE_TERMINATED, NULL,
1323
&reason, &tdata)==PJ_SUCCESS)
1325
pjsip_pres_send_request(uapres->sub, tdata);
1331
/* Clear server presence subscription list because account might be reused
1333
pj_list_init(&acc->pres_srv_list);
1335
/* Terminate presence publication, if any */
1336
pjsua_pres_unpublish(acc);
1340
/* Update server subscription (e.g. when our online status has changed) */
1341
void pjsua_pres_update_acc(int acc_id, pj_bool_t force)
1343
pjsua_acc *acc = &pjsua_var.acc[acc_id];
1344
pjsua_acc_config *acc_cfg = &pjsua_var.acc[acc_id].cfg;
1345
pjsua_srv_pres *uapres;
1347
uapres = pjsua_var.acc[acc_id].pres_srv_list.next;
1349
while (uapres != &acc->pres_srv_list) {
1351
pjsip_pres_status pres_status;
1352
pjsip_tx_data *tdata;
1354
pjsip_pres_get_status(uapres->sub, &pres_status);
1356
/* Only send NOTIFY once subscription is active. Some subscriptions
1357
* may still be in NULL (when app is adding a new buddy while in the
1358
* on_incoming_subscribe() callback) or PENDING (when user approval is
1359
* being requested) state and we don't send NOTIFY to these subs until
1360
* the user accepted the request.
1362
if (pjsip_evsub_get_state(uapres->sub)==PJSIP_EVSUB_STATE_ACTIVE &&
1363
(force || pres_status.info[0].basic_open != acc->online_status))
1366
pres_status.info[0].basic_open = acc->online_status;
1367
pj_memcpy(&pres_status.info[0].rpid, &acc->rpid,
1368
sizeof(pjrpid_element));
1370
pjsip_pres_set_status(uapres->sub, &pres_status);
1372
if (pjsip_pres_current_notify(uapres->sub, &tdata)==PJ_SUCCESS) {
1373
pjsua_process_msg_data(tdata, NULL);
1374
pjsip_pres_send_request(uapres->sub, tdata);
1378
uapres = uapres->next;
1381
/* Send PUBLISH if required. We only do this when we have a PUBLISH
1382
* session. If we don't have a PUBLISH session, then it could be
1383
* that we're waiting until registration has completed before we
1384
* send the first PUBLISH.
1386
if (acc_cfg->publish_enabled && acc->publish_sess) {
1387
if (force || acc->publish_state != acc->online_status) {
1388
send_publish(acc_id, PJ_TRUE);
1395
/***************************************************************************
1396
* Client subscription.
1399
static void buddy_timer_cb(pj_timer_heap_t *th, pj_timer_entry *entry)
1401
pjsua_buddy *buddy = (pjsua_buddy*)entry->user_data;
1405
entry->id = PJ_FALSE;
1406
pjsua_buddy_update_pres(buddy->index);
1409
/* Reschedule subscription refresh timer or terminate the subscription
1410
* refresh timer for the specified buddy.
1412
static void buddy_resubscribe(pjsua_buddy *buddy, pj_bool_t resched,
1413
unsigned msec_interval)
1415
if (buddy->timer.id) {
1416
pjsua_cancel_timer(&buddy->timer);
1417
buddy->timer.id = PJ_FALSE;
1423
PJ_LOG(4,(THIS_FILE,
1424
"Resubscribing buddy id %u in %u ms (reason: %.*s)",
1425
buddy->index, msec_interval,
1426
(int)buddy->term_reason.slen,
1427
buddy->term_reason.ptr));
1429
pj_timer_entry_init(&buddy->timer, 0, buddy, &buddy_timer_cb);
1431
delay.msec = msec_interval;
1432
pj_time_val_normalize(&delay);
1434
if (pjsua_schedule_timer(&buddy->timer, &delay)==PJ_SUCCESS)
1435
buddy->timer.id = PJ_TRUE;
1439
/* Callback called when *client* subscription state has changed. */
1440
static void pjsua_evsub_on_state( pjsip_evsub *sub, pjsip_event *event)
1444
PJ_UNUSED_ARG(event);
1446
/* Note: #937: no need to acuire PJSUA_LOCK here. Since the buddy has
1447
* a dialog attached to it, lock_buddy() will use the dialog
1448
* lock, which we are currently holding!
1450
buddy = (pjsua_buddy*) pjsip_evsub_get_mod_data(sub, pjsua_var.mod.id);
1452
PJ_LOG(4,(THIS_FILE,
1453
"Presence subscription to %.*s is %s",
1454
(int)pjsua_var.buddy[buddy->index].uri.slen,
1455
pjsua_var.buddy[buddy->index].uri.ptr,
1456
pjsip_evsub_get_state_name(sub)));
1458
if (pjsip_evsub_get_state(sub) == PJSIP_EVSUB_STATE_TERMINATED) {
1459
int resub_delay = -1;
1461
if (buddy->term_reason.ptr == NULL) {
1462
buddy->term_reason.ptr = (char*)
1463
pj_pool_alloc(buddy->pool,
1464
PJSUA_BUDDY_SUB_TERM_REASON_LEN);
1466
pj_strncpy(&buddy->term_reason,
1467
pjsip_evsub_get_termination_reason(sub),
1468
PJSUA_BUDDY_SUB_TERM_REASON_LEN);
1470
buddy->term_code = 200;
1472
/* Determine whether to resubscribe automatically */
1473
if (event && event->type==PJSIP_EVENT_TSX_STATE) {
1474
const pjsip_transaction *tsx = event->body.tsx_state.tsx;
1475
if (pjsip_method_cmp(&tsx->method,
1476
&pjsip_subscribe_method)==0)
1478
buddy->term_code = tsx->status_code;
1479
switch (tsx->status_code) {
1480
case PJSIP_SC_CALL_TSX_DOES_NOT_EXIST:
1481
/* 481: we refreshed too late? resubscribe
1484
/* But this must only happen when the 481 is received
1485
* on subscription refresh request. We MUST NOT try to
1486
* resubscribe automatically if the 481 is received
1487
* on the initial SUBSCRIBE (if server returns this
1488
* response for some reason).
1490
if (buddy->dlg->remote.contact)
1494
} else if (pjsip_method_cmp(&tsx->method,
1495
&pjsip_notify_method)==0)
1497
if (pj_stricmp2(&buddy->term_reason, "deactivated")==0 ||
1498
pj_stricmp2(&buddy->term_reason, "timeout")==0) {
1499
/* deactivated: The subscription has been terminated,
1500
* but the subscriber SHOULD retry immediately with
1501
* a new subscription.
1503
/* timeout: The subscription has been terminated
1504
* because it was not refreshed before it expired.
1505
* Clients MAY re-subscribe immediately. The
1506
* "retry-after" parameter has no semantics for
1511
else if (pj_stricmp2(&buddy->term_reason, "probation")==0||
1512
pj_stricmp2(&buddy->term_reason, "giveup")==0) {
1513
/* probation: The subscription has been terminated,
1514
* but the client SHOULD retry at some later time.
1515
* If a "retry-after" parameter is also present, the
1516
* client SHOULD wait at least the number of seconds
1517
* specified by that parameter before attempting to re-
1520
/* giveup: The subscription has been terminated because
1521
* the notifier could not obtain authorization in a
1522
* timely fashion. If a "retry-after" parameter is
1523
* also present, the client SHOULD wait at least the
1524
* number of seconds specified by that parameter before
1525
* attempting to re-subscribe; otherwise, the client
1526
* MAY retry immediately, but will likely get put back
1527
* into pending state.
1529
const pjsip_sub_state_hdr *sub_hdr;
1530
pj_str_t sub_state = { "Subscription-State", 18 };
1531
const pjsip_msg *msg;
1533
msg = event->body.tsx_state.src.rdata->msg_info.msg;
1534
sub_hdr = (const pjsip_sub_state_hdr*)
1535
pjsip_msg_find_hdr_by_name(msg, &sub_state,
1537
if (sub_hdr && sub_hdr->retry_after > 0)
1538
resub_delay = sub_hdr->retry_after * 1000;
1544
/* For other cases of subscription termination, if resubscribe
1545
* timer is not set, schedule with default expiration (plus minus
1546
* some random value, to avoid sending SUBSCRIBEs all at once)
1548
if (resub_delay == -1) {
1549
pj_assert(PJSUA_PRES_TIMER >= 3);
1550
resub_delay = PJSUA_PRES_TIMER*1000 - 2500 + (pj_rand()%5000);
1553
buddy_resubscribe(buddy, PJ_TRUE, resub_delay);
1556
/* This will clear the last termination code/reason */
1557
buddy->term_code = 0;
1558
buddy->term_reason.slen = 0;
1561
/* Call callbacks */
1562
if (pjsua_var.ua_cfg.cb.on_buddy_evsub_state)
1563
(*pjsua_var.ua_cfg.cb.on_buddy_evsub_state)(buddy->index, sub,
1566
if (pjsua_var.ua_cfg.cb.on_buddy_state)
1567
(*pjsua_var.ua_cfg.cb.on_buddy_state)(buddy->index);
1569
/* Clear subscription */
1570
if (pjsip_evsub_get_state(sub) == PJSIP_EVSUB_STATE_TERMINATED) {
1572
buddy->status.info_cnt = 0;
1574
pjsip_evsub_set_mod_data(sub, pjsua_var.mod.id, NULL);
1580
/* Callback when transaction state has changed. */
1581
static void pjsua_evsub_on_tsx_state(pjsip_evsub *sub,
1582
pjsip_transaction *tsx,
1586
pjsip_contact_hdr *contact_hdr;
1588
/* Note: #937: no need to acuire PJSUA_LOCK here. Since the buddy has
1589
* a dialog attached to it, lock_buddy() will use the dialog
1590
* lock, which we are currently holding!
1592
buddy = (pjsua_buddy*) pjsip_evsub_get_mod_data(sub, pjsua_var.mod.id);
1597
/* We only use this to update buddy's Contact, when it's not
1600
if (buddy->contact.slen != 0) {
1601
/* Contact already set */
1605
/* Only care about 2xx response to outgoing SUBSCRIBE */
1606
if (tsx->status_code/100 != 2 ||
1607
tsx->role != PJSIP_UAC_ROLE ||
1608
event->type != PJSIP_EVENT_RX_MSG ||
1609
pjsip_method_cmp(&tsx->method, pjsip_get_subscribe_method())!=0)
1614
/* Find contact header. */
1615
contact_hdr = (pjsip_contact_hdr*)
1616
pjsip_msg_find_hdr(event->body.rx_msg.rdata->msg_info.msg,
1617
PJSIP_H_CONTACT, NULL);
1618
if (!contact_hdr || !contact_hdr->uri) {
1622
buddy->contact.ptr = (char*)
1623
pj_pool_alloc(buddy->pool, PJSIP_MAX_URL_SIZE);
1624
buddy->contact.slen = pjsip_uri_print( PJSIP_URI_IN_CONTACT_HDR,
1627
PJSIP_MAX_URL_SIZE);
1628
if (buddy->contact.slen < 0)
1629
buddy->contact.slen = 0;
1633
/* Callback called when we receive NOTIFY */
1634
static void pjsua_evsub_on_rx_notify(pjsip_evsub *sub,
1635
pjsip_rx_data *rdata,
1637
pj_str_t **p_st_text,
1639
pjsip_msg_body **p_body)
1643
/* Note: #937: no need to acuire PJSUA_LOCK here. Since the buddy has
1644
* a dialog attached to it, lock_buddy() will use the dialog
1645
* lock, which we are currently holding!
1647
buddy = (pjsua_buddy*) pjsip_evsub_get_mod_data(sub, pjsua_var.mod.id);
1649
/* Update our info. */
1650
pjsip_pres_get_status(sub, &buddy->status);
1653
/* The default is to send 200 response to NOTIFY.
1654
* Just leave it there..
1656
PJ_UNUSED_ARG(rdata);
1657
PJ_UNUSED_ARG(p_st_code);
1658
PJ_UNUSED_ARG(p_st_text);
1659
PJ_UNUSED_ARG(res_hdr);
1660
PJ_UNUSED_ARG(p_body);
1664
/* It does what it says.. */
1665
static void subscribe_buddy_presence(pjsua_buddy_id buddy_id)
1667
pjsip_evsub_user pres_callback;
1668
pj_pool_t *tmp_pool = NULL;
1673
pjsip_tx_data *tdata;
1676
/* Event subscription callback. */
1677
pj_bzero(&pres_callback, sizeof(pres_callback));
1678
pres_callback.on_evsub_state = &pjsua_evsub_on_state;
1679
pres_callback.on_tsx_state = &pjsua_evsub_on_tsx_state;
1680
pres_callback.on_rx_notify = &pjsua_evsub_on_rx_notify;
1682
buddy = &pjsua_var.buddy[buddy_id];
1683
acc_id = pjsua_acc_find_for_outgoing(&buddy->uri);
1685
acc = &pjsua_var.acc[acc_id];
1687
PJ_LOG(4,(THIS_FILE, "Using account %d for buddy %d subscription",
1690
/* Generate suitable Contact header unless one is already set in
1693
if (acc->contact.slen) {
1694
contact = acc->contact;
1696
tmp_pool = pjsua_pool_create("tmpbuddy", 512, 256);
1698
status = pjsua_acc_create_uac_contact(tmp_pool, &contact,
1699
acc_id, &buddy->uri);
1700
if (status != PJ_SUCCESS) {
1701
pjsua_perror(THIS_FILE, "Unable to generate Contact header",
1703
pj_pool_release(tmp_pool);
1708
/* Create UAC dialog */
1709
status = pjsip_dlg_create_uac( pjsip_ua_instance(),
1714
if (status != PJ_SUCCESS) {
1715
pjsua_perror(THIS_FILE, "Unable to create dialog",
1717
if (tmp_pool) pj_pool_release(tmp_pool);
1721
/* Increment the dialog's lock otherwise when presence session creation
1722
* fails the dialog will be destroyed prematurely.
1724
pjsip_dlg_inc_lock(buddy->dlg);
1726
status = pjsip_pres_create_uac( buddy->dlg, &pres_callback,
1727
PJSIP_EVSUB_NO_EVENT_ID, &buddy->sub);
1728
if (status != PJ_SUCCESS) {
1730
pjsua_perror(THIS_FILE, "Unable to create presence client",
1732
/* This should destroy the dialog since there's no session
1735
if (buddy->dlg) pjsip_dlg_dec_lock(buddy->dlg);
1736
if (tmp_pool) pj_pool_release(tmp_pool);
1740
/* If account is locked to specific transport, then lock dialog
1741
* to this transport too.
1743
if (acc->cfg.transport_id != PJSUA_INVALID_ID) {
1744
pjsip_tpselector tp_sel;
1746
pjsua_init_tpselector(acc->cfg.transport_id, &tp_sel);
1747
pjsip_dlg_set_transport(buddy->dlg, &tp_sel);
1751
if (!pj_list_empty(&acc->route_set)) {
1752
pjsip_dlg_set_route_set(buddy->dlg, &acc->route_set);
1755
/* Set credentials */
1756
if (acc->cred_cnt) {
1757
pjsip_auth_clt_set_credentials( &buddy->dlg->auth_sess,
1758
acc->cred_cnt, acc->cred);
1761
/* Set authentication preference */
1762
pjsip_auth_clt_set_prefs(&buddy->dlg->auth_sess, &acc->cfg.auth_pref);
1764
pjsip_evsub_set_mod_data(buddy->sub, pjsua_var.mod.id, buddy);
1766
status = pjsip_pres_initiate(buddy->sub, -1, &tdata);
1767
if (status != PJ_SUCCESS) {
1768
if (buddy->dlg) pjsip_dlg_dec_lock(buddy->dlg);
1770
pjsip_pres_terminate(buddy->sub, PJ_FALSE);
1773
pjsua_perror(THIS_FILE, "Unable to create initial SUBSCRIBE",
1775
if (tmp_pool) pj_pool_release(tmp_pool);
1779
pjsua_process_msg_data(tdata, NULL);
1781
status = pjsip_pres_send_request(buddy->sub, tdata);
1782
if (status != PJ_SUCCESS) {
1783
if (buddy->dlg) pjsip_dlg_dec_lock(buddy->dlg);
1785
pjsip_pres_terminate(buddy->sub, PJ_FALSE);
1788
pjsua_perror(THIS_FILE, "Unable to send initial SUBSCRIBE",
1790
if (tmp_pool) pj_pool_release(tmp_pool);
1794
pjsip_dlg_dec_lock(buddy->dlg);
1795
if (tmp_pool) pj_pool_release(tmp_pool);
1799
/* It does what it says... */
1800
static void unsubscribe_buddy_presence(pjsua_buddy_id buddy_id)
1803
pjsip_tx_data *tdata;
1806
buddy = &pjsua_var.buddy[buddy_id];
1808
if (buddy->sub == NULL)
1811
if (pjsip_evsub_get_state(buddy->sub) == PJSIP_EVSUB_STATE_TERMINATED) {
1816
status = pjsip_pres_initiate( buddy->sub, 0, &tdata);
1817
if (status == PJ_SUCCESS) {
1818
pjsua_process_msg_data(tdata, NULL);
1819
status = pjsip_pres_send_request( buddy->sub, tdata );
1822
if (status != PJ_SUCCESS && buddy->sub) {
1823
pjsip_pres_terminate(buddy->sub, PJ_FALSE);
1825
pjsua_perror(THIS_FILE, "Unable to unsubscribe presence",
1830
/* It does what it says.. */
1831
static pj_status_t refresh_client_subscriptions(void)
1836
for (i=0; i<PJ_ARRAY_SIZE(pjsua_var.buddy); ++i) {
1837
struct buddy_lock lck;
1839
if (!pjsua_buddy_is_valid(i))
1842
status = lock_buddy("refresh_client_subscriptions()", i, &lck, 0);
1843
if (status != PJ_SUCCESS)
1846
if (pjsua_var.buddy[i].monitor && !pjsua_var.buddy[i].sub) {
1847
subscribe_buddy_presence(i);
1849
} else if (!pjsua_var.buddy[i].monitor && pjsua_var.buddy[i].sub) {
1850
unsubscribe_buddy_presence(i);
1860
/***************************************************************************
1863
/* Callback called when *client* subscription state has changed. */
1864
static void mwi_evsub_on_state( pjsip_evsub *sub, pjsip_event *event)
1868
PJ_UNUSED_ARG(event);
1870
/* Note: #937: no need to acuire PJSUA_LOCK here. Since the buddy has
1871
* a dialog attached to it, lock_buddy() will use the dialog
1872
* lock, which we are currently holding!
1874
acc = (pjsua_acc*) pjsip_evsub_get_mod_data(sub, pjsua_var.mod.id);
1878
PJ_LOG(4,(THIS_FILE,
1879
"MWI subscription for %.*s is %s",
1880
(int)acc->cfg.id.slen, acc->cfg.id.ptr,
1881
pjsip_evsub_get_state_name(sub)));
1883
if (pjsip_evsub_get_state(sub) == PJSIP_EVSUB_STATE_TERMINATED) {
1884
/* Clear subscription */
1885
acc->mwi_dlg = NULL;
1886
acc->mwi_sub = NULL;
1887
pjsip_evsub_set_mod_data(sub, pjsua_var.mod.id, NULL);
1892
/* Callback called when we receive NOTIFY */
1893
static void mwi_evsub_on_rx_notify(pjsip_evsub *sub,
1894
pjsip_rx_data *rdata,
1896
pj_str_t **p_st_text,
1898
pjsip_msg_body **p_body)
1900
pjsua_mwi_info mwi_info;
1903
PJ_UNUSED_ARG(p_st_code);
1904
PJ_UNUSED_ARG(p_st_text);
1905
PJ_UNUSED_ARG(res_hdr);
1906
PJ_UNUSED_ARG(p_body);
1908
acc = (pjsua_acc*) pjsip_evsub_get_mod_data(sub, pjsua_var.mod.id);
1912
/* Construct mwi_info */
1913
pj_bzero(&mwi_info, sizeof(mwi_info));
1914
mwi_info.evsub = sub;
1915
mwi_info.rdata = rdata;
1918
if (pjsua_var.ua_cfg.cb.on_mwi_info) {
1919
(*pjsua_var.ua_cfg.cb.on_mwi_info)(acc->index, &mwi_info);
1924
/* Event subscription callback. */
1925
static pjsip_evsub_user mwi_cb =
1927
&mwi_evsub_on_state,
1928
NULL, /* on_tsx_state: not interested */
1929
NULL, /* on_rx_refresh: don't care about SUBSCRIBE refresh, unless
1930
* we want to authenticate
1933
&mwi_evsub_on_rx_notify,
1935
NULL, /* on_client_refresh: Use default behaviour, which is to
1936
* refresh client subscription. */
1938
NULL, /* on_server_timeout: Use default behaviour, which is to send
1939
* NOTIFY to terminate.
1943
void pjsua_start_mwi(pjsua_acc *acc)
1945
pj_pool_t *tmp_pool = NULL;
1947
pjsip_tx_data *tdata;
1950
if (!acc->cfg.mwi_enabled) {
1952
/* Terminate MWI subscription */
1953
pjsip_tx_data *tdata;
1954
pjsip_evsub *sub = acc->mwi_sub;
1956
/* Detach sub from this account */
1957
acc->mwi_sub = NULL;
1958
acc->mwi_dlg = NULL;
1959
pjsip_evsub_set_mod_data(sub, pjsua_var.mod.id, NULL);
1962
status = pjsip_mwi_initiate(acc->mwi_sub, 0, &tdata);
1963
if (status == PJ_SUCCESS) {
1964
status = pjsip_mwi_send_request(acc->mwi_sub, tdata);
1971
/* Subscription is already active */
1976
/* Generate suitable Contact header unless one is already set in
1979
if (acc->contact.slen) {
1980
contact = acc->contact;
1982
tmp_pool = pjsua_pool_create("tmpmwi", 512, 256);
1983
status = pjsua_acc_create_uac_contact(tmp_pool, &contact,
1984
acc->index, &acc->cfg.id);
1985
if (status != PJ_SUCCESS) {
1986
pjsua_perror(THIS_FILE, "Unable to generate Contact header",
1988
pj_pool_release(tmp_pool);
1993
/* Create UAC dialog */
1994
status = pjsip_dlg_create_uac( pjsip_ua_instance(),
1998
NULL, &acc->mwi_dlg);
1999
if (status != PJ_SUCCESS) {
2000
pjsua_perror(THIS_FILE, "Unable to create dialog", status);
2001
if (tmp_pool) pj_pool_release(tmp_pool);
2005
/* Increment the dialog's lock otherwise when presence session creation
2006
* fails the dialog will be destroyed prematurely.
2008
pjsip_dlg_inc_lock(acc->mwi_dlg);
2010
/* Create UAC subscription */
2011
status = pjsip_mwi_create_uac(acc->mwi_dlg, &mwi_cb,
2012
PJSIP_EVSUB_NO_EVENT_ID, &acc->mwi_sub);
2013
if (status != PJ_SUCCESS) {
2014
pjsua_perror(THIS_FILE, "Error creating MWI subscription", status);
2015
if (tmp_pool) pj_pool_release(tmp_pool);
2016
if (acc->mwi_dlg) pjsip_dlg_dec_lock(acc->mwi_dlg);
2020
/* If account is locked to specific transport, then lock dialog
2021
* to this transport too.
2023
if (acc->cfg.transport_id != PJSUA_INVALID_ID) {
2024
pjsip_tpselector tp_sel;
2026
pjsua_init_tpselector(acc->cfg.transport_id, &tp_sel);
2027
pjsip_dlg_set_transport(acc->mwi_dlg, &tp_sel);
2031
if (!pj_list_empty(&acc->route_set)) {
2032
pjsip_dlg_set_route_set(acc->mwi_dlg, &acc->route_set);
2035
/* Set credentials */
2036
if (acc->cred_cnt) {
2037
pjsip_auth_clt_set_credentials( &acc->mwi_dlg->auth_sess,
2038
acc->cred_cnt, acc->cred);
2041
/* Set authentication preference */
2042
pjsip_auth_clt_set_prefs(&acc->mwi_dlg->auth_sess, &acc->cfg.auth_pref);
2044
pjsip_evsub_set_mod_data(acc->mwi_sub, pjsua_var.mod.id, acc);
2046
status = pjsip_mwi_initiate(acc->mwi_sub, -1, &tdata);
2047
if (status != PJ_SUCCESS) {
2048
if (acc->mwi_dlg) pjsip_dlg_dec_lock(acc->mwi_dlg);
2050
pjsip_pres_terminate(acc->mwi_sub, PJ_FALSE);
2052
acc->mwi_sub = NULL;
2053
acc->mwi_dlg = NULL;
2054
pjsua_perror(THIS_FILE, "Unable to create initial MWI SUBSCRIBE",
2056
if (tmp_pool) pj_pool_release(tmp_pool);
2060
pjsua_process_msg_data(tdata, NULL);
2062
status = pjsip_pres_send_request(acc->mwi_sub, tdata);
2063
if (status != PJ_SUCCESS) {
2064
if (acc->mwi_dlg) pjsip_dlg_dec_lock(acc->mwi_dlg);
2066
pjsip_pres_terminate(acc->mwi_sub, PJ_FALSE);
2068
acc->mwi_sub = NULL;
2069
acc->mwi_dlg = NULL;
2070
pjsua_perror(THIS_FILE, "Unable to send initial MWI SUBSCRIBE",
2072
if (tmp_pool) pj_pool_release(tmp_pool);
2076
pjsip_dlg_dec_lock(acc->mwi_dlg);
2077
if (tmp_pool) pj_pool_release(tmp_pool);
2082
/***************************************************************************
2085
static pj_bool_t unsolicited_mwi_on_rx_request(pjsip_rx_data *rdata)
2087
pjsip_msg *msg = rdata->msg_info.msg;
2088
pj_str_t EVENT_HDR = { "Event", 5 };
2089
pj_str_t MWI = { "message-summary", 15 };
2090
pjsip_event_hdr *eh;
2092
if (pjsip_method_cmp(&msg->line.req.method, &pjsip_notify_method)!=0) {
2093
/* Only interested with NOTIFY request */
2097
eh = (pjsip_event_hdr*) pjsip_msg_find_hdr_by_name(msg, &EVENT_HDR, NULL);
2099
/* Something wrong with the request, it has no Event hdr */
2103
if (pj_stricmp(&eh->event_type, &MWI) != 0) {
2108
/* Got unsolicited MWI request, respond with 200/OK first */
2109
pjsip_endpt_respond(pjsua_get_pjsip_endpt(), NULL, rdata, 200, NULL,
2114
if (pjsua_var.ua_cfg.cb.on_mwi_info) {
2115
pjsua_acc_id acc_id;
2116
pjsua_mwi_info mwi_info;
2118
acc_id = pjsua_acc_find_for_incoming(rdata);
2120
pj_bzero(&mwi_info, sizeof(mwi_info));
2121
mwi_info.rdata = rdata;
2123
(*pjsua_var.ua_cfg.cb.on_mwi_info)(acc_id, &mwi_info);
2130
/* The module instance. */
2131
static pjsip_module pjsua_unsolicited_mwi_mod =
2133
NULL, NULL, /* prev, next. */
2134
{ "mod-unsolicited-mwi", 19 }, /* Name. */
2136
PJSIP_MOD_PRIORITY_APPLICATION, /* Priority */
2140
NULL, /* unload() */
2141
&unsolicited_mwi_on_rx_request, /* on_rx_request() */
2142
NULL, /* on_rx_response() */
2143
NULL, /* on_tx_request. */
2144
NULL, /* on_tx_response() */
2145
NULL, /* on_tsx_state() */
2148
static pj_status_t enable_unsolicited_mwi(void)
2152
status = pjsip_endpt_register_module(pjsua_get_pjsip_endpt(),
2153
&pjsua_unsolicited_mwi_mod);
2154
if (status != PJ_SUCCESS)
2155
pjsua_perror(THIS_FILE, "Error registering unsolicited MWI module",
2163
/***************************************************************************/
2165
/* Timer callback to re-create client subscription */
2166
static void pres_timer_cb(pj_timer_heap_t *th,
2167
pj_timer_entry *entry)
2170
pj_time_val delay = { PJSUA_PRES_TIMER, 0 };
2172
entry->id = PJ_FALSE;
2174
/* Retry failed PUBLISH and MWI SUBSCRIBE requests */
2175
for (i=0; i<PJ_ARRAY_SIZE(pjsua_var.acc); ++i) {
2176
pjsua_acc *acc = &pjsua_var.acc[i];
2179
if (acc->cfg.publish_enabled && acc->publish_sess==NULL)
2180
pjsua_pres_init_publish_acc(acc->index);
2182
/* Re-subscribe MWI subscription if it's terminated prematurely */
2183
if (acc->cfg.mwi_enabled && !acc->mwi_sub)
2184
pjsua_start_mwi(acc);
2187
/* #937: No need to do bulk client refresh, as buddies have their
2188
* own individual timer now.
2190
//refresh_client_subscriptions();
2192
pjsip_endpt_schedule_timer(pjsua_var.endpt, entry, &delay);
2193
entry->id = PJ_TRUE;
2202
pj_status_t pjsua_pres_init()
2207
status = pjsip_endpt_register_module( pjsua_var.endpt, &mod_pjsua_pres);
2208
if (status != PJ_SUCCESS) {
2209
pjsua_perror(THIS_FILE, "Unable to register pjsua presence module",
2213
for (i=0; i<PJ_ARRAY_SIZE(pjsua_var.buddy); ++i) {
2222
* Start presence subsystem.
2224
pj_status_t pjsua_pres_start(void)
2226
/* Start presence timer to re-subscribe to buddy's presence when
2227
* subscription has failed.
2229
if (pjsua_var.pres_timer.id == PJ_FALSE) {
2230
pj_time_val pres_interval = {PJSUA_PRES_TIMER, 0};
2232
pjsua_var.pres_timer.cb = &pres_timer_cb;
2233
pjsip_endpt_schedule_timer(pjsua_var.endpt, &pjsua_var.pres_timer,
2235
pjsua_var.pres_timer.id = PJ_TRUE;
2238
if (pjsua_var.ua_cfg.enable_unsolicited_mwi) {
2239
pj_status_t status = enable_unsolicited_mwi();
2240
if (status != PJ_SUCCESS)
2249
* Shutdown presence.
2251
void pjsua_pres_shutdown(void)
2255
PJ_LOG(4,(THIS_FILE, "Shutting down presence.."));
2257
if (pjsua_var.pres_timer.id != 0) {
2258
pjsip_endpt_cancel_timer(pjsua_var.endpt, &pjsua_var.pres_timer);
2259
pjsua_var.pres_timer.id = PJ_FALSE;
2262
for (i=0; i<PJ_ARRAY_SIZE(pjsua_var.acc); ++i) {
2263
if (!pjsua_var.acc[i].valid)
2265
pjsua_pres_delete_acc(i);
2268
for (i=0; i<PJ_ARRAY_SIZE(pjsua_var.buddy); ++i) {
2269
pjsua_var.buddy[i].monitor = 0;
2272
refresh_client_subscriptions();
2274
for (i=0; i<PJ_ARRAY_SIZE(pjsua_var.acc); ++i) {
2275
if (pjsua_var.acc[i].valid)
2276
pjsua_pres_update_acc(i, PJ_FALSE);
added
removed
daemon/libs/pjproject/pjsip/src/pjsua-lib/pjsua_pres.c
