Storing of meta data. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_fs_service.h"

Include dependency graph for meta_data.c:

Data Structures
struct	MetaItem
	Meta data item. More...

struct	GNUNET_FS_MetaData
	Meta data to associate with a file, directory or namespace. More...

struct	MetaDataHeader
	Header for serialized meta data. More...

struct	MetaDataEntry
	Entry of serialized meta data. More...

Macros
#define	MAX_META_DATA (1024 * 1024)
	Maximum size allowed for meta data written/read from disk.

#define	LOG(kind, ...)

#define	HEADER_COMPRESSED 0x80000000
	Flag in 'version' that indicates compressed meta-data.

#define	HEADER_VERSION_MASK 0x7FFFFFFF
	Bits in 'version' that give the version number.

Functions
struct GNUNET_FS_MetaData *	GNUNET_FS_meta_data_create ()
	Create a fresh struct FS_MetaData token.

static void	meta_item_free (struct MetaItem *mi)
	Free meta data item.

static void	invalidate_sbuf (struct GNUNET_FS_MetaData *md)
	The meta data has changed, invalidate its serialization buffer.

void	GNUNET_FS_meta_data_destroy (struct GNUNET_FS_MetaData *md)
	Free meta data.

void	GNUNET_FS_meta_data_clear (struct GNUNET_FS_MetaData *md)
	Remove all items in the container.

int	GNUNET_FS_meta_data_test_equal (const struct GNUNET_FS_MetaData md1, const struct GNUNET_FS_MetaData md2)
	Test if two MDs are equal.

int	GNUNET_FS_meta_data_insert (struct GNUNET_FS_MetaData md, const char plugin_name, enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format, const char data_mime_type, const char data, size_t data_size)
	Extend metadata.

static int	merge_helper (void cls, const char plugin_name, enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format, const char data_mime_type, const char data, size_t data_size)
	Merge given meta data.

void	GNUNET_FS_meta_data_merge (struct GNUNET_FS_MetaData md, const struct GNUNET_FS_MetaData in)
	Extend metadata.

int	GNUNET_FS_meta_data_delete (struct GNUNET_FS_MetaData md, enum EXTRACTOR_MetaType type, const char data, size_t data_size)
	Remove an item.

void	GNUNET_FS_meta_data_add_publication_date (struct GNUNET_FS_MetaData *md)
	Add the current time as the publication date to the meta-data.

int	GNUNET_FS_meta_data_iterate (const struct GNUNET_FS_MetaData md, EXTRACTOR_MetaDataProcessor iter, void iter_cls)
	Iterate over MD entries.

char *	GNUNET_FS_meta_data_get_by_type (const struct GNUNET_FS_MetaData *md, enum EXTRACTOR_MetaType type)
	Get the first MD entry of the given type.

char *	GNUNET_FS_meta_data_get_first_by_types (const struct GNUNET_FS_MetaData *md,...)
	Get the first matching MD entry of the given types.

size_t	GNUNET_FS_meta_data_get_thumbnail (const struct GNUNET_FS_MetaData md, unsigned char *thumb)
	Get a thumbnail from the meta-data (if present).

struct GNUNET_FS_MetaData *	GNUNET_FS_meta_data_duplicate (const struct GNUNET_FS_MetaData *md)
	Duplicate a `struct GNUNET_FS_MetaData`.

ssize_t	GNUNET_FS_meta_data_serialize (const struct GNUNET_FS_MetaData md, char *target, size_t max, enum GNUNET_FS_MetaDataSerializationOptions opt)
	Serialize meta-data to target.

ssize_t	GNUNET_FS_meta_data_get_serialized_size (const struct GNUNET_FS_MetaData *md)
	Get the size of the full meta-data in serialized form.

struct GNUNET_FS_MetaData *	GNUNET_FS_meta_data_deserialize (const char *input, size_t size)
	Deserialize meta-data.

enum GNUNET_GenericReturnValue	GNUNET_FS_read_meta_data (struct GNUNET_BIO_ReadHandle h, const char what, struct GNUNET_FS_MetaData **result)
	Read a metadata container.

enum GNUNET_GenericReturnValue	GNUNET_FS_write_meta_data (struct GNUNET_BIO_WriteHandle h, const char what, const struct GNUNET_FS_MetaData *m)
	Write a metadata container.

static int	read_spec_handler_meta_data (void cls, struct GNUNET_BIO_ReadHandle h, const char what, void target, size_t target_size)
	Function used internally to read a metadata container from within a read spec.

struct GNUNET_BIO_ReadSpec	GNUNET_FS_read_spec_meta_data (const char what, struct GNUNET_FS_MetaData *result)
	Create the specification to read a metadata container.

static int	write_spec_handler_meta_data (void cls, struct GNUNET_BIO_WriteHandle h, const char what, void source, size_t source_size)
	Function used internally to write a metadata container from within a write spec.

struct GNUNET_BIO_WriteSpec	GNUNET_FS_write_spec_meta_data (const char what, const struct GNUNET_FS_MetaData m)
	Create the specification to write a metadata container.

