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