resource_asterisk.h File Reference

Generated file - declares stubs to be implemented in res/ari/resource_asterisk.c. More...

#include "asterisk/ari.h"

Include dependency graph for resource_asterisk.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ast_ari_asterisk_add_log_args
struct	ast_ari_asterisk_delete_log_args
struct	ast_ari_asterisk_delete_object_args
struct	ast_ari_asterisk_get_global_var_args
struct	ast_ari_asterisk_get_info_args
struct	ast_ari_asterisk_get_module_args
struct	ast_ari_asterisk_get_object_args
struct	ast_ari_asterisk_list_log_channels_args
struct	ast_ari_asterisk_list_modules_args
struct	ast_ari_asterisk_load_module_args
struct	ast_ari_asterisk_ping_args
struct	ast_ari_asterisk_reload_module_args
struct	ast_ari_asterisk_rotate_log_args
struct	ast_ari_asterisk_set_global_var_args
struct	ast_ari_asterisk_unload_module_args
struct	ast_ari_asterisk_update_object_args

Functions
void	ast_ari_asterisk_add_log (struct ast_variable *headers, struct ast_ari_asterisk_add_log_args *args, struct ast_ari_response *response)
	Adds a log channel. More...
int	ast_ari_asterisk_add_log_parse_body (struct ast_json *body, struct ast_ari_asterisk_add_log_args *args)
	Body parsing function for /asterisk/logging/{logChannelName}. More...
void	ast_ari_asterisk_delete_log (struct ast_variable *headers, struct ast_ari_asterisk_delete_log_args *args, struct ast_ari_response *response)
	Deletes a log channel. More...
void	ast_ari_asterisk_delete_object (struct ast_variable *headers, struct ast_ari_asterisk_delete_object_args *args, struct ast_ari_response *response)
	Delete a dynamic configuration object. More...
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)
	Get the value of a global variable. More...
int	ast_ari_asterisk_get_global_var_parse_body (struct ast_json *body, struct ast_ari_asterisk_get_global_var_args *args)
	Body parsing function for /asterisk/variable. More...
void	ast_ari_asterisk_get_info (struct ast_variable *headers, struct ast_ari_asterisk_get_info_args *args, struct ast_ari_response *response)
	Gets Asterisk system information. More...
int	ast_ari_asterisk_get_info_parse_body (struct ast_json *body, struct ast_ari_asterisk_get_info_args *args)
	Body parsing function for /asterisk/info. More...
void	ast_ari_asterisk_get_module (struct ast_variable *headers, struct ast_ari_asterisk_get_module_args *args, struct ast_ari_response *response)
	Get Asterisk module information. More...
void	ast_ari_asterisk_get_object (struct ast_variable *headers, struct ast_ari_asterisk_get_object_args *args, struct ast_ari_response *response)
	Retrieve a dynamic configuration object. More...
void	ast_ari_asterisk_list_log_channels (struct ast_variable *headers, struct ast_ari_asterisk_list_log_channels_args *args, struct ast_ari_response *response)
	Gets Asterisk log channel information. More...
void	ast_ari_asterisk_list_modules (struct ast_variable *headers, struct ast_ari_asterisk_list_modules_args *args, struct ast_ari_response *response)
	List Asterisk modules. More...
void	ast_ari_asterisk_load_module (struct ast_variable *headers, struct ast_ari_asterisk_load_module_args *args, struct ast_ari_response *response)
	Load an Asterisk module. More...
void	ast_ari_asterisk_ping (struct ast_variable *headers, struct ast_ari_asterisk_ping_args *args, struct ast_ari_response *response)
	Response pong message. More...
void	ast_ari_asterisk_reload_module (struct ast_variable *headers, struct ast_ari_asterisk_reload_module_args *args, struct ast_ari_response *response)
	Reload an Asterisk module. More...
void	ast_ari_asterisk_rotate_log (struct ast_variable *headers, struct ast_ari_asterisk_rotate_log_args *args, struct ast_ari_response *response)
	Rotates a log channel. More...
void	ast_ari_asterisk_set_global_var (struct ast_variable *headers, struct ast_ari_asterisk_set_global_var_args *args, struct ast_ari_response *response)
	Set the value of a global variable. More...
