src/fs/fs_download.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @file fs/fs_download.c
  22  * @brief download methods
  23  * @author Christian Grothoff
  24  *
  25  * TODO:
  26  * - location URI suppport (can wait, easy)
  27  * - check if blocks exist already (can wait, easy)
  28  * - handle recursive downloads (need directory &
  29  *   fs-level download-parallelism management, can wait)
  30  * - check if iblocks can be computed from existing blocks (can wait, hard)
  31  * - persistence (can wait)
  32  */
  33 #include "platform.h"
  34 #include "gnunet_constants.h"
  35 #include "gnunet_fs_service.h"
  36 #include "fs.h"
  37 #include "fs_tree.h"
  38
  39 #define DEBUG_DOWNLOAD GNUNET_YES
  40
  41 /**
  42  * We're storing the IBLOCKS after the
  43  * DBLOCKS on disk (so that we only have
  44  * to truncate the file once we're done).
  45  *
  46  * Given the offset of a block (with respect
  47  * to the DBLOCKS) and its depth, return the
  48  * offset where we would store this block
  49  * in the file.
  50
  51  *
  52  * @param fsize overall file size
  53  * @param off offset of the block in the file
  54  * @param depth depth of the block in the tree
  55  * @param treedepth maximum depth of the tree
  56  * @return off for DBLOCKS (depth == treedepth),
  57  *         otherwise an offset past the end
  58  *         of the file that does not overlap
  59  *         with the range for any other block
  60  */
  61 static uint64_t
  62 compute_disk_offset (uint64_t fsize,
  63                      uint64_t off,
  64                      unsigned int depth,
  65                      unsigned int treedepth)
  66 {
  67   unsigned int i;
  68   uint64_t lsize; /* what is the size of all IBlocks for level "i"? */
  69   uint64_t loff; /* where do IBlocks for level "i" start? */
  70   unsigned int ioff; /* which IBlock corresponds to "off" at level "i"? */
  71
  72   if (depth == treedepth)
  73     return off;
  74   /* first IBlocks start at the end of file, rounded up
  75      to full DBLOCK_SIZE */
  76   loff = ((fsize + DBLOCK_SIZE - 1) / DBLOCK_SIZE) * DBLOCK_SIZE;
  77   lsize = ( (fsize + DBLOCK_SIZE-1) / DBLOCK_SIZE) * sizeof (struct ContentHashKey);
  78   GNUNET_assert (0 == (off % DBLOCK_SIZE));
  79   ioff = (off / DBLOCK_SIZE);
  80   for (i=treedepth-1;i>depth;i--)
  81     {
  82       loff += lsize;
  83       lsize = (lsize + CHK_PER_INODE - 1) / CHK_PER_INODE;
  84       GNUNET_assert (lsize > 0);
  85       GNUNET_assert (0 == (ioff % CHK_PER_INODE));
  86       ioff /= CHK_PER_INODE;
  87     }
  88   return loff + ioff * sizeof (struct ContentHashKey);
  89 }
  90
  91
  92 /**
  93  * Given a file of the specified treedepth and a block at the given
  94  * offset and depth, calculate the offset for the CHK at the given
  95  * index.
  96  *
  97  * @param offset the offset of the first
  98  *        DBLOCK in the subtree of the
  99  *        identified IBLOCK
 100  * @param depth the depth of the IBLOCK in the tree
 101  * @param treedepth overall depth of the tree
 102  * @param k which CHK in the IBLOCK are we
 103  *        talking about
 104  * @return offset if k=0, otherwise an appropriately
 105  *         larger value (i.e., if depth = treedepth-1,
 106  *         the returned value should be offset+DBLOCK_SIZE)
 107  */
 108 static uint64_t
 109 compute_dblock_offset (uint64_t offset,
 110                        unsigned int depth,
 111                        unsigned int treedepth,
 112                        unsigned int k)
 113 {
 114   unsigned int i;
 115   uint64_t lsize; /* what is the size of the sum of all DBlocks
 116                      that a CHK at level i corresponds to? */
 117
 118   if (depth == treedepth)
 119     return offset;
 120   lsize = DBLOCK_SIZE;
 121   for (i=treedepth-1;i>depth;i--)
 122     lsize *= CHK_PER_INODE;
 123   return offset + k * lsize;
 124 }
 125
 126
 127 /**
 128  * Fill in all of the generic fields for
 129  * a download event.
 130  *
 131  * @param pi structure to fill in
 132  * @param dc overall download context
 133  */
 134 static void
 135 make_download_status (struct GNUNET_FS_ProgressInfo *pi,
 136                       struct GNUNET_FS_DownloadContext *dc)
 137 {
 138   pi->value.download.dc = dc;
 139   pi->value.download.cctx
 140     = dc->client_info;
 141   pi->value.download.pctx
 142     = (dc->parent == NULL) ? NULL : dc->parent->client_info;
 143   pi->value.download.uri
 144     = dc->uri;
 145   pi->value.download.filename
 146     = dc->filename;
 147   pi->value.download.size
 148     = dc->length;
 149   pi->value.download.duration
 150     = GNUNET_TIME_absolute_get_duration (dc->start_time);
 151   pi->value.download.completed
 152     = dc->completed;
 153   pi->value.download.anonymity
 154     = dc->anonymity;
 155 }
 156
 157 /**
 158  * We're ready to transmit a search request to the
 159  * file-sharing service.  Do it.  If there is
 160  * more than one request pending, try to send
 161  * multiple or request another transmission.
 162  *
 163  * @param cls closure
 164  * @param size number of bytes available in buf
 165  * @param buf where the callee should write the message
 166  * @return number of bytes written to buf
 167  */
 168 static size_t
 169 transmit_download_request (void *cls,
 170                            size_t size,
 171                            void *buf);
 172
 173
 174 /**
 175  * Schedule the download of the specified
 176  * block in the tree.
 177  *
 178  * @param dc overall download this block belongs to
 179  * @param chk content-hash-key of the block
 180  * @param offset offset of the block in the file
 181  *         (for IBlocks, the offset is the lowest
 182  *          offset of any DBlock in the subtree under
 183  *          the IBlock)
 184  * @param depth depth of the block, 0 is the root of the tree
 185  */
 186 static void
 187 schedule_block_download (struct GNUNET_FS_DownloadContext *dc,
 188                          const struct ContentHashKey *chk,
 189                          uint64_t offset,
 190                          unsigned int depth)
 191 {
 192   struct DownloadRequest *sm;
 193   uint64_t off;
 194
 195 #if DEBUG_DOWNLOAD
 196   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 197               "Scheduling download at offset %llu and depth %u for `%s'\n",
 198               (unsigned long long) offset,
 199               depth,
 200               GNUNET_h2s (&chk->query));
 201 #endif
 202   off = compute_disk_offset (GNUNET_ntohll (dc->uri->data.chk.file_length),
 203                              offset,
 204                              depth,
 205                              dc->treedepth);
 206   if ( (dc->old_file_size > off) &&
 207        (dc->handle != NULL) &&
 208        (off  ==
 209         GNUNET_DISK_file_seek (dc->handle,
 210                                off,
 211                                GNUNET_DISK_SEEK_SET) ) )
 212     {
 213       // FIXME: check if block exists on disk!
 214       // (read block, encode, compare with
 215       // query; if matches, simply return)
 216     }
 217   if (depth < dc->treedepth)
 218     {
 219       // FIXME: try if we could
 220       // reconstitute this IBLOCK
 221       // from the existing blocks on disk (can wait)
 222       // (read block(s), encode, compare with
 223       // query; if matches, simply return)
 224     }
 225   sm = GNUNET_malloc (sizeof (struct DownloadRequest));
 226   sm->chk = *chk;
 227   sm->offset = offset;
 228   sm->depth = depth;
 229   sm->is_pending = GNUNET_YES;
 230   sm->next = dc->pending;
 231   dc->pending = sm;
 232   GNUNET_CONTAINER_multihashmap_put (dc->active,
 233                                      &chk->query,
 234                                      sm,
 235                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 236
 237   if ( (dc->th == NULL) &&
 238        (dc->client != NULL) )
 239     dc->th = GNUNET_CLIENT_notify_transmit_ready (dc->client,
 240                                                   sizeof (struct SearchMessage),
 241                                                   GNUNET_CONSTANTS_SERVICE_TIMEOUT,
 242                                                   &transmit_download_request,
 243                                                   dc);
 244
 245 }
 246
 247
 248 /**
 249  * We've lost our connection with the FS service.
 250  * Re-establish it and re-transmit all of our
 251  * pending requests.
 252  *
 253  * @param dc download context that is having trouble
 254  */
 255 static void
 256 try_reconnect (struct GNUNET_FS_DownloadContext *dc);
 257
 258
 259 /**
 260  * Compute how many bytes of data should be stored in
 261  * the specified node.
 262  *
 263  * @param fsize overall file size
 264  * @param totaldepth depth of the entire tree
 265  * @param offset offset of the node
 266  * @param depth depth of the node
 267  * @return number of bytes stored in this node
 268  */
 269 static size_t
 270 calculate_block_size (uint64_t fsize,
 271                       unsigned int totaldepth,
 272                       uint64_t offset,
 273                       unsigned int depth)
 274 {
 275   unsigned int i;
 276   size_t ret;
 277   uint64_t rsize;
 278   uint64_t epos;
 279   unsigned int chks;
 280
 281   GNUNET_assert (offset < fsize);
 282   if (depth == totaldepth)
 283     {
 284       ret = DBLOCK_SIZE;
 285       if (offset + ret > fsize)
 286         ret = (size_t) (fsize - offset);
 287       return ret;
 288     }
 289
 290   rsize = DBLOCK_SIZE;
 291   for (i = totaldepth-1; i > depth; i--)
 292     rsize *= CHK_PER_INODE;
 293   epos = offset + rsize * CHK_PER_INODE;
 294   GNUNET_assert (epos > offset);
 295   if (epos > fsize)
 296     epos = fsize;
 297   /* round up when computing #CHKs in our IBlock */
 298   chks = (epos - offset + rsize - 1) / rsize;
 299   GNUNET_assert (chks <= CHK_PER_INODE);
 300   return chks * sizeof (struct ContentHashKey);
 301 }
 302
 303
 304 /**
 305  * Process a download result.
 306  *
 307  * @param dc our download context
 308  * @param type type of the result
 309  * @param data the (encrypted) response
 310  * @param size size of data
 311  */
 312 static void
 313 process_result (struct GNUNET_FS_DownloadContext *dc,
 314                 uint32_t type,
 315                 const void *data,
 316                 size_t size)
 317 {
 318   struct GNUNET_FS_ProgressInfo pi;
 319   GNUNET_HashCode query;
 320   struct DownloadRequest *sm;
 321   struct GNUNET_CRYPTO_AesSessionKey skey;
 322   struct GNUNET_CRYPTO_AesInitializationVector iv;
 323   char pt[size];
 324   uint64_t off;
 325   size_t app;
 326   int i;
 327   struct ContentHashKey *chk;
 328   char *emsg;
 329
 330
 331   GNUNET_CRYPTO_hash (data, size, &query);
 332 #if DEBUG_DOWNLOAD
 333   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 334               "Received result for query `%s' from `%s'-service\n",
 335               GNUNET_h2s (&query),
 336               "FS");
 337 #endif
 338   sm = GNUNET_CONTAINER_multihashmap_get (dc->active,
 339                                           &query);
 340   if (NULL == sm)
 341     {
 342       GNUNET_break (0);
 343       return;
 344     }
 345   if (size != calculate_block_size (GNUNET_ntohll (dc->uri->data.chk.file_length),
 346                                     dc->treedepth,
 347                                     sm->offset,
 348                                     sm->depth))
 349     {
 350 #if DEBUG_DOWNLOAD
 351       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 352                   "Internal error or bogus download URI (expected %u bytes, got %u)\n",
 353                   calculate_block_size (GNUNET_ntohll (dc->uri->data.chk.file_length),
 354                                         dc->treedepth,
 355                                         sm->offset,
 356                                         sm->depth),
 357                   size);
 358 #endif
 359       dc->emsg = GNUNET_strdup ("Internal error or bogus download URI");
 360       /* signal error */
 361       pi.status = GNUNET_FS_STATUS_DOWNLOAD_ERROR;
 362       make_download_status (&pi, dc);
 363       pi.value.download.specifics.error.message = dc->emsg;
 364       dc->client_info = dc->h->upcb (dc->h->upcb_cls,
 365                                      &pi);
 366       /* abort all pending requests */
 367       if (NULL != dc->th)
 368         {
 369           GNUNET_CONNECTION_notify_transmit_ready_cancel (dc->th);
 370           dc->th = NULL;
 371         }
 372       GNUNET_CLIENT_disconnect (dc->client);
 373       dc->client = NULL;
 374       return;
 375     }
 376   GNUNET_assert (GNUNET_YES ==
 377                  GNUNET_CONTAINER_multihashmap_remove (dc->active,
 378                                                        &query,
 379                                                        sm));
 380   GNUNET_CRYPTO_hash_to_aes_key (&sm->chk.key, &skey, &iv);
 381   GNUNET_CRYPTO_aes_decrypt (data,
 382                              size,
 383                              &skey,
 384                              &iv,
 385                              pt);
 386   /* save to disk */
 387   if ( (NULL != dc->handle) &&
 388        ( (sm->depth == dc->treedepth) ||
 389          (0 == (dc->options & GNUNET_FS_DOWNLOAD_NO_TEMPORARIES)) ) )
 390     {
 391       off = compute_disk_offset (GNUNET_ntohll (dc->uri->data.chk.file_length),
 392                                  sm->offset,
 393                                  sm->depth,
 394                                  dc->treedepth);
 395       emsg = NULL;
 396 #if DEBUG_DOWNLOAD
 397       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 398                   "Saving decrypted block to disk at offset %llu\n",
 399                   (unsigned long long) off);
 400 #endif
 401       if ( (off  !=
 402             GNUNET_DISK_file_seek (dc->handle,
 403                                    off,
 404                                    GNUNET_DISK_SEEK_SET) ) )
 405         GNUNET_asprintf (&emsg,
 406                          _("Failed to seek to offset %llu in file `%s': %s\n"),
 407                          (unsigned long long) off,
 408                          dc->filename,
 409                          STRERROR (errno));
 410       else if (size !=
 411                GNUNET_DISK_file_write (dc->handle,
 412                                        pt,
 413                                        size))
 414         GNUNET_asprintf (&emsg,
 415                          _("Failed to write block of %u bytes at offset %llu in file `%s': %s\n"),
 416                          (unsigned int) size,
 417                          (unsigned long long) off,
 418                          dc->filename,
 419                          STRERROR (errno));
 420       if (NULL != emsg)
 421         {
 422           dc->emsg = emsg;
 423           // FIXME: make persistent
 424
 425           /* signal error */
 426           pi.status = GNUNET_FS_STATUS_DOWNLOAD_ERROR;
 427           make_download_status (&pi, dc);
 428           pi.value.download.specifics.error.message = emsg;
 429           dc->client_info = dc->h->upcb (dc->h->upcb_cls,
 430                                          &pi);
 431
 432           /* abort all pending requests */
 433           if (NULL != dc->th)
 434             {
 435               GNUNET_CONNECTION_notify_transmit_ready_cancel (dc->th);
 436               dc->th = NULL;
 437             }
 438           GNUNET_CLIENT_disconnect (dc->client);
 439           dc->client = NULL;
 440           GNUNET_free (sm);
 441           return;
 442         }
 443     }
 444   if (sm->depth == dc->treedepth)
 445     {
 446       app = size;
 447       if (sm->offset < dc->offset)
 448         {
 449           /* starting offset begins in the middle of pt,
 450              do not count first bytes as progress */
 451           GNUNET_assert (app > (dc->offset - sm->offset));
 452           app -= (dc->offset - sm->offset);
 453         }
 454       if (sm->offset + size > dc->offset + dc->length)
 455         {
 456           /* end of block is after relevant range,
 457              do not count last bytes as progress */
 458           GNUNET_assert (app > (sm->offset + size) - (dc->offset + dc->length));
 459           app -= (sm->offset + size) - (dc->offset + dc->length);
 460         }
 461       dc->completed += app;
 462     }
 463
 464   pi.status = GNUNET_FS_STATUS_DOWNLOAD_PROGRESS;
 465   make_download_status (&pi, dc);
 466   pi.value.download.specifics.progress.data = pt;
 467   pi.value.download.specifics.progress.offset = sm->offset;
 468   pi.value.download.specifics.progress.data_len = size;
 469   pi.value.download.specifics.progress.depth = sm->depth;
 470   dc->client_info = dc->h->upcb (dc->h->upcb_cls,
 471                                  &pi);
 472   GNUNET_assert (dc->completed <= dc->length);
 473   if (dc->completed == dc->length)
 474     {
 475 #if DEBUG_DOWNLOAD
 476       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 477                   "Download completed, truncating file to desired length %llu\n",
 478                   (unsigned long long) GNUNET_ntohll (dc->uri->data.chk.file_length));
 479 #endif
 480       /* truncate file to size (since we store IBlocks at the end) */
 481       if (dc->handle != NULL)
 482         {
 483           GNUNET_DISK_file_close (dc->handle);
 484           dc->handle = NULL;
 485           if (0 != truncate (dc->filename,
 486                              GNUNET_ntohll (dc->uri->data.chk.file_length)))
 487             GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 488                                       "truncate",
 489                                       dc->filename);
 490         }
 491       /* signal completion */
 492       pi.status = GNUNET_FS_STATUS_DOWNLOAD_COMPLETED;
 493       make_download_status (&pi, dc);
 494       dc->client_info = dc->h->upcb (dc->h->upcb_cls,
 495                                      &pi);
 496       GNUNET_assert (sm->depth == dc->treedepth);
 497     }
 498   // FIXME: make persistent
 499   if (sm->depth == dc->treedepth)
 500     {
 501       GNUNET_free (sm);
 502       return;
 503     }
 504 #if DEBUG_DOWNLOAD
 505   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 506               "Triggering downloads of children (this block was at level %u and offset %llu)\n",
 507               sm->depth,
 508               (unsigned long long) sm->offset);
 509 #endif
 510   GNUNET_assert (0 == (size % sizeof(struct ContentHashKey)));
 511   chk = (struct ContentHashKey*) pt;
 512   for (i=(size / sizeof(struct ContentHashKey))-1;i>=0;i--)
 513     {
 514       off = compute_dblock_offset (sm->offset,
 515                                    sm->depth,
 516                                    dc->treedepth,
 517                                    i);
 518       if ( (off + DBLOCK_SIZE >= dc->offset) &&
 519            (off < dc->offset + dc->length) )
 520         schedule_block_download (dc,
 521                                  &chk[i],
 522                                  off,
 523                                  sm->depth + 1);
 524     }
 525   GNUNET_free (sm);
 526 }
 527
 528
 529 /**
 530  * Type of a function to call when we receive a message
 531  * from the service.
 532  *
 533  * @param cls closure
 534  * @param msg message received, NULL on timeout or fatal error
 535  */
 536 static void
 537 receive_results (void *cls,
 538                  const struct GNUNET_MessageHeader * msg)
 539 {
 540   struct GNUNET_FS_DownloadContext *dc = cls;
 541   const struct ContentMessage *cm;
 542   uint16_t msize;
 543
 544   if ( (NULL == msg) ||
 545        (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_FS_CONTENT) ||
 546        (ntohs (msg->size) <= sizeof (struct ContentMessage)) )
 547     {
 548       try_reconnect (dc);
 549       return;
 550     }
 551   msize = ntohs (msg->size);
 552   cm = (const struct ContentMessage*) msg;
 553   process_result (dc,
 554                   ntohl (cm->type),
 555                   &cm[1],
 556                   msize - sizeof (struct ContentMessage));
 557   if (dc->client == NULL)
 558     return; /* fatal error */
 559   /* continue receiving */
 560   GNUNET_CLIENT_receive (dc->client,
 561                          &receive_results,
 562                          dc,
 563                          GNUNET_TIME_UNIT_FOREVER_REL);
 564 }
 565
 566
 567
 568 /**
 569  * We're ready to transmit a search request to the
 570  * file-sharing service.  Do it.  If there is
 571  * more than one request pending, try to send
 572  * multiple or request another transmission.
 573  *
 574  * @param cls closure
 575  * @param size number of bytes available in buf
 576  * @param buf where the callee should write the message
 577  * @return number of bytes written to buf
 578  */
 579 static size_t
 580 transmit_download_request (void *cls,
 581                            size_t size,
 582                            void *buf)
 583 {
 584   struct GNUNET_FS_DownloadContext *dc = cls;
 585   size_t msize;
 586   struct SearchMessage *sm;
 587
 588   dc->th = NULL;
 589   if (NULL == buf)
 590     {
 591       try_reconnect (dc);
 592       return 0;
 593     }
 594   GNUNET_assert (size >= sizeof (struct SearchMessage));
 595   msize = 0;
 596   sm = buf;
 597   while ( (dc->pending != NULL) &&
 598           (size > msize + sizeof (struct SearchMessage)) )
 599     {
 600 #if DEBUG_DOWNLOAD
 601       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 602                   "Transmitting download request for `%s' to `%s'-service\n",
 603                   GNUNET_h2s (&dc->pending->chk.query),
 604                   "FS");
 605 #endif
 606       memset (sm, 0, sizeof (struct SearchMessage));
 607       sm->header.size = htons (sizeof (struct SearchMessage));
 608       sm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_START_SEARCH);
 609       sm->anonymity_level = htonl (dc->anonymity);
 610       sm->target = dc->target.hashPubKey;
 611       sm->query = dc->pending->chk.query;
 612       dc->pending->is_pending = GNUNET_NO;
 613       dc->pending = dc->pending->next;
 614       msize += sizeof (struct SearchMessage);
 615       sm++;
 616     }
 617   if (dc->pending != NULL)
 618     dc->th = GNUNET_CLIENT_notify_transmit_ready (dc->client,
 619                                                   sizeof (struct SearchMessage),
 620                                                   GNUNET_CONSTANTS_SERVICE_TIMEOUT,
 621                                                   &transmit_download_request,
 622                                                   dc);
 623   return msize;
 624 }
 625
 626
 627 /**
 628  * Reconnect to the FS service and transmit
 629  * our queries NOW.
 630  *
 631  * @param cls our download context
 632  * @param tc unused
 633  */
 634 static void
 635 do_reconnect (void *cls,
 636               const struct GNUNET_SCHEDULER_TaskContext *tc)
 637 {
 638   struct GNUNET_FS_DownloadContext *dc = cls;
 639   struct GNUNET_CLIENT_Connection *client;
 640
 641   dc->task = GNUNET_SCHEDULER_NO_TASK;
 642   client = GNUNET_CLIENT_connect (dc->h->sched,
 643                                   "fs",
 644                                   dc->h->cfg);
 645   if (NULL == client)
 646     {
 647       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 648                   "Connecting to `%s'-service failed, will try again.\n",
 649                   "FS");
 650       try_reconnect (dc);
 651       return;
 652     }
 653   dc->client = client;
 654   dc->th = GNUNET_CLIENT_notify_transmit_ready (client,
 655                                                 sizeof (struct SearchMessage),
 656                                                 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
 657                                                 &transmit_download_request,
 658                                                 dc);
 659   GNUNET_CLIENT_receive (client,
 660                          &receive_results,
 661                          dc,
 662                          GNUNET_TIME_UNIT_FOREVER_REL);
 663 }
 664
 665
 666 /**
 667  * Add entries that are not yet pending back to the pending list.
 668  *
 669  * @param cls our download context
 670  * @param key unused
 671  * @param entry entry of type "struct DownloadRequest"
 672  * @return GNUNET_OK
 673  */
 674 static int
 675 retry_entry (void *cls,
 676              const GNUNET_HashCode *key,
 677              void *entry)
 678 {
 679   struct GNUNET_FS_DownloadContext *dc = cls;
 680   struct DownloadRequest *dr = entry;
 681
 682   if (! dr->is_pending)
 683     {
 684       dr->next = dc->pending;
 685       dr->is_pending = GNUNET_YES;
 686       dc->pending = entry;
 687     }
 688   return GNUNET_OK;
 689 }
 690
 691
 692 /**
 693  * We've lost our connection with the FS service.
 694  * Re-establish it and re-transmit all of our
 695  * pending requests.
 696  *
 697  * @param dc download context that is having trouble
 698  */
 699 static void
 700 try_reconnect (struct GNUNET_FS_DownloadContext *dc)
 701 {
 702
 703   if (NULL != dc->client)
 704     {
 705       if (NULL != dc->th)
 706         {
 707           GNUNET_CONNECTION_notify_transmit_ready_cancel (dc->th);
 708           dc->th = NULL;
 709         }
 710       GNUNET_CONTAINER_multihashmap_iterate (dc->active,
 711                                              &retry_entry,
 712                                              dc);
 713       GNUNET_CLIENT_disconnect (dc->client);
 714       dc->client = NULL;
 715     }
 716   dc->task
 717     = GNUNET_SCHEDULER_add_delayed (dc->h->sched,
 718                                     GNUNET_NO,
 719                                     GNUNET_SCHEDULER_PRIORITY_IDLE,
 720                                     GNUNET_SCHEDULER_NO_TASK,
 721                                     GNUNET_TIME_UNIT_SECONDS,
 722                                     &do_reconnect,
 723                                     dc);
 724 }
 725
 726
 727 /**
 728  * Download parts of a file.  Note that this will store
 729  * the blocks at the respective offset in the given file.  Also, the
 730  * download is still using the blocking of the underlying FS
 731  * encoding.  As a result, the download may *write* outside of the
 732  * given boundaries (if offset and length do not match the 32k FS
 733  * block boundaries). <p>
 734  *
 735  * This function should be used to focus a download towards a
 736  * particular portion of the file (optimization), not to strictly
 737  * limit the download to exactly those bytes.
 738  *
 739  * @param h handle to the file sharing subsystem
 740  * @param uri the URI of the file (determines what to download); CHK or LOC URI
 741  * @param meta known metadata for the file (can be NULL)
 742  * @param filename where to store the file, maybe NULL (then no file is
 743  *        created on disk and data must be grabbed from the callbacks)
 744  * @param offset at what offset should we start the download (typically 0)
 745  * @param length how many bytes should be downloaded starting at offset
 746  * @param anonymity anonymity level to use for the download
 747  * @param options various options
 748  * @param cctx initial value for the client context for this download
 749  * @param parent parent download to associate this download with (use NULL
 750  *        for top-level downloads; useful for manually-triggered recursive downloads)
 751  * @return context that can be used to control this download
 752  */
 753 struct GNUNET_FS_DownloadContext *
 754 GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
 755                           const struct GNUNET_FS_Uri *uri,
 756                           const struct GNUNET_CONTAINER_MetaData *meta,
 757                           const char *filename,
 758                           uint64_t offset,
 759                           uint64_t length,
 760                           uint32_t anonymity,
 761                           enum GNUNET_FS_DownloadOptions options,
 762                           void *cctx,
 763                           struct GNUNET_FS_DownloadContext *parent)
 764 {
 765   struct GNUNET_FS_ProgressInfo pi;
 766   struct GNUNET_FS_DownloadContext *dc;
 767   struct GNUNET_CLIENT_Connection *client;
 768
 769   client = GNUNET_CLIENT_connect (h->sched,
 770                                   "fs",
 771                                   h->cfg);
 772   if (NULL == client)
 773     return NULL;
 774   // FIXME: add support for "loc" URIs!
 775   GNUNET_assert (GNUNET_FS_uri_test_chk (uri));
 776   if ( (offset + length < offset) ||
 777        (offset + length > uri->data.chk.file_length) )
 778     {
 779       GNUNET_break (0);
 780       return NULL;
 781     }
 782 #if DEBUG_DOWNLOAD
 783   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 784               "Starting download `%s' of %llu bytes\n",
 785               filename,
 786               (unsigned long long) length);
 787 #endif
 788   dc = GNUNET_malloc (sizeof(struct GNUNET_FS_DownloadContext));
 789   dc->h = h;
 790   dc->client = client;
 791   dc->parent = parent;
 792   dc->uri = GNUNET_FS_uri_dup (uri);
 793   dc->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
 794   dc->client_info = cctx;
 795   if (NULL != filename)
 796     {
 797       dc->filename = GNUNET_strdup (filename);
 798       if (GNUNET_YES == GNUNET_DISK_file_test (filename))
 799         GNUNET_DISK_file_size (filename,
 800                                &dc->old_file_size,
 801                                GNUNET_YES);
 802       dc->handle = GNUNET_DISK_file_open (filename,
 803                                           GNUNET_DISK_OPEN_READWRITE |
 804                                           GNUNET_DISK_OPEN_CREATE,
 805                                           GNUNET_DISK_PERM_USER_READ |
 806                                           GNUNET_DISK_PERM_USER_WRITE |
 807                                           GNUNET_DISK_PERM_GROUP_READ |
 808                                           GNUNET_DISK_PERM_OTHER_READ);
 809       if (dc->handle == NULL)
 810         {
 811           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 812                       _("Download failed: could not open file `%s': %s\n"),
 813                       dc->filename,
 814                       STRERROR (errno));
 815           GNUNET_CONTAINER_meta_data_destroy (dc->meta);
 816           GNUNET_FS_uri_destroy (dc->uri);
 817           GNUNET_free (dc->filename);
 818           GNUNET_CLIENT_disconnect (dc->client);
 819           GNUNET_free (dc);
 820           return NULL;
 821         }
 822     }
 823   // FIXME: set "dc->target" for LOC uris!
 824   dc->offset = offset;
 825   dc->length = length;
 826   dc->anonymity = anonymity;
 827   dc->options = options;
 828   dc->active = GNUNET_CONTAINER_multihashmap_create (2 * (length / DBLOCK_SIZE));
 829   dc->treedepth = GNUNET_FS_compute_depth (GNUNET_ntohll(dc->uri->data.chk.file_length));
 830 #if DEBUG_DOWNLOAD
 831   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 832               "Download tree has depth %u\n",
 833               dc->treedepth);
 834 #endif
 835   // FIXME: make persistent
 836   schedule_block_download (dc,
 837                            &dc->uri->data.chk.chk,
 838                            0,
 839                            1 /* 0 == CHK, 1 == top */);
 840   GNUNET_CLIENT_receive (client,
 841                          &receive_results,
 842                          dc,
 843                          GNUNET_TIME_UNIT_FOREVER_REL);
 844   pi.status = GNUNET_FS_STATUS_DOWNLOAD_START;
 845   make_download_status (&pi, dc);
 846   pi.value.download.specifics.start.meta = meta;
 847   dc->client_info = dc->h->upcb (dc->h->upcb_cls,
 848                                  &pi);
 849
 850   return dc;
 851 }
 852
 853
 854 /**
 855  * Free entries in the map.
 856  *
 857  * @param cls unused (NULL)
 858  * @param key unused
 859  * @param entry entry of type "struct DownloadRequest" which is freed
 860  * @return GNUNET_OK
 861  */
 862 static int
 863 free_entry (void *cls,
 864             const GNUNET_HashCode *key,
 865             void *entry)
 866 {
 867   GNUNET_free (entry);
 868   return GNUNET_OK;
 869 }
 870
 871
 872 /**
 873  * Stop a download (aborts if download is incomplete).
 874  *
 875  * @param dc handle for the download
 876  * @param do_delete delete files of incomplete downloads
 877  */
 878 void
 879 GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc,
 880                          int do_delete)
 881 {
 882   struct GNUNET_FS_ProgressInfo pi;
 883
 884   // FIXME: make unpersistent
 885   pi.status = GNUNET_FS_STATUS_DOWNLOAD_STOPPED;
 886   make_download_status (&pi, dc);
 887   dc->client_info = dc->h->upcb (dc->h->upcb_cls,
 888                                  &pi);
 889
 890   if (GNUNET_SCHEDULER_NO_TASK != dc->task)
 891     GNUNET_SCHEDULER_cancel (dc->h->sched,
 892                              dc->task);
 893   if (NULL != dc->th)
 894     {
 895       GNUNET_CONNECTION_notify_transmit_ready_cancel (dc->th);
 896       dc->th = NULL;
 897     }
 898   if (NULL != dc->client)
 899     GNUNET_CLIENT_disconnect (dc->client);
 900   GNUNET_CONTAINER_multihashmap_iterate (dc->active,
 901                                          &free_entry,
 902                                          NULL);
 903   GNUNET_CONTAINER_multihashmap_destroy (dc->active);
 904   if (dc->filename != NULL)
 905     {
 906       if (NULL != dc->handle)
 907         GNUNET_DISK_file_close (dc->handle);
 908       if ( (dc->completed != dc->length) &&
 909            (GNUNET_YES == do_delete) )
 910         {
 911           if (0 != UNLINK (dc->filename))
 912             GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 913                                       "unlink",
 914                                       dc->filename);
 915         }
 916       GNUNET_free (dc->filename);
 917     }
 918   GNUNET_CONTAINER_meta_data_destroy (dc->meta);
 919   GNUNET_FS_uri_destroy (dc->uri);
 920   GNUNET_free (dc);
 921 }
 922
 923
 924
 925 #if 0
 926
 927
 928 /**
 929  * Check if self block is already present on the drive.  If the block
 930  * is a dblock and present, the ProgressModel is notified. If the
 931  * block is present and it is an iblock, downloading the children is
 932  * triggered.
 933  *
 934  * Also checks if the block is within the range of blocks
 935  * that we are supposed to download.  If not, the method
 936  * returns as if the block is present but does NOT signal
 937  * progress.
 938  *
 939  * @param node that is checked for presence
 940  * @return GNUNET_YES if present, GNUNET_NO if not.
 941  */
 942 static int
 943 check_node_present (const struct Node *node)
 944 {
 945   int res;
 946   int ret;
 947   char *data;
 948   unsigned int size;
 949   GNUNET_HashCode hc;
 950
 951   size = get_node_size (node);
 952   /* first check if node is within range.
 953      For now, keeping it simple, we only do
 954      this for level-0 nodes */
 955   if ((node->level == 0) &&
 956       ((node->offset + size < node->ctx->offset) ||
 957        (node->offset >= node->ctx->offset + node->ctx->length)))
 958     return GNUNET_YES;
 959   data = GNUNET_malloc (size);
 960   ret = GNUNET_NO;
 961   res = read_from_files (node->ctx, node->level, node->offset, data, size);
 962   if (res == size)
 963     {
 964       GNUNET_hash (data, size, &hc);
 965       if (0 == memcmp (&hc, &node->chk.key, sizeof (GNUNET_HashCode)))
 966         {
 967           notify_client_about_progress (node, data, size);
 968           if (node->level > 0)
 969             iblock_download_children (node, data, size);
 970           ret = GNUNET_YES;
 971         }
 972     }
 973   GNUNET_free (data);
 974   return ret;
 975 }
 976
 977 #endif
 978
 979
 980 /* end of fs_download.c */