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