src/fs/fs_unindex.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2003, 2004, 2006, 2009 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/fs_unindex.c
  23  * @author Krista Grothoff
  24  * @author Christian Grothoff
  25  * @brief Unindex file.
  26  */
  27 #include "platform.h"
  28 #include "gnunet_constants.h"
  29 #include "gnunet_fs_service.h"
  30 #include "gnunet_protocols.h"
  31 #include "fs.h"
  32 #include "fs_tree.h"
  33
  34
  35 /**
  36  * Function called by the tree encoder to obtain
  37  * a block of plaintext data (for the lowest level
  38  * of the tree).
  39  *
  40  * @param cls our publishing context
  41  * @param offset identifies which block to get
  42  * @param max (maximum) number of bytes to get; returning
  43  *        fewer will also cause errors
  44  * @param buf where to copy the plaintext buffer
  45  * @param emsg location to store an error message (on error)
  46  * @return number of bytes copied to buf, 0 on error
  47  */
  48 static size_t
  49 unindex_reader (void *cls,
  50                 uint64_t offset,
  51                 size_t max,
  52                 void *buf,
  53                 char **emsg)
  54 {
  55   struct GNUNET_FS_UnindexContext *uc = cls;
  56   size_t pt_size;
  57
  58   pt_size = GNUNET_MIN(max,
  59                        uc->file_size - offset);
  60   if (offset !=
  61       GNUNET_DISK_file_seek (uc->fh, offset, GNUNET_DISK_SEEK_SET))
  62     {
  63       *emsg = GNUNET_strdup (_("Failed to find given position in file"));
  64       return 0;
  65     }
  66   if (pt_size !=
  67       GNUNET_DISK_file_read (uc->fh,
  68                              buf,
  69                              pt_size))
  70     {
  71       *emsg = GNUNET_strdup (_("Failed to read file"));
  72       return 0;
  73     }
  74   return pt_size;
  75 }
  76
  77
  78 /**
  79  * Fill in all of the generic fields for
  80  * an unindex event and call the callback.
  81  *
  82  * @param pi structure to fill in
  83  * @param uc overall unindex context
  84  * @param offset where we are in the file (for progress)
  85  */
  86 void
  87 GNUNET_FS_unindex_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
  88                                 struct GNUNET_FS_UnindexContext *uc,
  89                                 uint64_t offset)
  90 {
  91   pi->value.unindex.uc = uc;
  92   pi->value.unindex.cctx = uc->client_info;
  93   pi->value.unindex.filename = uc->filename;
  94   pi->value.unindex.size = uc->file_size;
  95   pi->value.unindex.eta
  96     = GNUNET_TIME_calculate_eta (uc->start_time,
  97                                  offset,
  98                                  uc->file_size);
  99   pi->value.unindex.duration = GNUNET_TIME_absolute_get_duration (uc->start_time);
 100   pi->value.unindex.completed = offset;
 101   uc->client_info
 102     = uc->h->upcb (uc->h->upcb_cls,
 103                    pi);
 104
 105 }
 106
 107
 108 /**
 109  * Function called with information about our
 110  * progress in computing the tree encoding.
 111  *
 112  * @param cls closure
 113  * @param offset where are we in the file
 114  * @param pt_block plaintext of the currently processed block
 115  * @param pt_size size of pt_block
 116  * @param depth depth of the block in the tree
 117  */
 118 static void
 119 unindex_progress (void *cls,
 120                   uint64_t offset,
 121                   const void *pt_block,
 122                   size_t pt_size,
 123                   unsigned int depth)
 124 {
 125   struct GNUNET_FS_UnindexContext *uc = cls;
 126   struct GNUNET_FS_ProgressInfo pi;
 127
 128   pi.status = GNUNET_FS_STATUS_UNINDEX_PROGRESS;
 129   pi.value.unindex.specifics.progress.data = pt_block;
 130   pi.value.unindex.specifics.progress.offset = offset;
 131   pi.value.unindex.specifics.progress.data_len = pt_size;
 132   pi.value.unindex.specifics.progress.depth = depth;
 133   GNUNET_FS_unindex_make_status_ (&pi, uc, offset);
 134 }
 135
 136
 137 /**
 138  * We've encountered an error during
 139  * unindexing.  Signal the client.
 140  *
 141  * @param uc context for the failed unindexing operation
 142  */
 143 static void
 144 signal_unindex_error (struct GNUNET_FS_UnindexContext *uc)
 145 {
 146   struct GNUNET_FS_ProgressInfo pi;
 147
 148   pi.status = GNUNET_FS_STATUS_UNINDEX_ERROR;
 149   pi.value.unindex.eta = GNUNET_TIME_UNIT_FOREVER_REL;
 150   pi.value.unindex.specifics.error.message = uc->emsg;
 151   GNUNET_FS_unindex_make_status_ (&pi, uc, 0);
 152 }
 153
 154
 155 /**
 156  * Continuation called to notify client about result of the
 157  * datastore removal operation.
 158  *
 159  * @param cls closure
 160  * @param success GNUNET_SYSERR on failure
 161  * @param msg NULL on success, otherwise an error message
 162  */
 163 static void
 164 process_cont (void *cls,
 165               int success,
 166               const char *msg)
 167 {
 168   struct GNUNET_FS_UnindexContext *uc = cls;
 169   if (success == GNUNET_SYSERR)
 170     {
 171       uc->emsg = GNUNET_strdup (msg);
 172       signal_unindex_error (uc);
 173       return;
 174     }
 175   GNUNET_FS_tree_encoder_next (uc->tc);
 176 }
 177
 178
 179 /**
 180  * Function called asking for the current (encoded)
 181  * block to be processed.  After processing the
 182  * client should either call "GNUNET_FS_tree_encode_next"
 183  * or (on error) "GNUNET_FS_tree_encode_finish".
 184  *
 185  * @param cls closure
 186  * @param query the query for the block (key for lookup in the datastore)
 187  * @param offset offset of the block
 188  * @param type type of the block (IBLOCK or DBLOCK)
 189  * @param block the (encrypted) block
 190  * @param block_size size of block (in bytes)
 191  */
 192 static void
 193 unindex_process (void *cls,
 194                  const GNUNET_HashCode *query,
 195                  uint64_t offset,
 196                  enum GNUNET_BLOCK_Type type,
 197                  const void *block,
 198                  uint16_t block_size)
 199 {
 200   struct GNUNET_FS_UnindexContext *uc = cls;
 201   uint32_t size;
 202   const void *data;
 203   struct OnDemandBlock odb;
 204
 205   if (type != GNUNET_BLOCK_TYPE_DBLOCK)
 206     {
 207       size = block_size;
 208       data = block;
 209     }
 210   else /* on-demand encoded DBLOCK */
 211     {
 212       size = sizeof(struct OnDemandBlock);
 213       odb.offset = GNUNET_htonll (offset);
 214       odb.file_id = uc->file_id;
 215       data = &odb;
 216     }
 217   GNUNET_DATASTORE_remove (uc->dsh,
 218                            query,
 219                            size,
 220                            data,
 221                            -2, 1,
 222                            GNUNET_CONSTANTS_SERVICE_TIMEOUT,
 223                            &process_cont,
 224                            uc);
 225 }
 226
 227
 228 /**
 229  * Function called with the response from the
 230  * FS service to our unindexing request.
 231  *
 232  * @param cls closure, unindex context
 233  * @param msg NULL on timeout, otherwise the response
 234  */
 235 static void
 236 process_fs_response (void *cls,
 237                      const struct GNUNET_MessageHeader *msg)
 238 {
 239   struct GNUNET_FS_UnindexContext *uc = cls;
 240   struct GNUNET_FS_ProgressInfo pi;
 241
 242   if (uc->client != NULL)
 243     {
 244       GNUNET_CLIENT_disconnect (uc->client, GNUNET_NO);
 245       uc->client = NULL;
 246     }
 247   if (uc->state != UNINDEX_STATE_FS_NOTIFY)
 248     {
 249       uc->state = UNINDEX_STATE_ERROR;
 250       uc->emsg = GNUNET_strdup (_("Unexpected time for a response from `fs' service."));
 251       GNUNET_FS_unindex_sync_ (uc);
 252       signal_unindex_error (uc);
 253       return;
 254     }
 255   if (NULL == msg)
 256     {
 257       uc->state = UNINDEX_STATE_ERROR;
 258       uc->emsg = GNUNET_strdup (_("Timeout waiting for `fs' service."));
 259       GNUNET_FS_unindex_sync_ (uc);
 260       signal_unindex_error (uc);
 261       return;
 262     }
 263   if (ntohs(msg->type) != GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK)
 264     {
 265       uc->state = UNINDEX_STATE_ERROR;
 266       uc->emsg = GNUNET_strdup (_("Invalid response from `fs' service."));
 267       GNUNET_FS_unindex_sync_ (uc);
 268       signal_unindex_error (uc);
 269       return;
 270     }
 271   uc->state = UNINDEX_STATE_COMPLETE;
 272   pi.status = GNUNET_FS_STATUS_UNINDEX_COMPLETED;
 273   pi.value.unindex.eta = GNUNET_TIME_UNIT_ZERO;
 274   GNUNET_FS_unindex_sync_ (uc);
 275   GNUNET_FS_unindex_make_status_ (&pi, uc, uc->file_size);
 276 }
 277
 278
 279 /**
 280  * Function called when the tree encoder has
 281  * processed all blocks.  Clean up.
 282  *
 283  * @param cls our unindexing context
 284  * @param tc not used
 285  */
 286 static void
 287 unindex_finish (void *cls,
 288                 const struct GNUNET_SCHEDULER_TaskContext *tc)
 289 {
 290   struct GNUNET_FS_UnindexContext *uc = cls;
 291   char *emsg;
 292   struct GNUNET_FS_Uri *uri;
 293   struct UnindexMessage req;
 294
 295   /* generate final progress message */
 296   unindex_progress (uc,
 297                     uc->file_size,
 298                     NULL,
 299                     0, 0);
 300   GNUNET_FS_tree_encoder_finish (uc->tc,
 301                                  &uri,
 302                                  &emsg);
 303   uc->tc = NULL;
 304   if (uri != NULL)
 305     GNUNET_FS_uri_destroy (uri);
 306   GNUNET_DISK_file_close (uc->fh);
 307   uc->fh = NULL;
 308   GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
 309   uc->dsh = NULL;
 310   uc->state = UNINDEX_STATE_FS_NOTIFY;
 311   GNUNET_FS_unindex_sync_ (uc);
 312   uc->client = GNUNET_CLIENT_connect (uc->h->sched,
 313                                       "fs",
 314                                       uc->h->cfg);
 315   if (uc->client == NULL)
 316     {
 317       uc->state = UNINDEX_STATE_ERROR;
 318       uc->emsg = GNUNET_strdup (_("Failed to connect to FS service for unindexing."));
 319       GNUNET_FS_unindex_sync_ (uc);
 320       signal_unindex_error (uc);
 321       return;
 322     }
 323   req.header.size = htons (sizeof (struct UnindexMessage));
 324   req.header.type = htons (GNUNET_MESSAGE_TYPE_FS_UNINDEX);
 325   req.reserved = 0;
 326   req.file_id = uc->file_id;
 327   GNUNET_break (GNUNET_OK ==
 328                 GNUNET_CLIENT_transmit_and_get_response (uc->client,
 329                                                          &req.header,
 330                                                          GNUNET_CONSTANTS_SERVICE_TIMEOUT,
 331                                                          GNUNET_YES,
 332                                                          &process_fs_response,
 333                                                          uc));
 334 }
 335
 336
 337 /**
 338  * Connect to the datastore and remove the blocks.
 339  *
 340  * @param uc context for the unindex operation.
 341  */
 342 void
 343 GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc)
 344 {
 345   uc->dsh = GNUNET_DATASTORE_connect (uc->h->cfg,
 346                                       uc->h->sched);
 347   if (NULL == uc->dsh)
 348     {
 349       uc->state = UNINDEX_STATE_ERROR;
 350       uc->emsg = GNUNET_strdup (_("Failed to connect to `datastore' service."));
 351       GNUNET_FS_unindex_sync_ (uc);
 352       signal_unindex_error (uc);
 353       return;
 354     }
 355   uc->fh = GNUNET_DISK_file_open (uc->filename,
 356                                   GNUNET_DISK_OPEN_READ,
 357                                   GNUNET_DISK_PERM_NONE);
 358   if (NULL == uc->fh)
 359     {
 360       GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
 361       uc->dsh = NULL;
 362       uc->state = UNINDEX_STATE_ERROR;
 363       uc->emsg = GNUNET_strdup (_("Failed to open file for unindexing."));
 364       GNUNET_FS_unindex_sync_ (uc);
 365       signal_unindex_error (uc);
 366       return;
 367     }
 368   uc->tc = GNUNET_FS_tree_encoder_create (uc->h,
 369                                           uc->file_size,
 370                                           uc,
 371                                           &unindex_reader,
 372                                           &unindex_process,
 373                                           &unindex_progress,
 374                                           &unindex_finish);
 375   GNUNET_FS_tree_encoder_next (uc->tc);
 376 }
 377
 378
 379 /**
 380  * Function called once the hash of the file
 381  * that is being unindexed has been computed.
 382  *
 383  * @param cls closure, unindex context
 384  * @param file_id computed hash, NULL on error
 385  */
 386 void
 387 GNUNET_FS_unindex_process_hash_ (void *cls,
 388                                  const GNUNET_HashCode *file_id)
 389 {
 390   struct GNUNET_FS_UnindexContext *uc = cls;
 391
 392   uc->fhc = NULL;
 393   if (uc->state != UNINDEX_STATE_HASHING)
 394     {
 395       GNUNET_FS_unindex_stop (uc);
 396       return;
 397     }
 398   if (file_id == NULL)
 399     {
 400       uc->state = UNINDEX_STATE_ERROR;
 401       uc->emsg = GNUNET_strdup (_("Failed to compute hash of file."));
 402       GNUNET_FS_unindex_sync_ (uc);
 403       signal_unindex_error (uc);
 404       return;
 405     }
 406   uc->file_id = *file_id;
 407   uc->state = UNINDEX_STATE_DS_REMOVE;
 408   GNUNET_FS_unindex_sync_ (uc);
 409   GNUNET_FS_unindex_do_remove_ (uc);
 410 }
 411
 412
 413 /**
 414  * Create SUSPEND event for the given unindex operation
 415  * and then clean up our state (without stop signal).
 416  *
 417  * @param cls the 'struct GNUNET_FS_UnindexContext' to signal for
 418  */
 419 void
 420 GNUNET_FS_unindex_signal_suspend_ (void *cls)
 421 {
 422   struct GNUNET_FS_UnindexContext *uc = cls;
 423   struct GNUNET_FS_ProgressInfo pi;
 424
 425   if (uc->fhc != NULL)
 426     {
 427       GNUNET_CRYPTO_hash_file_cancel (uc->fhc);
 428       uc->fhc = NULL;
 429     }
 430   if (uc->client != NULL)
 431     {
 432       GNUNET_CLIENT_disconnect (uc->client, GNUNET_NO);
 433       uc->client = NULL;
 434     }
 435   if (NULL != uc->dsh)
 436     {
 437       GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
 438       uc->dsh = NULL;
 439     }
 440   if (NULL != uc->tc)
 441     {
 442       GNUNET_FS_tree_encoder_finish (uc->tc,
 443                                      NULL,
 444                                      NULL);
 445       uc->tc = NULL;
 446     }
 447   if (uc->fh != NULL)
 448     {
 449       GNUNET_DISK_file_close (uc->fh);
 450       uc->fh = NULL;
 451     }
 452   GNUNET_FS_end_top (uc->h, uc->top);
 453   pi.status = GNUNET_FS_STATUS_UNINDEX_SUSPEND;
 454   GNUNET_FS_unindex_make_status_ (&pi, uc,
 455                                   (uc->state == UNINDEX_STATE_COMPLETE)
 456                                   ? uc->file_size : 0);
 457   GNUNET_break (NULL == uc->client_info);
 458   GNUNET_free (uc->filename);
 459   GNUNET_free_non_null (uc->serialization);
 460   GNUNET_free (uc);
 461 }
 462
 463
 464 /**
 465  * Unindex a file.
 466  *
 467  * @param h handle to the file sharing subsystem
 468  * @param filename file to unindex
 469  * @param cctx initial value for the client context
 470  * @return NULL on error, otherwise handle
 471  */
 472 struct GNUNET_FS_UnindexContext *
 473 GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h,
 474                          const char *filename,
 475                          void *cctx)
 476 {
 477   struct GNUNET_FS_UnindexContext *ret;
 478   struct GNUNET_FS_ProgressInfo pi;
 479   uint64_t size;
 480
 481   if (GNUNET_OK !=
 482       GNUNET_DISK_file_size (filename,
 483                              &size,
 484                              GNUNET_YES))
 485     return NULL;
 486   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
 487   ret->h = h;
 488   ret->filename = GNUNET_strdup (filename);
 489   ret->start_time = GNUNET_TIME_absolute_get ();
 490   ret->file_size = size;
 491   ret->client_info = cctx;
 492   GNUNET_FS_unindex_sync_ (ret);
 493   pi.status = GNUNET_FS_STATUS_UNINDEX_START;
 494   pi.value.unindex.eta = GNUNET_TIME_UNIT_FOREVER_REL;
 495   GNUNET_FS_unindex_make_status_ (&pi, ret, 0);
 496   ret->fhc = GNUNET_CRYPTO_hash_file (h->sched,
 497                                       GNUNET_SCHEDULER_PRIORITY_IDLE,
 498                                       filename,
 499                                       HASHING_BLOCKSIZE,
 500                                       &GNUNET_FS_unindex_process_hash_,
 501                                       ret);
 502   ret->top = GNUNET_FS_make_top (h,
 503                                  &GNUNET_FS_unindex_signal_suspend_,
 504                                  ret);
 505   return ret;
 506 }
 507
 508
 509 /**
 510  * Clean up after completion of an unindex operation.
 511  *
 512  * @param uc handle
 513  */
 514 void
 515 GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc)
 516 {
 517   struct GNUNET_FS_ProgressInfo pi;
 518
 519   if (uc->fhc != NULL)
 520     {
 521       GNUNET_CRYPTO_hash_file_cancel (uc->fhc);
 522       uc->fhc = NULL;
 523     }
 524   if (uc->client != NULL)
 525     {
 526       GNUNET_CLIENT_disconnect (uc->client, GNUNET_NO);
 527       uc->client = NULL;
 528     }
 529   if (NULL != uc->dsh)
 530     {
 531       GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
 532       uc->dsh = NULL;
 533     }
 534   if (NULL != uc->tc)
 535     {
 536       GNUNET_FS_tree_encoder_finish (uc->tc,
 537                                      NULL,
 538                                      NULL);
 539       uc->tc = NULL;
 540     }
 541   if (uc->fh != NULL)
 542     {
 543       GNUNET_DISK_file_close (uc->fh);
 544       uc->fh = NULL;
 545     }
 546   GNUNET_FS_end_top (uc->h, uc->top);
 547   if (uc->serialization != NULL)
 548     {
 549       GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, uc->serialization);
 550       GNUNET_free (uc->serialization);
 551       uc->serialization = NULL;
 552     }
 553   pi.status = GNUNET_FS_STATUS_UNINDEX_STOPPED;
 554   pi.value.unindex.eta = GNUNET_TIME_UNIT_ZERO;
 555   GNUNET_FS_unindex_make_status_ (&pi, uc,
 556                                   (uc->state == UNINDEX_STATE_COMPLETE)
 557                                   ? uc->file_size : 0);
 558   GNUNET_break (NULL == uc->client_info);
 559   GNUNET_free (uc->filename);
 560   GNUNET_free (uc);
 561 }
 562
 563 /* end of fs_unindex.c */