Asterisk - The Open Source Telephony Project GIT-master-0bf3178
Functions
resource_applications.c File Reference

/api-docs/applications.{format} implementation - Stasis application resources More...

#include "asterisk.h"
#include "asterisk/stasis_app.h"
#include "resource_applications.h"
Include dependency graph for resource_applications.c:

Go to the source code of this file.

Functions

static int append_json (void *obj, void *arg, int flags)
 
void ast_ari_applications_filter (struct ast_variable *headers, struct ast_ari_applications_filter_args *args, struct ast_ari_response *response)
 Filter application events types. More...
 
void ast_ari_applications_get (struct ast_variable *headers, struct ast_ari_applications_get_args *args, struct ast_ari_response *response)
 Get details of an application. More...
 
void ast_ari_applications_list (struct ast_variable *headers, struct ast_ari_applications_list_args *args, struct ast_ari_response *response)
 List all applications. More...
 
void ast_ari_applications_subscribe (struct ast_variable *headers, struct ast_ari_applications_subscribe_args *args, struct ast_ari_response *response)
 Subscribe an application to a event source. More...
 
void ast_ari_applications_unsubscribe (struct ast_variable *headers, struct ast_ari_applications_unsubscribe_args *args, struct ast_ari_response *response)
 Unsubscribe an application from an event source. More...
 

Detailed Description

/api-docs/applications.{format} implementation - Stasis application resources

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

Definition in file resource_applications.c.

Function Documentation

◆ append_json()

static int append_json ( void *  obj,
void *  arg,
int  flags 
)
static

Definition at line 32 of file resource_applications.c.

33{
34 const char *app = obj;
35 struct ast_json *array = arg;
36
38
39 return 0;
40}
static const char app[]
Definition: app_adsiprog.c:56
static int array(struct ast_channel *chan, const char *cmd, char *var, const char *value)
int ast_json_array_append(struct ast_json *array, struct ast_json *value)
Append to an array.
Definition: json.c:378
struct ast_json * stasis_app_to_json(const char *app_name)
Return the JSON representation of a Stasis application.
Definition: res_stasis.c:1879
Abstract JSON element (object, array, string, int, ...).

References app, array(), ast_json_array_append(), and stasis_app_to_json().

Referenced by ast_ari_applications_list().

◆ ast_ari_applications_filter()

void ast_ari_applications_filter ( struct ast_variable headers,
struct ast_ari_applications_filter_args args,
struct ast_ari_response response 
)

Filter application events types.

Allowed and/or disallowed event type filtering can be done. The body (parameter) should specify a JSON key/value object that describes the type of event filtering needed. One, or both of the following keys can be designated:

"allowed" - Specifies an allowed list of event types
"disallowed" - Specifies a disallowed list of event types

Further, each of those key's value should be a JSON array that holds zero, or more JSON key/value objects. Each of these objects must contain the following key with an associated value:

"type" - The type name of the event to filter

The value must be the string name (case sensitive) of the event type that needs filtering. For example:

{ "allowed": [ { "type": "StasisStart" }, { "type": "StasisEnd" } ] }

As this specifies only an allowed list, then only those two event type messages are sent to the application. No other event messages are sent.

The following rules apply:

* If the body is empty, both the allowed and disallowed filters are set empty.
* If both list types are given then both are set to their respective values (note, specifying an empty array for a given type sets that type to empty).
* If only one list type is given then only that type is set. The other type is not updated.
* An empty "allowed" list means all events are allowed.
* An empty "disallowed" list means no events are disallowed.
* Disallowed events take precedence over allowed events if the event type is specified in both lists.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 172 of file resource_applications.c.

175{
176 struct stasis_app *app = stasis_app_get_by_name(args->application_name);
177
178 if (!app) {
179 ast_ari_response_error(response, 404, "Not Found", "Application not found");
180 return;
181 }
182
183 if (stasis_app_event_filter_set(app, args->filter)) {
184 ast_ari_response_error(response, 400, "Bad Request", "Invalid format definition");
185 } else {
187 }
188
189 ao2_ref(app, -1);
190}
void ast_ari_response_error(struct ast_ari_response *response, int response_code, const char *response_text, const char *message_fmt,...)
Fill in an error ast_ari_response.
Definition: res_ari.c:259
void ast_ari_response_ok(struct ast_ari_response *response, struct ast_json *message)
Fill in an OK (200) ast_ari_response.
Definition: res_ari.c:276
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
struct ast_json * stasis_app_object_to_json(struct stasis_app *app)
Return the JSON representation of a Stasis application.
Definition: res_stasis.c:1869
int stasis_app_event_filter_set(struct stasis_app *app, struct ast_json *filter)
Set the application's event type filter.
struct stasis_app * stasis_app_get_by_name(const char *name)
Retrieve a handle to a Stasis application by its name.
Definition: res_stasis.c:1697
const char * args

