ari endpoints: GET /ari/endpoints/{invalid-tech} should return a 404
[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_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_endpoints.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 /endpoints.
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_endpoints_list_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_endpoints_list_args args = {};
66 #if defined(AST_DEVMODE)
67         int is_valid;
68         int code;
69 #endif /* AST_DEVMODE */
70
71         ast_ari_endpoints_list(headers, &args, response);
72 #if defined(AST_DEVMODE)
73         code = response->response_code;
74
75         switch (code) {
76         case 0: /* Implementation is still a stub, or the code wasn't set */
77                 is_valid = response->message == NULL;
78                 break;
79         case 500: /* Internal Server Error */
80         case 501: /* Not Implemented */
81                 is_valid = 1;
82                 break;
83         default:
84                 if (200 <= code && code <= 299) {
85                         is_valid = ast_ari_validate_list(response->message,
86                                 ast_ari_validate_endpoint_fn());
87                 } else {
88                         ast_log(LOG_ERROR, "Invalid error response %d for /endpoints\n", code);
89                         is_valid = 0;
90                 }
91         }
92
93         if (!is_valid) {
94                 ast_log(LOG_ERROR, "Response validation failed for /endpoints\n");
95                 ast_ari_response_error(response, 500,
96                         "Internal Server Error", "Response validation failed");
97         }
98 #endif /* AST_DEVMODE */
99
100 fin: __attribute__((unused))
101         return;
102 }
103 /*!
104  * \brief Parameter parsing callback for /endpoints/{tech}.
105  * \param get_params GET parameters in the HTTP request.
106  * \param path_vars Path variables extracted from the request.
107  * \param headers HTTP headers.
108  * \param[out] response Response to the HTTP request.
109  */
110 static void ast_ari_endpoints_list_by_tech_cb(
111         struct ast_variable *get_params, struct ast_variable *path_vars,
112         struct ast_variable *headers, struct ast_ari_response *response)
113 {
114         struct ast_ari_endpoints_list_by_tech_args args = {};
115         struct ast_variable *i;
116 #if defined(AST_DEVMODE)
117         int is_valid;
118         int code;
119 #endif /* AST_DEVMODE */
120
121         for (i = path_vars; i; i = i->next) {
122                 if (strcmp(i->name, "tech") == 0) {
123                         args.tech = (i->value);
124                 } else
125                 {}
126         }
127         ast_ari_endpoints_list_by_tech(headers, &args, response);
128 #if defined(AST_DEVMODE)
129         code = response->response_code;
130
131         switch (code) {
132         case 0: /* Implementation is still a stub, or the code wasn't set */
133                 is_valid = response->message == NULL;
134                 break;
135         case 500: /* Internal Server Error */
136         case 501: /* Not Implemented */
137         case 404: /* Endpoints not found */
138                 is_valid = 1;
139                 break;
140         default:
141                 if (200 <= code && code <= 299) {
142                         is_valid = ast_ari_validate_list(response->message,
143                                 ast_ari_validate_endpoint_fn());
144                 } else {
145                         ast_log(LOG_ERROR, "Invalid error response %d for /endpoints/{tech}\n", code);
146                         is_valid = 0;
147                 }
148         }
149
150         if (!is_valid) {
151                 ast_log(LOG_ERROR, "Response validation failed for /endpoints/{tech}\n");
152                 ast_ari_response_error(response, 500,
153                         "Internal Server Error", "Response validation failed");
154         }
155 #endif /* AST_DEVMODE */
156
157 fin: __attribute__((unused))
158         return;
159 }
160 /*!
161  * \brief Parameter parsing callback for /endpoints/{tech}/{resource}.
162  * \param get_params GET parameters in the HTTP request.
163  * \param path_vars Path variables extracted from the request.
164  * \param headers HTTP headers.
165  * \param[out] response Response to the HTTP request.
166  */
167 static void ast_ari_endpoints_get_cb(
168         struct ast_variable *get_params, struct ast_variable *path_vars,
169         struct ast_variable *headers, struct ast_ari_response *response)
170 {
171         struct ast_ari_endpoints_get_args args = {};
172         struct ast_variable *i;
173 #if defined(AST_DEVMODE)
174         int is_valid;
175         int code;
176 #endif /* AST_DEVMODE */
177
178         for (i = path_vars; i; i = i->next) {
179                 if (strcmp(i->name, "tech") == 0) {
180                         args.tech = (i->value);
181                 } else
182                 if (strcmp(i->name, "resource") == 0) {
183                         args.resource = (i->value);
184                 } else
185                 {}
186         }
187         ast_ari_endpoints_get(headers, &args, response);
188 #if defined(AST_DEVMODE)
189         code = response->response_code;
190
191         switch (code) {
192         case 0: /* Implementation is still a stub, or the code wasn't set */
193                 is_valid = response->message == NULL;
194                 break;
195         case 500: /* Internal Server Error */
196         case 501: /* Not Implemented */
197         case 404: /* Endpoints not found */
198                 is_valid = 1;
199                 break;
200         default:
201                 if (200 <= code && code <= 299) {
202                         is_valid = ast_ari_validate_endpoint(
203                                 response->message);
204                 } else {
205                         ast_log(LOG_ERROR, "Invalid error response %d for /endpoints/{tech}/{resource}\n", code);
206                         is_valid = 0;
207                 }
208         }
209
210         if (!is_valid) {
211                 ast_log(LOG_ERROR, "Response validation failed for /endpoints/{tech}/{resource}\n");
212                 ast_ari_response_error(response, 500,
213                         "Internal Server Error", "Response validation failed");
214         }
215 #endif /* AST_DEVMODE */
216
217 fin: __attribute__((unused))
218         return;
219 }
220
221 /*! \brief REST handler for /api-docs/endpoints.{format} */
222 static struct stasis_rest_handlers endpoints_tech_resource = {
223         .path_segment = "resource",
224         .is_wildcard = 1,
225         .callbacks = {
226                 [AST_HTTP_GET] = ast_ari_endpoints_get_cb,
227         },
228         .num_children = 0,
229         .children = {  }
230 };
231 /*! \brief REST handler for /api-docs/endpoints.{format} */
232 static struct stasis_rest_handlers endpoints_tech = {
233         .path_segment = "tech",
234         .is_wildcard = 1,
235         .callbacks = {
236                 [AST_HTTP_GET] = ast_ari_endpoints_list_by_tech_cb,
237         },
238         .num_children = 1,
239         .children = { &endpoints_tech_resource, }
240 };
241 /*! \brief REST handler for /api-docs/endpoints.{format} */
242 static struct stasis_rest_handlers endpoints = {
243         .path_segment = "endpoints",
244         .callbacks = {
245                 [AST_HTTP_GET] = ast_ari_endpoints_list_cb,
246         },
247         .num_children = 1,
248         .children = { &endpoints_tech, }
249 };
250
251 static int load_module(void)
252 {
253         int res = 0;
254         stasis_app_ref();
255         res |= ast_ari_add_handler(&endpoints);
256         return res;
257 }
258
259 static int unload_module(void)
260 {
261         ast_ari_remove_handler(&endpoints);
262         stasis_app_unref();
263         return 0;
264 }
265
266 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - Endpoint resources",
267         .load = load_module,
268         .unload = unload_module,
269         .nonoptreq = "res_ari,res_stasis",
270         );