mirror of
				https://github.com/asterisk/asterisk.git
				synced 2025-10-31 10:47:18 +00:00 
			
		
		
		
	I've audited all modules that include any header which includes asterisk/optional_api.h. All modules which use OPTIONAL_API now declare those dependencies in AST_MODULE_INFO using requires or optional_modules as appropriate. In addition ARI dependency declarations have been reworked. Instead of declaring additional required modules in res/ari/resource_*.c we now add them to an optional array "requiresModules" in api-docs for each module. This allows the AST_MODULE_INFO dependencies to include those missing modules. Change-Id: Ia0c70571f5566784f63605e78e1ceccb4f79c606
		
			
				
	
	
		
			360 lines
		
	
	
		
			9.6 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			360 lines
		
	
	
		
			9.6 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.
 | |
|  */
 | |
| 
 | |
| /*! \file
 | |
|  *
 | |
|  * \brief /api-docs/recordings.{format} implementation- Recording resources
 | |
|  *
 | |
|  * \author David M. Lee, II <dlee@digium.com>
 | |
|  */
 | |
| 
 | |
| /*** MODULEINFO
 | |
| 	<support_level>core</support_level>
 | |
|  ***/
 | |
| 
 | |
| #include "asterisk.h"
 | |
| 
 | |
| #include "asterisk/stasis_app_recording.h"
 | |
| #include "resource_recordings.h"
 | |
| 
 | |
