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  * @param emsg the error message
 143  */
 144 static void
 145 signal_unindex_error (struct GNUNET_FS_UnindexContext *uc,
 146                       const char *emsg)
 147 {
 148   struct GNUNET_FS_ProgressInfo pi;
 149
 150   pi.status = GNUNET_FS_STATUS_UNINDEX_ERROR;
 151   pi.value.unindex.eta = GNUNET_TIME_UNIT_FOREVER_REL;
 152   pi.value.unindex.specifics.error.message = emsg;
 153   GNUNET_FS_unindex_make_status_ (&pi, uc, 0);
 154 }
 155
 156
 157 /**
 158  * Continuation called to notify client about result of the
 159  * datastore removal operation.
 160  *
 161  * @param cls closure
 162  * @param success GNUNET_SYSERR on failure
 163  * @param msg NULL on success, otherwise an error message
 164  */
 165 static void
 166 process_cont (void *cls,
 167               int success,
 168               const char *msg)
 169 {
 170   struct GNUNET_FS_UnindexContext *uc = cls;
 171   if (success == GNUNET_SYSERR)
 172     {
 173       signal_unindex_error (uc,
 174                             msg);
 175       return;
 176     }
 177
 178   GNUNET_FS_tree_encoder_next (uc->tc);
 179 }
 180
 181
 182 /**
 183  * Function called asking for the current (encoded)
 184  * block to be processed.  After processing the
 185  * client should either call "GNUNET_FS_tree_encode_next"
 186  * or (on error) "GNUNET_FS_tree_encode_finish".
 187  *
 188  * @param cls closure
 189  * @param query the query for the block (key for lookup in the datastore)
 190  * @param offset offset of the block
 191  * @param type type of the block (IBLOCK or DBLOCK)
 192  * @param block the (encrypted) block
 193  * @param block_size size of block (in bytes)
 194  */
 195 static void
 196 unindex_process (void *cls,
 197                  const GNUNET_HashCode *query,
 198                  uint64_t offset,
 199                  enum GNUNET_BLOCK_Type type,
 200                  const void *block,
 201                  uint16_t block_size)
 202 {
 203   struct GNUNET_FS_UnindexContext *uc = cls;
 204   uint32_t size;
 205   const void *data;
 206   struct OnDemandBlock odb;
 207
 208   if (type != GNUNET_BLOCK_TYPE_DBLOCK)
 209     {
 210       size = block_size;
 211       data = block;
 212     }
 213   else /* on-demand encoded DBLOCK */
 214     {
 215       size = sizeof(struct OnDemandBlock);
 216       odb.offset = GNUNET_htonll (offset);
 217       odb.file_id = uc->file_id;
 218       data = &odb;
 219     }
 220   GNUNET_DATASTORE_remove (uc->dsh,
 221                            query,
 222                            size,
 223                            data,
 224                            &process_cont,
 225                            uc,
 226                            GNUNET_CONSTANTS_SERVICE_TIMEOUT);
 227 }
 228
 229
 230 /**
 231  * Function called when the tree encoder has
 232  * processed all blocks.  Clean up.
 233  *
 234  * @param cls our unindexing context
 235  * @param tc not used
 236  */
 237 static void
 238 unindex_finish (void *cls,
 239                 const struct GNUNET_SCHEDULER_TaskContext *tc)
 240 {
 241   struct GNUNET_FS_UnindexContext *uc = cls;
 242   char *emsg;
 243   struct GNUNET_FS_Uri *uri;
 244   struct GNUNET_FS_ProgressInfo pi;
 245
 246   GNUNET_FS_tree_encoder_finish (uc->tc,
 247                                  &uri,
 248                                  &emsg);
 249   if (uri != NULL)
 250     GNUNET_FS_uri_destroy (uri);
 251   GNUNET_DISK_file_close (uc->fh);
 252   uc->fh = NULL;
 253   GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
 254   uc->dsh = NULL;
 255   if (emsg != NULL)
 256     {
 257       signal_unindex_error (uc, emsg);
 258       GNUNET_free (emsg);
 259     }
 260   else
 261     {
 262       pi.status = GNUNET_FS_STATUS_UNINDEX_COMPLETED;
 263       pi.value.unindex.eta = GNUNET_TIME_UNIT_ZERO;
 264       GNUNET_FS_unindex_make_status_ (&pi, uc, uc->file_size);
 265     }
 266 }
 267
 268
 269 /**
 270  * Function called with the response from the
 271  * FS service to our unindexing request.
 272  *
 273  * @param cls closure, unindex context
 274  * @param msg NULL on timeout, otherwise the response
 275  */
 276 static void
 277 process_fs_response (void *cls,
 278                      const struct GNUNET_MessageHeader *msg)
 279 {
 280   struct GNUNET_FS_UnindexContext *uc = cls;
 281
 282   if (uc->client != NULL)
 283     {
 284       GNUNET_CLIENT_disconnect (uc->client, GNUNET_NO);
 285       uc->client = NULL;
 286     }
 287   if (uc->state != UNINDEX_STATE_FS_NOTIFY)
 288     {
 289       GNUNET_FS_unindex_stop (uc);
 290       return;
 291     }
 292   if (NULL == msg)
 293     {
 294       uc->state = UNINDEX_STATE_ERROR;
 295       signal_unindex_error (uc,
 296                             _("Timeout waiting for `fs' service."));
 297       return;
 298     }
 299   if (ntohs(msg->type) != GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK)
 300     {
 301       uc->state = UNINDEX_STATE_ERROR;
 302       signal_unindex_error (uc,
 303                             _("Invalid response from `fs' service."));
 304       return;
 305     }
 306   uc->state = UNINDEX_STATE_DS_REMOVE;
 307   GNUNET_FS_unindex_do_remove_ (uc);
 308 }
 309
 310
 311 /**
 312  * Connect to the datastore and remove the blocks.
 313  *
 314  * @param uc context for the unindex operation.
 315  */
 316 void
 317 GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc)
 318 {
 319   uc->dsh = GNUNET_DATASTORE_connect (uc->h->cfg,
 320                                       uc->h->sched);
 321   if (NULL == uc->dsh)
 322     {
 323       uc->state = UNINDEX_STATE_ERROR;
 324       signal_unindex_error (uc,
 325                             _("Failed to connect to `datastore' service."));
 326       return;
 327     }
 328   uc->fh = GNUNET_DISK_file_open (uc->filename,
 329                                   GNUNET_DISK_OPEN_READ,
 330                                   GNUNET_DISK_PERM_NONE);
 331   if (NULL == uc->fh)
 332     {
 333       GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
 334       uc->dsh = NULL;
 335       uc->state = UNINDEX_STATE_ERROR;
 336       signal_unindex_error (uc,
 337                             _("Failed to open file for unindexing."));
 338       return;
 339     }
 340   uc->tc = GNUNET_FS_tree_encoder_create (uc->h,
 341                                           uc->file_size,
 342                                           uc,
 343                                           &unindex_reader,
 344                                           &unindex_process,
 345                                           &unindex_progress,
 346                                           &unindex_finish);
 347   GNUNET_FS_tree_encoder_next (uc->tc);
 348 }
 349
 350
 351 /**
 352  * Function called once the hash of the file
 353  * that is being unindexed has been computed.
 354  *
 355  * @param cls closure, unindex context
 356  * @param file_id computed hash, NULL on error
 357  */
 358 void
 359 GNUNET_FS_unindex_process_hash_ (void *cls,
 360                                  const GNUNET_HashCode *file_id)
 361 {
 362   struct GNUNET_FS_UnindexContext *uc = cls;
 363   struct UnindexMessage req;
 364
 365   if (uc->state != UNINDEX_STATE_HASHING)
 366     {
 367       GNUNET_FS_unindex_stop (uc);
 368       return;
 369     }
 370   if (file_id == NULL)
 371     {
 372       uc->state = UNINDEX_STATE_ERROR;
 373       signal_unindex_error (uc,
 374                             _("Failed to compute hash of file."));
 375       return;
 376     }
 377   uc->file_id = *file_id;
 378   uc->state = UNINDEX_STATE_FS_NOTIFY;
 379   uc->client = GNUNET_CLIENT_connect (uc->h->sched,
 380                                       "fs",
 381                                       uc->h->cfg);
 382   req.header.size = htons (sizeof (struct UnindexMessage));
 383   req.header.type = htons (GNUNET_MESSAGE_TYPE_FS_UNINDEX);
 384   req.reserved = 0;
 385   req.file_id = *file_id;
 386   GNUNET_break (GNUNET_OK ==
 387                 GNUNET_CLIENT_transmit_and_get_response (uc->client,
 388                                                          &req.header,
 389                                                          GNUNET_CONSTANTS_SERVICE_TIMEOUT,
 390                                                          GNUNET_YES,
 391                                                          &process_fs_response,
 392                                                          uc));
 393 }
 394
 395
 396 /**
 397  * Create SUSPEND event for the given unindex operation
 398  * and then clean up our state (without stop signal).
 399  *
 400  * @param cls the 'struct GNUNET_FS_UnindexContext' to signal for
 401  */
 402 static void
 403 unindex_signal_suspend (void *cls)
 404 {
 405   struct GNUNET_FS_UnindexContext *uc = cls;
 406
 407   GNUNET_FS_end_top (uc->h, uc->top);
 408   /* FIXME: signal! */
 409   GNUNET_free (uc);
 410 }
 411
 412
 413 /**
 414  * Unindex a file.
 415  *
 416  * @param h handle to the file sharing subsystem
 417  * @param filename file to unindex
 418  * @param cctx initial value for the client context
 419  * @return NULL on error, otherwise handle
 420  */
 421 struct GNUNET_FS_UnindexContext *
 422 GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h,
 423                          const char *filename,
 424                          void *cctx)
 425 {
 426   struct GNUNET_FS_UnindexContext *ret;
 427   struct GNUNET_FS_ProgressInfo pi;
 428   uint64_t size;
 429
 430   if (GNUNET_OK !=
 431       GNUNET_DISK_file_size (filename,
 432                              &size,
 433                              GNUNET_YES))
 434     return NULL;
 435   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
 436   ret->h = h;
 437   ret->filename = GNUNET_strdup (filename);
 438   ret->start_time = GNUNET_TIME_absolute_get ();
 439   ret->file_size = size;
 440   ret->client_info = cctx;
 441
 442   // FIXME: make persistent!
 443   pi.status = GNUNET_FS_STATUS_UNINDEX_START;
 444   pi.value.unindex.eta = GNUNET_TIME_UNIT_FOREVER_REL;
 445   GNUNET_FS_unindex_make_status_ (&pi, ret, 0);
 446   GNUNET_CRYPTO_hash_file (h->sched,
 447                            GNUNET_SCHEDULER_PRIORITY_IDLE,
 448                            filename,
 449                            HASHING_BLOCKSIZE,
 450                            &GNUNET_FS_unindex_process_hash_,
 451                            ret);
 452   ret->top = GNUNET_FS_make_top (h,
 453                                  &unindex_signal_suspend,
 454                                  ret);
 455   return ret;
 456 }
 457
 458
 459 /**
 460  * Clean up after completion of an unindex operation.
 461  *
 462  * @param uc handle
 463  */
 464 void
 465 GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc)
 466 {
 467   struct GNUNET_FS_ProgressInfo pi;
 468
 469   GNUNET_FS_end_top (uc->h, uc->top);
 470   if ( (uc->state != UNINDEX_STATE_COMPLETE) &&
 471        (uc->state != UNINDEX_STATE_ERROR) )
 472     {
 473       uc->state = UNINDEX_STATE_ABORTED;
 474       return;
 475     }
 476   if (uc->serialization != NULL)
 477     {
 478       GNUNET_FS_remove_sync_file_ (uc->h, "unindex", uc->serialization);
 479       uc->serialization = NULL;
 480     }
 481   pi.status = GNUNET_FS_STATUS_UNINDEX_STOPPED;
 482   pi.value.unindex.eta = GNUNET_TIME_UNIT_ZERO;
 483   GNUNET_FS_unindex_make_status_ (&pi, uc,
 484                                   (uc->state == UNINDEX_STATE_COMPLETE)
 485                                   ? uc->file_size : 0);
 486   GNUNET_break (NULL == uc->client_info);
 487   GNUNET_free (uc->filename);
 488   GNUNET_free_non_null (uc->serialization);
 489   GNUNET_free (uc);
 490 }
 491
 492 /* end of fs_unindex.c */