res_clialiases.c File Reference

CLI Aliases. More...

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/config.h"
#include "asterisk/cli.h"
#include "asterisk/astobj2.h"

Include dependency graph for res_clialiases.c:

Go to the source code of this file.

Data Structures
struct	cli_alias

Macros
#define	FORMAT   "%-50.50s %-50.50s\n"
#define	MAX_ALIAS_BUCKETS   53

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
static int	alias_cmp_cb (void *obj, void *arg, int flags)
	Comparison function used for aliases. More...
static int	alias_hash_cb (const void *obj, const int flags)
	Hashing function used for aliases. More...
static int	alias_name_cb (void *obj, void *arg, int flags)
	Callback for finding an alias based on name. More...
static char *	alias_show (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
	CLI Command to display CLI Aliases. More...
static int	alias_unregister_cb (void *obj, void *arg, int flags)
	Callback for unregistering an alias. More...
struct ast_module *	AST_MODULE_SELF_SYM (void)
static char *	cli_alias_passthrough (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
	Function which passes through an aliased CLI command to the real one. More...
static void	load_config (int reload)
	Function called to load or reload the configuration file. More...
static int	load_module (void)
	Load the module. More...
static int	reload_module (void)
	Function called to reload the module. More...
static int	unload_module (void)
	Function called to unload the module. More...

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "CLI Aliases" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct ast_cli_entry	cli_alias []
	CLI commands to interact with things. More...
static struct ao2_container *	cli_aliases
static const char	config_file [] = "cli_aliases.conf"

Detailed Description

CLI Aliases.

Author

Joshua Colp <jcolp@digium.com> 

This module provides the capability to create aliases to other CLI commands.

Definition in file res_clialiases.c.

Macro Definition Documentation

FORMAT

#define FORMAT   "%-50.50s %-50.50s\n"

MAX_ALIAS_BUCKETS

#define MAX_ALIAS_BUCKETS   53

Maximum number of buckets for CLI aliases

Definition at line 50 of file res_clialiases.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 303 of file res_clialiases.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 303 of file res_clialiases.c.

alias_cmp_cb()

static int alias_cmp_cb ( void *  obj, void *  arg, int  flags  )

static

Comparison function used for aliases.

Definition at line 71 of file res_clialiases.c.

{
    const struct cli_alias *alias0 = obj, *alias1 = arg;
 
    return (alias0->cli_entry.command == alias1->cli_entry.command ? CMP_MATCH | CMP_STOP : 0);
}

References cli_alias::cli_entry, CMP_MATCH, CMP_STOP, and ast_cli_entry::command.

Referenced by load_module().

alias_hash_cb()

static int alias_hash_cb ( const void *  obj, const int  flags  )

static

Hashing function used for aliases.

Definition at line 64 of file res_clialiases.c.

{
    const struct cli_alias *alias = obj;
    return ast_str_hash(alias->cli_entry.command);
}

References cli_alias::alias, and ast_str_hash().

Referenced by load_module().

alias_name_cb()

static int alias_name_cb ( void *  obj, void *  arg, int  flags  )

static

Callback for finding an alias based on name.

Definition at line 91 of file res_clialiases.c.

{
    struct cli_alias *alias = obj;
    char *name = arg;
 
    return !strcmp(alias->alias, name) ? CMP_MATCH | CMP_STOP : 0;
}

References cli_alias::alias, CMP_MATCH, CMP_STOP, and name.

Referenced by load_config().

alias_show()

static char * alias_show ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

CLI Command to display CLI Aliases.

Definition at line 153 of file res_clialiases.c.

{
#define FORMAT "%-50.50s %-50.50s\n"
    struct cli_alias *alias;
    struct ao2_iterator i;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "cli show aliases";
        e->usage =
            "Usage: cli show aliases\n"
            "       Displays a list of aliased CLI commands.\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    ast_cli(a->fd, FORMAT, "Alias Command", "Real Command");
 
    i = ao2_iterator_init(cli_aliases, 0);
    for (; (alias = ao2_iterator_next(&i)); ao2_ref(alias, -1)) {
        ast_cli(a->fd, FORMAT, alias->alias, alias->real_cmd);
    }
    ao2_iterator_destroy(&i);
 
    return CLI_SUCCESS;
#undef FORMAT
}

References a, cli_alias::alias, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_cli(), cli_aliases, CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, FORMAT, NULL, cli_alias::real_cmd, and ast_cli_entry::usage.

alias_unregister_cb()

static int alias_unregister_cb ( void *  obj, void *  arg, int  flags  )

static

Callback for unregistering an alias.

Definition at line 79 of file res_clialiases.c.

{
    struct cli_alias *alias = obj;
 
    /* Unregister the CLI entry from the core */
    ast_cli_unregister(&alias->cli_entry);
 
    /* We can determine if this worked or not by looking at the cli_entry itself */
    return !alias->cli_entry.command ? CMP_MATCH : 0;
}

References cli_alias::alias, ast_cli_unregister(), and CMP_MATCH.

Referenced by load_config(), and unload_module().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 303 of file res_clialiases.c.

cli_alias_passthrough()

static char * cli_alias_passthrough ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Function which passes through an aliased CLI command to the real one.

Definition at line 100 of file res_clialiases.c.

{
    struct cli_alias *alias;
    struct cli_alias tmp = {
        .cli_entry.command = e->command,
    };
    char *generator = NULL;
    const char *line;
 
    /* Try to find the alias based on the CLI entry */
    if (!(alias = ao2_find(cli_aliases, &tmp, OBJ_POINTER))) {
        return 0;
    }
 
    switch (cmd) {
    case CLI_INIT:
        ao2_ref(alias, -1);
        return NULL;
    case CLI_GENERATE:
        line = a->line;
        line += (strlen(alias->alias));
        if (strncasecmp(alias->alias, alias->real_cmd, strlen(alias->alias))) {
            struct ast_str *real_cmd = ast_str_alloca(strlen(alias->real_cmd) + strlen(line) + 1);
            ast_str_append(&real_cmd, 0, "%s%s", alias->real_cmd, line);
            generator = ast_cli_generator(ast_str_buffer(real_cmd), a->word, a->n);
        }
        ao2_ref(alias, -1);
        return generator;
    }
 
    /* If they gave us extra arguments we need to construct a string to pass in */
    if (a->argc != e->args) {
        struct ast_str *real_cmd = ast_str_alloca(2048);
        int i;
 
        ast_str_append(&real_cmd, 0, "%s", alias->real_cmd);
 
        /* Add the additional arguments that have been passed in */
        for (i = e->args + 1; i <= a->argc; i++) {
            ast_str_append(&real_cmd, 0, " %s", a->argv[i - 1]);
        }
 
        ast_cli_command(a->fd, ast_str_buffer(real_cmd));
    } else {
        ast_cli_command(a->fd, alias->real_cmd);
    }
 
    ao2_ref(alias, -1);
 
    return CLI_SUCCESS;
}

References a, cli_alias::alias, ao2_find, ao2_ref, ast_cli_entry::args, ast_cli_generator(), ast_str_alloca, ast_str_append(), ast_str_buffer(), cli_aliases, CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, NULL, OBJ_POINTER, cli_alias::real_cmd, and tmp().

Referenced by load_config().

load_config()

static void load_config ( int  reload )

static

Function called to load or reload the configuration file.

Definition at line 188 of file res_clialiases.c.

{
    struct ast_config *cfg = NULL;
    struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
    struct cli_alias *alias;
    struct ast_variable *v, *v1;
 
    if (!(cfg = ast_config_load(config_file, config_flags)) || cfg == CONFIG_STATUS_FILEINVALID) {
        ast_log(LOG_ERROR, "res_clialiases configuration file '%s' not found\n", config_file);
        return;
    } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
        return;
    }
 
    /* Destroy any existing CLI aliases */
    if (reload) {
        ao2_callback(cli_aliases, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, alias_unregister_cb, NULL);
    }
 
    for (v = ast_variable_browse(cfg, "general"); v; v = v->next) {
        if (strcmp(v->name, "template")) {
            ast_log(LOG_WARNING, "%s is not a correct option in [%s]\n", v->name, "general");
            continue;
        }
        /* Read in those there CLI aliases */
        for (v1 = ast_variable_browse(cfg, v->value); v1; v1 = v1->next) {
            struct cli_alias *existing = ao2_callback(cli_aliases, 0, alias_name_cb, (char*)v1->name);
 
            if (existing) {
                ast_log(LOG_WARNING, "Alias '%s' could not be unregistered and has been retained\n",
                    existing->alias);
                ao2_ref(existing, -1);
                continue;
            }
 
            if (!(alias = ao2_alloc((sizeof(*alias) + strlen(v1->name) + strlen(v1->value) + 2), NULL))) {
                continue;
            }
            alias->alias = ((char *) alias) + sizeof(*alias);
            alias->real_cmd = ((char *) alias->alias) + strlen(v1->name) + 1;
            strcpy(alias->alias, v1->name);
            strcpy(alias->real_cmd, v1->value);
            alias->cli_entry.handler = cli_alias_passthrough;
            alias->cli_entry.command = alias->alias;
            alias->cli_entry.usage = "Aliased CLI Command\n";
 
            if (ast_cli_register(&alias->cli_entry)) {
                ao2_ref(alias, -1);
                continue;
            }
            ao2_link(cli_aliases, alias);
            ast_verb(5, "Aliased CLI command '%s' to '%s'\n", v1->name, v1->value);
            ao2_ref(alias, -1);
        }
    }
 
    ast_config_destroy(cfg);
 
    return;
}

References cli_alias::alias, alias_name_cb(), alias_unregister_cb(), ao2_alloc, ao2_callback, ao2_link, ao2_ref, ast_cli_register, ast_config_destroy(), ast_config_load, ast_log, ast_variable_browse(), ast_verb, cli_alias_passthrough(), cli_aliases, config_file, CONFIG_FLAG_FILEUNCHANGED, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEUNCHANGED, LOG_ERROR, LOG_WARNING, ast_variable::name, ast_variable::next, NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_UNLINK, reload(), and ast_variable::value.

Referenced by load_module(), and reload_module().

load_module()

static int load_module ( void  )

static

Load the module.

Module loading including tests for configuration or dependencies. This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE, or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails tests return AST_MODULE_LOAD_FAILURE. If the module can not load the configuration file or other non-critical problem return AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.

Definition at line 283 of file res_clialiases.c.

{
    cli_aliases = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0,
        MAX_ALIAS_BUCKETS, alias_hash_cb, NULL, alias_cmp_cb);
    if (!cli_aliases) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    load_config(0);
 
    ast_cli_register_multiple(cli_alias, ARRAY_LEN(cli_alias));
 
    return AST_MODULE_LOAD_SUCCESS;
}

