[Asterisk-code-review] ARI: Creating log channels (asterisk[13])
Scott Emidy
asteriskteam at digium.com
Wed Aug 5 17:16:11 CDT 2015
Scott Emidy has uploaded a new change for review.
https://gerrit.asterisk.org/1042
Change subject: ARI: Creating log channels
......................................................................
ARI: Creating log channels
An http request can be sent to create a log channel
in Asterisk.
The command "curl -v -u user:pass -X POST
"'http://localhost:088/ari/asterisk/logging/example?
configuration=notice,warning'" can be run in the terminal
to access the newly implemented functionality for ARI.
* Ability to create log channels using ARI
ASTERISK-25252
Change-Id: I9a20e5c75716dfbb6b62fd3474faf55be20bd782
---
M include/asterisk/logger.h
M main/logger.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, 282 insertions(+), 16 deletions(-)
git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/42/1042/2
diff --git a/include/asterisk/logger.h b/include/asterisk/logger.h
index be54f47..5422c38 100644
--- a/include/asterisk/logger.h
+++ b/include/asterisk/logger.h
@@ -91,6 +91,8 @@
void ast_log_callid(int level, const char *file, int line, const char *function, struct ast_callid *callid, const char *fmt, ...)
__attribute__((format(printf, 6, 7)));
+int ast_logger_create_channel(const char *channel, const char *components);
+
/*!
* \brief Log a backtrace of the current thread's execution stack to the Asterisk log
*/
diff --git a/main/logger.c b/main/logger.c
index 8fd8e50..5d62178 100644
--- a/main/logger.c
+++ b/main/logger.c
@@ -1054,6 +1054,44 @@
return CLI_SUCCESS;
}
+int ast_logger_create_channel(const char *channel, const char *components)
+{
+ struct logchannel *chan;
+ struct ast_str *filename = ast_str_create(64);
+ int success = 0;
+
+ if (ast_strlen_zero(components)) {
+ return -1;
+ }
+
+ if (!filename) {
+ return -2;
+ }
+
+ ast_str_append(&filename, 0, "%s/%s", ast_config_AST_LOG_DIR, channel);
+
+ AST_RWLIST_WRLOCK(&logchannels);
+
+ AST_RWLIST_TRAVERSE(&logchannels, chan, list) {
+ if (!strcmp(ast_str_buffer(filename), chan->filename)) {
+ success = 1;
+ }
+ }
+
+ if (!success) {
+ chan = make_logchannel(channel, components, 0, 1);
+ if (chan) {
+ AST_RWLIST_INSERT_HEAD(&logchannels, chan, list);
+ global_logmask |= chan->logmask;
+ AST_RWLIST_UNLOCK(&logchannels);
+ return 0;
+ }
+ }
+ AST_RWLIST_UNLOCK(&logchannels);
+
+ return success;
+}
+
static char *handle_logger_add_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
struct logchannel *chan;
diff --git a/res/ari/ari_model_validators.c b/res/ari/ari_model_validators.c
index 120daf5..48e8088 100644
--- a/res/ari/ari_model_validators.c
+++ b/res/ari/ari_model_validators.c
@@ -366,28 +366,50 @@
{
int res = 1;
struct ast_json_iter *iter;
- int has_logging_levels = 0;
- int has_name = 0;
+ int has_channel = 0;
+ int has_configuration = 0;
+ int has_status = 0;
+ int has_type = 0;
for (iter = ast_json_object_iter(json); iter; iter = ast_json_object_iter_next(json, iter)) {
- if (strcmp("logging_levels", ast_json_object_iter_key(iter)) == 0) {
+ if (strcmp("channel", ast_json_object_iter_key(iter)) == 0) {
int prop_is_valid;
- has_logging_levels = 1;
+ has_channel = 1;
+ prop_is_valid = ast_ari_validate_string(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI LogChannel field channel failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("configuration", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_configuration = 1;
prop_is_valid = ast_ari_validate_list(
ast_json_object_iter_value(iter),
ast_ari_validate_string);
if (!prop_is_valid) {
- ast_log(LOG_ERROR, "ARI LogChannel field logging_levels failed validation\n");
+ ast_log(LOG_ERROR, "ARI LogChannel field configuration failed validation\n");
res = 0;
}
} else
- if (strcmp("name", ast_json_object_iter_key(iter)) == 0) {
+ if (strcmp("status", ast_json_object_iter_key(iter)) == 0) {
int prop_is_valid;
- has_name = 1;
+ 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 LogChannel field name failed validation\n");
+ ast_log(LOG_ERROR, "ARI LogChannel field status failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("type", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_type = 1;
+ prop_is_valid = ast_ari_validate_string(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI LogChannel field type failed validation\n");
res = 0;
}
} else
@@ -399,13 +421,23 @@
}
}
- if (!has_logging_levels) {
- ast_log(LOG_ERROR, "ARI LogChannel missing required field logging_levels\n");
+ if (!has_channel) {
+ ast_log(LOG_ERROR, "ARI LogChannel missing required field channel\n");
res = 0;
}
- if (!has_name) {
- ast_log(LOG_ERROR, "ARI LogChannel missing required field name\n");
+ if (!has_configuration) {
+ ast_log(LOG_ERROR, "ARI LogChannel missing required field configuration\n");
+ res = 0;
+ }
+
+ if (!has_status) {
+ ast_log(LOG_ERROR, "ARI LogChannel missing required field status\n");
+ res = 0;
+ }
+
+ if (!has_type) {
+ ast_log(LOG_ERROR, "ARI LogChannel missing required field type\n");
res = 0;
}
diff --git a/res/ari/ari_model_validators.h b/res/ari/ari_model_validators.h
index fa39344..238b097 100644
--- a/res/ari/ari_model_validators.h
+++ b/res/ari/ari_model_validators.h
@@ -1302,8 +1302,10 @@
* - attribute: string (required)
* - value: string (required)
* LogChannel
- * - logging_levels: List[string] (required)
- * - name: string (required)
+ * - channel: string (required)
+ * - configuration: List[string] (required)
+ * - status: string (required)
+ * - type: string (required)
* Module
* - description: string (required)
* - name: string (required)
diff --git a/res/ari/resource_asterisk.c b/res/ari/resource_asterisk.c
index e227951..4e3e328 100644
--- a/res/ari/resource_asterisk.c
+++ b/res/ari/resource_asterisk.c
@@ -628,6 +628,33 @@
ast_ari_response_no_content(response);
}
+void ast_ari_asterisk_add_log(struct ast_variable *headers,
+ struct ast_ari_asterisk_add_log_args *args,
+ struct ast_ari_response *response)
+{
+ int pass;
+
+ ast_assert(response != NULL);
+
+ pass = ast_logger_create_channel(args->log_channel_name, args->configuration);
+
+ if (pass == -1) {
+ ast_ari_response_error(response, 400, "Bad Request",
+ "Configuration levels are required");
+ return;
+ } else if (pass == 1) {
+ ast_ari_response_error(response, 409, "Conflict",
+ "Log channel already exists");
+ return;
+ } else if (pass == -2) {
+ ast_ari_response_error(response, 500, "Internal Server Error",
+ "Allocation failed");
+ return;
+ }
+
+ ast_ari_response_no_content(response);
+}
+
void ast_ari_asterisk_rotate_log(struct ast_variable *headers,
struct ast_ari_asterisk_rotate_log_args *args,
struct ast_ari_response *response)
diff --git a/res/ari/resource_asterisk.h b/res/ari/resource_asterisk.h
index e271b05..1007260 100644
--- a/res/ari/resource_asterisk.h
+++ b/res/ari/resource_asterisk.h
@@ -194,6 +194,32 @@
* \param[out] response HTTP response
*/
void ast_ari_asterisk_reload_module(struct ast_variable *headers, struct ast_ari_asterisk_reload_module_args *args, struct ast_ari_response *response);
+/*! Argument struct for ast_ari_asterisk_add_log() */
+struct ast_ari_asterisk_add_log_args {
+ /*! The log channel to add */
+ const char *log_channel_name;
+ /*! levels of the log channel */
+ const char *configuration;
+};
+/*!
+ * \brief Body parsing function for /asterisk/logging/{logChannelName}.
+ * \param body The JSON body from which to parse parameters.
+ * \param[out] args The args structure to parse into.
+ * \retval zero on success
+ * \retval non-zero on failure
+ */
+int ast_ari_asterisk_add_log_parse_body(
+ struct ast_json *body,
+ struct ast_ari_asterisk_add_log_args *args);
+
+/*!
+ * \brief Adds a log channel.
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+void ast_ari_asterisk_add_log(struct ast_variable *headers, struct ast_ari_asterisk_add_log_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_asterisk_rotate_log() */
struct ast_ari_asterisk_rotate_log_args {
/*! Log channel's name */
diff --git a/res/res_ari_asterisk.c b/res/res_ari_asterisk.c
index d532da9..427a00d 100644
--- a/res/res_ari_asterisk.c
+++ b/res/res_ari_asterisk.c
@@ -721,6 +721,104 @@
fin: __attribute__((unused))
return;
}
+int ast_ari_asterisk_add_log_parse_body(
+ struct ast_json *body,
+ struct ast_ari_asterisk_add_log_args *args)
+{
+ struct ast_json *field;
+ /* Parse query parameters out of it */
+ field = ast_json_object_get(body, "configuration");
+ if (field) {
+ args->configuration = ast_json_string_get(field);
+ }
+ return 0;
+}
+
+/*!
+ * \brief Parameter parsing callback for /asterisk/logging/{logChannelName}.
+ * \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_add_log_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_add_log_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 = get_params; i; i = i->next) {
+ if (strcmp(i->name, "configuration") == 0) {
+ args.configuration = (i->value);
+ } else
+ {}
+ }
+ for (i = path_vars; i; i = i->next) {
+ if (strcmp(i->name, "logChannelName") == 0) {
+ args.log_channel_name = (i->value);
+ } else
+ {}
+ }
+ /* Look for a JSON request entity */
+ body = ast_http_get_json(ser, headers);
+ if (!body) {
+ switch (errno) {
+ case EFBIG:
+ ast_ari_response_error(response, 413, "Request Entity Too Large", "Request body too large");
+ goto fin;
+ case ENOMEM:
+ ast_ari_response_error(response, 500, "Internal Server Error", "Error processing request");
+ goto fin;
+ case EIO:
+ ast_ari_response_error(response, 400, "Bad Request", "Error parsing request body");
+ goto fin;
+ }
+ }
+ if (ast_ari_asterisk_add_log_parse_body(body, &args)) {
+ ast_ari_response_alloc_failed(response);
+ goto fin;
+ }
+ ast_ari_asterisk_add_log(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 400: /* Bad request body */
+ case 409: /* Log channel could not be created. */
+ 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 /asterisk/logging/{logChannelName}\n", code);
+ is_valid = 0;
+ }
+ }
+
+ if (!is_valid) {
+ ast_log(LOG_ERROR, "Response validation failed for /asterisk/logging/{logChannelName}\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 /asterisk/logging/{logChannelName}/rotate.
* \param get_params GET parameters in the HTTP request.
@@ -1061,6 +1159,7 @@
.path_segment = "logChannelName",
.is_wildcard = 1,
.callbacks = {
+ [AST_HTTP_POST] = ast_ari_asterisk_add_log_cb,
},
.num_children = 1,
.children = { &asterisk_logging_logChannelName_rotate, }
diff --git a/rest-api/api-docs/asterisk.json b/rest-api/api-docs/asterisk.json
index 6e0dd6c..e7e1cb2 100644
--- a/rest-api/api-docs/asterisk.json
+++ b/rest-api/api-docs/asterisk.json
@@ -297,6 +297,46 @@
]
},
{
+ "path": "/asterisk/logging/{logChannelName}",
+ "description": "Asterisk log channel",
+ "operations": [
+ {
+ "httpMethod": "POST",
+ "summary": "Adds a log channel.",
+ "nickname": "addLog",
+ "responseClass": "void",
+ "parameters": [
+ {
+ "name": "logChannelName",
+ "description": "The log channel to add",
+ "paramType": "path",
+ "required": true,
+ "allowMultiple": false,
+ "dataType": "string"
+ },
+ {
+ "name": "configuration",
+ "description": "levels of the log channel",
+ "paramType": "query",
+ "required": true,
+ "allowMultiple": false,
+ "dataType": "string"
+ }
+ ],
+ "errorResponses": [
+ {
+ "code": 400,
+ "reason": "Bad request body"
+ },
+ {
+ "code": 409,
+ "reason": "Log channel could not be created."
+ }
+ ]
+ }
+ ]
+ },
+ {
"path": "/asterisk/logging/{logChannelName}/rotate",
"description": "Asterisk log channel",
"operations": [
@@ -565,7 +605,7 @@
"id": "LogChannel",
"description": "Details of an Asterisk log channel",
"properties": {
- "name": {
+ "channel": {
"type": "string",
"description": "The log channel path",
"required": true
@@ -581,7 +621,7 @@
"required": true
},
"configuration": {
- "type": "string",
+ "type": "List[string]",
"description": "The various log levels",
"required": true
}
--
To view, visit https://gerrit.asterisk.org/1042
To unsubscribe, visit https://gerrit.asterisk.org/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I9a20e5c75716dfbb6b62fd3474faf55be20bd782
Gerrit-PatchSet: 2
Gerrit-Project: asterisk
Gerrit-Branch: 13
Gerrit-Owner: Scott Emidy <jemidy at digium.com>
More information about the asterisk-code-review
mailing list