resource_endpoints.c File Reference

/api-docs/endpoints.{format} implementation- Endpoint resources More...

#include "asterisk.h"
#include "resource_endpoints.h"
#include "asterisk/astobj2.h"
#include "asterisk/stasis.h"
#include "asterisk/stasis_app.h"
#include "asterisk/stasis_endpoints.h"
#include "asterisk/channel.h"
#include "asterisk/message.h"
#include "asterisk/refer.h"

Include dependency graph for resource_endpoints.c:

Go to the source code of this file.

Functions
void	ast_ari_endpoints_get (struct ast_variable *headers, struct ast_ari_endpoints_get_args *args, struct ast_ari_response *response)
	Details for an endpoint.
void	ast_ari_endpoints_list (struct ast_variable *headers, struct ast_ari_endpoints_list_args *args, struct ast_ari_response *response)
	List all endpoints.
void	ast_ari_endpoints_list_by_tech (struct ast_variable *headers, struct ast_ari_endpoints_list_by_tech_args *args, struct ast_ari_response *response)
	List available endoints for a given endpoint technology.
void	ast_ari_endpoints_refer (struct ast_variable *headers, struct ast_ari_endpoints_refer_args *args, struct ast_ari_response *response)
	Refer an endpoint or technology URI to some technology URI or endpoint.
void	ast_ari_endpoints_refer_to_endpoint (struct ast_variable *headers, struct ast_ari_endpoints_refer_to_endpoint_args *args, struct ast_ari_response *response)
	Refer an endpoint or technology URI to some technology URI or endpoint.
void	ast_ari_endpoints_send_message (struct ast_variable *headers, struct ast_ari_endpoints_send_message_args *args, struct ast_ari_response *response)
	Send a message to some technology URI or endpoint.
void	ast_ari_endpoints_send_message_to_endpoint (struct ast_variable *headers, struct ast_ari_endpoints_send_message_to_endpoint_args *args, struct ast_ari_response *response)
	Send a message to some endpoint in a technology.
static int	json_to_ast_variables (struct ast_ari_response *response, struct ast_json *json_variables, struct ast_variable **variables)
static int	parse_refer_json (struct ast_json *body, struct ast_ari_response *response, struct ast_variable **variables)
static void	send_message (const char *to, const char *from, const char *body, struct ast_variable *variables, struct ast_ari_response *response)
static void	send_refer (const char *to, const char *from, const char *refer_to, int to_self, struct ast_variable *variables, struct ast_ari_response *response)

Detailed Description

/api-docs/endpoints.{format} implementation- Endpoint resources

Author

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

Definition in file resource_endpoints.c.

Function Documentation

ast_ari_endpoints_get()

void ast_ari_endpoints_get	(	struct ast_variable *	headers,
		struct ast_ari_endpoints_get_args *	args,
		struct ast_ari_response *	response
	)

Details for an endpoint.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 154 of file resource_endpoints.c.

{
    struct ast_json *json;
    RAII_VAR(struct ast_endpoint_snapshot *, snapshot, NULL, ao2_cleanup);
 
    snapshot = ast_endpoint_latest_snapshot(args->tech, args->resource);
    if (!snapshot) {
        ast_ari_response_error(response, 404, "Not Found",
            "Endpoint not found");
        return;
    }
 
    json = ast_endpoint_snapshot_to_json(snapshot, stasis_app_get_sanitizer());
    if (!json) {
        ast_ari_response_alloc_failed(response);
        return;
    }
 
    ast_ari_response_ok(response, json);
}

References ao2_cleanup, args, ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_response_ok(), ast_endpoint_latest_snapshot(), ast_endpoint_snapshot_to_json(), NULL, RAII_VAR, and stasis_app_get_sanitizer().

Referenced by ast_ari_endpoints_get_cb().

ast_ari_endpoints_list()

void ast_ari_endpoints_list	(	struct ast_variable *	headers,
		struct ast_ari_endpoints_list_args *	args,
		struct ast_ari_response *	response
	)

List all endpoints.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 38 of file resource_endpoints.c.

