GNUnet  0.11.x
Data Structures | Macros | Functions
json_gnsrecord.c File Reference

JSON handling of GNS record data. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_json_lib.h"
Include dependency graph for json_gnsrecord.c:

Go to the source code of this file.

Data Structures

struct  GnsRecordInfo
 

Macros

#define GNUNET_JSON_GNSRECORD_VALUE   "value"
 
#define GNUNET_JSON_GNSRECORD_RECORD_DATA   "data"
 
#define GNUNET_JSON_GNSRECORD_TYPE   "record_type"
 
#define GNUNET_JSON_GNSRECORD_EXPIRATION_TIME   "expiration_time"
 
#define GNUNET_JSON_GNSRECORD_FLAG_PRIVATE   "private"
 
#define GNUNET_JSON_GNSRECORD_FLAG_SUPPLEMENTAL   "supplemental"
 
#define GNUNET_JSON_GNSRECORD_FLAG_RELATIVE   "relative_expiration"
 
#define GNUNET_JSON_GNSRECORD_FLAG_SHADOW   "shadow"
 
#define GNUNET_JSON_GNSRECORD_RECORD_NAME   "record_name"
 
#define GNUNET_JSON_GNSRECORD_NEVER   "never"
 

Functions

static void cleanup_recordinfo (struct GnsRecordInfo *gnsrecord_info)
 
static int parse_record (json_t *data, struct GNUNET_GNSRECORD_Data *rd)
 Parse given JSON object to gns record. More...
 
static int parse_record_data (struct GnsRecordInfo *gnsrecord_info, json_t *data)
 Parse given JSON object to gns record. More...
 
static int parse_gnsrecordobject (void *cls, json_t *root, struct GNUNET_JSON_Specification *spec)
 
static void clean_gnsrecordobject (void *cls, struct GNUNET_JSON_Specification *spec)
 Cleanup data left from parsing the record. More...
 
struct GNUNET_JSON_Specification GNUNET_JSON_spec_gnsrecord (struct GNUNET_GNSRECORD_Data **rd, unsigned int *rd_count, char **name)
 JSON Specification for GNS Records. More...
 

Detailed Description

JSON handling of GNS record data.

Author
Philippe Buschmann

Definition in file json_gnsrecord.c.

Macro Definition Documentation

◆ GNUNET_JSON_GNSRECORD_VALUE

#define GNUNET_JSON_GNSRECORD_VALUE   "value"

Definition at line 30 of file json_gnsrecord.c.

Referenced by parse_record().

◆ GNUNET_JSON_GNSRECORD_RECORD_DATA

#define GNUNET_JSON_GNSRECORD_RECORD_DATA   "data"

Definition at line 31 of file json_gnsrecord.c.

Referenced by parse_gnsrecordobject().

◆ GNUNET_JSON_GNSRECORD_TYPE

#define GNUNET_JSON_GNSRECORD_TYPE   "record_type"

Definition at line 32 of file json_gnsrecord.c.

Referenced by parse_record().

◆ GNUNET_JSON_GNSRECORD_EXPIRATION_TIME

#define GNUNET_JSON_GNSRECORD_EXPIRATION_TIME   "expiration_time"

Definition at line 33 of file json_gnsrecord.c.

Referenced by parse_record().

◆ GNUNET_JSON_GNSRECORD_FLAG_PRIVATE

#define GNUNET_JSON_GNSRECORD_FLAG_PRIVATE   "private"

Definition at line 34 of file json_gnsrecord.c.

Referenced by parse_record().

◆ GNUNET_JSON_GNSRECORD_FLAG_SUPPLEMENTAL

#define GNUNET_JSON_GNSRECORD_FLAG_SUPPLEMENTAL   "supplemental"

Definition at line 35 of file json_gnsrecord.c.

Referenced by parse_record().

◆ GNUNET_JSON_GNSRECORD_FLAG_RELATIVE

#define GNUNET_JSON_GNSRECORD_FLAG_RELATIVE   "relative_expiration"

Definition at line 36 of file json_gnsrecord.c.

Referenced by parse_record().

◆ GNUNET_JSON_GNSRECORD_FLAG_SHADOW

#define GNUNET_JSON_GNSRECORD_FLAG_SHADOW   "shadow"

Definition at line 37 of file json_gnsrecord.c.

Referenced by parse_record().

◆ GNUNET_JSON_GNSRECORD_RECORD_NAME

#define GNUNET_JSON_GNSRECORD_RECORD_NAME   "record_name"

Definition at line 38 of file json_gnsrecord.c.

Referenced by parse_gnsrecordobject().

◆ GNUNET_JSON_GNSRECORD_NEVER

#define GNUNET_JSON_GNSRECORD_NEVER   "never"

