2 This file is part of GNUnet
3 (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 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 3, 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 fs/fs_namespace.c
23 * @brief create and destroy namespaces
24 * @author Christian Grothoff
27 #include "gnunet_constants.h"
28 #include "gnunet_signatures.h"
29 #include "gnunet_util_lib.h"
30 #include "gnunet_fs_service.h"
33 #define DEBUG_NAMESPACE GNUNET_NO
36 * Return the name of the directory in which we store
37 * our local namespaces (or rather, their public keys).
39 * @param h global fs handle
40 * @return NULL on error, otherwise the name of the directory
43 get_namespace_directory (struct GNUNET_FS_Handle *h)
48 GNUNET_CONFIGURATION_get_value_filename (h->cfg,
53 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
54 _("Configuration fails to specify `%s' in section `%s'\n"),
64 * Return the name of the directory in which we store
65 * the update information graph for the given local namespace.
67 * @param ns namespace handle
68 * @return NULL on error, otherwise the name of the directory
71 get_update_information_directory (struct GNUNET_FS_Namespace *ns)
77 GNUNET_CONFIGURATION_get_value_filename (ns->h->cfg,
82 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
83 _("Configuration fails to specify `%s' in section `%s'\n"),
88 GNUNET_asprintf (&ret,
99 * Write the namespace update node graph to a file.
101 * @param ns namespace to dump
104 write_update_information_graph (struct GNUNET_FS_Namespace *ns)
107 struct GNUNET_BIO_WriteHandle *wh;
109 struct NamespaceUpdateNode *n;
112 fn = get_update_information_directory (ns);
113 wh = GNUNET_BIO_write_open (fn);
116 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
117 _("Failed to open `%s' for writing: %s\n"),
123 GNUNET_BIO_write_int32 (wh, ns->update_node_count))
125 for (i=0;i<ns->update_node_count;i++)
127 n = ns->update_nodes[i];
128 uris = GNUNET_FS_uri_to_string (n->uri);
130 GNUNET_BIO_write_string (wh, n->id)) ||
132 GNUNET_BIO_write_meta_data (wh, n->md)) ||
134 GNUNET_BIO_write_string (wh, n->update)) ||
136 GNUNET_BIO_write_string (wh, uris)) )
144 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
145 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
146 _("Failed to write `%s': %s\n"),
153 * Read the namespace update node graph from a file.
155 * @param ns namespace to read
158 read_update_information_graph (struct GNUNET_FS_Namespace *ns)
161 struct GNUNET_BIO_ReadHandle *rh;
163 struct NamespaceUpdateNode *n;
168 fn = get_update_information_directory (ns);
170 GNUNET_DISK_file_test (fn))
175 rh = GNUNET_BIO_read_open (fn);
182 GNUNET_BIO_read_int32 (rh, &count))
187 if (count > 1024 * 1024)
194 GNUNET_break (GNUNET_OK == GNUNET_BIO_read_close (rh, NULL));
198 ns->update_nodes = GNUNET_malloc (count * sizeof (struct NamespaceUpdateNode*));
200 for (i=0;i<count;i++)
202 n = GNUNET_malloc (sizeof (struct NamespaceUpdateNode));
204 GNUNET_BIO_read_string (rh, "identifier", &n->id, 1024)) ||
206 GNUNET_BIO_read_meta_data (rh, "meta", &n->md)) ||
208 GNUNET_BIO_read_string (rh, "update-id", &n->update, 1024)) ||
210 GNUNET_BIO_read_string (rh, "uri", &uris, 1024 * 2)) )
213 GNUNET_free_non_null (n->id);
214 GNUNET_free_non_null (n->update);
216 GNUNET_CONTAINER_meta_data_destroy (n->md);
220 n->uri = GNUNET_FS_uri_parse (uris, &emsg);
227 GNUNET_free_non_null (n->update);
228 GNUNET_CONTAINER_meta_data_destroy (n->md);
232 ns->update_nodes[i] = n;
234 ns->update_node_count = i;
236 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
238 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
239 _("Failed to write `%s': %s\n"),
248 * Context for advertising a namespace.
250 struct AdvertisementContext
253 * Function to call with the result.
255 GNUNET_FS_PublishContinuation cont;
265 struct GNUNET_DATASTORE_Handle *dsh;
270 struct GNUNET_FS_Uri *ksk_uri;
278 * NBlock to sign and store.
285 struct GNUNET_FS_Namespace *ns;
290 struct GNUNET_FS_BlockOptions bo;
293 * Number of bytes of plaintext.
298 * Current keyword offset.
305 * Disconnect from the datastore.
307 * @param cls datastore handle
308 * @param tc scheduler context
311 do_disconnect (void *cls,
312 const struct GNUNET_SCHEDULER_TaskContext *tc)
314 struct GNUNET_DATASTORE_Handle *dsh = cls;
316 GNUNET_DATASTORE_disconnect (dsh,
322 * Continuation called to notify client about result of the
325 * @param cls closure (our struct AdvertismentContext)
326 * @param success GNUNET_SYSERR on failure
327 * @param msg NULL on success, otherwise an error message
330 advertisement_cont (void *cls,
334 struct AdvertisementContext *ac = cls;
337 GNUNET_HashCode query;
338 struct GNUNET_CRYPTO_AesSessionKey skey;
339 struct GNUNET_CRYPTO_AesInitializationVector iv;
340 struct GNUNET_CRYPTO_RsaPrivateKey *pk;
342 if (GNUNET_OK != success)
345 GNUNET_SCHEDULER_add_continuation (&do_disconnect,
347 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
348 if (ac->cont != NULL)
349 ac->cont (ac->cont_cls, NULL, msg);
350 GNUNET_FS_uri_destroy (ac->ksk_uri);
351 GNUNET_free (ac->pt);
352 GNUNET_free (ac->nb);
353 GNUNET_FS_namespace_delete (ac->ns, GNUNET_NO);
357 if (ac->pos == ac->ksk_uri->data.ksk.keywordCount)
360 GNUNET_SCHEDULER_add_continuation (&do_disconnect,
362 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
363 if (ac->cont != NULL)
364 ac->cont (ac->cont_cls, ac->ksk_uri, NULL);
365 GNUNET_FS_uri_destroy (ac->ksk_uri);
366 GNUNET_free (ac->pt);
367 GNUNET_free (ac->nb);
368 GNUNET_FS_namespace_delete (ac->ns, GNUNET_NO);
372 keyword = ac->ksk_uri->data.ksk.keywords[ac->pos++];
373 /* first character of keyword indicates if it is
374 mandatory or not -- ignore for hashing */
375 GNUNET_CRYPTO_hash (&keyword[1], strlen (&keyword[1]), &key);
376 GNUNET_CRYPTO_hash_to_aes_key (&key, &skey, &iv);
377 GNUNET_CRYPTO_aes_encrypt (ac->pt,
382 GNUNET_break (GNUNET_OK ==
383 GNUNET_CRYPTO_rsa_sign (ac->ns->key,
385 &ac->nb->ns_signature));
386 pk = GNUNET_CRYPTO_rsa_key_create_from_hash (&key);
387 GNUNET_assert (pk != NULL);
388 GNUNET_CRYPTO_rsa_key_get_public (pk, &ac->nb->keyspace);
389 GNUNET_CRYPTO_hash (&ac->nb->keyspace,
390 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
392 GNUNET_break (GNUNET_OK ==
393 GNUNET_CRYPTO_rsa_sign (pk,
394 &ac->nb->ksk_purpose,
395 &ac->nb->ksk_signature));
396 GNUNET_CRYPTO_rsa_key_free (pk);
397 GNUNET_DATASTORE_put (ac->dsh,
398 0 /* no reservation */,
400 ac->pt_size + sizeof (struct NBlock),
402 GNUNET_BLOCK_TYPE_FS_NBLOCK,
403 ac->bo.content_priority,
404 ac->bo.anonymity_level,
405 ac->bo.replication_level,
406 ac->bo.expiration_time,
408 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
415 * Publish an advertismement for a namespace.
417 * @param h handle to the file sharing subsystem
418 * @param ksk_uri keywords to use for advertisment
419 * @param namespace handle for the namespace that should be advertised
420 * @param meta meta-data for the namespace advertisement
421 * @param bo block options
422 * @param rootEntry name of the root of the namespace
423 * @param cont continuation
424 * @param cont_cls closure for cont
427 GNUNET_FS_namespace_advertise (struct GNUNET_FS_Handle *h,
428 struct GNUNET_FS_Uri *ksk_uri,
429 struct GNUNET_FS_Namespace *namespace,
430 const struct GNUNET_CONTAINER_MetaData *meta,
431 const struct GNUNET_FS_BlockOptions *bo,
432 const char *rootEntry,
433 GNUNET_FS_PublishContinuation cont,
441 struct GNUNET_DATASTORE_Handle *dsh;
442 struct AdvertisementContext *ctx;
445 /* create advertisements */
446 mdsize = GNUNET_CONTAINER_meta_data_get_serialized_size (meta);
449 cont (cont_cls, NULL, _("Failed to serialize meta data"));
452 reslen = strlen (rootEntry) + 1;
453 size = mdsize + sizeof (struct NBlock) + reslen;
454 if (size > MAX_NBLOCK_SIZE)
456 size = MAX_NBLOCK_SIZE;
457 mdsize = size - sizeof (struct NBlock) - reslen;
460 pt = GNUNET_malloc (mdsize + reslen);
461 memcpy (pt, rootEntry, reslen);
463 mdsize = GNUNET_CONTAINER_meta_data_serialize (meta,
466 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART);
471 cont (cont_cls, NULL, _("Failed to serialize meta data"));
474 size = mdsize + sizeof (struct NBlock) + reslen;
475 nb = GNUNET_malloc (size);
476 GNUNET_CRYPTO_rsa_key_get_public (namespace->key,
478 nb->ns_purpose.size = htonl (mdsize + reslen +
479 sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) +
480 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
481 nb->ns_purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_FS_NBLOCK);
482 nb->ksk_purpose.size = htonl (size - sizeof (struct GNUNET_CRYPTO_RsaSignature));
483 nb->ksk_purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_FS_NBLOCK_KSIG);
484 dsh = GNUNET_DATASTORE_connect (h->cfg);
489 cont (cont_cls, NULL, _("Failed to connect to datastore service"));
492 ctx = GNUNET_malloc (sizeof (struct AdvertisementContext));
494 ctx->cont_cls = cont_cls;
496 ctx->ksk_uri = GNUNET_FS_uri_dup (ksk_uri);
499 ctx->pt_size = mdsize + reslen;
503 advertisement_cont (ctx, GNUNET_OK, NULL);
508 * Create a namespace with the given name; if one already
509 * exists, return a handle to the existing namespace.
511 * @param h handle to the file sharing subsystem
512 * @param name name to use for the namespace
513 * @return handle to the namespace, NULL on error
515 struct GNUNET_FS_Namespace *
516 GNUNET_FS_namespace_create (struct GNUNET_FS_Handle *h,
521 struct GNUNET_FS_Namespace *ret;
523 dn = get_namespace_directory (h);
524 GNUNET_asprintf (&fn,
530 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Namespace));
533 ret->key = GNUNET_CRYPTO_rsa_key_create_from_file (fn);
534 if (ret->key == NULL)
536 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
537 _("Failed to create or read private key for namespace `%s'\n"),
543 ret->name = GNUNET_strdup (name);
550 * Delete a namespace handle. Can be used for a clean shutdown (free
551 * memory) or also to freeze the namespace to prevent further
552 * insertions by anyone.
554 * @param namespace handle to the namespace that should be deleted / freed
555 * @param freeze prevents future insertions; creating a namespace
556 * with the same name again will create a fresh namespace instead
558 * @return GNUNET_OK on success, GNUNET_SYSERR on error
561 GNUNET_FS_namespace_delete (struct GNUNET_FS_Namespace *namespace,
565 struct NamespaceUpdateNode *nsn;
570 if (0 != UNLINK (namespace->filename))
571 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
573 namespace->filename);
575 if (0 == namespace->rc)
577 GNUNET_CRYPTO_rsa_key_free (namespace->key);
578 GNUNET_free (namespace->filename);
579 GNUNET_free (namespace->name);
580 for (i=0;i<namespace->update_node_count;i++)
582 nsn = namespace->update_nodes[i];
583 GNUNET_CONTAINER_meta_data_destroy (nsn->md);
584 GNUNET_FS_uri_destroy (nsn->uri);
585 GNUNET_free (nsn->id);
586 GNUNET_free (nsn->update);
589 GNUNET_array_grow (namespace->update_nodes,
590 namespace->update_node_count,
592 if (namespace->update_map != NULL)
593 GNUNET_CONTAINER_multihashmap_destroy (namespace->update_map);
594 GNUNET_free (namespace);
601 * Context for the 'process_namespace' callback.
602 * Specifies a function to call on each namespace.
604 struct ProcessNamespaceContext
609 GNUNET_FS_NamespaceInfoProcessor cb;
619 * Function called with a filename of a namespace. Reads the key and
620 * calls the callback.
622 * @param cls closure (struct ProcessNamespaceContext)
623 * @param filename complete filename (absolute path)
624 * @return GNUNET_OK to continue to iterate,
625 * GNUNET_SYSERR to abort iteration with error!
628 process_namespace (void *cls,
629 const char *filename)
631 struct ProcessNamespaceContext *pnc = cls;
632 struct GNUNET_CRYPTO_RsaPrivateKey *key;
633 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pk;
638 key = GNUNET_CRYPTO_rsa_key_create_from_file (filename);
641 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
642 _("Failed to read namespace private key file `%s', deleting it!\n"),
644 if (0 != UNLINK (filename))
645 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
650 GNUNET_CRYPTO_rsa_key_get_public (key, &pk);
651 GNUNET_CRYPTO_rsa_key_free (key);
652 GNUNET_CRYPTO_hash (&pk, sizeof(pk), &id);
654 while (NULL != (t = strstr (name, DIR_SEPARATOR_STR)))
656 pnc->cb (pnc->cb_cls,
664 * Build a list of all available local (!) namespaces The returned
665 * names are only the nicknames since we only iterate over the local
668 * @param h handle to the file sharing subsystem
669 * @param cb function to call on each known namespace
670 * @param cb_cls closure for cb
673 GNUNET_FS_namespace_list (struct GNUNET_FS_Handle *h,
674 GNUNET_FS_NamespaceInfoProcessor cb,
678 struct ProcessNamespaceContext ctx;
680 dn = get_namespace_directory (h);
685 GNUNET_DISK_directory_scan (dn,
695 * Context for the SKS publication.
697 struct PublishSksContext
701 * URI of the new entry in the namespace.
703 struct GNUNET_FS_Uri *uri;
706 * Namespace update node to add to namespace on success (or to be
707 * deleted if publishing failed).
709 struct NamespaceUpdateNode *nsn;
712 * Namespace we're publishing to.
714 struct GNUNET_FS_Namespace *namespace;
717 * Handle to the datastore.
719 struct GNUNET_DATASTORE_Handle *dsh;
722 * Function to call once we're done.
724 GNUNET_FS_PublishContinuation cont;
735 * Function called by the datastore API with
736 * the result from the PUT (SBlock) request.
738 * @param cls closure of type "struct PublishSksContext*"
739 * @param success GNUNET_OK on success
740 * @param msg error message (or NULL)
743 sb_put_cont (void *cls,
747 struct PublishSksContext *psc = cls;
750 if (NULL != psc->dsh)
752 GNUNET_DATASTORE_disconnect (psc->dsh, GNUNET_NO);
755 if (GNUNET_OK != success)
757 if (psc->cont != NULL)
758 psc->cont (psc->cont_cls,
764 if (psc->nsn != NULL)
766 /* FIXME: this can be done much more
767 efficiently by simply appending to the
768 file and overwriting the 4-byte header */
769 if (psc->namespace->update_nodes == NULL)
770 read_update_information_graph (psc->namespace);
771 GNUNET_array_append (psc->namespace->update_nodes,
772 psc->namespace->update_node_count,
774 if (psc->namespace->update_map != NULL)
776 GNUNET_CRYPTO_hash (psc->nsn->id,
777 strlen (psc->nsn->id),
779 GNUNET_CONTAINER_multihashmap_put (psc->namespace->update_map,
782 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
785 write_update_information_graph (psc->namespace);
787 if (psc->cont != NULL)
788 psc->cont (psc->cont_cls,
792 GNUNET_FS_namespace_delete (psc->namespace,
794 GNUNET_FS_uri_destroy (psc->uri);
795 if (psc->nsn != NULL)
797 GNUNET_CONTAINER_meta_data_destroy (psc->nsn->md);
798 GNUNET_FS_uri_destroy (psc->nsn->uri);
799 GNUNET_free (psc->nsn->id);
800 GNUNET_free (psc->nsn->update);
801 GNUNET_free (psc->nsn);
808 * Publish an SBlock on GNUnet.
810 * @param h handle to the file sharing subsystem
811 * @param namespace namespace to publish in
812 * @param identifier identifier to use
813 * @param update update identifier to use
814 * @param meta metadata to use
815 * @param uri URI to refer to in the SBlock
816 * @param bo block options
817 * @param options publication options
818 * @param cont continuation
819 * @param cont_cls closure for cont
822 GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
823 struct GNUNET_FS_Namespace *namespace,
824 const char *identifier,
826 const struct GNUNET_CONTAINER_MetaData *meta,
827 const struct GNUNET_FS_Uri *uri,
828 const struct GNUNET_FS_BlockOptions *bo,
829 enum GNUNET_FS_PublishOptions options,
830 GNUNET_FS_PublishContinuation cont,
833 struct PublishSksContext *psc;
834 struct GNUNET_CRYPTO_AesSessionKey sk;
835 struct GNUNET_CRYPTO_AesInitializationVector iv;
836 struct GNUNET_FS_Uri *sks_uri;
844 struct SBlock *sb_enc;
846 struct GNUNET_CONTAINER_MetaData *mmeta;
847 GNUNET_HashCode key; /* hash of thisId = key */
848 GNUNET_HashCode id; /* hash of hc = identifier */
849 GNUNET_HashCode query; /* id ^ nsid = DB query */
852 mmeta = GNUNET_CONTAINER_meta_data_create ();
854 mmeta = GNUNET_CONTAINER_meta_data_duplicate (meta);
855 uris = GNUNET_FS_uri_to_string (uri);
856 slen = strlen (uris) + 1;
857 idlen = strlen (identifier);
860 nidlen = strlen (update) + 1;
861 mdsize = GNUNET_CONTAINER_meta_data_get_serialized_size (mmeta);
862 size = sizeof (struct SBlock) + slen + nidlen + mdsize;
863 if (size > MAX_SBLOCK_SIZE)
865 size = MAX_SBLOCK_SIZE;
866 mdsize = size - (sizeof (struct SBlock) + slen + nidlen);
868 sb = GNUNET_malloc (sizeof (struct SBlock) + size);
869 dest = (char *) &sb[1];
870 memcpy (dest, update, nidlen);
872 memcpy (dest, uris, slen);
875 mdsize = GNUNET_CONTAINER_meta_data_serialize (mmeta,
878 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART);
879 GNUNET_CONTAINER_meta_data_destroy (mmeta);
886 _("Internal error."));
889 size = sizeof (struct SBlock) + mdsize + slen + nidlen;
890 sb_enc = GNUNET_malloc (size);
891 GNUNET_CRYPTO_hash (identifier, idlen, &key);
892 GNUNET_CRYPTO_hash (&key, sizeof (GNUNET_HashCode), &id);
893 sks_uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
895 GNUNET_CRYPTO_rsa_key_get_public (namespace->key, &sb_enc->subspace);
896 GNUNET_CRYPTO_hash (&sb_enc->subspace,
897 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
898 &sks_uri->data.sks.namespace);
899 sks_uri->data.sks.identifier = GNUNET_strdup (identifier);
900 GNUNET_CRYPTO_hash_xor (&id,
901 &sks_uri->data.sks.namespace,
902 &sb_enc->identifier);
903 GNUNET_CRYPTO_hash_to_aes_key (&key, &sk, &iv);
904 GNUNET_CRYPTO_aes_encrypt (&sb[1],
905 size - sizeof (struct SBlock),
909 sb_enc->purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_FS_SBLOCK);
910 sb_enc->purpose.size = htonl(slen + mdsize + nidlen
911 + sizeof(struct SBlock)
912 - sizeof(struct GNUNET_CRYPTO_RsaSignature));
913 GNUNET_assert (GNUNET_OK ==
914 GNUNET_CRYPTO_rsa_sign (namespace->key,
916 &sb_enc->signature));
917 psc = GNUNET_malloc (sizeof(struct PublishSksContext));
920 psc->namespace = namespace;
922 psc->cont_cls = cont_cls;
923 if (0 != (options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY))
925 GNUNET_free (sb_enc);
932 psc->dsh = GNUNET_DATASTORE_connect (h->cfg);
933 if (NULL == psc->dsh)
935 GNUNET_free (sb_enc);
939 _("Failed to connect to datastore."));
942 GNUNET_CRYPTO_hash_xor (&sks_uri->data.sks.namespace,
947 psc->nsn = GNUNET_malloc (sizeof (struct NamespaceUpdateNode));
948 psc->nsn->id = GNUNET_strdup (identifier);
949 psc->nsn->update = GNUNET_strdup (update);
950 psc->nsn->md = GNUNET_CONTAINER_meta_data_duplicate (meta);
951 psc->nsn->uri = GNUNET_FS_uri_dup (uri);
953 GNUNET_DATASTORE_put (psc->dsh,
958 GNUNET_BLOCK_TYPE_FS_SBLOCK,
959 bo->content_priority,
961 bo->replication_level,
964 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
968 GNUNET_free (sb_enc);
973 * Closure for 'process_update_node'.
975 struct ProcessUpdateClosure
978 * Function to call for each node.
980 GNUNET_FS_IdentifierProcessor ip;
990 * Call the iterator in the closure for each node.
992 * @param cls closure (of type 'struct ProcessUpdateClosure *')
993 * @param key current key code
994 * @param value value in the hash map (of type 'struct NamespaceUpdateNode *')
995 * @return GNUNET_YES if we should continue to
1000 process_update_node (void *cls,
1001 const GNUNET_HashCode * key,
1004 struct ProcessUpdateClosure *pc = cls;
1005 struct NamespaceUpdateNode *nsn = value;
1017 * Closure for 'find_trees'.
1019 struct FindTreeClosure
1022 * Namespace we are operating on.
1024 struct GNUNET_FS_Namespace *namespace;
1027 * Array with 'head's of TREEs.
1029 struct NamespaceUpdateNode **tree_array;
1032 * Size of 'tree_array'
1034 unsigned int tree_array_size;
1037 * Current generational ID used.
1042 * Identifier for the current TREE, or UINT_MAX for none yet.
1049 * Find all nodes reachable from the current node (including the
1050 * current node itself). If they are in no tree, add them to the
1051 * current one. If they are the head of another tree, merge the
1052 * trees. If they are in the middle of another tree, let them be.
1053 * We can tell that a node is already in an tree by checking if
1054 * its 'nug' field is set to the current 'nug' value. It is the
1055 * head of an tree if it is in the 'tree_array' under its respective
1058 * In short, we're trying to find the smallest number of tree to
1059 * cover a directed graph.
1061 * @param cls closure (of type 'struct FindTreeClosure')
1062 * @param key current key code
1063 * @param value value in the hash map
1064 * @return GNUNET_YES if we should continue to
1069 find_trees (void *cls,
1070 const GNUNET_HashCode * key,
1073 struct FindTreeClosure *fc = cls;
1074 struct NamespaceUpdateNode *nsn = value;
1077 if (nsn->nug == fc->nug)
1079 if (nsn->tree_id == UINT_MAX)
1080 return GNUNET_YES; /* circular */
1081 GNUNET_assert (nsn->tree_id < fc->tree_array_size);
1082 if (fc->tree_array[nsn->tree_id] != nsn)
1083 return GNUNET_YES; /* part of "another" (directed) TREE,
1084 and not root of it, end trace */
1085 if (nsn->tree_id == fc->id)
1086 return GNUNET_YES; /* that's our own root (can this be?) */
1087 /* merge existing TREE, we have a root for both */
1088 fc->tree_array[nsn->tree_id] = NULL;
1089 if (fc->id == UINT_MAX)
1090 fc->id = nsn->tree_id; /* take over ID */
1095 nsn->tree_id = UINT_MAX; /* mark as undef */
1097 GNUNET_CRYPTO_hash (nsn->update,
1098 strlen (nsn->update),
1100 GNUNET_CONTAINER_multihashmap_get_multiple (fc->namespace->update_map,
1110 * List all of the identifiers in the namespace for which we could
1111 * produce an update. Namespace updates form a graph where each node
1112 * has a name. Each node can have any number of URI/meta-data entries
1113 * which can each be linked to other nodes. Cycles are possible.
1115 * Calling this function with "next_id" NULL will cause the library to
1116 * call "ip" with a root for each strongly connected component of the
1117 * graph (a root being a node from which all other nodes in the Tree
1120 * Calling this function with "next_id" being the name of a node will
1121 * cause the library to call "ip" with all children of the node. Note
1122 * that cycles within the final tree are possible (including self-loops).
1123 * I know, odd definition of a tree, but the GUI will display an actual
1124 * tree (GtkTreeView), so that's what counts for the term here.
1126 * @param namespace namespace to inspect for updateable content
1127 * @param next_id ID to look for; use NULL to look for tree roots
1128 * @param ip function to call on each updateable identifier
1129 * @param ip_cls closure for ip
1132 GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Namespace *namespace,
1133 const char *next_id,
1134 GNUNET_FS_IdentifierProcessor ip,
1140 struct NamespaceUpdateNode *nsn;
1141 struct ProcessUpdateClosure pc;
1142 struct FindTreeClosure fc;
1144 if (namespace->update_nodes == NULL)
1145 read_update_information_graph (namespace);
1146 if (namespace->update_nodes == NULL)
1149 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1150 "No updateable nodes found for ID `%s'\n",
1153 return; /* no nodes */
1155 if (namespace->update_map == NULL)
1157 /* need to construct */
1158 namespace->update_map = GNUNET_CONTAINER_multihashmap_create (2 + 3 * namespace->update_node_count / 4);
1159 for (i=0;i<namespace->update_node_count;i++)
1161 nsn = namespace->update_nodes[i];
1162 GNUNET_CRYPTO_hash (nsn->id,
1165 GNUNET_CONTAINER_multihashmap_put (namespace->update_map,
1168 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1171 if (next_id != NULL)
1173 GNUNET_CRYPTO_hash (next_id,
1178 GNUNET_CONTAINER_multihashmap_get_multiple (namespace->update_map,
1180 &process_update_node,
1185 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1186 "Calculating TREEs to find roots of update trees\n");
1188 /* Find heads of TREEs in update graph */
1189 nug = ++namespace->nug_gen;
1190 fc.tree_array = NULL;
1191 fc.tree_array_size = 0;
1193 for (i=0;i<namespace->update_node_count;i++)
1195 nsn = namespace->update_nodes[i];
1196 if (nsn->nug == nug)
1199 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1200 "TREE of node `%s' is %u\n",
1204 continue; /* already placed in TREE */
1206 GNUNET_CRYPTO_hash (nsn->update,
1207 strlen (nsn->update),
1212 fc.namespace = namespace;
1213 GNUNET_CONTAINER_multihashmap_get_multiple (namespace->update_map,
1217 if (fc.id == UINT_MAX)
1219 /* start new TREE */
1220 for (fc.id=0;fc.id<fc.tree_array_size;fc.id++)
1222 if (fc.tree_array[fc.id] == NULL)
1224 fc.tree_array[fc.id] = nsn;
1225 nsn->tree_id = fc.id;
1229 if (fc.id == fc.tree_array_size)
1231 GNUNET_array_append (fc.tree_array,
1234 nsn->tree_id = fc.id;
1237 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1238 "Starting new TREE %u with node `%s'\n",
1242 /* put all nodes with same identifier into this TREE */
1243 GNUNET_CRYPTO_hash (nsn->id,
1246 fc.id = nsn->tree_id;
1248 fc.namespace = namespace;
1249 GNUNET_CONTAINER_multihashmap_get_multiple (namespace->update_map,
1256 /* make head of TREE "id" */
1257 fc.tree_array[fc.id] = nsn;
1258 nsn->tree_id = fc.id;
1261 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1262 "TREE of node `%s' is %u\n",
1267 for (i=0;i<fc.tree_array_size;i++)
1269 nsn = fc.tree_array[i];
1273 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1274 "Root of TREE %u is node `%s'\n",
1286 GNUNET_array_grow (fc.tree_array,
1290 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1291 "Done processing TREEs\n");
1296 /* end of fs_namespace.c */