Add a new unified Jingle, Google Jingle, and Google Talk channel driver written from...
[asterisk/asterisk.git] / channels / chan_motif.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@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 /*! \file
20  *
21  * \author Joshua Colp <jcolp@digium.com>
22  *
23  * \brief Motif Jingle Channel Driver
24  *
25  * \extref Iksemel http://iksemel.jabberstudio.org/
26  *
27  * \ingroup channel_drivers
28  */
29
30 /*** MODULEINFO
31         <depend>iksemel</depend>
32         <depend>res_jabber</depend>
33         <use type="external">openssl</use>
34         <support_level>core</support_level>
35  ***/
36
37 #include "asterisk.h"
38
39 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
40
41 #include <sys/socket.h>
42 #include <fcntl.h>
43 #include <netdb.h>
44 #include <netinet/in.h>
45 #include <arpa/inet.h>
46 #include <sys/signal.h>
47 #include <iksemel.h>
48 #include <pthread.h>
49
50 #include "asterisk/lock.h"
51 #include "asterisk/channel.h"
52 #include "asterisk/config_options.h"
53 #include "asterisk/module.h"
54 #include "asterisk/pbx.h"
55 #include "asterisk/sched.h"
56 #include "asterisk/io.h"
57 #include "asterisk/rtp_engine.h"
58 #include "asterisk/acl.h"
59 #include "asterisk/callerid.h"
60 #include "asterisk/file.h"
61 #include "asterisk/cli.h"
62 #include "asterisk/app.h"
63 #include "asterisk/musiconhold.h"
64 #include "asterisk/manager.h"
65 #include "asterisk/stringfields.h"
66 #include "asterisk/utils.h"
67 #include "asterisk/causes.h"
68 #include "asterisk/astobj.h"
69 #include "asterisk/abstract_jb.h"
70 #include "asterisk/xmpp.h"
71
72 /*! \brief Default maximum number of ICE candidates we will offer */
73 #define DEFAULT_MAX_ICE_CANDIDATES "10"
74
75 /*! \brief Default maximum number of payloads we will offer */
76 #define DEFAULT_MAX_PAYLOADS "30"
77
78 /*! \brief Number of buckets for endpoints */
79 #define ENDPOINT_BUCKETS 37
80
81 /*! \brief Number of buckets for sessions, on a per-endpoint basis */
82 #define SESSION_BUCKETS 37
83
84 /*! \brief Namespace for Jingle itself */
85 #define JINGLE_NS "urn:xmpp:jingle:1"
86
87 /*! \brief Namespace for Jingle RTP sessions */
88 #define JINGLE_RTP_NS "urn:xmpp:jingle:apps:rtp:1"
89
90 /*! \brief Namespace for Jingle RTP info */
91 #define JINGLE_RTP_INFO_NS "urn:xmpp:jingle:apps:rtp:info:1"
92
93 /*! \brief Namespace for Jingle ICE-UDP */
94 #define JINGLE_ICE_UDP_NS "urn:xmpp:jingle:transports:ice-udp:1"
95
96 /*! \brief Namespace for Google Talk ICE-UDP */
97 #define GOOGLE_TRANSPORT_NS "http://www.google.com/transport/p2p"
98
99 /*! \brief Namespace for Google Talk Raw UDP */
100 #define GOOGLE_TRANSPORT_RAW_NS "http://www.google.com/transport/raw-udp"
101
102 /*! \brief Namespace for Google Session */
103 #define GOOGLE_SESSION_NS "http://www.google.com/session"
104
105 /*! \brief Namespace for Google Phone description */
106 #define GOOGLE_PHONE_NS "http://www.google.com/session/phone"
107
108 /*! \brief Namespace for Google Video description */
109 #define GOOGLE_VIDEO_NS "http://www.google.com/session/video"
110
111 /*! \brief Namespace for XMPP stanzas */
112 #define XMPP_STANZAS_NS "urn:ietf:params:xml:ns:xmpp-stanzas"
113
114 /*! \brief The various transport methods supported, from highest priority to lowest priority when doing fallback */
115 enum jingle_transport {
116         JINGLE_TRANSPORT_ICE_UDP = 3,   /*!< XEP-0176 */
117         JINGLE_TRANSPORT_GOOGLE_V2 = 2, /*!< https://developers.google.com/talk/call_signaling */
118         JINGLE_TRANSPORT_GOOGLE_V1 = 1, /*!< Undocumented initial Google specification */
119         JINGLE_TRANSPORT_NONE = 0,      /*!< No transport specified */
120 };
121
122 /*! \brief Endpoint state information */
123 struct jingle_endpoint_state {
124         struct ao2_container *sessions; /*!< Active sessions to or from the endpoint */
125 };
126
127 /*! \brief Endpoint which contains configuration information and active sessions */
128 struct jingle_endpoint {
129         AST_DECLARE_STRING_FIELDS(
130                 AST_STRING_FIELD(name);              /*!< Name of the endpoint */
131                 AST_STRING_FIELD(context);           /*!< Context to place incoming calls into */
132                 AST_STRING_FIELD(accountcode);       /*!< Account code */
133                 AST_STRING_FIELD(language);          /*!< Default language for prompts */
134                 AST_STRING_FIELD(musicclass);        /*!< Configured music on hold class */
135                 AST_STRING_FIELD(parkinglot);        /*!< Configured parking lot */
136                 );
137         struct ast_xmpp_client *connection;     /*!< Connection to use for traffic */
138         iksrule *rule;                          /*!< Active matching rule */
139         unsigned int maxicecandidates;          /*!< Maximum number of ICE candidates we will offer */
140         unsigned int maxpayloads;               /*!< Maximum number of payloads we will offer */
141         struct ast_codec_pref prefs;            /*!< Codec preferences */
142         struct ast_format_cap *cap;             /*!< Formats to use */
143         ast_group_t callgroup;                  /*!< Call group */
144         ast_group_t pickupgroup;                /*!< Pickup group */
145         enum jingle_transport transport;        /*!< Default transport to use on outgoing sessions */
146         struct jingle_endpoint_state *state;    /*!< Endpoint state information */
147 };
148
149 /*! \brief Session which contains information about an active session */
150 struct jingle_session {
151         AST_DECLARE_STRING_FIELDS(
152                 AST_STRING_FIELD(sid);        /*!< Session identifier */
153                 AST_STRING_FIELD(audio_name); /*!< Name of the audio content */
154                 AST_STRING_FIELD(video_name); /*!< Name of the video content */
155                 );
156         struct jingle_endpoint_state *state;  /*!< Endpoint we are associated with */
157         struct ast_xmpp_client *connection;   /*!< Connection to use for traffic */
158         enum jingle_transport transport;      /*!< Transport type to use for this session */
159         unsigned int maxicecandidates;        /*!< Maximum number of ICE candidates we will offer */
160         unsigned int maxpayloads;             /*!< Maximum number of payloads we will offer */
161         char remote_original[XMPP_MAX_JIDLEN];/*!< Identifier of the original remote party (remote may have changed due to redirect) */
162         char remote[XMPP_MAX_JIDLEN];         /*!< Identifier of the remote party */
163         iksrule *rule;                        /*!< Session matching rule */
164         struct ast_codec_pref prefs;          /*!< Codec preferences */
165         struct ast_channel *owner;            /*!< Master Channel */
166         struct ast_rtp_instance *rtp;         /*!< RTP audio session */
167         struct ast_rtp_instance *vrtp;        /*!< RTP video session */
168         struct ast_format_cap *cap;           /*!< Local codec capabilities */
169         struct ast_format_cap *jointcap;      /*!< Joint codec capabilities */
170         struct ast_format_cap *peercap;       /*!< Peer codec capabilities */
171         unsigned int outgoing:1;              /*!< Whether this is an outgoing leg or not */
172         unsigned int gone:1;                  /*!< In the eyes of Jingle this session is already gone */
173 };
174
175 static const char desc[] = "Motif Jingle Channel";
176 static const char channel_type[] = "Motif";
177
178 struct jingle_config {
179         struct ao2_container *endpoints; /*!< Configured endpoints */
180 };
181
182 static AO2_GLOBAL_OBJ_STATIC(globals);
183
184 static struct ast_sched_context *sched; /*!< Scheduling context for RTCP */
185
186 /* \brief Asterisk core interaction functions */
187 static struct ast_channel *jingle_request(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *data, int *cause);
188 static int jingle_sendtext(struct ast_channel *ast, const char *text);
189 static int jingle_digit_begin(struct ast_channel *ast, char digit);
190 static int jingle_digit_end(struct ast_channel *ast, char digit, unsigned int duration);
191 static int jingle_call(struct ast_channel *ast, const char *dest, int timeout);
192 static int jingle_hangup(struct ast_channel *ast);
193 static int jingle_answer(struct ast_channel *ast);
194 static struct ast_frame *jingle_read(struct ast_channel *ast);
195 static int jingle_write(struct ast_channel *ast, struct ast_frame *f);
196 static int jingle_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
197 static int jingle_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
198 static struct jingle_session *jingle_alloc(struct jingle_endpoint *endpoint, const char *from, const char *sid);
199
200 /*! \brief Action handlers */
201 static void jingle_action_session_initiate(struct jingle_endpoint *endpoint, struct jingle_session *session, ikspak *pak);
202 static void jingle_action_transport_info(struct jingle_endpoint *endpoint, struct jingle_session *session, ikspak *pak);
203 static void jingle_action_session_accept(struct jingle_endpoint *endpoint, struct jingle_session *session, ikspak *pak);
204 static void jingle_action_session_info(struct jingle_endpoint *endpoint, struct jingle_session *session, ikspak *pak);
205 static void jingle_action_session_terminate(struct jingle_endpoint *endpoint, struct jingle_session *session, ikspak *pak);
206
207 /*! \brief PBX interface structure for channel registration */
208 static struct ast_channel_tech jingle_tech = {
209         .type = "Motif",
210         .description = "Motif Jingle Channel Driver",
211         .requester = jingle_request,
212         .send_text = jingle_sendtext,
213         .send_digit_begin = jingle_digit_begin,
214         .send_digit_end = jingle_digit_end,
215         .bridge = ast_rtp_instance_bridge,
216         .call = jingle_call,
217         .hangup = jingle_hangup,
218         .answer = jingle_answer,
219         .read = jingle_read,
220         .write = jingle_write,
221         .write_video = jingle_write,
222         .exception = jingle_read,
223         .indicate = jingle_indicate,
224         .fixup = jingle_fixup,
225         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER
226 };
227
228 /*! \brief Defined handlers for different Jingle actions */
229 static const struct jingle_action_handler {
230         const char *action;
231         void (*handler)(struct jingle_endpoint *endpoint, struct jingle_session *session, ikspak *pak);
232 } jingle_action_handlers[] = {
233         /* Jingle actions */
234         { "session-initiate", jingle_action_session_initiate, },
235         { "transport-info", jingle_action_transport_info, },
236         { "session-accept", jingle_action_session_accept, },
237         { "session-info", jingle_action_session_info, },
238         { "session-terminate", jingle_action_session_terminate, },
239         /* Google-V1 actions */
240         { "initiate", jingle_action_session_initiate, },
241         { "candidates", jingle_action_transport_info, },
242         { "accept", jingle_action_session_accept, },
243         { "terminate", jingle_action_session_terminate, },
244         { "reject", jingle_action_session_terminate, },
245 };
246
247 /*! \brief Reason text <-> cause code mapping */
248 static const struct jingle_reason_mapping {
249         const char *reason;
250         int cause;
251 } jingle_reason_mappings[] = {
252         { "busy", AST_CAUSE_BUSY, },
253         { "cancel", AST_CAUSE_CALL_REJECTED, },
254         { "connectivity-error", AST_CAUSE_INTERWORKING, },
255         { "decline", AST_CAUSE_CALL_REJECTED, },
256         { "expired", AST_CAUSE_NO_USER_RESPONSE, },
257         { "failed-transport", AST_CAUSE_PROTOCOL_ERROR, },
258         { "failed-application", AST_CAUSE_SWITCH_CONGESTION, },
259         { "general-error", AST_CAUSE_CONGESTION, },
260         { "gone", AST_CAUSE_NORMAL_CLEARING, },
261         { "incompatible-parameters", AST_CAUSE_BEARERCAPABILITY_NOTAVAIL, },
262         { "media-error", AST_CAUSE_BEARERCAPABILITY_NOTAVAIL, },
263         { "security-error", AST_CAUSE_PROTOCOL_ERROR, },
264         { "success", AST_CAUSE_NORMAL_CLEARING, },
265         { "timeout", AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE, },
266         { "unsupported-applications", AST_CAUSE_BEARERCAPABILITY_NOTAVAIL, },
267         { "unsupported-transports", AST_CAUSE_FACILITY_NOT_IMPLEMENTED, },
268 };
269
270 /*! \brief Hashing function for Jingle sessions */
271 static int jingle_session_hash(const void *obj, const int flags)
272 {
273         const struct jingle_session *session = obj;
274         const char *sid = obj;
275
276         return ast_str_hash(flags & OBJ_KEY ? sid : session->sid);
277 }
278
279 /*! \brief Comparator function for Jingle sessions */
280 static int jingle_session_cmp(void *obj, void *arg, int flags)
281 {
282         struct jingle_session *session1 = obj, *session2 = arg;
283         const char *sid = arg;
284
285         return !strcmp(session1->sid, flags & OBJ_KEY ? sid : session2->sid) ? CMP_MATCH | CMP_STOP : 0;
286 }
287
288 /*! \brief Destructor for Jingle endpoint state */
289 static void jingle_endpoint_state_destructor(void *obj)
290 {
291         struct jingle_endpoint_state *state = obj;
292
293         ao2_ref(state->sessions, -1);
294 }
295
296 /*! \brief Destructor for Jingle endpoints */
297 static void jingle_endpoint_destructor(void *obj)
298 {
299         struct jingle_endpoint *endpoint = obj;
300
301         if (endpoint->rule) {
302                 iks_filter_remove_rule(endpoint->connection->filter, endpoint->rule);
303         }
304
305         if (endpoint->connection) {
306                 ast_xmpp_client_unref(endpoint->connection);
307         }
308
309         ast_format_cap_destroy(endpoint->cap);
310
311         ao2_ref(endpoint->state, -1);
312
313         ast_string_field_free_memory(endpoint);
314 }
315
316 /*! \brief Find function for Jingle endpoints */
317 static void *jingle_endpoint_find(struct ao2_container *tmp_container, const char *category)
318 {
319         return ao2_find(tmp_container, category, OBJ_KEY);
320 }
321
322 /*! \brief Allocator function for Jingle endpoint state */
323 static struct jingle_endpoint_state *jingle_endpoint_state_create(void)
324 {
325         struct jingle_endpoint_state *state;
326
327         if (!(state = ao2_alloc(sizeof(*state), jingle_endpoint_state_destructor))) {
328                 return NULL;
329         }
330
331         if (!(state->sessions = ao2_container_alloc(SESSION_BUCKETS, jingle_session_hash, jingle_session_cmp))) {
332                 ao2_ref(state, -1);
333                 return NULL;
334         }
335
336         return state;
337 }
338
339 /*! \brief State find/create function */
340 static struct jingle_endpoint_state *jingle_endpoint_state_find_or_create(const char *category)
341 {
342         RAII_VAR(struct jingle_config *, cfg, ao2_global_obj_ref(globals), ao2_cleanup);
343         RAII_VAR(struct jingle_endpoint *, endpoint, NULL, ao2_cleanup);
344
345         if (!cfg || !cfg->endpoints || !(endpoint = jingle_endpoint_find(cfg->endpoints, category))) {
346                 return jingle_endpoint_state_create();
347         }
348
349         ao2_ref(endpoint->state, +1);
350         return endpoint->state;
351 }
352
353 /*! \brief Allocator function for Jingle endpoints */
354 static void *jingle_endpoint_alloc(const char *cat)
355 {
356         struct jingle_endpoint *endpoint;
357
358         if (!(endpoint = ao2_alloc(sizeof(*endpoint), jingle_endpoint_destructor))) {
359                 return NULL;
360         }
361
362         if (ast_string_field_init(endpoint, 512)) {
363                 ao2_ref(endpoint, -1);
364                 return NULL;
365         }
366
367         if (!(endpoint->state = jingle_endpoint_state_find_or_create(cat))) {
368                 ao2_ref(endpoint, -1);
369                 return NULL;
370         }
371
372         ast_string_field_set(endpoint, name, cat);
373
374         endpoint->cap = ast_format_cap_alloc_nolock();
375         endpoint->transport = JINGLE_TRANSPORT_ICE_UDP;
376
377         return endpoint;
378 }
379
380 /*! \brief Hashing function for Jingle endpoints */
381 static int jingle_endpoint_hash(const void *obj, const int flags)
382 {
383         const struct jingle_endpoint *endpoint = obj;
384         const char *name = obj;
385
386         return ast_str_hash(flags & OBJ_KEY ? name : endpoint->name);
387 }
388
389 /*! \brief Comparator function for Jingle endpoints */
390 static int jingle_endpoint_cmp(void *obj, void *arg, int flags)
391 {
392         struct jingle_endpoint *endpoint1 = obj, *endpoint2 = arg;
393         const char *name = arg;
394
395         return !strcmp(endpoint1->name, flags & OBJ_KEY ? name : endpoint2->name) ? CMP_MATCH | CMP_STOP : 0;
396 }
397
398 static struct aco_type endpoint_option = {
399         .type = ACO_ITEM,
400         .category_match = ACO_BLACKLIST,
401         .category = "^general$",
402         .item_alloc = jingle_endpoint_alloc,
403         .item_find = jingle_endpoint_find,
404         .item_offset = offsetof(struct jingle_config, endpoints),
405 };
406
407 struct aco_type *endpoint_options[] = ACO_TYPES(&endpoint_option);
408
409 struct aco_file jingle_conf = {
410         .filename = "motif.conf",
411         .types = ACO_TYPES(&endpoint_option),
412 };
413
414 /*! \brief Destructor for Jingle sessions */
415 static void jingle_session_destructor(void *obj)
416 {
417         struct jingle_session *session = obj;
418
419         if (session->rule) {
420                 iks_filter_remove_rule(session->connection->filter, session->rule);
421         }
422
423         if (session->connection) {
424                 ast_xmpp_client_unref(session->connection);
425         }
426
427         if (session->rtp) {
428                 ast_rtp_instance_destroy(session->rtp);
429         }
430
431         if (session->vrtp) {
432                 ast_rtp_instance_destroy(session->vrtp);
433         }
434
435         ast_format_cap_destroy(session->cap);
436         ast_format_cap_destroy(session->jointcap);
437         ast_format_cap_destroy(session->peercap);
438
439         ast_string_field_free_memory(session);
440 }
441
442 /*! \brief Destructor called when module configuration goes away */
443 static void jingle_config_destructor(void *obj)
444 {
445         struct jingle_config *cfg = obj;
446         ao2_cleanup(cfg->endpoints);
447 }
448
449 /*! \brief Allocator called when module configuration should appear */
450 static void *jingle_config_alloc(void)
451 {
452         struct jingle_config *cfg;
453
454         if (!(cfg = ao2_alloc(sizeof(*cfg), jingle_config_destructor))) {
455                 return NULL;
456         }
457
458         if (!(cfg->endpoints = ao2_container_alloc(ENDPOINT_BUCKETS, jingle_endpoint_hash, jingle_endpoint_cmp))) {
459                 ao2_ref(cfg, -1);
460                 return NULL;
461         }
462
463         return cfg;
464 }
465
466 CONFIG_INFO_STANDARD(cfg_info, globals, jingle_config_alloc,
467                      .files = ACO_FILES(&jingle_conf),
468         );
469
470 /*! \brief Function called by RTP engine to get local RTP peer */
471 static enum ast_rtp_glue_result jingle_get_rtp_peer(struct ast_channel *chan, struct ast_rtp_instance **instance)
472 {
473         struct jingle_session *session = ast_channel_tech_pvt(chan);
474         enum ast_rtp_glue_result res = AST_RTP_GLUE_RESULT_LOCAL;
475
476         if (!session->rtp) {
477                 return AST_RTP_GLUE_RESULT_FORBID;
478         }
479
480         ao2_ref(session->rtp, +1);
481         *instance = session->rtp;
482
483         return res;
484 }
485
486 /*! \brief Function called by RTP engine to get peer capabilities */
487 static void jingle_get_codec(struct ast_channel *chan, struct ast_format_cap *result)
488 {
489 }
490
491 /*! \brief Function called by RTP engine to change where the remote party should send media */
492 static int jingle_set_rtp_peer(struct ast_channel *chan, struct ast_rtp_instance *rtp, struct ast_rtp_instance *vrtp, struct ast_rtp_instance *tpeer, const struct ast_format_cap *cap, int nat_active)
493 {
494         return -1;
495 }
496
497 /*! \brief Local glue for interacting with the RTP engine core */
498 static struct ast_rtp_glue jingle_rtp_glue = {
499         .type = "Motif",
500         .get_rtp_info = jingle_get_rtp_peer,
501         .get_codec = jingle_get_codec,
502         .update_peer = jingle_set_rtp_peer,
503 };
504
505 /*! \brief Internal helper function which enables video support on a sesson if possible */
506 static void jingle_enable_video(struct jingle_session *session)
507 {
508         struct ast_sockaddr tmp;
509         struct ast_rtp_engine_ice *ice;
510
511         /* If video is already present don't do anything */
512         if (session->vrtp) {
513                 return;
514         }
515
516         /* If there are no configured video codecs do not turn video support on, it just won't work */
517         if (!ast_format_cap_has_type(session->cap, AST_FORMAT_TYPE_VIDEO)) {
518                 return;
519         }
520
521         ast_sockaddr_parse(&tmp, "0.0.0.0", 0);
522
523         if (!(session->vrtp = ast_rtp_instance_new("asterisk", sched, &tmp, NULL))) {
524                 return;
525         }
526
527         ast_rtp_instance_set_prop(session->vrtp, AST_RTP_PROPERTY_RTCP, 1);
528
529         ast_channel_set_fd(session->owner, 2, ast_rtp_instance_fd(session->vrtp, 0));
530         ast_channel_set_fd(session->owner, 3, ast_rtp_instance_fd(session->vrtp, 1));
531         ast_rtp_codecs_packetization_set(ast_rtp_instance_get_codecs(session->vrtp), session->vrtp, &session->prefs);
532
533         if (session->transport == JINGLE_TRANSPORT_GOOGLE_V2 && (ice = ast_rtp_instance_get_ice(session->vrtp))) {
534                 ice->stop(session->vrtp);
535         }
536 }
537
538 /*! \brief Internal helper function used to allocate Jingle session on an endpoint */
539 static struct jingle_session *jingle_alloc(struct jingle_endpoint *endpoint, const char *from, const char *sid)
540 {
541         struct jingle_session *session;
542         struct ast_sockaddr tmp;
543
544         if (!(session = ao2_alloc(sizeof(*session), jingle_session_destructor))) {
545                 return NULL;
546         }
547
548         if (ast_string_field_init(session, 512)) {
549                 ao2_ref(session, -1);
550                 return NULL;
551         }
552
553         if (!ast_strlen_zero(from)) {
554                 ast_copy_string(session->remote_original, from, sizeof(session->remote_original));
555                 ast_copy_string(session->remote, from, sizeof(session->remote));
556         }
557
558         if (ast_strlen_zero(sid)) {
559                 ast_string_field_build(session, sid, "%08lx%08lx", ast_random(), ast_random());
560                 session->outgoing = 1;
561                 ast_string_field_set(session, audio_name, "audio");
562                 ast_string_field_set(session, video_name, "video");
563         } else {
564                 ast_string_field_set(session, sid, sid);
565         }
566
567         ao2_ref(endpoint->state, +1);
568         session->state = endpoint->state;
569         ao2_ref(endpoint->connection, +1);
570         session->connection = endpoint->connection;
571         session->transport = endpoint->transport;
572
573         if (!(session->cap = ast_format_cap_alloc_nolock()) ||
574             !(session->jointcap = ast_format_cap_alloc_nolock()) ||
575             !(session->peercap = ast_format_cap_alloc_nolock())) {
576                 ao2_ref(session, -1);
577                 return NULL;
578         }
579
580         ast_format_cap_copy(session->cap, endpoint->cap);
581
582         /* While we rely on res_jabber for communication we still need a temporary ast_sockaddr to tell the RTP engine
583          * that we want IPv4 */
584         ast_sockaddr_parse(&tmp, "0.0.0.0", 0);
585
586         /* Sessions always carry audio, but video is optional so don't enable it here */
587         if (!(session->rtp = ast_rtp_instance_new("asterisk", sched, &tmp, NULL))) {
588                 ao2_ref(session, -1);
589                 return NULL;
590         }
591         ast_rtp_instance_set_prop(session->rtp, AST_RTP_PROPERTY_RTCP, 1);
592         ast_rtp_instance_set_prop(session->rtp, AST_RTP_PROPERTY_DTMF, 1);
593
594         memcpy(&session->prefs, &endpoint->prefs, sizeof(session->prefs));
595
596         session->maxicecandidates = endpoint->maxicecandidates;
597         session->maxpayloads = endpoint->maxpayloads;
598
599         return session;
600 }
601
602 /*! \brief Function called to create a new Jingle Asterisk channel */
603 static struct ast_channel *jingle_new(struct jingle_endpoint *endpoint, struct jingle_session *session, int state, const char *title, const char *linkedid, const char *cid_name)
604 {
605         struct ast_channel *chan;
606         const char *str = S_OR(title, session->remote);
607         struct ast_format tmpfmt;
608
609         if (ast_format_cap_is_empty(session->cap)) {
610                 return NULL;
611         }
612
613         if (!(chan = ast_channel_alloc(1, state, S_OR(title, ""), S_OR(cid_name, ""), "", "", "", linkedid, 0, "Motif/%s-%04lx", str, ast_random() & 0xffff))) {
614                 return NULL;
615         }
616
617         ast_channel_tech_set(chan, &jingle_tech);
618         ast_channel_tech_pvt_set(chan, session);
619         session->owner = chan;
620
621         ast_format_cap_copy(ast_channel_nativeformats(chan), session->cap);
622         ast_codec_choose(&session->prefs, session->cap, 1, &tmpfmt);
623
624         if (session->rtp) {
625                 struct ast_rtp_engine_ice *ice;
626
627                 ast_channel_set_fd(chan, 0, ast_rtp_instance_fd(session->rtp, 0));
628                 ast_channel_set_fd(chan, 1, ast_rtp_instance_fd(session->rtp, 1));
629                 ast_rtp_codecs_packetization_set(ast_rtp_instance_get_codecs(session->rtp), session->rtp, &session->prefs);
630
631                 if (((session->transport == JINGLE_TRANSPORT_GOOGLE_V2) ||
632                      (session->transport == JINGLE_TRANSPORT_GOOGLE_V1)) &&
633                     (ice = ast_rtp_instance_get_ice(session->rtp))) {
634                         /* We stop built in ICE support because we need to fall back to old old old STUN support */
635                         ice->stop(session->rtp);
636                 }
637         }
638
639         if (state == AST_STATE_RING) {
640                 ast_channel_rings_set(chan, 1);
641         }
642
643         ast_channel_adsicpe_set(chan, AST_ADSI_UNAVAILABLE);
644
645         ast_best_codec(ast_channel_nativeformats(chan), &tmpfmt);
646         ast_format_copy(ast_channel_writeformat(chan), &tmpfmt);
647         ast_format_copy(ast_channel_rawwriteformat(chan), &tmpfmt);
648         ast_format_copy(ast_channel_readformat(chan), &tmpfmt);
649         ast_format_copy(ast_channel_rawreadformat(chan), &tmpfmt);
650
651         ao2_lock(endpoint);
652
653         ast_channel_callgroup_set(chan, endpoint->callgroup);
654         ast_channel_pickupgroup_set(chan, endpoint->pickupgroup);
655
656         if (!ast_strlen_zero(endpoint->accountcode)) {
657                 ast_channel_accountcode_set(chan, endpoint->accountcode);
658         }
659
660         if (!ast_strlen_zero(endpoint->language)) {
661                 ast_channel_language_set(chan, endpoint->language);
662         }
663
664         if (!ast_strlen_zero(endpoint->musicclass)) {
665                 ast_channel_musicclass_set(chan, endpoint->musicclass);
666         }
667
668         ast_channel_context_set(chan, endpoint->context);
669         ast_channel_exten_set(chan, "s");
670         ast_channel_priority_set(chan, 1);
671
672         ao2_unlock(endpoint);
673
674         return chan;
675 }
676
677 /*! \brief Internal helper function which sends a response */
678 static void jingle_send_response(struct ast_xmpp_client *connection, ikspak *pak)
679 {
680         iks *response;
681
682         if (!(response = iks_new("iq"))) {
683                 ast_log(LOG_ERROR, "Unable to allocate an IKS response stanza\n");
684                 return;
685         }
686
687         iks_insert_attrib(response, "type", "result");
688         iks_insert_attrib(response, "from", connection->jid->full);
689         iks_insert_attrib(response, "to", iks_find_attrib(pak->x, "from"));
690         iks_insert_attrib(response, "id", iks_find_attrib(pak->x, "id"));
691
692         ast_xmpp_client_send(connection, response);
693
694         iks_delete(response);
695 }
696
697 /*! \brief Internal helper function which sends an error response */
698 static void jingle_send_error_response(struct ast_xmpp_client *connection, ikspak *pak, const char *type, const char *reasonstr, const char *reasonstr2)
699 {
700         iks *response, *error = NULL, *reason = NULL, *reason2 = NULL;
701
702         if (!(response = iks_new("iq")) ||
703             !(error = iks_new("error")) ||
704             !(reason = iks_new(reasonstr))) {
705                 ast_log(LOG_ERROR, "Unable to allocate IKS error response stanzas\n");
706                 goto end;
707         }
708
709         iks_insert_attrib(response, "type", "error");
710         iks_insert_attrib(response, "from", connection->jid->full);
711         iks_insert_attrib(response, "to", iks_find_attrib(pak->x, "from"));
712         iks_insert_attrib(response, "id", iks_find_attrib(pak->x, "id"));
713
714         iks_insert_attrib(error, "type", type);
715         iks_insert_node(error, reason);
716
717         if (!ast_strlen_zero(reasonstr2) && (reason2 = iks_new(reasonstr2))) {
718                 iks_insert_node(error, reason2);
719         }
720
721         iks_insert_node(response, error);
722
723         ast_xmpp_client_send(connection, response);
724 end:
725         iks_delete(reason2);
726         iks_delete(reason);
727         iks_delete(error);
728         iks_delete(response);
729 }
730
731 /*! \brief Internal helper function which adds ICE-UDP candidates to a transport node */
732 static int jingle_add_ice_udp_candidates_to_transport(struct ast_rtp_instance *rtp, iks *transport, iks **candidates, unsigned int maximum)
733 {
734         struct ast_rtp_engine_ice *ice;
735         struct ao2_container *local_candidates;
736         struct ao2_iterator it;
737         struct ast_rtp_engine_ice_candidate *candidate;
738         int i = 0, res = 0;
739
740         if (!(ice = ast_rtp_instance_get_ice(rtp)) || !(local_candidates = ice->get_local_candidates(rtp))) {
741                 ast_log(LOG_ERROR, "Unable to add ICE-UDP candidates as ICE support not available or no candidates available\n");
742                 return -1;
743         }
744
745         iks_insert_attrib(transport, "xmlns", JINGLE_ICE_UDP_NS);
746         iks_insert_attrib(transport, "pwd", ice->get_password(rtp));
747         iks_insert_attrib(transport, "ufrag", ice->get_ufrag(rtp));
748
749         it = ao2_iterator_init(local_candidates, 0);
750
751         while ((candidate = ao2_iterator_next(&it)) && (i < maximum)) {
752                 iks *local_candidate;
753                 char tmp[30];
754
755                 if (!(local_candidate = iks_new("candidate"))) {
756                         res = -1;
757                         ast_log(LOG_ERROR, "Unable to allocate IKS candidate stanza for ICE-UDP transport\n");
758                         break;
759                 }
760
761                 snprintf(tmp, sizeof(tmp), "%d", candidate->id);
762                 iks_insert_attrib(local_candidate, "component", tmp);
763                 snprintf(tmp, sizeof(tmp), "%d", ast_str_hash(candidate->foundation));
764                 iks_insert_attrib(local_candidate, "foundation", tmp);
765                 iks_insert_attrib(local_candidate, "generation", "0");
766                 snprintf(tmp, sizeof(tmp), "%04lx", ast_random() & 0xffff);
767                 iks_insert_attrib(local_candidate, "id", tmp);
768                 iks_insert_attrib(local_candidate, "ip", ast_sockaddr_stringify_host(&candidate->address));
769                 iks_insert_attrib(local_candidate, "port", ast_sockaddr_stringify_port(&candidate->address));
770                 snprintf(tmp, sizeof(tmp), "%d", candidate->priority);
771                 iks_insert_attrib(local_candidate, "priority", tmp);
772                 iks_insert_attrib(local_candidate, "protocol", "udp");
773
774                 if (candidate->type == AST_RTP_ICE_CANDIDATE_TYPE_HOST) {
775                         iks_insert_attrib(local_candidate, "type", "host");
776                 } else if (candidate->type == AST_RTP_ICE_CANDIDATE_TYPE_SRFLX) {
777                         iks_insert_attrib(local_candidate, "type", "srflx");
778                 } else if (candidate->type == AST_RTP_ICE_CANDIDATE_TYPE_RELAYED) {
779                         iks_insert_attrib(local_candidate, "type", "relay");
780                 }
781
782                 iks_insert_node(transport, local_candidate);
783                 candidates[i++] = local_candidate;
784         }
785
786         ao2_iterator_destroy(&it);
787         ao2_ref(local_candidates, -1);
788
789         return res;
790 }
791
792 /*! \brief Internal helper function which adds Google candidates to a transport node */
793 static int jingle_add_google_candidates_to_transport(struct ast_rtp_instance *rtp, iks *transport, iks **candidates, unsigned int video, enum jingle_transport transport_type, unsigned int maximum)
794 {
795         struct ast_rtp_engine_ice *ice;
796         struct ao2_container *local_candidates;
797         struct ao2_iterator it;
798         struct ast_rtp_engine_ice_candidate *candidate;
799         int i = 0, res = 0;
800
801         if (!(ice = ast_rtp_instance_get_ice(rtp)) || !(local_candidates = ice->get_local_candidates(rtp))) {
802                 ast_log(LOG_ERROR, "Unable to add Google ICE candidates as ICE support not available or no candidates available\n");
803                 return -1;
804         }
805
806         if (transport_type != JINGLE_TRANSPORT_GOOGLE_V1) {
807                 iks_insert_attrib(transport, "xmlns", GOOGLE_TRANSPORT_NS);
808         }
809
810         it = ao2_iterator_init(local_candidates, 0);
811
812         while ((candidate = ao2_iterator_next(&it)) && (i < maximum)) {
813                 iks *local_candidate;
814                 /* In Google land a username is 16 bytes, explicitly */
815                 char ufrag[17] = "";
816
817                 if (!(local_candidate = iks_new("candidate"))) {
818                         res = -1;
819                         ast_log(LOG_ERROR, "Unable to allocate IKS candidate stanza for Google ICE transport\n");
820                         break;
821                 }
822
823                 /* We only support RTP candidates */
824                 if (candidate->id != 1) {
825                         continue;
826                 }
827
828                 iks_insert_attrib(local_candidate, "name", !video ? "rtp" : "video_rtp");
829                 iks_insert_attrib(local_candidate, "address", ast_sockaddr_stringify_host(&candidate->address));
830                 iks_insert_attrib(local_candidate, "port", ast_sockaddr_stringify_port(&candidate->address));
831
832                 if (candidate->type == AST_RTP_ICE_CANDIDATE_TYPE_HOST) {
833                         iks_insert_attrib(local_candidate, "preference", "0.95");
834                         iks_insert_attrib(local_candidate, "type", "local");
835                 } else if (candidate->type == AST_RTP_ICE_CANDIDATE_TYPE_SRFLX) {
836                         iks_insert_attrib(local_candidate, "preference", "0.9");
837                         iks_insert_attrib(local_candidate, "type", "stun");
838                 }
839
840                 iks_insert_attrib(local_candidate, "protocol", "udp");
841                 iks_insert_attrib(local_candidate, "network", "0");
842                 snprintf(ufrag, sizeof(ufrag), "%s", ice->get_ufrag(rtp));
843                 iks_insert_attrib(local_candidate, "username", ufrag);
844                 iks_insert_attrib(local_candidate, "generation", "0");
845
846                 if (transport_type == JINGLE_TRANSPORT_GOOGLE_V1) {
847                         iks_insert_attrib(local_candidate, "password", "");
848                         iks_insert_attrib(local_candidate, "foundation", "0");
849                         iks_insert_attrib(local_candidate, "component", "1");
850                 } else {
851                         iks_insert_attrib(local_candidate, "password", ice->get_password(rtp));
852                 }
853
854                 /* You may notice a lack of relay support up above - this is because we don't support it for use with
855                  * the Google talk transport due to their arcane support. */
856
857                 iks_insert_node(transport, local_candidate);
858                 candidates[i++] = local_candidate;
859         }
860
861         ao2_iterator_destroy(&it);
862         ao2_ref(local_candidates, -1);
863
864         return res;
865 }
866
867 /*! \brief Internal function which sends a session-terminate message */
868 static void jingle_send_session_terminate(struct jingle_session *session, const char *reasontext)
869 {
870         iks *iq = NULL, *jingle = NULL, *reason = NULL, *text = NULL;
871
872         if (!(iq = iks_new("iq")) || !(jingle = iks_new(session->transport == JINGLE_TRANSPORT_GOOGLE_V1 ? "session" : "jingle")) ||
873             !(reason = iks_new("reason")) || !(text = iks_new(reasontext))) {
874                 ast_log(LOG_ERROR, "Failed to allocate stanzas for session-terminate message on session '%s'\n", session->sid);
875                 goto end;
876         }
877
878         iks_insert_attrib(iq, "to", session->remote);
879         iks_insert_attrib(iq, "type", "set");
880         iks_insert_attrib(iq, "id", session->connection->mid);
881         ast_xmpp_increment_mid(session->connection->mid);
882
883         if (session->transport == JINGLE_TRANSPORT_GOOGLE_V1) {
884                 iks_insert_attrib(jingle, "type", "terminate");
885                 iks_insert_attrib(jingle, "id", session->sid);
886                 iks_insert_attrib(jingle, "xmlns", GOOGLE_SESSION_NS);
887                 iks_insert_attrib(jingle, "initiator", session->outgoing ? session->connection->jid->full : session->remote);
888         } else {
889                 iks_insert_attrib(jingle, "action", "session-terminate");
890                 iks_insert_attrib(jingle, "sid", session->sid);
891                 iks_insert_attrib(jingle, "xmlns", JINGLE_NS);
892         }
893
894         iks_insert_node(iq, jingle);
895         iks_insert_node(jingle, reason);
896         iks_insert_node(reason, text);
897
898         ast_xmpp_client_send(session->connection, iq);
899
900 end:
901         iks_delete(text);
902         iks_delete(reason);
903         iks_delete(jingle);
904         iks_delete(iq);
905 }
906
907 /*! \brief Internal function which sends a session-info message */
908 static void jingle_send_session_info(struct jingle_session *session, const char *info)
909 {
910         iks *iq = NULL, *jingle = NULL, *text = NULL;
911
912         /* Google-V1 has no way to send informational messages so don't even bother trying */
913         if (session->transport == JINGLE_TRANSPORT_GOOGLE_V1) {
914                 return;
915         }
916
917         if (!(iq = iks_new("iq")) || !(jingle = iks_new("jingle")) || !(text = iks_new(info))) {
918                 ast_log(LOG_ERROR, "Failed to allocate stanzas for session-info message on session '%s'\n", session->sid);
919                 goto end;
920         }
921
922         iks_insert_attrib(iq, "to", session->remote);
923         iks_insert_attrib(iq, "type", "set");
924         iks_insert_attrib(iq, "id", session->connection->mid);
925         ast_xmpp_increment_mid(session->connection->mid);
926
927         iks_insert_attrib(jingle, "action", "session-info");
928         iks_insert_attrib(jingle, "sid", session->sid);
929         iks_insert_attrib(jingle, "xmlns", JINGLE_NS);
930         iks_insert_node(iq, jingle);
931         iks_insert_node(jingle, text);
932
933         ast_xmpp_client_send(session->connection, iq);
934
935 end:
936         iks_delete(text);
937         iks_delete(jingle);
938         iks_delete(iq);
939 }
940
941 /*! \internal
942  *
943  * \brief Locks both pvt and pvt owner if owner is present.
944  *
945  * \note This function gives a ref to pvt->owner if it is present and locked.
946  *       This reference must be decremented after pvt->owner is unlocked.
947  *
948  * \note This function will never give you up,
949  * \note This function will never let you down.
950  * \note This function will run around and desert you.
951  *
952  * \pre pvt is not locked
953  * \post pvt is locked
954  * \post pvt->owner is locked and its reference count is increased (if pvt->owner is not NULL)
955  *
956  * \returns a pointer to the locked and reffed pvt->owner channel if it exists.
957  */
958 static struct ast_channel *jingle_session_lock_full(struct jingle_session *pvt)
959 {
960         struct ast_channel *chan;
961
962         /* Locking is simple when it is done right.  If you see a deadlock resulting
963          * in this function, it is not this function's fault, Your problem exists elsewhere.
964          * This function is perfect... seriously. */
965         for (;;) {
966                 /* First, get the channel and grab a reference to it */
967                 ao2_lock(pvt);
968                 chan = pvt->owner;
969                 if (chan) {
970                         /* The channel can not go away while we hold the pvt lock.
971                          * Give the channel a ref so it will not go away after we let
972                          * the pvt lock go. */
973                         ast_channel_ref(chan);
974                 } else {
975                         /* no channel, return pvt locked */
976                         return NULL;
977                 }
978
979                 /* We had to hold the pvt lock while getting a ref to the owner channel
980                  * but now we have to let this lock go in order to preserve proper
981                  * locking order when grabbing the channel lock */
982                 ao2_unlock(pvt);
983
984                 /* Look, no deadlock avoidance, hooray! */
985                 ast_channel_lock(chan);
986                 ao2_lock(pvt);
987                 if (pvt->owner == chan) {
988                         /* done */
989                         break;
990                 }
991
992                 /* If the owner changed while everything was unlocked, no problem,
993                  * just start over and everthing will work.  This is rare, do not be
994                  * confused by this loop and think this it is an expensive operation.
995                  * The majority of the calls to this function will never involve multiple
996                  * executions of this loop. */
997                 ast_channel_unlock(chan);
998                 ast_channel_unref(chan);
999                 ao2_unlock(pvt);
1000         }
1001
1002         /* If owner exists, it is locked and reffed */
1003         return pvt->owner;
1004 }
1005
1006 /*! \brief Helper function which queues a hangup frame with cause code */
1007 static void jingle_queue_hangup_with_cause(struct jingle_session *session, int cause)
1008 {
1009         struct ast_channel *chan;
1010
1011         if ((chan = jingle_session_lock_full(session))) {
1012                 ast_debug(3, "Hanging up channel '%s' with cause '%d'\n", ast_channel_name(chan), cause);
1013                 ast_queue_hangup_with_cause(chan, cause);
1014                 ast_channel_unlock(chan);
1015                 ast_channel_unref(chan);
1016         }
1017         ao2_unlock(session);
1018 }
1019
1020 /*! \brief Internal function which sends a transport-info message */
1021 static void jingle_send_transport_info(struct jingle_session *session, const char *from)
1022 {
1023         iks *iq, *jingle = NULL, *audio = NULL, *audio_transport = NULL, *video = NULL, *video_transport = NULL;
1024         iks *audio_candidates[session->maxicecandidates], *video_candidates[session->maxicecandidates];
1025         int i, res = 0;
1026
1027         if (!(iq = iks_new("iq")) ||
1028             !(jingle = iks_new(session->transport == JINGLE_TRANSPORT_GOOGLE_V1 ? "session" : "jingle"))) {
1029                 iks_delete(iq);
1030                 jingle_queue_hangup_with_cause(session, AST_CAUSE_SWITCH_CONGESTION);
1031                 ast_log(LOG_ERROR, "Failed to allocate stanzas for transport-info message, hanging up session '%s'\n", session->sid);
1032                 return;
1033         }
1034
1035         memset(audio_candidates, 0, sizeof(audio_candidates));
1036         memset(video_candidates, 0, sizeof(video_candidates));
1037
1038         iks_insert_attrib(iq, "from", session->connection->jid->full);
1039         iks_insert_attrib(iq, "to", from);
1040         iks_insert_attrib(iq, "type", "set");
1041         iks_insert_attrib(iq, "id", session->connection->mid);
1042         ast_xmpp_increment_mid(session->connection->mid);
1043
1044         if (session->transport == JINGLE_TRANSPORT_GOOGLE_V1) {
1045                 iks_insert_attrib(jingle, "type", "candidates");
1046                 iks_insert_attrib(jingle, "id", session->sid);
1047                 iks_insert_attrib(jingle, "xmlns", GOOGLE_SESSION_NS);
1048                 iks_insert_attrib(jingle, "initiator", session->outgoing ? session->connection->jid->full : from);
1049         } else {
1050                 iks_insert_attrib(jingle, "action", "transport-info");
1051                 iks_insert_attrib(jingle, "sid", session->sid);
1052                 iks_insert_attrib(jingle, "xmlns", JINGLE_NS);
1053         }
1054         iks_insert_node(iq, jingle);
1055
1056         if (session->rtp) {
1057                 if (session->transport == JINGLE_TRANSPORT_GOOGLE_V1) {
1058                         /* V1 protocol has the candidates directly in the session */
1059                         res = jingle_add_google_candidates_to_transport(session->rtp, jingle, audio_candidates, 0, session->transport, session->maxicecandidates);
1060                 } else if ((audio = iks_new("content")) && (audio_transport = iks_new("transport"))) {
1061                         iks_insert_attrib(audio, "creator", session->outgoing ? "initiator" : "responder");
1062                         iks_insert_attrib(audio, "name", session->audio_name);
1063                         iks_insert_node(jingle, audio);
1064                         iks_insert_node(audio, audio_transport);
1065
1066                         if (session->transport == JINGLE_TRANSPORT_ICE_UDP) {
1067                                 res = jingle_add_ice_udp_candidates_to_transport(session->rtp, audio_transport, audio_candidates, session->maxicecandidates);
1068                         } else if (session->transport == JINGLE_TRANSPORT_GOOGLE_V2) {
1069                                 res = jingle_add_google_candidates_to_transport(session->rtp, audio_transport, audio_candidates, 0, session->transport,
1070                                                                                 session->maxicecandidates);
1071                         }
1072                 } else {
1073                         res = -1;
1074                 }
1075         }
1076
1077         if ((session->transport != JINGLE_TRANSPORT_GOOGLE_V1) && !res && session->vrtp) {
1078                 if ((video = iks_new("content")) && (video_transport = iks_new("transport"))) {
1079                         iks_insert_attrib(video, "creator", session->outgoing ? "initiator" : "responder");
1080                         iks_insert_attrib(video, "name", session->video_name);
1081                         iks_insert_node(jingle, video);
1082                         iks_insert_node(video, video_transport);
1083
1084                         if (session->transport == JINGLE_TRANSPORT_ICE_UDP) {
1085                                 res = jingle_add_ice_udp_candidates_to_transport(session->vrtp, video_transport, video_candidates, session->maxicecandidates);
1086                         } else if (session->transport == JINGLE_TRANSPORT_GOOGLE_V2) {
1087                                 res = jingle_add_google_candidates_to_transport(session->vrtp, video_transport, video_candidates, 1, session->transport,
1088                                                                                 session->maxicecandidates);
1089                         }
1090                 } else {
1091                         res = -1;
1092                 }
1093         }
1094
1095         if (!res) {
1096                 ast_xmpp_client_send(session->connection, iq);
1097         } else {
1098                 jingle_queue_hangup_with_cause(session, AST_CAUSE_SWITCH_CONGESTION);
1099         }
1100
1101         /* Clean up after ourselves */
1102         for (i = 0; i < session->maxicecandidates; i++) {
1103                 iks_delete(video_candidates[i]);
1104                 iks_delete(audio_candidates[i]);
1105         }
1106
1107         iks_delete(video_transport);
1108         iks_delete(video);
1109         iks_delete(audio_transport);
1110         iks_delete(audio);
1111         iks_delete(jingle);
1112         iks_delete(iq);
1113 }
1114
1115 /*! \brief Internal helper function which adds payloads to a description */
1116 static int jingle_add_payloads_to_description(struct jingle_session *session, struct ast_rtp_instance *rtp, iks *description, iks **payloads, enum ast_format_type type)
1117 {
1118         struct ast_format format;
1119         int i = 0, res = 0;
1120
1121         ast_format_cap_iter_start(session->jointcap);
1122         while (!(ast_format_cap_iter_next(session->jointcap, &format)) && (i < (session->maxpayloads - 2))) {
1123                 int rtp_code;
1124                 iks *payload;
1125                 char tmp[32];
1126
1127                 if (AST_FORMAT_GET_TYPE(format.id) != type) {
1128                         continue;
1129                 }
1130
1131                 if (((rtp_code = ast_rtp_codecs_payload_code(ast_rtp_instance_get_codecs(rtp), 1, &format, 0)) == -1) ||
1132                     (!(payload = iks_new("payload-type")))) {
1133                         res = -1;
1134                         goto end;
1135                 }
1136
1137                 if (session->transport == JINGLE_TRANSPORT_GOOGLE_V1) {
1138                         iks_insert_attrib(payload, "xmlns", GOOGLE_PHONE_NS);
1139                 }
1140
1141                 snprintf(tmp, sizeof(tmp), "%d", rtp_code);
1142                 iks_insert_attrib(payload, "id", tmp);
1143                 iks_insert_attrib(payload, "name", ast_rtp_lookup_mime_subtype2(1, &format, 0, 0));
1144                 iks_insert_attrib(payload, "channels", "1");
1145                 snprintf(tmp, sizeof(tmp), "%d", ast_rtp_lookup_sample_rate2(1, &format, 0));
1146                 iks_insert_attrib(payload, "clockrate", tmp);
1147
1148                 iks_insert_node(description, payload);
1149                 payloads[i++] = payload;
1150         }
1151         /* If this is for audio and there is room for RFC2833 add it in */
1152         if ((type == AST_FORMAT_TYPE_AUDIO) && (i < session->maxpayloads)) {
1153                 iks *payload;
1154
1155                 if ((payload = iks_new("payload-type"))) {
1156                         if (session->transport == JINGLE_TRANSPORT_GOOGLE_V1) {
1157                                 iks_insert_attrib(payload, "xmlns", GOOGLE_PHONE_NS);
1158                         }
1159
1160                         iks_insert_attrib(payload, "id", "101");
1161                         iks_insert_attrib(payload, "name", "telephone-event");
1162                         iks_insert_attrib(payload, "channels", "1");
1163                         iks_insert_attrib(payload, "clockrate", "8000");
1164                         iks_insert_node(description, payload);
1165                         payloads[i++] = payload;
1166                 }
1167         }
1168
1169 end:
1170         ast_format_cap_iter_end(session->jointcap);
1171
1172         return res;
1173 }
1174
1175 /*! \brief Helper function which adds content to a description */
1176 static int jingle_add_content(struct jingle_session *session, iks *jingle, iks *content, iks *description, iks *transport,
1177                               const char *name, enum ast_format_type type, struct ast_rtp_instance *rtp, iks **payloads)
1178 {
1179         int res = 0;
1180
1181         if (session->transport != JINGLE_TRANSPORT_GOOGLE_V1) {
1182                 iks_insert_attrib(content, "creator", session->outgoing ? "initiator" : "responder");
1183                 iks_insert_attrib(content, "name", name);
1184                 iks_insert_node(jingle, content);
1185
1186                 iks_insert_attrib(description, "xmlns", JINGLE_RTP_NS);
1187                 if (type == AST_FORMAT_TYPE_AUDIO) {
1188                         iks_insert_attrib(description, "media", "audio");
1189                 } else if (type == AST_FORMAT_TYPE_VIDEO) {
1190                         iks_insert_attrib(description, "media", "video");
1191                 } else {
1192                         return -1;
1193                 }
1194                 iks_insert_node(content, description);
1195         } else {
1196                 iks_insert_attrib(description, "xmlns", GOOGLE_PHONE_NS);
1197                 iks_insert_node(jingle, description);
1198         }
1199
1200         if (!(res = jingle_add_payloads_to_description(session, rtp, description, payloads, type))) {
1201                 if (session->transport == JINGLE_TRANSPORT_ICE_UDP) {
1202                         iks_insert_attrib(transport, "xmlns", JINGLE_ICE_UDP_NS);
1203                         iks_insert_node(content, transport);
1204                 } else if (session->transport == JINGLE_TRANSPORT_GOOGLE_V2) {
1205                         iks_insert_attrib(transport, "xmlns", GOOGLE_TRANSPORT_NS);
1206                         iks_insert_node(content, transport);
1207                 }
1208         }
1209
1210         return res;
1211 }
1212
1213 /*! \brief Internal function which sends a complete session message */
1214 static void jingle_send_session_action(struct jingle_session *session, const char *action)
1215 {
1216         iks *iq, *jingle, *audio = NULL, *audio_description = NULL, *video = NULL, *video_description = NULL;
1217         iks *audio_payloads[session->maxpayloads], *video_payloads[session->maxpayloads];
1218         iks *audio_transport = NULL, *video_transport = NULL;
1219         int i, res = 0;
1220
1221         if (!(iq = iks_new("iq")) ||
1222             !(jingle = iks_new(session->transport == JINGLE_TRANSPORT_GOOGLE_V1 ? "session" : "jingle"))) {
1223                 jingle_queue_hangup_with_cause(session, AST_CAUSE_SWITCH_CONGESTION);
1224                 iks_delete(iq);
1225                 return;
1226         }
1227
1228         memset(audio_payloads, 0, sizeof(audio_payloads));
1229         memset(video_payloads, 0, sizeof(video_payloads));
1230
1231         iks_insert_attrib(iq, "from", session->connection->jid->full);
1232         iks_insert_attrib(iq, "to", session->remote);
1233         iks_insert_attrib(iq, "type", "set");
1234         iks_insert_attrib(iq, "id", session->connection->mid);
1235         ast_xmpp_increment_mid(session->connection->mid);
1236
1237         if (session->transport == JINGLE_TRANSPORT_GOOGLE_V1) {
1238                 iks_insert_attrib(jingle, "type", action);
1239                 iks_insert_attrib(jingle, "id", session->sid);
1240                 iks_insert_attrib(jingle, "xmlns", GOOGLE_SESSION_NS);
1241         } else {
1242                 iks_insert_attrib(jingle, "action", action);
1243                 iks_insert_attrib(jingle, "sid", session->sid);
1244                 iks_insert_attrib(jingle, "xmlns", JINGLE_NS);
1245         }
1246
1247         if (!strcasecmp(action, "session-initiate") || !strcasecmp(action, "initiate") || !strcasecmp(action, "accept")) {
1248                 iks_insert_attrib(jingle, "initiator", session->outgoing ? session->connection->jid->full : session->remote);
1249         }
1250
1251         iks_insert_node(iq, jingle);
1252
1253         if (session->rtp && (audio = iks_new("content")) && (audio_description = iks_new("description")) &&
1254             (audio_transport = iks_new("transport"))) {
1255                 res = jingle_add_content(session, jingle, audio, audio_description, audio_transport, session->audio_name,
1256                                          AST_FORMAT_TYPE_AUDIO, session->rtp, audio_payloads);
1257         } else {
1258                 ast_log(LOG_ERROR, "Failed to allocate audio content stanzas for session '%s', hanging up\n", session->sid);
1259                 res = -1;
1260         }
1261
1262         if ((session->transport != JINGLE_TRANSPORT_GOOGLE_V1) && !res && session->vrtp) {
1263                 if ((video = iks_new("content")) && (video_description = iks_new("description")) &&
1264                     (video_transport = iks_new("transport"))) {
1265                         res = jingle_add_content(session, jingle, video, video_description, video_transport, session->video_name,
1266                                                  AST_FORMAT_TYPE_VIDEO, session->vrtp, video_payloads);
1267                 } else {
1268                         ast_log(LOG_ERROR, "Failed to allocate video content stanzas for session '%s', hanging up\n", session->sid);
1269                         res = -1;
1270                 }
1271         }
1272
1273         if (!res) {
1274                 ast_xmpp_client_send(session->connection, iq);
1275         } else {
1276                 jingle_queue_hangup_with_cause(session, AST_CAUSE_SWITCH_CONGESTION);
1277         }
1278
1279         iks_delete(video_transport);
1280         iks_delete(audio_transport);
1281
1282         for (i = 0; i < session->maxpayloads; i++) {
1283                 iks_delete(video_payloads[i]);
1284                 iks_delete(audio_payloads[i]);
1285         }
1286
1287         iks_delete(video_description);
1288         iks_delete(video);
1289         iks_delete(audio_description);
1290         iks_delete(audio);
1291         iks_delete(jingle);
1292         iks_delete(iq);
1293 }
1294
1295 /*! \brief Internal function which sends a session-inititate message */
1296 static void jingle_send_session_initiate(struct jingle_session *session)
1297 {
1298         jingle_send_session_action(session, session->transport == JINGLE_TRANSPORT_GOOGLE_V1 ? "initiate" : "session-initiate");
1299 }
1300
1301 /*! \brief Internal function which sends a session-accept message */
1302 static void jingle_send_session_accept(struct jingle_session *session)
1303 {
1304         jingle_send_session_action(session, session->transport == JINGLE_TRANSPORT_GOOGLE_V1 ? "accept" : "session-accept");
1305 }
1306
1307 /*! \brief Callback for when a response is received for an outgoing session-initiate message */
1308 static int jingle_outgoing_hook(void *data, ikspak *pak)
1309 {
1310         struct jingle_session *session = data;
1311         iks *error = iks_find(pak->x, "error"), *redirect;
1312
1313         /* In all cases this hook is done with */
1314         iks_filter_remove_rule(session->connection->filter, session->rule);
1315         session->rule = NULL;
1316
1317         /* If no error occurred they accepted our session-initiate message happily */
1318         if (!error) {
1319                 struct ast_channel *chan;
1320
1321                 if ((chan = jingle_session_lock_full(session))) {
1322                         ast_queue_control(chan, AST_CONTROL_PROCEEDING);
1323                         ast_channel_unlock(chan);
1324                         ast_channel_unref(chan);
1325                 }
1326                 ao2_unlock(session);
1327
1328                 jingle_send_transport_info(session, iks_find_attrib(pak->x, "from"));
1329                 return IKS_FILTER_EAT;
1330         }
1331
1332         /* Assume that because this is an error the session is gone, there is only one case where this is incorrect - a redirect */
1333         session->gone = 1;
1334
1335         /* Map the error we received to an appropriate cause code and hang up the channel */
1336         if ((redirect = iks_find_with_attrib(error, "redirect", "xmlns", XMPP_STANZAS_NS))) {
1337                 iks *to = iks_child(redirect);
1338                 char *target;
1339
1340                 if (to && (target = iks_name(to)) && !ast_strlen_zero(target)) {
1341                         /* Make the xmpp: go away if it is present */
1342                         if (!strncmp(target, "xmpp:", 5)) {
1343                                 target += 5;
1344                         }
1345
1346                         /* This is actually a fairly simple operation - we update the remote and send another session-initiate */
1347                         ast_copy_string(session->remote, target, sizeof(session->remote));
1348
1349                         /* Add a new hook so we can get the status of redirected session */
1350                         session->rule = iks_filter_add_rule(session->connection->filter, jingle_outgoing_hook, session,
1351                                                             IKS_RULE_ID, session->connection->mid, IKS_RULE_DONE);
1352
1353                         jingle_send_session_initiate(session);
1354
1355                         session->gone = 0;
1356                 } else {
1357                         jingle_queue_hangup_with_cause(session, AST_CAUSE_PROTOCOL_ERROR);
1358                 }
1359         } else if (iks_find_with_attrib(error, "service-unavailable", "xmlns", XMPP_STANZAS_NS)) {
1360                 jingle_queue_hangup_with_cause(session, AST_CAUSE_CONGESTION);
1361         } else if (iks_find_with_attrib(error, "resource-constraint", "xmlns", XMPP_STANZAS_NS)) {
1362                 jingle_queue_hangup_with_cause(session, AST_CAUSE_REQUESTED_CHAN_UNAVAIL);
1363         } else if (iks_find_with_attrib(error, "bad-request", "xmlns", XMPP_STANZAS_NS)) {
1364                 jingle_queue_hangup_with_cause(session, AST_CAUSE_PROTOCOL_ERROR);
1365         } else if (iks_find_with_attrib(error, "remote-server-not-found", "xmlns", XMPP_STANZAS_NS)) {
1366                 jingle_queue_hangup_with_cause(session, AST_CAUSE_NO_ROUTE_DESTINATION);
1367         } else if (iks_find_with_attrib(error, "feature-not-implemented", "xmlns", XMPP_STANZAS_NS)) {
1368                 /* Assume that this occurred because the remote side does not support our transport, so drop it down one and try again */
1369                 session->transport--;
1370
1371                 /* If we still have a viable transport mechanism re-send the session-initiate */
1372                 if (session->transport != JINGLE_TRANSPORT_NONE) {
1373                         struct ast_rtp_engine_ice *ice;
1374
1375                         if (((session->transport == JINGLE_TRANSPORT_GOOGLE_V2) ||
1376                              (session->transport == JINGLE_TRANSPORT_GOOGLE_V1)) &&
1377                             (ice = ast_rtp_instance_get_ice(session->rtp))) {
1378                                 /* We stop built in ICE support because we need to fall back to old old old STUN support */
1379                                 ice->stop(session->rtp);
1380                         }
1381
1382                         /* Re-send the message to the *original* target and not a redirected one */
1383                         ast_copy_string(session->remote, session->remote_original, sizeof(session->remote));
1384
1385                         session->rule = iks_filter_add_rule(session->connection->filter, jingle_outgoing_hook, session,
1386                                                             IKS_RULE_ID, session->connection->mid, IKS_RULE_DONE);
1387
1388                         jingle_send_session_initiate(session);
1389
1390                         session->gone = 0;
1391                 } else {
1392                         /* Otherwise we have exhausted all transports */
1393                         jingle_queue_hangup_with_cause(session, AST_CAUSE_FACILITY_NOT_IMPLEMENTED);
1394                 }
1395         } else {
1396                 jingle_queue_hangup_with_cause(session, AST_CAUSE_PROTOCOL_ERROR);
1397         }
1398
1399         return IKS_FILTER_EAT;
1400 }
1401
1402 /*! \brief Function called by core when we should answer a Jingle session */
1403 static int jingle_answer(struct ast_channel *ast)
1404 {
1405         struct jingle_session *session = ast_channel_tech_pvt(ast);
1406
1407         /* The channel has already been answered so we don't need to do anything */
1408         if (ast_channel_state(ast) == AST_STATE_UP) {
1409                 return 0;
1410         }
1411
1412         jingle_send_session_accept(session);
1413
1414         return 0;
1415 }
1416
1417 /*! \brief Function called by core to read any waiting frames */
1418 static struct ast_frame *jingle_read(struct ast_channel *ast)
1419 {
1420         struct jingle_session *session = ast_channel_tech_pvt(ast);
1421         struct ast_frame *frame = &ast_null_frame;
1422
1423         switch (ast_channel_fdno(ast)) {
1424         case 0:
1425                 if (session->rtp) {
1426                         frame = ast_rtp_instance_read(session->rtp, 0);
1427                 }
1428                 break;
1429         case 1:
1430                 if (session->rtp) {
1431                         frame = ast_rtp_instance_read(session->rtp, 1);
1432                 }
1433                 break;
1434         case 2:
1435                 if (session->vrtp) {
1436                         frame = ast_rtp_instance_read(session->vrtp, 0);
1437                 }
1438                 break;
1439         case 3:
1440                 if (session->vrtp) {
1441                         frame = ast_rtp_instance_read(session->vrtp, 1);
1442                 }
1443                 break;
1444         default:
1445                 break;
1446         }
1447
1448         if (frame && frame->frametype == AST_FRAME_VOICE &&
1449             !ast_format_cap_iscompatible(ast_channel_nativeformats(ast), &frame->subclass.format)) {
1450                 if (!ast_format_cap_iscompatible(session->jointcap, &frame->subclass.format)) {
1451                         ast_debug(1, "Bogus frame of format '%s' received from '%s'!\n",
1452                                   ast_getformatname(&frame->subclass.format), ast_channel_name(ast));
1453                         ast_frfree(frame);
1454                         frame = &ast_null_frame;
1455                 } else {
1456                         ast_debug(1, "Oooh, format changed to %s\n",
1457                                   ast_getformatname(&frame->subclass.format));
1458                         ast_format_cap_remove_bytype(ast_channel_nativeformats(ast), AST_FORMAT_TYPE_AUDIO);
1459                         ast_format_cap_add(ast_channel_nativeformats(ast), &frame->subclass.format);
1460                         ast_set_read_format(ast, ast_channel_readformat(ast));
1461                         ast_set_write_format(ast, ast_channel_writeformat(ast));
1462                 }
1463         }
1464
1465         return frame;
1466 }
1467
1468 /*! \brief Function called by core to write frames */
1469 static int jingle_write(struct ast_channel *ast, struct ast_frame *frame)
1470 {
1471         struct jingle_session *session = ast_channel_tech_pvt(ast);
1472         int res = 0;
1473         char buf[256];
1474
1475         switch (frame->frametype) {
1476         case AST_FRAME_VOICE:
1477                 if (!(ast_format_cap_iscompatible(ast_channel_nativeformats(ast), &frame->subclass.format))) {
1478                         ast_log(LOG_WARNING,
1479                                 "Asked to transmit frame type %s, while native formats is %s (read/write = %s/%s)\n",
1480                                 ast_getformatname(&frame->subclass.format),
1481                                 ast_getformatname_multiple(buf, sizeof(buf), ast_channel_nativeformats(ast)),
1482                                 ast_getformatname(ast_channel_readformat(ast)),
1483                                 ast_getformatname(ast_channel_writeformat(ast)));
1484                         return 0;
1485                 }
1486                 if (session && session->rtp) {
1487                         res = ast_rtp_instance_write(session->rtp, frame);
1488                 }
1489                 break;
1490         case AST_FRAME_VIDEO:
1491                 if (session && session->vrtp) {
1492                         res = ast_rtp_instance_write(session->vrtp, frame);
1493                 }
1494                 break;
1495         default:
1496                 ast_log(LOG_WARNING, "Can't send %d type frames with Jingle write\n",
1497                         frame->frametype);
1498                 return 0;
1499         }
1500
1501         return res;
1502 }
1503
1504 /*! \brief Function called by core to change the underlying owner channel */
1505 static int jingle_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
1506 {
1507         struct jingle_session *session = ast_channel_tech_pvt(newchan);
1508
1509         ao2_lock(session);
1510
1511         session->owner = newchan;
1512
1513         ao2_unlock(session);
1514
1515         return 0;
1516 }
1517
1518 /*! \brief Function called by core to ask the channel to indicate some sort of condition */
1519 static int jingle_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen)
1520 {
1521         struct jingle_session *session = ast_channel_tech_pvt(ast);
1522         int res = 0;
1523
1524         switch (condition) {
1525         case AST_CONTROL_RINGING:
1526                 if (ast_channel_state(ast) == AST_STATE_RING) {
1527                         jingle_send_session_info(session, "ringing xmlns='urn:xmpp:jingle:apps:rtp:info:1'");
1528                 } else {
1529                         res = -1;
1530                 }
1531                 break;
1532         case AST_CONTROL_BUSY:
1533                 if (ast_channel_state(ast) != AST_STATE_UP) {
1534                         ast_channel_hangupcause_set(ast, AST_CAUSE_BUSY);
1535                         ast_softhangup_nolock(ast, AST_SOFTHANGUP_DEV);
1536                 } else {
1537                         res = -1;
1538                 }
1539                 break;
1540         case AST_CONTROL_CONGESTION:
1541                 if (ast_channel_state(ast) != AST_STATE_UP) {
1542                         ast_channel_hangupcause_set(ast, AST_CAUSE_CONGESTION);
1543                         ast_softhangup_nolock(ast, AST_SOFTHANGUP_DEV);
1544                 } else {
1545                         res = -1;
1546                 }
1547                 break;
1548         case AST_CONTROL_INCOMPLETE:
1549                 if (ast_channel_state(ast) != AST_STATE_UP) {
1550                         ast_channel_hangupcause_set(ast, AST_CAUSE_CONGESTION);
1551                         ast_softhangup_nolock(ast, AST_SOFTHANGUP_DEV);
1552                 }
1553                 break;
1554         case AST_CONTROL_HOLD:
1555                 ast_moh_start(ast, data, NULL);
1556                 break;
1557         case AST_CONTROL_UNHOLD:
1558                 ast_moh_stop(ast);
1559                 break;
1560         case AST_CONTROL_SRCUPDATE:
1561                 if (session->rtp) {
1562                         ast_rtp_instance_update_source(session->rtp);
1563                 }
1564                 break;
1565         case AST_CONTROL_SRCCHANGE:
1566                 if (session->rtp) {
1567                         ast_rtp_instance_change_source(session->rtp);
1568                 }
1569                 break;
1570         case AST_CONTROL_VIDUPDATE:
1571         case AST_CONTROL_UPDATE_RTP_PEER:
1572         case AST_CONTROL_CONNECTED_LINE:
1573                 break;
1574         case AST_CONTROL_PVT_CAUSE_CODE:
1575         case -1:
1576                 res = -1;
1577                 break;
1578         default:
1579                 ast_log(LOG_NOTICE, "Don't know how to indicate condition '%d'\n", condition);
1580                 res = -1;
1581         }
1582
1583         return res;
1584 }
1585
1586 /*! \brief Function called by core to send text to the remote party of the Jingle session */
1587 static int jingle_sendtext(struct ast_channel *chan, const char *text)
1588 {
1589         struct jingle_session *session = ast_channel_tech_pvt(chan);
1590
1591         return ast_xmpp_client_send_message(session->connection, session->remote, text);
1592 }
1593
1594 /*! \brief Function called by core to start a DTMF digit */
1595 static int jingle_digit_begin(struct ast_channel *chan, char digit)
1596 {
1597         struct jingle_session *session = ast_channel_tech_pvt(chan);
1598
1599         if (session->rtp) {
1600                 ast_rtp_instance_dtmf_begin(session->rtp, digit);
1601         }
1602
1603         return 0;
1604 }
1605
1606 /*! \brief Function called by core to stop a DTMF digit */
1607 static int jingle_digit_end(struct ast_channel *ast, char digit, unsigned int duration)
1608 {
1609         struct jingle_session *session = ast_channel_tech_pvt(ast);
1610
1611         if (session->rtp) {
1612                 ast_rtp_instance_dtmf_end_with_duration(session->rtp, digit, duration);
1613         }
1614
1615         return 0;
1616 }
1617
1618 /*! \brief Function called by core to actually start calling a remote party */
1619 static int jingle_call(struct ast_channel *ast, const char *dest, int timeout)
1620 {
1621         struct jingle_session *session = ast_channel_tech_pvt(ast);
1622
1623         ast_setstate(ast, AST_STATE_RING);
1624
1625         /* Since we have no idea of the remote capabilities use ours for now */
1626         ast_format_cap_copy(session->jointcap, session->cap);
1627
1628         /* We set up a hook so we can know when our session-initiate message was accepted or rejected */
1629         session->rule = iks_filter_add_rule(session->connection->filter, jingle_outgoing_hook, session,
1630                                             IKS_RULE_ID, session->connection->mid, IKS_RULE_DONE);
1631
1632         jingle_send_session_initiate(session);
1633
1634         return 0;
1635 }
1636
1637 /*! \brief Function called by core to hang up a Jingle session */
1638 static int jingle_hangup(struct ast_channel *ast)
1639 {
1640         struct jingle_session *session = ast_channel_tech_pvt(ast);
1641
1642         ao2_lock(session);
1643
1644         if ((ast_channel_state(ast) != AST_STATE_DOWN) && !session->gone) {
1645                 int cause = (session->owner ? ast_channel_hangupcause(session->owner) : AST_CAUSE_CONGESTION);
1646                 const char *reason = "success";
1647                 int i;
1648
1649                 /* Get the appropriate reason and send a session-terminate */
1650                 for (i = 0; i < ARRAY_LEN(jingle_reason_mappings); i++) {
1651                         if (jingle_reason_mappings[i].cause == cause) {
1652                                 reason = jingle_reason_mappings[i].reason;
1653                                 break;
1654                         }
1655                 }
1656
1657                 jingle_send_session_terminate(session, reason);
1658         }
1659
1660         ast_channel_tech_pvt_set(ast, NULL);
1661         session->owner = NULL;
1662
1663         ao2_unlink(session->state->sessions, session);
1664         ao2_ref(session->state, -1);
1665
1666         ao2_unlock(session);
1667         ao2_ref(session, -1);
1668
1669         return 0;
1670 }
1671
1672 /*! \brief Function called by core to create a new outgoing Jingle session */
1673 static struct ast_channel *jingle_request(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *data, int *cause)
1674 {
1675         RAII_VAR(struct jingle_config *, cfg, ao2_global_obj_ref(globals), ao2_cleanup);
1676         RAII_VAR(struct jingle_endpoint *, endpoint, NULL, ao2_cleanup);
1677         char *dialed, target[200] = "";
1678         struct ast_xmpp_buddy *buddy;
1679         struct jingle_session *session;
1680         struct ast_channel *chan;
1681         enum jingle_transport transport = JINGLE_TRANSPORT_NONE;
1682         AST_DECLARE_APP_ARGS(args,
1683                              AST_APP_ARG(name);
1684                              AST_APP_ARG(target);
1685                 );
1686
1687         /* We require at a minimum one audio format to be requested */
1688         if (!ast_format_cap_has_type(cap, AST_FORMAT_TYPE_AUDIO)) {
1689                 ast_log(LOG_ERROR, "Motif channel driver requires an audio format when dialing a destination\n");
1690                 *cause = AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
1691                 return NULL;
1692         }
1693
1694         if (ast_strlen_zero(data) || !(dialed = ast_strdupa(data))) {
1695                 ast_log(LOG_ERROR, "Unable to create channel with empty destination.\n");
1696                 *cause = AST_CAUSE_CHANNEL_UNACCEPTABLE;
1697                 return NULL;
1698         }
1699
1700         /* Parse the given dial string and validate the results */
1701         AST_NONSTANDARD_APP_ARGS(args, dialed, '/');
1702
1703         if (ast_strlen_zero(args.name) || ast_strlen_zero(args.target)) {
1704                 ast_log(LOG_ERROR, "Unable to determine endpoint name and target.\n");
1705                 *cause = AST_CAUSE_CHANNEL_UNACCEPTABLE;
1706                 return NULL;
1707         }
1708
1709         if (!(endpoint = jingle_endpoint_find(cfg->endpoints, args.name))) {
1710                 ast_log(LOG_ERROR, "Endpoint '%s' does not exist.\n", args.name);
1711                 *cause = AST_CAUSE_CHANNEL_UNACCEPTABLE;
1712                 return NULL;
1713         }
1714
1715         ao2_lock(endpoint->state);
1716
1717         /* If we don't have a connection for the endpoint we can't exactly start a session on it */
1718         if (!endpoint->connection) {
1719                 ast_log(LOG_ERROR, "Unable to create Jingle session on endpoint '%s' as no valid connection exists\n", args.name);
1720                 *cause = AST_CAUSE_SWITCH_CONGESTION;
1721                 ao2_unlock(endpoint->state);
1722                 return NULL;
1723         }
1724
1725         /* Find the target in the roster so we can choose a resource */
1726         if ((buddy = ao2_find(endpoint->connection->buddies, args.target, OBJ_KEY))) {
1727                 struct ao2_iterator res;
1728                 struct ast_xmpp_resource *resource;
1729
1730                 /* Iterate through finding the first viable Jingle capable resource */
1731                 res = ao2_iterator_init(buddy->resources, 0);
1732                 while ((resource = ao2_iterator_next(&res))) {
1733                         if (resource->caps.jingle) {
1734                                 snprintf(target, sizeof(target), "%s/%s", args.target, resource->resource);
1735                                 transport = JINGLE_TRANSPORT_ICE_UDP;
1736                                 break;
1737                         } else if (resource->caps.google) {
1738                                 snprintf(target, sizeof(target), "%s/%s", args.target, resource->resource);
1739                                 transport = JINGLE_TRANSPORT_GOOGLE_V2;
1740                                 break;
1741                         }
1742                         ao2_ref(resource, -1);
1743                 }
1744                 ao2_iterator_destroy(&res);
1745
1746                 ao2_ref(buddy, -1);
1747         } else {
1748                 /* If the target is NOT in the roster use the provided target as-is */
1749                 ast_copy_string(target, args.target, sizeof(target));
1750         }
1751
1752         ao2_unlock(endpoint->state);
1753
1754         /* If no target was found we can't set up a session */
1755         if (ast_strlen_zero(target)) {
1756                 ast_log(LOG_ERROR, "Unable to create Jingle session on endpoint '%s' as no capable resource for target '%s' was found\n", args.name, args.target);
1757                 *cause = AST_CAUSE_SWITCH_CONGESTION;
1758                 return NULL;
1759         }
1760
1761         if (!(session = jingle_alloc(endpoint, target, NULL))) {
1762                 ast_log(LOG_ERROR, "Unable to create Jingle session on endpoint '%s'\n", args.name);
1763                 *cause = AST_CAUSE_SWITCH_CONGESTION;
1764                 return NULL;
1765         }
1766
1767         /* Update the transport if we learned what we should actually use */
1768         if (transport != JINGLE_TRANSPORT_NONE) {
1769                 session->transport = transport;
1770                 /* Note that for Google-V1 and Google-V2 we don't stop built-in ICE support, this will happen in jingle_new */
1771         }
1772
1773         if (!(chan = jingle_new(endpoint, session, AST_STATE_DOWN, target, requestor ? ast_channel_linkedid(requestor) : NULL, NULL))) {
1774                 ast_log(LOG_ERROR, "Unable to create Jingle channel on endpoint '%s'\n", args.name);
1775                 *cause = AST_CAUSE_SWITCH_CONGESTION;
1776                 ao2_ref(session, -1);
1777                 return NULL;
1778         }
1779
1780         /* If video was requested try to enable it on the session */
1781         if (ast_format_cap_has_type(cap, AST_FORMAT_TYPE_VIDEO)) {
1782                 jingle_enable_video(session);
1783         }
1784
1785         /* We purposely don't decrement the session here as there is a reference on the channel */
1786         ao2_link(endpoint->state->sessions, session);
1787
1788         return chan;
1789 }
1790
1791 /*! \brief Helper function which handles content descriptions */
1792 static int jingle_interpret_description(struct jingle_session *session, iks *description, const char *name, struct ast_rtp_instance **rtp)
1793 {
1794         char *media = iks_find_attrib(description, "media");
1795         struct ast_rtp_codecs codecs;
1796         iks *codec;
1797         int othercapability = 0;
1798
1799         /* Google-V1 is always carrying audio, but just doesn't tell us so */
1800         if (session->transport == JINGLE_TRANSPORT_GOOGLE_V1) {
1801                 media = "audio";
1802         } else if (ast_strlen_zero(media)) {
1803                 jingle_queue_hangup_with_cause(session, AST_CAUSE_BEARERCAPABILITY_NOTAVAIL);
1804                 ast_log(LOG_ERROR, "Received a content description on session '%s' without a name\n", session->sid);
1805                 return -1;
1806         }
1807
1808         /* Determine the type of media that is being carried and update the RTP instance, as well as the name */
1809         if (!strcasecmp(media, "audio")) {
1810                 if (!ast_strlen_zero(name)) {
1811                         ast_string_field_set(session, audio_name, name);
1812                 }
1813                 *rtp = session->rtp;
1814                 ast_format_cap_remove_bytype(session->peercap, AST_FORMAT_TYPE_AUDIO);
1815                 ast_format_cap_remove_bytype(session->jointcap, AST_FORMAT_TYPE_AUDIO);
1816         } else if (!strcasecmp(media, "video")) {
1817                 if (!ast_strlen_zero(name)) {
1818                         ast_string_field_set(session, video_name, name);
1819                 }
1820
1821                 jingle_enable_video(session);
1822                 *rtp = session->vrtp;
1823
1824                 /* If video is not present cancel this session */
1825                 if (!session->vrtp) {
1826                         jingle_queue_hangup_with_cause(session, AST_CAUSE_BEARERCAPABILITY_NOTAVAIL);
1827                         ast_log(LOG_ERROR, "Received a video content description on session '%s' but could not enable video\n", session->sid);
1828                         return -1;
1829                 }
1830
1831                 ast_format_cap_remove_bytype(session->peercap, AST_FORMAT_TYPE_VIDEO);
1832                 ast_format_cap_remove_bytype(session->jointcap, AST_FORMAT_TYPE_VIDEO);
1833         } else {
1834                 /* Unknown media type */
1835                 jingle_queue_hangup_with_cause(session, AST_CAUSE_BEARERCAPABILITY_NOTAVAIL);
1836                 ast_log(LOG_ERROR, "Unsupported media type '%s' received in content description on session '%s'\n", media, session->sid);
1837                 return -1;
1838         }
1839
1840         ast_rtp_codecs_payloads_clear(&codecs, NULL);
1841
1842         /* Iterate the codecs updating the relevant RTP instance as we go */
1843         for (codec = iks_child(description); codec; codec = iks_next(codec)) {
1844                 char *id = iks_find_attrib(codec, "id"), *name = iks_find_attrib(codec, "name");
1845                 char *clockrate = iks_find_attrib(codec, "clockrate");
1846                 int rtp_id, rtp_clockrate;
1847
1848                 if (!ast_strlen_zero(id) && !ast_strlen_zero(name) && (sscanf(id, "%30d", &rtp_id) == 1)) {
1849                         ast_rtp_codecs_payloads_set_m_type(&codecs, NULL, rtp_id);
1850
1851                         if (!ast_strlen_zero(clockrate) && (sscanf(clockrate, "%30d", &rtp_clockrate) == 1)) {
1852                                 ast_rtp_codecs_payloads_set_rtpmap_type_rate(&codecs, NULL, rtp_id, media, name, 0, rtp_clockrate);
1853                         } else {
1854                                 ast_rtp_codecs_payloads_set_rtpmap_type(&codecs, NULL, rtp_id, media, name, 0);
1855                         }
1856                 }
1857         }
1858
1859         ast_rtp_codecs_payload_formats(&codecs, session->peercap, &othercapability);
1860         ast_format_cap_joint_append(session->cap, session->peercap, session->jointcap);
1861
1862         if (ast_format_cap_is_empty(session->jointcap)) {
1863                 /* We have no compatible codecs, so terminate the session appropriately */
1864                 jingle_queue_hangup_with_cause(session, AST_CAUSE_BEARERCAPABILITY_NOTAVAIL);
1865                 return -1;
1866         }
1867
1868         ast_rtp_codecs_payloads_copy(&codecs, ast_rtp_instance_get_codecs(*rtp), *rtp);
1869
1870         return 0;
1871 }
1872
1873 /*! \brief Helper function which handles ICE-UDP transport information */
1874 static int jingle_interpret_ice_udp_transport(struct jingle_session *session, iks *transport, struct ast_rtp_instance *rtp)
1875 {
1876         struct ast_rtp_engine_ice *ice = ast_rtp_instance_get_ice(rtp);
1877         char *ufrag = iks_find_attrib(transport, "ufrag"), *pwd = iks_find_attrib(transport, "pwd");
1878         iks *candidate;
1879
1880         if (!ice) {
1881                 jingle_queue_hangup_with_cause(session, AST_CAUSE_SWITCH_CONGESTION);
1882                 ast_log(LOG_ERROR, "Received ICE-UDP transport information on session '%s' but ICE support not available\n", session->sid);
1883                 return -1;
1884         }
1885
1886         if (ast_strlen_zero(ufrag) || ast_strlen_zero(pwd)) {
1887                 jingle_queue_hangup_with_cause(session, AST_CAUSE_PROTOCOL_ERROR);
1888                 ast_log(LOG_ERROR, "Invalid ICE-UDP transport information received on session '%s', ufrag or pwd not present\n", session->sid);
1889                 return -1;
1890         }
1891
1892         ice->set_authentication(rtp, ufrag, pwd);
1893
1894         for (candidate = iks_child(transport); candidate; candidate = iks_next(candidate)) {
1895                 char *component = iks_find_attrib(candidate, "component"), *foundation = iks_find_attrib(candidate, "foundation");
1896                 char *generation = iks_find_attrib(candidate, "generation"), *id = iks_find_attrib(candidate, "id");
1897                 char *ip = iks_find_attrib(candidate, "ip"), *network = iks_find_attrib(candidate, "network");
1898                 char *port = iks_find_attrib(candidate, "port"), *priority = iks_find_attrib(candidate, "priority");
1899                 char *protocol = iks_find_attrib(candidate, "protocol"), *type = iks_find_attrib(candidate, "type");
1900                 struct ast_rtp_engine_ice_candidate local_candidate = { 0, };
1901                 int real_port;
1902                 struct ast_sockaddr remote_address = { { 0, } };
1903
1904                 /* If this candidate is incomplete skip it */
1905                 if (ast_strlen_zero(component) || ast_strlen_zero(foundation) || ast_strlen_zero(generation) || ast_strlen_zero(id) ||
1906                     ast_strlen_zero(ip) || ast_strlen_zero(network) || ast_strlen_zero(port) || ast_strlen_zero(priority) ||
1907                     ast_strlen_zero(protocol) || ast_strlen_zero(type)) {
1908                         jingle_queue_hangup_with_cause(session, AST_CAUSE_PROTOCOL_ERROR);
1909                         ast_log(LOG_ERROR, "Incomplete ICE-UDP candidate received on session '%s'\n", session->sid);
1910                         return -1;
1911                 }
1912
1913                 if ((sscanf(component, "%30u", &local_candidate.id) != 1) ||
1914                     (sscanf(priority, "%30u", &local_candidate.priority) != 1) ||
1915                     (sscanf(port, "%30d", &real_port) != 1)) {
1916                         jingle_queue_hangup_with_cause(session, AST_CAUSE_PROTOCOL_ERROR);
1917                         ast_log(LOG_ERROR, "Invalid ICE-UDP candidate information received on session '%s'\n", session->sid);
1918                         return -1;
1919                 }
1920
1921                 local_candidate.foundation = foundation;
1922                 local_candidate.transport = protocol;
1923
1924                 ast_sockaddr_parse(&local_candidate.address, ip, PARSE_PORT_FORBID);
1925
1926                 /* We only support IPv4 right now */
1927                 if (!ast_sockaddr_is_ipv4(&local_candidate.address)) {
1928                         continue;
1929                 }
1930
1931                 ast_sockaddr_set_port(&local_candidate.address, real_port);
1932
1933                 if (!strcasecmp(type, "host")) {
1934                         local_candidate.type = AST_RTP_ICE_CANDIDATE_TYPE_HOST;
1935                 } else if (!strcasecmp(type, "srflx")) {
1936                         local_candidate.type = AST_RTP_ICE_CANDIDATE_TYPE_SRFLX;
1937                 } else if (!strcasecmp(type, "relay")) {
1938                         local_candidate.type = AST_RTP_ICE_CANDIDATE_TYPE_RELAYED;
1939                 } else {
1940                         continue;
1941                 }
1942
1943                 /* Worst case use the first viable address */
1944                 ast_rtp_instance_get_remote_address(rtp, &remote_address);
1945
1946                 if (ast_sockaddr_is_ipv4(&local_candidate.address) && ast_sockaddr_isnull(&remote_address)) {
1947                         ast_rtp_instance_set_remote_address(rtp, &local_candidate.address);
1948                 }
1949
1950                 ice->add_remote_candidate(rtp, &local_candidate);
1951         }
1952
1953         ice->start(rtp);
1954
1955         return 0;
1956 }
1957
1958 /*! \brief Helper function which handles Google transport information */
1959 static int jingle_interpret_google_transport(struct jingle_session *session, iks *transport, struct ast_rtp_instance *rtp)
1960 {
1961         struct ast_rtp_engine_ice *ice = ast_rtp_instance_get_ice(rtp);
1962         iks *candidate;
1963
1964         if (!ice) {
1965                 jingle_queue_hangup_with_cause(session, AST_CAUSE_SWITCH_CONGESTION);
1966                 ast_log(LOG_ERROR, "Received Google transport information on session '%s' but ICE support not available\n", session->sid);
1967                 return -1;
1968         }
1969
1970         /* If this session has not transitioned to the Google transport do so now */
1971         if ((session->transport != JINGLE_TRANSPORT_GOOGLE_V2) &&
1972             (session->transport != JINGLE_TRANSPORT_GOOGLE_V1)) {
1973                 /* Stop built-in ICE support... we need to fall back to the old old old STUN */
1974                 ice->stop(rtp);
1975
1976                 session->transport = JINGLE_TRANSPORT_GOOGLE_V2;
1977         }
1978
1979         for (candidate = iks_child(transport); candidate; candidate = iks_next(candidate)) {
1980                 char *address = iks_find_attrib(candidate, "address"), *port = iks_find_attrib(candidate, "port");
1981                 char *username = iks_find_attrib(candidate, "username"), *name = iks_find_attrib(candidate, "name");
1982                 char *protocol = iks_find_attrib(candidate, "protocol");
1983                 int real_port;
1984                 struct ast_sockaddr target = { { 0, } };
1985                 /* In Google land the combined value is 32 bytes */
1986                 char combined[33] = "";
1987
1988                 /* If this is NOT actually a candidate just skip it */
1989                 if (strcasecmp(iks_name(candidate), "candidate") &&
1990                     strcasecmp(iks_name(candidate), "p:candidate") &&
1991                     strcasecmp(iks_name(candidate), "ses:candidate")) {
1992                         continue;
1993                 }
1994
1995                 /* If this candidate is incomplete skip it */
1996                 if (ast_strlen_zero(address) || ast_strlen_zero(port) || ast_strlen_zero(username) ||
1997                     ast_strlen_zero(name)) {
1998                         jingle_queue_hangup_with_cause(session, AST_CAUSE_PROTOCOL_ERROR);
1999                         ast_log(LOG_ERROR, "Incomplete Google candidate received on session '%s'\n", session->sid);
2000                         return -1;
2001                 }
2002
2003                 /* We only support UDP so skip any other protocols */
2004                 if (!ast_strlen_zero(protocol) && strcasecmp(protocol, "udp")) {
2005                         continue;
2006                 }
2007
2008                 /* Parse the target information so we can send a STUN request to the candidate */
2009                 if (sscanf(port, "%30d", &real_port) != 1) {
2010                         jingle_queue_hangup_with_cause(session, AST_CAUSE_PROTOCOL_ERROR);
2011                         ast_log(LOG_ERROR, "Invalid Google candidate port '%s' received on session '%s'\n", port, session->sid);
2012                         return -1;
2013                 }
2014                 ast_sockaddr_parse(&target, address, PARSE_PORT_FORBID);
2015                 ast_sockaddr_set_port(&target, real_port);
2016
2017                 /* Per the STUN support Google talk uses combine the two usernames */
2018                 snprintf(combined, sizeof(combined), "%s%s", username, ice->get_ufrag(rtp));
2019
2020                 /* This should appease the masses... we will actually change the remote address when we get their STUN packet */
2021                 ast_rtp_instance_stun_request(rtp, &target, combined);
2022         }
2023
2024         return 0;
2025 }
2026
2027 /*!
2028  * \brief Helper function which locates content stanzas and interprets them
2029  *
2030  * \note The session *must not* be locked before calling this
2031  */
2032 static int jingle_interpret_content(struct jingle_session *session, ikspak *pak)
2033 {
2034         iks *content;
2035         unsigned int changed = 0;
2036         struct ast_channel *chan;
2037
2038         /* Look at the content in the session initiation */
2039         for (content = iks_child(iks_child(pak->x)); content; content = iks_next(content)) {
2040                 char *name = iks_find_attrib(content, "name");
2041                 struct ast_rtp_instance *rtp = NULL;
2042                 iks *description, *transport;
2043
2044                 if (session->transport != JINGLE_TRANSPORT_GOOGLE_V1) {
2045                         /* If this content stanza has no name consider it invalid and move on */
2046                         if (ast_strlen_zero(name) && !(name = iks_find_attrib(content, "jin:name"))) {
2047                                 jingle_queue_hangup_with_cause(session, AST_CAUSE_BEARERCAPABILITY_NOTAVAIL);
2048                                 ast_log(LOG_ERROR, "Received content without a name on session '%s'\n", session->sid);
2049                                 return -1;
2050                         }
2051
2052                         /* Try to pre-populate which RTP instance this content is relevant to */
2053                         if (!strcmp(session->audio_name, name)) {
2054                                 rtp = session->rtp;
2055                         } else if (!strcmp(session->video_name, name)) {
2056                                 rtp = session->vrtp;
2057                         }
2058                 } else {
2059                         /* Google-V1 has no concept of assocating things like the above does, so since we only support audio over it assume they want audio */
2060                         rtp = session->rtp;
2061                 }
2062
2063                 /* If description information is available use it */
2064                 if ((description = iks_find_with_attrib(content, "description", "xmlns", JINGLE_RTP_NS)) ||
2065                     (description = iks_find_with_attrib(content, "rtp:description", "xmlns:rtp", JINGLE_RTP_NS)) ||
2066                     (description = iks_find_with_attrib(pak->query, "description", "xmlns", GOOGLE_PHONE_NS)) ||
2067                     (description = iks_find_with_attrib(pak->query, "vid:description", "xmlns", GOOGLE_VIDEO_NS))) {
2068                         /* If we failed to do something with the content description abort immediately */
2069                         if (jingle_interpret_description(session, description, name, &rtp)) {
2070                                 return -1;
2071                         }
2072
2073                         /* If we successfully interpret the description then the codecs need updating */
2074                         changed = 1;
2075                 }
2076
2077                 /* If we get past the description handling and we still don't know what RTP instance this is for... it is unknown content */
2078                 if (!rtp) {
2079                         ast_log(LOG_ERROR, "Received a content stanza but have no RTP instance for it on session '%s'\n", session->sid);
2080                         jingle_queue_hangup_with_cause(session, AST_CAUSE_SWITCH_CONGESTION);
2081                         return -1;
2082                 }
2083
2084                 /* If ICE UDP transport information is available use it */
2085                 if ((transport = iks_find_with_attrib(content, "transport", "xmlns", JINGLE_ICE_UDP_NS))) {
2086                         if (jingle_interpret_ice_udp_transport(session, transport, rtp)) {
2087                                 return -1;
2088                         }
2089                 } else if ((transport = iks_find_with_attrib(content, "transport", "xmlns", GOOGLE_TRANSPORT_NS)) ||
2090                            (transport = iks_find_with_attrib(content, "p:transport", "xmlns:p", GOOGLE_TRANSPORT_NS)) ||
2091                            (transport = iks_find_with_attrib(pak->x, "session", "xmlns", GOOGLE_SESSION_NS)) ||
2092                            (transport = iks_find_with_attrib(pak->x, "ses:session", "xmlns:ses", GOOGLE_SESSION_NS))) {
2093                         /* If Google transport support is available use it */
2094                         if (jingle_interpret_google_transport(session, transport, rtp)) {
2095                                 return -1;
2096                         }
2097                 } else if (iks_find(content, "transport")) {
2098                         /* If this is a transport we do not support terminate the session as it probably won't work out in the end */
2099                         jingle_queue_hangup_with_cause(session, AST_CAUSE_FACILITY_NOT_IMPLEMENTED);
2100                         ast_log(LOG_ERROR, "Unsupported transport type received on session '%s'\n", session->sid);
2101                         return -1;
2102                 }
2103         }
2104
2105         if (!changed) {
2106                 return 0;
2107         }
2108
2109         if ((chan = jingle_session_lock_full(session))) {
2110                 struct ast_format fmt;
2111
2112                 ast_format_cap_copy(ast_channel_nativeformats(chan), session->jointcap);
2113                 ast_codec_choose(&session->prefs, session->jointcap, 1, &fmt);
2114                 ast_set_read_format(chan, &fmt);
2115                 ast_set_write_format(chan, &fmt);
2116
2117                 ast_channel_unlock(chan);
2118                 ast_channel_unref(chan);
2119         }
2120         ao2_unlock(session);
2121
2122         return 0;
2123 }
2124
2125 /*! \brief Handler function for the 'session-initiate' action */
2126 static void jingle_action_session_initiate(struct jingle_endpoint *endpoint, struct jingle_session *session, ikspak *pak)
2127 {
2128         char *sid;
2129         enum jingle_transport transport = JINGLE_TRANSPORT_NONE;
2130         struct ast_channel *chan;
2131         int res;
2132
2133         if (session) {
2134                 /* This is a duplicate session setup, so respond accordingly */
2135                 jingle_send_error_response(endpoint->connection, pak, "result", "out-of-order", NULL);
2136                 return;
2137         }
2138
2139         /* Retrieve the session identifier from the message, note that this may alter the transport */
2140         if ((sid = iks_find_attrib(pak->query, "id"))) {
2141                 /* The presence of the session identifier in the 'id' attribute tells us that this is Google-V1 as everything else uses 'sid' */
2142                 transport = JINGLE_TRANSPORT_GOOGLE_V1;
2143         } else if (!(sid = iks_find_attrib(pak->query, "sid"))) {
2144                 jingle_send_error_response(endpoint->connection, pak, "bad-request", NULL, NULL);
2145                 return;
2146         }
2147
2148         /* Create a new local session */
2149         if (!(session = jingle_alloc(endpoint, pak->from->full, sid))) {
2150                 jingle_send_error_response(endpoint->connection, pak, "cancel", "service-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'", NULL);
2151                 return;
2152         }
2153
2154         /* If we determined that the transport should change as a result of how we got the SID change it */
2155         if (transport != JINGLE_TRANSPORT_NONE) {
2156                 session->transport = transport;
2157         }
2158
2159         /* Create a new Asterisk channel using the above local session */
2160         if (!(chan = jingle_new(endpoint, session, AST_STATE_DOWN, pak->from->user, NULL, pak->from->full))) {
2161                 ao2_ref(session, -1);
2162                 jingle_send_error_response(endpoint->connection, pak, "cancel", "service-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'", NULL);
2163                 return;
2164         }
2165
2166         ao2_link(endpoint->state->sessions, session);
2167
2168         ast_setstate(chan, AST_STATE_RING);
2169         res = ast_pbx_start(chan);
2170
2171         switch (res) {
2172         case AST_PBX_FAILED:
2173                 ast_log(LOG_WARNING, "Failed to start PBX :(\n");
2174                 jingle_send_error_response(endpoint->connection, pak, "cancel", "service-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'", NULL);
2175                 session->gone = 1;
2176                 ast_hangup(chan);
2177                 break;
2178         case AST_PBX_CALL_LIMIT:
2179                 ast_log(LOG_WARNING, "Failed to start PBX (call limit reached) \n");
2180                 jingle_send_error_response(endpoint->connection, pak, "wait", "resource-constraint xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'", NULL);
2181                 ast_hangup(chan);
2182                 break;
2183         case AST_PBX_SUCCESS:
2184                 jingle_send_response(endpoint->connection, pak);
2185
2186                 /* Only send a transport-info message if we successfully interpreted the available content */
2187                 if (!jingle_interpret_content(session, pak)) {
2188                         jingle_send_transport_info(session, iks_find_attrib(pak->x, "from"));
2189                 }
2190                 break;
2191         }
2192 }
2193
2194 /*! \brief Handler function for the 'transport-info' action */
2195 static void jingle_action_transport_info(struct jingle_endpoint *endpoint, struct jingle_session *session, ikspak *pak)
2196 {
2197         if (!session) {
2198                 jingle_send_error_response(endpoint->connection, pak, "cancel", "item-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'",
2199                                            "unknown-session xmlns='urn:xmpp:jingle:errors:1'");
2200                 return;
2201         }
2202
2203         jingle_interpret_content(session, pak);
2204         jingle_send_response(endpoint->connection, pak);
2205 }
2206
2207 /*! \brief Handler function for the 'session-accept' action */
2208 static void jingle_action_session_accept(struct jingle_endpoint *endpoint, struct jingle_session *session, ikspak *pak)
2209 {
2210         struct ast_channel *chan;
2211
2212         if (!session) {
2213                 jingle_send_error_response(endpoint->connection, pak, "cancel", "item-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'",
2214                                            "unknown-session xmlns='urn:xmpp:jingle:errors:1'");
2215                 return;
2216         }
2217
2218
2219         jingle_interpret_content(session, pak);
2220
2221         if ((chan = jingle_session_lock_full(session))) {
2222                 ast_queue_control(chan, AST_CONTROL_ANSWER);
2223                 ast_channel_unlock(chan);
2224                 ast_channel_unref(chan);
2225         }
2226         ao2_unlock(session);
2227
2228         jingle_send_response(endpoint->connection, pak);
2229 }
2230
2231 /*! \brief Handler function for the 'session-info' action */
2232 static void jingle_action_session_info(struct jingle_endpoint *endpoint, struct jingle_session *session, ikspak *pak)
2233 {
2234         struct ast_channel *chan;
2235
2236         if (!session) {
2237                 jingle_send_error_response(endpoint->connection, pak, "cancel", "item-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'",
2238                                            "unknown-session xmlns='urn:xmpp:jingle:errors:1'");
2239                 return;
2240         }
2241
2242         if (!(chan = jingle_session_lock_full(session))) {
2243                 ao2_unlock(session);
2244                 jingle_send_response(endpoint->connection, pak);
2245                 return;
2246         }
2247
2248         if (iks_find_with_attrib(pak->query, "ringing", "xmlns", JINGLE_RTP_INFO_NS)) {
2249                 ast_queue_control(chan, AST_CONTROL_RINGING);
2250                 if (ast_channel_state(chan) != AST_STATE_UP) {
2251                         ast_setstate(chan, AST_STATE_RINGING);
2252                 }
2253         } else if (iks_find_with_attrib(pak->query, "hold", "xmlns", JINGLE_RTP_INFO_NS)) {
2254                 ast_queue_control(chan, AST_CONTROL_HOLD);
2255         } else if (iks_find_with_attrib(pak->query, "unhold", "xmlns", JINGLE_RTP_INFO_NS)) {
2256                 ast_queue_control(chan, AST_CONTROL_UNHOLD);
2257         }
2258
2259         ast_channel_unlock(chan);
2260         ast_channel_unref(chan);
2261         ao2_unlock(session);
2262
2263         jingle_send_response(endpoint->connection, pak);
2264 }
2265
2266 /*! \brief Handler function for the 'session-terminate' action */
2267 static void jingle_action_session_terminate(struct jingle_endpoint *endpoint, struct jingle_session *session, ikspak *pak)
2268 {
2269         struct ast_channel *chan;
2270         iks *reason, *text;
2271         int cause = AST_CAUSE_NORMAL;
2272
2273         if (!session) {
2274                 jingle_send_error_response(endpoint->connection, pak, "cancel", "item-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'",
2275                                            "unknown-session xmlns='urn:xmpp:jingle:errors:1'");
2276                 return;
2277         }
2278
2279         if (!(chan = jingle_session_lock_full(session))) {
2280                 ao2_unlock(session);
2281                 jingle_send_response(endpoint->connection, pak);
2282                 return;
2283         }
2284
2285         /* Pull the reason text from the session-terminate message and translate it into a cause code */
2286         if ((reason = iks_find(pak->query, "reason")) && (text = iks_child(reason))) {
2287                 int i;
2288
2289                 /* Get the appropriate cause code mapping for this reason */
2290                 for (i = 0; i < ARRAY_LEN(jingle_reason_mappings); i++) {
2291                         if (!strcasecmp(jingle_reason_mappings[i].reason, iks_name(text))) {
2292                                 cause = jingle_reason_mappings[i].cause;
2293                                 break;
2294                         }
2295                 }
2296         }
2297
2298         ast_debug(3, "Hanging up channel '%s' due to session terminate message with cause '%d'\n", ast_channel_name(chan), cause);
2299         ast_queue_hangup_with_cause(chan, cause);
2300         session->gone = 1;
2301
2302         ast_channel_unlock(chan);
2303         ast_channel_unref(chan);
2304         ao2_unlock(session);
2305
2306         jingle_send_response(endpoint->connection, pak);
2307 }
2308
2309 /*! \brief Callback for when a Jingle action is received from an endpoint */
2310 static int jingle_action_hook(void *data, ikspak *pak)
2311 {
2312         char *action;
2313         const char *sid = NULL;
2314         struct jingle_session *session = NULL;
2315         struct jingle_endpoint *endpoint = data;
2316         int i, handled = 0;
2317
2318         /* We accept both Jingle and Google-V1 */
2319         if (!(action = iks_find_attrib(pak->query, "action")) &&
2320             !(action = iks_find_attrib(pak->query, "type"))) {
2321                 /* This occurs if either receive a packet masquerading as Jingle or Google-V1 that is actually not OR we receive a response
2322                  * to a message that has no response hook. */
2323                 return IKS_FILTER_EAT;
2324         }
2325
2326         /* Bump the endpoint reference count up in case a reload occurs. Unfortunately the available synchronization between iksemel and us
2327          * does not permit us to make this completely safe. */
2328         ao2_ref(endpoint, +1);
2329
2330         /* If a Jingle session identifier is present use it */
2331         if (!(sid = iks_find_attrib(pak->query, "sid"))) {
2332                 /* If a Google-V1 session identifier is present use it */
2333                 sid = iks_find_attrib(pak->query, "id");
2334         }
2335
2336         /* If a session identifier was present in the message attempt to find the session, it is up to the action handler whether
2337          * this is required or not */
2338         if (!ast_strlen_zero(sid)) {
2339                 session = ao2_find(endpoint->state->sessions, sid, OBJ_KEY);
2340         }
2341
2342         /* Iterate through supported action handlers looking for one that is able to handle this */
2343         for (i = 0; i < ARRAY_LEN(jingle_action_handlers); i++) {
2344                 if (!strcasecmp(jingle_action_handlers[i].action, action)) {
2345                         jingle_action_handlers[i].handler(endpoint, session, pak);
2346                         handled = 1;
2347                         break;
2348                 }
2349         }
2350
2351         /* If no action handler is present for the action they sent us make it evident */
2352         if (!handled) {
2353                 ast_log(LOG_NOTICE, "Received action '%s' for session '%s' that has no handler\n", action, sid);
2354         }
2355
2356         /* If a session was successfully found for this message deref it now since the handler is done */
2357         if (session) {
2358                 ao2_ref(session, -1);
2359         }
2360
2361         ao2_ref(endpoint, -1);
2362
2363         return IKS_FILTER_EAT;
2364 }
2365
2366 /*! \brief Custom handler for groups */
2367 static int custom_group_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
2368 {
2369         struct jingle_endpoint *endpoint = obj;
2370
2371         if (!strcasecmp(var->name, "callgroup")) {
2372                 endpoint->callgroup = ast_get_group(var->value);
2373         } else if (!strcasecmp(var->name, "pickupgroup")) {
2374                 endpoint->pickupgroup = ast_get_group(var->value);
2375         } else {
2376                 return -1;
2377         }
2378
2379         return 0;
2380 }
2381
2382 /*! \brief Custom handler for connection */
2383 static int custom_connection_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
2384 {
2385         struct jingle_endpoint *endpoint = obj;
2386
2387         /* You might think... but Josh, shouldn't you do this in a prelink callback? Well I *could* but until the original is destroyed
2388          * this will not actually get called, so even if the config turns out to be bogus this is harmless.
2389          */
2390         if (!(endpoint->connection = ast_xmpp_client_find(var->value))) {
2391                 ast_log(LOG_ERROR, "Connection '%s' configured on endpoint '%s' could not be found\n", var->value, endpoint->name);
2392                 return -1;
2393         }
2394
2395         if (!(endpoint->rule = iks_filter_add_rule(endpoint->connection->filter, jingle_action_hook, endpoint,
2396                                                    IKS_RULE_TYPE, IKS_PAK_IQ,
2397                                                    IKS_RULE_NS, JINGLE_NS,
2398                                                    IKS_RULE_NS, GOOGLE_SESSION_NS,
2399                                                    IKS_RULE_DONE))) {
2400                 ast_log(LOG_ERROR, "Action hook could not be added to connection '%s' on endpoint '%s'\n", var->value, endpoint->name);
2401                 return -1;
2402         }
2403
2404         return 0;
2405 }
2406
2407 /*! \brief Custom handler for transport */
2408 static int custom_transport_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
2409 {
2410         struct jingle_endpoint *endpoint = obj;
2411
2412         if (!strcasecmp(var->value, "ice-udp")) {
2413                 endpoint->transport = JINGLE_TRANSPORT_ICE_UDP;
2414         } else if (!strcasecmp(var->value, "google")) {
2415                 endpoint->transport = JINGLE_TRANSPORT_GOOGLE_V2;
2416         } else if (!strcasecmp(var->value, "google-v1")) {
2417                 endpoint->transport = JINGLE_TRANSPORT_GOOGLE_V1;
2418         } else {
2419                 ast_log(LOG_WARNING, "Unknown transport type '%s' on endpoint '%s', defaulting to 'ice-udp'\n", var->value, endpoint->name);
2420                 endpoint->transport = JINGLE_TRANSPORT_ICE_UDP;
2421         }
2422
2423         return 0;
2424 }
2425
2426 /*! \brief Load module into PBX, register channel */
2427 static int load_module(void)
2428 {
2429         if (!(jingle_tech.capabilities = ast_format_cap_alloc())) {
2430                 return AST_MODULE_LOAD_DECLINE;
2431         }
2432
2433         if (aco_info_init(&cfg_info)) {
2434                 ast_log(LOG_ERROR, "Unable to intialize configuration for chan_motif.\n");
2435                 goto end;
2436         }
2437
2438         aco_option_register(&cfg_info, "context", ACO_EXACT, endpoint_options, "default", OPT_STRINGFIELD_T, 0, STRFLDSET(struct jingle_endpoint, context));
2439         aco_option_register_custom(&cfg_info, "callgroup", ACO_EXACT, endpoint_options, NULL, custom_group_handler, 0);
2440         aco_option_register_custom(&cfg_info, "pickupgroup", ACO_EXACT, endpoint_options, NULL, custom_group_handler, 0);
2441         aco_option_register(&cfg_info, "language", ACO_EXACT, endpoint_options, NULL, OPT_STRINGFIELD_T, 0, STRFLDSET(struct jingle_endpoint, language));
2442         aco_option_register(&cfg_info, "musicclass", ACO_EXACT, endpoint_options, NULL, OPT_STRINGFIELD_T, 0, STRFLDSET(struct jingle_endpoint, musicclass));
2443         aco_option_register(&cfg_info, "parkinglot", ACO_EXACT, endpoint_options, NULL, OPT_STRINGFIELD_T, 0, STRFLDSET(struct jingle_endpoint, parkinglot));
2444         aco_option_register(&cfg_info, "accountcode", ACO_EXACT, endpoint_options, NULL, OPT_STRINGFIELD_T, 0, STRFLDSET(struct jingle_endpoint, accountcode));
2445         aco_option_register(&cfg_info, "allow", ACO_EXACT, endpoint_options, "ulaw,alaw", OPT_CODEC_T, 1, FLDSET(struct jingle_endpoint, prefs, cap));
2446         aco_option_register(&cfg_info, "disallow", ACO_EXACT, endpoint_options, "all", OPT_CODEC_T, 0, FLDSET(struct jingle_endpoint, prefs, cap));
2447         aco_option_register_custom(&cfg_info, "connection", ACO_EXACT, endpoint_options, NULL, custom_connection_handler, 0);
2448         aco_option_register_custom(&cfg_info, "transport", ACO_EXACT, endpoint_options, NULL, custom_transport_handler, 0);
2449         aco_option_register(&cfg_info, "maxicecandidates", ACO_EXACT, endpoint_options, DEFAULT_MAX_ICE_CANDIDATES, OPT_UINT_T, PARSE_DEFAULT,
2450                             FLDSET(struct jingle_endpoint, maxicecandidates));
2451         aco_option_register(&cfg_info, "maxpayloads", ACO_EXACT, endpoint_options, DEFAULT_MAX_PAYLOADS, OPT_UINT_T, PARSE_DEFAULT,
2452                             FLDSET(struct jingle_endpoint, maxpayloads));
2453
2454         ast_format_cap_add_all_by_type(jingle_tech.capabilities, AST_FORMAT_TYPE_AUDIO);
2455
2456         if (aco_process_config(&cfg_info, 0)) {
2457                 ast_log(LOG_ERROR, "Unable to read config file motif.conf. Not loading module.\n");
2458                 goto end;
2459         }
2460
2461         if (!(sched = ast_sched_context_create())) {
2462                 ast_log(LOG_ERROR, "Unable to create scheduler context.\n");
2463                 goto end;
2464         }
2465
2466         if (ast_sched_start_thread(sched)) {
2467                 ast_log(LOG_ERROR, "Unable to create scheduler context thread.\n");
2468                 goto end;
2469         }
2470
2471         ast_rtp_glue_register(&jingle_rtp_glue);
2472
2473         if (ast_channel_register(&jingle_tech)) {
2474                 ast_log(LOG_ERROR, "Unable to register channel class %s\n", channel_type);
2475                 goto end;
2476         }
2477
2478         return 0;
2479
2480 end:
2481         ast_rtp_glue_unregister(&jingle_rtp_glue);
2482
2483         if (sched) {
2484                 ast_sched_context_destroy(sched);
2485         }
2486
2487         aco_info_destroy(&cfg_info);
2488
2489         return AST_MODULE_LOAD_FAILURE;
2490 }
2491
2492 /*! \brief Reload module */
2493 static int reload(void)
2494 {
2495         return aco_process_config(&cfg_info, 1);
2496 }
2497
2498 /*! \brief Unload the jingle channel from Asterisk */
2499 static int unload_module(void)
2500 {
2501         ast_channel_unregister(&jingle_tech);
2502         ast_rtp_glue_unregister(&jingle_rtp_glue);
2503         ast_sched_context_destroy(sched);
2504         aco_info_destroy(&cfg_info);
2505         ao2_global_obj_release(globals);
2506
2507         return 0;
2508 }
2509
2510 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Motif Jingle Channel Driver",
2511                 .load = load_module,
2512                 .unload = unload_module,
2513                 .reload = reload,
2514                 .load_pri = AST_MODPRI_CHANNEL_DRIVER,
2515                );