Friends library

Library to read and write the FRIENDS file. More...

Typedefs
typedef void(*	GNUNET_FRIENDS_Callback) (void *cls, const struct GNUNET_PeerIdentity *friend_id)
	Signature of a function called on each friend found. More...

Functions
int	GNUNET_FRIENDS_parse (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_FRIENDS_Callback cb, void *cb_cls)
	Parse the FRIENDS file. More...
struct GNUNET_FRIENDS_Writer *	GNUNET_FRIENDS_write_start (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Start writing a fresh FRIENDS file. More...
int	GNUNET_FRIENDS_write_stop (struct GNUNET_FRIENDS_Writer *w)
	Finish writing out the friends file. More...
int	GNUNET_FRIENDS_write (struct GNUNET_FRIENDS_Writer *w, const struct GNUNET_PeerIdentity *friend_id)
	Add a friend to the friends file. More...

Detailed Description

Library to read and write the FRIENDS file.

Typedef Documentation

GNUNET_FRIENDS_Callback

typedef void(* GNUNET_FRIENDS_Callback) (void *cls, const struct GNUNET_PeerIdentity *friend_id)

Signature of a function called on each friend found.

Parameters

cls	closure
friend_id	peer identity of the friend

Definition at line 51 of file gnunet_friends_lib.h.

Function Documentation

GNUNET_FRIENDS_parse()

int GNUNET_FRIENDS_parse	(	const struct GNUNET_CONFIGURATION_Handle *	cfg,
		GNUNET_FRIENDS_Callback	cb,
		void *	cb_cls
	)

Parse the FRIENDS file.

Parameters

cfg	our configuration
cb	function to call on each friend found
cb_cls	closure for cb

Returns

GNUNET_OK on success, GNUNET_SYSERR on parsing errors

Definition at line 39 of file friends.c.

References _, data, fn, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CRYPTO_eddsa_public_key_from_string(), GNUNET_DISK_file_size(), GNUNET_DISK_file_test(), GNUNET_DISK_fn_read(), GNUNET_DISK_fn_write(), GNUNET_DISK_OPEN_CREATE, GNUNET_DISK_PERM_USER_READ, GNUNET_DISK_PERM_USER_WRITE, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_log_config_missing(), GNUNET_log_strerror, GNUNET_log_strerror_file, GNUNET_malloc_large, GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, GNUNET_PeerIdentity::public_key, and start.

Referenced by read_friends_file().

{
  char *fn;
  char *data;
  size_t pos;
  size_t start;
  struct GNUNET_PeerIdentity pid;
  uint64_t fsize;
  ssize_t ssize;

  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_filename (cfg,
                                               "TOPOLOGY",
                                               "FRIENDS",
                                               &fn))
  {
    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
                               "topology",
                               "FRIENDS");
    return GNUNET_SYSERR;
  }
  if ((GNUNET_OK !=
       GNUNET_DISK_file_test (fn)) &&
      (GNUNET_OK !=
       GNUNET_DISK_fn_write (fn,
                             NULL,
                             0,
                             GNUNET_DISK_PERM_USER_READ
                             | GNUNET_DISK_PERM_USER_WRITE
                             | GNUNET_DISK_OPEN_CREATE)))
    GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
                              "write",
                              fn);
  if ((GNUNET_OK !=
       GNUNET_DISK_file_size (fn,
                              &fsize,
                              GNUNET_NO,
                              GNUNET_YES)) ||
      (0 == fsize))
  {
    GNUNET_free (fn);
    return GNUNET_OK;
  }
  data = GNUNET_malloc_large (fsize);
  if (NULL == data)
  {
    GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "malloc");
    GNUNET_free (fn);
    return GNUNET_SYSERR;
  }
  ssize = GNUNET_DISK_fn_read (fn,
                               data,
                               fsize);
  if ((ssize < 0) ||
      (fsize != (uint64_t) ssize))
  {
    GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
                              "read",
                              "fn");
    GNUNET_free (fn);
    GNUNET_free (data);
    return GNUNET_SYSERR;
  }
  start = 0;
  pos = 0;
  while (pos < fsize)
  {
    while ((pos < fsize) &&
           (! isspace ((unsigned char) data[pos])))
      pos++;
    if (GNUNET_OK !=
        GNUNET_CRYPTO_eddsa_public_key_from_string (&data[start],
                                                    pos - start,
                                                    &pid.public_key))
    {
      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                  _ (
                    "Syntax error in FRIENDS file at offset %llu, skipping bytes `%.*s'.\n"),
                  (unsigned long long) pos,
                  (int) (pos - start),
                  &data[start]);
      pos++;
      start = pos;
      continue;
    }
    pos++;
    start = pos;
    cb (cb_cls, &pid);
  }
  GNUNET_free (data);
  GNUNET_free (fn);
  return GNUNET_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_FRIENDS_write_start()

