remove an unused function
[asterisk/asterisk.git] / main / cli.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Standard Command Line Interface
22  *
23  * \author Mark Spencer <markster@digium.com> 
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <unistd.h>
31 #include <stdlib.h>
32 #include <sys/signal.h>
33 #include <stdio.h>
34 #include <signal.h>
35 #include <string.h>
36 #include <ctype.h>
37 #include <regex.h>
38
39 #include "asterisk/logger.h"
40 #include "asterisk/options.h"
41 #include "asterisk/cli.h"
42 #include "asterisk/linkedlists.h"
43 #include "asterisk/module.h"
44 #include "asterisk/pbx.h"
45 #include "asterisk/channel.h"
46 #include "asterisk/utils.h"
47 #include "asterisk/app.h"
48 #include "asterisk/lock.h"
49 #include "editline/readline/readline.h"
50 #include "asterisk/threadstorage.h"
51
52 extern unsigned long global_fin, global_fout;
53
54 AST_THREADSTORAGE(ast_cli_buf);
55
56 /*! \brief Initial buffer size for resulting strings in ast_cli() */
57 #define AST_CLI_INITLEN   256
58
59 void ast_cli(int fd, char *fmt, ...)
60 {
61         int res;
62         struct ast_dynamic_str *buf;
63         va_list ap;
64
65         if (!(buf = ast_dynamic_str_thread_get(&ast_cli_buf, AST_CLI_INITLEN)))
66                 return;
67
68         va_start(ap, fmt);
69         res = ast_dynamic_str_thread_set_va(&buf, 0, &ast_cli_buf, fmt, ap);
70         va_end(ap);
71
72         if (res != AST_DYNSTR_BUILD_FAILED)
73                 ast_carefulwrite(fd, buf->str, strlen(buf->str), 100);
74 }
75
76 static AST_LIST_HEAD_STATIC(helpers, ast_cli_entry);
77
78 static char help_help[] =
79 "Usage: help [topic]\n"
80 "       When called with a topic as an argument, displays usage\n"
81 "       information on the given command. If called without a\n"
82 "       topic, it provides a list of commands.\n";
83
84 static char logger_mute_help[] = 
85 "Usage: logger mute\n"
86 "       Disables logging output to the current console, making it possible to\n"
87 "       gather information without being disturbed by scrolling lines.\n";
88
89 static char softhangup_help[] =
90 "Usage: soft hangup <channel>\n"
91 "       Request that a channel be hung up. The hangup takes effect\n"
92 "       the next time the driver reads or writes from the channel\n";
93
94 static char group_show_channels_help[] = 
95 "Usage: group show channels [pattern]\n"
96 "       Lists all currently active channels with channel group(s) specified.\n"
97 "       Optional regular expression pattern is matched to group names for each\n"
98 "       channel.\n";
99
100 static char *complete_fn(const char *word, int state)
101 {
102         char *c;
103         char filename[256];
104
105         if (word[0] == '/')
106                 ast_copy_string(filename, word, sizeof(filename));
107         else
108                 snprintf(filename, sizeof(filename), "%s/%s", ast_config_AST_MODULE_DIR, word);
109
110         /* XXX the following function is not reentrant, so we better not use it */
111         c = filename_completion_function(filename, state);
112         
113         if (c && word[0] != '/')
114                 c += (strlen(ast_config_AST_MODULE_DIR) + 1);
115         
116         return c ? strdup(c) : c;
117 }
118
119 static char *handle_load(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
120 {
121         /* "module load <mod>" */
122         switch (cmd) {
123         case CLI_INIT:
124                 e->command = "module load";
125                 e->usage =
126                         "Usage: module load <module name>\n"
127                         "       Loads the specified module into Asterisk.\n";
128                 return NULL;
129
130         case CLI_GENERATE:
131                 if (a->argc != e->args + 1)
132                         return NULL;
133                 return complete_fn(a->word, a->n);
134         }
135         if (a->argc != e->args + 1)
136                 return CLI_SHOWUSAGE;
137         if (ast_load_resource(a->argv[e->args])) {
138                 ast_cli(a->fd, "Unable to load module %s\n", a->argv[e->args]);
139                 return CLI_FAILURE;
140         }
141         return CLI_SUCCESS;
142 }
143
144 static char *handle_load_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
145 {
146         char *res = handle_load(e, cmd, a);
147         if (cmd == CLI_INIT)
148                 e->command = "load";
149         return res;
150 }
151
152 static char *handle_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
153 {
154         int x;
155
156         switch (cmd) {
157         case CLI_INIT:
158                 e->command = "module reload";
159                 e->usage =
160                         "Usage: module reload [module ...]\n"
161                         "       Reloads configuration files for all listed modules which support\n"
162                         "       reloading, or for all supported modules if none are listed.\n";
163                 return NULL;
164
165         case CLI_GENERATE:
166                 return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 1);
167         }
168         if (a->argc == e->args) {
169                 ast_module_reload(NULL);
170                 return CLI_SUCCESS;
171         }
172         for (x = e->args; x < a->argc; x++) {
173                 int res = ast_module_reload(a->argv[x]);
174                 /* XXX reload has multiple error returns, including -1 on error and 2 on success */
175                 switch(res) {
176                 case 0:
177                         ast_cli(a->fd, "No such module '%s'\n", a->argv[x]);
178                         break;
179                 case 1:
180                         ast_cli(a->fd, "Module '%s' does not support reload\n", a->argv[x]);
181                         break;
182                 }
183         }
184         return CLI_SUCCESS;
185 }
186
187 static char *handle_reload_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
188 {
189         char *s = handle_reload(e, cmd, a);
190         if (cmd == CLI_INIT)            /* override command name */
191                 e->command = "reload";
192         return s;
193 }
194
195 static char *handle_verbose(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
196 {
197         int oldval = option_verbose;
198         int newlevel;
199         int atleast = 0;
200         static char *choices[] = { "off", "atleast", NULL };
201         int fd = a->fd;
202         int argc = a->argc;
203         char **argv = a->argv;
204
205         switch (cmd) {
206         case CLI_INIT:
207                 e->command = "core set verbose";
208                 e->usage =
209                         "Usage: core set verbose [atleast] <level>\n"
210                         "       core set verbose off\n"
211                         "       Sets level of verbose messages to be displayed.  0 or off means\n"
212                         "       no messages should be displayed. Equivalent to -v[v[v...]]\n"
213                         "       on startup\n";
214                 return NULL;
215
216         case CLI_GENERATE:
217                 if (a->pos > e->args)
218                         return NULL;
219                 return ast_cli_complete(a->word, choices, a->n);
220         }
221         /* all the above return, so we proceed with the handler.
222          * we are guaranteed to be called with argc >= e->args;
223          */
224
225         if (argc < e->args + 1)
226                 return CLI_SHOWUSAGE;
227
228         if (argc == e->args + 1 && !strcasecmp(argv[e->args], "off")) {
229                 newlevel = 0;
230                 goto done;
231         }
232         if (!strcasecmp(argv[e->args], "atleast"))
233                 atleast = 1;
234         if (argc != e->args + atleast + 1)
235                 return CLI_SHOWUSAGE;
236         if (sscanf(argv[e->args + atleast], "%d", &newlevel) != 1)
237                 return CLI_SHOWUSAGE;
238
239 done:
240         if (!atleast || newlevel > option_verbose)
241                 option_verbose = newlevel;
242         if (oldval > 0 && option_verbose == 0)
243                 ast_cli(fd, "Verbosity is now OFF\n");
244         else if (option_verbose > 0) {
245                 if (oldval == option_verbose)
246                         ast_cli(fd, "Verbosity is at least %d\n", option_verbose);
247                 else
248                         ast_cli(fd, "Verbosity was %d and is now %d\n", oldval, option_verbose);
249         }
250
251         return CLI_SUCCESS;
252 }
253
254 static char *handle_set_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
255 {
256         int oldval = option_debug;
257         int newlevel;
258         int atleast = 0;
259         char *filename = '\0';
260         static char *choices[] = { "off", "atleast", NULL };
261         int fd = a->fd;
262         int argc = a->argc;
263         char **argv = a->argv;
264
265         switch (cmd) {
266         case CLI_INIT:
267                 e->command = "core set debug";
268                 e->usage =
269                         "Usage: core set debug [atleast] <level> [filename]\n"
270                         "       core set debug off\n"
271                         "       Sets level of core debug messages to be displayed. 0 or 'off' means\n"
272                         "       no messages should be displayed.  Equivalent to -d[d[d...]]\n"
273                         "       on startup.  If filename is specified, debugging will be\n"
274                         "       limited to just that file.\n";
275                 return NULL;
276
277         case CLI_GENERATE:
278                 if (a->pos > e->args)
279                         return NULL;
280                 return ast_cli_complete(a->word, choices, a->n);
281         }
282         /* all the above return, so we proceed with the handler.
283          * we are guaranteed to be called with argc >= e->args;
284          */
285
286         if (argc < e->args + 1)
287                 return CLI_SHOWUSAGE;
288
289         if (argc == e->args + 1 && !strcasecmp(argv[e->args], "off")) {
290                 newlevel = 0;
291                 goto done;
292         }
293         if (!strcasecmp(argv[e->args], "atleast"))
294                 atleast = 1;
295         if (argc < e->args + atleast + 1 || argc > e->args + atleast + 2)
296                 return CLI_SHOWUSAGE;
297         if (sscanf(argv[e->args + atleast], "%d", &newlevel) != 1)
298                 return CLI_SHOWUSAGE;
299
300         if (argc == e->args + atleast + 1) {
301                 debug_filename[0] = '\0';
302         } else {
303                 ast_copy_string(debug_filename, argv[e->args + atleast + 1], sizeof(debug_filename));
304         }
305
306 done:
307         if (!atleast || newlevel > option_debug)
308                 option_debug = newlevel;
309
310         if (oldval > 0 && option_debug == 0)
311                 ast_cli(fd, "Core debug is now OFF\n");
312         else if (option_debug > 0) {
313                 if (filename) {
314                         if (oldval == option_debug)
315                                 ast_cli(fd, "Core debug is at least %d, file '%s'\n", option_debug, filename);
316                         else
317                                 ast_cli(fd, "Core debug was %d and is now %d, file '%s'\n", oldval, option_debug, filename);
318                 } else {
319                         if (oldval == option_debug)
320                                 ast_cli(fd, "Core debug is at least %d\n", option_debug);
321                         else
322                                 ast_cli(fd, "Core debug was %d and is now %d\n", oldval, option_debug);
323                 }
324         }
325
326         return CLI_SUCCESS;
327 }
328
329 static int handle_logger_mute(int fd, int argc, char *argv[])
330 {
331         if (argc != 2)
332                 return RESULT_SHOWUSAGE;
333         ast_console_toggle_mute(fd);
334         return RESULT_SUCCESS;
335 }
336
337 static char *handle_unload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
338 {
339         /* "module unload mod_1 [mod_2 .. mod_N]" */
340         int x;
341         int force = AST_FORCE_SOFT;
342         char *s;
343
344         switch (cmd) {
345         case CLI_INIT:
346                 e->command = "module unload";
347                 e->usage =
348                         "Usage: module unload [-f|-h] <module_1> [<module_2> ... ]\n"
349                         "       Unloads the specified module from Asterisk. The -f\n"
350                         "       option causes the module to be unloaded even if it is\n"
351                         "       in use (may cause a crash) and the -h module causes the\n"
352                         "       module to be unloaded even if the module says it cannot, \n"
353                         "       which almost always will cause a crash.\n";
354                 return NULL;
355
356         case CLI_GENERATE:
357                 return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0);
358         }
359         if (a->argc < e->args + 1)
360                 return CLI_SHOWUSAGE;
361         x = e->args;    /* first argument */
362         s = a->argv[x];
363         if (s[0] == '-') {
364                 if (s[1] == 'f')
365                         force = AST_FORCE_FIRM;
366                 else if (s[1] == 'h')
367                         force = AST_FORCE_HARD;
368                 else
369                         return CLI_SHOWUSAGE;
370                 if (a->argc < e->args + 2)      /* need at least one module name */
371                         return CLI_SHOWUSAGE;
372                 x++;    /* skip this argument */
373         }
374
375         for (; x < a->argc; x++) {
376                 if (ast_unload_resource(a->argv[x], force)) {
377                         ast_cli(a->fd, "Unable to unload resource %s\n", a->argv[x]);
378                         return CLI_FAILURE;
379                 }
380         }
381         return CLI_SUCCESS;
382 }
383
384 static char *handle_unload_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
385 {
386         char *res = handle_unload(e, cmd, a);
387         if (cmd == CLI_INIT)
388                 e->command = "unload";  /* XXX override */
389         return res;
390 }
391
392 #define MODLIST_FORMAT  "%-30s %-40.40s %-10d\n"
393 #define MODLIST_FORMAT2 "%-30s %-40.40s %-10s\n"
394
395 AST_MUTEX_DEFINE_STATIC(climodentrylock);
396 static int climodentryfd = -1;
397
398 static int modlist_modentry(const char *module, const char *description, int usecnt, const char *like)
399 {
400         /* Comparing the like with the module */
401         if (strcasestr(module, like) ) {
402                 ast_cli(climodentryfd, MODLIST_FORMAT, module, description, usecnt);
403                 return 1;
404         } 
405         return 0;
406 }
407
408 static void print_uptimestr(int fd, time_t timeval, const char *prefix, int printsec)
409 {
410         int x; /* the main part - years, weeks, etc. */
411         char timestr[256]="", *s = timestr;
412         size_t maxbytes = sizeof(timestr);
413
414 #define SECOND (1)
415 #define MINUTE (SECOND*60)
416 #define HOUR (MINUTE*60)
417 #define DAY (HOUR*24)
418 #define WEEK (DAY*7)
419 #define YEAR (DAY*365)
420 #define ESS(x) ((x == 1) ? "" : "s")    /* plural suffix */
421 #define NEEDCOMMA(x) ((x)? ",": "")     /* define if we need a comma */
422         if (timeval < 0)        /* invalid, nothing to show */
423                 return;
424         if (printsec)  {        /* plain seconds output */
425                 ast_build_string(&s, &maxbytes, "%lu", (u_long)timeval);
426                 timeval = 0; /* bypass the other cases */
427         }
428         if (timeval > YEAR) {
429                 x = (timeval / YEAR);
430                 timeval -= (x * YEAR);
431                 ast_build_string(&s, &maxbytes, "%d year%s%s ", x, ESS(x),NEEDCOMMA(timeval));
432         }
433         if (timeval > WEEK) {
434                 x = (timeval / WEEK);
435                 timeval -= (x * WEEK);
436                 ast_build_string(&s, &maxbytes, "%d week%s%s ", x, ESS(x),NEEDCOMMA(timeval));
437         }
438         if (timeval > DAY) {
439                 x = (timeval / DAY);
440                 timeval -= (x * DAY);
441                 ast_build_string(&s, &maxbytes, "%d day%s%s ", x, ESS(x),NEEDCOMMA(timeval));
442         }
443         if (timeval > HOUR) {
444                 x = (timeval / HOUR);
445                 timeval -= (x * HOUR);
446                 ast_build_string(&s, &maxbytes, "%d hour%s%s ", x, ESS(x),NEEDCOMMA(timeval));
447         }
448         if (timeval > MINUTE) {
449                 x = (timeval / MINUTE);
450                 timeval -= (x * MINUTE);
451                 ast_build_string(&s, &maxbytes, "%d minute%s%s ", x, ESS(x),NEEDCOMMA(timeval));
452         }
453         x = timeval;
454         if (x > 0)
455                 ast_build_string(&s, &maxbytes, "%d second%s ", x, ESS(x));
456         if (timestr[0] != '\0')
457                 ast_cli(fd, "%s: %s\n", prefix, timestr);
458 }
459
460 static char * handle_showuptime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
461 {
462         time_t curtime;
463         int printsec;
464
465         switch (cmd) {
466         case CLI_INIT:
467                 e->command = "core show uptime";
468                 e->usage =
469                         "Usage: core show uptime [seconds]\n"
470                         "       Shows Asterisk uptime information.\n"
471                         "       The seconds word returns the uptime in seconds only.\n";
472                 return NULL;
473
474         case CLI_GENERATE:
475                 return (a->pos > e->args || a->n > 0) ? NULL : "seconds";
476         }
477         /* regular handler */
478         if (a->argc == e->args+1 && !strcasecmp(a->argv[e->args],"seconds"))
479                 printsec = 1;
480         else if (a->argc == e->args)
481                 printsec = 0;
482         else
483                 return CLI_SHOWUSAGE;
484         curtime = time(NULL);
485         if (ast_startuptime)
486                 print_uptimestr(a->fd, curtime - ast_startuptime, "System uptime", printsec);
487         if (ast_lastreloadtime)
488                 print_uptimestr(a->fd, curtime - ast_lastreloadtime, "Last reload", printsec);
489         return CLI_SUCCESS;
490 }
491
492 static char *handle_modlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
493 {
494         char *like;
495
496         switch (cmd) {
497         case CLI_INIT:
498                 e->command = "module show";
499                 e->usage =
500                         "Usage: module show [like keyword]\n"
501                         "       Shows Asterisk modules currently in use, and usage statistics.\n";
502                 return NULL;
503
504         case CLI_GENERATE:
505                 if (a->pos == e->args)
506                         return a->n == 0 ? strdup("like") : NULL;
507                 else if (a->pos == e->args+1 && strcasestr(a->line," like "))
508                         return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0);
509                 else
510                         return NULL;
511         }
512         /* all the above return, so we proceed with the handler.
513          * we are guaranteed to have argc >= e->args
514          */
515         if (a->argc == e->args)
516                 like = "";
517         else if (a->argc == e->args + 2 && !strcmp(a->argv[e->args],"like"))
518                 like = a->argv[e->args + 1];
519         else
520                 return CLI_SHOWUSAGE;
521                 
522         ast_mutex_lock(&climodentrylock);
523         climodentryfd = a->fd; /* global, protected by climodentrylock */
524         ast_cli(a->fd, MODLIST_FORMAT2, "Module", "Description", "Use Count");
525         ast_cli(a->fd,"%d modules loaded\n", ast_update_module_list(modlist_modentry, like));
526         climodentryfd = -1;
527         ast_mutex_unlock(&climodentrylock);
528         return RESULT_SUCCESS;
529 }
530 #undef MODLIST_FORMAT
531 #undef MODLIST_FORMAT2
532
533 static char *handle_chanlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
534 {
535 #define FORMAT_STRING  "%-20.20s %-20.20s %-7.7s %-30.30s\n"
536 #define FORMAT_STRING2 "%-20.20s %-20.20s %-7.7s %-30.30s\n"
537 #define CONCISE_FORMAT_STRING  "%s!%s!%s!%d!%s!%s!%s!%s!%s!%d!%s!%s\n"
538 #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"
539 #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"
540
541         struct ast_channel *c = NULL;
542         int numchans = 0, concise = 0, verbose = 0;
543         int fd, argc;
544         char **argv;
545
546         switch (cmd) {
547         case CLI_INIT:
548                 e->command = "core show channels";
549                 e->usage =
550                         "Usage: core show channels [concise|verbose]\n"
551                         "       Lists currently defined channels and some information about them. If\n"
552                         "       'concise' is specified, the format is abridged and in a more easily\n"
553                         "       machine parsable format. If 'verbose' is specified, the output includes\n"
554                         "       more and longer fields.\n";
555                 return NULL;
556
557         case CLI_GENERATE: {
558                 static char *choices[] = { "concise", "verbose", NULL };
559                 return (a->pos != e->args) ? NULL : ast_cli_complete(a->word, choices, a->n);
560                 }
561         }
562         fd = a->fd;
563         argc = a->argc;
564         argv = a->argv;
565
566         if (a->argc == e->args + 1) {
567                 if (!strcasecmp(argv[3],"concise"))
568                         concise = 1;
569                 else if (!strcasecmp(argv[3],"verbose"))
570                         verbose = 1;
571                 else
572                         return CLI_SHOWUSAGE;
573         } else if (a->argc != e->args)
574                 return CLI_SHOWUSAGE;
575
576         if (!concise && !verbose)
577                 ast_cli(fd, FORMAT_STRING2, "Channel", "Location", "State", "Application(Data)");
578         else if (verbose)
579                 ast_cli(fd, VERBOSE_FORMAT_STRING2, "Channel", "Context", "Extension", "Priority", "State", "Application", "Data", 
580                         "CallerID", "Duration", "Accountcode", "BridgedTo");
581
582         while ((c = ast_channel_walk_locked(c)) != NULL) {
583                 struct ast_channel *bc = ast_bridged_channel(c);
584                 char durbuf[10] = "-";
585
586                 if ((concise || verbose)  && c->cdr && !ast_tvzero(c->cdr->start)) {
587                         int duration = (int)(ast_tvdiff_ms(ast_tvnow(), c->cdr->start) / 1000);
588                         if (verbose) {
589                                 int durh = duration / 3600;
590                                 int durm = (duration % 3600) / 60;
591                                 int durs = duration % 60;
592                                 snprintf(durbuf, sizeof(durbuf), "%02d:%02d:%02d", durh, durm, durs);
593                         } else {
594                                 snprintf(durbuf, sizeof(durbuf), "%d", duration);
595                         }                               
596                 }
597                 if (concise) {
598                         ast_cli(fd, CONCISE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
599                                 c->appl ? c->appl : "(None)",
600                                 S_OR(c->data, ""),      /* XXX different from verbose ? */
601                                 S_OR(c->cid.cid_num, ""),
602                                 S_OR(c->accountcode, ""),
603                                 c->amaflags, 
604                                 durbuf,
605                                 bc ? bc->name : "(None)");
606                 } else if (verbose) {
607                         ast_cli(fd, VERBOSE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state),
608                                 c->appl ? c->appl : "(None)",
609                                 c->data ? S_OR(c->data, "(Empty)" ): "(None)",
610                                 S_OR(c->cid.cid_num, ""),
611                                 durbuf,
612                                 S_OR(c->accountcode, ""),
613                                 bc ? bc->name : "(None)");
614                 } else {
615                         char locbuf[40] = "(None)";
616                         char appdata[40] = "(None)";
617
618                         if (!ast_strlen_zero(c->context) && !ast_strlen_zero(c->exten)) 
619                                 snprintf(locbuf, sizeof(locbuf), "%s@%s:%d", c->exten, c->context, c->priority);
620                         if (c->appl)
621                                 snprintf(appdata, sizeof(appdata), "%s(%s)", c->appl, S_OR(c->data, ""));
622                         ast_cli(fd, FORMAT_STRING, c->name, locbuf, ast_state2str(c->_state), appdata);
623                 }
624                 numchans++;
625                 ast_channel_unlock(c);
626         }
627         if (!concise) {
628                 ast_cli(fd, "%d active channel%s\n", numchans, ESS(numchans));
629                 if (option_maxcalls)
630                         ast_cli(fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
631                                 ast_active_calls(), option_maxcalls, ESS(ast_active_calls()),
632                                 ((double)ast_active_calls() / (double)option_maxcalls) * 100.0);
633                 else
634                         ast_cli(fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
635         }
636         return CLI_SUCCESS;
637         
638 #undef FORMAT_STRING
639 #undef FORMAT_STRING2
640 #undef CONCISE_FORMAT_STRING
641 #undef VERBOSE_FORMAT_STRING
642 #undef VERBOSE_FORMAT_STRING2
643 }
644
645 static char showchan_help[] = 
646 "Usage: core show channel <channel>\n"
647 "       Shows lots of information about the specified channel.\n";
648
649 static char commandcomplete_help[] = 
650 "Usage: _command complete \"<line>\" text state\n"
651 "       This function is used internally to help with command completion and should.\n"
652 "       never be called by the user directly.\n";
653
654 static char commandnummatches_help[] = 
655 "Usage: _command nummatches \"<line>\" text \n"
656 "       This function is used internally to help with command completion and should.\n"
657 "       never be called by the user directly.\n";
658
659 static char commandmatchesarray_help[] = 
660 "Usage: _command matchesarray \"<line>\" text \n"
661 "       This function is used internally to help with command completion and should.\n"
662 "       never be called by the user directly.\n";
663
664 static int handle_softhangup(int fd, int argc, char *argv[])
665 {
666         struct ast_channel *c=NULL;
667         if (argc != 3)
668                 return RESULT_SHOWUSAGE;
669         c = ast_get_channel_by_name_locked(argv[2]);
670         if (c) {
671                 ast_cli(fd, "Requested Hangup on channel '%s'\n", c->name);
672                 ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
673                 ast_channel_unlock(c);
674         } else
675                 ast_cli(fd, "%s is not a known channel\n", argv[2]);
676         return RESULT_SUCCESS;
677 }
678
679 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock);
680
681 static int handle_commandmatchesarray(int fd, int argc, char *argv[])
682 {
683         char *buf, *obuf;
684         int buflen = 2048;
685         int len = 0;
686         char **matches;
687         int x, matchlen;
688
689         if (argc != 4)
690                 return RESULT_SHOWUSAGE;
691         if (!(buf = ast_malloc(buflen)))
692                 return RESULT_FAILURE;
693         buf[len] = '\0';
694         matches = ast_cli_completion_matches(argv[2], argv[3]);
695         if (matches) {
696                 for (x=0; matches[x]; x++) {
697                         matchlen = strlen(matches[x]) + 1;
698                         if (len + matchlen >= buflen) {
699                                 buflen += matchlen * 3;
700                                 obuf = buf;
701                                 if (!(buf = ast_realloc(obuf, buflen))) 
702                                         /* Memory allocation failure...  Just free old buffer and be done */
703                                         free(obuf);
704                         }
705                         if (buf)
706                                 len += sprintf( buf + len, "%s ", matches[x]);
707                         free(matches[x]);
708                         matches[x] = NULL;
709                 }
710                 free(matches);
711         }
712
713         if (buf) {
714                 ast_cli(fd, "%s%s",buf, AST_CLI_COMPLETE_EOF);
715                 free(buf);
716         } else
717                 ast_cli(fd, "NULL\n");
718
719         return RESULT_SUCCESS;
720 }
721
722
723
724 static int handle_commandnummatches(int fd, int argc, char *argv[])
725 {
726         int matches = 0;
727
728         if (argc != 4)
729                 return RESULT_SHOWUSAGE;
730
731         matches = ast_cli_generatornummatches(argv[2], argv[3]);
732
733         ast_cli(fd, "%d", matches);
734
735         return RESULT_SUCCESS;
736 }
737
738 static int handle_commandcomplete(int fd, int argc, char *argv[])
739 {
740         char *buf;
741
742         if (argc != 5)
743                 return RESULT_SHOWUSAGE;
744         buf = __ast_cli_generator(argv[2], argv[3], atoi(argv[4]), 0);
745         if (buf) {
746                 ast_cli(fd, buf);
747                 free(buf);
748         } else
749                 ast_cli(fd, "NULL\n");
750         return RESULT_SUCCESS;
751 }
752
753 static char *handle_core_set_debug_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
754 {
755         struct ast_channel *c = NULL;
756         int is_all, is_off = 0;
757
758         switch (cmd) {
759         case CLI_INIT:
760                 e->command = "core set debug channel";
761                 e->usage =
762                         "Usage: core set debug channel <all|channel> [off]\n"
763                         "       Enables/disables debugging on all or on a specific channel.\n";
764                 return NULL;
765
766         case CLI_GENERATE:
767                 /* XXX remember to handle the optional "off" */
768                 if (a->pos != e->args)
769                         return NULL;
770                 return a->n == 0 ? strdup("all") : ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
771         }
772         /* 'core set debug channel {all|chan_id}' */
773         if (a->argc == e->args + 2) {
774                 if (!strcasecmp(a->argv[e->args + 1], "off"))
775                         is_off = 1;
776                 else
777                         return CLI_SHOWUSAGE;
778         } else if (a->argc != e->args + 1)
779                 return CLI_SHOWUSAGE;
780
781         is_all = !strcasecmp("all", a->argv[e->args]);
782         if (is_all) {
783                 if (is_off) {
784                         global_fin &= ~DEBUGCHAN_FLAG;
785                         global_fout &= ~DEBUGCHAN_FLAG;
786                 } else {
787                         global_fin |= DEBUGCHAN_FLAG;
788                         global_fout |= DEBUGCHAN_FLAG;
789                 }
790                 c = ast_channel_walk_locked(NULL);
791         } else {
792                 c = ast_get_channel_by_name_locked(a->argv[e->args]);
793                 if (c == NULL)
794                         ast_cli(a->fd, "No such channel %s\n", a->argv[e->args]);
795         }
796         while (c) {
797                 if (!(c->fin & DEBUGCHAN_FLAG) || !(c->fout & DEBUGCHAN_FLAG)) {
798                         if (is_off) {
799                                 c->fin &= ~DEBUGCHAN_FLAG;
800                                 c->fout &= ~DEBUGCHAN_FLAG;
801                         } else {
802                                 c->fin |= DEBUGCHAN_FLAG;
803                                 c->fout |= DEBUGCHAN_FLAG;
804                         }
805                         ast_cli(a->fd, "Debugging %s on channel %s\n", is_off ? "disabled" : "enabled", c->name);
806                 }
807                 ast_channel_unlock(c);
808                 if (!is_all)
809                         break;
810                 c = ast_channel_walk_locked(c);
811         }
812         ast_cli(a->fd, "Debugging on new channels is %s\n", is_off ? "disabled" : "enabled");
813         return RESULT_SUCCESS;
814 }
815
816 static char *handle_debugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
817 {
818         char *res;
819
820         if (cmd == CLI_HANDLER && a->argc != e->args + 1)
821                 return CLI_SHOWUSAGE;
822         res = handle_core_set_debug_channel(e, cmd, a);
823         if (cmd == CLI_INIT)
824                 e->command = "debug channel";
825         return res;
826 }
827
828 static char *handle_nodebugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
829 {
830         char *res;
831         if (cmd == CLI_HANDLER) {
832                 if (a->argc != e->args + 1)
833                         return CLI_SHOWUSAGE;
834                 /* pretend we have an extra "off" at the end. We can do this as the array
835                  * is NULL terminated so we overwrite that entry.
836                  */
837                 a->argv[e->args+1] = "off";
838                 a->argc++;
839         }
840         res = handle_core_set_debug_channel(e, cmd, a);
841         if (cmd == CLI_INIT)
842                 e->command = "no debug channel";
843         return res;
844 }
845                 
846 static int handle_showchan(int fd, int argc, char *argv[])
847 {
848         struct ast_channel *c=NULL;
849         struct timeval now;
850         char buf[2048];
851         char cdrtime[256];
852         char nf[256], wf[256], rf[256];
853         long elapsed_seconds=0;
854         int hour=0, min=0, sec=0;
855         
856         if (argc != 4)
857                 return RESULT_SHOWUSAGE;
858         now = ast_tvnow();
859         c = ast_get_channel_by_name_locked(argv[3]);
860         if (!c) {
861                 ast_cli(fd, "%s is not a known channel\n", argv[3]);
862                 return RESULT_SUCCESS;
863         }
864         if(c->cdr) {
865                 elapsed_seconds = now.tv_sec - c->cdr->start.tv_sec;
866                 hour = elapsed_seconds / 3600;
867                 min = (elapsed_seconds % 3600) / 60;
868                 sec = elapsed_seconds % 60;
869                 snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec);
870         } else
871                 strcpy(cdrtime, "N/A");
872         ast_cli(fd, 
873                 " -- General --\n"
874                 "           Name: %s\n"
875                 "           Type: %s\n"
876                 "       UniqueID: %s\n"
877                 "      Caller ID: %s\n"
878                 " Caller ID Name: %s\n"
879                 "    DNID Digits: %s\n"
880                 "          State: %s (%d)\n"
881                 "          Rings: %d\n"
882                 "  NativeFormats: %s\n"
883                 "    WriteFormat: %s\n"
884                 "     ReadFormat: %s\n"
885                 " WriteTranscode: %s\n"
886                 "  ReadTranscode: %s\n"
887                 "1st File Descriptor: %d\n"
888                 "      Frames in: %d%s\n"
889                 "     Frames out: %d%s\n"
890                 " Time to Hangup: %ld\n"
891                 "   Elapsed Time: %s\n"
892                 "  Direct Bridge: %s\n"
893                 "Indirect Bridge: %s\n"
894                 " --   PBX   --\n"
895                 "        Context: %s\n"
896                 "      Extension: %s\n"
897                 "       Priority: %d\n"
898                 "     Call Group: %llu\n"
899                 "   Pickup Group: %llu\n"
900                 "    Application: %s\n"
901                 "           Data: %s\n"
902                 "    Blocking in: %s\n",
903                 c->name, c->tech->type, c->uniqueid,
904                 S_OR(c->cid.cid_num, "(N/A)"),
905                 S_OR(c->cid.cid_name, "(N/A)"),
906                 S_OR(c->cid.cid_dnid, "(N/A)"), ast_state2str(c->_state), c->_state, c->rings, 
907                 ast_getformatname_multiple(nf, sizeof(nf), c->nativeformats), 
908                 ast_getformatname_multiple(wf, sizeof(wf), c->writeformat), 
909                 ast_getformatname_multiple(rf, sizeof(rf), c->readformat),
910                 c->writetrans ? "Yes" : "No",
911                 c->readtrans ? "Yes" : "No",
912                 c->fds[0],
913                 c->fin & ~DEBUGCHAN_FLAG, (c->fin & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
914                 c->fout & ~DEBUGCHAN_FLAG, (c->fout & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "",
915                 (long)c->whentohangup,
916                 cdrtime, c->_bridge ? c->_bridge->name : "<none>", ast_bridged_channel(c) ? ast_bridged_channel(c)->name : "<none>", 
917                 c->context, c->exten, c->priority, c->callgroup, c->pickupgroup, ( c->appl ? c->appl : "(N/A)" ),
918                 ( c-> data ? S_OR(c->data, "(Empty)") : "(None)"),
919                 (ast_test_flag(c, AST_FLAG_BLOCKING) ? c->blockproc : "(Not Blocking)"));
920         
921         if(pbx_builtin_serialize_variables(c,buf,sizeof(buf)))
922                 ast_cli(fd,"      Variables:\n%s\n",buf);
923         if(c->cdr && ast_cdr_serialize_variables(c->cdr,buf, sizeof(buf), '=', '\n', 1))
924                 ast_cli(fd,"  CDR Variables:\n%s\n",buf);
925         
926         ast_channel_unlock(c);
927         return RESULT_SUCCESS;
928 }
929
930 /*
931  * helper function to generate CLI matches from a fixed set of values.
932  * A NULL word is acceptable.
933  */
934 char *ast_cli_complete(const char *word, char *const choices[], int state)
935 {
936         int i, which = 0, len;
937         len = ast_strlen_zero(word) ? 0 : strlen(word);
938
939         for (i = 0; choices[i]; i++) {
940                 if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
941                         return ast_strdup(choices[i]);
942         }
943         return NULL;
944 }
945
946 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
947 {
948         struct ast_channel *c = NULL;
949         int which = 0;
950         int wordlen;
951         char notfound = '\0';
952         char *ret = &notfound; /* so NULL can break the loop */
953
954         if (pos != rpos)
955                 return NULL;
956
957         wordlen = strlen(word); 
958
959         while (ret == &notfound && (c = ast_channel_walk_locked(c))) {
960                 if (!strncasecmp(word, c->name, wordlen) && ++which > state)
961                         ret = ast_strdup(c->name);
962                 ast_channel_unlock(c);
963         }
964         return ret == &notfound ? NULL : ret;
965 }
966
967 static char *complete_ch_3(const char *line, const char *word, int pos, int state)
968 {
969         return ast_complete_channels(line, word, pos, state, 2);
970 }
971
972 static char *complete_ch_4(const char *line, const char *word, int pos, int state)
973 {
974         return ast_complete_channels(line, word, pos, state, 3);
975 }
976
977 static int group_show_channels(int fd, int argc, char *argv[])
978 {
979 #define FORMAT_STRING  "%-25s  %-20s  %-20s\n"
980
981         struct ast_channel *c = NULL;
982         int numchans = 0;
983         struct ast_var_t *current;
984         struct varshead *headp;
985         regex_t regexbuf;
986         int havepattern = 0;
987
988         if (argc < 3 || argc > 4)
989                 return RESULT_SHOWUSAGE;
990         
991         if (argc == 4) {
992                 if (regcomp(&regexbuf, argv[3], REG_EXTENDED | REG_NOSUB))
993                         return RESULT_SHOWUSAGE;
994                 havepattern = 1;
995         }
996
997         ast_cli(fd, FORMAT_STRING, "Channel", "Group", "Category");
998         while ( (c = ast_channel_walk_locked(c)) != NULL) {
999                 headp=&c->varshead;
1000                 AST_LIST_TRAVERSE(headp,current,entries) {
1001                         if (!strncmp(ast_var_name(current), GROUP_CATEGORY_PREFIX "_", strlen(GROUP_CATEGORY_PREFIX) + 1)) {
1002                                 if (!havepattern || !regexec(&regexbuf, ast_var_value(current), 0, NULL, 0)) {
1003                                         ast_cli(fd, FORMAT_STRING, c->name, ast_var_value(current),
1004                                                 (ast_var_name(current) + strlen(GROUP_CATEGORY_PREFIX) + 1));
1005                                         numchans++;
1006                                 }
1007                         } else if (!strcmp(ast_var_name(current), GROUP_CATEGORY_PREFIX)) {
1008                                 if (!havepattern || !regexec(&regexbuf, ast_var_value(current), 0, NULL, 0)) {
1009                                         ast_cli(fd, FORMAT_STRING, c->name, ast_var_value(current), "(default)");
1010                                         numchans++;
1011                                 }
1012                         }
1013                 }
1014                 numchans++;
1015                 ast_channel_unlock(c);
1016         }
1017
1018         if (havepattern)
1019                 regfree(&regexbuf);
1020
1021         ast_cli(fd, "%d active channel%s\n", numchans, (numchans != 1) ? "s" : "");
1022         return RESULT_SUCCESS;
1023 #undef FORMAT_STRING
1024 }
1025
1026 static int handle_help(int fd, int argc, char *argv[]);
1027
1028 static char * complete_help(const char *text, const char *word, int pos, int state)
1029 {
1030         /* skip first 4 or 5 chars, "help "*/
1031         int l = strlen(text);
1032
1033         if (l > 5)
1034                 l = 5;
1035         text += l;
1036         /* XXX watch out, should stop to the non-generator parts */
1037         return __ast_cli_generator(text, word, state, 0);
1038 }
1039
1040 /* XXX Nothing in this array can currently be deprecated...
1041    You have to change the way find_cli works in order to remove this array
1042    I recommend doing this eventually...
1043  */
1044 static struct ast_cli_entry builtins[] = {
1045         /* Keep alphabetized, with longer matches first (example: abcd before abc) */
1046         { { "_command", "complete", NULL },
1047         handle_commandcomplete, "Command complete",
1048         commandcomplete_help },
1049
1050         { { "_command", "nummatches", NULL },
1051         handle_commandnummatches, "Returns number of command matches",
1052         commandnummatches_help },
1053
1054         { { "_command", "matchesarray", NULL },
1055         handle_commandmatchesarray, "Returns command matches array",
1056         commandmatchesarray_help },
1057
1058         { { NULL }, NULL, NULL, NULL }
1059 };
1060
1061 static struct ast_cli_entry cli_debug_channel_deprecated = NEW_CLI(handle_debugchan_deprecated, "Enable debugging on channel");
1062 static struct ast_cli_entry cli_module_load_deprecated = NEW_CLI(handle_load_deprecated, "Load a module");
1063 static struct ast_cli_entry cli_module_reload_deprecated = NEW_CLI(handle_reload_deprecated, "reload modules by name");
1064 static struct ast_cli_entry cli_module_unload_deprecated = NEW_CLI(handle_unload_deprecated, "unload modules by name");
1065
1066 static struct ast_cli_entry cli_cli[] = {
1067         /* Deprecated, but preferred command is now consolidated (and already has a deprecated command for it). */
1068         NEW_CLI(handle_nodebugchan_deprecated, "Disable debugging on channel(s)"),
1069
1070         NEW_CLI(handle_chanlist, "Display information on channels"),
1071
1072         { { "core", "show", "channel", NULL },
1073         handle_showchan, "Display information on a specific channel",
1074         showchan_help, complete_ch_4 },
1075
1076         NEW_CLI(handle_core_set_debug_channel, "Enable/disable debugging on a channel",
1077                 .deprecate_cmd = &cli_debug_channel_deprecated),
1078
1079         NEW_CLI(handle_set_debug, "Set level of debug chattiness"),
1080
1081         NEW_CLI(handle_verbose, "Set level of verboseness"),
1082
1083         { { "group", "show", "channels", NULL },
1084         group_show_channels, "Display active channels with group(s)",
1085         group_show_channels_help },
1086
1087         { { "help", NULL },
1088         handle_help, "Display help list, or specific help on a command",
1089         help_help, complete_help },
1090
1091         { { "logger", "mute", NULL },
1092         handle_logger_mute, "Toggle logging output to a console",
1093         logger_mute_help },
1094
1095         NEW_CLI(handle_modlist, "List modules and info"),
1096
1097         NEW_CLI(handle_load, "Load a module by name", .deprecate_cmd = &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         int dummy = 0;
1439
1440         if (trailingwhitespace == NULL)
1441                 trailingwhitespace = &dummy;
1442         *trailingwhitespace = 0;
1443         if (s == NULL)  /* invalid, though! */
1444                 return NULL;
1445         /* make a copy to store the parsed string */
1446         if (!(dup = ast_strdup(s)))
1447                 return NULL;
1448
1449         cur = dup;
1450         /* scan the original string copying into cur when needed */
1451         for (; *s ; s++) {
1452                 if (x >= max - 1) {
1453                         ast_log(LOG_WARNING, "Too many arguments, truncating at %s\n", s);
1454                         break;
1455                 }
1456                 if (*s == '"' && !escaped) {
1457                         quoted = !quoted;
1458                         if (quoted && whitespace) {
1459                                 /* start a quoted string from previous whitespace: new argument */
1460                                 argv[x++] = cur;
1461                                 whitespace = 0;
1462                         }
1463                 } else if ((*s == ' ' || *s == '\t') && !(quoted || escaped)) {
1464                         /* If we are not already in whitespace, and not in a quoted string or
1465                            processing an escape sequence, and just entered whitespace, then
1466                            finalize the previous argument and remember that we are in whitespace
1467                         */
1468                         if (!whitespace) {
1469                                 *cur++ = '\0';
1470                                 whitespace = 1;
1471                         }
1472                 } else if (*s == '\\' && !escaped) {
1473                         escaped = 1;
1474                 } else {
1475                         if (whitespace) {
1476                                 /* we leave whitespace, and are not quoted. So it's a new argument */
1477                                 argv[x++] = cur;
1478                                 whitespace = 0;
1479                         }
1480                         *cur++ = *s;
1481                         escaped = 0;
1482                 }
1483         }
1484         /* Null terminate */
1485         *cur++ = '\0';
1486         /* XXX put a NULL in the last argument, because some functions that take
1487          * the array may want a null-terminated array.
1488          * argc still reflects the number of non-NULL entries.
1489          */
1490         argv[x] = NULL;
1491         *argc = x;
1492         *trailingwhitespace = whitespace;
1493         return dup;
1494 }
1495
1496 /*! \brief Return the number of unique matches for the generator */
1497 int ast_cli_generatornummatches(const char *text, const char *word)
1498 {
1499         int matches = 0, i = 0;
1500         char *buf = NULL, *oldbuf = NULL;
1501
1502         while ((buf = ast_cli_generator(text, word, i++))) {
1503                 if (!oldbuf || strcmp(buf,oldbuf))
1504                         matches++;
1505                 if (oldbuf)
1506                         free(oldbuf);
1507                 oldbuf = buf;
1508         }
1509         if (oldbuf)
1510                 free(oldbuf);
1511         return matches;
1512 }
1513
1514 char **ast_cli_completion_matches(const char *text, const char *word)
1515 {
1516         char **match_list = NULL, *retstr, *prevstr;
1517         size_t match_list_len, max_equal, which, i;
1518         int matches = 0;
1519
1520         /* leave entry 0 free for the longest common substring */
1521         match_list_len = 1;
1522         while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
1523                 if (matches + 1 >= match_list_len) {
1524                         match_list_len <<= 1;
1525                         if (!(match_list = ast_realloc(match_list, match_list_len * sizeof(*match_list))))
1526                                 return NULL;
1527                 }
1528                 match_list[++matches] = retstr;
1529         }
1530
1531         if (!match_list)
1532                 return match_list; /* NULL */
1533
1534         /* Find the longest substring that is common to all results
1535          * (it is a candidate for completion), and store a copy in entry 0.
1536          */
1537         prevstr = match_list[1];
1538         max_equal = strlen(prevstr);
1539         for (which = 2; which <= matches; which++) {
1540                 for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
1541                         continue;
1542                 max_equal = i;
1543         }
1544
1545         if (!(retstr = ast_malloc(max_equal + 1)))
1546                 return NULL;
1547         
1548         ast_copy_string(retstr, match_list[1], max_equal + 1);
1549         match_list[0] = retstr;
1550
1551         /* ensure that the array is NULL terminated */
1552         if (matches + 1 >= match_list_len) {
1553                 if (!(match_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list))))
1554                         return NULL;
1555         }
1556         match_list[matches + 1] = NULL;
1557
1558         return match_list;
1559 }
1560
1561 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock)
1562 {
1563         char *argv[AST_MAX_ARGS];
1564         struct ast_cli_entry *e;
1565         struct cli_iterator i = { NULL, NULL };
1566         int x = 0, argindex, matchlen;
1567         int matchnum=0;
1568         char *ret = NULL;
1569         char matchstr[80] = "";
1570         int tws = 0;
1571         char *dup = parse_args(text, &x, argv, sizeof(argv) / sizeof(argv[0]), &tws);
1572
1573         if (!dup)       /* malloc error */
1574                 return NULL;
1575         argindex = (!ast_strlen_zero(word) && x>0) ? x-1 : x;
1576         /* rebuild the command, ignore tws */
1577         ast_join(matchstr, sizeof(matchstr)-1, argv);
1578         matchlen = strlen(matchstr);
1579         if (tws) {
1580                 strcat(matchstr, " "); /* XXX */
1581                 if (matchlen)
1582                         matchlen++;
1583         }
1584         if (lock)
1585                 AST_LIST_LOCK(&helpers);
1586         while ( (e = cli_next(&i)) ) {
1587                 int lc = strlen(e->_full_cmd);
1588                 if (e->_full_cmd[0] != '_' && lc > 0 && matchlen <= lc &&
1589                                 !strncasecmp(matchstr, e->_full_cmd, matchlen)) {
1590                         /* Found initial part, return a copy of the next word... */
1591                         if (e->cmda[argindex] && ++matchnum > state) {
1592                                 ret = strdup(e->cmda[argindex]); /* we need a malloced string */
1593                                 break;
1594                         }
1595                 } else if (!strncasecmp(matchstr, e->_full_cmd, lc) && matchstr[lc] < 33) {
1596                         /* This entry is a prefix of the command string entered
1597                          * (only one entry in the list should have this property).
1598                          * Run the generator if one is available. In any case we are done.
1599                          */
1600                         if (e->generator)
1601                                 ret = e->generator(matchstr, word, argindex, state - matchnum);
1602                         else if (e->new_handler) {      /* new style command */
1603                                 struct ast_cli_args a = {
1604                                         .line = matchstr, .word = word,
1605                                         .pos = argindex,
1606                                         .n = state - matchnum };
1607                                 ret = e->new_handler(e, CLI_GENERATE, &a);
1608                         }
1609                         if (ret)
1610                                 break;
1611                 }
1612         }
1613         if (lock)
1614                 AST_LIST_UNLOCK(&helpers);
1615         free(dup);
1616         return ret;
1617 }
1618
1619 char *ast_cli_generator(const char *text, const char *word, int state)
1620 {
1621         return __ast_cli_generator(text, word, state, 1);
1622 }
1623
1624 int ast_cli_command(int fd, const char *s)
1625 {
1626         char *args[AST_MAX_ARGS + 1];
1627         struct ast_cli_entry *e;
1628         int x;
1629         int res;
1630         char *dup = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL);
1631
1632         if (dup == NULL)
1633                 return -1;
1634
1635         if (x < 1)      /* We need at least one entry, otherwise ignore */
1636                 goto done;
1637
1638         AST_LIST_LOCK(&helpers);
1639         e = find_cli(args + 1, 0);
1640         if (e)
1641                 ast_atomic_fetchadd_int(&e->inuse, 1);
1642         AST_LIST_UNLOCK(&helpers);
1643         if (e == NULL) {
1644                 ast_cli(fd, "No such command '%s' (type 'help' for help)\n", find_best(args + 1));
1645                 goto done;
1646         }
1647         /*
1648          * Within the handler, argv[-1] contains a pointer to the ast_cli_entry.
1649          * Remember that the array returned by parse_args is NULL-terminated.
1650          */
1651         args[0] = (char *)e;
1652
1653         if (!e->new_handler)    /* old style */
1654                 res = e->handler(fd, x, args + 1);
1655         else {
1656                 struct ast_cli_args a = {
1657                         .fd = fd, .argc = x, .argv = args+1 };
1658                 char *retval = e->new_handler(e, CLI_HANDLER, &a);
1659
1660                 if (retval == CLI_SUCCESS)
1661                         res = RESULT_SUCCESS;
1662                 else if (retval == CLI_SHOWUSAGE)
1663                         res = RESULT_SHOWUSAGE;
1664                 else
1665                         res = RESULT_FAILURE;
1666         }
1667         switch (res) {
1668         case RESULT_SHOWUSAGE:
1669                 ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n"));
1670                 break;
1671
1672         case RESULT_FAILURE:
1673                 ast_cli(fd, "Command '%s' failed.\n", s);
1674                 /* FALLTHROUGH */
1675         default:
1676                 AST_LIST_LOCK(&helpers);
1677                 if (e->deprecated == 1) {
1678                         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);
1679                         e->deprecated = 2;
1680                 }
1681                 AST_LIST_UNLOCK(&helpers);
1682                 break;
1683         }
1684         ast_atomic_fetchadd_int(&e->inuse, -1);
1685 done:
1686         free(dup);
1687         return 0;
1688 }