895b8b855644e7f6ee5cf7e5584bc195c9eac1c3
[asterisk/asterisk.git] / main / cli.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 Standard Command Line Interface
22  *
23  * \author Mark Spencer <markster@digium.com> 
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <unistd.h>
31 #include <stdlib.h>
32 #include <sys/signal.h>
33 #include <stdio.h>
34 #include <signal.h>
35 #include <string.h>
36 #include <ctype.h>
37 #include <regex.h>
38
39 #include "asterisk/logger.h"
40 #include "asterisk/options.h"
41 #include "asterisk/cli.h"
42 #include "asterisk/linkedlists.h"
43 #include "asterisk/module.h"
44 #include "asterisk/pbx.h"
45 #include "asterisk/channel.h"
46 #include "asterisk/utils.h"
47 #include "asterisk/app.h"
48 #include "asterisk/lock.h"
49 #include "editline/readline/readline.h"
50 #include "asterisk/threadstorage.h"
51
52 extern unsigned long global_fin, global_fout;
53
54 AST_THREADSTORAGE(ast_cli_buf);
55
56 /*! \brief Initial buffer size for resulting strings in ast_cli() */
57 #define AST_CLI_INITLEN   256
58
59 void ast_cli(int fd, char *fmt, ...)
60 {
61         int res;
62         struct ast_dynamic_str *buf;
63         va_list ap;
64
65         if (!(buf = ast_dynamic_str_thread_get(&ast_cli_buf, AST_CLI_INITLEN)))
66                 return;
67
68         va_start(ap, fmt);
69         res = ast_dynamic_str_thread_set_va(&buf, 0, &ast_cli_buf, fmt, ap);
70         va_end(ap);
71
72         if (res != AST_DYNSTR_BUILD_FAILED)
73                 ast_carefulwrite(fd, buf->str, strlen(buf->str), 100);
74 }
75
76 static AST_LIST_HEAD_STATIC(helpers, ast_cli_entry);
77
78 static const char logger_mute_help[] = 
79 "Usage: logger mute\n"
80 "       Disables logging output to the current console, making it possible to\n"
81 "       gather information without being disturbed by scrolling lines.\n";
82
83 static const char softhangup_help[] =
84 "Usage: soft hangup <channel>\n"
85 "       Request that a channel be hung up. The hangup takes effect\n"
86 "       the next time the driver reads or writes from the channel\n";
87
88 static const char group_show_channels_help[] = 
89 "Usage: group show channels [pattern]\n"
90 "       Lists all currently active channels with channel group(s) specified.\n"
91 "       Optional regular expression pattern is matched to group names for each\n"
92 "       channel.\n";
93
94 static char *complete_fn(const char *word, int state)
95 {
96         char *c;
97         char filename[256];
98
99         if (word[0] == '/')
100                 ast_copy_string(filename, word, sizeof(filename));
101         else
102                 snprintf(filename, sizeof(filename), "%s/%s", ast_config_AST_MODULE_DIR, word);
103
104         /* XXX the following function is not reentrant, so we better not use it */
105         c = filename_completion_function(filename, state);
106         
107         if (c && word[0] != '/')
108                 c += (strlen(ast_config_AST_MODULE_DIR) + 1);
109         
110         return c ? strdup(c) : c;
111 }
112
113 static char *handle_load(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
114 {
115         /* "module load <mod>" */
116         switch (cmd) {
117         case CLI_INIT:
118                 e->command = "module load";
119                 e->usage =
120                         "Usage: module load <module name>\n"
121                         "       Loads the specified module into Asterisk.\n";
122                 return NULL;
123
124         case CLI_GENERATE:
125                 if (a->argc != e->args + 1)
126                         return NULL;
127                 return complete_fn(a->word, a->n);
128         }
129         if (a->argc != e->args + 1)
130                 return CLI_SHOWUSAGE;
131         if (ast_load_resource(a->argv[e->args])) {
132                 ast_cli(a->fd, "Unable to load module %s\n", a->argv[e->args]);
133                 return CLI_FAILURE;
134         }
135         return CLI_SUCCESS;
136 }
137
138 static char *handle_load_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
139 {
140         char *res = handle_load(e, cmd, a);
141         if (cmd == CLI_INIT)
142                 e->command = "load";
143         return res;
144 }
145
146 static char *handle_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
147 {
148         int x;
149
150         switch (cmd) {
151         case CLI_INIT:
152                 e->command = "module reload";
153                 e->usage =
154                         "Usage: module reload [module ...]\n"
155                         "       Reloads configuration files for all listed modules which support\n"
156                         "       reloading, or for all supported modules if none are listed.\n";
157                 return NULL;
158
159         case CLI_GENERATE:
160                 return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 1);
161         }
162         if (a->argc == e->args) {
163                 ast_module_reload(NULL);
164                 return CLI_SUCCESS;
165         }
166         for (x = e->args; x < a->argc; x++) {
167                 int res = ast_module_reload(a->argv[x]);
168                 /* XXX reload has multiple error returns, including -1 on error and 2 on success */
169                 switch(res) {
170                 case 0:
171                         ast_cli(a->fd, "No such module '%s'\n", a->argv[x]);
172                         break;
173                 case 1:
174                         ast_cli(a->fd, "Module '%s' does not support reload\n", a->argv[x]);
175                         break;
176                 }
177         }
178         return CLI_SUCCESS;
179 }
180
181 static char *handle_reload_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
182 {
183         char *s = handle_reload(e, cmd, a);
184         if (cmd == CLI_INIT)            /* override command name */
185                 e->command = "reload";
186         return s;
187 }
188
189 static char *handle_verbose(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
190 {
191         int oldval = option_verbose;
192         int newlevel;
193         int atleast = 0;
194         int fd = a->fd;
195         int argc = a->argc;
196         char **argv = a->argv;
197         int *dst;
198         char *what;
199
200         switch (cmd) {
201         case CLI_INIT:
202                 e->command = "core set {debug|verbose} [off|atleast]";
203                 e->usage =
204                         "Usage: core set {debug|verbose} [atleast] <level>\n"
205                         "       core set {debug|verbose} off\n"
206                         "       Sets level of debug or verbose messages to be displayed.\n"
207                         "       0 or off means no messages should be displayed.\n"
208                         "       Equivalent to -d[d[...]] or -v[v[v...]] on startup\n";
209                 return NULL;
210
211         case CLI_GENERATE:
212                 return NULL;
213         }
214         /* all the above return, so we proceed with the handler.
215          * we are guaranteed to be called with argc >= e->args;
216          */
217
218         if (argc < e->args)
219                 return CLI_SHOWUSAGE;
220         if (!strcasecmp(argv[e->args - 2], "debug")) {
221                 dst = &option_debug;
222                 what = "Core debug";
223         } else {
224                 dst = &option_verbose;
225                 what = "Verbosity";
226         }
227         if (argc == e->args && !strcasecmp(argv[e->args - 1], "off")) {
228                 newlevel = 0;
229                 goto done;
230         }
231         if (!strcasecmp(argv[e->args-1], "atleast"))
232                 atleast = 1;
233         if (argc != e->args + atleast)
234                 return CLI_SHOWUSAGE;
235         if (sscanf(argv[e->args + atleast - 1], "%d", &newlevel) != 1)
236                 return CLI_SHOWUSAGE;
237
238 done:
239         if (!atleast || newlevel > *dst)
240                 *dst = newlevel;
241         if (oldval > 0 && *dst == 0)
242                 ast_cli(fd, "%s is now OFF\n", what);
243         else if (*dst > 0) {
244                 if (oldval == *dst)
245                         ast_cli(fd, "%s is at least %d\n", what, *dst);
246                 else
247                         ast_cli(fd, "%s was %d and is now %d\n", what, oldval, *dst);
248         }
249
250         return CLI_SUCCESS;
251 }
252
253 static int handle_logger_mute(int fd, int argc, char *argv[])
254 {
255         if (argc != 2)
256                 return RESULT_SHOWUSAGE;
257         ast_console_toggle_mute(fd);
258         return RESULT_SUCCESS;
259 }
260
261 static char *handle_unload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
262 {
263         /* "module unload mod_1 [mod_2 .. mod_N]" */
264         int x;
265         int force = AST_FORCE_SOFT;
266         char *s;
267
268         switch (cmd) {
269         case CLI_INIT:
270                 e->command = "module unload";
271                 e->usage =
272                         "Usage: module unload [-f|-h] <module_1> [<module_2> ... ]\n"
273                         "       Unloads the specified module from Asterisk. The -f\n"
274                         "       option causes the module to be unloaded even if it is\n"
275                         "       in use (may cause a crash) and the -h module causes the\n"
276                         "       module to be unloaded even if the module says it cannot, \n"
277                         "       which almost always will cause a crash.\n";
278                 return NULL;
279
280         case CLI_GENERATE:
281                 return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0);
282         }
283         if (a->argc < e->args + 1)
284                 return CLI_SHOWUSAGE;
285         x = e->args;    /* first argument */
286         s = a->argv[x];
287         if (s[0] == '-') {
288                 if (s[1] == 'f')
289                         force = AST_FORCE_FIRM;
290                 else if (s[1] == 'h')
291                         force = AST_FORCE_HARD;
292                 else
293                         return CLI_SHOWUSAGE;
294                 if (a->argc < e->args + 2)      /* need at least one module name */
295                         return CLI_SHOWUSAGE;
296                 x++;    /* skip this argument */
297         }
298
299         for (; x < a->argc; x++) {
300                 if (ast_unload_resource(a->argv[x], force)) {
301                         ast_cli(a->fd, "Unable to unload resource %s\n", a->argv[x]);
302                         return CLI_FAILURE;
303                 }
304         }
305         return CLI_SUCCESS;
306 }
307
308 static char *handle_unload_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
309 {
310         char *res = handle_unload(e, cmd, a);
311         if (cmd == CLI_INIT)
312                 e->command = "unload";  /* XXX override */
313         return res;
314 }
315
316 #define MODLIST_FORMAT  "%-30s %-40.40s %-10d\n"
317 #define MODLIST_FORMAT2 "%-30s %-40.40s %-10s\n"
318
319 AST_MUTEX_DEFINE_STATIC(climodentrylock);
320 static int climodentryfd = -1;
321
322 static int modlist_modentry(const char *module, const char *description, int usecnt, const char *like)
323 {
324         /* Comparing the like with the module */
325         if (strcasestr(module, like) ) {
326                 ast_cli(climodentryfd, MODLIST_FORMAT, module, description, usecnt);
327                 return 1;
328         } 
329         return 0;
330 }
331
332 static void print_uptimestr(int fd, time_t timeval, const char *prefix, int printsec)
333 {
334         int x; /* the main part - years, weeks, etc. */
335         char timestr[256]="", *s = timestr;
336         size_t maxbytes = sizeof(timestr);
337
338 #define SECOND (1)
339 #define MINUTE (SECOND*60)
340 #define HOUR (MINUTE*60)
341 #define DAY (HOUR*24)
342 #define WEEK (DAY*7)
343 #define YEAR (DAY*365)
344 #define NEEDCOMMA(x) ((x)? ",": "")     /* define if we need a comma */
345         if (timeval < 0)        /* invalid, nothing to show */
346                 return;
347         if (printsec)  {        /* plain seconds output */
348                 ast_build_string(&s, &maxbytes, "%lu", (u_long)timeval);
349                 timeval = 0; /* bypass the other cases */
350         }
351         if (timeval > YEAR) {
352                 x = (timeval / YEAR);
353                 timeval -= (x * YEAR);
354                 ast_build_string(&s, &maxbytes, "%d year%s%s ", x, ESS(x),NEEDCOMMA(timeval));
355         }
356         if (timeval > WEEK) {
357                 x = (timeval / WEEK);
358                 timeval -= (x * WEEK);
359                 ast_build_string(&s, &maxbytes, "%d week%s%s ", x, ESS(x),NEEDCOMMA(timeval));
360         }
361         if (timeval > DAY) {
362                 x = (timeval / DAY);
363                 timeval -= (x * DAY);
364                 ast_build_string(&s, &maxbytes, "%d day%s%s ", x, ESS(x),NEEDCOMMA(timeval));
365         }
366         if (timeval > HOUR) {
367                 x = (timeval / HOUR);
368                 timeval -= (x * HOUR);
369                 ast_build_string(&s, &maxbytes, "%d hour%s%s ", x, ESS(x),NEEDCOMMA(timeval));
370         }
371         if (timeval > MINUTE) {
372                 x = (timeval / MINUTE);
373                 timeval -= (x * MINUTE);
374                 ast_build_string(&s, &maxbytes, "%d minute%s%s ", x, ESS(x),NEEDCOMMA(timeval));
375         }
376         x = timeval;
377         if (x > 0)
378                 ast_build_string(&s, &maxbytes, "%d second%s ", x, ESS(x));
379         if (timestr[0] != '\0')
380                 ast_cli(fd, "%s: %s\n", prefix, timestr);
381 }
382
383 static char * handle_showuptime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
384 {
385         time_t curtime;
386         int printsec;
387
388         switch (cmd) {
389         case CLI_INIT:
390                 e->command = "core show uptime";
391                 e->usage =
392                         "Usage: core show uptime [seconds]\n"
393                         "       Shows Asterisk uptime information.\n"
394                         "       The seconds word returns the uptime in seconds only.\n";
395                 return NULL;
396
397         case CLI_GENERATE:
398                 return (a->pos > e->args || a->n > 0) ? NULL : "seconds";
399         }
400         /* regular handler */
401         if (a->argc == e->args+1 && !strcasecmp(a->argv[e->args],"seconds"))
402                 printsec = 1;
403         else if (a->argc == e->args)
404                 printsec = 0;
405         else
406                 return CLI_SHOWUSAGE;
407         curtime = time(NULL);
408         if (ast_startuptime)
409                 print_uptimestr(a->fd, curtime - ast_startuptime, "System uptime", printsec);
410         if (ast_lastreloadtime)
411                 print_uptimestr(a->fd, curtime - ast_lastreloadtime, "Last reload", printsec);
412         return CLI_SUCCESS;
413 }
414
415 static char *handle_modlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
416 {
417         char *like;
418
419         switch (cmd) {
420         case CLI_INIT:
421                 e->command = "module show [like]";
422                 e->usage =
423                         "Usage: module show [like keyword]\n"
424                         "       Shows Asterisk modules currently in use, and usage statistics.\n";
425                 return NULL;
426
427         case CLI_GENERATE:
428                 if (a->pos == e->args)
429                         return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0);
430                 else
431                         return NULL;
432         }
433         /* all the above return, so we proceed with the handler.
434          * we are guaranteed to have argc >= e->args
435          */
436         if (a->argc == e->args - 1)
437                 like = "";
438         else if (a->argc == e->args + 1 && !strcasecmp(a->argv[e->args-1], "like") )
439                 like = a->argv[e->args];
440         else
441                 return CLI_SHOWUSAGE;
442                 
443         ast_mutex_lock(&climodentrylock);
444         climodentryfd = a->fd; /* global, protected by climodentrylock */
445         ast_cli(a->fd, MODLIST_FORMAT2, "Module", "Description", "Use Count");
446         ast_cli(a->fd,"%d modules loaded\n", ast_update_module_list(modlist_modentry, like));
447         climodentryfd = -1;
448         ast_mutex_unlock(&climodentrylock);
449         return RESULT_SUCCESS;
450 }
451 #undef MODLIST_FORMAT
452 #undef MODLIST_FORMAT2
453
454 static char *handle_chanlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
455 {
456 #define FORMAT_STRING  "%-20.20s %-20.20s %-7.7s %-30.30s\n"
457 #define FORMAT_STRING2 "%-20.20s %-20.20s %-7.7s %-30.30s\n"
458 #define CONCISE_FORMAT_STRING  "%s!%s!%s!%d!%s!%s!%s!%s!%s!%d!%s!%s\n"
459 #define VERBOSE_FORMAT_STRING  "%-20.20s %-20.20s %-16.16s %4d %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-20.20s\n"
460 #define VERBOSE_FORMAT_STRING2 "%-20.20s %-20.20s %-16.16s %-4.4s %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-20.20s\n"
461
462         struct ast_channel *c = NULL;
463         int numchans = 0, concise = 0, verbose = 0;
464         int fd, argc;
465         char **argv;
466
467         switch (cmd) {
468         case CLI_INIT:
469                 e->command = "core show channels [concise|verbose]";
470                 e->usage =
471                         "Usage: core show channels [concise|verbose]\n"
472                         "       Lists currently defined channels and some information about them. If\n"
473                         "       'concise' is specified, the format is abridged and in a more easily\n"
474                         "       machine parsable format. If 'verbose' is specified, the output includes\n"
475                         "       more and longer fields.\n";
476                 return NULL;
477
478         case CLI_GENERATE:
479                 return NULL;
480         }
481         fd = a->fd;
482         argc = a->argc;
483         argv = a->argv;
484
485         if (a->argc == e->args) {
486                 if (!strcasecmp(argv[e->args-1],"concise"))
487                         concise = 1;
488                 else if (!strcasecmp(argv[e->args-1],"verbose"))
489                         verbose = 1;
490                 else
491                         return CLI_SHOWUSAGE;
492         } else if (a->argc != e->args - 1)
493                 return CLI_SHOWUSAGE;
494
495         if (!concise && !verbose)
496                 ast_cli(fd, FORMAT_STRING2, "Channel", "Location", "State", "Application(Data)");
497         else if (verbose)
498                 ast_cli(fd, VERBOSE_FORMAT_STRING2, "Channel", "Context", "Extension", "Priority", "State", "Application", "Data", 
499                         "CallerID", "Duration", "Accountcode", "BridgedTo");
500
501         while ((c = ast_channel_walk_locked(c)) != NULL) {
502                 struct ast_channel *bc = ast_bridged_channel(c);
503                 char durbuf[10] = "-";
504
505                 if ((concise || verbose)  && c->cdr && !ast_tvzero(c->cdr->start)) {
506                         int duration = (int)(ast_tvdiff_ms(ast_tvnow(), c->cdr->start) / 1000);
507                         if (verbose) {
508                                 int durh = duration / 3600;
509                                 int durm = (duration % 3600) / 60;
510                                 int durs = duration % 60;
511                                 snprintf(durbuf, sizeof(durbuf), "%02d:%02d:%02d", durh, durm, durs);
512                         } else {
513                                 snprintf(durbuf, sizeof(durbuf), "%d", duration);
514                         }                               
515                 }
516                 if (concise) {
517                         ast_cli(fd, CONCISE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
518                                 c->appl ? c->appl : "(None)",
519                                 S_OR(c->data, ""),      /* XXX different from verbose ? */
520                                 S_OR(c->cid.cid_num, ""),
521                                 S_OR(c->accountcode, ""),
522                                 c->amaflags, 
523                                 durbuf,
524                                 bc ? bc->name : "(None)");
525                 } else if (verbose) {
526                         ast_cli(fd, VERBOSE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
527                                 c->appl ? c->appl : "(None)",
528                                 c->data ? S_OR(c->data, "(Empty)" ): "(None)",
529                                 S_OR(c->cid.cid_num, ""),
530                                 durbuf,
531                                 S_OR(c->accountcode, ""),
532                                 bc ? bc->name : "(None)");
533                 } else {
534                         char locbuf[40] = "(None)";
535                         char appdata[40] = "(None)";
536
537                         if (!ast_strlen_zero(c->context) && !ast_strlen_zero(c->exten)) 
538                                 snprintf(locbuf, sizeof(locbuf), "%s@%s:%d", c->exten, c->context, c->priority);
539                         if (c->appl)
540                                 snprintf(appdata, sizeof(appdata), "%s(%s)", c->appl, S_OR(c->data, ""));
541                         ast_cli(fd, FORMAT_STRING, c->name, locbuf, ast_state2str(c->_state), appdata);
542                 }
543                 numchans++;
544                 ast_channel_unlock(c);
545         }
546         if (!concise) {
547                 ast_cli(fd, "%d active channel%s\n", numchans, ESS(numchans));
548                 if (option_maxcalls)
549                         ast_cli(fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
550                                 ast_active_calls(), option_maxcalls, ESS(ast_active_calls()),
551                                 ((double)ast_active_calls() / (double)option_maxcalls) * 100.0);
552                 else
553                         ast_cli(fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
554         }
555         return CLI_SUCCESS;
556         
557 #undef FORMAT_STRING
558 #undef FORMAT_STRING2
559 #undef CONCISE_FORMAT_STRING
560 #undef VERBOSE_FORMAT_STRING
561 #undef VERBOSE_FORMAT_STRING2
562 }
563
564 static const char showchan_help[] = 
565 "Usage: core show channel <channel>\n"
566 "       Shows lots of information about the specified channel.\n";
567
568 static const char commandcomplete_help[] = 
569 "Usage: _command complete \"<line>\" text state\n"
570 "       This function is used internally to help with command completion and should.\n"
571 "       never be called by the user directly.\n";
572
573 static const char commandnummatches_help[] = 
574 "Usage: _command nummatches \"<line>\" text \n"
575 "       This function is used internally to help with command completion and should.\n"
576 "       never be called by the user directly.\n";
577
578 static const char commandmatchesarray_help[] = 
579 "Usage: _command matchesarray \"<line>\" text \n"
580 "       This function is used internally to help with command completion and should.\n"
581 "       never be called by the user directly.\n";
582
583 static int handle_softhangup(int fd, int argc, char *argv[])
584 {
585         struct ast_channel *c=NULL;
586         if (argc != 3)
587                 return RESULT_SHOWUSAGE;
588         c = ast_get_channel_by_name_locked(argv[2]);
589         if (c) {
590                 ast_cli(fd, "Requested Hangup on channel '%s'\n", c->name);
591                 ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
592                 ast_channel_unlock(c);
593         } else
594                 ast_cli(fd, "%s is not a known channel\n", argv[2]);
595         return RESULT_SUCCESS;
596 }
597
598 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock);
599
600 static int handle_commandmatchesarray(int fd, int argc, char *argv[])
601 {
602         char *buf, *obuf;
603         int buflen = 2048;
604         int len = 0;
605         char **matches;
606         int x, matchlen;
607
608         if (argc != 4)
609                 return RESULT_SHOWUSAGE;
610         if (!(buf = ast_malloc(buflen)))
611                 return RESULT_FAILURE;
612         buf[len] = '\0';
613         matches = ast_cli_completion_matches(argv[2], argv[3]);
614         if (matches) {
615                 for (x=0; matches[x]; x++) {
616                         matchlen = strlen(matches[x]) + 1;
617                         if (len + matchlen >= buflen) {
618                                 buflen += matchlen * 3;
619                                 obuf = buf;
620                                 if (!(buf = ast_realloc(obuf, buflen))) 
621                                         /* Memory allocation failure...  Just free old buffer and be done */
622                                         free(obuf);
623                         }
624                         if (buf)
625                                 len += sprintf( buf + len, "%s ", matches[x]);
626                         free(matches[x]);
627                         matches[x] = NULL;
628                 }
629                 free(matches);
630         }
631
632         if (buf) {
633                 ast_cli(fd, "%s%s",buf, AST_CLI_COMPLETE_EOF);
634                 free(buf);
635         } else
636                 ast_cli(fd, "NULL\n");
637
638         return RESULT_SUCCESS;
639 }
640
641
642
643 static int handle_commandnummatches(int fd, int argc, char *argv[])
644 {
645         int matches = 0;
646
647         if (argc != 4)
648                 return RESULT_SHOWUSAGE;
649
650         matches = ast_cli_generatornummatches(argv[2], argv[3]);
651
652         ast_cli(fd, "%d", matches);
653
654         return RESULT_SUCCESS;
655 }
656
657 static int handle_commandcomplete(int fd, int argc, char *argv[])
658 {
659         char *buf;
660
661         if (argc != 5)
662                 return RESULT_SHOWUSAGE;
663         buf = __ast_cli_generator(argv[2], argv[3], atoi(argv[4]), 0);
664         if (buf) {
665                 ast_cli(fd, buf);
666                 free(buf);
667         } else
668                 ast_cli(fd, "NULL\n");
669         return RESULT_SUCCESS;
670 }
671
672 static char *handle_core_set_debug_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
673 {
674         struct ast_channel *c = NULL;
675         int is_all, is_off = 0;
676
677         switch (cmd) {
678         case CLI_INIT:
679                 e->command = "core set debug channel";
680                 e->usage =
681                         "Usage: core set debug channel <all|channel> [off]\n"
682                         "       Enables/disables debugging on all or on a specific channel.\n";
683                 return NULL;
684
685         case CLI_GENERATE:
686                 /* XXX remember to handle the optional "off" */
687                 if (a->pos != e->args)
688                         return NULL;
689                 return a->n == 0 ? strdup("all") : ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
690         }
691         /* 'core set debug channel {all|chan_id}' */
692         if (a->argc == e->args + 2) {
693                 if (!strcasecmp(a->argv[e->args + 1], "off"))
694                         is_off = 1;
695                 else
696                         return CLI_SHOWUSAGE;
697         } else if (a->argc != e->args + 1)
698                 return CLI_SHOWUSAGE;
699
700         is_all = !strcasecmp("all", a->argv[e->args]);
701         if (is_all) {
702                 if (is_off) {
703                         global_fin &= ~DEBUGCHAN_FLAG;
704                         global_fout &= ~DEBUGCHAN_FLAG;
705                 } else {
706                         global_fin |= DEBUGCHAN_FLAG;
707                         global_fout |= DEBUGCHAN_FLAG;
708                 }
709                 c = ast_channel_walk_locked(NULL);
710         } else {
711                 c = ast_get_channel_by_name_locked(a->argv[e->args]);
712                 if (c == NULL)
713                         ast_cli(a->fd, "No such channel %s\n", a->argv[e->args]);
714         }
715         while (c) {
716                 if (!(c->fin & DEBUGCHAN_FLAG) || !(c->fout & DEBUGCHAN_FLAG)) {
717                         if (is_off) {
718                                 c->fin &= ~DEBUGCHAN_FLAG;
719                                 c->fout &= ~DEBUGCHAN_FLAG;
720                         } else {
721                                 c->fin |= DEBUGCHAN_FLAG;
722                                 c->fout |= DEBUGCHAN_FLAG;
723                         }
724                         ast_cli(a->fd, "Debugging %s on channel %s\n", is_off ? "disabled" : "enabled", c->name);
725                 }
726                 ast_channel_unlock(c);
727                 if (!is_all)
728                         break;
729                 c = ast_channel_walk_locked(c);
730         }
731         ast_cli(a->fd, "Debugging on new channels is %s\n", is_off ? "disabled" : "enabled");
732         return RESULT_SUCCESS;
733 }
734
735 static char *handle_debugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
736 {
737         char *res;
738
739         if (cmd == CLI_HANDLER && a->argc != e->args + 1)
740                 return CLI_SHOWUSAGE;
741         res = handle_core_set_debug_channel(e, cmd, a);
742         if (cmd == CLI_INIT)
743                 e->command = "debug channel";
744         return res;
745 }
746
747 static char *handle_nodebugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
748 {
749         char *res;
750         if (cmd == CLI_HANDLER) {
751                 if (a->argc != e->args + 1)
752                         return CLI_SHOWUSAGE;
753                 /* pretend we have an extra "off" at the end. We can do this as the array
754                  * is NULL terminated so we overwrite that entry.
755                  */
756                 a->argv[e->args+1] = "off";
757                 a->argc++;
758         }
759         res = handle_core_set_debug_channel(e, cmd, a);
760         if (cmd == CLI_INIT)
761                 e->command = "no debug channel";
762         return res;
763 }
764                 
765 static int handle_showchan(int fd, int argc, char *argv[])
766 {
767         struct ast_channel *c=NULL;
768         struct timeval now;
769         char buf[2048];
770         char cdrtime[256];
771         char nf[256], wf[256], rf[256];
772         long elapsed_seconds=0;
773         int hour=0, min=0, sec=0;
774         
775         if (argc != 4)
776                 return RESULT_SHOWUSAGE;
777         now = ast_tvnow();
778         c = ast_get_channel_by_name_locked(argv[3]);
779         if (!c) {
780                 ast_cli(fd, "%s is not a known channel\n", argv[3]);
781                 return RESULT_SUCCESS;
782         }
783         if(c->cdr) {
784                 elapsed_seconds = now.tv_sec - c->cdr->start.tv_sec;
785                 hour = elapsed_seconds / 3600;
786                 min = (elapsed_seconds % 3600) / 60;
787                 sec = elapsed_seconds % 60;
788                 snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec);
789         } else
790                 strcpy(cdrtime, "N/A");
791         ast_cli(fd, 
792                 " -- General --\n"
793                 "           Name: %s\n"
794                 "           Type: %s\n"
795                 "       UniqueID: %s\n"
796                 "      Caller ID: %s\n"
797                 " Caller ID Name: %s\n"
798                 "    DNID Digits: %s\n"
799                 "          State: %s (%d)\n"
800                 "          Rings: %d\n"
801                 "  NativeFormats: %s\n"
802                 "    WriteFormat: %s\n"
803                 "     ReadFormat: %s\n"
804                 " WriteTranscode: %s\n"
805                 "  ReadTranscode: %s\n"
806                 "1st File Descriptor: %d\n"
807                 "      Frames in: %d%s\n"
808                 "     Frames out: %d%s\n"
809                 " Time to Hangup: %ld\n"
810                 "   Elapsed Time: %s\n"
811                 "  Direct Bridge: %s\n"
812                 "Indirect Bridge: %s\n"
813                 " --   PBX   --\n"
814                 "        Context: %s\n"
815                 "      Extension: %s\n"
816                 "       Priority: %d\n"
817                 "     Call Group: %llu\n"
818                 "   Pickup Group: %llu\n"
819                 "    Application: %s\n"
820                 "           Data: %s\n"
821                 "    Blocking in: %s\n",
822                 c->name, c->tech->type, c->uniqueid,
823                 S_OR(c->cid.cid_num, "(N/A)"),
824                 S_OR(c->cid.cid_name, "(N/A)"),
825                 S_OR(c->cid.cid_dnid, "(N/A)"), ast_state2str(c->_state), c->_state, c->rings, 
826                 ast_getformatname_multiple(nf, sizeof(nf), c->nativeformats), 
827                 ast_getformatname_multiple(wf, sizeof(wf), c->writeformat), 
828                 ast_getformatname_multiple(rf, sizeof(rf), c->readformat),
829                 c->writetrans ? "Yes" : "No",
830                 c->readtrans ? "Yes" : "No",
831                 c->fds[0],
832                 c->fin & ~DEBUGCHAN_FLAG, (c->fin & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
833                 c->fout & ~DEBUGCHAN_FLAG, (c->fout & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
834                 (long)c->whentohangup,
835                 cdrtime, c->_bridge ? c->_bridge->name : "<none>", ast_bridged_channel(c) ? ast_bridged_channel(c)->name : "<none>", 
836                 c->context, c->exten, c->priority, c->callgroup, c->pickupgroup, ( c->appl ? c->appl : "(N/A)" ),
837                 ( c-> data ? S_OR(c->data, "(Empty)") : "(None)"),
838                 (ast_test_flag(c, AST_FLAG_BLOCKING) ? c->blockproc : "(Not Blocking)"));
839         
840         if(pbx_builtin_serialize_variables(c,buf,sizeof(buf)))
841                 ast_cli(fd,"      Variables:\n%s\n",buf);
842         if(c->cdr && ast_cdr_serialize_variables(c->cdr,buf, sizeof(buf), '=', '\n', 1))
843                 ast_cli(fd,"  CDR Variables:\n%s\n",buf);
844         
845         ast_channel_unlock(c);
846         return RESULT_SUCCESS;
847 }
848
849 /*
850  * helper function to generate CLI matches from a fixed set of values.
851  * A NULL word is acceptable.
852  */
853 char *ast_cli_complete(const char *word, char *const choices[], int state)
854 {
855         int i, which = 0, len;
856         len = ast_strlen_zero(word) ? 0 : strlen(word);
857
858         for (i = 0; choices[i]; i++) {
859                 if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
860                         return ast_strdup(choices[i]);
861         }
862         return NULL;
863 }
864
865 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
866 {
867         struct ast_channel *c = NULL;
868         int which = 0;
869         int wordlen;
870         char notfound = '\0';
871         char *ret = &notfound; /* so NULL can break the loop */
872
873         if (pos != rpos)
874                 return NULL;
875
876         wordlen = strlen(word); 
877
878         while (ret == &notfound && (c = ast_channel_walk_locked(c))) {
879                 if (!strncasecmp(word, c->name, wordlen) && ++which > state)
880                         ret = ast_strdup(c->name);
881                 ast_channel_unlock(c);
882         }
883         return ret == &notfound ? NULL : ret;
884 }
885
886 static char *complete_ch_3(const char *line, const char *word, int pos, int state)
887 {
888         return ast_complete_channels(line, word, pos, state, 2);
889 }
890
891 static char *complete_ch_4(const char *line, const char *word, int pos, int state)
892 {
893         return ast_complete_channels(line, word, pos, state, 3);
894 }
895
896 static int group_show_channels(int fd, int argc, char *argv[])
897 {
898 #define FORMAT_STRING  "%-25s  %-20s  %-20s\n"
899
900         struct ast_channel *c = NULL;
901         int numchans = 0;
902         struct ast_var_t *current;
903         struct varshead *headp;
904         regex_t regexbuf;
905         int havepattern = 0;
906
907         if (argc < 3 || argc > 4)
908                 return RESULT_SHOWUSAGE;
909         
910         if (argc == 4) {
911                 if (regcomp(&regexbuf, argv[3], REG_EXTENDED | REG_NOSUB))
912                         return RESULT_SHOWUSAGE;
913                 havepattern = 1;
914         }
915
916         ast_cli(fd, FORMAT_STRING, "Channel", "Group", "Category");
917         while ( (c = ast_channel_walk_locked(c)) != NULL) {
918                 headp=&c->varshead;
919                 AST_LIST_TRAVERSE(headp,current,entries) {
920                         if (!strncmp(ast_var_name(current), GROUP_CATEGORY_PREFIX "_", strlen(GROUP_CATEGORY_PREFIX) + 1)) {
921                                 if (!havepattern || !regexec(&regexbuf, ast_var_value(current), 0, NULL, 0)) {
922                                         ast_cli(fd, FORMAT_STRING, c->name, ast_var_value(current),
923                                                 (ast_var_name(current) + strlen(GROUP_CATEGORY_PREFIX) + 1));
924                                         numchans++;
925                                 }
926                         } else if (!strcmp(ast_var_name(current), GROUP_CATEGORY_PREFIX)) {
927                                 if (!havepattern || !regexec(&regexbuf, ast_var_value(current), 0, NULL, 0)) {
928                                         ast_cli(fd, FORMAT_STRING, c->name, ast_var_value(current), "(default)");
929                                         numchans++;
930                                 }
931                         }
932                 }
933                 numchans++;
934                 ast_channel_unlock(c);
935         }
936
937         if (havepattern)
938                 regfree(&regexbuf);
939
940         ast_cli(fd, "%d active channel%s\n", numchans, ESS(numchans));
941         return RESULT_SUCCESS;
942 #undef FORMAT_STRING
943 }
944
945 /* XXX Nothing in this array can currently be deprecated...
946    You have to change the way find_cli works in order to remove this array
947    I recommend doing this eventually...
948  */
949 static struct ast_cli_entry builtins[] = {
950         /* Keep alphabetized, with longer matches first (example: abcd before abc) */
951         { { "_command", "complete", NULL },
952         handle_commandcomplete, "Command complete",
953         commandcomplete_help },
954
955         { { "_command", "nummatches", NULL },
956         handle_commandnummatches, "Returns number of command matches",
957         commandnummatches_help },
958
959         { { "_command", "matchesarray", NULL },
960         handle_commandmatchesarray, "Returns command matches array",
961         commandmatchesarray_help },
962
963         { { NULL }, NULL, NULL, NULL }
964 };
965
966 static struct ast_cli_entry cli_debug_channel_deprecated = NEW_CLI(handle_debugchan_deprecated, "Enable debugging on channel");
967 static struct ast_cli_entry cli_module_load_deprecated = NEW_CLI(handle_load_deprecated, "Load a module");
968 static struct ast_cli_entry cli_module_reload_deprecated = NEW_CLI(handle_reload_deprecated, "reload modules by name");
969 static struct ast_cli_entry cli_module_unload_deprecated = NEW_CLI(handle_unload_deprecated, "unload modules by name");
970
971 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
972
973 static struct ast_cli_entry cli_cli[] = {
974         /* Deprecated, but preferred command is now consolidated (and already has a deprecated command for it). */
975         NEW_CLI(handle_nodebugchan_deprecated, "Disable debugging on channel(s)"),
976
977         NEW_CLI(handle_chanlist, "Display information on channels"),
978
979         { { "core", "show", "channel", NULL },
980         handle_showchan, "Display information on a specific channel",
981         showchan_help, complete_ch_4 },
982
983         NEW_CLI(handle_core_set_debug_channel, "Enable/disable debugging on a channel",
984                 .deprecate_cmd = &cli_debug_channel_deprecated),
985
986         NEW_CLI(handle_verbose, "Set level of debug/verbose chattiness"),
987
988         { { "group", "show", "channels", NULL },
989         group_show_channels, "Display active channels with group(s)",
990         group_show_channels_help },
991
992         NEW_CLI(handle_help, "Display help list, or specific help on a command"),
993
994         { { "logger", "mute", NULL },
995         handle_logger_mute, "Toggle logging output to a console",
996         logger_mute_help },
997
998         NEW_CLI(handle_modlist, "List modules and info"),
999
1000         NEW_CLI(handle_load, "Load a module by name", .deprecate_cmd = &cli_module_load_deprecated),
1001
1002         NEW_CLI(handle_reload, "Reload configuration", .deprecate_cmd = &cli_module_reload_deprecated),
1003
1004         NEW_CLI(handle_unload, "Unload a module by name", .deprecate_cmd = &cli_module_unload_deprecated ),
1005
1006         NEW_CLI(handle_showuptime, "Show uptime information"),
1007
1008         { { "soft", "hangup", NULL },
1009         handle_softhangup, "Request a hangup on a given channel",
1010         softhangup_help, complete_ch_3 },
1011 };
1012
1013 /*!
1014  * Some regexp characters in cli arguments are reserved and used as separators.
1015  */
1016 static const char cli_rsvd[] = "[]{}|*%";
1017
1018 /*!
1019  * initialize the _full_cmd string and related parameters,
1020  * return 0 on success, -1 on error.
1021  */
1022 static int set_full_cmd(struct ast_cli_entry *e)
1023 {
1024         int i;
1025         char buf[80];
1026
1027         ast_join(buf, sizeof(buf), e->cmda);
1028         e->_full_cmd = strdup(buf);
1029         if (!e->_full_cmd) {
1030                 ast_log(LOG_WARNING, "-- cannot allocate <%s>\n", buf);
1031                 return -1;
1032         }
1033         e->cmdlen = strcspn(e->_full_cmd, cli_rsvd);
1034         for (i = 0; e->cmda[i]; i++)
1035                 ;
1036         e->args = i;
1037         return 0;
1038 }
1039
1040 /*! \brief initialize the _full_cmd string in * each of the builtins. */
1041 void ast_builtins_init(void)
1042 {
1043         struct ast_cli_entry *e;
1044
1045         for (e = builtins; e->cmda[0] != NULL; e++)
1046                 set_full_cmd(e);
1047
1048         ast_cli_register_multiple(cli_cli, sizeof(cli_cli) / sizeof(struct ast_cli_entry));
1049 }
1050
1051 /*
1052  * We have two sets of commands: builtins are stored in a
1053  * NULL-terminated array of ast_cli_entry, whereas external
1054  * commands are in a list.
1055  * When navigating, we need to keep two pointers and get
1056  * the next one in lexicographic order. For the purpose,
1057  * we use a structure.
1058  */
1059
1060 struct cli_iterator {
1061         struct ast_cli_entry *builtins;
1062         struct ast_cli_entry *helpers;
1063 };
1064
1065 static struct ast_cli_entry *cli_next(struct cli_iterator *i)
1066 {
1067         struct ast_cli_entry *e;
1068
1069         if (i->builtins == NULL && i->helpers == NULL) {
1070                 /* initialize */
1071                 i->builtins = builtins;
1072                 i->helpers = AST_LIST_FIRST(&helpers);
1073         }
1074         e = i->builtins; /* temporary */
1075         if (!e->cmda[0] || (i->helpers &&
1076                     strcmp(i->helpers->_full_cmd, e->_full_cmd) < 0)) {
1077                 /* Use helpers */
1078                 e = i->helpers;
1079                 if (e)
1080                         i->helpers = AST_LIST_NEXT(e, list);
1081         } else { /* use builtin. e is already set  */
1082                 (i->builtins)++;        /* move to next */
1083         }
1084         return e;
1085 }
1086
1087 /*!
1088  * match a word in the CLI entry.
1089  * returns -1 on mismatch, 0 on match of an optional word,
1090  * 1 on match of a full word.
1091  *
1092  * The pattern can be
1093  *   any_word           match for equal
1094  *   [foo|bar|baz]      optionally, one of these words
1095  *   {foo|bar|baz}      exactly, one of these words
1096  *   %                  any word
1097  */
1098 static int word_match(const char *cmd, const char *cli_word)
1099 {
1100         int l;
1101         char *pos;
1102
1103         if (ast_strlen_zero(cmd) || ast_strlen_zero(cli_word))
1104                 return -1;
1105         if (!strchr(cli_rsvd, cli_word[0])) /* normal match */
1106                 return (strcasecmp(cmd, cli_word) == 0) ? 1 : -1;
1107         /* regexp match, takes [foo|bar] or {foo|bar} */
1108         l = strlen(cmd);
1109         /* wildcard match - will extend in the future */
1110         if (l > 0 && cli_word[0] == '%') {
1111                 return 1;       /* wildcard */
1112         }
1113         pos = strcasestr(cli_word, cmd);
1114         if (pos == NULL) /* not found, say ok if optional */
1115                 return cli_word[0] == '[' ? 0 : -1;
1116         if (pos == cli_word)    /* no valid match at the beginning */
1117                 return -1;
1118         if (strchr(cli_rsvd, pos[-1]) && strchr(cli_rsvd, pos[l]))
1119                 return 1;       /* valid match */
1120         return -1;      /* not found */
1121 }
1122
1123 /*! \brief if word is a valid prefix for token, returns the pos-th
1124  * match as a malloced string, or NULL otherwise.
1125  * Always tell in *actual how many matches we got.
1126  */
1127 static char *is_prefix(const char *word, const char *token,
1128         int pos, int *actual)
1129 {
1130         int lw;
1131         char *s, *t1;
1132
1133         *actual = 0;
1134         if (ast_strlen_zero(token))
1135                 return NULL;
1136         if (ast_strlen_zero(word))
1137                 word = "";      /* dummy */
1138         lw = strlen(word);
1139         if (strcspn(word, cli_rsvd) != lw)
1140                 return NULL;    /* no match if word has reserved chars */
1141         if (strchr(cli_rsvd, token[0]) == NULL) {       /* regular match */
1142                 if (strncasecmp(token, word, lw))       /* no match */
1143                         return NULL;
1144                 *actual = 1;
1145                 return (pos != 0) ? NULL : strdup(token);
1146         }
1147         /* now handle regexp match */
1148
1149         /* Wildcard always matches, so we never do is_prefix on them */
1150
1151         t1 = ast_strdupa(token + 1);    /* copy, skipping first char */
1152         while (pos >= 0 && (s = strsep(&t1, cli_rsvd)) && *s) {
1153                 if (*s == '%')  /* wildcard */
1154                         continue;
1155                 if (strncasecmp(s, word, lw))   /* no match */
1156                         continue;
1157                 (*actual)++;
1158                 if (pos-- == 0)
1159                         return strdup(s);
1160         }
1161         return NULL;
1162 }
1163
1164 /*!
1165  * \brief locate a cli command in the 'helpers' list (which must be locked).
1166  * exact has 3 values:
1167  *      0       returns if the search key is equal or longer than the entry.
1168  *              note that trailing optional arguments are skipped.
1169  *      -1      true if the mismatch is on the last word XXX not true!
1170  *      1       true only on complete, exact match.
1171  *
1172  * The search compares word by word taking care of regexps in e->cmda
1173  */
1174 static struct ast_cli_entry *find_cli(char *const cmds[], int match_type)
1175 {
1176         int matchlen = -1;      /* length of longest match so far */
1177         struct ast_cli_entry *cand = NULL, *e=NULL;
1178         struct cli_iterator i = { NULL, NULL};
1179
1180         while( (e = cli_next(&i)) ) {
1181                 /* word-by word regexp comparison */
1182                 char * const *src = cmds;
1183                 char * const *dst = e->cmda;
1184                 int n = 0;
1185                 for (;; dst++, src += n) {
1186                         n = word_match(*src, *dst);
1187                         if (n < 0)
1188                                 break;
1189                 }
1190                 if (ast_strlen_zero(*dst) || ((*dst)[0] == '[' && ast_strlen_zero(dst[1]))) {
1191                         /* no more words in 'e' */
1192                         if (ast_strlen_zero(*src))      /* exact match, cannot do better */
1193                                 break;
1194                         /* Here, cmds has more words than the entry 'e' */
1195                         if (match_type != 0)    /* but we look for almost exact match... */
1196                                 continue;       /* so we skip this one. */
1197                         /* otherwise we like it (case 0) */
1198                 } else {        /* still words in 'e' */
1199                         if (ast_strlen_zero(*src))
1200                                 continue; /* cmds is shorter than 'e', not good */
1201                         /* Here we have leftover words in cmds and 'e',
1202                          * but there is a mismatch. We only accept this one if match_type == -1
1203                          * and this is the last word for both.
1204                          */
1205                         if (match_type != -1 || !ast_strlen_zero(src[1]) ||
1206                             !ast_strlen_zero(dst[1]))   /* not the one we look for */
1207                                 continue;
1208                         /* good, we are in case match_type == -1 and mismatch on last word */
1209                 }
1210                 if (src - cmds > matchlen) {    /* remember the candidate */
1211                         matchlen = src - cmds;
1212                         cand = e;
1213                 }
1214         }
1215         return e ? e : cand;
1216 }
1217
1218 static char *find_best(char *argv[])
1219 {
1220         static char cmdline[80];
1221         int x;
1222         /* See how close we get, then print the candidate */
1223         char *myargv[AST_MAX_CMD_LEN];
1224         for (x=0;x<AST_MAX_CMD_LEN;x++)
1225                 myargv[x]=NULL;
1226         AST_LIST_LOCK(&helpers);
1227         for (x=0;argv[x];x++) {
1228                 myargv[x] = argv[x];
1229                 if (!find_cli(myargv, -1))
1230                         break;
1231         }
1232         AST_LIST_UNLOCK(&helpers);
1233         ast_join(cmdline, sizeof(cmdline), myargv);
1234         return cmdline;
1235 }
1236
1237 static int __ast_cli_unregister(struct ast_cli_entry *e, struct ast_cli_entry *ed)
1238 {
1239         if (e->deprecate_cmd) {
1240                 __ast_cli_unregister(e->deprecate_cmd, e);
1241         }
1242         if (e->inuse) {
1243                 ast_log(LOG_WARNING, "Can't remove command that is in use\n");
1244         } else {
1245                 AST_LIST_LOCK(&helpers);
1246                 AST_LIST_REMOVE(&helpers, e, list);
1247                 AST_LIST_UNLOCK(&helpers);
1248                 free(e->_full_cmd);
1249                 e->_full_cmd = NULL;
1250                 if (e->new_handler) {
1251                         /* this is a new-style entry. Reset fields and free memory. */
1252                         bzero((char **)(e->cmda), sizeof(e->cmda));
1253                         free(e->command);
1254                         e->command = NULL;
1255                         e->usage = NULL;
1256                 }
1257         }
1258         return 0;
1259 }
1260
1261 static int __ast_cli_register(struct ast_cli_entry *e, struct ast_cli_entry *ed)
1262 {
1263         struct ast_cli_entry *cur;
1264         int i, lf, ret = -1;
1265
1266         if (e->handler == NULL) {       /* new style entry, run the handler to init fields */
1267                 struct ast_cli_args a;  /* fake argument */
1268                 char **dst = (char **)e->cmda;  /* need to cast as the entry is readonly */
1269                 char *s;
1270
1271                 bzero (&a, sizeof(a));
1272                 e->new_handler(e, CLI_INIT, &a);
1273                 /* XXX check that usage and command are filled up */
1274                 s = ast_skip_blanks(e->command);
1275                 s = e->command = ast_strdup(s);
1276                 for (i=0; !ast_strlen_zero(s) && i < AST_MAX_CMD_LEN-1; i++) {
1277                         *dst++ = s;     /* store string */
1278                         s = ast_skip_nonblanks(s);
1279                         if (*s == '\0') /* we are done */
1280                                 break;
1281                         *s++ = '\0';
1282                         s = ast_skip_blanks(s);
1283                 }
1284                 *dst++ = NULL;
1285         }
1286         if (set_full_cmd(e))
1287                 goto done;
1288         AST_LIST_LOCK(&helpers);
1289         
1290         if (find_cli(e->cmda, 1)) {
1291                 ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n", e->_full_cmd);
1292                 free(e->_full_cmd);
1293                 e->_full_cmd = NULL;
1294                 goto done;
1295         }
1296         if (!ed) {
1297                 e->deprecated = 0;
1298         } else {
1299                 e->deprecated = 1;
1300                 e->summary = ed->summary;
1301                 e->usage = ed->usage;
1302                 /* XXX If command A deprecates command B, and command B deprecates command C...
1303                    Do we want to show command A or command B when telling the user to use new syntax?
1304                    This currently would show command A.
1305                    To show command B, you just need to always use ed->_full_cmd.
1306                  */
1307                 e->_deprecated_by = S_OR(ed->_deprecated_by, ed->_full_cmd);
1308         }
1309
1310         lf = e->cmdlen;
1311         AST_LIST_TRAVERSE_SAFE_BEGIN(&helpers, cur, list) {
1312                 int len = cur->cmdlen;
1313                 if (lf < len)
1314                         len = lf;
1315                 if (strncasecmp(e->_full_cmd, cur->_full_cmd, len) < 0) {
1316                         AST_LIST_INSERT_BEFORE_CURRENT(&helpers, e, list); 
1317                         break;
1318                 }
1319         }
1320         AST_LIST_TRAVERSE_SAFE_END;
1321
1322         if (!cur)
1323                 AST_LIST_INSERT_TAIL(&helpers, e, list); 
1324         ret = 0;        /* success */
1325
1326 done:
1327         AST_LIST_UNLOCK(&helpers);
1328
1329         if (e->deprecate_cmd) {
1330                 /* This command deprecates another command.  Register that one also. */
1331                 __ast_cli_register(e->deprecate_cmd, e);
1332         }
1333         
1334         return ret;
1335 }
1336
1337 /* wrapper function, so we can unregister deprecated commands recursively */
1338 int ast_cli_unregister(struct ast_cli_entry *e)
1339 {
1340         return __ast_cli_unregister(e, NULL);
1341 }
1342
1343 /* wrapper function, so we can register deprecated commands recursively */
1344 int ast_cli_register(struct ast_cli_entry *e)
1345 {
1346         return __ast_cli_register(e, NULL);
1347 }
1348
1349 /*
1350  * register/unregister an array of entries.
1351  */
1352 void ast_cli_register_multiple(struct ast_cli_entry *e, int len)
1353 {
1354         int i;
1355
1356         for (i = 0; i < len; i++)
1357                 ast_cli_register(e + i);
1358 }
1359
1360 void ast_cli_unregister_multiple(struct ast_cli_entry *e, int len)
1361 {
1362         int i;
1363
1364         for (i = 0; i < len; i++)
1365                 ast_cli_unregister(e + i);
1366 }
1367
1368
1369 /*! \brief helper for final part of
1370  * handle_help. if locked = 0 it's just "help_workhorse",
1371  * otherwise assume the list is already locked and print
1372  * an error message if not found.
1373  */
1374 static char *help1(int fd, char *match[], int locked)
1375 {
1376         char matchstr[80] = "";
1377         struct ast_cli_entry *e;
1378         int len = 0;
1379         int found = 0;
1380         struct cli_iterator i = { NULL, NULL};
1381
1382         if (match) {
1383                 ast_join(matchstr, sizeof(matchstr), match);
1384                 len = strlen(matchstr);
1385         }
1386         if (!locked)
1387                 AST_LIST_LOCK(&helpers);
1388         while ( (e = cli_next(&i)) ) {
1389                 /* Hide commands that start with '_' */
1390                 if (e->_full_cmd[0] == '_')
1391                         continue;
1392                 /* Hide commands that are marked as deprecated. */
1393                 if (e->deprecated)
1394                         continue;
1395                 if (match && strncasecmp(matchstr, e->_full_cmd, len))
1396                         continue;
1397                 ast_cli(fd, "%30.30s %s\n", e->_full_cmd, S_OR(e->summary, "<no description available>"));
1398                 found++;
1399         }
1400         if (!locked)
1401                 AST_LIST_UNLOCK(&helpers);
1402         if (!locked && !found && matchstr[0])
1403                 ast_cli(fd, "No such command '%s'.\n", matchstr);
1404         return CLI_SUCCESS;
1405 }
1406
1407 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1408 {
1409         char fullcmd[80];
1410         struct ast_cli_entry *my_e;
1411
1412         if (cmd == CLI_INIT) {
1413                 e->command = "help";
1414                 e->usage =
1415                         "Usage: help [topic]\n"
1416                         "       When called with a topic as an argument, displays usage\n"
1417                         "       information on the given command. If called without a\n"
1418                         "       topic, it provides a list of commands.\n";
1419                 return NULL;
1420
1421         } else if (cmd == CLI_GENERATE) {
1422                 /* skip first 4 or 5 chars, "help " */
1423                 int l = strlen(a->line);
1424
1425                 if (l > 5)
1426                         l = 5;
1427                 /* XXX watch out, should stop to the non-generator parts */
1428                 return __ast_cli_generator(a->line + l, a->word, a->n, 0);
1429         }
1430         if (a->argc == 1)
1431                 return help1(a->fd, NULL, 0);
1432
1433         AST_LIST_LOCK(&helpers);
1434         my_e = find_cli(a->argv + 1, 1);        /* try exact match first */
1435         if (!my_e)
1436                 return help1(a->fd, a->argv + 1, 1 /* locked */);
1437         if (my_e->usage)
1438                 ast_cli(a->fd, "%s", my_e->usage);
1439         else {
1440                 ast_join(fullcmd, sizeof(fullcmd), a->argv+1);
1441                 ast_cli(a->fd, "No help text available for '%s'.\n", fullcmd);
1442         }
1443         AST_LIST_UNLOCK(&helpers);
1444         return RESULT_SUCCESS;
1445 }
1446
1447 static char *parse_args(const char *s, int *argc, char *argv[], int max, int *trailingwhitespace)
1448 {
1449         char *dup, *cur;
1450         int x = 0;
1451         int quoted = 0;
1452         int escaped = 0;
1453         int whitespace = 1;
1454         int dummy = 0;
1455
1456         if (trailingwhitespace == NULL)
1457                 trailingwhitespace = &dummy;
1458         *trailingwhitespace = 0;
1459         if (s == NULL)  /* invalid, though! */
1460                 return NULL;
1461         /* make a copy to store the parsed string */
1462         if (!(dup = ast_strdup(s)))
1463                 return NULL;
1464
1465         cur = dup;
1466         /* scan the original string copying into cur when needed */
1467         for (; *s ; s++) {
1468                 if (x >= max - 1) {
1469                         ast_log(LOG_WARNING, "Too many arguments, truncating at %s\n", s);
1470                         break;
1471                 }
1472                 if (*s == '"' && !escaped) {
1473                         quoted = !quoted;
1474                         if (quoted && whitespace) {
1475                                 /* start a quoted string from previous whitespace: new argument */
1476                                 argv[x++] = cur;
1477                                 whitespace = 0;
1478                         }
1479                 } else if ((*s == ' ' || *s == '\t') && !(quoted || escaped)) {
1480                         /* If we are not already in whitespace, and not in a quoted string or
1481                            processing an escape sequence, and just entered whitespace, then
1482                            finalize the previous argument and remember that we are in whitespace
1483                         */
1484                         if (!whitespace) {
1485                                 *cur++ = '\0';
1486                                 whitespace = 1;
1487                         }
1488                 } else if (*s == '\\' && !escaped) {
1489                         escaped = 1;
1490                 } else {
1491                         if (whitespace) {
1492                                 /* we leave whitespace, and are not quoted. So it's a new argument */
1493                                 argv[x++] = cur;
1494                                 whitespace = 0;
1495                         }
1496                         *cur++ = *s;
1497                         escaped = 0;
1498                 }
1499         }
1500         /* Null terminate */
1501         *cur++ = '\0';
1502         /* XXX put a NULL in the last argument, because some functions that take
1503          * the array may want a null-terminated array.
1504          * argc still reflects the number of non-NULL entries.
1505          */
1506         argv[x] = NULL;
1507         *argc = x;
1508         *trailingwhitespace = whitespace;
1509         return dup;
1510 }
1511
1512 /*! \brief Return the number of unique matches for the generator */
1513 int ast_cli_generatornummatches(const char *text, const char *word)
1514 {
1515         int matches = 0, i = 0;
1516         char *buf = NULL, *oldbuf = NULL;
1517
1518         while ((buf = ast_cli_generator(text, word, i++))) {
1519                 if (!oldbuf || strcmp(buf,oldbuf))
1520                         matches++;
1521                 if (oldbuf)
1522                         free(oldbuf);
1523                 oldbuf = buf;
1524         }
1525         if (oldbuf)
1526                 free(oldbuf);
1527         return matches;
1528 }
1529
1530 char **ast_cli_completion_matches(const char *text, const char *word)
1531 {
1532         char **match_list = NULL, *retstr, *prevstr;
1533         size_t match_list_len, max_equal, which, i;
1534         int matches = 0;
1535
1536         /* leave entry 0 free for the longest common substring */
1537         match_list_len = 1;
1538         while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
1539                 if (matches + 1 >= match_list_len) {
1540                         match_list_len <<= 1;
1541                         if (!(match_list = ast_realloc(match_list, match_list_len * sizeof(*match_list))))
1542                                 return NULL;
1543                 }
1544                 match_list[++matches] = retstr;
1545         }
1546
1547         if (!match_list)
1548                 return match_list; /* NULL */
1549
1550         /* Find the longest substring that is common to all results
1551          * (it is a candidate for completion), and store a copy in entry 0.
1552          */
1553         prevstr = match_list[1];
1554         max_equal = strlen(prevstr);
1555         for (which = 2; which <= matches; which++) {
1556                 for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
1557                         continue;
1558                 max_equal = i;
1559         }
1560
1561         if (!(retstr = ast_malloc(max_equal + 1)))
1562                 return NULL;
1563         
1564         ast_copy_string(retstr, match_list[1], max_equal + 1);
1565         match_list[0] = retstr;
1566
1567         /* ensure that the array is NULL terminated */
1568         if (matches + 1 >= match_list_len) {
1569                 if (!(match_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list))))
1570                         return NULL;
1571         }
1572         match_list[matches + 1] = NULL;
1573
1574         return match_list;
1575 }
1576
1577 /*! \brief returns true if there are more words to match */
1578 static int more_words (char * const *dst)
1579 {
1580         int i;
1581         for (i = 0; dst[i]; i++) {
1582                 if (dst[i][0] != '[')
1583                         return -1;
1584         }
1585         return 0;
1586 }
1587         
1588 /*
1589  * generate the entry at position 'state'
1590  */
1591 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock)
1592 {
1593         char *argv[AST_MAX_ARGS];
1594         struct ast_cli_entry *e;
1595         struct cli_iterator i = { NULL, NULL };
1596         int x = 0, argindex, matchlen;
1597         int matchnum=0;
1598         char *ret = NULL;
1599         char matchstr[80] = "";
1600         int tws = 0;
1601         /* Split the argument into an array of words */
1602         char *dup = parse_args(text, &x, argv, sizeof(argv) / sizeof(argv[0]), &tws);
1603
1604         if (!dup)       /* malloc error */
1605                 return NULL;
1606
1607         /* Compute the index of the last argument (could be an empty string) */
1608         argindex = (!ast_strlen_zero(word) && x>0) ? x-1 : x;
1609
1610         /* rebuild the command, ignore terminating white space and flatten space */
1611         ast_join(matchstr, sizeof(matchstr)-1, argv);
1612         matchlen = strlen(matchstr);
1613         if (tws) {
1614                 strcat(matchstr, " "); /* XXX */
1615                 if (matchlen)
1616                         matchlen++;
1617         }
1618         if (lock)
1619                 AST_LIST_LOCK(&helpers);
1620         while ( (e = cli_next(&i)) ) {
1621                 /* XXX repeated code */
1622                 int src = 0, dst = 0, n = 0;
1623
1624                 /*
1625                  * Try to match words, up to and excluding the last word, which
1626                  * is either a blank or something that we want to extend.
1627                  */
1628                 for (;src < argindex; dst++, src += n) {
1629                         n = word_match(argv[src], e->cmda[dst]);
1630                         if (n < 0)
1631                                 break;
1632                 }
1633
1634                 if (src != argindex && more_words(e->cmda + dst))       /* not a match */
1635                         continue;
1636                 ret = is_prefix(argv[src], e->cmda[dst], state - matchnum, &n);
1637                 matchnum += n;  /* this many matches here */
1638                 if (ret) {
1639                         /*
1640                          * argv[src] is a valid prefix of the next word in this
1641                          * command. If this is also the correct entry, return it.
1642                          */
1643                         if (matchnum > state)
1644                                 break;
1645                         free(ret);
1646                         ret = NULL;
1647                 } else if (ast_strlen_zero(e->cmda[dst])) {
1648                         /*
1649                          * This entry is a prefix of the command string entered
1650                          * (only one entry in the list should have this property).
1651                          * Run the generator if one is available. In any case we are done.
1652                          */
1653                         if (e->generator)
1654                                 ret = e->generator(matchstr, word, argindex, state - matchnum);
1655                         else if (e->new_handler) {      /* new style command */
1656                                 struct ast_cli_args a = {
1657                                         .line = matchstr, .word = word,
1658                                         .pos = argindex,
1659                                         .n = state - matchnum };
1660                                 ret = e->new_handler(e, CLI_GENERATE, &a);
1661                         }
1662                         if (ret)
1663                                 break;
1664                 }
1665         }
1666         if (lock)
1667                 AST_LIST_UNLOCK(&helpers);
1668         free(dup);
1669         return ret;
1670 }
1671
1672 char *ast_cli_generator(const char *text, const char *word, int state)
1673 {
1674         return __ast_cli_generator(text, word, state, 1);
1675 }
1676
1677 int ast_cli_command(int fd, const char *s)
1678 {
1679         char *args[AST_MAX_ARGS + 1];
1680         struct ast_cli_entry *e;
1681         int x;
1682         int res;
1683         char *dup = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL);
1684
1685         if (dup == NULL)
1686                 return -1;
1687
1688         if (x < 1)      /* We need at least one entry, otherwise ignore */
1689                 goto done;
1690
1691         AST_LIST_LOCK(&helpers);
1692         e = find_cli(args + 1, 0);
1693         if (e)
1694                 ast_atomic_fetchadd_int(&e->inuse, 1);
1695         AST_LIST_UNLOCK(&helpers);
1696         if (e == NULL) {
1697                 ast_cli(fd, "No such command '%s' (type 'help' for help)\n", find_best(args + 1));
1698                 goto done;
1699         }
1700         /*
1701          * Within the handler, argv[-1] contains a pointer to the ast_cli_entry.
1702          * Remember that the array returned by parse_args is NULL-terminated.
1703          */
1704         args[0] = (char *)e;
1705
1706         if (!e->new_handler)    /* old style */
1707                 res = e->handler(fd, x, args + 1);
1708         else {
1709                 struct ast_cli_args a = {
1710                         .fd = fd, .argc = x, .argv = args+1 };
1711                 char *retval = e->new_handler(e, CLI_HANDLER, &a);
1712
1713                 if (retval == CLI_SUCCESS)
1714                         res = RESULT_SUCCESS;
1715                 else if (retval == CLI_SHOWUSAGE)
1716                         res = RESULT_SHOWUSAGE;
1717                 else
1718                         res = RESULT_FAILURE;
1719         }
1720         switch (res) {
1721         case RESULT_SHOWUSAGE:
1722                 ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n"));
1723                 break;
1724
1725         case RESULT_FAILURE:
1726                 ast_cli(fd, "Command '%s' failed.\n", s);
1727                 /* FALLTHROUGH */
1728         default:
1729                 AST_LIST_LOCK(&helpers);
1730                 if (e->deprecated == 1) {
1731                         ast_cli(fd, "The '%s' command is deprecated and will be removed in a future release. Please use '%s' instead.\n", e->_full_cmd, e->_deprecated_by);
1732                         e->deprecated = 2;
1733                 }
1734                 AST_LIST_UNLOCK(&helpers);
1735                 break;
1736         }
1737         ast_atomic_fetchadd_int(&e->inuse, -1);
1738 done:
1739         free(dup);
1740         return 0;
1741 }