int	ast_ari_asterisk_set_global_var_parse_body (struct ast_json *body, struct ast_ari_asterisk_set_global_var_args *args)
	Body parsing function for /asterisk/variable. More...
void	ast_ari_asterisk_unload_module (struct ast_variable *headers, struct ast_ari_asterisk_unload_module_args *args, struct ast_ari_response *response)
	Unload an Asterisk module. More...
void	ast_ari_asterisk_update_object (struct ast_variable *headers, struct ast_ari_asterisk_update_object_args *args, struct ast_ari_response *response)
	Create or update a dynamic configuration object. More...
int	ast_ari_asterisk_update_object_parse_body (struct ast_json *body, struct ast_ari_asterisk_update_object_args *args)
	Body parsing function for /asterisk/config/dynamic/{configClass}/{objectType}/{id}. More...

Detailed Description

Generated file - declares stubs to be implemented in res/ari/resource_asterisk.c.

Asterisk resources

Author

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

Definition in file resource_asterisk.h.

Function Documentation

ast_ari_asterisk_add_log()

void ast_ari_asterisk_add_log	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_add_log_args *	args,
		struct ast_ari_response *	response
	)

Adds a log channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 705 of file resource_asterisk.c.

References ast_ari_response_error(), ast_ari_response_no_content(), ast_assert, AST_LOGGER_ALLOC_ERROR, ast_logger_create_channel(), AST_LOGGER_DECLINE, AST_LOGGER_FAILURE, ast_ari_asterisk_add_log_args::configuration, ast_ari_asterisk_add_log_args::log_channel_name, and NULL.

Referenced by ast_ari_asterisk_add_log_cb().

{
   int res;

   ast_assert(response != NULL);

   res = ast_logger_create_channel(args->log_channel_name, args->configuration);

   if (res == AST_LOGGER_DECLINE) {
      ast_ari_response_error(response, 400, "Bad Request",
         "Configuration levels are required");
      return;
   } else if (res == AST_LOGGER_FAILURE) {
      ast_ari_response_error(response, 409, "Conflict",
         "Log channel already exists");
      return;
   } else if (res == AST_LOGGER_ALLOC_ERROR) {
      ast_ari_response_error(response, 500, "Internal Server Error",
         "Allocation failed");
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_asterisk_add_log_parse_body()

int ast_ari_asterisk_add_log_parse_body	(	struct ast_json *	body,
		struct ast_ari_asterisk_add_log_args *	args
	)

Body parsing function for /asterisk/logging/{logChannelName}.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 783 of file res_ari_asterisk.c.

References ast_json_object_get(), ast_json_string_get(), and ast_ari_asterisk_add_log_args::configuration.

Referenced by ast_ari_asterisk_add_log_cb().

{
   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;
}

ast_ari_asterisk_delete_log()

void ast_ari_asterisk_delete_log	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_delete_log_args *	args,
		struct ast_ari_response *	response
	)

Deletes a log channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 757 of file resource_asterisk.c.

References ast_ari_response_error(), ast_ari_response_no_content(), ast_assert, AST_LOGGER_ALLOC_ERROR, AST_LOGGER_FAILURE, ast_logger_remove_channel(), ast_ari_asterisk_delete_log_args::log_channel_name, and NULL.

Referenced by ast_ari_asterisk_delete_log_cb().

{
   int res;

   ast_assert(response != NULL);

   res = ast_logger_remove_channel(args->log_channel_name);

   if (res == AST_LOGGER_FAILURE) {
      ast_ari_response_error(response, 404, "Not Found",
         "Log channel does not exist");
      return;
   } else if (res == AST_LOGGER_ALLOC_ERROR) {
      ast_ari_response_error(response, 500, "Internal Server Error",
         "Allocation failed");
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_asterisk_delete_object()

void ast_ari_asterisk_delete_object	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_delete_object_args *	args,
		struct ast_ari_response *	response
	)

Delete a dynamic configuration object.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 247 of file resource_asterisk.c.

References ao2_cleanup, ast_ari_response_error(), ast_ari_response_no_content(), ast_sorcery_delete(), ast_sorcery_get_object_type(), ast_sorcery_retrieve_by_id(), ast_sorcery_retrieve_by_module_name(), ast_sorcery_unref, ast_ari_asterisk_delete_object_args::config_class, ast_ari_asterisk_delete_object_args::id, NULL, ast_ari_asterisk_delete_object_args::object_type, RAII_VAR, and sorcery.

Referenced by ast_ari_asterisk_delete_object_cb().

{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct ast_sorcery_object_type *, object_type, NULL, ao2_cleanup);
   RAII_VAR(void *, sorcery_obj, NULL, ao2_cleanup);

   sorcery = ast_sorcery_retrieve_by_module_name(args->config_class);
   if (!sorcery) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "configClass '%s' not found",
         args->config_class);
      return;
   }

   object_type = ast_sorcery_get_object_type(sorcery, args->object_type);
   if (!object_type) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "objectType '%s' not found",
         args->object_type);
      return;
   }

   sorcery_obj = ast_sorcery_retrieve_by_id(sorcery, args->object_type, args->id);
   if (!sorcery_obj) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "Object with id '%s' not found",
         args->id);
      return;
   }

   if (ast_sorcery_delete(sorcery, sorcery_obj)) {
      ast_ari_response_error(
         response, 403, "Forbidden",
         "Could not delete object with id '%s'",
         args->id);
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_asterisk_get_global_var()

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
	)

