blob: 32947446ef7eeb8c1f5ee2872c60053a233eaa4e [file] [log] [blame]
Benny Prijono268ca612006-02-07 12:34:11 +00001/* $Id$ */
2/*
3 * Copyright (C) 2003-2006 Benny Prijono <benny@prijono.org>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
19#include <pjsip-ua/sip_inv.h>
20#include <pjsip/sip_module.h>
21#include <pjsip/sip_endpoint.h>
22#include <pjsip/sip_event.h>
23#include <pjsip/sip_transaction.h>
24#include <pjmedia/sdp.h>
25#include <pjmedia/sdp_neg.h>
Benny Prijono95196582006-02-09 00:13:40 +000026#include <pjmedia/errno.h>
Benny Prijono268ca612006-02-07 12:34:11 +000027#include <pj/string.h>
28#include <pj/pool.h>
29#include <pj/assert.h>
Benny Prijono8ad55352006-02-08 11:16:05 +000030#include <pj/os.h>
Benny Prijonoa66c7152006-02-09 01:26:14 +000031#include <pj/log.h>
32
Benny Prijono268ca612006-02-07 12:34:11 +000033
34#define THIS_FILE "sip_invite_session.c"
35
Benny Prijonoe8b0d3b2006-03-17 17:57:52 +000036static const char *inv_state_names[] =
37{
38 "NULL ",
39 "CALLING ",
40 "INCOMING ",
41 "EARLY ",
42 "CONNECTING",
43 "CONFIRMED ",
44 "DISCONNCTD",
45 "TERMINATED",
46};
47
Benny Prijono268ca612006-02-07 12:34:11 +000048/*
49 * Static prototypes.
50 */
51static pj_status_t mod_inv_load(pjsip_endpoint *endpt);
52static pj_status_t mod_inv_unload(void);
53static pj_bool_t mod_inv_on_rx_request(pjsip_rx_data *rdata);
54static pj_bool_t mod_inv_on_rx_response(pjsip_rx_data *rdata);
55static void mod_inv_on_tsx_state(pjsip_transaction*, pjsip_event*);
56
Benny Prijono8ad55352006-02-08 11:16:05 +000057static void inv_on_state_null( pjsip_inv_session *inv, pjsip_event *e);
58static void inv_on_state_calling( pjsip_inv_session *inv, pjsip_event *e);
59static void inv_on_state_incoming( pjsip_inv_session *inv, pjsip_event *e);
60static void inv_on_state_early( pjsip_inv_session *inv, pjsip_event *e);
61static void inv_on_state_connecting( pjsip_inv_session *inv, pjsip_event *e);
62static void inv_on_state_confirmed( pjsip_inv_session *inv, pjsip_event *e);
63static void inv_on_state_disconnected( pjsip_inv_session *inv, pjsip_event *e);
Benny Prijono268ca612006-02-07 12:34:11 +000064
Benny Prijono8ad55352006-02-08 11:16:05 +000065static void (*inv_state_handler[])( pjsip_inv_session *inv, pjsip_event *e) =
Benny Prijono268ca612006-02-07 12:34:11 +000066{
67 &inv_on_state_null,
68 &inv_on_state_calling,
69 &inv_on_state_incoming,
70 &inv_on_state_early,
71 &inv_on_state_connecting,
72 &inv_on_state_confirmed,
73 &inv_on_state_disconnected,
Benny Prijono268ca612006-02-07 12:34:11 +000074};
75
76static struct mod_inv
77{
78 pjsip_module mod;
79 pjsip_endpoint *endpt;
80 pjsip_inv_callback cb;
Benny Prijono268ca612006-02-07 12:34:11 +000081} mod_inv =
82{
83 {
Benny Prijono2f8992b2006-02-25 21:16:36 +000084 NULL, NULL, /* prev, next. */
85 { "mod-invite", 10 }, /* Name. */
86 -1, /* Id */
87 PJSIP_MOD_PRIORITY_DIALOG_USAGE, /* Priority */
88 &mod_inv_load, /* load() */
89 NULL, /* start() */
90 NULL, /* stop() */
91 &mod_inv_unload, /* unload() */
92 &mod_inv_on_rx_request, /* on_rx_request() */
93 &mod_inv_on_rx_response, /* on_rx_response() */
94 NULL, /* on_tx_request. */
95 NULL, /* on_tx_response() */
96 &mod_inv_on_tsx_state, /* on_tsx_state() */
Benny Prijono268ca612006-02-07 12:34:11 +000097 }
98};
99
100
Benny Prijonoa66c7152006-02-09 01:26:14 +0000101/* Invite session data to be attached to transaction. */
102struct tsx_inv_data
103{
104 pjsip_inv_session *inv;
105 pj_bool_t sdp_done;
106};
107
108
Benny Prijono8ad55352006-02-08 11:16:05 +0000109/*
110 * Module load()
111 */
Benny Prijono268ca612006-02-07 12:34:11 +0000112static pj_status_t mod_inv_load(pjsip_endpoint *endpt)
113{
114 pj_str_t allowed[] = {{"INVITE", 6}, {"ACK",3}, {"BYE",3}, {"CANCEL",6}};
Benny Prijono56315612006-07-18 14:39:40 +0000115 pj_str_t accepted = { "application/sdp", 15 };
Benny Prijono268ca612006-02-07 12:34:11 +0000116
117 /* Register supported methods: INVITE, ACK, BYE, CANCEL */
118 pjsip_endpt_add_capability(endpt, &mod_inv.mod, PJSIP_H_ALLOW, NULL,
119 PJ_ARRAY_SIZE(allowed), allowed);
120
Benny Prijono56315612006-07-18 14:39:40 +0000121 /* Register "application/sdp" in Accept header */
122 pjsip_endpt_add_capability(endpt, &mod_inv.mod, PJSIP_H_ACCEPT, NULL,
123 1, &accepted);
124
Benny Prijono268ca612006-02-07 12:34:11 +0000125 return PJ_SUCCESS;
126}
127
Benny Prijono8ad55352006-02-08 11:16:05 +0000128/*
129 * Module unload()
130 */
Benny Prijono268ca612006-02-07 12:34:11 +0000131static pj_status_t mod_inv_unload(void)
132{
133 /* Should remove capability here */
134 return PJ_SUCCESS;
135}
136
Benny Prijono8ad55352006-02-08 11:16:05 +0000137/*
Benny Prijono38998232006-02-08 22:44:25 +0000138 * Set session state.
139 */
140void inv_set_state(pjsip_inv_session *inv, pjsip_inv_state state,
141 pjsip_event *e)
142{
Benny Prijonod4e0abd2006-03-05 11:53:36 +0000143 pjsip_inv_state prev_state = inv->state;
144
145 /* Set state. */
Benny Prijono38998232006-02-08 22:44:25 +0000146 inv->state = state;
Benny Prijonod4e0abd2006-03-05 11:53:36 +0000147
148 /* If state is DISCONNECTED, cause code MUST have been set. */
149 pj_assert(inv->state != PJSIP_INV_STATE_DISCONNECTED ||
150 inv->cause != 0);
151
152 /* Call on_state_changed() callback. */
153 if (mod_inv.cb.on_state_changed && inv->notify)
Benny Prijono38998232006-02-08 22:44:25 +0000154 (*mod_inv.cb.on_state_changed)(inv, e);
155
Benny Prijonod4e0abd2006-03-05 11:53:36 +0000156 /* Only decrement when previous state is not already DISCONNECTED */
157 if (inv->state == PJSIP_INV_STATE_DISCONNECTED &&
158 prev_state != PJSIP_INV_STATE_DISCONNECTED)
159 {
Benny Prijonoe4f2abb2006-02-10 14:04:05 +0000160 pjsip_dlg_dec_session(inv->dlg, &mod_inv.mod);
Benny Prijonod4e0abd2006-03-05 11:53:36 +0000161 }
Benny Prijono38998232006-02-08 22:44:25 +0000162}
163
164
165/*
Benny Prijono0b6340c2006-06-13 22:21:23 +0000166 * Set cause code.
167 */
168void inv_set_cause(pjsip_inv_session *inv, int cause_code,
169 const pj_str_t *cause_text)
170{
171 if (cause_code > inv->cause) {
172 inv->cause = cause_code;
173 if (cause_text)
174 pj_strdup(inv->pool, &inv->cause_text, cause_text);
175 else if (cause_code/100 == 2)
176 inv->cause_text = pj_str("Normal call clearing");
177 else
178 inv->cause_text = *pjsip_get_status_text(cause_code);
179 }
180}
181
182
183
184/*
Benny Prijono8ad55352006-02-08 11:16:05 +0000185 * Send ACK for 2xx response.
186 */
187static pj_status_t inv_send_ack(pjsip_inv_session *inv, pjsip_rx_data *rdata)
Benny Prijono268ca612006-02-07 12:34:11 +0000188{
189 pjsip_tx_data *tdata;
190 pj_status_t status;
191
Benny Prijonoe4f2abb2006-02-10 14:04:05 +0000192 PJ_LOG(5,(inv->obj_name, "Received %s, sending ACK",
193 pjsip_rx_data_get_info(rdata)));
194
Benny Prijono268ca612006-02-07 12:34:11 +0000195 status = pjsip_dlg_create_request(inv->dlg, &pjsip_ack_method,
196 rdata->msg_info.cseq->cseq, &tdata);
197 if (status != PJ_SUCCESS) {
198 /* Better luck next time */
199 pj_assert(!"Unable to create ACK!");
200 return status;
201 }
202
Benny Prijono64158af2006-04-04 11:06:34 +0000203 status = pjsip_dlg_send_request(inv->dlg, tdata, -1, NULL);
Benny Prijono268ca612006-02-07 12:34:11 +0000204 if (status != PJ_SUCCESS) {
205 /* Better luck next time */
206 pj_assert(!"Unable to send ACK!");
207 return status;
208 }
209
210 return PJ_SUCCESS;
211}
212
Benny Prijono8ad55352006-02-08 11:16:05 +0000213/*
214 * Module on_rx_request()
215 *
216 * This callback is called for these events:
217 * - endpoint receives request which was unhandled by higher priority
218 * modules (e.g. transaction layer, dialog layer).
219 * - dialog distributes incoming request to its usages.
220 */
221static pj_bool_t mod_inv_on_rx_request(pjsip_rx_data *rdata)
222{
223 pjsip_method *method;
Benny Prijono38998232006-02-08 22:44:25 +0000224 pjsip_dialog *dlg;
225 pjsip_inv_session *inv;
Benny Prijono8ad55352006-02-08 11:16:05 +0000226
227 /* Only wants to receive request from a dialog. */
Benny Prijono38998232006-02-08 22:44:25 +0000228 dlg = pjsip_rdata_get_dlg(rdata);
229 if (dlg == NULL)
Benny Prijono8ad55352006-02-08 11:16:05 +0000230 return PJ_FALSE;
231
Benny Prijono38998232006-02-08 22:44:25 +0000232 inv = dlg->mod_data[mod_inv.mod.id];
233
Benny Prijono8ad55352006-02-08 11:16:05 +0000234 /* Report to dialog that we handle INVITE, CANCEL, BYE, ACK.
235 * If we need to send response, it will be sent in the state
236 * handlers.
237 */
238 method = &rdata->msg_info.msg->line.req.method;
239
Benny Prijono70127222006-07-02 14:53:05 +0000240 if (method->id == PJSIP_INVITE_METHOD) {
241 return PJ_TRUE;
242 }
243
244 /* BYE and CANCEL must have existing invite session */
245 if (method->id == PJSIP_BYE_METHOD ||
246 method->id == PJSIP_CANCEL_METHOD)
Benny Prijono8ad55352006-02-08 11:16:05 +0000247 {
Benny Prijono70127222006-07-02 14:53:05 +0000248 if (inv == NULL)
249 return PJ_FALSE;
250
Benny Prijono8ad55352006-02-08 11:16:05 +0000251 return PJ_TRUE;
252 }
253
Benny Prijono38998232006-02-08 22:44:25 +0000254 /* On receipt ACK request, when state is CONNECTING,
255 * move state to CONFIRMED.
256 */
Benny Prijono26ff9062006-02-21 23:47:00 +0000257 if (method->id == PJSIP_ACK_METHOD && inv) {
Benny Prijono38998232006-02-08 22:44:25 +0000258
Benny Prijonof521eb02006-08-06 23:07:25 +0000259 /* Ignore ACK if pending INVITE transaction has not finished. */
260 if (inv->invite_tsx &&
261 inv->invite_tsx->state < PJSIP_TSX_STATE_COMPLETED)
262 {
263 return PJ_TRUE;
264 }
265
Benny Prijono5eff0432006-02-09 14:14:21 +0000266 /* Terminate INVITE transaction, if it's still present. */
267 if (inv->invite_tsx &&
268 inv->invite_tsx->state <= PJSIP_TSX_STATE_COMPLETED)
269 {
Benny Prijonof521eb02006-08-06 23:07:25 +0000270 pj_assert(inv->invite_tsx->status_code >= 200);
Benny Prijono5eff0432006-02-09 14:14:21 +0000271 pjsip_tsx_terminate(inv->invite_tsx,
272 inv->invite_tsx->status_code);
273 inv->invite_tsx = NULL;
274 }
275
Benny Prijono32ac8fe2006-03-02 21:16:55 +0000276 /* On receipt of ACK, only set state to confirmed when state
277 * is CONNECTING (e.g. we don't want to set the state to confirmed
278 * when we receive ACK retransmission after sending non-2xx!)
279 */
280 if (inv->state == PJSIP_INV_STATE_CONNECTING) {
Benny Prijono26ff9062006-02-21 23:47:00 +0000281 pjsip_event event;
282
283 PJSIP_EVENT_INIT_RX_MSG(event, rdata);
284 inv_set_state(inv, PJSIP_INV_STATE_CONFIRMED, &event);
285 }
Benny Prijono38998232006-02-08 22:44:25 +0000286 }
287
Benny Prijono8ad55352006-02-08 11:16:05 +0000288 return PJ_FALSE;
289}
290
291/*
292 * Module on_rx_response().
293 *
294 * This callback is called for these events:
295 * - dialog distributes incoming 2xx response to INVITE (outside
296 * transaction) to its usages.
297 * - endpoint distributes strayed responses.
298 */
Benny Prijono268ca612006-02-07 12:34:11 +0000299static pj_bool_t mod_inv_on_rx_response(pjsip_rx_data *rdata)
300{
301 pjsip_dialog *dlg;
302 pjsip_inv_session *inv;
303 pjsip_msg *msg = rdata->msg_info.msg;
304
305 dlg = pjsip_rdata_get_dlg(rdata);
306
307 /* Ignore responses outside dialog */
308 if (dlg == NULL)
309 return PJ_FALSE;
310
311 /* Ignore responses not belonging to invite session */
312 inv = pjsip_dlg_get_inv_session(dlg);
313 if (inv == NULL)
314 return PJ_FALSE;
315
316 /* This MAY be retransmission of 2xx response to INVITE.
317 * If it is, we need to send ACK.
318 */
319 if (msg->type == PJSIP_RESPONSE_MSG && msg->line.status.code/100==2 &&
Benny Prijono26ff9062006-02-21 23:47:00 +0000320 rdata->msg_info.cseq->method.id == PJSIP_INVITE_METHOD &&
321 inv->invite_tsx == NULL)
322 {
Benny Prijono268ca612006-02-07 12:34:11 +0000323
Benny Prijono8ad55352006-02-08 11:16:05 +0000324 inv_send_ack(inv, rdata);
Benny Prijono268ca612006-02-07 12:34:11 +0000325 return PJ_TRUE;
326
327 }
328
329 /* No other processing needs to be done here. */
330 return PJ_FALSE;
331}
332
Benny Prijono8ad55352006-02-08 11:16:05 +0000333/*
334 * Module on_tsx_state()
335 *
336 * This callback is called by dialog framework for all transactions
337 * inside the dialog for all its dialog usages.
338 */
Benny Prijono268ca612006-02-07 12:34:11 +0000339static void mod_inv_on_tsx_state(pjsip_transaction *tsx, pjsip_event *e)
340{
341 pjsip_dialog *dlg;
342 pjsip_inv_session *inv;
343
344 dlg = pjsip_tsx_get_dlg(tsx);
345 if (dlg == NULL)
346 return;
347
348 inv = pjsip_dlg_get_inv_session(dlg);
349 if (inv == NULL)
350 return;
351
352 /* Call state handler for the invite session. */
353 (*inv_state_handler[inv->state])(inv, e);
354
355 /* Call on_tsx_state */
Benny Prijonod4e0abd2006-03-05 11:53:36 +0000356 if (mod_inv.cb.on_tsx_state_changed && inv->notify)
Benny Prijono268ca612006-02-07 12:34:11 +0000357 (*mod_inv.cb.on_tsx_state_changed)(inv, tsx, e);
358
359 /* Clear invite transaction when tsx is terminated. */
360 if (tsx->state==PJSIP_TSX_STATE_TERMINATED && tsx == inv->invite_tsx)
361 inv->invite_tsx = NULL;
362}
363
Benny Prijono8ad55352006-02-08 11:16:05 +0000364
365/*
366 * Initialize the invite module.
367 */
Benny Prijono268ca612006-02-07 12:34:11 +0000368PJ_DEF(pj_status_t) pjsip_inv_usage_init( pjsip_endpoint *endpt,
Benny Prijono268ca612006-02-07 12:34:11 +0000369 const pjsip_inv_callback *cb)
370{
371 pj_status_t status;
372
373 /* Check arguments. */
Benny Prijonoe8b0d3b2006-03-17 17:57:52 +0000374 PJ_ASSERT_RETURN(endpt && cb, PJ_EINVAL);
Benny Prijono268ca612006-02-07 12:34:11 +0000375
376 /* Some callbacks are mandatory */
377 PJ_ASSERT_RETURN(cb->on_state_changed && cb->on_new_session, PJ_EINVAL);
378
379 /* Check if module already registered. */
380 PJ_ASSERT_RETURN(mod_inv.mod.id == -1, PJ_EINVALIDOP);
381
382 /* Copy param. */
383 pj_memcpy(&mod_inv.cb, cb, sizeof(pjsip_inv_callback));
384
385 mod_inv.endpt = endpt;
Benny Prijono268ca612006-02-07 12:34:11 +0000386
387 /* Register the module. */
388 status = pjsip_endpt_register_module(endpt, &mod_inv.mod);
389
390 return status;
391}
392
Benny Prijono8ad55352006-02-08 11:16:05 +0000393/*
394 * Get the instance of invite module.
395 */
Benny Prijono268ca612006-02-07 12:34:11 +0000396PJ_DEF(pjsip_module*) pjsip_inv_usage_instance(void)
397{
398 return &mod_inv.mod;
399}
400
401
Benny Prijono632ce712006-02-09 14:01:40 +0000402
Benny Prijono8ad55352006-02-08 11:16:05 +0000403/*
404 * Return the invite session for the specified dialog.
405 */
Benny Prijono268ca612006-02-07 12:34:11 +0000406PJ_DEF(pjsip_inv_session*) pjsip_dlg_get_inv_session(pjsip_dialog *dlg)
407{
408 return dlg->mod_data[mod_inv.mod.id];
409}
410
Benny Prijono8ad55352006-02-08 11:16:05 +0000411
Benny Prijono268ca612006-02-07 12:34:11 +0000412/*
Benny Prijonoe8b0d3b2006-03-17 17:57:52 +0000413 * Get INVITE state name.
414 */
415PJ_DEF(const char *) pjsip_inv_state_name(pjsip_inv_state state)
416{
417 PJ_ASSERT_RETURN(state >= PJSIP_INV_STATE_NULL &&
418 state <= PJSIP_INV_STATE_DISCONNECTED,
419 "??");
420
421 return inv_state_names[state];
422}
423
424/*
Benny Prijono8ad55352006-02-08 11:16:05 +0000425 * Create UAC invite session.
Benny Prijono268ca612006-02-07 12:34:11 +0000426 */
427PJ_DEF(pj_status_t) pjsip_inv_create_uac( pjsip_dialog *dlg,
428 const pjmedia_sdp_session *local_sdp,
429 unsigned options,
430 pjsip_inv_session **p_inv)
431{
432 pjsip_inv_session *inv;
433 pj_status_t status;
434
435 /* Verify arguments. */
436 PJ_ASSERT_RETURN(dlg && p_inv, PJ_EINVAL);
437
438 /* Normalize options */
439 if (options & PJSIP_INV_REQUIRE_100REL)
440 options |= PJSIP_INV_SUPPORT_100REL;
441
442 if (options & PJSIP_INV_REQUIRE_TIMER)
443 options |= PJSIP_INV_SUPPORT_TIMER;
444
445 /* Create the session */
446 inv = pj_pool_zalloc(dlg->pool, sizeof(pjsip_inv_session));
447 PJ_ASSERT_RETURN(inv != NULL, PJ_ENOMEM);
448
449 inv->pool = dlg->pool;
450 inv->role = PJSIP_ROLE_UAC;
451 inv->state = PJSIP_INV_STATE_NULL;
452 inv->dlg = dlg;
453 inv->options = options;
Benny Prijonod4e0abd2006-03-05 11:53:36 +0000454 inv->notify = PJ_TRUE;
455 inv->cause = 0;
Benny Prijono268ca612006-02-07 12:34:11 +0000456
Benny Prijonoe4f2abb2006-02-10 14:04:05 +0000457 /* Object name will use the same dialog pointer. */
Benny Prijonoed811d72006-03-10 12:57:12 +0000458 pj_ansi_snprintf(inv->obj_name, PJ_MAX_OBJ_NAME, "inv%p", dlg);
Benny Prijonoe4f2abb2006-02-10 14:04:05 +0000459
Benny Prijono268ca612006-02-07 12:34:11 +0000460 /* Create negotiator if local_sdp is specified. */
461 if (local_sdp) {
462 status = pjmedia_sdp_neg_create_w_local_offer(dlg->pool, local_sdp,
463 &inv->neg);
464 if (status != PJ_SUCCESS)
465 return status;
466 }
467
468 /* Register invite as dialog usage. */
469 status = pjsip_dlg_add_usage(dlg, &mod_inv.mod, inv);
470 if (status != PJ_SUCCESS)
471 return status;
472
473 /* Increment dialog session */
Benny Prijonoe4f2abb2006-02-10 14:04:05 +0000474 pjsip_dlg_inc_session(dlg, &mod_inv.mod);
Benny Prijono268ca612006-02-07 12:34:11 +0000475
476 /* Done */
477 *p_inv = inv;
Benny Prijonoe4f2abb2006-02-10 14:04:05 +0000478
479 PJ_LOG(5,(inv->obj_name, "UAC invite session created for dialog %s",
480 dlg->obj_name));
481
Benny Prijono268ca612006-02-07 12:34:11 +0000482 return PJ_SUCCESS;
483}
484
485/*
486 * Verify incoming INVITE request.
487 */
488PJ_DEF(pj_status_t) pjsip_inv_verify_request(pjsip_rx_data *rdata,
489 unsigned *options,
490 const pjmedia_sdp_session *l_sdp,
491 pjsip_dialog *dlg,
492 pjsip_endpoint *endpt,
493 pjsip_tx_data **p_tdata)
494{
495 pjsip_msg *msg;
496 pjsip_allow_hdr *allow;
497 pjsip_supported_hdr *sup_hdr;
498 pjsip_require_hdr *req_hdr;
499 int code = 200;
500 unsigned rem_option = 0;
501 pj_status_t status = PJ_SUCCESS;
502 pjsip_hdr res_hdr_list;
503
504 /* Init return arguments. */
505 if (p_tdata) *p_tdata = NULL;
506
507 /* Verify arguments. */
508 PJ_ASSERT_RETURN(rdata != NULL && options != NULL, PJ_EINVAL);
509
510 /* Normalize options */
511 if (*options & PJSIP_INV_REQUIRE_100REL)
512 *options |= PJSIP_INV_SUPPORT_100REL;
513
514 if (*options & PJSIP_INV_REQUIRE_TIMER)
515 *options |= PJSIP_INV_SUPPORT_TIMER;
516
517 /* Get the message in rdata */
518 msg = rdata->msg_info.msg;
519
520 /* Must be INVITE request. */
521 PJ_ASSERT_RETURN(msg->type == PJSIP_REQUEST_MSG &&
522 msg->line.req.method.id == PJSIP_INVITE_METHOD,
523 PJ_EINVAL);
524
525 /* If tdata is specified, then either dlg or endpt must be specified */
526 PJ_ASSERT_RETURN((!p_tdata) || (endpt || dlg), PJ_EINVAL);
527
528 /* Get the endpoint */
529 endpt = endpt ? endpt : dlg->endpt;
530
531 /* Init response header list */
532 pj_list_init(&res_hdr_list);
533
Benny Prijono8ad55352006-02-08 11:16:05 +0000534 /* Check the request body, see if it'inv something that we support
Benny Prijono268ca612006-02-07 12:34:11 +0000535 * (i.e. SDP).
536 */
537 if (msg->body) {
538 pjsip_msg_body *body = msg->body;
539 pj_str_t str_application = {"application", 11};
540 pj_str_t str_sdp = { "sdp", 3 };
541 pjmedia_sdp_session *sdp;
542
543 /* Check content type. */
544 if (pj_stricmp(&body->content_type.type, &str_application) != 0 ||
545 pj_stricmp(&body->content_type.subtype, &str_sdp) != 0)
546 {
547 /* Not "application/sdp" */
548 code = PJSIP_SC_UNSUPPORTED_MEDIA_TYPE;
549 status = PJSIP_ERRNO_FROM_SIP_STATUS(code);
550
551 if (p_tdata) {
552 /* Add Accept header to response */
553 pjsip_accept_hdr *acc;
554
555 acc = pjsip_accept_hdr_create(rdata->tp_info.pool);
556 PJ_ASSERT_RETURN(acc, PJ_ENOMEM);
557 acc->values[acc->count++] = pj_str("application/sdp");
558 pj_list_push_back(&res_hdr_list, acc);
559 }
560
561 goto on_return;
562 }
563
564 /* Parse and validate SDP */
565 status = pjmedia_sdp_parse(rdata->tp_info.pool, body->data, body->len,
566 &sdp);
567 if (status == PJ_SUCCESS)
568 status = pjmedia_sdp_validate(sdp);
569
570 if (status != PJ_SUCCESS) {
571 /* Unparseable or invalid SDP */
572 code = PJSIP_SC_BAD_REQUEST;
573
574 if (p_tdata) {
575 /* Add Warning header. */
576 pjsip_warning_hdr *w;
577
578 w = pjsip_warning_hdr_create_from_status(rdata->tp_info.pool,
579 pjsip_endpt_name(endpt),
580 status);
581 PJ_ASSERT_RETURN(w, PJ_ENOMEM);
582
583 pj_list_push_back(&res_hdr_list, w);
584 }
585
586 goto on_return;
587 }
588
589 /* Negotiate with local SDP */
590 if (l_sdp) {
591 pjmedia_sdp_neg *neg;
592
593 /* Local SDP must be valid! */
594 PJ_ASSERT_RETURN((status=pjmedia_sdp_validate(l_sdp))==PJ_SUCCESS,
595 status);
596
597 /* Create SDP negotiator */
598 status = pjmedia_sdp_neg_create_w_remote_offer(
599 rdata->tp_info.pool, l_sdp, sdp, &neg);
600 PJ_ASSERT_RETURN(status == PJ_SUCCESS, status);
601
602 /* Negotiate SDP */
603 status = pjmedia_sdp_neg_negotiate(rdata->tp_info.pool, neg, 0);
604 if (status != PJ_SUCCESS) {
605
606 /* Incompatible media */
607 code = PJSIP_SC_NOT_ACCEPTABLE_HERE;
608 status = PJSIP_ERRNO_FROM_SIP_STATUS(code);
609
610 if (p_tdata) {
611 pjsip_accept_hdr *acc;
612 pjsip_warning_hdr *w;
613
614 /* Add Warning header. */
615 w = pjsip_warning_hdr_create_from_status(
616 rdata->tp_info.pool,
617 pjsip_endpt_name(endpt), status);
618 PJ_ASSERT_RETURN(w, PJ_ENOMEM);
619
620 pj_list_push_back(&res_hdr_list, w);
621
622 /* Add Accept header to response */
623 acc = pjsip_accept_hdr_create(rdata->tp_info.pool);
624 PJ_ASSERT_RETURN(acc, PJ_ENOMEM);
625 acc->values[acc->count++] = pj_str("application/sdp");
626 pj_list_push_back(&res_hdr_list, acc);
627
628 }
629
630 goto on_return;
631 }
632 }
633 }
634
635 /* Check supported methods, see if peer supports UPDATE.
636 * We just assume that peer supports standard INVITE, ACK, CANCEL, and BYE
637 * implicitly by sending this INVITE.
638 */
639 allow = pjsip_msg_find_hdr(msg, PJSIP_H_ALLOW, NULL);
640 if (allow) {
641 unsigned i;
642 const pj_str_t STR_UPDATE = { "UPDATE", 6 };
643
644 for (i=0; i<allow->count; ++i) {
645 if (pj_stricmp(&allow->values[i], &STR_UPDATE)==0)
646 break;
647 }
648
649 if (i != allow->count) {
650 /* UPDATE is present in Allow */
651 rem_option |= PJSIP_INV_SUPPORT_UPDATE;
652 }
653
654 }
655
656 /* Check Supported header */
657 sup_hdr = pjsip_msg_find_hdr(msg, PJSIP_H_SUPPORTED, NULL);
658 if (sup_hdr) {
659 unsigned i;
660 pj_str_t STR_100REL = { "100rel", 6};
661 pj_str_t STR_TIMER = { "timer", 5 };
662
663 for (i=0; i<sup_hdr->count; ++i) {
664 if (pj_stricmp(&sup_hdr->values[i], &STR_100REL)==0)
665 rem_option |= PJSIP_INV_SUPPORT_100REL;
666 else if (pj_stricmp(&sup_hdr->values[i], &STR_TIMER)==0)
667 rem_option |= PJSIP_INV_SUPPORT_TIMER;
668 }
669 }
670
671 /* Check Require header */
672 req_hdr = pjsip_msg_find_hdr(msg, PJSIP_H_REQUIRE, NULL);
673 if (req_hdr) {
674 unsigned i;
675 pj_str_t STR_100REL = { "100rel", 6};
676 pj_str_t STR_TIMER = { "timer", 5 };
677 unsigned unsupp_cnt = 0;
678 pj_str_t unsupp_tags[PJSIP_GENERIC_ARRAY_MAX_COUNT];
679
680 for (i=0; i<req_hdr->count; ++i) {
681 if ((*options & PJSIP_INV_SUPPORT_100REL) &&
682 pj_stricmp(&req_hdr->values[i], &STR_100REL)==0)
683 {
684 rem_option |= PJSIP_INV_REQUIRE_100REL;
685
686 } else if ((*options && PJSIP_INV_SUPPORT_TIMER) &&
687 pj_stricmp(&req_hdr->values[i], &STR_TIMER)==0)
688 {
689 rem_option |= PJSIP_INV_REQUIRE_TIMER;
690
691 } else {
692 /* Unknown/unsupported extension tag! */
693 unsupp_tags[unsupp_cnt++] = req_hdr->values[i];
694 }
695 }
696
697 /* Check if there are required tags that we don't support */
698 if (unsupp_cnt) {
699
700 code = PJSIP_SC_BAD_EXTENSION;
701 status = PJSIP_ERRNO_FROM_SIP_STATUS(code);
702
703 if (p_tdata) {
704 pjsip_unsupported_hdr *unsupp_hdr;
705 const pjsip_hdr *h;
706
707 /* Add Unsupported header. */
708 unsupp_hdr = pjsip_unsupported_hdr_create(rdata->tp_info.pool);
709 PJ_ASSERT_RETURN(unsupp_hdr != NULL, PJ_ENOMEM);
710
711 unsupp_hdr->count = unsupp_cnt;
712 for (i=0; i<unsupp_cnt; ++i)
713 unsupp_hdr->values[i] = unsupp_tags[i];
714
715 pj_list_push_back(&res_hdr_list, unsupp_hdr);
716
717 /* Add Supported header. */
718 h = pjsip_endpt_get_capability(endpt, PJSIP_H_SUPPORTED,
719 NULL);
720 pj_assert(h);
721 if (h) {
722 sup_hdr = pjsip_hdr_clone(rdata->tp_info.pool, h);
723 pj_list_push_back(&res_hdr_list, sup_hdr);
724 }
725 }
726
727 goto on_return;
728 }
729 }
730
731 /* Check if there are local requirements that are not supported
732 * by peer.
733 */
734 if ( ((*options & PJSIP_INV_REQUIRE_100REL)!=0 &&
735 (rem_option & PJSIP_INV_SUPPORT_100REL)==0) ||
736 ((*options & PJSIP_INV_REQUIRE_TIMER)!=0 &&
737 (rem_option & PJSIP_INV_SUPPORT_TIMER)==0))
738 {
739 code = PJSIP_SC_EXTENSION_REQUIRED;
740 status = PJSIP_ERRNO_FROM_SIP_STATUS(code);
741
742 if (p_tdata) {
743 const pjsip_hdr *h;
744
745 /* Add Require header. */
746 req_hdr = pjsip_require_hdr_create(rdata->tp_info.pool);
747 PJ_ASSERT_RETURN(req_hdr != NULL, PJ_ENOMEM);
748
749 if (*options & PJSIP_INV_REQUIRE_100REL)
750 req_hdr->values[req_hdr->count++] = pj_str("100rel");
751
752 if (*options & PJSIP_INV_REQUIRE_TIMER)
753 req_hdr->values[req_hdr->count++] = pj_str("timer");
754
755 pj_list_push_back(&res_hdr_list, req_hdr);
756
757 /* Add Supported header. */
758 h = pjsip_endpt_get_capability(endpt, PJSIP_H_SUPPORTED,
759 NULL);
760 pj_assert(h);
761 if (h) {
762 sup_hdr = pjsip_hdr_clone(rdata->tp_info.pool, h);
763 pj_list_push_back(&res_hdr_list, sup_hdr);
764 }
765
766 }
767
768 goto on_return;
769 }
770
771on_return:
772
773 /* Create response if necessary */
774 if (code != 200 && p_tdata) {
775 pjsip_tx_data *tdata;
776 const pjsip_hdr *h;
777
778 if (dlg) {
779 status = pjsip_dlg_create_response(dlg, rdata, code, NULL,
780 &tdata);
781 } else {
782 status = pjsip_endpt_create_response(endpt, rdata, code, NULL,
783 &tdata);
784 }
785
786 if (status != PJ_SUCCESS)
787 return status;
788
789 /* Add response headers. */
790 h = res_hdr_list.next;
791 while (h != &res_hdr_list) {
792 pjsip_hdr *cloned;
793
794 cloned = pjsip_hdr_clone(tdata->pool, h);
795 PJ_ASSERT_RETURN(cloned, PJ_ENOMEM);
796
797 pjsip_msg_add_hdr(tdata->msg, cloned);
798
799 h = h->next;
800 }
801
802 *p_tdata = tdata;
Benny Prijono70127222006-07-02 14:53:05 +0000803
804 /* Can not return PJ_SUCCESS when response message is produced.
805 * Ref: PROTOS test ~#2490
806 */
807 if (status == PJ_SUCCESS)
808 status = PJSIP_ERRNO_FROM_SIP_STATUS(code);
809
Benny Prijono268ca612006-02-07 12:34:11 +0000810 }
811
812 return status;
813}
814
815/*
Benny Prijono8ad55352006-02-08 11:16:05 +0000816 * Create UAS invite session.
Benny Prijono268ca612006-02-07 12:34:11 +0000817 */
818PJ_DEF(pj_status_t) pjsip_inv_create_uas( pjsip_dialog *dlg,
819 pjsip_rx_data *rdata,
820 const pjmedia_sdp_session *local_sdp,
821 unsigned options,
822 pjsip_inv_session **p_inv)
823{
824 pjsip_inv_session *inv;
Benny Prijonoa66c7152006-02-09 01:26:14 +0000825 struct tsx_inv_data *tsx_inv_data;
Benny Prijono268ca612006-02-07 12:34:11 +0000826 pjsip_msg *msg;
827 pjmedia_sdp_session *rem_sdp = NULL;
828 pj_status_t status;
829
830 /* Verify arguments. */
831 PJ_ASSERT_RETURN(dlg && rdata && p_inv, PJ_EINVAL);
832
833 /* Dialog MUST have been initialised. */
834 PJ_ASSERT_RETURN(pjsip_rdata_get_tsx(rdata) != NULL, PJ_EINVALIDOP);
835
836 msg = rdata->msg_info.msg;
837
838 /* rdata MUST contain INVITE request */
839 PJ_ASSERT_RETURN(msg->type == PJSIP_REQUEST_MSG &&
840 msg->line.req.method.id == PJSIP_INVITE_METHOD,
841 PJ_EINVALIDOP);
842
843 /* Normalize options */
844 if (options & PJSIP_INV_REQUIRE_100REL)
845 options |= PJSIP_INV_SUPPORT_100REL;
846
847 if (options & PJSIP_INV_REQUIRE_TIMER)
848 options |= PJSIP_INV_SUPPORT_TIMER;
849
850 /* Create the session */
851 inv = pj_pool_zalloc(dlg->pool, sizeof(pjsip_inv_session));
852 PJ_ASSERT_RETURN(inv != NULL, PJ_ENOMEM);
853
854 inv->pool = dlg->pool;
855 inv->role = PJSIP_ROLE_UAS;
Benny Prijono38998232006-02-08 22:44:25 +0000856 inv->state = PJSIP_INV_STATE_NULL;
Benny Prijono268ca612006-02-07 12:34:11 +0000857 inv->dlg = dlg;
858 inv->options = options;
Benny Prijonod4e0abd2006-03-05 11:53:36 +0000859 inv->notify = PJ_TRUE;
860 inv->cause = 0;
Benny Prijono268ca612006-02-07 12:34:11 +0000861
Benny Prijonoe4f2abb2006-02-10 14:04:05 +0000862 /* Object name will use the same dialog pointer. */
Benny Prijonoed811d72006-03-10 12:57:12 +0000863 pj_ansi_snprintf(inv->obj_name, PJ_MAX_OBJ_NAME, "inv%p", dlg);
Benny Prijonoe4f2abb2006-02-10 14:04:05 +0000864
Benny Prijono268ca612006-02-07 12:34:11 +0000865 /* Parse SDP in message body, if present. */
866 if (msg->body) {
867 pjsip_msg_body *body = msg->body;
868
869 /* Parse and validate SDP */
870 status = pjmedia_sdp_parse(inv->pool, body->data, body->len,
871 &rem_sdp);
872 if (status == PJ_SUCCESS)
873 status = pjmedia_sdp_validate(rem_sdp);
874
875 if (status != PJ_SUCCESS)
876 return status;
877 }
878
879 /* Create negotiator. */
880 if (rem_sdp) {
881 status = pjmedia_sdp_neg_create_w_remote_offer(inv->pool, local_sdp,
882 rem_sdp, &inv->neg);
883
884 } else if (local_sdp) {
885 status = pjmedia_sdp_neg_create_w_local_offer(inv->pool, local_sdp,
886 &inv->neg);
887 } else {
Benny Prijono95196582006-02-09 00:13:40 +0000888 status = PJ_SUCCESS;
Benny Prijono268ca612006-02-07 12:34:11 +0000889 }
890
891 if (status != PJ_SUCCESS)
892 return status;
893
894 /* Register invite as dialog usage. */
895 status = pjsip_dlg_add_usage(dlg, &mod_inv.mod, inv);
896 if (status != PJ_SUCCESS)
897 return status;
898
899 /* Increment session in the dialog. */
Benny Prijonoe4f2abb2006-02-10 14:04:05 +0000900 pjsip_dlg_inc_session(dlg, &mod_inv.mod);
Benny Prijono268ca612006-02-07 12:34:11 +0000901
902 /* Save the invite transaction. */
903 inv->invite_tsx = pjsip_rdata_get_tsx(rdata);
Benny Prijonoa66c7152006-02-09 01:26:14 +0000904
905 /* Attach our data to the transaction. */
906 tsx_inv_data = pj_pool_zalloc(inv->invite_tsx->pool,
907 sizeof(struct tsx_inv_data));
908 tsx_inv_data->inv = inv;
909 inv->invite_tsx->mod_data[mod_inv.mod.id] = tsx_inv_data;
Benny Prijono268ca612006-02-07 12:34:11 +0000910
911 /* Done */
912 *p_inv = inv;
Benny Prijonoe4f2abb2006-02-10 14:04:05 +0000913
914 PJ_LOG(5,(inv->obj_name, "UAS invite session created for dialog %s",
915 dlg->obj_name));
916
Benny Prijono268ca612006-02-07 12:34:11 +0000917 return PJ_SUCCESS;
918}
919
Benny Prijonod4e0abd2006-03-05 11:53:36 +0000920/*
921 * Forcefully terminate the session.
922 */
923PJ_DEF(pj_status_t) pjsip_inv_terminate( pjsip_inv_session *inv,
924 int st_code,
925 pj_bool_t notify)
926{
927 PJ_ASSERT_RETURN(inv, PJ_EINVAL);
928
929 /* Lock dialog. */
930 pjsip_dlg_inc_lock(inv->dlg);
931
932 /* Set callback notify flag. */
933 inv->notify = notify;
934
935 /* If there's pending transaction, terminate the transaction.
936 * This may subsequently set the INVITE session state to
937 * disconnected.
938 */
939 if (inv->invite_tsx &&
940 inv->invite_tsx->state <= PJSIP_TSX_STATE_COMPLETED)
941 {
942 pjsip_tsx_terminate(inv->invite_tsx, st_code);
943
944 }
945
946 /* Set cause. */
Benny Prijono0b6340c2006-06-13 22:21:23 +0000947 inv_set_cause(inv, st_code, NULL);
Benny Prijonod4e0abd2006-03-05 11:53:36 +0000948
949 /* Forcefully terminate the session if state is not DISCONNECTED */
950 if (inv->state != PJSIP_INV_STATE_DISCONNECTED) {
951 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, NULL);
952 }
953
954 /* Done.
955 * The dec_lock() below will actually destroys the dialog if it
956 * has no other session.
957 */
958 pjsip_dlg_dec_lock(inv->dlg);
959
960 return PJ_SUCCESS;
961}
962
963
Benny Prijono268ca612006-02-07 12:34:11 +0000964static void *clone_sdp(pj_pool_t *pool, const void *data, unsigned len)
965{
966 PJ_UNUSED_ARG(len);
967 return pjmedia_sdp_session_clone(pool, data);
968}
969
970static int print_sdp(pjsip_msg_body *body, char *buf, pj_size_t len)
971{
972 return pjmedia_sdp_print(body->data, buf, len);
973}
974
Benny Prijono56315612006-07-18 14:39:40 +0000975
976PJ_DEF(pj_status_t) pjsip_create_sdp_body( pj_pool_t *pool,
977 pjmedia_sdp_session *sdp,
978 pjsip_msg_body **p_body)
979{
980 const pj_str_t STR_APPLICATION = { "application", 11};
981 const pj_str_t STR_SDP = { "sdp", 3 };
982 pjsip_msg_body *body;
983
984 body = pj_pool_zalloc(pool, sizeof(pjsip_msg_body));
985 PJ_ASSERT_RETURN(body != NULL, PJ_ENOMEM);
986
987 body->content_type.type = STR_APPLICATION;
988 body->content_type.subtype = STR_SDP;
989 body->data = sdp;
990 body->len = 0;
991 body->clone_data = &clone_sdp;
992 body->print_body = &print_sdp;
993
994 *p_body = body;
995
996 return PJ_SUCCESS;
997}
998
Benny Prijono268ca612006-02-07 12:34:11 +0000999static pjsip_msg_body *create_sdp_body(pj_pool_t *pool,
1000 const pjmedia_sdp_session *c_sdp)
1001{
1002 pjsip_msg_body *body;
Benny Prijono56315612006-07-18 14:39:40 +00001003 pj_status_t status;
Benny Prijono268ca612006-02-07 12:34:11 +00001004
Benny Prijono56315612006-07-18 14:39:40 +00001005 status = pjsip_create_sdp_body(pool,
1006 pjmedia_sdp_session_clone(pool, c_sdp),
1007 &body);
Benny Prijono268ca612006-02-07 12:34:11 +00001008
Benny Prijono56315612006-07-18 14:39:40 +00001009 if (status != PJ_SUCCESS)
1010 return NULL;
Benny Prijono268ca612006-02-07 12:34:11 +00001011
1012 return body;
1013}
1014
1015/*
1016 * Create initial INVITE request.
1017 */
1018PJ_DEF(pj_status_t) pjsip_inv_invite( pjsip_inv_session *inv,
1019 pjsip_tx_data **p_tdata )
1020{
1021 pjsip_tx_data *tdata;
1022 const pjsip_hdr *hdr;
Benny Prijono26ff9062006-02-21 23:47:00 +00001023 pj_bool_t has_sdp;
Benny Prijono268ca612006-02-07 12:34:11 +00001024 pj_status_t status;
1025
1026 /* Verify arguments. */
1027 PJ_ASSERT_RETURN(inv && p_tdata, PJ_EINVAL);
1028
Benny Prijono26ff9062006-02-21 23:47:00 +00001029 /* State MUST be NULL or CONFIRMED. */
1030 PJ_ASSERT_RETURN(inv->state == PJSIP_INV_STATE_NULL ||
1031 inv->state == PJSIP_INV_STATE_CONFIRMED,
1032 PJ_EINVALIDOP);
Benny Prijono268ca612006-02-07 12:34:11 +00001033
Benny Prijono64f851e2006-02-23 13:49:28 +00001034 /* Lock dialog. */
1035 pjsip_dlg_inc_lock(inv->dlg);
1036
Benny Prijono268ca612006-02-07 12:34:11 +00001037 /* Create the INVITE request. */
1038 status = pjsip_dlg_create_request(inv->dlg, &pjsip_invite_method, -1,
1039 &tdata);
1040 if (status != PJ_SUCCESS)
Benny Prijono64f851e2006-02-23 13:49:28 +00001041 goto on_return;
1042
Benny Prijono268ca612006-02-07 12:34:11 +00001043
Benny Prijono26ff9062006-02-21 23:47:00 +00001044 /* If this is the first INVITE, then copy the headers from inv_hdr.
1045 * These are the headers parsed from the request URI when the
1046 * dialog was created.
1047 */
1048 if (inv->state == PJSIP_INV_STATE_NULL) {
1049 hdr = inv->dlg->inv_hdr.next;
1050
1051 while (hdr != &inv->dlg->inv_hdr) {
1052 pjsip_msg_add_hdr(tdata->msg,
1053 pjsip_hdr_shallow_clone(tdata->pool, hdr));
1054 hdr = hdr->next;
1055 }
1056 }
1057
1058 /* See if we have SDP to send. */
1059 if (inv->neg) {
1060 pjmedia_sdp_neg_state neg_state;
1061
1062 neg_state = pjmedia_sdp_neg_get_state(inv->neg);
1063
1064 has_sdp = (neg_state == PJMEDIA_SDP_NEG_STATE_LOCAL_OFFER ||
1065 (neg_state == PJMEDIA_SDP_NEG_STATE_WAIT_NEGO &&
1066 pjmedia_sdp_neg_has_local_answer(inv->neg)));
1067
1068
1069 } else {
1070 has_sdp = PJ_FALSE;
1071 }
1072
Benny Prijono268ca612006-02-07 12:34:11 +00001073 /* Add SDP, if any. */
Benny Prijono26ff9062006-02-21 23:47:00 +00001074 if (has_sdp) {
Benny Prijono268ca612006-02-07 12:34:11 +00001075 const pjmedia_sdp_session *offer;
1076
1077 status = pjmedia_sdp_neg_get_neg_local(inv->neg, &offer);
1078 if (status != PJ_SUCCESS)
Benny Prijono64f851e2006-02-23 13:49:28 +00001079 goto on_return;
Benny Prijono268ca612006-02-07 12:34:11 +00001080
1081 tdata->msg->body = create_sdp_body(tdata->pool, offer);
1082 }
1083
1084 /* Add Allow header. */
1085 hdr = pjsip_endpt_get_capability(inv->dlg->endpt, PJSIP_H_ALLOW, NULL);
1086 if (hdr) {
1087 pjsip_msg_add_hdr(tdata->msg,
1088 pjsip_hdr_shallow_clone(tdata->pool, hdr));
1089 }
1090
1091 /* Add Supported header */
1092 hdr = pjsip_endpt_get_capability(inv->dlg->endpt, PJSIP_H_SUPPORTED, NULL);
1093 if (hdr) {
1094 pjsip_msg_add_hdr(tdata->msg,
1095 pjsip_hdr_shallow_clone(tdata->pool, hdr));
1096 }
1097
1098 /* Add Require header. */
1099 PJ_TODO(INVITE_ADD_REQUIRE_HEADER);
1100
1101 /* Done. */
1102 *p_tdata = tdata;
1103
Benny Prijono64f851e2006-02-23 13:49:28 +00001104
1105on_return:
1106 pjsip_dlg_dec_lock(inv->dlg);
1107 return status;
Benny Prijono268ca612006-02-07 12:34:11 +00001108}
1109
1110
1111/*
Benny Prijono95196582006-02-09 00:13:40 +00001112 * Negotiate SDP.
1113 */
1114static pj_status_t inv_negotiate_sdp( pjsip_inv_session *inv )
1115{
1116 pj_status_t status;
1117
1118 PJ_ASSERT_RETURN(pjmedia_sdp_neg_get_state(inv->neg) ==
1119 PJMEDIA_SDP_NEG_STATE_WAIT_NEGO,
1120 PJMEDIA_SDPNEG_EINSTATE);
1121
1122 status = pjmedia_sdp_neg_negotiate(inv->pool, inv->neg, 0);
1123
Benny Prijonoe4f2abb2006-02-10 14:04:05 +00001124 PJ_LOG(5,(inv->obj_name, "SDP negotiation done, status=%d", status));
1125
Benny Prijonod4e0abd2006-03-05 11:53:36 +00001126 if (mod_inv.cb.on_media_update && inv->notify)
Benny Prijono95196582006-02-09 00:13:40 +00001127 (*mod_inv.cb.on_media_update)(inv, status);
1128
1129 return status;
1130}
1131
1132/*
Benny Prijonoa66c7152006-02-09 01:26:14 +00001133 * Check in incoming message for SDP offer/answer.
1134 */
Benny Prijono26ff9062006-02-21 23:47:00 +00001135static pj_status_t inv_check_sdp_in_incoming_msg( pjsip_inv_session *inv,
1136 pjsip_transaction *tsx,
1137 pjsip_rx_data *rdata)
Benny Prijonoa66c7152006-02-09 01:26:14 +00001138{
1139 struct tsx_inv_data *tsx_inv_data;
1140 static const pj_str_t str_application = { "application", 11 };
1141 static const pj_str_t str_sdp = { "sdp", 3 };
1142 pj_status_t status;
1143 pjsip_msg *msg;
1144 pjmedia_sdp_session *sdp;
1145
1146 /* Get/attach invite session's transaction data */
1147 tsx_inv_data = tsx->mod_data[mod_inv.mod.id];
1148 if (tsx_inv_data == NULL) {
1149 tsx_inv_data = pj_pool_zalloc(tsx->pool, sizeof(struct tsx_inv_data));
1150 tsx_inv_data->inv = inv;
1151 tsx->mod_data[mod_inv.mod.id] = tsx_inv_data;
1152 }
1153
1154 /* MUST NOT do multiple SDP offer/answer in a single transaction.
1155 */
1156
1157 if (tsx_inv_data->sdp_done)
Benny Prijono26ff9062006-02-21 23:47:00 +00001158 return PJ_SUCCESS;
Benny Prijonoa66c7152006-02-09 01:26:14 +00001159
1160 /* Check if SDP is present in the message. */
1161
1162 msg = rdata->msg_info.msg;
1163 if (msg->body == NULL) {
1164 /* Message doesn't have body. */
Benny Prijono26ff9062006-02-21 23:47:00 +00001165 return PJ_SUCCESS;
Benny Prijonoa66c7152006-02-09 01:26:14 +00001166 }
1167
1168 if (pj_stricmp(&msg->body->content_type.type, &str_application) ||
1169 pj_stricmp(&msg->body->content_type.subtype, &str_sdp))
1170 {
1171 /* Message body is not "application/sdp" */
Benny Prijono26ff9062006-02-21 23:47:00 +00001172 return PJMEDIA_SDP_EINSDP;
Benny Prijonoa66c7152006-02-09 01:26:14 +00001173 }
1174
1175 /* Parse the SDP body. */
1176
1177 status = pjmedia_sdp_parse(rdata->tp_info.pool, msg->body->data,
1178 msg->body->len, &sdp);
1179 if (status != PJ_SUCCESS) {
1180 char errmsg[PJ_ERR_MSG_SIZE];
1181 pj_strerror(status, errmsg, sizeof(errmsg));
1182 PJ_LOG(4,(THIS_FILE, "Error parsing SDP in %s: %s",
1183 pjsip_rx_data_get_info(rdata), errmsg));
Benny Prijono26ff9062006-02-21 23:47:00 +00001184 return PJMEDIA_SDP_EINSDP;
Benny Prijonoa66c7152006-02-09 01:26:14 +00001185 }
1186
1187 /* The SDP can be an offer or answer, depending on negotiator's state */
1188
1189 if (inv->neg == NULL ||
1190 pjmedia_sdp_neg_get_state(inv->neg) == PJMEDIA_SDP_NEG_STATE_DONE)
1191 {
1192
1193 /* This is an offer. */
1194
Benny Prijonoe4f2abb2006-02-10 14:04:05 +00001195 PJ_LOG(5,(inv->obj_name, "Got SDP offer in %s",
1196 pjsip_rx_data_get_info(rdata)));
1197
Benny Prijonoa66c7152006-02-09 01:26:14 +00001198 if (inv->neg == NULL) {
1199 status=pjmedia_sdp_neg_create_w_remote_offer(inv->pool, NULL,
1200 sdp, &inv->neg);
1201 } else {
1202 status=pjmedia_sdp_neg_set_remote_offer(inv->pool, inv->neg, sdp);
1203 }
1204
1205 if (status != PJ_SUCCESS) {
1206 char errmsg[PJ_ERR_MSG_SIZE];
1207 pj_strerror(status, errmsg, sizeof(errmsg));
1208 PJ_LOG(4,(THIS_FILE, "Error processing SDP offer in %s: %s",
1209 pjsip_rx_data_get_info(rdata), errmsg));
Benny Prijono26ff9062006-02-21 23:47:00 +00001210 return PJMEDIA_SDP_EINSDP;
Benny Prijonoa66c7152006-02-09 01:26:14 +00001211 }
1212
1213 /* Inform application about remote offer. */
1214
Benny Prijonod4e0abd2006-03-05 11:53:36 +00001215 if (mod_inv.cb.on_rx_offer && inv->notify) {
Benny Prijono26ff9062006-02-21 23:47:00 +00001216
1217 (*mod_inv.cb.on_rx_offer)(inv, sdp);
1218
1219 }
Benny Prijonoa66c7152006-02-09 01:26:14 +00001220
1221 } else if (pjmedia_sdp_neg_get_state(inv->neg) ==
1222 PJMEDIA_SDP_NEG_STATE_LOCAL_OFFER)
1223 {
1224
1225 /* This is an answer.
1226 * Process and negotiate remote answer.
1227 */
1228
Benny Prijonoe4f2abb2006-02-10 14:04:05 +00001229 PJ_LOG(5,(inv->obj_name, "Got SDP answer in %s",
1230 pjsip_rx_data_get_info(rdata)));
1231
Benny Prijonoa66c7152006-02-09 01:26:14 +00001232 status = pjmedia_sdp_neg_set_remote_answer(inv->pool, inv->neg, sdp);
1233
1234 if (status != PJ_SUCCESS) {
1235 char errmsg[PJ_ERR_MSG_SIZE];
1236 pj_strerror(status, errmsg, sizeof(errmsg));
1237 PJ_LOG(4,(THIS_FILE, "Error processing SDP answer in %s: %s",
1238 pjsip_rx_data_get_info(rdata), errmsg));
Benny Prijono26ff9062006-02-21 23:47:00 +00001239 return PJMEDIA_SDP_EINSDP;
Benny Prijonoa66c7152006-02-09 01:26:14 +00001240 }
1241
1242 /* Negotiate SDP */
1243
1244 inv_negotiate_sdp(inv);
1245
1246 /* Mark this transaction has having SDP offer/answer done. */
1247
1248 tsx_inv_data->sdp_done = 1;
1249
1250 } else {
1251
1252 PJ_LOG(5,(THIS_FILE, "Ignored SDP in %s: negotiator state is %s",
1253 pjsip_rx_data_get_info(rdata),
1254 pjmedia_sdp_neg_state_str(pjmedia_sdp_neg_get_state(inv->neg))));
1255 }
1256
Benny Prijono26ff9062006-02-21 23:47:00 +00001257 return PJ_SUCCESS;
Benny Prijonoa66c7152006-02-09 01:26:14 +00001258}
1259
1260
Benny Prijono26ff9062006-02-21 23:47:00 +00001261/*
1262 * Process INVITE answer, for both initial and subsequent re-INVITE
1263 */
1264static pj_status_t process_answer( pjsip_inv_session *inv,
1265 int st_code,
Benny Prijono64f851e2006-02-23 13:49:28 +00001266 pjsip_tx_data *tdata,
1267 const pjmedia_sdp_session *local_sdp)
Benny Prijono26ff9062006-02-21 23:47:00 +00001268{
1269 pj_status_t status;
Benny Prijonoab7399b2006-02-27 00:40:31 +00001270 const pjmedia_sdp_session *sdp = NULL;
Benny Prijono26ff9062006-02-21 23:47:00 +00001271
Benny Prijono64f851e2006-02-23 13:49:28 +00001272 /* If local_sdp is specified, then we MUST NOT have answered the
1273 * offer before.
Benny Prijono26ff9062006-02-21 23:47:00 +00001274 */
Benny Prijono64f851e2006-02-23 13:49:28 +00001275 if (local_sdp && (st_code/100==1 || st_code/100==2)) {
1276
1277 if (inv->neg == NULL) {
1278 status = pjmedia_sdp_neg_create_w_local_offer(inv->pool, local_sdp,
1279 &inv->neg);
1280 } else if (pjmedia_sdp_neg_get_state(inv->neg)==
1281 PJMEDIA_SDP_NEG_STATE_REMOTE_OFFER)
1282 {
1283 status = pjmedia_sdp_neg_set_local_answer(inv->pool, inv->neg,
1284 local_sdp);
1285 } else {
1286
1287 /* Can not specify local SDP at this state. */
1288 pj_assert(0);
1289 status = PJMEDIA_SDPNEG_EINSTATE;
1290 }
1291
1292 if (status != PJ_SUCCESS)
1293 return status;
1294
1295 }
1296
1297
1298 /* If SDP negotiator is ready, start negotiation. */
1299 if (st_code/100==2 || (st_code/10==18 && st_code!=180)) {
Benny Prijono26ff9062006-02-21 23:47:00 +00001300
1301 pjmedia_sdp_neg_state neg_state;
1302
Benny Prijono64f851e2006-02-23 13:49:28 +00001303 /* Start nego when appropriate. */
Benny Prijono26ff9062006-02-21 23:47:00 +00001304 neg_state = inv->neg ? pjmedia_sdp_neg_get_state(inv->neg) :
1305 PJMEDIA_SDP_NEG_STATE_NULL;
1306
1307 if (neg_state == PJMEDIA_SDP_NEG_STATE_LOCAL_OFFER) {
1308
1309 status = pjmedia_sdp_neg_get_neg_local(inv->neg, &sdp);
1310
1311 } else if (neg_state == PJMEDIA_SDP_NEG_STATE_WAIT_NEGO &&
1312 pjmedia_sdp_neg_has_local_answer(inv->neg) )
1313 {
1314
1315 status = inv_negotiate_sdp(inv);
1316 if (status != PJ_SUCCESS)
1317 return status;
1318
1319 status = pjmedia_sdp_neg_get_active_local(inv->neg, &sdp);
1320 }
Benny Prijono26ff9062006-02-21 23:47:00 +00001321 }
1322
Benny Prijono64f851e2006-02-23 13:49:28 +00001323 /* Include SDP when it's available for 2xx and 18x (but not 180) response.
Benny Prijono26ff9062006-02-21 23:47:00 +00001324 * Subsequent response will include this SDP.
1325 */
1326 if (sdp) {
1327 tdata->msg->body = create_sdp_body(tdata->pool, sdp);
1328 }
1329
Benny Prijono26ff9062006-02-21 23:47:00 +00001330
1331 return PJ_SUCCESS;
1332}
1333
Benny Prijonoa66c7152006-02-09 01:26:14 +00001334
1335/*
Benny Prijono64f851e2006-02-23 13:49:28 +00001336 * Create first response to INVITE
1337 */
1338PJ_DEF(pj_status_t) pjsip_inv_initial_answer( pjsip_inv_session *inv,
1339 pjsip_rx_data *rdata,
1340 int st_code,
1341 const pj_str_t *st_text,
1342 const pjmedia_sdp_session *sdp,
1343 pjsip_tx_data **p_tdata)
1344{
1345 pjsip_tx_data *tdata;
1346 pj_status_t status;
1347
1348 /* Verify arguments. */
1349 PJ_ASSERT_RETURN(inv && p_tdata, PJ_EINVAL);
1350
1351 /* Must have INVITE transaction. */
1352 PJ_ASSERT_RETURN(inv->invite_tsx, PJ_EBUG);
1353
1354 pjsip_dlg_inc_lock(inv->dlg);
1355
1356 /* Create response */
1357 status = pjsip_dlg_create_response(inv->dlg, rdata, st_code, st_text,
1358 &tdata);
1359 if (status != PJ_SUCCESS)
1360 goto on_return;
1361
1362 /* Process SDP in answer */
1363 status = process_answer(inv, st_code, tdata, sdp);
1364 if (status != PJ_SUCCESS) {
1365 pjsip_tx_data_dec_ref(tdata);
1366 goto on_return;
1367 }
1368
1369 *p_tdata = tdata;
1370
1371on_return:
1372 pjsip_dlg_dec_lock(inv->dlg);
1373 return status;
1374}
1375
1376
1377/*
Benny Prijono26ff9062006-02-21 23:47:00 +00001378 * Answer initial INVITE
1379 * Re-INVITE will be answered automatically, and will not use this function.
Benny Prijono268ca612006-02-07 12:34:11 +00001380 */
1381PJ_DEF(pj_status_t) pjsip_inv_answer( pjsip_inv_session *inv,
1382 int st_code,
1383 const pj_str_t *st_text,
1384 const pjmedia_sdp_session *local_sdp,
1385 pjsip_tx_data **p_tdata )
1386{
1387 pjsip_tx_data *last_res;
1388 pj_status_t status;
1389
1390 /* Verify arguments. */
1391 PJ_ASSERT_RETURN(inv && p_tdata, PJ_EINVAL);
1392
1393 /* Must have INVITE transaction. */
1394 PJ_ASSERT_RETURN(inv->invite_tsx, PJ_EBUG);
1395
1396 /* INVITE transaction MUST have transmitted a response (e.g. 100) */
1397 PJ_ASSERT_RETURN(inv->invite_tsx->last_tx, PJ_EINVALIDOP);
1398
Benny Prijono64f851e2006-02-23 13:49:28 +00001399 pjsip_dlg_inc_lock(inv->dlg);
Benny Prijono268ca612006-02-07 12:34:11 +00001400
1401 /* Modify last response. */
Benny Prijono26ff9062006-02-21 23:47:00 +00001402 last_res = inv->invite_tsx->last_tx;
Benny Prijono268ca612006-02-07 12:34:11 +00001403 status = pjsip_dlg_modify_response(inv->dlg, last_res, st_code, st_text);
1404 if (status != PJ_SUCCESS)
Benny Prijono64f851e2006-02-23 13:49:28 +00001405 goto on_return;
Benny Prijono268ca612006-02-07 12:34:11 +00001406
Benny Prijono268ca612006-02-07 12:34:11 +00001407
Benny Prijono26ff9062006-02-21 23:47:00 +00001408 /* Process SDP in answer */
Benny Prijono64f851e2006-02-23 13:49:28 +00001409 status = process_answer(inv, st_code, last_res, local_sdp);
1410 if (status != PJ_SUCCESS) {
1411 pjsip_tx_data_dec_ref(last_res);
1412 goto on_return;
1413 }
Benny Prijono268ca612006-02-07 12:34:11 +00001414
Benny Prijono268ca612006-02-07 12:34:11 +00001415
1416 *p_tdata = last_res;
1417
Benny Prijono64f851e2006-02-23 13:49:28 +00001418on_return:
1419 pjsip_dlg_dec_lock(inv->dlg);
1420 return status;
Benny Prijono268ca612006-02-07 12:34:11 +00001421}
1422
1423
1424/*
Benny Prijono26ff9062006-02-21 23:47:00 +00001425 * Set SDP answer.
1426 */
1427PJ_DEF(pj_status_t) pjsip_inv_set_sdp_answer( pjsip_inv_session *inv,
1428 const pjmedia_sdp_session *sdp )
1429{
1430 pj_status_t status;
1431
1432 PJ_ASSERT_RETURN(inv && sdp, PJ_EINVAL);
1433
1434 pjsip_dlg_inc_lock(inv->dlg);
1435 status = pjmedia_sdp_neg_set_local_answer( inv->pool, inv->neg, sdp);
1436 pjsip_dlg_dec_lock(inv->dlg);
1437
1438 return status;
1439}
1440
1441
1442/*
Benny Prijono268ca612006-02-07 12:34:11 +00001443 * End session.
1444 */
1445PJ_DEF(pj_status_t) pjsip_inv_end_session( pjsip_inv_session *inv,
1446 int st_code,
1447 const pj_str_t *st_text,
1448 pjsip_tx_data **p_tdata )
1449{
1450 pjsip_tx_data *tdata;
1451 pj_status_t status;
1452
1453 /* Verify arguments. */
1454 PJ_ASSERT_RETURN(inv && p_tdata, PJ_EINVAL);
1455
Benny Prijonod4e0abd2006-03-05 11:53:36 +00001456 /* Set cause code. */
Benny Prijono0b6340c2006-06-13 22:21:23 +00001457 inv_set_cause(inv, st_code, st_text);
Benny Prijonod4e0abd2006-03-05 11:53:36 +00001458
Benny Prijono268ca612006-02-07 12:34:11 +00001459 /* Create appropriate message. */
1460 switch (inv->state) {
1461 case PJSIP_INV_STATE_CALLING:
1462 case PJSIP_INV_STATE_EARLY:
1463 case PJSIP_INV_STATE_INCOMING:
1464
1465 if (inv->role == PJSIP_ROLE_UAC) {
1466
1467 /* For UAC when session has not been confirmed, create CANCEL. */
1468
1469 /* MUST have the original UAC INVITE transaction. */
1470 PJ_ASSERT_RETURN(inv->invite_tsx != NULL, PJ_EBUG);
1471
1472 /* But CANCEL should only be called when we have received a
1473 * provisional response. If we haven't received any responses,
1474 * just destroy the transaction.
1475 */
1476 if (inv->invite_tsx->status_code < 100) {
1477
1478 pjsip_tsx_terminate(inv->invite_tsx, 487);
Benny Prijonofccab712006-02-22 22:23:22 +00001479 *p_tdata = NULL;
1480 return PJ_SUCCESS;
Benny Prijono268ca612006-02-07 12:34:11 +00001481 }
1482
1483 /* The CSeq here assumes that the dialog is started with an
1484 * INVITE session. This may not be correct; dialog can be
1485 * started as SUBSCRIBE session.
1486 * So fix this!
1487 */
1488 status = pjsip_endpt_create_cancel(inv->dlg->endpt,
1489 inv->invite_tsx->last_tx,
1490 &tdata);
1491
1492 } else {
1493
1494 /* For UAS, send a final response. */
1495 tdata = inv->invite_tsx->last_tx;
1496 PJ_ASSERT_RETURN(tdata != NULL, PJ_EINVALIDOP);
1497
Benny Prijono26ff9062006-02-21 23:47:00 +00001498 //status = pjsip_dlg_modify_response(inv->dlg, tdata, st_code,
1499 // st_text);
1500 status = pjsip_inv_answer(inv, st_code, st_text, NULL, &tdata);
Benny Prijono268ca612006-02-07 12:34:11 +00001501 }
1502 break;
1503
1504 case PJSIP_INV_STATE_CONNECTING:
1505 case PJSIP_INV_STATE_CONFIRMED:
1506 /* For established dialog, send BYE */
1507 status = pjsip_dlg_create_request(inv->dlg, &pjsip_bye_method, -1,
1508 &tdata);
1509 break;
1510
1511 case PJSIP_INV_STATE_DISCONNECTED:
Benny Prijono268ca612006-02-07 12:34:11 +00001512 /* No need to do anything. */
Benny Prijonod4e0abd2006-03-05 11:53:36 +00001513 return PJSIP_ESESSIONTERMINATED;
Benny Prijono268ca612006-02-07 12:34:11 +00001514
1515 default:
1516 pj_assert("!Invalid operation!");
1517 return PJ_EINVALIDOP;
1518 }
1519
1520 if (status != PJ_SUCCESS)
1521 return status;
1522
1523
1524 /* Done */
1525
1526 *p_tdata = tdata;
1527
1528 return PJ_SUCCESS;
1529}
1530
1531
1532/*
1533 * Create re-INVITE.
1534 */
1535PJ_DEF(pj_status_t) pjsip_inv_reinvite( pjsip_inv_session *inv,
1536 const pj_str_t *new_contact,
1537 const pjmedia_sdp_session *new_offer,
1538 pjsip_tx_data **p_tdata )
1539{
Benny Prijono26ff9062006-02-21 23:47:00 +00001540 pj_status_t status;
1541 pjsip_contact_hdr *contact_hdr = NULL;
Benny Prijono268ca612006-02-07 12:34:11 +00001542
Benny Prijono26ff9062006-02-21 23:47:00 +00001543 /* Check arguments. */
1544 PJ_ASSERT_RETURN(inv && p_tdata, PJ_EINVAL);
1545
1546 /* Must NOT have a pending INVITE transaction */
1547 PJ_ASSERT_RETURN(inv->invite_tsx==NULL, PJ_EINVALIDOP);
1548
1549
1550 pjsip_dlg_inc_lock(inv->dlg);
1551
1552 if (new_contact) {
1553 pj_str_t tmp;
1554 const pj_str_t STR_CONTACT = { "Contact", 7 };
1555
1556 pj_strdup_with_null(inv->dlg->pool, &tmp, new_contact);
1557 contact_hdr = pjsip_parse_hdr(inv->dlg->pool, &STR_CONTACT,
1558 tmp.ptr, tmp.slen, NULL);
1559 if (!contact_hdr) {
1560 status = PJSIP_EINVALIDURI;
1561 goto on_return;
1562 }
1563 }
1564
1565
1566 if (new_offer) {
1567 if (!inv->neg) {
1568 status = pjmedia_sdp_neg_create_w_local_offer(inv->pool, new_offer,
1569 &inv->neg);
1570 if (status != PJ_SUCCESS)
1571 goto on_return;
1572
1573 } else switch (pjmedia_sdp_neg_get_state(inv->neg)) {
1574
1575 case PJMEDIA_SDP_NEG_STATE_NULL:
1576 pj_assert(!"Unexpected SDP neg state NULL");
1577 status = PJ_EBUG;
1578 goto on_return;
1579
1580 case PJMEDIA_SDP_NEG_STATE_LOCAL_OFFER:
1581 PJ_LOG(4,(inv->obj_name,
1582 "pjsip_inv_reinvite: already have an offer, new "
1583 "offer is ignored"));
1584 break;
1585
1586 case PJMEDIA_SDP_NEG_STATE_REMOTE_OFFER:
1587 status = pjmedia_sdp_neg_set_local_answer(inv->pool, inv->neg,
1588 new_offer);
1589 if (status != PJ_SUCCESS)
1590 goto on_return;
1591 break;
1592
1593 case PJMEDIA_SDP_NEG_STATE_WAIT_NEGO:
1594 PJ_LOG(4,(inv->obj_name,
1595 "pjsip_inv_reinvite: SDP in WAIT_NEGO state, new "
1596 "offer is ignored"));
1597 break;
1598
1599 case PJMEDIA_SDP_NEG_STATE_DONE:
1600 status = pjmedia_sdp_neg_modify_local_offer(inv->pool,inv->neg,
1601 new_offer);
1602 if (status != PJ_SUCCESS)
1603 goto on_return;
1604 break;
1605 }
1606 }
1607
1608 if (contact_hdr)
1609 inv->dlg->local.contact = contact_hdr;
1610
1611 status = pjsip_inv_invite(inv, p_tdata);
1612
1613on_return:
1614 pjsip_dlg_dec_lock(inv->dlg);
1615 return status;
Benny Prijono268ca612006-02-07 12:34:11 +00001616}
1617
1618/*
1619 * Create UPDATE.
1620 */
1621PJ_DEF(pj_status_t) pjsip_inv_update ( pjsip_inv_session *inv,
1622 const pj_str_t *new_contact,
1623 const pjmedia_sdp_session *new_offer,
1624 pjsip_tx_data **p_tdata )
1625{
1626 PJ_UNUSED_ARG(inv);
1627 PJ_UNUSED_ARG(new_contact);
1628 PJ_UNUSED_ARG(new_offer);
1629 PJ_UNUSED_ARG(p_tdata);
1630
1631 PJ_TODO(CREATE_UPDATE_REQUEST);
1632 return PJ_ENOTSUP;
1633}
1634
1635/*
1636 * Send a request or response message.
1637 */
1638PJ_DEF(pj_status_t) pjsip_inv_send_msg( pjsip_inv_session *inv,
Benny Prijonoe8b0d3b2006-03-17 17:57:52 +00001639 pjsip_tx_data *tdata)
Benny Prijono268ca612006-02-07 12:34:11 +00001640{
1641 pj_status_t status;
1642
1643 /* Verify arguments. */
1644 PJ_ASSERT_RETURN(inv && tdata, PJ_EINVAL);
1645
Benny Prijonoe4f2abb2006-02-10 14:04:05 +00001646 PJ_LOG(5,(inv->obj_name, "Sending %s",
1647 pjsip_tx_data_get_info(tdata)));
1648
Benny Prijono268ca612006-02-07 12:34:11 +00001649 if (tdata->msg->type == PJSIP_REQUEST_MSG) {
Benny Prijonoa66c7152006-02-09 01:26:14 +00001650 struct tsx_inv_data *tsx_inv_data;
Benny Prijono268ca612006-02-07 12:34:11 +00001651
Benny Prijono64158af2006-04-04 11:06:34 +00001652 pjsip_dlg_inc_lock(inv->dlg);
Benny Prijono268ca612006-02-07 12:34:11 +00001653
Benny Prijono64158af2006-04-04 11:06:34 +00001654 tsx_inv_data = pj_pool_zalloc(inv->pool, sizeof(struct tsx_inv_data));
Benny Prijonoa66c7152006-02-09 01:26:14 +00001655 tsx_inv_data->inv = inv;
1656
Benny Prijono64158af2006-04-04 11:06:34 +00001657 pjsip_dlg_dec_lock(inv->dlg);
1658
1659 status = pjsip_dlg_send_request(inv->dlg, tdata, mod_inv.mod.id,
1660 tsx_inv_data);
1661 if (status != PJ_SUCCESS)
1662 return status;
Benny Prijono268ca612006-02-07 12:34:11 +00001663
1664 } else {
1665 pjsip_cseq_hdr *cseq;
1666
1667 /* Can only do this to send response to original INVITE
1668 * request.
1669 */
Benny Prijono64f851e2006-02-23 13:49:28 +00001670 PJ_ASSERT_RETURN((cseq=pjsip_msg_find_hdr(tdata->msg, PJSIP_H_CSEQ, NULL))!=NULL
1671 && (cseq->cseq == inv->invite_tsx->cseq),
Benny Prijono268ca612006-02-07 12:34:11 +00001672 PJ_EINVALIDOP);
1673
1674 status = pjsip_dlg_send_response(inv->dlg, inv->invite_tsx, tdata);
1675 if (status != PJ_SUCCESS)
1676 return status;
1677 }
1678
1679 /* Done (?) */
1680 return PJ_SUCCESS;
1681}
1682
1683
Benny Prijono8ad55352006-02-08 11:16:05 +00001684/*
1685 * Respond to incoming CANCEL request.
1686 */
1687static void inv_respond_incoming_cancel(pjsip_inv_session *inv,
1688 pjsip_transaction *cancel_tsx,
1689 pjsip_rx_data *rdata)
1690{
1691 pjsip_tx_data *tdata;
1692 pjsip_transaction *invite_tsx;
1693 pj_str_t key;
1694 pj_status_t status;
1695
1696 /* See if we have matching INVITE server transaction: */
1697
1698 pjsip_tsx_create_key(rdata->tp_info.pool, &key, PJSIP_ROLE_UAS,
1699 &pjsip_invite_method, rdata);
1700 invite_tsx = pjsip_tsx_layer_find_tsx(&key, PJ_TRUE);
1701
1702 if (invite_tsx == NULL) {
1703
1704 /* Invite transaction not found!
1705 * Respond CANCEL with 491 (RFC 3261 Section 9.2 page 42)
1706 */
1707 status = pjsip_dlg_create_response( inv->dlg, rdata, 200, NULL,
1708 &tdata);
1709
1710 } else {
1711 /* Always answer CANCEL will 200 (OK) regardless of
1712 * the state of the INVITE transaction.
1713 */
1714 status = pjsip_dlg_create_response( inv->dlg, rdata, 200, NULL,
1715 &tdata);
1716 }
1717
1718 /* See if we have created the response successfully. */
1719 if (status != PJ_SUCCESS) return;
1720
1721 /* Send the CANCEL response */
1722 status = pjsip_dlg_send_response(inv->dlg, cancel_tsx, tdata);
1723 if (status != PJ_SUCCESS) return;
1724
1725
1726 /* See if we need to terminate the UAS INVITE transaction
1727 * with 487 (Request Terminated) response.
1728 */
1729 if (invite_tsx && invite_tsx->status_code < 200) {
1730
1731 pj_assert(invite_tsx->last_tx != NULL);
1732
1733 tdata = invite_tsx->last_tx;
1734
1735 status = pjsip_dlg_modify_response(inv->dlg, tdata, 487, NULL);
1736 if (status == PJ_SUCCESS)
1737 pjsip_dlg_send_response(inv->dlg, invite_tsx, tdata);
1738 }
1739
1740 if (invite_tsx)
1741 pj_mutex_unlock(invite_tsx->mutex);
1742}
1743
1744
1745/*
1746 * Respond to incoming BYE request.
1747 */
1748static void inv_respond_incoming_bye( pjsip_inv_session *inv,
1749 pjsip_transaction *bye_tsx,
1750 pjsip_rx_data *rdata,
1751 pjsip_event *e )
1752{
1753 pj_status_t status;
1754 pjsip_tx_data *tdata;
1755
1756 /* Respond BYE with 200: */
1757
1758 status = pjsip_dlg_create_response(inv->dlg, rdata, 200, NULL, &tdata);
1759 if (status != PJ_SUCCESS) return;
1760
1761 status = pjsip_dlg_send_response(inv->dlg, bye_tsx, tdata);
1762 if (status != PJ_SUCCESS) return;
1763
1764 /* Terminate session: */
1765
Benny Prijonod4e0abd2006-03-05 11:53:36 +00001766 if (inv->state != PJSIP_INV_STATE_DISCONNECTED) {
Benny Prijono0b6340c2006-06-13 22:21:23 +00001767 inv_set_cause(inv, PJSIP_SC_OK, NULL);
Benny Prijono8ad55352006-02-08 11:16:05 +00001768 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
Benny Prijonod4e0abd2006-03-05 11:53:36 +00001769 }
Benny Prijono8ad55352006-02-08 11:16:05 +00001770}
1771
1772/*
Benny Prijono38998232006-02-08 22:44:25 +00001773 * Respond to BYE request.
1774 */
1775static void inv_handle_bye_response( pjsip_inv_session *inv,
1776 pjsip_transaction *tsx,
1777 pjsip_rx_data *rdata,
1778 pjsip_event *e )
1779{
1780 pj_status_t status;
1781
1782 if (e->body.tsx_state.type != PJSIP_EVENT_RX_MSG) {
Benny Prijono0b6340c2006-06-13 22:21:23 +00001783 inv_set_cause(inv, PJSIP_SC_OK, NULL);
Benny Prijono38998232006-02-08 22:44:25 +00001784 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
1785 return;
1786 }
1787
1788 /* Handle 401/407 challenge. */
1789 if (tsx->status_code == 401 || tsx->status_code == 407) {
1790
1791 pjsip_tx_data *tdata;
1792
1793 status = pjsip_auth_clt_reinit_req( &inv->dlg->auth_sess,
1794 rdata,
1795 tsx->last_tx,
1796 &tdata);
1797
1798 if (status != PJ_SUCCESS) {
1799
1800 /* Does not have proper credentials.
1801 * End the session anyway.
1802 */
Benny Prijono0b6340c2006-06-13 22:21:23 +00001803 inv_set_cause(inv, PJSIP_SC_OK, NULL);
Benny Prijono38998232006-02-08 22:44:25 +00001804 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
1805
1806 } else {
1807 /* Re-send BYE. */
Benny Prijonoe8b0d3b2006-03-17 17:57:52 +00001808 status = pjsip_inv_send_msg(inv, tdata);
Benny Prijono38998232006-02-08 22:44:25 +00001809 }
1810
1811 } else {
1812
1813 /* End the session. */
Benny Prijono0b6340c2006-06-13 22:21:23 +00001814 inv_set_cause(inv, PJSIP_SC_OK, NULL);
Benny Prijono38998232006-02-08 22:44:25 +00001815 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
1816 }
1817
1818}
1819
1820/*
Benny Prijono8ad55352006-02-08 11:16:05 +00001821 * State NULL is before anything is sent/received.
1822 */
1823static void inv_on_state_null( pjsip_inv_session *inv, pjsip_event *e)
Benny Prijono268ca612006-02-07 12:34:11 +00001824{
1825 pjsip_transaction *tsx = e->body.tsx_state.tsx;
1826 pjsip_dialog *dlg = pjsip_tsx_get_dlg(tsx);
1827
1828 PJ_ASSERT_ON_FAIL(tsx && dlg, return);
1829
1830 if (tsx->method.id == PJSIP_INVITE_METHOD) {
1831
Benny Prijono64f851e2006-02-23 13:49:28 +00001832 /* Keep the initial INVITE transaction. */
1833 if (inv->invite_tsx == NULL)
1834 inv->invite_tsx = tsx;
Benny Prijono268ca612006-02-07 12:34:11 +00001835
Benny Prijono64f851e2006-02-23 13:49:28 +00001836 if (dlg->role == PJSIP_ROLE_UAC) {
Benny Prijono268ca612006-02-07 12:34:11 +00001837
1838 switch (tsx->state) {
1839 case PJSIP_TSX_STATE_CALLING:
Benny Prijono8ad55352006-02-08 11:16:05 +00001840 inv_set_state(inv, PJSIP_INV_STATE_CALLING, e);
Benny Prijono268ca612006-02-07 12:34:11 +00001841 break;
1842 default:
Benny Prijono64f851e2006-02-23 13:49:28 +00001843 inv_on_state_calling(inv, e);
Benny Prijono268ca612006-02-07 12:34:11 +00001844 break;
1845 }
1846
1847 } else {
1848 switch (tsx->state) {
1849 case PJSIP_TSX_STATE_TRYING:
Benny Prijono8ad55352006-02-08 11:16:05 +00001850 inv_set_state(inv, PJSIP_INV_STATE_INCOMING, e);
Benny Prijono268ca612006-02-07 12:34:11 +00001851 break;
Benny Prijono38998232006-02-08 22:44:25 +00001852 case PJSIP_TSX_STATE_PROCEEDING:
1853 inv_set_state(inv, PJSIP_INV_STATE_INCOMING, e);
1854 if (tsx->status_code > 100)
1855 inv_set_state(inv, PJSIP_INV_STATE_EARLY, e);
1856 break;
Benny Prijono268ca612006-02-07 12:34:11 +00001857 default:
Benny Prijono64f851e2006-02-23 13:49:28 +00001858 inv_on_state_incoming(inv, e);
1859 break;
Benny Prijono268ca612006-02-07 12:34:11 +00001860 }
1861 }
1862
1863 } else {
1864 pj_assert(!"Unexpected transaction type");
1865 }
1866}
1867
Benny Prijono8ad55352006-02-08 11:16:05 +00001868/*
1869 * State CALLING is after sending initial INVITE request but before
1870 * any response (with tag) is received.
1871 */
1872static void inv_on_state_calling( pjsip_inv_session *inv, pjsip_event *e)
Benny Prijono268ca612006-02-07 12:34:11 +00001873{
1874 pjsip_transaction *tsx = e->body.tsx_state.tsx;
1875 pjsip_dialog *dlg = pjsip_tsx_get_dlg(tsx);
Benny Prijonoccf95622006-02-07 18:48:01 +00001876 pj_status_t status;
Benny Prijono268ca612006-02-07 12:34:11 +00001877
1878 PJ_ASSERT_ON_FAIL(tsx && dlg, return);
1879
Benny Prijono8ad55352006-02-08 11:16:05 +00001880 if (tsx == inv->invite_tsx) {
Benny Prijono268ca612006-02-07 12:34:11 +00001881
1882 switch (tsx->state) {
1883
Benny Prijono64f851e2006-02-23 13:49:28 +00001884 case PJSIP_TSX_STATE_CALLING:
1885 inv_set_state(inv, PJSIP_INV_STATE_CALLING, e);
1886 break;
1887
Benny Prijono268ca612006-02-07 12:34:11 +00001888 case PJSIP_TSX_STATE_PROCEEDING:
1889 if (dlg->remote.info->tag.slen) {
Benny Prijonoa66c7152006-02-09 01:26:14 +00001890
Benny Prijono8ad55352006-02-08 11:16:05 +00001891 inv_set_state(inv, PJSIP_INV_STATE_EARLY, e);
Benny Prijonoa66c7152006-02-09 01:26:14 +00001892
1893 inv_check_sdp_in_incoming_msg(inv, tsx,
1894 e->body.tsx_state.src.rdata);
1895
Benny Prijono268ca612006-02-07 12:34:11 +00001896 } else {
1897 /* Ignore 100 (Trying) response, as it doesn't change
1898 * session state. It only ceases retransmissions.
1899 */
1900 }
1901 break;
1902
1903 case PJSIP_TSX_STATE_COMPLETED:
1904 if (tsx->status_code/100 == 2) {
1905
1906 /* This should not happen.
1907 * When transaction receives 2xx, it should be terminated
1908 */
1909 pj_assert(0);
Benny Prijono8ad55352006-02-08 11:16:05 +00001910 inv_set_state(inv, PJSIP_INV_STATE_CONNECTING, e);
Benny Prijonoa66c7152006-02-09 01:26:14 +00001911
1912 inv_check_sdp_in_incoming_msg(inv, tsx,
1913 e->body.tsx_state.src.rdata);
Benny Prijono268ca612006-02-07 12:34:11 +00001914
Benny Prijonoccf95622006-02-07 18:48:01 +00001915 } else if (tsx->status_code==401 || tsx->status_code==407) {
1916
1917 /* Handle authentication failure:
1918 * Resend the request with Authorization header.
1919 */
1920 pjsip_tx_data *tdata;
1921
Benny Prijono8ad55352006-02-08 11:16:05 +00001922 status = pjsip_auth_clt_reinit_req(&inv->dlg->auth_sess,
Benny Prijonoccf95622006-02-07 18:48:01 +00001923 e->body.tsx_state.src.rdata,
1924 tsx->last_tx,
1925 &tdata);
1926
1927 if (status != PJ_SUCCESS) {
1928
1929 /* Does not have proper credentials.
1930 * End the session.
1931 */
Benny Prijono0b6340c2006-06-13 22:21:23 +00001932 inv_set_cause(inv, tsx->status_code, &tsx->status_text);
Benny Prijono8ad55352006-02-08 11:16:05 +00001933 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
Benny Prijonoccf95622006-02-07 18:48:01 +00001934
1935 } else {
1936
1937 /* Restart session. */
Benny Prijono8ad55352006-02-08 11:16:05 +00001938 inv->state = PJSIP_INV_STATE_NULL;
1939 inv->invite_tsx = NULL;
Benny Prijonoccf95622006-02-07 18:48:01 +00001940
1941 /* Send the request. */
Benny Prijonoe8b0d3b2006-03-17 17:57:52 +00001942 status = pjsip_inv_send_msg(inv, tdata);
Benny Prijonoccf95622006-02-07 18:48:01 +00001943 }
1944
Benny Prijono268ca612006-02-07 12:34:11 +00001945 } else {
Benny Prijonoccf95622006-02-07 18:48:01 +00001946
Benny Prijono0b6340c2006-06-13 22:21:23 +00001947 inv_set_cause(inv, tsx->status_code, &tsx->status_text);
Benny Prijono8ad55352006-02-08 11:16:05 +00001948 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
Benny Prijonoccf95622006-02-07 18:48:01 +00001949
Benny Prijono268ca612006-02-07 12:34:11 +00001950 }
1951 break;
1952
1953 case PJSIP_TSX_STATE_TERMINATED:
1954 /* INVITE transaction can be terminated either because UAC
1955 * transaction received 2xx response or because of transport
1956 * error.
1957 */
1958 if (tsx->status_code/100 == 2) {
1959 /* This must be receipt of 2xx response */
1960
1961 /* Set state to CONNECTING */
Benny Prijono8ad55352006-02-08 11:16:05 +00001962 inv_set_state(inv, PJSIP_INV_STATE_CONNECTING, e);
Benny Prijono268ca612006-02-07 12:34:11 +00001963
Benny Prijonoa66c7152006-02-09 01:26:14 +00001964 inv_check_sdp_in_incoming_msg(inv, tsx,
1965 e->body.tsx_state.src.rdata);
1966
Benny Prijono268ca612006-02-07 12:34:11 +00001967 /* Send ACK */
1968 pj_assert(e->body.tsx_state.type == PJSIP_EVENT_RX_MSG);
1969
Benny Prijono8ad55352006-02-08 11:16:05 +00001970 inv_send_ack(inv, e->body.tsx_state.src.rdata);
Benny Prijono5eff0432006-02-09 14:14:21 +00001971 inv_set_state(inv, PJSIP_INV_STATE_CONFIRMED, e);
Benny Prijono268ca612006-02-07 12:34:11 +00001972
Benny Prijonoa66c7152006-02-09 01:26:14 +00001973
Benny Prijono268ca612006-02-07 12:34:11 +00001974 } else {
Benny Prijono0b6340c2006-06-13 22:21:23 +00001975 inv_set_cause(inv, tsx->status_code, &tsx->status_text);
Benny Prijono8ad55352006-02-08 11:16:05 +00001976 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
Benny Prijono268ca612006-02-07 12:34:11 +00001977 }
1978 break;
1979
Benny Prijono34a404e2006-02-09 14:38:30 +00001980 default:
1981 break;
Benny Prijono268ca612006-02-07 12:34:11 +00001982 }
Benny Prijonoe4f2abb2006-02-10 14:04:05 +00001983
1984 } else if (inv->role == PJSIP_ROLE_UAC &&
1985 tsx->role == PJSIP_ROLE_UAC &&
1986 tsx->method.id == PJSIP_CANCEL_METHOD)
1987 {
1988 /*
1989 * Handle case when outgoing CANCEL is answered with 481 (Call/
1990 * Transaction Does Not Exist), 408, or when it's timed out. In these
1991 * cases, disconnect session (i.e. dialog usage only).
1992 */
1993 if (tsx->status_code == PJSIP_SC_CALL_TSX_DOES_NOT_EXIST ||
1994 tsx->status_code == PJSIP_SC_REQUEST_TIMEOUT ||
1995 tsx->status_code == PJSIP_SC_TSX_TIMEOUT ||
Benny Prijono0b6340c2006-06-13 22:21:23 +00001996 tsx->status_code == PJSIP_SC_TSX_TRANSPORT_ERROR)
Benny Prijonoe4f2abb2006-02-10 14:04:05 +00001997 {
Benny Prijono0b6340c2006-06-13 22:21:23 +00001998 inv_set_cause(inv, tsx->status_code, &tsx->status_text);
Benny Prijonoe4f2abb2006-02-10 14:04:05 +00001999 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
2000 }
Benny Prijono268ca612006-02-07 12:34:11 +00002001 }
2002}
2003
Benny Prijono8ad55352006-02-08 11:16:05 +00002004/*
2005 * State INCOMING is after we received the request, but before
2006 * responses with tag are sent.
2007 */
2008static void inv_on_state_incoming( pjsip_inv_session *inv, pjsip_event *e)
Benny Prijono268ca612006-02-07 12:34:11 +00002009{
2010 pjsip_transaction *tsx = e->body.tsx_state.tsx;
2011 pjsip_dialog *dlg = pjsip_tsx_get_dlg(tsx);
2012
2013 PJ_ASSERT_ON_FAIL(tsx && dlg, return);
2014
Benny Prijono8ad55352006-02-08 11:16:05 +00002015 if (tsx == inv->invite_tsx) {
2016
2017 /*
2018 * Handle the INVITE state transition.
2019 */
2020
Benny Prijono268ca612006-02-07 12:34:11 +00002021 switch (tsx->state) {
Benny Prijono8ad55352006-02-08 11:16:05 +00002022
Benny Prijono64f851e2006-02-23 13:49:28 +00002023 case PJSIP_TSX_STATE_TRYING:
2024 inv_set_state(inv, PJSIP_INV_STATE_INCOMING, e);
2025 break;
2026
Benny Prijono268ca612006-02-07 12:34:11 +00002027 case PJSIP_TSX_STATE_PROCEEDING:
Benny Prijono8ad55352006-02-08 11:16:05 +00002028 /*
2029 * Transaction sent provisional response.
2030 */
Benny Prijono268ca612006-02-07 12:34:11 +00002031 if (tsx->status_code > 100)
Benny Prijono8ad55352006-02-08 11:16:05 +00002032 inv_set_state(inv, PJSIP_INV_STATE_EARLY, e);
Benny Prijono268ca612006-02-07 12:34:11 +00002033 break;
Benny Prijono8ad55352006-02-08 11:16:05 +00002034
Benny Prijono268ca612006-02-07 12:34:11 +00002035 case PJSIP_TSX_STATE_COMPLETED:
Benny Prijono8ad55352006-02-08 11:16:05 +00002036 /*
2037 * Transaction sent final response.
2038 */
Benny Prijonod4e0abd2006-03-05 11:53:36 +00002039 if (tsx->status_code/100 == 2) {
Benny Prijono8ad55352006-02-08 11:16:05 +00002040 inv_set_state(inv, PJSIP_INV_STATE_CONNECTING, e);
Benny Prijonod4e0abd2006-03-05 11:53:36 +00002041 } else {
Benny Prijono0b6340c2006-06-13 22:21:23 +00002042 inv_set_cause(inv, tsx->status_code, &tsx->status_text);
Benny Prijono8ad55352006-02-08 11:16:05 +00002043 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
Benny Prijonod4e0abd2006-03-05 11:53:36 +00002044 }
Benny Prijono268ca612006-02-07 12:34:11 +00002045 break;
Benny Prijono8ad55352006-02-08 11:16:05 +00002046
Benny Prijono268ca612006-02-07 12:34:11 +00002047 case PJSIP_TSX_STATE_TERMINATED:
Benny Prijono8ad55352006-02-08 11:16:05 +00002048 /*
2049 * This happens on transport error (e.g. failed to send
2050 * response)
2051 */
Benny Prijono0b6340c2006-06-13 22:21:23 +00002052 inv_set_cause(inv, tsx->status_code, &tsx->status_text);
Benny Prijono8ad55352006-02-08 11:16:05 +00002053 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
Benny Prijono268ca612006-02-07 12:34:11 +00002054 break;
Benny Prijono8ad55352006-02-08 11:16:05 +00002055
Benny Prijono268ca612006-02-07 12:34:11 +00002056 default:
Benny Prijono8ad55352006-02-08 11:16:05 +00002057 pj_assert(!"Unexpected INVITE state");
2058 break;
Benny Prijono268ca612006-02-07 12:34:11 +00002059 }
Benny Prijono8ad55352006-02-08 11:16:05 +00002060
2061 } else if (tsx->method.id == PJSIP_CANCEL_METHOD &&
2062 tsx->role == PJSIP_ROLE_UAS &&
2063 tsx->state < PJSIP_TSX_STATE_COMPLETED &&
2064 e->body.tsx_state.type == PJSIP_EVENT_RX_MSG )
2065 {
2066
2067 /*
2068 * Handle incoming CANCEL request.
2069 */
2070
2071 inv_respond_incoming_cancel(inv, tsx, e->body.tsx_state.src.rdata);
2072
Benny Prijono268ca612006-02-07 12:34:11 +00002073 }
2074}
2075
Benny Prijono8ad55352006-02-08 11:16:05 +00002076/*
2077 * State EARLY is for both UAS and UAC, after response with To tag
2078 * is sent/received.
2079 */
2080static void inv_on_state_early( pjsip_inv_session *inv, pjsip_event *e)
Benny Prijono268ca612006-02-07 12:34:11 +00002081{
2082 pjsip_transaction *tsx = e->body.tsx_state.tsx;
2083 pjsip_dialog *dlg = pjsip_tsx_get_dlg(tsx);
2084
2085 PJ_ASSERT_ON_FAIL(tsx && dlg, return);
2086
Benny Prijono8ad55352006-02-08 11:16:05 +00002087 if (tsx == inv->invite_tsx) {
2088
2089 /*
2090 * Handle the INVITE state progress.
2091 */
Benny Prijono268ca612006-02-07 12:34:11 +00002092
2093 switch (tsx->state) {
2094
2095 case PJSIP_TSX_STATE_PROCEEDING:
2096 /* Send/received another provisional response. */
Benny Prijono8ad55352006-02-08 11:16:05 +00002097 inv_set_state(inv, PJSIP_INV_STATE_EARLY, e);
Benny Prijonoa66c7152006-02-09 01:26:14 +00002098
2099 if (e->body.tsx_state.type == PJSIP_EVENT_RX_MSG) {
2100 inv_check_sdp_in_incoming_msg(inv, tsx,
2101 e->body.tsx_state.src.rdata);
2102 }
Benny Prijono268ca612006-02-07 12:34:11 +00002103 break;
2104
2105 case PJSIP_TSX_STATE_COMPLETED:
Benny Prijonoa66c7152006-02-09 01:26:14 +00002106 if (tsx->status_code/100 == 2) {
Benny Prijono8ad55352006-02-08 11:16:05 +00002107 inv_set_state(inv, PJSIP_INV_STATE_CONNECTING, e);
Benny Prijonoa66c7152006-02-09 01:26:14 +00002108 if (e->body.tsx_state.type == PJSIP_EVENT_RX_MSG) {
2109 inv_check_sdp_in_incoming_msg(inv, tsx,
2110 e->body.tsx_state.src.rdata);
2111 }
2112
Benny Prijonod4e0abd2006-03-05 11:53:36 +00002113 } else {
Benny Prijono0b6340c2006-06-13 22:21:23 +00002114 inv_set_cause(inv, tsx->status_code, &tsx->status_text);
Benny Prijono8ad55352006-02-08 11:16:05 +00002115 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
Benny Prijonod4e0abd2006-03-05 11:53:36 +00002116 }
Benny Prijono268ca612006-02-07 12:34:11 +00002117 break;
2118
Benny Prijonof3195072006-02-14 21:15:30 +00002119 case PJSIP_TSX_STATE_CONFIRMED:
2120 /* For some reason can go here */
2121
Benny Prijono268ca612006-02-07 12:34:11 +00002122 case PJSIP_TSX_STATE_TERMINATED:
2123 /* INVITE transaction can be terminated either because UAC
2124 * transaction received 2xx response or because of transport
2125 * error.
2126 */
2127 if (tsx->status_code/100 == 2) {
2128
2129 /* This must be receipt of 2xx response */
2130
2131 /* Set state to CONNECTING */
Benny Prijono8ad55352006-02-08 11:16:05 +00002132 inv_set_state(inv, PJSIP_INV_STATE_CONNECTING, e);
Benny Prijono268ca612006-02-07 12:34:11 +00002133
Benny Prijonoa66c7152006-02-09 01:26:14 +00002134 if (e->body.tsx_state.type == PJSIP_EVENT_RX_MSG) {
2135 inv_check_sdp_in_incoming_msg(inv, tsx,
2136 e->body.tsx_state.src.rdata);
2137 }
2138
Benny Prijono268ca612006-02-07 12:34:11 +00002139 /* if UAC, send ACK and move state to confirmed. */
2140 if (tsx->role == PJSIP_ROLE_UAC) {
2141 pj_assert(e->body.tsx_state.type == PJSIP_EVENT_RX_MSG);
2142
Benny Prijono8ad55352006-02-08 11:16:05 +00002143 inv_send_ack(inv, e->body.tsx_state.src.rdata);
Benny Prijono8ad55352006-02-08 11:16:05 +00002144 inv_set_state(inv, PJSIP_INV_STATE_CONFIRMED, e);
Benny Prijono268ca612006-02-07 12:34:11 +00002145 }
2146
2147 } else {
Benny Prijono0b6340c2006-06-13 22:21:23 +00002148 inv_set_cause(inv, tsx->status_code, &tsx->status_text);
Benny Prijono8ad55352006-02-08 11:16:05 +00002149 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
Benny Prijono268ca612006-02-07 12:34:11 +00002150 }
2151 break;
2152
2153 default:
Benny Prijono8ad55352006-02-08 11:16:05 +00002154 pj_assert(!"Unexpected INVITE tsx state");
Benny Prijono268ca612006-02-07 12:34:11 +00002155 }
2156
Benny Prijono8ad55352006-02-08 11:16:05 +00002157 } else if (inv->role == PJSIP_ROLE_UAS &&
2158 tsx->role == PJSIP_ROLE_UAS &&
2159 tsx->method.id == PJSIP_CANCEL_METHOD &&
2160 tsx->state < PJSIP_TSX_STATE_COMPLETED &&
2161 e->body.tsx_state.type == PJSIP_EVENT_RX_MSG )
2162 {
Benny Prijono268ca612006-02-07 12:34:11 +00002163
Benny Prijono8ad55352006-02-08 11:16:05 +00002164 /*
2165 * Handle incoming CANCEL request.
Benny Prijonoccf95622006-02-07 18:48:01 +00002166 */
2167
Benny Prijono8ad55352006-02-08 11:16:05 +00002168 inv_respond_incoming_cancel(inv, tsx, e->body.tsx_state.src.rdata);
2169
Benny Prijonoe4f2abb2006-02-10 14:04:05 +00002170 } else if (inv->role == PJSIP_ROLE_UAC &&
2171 tsx->role == PJSIP_ROLE_UAC &&
2172 tsx->method.id == PJSIP_CANCEL_METHOD)
2173 {
2174 /*
2175 * Handle case when outgoing CANCEL is answered with 481 (Call/
2176 * Transaction Does Not Exist), 408, or when it's timed out. In these
2177 * cases, disconnect session (i.e. dialog usage only).
2178 */
2179 if (tsx->status_code == PJSIP_SC_CALL_TSX_DOES_NOT_EXIST ||
2180 tsx->status_code == PJSIP_SC_REQUEST_TIMEOUT ||
2181 tsx->status_code == PJSIP_SC_TSX_TIMEOUT ||
Benny Prijono0b6340c2006-06-13 22:21:23 +00002182 tsx->status_code == PJSIP_SC_TSX_TRANSPORT_ERROR)
Benny Prijonoe4f2abb2006-02-10 14:04:05 +00002183 {
Benny Prijono0b6340c2006-06-13 22:21:23 +00002184 inv_set_cause(inv, tsx->status_code, &tsx->status_text);
Benny Prijonoe4f2abb2006-02-10 14:04:05 +00002185 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
2186 }
Benny Prijono268ca612006-02-07 12:34:11 +00002187 }
2188}
2189
Benny Prijono8ad55352006-02-08 11:16:05 +00002190/*
2191 * State CONNECTING is after 2xx response to INVITE is sent/received.
2192 */
2193static void inv_on_state_connecting( pjsip_inv_session *inv, pjsip_event *e)
Benny Prijono268ca612006-02-07 12:34:11 +00002194{
2195 pjsip_transaction *tsx = e->body.tsx_state.tsx;
2196 pjsip_dialog *dlg = pjsip_tsx_get_dlg(tsx);
2197
2198 PJ_ASSERT_ON_FAIL(tsx && dlg, return);
2199
Benny Prijono8ad55352006-02-08 11:16:05 +00002200 if (tsx == inv->invite_tsx) {
Benny Prijono268ca612006-02-07 12:34:11 +00002201
Benny Prijono8ad55352006-02-08 11:16:05 +00002202 /*
2203 * Handle INVITE state progression.
2204 */
Benny Prijono268ca612006-02-07 12:34:11 +00002205 switch (tsx->state) {
2206
2207 case PJSIP_TSX_STATE_CONFIRMED:
Benny Prijono38998232006-02-08 22:44:25 +00002208 if (tsx->status_code/100 == 2)
2209 inv_set_state(inv, PJSIP_INV_STATE_CONFIRMED, e);
Benny Prijono268ca612006-02-07 12:34:11 +00002210 break;
2211
2212 case PJSIP_TSX_STATE_TERMINATED:
2213 /* INVITE transaction can be terminated either because UAC
2214 * transaction received 2xx response or because of transport
2215 * error.
2216 */
2217 if (tsx->status_code/100 != 2) {
Benny Prijono0b6340c2006-06-13 22:21:23 +00002218 inv_set_cause(inv, tsx->status_code, &tsx->status_text);
Benny Prijono8ad55352006-02-08 11:16:05 +00002219 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
Benny Prijono268ca612006-02-07 12:34:11 +00002220 }
2221 break;
2222
2223 case PJSIP_TSX_STATE_DESTROYED:
2224 /* Do nothing. */
2225 break;
2226
2227 default:
2228 pj_assert(!"Unexpected state");
2229 }
2230
Benny Prijono8ad55352006-02-08 11:16:05 +00002231 } else if (tsx->role == PJSIP_ROLE_UAS &&
2232 tsx->method.id == PJSIP_BYE_METHOD &&
2233 tsx->status_code < 200 &&
2234 e->body.tsx_state.type == PJSIP_EVENT_RX_MSG)
2235 {
2236
2237 /*
2238 * Handle incoming BYE.
2239 */
2240
2241 inv_respond_incoming_bye( inv, tsx, e->body.tsx_state.src.rdata, e );
2242
Benny Prijono38998232006-02-08 22:44:25 +00002243 } else if (tsx->method.id == PJSIP_BYE_METHOD &&
2244 tsx->role == PJSIP_ROLE_UAC &&
Benny Prijonoa66c7152006-02-09 01:26:14 +00002245 (tsx->state == PJSIP_TSX_STATE_COMPLETED ||
2246 tsx->state == PJSIP_TSX_STATE_TERMINATED))
Benny Prijono38998232006-02-08 22:44:25 +00002247 {
2248
2249 /*
2250 * Outgoing BYE
2251 */
2252 inv_handle_bye_response( inv, tsx, e->body.tsx_state.src.rdata, e);
2253
Benny Prijono268ca612006-02-07 12:34:11 +00002254 }
Benny Prijono70127222006-07-02 14:53:05 +00002255 else if (tsx->method.id == PJSIP_CANCEL_METHOD &&
2256 tsx->role == PJSIP_ROLE_UAS &&
2257 tsx->status_code < 200 &&
2258 e->body.tsx_state.type == PJSIP_EVENT_RX_MSG)
2259 {
Benny Prijono38998232006-02-08 22:44:25 +00002260
Benny Prijono70127222006-07-02 14:53:05 +00002261 /*
2262 * Handle strandled incoming CANCEL.
2263 */
2264 pjsip_rx_data *rdata = e->body.tsx_state.src.rdata;
2265 pjsip_tx_data *tdata;
2266 pj_status_t status;
2267
2268 status = pjsip_dlg_create_response(dlg, rdata, 200, NULL, &tdata);
2269 if (status != PJ_SUCCESS) return;
2270
2271 status = pjsip_dlg_send_response(dlg, tsx, tdata);
2272 if (status != PJ_SUCCESS) return;
2273
2274 }
Benny Prijono268ca612006-02-07 12:34:11 +00002275}
2276
Benny Prijono8ad55352006-02-08 11:16:05 +00002277/*
2278 * State CONFIRMED is after ACK is sent/received.
2279 */
2280static void inv_on_state_confirmed( pjsip_inv_session *inv, pjsip_event *e)
Benny Prijono268ca612006-02-07 12:34:11 +00002281{
2282 pjsip_transaction *tsx = e->body.tsx_state.tsx;
2283 pjsip_dialog *dlg = pjsip_tsx_get_dlg(tsx);
2284
2285 PJ_ASSERT_ON_FAIL(tsx && dlg, return);
2286
Benny Prijono268ca612006-02-07 12:34:11 +00002287
Benny Prijono8ad55352006-02-08 11:16:05 +00002288 if (tsx->method.id == PJSIP_BYE_METHOD &&
2289 tsx->role == PJSIP_ROLE_UAC &&
Benny Prijonoa66c7152006-02-09 01:26:14 +00002290 (tsx->state == PJSIP_TSX_STATE_COMPLETED ||
2291 tsx->state == PJSIP_TSX_STATE_TERMINATED))
Benny Prijono8ad55352006-02-08 11:16:05 +00002292 {
Benny Prijono38998232006-02-08 22:44:25 +00002293
Benny Prijono8ad55352006-02-08 11:16:05 +00002294 /*
Benny Prijono38998232006-02-08 22:44:25 +00002295 * Outgoing BYE
Benny Prijono8ad55352006-02-08 11:16:05 +00002296 */
Benny Prijono8ad55352006-02-08 11:16:05 +00002297
Benny Prijonoa66c7152006-02-09 01:26:14 +00002298 inv_handle_bye_response( inv, tsx, e->body.tsx_state.src.rdata, e);
Benny Prijono268ca612006-02-07 12:34:11 +00002299
Benny Prijono8ad55352006-02-08 11:16:05 +00002300 }
2301 else if (tsx->method.id == PJSIP_BYE_METHOD &&
2302 tsx->role == PJSIP_ROLE_UAS &&
2303 tsx->status_code < 200 &&
2304 e->body.tsx_state.type == PJSIP_EVENT_RX_MSG)
2305 {
Benny Prijonoccf95622006-02-07 18:48:01 +00002306
Benny Prijono8ad55352006-02-08 11:16:05 +00002307 /*
2308 * Handle incoming BYE.
2309 */
Benny Prijono268ca612006-02-07 12:34:11 +00002310
Benny Prijono8ad55352006-02-08 11:16:05 +00002311 inv_respond_incoming_bye( inv, tsx, e->body.tsx_state.src.rdata, e );
2312
Benny Prijono268ca612006-02-07 12:34:11 +00002313 }
Benny Prijono70127222006-07-02 14:53:05 +00002314 else if (tsx->method.id == PJSIP_CANCEL_METHOD &&
2315 tsx->role == PJSIP_ROLE_UAS &&
2316 tsx->status_code < 200 &&
2317 e->body.tsx_state.type == PJSIP_EVENT_RX_MSG)
2318 {
2319
2320 /*
2321 * Handle strandled incoming CANCEL.
2322 */
2323 pjsip_rx_data *rdata = e->body.tsx_state.src.rdata;
2324 pjsip_tx_data *tdata;
2325 pj_status_t status;
2326
2327 status = pjsip_dlg_create_response(dlg, rdata, 200, NULL, &tdata);
2328 if (status != PJ_SUCCESS) return;
2329
2330 status = pjsip_dlg_send_response(dlg, tsx, tdata);
2331 if (status != PJ_SUCCESS) return;
2332
2333 }
Benny Prijono26ff9062006-02-21 23:47:00 +00002334 else if (tsx->method.id == PJSIP_INVITE_METHOD &&
2335 tsx->role == PJSIP_ROLE_UAS)
2336 {
2337
2338 /*
2339 * Handle incoming re-INVITE
2340 */
2341 if (tsx->state == PJSIP_TSX_STATE_TRYING) {
2342
2343 pjsip_rx_data *rdata = e->body.tsx_state.src.rdata;
2344 pjsip_tx_data *tdata;
2345 pj_status_t status;
2346
2347 /* Check if we have INVITE pending. */
2348 if (inv->invite_tsx && inv->invite_tsx!=tsx) {
2349
2350 /* Can not receive re-INVITE while another one is pending. */
2351 status = pjsip_dlg_create_response( inv->dlg, rdata, 500, NULL,
2352 &tdata);
2353 if (status != PJ_SUCCESS)
2354 return;
2355
2356 status = pjsip_dlg_send_response( inv->dlg, tsx, tdata);
2357
2358
2359 return;
2360 }
2361
2362 /* Save the invite transaction. */
2363 inv->invite_tsx = tsx;
2364
2365 /* Process SDP in incoming message. */
2366 status = inv_check_sdp_in_incoming_msg(inv, tsx, rdata);
2367
2368 if (status != PJ_SUCCESS) {
2369
2370 /* Not Acceptable */
2371 const pjsip_hdr *accept;
2372
2373 status = pjsip_dlg_create_response(inv->dlg, rdata,
2374 488, NULL, &tdata);
2375 if (status != PJ_SUCCESS)
2376 return;
2377
2378
2379 accept = pjsip_endpt_get_capability(dlg->endpt, PJSIP_H_ACCEPT,
2380 NULL);
2381 if (accept) {
2382 pjsip_msg_add_hdr(tdata->msg,
2383 pjsip_hdr_clone(tdata->pool, accept));
2384 }
2385
2386 status = pjsip_dlg_send_response(dlg, tsx, tdata);
2387
2388 return;
2389 }
2390
2391 /* Create 2xx ANSWER */
2392 status = pjsip_dlg_create_response(dlg, rdata, 200, NULL, &tdata);
2393 if (status != PJ_SUCCESS)
2394 return;
2395
2396 /* Process SDP in the answer */
Benny Prijono64f851e2006-02-23 13:49:28 +00002397 status = process_answer(inv, 200, tdata, NULL);
Benny Prijono26ff9062006-02-21 23:47:00 +00002398 if (status != PJ_SUCCESS)
2399 return;
2400
Benny Prijonoe8b0d3b2006-03-17 17:57:52 +00002401 status = pjsip_inv_send_msg(inv, tdata);
Benny Prijono26ff9062006-02-21 23:47:00 +00002402
2403 }
2404
2405 }
2406 else if (tsx->method.id == PJSIP_INVITE_METHOD &&
2407 tsx->role == PJSIP_ROLE_UAC)
2408 {
2409 /*
2410 * Handle outgoing re-INVITE
2411 */
2412 if (tsx->state == PJSIP_TSX_STATE_TERMINATED &&
2413 tsx->status_code/100 == 2)
2414 {
2415
2416 /* Re-INVITE was accepted. */
2417
2418 /* Process SDP */
2419 inv_check_sdp_in_incoming_msg(inv, tsx,
2420 e->body.tsx_state.src.rdata);
2421
2422 /* Send ACK */
2423 inv_send_ack(inv, e->body.tsx_state.src.rdata);
2424
2425 } else if (tsx->state == PJSIP_TSX_STATE_COMPLETED &&
2426 (tsx->status_code==401 || tsx->status_code==407))
2427 {
2428 pjsip_tx_data *tdata;
2429 pj_status_t status;
2430
2431 /* Handle authentication challenge. */
2432 status = pjsip_auth_clt_reinit_req( &dlg->auth_sess,
2433 e->body.tsx_state.src.rdata,
2434 tsx->last_tx,
2435 &tdata);
2436 if (status != PJ_SUCCESS)
2437 return;
2438
2439 /* Send re-INVITE */
Benny Prijonoe8b0d3b2006-03-17 17:57:52 +00002440 status = pjsip_inv_send_msg( inv, tdata);
Benny Prijono26ff9062006-02-21 23:47:00 +00002441
2442 } else if (tsx->status_code==PJSIP_SC_CALL_TSX_DOES_NOT_EXIST ||
2443 tsx->status_code==PJSIP_SC_REQUEST_TIMEOUT ||
2444 tsx->status_code >= 700)
2445 {
2446 /*
2447 * Handle responses that terminates dialog.
2448 */
Benny Prijono0b6340c2006-06-13 22:21:23 +00002449 inv_set_cause(inv, tsx->status_code, &tsx->status_text);
Benny Prijono26ff9062006-02-21 23:47:00 +00002450 inv_set_state(inv, PJSIP_INV_STATE_DISCONNECTED, e);
2451 }
2452 }
Benny Prijono268ca612006-02-07 12:34:11 +00002453}
2454
Benny Prijono8ad55352006-02-08 11:16:05 +00002455/*
2456 * After session has been terminated, but before dialog is destroyed
2457 * (because dialog has other usages, or because dialog is waiting for
2458 * the last transaction to terminate).
2459 */
2460static void inv_on_state_disconnected( pjsip_inv_session *inv, pjsip_event *e)
Benny Prijono268ca612006-02-07 12:34:11 +00002461{
Benny Prijono8ad55352006-02-08 11:16:05 +00002462 pjsip_transaction *tsx = e->body.tsx_state.tsx;
2463 pjsip_dialog *dlg = pjsip_tsx_get_dlg(tsx);
Benny Prijono268ca612006-02-07 12:34:11 +00002464
Benny Prijono8ad55352006-02-08 11:16:05 +00002465 PJ_ASSERT_ON_FAIL(tsx && dlg, return);
2466
Benny Prijono70127222006-07-02 14:53:05 +00002467 if (tsx->role == PJSIP_ROLE_UAS &&
Benny Prijono8ad55352006-02-08 11:16:05 +00002468 tsx->status_code < 200 &&
2469 e->body.tsx_state.type == PJSIP_EVENT_RX_MSG)
2470 {
Benny Prijono70127222006-07-02 14:53:05 +00002471 pjsip_rx_data *rdata = e->body.tsx_state.src.rdata;
Benny Prijono8ad55352006-02-08 11:16:05 +00002472
2473 /*
Benny Prijono70127222006-07-02 14:53:05 +00002474 * Respond BYE with 200/OK
Benny Prijono8ad55352006-02-08 11:16:05 +00002475 */
Benny Prijono70127222006-07-02 14:53:05 +00002476 if (tsx->method.id == PJSIP_BYE_METHOD) {
2477 inv_respond_incoming_bye( inv, tsx, rdata, e );
2478 } else if (tsx->method.id == PJSIP_CANCEL_METHOD) {
2479 /*
2480 * Respond CANCEL with 200/OK too.
2481 */
2482 pjsip_tx_data *tdata;
2483 pj_status_t status;
Benny Prijono8ad55352006-02-08 11:16:05 +00002484
Benny Prijono70127222006-07-02 14:53:05 +00002485 status = pjsip_dlg_create_response(dlg, rdata, 200, NULL, &tdata);
2486 if (status != PJ_SUCCESS) return;
Benny Prijono8ad55352006-02-08 11:16:05 +00002487
Benny Prijono70127222006-07-02 14:53:05 +00002488 status = pjsip_dlg_send_response(dlg, tsx, tdata);
2489 if (status != PJ_SUCCESS) return;
2490
2491 }
Benny Prijono8ad55352006-02-08 11:16:05 +00002492 }
Benny Prijono268ca612006-02-07 12:34:11 +00002493}
2494