json_pack.c File Reference

functions to pack JSON objects More...

#include "platform.h"
#include "gnunet_json_lib.h"

Include dependency graph for json_pack.c:

Go to the source code of this file.

Functions
json_t *	GNUNET_JSON_pack_ (struct GNUNET_JSON_PackSpec spec[])
	Pack a JSON object from a spec. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_end_ (void)
	Do not use directly. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_allow_null (struct GNUNET_JSON_PackSpec in)
	Modify packer instruction to allow NULL as a value. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_bool (const char *name, bool b)
	Generate packer instruction for a JSON field of type bool. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_string (const char *name, const char *s)
	Generate packer instruction for a JSON field of type string. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_uint64 (const char *name, uint64_t num)
	Generate packer instruction for a JSON field of type unsigned integer. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_int64 (const char *name, int64_t num)
	Generate packer instruction for a JSON field of type signed integer. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_object_steal (const char *name, json_t *o)
	Generate packer instruction for a JSON field of type JSON object where the reference is taken over by the packer. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_object_incref (const char *name, json_t *o)
	Generate packer instruction for a JSON field of type JSON object where the reference counter is incremented by the packer. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_array_steal (const char *name, json_t *a)
	Generate packer instruction for a JSON field of type JSON array where the reference is taken over by the packer. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_array_incref (const char *name, json_t *a)
	Generate packer instruction for a JSON field of type JSON array where the reference counter is incremented by the packer. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_data_varsize (const char *name, const void *blob, size_t blob_size)
	Generate packer instruction for a JSON field of type variable size binary blob. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_data64_varsize (const char *name, const void *blob, size_t blob_size)
	Generate packer instruction for a JSON field of type variable size binary blob. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_timestamp (const char *name, struct GNUNET_TIME_Timestamp t)
	Generate packer instruction for a JSON field of type timestamp. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_timestamp_nbo (const char *name, struct GNUNET_TIME_TimestampNBO at)
	Generate packer instruction for a JSON field of type timestamp in network byte order. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_time_rel (const char *name, struct GNUNET_TIME_Relative rt)
	Generate packer instruction for a JSON field of type relative time. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_time_rel_nbo (const char *name, struct GNUNET_TIME_RelativeNBO rt)
	Generate packer instruction for a JSON field of type relative time in network byte order. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_rsa_public_key (const char *name, const struct GNUNET_CRYPTO_RsaPublicKey *pk)
	Generate packer instruction for a JSON field of type RSA public key. More...
struct GNUNET_JSON_PackSpec	GNUNET_JSON_pack_rsa_signature (const char *name, const struct GNUNET_CRYPTO_RsaSignature *sig)
	Generate packer instruction for a JSON field of type RSA signature. More...

Detailed Description

functions to pack JSON objects

Author

Christian Grothoff

Definition in file json_pack.c.

Function Documentation

GNUNET_JSON_pack_()

json_t* GNUNET_JSON_pack_

(

struct GNUNET_JSON_PackSpec

spec[]

)

Pack a JSON object from a spec.

Aborts if packing fails.

Parameters

spec	specification object

Returns

JSON object

Definition at line 30 of file json_pack.c.

{
  json_t *ret;
 
  if (NULL == spec[0].field_name)
  {
    ret = spec[0].object;
    spec[0].object = NULL;
    return ret;
  }
  ret = json_object ();
  GNUNET_assert (NULL != ret);
  for (unsigned int i = 0;
       NULL != spec[i].field_name;
       i++)
  {
    if (NULL == spec[i].object)
    {
      if (! spec[i].allow_null)
      {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                    "NULL not allowed for `%s'\n",
                    spec[i].field_name);
        GNUNET_assert (0);
      }
    }
    else
    {
      GNUNET_assert (0 ==
                     json_object_set_new (ret,
                                          spec[i].field_name,
                                          spec[i].object));
      spec[i].object = NULL;
    }
  }
  return ret;
}

References GNUNET_JSON_PackSpec::field_name, GNUNET_assert, GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_JSON_PackSpec::object, and ret.

GNUNET_JSON_pack_end_()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_end_

(

void

)

