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