src/fs/fs_download.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001-2011 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  * @file fs/fs_download.c
  22  * @brief download methods
  23  * @author Christian Grothoff
  24  *
  25  * TODO:
  26  * - different priority for scheduling probe downloads?
  27  */
  28 #include "platform.h"
  29 #include "gnunet_constants.h"
  30 #include "gnunet_fs_service.h"
  31 #include "fs_api.h"
  32 #include "fs_tree.h"
  33
  34 #define DEBUG_DOWNLOAD GNUNET_EXTRA_LOGGING
  35
  36 /**
  37  * Determine if the given download (options and meta data) should cause
  38  * use to try to do a recursive download.
  39  */
  40 static int
  41 is_recursive_download (struct GNUNET_FS_DownloadContext *dc)
  42 {
  43   return (0 != (dc->options & GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE)) &&
  44       ((GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (dc->meta)) ||
  45        ((dc->meta == NULL) &&
  46         ((NULL == dc->filename) ||
  47          ((strlen (dc->filename) >= strlen (GNUNET_FS_DIRECTORY_EXT)) &&
  48           (NULL !=
  49            strstr (dc->filename + strlen (dc->filename) -
  50                    strlen (GNUNET_FS_DIRECTORY_EXT),
  51                    GNUNET_FS_DIRECTORY_EXT))))));
  52 }
  53
  54
  55 /**
  56  * We're storing the IBLOCKS after the DBLOCKS on disk (so that we
  57  * only have to truncate the file once we're done).
  58  *
  59  * Given the offset of a block (with respect to the DBLOCKS) and its
  60  * depth, return the offset where we would store this block in the
  61  * file.
  62  *
  63  * @param fsize overall file size
  64  * @param off offset of the block in the file
  65  * @param depth depth of the block in the tree, 0 for DBLOCK
  66  * @return off for DBLOCKS (depth == treedepth),
  67  *         otherwise an offset past the end
  68  *         of the file that does not overlap
  69  *         with the range for any other block
  70  */
  71 static uint64_t
  72 compute_disk_offset (uint64_t fsize, uint64_t off, unsigned int depth)
  73 {
  74   unsigned int i;
  75   uint64_t lsize;               /* what is the size of all IBlocks for depth "i"? */
  76   uint64_t loff;                /* where do IBlocks for depth "i" start? */
  77   unsigned int ioff;            /* which IBlock corresponds to "off" at depth "i"? */
  78
  79   if (depth == 0)
  80     return off;
  81   /* first IBlocks start at the end of file, rounded up
  82    * to full DBLOCK_SIZE */
  83   loff = ((fsize + DBLOCK_SIZE - 1) / DBLOCK_SIZE) * DBLOCK_SIZE;
  84   lsize =
  85       ((fsize + DBLOCK_SIZE -
  86         1) / DBLOCK_SIZE) * sizeof (struct ContentHashKey);
  87   GNUNET_assert (0 == (off % DBLOCK_SIZE));
  88   ioff = (off / DBLOCK_SIZE);
  89   for (i = 1; i < depth; i++)
  90   {
  91     loff += lsize;
  92     lsize = (lsize + CHK_PER_INODE - 1) / CHK_PER_INODE;
  93     GNUNET_assert (lsize > 0);
  94     GNUNET_assert (0 == (ioff % CHK_PER_INODE));
  95     ioff /= CHK_PER_INODE;
  96   }
  97   return loff + ioff * sizeof (struct ContentHashKey);
  98 }
  99
 100
 101 /**
 102  * Fill in all of the generic fields for a download event and call the
 103  * callback.
 104  *
 105  * @param pi structure to fill in
 106  * @param dc overall download context
 107  */
 108 void
 109 GNUNET_FS_download_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
 110                                  struct GNUNET_FS_DownloadContext *dc)
 111 {
 112   pi->value.download.dc = dc;
 113   pi->value.download.cctx = dc->client_info;
 114   pi->value.download.pctx =
 115       (dc->parent == NULL) ? NULL : dc->parent->client_info;
 116   pi->value.download.sctx =
 117       (dc->search == NULL) ? NULL : dc->search->client_info;
 118   pi->value.download.uri = dc->uri;
 119   pi->value.download.filename = dc->filename;
 120   pi->value.download.size = dc->length;
 121   /* FIXME: Fix duration calculation to account for pauses */
 122   pi->value.download.duration =
 123       GNUNET_TIME_absolute_get_duration (dc->start_time);
 124   pi->value.download.completed = dc->completed;
 125   pi->value.download.anonymity = dc->anonymity;
 126   pi->value.download.eta =
 127       GNUNET_TIME_calculate_eta (dc->start_time, dc->completed, dc->length);
 128   pi->value.download.is_active = (dc->client == NULL) ? GNUNET_NO : GNUNET_YES;
 129   if (0 == (dc->options & GNUNET_FS_DOWNLOAD_IS_PROBE))
 130     dc->client_info = dc->h->upcb (dc->h->upcb_cls, pi);
 131   else
 132     dc->client_info = GNUNET_FS_search_probe_progress_ (NULL, pi);
 133 }
 134
 135
 136 /**
 137  * We're ready to transmit a search request to the
 138  * file-sharing service.  Do it.  If there is
 139  * more than one request pending, try to send
 140  * multiple or request another transmission.
 141  *
 142  * @param cls closure
 143  * @param size number of bytes available in buf
 144  * @param buf where the callee should write the message
 145  * @return number of bytes written to buf
 146  */
 147 static size_t
 148 transmit_download_request (void *cls, size_t size, void *buf);
 149
 150
 151 /**
 152  * Closure for iterator processing results.
 153  */
 154 struct ProcessResultClosure
 155 {
 156
 157   /**
 158    * Hash of data.
 159    */
 160   GNUNET_HashCode query;
 161
 162   /**
 163    * Data found in P2P network.
 164    */
 165   const void *data;
 166
 167   /**
 168    * Our download context.
 169    */
 170   struct GNUNET_FS_DownloadContext *dc;
 171
 172   /**
 173    * Number of bytes in data.
 174    */
 175   size_t size;
 176
 177   /**
 178    * Type of data.
 179    */
 180   enum GNUNET_BLOCK_Type type;
 181
 182   /**
 183    * Flag to indicate if this block should be stored on disk.
 184    */
 185   int do_store;
 186
 187   struct GNUNET_TIME_Absolute last_transmission;
 188
 189 };
 190
 191
 192 /**
 193  * Iterator over entries in the pending requests in the 'active' map for the
 194  * reply that we just got.
 195  *
 196  * @param cls closure (our 'struct ProcessResultClosure')
 197  * @param key query for the given value / request
 198  * @param value value in the hash map (a 'struct DownloadRequest')
 199  * @return GNUNET_YES (we should continue to iterate); unless serious error
 200  */
 201 static int
 202 process_result_with_request (void *cls, const GNUNET_HashCode * key,
 203                              void *value);
 204
 205
 206 /**
 207  * We've found a matching block without downloading it.
 208  * Encrypt it and pass it to our "receive" function as
 209  * if we had received it from the network.
 210  *
 211  * @param dc download in question
 212  * @param chk request this relates to
 213  * @param dr request details
 214  * @param block plaintext data matching request
 215  * @param len number of bytes in block
 216  * @param do_store should we still store the block on disk?
 217  * @return GNUNET_OK on success
 218  */
 219 static int
 220 encrypt_existing_match (struct GNUNET_FS_DownloadContext *dc,
 221                         const struct ContentHashKey *chk,
 222                         struct DownloadRequest *dr, const char *block,
 223                         size_t len, int do_store)
 224 {
 225   struct ProcessResultClosure prc;
 226   char enc[len];
 227   struct GNUNET_CRYPTO_AesSessionKey sk;
 228   struct GNUNET_CRYPTO_AesInitializationVector iv;
 229   GNUNET_HashCode query;
 230
 231   GNUNET_CRYPTO_hash_to_aes_key (&chk->key, &sk, &iv);
 232   if (-1 == GNUNET_CRYPTO_aes_encrypt (block, len, &sk, &iv, enc))
 233   {
 234     GNUNET_break (0);
 235     return GNUNET_SYSERR;
 236   }
 237   GNUNET_CRYPTO_hash (enc, len, &query);
 238   if (0 != memcmp (&query, &chk->query, sizeof (GNUNET_HashCode)))
 239   {
 240     GNUNET_break_op (0);
 241     return GNUNET_SYSERR;
 242   }
 243 #if DEBUG_DOWNLOAD
 244   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 245               "Matching block for `%s' at offset %llu already present, no need for download!\n",
 246               dc->filename, (unsigned long long) dr->offset);
 247 #endif
 248   /* already got it! */
 249   prc.dc = dc;
 250   prc.data = enc;
 251   prc.size = len;
 252   prc.type =
 253       (0 ==
 254        dr->depth) ? GNUNET_BLOCK_TYPE_FS_DBLOCK : GNUNET_BLOCK_TYPE_FS_IBLOCK;
 255   prc.query = chk->query;
 256   prc.do_store = do_store;
 257   prc.last_transmission = GNUNET_TIME_UNIT_FOREVER_ABS;
 258   process_result_with_request (&prc, &chk->key, dr);
 259   return GNUNET_OK;
 260 }
 261
 262
 263 /**
 264  * We've lost our connection with the FS service.
 265  * Re-establish it and re-transmit all of our
 266  * pending requests.
 267  *
 268  * @param dc download context that is having trouble
 269  */
 270 static void
 271 try_reconnect (struct GNUNET_FS_DownloadContext *dc);
 272
 273
 274 /**
 275  * We found an entry in a directory.  Check if the respective child
 276  * already exists and if not create the respective child download.
 277  *
 278  * @param cls the parent download
 279  * @param filename name of the file in the directory
 280  * @param uri URI of the file (CHK or LOC)
 281  * @param meta meta data of the file
 282  * @param length number of bytes in data
 283  * @param data contents of the file (or NULL if they were not inlined)
 284  */
 285 static void
 286 trigger_recursive_download (void *cls, const char *filename,
 287                             const struct GNUNET_FS_Uri *uri,
 288                             const struct GNUNET_CONTAINER_MetaData *meta,
 289                             size_t length, const void *data);
 290
 291
 292 /**
 293  * We're done downloading a directory.  Open the file and
 294  * trigger all of the (remaining) child downloads.
 295  *
 296  * @param dc context of download that just completed
 297  */
 298 static void
 299 full_recursive_download (struct GNUNET_FS_DownloadContext *dc)
 300 {
 301   size_t size;
 302   uint64_t size64;
 303   void *data;
 304   struct GNUNET_DISK_FileHandle *h;
 305   struct GNUNET_DISK_MapHandle *m;
 306
 307   size64 = GNUNET_FS_uri_chk_get_file_size (dc->uri);
 308   size = (size_t) size64;
 309   if (size64 != (uint64_t) size)
 310   {
 311     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 312                 _
 313                 ("Recursive downloads of directories larger than 4 GB are not supported on 32-bit systems\n"));
 314     return;
 315   }
 316   if (dc->filename != NULL)
 317   {
 318     h = GNUNET_DISK_file_open (dc->filename, GNUNET_DISK_OPEN_READ,
 319                                GNUNET_DISK_PERM_NONE);
 320   }
 321   else
 322   {
 323     GNUNET_assert (dc->temp_filename != NULL);
 324     h = GNUNET_DISK_file_open (dc->temp_filename, GNUNET_DISK_OPEN_READ,
 325                                GNUNET_DISK_PERM_NONE);
 326   }
 327   if (h == NULL)
 328     return;                     /* oops */
 329   data = GNUNET_DISK_file_map (h, &m, GNUNET_DISK_MAP_TYPE_READ, size);
 330   if (data == NULL)
 331   {
 332     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 333                 _("Directory too large for system address space\n"));
 334   }
 335   else
 336   {
 337     GNUNET_FS_directory_list_contents (size, data, 0,
 338                                        &trigger_recursive_download, dc);
 339     GNUNET_DISK_file_unmap (m);
 340   }
 341   GNUNET_DISK_file_close (h);
 342   if (dc->filename == NULL)
 343   {
 344     if (0 != UNLINK (dc->temp_filename))
 345       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink",
 346                                 dc->temp_filename);
 347     GNUNET_free (dc->temp_filename);
 348     dc->temp_filename = NULL;
 349   }
 350 }
 351
 352
 353 /**
 354  * Check if all child-downloads have completed (or trigger them if
 355  * necessary) and once we're completely done, signal completion (and
 356  * possibly recurse to parent).  This function MUST be called when the
 357  * download of a file itself is done or when the download of a file is
 358  * done and then later a direct child download has completed (and
 359  * hence this download may complete itself).
 360  *
 361  * @param dc download to check for completion of children
 362  */
 363 static void
 364 check_completed (struct GNUNET_FS_DownloadContext *dc)
 365 {
 366   struct GNUNET_FS_ProgressInfo pi;
 367   struct GNUNET_FS_DownloadContext *pos;
 368
 369   /* first, check if we need to download children */
 370   if ((dc->child_head == NULL) && (is_recursive_download (dc)))
 371     full_recursive_download (dc);
 372   /* then, check if children are done already */
 373   pos = dc->child_head;
 374   while (pos != NULL)
 375   {
 376     if ((pos->emsg == NULL) && (pos->completed < pos->length))
 377       return;                   /* not done yet */
 378     if ((pos->child_head != NULL) && (pos->has_finished != GNUNET_YES))
 379       return;                   /* not transitively done yet */
 380     pos = pos->next;
 381   }
 382   /* All of our children are done, so mark this download done */
 383   dc->has_finished = GNUNET_YES;
 384   if (dc->job_queue != NULL)
 385   {
 386     GNUNET_FS_dequeue_ (dc->job_queue);
 387     dc->job_queue = NULL;
 388   }
 389   GNUNET_FS_download_sync_ (dc);
 390
 391   /* signal completion */
 392   pi.status = GNUNET_FS_STATUS_DOWNLOAD_COMPLETED;
 393   GNUNET_FS_download_make_status_ (&pi, dc);
 394
 395   /* let parent know */
 396   if (dc->parent != NULL)
 397     check_completed (dc->parent);
 398 }
 399
 400
 401 /**
 402  * We got a block of plaintext data (from the meta data).
 403  * Try it for upward reconstruction of the data.  On success,
 404  * the top-level block will move to state BRS_DOWNLOAD_UP.
 405  *
 406  * @param dc context for the download
 407  * @param dr download request to match against
 408  * @param data plaintext data, starting from the beginning of the file
 409  * @param data_len number of bytes in data
 410  */
 411 static void
 412 try_match_block (struct GNUNET_FS_DownloadContext *dc,
 413                  struct DownloadRequest *dr, const char *data, size_t data_len)
 414 {
 415   struct GNUNET_FS_ProgressInfo pi;
 416   unsigned int i;
 417   char enc[DBLOCK_SIZE];
 418   struct ContentHashKey chks[CHK_PER_INODE];
 419   struct ContentHashKey in_chk;
 420   struct GNUNET_CRYPTO_AesSessionKey sk;
 421   struct GNUNET_CRYPTO_AesInitializationVector iv;
 422   size_t dlen;
 423   struct DownloadRequest *drc;
 424   struct GNUNET_DISK_FileHandle *fh;
 425   int complete;
 426   const char *fn;
 427   const char *odata;
 428   size_t odata_len;
 429
 430   odata = data;
 431   odata_len = data_len;
 432   if (BRS_DOWNLOAD_UP == dr->state)
 433     return;
 434   if (dr->depth > 0)
 435   {
 436     complete = GNUNET_YES;
 437     for (i = 0; i < dr->num_children; i++)
 438     {
 439       drc = dr->children[i];
 440       try_match_block (dc, drc, data, data_len);
 441       if (drc->state != BRS_RECONSTRUCT_META_UP)
 442         complete = GNUNET_NO;
 443       else
 444         chks[i] = drc->chk;
 445     }
 446     if (GNUNET_YES != complete)
 447       return;
 448     data = (const char *) chks;
 449     dlen = dr->num_children * sizeof (struct ContentHashKey);
 450   }
 451   else
 452   {
 453     if (dr->offset > data_len)
 454       return;                   /* oops */
 455     dlen = GNUNET_MIN (data_len - dr->offset, DBLOCK_SIZE);
 456   }
 457   GNUNET_CRYPTO_hash (&data[dr->offset], dlen, &in_chk.key);
 458   GNUNET_CRYPTO_hash_to_aes_key (&in_chk.key, &sk, &iv);
 459   if (-1 == GNUNET_CRYPTO_aes_encrypt (&data[dr->offset], dlen, &sk, &iv, enc))
 460   {
 461     GNUNET_break (0);
 462     return;
 463   }
 464   GNUNET_CRYPTO_hash (enc, dlen, &in_chk.query);
 465   switch (dr->state)
 466   {
 467   case BRS_INIT:
 468     dr->chk = in_chk;
 469     dr->state = BRS_RECONSTRUCT_META_UP;
 470     break;
 471   case BRS_CHK_SET:
 472     if (0 != memcmp (&in_chk, &dr->chk, sizeof (struct ContentHashKey)))
 473     {
 474       /* other peer provided bogus meta data */
 475       GNUNET_break_op (0);
 476       break;
 477     }
 478     /* write block to disk */
 479     fn = dc->filename != NULL ? dc->filename : dc->temp_filename;
 480     fh = GNUNET_DISK_file_open (fn,
 481                                 GNUNET_DISK_OPEN_READWRITE |
 482                                 GNUNET_DISK_OPEN_CREATE |
 483                                 GNUNET_DISK_OPEN_TRUNCATE,
 484                                 GNUNET_DISK_PERM_USER_READ |
 485                                 GNUNET_DISK_PERM_USER_WRITE |
 486                                 GNUNET_DISK_PERM_GROUP_READ |
 487                                 GNUNET_DISK_PERM_OTHER_READ);
 488     if (fh == NULL)
 489     {
 490       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", fn);
 491       GNUNET_asprintf (&dc->emsg, _("Failed to open file `%s' for writing"),
 492                        fn);
 493       GNUNET_DISK_file_close (fh);
 494       dr->state = BRS_ERROR;
 495       pi.status = GNUNET_FS_STATUS_DOWNLOAD_ERROR;
 496       pi.value.download.specifics.error.message = dc->emsg;
 497       GNUNET_FS_download_make_status_ (&pi, dc);
 498       return;
 499     }
 500     if (data_len != GNUNET_DISK_file_write (fh, odata, odata_len))
 501     {
 502       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "write", fn);
 503       GNUNET_asprintf (&dc->emsg, _("Failed to open file `%s' for writing"),
 504                        fn);
 505       GNUNET_DISK_file_close (fh);
 506       dr->state = BRS_ERROR;
 507       pi.status = GNUNET_FS_STATUS_DOWNLOAD_ERROR;
 508       pi.value.download.specifics.error.message = dc->emsg;
 509       GNUNET_FS_download_make_status_ (&pi, dc);
 510       return;
 511     }
 512     GNUNET_DISK_file_close (fh);
 513     /* signal success */
 514     dr->state = BRS_DOWNLOAD_UP;
 515     dc->completed = dc->length;
 516     GNUNET_FS_download_sync_ (dc);
 517     pi.status = GNUNET_FS_STATUS_DOWNLOAD_PROGRESS;
 518     pi.value.download.specifics.progress.data = data;
 519     pi.value.download.specifics.progress.offset = 0;
 520     pi.value.download.specifics.progress.data_len = dlen;
 521     pi.value.download.specifics.progress.depth = 0;
 522     pi.value.download.specifics.progress.trust_offered = 0;
 523     GNUNET_FS_download_make_status_ (&pi, dc);
 524     if ((NULL != dc->filename) &&
 525         (0 !=
 526          truncate (dc->filename,
 527                    GNUNET_ntohll (dc->uri->data.chk.file_length))))
 528       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "truncate",
 529                                 dc->filename);
 530     check_completed (dc);
 531     break;
 532   default:
 533     /* how did we get here? */
 534     GNUNET_break (0);
 535     break;
 536   }
 537 }
 538
 539
 540 /**
 541  * Type of a function that libextractor calls for each
 542  * meta data item found.  If we find full data meta data,
 543  * call 'try_match_block' on it.
 544  *
 545  * @param cls our 'struct GNUNET_FS_DownloadContext*'
 546  * @param plugin_name name of the plugin that produced this value;
 547  *        special values can be used (i.e. '&lt;zlib&gt;' for zlib being
 548  *        used in the main libextractor library and yielding
 549  *        meta data).
 550  * @param type libextractor-type describing the meta data
 551  * @param format basic format information about data
 552  * @param data_mime_type mime-type of data (not of the original file);
 553  *        can be NULL (if mime-type is not known)
 554  * @param data actual meta-data found
 555  * @param data_len number of bytes in data
 556  * @return 0 to continue extracting, 1 to abort
 557  */
 558 static int
 559 match_full_data (void *cls, const char *plugin_name,
 560                  enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format,
 561                  const char *data_mime_type, const char *data, size_t data_len)
 562 {
 563   struct GNUNET_FS_DownloadContext *dc = cls;
 564
 565   if (type != EXTRACTOR_METATYPE_GNUNET_FULL_DATA)
 566     return 0;
 567 #if DEBUG_DOWNLOAD
 568   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Found %u bytes of FD!\n",
 569               (unsigned int) data_len);
 570 #endif
 571   if (GNUNET_FS_uri_chk_get_file_size (dc->uri) != data_len)
 572   {
 573     GNUNET_break_op (0);
 574     return 1;                   /* bogus meta data */
 575   }
 576   try_match_block (dc, dc->top_request, data, data_len);
 577   return 1;
 578 }
 579
 580
 581 /**
 582  * Set the state of the given download request to
 583  * BRS_DOWNLOAD_UP and propagate it up the tree.
 584  *
 585  * @param dr download request that is done
 586  */
 587 static void
 588 propagate_up (struct DownloadRequest *dr)
 589 {
 590   unsigned int i;
 591
 592   do
 593   {
 594     dr->state = BRS_DOWNLOAD_UP;
 595     dr = dr->parent;
 596     if (dr == NULL)
 597       break;
 598     for (i = 0; i < dr->num_children; i++)
 599       if (dr->children[i]->state != BRS_DOWNLOAD_UP)
 600         break;
 601   }
 602   while (i == dr->num_children);
 603 }
 604
 605
 606 /**
 607  * Try top-down reconstruction.  Before, the given request node
 608  * must have the state BRS_CHK_SET.  Afterwards, more nodes may
 609  * have that state or advanced to BRS_DOWNLOAD_DOWN or even
 610  * BRS_DOWNLOAD_UP.  It is also possible to get BRS_ERROR on the
 611  * top level.
 612  *
 613  * @param dc overall download this block belongs to
 614  * @param dr block to reconstruct
 615  */
 616 static void
 617 try_top_down_reconstruction (struct GNUNET_FS_DownloadContext *dc,
 618                              struct DownloadRequest *dr)
 619 {
 620   uint64_t off;
 621   char block[DBLOCK_SIZE];
 622   GNUNET_HashCode key;
 623   uint64_t total;
 624   size_t len;
 625   unsigned int i;
 626   unsigned int chk_off;
 627   struct DownloadRequest *drc;
 628   uint64_t child_block_size;
 629   const struct ContentHashKey *chks;
 630   int up_done;
 631
 632   GNUNET_assert (dc->rfh != NULL);
 633   GNUNET_assert (dr->state == BRS_CHK_SET);
 634   total = GNUNET_FS_uri_chk_get_file_size (dc->uri);
 635   GNUNET_assert (dr->depth < dc->treedepth);
 636   len = GNUNET_FS_tree_calculate_block_size (total, dr->offset, dr->depth);
 637   GNUNET_assert (len <= DBLOCK_SIZE);
 638   off = compute_disk_offset (total, dr->offset, dr->depth);
 639   if (dc->old_file_size < off + len)
 640     return;                     /* failure */
 641   if (off != GNUNET_DISK_file_seek (dc->rfh, off, GNUNET_DISK_SEEK_SET))
 642   {
 643     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "seek", dc->filename);
 644     return;                     /* failure */
 645   }
 646   if (len != GNUNET_DISK_file_read (dc->rfh, block, len))
 647   {
 648     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "read", dc->filename);
 649     return;                     /* failure */
 650   }
 651   GNUNET_CRYPTO_hash (block, len, &key);
 652   if (0 != memcmp (&key, &dr->chk.key, sizeof (GNUNET_HashCode)))
 653     return;                     /* mismatch */
 654   if (GNUNET_OK !=
 655       encrypt_existing_match (dc, &dr->chk, dr, block, len, GNUNET_NO))
 656   {
 657     /* hash matches but encrypted block does not, really bad */
 658     dr->state = BRS_ERROR;
 659     /* propagate up */
 660     while (dr->parent != NULL)
 661     {
 662       dr = dr->parent;
 663       dr->state = BRS_ERROR;
 664     }
 665     return;
 666   }
 667   /* block matches */
 668   dr->state = BRS_DOWNLOAD_DOWN;
 669
 670   /* set CHKs for children */
 671   up_done = GNUNET_YES;
 672   chks = (const struct ContentHashKey *) block;
 673   for (i = 0; i < dr->num_children; i++)
 674   {
 675     drc = dr->children[i];
 676     GNUNET_assert (drc->offset >= dr->offset);
 677     child_block_size = GNUNET_FS_tree_compute_tree_size (drc->depth);
 678     GNUNET_assert (0 == (drc->offset - dr->offset) % child_block_size);
 679     chk_off = (drc->offset - dr->offset) / child_block_size;
 680     if (drc->state == BRS_INIT)
 681     {
 682       drc->state = BRS_CHK_SET;
 683       drc->chk = chks[chk_off];
 684       try_top_down_reconstruction (dc, drc);
 685     }
 686     if (drc->state != BRS_DOWNLOAD_UP)
 687       up_done = GNUNET_NO;      /* children not all done */
 688   }
 689   if (up_done == GNUNET_YES)
 690     propagate_up (dr);          /* children all done (or no children...) */
 691 }
 692
 693
 694 /**
 695  * Schedule the download of the specified block in the tree.
 696  *
 697  * @param dc overall download this block belongs to
 698  * @param dr request to schedule
 699  */
 700 static void
 701 schedule_block_download (struct GNUNET_FS_DownloadContext *dc,
 702                          struct DownloadRequest *dr)
 703 {
 704   unsigned int i;
 705
 706   switch (dr->state)
 707   {
 708   case BRS_INIT:
 709     GNUNET_assert (0);
 710     break;
 711   case BRS_RECONSTRUCT_DOWN:
 712     GNUNET_assert (0);
 713     break;
 714   case BRS_RECONSTRUCT_META_UP:
 715     GNUNET_assert (0);
 716     break;
 717   case BRS_RECONSTRUCT_UP:
 718     GNUNET_assert (0);
 719     break;
 720   case BRS_CHK_SET:
 721     /* normal case, start download */
 722     break;
 723   case BRS_DOWNLOAD_DOWN:
 724     for (i = 0; i < dr->num_children; i++)
 725       schedule_block_download (dc, dr->children[i]);
 726     return;
 727   case BRS_DOWNLOAD_UP:
 728     /* We're done! */
 729     return;
 730   case BRS_ERROR:
 731     GNUNET_break (0);
 732     return;
 733   }
 734 #if DEBUG_DOWNLOAD
 735   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 736               "Scheduling download at offset %llu and depth %u for `%s'\n",
 737               (unsigned long long) dr->offset, dr->depth,
 738               GNUNET_h2s (&dr->chk.query));
 739 #endif
 740   if (GNUNET_NO !=
 741       GNUNET_CONTAINER_multihashmap_contains_value (dc->active, &dr->chk.query,
 742                                                     dr))
 743     return;                     /* already active */
 744   GNUNET_CONTAINER_multihashmap_put (dc->active, &dr->chk.query, dr,
 745                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 746   if (dc->client == NULL)
 747     return;                     /* download not active */
 748   GNUNET_CONTAINER_DLL_insert (dc->pending_head, dc->pending_tail, dr);
 749   dr->is_pending = GNUNET_YES;
 750   if (NULL == dc->th)
 751     dc->th =
 752         GNUNET_CLIENT_notify_transmit_ready (dc->client,
 753                                              sizeof (struct SearchMessage),
 754                                              GNUNET_CONSTANTS_SERVICE_TIMEOUT,
 755                                              GNUNET_NO,
 756                                              &transmit_download_request, dc);
 757 }
 758
 759
 760 #define GNUNET_FS_URI_CHK_PREFIX GNUNET_FS_URI_PREFIX GNUNET_FS_URI_CHK_INFIX
 761
 762 /**
 763  * We found an entry in a directory.  Check if the respective child
 764  * already exists and if not create the respective child download.
 765  *
 766  * @param cls the parent download
 767  * @param filename name of the file in the directory
 768  * @param uri URI of the file (CHK or LOC)
 769  * @param meta meta data of the file
 770  * @param length number of bytes in data
 771  * @param data contents of the file (or NULL if they were not inlined)
 772  */
 773 static void
 774 trigger_recursive_download (void *cls, const char *filename,
 775                             const struct GNUNET_FS_Uri *uri,
 776                             const struct GNUNET_CONTAINER_MetaData *meta,
 777                             size_t length, const void *data)
 778 {
 779   struct GNUNET_FS_DownloadContext *dc = cls;
 780   struct GNUNET_FS_DownloadContext *cpos;
 781   char *temp_name;
 782   char *fn;
 783   char *us;
 784   char *ext;
 785   char *dn;
 786   char *pos;
 787   char *full_name;
 788   char *sfn;
 789
 790   if (NULL == uri)
 791     return;                     /* entry for the directory itself */
 792   cpos = dc->child_head;
 793   while (cpos != NULL)
 794   {
 795     if ((GNUNET_FS_uri_test_equal (uri, cpos->uri)) ||
 796         ((filename != NULL) && (0 == strcmp (cpos->filename, filename))))
 797       break;
 798     cpos = cpos->next;
 799   }
 800   if (cpos != NULL)
 801     return;                     /* already exists */
 802   fn = NULL;
 803   if (NULL == filename)
 804   {
 805     fn = GNUNET_FS_meta_data_suggest_filename (meta);
 806     if (fn == NULL)
 807     {
 808       us = GNUNET_FS_uri_to_string (uri);
 809       fn = GNUNET_strdup (&us[strlen (GNUNET_FS_URI_CHK_PREFIX)]);
 810       GNUNET_free (us);
 811     }
 812     else if (fn[0] == '.')
 813     {
 814       ext = fn;
 815       us = GNUNET_FS_uri_to_string (uri);
 816       GNUNET_asprintf (&fn, "%s%s", &us[strlen (GNUNET_FS_URI_CHK_PREFIX)],
 817                        ext);
 818       GNUNET_free (ext);
 819       GNUNET_free (us);
 820     }
 821     /* change '\' to '/' (this should have happened
 822      * during insertion, but malicious peers may
 823      * not have done this) */
 824     while (NULL != (pos = strstr (fn, "\\")))
 825       *pos = '/';
 826     /* remove '../' everywhere (again, well-behaved
 827      * peers don't do this, but don't trust that
 828      * we did not get something nasty) */
 829     while (NULL != (pos = strstr (fn, "../")))
 830     {
 831       pos[0] = '_';
 832       pos[1] = '_';
 833       pos[2] = '_';
 834     }
 835     filename = fn;
 836   }
 837   if (dc->filename == NULL)
 838   {
 839     full_name = NULL;
 840   }
 841   else
 842   {
 843     dn = GNUNET_strdup (dc->filename);
 844     GNUNET_break ((strlen (dn) >= strlen (GNUNET_FS_DIRECTORY_EXT)) &&
 845                   (NULL !=
 846                    strstr (dn + strlen (dn) - strlen (GNUNET_FS_DIRECTORY_EXT),
 847                            GNUNET_FS_DIRECTORY_EXT)));
 848     sfn = GNUNET_strdup (filename);
 849     while ((strlen (sfn) > 0) && (filename[strlen (sfn) - 1] == '/'))
 850       sfn[strlen (sfn) - 1] = '\0';
 851     if ((strlen (dn) >= strlen (GNUNET_FS_DIRECTORY_EXT)) &&
 852         (NULL !=
 853          strstr (dn + strlen (dn) - strlen (GNUNET_FS_DIRECTORY_EXT),
 854                  GNUNET_FS_DIRECTORY_EXT)))
 855       dn[strlen (dn) - strlen (GNUNET_FS_DIRECTORY_EXT)] = '\0';
 856     if ((GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta)) &&
 857         ((strlen (filename) < strlen (GNUNET_FS_DIRECTORY_EXT)) ||
 858          (NULL ==
 859           strstr (filename + strlen (filename) -
 860                   strlen (GNUNET_FS_DIRECTORY_EXT), GNUNET_FS_DIRECTORY_EXT))))
 861     {
 862       GNUNET_asprintf (&full_name, "%s%s%s%s", dn, DIR_SEPARATOR_STR, sfn,
 863                        GNUNET_FS_DIRECTORY_EXT);
 864     }
 865     else
 866     {
 867       GNUNET_asprintf (&full_name, "%s%s%s", dn, DIR_SEPARATOR_STR, sfn);
 868     }
 869     GNUNET_free (sfn);
 870     GNUNET_free (dn);
 871   }
 872   if ((full_name != NULL) &&
 873       (GNUNET_OK != GNUNET_DISK_directory_create_for_file (full_name)))
 874   {
 875     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 876                 _
 877                 ("Failed to create directory for recursive download of `%s'\n"),
 878                 full_name);
 879     GNUNET_free (full_name);
 880     GNUNET_free_non_null (fn);
 881     return;
 882   }
 883
 884   temp_name = NULL;
 885 #if DEBUG_DOWNLOAD
 886   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 887               "Triggering recursive download of size %llu with %u bytes MD\n",
 888               (unsigned long long) GNUNET_FS_uri_chk_get_file_size (uri),
 889               (unsigned int)
 890               GNUNET_CONTAINER_meta_data_get_serialized_size (meta));
 891 #endif
 892   GNUNET_FS_download_start (dc->h, uri, meta, full_name, temp_name, 0,
 893                             GNUNET_FS_uri_chk_get_file_size (uri),
 894                             dc->anonymity, dc->options, NULL, dc);
 895   GNUNET_free_non_null (full_name);
 896   GNUNET_free_non_null (temp_name);
 897   GNUNET_free_non_null (fn);
 898 }
 899
 900
 901 /**
 902  * (recursively) free download request structure
 903  *
 904  * @param dr request to free
 905  */
 906 void
 907 GNUNET_FS_free_download_request_ (struct DownloadRequest *dr)
 908 {
 909   unsigned int i;
 910
 911   if (dr == NULL)
 912     return;
 913   for (i = 0; i < dr->num_children; i++)
 914     GNUNET_FS_free_download_request_ (dr->children[i]);
 915   GNUNET_free_non_null (dr->children);
 916   GNUNET_free (dr);
 917 }
 918
 919
 920 /**
 921  * Iterator over entries in the pending requests in the 'active' map for the
 922  * reply that we just got.
 923  *
 924  * @param cls closure (our 'struct ProcessResultClosure')
 925  * @param key query for the given value / request
 926  * @param value value in the hash map (a 'struct DownloadRequest')
 927  * @return GNUNET_YES (we should continue to iterate); unless serious error
 928  */
 929 static int
 930 process_result_with_request (void *cls, const GNUNET_HashCode * key,
 931                              void *value)
 932 {
 933   struct ProcessResultClosure *prc = cls;
 934   struct DownloadRequest *dr = value;
 935   struct GNUNET_FS_DownloadContext *dc = prc->dc;
 936   struct DownloadRequest *drc;
 937   struct GNUNET_DISK_FileHandle *fh = NULL;
 938   struct GNUNET_CRYPTO_AesSessionKey skey;
 939   struct GNUNET_CRYPTO_AesInitializationVector iv;
 940   char pt[prc->size];
 941   struct GNUNET_FS_ProgressInfo pi;
 942   uint64_t off;
 943   size_t bs;
 944   size_t app;
 945   int i;
 946   struct ContentHashKey *chkarr;
 947
 948 #if DEBUG_DOWNLOAD
 949   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 950               "Received block `%s' matching pending request at depth %u and offset %llu/%llu\n",
 951               GNUNET_h2s (key), dr->depth, (unsigned long long) dr->offset,
 952               (unsigned long long) GNUNET_ntohll (dc->uri->data.
 953                                                   chk.file_length));
 954
 955 #endif
 956   bs = GNUNET_FS_tree_calculate_block_size (GNUNET_ntohll
 957                                             (dc->uri->data.chk.file_length),
 958                                             dr->offset, dr->depth);
 959   if (prc->size != bs)
 960   {
 961     GNUNET_asprintf (&dc->emsg,
 962                      _
 963                      ("Internal error or bogus download URI (expected %u bytes at depth %u and offset %llu/%llu, got %u bytes)\n"),
 964                      bs, dr->depth, (unsigned long long) dr->offset,
 965                      (unsigned long long) GNUNET_ntohll (dc->uri->data.
 966                                                          chk.file_length),
 967                      prc->size);
 968     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "%s", dc->emsg);
 969     while (dr->parent != NULL)
 970     {
 971       dr->state = BRS_ERROR;
 972       dr = dr->parent;
 973     }
 974     dr->state = BRS_ERROR;
 975     goto signal_error;
 976   }
 977
 978   (void) GNUNET_CONTAINER_multihashmap_remove (dc->active, &prc->query, dr);
 979   if (GNUNET_YES == dr->is_pending)
 980   {
 981     GNUNET_CONTAINER_DLL_remove (dc->pending_head, dc->pending_tail, dr);
 982     dr->is_pending = GNUNET_NO;
 983   }
 984
 985   GNUNET_CRYPTO_hash_to_aes_key (&dr->chk.key, &skey, &iv);
 986   if (-1 == GNUNET_CRYPTO_aes_decrypt (prc->data, prc->size, &skey, &iv, pt))
 987   {
 988     GNUNET_break (0);
 989     dc->emsg = GNUNET_strdup (_("internal error decrypting content"));
 990     goto signal_error;
 991   }
 992   off =
 993       compute_disk_offset (GNUNET_ntohll (dc->uri->data.chk.file_length),
 994                            dr->offset, dr->depth);
 995   /* save to disk */
 996   if ((GNUNET_YES == prc->do_store) &&
 997       ((dc->filename != NULL) || (is_recursive_download (dc))) &&
 998       ((dr->depth == dc->treedepth) ||
 999        (0 == (dc->options & GNUNET_FS_DOWNLOAD_NO_TEMPORARIES))))
