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().

{
  char *tmp;

  if (NULL != *(gnsrecord_info->rd))
  {
    for (int i = 0; i < *(gnsrecord_info->rd_count); i++)
    {
      tmp = (char*) (*(gnsrecord_info->rd))[i].data;
      if (NULL != tmp)
        GNUNET_free (tmp);
    }
    GNUNET_free (*(gnsrecord_info->rd));
    *(gnsrecord_info->rd) = NULL;
  }
  if (NULL != *(gnsrecord_info->name))
    GNUNET_free (*(gnsrecord_info->name));
  *(gnsrecord_info->name) = NULL;
}

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

cls	closure, NULL
root	the json object representing data
spec	where 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().

{
  struct GNUNET_TIME_Absolute abs_expiration_time;
  struct GNUNET_TIME_Relative rel_expiration_time;
  const char *value;
  const char *record_type;
  const char *expiration_time;
  int private;
  int supplemental;
  int rel_exp;
  int shadow;
  int unpack_state = 0;

  // interpret single gns record
  unpack_state = json_unpack (data,
                              "{s:s, s:s, s:s, s:b, s:b, s:b, s:b}",
                              GNUNET_JSON_GNSRECORD_VALUE,
                              &value,
                              GNUNET_JSON_GNSRECORD_TYPE,
                              &record_type,
                              GNUNET_JSON_GNSRECORD_EXPIRATION_TIME,
                              &expiration_time,
                              GNUNET_JSON_GNSRECORD_FLAG_PRIVATE,
                              &private,
                              GNUNET_JSON_GNSRECORD_FLAG_SUPPLEMENTAL,
                              &supplemental,
                              GNUNET_JSON_GNSRECORD_FLAG_RELATIVE,
                              &rel_exp,
                              GNUNET_JSON_GNSRECORD_FLAG_SHADOW,
                              &shadow);
  if (0 != unpack_state)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Error gnsdata object has a wrong format!\n");
    return GNUNET_SYSERR;
  }
  rd->record_type = GNUNET_GNSRECORD_typename_to_number (record_type);
  if (UINT32_MAX == rd->record_type)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unsupported type\n");
    return GNUNET_SYSERR;
  }
  if (GNUNET_OK != GNUNET_GNSRECORD_string_to_value (rd->record_type,
                                                     value,
                                                     (void **) &rd->data,
                                                     &rd->data_size))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Value invalid for record type\n");
    return GNUNET_SYSERR;
  }

  if (0 == strcmp (expiration_time, GNUNET_JSON_GNSRECORD_NEVER))
  {
    rd->expiration_time = GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us;
  }
  else if ((1 != rel_exp) &&
           (GNUNET_OK ==
           GNUNET_STRINGS_fancy_time_to_absolute (expiration_time,
                                                  &abs_expiration_time)))
  {
    rd->expiration_time = abs_expiration_time.abs_value_us;
  }
  else if (GNUNET_OK ==
           GNUNET_STRINGS_fancy_time_to_relative (expiration_time,
                                                  &rel_expiration_time))
  {
    rd->flags |= GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION;
    rd->expiration_time = rel_expiration_time.rel_value_us;
  }
  else
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Expiration time invalid\n");
    return GNUNET_SYSERR;
  }
  if (1 == private)
    rd->flags |= GNUNET_GNSRECORD_RF_PRIVATE;
  if (1 == supplemental)
    rd->flags |= GNUNET_GNSRECORD_RF_SUPPLEMENTAL;
  if (1 == shadow)
    rd->flags |= GNUNET_GNSRECORD_RF_SHADOW_RECORD;
  return GNUNET_OK;
}

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

cls	closure, NULL
root	the json object representing data
spec	where 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().

{
  GNUNET_assert (NULL != data);
  if (! json_is_array (data))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Error gns record data JSON is not an array!\n");
    return GNUNET_SYSERR;
  }
  *(gnsrecord_info->rd_count) = json_array_size (data);
  *(gnsrecord_info->rd) = GNUNET_malloc (sizeof(struct GNUNET_GNSRECORD_Data)
                                         * json_array_size (data));
  size_t index;
  json_t *value;
  json_array_foreach (data, index, value)
  {
    if (GNUNET_OK != parse_record (value, &(*(gnsrecord_info->rd))[index]))
      return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

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().

{
  struct GnsRecordInfo *gnsrecord_info;
  int unpack_state = 0;
  const char *name;
  json_t *data;

  GNUNET_assert (NULL != root);
  if (! json_is_object (root))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Error record JSON is not an object!\n");
    return GNUNET_SYSERR;
  }
  // interpret single gns record
  unpack_state = json_unpack (root,
                              "{s:s, s:o!}",
                              GNUNET_JSON_GNSRECORD_RECORD_NAME,
                              &name,
                              GNUNET_JSON_GNSRECORD_RECORD_DATA,
                              &data);
  if (0 != unpack_state)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Error namestore records object has a wrong format!\n");
    return GNUNET_SYSERR;
  }
  gnsrecord_info = (struct GnsRecordInfo *) spec->ptr;
  *(gnsrecord_info->name) = GNUNET_strdup (name);
  if (GNUNET_OK != parse_record_data (gnsrecord_info, data))
  {
    cleanup_recordinfo (gnsrecord_info);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

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

	cls	closure, NULL
[out]	spec	where 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().

{
  struct GnsRecordInfo *gnsrecord_info = (struct GnsRecordInfo *) spec->ptr;

  GNUNET_free (gnsrecord_info);
}

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_object

struct 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().

{
  struct GnsRecordInfo *gnsrecord_info = GNUNET_new (struct GnsRecordInfo);

  gnsrecord_info->rd = rd;
  gnsrecord_info->name = name;
  gnsrecord_info->rd_count = rd_count;
  struct GNUNET_JSON_Specification ret = { .parser = &parse_gnsrecordobject,
                                           .cleaner = &clean_gnsrecordobject,
                                           .cls = NULL,
                                           .field = NULL,
                                           .ptr = (struct GnsRecordInfo *)
                                                  gnsrecord_info,
                                           .ptr_size = 0,
                                           .size_ptr = NULL };
  return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function: