res_realtime.c File Reference

RealTime CLI. More...

#include "asterisk.h"
#include "asterisk/file.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/config.h"
#include "asterisk/module.h"
#include "asterisk/lock.h"
#include "asterisk/cli.h"

Include dependency graph for res_realtime.c:

Go to the source code of this file.

Macros
#define	CRL_HEADER_FORMAT   "%30s %-30s\n"

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static char *	cli_realtime_destroy (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	cli_realtime_load (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	cli_realtime_store (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	cli_realtime_update (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	cli_realtime_update2 (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	load_module (void)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Realtime Data Lookup/Rewrite" , .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, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct ast_cli_entry	cli_realtime []

Detailed Description

RealTime CLI.

Author

Anthony Minessale anthm.nosp@m.ct@y.nosp@m.ahoo..nosp@m.com

Mark Spencer marks.nosp@m.ter@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

Definition in file res_realtime.c.

Macro Definition Documentation

CRL_HEADER_FORMAT

#define CRL_HEADER_FORMAT   "%30s %-30s\n"

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 288 of file res_realtime.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 288 of file res_realtime.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 288 of file res_realtime.c.

cli_realtime_destroy()

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

static

Definition at line 226 of file res_realtime.c.

{
    int res = -1;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "realtime destroy";
        e->usage =
            "Usage: realtime destroy <family> <colmatch1> <valuematch1> [<colmatch2> <valuematch2> [... <colmatch5> <valuematch5>]]\n"
            "       Remove a stored row using the RealTime driver.\n"
            "       You must supply a family name and name/value pairs (up to 5).\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc < 5) {
        return CLI_SHOWUSAGE;
    } else if (a->argc == 5) {
        res = ast_destroy_realtime(a->argv[2], a->argv[3], a->argv[4], SENTINEL);
    } else if (a->argc == 7) {
        res = ast_destroy_realtime(a->argv[2], a->argv[3], a->argv[4], a->argv[5], a->argv[6], SENTINEL);
    } else if (a->argc == 9) {
        res = ast_destroy_realtime(a->argv[2], a->argv[3], a->argv[4], a->argv[5], a->argv[6], a->argv[7], a->argv[8], SENTINEL);
    } else if (a->argc == 11) {
        res = ast_destroy_realtime(a->argv[2], a->argv[3], a->argv[4], a->argv[5], a->argv[6], a->argv[7], a->argv[8], a->argv[9], a->argv[10], SENTINEL);
    } else if (a->argc == 13) {
        res = ast_destroy_realtime(a->argv[2], a->argv[3], a->argv[4], a->argv[5], a->argv[6], a->argv[7], a->argv[8], a->argv[9], a->argv[10], a->argv[11], a->argv[12], SENTINEL);
    } else {
        return CLI_SHOWUSAGE;
    }
 
    if (res < 0) {
        ast_cli(a->fd, "Failed to remove record. Check the debug log for possible SQL related entries.\n");
        return CLI_FAILURE;
    }
 
    ast_cli(a->fd, "Removed %d RealTime record%s.\n", res, ESS(res));
 
    return CLI_SUCCESS;
}

References a, ast_cli(), ast_destroy_realtime(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, ESS, NULL, SENTINEL, and ast_cli_entry::usage.

cli_realtime_load()

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

static

Definition at line 45 of file res_realtime.c.

{
#define CRL_HEADER_FORMAT "%30s  %-30s\n"
    struct ast_variable *var = NULL, *orig_var = NULL;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "realtime load";
        e->usage =
            "Usage: realtime load <family> <colmatch> <value>\n"
            "       Prints out a list of variables using the RealTime driver.\n"
            "       You must supply a family name, a column to match on, and a value to match to.\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
 
    if (a->argc < 5)
        return CLI_SHOWUSAGE;
 
    var = ast_load_realtime_all(a->argv[2], a->argv[3], a->argv[4], SENTINEL);
 
    if (var) {
        ast_cli(a->fd, CRL_HEADER_FORMAT, "Column Name", "Column Value");
        ast_cli(a->fd, CRL_HEADER_FORMAT, "--------------------", "--------------------");
        orig_var = var;
        while (var) {
            ast_cli(a->fd, CRL_HEADER_FORMAT, var->name, var->value);
            var = var->next;
        }
    } else {
        ast_cli(a->fd, "No rows found matching search criteria.\n");
    }
    ast_variables_destroy(orig_var);
    return CLI_SUCCESS;
}

References a, ast_cli(), ast_load_realtime_all(), ast_variables_destroy(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, CRL_HEADER_FORMAT, NULL, SENTINEL, ast_cli_entry::usage, and var.

cli_realtime_store()

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

static

Definition at line 181 of file res_realtime.c.

{
    int res = -1;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "realtime store";
        e->usage =
            "Usage: realtime store <family> <colname1> <value1> [<colname2> <value2> [... <colname5> <value5>]]\n"
            "       Create a stored row using the RealTime driver.\n"
            "       You must supply a family name and name/value pairs (up to 5).  If\n"
            "       you need to store more than 5 key/value pairs, start with the first\n"
            "       five, then use 'realtime update' or 'realtime update2' to add\n"
            "       additional columns.\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc < 5) {
        return CLI_SHOWUSAGE;
    } else if (a->argc == 5) {
        res = ast_store_realtime(a->argv[2], a->argv[3], a->argv[4], SENTINEL);
    } else if (a->argc == 7) {
        res = ast_store_realtime(a->argv[2], a->argv[3], a->argv[4], a->argv[5], a->argv[6], SENTINEL);
    } else if (a->argc == 9) {
        res = ast_store_realtime(a->argv[2], a->argv[3], a->argv[4], a->argv[5], a->argv[6], a->argv[7], a->argv[8], SENTINEL);
    } else if (a->argc == 11) {
        res = ast_store_realtime(a->argv[2], a->argv[3], a->argv[4], a->argv[5], a->argv[6], a->argv[7], a->argv[8], a->argv[9], a->argv[10], SENTINEL);
    } else if (a->argc == 13) {
        res = ast_store_realtime(a->argv[2], a->argv[3], a->argv[4], a->argv[5], a->argv[6], a->argv[7], a->argv[8], a->argv[9], a->argv[10], a->argv[11], a->argv[12], SENTINEL);
    } else {
        return CLI_SHOWUSAGE;
    }
 
    if (res < 0) {
        ast_cli(a->fd, "Failed to store record. Check the debug log for possible SQL related entries.\n");
        return CLI_FAILURE;
    }
 
    ast_cli(a->fd, "Stored RealTime record.\n");
 
    return CLI_SUCCESS;
}

References a, ast_cli(), ast_store_realtime(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, NULL, SENTINEL, and ast_cli_entry::usage.

cli_realtime_update()

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

static

Definition at line 83 of file res_realtime.c.

{
    int res = 0;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "realtime update";
        e->usage =
            "Usage: realtime update <family> <colmatch> <valuematch> <colupdate> <newvalue>\n"
            "       Update a single variable using the RealTime driver.\n"
            "       You must supply a family name, a column to update on, a new value, column to match, and value to match.\n"
            "       Ex: realtime update sippeers name bobsphone port 4343\n"
            "       will execute SQL as UPDATE sippeers SET port = 4343 WHERE name = bobsphone\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc < 7)
        return CLI_SHOWUSAGE;
 
    res = ast_update_realtime(a->argv[2], a->argv[3], a->argv[4], a->argv[5], a->argv[6], SENTINEL);
 
    if (res < 0) {
        ast_cli(a->fd, "Failed to update. Check the debug log for possible SQL related entries.\n");
        return CLI_FAILURE;
    }
 
    ast_cli(a->fd, "Updated %d RealTime record%s.\n", res, ESS(res));
 
    return CLI_SUCCESS;
}

References a, ast_cli(), ast_update_realtime(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, ESS, NULL, SENTINEL, and ast_cli_entry::usage.

cli_realtime_update2()

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

static

Definition at line 116 of file res_realtime.c.

{
    int res = -1;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "realtime update2";
        e->usage =
            "Usage: realtime update2 <family> <colmatch> <valuematch> [... <colmatch5> <valuematch5>] NULL <colupdate> <newvalue>\n"
            "       Update a single variable, requiring one or more fields to match using the\n"
            "       RealTime driver. You must supply a family name, a column to update, a new\n"
            "       value, and at least one column and value to match.\n"
            "       Ex: realtime update2 sippeers name bobsphone ipaddr 127.0.0.1 NULL port 4343\n"
            "       will execute SQL as\n"
            "       UPDATE sippeers SET port='4343' WHERE name='bobsphone' and ipaddr='127.0.0.1'\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    /* Make sure we have the right number of arguments and that the required literal NULL
       is present */
    if (a->argc < 8 || a->argc > 16 || a->argc % 2
       || strcmp(a->argv[a->argc - 3], "NULL")) {
        return CLI_SHOWUSAGE;
    }
 
    if (a->argc == 8) {
        res = ast_update2_realtime(
            a->argv[2], a->argv[3], a->argv[4], SENTINEL,
            a->argv[6], a->argv[7], SENTINEL);
    } else if (a->argc == 10) {
        res = ast_update2_realtime(
            a->argv[2], a->argv[3], a->argv[4], a->argv[5],
            a->argv[6], SENTINEL,
            a->argv[8], a->argv[9], SENTINEL);
    } else if (a->argc == 12) {
        res = ast_update2_realtime(
            a->argv[2], a->argv[3], a->argv[4], a->argv[5],
            a->argv[6], a->argv[7], a->argv[8], SENTINEL,
            a->argv[10], a->argv[11], SENTINEL);
    } else if (a->argc == 14) {
        res = ast_update2_realtime(
            a->argv[2], a->argv[3], a->argv[4], a->argv[5],
            a->argv[6], a->argv[7], a->argv[8], a->argv[9],
            a->argv[10], SENTINEL,
            a->argv[12], a->argv[13], SENTINEL);
    } else if (a->argc == 16) {
        res = ast_update2_realtime(
            a->argv[2], a->argv[3], a->argv[4], a->argv[5],
            a->argv[6], a->argv[7], a->argv[8], a->argv[9],
            a->argv[10], a->argv[11], a->argv[12], SENTINEL,
            a->argv[14], a->argv[15], SENTINEL);
    }
 
    if (res < 0) {
        ast_cli(a->fd, "Failed to update. Check the debug log for possible SQL related entries.\n");
        return CLI_FAILURE;
    }
 
    ast_cli(a->fd, "Updated %d RealTime record%s.\n", res, ESS(res));
 
    return CLI_SUCCESS;
}

References a, ast_cli(), ast_update2_realtime(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, ESS, NULL, SENTINEL, and ast_cli_entry::usage.

load_module()

static int load_module ( void  )

static

Definition at line 282 of file res_realtime.c.

{
    ast_cli_register_multiple(cli_realtime, ARRAY_LEN(cli_realtime));
    return AST_MODULE_LOAD_SUCCESS;
}

References ARRAY_LEN, ast_cli_register_multiple, AST_MODULE_LOAD_SUCCESS, and cli_realtime.

unload_module()

static int unload_module ( void  )

static

Definition at line 276 of file res_realtime.c.

{
    ast_cli_unregister_multiple(cli_realtime, ARRAY_LEN(cli_realtime));
    return 0;
}

References ARRAY_LEN, ast_cli_unregister_multiple(), and cli_realtime.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Realtime Data Lookup/Rewrite" , .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, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static

Definition at line 288 of file res_realtime.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 288 of file res_realtime.c.

cli_realtime

struct ast_cli_entry cli_realtime[]

static

Definition at line 268 of file res_realtime.c.

Referenced by load_module(), and unload_module().