Get the value of a global variable.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 780 of file resource_asterisk.c.

References ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_response_ok(), ast_assert, ast_free, ast_json_pack(), ast_json_ref(), ast_json_unref(), ast_str_create, ast_str_retrieve_variable(), ast_strlen_zero, NULL, RAII_VAR, S_OR, tmp(), value, and ast_ari_asterisk_get_global_var_args::variable.

Referenced by ast_ari_asterisk_get_global_var_cb().

{
   RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
   RAII_VAR(struct ast_str *, tmp, NULL, ast_free);

   const char *value;

   ast_assert(response != NULL);

   if (ast_strlen_zero(args->variable)) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "Variable name is required");
      return;
   }

   tmp = ast_str_create(32);
   if (!tmp) {
      ast_ari_response_alloc_failed(response);
      return;
   }

   value = ast_str_retrieve_variable(&tmp, 0, NULL, NULL, args->variable);

   if (!(json = ast_json_pack("{s: s}", "value", S_OR(value, "")))) {
      ast_ari_response_alloc_failed(response);
      return;
   }

   ast_ari_response_ok(response, ast_json_ref(json));
}

ast_ari_asterisk_get_global_var_parse_body()

int ast_ari_asterisk_get_global_var_parse_body	(	struct ast_json *	body,
		struct ast_ari_asterisk_get_global_var_args *	args
	)

Body parsing function for /asterisk/variable.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 981 of file res_ari_asterisk.c.

References ast_json_object_get(), ast_json_string_get(), and ast_ari_asterisk_get_global_var_args::variable.

Referenced by ast_ari_asterisk_get_global_var_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "variable");
   if (field) {
      args->variable = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_asterisk_get_info()

void ast_ari_asterisk_get_info	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_get_info_args *	args,
		struct ast_ari_response *	response
	)

Gets Asterisk system information.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 294 of file resource_asterisk.c.

References ast_ari_response_alloc_failed(), ast_ari_response_ok(), ast_build_date, ast_build_kernel, ast_build_machine, ast_build_os, ast_build_user, AST_BUILDOPTS, ast_config_AST_RUN_GROUP, ast_config_AST_RUN_USER, ast_config_AST_SYSTEM_NAME, ast_defaultlanguage, ast_eid_default, ast_eid_to_str(), ast_get_version(), ast_json_integer_create(), ast_json_object_create(), ast_json_object_set(), ast_json_pack(), ast_json_real_create(), ast_json_ref(), ast_json_timeval(), ast_json_unref(), ast_lastreloadtime, ast_log, ast_option_maxcalls, ast_option_maxfiles, ast_option_maxload, ast_startuptime, config, LOG_WARNING, NULL, ast_ari_asterisk_get_info_args::only, ast_ari_asterisk_get_info_args::only_count, and RAII_VAR.

Referenced by ast_ari_asterisk_get_info_cb().