Detailed Description

Storing of meta data.

Author: Christian Grothoff; Martin Schanzenbach

Definition in file meta_data.c.

Macro Definition Documentation

◆ MAX_META_DATA

#define MAX_META_DATA (1024 * 1024)

Maximum size allowed for meta data written/read from disk.

File-sharing limits to 64k, so this should be rather generous.

Definition at line 35 of file meta_data.c.

◆ LOG

#define LOG	(	kind,
		...
	)

Value:

GNUNET_log_from (kind, "fs-meta-data", \

__VA_ARGS__)

GNUNET_log_from

#define GNUNET_log_from(kind, comp,...)

Definition gnunet_common.h:522

Definition at line 38 of file meta_data.c.

{
  struct MetaItem *next;
 
  struct MetaItem *prev;
 
  char *plugin_name;
 
  char *mime_type;
 
  char *data;
 
  size_t data_size;
 
  enum EXTRACTOR_MetaType type;
 
  enum EXTRACTOR_MetaFormat format;
};
 
struct GNUNET_FS_MetaData
{
  struct MetaItem *items_head;
 
  struct MetaItem *items_tail;
 
  char *sbuf;
 
  size_t sbuf_size;
 
  unsigned int item_count;
};
 
 
struct GNUNET_FS_MetaData *
GNUNET_FS_meta_data_create ()
{
  return GNUNET_new (struct GNUNET_FS_MetaData);
}
 
 
static void
meta_item_free (struct MetaItem *mi)
{
  GNUNET_free (mi->plugin_name);
  GNUNET_free (mi->mime_type);
  GNUNET_free (mi->data);
  GNUNET_free (mi);
}
 
 
static void
invalidate_sbuf (struct GNUNET_FS_MetaData *md)
{
  if (NULL == md->sbuf)
    return;
  GNUNET_free (md->sbuf);
  md->sbuf = NULL;
  md->sbuf_size = 0;
}
 
 
void
GNUNET_FS_meta_data_destroy (struct GNUNET_FS_MetaData *md)
{
  struct MetaItem *pos;
 
  if (NULL == md)
    return;
  while (NULL != (pos = md->items_head))
  {
    GNUNET_CONTAINER_DLL_remove (md->items_head, md->items_tail, pos);
    meta_item_free (pos);
  }
  GNUNET_free (md->sbuf);
  GNUNET_free (md);
}
 
 
void
GNUNET_FS_meta_data_clear (struct GNUNET_FS_MetaData *md)
{
  struct MetaItem *mi;
 
  if (NULL == md)
    return;
  while (NULL != (mi = md->items_head))
  {
    GNUNET_CONTAINER_DLL_remove (md->items_head, md->items_tail, mi);
    meta_item_free (mi);
  }
  GNUNET_free (md->sbuf);
  memset (md, 0, sizeof(struct GNUNET_FS_MetaData));
}
 
 
int
GNUNET_FS_meta_data_test_equal (const struct GNUNET_FS_MetaData
                                *md1,
                                const struct GNUNET_FS_MetaData
                                *md2)
{
  struct MetaItem *i;
  struct MetaItem *j;
  int found;
 
  if (md1 == md2)
    return GNUNET_YES;
  if (md1->item_count != md2->item_count)
    return GNUNET_NO;
  for (i = md1->items_head; NULL != i; i = i->next)
  {
    found = GNUNET_NO;
    for (j = md2->items_head; NULL != j; j = j->next)
    {
      if ((i->type == j->type) && (i->format == j->format) &&
          (i->data_size == j->data_size) &&
          (0 == memcmp (i->data, j->data, i->data_size)))
      {
        found = GNUNET_YES;
        break;
      }
      if (j->data_size < i->data_size)
        break;     /* elements are sorted by (decreasing) size... */
    }
    if (GNUNET_NO == found)
      return GNUNET_NO;
  }
  return GNUNET_YES;
}
 
 
int
GNUNET_FS_meta_data_insert (struct GNUNET_FS_MetaData *md,
                            const char *plugin_name,
                            enum EXTRACTOR_MetaType type,
                            enum EXTRACTOR_MetaFormat format,
                            const char *data_mime_type, const char *data,
                            size_t data_size)
{
  struct MetaItem *pos;
  struct MetaItem *mi;
  char *p;
 
  if ((EXTRACTOR_METAFORMAT_UTF8 == format) ||
      (EXTRACTOR_METAFORMAT_C_STRING == format))
    GNUNET_break ('\0' == data[data_size - 1]);
 
  for (pos = md->items_head; NULL != pos; pos = pos->next)
  {
    if (pos->data_size < data_size)
      break;   /* elements are sorted by size in the list */
    if ((pos->type == type) && (pos->data_size == data_size) &&
        (0 == memcmp (pos->data, data, data_size)))
    {
      if ((NULL == pos->mime_type) && (NULL != data_mime_type))
      {
        pos->mime_type = GNUNET_strdup (data_mime_type);
        invalidate_sbuf (md);
      }
      if ((EXTRACTOR_METAFORMAT_C_STRING == pos->format) &&
          (EXTRACTOR_METAFORMAT_UTF8 == format))
      {
        pos->format = EXTRACTOR_METAFORMAT_UTF8;
        invalidate_sbuf (md);
      }
      return GNUNET_SYSERR;
    }
  }
  md->item_count++;
  mi = GNUNET_new (struct MetaItem);
  mi->type = type;
  mi->format = format;
  mi->data_size = data_size;
  if (NULL == pos)
    GNUNET_CONTAINER_DLL_insert_tail (md->items_head,
                                      md->items_tail,
                                      mi);
  else
    GNUNET_CONTAINER_DLL_insert_after (md->items_head,
                                       md->items_tail,
                                       pos->prev,
                                       mi);
  mi->mime_type =
    (NULL == data_mime_type) ? NULL : GNUNET_strdup (data_mime_type);
  mi->plugin_name = (NULL == plugin_name) ? NULL : GNUNET_strdup (plugin_name);
  mi->data = GNUNET_malloc (data_size);
  GNUNET_memcpy (mi->data, data, data_size);
  /* change all dir separators to POSIX style ('/') */
  if ((EXTRACTOR_METATYPE_FILENAME == type) ||
      (EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME == type))
  {
    p = mi->data;
    while (('\0' != *p) && (p < mi->data + data_size))
    {
      if ('\\' == *p)
        *p = '/';
      p++;
    }
  }
  invalidate_sbuf (md);
  return GNUNET_OK;
}
 
 
static int
merge_helper (void *cls, const char *plugin_name, enum EXTRACTOR_MetaType type,
              enum EXTRACTOR_MetaFormat format, const char *data_mime_type,
              const char *data, size_t data_size)
{
  struct GNUNET_FS_MetaData *md = cls;
 
  (void) GNUNET_FS_meta_data_insert (md, plugin_name, type, format,
                                     data_mime_type, data, data_size);
  return 0;
}
 
 
void
GNUNET_FS_meta_data_merge (struct GNUNET_FS_MetaData *md,
                           const struct GNUNET_FS_MetaData *in)
{
  GNUNET_FS_meta_data_iterate (in, &merge_helper, md);
}
 
 
int
GNUNET_FS_meta_data_delete (struct GNUNET_FS_MetaData *md,
                            enum EXTRACTOR_MetaType type,
                            const char *data, size_t data_size)
{
  struct MetaItem *pos;
 
  for (pos = md->items_head; NULL != pos; pos = pos->next)
  {
    if (pos->data_size < data_size)
      break;   /* items are sorted by (decreasing) size */
    if ((pos->type == type) &&
        ((NULL == data) ||
         ((pos->data_size == data_size) &&
          (0 == memcmp (pos->data, data, data_size)))))
    {
      GNUNET_CONTAINER_DLL_remove (md->items_head, md->items_tail, pos);
      meta_item_free (pos);
      md->item_count--;
      invalidate_sbuf (md);
      return GNUNET_OK;
    }
  }
  return GNUNET_SYSERR;
}
 
 
void
GNUNET_FS_meta_data_add_publication_date (struct
                                          GNUNET_FS_MetaData *md)
{
  const char *dat;
  struct GNUNET_TIME_Absolute t;
 
  t = GNUNET_TIME_absolute_get ();
  GNUNET_FS_meta_data_delete (md,
                              EXTRACTOR_METATYPE_PUBLICATION_DATE,
                              NULL, 0);
  dat = GNUNET_STRINGS_absolute_time_to_string (t);
  GNUNET_FS_meta_data_insert (md, "<gnunet>",
                              EXTRACTOR_METATYPE_PUBLICATION_DATE,
                              EXTRACTOR_METAFORMAT_UTF8, "text/plain",
                              dat, strlen (dat) + 1);
}
 
 
int
GNUNET_FS_meta_data_iterate (const struct GNUNET_FS_MetaData *md,
                             EXTRACTOR_MetaDataProcessor iter,
                             void *iter_cls)
{
  struct MetaItem *pos;
 
  if (NULL == md)
    return 0;
  if (NULL == iter)
    return md->item_count;
  for (pos = md->items_head; NULL != pos; pos = pos->next)
    if (0 !=
        iter (iter_cls, pos->plugin_name, pos->type, pos->format,
              pos->mime_type, pos->data, pos->data_size))
      return md->item_count;
  return md->item_count;
}
 
 
char *
GNUNET_FS_meta_data_get_by_type (const struct
                                 GNUNET_FS_MetaData *md,
                                 enum EXTRACTOR_MetaType type)
{
  struct MetaItem *pos;
 