Do not use directly.

Use GNUNET_JSON_PACK.

Returns

array terminator

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = NULL
  };
 
  return ps;
}

GNUNET_JSON_pack_allow_null()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_allow_null

(

struct GNUNET_JSON_PackSpec

in

)

Modify packer instruction to allow NULL as a value.

Parameters

in	json pack specification to modify

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  in.allow_null = true;
  return in;
}

GNUNET_JSON_pack_bool()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_bool	(	const char *	name,
		bool	b
	)

Generate packer instruction for a JSON field of type bool.

Parameters

name	name of the field to add to the object
b	boolean value

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = json_boolean (b)
  };
 
  return ps;
}

GNUNET_JSON_pack_string()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_string	(	const char *	name,
		const char *	s
	)

Generate packer instruction for a JSON field of type string.

Parameters

name	name of the field to add to the object
s	string value

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = json_string (s)
  };
 
  return ps;
}

GNUNET_JSON_pack_uint64()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_uint64	(	const char *	name,
		uint64_t	num
	)

Generate packer instruction for a JSON field of type unsigned integer.

Note that the maximum allowed value is still limited by JSON and not UINT64_MAX.

Parameters

name	name of the field to add to the object
num	numeric value

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = json_integer ((json_int_t) num)
  };
 
#if JSON_INTEGER_IS_LONG_LONG
  GNUNET_assert (num <= LLONG_MAX);
#else
  GNUNET_assert (num <= LONG_MAX);
#endif
  return ps;
}

GNUNET_JSON_pack_int64()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_int64	(	const char *	name,
		int64_t	num
	)

Generate packer instruction for a JSON field of type signed integer.

Parameters

name	name of the field to add to the object
num	numeric value

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = json_integer ((json_int_t) num)
  };
 
#if JSON_INTEGER_IS_LONG_LONG
  GNUNET_assert (num <= LLONG_MAX);
  GNUNET_assert (num >= LLONG_MIN);
#else
  GNUNET_assert (num <= LONG_MAX);
  GNUNET_assert (num >= LONG_MIN);
#endif
  return ps;
}

GNUNET_JSON_pack_object_steal()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_object_steal	(	const char *	name,
		json_t *	o
	)

Generate packer instruction for a JSON field of type JSON object where the reference is taken over by the packer.

Parameters

name	name of the field to add to the object
o	object to steal

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = o
  };
 
  if (NULL == o)
    return ps;
  if (! json_is_object (o))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Expected JSON object for field `%s'\n",
                name);
    GNUNET_assert (0);
  }
  return ps;
}

GNUNET_JSON_pack_object_incref()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_object_incref	(	const char *	name,
		json_t *	o
	)

Generate packer instruction for a JSON field of type JSON object where the reference counter is incremented by the packer.

Note that a deep copy is not performed.

Parameters

name	name of the field to add to the object
o	object to increment reference counter of

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = o
  };
 
  if (NULL == o)
    return ps;
  (void) json_incref (o);
  if (! json_is_object (o))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Expected JSON object for field `%s'\n",
                name);
    GNUNET_assert (0);
  }
  return ps;
}

GNUNET_JSON_pack_array_steal()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_array_steal	(	const char *	name,
		json_t *	a
	)

Generate packer instruction for a JSON field of type JSON array where the reference is taken over by the packer.

Parameters

name	name of the field to add to the object
a	array to steal

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = a
  };
 
  if (NULL == a)
    return ps;
  if (! json_is_array (a))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Expected JSON array for field `%s'\n",
                name);
    GNUNET_assert (0);
  }
  return ps;
}

GNUNET_JSON_pack_array_incref()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_array_incref	(	const char *	name,
		json_t *	a
	)

Generate packer instruction for a JSON field of type JSON array where the reference counter is incremented by the packer.

Note that a deep copy is not performed.

Parameters

name	name of the field to add to the object
a	array to increment reference counter of

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = a
  };
 
  if (NULL == a)
    return ps;
  (void) json_incref (a);
  if (! json_is_array (a))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Expected JSON array for field `%s'\n",
                name);
    GNUNET_assert (0);
  }
  return ps;
}