{
    RAII_VAR(struct stasis_cache *, cache, NULL, ao2_cleanup);
    RAII_VAR(struct ao2_container *, snapshots, NULL, ao2_cleanup);
    RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
    struct ao2_iterator i;
    void *obj;
 
    cache = ast_endpoint_cache();
    if (!cache) {
        ast_ari_response_error(
            response, 500, "Internal Server Error",
            "Message bus not initialized");
        return;
    }
    ao2_ref(cache, +1);
 
    snapshots = stasis_cache_dump(cache, ast_endpoint_snapshot_type());
    if (!snapshots) {
        ast_ari_response_alloc_failed(response);
        return;
    }
 
    json = ast_json_array_create();
    if (!json) {
        ast_ari_response_alloc_failed(response);
        return;
    }
 
    i = ao2_iterator_init(snapshots, 0);
    while ((obj = ao2_iterator_next(&i))) {
        RAII_VAR(struct stasis_message *, msg, obj, ao2_cleanup);
        struct ast_endpoint_snapshot *snapshot = stasis_message_data(msg);
        struct ast_json *json_endpoint = ast_endpoint_snapshot_to_json(snapshot, stasis_app_get_sanitizer());
 
        if (!json_endpoint || ast_json_array_append(json, json_endpoint)) {
            ao2_iterator_destroy(&i);
            ast_ari_response_alloc_failed(response);
            return;
        }
    }
    ao2_iterator_destroy(&i);
 
    ast_ari_response_ok(response, ast_json_ref(json));
}

References ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_response_ok(), ast_endpoint_cache(), ast_endpoint_snapshot_to_json(), ast_endpoint_snapshot_type(), ast_json_array_append(), ast_json_array_create(), ast_json_ref(), ast_json_unref(), cache, NULL, RAII_VAR, stasis_app_get_sanitizer(), stasis_cache_dump(), and stasis_message_data().

Referenced by ast_ari_endpoints_list_cb().

ast_ari_endpoints_list_by_tech()

void ast_ari_endpoints_list_by_tech	(	struct ast_variable *	headers,
		struct ast_ari_endpoints_list_by_tech_args *	args,
		struct ast_ari_response *	response
	)

List available endoints for a given endpoint technology.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 86 of file resource_endpoints.c.

{
    RAII_VAR(struct stasis_cache *, cache, NULL, ao2_cleanup);
    RAII_VAR(struct ao2_container *, snapshots, NULL, ao2_cleanup);
    RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
    struct ast_endpoint *tech_endpoint;
    struct ao2_iterator i;
    void *obj;
 
    tech_endpoint = ast_endpoint_find_by_id(args->tech);
    if (!tech_endpoint) {
        ast_ari_response_error(response, 404, "Not Found",
                       "No Endpoints found - invalid tech %s", args->tech);
        return;
    }
    ao2_ref(tech_endpoint, -1);
 
    cache = ast_endpoint_cache();
    if (!cache) {
        ast_ari_response_error(
            response, 500, "Internal Server Error",
            "Message bus not initialized");
        return;
    }
    ao2_ref(cache, +1);
 
    snapshots = stasis_cache_dump(cache, ast_endpoint_snapshot_type());
    if (!snapshots) {
        ast_ari_response_alloc_failed(response);
        return;
    }
 
    json = ast_json_array_create();
    if (!json) {
        ast_ari_response_alloc_failed(response);
        return;
    }
 
    i = ao2_iterator_init(snapshots, 0);
    while ((obj = ao2_iterator_next(&i))) {
        RAII_VAR(struct stasis_message *, msg, obj, ao2_cleanup);
        struct ast_endpoint_snapshot *snapshot = stasis_message_data(msg);
        struct ast_json *json_endpoint;
        int r;
 
        if (strcasecmp(args->tech, snapshot->tech) != 0) {
            continue;
        }
 
        json_endpoint = ast_endpoint_snapshot_to_json(snapshot, stasis_app_get_sanitizer());
        if (!json_endpoint) {
            continue;
        }
 
        r = ast_json_array_append(
            json, json_endpoint);
        if (r != 0) {
            ao2_iterator_destroy(&i);
            ast_ari_response_alloc_failed(response);
            return;
        }
    }
    ao2_iterator_destroy(&i);
    ast_ari_response_ok(response, ast_json_ref(json));
}

References ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, args, ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_response_ok(), ast_endpoint_cache(), ast_endpoint_find_by_id(), ast_endpoint_snapshot_to_json(), ast_endpoint_snapshot_type(), ast_json_array_append(), ast_json_array_create(), ast_json_ref(), ast_json_unref(), cache, NULL, RAII_VAR, stasis_app_get_sanitizer(), stasis_cache_dump(), stasis_message_data(), and ast_endpoint_snapshot::tech.

Referenced by ast_ari_endpoints_list_by_tech_cb().

ast_ari_endpoints_refer()

void ast_ari_endpoints_refer	(	struct ast_variable *	headers,
		struct ast_ari_endpoints_refer_args *	args,
		struct ast_ari_response *	response
	)

Refer an endpoint or technology URI to some technology URI or endpoint.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 398 of file resource_endpoints.c.

{
    struct ast_variable *variables = NULL;
 
    ast_ari_endpoints_refer_parse_body(args->variables, args);
 
    if (parse_refer_json(args->variables, response, &variables)) {
        return;
    }
 
    send_refer(args->to, args->from, args->refer_to, args->to_self, variables, response);
    ast_variables_destroy(variables);
}

References args, ast_ari_endpoints_refer_parse_body(), ast_variables_destroy(), NULL, parse_refer_json(), and send_refer().

Referenced by ast_ari_endpoints_refer_cb().

ast_ari_endpoints_refer_to_endpoint()

void ast_ari_endpoints_refer_to_endpoint	(	struct ast_variable *	headers,
		struct ast_ari_endpoints_refer_to_endpoint_args *	args,
		struct ast_ari_response *	response
	)

Refer an endpoint or technology URI to some technology URI or endpoint.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 414 of file resource_endpoints.c.

{
    struct ast_variable *variables = NULL;
    struct ast_endpoint_snapshot *snapshot;
    char to[128];
    char *tech = ast_strdupa(args->tech);
 
    /* Really, we just want to know if this thing exists */
    snapshot = ast_endpoint_latest_snapshot(args->tech, args->resource);
    if (!snapshot) {
        ast_ari_response_error(response, 404, "Not Found",
            "Endpoint not found");
        return;
    }
    ao2_ref(snapshot, -1);
 
    ast_ari_endpoints_refer_to_endpoint_parse_body(args->variables, args);
 
    if (parse_refer_json(args->variables, response, &variables)) {
        return;
    }
 
    snprintf(to, sizeof(to), "%s:%s", ast_str_to_lower(tech), args->resource);
 
    send_refer(to, args->from, args->refer_to, args->to_self, variables, response);
    ast_variables_destroy(variables);
}

References ao2_ref, args, ast_ari_endpoints_refer_to_endpoint_parse_body(), ast_ari_response_error(), ast_endpoint_latest_snapshot(), ast_str_to_lower(), ast_strdupa, ast_variables_destroy(), NULL, parse_refer_json(), send_refer(), and ast_endpoint_snapshot::tech.

Referenced by ast_ari_endpoints_refer_to_endpoint_cb().

ast_ari_endpoints_send_message()

void ast_ari_endpoints_send_message	(	struct ast_variable *	headers,
		struct ast_ari_endpoints_send_message_args *	args,
		struct ast_ari_response *	response
	)

Send a message to some technology URI or endpoint.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 256 of file resource_endpoints.c.

{
    struct ast_variable *variables = NULL;
 
    if (args->variables) {
        struct ast_json *json_variables;
 
        ast_ari_endpoints_send_message_parse_body(args->variables, args);
        json_variables = ast_json_object_get(args->variables, "variables");
        if (json_variables
            && json_to_ast_variables(response, json_variables, &variables)) {
            return;
        }
    }
 
    send_message(args->to, args->from, args->body, variables, response);
    ast_variables_destroy(variables);
}

References args, ast_ari_endpoints_send_message_parse_body(), ast_json_object_get(), ast_variables_destroy(), json_to_ast_variables(), NULL, and send_message().

Referenced by ast_ari_endpoints_send_message_cb().

ast_ari_endpoints_send_message_to_endpoint()

void ast_ari_endpoints_send_message_to_endpoint	(	struct ast_variable *	headers,
		struct ast_ari_endpoints_send_message_to_endpoint_args *	args,
		struct ast_ari_response *	response
	)

