GNUnet  0.11.x
json.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2014-2017, 2021 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
27 #include "platform.h"
28 #include "gnunet_json_lib.h"
29 
30 
32 GNUNET_JSON_parse (const json_t *root,
33  struct GNUNET_JSON_Specification *spec,
34  const char **error_json_name,
35  unsigned int *error_line)
36 {
37  if (NULL == root)
38  return GNUNET_SYSERR;
39  for (unsigned int i = 0; NULL != spec[i].parser; i++)
40  {
41  json_t *pos;
42 
43  if (NULL == spec[i].field)
44  pos = (json_t *) root;
45  else
46  pos = json_object_get (root,
47  spec[i].field);
48  if ( ( (NULL == pos) ||
49  (json_is_null (pos) ) ) &&
50  (spec[i].is_optional) )
51  continue;
52  if ( (NULL == pos) ||
53  (GNUNET_OK !=
54  spec[i].parser (spec[i].cls,
55  pos,
56  &spec[i])) )
57  {
58  if (NULL != error_json_name)
59  *error_json_name = spec[i].field;
60  else
62  "Parsing failed for field `%s:%u`\n",
63  spec[i].field,
64  i);
65  if (NULL != error_line)
66  *error_line = i;
68  return GNUNET_SYSERR;
69  }
70  }
71  return GNUNET_OK; /* all OK! */
72 }
73 
74 
77 {
78  struct GNUNET_JSON_Specification ret = spec;
79 
80  ret.is_optional = true;
81  return ret;
82 }
83 
84 
85 void
87 {
88  for (unsigned int i = 0; NULL != spec[i].parser; i++)
89  if (NULL != spec[i].cleaner)
90  spec[i].cleaner (spec[i].cls,
91  &spec[i]);
92 }
93 
94 
107 static int
109  void *scls,
110  const char *option,
111  const char *value)
112 {
113  json_t **json = scls;
114  json_error_t error;
115 
116  *json = json_loads (value, JSON_REJECT_DUPLICATES, &error);
117  if (NULL == *json)
118  {
119  fprintf (stderr,
120  _ ("Failed to parse JSON in option `%s': %s (%s)\n"),
121  option,
122  error.text,
123  error.source);
124  return GNUNET_SYSERR;
125  }
126  return GNUNET_OK;
127 }
128 
129 
132  const char *name,
133  const char *argumentHelp,
134  const char *description,
135  json_t **json)
136 {
138  .name = name,
139  .argumentHelp = argumentHelp,
140  .description = description,
141  .require_argument = 1,
142  .processor = &set_json,
143  .scls = (void *) json };
144 
145  return clo;
146 }
147 
148 
149 /* end of json.c */
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
static char * value
Value of the record to add/remove.
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
#define GNUNET_log(kind,...)
GNUNET_GenericReturnValue
Named constants for return values.
Definition: gnunet_common.h:92
@ GNUNET_OK
Definition: gnunet_common.h:95
@ GNUNET_SYSERR
Definition: gnunet_common.h:93
functions to parse JSON objects into GNUnet objects
@ GNUNET_ERROR_TYPE_WARNING
void GNUNET_JSON_parse_free(struct GNUNET_JSON_Specification *spec)
Frees all elements allocated during a GNUNET_JSON_parse() operation.
Definition: json.c:86
static int set_json(struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, void *scls, const char *option, const char *value)
Set an option with a JSON value from the command line.
Definition: json.c:108
struct GNUNET_JSON_Specification GNUNET_JSON_spec_mark_optional(struct GNUNET_JSON_Specification spec)
Set the "optional" flag for a parser specification entry.
Definition: json.c:76
struct GNUNET_GETOPT_CommandLineOption GNUNET_JSON_getopt(char shortName, const char *name, const char *argumentHelp, const char *description, json_t **json)
Allow user to specify a JSON input value.
Definition: json.c:131
enum GNUNET_GenericReturnValue GNUNET_JSON_parse(const json_t *root, struct GNUNET_JSON_Specification *spec, const char **error_json_name, unsigned int *error_line)
Navigate and parse data in a JSON tree.
Definition: json.c:32
#define _(String)
GNU gettext support macro.
Definition: platform.h:177
const char * name
Definition of a command line option.
const char * description
Help text for the option (description)
const char * argumentHelp
Name of the argument for the user in help text.
const char shortName
Short name of the option.
General context for command line processors.
Entry in parser specification for GNUNET_JSON_parse().
GNUNET_JSON_Cleaner cleaner
Function for how to clean up this type of entry.
const char * field
Name of the field to parse, use NULL to get the JSON of the main object instead of the JSON of an ind...
void * cls
Closure for parser and cleaner.
GNUNET_JSON_Parser parser
Function for how to parse this type of entry.