res_fax.c: Add chan locked precondition comments.
[asterisk/asterisk.git] / res / res_ari_endpoints.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 Endpoint 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 ASTERISK_REGISTER_FILE()
44
45 #include "asterisk/app.h"
46 #include "asterisk/module.h"
47 #include "asterisk/stasis_app.h"
48 #include "ari/resource_endpoints.h"
49 #if defined(AST_DEVMODE)
50 #include "ari/ari_model_validators.h"
51 #endif
52
53 #define MAX_VALS 128
54
55 /*!
56  * \brief Parameter parsing callback for /endpoints.
57  * \param get_params GET parameters in the HTTP request.
58  * \param path_vars Path variables extracted from the request.
59  * \param headers HTTP headers.
60  * \param[out] response Response to the HTTP request.
61  */
62 static void ast_ari_endpoints_list_cb(
63         struct ast_tcptls_session_instance *ser,
64         struct ast_variable *get_params, struct ast_variable *path_vars,
65         struct ast_variable *headers, struct ast_ari_response *response)
66 {
67         struct ast_ari_endpoints_list_args args = {};
68         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
69 #if defined(AST_DEVMODE)
70         int is_valid;
71         int code;
72 #endif /* AST_DEVMODE */
73
74         ast_ari_endpoints_list(headers, &args, response);
75 #if defined(AST_DEVMODE)
76         code = response->response_code;
77
78         switch (code) {
79         case 0: /* Implementation is still a stub, or the code wasn't set */
80                 is_valid = response->message == NULL;
81                 break;
82         case 500: /* Internal Server Error */
83         case 501: /* Not Implemented */
84                 is_valid = 1;
85                 break;
86         default:
87                 if (200 <= code && code <= 299) {
88                         is_valid = ast_ari_validate_list(response->message,
89                                 ast_ari_validate_endpoint_fn());
90                 } else {
91                         ast_log(LOG_ERROR, "Invalid error response %d for /endpoints\n", code);
92                         is_valid = 0;
93                 }
94         }
95
96         if (!is_valid) {
97                 ast_log(LOG_ERROR, "Response validation failed for /endpoints\n");
98                 ast_ari_response_error(response, 500,
99                         "Internal Server Error", "Response validation failed");
100         }
101 #endif /* AST_DEVMODE */
102
103 fin: __attribute__((unused))
104         return;
105 }
106 int ast_ari_endpoints_send_message_parse_body(
107         struct ast_json *body,
108         struct ast_ari_endpoints_send_message_args *args)
109 {
110         struct ast_json *field;
111         /* Parse query parameters out of it */
112         field = ast_json_object_get(body, "to");
113         if (field) {
114                 args->to = ast_json_string_get(field);
115         }
116         field = ast_json_object_get(body, "from");
117         if (field) {
118                 args->from = ast_json_string_get(field);
119         }
120         field = ast_json_object_get(body, "body");
121         if (field) {
122                 args->body = ast_json_string_get(field);
123         }
124         return 0;
125 }
126
127 /*!
128  * \brief Parameter parsing callback for /endpoints/sendMessage.
129  * \param get_params GET parameters in the HTTP request.
130  * \param path_vars Path variables extracted from the request.
131  * \param headers HTTP headers.
132  * \param[out] response Response to the HTTP request.
133  */
134 static void ast_ari_endpoints_send_message_cb(
135         struct ast_tcptls_session_instance *ser,
136         struct ast_variable *get_params, struct ast_variable *path_vars,
137         struct ast_variable *headers, struct ast_ari_response *response)
138 {
139         struct ast_ari_endpoints_send_message_args args = {};
140         struct ast_variable *i;
141         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
142 #if defined(AST_DEVMODE)
143         int is_valid;
144         int code;
145 #endif /* AST_DEVMODE */
146
147         for (i = get_params; i; i = i->next) {
148                 if (strcmp(i->name, "to") == 0) {
149                         args.to = (i->value);
150                 } else
151                 if (strcmp(i->name, "from") == 0) {
152                         args.from = (i->value);
153                 } else
154                 if (strcmp(i->name, "body") == 0) {
155                         args.body = (i->value);
156                 } else
157                 {}
158         }
159         /* Look for a JSON request entity */
160         body = ast_http_get_json(ser, headers);
161         if (!body) {
162                 switch (errno) {
163                 case EFBIG:
164                         ast_ari_response_error(response, 413, "Request Entity Too Large", "Request body too large");
165                         goto fin;
166                 case ENOMEM:
167                         ast_ari_response_error(response, 500, "Internal Server Error", "Error processing request");
168                         goto fin;
169                 case EIO:
170                         ast_ari_response_error(response, 400, "Bad Request", "Error parsing request body");
171                         goto fin;
172                 }
173         }
174         args.variables = body;
175         ast_ari_endpoints_send_message(headers, &args, response);
176 #if defined(AST_DEVMODE)
177         code = response->response_code;
178
179         switch (code) {
180         case 0: /* Implementation is still a stub, or the code wasn't set */
181                 is_valid = response->message == NULL;
182                 break;
183         case 500: /* Internal Server Error */
184         case 501: /* Not Implemented */
185         case 400: /* Invalid parameters for sending a message. */
186         case 404: /* Endpoint not found */
187                 is_valid = 1;
188                 break;
189         default:
190                 if (200 <= code && code <= 299) {
191                         is_valid = ast_ari_validate_void(
192                                 response->message);
193                 } else {
194                         ast_log(LOG_ERROR, "Invalid error response %d for /endpoints/sendMessage\n", code);
195                         is_valid = 0;
196                 }
197         }
198
199         if (!is_valid) {
200                 ast_log(LOG_ERROR, "Response validation failed for /endpoints/sendMessage\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 /endpoints/{tech}.
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_endpoints_list_by_tech_cb(
217         struct ast_tcptls_session_instance *ser,
218         struct ast_variable *get_params, struct ast_variable *path_vars,
219         struct ast_variable *headers, struct ast_ari_response *response)
220 {
221         struct ast_ari_endpoints_list_by_tech_args args = {};
222         struct ast_variable *i;
223         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
224 #if defined(AST_DEVMODE)
225         int is_valid;
226         int code;
227 #endif /* AST_DEVMODE */
228
229         for (i = path_vars; i; i = i->next) {
230                 if (strcmp(i->name, "tech") == 0) {
231                         args.tech = (i->value);
232                 } else
233                 {}
234         }
235         ast_ari_endpoints_list_by_tech(headers, &args, response);
236 #if defined(AST_DEVMODE)
237         code = response->response_code;
238
239         switch (code) {
240         case 0: /* Implementation is still a stub, or the code wasn't set */
241                 is_valid = response->message == NULL;
242                 break;
243         case 500: /* Internal Server Error */
244         case 501: /* Not Implemented */
245         case 404: /* Endpoints not found */
246                 is_valid = 1;
247                 break;
248         default:
249                 if (200 <= code && code <= 299) {
250                         is_valid = ast_ari_validate_list(response->message,
251                                 ast_ari_validate_endpoint_fn());
252                 } else {
253                         ast_log(LOG_ERROR, "Invalid error response %d for /endpoints/{tech}\n", code);
254                         is_valid = 0;
255                 }
256         }
257
258         if (!is_valid) {
259                 ast_log(LOG_ERROR, "Response validation failed for /endpoints/{tech}\n");
260                 ast_ari_response_error(response, 500,
261                         "Internal Server Error", "Response validation failed");
262         }
263 #endif /* AST_DEVMODE */
264
265 fin: __attribute__((unused))
266         return;
267 }
268 /*!
269  * \brief Parameter parsing callback for /endpoints/{tech}/{resource}.
270  * \param get_params GET parameters in the HTTP request.
271  * \param path_vars Path variables extracted from the request.
272  * \param headers HTTP headers.
273  * \param[out] response Response to the HTTP request.
274  */
275 static void ast_ari_endpoints_get_cb(
276         struct ast_tcptls_session_instance *ser,
277         struct ast_variable *get_params, struct ast_variable *path_vars,
278         struct ast_variable *headers, struct ast_ari_response *response)
279 {
280         struct ast_ari_endpoints_get_args args = {};
281         struct ast_variable *i;
282         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
283 #if defined(AST_DEVMODE)
284         int is_valid;
285         int code;
286 #endif /* AST_DEVMODE */
287
288         for (i = path_vars; i; i = i->next) {
289                 if (strcmp(i->name, "tech") == 0) {
290                         args.tech = (i->value);
291                 } else
292                 if (strcmp(i->name, "resource") == 0) {
293                         args.resource = (i->value);
294                 } else
295                 {}
296         }
297         ast_ari_endpoints_get(headers, &args, response);
298 #if defined(AST_DEVMODE)
299         code = response->response_code;
300
301         switch (code) {
302         case 0: /* Implementation is still a stub, or the code wasn't set */
303                 is_valid = response->message == NULL;
304                 break;
305         case 500: /* Internal Server Error */
306         case 501: /* Not Implemented */
307         case 400: /* Invalid parameters for sending a message. */
308         case 404: /* Endpoints not found */
309                 is_valid = 1;
310                 break;
311         default:
312                 if (200 <= code && code <= 299) {
313                         is_valid = ast_ari_validate_endpoint(
314                                 response->message);
315                 } else {
316                         ast_log(LOG_ERROR, "Invalid error response %d for /endpoints/{tech}/{resource}\n", code);
317                         is_valid = 0;
318                 }
319         }
320
321         if (!is_valid) {
322                 ast_log(LOG_ERROR, "Response validation failed for /endpoints/{tech}/{resource}\n");
323                 ast_ari_response_error(response, 500,
324                         "Internal Server Error", "Response validation failed");
325         }
326 #endif /* AST_DEVMODE */
327
328 fin: __attribute__((unused))
329         return;
330 }
331 int ast_ari_endpoints_send_message_to_endpoint_parse_body(
332         struct ast_json *body,
333         struct ast_ari_endpoints_send_message_to_endpoint_args *args)
334 {
335         struct ast_json *field;
336         /* Parse query parameters out of it */
337         field = ast_json_object_get(body, "from");
338         if (field) {
339                 args->from = ast_json_string_get(field);
340         }
341         field = ast_json_object_get(body, "body");
342         if (field) {
343                 args->body = ast_json_string_get(field);
344         }
345         return 0;
346 }
347
348 /*!
349  * \brief Parameter parsing callback for /endpoints/{tech}/{resource}/sendMessage.
350  * \param get_params GET parameters in the HTTP request.
351  * \param path_vars Path variables extracted from the request.
352  * \param headers HTTP headers.
353  * \param[out] response Response to the HTTP request.
354  */
355 static void ast_ari_endpoints_send_message_to_endpoint_cb(
356         struct ast_tcptls_session_instance *ser,
357         struct ast_variable *get_params, struct ast_variable *path_vars,
358         struct ast_variable *headers, struct ast_ari_response *response)
359 {
360         struct ast_ari_endpoints_send_message_to_endpoint_args args = {};
361         struct ast_variable *i;
362         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
363 #if defined(AST_DEVMODE)
364         int is_valid;
365         int code;
366 #endif /* AST_DEVMODE */
367
368         for (i = get_params; i; i = i->next) {
369                 if (strcmp(i->name, "from") == 0) {
370                         args.from = (i->value);
371                 } else
372                 if (strcmp(i->name, "body") == 0) {
373                         args.body = (i->value);
374                 } else
375                 {}
376         }
377         for (i = path_vars; i; i = i->next) {
378                 if (strcmp(i->name, "tech") == 0) {
379                         args.tech = (i->value);
380                 } else
381                 if (strcmp(i->name, "resource") == 0) {
382                         args.resource = (i->value);
383                 } else
384                 {}
385         }
386         /* Look for a JSON request entity */
387         body = ast_http_get_json(ser, headers);
388         if (!body) {
389                 switch (errno) {
390                 case EFBIG:
391                         ast_ari_response_error(response, 413, "Request Entity Too Large", "Request body too large");
392                         goto fin;
393                 case ENOMEM:
394                         ast_ari_response_error(response, 500, "Internal Server Error", "Error processing request");
395                         goto fin;
396                 case EIO:
397                         ast_ari_response_error(response, 400, "Bad Request", "Error parsing request body");
398                         goto fin;
399                 }
400         }
401         args.variables = body;
402         ast_ari_endpoints_send_message_to_endpoint(headers, &args, response);
403 #if defined(AST_DEVMODE)
404         code = response->response_code;
405
406         switch (code) {
407         case 0: /* Implementation is still a stub, or the code wasn't set */
408                 is_valid = response->message == NULL;
409                 break;
410         case 500: /* Internal Server Error */
411         case 501: /* Not Implemented */
412         case 400: /* Invalid parameters for sending a message. */
413         case 404: /* Endpoint not found */
414                 is_valid = 1;
415                 break;
416         default:
417                 if (200 <= code && code <= 299) {
418                         is_valid = ast_ari_validate_void(
419                                 response->message);
420                 } else {
421                         ast_log(LOG_ERROR, "Invalid error response %d for /endpoints/{tech}/{resource}/sendMessage\n", code);
422                         is_valid = 0;
423                 }
424         }
425
426         if (!is_valid) {
427                 ast_log(LOG_ERROR, "Response validation failed for /endpoints/{tech}/{resource}/sendMessage\n");
428                 ast_ari_response_error(response, 500,
429                         "Internal Server Error", "Response validation failed");
430         }
431 #endif /* AST_DEVMODE */
432
433 fin: __attribute__((unused))
434         return;
435 }
436
437 /*! \brief REST handler for /api-docs/endpoints.json */
438 static struct stasis_rest_handlers endpoints_sendMessage = {
439         .path_segment = "sendMessage",
440         .callbacks = {
441                 [AST_HTTP_PUT] = ast_ari_endpoints_send_message_cb,
442         },
443         .num_children = 0,
444         .children = {  }
445 };
446 /*! \brief REST handler for /api-docs/endpoints.json */
447 static struct stasis_rest_handlers endpoints_tech_resource_sendMessage = {
448         .path_segment = "sendMessage",
449         .callbacks = {
450                 [AST_HTTP_PUT] = ast_ari_endpoints_send_message_to_endpoint_cb,
451         },
452         .num_children = 0,
453         .children = {  }
454 };
455 /*! \brief REST handler for /api-docs/endpoints.json */
456 static struct stasis_rest_handlers endpoints_tech_resource = {
457         .path_segment = "resource",
458         .is_wildcard = 1,
459         .callbacks = {
460                 [AST_HTTP_GET] = ast_ari_endpoints_get_cb,
461         },
462         .num_children = 1,
463         .children = { &endpoints_tech_resource_sendMessage, }
464 };
465 /*! \brief REST handler for /api-docs/endpoints.json */
466 static struct stasis_rest_handlers endpoints_tech = {
467         .path_segment = "tech",
468         .is_wildcard = 1,
469         .callbacks = {
470                 [AST_HTTP_GET] = ast_ari_endpoints_list_by_tech_cb,
471         },
472         .num_children = 1,
473         .children = { &endpoints_tech_resource, }
474 };
475 /*! \brief REST handler for /api-docs/endpoints.json */
476 static struct stasis_rest_handlers endpoints = {
477         .path_segment = "endpoints",
478         .callbacks = {
479                 [AST_HTTP_GET] = ast_ari_endpoints_list_cb,
480         },
481         .num_children = 2,
482         .children = { &endpoints_sendMessage,&endpoints_tech, }
483 };
484
485 static int load_module(void)
486 {
487         int res = 0;
488         stasis_app_ref();
489         res |= ast_ari_add_handler(&endpoints);
490         return res;
491 }
492
493 static int unload_module(void)
494 {
495         ast_ari_remove_handler(&endpoints);
496         stasis_app_unref();
497         return 0;
498 }
499
500 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - Endpoint resources",
501         .support_level = AST_MODULE_SUPPORT_CORE,
502         .load = load_module,
503         .unload = unload_module,
504         .nonoptreq = "res_ari,res_stasis",
505 );