{
   RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
   int show_all = args->only_count == 0;
   int show_build = show_all;
   int show_system = show_all;
   int show_config = show_all;
   int show_status = show_all;
   size_t i;
   int res = 0;

   for (i = 0; i < args->only_count; ++i) {
      if (strcasecmp("build", args->only[i]) == 0) {
         show_build = 1;
      } else if (strcasecmp("system", args->only[i]) == 0) {
         show_system = 1;
      } else if (strcasecmp("config", args->only[i]) == 0) {
         show_config = 1;
      } else if (strcasecmp("status", args->only[i]) == 0) {
         show_status = 1;
      } else {
         ast_log(LOG_WARNING, "Unrecognized info section '%s'\n",
            args->only[i]);
      }
   }

   json = ast_json_object_create();

   if (show_build) {
      res |= ast_json_object_set(json, "build",
         ast_json_pack(
            "{ s: s, s: s, s: s,"
            "  s: s, s: s, s: s }",

            "os", ast_build_os,
            "kernel", ast_build_kernel,
            "machine", ast_build_machine,

            "options", AST_BUILDOPTS,
            "date", ast_build_date,
            "user", ast_build_user));
   }

   if (show_system) {
      char eid_str[128];

      ast_eid_to_str(eid_str, sizeof(eid_str), &ast_eid_default);

      res |= ast_json_object_set(json, "system",
         ast_json_pack("{ s: s, s: s }",
            "version", ast_get_version(),
            "entity_id", eid_str));
   }

   if (show_config) {
      struct ast_json *config = ast_json_pack(
         "{ s: s, s: s,"
         " s: { s: s, s: s } }",

         "name", ast_config_AST_SYSTEM_NAME,
         "default_language", ast_defaultlanguage,

         "setid",
         "user", ast_config_AST_RUN_USER,
         "group", ast_config_AST_RUN_GROUP);

      res |= ast_json_object_set(json, "config", config);

      if (ast_option_maxcalls) {
         res |= ast_json_object_set(config, "max_channels",
            ast_json_integer_create(ast_option_maxcalls));
      }

      if (ast_option_maxfiles) {
         res |= ast_json_object_set(config, "max_open_files",
            ast_json_integer_create(ast_option_maxfiles));
      }

      if (ast_option_maxload) {
         res |= ast_json_object_set(config, "max_load",
            ast_json_real_create(ast_option_maxload));
      }
   }

   if (show_status) {
      res |= ast_json_object_set(json, "status",
         ast_json_pack("{ s: o, s: o }",
            "startup_time",
            ast_json_timeval(ast_startuptime, NULL),
            "last_reload_time",
            ast_json_timeval(ast_lastreloadtime, NULL)));
   }

   if (res != 0) {
      ast_ari_response_alloc_failed(response);
      return;
   }

   ast_ari_response_ok(response, ast_json_ref(json));
}

ast_ari_asterisk_get_info_parse_body()

int ast_ari_asterisk_get_info_parse_body	(	struct ast_json *	body,
		struct ast_ari_asterisk_get_info_args *	args
	)

Body parsing function for /asterisk/info.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 257 of file res_ari_asterisk.c.

References ast_free, AST_JSON_ARRAY, ast_json_array_get(), ast_json_array_size(), ast_json_object_get(), ast_json_string_get(), ast_json_typeof(), ast_malloc, ast_ari_asterisk_get_info_args::only, and ast_ari_asterisk_get_info_args::only_count.

Referenced by ast_ari_asterisk_get_info_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "only");
   if (field) {
      /* If they were silly enough to both pass in a query param and a
       * JSON body, free up the query value.
       */
      ast_free(args->only);
      if (ast_json_typeof(field) == AST_JSON_ARRAY) {
         /* Multiple param passed as array */
         size_t i;
         args->only_count = ast_json_array_size(field);
         args->only = ast_malloc(sizeof(*args->only) * args->only_count);

         if (!args->only) {
            return -1;
         }

         for (i = 0; i < args->only_count; ++i) {
            args->only[i] = ast_json_string_get(ast_json_array_get(field, i));
         }
      } else {
         /* Multiple param passed as single value */
         args->only_count = 1;
         args->only = ast_malloc(sizeof(*args->only) * args->only_count);
         if (!args->only) {
            return -1;
         }
         args->only[0] = ast_json_string_get(field);
      }
   }
   return 0;
}

ast_ari_asterisk_get_module()

void ast_ari_asterisk_get_module	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_get_module_args *	args,
		struct ast_ari_response *	response
	)

