plugin_gnsrecord_messenger.c File Reference

Plugin to provide the API for useful GNS records to improve the usability of the messenger service. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_gnsrecord_lib.h"
#include "gnunet_messenger_service.h"
#include "gnunet_gnsrecord_plugin.h"

Include dependency graph for plugin_gnsrecord_messenger.c:

Go to the source code of this file.

Functions
static char *	messenger_value_to_string (void *cls, uint32_t type, const void *data, size_t data_size)
	Convert the 'value' of a record to a string. More...
static int	messenger_string_to_value (void *cls, uint32_t type, const char *s, void **data, size_t *data_size)
	Convert human-readable version of a 'value' of a record to the binary representation. More...
static uint32_t	messenger_typename_to_number (void *cls, const char *gns_typename)
	Convert a type name (e.g. More...
static const char *	messenger_number_to_typename (void *cls, uint32_t type)
	Convert a type number to the corresponding type string (e.g. More...
void *	libgnunet_plugin_gnsrecord_messenger_init (void *cls)
	Entry point for the plugin. More...
void *	libgnunet_plugin_gnsrecord_messenger_done (void *cls)
	Exit point from the plugin. More...

Variables
struct {
const char *   name
uint32_t   number
}	name_map []
	Mapping of record type numbers to human-readable record type names. More...

Detailed Description

Plugin to provide the API for useful GNS records to improve the usability of the messenger service.

Author

Tobias Frisch

Definition in file plugin_gnsrecord_messenger.c.

Function Documentation

messenger_value_to_string()

static char* messenger_value_to_string ( void *  cls, uint32_t  type, const void *  data, size_t  data_size  )

static

Convert the 'value' of a record to a string.

Parameters

cls	closure, unused
type	type of the record
data	value in binary encoding
data_size	number of bytes in data

Returns

NULL on error, otherwise human-readable representation of the value

Definition at line 44 of file plugin_gnsrecord_messenger.c.

{
  (void) cls;
  switch (type)
  {
  case GNUNET_GNSRECORD_TYPE_MESSENGER_ROOM_ENTRY:
    {
      if (data_size != sizeof(struct GNUNET_MESSENGER_RoomEntryRecord))
      {
        GNUNET_break_op (0);
        return NULL;
      }
 
      const struct GNUNET_MESSENGER_RoomEntryRecord *record = data;
 
      char *door = GNUNET_CRYPTO_eddsa_public_key_to_string (&(record->door.public_key));
      char *key = GNUNET_STRINGS_data_to_string_alloc (&(record->key), sizeof(struct GNUNET_HashCode));
 
      char *ret;
      GNUNET_asprintf (&ret, "%s-%s", key, door);
      GNUNET_free (key);
      GNUNET_free (door);
      return ret;
    }
  case GNUNET_GNSRECORD_TYPE_MESSENGER_ROOM_DETAILS:
    {
      if (data_size != sizeof(struct GNUNET_MESSENGER_RoomDetailsRecord))
      {
        GNUNET_break_op (0);
        return NULL;
      }
 
      const struct GNUNET_MESSENGER_RoomDetailsRecord *record = data;
 
      char *name = GNUNET_strndup(record->name, 256);
      char *flags = GNUNET_STRINGS_data_to_string_alloc (&(record->flags), sizeof(uint32_t));
 
      char *ret;
      GNUNET_asprintf (&ret, "%s-%s", flags, name);
      GNUNET_free (flags);
      GNUNET_free (name);
      return ret;
    }
  default:
    return NULL;
  }
}

References data, data_size, GNUNET_MESSENGER_RoomEntryRecord::door, GNUNET_MESSENGER_RoomDetailsRecord::flags, GNUNET_asprintf(), GNUNET_break_op, GNUNET_CRYPTO_eddsa_public_key_to_string(), GNUNET_free, GNUNET_GNSRECORD_TYPE_MESSENGER_ROOM_DETAILS, GNUNET_GNSRECORD_TYPE_MESSENGER_ROOM_ENTRY, GNUNET_STRINGS_data_to_string_alloc(), GNUNET_strndup, key, name, record(), ret, and type.

Referenced by libgnunet_plugin_gnsrecord_messenger_init().

Here is the call graph for this function:

Here is the caller graph for this function:

messenger_string_to_value()

static int messenger_string_to_value ( void *  cls, uint32_t  type, const char *  s, void **  data, size_t *  data_size  )

static

Convert human-readable version of a 'value' of a record to the binary representation.

Parameters

cls	closure, unused
type	type of the record
s	human-readable string
data	set to value in binary encoding (will be allocated)
data_size	set to number of bytes in data

Returns

GNUNET_OK on success

Definition at line 108 of file plugin_gnsrecord_messenger.c.

{
  (void) cls;
  if (NULL == s)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
 
  switch (type)
  {
  case GNUNET_GNSRECORD_TYPE_MESSENGER_ROOM_ENTRY:
    {
      char key [103];
      const char *dash;
      struct GNUNET_PeerIdentity door;
 
      if ((NULL == (dash = strchr (s, '-'))) ||
          (1 != sscanf (s, "%103s-", key)) ||
          (GNUNET_OK != GNUNET_CRYPTO_eddsa_public_key_from_string (dash + 1,
                                                                    strlen (dash + 1),
                                                                    &(door.public_key))))
      {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                    _ ("Unable to parse MESSENGER_ROOM_ENTRY record `%s'\n"),
                    s);
        return GNUNET_SYSERR;
      }
 
      struct GNUNET_MESSENGER_RoomEntryRecord *record = GNUNET_new (
          struct GNUNET_MESSENGER_RoomEntryRecord
      );
 
      if (GNUNET_OK != GNUNET_STRINGS_string_to_data (key,
                                                      strlen (key),
                                                      &(record->key),
                                                      sizeof(struct GNUNET_HashCode)))
      {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                    _ ("Unable to parse MESSENGER_ROOM_ENTRY record `%s'\n"),
                    s);
        GNUNET_free (record);
        return GNUNET_SYSERR;
      }
 
      record->door = door;
      *data = record;
      *data_size = sizeof(struct GNUNET_MESSENGER_RoomEntryRecord);
      return GNUNET_OK;
    }
  case GNUNET_GNSRECORD_TYPE_MESSENGER_ROOM_DETAILS:
    {
      char flags [7];
      const char *dash;
 
      if ((NULL == (dash = strchr (s, '-'))) ||
          (1 != sscanf (s, "%7s-", flags)) ||
          (strlen (dash + 1) > 256))
      {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                    _ ("Unable to parse MESSENGER_ROOM_DETAILS record `%s'\n"),
                    s);
        return GNUNET_SYSERR;
      }
 
      struct GNUNET_MESSENGER_RoomDetailsRecord *record = GNUNET_new (
          struct GNUNET_MESSENGER_RoomDetailsRecord
      );
 
      if (GNUNET_OK != GNUNET_STRINGS_string_to_data (flags,
                                                      strlen (flags),
                                                      &(record->flags),
                                                      sizeof(uint32_t)))
      {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                    _ ("Unable to parse MESSENGER_ROOM_DETAILS record `%s'\n"),
                    s);
        GNUNET_free (record);
        return GNUNET_SYSERR;
      }
 
      GNUNET_memcpy(record->name, dash + 1, strlen(dash + 1));
 
      *data = record;
      *data_size = sizeof(struct GNUNET_MESSENGER_RoomDetailsRecord);
      return GNUNET_OK;
    }
  default:
    return GNUNET_SYSERR;
  }
}

References _, data, data_size, GNUNET_MESSENGER_RoomEntryRecord::door, GNUNET_MESSENGER_RoomDetailsRecord::flags, GNUNET_break, GNUNET_CRYPTO_eddsa_public_key_from_string(), GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_GNSRECORD_TYPE_MESSENGER_ROOM_DETAILS, GNUNET_GNSRECORD_TYPE_MESSENGER_ROOM_ENTRY, GNUNET_log, GNUNET_memcpy, GNUNET_new, GNUNET_OK, GNUNET_STRINGS_string_to_data(), GNUNET_SYSERR, key, GNUNET_PeerIdentity::public_key, record(), and type.

Referenced by libgnunet_plugin_gnsrecord_messenger_init().

Here is the call graph for this function:

Here is the caller graph for this function:

messenger_typename_to_number()

static uint32_t messenger_typename_to_number ( void *  cls, const char *  gns_typename  )

static

Convert a type name (e.g.

"AAAA") to the corresponding number.

Parameters

cls	closure, unused
gns_typename	name to convert

Returns

corresponding number, UINT32_MAX on error

Definition at line 228 of file plugin_gnsrecord_messenger.c.

{
  unsigned int i;
 
  (void) cls;
  i = 0;
  while ((name_map[i].name != NULL) &&
         (0 != strcasecmp (gns_typename, name_map[i].name)))
    i++;
  return name_map[i].number;
}

