Remove some callbacks and functions which are not needed.
[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 /*!
594  * \brief Structure used for sending delayed requests
595  *
596  * Requests are typically delayed because the current transaction
597  * state of an INVITE. Once the pending INVITE transaction terminates,
598  * the delayed request will be sent
599  */
600 struct ast_sip_session_delayed_request {
601         /*! Method of the request */
602         char method[15];
603         /*! Callback to call when the delayed request is created. */
604         ast_sip_session_request_creation_cb on_request_creation;
605         /*! Callback to call when the delayed request receives a response */
606         ast_sip_session_response_cb on_response;
607         /*! Request to send */
608         pjsip_tx_data *tdata;
609         AST_LIST_ENTRY(ast_sip_session_delayed_request) next;
610 };
611
612 static struct ast_sip_session_delayed_request *delayed_request_alloc(const char *method,
613                 ast_sip_session_request_creation_cb on_request_creation,
614                 ast_sip_session_response_cb on_response,
615                 pjsip_tx_data *tdata)
616 {
617         struct ast_sip_session_delayed_request *delay = ast_calloc(1, sizeof(*delay));
618         if (!delay) {
619                 return NULL;
620         }
621         ast_copy_string(delay->method, method, sizeof(delay->method));
622         delay->on_request_creation = on_request_creation;
623         delay->on_response = on_response;
624         delay->tdata = tdata;
625         return delay;
626 }
627
628 static int send_delayed_request(struct ast_sip_session *session, struct ast_sip_session_delayed_request *delay)
629 {
630         ast_debug(3, "Sending delayed %s request to %s\n", delay->method, ast_sorcery_object_get_id(session->endpoint));
631
632         if (delay->tdata) {
633                 ast_sip_session_send_request_with_cb(session, delay->tdata, delay->on_response);
634                 return 0;
635         }
636
637         if (!strcmp(delay->method, "INVITE")) {
638                 ast_sip_session_refresh(session, delay->on_request_creation,
639                                 delay->on_response, AST_SIP_SESSION_REFRESH_METHOD_INVITE, 1);
640         } else if (!strcmp(delay->method, "UPDATE")) {
641                 ast_sip_session_refresh(session, delay->on_request_creation,
642                                 delay->on_response, AST_SIP_SESSION_REFRESH_METHOD_UPDATE, 1);
643         } else {
644                 ast_log(LOG_WARNING, "Unexpected delayed %s request with no existing request structure\n", delay->method);
645                 return -1;
646         }
647         return 0;
648 }
649
650 static int queued_delayed_request_send(void *data)
651 {
652         RAII_VAR(struct ast_sip_session *, session, data, ao2_cleanup);
653         RAII_VAR(struct ast_sip_session_delayed_request *, delay, NULL, ast_free_ptr);
654
655         delay = AST_LIST_REMOVE_HEAD(&session->delayed_requests, next);
656         if (!delay) {
657                 return 0;
658         }
659
660         return send_delayed_request(session, delay);
661 }
662
663 static void queue_delayed_request(struct ast_sip_session *session)
664 {
665         if (AST_LIST_EMPTY(&session->delayed_requests)) {
666                 /* No delayed request to send, so just return */
667                 return;
668         }
669
670         ast_debug(3, "Queuing delayed request to run for %s\n",
671                         ast_sorcery_object_get_id(session->endpoint));
672
673         ao2_ref(session, +1);
674         ast_sip_push_task(session->serializer, queued_delayed_request_send, session);
675 }
676
677 static int delay_request(struct ast_sip_session *session, ast_sip_session_request_creation_cb on_request,
678                 ast_sip_session_response_cb on_response, const char *method, pjsip_tx_data *tdata)
679 {
680         struct ast_sip_session_delayed_request *delay = delayed_request_alloc(method,
681                         on_request, on_response, tdata);
682
683         if (!delay) {
684                 return -1;
685         }
686
687         AST_LIST_INSERT_TAIL(&session->delayed_requests, delay, next);
688         return 0;
689 }
690
691 static pjmedia_sdp_session *generate_session_refresh_sdp(struct ast_sip_session *session)
692 {
693         pjsip_inv_session *inv_session = session->inv_session;
694         const pjmedia_sdp_session *previous_sdp;
695
696         if (pjmedia_sdp_neg_was_answer_remote(inv_session->neg)) {
697                 pjmedia_sdp_neg_get_active_remote(inv_session->neg, &previous_sdp);
698         } else {
699                 pjmedia_sdp_neg_get_active_local(inv_session->neg, &previous_sdp);
700         }
701         return create_local_sdp(inv_session, session, previous_sdp);
702 }
703
704 int ast_sip_session_refresh(struct ast_sip_session *session,
705                 ast_sip_session_request_creation_cb on_request_creation, ast_sip_session_response_cb on_response,
706                 enum ast_sip_session_refresh_method method, int generate_new_sdp)
707 {
708         pjsip_inv_session *inv_session = session->inv_session;
709         pjmedia_sdp_session *new_sdp = NULL;
710         pjsip_tx_data *tdata;
711
712         if (inv_session->state == PJSIP_INV_STATE_DISCONNECTED) {
713                 /* Don't try to do anything with a hung-up call */
714                 ast_debug(3, "Not sending reinvite to %s because of disconnected state...\n",
715                                 ast_sorcery_object_get_id(session->endpoint));
716                 return 0;
717         }
718
719         if ((method == AST_SIP_SESSION_REFRESH_METHOD_INVITE) && inv_session->invite_tsx) {
720                 /* We can't send a reinvite yet, so delay it */
721                 ast_debug(3, "Delaying sending reinvite to %s because of outstanding transaction...\n",
722                                 ast_sorcery_object_get_id(session->endpoint));
723                 return delay_request(session, on_request_creation, on_response, "INVITE", NULL);
724         }
725
726         if (generate_new_sdp) {
727                 new_sdp = generate_session_refresh_sdp(session);
728                 if (!new_sdp) {
729                         ast_log(LOG_ERROR, "Failed to generate session refresh SDP. Not sending session refresh\n");
730                         return -1;
731                 }
732         }
733
734         if (method == AST_SIP_SESSION_REFRESH_METHOD_INVITE) {
735                 if (pjsip_inv_reinvite(inv_session, NULL, new_sdp, &tdata)) {
736                         ast_log(LOG_WARNING, "Failed to create reinvite properly.\n");
737                         return -1;
738                 }
739         } else if (pjsip_inv_update(inv_session, NULL, new_sdp, &tdata)) {
740                 ast_log(LOG_WARNING, "Failed to create UPDATE properly.\n");
741                 return -1;
742         }
743         if (on_request_creation) {
744                 if (on_request_creation(session, tdata)) {
745                         return -1;
746                 }
747         }
748         ast_sip_session_send_request_with_cb(session, tdata, on_response);
749         return 0;
750 }
751
752 void ast_sip_session_send_response(struct ast_sip_session *session, pjsip_tx_data *tdata)
753 {
754         handle_outgoing_response(session, tdata);
755         pjsip_inv_send_msg(session->inv_session, tdata);
756         return;
757 }
758
759 static pj_bool_t session_on_rx_request(pjsip_rx_data *rdata);
760
761 static pjsip_module session_module = {
762         .name = {"Session Module", 14},
763         .priority = PJSIP_MOD_PRIORITY_APPLICATION,
764         .on_rx_request = session_on_rx_request,
765 };
766
767 void ast_sip_session_send_request_with_cb(struct ast_sip_session *session, pjsip_tx_data *tdata,
768                 ast_sip_session_response_cb on_response)
769 {
770         pjsip_inv_session *inv_session = session->inv_session;
771
772         if (inv_session->state == PJSIP_INV_STATE_DISCONNECTED) {
773                 /* Don't try to do anything with a hung-up call */
774                 return;
775         }
776
777         tdata->mod_data[session_module.id] = on_response;
778         handle_outgoing_request(session, tdata);
779         pjsip_inv_send_msg(session->inv_session, tdata);
780         return;
781 }
782
783 void ast_sip_session_send_request(struct ast_sip_session *session, pjsip_tx_data *tdata)
784 {
785         ast_sip_session_send_request_with_cb(session, tdata, NULL);
786 }
787
788 int ast_sip_session_create_invite(struct ast_sip_session *session, pjsip_tx_data **tdata)
789 {
790         pjmedia_sdp_session *offer;
791
792         if (!(offer = create_local_sdp(session->inv_session, session, NULL))) {
793                 pjsip_inv_terminate(session->inv_session, 500, PJ_FALSE);
794                 return -1;
795         }
796
797         pjsip_inv_set_local_sdp(session->inv_session, offer);
798         pjmedia_sdp_neg_set_prefer_remote_codec_order(session->inv_session->neg, PJ_FALSE);
799         if (pjsip_inv_invite(session->inv_session, tdata) != PJ_SUCCESS) {
800                 return -1;
801         }
802         return 0;
803 }
804
805 static int datastore_hash(const void *obj, int flags)
806 {
807         const struct ast_datastore *datastore = obj;
808         const char *uid = flags & OBJ_KEY ? obj : datastore->uid;
809
810         ast_assert(uid != NULL);
811
812         return ast_str_hash(uid);
813 }
814
815 static int datastore_cmp(void *obj, void *arg, int flags)
816 {
817         const struct ast_datastore *datastore1 = obj;
818         const struct ast_datastore *datastore2 = arg;
819         const char *uid2 = flags & OBJ_KEY ? arg : datastore2->uid;
820
821         ast_assert(datastore1->uid != NULL);
822         ast_assert(uid2 != NULL);
823
824         return strcmp(datastore1->uid, uid2) ? 0 : CMP_MATCH | CMP_STOP;
825 }
826
827 static void session_media_dtor(void *obj)
828 {
829         struct ast_sip_session_media *session_media = obj;
830         if (session_media->handler) {
831                 session_media->handler->stream_destroy(session_media);
832         }
833         if (session_media->srtp) {
834                 ast_sdp_srtp_destroy(session_media->srtp);
835         }
836 }
837
838 static void session_destructor(void *obj)
839 {
840         struct ast_sip_session *session = obj;
841         struct ast_sip_session_supplement *supplement;
842         struct ast_sip_session_delayed_request *delay;
843
844         ast_debug(3, "Destroying SIP session with endpoint %s\n",
845                         ast_sorcery_object_get_id(session->endpoint));
846
847         while ((supplement = AST_LIST_REMOVE_HEAD(&session->supplements, next))) {
848                 if (supplement->session_destroy) {
849                         supplement->session_destroy(session);
850                 }
851                 ast_free(supplement);
852         }
853
854         ast_taskprocessor_unreference(session->serializer);
855         ao2_cleanup(session->datastores);
856         ao2_cleanup(session->media);
857         AST_LIST_HEAD_DESTROY(&session->supplements);
858         while ((delay = AST_LIST_REMOVE_HEAD(&session->delayed_requests, next))) {
859                 ast_free(delay);
860         }
861         ast_party_id_free(&session->id);
862         ao2_cleanup(session->endpoint);
863         ast_format_cap_destroy(session->req_caps);
864
865         if (session->dsp) {
866                 ast_dsp_free(session->dsp);
867         }
868
869         if (session->inv_session) {
870                 pjsip_dlg_dec_session(session->inv_session->dlg, &session_module);
871         }
872 }
873
874 static int add_supplements(struct ast_sip_session *session)
875 {
876         struct ast_sip_session_supplement *iter;
877         SCOPED_LOCK(lock, &session_supplements, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK);
878
879         AST_RWLIST_TRAVERSE(&session_supplements, iter, next) {
880                 struct ast_sip_session_supplement *copy = supplement_dup(iter);
881                 if (!copy) {
882                         return -1;
883                 }
884                 AST_LIST_INSERT_TAIL(&session->supplements, copy, next);
885         }
886         return 0;
887 }
888
889 static int add_session_media(void *obj, void *arg, int flags)
890 {
891         struct sdp_handler_list *handler_list = obj;
892         struct ast_sip_session * session = arg;
893         RAII_VAR(struct ast_sip_session_media *, session_media, NULL, ao2_cleanup);
894         session_media = ao2_alloc(sizeof(*session_media) + strlen(handler_list->stream_type), session_media_dtor);
895         if (!session_media) {
896                 return CMP_STOP;
897         }
898         /* Safe use of strcpy */
899         strcpy(session_media->stream_type, handler_list->stream_type);
900         ao2_link(session->media, session_media);
901         return 0;
902 }
903
904 struct ast_sip_session *ast_sip_session_alloc(struct ast_sip_endpoint *endpoint, pjsip_inv_session *inv_session)
905 {
906         RAII_VAR(struct ast_sip_session *, session, ao2_alloc(sizeof(*session), session_destructor), ao2_cleanup);
907         struct ast_sip_session_supplement *iter;
908         if (!session) {
909                 return NULL;
910         }
911         AST_LIST_HEAD_INIT(&session->supplements);
912         session->datastores = ao2_container_alloc(DATASTORE_BUCKETS, datastore_hash, datastore_cmp);
913         if (!session->datastores) {
914                 return NULL;
915         }
916
917         session->media = ao2_container_alloc(MEDIA_BUCKETS, session_media_hash, session_media_cmp);
918         if (!session->media) {
919                 return NULL;
920         }
921         /* fill session->media with available types */
922         ao2_callback(sdp_handlers, OBJ_NODATA, add_session_media, session);
923
924         session->serializer = ast_sip_create_serializer();
925         if (!session->serializer) {
926                 return NULL;
927         }
928         ast_sip_dialog_set_serializer(inv_session->dlg, session->serializer);
929         ast_sip_dialog_set_endpoint(inv_session->dlg, endpoint);
930         pjsip_dlg_inc_session(inv_session->dlg, &session_module);
931         ao2_ref(endpoint, +1);
932         inv_session->mod_data[session_module.id] = session;
933         session->endpoint = endpoint;
934         session->inv_session = inv_session;
935         session->req_caps = ast_format_cap_alloc_nolock();
936
937         if (endpoint->dtmf == AST_SIP_DTMF_INBAND) {
938                 if (!(session->dsp = ast_dsp_new())) {
939                         return NULL;
940                 }
941
942                 ast_dsp_set_features(session->dsp, DSP_FEATURE_DIGIT_DETECT);
943         }
944
945         if (add_supplements(session)) {
946                 return NULL;
947         }
948         AST_LIST_TRAVERSE(&session->supplements, iter, next) {
949                 if (iter->session_begin) {
950                         iter->session_begin(session);
951                 }
952         }
953         session->direct_media_cap = ast_format_cap_alloc_nolock();
954         AST_LIST_HEAD_INIT_NOLOCK(&session->delayed_requests);
955         ast_party_id_init(&session->id);
956         ao2_ref(session, +1);
957         return session;
958 }
959
960 static int session_outbound_auth(pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data)
961 {
962         pjsip_inv_session *inv = pjsip_dlg_get_inv_session(dlg);
963         struct ast_sip_session *session = inv->mod_data[session_module.id];
964
965         if (inv->state < PJSIP_INV_STATE_CONFIRMED && tdata->msg->line.req.method.id == PJSIP_INVITE_METHOD) {
966                 pjsip_inv_uac_restart(inv, PJ_TRUE);
967         }
968         ast_sip_session_send_request(session, tdata);
969         return 0;
970 }
971
972 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)
973 {
974         const char *uri = NULL;
975         RAII_VAR(struct ast_sip_contact *, contact, NULL, ao2_cleanup);
976         pjsip_timer_setting timer;
977         pjsip_dialog *dlg;
978         struct pjsip_inv_session *inv_session;
979         RAII_VAR(struct ast_sip_session *, session, NULL, ao2_cleanup);
980
981         /* If no location has been provided use the AOR list from the endpoint itself */
982         location = S_OR(location, endpoint->aors);
983
984         contact = ast_sip_location_retrieve_contact_from_aor_list(location);
985         if (!contact || ast_strlen_zero(contact->uri)) {
986                 uri = location;
987         } else {
988                 uri = contact->uri;
989         }
990
991         /* If we still have no URI to dial fail to create the session */
992         if (ast_strlen_zero(uri)) {
993                 return NULL;
994         }
995
996         if (!(dlg = ast_sip_create_dialog(endpoint, uri, request_user))) {
997                 return NULL;
998         }
999
1000         if (ast_sip_dialog_setup_outbound_authentication(dlg, endpoint, session_outbound_auth, NULL)) {
1001                 pjsip_dlg_terminate(dlg);
1002                 return NULL;
1003         }
1004
1005         if (pjsip_inv_create_uac(dlg, NULL, endpoint->extensions, &inv_session) != PJ_SUCCESS) {
1006                 pjsip_dlg_terminate(dlg);
1007                 return NULL;
1008         }
1009
1010         pjsip_timer_setting_default(&timer);
1011         timer.min_se = endpoint->min_se;
1012         timer.sess_expires = endpoint->sess_expires;
1013         pjsip_timer_init_session(inv_session, &timer);
1014
1015         if (!(session = ast_sip_session_alloc(endpoint, inv_session))) {
1016                 pjsip_inv_terminate(inv_session, 500, PJ_FALSE);
1017                 return NULL;
1018         }
1019
1020         ast_format_cap_copy(session->req_caps, req_caps);
1021         if ((pjsip_dlg_add_usage(dlg, &session_module, NULL) != PJ_SUCCESS)) {
1022                 pjsip_inv_terminate(inv_session, 500, PJ_FALSE);
1023                 return NULL;
1024         }
1025
1026         ao2_ref(session, +1);
1027         return session;
1028 }
1029
1030 static int session_termination_task(void *data)
1031 {
1032         RAII_VAR(struct ast_sip_session *, session, data, ao2_cleanup);
1033         pjsip_tx_data *packet = NULL;
1034
1035         if (!session->inv_session) {
1036                 return 0;
1037         }
1038
1039         if (pjsip_inv_end_session(session->inv_session, 603, NULL, &packet) == PJ_SUCCESS) {
1040                 ast_sip_session_send_request(session, packet);
1041         }
1042
1043         return 0;
1044 }
1045
1046 static void session_termination_cb(pj_timer_heap_t *timer_heap, struct pj_timer_entry *entry)
1047 {
1048         struct ast_sip_session *session = entry->user_data;
1049
1050         if (ast_sip_push_task(session->serializer, session_termination_task, session)) {
1051                 ao2_cleanup(session);
1052         }
1053 }
1054
1055 void ast_sip_session_defer_termination(struct ast_sip_session *session)
1056 {
1057         pj_time_val delay = { .sec = 60, };
1058
1059         session->defer_terminate = 1;
1060
1061         session->scheduled_termination.id = 0;
1062         ao2_ref(session, +1);
1063         session->scheduled_termination.user_data = session;
1064         session->scheduled_termination.cb = session_termination_cb;
1065
1066         if (pjsip_endpt_schedule_timer(ast_sip_get_pjsip_endpoint(), &session->scheduled_termination, &delay) != PJ_SUCCESS) {
1067                 ao2_ref(session, -1);
1068         }
1069 }
1070
1071 struct ast_sip_session *ast_sip_dialog_get_session(pjsip_dialog *dlg)
1072 {
1073         pjsip_inv_session *inv_session = pjsip_dlg_get_inv_session(dlg);
1074         struct ast_sip_session *session;
1075
1076         if (!inv_session ||
1077                 !(session = inv_session->mod_data[session_module.id])) {
1078                 return NULL;
1079         }
1080
1081         ao2_ref(session, +1);
1082
1083         return session;
1084 }
1085
1086 enum sip_get_destination_result {
1087         /*! The extension was successfully found */
1088         SIP_GET_DEST_EXTEN_FOUND,
1089         /*! The extension specified in the RURI was not found */
1090         SIP_GET_DEST_EXTEN_NOT_FOUND,
1091         /*! The extension specified in the RURI was a partial match */
1092         SIP_GET_DEST_EXTEN_PARTIAL,
1093         /*! The RURI is of an unsupported scheme */
1094         SIP_GET_DEST_UNSUPPORTED_URI,
1095 };
1096
1097 /*!
1098  * \brief Determine where in the dialplan a call should go
1099  *
1100  * This uses the username in the request URI to try to match
1101  * an extension in the endpoint's configured context in order
1102  * to route the call.
1103  *
1104  * \param session The inbound SIP session
1105  * \param rdata The SIP INVITE
1106  */
1107 static enum sip_get_destination_result get_destination(struct ast_sip_session *session, pjsip_rx_data *rdata)
1108 {
1109         pjsip_uri *ruri = rdata->msg_info.msg->line.req.uri;
1110         pjsip_sip_uri *sip_ruri;
1111         if (!PJSIP_URI_SCHEME_IS_SIP(ruri) && !PJSIP_URI_SCHEME_IS_SIPS(ruri)) {
1112                 return SIP_GET_DEST_UNSUPPORTED_URI;
1113         }
1114         sip_ruri = pjsip_uri_get_uri(ruri);
1115         ast_copy_pj_str(session->exten, &sip_ruri->user, sizeof(session->exten));
1116         if (ast_exists_extension(NULL, session->endpoint->context, session->exten, 1, NULL)) {
1117                 return SIP_GET_DEST_EXTEN_FOUND;
1118         }
1119         /* XXX In reality, we'll likely have further options so that partial matches
1120          * can be indicated here, but for getting something up and running, we're going
1121          * to return a "not exists" error here.
1122          */
1123         return SIP_GET_DEST_EXTEN_NOT_FOUND;
1124 }
1125
1126 static pjsip_inv_session *pre_session_setup(pjsip_rx_data *rdata, const struct ast_sip_endpoint *endpoint)
1127 {
1128         pjsip_tx_data *tdata;
1129         pjsip_dialog *dlg;
1130         pjsip_inv_session *inv_session;
1131         unsigned int options = endpoint->extensions;
1132
1133         if (pjsip_inv_verify_request(rdata, &options, NULL, NULL, ast_sip_get_pjsip_endpoint(), &tdata) != PJ_SUCCESS) {
1134                 if (tdata) {
1135                         pjsip_endpt_send_response2(ast_sip_get_pjsip_endpoint(), rdata, tdata, NULL, NULL);
1136                 } else {
1137                         pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 500, NULL, NULL, NULL);
1138                 }
1139                 return NULL;
1140         }
1141         if (pjsip_dlg_create_uas(pjsip_ua_instance(), rdata, NULL, &dlg) != PJ_SUCCESS) {
1142                 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 500, NULL, NULL, NULL);
1143                 return NULL;
1144         }
1145         if (pjsip_inv_create_uas(dlg, rdata, NULL, 0, &inv_session) != PJ_SUCCESS) {
1146                 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 500, NULL, NULL, NULL);
1147                 pjsip_dlg_terminate(dlg);
1148                 return NULL;
1149         }
1150         if (pjsip_dlg_add_usage(dlg, &session_module, NULL) != PJ_SUCCESS) {
1151                 if (pjsip_inv_initial_answer(inv_session, rdata, 500, NULL, NULL, &tdata) != PJ_SUCCESS) {
1152                         pjsip_inv_terminate(inv_session, 500, PJ_FALSE);
1153                 }
1154                 pjsip_inv_send_msg(inv_session, tdata);
1155                 return NULL;
1156         }
1157         return inv_session;
1158 }
1159
1160 static void handle_new_invite_request(pjsip_rx_data *rdata)
1161 {
1162         RAII_VAR(struct ast_sip_endpoint *, endpoint,
1163                         ast_pjsip_rdata_get_endpoint(rdata), ao2_cleanup);
1164         pjsip_tx_data *tdata = NULL;
1165         pjsip_inv_session *inv_session = NULL;
1166         struct ast_sip_session *session = NULL;
1167         pjsip_timer_setting timer;
1168         pjsip_rdata_sdp_info *sdp_info;
1169         pjmedia_sdp_session *local = NULL;
1170
1171         ast_assert(endpoint != NULL);
1172
1173         inv_session = pre_session_setup(rdata, endpoint);
1174         if (!inv_session) {
1175                 /* pre_session_setup() returns a response on failure */
1176                 return;
1177         }
1178
1179         session = ast_sip_session_alloc(endpoint, inv_session);
1180         if (!session) {
1181                 if (pjsip_inv_initial_answer(inv_session, rdata, 500, NULL, NULL, &tdata) == PJ_SUCCESS) {
1182                         pjsip_inv_terminate(inv_session, 500, PJ_FALSE);
1183                 } else {
1184                         pjsip_inv_send_msg(inv_session, tdata);
1185                 }
1186                 return;
1187         }
1188
1189         /* From this point on, any calls to pjsip_inv_terminate have the last argument as PJ_TRUE
1190          * so that we will be notified so we can destroy the session properly
1191          */
1192
1193         switch (get_destination(session, rdata)) {
1194         case SIP_GET_DEST_EXTEN_FOUND:
1195                 /* Things worked. Keep going */
1196                 break;
1197         case SIP_GET_DEST_UNSUPPORTED_URI:
1198                 if (pjsip_inv_initial_answer(inv_session, rdata, 416, NULL, NULL, &tdata) == PJ_SUCCESS) {
1199                         ast_sip_session_send_response(session, tdata);
1200                 } else  {
1201                         pjsip_inv_terminate(inv_session, 416, PJ_TRUE);
1202                 }
1203                 return;
1204         case SIP_GET_DEST_EXTEN_NOT_FOUND:
1205         case SIP_GET_DEST_EXTEN_PARTIAL:
1206         default:
1207                 ast_log(LOG_NOTICE, "Call from '%s' (%s:%s:%d) to extension '%s' rejected because extension not found in context '%s'.\n",
1208                         ast_sorcery_object_get_id(session->endpoint), rdata->tp_info.transport->type_name, rdata->pkt_info.src_name,
1209                         rdata->pkt_info.src_port, session->exten, session->endpoint->context);
1210
1211                 if (pjsip_inv_initial_answer(inv_session, rdata, 404, NULL, NULL, &tdata) == PJ_SUCCESS) {
1212                         ast_sip_session_send_response(session, tdata);
1213                 } else  {
1214                         pjsip_inv_terminate(inv_session, 404, PJ_TRUE);
1215                 }
1216                 return;
1217         };
1218
1219         if ((sdp_info = pjsip_rdata_get_sdp_info(rdata)) && (sdp_info->sdp_err == PJ_SUCCESS) && sdp_info->sdp) {
1220                 if (handle_incoming_sdp(session, sdp_info->sdp)) {
1221                         if (pjsip_inv_initial_answer(inv_session, rdata, 488, NULL, NULL, &tdata) == PJ_SUCCESS) {
1222                                 ast_sip_session_send_response(session, tdata);
1223                         } else  {
1224                                 pjsip_inv_terminate(inv_session, 488, PJ_TRUE);
1225                         }
1226                         return;
1227                 }
1228                 /* We are creating a local SDP which is an answer to their offer */
1229                 local = create_local_sdp(inv_session, session, sdp_info->sdp);
1230         } else {
1231                 /* We are creating a local SDP which is an offer */
1232                 local = create_local_sdp(inv_session, session, NULL);
1233         }
1234
1235         /* If we were unable to create a local SDP terminate the session early, it won't go anywhere */
1236         if (!local) {
1237                 if (pjsip_inv_initial_answer(inv_session, rdata, 500, NULL, NULL, &tdata) == PJ_SUCCESS) {
1238                         ast_sip_session_send_response(session, tdata);
1239                 } else  {
1240                         pjsip_inv_terminate(inv_session, 500, PJ_TRUE);
1241                 }
1242                 return;
1243         } else {
1244                 pjsip_inv_set_local_sdp(inv_session, local);
1245                 pjmedia_sdp_neg_set_prefer_remote_codec_order(inv_session->neg, PJ_FALSE);
1246         }
1247
1248         pjsip_timer_setting_default(&timer);
1249         timer.min_se = endpoint->min_se;
1250         timer.sess_expires = endpoint->sess_expires;
1251         pjsip_timer_init_session(inv_session, &timer);
1252
1253         /* At this point, we've verified what we can, so let's go ahead and send a 100 Trying out */
1254         if (pjsip_inv_initial_answer(inv_session, rdata, 100, NULL, NULL, &tdata) != PJ_SUCCESS) {
1255                 pjsip_inv_terminate(inv_session, 500, PJ_TRUE);
1256                 return;
1257         }
1258         ast_sip_session_send_response(session, tdata);
1259
1260         handle_incoming_request(session, rdata);
1261 }
1262
1263 static pj_bool_t does_method_match(const pj_str_t *message_method, const char *supplement_method)
1264 {
1265         pj_str_t method;
1266
1267         if (ast_strlen_zero(supplement_method)) {
1268                 return PJ_TRUE;
1269         }
1270
1271         pj_cstr(&method, supplement_method);
1272
1273         return pj_stristr(&method, message_method) ? PJ_TRUE : PJ_FALSE;
1274 }
1275
1276 static pj_bool_t has_supplement(const struct ast_sip_session *session, const pjsip_rx_data *rdata)
1277 {
1278         struct ast_sip_session_supplement *supplement;
1279         struct pjsip_method *method = &rdata->msg_info.msg->line.req.method;
1280
1281         if (!session) {
1282                 return PJ_FALSE;
1283         }
1284
1285         AST_LIST_TRAVERSE(&session->supplements, supplement, next) {
1286                 if (does_method_match(&method->name, supplement->method)) {
1287                         return PJ_TRUE;
1288                 }
1289         }
1290         return PJ_FALSE;
1291 }
1292 /*!
1293  * \brief Called when a new SIP request comes into PJSIP
1294  *
1295  * This function is called under two circumstances
1296  * 1) An out-of-dialog request is received by PJSIP
1297  * 2) An in-dialog request that the inv_session layer does not
1298  *    handle is received (such as an in-dialog INFO)
1299  *
1300  * In all cases, there is very little we actually do in this function
1301  * 1) For requests we don't handle, we return PJ_FALSE
1302  * 2) For new INVITEs, throw the work into the SIP threadpool to be done
1303  *    there to free up the thread(s) handling incoming requests
1304  * 3) For in-dialog requests we handle, we defer handling them until the
1305  *    on_inv_state_change() callback instead (where we will end up putting
1306  *    them into the threadpool).
1307  */
1308 static pj_bool_t session_on_rx_request(pjsip_rx_data *rdata)
1309 {
1310         pj_status_t handled = PJ_FALSE;
1311         pjsip_dialog *dlg = pjsip_rdata_get_dlg(rdata);
1312         pjsip_inv_session *inv_session;
1313
1314         switch (rdata->msg_info.msg->line.req.method.id) {
1315         case PJSIP_INVITE_METHOD:
1316                 if (dlg) {
1317                         ast_log(LOG_WARNING, "on_rx_request called for INVITE in mid-dialog?\n");
1318                         break;
1319                 }
1320                 handled = PJ_TRUE;
1321                 handle_new_invite_request(rdata);
1322                 break;
1323         default:
1324                 /* Handle other in-dialog methods if their supplements have been registered */
1325                 handled = dlg && (inv_session = pjsip_dlg_get_inv_session(dlg)) &&
1326                         has_supplement(inv_session->mod_data[session_module.id], rdata);
1327                 break;
1328         }
1329
1330         return handled;
1331 }
1332
1333 struct reschedule_reinvite_data {
1334         struct ast_sip_session *session;
1335         struct ast_sip_session_delayed_request *delay;
1336 };
1337
1338 static struct reschedule_reinvite_data *reschedule_reinvite_data_alloc(
1339                 struct ast_sip_session *session, struct ast_sip_session_delayed_request *delay)
1340 {
1341         struct reschedule_reinvite_data *rrd = ast_malloc(sizeof(*rrd));
1342         if (!rrd) {
1343                 return NULL;
1344         }
1345         ao2_ref(session, +1);
1346         rrd->session = session;
1347         rrd->delay = delay;
1348         return rrd;
1349 }
1350
1351 static void reschedule_reinvite_data_destroy(struct reschedule_reinvite_data *rrd)
1352 {
1353         ao2_cleanup(rrd->session);
1354         ast_free(rrd->delay);
1355         ast_free(rrd);
1356 }
1357
1358 static int really_resend_reinvite(void *data)
1359 {
1360         RAII_VAR(struct reschedule_reinvite_data *, rrd, data, reschedule_reinvite_data_destroy);
1361
1362         return send_delayed_request(rrd->session, rrd->delay);
1363 }
1364
1365 static void resend_reinvite(pj_timer_heap_t *timer, pj_timer_entry *entry)
1366 {
1367         struct reschedule_reinvite_data *rrd = entry->user_data;
1368
1369         ast_sip_push_task(rrd->session->serializer, really_resend_reinvite, entry->user_data);
1370 }
1371
1372 static void reschedule_reinvite(struct ast_sip_session *session, ast_sip_session_response_cb on_response, pjsip_tx_data *tdata)
1373 {
1374         struct ast_sip_session_delayed_request *delay = delayed_request_alloc("INVITE",
1375                         NULL, on_response, tdata);
1376         pjsip_inv_session *inv = session->inv_session;
1377         struct reschedule_reinvite_data *rrd = reschedule_reinvite_data_alloc(session, delay);
1378         pj_time_val tv;
1379         
1380         if (!rrd || !delay) {
1381                 return;
1382         }
1383
1384         tv.sec = 0;
1385         if (inv->role == PJSIP_ROLE_UAC) {
1386                 tv.msec = 2100 + ast_random() % 2000;
1387         } else {
1388                 tv.msec = ast_random() % 2000;
1389         }
1390
1391         pj_timer_entry_init(&session->rescheduled_reinvite, 0, rrd, resend_reinvite);
1392
1393         pjsip_endpt_schedule_timer(ast_sip_get_pjsip_endpoint(), &session->rescheduled_reinvite, &tv);
1394 }
1395
1396 static void __print_debug_details(const char *function, pjsip_inv_session *inv, pjsip_transaction *tsx, pjsip_event *e)
1397 {
1398         struct ast_sip_session *session;
1399         ast_debug(5, "Function %s called on event %s\n", function, pjsip_event_str(e->type));
1400         if (!inv) {
1401                 ast_debug(5, "Transaction %p does not belong to an inv_session?\n", tsx);
1402                 ast_debug(5, "The transaction state is %s\n", pjsip_tsx_state_str(tsx->state));
1403                 return;
1404         }
1405         session = inv->mod_data[session_module.id];
1406         if (!session) {
1407                 ast_debug(5, "inv_session %p has no ast session\n", inv);
1408         } else {
1409                 ast_debug(5, "The state change pertains to the session with %s\n",
1410                                 ast_sorcery_object_get_id(session->endpoint));
1411         }
1412         if (inv->invite_tsx) {
1413                 ast_debug(5, "The inv session still has an invite_tsx (%p)\n", inv->invite_tsx);
1414         } else {
1415                 ast_debug(5, "The inv session does NOT have an invite_tsx\n");
1416         }
1417         if (tsx) {
1418                 ast_debug(5, "The transaction involved in this state change is %p\n", tsx);
1419                 ast_debug(5, "The current transaction state is %s\n", pjsip_tsx_state_str(tsx->state));
1420                 ast_debug(5, "The transaction state change event is %s\n", pjsip_event_str(e->body.tsx_state.type));
1421         } else {
1422                 ast_debug(5, "There is no transaction involved in this state change\n");
1423         }
1424         ast_debug(5, "The current inv state is %s\n", pjsip_inv_state_name(inv->state));
1425 }
1426
1427 #define print_debug_details(inv, tsx, e) __print_debug_details(__PRETTY_FUNCTION__, (inv), (tsx), (e))
1428
1429 static void handle_incoming_request(struct ast_sip_session *session, pjsip_rx_data *rdata)
1430 {
1431         struct ast_sip_session_supplement *supplement;
1432         struct pjsip_request_line req = rdata->msg_info.msg->line.req;
1433
1434         ast_debug(3, "Method is %.*s\n", (int) pj_strlen(&req.method.name), pj_strbuf(&req.method.name));
1435         AST_LIST_TRAVERSE(&session->supplements, supplement, next) {
1436                 if (supplement->incoming_request && does_method_match(&req.method.name, supplement->method)) {
1437                         if (supplement->incoming_request(session, rdata)) {
1438                                 break;
1439                         }
1440                 }
1441         }
1442 }
1443
1444 static void handle_incoming_response(struct ast_sip_session *session, pjsip_rx_data *rdata)
1445 {
1446         struct ast_sip_session_supplement *supplement;
1447         struct pjsip_status_line status = rdata->msg_info.msg->line.status;
1448
1449         ast_debug(3, "Response is %d %.*s\n", status.code, (int) pj_strlen(&status.reason),
1450                         pj_strbuf(&status.reason));
1451
1452         AST_LIST_TRAVERSE(&session->supplements, supplement, next) {
1453                 if (supplement->incoming_response && does_method_match(&rdata->msg_info.cseq->method.name, supplement->method)) {
1454                         supplement->incoming_response(session, rdata);
1455                 }
1456         }
1457 }
1458
1459 static int handle_incoming(struct ast_sip_session *session, pjsip_rx_data *rdata)
1460 {
1461         ast_debug(3, "Received %s\n", rdata->msg_info.msg->type == PJSIP_REQUEST_MSG ?
1462                         "request" : "response");
1463
1464         if (rdata->msg_info.msg->type == PJSIP_REQUEST_MSG) {
1465                 handle_incoming_request(session, rdata);
1466         } else {
1467                 handle_incoming_response(session, rdata);
1468         }
1469
1470         return 0;
1471 }
1472
1473 static void handle_outgoing_request(struct ast_sip_session *session, pjsip_tx_data *tdata)
1474 {
1475         struct ast_sip_session_supplement *supplement;
1476         struct pjsip_request_line req = tdata->msg->line.req;
1477
1478         ast_debug(3, "Method is %.*s\n", (int) pj_strlen(&req.method.name), pj_strbuf(&req.method.name));
1479         AST_LIST_TRAVERSE(&session->supplements, supplement, next) {
1480                 if (supplement->outgoing_request && does_method_match(&req.method.name, supplement->method)) {
1481                         supplement->outgoing_request(session, tdata);
1482                 }
1483         }
1484 }
1485
1486 static void handle_outgoing_response(struct ast_sip_session *session, pjsip_tx_data *tdata)
1487 {
1488         struct ast_sip_session_supplement *supplement;
1489         struct pjsip_status_line status = tdata->msg->line.status;
1490         pjsip_cseq_hdr *cseq = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_CSEQ, NULL);
1491         ast_debug(3, "Method is %.*s, Response is %d %.*s\n", (int) pj_strlen(&cseq->method.name),
1492                 pj_strbuf(&cseq->method.name), status.code, (int) pj_strlen(&status.reason),
1493                 pj_strbuf(&status.reason));
1494
1495         AST_LIST_TRAVERSE(&session->supplements, supplement, next) {
1496                 if (supplement->outgoing_response && does_method_match(&cseq->method.name, supplement->method)) {
1497                         supplement->outgoing_response(session, tdata);
1498                 }
1499         }
1500 }
1501
1502 static void handle_outgoing(struct ast_sip_session *session, pjsip_tx_data *tdata)
1503 {
1504         ast_debug(3, "Sending %s\n", tdata->msg->type == PJSIP_REQUEST_MSG ?
1505                         "request" : "response");
1506         if (tdata->msg->type == PJSIP_REQUEST_MSG) {
1507                 handle_outgoing_request(session, tdata);
1508         } else {
1509                 handle_outgoing_response(session, tdata);
1510         }
1511 }
1512
1513 static int session_end(struct ast_sip_session *session)
1514 {
1515         struct ast_sip_session_supplement *iter;
1516
1517         /* Stop the scheduled termination */
1518         if (pj_timer_heap_cancel(pjsip_endpt_get_timer_heap(ast_sip_get_pjsip_endpoint()), &session->scheduled_termination)) {
1519                 ao2_ref(session, -1);
1520         }
1521
1522         /* Session is dead. Let's get rid of the reference to the session */
1523         AST_LIST_TRAVERSE(&session->supplements, iter, next) {
1524                 if (iter->session_end) {
1525                         iter->session_end(session);
1526                 }
1527         }
1528
1529         session->inv_session->mod_data[session_module.id] = NULL;
1530         ast_sip_dialog_set_serializer(session->inv_session->dlg, NULL);
1531         ast_sip_dialog_set_endpoint(session->inv_session->dlg, NULL);
1532         ao2_cleanup(session);
1533         return 0;
1534 }
1535
1536 static void session_inv_on_state_changed(pjsip_inv_session *inv, pjsip_event *e)
1537 {
1538         struct ast_sip_session *session = inv->mod_data[session_module.id];
1539
1540         print_debug_details(inv, NULL, e);
1541
1542         switch(e->type) {
1543         case PJSIP_EVENT_TX_MSG:
1544                 handle_outgoing(session, e->body.tx_msg.tdata);
1545                 break;
1546         case PJSIP_EVENT_RX_MSG:
1547                 handle_incoming(session, e->body.rx_msg.rdata);
1548                 break;
1549         case PJSIP_EVENT_TSX_STATE:
1550                 ast_debug(3, "Source of transaction state change is %s\n", pjsip_event_str(e->body.tsx_state.type));
1551                 /* Transaction state changes are prompted by some other underlying event. */
1552                 switch(e->body.tsx_state.type) {
1553                 case PJSIP_EVENT_TX_MSG:
1554                         handle_outgoing(session, e->body.tsx_state.src.tdata);
1555                         break;
1556                 case PJSIP_EVENT_RX_MSG:
1557                         handle_incoming(session, e->body.tsx_state.src.rdata);
1558                         break;
1559                 case PJSIP_EVENT_TRANSPORT_ERROR:
1560                 case PJSIP_EVENT_TIMER:
1561                 case PJSIP_EVENT_USER:
1562                 case PJSIP_EVENT_UNKNOWN:
1563                 case PJSIP_EVENT_TSX_STATE:
1564                         /* Inception? */
1565                         break;
1566                 }
1567                 break;
1568         case PJSIP_EVENT_TRANSPORT_ERROR:
1569         case PJSIP_EVENT_TIMER:
1570         case PJSIP_EVENT_UNKNOWN:
1571         case PJSIP_EVENT_USER:
1572         default:
1573                 break;
1574         }
1575
1576         if (inv->state == PJSIP_INV_STATE_DISCONNECTED) {
1577                 session_end(session);
1578         }
1579 }
1580
1581 static void session_inv_on_new_session(pjsip_inv_session *inv, pjsip_event *e)
1582 {
1583         /* XXX STUB */
1584 }
1585
1586 static void session_inv_on_tsx_state_changed(pjsip_inv_session *inv, pjsip_transaction *tsx, pjsip_event *e)
1587 {
1588         struct ast_sip_session *session = inv->mod_data[session_module.id];
1589         print_debug_details(inv, tsx, e);
1590         if (!session) {
1591                 /* Transaction likely timed out after the call was hung up. Just
1592                  * ignore such transaction changes
1593                  */
1594                 return;
1595         }
1596         switch (e->body.tsx_state.type) {
1597         case PJSIP_EVENT_TX_MSG:
1598                 /* When we create an outgoing request, we do not have access to the transaction that
1599                  * is created. Instead, We have to place transaction-specific data in the tdata. Here,
1600                  * we transfer the data into the transaction. This way, when we receive a response, we
1601                  * can dig this data out again
1602                  */
1603                 tsx->mod_data[session_module.id] = e->body.tsx_state.src.tdata->mod_data[session_module.id];
1604                 break;
1605         case PJSIP_EVENT_RX_MSG:
1606                 if (tsx->method.id == PJSIP_INVITE_METHOD) {
1607                         if (tsx->role == PJSIP_ROLE_UAC && tsx->state == PJSIP_TSX_STATE_COMPLETED) {
1608                                 /* This means we got a non 2XX final response to our outgoing INVITE */
1609                                 if (tsx->status_code == PJSIP_SC_REQUEST_PENDING) {
1610                                         reschedule_reinvite(session, tsx->mod_data[session_module.id], tsx->last_tx);
1611                                         return;
1612                                 } else {
1613                                         /* Other failures result in destroying the session. */
1614                                         pjsip_tx_data *tdata;
1615                                         pjsip_inv_end_session(inv, 500, NULL, &tdata);
1616                                         ast_sip_session_send_request(session, tdata);
1617                                 }
1618                         }
1619                 } else {
1620                         if (tsx->role == PJSIP_ROLE_UAS && tsx->state == PJSIP_TSX_STATE_TRYING) {
1621                                 handle_incoming_request(session, e->body.tsx_state.src.rdata);
1622                         }
1623                 }
1624                 if (tsx->mod_data[session_module.id]) {
1625                         ast_sip_session_response_cb cb = tsx->mod_data[session_module.id];
1626                         cb(session, e->body.tsx_state.src.rdata);
1627                 }
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
1637         /* Terminated INVITE transactions always should result in queuing delayed requests,
1638          * no matter what event caused the transaction to terminate
1639          */
1640         if (tsx->method.id == PJSIP_INVITE_METHOD && tsx->state == PJSIP_TSX_STATE_TERMINATED) {
1641                 queue_delayed_request(session);
1642         }
1643 }
1644
1645 static int add_sdp_streams(void *obj, void *arg, void *data, int flags)
1646 {
1647         struct ast_sip_session_media *session_media = obj;
1648         pjmedia_sdp_session *answer = arg;
1649         struct ast_sip_session *session = data;
1650         struct ast_sip_session_sdp_handler *handler = session_media->handler;
1651         RAII_VAR(struct sdp_handler_list *, handler_list, NULL, ao2_cleanup);
1652
1653         if (handler) {
1654                 /* if an already assigned handler does not handle the session_media or reports a catastrophic error, fail */
1655                 if (handler->create_outgoing_sdp_stream(session, session_media, answer) <= 0) {
1656                         return 0;
1657                 }
1658                 return CMP_MATCH;
1659         }
1660
1661         handler_list = ao2_find(sdp_handlers, session_media->stream_type, OBJ_KEY);
1662         if (!handler_list) {
1663                 return CMP_MATCH;
1664         }
1665
1666         /* no handler for this stream type and we have a list to search */
1667         AST_LIST_TRAVERSE(&handler_list->list, handler, next) {
1668                 int res = handler->create_outgoing_sdp_stream(session, session_media, answer);
1669                 if (res < 0) {
1670                         /* catastrophic error */
1671                         return 0;
1672                 }
1673                 if (res > 0) {
1674                         /* handled */
1675                         return CMP_MATCH;
1676                 }
1677         }
1678
1679         /* streams that weren't handled won't be included in generated outbound SDP */
1680         return CMP_MATCH;
1681 }
1682
1683 static struct pjmedia_sdp_session *create_local_sdp(pjsip_inv_session *inv, struct ast_sip_session *session, const pjmedia_sdp_session *offer)
1684 {
1685         RAII_VAR(struct ao2_iterator *, successful, NULL, ao2_iterator_cleanup);
1686         static const pj_str_t STR_ASTERISK = { "Asterisk", 8 };
1687         static const pj_str_t STR_IN = { "IN", 2 };
1688         static const pj_str_t STR_IP4 = { "IP4", 3 };
1689         static const pj_str_t STR_IP6 = { "IP6", 3 };
1690         pjmedia_sdp_session *local;
1691
1692         if (!(local = PJ_POOL_ZALLOC_T(inv->pool_prov, pjmedia_sdp_session))) {
1693                 return NULL;
1694         }
1695
1696         if (!offer) {
1697                 local->origin.version = local->origin.id = (pj_uint32_t)(ast_random());
1698         } else {
1699                 local->origin.version = offer->origin.version + 1;
1700                 local->origin.id = offer->origin.id;
1701         }
1702
1703         local->origin.user = STR_ASTERISK;
1704         local->origin.net_type = STR_IN;
1705         local->origin.addr_type = session->endpoint->rtp_ipv6 ? STR_IP6 : STR_IP4;
1706         local->origin.addr = *pj_gethostname();
1707         local->name = local->origin.user;
1708
1709         /* Now let the handlers add streams of various types, pjmedia will automatically reorder the media streams for us */
1710         successful = ao2_callback_data(session->media, OBJ_MULTIPLE, add_sdp_streams, local, session);
1711         if (!successful || ao2_container_count(successful->c) != ao2_container_count(session->media)) {
1712                 /* Something experienced a catastrophic failure */
1713                 return NULL;
1714         }
1715
1716         /* Use the connection details of the first media stream if possible for SDP level */
1717         if (local->media_count) {
1718                 local->conn = local->media[0]->conn;
1719         }
1720
1721         return local;
1722 }
1723
1724 static void session_inv_on_rx_offer(pjsip_inv_session *inv, const pjmedia_sdp_session *offer)
1725 {
1726         struct ast_sip_session *session = inv->mod_data[session_module.id];
1727         pjmedia_sdp_session *answer;
1728
1729         if (handle_incoming_sdp(session, offer)) {
1730                 return;
1731         }
1732
1733         if ((answer = create_local_sdp(inv, session, offer))) {
1734                 pjsip_inv_set_sdp_answer(inv, answer);
1735         }
1736 }
1737
1738 #if 0
1739 static void session_inv_on_create_offer(pjsip_inv_session *inv, pjmedia_sdp_session **p_offer)
1740 {
1741         /* XXX STUB */
1742 }
1743 #endif
1744
1745 static void session_inv_on_media_update(pjsip_inv_session *inv, pj_status_t status)
1746 {
1747         struct ast_sip_session *session = inv->mod_data[session_module.id];
1748         const pjmedia_sdp_session *local, *remote;
1749
1750         if (!session->channel) {
1751                 /* If we don't have a channel. We really don't care about media updates.
1752                  * Just ignore
1753                  */
1754                 return;
1755         }
1756
1757         if ((status != PJ_SUCCESS) || (pjmedia_sdp_neg_get_active_local(inv->neg, &local) != PJ_SUCCESS) ||
1758                 (pjmedia_sdp_neg_get_active_remote(inv->neg, &remote) != PJ_SUCCESS)) {
1759                 ast_channel_hangupcause_set(session->channel, AST_CAUSE_BEARERCAPABILITY_NOTAVAIL);
1760                 ast_queue_hangup(session->channel);
1761                 return;
1762         }
1763
1764         handle_negotiated_sdp(session, local, remote);
1765 }
1766
1767 static pjsip_redirect_op session_inv_on_redirected(pjsip_inv_session *inv, const pjsip_uri *target, const pjsip_event *e)
1768 {
1769         struct ast_sip_session *session = inv->mod_data[session_module.id];
1770
1771         if (PJSIP_URI_SCHEME_IS_SIP(target) || PJSIP_URI_SCHEME_IS_SIPS(target)) {
1772                 const pjsip_sip_uri *uri = pjsip_uri_get_uri(target);
1773                 char exten[AST_MAX_EXTENSION];
1774
1775                 ast_copy_pj_str(exten, &uri->user, sizeof(exten));
1776                 ast_channel_call_forward_set(session->channel, exten);
1777         }
1778
1779         return PJSIP_REDIRECT_STOP;
1780 }
1781
1782 static pjsip_inv_callback inv_callback = {
1783         .on_state_changed = session_inv_on_state_changed,
1784         .on_new_session = session_inv_on_new_session,
1785         .on_tsx_state_changed = session_inv_on_tsx_state_changed,
1786         .on_rx_offer = session_inv_on_rx_offer,
1787         .on_media_update = session_inv_on_media_update,
1788         .on_redirected = session_inv_on_redirected,
1789 };
1790
1791 /*! \brief Hook for modifying outgoing messages with SDP to contain the proper address information */
1792 static void session_outgoing_nat_hook(pjsip_tx_data *tdata, struct ast_sip_transport *transport)
1793 {
1794         struct ast_sip_nat_hook *hook = tdata->mod_data[session_module.id];
1795         struct pjmedia_sdp_session *sdp;
1796         int stream;
1797
1798         /* SDP produced by us directly will never be multipart */
1799         if (hook || !tdata->msg->body || pj_stricmp2(&tdata->msg->body->content_type.type, "application") ||
1800                 pj_stricmp2(&tdata->msg->body->content_type.subtype, "sdp") || ast_strlen_zero(transport->external_media_address)) {
1801                 return;
1802         }
1803
1804         sdp = tdata->msg->body->data;
1805
1806         for (stream = 0; stream < sdp->media_count; ++stream) {
1807                 /* See if there are registered handlers for this media stream type */
1808                 char media[20];
1809                 struct ast_sip_session_sdp_handler *handler;
1810                 RAII_VAR(struct sdp_handler_list *, handler_list, NULL, ao2_cleanup);
1811
1812                 /* We need a null-terminated version of the media string */
1813                 ast_copy_pj_str(media, &sdp->media[stream]->desc.media, sizeof(media));
1814
1815                 handler_list = ao2_find(sdp_handlers, media, OBJ_KEY);
1816                 if (!handler_list) {
1817                         ast_debug(1, "No registered SDP handlers for media type '%s'\n", media);
1818                         continue;
1819                 }
1820                 AST_LIST_TRAVERSE(&handler_list->list, handler, next) {
1821                         if (handler->change_outgoing_sdp_stream_media_address) {
1822                                 handler->change_outgoing_sdp_stream_media_address(tdata, sdp->media[stream], transport);
1823                         }
1824                 }
1825         }
1826
1827         /* We purposely do this so that the hook will not be invoked multiple times, ie: if a retransmit occurs */
1828         tdata->mod_data[session_module.id] = nat_hook;
1829 }
1830
1831 static int load_module(void)
1832 {
1833         pjsip_endpoint *endpt;
1834         if (!ast_sip_get_sorcery() || !ast_sip_get_pjsip_endpoint()) {
1835                 return AST_MODULE_LOAD_DECLINE;
1836         }
1837         if (!(nat_hook = ast_sorcery_alloc(ast_sip_get_sorcery(), "nat_hook", NULL))) {
1838                 return AST_MODULE_LOAD_DECLINE;
1839         }
1840         nat_hook->outgoing_external_message = session_outgoing_nat_hook;
1841         ast_sorcery_create(ast_sip_get_sorcery(), nat_hook);
1842         sdp_handlers = ao2_container_alloc(SDP_HANDLER_BUCKETS,
1843                         sdp_handler_list_hash, sdp_handler_list_cmp);
1844         if (!sdp_handlers) {
1845                 return AST_MODULE_LOAD_DECLINE;
1846         }
1847         endpt = ast_sip_get_pjsip_endpoint();
1848         pjsip_inv_usage_init(endpt, &inv_callback);
1849         pjsip_100rel_init_module(endpt);
1850         pjsip_timer_init_module(endpt);
1851         if (ast_sip_register_service(&session_module)) {
1852                 return AST_MODULE_LOAD_DECLINE;
1853         }
1854         return AST_MODULE_LOAD_SUCCESS;
1855 }
1856
1857 static int unload_module(void)
1858 {
1859         ast_sip_unregister_service(&session_module);
1860         if (nat_hook) {
1861                 ast_sorcery_delete(ast_sip_get_sorcery(), nat_hook);
1862                 nat_hook = NULL;
1863         }
1864         return 0;
1865 }
1866
1867 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "SIP Session resource",
1868                 .load = load_module,
1869                 .unload = unload_module,
1870                 .load_pri = AST_MODPRI_APP_DEPEND,
1871                );