Get Asterisk module information.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 484 of file resource_asterisk.c.

References ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_response_ok(), ast_assert, ast_json_object_create(), ast_json_unref(), ast_module_check(), ast_update_module_list_condition(), identify_module(), ast_ari_asterisk_get_module_args::module_name, and NULL.

Referenced by ast_ari_asterisk_get_module_cb().

{
   struct ast_json *json;
   int module_retrieved = 0;

   ast_assert(response != NULL);

   if (!ast_module_check(args->module_name)) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "Module could not be found in running modules");
      return;
   }

   json = ast_json_object_create();
   if (!json) {
      ast_ari_response_alloc_failed(response);
      return;
   }

   module_retrieved = ast_update_module_list_condition(&identify_module, NULL, json,
                                                       args->module_name);
   if (!module_retrieved) {
      ast_ari_response_error(
         response, 409, "Conflict",
         "Module information could not be retrieved");
      ast_json_unref(json);
      return;
   }

   ast_ari_response_ok(response, json);
}

ast_ari_asterisk_get_object()

void ast_ari_asterisk_get_object	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_get_object_args *	args,
		struct ast_ari_response *	response
	)

Retrieve a dynamic configuration object.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 89 of file resource_asterisk.c.

References ao2_cleanup, ast_ari_response_error(), ast_sorcery_get_object_type(), ast_sorcery_retrieve_by_id(), ast_sorcery_retrieve_by_module_name(), ast_sorcery_unref, ast_ari_asterisk_get_object_args::config_class, ast_ari_asterisk_get_object_args::id, NULL, ast_ari_asterisk_get_object_args::object_type, RAII_VAR, return_sorcery_object(), and sorcery.

Referenced by ast_ari_asterisk_get_object_cb().

{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct ast_sorcery_object_type *, object_type, NULL, ao2_cleanup);
   RAII_VAR(void *, sorcery_obj, NULL, ao2_cleanup);


   sorcery = ast_sorcery_retrieve_by_module_name(args->config_class);
   if (!sorcery) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "configClass '%s' not found",
         args->config_class);
      return;
   }

   object_type = ast_sorcery_get_object_type(sorcery, args->object_type);
   if (!object_type) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "objectType '%s' not found",
         args->object_type);
      return;
   }

   sorcery_obj = ast_sorcery_retrieve_by_id(sorcery, args->object_type, args->id);
   if (!sorcery_obj) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "Object with id '%s' not found",
         args->id);
      return;
   }

   return_sorcery_object(sorcery, sorcery_obj, response);
}

ast_ari_asterisk_list_log_channels()

void ast_ari_asterisk_list_log_channels	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_list_log_channels_args *	args,
		struct ast_ari_response *	response
	)

Gets Asterisk log channel information.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 680 of file resource_asterisk.c.

References ast_ari_response_error(), ast_ari_response_ok(), ast_json_array_create(), ast_json_unref(), AST_LOGGER_ALLOC_ERROR, AST_LOGGER_FAILURE, ast_logger_get_channels(), and process_log_list().

Referenced by ast_ari_asterisk_list_log_channels_cb().

{
   struct ast_json *json;
   int res;

   json = ast_json_array_create();
   res = ast_logger_get_channels(&process_log_list, json);

   if (res == AST_LOGGER_FAILURE) {
      ast_ari_response_error(response, 500, "Internal Server Error",
         "Response body is not valid");
      ast_json_unref(json);
      return;
   } else if (res == AST_LOGGER_ALLOC_ERROR) {
      ast_ari_response_error(response, 500, "Internal Server Error",
         "Allocation Failed");
      ast_json_unref(json);
      return;
   }

   ast_ari_response_ok(response, json);
}

ast_ari_asterisk_list_modules()

void ast_ari_asterisk_list_modules	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_list_modules_args *	args,
		struct ast_ari_response *	response
	)

List Asterisk modules.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 429 of file resource_asterisk.c.

References ast_ari_response_alloc_failed(), ast_ari_response_ok(), ast_json_array_create(), ast_update_module_list_data(), NULL, and process_module_list().

Referenced by ast_ari_asterisk_list_modules_cb().

