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