res_ari_events.c File Reference

WebSocket resource. More...

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

Include dependency graph for res_ari_events.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_events_user_event_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 /events/user/{eventName}.
int	ast_ari_events_user_event_parse_body (struct ast_json *body, struct ast_ari_events_user_event_args *args)
	Body parsing function for /events/user/{eventName}.
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 - WebSocket resource" , .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,res_http_websocket", }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct stasis_rest_handlers	events
	REST handler for /api-docs/events.json.
static struct stasis_rest_handlers	events_user
	REST handler for /api-docs/events.json.
static struct stasis_rest_handlers	events_user_eventName
	REST handler for /api-docs/events.json.

Detailed Description

WebSocket resource.

Author

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

Definition in file res_ari_events.c.

Macro Definition Documentation

MAX_VALS

#define MAX_VALS   128

Definition at line 52 of file res_ari_events.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 264 of file res_ari_events.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 264 of file res_ari_events.c.

ast_ari_events_user_event_cb()

static void ast_ari_events_user_event_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 /events/user/{eventName}.

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 105 of file res_ari_events.c.

{
    struct ast_ari_events_user_event_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, "application") == 0) {
            args.application = (i->value);
        } else
        if (strcmp(i->name, "source") == 0) {
            /* Parse comma separated list */
            char *vals[MAX_VALS];
            size_t j;
 
            args.source_parse = ast_strdup(i->value);
            if (!args.source_parse) {
                ast_ari_response_alloc_failed(response);
                goto fin;
            }
 
            if (strlen(args.source_parse) == 0) {
                /* ast_app_separate_args can't handle "" */
                args.source_count = 1;
                vals[0] = args.source_parse;
            } else {
                args.source_count = ast_app_separate_args(
                    args.source_parse, ',', vals,
                    ARRAY_LEN(vals));
            }
 
            if (args.source_count == 0) {
                ast_ari_response_alloc_failed(response);
                goto fin;
            }
 
            if (args.source_count >= MAX_VALS) {
                ast_ari_response_error(response, 400,
                    "Bad Request",
                    "Too many values for source");
                goto fin;
            }
 
            args.source = ast_malloc(sizeof(*args.source) * args.source_count);
            if (!args.source) {
                ast_ari_response_alloc_failed(response);
                goto fin;
            }
 
            for (j = 0; j < args.source_count; ++j) {
                args.source[j] = (vals[j]);
            }
        } else
        {}
    }
    for (i = path_vars; i; i = i->next) {
        if (strcmp(i->name, "eventName") == 0) {
            args.event_name = (i->value);
        } else
        {}
    }
    args.variables = body;
    ast_ari_events_user_event(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: /* Application does not exist. */
    case 422: /* Event source not found. */
    case 400: /* Invalid even tsource URI or userevent data. */
        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 /events/user/{eventName}\n", code);
            is_valid = 0;
        }
    }
 
    if (!is_valid) {
        ast_log(LOG_ERROR, "Response validation failed for /events/user/{eventName}\n");
        ast_ari_response_error(response, 500,
            "Internal Server Error", "Response validation failed");
    }
#endif /* AST_DEVMODE */
 
fin: __attribute__((unused))
    ast_free(args.source_parse);
    ast_free(args.source);
    return;
}

References args, ARRAY_LEN, ast_app_separate_args, ast_ari_events_user_event(), ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_validate_void(), 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_events_user_event_parse_body()

int ast_ari_events_user_event_parse_body	(	struct ast_json *	body,
		struct ast_ari_events_user_event_args *	args
	)

Body parsing function for /events/user/{eventName}.

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 54 of file res_ari_events.c.

{
    struct ast_json *field;
    /* Parse query parameters out of it */
    field = ast_json_object_get(body, "application");
    if (field) {
        args->application = ast_json_string_get(field);
    }
    field = ast_json_object_get(body, "source");
    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->source);
        if (ast_json_typeof(field) == AST_JSON_ARRAY) {
            /* Multiple param passed as array */
            size_t i;
            args->source_count = ast_json_array_size(field);
            args->source = ast_malloc(sizeof(*args->source) * args->source_count);
 
            if (!args->source) {
                return -1;
            }
 
            for (i = 0; i < args->source_count; ++i) {
                args->source[i] = ast_json_string_get(ast_json_array_get(field, i));
            }
        } else {
            /* Multiple param passed as single value */
            args->source_count = 1;
            args->source = ast_malloc(sizeof(*args->source) * args->source_count);
            if (!args->source) {
                return -1;
            }
            args->source[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_events_user_event().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 264 of file res_ari_events.c.

load_module()

static int load_module ( void  )

static

Definition at line 244 of file res_ari_events.c.

{
    int res = 0;
 
    events.is_websocket = 1;
 
    res |= ast_ari_add_handler(&events);
    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, events, stasis_rest_handlers::is_websocket, and unload_module().

unload_module()

static int unload_module ( void  )

static

Definition at line 238 of file res_ari_events.c.

{
    ast_ari_remove_handler(&events);
    return 0;
}

References ast_ari_remove_handler(), and events.

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 - WebSocket resource" , .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,res_http_websocket", }

static

Definition at line 264 of file res_ari_events.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 264 of file res_ari_events.c.

events

struct stasis_rest_handlers events

static

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

Definition at line 230 of file res_ari_events.c.

                                            {
    .path_segment = "events",
    .callbacks = {
    },
    .num_children = 1,
    .children = { &events_user, }
};

Referenced by load_module(), and unload_module().

events_user

struct stasis_rest_handlers events_user

static

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

Definition at line 222 of file res_ari_events.c.

                                                 {
    .path_segment = "user",
    .callbacks = {
    },
    .num_children = 1,
    .children = { &events_user_eventName, }
};

events_user_eventName

struct stasis_rest_handlers events_user_eventName

static

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

Definition at line 212 of file res_ari_events.c.

                                                           {
    .path_segment = "eventName",
    .is_wildcard = 1,
    .callbacks = {
        [AST_HTTP_POST] = ast_ari_events_user_event_cb,
    },
    .num_children = 0,
    .children = {  }
};