{
   struct ast_json *json;

   json = ast_json_array_create();
   if (!json) {
      ast_ari_response_alloc_failed(response);
      return;
   }
   ast_update_module_list_data(&process_module_list, NULL, json);

   ast_ari_response_ok(response, json);
}

ast_ari_asterisk_load_module()

void ast_ari_asterisk_load_module	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_load_module_args *	args,
		struct ast_ari_response *	response
	)

Load an Asterisk module.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 519 of file resource_asterisk.c.

References ast_ari_response_error(), ast_ari_response_no_content(), ast_assert, ast_load_resource(), ast_module_check(), AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_SKIP, ast_ari_asterisk_load_module_args::module_name, and NULL.

Referenced by ast_ari_asterisk_load_module_cb().

{
   enum ast_module_load_result load_result;

   ast_assert(response != NULL);

   if (ast_module_check(args->module_name)) {
      ast_ari_response_error(
         response, 409, "Conflict",
         "Module is already loaded");
      return;
   }

   load_result = ast_load_resource(args->module_name);

   if (load_result == AST_MODULE_LOAD_DECLINE) {
      ast_ari_response_error(
         response, 409, "Conflict",
         "Module load declined");
      return;
   } else if (load_result == AST_MODULE_LOAD_SKIP) {
      ast_ari_response_error(
         response, 409, "Conflict",
         "Module was skipped");
      return;
   } else if (load_result == AST_MODULE_LOAD_FAILURE) {
      ast_ari_response_error(
         response, 409, "Conflict",
         "Module could not be loaded properly");
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_asterisk_ping()

void ast_ari_asterisk_ping	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_ping_args *	args,
		struct ast_ari_response *	response
	)

Response pong message.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 634 of file resource_asterisk.c.

References ast_ari_response_ok(), ast_assert, ast_eid_default, ast_eid_to_str(), ast_json_pack(), ast_json_timeval(), ast_tvnow(), and NULL.

Referenced by ast_ari_asterisk_ping_cb().

{
   struct ast_json *json;
   char eid[20];

   ast_assert(response != NULL);

   json = ast_json_pack("{s: s, s: o, s: s}",
         "ping",  "pong",
         "timestamp", ast_json_timeval(ast_tvnow(), NULL),
         "asterisk_id", ast_eid_to_str(eid, sizeof(eid), &ast_eid_default)
         );

   ast_ari_response_ok(response, json);
}

ast_ari_asterisk_reload_module()

void ast_ari_asterisk_reload_module	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_reload_module_args *	args,
		struct ast_ari_response *	response
	)

Reload an Asterisk module.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 584 of file resource_asterisk.c.

References ast_ari_response_accepted(), ast_ari_response_error(), ast_ari_response_no_content(), ast_assert, ast_module_check(), ast_module_reload(), AST_MODULE_RELOAD_ERROR, AST_MODULE_RELOAD_IN_PROGRESS, AST_MODULE_RELOAD_NOT_FOUND, AST_MODULE_RELOAD_NOT_IMPLEMENTED, AST_MODULE_RELOAD_QUEUED, AST_MODULE_RELOAD_UNINITIALIZED, ast_ari_asterisk_reload_module_args::module_name, and NULL.

Referenced by ast_ari_asterisk_reload_module_cb().

{
   enum ast_module_reload_result reload_result;

   ast_assert(response != NULL);

   if (!ast_module_check(args->module_name)) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "Module not found in running modules");
      return;
   }

   reload_result = ast_module_reload(args->module_name);

   if (reload_result == AST_MODULE_RELOAD_NOT_FOUND) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "Module could not be found");
      return;
   } else if (reload_result == AST_MODULE_RELOAD_ERROR) {
      ast_ari_response_error(
         response, 409, "Conflict",
         "An unknown error occurred while reloading the module");
      return;
   } else if (reload_result == AST_MODULE_RELOAD_IN_PROGRESS) {
      ast_ari_response_error(
         response, 409, "Conflict",
         "Another reload is currently in progress");
      return;
   } else if (reload_result == AST_MODULE_RELOAD_UNINITIALIZED) {
      ast_ari_response_error(
         response, 409, "Conflict",
         "Module has not been initialized");
      return;
   } else if (reload_result == AST_MODULE_RELOAD_NOT_IMPLEMENTED) {
      ast_ari_response_error(
         response, 409, "Conflict",
         "Module does not support reloading");
      return;
   } else if (reload_result == AST_MODULE_RELOAD_QUEUED) {
      ast_ari_response_accepted(response);
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_asterisk_rotate_log()

void ast_ari_asterisk_rotate_log	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_rotate_log_args *	args,
		struct ast_ari_response *	response
	)

