2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2005, Digium, Inc.
6 * Mark Spencer <markster@digium.com>
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.
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.
21 * \author Mark Spencer <markster@digium.com>
23 * \brief Local Proxy Channel
25 * \ingroup channel_drivers
31 #include <sys/socket.h>
36 #include <netinet/in.h>
37 #include <arpa/inet.h>
38 #include <sys/signal.h>
42 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
44 #include "asterisk/lock.h"
45 #include "asterisk/channel.h"
46 #include "asterisk/config.h"
47 #include "asterisk/logger.h"
48 #include "asterisk/module.h"
49 #include "asterisk/pbx.h"
50 #include "asterisk/options.h"
51 #include "asterisk/lock.h"
52 #include "asterisk/sched.h"
53 #include "asterisk/io.h"
54 #include "asterisk/rtp.h"
55 #include "asterisk/acl.h"
56 #include "asterisk/callerid.h"
57 #include "asterisk/file.h"
58 #include "asterisk/cli.h"
59 #include "asterisk/app.h"
60 #include "asterisk/musiconhold.h"
61 #include "asterisk/manager.h"
62 #include "asterisk/stringfields.h"
64 static const char desc[] = "Local Proxy Channel";
65 static const char tdesc[] = "Local Proxy Channel Driver";
68 AST_MUTEX_DEFINE_STATIC(usecnt_lock);
70 #define IS_OUTBOUND(a,b) (a == b->chan ? 1 : 0)
72 static struct ast_channel *local_request(const char *type, int format, void *data, int *cause);
73 static int local_digit(struct ast_channel *ast, char digit);
74 static int local_call(struct ast_channel *ast, char *dest, int timeout);
75 static int local_hangup(struct ast_channel *ast);
76 static int local_answer(struct ast_channel *ast);
77 static struct ast_frame *local_read(struct ast_channel *ast);
78 static int local_write(struct ast_channel *ast, struct ast_frame *f);
79 static int local_indicate(struct ast_channel *ast, int condition);
80 static int local_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
81 static int local_sendhtml(struct ast_channel *ast, int subclass, const char *data, int datalen);
83 /* PBX interface structure for channel registration */
84 static const struct ast_channel_tech local_tech = {
88 .requester = local_request,
89 .send_digit = local_digit,
91 .hangup = local_hangup,
92 .answer = local_answer,
95 .exception = local_read,
96 .indicate = local_indicate,
98 .send_html = local_sendhtml,
102 ast_mutex_t lock; /* Channel private lock */
103 char context[AST_MAX_CONTEXT]; /* Context to call */
104 char exten[AST_MAX_EXTENSION]; /* Extension to call */
105 int reqformat; /* Requested format */
106 int glaredetect; /* Detect glare on hangup */
107 int cancelqueue; /* Cancel queue */
108 int alreadymasqed; /* Already masqueraded */
109 int launchedpbx; /* Did we launch the PBX */
110 int nooptimization; /* Don't leave masq state */
111 struct ast_channel *owner; /* Master Channel */
112 struct ast_channel *chan; /* Outbound channel */
113 AST_LIST_ENTRY(local_pvt) list; /* Next entity */
116 static AST_LIST_HEAD_STATIC(locals, local_pvt);
118 static int local_queue_frame(struct local_pvt *p, int isoutbound, struct ast_frame *f, struct ast_channel *us)
120 struct ast_channel *other;
122 /* Recalculate outbound channel */
128 /* Set glare detection */
130 if (p->cancelqueue) {
131 /* We had a glare on the hangup. Forget all this business,
132 return and destroy p. */
133 ast_mutex_unlock(&p->lock);
134 ast_mutex_destroy(&p->lock);
142 if (ast_mutex_trylock(&other->lock)) {
143 /* Failed to lock. Release main lock and try again */
144 ast_mutex_unlock(&p->lock);
146 if (ast_mutex_unlock(&us->lock)) {
147 ast_log(LOG_WARNING, "%s wasn't locked while sending %d/%d\n",
148 us->name, f->frametype, f->subclass);
152 /* Wait just a bit */
154 /* Only we can destroy ourselves, so we can't disappear here */
156 ast_mutex_lock(&us->lock);
157 ast_mutex_lock(&p->lock);
160 ast_queue_frame(other, f);
161 ast_mutex_unlock(&other->lock);
166 static int local_answer(struct ast_channel *ast)
168 struct local_pvt *p = ast->tech_pvt;
172 ast_mutex_lock(&p->lock);
173 isoutbound = IS_OUTBOUND(ast, p);
175 /* Pass along answer since somebody answered us */
176 struct ast_frame answer = { AST_FRAME_CONTROL, AST_CONTROL_ANSWER };
177 res = local_queue_frame(p, isoutbound, &answer, ast);
179 ast_log(LOG_WARNING, "Huh? Local is being asked to answer?\n");
180 ast_mutex_unlock(&p->lock);
184 static void check_bridge(struct local_pvt *p, int isoutbound)
186 if (p->alreadymasqed || p->nooptimization)
188 if (!p->chan || !p->owner)
190 if (isoutbound&& p->chan->_bridge /* Not ast_bridged_channel! Only go one step! */ && !p->owner->readq) {
191 /* Masquerade bridged channel into owner */
192 /* Lock everything we need, one by one, and give up if
193 we can't get everything. Remember, we'll get another
194 chance in just a little bit */
195 if (!ast_mutex_trylock(&(p->chan->_bridge)->lock)) {
196 if (!p->chan->_bridge->_softhangup) {
197 if (!ast_mutex_trylock(&p->owner->lock)) {
198 if (!p->owner->_softhangup) {
199 ast_channel_masquerade(p->owner, p->chan->_bridge);
200 p->alreadymasqed = 1;
202 ast_mutex_unlock(&p->owner->lock);
204 ast_mutex_unlock(&(p->chan->_bridge)->lock);
207 } else if (!isoutbound && p->owner && p->owner->_bridge && p->chan && !p->chan->readq) {
208 /* Masquerade bridged channel into chan */
209 if (!ast_mutex_trylock(&(p->owner->_bridge)->lock)) {
210 if (!p->owner->_bridge->_softhangup) {
211 if (!ast_mutex_trylock(&p->chan->lock)) {
212 if (!p->chan->_softhangup) {
213 ast_channel_masquerade(p->chan, p->owner->_bridge);
214 p->alreadymasqed = 1;
216 ast_mutex_unlock(&p->chan->lock);
219 ast_mutex_unlock(&(p->owner->_bridge)->lock);
224 static struct ast_frame *local_read(struct ast_channel *ast)
226 return &ast_null_frame;
229 static int local_write(struct ast_channel *ast, struct ast_frame *f)
231 struct local_pvt *p = ast->tech_pvt;
235 /* Just queue for delivery to the other side */
236 ast_mutex_lock(&p->lock);
237 isoutbound = IS_OUTBOUND(ast, p);
238 if (f && (f->frametype == AST_FRAME_VOICE))
239 check_bridge(p, isoutbound);
240 if (!p->alreadymasqed)
241 res = local_queue_frame(p, isoutbound, f, ast);
243 ast_log(LOG_DEBUG, "Not posting to queue since already masked on '%s'\n", ast->name);
246 ast_mutex_unlock(&p->lock);
250 static int local_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
252 struct local_pvt *p = newchan->tech_pvt;
253 ast_mutex_lock(&p->lock);
255 if ((p->owner != oldchan) && (p->chan != oldchan)) {
256 ast_log(LOG_WARNING, "Old channel wasn't %p but was %p/%p\n", oldchan, p->owner, p->chan);
257 ast_mutex_unlock(&p->lock);
260 if (p->owner == oldchan)
264 ast_mutex_unlock(&p->lock);
268 static int local_indicate(struct ast_channel *ast, int condition)
270 struct local_pvt *p = ast->tech_pvt;
272 struct ast_frame f = { AST_FRAME_CONTROL, };
275 /* Queue up a frame representing the indication as a control frame */
276 ast_mutex_lock(&p->lock);
277 isoutbound = IS_OUTBOUND(ast, p);
278 f.subclass = condition;
279 res = local_queue_frame(p, isoutbound, &f, ast);
280 ast_mutex_unlock(&p->lock);
284 static int local_digit(struct ast_channel *ast, char digit)
286 struct local_pvt *p = ast->tech_pvt;
288 struct ast_frame f = { AST_FRAME_DTMF, };
291 ast_mutex_lock(&p->lock);
292 isoutbound = IS_OUTBOUND(ast, p);
294 res = local_queue_frame(p, isoutbound, &f, ast);
295 ast_mutex_unlock(&p->lock);
299 static int local_sendhtml(struct ast_channel *ast, int subclass, const char *data, int datalen)
301 struct local_pvt *p = ast->tech_pvt;
303 struct ast_frame f = { AST_FRAME_HTML, };
306 ast_mutex_lock(&p->lock);
307 isoutbound = IS_OUTBOUND(ast, p);
308 f.subclass = subclass;
309 f.data = (char *)data;
311 res = local_queue_frame(p, isoutbound, &f, ast);
312 ast_mutex_unlock(&p->lock);
316 /*! \brief Initiate new call, part of PBX interface
317 * dest is the dial string */
318 static int local_call(struct ast_channel *ast, char *dest, int timeout)
320 struct local_pvt *p = ast->tech_pvt;
322 struct ast_var_t *varptr = NULL, *new;
325 ast_mutex_lock(&p->lock);
327 p->chan->cid.cid_num = ast_strdup(p->owner->cid.cid_num);
328 p->chan->cid.cid_name = ast_strdup(p->owner->cid.cid_name);
329 p->chan->cid.cid_rdnis = ast_strdup(p->owner->cid.cid_rdnis);
330 p->chan->cid.cid_ani = ast_strdup(p->owner->cid.cid_ani);
332 ast_string_field_set(p->chan, language, p->owner->language);
333 ast_string_field_set(p->chan, accountcode, p->owner->accountcode);
334 p->chan->cdrflags = p->owner->cdrflags;
336 /* copy the channel variables from the incoming channel to the outgoing channel */
337 /* Note that due to certain assumptions, they MUST be in the same order */
338 AST_LIST_TRAVERSE(&p->owner->varshead, varptr, entries) {
339 namelen = strlen(varptr->name);
340 len = sizeof(struct ast_var_t) + namelen + strlen(varptr->value) + 2;
341 if ((new = ast_calloc(1, len))) {
342 memcpy(new, varptr, len);
343 new->value = &(new->name[0]) + namelen + 1;
344 AST_LIST_INSERT_TAIL(&p->chan->varshead, new, entries);
350 /* Start switch on sub channel */
351 res = ast_pbx_start(p->chan);
352 ast_mutex_unlock(&p->lock);
357 static void local_destroy(struct local_pvt *p)
359 struct local_pvt *cur;
361 AST_LIST_LOCK(&locals);
362 AST_LIST_TRAVERSE_SAFE_BEGIN(&locals, cur, list) {
364 AST_LIST_REMOVE_CURRENT(&locals, list);
365 ast_mutex_destroy(&cur->lock);
370 AST_LIST_TRAVERSE_SAFE_END
371 AST_LIST_UNLOCK(&locals);
373 ast_log(LOG_WARNING, "Unable ot find local '%s@%s' in local list\n", p->exten, p->context);
377 /*! \brief Hangup a call through the local proxy channel */
378 static int local_hangup(struct ast_channel *ast)
380 struct local_pvt *p = ast->tech_pvt;
382 struct ast_frame f = { AST_FRAME_CONTROL, AST_CONTROL_HANGUP };
383 struct ast_channel *ochan = NULL;
387 ast_mutex_lock(&p->lock);
388 isoutbound = IS_OUTBOUND(ast, p);
390 status = pbx_builtin_getvar_helper(p->chan, "DIALSTATUS");
391 if ((status) && (p->owner))
392 pbx_builtin_setvar_helper(p->owner, "CHANLOCALSTATUS", status);
397 ast->tech_pvt = NULL;
399 ast_mutex_lock(&usecnt_lock);
401 ast_mutex_unlock(&usecnt_lock);
403 if (!p->owner && !p->chan) {
404 /* Okay, done with the private part now, too. */
405 glaredetect = p->glaredetect;
406 /* If we have a queue holding, don't actually destroy p yet, but
407 let local_queue do it. */
410 ast_mutex_unlock(&p->lock);
411 /* Remove from list */
412 AST_LIST_LOCK(&locals);
413 AST_LIST_REMOVE(&locals, p, list);
414 AST_LIST_UNLOCK(&locals);
415 /* Grab / release lock just in case */
416 ast_mutex_lock(&p->lock);
417 ast_mutex_unlock(&p->lock);
420 ast_mutex_destroy(&p->lock);
425 if (p->chan && !p->launchedpbx)
426 /* Need to actually hangup since there is no PBX */
429 local_queue_frame(p, isoutbound, &f, NULL);
430 ast_mutex_unlock(&p->lock);
436 /*! \brief Create a call structure */
437 static struct local_pvt *local_alloc(char *data, int format)
439 struct local_pvt *tmp;
443 if (!(tmp = ast_calloc(1, sizeof(*tmp))))
446 ast_mutex_init(&tmp->lock);
447 strncpy(tmp->exten, data, sizeof(tmp->exten) - 1);
448 opts = strchr(tmp->exten, '/');
452 if (strchr(opts, 'n'))
453 tmp->nooptimization = 1;
455 c = strchr(tmp->exten, '@');
459 strncpy(tmp->context, c, sizeof(tmp->context) - 1);
461 strncpy(tmp->context, "default", sizeof(tmp->context) - 1);
462 tmp->reqformat = format;
463 if (!ast_exists_extension(NULL, tmp->context, tmp->exten, 1, NULL)) {
464 ast_log(LOG_NOTICE, "No such extension/context %s@%s creating local channel\n", tmp->exten, tmp->context);
465 ast_mutex_destroy(&tmp->lock);
470 AST_LIST_LOCK(&locals);
471 AST_LIST_INSERT_HEAD(&locals, tmp, list);
472 AST_LIST_UNLOCK(&locals);
478 /*! \brief Start new local channel */
479 static struct ast_channel *local_new(struct local_pvt *p, int state)
481 struct ast_channel *tmp, *tmp2;
482 int randnum = rand() & 0xffff;
484 tmp = ast_channel_alloc(1);
485 tmp2 = ast_channel_alloc(1);
488 ast_channel_free(tmp);
490 ast_channel_free(tmp2);
491 ast_log(LOG_WARNING, "Unable to allocate channel structure(s)\n");
495 tmp2->tech = tmp->tech = &local_tech;
496 tmp->nativeformats = p->reqformat;
497 tmp2->nativeformats = p->reqformat;
498 ast_string_field_build(tmp, name, "Local/%s@%s-%04x,1", p->exten, p->context, randnum);
499 ast_string_field_build(tmp2, name, "Local/%s@%s-%04x,2", p->exten, p->context, randnum);
500 ast_setstate(tmp, state);
501 ast_setstate(tmp2, AST_STATE_RING);
502 tmp->writeformat = p->reqformat;
503 tmp2->writeformat = p->reqformat;
504 tmp->rawwriteformat = p->reqformat;
505 tmp2->rawwriteformat = p->reqformat;
506 tmp->readformat = p->reqformat;
507 tmp2->readformat = p->reqformat;
508 tmp->rawreadformat = p->reqformat;
509 tmp2->rawreadformat = p->reqformat;
514 ast_mutex_lock(&usecnt_lock);
517 ast_mutex_unlock(&usecnt_lock);
518 ast_update_use_count();
519 ast_copy_string(tmp->context, p->context, sizeof(tmp->context));
520 ast_copy_string(tmp2->context, p->context, sizeof(tmp2->context));
521 ast_copy_string(tmp2->exten, p->exten, sizeof(tmp->exten));
529 /*! \brief Part of PBX interface */
530 static struct ast_channel *local_request(const char *type, int format, void *data, int *cause)
533 struct ast_channel *chan = NULL;
535 p = local_alloc(data, format);
537 chan = local_new(p, AST_STATE_DOWN);
541 /*! \brief CLI command "local show channels" */
542 static int locals_show(int fd, int argc, char **argv)
547 return RESULT_SHOWUSAGE;
548 if (AST_LIST_EMPTY(&locals))
549 ast_cli(fd, "No local channels in use\n");
550 AST_LIST_LOCK(&locals);
551 AST_LIST_TRAVERSE(&locals, p, list) {
552 ast_mutex_lock(&p->lock);
553 ast_cli(fd, "%s -- %s@%s\n", p->owner ? p->owner->name : "<unowned>", p->exten, p->context);
554 ast_mutex_unlock(&p->lock);
556 AST_LIST_UNLOCK(&locals);
557 return RESULT_SUCCESS;
560 static char show_locals_usage[] =
561 "Usage: local show channels\n"
562 " Provides summary information on active local proxy channels.\n";
564 static struct ast_cli_entry cli_show_locals = {
565 { "local", "show", "channels", NULL }, locals_show,
566 "Show status of local channels", show_locals_usage, NULL };
568 /*! \brief Load module into PBX, register channel */
571 /* Make sure we can register our channel type */
572 if (ast_channel_register(&local_tech)) {
573 ast_log(LOG_ERROR, "Unable to register channel class 'Local'\n");
576 ast_cli_register(&cli_show_locals);
580 /*! \brief Reload module */
586 /*! \brief Unload the local proxy channel from Asterisk */
591 /* First, take us out of the channel loop */
592 ast_cli_unregister(&cli_show_locals);
593 ast_channel_unregister(&local_tech);
594 if (!AST_LIST_LOCK(&locals)) {
595 /* Hangup all interfaces if they have an owner */
596 AST_LIST_TRAVERSE(&locals, p, list) {
598 ast_softhangup(p->owner, AST_SOFTHANGUP_APPUNLOAD);
600 AST_LIST_UNLOCK(&locals);
601 AST_LIST_HEAD_DESTROY(&locals);
603 ast_log(LOG_WARNING, "Unable to lock the monitor\n");
616 return ASTERISK_GPL_KEY;
621 return (char *) desc;