Asterisk - The Open Source Telephony Project  21.4.1
main/cli.c
Go to the documentation of this file.
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 /*! \li \ref cli.c uses the configuration file \ref cli_permissions.conf
27  * \addtogroup configuration_file Configuration Files
28  */
29 
30 /*!
31  * \page cli_permissions.conf cli_permissions.conf
32  * \verbinclude cli_permissions.conf.sample
33  */
34 
35 /*** MODULEINFO
36  <support_level>core</support_level>
37  ***/
38 
39 #include "asterisk.h"
40 
41 #include "asterisk/_private.h"
42 #include "asterisk/paths.h" /* use ast_config_AST_MODULE_DIR */
43 #include <signal.h>
44 #include <ctype.h>
45 #include <regex.h>
46 #include <pwd.h>
47 #include <grp.h>
48 
49 #include "asterisk/cli.h"
50 #include "asterisk/linkedlists.h"
51 #include "asterisk/module.h"
52 #include "asterisk/pbx.h"
53 #include "asterisk/channel.h"
54 #include "asterisk/utils.h"
55 #include "asterisk/app.h"
56 #include "asterisk/lock.h"
57 #include "asterisk/threadstorage.h"
58 #include "asterisk/logger_category.h"
59 #include "asterisk/translate.h"
60 #include "asterisk/bridge.h"
61 #include "asterisk/stasis_channels.h"
62 #include "asterisk/stasis_bridges.h"
63 #include "asterisk/vector.h"
64 #include "asterisk/stream.h"
65 
66 /*!
67  * \brief List of restrictions per user.
68  */
69 struct cli_perm {
70  unsigned int permit:1; /*!< 1=Permit 0=Deny */
71  char *command; /*!< Command name (to apply restrictions) */
73 };
74 
76 
77 /*! \brief list of users to apply restrictions. */
79  int uid; /*!< User ID (-1 disabled) */
80  int gid; /*!< Group ID (-1 disabled) */
81  struct cli_perm_head *perms; /*!< List of permissions. */
82  AST_LIST_ENTRY(usergroup_cli_perm) list;/*!< List mechanics */
83 };
84 /*! \brief CLI permissions config file. */
85 static const char perms_config[] = "cli_permissions.conf";
86 /*! \brief Default permissions value 1=Permit 0=Deny */
87 static int cli_default_perm = 1;
88 
89 /*! \brief mutex used to prevent a user from running the 'cli reload permissions' command while
90  * it is already running. */
91 AST_MUTEX_DEFINE_STATIC(permsconfiglock);
92 /*! \brief List of users and permissions. */
93 static AST_RWLIST_HEAD_STATIC(cli_perms, usergroup_cli_perm);
94 
95 /*!
96  * \brief map a debug or verbose level to a module name
97  */
98 struct module_level {
99  unsigned int level;
100  AST_RWLIST_ENTRY(module_level) entry;
101  char module[0];
102 };
103 
105 
106 /*! lists of module names and their debug/trace levels */
108 static struct module_level_list trace_modules = AST_RWLIST_HEAD_INIT_VALUE;
109 
110 AST_THREADSTORAGE(ast_cli_buf);
111 
112 AST_RWLOCK_DEFINE_STATIC(shutdown_commands_lock);
113 static AST_VECTOR(, struct ast_cli_entry *) shutdown_commands;
114 
115 /*! \brief Initial buffer size for resulting strings in ast_cli() */
116 #define AST_CLI_INITLEN 256
117 
118 void ast_cli(int fd, const char *fmt, ...)
119 {
120  int res;
121  struct ast_str *buf;
122  va_list ap;
123 
124  if (!(buf = ast_str_thread_get(&ast_cli_buf, AST_CLI_INITLEN)))
125  return;
126 
127  va_start(ap, fmt);
128  res = ast_str_set_va(&buf, 0, fmt, ap);
129  va_end(ap);
130 
131  if (res != AST_DYNSTR_BUILD_FAILED) {
132  ast_carefulwrite(fd, ast_str_buffer(buf), ast_str_strlen(buf), 100);
133  }
134 }
135 
136 unsigned int ast_debug_get_by_module(const char *module)
137 {
138  struct module_level *ml;
139  unsigned int res = 0;
140 
141  AST_RWLIST_RDLOCK(&debug_modules);
142  AST_LIST_TRAVERSE(&debug_modules, ml, entry) {
143  if (!strcasecmp(ml->module, module)) {
144  res = ml->level;
145  break;
146  }
147  }
148  AST_RWLIST_UNLOCK(&debug_modules);
149 
150  return res;
151 }
152 
153 unsigned int ast_trace_get_by_module(const char *module)
154 {
155  struct module_level *ml;
156  unsigned int res = 0;
157 
158  AST_RWLIST_RDLOCK(&trace_modules);
159  AST_LIST_TRAVERSE(&trace_modules, ml, entry) {
160  if (!strcasecmp(ml->module, module)) {
161  res = ml->level;
162  break;
163  }
164  }
165  AST_RWLIST_UNLOCK(&trace_modules);
166 
167  return res;
168 }
169 
170 /*! \internal
171  * \brief Check if the user with 'uid' and 'gid' is allow to execute 'command',
172  * if command starts with '_' then not check permissions, just permit
173  * to run the 'command'.
174  * if uid == -1 or gid == -1 do not check permissions.
175  * if uid == -2 and gid == -2 is because rasterisk client didn't send
176  * the credentials, so the cli_default_perm will be applied.
177  * \param uid User ID.
178  * \param gid Group ID.
179  * \param command Command name to check permissions.
180  * \retval 1 if has permission
181  * \retval 0 if it is not allowed.
182  */
183 static int cli_has_permissions(int uid, int gid, const char *command)
184 {
185  struct usergroup_cli_perm *user_perm;
186  struct cli_perm *perm;
187  /* set to the default permissions general option. */
188  int isallowg = cli_default_perm, isallowu = -1, ispattern;
189  regex_t regexbuf;
190 
191  /* if uid == -1 or gid == -1 do not check permissions.
192  if uid == -2 and gid == -2 is because rasterisk client didn't send
193  the credentials, so the cli_default_perm will be applied. */
194  if ((uid == CLI_NO_PERMS && gid == CLI_NO_PERMS) || command[0] == '_') {
195  return 1;
196  }
197 
198  if (gid < 0 && uid < 0) {
199  return cli_default_perm;
200  }
201 
203  AST_LIST_TRAVERSE(&cli_perms, user_perm, list) {
204  if (user_perm->gid != gid && user_perm->uid != uid) {
205  continue;
206  }
207  AST_LIST_TRAVERSE(user_perm->perms, perm, list) {
208  if (strcasecmp(perm->command, "all") && strncasecmp(perm->command, command, strlen(perm->command))) {
209  /* if the perm->command is a pattern, check it against command. */
210  ispattern = !regcomp(&regexbuf, perm->command, REG_EXTENDED | REG_NOSUB | REG_ICASE);
211  if (ispattern && regexec(&regexbuf, command, 0, NULL, 0)) {
212  regfree(&regexbuf);
213  continue;
214  }
215  if (!ispattern) {
216  continue;
217  }
218  regfree(&regexbuf);
219  }
220  if (user_perm->uid == uid) {
221  /* this is a user definition. */
222  isallowu = perm->permit;
223  } else {
224  /* otherwise is a group definition. */
225  isallowg = perm->permit;
226  }
227  }
228  }
230  if (isallowu > -1) {
231  /* user definition override group definition. */
232  isallowg = isallowu;
233  }
234 
235  return isallowg;
236 }
237 
239 
240 static char *handle_load(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
241 {
242  /* "module load <mod>" */
243  switch (cmd) {
244  case CLI_INIT:
245  e->command = "module load";
246  e->usage =
247  "Usage: module load <module name>\n"
248  " Loads the specified module into Asterisk.\n";
249  return NULL;
250 
251  case CLI_GENERATE:
252  if (a->pos != e->args) {
253  return NULL;
254  }
255  return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, AST_MODULE_HELPER_LOAD);
256  }
257  if (a->argc != e->args + 1) {
258  return CLI_SHOWUSAGE;
259  }
260  if (ast_load_resource(a->argv[e->args])) {
261  ast_cli(a->fd, "Unable to load module %s\n", a->argv[e->args]);
262  return CLI_FAILURE;
263  }
264  ast_cli(a->fd, "Loaded %s\n", a->argv[e->args]);
265  return CLI_SUCCESS;
266 }
267 
268 static char *handle_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
269 {
270  int x;
271 
272  switch (cmd) {
273  case CLI_INIT:
274  e->command = "module reload";
275  e->usage =
276  "Usage: module reload [module ...]\n"
277  " Reloads configuration files for all listed modules which support\n"
278  " reloading, or for all supported modules if none are listed.\n";
279  return NULL;
280 
281  case CLI_GENERATE:
282  return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, AST_MODULE_HELPER_RELOAD);
283  }
284  if (a->argc == e->args) {
285  ast_module_reload(NULL);
286  return CLI_SUCCESS;
287  }
288  for (x = e->args; x < a->argc; x++) {
289  enum ast_module_reload_result res = ast_module_reload(a->argv[x]);
290  switch (res) {
292  ast_cli(a->fd, "No such module '%s'\n", a->argv[x]);
293  break;
295  ast_cli(a->fd, "The module '%s' does not support reloads\n", a->argv[x]);
296  break;
298  ast_cli(a->fd, "Asterisk cannot reload a module yet; request queued\n");
299  break;
301  ast_cli(a->fd, "The module '%s' reported a reload failure\n", a->argv[x]);
302  break;
304  ast_cli(a->fd, "A module reload request is already in progress; please be patient\n");
305  break;
307  ast_cli(a->fd, "The module '%s' was not properly initialized. Before reloading"
308  " the module, you must run \"module load %s\" and fix whatever is"
309  " preventing the module from being initialized.\n", a->argv[x], a->argv[x]);
310  break;
312  ast_cli(a->fd, "Module '%s' reloaded successfully.\n", a->argv[x]);
313  break;
314  }
315  }
316  return CLI_SUCCESS;
317 }
318 
319 static char *handle_core_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
320 {
321  switch (cmd) {
322  case CLI_INIT:
323  e->command = "core reload";
324  e->usage =
325  "Usage: core reload\n"
326  " Execute a global reload.\n";
327  return NULL;
328 
329  case CLI_GENERATE:
330  return NULL;
331  }
332 
333  if (a->argc != e->args) {
334  return CLI_SHOWUSAGE;
335  }
336 
337  ast_module_reload(NULL);
338 
339  return CLI_SUCCESS;
340 }
341 
342 /*!
343  * \brief Find the module level setting
344  *
345  * \param module Module name to look for.
346  * \param mll List to search.
347  *
348  * \retval level struct found on success.
349  * \retval NULL not found.
350  */
351 static struct module_level *find_module_level(const char *module, struct module_level_list *mll)
352 {
353  struct module_level *ml;
354 
355  AST_LIST_TRAVERSE(mll, ml, entry) {
356  if (!strcasecmp(ml->module, module))
357  return ml;
358  }
359 
360  return NULL;
361 }
362 
363 static char *complete_number(const char *partial, unsigned int min, unsigned int max, int n)
364 {
365  int i, count = 0;
366  unsigned int prospective[2];
367  unsigned int part = strtoul(partial, NULL, 10);
368  char next[13];
369 
370  if (part < min || part > max) {
371  return NULL;
372  }
373 
374  for (i = 0; i < 21; i++) {
375  if (i == 0) {
376  prospective[0] = prospective[1] = part;
377  } else if (part == 0 && !ast_strlen_zero(partial)) {
378  break;
379  } else if (i < 11) {
380  prospective[0] = prospective[1] = part * 10 + (i - 1);
381  } else {
382  prospective[0] = (part * 10 + (i - 11)) * 10;
383  prospective[1] = prospective[0] + 9;
384  }
385  if (i < 11 && (prospective[0] < min || prospective[0] > max)) {
386  continue;
387  } else if (prospective[1] < min || prospective[0] > max) {
388  continue;
389  }
390 
391  if (++count > n) {
392  if (i < 11) {
393  snprintf(next, sizeof(next), "%u", prospective[0]);
394  } else {
395  snprintf(next, sizeof(next), "%u...", prospective[0] / 10);
396  }
397  return ast_strdup(next);
398  }
399  }
400  return NULL;
401 }
402 
403 #define DEBUG_HANDLER 0
404 #define TRACE_HANDLER 1
405 #define VERBOSE_HANDLER 2
406 
407 static void status_debug_verbose(struct ast_cli_args *a, int handler, int old_val, int cur_val)
408 {
409  char was_buf[30];
410  const char *was;
411  const char *what = "";
412 
413  switch(handler) {
414  case DEBUG_HANDLER:
415  what = "Core debug";
416  break;
417  case TRACE_HANDLER:
418  what = "Core trace";
419  break;
420  case VERBOSE_HANDLER:
421  what = "Console verbose";
422  break;
423  }
424 
425  if (old_val) {
426  snprintf(was_buf, sizeof(was_buf), "%d", old_val);
427  was = was_buf;
428  } else {
429  was = "OFF";
430  }
431 
432  if (old_val == cur_val) {
433  ast_cli(a->fd, "%s is still %s.\n", what, was);
434  } else {
435  char now_buf[30];
436  const char *now;
437 
438  if (cur_val) {
439  snprintf(now_buf, sizeof(now_buf), "%d", cur_val);
440  now = now_buf;
441  } else {
442  now = "OFF";
443  }
444 
445  ast_cli(a->fd, "%s was %s and is now %s.\n", what, was, now);
446  }
447 }
448 
449 static char *handle_debug_or_trace(int handler, struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
450 {
451  int oldval;
452  int newlevel;
453  int atleast = 0;
454  struct module_level *ml;
455  struct module_level_list *modules;
456  unsigned int module_option;
457  int *core_option;
458  const char *handler_name;
459 
460  if (a->argc <= e->args) {
461  return CLI_SHOWUSAGE;
462  }
463 
464  if (handler == DEBUG_HANDLER) {
465  modules = &debug_modules;
466  module_option = AST_OPT_FLAG_DEBUG_MODULE;
467  core_option = &option_debug;
468  handler_name = "debug";
469  } else {
470  modules = &trace_modules;
471  module_option = AST_OPT_FLAG_TRACE_MODULE;
472  core_option = &option_trace;
473  handler_name = "trace";
474  }
475 
476  if (a->argc == e->args + 1 && !strcasecmp(a->argv[e->args], "off")) {
477  newlevel = 0;
478  } else {
479  if (!strcasecmp(a->argv[e->args], "atleast")) {
480  atleast = 1;
481  }
482 
483  if (a->argc != e->args + atleast + 1 && a->argc != e->args + atleast + 2) {
484  return CLI_SHOWUSAGE;
485  }
486 
487  if (sscanf(a->argv[e->args + atleast], "%30d", &newlevel) != 1) {
488  return CLI_SHOWUSAGE;
489  }
490 
491  if (a->argc == e->args + atleast + 2) {
492  /* We have specified a module name. */
493  char *mod = ast_strdupa(a->argv[e->args + atleast + 1]);
494  int mod_len = strlen(mod);
495 
496  if (3 < mod_len && !strcasecmp(mod + mod_len - 3, ".so")) {
497  mod[mod_len - 3] = '\0';
498  }
499 
500  AST_RWLIST_WRLOCK(modules);
501 
502  ml = find_module_level(mod, modules);
503  if (!newlevel) {
504  if (!ml) {
505  /* Specified off for a nonexistent entry. */
506  AST_RWLIST_UNLOCK(modules);
507  ast_cli(a->fd, "Core %s is still 0 for '%s'.\n", handler_name, mod);
508  return CLI_SUCCESS;
509  }
510  AST_RWLIST_REMOVE(modules, ml, entry);
511  if (AST_RWLIST_EMPTY(modules)) {
512  ast_clear_flag(&ast_options, module_option);
513  }
514  AST_RWLIST_UNLOCK(modules);
515  ast_cli(a->fd, "Core %s was %u and has been set to 0 for '%s'.\n", handler_name,
516  ml->level, mod);
517  ast_free(ml);
518  return CLI_SUCCESS;
519  }
520 
521  if (ml) {
522  if ((atleast && newlevel < ml->level) || ml->level == newlevel) {
523  ast_cli(a->fd, "Core %s is still %u for '%s'.\n", handler_name, ml->level, mod);
524  AST_RWLIST_UNLOCK(modules);
525  return CLI_SUCCESS;
526  }
527  oldval = ml->level;
528  ml->level = newlevel;
529  } else {
530  ml = ast_calloc(1, sizeof(*ml) + strlen(mod) + 1);
531  if (!ml) {
532  AST_RWLIST_UNLOCK(modules);
533  return CLI_FAILURE;
534  }
535  oldval = ml->level;
536  ml->level = newlevel;
537  strcpy(ml->module, mod);
538  AST_RWLIST_INSERT_TAIL(modules, ml, entry);
539  }
540  ast_set_flag(&ast_options, module_option);
541 
542  ast_cli(a->fd, "Core %s was %d and has been set to %u for '%s'.\n", handler_name,
543  oldval, ml->level, ml->module);
544 
545  AST_RWLIST_UNLOCK(modules);
546 
547  return CLI_SUCCESS;
548  }
549  }
550 
551  /* Update global debug level */
552  if (!newlevel) {
553  /* Specified level was 0 or off. */
554  AST_RWLIST_WRLOCK(modules);
555  while ((ml = AST_RWLIST_REMOVE_HEAD(modules, entry))) {
556  ast_free(ml);
557  }
558  ast_clear_flag(&ast_options, AST_OPT_FLAG_DEBUG_MODULE);
559  AST_RWLIST_UNLOCK(modules);
560  }
561  oldval = *core_option;
562  if (!atleast || newlevel > *core_option) {
563  *core_option = newlevel;
564  }
565 
566  /* Report debug level status */
567  status_debug_verbose(a, handler, oldval, *core_option);
568 
569  return CLI_SUCCESS;
570 }
571 
572 static char *handle_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
573 {
574  int atleast = 0;
575  const char *argv3 = a->argv ? S_OR(a->argv[3], "") : "";
576 
577  switch (cmd) {
578  case CLI_INIT:
579  e->command = "core set debug";
580  e->usage =
581  "Usage: core set debug [atleast] <level> [module]\n"
582  " core set debug off\n"
583  "\n"
584  " Sets level of debug messages to be displayed or\n"
585  " sets a module name to display debug messages from.\n"
586  " 0 or off means no messages should be displayed.\n"
587  " Equivalent to -d[d[...]] on startup\n";
588  return NULL;
589 
590  case CLI_GENERATE:
591  if (!strcasecmp(argv3, "category")) {
592  return NULL;
593  }
594 
595  if (!strcasecmp(argv3, "atleast")) {
596  atleast = 1;
597  }
598  if (a->pos == 3 || (a->pos == 4 && atleast)) {
599  const char *pos = a->pos == 3 ? argv3 : S_OR(a->argv[4], "");
600  int numbermatch = (ast_strlen_zero(pos) || strchr("123456789", pos[0])) ? 0 : 21;
601 
602  if (a->n < 21 && numbermatch == 0) {
603  return complete_number(pos, 0, 0x7fffffff, a->n);
604  } else if (pos[0] == '0') {
605  if (a->n == 0) {
606  return ast_strdup("0");
607  }
608  } else if (a->n == (21 - numbermatch)) {
609  if (a->pos == 3 && !strncasecmp(argv3, "off", strlen(argv3))) {
610  return ast_strdup("off");
611  } else if (a->pos == 3 && !strncasecmp(argv3, "atleast", strlen(argv3))) {
612  return ast_strdup("atleast");
613  }
614  } else if (a->n == (22 - numbermatch) && a->pos == 3 && ast_strlen_zero(argv3)) {
615  return ast_strdup("atleast");
616  }
617  } else if ((a->pos == 4 && !atleast && strcasecmp(argv3, "off") && strcasecmp(argv3, "channel"))
618  || (a->pos == 5 && atleast)) {
619  return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, AST_MODULE_HELPER_RUNNING);
620  }
621  return NULL;
622  }
623  /* all the above return, so we proceed with the handler.
624  * we are guaranteed to be called with argc >= e->args;
625  */
626 
627  return handle_debug_or_trace(DEBUG_HANDLER, e, cmd, a);
628 }
629 
630 static char *handle_trace(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
631 {
632  int atleast = 0;
633  const char *argv3 = a->argv ? S_OR(a->argv[3], "") : "";
634 
635  switch (cmd) {
636  case CLI_INIT:
637  e->command = "core set trace";
638  e->usage =
639  "Usage: core set trace [atleast] <level> [module]\n"
640  " core set trace off\n"
641  "\n"
642  " Sets level of trace messages to be displayed or\n"
643  " sets a module name to display trace messages from.\n"
644  " 0 or off means no messages should be displayed.\n";
645  return NULL;
646 
647  case CLI_GENERATE:
648  if (!strcasecmp(argv3, "atleast")) {
649  atleast = 1;
650  }
651  if (a->pos == 3 || (a->pos == 4 && atleast)) {
652  const char *pos = a->pos == 3 ? argv3 : S_OR(a->argv[4], "");
653  int numbermatch = (ast_strlen_zero(pos) || strchr("123456789", pos[0])) ? 0 : 21;
654 
655  if (a->n < 21 && numbermatch == 0) {
656  return complete_number(pos, 0, 0x7fffffff, a->n);
657  } else if (pos[0] == '0') {
658  if (a->n == 0) {
659  return ast_strdup("0");
660  }
661  } else if (a->n == (21 - numbermatch)) {
662  if (a->pos == 3 && !strncasecmp(argv3, "off", strlen(argv3))) {
663  return ast_strdup("off");
664  } else if (a->pos == 3 && !strncasecmp(argv3, "atleast", strlen(argv3))) {
665  return ast_strdup("atleast");
666  }
667  } else if (a->n == (22 - numbermatch) && a->pos == 3 && ast_strlen_zero(argv3)) {
668  return ast_strdup("atleast");
669  }
670  } else if ((a->pos == 4 && !atleast && strcasecmp(argv3, "off") && strcasecmp(argv3, "channel"))
671  || (a->pos == 5 && atleast)) {
672  return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, AST_MODULE_HELPER_RUNNING);
673  }
674  return NULL;
675  }
676  /* all the above return, so we proceed with the handler.
677  * we are guaranteed to be called with argc >= e->args;
678  */
679 
680  return handle_debug_or_trace(TRACE_HANDLER, e, cmd, a);
681 }
682 
683 static char *handle_verbose(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
684 {
685  int oldval;
686  int newlevel;
687  int atleast = 0;
688  int silent = 0;
689  const char *argv3 = a->argv ? S_OR(a->argv[3], "") : "";
690 
691  switch (cmd) {
692  case CLI_INIT:
693  e->command = "core set verbose";
694  e->usage =
695  "Usage: core set verbose [atleast] <level> [silent]\n"
696  " core set verbose off\n"
697  "\n"
698  " Sets level of verbose messages to be displayed.\n"
699  " 0 or off means no verbose messages should be displayed.\n"
700  " The silent option means the command does not report what\n"
701  " happened to the verbose level.\n"
702  " Equivalent to -v[v[...]] on startup\n";
703  return NULL;
704 
705  case CLI_GENERATE:
706  if (!strcasecmp(argv3, "atleast")) {
707  atleast = 1;
708  }
709  if (a->pos == 3 || (a->pos == 4 && atleast)) {
710  const char *pos = a->pos == 3 ? argv3 : S_OR(a->argv[4], "");
711  int numbermatch = (ast_strlen_zero(pos) || strchr("123456789", pos[0])) ? 0 : 21;
712 
713  if (a->n < 21 && numbermatch == 0) {
714  return complete_number(pos, 0, 0x7fffffff, a->n);
715  } else if (pos[0] == '0') {
716  if (a->n == 0) {
717  return ast_strdup("0");
718  }
719  } else if (a->n == (21 - numbermatch)) {
720  if (a->pos == 3 && !strncasecmp(argv3, "off", strlen(argv3))) {
721  return ast_strdup("off");
722  } else if (a->pos == 3 && !strncasecmp(argv3, "atleast", strlen(argv3))) {
723  return ast_strdup("atleast");
724  }
725  } else if (a->n == (22 - numbermatch) && a->pos == 3 && ast_strlen_zero(argv3)) {
726  return ast_strdup("atleast");
727  }
728  } else if ((a->pos == 4 && !atleast && strcasecmp(argv3, "off"))
729  || (a->pos == 5 && atleast)) {
730  const char *pos = S_OR(a->argv[a->pos], "");
731 
732  if (a->n == 0 && !strncasecmp(pos, "silent", strlen(pos))) {
733  return ast_strdup("silent");
734  }
735  }
736  return NULL;
737  }
738  /* all the above return, so we proceed with the handler.
739  * we are guaranteed to be called with argc >= e->args;
740  */
741 
742  if (a->argc <= e->args) {
743  return CLI_SHOWUSAGE;
744  }
745 
746  if (a->argc == e->args + 1 && !strcasecmp(a->argv[e->args], "off")) {
747  newlevel = 0;
748  } else {
749  if (!strcasecmp(a->argv[e->args], "atleast")) {
750  atleast = 1;
751  }
752  if (a->argc == e->args + atleast + 2
753  && !strcasecmp(a->argv[e->args + atleast + 1], "silent")) {
754  silent = 1;
755  }
756  if (a->argc != e->args + atleast + silent + 1) {
757  return CLI_SHOWUSAGE;
758  }
759  if (sscanf(a->argv[e->args + atleast], "%30d", &newlevel) != 1) {
760  return CLI_SHOWUSAGE;
761  }
762  }
763 
764  /* Update verbose level */
765  oldval = ast_verb_console_get();
766  if (!atleast || newlevel > oldval) {
767  ast_verb_console_set(newlevel);
768  } else {
769  newlevel = oldval;
770  }
771 
772  if (silent) {
773  /* Be silent after setting the level. */
774  return CLI_SUCCESS;
775  }
776 
777  /* Report verbose level status */
778  status_debug_verbose(a, VERBOSE_HANDLER, oldval, newlevel);
779 
780  return CLI_SUCCESS;
781 }
782 
783 static char *handle_logger_mute(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
784 {
785  switch (cmd) {
786  case CLI_INIT:
787  e->command = "logger mute";
788  e->usage =
789  "Usage: logger mute\n"
790  " Disables logging output to the current console, making it possible to\n"
791  " gather information without being disturbed by scrolling lines.\n";
792  return NULL;
793  case CLI_GENERATE:
794  return NULL;
795  }
796 
797  if (a->argc < 2 || a->argc > 3)
798  return CLI_SHOWUSAGE;
799 
800  if (a->argc == 3 && !strcasecmp(a->argv[2], "silent"))
801  ast_console_toggle_mute(a->fd, 1);
802  else
803  ast_console_toggle_mute(a->fd, 0);
804 
805  return CLI_SUCCESS;
806 }
807 
808 static char *handle_refresh(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
809 {
810  static const char * const completions[] = { "recursively", NULL };
811  int res;
812  /* "module refresh <mod>" */
813  switch (cmd) {
814  case CLI_INIT:
815  e->command = "module refresh";
816  e->usage =
817  "Usage: module refresh <module name> [recursively]\n"
818  " Unloads and loads the specified module into Asterisk.\n"
819  " 'recursively' will attempt to unload any modules with\n"
820  " dependencies on this module for you and load them again\n"
821  " afterwards.\n";
822  return NULL;
823 
824  case CLI_GENERATE:
825  if (a->pos == e->args) {
826  return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, AST_MODULE_HELPER_UNLOAD);
827  } else if (a->pos == e->args + 1) {
828  return ast_cli_complete(a->word, completions, a->n);
829  }
830  return NULL;
831  }
832  if (a->argc < 3 || a->argc > 4) {
833  return CLI_SHOWUSAGE;
834  }
835 
836  res = ast_refresh_resource(a->argv[e->args], AST_FORCE_SOFT, a->argc == 4 && !strcasecmp(a->argv[3], "recursively"));
837  if (res) {
838  ast_cli(a->fd, "Unable to %s resource %s\n", res > 0 ? "unload" : "load", a->argv[e->args]);
839  return CLI_FAILURE;
840  }
841  ast_cli(a->fd, "Unloaded and loaded %s\n", a->argv[e->args]);
842  return CLI_SUCCESS;
843 }
844 
845 static char *handle_unload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
846 {
847  /* "module unload mod_1 [mod_2 .. mod_N]" */
848  int x;
849  int force = AST_FORCE_SOFT;
850  const char *s;
851 
852  switch (cmd) {
853  case CLI_INIT:
854  e->command = "module unload";
855  e->usage =
856  "Usage: module unload [-f|-h] <module_1> [<module_2> ... ]\n"
857  " Unloads the specified module from Asterisk. The -f\n"
858  " option causes the module to be unloaded even if it is\n"
859  " in use (may cause a crash) and the -h module causes the\n"
860  " module to be unloaded even if the module says it cannot, \n"
861  " which almost always will cause a crash.\n";
862  return NULL;
863 
864  case CLI_GENERATE:
865  return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, AST_MODULE_HELPER_UNLOAD);
866  }
867  if (a->argc < e->args + 1)
868  return CLI_SHOWUSAGE;
869  x = e->args; /* first argument */
870  s = a->argv[x];
871  if (s[0] == '-') {
872  if (s[1] == 'f')
873  force = AST_FORCE_FIRM;
874  else if (s[1] == 'h')
875  force = AST_FORCE_HARD;
876  else
877  return CLI_SHOWUSAGE;
878  if (a->argc < e->args + 2) /* need at least one module name */
879  return CLI_SHOWUSAGE;
880  x++; /* skip this argument */
881  }
882 
883  for (; x < a->argc; x++) {
884  if (ast_unload_resource(a->argv[x], force)) {
885  ast_cli(a->fd, "Unable to unload resource %s\n", a->argv[x]);
886  return CLI_FAILURE;
887  }
888  ast_cli(a->fd, "Unloaded %s\n", a->argv[x]);
889  }
890 
891  return CLI_SUCCESS;
892 }
893 
894 #define MODLIST_FORMAT "%-30s %-40.40s %-10d %-11s %13s\n"
895 #define MODLIST_FORMAT2 "%-30s %-40.40s %-10s %-11s %13s\n"
896 
897 AST_MUTEX_DEFINE_STATIC(climodentrylock);
898 static int climodentryfd = -1;
899 
900 static int modlist_modentry(const char *module, const char *description,
901  int usecnt, const char *status, const char *like,
902  enum ast_module_support_level support_level)
903 {
904  /* Comparing the like with the module */
905  if (strcasestr(module, like) ) {
906  ast_cli(climodentryfd, MODLIST_FORMAT, module, description, usecnt,
907  status, ast_module_support_level_to_string(support_level));
908  return 1;
909  }
910  return 0;
911 }
912 
913 static void print_uptimestr(int fd, struct timeval timeval, const char *prefix, int printsec)
914 {
915  int x; /* the main part - years, weeks, etc. */
916  struct ast_str *out;
917 
918 #define SECOND (1)
919 #define MINUTE (SECOND*60)
920 #define HOUR (MINUTE*60)
921 #define DAY (HOUR*24)
922 #define WEEK (DAY*7)
923 #define YEAR (DAY*365)
924 #define NEEDCOMMA(x) ((x) ? ", " : "") /* define if we need a comma */
925  if (timeval.tv_sec < 0) /* invalid, nothing to show */
926  return;
927 
928  if (printsec) { /* plain seconds output */
929  ast_cli(fd, "%s%lu\n", prefix, (u_long)timeval.tv_sec);
930  return;
931  }
932  out = ast_str_alloca(256);
933  if (timeval.tv_sec > YEAR) {
934  x = (timeval.tv_sec / YEAR);
935  timeval.tv_sec -= (x * YEAR);
936  ast_str_append(&out, 0, "%d year%s%s", x, ESS(x), NEEDCOMMA(timeval.tv_sec));
937  }
938  if (timeval.tv_sec > WEEK) {
939  x = (timeval.tv_sec / WEEK);
940  timeval.tv_sec -= (x * WEEK);
941  ast_str_append(&out, 0, "%d week%s%s", x, ESS(x), NEEDCOMMA(timeval.tv_sec));
942  }
943  if (timeval.tv_sec > DAY) {
944  x = (timeval.tv_sec / DAY);
945  timeval.tv_sec -= (x * DAY);
946  ast_str_append(&out, 0, "%d day%s%s", x, ESS(x), NEEDCOMMA(timeval.tv_sec));
947  }
948  if (timeval.tv_sec > HOUR) {
949  x = (timeval.tv_sec / HOUR);
950  timeval.tv_sec -= (x * HOUR);
951  ast_str_append(&out, 0, "%d hour%s%s", x, ESS(x), NEEDCOMMA(timeval.tv_sec));
952  }
953  if (timeval.tv_sec > MINUTE) {
954  x = (timeval.tv_sec / MINUTE);
955  timeval.tv_sec -= (x * MINUTE);
956  ast_str_append(&out, 0, "%d minute%s%s", x, ESS(x), NEEDCOMMA(timeval.tv_sec));
957  }
958  x = timeval.tv_sec;
959  if (x > 0 || ast_str_strlen(out) == 0) {
960  /* if there is nothing, print 0 seconds */
961  ast_str_append(&out, 0, "%d second%s", x, ESS(x));
962  }
963  ast_cli(fd, "%s%s\n", prefix, ast_str_buffer(out));
964 }
965 
966 static struct ast_cli_entry *cli_next(struct ast_cli_entry *e)
967 {
968  if (e) {
969  return AST_LIST_NEXT(e, list);
970  } else {
971  return AST_LIST_FIRST(&helpers);
972  }
973 }
974 
975 static char * handle_showuptime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
976 {
977  struct timeval curtime = ast_tvnow();
978  int printsec;
979 
980  switch (cmd) {
981  case CLI_INIT:
982  e->command = "core show uptime [seconds]";
983  e->usage =
984  "Usage: core show uptime [seconds]\n"
985  " Shows Asterisk uptime information.\n"
986  " The seconds word returns the uptime in seconds only.\n";
987  return NULL;
988 
989  case CLI_GENERATE:
990  return NULL;
991  }
992  /* regular handler */
993  if (a->argc == e->args && !strcasecmp(a->argv[e->args-1],"seconds"))
994  printsec = 1;
995  else if (a->argc == e->args-1)
996  printsec = 0;
997  else
998  return CLI_SHOWUSAGE;
999  if (ast_startuptime.tv_sec) {
1000  print_uptimestr(a->fd, ast_tvsub(curtime, ast_startuptime), "System uptime: ", printsec);
1001  }
1002  if (ast_lastreloadtime.tv_sec) {
1003  print_uptimestr(a->fd, ast_tvsub(curtime, ast_lastreloadtime), "Last reload: ", printsec);
1004  }
1005  return CLI_SUCCESS;
1006 }
1007 
1008 static char *handle_modlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1009 {
1010  const char *like;
1011 
1012  switch (cmd) {
1013  case CLI_INIT:
1014  e->command = "module show [like]";
1015  e->usage =
1016  "Usage: module show [like keyword]\n"
1017  " Shows Asterisk modules currently in use, and usage statistics.\n";
1018  return NULL;
1019 
1020  case CLI_GENERATE:
1021  if (a->pos == e->args) {
1022  return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, AST_MODULE_HELPER_LOADED);
1023  } else {
1024  return NULL;
1025  }
1026  }
1027  /* all the above return, so we proceed with the handler.
1028  * we are guaranteed to have argc >= e->args
1029  */
1030  if (a->argc == e->args - 1)
1031  like = "";
1032  else if (a->argc == e->args + 1 && !strcasecmp(a->argv[e->args-1], "like") )
1033  like = a->argv[e->args];
1034  else
1035  return CLI_SHOWUSAGE;
1036 
1037  ast_mutex_lock(&climodentrylock);
1038  climodentryfd = a->fd; /* global, protected by climodentrylock */
1039  ast_cli(a->fd, MODLIST_FORMAT2, "Module", "Description", "Use Count", "Status", "Support Level");
1040  ast_cli(a->fd,"%d modules loaded\n", ast_update_module_list(modlist_modentry, like));
1041  climodentryfd = -1;
1042  ast_mutex_unlock(&climodentrylock);
1043  return CLI_SUCCESS;
1044 }
1045 #undef MODLIST_FORMAT
1046 #undef MODLIST_FORMAT2
1047 
1048 static char *handle_showcalls(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1049 {
1050  static const char * const completions[] = { "seconds", NULL };
1051  struct timeval curtime = ast_tvnow();
1052  int showuptime, printsec;
1053 
1054  switch (cmd) {
1055  case CLI_INIT:
1056  e->command = "core show calls [uptime]";
1057  e->usage =
1058  "Usage: core show calls [uptime [seconds]]\n"
1059  " Lists number of currently active calls and total number of calls\n"
1060  " processed through PBX since last restart. If 'uptime' is specified\n"
1061  " the system uptime is also displayed. If 'seconds' is specified in\n"
1062  " addition to 'uptime', the system uptime is displayed in seconds.\n";
1063  return NULL;
1064 
1065  case CLI_GENERATE:
1066  if (a->pos != e->args)
1067  return NULL;
1068  return ast_cli_complete(a->word, completions, a->n);
1069  }
1070 
1071  /* regular handler */
1072  if (a->argc >= e->args && !strcasecmp(a->argv[e->args-1],"uptime")) {
1073  showuptime = 1;
1074 
1075  if (a->argc == e->args+1 && !strcasecmp(a->argv[e->args],"seconds"))
1076  printsec = 1;
1077  else if (a->argc == e->args)
1078  printsec = 0;
1079  else
1080  return CLI_SHOWUSAGE;
1081  } else if (a->argc == e->args-1) {
1082  showuptime = 0;
1083  printsec = 0;
1084  } else
1085  return CLI_SHOWUSAGE;
1086 
1087  if (ast_option_maxcalls) {
1088  ast_cli(a->fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
1090  ((double)ast_active_calls() / (double)ast_option_maxcalls) * 100.0);
1091  } else {
1092  ast_cli(a->fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
1093  }
1094 
1095  ast_cli(a->fd, "%d call%s processed\n", ast_processed_calls(), ESS(ast_processed_calls()));
1096 
1097  if (ast_startuptime.tv_sec && showuptime) {
1098  print_uptimestr(a->fd, ast_tvsub(curtime, ast_startuptime), "System uptime: ", printsec);
1099  }
1100 
1101  return RESULT_SUCCESS;
1102 }
1103 
1104 static char *handle_chanlist(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1105 {
1106 #define FORMAT_STRING "%-64.64s %-32.32s %-7.7s %-30.30s\n"
1107 #define FORMAT_STRING2 "%-64.64s %-32.32s %-7.7s %-30.30s\n"
1108 #define CONCISE_FORMAT_STRING "%s!%s!%s!%d!%s!%s!%s!%s!%s!%s!%d!%s!%s!%s\n"
1109 #define VERBOSE_FORMAT_STRING "%-80.80s %-24.24s %-24.24s %4d %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-11.11s %-20.20s\n"
1110 #define VERBOSE_FORMAT_STRING2 "%-80.80s %-24.24s %-24.24s %-4.4s %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-11.11s %-20.20s\n"
1111 
1112  struct ao2_container *channels;
1113  struct ao2_iterator it_chans;
1114  struct ast_channel_snapshot *cs;
1115  int numchans = 0, concise = 0, verbose = 0, count = 0;
1116 
1117  switch (cmd) {
1118  case CLI_INIT:
1119  e->command = "core show channels [concise|verbose|count]";
1120  e->usage =
1121  "Usage: core show channels [concise|verbose|count]\n"
1122  " Lists currently defined channels and some information about them. If\n"
1123  " 'concise' is specified, the format is abridged and in a more easily\n"
1124  " machine parsable format. If 'verbose' is specified, the output includes\n"
1125  " more and longer fields. If 'count' is specified only the channel and call\n"
1126  " count is output.\n";
1127  return NULL;
1128 
1129  case CLI_GENERATE:
1130  return NULL;
1131  }
1132 
1133  if (a->argc == e->args) {
1134  if (!strcasecmp(a->argv[e->args-1],"concise"))
1135  concise = 1;
1136  else if (!strcasecmp(a->argv[e->args-1],"verbose"))
1137  verbose = 1;
1138  else if (!strcasecmp(a->argv[e->args-1],"count"))
1139  count = 1;
1140  else
1141  return CLI_SHOWUSAGE;
1142  } else if (a->argc != e->args - 1)
1143  return CLI_SHOWUSAGE;
1144 
1145  channels = ast_channel_cache_by_name();
1146 
1147  if (!count) {
1148  if (!concise && !verbose)
1149  ast_cli(a->fd, FORMAT_STRING2, "Channel", "Location", "State", "Application(Data)");
1150  else if (verbose)
1151  ast_cli(a->fd, VERBOSE_FORMAT_STRING2, "Channel", "Context", "Extension", "Priority", "State", "Application", "Data",
1152  "CallerID", "Duration", "Accountcode", "PeerAccount", "BridgeID");
1153  }
1154 
1155  it_chans = ao2_iterator_init(channels, 0);
1156  for (; (cs = ao2_iterator_next(&it_chans)); ao2_ref(cs, -1)) {
1157  char durbuf[16] = "-";
1158 
1159  if (!count) {
1160  if ((concise || verbose) && !ast_tvzero(cs->base->creationtime)) {
1161  int duration = (int)(ast_tvdiff_ms(ast_tvnow(), cs->base->creationtime) / 1000);
1162  if (verbose) {
1163  int durh = duration / 3600;
1164  int durm = (duration % 3600) / 60;
1165  int durs = duration % 60;
1166  snprintf(durbuf, sizeof(durbuf), "%02d:%02d:%02d", durh, durm, durs);
1167  } else {
1168  snprintf(durbuf, sizeof(durbuf), "%d", duration);
1169  }
1170  }
1171  if (concise) {
1172  ast_cli(a->fd, CONCISE_FORMAT_STRING, cs->base->name, cs->dialplan->context, cs->dialplan->exten, cs->dialplan->priority, ast_state2str(cs->state),
1173  S_OR(cs->dialplan->appl, "(None)"),
1174  cs->dialplan->data,
1175  cs->caller->number,
1176  cs->base->accountcode,
1177  cs->peer->account,
1178  cs->amaflags,
1179  durbuf,
1180  cs->bridge->id,
1181  cs->base->uniqueid);
1182  } else if (verbose) {
1183  ast_cli(a->fd, VERBOSE_FORMAT_STRING, cs->base->name, cs->dialplan->context, cs->dialplan->exten, cs->dialplan->priority, ast_state2str(cs->state),
1184  S_OR(cs->dialplan->appl, "(None)"),
1185  S_OR(cs->dialplan->data, "(Empty)"),
1186  cs->caller->number,
1187  durbuf,
1188  cs->base->accountcode,
1189  cs->peer->account,
1190  cs->bridge->id);
1191  } else {
1192  char locbuf[40] = "(None)";
1193  char appdata[40] = "(None)";
1194 
1195  if (!ast_strlen_zero(cs->dialplan->context) && !ast_strlen_zero(cs->dialplan->exten)) {
1196  snprintf(locbuf, sizeof(locbuf), "%s@%s:%d", cs->dialplan->exten, cs->dialplan->context, cs->dialplan->priority);
1197  }
1198  if (!ast_strlen_zero(cs->dialplan->appl)) {
1199  snprintf(appdata, sizeof(appdata), "%s(%s)", cs->dialplan->appl, S_OR(cs->dialplan->data, ""));
1200  }
1201  ast_cli(a->fd, FORMAT_STRING, cs->base->name, locbuf, ast_state2str(cs->state), appdata);
1202  }
1203  }
1204  }
1205  ao2_iterator_destroy(&it_chans);
1206 
1207  if (!concise) {
1208  numchans = ast_active_channels();
1209  ast_cli(a->fd, "%d active channel%s\n", numchans, ESS(numchans));
1210  if (ast_option_maxcalls)
1211  ast_cli(a->fd, "%d of %d max active call%s (%5.2f%% of capacity)\n",
1213  ((double)ast_active_calls() / (double)ast_option_maxcalls) * 100.0);
1214  else
1215  ast_cli(a->fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls()));
1216 
1217  ast_cli(a->fd, "%d call%s processed\n", ast_processed_calls(), ESS(ast_processed_calls()));
1218  }
1219  ao2_ref(channels, -1);
1220 
1221  return CLI_SUCCESS;
1222 
1223 #undef FORMAT_STRING
1224 #undef FORMAT_STRING2
1225 #undef CONCISE_FORMAT_STRING
1226 #undef VERBOSE_FORMAT_STRING
1227 #undef VERBOSE_FORMAT_STRING2
1228 }
1229 
1230 static char *handle_softhangup(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1231 {
1232  struct ast_channel *c = NULL;
1233  static const char * const completions[] = { "all", NULL };
1234  char *complete;
1235 
1236  switch (cmd) {
1237  case CLI_INIT:
1238  e->command = "channel request hangup";
1239  e->usage =
1240  "Usage: channel request hangup <channel>|<all>\n"
1241  " Request that a channel be hung up. The hangup takes effect\n"
1242  " the next time the driver reads or writes from the channel.\n"
1243  " If 'all' is specified instead of a channel name, all channels\n"
1244  " will see the hangup request.\n";
1245  return NULL;
1246  case CLI_GENERATE:
1247  if (a->pos != e->args) {
1248  return NULL;
1249  }
1250  complete = ast_cli_complete(a->word, completions, a->n);
1251  if (!complete) {
1252  complete = ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
1253  }
1254  return complete;
1255  }
1256 
1257  if (a->argc != 4) {
1258  return CLI_SHOWUSAGE;
1259  }
1260 
1261  if (!strcasecmp(a->argv[3], "all")) {
1262  struct ast_channel_iterator *iter = NULL;
1263  if (!(iter = ast_channel_iterator_all_new())) {
1264  return CLI_FAILURE;
1265  }
1266  for (; iter && (c = ast_channel_iterator_next(iter)); ast_channel_unref(c)) {
1267  ast_channel_lock(c);
1268  ast_cli(a->fd, "Requested Hangup on channel '%s'\n", ast_channel_name(c));
1270  ast_channel_unlock(c);
1271  }
1273  } else if ((c = ast_channel_get_by_name(a->argv[3]))) {
1274  ast_channel_lock(c);
1275  ast_cli(a->fd, "Requested Hangup on channel '%s'\n", ast_channel_name(c));
1277  ast_channel_unlock(c);
1278  c = ast_channel_unref(c);
1279  } else {
1280  ast_cli(a->fd, "%s is not a known channel\n", a->argv[3]);
1281  }
1282 
1283  return CLI_SUCCESS;
1284 }
1285 
1286 /*! \brief handles CLI command 'cli show permissions' */
1287 static char *handle_cli_show_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1288 {
1289  struct usergroup_cli_perm *cp;
1290  struct cli_perm *perm;
1291  struct passwd *pw = NULL;
1292  struct group *gr = NULL;
1293 
1294  switch (cmd) {
1295  case CLI_INIT:
1296  e->command = "cli show permissions";
1297  e->usage =
1298  "Usage: cli show permissions\n"
1299  " Shows CLI configured permissions.\n";
1300  return NULL;
1301  case CLI_GENERATE:
1302  return NULL;
1303  }
1304 
1306  AST_LIST_TRAVERSE(&cli_perms, cp, list) {
1307  if (cp->uid >= 0) {
1308  pw = getpwuid(cp->uid);
1309  if (pw) {
1310  ast_cli(a->fd, "user: %s [uid=%d]\n", pw->pw_name, cp->uid);
1311  }
1312  } else {
1313  gr = getgrgid(cp->gid);
1314  if (gr) {
1315  ast_cli(a->fd, "group: %s [gid=%d]\n", gr->gr_name, cp->gid);
1316  }
1317  }
1318  ast_cli(a->fd, "Permissions:\n");
1319  if (cp->perms) {
1320  AST_LIST_TRAVERSE(cp->perms, perm, list) {
1321  ast_cli(a->fd, "\t%s -> %s\n", perm->permit ? "permit" : "deny", perm->command);
1322  }
1323  }
1324  ast_cli(a->fd, "\n");
1325  }
1327 
1328  return CLI_SUCCESS;
1329 }
1330 
1331 /*! \brief handles CLI command 'cli reload permissions' */
1332 static char *handle_cli_reload_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1333 {
1334  switch (cmd) {
1335  case CLI_INIT:
1336  e->command = "cli reload permissions";
1337  e->usage =
1338  "Usage: cli reload permissions\n"
1339  " Reload the 'cli_permissions.conf' file.\n";
1340  return NULL;
1341  case CLI_GENERATE:
1342  return NULL;
1343  }
1344 
1345  ast_cli_perms_init(1);
1346 
1347  return CLI_SUCCESS;
1348 }
1349 
1350 /*! \brief handles CLI command 'cli check permissions' */
1351 static char *handle_cli_check_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1352 {
1353  struct passwd *pw = NULL;
1354  struct group *gr;
1355  int gid = -1, uid = -1;
1356  char command[AST_MAX_ARGS] = "";
1357  struct ast_cli_entry *ce = NULL;
1358  int found = 0;
1359  char *group, *tmp;
1360 
1361  switch (cmd) {
1362  case CLI_INIT:
1363  e->command = "cli check permissions";
1364  e->usage =
1365  "Usage: cli check permissions {<username>|@<groupname>|<username>@<groupname>} [<command>]\n"
1366  " Check permissions config for a user@group or list the allowed commands for the specified user.\n"
1367  " The username or the groupname may be omitted.\n";
1368  return NULL;
1369  case CLI_GENERATE:
1370  if (a->pos >= 4) {
1371  return ast_cli_generator(a->line + strlen("cli check permissions") + strlen(a->argv[3]) + 1, a->word, a->n);
1372  }
1373  return NULL;
1374  }
1375 
1376  if (a->argc < 4) {
1377  return CLI_SHOWUSAGE;
1378  }
1379 
1380  tmp = ast_strdupa(a->argv[3]);
1381  group = strchr(tmp, '@');
1382  if (group) {
1383  gr = getgrnam(&group[1]);
1384  if (!gr) {
1385  ast_cli(a->fd, "Unknown group '%s'\n", &group[1]);
1386  return CLI_FAILURE;
1387  }
1388  group[0] = '\0';
1389  gid = gr->gr_gid;
1390  }
1391 
1392  if (!group && ast_strlen_zero(tmp)) {
1393  ast_cli(a->fd, "You didn't supply a username\n");
1394  } else if (!ast_strlen_zero(tmp) && !(pw = getpwnam(tmp))) {
1395  ast_cli(a->fd, "Unknown user '%s'\n", tmp);
1396  return CLI_FAILURE;
1397  } else if (pw) {
1398  uid = pw->pw_uid;
1399  }
1400 
1401  if (a->argc == 4) {
1402  while ((ce = cli_next(ce))) {
1403  /* Hide commands that start with '_' */
1404  if (ce->_full_cmd[0] == '_') {
1405  continue;
1406  }
1407  if (cli_has_permissions(uid, gid, ce->_full_cmd)) {
1408  ast_cli(a->fd, "%30.30s %s\n", ce->_full_cmd, S_OR(ce->summary, "<no description available>"));
1409  found++;
1410  }
1411  }
1412  if (!found) {
1413  ast_cli(a->fd, "You are not allowed to run any command on Asterisk\n");
1414  }
1415  } else {
1416  ast_join(command, sizeof(command), a->argv + 4);
1417  ast_cli(a->fd, "%s '%s%s%s' is %s to run command: '%s'\n", uid >= 0 ? "User" : "Group", tmp,
1418  group && uid >= 0 ? "@" : "",
1419  group ? &group[1] : "",
1420  cli_has_permissions(uid, gid, command) ? "allowed" : "not allowed", command);
1421  }
1422 
1423  return CLI_SUCCESS;
1424 }
1425 
1426 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock);
1427 
1428 static char *handle_commandmatchesarray(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1429 {
1430  char *buf, *obuf;
1431  int buflen = 2048;
1432  int len = 0;
1433  char **matches;
1434  int x, matchlen;
1435 
1436  switch (cmd) {
1437  case CLI_INIT:
1438  e->command = "_command matchesarray";
1439  e->usage =
1440  "Usage: _command matchesarray \"<line>\" text \n"
1441  " This function is used internally to help with command completion and should.\n"
1442  " never be called by the user directly.\n";
1443  return NULL;
1444  case CLI_GENERATE:
1445  return NULL;
1446  }
1447 
1448  if (a->argc != 4)
1449  return CLI_SHOWUSAGE;
1450  if (!(buf = ast_malloc(buflen)))
1451  return CLI_FAILURE;
1452  buf[len] = '\0';
1453  matches = ast_cli_completion_matches(a->argv[2], a->argv[3]);
1454  if (matches) {
1455  for (x=0; matches[x]; x++) {
1456  matchlen = strlen(matches[x]) + 1;
1457  if (len + matchlen >= buflen) {
1458  buflen += matchlen * 3;
1459  obuf = buf;
1460  if (!(buf = ast_realloc(obuf, buflen)))
1461  /* Memory allocation failure... Just free old buffer and be done */
1462  ast_free(obuf);
1463  }
1464  if (buf)
1465  len += sprintf( buf + len, "%s ", matches[x]);
1466  ast_free(matches[x]);
1467  matches[x] = NULL;
1468  }
1469  ast_free(matches);
1470  }
1471 
1472  if (buf) {
1473  ast_cli(a->fd, "%s%s",buf, AST_CLI_COMPLETE_EOF);
1474  ast_free(buf);
1475  } else
1476  ast_cli(a->fd, "NULL\n");
1477 
1478  return CLI_SUCCESS;
1479 }
1480 
1481 
1483  int fd;
1484  int is_off;
1485 };
1486 
1487 static int channel_set_debug(void *obj, void *arg, void *data, int flags)
1488 {
1489  struct ast_channel *chan = obj;
1490  struct channel_set_debug_args *args = data;
1491 
1492  ast_channel_lock(chan);
1493 
1494  if (!(ast_channel_fin(chan) & DEBUGCHAN_FLAG) || !(ast_channel_fout(chan) & DEBUGCHAN_FLAG)) {
1495  if (args->is_off) {
1496  ast_channel_fin_set(chan, ast_channel_fin(chan) & ~DEBUGCHAN_FLAG);
1497  ast_channel_fout_set(chan, ast_channel_fout(chan) & ~DEBUGCHAN_FLAG);
1498  } else {
1499  ast_channel_fin_set(chan, ast_channel_fin(chan) | DEBUGCHAN_FLAG);
1500  ast_channel_fout_set(chan, ast_channel_fout(chan) | DEBUGCHAN_FLAG);
1501  }
1502  ast_cli(args->fd, "Debugging %s on channel %s\n", args->is_off ? "disabled" : "enabled",
1503  ast_channel_name(chan));
1504  }
1505 
1506  ast_channel_unlock(chan);
1507 
1508  return 0;
1509 }
1510 
1511 static char *handle_core_set_debug_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1512 {
1513  struct ast_channel *c = NULL;
1514  static const char * const completions_all[] = { "all", NULL };
1515  static const char * const completions_off[] = { "off", NULL };
1516  struct channel_set_debug_args args = {
1517  .fd = a->fd,
1518  };
1519 
1520  switch (cmd) {
1521  case CLI_INIT:
1522  e->command = "core set debug channel";
1523  e->usage =
1524  "Usage: core set debug channel <all|channel> [off]\n"
1525  " Enables/disables debugging on all or on a specific channel.\n";
1526  return NULL;
1527  case CLI_GENERATE:
1528  if (a->pos == 4) {
1529  char *complete = ast_cli_complete(a->word, completions_all, a->n);
1530  if (!complete) {
1531  complete = ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
1532  }
1533  return complete;
1534  } else if (a->pos == 5) {
1535  return ast_cli_complete(a->word, completions_off, a->n);
1536  }
1537 
1538  return NULL;
1539  }
1540 
1541  if (cmd == (CLI_HANDLER + 1000)) {
1542  /* called from handle_nodebugchan_deprecated */
1543  args.is_off = 1;
1544  } else if (a->argc == e->args + 2) {
1545  /* 'core set debug channel {all|chan_id}' */
1546  if (!strcasecmp(a->argv[e->args + 1], "off"))
1547  args.is_off = 1;
1548  else
1549  return CLI_SHOWUSAGE;
1550  } else if (a->argc != e->args + 1) {
1551  return CLI_SHOWUSAGE;
1552  }
1553 
1554  if (!strcasecmp("all", a->argv[e->args])) {
1555  if (args.is_off) {
1556  global_fin &= ~DEBUGCHAN_FLAG;
1557  global_fout &= ~DEBUGCHAN_FLAG;
1558  } else {
1560  global_fout |= DEBUGCHAN_FLAG;
1561  }
1562  ast_channel_callback(channel_set_debug, NULL, &args, OBJ_NODATA | OBJ_MULTIPLE);
1563  } else {
1564  if ((c = ast_channel_get_by_name(a->argv[e->args]))) {
1565  channel_set_debug(c, NULL, &args, 0);
1566  ast_channel_unref(c);
1567  } else {
1568  ast_cli(a->fd, "No such channel %s\n", a->argv[e->args]);
1569  }
1570  }
1571 
1572  ast_cli(a->fd, "Debugging on new channels is %s\n", args.is_off ? "disabled" : "enabled");
1573 
1574  return CLI_SUCCESS;
1575 }
1576 
1577 static char *handle_debug_category(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1578 {
1579  const char *argv4 = a->argv ? S_OR(a->argv[4], "") : "";
1580  int offset = strncasecmp(argv4, "off", strlen(argv4)) ? 0 : 1;
1581 
1582  switch (cmd) {
1583  case CLI_INIT:
1584  e->command = "core set debug category";
1585  e->usage =
1586  "Usage: core set debug category <category>[:<sublevel>] [category[:<sublevel] ...]\n"
1587  " core set debug category off [<category> [<category>] ...]\n\n"
1588  " Allows enabling and disabling debug logging categories.\n"
1589  " When a category is enabled all relevant debug messages are logged\n"
1590  " for a given category. However, if a sublevel is specified only\n"
1591  " those categorized messages at or below the coded debug sublevel\n"
1592  " are logged.\n";
1593  return NULL;
1594 
1595  case CLI_GENERATE:
1596  if (a->pos < e->args) {
1597  return NULL;
1598  }
1599 
1600  if (a->pos == 4 && offset) {
1602  }
1603 
1604  return ast_debug_category_complete(a->argv + 4,
1605  a->pos - e->args, a->word, a->n - 1);
1606  }
1607 
1608  if (a->argc <= e->args) {
1609  return CLI_SHOWUSAGE;
1610  }
1611 
1612  ast_debug_category_set_sublevels(a->argv + e->args + offset, a->argc - e->args - offset,
1613  offset ? AST_LOG_CATEGORY_DISABLED : AST_LOG_CATEGORY_ENABLED);
1614 
1615  return CLI_SUCCESS;
1616 }
1617 
1618 static char *handle_nodebugchan_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1619 {
1620  char *res;
1621 
1622  switch (cmd) {
1623  case CLI_INIT:
1624  e->command = "no debug channel";
1625  return NULL;
1626  case CLI_HANDLER:
1627  /* exit out of switch statement */
1628  break;
1629  default:
1630  return NULL;
1631  }
1632 
1633  if (a->argc != e->args + 1)
1634  return CLI_SHOWUSAGE;
1635 
1636  /* add a 'magic' value to the CLI_HANDLER command so that
1637  * handle_core_set_debug_channel() will act as if 'off'
1638  * had been specified as part of the command
1639  */
1640  res = handle_core_set_debug_channel(e, CLI_HANDLER + 1000, a);
1641 
1642  return res;
1643 }
1644 
1645 static char *handle_showchan(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1646 {
1647  struct ast_channel *chan;
1648  struct timeval now;
1649  char cdrtime[256];
1650  struct ast_str *obuf;/*!< Buffer for CDR variables. */
1651  struct ast_str *output;/*!< Accumulation buffer for all output. */
1652  long elapsed_seconds=0;
1653  int hour=0, min=0, sec=0;
1654  struct ast_var_t *var;
1655  struct ast_str *write_transpath = ast_str_alloca(256);
1656  struct ast_str *read_transpath = ast_str_alloca(256);
1657  struct ast_str *codec_buf = ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN);
1658  struct ast_bridge *bridge;
1659  ast_callid callid;
1660  char callid_buf[32];
1661  int stream_num;
1662 
1663  switch (cmd) {
1664  case CLI_INIT:
1665  e->command = "core show channel";
1666  e->usage =
1667  "Usage: core show channel <channel>\n"
1668  " Shows lots of information about the specified channel.\n";
1669  return NULL;
1670  case CLI_GENERATE:
1671  return ast_complete_channels(a->line, a->word, a->pos, a->n, 3);
1672  }
1673 
1674  if (a->argc != 4) {
1675  return CLI_SHOWUSAGE;
1676  }
1677 
1678  obuf = ast_str_thread_get(&ast_str_thread_global_buf, 16);
1679  if (!obuf) {
1680  return CLI_FAILURE;
1681  }
1682 
1683  chan = ast_channel_get_by_name(a->argv[3]);
1684  if (!chan) {
1685  ast_cli(a->fd, "%s is not a known channel\n", a->argv[3]);
1686 
1687  return CLI_SUCCESS;
1688  }
1689 
1690  output = ast_str_create(8192);
1691  if (!output) {
1692  ast_channel_unref(chan);
1693 
1694  return CLI_FAILURE;
1695  }
1696 
1697  now = ast_tvnow();
1698  ast_channel_lock(chan);
1699 
1700  if (!ast_tvzero(ast_channel_creationtime(chan))) {
1701  elapsed_seconds = now.tv_sec - ast_channel_creationtime(chan).tv_sec;
1702  hour = elapsed_seconds / 3600;
1703  min = (elapsed_seconds % 3600) / 60;
1704  sec = elapsed_seconds % 60;
1705  snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec);
1706  } else {
1707  strcpy(cdrtime, "N/A");
1708  }
1709 
1710  ast_translate_path_to_str(ast_channel_writetrans(chan), &write_transpath);
1711  ast_translate_path_to_str(ast_channel_readtrans(chan), &read_transpath);
1712 
1713  bridge = ast_channel_get_bridge(chan);
1714  callid_buf[0] = '\0';
1715  callid = ast_channel_callid(chan);
1716  if (callid) {
1717  ast_callid_strnprint(callid_buf, sizeof(callid_buf), callid);
1718  }
1719 
1720  ast_str_append(&output, 0,
1721  " -- General --\n"
1722  " Name: %s\n"
1723  " Type: %s\n"
1724  " UniqueID: %s\n"
1725  " LinkedID: %s\n"
1726  " Caller ID: %s\n"
1727  " Caller ID Name: %s\n"
1728  "Connected Line ID: %s\n"
1729  "Connected Line ID Name: %s\n"
1730  "Eff. Connected Line ID: %s\n"
1731  "Eff. Connected Line ID Name: %s\n"
1732  " DNID Digits: %s\n"
1733  " Language: %s\n"
1734  " State: %s (%u)\n"
1735  " NativeFormats: %s\n"
1736  " WriteFormat: %s\n"
1737  " ReadFormat: %s\n"
1738  " WriteTranscode: %s %s\n"
1739  " ReadTranscode: %s %s\n"
1740  " Time to Hangup: %ld\n"
1741  " Elapsed Time: %s\n"
1742  " Bridge ID: %s\n"
1743  " -- PBX --\n"
1744  " Context: %s\n"
1745  " Extension: %s\n"
1746  " Priority: %d\n"
1747  " Call Group: %llu\n"
1748  " Pickup Group: %llu\n"
1749  " Application: %s\n"
1750  " Data: %s\n"
1751  " Call Identifer: %s\n",
1752  ast_channel_name(chan),
1753  ast_channel_tech(chan)->type,
1754  ast_channel_uniqueid(chan),
1755  ast_channel_linkedid(chan),
1756  S_COR(ast_channel_caller(chan)->id.number.valid,
1757  ast_channel_caller(chan)->id.number.str, "(N/A)"),
1758  S_COR(ast_channel_caller(chan)->id.name.valid,
1759  ast_channel_caller(chan)->id.name.str, "(N/A)"),
1760  S_COR(ast_channel_connected(chan)->id.number.valid,
1761  ast_channel_connected(chan)->id.number.str, "(N/A)"),
1762  S_COR(ast_channel_connected(chan)->id.name.valid,
1763  ast_channel_connected(chan)->id.name.str, "(N/A)"),
1764  S_COR(ast_channel_connected_effective_id(chan).number.valid,
1765  ast_channel_connected_effective_id(chan).number.str, "(N/A)"),
1766  S_COR(ast_channel_connected_effective_id(chan).name.valid,
1767  ast_channel_connected_effective_id(chan).name.str, "(N/A)"),
1768  S_OR(ast_channel_dialed(chan)->number.str, "(N/A)"),
1769  ast_channel_language(chan),
1771  ast_channel_state(chan),
1772  ast_format_cap_get_names(ast_channel_nativeformats(chan), &codec_buf),
1773  ast_format_get_name(ast_channel_writeformat(chan)),
1774  ast_format_get_name(ast_channel_readformat(chan)),
1775  ast_str_strlen(write_transpath) ? "Yes" : "No",
1776  ast_str_buffer(write_transpath),
1777  ast_str_strlen(read_transpath) ? "Yes" : "No",
1778  ast_str_buffer(read_transpath),
1779  (long)ast_channel_whentohangup(chan)->tv_sec,
1780  cdrtime,
1781  bridge ? bridge->uniqueid : "(Not bridged)",
1782  ast_channel_context(chan),
1783  ast_channel_exten(chan),
1784  ast_channel_priority(chan),
1785  ast_channel_callgroup(chan),
1786  ast_channel_pickupgroup(chan),
1787  S_OR(ast_channel_appl(chan), "(N/A)"),
1788  S_OR(ast_channel_data(chan), "(Empty)"),
1789  S_OR(callid_buf, "(None)")
1790  );
1791 
1792  ast_str_append(&output, 0, " Variables:\n");
1793 
1794  AST_LIST_TRAVERSE(ast_channel_varshead(chan), var, entries) {
1795  ast_str_append(&output, 0, "%s=%s\n", ast_var_name(var), ast_var_value(var));
1796  }
1797 
1798  if (!(ast_channel_tech(chan)->properties & AST_CHAN_TP_INTERNAL)
1799  && ast_cdr_serialize_variables(ast_channel_name(chan), &obuf, '=', '\n')) {
1800  ast_str_append(&output, 0, " CDR Variables:\n%s\n", ast_str_buffer(obuf));
1801  }
1802 
1803  ast_str_append(&output, 0, " -- Streams --\n");
1804  for (stream_num = 0; stream_num < ast_stream_topology_get_count(ast_channel_get_stream_topology(chan)); stream_num++) {
1806  struct ast_variable *metadata = ast_stream_get_metadata_list(stream);
1807 
1808  ast_str_append(&output, 0,
1809  "Name: %s\n"
1810  " Type: %s\n"
1811  " State: %s\n"
1812  " Group: %d\n"
1813  " Formats: %s\n"
1814  " Metadata:\n",
1815  ast_stream_get_name(stream),
1818  ast_stream_get_group(stream),
1820  );
1821 
1822  if (metadata) {
1823  struct ast_variable *v;
1824  for(v = metadata; v; v = v->next) {
1825  ast_str_append(&output, 0, " %s: %s\n", v->name, v->value);
1826  }
1827  ast_variables_destroy(metadata);
1828  }
1829  }
1830 
1831  ast_channel_unlock(chan);
1832 
1833  ast_cli(a->fd, "%s", ast_str_buffer(output));
1834  ast_free(output);
1835 
1836  ao2_cleanup(bridge);
1837  ast_channel_unref(chan);
1838 
1839  return CLI_SUCCESS;
1840 }
1841 
1842 /*
1843  * helper function to generate CLI matches from a fixed set of values.
1844  * A NULL word is acceptable.
1845  */
1846 char *ast_cli_complete(const char *word, const char * const choices[], int state)
1847 {
1848  int i, which = 0, len;
1849  len = ast_strlen_zero(word) ? 0 : strlen(word);
1850 
1851  for (i = 0; choices[i]; i++) {
1852  if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state) {
1853  if (state != -1) {
1854  return ast_strdup(choices[i]);
1855  }
1856 
1857  if (ast_cli_completion_add(ast_strdup(choices[i]))) {
1858  return NULL;
1859  }
1860  }
1861  }
1862  return NULL;
1863 }
1864 
1865 char *ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
1866 {
1867  int wordlen = strlen(word), which = 0;
1868  struct ao2_container *cached_channels;
1869  char *ret = NULL;
1870  struct ao2_iterator iter;
1871  struct ast_channel_snapshot *snapshot;
1872 
1873  if (pos != rpos) {
1874  return NULL;
1875  }
1876 
1877  cached_channels = ast_channel_cache_all();
1878 
1879  iter = ao2_iterator_init(cached_channels, 0);
1880  for (; (snapshot = ao2_iterator_next(&iter)); ao2_ref(snapshot, -1)) {
1881  if (!strncasecmp(word, snapshot->base->name, wordlen) && (++which > state)) {
1882  if (state != -1) {
1883  ret = ast_strdup(snapshot->base->name);
1884  ao2_ref(snapshot, -1);
1885  break;
1886  }
1887 
1888  if (ast_cli_completion_add(ast_strdup(snapshot->base->name))) {
1889  ao2_ref(snapshot, -1);
1890  break;
1891  }
1892  }
1893  }
1894  ao2_iterator_destroy(&iter);
1895  ao2_ref(cached_channels, -1);
1896 
1897  return ret;
1898 }
1899 
1900 static char *group_show_channels(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1901 {
1902 #define FORMAT_STRING "%-25s %-20s %-20s\n"
1903 
1904  struct ast_group_info *gi = NULL;
1905  int numchans = 0;
1906  regex_t regexbuf;
1907  int havepattern = 0;
1908 
1909  switch (cmd) {
1910  case CLI_INIT:
1911  e->command = "group show channels";
1912  e->usage =
1913  "Usage: group show channels [pattern]\n"
1914  " Lists all currently active channels with channel group(s) specified.\n"
1915  " Optional regular expression pattern is matched to group names for each\n"
1916  " channel.\n";
1917  return NULL;
1918  case CLI_GENERATE:
1919  return NULL;
1920  }
1921 
1922  if (a->argc < 3 || a->argc > 4)
1923  return CLI_SHOWUSAGE;
1924 
1925  if (a->argc == 4) {
1926  if (regcomp(&regexbuf, a->argv[3], REG_EXTENDED | REG_NOSUB))
1927  return CLI_SHOWUSAGE;
1928  havepattern = 1;
1929  }
1930 
1931  ast_cli(a->fd, FORMAT_STRING, "Channel", "Group", "Category");
1932 
1934 
1935  gi = ast_app_group_list_head();
1936  while (gi) {
1937  if (!havepattern || !regexec(&regexbuf, gi->group, 0, NULL, 0)) {
1938  ast_cli(a->fd, FORMAT_STRING, ast_channel_name(gi->chan), gi->group, (ast_strlen_zero(gi->category) ? "(default)" : gi->category));
1939  numchans++;
1940  }
1941  gi = AST_LIST_NEXT(gi, group_list);
1942  }
1943 
1945 
1946  if (havepattern)
1947  regfree(&regexbuf);
1948 
1949  ast_cli(a->fd, "%d active channel%s\n", numchans, ESS(numchans));
1950  return CLI_SUCCESS;
1951 #undef FORMAT_STRING
1952 }
1953 
1954 static char *handle_cli_wait_fullybooted(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1955 {
1956  switch (cmd) {
1957  case CLI_INIT:
1958  e->command = "core waitfullybooted";
1959  e->usage =
1960  "Usage: core waitfullybooted\n"
1961  " Wait until Asterisk has fully booted.\n";
1962  return NULL;
1963  case CLI_GENERATE:
1964  return NULL;
1965  }
1966 
1967  while (!ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)) {
1968  usleep(100);
1969  }
1970 
1971  ast_cli(a->fd, "Asterisk has fully booted.\n");
1972 
1973  return CLI_SUCCESS;
1974 }
1975 
1976 
1977 #ifdef HAVE_MALLOC_TRIM
1978 
1979 /*!
1980  * \internal
1981  * \brief Attempt to reclaim unused heap memory.
1982  *
1983  * Users have reported that asterisk will sometimes be killed because it can't allocate
1984  * more than around 3G of memory on a 32 bit system.
1985  *
1986  * Using malloc_trim() will help us to determine if it's because there's a leak or because
1987  * the heap is so fragmented that there isn't enough contiguous memory available.
1988  *
1989  * \note malloc_trim() is a GNU extension and is therefore not portable.
1990  */
1991 static char *handle_cli_malloc_trim(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1992 {
1993  extern int malloc_trim(size_t __pad) __THROW;
1994 
1995  switch (cmd) {
1996  case CLI_INIT:
1997  e->command = "malloc trim";
1998  e->usage =
1999  "Usage: malloc trim\n"
2000  " Try to give excess memory back to the OS.\n";
2001  return NULL;
2002  case CLI_GENERATE:
2003  return NULL;
2004  }
2005 
2006  if (malloc_trim(0)) {
2007  ast_cli(a->fd, "Returned some memory to the OS.\n");
2008  } else {
2009  ast_cli(a->fd, "No memory returned to the OS.\n");
2010  }
2011 
2012  return CLI_SUCCESS;
2013 }
2014 
2015 #endif
2016 
2017 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2018 
2019 static struct ast_cli_entry cli_cli[] = {
2020  AST_CLI_DEFINE(handle_commandmatchesarray, "Returns command matches array"),
2021 
2022  AST_CLI_DEFINE(handle_debug_category, "Enable/disable debugging categories"),
2023 
2024  AST_CLI_DEFINE(handle_debug, "Set level of debug chattiness"),
2025  AST_CLI_DEFINE(handle_trace, "Set level of trace chattiness"),
2026  AST_CLI_DEFINE(handle_verbose, "Set level of verbose chattiness"),
2027 
2028  AST_CLI_DEFINE(handle_help, "Display help list, or specific help on a command"),
2029  AST_CLI_DEFINE(handle_logger_mute, "Toggle logging output to a console"),
2030 
2031  AST_CLI_DEFINE(handle_modlist, "List modules and info"),
2032  AST_CLI_DEFINE(handle_load, "Load a module by name"),
2033  AST_CLI_DEFINE(handle_reload, "Reload configuration for a module"),
2034  AST_CLI_DEFINE(handle_core_reload, "Global reload"),
2035  AST_CLI_DEFINE(handle_unload, "Unload a module by name"),
2036  AST_CLI_DEFINE(handle_refresh, "Completely unloads and loads a module by name"),
2037 
2038  AST_CLI_DEFINE(handle_showuptime, "Show uptime information"),
2039 
2040  AST_CLI_DEFINE(handle_cli_reload_permissions, "Reload CLI permissions config"),
2041  AST_CLI_DEFINE(handle_cli_show_permissions, "Show CLI permissions"),
2042  AST_CLI_DEFINE(handle_cli_check_permissions, "Try a permissions config for a user"),
2043  AST_CLI_DEFINE(handle_cli_wait_fullybooted, "Wait for Asterisk to be fully booted"),
2044 
2045 #ifdef HAVE_MALLOC_TRIM
2046  AST_CLI_DEFINE(handle_cli_malloc_trim, "Return excess memory to the OS"),
2047 #endif
2048 
2049 };
2050 
2051 static struct ast_cli_entry cli_channels_cli[] = {
2052  AST_CLI_DEFINE(handle_nodebugchan_deprecated, "Disable debugging on channel(s)"),
2053  AST_CLI_DEFINE(handle_chanlist, "Display information on channels"),
2054  AST_CLI_DEFINE(handle_showcalls, "Display information on calls"),
2055  AST_CLI_DEFINE(handle_showchan, "Display information on a specific channel"),
2056  AST_CLI_DEFINE(handle_core_set_debug_channel, "Enable/disable debugging on a channel"),
2057  AST_CLI_DEFINE(group_show_channels, "Display active channels with group(s)"),
2058  AST_CLI_DEFINE(handle_softhangup, "Request a hangup on a given channel"),
2059 };
2060 
2061 /*!
2062  * Some regexp characters in cli arguments are reserved and used as separators.
2063  */
2064 static const char cli_rsvd[] = "[]{}|*%";
2065 
2066 /*!
2067  * initialize the _full_cmd string and related parameters,
2068  * return 0 on success, -1 on error.
2069  */
2070 static int set_full_cmd(struct ast_cli_entry *e)
2071 {
2072  int i;
2073  char buf[80];
2074 
2075  ast_join(buf, sizeof(buf), e->cmda);
2076  e->_full_cmd = ast_strdup(buf);
2077  if (!e->_full_cmd) {
2078  ast_log(LOG_WARNING, "-- cannot allocate <%s>\n", buf);
2079  return -1;
2080  }
2081  e->cmdlen = strcspn(e->_full_cmd, cli_rsvd);
2082  for (i = 0; e->cmda[i]; i++)
2083  ;
2084  e->args = i;
2085  return 0;
2086 }
2087 
2088 /*! \brief cleanup (free) cli_perms linkedlist. */
2089 static void destroy_user_perms(void)
2090 {
2091  struct cli_perm *perm;
2092  struct usergroup_cli_perm *user_perm;
2093 
2095  while ((user_perm = AST_LIST_REMOVE_HEAD(&cli_perms, list))) {
2096  while ((perm = AST_LIST_REMOVE_HEAD(user_perm->perms, list))) {
2097  ast_free(perm->command);
2098  ast_free(perm);
2099  }
2100  ast_free(user_perm);
2101  }
2103 }
2104 
2105 int ast_cli_perms_init(int reload)
2106 {
2107  struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
2108  struct ast_config *cfg;
2109  char *cat = NULL;
2110  struct ast_variable *v;
2111  struct usergroup_cli_perm *user_group, *cp_entry;
2112  struct cli_perm *perm = NULL;
2113  struct passwd *pw;
2114  struct group *gr;
2115 
2116  if (ast_mutex_trylock(&permsconfiglock)) {
2117  ast_log(LOG_NOTICE, "You must wait until last 'cli reload permissions' command finish\n");
2118  return 1;
2119  }
2120 
2121  cfg = ast_config_load2(perms_config, "" /* core, can't reload */, config_flags);
2122  if (!cfg) {
2123  ast_mutex_unlock(&permsconfiglock);
2124  return 1;
2125  } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
2126  ast_mutex_unlock(&permsconfiglock);
2127  return 0;
2128  }
2129 
2130  /* free current structures. */
2132 
2133  while ((cat = ast_category_browse(cfg, cat))) {
2134  if (!strcasecmp(cat, "general")) {
2135  /* General options */
2136  for (v = ast_variable_browse(cfg, cat); v; v = v->next) {
2137  if (!strcasecmp(v->name, "default_perm")) {
2138  cli_default_perm = (!strcasecmp(v->value, "permit")) ? 1: 0;
2139  }
2140  }
2141  continue;
2142  }
2143 
2144  /* users or groups */
2145  gr = NULL, pw = NULL;
2146  if (cat[0] == '@') {
2147  /* This is a group */
2148  gr = getgrnam(&cat[1]);
2149  if (!gr) {
2150  ast_log (LOG_WARNING, "Unknown group '%s'\n", &cat[1]);
2151  continue;
2152  }
2153  } else {
2154  /* This is a user */
2155  pw = getpwnam(cat);
2156  if (!pw) {
2157  ast_log (LOG_WARNING, "Unknown user '%s'\n", cat);
2158  continue;
2159  }
2160  }
2161  user_group = NULL;
2162  /* Check for duplicates */
2164  AST_LIST_TRAVERSE(&cli_perms, cp_entry, list) {
2165  if ((pw && cp_entry->uid == pw->pw_uid) || (gr && cp_entry->gid == gr->gr_gid)) {
2166  /* if it is duplicated, just added this new settings, to
2167  the current list. */
2168  user_group = cp_entry;
2169  break;
2170  }
2171  }
2173 
2174  if (!user_group) {
2175  /* alloc space for the new user config. */
2176  user_group = ast_calloc(1, sizeof(*user_group));
2177  if (!user_group) {
2178  continue;
2179  }
2180  user_group->uid = (pw ? pw->pw_uid : -1);
2181  user_group->gid = (gr ? gr->gr_gid : -1);
2182  user_group->perms = ast_calloc(1, sizeof(*user_group->perms));
2183  if (!user_group->perms) {
2184  ast_free(user_group);
2185  continue;
2186  }
2187  }
2188  for (v = ast_variable_browse(cfg, cat); v; v = v->next) {
2189  if (ast_strlen_zero(v->value)) {
2190  /* we need to check this condition cause it could break security. */
2191  ast_log(LOG_WARNING, "Empty permit/deny option in user '%s'\n", cat);
2192  continue;
2193  }
2194  if (!strcasecmp(v->name, "permit")) {
2195  perm = ast_calloc(1, sizeof(*perm));
2196  if (perm) {
2197  perm->permit = 1;
2198  perm->command = ast_strdup(v->value);
2199  }
2200  } else if (!strcasecmp(v->name, "deny")) {
2201  perm = ast_calloc(1, sizeof(*perm));
2202  if (perm) {
2203  perm->permit = 0;
2204  perm->command = ast_strdup(v->value);
2205  }
2206  } else {
2207  /* up to now, only 'permit' and 'deny' are possible values. */
2208  ast_log(LOG_WARNING, "Unknown '%s' option\n", v->name);
2209  continue;
2210  }
2211  if (perm) {
2212  /* Added the permission to the user's list. */
2213  AST_LIST_INSERT_TAIL(user_group->perms, perm, list);
2214  perm = NULL;
2215  }
2216  }
2218  AST_RWLIST_INSERT_TAIL(&cli_perms, user_group, list);
2220  }
2221 
2222  ast_config_destroy(cfg);
2223  ast_mutex_unlock(&permsconfiglock);
2224  return 0;
2225 }
2226 
2227 static void cli_shutdown(void)
2228 {
2229  ast_cli_unregister_multiple(cli_cli, ARRAY_LEN(cli_cli));
2230 }
2231 
2232 static void cli_channels_shutdown(void)
2233 {
2234  ast_cli_unregister_multiple(cli_channels_cli, ARRAY_LEN(cli_channels_cli));
2235 }
2236 
2237 /*! \brief initialize the _full_cmd string in * each of the builtins. */
2239 {
2240  AST_VECTOR_INIT(&shutdown_commands, 0);
2241  ast_cli_register_multiple(cli_cli, ARRAY_LEN(cli_cli));
2242  ast_register_cleanup(cli_shutdown);
2243 }
2244 
2246 {
2247  ast_cli_register_multiple(cli_channels_cli, ARRAY_LEN(cli_channels_cli));
2248  ast_register_cleanup(cli_channels_shutdown);
2249 }
2250 
2251 /*!
2252  * match a word in the CLI entry.
2253  * returns -1 on mismatch, 0 on match of an optional word,
2254  * 1 on match of a full word.
2255  *
2256  * The pattern can be
2257  * any_word match for equal
2258  * [foo|bar|baz] optionally, one of these words
2259  * {foo|bar|baz} exactly, one of these words
2260  * % any word
2261  */
2262 static int word_match(const char *cmd, const char *cli_word)
2263 {
2264  int l;
2265  char *pos;
2266 
2267  if (ast_strlen_zero(cmd) || ast_strlen_zero(cli_word))
2268  return -1;
2269  if (!strchr(cli_rsvd, cli_word[0])) /* normal match */
2270  return (strcasecmp(cmd, cli_word) == 0) ? 1 : -1;
2271  l = strlen(cmd);
2272  /* wildcard match - will extend in the future */
2273  if (l > 0 && cli_word[0] == '%') {
2274  return 1; /* wildcard */
2275  }
2276 
2277  /* Start a search for the command entered against the cli word in question */
2278  pos = strcasestr(cli_word, cmd);
2279  while (pos) {
2280 
2281  /*
2282  *Check if the word matched with is surrounded by reserved characters on both sides
2283  * and isn't at the beginning of the cli_word since that would make it check in a location we shouldn't know about.
2284  * If it is surrounded by reserved chars and isn't at the beginning, it's a match.
2285  */
2286  if (pos != cli_word && strchr(cli_rsvd, pos[-1]) && strchr(cli_rsvd, pos[l])) {
2287  return 1; /* valid match */
2288  }
2289 
2290  /* Ok, that one didn't match, strcasestr to the next appearance of the command and start over.*/
2291  pos = strcasestr(pos + 1, cmd);
2292  }
2293  /* If no matches were found over the course of the while loop, we hit the end of the string. It's a mismatch. */
2294  return -1;
2295 }
2296 
2297 /*! \brief if word is a valid prefix for token, returns the pos-th
2298  * match as a malloced string, or NULL otherwise.
2299  * Always tell in *actual how many matches we got.
2300  */
2301 static char *is_prefix(const char *word, const char *token,
2302  int pos, int *actual)
2303 {
2304  int lw;
2305  char *s, *t1;
2306 
2307  *actual = 0;
2308  if (ast_strlen_zero(token))
2309  return NULL;
2310  if (ast_strlen_zero(word))
2311  word = ""; /* dummy */
2312  lw = strlen(word);
2313  if (strcspn(word, cli_rsvd) != lw)
2314  return NULL; /* no match if word has reserved chars */
2315  if (strchr(cli_rsvd, token[0]) == NULL) { /* regular match */
2316  if (strncasecmp(token, word, lw)) /* no match */
2317  return NULL;
2318  *actual = 1;
2319  return (pos != 0) ? NULL : ast_strdup(token);
2320  }
2321  /* now handle regexp match */
2322 
2323  /* Wildcard always matches, so we never do is_prefix on them */
2324 
2325  t1 = ast_strdupa(token + 1); /* copy, skipping first char */
2326  while (pos >= 0 && (s = strsep(&t1, cli_rsvd)) && *s) {
2327  if (*s == '%') /* wildcard */
2328  continue;
2329  if (strncasecmp(s, word, lw)) /* no match */
2330  continue;
2331  (*actual)++;
2332  if (pos-- == 0)
2333  return ast_strdup(s);
2334  }
2335  return NULL;
2336 }
2337 
2338 /*!
2339  * \internal
2340  * \brief locate a cli command in the 'helpers' list (which must be locked).
2341  * The search compares word by word taking care of regexps in e->cmda
2342  * This function will return NULL when nothing is matched, or the ast_cli_entry that matched.
2343  * \param cmds
2344  * \param match_type has 3 possible values:
2345  * 0 returns if the search key is equal or longer than the entry.
2346  * note that trailing optional arguments are skipped.
2347  * -1 true if the mismatch is on the last word XXX not true!
2348  * 1 true only on complete, exact match.
2349  *
2350  */
2351 static struct ast_cli_entry *find_cli(const char * const cmds[], int match_type)
2352 {
2353  int matchlen = -1; /* length of longest match so far */
2354  struct ast_cli_entry *cand = NULL, *e=NULL;
2355 
2356  while ( (e = cli_next(e)) ) {
2357  /* word-by word regexp comparison */
2358  const char * const *src = cmds;
2359  const char * const *dst = e->cmda;
2360  int n = 0;
2361  for (;; dst++, src += n) {
2362  n = word_match(*src, *dst);
2363  if (n < 0)
2364  break;
2365  }
2366  if (ast_strlen_zero(*dst) || ((*dst)[0] == '[' && ast_strlen_zero(dst[1]))) {
2367  /* no more words in 'e' */
2368  if (ast_strlen_zero(*src)) /* exact match, cannot do better */
2369  break;
2370  /* Here, cmds has more words than the entry 'e' */
2371  if (match_type != 0) /* but we look for almost exact match... */
2372  continue; /* so we skip this one. */
2373  /* otherwise we like it (case 0) */
2374  } else { /* still words in 'e' */
2375  if (ast_strlen_zero(*src))
2376  continue; /* cmds is shorter than 'e', not good */
2377  /* Here we have leftover words in cmds and 'e',
2378  * but there is a mismatch. We only accept this one if match_type == -1
2379  * and this is the last word for both.
2380  */
2381  if (match_type != -1 || !ast_strlen_zero(src[1]) ||
2382  !ast_strlen_zero(dst[1])) /* not the one we look for */
2383  continue;
2384  /* good, we are in case match_type == -1 and mismatch on last word */
2385  }
2386  if (src - cmds > matchlen) { /* remember the candidate */
2387  matchlen = src - cmds;
2388  cand = e;
2389  }
2390  }
2391 
2392  return e ? e : cand;
2393 }
2394 
2395 static char *find_best(const char *argv[])
2396 {
2397  static char cmdline[80];
2398  int x;
2399  /* See how close we get, then print the candidate */
2400  const char *myargv[AST_MAX_CMD_LEN] = { NULL, };
2401 
2403  for (x = 0; argv[x]; x++) {
2404  myargv[x] = argv[x];
2405  if (!find_cli(myargv, -1))
2406  break;
2407  }
2409  ast_join(cmdline, sizeof(cmdline), myargv);
2410  return cmdline;
2411 }
2412 
2413 static int cli_is_registered(struct ast_cli_entry *e)
2414 {
2415  struct ast_cli_entry *cur = NULL;
2416 
2417  while ((cur = cli_next(cur))) {
2418  if (cur == e) {
2419  return 1;
2420  }
2421  }
2422  return 0;
2423 }
2424 
2425 static void remove_shutdown_command(struct ast_cli_entry *e)
2426 {
2427  ast_rwlock_wrlock(&shutdown_commands_lock);
2429  ast_rwlock_unlock(&shutdown_commands_lock);
2430 }
2431 
2433 {
2434  if (e->inuse) {
2435  ast_log(LOG_WARNING, "Can't remove command that is in use\n");
2436  } else {
2438  AST_RWLIST_REMOVE(&helpers, e, list);
2440  remove_shutdown_command(e);
2441  ast_free(e->_full_cmd);
2442  e->_full_cmd = NULL;
2443  if (e->handler) {
2444  /* this is a new-style entry. Reset fields and free memory. */
2445  char *cmda = (char *) e->cmda;
2446  memset(cmda, '\0', sizeof(e->cmda));
2447  ast_free(e->command);
2448  e->command = NULL;
2449  e->usage = NULL;
2450  }
2451  }
2452  return 0;
2453 }
2454 
2455 int __ast_cli_register(struct ast_cli_entry *e, struct ast_module *module)
2456 {
2457  struct ast_cli_entry *cur;
2458  int i, lf, ret = -1;
2459 
2460  struct ast_cli_args a; /* fake argument */
2461  char **dst = (char **)e->cmda; /* need to cast as the entry is readonly */
2462  char *s;
2463 
2465 
2466  if (cli_is_registered(e)) {
2467  ast_log(LOG_WARNING, "Command '%s' already registered (the same ast_cli_entry)\n",
2468  S_OR(e->_full_cmd, e->command));
2469  ret = 0; /* report success */
2470  goto done;
2471  }
2472 
2473  memset(&a, '\0', sizeof(a));
2474 
2475  e->module = module;
2476  /* No module reference needed here, the module called us. */
2477  e->handler(e, CLI_INIT, &a);
2478 
2479  /* XXX check that usage and command are filled up */
2480  s = ast_skip_blanks(e->command);
2481  s = e->command = ast_strdup(s);
2482  for (i=0; !ast_strlen_zero(s) && i < AST_MAX_CMD_LEN-1; i++) {
2483  *dst++ = s; /* store string */
2484  s = ast_skip_nonblanks(s);
2485  if (*s == '\0') /* we are done */
2486  break;
2487  *s++ = '\0';
2488  s = ast_skip_blanks(s);
2489  }
2490  *dst++ = NULL;
2491 
2492  if (find_cli(e->cmda, 1)) {
2493  ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n",
2494  S_OR(e->_full_cmd, e->command));
2495  goto done;
2496  }
2497  if (set_full_cmd(e)) {
2498  ast_log(LOG_WARNING, "Error registering CLI Command '%s'\n",
2499  S_OR(e->_full_cmd, e->command));
2500  goto done;
2501  }
2502 
2503  lf = e->cmdlen;
2504  AST_RWLIST_TRAVERSE_SAFE_BEGIN(&helpers, cur, list) {
2505  int len = cur->cmdlen;
2506  if (lf < len)
2507  len = lf;
2508  if (strncasecmp(e->_full_cmd, cur->_full_cmd, len) < 0) {
2509  AST_RWLIST_INSERT_BEFORE_CURRENT(e, list);
2510  break;
2511  }
2512  }
2513  AST_RWLIST_TRAVERSE_SAFE_END;
2514 
2515  if (!cur)
2516  AST_RWLIST_INSERT_TAIL(&helpers, e, list);
2517  ret = 0; /* success */
2518 
2519 done:
2521  if (ret) {
2522  ast_free(e->command);
2523  e->command = NULL;
2524  }
2525 
2526  return ret;
2527 }
2528 
2529 /*
2530  * register/unregister an array of entries.
2531  */
2532 int __ast_cli_register_multiple(struct ast_cli_entry *e, int len, struct ast_module *module)
2533 {
2534  int i, res = 0;
2535 
2536  for (i = 0; i < len; i++) {
2537  res |= __ast_cli_register(e + i, module);
2538  }
2539 
2540  return res;
2541 }
2542 
2544 {
2545  int i, res = 0;
2546 
2547  for (i = 0; i < len; i++)
2548  res |= ast_cli_unregister(e + i);
2549 
2550  return res;
2551 }
2552 
2553 
2554 /*! \brief helper for final part of handle_help
2555  * if locked = 1, assume the list is already locked
2556  */
2557 static char *help1(int fd, const char * const match[], int locked)
2558 {
2559  char matchstr[80] = "";
2560  struct ast_cli_entry *e = NULL;
2561  int len = 0;
2562  int found = 0;
2563 
2564  if (match) {
2565  ast_join(matchstr, sizeof(matchstr), match);
2566  len = strlen(matchstr);
2567  }
2568  if (!locked)
2570  while ( (e = cli_next(e)) ) {
2571  /* Hide commands that start with '_' */
2572  if (e->_full_cmd[0] == '_')
2573  continue;
2574  if (match && strncasecmp(matchstr, e->_full_cmd, len))
2575  continue;
2576  ast_cli(fd, "%-30s -- %s\n", e->_full_cmd,
2577  S_OR(e->summary, "<no description available>"));
2578  found++;
2579  }
2580  if (!locked)
2582  if (!found && matchstr[0])
2583  ast_cli(fd, "No such command '%s'.\n", matchstr);
2584  return CLI_SUCCESS;
2585 }
2586 
2587 static char *handle_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2588 {
2589  char fullcmd[80];
2590  struct ast_cli_entry *my_e;
2591  char *res = CLI_SUCCESS;
2592 
2593  if (cmd == CLI_INIT) {
2594  e->command = "core show help";
2595  e->usage =
2596  "Usage: core show help [topic]\n"
2597  " When called with a topic as an argument, displays usage\n"
2598  " information on the given command. If called without a\n"
2599  " topic, it provides a list of commands.\n";
2600  return NULL;
2601 
2602  } else if (cmd == CLI_GENERATE) {
2603  /* skip first 14 or 15 chars, "core show help " */
2604  int l = strlen(a->line);
2605 
2606  if (l > 15) {
2607  l = 15;
2608  }
2609  /* XXX watch out, should stop to the non-generator parts */
2610  return __ast_cli_generator(a->line + l, a->word, a->n, 0);
2611  }
2612  if (a->argc == e->args) {
2613  return help1(a->fd, NULL, 0);
2614  }
2615 
2617  my_e = find_cli(a->argv + 3, 1); /* try exact match first */
2618  if (!my_e) {
2619  res = help1(a->fd, a->argv + 3, 1 /* locked */);
2621  return res;
2622  }
2623  if (my_e->usage)
2624  ast_cli(a->fd, "%s", my_e->usage);
2625  else {
2626  ast_join(fullcmd, sizeof(fullcmd), a->argv + 3);
2627  ast_cli(a->fd, "No help text available for '%s'.\n", fullcmd);
2628  }
2630  return res;
2631 }
2632 
2633 static char *parse_args(const char *s, int *argc, const char *argv[], int max, int *trailingwhitespace)
2634 {
2635  char *duplicate, *cur;
2636  int x = 0;
2637  int quoted = 0;
2638  int escaped = 0;
2639  int whitespace = 1;
2640  int dummy = 0;
2641 
2642  if (trailingwhitespace == NULL)
2643  trailingwhitespace = &dummy;
2644  *trailingwhitespace = 0;
2645  if (s == NULL) /* invalid, though! */
2646  return NULL;
2647  /* make a copy to store the parsed string */
2648  if (!(duplicate = ast_strdup(s)))
2649  return NULL;
2650 
2651  cur = duplicate;
2652 
2653  /* Remove leading spaces from the command */
2654  while (isspace(*s)) {
2655  cur++;
2656  s++;
2657  }
2658 
2659  /* scan the original string copying into cur when needed */
2660  for (; *s ; s++) {
2661  if (x >= max - 1) {
2662  ast_log(LOG_WARNING, "Too many arguments, truncating at %s\n", s);
2663  break;
2664  }
2665  if (*s == '"' && !escaped) {
2666  quoted = !quoted;
2667  if (quoted && whitespace) {
2668  /* start a quoted string from previous whitespace: new argument */
2669  argv[x++] = cur;
2670  whitespace = 0;
2671  }
2672  } else if ((*s == ' ' || *s == '\t') && !(quoted || escaped)) {
2673  /* If we are not already in whitespace, and not in a quoted string or
2674  processing an escape sequence, and just entered whitespace, then
2675  finalize the previous argument and remember that we are in whitespace
2676  */
2677  if (!whitespace) {
2678  *cur++ = '\0';
2679  whitespace = 1;
2680  }
2681  } else if (*s == '\\' && !escaped) {
2682  escaped = 1;
2683  } else {
2684  if (whitespace) {
2685  /* we leave whitespace, and are not quoted. So it's a new argument */
2686  argv[x++] = cur;
2687  whitespace = 0;
2688  }
2689  *cur++ = *s;
2690  escaped = 0;
2691  }
2692  }
2693  /* Null terminate */
2694  *cur++ = '\0';
2695  /* XXX put a NULL in the last argument, because some functions that take
2696  * the array may want a null-terminated array.
2697  * argc still reflects the number of non-NULL entries.
2698  */
2699  argv[x] = NULL;
2700  *argc = x;
2701  *trailingwhitespace = whitespace;
2702  return duplicate;
2703 }
2704 
2705 char **ast_cli_completion_matches(const char *text, const char *word)
2706 {
2707  struct ast_vector_string *vec = ast_cli_completion_vector(text, word);
2708  char **match_list;
2709 
2710  if (!vec) {
2711  return NULL;
2712  }
2713 
2714  if (AST_VECTOR_APPEND(vec, NULL)) {
2715  /* We failed to NULL terminate the elements */
2716  AST_VECTOR_CALLBACK_VOID(vec, ast_free);
2717  AST_VECTOR_PTR_FREE(vec);
2718 
2719  return NULL;
2720  }
2721 
2722  match_list = AST_VECTOR_STEAL_ELEMENTS(vec);
2723  AST_VECTOR_PTR_FREE(vec);
2724 
2725  return match_list;
2726 }
2727 
2728 AST_THREADSTORAGE_RAW(completion_storage);
2729 
2730 /*!
2731  * \internal
2732  * \brief Add a value to the vector.
2733  *
2734  * \param vec Vector to add \a value to. Must be from threadstorage.
2735  * \param value The value to add.
2736  *
2737  * \retval 0 Success
2738  * \retval -1 Failure
2739  */
2740 static int cli_completion_vector_add(struct ast_vector_string *vec, char *value)
2741 {
2742  if (!value) {
2743  return 0;
2744  }
2745 
2746  if (!vec || AST_VECTOR_ADD_SORTED(vec, value, strcasecmp)) {
2747  if (vec) {
2748  ast_threadstorage_set_ptr(&completion_storage, NULL);
2749 
2750  AST_VECTOR_CALLBACK_VOID(vec, ast_free);
2751  AST_VECTOR_FREE(vec);
2752  }
2753  ast_free(value);
2754 
2755  return -1;
2756  }
2757 
2758  return 0;
2759 }
2760 
2761 int ast_cli_completion_add(char *value)
2762 {
2763  return cli_completion_vector_add(ast_threadstorage_get_ptr(&completion_storage), value);
2764 }
2765 
2766 struct ast_vector_string *ast_cli_completion_vector(const char *text, const char *word)
2767 {
2768  char *retstr, *prevstr;
2769  size_t max_equal;
2770  size_t which = 0;
2771  struct ast_vector_string *vec = ast_calloc(1, sizeof(*vec));
2772 
2773  /* Recursion into this function is a coding error. */
2774  ast_assert(!ast_threadstorage_get_ptr(&completion_storage));
2775 
2776  if (!vec) {
2777  return NULL;
2778  }
2779 
2780  if (ast_threadstorage_set_ptr(&completion_storage, vec)) {
2781  ast_log(LOG_ERROR, "Failed to initialize threadstorage for completion.\n");
2782  ast_free(vec);
2783 
2784  return NULL;
2785  }
2786 
2787  while ((retstr = ast_cli_generator(text, word, which)) != NULL) {
2788  if (cli_completion_vector_add(vec, retstr)) {
2789  ast_threadstorage_set_ptr(&completion_storage, NULL);
2790 
2791  goto vector_cleanup;
2792  }
2793 
2794  ++which;
2795  }
2796 
2797  ast_threadstorage_set_ptr(&completion_storage, NULL);
2798 
2799  if (!AST_VECTOR_SIZE(vec)) {
2800  AST_VECTOR_PTR_FREE(vec);
2801 
2802  return NULL;
2803  }
2804 
2805  prevstr = AST_VECTOR_GET(vec, 0);
2806  max_equal = strlen(prevstr);
2807  which = 1;
2808 
2809  /* Find the longest substring that is common to all results
2810  * (it is a candidate for completion), and store a copy in entry 0.
2811  */
2812  while (which < AST_VECTOR_SIZE(vec)) {
2813  size_t i = 0;
2814 
2815  retstr = AST_VECTOR_GET(vec, which);
2816  /* Check for and remove duplicate strings. */
2817  if (!strcasecmp(prevstr, retstr)) {
2818  AST_VECTOR_REMOVE(vec, which, 1);
2819  ast_free(retstr);
2820 
2821  continue;
2822  }
2823 
2824  while (i < max_equal && toupper(prevstr[i]) == toupper(retstr[i])) {
2825  i++;
2826  }
2827 
2828  max_equal = i;
2829  prevstr = retstr;
2830  ++which;
2831  }
2832 
2833  /* Insert longest match to position 0. */
2834  retstr = ast_strndup(AST_VECTOR_GET(vec, 0), max_equal);
2835  if (!retstr || AST_VECTOR_INSERT_AT(vec, 0, retstr)) {
2836  ast_free(retstr);
2837 
2838  goto vector_cleanup;
2839  }
2840 
2841  return vec;
2842 
2843 vector_cleanup:
2844  AST_VECTOR_CALLBACK_VOID(vec, ast_free);
2845  AST_VECTOR_PTR_FREE(vec);
2846 
2847  return NULL;
2848 }
2849 
2850 /*! \brief returns true if there are more words to match */
2851 static int more_words (const char * const *dst)
2852 {
2853  int i;
2854  for (i = 0; dst[i]; i++) {
2855  if (dst[i][0] != '[')
2856  return -1;
2857  }
2858  return 0;
2859 }
2860 
2861 /*
2862  * generate the entry at position 'state'
2863  */
2864 static char *__ast_cli_generator(const char *text, const char *word, int state, int lock)
2865 {
2866  const char *argv[AST_MAX_ARGS];
2867  struct ast_cli_entry *e = NULL;
2868  int x = 0, argindex, matchlen;
2869  int matchnum=0;
2870  char *ret = NULL;
2871  char matchstr[80] = "";
2872  int tws = 0;
2873  /* Split the argument into an array of words */
2874  char *duplicate = parse_args(text, &x, argv, ARRAY_LEN(argv), &tws);
2875 
2876  if (!duplicate) /* malloc error */
2877  return NULL;
2878 
2879  /* Compute the index of the last argument (could be an empty string) */
2880  argindex = (!ast_strlen_zero(word) && x>0) ? x-1 : x;
2881 
2882  /* rebuild the command, ignore terminating white space and flatten space */
2883  ast_join(matchstr, sizeof(matchstr)-1, argv);
2884  matchlen = strlen(matchstr);
2885  if (tws) {
2886  strcat(matchstr, " "); /* XXX */
2887  if (matchlen)
2888  matchlen++;
2889  }
2890  if (lock)
2892  while ( (e = cli_next(e)) ) {
2893  /* XXX repeated code */
2894  int src = 0, dst = 0, n = 0;
2895 
2896  if (e->command[0] == '_')
2897  continue;
2898 
2899  /*
2900  * Try to match words, up to and excluding the last word, which
2901  * is either a blank or something that we want to extend.
2902  */
2903  for (;src < argindex; dst++, src += n) {
2904  n = word_match(argv[src], e->cmda[dst]);
2905  if (n < 0)
2906  break;
2907  }
2908 
2909  if (src != argindex && more_words(e->cmda + dst)) /* not a match */
2910  continue;
2911  ret = is_prefix(argv[src], e->cmda[dst], state - matchnum, &n);
2912  matchnum += n; /* this many matches here */
2913  if (ret) {
2914  /*
2915  * argv[src] is a valid prefix of the next word in this
2916  * command. If this is also the correct entry, return it.
2917  */
2918  if (matchnum > state)
2919  break;
2920  ast_free(ret);
2921  ret = NULL;
2922  } else if (ast_strlen_zero(e->cmda[dst])) {
2923  /*
2924  * This entry is a prefix of the command string entered
2925  * (only one entry in the list should have this property).
2926  * Run the generator if one is available. In any case we are done.
2927  */
2928  if (e->handler) { /* new style command */
2929  struct ast_cli_args a = {
2930  .line = matchstr, .word = word,
2931  .pos = argindex,
2932  .n = state - matchnum,
2933  .argv = argv,
2934  .argc = x};
2935 
2936  /* If the command is in a module it must be running. */
2937  if (!e->module || ast_module_running_ref(e->module)) {
2938  ret = e->handler(e, CLI_GENERATE, &a);
2940  }
2941  }
2942  if (ret)
2943  break;
2944  }
2945  }
2946  if (lock)
2948  ast_free(duplicate);
2949  return ret;
2950 }
2951 
2952 char *ast_cli_generator(const char *text, const char *word, int state)
2953 {
2954  return __ast_cli_generator(text, word, state, 1);
2955 }
2956 
2957 static int allowed_on_shutdown(struct ast_cli_entry *e)
2958 {
2959  int found = 0;
2960  int i;
2961 
2962  ast_rwlock_rdlock(&shutdown_commands_lock);
2963  for (i = 0; i < AST_VECTOR_SIZE(&shutdown_commands); ++i) {
2964  if (e == AST_VECTOR_GET(&shutdown_commands, i)) {
2965  found = 1;
2966  break;
2967  }
2968  }
2969  ast_rwlock_unlock(&shutdown_commands_lock);
2970 
2971  return found;
2972 }
2973 
2974 int ast_cli_command_full(int uid, int gid, int fd, const char *s)
2975 {
2976  const char *args[AST_MAX_ARGS + 1];
2977  struct ast_cli_entry *e = NULL;
2978  int x;
2979  char *duplicate = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL);
2980  char tmp[AST_MAX_ARGS + 1];
2981  char *retval = CLI_FAILURE;
2982  struct ast_cli_args a = {
2983  .fd = fd, .argc = x, .argv = args+1 };
2984 
2985  if (duplicate == NULL)
2986  return RESULT_FAILURE;
2987 
2988  if (x < 1) /* We need at least one entry, otherwise ignore */
2989  goto done;
2990 
2992  e = find_cli(args + 1, 0);
2993  if (e)
2996  if (e == NULL) {
2997  ast_cli(fd, "No such command '%s' (type 'core show help %s' for other possible commands)\n", s, find_best(args + 1));
2998  goto done;
2999  }
3000 
3001  if (ast_shutting_down() && !allowed_on_shutdown(e)) {
3002  ast_cli(fd, "Command '%s' cannot be run during shutdown\n", s);
3003  goto done;
3004  }
3005 
3006  ast_join(tmp, sizeof(tmp), args + 1);
3007  /* Check if the user has rights to run this command. */
3008  if (!cli_has_permissions(uid, gid, tmp)) {
3009  ast_cli(fd, "You don't have permissions to run '%s' command\n", tmp);
3010  goto done;
3011  }
3012 
3013  /*
3014  * Within the handler, argv[-1] contains a pointer to the ast_cli_entry.
3015  * Remember that the array returned by parse_args is NULL-terminated.
3016  */
3017  args[0] = (char *)e;
3018 
3019  /* If the command is in a module it must be running. */
3020  if (!e->module || ast_module_running_ref(e->module)) {
3021  retval = e->handler(e, CLI_HANDLER, &a);
3023  }
3024 
3025  if (retval == CLI_SHOWUSAGE) {
3026  ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n"));
3027  } else if (retval == CLI_FAILURE) {
3028  ast_cli(fd, "Command '%s' failed.\n", s);
3029  }
3030 
3031 done:
3032  if (e) {
3033  ast_atomic_fetchadd_int(&e->inuse, -1);
3034  }
3035  ast_free(duplicate);
3036  return retval == CLI_SUCCESS ? RESULT_SUCCESS : RESULT_FAILURE;
3037 }
3038 
3039 int ast_cli_command_multiple_full(int uid, int gid, int fd, size_t size, const char *s)
3040 {
3041  char cmd[512];
3042  int x, y = 0, count = 0;
3043 
3044  for (x = 0; x < size; x++) {
3045  cmd[y] = s[x];
3046  y++;
3047  if (s[x] == '\0') {
3048  ast_cli_command_full(uid, gid, fd, cmd);
3049  y = 0;
3050  count++;
3051  }
3052  }
3053  return count;
3054 }
3055 
3056 void ast_cli_print_timestr_fromseconds(int fd, int seconds, const char *prefix)
3057 {
3058  print_uptimestr(fd, ast_tv(seconds, 0), prefix, 0);
3059 }
3060 
3062 {
3063  int res;
3064 
3065  ast_rwlock_wrlock(&shutdown_commands_lock);
3066  res = AST_VECTOR_APPEND(&shutdown_commands, e);
3067  ast_rwlock_unlock(&shutdown_commands_lock);
3068 
3069  return res;
3070 }
char * ast_cli_generator(const char *text, const char *word, int state)
Readline madness Useful for readline, that's about it.
Definition: main/cli.c:2952
#define AST_VECTOR_FREE(vec)
Deallocates this vector.
Definition: vector.h:174
struct ast_variable * next
struct ao2_container * ast_channel_cache_by_name(void)
Secondary channel cache, indexed by name.
#define AST_THREADSTORAGE(name)
Define a thread storage variable.
Definition: threadstorage.h:86
const ast_string_field data
static struct module_level_list debug_modules
Definition: main/cli.c:107
char * ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
Command completion for the list of active channels.
Definition: main/cli.c:1865
static struct module_level * find_module_level(const char *module, struct module_level_list *mll)
Find the module level setting.
Definition: main/cli.c:351
Main Channel structure associated with a channel.
channel group info
Definition: channel.h:2915
char * _full_cmd
Definition: cli.h:181
#define AST_VECTOR_ADD_SORTED(vec, elem, cmp)
Add an element into a sorted vector.
Definition: vector.h:371
struct ast_channel_snapshot_base * base
Asterisk locking-related definitions:
Channels with this particular technology are an implementation detail of Asterisk and should generall...
Definition: channel.h:971
struct ast_channel * ast_channel_iterator_next(struct ast_channel_iterator *i)
Get the next channel for a channel iterator.
Definition: channel.c:1422
Asterisk main include file. File version handling, generic pbx functions.
int ast_shutting_down(void)
Definition: asterisk.c:1876
#define AST_VECTOR_REMOVE_ELEM_UNORDERED(vec, elem, cleanup)
Remove an element from a vector.
Definition: vector.h:583
#define AST_LIST_FIRST(head)
Returns the first entry contained in a list.
Definition: linkedlists.h:421
const ast_string_field uniqueid
Definition: bridge.h:401
#define ast_realloc(p, len)
A wrapper for realloc()
Definition: astmm.h:226
char * ast_module_helper(const char *line, const char *word, int pos, int state, int rpos, enum ast_module_helper_type type)
Match modules names for the Asterisk cli.
Definition: loader.c:1528
int ast_active_calls(void)
Retrieve the number of active calls.
Definition: pbx.c:4760
enum ast_module_load_result ast_load_resource(const char *resource_name)
Load a module.
Definition: loader.c:1978
unsigned int ast_trace_get_by_module(const char *module)
Get the trace level for a module.
Definition: main/cli.c:153
int cmdlen
Definition: cli.h:182
struct ast_stream_topology * ast_channel_get_stream_topology(const struct ast_channel *chan)
Retrieve the topology of streams on a channel.
#define DEBUGCHAN_FLAG
Definition: channel.h:857
void ast_variables_destroy(struct ast_variable *var)
Free variable list.
Definition: extconf.c:1262
#define ast_join(s, len, w)
Join an array of strings into a single string.
Definition: strings.h:520
int ast_stream_get_group(const struct ast_stream *stream)
Get the stream group that a stream is part of.
Definition: stream.c:1077
struct ast_group_info * ast_app_group_list_head(void)
Get the head of the group count list.
Definition: main/app.c:2346
#define ast_channel_unref(c)
Decrease channel reference count.
Definition: channel.h:2958
int option_debug
Definition: options.c:69
Support for translation of data formats. translate.c.
int ast_carefulwrite(int fd, char *s, int len, int timeoutms)
Try to write string, but wait no more than ms milliseconds before timing out.
Definition: utils.c:1771
int ast_softhangup(struct ast_channel *chan, int cause)
Softly hangup up a channel.
Definition: channel.c:2471
enum ast_media_type ast_stream_get_type(const struct ast_stream *stream)
Get the media type of a stream.
Definition: stream.c:316
enum ast_module_reload_result ast_module_reload(const char *name)
Reload asterisk modules.
Definition: loader.c:1721
ast_module_reload_result
Possible return types for ast_module_reload.
Definition: module.h:109
descriptor for a cli entry.
Definition: cli.h:171
ast_callid callid
Definition: bridge.h:361
#define AST_FORMAT_CAP_NAMES_LEN
Definition: format_cap.h:324
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:761
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:78
const ast_string_field name
Definition: bridge.h:401
#define AST_RWLIST_HEAD_INIT_VALUE
Defines initial values for a declaration of AST_RWLIST_HEAD.
Definition: linkedlists.h:243
const char * ast_codec_media_type2str(enum ast_media_type type)
Conversion function to take a media type and turn it into a string.
Definition: codec.c:348
struct ast_config * ast_config_load2(const char *filename, const char *who_asked, struct ast_flags flags)
Load a config file.
Definition: main/config.c:3321
static ast_mutex_t permsconfiglock
mutex used to prevent a user from running the 'cli reload permissions' command while it is already ru...
Definition: main/cli.c:91
Structure for variables, used for configurations and for channel variables.
#define AST_VECTOR_APPEND(vec, elem)
Append an element to a vector, growing the vector if needed.
Definition: vector.h:256
unsigned long global_fin
Definition: channel.c:95
Structure representing a snapshot of channel state.
static int more_words(const char *const *dst)
returns true if there are more words to match
Definition: main/cli.c:2851
int ast_str_set_va(struct ast_str **buf, ssize_t max_len, const char *fmt, va_list ap)
Set a dynamic string from a va_list.
Definition: strings.h:1030
int ast_tvzero(const struct timeval t)
Returns true if the argument is 0,0.
Definition: time.h:117
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition: linkedlists.h:439
AST_THREADSTORAGE_RAW(in_intercept_routine)
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:52
ast_channel_state
ast_channel states
Definition: channelstate.h:35
const ast_string_field accountcode
static const char perms_config[]
CLI permissions config file.
Definition: main/cli.c:85
const ast_string_field uniqueid
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition: strings.h:1139
#define ast_cli_register_multiple(e, len)
Register multiple commands.
Definition: cli.h:265
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
static char * help1(int fd, const char *const match[], int locked)
helper for final part of handle_help if locked = 1, assume the list is already locked ...
Definition: main/cli.c:2557
int ast_verb_console_get(void)
Get this thread's console verbosity level.
Definition: logger.c:2673
int ast_cli_unregister(struct ast_cli_entry *e)
Unregisters a command or an array of commands.
Definition: main/cli.c:2432
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition: time.h:159
int ast_refresh_resource(const char *resource_name, enum ast_module_unload_mode force, int recursive)
Unload and load a module again.
Definition: loader.c:1407
void ast_cli_channels_init(void)
Definition: main/cli.c:2245
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition: format.c:334
int64_t ast_tvdiff_ms(struct timeval end, struct timeval start)
Computes the difference (in milliseconds) between two struct timeval instances.
Definition: time.h:107
map a debug or verbose level to a module name
Definition: main/cli.c:98
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
char * ast_category_browse(struct ast_config *config, const char *prev_name)
Browse categories.
Definition: extconf.c:3326
struct ast_stream * ast_stream_topology_get_stream(const struct ast_stream_topology *topology, unsigned int position)
Get a specific stream from the topology.
Definition: stream.c:788
Definitions to aid in the use of thread local storage.
struct ast_channel_snapshot_dialplan * dialplan
char * ast_skip_nonblanks(const char *str)
Gets a pointer to first whitespace character in a string.
Definition: strings.h:204
int ast_atomic_fetchadd_int(volatile int *p, int v)
Atomically add v to *p and return the previous value of *p.
Definition: lock.h:757
int ast_option_maxcalls
Definition: options.c:79
Media Stream API.
Utility functions.
int args
This gets set in ast_cli_register()
Definition: cli.h:185
All configuration options for http media cache.
static int cli_default_perm
Default permissions value 1=Permit 0=Deny.
Definition: main/cli.c:87
#define AST_RWLIST_HEAD_STATIC(name, type)
Defines a structure to be used to hold a read/write list of specified type, statically initialized...
Definition: linkedlists.h:333
Number structure.
Definition: app_followme.c:154
const ast_string_field context
int ast_update_module_list(int(*modentry)(const char *module, const char *description, int usecnt, const char *status, const char *like, enum ast_module_support_level support_level), const char *like)
Ask for a list of modules, descriptions, use counts and status.
int inuse
Definition: cli.h:179
struct ast_bridge * ast_channel_get_bridge(const struct ast_channel *chan)
Get the bridge associated with a channel.
Definition: channel.c:10534
#define AST_VECTOR_INIT(vec, size)
Initialize a vector.
Definition: vector.h:113
ast_mutex_t lock
General Asterisk PBX channel definitions.
int ast_register_cleanup(void(*func)(void))
Register a function to be executed before Asterisk gracefully exits.
Definition: clicompat.c:19
Asterisk file paths, configured in asterisk.conf.
int ast_threadstorage_set_ptr(struct ast_threadstorage *ts, void *ptr)
Set a raw pointer from threadstorage.
const ast_string_field appl
#define AST_VECTOR_ELEM_CLEANUP_NOOP(elem)
Vector element cleanup that does nothing.
Definition: vector.h:571
int ast_cli_unregister_multiple(struct ast_cli_entry *e, int len)
Unregister multiple commands.
Definition: main/cli.c:2543
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:298
int ast_cli_allow_at_shutdown(struct ast_cli_entry *e)
Allow a CLI command to be executed while Asterisk is shutting down.
Definition: main/cli.c:3061
struct cli_perm_head * perms
Definition: main/cli.c:81
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
struct ast_variable * ast_stream_get_metadata_list(const struct ast_stream *stream)
Get all stream metadata keys.
Definition: stream.c:439
#define S_COR(a, b, c)
returns the equivalent of logic or for strings, with an additional boolean check: second one if not e...
Definition: strings.h:87
const ast_string_field exten
static struct callattempt * find_best(struct callattempt *outgoing)
find the entry with the best metric, or NULL
Definition: app_queue.c:4885
A set of macros to manage forward-linked lists.
#define ast_malloc(len)
A wrapper for malloc()
Definition: astmm.h:191
#define AST_VECTOR_STEAL_ELEMENTS(vec)
Steal the elements from a vector and reinitialize.
Definition: vector.h:140
void ast_cli_print_timestr_fromseconds(int fd, int seconds, const char *prefix)
Print on cli a duration in seconds in format s year(s), s week(s), s day(s), s hour(s), s second(s)
Definition: main/cli.c:3056
#define AST_VECTOR(name, type)
Define a vector structure.
Definition: vector.h:44
#define AST_LIST_REMOVE_HEAD(head, field)
Removes and returns the head entry from a list.
Definition: linkedlists.h:833
const struct ast_format_cap * ast_stream_get_formats(const struct ast_stream *stream)
Get the current negotiated formats of a stream.
Definition: stream.c:330
static char * handle_cli_reload_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
handles CLI command 'cli reload permissions'
Definition: main/cli.c:1332
#define AST_CLI_INITLEN
Initial buffer size for resulting strings in ast_cli()
Definition: main/cli.c:116
Structure to describe a channel "technology", ie a channel driver See for examples: ...
Definition: channel.h:628
static char * handle_cli_show_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
handles CLI command 'cli show permissions'
Definition: main/cli.c:1287
Core PBX routines and definitions.
struct ast_channel * ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg, void *data, int ao2_flags)
Call a function with every active channel.
Definition: channel.c:1278
List of restrictions per user.
Definition: main/cli.c:69
struct ast_channel_snapshot_caller * caller
#define AST_LIST_HEAD_NOLOCK(name, type)
Defines a structure to be used to hold a list of specified type (with no lock).
Definition: linkedlists.h:225
Structure that contains information about a bridge.
Definition: bridge.h:349
struct ast_vector_string * ast_cli_completion_vector(const char *text, const char *word)
Generates a vector of strings for CLI completion.
Definition: main/cli.c:2766
int ast_processed_calls(void)
Retrieve the total number of calls processed through the PBX since last restart.
Definition: pbx.c:4765
#define AST_LIST_INSERT_TAIL(head, elm, field)
Appends a list entry to the tail of a list.
Definition: linkedlists.h:731
list of users to apply restrictions.
Definition: main/cli.c:78
Support for dynamic strings.
Definition: strings.h:623
int ast_unload_resource(const char *resource_name, enum ast_module_unload_mode)
Unload a module.
Definition: loader.c:1448
static char * handle_cli_check_permissions(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
handles CLI command 'cli check permissions'
Definition: main/cli.c:1351
char * ast_skip_blanks(const char *str)
Gets a pointer to the first non-whitespace character in a string.
Definition: strings.h:161
#define ast_strndup(str, len)
A wrapper for strndup()
Definition: astmm.h:256
const char * ast_format_cap_get_names(const struct ast_format_cap *cap, struct ast_str **buf)
Get the names of codecs of a set of formats.
Definition: format_cap.c:734
char ** ast_cli_completion_matches(const char *text, const char *word)
Generates a NULL-terminated array of strings that 1) begin with the string in the second parameter...
Definition: main/cli.c:2705
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:491
#define AST_LIST_ENTRY(type)
Declare a forward link structure inside a list entry.
Definition: linkedlists.h:410
int ast_app_group_list_unlock(void)
Unlock the group count list.
Definition: main/app.c:2351
#define ESS(x)
Definition: cli.h:59
char * command
Definition: cli.h:186
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
char * ast_cli_complete(const char *word, const char *const choices[], int state)
Definition: main/cli.c:1846
Prototypes for public functions only of internal interest,.
Vector container support.
enum ast_channel_state state
void * ast_threadstorage_get_ptr(struct ast_threadstorage *ts)
Retrieve a raw pointer from threadstorage.
int ast_stream_topology_get_count(const struct ast_stream_topology *topology)
Get the number of streams in a topology.
Definition: stream.c:765
#define AST_VECTOR_PTR_FREE(vec)
Deallocates this vector pointer.
Definition: vector.h:189
Structure used to handle boolean flags.
Definition: utils.h:199
#define AST_RWLIST_HEAD(name, type)
Defines a structure to be used to hold a read/write list of specified type.
Definition: linkedlists.h:199
const char * usage
Definition: cli.h:177
#define ast_module_unref(mod)
Release a reference to the module.
Definition: module.h:483
unsigned int ast_debug_get_by_module(const char *module)
Get the debug level for a module.
Definition: main/cli.c:136
#define ast_module_running_ref(mod)
Hold a reference to the module if it is running.
Definition: module.h:469
int ast_cli_command_multiple_full(int uid, int gid, int fd, size_t size, const char *s)
Executes multiple CLI commands Interpret strings separated by NULL and execute each one...
Definition: main/cli.c:3039
size_t ast_str_strlen(const struct ast_str *buf)
Returns the current length of the string stored within buf.
Definition: strings.h:730
#define AST_VECTOR_GET(vec, idx)
Get an element from a vector.
Definition: vector.h:680
const char * ast_translate_path_to_str(struct ast_trans_pvt *t, struct ast_str **str)
Puts a string representation of the translation path into outbuf.
Definition: translate.c:930
static const char cli_rsvd[]
Definition: main/cli.c:2064
const char *const summary
Definition: cli.h:176
int ast_app_group_list_rdlock(void)
Read Lock the group count list.
Definition: main/app.c:2341
static char * is_prefix(const char *word, const char *token, int pos, int *actual)
if word is a valid prefix for token, returns the pos-th match as a malloced string, or NULL otherwise. Always tell in *actual how many matches we got.
Definition: main/cli.c:2301
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition: astobj2.h:1821
Standard Command Line Interface.
int ast_cli_command_full(int uid, int gid, int fd, const char *s)
Interprets a command Interpret a command s, sending output to fd if uid:gid has permissions to run th...
Definition: main/cli.c:2974
const ast_string_field number
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one...
Definition: strings.h:80
struct timeval ast_tv(ast_time_t sec, ast_suseconds_t usec)
Returns a timeval from sec, usec.
Definition: time.h:235
struct ast_channel_snapshot_bridge * bridge
struct ast_channel_iterator * ast_channel_iterator_destroy(struct ast_channel_iterator *i)
Destroy a channel iterator.
Definition: channel.c:1360
const char * ast_stream_state2str(enum ast_stream_state state)
Convert the state of a stream into a string.
Definition: stream.c:388
int ast_cli_perms_init(int reload)
Definition: main/cli.c:2105
void ast_verb_console_set(int verb_level)
Set this thread's console verbosity level.
Definition: logger.c:2691
int ast_cdr_serialize_variables(const char *channel_name, struct ast_str **buf, char delim, char sep)
Serializes all the data and variables for a current CDR record.
Definition: cdr.c:3415
List of users and permissions.
Definition: main/cli.c:93
#define AST_VECTOR_INSERT_AT(vec, idx, elem)
Insert an element at a specific position in a vector, growing the vector if needed.
Definition: vector.h:338
char * command
Definition: main/cli.c:71
Definition: search.h:40
static int word_match(const char *cmd, const char *cli_word)
Definition: main/cli.c:2262
struct timeval ast_tvsub(struct timeval a, struct timeval b)
Returns the difference of two timevals a - b.
Definition: extconf.c:2297
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:151
Generic container type.
struct ast_str * ast_str_thread_get(struct ast_threadstorage *ts, size_t init_len)
Retrieve a thread locally stored dynamic string.
Definition: strings.h:909
void ast_console_toggle_mute(int fd, int silent)
mute or unmute a console from logging
Definition: asterisk.c:1274
String vector definitions.
Definition: vector.h:55
void ast_callid_strnprint(char *buffer, size_t buffer_size, ast_callid callid)
copy a string representation of the callid into a target string
Definition: logger.c:2288
struct ast_channel_iterator * ast_channel_iterator_all_new(void)
Create a new channel iterator.
Definition: channel.c:1408
void ast_config_destroy(struct ast_config *cfg)
Destroys a config.
Definition: extconf.c:1289
struct ast_channel_snapshot_peer * peer
void ast_builtins_init(void)
initialize the _full_cmd string in * each of the builtins.
Definition: main/cli.c:2238
const char * ast_stream_get_name(const struct ast_stream *stream)
Get the name of a stream.
Definition: stream.c:309
struct ast_channel * ast_channel_get_by_name(const char *name)
Find a channel by name.
Definition: channel.c:1454
Bridging API.
#define AST_VECTOR_REMOVE(vec, idx, preserve_ordered)
Remove an element from a vector by index.
Definition: vector.h:412
const char *const cmda[AST_MAX_CMD_LEN]
Definition: cli.h:172
Asterisk module definitions.
unsigned int permit
Definition: main/cli.c:70
static void destroy_user_perms(void)
cleanup (free) cli_perms linkedlist.
Definition: main/cli.c:2089
int ast_active_channels(void)
returns number of active/allocated channels
Definition: channel.c:499
const char * ast_state2str(enum ast_channel_state state)
Gives the string form of a given channel state.
Definition: channel.c:636
Application convenience functions, designed to give consistent look and feel to Asterisk apps...
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
static char * handle_showchan(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition: main/cli.c:1645
enum ast_stream_state ast_stream_get_state(const struct ast_stream *stream)
Get the current state of a stream.
Definition: stream.c:373
static int set_full_cmd(struct ast_cli_entry *e)
Definition: main/cli.c:2070
#define AST_VECTOR_SIZE(vec)
Get the number of elements in a vector.
Definition: vector.h:609
struct ast_module * module
Definition: cli.h:180
#define AST_VECTOR_CALLBACK_VOID(vec, callback,...)
Execute a callback on every element in a vector disregarding callback return.
Definition: vector.h:862
const ast_string_field name
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition: strings.h:659
int ast_cli_completion_add(char *value)
Add a result to a request for completion options.
Definition: main/cli.c:2761
int option_trace
Definition: options.c:71