Rotates a log channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 732 of file resource_asterisk.c.

References ast_ari_response_error(), ast_ari_response_no_content(), ast_assert, AST_LOGGER_ALLOC_ERROR, AST_LOGGER_FAILURE, ast_logger_rotate_channel(), ast_ari_asterisk_rotate_log_args::log_channel_name, and NULL.

Referenced by ast_ari_asterisk_rotate_log_cb().

{
   int res;

   ast_assert(response != NULL);

   res = ast_logger_rotate_channel(args->log_channel_name);

   if (res == AST_LOGGER_FAILURE) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "Log channel does not exist");
      return;
   } else if (res == AST_LOGGER_ALLOC_ERROR) {
      ast_ari_response_error(
         response, 500, "Internal Server Error",
         "Allocation failed");
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_asterisk_set_global_var()

void ast_ari_asterisk_set_global_var	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_set_global_var_args *	args,
		struct ast_ari_response *	response
	)

Set the value of a global variable.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 814 of file resource_asterisk.c.

References ast_ari_response_error(), ast_ari_response_no_content(), ast_assert, ast_strlen_zero, NULL, pbx_builtin_setvar_helper(), ast_ari_asterisk_set_global_var_args::value, and ast_ari_asterisk_set_global_var_args::variable.

Referenced by ast_ari_asterisk_set_global_var_cb().

{
   ast_assert(response != NULL);

   if (ast_strlen_zero(args->variable)) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "Variable name is required");
      return;
   }

   pbx_builtin_setvar_helper(NULL, args->variable, args->value);

   ast_ari_response_no_content(response);
}

ast_ari_asterisk_set_global_var_parse_body()

int ast_ari_asterisk_set_global_var_parse_body	(	struct ast_json *	body,
		struct ast_ari_asterisk_set_global_var_args *	args
	)

Body parsing function for /asterisk/variable.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 1056 of file res_ari_asterisk.c.

References ast_json_object_get(), ast_json_string_get(), ast_ari_asterisk_set_global_var_args::value, and ast_ari_asterisk_set_global_var_args::variable.

Referenced by ast_ari_asterisk_set_global_var_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "variable");
   if (field) {
      args->variable = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "value");
   if (field) {
      args->value = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_asterisk_unload_module()

void ast_ari_asterisk_unload_module	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_unload_module_args *	args,
		struct ast_ari_response *	response
	)

Unload an Asterisk module.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 556 of file resource_asterisk.c.

References ast_ari_response_error(), ast_ari_response_no_content(), ast_assert, AST_FORCE_SOFT, ast_module_check(), ast_unload_resource(), ast_ari_asterisk_unload_module_args::module_name, and NULL.

Referenced by ast_ari_asterisk_unload_module_cb().

