ari:Add application/json parameter support
[asterisk/asterisk.git] / res / res_ari_asterisk.c
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 Asterisk 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_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_asterisk.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 /asterisk/info.
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_asterisk_get_info_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_asterisk_get_info_args args = {};
67         struct ast_variable *i;
68         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
69         struct ast_json *field;
70 #if defined(AST_DEVMODE)
71         int is_valid;
72         int code;
73 #endif /* AST_DEVMODE */
74
75         for (i = get_params; i; i = i->next) {
76                 if (strcmp(i->name, "only") == 0) {
77                         /* Parse comma separated list */
78                         char *vals[MAX_VALS];
79                         size_t j;
80
81                         args.only_parse = ast_strdup(i->value);
82                         if (!args.only_parse) {
83                                 ast_ari_response_alloc_failed(response);
84                                 goto fin;
85                         }
86
87                         if (strlen(args.only_parse) == 0) {
88                                 /* ast_app_separate_args can't handle "" */
89                                 args.only_count = 1;
90                                 vals[0] = args.only_parse;
91                         } else {
92                                 args.only_count = ast_app_separate_args(
93                                         args.only_parse, ',', vals,
94                                         ARRAY_LEN(vals));
95                         }
96
97                         if (args.only_count == 0) {
98                                 ast_ari_response_alloc_failed(response);
99                                 goto fin;
100                         }
101
102                         if (args.only_count >= MAX_VALS) {
103                                 ast_ari_response_error(response, 400,
104                                         "Bad Request",
105                                         "Too many values for only");
106                                 goto fin;
107                         }
108
109                         args.only = ast_malloc(sizeof(*args.only) * args.only_count);
110                         if (!args.only) {
111                                 ast_ari_response_alloc_failed(response);
112                                 goto fin;
113                         }
114
115                         for (j = 0; j < args.only_count; ++j) {
116                                 args.only[j] = (vals[j]);
117                         }
118                 } else
119                 {}
120         }
121         /* Look for a JSON request entity */
122         body = ast_http_get_json(ser, headers);
123         if (!body) {
124                 switch (errno) {
125                 case EFBIG:
126                         ast_ari_response_error(response, 413, "Request Entity Too Large", "Request body too large");
127                         goto fin;
128                 case ENOMEM:
129                         ast_ari_response_error(response, 500, "Internal Server Error", "Error processing request");
130                         goto fin;
131                 case EIO:
132                         ast_ari_response_error(response, 400, "Bad Request", "Error parsing request body");
133                         goto fin;
134                 }
135         }
136         /* Parse query parameters out of it */
137         field = ast_json_object_get(body, "only");
138         if (field) {
139                 /* If they were silly enough to both pass in a query param and a
140                  * JSON body, free up the query value.
141                  */
142                 ast_free(args.only);
143                 if (ast_json_typeof(field) == AST_JSON_ARRAY) {
144                         /* Multiple param passed as array */
145                         size_t i;
146                         args.only_count = ast_json_array_size(field);
147                         args.only = ast_malloc(sizeof(*args.only) * args.only_count);
148
149                         if (!args.only) {
150                                 ast_ari_response_alloc_failed(response);
151                                 goto fin;
152                         }
153
154                         for (i = 0; i < args.only_count; ++i) {
155                                 args.only[i] = ast_json_string_get(ast_json_array_get(field, i));
156                         }
157                 } else {
158                         /* Multiple param passed as single value */
159                         args.only_count = 1;
160                         args.only = ast_malloc(sizeof(*args.only) * args.only_count);
161                         if (!args.only) {
162                                 ast_ari_response_alloc_failed(response);
163                                 goto fin;
164                         }
165                         args.only[0] = ast_json_string_get(field);
166                 }
167         }
168         ast_ari_asterisk_get_info(headers, &args, response);
169 #if defined(AST_DEVMODE)
170         code = response->response_code;
171
172         switch (code) {
173         case 0: /* Implementation is still a stub, or the code wasn't set */
174                 is_valid = response->message == NULL;
175                 break;
176         case 500: /* Internal Server Error */
177         case 501: /* Not Implemented */
178                 is_valid = 1;
179                 break;
180         default:
181                 if (200 <= code && code <= 299) {
182                         is_valid = ast_ari_validate_asterisk_info(
183                                 response->message);
184                 } else {
185                         ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/info\n", code);
186                         is_valid = 0;
187                 }
188         }
189
190         if (!is_valid) {
191                 ast_log(LOG_ERROR, "Response validation failed for /asterisk/info\n");
192                 ast_ari_response_error(response, 500,
193                         "Internal Server Error", "Response validation failed");
194         }
195 #endif /* AST_DEVMODE */
196
197 fin: __attribute__((unused))
198         ast_free(args.only_parse);
199         ast_free(args.only);
200         return;
201 }
202 /*!
203  * \brief Parameter parsing callback for /asterisk/variable.
204  * \param get_params GET parameters in the HTTP request.
205  * \param path_vars Path variables extracted from the request.
206  * \param headers HTTP headers.
207  * \param[out] response Response to the HTTP request.
208  */
209 static void ast_ari_asterisk_get_global_var_cb(
210         struct ast_tcptls_session_instance *ser,
211         struct ast_variable *get_params, struct ast_variable *path_vars,
212         struct ast_variable *headers, struct ast_ari_response *response)
213 {
214         struct ast_ari_asterisk_get_global_var_args args = {};
215         struct ast_variable *i;
216         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
217         struct ast_json *field;
218 #if defined(AST_DEVMODE)
219         int is_valid;
220         int code;
221 #endif /* AST_DEVMODE */
222
223         for (i = get_params; i; i = i->next) {
224                 if (strcmp(i->name, "variable") == 0) {
225                         args.variable = (i->value);
226                 } else
227                 {}
228         }
229         /* Look for a JSON request entity */
230         body = ast_http_get_json(ser, headers);
231         if (!body) {
232                 switch (errno) {
233                 case EFBIG:
234                         ast_ari_response_error(response, 413, "Request Entity Too Large", "Request body too large");
235                         goto fin;
236                 case ENOMEM:
237                         ast_ari_response_error(response, 500, "Internal Server Error", "Error processing request");
238                         goto fin;
239                 case EIO:
240                         ast_ari_response_error(response, 400, "Bad Request", "Error parsing request body");
241                         goto fin;
242                 }
243         }
244         /* Parse query parameters out of it */
245         field = ast_json_object_get(body, "variable");
246         if (field) {
247                 args.variable = ast_json_string_get(field);
248         }
249         ast_ari_asterisk_get_global_var(headers, &args, response);
250 #if defined(AST_DEVMODE)
251         code = response->response_code;
252
253         switch (code) {
254         case 0: /* Implementation is still a stub, or the code wasn't set */
255                 is_valid = response->message == NULL;
256                 break;
257         case 500: /* Internal Server Error */
258         case 501: /* Not Implemented */
259         case 400: /* Missing variable parameter. */
260                 is_valid = 1;
261                 break;
262         default:
263                 if (200 <= code && code <= 299) {
264                         is_valid = ast_ari_validate_variable(
265                                 response->message);
266                 } else {
267                         ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/variable\n", code);
268                         is_valid = 0;
269                 }
270         }
271
272         if (!is_valid) {
273                 ast_log(LOG_ERROR, "Response validation failed for /asterisk/variable\n");
274                 ast_ari_response_error(response, 500,
275                         "Internal Server Error", "Response validation failed");
276         }
277 #endif /* AST_DEVMODE */
278
279 fin: __attribute__((unused))
280         return;
281 }
282 /*!
283  * \brief Parameter parsing callback for /asterisk/variable.
284  * \param get_params GET parameters in the HTTP request.
285  * \param path_vars Path variables extracted from the request.
286  * \param headers HTTP headers.
287  * \param[out] response Response to the HTTP request.
288  */
289 static void ast_ari_asterisk_set_global_var_cb(
290         struct ast_tcptls_session_instance *ser,
291         struct ast_variable *get_params, struct ast_variable *path_vars,
292         struct ast_variable *headers, struct ast_ari_response *response)
293 {
294         struct ast_ari_asterisk_set_global_var_args args = {};
295         struct ast_variable *i;
296         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
297         struct ast_json *field;
298 #if defined(AST_DEVMODE)
299         int is_valid;
300         int code;
301 #endif /* AST_DEVMODE */
302
303         for (i = get_params; i; i = i->next) {
304                 if (strcmp(i->name, "variable") == 0) {
305                         args.variable = (i->value);
306                 } else
307                 if (strcmp(i->name, "value") == 0) {
308                         args.value = (i->value);
309                 } else
310                 {}
311         }
312         /* Look for a JSON request entity */
313         body = ast_http_get_json(ser, headers);
314         if (!body) {
315                 switch (errno) {
316                 case EFBIG:
317                         ast_ari_response_error(response, 413, "Request Entity Too Large", "Request body too large");
318                         goto fin;
319                 case ENOMEM:
320                         ast_ari_response_error(response, 500, "Internal Server Error", "Error processing request");
321                         goto fin;
322                 case EIO:
323                         ast_ari_response_error(response, 400, "Bad Request", "Error parsing request body");
324                         goto fin;
325                 }
326         }
327         /* Parse query parameters out of it */
328         field = ast_json_object_get(body, "variable");
329         if (field) {
330                 args.variable = ast_json_string_get(field);
331         }
332         field = ast_json_object_get(body, "value");
333         if (field) {
334                 args.value = ast_json_string_get(field);
335         }
336         ast_ari_asterisk_set_global_var(headers, &args, response);
337 #if defined(AST_DEVMODE)
338         code = response->response_code;
339
340         switch (code) {
341         case 0: /* Implementation is still a stub, or the code wasn't set */
342                 is_valid = response->message == NULL;
343                 break;
344         case 500: /* Internal Server Error */
345         case 501: /* Not Implemented */
346         case 400: /* Missing variable parameter. */
347                 is_valid = 1;
348                 break;
349         default:
350                 if (200 <= code && code <= 299) {
351                         is_valid = ast_ari_validate_void(
352                                 response->message);
353                 } else {
354                         ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/variable\n", code);
355                         is_valid = 0;
356                 }
357         }
358
359         if (!is_valid) {
360                 ast_log(LOG_ERROR, "Response validation failed for /asterisk/variable\n");
361                 ast_ari_response_error(response, 500,
362                         "Internal Server Error", "Response validation failed");
363         }
364 #endif /* AST_DEVMODE */
365
366 fin: __attribute__((unused))
367         return;
368 }
369
370 /*! \brief REST handler for /api-docs/asterisk.{format} */
371 static struct stasis_rest_handlers asterisk_info = {
372         .path_segment = "info",
373         .callbacks = {
374                 [AST_HTTP_GET] = ast_ari_asterisk_get_info_cb,
375         },
376         .num_children = 0,
377         .children = {  }
378 };
379 /*! \brief REST handler for /api-docs/asterisk.{format} */
380 static struct stasis_rest_handlers asterisk_variable = {
381         .path_segment = "variable",
382         .callbacks = {
383                 [AST_HTTP_GET] = ast_ari_asterisk_get_global_var_cb,
384                 [AST_HTTP_POST] = ast_ari_asterisk_set_global_var_cb,
385         },
386         .num_children = 0,
387         .children = {  }
388 };
389 /*! \brief REST handler for /api-docs/asterisk.{format} */
390 static struct stasis_rest_handlers asterisk = {
391         .path_segment = "asterisk",
392         .callbacks = {
393         },
394         .num_children = 2,
395         .children = { &asterisk_info,&asterisk_variable, }
396 };
397
398 static int load_module(void)
399 {
400         int res = 0;
401         stasis_app_ref();
402         res |= ast_ari_add_handler(&asterisk);
403         return res;
404 }
405
406 static int unload_module(void)
407 {
408         ast_ari_remove_handler(&asterisk);
409         stasis_app_unref();
410         return 0;
411 }
412
413 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - Asterisk resources",
414         .load = load_module,
415         .unload = unload_module,
416         .nonoptreq = "res_ari,res_stasis",
417         );