Send a message to some endpoint in a technology.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 277 of file resource_endpoints.c.

{
    struct ast_variable *variables = NULL;
    struct ast_endpoint_snapshot *snapshot;
    char msg_to[128];
    char *tech = ast_strdupa(args->tech);
 
    /* Really, we just want to know if this thing exists */
    snapshot = ast_endpoint_latest_snapshot(args->tech, args->resource);
    if (!snapshot) {
        ast_ari_response_error(response, 404, "Not Found",
            "Endpoint not found");
        return;
    }
    ao2_ref(snapshot, -1);
 
    if (args->variables) {
        struct ast_json *json_variables;
 
        ast_ari_endpoints_send_message_to_endpoint_parse_body(args->variables, args);
        json_variables = ast_json_object_get(args->variables, "variables");
        if (json_variables
            && json_to_ast_variables(response, json_variables, &variables)) {
            return;
        }
    }
 
    snprintf(msg_to, sizeof(msg_to), "%s:%s", ast_str_to_lower(tech), args->resource);
 
    send_message(msg_to, args->from, args->body, variables, response);
    ast_variables_destroy(variables);
}

References ao2_ref, args, ast_ari_endpoints_send_message_to_endpoint_parse_body(), ast_ari_response_error(), ast_endpoint_latest_snapshot(), ast_json_object_get(), ast_str_to_lower(), ast_strdupa, ast_variables_destroy(), json_to_ast_variables(), NULL, send_message(), and ast_endpoint_snapshot::tech.

Referenced by ast_ari_endpoints_send_message_to_endpoint_cb().

json_to_ast_variables()

static int json_to_ast_variables ( struct ast_ari_response *  response, struct ast_json *  json_variables, struct ast_variable **  variables  )

static

Definition at line 235 of file resource_endpoints.c.

{
    enum ast_json_to_ast_vars_code res;
 
    res = ast_json_to_ast_variables(json_variables, variables);
    switch (res) {
    case AST_JSON_TO_AST_VARS_CODE_SUCCESS:
        return 0;
    case AST_JSON_TO_AST_VARS_CODE_INVALID_TYPE:
        ast_ari_response_error(response, 400, "Bad Request",
            "Only string values in the 'variables' object allowed");
        break;
    case AST_JSON_TO_AST_VARS_CODE_OOM:
        ast_ari_response_alloc_failed(response);
        break;
    }
    ast_log(AST_LOG_ERROR, "Unable to convert 'variables' in JSON body to Asterisk variables\n");
 
    return -1;
}

References ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_json_to_ast_variables(), AST_JSON_TO_AST_VARS_CODE_INVALID_TYPE, AST_JSON_TO_AST_VARS_CODE_OOM, AST_JSON_TO_AST_VARS_CODE_SUCCESS, ast_log, and AST_LOG_ERROR.

Referenced by ast_ari_endpoints_send_message(), ast_ari_endpoints_send_message_to_endpoint(), and parse_refer_json().

parse_refer_json()

static int parse_refer_json ( struct ast_json *  body, struct ast_ari_response *  response, struct ast_variable **  variables  )

static

Definition at line 361 of file resource_endpoints.c.

{
    const char *known_variables[] = { "display_name" };
    const char *value;
    struct ast_variable *new_var;
    struct ast_json *json_variable;
    int err = 0;
    int i;
 
    if (!body) {
        return 0;
    }
 
    json_variable = ast_json_object_get(body, "variables");
    if (json_variable) {
        err = json_to_ast_variables(response, json_variable, variables);
        if (err) {
            return err;
        }
    }
 
    for (i = 0; i < sizeof(known_variables) / sizeof(*known_variables); ++i) {
        json_variable = ast_json_object_get(body, known_variables[i]);
        if (json_variable && ast_json_typeof(json_variable) == AST_JSON_STRING) {
            value = ast_json_string_get(json_variable);
            new_var = ast_variable_new(known_variables[i], value, "");
            if (new_var) {
                ast_variable_list_append(variables, new_var);
            }
        }
    }
 
    return err;
}