Definition at line 39 of file json_gnsrecord.c.

Referenced by parse_record().

Function Documentation

◆ cleanup_recordinfo()

static void cleanup_recordinfo ( struct GnsRecordInfo gnsrecord_info)
static

Definition at line 52 of file json_gnsrecord.c.

References data, GNUNET_free, GnsRecordInfo::name, GnsRecordInfo::rd, and GnsRecordInfo::rd_count.

Referenced by parse_gnsrecordobject().

53 {
54  char *tmp;
55 
56  if (NULL != *(gnsrecord_info->rd))
57  {
58  for (int i = 0; i < *(gnsrecord_info->rd_count); i++)
59  {
60  tmp = (char*) (*(gnsrecord_info->rd))[i].data;
61  if (NULL != tmp)
62  GNUNET_free (tmp);
63  }
64  GNUNET_free (*(gnsrecord_info->rd));
65  *(gnsrecord_info->rd) = NULL;
66  }
67  if (NULL != *(gnsrecord_info->name))
68  GNUNET_free (*(gnsrecord_info->name));
69  *(gnsrecord_info->name) = NULL;
70 }
unsigned int * rd_count
struct GNUNET_GNSRECORD_Data ** rd
uint32_t data
The data value.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the caller graph for this function:

◆ parse_record()

static int parse_record ( json_t *  data,
struct GNUNET_GNSRECORD_Data rd 
)
static

Parse given JSON object to gns record.

Parameters
clsclosure, NULL
rootthe json object representing data
specwhere to write the data
Returns
GNUNET_OK upon successful parsing; GNUNET_SYSERR upon error

Definition at line 82 of file json_gnsrecord.c.

References GNUNET_TIME_Absolute::abs_value_us, GNUNET_GNSRECORD_Data::data, GNUNET_GNSRECORD_Data::data_size, GNUNET_GNSRECORD_Data::expiration_time, GNUNET_GNSRECORD_Data::flags, GNUNET_ERROR_TYPE_ERROR, GNUNET_GNSRECORD_RF_PRIVATE, GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION, GNUNET_GNSRECORD_RF_SHADOW_RECORD, GNUNET_GNSRECORD_RF_SUPPLEMENTAL, GNUNET_GNSRECORD_string_to_value(), GNUNET_GNSRECORD_typename_to_number(), GNUNET_JSON_GNSRECORD_EXPIRATION_TIME, GNUNET_JSON_GNSRECORD_FLAG_PRIVATE, GNUNET_JSON_GNSRECORD_FLAG_RELATIVE, GNUNET_JSON_GNSRECORD_FLAG_SHADOW, GNUNET_JSON_GNSRECORD_FLAG_SUPPLEMENTAL, GNUNET_JSON_GNSRECORD_NEVER, GNUNET_JSON_GNSRECORD_TYPE, GNUNET_JSON_GNSRECORD_VALUE, GNUNET_log, GNUNET_OK, GNUNET_STRINGS_fancy_time_to_absolute(), GNUNET_STRINGS_fancy_time_to_relative(), GNUNET_SYSERR, GNUNET_TIME_UNIT_FOREVER_ABS, GNUNET_GNSRECORD_Data::record_type, GNUNET_TIME_Relative::rel_value_us, and value.

Referenced by parse_record_data().