References ao2_ref, app, args, ast_ari_response_error(), ast_ari_response_ok(), stasis_app_event_filter_set(), stasis_app_get_by_name(), and stasis_app_object_to_json().

Referenced by ast_ari_applications_filter_cb().

◆ ast_ari_applications_get()

void ast_ari_applications_get ( struct ast_variable headers,
struct ast_ari_applications_get_args args,
struct ast_ari_response response 
)

Get details of an application.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 72 of file resource_applications.c.

75{
76 struct ast_json *json;
77
78 json = stasis_app_to_json(args->application_name);
79
80 if (!json) {
81 ast_ari_response_error(response, 404, "Not Found",
82 "Application not found");
83 return;
84 }
85
86 ast_ari_response_ok(response, json);
87}

References args, ast_ari_response_error(), ast_ari_response_ok(), and stasis_app_to_json().

Referenced by ast_ari_applications_get_cb().

◆ ast_ari_applications_list()

void ast_ari_applications_list ( struct ast_variable headers,
struct ast_ari_applications_list_args args,
struct ast_ari_response response 
)

List all applications.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 42 of file resource_applications.c.

45{
47 RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
48 size_t count;
49
51 json = ast_json_array_create();
52 if (!apps || !json) {
53 ast_ari_response_error(response, 500, "Internal Server Error",
54 "Allocation failed");
55 return;
56 }
57
62
63 if (count != ast_json_array_size(json)) {
64 ast_ari_response_error(response, 500, "Internal Server Error",
65 "Allocation failed");
66 return;
67 }
68
69 ast_ari_response_ok(response, ast_json_ref(json));
70}
#define ao2_callback(c, flags, cb_fn, arg)
ao2_callback() is a generic function that applies cb_fn() to all objects in a container,...
Definition: astobj2.h:1693
int ao2_container_count(struct ao2_container *c)
Returns the number of elements in a container.
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
#define ao2_unlock(a)
Definition: astobj2.h:729
#define ao2_lock(a)
Definition: astobj2.h:717
@ OBJ_NOLOCK
Assume that the ao2_container is already locked.
Definition: astobj2.h:1063
@ OBJ_NODATA
Definition: astobj2.h:1044
void ast_json_unref(struct ast_json *value)
Decrease refcount on value. If refcount reaches zero, value is freed.
Definition: json.c:73
struct ast_json * ast_json_array_create(void)
Create a empty JSON array.
Definition: json.c:362
struct ast_json * ast_json_ref(struct ast_json *value)
Increase refcount on value.
Definition: json.c:67
size_t ast_json_array_size(const struct ast_json *array)
Get the size of a JSON array.
Definition: json.c:366
#define NULL
Definition: resample.c:96
static int append_json(void *obj, void *arg, int flags)
struct ao2_container * stasis_app_get_all(void)
Gets the names of all registered Stasis applications.
Definition: res_stasis.c:1711
Generic container type.
Registered applications container.
Definition: pbx_app.c:67
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:941

References ao2_callback, ao2_cleanup, ao2_container_count(), ao2_lock, ao2_unlock, append_json(), ast_ari_response_error(), ast_ari_response_ok(), ast_json_array_create(), ast_json_array_size(), ast_json_ref(), ast_json_unref(), NULL, OBJ_NODATA, OBJ_NOLOCK, RAII_VAR, and stasis_app_get_all().

Referenced by ast_ari_applications_list_cb().

◆ ast_ari_applications_subscribe()

void ast_ari_applications_subscribe ( struct ast_variable headers,
struct ast_ari_applications_subscribe_args args,
struct ast_ari_response response 
)

Subscribe an application to a event source.

Returns the state of the application after the subscriptions have changed

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 89 of file resource_applications.c.

