res_pjsip_cli.h File Reference

#include "asterisk/cli.h"

Include dependency graph for res_pjsip_cli.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ast_sip_cli_context
	CLI Formatter Context passed to all formatters. More...
struct	ast_sip_cli_formatter_entry
	CLI Formatter Registry Entry. More...

Macros
#define	CLI_DETAIL_FILLER   " "
#define	CLI_HEADER_FILLER   ".........................................................................................."
#define	CLI_INDENT_TO_SPACES(x)   ((x * 2) + 1 + CLI_MAX_TITLE_NAME)
#define	CLI_LAST_TABSTOP   62
#define	CLI_MAX_TITLE_NAME   8
#define	CLI_MAX_WIDTH   90

Functions
int	ast_sip_cli_print_sorcery_objectset (void *obj, void *arg, int flags)
	Prints a sorcery object's ast_variable list.
char *	ast_sip_cli_traverse_objects (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
struct ast_sip_cli_formatter_entry *	ast_sip_lookup_cli_formatter (const char *name)
	Looks up a CLI formatter by type.
int	ast_sip_register_cli_formatter (struct ast_sip_cli_formatter_entry *formatter)
	Registers a CLI formatter.
int	ast_sip_unregister_cli_formatter (struct ast_sip_cli_formatter_entry *formatter)
	Unregisters a CLI formatter.

Macro Definition Documentation

CLI_DETAIL_FILLER

#define CLI_DETAIL_FILLER   " "

Definition at line 25 of file res_pjsip_cli.h.

CLI_HEADER_FILLER

#define CLI_HEADER_FILLER   ".........................................................................................."

Definition at line 24 of file res_pjsip_cli.h.

CLI_INDENT_TO_SPACES

#define CLI_INDENT_TO_SPACES

(

x

)

((x * 2) + 1 + CLI_MAX_TITLE_NAME)

Definition at line 29 of file res_pjsip_cli.h.

CLI_LAST_TABSTOP

#define CLI_LAST_TABSTOP   62

Definition at line 27 of file res_pjsip_cli.h.

CLI_MAX_TITLE_NAME

#define CLI_MAX_TITLE_NAME   8

Definition at line 28 of file res_pjsip_cli.h.

CLI_MAX_WIDTH

#define CLI_MAX_WIDTH   90

Definition at line 26 of file res_pjsip_cli.h.

Function Documentation

ast_sip_cli_print_sorcery_objectset()

int ast_sip_cli_print_sorcery_objectset	(	void *	obj,
		void *	arg,
		int	flags
	)

Prints a sorcery object's ast_variable list.

Parameters

obj	The sorcery object
arg	The ast_sip_cli_context
flags

Return values

0	Success, non-zero on failure

Definition at line 36 of file pjsip_cli.c.

{
    struct ast_sip_cli_context *context = arg;
    struct ast_variable *i;
    int max_name_width = 13;
    int max_value_width = 14;
    int width;
    char *separator;
    struct ast_variable *objset;
 
    if (!context->output_buffer) {
        return -1;
    }
 
    objset = ast_sorcery_objectset_create(ast_sip_get_sorcery(),obj);
    if (!objset) {
        return -1;
    }
 
    for (i = objset; i; i = i->next) {
        if (i->name) {
            width = strlen(i->name);
            max_name_width = width > max_name_width ? width : max_name_width;
        }
        if (i->value) {
            width = strlen(i->value);
            max_value_width = width > max_value_width ? width : max_value_width;
        }
    }
 
    separator = ast_alloca(max_name_width + max_value_width + 8);
 
    memset(separator, '=', max_name_width + max_value_width + 3);
    separator[max_name_width + max_value_width + 3] = 0;
 
    ast_str_append(&context->output_buffer, 0, " %-*s : %s\n", max_name_width, "ParameterName", "ParameterValue");
    ast_str_append(&context->output_buffer, 0, " %s\n", separator);
 
    objset = ast_variable_list_sort(objset);
 
    for (i = objset; i; i = i->next) {
        ast_str_append(&context->output_buffer, 0, " %-*s : %s\n", max_name_width, i->name, i->value);
    }
 
    ast_variables_destroy(objset);
 
    return 0;
}

References ast_alloca, ast_sip_get_sorcery(), ast_sorcery_objectset_create, ast_str_append(), ast_variable_list_sort(), ast_variables_destroy(), ast_variable::name, ast_variable::next, and ast_variable::value.

Referenced by cli_aor_print_body(), cli_contact_print_body(), cli_endpoint_print_body(), cli_print_body(), cli_print_body(), cli_print_body(), cli_print_body(), sip_cli_print_global(), and sip_cli_print_system().

ast_sip_cli_traverse_objects()

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

Definition at line 109 of file pjsip_cli.c.

{
    RAII_VAR(struct ao2_container *, container, NULL, ao2_cleanup);
    RAII_VAR(struct ast_sip_cli_formatter_entry *, formatter_entry, NULL, ao2_cleanup);
    RAII_VAR(void *, object, NULL, ao2_cleanup);
    int is_container = 0;
    const char *cmd1;
    const char *cmd2;
    const char *object_id;
    char formatter_type[64];
    const char *regex;
 
    struct ast_sip_cli_context context = {
        .indent_level = 0,
        .show_details = 0,
        .show_details_only_level_0 = 0,
        .recurse = 0,
    };
 
    if (cmd == CLI_INIT) {
        return NULL;
    }
 
    cmd1 = e->cmda[1];
    cmd2 = e->cmda[2];
    object_id = a->argv[3];
 
    if (!ast_ends_with(cmd2, "s")) {
        ast_copy_string(formatter_type, cmd2, sizeof(formatter_type));
        is_container = 0;
    } else if (ast_ends_with(cmd2, "ies")) {
        /* Take the plural "ies" off of the object name and re[place with "y". */
        int l = strlen(cmd2);
        snprintf(formatter_type, 64, "%*.*sy", l - 3, l - 3, cmd2);
        is_container = 1;
    } else {
        /* Take the plural "s" off of the object name. */
        ast_copy_string(formatter_type, cmd2, strlen(cmd2));
        is_container = 1;
    }
 
    if (!strcmp(cmd1, "show")) {
        context.show_details_only_level_0 = !is_container;
        context.recurse = 1;
    } else {
        is_container = 1;
    }
 
    if (cmd != CLI_GENERATE
        && is_container
        && a->argc >= 4
        && strcmp(object_id, "like") == 0) {
        if (ast_strlen_zero(a->argv[4])) {
            return CLI_SHOWUSAGE;
        }
        regex = a->argv[4];
    } else {
        regex = "";
    }
 
    if (cmd == CLI_GENERATE
        && (is_container
            || a->argc > 4
            || (a->argc == 4 && ast_strlen_zero(a->word)))) {
        return CLI_SUCCESS;
    }
 
    context.output_buffer = ast_str_create(256);
    if (!context.output_buffer) {
        return CLI_FAILURE;
    }
 
    formatter_entry = ast_sip_lookup_cli_formatter(formatter_type);
    if (!formatter_entry) {
        ast_log(LOG_ERROR, "No formatter registered for object type %s.\n",
            formatter_type);
        ast_free(context.output_buffer);
        return CLI_FAILURE;
    }
    ast_str_append(&context.output_buffer, 0, "\n");
    formatter_entry->print_header(NULL, &context, 0);
    ast_str_append(&context.output_buffer, 0,
        "==========================================================================================\n\n");
 
    if (is_container || cmd == CLI_GENERATE) {
        container = formatter_entry->get_container(regex);
        if (!container) {
            ast_cli(a->fd, "No container returned for object type %s.\n",
                formatter_type);
            ast_free(context.output_buffer);
            return CLI_FAILURE;
        }
    }
 
    if (cmd == CLI_GENERATE) {
        ast_free(context.output_buffer);
        complete_show_sorcery_object(container, formatter_entry, a->word);
        return NULL;
    }
 
    if (is_container) {
        if (!ao2_container_count(container)) {
            ast_free(context.output_buffer);
            ast_cli(a->fd, "No objects found.\n\n");
            return CLI_SUCCESS;
        }
        ao2_callback(container, OBJ_NODATA, formatter_entry->print_body, &context);
        ast_str_append(&context.output_buffer, 0, "\nObjects found: %d\n", ao2_container_count(container));
 
    } else {
        if (ast_strlen_zero(object_id)) {
            ast_free(context.output_buffer);
            ast_cli(a->fd, "No object specified.\n");
            return CLI_FAILURE;
        }
 
        object = formatter_entry->retrieve_by_id(object_id);
        if (!object) {
            ast_free(context.output_buffer);
            ast_cli(a->fd, "Unable to find object %s.\n\n", object_id);
            return CLI_SUCCESS;
        }
        formatter_entry->print_body(object, &context, 0);
    }
 
    ast_str_append(&context.output_buffer, 0, "\n");
    dump_str_and_free(a->fd, context.output_buffer);
    return CLI_SUCCESS;
}

References a, ao2_callback, ao2_cleanup, ao2_container_count(), ast_cli(), ast_copy_string(), ast_ends_with(), ast_free, ast_log, ast_sip_lookup_cli_formatter(), ast_str_append(), ast_str_create, ast_strlen_zero(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::cmda, complete_show_sorcery_object(), container, dump_str_and_free(), LOG_ERROR, NULL, OBJ_NODATA, RAII_VAR, and regex().

Referenced by my_cli_traverse_objects(), and my_cli_traverse_objects().

ast_sip_lookup_cli_formatter()

struct ast_sip_cli_formatter_entry * ast_sip_lookup_cli_formatter

(

const char *

name

)

Looks up a CLI formatter by type.

Parameters

name	The name of the formatter, usually the sorcery object type.

Return values

Pointer

to formatter entry structure

Definition at line 305 of file pjsip_cli.c.

{
    return ao2_find(formatter_registry, name, OBJ_SEARCH_KEY | OBJ_NOLOCK);
}

References ao2_find, formatter_registry, name, OBJ_NOLOCK, and OBJ_SEARCH_KEY.

Referenced by ast_sip_cli_traverse_objects(), cli_aor_print_body(), cli_aor_print_header(), cli_endpoint_print_child_body(), and cli_endpoint_print_child_header().

ast_sip_register_cli_formatter()

int ast_sip_register_cli_formatter

(

struct ast_sip_cli_formatter_entry *

formatter

)

Registers a CLI formatter.

Parameters

formatter

An ao2_callback_fn that outputs the formatted data.

Return values

0	Success, non-zero on failure

Definition at line 310 of file pjsip_cli.c.

{
    ast_assert(formatter != NULL);
    ast_assert(formatter->name != NULL);
    ast_assert(formatter->print_body != NULL);
    ast_assert(formatter->print_header != NULL);
    ast_assert(formatter->get_container != NULL);
    ast_assert(formatter->iterate != NULL);
    ast_assert(formatter->get_id != NULL);
    ast_assert(formatter->retrieve_by_id != NULL);
 
    ao2_link(formatter_registry, formatter);
 
    return 0;
}

References ao2_link, ast_assert, formatter_registry, ast_sip_cli_formatter_entry::get_container, ast_sip_cli_formatter_entry::get_id, ast_sip_cli_formatter_entry::iterate, ast_sip_cli_formatter_entry::name, NULL, ast_sip_cli_formatter_entry::print_body, ast_sip_cli_formatter_entry::print_header, and ast_sip_cli_formatter_entry::retrieve_by_id.

Referenced by ast_res_pjsip_initialize_configuration(), ast_sip_initialize_distributor(), ast_sip_initialize_sorcery_auth(), ast_sip_initialize_sorcery_location(), ast_sip_initialize_sorcery_transport(), load_module(), load_module(), and pjsip_channel_cli_register().

ast_sip_unregister_cli_formatter()

int ast_sip_unregister_cli_formatter

(

struct ast_sip_cli_formatter_entry *

formatter

)

Unregisters a CLI formatter.

Parameters

formatter

The name of the formatter, usually the sorcery object type.

Return values

0	Success, non-zero on failure

Definition at line 326 of file pjsip_cli.c.

{
    if (formatter) {
        ao2_wrlock(formatter_registry);
        if (ao2_ref(formatter, -1) == 2) {
            ao2_unlink_flags(formatter_registry, formatter, OBJ_NOLOCK);
        }
        ao2_unlock(formatter_registry);
    }
    return 0;
}

References ao2_ref, ao2_unlink_flags, ao2_unlock, ao2_wrlock, formatter_registry, and OBJ_NOLOCK.

Referenced by ast_res_pjsip_destroy_configuration(), ast_sip_destroy_distributor(), ast_sip_destroy_sorcery_auth(), ast_sip_destroy_sorcery_location(), ast_sip_destroy_sorcery_transport(), pjsip_channel_cli_unregister(), unload_module(), and unload_module().