a8079f13911271aef205d23f87ddc3d3146da3c6
[asterisk/asterisk.git] / res / res_ari_device_states.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012 - 2013, Digium, Inc.
5  *
6  * Kevin Harwell <kharwell@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 Device state resources
30  *
31  * \author Kevin Harwell <kharwell@digium.com>
32  */
33
34 /*** MODULEINFO
35         <depend type="module">res_ari</depend>
36         <depend type="module">res_stasis</depend>
37         <support_level>core</support_level>
38  ***/
39
40 #include "asterisk.h"
41
42 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
43
44 #include "asterisk/app.h"
45 #include "asterisk/module.h"
46 #include "asterisk/stasis_app.h"
47 #include "ari/resource_device_states.h"
48 #if defined(AST_DEVMODE)
49 #include "ari/ari_model_validators.h"
50 #endif
51
52 #define MAX_VALS 128
53
54 /*!
55  * \brief Parameter parsing callback for /deviceStates.
56  * \param get_params GET parameters in the HTTP request.
57  * \param path_vars Path variables extracted from the request.
58  * \param headers HTTP headers.
59  * \param[out] response Response to the HTTP request.
60  */
61 static void ast_ari_device_states_list_cb(
62         struct ast_tcptls_session_instance *ser,
63         struct ast_variable *get_params, struct ast_variable *path_vars,
64         struct ast_variable *headers, struct ast_ari_response *response)
65 {
66         struct ast_ari_device_states_list_args args = {};
67         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
68 #if defined(AST_DEVMODE)
69         int is_valid;
70         int code;
71 #endif /* AST_DEVMODE */
72
73         ast_ari_device_states_list(headers, &args, response);
74 #if defined(AST_DEVMODE)
75         code = response->response_code;
76
77         switch (code) {
78         case 0: /* Implementation is still a stub, or the code wasn't set */
79                 is_valid = response->message == NULL;
80                 break;
81         case 500: /* Internal Server Error */
82         case 501: /* Not Implemented */
83                 is_valid = 1;
84                 break;
85         default:
86                 if (200 <= code && code <= 299) {
87                         is_valid = ast_ari_validate_list(response->message,
88                                 ast_ari_validate_device_state_fn());
89                 } else {
90                         ast_log(LOG_ERROR, "Invalid error response %d for /deviceStates\n", code);
91                         is_valid = 0;
92                 }
93         }
94
95         if (!is_valid) {
96                 ast_log(LOG_ERROR, "Response validation failed for /deviceStates\n");
97                 ast_ari_response_error(response, 500,
98                         "Internal Server Error", "Response validation failed");
99         }
100 #endif /* AST_DEVMODE */
101
102 fin: __attribute__((unused))
103         return;
104 }
105 /*!
106  * \brief Parameter parsing callback for /deviceStates/{deviceName}.
107  * \param get_params GET parameters in the HTTP request.
108  * \param path_vars Path variables extracted from the request.
109  * \param headers HTTP headers.
110  * \param[out] response Response to the HTTP request.
111  */
112 static void ast_ari_device_states_get_cb(
113         struct ast_tcptls_session_instance *ser,
114         struct ast_variable *get_params, struct ast_variable *path_vars,
115         struct ast_variable *headers, struct ast_ari_response *response)
116 {
117         struct ast_ari_device_states_get_args args = {};
118         struct ast_variable *i;
119         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
120 #if defined(AST_DEVMODE)
121         int is_valid;
122         int code;
123 #endif /* AST_DEVMODE */
124
125         for (i = path_vars; i; i = i->next) {
126                 if (strcmp(i->name, "deviceName") == 0) {
127                         args.device_name = (i->value);
128                 } else
129                 {}
130         }
131         ast_ari_device_states_get(headers, &args, response);
132 #if defined(AST_DEVMODE)
133         code = response->response_code;
134
135         switch (code) {
136         case 0: /* Implementation is still a stub, or the code wasn't set */
137                 is_valid = response->message == NULL;
138                 break;
139         case 500: /* Internal Server Error */
140         case 501: /* Not Implemented */
141                 is_valid = 1;
142                 break;
143         default:
144                 if (200 <= code && code <= 299) {
145                         is_valid = ast_ari_validate_device_state(
146                                 response->message);
147                 } else {
148                         ast_log(LOG_ERROR, "Invalid error response %d for /deviceStates/{deviceName}\n", code);
149                         is_valid = 0;
150                 }
151         }
152
153         if (!is_valid) {
154                 ast_log(LOG_ERROR, "Response validation failed for /deviceStates/{deviceName}\n");
155                 ast_ari_response_error(response, 500,
156                         "Internal Server Error", "Response validation failed");
157         }
158 #endif /* AST_DEVMODE */
159
160 fin: __attribute__((unused))
161         return;
162 }
163 /*!
164  * \brief Parameter parsing callback for /deviceStates/{deviceName}.
165  * \param get_params GET parameters in the HTTP request.
166  * \param path_vars Path variables extracted from the request.
167  * \param headers HTTP headers.
168  * \param[out] response Response to the HTTP request.
169  */
170 static void ast_ari_device_states_update_cb(
171         struct ast_tcptls_session_instance *ser,
172         struct ast_variable *get_params, struct ast_variable *path_vars,
173         struct ast_variable *headers, struct ast_ari_response *response)
174 {
175         struct ast_ari_device_states_update_args args = {};
176         struct ast_variable *i;
177         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
178         struct ast_json *field;
179 #if defined(AST_DEVMODE)
180         int is_valid;
181         int code;
182 #endif /* AST_DEVMODE */
183
184         for (i = get_params; i; i = i->next) {
185                 if (strcmp(i->name, "deviceState") == 0) {
186                         args.device_state = (i->value);
187                 } else
188                 {}
189         }
190         for (i = path_vars; i; i = i->next) {
191                 if (strcmp(i->name, "deviceName") == 0) {
192                         args.device_name = (i->value);
193                 } else
194                 {}
195         }
196         /* Look for a JSON request entity */
197         body = ast_http_get_json(ser, headers);
198         if (!body) {
199                 switch (errno) {
200                 case EFBIG:
201                         ast_ari_response_error(response, 413, "Request Entity Too Large", "Request body too large");
202                         goto fin;
203                 case ENOMEM:
204                         ast_ari_response_error(response, 500, "Internal Server Error", "Error processing request");
205                         goto fin;
206                 case EIO:
207                         ast_ari_response_error(response, 400, "Bad Request", "Error parsing request body");
208                         goto fin;
209                 }
210         }
211         /* Parse query parameters out of it */
212         field = ast_json_object_get(body, "deviceState");
213         if (field) {
214                 args.device_state = ast_json_string_get(field);
215         }
216         ast_ari_device_states_update(headers, &args, response);
217 #if defined(AST_DEVMODE)
218         code = response->response_code;
219
220         switch (code) {
221         case 0: /* Implementation is still a stub, or the code wasn't set */
222                 is_valid = response->message == NULL;
223                 break;
224         case 500: /* Internal Server Error */
225         case 501: /* Not Implemented */
226         case 404: /* Device name is missing */
227         case 409: /* Uncontrolled device specified */
228                 is_valid = 1;
229                 break;
230         default:
231                 if (200 <= code && code <= 299) {
232                         is_valid = ast_ari_validate_void(
233                                 response->message);
234                 } else {
235                         ast_log(LOG_ERROR, "Invalid error response %d for /deviceStates/{deviceName}\n", code);
236                         is_valid = 0;
237                 }
238         }
239
240         if (!is_valid) {
241                 ast_log(LOG_ERROR, "Response validation failed for /deviceStates/{deviceName}\n");
242                 ast_ari_response_error(response, 500,
243                         "Internal Server Error", "Response validation failed");
244         }
245 #endif /* AST_DEVMODE */
246
247 fin: __attribute__((unused))
248         return;
249 }
250 /*!
251  * \brief Parameter parsing callback for /deviceStates/{deviceName}.
252  * \param get_params GET parameters in the HTTP request.
253  * \param path_vars Path variables extracted from the request.
254  * \param headers HTTP headers.
255  * \param[out] response Response to the HTTP request.
256  */
257 static void ast_ari_device_states_delete_cb(
258         struct ast_tcptls_session_instance *ser,
259         struct ast_variable *get_params, struct ast_variable *path_vars,
260         struct ast_variable *headers, struct ast_ari_response *response)
261 {
262         struct ast_ari_device_states_delete_args args = {};
263         struct ast_variable *i;
264         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
265 #if defined(AST_DEVMODE)
266         int is_valid;
267         int code;
268 #endif /* AST_DEVMODE */
269
270         for (i = path_vars; i; i = i->next) {
271                 if (strcmp(i->name, "deviceName") == 0) {
272                         args.device_name = (i->value);
273                 } else
274                 {}
275         }
276         ast_ari_device_states_delete(headers, &args, response);
277 #if defined(AST_DEVMODE)
278         code = response->response_code;
279
280         switch (code) {
281         case 0: /* Implementation is still a stub, or the code wasn't set */
282                 is_valid = response->message == NULL;
283                 break;
284         case 500: /* Internal Server Error */
285         case 501: /* Not Implemented */
286         case 404: /* Device name is missing */
287         case 409: /* Uncontrolled device specified */
288                 is_valid = 1;
289                 break;
290         default:
291                 if (200 <= code && code <= 299) {
292                         is_valid = ast_ari_validate_void(
293                                 response->message);
294                 } else {
295                         ast_log(LOG_ERROR, "Invalid error response %d for /deviceStates/{deviceName}\n", code);
296                         is_valid = 0;
297                 }
298         }
299
300         if (!is_valid) {
301                 ast_log(LOG_ERROR, "Response validation failed for /deviceStates/{deviceName}\n");
302                 ast_ari_response_error(response, 500,
303                         "Internal Server Error", "Response validation failed");
304         }
305 #endif /* AST_DEVMODE */
306
307 fin: __attribute__((unused))
308         return;
309 }
310
311 /*! \brief REST handler for /api-docs/deviceStates.{format} */
312 static struct stasis_rest_handlers deviceStates_deviceName = {
313         .path_segment = "deviceName",
314         .is_wildcard = 1,
315         .callbacks = {
316                 [AST_HTTP_GET] = ast_ari_device_states_get_cb,
317                 [AST_HTTP_PUT] = ast_ari_device_states_update_cb,
318                 [AST_HTTP_DELETE] = ast_ari_device_states_delete_cb,
319         },
320         .num_children = 0,
321         .children = {  }
322 };
323 /*! \brief REST handler for /api-docs/deviceStates.{format} */
324 static struct stasis_rest_handlers deviceStates = {
325         .path_segment = "deviceStates",
326         .callbacks = {
327                 [AST_HTTP_GET] = ast_ari_device_states_list_cb,
328         },
329         .num_children = 1,
330         .children = { &deviceStates_deviceName, }
331 };
332
333 static int load_module(void)
334 {
335         int res = 0;
336         stasis_app_ref();
337         res |= ast_ari_add_handler(&deviceStates);
338         return res;
339 }
340
341 static int unload_module(void)
342 {
343         ast_ari_remove_handler(&deviceStates);
344         stasis_app_unref();
345         return 0;
346 }
347
348 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - Device state resources",
349         .load = load_module,
350         .unload = unload_module,
351         .nonoptreq = "res_ari,res_stasis",
352         );