res_ari_asterisk.c File Reference

Asterisk resources. More...

#include "asterisk.h"
#include "asterisk/app.h"
#include "asterisk/module.h"
#include "asterisk/stasis_app.h"
#include "ari/resource_asterisk.h"

Include dependency graph for res_ari_asterisk.c:

Go to the source code of this file.

Macros
#define	MAX_VALS   128

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
static void	ast_ari_asterisk_add_log_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/logging/{logChannelName}. More...
int	ast_ari_asterisk_add_log_parse_body (struct ast_json *body, struct ast_ari_asterisk_add_log_args *args)
	Body parsing function for /asterisk/logging/{logChannelName}. More...
static void	ast_ari_asterisk_delete_log_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/logging/{logChannelName}. More...
static void	ast_ari_asterisk_delete_object_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/config/dynamic/{configClass}/{objectType}/{id}. More...
static void	ast_ari_asterisk_get_global_var_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/variable. More...
int	ast_ari_asterisk_get_global_var_parse_body (struct ast_json *body, struct ast_ari_asterisk_get_global_var_args *args)
	Body parsing function for /asterisk/variable. More...
static void	ast_ari_asterisk_get_info_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/info. More...
int	ast_ari_asterisk_get_info_parse_body (struct ast_json *body, struct ast_ari_asterisk_get_info_args *args)
	Body parsing function for /asterisk/info. More...
static void	ast_ari_asterisk_get_module_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/modules/{moduleName}. More...
static void	ast_ari_asterisk_get_object_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/config/dynamic/{configClass}/{objectType}/{id}. More...
static void	ast_ari_asterisk_list_log_channels_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/logging. More...
static void	ast_ari_asterisk_list_modules_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/modules. More...
static void	ast_ari_asterisk_load_module_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/modules/{moduleName}. More...
static void	ast_ari_asterisk_ping_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/ping. More...
static void	ast_ari_asterisk_reload_module_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/modules/{moduleName}. More...
static void	ast_ari_asterisk_rotate_log_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/logging/{logChannelName}/rotate. More...
static void	ast_ari_asterisk_set_global_var_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/variable. More...
int	ast_ari_asterisk_set_global_var_parse_body (struct ast_json *body, struct ast_ari_asterisk_set_global_var_args *args)
	Body parsing function for /asterisk/variable. More...
static void	ast_ari_asterisk_unload_module_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/modules/{moduleName}. More...
static void	ast_ari_asterisk_update_object_cb (struct ast_tcptls_session_instance *ser, struct ast_variable *get_params, struct ast_variable *path_vars, struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
	Parameter parsing callback for /asterisk/config/dynamic/{configClass}/{objectType}/{id}. More...
int	ast_ari_asterisk_update_object_parse_body (struct ast_json *body, struct ast_ari_asterisk_update_object_args *args)
	Body parsing function for /asterisk/config/dynamic/{configClass}/{objectType}/{id}. More...
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	load_module (void)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "RESTful API module - Asterisk resources" , .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, .requires = "res_ari,res_ari_model,res_stasis", }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct stasis_rest_handlers	asterisk
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_config
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_config_dynamic
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_config_dynamic_configClass
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_config_dynamic_configClass_objectType
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_config_dynamic_configClass_objectType_id
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_info
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_logging
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_logging_logChannelName
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_logging_logChannelName_rotate
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_modules
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_modules_moduleName
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_ping
	REST handler for /api-docs/asterisk.json. More...
static struct stasis_rest_handlers	asterisk_variable
	REST handler for /api-docs/asterisk.json. More...

Detailed Description

Asterisk resources.

Author

David M. Lee, II dlee@.nosp@m.digi.nosp@m.um.co.nosp@m.m

Definition in file res_ari_asterisk.c.

Macro Definition Documentation

MAX_VALS

#define MAX_VALS   128

Definition at line 51 of file res_ari_asterisk.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 1330 of file res_ari_asterisk.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 1330 of file res_ari_asterisk.c.

ast_ari_asterisk_add_log_cb()