1000   {
1001     fh = GNUNET_DISK_file_open (dc->filename !=
1002                                 NULL ? dc->filename : dc->temp_filename,
1003                                 GNUNET_DISK_OPEN_READWRITE |
1004                                 GNUNET_DISK_OPEN_CREATE,
1005                                 GNUNET_DISK_PERM_USER_READ |
1006                                 GNUNET_DISK_PERM_USER_WRITE |
1007                                 GNUNET_DISK_PERM_GROUP_READ |
1008                                 GNUNET_DISK_PERM_OTHER_READ);
1009     if (NULL == fh)
1010     {
1011       GNUNET_asprintf (&dc->emsg,
1012                        _("Download failed: could not open file `%s': %s\n"),
1013                        dc->filename, STRERROR (errno));
1014       goto signal_error;
1015     }
1016 #if DEBUG_DOWNLOAD
1017     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1018                 "Saving decrypted block to disk at offset %llu\n",
1019                 (unsigned long long) off);
1020 #endif
1021     if ((off != GNUNET_DISK_file_seek (fh, off, GNUNET_DISK_SEEK_SET)))
1022     {
1023       GNUNET_asprintf (&dc->emsg,
1024                        _("Failed to seek to offset %llu in file `%s': %s\n"),
1025                        (unsigned long long) off, dc->filename,
1026                        STRERROR (errno));
1027       goto signal_error;
1028     }
1029     if (prc->size != GNUNET_DISK_file_write (fh, pt, prc->size))
1030     {
1031       GNUNET_asprintf (&dc->emsg,
1032                        _
1033                        ("Failed to write block of %u bytes at offset %llu in file `%s': %s\n"),
1034                        (unsigned int) prc->size, (unsigned long long) off,
1035                        dc->filename, STRERROR (errno));
1036       goto signal_error;
1037     }
1038     GNUNET_break (GNUNET_OK == GNUNET_DISK_file_close (fh));
1039     fh = NULL;
1040   }
1041
1042   if (dr->depth == 0)
1043   {
1044     /* DBLOCK, update progress and try recursion if applicable */
1045     app = prc->size;
1046     if (dr->offset < dc->offset)
1047     {
1048       /* starting offset begins in the middle of pt,
1049        * do not count first bytes as progress */
1050       GNUNET_assert (app > (dc->offset - dr->offset));
1051       app -= (dc->offset - dr->offset);
1052     }
1053     if (dr->offset + prc->size > dc->offset + dc->length)
1054     {
1055       /* end of block is after relevant range,
1056        * do not count last bytes as progress */
1057       GNUNET_assert (app >
1058                      (dr->offset + prc->size) - (dc->offset + dc->length));
1059       app -= (dr->offset + prc->size) - (dc->offset + dc->length);
1060     }
1061     dc->completed += app;
1062
1063     /* do recursive download if option is set and either meta data
1064      * says it is a directory or if no meta data is given AND filename
1065      * ends in '.gnd' (top-level case) */
1066     if (is_recursive_download (dc))
1067       GNUNET_FS_directory_list_contents (prc->size, pt, off,
1068                                          &trigger_recursive_download, dc);
1069
1070   }
1071   GNUNET_assert (dc->completed <= dc->length);
1072   dr->state = BRS_DOWNLOAD_DOWN;
1073   pi.status = GNUNET_FS_STATUS_DOWNLOAD_PROGRESS;
1074   pi.value.download.specifics.progress.data = pt;
1075   pi.value.download.specifics.progress.offset = dr->offset;
1076   pi.value.download.specifics.progress.data_len = prc->size;
1077   pi.value.download.specifics.progress.depth = dr->depth;
1078   pi.value.download.specifics.progress.trust_offered = 0;
1079   if (prc->last_transmission.abs_value != GNUNET_TIME_UNIT_FOREVER_ABS.abs_value)
1080     pi.value.download.specifics.progress.block_download_duration =
1081         GNUNET_TIME_absolute_get_duration (prc->last_transmission);
1082   else
1083     pi.value.download.specifics.progress.block_download_duration.rel_value =
1084         GNUNET_TIME_UNIT_FOREVER_REL.rel_value;
1085   GNUNET_FS_download_make_status_ (&pi, dc);
1086   if (dr->depth == 0)
1087     propagate_up (dr);
1088
1089   if (dc->completed == dc->length)
1090   {
1091     /* download completed, signal */
1092 #if DEBUG_DOWNLOAD
1093     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1094                 "Download completed, truncating file to desired length %llu\n",
1095                 (unsigned long long) GNUNET_ntohll (dc->uri->data.
1096                                                     chk.file_length));
1097 #endif
1098     /* truncate file to size (since we store IBlocks at the end) */
1099     if (dc->filename != NULL)
1100     {
1101       if (0 !=
1102           truncate (dc->filename,
1103                     GNUNET_ntohll (dc->uri->data.chk.file_length)))
1104         GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "truncate",
1105                                   dc->filename);
1106     }
1107     GNUNET_assert (dr->depth == 0);
1108     check_completed (dc);
1109   }
1110   if (dr->depth == 0)
1111   {
1112     /* bottom of the tree, no child downloads possible, just sync */
1113     GNUNET_FS_download_sync_ (dc);
1114     return GNUNET_YES;
1115   }
1116
1117 #if DEBUG_DOWNLOAD
1118   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1119               "Triggering downloads of children (this block was at depth %u and offset %llu)\n",
1120               dr->depth, (unsigned long long) dr->offset);
1121 #endif
1122   GNUNET_assert (0 == (prc->size % sizeof (struct ContentHashKey)));
1123   chkarr = (struct ContentHashKey *) pt;
1124   for (i = (prc->size / sizeof (struct ContentHashKey)) - 1; i >= 0; i--)
1125   {
1126     drc = dr->children[i];
1127     switch (drc->state)
1128     {
1129     case BRS_INIT:
1130       drc->chk = chkarr[i];
1131       drc->state = BRS_CHK_SET;
1132       schedule_block_download (dc, drc);
1133       break;
1134     case BRS_RECONSTRUCT_DOWN:
1135       GNUNET_assert (0);
1136       break;
1137     case BRS_RECONSTRUCT_META_UP:
1138       GNUNET_assert (0);
1139       break;
1140     case BRS_RECONSTRUCT_UP:
1141       GNUNET_assert (0);
1142       break;
1143     case BRS_CHK_SET:
1144       GNUNET_assert (0);
1145       break;
1146     case BRS_DOWNLOAD_DOWN:
1147       GNUNET_assert (0);
1148       break;
1149     case BRS_DOWNLOAD_UP:
1150       GNUNET_assert (0);
1151       break;
1152     case BRS_ERROR:
1153       GNUNET_assert (0);
1154       break;
1155     default:
1156       GNUNET_assert (0);
1157       break;
1158     }
1159   }
1160   GNUNET_FS_download_sync_ (dc);
1161   return GNUNET_YES;
1162
1163 signal_error:
1164   if (fh != NULL)
1165     GNUNET_DISK_file_close (fh);
1166   pi.status = GNUNET_FS_STATUS_DOWNLOAD_ERROR;
1167   pi.value.download.specifics.error.message = dc->emsg;
1168   GNUNET_FS_download_make_status_ (&pi, dc);
1169   /* abort all pending requests */
1170   if (NULL != dc->th)
1171   {
1172     GNUNET_CLIENT_notify_transmit_ready_cancel (dc->th);
1173     dc->th = NULL;
1174   }
1175   GNUNET_CLIENT_disconnect (dc->client, GNUNET_NO);
1176   dc->in_receive = GNUNET_NO;
1177   dc->client = NULL;
1178   GNUNET_FS_free_download_request_ (dc->top_request);
1179   dc->top_request = NULL;
1180   GNUNET_CONTAINER_multihashmap_destroy (dc->active);
1181   dc->active = NULL;
1182   dc->pending_head = NULL;
1183   dc->pending_tail = NULL;
1184   GNUNET_FS_download_sync_ (dc);
1185   return GNUNET_NO;
1186 }
1187
1188
1189 /**
1190  * Process a download result.
1191  *
1192  * @param dc our download context
1193  * @param type type of the result
1194  * @param last_transmission when was this block requested the last time? (FOREVER if unknown/not applicable)
1195  * @param data the (encrypted) response
1196  * @param size size of data
1197  */
1198 static void
1199 process_result (struct GNUNET_FS_DownloadContext *dc,
1200                 enum GNUNET_BLOCK_Type type,
1201                 struct GNUNET_TIME_Absolute last_transmission,
1202                 const void *data, size_t size)
1203 {
1204   struct ProcessResultClosure prc;
1205
1206   prc.dc = dc;
1207   prc.data = data;
1208   prc.size = size;
1209   prc.type = type;
1210   prc.do_store = GNUNET_YES;
1211   prc.last_transmission = last_transmission;
1212   GNUNET_CRYPTO_hash (data, size, &prc.query);
1213 #if DEBUG_DOWNLOAD
1214   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1215               "Received result for query `%s' from `%s'-service\n",
1216               GNUNET_h2s (&prc.query), "FS");
1217 #endif
1218   GNUNET_CONTAINER_multihashmap_get_multiple (dc->active, &prc.query,
1219                                               &process_result_with_request,
1220                                               &prc);
1221 }
1222
1223
1224 /**
1225  * Type of a function to call when we receive a message
1226  * from the service.
1227  *
1228  * @param cls closure
1229  * @param msg message received, NULL on timeout or fatal error
1230  */
1231 static void
1232 receive_results (void *cls, const struct GNUNET_MessageHeader *msg)
1233 {
1234   struct GNUNET_FS_DownloadContext *dc = cls;
1235   const struct ClientPutMessage *cm;
1236   uint16_t msize;
1237
1238   if ((NULL == msg) || (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_FS_PUT) ||
1239       (sizeof (struct ClientPutMessage) > ntohs (msg->size)))
1240   {
1241     GNUNET_break (msg == NULL);
1242     try_reconnect (dc);
1243     return;
1244   }
1245   msize = ntohs (msg->size);
1246   cm = (const struct ClientPutMessage *) msg;
1247   process_result (dc, ntohl (cm->type),
1248                   GNUNET_TIME_absolute_ntoh (cm->last_transmission), &cm[1],
1249                   msize - sizeof (struct ClientPutMessage));
1250   if (dc->client == NULL)
1251     return;                     /* fatal error */
1252   /* continue receiving */
1253   GNUNET_CLIENT_receive (dc->client, &receive_results, dc,
1254                          GNUNET_TIME_UNIT_FOREVER_REL);
1255 }
1256
1257
1258
1259 /**
1260  * We're ready to transmit a search request to the
1261  * file-sharing service.  Do it.  If there is
1262  * more than one request pending, try to send
1263  * multiple or request another transmission.
1264  *
1265  * @param cls closure
1266  * @param size number of bytes available in buf
1267  * @param buf where the callee should write the message
1268  * @return number of bytes written to buf
1269  */
1270 static size_t
1271 transmit_download_request (void *cls, size_t size, void *buf)
1272 {
1273   struct GNUNET_FS_DownloadContext *dc = cls;
1274   size_t msize;
1275   struct SearchMessage *sm;
1276   struct DownloadRequest *dr;
1277
1278   dc->th = NULL;
1279   if (NULL == buf)
1280   {
1281 #if DEBUG_DOWNLOAD
1282     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1283                 "Transmitting download request failed, trying to reconnect\n");
1284 #endif
1285     try_reconnect (dc);
1286     return 0;
1287   }
1288   GNUNET_assert (size >= sizeof (struct SearchMessage));
1289   msize = 0;
1290   sm = buf;
1291   while ((NULL != (dr = dc->pending_head)) &&
1292          (size >= msize + sizeof (struct SearchMessage)))
1293   {
1294 #if DEBUG_DOWNLOAD
1295     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1296                 "Transmitting download request for `%s' to `%s'-service\n",
1297                 GNUNET_h2s (&dr->chk.query), "FS");
1298 #endif
1299     memset (sm, 0, sizeof (struct SearchMessage));
1300     sm->header.size = htons (sizeof (struct SearchMessage));
1301     sm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_START_SEARCH);
1302     if (0 != (dc->options & GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY))
1303       sm->options = htonl (GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY);
1304     else
1305       sm->options = htonl (GNUNET_FS_SEARCH_OPTION_NONE);
1306     if (dr->depth == 0)
1307       sm->type = htonl (GNUNET_BLOCK_TYPE_FS_DBLOCK);
1308     else
1309       sm->type = htonl (GNUNET_BLOCK_TYPE_FS_IBLOCK);
1310     sm->anonymity_level = htonl (dc->anonymity);
1311     sm->target = dc->target.hashPubKey;
1312     sm->query = dr->chk.query;
1313     GNUNET_CONTAINER_DLL_remove (dc->pending_head, dc->pending_tail, dr);
1314     dr->is_pending = GNUNET_NO;
1315     msize += sizeof (struct SearchMessage);
1316     sm++;
1317   }
1318   if (dc->pending_head != NULL)
1319   {
1320     dc->th =
1321         GNUNET_CLIENT_notify_transmit_ready (dc->client,
1322                                              sizeof (struct SearchMessage),
1323                                              GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1324                                              GNUNET_NO,
1325                                              &transmit_download_request, dc);
1326     GNUNET_assert (dc->th != NULL);
1327   }
1328   if (GNUNET_NO == dc->in_receive)
1329   {
1330     dc->in_receive = GNUNET_YES;
1331     GNUNET_CLIENT_receive (dc->client, &receive_results, dc,
1332                            GNUNET_TIME_UNIT_FOREVER_REL);
1333   }
1334   return msize;
1335 }
1336
1337
1338 /**
1339  * Reconnect to the FS service and transmit our queries NOW.
1340  *
1341  * @param cls our download context
1342  * @param tc unused
1343  */
1344 static void
1345 do_reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1346 {
1347   struct GNUNET_FS_DownloadContext *dc = cls;
1348   struct GNUNET_CLIENT_Connection *client;
1349
1350   dc->task = GNUNET_SCHEDULER_NO_TASK;
1351   client = GNUNET_CLIENT_connect ("fs", dc->h->cfg);
1352   if (NULL == client)
1353   {
1354     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1355                 "Connecting to `%s'-service failed, will try again.\n", "FS");
1356     try_reconnect (dc);
1357     return;
1358   }
1359   dc->client = client;
1360   if (dc->pending_head != NULL)
1361   {
1362     dc->th =
1363         GNUNET_CLIENT_notify_transmit_ready (client,
1364                                              sizeof (struct SearchMessage),
1365                                              GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1366                                              GNUNET_NO,
1367                                              &transmit_download_request, dc);
1368     GNUNET_assert (dc->th != NULL);
1369   }
1370 }
1371
1372
1373 /**
1374  * Add entries to the pending list.
1375  *
1376  * @param cls our download context
1377  * @param key unused
1378  * @param entry entry of type "struct DownloadRequest"
1379  * @return GNUNET_OK
1380  */
1381 static int
1382 retry_entry (void *cls, const GNUNET_HashCode * key, void *entry)
1383 {
1384   struct GNUNET_FS_DownloadContext *dc = cls;
1385   struct DownloadRequest *dr = entry;
1386
1387   dr->next = NULL;
1388   dr->prev = NULL;
1389   GNUNET_CONTAINER_DLL_insert (dc->pending_head, dc->pending_tail, dr);
1390   dr->is_pending = GNUNET_YES;
1391   return GNUNET_OK;
1392 }
1393
1394
1395 /**
1396  * We've lost our connection with the FS service.
1397  * Re-establish it and re-transmit all of our
1398  * pending requests.
1399  *
1400  * @param dc download context that is having trouble
1401  */
1402 static void
1403 try_reconnect (struct GNUNET_FS_DownloadContext *dc)
1404 {
1405
1406   if (NULL != dc->client)
1407   {
1408 #if DEBUG_DOWNLOAD
1409     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1410                 "Moving all requests back to pending list\n");
1411 #endif
1412     if (NULL != dc->th)
1413     {
1414       GNUNET_CLIENT_notify_transmit_ready_cancel (dc->th);
1415       dc->th = NULL;
1416     }
1417     /* full reset of the pending list */
1418     dc->pending_head = NULL;
1419     dc->pending_tail = NULL;
1420     GNUNET_CONTAINER_multihashmap_iterate (dc->active, &retry_entry, dc);
1421     GNUNET_CLIENT_disconnect (dc->client, GNUNET_NO);
1422     dc->in_receive = GNUNET_NO;
1423     dc->client = NULL;
1424   }
1425 #if DEBUG_DOWNLOAD
1426   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Will try to reconnect in 1s\n");
1427 #endif
1428   dc->task =
1429       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &do_reconnect,
1430                                     dc);
1431 }
1432
1433
1434 /**
1435  * We're allowed to ask the FS service for our blocks.  Start the download.
1436  *
1437  * @param cls the 'struct GNUNET_FS_DownloadContext'
1438  * @param client handle to use for communcation with FS (we must destroy it!)
1439  */
1440 static void
1441 activate_fs_download (void *cls, struct GNUNET_CLIENT_Connection *client)
1442 {
1443   struct GNUNET_FS_DownloadContext *dc = cls;
1444   struct GNUNET_FS_ProgressInfo pi;
1445
1446 #if DEBUG_DOWNLOAD
1447   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Download activated\n");
1448 #endif
1449   GNUNET_assert (NULL != client);
1450   GNUNET_assert (dc->client == NULL);
1451   GNUNET_assert (dc->th == NULL);
1452   dc->client = client;
1453   pi.status = GNUNET_FS_STATUS_DOWNLOAD_ACTIVE;
1454   GNUNET_FS_download_make_status_ (&pi, dc);
1455   dc->pending_head = NULL;
1456   dc->pending_tail = NULL;
1457   GNUNET_CONTAINER_multihashmap_iterate (dc->active, &retry_entry, dc);
1458 #if DEBUG_DOWNLOAD
1459   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1460               "Asking for transmission to FS service\n");
1461 #endif
1462   if (dc->pending_head != NULL)
1463   {
1464     dc->th =
1465         GNUNET_CLIENT_notify_transmit_ready (dc->client,
1466                                              sizeof (struct SearchMessage),
1467                                              GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1468                                              GNUNET_NO,
1469                                              &transmit_download_request, dc);
1470     GNUNET_assert (dc->th != NULL);
1471   }
1472 }
1473
1474
1475 /**
1476  * We must stop to ask the FS service for our blocks.  Pause the download.
1477  *
1478  * @param cls the 'struct GNUNET_FS_DownloadContext'
1479  */
1480 static void
1481 deactivate_fs_download (void *cls)
1482 {
1483   struct GNUNET_FS_DownloadContext *dc = cls;
1484   struct GNUNET_FS_ProgressInfo pi;
1485
1486 #if DEBUG_DOWNLOAD
1487   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Download deactivated\n");
1488 #endif
1489   if (NULL != dc->th)
1490   {
1491     GNUNET_CLIENT_notify_transmit_ready_cancel (dc->th);
1492     dc->th = NULL;
1493   }
1494   if (NULL != dc->client)
1495   {
1496     GNUNET_CLIENT_disconnect (dc->client, GNUNET_NO);
1497     dc->in_receive = GNUNET_NO;
1498     dc->client = NULL;
1499   }
1500   dc->pending_head = NULL;
1501   dc->pending_tail = NULL;
1502   pi.status = GNUNET_FS_STATUS_DOWNLOAD_INACTIVE;
1503   GNUNET_FS_download_make_status_ (&pi, dc);
1504 }
1505
1506
1507 /**
1508  * (recursively) Create a download request structure.
1509  *
1510  * @param parent parent of the current entry
1511  * @param depth depth of the current entry, 0 are the DBLOCKs,
1512  *              top level block is 'dc->treedepth - 1'
1513  * @param dr_offset offset in the original file this block maps to
1514  *              (as in, offset of the first byte of the first DBLOCK
1515  *               in the subtree rooted in the returned download request tree)
1516  * @param file_start_offset desired starting offset for the download
1517  *             in the original file; requesting tree should not contain
1518  *             DBLOCKs prior to the file_start_offset
1519  * @param desired_length desired number of bytes the user wanted to access
1520  *        (from file_start_offset).  Resulting tree should not contain
1521  *        DBLOCKs after file_start_offset + file_length.
1522  * @return download request tree for the given range of DBLOCKs at
1523  *         the specified depth
1524  */
1525 static struct DownloadRequest *
1526 create_download_request (struct DownloadRequest *parent, unsigned int depth,
1527                          uint64_t dr_offset, uint64_t file_start_offset,
1528                          uint64_t desired_length)
1529 {
1530   struct DownloadRequest *dr;
1531   unsigned int i;
1532   unsigned int head_skip;
1533   uint64_t child_block_size;
1534
1535   dr = GNUNET_malloc (sizeof (struct DownloadRequest));
1536   dr->parent = parent;
1537   dr->depth = depth;
1538   dr->offset = dr_offset;
1539   if (depth > 0)
1540   {
1541     child_block_size = GNUNET_FS_tree_compute_tree_size (depth - 1);
1542
1543     /* calculate how many blocks at this level are not interesting
1544      * from the start (rounded down), either because of the requested
1545      * file offset or because this IBlock is further along */
1546     if (dr_offset < file_start_offset)
1547       head_skip = file_start_offset / child_block_size;
1548     else
1549       head_skip = dr_offset / child_block_size;
1550
1551     /* calculate index of last block at this level that is interesting (rounded up) */
1552     dr->num_children = file_start_offset + desired_length / child_block_size;
1553     if (dr->num_children * child_block_size <
1554         file_start_offset + desired_length)
1555       dr->num_children++;       /* round up */
1556
1557     /* now we can get the total number of children for this block */
1558     dr->num_children -= head_skip;
1559     if (dr->num_children > CHK_PER_INODE)
1560       dr->num_children = CHK_PER_INODE; /* cap at max */
1561
1562     /* why else would we have gotten here to begin with? (that'd be a bad logic error) */
1563     GNUNET_assert (dr->num_children > 0);
1564
1565     dr->children =
1566         GNUNET_malloc (dr->num_children * sizeof (struct DownloadRequest *));
1567     for (i = 0; i < dr->num_children; i++)
1568       dr->children[i] =
1569           create_download_request (dr, depth - 1,
1570                                    dr_offset + i * child_block_size,
1571                                    file_start_offset, desired_length);
1572   }
1573   return dr;
1574 }
1575
1576
1577 /**
1578  * Continuation after a possible attempt to reconstruct
1579  * the current IBlock from the existing file.
1580  *
1581  * @param cls the 'struct ReconstructContext'
1582  * @param tc scheduler context
1583  */
1584 static void
1585 reconstruct_cont (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1586 {
1587   struct GNUNET_FS_DownloadContext *dc = cls;
1588
1589   /* clean up state from tree encoder */
1590   if (dc->te != NULL)
1591   {
1592     GNUNET_FS_tree_encoder_finish (dc->te, NULL, NULL);
1593     dc->te = NULL;
1594   }
1595   if (dc->task != GNUNET_SCHEDULER_NO_TASK)
1596   {
1597     GNUNET_SCHEDULER_cancel (dc->task);
1598     dc->task = GNUNET_SCHEDULER_NO_TASK;
1599   }
1600   if (dc->rfh != NULL)
1601   {
1602     GNUNET_break (GNUNET_OK == GNUNET_DISK_file_close (dc->rfh));
1603     dc->rfh = NULL;
1604   }
1605   /* start "normal" download */
1606   schedule_block_download (dc, dc->top_request);
1607 }
1608
1609
1610 /**
1611  * Task requesting the next block from the tree encoder.
1612  *
1613  * @param cls the 'struct GNUJNET_FS_DownloadContext' we're processing
1614  * @param tc task context
1615  */
1616 static void
1617 get_next_block (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1618 {
1619   struct GNUNET_FS_DownloadContext *dc = cls;
1620
1621   dc->task = GNUNET_SCHEDULER_NO_TASK;
1622   GNUNET_FS_tree_encoder_next (dc->te);
1623 }
1624
1625
1626
1627 /**
1628  * Function called asking for the current (encoded)
1629  * block to be processed.  After processing the
1630  * client should either call "GNUNET_FS_tree_encode_next"
1631  * or (on error) "GNUNET_FS_tree_encode_finish".
1632  *
1633  * This function checks if the content on disk matches
1634  * the expected content based on the URI.
1635  *
1636  * @param cls closure
1637  * @param chk content hash key for the block
1638  * @param offset offset of the block
1639  * @param depth depth of the block, 0 for DBLOCK
1640  * @param type type of the block (IBLOCK or DBLOCK)
1641  * @param block the (encrypted) block
1642  * @param block_size size of block (in bytes)
1643  */
1644 static void
1645 reconstruct_cb (void *cls, const struct ContentHashKey *chk, uint64_t offset,
1646                 unsigned int depth, enum GNUNET_BLOCK_Type type,
1647                 const void *block, uint16_t block_size)
1648 {
1649   struct GNUNET_FS_DownloadContext *dc = cls;
1650   struct GNUNET_FS_ProgressInfo pi;
1651   struct DownloadRequest *dr;
1652   uint64_t blen;
1653   unsigned int chld;
1654
1655   /* find corresponding request entry */
1656   dr = dc->top_request;
1657   while (dr->depth > depth)
1658   {
1659     blen = GNUNET_FS_tree_compute_tree_size (dr->depth);
1660     chld = (offset - dr->offset) / blen;
1661     GNUNET_assert (chld < dr->num_children);
1662     dr = dr->children[chld];
1663   }
1664   /* FIXME: this code needs more testing and might
1665      need to handle more states... */
1666   switch (dr->state)
1667   {
1668   case BRS_INIT:
1669     break;
1670   case BRS_RECONSTRUCT_DOWN:
1671     break;
1672   case BRS_RECONSTRUCT_META_UP:
1673     break;
1674   case BRS_RECONSTRUCT_UP:
1675     break;
1676   case BRS_CHK_SET:
1677     if (0 == memcmp (chk, &dr->chk, sizeof (struct ContentHashKey)))
1678     {
1679       /* block matches, hence tree below matches;
1680        * this request is done! */
1681       dr->state = BRS_DOWNLOAD_UP;
1682       GNUNET_assert (GNUNET_YES ==
1683                      GNUNET_CONTAINER_multihashmap_remove (dc->active, &dr->chk.query, dr));
1684       if (GNUNET_YES == dr->is_pending)
1685       {
1686         GNUNET_CONTAINER_DLL_remove (dc->pending_head, dc->pending_tail, dr);
1687         dr->is_pending = GNUNET_NO;
1688       }
1689       /* calculate how many bytes of payload this block
1690        * corresponds to */
1691       blen = GNUNET_FS_tree_compute_tree_size (dr->depth);
1692       /* how many of those bytes are in the requested range? */
1693       blen = GNUNET_MIN (blen, dc->length + dc->offset - dr->offset);
1694       /* signal progress */
1695       dc->completed += blen;
1696       pi.status = GNUNET_FS_STATUS_DOWNLOAD_PROGRESS;
1697       pi.value.download.specifics.progress.data = NULL;
1698       pi.value.download.specifics.progress.offset = offset;
1699       pi.value.download.specifics.progress.data_len = 0;
1700       pi.value.download.specifics.progress.depth = 0;
1701       pi.value.download.specifics.progress.trust_offered = 0;
1702       GNUNET_FS_download_make_status_ (&pi, dc);
1703       /* FIXME: duplicated code from 'process_result_with_request - refactor */
1704       if (dc->completed == dc->length)
1705       {
1706         /* download completed, signal */
1707 #if DEBUG_DOWNLOAD
1708         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1709                     "Download completed, truncating file to desired length %llu\n",
1710                     (unsigned long long) GNUNET_ntohll (dc->uri->data.
1711                                                         chk.file_length));
1712 #endif
1713         /* truncate file to size (since we store IBlocks at the end) */
1714         if (dc->filename != NULL)
1715         {
1716           if (0 !=
1717               truncate (dc->filename,
1718                         GNUNET_ntohll (dc->uri->data.chk.file_length)))
1719             GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "truncate",
1720                                       dc->filename);
1721         }
1722       }
1723     }
1724     break;
1725   case BRS_DOWNLOAD_DOWN:
1726     break;
1727   case BRS_DOWNLOAD_UP:
1728     break;
1729   case BRS_ERROR:
1730     break;
1731   default:
1732     GNUNET_assert (0);
1733     break;
1734   }
1735   if ((dr == dc->top_request) && (dr->state == BRS_DOWNLOAD_UP))
1736   {
1737     check_completed (dc);
1738     return;
1739   }
1740   dc->task = GNUNET_SCHEDULER_add_now (&get_next_block, dc);
1741 }
1742
1743
1744 /**
1745  * Function called by the tree encoder to obtain a block of plaintext
1746  * data (for the lowest level of the tree).
1747  *
1748  * @param cls our 'struct ReconstructContext'
1749  * @param offset identifies which block to get
1750  * @param max (maximum) number of bytes to get; returning
1751  *        fewer will also cause errors
1752  * @param buf where to copy the plaintext buffer
1753  * @param emsg location to store an error message (on error)
1754  * @return number of bytes copied to buf, 0 on error
1755  */
1756 static size_t
1757 fh_reader (void *cls, uint64_t offset, size_t max, void *buf, char **emsg)
1758 {
1759   struct GNUNET_FS_DownloadContext *dc = cls;
1760   struct GNUNET_DISK_FileHandle *fh = dc->rfh;
1761   ssize_t ret;
1762
1763   *emsg = NULL;
1764   if (offset != GNUNET_DISK_file_seek (fh, offset, GNUNET_DISK_SEEK_SET))
1765   {
1766     *emsg = GNUNET_strdup (strerror (errno));
1767     return 0;
1768   }
1769   ret = GNUNET_DISK_file_read (fh, buf, max);
1770   if (ret < 0)
1771   {
1772     *emsg = GNUNET_strdup (strerror (errno));
1773     return 0;
1774   }
1775   return ret;
1776 }
1777
1778
1779 /**
1780  * Task that creates the initial (top-level) download
1781  * request for the file.
1782  *
1783  * @param cls the 'struct GNUNET_FS_DownloadContext'
1784  * @param tc scheduler context
1785  */
1786 void
1787 GNUNET_FS_download_start_task_ (void *cls,
1788                                 const struct GNUNET_SCHEDULER_TaskContext *tc)
1789 {
1790   struct GNUNET_FS_DownloadContext *dc = cls;
1791   struct GNUNET_FS_ProgressInfo pi;
1792   struct GNUNET_DISK_FileHandle *fh;
1793
1794 #if DEBUG_DOWNLOAD
1795   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Start task running...\n");
1796 #endif
1797   dc->task = GNUNET_SCHEDULER_NO_TASK;
1798   if (dc->length == 0)
1799   {
1800     /* no bytes required! */
1801     if (dc->filename != NULL)
1802     {
1803       fh = GNUNET_DISK_file_open (dc->filename,
1804                                   GNUNET_DISK_OPEN_READWRITE |
1805                                   GNUNET_DISK_OPEN_CREATE |
1806                                   ((0 ==
1807                                     GNUNET_FS_uri_chk_get_file_size (dc->uri)) ?
1808                                    GNUNET_DISK_OPEN_TRUNCATE : 0),
1809                                   GNUNET_DISK_PERM_USER_READ |
1810                                   GNUNET_DISK_PERM_USER_WRITE |
1811                                   GNUNET_DISK_PERM_GROUP_READ |
1812                                   GNUNET_DISK_PERM_OTHER_READ);
1813       GNUNET_DISK_file_close (fh);
1814     }
1815     GNUNET_FS_download_sync_ (dc);
1816     pi.status = GNUNET_FS_STATUS_DOWNLOAD_START;
1817     pi.value.download.specifics.start.meta = dc->meta;
1818     GNUNET_FS_download_make_status_ (&pi, dc);
1819     check_completed (dc);
1820     return;
1821   }
1822   if (dc->emsg != NULL)
1823     return;
1824   if (dc->top_request == NULL)
1825   {
1826     dc->top_request =
1827         create_download_request (NULL, dc->treedepth - 1, 0, dc->offset,
1828                                  dc->length);
1829     dc->top_request->state = BRS_CHK_SET;
1830     dc->top_request->chk =
1831         (dc->uri->type ==
1832          chk) ? dc->uri->data.chk.chk : dc->uri->data.loc.fi.chk;
1833     /* signal start */
1834     GNUNET_FS_download_sync_ (dc);
1835     pi.status = GNUNET_FS_STATUS_DOWNLOAD_START;
1836     pi.value.download.specifics.start.meta = dc->meta;
1837     GNUNET_FS_download_make_status_ (&pi, dc);
1838   }
1839   GNUNET_FS_download_start_downloading_ (dc);
1840   /* attempt reconstruction from disk */
1841   if (GNUNET_YES == GNUNET_DISK_file_test (dc->filename))
1842     dc->rfh =
1843         GNUNET_DISK_file_open (dc->filename, GNUNET_DISK_OPEN_READ,
1844                                GNUNET_DISK_PERM_NONE);
1845   if (dc->top_request->state == BRS_CHK_SET)
1846   {
1847     if (dc->rfh != NULL)
1848     {
1849       /* first, try top-down */
1850 #if DEBUG_DOWNLOAD
1851       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1852                   "Trying top-down reconstruction for `%s'\n", dc->filename);
1853 #endif
1854       try_top_down_reconstruction (dc, dc->top_request);
1855       switch (dc->top_request->state)
1856       {
1857       case BRS_CHK_SET:
1858         break;                  /* normal */
1859       case BRS_DOWNLOAD_DOWN:
1860         break;                  /* normal, some blocks already down */
1861       case BRS_DOWNLOAD_UP:
1862         /* already done entirely, party! */
1863         if (dc->rfh != NULL)
1864         {
1865           /* avoid hanging on to file handle longer than
1866            * necessary */
1867           GNUNET_DISK_file_close (dc->rfh);
1868           dc->rfh = NULL;
1869         }
1870         return;
1871       case BRS_ERROR:
1872         GNUNET_asprintf (&dc->emsg, _("Invalid URI"));
1873         GNUNET_FS_download_sync_ (dc);
1874         pi.status = GNUNET_FS_STATUS_DOWNLOAD_ERROR;
1875         pi.value.download.specifics.error.message = dc->emsg;
1876         GNUNET_FS_download_make_status_ (&pi, dc);
1877         return;
1878       default:
1879         GNUNET_assert (0);
1880         break;
1881       }
1882     }
1883   }
1884   /* attempt reconstruction from meta data */
1885   if ((GNUNET_FS_uri_chk_get_file_size (dc->uri) <= MAX_INLINE_SIZE) &&
1886       (NULL != dc->meta))
1887   {
1888 #if DEBUG_DOWNLOAD
1889     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1890                 "Trying to find embedded meta data for download of size %llu with %u bytes MD\n",
1891                 (unsigned long long) GNUNET_FS_uri_chk_get_file_size (dc->uri),
1892                 (unsigned int)
1893                 GNUNET_CONTAINER_meta_data_get_serialized_size (dc->meta));
1894 #endif
1895     GNUNET_CONTAINER_meta_data_iterate (dc->meta, &match_full_data, dc);
1896     if (dc->top_request->state == BRS_DOWNLOAD_UP)
1897     {
1898       if (dc->rfh != NULL)
1899       {
1900         /* avoid hanging on to file handle longer than
1901          * necessary */
1902         GNUNET_DISK_file_close (dc->rfh);
1903         dc->rfh = NULL;
1904       }
1905       return;                   /* finished, status update was already done for us */
1906     }
1907   }
1908   if (dc->rfh != NULL)
1909   {
1910     /* finally, try bottom-up */
1911 #if DEBUG_DOWNLOAD
1912     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1913                 "Trying bottom-up reconstruction of file `%s'\n", dc->filename);
1914 #endif
1915     dc->te =
1916         GNUNET_FS_tree_encoder_create (dc->h, dc->old_file_size, dc, &fh_reader,
1917                                        &reconstruct_cb, NULL,
1918                                        &reconstruct_cont);
1919     dc->task = GNUNET_SCHEDULER_add_now (&get_next_block, dc);
1920   }
1921   else
1922   {
1923     /* simple, top-level download */
1924     schedule_block_download (dc, dc->top_request);
1925   }
1926   if (dc->top_request->state == BRS_DOWNLOAD_UP)
1927     check_completed (dc);
1928 }
1929
1930
1931 /**
1932  * Create SUSPEND event for the given download operation
1933  * and then clean up our state (without stop signal).
1934  *
1935  * @param cls the 'struct GNUNET_FS_DownloadContext' to signal for
1936  */
1937 void
1938 GNUNET_FS_download_signal_suspend_ (void *cls)
1939 {
1940   struct GNUNET_FS_DownloadContext *dc = cls;
1941   struct GNUNET_FS_ProgressInfo pi;
1942
1943   if (dc->top != NULL)
1944     GNUNET_FS_end_top (dc->h, dc->top);
1945   while (NULL != dc->child_head)
1946     GNUNET_FS_download_signal_suspend_ (dc->child_head);
1947   if (dc->search != NULL)
1948   {
1949     dc->search->download = NULL;
1950     dc->search = NULL;
1951   }
1952   if (dc->job_queue != NULL)
1953   {
1954     GNUNET_FS_dequeue_ (dc->job_queue);
1955     dc->job_queue = NULL;
1956   }
1957   if (dc->parent != NULL)
1958     GNUNET_CONTAINER_DLL_remove (dc->parent->child_head, dc->parent->child_tail,
1959                                  dc);
1960   if (dc->task != GNUNET_SCHEDULER_NO_TASK)
1961   {
1962     GNUNET_SCHEDULER_cancel (dc->task);
1963     dc->task = GNUNET_SCHEDULER_NO_TASK;
1964   }
1965   pi.status = GNUNET_FS_STATUS_DOWNLOAD_SUSPEND;
1966   GNUNET_FS_download_make_status_ (&pi, dc);
1967   if (dc->te != NULL)
1968   {
1969     GNUNET_FS_tree_encoder_finish (dc->te, NULL, NULL);
1970     dc->te = NULL;
1971   }
1972   if (dc->rfh != NULL)
1973   {
1974     GNUNET_DISK_file_close (dc->rfh);
1975     dc->rfh = NULL;
1976   }
1977   GNUNET_FS_free_download_request_ (dc->top_request);
1978   if (dc->active != NULL)
1979   {
1980     GNUNET_CONTAINER_multihashmap_destroy (dc->active);
1981     dc->active = NULL;
1982   }
1983   GNUNET_free_non_null (dc->filename);
1984   GNUNET_CONTAINER_meta_data_destroy (dc->meta);
1985   GNUNET_FS_uri_destroy (dc->uri);
1986   GNUNET_free_non_null (dc->temp_filename);
1987   GNUNET_free_non_null (dc->serialization);
1988   GNUNET_free (dc);
1989 }
1990
1991
1992 /**
1993  * Download parts of a file.  Note that this will store
1994  * the blocks at the respective offset in the given file.  Also, the
1995  * download is still using the blocking of the underlying FS
1996  * encoding.  As a result, the download may *write* outside of the
1997  * given boundaries (if offset and length do not match the 32k FS
1998  * block boundaries). <p>
1999  *
2000  * This function should be used to focus a download towards a
2001  * particular portion of the file (optimization), not to strictly
2002  * limit the download to exactly those bytes.
2003  *
2004  * @param h handle to the file sharing subsystem
2005  * @param uri the URI of the file (determines what to download); CHK or LOC URI
2006  * @param meta known metadata for the file (can be NULL)
2007  * @param filename where to store the file, maybe NULL (then no file is
2008  *        created on disk and data must be grabbed from the callbacks)
2009  * @param tempname where to store temporary file data, not used if filename is non-NULL;
2010  *        can be NULL (in which case we will pick a name if needed); the temporary file
2011  *        may already exist, in which case we will try to use the data that is there and
2012  *        if it is not what is desired, will overwrite it
2013  * @param offset at what offset should we start the download (typically 0)
2014  * @param length how many bytes should be downloaded starting at offset
2015  * @param anonymity anonymity level to use for the download
2016  * @param options various options
2017  * @param cctx initial value for the client context for this download
2018  * @param parent parent download to associate this download with (use NULL
2019  *        for top-level downloads; useful for manually-triggered recursive downloads)
2020  * @return context that can be used to control this download
2021  */
2022 struct GNUNET_FS_DownloadContext *
2023 GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
2024                           const struct GNUNET_FS_Uri *uri,
2025                           const struct GNUNET_CONTAINER_MetaData *meta,
2026                           const char *filename, const char *tempname,
2027                           uint64_t offset, uint64_t length, uint32_t anonymity,
2028                           enum GNUNET_FS_DownloadOptions options, void *cctx,
2029                           struct GNUNET_FS_DownloadContext *parent)
2030 {
2031   struct GNUNET_FS_DownloadContext *dc;
2032
2033   GNUNET_assert (GNUNET_FS_uri_test_chk (uri) || GNUNET_FS_uri_test_loc (uri));
2034
2035   if ((offset + length < offset) ||
2036       (offset + length > GNUNET_FS_uri_chk_get_file_size (uri)))
2037   {
2038     GNUNET_break (0);
2039     return NULL;
2040   }
2041 #if DEBUG_DOWNLOAD
2042   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Starting download `%s' of %llu bytes\n",
2043               filename, (unsigned long long) length);
2044 #endif
2045   dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2046   dc->h = h;
2047   dc->parent = parent;
2048   if (parent != NULL)
2049   {
2050     GNUNET_CONTAINER_DLL_insert (parent->child_head, parent->child_tail, dc);
2051   }
2052   dc->uri = GNUNET_FS_uri_dup (uri);
2053   dc->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
2054   dc->client_info = cctx;
2055   dc->start_time = GNUNET_TIME_absolute_get ();
2056   if (NULL != filename)
2057   {
2058     dc->filename = GNUNET_strdup (filename);
2059     if (GNUNET_YES == GNUNET_DISK_file_test (filename))
2060       GNUNET_DISK_file_size (filename, &dc->old_file_size, GNUNET_YES);
2061   }
2062   if (GNUNET_FS_uri_test_loc (dc->uri))
2063     GNUNET_assert (GNUNET_OK ==
2064                    GNUNET_FS_uri_loc_get_peer_identity (dc->uri, &dc->target));
2065   dc->offset = offset;
2066   dc->length = length;
2067   dc->anonymity = anonymity;
2068   dc->options = options;
2069   dc->active =
2070       GNUNET_CONTAINER_multihashmap_create (1 + 2 * (length / DBLOCK_SIZE));
2071   dc->treedepth =
2072       GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
2073   if ((filename == NULL) && (is_recursive_download (dc)))
2074   {
2075     if (tempname != NULL)
2076       dc->temp_filename = GNUNET_strdup (tempname);
2077     else
2078       dc->temp_filename = GNUNET_DISK_mktemp ("gnunet-directory-download-tmp");
2079   }
2080
2081 #if DEBUG_DOWNLOAD
2082   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Download tree has depth %u\n",
2083               dc->treedepth);
2084 #endif
2085   if (parent == NULL)
2086   {
2087     dc->top =
2088         GNUNET_FS_make_top (dc->h, &GNUNET_FS_download_signal_suspend_, dc);
2089   }
2090   dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_, dc);
2091   return dc;
2092 }
2093
2094
2095 /**
2096  * Download parts of a file based on a search result.  The download
2097  * will be associated with the search result (and the association
2098  * will be preserved when serializing/deserializing the state).
2099  * If the search is stopped, the download will not be aborted but
2100  * be 'promoted' to a stand-alone download.
2101  *
2102  * As with the other download function, this will store
2103  * the blocks at the respective offset in the given file.  Also, the
2104  * download is still using the blocking of the underlying FS
2105  * encoding.  As a result, the download may *write* outside of the
2106  * given boundaries (if offset and length do not match the 32k FS
2107  * block boundaries). <p>
2108  *
2109  * The given range can be used to focus a download towards a
2110  * particular portion of the file (optimization), not to strictly
2111  * limit the download to exactly those bytes.
2112  *
2113  * @param h handle to the file sharing subsystem
2114  * @param sr the search result to use for the download (determines uri and
2115  *        meta data and associations)
2116  * @param filename where to store the file, maybe NULL (then no file is
2117  *        created on disk and data must be grabbed from the callbacks)
2118  * @param tempname where to store temporary file data, not used if filename is non-NULL;
2119  *        can be NULL (in which case we will pick a name if needed); the temporary file
2120  *        may already exist, in which case we will try to use the data that is there and
2121  *        if it is not what is desired, will overwrite it
2122  * @param offset at what offset should we start the download (typically 0)
2123  * @param length how many bytes should be downloaded starting at offset
2124  * @param anonymity anonymity level to use for the download
2125  * @param options various download options
2126  * @param cctx initial value for the client context for this download
2127  * @return context that can be used to control this download
2128  */
2129 struct GNUNET_FS_DownloadContext *
2130 GNUNET_FS_download_start_from_search (struct GNUNET_FS_Handle *h,
2131                                       struct GNUNET_FS_SearchResult *sr,
2132                                       const char *filename,
2133                                       const char *tempname, uint64_t offset,
2134                                       uint64_t length, uint32_t anonymity,
2135                                       enum GNUNET_FS_DownloadOptions options,
2136                                       void *cctx)
2137 {
2138   struct GNUNET_FS_DownloadContext *dc;
2139
2140   if ((sr == NULL) || (sr->download != NULL))
2141   {
2142     GNUNET_break (0);
2143     return NULL;
2144   }
2145   GNUNET_assert (GNUNET_FS_uri_test_chk (sr->uri) ||
2146                  GNUNET_FS_uri_test_loc (sr->uri));
2147   if ((offset + length < offset) ||
2148       (offset + length > sr->uri->data.chk.file_length))
2149   {
2150     GNUNET_break (0);
2151     return NULL;
2152   }
2153 #if DEBUG_DOWNLOAD
2154   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Starting download `%s' of %llu bytes\n",
2155               filename, (unsigned long long) length);
2156 #endif
2157   dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2158   dc->h = h;
2159   dc->search = sr;
2160   sr->download = dc;
2161   if (sr->probe_ctx != NULL)
2162   {
2163     GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
2164     sr->probe_ctx = NULL;
2165   }
2166   dc->uri = GNUNET_FS_uri_dup (sr->uri);
2167   dc->meta = GNUNET_CONTAINER_meta_data_duplicate (sr->meta);
2168   dc->client_info = cctx;
2169   dc->start_time = GNUNET_TIME_absolute_get ();
2170   if (NULL != filename)
2171   {
2172     dc->filename = GNUNET_strdup (filename);
2173     if (GNUNET_YES == GNUNET_DISK_file_test (filename))
2174       GNUNET_DISK_file_size (filename, &dc->old_file_size, GNUNET_YES);
2175   }
2176   if (GNUNET_FS_uri_test_loc (dc->uri))
2177     GNUNET_assert (GNUNET_OK ==
2178                    GNUNET_FS_uri_loc_get_peer_identity (dc->uri, &dc->target));
2179   dc->offset = offset;
2180   dc->length = length;
2181   dc->anonymity = anonymity;
2182   dc->options = options;
2183   dc->active =
2184       GNUNET_CONTAINER_multihashmap_create (1 + 2 * (length / DBLOCK_SIZE));
2185   dc->treedepth =
2186       GNUNET_FS_compute_depth (GNUNET_ntohll (dc->uri->data.chk.file_length));
2187   if ((filename == NULL) && (is_recursive_download (dc)))
2188   {
2189     if (tempname != NULL)
2190       dc->temp_filename = GNUNET_strdup (tempname);
2191     else
2192       dc->temp_filename = GNUNET_DISK_mktemp ("gnunet-directory-download-tmp");
2193   }
2194
2195 #if DEBUG_DOWNLOAD
2196   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Download tree has depth %u\n",
2197               dc->treedepth);
2198 #endif
2199   dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_, dc);
2200   return dc;
2201 }
2202
2203
2204 /**
2205  * Start the downloading process (by entering the queue).
2206  *
2207  * @param dc our download context
2208  */
2209 void
2210 GNUNET_FS_download_start_downloading_ (struct GNUNET_FS_DownloadContext *dc)
2211 {
2212   if (dc->completed == dc->length)
2213     return;
2214   GNUNET_assert (dc->job_queue == NULL);
2215   dc->job_queue =
2216       GNUNET_FS_queue_ (dc->h, &activate_fs_download, &deactivate_fs_download,
2217                         dc, (dc->length + DBLOCK_SIZE - 1) / DBLOCK_SIZE);
2218 }
2219
2220
2221 /**
2222  * Stop a download (aborts if download is incomplete).
2223  *
2224  * @param dc handle for the download
2225  * @param do_delete delete files of incomplete downloads
2226  */
2227 void
2228 GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc, int do_delete)
2229 {
2230   struct GNUNET_FS_ProgressInfo pi;
2231   int have_children;
2232
2233   if (dc->top != NULL)
2234     GNUNET_FS_end_top (dc->h, dc->top);
2235
2236
2237   if (dc->task != GNUNET_SCHEDULER_NO_TASK)
2238   {
2239     GNUNET_SCHEDULER_cancel (dc->task);
2240     dc->task = GNUNET_SCHEDULER_NO_TASK;
2241   }
2242   if (dc->search != NULL)
2243   {
2244     dc->search->download = NULL;
2245     dc->search = NULL;
2246   }
2247   if (dc->job_queue != NULL)
2248   {
2249     GNUNET_FS_dequeue_ (dc->job_queue);
2250     dc->job_queue = NULL;
2251   }
2252   if (dc->te != NULL)
2253   {
2254     GNUNET_FS_tree_encoder_finish (dc->te, NULL, NULL);
2255     dc->te = NULL;
2256   }
2257   have_children = (NULL != dc->child_head) ? GNUNET_YES : GNUNET_NO;
2258   while (NULL != dc->child_head)
2259     GNUNET_FS_download_stop (dc->child_head, do_delete);
2260   if (dc->parent != NULL)
2261     GNUNET_CONTAINER_DLL_remove (dc->parent->child_head, dc->parent->child_tail,
2262                                  dc);
2263   if (dc->serialization != NULL)
2264     GNUNET_FS_remove_sync_file_ (dc->h,
2265                                  ((dc->parent != NULL) ||
2266                                   (dc->search !=
2267                                    NULL)) ? GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
2268                                  GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
2269                                  dc->serialization);
2270   if ((GNUNET_YES == have_children) && (dc->parent == NULL))
2271     GNUNET_FS_remove_sync_dir_ (dc->h,
2272                                 (dc->search !=
2273                                  NULL) ? GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
2274                                 GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
2275                                 dc->serialization);
2276   pi.status = GNUNET_FS_STATUS_DOWNLOAD_STOPPED;
2277   GNUNET_FS_download_make_status_ (&pi, dc);
2278   GNUNET_FS_free_download_request_ (dc->top_request);
2279   dc->top_request = NULL;
2280   if (dc->active != NULL)
2281   {
2282     GNUNET_CONTAINER_multihashmap_destroy (dc->active);
2283     dc->active = NULL;
2284   }
2285   if (dc->filename != NULL)
2286   {
2287     if ((dc->completed != dc->length) && (GNUNET_YES == do_delete))
2288     {
2289       if (0 != UNLINK (dc->filename))
2290         GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink",
2291                                   dc->filename);
2292     }
2293     GNUNET_free (dc->filename);
2294   }
2295   GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2296   GNUNET_FS_uri_destroy (dc->uri);
2297   if (NULL != dc->temp_filename)
2298   {
2299     if (0 != UNLINK (dc->temp_filename))
2300       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "unlink",
2301                                 dc->temp_filename);
2302     GNUNET_free (dc->temp_filename);
2303   }
2304   GNUNET_free_non_null (dc->serialization);
2305   GNUNET_free (dc);
2306 }
2307
2308 /* end of fs_download.c */