res_ari_sounds.c File Reference

Sound resources. More...

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

Include dependency graph for res_ari_sounds.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_sounds_get_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 /sounds/{soundId}.
static void	ast_ari_sounds_list_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 /sounds.
int	ast_ari_sounds_list_parse_body (struct ast_json *body, struct ast_ari_sounds_list_args *args)
	Body parsing function for /sounds.
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 - Sound resources" , .key = ASTERISK_GPL_KEY , .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	sounds
	REST handler for /api-docs/sounds.json.
static struct stasis_rest_handlers	sounds_soundId
	REST handler for /api-docs/sounds.json.

Detailed Description

Sound resources.

Author

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

Definition in file res_ari_sounds.c.

Macro Definition Documentation

MAX_VALS

#define MAX_VALS   128

Definition at line 51 of file res_ari_sounds.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 241 of file res_ari_sounds.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 241 of file res_ari_sounds.c.

ast_ari_sounds_get_cb()

static void ast_ari_sounds_get_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 /sounds/{soundId}.

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 145 of file res_ari_sounds.c.

{
    struct ast_ari_sounds_get_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, "soundId") == 0) {
            args.sound_id = (i->value);
        } else
        {}
    }
    ast_ari_sounds_get(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_sound(
                response->message);
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /sounds/{soundId}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /sounds/{soundId}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_response_error(), ast_ari_sounds_get(), ast_ari_validate_sound(), 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_sounds_list_cb()

static void ast_ari_sounds_list_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 /sounds.

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 79 of file res_ari_sounds.c.

{
    struct ast_ari_sounds_list_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, "lang") == 0) {
            args.lang = (i->value);
        } else
        if (strcmp(i->name, "format") == 0) {
            args.format = (i->value);
        } else
        {}
    }
    if (ast_ari_sounds_list_parse_body(body, &args)) {
        ast_ari_response_alloc_failed(response);
        goto fin;
    }
    ast_ari_sounds_list(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_sound_fn());
        } else {
            ast_log(LOG_ERROR, "Invalid error response %d for /sounds\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /sounds\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    return;
}

References args, ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_sounds_list(), ast_ari_sounds_list_parse_body(), ast_ari_validate_list(), ast_ari_validate_sound_fn(), 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_sounds_list_parse_body()

int ast_ari_sounds_list_parse_body	(	struct ast_json *	body,
		struct ast_ari_sounds_list_args *	args
	)

Body parsing function for /sounds.

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 53 of file res_ari_sounds.c.

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

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

Referenced by ast_ari_sounds_list_cb().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 241 of file res_ari_sounds.c.

load_module()

static int load_module ( void  )

static

Definition at line 222 of file res_ari_sounds.c.

{
    int res = 0;
 
 
    res |= ast_ari_add_handler(&sounds);
    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, sounds, and unload_module().

unload_module()

static int unload_module ( void  )

static

Definition at line 216 of file res_ari_sounds.c.

{
    ast_ari_remove_handler(&sounds);
    return 0;
}

References ast_ari_remove_handler(), and sounds.

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 - Sound resources" , .key = ASTERISK_GPL_KEY , .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 241 of file res_ari_sounds.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 241 of file res_ari_sounds.c.

sounds

struct stasis_rest_handlers sounds

static

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

Definition at line 207 of file res_ari_sounds.c.

                                            {
    .path_segment = "sounds",
    .callbacks = {
        [AST_HTTP_GET] = ast_ari_sounds_list_cb,
    },
    .num_children = 1,
    .children = { &sounds_soundId, }
};

Referenced by bridge_profile_sounds_alloc(), bridge_profile_sounds_destroy_cb(), bridge_template_handler(), load_module(), set_sound(), and unload_module().

sounds_soundId

struct stasis_rest_handlers sounds_soundId

static

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

Definition at line 197 of file res_ari_sounds.c.

                                                    {
    .path_segment = "soundId",
    .is_wildcard = 1,
    .callbacks = {
        [AST_HTTP_GET] = ast_ari_sounds_get_cb,
    },
    .num_children = 0,
    .children = {  }
};