  if (NULL == md)
    return NULL;
  for (pos = md->items_head; NULL != pos; pos = pos->next)
    if ((type == pos->type) &&
        ((pos->format == EXTRACTOR_METAFORMAT_UTF8) ||
         (pos->format == EXTRACTOR_METAFORMAT_C_STRING)))
      return GNUNET_strdup (pos->data);
  return NULL;
}
 
 
char *
GNUNET_FS_meta_data_get_first_by_types (const struct
                                        GNUNET_FS_MetaData *md,
                                        ...)
{
  char *ret;
  va_list args;
  int type;
 
  if (NULL == md)
    return NULL;
  ret = NULL;
  va_start (args, md);
  while (1)
  {
    type = va_arg (args, int);
    if (-1 == type)
      break;
    if (NULL != (ret = GNUNET_FS_meta_data_get_by_type (md, type)))
      break;
  }
  va_end (args);
  return ret;
}
 
 
size_t
GNUNET_FS_meta_data_get_thumbnail (const struct GNUNET_FS_MetaData
                                   *md, unsigned char **thumb)
{
  struct MetaItem *pos;
  struct MetaItem *match;
 
  if (NULL == md)
    return 0;
  match = NULL;
  for (pos = md->items_head; NULL != pos; pos = pos->next)
  {
    if ((NULL != pos->mime_type) &&
        (0 == strncasecmp ("image/", pos->mime_type, strlen ("image/"))) &&
        (EXTRACTOR_METAFORMAT_BINARY == pos->format))
    {
      if (NULL == match)
        match = pos;
      else if ((match->type != EXTRACTOR_METATYPE_THUMBNAIL) &&
               (pos->type == EXTRACTOR_METATYPE_THUMBNAIL))
        match = pos;
    }
  }
  if ((NULL == match) || (0 == match->data_size))
    return 0;
  *thumb = GNUNET_malloc (match->data_size);
  GNUNET_memcpy (*thumb, match->data, match->data_size);
  return match->data_size;
}
 
 
struct GNUNET_FS_MetaData *
GNUNET_FS_meta_data_duplicate (const struct GNUNET_FS_MetaData
                               *md)
{
  struct GNUNET_FS_MetaData *ret;
  struct MetaItem *pos;
 
  if (NULL == md)
    return NULL;
  ret = GNUNET_FS_meta_data_create ();
  for (pos = md->items_tail; NULL != pos; pos = pos->prev)
    GNUNET_FS_meta_data_insert (ret, pos->plugin_name, pos->type,
                                pos->format, pos->mime_type, pos->data,
                                pos->data_size);
  return ret;
}
 
 
#define HEADER_COMPRESSED 0x80000000
 
 
#define HEADER_VERSION_MASK 0x7FFFFFFF
 
 
struct MetaDataHeader
{
  uint32_t version;
 
