c83c2f6a306817a0e193e2851a850be68a22e6cb
[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_variable *get_params, struct ast_variable *path_vars,
63         struct ast_variable *headers, struct ast_ari_response *response)
64 {
65         struct ast_ari_asterisk_get_info_args args = {};
66         struct ast_variable *i;
67 #if defined(AST_DEVMODE)
68         int is_valid;
69         int code;
70 #endif /* AST_DEVMODE */
71
72         for (i = get_params; i; i = i->next) {
73                 if (strcmp(i->name, "only") == 0) {
74                         /* Parse comma separated list */
75                         char *vals[MAX_VALS];
76                         size_t j;
77
78                         args.only_parse = ast_strdup(i->value);
79                         if (!args.only_parse) {
80                                 ast_ari_response_alloc_failed(response);
81                                 goto fin;
82                         }
83
84                         if (strlen(args.only_parse) == 0) {
85                                 /* ast_app_separate_args can't handle "" */
86                                 args.only_count = 1;
87                                 vals[0] = args.only_parse;
88                         } else {
89                                 args.only_count = ast_app_separate_args(
90                                         args.only_parse, ',', vals,
91                                         ARRAY_LEN(vals));
92                         }
93
94                         if (args.only_count == 0) {
95                                 ast_ari_response_alloc_failed(response);
96                                 goto fin;
97                         }
98
99                         if (args.only_count >= MAX_VALS) {
100                                 ast_ari_response_error(response, 400,
101                                         "Bad Request",
102                                         "Too many values for only");
103                                 goto fin;
104                         }
105
106                         args.only = ast_malloc(sizeof(*args.only) * args.only_count);
107                         if (!args.only) {
108                                 ast_ari_response_alloc_failed(response);
109                                 goto fin;
110                         }
111
112                         for (j = 0; j < args.only_count; ++j) {
113                                 args.only[j] = (vals[j]);
114                         }
115                 } else
116                 {}
117         }
118         ast_ari_asterisk_get_info(headers, &args, response);
119 #if defined(AST_DEVMODE)
120         code = response->response_code;
121
122         switch (code) {
123         case 0: /* Implementation is still a stub, or the code wasn't set */
124                 is_valid = response->message == NULL;
125                 break;
126         case 500: /* Internal Server Error */
127         case 501: /* Not Implemented */
128                 is_valid = 1;
129                 break;
130         default:
131                 if (200 <= code && code <= 299) {
132                         is_valid = ast_ari_validate_asterisk_info(
133                                 response->message);
134                 } else {
135                         ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/info\n", code);
136                         is_valid = 0;
137                 }
138         }
139
140         if (!is_valid) {
141                 ast_log(LOG_ERROR, "Response validation failed for /asterisk/info\n");
142                 ast_ari_response_error(response, 500,
143                         "Internal Server Error", "Response validation failed");
144         }
145 #endif /* AST_DEVMODE */
146
147 fin: __attribute__((unused))
148         ast_free(args.only_parse);
149         ast_free(args.only);
150         return;
151 }
152 /*!
153  * \brief Parameter parsing callback for /asterisk/variable.
154  * \param get_params GET parameters in the HTTP request.
155  * \param path_vars Path variables extracted from the request.
156  * \param headers HTTP headers.
157  * \param[out] response Response to the HTTP request.
158  */
159 static void ast_ari_asterisk_get_global_var_cb(
160         struct ast_variable *get_params, struct ast_variable *path_vars,
161         struct ast_variable *headers, struct ast_ari_response *response)
162 {
163         struct ast_ari_asterisk_get_global_var_args args = {};
164         struct ast_variable *i;
165 #if defined(AST_DEVMODE)
166         int is_valid;
167         int code;
168 #endif /* AST_DEVMODE */
169
170         for (i = get_params; i; i = i->next) {
171                 if (strcmp(i->name, "variable") == 0) {
172                         args.variable = (i->value);
173                 } else
174                 {}
175         }
176         ast_ari_asterisk_get_global_var(headers, &args, response);
177 #if defined(AST_DEVMODE)
178         code = response->response_code;
179
180         switch (code) {
181         case 0: /* Implementation is still a stub, or the code wasn't set */
182                 is_valid = response->message == NULL;
183                 break;
184         case 500: /* Internal Server Error */
185         case 501: /* Not Implemented */
186         case 400: /* Missing variable parameter. */
187                 is_valid = 1;
188                 break;
189         default:
190                 if (200 <= code && code <= 299) {
191                         is_valid = ast_ari_validate_variable(
192                                 response->message);
193                 } else {
194                         ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/variable\n", code);
195                         is_valid = 0;
196                 }
197         }
198
199         if (!is_valid) {
200                 ast_log(LOG_ERROR, "Response validation failed for /asterisk/variable\n");
201                 ast_ari_response_error(response, 500,
202                         "Internal Server Error", "Response validation failed");
203         }
204 #endif /* AST_DEVMODE */
205
206 fin: __attribute__((unused))
207         return;
208 }
209 /*!
210  * \brief Parameter parsing callback for /asterisk/variable.
211  * \param get_params GET parameters in the HTTP request.
212  * \param path_vars Path variables extracted from the request.
213  * \param headers HTTP headers.
214  * \param[out] response Response to the HTTP request.
215  */
216 static void ast_ari_asterisk_set_global_var_cb(
217         struct ast_variable *get_params, struct ast_variable *path_vars,
218         struct ast_variable *headers, struct ast_ari_response *response)
219 {
220         struct ast_ari_asterisk_set_global_var_args args = {};
221         struct ast_variable *i;
222 #if defined(AST_DEVMODE)
223         int is_valid;
224         int code;
225 #endif /* AST_DEVMODE */
226
227         for (i = get_params; i; i = i->next) {
228                 if (strcmp(i->name, "variable") == 0) {
229                         args.variable = (i->value);
230                 } else
231                 if (strcmp(i->name, "value") == 0) {
232                         args.value = (i->value);
233                 } else
234                 {}
235         }
236         ast_ari_asterisk_set_global_var(headers, &args, response);
237 #if defined(AST_DEVMODE)
238         code = response->response_code;
239
240         switch (code) {
241         case 0: /* Implementation is still a stub, or the code wasn't set */
242                 is_valid = response->message == NULL;
243                 break;
244         case 500: /* Internal Server Error */
245         case 501: /* Not Implemented */
246         case 400: /* Missing variable parameter. */
247                 is_valid = 1;
248                 break;
249         default:
250                 if (200 <= code && code <= 299) {
251                         is_valid = ast_ari_validate_void(
252                                 response->message);
253                 } else {
254                         ast_log(LOG_ERROR, "Invalid error response %d for /asterisk/variable\n", code);
255                         is_valid = 0;
256                 }
257         }
258
259         if (!is_valid) {
260                 ast_log(LOG_ERROR, "Response validation failed for /asterisk/variable\n");
261                 ast_ari_response_error(response, 500,
262                         "Internal Server Error", "Response validation failed");
263         }
264 #endif /* AST_DEVMODE */
265
266 fin: __attribute__((unused))
267         return;
268 }
269
270 /*! \brief REST handler for /api-docs/asterisk.{format} */
271 static struct stasis_rest_handlers asterisk_info = {
272         .path_segment = "info",
273         .callbacks = {
274                 [AST_HTTP_GET] = ast_ari_asterisk_get_info_cb,
275         },
276         .num_children = 0,
277         .children = {  }
278 };
279 /*! \brief REST handler for /api-docs/asterisk.{format} */
280 static struct stasis_rest_handlers asterisk_variable = {
281         .path_segment = "variable",
282         .callbacks = {
283                 [AST_HTTP_GET] = ast_ari_asterisk_get_global_var_cb,
284                 [AST_HTTP_POST] = ast_ari_asterisk_set_global_var_cb,
285         },
286         .num_children = 0,
287         .children = {  }
288 };
289 /*! \brief REST handler for /api-docs/asterisk.{format} */
290 static struct stasis_rest_handlers asterisk = {
291         .path_segment = "asterisk",
292         .callbacks = {
293         },
294         .num_children = 2,
295         .children = { &asterisk_info,&asterisk_variable, }
296 };
297
298 static int load_module(void)
299 {
300         int res = 0;
301         stasis_app_ref();
302         res |= ast_ari_add_handler(&asterisk);
303         return res;
304 }
305
306 static int unload_module(void)
307 {
308         ast_ari_remove_handler(&asterisk);
309         stasis_app_unref();
310         return 0;
311 }
312
313 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - Asterisk resources",
314         .load = load_module,
315         .unload = unload_module,
316         .nonoptreq = "res_ari,res_stasis",
317         );