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 2, 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 when the tree encoder has
 230  * processed all blocks.  Clean up.
 231  *
 232  * @param cls our unindexing context
 233  * @param tc not used
 234  */
 235 static void
 236 unindex_finish (void *cls,
 237                 const struct GNUNET_SCHEDULER_TaskContext *tc)
 238 {
 239   struct GNUNET_FS_UnindexContext *uc = cls;
 240   char *emsg;
 241   struct GNUNET_FS_Uri *uri;
 242   struct GNUNET_FS_ProgressInfo pi;
 243
 244   GNUNET_FS_tree_encoder_finish (uc->tc,
 245                                  &uri,
 246                                  &emsg);
 247   uc->tc = NULL;
 248   if (uri != NULL)
 249     GNUNET_FS_uri_destroy (uri);
 250   GNUNET_DISK_file_close (uc->fh);
 251   uc->fh = NULL;
 252   GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
 253   uc->dsh = NULL;
 254   if (emsg != NULL)
 255     {
 256       uc->state = UNINDEX_STATE_ERROR;
 257       uc->emsg = emsg;
 258       signal_unindex_error (uc);
 259     }
 260   else
 261     {
 262       uc->state = UNINDEX_STATE_COMPLETE;
 263       pi.status = GNUNET_FS_STATUS_UNINDEX_COMPLETED;
 264       pi.value.unindex.eta = GNUNET_TIME_UNIT_ZERO;
 265       GNUNET_FS_unindex_make_status_ (&pi, uc, uc->file_size);
 266     }
 267   GNUNET_FS_unindex_sync_ (uc);
 268 }
 269
 270
 271 /**
 272  * Function called with the response from the
 273  * FS service to our unindexing request.
 274  *
 275  * @param cls closure, unindex context
 276  * @param msg NULL on timeout, otherwise the response
 277  */
 278 static void
 279 process_fs_response (void *cls,
 280                      const struct GNUNET_MessageHeader *msg)
 281 {
 282   struct GNUNET_FS_UnindexContext *uc = cls;
 283
 284   if (uc->client != NULL)
 285     {
 286       GNUNET_CLIENT_disconnect (uc->client, GNUNET_NO);
 287       uc->client = NULL;
 288     }
 289   if (uc->state != UNINDEX_STATE_FS_NOTIFY)
 290     {
 291       uc->state = UNINDEX_STATE_ERROR;
 292       uc->emsg = GNUNET_strdup (_("Unexpected time for a response from `fs' service."));
 293       GNUNET_FS_unindex_sync_ (uc);
 294       signal_unindex_error (uc);
 295       return;
 296     }
 297   if (NULL == msg)
 298     {
 299       uc->state = UNINDEX_STATE_ERROR;
 300       uc->emsg = GNUNET_strdup (_("Timeout waiting for `fs' service."));
 301       GNUNET_FS_unindex_sync_ (uc);
 302       signal_unindex_error (uc);
 303       return;
 304     }
 305   if (ntohs(msg->type) != GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK)
 306     {
 307       uc->state = UNINDEX_STATE_ERROR;
 308       uc->emsg = GNUNET_strdup (_("Invalid response from `fs' service."));
 309       GNUNET_FS_unindex_sync_ (uc);
 310       signal_unindex_error (uc);
 311       return;
 312     }
 313   uc->state = UNINDEX_STATE_DS_REMOVE;
 314   GNUNET_FS_unindex_sync_ (uc);
 315   GNUNET_FS_unindex_do_remove_ (uc);
 316 }
 317
 318
 319 /**
 320  * Connect to the datastore and remove the blocks.
 321  *
 322  * @param uc context for the unindex operation.
 323  */
 324 void
 325 GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc)
 326 {
 327   uc->dsh = GNUNET_DATASTORE_connect (uc->h->cfg,
 328                                       uc->h->sched);
 329   if (NULL == uc->dsh)
 330     {
 331       uc->state = UNINDEX_STATE_ERROR;
 332       uc->emsg = GNUNET_strdup (_("Failed to connect to `datastore' service."));
 333       GNUNET_FS_unindex_sync_ (uc);
 334       signal_unindex_error (uc);
 335       return;
 336     }
 337   uc->fh = GNUNET_DISK_file_open (uc->filename,
 338                                   GNUNET_DISK_OPEN_READ,
 339                                   GNUNET_DISK_PERM_NONE);
 340   if (NULL == uc->fh)
 341     {
 342       GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
 343       uc->dsh = NULL;
 344       uc->state = UNINDEX_STATE_ERROR;
 345       uc->emsg = GNUNET_strdup (_("Failed to open file for unindexing."));
 346       GNUNET_FS_unindex_sync_ (uc);
 347       signal_unindex_error (uc);
 348       return;
 349     }
 350   uc->tc = GNUNET_FS_tree_encoder_create (uc->h,
 351                                           uc->file_size,
 352                                           uc,
 353                                           &unindex_reader,
 354                                           &unindex_process,
 355                                           &unindex_progress,
 356                                           &unindex_finish);
 357   GNUNET_FS_tree_encoder_next (uc->tc);
 358 }
 359
 360
 361 /**
 362  * Function called once the hash of the file
 363  * that is being unindexed has been computed.
 364  *
 365  * @param cls closure, unindex context
 366  * @param file_id computed hash, NULL on error
 367  */
 368 void
 369 GNUNET_FS_unindex_process_hash_ (void *cls,
 370                                  const GNUNET_HashCode *file_id)
 371 {
 372   struct GNUNET_FS_UnindexContext *uc = cls;
 373   struct UnindexMessage req;
 374
 375   uc->fhc = NULL;
 376   if (uc->state != UNINDEX_STATE_HASHING)
 377     {
 378       GNUNET_FS_unindex_stop (uc);
 379       return;
 380     }
 381   if (file_id == NULL)
 382     {
 383       uc->state = UNINDEX_STATE_ERROR;
 384       uc->emsg = GNUNET_strdup (_("Failed to compute hash of file."));
 385       GNUNET_FS_unindex_sync_ (uc);
 386       signal_unindex_error (uc);
 387       return;
 388     }
 389   uc->file_id = *file_id;
 390   uc->state = UNINDEX_STATE_FS_NOTIFY;
 391   GNUNET_FS_unindex_sync_ (uc);
 392   uc->client = GNUNET_CLIENT_connect (uc->h->sched,
 393                                       "fs",
 394                                       uc->h->cfg);
 395   req.header.size = htons (sizeof (struct UnindexMessage));
 396   req.header.type = htons (GNUNET_MESSAGE_TYPE_FS_UNINDEX);
 397   req.reserved = 0;
 398   req.file_id = *file_id;
 399   GNUNET_break (GNUNET_OK ==
 400                 GNUNET_CLIENT_transmit_and_get_response (uc->client,
 401                                                          &req.header,
 402                                                          GNUNET_CONSTANTS_SERVICE_TIMEOUT,
 403                                                          GNUNET_YES,
 404                                                          &process_fs_response,
 405                                                          uc));
 406 }
 407
 408
 409 /**
 410  * Create SUSPEND event for the given unindex operation
 411  * and then clean up our state (without stop signal).
 412  *
 413  * @param cls the 'struct GNUNET_FS_UnindexContext' to signal for
 414  */
 415 void
 416 GNUNET_FS_unindex_signal_suspend_ (void *cls)
 417 {
 418   struct GNUNET_FS_UnindexContext *uc = cls;
 419   struct GNUNET_FS_ProgressInfo pi;
 420
 421   if (uc->fhc != NULL)
 422     {
 423       GNUNET_CRYPTO_hash_file_cancel (uc->fhc);
 424       uc->fhc = NULL;
 425     }
 426   if (uc->client != NULL)
 427     {
 428       GNUNET_CLIENT_disconnect (uc->client, GNUNET_NO);
 429       uc->client = NULL;
 430     }
 431   if (NULL != uc->dsh)
 432     {
 433       GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
 434       uc->dsh = NULL;
 435     }
 436   if (NULL != uc->tc)
 437     {
 438       GNUNET_FS_tree_encoder_finish (uc->tc,
 439                                      NULL,
 440                                      NULL);
 441       uc->tc = NULL;
 442     }
 443   if (uc->fh != NULL)
 444     {
 445       GNUNET_DISK_file_close (uc->fh);
 446       uc->fh = NULL;
 447     }
 448   GNUNET_FS_end_top (uc->h, uc->top);
 449   pi.status = GNUNET_FS_STATUS_UNINDEX_SUSPEND;
 450   GNUNET_FS_unindex_make_status_ (&pi, uc,
 451                                   (uc->state == UNINDEX_STATE_COMPLETE)
 452                                   ? uc->file_size : 0);
 453   GNUNET_break (NULL == uc->client_info);
 454   GNUNET_free (uc->filename);
 455   GNUNET_free_non_null (uc->serialization);
 456   GNUNET_free (uc);
 457 }
 458
 459
 460 /**
 461  * Unindex a file.
 462  *
 463  * @param h handle to the file sharing subsystem
 464  * @param filename file to unindex
 465  * @param cctx initial value for the client context
 466  * @return NULL on error, otherwise handle
 467  */
 468 struct GNUNET_FS_UnindexContext *
 469 GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h,
 470                          const char *filename,
 471                          void *cctx)
 472 {
 473   struct GNUNET_FS_UnindexContext *ret;
 474   struct GNUNET_FS_ProgressInfo pi;
 475   uint64_t size;
 476
 477   if (GNUNET_OK !=
 478       GNUNET_DISK_file_size (filename,
 479                              &size,
 480                              GNUNET_YES))
 481     return NULL;
 482   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
 483   ret->h = h;
 484   ret->filename = GNUNET_strdup (filename);
 485   ret->start_time = GNUNET_TIME_absolute_get ();
 486   ret->file_size = size;
 487   ret->client_info = cctx;
 488   GNUNET_FS_unindex_sync_ (ret);
 489   pi.status = GNUNET_FS_STATUS_UNINDEX_START;
 490   pi.value.unindex.eta = GNUNET_TIME_UNIT_FOREVER_REL;
 491   GNUNET_FS_unindex_make_status_ (&pi, ret, 0);
 492   ret->fhc = GNUNET_CRYPTO_hash_file (h->sched,
 493                                       GNUNET_SCHEDULER_PRIORITY_IDLE,
 494                                       filename,
 495                                       HASHING_BLOCKSIZE,
 496                                       &GNUNET_FS_unindex_process_hash_,
 497                                       ret);
 498   ret->top = GNUNET_FS_make_top (h,
 499                                  &GNUNET_FS_unindex_signal_suspend_,
 500                                  ret);
 501   return ret;
 502 }
 503
 504
 505 /**
 506  * Clean up after completion of an unindex operation.
 507  *
 508  * @param uc handle
 509  */
 510 void
 511 GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc)
 512 {
 513   struct GNUNET_FS_ProgressInfo pi;
 514
 515   if (uc->fhc != NULL)
 516     {
 517       GNUNET_CRYPTO_hash_file_cancel (uc->fhc);
 518       uc->fhc = NULL;
 519     }
 520   if (uc->client != NULL)
 521     {
 522       GNUNET_CLIENT_disconnect (uc->client, GNUNET_NO);
 523       uc->client = NULL;
 524     }
 525   if (NULL != uc->dsh)
 526     {
 527       GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
 528       uc->dsh = NULL;
 529     }
 530   if (NULL != uc->tc)
 531     {
 532       GNUNET_FS_tree_encoder_finish (uc->tc,
 533                                      NULL,
 534                                      NULL);
 535       uc->tc = NULL;
 536     }
 537   if (uc->fh != NULL)
 538     {
 539       GNUNET_DISK_file_close (uc->fh);
 540       uc->fh = NULL;
 541     }
 542   GNUNET_FS_end_top (uc->h, uc->top);
 543   if (uc->serialization != NULL)
 544     {
 545       GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, uc->serialization);
 546       GNUNET_free (uc->serialization);
 547       uc->serialization = NULL;
 548     }
 549   pi.status = GNUNET_FS_STATUS_UNINDEX_STOPPED;
 550   pi.value.unindex.eta = GNUNET_TIME_UNIT_ZERO;
 551   GNUNET_FS_unindex_make_status_ (&pi, uc,
 552                                   (uc->state == UNINDEX_STATE_COMPLETE)
 553                                   ? uc->file_size : 0);
 554   GNUNET_break (NULL == uc->client_info);
 555   GNUNET_free (uc->filename);
 556   GNUNET_free (uc);
 557 }
 558
 559 /* end of fs_unindex.c */