mirror of
				https://github.com/asterisk/asterisk.git
				synced 2025-11-03 20:38:59 +00:00 
			
		
		
		
	The recent change to make the use of LOAD_DECLINE more consistent caused res_ari to unload itself before declining if the ari.conf file wasn't found. The ari stubs though still tried to use the configuration resulting in segfaults. This patch creates a new CHECK_ARI_MODULE_LOADED macro which tests to see if res_ari is actually loaded and causes the stubs to also decline if it isn't. The macro was then added to the mustache template's "load_module" function. ASTERISK-27026 #close Reported-by: Ronald Raikes Change-Id: I263d56efa628ee3c411bdcd16d49af6260c6c91d
		
			
				
	
	
		
			312 lines
		
	
	
		
			8.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			312 lines
		
	
	
		
			8.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/*
 | 
						|
 * Asterisk -- An open source telephony toolkit.
 | 
						|
 *
 | 
						|
 * Copyright (C) 2012 - 2013, Digium, Inc.
 | 
						|
 *
 | 
						|
 * David M. Lee, II <dlee@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 Playback control resources
 | 
						|
 *
 | 
						|
 * \author David M. Lee, II <dlee@digium.com>
 | 
						|
 */
 | 
						|
 | 
						|
/*** MODULEINFO
 | 
						|
	<depend type="module">res_ari</depend>
 | 
						|
	<depend type="module">res_ari_model</depend>
 | 
						|
	<depend type="module">res_stasis</depend>
 | 
						|
	<support_level>core</support_level>
 | 
						|
 ***/
 | 
						|
 | 
						|
#include "asterisk.h"
 | 
						|
 | 
						|
#include "asterisk/app.h"
 | 
						|
#include "asterisk/module.h"
 | 
						|
#include "asterisk/stasis_app.h"
 | 
						|
#include "ari/resource_playbacks.h"
 | 
						|
#if defined(AST_DEVMODE)
 | 
						|
#include "ari/ari_model_validators.h"
 | 
						|
#endif
 | 
						|
 | 
						|
#define MAX_VALS 128
 | 
						|
 | 
						|
/*!
 | 
						|
 * \brief Parameter parsing callback for /playbacks/{playbackId}.
 | 
						|
 * \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_playbacks_get_cb(
 | 
						|
	struct ast_tcptls_session_instance *ser,
 | 
						|
	struct ast_variable *get_params, struct ast_variable *path_vars,
 | 
						|
	struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
 | 
						|
{
 | 
						|
	struct ast_ari_playbacks_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, "playbackId") == 0) {
 | 
						|
			args.playback_id = (i->value);
 | 
						|
		} else
 | 
						|
		{}
 | 
						|
	}
 | 
						|
	ast_ari_playbacks_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 */
 | 
						|
	case 404: /* The playback cannot be found */
 | 
						|
		is_valid = 1;
 | 
						|
		break;
 | 
						|
	default:
 | 
						|
		if (200 <= code && code <= 299) {
 | 
						|
			is_valid = ast_ari_validate_playback(
 | 
						|
				response->message);
 | 
						|
		} else {
 | 
						|
			ast_log(LOG_ERROR, "Invalid error response %d for /playbacks/{playbackId}\n", code);
 | 
						|
			is_valid = 0;
 | 
						|
		}
 | 
						|
	}
 | 
						|
 | 
						|
	if (!is_valid) {
 | 
						|
		ast_log(LOG_ERROR, "Response validation failed for /playbacks/{playbackId}\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 /playbacks/{playbackId}.
 | 
						|
 * \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_playbacks_stop_cb(
 | 
						|
	struct ast_tcptls_session_instance *ser,
 | 
						|
	struct ast_variable *get_params, struct ast_variable *path_vars,
 | 
						|
	struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
 | 
						|
{
 | 
						|
	struct ast_ari_playbacks_stop_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, "playbackId") == 0) {
 | 
						|
			args.playback_id = (i->value);
 | 
						|
		} else
 | 
						|
		{}
 | 
						|
	}
 | 
						|
	ast_ari_playbacks_stop(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: /* The playback cannot be found */
 | 
						|
		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 /playbacks/{playbackId}\n", code);
 | 
						|
			is_valid = 0;
 | 
						|
		}
 | 
						|
	}
 | 
						|
 | 
						|
	if (!is_valid) {
 | 
						|
		ast_log(LOG_ERROR, "Response validation failed for /playbacks/{playbackId}\n");
 | 
						|
		ast_ari_response_error(response, 500,
 | 
						|
			"Internal Server Error", "Response validation failed");
 | 
						|
	}
 | 
						|
#endif /* AST_DEVMODE */
 | 
						|
 | 
						|
fin: __attribute__((unused))
 | 
						|
	return;
 | 
						|
}
 | 
						|
int ast_ari_playbacks_control_parse_body(
 | 
						|
	struct ast_json *body,
 | 
						|
	struct ast_ari_playbacks_control_args *args)
 | 
						|
{
 | 
						|
	struct ast_json *field;
 | 
						|
	/* Parse query parameters out of it */
 | 
						|
	field = ast_json_object_get(body, "operation");
 | 
						|
	if (field) {
 | 
						|
		args->operation = ast_json_string_get(field);
 | 
						|
	}
 | 
						|
	return 0;
 | 
						|
}
 | 
						|
 | 
						|
/*!
 | 
						|
 * \brief Parameter parsing callback for /playbacks/{playbackId}/control.
 | 
						|
 * \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_playbacks_control_cb(
 | 
						|
	struct ast_tcptls_session_instance *ser,
 | 
						|
	struct ast_variable *get_params, struct ast_variable *path_vars,
 | 
						|
	struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
 | 
						|
{
 | 
						|
	struct ast_ari_playbacks_control_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, "operation") == 0) {
 | 
						|
			args.operation = (i->value);
 | 
						|
		} else
 | 
						|
		{}
 | 
						|
	}
 | 
						|
	for (i = path_vars; i; i = i->next) {
 | 
						|
		if (strcmp(i->name, "playbackId") == 0) {
 | 
						|
			args.playback_id = (i->value);
 | 
						|
		} else
 | 
						|
		{}
 | 
						|
	}
 | 
						|
	if (ast_ari_playbacks_control_parse_body(body, &args)) {
 | 
						|
		ast_ari_response_alloc_failed(response);
 | 
						|
		goto fin;
 | 
						|
	}
 | 
						|
	ast_ari_playbacks_control(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: /* The provided operation parameter was invalid */
 | 
						|
	case 404: /* The playback cannot be found */
 | 
						|
	case 409: /* The operation cannot be performed in the playback's current state */
 | 
						|
		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 /playbacks/{playbackId}/control\n", code);
 | 
						|
			is_valid = 0;
 | 
						|
		}
 | 
						|
	}
 | 
						|
 | 
						|
	if (!is_valid) {
 | 
						|
		ast_log(LOG_ERROR, "Response validation failed for /playbacks/{playbackId}/control\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/playbacks.json */
 | 
						|
static struct stasis_rest_handlers playbacks_playbackId_control = {
 | 
						|
	.path_segment = "control",
 | 
						|
	.callbacks = {
 | 
						|
		[AST_HTTP_POST] = ast_ari_playbacks_control_cb,
 | 
						|
	},
 | 
						|
	.num_children = 0,
 | 
						|
	.children = {  }
 | 
						|
};
 | 
						|
/*! \brief REST handler for /api-docs/playbacks.json */
 | 
						|
static struct stasis_rest_handlers playbacks_playbackId = {
 | 
						|
	.path_segment = "playbackId",
 | 
						|
	.is_wildcard = 1,
 | 
						|
	.callbacks = {
 | 
						|
		[AST_HTTP_GET] = ast_ari_playbacks_get_cb,
 | 
						|
		[AST_HTTP_DELETE] = ast_ari_playbacks_stop_cb,
 | 
						|
	},
 | 
						|
	.num_children = 1,
 | 
						|
	.children = { &playbacks_playbackId_control, }
 | 
						|
};
 | 
						|
/*! \brief REST handler for /api-docs/playbacks.json */
 | 
						|
static struct stasis_rest_handlers playbacks = {
 | 
						|
	.path_segment = "playbacks",
 | 
						|
	.callbacks = {
 | 
						|
	},
 | 
						|
	.num_children = 1,
 | 
						|
	.children = { &playbacks_playbackId, }
 | 
						|
};
 | 
						|
 | 
						|
static int unload_module(void)
 | 
						|
{
 | 
						|
	ast_ari_remove_handler(&playbacks);
 | 
						|
	stasis_app_unref();
 | 
						|
	return 0;
 | 
						|
}
 | 
						|
 | 
						|
static int load_module(void)
 | 
						|
{
 | 
						|
	int res = 0;
 | 
						|
 | 
						|
	CHECK_ARI_MODULE_LOADED();
 | 
						|
 | 
						|
 | 
						|
	stasis_app_ref();
 | 
						|
	res |= ast_ari_add_handler(&playbacks);
 | 
						|
	if (res) {
 | 
						|
		unload_module();
 | 
						|
		return AST_MODULE_LOAD_DECLINE;
 | 
						|
	}
 | 
						|
 | 
						|
	return AST_MODULE_LOAD_SUCCESS;
 | 
						|
}
 | 
						|
 | 
						|
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - Playback control resources",
 | 
						|
	.support_level = AST_MODULE_SUPPORT_CORE,
 | 
						|
	.load = load_module,
 | 
						|
	.unload = unload_module,
 | 
						|
	.nonoptreq = "res_ari,res_stasis",
 | 
						|
);
 |