| void ast_ari_recordings_list_stored(struct ast_variable *headers,
 | |
| 	struct ast_ari_recordings_list_stored_args *args,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	RAII_VAR(struct ao2_container *, recordings, NULL, ao2_cleanup);
 | |
| 	RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
 | |
| 	struct ao2_iterator i;
 | |
| 	void *obj;
 | |
| 
 | |
| 	recordings = stasis_app_stored_recording_find_all();
 | |
| 
 | |
| 	if (!recordings) {
 | |
| 		ast_ari_response_alloc_failed(response);
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	json = ast_json_array_create();
 | |
| 	if (!json) {
 | |
| 		ast_ari_response_alloc_failed(response);
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	i = ao2_iterator_init(recordings, 0);
 | |
| 	while ((obj = ao2_iterator_next(&i))) {
 | |
| 		RAII_VAR(struct stasis_app_stored_recording *, recording, obj,
 | |
| 			ao2_cleanup);
 | |
| 
 | |
| 		int r = ast_json_array_append(
 | |
| 			json, stasis_app_stored_recording_to_json(recording));
 | |
| 		if (r != 0) {
 | |
| 			ast_ari_response_alloc_failed(response);
 | |
| 			ao2_iterator_destroy(&i);
 | |
| 			return;
 | |
| 		}
 | |
| 	}
 | |
| 	ao2_iterator_destroy(&i);
 | |
| 
 | |
| 	ast_ari_response_ok(response, ast_json_ref(json));
 | |
| }
 | |
| 
 | |
| void ast_ari_recordings_get_stored(struct ast_variable *headers,
 | |
| 	struct ast_ari_recordings_get_stored_args *args,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	RAII_VAR(struct stasis_app_stored_recording *, recording, NULL,
 | |
| 		ao2_cleanup);
 | |
| 	struct ast_json *json;
 | |
| 
 | |
| 	recording = stasis_app_stored_recording_find_by_name(
 | |
| 		args->recording_name);
 | |
| 	if (recording == NULL) {
 | |
| 		ast_ari_response_error(response, 404, "Not Found",
 | |
| 			"Recording not found");
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	json = stasis_app_stored_recording_to_json(recording);
 | |
| 	if (json == NULL) {
 | |
| 		ast_ari_response_error(response, 500,
 | |
| 			"Internal Server Error", "Error building response");
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	ast_ari_response_ok(response, json);
 | |
| }
 | |
| 
 | |
| void ast_ari_recordings_get_stored_file(struct ast_tcptls_session_instance *ser,
 | |
| 	struct ast_variable *headers, struct ast_ari_recordings_get_stored_file_args *args,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	RAII_VAR(struct stasis_app_stored_recording *, recording,
 | |
| 		stasis_app_stored_recording_find_by_name(args->recording_name),
 | |
| 		ao2_cleanup);
 | |
| 	static const char *format_type_names[AST_MEDIA_TYPE_TEXT + 1] = {
 | |
| 		[AST_MEDIA_TYPE_UNKNOWN] = "binary",
 | |
| 		[AST_MEDIA_TYPE_AUDIO] = "audio",
 | |
| 		[AST_MEDIA_TYPE_VIDEO] = "video",
 | |
| 		[AST_MEDIA_TYPE_IMAGE] = "image",
 | |
| 		[AST_MEDIA_TYPE_TEXT] = "text",
 | |
| 	};
 | |
| 	struct ast_format *format;
 | |
| 
 | |
| 	response->message = ast_json_null();
 | |
| 
 | |
| 	if (!recording) {
 | |
| 		ast_ari_response_error(response, 404, "Not Found",
 | |
| 			"Recording not found");
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	format = ast_get_format_for_file_ext(stasis_app_stored_recording_get_extension(recording));
 | |
| 	if (!format) {
 | |
| 		ast_ari_response_error(response, 500, "Internal Server Error",
 | |
| 			"Format specified by recording not available or loaded");
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	response->fd = open(stasis_app_stored_recording_get_filename(recording), O_RDONLY);
 | |
| 	if (response->fd < 0) {
 | |
| 		ast_ari_response_error(response, 403, "Forbidden",
 | |
| 			"Recording could not be opened");
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	ast_str_append(&response->headers, 0, "Content-Type: %s/%s\r\n",
 | |
| 		format_type_names[ast_format_get_type(format)],
 | |
| 		stasis_app_stored_recording_get_extension(recording));
 | |
| 	ast_ari_response_ok(response, ast_json_null());
 | |
| }
 | |
| 
 | |
| void ast_ari_recordings_copy_stored(struct ast_variable *headers,
 | |
| 	struct ast_ari_recordings_copy_stored_args *args,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	RAII_VAR(struct stasis_app_stored_recording *, src_recording, NULL,
 | |
| 		ao2_cleanup);
 | |
| 	RAII_VAR(struct stasis_app_stored_recording *, dst_recording, NULL,
 | |
| 		ao2_cleanup);
 | |
| 	struct ast_json *json;
 | |
| 	int res;
 | |
| 
 | |
| 	src_recording = stasis_app_stored_recording_find_by_name(
 | |
| 		args->recording_name);
 | |
| 	if (src_recording == NULL) {
 | |
| 		ast_ari_response_error(response, 404, "Not Found",
 | |
| 			"Recording not found");
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	dst_recording = stasis_app_stored_recording_find_by_name(
 | |
| 		args->destination_recording_name);
 | |
| 	if (dst_recording) {
 | |
| 		ast_ari_response_error(response, 409, "Conflict",
 | |
| 			"A recording with the same name already exists on the system");
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	/* See if we got our name rejected */
 | |
| 	switch (errno) {
 | |
| 	case EINVAL:
 | |
| 		ast_ari_response_error(response, 400, "Bad request",
 | |
| 			"Invalid destination recording name");
 | |
| 		return;
 | |
| 	case EACCES:
 | |
| 		ast_ari_response_error(response, 403, "Forbidden",
 | |
| 			"Destination file path is forbidden");
 | |
| 		return;
 | |
| 	default:
 | |
| 		break;
 | |
| 	}
 | |
| 
 | |
| 	res = stasis_app_stored_recording_copy(src_recording,
 | |
| 		args->destination_recording_name, &dst_recording);
 | |
| 	if (res) {
 | |
| 		switch (errno) {
 | |
| 		case EACCES:
 | |
| 		case EPERM:
 | |
| 			ast_ari_response_error(response, 500,
 | |
| 				"Internal Server Error",
 | |
| 				"Copy failed");
 | |
| 			break;
 | |
| 		default:
 | |
| 			ast_log(LOG_WARNING,
 | |
| 				"Unexpected error copying recording %s to %s: %s\n",
 | |
| 				args->recording_name, args->destination_recording_name, strerror(errno));
 | |
| 			ast_ari_response_error(response, 500,
 | |
| 				"Internal Server Error",
 | |
| 				"Copy failed");
 | |
| 			break;
 | |
| 		}
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	json = stasis_app_stored_recording_to_json(dst_recording);
 | |
| 	if (json == NULL) {
 | |
| 		ast_ari_response_error(response, 500,
 | |
| 			"Internal Server Error", "Error building response");
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	ast_ari_response_ok(response, json);
 | |
| }
 | |
| 
 | |
| void ast_ari_recordings_delete_stored(struct ast_variable *headers,
 | |
| 	struct ast_ari_recordings_delete_stored_args *args,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	RAII_VAR(struct stasis_app_stored_recording *, recording, NULL,
 | |
| 		ao2_cleanup);
 | |
| 	int res;
 | |
| 
 | |
| 	recording = stasis_app_stored_recording_find_by_name(
 | |
| 		args->recording_name);
 | |
| 	if (recording == NULL) {
 | |
| 		ast_ari_response_error(response, 404, "Not Found",
 | |
| 			"Recording not found");
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	res = stasis_app_stored_recording_delete(recording);
 | |
| 
 | |
| 	if (res != 0) {
 | |
| 		switch (errno) {
 | |
| 		case EACCES:
 | |
| 		case EPERM:
 | |
| 			ast_ari_response_error(response, 500,
 | |
| 				"Internal Server Error",
 | |
| 				"Delete failed");
 | |
| 			break;
 | |
| 		default:
 | |
| 			ast_log(LOG_WARNING,
 | |
| 				"Unexpected error deleting recording %s: %s\n",
 | |
| 				args->recording_name, strerror(errno));
 | |
| 			ast_ari_response_error(response, 500,
 | |
| 				"Internal Server Error",
 | |
| 				"Delete failed");
 | |
| 			break;
 | |
| 		}
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	ast_ari_response_no_content(response);
 | |
| }
 | |
| 
 | |
| void ast_ari_recordings_get_live(struct ast_variable *headers,
 | |
| 	struct ast_ari_recordings_get_live_args *args,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	RAII_VAR(struct stasis_app_recording *, recording, NULL, ao2_cleanup);
 | |
| 	struct ast_json *json;
 | |
| 
 | |
| 	recording = stasis_app_recording_find_by_name(args->recording_name);
 | |
| 	if (recording == NULL) {
 | |
| 		ast_ari_response_error(response, 404, "Not Found",
 | |
| 			"Recording not found");
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	json = stasis_app_recording_to_json(recording);
 | |
| 	if (json == NULL) {
 | |
| 		ast_ari_response_error(response, 500,
 | |
| 			"Internal Server Error", "Error building response");
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	ast_ari_response_ok(response, json);
 | |
| }
 | |
| 
 | |
| static void control_recording(const char *name,
 | |
| 	enum stasis_app_recording_media_operation operation,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	RAII_VAR(struct stasis_app_recording *, recording, NULL, ao2_cleanup);
 | |
| 	enum stasis_app_recording_oper_results res;
 | |
| 
 | |
| 	recording = stasis_app_recording_find_by_name(name);
 | |
| 	if (recording == NULL) {
 | |
| 		ast_ari_response_error(response, 404, "Not Found",
 | |
| 			"Recording not found");
 | |
| 		return;
 | |
| 	}
 | |
| 
 | |
| 	res = stasis_app_recording_operation(recording, operation);
 | |
| 
 | |
| 	switch (res) {
 | |
| 	case STASIS_APP_RECORDING_OPER_OK:
 | |
| 		ast_ari_response_no_content(response);
 | |
| 		return;
 | |
| 	case STASIS_APP_RECORDING_OPER_FAILED:
 | |
| 		ast_ari_response_error(response, 500,
 | |
| 			"Internal Server Error", "Recording operation failed");
 | |
| 		return;
 | |
| 	case STASIS_APP_RECORDING_OPER_NOT_RECORDING:
 | |
| 		ast_ari_response_error(response, 409,
 | |
| 			"Conflict", "Recording not in session");
 | |
| 	}
 | |
| }
 | |
| 
 | |
| void ast_ari_recordings_cancel(struct ast_variable *headers,
 | |
| 	struct ast_ari_recordings_cancel_args *args,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	control_recording(args->recording_name, STASIS_APP_RECORDING_CANCEL,
 | |
| 		response);
 | |
| }
 | |
| 
 | |
| void ast_ari_recordings_stop(struct ast_variable *headers,
 | |
| 	struct ast_ari_recordings_stop_args *args,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	control_recording(args->recording_name, STASIS_APP_RECORDING_STOP,
 | |
| 		response);
 | |
| }
 | |
| 
 | |
| void ast_ari_recordings_pause(struct ast_variable *headers,
 | |
| 	struct ast_ari_recordings_pause_args *args,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	control_recording(args->recording_name, STASIS_APP_RECORDING_PAUSE,
 | |
| 		response);
 | |
| }
 | |
| 
 | |
| void ast_ari_recordings_unpause(struct ast_variable *headers,
 | |
| 	struct ast_ari_recordings_unpause_args *args,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	control_recording(args->recording_name, STASIS_APP_RECORDING_UNPAUSE,
 | |
| 		response);
 | |
| }
 | |
| 
 | |
| void ast_ari_recordings_mute(struct ast_variable *headers,
 | |
| 	struct ast_ari_recordings_mute_args *args,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	control_recording(args->recording_name, STASIS_APP_RECORDING_MUTE,
 | |
| 		response);
 | |
| }
 | |
| 
 | |
| void ast_ari_recordings_unmute(struct ast_variable *headers,
 | |
| 	struct ast_ari_recordings_unmute_args *args,
 | |
| 	struct ast_ari_response *response)
 | |
| {
 | |
| 	control_recording(args->recording_name, STASIS_APP_RECORDING_UNMUTE,
 | |
| 		response);
 | |
| }
 |