GNUNET_JSON_pack_data_varsize()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_data_varsize	(	const char *	name,
		const void *	blob,
		size_t	blob_size
	)

Generate packer instruction for a JSON field of type variable size binary blob.

Parameters

name	name of the field to add to the object
blob	binary data to pack
blob_size	number of bytes in blob

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = (NULL != blob)
    ? GNUNET_JSON_from_data (blob,
                             blob_size)
    : NULL
  };
 
  return ps;
}

GNUNET_JSON_pack_data64_varsize()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_data64_varsize	(	const char *	name,
		const void *	blob,
		size_t	blob_size
	)

Generate packer instruction for a JSON field of type variable size binary blob.

Use base64-encoding, instead of the more common Crockford base32-encoding.

Parameters

name	name of the field to add to the object
blob	binary data to pack
blob_size	number of bytes in blob

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = (NULL != blob)
    ? GNUNET_JSON_from_data64 (blob,
                               blob_size)
    : NULL
  };
 
  return ps;
}

GNUNET_JSON_pack_timestamp()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_timestamp	(	const char *	name,
		struct GNUNET_TIME_Timestamp	at
	)

Generate packer instruction for a JSON field of type timestamp.

Parameters

name	name of the field to add to the object
at	timestamp pack, a value of 0 is only allowed with GNUNET_JSON_pack_allow_null()!

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name
  };
 
  if (! GNUNET_TIME_absolute_is_zero (t.abs_time))
  {
    ps.object = GNUNET_JSON_from_timestamp (t);
    GNUNET_assert (NULL != ps.object);
  }
  else
  {
    ps.object = NULL;
  }
  return ps;
}

GNUNET_JSON_pack_timestamp_nbo()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_timestamp_nbo	(	const char *	name,
		struct GNUNET_TIME_TimestampNBO	at
	)

Generate packer instruction for a JSON field of type timestamp in network byte order.

Parameters

name	name of the field to add to the object
at	timestamp to pack, a value of 0 is only allowed with GNUNET_JSON_pack_allow_null()!

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  return GNUNET_JSON_pack_timestamp (name,
                                     GNUNET_TIME_timestamp_ntoh (at));
}

GNUNET_JSON_pack_time_rel()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_time_rel	(	const char *	name,
		struct GNUNET_TIME_Relative	rt
	)

Generate packer instruction for a JSON field of type relative time.

Parameters

name	name of the field to add to the object
rt	relative time to pack

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  json_t *json;
 
  json = GNUNET_JSON_from_time_rel (rt);
  GNUNET_assert (NULL != json);
  return GNUNET_JSON_pack_object_steal (name,
                                        json);
}

GNUNET_JSON_pack_time_rel_nbo()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_time_rel_nbo	(	const char *	name,
		struct GNUNET_TIME_RelativeNBO	rt
	)

Generate packer instruction for a JSON field of type relative time in network byte order.

Parameters

name	name of the field to add to the object
rt	relative time to pack

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  return GNUNET_JSON_pack_time_rel (name,
                                    GNUNET_TIME_relative_ntoh (rt));
}

GNUNET_JSON_pack_rsa_public_key()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_rsa_public_key	(	const char *	name,
		const struct GNUNET_CRYPTO_RsaPublicKey *	pk
	)

Generate packer instruction for a JSON field of type RSA public key.

Parameters

name	name of the field to add to the object
pk	RSA public key

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = GNUNET_JSON_from_rsa_public_key (pk)
  };
 
  return ps;
}

GNUNET_JSON_pack_rsa_signature()

struct GNUNET_JSON_PackSpec GNUNET_JSON_pack_rsa_signature	(	const char *	name,
		const struct GNUNET_CRYPTO_RsaSignature *	sig
	)

Generate packer instruction for a JSON field of type RSA signature.

Parameters

name	name of the field to add to the object
sig	RSA signature

Returns

json pack specification

Definition at line 30 of file json_pack.c.

{
  struct GNUNET_JSON_PackSpec ps = {
    .field_name = name,
    .object = GNUNET_JSON_from_rsa_signature (sig)
  };
 
  return ps;
}