{
   int unload_result;
   enum ast_module_unload_mode unload_mode = AST_FORCE_SOFT;

   ast_assert(response != NULL);

   if (!ast_module_check(args->module_name)) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "Module not found in running modules");
      return;
   }

   unload_result = ast_unload_resource(args->module_name, unload_mode);

   if (unload_result != 0) {
      ast_ari_response_error(
         response, 409, "Conflict",
         "Module could not be unloaded");
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_asterisk_update_object()

void ast_ari_asterisk_update_object	(	struct ast_variable *	headers,
		struct ast_ari_asterisk_update_object_args *	args,
		struct ast_ari_response *	response
	)

Create or update a dynamic configuration object.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 128 of file resource_asterisk.c.

References ao2_cleanup, ao2_ref, ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_debug, ast_json_array_get(), ast_json_array_size(), ast_json_object_get(), ast_json_string_get(), ast_sorcery_alloc(), ast_sorcery_copy(), ast_sorcery_create(), ast_sorcery_get_object_type(), ast_sorcery_objectset_apply(), ast_sorcery_retrieve_by_id(), ast_sorcery_retrieve_by_module_name(), ast_sorcery_unref, ast_sorcery_update(), ast_variable_list_append, ast_variable_new, ast_variables_destroy(), ast_ari_asterisk_update_object_args::config_class, copy(), ast_ari_asterisk_update_object_args::fields, ast_ari_asterisk_update_object_args::id, NULL, ast_ari_asterisk_update_object_args::object_type, RAII_VAR, return_sorcery_object(), and sorcery.

Referenced by ast_ari_asterisk_update_object_cb().

{
   RAII_VAR(struct ast_sorcery *, sorcery, NULL, ast_sorcery_unref);
   RAII_VAR(struct ast_sorcery_object_type *, object_type, NULL, ao2_cleanup);
   RAII_VAR(void *, sorcery_obj, NULL, ao2_cleanup);
   struct ast_json *fields;
   struct ast_variable *update_set = NULL;
   int created = 0;

   sorcery = ast_sorcery_retrieve_by_module_name(args->config_class);
   if (!sorcery) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "configClass '%s' not found",
         args->config_class);
      return;
   }

   object_type = ast_sorcery_get_object_type(sorcery, args->object_type);
   if (!object_type) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "objectType '%s' not found",
         args->object_type);
      return;
   }

   sorcery_obj = ast_sorcery_retrieve_by_id(sorcery, args->object_type, args->id);
   if (!sorcery_obj) {
      ast_debug(5, "Sorcery object '%s' does not exist; creating it\n", args->id);
      sorcery_obj = ast_sorcery_alloc(sorcery, args->object_type, args->id);
      if (!sorcery_obj) {
         ast_ari_response_alloc_failed(response);
         return;
      }

      created = 1;
   } else {
      void *copy;

      copy = ast_sorcery_copy(sorcery, sorcery_obj);
      if (!copy) {
         ast_ari_response_alloc_failed(response);
         return;
      }

      ao2_ref(sorcery_obj, -1);
      sorcery_obj = copy;
   }

   fields = ast_json_object_get(args->fields, "fields");
   if (!fields && !created) {
      /* Whoops. We need data. */
      ast_ari_response_error(
         response, 400, "Bad request",
         "Fields must be provided to update object '%s'",
         args->id);
      return;
   } else if (fields) {
      size_t i;

      for (i = 0; i < ast_json_array_size(fields); i++) {
         struct ast_variable *new_var;
         struct ast_json *json_value = ast_json_array_get(fields, i);

         if (!json_value) {
            continue;
         }

         new_var = ast_variable_new(
            ast_json_string_get(ast_json_object_get(json_value, "attribute")),
            ast_json_string_get(ast_json_object_get(json_value, "value")),
            "");
         if (!new_var) {
            ast_variables_destroy(update_set);
            ast_ari_response_alloc_failed(response);
            return;
         }
         ast_variable_list_append(&update_set, new_var);
      }
   }

   /* APPLY! Note that a NULL update_set is fine (and necessary), as it
    * will force validation on a newly created object.
    */
   if (ast_sorcery_objectset_apply(sorcery, sorcery_obj, update_set)) {
      ast_variables_destroy(update_set);
      ast_ari_response_error(
         response, 400, "Bad request",
         "%s of object '%s' failed field value validation",
         created ? "Creation" : "Update",
         args->id);
      return;
   }

   ast_variables_destroy(update_set);

   if (created) {
      if (ast_sorcery_create(sorcery, sorcery_obj)) {
         ast_ari_response_error(
            response, 403, "Forbidden",
            "Cannot create sorcery objects of type '%s'",
            args->object_type);
         return;
      }
   } else {
      if (ast_sorcery_update(sorcery, sorcery_obj)) {
         ast_ari_response_error(
            response, 403, "Forbidden",
            "Cannot update sorcery objects of type '%s'",
            args->object_type);
         return;
      }
   }

   return_sorcery_object(sorcery, sorcery_obj, response);
}

ast_ari_asterisk_update_object_parse_body()

int ast_ari_asterisk_update_object_parse_body	(	struct ast_json *	body,
		struct ast_ari_asterisk_update_object_args *	args
	)

Body parsing function for /asterisk/config/dynamic/{configClass}/{objectType}/{id}.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 117 of file res_ari_asterisk.c.

{
   /* Parse query parameters out of it */
   return 0;
}