The patch allows ARI to parse request parameters from an incoming JSON request body, instead of requiring the request to come in as query parameters (which is just weird for POST and DELETE) or form parameters (which is okay, but a bit asymmetric given that all of our responses are JSON). For any operation that does _not_ have a parameter defined of type body (i.e. "paramType": "body" in the API declaration), if a request provides a request body with a Content type of "application/json", the provided JSON document is parsed and searched for parameters. The expected fields in the provided JSON document should match the query parameters defined for the operation. If the parameter has 'allowMultiple' set, then the field in the JSON document may optionally be an array of values. (closes issue ASTERISK-22685) Review: https://reviewboard.asterisk.org/r/2994/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@403177 65c4cc65-6c06-0410-ace0-fbb531ad65f3
149 lines
4 KiB
Text
149 lines
4 KiB
Text
{{!
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2013, Digium, Inc.
|
|
*
|
|
* David M. Lee, II <dlee@digium.com>
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
}}
|
|
{{!
|
|
* Snippet for decoding parameters into an _args struct.
|
|
}}
|
|
{{#has_query_parameters}}
|
|
for (i = get_params; i; i = i->next) {
|
|
{{#query_parameters}}
|
|
if (strcmp(i->name, "{{name}}") == 0) {
|
|
{{^allow_multiple}}
|
|
args.{{c_name}} = {{c_convert}}(i->value);
|
|
{{/allow_multiple}}
|
|
{{#allow_multiple}}
|
|
/* Parse comma separated list */
|
|
char *vals[MAX_VALS];
|
|
size_t j;
|
|
|
|
args.{{c_name}}_parse = ast_strdup(i->value);
|
|
if (!args.{{c_name}}_parse) {
|
|
ast_ari_response_alloc_failed(response);
|
|
goto fin;
|
|
}
|
|
|
|
if (strlen(args.{{c_name}}_parse) == 0) {
|
|
/* ast_app_separate_args can't handle "" */
|
|
args.{{c_name}}_count = 1;
|
|
vals[0] = args.{{c_name}}_parse;
|
|
} else {
|
|
args.{{c_name}}_count = ast_app_separate_args(
|
|
args.{{c_name}}_parse, ',', vals,
|
|
ARRAY_LEN(vals));
|
|
}
|
|
|
|
if (args.{{c_name}}_count == 0) {
|
|
ast_ari_response_alloc_failed(response);
|
|
goto fin;
|
|
}
|
|
|
|
if (args.{{c_name}}_count >= MAX_VALS) {
|
|
ast_ari_response_error(response, 400,
|
|
"Bad Request",
|
|
"Too many values for {{c_name}}");
|
|
goto fin;
|
|
}
|
|
|
|
args.{{c_name}} = ast_malloc(sizeof(*args.{{c_name}}) * args.{{c_name}}_count);
|
|
if (!args.{{c_name}}) {
|
|
ast_ari_response_alloc_failed(response);
|
|
goto fin;
|
|
}
|
|
|
|
for (j = 0; j < args.{{c_name}}_count; ++j) {
|
|
args.{{c_name}}[j] = {{c_convert}}(vals[j]);
|
|
}
|
|
{{/allow_multiple}}
|
|
} else
|
|
{{/query_parameters}}
|
|
{}
|
|
}
|
|
{{/has_query_parameters}}
|
|
{{#has_path_parameters}}
|
|
for (i = path_vars; i; i = i->next) {
|
|
{{#path_parameters}}
|
|
if (strcmp(i->name, "{{name}}") == 0) {
|
|
args.{{c_name}} = {{c_convert}}(i->value);
|
|
} else
|
|
{{/path_parameters}}
|
|
{}
|
|
}
|
|
{{/has_path_parameters}}
|
|
{{^is_websocket}}
|
|
{{#parse_body}}
|
|
/* Look for a JSON request entity */
|
|
body = ast_http_get_json(ser, headers);
|
|
if (!body) {
|
|
switch (errno) {
|
|
case EFBIG:
|
|
ast_ari_response_error(response, 413, "Request Entity Too Large", "Request body too large");
|
|
goto fin;
|
|
case ENOMEM:
|
|
ast_ari_response_error(response, 500, "Internal Server Error", "Error processing request");
|
|
goto fin;
|
|
case EIO:
|
|
ast_ari_response_error(response, 400, "Bad Request", "Error parsing request body");
|
|
goto fin;
|
|
}
|
|
}
|
|
{{#body_parameter}}
|
|
args.{{c_name}} = ast_json_ref(body);
|
|
{{/body_parameter}}
|
|
{{^body_parameter}}
|
|
/* Parse query parameters out of it */
|
|
{{#query_parameters}}
|
|
field = ast_json_object_get(body, "{{name}}");
|
|
if (field) {
|
|
{{^allow_multiple}}
|
|
args.{{c_name}} = {{json_convert}}(field);
|
|
{{/allow_multiple}}
|
|
{{#allow_multiple}}
|
|
/* If they were silly enough to both pass in a query param and a
|
|
* JSON body, free up the query value.
|
|
*/
|
|
ast_free(args.{{c_name}});
|
|
if (ast_json_typeof(field) == AST_JSON_ARRAY) {
|
|
/* Multiple param passed as array */
|
|
size_t i;
|
|
args.{{c_name}}_count = ast_json_array_size(field);
|
|
args.{{c_name}} = ast_malloc(sizeof(*args.{{c_name}}) * args.{{c_name}}_count);
|
|
|
|
if (!args.{{c_name}}) {
|
|
ast_ari_response_alloc_failed(response);
|
|
goto fin;
|
|
}
|
|
|
|
for (i = 0; i < args.{{c_name}}_count; ++i) {
|
|
args.{{c_name}}[i] = {{json_convert}}(ast_json_array_get(field, i));
|
|
}
|
|
} else {
|
|
/* Multiple param passed as single value */
|
|
args.{{c_name}}_count = 1;
|
|
args.{{c_name}} = ast_malloc(sizeof(*args.{{c_name}}) * args.{{c_name}}_count);
|
|
if (!args.{{c_name}}) {
|
|
ast_ari_response_alloc_failed(response);
|
|
goto fin;
|
|
}
|
|
args.{{c_name}}[0] = {{json_convert}}(field);
|
|
}
|
|
{{/allow_multiple}}
|
|
}
|
|
{{/query_parameters}}
|
|
{{/body_parameter}}
|
|
{{/parse_body}}
|
|
{{/is_websocket}}
|