  uint32_t entries;
 
  uint32_t size;
 
};
 
 
struct MetaDataEntry
{
  uint32_t type;
 
  uint32_t format;
 
  uint32_t data_size;
 
  uint32_t plugin_name_len;
 
  uint32_t mime_type_len;
};
 
 
ssize_t
GNUNET_FS_meta_data_serialize (const struct GNUNET_FS_MetaData
                               *md, char **target, size_t max,
                               enum
                               GNUNET_FS_MetaDataSerializationOptions
                               opt)
{
  struct GNUNET_FS_MetaData *vmd;
  struct MetaItem *pos;
  struct MetaDataHeader ihdr;
  struct MetaDataHeader *hdr;
  struct MetaDataEntry *ent;
  char *dst;
  unsigned int i;
  uint64_t msize;
  size_t off;
  char *mdata;
  char *cdata;
  size_t mlen;
  size_t plen;
  size_t size;
  size_t left;
  size_t clen;
  size_t rlen;
  int comp;
 
  if (max < sizeof(struct MetaDataHeader))
    return GNUNET_SYSERR;       /* far too small */
  if (NULL == md)
    return 0;
 
  if (NULL != md->sbuf)
  {
    /* try to use serialization cache */
    if (md->sbuf_size <= max)
    {
      if (NULL == *target)
        *target = GNUNET_malloc (md->sbuf_size);
      GNUNET_memcpy (*target, md->sbuf, md->sbuf_size);
      return md->sbuf_size;
    }
    if (0 == (opt & GNUNET_FS_META_DATA_SERIALIZE_PART))
      return GNUNET_SYSERR;     /* can say that this will fail */
    /* need to compute a partial serialization, sbuf useless ... */
  }
  dst = NULL;
  msize = 0;
  for (pos = md->items_tail; NULL != pos; pos = pos->prev)
  {
    msize += sizeof(struct MetaDataEntry);
    msize += pos->data_size;
    if (NULL != pos->plugin_name)
      msize += strlen (pos->plugin_name) + 1;
    if (NULL != pos->mime_type)
      msize += strlen (pos->mime_type) + 1;
  }
  size = (size_t) msize;
  if (size != msize)
  {
    GNUNET_break (0);           /* integer overflow */
    return GNUNET_SYSERR;
  }
  if (size >= GNUNET_MAX_MALLOC_CHECKED)
  {
    /* too large to be processed */
    return GNUNET_SYSERR;
  }
  ent = GNUNET_malloc (size);
  mdata = (char *) &ent[md->item_count];
  off = size - (md->item_count * sizeof(struct MetaDataEntry));
  i = 0;
  for (pos = md->items_head; NULL != pos; pos = pos->next)
  {
    ent[i].type = htonl ((uint32_t) pos->type);
    ent[i].format = htonl ((uint32_t) pos->format);
    ent[i].data_size = htonl ((uint32_t) pos->data_size);
    if (NULL == pos->plugin_name)
      plen = 0;
    else
      plen = strlen (pos->plugin_name) + 1;
    ent[i].plugin_name_len = htonl ((uint32_t) plen);
    if (NULL == pos->mime_type)
      mlen = 0;
    else
      mlen = strlen (pos->mime_type) + 1;
    ent[i].mime_type_len = htonl ((uint32_t) mlen);
    off -= pos->data_size;
    if ((EXTRACTOR_METAFORMAT_UTF8 == pos->format) ||
        (EXTRACTOR_METAFORMAT_C_STRING == pos->format))
      GNUNET_break ('\0' == pos->data[pos->data_size - 1]);
    GNUNET_memcpy (&mdata[off], pos->data, pos->data_size);
    off -= plen;
    if (NULL != pos->plugin_name)
      GNUNET_memcpy (&mdata[off], pos->plugin_name, plen);
    off -= mlen;
    if (NULL != pos->mime_type)
      GNUNET_memcpy (&mdata[off], pos->mime_type, mlen);
    i++;
  }
  GNUNET_assert (0 == off);
 
  clen = 0;
  cdata = NULL;
  left = size;
  i = 0;
  for (pos = md->items_head; NULL != pos; pos = pos->next)
  {
    comp = GNUNET_NO;
    if (0 == (opt & GNUNET_FS_META_DATA_SERIALIZE_NO_COMPRESS))
      comp = GNUNET_try_compression ((const char *) &ent[i],
                                     left,
                                     &cdata,
                                     &clen);
 
    if ((NULL == md->sbuf) && (0 == i))
    {
      /* fill 'sbuf'; this "modifies" md, but since this is only
       * an internal cache we will cast away the 'const' instead
       * of making the API look strange. */
      vmd = (struct GNUNET_FS_MetaData *) md;
      hdr = GNUNET_malloc (left + sizeof(struct MetaDataHeader));
      hdr->size = htonl (left);
      hdr->entries = htonl (md->item_count);
      if (GNUNET_YES == comp)
      {
        GNUNET_assert (clen < left);
        hdr->version = htonl (2 | HEADER_COMPRESSED);
        GNUNET_memcpy (&hdr[1], cdata, clen);
        vmd->sbuf_size = clen + sizeof(struct MetaDataHeader);
      }
      else
      {
        hdr->version = htonl (2);
        GNUNET_memcpy (&hdr[1], &ent[0], left);
        vmd->sbuf_size = left + sizeof(struct MetaDataHeader);
      }
      vmd->sbuf = (char *) hdr;
    }
 
    if (((left + sizeof(struct MetaDataHeader)) <= max) ||
        ((GNUNET_YES == comp) && (clen <= max)))
    {
      /* success, this now fits! */
      if (GNUNET_YES == comp)
      {
        if (NULL == dst)
          dst = GNUNET_malloc (clen + sizeof(struct MetaDataHeader));
        hdr = (struct MetaDataHeader *) dst;
        hdr->version = htonl (2 | HEADER_COMPRESSED);
        hdr->size = htonl (left);
        hdr->entries = htonl (md->item_count - i);
        GNUNET_memcpy (&dst[sizeof(struct MetaDataHeader)], cdata, clen);
        GNUNET_free (cdata);
        cdata = NULL;
        GNUNET_free (ent);
        rlen = clen + sizeof(struct MetaDataHeader);
      }
      else
      {
        if (NULL == dst)
          dst = GNUNET_malloc (left + sizeof(struct MetaDataHeader));
        hdr = (struct MetaDataHeader *) dst;
        hdr->version = htonl (2);
        hdr->entries = htonl (md->item_count - i);
        hdr->size = htonl (left);
        GNUNET_memcpy (&dst[sizeof(struct MetaDataHeader)], &ent[i], left);
        GNUNET_free (ent);
        rlen = left + sizeof(struct MetaDataHeader);
      }
      if (NULL != *target)
      {
        if (GNUNET_YES == comp)
          GNUNET_memcpy (*target, dst, clen + sizeof(struct MetaDataHeader));
        else
          GNUNET_memcpy (*target, dst, left + sizeof(struct MetaDataHeader));
        GNUNET_free (dst);
      }
      else
      {
        *target = dst;
      }
      return rlen;
    }
 
    if (0 == (opt & GNUNET_FS_META_DATA_SERIALIZE_PART))
    {
      /* does not fit! */
      GNUNET_free (ent);
      if (NULL != cdata)
        GNUNET_free (cdata);
      cdata = NULL;
      return GNUNET_SYSERR;
    }
 
    /* next iteration: ignore the corresponding meta data at the
     * end and try again without it */
    left -= sizeof(struct MetaDataEntry);
    left -= pos->data_size;
    if (NULL != pos->plugin_name)
      left -= strlen (pos->plugin_name) + 1;
    if (NULL != pos->mime_type)
      left -= strlen (pos->mime_type) + 1;
 
    if (NULL != cdata)
      GNUNET_free (cdata);
    cdata = NULL;
    i++;
  }
  GNUNET_free (ent);
 
  /* nothing fit, only write header! */
  ihdr.version = htonl (2);
  ihdr.entries = htonl (0);
  ihdr.size = htonl (0);
  if (NULL == *target)
    *target = (char *) GNUNET_new (struct MetaDataHeader);
  GNUNET_memcpy (*target, &ihdr, sizeof(struct MetaDataHeader));
  return sizeof(struct MetaDataHeader);
}
 
 
ssize_t
GNUNET_FS_meta_data_get_serialized_size (const struct
                                         GNUNET_FS_MetaData *md)
{
  ssize_t ret;
  char *ptr;
 
  if (NULL != md->sbuf)
    return md->sbuf_size;
  ptr = NULL;
  ret =
    GNUNET_FS_meta_data_serialize (md, &ptr, GNUNET_MAX_MALLOC_CHECKED,
                                   GNUNET_FS_META_DATA_SERIALIZE_FULL);
  if (-1 != ret)
    GNUNET_free (ptr);
  return ret;
}
 
 
struct GNUNET_FS_MetaData *
GNUNET_FS_meta_data_deserialize (const char *input, size_t size)
{
  struct GNUNET_FS_MetaData *md;
  struct MetaDataHeader hdr;
  struct MetaDataEntry ent;
  uint32_t ic;
  uint32_t i;
  char *data;
  const char *cdata;
  uint32_t version;
  uint32_t dataSize;
  int compressed;
  size_t left;
  uint32_t mlen;
  uint32_t plen;
  uint32_t dlen;
  const char *mdata;
  const char *meta_data;
  const char *plugin_name;
  const char *mime_type;
  enum EXTRACTOR_MetaFormat format;
 
  if (size < sizeof(struct MetaDataHeader))
    return NULL;
  GNUNET_memcpy (&hdr, input, sizeof(struct MetaDataHeader));
  version = ntohl (hdr.version) & HEADER_VERSION_MASK;
  compressed = (ntohl (hdr.version) & HEADER_COMPRESSED) != 0;
 
  if (1 == version)
    return NULL;                /* null pointer */
  if (2 != version)
  {
    GNUNET_break_op (0);        /* unsupported version */
    return NULL;
  }
 
  ic = ntohl (hdr.entries);
  dataSize = ntohl (hdr.size);
  if (((sizeof(struct MetaDataEntry) * ic) > dataSize) ||
      ((0 != ic) &&
       (dataSize / ic < sizeof(struct MetaDataEntry))))
  {
    GNUNET_break_op (0);
    return NULL;
  }
 
  if (compressed)
  {
    if (dataSize >= GNUNET_MAX_MALLOC_CHECKED)
    {
      /* make sure we don't blow our memory limit because of a mal-formed
       * message... */
      GNUNET_break_op (0);
      return NULL;
    }
    data =
      GNUNET_decompress ((const char *) &input[sizeof(struct MetaDataHeader)],
                         size - sizeof(struct MetaDataHeader),
                         dataSize);
    if (NULL == data)
    {
      GNUNET_break_op (0);
      return NULL;
    }
    cdata = data;
  }
  else
  {
    data = NULL;
    cdata = (const char *) &input[sizeof(struct MetaDataHeader)];
    if (dataSize != size - sizeof(struct MetaDataHeader))
    {
      GNUNET_break_op (0);
      return NULL;
    }
  }
 
  md = GNUNET_FS_meta_data_create ();
  left = dataSize - ic * sizeof(struct MetaDataEntry);
  mdata = &cdata[ic * sizeof(struct MetaDataEntry)];
  for (i = 0; i < ic; i++)
  {
    GNUNET_memcpy (&ent, &cdata[i * sizeof(struct MetaDataEntry)],
                   sizeof(struct MetaDataEntry));
    format = ntohl (ent.format);
    if ((EXTRACTOR_METAFORMAT_UTF8 != format) &&
        (EXTRACTOR_METAFORMAT_C_STRING != format) &&
        (EXTRACTOR_METAFORMAT_BINARY != format))
    {
      GNUNET_break_op (0);
      break;
    }
    dlen = ntohl (ent.data_size);
    plen = ntohl (ent.plugin_name_len);
    mlen = ntohl (ent.mime_type_len);
    if (dlen > left)
    {
      GNUNET_break_op (0);
      break;
    }
    left -= dlen;
    meta_data = &mdata[left];
    if ((EXTRACTOR_METAFORMAT_UTF8 == format) ||
        (EXTRACTOR_METAFORMAT_C_STRING == format))
    {
      if (0 == dlen)
      {
        GNUNET_break_op (0);
        break;
      }
      if ('\0' != meta_data[dlen - 1])
      {
        GNUNET_break_op (0);
        break;
      }
    }
    if (plen > left)
    {
      GNUNET_break_op (0);
      break;
    }
    left -= plen;
    if ((plen > 0) && ('\0' != mdata[left + plen - 1]))
    {
      GNUNET_break_op (0);
      break;
    }
    if (0 == plen)
      plugin_name = NULL;
    else
      plugin_name = &mdata[left];
 
    if (mlen > left)
    {
      GNUNET_break_op (0);
      break;
    }
    left -= mlen;
    if ((mlen > 0) && ('\0' != mdata[left + mlen - 1]))
    {
      GNUNET_break_op (0);
      break;
    }
    if (0 == mlen)
      mime_type = NULL;
    else
      mime_type = &mdata[left];
    GNUNET_FS_meta_data_insert (md, plugin_name,
                                ntohl (ent.type), format,
                                mime_type,
                                meta_data, dlen);
  }
  GNUNET_free (data);
  return md;
}
 
 
enum GNUNET_GenericReturnValue
GNUNET_FS_read_meta_data (struct GNUNET_BIO_ReadHandle *h,
                          const char *what,
                          struct GNUNET_FS_MetaData **result)
{
  uint32_t size;
  char *buf;
  char *emsg;
  struct GNUNET_FS_MetaData *meta;
 
