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