kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-02 11:06:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

ARI: Support channel variables in originate

Browse Source 
This adds back in support for specifying channel variables during an
originate without compromising the ability to specify query parameters
in the JSON body. This was accomplished by generating the body-parsing
code in a separate function instead of being integrated with the URI
query parameter parsing code such that it could be called by paths with
body parameters. This is transparent to the user of the API and
prevents manual duplication of code or data structures.

(closes issue ASTERISK-23051)
Review: https://reviewboard.asterisk.org/r/3122/
Reported by: Matt Jordan
........

Merged revisions 406003 from http://svn.asterisk.org/svn/asterisk/branches/12


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@406006 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Kinsey Moore
2014-01-21 14:27:21 +00:00
parent 4bc84b1b9f
commit 1590d32ab0
23 changed files with 1161 additions and 474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
rest-api-templates/ari_resource.h.mustache
View File

@@ -62,6 +62,19 @@ struct ast_ari_{{c_name}}_{{c_nickname}}_args {
{{/parameters}}
};
{{#is_req}}
{{#parse_body}}
/*!
* \brief Body parsing function for {{path}}.
* \param body The JSON body from which to parse parameters.
* \param[out] args The args structure to parse into.
* \retval zero on success
* \retval non-zero on failure
*/
int ast_ari_{{c_name}}_{{c_nickname}}_parse_body(
struct ast_json *body,
struct ast_ari_{{c_name}}_{{c_nickname}}_args *args);
{{/parse_body}}
/*!
* \brief {{summary}}
{{#notes}}

2
rest-api-templates/asterisk_processor.py
View File

@@ -203,8 +203,10 @@ class AsteriskProcessor(SwaggerPostProcessor):
def process_parameter(self, parameter, context):
if parameter.param_type == 'body':
parameter.is_body_parameter = True;
parameter.c_data_type = 'struct ast_json *'
else:
parameter.is_body_parameter = False;
if not parameter.data_type in self.type_mapping:
raise SwaggerError(
"Invalid parameter type %s" % parameter.data_type, context)

71
rest-api-templates/body_parsing.mustache Normal file
View File

@@ -0,0 +1,71 @@
{{!
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2014, Digium, Inc.
*
* William Kinsey Moore, III <kmoore@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.
}}
{{#parse_body}}
int ast_ari_{{c_name}}_{{c_nickname}}_parse_body(
struct ast_json *body,
struct ast_ari_{{c_name}}_{{c_nickname}}_args *args)
{
{{#has_query_parameters}}
struct ast_json *field;
{{/has_query_parameters}}
/* Parse query parameters out of it */
{{#query_parameters}}
{{^is_body_parameter}}
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}}) {
return -1;
}
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}}) {
return -1;
}
args->{{c_name}}[0] = {{json_convert}}(field);
}
{{/allow_multiple}}
}
{{/is_body_parameter}}
{{/query_parameters}}
return 0;
}
{{/parse_body}}

41
rest-api-templates/param_parsing.mustache
View File

@@ -104,45 +104,10 @@
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}}
if (ast_ari_{{c_name}}_{{c_nickname}}_parse_body(body, &args)) {
ast_ari_response_alloc_failed(response);
goto fin;
}
{{/query_parameters}}
{{/body_parameter}}
{{/parse_body}}
{{/is_websocket}}

6
rest-api-templates/res_ari_resource.c.mustache
View File

@@ -66,6 +66,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
{{#apis}}
{{#operations}}
{{#is_req}}
{{> body_parsing}}
/*!
* \brief Parameter parsing callback for {{path}}.
* \param get_params GET parameters in the HTTP request.
@@ -83,11 +84,6 @@ static void ast_ari_{{c_name}}_{{c_nickname}}_cb(
struct ast_variable *i;
{{/has_parameters}}
RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
{{^body_parameter}}
{{#has_query_parameters}}
struct ast_json *field;
{{/has_query_parameters}}
{{/body_parameter}}
#if defined(AST_DEVMODE)
int is_valid;
int code;