References name, and name_map.

Referenced by libgnunet_plugin_gnsrecord_messenger_init().

Here is the caller graph for this function:

messenger_number_to_typename()

static const char* messenger_number_to_typename ( void *  cls, uint32_t  type  )

static

Convert a type number to the corresponding type string (e.g.

1 to "A")

Parameters

cls	closure, unused
type	number of a type to convert

Returns

corresponding typestring, NULL on error

Definition at line 250 of file plugin_gnsrecord_messenger.c.

{
  unsigned int i;
 
  (void) cls;
  i = 0;
  while ((name_map[i].name != NULL) &&
         (type != name_map[i].number))
    i++;
  return name_map[i].name;
}

References name, name_map, and type.

Referenced by libgnunet_plugin_gnsrecord_messenger_init().

Here is the caller graph for this function:

libgnunet_plugin_gnsrecord_messenger_init()

void* libgnunet_plugin_gnsrecord_messenger_init

(

void *

cls

)

Entry point for the plugin.

Parameters

cls

NULL

Returns

the exported block API

Definition at line 271 of file plugin_gnsrecord_messenger.c.

{
  struct GNUNET_GNSRECORD_PluginFunctions *api;
 
  (void) cls;
  api = GNUNET_new (struct GNUNET_GNSRECORD_PluginFunctions);
  api->value_to_string = &messenger_value_to_string;
  api->string_to_value = &messenger_string_to_value;
  api->typename_to_number = &messenger_typename_to_number;
  api->number_to_typename = &messenger_number_to_typename;
  return api;
}

References GNUNET_GNSRECORD_PluginFunctions::cls, GNUNET_new, messenger_number_to_typename(), messenger_string_to_value(), messenger_typename_to_number(), messenger_value_to_string(), GNUNET_GNSRECORD_PluginFunctions::number_to_typename, GNUNET_GNSRECORD_PluginFunctions::string_to_value, GNUNET_GNSRECORD_PluginFunctions::typename_to_number, and GNUNET_GNSRECORD_PluginFunctions::value_to_string.

Here is the call graph for this function:

libgnunet_plugin_gnsrecord_messenger_done()

void* libgnunet_plugin_gnsrecord_messenger_done

(

void *

cls

)

Exit point from the plugin.

Parameters

cls	the return value from libgnunet_plugin_block_test_init

Returns

NULL

Definition at line 292 of file plugin_gnsrecord_messenger.c.

{
  struct GNUNET_GNSRECORD_PluginFunctions *api = cls;
 
  GNUNET_free (api);
  return NULL;
}

References GNUNET_GNSRECORD_PluginFunctions::cls, and GNUNET_free.

Variable Documentation

name

const char* name

Definition at line 211 of file plugin_gnsrecord_messenger.c.

Referenced by messenger_number_to_typename(), messenger_typename_to_number(), and messenger_value_to_string().

number

uint32_t number

Definition at line 212 of file plugin_gnsrecord_messenger.c.

struct { ... } name_map[]

Initial value:

= {
  { "MESSENGER_ROOM_ENTRY", GNUNET_GNSRECORD_TYPE_MESSENGER_ROOM_ENTRY },
  { "MESSENGER_ROOM_DETAILS", GNUNET_GNSRECORD_TYPE_MESSENGER_ROOM_DETAILS },
  { NULL, UINT32_MAX }
}

Mapping of record type numbers to human-readable record type names.

Referenced by messenger_number_to_typename(), and messenger_typename_to_number().