2 * Copyright (C) 2016, 2017 "IoT.bzh"
3 * Author José Bollo <jose.bollo@iot.bzh>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 * This simple program expands the object { "$ref": "#/path/to/a/target" }
25 * "b": { "$ref": "#/type/a" }
29 * will be exapanded to
38 * Invocation: program [file|-]...
40 * without arguments, it reads the input.
48 #include <json-c/json.h>
50 #define oom(x) do{if(!(x)){fprintf(stderr,"out of memory\n");exit(1);}}while(0)
53 * records path to the expanded node
57 struct json_object *object; /**< node being expanded */
58 struct path *upper; /**< link to upper expanded nodes */
62 * root of the JSON being parsed
64 struct json_object *root = NULL;
65 struct json_object *d_perms = NULL;
66 struct json_object *a_perms = NULL;
67 const char *init = NULL;
68 const char *start = NULL;
69 const char *onevent = NULL;
70 const char *api = NULL;
71 const char *scope = NULL;
72 const char *prefix = NULL;
73 const char *postfix = NULL;
77 * Search for a reference of type "#/a/b/c" int the
80 struct json_object *search(const char *path)
83 struct json_object *i;
85 /* does it match #/ at the beginning? */
86 if (path[0] != '#' || (path[0] && path[1] != '/'))
89 /* search from root to target */
94 if (!json_object_object_get_ex(i, d, &i))
96 d = strtok(NULL, "/");
102 * Expands the node designated by path and returns its expanded form
104 struct json_object *expand_$ref(struct path path)
107 struct json_object *o, *x;
109 struct json_object_iterator ji, jn;
111 /* expansion depends of the type of the node */
112 switch (json_object_get_type(path.object)) {
113 case json_type_object:
114 /* for object, look if it contains a property "$ref" */
115 if (json_object_object_get_ex(path.object, "$ref", &o)) {
116 /* yes, reference, try to substitute its target */
117 if (!json_object_is_type(o, json_type_string)) {
118 fprintf(stderr, "found a $ref not being string. Is: %s\n", json_object_get_string(o));
121 x = search(json_object_get_string(o));
123 fprintf(stderr, "$ref not found. Was: %s\n", json_object_get_string(o));
128 if (x == p->object) {
129 fprintf(stderr, "$ref recursive. Was: %s\n", json_object_get_string(o));
134 /* cool found, return a new instance of the target */
135 return json_object_get(x);
137 /* no, expand the values */
138 ji = json_object_iter_begin(path.object);
139 jn = json_object_iter_end(path.object);
140 while (!json_object_iter_equal(&ji, &jn)) {
141 o = json_object_iter_peek_value(&ji);
142 x = expand_$ref((struct path){ .object = o, .upper = &path });
144 json_object_object_add(path.object, json_object_iter_peek_name(&ji), x);
145 json_object_iter_next(&ji);
148 case json_type_array:
149 /* expand the values of arrays */
151 n = json_object_array_length(path.object);
153 o = json_object_array_get_idx(path.object, i);
154 x = expand_$ref((struct path){ .object = o, .upper = &path });
156 json_object_array_put_idx(path.object, i, x);
161 /* otherwise no expansion */
165 /* return the given node */
170 char *make_desc(struct json_object *o)
173 char *desc, c, buf[3];
177 a = b = json_object_to_json_string_ext(root, 0);
180 len += 1 + ('"' == c);
183 len += 7 * (1 + len / 72);
195 else if (c == '\\') {
196 switch ((c = *b++)) {
217 if (pos >= 77 && !e) {
242 struct json_object *permissions_of_verb(struct json_object *obj)
244 struct json_object *x, *y;
246 if (json_object_object_get_ex(obj, "x-permissions", &x))
249 if (json_object_object_get_ex(obj, "get", &x))
250 if (json_object_object_get_ex(x, "x-permissions", &y))
260 n = a_perms ? json_object_array_length(a_perms) : 0;
262 printf("static const struct afb_auth _afb_auths_v2_%s[] = {\n" , api);
265 printf("\t{ %s }", json_object_get_string(json_object_array_get_idx(a_perms, i)));
266 printf(",\n"+(++i == n));
272 struct json_object *new_perm(struct json_object *obj, const char *desc)
276 struct json_object *x, *y;
278 tag = obj ? json_object_to_json_string_ext(obj, 0) : desc;
279 if (!json_object_object_get_ex(d_perms, tag, &y)) {
281 d_perms = json_object_new_object();
282 a_perms = json_object_new_array();
285 asprintf(&b, "&_afb_auths_v2_%s[%d]", api, json_object_array_length(a_perms));
286 x = json_object_new_string(desc);
287 y = json_object_new_string(b);
288 json_object_array_add(a_perms, x);
289 json_object_object_add(d_perms, tag, y);
295 struct json_object *decl_perm(struct json_object *obj);
297 struct json_object *decl_perm_a(const char *op, struct json_object *obj)
301 struct json_object *x, *y;
304 i = n = obj ? json_object_array_length(obj) : 0;
306 y = decl_perm(json_object_array_get_idx(obj, --i));
312 asprintf(&a, ".type = afb_auth_%s, .first = %s, .next = %s",
313 op, json_object_get_string(y), json_object_get_string(x));
314 x = new_perm(NULL, a);
321 struct json_object *decl_perm(struct json_object *obj)
324 struct json_object *x, *y;
326 if (json_object_object_get_ex(d_perms, json_object_to_json_string_ext(obj, 0), &x))
329 if (json_object_object_get_ex(obj, "permission", &x)) {
330 asprintf(&a, ".type = afb_auth_Permission, .text = \"%s\"", json_object_get_string(x));
331 y = new_perm(obj, a);
334 else if (json_object_object_get_ex(obj, "anyOf", &x)) {
335 y = decl_perm_a("Or", x);
337 else if (json_object_object_get_ex(obj, "allOf", &x)) {
338 y = decl_perm_a("And", x);
340 else if (json_object_object_get_ex(obj, "not", &x)) {
342 asprintf(&a, ".type = afb_auth_Not, .first = %s", json_object_get_string(x));
343 y = new_perm(obj, a);
346 else if (json_object_object_get_ex(obj, "LOA", &x))
348 else if (json_object_object_get_ex(obj, "session", &x))
356 void declare_permissions(const char *name, struct json_object *obj)
358 struct json_object *p;
360 p = permissions_of_verb(obj);
366 #define SESSION_CLOSE 0x000001
367 #define SESSION_RENEW 0x000010
368 #define SESSION_CHECK 0x000100
369 #define SESSION_LOA_1 0x001000
370 #define SESSION_LOA_2 0x011000
371 #define SESSION_LOA_3 0x111000
372 #define SESSION_MASK 0x111111
375 int get_session(struct json_object *obj);
377 int get_session_a(int and, struct json_object *obj)
381 n = obj ? json_object_array_length(obj) : 0;
386 x = get_session(json_object_array_get_idx(obj, --i));
388 y = get_session(json_object_array_get_idx(obj, --i));
397 int get_session(struct json_object *obj)
401 struct json_object *x;
404 if (json_object_object_get_ex(obj, "anyOf", &x)) {
405 y = get_session_a(1, x);
407 else if (json_object_object_get_ex(obj, "allOf", &x)) {
408 y = get_session_a(0, x);
410 else if (json_object_object_get_ex(obj, "not", &x)) {
411 y = ~get_session(x) & SESSION_MASK;
413 else if (json_object_object_get_ex(obj, "LOA", &x)) {
414 switch (json_object_get_int(x)) {
415 case 3: y = SESSION_LOA_3; break;
416 case 2: y = SESSION_LOA_2; break;
417 case 1: y = SESSION_LOA_1; break;
421 else if (json_object_object_get_ex(obj, "session", &x)) {
422 a = json_object_get_string(x);
423 if (!strcmp(a, "check"))
425 else if (!strcmp(a, "close"))
428 else if (json_object_object_get_ex(obj, "token", &x)) {
429 a = json_object_get_string(x);
430 if (!strcmp(a, "refresh"))
437 void print_session(struct json_object *p)
441 s = p ? get_session(p) : 0;
443 if (s & SESSION_CHECK) {
444 printf("%s", "|AFB_SESSION_CHECK_V2" + c);
447 if (s & SESSION_LOA_3 & ~SESSION_LOA_2)
449 else if (s & SESSION_LOA_2 & ~SESSION_LOA_1)
451 else if (s & SESSION_LOA_1)
456 printf("%s%d_V2", "|AFB_SESSION_LOA_" + c, l);
459 if (s & SESSION_CLOSE) {
460 printf("%s", "|AFB_SESSION_CLOSE_V2" + c);
463 if (s & SESSION_RENEW) {
464 printf("%s", "|AFB_SESSION_REFRESH_V2" + c);
468 printf("AFB_SESSION_NONE_V2");
471 void print_verb(const char *name)
473 printf("%s%s%s" , prefix, name, postfix);
476 void print_declare_verb(const char *name, struct json_object *obj)
478 printf("%s void ", scope);
480 printf("(struct afb_req req);\n");
483 void print_struct_verb(const char *name, struct json_object *obj)
485 struct json_object *p;
487 p = permissions_of_verb(obj);
499 , p ? json_object_get_string(decl_perm(p)) : "NULL"
508 void enum_verbs(void (*func)(const char *name, struct json_object *obj))
510 struct json_object_iterator ji, jn;
511 struct json_object *paths, *obj;
514 /* search the verbs */
515 paths = search("#/paths");
519 /* list the verbs and sort it */
520 ji = json_object_iter_begin(paths);
521 jn = json_object_iter_end(paths);
522 while (!json_object_iter_equal(&ji, &jn)) {
523 name = json_object_iter_peek_name(&ji);
524 obj = json_object_iter_peek_value(&ji);
525 name += (*name == '/');
527 json_object_iter_next(&ji);
531 void getvarbool(int *var, const char *path, int defval)
533 struct json_object *o;
535 if (*var != 0 && *var != 1) {
537 if (o && json_object_is_type(o, json_type_boolean))
538 *var = json_object_get_boolean(o);
544 void getvar(const char **var, const char *path, const char *defval)
546 struct json_object *o;
550 if (o && json_object_is_type(o, json_type_string))
551 *var = json_object_get_string(o);
558 * process a file and prints its expansion on stdout
560 void process(char *filename)
565 if (!strcmp(filename, "-"))
566 filename = "/dev/stdin";
569 if (access(filename, R_OK)) {
570 fprintf(stderr, "can't access file %s\n", filename);
575 root = json_object_from_file(filename);
577 fprintf(stderr, "reading file %s produced null\n", filename);
581 /* create the description */
582 desc = make_desc(root);
584 /* expand references */
585 root = expand_$ref((struct path){ .object = root, .upper = NULL });
588 getvar(&api, "#/info/x-binding-c-generator/api", NULL);
589 getvar(&init, "#/info/x-binding-c-generator/init", NULL);
590 getvar(&start, "#/info/x-binding-c-generator/start", NULL);
591 getvar(&onevent, "#/info/x-binding-c-generator/onevent", NULL);
592 getvar(&scope, "#/info/x-binding-c-generator/scope", "static");
593 getvar(&prefix, "#/info/x-binding-c-generator/prefix", "afb_verb_");
594 getvar(&postfix, "#/info/x-binding-c-generator/postfix", "_cb");
595 getvarbool(&priv, "#/info/x-binding-c-generator/private", 0);
596 getvar(&api, "#/info/title", "?");
598 /* get the API name */
601 "static const char _afb_description_v2_%s[] =\n"
607 enum_verbs(declare_permissions);
609 enum_verbs(print_declare_verb);
612 "static const struct afb_verb_v2 _afb_verbs_v2_%s[] = {\n"
615 enum_verbs(print_struct_verb);
617 " { .verb = NULL }\n"
622 "%sconst struct afb_binding_v2 %s%s = {\n"
624 " .specification = _afb_description_v2_%s,\n"
625 " .verbs = _afb_verbs_v2_%s,\n"
631 , priv ? "static " : ""
632 , priv ? "_afb_binding_v2_" : "afbBindingV2"
643 json_object_put(root);
647 /** process the list of files or stdin if none */
648 int main(int ac, char **av)
653 do { process(*av); } while(*++av);