References alias_cmp_cb(), alias_hash_cb(), AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_hash, ARRAY_LEN, ast_cli_register_multiple, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, cli_aliases, load_config(), MAX_ALIAS_BUCKETS, and NULL.

reload_module()

static int reload_module ( void  )

static

Function called to reload the module.

Definition at line 250 of file res_clialiases.c.

{
    load_config(1);
    return 0;
}

References load_config().

unload_module()

static int unload_module ( void  )

static

Function called to unload the module.

Definition at line 257 of file res_clialiases.c.

{
    ao2_callback(cli_aliases, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, alias_unregister_cb, NULL);
 
    if (ao2_container_count(cli_aliases)) {
        ast_log(LOG_ERROR, "Could not unregister all CLI aliases\n");
        return -1;
    }
 
    ao2_ref(cli_aliases, -1);
 
    ast_cli_unregister_multiple(cli_alias, ARRAY_LEN(cli_alias));
 
    return 0;
}

References alias_unregister_cb(), ao2_callback, ao2_container_count(), ao2_ref, ARRAY_LEN, ast_cli_unregister_multiple(), ast_log, cli_aliases, LOG_ERROR, NULL, OBJ_MULTIPLE, OBJ_NODATA, and OBJ_UNLINK.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "CLI Aliases" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, }

static

Definition at line 303 of file res_clialiases.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 303 of file res_clialiases.c.

cli_alias

struct ast_cli_entry cli_alias[]

static

Initial value:

= {
    { .handler =  alias_show , .summary =  "Show CLI command aliases" ,},
}

CLI commands to interact with things.

Definition at line 183 of file res_clialiases.c.

cli_aliases

struct ao2_container* cli_aliases

static

Definition at line 61 of file res_clialiases.c.

Referenced by alias_show(), cli_alias_passthrough(), load_config(), load_module(), and unload_module().

config_file

const char config_file[] = "cli_aliases.conf"

static

Configuration file used for this application

Definition at line 53 of file res_clialiases.c.

Referenced by load_config().