mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-03 11:25:35 +00:00
ed48377994
Created a data model and implemented functionality for an ARI device state
resource. The following operations have been added that allow a user to
manipulate an ARI controlled device:
Create/Change the state of an ARI controlled device
PUT /deviceStates/{deviceName}&{deviceState}
Retrieve all ARI controlled devices
GET /deviceStates
Retrieve the current state of a device
GET /deviceStates/{deviceName}
Destroy a device-state controlled by ARI
DELETE /deviceStates/{deviceName}
The ARI controlled device must begin with 'Stasis:'. An example controlled
device name would be Stasis:Example. A 'DeviceStateChanged' event has also
been added so that an application can subscribe and receive device change
events. Any device state, ARI controlled or not, can be subscribed to.
While adding the event, the underlying subscription control mechanism was
refactored so that all current and future resource subscriptions would be
the same. Each event resource must now register itself in order to be able
to properly handle [un]subscribes.
(issue ASTERISK-22838)
Reported by: Matt Jordan
Review: https://reviewboard.asterisk.org/r/3025/
........
Merged revisions 403134 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@403135 65c4cc65-6c06-0410-ace0-fbb531ad65f3
324 lines
8.9 KiB
C
324 lines
8.9 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2012 - 2013, Digium, Inc.
|
|
*
|
|
* Kevin Harwell <kharwell@digium.com>
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*
|
|
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
* !!!!! DO NOT EDIT !!!!!
|
|
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
* This file is generated by a mustache template. Please see the original
|
|
* template in rest-api-templates/res_ari_resource.c.mustache
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Device state resources
|
|
*
|
|
* \author Kevin Harwell <kharwell@digium.com>
|
|
*/
|
|
|
|
/*** MODULEINFO
|
|
<depend type="module">res_ari</depend>
|
|
<depend type="module">res_stasis</depend>
|
|
<support_level>core</support_level>
|
|
***/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include "asterisk/app.h"
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/stasis_app.h"
|
|
#include "ari/resource_device_states.h"
|
|
#if defined(AST_DEVMODE)
|
|
#include "ari/ari_model_validators.h"
|
|
#endif
|
|
|
|
#define MAX_VALS 128
|
|
|
|
/*!
|
|
* \brief Parameter parsing callback for /deviceStates.
|
|
* \param get_params GET parameters in the HTTP request.
|
|
* \param path_vars Path variables extracted from the request.
|
|
* \param headers HTTP headers.
|
|
* \param[out] response Response to the HTTP request.
|
|
*/
|
|
static void ast_ari_device_states_list_cb(
|
|
struct ast_variable *get_params, struct ast_variable *path_vars,
|
|
struct ast_variable *headers, struct ast_ari_response *response)
|
|
{
|
|
struct ast_ari_device_states_list_args args = {};
|
|
#if defined(AST_DEVMODE)
|
|
int is_valid;
|
|
int code;
|
|
#endif /* AST_DEVMODE */
|
|
|
|
ast_ari_device_states_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_device_state_fn());
|
|
} else {
|
|
ast_log(LOG_ERROR, "Invalid error response %d for /deviceStates\n", code);
|
|
is_valid = 0;
|
|
}
|
|
}
|
|
|
|
if (!is_valid) {
|
|
ast_log(LOG_ERROR, "Response validation failed for /deviceStates\n");
|
|
ast_ari_response_error(response, 500,
|
|
"Internal Server Error", "Response validation failed");
|
|
}
|
|
#endif /* AST_DEVMODE */
|
|
|
|
fin: __attribute__((unused))
|
|
return;
|
|
}
|
|
/*!
|
|
* \brief Parameter parsing callback for /deviceStates/{deviceName}.
|
|
* \param get_params GET parameters in the HTTP request.
|
|
* \param path_vars Path variables extracted from the request.
|
|
* \param headers HTTP headers.
|
|
* \param[out] response Response to the HTTP request.
|
|
*/
|
|
static void ast_ari_device_states_get_cb(
|
|
struct ast_variable *get_params, struct ast_variable *path_vars,
|
|
struct ast_variable *headers, struct ast_ari_response *response)
|
|
{
|
|
struct ast_ari_device_states_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, "deviceName") == 0) {
|
|
args.device_name = (i->value);
|
|
} else
|
|
{}
|
|
}
|
|
ast_ari_device_states_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_device_state(
|
|
response->message);
|
|
} else {
|
|
ast_log(LOG_ERROR, "Invalid error response %d for /deviceStates/{deviceName}\n", code);
|
|
is_valid = 0;
|
|
}
|
|
}
|
|
|
|
if (!is_valid) {
|
|
ast_log(LOG_ERROR, "Response validation failed for /deviceStates/{deviceName}\n");
|
|
ast_ari_response_error(response, 500,
|
|
"Internal Server Error", "Response validation failed");
|
|
}
|
|
#endif /* AST_DEVMODE */
|
|
|
|
fin: __attribute__((unused))
|
|
return;
|
|
}
|
|
/*!
|
|
* \brief Parameter parsing callback for /deviceStates/{deviceName}.
|
|
* \param get_params GET parameters in the HTTP request.
|
|
* \param path_vars Path variables extracted from the request.
|
|
* \param headers HTTP headers.
|
|
* \param[out] response Response to the HTTP request.
|
|
*/
|
|
static void ast_ari_device_states_update_cb(
|
|
struct ast_variable *get_params, struct ast_variable *path_vars,
|
|
struct ast_variable *headers, struct ast_ari_response *response)
|
|
{
|
|
struct ast_ari_device_states_update_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, "deviceState") == 0) {
|
|
args.device_state = (i->value);
|
|
} else
|
|
{}
|
|
}
|
|
for (i = path_vars; i; i = i->next) {
|
|
if (strcmp(i->name, "deviceName") == 0) {
|
|
args.device_name = (i->value);
|
|
} else
|
|
{}
|
|
}
|
|
ast_ari_device_states_update(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: /* Device name is missing */
|
|
case 409: /* Uncontrolled device specified */
|
|
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 /deviceStates/{deviceName}\n", code);
|
|
is_valid = 0;
|
|
}
|
|
}
|
|
|
|
if (!is_valid) {
|
|
ast_log(LOG_ERROR, "Response validation failed for /deviceStates/{deviceName}\n");
|
|
ast_ari_response_error(response, 500,
|
|
"Internal Server Error", "Response validation failed");
|
|
}
|
|
#endif /* AST_DEVMODE */
|
|
|
|
fin: __attribute__((unused))
|
|
return;
|
|
}
|
|
/*!
|
|
* \brief Parameter parsing callback for /deviceStates/{deviceName}.
|
|
* \param get_params GET parameters in the HTTP request.
|
|
* \param path_vars Path variables extracted from the request.
|
|
* \param headers HTTP headers.
|
|
* \param[out] response Response to the HTTP request.
|
|
*/
|
|
static void ast_ari_device_states_delete_cb(
|
|
struct ast_variable *get_params, struct ast_variable *path_vars,
|
|
struct ast_variable *headers, struct ast_ari_response *response)
|
|
{
|
|
struct ast_ari_device_states_delete_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, "deviceName") == 0) {
|
|
args.device_name = (i->value);
|
|
} else
|
|
{}
|
|
}
|
|
ast_ari_device_states_delete(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: /* Device name is missing */
|
|
case 409: /* Uncontrolled device specified */
|
|
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 /deviceStates/{deviceName}\n", code);
|
|
is_valid = 0;
|
|
}
|
|
}
|
|
|
|
if (!is_valid) {
|
|
ast_log(LOG_ERROR, "Response validation failed for /deviceStates/{deviceName}\n");
|
|
ast_ari_response_error(response, 500,
|
|
"Internal Server Error", "Response validation failed");
|
|
}
|
|
#endif /* AST_DEVMODE */
|
|
|
|
fin: __attribute__((unused))
|
|
return;
|
|
}
|
|
|
|
/*! \brief REST handler for /api-docs/deviceStates.{format} */
|
|
static struct stasis_rest_handlers deviceStates_deviceName = {
|
|
.path_segment = "deviceName",
|
|
.is_wildcard = 1,
|
|
.callbacks = {
|
|
[AST_HTTP_GET] = ast_ari_device_states_get_cb,
|
|
[AST_HTTP_PUT] = ast_ari_device_states_update_cb,
|
|
[AST_HTTP_DELETE] = ast_ari_device_states_delete_cb,
|
|
},
|
|
.num_children = 0,
|
|
.children = { }
|
|
};
|
|
/*! \brief REST handler for /api-docs/deviceStates.{format} */
|
|
static struct stasis_rest_handlers deviceStates = {
|
|
.path_segment = "deviceStates",
|
|
.callbacks = {
|
|
[AST_HTTP_GET] = ast_ari_device_states_list_cb,
|
|
},
|
|
.num_children = 1,
|
|
.children = { &deviceStates_deviceName, }
|
|
};
|
|
|
|
static int load_module(void)
|
|
{
|
|
int res = 0;
|
|
stasis_app_ref();
|
|
res |= ast_ari_add_handler(&deviceStates);
|
|
return res;
|
|
}
|
|
|
|
static int unload_module(void)
|
|
{
|
|
ast_ari_remove_handler(&deviceStates);
|
|
stasis_app_unref();
|
|
return 0;
|
|
}
|
|
|
|
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - Device state resources",
|
|
.load = load_module,
|
|
.unload = unload_module,
|
|
.nonoptreq = "res_ari,res_stasis",
|
|
);
|