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