Create a universal exception handling extension, "e" (closes issue #9785)
[asterisk/asterisk.git] / main / pbx.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@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  * \brief Core PBX routines.
22  *
23  * \author Mark Spencer <markster@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <sys/types.h>
31 #include <string.h>
32 #include <unistd.h>
33 #include <stdlib.h>
34 #include <stdio.h>
35 #include <ctype.h>
36 #include <errno.h>
37 #include <time.h>
38 #include <sys/time.h>
39 #include <limits.h>
40 #if defined(HAVE_SYSINFO)
41 #include <sys/sysinfo.h>
42 #endif
43 #if defined(SOLARIS)
44 #include <sys/loadavg.h>
45 #endif
46
47 #include "asterisk/lock.h"
48 #include "asterisk/cli.h"
49 #include "asterisk/pbx.h"
50 #include "asterisk/channel.h"
51 #include "asterisk/options.h"
52 #include "asterisk/logger.h"
53 #include "asterisk/file.h"
54 #include "asterisk/callerid.h"
55 #include "asterisk/cdr.h"
56 #include "asterisk/config.h"
57 #include "asterisk/term.h"
58 #include "asterisk/manager.h"
59 #include "asterisk/ast_expr.h"
60 #include "asterisk/linkedlists.h"
61 #define SAY_STUBS       /* generate declarations and stubs for say methods */
62 #include "asterisk/say.h"
63 #include "asterisk/utils.h"
64 #include "asterisk/causes.h"
65 #include "asterisk/musiconhold.h"
66 #include "asterisk/app.h"
67 #include "asterisk/devicestate.h"
68 #include "asterisk/stringfields.h"
69 #include "asterisk/event.h"
70 #include "asterisk/module.h"
71
72 /*!
73  * \note I M P O R T A N T :
74  *
75  *              The speed of extension handling will likely be among the most important
76  * aspects of this PBX.  The switching scheme as it exists right now isn't
77  * terribly bad (it's O(N+M), where N is the # of extensions and M is the avg #
78  * of priorities, but a constant search time here would be great ;-)
79  *
80  */
81
82 #ifdef LOW_MEMORY
83 #define EXT_DATA_SIZE 256
84 #else
85 #define EXT_DATA_SIZE 8192
86 #endif
87
88 #define SWITCH_DATA_LENGTH 256
89
90 #define VAR_BUF_SIZE 4096
91
92 #define VAR_NORMAL              1
93 #define VAR_SOFTTRAN    2
94 #define VAR_HARDTRAN    3
95
96 #define BACKGROUND_SKIP         (1 << 0)
97 #define BACKGROUND_NOANSWER     (1 << 1)
98 #define BACKGROUND_MATCHEXTEN   (1 << 2)
99 #define BACKGROUND_PLAYBACK     (1 << 3)
100
101 AST_APP_OPTIONS(background_opts, {
102         AST_APP_OPTION('s', BACKGROUND_SKIP),
103         AST_APP_OPTION('n', BACKGROUND_NOANSWER),
104         AST_APP_OPTION('m', BACKGROUND_MATCHEXTEN),
105         AST_APP_OPTION('p', BACKGROUND_PLAYBACK),
106 });
107
108 #define WAITEXTEN_MOH           (1 << 0)
109
110 AST_APP_OPTIONS(waitexten_opts, {
111         AST_APP_OPTION_ARG('m', WAITEXTEN_MOH, 0),
112 });
113
114 struct ast_context;
115 struct ast_app;
116
117 /*!
118    \brief ast_exten: An extension
119         The dialplan is saved as a linked list with each context
120         having it's own linked list of extensions - one item per
121         priority.
122 */
123 struct ast_exten {
124         char *exten;                    /*!< Extension name */
125         int matchcid;                   /*!< Match caller id ? */
126         const char *cidmatch;           /*!< Caller id to match for this extension */
127         int priority;                   /*!< Priority */
128         const char *label;              /*!< Label */
129         struct ast_context *parent;     /*!< The context this extension belongs to  */
130         const char *app;                /*!< Application to execute */
131         struct ast_app *cached_app;     /*!< Cached location of application */
132         void *data;                     /*!< Data to use (arguments) */
133         void (*datad)(void *);          /*!< Data destructor */
134         struct ast_exten *peer;         /*!< Next higher priority with our extension */
135         const char *registrar;          /*!< Registrar */
136         struct ast_exten *next;         /*!< Extension with a greater ID */
137         char stuff[0];
138 };
139
140 /*! \brief ast_include: include= support in extensions.conf */
141 struct ast_include {
142         const char *name;
143         const char *rname;                      /*!< Context to include */
144         const char *registrar;                  /*!< Registrar */
145         int hastime;                            /*!< If time construct exists */
146         struct ast_timing timing;               /*!< time construct */
147         struct ast_include *next;               /*!< Link them together */
148         char stuff[0];
149 };
150
151 /*! \brief ast_sw: Switch statement in extensions.conf */
152 struct ast_sw {
153         char *name;
154         const char *registrar;                  /*!< Registrar */
155         char *data;                             /*!< Data load */
156         int eval;
157         AST_LIST_ENTRY(ast_sw) list;
158         char *tmpdata;
159         char stuff[0];
160 };
161
162 /*! \brief ast_ignorepat: Ignore patterns in dial plan */
163 struct ast_ignorepat {
164         const char *registrar;
165         struct ast_ignorepat *next;
166         const char pattern[0];
167 };
168
169 /*! \brief ast_context: An extension context */
170 struct ast_context {
171         ast_rwlock_t lock;                      /*!< A lock to prevent multiple threads from clobbering the context */
172         struct ast_exten *root;                 /*!< The root of the list of extensions */
173         struct ast_context *next;               /*!< Link them together */
174         struct ast_include *includes;           /*!< Include other contexts */
175         struct ast_ignorepat *ignorepats;       /*!< Patterns for which to continue playing dialtone */
176         const char *registrar;                  /*!< Registrar */
177         AST_LIST_HEAD_NOLOCK(, ast_sw) alts;    /*!< Alternative switches */
178         ast_mutex_t macrolock;                  /*!< A lock to implement "exclusive" macros - held whilst a call is executing in the macro */
179         char name[0];                           /*!< Name of the context */
180 };
181
182
183 /*! \brief ast_app: A registered application */
184 struct ast_app {
185         int (*execute)(struct ast_channel *chan, void *data);
186         const char *synopsis;                   /*!< Synopsis text for 'show applications' */
187         const char *description;                /*!< Description (help text) for 'show application &lt;name&gt;' */
188         AST_RWLIST_ENTRY(ast_app) list;         /*!< Next app in list */
189         struct ast_module *module;              /*!< Module this app belongs to */
190         char name[0];                           /*!< Name of the application */
191 };
192
193 /*! \brief ast_state_cb: An extension state notify register item */
194 struct ast_state_cb {
195         int id;
196         void *data;
197         ast_state_cb_type callback;
198         struct ast_state_cb *next;
199 };
200
201 /*! \brief Structure for dial plan hints
202
203   \note Hints are pointers from an extension in the dialplan to one or
204   more devices (tech/name) 
205         - See \ref AstExtState
206 */
207 struct ast_hint {
208         struct ast_exten *exten;        /*!< Extension */
209         int laststate;                  /*!< Last known state */
210         struct ast_state_cb *callbacks; /*!< Callback list for this extension */
211         AST_RWLIST_ENTRY(ast_hint) list;/*!< Pointer to next hint in list */
212 };
213
214 static const struct cfextension_states {
215         int extension_state;
216         const char * const text;
217 } extension_states[] = {
218         { AST_EXTENSION_NOT_INUSE,                     "Idle" },
219         { AST_EXTENSION_INUSE,                         "InUse" },
220         { AST_EXTENSION_BUSY,                          "Busy" },
221         { AST_EXTENSION_UNAVAILABLE,                   "Unavailable" },
222         { AST_EXTENSION_RINGING,                       "Ringing" },
223         { AST_EXTENSION_INUSE | AST_EXTENSION_RINGING, "InUse&Ringing" },
224         { AST_EXTENSION_ONHOLD,                        "Hold" },
225         { AST_EXTENSION_INUSE | AST_EXTENSION_ONHOLD,  "InUse&Hold" }
226 };
227
228 struct statechange {
229         AST_LIST_ENTRY(statechange) entry;
230         char dev[0];
231 };
232
233 /*!
234  * \brief Data used by the device state thread
235  */
236 static struct {
237         /*! Set to 1 to stop the thread */
238         unsigned int stop:1;
239         /*! The device state monitoring thread */
240         pthread_t thread;
241         /*! Lock for the state change queue */
242         ast_mutex_t lock;
243         /*! Condition for the state change queue */
244         ast_cond_t cond;
245         /*! Queue of state changes */
246         AST_LIST_HEAD_NOLOCK(, statechange) state_change_q;
247 } device_state = {
248         .thread = AST_PTHREADT_NULL,
249 };
250
251 struct pbx_exception {
252         AST_DECLARE_STRING_FIELDS(
253                 AST_STRING_FIELD(context);      /*!< Context associated with this exception */
254                 AST_STRING_FIELD(exten);        /*!< Exten associated with this exception */
255                 AST_STRING_FIELD(type);         /*!< The type of exception */
256         );
257
258         int priority;                           /*!< Priority associated with this exception */
259 };
260
261 static int pbx_builtin_answer(struct ast_channel *, void *);
262 static int pbx_builtin_goto(struct ast_channel *, void *);
263 static int pbx_builtin_hangup(struct ast_channel *, void *);
264 static int pbx_builtin_background(struct ast_channel *, void *);
265 static int pbx_builtin_wait(struct ast_channel *, void *);
266 static int pbx_builtin_waitexten(struct ast_channel *, void *);
267 static int pbx_builtin_keepalive(struct ast_channel *, void *);
268 static int pbx_builtin_resetcdr(struct ast_channel *, void *);
269 static int pbx_builtin_setamaflags(struct ast_channel *, void *);
270 static int pbx_builtin_ringing(struct ast_channel *, void *);
271 static int pbx_builtin_progress(struct ast_channel *, void *);
272 static int pbx_builtin_congestion(struct ast_channel *, void *);
273 static int pbx_builtin_busy(struct ast_channel *, void *);
274 static int pbx_builtin_noop(struct ast_channel *, void *);
275 static int pbx_builtin_gotoif(struct ast_channel *, void *);
276 static int pbx_builtin_gotoiftime(struct ast_channel *, void *);
277 static int pbx_builtin_execiftime(struct ast_channel *, void *);
278 static int pbx_builtin_saynumber(struct ast_channel *, void *);
279 static int pbx_builtin_saydigits(struct ast_channel *, void *);
280 static int pbx_builtin_saycharacters(struct ast_channel *, void *);
281 static int pbx_builtin_sayphonetic(struct ast_channel *, void *);
282 int pbx_builtin_setvar(struct ast_channel *, void *);
283 static int pbx_builtin_setvar_multiple(struct ast_channel *, void *);
284 static int pbx_builtin_importvar(struct ast_channel *, void *);
285 static void set_ext_pri(struct ast_channel *c, const char *exten, int pri);
286
287 AST_RWLOCK_DEFINE_STATIC(globalslock);
288 static struct varshead globals = AST_LIST_HEAD_NOLOCK_INIT_VALUE;
289
290 static int autofallthrough = 1;
291
292 /*! \brief Subscription for device state change events */
293 static struct ast_event_sub *device_state_sub;
294
295 AST_MUTEX_DEFINE_STATIC(maxcalllock);
296 static int countcalls;
297
298 static AST_RWLIST_HEAD_STATIC(acf_root, ast_custom_function);
299
300 /*! \brief Declaration of builtin applications */
301 static struct pbx_builtin {
302         char name[AST_MAX_APP];
303         int (*execute)(struct ast_channel *chan, void *data);
304         char *synopsis;
305         char *description;
306 } builtins[] =
307 {
308         /* These applications are built into the PBX core and do not
309            need separate modules */
310
311         { "Answer", pbx_builtin_answer,
312         "Answer a channel if ringing",
313         "  Answer([delay]): If the call has not been answered, this application will\n"
314         "answer it. Otherwise, it has no effect on the call. If a delay is specified,\n"
315         "Asterisk will wait this number of milliseconds before returning to\n"
316         "the dialplan after answering the call.\n"
317         },
318
319         { "BackGround", pbx_builtin_background,
320         "Play an audio file while waiting for digits of an extension to go to.",
321         "  Background(filename1[&filename2...][,options[,langoverride][,context]]):\n"
322         "This application will play the given list of files while waiting for an\n"
323         "extension to be dialed by the calling channel. To continue waiting for digits\n"
324         "after this application has finished playing files, the WaitExten application\n"
325         "should be used. The 'langoverride' option explicitly specifies which language\n"
326         "to attempt to use for the requested sound files. If a 'context' is specified,\n"
327         "this is the dialplan context that this application will use when exiting to a\n"
328         "dialed extension."
329         "  If one of the requested sound files does not exist, call processing will be\n"
330         "terminated.\n"
331         "  Options:\n"
332         "    s - Causes the playback of the message to be skipped\n"
333         "          if the channel is not in the 'up' state (i.e. it\n"
334         "          hasn't been answered yet). If this happens, the\n"
335         "          application will return immediately.\n"
336         "    n - Don't answer the channel before playing the files.\n"
337         "    m - Only break if a digit hit matches a one digit\n"
338         "          extension in the destination context.\n"
339         "This application sets the following channel variable upon completion:\n"
340         " BACKGROUNDSTATUS    The status of the background attempt as a text string, one of\n"
341         "               SUCCESS | FAILED\n"
342         },
343
344         { "Busy", pbx_builtin_busy,
345         "Indicate the Busy condition",
346         "  Busy([timeout]): This application will indicate the busy condition to\n"
347         "the calling channel. If the optional timeout is specified, the calling channel\n"
348         "will be hung up after the specified number of seconds. Otherwise, this\n"
349         "application will wait until the calling channel hangs up.\n"
350         },
351
352         { "Congestion", pbx_builtin_congestion,
353         "Indicate the Congestion condition",
354         "  Congestion([timeout]): This application will indicate the congestion\n"
355         "condition to the calling channel. If the optional timeout is specified, the\n"
356         "calling channel will be hung up after the specified number of seconds.\n"
357         "Otherwise, this application will wait until the calling channel hangs up.\n"
358         },
359
360         { "ExecIfTime", pbx_builtin_execiftime,
361         "Conditional application execution based on the current time",
362         "  ExecIfTime(<times>,<weekdays>,<mdays>,<months>?appname[(appargs)]):\n"
363         "This application will execute the specified dialplan application, with optional\n"
364         "arguments, if the current time matches the given time specification.\n"
365         },
366
367         { "Goto", pbx_builtin_goto,
368         "Jump to a particular priority, extension, or context",
369         "  Goto([[context,]extension,]priority): This application will set the current\n"
370         "context, extension, and priority in the channel structure. After it completes, the\n"
371         "pbx engine will continue dialplan execution at the specified location.\n"
372         "If no specific extension, or extension and context, are specified, then this\n"
373         "application will just set the specified priority of the current extension.\n"
374         "  At least a priority is required as an argument, or the goto will return a -1,\n"
375         "and the channel and call will be terminated.\n"
376         "  If the location that is put into the channel information is bogus, and asterisk cannot\n"
377         "find that location in the dialplan,\n"
378         "then the execution engine will try to find and execute the code in the 'i' (invalid)\n"
379         "extension in the current context. If that does not exist, it will try to execute the\n"
380         "'h' extension. If either or neither the 'h' or 'i' extensions have been defined, the\n"
381         "channel is hung up, and the execution of instructions on the channel is terminated.\n"
382         "What this means is that, for example, you specify a context that does not exist, then\n"
383         "it will not be possible to find the 'h' or 'i' extensions, and the call will terminate!\n"
384         },
385
386         { "GotoIf", pbx_builtin_gotoif,
387         "Conditional goto",
388         "  GotoIf(condition?[labeliftrue]:[labeliffalse]): This application will set the current\n"
389         "context, extension, and priority in the channel structure based on the evaluation of\n"
390         "the given condition. After this application completes, the\n"
391         "pbx engine will continue dialplan execution at the specified location in the dialplan.\n"
392         "The channel will continue at\n"
393         "'labeliftrue' if the condition is true, or 'labeliffalse' if the condition is\n"
394         "false. The labels are specified with the same syntax as used within the Goto\n"
395         "application.  If the label chosen by the condition is omitted, no jump is\n"
396         "performed, and the execution passes to the next instruction.\n"
397         "If the target location is bogus, and does not exist, the execution engine will try \n"
398         "to find and execute the code in the 'i' (invalid)\n"
399         "extension in the current context. If that does not exist, it will try to execute the\n"
400         "'h' extension. If either or neither the 'h' or 'i' extensions have been defined, the\n"
401         "channel is hung up, and the execution of instructions on the channel is terminated.\n"
402         "Remember that this command can set the current context, and if the context specified\n"
403         "does not exist, then it will not be able to find any 'h' or 'i' extensions there, and\n"
404         "the channel and call will both be terminated!\n"
405         },
406
407         { "GotoIfTime", pbx_builtin_gotoiftime,
408         "Conditional Goto based on the current time",
409         "  GotoIfTime(<times>,<weekdays>,<mdays>,<months>?[[context,]exten,]priority):\n"
410         "This application will set the context, extension, and priority in the channel structure\n"
411         "if the current time matches the given time specification. Otherwise, nothing is done.\n"
412         "Further information on the time specification can be found in examples\n"
413         "illustrating how to do time-based context includes in the dialplan.\n" 
414         "If the target jump location is bogus, the same actions would be taken as for Goto.\n"
415         },
416
417         { "ImportVar", pbx_builtin_importvar,
418         "Import a variable from a channel into a new variable",
419         "  ImportVar(newvar=channelname,variable): This application imports a variable\n"
420         "from the specified channel (as opposed to the current one) and stores it as\n"
421         "a variable in the current channel (the channel that is calling this\n"
422         "application). Variables created by this application have the same inheritance\n"
423         "properties as those created with the Set application. See the documentation for\n"
424         "Set for more information.\n"
425         },
426
427         { "Hangup", pbx_builtin_hangup,
428         "Hang up the calling channel",
429         "  Hangup([causecode]): This application will hang up the calling channel.\n"
430         "If a causecode is given the channel's hangup cause will be set to the given\n"
431         "value.\n"
432         },
433
434         { "NoOp", pbx_builtin_noop,
435         "Do Nothing",
436         "  NoOp(): This applicatiion does nothing. However, it is useful for debugging\n"
437         "purposes. Any text that is provided as arguments to this application can be\n"
438         "viewed at the Asterisk CLI. This method can be used to see the evaluations of\n"
439         "variables or functions without having any effect."
440         },
441
442         { "Progress", pbx_builtin_progress,
443         "Indicate progress",
444         "  Progress(): This application will request that in-band progress information\n"
445         "be provided to the calling channel.\n"
446         },
447
448         { "RaiseException", pbx_builtin_raise_exception,
449         "Handle an exceptional condition",
450         "  RaiseException(<reason>): This application will jump to the \"e\" extension\n"
451         "in the current context, setting the dialplan function EXCEPTION().  If the \"e\"\n"
452         "extension does not exist, the call will hangup.\n"
453         },
454
455         { "ResetCDR", pbx_builtin_resetcdr,
456         "Resets the Call Data Record",
457         "  ResetCDR([options]):  This application causes the Call Data Record to be\n"
458         "reset.\n"
459         "  Options:\n"
460         "    w -- Store the current CDR record before resetting it.\n"
461         "    a -- Store any stacked records.\n"
462         "    v -- Save CDR variables.\n"
463         },
464
465         { "Ringing", pbx_builtin_ringing,
466         "Indicate ringing tone",
467         "  Ringing(): This application will request that the channel indicate a ringing\n"
468         "tone to the user.\n"
469         },
470
471         { "SayAlpha", pbx_builtin_saycharacters,
472         "Say Alpha",
473         "  SayAlpha(string): This application will play the sounds that correspond to\n"
474         "the letters of the given string.\n"
475         },
476
477         { "SayDigits", pbx_builtin_saydigits,
478         "Say Digits",
479         "  SayDigits(digits): This application will play the sounds that correspond\n"
480         "to the digits of the given number. This will use the language that is currently\n"
481         "set for the channel. See the LANGUAGE function for more information on setting\n"
482         "the language for the channel.\n"
483         },
484
485         { "SayNumber", pbx_builtin_saynumber,
486         "Say Number",
487         "  SayNumber(digits[,gender]): This application will play the sounds that\n"
488         "correspond to the given number. Optionally, a gender may be specified.\n"
489         "This will use the language that is currently set for the channel. See the\n"
490         "LANGUAGE function for more information on setting the language for the channel.\n"
491         },
492
493         { "SayPhonetic", pbx_builtin_sayphonetic,
494         "Say Phonetic",
495         "  SayPhonetic(string): This application will play the sounds from the phonetic\n"
496         "alphabet that correspond to the letters in the given string.\n"
497         },
498
499         { "Set", pbx_builtin_setvar,
500         "Set channel variable or function value",
501         "  Set(name=value)\n"
502         "This function can be used to set the value of channel variables or dialplan\n"
503         "functions. When setting variables, if the variable name is prefixed with _,\n"
504         "the variable will be inherited into channels created from the current\n"
505         "channel. If the variable name is prefixed with __, the variable will be\n"
506         "inherited into channels created from the current channel and all children\n"
507         "channels.\n"
508         },
509
510         { "MSet", pbx_builtin_setvar_multiple,
511         "Set channel variable(s) or function value(s)",
512         "  MSet(name1=value1,name2=value2,...)\n"
513         "This function can be used to set the value of channel variables or dialplan\n"
514         "functions. When setting variables, if the variable name is prefixed with _,\n"
515         "the variable will be inherited into channels created from the current\n"
516         "channel. If the variable name is prefixed with __, the variable will be\n"
517         "inherited into channels created from the current channel and all children\n"
518         "channels.\n\n"
519         "MSet behaves in a similar fashion to the way Set worked in 1.2/1.4 and is thus\n"
520         "prone to doing things that you may not expect.  Avoid its use if possible.\n"
521         },
522
523         { "SetAMAFlags", pbx_builtin_setamaflags,
524         "Set the AMA Flags",
525         "  SetAMAFlags([flag]): This application will set the channel's AMA Flags for\n"
526         "  billing purposes.\n"
527         },
528
529         { "Wait", pbx_builtin_wait,
530         "Waits for some time",
531         "  Wait(seconds): This application waits for a specified number of seconds.\n"
532         "Then, dialplan execution will continue at the next priority.\n"
533         "  Note that the seconds can be passed with fractions of a second. For example,\n"
534         "'1.5' will ask the application to wait for 1.5 seconds.\n"
535         },
536
537         { "WaitExten", pbx_builtin_waitexten,
538         "Waits for an extension to be entered",
539         "  WaitExten([seconds][,options]): This application waits for the user to enter\n"
540         "a new extension for a specified number of seconds.\n"
541         "  Note that the seconds can be passed with fractions of a second. For example,\n"
542         "'1.5' will ask the application to wait for 1.5 seconds.\n"
543         "  Options:\n"
544         "    m[(x)] - Provide music on hold to the caller while waiting for an extension.\n"
545         "               Optionally, specify the class for music on hold within parenthesis.\n"
546         },
547
548         { "KeepAlive", pbx_builtin_keepalive,
549         "returns AST_PBX_KEEPALIVE value",
550         "  KeepAlive(): This application is chiefly meant for internal use with Gosubs.\n"
551         "Please do not run it alone from the dialplan!\n"
552         },
553
554 };
555
556 static struct ast_context *contexts;
557 AST_RWLOCK_DEFINE_STATIC(conlock);              /*!< Lock for the ast_context list */
558
559 static AST_RWLIST_HEAD_STATIC(apps, ast_app);
560
561 static AST_RWLIST_HEAD_STATIC(switches, ast_switch);
562
563 static int stateid = 1;
564 /* WARNING:
565    When holding this list's lock, do _not_ do anything that will cause conlock
566    to be taken, unless you _already_ hold it. The ast_merge_contexts_and_delete
567    function will take the locks in conlock/hints order, so any other
568    paths that require both locks must also take them in that order.
569 */
570 static AST_RWLIST_HEAD_STATIC(hints, ast_hint);
571 struct ast_state_cb *statecbs;
572
573 /*
574    \note This function is special. It saves the stack so that no matter
575    how many times it is called, it returns to the same place */
576 int pbx_exec(struct ast_channel *c,             /*!< Channel */
577              struct ast_app *app,               /*!< Application */
578              void *data)                        /*!< Data for execution */
579 {
580         int res;
581         struct ast_module_user *u = NULL;
582         const char *saved_c_appl;
583         const char *saved_c_data;
584
585         if (c->cdr &&  !ast_check_hangup(c))
586                 ast_cdr_setapp(c->cdr, app->name, data);
587
588         /* save channel values */
589         saved_c_appl= c->appl;
590         saved_c_data= c->data;
591
592         c->appl = app->name;
593         c->data = data;
594         if (app->module)
595                 u = __ast_module_user_add(app->module, c);
596         res = app->execute(c, data);
597         if (app->module && u)
598                 __ast_module_user_remove(app->module, u);
599         /* restore channel values */
600         c->appl = saved_c_appl;
601         c->data = saved_c_data;
602         return res;
603 }
604
605
606 /*! Go no deeper than this through includes (not counting loops) */
607 #define AST_PBX_MAX_STACK       128
608
609 /*! \brief Find application handle in linked list
610  */
611 struct ast_app *pbx_findapp(const char *app)
612 {
613         struct ast_app *tmp;
614
615         AST_RWLIST_RDLOCK(&apps);
616         AST_RWLIST_TRAVERSE(&apps, tmp, list) {
617                 if (!strcasecmp(tmp->name, app))
618                         break;
619         }
620         AST_RWLIST_UNLOCK(&apps);
621
622         return tmp;
623 }
624
625 static struct ast_switch *pbx_findswitch(const char *sw)
626 {
627         struct ast_switch *asw;
628
629         AST_RWLIST_RDLOCK(&switches);
630         AST_RWLIST_TRAVERSE(&switches, asw, list) {
631                 if (!strcasecmp(asw->name, sw))
632                         break;
633         }
634         AST_RWLIST_UNLOCK(&switches);
635
636         return asw;
637 }
638
639 static inline int include_valid(struct ast_include *i)
640 {
641         if (!i->hastime)
642                 return 1;
643
644         return ast_check_timing(&(i->timing));
645 }
646
647 static void pbx_destroy(struct ast_pbx *p)
648 {
649         ast_free(p);
650 }
651
652 /*
653  * Special characters used in patterns:
654  *      '_'     underscore is the leading character of a pattern.
655  *              In other position it is treated as a regular char.
656  *      ' ' '-' space and '-' are separator and ignored.
657  *      .       one or more of any character. Only allowed at the end of
658  *              a pattern.
659  *      !       zero or more of anything. Also impacts the result of CANMATCH
660  *              and MATCHMORE. Only allowed at the end of a pattern.
661  *              In the core routine, ! causes a match with a return code of 2.
662  *              In turn, depending on the search mode: (XXX check if it is implemented)
663  *              - E_MATCH retuns 1 (does match)
664  *              - E_MATCHMORE returns 0 (no match)
665  *              - E_CANMATCH returns 1 (does match)
666  *
667  *      /       should not appear as it is considered the separator of the CID info.
668  *              XXX at the moment we may stop on this char.
669  *
670  *      X Z N   match ranges 0-9, 1-9, 2-9 respectively.
671  *      [       denotes the start of a set of character. Everything inside
672  *              is considered literally. We can have ranges a-d and individual
673  *              characters. A '[' and '-' can be considered literally if they
674  *              are just before ']'.
675  *              XXX currently there is no way to specify ']' in a range, nor \ is
676  *              considered specially.
677  *
678  * When we compare a pattern with a specific extension, all characters in the extension
679  * itself are considered literally with the only exception of '-' which is considered
680  * as a separator and thus ignored.
681  * XXX do we want to consider space as a separator as well ?
682  * XXX do we want to consider the separators in non-patterns as well ?
683  */
684
685 /*!
686  * \brief helper functions to sort extensions and patterns in the desired way,
687  * so that more specific patterns appear first.
688  *
689  * ext_cmp1 compares individual characters (or sets of), returning
690  * an int where bits 0-7 are the ASCII code of the first char in the set,
691  * while bit 8-15 are the cardinality of the set minus 1.
692  * This way more specific patterns (smaller cardinality) appear first.
693  * Wildcards have a special value, so that we can directly compare them to
694  * sets by subtracting the two values. In particular:
695  *      0x000xx         one character, xx
696  *      0x0yyxx         yy character set starting with xx
697  *      0x10000         '.' (one or more of anything)
698  *      0x20000         '!' (zero or more of anything)
699  *      0x30000         NUL (end of string)
700  *      0x40000         error in set.
701  * The pointer to the string is advanced according to needs.
702  * NOTES:
703  *      1. the empty set is equivalent to NUL.
704  *      2. given that a full set has always 0 as the first element,
705  *         we could encode the special cases as 0xffXX where XX
706  *         is 1, 2, 3, 4 as used above.
707  */
708 static int ext_cmp1(const char **p)
709 {
710         uint32_t chars[8];
711         int c, cmin = 0xff, count = 0;
712         const char *end;
713
714         /* load, sign extend and advance pointer until we find
715          * a valid character.
716          */
717         while ( (c = *(*p)++) && (c == ' ' || c == '-') )
718                 ;       /* ignore some characters */
719
720         /* always return unless we have a set of chars */
721         switch (c) {
722         default:        /* ordinary character */
723                 return 0x0000 | (c & 0xff);
724
725         case 'N':       /* 2..9 */
726                 return 0x0700 | '2' ;
727
728         case 'X':       /* 0..9 */
729                 return 0x0900 | '0';
730
731         case 'Z':       /* 1..9 */
732                 return 0x0800 | '1';
733
734         case '.':       /* wildcard */
735                 return 0x10000;
736
737         case '!':       /* earlymatch */
738                 return 0x20000; /* less specific than NULL */
739
740         case '\0':      /* empty string */
741                 *p = NULL;
742                 return 0x30000;
743
744         case '[':       /* pattern */
745                 break;
746         }
747         /* locate end of set */
748         end = strchr(*p, ']');  
749
750         if (end == NULL) {
751                 ast_log(LOG_WARNING, "Wrong usage of [] in the extension\n");
752                 return 0x40000; /* XXX make this entry go last... */
753         }
754
755         bzero(chars, sizeof(chars));    /* clear all chars in the set */
756         for (; *p < end  ; (*p)++) {
757                 unsigned char c1, c2;   /* first-last char in range */
758                 c1 = (unsigned char)((*p)[0]);
759                 if (*p + 2 < end && (*p)[1] == '-') { /* this is a range */
760                         c2 = (unsigned char)((*p)[2]);
761                         *p += 2;        /* skip a total of 3 chars */
762                 } else                  /* individual character */
763                         c2 = c1;
764                 if (c1 < cmin)
765                         cmin = c1;
766                 for (; c1 <= c2; c1++) {
767                         uint32_t mask = 1 << (c1 % 32);
768                         if ( (chars[ c1 / 32 ] & mask) == 0)
769                                 count += 0x100;
770                         chars[ c1 / 32 ] |= mask;
771                 }
772         }
773         (*p)++;
774         return count == 0 ? 0x30000 : (count | cmin);
775 }
776
777 /*!
778  * \brief the full routine to compare extensions in rules.
779  */
780 static int ext_cmp(const char *a, const char *b)
781 {
782         /* make sure non-patterns come first.
783          * If a is not a pattern, it either comes first or
784          * we use strcmp to compare the strings.
785          */
786         int ret = 0;
787
788         if (a[0] != '_')
789                 return (b[0] == '_') ? -1 : strcmp(a, b);
790
791         /* Now we know a is a pattern; if b is not, a comes first */
792         if (b[0] != '_')
793                 return 1;
794 #if 0   /* old mode for ext matching */
795         return strcmp(a, b);
796 #endif
797         /* ok we need full pattern sorting routine */
798         while (!ret && a && b)
799                 ret = ext_cmp1(&a) - ext_cmp1(&b);
800         if (ret == 0)
801                 return 0;
802         else
803                 return (ret > 0) ? 1 : -1;
804 }
805
806 /*!
807  * \internal
808  * \brief used ast_extension_{match|close}
809  * mode is as follows:
810  *      E_MATCH         success only on exact match
811  *      E_MATCHMORE     success only on partial match (i.e. leftover digits in pattern)
812  *      E_CANMATCH      either of the above.
813  * \retval 0 on no-match
814  * \retval 1 on match
815  * \retval 2 on early match.
816  */
817
818 static int _extension_match_core(const char *pattern, const char *data, enum ext_match_t mode)
819 {
820         mode &= E_MATCH_MASK;   /* only consider the relevant bits */
821
822         if ( (mode == E_MATCH) && (pattern[0] == '_') && (strcasecmp(pattern,data)==0) ) /* note: if this test is left out, then _x. will not match _x. !!! */
823                 return 1;
824
825         if (pattern[0] != '_') { /* not a pattern, try exact or partial match */
826                 int ld = strlen(data), lp = strlen(pattern);
827
828                 if (lp < ld)            /* pattern too short, cannot match */
829                         return 0;
830                 /* depending on the mode, accept full or partial match or both */
831                 if (mode == E_MATCH)
832                         return !strcmp(pattern, data); /* 1 on match, 0 on fail */
833                 if (ld == 0 || !strncasecmp(pattern, data, ld)) /* partial or full match */
834                         return (mode == E_MATCHMORE) ? lp > ld : 1; /* XXX should consider '!' and '/' ? */
835                 else
836                         return 0;
837         }
838         pattern++; /* skip leading _ */
839         /*
840          * XXX below we stop at '/' which is a separator for the CID info. However we should
841          * not store '/' in the pattern at all. When we insure it, we can remove the checks.
842          */
843         while (*data && *pattern && *pattern != '/') {
844                 const char *end;
845
846                 if (*data == '-') { /* skip '-' in data (just a separator) */
847                         data++;
848                         continue;
849                 }
850                 switch (toupper(*pattern)) {
851                 case '[':       /* a range */
852                         end = strchr(pattern+1, ']'); /* XXX should deal with escapes ? */
853                         if (end == NULL) {
854                                 ast_log(LOG_WARNING, "Wrong usage of [] in the extension\n");
855                                 return 0;       /* unconditional failure */
856                         }
857                         for (pattern++; pattern != end; pattern++) {
858                                 if (pattern+2 < end && pattern[1] == '-') { /* this is a range */
859                                         if (*data >= pattern[0] && *data <= pattern[2])
860                                                 break;  /* match found */
861                                         else {
862                                                 pattern += 2; /* skip a total of 3 chars */
863                                                 continue;
864                                         }
865                                 } else if (*data == pattern[0])
866                                         break;  /* match found */
867                         }
868                         if (pattern == end)
869                                 return 0;
870                         pattern = end;  /* skip and continue */
871                         break;
872                 case 'N':
873                         if (*data < '2' || *data > '9')
874                                 return 0;
875                         break;
876                 case 'X':
877                         if (*data < '0' || *data > '9')
878                                 return 0;
879                         break;
880                 case 'Z':
881                         if (*data < '1' || *data > '9')
882                                 return 0;
883                         break;
884                 case '.':       /* Must match, even with more digits */
885                         return 1;
886                 case '!':       /* Early match */
887                         return 2;
888                 case ' ':
889                 case '-':       /* Ignore these in patterns */
890                         data--; /* compensate the final data++ */
891                         break;
892                 default:
893                         if (*data != *pattern)
894                                 return 0;
895                 }
896                 data++;
897                 pattern++;
898         }
899         if (*data)                      /* data longer than pattern, no match */
900                 return 0;
901         /*
902          * match so far, but ran off the end of the data.
903          * Depending on what is next, determine match or not.
904          */
905         if (*pattern == '\0' || *pattern == '/')        /* exact match */
906                 return (mode == E_MATCHMORE) ? 0 : 1;   /* this is a failure for E_MATCHMORE */
907         else if (*pattern == '!')                       /* early match */
908                 return 2;
909         else                                            /* partial match */
910                 return (mode == E_MATCH) ? 0 : 1;       /* this is a failure for E_MATCH */
911 }
912
913 /*
914  * Wrapper around _extension_match_core() to do performance measurement
915  * using the profiling code.
916  */
917 static int extension_match_core(const char *pattern, const char *data, enum ext_match_t mode)
918 {
919         int i;
920         static int prof_id = -2;        /* marker for 'unallocated' id */
921         if (prof_id == -2)
922                 prof_id = ast_add_profile("ext_match", 0);
923         ast_mark(prof_id, 1);
924         i = _extension_match_core(pattern, data, mode);
925         ast_mark(prof_id, 0);
926         return i;
927 }
928
929 int ast_extension_match(const char *pattern, const char *data)
930 {
931         return extension_match_core(pattern, data, E_MATCH);
932 }
933
934 int ast_extension_close(const char *pattern, const char *data, int needmore)
935 {
936         if (needmore != E_MATCHMORE && needmore != E_CANMATCH)
937                 ast_log(LOG_WARNING, "invalid argument %d\n", needmore);
938         return extension_match_core(pattern, data, needmore);
939 }
940
941 struct ast_context *ast_context_find(const char *name)
942 {
943         struct ast_context *tmp = NULL;
944         ast_rdlock_contexts();
945         while ( (tmp = ast_walk_contexts(tmp)) ) {
946                 if (!name || !strcasecmp(name, tmp->name))
947                         break;
948         }
949         ast_unlock_contexts();
950         return tmp;
951 }
952
953 #define STATUS_NO_CONTEXT       1
954 #define STATUS_NO_EXTENSION     2
955 #define STATUS_NO_PRIORITY      3
956 #define STATUS_NO_LABEL         4
957 #define STATUS_SUCCESS          5
958
959 static int matchcid(const char *cidpattern, const char *callerid)
960 {
961         /* If the Caller*ID pattern is empty, then we're matching NO Caller*ID, so
962            failing to get a number should count as a match, otherwise not */
963
964         if (ast_strlen_zero(callerid))
965                 return ast_strlen_zero(cidpattern) ? 1 : 0;
966
967         return ast_extension_match(cidpattern, callerid);
968 }
969
970 struct ast_exten *pbx_find_extension(struct ast_channel *chan,
971         struct ast_context *bypass, struct pbx_find_info *q,
972         const char *context, const char *exten, int priority,
973         const char *label, const char *callerid, enum ext_match_t action)
974 {
975         int x, res;
976         struct ast_context *tmp;
977         struct ast_exten *e, *eroot;
978         struct ast_include *i;
979         struct ast_sw *sw;
980
981         /* Initialize status if appropriate */
982         if (q->stacklen == 0) {
983                 q->status = STATUS_NO_CONTEXT;
984                 q->swo = NULL;
985                 q->data = NULL;
986                 q->foundcontext = NULL;
987         } else if (q->stacklen >= AST_PBX_MAX_STACK) {
988                 ast_log(LOG_WARNING, "Maximum PBX stack exceeded\n");
989                 return NULL;
990         }
991
992         /* Check first to see if we've already been checked */
993         for (x = 0; x < q->stacklen; x++) {
994                 if (!strcasecmp(q->incstack[x], context))
995                         return NULL;
996         }
997
998         if (bypass)     /* bypass means we only look there */
999                 tmp = bypass;
1000         else {  /* look in contexts */
1001                 tmp = NULL;
1002                 while ((tmp = ast_walk_contexts(tmp)) ) {
1003                         if (!strcmp(tmp->name, context))
1004                                 break;
1005                 }
1006                 if (!tmp)
1007                         return NULL;
1008         }
1009
1010         if (q->status < STATUS_NO_EXTENSION)
1011                 q->status = STATUS_NO_EXTENSION;
1012
1013         /* scan the list trying to match extension and CID */
1014         eroot = NULL;
1015         while ( (eroot = ast_walk_context_extensions(tmp, eroot)) ) {
1016                 int match = extension_match_core(eroot->exten, exten, action);
1017                 /* 0 on fail, 1 on match, 2 on earlymatch */
1018
1019                 if (!match || (eroot->matchcid && !matchcid(eroot->cidmatch, callerid)))
1020                         continue;       /* keep trying */
1021                 if (match == 2 && action == E_MATCHMORE) {
1022                         /* We match an extension ending in '!'.
1023                          * The decision in this case is final and is NULL (no match).
1024                          */
1025                         return NULL;
1026                 }
1027                 /* found entry, now look for the right priority */
1028                 if (q->status < STATUS_NO_PRIORITY)
1029                         q->status = STATUS_NO_PRIORITY;
1030                 e = NULL;
1031                 while ( (e = ast_walk_extension_priorities(eroot, e)) ) {
1032                         /* Match label or priority */
1033                         if (action == E_FINDLABEL) {
1034                                 if (q->status < STATUS_NO_LABEL)
1035                                         q->status = STATUS_NO_LABEL;
1036                                 if (label && e->label && !strcmp(label, e->label))
1037                                         break;  /* found it */
1038                         } else if (e->priority == priority) {
1039                                 break;  /* found it */
1040                         } /* else keep searching */
1041                 }
1042                 if (e) {        /* found a valid match */
1043                         q->status = STATUS_SUCCESS;
1044                         q->foundcontext = context;
1045                         return e;
1046                 }
1047         }
1048         /* Check alternative switches */
1049         AST_LIST_TRAVERSE(&tmp->alts, sw, list) {
1050                 struct ast_switch *asw = pbx_findswitch(sw->name);
1051                 ast_switch_f *aswf = NULL;
1052                 char *datap;
1053
1054                 if (!asw) {
1055                         ast_log(LOG_WARNING, "No such switch '%s'\n", sw->name);
1056                         continue;
1057                 }
1058                 /* Substitute variables now */
1059                 if (sw->eval)
1060                         pbx_substitute_variables_helper(chan, sw->data, sw->tmpdata, SWITCH_DATA_LENGTH - 1);
1061
1062                 /* equivalent of extension_match_core() at the switch level */
1063                 if (action == E_CANMATCH)
1064                         aswf = asw->canmatch;
1065                 else if (action == E_MATCHMORE)
1066                         aswf = asw->matchmore;
1067                 else /* action == E_MATCH */
1068                         aswf = asw->exists;
1069                 datap = sw->eval ? sw->tmpdata : sw->data;
1070                 res = !aswf ? 0 : aswf(chan, context, exten, priority, callerid, datap);
1071                 if (res) {      /* Got a match */
1072                         q->swo = asw;
1073                         q->data = datap;
1074                         q->foundcontext = context;
1075                         /* XXX keep status = STATUS_NO_CONTEXT ? */
1076                         return NULL;
1077                 }
1078         }
1079         q->incstack[q->stacklen++] = tmp->name; /* Setup the stack */
1080         /* Now try any includes we have in this context */
1081         for (i = tmp->includes; i; i = i->next) {
1082                 if (include_valid(i)) {
1083                         if ((e = pbx_find_extension(chan, bypass, q, i->rname, exten, priority, label, callerid, action)))
1084                                 return e;
1085                         if (q->swo)
1086                                 return NULL;
1087                 }
1088         }
1089         return NULL;
1090 }
1091
1092 /*! 
1093  * \brief extract offset:length from variable name.
1094  * \return 1 if there is a offset:length part, which is
1095  * trimmed off (values go into variables)
1096  */
1097 static int parse_variable_name(char *var, int *offset, int *length, int *isfunc)
1098 {
1099         int parens=0;
1100
1101         *offset = 0;
1102         *length = INT_MAX;
1103         *isfunc = 0;
1104         for (; *var; var++) {
1105                 if (*var == '(') {
1106                         (*isfunc)++;
1107                         parens++;
1108                 } else if (*var == ')') {
1109                         parens--;
1110                 } else if (*var == ':' && parens == 0) {
1111                         *var++ = '\0';
1112                         sscanf(var, "%d:%d", offset, length);
1113                         return 1; /* offset:length valid */
1114                 }
1115         }
1116         return 0;
1117 }
1118
1119 /*! 
1120  *\brief takes a substring. It is ok to call with value == workspace.
1121  * \param value
1122  * \param offset < 0 means start from the end of the string and set the beginning
1123  *   to be that many characters back.
1124  * \param length is the length of the substring, a value less than 0 means to leave
1125  * that many off the end.
1126  * \param workspace
1127  * \param workspace_len
1128  * Always return a copy in workspace.
1129  */
1130 static char *substring(const char *value, int offset, int length, char *workspace, size_t workspace_len)
1131 {
1132         char *ret = workspace;
1133         int lr; /* length of the input string after the copy */
1134
1135         ast_copy_string(workspace, value, workspace_len); /* always make a copy */
1136
1137         lr = strlen(ret); /* compute length after copy, so we never go out of the workspace */
1138
1139         /* Quick check if no need to do anything */
1140         if (offset == 0 && length >= lr)        /* take the whole string */
1141                 return ret;
1142
1143         if (offset < 0) {       /* translate negative offset into positive ones */
1144                 offset = lr + offset;
1145                 if (offset < 0) /* If the negative offset was greater than the length of the string, just start at the beginning */
1146                         offset = 0;
1147         }
1148
1149         /* too large offset result in empty string so we know what to return */
1150         if (offset >= lr)
1151                 return ret + lr;        /* the final '\0' */
1152
1153         ret += offset;          /* move to the start position */
1154         if (length >= 0 && length < lr - offset)        /* truncate if necessary */
1155                 ret[length] = '\0';
1156         else if (length < 0) {
1157                 if (lr > offset - length) /* After we remove from the front and from the rear, is there anything left? */
1158                         ret[lr + length - offset] = '\0';
1159                 else
1160                         ret[0] = '\0';
1161         }
1162
1163         return ret;
1164 }
1165
1166 /*! \brief  Support for Asterisk built-in variables in the dialplan
1167
1168 \note   See also
1169         - \ref AstVar   Channel variables
1170         - \ref AstCauses The HANGUPCAUSE variable
1171  */
1172 void pbx_retrieve_variable(struct ast_channel *c, const char *var, char **ret, char *workspace, int workspacelen, struct varshead *headp)
1173 {
1174         const char not_found = '\0';
1175         char *tmpvar;
1176         const char *s;  /* the result */
1177         int offset, length;
1178         int i, need_substring;
1179         struct varshead *places[2] = { headp, &globals };       /* list of places where we may look */
1180
1181         if (c) {
1182                 places[0] = &c->varshead;
1183         }
1184         /*
1185          * Make a copy of var because parse_variable_name() modifies the string.
1186          * Then if called directly, we might need to run substring() on the result;
1187          * remember this for later in 'need_substring', 'offset' and 'length'
1188          */
1189         tmpvar = ast_strdupa(var);      /* parse_variable_name modifies the string */
1190         need_substring = parse_variable_name(tmpvar, &offset, &length, &i /* ignored */);
1191
1192         /*
1193          * Look first into predefined variables, then into variable lists.
1194          * Variable 's' points to the result, according to the following rules:
1195          * s == &not_found (set at the beginning) means that we did not find a
1196          *      matching variable and need to look into more places.
1197          * If s != &not_found, s is a valid result string as follows:
1198          * s = NULL if the variable does not have a value;
1199          *      you typically do this when looking for an unset predefined variable.
1200          * s = workspace if the result has been assembled there;
1201          *      typically done when the result is built e.g. with an snprintf(),
1202          *      so we don't need to do an additional copy.
1203          * s != workspace in case we have a string, that needs to be copied
1204          *      (the ast_copy_string is done once for all at the end).
1205          *      Typically done when the result is already available in some string.
1206          */
1207         s = &not_found; /* default value */
1208         if (c) {        /* This group requires a valid channel */
1209                 /* Names with common parts are looked up a piece at a time using strncmp. */
1210                 if (!strncmp(var, "CALL", 4)) {
1211                         if (!strncmp(var + 4, "ING", 3)) {
1212                                 if (!strcmp(var + 7, "PRES")) {                 /* CALLINGPRES */
1213                                         snprintf(workspace, workspacelen, "%d", c->cid.cid_pres);
1214                                         s = workspace;
1215                                 } else if (!strcmp(var + 7, "ANI2")) {          /* CALLINGANI2 */
1216                                         snprintf(workspace, workspacelen, "%d", c->cid.cid_ani2);
1217                                         s = workspace;
1218                                 } else if (!strcmp(var + 7, "TON")) {           /* CALLINGTON */
1219                                         snprintf(workspace, workspacelen, "%d", c->cid.cid_ton);
1220                                         s = workspace;
1221                                 } else if (!strcmp(var + 7, "TNS")) {           /* CALLINGTNS */
1222                                         snprintf(workspace, workspacelen, "%d", c->cid.cid_tns);
1223                                         s = workspace;
1224                                 }
1225                         }
1226                 } else if (!strcmp(var, "HINT")) {
1227                         s = ast_get_hint(workspace, workspacelen, NULL, 0, c, c->context, c->exten) ? workspace : NULL;
1228                 } else if (!strcmp(var, "HINTNAME")) {
1229                         s = ast_get_hint(NULL, 0, workspace, workspacelen, c, c->context, c->exten) ? workspace : NULL;
1230                 } else if (!strcmp(var, "EXTEN")) {
1231                         s = c->exten;
1232                 } else if (!strcmp(var, "CONTEXT")) {
1233                         s = c->context;
1234                 } else if (!strcmp(var, "PRIORITY")) {
1235                         snprintf(workspace, workspacelen, "%d", c->priority);
1236                         s = workspace;
1237                 } else if (!strcmp(var, "CHANNEL")) {
1238                         s = c->name;
1239                 } else if (!strcmp(var, "UNIQUEID")) {
1240                         s = c->uniqueid;
1241                 } else if (!strcmp(var, "HANGUPCAUSE")) {
1242                         snprintf(workspace, workspacelen, "%d", c->hangupcause);
1243                         s = workspace;
1244                 }
1245         }
1246         if (s == &not_found) { /* look for more */
1247                 if (!strcmp(var, "EPOCH")) {
1248                         snprintf(workspace, workspacelen, "%u",(int)time(NULL));
1249                         s = workspace;
1250                 } else if (!strcmp(var, "SYSTEMNAME")) {
1251                         s = ast_config_AST_SYSTEM_NAME;
1252                 }
1253         }
1254         /* if not found, look into chanvars or global vars */
1255         for (i = 0; s == &not_found && i < (sizeof(places) / sizeof(places[0])); i++) {
1256                 struct ast_var_t *variables;
1257                 if (!places[i])
1258                         continue;
1259                 if (places[i] == &globals)
1260                         ast_rwlock_rdlock(&globalslock);
1261                 AST_LIST_TRAVERSE(places[i], variables, entries) {
1262                         if (strcasecmp(ast_var_name(variables), var)==0) {
1263                                 s = ast_var_value(variables);
1264                                 break;
1265                         }
1266                 }
1267                 if (places[i] == &globals)
1268                         ast_rwlock_unlock(&globalslock);
1269         }
1270         if (s == &not_found || s == NULL)
1271                 *ret = NULL;
1272         else {
1273                 if (s != workspace)
1274                         ast_copy_string(workspace, s, workspacelen);
1275                 *ret = workspace;
1276                 if (need_substring)
1277                         *ret = substring(*ret, offset, length, workspace, workspacelen);
1278         }
1279 }
1280
1281 static void exception_store_free(void *data)
1282 {
1283         struct pbx_exception *exception = data;
1284         ast_string_field_free_pools(exception);
1285         ast_free(exception);
1286 }
1287
1288 static struct ast_datastore_info exception_store_info = {
1289         .type = "EXCEPTION",
1290         .destroy = exception_store_free,
1291 };
1292
1293 int pbx_builtin_raise_exception(struct ast_channel *chan, void *vtype)
1294 {
1295         const char *type = vtype;
1296         struct ast_datastore *ds = ast_channel_datastore_find(chan, &exception_store_info, NULL);
1297         struct pbx_exception *exception = NULL;
1298
1299         if (!ds) {
1300                 ds = ast_channel_datastore_alloc(&exception_store_info, NULL);
1301                 if (!ds)
1302                         return -1;
1303                 exception = ast_calloc(1, sizeof(struct pbx_exception));
1304                 if (!ds->data) {
1305                         ast_channel_datastore_free(ds);
1306                         return -1;
1307                 }
1308                 if (ast_string_field_init(exception, 128)) {
1309                         ast_free(exception);
1310                         ast_channel_datastore_free(ds);
1311                         return -1;
1312                 }
1313                 ds->data = exception;
1314                 ast_channel_datastore_add(chan, ds);
1315         } else
1316                 exception = ds->data;
1317
1318         ast_string_field_set(exception, type, type);
1319         ast_string_field_set(exception, context, chan->context);
1320         ast_string_field_set(exception, exten, chan->exten);
1321         exception->priority = chan->priority;
1322         set_ext_pri(chan, "e", 1);
1323         return 0;
1324 }
1325
1326 static int acf_exception_read(struct ast_channel *chan, const char *name, char *data, char *buf, size_t buflen)
1327 {
1328         struct ast_datastore *ds = ast_channel_datastore_find(chan, &exception_store_info, NULL);
1329         struct pbx_exception *exception = NULL;
1330         if (!ds || !ds->data)
1331                 return -1;
1332         exception = ds->data;
1333         if (!strcasecmp(data, "TYPE"))
1334                 ast_copy_string(buf, exception->type, buflen);
1335         else if (!strcasecmp(data, "CONTEXT"))
1336                 ast_copy_string(buf, exception->context, buflen);
1337         else if (!strncasecmp(data, "EXTEN", 5))
1338                 ast_copy_string(buf, exception->exten, buflen);
1339         else if (!strcasecmp(data, "PRIORITY"))
1340                 snprintf(buf, buflen, "%d", exception->priority);
1341         else
1342                 return -1;
1343         return 0;
1344 }
1345
1346 static struct ast_custom_function exception_function = {
1347         .name = "EXCEPTION",
1348         .synopsis = "Retrieve the details of the current dialplan exception",
1349         .desc =
1350 "The following fields are available for retrieval:\n"
1351 "  type      INVALID, ERROR, RESPONSETIMEOUT, or ABSOLUTETIMEOUT\n"
1352 "  context   The context executing when the exception occurred\n"
1353 "  exten     The extension executing when the exception occurred\n"
1354 "  priority  The numeric priority executing when the exception occurred\n",
1355         .syntax = "EXCEPTION(<field>)",
1356         .read = acf_exception_read,
1357 };
1358
1359 static char *handle_show_functions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1360 {
1361         struct ast_custom_function *acf;
1362         int count_acf = 0;
1363         int like = 0;
1364
1365         switch (cmd) {
1366         case CLI_INIT:
1367                 e->command = "core show functions [like]";
1368                 e->usage = 
1369                         "Usage: core show functions [like <text>]\n"
1370                         "       List builtin functions, optionally only those matching a given string\n";
1371                 return NULL;
1372         case CLI_GENERATE:
1373                 return NULL;
1374         }
1375
1376         if (a->argc == 5 && (!strcmp(a->argv[3], "like")) ) {
1377                 like = 1;
1378         } else if (a->argc != 3) {
1379                 return CLI_SHOWUSAGE;
1380         }
1381
1382         ast_cli(a->fd, "%s Custom Functions:\n--------------------------------------------------------------------------------\n", like ? "Matching" : "Installed");
1383
1384         AST_RWLIST_RDLOCK(&acf_root);
1385         AST_RWLIST_TRAVERSE(&acf_root, acf, acflist) {
1386                 if (!like || strstr(acf->name, a->argv[4])) {
1387                         count_acf++;
1388                         ast_cli(a->fd, "%-20.20s  %-35.35s  %s\n", acf->name, acf->syntax, acf->synopsis);
1389                 }
1390         }
1391         AST_RWLIST_UNLOCK(&acf_root);
1392
1393         ast_cli(a->fd, "%d %scustom functions installed.\n", count_acf, like ? "matching " : "");
1394
1395         return CLI_SUCCESS;
1396 }
1397
1398 static char *handle_show_function(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1399 {
1400         struct ast_custom_function *acf;
1401         /* Maximum number of characters added by terminal coloring is 22 */
1402         char infotitle[64 + AST_MAX_APP + 22], syntitle[40], destitle[40];
1403         char info[64 + AST_MAX_APP], *synopsis = NULL, *description = NULL;
1404         char stxtitle[40], *syntax = NULL;
1405         int synopsis_size, description_size, syntax_size;
1406         char *ret = NULL;
1407         int which = 0;
1408         int wordlen;
1409
1410         switch (cmd) {
1411         case CLI_INIT:
1412                 e->command = "core show function";
1413                 e->usage = 
1414                         "Usage: core show function <function>\n"
1415                         "       Describe a particular dialplan function.\n";
1416                 return NULL;
1417         case CLI_GENERATE:      
1418                 wordlen = strlen(a->word);
1419                 /* case-insensitive for convenience in this 'complete' function */
1420                 AST_RWLIST_RDLOCK(&acf_root);
1421                 AST_RWLIST_TRAVERSE(&acf_root, acf, acflist) {
1422                         if (!strncasecmp(a->word, acf->name, wordlen) && ++which > a->n) {
1423                                 ret = ast_strdup(acf->name);
1424                                 break;
1425                         }
1426                 }
1427                 AST_RWLIST_UNLOCK(&acf_root);
1428
1429                 return ret;
1430         }
1431
1432         if (a->argc < 4)
1433                 return CLI_SHOWUSAGE;
1434
1435         if (!(acf = ast_custom_function_find(a->argv[3]))) {
1436                 ast_cli(a->fd, "No function by that name registered.\n");
1437                 return CLI_FAILURE;
1438
1439         }
1440
1441         if (acf->synopsis)
1442                 synopsis_size = strlen(acf->synopsis) + 23;
1443         else
1444                 synopsis_size = strlen("Not available") + 23;
1445         synopsis = alloca(synopsis_size);
1446
1447         if (acf->desc)
1448                 description_size = strlen(acf->desc) + 23;
1449         else
1450                 description_size = strlen("Not available") + 23;
1451         description = alloca(description_size);
1452
1453         if (acf->syntax)
1454                 syntax_size = strlen(acf->syntax) + 23;
1455         else
1456                 syntax_size = strlen("Not available") + 23;
1457         syntax = alloca(syntax_size);
1458
1459         snprintf(info, 64 + AST_MAX_APP, "\n  -= Info about function '%s' =- \n\n", acf->name);
1460         term_color(infotitle, info, COLOR_MAGENTA, 0, 64 + AST_MAX_APP + 22);
1461         term_color(stxtitle, "[Syntax]\n", COLOR_MAGENTA, 0, 40);
1462         term_color(syntitle, "[Synopsis]\n", COLOR_MAGENTA, 0, 40);
1463         term_color(destitle, "[Description]\n", COLOR_MAGENTA, 0, 40);
1464         term_color(syntax,
1465                    acf->syntax ? acf->syntax : "Not available",
1466                    COLOR_CYAN, 0, syntax_size);
1467         term_color(synopsis,
1468                    acf->synopsis ? acf->synopsis : "Not available",
1469                    COLOR_CYAN, 0, synopsis_size);
1470         term_color(description,
1471                    acf->desc ? acf->desc : "Not available",
1472                    COLOR_CYAN, 0, description_size);
1473
1474         ast_cli(a->fd,"%s%s%s\n\n%s%s\n\n%s%s\n", infotitle, stxtitle, syntax, syntitle, synopsis, destitle, description);
1475
1476         return CLI_SUCCESS;
1477 }
1478
1479 struct ast_custom_function *ast_custom_function_find(const char *name)
1480 {
1481         struct ast_custom_function *acf = NULL;
1482
1483         AST_RWLIST_RDLOCK(&acf_root);
1484         AST_RWLIST_TRAVERSE(&acf_root, acf, acflist) {
1485                 if (!strcmp(name, acf->name))
1486                         break;
1487         }
1488         AST_RWLIST_UNLOCK(&acf_root);
1489
1490         return acf;
1491 }
1492
1493 int ast_custom_function_unregister(struct ast_custom_function *acf)
1494 {
1495         struct ast_custom_function *cur;
1496
1497         if (!acf)
1498                 return -1;
1499
1500         AST_RWLIST_WRLOCK(&acf_root);
1501         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&acf_root, cur, acflist) {
1502                 if (cur == acf) {
1503                         AST_RWLIST_REMOVE_CURRENT(&acf_root, acflist);
1504                         ast_verb(2, "Unregistered custom function %s\n", acf->name);
1505                         break;
1506                 }
1507         }
1508         AST_RWLIST_TRAVERSE_SAFE_END
1509         AST_RWLIST_UNLOCK(&acf_root);
1510
1511         return acf ? 0 : -1;
1512 }
1513
1514 int __ast_custom_function_register(struct ast_custom_function *acf, struct ast_module *mod)
1515 {
1516         struct ast_custom_function *cur;
1517
1518         if (!acf)
1519                 return -1;
1520
1521         acf->mod = mod;
1522
1523         AST_RWLIST_WRLOCK(&acf_root);
1524
1525         AST_RWLIST_TRAVERSE(&acf_root, cur, acflist) {
1526                 if (!strcmp(acf->name, cur->name)) {
1527                         ast_log(LOG_ERROR, "Function %s already registered.\n", acf->name);
1528                         AST_RWLIST_UNLOCK(&acf_root);
1529                         return -1;
1530                 }
1531         }
1532
1533         /* Store in alphabetical order */
1534         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&acf_root, cur, acflist) {
1535                 if (strcasecmp(acf->name, cur->name) < 0) {
1536                         AST_RWLIST_INSERT_BEFORE_CURRENT(&acf_root, acf, acflist);
1537                         break;
1538                 }
1539         }
1540         AST_RWLIST_TRAVERSE_SAFE_END
1541         if (!cur)
1542                 AST_RWLIST_INSERT_TAIL(&acf_root, acf, acflist);
1543
1544         AST_RWLIST_UNLOCK(&acf_root);
1545
1546         ast_verb(2, "Registered custom function %s\n", acf->name);
1547
1548         return 0;
1549 }
1550
1551 /*! \brief return a pointer to the arguments of the function,
1552  * and terminates the function name with '\\0'
1553  */
1554 static char *func_args(char *function)
1555 {
1556         char *args = strchr(function, '(');
1557
1558         if (!args)
1559                 ast_log(LOG_WARNING, "Function doesn't contain parentheses.  Assuming null argument.\n");
1560         else {
1561                 char *p;
1562                 *args++ = '\0';
1563                 if ((p = strrchr(args, ')')) )
1564                         *p = '\0';
1565                 else
1566                         ast_log(LOG_WARNING, "Can't find trailing parenthesis?\n");
1567         }
1568         return args;
1569 }
1570
1571 int ast_func_read(struct ast_channel *chan, const char *function, char *workspace, size_t len)
1572 {
1573         char *copy = ast_strdupa(function);
1574         char *args = func_args(copy);
1575         struct ast_custom_function *acfptr = ast_custom_function_find(copy);
1576
1577         if (acfptr == NULL)
1578                 ast_log(LOG_ERROR, "Function %s not registered\n", copy);
1579         else if (!acfptr->read)
1580                 ast_log(LOG_ERROR, "Function %s cannot be read\n", copy);
1581         else {
1582                 int res;
1583                 struct ast_module_user *u = NULL;
1584                 if (acfptr->mod)
1585                         u = __ast_module_user_add(acfptr->mod, chan);
1586                 res = acfptr->read(chan, copy, args, workspace, len);
1587                 if (acfptr->mod && u)
1588                         __ast_module_user_remove(acfptr->mod, u);
1589                 return res;
1590         }
1591         return -1;
1592 }
1593
1594 int ast_func_write(struct ast_channel *chan, const char *function, const char *value)
1595 {
1596         char *copy = ast_strdupa(function);
1597         char *args = func_args(copy);
1598         struct ast_custom_function *acfptr = ast_custom_function_find(copy);
1599
1600         if (acfptr == NULL)
1601                 ast_log(LOG_ERROR, "Function %s not registered\n", copy);
1602         else if (!acfptr->write)
1603                 ast_log(LOG_ERROR, "Function %s cannot be written to\n", copy);
1604         else {
1605                 int res;
1606                 struct ast_module_user *u = NULL;
1607                 if (acfptr->mod)
1608                         u = __ast_module_user_add(acfptr->mod, chan);
1609                 res = acfptr->write(chan, copy, args, value);
1610                 if (acfptr->mod && u)
1611                         __ast_module_user_remove(acfptr->mod, u);
1612                 return res;
1613         }
1614
1615         return -1;
1616 }
1617
1618 static void pbx_substitute_variables_helper_full(struct ast_channel *c, struct varshead *headp, const char *cp1, char *cp2, int count)
1619 {
1620         /* Substitutes variables into cp2, based on string cp1, and assuming cp2 to be
1621            zero-filled */
1622         char *cp4;
1623         const char *tmp, *whereweare;
1624         int length, offset, offset2, isfunction;
1625         char *workspace = NULL;
1626         char *ltmp = NULL, *var = NULL;
1627         char *nextvar, *nextexp, *nextthing;
1628         char *vars, *vare;
1629         int pos, brackets, needsub, len;
1630
1631         whereweare=tmp=cp1;
1632         while (!ast_strlen_zero(whereweare) && count) {
1633                 /* Assume we're copying the whole remaining string */
1634                 pos = strlen(whereweare);
1635                 nextvar = NULL;
1636                 nextexp = NULL;
1637                 nextthing = strchr(whereweare, '$');
1638                 if (nextthing) {
1639                         switch (nextthing[1]) {
1640                         case '{':
1641                                 nextvar = nextthing;
1642                                 pos = nextvar - whereweare;
1643                                 break;
1644                         case '[':
1645                                 nextexp = nextthing;
1646                                 pos = nextexp - whereweare;
1647                                 break;
1648                         }
1649                 }
1650
1651                 if (pos) {
1652                         /* Can't copy more than 'count' bytes */
1653                         if (pos > count)
1654                                 pos = count;
1655
1656                         /* Copy that many bytes */
1657                         memcpy(cp2, whereweare, pos);
1658
1659                         count -= pos;
1660                         cp2 += pos;
1661                         whereweare += pos;
1662                 }
1663
1664                 if (nextvar) {
1665                         /* We have a variable.  Find the start and end, and determine
1666                            if we are going to have to recursively call ourselves on the
1667                            contents */
1668                         vars = vare = nextvar + 2;
1669                         brackets = 1;
1670                         needsub = 0;
1671
1672                         /* Find the end of it */
1673                         while (brackets && *vare) {
1674                                 if ((vare[0] == '$') && (vare[1] == '{')) {
1675                                         needsub++;
1676                                 } else if (vare[0] == '{') {
1677                                         brackets++;
1678                                 } else if (vare[0] == '}') {
1679                                         brackets--;
1680                                 } else if ((vare[0] == '$') && (vare[1] == '['))
1681                                         needsub++;
1682                                 vare++;
1683                         }
1684                         if (brackets)
1685                                 ast_log(LOG_NOTICE, "Error in extension logic (missing '}')\n");
1686                         len = vare - vars - 1;
1687
1688                         /* Skip totally over variable string */
1689                         whereweare += (len + 3);
1690
1691                         if (!var)
1692                                 var = alloca(VAR_BUF_SIZE);
1693
1694                         /* Store variable name (and truncate) */
1695                         ast_copy_string(var, vars, len + 1);
1696
1697                         /* Substitute if necessary */
1698                         if (needsub) {
1699                                 if (!ltmp)
1700                                         ltmp = alloca(VAR_BUF_SIZE);
1701
1702                                 memset(ltmp, 0, VAR_BUF_SIZE);
1703                                 pbx_substitute_variables_helper_full(c, headp, var, ltmp, VAR_BUF_SIZE - 1);
1704                                 vars = ltmp;
1705                         } else {
1706                                 vars = var;
1707                         }
1708
1709                         if (!workspace)
1710                                 workspace = alloca(VAR_BUF_SIZE);
1711
1712                         workspace[0] = '\0';
1713
1714                         parse_variable_name(vars, &offset, &offset2, &isfunction);
1715                         if (isfunction) {
1716                                 /* Evaluate function */
1717                                 if (c || !headp)
1718                                         cp4 = ast_func_read(c, vars, workspace, VAR_BUF_SIZE) ? NULL : workspace;
1719                                 else {
1720                                         struct varshead old;
1721                                         struct ast_channel *c = ast_channel_alloc(0, 0, "", "", "", "", "", 0, "Bogus/%p", vars);
1722                                         if (c) {
1723                                                 memcpy(&old, &c->varshead, sizeof(old));
1724                                                 memcpy(&c->varshead, headp, sizeof(c->varshead));
1725                                                 cp4 = ast_func_read(c, vars, workspace, VAR_BUF_SIZE) ? NULL : workspace;
1726                                                 /* Don't deallocate the varshead that was passed in */
1727                                                 memcpy(&c->varshead, &old, sizeof(c->varshead));
1728                                                 ast_channel_free(c);
1729                                         } else
1730                                                 ast_log(LOG_ERROR, "Unable to allocate bogus channel for variable substitution.  Function results may be blank.\n");
1731                                 }
1732                                 ast_debug(1, "Function result is '%s'\n", cp4 ? cp4 : "(null)");
1733                         } else {
1734                                 /* Retrieve variable value */
1735                                 pbx_retrieve_variable(c, vars, &cp4, workspace, VAR_BUF_SIZE, headp);
1736                         }
1737                         if (cp4) {
1738                                 cp4 = substring(cp4, offset, offset2, workspace, VAR_BUF_SIZE);
1739
1740                                 length = strlen(cp4);
1741                                 if (length > count)
1742                                         length = count;
1743                                 memcpy(cp2, cp4, length);
1744                                 count -= length;
1745                                 cp2 += length;
1746                         }
1747                 } else if (nextexp) {
1748                         /* We have an expression.  Find the start and end, and determine
1749                            if we are going to have to recursively call ourselves on the
1750                            contents */
1751                         vars = vare = nextexp + 2;
1752                         brackets = 1;
1753                         needsub = 0;
1754
1755                         /* Find the end of it */
1756                         while (brackets && *vare) {
1757                                 if ((vare[0] == '$') && (vare[1] == '[')) {
1758                                         needsub++;
1759                                         brackets++;
1760                                         vare++;
1761                                 } else if (vare[0] == '[') {
1762                                         brackets++;
1763                                 } else if (vare[0] == ']') {
1764                                         brackets--;
1765                                 } else if ((vare[0] == '$') && (vare[1] == '{')) {
1766                                         needsub++;
1767                                         vare++;
1768                                 }
1769                                 vare++;
1770                         }
1771                         if (brackets)
1772                                 ast_log(LOG_NOTICE, "Error in extension logic (missing ']')\n");
1773                         len = vare - vars - 1;
1774
1775                         /* Skip totally over expression */
1776                         whereweare += (len + 3);
1777
1778                         if (!var)
1779                                 var = alloca(VAR_BUF_SIZE);
1780
1781                         /* Store variable name (and truncate) */
1782                         ast_copy_string(var, vars, len + 1);
1783
1784                         /* Substitute if necessary */
1785                         if (needsub) {
1786                                 if (!ltmp)
1787                                         ltmp = alloca(VAR_BUF_SIZE);
1788
1789                                 memset(ltmp, 0, VAR_BUF_SIZE);
1790                                 pbx_substitute_variables_helper_full(c, headp, var, ltmp, VAR_BUF_SIZE - 1);
1791                                 vars = ltmp;
1792                         } else {
1793                                 vars = var;
1794                         }
1795
1796                         length = ast_expr(vars, cp2, count, c);
1797
1798                         if (length) {
1799                                 ast_debug(1, "Expression result is '%s'\n", cp2);
1800                                 count -= length;
1801                                 cp2 += length;
1802                         }
1803                 } else
1804                         break;
1805         }
1806 }
1807
1808 void pbx_substitute_variables_helper(struct ast_channel *c, const char *cp1, char *cp2, int count)
1809 {
1810         pbx_substitute_variables_helper_full(c, (c) ? &c->varshead : NULL, cp1, cp2, count);
1811 }
1812
1813 void pbx_substitute_variables_varshead(struct varshead *headp, const char *cp1, char *cp2, int count)
1814 {
1815         pbx_substitute_variables_helper_full(NULL, headp, cp1, cp2, count);
1816 }
1817
1818 static void pbx_substitute_variables(char *passdata, int datalen, struct ast_channel *c, struct ast_exten *e)
1819 {
1820         memset(passdata, 0, datalen);
1821
1822         /* No variables or expressions in e->data, so why scan it? */
1823         if (e->data && !strchr(e->data, '$') && !strstr(e->data,"${") && !strstr(e->data,"$[") && !strstr(e->data,"$(")) {
1824                 ast_copy_string(passdata, e->data, datalen);
1825                 return;
1826         }
1827
1828         pbx_substitute_variables_helper(c, e->data, passdata, datalen - 1);
1829 }
1830
1831 /*! \brief The return value depends on the action:
1832  *
1833  * E_MATCH, E_CANMATCH, E_MATCHMORE require a real match,
1834  *      and return 0 on failure, -1 on match;
1835  * E_FINDLABEL maps the label to a priority, and returns
1836  *      the priority on success, ... XXX
1837  * E_SPAWN, spawn an application,
1838  *      
1839  * \retval 0 on success.
1840  * \retval  -1 on failure.
1841  */
1842 static int pbx_extension_helper(struct ast_channel *c, struct ast_context *con,
1843         const char *context, const char *exten, int priority,
1844         const char *label, const char *callerid, enum ext_match_t action)
1845 {
1846         struct ast_exten *e;
1847         struct ast_app *app;
1848         int res;
1849         struct pbx_find_info q = { .stacklen = 0 }; /* the rest is reset in pbx_find_extension */
1850         char passdata[EXT_DATA_SIZE];
1851
1852         int matching_action = (action == E_MATCH || action == E_CANMATCH || action == E_MATCHMORE);
1853
1854         ast_rdlock_contexts();
1855         e = pbx_find_extension(c, con, &q, context, exten, priority, label, callerid, action);
1856         if (e) {
1857                 if (matching_action) {
1858                         ast_unlock_contexts();
1859                         return -1;      /* success, we found it */
1860                 } else if (action == E_FINDLABEL) { /* map the label to a priority */
1861                         res = e->priority;
1862                         ast_unlock_contexts();
1863                         return res;     /* the priority we were looking for */
1864                 } else {        /* spawn */
1865                         if (!e->cached_app)
1866                                 e->cached_app = pbx_findapp(e->app);
1867                         app = e->cached_app;
1868                         ast_unlock_contexts();
1869                         if (!app) {
1870                                 ast_log(LOG_WARNING, "No application '%s' for extension (%s, %s, %d)\n", e->app, context, exten, priority);
1871                                 return -1;
1872                         }
1873                         if (c->context != context)
1874                                 ast_copy_string(c->context, context, sizeof(c->context));
1875                         if (c->exten != exten)
1876                                 ast_copy_string(c->exten, exten, sizeof(c->exten));
1877                         c->priority = priority;
1878                         pbx_substitute_variables(passdata, sizeof(passdata), c, e);
1879                         if (option_debug) {
1880                                 char atmp[80];
1881                                 char atmp2[EXT_DATA_SIZE+100];
1882                                 ast_debug(1, "Launching '%s'\n", app->name);
1883                                 snprintf(atmp, sizeof(atmp), "STACK-%s-%s-%d", context, exten, priority);
1884                                 snprintf(atmp2, sizeof(atmp2), "%s(\"%s\", \"%s\") %s",
1885                                         app->name, c->name, passdata, "in new stack");
1886                                 pbx_builtin_setvar_helper(c, atmp, atmp2);
1887                         }
1888                         if (option_verbose > 2) {
1889                                 char tmp[80], tmp2[80], tmp3[EXT_DATA_SIZE];
1890                                 ast_verb(3, "Executing [%s@%s:%d] %s(\"%s\", \"%s\") %s\n",
1891                                         exten, context, priority,
1892                                         term_color(tmp, app->name, COLOR_BRCYAN, 0, sizeof(tmp)),
1893                                         term_color(tmp2, c->name, COLOR_BRMAGENTA, 0, sizeof(tmp2)),
1894                                         term_color(tmp3, passdata, COLOR_BRMAGENTA, 0, sizeof(tmp3)),
1895                                         "in new stack");
1896                         }
1897                         manager_event(EVENT_FLAG_CALL, "Newexten",
1898                                         "Channel: %s\r\n"
1899                                         "Context: %s\r\n"
1900                                         "Extension: %s\r\n"
1901                                         "Priority: %d\r\n"
1902                                         "Application: %s\r\n"
1903                                         "AppData: %s\r\n"
1904                                         "Uniqueid: %s\r\n",
1905                                         c->name, c->context, c->exten, c->priority, app->name, passdata, c->uniqueid);
1906                         return pbx_exec(c, app, passdata);      /* 0 on success, -1 on failure */
1907                 }
1908         } else if (q.swo) {     /* not found here, but in another switch */
1909                 ast_unlock_contexts();
1910                 if (matching_action)
1911                         return -1;
1912                 else {
1913                         if (!q.swo->exec) {
1914                                 ast_log(LOG_WARNING, "No execution engine for switch %s\n", q.swo->name);
1915                                 res = -1;
1916                         }
1917                         return q.swo->exec(c, q.foundcontext ? q.foundcontext : context, exten, priority, callerid, q.data);
1918                 }
1919         } else {        /* not found anywhere, see what happened */
1920                 ast_unlock_contexts();
1921                 switch (q.status) {
1922                 case STATUS_NO_CONTEXT:
1923                         if (!matching_action)
1924                                 ast_log(LOG_NOTICE, "Cannot find extension context '%s'\n", context);
1925                         break;
1926                 case STATUS_NO_EXTENSION:
1927                         if (!matching_action)
1928                                 ast_log(LOG_NOTICE, "Cannot find extension '%s' in context '%s'\n", exten, context);
1929                         break;
1930                 case STATUS_NO_PRIORITY:
1931                         if (!matching_action)
1932                                 ast_log(LOG_NOTICE, "No such priority %d in extension '%s' in context '%s'\n", priority, exten, context);
1933                         break;
1934                 case STATUS_NO_LABEL:
1935                         if (context)
1936                                 ast_log(LOG_NOTICE, "No such label '%s' in extension '%s' in context '%s'\n", label, exten, context);
1937                         break;
1938                 default:
1939                         ast_debug(1, "Shouldn't happen!\n");
1940                 }
1941
1942                 return (matching_action) ? 0 : -1;
1943         }
1944 }
1945
1946 /*! \brief Find hint for given extension in context */
1947 static struct ast_exten *ast_hint_extension(struct ast_channel *c, const char *context, const char *exten)
1948 {
1949         struct ast_exten *e;
1950         struct pbx_find_info q = { .stacklen = 0 }; /* the rest is set in pbx_find_context */
1951
1952         ast_rdlock_contexts();
1953         e = pbx_find_extension(c, NULL, &q, context, exten, PRIORITY_HINT, NULL, "", E_MATCH);
1954         ast_unlock_contexts();
1955
1956         return e;
1957 }
1958
1959 /*! \brief Check state of extension by using hints */
1960 static int ast_extension_state2(struct ast_exten *e)
1961 {
1962         char hint[AST_MAX_EXTENSION];
1963         char *cur, *rest;
1964         int allunavailable = 1, allbusy = 1, allfree = 1, allonhold = 1;
1965         int busy = 0, inuse = 0, ring = 0;
1966
1967         if (!e)
1968                 return -1;
1969
1970         ast_copy_string(hint, ast_get_extension_app(e), sizeof(hint));
1971
1972         rest = hint;    /* One or more devices separated with a & character */
1973         while ( (cur = strsep(&rest, "&")) ) {
1974                 int res = ast_device_state(cur);
1975                 switch (res) {
1976                 case AST_DEVICE_NOT_INUSE:
1977                         allunavailable = 0;
1978                         allbusy = 0;
1979                         allonhold = 0;
1980                         break;
1981                 case AST_DEVICE_INUSE:
1982                         inuse = 1;
1983                         allunavailable = 0;
1984                         allfree = 0;
1985                         allonhold = 0;
1986                         break;
1987                 case AST_DEVICE_RINGING:
1988                         ring = 1;
1989                         allunavailable = 0;
1990                         allfree = 0;
1991                         allonhold = 0;
1992                         break;
1993                 case AST_DEVICE_RINGINUSE:
1994                         inuse = 1;
1995                         ring = 1;
1996                         allunavailable = 0;
1997                         allfree = 0;
1998                         allonhold = 0;
1999                         break;
2000                 case AST_DEVICE_ONHOLD:
2001                         allunavailable = 0;
2002                         allfree = 0;
2003                         break;
2004                 case AST_DEVICE_BUSY:
2005                         allunavailable = 0;
2006                         allfree = 0;
2007                         allonhold = 0;
2008                         busy = 1;
2009                         break;
2010                 case AST_DEVICE_UNAVAILABLE:
2011                 case AST_DEVICE_INVALID:
2012                         allbusy = 0;
2013                         allfree = 0;
2014                         allonhold = 0;
2015                         break;
2016                 default:
2017                         allunavailable = 0;
2018                         allbusy = 0;
2019                         allfree = 0;
2020                         allonhold = 0;
2021                 }
2022         }
2023
2024         if (!inuse && ring)
2025                 return AST_EXTENSION_RINGING;
2026         if (inuse && ring)
2027                 return (AST_EXTENSION_INUSE | AST_EXTENSION_RINGING);
2028         if (inuse)
2029                 return AST_EXTENSION_INUSE;
2030         if (allfree)
2031                 return AST_EXTENSION_NOT_INUSE;
2032         if (allonhold)
2033                 return AST_EXTENSION_ONHOLD;
2034         if (allbusy)
2035                 return AST_EXTENSION_BUSY;
2036         if (allunavailable)
2037                 return AST_EXTENSION_UNAVAILABLE;
2038         if (busy)
2039                 return AST_EXTENSION_INUSE;
2040
2041         return AST_EXTENSION_NOT_INUSE;
2042 }
2043
2044 /*! \brief Return extension_state as string */
2045 const char *ast_extension_state2str(int extension_state)
2046 {
2047         int i;
2048
2049         for (i = 0; (i < (sizeof(extension_states) / sizeof(extension_states[0]))); i++) {
2050                 if (extension_states[i].extension_state == extension_state)
2051                         return extension_states[i].text;
2052         }
2053         return "Unknown";
2054 }
2055
2056 /*! \brief Check extension state for an extension by using hint */
2057 int ast_extension_state(struct ast_channel *c, const char *context, const char *exten)
2058 {
2059         struct ast_exten *e;
2060
2061         e = ast_hint_extension(c, context, exten);      /* Do we have a hint for this extension ? */
2062         if (!e)
2063                 return -1;                              /* No hint, return -1 */
2064
2065         return ast_extension_state2(e);                 /* Check all devices in the hint */
2066 }
2067
2068 static void handle_statechange(const char *device)
2069 {
2070         struct ast_hint *hint;
2071
2072         AST_RWLIST_RDLOCK(&hints);
2073
2074         AST_RWLIST_TRAVERSE(&hints, hint, list) {
2075                 struct ast_state_cb *cblist;
2076                 char buf[AST_MAX_EXTENSION];
2077                 char *parse = buf;
2078                 char *cur;
2079                 int state;
2080
2081                 ast_copy_string(buf, ast_get_extension_app(hint->exten), sizeof(buf));
2082                 while ( (cur = strsep(&parse, "&")) ) {
2083                         if (!strcasecmp(cur, device))
2084                                 break;
2085                 }
2086                 if (!cur)
2087                         continue;
2088
2089                 /* Get device state for this hint */
2090                 state = ast_extension_state2(hint->exten);
2091
2092                 if ((state == -1) || (state == hint->laststate))
2093                         continue;
2094
2095                 /* Device state changed since last check - notify the watchers */
2096
2097                 /* For general callbacks */
2098                 for (cblist = statecbs; cblist; cblist = cblist->next)
2099                         cblist->callback(hint->exten->parent->name, hint->exten->exten, state, cblist->data);
2100
2101                 /* For extension callbacks */
2102                 for (cblist = hint->callbacks; cblist; cblist = cblist->next)
2103                         cblist->callback(hint->exten->parent->name, hint->exten->exten, state, cblist->data);
2104
2105                 hint->laststate = state;        /* record we saw the change */
2106         }
2107
2108         AST_RWLIST_UNLOCK(&hints);
2109 }
2110
2111 static int statechange_queue(const char *dev)
2112 {
2113         struct statechange *sc;
2114
2115         if (!(sc = ast_calloc(1, sizeof(*sc) + strlen(dev) + 1)))
2116                 return 0;
2117
2118         strcpy(sc->dev, dev);
2119
2120         ast_mutex_lock(&device_state.lock);
2121         AST_LIST_INSERT_TAIL(&device_state.state_change_q, sc, entry);
2122         ast_cond_signal(&device_state.cond);
2123         ast_mutex_unlock(&device_state.lock);
2124
2125         return 0;
2126 }
2127
2128 static void *device_state_thread(void *data)
2129 {
2130         struct statechange *sc;
2131
2132         while (!device_state.stop) {
2133                 ast_mutex_lock(&device_state.lock);
2134                 while (!(sc = AST_LIST_REMOVE_HEAD(&device_state.state_change_q, entry))) {
2135                         ast_cond_wait(&device_state.cond, &device_state.lock);
2136                         /* Check to see if we were woken up to see the request to stop */
2137                         if (device_state.stop) {
2138                                 ast_mutex_unlock(&device_state.lock);
2139                                 return NULL;
2140                         }
2141                 }
2142                 ast_mutex_unlock(&device_state.lock);
2143
2144                 handle_statechange(sc->dev);
2145
2146                 ast_free(sc);
2147         }
2148
2149         return NULL;
2150 }
2151
2152 /*! \brief  Add watcher for extension states */
2153 int ast_extension_state_add(const char *context, const char *exten,
2154                             ast_state_cb_type callback, void *data)
2155 {
2156         struct ast_hint *hint;
2157         struct ast_state_cb *cblist;
2158         struct ast_exten *e;
2159
2160         /* If there's no context and extension:  add callback to statecbs list */
2161         if (!context && !exten) {
2162                 AST_RWLIST_WRLOCK(&hints);
2163
2164                 for (cblist = statecbs; cblist; cblist = cblist->next) {
2165                         if (cblist->callback == callback) {
2166                                 cblist->data = data;
2167                                 AST_RWLIST_UNLOCK(&hints);
2168                                 return 0;
2169                         }
2170                 }
2171
2172                 /* Now insert the callback */
2173                 if (!(cblist = ast_calloc(1, sizeof(*cblist)))) {
2174                         AST_RWLIST_UNLOCK(&hints);
2175                         return -1;
2176                 }
2177                 cblist->id = 0;
2178                 cblist->callback = callback;
2179                 cblist->data = data;
2180
2181                 cblist->next = statecbs;
2182                 statecbs = cblist;
2183
2184                 AST_RWLIST_UNLOCK(&hints);
2185                 return 0;
2186         }
2187
2188         if (!context || !exten)
2189                 return -1;
2190
2191         /* This callback type is for only one hint, so get the hint */
2192         e = ast_hint_extension(NULL, context, exten);
2193         if (!e) {
2194                 return -1;
2195         }
2196
2197         /* Find the hint in the list of hints */
2198         AST_RWLIST_WRLOCK(&hints);
2199
2200         AST_RWLIST_TRAVERSE(&hints, hint, list) {
2201                 if (hint->exten == e)
2202                         break;
2203         }
2204
2205         if (!hint) {
2206                 /* We have no hint, sorry */
2207                 AST_RWLIST_UNLOCK(&hints);
2208                 return -1;
2209         }
2210
2211         /* Now insert the callback in the callback list  */
2212         if (!(cblist = ast_calloc(1, sizeof(*cblist)))) {
2213                 AST_RWLIST_UNLOCK(&hints);
2214                 return -1;
2215         }
2216         cblist->id = stateid++;         /* Unique ID for this callback */
2217         cblist->callback = callback;    /* Pointer to callback routine */
2218         cblist->data = data;            /* Data for the callback */
2219
2220         cblist->next = hint->callbacks;
2221         hint->callbacks = cblist;
2222
2223         AST_RWLIST_UNLOCK(&hints);
2224         return cblist->id;
2225 }
2226
2227 /*! \brief Remove a watcher from the callback list */
2228 int ast_extension_state_del(int id, ast_state_cb_type callback)
2229 {
2230         struct ast_state_cb **p_cur = NULL;     /* address of pointer to us */
2231         int ret = -1;
2232
2233         if (!id && !callback)
2234                 return -1;
2235
2236         AST_RWLIST_WRLOCK(&hints);
2237
2238         if (!id) {      /* id == 0 is a callback without extension */
2239                 for (p_cur = &statecbs; *p_cur; p_cur = &(*p_cur)->next) {
2240                         if ((*p_cur)->callback == callback)
2241                                 break;
2242                 }
2243         } else { /* callback with extension, find the callback based on ID */
2244                 struct ast_hint *hint;
2245                 AST_RWLIST_TRAVERSE(&hints, hint, list) {
2246                         for (p_cur = &hint->callbacks; *p_cur; p_cur = &(*p_cur)->next) {
2247                                 if ((*p_cur)->id == id)
2248                                         break;
2249                         }
2250                         if (*p_cur)     /* found in the inner loop */
2251                                 break;
2252                 }
2253         }
2254         if (p_cur && *p_cur) {
2255                 struct ast_state_cb *cur = *p_cur;
2256                 *p_cur = cur->next;
2257                 ast_free(cur);
2258                 ret = 0;
2259         }
2260         AST_RWLIST_UNLOCK(&hints);
2261         return ret;
2262 }
2263
2264 /*! \brief Add hint to hint list, check initial extension state */
2265 static int ast_add_hint(struct ast_exten *e)
2266 {
2267         struct ast_hint *hint;
2268
2269         if (!e)
2270                 return -1;
2271
2272         AST_RWLIST_WRLOCK(&hints);
2273
2274         /* Search if hint exists, do nothing */
2275         AST_RWLIST_TRAVERSE(&hints, hint, list) {
2276                 if (hint->exten == e) {
2277                         AST_RWLIST_UNLOCK(&hints);
2278                         ast_debug(2, "HINTS: Not re-adding existing hint %s: %s\n", ast_get_extension_name(e), ast_get_extension_app(e));
2279                         return -1;
2280                 }
2281         }
2282
2283         ast_debug(2, "HINTS: Adding hint %s: %s\n", ast_get_extension_name(e), ast_get_extension_app(e));
2284
2285         if (!(hint = ast_calloc(1, sizeof(*hint)))) {
2286                 AST_RWLIST_UNLOCK(&hints);
2287                 return -1;
2288         }
2289         /* Initialize and insert new item at the top */
2290         hint->exten = e;
2291         hint->laststate = ast_extension_state2(e);
2292         AST_RWLIST_INSERT_HEAD(&hints, hint, list);
2293
2294         AST_RWLIST_UNLOCK(&hints);
2295         return 0;
2296 }
2297
2298 /*! \brief Change hint for an extension */
2299 static int ast_change_hint(struct ast_exten *oe, struct ast_exten *ne)
2300 {
2301         struct ast_hint *hint;
2302         int res = -1;
2303
2304         AST_RWLIST_WRLOCK(&hints);
2305         AST_RWLIST_TRAVERSE(&hints, hint, list) {
2306                 if (hint->exten == oe) {
2307                         hint->exten = ne;
2308                         res = 0;
2309                         break;
2310                 }
2311         }
2312         AST_RWLIST_UNLOCK(&hints);
2313
2314         return res;
2315 }
2316
2317 /*! \brief Remove hint from extension */
2318 static int ast_remove_hint(struct ast_exten *e)
2319 {
2320         /* Cleanup the Notifys if hint is removed */
2321         struct ast_hint *hint;
2322         struct ast_state_cb *cblist, *cbprev;
2323         int res = -1;
2324
2325         if (!e)
2326                 return -1;
2327
2328         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&hints, hint, list) {
2329                 if (hint->exten == e) {
2330                         cbprev = NULL;
2331                         cblist = hint->callbacks;
2332                         while (cblist) {
2333                                 /* Notify with -1 and remove all callbacks */
2334                                 cbprev = cblist;
2335                                 cblist = cblist->next;
2336                                 cbprev->callback(hint->exten->parent->name, hint->exten->exten, AST_EXTENSION_DEACTIVATED, cbprev->data);
2337                                 ast_free(cbprev);
2338                         }
2339                         hint->callbacks = NULL;
2340                         AST_RWLIST_REMOVE_CURRENT(&hints, list);
2341                         ast_free(hint);
2342                         res = 0;
2343                         break;
2344                 }
2345         }
2346         AST_RWLIST_TRAVERSE_SAFE_END
2347
2348         return res;
2349 }
2350
2351
2352 /*! \brief Get hint for channel */
2353 int ast_get_hint(char *hint, int hintsize, char *name, int namesize, struct ast_channel *c, const char *context, const char *exten)
2354 {
2355         struct ast_exten *e = ast_hint_extension(c, context, exten);
2356
2357         if (e) {
2358                 if (hint)
2359                         ast_copy_string(hint, ast_get_extension_app(e), hintsize);
2360                 if (name) {
2361                         const char *tmp = ast_get_extension_app_data(e);
2362                         if (tmp)
2363                                 ast_copy_string(name, tmp, namesize);
2364                 }
2365                 return -1;
2366         }
2367         return 0;
2368 }
2369
2370 int ast_exists_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
2371 {
2372         return pbx_extension_helper(c, NULL, context, exten, priority, NULL, callerid, E_MATCH);
2373 }
2374
2375 int ast_findlabel_extension(struct ast_channel *c, const char *context, const char *exten, const char *label, const char *callerid)
2376 {
2377         return pbx_extension_helper(c, NULL, context, exten, 0, label, callerid, E_FINDLABEL);
2378 }
2379
2380 int ast_findlabel_extension2(struct ast_channel *c, struct ast_context *con, const char *exten, const char *label, const char *callerid)
2381 {
2382         return pbx_extension_helper(c, con, NULL, exten, 0, label, callerid, E_FINDLABEL);
2383 }
2384
2385 int ast_canmatch_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
2386 {
2387         return pbx_extension_helper(c, NULL, context, exten, priority, NULL, callerid, E_CANMATCH);
2388 }
2389
2390 int ast_matchmore_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
2391 {
2392         return pbx_extension_helper(c, NULL, context, exten, priority, NULL, callerid, E_MATCHMORE);
2393 }
2394
2395 int ast_spawn_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
2396 {
2397         return pbx_extension_helper(c, NULL, context, exten, priority, NULL, callerid, E_SPAWN);
2398 }
2399
2400 /*! helper function to set extension and priority */
2401 static void set_ext_pri(struct ast_channel *c, const char *exten, int pri)
2402 {
2403         ast_copy_string(c->exten, exten, sizeof(c->exten));
2404         c->priority = pri;
2405 }
2406
2407 /*!
2408  * \brief collect digits from the channel into the buffer.
2409  * \retval 0 on timeout or done.
2410  * \retval -1 on error.
2411 */
2412 static int collect_digits(struct ast_channel *c, int waittime, char *buf, int buflen, int pos)
2413 {
2414         int digit;
2415
2416         buf[pos] = '\0';        /* make sure it is properly terminated */
2417         while (ast_matchmore_extension(c, c->context, buf, 1, c->cid.cid_num)) {
2418                 /* As long as we're willing to wait, and as long as it's not defined,
2419                    keep reading digits until we can't possibly get a right answer anymore.  */
2420                 digit = ast_waitfordigit(c, waittime * 1000);
2421                 if (c->_softhangup == AST_SOFTHANGUP_ASYNCGOTO) {
2422                         c->_softhangup = 0;
2423                 } else {
2424                         if (!digit)     /* No entry */
2425                                 break;
2426                         if (digit < 0)  /* Error, maybe a  hangup */
2427                                 return -1;
2428                         if (pos < buflen - 1) { /* XXX maybe error otherwise ? */
2429                                 buf[pos++] = digit;
2430                                 buf[pos] = '\0';
2431                         }
2432                         waittime = c->pbx->dtimeout;
2433                 }
2434         }
2435         return 0;
2436 }
2437
2438 static int __ast_pbx_run(struct ast_channel *c)
2439 {
2440         int found = 0;  /* set if we find at least one match */
2441         int res = 0;
2442         int autoloopflag;
2443         int error = 0;          /* set an error conditions */
2444
2445         /* A little initial setup here */
2446         if (c->pbx) {
2447                 ast_log(LOG_WARNING, "%s already has PBX structure??\n", c->name);
2448                 /* XXX and now what ? */
2449                 ast_free(c->pbx);
2450         }
2451         if (!(c->pbx = ast_calloc(1, sizeof(*c->pbx))))
2452                 return -1;
2453         if (c->amaflags) {
2454                 if (!c->cdr) {
2455                         c->cdr = ast_cdr_alloc();
2456                         if (!c->cdr) {
2457                                 ast_log(LOG_WARNING, "Unable to create Call Detail Record\n");
2458                                 ast_free(c->pbx);
2459                                 return -1;
2460                         }
2461                         ast_cdr_init(c->cdr, c);
2462                 }
2463         }
2464         /* Set reasonable defaults */
2465         c->pbx->rtimeout = 10;
2466         c->pbx->dtimeout = 5;
2467
2468         autoloopflag = ast_test_flag(c, AST_FLAG_IN_AUTOLOOP);  /* save value to restore at the end */
2469         ast_set_flag(c, AST_FLAG_IN_AUTOLOOP);
2470
2471         /* Start by trying whatever the channel is set to */
2472         if (!ast_exists_extension(c, c->context, c->exten, c->priority, c->cid.cid_num)) {
2473                 /* If not successful fall back to 's' */
2474                 ast_verb(2, "Starting %s at %s,%s,%d failed so falling back to exten 's'\n", c->name, c->context, c->exten, c->priority);
2475                 /* XXX the original code used the existing priority in the call to
2476                  * ast_exists_extension(), and reset it to 1 afterwards.
2477                  * I believe the correct thing is to set it to 1 immediately.
2478                  */
2479                 set_ext_pri(c, "s", 1);
2480                 if (!ast_exists_extension(c, c->context, c->exten, c->priority, c->cid.cid_num)) {
2481                         /* JK02: And finally back to default if everything else failed */
2482                         ast_verb(2, "Starting %s at %s,%s,%d still failed so falling back to context 'default'\n", c->name, c->context, c->exten, c->priority);
2483                         ast_copy_string(c->context, "default", sizeof(c->context));
2484                 }
2485         }
2486         if (c->cdr && ast_tvzero(c->cdr->start))
2487                 ast_cdr_start(c->cdr);
2488         for (;;) {
2489                 char dst_exten[256];    /* buffer to accumulate digits */
2490                 int pos = 0;            /* XXX should check bounds */
2491                 int digit = 0;
2492
2493                 /* loop on priorities in this context/exten */
2494                 while (ast_exists_extension(c, c->context, c->exten, c->priority, c->cid.cid_num)) {
2495                         found = 1;
2496                         if ((res = ast_spawn_extension(c, c->context, c->exten, c->priority, c->cid.cid_num))) {
2497                                 /* Something bad happened, or a hangup has been requested. */
2498                                 if (strchr("0123456789ABCDEF*#", res)) {
2499                                         ast_debug(1, "Oooh, got something to jump out with ('%c')!\n", res);
2500                                         pos = 0;
2501                                         dst_exten[pos++] = digit = res;
2502                                         dst_exten[pos] = '\0';
2503                                         break;
2504                                 }
2505                                 if (res == AST_PBX_KEEPALIVE) {
2506                                         ast_debug(1, "Spawn extension (%s,%s,%d) exited KEEPALIVE on '%s'\n", c->context, c->exten, c->priority, c->name);
2507                                         ast_verb(2, "Spawn extension (%s, %s, %d) exited KEEPALIVE on '%s'\n", c->context, c->exten, c->priority, c->name);
2508                                         error = 1;
2509                                         break;
2510                                 }
2511                                 ast_debug(1, "Spawn extension (%s,%s,%d) exited non-zero on '%s'\n", c->context, c->exten, c->priority, c->name);
2512                                 ast_verb(2, "Spawn extension (%s, %s, %d) exited non-zero on '%s'\n", c->context, c->exten, c->priority, c->name);
2513
2514                                 if ((res == AST_PBX_ERROR) && ast_exists_extension(c, c->context, "e", 1, c->cid.cid_num)) {
2515                                         /* if we are already on the 'e' exten, don't jump to it again */
2516                                         if (!strcmp(c->exten, "e")) {
2517                                                 if (option_verbose > 1)
2518                                                         ast_verbose(VERBOSE_PREFIX_2 "Spawn extension (%s, %s, %d) exited ERROR while already on 'e' exten on '%s'\n", c->context, c->exten, c->priority, c->name);
2519                                                 error = 1;
2520                                                 break;
2521                                         } else {
2522                                                 pbx_builtin_raise_exception(c, "ERROR");
2523                                                 continue;
2524                                         }
2525                                 }
2526
2527                                 if (c->_softhangup == AST_SOFTHANGUP_ASYNCGOTO) {
2528                                         c->_softhangup = 0;
2529                                 } else if (c->_softhangup == AST_SOFTHANGUP_TIMEOUT) {
2530                                         /* atimeout, nothing bad */
2531                                 } else {
2532                                         if (c->cdr)
2533                                                 ast_cdr_update(c);
2534                                         error = 1;
2535                                         break;
2536                                 }
2537                         }
2538                         if (c->_softhangup == AST_SOFTHANGUP_TIMEOUT && ast_exists_extension(c, c->context, "T", 1, c->cid.cid_num)) {
2539                                 set_ext_pri(c, "T", 0); /* 0 will become 1 with the c->priority++; at the end */
2540                                 /* If the AbsoluteTimeout is not reset to 0, we'll get an infinite loop */
2541                                 c->whentohangup = 0;
2542                                 c->_softhangup &= ~AST_SOFTHANGUP_TIMEOUT;
2543                         } else if (c->_softhangup == AST_SOFTHANGUP_TIMEOUT && ast_exists_extension(c, c->context, "e", 1, c->cid.cid_num)) {
2544                                 pbx_builtin_raise_exception(c, "ABSOLUTETIMEOUT");
2545                                 /* If the AbsoluteTimeout is not reset to 0, we'll get an infinite loop */
2546                                 c->whentohangup = 0;
2547                                 c->_softhangup &= ~AST_SOFTHANGUP_TIMEOUT;
2548                         } else if (ast_check_hangup(c)) {
2549                                 ast_debug(1, "Extension %s, priority %d returned normally even though call was hung up\n",
2550                                         c->exten, c->priority);
2551                                 error = 1;
2552                                 break;
2553                         }
2554                         c->priority++;
2555                 } /* end while  - from here on we can use 'break' to go out */
2556                 if (error)
2557                         break;
2558
2559                 /*!\note
2560                  * We get here on a failure of some kind:  non-existing extension or
2561                  * hangup.  We have options, here.  We can either catch the failure
2562                  * and continue, or we can drop out entirely. */
2563
2564                 if (!ast_exists_extension(c, c->context, c->exten, 1, c->cid.cid_num)) {
2565                         /*!\note
2566                          * If there is no match at priority 1, it is not a valid extension anymore.
2567                          * Try to continue at "i" (for invalid) or "e" (for exception) or exit if
2568                          * neither exist.
2569                          */
2570                         if (ast_exists_extension(c, c->context, "i", 1, c->cid.cid_num)) {
2571                                 ast_verb(3, "Sent into invalid extension '%s' in context '%s' on %s\n", c->exten, c->context, c->name);
2572                                 pbx_builtin_setvar_helper(c, "INVALID_EXTEN", c->exten);
2573                                 set_ext_pri(c, "i", 1);
2574                         } else if (ast_exists_extension(c, c->context, "e", 1, c->cid.cid_num)) {
2575                                 pbx_builtin_raise_exception(c, "INVALID");
2576                         } else {
2577                                 ast_log(LOG_WARNING, "Channel '%s' sent into invalid extension '%s' in context '%s', but no invalid handler\n",
2578                                         c->name, c->exten, c->context);
2579                                 error = 1; /* we know what to do with it */
2580                                 break;
2581                         }
2582                 } else if (c->_softhangup == AST_SOFTHANGUP_TIMEOUT) {
2583                         /* If we get this far with AST_SOFTHANGUP_TIMEOUT, then we know that the "T" extension is next. */
2584                         c->_softhangup = 0;
2585                 } else {        /* keypress received, get more digits for a full extension */
2586                         int waittime = 0;
2587                         if (digit)
2588                                 waittime = c->pbx->dtimeout;
2589                         else if (!autofallthrough)
2590                                 waittime = c->pbx->rtimeout;
2591                         if (!waittime) {
2592                                 const char *status = pbx_builtin_getvar_helper(c, "DIALSTATUS");
2593                                 if (!status)
2594                                         status = "UNKNOWN";
2595                                 ast_verb(3, "Auto fallthrough, channel '%s' status is '%s'\n", c->name, status);
2596                                 if (!strcasecmp(status, "CONGESTION"))
2597                                         res = pbx_builtin_congestion(c, "10");
2598                                 else if (!strcasecmp(status, "CHANUNAVAIL"))
2599                                         res = pbx_builtin_congestion(c, "10");
2600                                 else if (!strcasecmp(status, "BUSY"))
2601                                         res = pbx_builtin_busy(c, "10");
2602                                 error = 1; /* XXX disable message */
2603                                 break;  /* exit from the 'for' loop */
2604                         }
2605
2606                         if (collect_digits(c, waittime, dst_exten, sizeof(dst_exten), pos))
2607                                 break;
2608                         if (ast_exists_extension(c, c->context, dst_exten, 1, c->cid.cid_num)) /* Prepare the next cycle */
2609                                 set_ext_pri(c, dst_exten, 1);
2610                         else {
2611                                 /* No such extension */
2612                                 if (!ast_strlen_zero(dst_exten)) {
2613                                         /* An invalid extension */
2614                                         if (ast_exists_extension(c, c->context, "i", 1, c->cid.cid_num)) {
2615                                                 ast_verb(3, "Invalid extension '%s' in context '%s' on %s\n", dst_exten, c->context, c->name);
2616                                                 pbx_builtin_setvar_helper(c, "INVALID_EXTEN", dst_exten);
2617                                                 set_ext_pri(c, "i", 1);
2618                                         } else if (ast_exists_extension(c, c->context, "e", 1, c->cid.cid_num)) {
2619                                                 pbx_builtin_raise_exception(c, "INVALID");
2620                                         } else {
2621                                                 ast_log(LOG_WARNING, "Invalid extension '%s', but no rule 'i' in context '%s'\n", dst_exten, c->context);
2622                                                 found = 1; /* XXX disable message */
2623                                                 break;
2624                                         }
2625                                 } else {
2626                                         /* A simple timeout */
2627                                         if (ast_exists_extension(c, c->context, "t", 1, c->cid.cid_num)) {
2628                                                 ast_verb(3, "Timeout on %s\n", c->name);
2629                                                 set_ext_pri(c, "t", 1);
2630                                         } else if (ast_exists_extension(c, c->context, "e", 1, c->cid.cid_num)) {
2631                                                 pbx_builtin_raise_exception(c, "RESPONSETIMEOUT");
2632                                         } else {
2633                                                 ast_log(LOG_WARNING, "Timeout, but no rule 't' in context '%s'\n", c->context);
2634                                                 found = 1; /* XXX disable message */
2635                                                 break;
2636                                         }
2637                                 }
2638                         }
2639                         if (c->cdr) {
2640                                 ast_verb(2, "CDR updated on %s\n",c->name);
2641                                 ast_cdr_update(c);
2642                         }
2643                 }
2644         }
2645         if (!found && !error)
2646                 ast_log(LOG_WARNING, "Don't know what to do with '%s'\n", c->name);
2647         if (res != AST_PBX_KEEPALIVE)
2648                 ast_softhangup(c, c->hangupcause ? c->hangupcause : AST_CAUSE_NORMAL_CLEARING);
2649         if ((res != AST_PBX_KEEPALIVE) && ast_exists_extension(c, c->context, "h", 1, c->cid.cid_num)) {
2650                 if (c->cdr && ast_opt_end_cdr_before_h_exten)
2651                         ast_cdr_end(c->cdr);
2652                 set_ext_pri(c, "h", 1);
2653                 while (ast_exists_extension(c, c->context, c->exten, c->priority, c->cid.cid_num)) {
2654                         if ((res = ast_spawn_extension(c, c->context, c->exten, c->priority, c->cid.cid_num))) {
2655                                 /* Something bad happened, or a hangup has been requested. */
2656                                 ast_debug(1, "Spawn extension (%s,%s,%d) exited non-zero on '%s'\n", c->context, c->exten, c->priority, c->name);
2657                                 ast_verb(2, "Spawn extension (%s, %s, %d) exited non-zero on '%s'\n", c->context, c->exten, c->priority, c->name);
2658                                 break;
2659                         }
2660                         c->priority++;
2661                 }
2662         }
2663         ast_set2_flag(c, autoloopflag, AST_FLAG_IN_AUTOLOOP);
2664
2665         pbx_destroy(c->pbx);
2666         c->pbx = NULL;
2667         if (res != AST_PBX_KEEPALIVE)
2668                 ast_hangup(c);
2669         return 0;
2670 }
2671
2672 /*! 
2673  * \brief Increase call count for channel
2674  * \retval 0 on success
2675  * \retval non-zero if a configured limit (maxcalls, maxload, minmemfree) was reached 
2676 */
2677 static int increase_call_count(const struct ast_channel *c)
2678 {
2679         int failed = 0;
2680         double curloadavg;
2681 #if defined(HAVE_SYSINFO)
2682         long curfreemem;
2683         struct sysinfo sys_info;
2684 #endif
2685
2686         ast_mutex_lock(&maxcalllock);
2687         if (option_maxcalls) {
2688                 if (countcalls >= option_maxcalls) {
2689                         ast_log(LOG_NOTICE, "Maximum call limit of %d calls exceeded by '%s'!\n", option_maxcalls, c->name);
2690                         failed = -1;
2691                 }
2692         }
2693         if (option_maxload) {
2694                 getloadavg(&curloadavg, 1);
2695                 if (curloadavg >= option_maxload) {
2696                         ast_log(LOG_NOTICE, "Maximum loadavg limit of %f load exceeded by '%s' (currently %f)!\n", option_maxload, c->name, curloadavg);
2697                         failed = -1;
2698                 }
2699         }
2700 #if defined(HAVE_SYSINFO)
2701         if (option_minmemfree) {
2702                 if (!sysinfo(&sys_info)) {
2703                         /* make sure that the free system memory is above the configured low watermark
2704                          * convert the amount of freeram from mem_units to MB */
2705                         curfreemem = sys_info.freeram / sys_info.mem_unit; 
2706                         curfreemem /= 1024*1024; 
2707                         if (curfreemem < option_minmemfree) {
2708                                 ast_log(LOG_WARNING, "Available system memory (~%ldMB) is below the configured low watermark (%ldMB)\n", curfreemem, option_minmemfree);
2709                                 failed = -1;
2710                         }
2711                 }
2712         }
2713 #endif
2714                 
2715         if (!failed)
2716                 countcalls++;
2717         ast_mutex_unlock(&maxcalllock);
2718
2719         return failed;
2720 }
2721
2722 static void decrease_call_count(void)
2723 {
2724         ast_mutex_lock(&maxcalllock);
2725         if (countcalls > 0)
2726                 countcalls--;
2727         ast_mutex_unlock(&maxcalllock);
2728 }
2729
2730 static void destroy_exten(struct ast_exten *e)
2731 {
2732         if (e->priority == PRIORITY_HINT)
2733                 ast_remove_hint(e);
2734
2735         if (e->datad)
2736                 e->datad(e->data);
2737         ast_free(e);
2738 }
2739
2740 static void *pbx_thread(void *data)
2741 {
2742         /* Oh joyeous kernel, we're a new thread, with nothing to do but
2743            answer this channel and get it going.
2744         */
2745         /* NOTE:
2746            The launcher of this function _MUST_ increment 'countcalls'
2747            before invoking the function; it will be decremented when the
2748            PBX has finished running on the channel
2749          */
2750         struct ast_channel *c = data;
2751
2752         __ast_pbx_run(c);
2753         decrease_call_count();
2754
2755         pthread_exit(NULL);
2756
2757         return NULL;
2758 }
2759
2760 enum ast_pbx_result ast_pbx_start(struct ast_channel *c)
2761 {
2762         pthread_t t;
2763
2764         if (!c) {
2765                 ast_log(LOG_WARNING, "Asked to start thread on NULL channel?\n");
2766                 return AST_PBX_FAILED;
2767         }
2768
2769         if (increase_call_count(c))
2770                 return AST_PBX_CALL_LIMIT;
2771
2772         /* Start a new thread, and get something handling this channel. */
2773         if (ast_pthread_create_detached(&t, NULL, pbx_thread, c)) {
2774                 ast_log(LOG_WARNING, "Failed to create new channel thread\n");
2775                 return AST_PBX_FAILED;
2776         }
2777
2778         return AST_PBX_SUCCESS;
2779 }
2780
2781 enum ast_pbx_result ast_pbx_run(struct ast_channel *c)
2782 {
2783         enum ast_pbx_result res = AST_PBX_SUCCESS;
2784
2785         if (increase_call_count(c))
2786                 return AST_PBX_CALL_LIMIT;
2787
2788         res = __ast_pbx_run(c);
2789         decrease_call_count();
2790
2791         return res;
2792 }
2793
2794 int ast_active_calls(void)
2795 {
2796         return countcalls;
2797 }
2798
2799 int pbx_set_autofallthrough(int newval)
2800 {
2801         int oldval = autofallthrough;
2802         autofallthrough = newval;
2803         return oldval;
2804 }
2805
2806 /*!
2807  * \brief lookup for a context with a given name,
2808  * \retval with conlock held if found.
2809  * \retval NULL if not found.
2810 */
2811 static struct ast_context *find_context_locked(const char *context)
2812 {
2813         struct ast_context *c = NULL;
2814
2815         ast_rdlock_contexts();
2816         while ( (c = ast_walk_contexts(c)) ) {
2817                 if (!strcmp(ast_get_context_name(c), context))
2818                         return c;
2819         }
2820         ast_unlock_contexts();
2821
2822         return NULL;
2823 }
2824
2825 /*!
2826  * \brief Remove included contexts.
2827  * This function locks contexts list by &conlist, search for the right context
2828  * structure, leave context list locked and call ast_context_remove_include2
2829  * which removes include, unlock contexts list and return ...
2830 */
2831 int ast_context_remove_include(const char *context, const char *include, const char *registrar)
2832 {
2833         int ret = -1;
2834         struct ast_context *c = find_context_locked(context);
2835
2836         if (c) {
2837                 /* found, remove include from this context ... */
2838                 ret = ast_context_remove_include2(c, include, registrar);
2839                 ast_unlock_contexts();
2840         }
2841         return ret;
2842 }
2843
2844 /*!
2845  * \brief Locks context, remove included contexts, unlocks context.
2846  * When we call this function, &conlock lock must be locked, because when
2847  * we giving *con argument, some process can remove/change this context
2848  * and after that there can be segfault.
2849  *
2850  * \retval 0 on success.
2851  * \retval -1 on failure.
2852  */
2853 int ast_context_remove_include2(struct ast_context *con, const char *include, const char *registrar)
2854 {
2855         struct ast_include *i, *pi = NULL;
2856         int ret = -1;
2857
2858         ast_wrlock_context(con);
2859
2860         /* find our include */
2861         for (i = con->includes; i; pi = i, i = i->next) {
2862                 if (!strcmp(i->name, include) &&
2863                                 (!registrar || !strcmp(i->registrar, registrar))) {
2864                         /* remove from list */
2865                         if (pi)
2866                                 pi->next = i->next;
2867                         else
2868                                 con->includes = i->next;
2869                         /* free include and return */
2870                         ast_free(i);
2871                         ret = 0;
2872                         break;
2873                 }
2874         }
2875
2876         ast_unlock_context(con);
2877
2878         return ret;
2879 }
2880
2881 /*!
2882  * \note This function locks contexts list by &conlist, search for the rigt context
2883  * structure, leave context list locked and call ast_context_remove_switch2
2884  * which removes switch, unlock contexts list and return ...
2885  */
2886 int ast_context_remove_switch(const char *context, const char *sw, const char *data, const char *registrar)
2887 {
2888         int ret = -1; /* default error return */
2889         struct ast_context *c = find_context_locked(context);
2890
2891         if (c) {
2892                 /* remove switch from this context ... */
2893                 ret = ast_context_remove_switch2(c, sw, data, registrar);
2894                 ast_unlock_contexts();
2895         }
2896         return ret;
2897 }
2898
2899 /*!
2900  * \brief This function locks given context, removes switch, unlock context and
2901  * return.
2902  * \note When we call this function, &conlock lock must be locked, because when
2903  * we giving *con argument, some process can remove/change this context
2904  * and after that there can be segfault.
2905  *
2906  */
2907 int ast_context_remove_switch2(struct ast_context *con, const char *sw, const char *data, const char *registrar)
2908 {
2909         struct ast_sw *i;
2910         int ret = -1;
2911
2912         ast_wrlock_context(con);
2913
2914         /* walk switches */
2915         AST_LIST_TRAVERSE_SAFE_BEGIN(&con->alts, i, list) {
2916                 if (!strcmp(i->name, sw) && !strcmp(i->data, data) &&
2917                         (!registrar || !strcmp(i->registrar, registrar))) {
2918                         /* found, remove from list */
2919                         AST_LIST_REMOVE_CURRENT(&con->alts, list);
2920                         ast_free(i); /* free switch and return */
2921                         ret = 0;
2922                         break;
2923                 }
2924         }
2925         AST_LIST_TRAVERSE_SAFE_END
2926
2927         ast_unlock_context(con);
2928
2929         return ret;
2930 }
2931
2932 /*
2933  * \note This functions lock contexts list, search for the right context,
2934  * call ast_context_remove_extension2, unlock contexts list and return.
2935  * In this function we are using
2936  */
2937 int ast_context_remove_extension(const char *context, const char *extension, int priority, const char *registrar)
2938 {
2939         int ret = -1; /* default error return */
2940         struct ast_context *c = find_context_locked(context);
2941
2942         if (c) { /* ... remove extension ... */
2943                 ret = ast_context_remove_extension2(c, extension, priority, registrar);
2944                 ast_unlock_contexts();
2945         }
2946         return ret;
2947 }
2948
2949 /*!
2950  * \brief This functionc locks given context, search for the right extension and
2951  * fires out all peer in this extensions with given priority. If priority
2952  * is set to 0, all peers are removed. After that, unlock context and
2953  * return.
2954  * \note When do you want to call this function, make sure that &conlock is locked,
2955  * because some process can handle with your *con context before you lock
2956  * it.
2957  *
2958  */
2959 int ast_context_remove_extension2(struct ast_context *con, const char *extension, int priority, const char *registrar)
2960 {
2961         struct ast_exten *exten, *prev_exten = NULL;
2962         struct ast_exten *peer;
2963
2964         ast_wrlock_context(con);
2965
2966         /* scan the extension list to find matching extension-registrar */
2967         for (exten = con->root; exten; prev_exten = exten, exten = exten->next) {
2968                 if (!strcmp(exten->exten, extension) &&
2969                         (!registrar || !strcmp(exten->registrar, registrar)))
2970                         break;
2971         }
2972         if (!exten) {
2973                 /* we can't find right extension */
2974                 ast_unlock_context(con);
2975                 return -1;
2976         }
2977
2978         /* should we free all peers in this extension? (priority == 0)? */
2979         if (priority == 0) {
2980                 /* remove this extension from context list */
2981                 if (prev_exten)
2982                         prev_exten->next = exten->next;
2983                 else
2984                         con->root = exten->next;
2985
2986                 /* fire out all peers */
2987                 while ( (peer = exten) ) {
2988                         exten = peer->peer; /* prepare for next entry */
2989                         destroy_exten(peer);
2990                 }
2991         } else {
2992                 /* scan the priority list to remove extension with exten->priority == priority */
2993                 struct ast_exten *previous_peer = NULL;
2994
2995                 for (peer = exten; peer; previous_peer = peer, peer = peer->peer) {
2996                         if (peer->priority == priority &&
2997                                         (!registrar || !strcmp(peer->registrar, registrar) ))
2998                                 break; /* found our priority */
2999                 }
3000                 if (!peer) { /* not found */
3001                         ast_unlock_context(con);
3002                         return -1;
3003                 }
3004                 /* we are first priority extension? */
3005                 if (!previous_peer) {
3006                         /*
3007                          * We are first in the priority chain, so must update the extension chain.
3008                          * The next node is either the next priority or the next extension
3009                          */
3010                         struct ast_exten *next_node = peer->peer ? peer->peer : peer->next;
3011
3012                         if (!prev_exten)        /* change the root... */
3013                                 con->root = next_node;
3014                         else
3015                                 prev_exten->next = next_node; /* unlink */
3016                         if (peer->peer) /* XXX update the new head of the pri list */
3017                                 peer->peer->next = peer->next;
3018                 } else { /* easy, we are not first priority in extension */
3019                         previous_peer->peer = peer->peer;
3020                 }
3021
3022                 /* now, free whole priority extension */
3023                 destroy_exten(peer);
3024                 /* XXX should we return -1 ? */
3025         }
3026         ast_unlock_context(con);
3027         return 0;
3028 }
3029
3030
3031 /*!
3032  * \note This function locks contexts list by &conlist, searches for the right context
3033  * structure, and locks the macrolock mutex in that context.
3034  * macrolock is used to limit a macro to be executed by one call at a time.
3035  */
3036 int ast_context_lockmacro(const char *context)
3037 {
3038         struct ast_context *c = NULL;
3039         int ret = -1;
3040
3041         ast_rdlock_contexts();
3042
3043         while ((c = ast_walk_contexts(c))) {
3044                 if (!strcmp(ast_get_context_name(c), context)) {
3045                         ret = 0;
3046                         break;
3047                 }
3048         }
3049
3050         ast_unlock_contexts();
3051
3052         /* if we found context, lock macrolock */
3053         if (ret == 0) 
3054                 ret = ast_mutex_lock(&c->macrolock);
3055
3056         return ret;
3057 }
3058
3059 /*!
3060  * \note This function locks contexts list by &conlist, searches for the right context
3061  * structure, and unlocks the macrolock mutex in that context.
3062  * macrolock is used to limit a macro to be executed by one call at a time.
3063  */
3064 int ast_context_unlockmacro(const char *context)
3065 {
3066         struct ast_context *c = NULL;
3067         int ret = -1;
3068
3069         ast_rdlock_contexts();
3070
3071         while ((c = ast_walk_contexts(c))) {
3072                 if (!strcmp(ast_get_context_name(c), context)) {
3073                         ret = 0;
3074                         break;
3075                 }
3076         }
3077
3078         ast_unlock_contexts();
3079
3080         /* if we found context, unlock macrolock */
3081         if (ret == 0) 
3082                 ret = ast_mutex_unlock(&c->macrolock);
3083
3084         return ret;
3085 }
3086
3087 /*! \brief Dynamically register a new dial plan application */
3088 int ast_register_application2(const char *app, int (*execute)(struct ast_channel *, void *), const char *synopsis, const char *description, void *mod)
3089 {
3090         struct ast_app *tmp, *cur = NULL;
3091         char tmps[80];
3092         int length, res;
3093
3094         AST_RWLIST_WRLOCK(&apps);
3095         AST_RWLIST_TRAVERSE(&apps, tmp, list) {
3096                 if (!(res = strcasecmp(app, tmp->name))) {
3097                         ast_log(LOG_WARNING, "Already have an application '%s'\n", app);
3098                         AST_RWLIST_UNLOCK(&apps);
3099                         return -1;
3100                 } else if (res < 0)
3101                         break;
3102         }
3103
3104         length = sizeof(*tmp) + strlen(app) + 1;
3105
3106         if (!(tmp = ast_calloc(1, length))) {
3107                 AST_RWLIST_UNLOCK(&apps);
3108                 return -1;
3109         }
3110
3111         strcpy(tmp->name, app);
3112         tmp->execute = execute;
3113         tmp->synopsis = synopsis;
3114         tmp->description = description;
3115         tmp->module = mod;
3116
3117         /* Store in alphabetical order */
3118         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, cur, list) {
3119                 if (strcasecmp(tmp->name, cur->name) < 0) {
3120                         AST_RWLIST_INSERT_BEFORE_CURRENT(&apps, tmp, list);
3121                         break;
3122                 }
3123         }
3124         AST_RWLIST_TRAVERSE_SAFE_END
3125         if (!cur)
3126                 AST_RWLIST_INSERT_TAIL(&apps, tmp, list);
3127
3128         ast_verb(2, "Registered application '%s'\n", term_color(tmps, tmp->name, COLOR_BRCYAN, 0, sizeof(tmps)));
3129
3130         AST_RWLIST_UNLOCK(&apps);</