  if (GNUNET_OK != GNUNET_BIO_read_int32 (h,
                                          _ ("metadata length"),
                                          (int32_t *) &size))
    return GNUNET_SYSERR;
  if (0 == size)
  {
    *result = NULL;
    return GNUNET_OK;
  }
  if (MAX_META_DATA < size)
  {
    GNUNET_asprintf (&emsg,
                     _ (
                       "Serialized metadata `%s' larger than allowed (%u > %u)\n"),
                     what,
                     size,
                     MAX_META_DATA);
    GNUNET_BIO_read_set_error (h, emsg);
    GNUNET_free (emsg);
    return GNUNET_SYSERR;
  }
  buf = GNUNET_malloc (size);
  if (GNUNET_OK != GNUNET_BIO_read (h, what, buf, size))
  {
    GNUNET_free (buf);
    return GNUNET_SYSERR;
  }
  meta = GNUNET_FS_meta_data_deserialize (buf, size);
  if (NULL == meta)
  {
    GNUNET_free (buf);
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _ ("Failed to deserialize metadata `%s'"), what);
    return GNUNET_SYSERR;
  }
  GNUNET_free (buf);
  *result = meta;
  return GNUNET_OK;
}
 
 
enum GNUNET_GenericReturnValue
GNUNET_FS_write_meta_data (struct GNUNET_BIO_WriteHandle *h,
                           const char *what,
                           const struct GNUNET_FS_MetaData *m)
{
  ssize_t size;
  char *buf;
 
  if (m == NULL)
    return GNUNET_BIO_write_int32 (h, _ ("metadata length"), 0);
  buf = NULL;
  size = GNUNET_FS_meta_data_serialize (m,
                                        &buf,
                                        MAX_META_DATA,
                                        GNUNET_FS_META_DATA_SERIALIZE_PART);
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "Serialized %lld bytes of metadata",
              (long long) size);
 
  if (-1 == size)
  {
    GNUNET_free (buf);
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Failed to serialize metadata `%s'",
                what);
    return GNUNET_SYSERR;
  }
  if ( (GNUNET_OK !=
        GNUNET_BIO_write_int32 (h,
                                "metadata length",
                                (uint32_t) size)) ||
       (GNUNET_OK !=
        GNUNET_BIO_write (h,
                          what,
                          buf,
                          size)) )
  {
    GNUNET_free (buf);
    return GNUNET_SYSERR;
  }
  GNUNET_free (buf);
  return GNUNET_OK;
}
 
 
static int
read_spec_handler_meta_data (void *cls,
                             struct GNUNET_BIO_ReadHandle *h,
                             const char *what,
                             void *target,
                             size_t target_size)
{
  struct GNUNET_FS_MetaData **result = target;
  return GNUNET_FS_read_meta_data (h, what, result);
}
 
 
struct GNUNET_BIO_ReadSpec
GNUNET_FS_read_spec_meta_data (const char *what,
                               struct GNUNET_FS_MetaData **result)
{
  struct GNUNET_BIO_ReadSpec rs = {
    .rh = &read_spec_handler_meta_data,
    .cls = NULL,
    .target = result,
    .size = 0,
  };
 
  return rs;
}
 
 
static int
write_spec_handler_meta_data (void *cls,
                              struct GNUNET_BIO_WriteHandle *h,
                              const char *what,
                              void *source,
                              size_t source_size)
{
  const struct GNUNET_FS_MetaData *m = source;
  return GNUNET_FS_write_meta_data (h, what, m);
}
 
 
struct GNUNET_BIO_WriteSpec
GNUNET_FS_write_spec_meta_data (const char *what,
                                const struct GNUNET_FS_MetaData *m)
{
  struct GNUNET_BIO_WriteSpec ws = {
    .wh = &write_spec_handler_meta_data,
    .cls = NULL,
    .what = what,
    .source = (void *) m,
    .source_size = 0,
  };
 
  return ws;
}
 
 
/* end of meta_data.c */

◆ HEADER_COMPRESSED

#define HEADER_COMPRESSED 0x80000000

Flag in 'version' that indicates compressed meta-data.

Definition at line 547 of file meta_data.c.

◆ HEADER_VERSION_MASK

#define HEADER_VERSION_MASK 0x7FFFFFFF

Bits in 'version' that give the version number.

Definition at line 553 of file meta_data.c.

Function Documentation

◆ meta_item_free()

static void meta_item_free ( struct MetaItem * mi )

static

Free meta data item.

Parameters

mi	item to free

Definition at line 139 of file meta_data.c.

{
  GNUNET_free (mi->plugin_name);
  GNUNET_free (mi->mime_type);
  GNUNET_free (mi->data);
  GNUNET_free (mi);
}

References MetaItem::data, GNUNET_free, MetaItem::mime_type, and MetaItem::plugin_name.

Referenced by GNUNET_FS_meta_data_clear(), GNUNET_FS_meta_data_delete(), and GNUNET_FS_meta_data_destroy().

Here is the caller graph for this function:

◆ invalidate_sbuf()

static void invalidate_sbuf ( struct GNUNET_FS_MetaData * md )

static

The meta data has changed, invalidate its serialization buffer.

Parameters

md	meta data that changed

Definition at line 155 of file meta_data.c.

{
  if (NULL == md->sbuf)
    return;
  GNUNET_free (md->sbuf);
  md->sbuf = NULL;
  md->sbuf_size = 0;
}

References GNUNET_free, GNUNET_FS_MetaData::sbuf, and GNUNET_FS_MetaData::sbuf_size.

Referenced by GNUNET_FS_meta_data_delete(), and GNUNET_FS_meta_data_insert().

Here is the caller graph for this function:

◆ merge_helper()

static int merge_helper	(	void *	cls,
		const char *	plugin_name,
		enum EXTRACTOR_MetaType	type,
		enum EXTRACTOR_MetaFormat	format,
		const char *	data_mime_type,
		const char *	data,
		size_t	data_size
	)

static

Merge given meta data.

Parameters

cls	the `struct GNUNET_FS_MetaData` to merge into
plugin_name	name of the plugin that produced this value; special values can be used (e.g. '<zlib>' for zlib being used in the main libextractor library and yielding meta data).
type	libextractor-type describing the meta data
format	basic format information about data
data_mime_type	mime-type of data (not of the original file); can be NULL (if mime-type is not known)
data	actual meta-data found
data_size	number of bytes in data

Returns: 0 (to continue)

Definition at line 343 of file meta_data.c.

{
  struct GNUNET_FS_MetaData *md = cls;
 
  (void) GNUNET_FS_meta_data_insert (md, plugin_name, type, format,
                                     data_mime_type, data, data_size);
  return 0;
}

References data, data_size, GNUNET_FS_meta_data_insert(), plugin_name, and type.

Referenced by GNUNET_FS_meta_data_merge().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read_spec_handler_meta_data()

static int read_spec_handler_meta_data	(	void *	cls,
		struct GNUNET_BIO_ReadHandle *	h,
		const char *	what,
		void *	target,
		size_t	target_size
	)

static

Function used internally to read a metadata container from within a read spec.

Parameters

cls	ignored, always NULL
h	the IO handle to read from
what	what is being read (for error message creation)
target	where to store the data
target_size	ignored

Returns: GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 1166 of file meta_data.c.

{
  struct GNUNET_FS_MetaData **result = target;
  return GNUNET_FS_read_meta_data (h, what, result);
}

References GNUNET_FS_read_meta_data(), h, and result.

Referenced by GNUNET_FS_read_spec_meta_data().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write_spec_handler_meta_data()

static int write_spec_handler_meta_data	(	void *	cls,
		struct GNUNET_BIO_WriteHandle *	h,
		const char *	what,
		void *	source,
		size_t	source_size
	)

static

Function used internally to write a metadata container from within a write spec.

Parameters

cls	ignored, always NULL
h	the IO handle to write to
what	what is being written (for error message creation)
source	the data to write
source_size	ignored

Returns: GNUNET_OK on success, GNUNET_SYSERR otherwise

Definition at line 1211 of file meta_data.c.

{
  const struct GNUNET_FS_MetaData *m = source;
  return GNUNET_FS_write_meta_data (h, what, m);
}

References GNUNET_FS_write_meta_data(), h, m, and source.

Referenced by GNUNET_FS_write_spec_meta_data().

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ MAX_META_DATA

◆ LOG

◆ HEADER_COMPRESSED

◆ HEADER_VERSION_MASK

Function Documentation

◆ meta_item_free()

◆ invalidate_sbuf()

◆ merge_helper()

◆ read_spec_handler_meta_data()

◆ write_spec_handler_meta_data()