src/fs/fs_download.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009, 2010 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  * @file fs/fs_download.c
  22  * @brief download methods
  23  * @author Christian Grothoff
  24  *
  25  * TODO:
  26  * - handle recursive downloads (need directory &
  27  *   fs-level download-parallelism management)
  28  * - handle recursive downloads where directory file is
  29  *   NOT saved on disk (need temporary file instead then!)
  30  * - location URI suppport (can wait, easy)
  31  * - check if blocks exist already (can wait, easy)
  32  * - check if iblocks can be computed from existing blocks (can wait, hard)
  33  * - persistence (can wait)
  34  */
  35 #include "platform.h"
  36 #include "gnunet_constants.h"
  37 #include "gnunet_fs_service.h"
  38 #include "fs.h"
  39 #include "fs_tree.h"
  40
  41 #define DEBUG_DOWNLOAD GNUNET_NO
  42
  43 /**
  44  * We're storing the IBLOCKS after the DBLOCKS on disk (so that we
  45  * only have to truncate the file once we're done).
  46  *
  47  * Given the offset of a block (with respect to the DBLOCKS) and its
  48  * depth, return the offset where we would store this block in the
  49  * file.
  50  *
  51  * @param fsize overall file size
  52  * @param off offset of the block in the file
  53  * @param depth depth of the block in the tree
  54  * @param treedepth maximum depth of the tree
  55  * @return off for DBLOCKS (depth == treedepth),
  56  *         otherwise an offset past the end
  57  *         of the file that does not overlap
  58  *         with the range for any other block
  59  */
  60 static uint64_t
  61 compute_disk_offset (uint64_t fsize,
  62                      uint64_t off,
  63                      unsigned int depth,
  64                      unsigned int treedepth)
  65 {
  66   unsigned int i;
  67   uint64_t lsize; /* what is the size of all IBlocks for depth "i"? */
  68   uint64_t loff; /* where do IBlocks for depth "i" start? */
  69   unsigned int ioff; /* which IBlock corresponds to "off" at depth "i"? */
  70
  71   if (depth == treedepth)
  72     return off;
  73   /* first IBlocks start at the end of file, rounded up
  74      to full DBLOCK_SIZE */
  75   loff = ((fsize + DBLOCK_SIZE - 1) / DBLOCK_SIZE) * DBLOCK_SIZE;
  76   lsize = ( (fsize + DBLOCK_SIZE-1) / DBLOCK_SIZE) * sizeof (struct ContentHashKey);
  77   GNUNET_assert (0 == (off % DBLOCK_SIZE));
  78   ioff = (off / DBLOCK_SIZE);
  79   for (i=treedepth-1;i>depth;i--)
  80     {
  81       loff += lsize;
  82       lsize = (lsize + CHK_PER_INODE - 1) / CHK_PER_INODE;
  83       GNUNET_assert (lsize > 0);
  84       GNUNET_assert (0 == (ioff % CHK_PER_INODE));
  85       ioff /= CHK_PER_INODE;
  86     }
  87   return loff + ioff * sizeof (struct ContentHashKey);
  88 }
  89
  90
  91 /**
  92  * Given a file of the specified treedepth and a block at the given
  93  * offset and depth, calculate the offset for the CHK at the given
  94  * index.
  95  *
  96  * @param offset the offset of the first
  97  *        DBLOCK in the subtree of the
  98  *        identified IBLOCK
  99  * @param depth the depth of the IBLOCK in the tree
 100  * @param treedepth overall depth of the tree
 101  * @param k which CHK in the IBLOCK are we
 102  *        talking about
 103  * @return offset if k=0, otherwise an appropriately
 104  *         larger value (i.e., if depth = treedepth-1,
 105  *         the returned value should be offset+DBLOCK_SIZE)
 106  */
 107 static uint64_t
 108 compute_dblock_offset (uint64_t offset,
 109                        unsigned int depth,
 110                        unsigned int treedepth,
 111                        unsigned int k)
 112 {
 113   unsigned int i;
 114   uint64_t lsize; /* what is the size of the sum of all DBlocks
 115                      that a CHK at depth i corresponds to? */
 116
 117   if (depth == treedepth)
 118     return offset;
 119   lsize = DBLOCK_SIZE;
 120   for (i=treedepth-1;i>depth;i--)
 121     lsize *= CHK_PER_INODE;
 122   return offset + k * lsize;
 123 }
 124
 125
 126 /**
 127  * Fill in all of the generic fields for
 128  * a download event.
 129  *
 130  * @param pi structure to fill in
 131  * @param dc overall download context
 132  */
 133 static void
 134 make_download_status (struct GNUNET_FS_ProgressInfo *pi,
 135                       struct GNUNET_FS_DownloadContext *dc)
 136 {
 137   pi->value.download.dc = dc;
 138   pi->value.download.cctx
 139     = dc->client_info;
 140   pi->value.download.pctx
 141     = (dc->parent == NULL) ? NULL : dc->parent->client_info;
 142   pi->value.download.uri
 143     = dc->uri;
 144   pi->value.download.filename
 145     = dc->filename;
 146   pi->value.download.size
 147     = dc->length;
 148   pi->value.download.duration
 149     = GNUNET_TIME_absolute_get_duration (dc->start_time);
 150   pi->value.download.completed
 151     = dc->completed;
 152   pi->value.download.anonymity
 153     = dc->anonymity;
 154   pi->value.download.eta
 155     = GNUNET_TIME_calculate_eta (dc->start_time,
 156                                  dc->completed,
 157                                  dc->length);
 158 }
 159
 160 /**
 161  * We're ready to transmit a search request to the
 162  * file-sharing service.  Do it.  If there is
 163  * more than one request pending, try to send
 164  * multiple or request another transmission.
 165  *
 166  * @param cls closure
 167  * @param size number of bytes available in buf
 168  * @param buf where the callee should write the message
 169  * @return number of bytes written to buf
 170  */
 171 static size_t
 172 transmit_download_request (void *cls,
 173                            size_t size,
 174                            void *buf);
 175
 176
 177 /**
 178  * Schedule the download of the specified
 179  * block in the tree.
 180  *
 181  * @param dc overall download this block belongs to
 182  * @param chk content-hash-key of the block
 183  * @param offset offset of the block in the file
 184  *         (for IBlocks, the offset is the lowest
 185  *          offset of any DBlock in the subtree under
 186  *          the IBlock)
 187  * @param depth depth of the block, 0 is the root of the tree
 188  */
 189 static void
 190 schedule_block_download (struct GNUNET_FS_DownloadContext *dc,
 191                          const struct ContentHashKey *chk,
 192                          uint64_t offset,
 193                          unsigned int depth)
 194 {
 195   struct DownloadRequest *sm;
 196   uint64_t off;
 197
 198 #if DEBUG_DOWNLOAD
 199   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 200               "Scheduling download at offset %llu and depth %u for `%s'\n",
 201               (unsigned long long) offset,
 202               depth,
 203               GNUNET_h2s (&chk->query));
 204 #endif
 205   off = compute_disk_offset (GNUNET_ntohll (dc->uri->data.chk.file_length),
 206                              offset,
 207                              depth,
 208                              dc->treedepth);
 209   if ( (dc->old_file_size > off) &&
 210        (dc->handle != NULL) &&
 211        (off  ==
 212         GNUNET_DISK_file_seek (dc->handle,
 213                                off,
 214                                GNUNET_DISK_SEEK_SET) ) )
 215     {
 216       // FIXME: check if block exists on disk!
 217       // (read block, encode, compare with
 218       // query; if matches, simply return)
 219     }
 220   if (depth < dc->treedepth)
 221     {
 222       // FIXME: try if we could
 223       // reconstitute this IBLOCK
 224       // from the existing blocks on disk (can wait)
 225       // (read block(s), encode, compare with
 226       // query; if matches, simply return)
 227     }
 228   sm = GNUNET_malloc (sizeof (struct DownloadRequest));
 229   sm->chk = *chk;
 230   sm->offset = offset;
 231   sm->depth = depth;
 232   sm->is_pending = GNUNET_YES;
 233   sm->next = dc->pending;
 234   dc->pending = sm;
 235   GNUNET_CONTAINER_multihashmap_put (dc->active,
 236                                      &chk->query,
 237                                      sm,
 238                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 239
 240   if ( (dc->th == NULL) &&
 241        (dc->client != NULL) )
 242     dc->th = GNUNET_CLIENT_notify_transmit_ready (dc->client,
 243                                                   sizeof (struct SearchMessage),
 244                                                   GNUNET_CONSTANTS_SERVICE_TIMEOUT,
 245                                                   GNUNET_NO,
 246                                                   &transmit_download_request,
 247                                                   dc);
 248 }
 249
 250
 251
 252 /**
 253  * Suggest a filename based on given metadata.
 254  *
 255  * @param md given meta data
 256  * @return NULL if meta data is useless for suggesting a filename
 257  */
 258 char *
 259 GNUNET_FS_meta_data_suggest_filename (const struct GNUNET_CONTAINER_MetaData *md)
 260 {
 261   return NULL;
 262 }
 263
 264
 265 /**
 266  * We've lost our connection with the FS service.
 267  * Re-establish it and re-transmit all of our
 268  * pending requests.
 269  *
 270  * @param dc download context that is having trouble
 271  */
 272 static void
 273 try_reconnect (struct GNUNET_FS_DownloadContext *dc);
 274
 275
 276 /**
 277  * Compute how many bytes of data should be stored in
 278  * the specified node.
 279  *
 280  * @param fsize overall file size
 281  * @param totaldepth depth of the entire tree
 282  * @param offset offset of the node
 283  * @param depth depth of the node
 284  * @return number of bytes stored in this node
 285  */
 286 static size_t
 287 calculate_block_size (uint64_t fsize,
 288                       unsigned int totaldepth,
 289                       uint64_t offset,
 290                       unsigned int depth)
 291 {
 292   unsigned int i;
 293   size_t ret;
 294   uint64_t rsize;
 295   uint64_t epos;
 296   unsigned int chks;
 297
 298   GNUNET_assert (offset < fsize);
 299   if (depth == totaldepth)
 300     {
 301       ret = DBLOCK_SIZE;
 302       if (offset + ret > fsize)
 303         ret = (size_t) (fsize - offset);
 304       return ret;
 305     }
 306
 307   rsize = DBLOCK_SIZE;
 308   for (i = totaldepth-1; i > depth; i--)
 309     rsize *= CHK_PER_INODE;
 310   epos = offset + rsize * CHK_PER_INODE;
 311   GNUNET_assert (epos > offset);
 312   if (epos > fsize)
 313     epos = fsize;
 314   /* round up when computing #CHKs in our IBlock */
 315   chks = (epos - offset + rsize - 1) / rsize;
 316   GNUNET_assert (chks <= CHK_PER_INODE);
 317   return chks * sizeof (struct ContentHashKey);
 318 }
 319
 320
 321 /**
 322  * Closure for iterator processing results.
 323  */
 324 struct ProcessResultClosure
 325 {
 326
 327   /**
 328    * Hash of data.
 329    */
 330   GNUNET_HashCode query;
 331
 332   /**
 333    * Data found in P2P network.
 334    */
 335   const void *data;
 336
 337   /**
 338    * Our download context.
 339    */
 340   struct GNUNET_FS_DownloadContext *dc;
 341
 342   /**
 343    * Number of bytes in data.
 344    */
 345   size_t size;
 346
 347   /**
 348    * Type of data.
 349    */
 350   uint32_t type;
 351
 352 };
 353
 354
 355 /**
 356  * We found an entry in a directory.  Check if the respective child
 357  * already exists and if not create the respective child download.
 358  *
 359  * @param cls the parent download
 360  * @param filename name of the file in the directory
 361  * @param uri URI of the file (CHK or LOC)
 362  * @param meta meta data of the file
 363  * @param length number of bytes in data
 364  * @param data contents of the file (or NULL if they were not inlined)
 365  */
 366 static void
 367 trigger_recursive_download (void *cls,
 368                             const char *filename,
 369                             const struct GNUNET_FS_Uri *uri,
 370                             const struct GNUNET_CONTAINER_MetaData *meta,
 371                             size_t length,
 372                             const void *data)
 373 {
 374   struct GNUNET_FS_DownloadContext *dc = cls;
 375   struct GNUNET_FS_DownloadContext *cpos;
 376   char *fn;
 377   char *us;
 378   char *ext;
 379   char *dn;
 380   char *full_name;
 381
 382   if (NULL == uri)
 383     return; /* entry for the directory itself */
 384   cpos = dc->child_head;
 385   while (cpos != NULL)
 386     {
 387       if ( (GNUNET_FS_uri_test_equal (uri,
 388                                       cpos->uri)) ||
 389            ( (filename != NULL) &&
 390              (0 == strcmp (cpos->filename,
 391                            filename)) ) )
 392         break;
 393       cpos = cpos->next;
 394     }
 395   if (cpos != NULL)
 396     return; /* already exists */
 397   fn = NULL;
 398   if (NULL == filename)
 399     {
 400       fn = GNUNET_FS_meta_data_suggest_filename (meta);
 401       if (fn == NULL)
 402         {
 403           fn = GNUNET_FS_uri_to_string (uri);
 404
 405         }
 406       else if (fn[0] == '.')
 407         {
 408           ext = fn;
 409           us = GNUNET_FS_uri_to_string (uri);
 410           GNUNET_asprintf (&fn,
 411                            "%s%s",
 412                            us, ext);
 413           GNUNET_free (ext);
 414           GNUNET_free (us);
 415         }
 416       filename = fn;
 417     }
 418   if (dc->filename == NULL)
 419     {
 420       full_name = NULL;
 421     }
 422   else
 423     {
 424       dn = GNUNET_strdup (dc->filename);
 425       GNUNET_break ( (strlen (dn) < strlen (GNUNET_FS_DIRECTORY_EXT)) ||
 426                      (NULL ==
 427                       strstr (dn + strlen(dn) - strlen(GNUNET_FS_DIRECTORY_EXT),
 428                               GNUNET_FS_DIRECTORY_EXT)) );
 429       dn[strlen(dn) - strlen (GNUNET_FS_DIRECTORY_EXT)] = '\0';
 430       if ( (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta)) &&
 431            ( (strlen (filename) < strlen (GNUNET_FS_DIRECTORY_EXT)) ||
 432              (NULL ==
 433               strstr (filename + strlen(filename) - strlen(GNUNET_FS_DIRECTORY_EXT),
 434                       GNUNET_FS_DIRECTORY_EXT)) ) )
 435         {
 436           GNUNET_asprintf (&full_name,
 437                            "%s%s%s%s",
 438                            dn,
 439                            DIR_SEPARATOR_STR,
 440                            filename,
 441                            GNUNET_FS_DIRECTORY_EXT);
 442         }
 443       else
 444         {
 445           GNUNET_asprintf (&full_name,
 446                            "%s%s%s",
 447                            dn,
 448                            DIR_SEPARATOR_STR,
 449                            filename);
 450         }
 451       GNUNET_free (dn);
 452     }
 453   if (data != NULL)
 454     {
 455       if (full_name != NULL)
 456         {
 457           /* determine on-disk filename, write data! */
 458           GNUNET_break (0); // FIXME: not implemented
 459         }
 460       else
 461         {
 462           /* FIXME: generate 'progress' events and move to
 463              instant completion! */
 464           GNUNET_break (0); // FIXME: not implemented
 465         }
 466     }
 467   GNUNET_FS_download_start (dc->h,
 468                             uri,
 469                             meta,
 470                             full_name,
 471                             0,
 472                             GNUNET_FS_uri_chk_get_file_size (uri),
 473                             dc->anonymity,
 474                             dc->options,
 475                             NULL,
 476                             dc);
 477   GNUNET_free_non_null (full_name);
 478   GNUNET_free_non_null (fn);
 479 }
 480
 481
 482 /**
 483  * We're done downloading a directory.  Open the file and
 484  * trigger all of the (remaining) child downloads.
 485  *
 486  * @param dc context of download that just completed
 487  */
 488 static void
 489 full_recursive_download (struct GNUNET_FS_DownloadContext *dc)
 490 {
 491   size_t size;
 492   uint64_t size64;
 493   void *data;
 494   struct GNUNET_DISK_FileHandle *h;
 495   struct GNUNET_DISK_MapHandle *m;
 496
 497   size64 = GNUNET_FS_uri_chk_get_file_size (dc->uri);
 498   size = (size_t) size64;
 499   if (size64 != (uint64_t) size)
 500     {
 501       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 502                   _("Recursive downloads of directories larger than 4 GB are not supported on 32-bit systems\n"));
 503       return;
 504     }
 505   if (dc->filename != NULL)
 506     {
 507       h = GNUNET_DISK_file_open (dc->filename,
 508                                  GNUNET_DISK_OPEN_READ,
 509                                  GNUNET_DISK_PERM_NONE);
 510     }
 511   else
 512     {
 513       /* FIXME: need to initialize (and use) temp_filename
 514          in various places in order for this assertion to
 515          not fail; right now, it will always fail! */
 516       GNUNET_assert (dc->temp_filename != NULL);
 517       h = GNUNET_DISK_file_open (dc->temp_filename,
 518                                  GNUNET_DISK_OPEN_READ,
 519                                  GNUNET_DISK_PERM_NONE);
 520     }
 521   if (h == NULL)
 522     return; /* oops */
 523   data = GNUNET_DISK_file_map (h, &m, GNUNET_DISK_MAP_TYPE_READ, size);
 524   if (data == NULL)
 525     {
 526       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 527                   _("Directory too large for system address space\n"));
 528     }
 529   else
 530     {
 531       GNUNET_FS_directory_list_contents (size,
 532                                          data,
 533                                          0,
 534                                          &trigger_recursive_download,
 535                                          dc);
 536       GNUNET_DISK_file_unmap (m);
 537     }
 538   GNUNET_DISK_file_close (h);
 539   if (dc->filename == NULL)
 540     {
 541       if (0 != UNLINK (dc->temp_filename))
 542         GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 543                                   "unlink",
 544                                   dc->temp_filename);
 545       GNUNET_free (dc->temp_filename);
 546       dc->temp_filename = NULL;
 547     }
 548 }
 549
 550
 551 /**
 552  * Iterator over entries in the pending requests in the 'active' map for the
 553  * reply that we just got.
 554  *
 555  * @param cls closure (our 'struct ProcessResultClosure')
 556  * @param key query for the given value / request
 557  * @param value value in the hash map (a 'struct DownloadRequest')
 558  * @return GNUNET_YES (we should continue to iterate); unless serious error
 559  */
 560 static int
 561 process_result_with_request (void *cls,
 562                              const GNUNET_HashCode * key,
 563                              void *value)
 564 {
 565   struct ProcessResultClosure *prc = cls;
 566   struct DownloadRequest *sm = value;
 567   struct GNUNET_FS_DownloadContext *dc = prc->dc;
 568   struct GNUNET_CRYPTO_AesSessionKey skey;
 569   struct GNUNET_CRYPTO_AesInitializationVector iv;
 570   char pt[prc->size];
 571   struct GNUNET_FS_ProgressInfo pi;
 572   uint64_t off;
 573   size_t app;
 574   int i;
 575   struct ContentHashKey *chk;
 576   char *emsg;
 577
 578   if (prc->size != calculate_block_size (GNUNET_ntohll (dc->uri->data.chk.file_length),
 579                                          dc->treedepth,
 580                                          sm->offset,
 581                                          sm->depth))
 582     {
 583 #if DEBUG_DOWNLOAD
 584       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 585                   "Internal error or bogus download URI (expected %u bytes, got %u)\n",
 586                   calculate_block_size (GNUNET_ntohll (dc->uri->data.chk.file_length),
 587                                         dc->treedepth,
 588                                         sm->offset,
 589                                         sm->depth),
 590                   prc->size);
 591 #endif
 592       dc->emsg = GNUNET_strdup ("Internal error or bogus download URI");
 593       /* signal error */
 594       pi.status = GNUNET_FS_STATUS_DOWNLOAD_ERROR;
 595       make_download_status (&pi, dc);
 596       pi.value.download.specifics.error.message = dc->emsg;
 597       dc->client_info = dc->h->upcb (dc->h->upcb_cls,
 598                                      &pi);
 599       /* abort all pending requests */
 600       if (NULL != dc->th)
 601         {
 602           GNUNET_CLIENT_notify_transmit_ready_cancel (dc->th);
 603           dc->th = NULL;
 604         }
 605       GNUNET_CLIENT_disconnect (dc->client, GNUNET_NO);
 606       dc->client = NULL;
 607       return GNUNET_NO;
 608     }
 609   GNUNET_assert (GNUNET_YES ==
 610                  GNUNET_CONTAINER_multihashmap_remove (dc->active,
 611                                                        &prc->query,
 612                                                        sm));
 613   GNUNET_CRYPTO_hash_to_aes_key (&sm->chk.key, &skey, &iv);
 614   GNUNET_CRYPTO_aes_decrypt (prc->data,
 615                              prc->size,
 616                              &skey,
 617                              &iv,
 618                              pt);
 619   off = compute_disk_offset (GNUNET_ntohll (dc->uri->data.chk.file_length),
 620                              sm->offset,
 621                              sm->depth,
 622                              dc->treedepth);
 623   /* save to disk */
 624   if ( (NULL != dc->handle) &&
 625        ( (sm->depth == dc->treedepth) ||
 626          (0 == (dc->options & GNUNET_FS_DOWNLOAD_NO_TEMPORARIES)) ) )
 627     {
 628       emsg = NULL;
 629 #if DEBUG_DOWNLOAD
 630       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 631                   "Saving decrypted block to disk at offset %llu\n",
 632                   (unsigned long long) off);
 633 #endif
 634       if ( (off  !=
 635             GNUNET_DISK_file_seek (dc->handle,
 636                                    off,
 637                                    GNUNET_DISK_SEEK_SET) ) )
 638         GNUNET_asprintf (&emsg,
 639                          _("Failed to seek to offset %llu in file `%s': %s\n"),
 640                          (unsigned long long) off,
 641                          dc->filename,
 642                          STRERROR (errno));
 643       else if (prc->size !=
 644                GNUNET_DISK_file_write (dc->handle,
 645                                        pt,
 646                                        prc->size))
 647         GNUNET_asprintf (&emsg,
 648                          _("Failed to write block of %u bytes at offset %llu in file `%s': %s\n"),
 649                          (unsigned int) prc->size,
 650                          (unsigned long long) off,
 651                          dc->filename,
 652                          STRERROR (errno));
 653       if (NULL != emsg)
 654         {
 655           dc->emsg = emsg;
 656           // FIXME: make persistent
 657
 658           /* signal error */
 659           pi.status = GNUNET_FS_STATUS_DOWNLOAD_ERROR;
 660           make_download_status (&pi, dc);
 661           pi.value.download.specifics.error.message = emsg;
 662           dc->client_info = dc->h->upcb (dc->h->upcb_cls,
 663                                          &pi);
 664
 665           /* abort all pending requests */
 666           if (NULL != dc->th)
 667             {
 668               GNUNET_CLIENT_notify_transmit_ready_cancel (dc->th);
 669               dc->th = NULL;
 670             }
 671           GNUNET_CLIENT_disconnect (dc->client, GNUNET_NO);
 672           dc->client = NULL;
 673           GNUNET_free (sm);
 674           return GNUNET_NO;
 675         }
 676     }
 677   if (sm->depth == dc->treedepth)
 678     {
 679       app = prc->size;
 680       if (sm->offset < dc->offset)
 681         {
 682           /* starting offset begins in the middle of pt,
 683              do not count first bytes as progress */
 684           GNUNET_assert (app > (dc->offset - sm->offset));
 685           app -= (dc->offset - sm->offset);
 686         }
 687       if (sm->offset + prc->size > dc->offset + dc->length)
 688         {
 689           /* end of block is after relevant range,
 690              do not count last bytes as progress */
 691           GNUNET_assert (app > (sm->offset + prc->size) - (dc->offset + dc->length));
 692           app -= (sm->offset + prc->size) - (dc->offset + dc->length);
 693         }
 694       dc->completed += app;
 695
 696       /* do recursive download if option is set and either meta data
 697          says it is a directory or if no meta data is given AND filename
 698          ends in '.gnd' (top-level case) */
 699       if ( (0 != (dc->options & GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE)) &&
 700            ( (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (dc->meta)) ||
 701              ( (dc->meta == NULL) &&
 702                ( (NULL == dc->filename) ||
 703                  ( (strlen (dc->filename) >= strlen (GNUNET_FS_DIRECTORY_EXT)) &&
 704                    (NULL !=
 705                     strstr (dc->filename + strlen(dc->filename) - strlen(GNUNET_FS_DIRECTORY_EXT),
 706                             GNUNET_FS_DIRECTORY_EXT)) ) ) ) ) )
 707         {
 708           GNUNET_FS_directory_list_contents (prc->size,
 709                                              pt,
 710                                              off,
 711                                              &trigger_recursive_download,
 712                                              dc);
 713         }
 714
 715     }
 716
 717   pi.status = GNUNET_FS_STATUS_DOWNLOAD_PROGRESS;
 718   make_download_status (&pi, dc);
 719   pi.value.download.specifics.progress.data = pt;
 720   pi.value.download.specifics.progress.offset = sm->offset;
 721   pi.value.download.specifics.progress.data_len = prc->size;
 722   pi.value.download.specifics.progress.depth = sm->depth;
 723   dc->client_info = dc->h->upcb (dc->h->upcb_cls,
 724                                  &pi);
 725   GNUNET_assert (dc->completed <= dc->length);
 726   if (dc->completed == dc->length)
 727     {
 728 #if DEBUG_DOWNLOAD
 729       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 730                   "Download completed, truncating file to desired length %llu\n",
 731                   (unsigned long long) GNUNET_ntohll (dc->uri->data.chk.file_length));
 732 #endif
 733       /* truncate file to size (since we store IBlocks at the end) */
 734       if (dc->handle != NULL)
 735         {
 736           GNUNET_DISK_file_close (dc->handle);
 737           dc->handle = NULL;
 738           if (0 != truncate (dc->filename,
 739                              GNUNET_ntohll (dc->uri->data.chk.file_length)))
 740             GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 741                                       "truncate",
 742                                       dc->filename);
 743         }
 744
 745       if ( (0 != (dc->options & GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE)) &&
 746            (GNUNET_NO != GNUNET_FS_meta_data_test_for_directory (dc->meta)) )
 747         full_recursive_download (dc);
 748       if (dc->child_head == NULL)
 749         {
 750           /* signal completion */
 751           pi.status = GNUNET_FS_STATUS_DOWNLOAD_COMPLETED;
 752           make_download_status (&pi, dc);
 753           dc->client_info = dc->h->upcb (dc->h->upcb_cls,
 754                                          &pi);
 755         }
 756       GNUNET_assert (sm->depth == dc->treedepth);
 757     }
 758   // FIXME: make persistent
 759   if (sm->depth == dc->treedepth)
 760     {
 761       GNUNET_free (sm);
 762       return GNUNET_YES;
 763     }
 764 #if DEBUG_DOWNLOAD
 765   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 766               "Triggering downloads of children (this block was at depth %u and offset %llu)\n",
 767               sm->depth,
 768               (unsigned long long) sm->offset);
 769 #endif
 770   GNUNET_assert (0 == (prc->size % sizeof(struct ContentHashKey)));
 771   chk = (struct ContentHashKey*) pt;
 772   for (i=(prc->size / sizeof(struct ContentHashKey))-1;i>=0;i--)
 773     {
 774       off = compute_dblock_offset (sm->offset,
 775                                    sm->depth,
 776                                    dc->treedepth,
 777                                    i);
 778       if ( (off + DBLOCK_SIZE >= dc->offset) &&
 779            (off < dc->offset + dc->length) )
 780         schedule_block_download (dc,
 781                                  &chk[i],
 782                                  off,
 783                                  sm->depth + 1);
 784     }
 785   GNUNET_free (sm);
 786   return GNUNET_YES;
 787 }
 788
 789
 790 /**
 791  * Process a download result.
 792  *
 793  * @param dc our download context
 794  * @param type type of the result
 795  * @param data the (encrypted) response
 796  * @param size size of data
 797  */
 798 static void
 799 process_result (struct GNUNET_FS_DownloadContext *dc,
 800                 uint32_t type,
 801                 const void *data,
 802                 size_t size)
 803 {
 804   struct ProcessResultClosure prc;
 805
 806   prc.dc = dc;
 807   prc.data = data;
 808   prc.size = size;
 809   prc.type = type;
 810   GNUNET_CRYPTO_hash (data, size, &prc.query);
 811 #if DEBUG_DOWNLOAD
 812   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 813               "Received result for query `%s' from `%s'-service\n",
 814               GNUNET_h2s (&prc.query),
 815               "FS");
 816 #endif
 817   GNUNET_CONTAINER_multihashmap_get_multiple (dc->active,
 818                                               &prc.query,
 819                                               &process_result_with_request,
 820                                               &prc);
 821 }
 822
 823
 824 /**
 825  * Type of a function to call when we receive a message
 826  * from the service.
 827  *
 828  * @param cls closure
 829  * @param msg message received, NULL on timeout or fatal error
 830  */
 831 static void
 832 receive_results (void *cls,
 833                  const struct GNUNET_MessageHeader * msg)
 834 {
 835   struct GNUNET_FS_DownloadContext *dc = cls;
 836   const struct PutMessage *cm;
 837   uint16_t msize;
 838
 839   if ( (NULL == msg) ||
 840        (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_FS_PUT) ||
 841        (sizeof (struct PutMessage) > ntohs(msg->size)) )
 842     {
 843       GNUNET_break (msg == NULL);
 844       try_reconnect (dc);
 845       return;
 846     }
 847   msize = ntohs(msg->size);
 848   cm = (const struct PutMessage*) msg;
 849   process_result (dc,
 850                   ntohl (cm->type),
 851                   &cm[1],
 852                   msize - sizeof (struct PutMessage));
 853   if (dc->client == NULL)
 854     return; /* fatal error */
 855   /* continue receiving */
 856   GNUNET_CLIENT_receive (dc->client,
 857                          &receive_results,
 858                          dc,
 859                          GNUNET_TIME_UNIT_FOREVER_REL);
 860 }
 861
 862
 863
 864 /**
 865  * We're ready to transmit a search request to the
 866  * file-sharing service.  Do it.  If there is
 867  * more than one request pending, try to send
 868  * multiple or request another transmission.
 869  *
 870  * @param cls closure
 871  * @param size number of bytes available in buf
 872  * @param buf where the callee should write the message
 873  * @return number of bytes written to buf
 874  */
 875 static size_t
 876 transmit_download_request (void *cls,
 877                            size_t size,
 878                            void *buf)
 879 {
 880   struct GNUNET_FS_DownloadContext *dc = cls;
 881   size_t msize;
 882   struct SearchMessage *sm;
 883
 884   dc->th = NULL;
 885   if (NULL == buf)
 886     {
 887       try_reconnect (dc);
 888       return 0;
 889     }
 890   GNUNET_assert (size >= sizeof (struct SearchMessage));
 891   msize = 0;
 892   sm = buf;
 893   while ( (dc->pending != NULL) &&
 894           (size > msize + sizeof (struct SearchMessage)) )
 895     {
 896 #if DEBUG_DOWNLOAD
 897       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 898                   "Transmitting download request for `%s' to `%s'-service\n",
 899                   GNUNET_h2s (&dc->pending->chk.query),
 900                   "FS");
 901 #endif
 902       memset (sm, 0, sizeof (struct SearchMessage));
 903       sm->header.size = htons (sizeof (struct SearchMessage));
 904       sm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_START_SEARCH);
 905       if (dc->pending->depth == dc->treedepth)
 906         sm->type = htonl (GNUNET_DATASTORE_BLOCKTYPE_DBLOCK);
 907       else
 908         sm->type = htonl (GNUNET_DATASTORE_BLOCKTYPE_IBLOCK);
 909       sm->anonymity_level = htonl (dc->anonymity);
 910       sm->target = dc->target.hashPubKey;
 911       sm->query = dc->pending->chk.query;
 912       dc->pending->is_pending = GNUNET_NO;
 913       dc->pending = dc->pending->next;
 914       msize += sizeof (struct SearchMessage);
 915       sm++;
 916     }
 917   if (dc->pending != NULL)
 918     dc->th = GNUNET_CLIENT_notify_transmit_ready (dc->client,
 919                                                   sizeof (struct SearchMessage),
 920                                                   GNUNET_CONSTANTS_SERVICE_TIMEOUT,
 921                                                   GNUNET_NO,
 922                                                   &transmit_download_request,
 923                                                   dc);
 924   return msize;
 925 }
 926
 927
 928 /**
 929  * Reconnect to the FS service and transmit our queries NOW.
 930  *
 931  * @param cls our download context
 932  * @param tc unused
 933  */
 934 static void
 935 do_reconnect (void *cls,
 936               const struct GNUNET_SCHEDULER_TaskContext *tc)
 937 {
 938   struct GNUNET_FS_DownloadContext *dc = cls;
 939   struct GNUNET_CLIENT_Connection *client;
 940
 941   dc->task = GNUNET_SCHEDULER_NO_TASK;
 942   client = GNUNET_CLIENT_connect (dc->h->sched,
 943                                   "fs",
 944                                   dc->h->cfg);
 945   if (NULL == client)
 946     {
 947       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 948                   "Connecting to `%s'-service failed, will try again.\n",
 949                   "FS");
 950       try_reconnect (dc);
 951       return;
 952     }
 953   dc->client = client;
 954   dc->th = GNUNET_CLIENT_notify_transmit_ready (client,
 955                                                 sizeof (struct SearchMessage),
 956                                                 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
 957                                                 GNUNET_NO,
 958                                                 &transmit_download_request,
 959                                                 dc);
 960   GNUNET_CLIENT_receive (client,
 961                          &receive_results,
 962                          dc,
 963                          GNUNET_TIME_UNIT_FOREVER_REL);
 964 }
 965
 966
 967 /**
 968  * Add entries that are not yet pending back to the pending list.
 969  *
 970  * @param cls our download context
 971  * @param key unused
 972  * @param entry entry of type "struct DownloadRequest"
 973  * @return GNUNET_OK
 974  */
 975 static int
 976 retry_entry (void *cls,
 977              const GNUNET_HashCode *key,
 978              void *entry)
 979 {
 980   struct GNUNET_FS_DownloadContext *dc = cls;
 981   struct DownloadRequest *dr = entry;
 982
 983   if (! dr->is_pending)
 984     {
 985       dr->next = dc->pending;
 986       dr->is_pending = GNUNET_YES;
 987       dc->pending = entry;
 988     }
 989   return GNUNET_OK;
 990 }
 991
 992
 993 /**
 994  * We've lost our connection with the FS service.
 995  * Re-establish it and re-transmit all of our
 996  * pending requests.
 997  *
 998  * @param dc download context that is having trouble
 999  */
1000 static void
1001 try_reconnect (struct GNUNET_FS_DownloadContext *dc)
1002 {
1003
1004   if (NULL != dc->client)
1005     {
1006       if (NULL != dc->th)
1007         {
1008           GNUNET_CLIENT_notify_transmit_ready_cancel (dc->th);
1009           dc->th = NULL;
1010         }
1011       GNUNET_CONTAINER_multihashmap_iterate (dc->active,
1012                                              &retry_entry,
1013                                              dc);
1014       GNUNET_CLIENT_disconnect (dc->client, GNUNET_NO);
1015       dc->client = NULL;
1016     }
1017   dc->task
1018     = GNUNET_SCHEDULER_add_delayed (dc->h->sched,
1019                                     GNUNET_TIME_UNIT_SECONDS,
1020                                     &do_reconnect,
1021                                     dc);
1022 }
1023
1024
1025 /**
1026  * Download parts of a file.  Note that this will store
1027  * the blocks at the respective offset in the given file.  Also, the
1028  * download is still using the blocking of the underlying FS
1029  * encoding.  As a result, the download may *write* outside of the
1030  * given boundaries (if offset and length do not match the 32k FS
1031  * block boundaries). <p>
1032  *
1033  * This function should be used to focus a download towards a
1034  * particular portion of the file (optimization), not to strictly
1035  * limit the download to exactly those bytes.
1036  *
1037  * @param h handle to the file sharing subsystem
1038  * @param uri the URI of the file (determines what to download); CHK or LOC URI
1039  * @param meta known metadata for the file (can be NULL)
1040  * @param filename where to store the file, maybe NULL (then no file is
1041  *        created on disk and data must be grabbed from the callbacks)
1042  * @param offset at what offset should we start the download (typically 0)
1043  * @param length how many bytes should be downloaded starting at offset
1044  * @param anonymity anonymity level to use for the download
1045  * @param options various options
1046  * @param cctx initial value for the client context for this download
1047  * @param parent parent download to associate this download with (use NULL
1048  *        for top-level downloads; useful for manually-triggered recursive downloads)
1049  * @return context that can be used to control this download
1050  */
1051 struct GNUNET_FS_DownloadContext *
1052 GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
1053                           const struct GNUNET_FS_Uri *uri,
1054                           const struct GNUNET_CONTAINER_MetaData *meta,
1055                           const char *filename,
1056                           uint64_t offset,
1057                           uint64_t length,
1058                           uint32_t anonymity,
1059                           enum GNUNET_FS_DownloadOptions options,
1060                           void *cctx,
1061                           struct GNUNET_FS_DownloadContext *parent)
1062 {
1063   struct GNUNET_FS_ProgressInfo pi;
1064   struct GNUNET_FS_DownloadContext *dc;
1065   struct GNUNET_CLIENT_Connection *client;
1066
1067   GNUNET_assert (GNUNET_FS_uri_test_chk (uri));
1068   if ( (offset + length < offset) ||
1069        (offset + length > uri->data.chk.file_length) )
1070     {
1071       GNUNET_break (0);
1072       return NULL;
1073     }
1074   // FIXME: add support for "loc" URIs!
1075 #if DEBUG_DOWNLOAD
1076   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1077               "Starting download `%s' of %llu bytes\n",
1078               filename,
1079               (unsigned long long) length);
1080 #endif
1081   dc = GNUNET_malloc (sizeof(struct GNUNET_FS_DownloadContext));
1082   dc->h = h;
1083   dc->parent = parent;
1084   if (parent != NULL)
1085     {
1086       GNUNET_CONTAINER_DLL_insert (parent->child_head,
1087                                    parent->child_tail,
1088                                    dc);
1089     }
1090   dc->uri = GNUNET_FS_uri_dup (uri);
1091   dc->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
1092   dc->client_info = cctx;
1093   dc->start_time = GNUNET_TIME_absolute_get ();
1094   if (NULL != filename)
1095     {
1096       dc->filename = GNUNET_strdup (filename);
1097       if (GNUNET_YES == GNUNET_DISK_file_test (filename))
1098         GNUNET_DISK_file_size (filename,
1099                                &dc->old_file_size,
1100                                GNUNET_YES);
1101       dc->handle = GNUNET_DISK_file_open (filename,
1102                                           GNUNET_DISK_OPEN_READWRITE |
1103                                           GNUNET_DISK_OPEN_CREATE,
1104                                           GNUNET_DISK_PERM_USER_READ |
1105                                           GNUNET_DISK_PERM_USER_WRITE |
1106                                           GNUNET_DISK_PERM_GROUP_READ |
1107                                           GNUNET_DISK_PERM_OTHER_READ);
1108       if (dc->handle == NULL)
1109         {
1110           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1111                       _("Download failed: could not open file `%s': %s\n"),
1112                       dc->filename,
1113                       STRERROR (errno));
1114           GNUNET_CONTAINER_meta_data_destroy (dc->meta);
1115           GNUNET_FS_uri_destroy (dc->uri);
1116           GNUNET_free (dc->filename);
1117           GNUNET_CLIENT_disconnect (dc->client, GNUNET_NO);
1118           GNUNET_free (dc);
1119           return NULL;
1120         }
1121     }
1122   // FIXME: set "dc->target" for LOC uris!
1123   dc->offset = offset;
1124   dc->length = length;
1125   dc->anonymity = anonymity;
1126   dc->options = options;
1127   dc->active = GNUNET_CONTAINER_multihashmap_create (2 * (length / DBLOCK_SIZE));
1128   dc->treedepth = GNUNET_FS_compute_depth (GNUNET_ntohll(dc->uri->data.chk.file_length));
1129 #if DEBUG_DOWNLOAD
1130   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1131               "Download tree has depth %u\n",
1132               dc->treedepth);
1133 #endif
1134   // FIXME: make persistent
1135
1136   // FIXME: bound parallelism here!
1137   client = GNUNET_CLIENT_connect (h->sched,
1138                                   "fs",
1139                                   h->cfg);
1140   dc->client = client;
1141   schedule_block_download (dc,
1142                            &dc->uri->data.chk.chk,
1143                            0,
1144                            1 /* 0 == CHK, 1 == top */);
1145   GNUNET_CLIENT_receive (client,
1146                          &receive_results,
1147                          dc,
1148                          GNUNET_TIME_UNIT_FOREVER_REL);
1149   pi.status = GNUNET_FS_STATUS_DOWNLOAD_START;
1150   make_download_status (&pi, dc);
1151   pi.value.download.specifics.start.meta = meta;
1152   dc->client_info = dc->h->upcb (dc->h->upcb_cls,
1153                                  &pi);
1154
1155   return dc;
1156 }
1157
1158
1159 /**
1160  * Free entries in the map.
1161  *
1162  * @param cls unused (NULL)
1163  * @param key unused
1164  * @param entry entry of type "struct DownloadRequest" which is freed
1165  * @return GNUNET_OK
1166  */
1167 static int
1168 free_entry (void *cls,
1169             const GNUNET_HashCode *key,
1170             void *entry)
1171 {
1172   GNUNET_free (entry);
1173   return GNUNET_OK;
1174 }
1175
1176
1177 /**
1178  * Stop a download (aborts if download is incomplete).
1179  *
1180  * @param dc handle for the download
1181  * @param do_delete delete files of incomplete downloads
1182  */
1183 void
1184 GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc,
1185                          int do_delete)
1186 {
1187   struct GNUNET_FS_ProgressInfo pi;
1188
1189   while (NULL != dc->child_head)
1190     GNUNET_FS_download_stop (dc->child_head,
1191                              do_delete);
1192   // FIXME: make unpersistent
1193   if (dc->parent != NULL)
1194     GNUNET_CONTAINER_DLL_remove (dc->parent->child_head,
1195                                  dc->parent->child_tail,
1196                                  dc);
1197
1198   pi.status = GNUNET_FS_STATUS_DOWNLOAD_STOPPED;
1199   make_download_status (&pi, dc);
1200   dc->client_info = dc->h->upcb (dc->h->upcb_cls,
1201                                  &pi);
1202
1203   if (GNUNET_SCHEDULER_NO_TASK != dc->task)
1204     GNUNET_SCHEDULER_cancel (dc->h->sched,
1205                              dc->task);
1206   if (NULL != dc->th)
1207     {
1208       GNUNET_CLIENT_notify_transmit_ready_cancel (dc->th);
1209       dc->th = NULL;
1210     }
1211   if (NULL != dc->client)
1212     GNUNET_CLIENT_disconnect (dc->client, GNUNET_NO);
1213   GNUNET_CONTAINER_multihashmap_iterate (dc->active,
1214                                          &free_entry,
1215                                          NULL);
1216   GNUNET_CONTAINER_multihashmap_destroy (dc->active);
1217   if (dc->filename != NULL)
1218     {
1219       if (NULL != dc->handle)
1220         GNUNET_DISK_file_close (dc->handle);
1221       if ( (dc->completed != dc->length) &&
1222            (GNUNET_YES == do_delete) )
1223         {
1224           if (0 != UNLINK (dc->filename))
1225             GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
1226                                       "unlink",
1227                                       dc->filename);
1228         }
1229       GNUNET_free (dc->filename);
1230     }
1231   GNUNET_CONTAINER_meta_data_destroy (dc->meta);
1232   GNUNET_FS_uri_destroy (dc->uri);
1233   GNUNET_free (dc);
1234 }
1235
1236 /* end of fs_download.c */