92{
93 RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
95
96 if (args->event_source_count <= 0) {
97 ast_ari_response_error(response, 400, "Bad Request",
98 "Missing parameter eventSource");
99 return;
100 }
101
102 if (ast_strlen_zero(args->application_name)) {
103 ast_ari_response_error(response, 400, "Bad Request",
104 "Missing parameter applicationName");
105 return;
106 }
107
108 res = stasis_app_subscribe(args->application_name, args->event_source,
109 args->event_source_count, &json);
110
111 switch (res) {
112 case STASIS_ASR_OK:
113 ast_ari_response_ok(response, ast_json_ref(json));
114 break;
116 ast_ari_response_error(response, 404, "Not Found",
117 "Application not found");
118 break;
120 ast_ari_response_error(response, 422, "Unprocessable Entity",
121 "Event source does not exist");
122 break;
124 ast_ari_response_error(response, 400, "Bad Request",
125 "Invalid event source URI scheme");
126 break;
128 ast_ari_response_error(response, 500, "Internal Server Error",
129 "Error processing request");
130 break;
131 }
132}
enum stasis_app_subscribe_res stasis_app_subscribe(const char *app_name, const char **event_source_uris, int event_sources_count, struct ast_json **json)
Subscribes an application to a list of event sources.
Definition: res_stasis.c:2048
stasis_app_subscribe_res
Return code for stasis_app_[un]subscribe.
Definition: stasis_app.h:282
@ STASIS_ASR_OK
Definition: stasis_app.h:283
@ STASIS_ASR_EVENT_SOURCE_BAD_SCHEME
Definition: stasis_app.h:286
@ STASIS_ASR_INTERNAL_ERROR
Definition: stasis_app.h:287
@ STASIS_ASR_EVENT_SOURCE_NOT_FOUND
Definition: stasis_app.h:285
@ STASIS_ASR_APP_NOT_FOUND
Definition: stasis_app.h:284
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65

References args, ast_ari_response_error(), ast_ari_response_ok(), ast_json_ref(), ast_json_unref(), ast_strlen_zero(), NULL, RAII_VAR, stasis_app_subscribe(), STASIS_ASR_APP_NOT_FOUND, STASIS_ASR_EVENT_SOURCE_BAD_SCHEME, STASIS_ASR_EVENT_SOURCE_NOT_FOUND, STASIS_ASR_INTERNAL_ERROR, and STASIS_ASR_OK.

Referenced by ast_ari_applications_subscribe_cb().

◆ ast_ari_applications_unsubscribe()

void ast_ari_applications_unsubscribe ( struct ast_variable headers,
struct ast_ari_applications_unsubscribe_args args,
struct ast_ari_response response 
)

Unsubscribe an application from an event source.

Returns the state of the application after the subscriptions have changed

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 134 of file resource_applications.c.

137{
138 RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
140
141 if (args->event_source_count == 0) {
142 ast_ari_response_error(response, 400, "Bad Request",
143 "Missing parameter eventSource");
144 return;
145 }
146
147 res = stasis_app_unsubscribe(args->application_name, args->event_source,
148 args->event_source_count, &json);
149
150 switch (res) {
151 case STASIS_ASR_OK:
152 ast_ari_response_ok(response, ast_json_ref(json));
153 break;
155 ast_ari_response_error(response, 404, "Not Found",
156 "Application not found");
157 break;
159 ast_ari_response_error(response, 422, "Unprocessable Entity",
160 "Event source was not subscribed to");
161 break;
163 ast_ari_response_error(response, 400, "Bad Request",
164 "Invalid event source URI scheme");
165 break;
167 ast_ari_response_error(response, 500, "Internal Server Error",
168 "Error processing request");
169 }
170}
enum stasis_app_subscribe_res stasis_app_unsubscribe(const char *app_name, const char **event_source_uris, int event_sources_count, struct ast_json **json)
Unsubscribes an application from a list of event sources.
Definition: res_stasis.c:2089

References args, ast_ari_response_error(), ast_ari_response_ok(), ast_json_ref(), ast_json_unref(), NULL, RAII_VAR, stasis_app_unsubscribe(), STASIS_ASR_APP_NOT_FOUND, STASIS_ASR_EVENT_SOURCE_BAD_SCHEME, STASIS_ASR_EVENT_SOURCE_NOT_FOUND, STASIS_ASR_INTERNAL_ERROR, and STASIS_ASR_OK.

Referenced by ast_ari_applications_unsubscribe_cb().