[Asterisk-code-review] ARI: Deleting log channels (asterisk[13])
Scott Emidy
asteriskteam at digium.com
Thu Aug 6 15:36:37 CDT 2015
Scott Emidy has uploaded a new change for review.
https://gerrit.asterisk.org/1048
Change subject: ARI: Deleting log channels
......................................................................
ARI: Deleting log channels
An http request can be sent to delete a log channel
in Asterisk.
The command "curl -v -u user:pass -X DELETE 'http://localhost:8088
/ari/asterisk/logging/mylog'" can be run in the terminal
to access the newly implemented functionally for ARI.
* Able to delete log channels using ARI
ASTERISK-25252
Change-Id: Id6eeb54ebcc511595f0418d586ff55914bc3aae6
---
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, 211 insertions(+), 12 deletions(-)
git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/48/1048/3
diff --git a/include/asterisk/logger.h b/include/asterisk/logger.h
index be54f47..9f15776 100644
--- a/include/asterisk/logger.h
+++ b/include/asterisk/logger.h
@@ -92,6 +92,13 @@
__attribute__((format(printf, 6, 7)));
/*!
+ * \brief Delete the specified log channel
+ *
+ * \param log_channel The log channel to delete
+ */
+int ast_logger_remove_channel(const char *log_channel);
+
+/*!
* \brief Log a backtrace of the current thread's execution stack to the Asterisk log
*/
void ast_log_backtrace(void);
diff --git a/main/logger.c b/main/logger.c
index 8fd8e50..0129745 100644
--- a/main/logger.c
+++ b/main/logger.c
@@ -1103,6 +1103,41 @@
return CLI_FAILURE;
}
+int ast_logger_remove_channel(const char *log_channel)
+{
+ struct logchannel *chan;
+ struct ast_str *filename = ast_str_create(64);
+
+ if (!filename) {
+ return -1;
+ }
+
+ ast_str_append(&filename, 0, "%s/%s", ast_config_AST_LOG_DIR, log_channel);
+
+ AST_RWLIST_WRLOCK(&logchannels);
+ AST_RWLIST_TRAVERSE_SAFE_BEGIN(&logchannels, chan, list) {
+ if (chan->dynamic && !strcmp(chan->filename, ast_str_buffer(filename))) {
+ AST_RWLIST_REMOVE_CURRENT(list);
+ break;
+ }
+ }
+ AST_RWLIST_TRAVERSE_SAFE_END;
+ AST_RWLIST_UNLOCK(&logchannels);
+
+ if (!chan) {
+ return 1;
+ }
+
+ if (chan->fileptr) {
+ fclose(chan->fileptr);
+ chan->fileptr = NULL;
+ }
+ ast_free(chan);
+ chan = NULL;
+
+ return 0;
+}
+
static char *handle_logger_remove_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..26e9b74 100644
--- a/res/ari/ari_model_validators.c
+++ b/res/ari/ari_model_validators.c
@@ -366,18 +366,19 @@
{
int res = 1;
struct ast_json_iter *iter;
- int has_logging_levels = 0;
+ int has_configuration = 0;
int has_name = 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("configuration", ast_json_object_iter_key(iter)) == 0) {
int prop_is_valid;
- has_logging_levels = 1;
- prop_is_valid = ast_ari_validate_list(
- ast_json_object_iter_value(iter),
- ast_ari_validate_string);
+ has_configuration = 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 logging_levels failed validation\n");
+ ast_log(LOG_ERROR, "ARI LogChannel field configuration failed validation\n");
res = 0;
}
} else
@@ -391,6 +392,26 @@
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 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
{
ast_log(LOG_ERROR,
"ARI LogChannel has undocumented field %s\n",
@@ -399,8 +420,8 @@
}
}
- if (!has_logging_levels) {
- ast_log(LOG_ERROR, "ARI LogChannel missing required field logging_levels\n");
+ if (!has_configuration) {
+ ast_log(LOG_ERROR, "ARI LogChannel missing required field configuration\n");
res = 0;
}
@@ -409,6 +430,16 @@
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;
+ }
+
return res;
}
diff --git a/res/ari/ari_model_validators.h b/res/ari/ari_model_validators.h
index fa39344..b181506 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)
+ * - configuration: string (required)
* - name: 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..eed4c99 100644
--- a/res/ari/resource_asterisk.c
+++ b/res/ari/resource_asterisk.c
@@ -653,6 +653,29 @@
ast_ari_response_no_content(response);
}
+void ast_ari_asterisk_delete_log(struct ast_variable *headers,
+ struct ast_ari_asterisk_delete_log_args *args,
+ struct ast_ari_response *response)
+{
+ int success;
+
+ ast_assert(response != NULL);
+
+ success = ast_logger_remove_channel(args->log_channel_name);
+
+ if (success == 1) {
+ ast_ari_response_error(response, 404, "Not Found",
+ "Log channel does not exist");
+ return;
+ } else if (success == -1) {
+ ast_ari_response_error(response, 500, "Internal Server Error",
+ "Allocation failed");
+ return;
+ }
+
+ ast_ari_response_no_content(response);
+}
+
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 e271b05..00f463c 100644
--- a/res/ari/resource_asterisk.h
+++ b/res/ari/resource_asterisk.h
@@ -194,6 +194,19 @@
* \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_delete_log() */
+struct ast_ari_asterisk_delete_log_args {
+ /*! Log channels name */
+ const char *log_channel_name;
+};
+/*!
+ * \brief Deletes a log channel.
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+void ast_ari_asterisk_delete_log(struct ast_variable *headers, struct ast_ari_asterisk_delete_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..320800a 100644
--- a/res/res_ari_asterisk.c
+++ b/res/res_ari_asterisk.c
@@ -722,6 +722,65 @@
return;
}
/*!
+ * \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_delete_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_delete_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 = path_vars; i; i = i->next) {
+ if (strcmp(i->name, "logChannelName") == 0) {
+ args.log_channel_name = (i->value);
+ } else
+ {}
+ }
+ ast_ari_asterisk_delete_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 404: /* Log channel does not exist. */
+ 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.
* \param path_vars Path variables extracted from the request.
@@ -1061,6 +1120,7 @@
.path_segment = "logChannelName",
.is_wildcard = 1,
.callbacks = {
+ [AST_HTTP_DELETE] = ast_ari_asterisk_delete_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..c251dfa 100644
--- a/rest-api/api-docs/asterisk.json
+++ b/rest-api/api-docs/asterisk.json
@@ -297,6 +297,34 @@
]
},
{
+ "path": "/asterisk/logging/{logChannelName}",
+ "description": "Asterisk log channel",
+ "operations": [
+ {
+ "httpMethod": "DELETE",
+ "summary": "Deletes a log channel.",
+ "nickname": "deleteLog",
+ "responseClass": "void",
+ "parameters": [
+ {
+ "name": "logChannelName",
+ "description": "Log channels name",
+ "paramType": "path",
+ "required": true,
+ "allowMultiple": false,
+ "dataType": "string"
+ }
+ ],
+ "errorResponses": [
+ {
+ "code": 404,
+ "reason": "Log channel does not exist."
+ }
+ ]
+ }
+ ]
+ },
+ {
"path": "/asterisk/logging/{logChannelName}/rotate",
"description": "Asterisk log channel",
"operations": [
@@ -565,7 +593,7 @@
"id": "LogChannel",
"description": "Details of an Asterisk log channel",
"properties": {
- "name": {
+ "channel": {
"type": "string",
"description": "The log channel path",
"required": true
@@ -581,7 +609,7 @@
"required": true
},
"configuration": {
- "type": "string",
+ "type": "List[string]",
"description": "The various log levels",
"required": true
}
--
To view, visit https://gerrit.asterisk.org/1048
To unsubscribe, visit https://gerrit.asterisk.org/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Id6eeb54ebcc511595f0418d586ff55914bc3aae6
Gerrit-PatchSet: 3
Gerrit-Project: asterisk
Gerrit-Branch: 13
Gerrit-Owner: Scott Emidy <jemidy at digium.com>
More information about the asterisk-code-review
mailing list