[Asterisk-code-review] ARI: Added new functionality to get information on a single ... (asterisk[master])
Benjamin Keith Ford
asteriskteam at digium.com
Wed Jul 8 09:32:36 CDT 2015
Benjamin Keith Ford has uploaded a new change for review.
https://gerrit.asterisk.org/812
Change subject: ARI: Added new functionality to get information on a single module.
......................................................................
ARI: Added new functionality to get information on a single module.
An http request can be sent to retrieve information on a single
module, including the resource name, description, use count, status,
and support level.
The command "curl -v -u user:pass -X GET 'http://localhost:8088/ari
/asterisk/modules/{moduleName}'" (or something similar, depending on
configuration) can be run in the terminal to access this new
functionality.
For more information, see:
https://wiki.asterisk.org/wiki.display/~bford/Asterisk+ARI+Resource
* Added new ARI functionality
* Information on a single module can now be retrieved
ASTERISK-25173
Change-Id: Ibce5a94e70ecdf4e90329cf0ba66c33a62d37463
---
M include/asterisk/module.h
M main/loader.c
M res/ari/ari_model_validators.c
M res/ari/ari_model_validators.h
M res/ari/resource_asterisk.c
M res/ari/resource_asterisk.h
M res/res_ari_asterisk.c
M rest-api/api-docs/asterisk.json
8 files changed, 405 insertions(+), 2 deletions(-)
git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/12/812/1
diff --git a/include/asterisk/module.h b/include/asterisk/module.h
index f427491..bc986f4 100644
--- a/include/asterisk/module.h
+++ b/include/asterisk/module.h
@@ -161,6 +161,27 @@
const char *like);
/*!
+ * \brief Ask for a list of modules, descriptions, use counts and status.
+ * \param modentry A callback to an updated function.
+ * \param like
+ * \param data Data to pass to the callback
+ * \param condition The condition to meet
+ *
+ * For each of the modules loaded, modentry will be executed with the resource,
+ * description, and usecount values of each particular module until the condition
+ * is met.
+ *
+ * \retval number of conditions met
+ * \since 13.5.0
+ */
+int ast_update_module_list_condition(int (*modentry)(const char *module, const char *description,
+ int usecnt, const char *status,
+ const char *like,
+ enum ast_module_support_level support_level,
+ void *data, const char *condition),
+ const char *like, void *data, const char *condition);
+
+/*!
* \brief Check if module with the name given is loaded
* \param name Module name, like "chan_sip.so"
* \retval 1 if true
diff --git a/main/loader.c b/main/loader.c
index eb959fa..9867aef 100644
--- a/main/loader.c
+++ b/main/loader.c
@@ -1419,6 +1419,34 @@
return total_mod_loaded;
}
+int ast_update_module_list_condition(int (*modentry)(const char *module, const char *description,
+ int usecnt, const char *status,
+ const char *like,
+ enum ast_module_support_level support_level,
+ void *data, const char *condition),
+ const char *like, void *data, const char *condition)
+{
+ struct ast_module *cur;
+ int condition_met = 0;
+ AST_LIST_HEAD_NOLOCK(, ast_module) alpha_module_list = AST_LIST_HEAD_NOLOCK_INIT_VALUE;
+
+ AST_DLLIST_LOCK(&module_list);
+
+ AST_DLLIST_TRAVERSE(&module_list, cur, entry) {
+ AST_LIST_INSERT_SORTALPHA(&alpha_module_list, cur, list_entry, resource);
+ }
+
+ while ((cur = AST_LIST_REMOVE_HEAD(&alpha_module_list, list_entry))) {
+ condition_met += modentry(cur->resource, cur->info->description, cur->usecount,
+ cur->flags.running ? "Running" : "Not Running", like, cur->info->support_level,
+ data, condition);
+ }
+
+ AST_DLLIST_UNLOCK(&module_list);
+
+ return condition_met;
+}
+
/*! \brief Check if module exists */
int ast_module_check(const char *name)
{
diff --git a/res/ari/ari_model_validators.c b/res/ari/ari_model_validators.c
index 37d31a1..ca72f93 100644
--- a/res/ari/ari_model_validators.c
+++ b/res/ari/ari_model_validators.c
@@ -308,6 +308,108 @@
return ast_ari_validate_config_info;
}
+int ast_ari_validate_module(struct ast_json *json)
+{
+ int res = 1;
+ struct ast_json_iter *iter;
+ int has_description = 0;
+ int has_name = 0;
+ int has_status = 0;
+ int has_support_level = 0;
+ int has_use_count = 0;
+
+ for (iter = ast_json_object_iter(json); iter; iter = ast_json_object_iter_next(json, iter)) {
+ if (strcmp("description", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_description = 1;
+ prop_is_valid = ast_ari_validate_string(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI Module field description failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("name", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_name = 1;
+ prop_is_valid = ast_ari_validate_string(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI Module field name failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("status", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_status = 1;
+ prop_is_valid = ast_ari_validate_string(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI Module field status failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("support_level", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_support_level = 1;
+ prop_is_valid = ast_ari_validate_string(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI Module field support_level failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("use_count", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_use_count = 1;
+ prop_is_valid = ast_ari_validate_int(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI Module field use_count failed validation\n");
+ res = 0;
+ }
+ } else
+ {
+ ast_log(LOG_ERROR,
+ "ARI Module has undocumented field %s\n",
+ ast_json_object_iter_key(iter));
+ res = 0;
+ }
+ }
+
+ if (!has_description) {
+ ast_log(LOG_ERROR, "ARI Module missing required field description\n");
+ res = 0;
+ }
+
+ if (!has_name) {
+ ast_log(LOG_ERROR, "ARI Module missing required field name\n");
+ res = 0;
+ }
+
+ if (!has_status) {
+ ast_log(LOG_ERROR, "ARI Module missing required field status\n");
+ res = 0;
+ }
+
+ if (!has_support_level) {
+ ast_log(LOG_ERROR, "ARI Module missing required field support_level\n");
+ res = 0;
+ }
+
+ if (!has_use_count) {
+ ast_log(LOG_ERROR, "ARI Module missing required field use_count\n");
+ res = 0;
+ }
+
+ return res;
+}
+
+ari_validator ast_ari_validate_module_fn(void)
+{
+ return ast_ari_validate_module;
+}
+
int ast_ari_validate_set_id(struct ast_json *json)
{
int res = 1;
diff --git a/res/ari/ari_model_validators.h b/res/ari/ari_model_validators.h
index 1fafba3..41b9179 100644
--- a/res/ari/ari_model_validators.h
+++ b/res/ari/ari_model_validators.h
@@ -207,6 +207,24 @@
ari_validator ast_ari_validate_config_info_fn(void);
/*!
+ * \brief Validator for Module.
+ *
+ * Details of an Asterisk module
+ *
+ * \param json JSON object to validate.
+ * \returns True (non-zero) if valid.
+ * \returns False (zero) if invalid.
+ */
+int ast_ari_validate_module(struct ast_json *json);
+
+/*!
+ * \brief Function pointer to ast_ari_validate_module().
+ *
+ * See \ref ast_ari_model_validators.h for more details.
+ */
+ari_validator ast_ari_validate_module_fn(void);
+
+/*!
* \brief Validator for SetId.
*
* Effective user/group id
@@ -1244,6 +1262,12 @@
* - max_open_files: int
* - name: string (required)
* - setid: SetId (required)
+ * Module
+ * - description: string (required)
+ * - name: string (required)
+ * - status: string (required)
+ * - support_level: string (required)
+ * - use_count: int (required)
* SetId
* - group: string (required)
* - user: string (required)
diff --git a/res/ari/resource_asterisk.c b/res/ari/resource_asterisk.c
index a2198bb..7c73548 100644
--- a/res/ari/resource_asterisk.c
+++ b/res/ari/resource_asterisk.c
@@ -33,6 +33,7 @@
#include "asterisk/ast_version.h"
#include "asterisk/buildinfo.h"
+#include "asterisk/module.h"
#include "asterisk/paths.h"
#include "asterisk/pbx.h"
#include "resource_asterisk.h"
@@ -140,6 +141,80 @@
ast_ari_response_ok(response, ast_json_ref(json));
}
+/*!
+ * \brief Identify module by name and process resource information
+ * \param module Resource name
+ * \param description
+ * \param usecnt Resource use count
+ * \param status
+ * \param like
+ * \param support_level
+ * \param data JSON body for resource
+ * \param condition Name to match resource to
+ *
+ * \retval 0 if no resource
+ * \retval 1 if resource exists
+ */
+static int identify_module(const char *module, const char *description, int usecnt,
+ const char *status, const char *like,
+ enum ast_module_support_level support_level, void *data,
+ const char *condition)
+{
+ struct ast_json *module_info;
+ struct ast_json **out = data;
+
+ if (strcmp(condition,module) != 0) {
+ return 0;
+ }
+
+ module_info = ast_json_pack("{s: s, s: s, s: i, s: s, s: s}",
+ "name", module,
+ "description", description,
+ "use_count", usecnt,
+ "status", status,
+ "support_level", ast_module_support_level_to_string(support_level));
+
+ if (!module_info) {
+ return 0;
+ }
+
+ *out = module_info;
+ return 1;
+}
+
+void ast_ari_asterisk_get_module(struct ast_variable *headers,
+ struct ast_ari_asterisk_get_module_args *args,
+ struct ast_ari_response *response)
+{
+ struct ast_json *json;
+
+ ast_assert(response != NULL);
+
+ json = ast_json_object_create();
+ if (!json) {
+ ast_ari_response_alloc_failed(response);
+ return;
+ }
+
+ if (ast_strlen_zero(args->module_name)) {
+ ast_ari_response_error(
+ response, 400, "Bad Request",
+ "Module name is required");
+ return;
+ }
+
+ if (!ast_module_check(args->module_name)) {
+ ast_ari_response_error(
+ response, 404, "Not Found",
+ "Module does not exist");
+ return;
+ }
+
+ ast_update_module_list_condition(&identify_module, NULL, &json, args->module_name);
+
+ ast_ari_response_ok(response, json);
+}
+
void ast_ari_asterisk_get_global_var(struct ast_variable *headers,
struct ast_ari_asterisk_get_global_var_args *args,
struct ast_ari_response *response)
diff --git a/res/ari/resource_asterisk.h b/res/ari/resource_asterisk.h
index dc4b183..f2347b4 100644
--- a/res/ari/resource_asterisk.h
+++ b/res/ari/resource_asterisk.h
@@ -67,6 +67,19 @@
* \param[out] response HTTP response
*/
void ast_ari_asterisk_get_info(struct ast_variable *headers, struct ast_ari_asterisk_get_info_args *args, struct ast_ari_response *response);
+/*! Argument struct for ast_ari_asterisk_get_module() */
+struct ast_ari_asterisk_get_module_args {
+ /*! Module's name */
+ const char *module_name;
+};
+/*!
+ * \brief Get Asterisk module information.
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+void ast_ari_asterisk_get_module(struct ast_variable *headers, struct ast_ari_asterisk_get_module_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_asterisk_get_global_var() */
struct ast_ari_asterisk_get_global_var_args {
/*! The variable to get */
diff --git a/res/res_ari_asterisk.c b/res/res_ari_asterisk.c
index cb6219b..2509623 100644
--- a/res/res_ari_asterisk.c
+++ b/res/res_ari_asterisk.c
@@ -209,6 +209,65 @@
ast_free(args.only);
return;
}
+/*!
+ * \brief Parameter parsing callback for /asterisk/modules/{moduleName}.
+ * \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_asterisk_get_module_cb(
+ struct ast_tcptls_session_instance *ser,
+ struct ast_variable *get_params, struct ast_variable *path_vars,
+ struct ast_variable *headers, struct ast_ari_response *response)
+{
+ struct ast_ari_asterisk_get_module_args args = {};
+ struct ast_variable *i;
+ RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
+#if defined(AST_DEVMODE)
+ int is_valid;
+ int code;
+#endif /* AST_DEVMODE */
+
+ for (i = path_vars; i; i = i->next) {
+ if (strcmp(i->name, "moduleName") == 0) {
+ args.module_name = (i->value);
+ } else
+ {}
+ }
+ ast_ari_asterisk_get_module(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: /* Module does not exist. */
+ is_valid = 1;
+ break;
+ default:
+ if (200 <= code && code <= 299) {
+ is_valid = ast_ari_validate_module(
+ response->message);
+ } else {
+ ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/modules/{moduleName}\n", code);
+ is_valid = 0;
+ }
+ }
+
+ if (!is_valid) {
+ ast_log(LOG_ERROR, "Response validation failed for /asterisk/modules/{moduleName}\n");
+ ast_ari_response_error(response, 500,
+ "Internal Server Error", "Response validation failed");
+ }
+#endif /* AST_DEVMODE */
+
+fin: __attribute__((unused))
+ return;
+}
int ast_ari_asterisk_get_global_var_parse_body(
struct ast_json *body,
struct ast_ari_asterisk_get_global_var_args *args)
@@ -409,6 +468,24 @@
.children = { }
};
/*! \brief REST handler for /api-docs/asterisk.{format} */
+static struct stasis_rest_handlers asterisk_modules_moduleName = {
+ .path_segment = "moduleName",
+ .is_wildcard = 1,
+ .callbacks = {
+ [AST_HTTP_GET] = ast_ari_asterisk_get_module_cb,
+ },
+ .num_children = 0,
+ .children = { }
+};
+/*! \brief REST handler for /api-docs/asterisk.{format} */
+static struct stasis_rest_handlers asterisk_modules = {
+ .path_segment = "modules",
+ .callbacks = {
+ },
+ .num_children = 1,
+ .children = { &asterisk_modules_moduleName, }
+};
+/*! \brief REST handler for /api-docs/asterisk.{format} */
static struct stasis_rest_handlers asterisk_variable = {
.path_segment = "variable",
.callbacks = {
@@ -423,8 +500,8 @@
.path_segment = "asterisk",
.callbacks = {
},
- .num_children = 2,
- .children = { &asterisk_info,&asterisk_variable, }
+ .num_children = 3,
+ .children = { &asterisk_info,&asterisk_modules,&asterisk_variable, }
};
static int load_module(void)
diff --git a/rest-api/api-docs/asterisk.json b/rest-api/api-docs/asterisk.json
index 263bfd6..bec237f 100644
--- a/rest-api/api-docs/asterisk.json
+++ b/rest-api/api-docs/asterisk.json
@@ -39,6 +39,38 @@
]
},
{
+ "path": "/asterisk/modules/{moduleName}",
+ "description": "Asterisk module",
+ "operations": [
+ {
+ "httpMethod": "GET",
+ "summary": "Get Asterisk module information.",
+ "nickname": "getModule",
+ "responseClass": "Module",
+ "parameters": [
+ {
+ "name": "moduleName",
+ "description": "Module's name",
+ "paramType": "path",
+ "required": true,
+ "allowMultiple": false,
+ "dataType": "string"
+ }
+ ],
+ "errorResponses": [
+ {
+ "code": 400,
+ "reason": "Module name is required."
+ },
+ {
+ "code": 404,
+ "reason": "Module does not exist."
+ }
+ ]
+ }
+ ]
+ },
+ {
"path": "/asterisk/variable",
"description": "Global variables",
"operations": [
@@ -244,6 +276,37 @@
}
}
},
+ "Module": {
+ "id": "Module",
+ "description": "Details of an Asterisk module",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of this module",
+ "required": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of this module",
+ "required": true
+ },
+ "use_count": {
+ "type": "int",
+ "description": "The number of times this module is being used",
+ "required": true
+ },
+ "status": {
+ "type": "string",
+ "description": "The running status of this module",
+ "required": true
+ },
+ "support_level": {
+ "type": "string",
+ "description": "The support state of this module",
+ "required": true
+ }
+ }
+ },
"Variable": {
"id": "Variable",
"description": "The value of a channel variable",
--
To view, visit https://gerrit.asterisk.org/812
To unsubscribe, visit https://gerrit.asterisk.org/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ibce5a94e70ecdf4e90329cf0ba66c33a62d37463
Gerrit-PatchSet: 1
Gerrit-Project: asterisk
Gerrit-Branch: master
Gerrit-Owner: Benjamin Keith Ford <bford at digium.com>
More information about the asterisk-code-review
mailing list