2 This file is part of GNUnet
3 (C) 2003, 2004, 2005, 2006, 2007, 2008 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 2, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file util/pseudonym.c
23 * @brief helper functions
24 * @author Christian Grothoff
28 #include "gnunet_common.h"
29 #include "gnunet_container_lib.h"
30 #include "gnunet_disk_lib.h"
31 #include "gnunet_pseudonym_lib.h"
33 #define PS_METADATA_DIR DIR_SEPARATOR_STR "data" DIR_SEPARATOR_STR "pseudonyms/metadata" DIR_SEPARATOR_STR
34 #define PS_NAMES_DIR DIR_SEPARATOR_STR "data" DIR_SEPARATOR_STR "pseudonyms/names" DIR_SEPARATOR_STR
36 struct DiscoveryCallback
38 struct DiscoveryCallback *next;
39 GNUNET_PSEUDONYM_Iterator callback;
43 static struct DiscoveryCallback *head;
46 * Internal notification about new tracked URI.
49 internal_notify (const GNUNET_HashCode * id,
50 const struct GNUNET_CONTAINER_MetaData *md, int rating)
52 struct DiscoveryCallback *pos;
57 pos->callback (pos->closure, id, md, rating);
63 * Register callback to be invoked whenever we discover
67 GNUNET_PSEUDONYM_discovery_callback_register (struct
68 GNUNET_CONFIGURATION_Handle
70 GNUNET_PSEUDONYM_Iterator
71 iterator, void *closure)
73 struct DiscoveryCallback *list;
75 list = GNUNET_malloc (sizeof (struct DiscoveryCallback));
76 list->callback = iterator;
77 list->closure = closure;
80 GNUNET_PSEUDONYM_list_all (cfg, iterator, closure);
85 * Unregister pseudonym discovery callback.
88 GNUNET_PSEUDONYM_discovery_callback_unregister (GNUNET_PSEUDONYM_Iterator
89 iterator, void *closure)
91 struct DiscoveryCallback *prev;
92 struct DiscoveryCallback *pos;
96 while ((pos != NULL) &&
97 ((pos->callback != iterator) || (pos->closure != closure)))
103 return GNUNET_SYSERR;
107 prev->next = pos->next;
114 * Get the filename (or directory name) for the given
115 * pseudonym identifier and directory prefix.
118 get_data_filename (struct GNUNET_CONFIGURATION_Handle
119 *cfg, const char *prefix, const GNUNET_HashCode * psid)
121 struct GNUNET_CRYPTO_HashAsciiEncoded enc;
124 GNUNET_CRYPTO_hash_to_enc (psid, &enc);
125 return GNUNET_DISK_get_home_filename (cfg,
126 GNUNET_CLIENT_SERVICE_NAME,
129 NULL) ? NULL : (const char *) &enc,
134 write_pseudonym_info (struct GNUNET_CONFIGURATION_Handle *cfg,
135 const GNUNET_HashCode * nsid,
136 const struct GNUNET_CONTAINER_MetaData *meta,
137 int32_t ranking, const char *ns_name)
145 fn = get_data_filename (cfg, PS_METADATA_DIR, nsid);
146 GNUNET_assert (fn != NULL);
147 size = GNUNET_CONTAINER_meta_data_get_serialized_size (meta,
148 GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL);
149 tag = size + sizeof (int) + 1;
153 off = strlen (ns_name);
156 buf = GNUNET_malloc (tag);
157 ((int *) buf)[0] = htonl (ranking); /* ranking */
160 memcpy (&buf[sizeof (int)], ns_name, off + 1);
164 buf[sizeof (int)] = '\0';
167 (size == GNUNET_CONTAINER_meta_data_serialize (meta,
172 GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL));
173 GNUNET_DISK_fn_write (fn, buf, tag, GNUNET_DISK_PERM_USER_READ
174 | GNUNET_DISK_PERM_USER_WRITE | GNUNET_DISK_PERM_GROUP_READ);
177 /* create entry for pseudonym name in names */
178 GNUNET_free_non_null (GNUNET_PSEUDONYM_id_to_name (cfg, nsid));
182 read_info (struct GNUNET_CONFIGURATION_Handle *cfg,
183 const GNUNET_HashCode * nsid,
184 struct GNUNET_CONTAINER_MetaData **meta,
185 int32_t * ranking, char **ns_name)
187 unsigned long long len;
198 fn = get_data_filename (cfg, PS_METADATA_DIR, nsid);
199 GNUNET_assert (fn != NULL);
201 if ((0 != STAT (fn, &sbuf))
202 || (GNUNET_OK != GNUNET_DISK_file_size (fn, &len, GNUNET_YES)))
205 return GNUNET_SYSERR;
207 if (len <= sizeof (int) + 1)
210 return GNUNET_SYSERR;
212 if (len > 16 * 1024 * 1024)
214 /* too big, must be invalid! remove! */
216 if (0 != UNLINK (fn))
217 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
219 return GNUNET_SYSERR;
221 buf = GNUNET_malloc (len);
222 if (len != GNUNET_DISK_fn_read (fn, buf, len))
226 return GNUNET_SYSERR;
229 *ranking = ntohl (((int *) buf)[0]);
231 while ((zend < len) && (buf[zend] != '\0'))
237 return GNUNET_SYSERR;
241 if (zend != sizeof (int))
242 *ns_name = GNUNET_strdup (&buf[sizeof (int)]);
250 *meta = GNUNET_CONTAINER_meta_data_deserialize (&buf[zend], size);
253 /* invalid data! remove! */
255 if (0 != UNLINK (fn))
256 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
260 return GNUNET_SYSERR;
271 * Return the unique, human readable name for the given namespace.
273 * @return NULL on failure (should never happen)
276 GNUNET_PSEUDONYM_id_to_name (struct GNUNET_CONFIGURATION_Handle *cfg,
277 const GNUNET_HashCode * nsid)
279 struct GNUNET_CONTAINER_MetaData *meta;
283 unsigned long long len;
284 struct GNUNET_DISK_FileHandle *fh;
292 if (GNUNET_OK == read_info (cfg, nsid, &meta, NULL, &name))
294 if ((meta != NULL) && (name == NULL))
295 name = GNUNET_CONTAINER_meta_data_get_first_by_types (meta,
298 EXTRACTOR_DESCRIPTION,
308 GNUNET_CONTAINER_meta_data_destroy (meta);
313 name = GNUNET_strdup (_("no-name"));
314 GNUNET_CRYPTO_hash (name, strlen (name), &nh);
315 fn = get_data_filename (cfg, PS_NAMES_DIR, &nh);
316 GNUNET_assert (fn != NULL);
319 if (0 == STAT (fn, &sbuf))
320 GNUNET_DISK_file_size (fn, &len, GNUNET_YES);
321 fh = GNUNET_DISK_file_open (fn, GNUNET_DISK_OPEN_CREATE
322 | GNUNET_DISK_OPEN_READWRITE, GNUNET_DISK_PERM_USER_READ
323 | GNUNET_DISK_PERM_USER_WRITE);
326 while ((len >= sizeof (GNUNET_HashCode)) &&
327 (sizeof (GNUNET_HashCode)
328 == GNUNET_DISK_file_read (fh, &nh, sizeof (GNUNET_HashCode))))
330 if (0 == memcmp (&nh, nsid, sizeof (GNUNET_HashCode)))
336 len -= sizeof (GNUNET_HashCode);
341 if (sizeof (GNUNET_HashCode) !=
342 GNUNET_DISK_file_write (fh, nsid, sizeof (GNUNET_HashCode)))
343 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "write", fn);
345 GNUNET_DISK_file_close (fh);
346 ret = GNUNET_malloc (strlen (name) + 32);
347 GNUNET_snprintf (ret, strlen (name) + 32, "%s-%u", name, idx);
354 * Get the namespace ID belonging to the given namespace name.
356 * @return GNUNET_OK on success
359 GNUNET_PSEUDONYM_name_to_id (struct GNUNET_CONFIGURATION_Handle *cfg,
360 const char *ns_uname, GNUNET_HashCode * nsid)
363 unsigned long long len;
368 struct GNUNET_DISK_FileHandle *fh;
371 slen = strlen (ns_uname);
372 while ((slen > 0) && (1 != sscanf (&ns_uname[slen - 1], "-%u", &idx)))
375 return GNUNET_SYSERR;
376 name = GNUNET_strdup (ns_uname);
377 name[slen - 1] = '\0';
378 GNUNET_CRYPTO_hash (name, strlen (name), &nh);
380 fn = get_data_filename (cfg, PS_NAMES_DIR, &nh);
381 GNUNET_assert (fn != NULL);
383 if ((GNUNET_OK != GNUNET_DISK_file_test (fn) ||
384 (GNUNET_OK != GNUNET_DISK_file_size (fn, &len, GNUNET_YES))) ||
385 ((idx + 1) * sizeof (GNUNET_HashCode) > len))
388 return GNUNET_SYSERR;
390 fh = GNUNET_DISK_file_open (fn, GNUNET_DISK_OPEN_CREATE
391 | GNUNET_DISK_OPEN_READWRITE, GNUNET_DISK_PERM_USER_READ
392 | GNUNET_DISK_PERM_USER_WRITE);
394 GNUNET_DISK_file_seek (fh, idx * sizeof (GNUNET_HashCode), GNUNET_SEEK_SET);
395 if (sizeof (GNUNET_HashCode) != GNUNET_DISK_file_read (fh, nsid, sizeof (GNUNET_HashCode)))
397 GNUNET_DISK_file_close (fh);
398 return GNUNET_SYSERR;
400 GNUNET_DISK_file_close (fh);
407 struct ListPseudonymClosure
409 GNUNET_PSEUDONYM_Iterator iterator;
411 struct GNUNET_CONFIGURATION_Handle *cfg;
415 list_pseudonym_helper (void *cls, const char *fullname)
417 struct ListPseudonymClosure *c = cls;
421 struct GNUNET_CONTAINER_MetaData *meta;
424 if (strlen (fullname) < sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded))
427 &fullname[strlen (fullname) + 1 -
428 sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
429 if (fn[-1] != DIR_SEPARATOR)
432 if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (fn, &id))
433 return GNUNET_OK; /* invalid name */
434 if (GNUNET_OK != read_info (c->cfg, &id, &meta, &rating, NULL))
435 return GNUNET_OK; /* ignore entry */
436 if (c->iterator != NULL)
437 ret = c->iterator (c->closure, &id, meta, rating);
438 GNUNET_CONTAINER_meta_data_destroy (meta);
443 * List all available pseudonyms.
446 GNUNET_PSEUDONYM_list_all (struct GNUNET_CONFIGURATION_Handle *cfg,
447 GNUNET_PSEUDONYM_Iterator iterator, void *closure)
449 struct ListPseudonymClosure cls;
453 cls.iterator = iterator;
454 cls.closure = closure;
456 fn = get_data_filename (cfg, PS_METADATA_DIR, NULL);
457 GNUNET_assert (fn != NULL);
458 GNUNET_DISK_directory_create (fn);
459 ret = GNUNET_DISK_directory_scan (fn, &list_pseudonym_helper, &cls);
465 * Change the ranking of a pseudonym.
467 * @param nsid id of the pseudonym
468 * @param delta by how much should the rating be
470 * @return new rating of the pseudonym
473 GNUNET_PSEUDONYM_rank (struct GNUNET_CONFIGURATION_Handle *cfg,
474 const GNUNET_HashCode * nsid, int delta)
476 struct GNUNET_CONTAINER_MetaData *meta;
482 ret = read_info (cfg, nsid, &meta, &ranking, &name);
483 if (ret == GNUNET_SYSERR)
486 meta = GNUNET_CONTAINER_meta_data_create ();
489 write_pseudonym_info (cfg, nsid, meta, ranking, name);
490 GNUNET_CONTAINER_meta_data_destroy (meta);
491 GNUNET_free_non_null (name);
496 * Insert metadata into existing MD record (passed as cls).
499 merge_meta_helper (EXTRACTOR_KeywordType type, const char *data, void *cls)
501 struct GNUNET_CONTAINER_MetaData *meta = cls;
502 GNUNET_CONTAINER_meta_data_insert (meta, type, data);
509 * Add a pseudonym to the set of known pseudonyms.
510 * For all pseudonym advertisements that we discover
511 * FSUI should automatically call this function.
513 * @param id the pseudonym identifier
516 GNUNET_PSEUDONYM_add (struct GNUNET_CONFIGURATION_Handle *cfg,
517 const GNUNET_HashCode * id,
518 const struct GNUNET_CONTAINER_MetaData *meta)
522 struct GNUNET_CONTAINER_MetaData *old;
527 fn = get_data_filename (cfg, PS_METADATA_DIR, id);
528 GNUNET_assert (fn != NULL);
530 if ((0 == STAT (fn, &sbuf)) &&
531 (GNUNET_OK == read_info (cfg, id, &old, &ranking, &name)))
533 GNUNET_CONTAINER_meta_data_get_contents (meta, &merge_meta_helper, old);
534 write_pseudonym_info (cfg, id, old, ranking, name);
535 GNUNET_CONTAINER_meta_data_destroy (old);
536 GNUNET_free_non_null (name);
540 write_pseudonym_info (cfg, id, meta, ranking, NULL);
543 internal_notify (id, meta, ranking);
550 /* end of pseudonym.c */