83 {
84  struct GNUNET_TIME_Absolute abs_expiration_time;
85  struct GNUNET_TIME_Relative rel_expiration_time;
86  const char *value;
87  const char *record_type;
88  const char *expiration_time;
89  int private;
90  int supplemental;
91  int rel_exp;
92  int shadow;
93  int unpack_state = 0;
94 
95  // interpret single gns record
96  unpack_state = json_unpack (data,
97  "{s:s, s:s, s:s, s:b, s:b, s:b, s:b}",
99  &value,
101  &record_type,
103  &expiration_time,
105  &private,
107  &supplemental,
109  &rel_exp,
111  &shadow);
112  if (0 != unpack_state)
113  {
115  "Error gnsdata object has a wrong format!\n");
116  return GNUNET_SYSERR;
117  }
119  if (UINT32_MAX == rd->record_type)
120  {
121  GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unsupported type\n");
122  return GNUNET_SYSERR;
123  }
125  value,
126  (void **) &rd->data,
127  &rd->data_size))
128  {
129  GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Value invalid for record type\n");
130  return GNUNET_SYSERR;
131  }
132 
133  if (0 == strcmp (expiration_time, GNUNET_JSON_GNSRECORD_NEVER))
134  {
136  }
137  else if ((1 != rel_exp) &&
138  (GNUNET_OK ==
139  GNUNET_STRINGS_fancy_time_to_absolute (expiration_time,
140  &abs_expiration_time)))
141  {
142  rd->expiration_time = abs_expiration_time.abs_value_us;
143  }
144  else if (GNUNET_OK ==
145  GNUNET_STRINGS_fancy_time_to_relative (expiration_time,
146  &rel_expiration_time))
147  {
149  rd->expiration_time = rel_expiration_time.rel_value_us;
150  }
151  else
152  {
153  GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Expiration time invalid\n");
154  return GNUNET_SYSERR;
155  }
156  if (1 == private)
158  if (1 == supplemental)
160  if (1 == shadow)
162  return GNUNET_OK;
163 }
#define GNUNET_JSON_GNSRECORD_VALUE
This record should not be used unless all (other) records with an absolute expiration time have expir...
#define GNUNET_JSON_GNSRECORD_FLAG_SUPPLEMENTAL
uint32_t GNUNET_GNSRECORD_typename_to_number(const char *dns_typename)
Convert a type name (i.e.
Definition: gnsrecord.c:204
#define GNUNET_JSON_GNSRECORD_EXPIRATION_TIME
int GNUNET_STRINGS_fancy_time_to_relative(const char *fancy_time, struct GNUNET_TIME_Relative *rtime)
Convert a given fancy human-readable time to our internal representation.
Definition: strings.c:355
int GNUNET_STRINGS_fancy_time_to_absolute(const char *fancy_time, struct GNUNET_TIME_Absolute *atime)
Convert a given fancy human-readable time to our internal representation.
Definition: strings.c:406
This is a supplemental record.
size_t data_size
Number of bytes in data.
#define GNUNET_TIME_UNIT_FOREVER_ABS
Constant used to specify "forever".
#define GNUNET_JSON_GNSRECORD_FLAG_PRIVATE
const void * data
Binary value stored in the DNS record.
static char * value
Value of the record to add/remove.
uint64_t expiration_time
Expiration time for the DNS record.
This is a private record of this peer and it should thus not be handed out to other peers...
int GNUNET_GNSRECORD_string_to_value(uint32_t type, const char *s, void **data, size_t *data_size)
Convert human-readable version of a &#39;value&#39; of a record to the binary representation.
Definition: gnsrecord.c:175
#define GNUNET_JSON_GNSRECORD_TYPE
uint32_t record_type
Type of the GNS/DNS record.
#define GNUNET_log(kind,...)
Time for absolute times used by GNUnet, in microseconds.
#define GNUNET_JSON_GNSRECORD_NEVER
enum GNUNET_GNSRECORD_Flags flags
Flags for the record.
This expiration time of the record is a relative time (not an absolute time).
uint32_t data
The data value.
#define GNUNET_JSON_GNSRECORD_FLAG_RELATIVE
Time for relative time used by GNUnet, in microseconds.
#define GNUNET_JSON_GNSRECORD_FLAG_SHADOW
Here is the call graph for this function:
Here is the caller graph for this function:

◆ parse_record_data()

static int parse_record_data ( struct GnsRecordInfo gnsrecord_info,
json_t *  data 
)
static

Parse given JSON object to gns record.

Parameters
clsclosure, NULL
rootthe json object representing data
specwhere to write the data
Returns
GNUNET_OK upon successful parsing; GNUNET_SYSERR upon error

Definition at line 175 of file json_gnsrecord.c.

References GNUNET_assert, GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_malloc, GNUNET_OK, GNUNET_SYSERR, parse_record(), GnsRecordInfo::rd, GnsRecordInfo::rd_count, and value.

Referenced by parse_gnsrecordobject().

176 {
177  GNUNET_assert (NULL != data);
178  if (! json_is_array (data))
179  {
181  "Error gns record data JSON is not an array!\n");
182  return GNUNET_SYSERR;
183  }
184  *(gnsrecord_info->rd_count) = json_array_size (data);
185  *(gnsrecord_info->rd) = GNUNET_malloc (sizeof(struct GNUNET_GNSRECORD_Data)
186  * json_array_size (data));
187  size_t index;
188  json_t *value;
189  json_array_foreach (data, index, value)
190  {
191  if (GNUNET_OK != parse_record (value, &(*(gnsrecord_info->rd))[index]))
192  return GNUNET_SYSERR;
193  }
194  return GNUNET_OK;
195 }
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static char * value
Value of the record to add/remove.
unsigned int * rd_count
static int parse_record(json_t *data, struct GNUNET_GNSRECORD_Data *rd)
Parse given JSON object to gns record.
#define GNUNET_log(kind,...)
struct GNUNET_GNSRECORD_Data ** rd
uint32_t data
The data value.
#define GNUNET_malloc(size)
Wrapper around malloc.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ parse_gnsrecordobject()

static int parse_gnsrecordobject ( void *  cls,
json_t *  root,
struct GNUNET_JSON_Specification spec 
)
static

Definition at line 199 of file json_gnsrecord.c.

References cleanup_recordinfo(), data, GNUNET_assert, GNUNET_ERROR_TYPE_ERROR, GNUNET_JSON_GNSRECORD_RECORD_DATA, GNUNET_JSON_GNSRECORD_RECORD_NAME, GNUNET_log, GNUNET_OK, GNUNET_strdup, GNUNET_SYSERR, GnsRecordInfo::name, parse_record_data(), and GNUNET_JSON_Specification::ptr.

Referenced by GNUNET_JSON_spec_gnsrecord().

202 {
203  struct GnsRecordInfo *gnsrecord_info;
204  int unpack_state = 0;
205  const char *name;
206  json_t *data;
207 
208  GNUNET_assert (NULL != root);
209  if (! json_is_object (root))
210  {
212  "Error record JSON is not an object!\n");
213  return GNUNET_SYSERR;
214  }
215  // interpret single gns record
216  unpack_state = json_unpack (root,
217  "{s:s, s:o!}",
219  &name,
221  &data);
222  if (0 != unpack_state)
223  {
225  "Error namestore records object has a wrong format!\n");
226  return GNUNET_SYSERR;
227  }
228  gnsrecord_info = (struct GnsRecordInfo *) spec->ptr;
229  *(gnsrecord_info->name) = GNUNET_strdup (name);
230  if (GNUNET_OK != parse_record_data (gnsrecord_info, data))
231  {
232  cleanup_recordinfo (gnsrecord_info);
233  return GNUNET_SYSERR;
234  }
235  return GNUNET_OK;
236 }
#define GNUNET_JSON_GNSRECORD_RECORD_NAME
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static int parse_record_data(struct GnsRecordInfo *gnsrecord_info, json_t *data)
Parse given JSON object to gns record.
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
static void cleanup_recordinfo(struct GnsRecordInfo *gnsrecord_info)
void * ptr
Pointer, details specific to the parser.
const char * name
#define GNUNET_log(kind,...)
#define GNUNET_JSON_GNSRECORD_RECORD_DATA
uint32_t data
The data value.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ clean_gnsrecordobject()

static void clean_gnsrecordobject ( void *  cls,
struct GNUNET_JSON_Specification spec 
)
static

Cleanup data left from parsing the record.

Parameters
clsclosure, NULL
[out]specwhere to free the data

Definition at line 246 of file json_gnsrecord.c.

References GNUNET_free, and GNUNET_JSON_Specification::ptr.

Referenced by GNUNET_JSON_spec_gnsrecord().

247 {
248  struct GnsRecordInfo *gnsrecord_info = (struct GnsRecordInfo *) spec->ptr;
249 
250  GNUNET_free (gnsrecord_info);
251 }
void * ptr
Pointer, details specific to the parser.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the caller graph for this function:

◆ GNUNET_JSON_spec_gnsrecord()

struct GNUNET_JSON_Specification GNUNET_JSON_spec_gnsrecord ( struct GNUNET_GNSRECORD_Data **  rd,
unsigned int *  rd_count,
char **  name 
)

JSON Specification for GNS Records.

Parameters
gnsrecord_objectstruct of GNUNET_GNSRECORD_Data to fill
Returns
JSON Specification

Definition at line 261 of file json_gnsrecord.c.

References clean_gnsrecordobject(), GNUNET_new, GnsRecordInfo::name, parse_gnsrecordobject(), GNUNET_JSON_Specification::parser, GnsRecordInfo::rd, GnsRecordInfo::rd_count, and ret.

Referenced by namestore_add_or_update().

264 {
265  struct GnsRecordInfo *gnsrecord_info = GNUNET_new (struct GnsRecordInfo);
266 
267  gnsrecord_info->rd = rd;
268  gnsrecord_info->name = name;
269  gnsrecord_info->rd_count = rd_count;
271  .cleaner = &clean_gnsrecordobject,
272  .cls = NULL,
273  .field = NULL,
274  .ptr = (struct GnsRecordInfo *)
275  gnsrecord_info,
276  .ptr_size = 0,
277  .size_ptr = NULL };
278  return ret;
279 }
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
Entry in parser specification for GNUNET_JSON_parse().
#define GNUNET_new(type)
Allocate a struct or union of the given type.
static int parse_gnsrecordobject(void *cls, json_t *root, struct GNUNET_JSON_Specification *spec)
unsigned int * rd_count
const char * name
static void clean_gnsrecordobject(void *cls, struct GNUNET_JSON_Specification *spec)
Cleanup data left from parsing the record.
struct GNUNET_GNSRECORD_Data ** rd
Here is the call graph for this function:
Here is the caller graph for this function: