Asterisk - The Open Source Telephony Project GIT-master-2de1a68
res_ari_sounds.c
Go to the documentation of this file.
1/*
2 * Asterisk -- An open source telephony toolkit.
3 *
4 * Copyright (C) 2012 - 2013, Digium, Inc.
5 *
6 * David M. Lee, II <dlee@digium.com>
7 *
8 * See http://www.asterisk.org for more information about
9 * the Asterisk project. Please do not directly contact
10 * any of the maintainers of this project for assistance;
11 * the project provides a web site, mailing lists and IRC
12 * channels for your use.
13 *
14 * This program is free software, distributed under the terms of
15 * the GNU General Public License Version 2. See the LICENSE file
16 * at the top of the source tree.
17 */
18
19/*
20 * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
21 * !!!!! DO NOT EDIT !!!!!
22 * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
23 * This file is generated by a mustache template. Please see the original
24 * template in rest-api-templates/res_ari_resource.c.mustache
25 */
26
27/*! \file
28 *
29 * \brief Sound resources
30 *
31 * \author David M. Lee, II <dlee@digium.com>
32 */
33
34/*** MODULEINFO
35 <depend type="module">res_ari</depend>
36 <depend type="module">res_ari_model</depend>
37 <depend type="module">res_stasis</depend>
38 <support_level>core</support_level>
39 ***/
40
41#include "asterisk.h"
42
43#include "asterisk/app.h"
44#include "asterisk/module.h"
45#include "asterisk/stasis_app.h"
46#include "ari/resource_sounds.h"
47#if defined(AST_DEVMODE)
49#endif
50
51#define MAX_VALS 128
52
54 struct ast_json *body,
56{
57 struct ast_json *field;
58 /* Parse query parameters out of it */
59 field = ast_json_object_get(body, "lang");
60 if (field) {
61 args->lang = ast_json_string_get(field);
62 }
63 field = ast_json_object_get(body, "format");
64 if (field) {
65 args->format = ast_json_string_get(field);
66 }
67 return 0;
68}
69
70/*!
71 * \brief Parameter parsing callback for /sounds.
72 * \param ser TCP/TLS session object
73 * \param get_params GET parameters in the HTTP request.
74 * \param path_vars Path variables extracted from the request.
75 * \param headers HTTP headers.
76 * \param body
77 * \param[out] response Response to the HTTP request.
78 */
81 struct ast_variable *get_params, struct ast_variable *path_vars,
82 struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
83{
85 struct ast_variable *i;
86#if defined(AST_DEVMODE)
87 int is_valid;
88 int code;
89#endif /* AST_DEVMODE */
90
91 for (i = get_params; i; i = i->next) {
92 if (strcmp(i->name, "lang") == 0) {
93 args.lang = (i->value);
94 } else
95 if (strcmp(i->name, "format") == 0) {
96 args.format = (i->value);
97 } else
98 {}
99 }
102 goto fin;
103 }
104 ast_ari_sounds_list(headers, &args, response);
105#if defined(AST_DEVMODE)
106 code = response->response_code;
107
108 switch (code) {
109 case 0: /* Implementation is still a stub, or the code wasn't set */
110 is_valid = response->message == NULL;
111 break;
112 case 500: /* Internal Server Error */
113 case 501: /* Not Implemented */
114 is_valid = 1;
115 break;
116 default:
117 if (200 <= code && code <= 299) {
118 is_valid = ast_ari_validate_list(response->message,
120 } else {
121 ast_log(LOG_ERROR, "Invalid error response %d for /sounds\n", code);
122 is_valid = 0;
123 }
124 }
125
126 if (!is_valid) {
127 ast_log(LOG_ERROR, "Response validation failed for /sounds\n");
128 ast_ari_response_error(response, 500,
129 "Internal Server Error", "Response validation failed");
130 }
131#endif /* AST_DEVMODE */
132
133fin: __attribute__((unused))
134 return;
135}
136/*!
137 * \brief Parameter parsing callback for /sounds/{soundId}.
138 * \param ser TCP/TLS session object
139 * \param get_params GET parameters in the HTTP request.
140 * \param path_vars Path variables extracted from the request.
141 * \param headers HTTP headers.
142 * \param body
143 * \param[out] response Response to the HTTP request.
144 */
146 struct ast_tcptls_session_instance *ser,
147 struct ast_variable *get_params, struct ast_variable *path_vars,
148 struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
149{
150 struct ast_ari_sounds_get_args args = {};
151 struct ast_variable *i;
152#if defined(AST_DEVMODE)
153 int is_valid;
154 int code;
155#endif /* AST_DEVMODE */
156
157 for (i = path_vars; i; i = i->next) {
158 if (strcmp(i->name, "soundId") == 0) {
159 args.sound_id = (i->value);
160 } else
161 {}
162 }
163 ast_ari_sounds_get(headers, &args, response);
164#if defined(AST_DEVMODE)
165 code = response->response_code;
166
167 switch (code) {
168 case 0: /* Implementation is still a stub, or the code wasn't set */
169 is_valid = response->message == NULL;
170 break;
171 case 500: /* Internal Server Error */
172 case 501: /* Not Implemented */
173 is_valid = 1;
174 break;
175 default:
176 if (200 <= code && code <= 299) {
177 is_valid = ast_ari_validate_sound(
178 response->message);
179 } else {
180 ast_log(LOG_ERROR, "Invalid error response %d for /sounds/{soundId}\n", code);
181 is_valid = 0;
182 }
183 }
184
185 if (!is_valid) {
186 ast_log(LOG_ERROR, "Response validation failed for /sounds/{soundId}\n");
187 ast_ari_response_error(response, 500,
188 "Internal Server Error", "Response validation failed");
189 }
190#endif /* AST_DEVMODE */
191
192fin: __attribute__((unused))
193 return;
194}
195
196/*! \brief REST handler for /api-docs/sounds.json */
198 .path_segment = "soundId",
199 .is_wildcard = 1,
200 .callbacks = {
202 },
203 .num_children = 0,
204 .children = { }
205};
206/*! \brief REST handler for /api-docs/sounds.json */
208 .path_segment = "sounds",
209 .callbacks = {
211 },
212 .num_children = 1,
213 .children = { &sounds_soundId, }
214};
215
216static int unload_module(void)
217{
219 return 0;
220}
221
222static int load_module(void)
223{
224 int res = 0;
225
226
228 if (res) {
231 }
232
234}
235
236AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - Sound resources",
237 .support_level = AST_MODULE_SUPPORT_CORE,
238 .load = load_module,
239 .unload = unload_module,
240 .requires = "res_ari,res_ari_model,res_stasis",
int ast_ari_remove_handler(struct stasis_rest_handlers *handler)
Definition: res_ari.c:202
void ast_ari_response_error(struct ast_ari_response *response, int response_code, const char *response_text, const char *message_fmt,...)
Fill in an error ast_ari_response.
Definition: res_ari.c:259
void ast_ari_response_alloc_failed(struct ast_ari_response *response)
Fill in response with a 500 message for allocation failures.
Definition: res_ari.c:298
int ast_ari_add_handler(struct stasis_rest_handlers *handler)
Definition: res_ari.c:179
ari_validator ast_ari_validate_sound_fn(void)
Function pointer to ast_ari_validate_sound().
int ast_ari_validate_sound(struct ast_json *json)
Validator for Sound.
Generated file - Build validators for ARI model objects.
int ast_ari_validate_list(struct ast_json *json, int(*fn)(struct ast_json *))
Validator for a Swagger List[]/JSON array.
Asterisk main include file. File version handling, generic pbx functions.
#define ast_log
Definition: astobj2.c:42
@ AST_HTTP_GET
Definition: http.h:60
Application convenience functions, designed to give consistent look and feel to Asterisk apps.
#define LOG_ERROR
const char * ast_json_string_get(const struct ast_json *string)
Get the value of a JSON string.
Definition: json.c:283
struct ast_json * ast_json_object_get(struct ast_json *object, const char *key)
Get a field from a JSON object.
Definition: json.c:407
Asterisk module definitions.
@ AST_MODFLAG_DEFAULT
Definition: module.h:315
#define AST_MODULE_INFO(keystr, flags_to_set, desc, fields...)
Definition: module.h:543
@ AST_MODULE_SUPPORT_CORE
Definition: module.h:121
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition: module.h:46
@ AST_MODULE_LOAD_SUCCESS
Definition: module.h:70
@ AST_MODULE_LOAD_DECLINE
Module has failed to load, may be in an inconsistent state.
Definition: module.h:78
static struct stasis_rest_handlers sounds_soundId
REST handler for /api-docs/sounds.json.
static struct stasis_rest_handlers sounds
REST handler for /api-docs/sounds.json.
int ast_ari_sounds_list_parse_body(struct ast_json *body, struct ast_ari_sounds_list_args *args)
Body parsing function for /sounds.
static void ast_ari_sounds_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)
Parameter parsing callback for /sounds/{soundId}.
static void ast_ari_sounds_list_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)
Parameter parsing callback for /sounds.
static int load_module(void)
static int unload_module(void)
#define NULL
Definition: resample.c:96
void ast_ari_sounds_get(struct ast_variable *headers, struct ast_ari_sounds_get_args *args, struct ast_ari_response *response)
Get a sound's details.
void ast_ari_sounds_list(struct ast_variable *headers, struct ast_ari_sounds_list_args *args, struct ast_ari_response *response)
List all sounds.
Generated file - declares stubs to be implemented in res/ari/resource_sounds.c.
Stasis Application API. See Stasis Application API for detailed documentation.
struct ast_json * message
Definition: ari.h:94
int response_code
Definition: ari.h:99
Abstract JSON element (object, array, string, int, ...).
describes a server instance
Definition: tcptls.h:150
Structure for variables, used for configurations and for channel variables.
struct ast_variable * next
Handler for a single RESTful path segment.
Definition: ari.h:69
const char * path_segment
Definition: ari.h:71
const char * args