static void ast_ari_asterisk_add_log_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/logging/{logChannelName}.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 827 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_add_log_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = get_params; i; i = i->next) {
        if (strcmp(i->name, "configuration") == 0) {
            args.configuration = (i->value);
        } else
        {}
    }
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "logChannelName") == 0) {
            args.log_channel_name = (i->value);
        } else
        {}
    }
    if (ast_ari_asterisk_add_log_parse_body(body, &args)) {
        ast_ari_response_alloc_failed(response);
        goto fin;
    }
    ast_ari_asterisk_add_log(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 400: /* Bad request body */
    case 409: /* Log channel could not be created. */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_void(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/logging/{logChannelName}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/logging/{logChannelName}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_add_log(), ast_ari_asterisk_add_log_parse_body(), ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_validate_void(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_add_log_parse_body()

int ast_ari_asterisk_add_log_parse_body	(	struct ast_json *	body,
		struct ast_ari_asterisk_add_log_args *	args
	)

Body parsing function for /asterisk/logging/{logChannelName}.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 805 of file res_ari_asterisk.c.

{
    struct ast_json *field;
    /* Parse query parameters out of it */
    field = ast_json_object_get(body, "configuration");
    if (field) {
        args->configuration = ast_json_string_get(field);
    }
    return 0;
}

References args, ast_json_object_get(), and ast_json_string_get().

Referenced by ast_ari_asterisk_add_log_cb().

ast_ari_asterisk_delete_log_cb()

static void ast_ari_asterisk_delete_log_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/logging/{logChannelName}.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 898 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_delete_log_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "logChannelName") == 0) {
            args.log_channel_name = (i->value);
        } else
        {}
    }
    ast_ari_asterisk_delete_log(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 404: /* Log channel does not exist. */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_void(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/logging/{logChannelName}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/logging/{logChannelName}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_delete_log(), ast_ari_response_error(), ast_ari_validate_void(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_delete_object_cb()

static void ast_ari_asterisk_delete_object_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/config/dynamic/{configClass}/{objectType}/{id}.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 205 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_delete_object_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "configClass") == 0) {
            args.config_class = (i->value);
        } else
        if (strcmp(i->name, "objectType") == 0) {
            args.object_type = (i->value);
        } else
        if (strcmp(i->name, "id") == 0) {
            args.id = (i->value);
        } else
        {}
    }
    ast_ari_asterisk_delete_object(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 403: /* Could not delete object */
    case 404: /* {configClass|objectType|id} not found */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_void(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/config/dynamic/{configClass}/{objectType}/{id}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/config/dynamic/{configClass}/{objectType}/{id}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_delete_object(), ast_ari_response_error(), ast_ari_validate_void(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_get_global_var_cb()

static void ast_ari_asterisk_get_global_var_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/variable.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 1031 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_get_global_var_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = get_params; i; i = i->next) {
        if (strcmp(i->name, "variable") == 0) {
            args.variable = (i->value);
        } else
        {}
    }
    if (ast_ari_asterisk_get_global_var_parse_body(body, &args)) {
        ast_ari_response_alloc_failed(response);
        goto fin;
    }
    ast_ari_asterisk_get_global_var(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 400: /* Missing variable parameter. */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_variable(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/variable\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/variable\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_get_global_var(), ast_ari_asterisk_get_global_var_parse_body(), ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_validate_variable(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_get_global_var_parse_body()

int ast_ari_asterisk_get_global_var_parse_body	(	struct ast_json *	body,
		struct ast_ari_asterisk_get_global_var_args *	args
	)

Body parsing function for /asterisk/variable.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 1009 of file res_ari_asterisk.c.

{
    struct ast_json *field;
    /* Parse query parameters out of it */
    field = ast_json_object_get(body, "variable");
    if (field) {
        args->variable = ast_json_string_get(field);
    }
    return 0;
}

References args, ast_json_object_get(), and ast_json_string_get().

Referenced by ast_ari_asterisk_get_global_var_cb().

ast_ari_asterisk_get_info_cb()

static void ast_ari_asterisk_get_info_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/info.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 310 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_get_info_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = get_params; i; i = i->next) {
        if (strcmp(i->name, "only") == 0) {
            /* Parse comma separated list */
            char *vals[MAX_VALS];
            size_t j;
 
            args.only_parse = ast_strdup(i->value);
            if (!args.only_parse) {
                ast_ari_response_alloc_failed(response);
                goto fin;
            }
 
            if (strlen(args.only_parse) == 0) {
                /* ast_app_separate_args can't handle "" */
                args.only_count = 1;
                vals[0] = args.only_parse;
            } else {
                args.only_count = ast_app_separate_args(
                    args.only_parse, ',', vals,
                    ARRAY_LEN(vals));
            }
 
            if (args.only_count == 0) {
                ast_ari_response_alloc_failed(response);
                goto fin;
            }
 
            if (args.only_count >= MAX_VALS) {
                ast_ari_response_error(response, 400,
                    "Bad Request",
                    "Too many values for only");
                goto fin;
            }
 
            args.only = ast_malloc(sizeof(*args.only) * args.only_count);
            if (!args.only) {
                ast_ari_response_alloc_failed(response);
                goto fin;
            }
 
            for (j = 0; j < args.only_count; ++j) {
                args.only[j] = (vals[j]);
            }
        } else
        {}
    }
    if (ast_ari_asterisk_get_info_parse_body(body, &args)) {
        ast_ari_response_alloc_failed(response);
        goto fin;
    }
    ast_ari_asterisk_get_info(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_asterisk_info(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/info\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/info\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    ast_free(args.only_parse);
    ast_free(args.only);
    return;
}

References args, ARRAY_LEN, ast_app_separate_args, ast_ari_asterisk_get_info(), ast_ari_asterisk_get_info_parse_body(), ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_validate_asterisk_info(), ast_free, ast_log, ast_malloc, ast_strdup, LOG_ERROR, MAX_VALS, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_get_info_parse_body()

int ast_ari_asterisk_get_info_parse_body	(	struct ast_json *	body,
		struct ast_ari_asterisk_get_info_args *	args
	)

Body parsing function for /asterisk/info.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 263 of file res_ari_asterisk.c.

{
    struct ast_json *field;
    /* Parse query parameters out of it */
    field = ast_json_object_get(body, "only");
    if (field) {
        /* If they were silly enough to both pass in a query param and a
         * JSON body, free up the query value.
         */
        ast_free(args->only);
        if (ast_json_typeof(field) == AST_JSON_ARRAY) {
            /* Multiple param passed as array */
            size_t i;
            args->only_count = ast_json_array_size(field);
            args->only = ast_malloc(sizeof(*args->only) * args->only_count);
 
            if (!args->only) {
                return -1;
            }
 
            for (i = 0; i < args->only_count; ++i) {
                args->only[i] = ast_json_string_get(ast_json_array_get(field, i));
            }
        } else {
            /* Multiple param passed as single value */
            args->only_count = 1;
            args->only = ast_malloc(sizeof(*args->only) * args->only_count);
            if (!args->only) {
                return -1;
            }
            args->only[0] = ast_json_string_get(field);
        }
    }
    return 0;
}

References args, ast_free, AST_JSON_ARRAY, ast_json_array_get(), ast_json_array_size(), ast_json_object_get(), ast_json_string_get(), ast_json_typeof(), and ast_malloc.

Referenced by ast_ari_asterisk_get_info_cb().

ast_ari_asterisk_get_module_cb()

static void ast_ari_asterisk_get_module_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/modules/{moduleName}.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 519 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_get_module_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "moduleName") == 0) {
            args.module_name = (i->value);
        } else
        {}
    }
    ast_ari_asterisk_get_module(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 404: /* Module could not be found in running modules. */
    case 409: /* Module information could not be retrieved. */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_module(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/modules/{moduleName}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/modules/{moduleName}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_get_module(), ast_ari_response_error(), ast_ari_validate_module(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_get_object_cb()

static void ast_ari_asterisk_get_object_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/config/dynamic/{configClass}/{objectType}/{id}.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 62 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_get_object_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "configClass") == 0) {
            args.config_class = (i->value);
        } else
        if (strcmp(i->name, "objectType") == 0) {
            args.object_type = (i->value);
        } else
        if (strcmp(i->name, "id") == 0) {
            args.id = (i->value);
        } else
        {}
    }
    ast_ari_asterisk_get_object(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 404: /* {configClass|objectType|id} not found */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_list(response->message,
                ast_ari_validate_config_tuple_fn());
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/config/dynamic/{configClass}/{objectType}/{id}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/config/dynamic/{configClass}/{objectType}/{id}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_get_object(), ast_ari_response_error(), ast_ari_validate_config_tuple_fn(), ast_ari_validate_list(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_list_log_channels_cb()

static void ast_ari_asterisk_list_log_channels_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/logging.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 762 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_list_log_channels_args args = {};
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    ast_ari_asterisk_list_log_channels(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_list(response->message,
                ast_ari_validate_log_channel_fn());
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/logging\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/logging\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_list_log_channels(), ast_ari_response_error(), ast_ari_validate_list(), ast_ari_validate_log_channel_fn(), ast_log, LOG_ERROR, ast_ari_response::message, NULL, and ast_ari_response::response_code.

ast_ari_asterisk_list_modules_cb()

static void ast_ari_asterisk_list_modules_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/modules.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 467 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_list_modules_args args = {};
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    ast_ari_asterisk_list_modules(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_list(response->message,
                ast_ari_validate_module_fn());
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/modules\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/modules\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_list_modules(), ast_ari_response_error(), ast_ari_validate_list(), ast_ari_validate_module_fn(), ast_log, LOG_ERROR, ast_ari_response::message, NULL, and ast_ari_response::response_code.

ast_ari_asterisk_load_module_cb()

static void ast_ari_asterisk_load_module_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/modules/{moduleName}.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 580 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_load_module_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "moduleName") == 0) {
            args.module_name = (i->value);
        } else
        {}
    }
    ast_ari_asterisk_load_module(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 409: /* Module could not be loaded. */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_void(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/modules/{moduleName}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/modules/{moduleName}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_load_module(), ast_ari_response_error(), ast_ari_validate_void(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_ping_cb()

static void ast_ari_asterisk_ping_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/ping.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 415 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_ping_args args = {};
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    ast_ari_asterisk_ping(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_asterisk_ping(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/ping\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/ping\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_ping(), ast_ari_response_error(), ast_ari_validate_asterisk_ping(), ast_log, LOG_ERROR, ast_ari_response::message, NULL, and ast_ari_response::response_code.

ast_ari_asterisk_reload_module_cb()

static void ast_ari_asterisk_reload_module_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/modules/{moduleName}.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 701 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_reload_module_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "moduleName") == 0) {
            args.module_name = (i->value);
        } else
        {}
    }
    ast_ari_asterisk_reload_module(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 404: /* Module not found in running modules. */
    case 409: /* Module could not be reloaded. */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_void(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/modules/{moduleName}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/modules/{moduleName}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_reload_module(), ast_ari_response_error(), ast_ari_validate_void(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_rotate_log_cb()

static void ast_ari_asterisk_rotate_log_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/logging/{logChannelName}/rotate.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 958 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_rotate_log_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "logChannelName") == 0) {
            args.log_channel_name = (i->value);
        } else
        {}
    }
    ast_ari_asterisk_rotate_log(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 404: /* Log channel does not exist. */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_void(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/logging/{logChannelName}/rotate\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/logging/{logChannelName}/rotate\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_rotate_log(), ast_ari_response_error(), ast_ari_validate_void(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_set_global_var_cb()

static void ast_ari_asterisk_set_global_var_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/variable.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 1112 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_set_global_var_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = get_params; i; i = i->next) {
        if (strcmp(i->name, "variable") == 0) {
            args.variable = (i->value);
        } else
        if (strcmp(i->name, "value") == 0) {
            args.value = (i->value);
        } else
        {}
    }
    if (ast_ari_asterisk_set_global_var_parse_body(body, &args)) {
        ast_ari_response_alloc_failed(response);
        goto fin;
    }
    ast_ari_asterisk_set_global_var(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 400: /* Missing variable parameter. */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_void(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/variable\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/variable\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_set_global_var(), ast_ari_asterisk_set_global_var_parse_body(), ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_validate_void(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_set_global_var_parse_body()

int ast_ari_asterisk_set_global_var_parse_body	(	struct ast_json *	body,
		struct ast_ari_asterisk_set_global_var_args *	args
	)

Body parsing function for /asterisk/variable.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 1086 of file res_ari_asterisk.c.

{
    struct ast_json *field;
    /* Parse query parameters out of it */
    field = ast_json_object_get(body, "variable");
    if (field) {
        args->variable = ast_json_string_get(field);
    }
    field = ast_json_object_get(body, "value");
    if (field) {
        args->value = ast_json_string_get(field);
    }
    return 0;
}

References args, ast_json_object_get(), and ast_json_string_get().

Referenced by ast_ari_asterisk_set_global_var_cb().

ast_ari_asterisk_unload_module_cb()

static void ast_ari_asterisk_unload_module_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/modules/{moduleName}.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 640 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_unload_module_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "moduleName") == 0) {
            args.module_name = (i->value);
        } else
        {}
    }
    ast_ari_asterisk_unload_module(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 404: /* Module not found in running modules. */
    case 409: /* Module could not be unloaded. */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_void(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/modules/{moduleName}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/modules/{moduleName}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_unload_module(), ast_ari_response_error(), ast_ari_validate_void(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_update_object_cb()

static void ast_ari_asterisk_update_object_cb ( struct ast_tcptls_session_instance *  ser, struct ast_variable *  get_params, struct ast_variable *  path_vars, struct ast_variable *  headers, struct ast_json *  body, struct ast_ari_response *  response  )

static

Parameter parsing callback for /asterisk/config/dynamic/{configClass}/{objectType}/{id}.

Parameters

	ser	TCP/TLS session object
	get_params	GET parameters in the HTTP request.
	path_vars	Path variables extracted from the request.
	headers	HTTP headers.
	body
[out]	response	Response to the HTTP request.

Definition at line 136 of file res_ari_asterisk.c.

{
    struct ast_ari_asterisk_update_object_args args = {};
    struct ast_variable *i;
#if defined(AST_DEVMODE)
    int is_valid;
    int code;
#endif /* AST_DEVMODE */
 
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "configClass") == 0) {
            args.config_class = (i->value);
        } else
        if (strcmp(i->name, "objectType") == 0) {
            args.object_type = (i->value);
        } else
        if (strcmp(i->name, "id") == 0) {
            args.id = (i->value);
        } else
        {}
    }
    args.fields = body;
    ast_ari_asterisk_update_object(headers, &args, response);
#if defined(AST_DEVMODE)
    code = response->response_code;
 
    switch (code) {
    case 0: /* Implementation is still a stub, or the code wasn't set */
        is_valid = response->message == NULL;
        break;
    case 500: /* Internal Server Error */
    case 501: /* Not Implemented */
    case 400: /* Bad request body */
    case 403: /* Could not create or update object */
    case 404: /* {configClass|objectType} not found */
        is_valid = 1;
        break;
    default:
        if (200 <= code && code <= 299) {
            is_valid = ast_ari_validate_list(response->message,
                ast_ari_validate_config_tuple_fn());
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/config/dynamic/{configClass}/{objectType}/{id}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /asterisk/config/dynamic/{configClass}/{objectType}/{id}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_asterisk_update_object(), ast_ari_response_error(), ast_ari_validate_config_tuple_fn(), ast_ari_validate_list(), ast_log, LOG_ERROR, ast_ari_response::message, ast_variable::name, ast_variable::next, NULL, ast_ari_response::response_code, and ast_variable::value.

ast_ari_asterisk_update_object_parse_body()

int ast_ari_asterisk_update_object_parse_body	(	struct ast_json *	body,
		struct ast_ari_asterisk_update_object_args *	args
	)

Body parsing function for /asterisk/config/dynamic/{configClass}/{objectType}/{id}.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 119 of file res_ari_asterisk.c.

{
    /* Parse query parameters out of it */
    return 0;
}

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 1330 of file res_ari_asterisk.c.

load_module()

static int load_module ( void  )

static

Definition at line 1311 of file res_ari_asterisk.c.

{
    int res = 0;
 
 
    res |= ast_ari_add_handler(&asterisk);
    if (res) {
        unload_module();
        return AST_MODULE_LOAD_DECLINE;
    }
 
    return AST_MODULE_LOAD_SUCCESS;
}

References ast_ari_add_handler(), AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, asterisk, and unload_module().

unload_module()

static int unload_module ( void  )

static

Definition at line 1305 of file res_ari_asterisk.c.

{
    ast_ari_remove_handler(&asterisk);
    return 0;
}

References ast_ari_remove_handler(), and asterisk.

Referenced by load_module().

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "RESTful API module - Asterisk resources" , .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, .requires = "res_ari,res_ari_model,res_stasis", }

static

Definition at line 1330 of file res_ari_asterisk.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 1330 of file res_ari_asterisk.c.

asterisk

struct stasis_rest_handlers asterisk

static

REST handler for /api-docs/asterisk.json.

Definition at line 1297 of file res_ari_asterisk.c.

Referenced by load_module(), and unload_module().

asterisk_config

struct stasis_rest_handlers asterisk_config

static

REST handler for /api-docs/asterisk.json.

Definition at line 1210 of file res_ari_asterisk.c.

asterisk_config_dynamic

struct stasis_rest_handlers asterisk_config_dynamic

static

REST handler for /api-docs/asterisk.json.

Definition at line 1202 of file res_ari_asterisk.c.

asterisk_config_dynamic_configClass

struct stasis_rest_handlers asterisk_config_dynamic_configClass

static

REST handler for /api-docs/asterisk.json.

Definition at line 1193 of file res_ari_asterisk.c.

asterisk_config_dynamic_configClass_objectType

struct stasis_rest_handlers asterisk_config_dynamic_configClass_objectType

static

REST handler for /api-docs/asterisk.json.

Definition at line 1184 of file res_ari_asterisk.c.

asterisk_config_dynamic_configClass_objectType_id

struct stasis_rest_handlers asterisk_config_dynamic_configClass_objectType_id

static

REST handler for /api-docs/asterisk.json.

Definition at line 1172 of file res_ari_asterisk.c.

asterisk_info

struct stasis_rest_handlers asterisk_info

static

REST handler for /api-docs/asterisk.json.

Definition at line 1218 of file res_ari_asterisk.c.

asterisk_logging

struct stasis_rest_handlers asterisk_logging

static

REST handler for /api-docs/asterisk.json.

Definition at line 1278 of file res_ari_asterisk.c.

asterisk_logging_logChannelName

struct stasis_rest_handlers asterisk_logging_logChannelName

static

REST handler for /api-docs/asterisk.json.

Definition at line 1267 of file res_ari_asterisk.c.

asterisk_logging_logChannelName_rotate

struct stasis_rest_handlers asterisk_logging_logChannelName_rotate

static

REST handler for /api-docs/asterisk.json.

Definition at line 1258 of file res_ari_asterisk.c.

asterisk_modules

struct stasis_rest_handlers asterisk_modules

static

REST handler for /api-docs/asterisk.json.

Definition at line 1249 of file res_ari_asterisk.c.

asterisk_modules_moduleName

struct stasis_rest_handlers asterisk_modules_moduleName

static

REST handler for /api-docs/asterisk.json.

Definition at line 1236 of file res_ari_asterisk.c.

asterisk_ping

struct stasis_rest_handlers asterisk_ping

static

REST handler for /api-docs/asterisk.json.

Definition at line 1227 of file res_ari_asterisk.c.

asterisk_variable

struct stasis_rest_handlers asterisk_variable

static

REST handler for /api-docs/asterisk.json.

Definition at line 1287 of file res_ari_asterisk.c.