ari:Add application/json parameter support
[asterisk/asterisk.git] / rest-api-templates / res_ari_resource.c.mustache
1 {{#api_declaration}}
2 /*
3  * Asterisk -- An open source telephony toolkit.
4  *
5  * {{{copyright}}}
6  *
7  * {{{author}}}
8 {{! Template Copyright
9  * Copyright (C) 2013, Digium, Inc.
10  *
11  * David M. Lee, II <dlee@digium.com>
12 }}
13  *
14  * See http://www.asterisk.org for more information about
15  * the Asterisk project. Please do not directly contact
16  * any of the maintainers of this project for assistance;
17  * the project provides a web site, mailing lists and IRC
18  * channels for your use.
19  *
20  * This program is free software, distributed under the terms of
21  * the GNU General Public License Version 2. See the LICENSE file
22  * at the top of the source tree.
23  */
24
25 {{! Template for rendering the res_ module for an HTTP resource. }}
26 /*
27 {{> do-not-edit}}
28  * This file is generated by a mustache template. Please see the original
29  * template in rest-api-templates/res_ari_resource.c.mustache
30  */
31
32 /*! \file
33  *
34  * \brief {{{description}}}
35  *
36  * \author {{{author}}}
37  */
38
39 /*** MODULEINFO
40         <depend type="module">res_ari</depend>
41         <depend type="module">res_stasis</depend>
42         <support_level>core</support_level>
43  ***/
44
45 #include "asterisk.h"
46
47 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
48
49 #include "asterisk/app.h"
50 #include "asterisk/module.h"
51 #include "asterisk/stasis_app.h"
52 #include "ari/resource_{{c_name}}.h"
53 #if defined(AST_DEVMODE)
54 #include "ari/ari_model_validators.h"
55 #endif
56 {{^has_websocket}}
57 {{! Only include http_websocket if necessary. Otherwise we'll do a lot of
58  *  unnecessary optional_api intialization, which makes optional_api harder
59  *  to debug
60  }}
61 #include "asterisk/http_websocket.h"
62 {{/has_websocket}}
63
64 #define MAX_VALS 128
65
66 {{#apis}}
67 {{#operations}}
68 {{#is_req}}
69 /*!
70  * \brief Parameter parsing callback for {{path}}.
71  * \param get_params GET parameters in the HTTP request.
72  * \param path_vars Path variables extracted from the request.
73  * \param headers HTTP headers.
74  * \param[out] response Response to the HTTP request.
75  */
76 static void ast_ari_{{c_name}}_{{c_nickname}}_cb(
77         struct ast_tcptls_session_instance *ser,
78         struct ast_variable *get_params, struct ast_variable *path_vars,
79         struct ast_variable *headers, struct ast_ari_response *response)
80 {
81         struct ast_ari_{{c_name}}_{{c_nickname}}_args args = {};
82 {{#has_parameters}}
83         struct ast_variable *i;
84 {{/has_parameters}}
85         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
86 {{^body_parameter}}
87 {{#has_query_parameters}}
88         struct ast_json *field;
89 {{/has_query_parameters}}
90 {{/body_parameter}}
91 #if defined(AST_DEVMODE)
92         int is_valid;
93         int code;
94 #endif /* AST_DEVMODE */
95
96 {{> param_parsing}}
97         ast_ari_{{c_name}}_{{c_nickname}}(headers, &args, response);
98 #if defined(AST_DEVMODE)
99         code = response->response_code;
100
101         switch (code) {
102         case 0: /* Implementation is still a stub, or the code wasn't set */
103                 is_valid = response->message == NULL;
104                 break;
105         case 500: /* Internal Server Error */
106         case 501: /* Not Implemented */
107 {{#error_responses}}
108         case {{code}}: /* {{{reason}}} */
109 {{/error_responses}}
110                 is_valid = 1;
111                 break;
112         default:
113                 if (200 <= code && code <= 299) {
114 {{#response_class}}
115 {{#is_list}}
116                         is_valid = ast_ari_validate_list(response->message,
117                                 ast_ari_validate_{{c_singular_name}}_fn());
118 {{/is_list}}
119 {{^is_list}}
120                         is_valid = ast_ari_validate_{{c_name}}(
121                                 response->message);
122 {{/is_list}}
123 {{/response_class}}
124                 } else {
125                         ast_log(LOG_ERROR, "Invalid error response %d for {{path}}\n", code);
126                         is_valid = 0;
127                 }
128         }
129
130         if (!is_valid) {
131                 ast_log(LOG_ERROR, "Response validation failed for {{path}}\n");
132                 ast_ari_response_error(response, 500,
133                         "Internal Server Error", "Response validation failed");
134         }
135 #endif /* AST_DEVMODE */
136
137 fin: __attribute__((unused))
138 {{> param_cleanup}}
139         return;
140 }
141 {{/is_req}}
142 {{#is_websocket}}
143 static void ast_ari_{{c_name}}_{{c_nickname}}_ws_cb(struct ast_websocket *ws_session,
144         struct ast_variable *get_params, struct ast_variable *headers)
145 {
146         struct ast_ari_{{c_name}}_{{c_nickname}}_args args = {};
147 {{#has_parameters}}
148         RAII_VAR(struct ast_ari_response *, response, NULL, ast_free);
149         struct ast_variable *i;
150 {{/has_parameters}}
151         RAII_VAR(struct ast_websocket *, s, ws_session, ast_websocket_unref);
152         RAII_VAR(struct ast_ari_websocket_session *, session, NULL, ao2_cleanup);
153 {{#has_path_parameters}}
154         /* TODO: It's not immediately obvious how to pass path params through
155          * the websocket code to this callback. Not needed right now, so we'll
156          * just punt. */
157         struct ast_variable *path_vars = NULL;
158 {{/has_path_parameters}}
159
160 {{#has_parameters}}
161         response = ast_calloc(1, sizeof(*response));
162         if (!response) {
163                 ast_log(LOG_ERROR, "Failed to create response.\n");
164                 goto fin;
165         }
166 {{/has_parameters}}
167
168 #if defined(AST_DEVMODE)
169         session = ast_ari_websocket_session_create(ws_session,
170                 ast_ari_validate_{{response_class.c_name}}_fn());
171 #else
172         session = ast_ari_websocket_session_create(ws_session, NULL);
173 #endif
174         if (!session) {
175                 ast_log(LOG_ERROR, "Failed to create ARI session\n");
176                 goto fin;
177         }
178
179 {{> param_parsing}}
180
181         ast_ari_websocket_{{c_name}}_{{c_nickname}}(session, headers, &args);
182
183 fin: __attribute__((unused))
184         if (response && response->response_code != 0) {
185                 /* Param parsing failure */
186                 /* TODO - ideally, this would return the error code to the
187                  * HTTP client; but we've already done the WebSocket
188                  * negotiation. Param parsing should happen earlier, but we
189                  * need a way to pass it through the WebSocket code to the
190                  * callback */
191                 RAII_VAR(char *, msg, NULL, ast_json_free);
192                 if (response->message) {
193                         msg = ast_json_dump_string(response->message);
194                 } else {
195                         ast_log(LOG_ERROR, "Missing response message\n");
196                 }
197                 if (msg) {
198                         ast_websocket_write(ws_session,
199                                 AST_WEBSOCKET_OPCODE_TEXT, msg, strlen(msg));
200                 }
201         }
202 {{> param_cleanup}}
203 }
204 {{/is_websocket}}
205 {{/operations}}
206 {{/apis}}
207
208 {{! The rest_handler partial expands to the tree of stasis_rest_handlers }}
209 {{#root_path}}
210 {{> rest_handler}}
211 {{/root_path}}
212
213 static int load_module(void)
214 {
215         int res = 0;
216 {{#apis}}
217 {{#has_websocket}}
218         {{full_name}}.ws_server = ast_websocket_server_create();
219         if (!{{full_name}}.ws_server) {
220                 return AST_MODULE_LOAD_FAILURE;
221         }
222 {{/has_websocket}}
223 {{#operations}}
224 {{#is_websocket}}
225         res |= ast_websocket_server_add_protocol({{full_name}}.ws_server,
226                 "{{websocket_protocol}}", ast_ari_{{c_name}}_{{c_nickname}}_ws_cb);
227 {{/is_websocket}}
228 {{/operations}}
229 {{/apis}}
230         stasis_app_ref();
231         res |= ast_ari_add_handler(&{{root_full_name}});
232         return res;
233 }
234
235 static int unload_module(void)
236 {
237         ast_ari_remove_handler(&{{root_full_name}});
238 {{#apis}}
239 {{#has_websocket}}
240         ao2_cleanup({{full_name}}.ws_server);
241         {{full_name}}.ws_server = NULL;
242 {{/has_websocket}}
243 {{/apis}}
244         stasis_app_unref();
245         return 0;
246 }
247
248 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - {{{description}}}",
249         .load = load_module,
250         .unload = unload_module,
251         .nonoptreq = "res_ari,res_stasis",
252         );
253 {{/api_declaration}}