2 This file is part of GNUnet.
3 (C) 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/gnunet-service-fs_indexing.c
23 * @brief program that provides indexing functions of the file-sharing service
24 * @author Christian Grothoff
28 #include "gnunet_core_service.h"
29 #include "gnunet_datastore_service.h"
30 #include "gnunet_peer_lib.h"
31 #include "gnunet_protocols.h"
32 #include "gnunet_signatures.h"
33 #include "gnunet_util_lib.h"
34 #include "gnunet-service-fs.h"
35 #include "gnunet-service-fs_indexing.h"
39 * In-memory information about indexed files (also available
46 * This is a linked list.
48 struct IndexInfo *next;
51 * Name of the indexed file. Memory allocated
52 * at the end of this struct (do not free).
57 * Context for transmitting confirmation to client,
58 * NULL if we've done this already.
60 struct GNUNET_SERVER_TransmitContext *tc;
63 * Context for hashing of the file.
65 struct GNUNET_CRYPTO_FileHashContext *fhc;
68 * Hash of the contents of the file.
70 GNUNET_HashCode file_id;
76 * Linked list of indexed files.
78 static struct IndexInfo *indexed_files;
81 * Maps hash over content of indexed files to the respective filename.
82 * The filenames are pointers into the indexed_files linked list and
83 * do not need to be freed.
85 static struct GNUNET_CONTAINER_MultiHashMap *ifm;
90 static const struct GNUNET_CONFIGURATION_Handle *cfg;
93 * Datastore handle. Created and destroyed by code in
94 * gnunet-service-fs (this is an alias).
96 static struct GNUNET_DATASTORE_Handle *dsh;
100 * Write the current index information list to disk.
105 struct GNUNET_BIO_WriteHandle *wh;
107 struct IndexInfo *pos;
110 GNUNET_CONFIGURATION_get_value_filename (cfg, "FS", "INDEXDB", &fn))
112 GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
113 _("Configuration option `%s' in section `%s' missing.\n"),
117 wh = GNUNET_BIO_write_open (fn);
120 GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
121 _("Could not open `%s'.\n"), fn);
129 GNUNET_BIO_write (wh,
131 sizeof (GNUNET_HashCode))) ||
132 (GNUNET_OK != GNUNET_BIO_write_string (wh, pos->filename)))
136 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
138 GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
139 _("Error writing `%s'.\n"), fn);
148 * Read index information from disk.
153 struct GNUNET_BIO_ReadHandle *rh;
155 struct IndexInfo *pos;
162 GNUNET_CONFIGURATION_get_value_filename (cfg, "FS", "INDEXDB", &fn))
164 GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
165 _("Configuration option `%s' in section `%s' missing.\n"),
169 if (GNUNET_NO == GNUNET_DISK_file_test (fn))
171 /* no index info yet */
175 rh = GNUNET_BIO_read_open (fn);
178 GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
179 _("Could not open `%s'.\n"), fn);
185 "Hash of indexed file",
187 sizeof (GNUNET_HashCode))) &&
189 GNUNET_BIO_read_string (rh,
190 "Name of indexed file",
191 &fname, 1024 * 16)) && (fname != NULL))
193 slen = strlen (fname) + 1;
194 pos = GNUNET_malloc (sizeof (struct IndexInfo) + slen);
196 pos->filename = (const char *) &pos[1];
197 memcpy (&pos[1], fname, slen);
199 GNUNET_CONTAINER_multihashmap_put (ifm,
201 (void *) pos->filename,
202 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
208 pos->next = indexed_files;
213 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
220 * We've validated the hash of the file we're about to index. Signal
221 * success to the client and update our internal data structures.
223 * @param ii the index info entry for the request
226 signal_index_ok (struct IndexInfo *ii)
229 GNUNET_CONTAINER_multihashmap_put (ifm,
231 (void *) ii->filename,
232 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
234 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
236 ("Index request received for file `%s' is already indexed as `%s'. Permitting anyway.\n"),
238 (const char *) GNUNET_CONTAINER_multihashmap_get (ifm,
240 GNUNET_SERVER_transmit_context_append_data (ii->tc, NULL, 0,
241 GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK);
242 GNUNET_SERVER_transmit_context_run (ii->tc, GNUNET_TIME_UNIT_MINUTES);
246 ii->next = indexed_files;
249 GNUNET_SERVER_transmit_context_append_data (ii->tc,
251 GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK);
252 GNUNET_SERVER_transmit_context_run (ii->tc, GNUNET_TIME_UNIT_MINUTES);
258 * Function called once the hash computation over an
259 * indexed file has completed.
261 * @param cls closure, our publishing context
262 * @param res resulting hash, NULL on error
265 hash_for_index_val (void *cls, const GNUNET_HashCode * res)
267 struct IndexInfo *ii = cls;
271 (0 != memcmp (res, &ii->file_id, sizeof (GNUNET_HashCode))))
273 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
275 ("Hash mismatch trying to index file `%s' which has hash `%s'\n"),
276 ii->filename, GNUNET_h2s (res));
278 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
279 "Wanted `%s'\n", GNUNET_h2s (&ii->file_id));
281 GNUNET_SERVER_transmit_context_append_data (ii->tc,
283 GNUNET_MESSAGE_TYPE_FS_INDEX_START_FAILED);
284 GNUNET_SERVER_transmit_context_run (ii->tc, GNUNET_TIME_UNIT_MINUTES);
288 signal_index_ok (ii);
293 * Handle INDEX_START-message.
296 * @param client identification of the client
297 * @param message the actual message
300 GNUNET_FS_handle_index_start (void *cls,
301 struct GNUNET_SERVER_Client *client,
302 const struct GNUNET_MessageHeader *message)
304 const struct IndexStartMessage *ism;
307 struct IndexInfo *ii;
314 msize = ntohs (message->size);
315 if ((msize <= sizeof (struct IndexStartMessage)) ||
316 (((const char *) message)[msize - 1] != '\0'))
319 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
322 ism = (const struct IndexStartMessage *) message;
323 if (0 != ism->reserved)
326 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
329 fn = GNUNET_STRINGS_filename_expand ((const char *) &ism[1]);
332 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
335 dev = GNUNET_ntohll (ism->device);
336 ino = GNUNET_ntohll (ism->inode);
337 ism = (const struct IndexStartMessage *) message;
338 slen = strlen (fn) + 1;
339 ii = GNUNET_malloc (sizeof (struct IndexInfo) + slen);
340 ii->filename = (const char *) &ii[1];
341 memcpy (&ii[1], fn, slen);
342 ii->file_id = ism->file_id;
344 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
345 "Received `%s' message for file `%s'\n",
346 "START_INDEX", ii->filename);
349 ii->tc = GNUNET_SERVER_transmit_context_create (client);
354 (GNUNET_OK == GNUNET_DISK_file_get_identifiers (fn,
357 ((dev == mydev) && (ino == myino)))
359 /* fast validation OK! */
360 signal_index_ok (ii);
365 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
366 "Mismatch in file identifiers (%llu != %llu or %u != %u), need to hash.\n",
367 (unsigned long long) ino,
368 (unsigned long long) myino,
369 (unsigned int) dev, (unsigned int) mydev);
371 /* slow validation, need to hash full file (again) */
372 ii->fhc = GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE,
375 &hash_for_index_val, ii);
377 hash_for_index_val (ii, NULL);
383 * Handle INDEX_LIST_GET-message.
386 * @param client identification of the client
387 * @param message the actual message
390 GNUNET_FS_handle_index_list_get (void *cls,
391 struct GNUNET_SERVER_Client *client,
392 const struct GNUNET_MessageHeader *message)
394 struct GNUNET_SERVER_TransmitContext *tc;
395 struct IndexInfoMessage *iim;
396 char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
399 struct IndexInfo *pos;
401 tc = GNUNET_SERVER_transmit_context_create (client);
402 iim = (struct IndexInfoMessage *) buf;
407 slen = strlen (fn) + 1;
408 if (slen + sizeof (struct IndexInfoMessage) >=
409 GNUNET_SERVER_MAX_MESSAGE_SIZE)
414 iim->header.type = htons (GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY);
415 iim->header.size = htons (slen + sizeof (struct IndexInfoMessage));
417 iim->file_id = pos->file_id;
418 memcpy (&iim[1], fn, slen);
419 GNUNET_SERVER_transmit_context_append_message (tc, &iim->header);
422 GNUNET_SERVER_transmit_context_append_data (tc,
424 GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_END);
425 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_MINUTES);
430 * Handle UNINDEX-message.
433 * @param client identification of the client
434 * @param message the actual message
437 GNUNET_FS_handle_unindex (void *cls,
438 struct GNUNET_SERVER_Client *client,
439 const struct GNUNET_MessageHeader *message)
441 const struct UnindexMessage *um;
442 struct IndexInfo *pos;
443 struct IndexInfo *prev;
444 struct IndexInfo *next;
445 struct GNUNET_SERVER_TransmitContext *tc;
448 um = (const struct UnindexMessage *) message;
449 if (0 != um->reserved)
452 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
461 if (0 == memcmp (&pos->file_id, &um->file_id, sizeof (GNUNET_HashCode)))
464 indexed_files = next;
467 GNUNET_break (GNUNET_OK ==
468 GNUNET_CONTAINER_multihashmap_remove (ifm,
482 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
483 "Client requested unindexing of file `%s': %s\n",
484 GNUNET_h2s (&um->file_id), found ? "found" : "not found");
486 if (GNUNET_YES == found)
488 tc = GNUNET_SERVER_transmit_context_create (client);
489 GNUNET_SERVER_transmit_context_append_data (tc,
491 GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK);
492 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_MINUTES);
497 * Continuation called from datastore's remove
501 * @param success did the deletion work?
502 * @param msg error message
505 remove_cont (void *cls, int success, const char *msg)
507 if (GNUNET_OK != success)
508 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
509 _("Failed to delete bogus block: %s\n"), msg);
514 * We've received an on-demand encoded block from the datastore.
515 * Attempt to do on-demand encoding and (if successful), call the
516 * continuation with the resulting block. On error, clean up and ask
517 * the datastore for more results.
519 * @param key key for the content
520 * @param size number of bytes in data
521 * @param data content stored
522 * @param type type of the content
523 * @param priority priority of the content
524 * @param anonymity anonymity-level for the content
525 * @param expiration expiration time for the content
526 * @param uid unique identifier for the datum;
527 * maybe 0 if no unique identifier is available
528 * @param cont function to call with the actual block (at most once, on success)
529 * @param cont_cls closure for cont
530 * @return GNUNET_OK on success
533 GNUNET_FS_handle_on_demand_block (const GNUNET_HashCode * key,
536 enum GNUNET_BLOCK_Type type,
539 struct GNUNET_TIME_Absolute
540 expiration, uint64_t uid,
541 GNUNET_DATASTORE_DatumProcessor cont,
544 const struct OnDemandBlock *odb;
545 GNUNET_HashCode nkey;
546 struct GNUNET_CRYPTO_AesSessionKey skey;
547 struct GNUNET_CRYPTO_AesInitializationVector iv;
548 GNUNET_HashCode query;
550 char ndata[DBLOCK_SIZE];
551 char edata[DBLOCK_SIZE];
553 struct GNUNET_DISK_FileHandle *fh;
556 if (size != sizeof (struct OnDemandBlock))
559 GNUNET_DATASTORE_remove (dsh,
564 GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
565 return GNUNET_SYSERR;
567 odb = (const struct OnDemandBlock *) data;
568 off = GNUNET_ntohll (odb->offset);
569 fn = (const char *) GNUNET_CONTAINER_multihashmap_get (ifm, &odb->file_id);
572 (NULL == (fh = GNUNET_DISK_file_open (fn,
573 GNUNET_DISK_OPEN_READ,
574 GNUNET_DISK_PERM_NONE))) ||
576 GNUNET_DISK_file_seek (fh,
578 GNUNET_DISK_SEEK_SET)) ||
579 (-1 == (nsize = GNUNET_DISK_file_read (fh, ndata, sizeof (ndata)))))
581 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
583 ("Could not access indexed file `%s' (%s) at offset %llu: %s\n"),
584 GNUNET_h2s (&odb->file_id), fn, (unsigned long long) off,
585 (fn == NULL) ? _("not indexed") : STRERROR (errno));
587 GNUNET_DISK_file_close (fh);
588 GNUNET_DATASTORE_remove (dsh,
593 GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
594 return GNUNET_SYSERR;
596 GNUNET_DISK_file_close (fh);
597 GNUNET_CRYPTO_hash (ndata, nsize, &nkey);
598 GNUNET_CRYPTO_hash_to_aes_key (&nkey, &skey, &iv);
599 GNUNET_CRYPTO_aes_encrypt (ndata, nsize, &skey, &iv, edata);
600 GNUNET_CRYPTO_hash (edata, nsize, &query);
601 if (0 != memcmp (&query, key, sizeof (GNUNET_HashCode)))
603 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
604 _("Indexed file `%s' changed at offset %llu\n"),
605 fn, (unsigned long long) off);
606 GNUNET_DATASTORE_remove (dsh,
611 GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
612 return GNUNET_SYSERR;
615 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
616 "On-demand encoded block for query `%s'\n", GNUNET_h2s (key));
622 GNUNET_BLOCK_TYPE_FS_DBLOCK, priority, anonymity, expiration, uid);
628 * Shutdown the module.
631 GNUNET_FS_indexing_done ()
633 struct IndexInfo *pos;
635 GNUNET_CONTAINER_multihashmap_destroy (ifm);
637 while (NULL != (pos = indexed_files))
639 indexed_files = pos->next;
640 if (pos->fhc != NULL)
641 GNUNET_CRYPTO_hash_file_cancel (pos->fhc);
649 * Initialize the indexing submodule.
651 * @param c configuration to use
652 * @param d datastore to use
655 GNUNET_FS_indexing_init (const struct GNUNET_CONFIGURATION_Handle *c,
656 struct GNUNET_DATASTORE_Handle *d)
660 ifm = GNUNET_CONTAINER_multihashmap_create (128);
665 /* end of gnunet-service-fs_indexing.c */