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