References ast_json_object_get(), AST_JSON_STRING, ast_json_string_get(), ast_json_typeof(), ast_variable_list_append, ast_variable_new, json_to_ast_variables(), and value.

Referenced by ast_ari_endpoints_refer(), and ast_ari_endpoints_refer_to_endpoint().

send_message()

static void send_message ( const char *  to, const char *  from, const char *  body, struct ast_variable *  variables, struct ast_ari_response *  response  )

static

Definition at line 177 of file resource_endpoints.c.

{
    struct ast_variable *current;
    struct ast_msg *msg;
    int res = 0;
 
    if (ast_strlen_zero(to)) {
        ast_ari_response_error(response, 400, "Bad Request",
            "To must be specified");
        return;
    }
 
    msg = ast_msg_alloc();
    if (!msg) {
        ast_ari_response_alloc_failed(response);
        return;
    }
 
    res |= ast_msg_set_from(msg, "%s", from);
    res |= ast_msg_set_to(msg, "%s", to);
 
    if (!ast_strlen_zero(body)) {
        res |= ast_msg_set_body(msg, "%s", body);
    }
 
    for (current = variables; current; current = current->next) {
        res |= ast_msg_set_var_outbound(msg, current->name, current->value);
    }
 
    if (res) {
        ast_ari_response_alloc_failed(response);
        ast_msg_destroy(msg);
        return;
    }
 
    if (ast_msg_send(msg, to, from)) {
        ast_ari_response_error(response, 404, "Not Found",
            "Endpoint not found");
        return;
    }
 
    response->message = ast_json_null();
    response->response_code = 202;
    response->response_text = "Accepted";
}

References ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_json_null(), ast_msg_alloc(), ast_msg_destroy(), ast_msg_send(), ast_msg_set_body(), ast_msg_set_from(), ast_msg_set_to(), ast_msg_set_var_outbound(), ast_strlen_zero(), ast_msg::body, current, ast_msg::from, ast_ari_response::message, ast_variable::next, ast_ari_response::response_code, ast_ari_response::response_text, and ast_msg::to.

Referenced by ast_ari_endpoints_send_message(), and ast_ari_endpoints_send_message_to_endpoint().

send_refer()

static void send_refer ( const char *  to, const char *  from, const char *  refer_to, int  to_self, struct ast_variable *  variables, struct ast_ari_response *  response  )

static

Definition at line 312 of file resource_endpoints.c.

{
    struct ast_variable *current;
    struct ast_refer *refer;
    int res = 0;
 
    if (ast_strlen_zero(to)) {
        ast_ari_response_error(response, 400, "Bad Request",
            "To must be specified");
        return;
    }
 
    refer = ast_refer_alloc();
    if (!refer) {
        ast_ari_response_alloc_failed(response);
        return;
    }
 
    ast_refer_set_to(refer, "%s", to);
    ast_refer_set_to_self(refer, to_self);
 
    if (!ast_strlen_zero(from)) {
        ast_refer_set_from(refer, "%s", from);
    }
    if (!ast_strlen_zero(refer_to)) {
        ast_refer_set_refer_to(refer, "%s", refer_to);
    }
 
    for (current = variables; current; current = current->next) {
        res |= ast_refer_set_var_outbound(refer, current->name, current->value);
    }
 
    if (res) {
        ast_ari_response_alloc_failed(response);
        ast_refer_destroy(refer);
        return;
    }
 
    if (ast_refer_send(refer)) {
        ast_ari_response_error(response, 404, "Not Found",
            "Endpoint not found");
        return;
    }
 
    response->message = ast_json_null();
    response->response_code = 202;
    response->response_text = "Accepted";
}

References ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_json_null(), ast_refer_alloc(), ast_refer_destroy(), ast_refer_send(), ast_refer_set_from(), ast_refer_set_refer_to(), ast_refer_set_to(), ast_refer_set_to_self(), ast_refer_set_var_outbound(), ast_strlen_zero(), current, ast_refer::from, ast_ari_response::message, ast_variable::next, ast_refer::refer_to, ast_ari_response::response_code, ast_ari_response::response_text, ast_refer::to, and ast_refer::to_self.

Referenced by ast_ari_endpoints_refer(), and ast_ari_endpoints_refer_to_endpoint().