struct GNUNET_FRIENDS_Writer* GNUNET_FRIENDS_write_start

(

const struct GNUNET_CONFIGURATION_Handle *

cfg

)

Start writing a fresh FRIENDS file.

Will make a backup of the old one.

Parameters

cfg	configuration to use.

Returns

NULL on error

Definition at line 156 of file friends.c.

References _, GNUNET_FRIENDS_Writer::fh, fn, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_DISK_directory_create_for_file(), GNUNET_DISK_file_backup(), GNUNET_DISK_file_open(), GNUNET_DISK_file_test(), GNUNET_DISK_OPEN_CREATE, GNUNET_DISK_OPEN_FAILIFEXISTS, GNUNET_DISK_OPEN_WRITE, GNUNET_DISK_PERM_USER_READ, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_log_config_missing(), GNUNET_new, and GNUNET_OK.

{
  struct GNUNET_FRIENDS_Writer *w;
  char *fn;

  if (GNUNET_OK !=
      GNUNET_CONFIGURATION_get_value_filename (cfg, "TOPOLOGY", "FRIENDS", &fn))
  {
    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
                               "topology", "FRIENDS");
    return NULL;
  }
  if (GNUNET_OK !=
      GNUNET_DISK_directory_create_for_file (fn))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                _ ("Directory for file `%s' does not seem to be writable.\n"),
                fn);
    GNUNET_free (fn);
    return NULL;
  }
  if (GNUNET_OK == GNUNET_DISK_file_test (fn))
    GNUNET_DISK_file_backup (fn);
  w = GNUNET_new (struct GNUNET_FRIENDS_Writer);
  w->fh = GNUNET_DISK_file_open (fn,
                                 GNUNET_DISK_OPEN_CREATE
                                 | GNUNET_DISK_OPEN_WRITE
                                 | GNUNET_DISK_OPEN_FAILIFEXISTS,
                                 GNUNET_DISK_PERM_USER_READ);
  GNUNET_free (fn);
  if (NULL == w->fh)
  {
    GNUNET_free (w);
    return NULL;
  }
  return w;
}

Here is the call graph for this function:

GNUNET_FRIENDS_write_stop()

int GNUNET_FRIENDS_write_stop

(

struct GNUNET_FRIENDS_Writer *

w

)

Finish writing out the friends file.

Parameters

w	write handle

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 202 of file friends.c.

References GNUNET_FRIENDS_Writer::fh, GNUNET_DISK_file_close(), GNUNET_free, and ret.

{
  int ret;

  ret = GNUNET_DISK_file_close (w->fh);
  GNUNET_free (w);
  return ret;
}

Here is the call graph for this function:

GNUNET_FRIENDS_write()

int GNUNET_FRIENDS_write	(	struct GNUNET_FRIENDS_Writer *	w,
		const struct GNUNET_PeerIdentity *	friend_id
	)

Add a friend to the friends file.

Parameters

w	write handle
friend_id	friend to add

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 220 of file friends.c.

References buf, GNUNET_FRIENDS_Writer::fh, GNUNET_asprintf(), GNUNET_CRYPTO_eddsa_public_key_to_string(), GNUNET_DISK_file_write(), GNUNET_free, GNUNET_OK, GNUNET_SYSERR, GNUNET_PeerIdentity::public_key, and ret.

{
  char *buf;
  char *ret;
  size_t slen;

  ret = GNUNET_CRYPTO_eddsa_public_key_to_string (&friend_id->public_key);
  GNUNET_asprintf (&buf,
                   "%s\n",
                   ret);
  GNUNET_free (ret);
  slen = strlen (buf);
  if (slen !=
      GNUNET_DISK_file_write (w->fh,
                              buf,
                              slen))
  {
    GNUNET_free (buf);
    return GNUNET_SYSERR;
  }
  GNUNET_free (buf);
  return GNUNET_OK;
}

Here is the call graph for this function: