indentation
[oweals/gnunet.git] / src / fs / gnunet-service-fs_indexing.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009, 2010 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21 /**
22  * @file fs/gnunet-service-fs_indexing.c
23  * @brief program that provides indexing functions of the file-sharing service
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
27 #include <float.h>
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"
36 #include "fs.h"
37
38 /**
39  * In-memory information about indexed files (also available
40  * on-disk).
41  */
42 struct IndexInfo
43 {
44
45   /**
46    * This is a linked list.
47    */
48   struct IndexInfo *next;
49
50   /**
51    * Name of the indexed file.  Memory allocated
52    * at the end of this struct (do not free).
53    */
54   const char *filename;
55
56   /**
57    * Context for transmitting confirmation to client,
58    * NULL if we've done this already.
59    */
60   struct GNUNET_SERVER_TransmitContext *tc;
61
62   /**
63    * Context for hashing of the file.
64    */
65   struct GNUNET_CRYPTO_FileHashContext *fhc;
66
67   /**
68    * Hash of the contents of the file.
69    */
70   GNUNET_HashCode file_id;
71
72 };
73
74
75 /**
76  * Linked list of indexed files.
77  */
78 static struct IndexInfo *indexed_files;
79
80 /**
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.
84  */
85 static struct GNUNET_CONTAINER_MultiHashMap *ifm;
86
87 /**
88  * Our configuration.
89  */
90 static const struct GNUNET_CONFIGURATION_Handle *cfg;
91
92 /**
93  * Datastore handle.  Created and destroyed by code in
94  * gnunet-service-fs (this is an alias).
95  */
96 static struct GNUNET_DATASTORE_Handle *dsh;
97
98
99 /**
100  * Write the current index information list to disk.
101  */
102 static void
103 write_index_list ()
104 {
105   struct GNUNET_BIO_WriteHandle *wh;
106   char *fn;
107   struct IndexInfo *pos;
108
109   if (GNUNET_OK !=
110       GNUNET_CONFIGURATION_get_value_filename (cfg, "FS", "INDEXDB", &fn))
111   {
112     GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
113                 _("Configuration option `%s' in section `%s' missing.\n"),
114                 "INDEXDB", "FS");
115     return;
116   }
117   wh = GNUNET_BIO_write_open (fn);
118   if (NULL == wh)
119   {
120     GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
121                 _("Could not open `%s'.\n"), fn);
122     GNUNET_free (fn);
123     return;
124   }
125   pos = indexed_files;
126   while (pos != NULL)
127   {
128     if ((GNUNET_OK !=
129          GNUNET_BIO_write (wh, &pos->file_id, sizeof (GNUNET_HashCode))) ||
130         (GNUNET_OK != GNUNET_BIO_write_string (wh, pos->filename)))
131       break;
132     pos = pos->next;
133   }
134   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
135   {
136     GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
137                 _("Error writing `%s'.\n"), fn);
138     GNUNET_free (fn);
139     return;
140   }
141   GNUNET_free (fn);
142 }
143
144
145 /**
146  * Read index information from disk.
147  */
148 static void
149 read_index_list ()
150 {
151   struct GNUNET_BIO_ReadHandle *rh;
152   char *fn;
153   struct IndexInfo *pos;
154   char *fname;
155   GNUNET_HashCode hc;
156   size_t slen;
157   char *emsg;
158
159   if (GNUNET_OK !=
160       GNUNET_CONFIGURATION_get_value_filename (cfg, "FS", "INDEXDB", &fn))
161   {
162     GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
163                 _("Configuration option `%s' in section `%s' missing.\n"),
164                 "INDEXDB", "FS");
165     return;
166   }
167   if (GNUNET_NO == GNUNET_DISK_file_test (fn))
168   {
169     /* no index info yet */
170     GNUNET_free (fn);
171     return;
172   }
173   rh = GNUNET_BIO_read_open (fn);
174   if (NULL == rh)
175   {
176     GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
177                 _("Could not open `%s'.\n"), fn);
178     GNUNET_free (fn);
179     return;
180   }
181   while ((GNUNET_OK ==
182           GNUNET_BIO_read (rh, "Hash of indexed file", &hc,
183                            sizeof (GNUNET_HashCode))) &&
184          (GNUNET_OK ==
185           GNUNET_BIO_read_string (rh, "Name of indexed file", &fname,
186                                   1024 * 16)) && (fname != NULL))
187   {
188     slen = strlen (fname) + 1;
189     pos = GNUNET_malloc (sizeof (struct IndexInfo) + slen);
190     pos->file_id = hc;
191     pos->filename = (const char *) &pos[1];
192     memcpy (&pos[1], fname, slen);
193     if (GNUNET_SYSERR ==
194         GNUNET_CONTAINER_multihashmap_put (ifm, &hc, (void *) pos->filename,
195                                            GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
196     {
197       GNUNET_free (pos);
198     }
199     else
200     {
201       pos->next = indexed_files;
202       indexed_files = pos;
203     }
204     GNUNET_free (fname);
205   }
206   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
207     GNUNET_free (emsg);
208   GNUNET_free (fn);
209 }
210
211
212 /**
213  * We've validated the hash of the file we're about to index.  Signal
214  * success to the client and update our internal data structures.
215  *
216  * @param ii the index info entry for the request
217  */
218 static void
219 signal_index_ok (struct IndexInfo *ii)
220 {
221   if (GNUNET_SYSERR ==
222       GNUNET_CONTAINER_multihashmap_put (ifm, &ii->file_id,
223                                          (void *) ii->filename,
224                                          GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
225   {
226     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
227                 _
228                 ("Index request received for file `%s' is already indexed as `%s'.  Permitting anyway.\n"),
229                 ii->filename,
230                 (const char *) GNUNET_CONTAINER_multihashmap_get (ifm,
231                                                                   &ii->
232                                                                   file_id));
233     GNUNET_SERVER_transmit_context_append_data (ii->tc, NULL, 0,
234                                                 GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK);
235     GNUNET_SERVER_transmit_context_run (ii->tc, GNUNET_TIME_UNIT_MINUTES);
236     GNUNET_free (ii);
237     return;
238   }
239   ii->next = indexed_files;
240   indexed_files = ii;
241   write_index_list ();
242   GNUNET_SERVER_transmit_context_append_data (ii->tc, NULL, 0,
243                                               GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK);
244   GNUNET_SERVER_transmit_context_run (ii->tc, GNUNET_TIME_UNIT_MINUTES);
245   ii->tc = NULL;
246 }
247
248
249 /**
250  * Function called once the hash computation over an
251  * indexed file has completed.
252  *
253  * @param cls closure, our publishing context
254  * @param res resulting hash, NULL on error
255  */
256 static void
257 hash_for_index_val (void *cls, const GNUNET_HashCode * res)
258 {
259   struct IndexInfo *ii = cls;
260
261   ii->fhc = NULL;
262   if ((res == NULL) ||
263       (0 != memcmp (res, &ii->file_id, sizeof (GNUNET_HashCode))))
264   {
265     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
266                 _
267                 ("Hash mismatch trying to index file `%s' which has hash `%s'\n"),
268                 ii->filename, GNUNET_h2s (res));
269 #if DEBUG_FS
270     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Wanted `%s'\n",
271                 GNUNET_h2s (&ii->file_id));
272 #endif
273     GNUNET_SERVER_transmit_context_append_data (ii->tc, NULL, 0,
274                                                 GNUNET_MESSAGE_TYPE_FS_INDEX_START_FAILED);
275     GNUNET_SERVER_transmit_context_run (ii->tc, GNUNET_TIME_UNIT_MINUTES);
276     GNUNET_free (ii);
277     return;
278   }
279   signal_index_ok (ii);
280 }
281
282
283 /**
284  * Handle INDEX_START-message.
285  *
286  * @param cls closure
287  * @param client identification of the client
288  * @param message the actual message
289  */
290 void
291 GNUNET_FS_handle_index_start (void *cls, struct GNUNET_SERVER_Client *client,
292                               const struct GNUNET_MessageHeader *message)
293 {
294   const struct IndexStartMessage *ism;
295   char *fn;
296   uint16_t msize;
297   struct IndexInfo *ii;
298   size_t slen;
299   uint64_t dev;
300   uint64_t ino;
301   uint64_t mydev;
302   uint64_t myino;
303
304   msize = ntohs (message->size);
305   if ((msize <= sizeof (struct IndexStartMessage)) ||
306       (((const char *) message)[msize - 1] != '\0'))
307   {
308     GNUNET_break (0);
309     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
310     return;
311   }
312   ism = (const struct IndexStartMessage *) message;
313   if (0 != ism->reserved)
314   {
315     GNUNET_break (0);
316     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
317     return;
318   }
319   fn = GNUNET_STRINGS_filename_expand ((const char *) &ism[1]);
320   if (fn == NULL)
321   {
322     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
323     return;
324   }
325   dev = GNUNET_ntohll (ism->device);
326   ino = GNUNET_ntohll (ism->inode);
327   ism = (const struct IndexStartMessage *) message;
328   slen = strlen (fn) + 1;
329   ii = GNUNET_malloc (sizeof (struct IndexInfo) + slen);
330   ii->filename = (const char *) &ii[1];
331   memcpy (&ii[1], fn, slen);
332   ii->file_id = ism->file_id;
333 #if DEBUG_FS
334   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message for file `%s'\n",
335               "START_INDEX", ii->filename);
336 #endif
337
338   ii->tc = GNUNET_SERVER_transmit_context_create (client);
339   mydev = 0;
340   myino = 0;
341   if (((dev != 0) || (ino != 0)) &&
342       (GNUNET_OK == GNUNET_DISK_file_get_identifiers (fn, &mydev, &myino)) &&
343       ((dev == mydev) && (ino == myino)))
344   {
345     /* fast validation OK! */
346     signal_index_ok (ii);
347     GNUNET_free (fn);
348     return;
349   }
350 #if DEBUG_FS
351   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
352               "Mismatch in file identifiers (%llu != %llu or %u != %u), need to hash.\n",
353               (unsigned long long) ino, (unsigned long long) myino,
354               (unsigned int) dev, (unsigned int) mydev);
355 #endif
356   /* slow validation, need to hash full file (again) */
357   ii->fhc =
358       GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, fn,
359                                HASHING_BLOCKSIZE, &hash_for_index_val, ii);
360   if (ii->fhc == NULL)
361     hash_for_index_val (ii, NULL);
362   GNUNET_free (fn);
363 }
364
365
366 /**
367  * Handle INDEX_LIST_GET-message.
368  *
369  * @param cls closure
370  * @param client identification of the client
371  * @param message the actual message
372  */
373 void
374 GNUNET_FS_handle_index_list_get (void *cls, struct GNUNET_SERVER_Client *client,
375                                  const struct GNUNET_MessageHeader *message)
376 {
377   struct GNUNET_SERVER_TransmitContext *tc;
378   struct IndexInfoMessage *iim;
379   char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
380   size_t slen;
381   const char *fn;
382   struct IndexInfo *pos;
383
384   tc = GNUNET_SERVER_transmit_context_create (client);
385   iim = (struct IndexInfoMessage *) buf;
386   pos = indexed_files;
387   while (NULL != pos)
388   {
389     fn = pos->filename;
390     slen = strlen (fn) + 1;
391     if (slen + sizeof (struct IndexInfoMessage) >=
392         GNUNET_SERVER_MAX_MESSAGE_SIZE)
393     {
394       GNUNET_break (0);
395       break;
396     }
397     iim->header.type = htons (GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY);
398     iim->header.size = htons (slen + sizeof (struct IndexInfoMessage));
399     iim->reserved = 0;
400     iim->file_id = pos->file_id;
401     memcpy (&iim[1], fn, slen);
402     GNUNET_SERVER_transmit_context_append_message (tc, &iim->header);
403     pos = pos->next;
404   }
405   GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
406                                               GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_END);
407   GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_MINUTES);
408 }
409
410
411 /**
412  * Handle UNINDEX-message.
413  *
414  * @param cls closure
415  * @param client identification of the client
416  * @param message the actual message
417  */
418 void
419 GNUNET_FS_handle_unindex (void *cls, struct GNUNET_SERVER_Client *client,
420                           const struct GNUNET_MessageHeader *message)
421 {
422   const struct UnindexMessage *um;
423   struct IndexInfo *pos;
424   struct IndexInfo *prev;
425   struct IndexInfo *next;
426   struct GNUNET_SERVER_TransmitContext *tc;
427   int found;
428
429   um = (const struct UnindexMessage *) message;
430   if (0 != um->reserved)
431   {
432     GNUNET_break (0);
433     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
434     return;
435   }
436   found = GNUNET_NO;
437   prev = NULL;
438   pos = indexed_files;
439   while (NULL != pos)
440   {
441     next = pos->next;
442     if (0 == memcmp (&pos->file_id, &um->file_id, sizeof (GNUNET_HashCode)))
443     {
444       if (prev == NULL)
445         indexed_files = next;
446       else
447         prev->next = next;
448       GNUNET_break (GNUNET_OK ==
449                     GNUNET_CONTAINER_multihashmap_remove (ifm, &pos->file_id,
450                                                           (void *) pos->
451                                                           filename));
452       GNUNET_free (pos);
453       found = GNUNET_YES;
454     }
455     else
456     {
457       prev = pos;
458     }
459     pos = next;
460   }
461 #if DEBUG_FS
462   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
463               "Client requested unindexing of file `%s': %s\n",
464               GNUNET_h2s (&um->file_id), found ? "found" : "not found");
465 #endif
466   if (GNUNET_YES == found)
467     write_index_list ();
468   tc = GNUNET_SERVER_transmit_context_create (client);
469   GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
470                                               GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK);
471   GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_MINUTES);
472 }
473
474
475 /**
476  * Continuation called from datastore's remove
477  * function.
478  *
479  * @param cls unused
480  * @param success did the deletion work?
481  * @param msg error message
482  */
483 static void
484 remove_cont (void *cls, int success, const char *msg)
485 {
486   if (GNUNET_OK != success)
487     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
488                 _("Failed to delete bogus block: %s\n"), msg);
489 }
490
491
492 /**
493  * We've received an on-demand encoded block from the datastore.
494  * Attempt to do on-demand encoding and (if successful), call the
495  * continuation with the resulting block.  On error, clean up and ask
496  * the datastore for more results.
497  *
498  * @param key key for the content
499  * @param size number of bytes in data
500  * @param data content stored
501  * @param type type of the content
502  * @param priority priority of the content
503  * @param anonymity anonymity-level for the content
504  * @param expiration expiration time for the content
505  * @param uid unique identifier for the datum;
506  *        maybe 0 if no unique identifier is available
507  * @param cont function to call with the actual block (at most once, on success)
508  * @param cont_cls closure for cont
509  * @return GNUNET_OK on success
510  */
511 int
512 GNUNET_FS_handle_on_demand_block (const GNUNET_HashCode * key, uint32_t size,
513                                   const void *data, enum GNUNET_BLOCK_Type type,
514                                   uint32_t priority, uint32_t anonymity,
515                                   struct GNUNET_TIME_Absolute expiration,
516                                   uint64_t uid,
517                                   GNUNET_DATASTORE_DatumProcessor cont,
518                                   void *cont_cls)
519 {
520   const struct OnDemandBlock *odb;
521   GNUNET_HashCode nkey;
522   struct GNUNET_CRYPTO_AesSessionKey skey;
523   struct GNUNET_CRYPTO_AesInitializationVector iv;
524   GNUNET_HashCode query;
525   ssize_t nsize;
526   char ndata[DBLOCK_SIZE];
527   char edata[DBLOCK_SIZE];
528   const char *fn;
529   struct GNUNET_DISK_FileHandle *fh;
530   uint64_t off;
531
532   if (size != sizeof (struct OnDemandBlock))
533   {
534     GNUNET_break (0);
535     GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1,
536                              GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
537     return GNUNET_SYSERR;
538   }
539   odb = (const struct OnDemandBlock *) data;
540   off = GNUNET_ntohll (odb->offset);
541   fn = (const char *) GNUNET_CONTAINER_multihashmap_get (ifm, &odb->file_id);
542   fh = NULL;
543   if ((NULL == fn) ||
544       (NULL ==
545        (fh =
546         GNUNET_DISK_file_open (fn, GNUNET_DISK_OPEN_READ,
547                                GNUNET_DISK_PERM_NONE))) ||
548       (off != GNUNET_DISK_file_seek (fh, off, GNUNET_DISK_SEEK_SET)) ||
549       (-1 == (nsize = GNUNET_DISK_file_read (fh, ndata, sizeof (ndata)))))
550   {
551     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
552                 _
553                 ("Could not access indexed file `%s' (%s) at offset %llu: %s\n"),
554                 GNUNET_h2s (&odb->file_id), fn, (unsigned long long) off,
555                 (fn == NULL) ? _("not indexed") : STRERROR (errno));
556     if (fh != NULL)
557       GNUNET_DISK_file_close (fh);
558     GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1,
559                              GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
560     return GNUNET_SYSERR;
561   }
562   GNUNET_DISK_file_close (fh);
563   GNUNET_CRYPTO_hash (ndata, nsize, &nkey);
564   GNUNET_CRYPTO_hash_to_aes_key (&nkey, &skey, &iv);
565   GNUNET_CRYPTO_aes_encrypt (ndata, nsize, &skey, &iv, edata);
566   GNUNET_CRYPTO_hash (edata, nsize, &query);
567   if (0 != memcmp (&query, key, sizeof (GNUNET_HashCode)))
568   {
569     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
570                 _("Indexed file `%s' changed at offset %llu\n"), fn,
571                 (unsigned long long) off);
572     GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1,
573                              GNUNET_TIME_UNIT_FOREVER_REL, &remove_cont, NULL);
574     return GNUNET_SYSERR;
575   }
576 #if DEBUG_FS
577   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
578               "On-demand encoded block for query `%s'\n", GNUNET_h2s (key));
579 #endif
580   cont (cont_cls, key, nsize, edata, GNUNET_BLOCK_TYPE_FS_DBLOCK, priority,
581         anonymity, expiration, uid);
582   return GNUNET_OK;
583 }
584
585
586 /**
587  * Shutdown the module.
588  */
589 void
590 GNUNET_FS_indexing_done ()
591 {
592   struct IndexInfo *pos;
593
594   GNUNET_CONTAINER_multihashmap_destroy (ifm);
595   ifm = NULL;
596   while (NULL != (pos = indexed_files))
597   {
598     indexed_files = pos->next;
599     if (pos->fhc != NULL)
600       GNUNET_CRYPTO_hash_file_cancel (pos->fhc);
601     GNUNET_free (pos);
602   }
603   cfg = NULL;
604 }
605
606
607 /**
608  * Initialize the indexing submodule.
609  *
610  * @param c configuration to use
611  * @param d datastore to use
612  */
613 int
614 GNUNET_FS_indexing_init (const struct GNUNET_CONFIGURATION_Handle *c,
615                          struct GNUNET_DATASTORE_Handle *d)
616 {
617   cfg = c;
618   dsh = d;
619   ifm = GNUNET_CONTAINER_multihashmap_create (128);
620   read_index_list ();
621   return GNUNET_OK;
622 }
623
624 /* end of gnunet-service-fs_indexing.c */