Provide error message for QUEUE_MEMBER when member is not in queue
[asterisk/asterisk.git] / res / res_sip_session.c
1 /*
2 * Asterisk -- An open source telephony toolkit.
3 *
4 * Copyright (C) 2013, Digium, Inc.
5 *
6 * Mark Michelson <mmichelson@digium.com>
7 *
8 * See http://www.asterisk.org for more information about
9 * the Asterisk project. Please do not directly contact
10 * any of the maintainers of this project for assistance;
11 * the project provides a web site, mailing lists and IRC
12 * channels for your use.
13 *
14 * This program is free software, distributed under the terms of
15 * the GNU General Public License Version 2. See the LICENSE file
16 * at the top of the source tree.
17 */
18
19 /*** MODULEINFO
20         <depend>pjproject</depend>
21         <depend>res_sip</depend>
22         <support_level>core</support_level>
23  ***/
24
25 #include "asterisk.h"
26
27 #include <pjsip.h>
28 #include <pjsip_ua.h>
29 #include <pjlib.h>
30
31 #include "asterisk/res_sip.h"
32 #include "asterisk/res_sip_session.h"
33 #include "asterisk/datastore.h"
34 #include "asterisk/module.h"
35 #include "asterisk/logger.h"
36 #include "asterisk/res_sip.h"
37 #include "asterisk/astobj2.h"
38 #include "asterisk/lock.h"
39 #include "asterisk/uuid.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/taskprocessor.h"
42 #include "asterisk/causes.h"
43 #include "asterisk/sdp_srtp.h"
44 #include "asterisk/dsp.h"
45
46 #define SDP_HANDLER_BUCKETS 11
47
48 /* Some forward declarations */
49 static void handle_incoming_request(struct ast_sip_session *session, pjsip_rx_data *rdata);
50 static void handle_incoming_response(struct ast_sip_session *session, pjsip_rx_data *rdata);
51 static int handle_incoming(struct ast_sip_session *session, pjsip_rx_data *rdata);
52 static void handle_outgoing_request(struct ast_sip_session *session, pjsip_tx_data *tdata);
53 static void handle_outgoing_response(struct ast_sip_session *session, pjsip_tx_data *tdata);
54 static void handle_outgoing(struct ast_sip_session *session, pjsip_tx_data *tdata);
55
56 /*! \brief NAT hook for modifying outgoing messages with SDP */
57 static struct ast_sip_nat_hook *nat_hook;
58
59 /*!
60  * \brief Registered SDP stream handlers
61  *
62  * This container is keyed on stream types. Each
63  * object in the container is a linked list of
64  * handlers for the stream type.
65  */
66 static struct ao2_container *sdp_handlers;
67
68 /*!
69  * These are the objects in the sdp_handlers container
70  */
71 struct sdp_handler_list {
72         /* The list of handlers to visit */
73         AST_LIST_HEAD_NOLOCK(, ast_sip_session_sdp_handler) list;
74         /* The handlers in this list handle streams of this type */
75         char stream_type[1];
76 };
77
78 static struct pjmedia_sdp_session *create_local_sdp(pjsip_inv_session *inv, struct ast_sip_session *session, const pjmedia_sdp_session *offer);
79
80 static int sdp_handler_list_hash(const void *obj, int flags)
81 {
82         const struct sdp_handler_list *handler_list = obj;
83         const char *stream_type = flags & OBJ_KEY ? obj : handler_list->stream_type;
84
85         return ast_str_hash(stream_type);
86 }
87
88 static int sdp_handler_list_cmp(void *obj, void *arg, int flags)
89 {
90         struct sdp_handler_list *handler_list1 = obj;
91         struct sdp_handler_list *handler_list2 = arg;
92         const char *stream_type2 = flags & OBJ_KEY ? arg : handler_list2->stream_type;
93
94         return strcmp(handler_list1->stream_type, stream_type2) ? 0 : CMP_MATCH | CMP_STOP;
95 }
96
97 static int session_media_hash(const void *obj, int flags)
98 {
99         const struct ast_sip_session_media *session_media = obj;
100         const char *stream_type = flags & OBJ_KEY ? obj : session_media->stream_type;
101
102         return ast_str_hash(stream_type);
103 }
104
105 static int session_media_cmp(void *obj, void *arg, int flags)
106 {
107         struct ast_sip_session_media *session_media1 = obj;
108         struct ast_sip_session_media *session_media2 = arg;
109         const char *stream_type2 = flags & OBJ_KEY ? arg : session_media2->stream_type;
110
111         return strcmp(session_media1->stream_type, stream_type2) ? 0 : CMP_MATCH | CMP_STOP;
112 }
113
114 int ast_sip_session_register_sdp_handler(struct ast_sip_session_sdp_handler *handler, const char *stream_type)
115 {
116         RAII_VAR(struct sdp_handler_list *, handler_list,
117                         ao2_find(sdp_handlers, stream_type, OBJ_KEY), ao2_cleanup);
118         SCOPED_AO2LOCK(lock, sdp_handlers);
119
120         if (handler_list) {
121                 struct ast_sip_session_sdp_handler *iter;
122                 /* Check if this handler is already registered for this stream type */
123                 AST_LIST_TRAVERSE(&handler_list->list, iter, next) {
124                         if (!strcmp(iter->id, handler->id)) {
125                                 ast_log(LOG_WARNING, "Handler '%s' already registered for stream type '%s'.\n", handler->id, stream_type);
126                                 return -1;
127                         }
128                 }
129                 AST_LIST_INSERT_TAIL(&handler_list->list, handler, next);
130                 ast_debug(1, "Registered SDP stream handler '%s' for stream type '%s'\n", handler->id, stream_type); 
131                 ast_module_ref(ast_module_info->self);
132                 return 0;
133         }
134
135         /* No stream of this type has been registered yet, so we need to create a new list */
136         handler_list = ao2_alloc(sizeof(*handler_list) + strlen(stream_type), NULL);
137         if (!handler_list) {
138                 return -1;
139         }
140         /* Safe use of strcpy */
141         strcpy(handler_list->stream_type, stream_type);
142         AST_LIST_HEAD_INIT_NOLOCK(&handler_list->list);
143         AST_LIST_INSERT_TAIL(&handler_list->list, handler, next);
144         if (!ao2_link(sdp_handlers, handler_list)) {
145                 return -1;
146         }
147         ast_debug(1, "Registered SDP stream handler '%s' for stream type '%s'\n", handler->id, stream_type); 
148         ast_module_ref(ast_module_info->self);
149         return 0;
150 }
151
152 static int remove_handler(void *obj, void *arg, void *data, int flags)
153 {
154         struct sdp_handler_list *handler_list = obj;
155         struct ast_sip_session_sdp_handler *handler = data;
156         struct ast_sip_session_sdp_handler *iter;
157         const char *stream_type = arg;
158
159         AST_LIST_TRAVERSE_SAFE_BEGIN(&handler_list->list, iter, next) {
160                 if (!strcmp(iter->id, handler->id)) {
161                         AST_LIST_REMOVE_CURRENT(next);
162                         ast_debug(1, "Unregistered SDP stream handler '%s' for stream type '%s'\n", handler->id, stream_type);
163                         ast_module_unref(ast_module_info->self);
164                 }
165         }
166         AST_LIST_TRAVERSE_SAFE_END;
167
168         if (AST_LIST_EMPTY(&handler_list->list)) {
169                 ast_debug(3, "No more handlers exist for stream type '%s'\n", stream_type);
170                 return CMP_MATCH;
171         } else {
172                 return CMP_STOP;
173         }
174 }
175
176 void ast_sip_session_unregister_sdp_handler(struct ast_sip_session_sdp_handler *handler, const char *stream_type)
177 {
178         ao2_callback_data(sdp_handlers, OBJ_KEY | OBJ_UNLINK | OBJ_NODATA, remove_handler, (void *)stream_type, handler);
179 }
180
181 static int validate_port_hash(const void *obj, int flags)
182 {
183         const int *port = obj;
184         return *port;
185 }
186
187 static int validate_port_cmp(void *obj, void *arg, int flags)
188 {
189         int *port1 = obj;
190         int *port2 = arg;
191
192         return *port1 == *port2 ? CMP_MATCH | CMP_STOP : 0;
193 }
194
195 struct bundle_assoc {
196         int port;
197         char tag[1];
198 };
199
200 static int bundle_assoc_hash(const void *obj, int flags)
201 {
202         const struct bundle_assoc *assoc = obj;
203         const char *tag = flags & OBJ_KEY ? obj : assoc->tag;
204
205         return ast_str_hash(tag);
206 }
207
208 static int bundle_assoc_cmp(void *obj, void *arg, int flags)
209 {
210         struct bundle_assoc *assoc1 = obj;
211         struct bundle_assoc *assoc2 = arg;
212         const char *tag2 = flags & OBJ_KEY ? arg : assoc2->tag;
213
214         return strcmp(assoc1->tag, tag2) ? 0 : CMP_MATCH | CMP_STOP;
215 }
216
217 /* return must be ast_freed */
218 static pjmedia_sdp_attr *media_get_mid(pjmedia_sdp_media *media)
219 {
220         pjmedia_sdp_attr *attr = pjmedia_sdp_media_find_attr2(media, "mid", NULL);
221         if (!attr) {
222                 return NULL;
223         }
224
225         return attr;
226 }
227
228 static int get_bundle_port(const pjmedia_sdp_session *sdp, const char *mid)
229 {
230         int i;
231         for (i = 0; i < sdp->media_count; ++i) {
232                 pjmedia_sdp_attr *mid_attr = media_get_mid(sdp->media[i]);
233                 if (mid_attr && !pj_strcmp2(&mid_attr->value, mid)) {
234                         return sdp->media[i]->desc.port;
235                 }
236         }
237
238         return -1;
239 }
240
241 static int validate_incoming_sdp(const pjmedia_sdp_session *sdp)
242 {
243         int i;
244         RAII_VAR(struct ao2_container *, portlist, ao2_container_alloc(5, validate_port_hash, validate_port_cmp), ao2_cleanup);
245         RAII_VAR(struct ao2_container *, bundle_assoc_list, ao2_container_alloc(5, bundle_assoc_hash, bundle_assoc_cmp), ao2_cleanup);
246
247         /* check for bundles (for websocket RTP multiplexing, there can be more than one) */
248         for (i = 0; i < sdp->attr_count; ++i) {
249                 char *bundle_list;
250                 int bundle_port = 0;
251                 if (pj_stricmp2(&sdp->attr[i]->name, "group")) {
252                         continue;
253                 }
254
255                 /* check to see if this group is a bundle */
256                 if (7 >= sdp->attr[i]->value.slen || pj_strnicmp2(&sdp->attr[i]->value, "bundle ", 7)) {
257                         continue;
258                 }
259
260                 bundle_list = ast_alloca(sdp->attr[i]->value.slen - 6);
261                 strncpy(bundle_list, sdp->attr[i]->value.ptr + 7, sdp->attr[i]->value.slen - 7);
262                 bundle_list[sdp->attr[i]->value.slen - 7] = '\0';
263                 while (bundle_list) {
264                         char *item;
265                         RAII_VAR(struct bundle_assoc *, assoc, NULL, ao2_cleanup);
266                         item = strsep(&bundle_list, " ,");
267                         if (!bundle_port) {
268                                 RAII_VAR(int *, port, ao2_alloc(sizeof(int), NULL), ao2_cleanup);
269                                 RAII_VAR(int *, port_match, NULL, ao2_cleanup);
270                                 bundle_port = get_bundle_port(sdp, item);
271                                 if (bundle_port < 0) {
272                                         return -1;
273                                 }
274                                 port_match = ao2_find(portlist, &bundle_port, OBJ_KEY);
275                                 if (port_match) {
276                                         /* bundle port aready consumed by a different bundle */
277                                         return -1;
278                                 }
279                                 *port = bundle_port;
280                                 ao2_link(portlist, port);
281                         }
282                         assoc = ao2_alloc(sizeof(*assoc) + strlen(item), NULL);
283                         if (!assoc) {
284                                 return -1;
285                         }
286
287                         /* safe use of strcpy */
288                         strcpy(assoc->tag, item);
289                         assoc->port = bundle_port;
290                         ao2_link(bundle_assoc_list, assoc);
291                 }
292         }
293
294         /* validate all streams */
295         for (i = 0; i < sdp->media_count; ++i) {
296                 RAII_VAR(int *, port, ao2_alloc(sizeof(int), NULL), ao2_cleanup);
297                 RAII_VAR(int *, port_match, NULL, ao2_cleanup);
298                 RAII_VAR(int *, bundle_match, NULL, ao2_cleanup);
299                 *port = sdp->media[i]->desc.port;
300                 port_match = ao2_find(portlist, port, OBJ_KEY);
301                 if (port_match) {
302                         RAII_VAR(struct bundle_assoc *, assoc, NULL, ao2_cleanup);
303                         pjmedia_sdp_attr *mid = media_get_mid(sdp->media[i]);
304                         char *mid_val;
305
306                         if (!mid) {
307                                 /* not part of a bundle */
308                                 return -1;
309                         }
310
311                         mid_val = ast_alloca(mid->value.slen + 1);
312                         strncpy(mid_val, mid->value.ptr, mid->value.slen);
313                         mid_val[mid->value.slen] = '\0';
314
315                         assoc = ao2_find(bundle_assoc_list, mid_val, OBJ_KEY);
316                         if (!assoc || assoc->port != *port) {
317                                 /* This port already exists elsewhere in the SDP
318                                  * and is not an appropriate bundle port, fail
319                                  * catastrophically */
320                                 return -1;
321                         }
322                 }
323                 ao2_link(portlist, port);
324         }
325         return 0;
326 }
327
328 static int handle_incoming_sdp(struct ast_sip_session *session, const pjmedia_sdp_session *sdp)
329 {
330         int i;
331         if (validate_incoming_sdp(sdp)) {
332                 return -1;
333         }
334
335         for (i = 0; i < sdp->media_count; ++i) {
336                 /* See if there are registered handlers for this media stream type */
337                 char media[20];
338                 struct ast_sip_session_sdp_handler *handler;
339                 RAII_VAR(struct sdp_handler_list *, handler_list, NULL, ao2_cleanup);
340                 RAII_VAR(struct ast_sip_session_media *, session_media, NULL, ao2_cleanup);
341
342                 /* We need a null-terminated version of the media string */
343                 ast_copy_pj_str(media, &sdp->media[i]->desc.media, sizeof(media));
344
345                 session_media = ao2_find(session->media, media, OBJ_KEY);
346                 if (!session_media) {
347                         /* if the session_media doesn't exist, there weren't
348                          * any handlers at the time of its creation */
349                         continue;
350                 }
351
352                 if (session_media->handler) {
353                         int res;
354                         handler = session_media->handler;
355                         res = handler->negotiate_incoming_sdp_stream(
356                                 session, session_media, sdp, sdp->media[i]);
357                         if (res <= 0) {
358                                 /* Catastrophic failure or ignored by assigned handler. Abort! */
359                                 return -1;
360                         }
361                         if (res > 0) {
362                                 /* Handled by this handler. Move to the next stream */
363                                 continue;
364                         }
365                 }
366
367                 handler_list = ao2_find(sdp_handlers, media, OBJ_KEY);
368                 if (!handler_list) {
369                         ast_debug(1, "No registered SDP handlers for media type '%s'\n", media);
370                         continue;
371                 }
372                 AST_LIST_TRAVERSE(&handler_list->list, handler, next) {
373                         int res;
374                         if (session_media->handler) {
375                                 /* There is only one slot for this stream type and it has already been claimed
376                                  * so it will go unhandled */
377                                 break;
378                         }
379                         res = handler->negotiate_incoming_sdp_stream(session, session_media, sdp, sdp->media[i]);
380                         if (res < 0) {
381                                 /* Catastrophic failure. Abort! */
382                                 return -1;
383                         }
384                         if (res > 0) {
385                                 /* Handled by this handler. Move to the next stream */
386                                 session_media->handler = handler;
387                                 break;
388                         }
389                 }
390         }
391         return 0;
392 }
393
394 struct handle_negotiated_sdp_cb {
395         struct ast_sip_session *session;
396         const pjmedia_sdp_session *local;
397         const pjmedia_sdp_session *remote;
398 };
399
400 static int handle_negotiated_sdp_session_media(void *obj, void *arg, int flags)
401 {
402         struct ast_sip_session_media *session_media = obj;
403         struct handle_negotiated_sdp_cb *callback_data = arg;
404         struct ast_sip_session *session = callback_data->session;
405         const pjmedia_sdp_session *local = callback_data->local;
406         const pjmedia_sdp_session *remote = callback_data->remote;
407         int i;
408
409         for (i = 0; i < local->media_count; ++i) {
410                 /* See if there are registered handlers for this media stream type */
411                 char media[20];
412                 struct ast_sip_session_sdp_handler *handler;
413                 RAII_VAR(struct sdp_handler_list *, handler_list, NULL, ao2_cleanup);
414
415                 /* We need a null-terminated version of the media string */
416                 ast_copy_pj_str(media, &local->media[i]->desc.media, sizeof(media));
417
418                 /* stream type doesn't match the one we're looking to fill */
419                 if (strcasecmp(session_media->stream_type, media)) {
420                         continue;
421                 }
422
423                 handler = session_media->handler;
424                 if (handler) {
425                         int res = handler->apply_negotiated_sdp_stream(session, session_media, local, local->media[i], remote, remote->media[i]);
426                         if (res >= 0) {
427                                 return CMP_MATCH;
428                         }
429                         return 0;
430                 }
431
432                 handler_list = ao2_find(sdp_handlers, media, OBJ_KEY);
433                 if (!handler_list) {
434                         ast_debug(1, "No registered SDP handlers for media type '%s'\n", media);
435                         continue;
436                 }
437                 AST_LIST_TRAVERSE(&handler_list->list, handler, next) {
438                         int res = handler->apply_negotiated_sdp_stream(session, session_media, local, local->media[i], remote, remote->media[i]);
439                         if (res < 0) {
440                                 /* Catastrophic failure. Abort! */
441                                 return 0;
442                         }
443                         if (res > 0) {
444                                 /* Handled by this handler. Move to the next stream */
445                                 session_media->handler = handler;
446                                 return CMP_MATCH;
447                         }
448                 }
449         }
450         return CMP_MATCH;
451 }
452
453 static int handle_negotiated_sdp(struct ast_sip_session *session, const pjmedia_sdp_session *local, const pjmedia_sdp_session *remote)
454 {
455         RAII_VAR(struct ao2_iterator *, successful, NULL, ao2_iterator_cleanup);
456         struct handle_negotiated_sdp_cb callback_data = {
457                 .session = session,
458                 .local = local,
459                 .remote = remote,
460         };
461
462         successful = ao2_callback(session->media, OBJ_MULTIPLE, handle_negotiated_sdp_session_media, &callback_data);
463         if (successful && ao2_container_count(successful->c) == ao2_container_count(session->media)) {
464                 /* Nothing experienced a catastrophic failure */
465                 return 0;
466         }
467         return -1;
468 }
469
470 AST_RWLIST_HEAD_STATIC(session_supplements, ast_sip_session_supplement);
471
472 int ast_sip_session_register_supplement(struct ast_sip_session_supplement *supplement)
473 {
474         struct ast_sip_session_supplement *iter;
475         int inserted = 0;
476         SCOPED_LOCK(lock, &session_supplements, AST_RWLIST_WRLOCK, AST_RWLIST_UNLOCK);
477
478         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&session_supplements, iter, next) {
479                 if (iter->priority > supplement->priority) {
480                         AST_RWLIST_INSERT_BEFORE_CURRENT(supplement, next);
481                         inserted = 1;
482                         break;
483                 }
484         }
485         AST_RWLIST_TRAVERSE_SAFE_END;
486
487         if (!inserted) {
488                 AST_RWLIST_INSERT_TAIL(&session_supplements, supplement, next);
489         }
490         ast_module_ref(ast_module_info->self);
491         return 0;
492 }
493
494 void ast_sip_session_unregister_supplement(struct ast_sip_session_supplement *supplement)
495 {
496         struct ast_sip_session_supplement *iter;
497         SCOPED_LOCK(lock, &session_supplements, AST_RWLIST_WRLOCK, AST_RWLIST_UNLOCK);
498         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&session_supplements, iter, next) {
499                 if (supplement == iter) {
500                         AST_RWLIST_REMOVE_CURRENT(next);
501                         ast_module_unref(ast_module_info->self);
502                         break;
503                 }
504         }
505         AST_RWLIST_TRAVERSE_SAFE_END;
506 }
507
508 static struct ast_sip_session_supplement *supplement_dup(const struct ast_sip_session_supplement *src)
509 {
510         struct ast_sip_session_supplement *dst = ast_calloc(1, sizeof(*dst));
511         if (!dst) {
512                 return NULL;
513         }
514         /* Will need to revisit if shallow copy becomes an issue */
515         *dst = *src;
516         return dst;
517 }
518
519 #define DATASTORE_BUCKETS 53
520 #define MEDIA_BUCKETS 7
521
522 static void session_datastore_destroy(void *obj)
523 {
524         struct ast_datastore *datastore = obj;
525
526         /* Using the destroy function (if present) destroy the data */
527         if (datastore->info->destroy != NULL && datastore->data != NULL) {
528                 datastore->info->destroy(datastore->data);
529                 datastore->data = NULL;
530         }
531
532         ast_free((void *) datastore->uid);
533         datastore->uid = NULL;
534 }
535
536 struct ast_datastore *ast_sip_session_alloc_datastore(const struct ast_datastore_info *info, const char *uid)
537 {
538         RAII_VAR(struct ast_datastore *, datastore, NULL, ao2_cleanup);
539         const char *uid_ptr = uid;
540
541         if (!info) {
542                 return NULL;
543         }
544
545         datastore = ao2_alloc(sizeof(*datastore), session_datastore_destroy);
546         if (!datastore) {
547                 return NULL;
548         }
549
550         datastore->info = info;
551         if (ast_strlen_zero(uid)) {
552                 /* They didn't provide an ID so we'll provide one ourself */
553                 struct ast_uuid *uuid = ast_uuid_generate();
554                 char uuid_buf[AST_UUID_STR_LEN];
555                 if (!uuid) {
556                         return NULL;
557                 }
558                 uid_ptr = ast_uuid_to_str(uuid, uuid_buf, sizeof(uuid_buf));
559                 ast_free(uuid);
560         }
561
562         datastore->uid = ast_strdup(uid_ptr);
563         if (!datastore->uid) {
564                 return NULL;
565         }
566
567         ao2_ref(datastore, +1);
568         return datastore;
569 }
570
571 int ast_sip_session_add_datastore(struct ast_sip_session *session, struct ast_datastore *datastore)
572 {
573         ast_assert(datastore != NULL);
574         ast_assert(datastore->info != NULL);
575         ast_assert(ast_strlen_zero(datastore->uid) == 0);
576
577         if (!ao2_link(session->datastores, datastore)) {
578                 return -1;
579         }
580         return 0;
581 }
582
583 struct ast_datastore *ast_sip_session_get_datastore(struct ast_sip_session *session, const char *name)
584 {
585         return ao2_find(session->datastores, name, OBJ_KEY);
586 }
587
588 void ast_sip_session_remove_datastore(struct ast_sip_session *session, const char *name)
589 {
590         ao2_callback(session->datastores, OBJ_KEY | OBJ_UNLINK | OBJ_NODATA, NULL, (void *) name);
591 }
592
593 int ast_sip_session_get_identity(struct pjsip_rx_data *rdata, struct ast_party_id *id)
594 {
595         /* XXX STUB
596          * This is low-priority as far as getting SIP working is concerned, so this
597          * will be addressed later.
598          *
599          * The idea here will be that the rdata will be examined for headers such as
600          * P-Asserted-Identity, Remote-Party-ID, and From in order to determine Identity
601          * information.
602          *
603          * For reference, Asterisk SCF code does something very similar to this, except in
604          * C++ and using its version of the ast_party_id struct, so using it as a basis
605          * would be a smart idea here.
606          */
607         return 0;
608 }
609
610 /*!
611  * \brief Structure used for sending delayed requests
612  *
613  * Requests are typically delayed because the current transaction
614  * state of an INVITE. Once the pending INVITE transaction terminates,
615  * the delayed request will be sent
616  */
617 struct ast_sip_session_delayed_request {
618         /*! Method of the request */
619         char method[15];
620         /*! Callback to call when the delayed request is created. */
621         ast_sip_session_request_creation_cb on_request_creation;
622         /*! Callback to call when the delayed request receives a response */
623         ast_sip_session_response_cb on_response;
624         /*! Request to send */
625         pjsip_tx_data *tdata;
626         AST_LIST_ENTRY(ast_sip_session_delayed_request) next;
627 };
628
629 static struct ast_sip_session_delayed_request *delayed_request_alloc(const char *method,
630                 ast_sip_session_request_creation_cb on_request_creation,
631                 ast_sip_session_response_cb on_response,
632                 pjsip_tx_data *tdata)
633 {
634         struct ast_sip_session_delayed_request *delay = ast_calloc(1, sizeof(*delay));
635         if (!delay) {
636                 return NULL;
637         }
638         ast_copy_string(delay->method, method, sizeof(delay->method));
639         delay->on_request_creation = on_request_creation;
640         delay->on_response = on_response;
641         delay->tdata = tdata;
642         return delay;
643 }
644
645 static int send_delayed_request(struct ast_sip_session *session, struct ast_sip_session_delayed_request *delay)
646 {
647         ast_debug(3, "Sending delayed %s request to %s\n", delay->method, ast_sorcery_object_get_id(session->endpoint));
648
649         if (delay->tdata) {
650                 ast_sip_session_send_request_with_cb(session, delay->tdata, delay->on_response);
651                 return 0;
652         }
653
654         if (!strcmp(delay->method, "INVITE")) {
655                 ast_sip_session_refresh(session, delay->on_request_creation,
656                                 delay->on_response, AST_SIP_SESSION_REFRESH_METHOD_INVITE, 1);
657         } else if (!strcmp(delay->method, "UPDATE")) {
658                 ast_sip_session_refresh(session, delay->on_request_creation,
659                                 delay->on_response, AST_SIP_SESSION_REFRESH_METHOD_UPDATE, 1);
660         } else {
661                 ast_log(LOG_WARNING, "Unexpected delayed %s request with no existing request structure\n", delay->method);
662                 return -1;
663         }
664         return 0;
665 }
666
667 static int queued_delayed_request_send(void *data)
668 {
669         RAII_VAR(struct ast_sip_session *, session, data, ao2_cleanup);
670         RAII_VAR(struct ast_sip_session_delayed_request *, delay, NULL, ast_free_ptr);
671
672         delay = AST_LIST_REMOVE_HEAD(&session->delayed_requests, next);
673         if (!delay) {
674                 return 0;
675         }
676
677         return send_delayed_request(session, delay);
678 }
679
680 static void queue_delayed_request(struct ast_sip_session *session)
681 {
682         if (AST_LIST_EMPTY(&session->delayed_requests)) {
683                 /* No delayed request to send, so just return */
684                 return;
685         }
686
687         ast_debug(3, "Queuing delayed request to run for %s\n",
688                         ast_sorcery_object_get_id(session->endpoint));
689
690         ao2_ref(session, +1);
691         ast_sip_push_task(session->serializer, queued_delayed_request_send, session);
692 }
693
694 static int delay_request(struct ast_sip_session *session, ast_sip_session_request_creation_cb on_request,
695                 ast_sip_session_response_cb on_response, const char *method, pjsip_tx_data *tdata)
696 {
697         struct ast_sip_session_delayed_request *delay = delayed_request_alloc(method,
698                         on_request, on_response, tdata);
699
700         if (!delay) {
701                 return -1;
702         }
703
704         AST_LIST_INSERT_TAIL(&session->delayed_requests, delay, next);
705         return 0;
706 }
707
708 static pjmedia_sdp_session *generate_session_refresh_sdp(struct ast_sip_session *session)
709 {
710         pjsip_inv_session *inv_session = session->inv_session;
711         const pjmedia_sdp_session *previous_sdp;
712
713         if (pjmedia_sdp_neg_was_answer_remote(inv_session->neg)) {
714                 pjmedia_sdp_neg_get_active_remote(inv_session->neg, &previous_sdp);
715         } else {
716                 pjmedia_sdp_neg_get_active_local(inv_session->neg, &previous_sdp);
717         }
718         return create_local_sdp(inv_session, session, previous_sdp);
719 }
720
721 int ast_sip_session_refresh(struct ast_sip_session *session,
722                 ast_sip_session_request_creation_cb on_request_creation, ast_sip_session_response_cb on_response,
723                 enum ast_sip_session_refresh_method method, int generate_new_sdp)
724 {
725         pjsip_inv_session *inv_session = session->inv_session;
726         pjmedia_sdp_session *new_sdp = NULL;
727         pjsip_tx_data *tdata;
728
729         if (inv_session->state == PJSIP_INV_STATE_DISCONNECTED) {
730                 /* Don't try to do anything with a hung-up call */
731                 ast_debug(3, "Not sending reinvite to %s because of disconnected state...\n",
732                                 ast_sorcery_object_get_id(session->endpoint));
733                 return 0;
734         }
735
736         if ((method == AST_SIP_SESSION_REFRESH_METHOD_INVITE) && inv_session->invite_tsx) {
737                 /* We can't send a reinvite yet, so delay it */
738                 ast_debug(3, "Delaying sending reinvite to %s because of outstanding transaction...\n",
739                                 ast_sorcery_object_get_id(session->endpoint));
740                 return delay_request(session, on_request_creation, on_response, "INVITE", NULL);
741         }
742
743         if (generate_new_sdp) {
744                 new_sdp = generate_session_refresh_sdp(session);
745                 if (!new_sdp) {
746                         ast_log(LOG_ERROR, "Failed to generate session refresh SDP. Not sending session refresh\n");
747                         return -1;
748                 }
749         }
750
751         if (method == AST_SIP_SESSION_REFRESH_METHOD_INVITE) {
752                 if (pjsip_inv_reinvite(inv_session, NULL, new_sdp, &tdata)) {
753                         ast_log(LOG_WARNING, "Failed to create reinvite properly.\n");
754                         return -1;
755                 }
756         } else if (pjsip_inv_update(inv_session, NULL, new_sdp, &tdata)) {
757                 ast_log(LOG_WARNING, "Failed to create UPDATE properly.\n");
758                 return -1;
759         }
760         if (on_request_creation) {
761                 if (on_request_creation(session, tdata)) {
762                         return -1;
763                 }
764         }
765         ast_sip_session_send_request_with_cb(session, tdata, on_response);
766         return 0;
767 }
768
769 void ast_sip_session_send_response(struct ast_sip_session *session, pjsip_tx_data *tdata)
770 {
771         handle_outgoing_response(session, tdata);
772         pjsip_inv_send_msg(session->inv_session, tdata);
773         return;
774 }
775
776 static pj_status_t session_load(pjsip_endpoint *endpt);
777 static pj_status_t session_start(void);
778 static pj_status_t session_stop(void);
779 static pj_status_t session_unload(void);
780 static pj_bool_t session_on_rx_request(pjsip_rx_data *rdata);
781
782 static pjsip_module session_module = {
783         .name = {"Session Module", 14},
784         .priority = PJSIP_MOD_PRIORITY_APPLICATION,
785         .load = session_load,
786         .unload = session_unload,
787         .start = session_start,
788         .stop = session_stop,
789         .on_rx_request = session_on_rx_request,
790 };
791
792 void ast_sip_session_send_request_with_cb(struct ast_sip_session *session, pjsip_tx_data *tdata,
793                 ast_sip_session_response_cb on_response)
794 {
795         pjsip_inv_session *inv_session = session->inv_session;
796
797         if (inv_session->state == PJSIP_INV_STATE_DISCONNECTED) {
798                 /* Don't try to do anything with a hung-up call */
799                 return;
800         }
801
802         tdata->mod_data[session_module.id] = on_response;
803         handle_outgoing_request(session, tdata);
804         pjsip_inv_send_msg(session->inv_session, tdata);
805         return;
806 }
807
808 void ast_sip_session_send_request(struct ast_sip_session *session, pjsip_tx_data *tdata)
809 {
810         ast_sip_session_send_request_with_cb(session, tdata, NULL);
811 }
812
813 int ast_sip_session_create_invite(struct ast_sip_session *session, pjsip_tx_data **tdata)
814 {
815         pjmedia_sdp_session *offer;
816
817         if (!(offer = create_local_sdp(session->inv_session, session, NULL))) {
818                 pjsip_inv_terminate(session->inv_session, 500, PJ_FALSE);
819                 return -1;
820         }
821
822         pjsip_inv_set_local_sdp(session->inv_session, offer);
823         pjmedia_sdp_neg_set_prefer_remote_codec_order(session->inv_session->neg, PJ_FALSE);
824         if (pjsip_inv_invite(session->inv_session, tdata) != PJ_SUCCESS) {
825                 return -1;
826         }
827         return 0;
828 }
829
830 /*!
831  * \brief Called when the PJSIP core loads us
832  *
833  * Since we already have Asterisk's fine module load/unload framework
834  * in use, we don't need to do anything special here.
835  */
836 static pj_status_t session_load(pjsip_endpoint *endpt)
837 {
838         return PJ_SUCCESS;
839 }
840
841 /*!
842  * \brief Called when the PJSIP core starts us
843  *
844  * Since we already have Asterisk's fine module load/unload framework
845  * in use, we don't need to do anything special here.
846  */
847 static pj_status_t session_start(void)
848 {
849         return PJ_SUCCESS;
850 }
851
852 /*!
853  * \brief Called when the PJSIP core stops us
854  *
855  * Since we already have Asterisk's fine module load/unload framework
856  * in use, we don't need to do anything special here.
857  */
858 static pj_status_t session_stop(void)
859 {
860         return PJ_SUCCESS;
861 }
862
863 /*!
864  * \brief Called when the PJSIP core unloads us
865  *
866  * Since we already have Asterisk's fine module load/unload framework
867  * in use, we don't need to do anything special here.
868  */
869 static pj_status_t session_unload(void)
870 {
871         return PJ_SUCCESS;
872 }
873
874 static int datastore_hash(const void *obj, int flags)
875 {
876         const struct ast_datastore *datastore = obj;
877         const char *uid = flags & OBJ_KEY ? obj : datastore->uid;
878
879         ast_assert(uid != NULL);
880
881         return ast_str_hash(uid);
882 }
883
884 static int datastore_cmp(void *obj, void *arg, int flags)
885 {
886         const struct ast_datastore *datastore1 = obj;
887         const struct ast_datastore *datastore2 = arg;
888         const char *uid2 = flags & OBJ_KEY ? arg : datastore2->uid;
889
890         ast_assert(datastore1->uid != NULL);
891         ast_assert(uid2 != NULL);
892
893         return strcmp(datastore1->uid, uid2) ? 0 : CMP_MATCH | CMP_STOP;
894 }
895
896 static void session_media_dtor(void *obj)
897 {
898         struct ast_sip_session_media *session_media = obj;
899         if (session_media->handler) {
900                 session_media->handler->stream_destroy(session_media);
901         }
902         if (session_media->srtp) {
903                 ast_sdp_srtp_destroy(session_media->srtp);
904         }
905 }
906
907 static void session_destructor(void *obj)
908 {
909         struct ast_sip_session *session = obj;
910         struct ast_sip_session_supplement *supplement;
911         struct ast_sip_session_delayed_request *delay;
912
913         ast_debug(3, "Destroying SIP session with endpoint %s\n",
914                         ast_sorcery_object_get_id(session->endpoint));
915
916         while ((supplement = AST_LIST_REMOVE_HEAD(&session->supplements, next))) {
917                 if (supplement->session_destroy) {
918                         supplement->session_destroy(session);
919                 }
920                 ast_free(supplement);
921         }
922
923         ast_taskprocessor_unreference(session->serializer);
924         ao2_cleanup(session->datastores);
925         ao2_cleanup(session->media);
926         AST_LIST_HEAD_DESTROY(&session->supplements);
927         while ((delay = AST_LIST_REMOVE_HEAD(&session->delayed_requests, next))) {
928                 ast_free(delay);
929         }
930         ast_party_id_free(&session->id);
931         ao2_cleanup(session->endpoint);
932         ast_format_cap_destroy(session->req_caps);
933
934         if (session->dsp) {
935                 ast_dsp_free(session->dsp);
936         }
937
938         if (session->inv_session) {
939                 pjsip_dlg_dec_session(session->inv_session->dlg, &session_module);
940         }
941 }
942
943 static int add_supplements(struct ast_sip_session *session)
944 {
945         struct ast_sip_session_supplement *iter;
946         SCOPED_LOCK(lock, &session_supplements, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK);
947
948         AST_RWLIST_TRAVERSE(&session_supplements, iter, next) {
949                 struct ast_sip_session_supplement *copy = supplement_dup(iter);
950                 if (!copy) {
951                         return -1;
952                 }
953                 AST_LIST_INSERT_TAIL(&session->supplements, copy, next);
954         }
955         return 0;
956 }
957
958 static int add_session_media(void *obj, void *arg, int flags)
959 {
960         struct sdp_handler_list *handler_list = obj;
961         struct ast_sip_session * session = arg;
962         RAII_VAR(struct ast_sip_session_media *, session_media, NULL, ao2_cleanup);
963         session_media = ao2_alloc(sizeof(*session_media) + strlen(handler_list->stream_type), session_media_dtor);
964         if (!session_media) {
965                 return CMP_STOP;
966         }
967         /* Safe use of strcpy */
968         strcpy(session_media->stream_type, handler_list->stream_type);
969         ao2_link(session->media, session_media);
970         return 0;
971 }
972
973 struct ast_sip_session *ast_sip_session_alloc(struct ast_sip_endpoint *endpoint, pjsip_inv_session *inv_session)
974 {
975         RAII_VAR(struct ast_sip_session *, session, ao2_alloc(sizeof(*session), session_destructor), ao2_cleanup);
976         struct ast_sip_session_supplement *iter;
977         if (!session) {
978                 return NULL;
979         }
980         AST_LIST_HEAD_INIT(&session->supplements);
981         session->datastores = ao2_container_alloc(DATASTORE_BUCKETS, datastore_hash, datastore_cmp);
982         if (!session->datastores) {
983                 return NULL;
984         }
985
986         session->media = ao2_container_alloc(MEDIA_BUCKETS, session_media_hash, session_media_cmp);
987         if (!session->media) {
988                 return NULL;
989         }
990         /* fill session->media with available types */
991         ao2_callback(sdp_handlers, OBJ_NODATA, add_session_media, session);
992
993         session->serializer = ast_sip_create_serializer();
994         if (!session->serializer) {
995                 return NULL;
996         }
997         ast_sip_dialog_set_serializer(inv_session->dlg, session->serializer);
998         ast_sip_dialog_set_endpoint(inv_session->dlg, endpoint);
999         pjsip_dlg_inc_session(inv_session->dlg, &session_module);
1000         ao2_ref(endpoint, +1);
1001         inv_session->mod_data[session_module.id] = session;
1002         session->endpoint = endpoint;
1003         session->inv_session = inv_session;
1004         session->req_caps = ast_format_cap_alloc_nolock();
1005
1006         if (endpoint->dtmf == AST_SIP_DTMF_INBAND) {
1007                 if (!(session->dsp = ast_dsp_new())) {
1008                         return NULL;
1009                 }
1010
1011                 ast_dsp_set_features(session->dsp, DSP_FEATURE_DIGIT_DETECT);
1012         }
1013
1014         if (add_supplements(session)) {
1015                 return NULL;
1016         }
1017         AST_LIST_TRAVERSE(&session->supplements, iter, next) {
1018                 if (iter->session_begin) {
1019                         iter->session_begin(session);
1020                 }
1021         }
1022         session->direct_media_cap = ast_format_cap_alloc_nolock();
1023         AST_LIST_HEAD_INIT_NOLOCK(&session->delayed_requests);
1024         ast_party_id_init(&session->id);
1025         ao2_ref(session, +1);
1026         return session;
1027 }
1028
1029 static int session_outbound_auth(pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data)
1030 {
1031         pjsip_inv_session *inv = pjsip_dlg_get_inv_session(dlg);
1032         struct ast_sip_session *session = inv->mod_data[session_module.id];
1033
1034         if (inv->state < PJSIP_INV_STATE_CONFIRMED && tdata->msg->line.req.method.id == PJSIP_INVITE_METHOD) {
1035                 pjsip_inv_uac_restart(inv, PJ_TRUE);
1036         }
1037         ast_sip_session_send_request(session, tdata);
1038         return 0;
1039 }
1040
1041 struct ast_sip_session *ast_sip_session_create_outgoing(struct ast_sip_endpoint *endpoint, const char *location, const char *request_user, struct ast_format_cap *req_caps)
1042 {
1043         const char *uri = NULL;
1044         RAII_VAR(struct ast_sip_contact *, contact, NULL, ao2_cleanup);
1045         pjsip_timer_setting timer;
1046         pjsip_dialog *dlg;
1047         struct pjsip_inv_session *inv_session;
1048         RAII_VAR(struct ast_sip_session *, session, NULL, ao2_cleanup);
1049
1050         /* If no location has been provided use the AOR list from the endpoint itself */
1051         location = S_OR(location, endpoint->aors);
1052
1053         contact = ast_sip_location_retrieve_contact_from_aor_list(location);
1054         if (!contact || ast_strlen_zero(contact->uri)) {
1055                 uri = location;
1056         } else {
1057                 uri = contact->uri;
1058         }
1059
1060         /* If we still have no URI to dial fail to create the session */
1061         if (ast_strlen_zero(uri)) {
1062                 return NULL;
1063         }
1064
1065         if (!(dlg = ast_sip_create_dialog(endpoint, uri, request_user))) {
1066                 return NULL;
1067         }
1068
1069         if (ast_sip_dialog_setup_outbound_authentication(dlg, endpoint, session_outbound_auth, NULL)) {
1070                 pjsip_dlg_terminate(dlg);
1071                 return NULL;
1072         }
1073
1074         if (pjsip_inv_create_uac(dlg, NULL, endpoint->extensions, &inv_session) != PJ_SUCCESS) {
1075                 pjsip_dlg_terminate(dlg);
1076                 return NULL;
1077         }
1078
1079         pjsip_timer_setting_default(&timer);
1080         timer.min_se = endpoint->min_se;
1081         timer.sess_expires = endpoint->sess_expires;
1082         pjsip_timer_init_session(inv_session, &timer);
1083
1084         if (!(session = ast_sip_session_alloc(endpoint, inv_session))) {
1085                 pjsip_inv_terminate(inv_session, 500, PJ_FALSE);
1086                 return NULL;
1087         }
1088
1089         ast_format_cap_copy(session->req_caps, req_caps);
1090         if ((pjsip_dlg_add_usage(dlg, &session_module, NULL) != PJ_SUCCESS)) {
1091                 pjsip_inv_terminate(inv_session, 500, PJ_FALSE);
1092                 return NULL;
1093         }
1094
1095         ao2_ref(session, +1);
1096         return session;
1097 }
1098
1099 static int session_termination_task(void *data)
1100 {
1101         RAII_VAR(struct ast_sip_session *, session, data, ao2_cleanup);
1102         pjsip_tx_data *packet = NULL;
1103
1104         if (!session->inv_session) {
1105                 return 0;
1106         }
1107
1108         if (pjsip_inv_end_session(session->inv_session, 603, NULL, &packet) == PJ_SUCCESS) {
1109                 ast_sip_session_send_request(session, packet);
1110         }
1111
1112         return 0;
1113 }
1114
1115 static void session_termination_cb(pj_timer_heap_t *timer_heap, struct pj_timer_entry *entry)
1116 {
1117         struct ast_sip_session *session = entry->user_data;
1118
1119         if (ast_sip_push_task(session->serializer, session_termination_task, session)) {
1120                 ao2_cleanup(session);
1121         }
1122 }
1123
1124 void ast_sip_session_defer_termination(struct ast_sip_session *session)
1125 {
1126         pj_time_val delay = { .sec = 60, };
1127
1128         session->defer_terminate = 1;
1129
1130         session->scheduled_termination.id = 0;
1131         ao2_ref(session, +1);
1132         session->scheduled_termination.user_data = session;
1133         session->scheduled_termination.cb = session_termination_cb;
1134
1135         if (pjsip_endpt_schedule_timer(ast_sip_get_pjsip_endpoint(), &session->scheduled_termination, &delay) != PJ_SUCCESS) {
1136                 ao2_ref(session, -1);
1137         }
1138 }
1139
1140 struct ast_sip_session *ast_sip_dialog_get_session(pjsip_dialog *dlg)
1141 {
1142         pjsip_inv_session *inv_session = pjsip_dlg_get_inv_session(dlg);
1143         struct ast_sip_session *session;
1144
1145         if (!inv_session ||
1146                 !(session = inv_session->mod_data[session_module.id])) {
1147                 return NULL;
1148         }
1149
1150         ao2_ref(session, +1);
1151
1152         return session;
1153 }
1154
1155 enum sip_get_destination_result {
1156         /*! The extension was successfully found */
1157         SIP_GET_DEST_EXTEN_FOUND,
1158         /*! The extension specified in the RURI was not found */
1159         SIP_GET_DEST_EXTEN_NOT_FOUND,
1160         /*! The extension specified in the RURI was a partial match */
1161         SIP_GET_DEST_EXTEN_PARTIAL,
1162         /*! The RURI is of an unsupported scheme */
1163         SIP_GET_DEST_UNSUPPORTED_URI,
1164 };
1165
1166 /*!
1167  * \brief Determine where in the dialplan a call should go
1168  *
1169  * This uses the username in the request URI to try to match
1170  * an extension in the endpoint's configured context in order
1171  * to route the call.
1172  *
1173  * \param session The inbound SIP session
1174  * \param rdata The SIP INVITE
1175  */
1176 static enum sip_get_destination_result get_destination(struct ast_sip_session *session, pjsip_rx_data *rdata)
1177 {
1178         pjsip_uri *ruri = rdata->msg_info.msg->line.req.uri;
1179         pjsip_sip_uri *sip_ruri;
1180         if (!PJSIP_URI_SCHEME_IS_SIP(ruri) && !PJSIP_URI_SCHEME_IS_SIPS(ruri)) {
1181                 return SIP_GET_DEST_UNSUPPORTED_URI;
1182         }
1183         sip_ruri = pjsip_uri_get_uri(ruri);
1184         ast_copy_pj_str(session->exten, &sip_ruri->user, sizeof(session->exten));
1185         if (ast_exists_extension(NULL, session->endpoint->context, session->exten, 1, NULL)) {
1186                 return SIP_GET_DEST_EXTEN_FOUND;
1187         }
1188         /* XXX In reality, we'll likely have further options so that partial matches
1189          * can be indicated here, but for getting something up and running, we're going
1190          * to return a "not exists" error here.
1191          */
1192         return SIP_GET_DEST_EXTEN_NOT_FOUND;
1193 }
1194
1195 static pjsip_inv_session *pre_session_setup(pjsip_rx_data *rdata, const struct ast_sip_endpoint *endpoint)
1196 {
1197         pjsip_tx_data *tdata;
1198         pjsip_dialog *dlg;
1199         pjsip_inv_session *inv_session;
1200         unsigned int options = endpoint->extensions;
1201
1202         if (pjsip_inv_verify_request(rdata, &options, NULL, NULL, ast_sip_get_pjsip_endpoint(), &tdata) != PJ_SUCCESS) {
1203                 if (tdata) {
1204                         pjsip_endpt_send_response2(ast_sip_get_pjsip_endpoint(), rdata, tdata, NULL, NULL);
1205                 } else {
1206                         pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 500, NULL, NULL, NULL);
1207                 }
1208                 return NULL;
1209         }
1210         if (pjsip_dlg_create_uas(pjsip_ua_instance(), rdata, NULL, &dlg) != PJ_SUCCESS) {
1211                 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 500, NULL, NULL, NULL);
1212                 return NULL;
1213         }
1214         if (pjsip_inv_create_uas(dlg, rdata, NULL, 0, &inv_session) != PJ_SUCCESS) {
1215                 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 500, NULL, NULL, NULL);
1216                 pjsip_dlg_terminate(dlg);
1217                 return NULL;
1218         }
1219         if (pjsip_dlg_add_usage(dlg, &session_module, NULL) != PJ_SUCCESS) {
1220                 if (pjsip_inv_initial_answer(inv_session, rdata, 500, NULL, NULL, &tdata) != PJ_SUCCESS) {
1221                         pjsip_inv_terminate(inv_session, 500, PJ_FALSE);
1222                 }
1223                 pjsip_inv_send_msg(inv_session, tdata);
1224                 return NULL;
1225         }
1226         return inv_session;
1227 }
1228
1229 static void handle_new_invite_request(pjsip_rx_data *rdata)
1230 {
1231         RAII_VAR(struct ast_sip_endpoint *, endpoint,
1232                         ast_pjsip_rdata_get_endpoint(rdata), ao2_cleanup);
1233         pjsip_tx_data *tdata = NULL;
1234         pjsip_inv_session *inv_session = NULL;
1235         struct ast_sip_session *session = NULL;
1236         pjsip_timer_setting timer;
1237         pjsip_rdata_sdp_info *sdp_info;
1238         pjmedia_sdp_session *local = NULL;
1239
1240         ast_assert(endpoint != NULL);
1241
1242         inv_session = pre_session_setup(rdata, endpoint);
1243         if (!inv_session) {
1244                 /* pre_session_setup() returns a response on failure */
1245                 return;
1246         }
1247
1248         session = ast_sip_session_alloc(endpoint, inv_session);
1249         if (!session) {
1250                 if (pjsip_inv_initial_answer(inv_session, rdata, 500, NULL, NULL, &tdata) == PJ_SUCCESS) {
1251                         pjsip_inv_terminate(inv_session, 500, PJ_FALSE);
1252                 } else {
1253                         pjsip_inv_send_msg(inv_session, tdata);
1254                 }
1255                 return;
1256         }
1257
1258         /* From this point on, any calls to pjsip_inv_terminate have the last argument as PJ_TRUE
1259          * so that we will be notified so we can destroy the session properly
1260          */
1261
1262         switch (get_destination(session, rdata)) {
1263         case SIP_GET_DEST_EXTEN_FOUND:
1264                 /* Things worked. Keep going */
1265                 break;
1266         case SIP_GET_DEST_UNSUPPORTED_URI:
1267                 if (pjsip_inv_initial_answer(inv_session, rdata, 416, NULL, NULL, &tdata) == PJ_SUCCESS) {
1268                         ast_sip_session_send_response(session, tdata);
1269                 } else  {
1270                         pjsip_inv_terminate(inv_session, 416, PJ_TRUE);
1271                 }
1272                 return;
1273         case SIP_GET_DEST_EXTEN_NOT_FOUND:
1274         case SIP_GET_DEST_EXTEN_PARTIAL:
1275         default:
1276                 ast_log(LOG_NOTICE, "Call from '%s' (%s:%s:%d) to extension '%s' rejected because extension not found in context '%s'.\n",
1277                         ast_sorcery_object_get_id(session->endpoint), rdata->tp_info.transport->type_name, rdata->pkt_info.src_name,
1278                         rdata->pkt_info.src_port, session->exten, session->endpoint->context);
1279
1280                 if (pjsip_inv_initial_answer(inv_session, rdata, 404, NULL, NULL, &tdata) == PJ_SUCCESS) {
1281                         ast_sip_session_send_response(session, tdata);
1282                 } else  {
1283                         pjsip_inv_terminate(inv_session, 404, PJ_TRUE);
1284                 }
1285                 return;
1286         };
1287
1288         if ((sdp_info = pjsip_rdata_get_sdp_info(rdata)) && (sdp_info->sdp_err == PJ_SUCCESS) && sdp_info->sdp) {
1289                 if (handle_incoming_sdp(session, sdp_info->sdp)) {
1290                         if (pjsip_inv_initial_answer(inv_session, rdata, 488, NULL, NULL, &tdata) == PJ_SUCCESS) {
1291                                 ast_sip_session_send_response(session, tdata);
1292                         } else  {
1293                                 pjsip_inv_terminate(inv_session, 488, PJ_TRUE);
1294                         }
1295                         return;
1296                 }
1297                 /* We are creating a local SDP which is an answer to their offer */
1298                 local = create_local_sdp(inv_session, session, sdp_info->sdp);
1299         } else {
1300                 /* We are creating a local SDP which is an offer */
1301                 local = create_local_sdp(inv_session, session, NULL);
1302         }
1303
1304         /* If we were unable to create a local SDP terminate the session early, it won't go anywhere */
1305         if (!local) {
1306                 if (pjsip_inv_initial_answer(inv_session, rdata, 500, NULL, NULL, &tdata) == PJ_SUCCESS) {
1307                         ast_sip_session_send_response(session, tdata);
1308                 } else  {
1309                         pjsip_inv_terminate(inv_session, 500, PJ_TRUE);
1310                 }
1311                 return;
1312         } else {
1313                 pjsip_inv_set_local_sdp(inv_session, local);
1314                 pjmedia_sdp_neg_set_prefer_remote_codec_order(inv_session->neg, PJ_FALSE);
1315         }
1316
1317         pjsip_timer_setting_default(&timer);
1318         timer.min_se = endpoint->min_se;
1319         timer.sess_expires = endpoint->sess_expires;
1320         pjsip_timer_init_session(inv_session, &timer);
1321
1322         /* At this point, we've verified what we can, so let's go ahead and send a 100 Trying out */
1323         if (pjsip_inv_initial_answer(inv_session, rdata, 100, NULL, NULL, &tdata) != PJ_SUCCESS) {
1324                 pjsip_inv_terminate(inv_session, 500, PJ_TRUE);
1325                 return;
1326         }
1327         ast_sip_session_send_response(session, tdata);
1328
1329         handle_incoming_request(session, rdata);
1330 }
1331
1332 static pj_bool_t does_method_match(const pj_str_t *message_method, const char *supplement_method)
1333 {
1334         pj_str_t method;
1335
1336         if (ast_strlen_zero(supplement_method)) {
1337                 return PJ_TRUE;
1338         }
1339
1340         pj_cstr(&method, supplement_method);
1341
1342         return pj_stristr(&method, message_method) ? PJ_TRUE : PJ_FALSE;
1343 }
1344
1345 static pj_bool_t has_supplement(const struct ast_sip_session *session, const pjsip_rx_data *rdata)
1346 {
1347         struct ast_sip_session_supplement *supplement;
1348         struct pjsip_method *method = &rdata->msg_info.msg->line.req.method;
1349
1350         if (!session) {
1351                 return PJ_FALSE;
1352         }
1353
1354         AST_LIST_TRAVERSE(&session->supplements, supplement, next) {
1355                 if (does_method_match(&method->name, supplement->method)) {
1356                         return PJ_TRUE;
1357                 }
1358         }
1359         return PJ_FALSE;
1360 }
1361 /*!
1362  * \brief Called when a new SIP request comes into PJSIP
1363  *
1364  * This function is called under two circumstances
1365  * 1) An out-of-dialog request is received by PJSIP
1366  * 2) An in-dialog request that the inv_session layer does not
1367  *    handle is received (such as an in-dialog INFO)
1368  *
1369  * In all cases, there is very little we actually do in this function
1370  * 1) For requests we don't handle, we return PJ_FALSE
1371  * 2) For new INVITEs, throw the work into the SIP threadpool to be done
1372  *    there to free up the thread(s) handling incoming requests
1373  * 3) For in-dialog requests we handle, we defer handling them until the
1374  *    on_inv_state_change() callback instead (where we will end up putting
1375  *    them into the threadpool).
1376  */
1377 static pj_bool_t session_on_rx_request(pjsip_rx_data *rdata)
1378 {
1379         pj_status_t handled = PJ_FALSE;
1380         pjsip_dialog *dlg = pjsip_rdata_get_dlg(rdata);
1381         pjsip_inv_session *inv_session;
1382
1383         switch (rdata->msg_info.msg->line.req.method.id) {
1384         case PJSIP_INVITE_METHOD:
1385                 if (dlg) {
1386                         ast_log(LOG_WARNING, "on_rx_request called for INVITE in mid-dialog?\n");
1387                         break;
1388                 }
1389                 handled = PJ_TRUE;
1390                 handle_new_invite_request(rdata);
1391                 break;
1392         default:
1393                 /* Handle other in-dialog methods if their supplements have been registered */
1394                 handled = dlg && (inv_session = pjsip_dlg_get_inv_session(dlg)) &&
1395                         has_supplement(inv_session->mod_data[session_module.id], rdata);
1396                 break;
1397         }
1398
1399         return handled;
1400 }
1401
1402 struct reschedule_reinvite_data {
1403         struct ast_sip_session *session;
1404         struct ast_sip_session_delayed_request *delay;
1405 };
1406
1407 static struct reschedule_reinvite_data *reschedule_reinvite_data_alloc(
1408                 struct ast_sip_session *session, struct ast_sip_session_delayed_request *delay)
1409 {
1410         struct reschedule_reinvite_data *rrd = ast_malloc(sizeof(*rrd));
1411         if (!rrd) {
1412                 return NULL;
1413         }
1414         ao2_ref(session, +1);
1415         rrd->session = session;
1416         rrd->delay = delay;
1417         return rrd;
1418 }
1419
1420 static void reschedule_reinvite_data_destroy(struct reschedule_reinvite_data *rrd)
1421 {
1422         ao2_cleanup(rrd->session);
1423         ast_free(rrd->delay);
1424         ast_free(rrd);
1425 }
1426
1427 static int really_resend_reinvite(void *data)
1428 {
1429         RAII_VAR(struct reschedule_reinvite_data *, rrd, data, reschedule_reinvite_data_destroy);
1430
1431         return send_delayed_request(rrd->session, rrd->delay);
1432 }
1433
1434 static void resend_reinvite(pj_timer_heap_t *timer, pj_timer_entry *entry)
1435 {
1436         struct reschedule_reinvite_data *rrd = entry->user_data;
1437
1438         ast_sip_push_task(rrd->session->serializer, really_resend_reinvite, entry->user_data);
1439 }
1440
1441 static void reschedule_reinvite(struct ast_sip_session *session, ast_sip_session_response_cb on_response, pjsip_tx_data *tdata)
1442 {
1443         struct ast_sip_session_delayed_request *delay = delayed_request_alloc("INVITE",
1444                         NULL, on_response, tdata);
1445         pjsip_inv_session *inv = session->inv_session;
1446         struct reschedule_reinvite_data *rrd = reschedule_reinvite_data_alloc(session, delay);
1447         pj_time_val tv;
1448         
1449         if (!rrd || !delay) {
1450                 return;
1451         }
1452
1453         tv.sec = 0;
1454         if (inv->role == PJSIP_ROLE_UAC) {
1455                 tv.msec = 2100 + ast_random() % 2000;
1456         } else {
1457                 tv.msec = ast_random() % 2000;
1458         }
1459
1460         pj_timer_entry_init(&session->rescheduled_reinvite, 0, rrd, resend_reinvite);
1461
1462         pjsip_endpt_schedule_timer(ast_sip_get_pjsip_endpoint(), &session->rescheduled_reinvite, &tv);
1463 }
1464
1465 static void __print_debug_details(const char *function, pjsip_inv_session *inv, pjsip_transaction *tsx, pjsip_event *e)
1466 {
1467         struct ast_sip_session *session;
1468         ast_debug(5, "Function %s called on event %s\n", function, pjsip_event_str(e->type));
1469         if (!inv) {
1470                 ast_debug(5, "Transaction %p does not belong to an inv_session?\n", tsx);
1471                 ast_debug(5, "The transaction state is %s\n", pjsip_tsx_state_str(tsx->state));
1472                 return;
1473         }
1474         session = inv->mod_data[session_module.id];
1475         if (!session) {
1476                 ast_debug(5, "inv_session %p has no ast session\n", inv);
1477         } else {
1478                 ast_debug(5, "The state change pertains to the session with %s\n",
1479                                 ast_sorcery_object_get_id(session->endpoint));
1480         }
1481         if (inv->invite_tsx) {
1482                 ast_debug(5, "The inv session still has an invite_tsx (%p)\n", inv->invite_tsx);
1483         } else {
1484                 ast_debug(5, "The inv session does NOT have an invite_tsx\n");
1485         }
1486         if (tsx) {
1487                 ast_debug(5, "The transaction involved in this state change is %p\n", tsx);
1488                 ast_debug(5, "The current transaction state is %s\n", pjsip_tsx_state_str(tsx->state));
1489                 ast_debug(5, "The transaction state change event is %s\n", pjsip_event_str(e->body.tsx_state.type));
1490         } else {
1491                 ast_debug(5, "There is no transaction involved in this state change\n");
1492         }
1493         ast_debug(5, "The current inv state is %s\n", pjsip_inv_state_name(inv->state));
1494 }
1495
1496 #define print_debug_details(inv, tsx, e) __print_debug_details(__PRETTY_FUNCTION__, (inv), (tsx), (e))
1497
1498 static void handle_incoming_request(struct ast_sip_session *session, pjsip_rx_data *rdata)
1499 {
1500         struct ast_sip_session_supplement *supplement;
1501         struct pjsip_request_line req = rdata->msg_info.msg->line.req;
1502
1503         ast_debug(3, "Method is %.*s\n", (int) pj_strlen(&req.method.name), pj_strbuf(&req.method.name));
1504         AST_LIST_TRAVERSE(&session->supplements, supplement, next) {
1505                 if (supplement->incoming_request && does_method_match(&req.method.name, supplement->method)) {
1506                         if (supplement->incoming_request(session, rdata)) {
1507                                 break;
1508                         }
1509                 }
1510         }
1511 }
1512
1513 static void handle_incoming_response(struct ast_sip_session *session, pjsip_rx_data *rdata)
1514 {
1515         struct ast_sip_session_supplement *supplement;
1516         struct pjsip_status_line status = rdata->msg_info.msg->line.status;
1517
1518         ast_debug(3, "Response is %d %.*s\n", status.code, (int) pj_strlen(&status.reason),
1519                         pj_strbuf(&status.reason));
1520
1521         AST_LIST_TRAVERSE(&session->supplements, supplement, next) {
1522                 if (supplement->incoming_response && does_method_match(&rdata->msg_info.cseq->method.name, supplement->method)) {
1523                         supplement->incoming_response(session, rdata);
1524                 }
1525         }
1526 }
1527
1528 static int handle_incoming(struct ast_sip_session *session, pjsip_rx_data *rdata)
1529 {
1530         ast_debug(3, "Received %s\n", rdata->msg_info.msg->type == PJSIP_REQUEST_MSG ?
1531                         "request" : "response");
1532
1533         if (rdata->msg_info.msg->type == PJSIP_REQUEST_MSG) {
1534                 handle_incoming_request(session, rdata);
1535         } else {
1536                 handle_incoming_response(session, rdata);
1537         }
1538
1539         return 0;
1540 }
1541
1542 static void handle_outgoing_request(struct ast_sip_session *session, pjsip_tx_data *tdata)
1543 {
1544         struct ast_sip_session_supplement *supplement;
1545         struct pjsip_request_line req = tdata->msg->line.req;
1546
1547         ast_debug(3, "Method is %.*s\n", (int) pj_strlen(&req.method.name), pj_strbuf(&req.method.name));
1548         AST_LIST_TRAVERSE(&session->supplements, supplement, next) {
1549                 if (supplement->outgoing_request && does_method_match(&req.method.name, supplement->method)) {
1550                         supplement->outgoing_request(session, tdata);
1551                 }
1552         }
1553 }
1554
1555 static void handle_outgoing_response(struct ast_sip_session *session, pjsip_tx_data *tdata)
1556 {
1557         struct ast_sip_session_supplement *supplement;
1558         struct pjsip_status_line status = tdata->msg->line.status;
1559         pjsip_cseq_hdr *cseq = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_CSEQ, NULL);
1560         ast_debug(3, "Method is %.*s, Response is %d %.*s\n", (int) pj_strlen(&cseq->method.name),
1561                 pj_strbuf(&cseq->method.name), status.code, (int) pj_strlen(&status.reason),
1562                 pj_strbuf(&status.reason));
1563
1564         AST_LIST_TRAVERSE(&session->supplements, supplement, next) {
1565                 if (supplement->outgoing_response && does_method_match(&cseq->method.name, supplement->method)) {
1566                         supplement->outgoing_response(session, tdata);
1567                 }
1568         }
1569 }
1570
1571 static void handle_outgoing(struct ast_sip_session *session, pjsip_tx_data *tdata)
1572 {
1573         ast_debug(3, "Sending %s\n", tdata->msg->type == PJSIP_REQUEST_MSG ?
1574                         "request" : "response");
1575         if (tdata->msg->type == PJSIP_REQUEST_MSG) {
1576                 handle_outgoing_request(session, tdata);
1577         } else {
1578                 handle_outgoing_response(session, tdata);
1579         }
1580 }
1581
1582 static int session_end(struct ast_sip_session *session)
1583 {
1584         struct ast_sip_session_supplement *iter;
1585
1586         /* Stop the scheduled termination */
1587         if (pj_timer_heap_cancel(pjsip_endpt_get_timer_heap(ast_sip_get_pjsip_endpoint()), &session->scheduled_termination)) {
1588                 ao2_ref(session, -1);
1589         }
1590
1591         /* Session is dead. Let's get rid of the reference to the session */
1592         AST_LIST_TRAVERSE(&session->supplements, iter, next) {
1593                 if (iter->session_end) {
1594                         iter->session_end(session);
1595                 }
1596         }
1597
1598         session->inv_session->mod_data[session_module.id] = NULL;
1599         ast_sip_dialog_set_serializer(session->inv_session->dlg, NULL);
1600         ast_sip_dialog_set_endpoint(session->inv_session->dlg, NULL);
1601         ao2_cleanup(session);
1602         return 0;
1603 }
1604
1605 static void session_inv_on_state_changed(pjsip_inv_session *inv, pjsip_event *e)
1606 {
1607         struct ast_sip_session *session = inv->mod_data[session_module.id];
1608
1609         print_debug_details(inv, NULL, e);
1610
1611         switch(e->type) {
1612         case PJSIP_EVENT_TX_MSG:
1613                 handle_outgoing(session, e->body.tx_msg.tdata);
1614                 break;
1615         case PJSIP_EVENT_RX_MSG:
1616                 handle_incoming(session, e->body.rx_msg.rdata);
1617                 break;
1618         case PJSIP_EVENT_TSX_STATE:
1619                 ast_debug(3, "Source of transaction state change is %s\n", pjsip_event_str(e->body.tsx_state.type));
1620                 /* Transaction state changes are prompted by some other underlying event. */
1621                 switch(e->body.tsx_state.type) {
1622                 case PJSIP_EVENT_TX_MSG:
1623                         handle_outgoing(session, e->body.tsx_state.src.tdata);
1624                         break;
1625                 case PJSIP_EVENT_RX_MSG:
1626                         handle_incoming(session, e->body.tsx_state.src.rdata);
1627                         break;
1628                 case PJSIP_EVENT_TRANSPORT_ERROR:
1629                 case PJSIP_EVENT_TIMER:
1630                 case PJSIP_EVENT_USER:
1631                 case PJSIP_EVENT_UNKNOWN:
1632                 case PJSIP_EVENT_TSX_STATE:
1633                         /* Inception? */
1634                         break;
1635                 }
1636                 break;
1637         case PJSIP_EVENT_TRANSPORT_ERROR:
1638         case PJSIP_EVENT_TIMER:
1639         case PJSIP_EVENT_UNKNOWN:
1640         case PJSIP_EVENT_USER:
1641         default:
1642                 break;
1643         }
1644
1645         if (inv->state == PJSIP_INV_STATE_DISCONNECTED) {
1646                 session_end(session);
1647         }
1648 }
1649
1650 static void session_inv_on_new_session(pjsip_inv_session *inv, pjsip_event *e)
1651 {
1652         /* XXX STUB */
1653 }
1654
1655 static void session_inv_on_tsx_state_changed(pjsip_inv_session *inv, pjsip_transaction *tsx, pjsip_event *e)
1656 {
1657         struct ast_sip_session *session = inv->mod_data[session_module.id];
1658         print_debug_details(inv, tsx, e);
1659         if (!session) {
1660                 /* Transaction likely timed out after the call was hung up. Just
1661                  * ignore such transaction changes
1662                  */
1663                 return;
1664         }
1665         switch (e->body.tsx_state.type) {
1666         case PJSIP_EVENT_TX_MSG:
1667                 /* When we create an outgoing request, we do not have access to the transaction that
1668                  * is created. Instead, We have to place transaction-specific data in the tdata. Here,
1669                  * we transfer the data into the transaction. This way, when we receive a response, we
1670                  * can dig this data out again
1671                  */
1672                 tsx->mod_data[session_module.id] = e->body.tsx_state.src.tdata->mod_data[session_module.id];
1673                 break;
1674         case PJSIP_EVENT_RX_MSG:
1675                 if (tsx->method.id == PJSIP_INVITE_METHOD) {
1676                         if (tsx->role == PJSIP_ROLE_UAC && tsx->state == PJSIP_TSX_STATE_COMPLETED) {
1677                                 /* This means we got a non 2XX final response to our outgoing INVITE */
1678                                 if (tsx->status_code == PJSIP_SC_REQUEST_PENDING) {
1679                                         reschedule_reinvite(session, tsx->mod_data[session_module.id], tsx->last_tx);
1680                                         return;
1681                                 } else {
1682                                         /* Other failures result in destroying the session. */
1683                                         pjsip_tx_data *tdata;
1684                                         pjsip_inv_end_session(inv, 500, NULL, &tdata);
1685                                         ast_sip_session_send_request(session, tdata);
1686                                 }
1687                         }
1688                 } else {
1689                         if (tsx->role == PJSIP_ROLE_UAS && tsx->state == PJSIP_TSX_STATE_TRYING) {
1690                                 handle_incoming_request(session, e->body.tsx_state.src.rdata);
1691                         }
1692                 }
1693                 if (tsx->mod_data[session_module.id]) {
1694                         ast_sip_session_response_cb cb = tsx->mod_data[session_module.id];
1695                         cb(session, e->body.tsx_state.src.rdata);
1696                 }
1697         case PJSIP_EVENT_TRANSPORT_ERROR:
1698         case PJSIP_EVENT_TIMER:
1699         case PJSIP_EVENT_USER:
1700         case PJSIP_EVENT_UNKNOWN:
1701         case PJSIP_EVENT_TSX_STATE:
1702                 /* Inception? */
1703                 break;
1704         }
1705
1706         /* Terminated INVITE transactions always should result in queuing delayed requests,
1707          * no matter what event caused the transaction to terminate
1708          */
1709         if (tsx->method.id == PJSIP_INVITE_METHOD && tsx->state == PJSIP_TSX_STATE_TERMINATED) {
1710                 queue_delayed_request(session);
1711         }
1712 }
1713
1714 static int add_sdp_streams(void *obj, void *arg, void *data, int flags)
1715 {
1716         struct ast_sip_session_media *session_media = obj;
1717         pjmedia_sdp_session *answer = arg;
1718         struct ast_sip_session *session = data;
1719         struct ast_sip_session_sdp_handler *handler = session_media->handler;
1720         RAII_VAR(struct sdp_handler_list *, handler_list, NULL, ao2_cleanup);
1721
1722         if (handler) {
1723                 /* if an already assigned handler does not handle the session_media or reports a catastrophic error, fail */
1724                 if (handler->create_outgoing_sdp_stream(session, session_media, answer) <= 0) {
1725                         return 0;
1726                 }
1727                 return CMP_MATCH;
1728         }
1729
1730         handler_list = ao2_find(sdp_handlers, session_media->stream_type, OBJ_KEY);
1731         if (!handler_list) {
1732                 return CMP_MATCH;
1733         }
1734
1735         /* no handler for this stream type and we have a list to search */
1736         AST_LIST_TRAVERSE(&handler_list->list, handler, next) {
1737                 int res = handler->create_outgoing_sdp_stream(session, session_media, answer);
1738                 if (res < 0) {
1739                         /* catastrophic error */
1740                         return 0;
1741                 }
1742                 if (res > 0) {
1743                         /* handled */
1744                         return CMP_MATCH;
1745                 }
1746         }
1747
1748         /* streams that weren't handled won't be included in generated outbound SDP */
1749         return CMP_MATCH;
1750 }
1751
1752 static struct pjmedia_sdp_session *create_local_sdp(pjsip_inv_session *inv, struct ast_sip_session *session, const pjmedia_sdp_session *offer)
1753 {
1754         RAII_VAR(struct ao2_iterator *, successful, NULL, ao2_iterator_cleanup);
1755         static const pj_str_t STR_ASTERISK = { "Asterisk", 8 };
1756         static const pj_str_t STR_IN = { "IN", 2 };
1757         static const pj_str_t STR_IP4 = { "IP4", 3 };
1758         static const pj_str_t STR_IP6 = { "IP6", 3 };
1759         pjmedia_sdp_session *local;
1760
1761         if (!(local = PJ_POOL_ZALLOC_T(inv->pool_prov, pjmedia_sdp_session))) {
1762                 return NULL;
1763         }
1764
1765         if (!offer) {
1766                 local->origin.version = local->origin.id = (pj_uint32_t)(ast_random());
1767         } else {
1768                 local->origin.version = offer->origin.version + 1;
1769                 local->origin.id = offer->origin.id;
1770         }
1771
1772         local->origin.user = STR_ASTERISK;
1773         local->origin.net_type = STR_IN;
1774         local->origin.addr_type = session->endpoint->rtp_ipv6 ? STR_IP6 : STR_IP4;
1775         local->origin.addr = *pj_gethostname();
1776         local->name = local->origin.user;
1777
1778         /* Now let the handlers add streams of various types, pjmedia will automatically reorder the media streams for us */
1779         successful = ao2_callback_data(session->media, OBJ_MULTIPLE, add_sdp_streams, local, session);
1780         if (!successful || ao2_container_count(successful->c) != ao2_container_count(session->media)) {
1781                 /* Something experienced a catastrophic failure */
1782                 return NULL;
1783         }
1784
1785         /* Use the connection details of the first media stream if possible for SDP level */
1786         if (local->media_count) {
1787                 local->conn = local->media[0]->conn;
1788         }
1789
1790         return local;
1791 }
1792
1793 static void session_inv_on_rx_offer(pjsip_inv_session *inv, const pjmedia_sdp_session *offer)
1794 {
1795         struct ast_sip_session *session = inv->mod_data[session_module.id];
1796         pjmedia_sdp_session *answer;
1797
1798         if (handle_incoming_sdp(session, offer)) {
1799                 return;
1800         }
1801
1802         if ((answer = create_local_sdp(inv, session, offer))) {
1803                 pjsip_inv_set_sdp_answer(inv, answer);
1804         }
1805 }
1806
1807 #if 0
1808 static void session_inv_on_create_offer(pjsip_inv_session *inv, pjmedia_sdp_session **p_offer)
1809 {
1810         /* XXX STUB */
1811 }
1812 #endif
1813
1814 static void session_inv_on_media_update(pjsip_inv_session *inv, pj_status_t status)
1815 {
1816         struct ast_sip_session *session = inv->mod_data[session_module.id];
1817         const pjmedia_sdp_session *local, *remote;
1818
1819         if (!session->channel) {
1820                 /* If we don't have a channel. We really don't care about media updates.
1821                  * Just ignore
1822                  */
1823                 return;
1824         }
1825
1826         if ((status != PJ_SUCCESS) || (pjmedia_sdp_neg_get_active_local(inv->neg, &local) != PJ_SUCCESS) ||
1827                 (pjmedia_sdp_neg_get_active_remote(inv->neg, &remote) != PJ_SUCCESS)) {
1828                 ast_channel_hangupcause_set(session->channel, AST_CAUSE_BEARERCAPABILITY_NOTAVAIL);
1829                 ast_queue_hangup(session->channel);
1830                 return;
1831         }
1832
1833         handle_negotiated_sdp(session, local, remote);
1834 }
1835
1836 static pjsip_redirect_op session_inv_on_redirected(pjsip_inv_session *inv, const pjsip_uri *target, const pjsip_event *e)
1837 {
1838         struct ast_sip_session *session = inv->mod_data[session_module.id];
1839
1840         if (PJSIP_URI_SCHEME_IS_SIP(target) || PJSIP_URI_SCHEME_IS_SIPS(target)) {
1841                 const pjsip_sip_uri *uri = pjsip_uri_get_uri(target);
1842                 char exten[AST_MAX_EXTENSION];
1843
1844                 ast_copy_pj_str(exten, &uri->user, sizeof(exten));
1845                 ast_channel_call_forward_set(session->channel, exten);
1846         }
1847
1848         return PJSIP_REDIRECT_STOP;
1849 }
1850
1851 static pjsip_inv_callback inv_callback = {
1852         .on_state_changed = session_inv_on_state_changed,
1853         .on_new_session = session_inv_on_new_session,
1854         .on_tsx_state_changed = session_inv_on_tsx_state_changed,
1855         .on_rx_offer = session_inv_on_rx_offer,
1856         .on_media_update = session_inv_on_media_update,
1857         .on_redirected = session_inv_on_redirected,
1858 };
1859
1860 /*! \brief Hook for modifying outgoing messages with SDP to contain the proper address information */
1861 static void session_outgoing_nat_hook(pjsip_tx_data *tdata, struct ast_sip_transport *transport)
1862 {
1863         struct ast_sip_nat_hook *hook = tdata->mod_data[session_module.id];
1864         struct pjmedia_sdp_session *sdp;
1865         int stream;
1866
1867         /* SDP produced by us directly will never be multipart */
1868         if (hook || !tdata->msg->body || pj_stricmp2(&tdata->msg->body->content_type.type, "application") ||
1869                 pj_stricmp2(&tdata->msg->body->content_type.subtype, "sdp") || ast_strlen_zero(transport->external_media_address)) {
1870                 return;
1871         }
1872
1873         sdp = tdata->msg->body->data;
1874
1875         for (stream = 0; stream < sdp->media_count; ++stream) {
1876                 /* See if there are registered handlers for this media stream type */
1877                 char media[20];
1878                 struct ast_sip_session_sdp_handler *handler;
1879                 RAII_VAR(struct sdp_handler_list *, handler_list, NULL, ao2_cleanup);
1880
1881                 /* We need a null-terminated version of the media string */
1882                 ast_copy_pj_str(media, &sdp->media[stream]->desc.media, sizeof(media));
1883
1884                 handler_list = ao2_find(sdp_handlers, media, OBJ_KEY);
1885                 if (!handler_list) {
1886                         ast_debug(1, "No registered SDP handlers for media type '%s'\n", media);
1887                         continue;
1888                 }
1889                 AST_LIST_TRAVERSE(&handler_list->list, handler, next) {
1890                         if (handler->change_outgoing_sdp_stream_media_address) {
1891                                 handler->change_outgoing_sdp_stream_media_address(tdata, sdp->media[stream], transport);
1892                         }
1893                 }
1894         }
1895
1896         /* We purposely do this so that the hook will not be invoked multiple times, ie: if a retransmit occurs */
1897         tdata->mod_data[session_module.id] = nat_hook;
1898 }
1899
1900 static int load_module(void)
1901 {
1902         pjsip_endpoint *endpt;
1903         if (!ast_sip_get_sorcery() || !ast_sip_get_pjsip_endpoint()) {
1904                 return AST_MODULE_LOAD_DECLINE;
1905         }
1906         if (!(nat_hook = ast_sorcery_alloc(ast_sip_get_sorcery(), "nat_hook", NULL))) {
1907                 return AST_MODULE_LOAD_DECLINE;
1908         }
1909         nat_hook->outgoing_external_message = session_outgoing_nat_hook;
1910         ast_sorcery_create(ast_sip_get_sorcery(), nat_hook);
1911         sdp_handlers = ao2_container_alloc(SDP_HANDLER_BUCKETS,
1912                         sdp_handler_list_hash, sdp_handler_list_cmp);
1913         if (!sdp_handlers) {
1914                 return AST_MODULE_LOAD_DECLINE;
1915         }
1916         endpt = ast_sip_get_pjsip_endpoint();
1917         pjsip_inv_usage_init(endpt, &inv_callback);
1918         pjsip_100rel_init_module(endpt);
1919         pjsip_timer_init_module(endpt);
1920         if (ast_sip_register_service(&session_module)) {
1921                 return AST_MODULE_LOAD_DECLINE;
1922         }
1923         return AST_MODULE_LOAD_SUCCESS;
1924 }
1925
1926 static int unload_module(void)
1927 {
1928         ast_sip_unregister_service(&session_module);
1929         if (nat_hook) {
1930                 ast_sorcery_delete(ast_sip_get_sorcery(), nat_hook);
1931                 nat_hook = NULL;
1932         }
1933         return 0;
1934 }
1935
1936 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "SIP Session resource",
1937                 .load = load_module,
1938                 .unload = unload_module,
1939                 .load_pri = AST_MODPRI_APP_DEPEND,
1940                );