2 This file is part of GNUnet.
3 (C) 2001-2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
21 * @file fs/fs_download.c
22 * @brief download methods
23 * @author Christian Grothoff
26 * - different priority for scheduling probe downloads?
29 #include "gnunet_constants.h"
30 #include "gnunet_fs_service.h"
34 #define DEBUG_DOWNLOAD GNUNET_NO
37 * Determine if the given download (options and meta data) should cause
38 * use to try to do a recursive download.
41 is_recursive_download (struct GNUNET_FS_DownloadContext *dc)
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)) &&
49 strstr (dc->filename + strlen(dc->filename) - strlen(GNUNET_FS_DIRECTORY_EXT),
50 GNUNET_FS_DIRECTORY_EXT)) ) ) ) );
55 * We're storing the IBLOCKS after the DBLOCKS on disk (so that we
56 * only have to truncate the file once we're done).
58 * Given the offset of a block (with respect to the DBLOCKS) and its
59 * depth, return the offset where we would store this block in the
62 * @param fsize overall file size
63 * @param off offset of the block in the file
64 * @param depth depth of the block in the tree, 0 for DBLOCK
65 * @return off for DBLOCKS (depth == treedepth),
66 * otherwise an offset past the end
67 * of the file that does not overlap
68 * with the range for any other block
71 compute_disk_offset (uint64_t fsize,
76 uint64_t lsize; /* what is the size of all IBlocks for depth "i"? */
77 uint64_t loff; /* where do IBlocks for depth "i" start? */
78 unsigned int ioff; /* which IBlock corresponds to "off" at depth "i"? */
82 /* first IBlocks start at the end of file, rounded up
83 to full DBLOCK_SIZE */
84 loff = ((fsize + DBLOCK_SIZE - 1) / DBLOCK_SIZE) * DBLOCK_SIZE;
85 lsize = ( (fsize + DBLOCK_SIZE - 1) / DBLOCK_SIZE) * sizeof (struct ContentHashKey);
86 GNUNET_assert (0 == (off % DBLOCK_SIZE));
87 ioff = (off / DBLOCK_SIZE);
91 lsize = (lsize + CHK_PER_INODE - 1) / CHK_PER_INODE;
92 GNUNET_assert (lsize > 0);
93 GNUNET_assert (0 == (ioff % CHK_PER_INODE));
94 ioff /= CHK_PER_INODE;
96 return loff + ioff * sizeof (struct ContentHashKey);
101 * Fill in all of the generic fields for a download event and call the
104 * @param pi structure to fill in
105 * @param dc overall download context
108 GNUNET_FS_download_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
109 struct GNUNET_FS_DownloadContext *dc)
111 pi->value.download.dc = dc;
112 pi->value.download.cctx
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
120 pi->value.download.filename
122 pi->value.download.size
124 pi->value.download.duration
125 = GNUNET_TIME_absolute_get_duration (dc->start_time);
126 pi->value.download.completed
128 pi->value.download.anonymity
130 pi->value.download.eta
131 = GNUNET_TIME_calculate_eta (dc->start_time,
134 pi->value.download.is_active = (dc->client == NULL) ? GNUNET_NO : GNUNET_YES;
135 if (0 == (dc->options & GNUNET_FS_DOWNLOAD_IS_PROBE))
136 dc->client_info = dc->h->upcb (dc->h->upcb_cls,
139 dc->client_info = GNUNET_FS_search_probe_progress_ (NULL,
145 * We're ready to transmit a search request to the
146 * file-sharing service. Do it. If there is
147 * more than one request pending, try to send
148 * multiple or request another transmission.
151 * @param size number of bytes available in buf
152 * @param buf where the callee should write the message
153 * @return number of bytes written to buf
156 transmit_download_request (void *cls,
162 * Closure for iterator processing results.
164 struct ProcessResultClosure
170 GNUNET_HashCode query;
173 * Data found in P2P network.
178 * Our download context.
180 struct GNUNET_FS_DownloadContext *dc;
183 * Number of bytes in data.
190 enum GNUNET_BLOCK_Type type;
193 * Flag to indicate if this block should be stored on disk.
201 * Iterator over entries in the pending requests in the 'active' map for the
202 * reply that we just got.
204 * @param cls closure (our 'struct ProcessResultClosure')
205 * @param key query for the given value / request
206 * @param value value in the hash map (a 'struct DownloadRequest')
207 * @return GNUNET_YES (we should continue to iterate); unless serious error
210 process_result_with_request (void *cls,
211 const GNUNET_HashCode * key,
216 * We've found a matching block without downloading it.
217 * Encrypt it and pass it to our "receive" function as
218 * if we had received it from the network.
220 * @param dc download in question
221 * @param chk request this relates to
222 * @param dr request details
223 * @param block plaintext data matching request
224 * @param len number of bytes in block
225 * @param do_store should we still store the block on disk?
226 * @return GNUNET_OK on success
229 encrypt_existing_match (struct GNUNET_FS_DownloadContext *dc,
230 const struct ContentHashKey *chk,
231 struct DownloadRequest *dr,
236 struct ProcessResultClosure prc;
238 struct GNUNET_CRYPTO_AesSessionKey sk;
239 struct GNUNET_CRYPTO_AesInitializationVector iv;
240 GNUNET_HashCode query;
242 GNUNET_CRYPTO_hash_to_aes_key (&chk->key, &sk, &iv);
243 if (-1 == GNUNET_CRYPTO_aes_encrypt (block, len,
249 return GNUNET_SYSERR;
251 GNUNET_CRYPTO_hash (enc, len, &query);
252 if (0 != memcmp (&query,
254 sizeof (GNUNET_HashCode)))
257 return GNUNET_SYSERR;
260 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
261 "Matching block for `%s' at offset %llu already present, no need for download!\n",
263 (unsigned long long) dr->offset);
265 /* already got it! */
269 prc.type = (0 == dr->depth)
270 ? GNUNET_BLOCK_TYPE_FS_DBLOCK
271 : GNUNET_BLOCK_TYPE_FS_IBLOCK;
272 prc.query = chk->query;
273 prc.do_store = do_store;
274 process_result_with_request (&prc,
282 * We've lost our connection with the FS service.
283 * Re-establish it and re-transmit all of our
286 * @param dc download context that is having trouble
289 try_reconnect (struct GNUNET_FS_DownloadContext *dc);
293 * We found an entry in a directory. Check if the respective child
294 * already exists and if not create the respective child download.
296 * @param cls the parent download
297 * @param filename name of the file in the directory
298 * @param uri URI of the file (CHK or LOC)
299 * @param meta meta data of the file
300 * @param length number of bytes in data
301 * @param data contents of the file (or NULL if they were not inlined)
304 trigger_recursive_download (void *cls,
305 const char *filename,
306 const struct GNUNET_FS_Uri *uri,
307 const struct GNUNET_CONTAINER_MetaData *meta,
313 * We're done downloading a directory. Open the file and
314 * trigger all of the (remaining) child downloads.
316 * @param dc context of download that just completed
319 full_recursive_download (struct GNUNET_FS_DownloadContext *dc)
324 struct GNUNET_DISK_FileHandle *h;
325 struct GNUNET_DISK_MapHandle *m;
327 size64 = GNUNET_FS_uri_chk_get_file_size (dc->uri);
328 size = (size_t) size64;
329 if (size64 != (uint64_t) size)
331 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
332 _("Recursive downloads of directories larger than 4 GB are not supported on 32-bit systems\n"));
335 if (dc->filename != NULL)
337 h = GNUNET_DISK_file_open (dc->filename,
338 GNUNET_DISK_OPEN_READ,
339 GNUNET_DISK_PERM_NONE);
343 GNUNET_assert (dc->temp_filename != NULL);
344 h = GNUNET_DISK_file_open (dc->temp_filename,
345 GNUNET_DISK_OPEN_READ,
346 GNUNET_DISK_PERM_NONE);
350 data = GNUNET_DISK_file_map (h, &m, GNUNET_DISK_MAP_TYPE_READ, size);
353 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
354 _("Directory too large for system address space\n"));
358 GNUNET_FS_directory_list_contents (size,
361 &trigger_recursive_download,
363 GNUNET_DISK_file_unmap (m);
365 GNUNET_DISK_file_close (h);
366 if (dc->filename == NULL)
368 if (0 != UNLINK (dc->temp_filename))
369 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
372 GNUNET_free (dc->temp_filename);
373 dc->temp_filename = NULL;
379 * Check if all child-downloads have completed (or trigger them if
380 * necessary) and once we're completely done, signal completion (and
381 * possibly recurse to parent). This function MUST be called when the
382 * download of a file itself is done or when the download of a file is
383 * done and then later a direct child download has completed (and
384 * hence this download may complete itself).
386 * @param dc download to check for completion of children
389 check_completed (struct GNUNET_FS_DownloadContext *dc)
391 struct GNUNET_FS_ProgressInfo pi;
392 struct GNUNET_FS_DownloadContext *pos;
394 /* first, check if we need to download children */
395 if ( (dc->child_head == NULL) &&
396 (is_recursive_download (dc)) )
397 full_recursive_download (dc);
398 /* then, check if children are done already */
399 pos = dc->child_head;
402 if ( (pos->emsg == NULL) &&
403 (pos->completed < pos->length) )
404 return; /* not done yet */
405 if ( (pos->child_head != NULL) &&
406 (pos->has_finished != GNUNET_YES) )
407 return; /* not transitively done yet */
410 /* All of our children are done, so mark this download done */
411 dc->has_finished = GNUNET_YES;
412 if (dc->job_queue != NULL)
414 GNUNET_FS_dequeue_ (dc->job_queue);
415 dc->job_queue = NULL;
417 GNUNET_FS_download_sync_ (dc);
419 /* signal completion */
420 pi.status = GNUNET_FS_STATUS_DOWNLOAD_COMPLETED;
421 GNUNET_FS_download_make_status_ (&pi, dc);
423 /* let parent know */
424 if (dc->parent != NULL)
425 check_completed (dc->parent);
430 * We got a block of plaintext data (from the meta data).
431 * Try it for upward reconstruction of the data. On success,
432 * the top-level block will move to state BRS_DOWNLOAD_UP.
434 * @param dc context for the download
435 * @param dr download request to match against
436 * @param data plaintext data, starting from the beginning of the file
437 * @param data_len number of bytes in data
440 try_match_block (struct GNUNET_FS_DownloadContext *dc,
441 struct DownloadRequest *dr,
445 struct GNUNET_FS_ProgressInfo pi;
447 char enc[DBLOCK_SIZE];
448 struct ContentHashKey chks[CHK_PER_INODE];
449 struct ContentHashKey in_chk;
450 struct GNUNET_CRYPTO_AesSessionKey sk;
451 struct GNUNET_CRYPTO_AesInitializationVector iv;
453 struct DownloadRequest *drc;
454 struct GNUNET_DISK_FileHandle *fh;
461 odata_len = data_len;
462 if (BRS_DOWNLOAD_UP == dr->state)
466 complete = GNUNET_YES;
467 for (i=0;i<dr->num_children;i++)
469 drc = dr->children[i];
473 if (drc->state != BRS_RECONSTRUCT_META_UP)
474 complete = GNUNET_NO;
478 if (GNUNET_YES != complete)
480 data = (const char*) chks;
481 dlen = dr->num_children * sizeof (struct ContentHashKey);
485 if (dr->offset > data_len)
487 dlen = GNUNET_MIN (data_len - dr->offset,
490 GNUNET_CRYPTO_hash (&data[dr->offset],
493 GNUNET_CRYPTO_hash_to_aes_key (&in_chk.key, &sk, &iv);
494 if (-1 == GNUNET_CRYPTO_aes_encrypt (&data[dr->offset], dlen,
502 GNUNET_CRYPTO_hash (enc, dlen, &in_chk.query);
507 dr->state = BRS_RECONSTRUCT_META_UP;
510 if (0 != memcmp (&in_chk,
512 sizeof (struct ContentHashKey)))
514 /* other peer provided bogus meta data */
518 /* write block to disk */
519 fn = dc->filename != NULL
522 fh = GNUNET_DISK_file_open (fn,
523 GNUNET_DISK_OPEN_READWRITE |
524 GNUNET_DISK_OPEN_CREATE |
525 GNUNET_DISK_OPEN_TRUNCATE,
526 GNUNET_DISK_PERM_USER_READ |
527 GNUNET_DISK_PERM_USER_WRITE |
528 GNUNET_DISK_PERM_GROUP_READ |
529 GNUNET_DISK_PERM_OTHER_READ);
532 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
535 GNUNET_asprintf (&dc->emsg,
536 _("Failed to open file `%s' for writing"),
538 GNUNET_DISK_file_close (fh);
539 dr->state = BRS_ERROR;
540 pi.status = GNUNET_FS_STATUS_DOWNLOAD_ERROR;
541 pi.value.download.specifics.error.message = dc->emsg;
542 GNUNET_FS_download_make_status_ (&pi, dc);
546 GNUNET_DISK_file_write (fh,
550 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
553 GNUNET_asprintf (&dc->emsg,
554 _("Failed to open file `%s' for writing"),
556 GNUNET_DISK_file_close (fh);
557 dr->state = BRS_ERROR;
558 pi.status = GNUNET_FS_STATUS_DOWNLOAD_ERROR;
559 pi.value.download.specifics.error.message = dc->emsg;
560 GNUNET_FS_download_make_status_ (&pi, dc);
563 GNUNET_DISK_file_close (fh);
565 dr->state = BRS_DOWNLOAD_UP;
566 dc->completed = dc->length;
567 GNUNET_FS_download_sync_ (dc);
568 pi.status = GNUNET_FS_STATUS_DOWNLOAD_PROGRESS;
569 pi.value.download.specifics.progress.data = data;
570 pi.value.download.specifics.progress.offset = 0;
571 pi.value.download.specifics.progress.data_len = dlen;
572 pi.value.download.specifics.progress.depth = 0;
573 GNUNET_FS_download_make_status_ (&pi, dc);
574 if ( (NULL != dc->filename) &&
575 (0 != truncate (dc->filename,
576 GNUNET_ntohll (dc->uri->data.chk.file_length))) )
577 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
580 check_completed (dc);
583 /* how did we get here? */
591 * Type of a function that libextractor calls for each
592 * meta data item found. If we find full data meta data,
593 * call 'try_match_block' on it.
595 * @param cls our 'struct GNUNET_FS_DownloadContext*'
596 * @param plugin_name name of the plugin that produced this value;
597 * special values can be used (i.e. '<zlib>' for zlib being
598 * used in the main libextractor library and yielding
600 * @param type libextractor-type describing the meta data
601 * @param format basic format information about data
602 * @param data_mime_type mime-type of data (not of the original file);
603 * can be NULL (if mime-type is not known)
604 * @param data actual meta-data found
605 * @param data_len number of bytes in data
606 * @return 0 to continue extracting, 1 to abort
609 match_full_data (void *cls,
610 const char *plugin_name,
611 enum EXTRACTOR_MetaType type,
612 enum EXTRACTOR_MetaFormat format,
613 const char *data_mime_type,
617 struct GNUNET_FS_DownloadContext *dc = cls;
619 if (type != EXTRACTOR_METATYPE_GNUNET_FULL_DATA)
622 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
623 "Found %u bytes of FD!\n",
624 (unsigned int) data_len);
626 if (GNUNET_FS_uri_chk_get_file_size (dc->uri) != data_len)
629 return 1; /* bogus meta data */
640 * Set the state of the given download request to
641 * BRS_DOWNLOAD_UP and propagate it up the tree.
643 * @param dr download request that is done
646 propagate_up (struct DownloadRequest *dr)
652 dr->state = BRS_DOWNLOAD_UP;
656 for (i=0;i<dr->num_children;i++)
657 if (dr->children[i]->state != BRS_DOWNLOAD_UP)
660 while (i == dr->num_children);
665 * Try top-down reconstruction. Before, the given request node
666 * must have the state BRS_CHK_SET. Afterwards, more nodes may
667 * have that state or advanced to BRS_DOWNLOAD_DOWN or even
668 * BRS_DOWNLOAD_UP. It is also possible to get BRS_ERROR on the
671 * @param dc overall download this block belongs to
672 * @param dr block to reconstruct
675 try_top_down_reconstruction (struct GNUNET_FS_DownloadContext *dc,
676 struct DownloadRequest *dr)
679 char block[DBLOCK_SIZE];
684 unsigned int chk_off;
685 struct DownloadRequest *drc;
686 uint64_t child_block_size;
687 const struct ContentHashKey *chks;
690 GNUNET_assert (dc->rfh != NULL);
691 GNUNET_assert (dr->state == BRS_CHK_SET);
692 total = GNUNET_FS_uri_chk_get_file_size (dc->uri);
693 GNUNET_assert (dr->depth < dc->treedepth);
694 len = GNUNET_FS_tree_calculate_block_size (total,
697 GNUNET_assert (len <= DBLOCK_SIZE);
698 off = compute_disk_offset (total,
701 if (dc->old_file_size < off + len)
702 return; /* failure */
704 GNUNET_DISK_file_seek (dc->rfh,
706 GNUNET_DISK_SEEK_SET) )
708 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
711 return; /* failure */
714 GNUNET_DISK_file_read (dc->rfh,
718 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
721 return; /* failure */
723 GNUNET_CRYPTO_hash (block, len, &key);
724 if (0 != memcmp (&key,
726 sizeof (GNUNET_HashCode)))
727 return; /* mismatch */
729 encrypt_existing_match (dc,
736 /* hash matches but encrypted block does not, really bad */
737 dr->state = BRS_ERROR;
739 while (dr->parent != NULL)
742 dr->state = BRS_ERROR;
747 dr->state = BRS_DOWNLOAD_DOWN;
749 /* set CHKs for children */
750 up_done = GNUNET_YES;
751 chks = (const struct ContentHashKey*) block;
752 for (i=0;i<dr->num_children;i++)
754 drc = dr->children[i];
755 GNUNET_assert (drc->offset >= dr->offset);
756 child_block_size = GNUNET_FS_tree_compute_tree_size (drc->depth);
757 GNUNET_assert (0 == (drc->offset - dr->offset) % child_block_size);
758 chk_off = (drc->offset - dr->offset) / child_block_size;
759 GNUNET_assert (drc->state == BRS_INIT);
760 drc->state = BRS_CHK_SET;
761 drc->chk = chks[chk_off];
762 try_top_down_reconstruction (dc, drc);
763 if (drc->state != BRS_DOWNLOAD_UP)
764 up_done = GNUNET_NO; /* children not all done */
766 if (up_done == GNUNET_YES)
767 propagate_up (dr); /* children all done (or no children...) */
772 * Schedule the download of the specified block in the tree.
774 * @param dc overall download this block belongs to
775 * @param dr request to schedule
778 schedule_block_download (struct GNUNET_FS_DownloadContext *dc,
779 struct DownloadRequest *dr)
788 case BRS_RECONSTRUCT_DOWN:
791 case BRS_RECONSTRUCT_META_UP:
794 case BRS_RECONSTRUCT_UP:
798 /* normal case, start download */
800 case BRS_DOWNLOAD_DOWN:
801 for (i=0;i<dr->num_children;i++)
802 schedule_block_download (dc, dr->children[i]);
804 case BRS_DOWNLOAD_UP:
812 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
813 "Scheduling download at offset %llu and depth %u for `%s'\n",
814 (unsigned long long) dr->offset,
816 GNUNET_h2s (&dr->chk.query));
818 GNUNET_assert (GNUNET_NO ==
819 GNUNET_CONTAINER_multihashmap_contains_value (dc->active,
822 GNUNET_CONTAINER_multihashmap_put (dc->active,
825 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
826 if (dc->client == NULL)
827 return; /* download not active */
828 GNUNET_CONTAINER_DLL_insert (dc->pending_head,
831 dr->is_pending = GNUNET_YES;
833 dc->th = GNUNET_CLIENT_notify_transmit_ready (dc->client,
834 sizeof (struct SearchMessage),
835 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
837 &transmit_download_request,
842 #define GNUNET_FS_URI_CHK_PREFIX GNUNET_FS_URI_PREFIX GNUNET_FS_URI_CHK_INFIX
845 * We found an entry in a directory. Check if the respective child
846 * already exists and if not create the respective child download.
848 * @param cls the parent download
849 * @param filename name of the file in the directory
850 * @param uri URI of the file (CHK or LOC)
851 * @param meta meta data of the file
852 * @param length number of bytes in data
853 * @param data contents of the file (or NULL if they were not inlined)
856 trigger_recursive_download (void *cls,
857 const char *filename,
858 const struct GNUNET_FS_Uri *uri,
859 const struct GNUNET_CONTAINER_MetaData *meta,
863 struct GNUNET_FS_DownloadContext *dc = cls;
864 struct GNUNET_FS_DownloadContext *cpos;
875 return; /* entry for the directory itself */
876 cpos = dc->child_head;
879 if ( (GNUNET_FS_uri_test_equal (uri,
881 ( (filename != NULL) &&
882 (0 == strcmp (cpos->filename,
888 return; /* already exists */
890 if (NULL == filename)
892 fn = GNUNET_FS_meta_data_suggest_filename (meta);
895 us = GNUNET_FS_uri_to_string (uri);
896 fn = GNUNET_strdup (&us [strlen (GNUNET_FS_URI_CHK_PREFIX)]);
899 else if (fn[0] == '.')
902 us = GNUNET_FS_uri_to_string (uri);
903 GNUNET_asprintf (&fn,
905 &us[strlen (GNUNET_FS_URI_CHK_PREFIX)], ext);
909 /* change '\' to '/' (this should have happened
910 during insertion, but malicious peers may
911 not have done this) */
912 while (NULL != (pos = strstr (fn, "\\")))
914 /* remove '../' everywhere (again, well-behaved
915 peers don't do this, but don't trust that
916 we did not get something nasty) */
917 while (NULL != (pos = strstr (fn, "../")))
925 if (dc->filename == NULL)
931 dn = GNUNET_strdup (dc->filename);
932 GNUNET_break ( (strlen (dn) >= strlen (GNUNET_FS_DIRECTORY_EXT)) &&
934 strstr (dn + strlen(dn) - strlen(GNUNET_FS_DIRECTORY_EXT),
935 GNUNET_FS_DIRECTORY_EXT)) );
936 sfn = GNUNET_strdup (filename);
937 while ( (strlen (sfn) > 0) &&
938 (filename[strlen(sfn)-1] == '/') )
939 sfn[strlen(sfn)-1] = '\0';
940 if ( (strlen (dn) >= strlen (GNUNET_FS_DIRECTORY_EXT)) &&
942 strstr (dn + strlen(dn) - strlen(GNUNET_FS_DIRECTORY_EXT),
943 GNUNET_FS_DIRECTORY_EXT)) )
944 dn[strlen(dn) - strlen (GNUNET_FS_DIRECTORY_EXT)] = '\0';
945 if ( (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta)) &&
946 ( (strlen (filename) < strlen (GNUNET_FS_DIRECTORY_EXT)) ||
948 strstr (filename + strlen(filename) - strlen(GNUNET_FS_DIRECTORY_EXT),
949 GNUNET_FS_DIRECTORY_EXT)) ) )
951 GNUNET_asprintf (&full_name,
956 GNUNET_FS_DIRECTORY_EXT);
960 GNUNET_asprintf (&full_name,
969 if ( (full_name != NULL) &&
971 GNUNET_DISK_directory_create_for_file (full_name)) )
973 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
974 _("Failed to create directory for recursive download of `%s'\n"),
976 GNUNET_free (full_name);
977 GNUNET_free_non_null (fn);
983 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
984 "Triggering recursive download of size %llu with %u bytes MD\n",
985 (unsigned long long) GNUNET_FS_uri_chk_get_file_size (uri),
986 (unsigned int) GNUNET_CONTAINER_meta_data_get_serialized_size (meta));
988 GNUNET_FS_download_start (dc->h,
991 full_name, temp_name,
993 GNUNET_FS_uri_chk_get_file_size (uri),
998 GNUNET_free_non_null (full_name);
999 GNUNET_free_non_null (temp_name);
1000 GNUNET_free_non_null (fn);
1005 * (recursively) free download request structure
1007 * @param dr request to free
1010 GNUNET_FS_free_download_request_ (struct DownloadRequest *dr)
1016 for (i=0;i<dr->num_children;i++)
1017 GNUNET_FS_free_download_request_ (dr->children[i]);
1018 GNUNET_free_non_null (dr->children);
1024 * Iterator over entries in the pending requests in the 'active' map for the
1025 * reply that we just got.
1027 * @param cls closure (our 'struct ProcessResultClosure')
1028 * @param key query for the given value / request
1029 * @param value value in the hash map (a 'struct DownloadRequest')
1030 * @return GNUNET_YES (we should continue to iterate); unless serious error
1033 process_result_with_request (void *cls,
1034 const GNUNET_HashCode *key,
1037 struct ProcessResultClosure *prc = cls;
1038 struct DownloadRequest *dr = value;
1039 struct GNUNET_FS_DownloadContext *dc = prc->dc;
1040 struct DownloadRequest *drc;
1041 struct GNUNET_DISK_FileHandle *fh = NULL;
1042 struct GNUNET_CRYPTO_AesSessionKey skey;
1043 struct GNUNET_CRYPTO_AesInitializationVector iv;
1045 struct GNUNET_FS_ProgressInfo pi;
1050 struct ContentHashKey *chk;
1053 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1054 "Received block `%s' matching pending request at depth %u and offset %llu/%llu\n",
1057 (unsigned long long) dr->offset,
1058 (unsigned long long) GNUNET_ntohll (dc->uri->data.chk.file_length));
1061 bs = GNUNET_FS_tree_calculate_block_size (GNUNET_ntohll (dc->uri->data.chk.file_length),
1064 if (prc->size != bs)
1066 GNUNET_asprintf (&dc->emsg,
1067 _("Internal error or bogus download URI (expected %u bytes at depth %u and offset %llu/%llu, got %u bytes)\n"),
1070 (unsigned long long) dr->offset,
1071 (unsigned long long) GNUNET_ntohll (dc->uri->data.chk.file_length),
1073 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1076 while (dr->parent != NULL)
1078 dr->state = BRS_ERROR;
1081 dr->state = BRS_ERROR;
1085 (void) GNUNET_CONTAINER_multihashmap_remove (dc->active,
1088 if (GNUNET_YES == dr->is_pending)
1090 GNUNET_CONTAINER_DLL_remove (dc->pending_head,
1093 dr->is_pending = GNUNET_NO;
1097 GNUNET_CRYPTO_hash_to_aes_key (&dr->chk.key, &skey, &iv);
1098 if (-1 == GNUNET_CRYPTO_aes_decrypt (prc->data,
1105 dc->emsg = GNUNET_strdup (_("internal error decrypting content"));
1108 off = compute_disk_offset (GNUNET_ntohll (dc->uri->data.chk.file_length),
1112 if ( ( GNUNET_YES == prc->do_store) &&
1113 ( (dc->filename != NULL) ||
1114 (is_recursive_download (dc)) ) &&
1115 ( (dr->depth == dc->treedepth) ||
1116 (0 == (dc->options & GNUNET_FS_DOWNLOAD_NO_TEMPORARIES)) ) )
1118 fh = GNUNET_DISK_file_open (dc->filename != NULL
1120 : dc->temp_filename,
1121 GNUNET_DISK_OPEN_READWRITE |
1122 GNUNET_DISK_OPEN_CREATE,
1123 GNUNET_DISK_PERM_USER_READ |
1124 GNUNET_DISK_PERM_USER_WRITE |
1125 GNUNET_DISK_PERM_GROUP_READ |
1126 GNUNET_DISK_PERM_OTHER_READ);
1129 GNUNET_asprintf (&dc->emsg,
1130 _("Download failed: could not open file `%s': %s\n"),
1136 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1137 "Saving decrypted block to disk at offset %llu\n",
1138 (unsigned long long) off);
1141 GNUNET_DISK_file_seek (fh,
1143 GNUNET_DISK_SEEK_SET) ) )
1145 GNUNET_asprintf (&dc->emsg,
1146 _("Failed to seek to offset %llu in file `%s': %s\n"),
1147 (unsigned long long) off,
1153 GNUNET_DISK_file_write (fh,
1157 GNUNET_asprintf (&dc->emsg,
1158 _("Failed to write block of %u bytes at offset %llu in file `%s': %s\n"),
1159 (unsigned int) prc->size,
1160 (unsigned long long) off,
1165 GNUNET_break (GNUNET_OK == GNUNET_DISK_file_close (fh));
1171 /* DBLOCK, update progress and try recursion if applicable */
1173 if (dr->offset < dc->offset)
1175 /* starting offset begins in the middle of pt,
1176 do not count first bytes as progress */
1177 GNUNET_assert (app > (dc->offset - dr->offset));
1178 app -= (dc->offset - dr->offset);
1180 if (dr->offset + prc->size > dc->offset + dc->length)
1182 /* end of block is after relevant range,
1183 do not count last bytes as progress */
1184 GNUNET_assert (app > (dr->offset + prc->size) - (dc->offset + dc->length));
1185 app -= (dr->offset + prc->size) - (dc->offset + dc->length);
1187 dc->completed += app;
1189 /* do recursive download if option is set and either meta data
1190 says it is a directory or if no meta data is given AND filename
1191 ends in '.gnd' (top-level case) */
1192 if (is_recursive_download (dc))
1193 GNUNET_FS_directory_list_contents (prc->size,
1196 &trigger_recursive_download,
1200 dr->state = BRS_DOWNLOAD_DOWN;
1201 pi.status = GNUNET_FS_STATUS_DOWNLOAD_PROGRESS;
1202 pi.value.download.specifics.progress.data = pt;
1203 pi.value.download.specifics.progress.offset = dr->offset;
1204 pi.value.download.specifics.progress.data_len = prc->size;
1205 pi.value.download.specifics.progress.depth = dr->depth;
1206 GNUNET_FS_download_make_status_ (&pi, dc);
1207 GNUNET_assert (dc->completed <= dc->length);
1211 if (dc->completed == dc->length)
1213 /* download completed, signal */
1215 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1216 "Download completed, truncating file to desired length %llu\n",
1217 (unsigned long long) GNUNET_ntohll (dc->uri->data.chk.file_length));
1219 /* truncate file to size (since we store IBlocks at the end) */
1220 if (dc->filename != NULL)
1222 if (0 != truncate (dc->filename,
1223 GNUNET_ntohll (dc->uri->data.chk.file_length)))
1224 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
1228 GNUNET_assert (dr->depth == 0);
1229 check_completed (dc);
1233 /* bottom of the tree, no child downloads possible, just sync */
1234 GNUNET_FS_download_sync_ (dc);
1239 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1240 "Triggering downloads of children (this block was at depth %u and offset %llu)\n",
1242 (unsigned long long) dr->offset);
1244 GNUNET_assert (0 == (prc->size % sizeof(struct ContentHashKey)));
1245 chk = (struct ContentHashKey*) pt;
1246 for (i=(prc->size / sizeof(struct ContentHashKey))-1;i>=0;i--)
1248 drc = dr->children[i];
1253 drc->state = BRS_CHK_SET;
1254 schedule_block_download (dc, drc);
1256 case BRS_RECONSTRUCT_DOWN:
1259 case BRS_RECONSTRUCT_META_UP:
1262 case BRS_RECONSTRUCT_UP:
1268 case BRS_DOWNLOAD_DOWN:
1271 case BRS_DOWNLOAD_UP:
1282 GNUNET_FS_download_sync_ (dc);
1287 GNUNET_DISK_file_close (fh);
1288 pi.status = GNUNET_FS_STATUS_DOWNLOAD_ERROR;
1289 pi.value.download.specifics.error.message = dc->emsg;
1290 GNUNET_FS_download_make_status_ (&pi, dc);
1291 /* abort all pending requests */
1294 GNUNET_CLIENT_notify_transmit_ready_cancel (dc->th);
1297 GNUNET_CLIENT_disconnect (dc->client, GNUNET_NO);
1299 GNUNET_FS_free_download_request_ (dc->top_request);
1300 dc->top_request = NULL;
1301 GNUNET_CONTAINER_multihashmap_destroy (dc->active);
1303 dc->pending_head = NULL;
1304 dc->pending_tail = NULL;
1305 GNUNET_FS_download_sync_ (dc);
1311 * Process a download result.
1313 * @param dc our download context
1314 * @param type type of the result
1315 * @param data the (encrypted) response
1316 * @param size size of data
1319 process_result (struct GNUNET_FS_DownloadContext *dc,
1320 enum GNUNET_BLOCK_Type type,
1324 struct ProcessResultClosure prc;
1330 prc.do_store = GNUNET_YES;
1331 GNUNET_CRYPTO_hash (data, size, &prc.query);
1333 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1334 "Received result for query `%s' from `%s'-service\n",
1335 GNUNET_h2s (&prc.query),
1338 GNUNET_CONTAINER_multihashmap_get_multiple (dc->active,
1340 &process_result_with_request,
1346 * Type of a function to call when we receive a message
1349 * @param cls closure
1350 * @param msg message received, NULL on timeout or fatal error
1353 receive_results (void *cls,
1354 const struct GNUNET_MessageHeader * msg)
1356 struct GNUNET_FS_DownloadContext *dc = cls;
1357 const struct PutMessage *cm;
1360 if ( (NULL == msg) ||
1361 (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_FS_PUT) ||
1362 (sizeof (struct PutMessage) > ntohs(msg->size)) )
1364 GNUNET_break (msg == NULL);
1368 msize = ntohs(msg->size);
1369 cm = (const struct PutMessage*) msg;
1373 msize - sizeof (struct PutMessage));
1374 if (dc->client == NULL)
1375 return; /* fatal error */
1376 /* continue receiving */
1377 GNUNET_CLIENT_receive (dc->client,
1380 GNUNET_TIME_UNIT_FOREVER_REL);
1386 * We're ready to transmit a search request to the
1387 * file-sharing service. Do it. If there is
1388 * more than one request pending, try to send
1389 * multiple or request another transmission.
1391 * @param cls closure
1392 * @param size number of bytes available in buf
1393 * @param buf where the callee should write the message
1394 * @return number of bytes written to buf
1397 transmit_download_request (void *cls,
1401 struct GNUNET_FS_DownloadContext *dc = cls;
1403 struct SearchMessage *sm;
1404 struct DownloadRequest *dr;
1410 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1411 "Transmitting download request failed, trying to reconnect\n");
1416 GNUNET_assert (size >= sizeof (struct SearchMessage));
1419 while ( (NULL != (dr = dc->pending_head)) &&
1420 (size >= msize + sizeof (struct SearchMessage)) )
1423 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1424 "Transmitting download request for `%s' to `%s'-service\n",
1425 GNUNET_h2s (&dr->chk.query),
1428 memset (sm, 0, sizeof (struct SearchMessage));
1429 sm->header.size = htons (sizeof (struct SearchMessage));
1430 sm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_START_SEARCH);
1431 if (0 != (dc->options & GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY))
1432 sm->options = htonl (1);
1434 sm->options = htonl (0);
1436 sm->type = htonl (GNUNET_BLOCK_TYPE_FS_DBLOCK);
1438 sm->type = htonl (GNUNET_BLOCK_TYPE_FS_IBLOCK);
1439 sm->anonymity_level = htonl (dc->anonymity);
1440 sm->target = dc->target.hashPubKey;
1441 sm->query = dr->chk.query;
1442 GNUNET_CONTAINER_DLL_remove (dc->pending_head,
1445 dr->is_pending = GNUNET_NO;
1446 msize += sizeof (struct SearchMessage);
1449 if (dc->pending_head != NULL)
1451 dc->th = GNUNET_CLIENT_notify_transmit_ready (dc->client,
1452 sizeof (struct SearchMessage),
1453 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1455 &transmit_download_request,
1457 GNUNET_assert (dc->th != NULL);
1464 * Reconnect to the FS service and transmit our queries NOW.
1466 * @param cls our download context
1470 do_reconnect (void *cls,
1471 const struct GNUNET_SCHEDULER_TaskContext *tc)
1473 struct GNUNET_FS_DownloadContext *dc = cls;
1474 struct GNUNET_CLIENT_Connection *client;
1476 dc->task = GNUNET_SCHEDULER_NO_TASK;
1477 client = GNUNET_CLIENT_connect ("fs",
1481 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1482 "Connecting to `%s'-service failed, will try again.\n",
1487 dc->client = client;
1488 if (dc->pending_head != NULL)
1490 dc->th = GNUNET_CLIENT_notify_transmit_ready (client,
1491 sizeof (struct SearchMessage),
1492 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1494 &transmit_download_request,
1496 GNUNET_assert (dc->th != NULL);
1498 GNUNET_CLIENT_receive (client,
1501 GNUNET_TIME_UNIT_FOREVER_REL);
1506 * Add entries to the pending list.
1508 * @param cls our download context
1510 * @param entry entry of type "struct DownloadRequest"
1514 retry_entry (void *cls,
1515 const GNUNET_HashCode *key,
1518 struct GNUNET_FS_DownloadContext *dc = cls;
1519 struct DownloadRequest *dr = entry;
1523 GNUNET_CONTAINER_DLL_insert (dc->pending_head,
1526 dr->is_pending = GNUNET_YES;
1532 * We've lost our connection with the FS service.
1533 * Re-establish it and re-transmit all of our
1536 * @param dc download context that is having trouble
1539 try_reconnect (struct GNUNET_FS_DownloadContext *dc)
1542 if (NULL != dc->client)
1545 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1546 "Moving all requests back to pending list\n");
1550 GNUNET_CLIENT_notify_transmit_ready_cancel (dc->th);
1553 /* full reset of the pending list */
1554 dc->pending_head = NULL;
1555 dc->pending_tail = NULL;
1556 GNUNET_CONTAINER_multihashmap_iterate (dc->active,
1559 GNUNET_CLIENT_disconnect (dc->client, GNUNET_NO);
1563 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1564 "Will try to reconnect in 1s\n");
1567 = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
1574 * We're allowed to ask the FS service for our blocks. Start the download.
1576 * @param cls the 'struct GNUNET_FS_DownloadContext'
1577 * @param client handle to use for communcation with FS (we must destroy it!)
1580 activate_fs_download (void *cls,
1581 struct GNUNET_CLIENT_Connection *client)
1583 struct GNUNET_FS_DownloadContext *dc = cls;
1584 struct GNUNET_FS_ProgressInfo pi;
1587 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1588 "Download activated\n");
1590 GNUNET_assert (NULL != client);
1591 GNUNET_assert (dc->client == NULL);
1592 GNUNET_assert (dc->th == NULL);
1593 dc->client = client;
1594 GNUNET_CLIENT_receive (client,
1597 GNUNET_TIME_UNIT_FOREVER_REL);
1598 pi.status = GNUNET_FS_STATUS_DOWNLOAD_ACTIVE;
1599 GNUNET_FS_download_make_status_ (&pi, dc);
1600 GNUNET_assert (dc->pending_head == NULL);
1601 GNUNET_assert (dc->pending_tail == NULL);
1602 GNUNET_CONTAINER_multihashmap_iterate (dc->active,
1606 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1607 "Asking for transmission to FS service\n");
1609 if (dc->pending_head != NULL)
1611 dc->th = GNUNET_CLIENT_notify_transmit_ready (dc->client,
1612 sizeof (struct SearchMessage),
1613 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1615 &transmit_download_request,
1617 GNUNET_assert (dc->th != NULL);
1623 * We must stop to ask the FS service for our blocks. Pause the download.
1625 * @param cls the 'struct GNUNET_FS_DownloadContext'
1628 deactivate_fs_download (void *cls)
1630 struct GNUNET_FS_DownloadContext *dc = cls;
1631 struct GNUNET_FS_ProgressInfo pi;
1634 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1635 "Download deactivated\n");
1639 GNUNET_CLIENT_notify_transmit_ready_cancel (dc->th);
1642 if (NULL != dc->client)
1644 GNUNET_CLIENT_disconnect (dc->client, GNUNET_NO);
1647 dc->pending_head = NULL;
1648 dc->pending_tail = NULL;
1649 pi.status = GNUNET_FS_STATUS_DOWNLOAD_INACTIVE;
1650 GNUNET_FS_download_make_status_ (&pi, dc);
1655 * (recursively) Create a download request structure.
1657 * @param parent parent of the current entry
1658 * @param depth depth of the current entry, 0 are the DBLOCKs,
1659 * top level block is 'dc->treedepth - 1'
1660 * @param dr_offset offset in the original file this block maps to
1661 * (as in, offset of the first byte of the first DBLOCK
1662 * in the subtree rooted in the returned download request tree)
1663 * @param file_start_offset desired starting offset for the download
1664 * in the original file; requesting tree should not contain
1665 * DBLOCKs prior to the file_start_offset
1666 * @param desired_length desired number of bytes the user wanted to access
1667 * (from file_start_offset). Resulting tree should not contain
1668 * DBLOCKs after file_start_offset + file_length.
1669 * @return download request tree for the given range of DBLOCKs at
1670 * the specified depth
1672 static struct DownloadRequest *
1673 create_download_request (struct DownloadRequest *parent,
1676 uint64_t file_start_offset,
1677 uint64_t desired_length)
1679 struct DownloadRequest *dr;
1681 unsigned int head_skip;
1682 uint64_t child_block_size;
1684 dr = GNUNET_malloc (sizeof (struct DownloadRequest));
1685 dr->parent = parent;
1687 dr->offset = dr_offset;
1690 child_block_size = GNUNET_FS_tree_compute_tree_size (depth - 1);
1692 /* calculate how many blocks at this level are not interesting
1693 from the start (rounded down), either because of the requested
1694 file offset or because this IBlock is further along */
1695 if (dr_offset < file_start_offset)
1696 head_skip = file_start_offset / child_block_size;
1698 head_skip = dr_offset / child_block_size;
1700 /* calculate index of last block at this level that is interesting (rounded up) */
1701 dr->num_children = file_start_offset + desired_length / child_block_size;
1702 if (dr->num_children * child_block_size < file_start_offset + desired_length)
1703 dr->num_children++; /* round up */
1705 /* now we can get the total number of children for this block */
1706 dr->num_children -= head_skip;
1707 if (dr->num_children > CHK_PER_INODE)
1708 dr->num_children = CHK_PER_INODE; /* cap at max */
1710 /* why else would we have gotten here to begin with? (that'd be a bad logic error) */
1711 GNUNET_assert (dr->num_children > 0);
1713 dr->children = GNUNET_malloc (dr->num_children *
1714 sizeof (struct DownloadRequest *));
1715 for (i=0;i<dr->num_children;i++)
1716 dr->children[i] = create_download_request (dr,
1718 dr_offset + i * child_block_size,
1727 * Continuation after a possible attempt to reconstruct
1728 * the current IBlock from the existing file.
1730 * @param cls the 'struct ReconstructContext'
1731 * @param tc scheduler context
1734 reconstruct_cont (void *cls,
1735 const struct GNUNET_SCHEDULER_TaskContext *tc)
1737 struct GNUNET_FS_DownloadContext *dc = cls;
1739 /* clean up state from tree encoder */
1742 GNUNET_FS_tree_encoder_finish (dc->te, NULL, NULL);
1745 if (dc->task != GNUNET_SCHEDULER_NO_TASK)
1747 GNUNET_SCHEDULER_cancel (dc->task);
1748 dc->task = GNUNET_SCHEDULER_NO_TASK;
1750 if (dc->rfh != NULL)
1752 GNUNET_break (GNUNET_OK == GNUNET_DISK_file_close (dc->rfh));
1755 /* start "normal" download */
1756 schedule_block_download (dc,
1762 * Task requesting the next block from the tree encoder.
1764 * @param cls the 'struct GNUJNET_FS_DownloadContext' we're processing
1765 * @param tc task context
1768 get_next_block (void *cls,
1769 const struct GNUNET_SCHEDULER_TaskContext *tc)
1771 struct GNUNET_FS_DownloadContext *dc = cls;
1773 dc->task = GNUNET_SCHEDULER_NO_TASK;
1774 GNUNET_FS_tree_encoder_next (dc->te);
1780 * Function called asking for the current (encoded)
1781 * block to be processed. After processing the
1782 * client should either call "GNUNET_FS_tree_encode_next"
1783 * or (on error) "GNUNET_FS_tree_encode_finish".
1785 * This function checks if the content on disk matches
1786 * the expected content based on the URI.
1788 * @param cls closure
1789 * @param chk content hash key for the block
1790 * @param offset offset of the block
1791 * @param depth depth of the block, 0 for DBLOCK
1792 * @param type type of the block (IBLOCK or DBLOCK)
1793 * @param block the (encrypted) block
1794 * @param block_size size of block (in bytes)
1797 reconstruct_cb (void *cls,
1798 const struct ContentHashKey *chk,
1801 enum GNUNET_BLOCK_Type type,
1803 uint16_t block_size)
1805 struct GNUNET_FS_DownloadContext *dc = cls;
1806 struct GNUNET_FS_ProgressInfo pi;
1807 struct DownloadRequest *dr;
1811 /* find corresponding request entry */
1812 dr = dc->top_request;
1813 while (dr->depth > depth)
1815 blen = GNUNET_FS_tree_compute_tree_size (dr->depth);
1816 chld = (offset - dr->offset) / blen;
1817 GNUNET_assert (chld < dr->num_children);
1818 dr = dr->children[chld];
1824 case BRS_RECONSTRUCT_DOWN:
1826 case BRS_RECONSTRUCT_META_UP:
1828 case BRS_RECONSTRUCT_UP:
1831 if (0 == memcmp (chk,
1833 sizeof (struct ContentHashKey)))
1835 /* block matches, hence tree below matches;
1836 this request is done! */
1837 dr->state = BRS_DOWNLOAD_UP;
1838 /* calculate how many bytes of payload this block
1840 blen = GNUNET_FS_tree_compute_tree_size (dr->depth);
1841 /* how many of those bytes are in the requested range? */
1842 blen = GNUNET_MIN (blen,
1843 dc->length + dc->offset - dr->offset);
1844 /* signal progress */
1845 dc->completed += blen;
1846 pi.status = GNUNET_FS_STATUS_DOWNLOAD_PROGRESS;
1847 pi.value.download.specifics.progress.data = NULL;
1848 pi.value.download.specifics.progress.offset = offset;
1849 pi.value.download.specifics.progress.data_len = 0;
1850 pi.value.download.specifics.progress.depth = 0;
1851 GNUNET_FS_download_make_status_ (&pi, dc);
1857 case BRS_DOWNLOAD_DOWN:
1859 case BRS_DOWNLOAD_UP:
1867 if ( (dr == dc->top_request) &&
1868 (dr->state == BRS_DOWNLOAD_UP) )
1870 check_completed (dc);
1873 dc->task = GNUNET_SCHEDULER_add_now (&get_next_block,
1879 * Function called by the tree encoder to obtain a block of plaintext
1880 * data (for the lowest level of the tree).
1882 * @param cls our 'struct ReconstructContext'
1883 * @param offset identifies which block to get
1884 * @param max (maximum) number of bytes to get; returning
1885 * fewer will also cause errors
1886 * @param buf where to copy the plaintext buffer
1887 * @param emsg location to store an error message (on error)
1888 * @return number of bytes copied to buf, 0 on error
1891 fh_reader (void *cls,
1897 struct GNUNET_FS_DownloadContext *dc = cls;
1898 struct GNUNET_DISK_FileHandle *fh = dc->rfh;
1903 GNUNET_DISK_file_seek (fh,
1905 GNUNET_DISK_SEEK_SET))
1907 *emsg = GNUNET_strdup (strerror (errno));
1910 ret = GNUNET_DISK_file_read (fh, buf, max);
1913 *emsg = GNUNET_strdup (strerror (errno));
1921 * Task that creates the initial (top-level) download
1922 * request for the file.
1924 * @param cls the 'struct GNUNET_FS_DownloadContext'
1925 * @param tc scheduler context
1928 GNUNET_FS_download_start_task_ (void *cls,
1929 const struct GNUNET_SCHEDULER_TaskContext *tc)
1931 struct GNUNET_FS_DownloadContext *dc = cls;
1932 struct GNUNET_FS_ProgressInfo pi;
1933 struct GNUNET_DISK_FileHandle *fh;
1936 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1937 "Start task running...\n");
1939 dc->task = GNUNET_SCHEDULER_NO_TASK;
1940 if (dc->length == 0)
1942 /* no bytes required! */
1943 if (dc->filename != NULL)
1945 fh = GNUNET_DISK_file_open (dc->filename,
1946 GNUNET_DISK_OPEN_READWRITE |
1947 GNUNET_DISK_OPEN_CREATE |
1948 ( (0 == GNUNET_FS_uri_chk_get_file_size (dc->uri))
1949 ? GNUNET_DISK_OPEN_TRUNCATE : 0),
1950 GNUNET_DISK_PERM_USER_READ |
1951 GNUNET_DISK_PERM_USER_WRITE |
1952 GNUNET_DISK_PERM_GROUP_READ |
1953 GNUNET_DISK_PERM_OTHER_READ);
1954 GNUNET_DISK_file_close (fh);
1956 GNUNET_FS_download_sync_ (dc);
1957 check_completed (dc);
1960 if (dc->emsg != NULL)
1962 if (dc->top_request == NULL)
1964 dc->top_request = create_download_request (NULL, dc->treedepth - 1, 0,
1965 dc->offset, dc->length);
1966 dc->top_request->state = BRS_CHK_SET;
1967 dc->top_request->chk = (dc->uri->type == chk)
1968 ? dc->uri->data.chk.chk
1969 : dc->uri->data.loc.fi.chk;
1971 GNUNET_FS_download_sync_ (dc);
1972 pi.status = GNUNET_FS_STATUS_DOWNLOAD_START;
1973 pi.value.download.specifics.start.meta = dc->meta;
1974 GNUNET_FS_download_make_status_ (&pi, dc);
1976 GNUNET_FS_download_start_downloading_ (dc);
1977 /* attempt reconstruction from disk */
1978 if (GNUNET_YES == GNUNET_DISK_file_test (dc->filename))
1979 dc->rfh = GNUNET_DISK_file_open (dc->filename,
1980 GNUNET_DISK_OPEN_READ,
1981 GNUNET_DISK_PERM_NONE);
1982 if (dc->top_request->state == BRS_CHK_SET)
1984 if (dc->rfh != NULL)
1986 /* first, try top-down */
1988 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1989 "Trying top-down reconstruction for `%s'\n",
1992 try_top_down_reconstruction (dc, dc->top_request);
1993 switch (dc->top_request->state)
1997 case BRS_DOWNLOAD_DOWN:
1998 break; /* normal, some blocks already down */
1999 case BRS_DOWNLOAD_UP:
2000 /* already done entirely, party! */
2001 if (dc->rfh != NULL)
2003 /* avoid hanging on to file handle longer than
2005 GNUNET_DISK_file_close (dc->rfh);
2010 GNUNET_asprintf (&dc->emsg,
2012 GNUNET_FS_download_sync_ (dc);
2013 pi.status = GNUNET_FS_STATUS_DOWNLOAD_ERROR;
2014 pi.value.download.specifics.error.message = dc->emsg;
2015 GNUNET_FS_download_make_status_ (&pi, dc);
2023 /* attempt reconstruction from meta data */
2024 if ( (GNUNET_FS_uri_chk_get_file_size (dc->uri) <= MAX_INLINE_SIZE) &&
2025 (NULL != dc->meta) )
2028 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2029 "Trying to find embedded meta data for download of size %llu with %u bytes MD\n",
2030 (unsigned long long) GNUNET_FS_uri_chk_get_file_size (dc->uri),
2031 (unsigned int) GNUNET_CONTAINER_meta_data_get_serialized_size (dc->meta));
2033 GNUNET_CONTAINER_meta_data_iterate (dc->meta,
2036 if (dc->top_request->state == BRS_DOWNLOAD_UP)
2038 if (dc->rfh != NULL)
2040 /* avoid hanging on to file handle longer than
2042 GNUNET_DISK_file_close (dc->rfh);
2045 return; /* finished, status update was already done for us */
2048 if (dc->rfh != NULL)
2050 /* finally, try bottom-up */
2052 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2053 "Trying bottom-up reconstruction of file `%s'\n",
2056 dc->te = GNUNET_FS_tree_encoder_create (dc->h,
2063 dc->task = GNUNET_SCHEDULER_add_now (&get_next_block,
2068 /* simple, top-level download */
2069 schedule_block_download (dc,
2072 if (dc->top_request->state == BRS_DOWNLOAD_UP)
2073 check_completed (dc);
2078 * Create SUSPEND event for the given download operation
2079 * and then clean up our state (without stop signal).
2081 * @param cls the 'struct GNUNET_FS_DownloadContext' to signal for
2084 GNUNET_FS_download_signal_suspend_ (void *cls)
2086 struct GNUNET_FS_DownloadContext *dc = cls;
2087 struct GNUNET_FS_ProgressInfo pi;
2089 if (dc->top != NULL)
2090 GNUNET_FS_end_top (dc->h, dc->top);
2091 while (NULL != dc->child_head)
2092 GNUNET_FS_download_signal_suspend_ (dc->child_head);
2093 if (dc->search != NULL)
2095 dc->search->download = NULL;
2098 if (dc->job_queue != NULL)
2100 GNUNET_FS_dequeue_ (dc->job_queue);
2101 dc->job_queue = NULL;
2103 if (dc->parent != NULL)
2104 GNUNET_CONTAINER_DLL_remove (dc->parent->child_head,
2105 dc->parent->child_tail,
2107 if (dc->task != GNUNET_SCHEDULER_NO_TASK)
2109 GNUNET_SCHEDULER_cancel (dc->task);
2110 dc->task = GNUNET_SCHEDULER_NO_TASK;
2112 pi.status = GNUNET_FS_STATUS_DOWNLOAD_SUSPEND;
2113 GNUNET_FS_download_make_status_ (&pi, dc);
2116 GNUNET_FS_tree_encoder_finish (dc->te, NULL, NULL);
2119 if (dc->rfh != NULL)
2121 GNUNET_DISK_file_close (dc->rfh);
2124 GNUNET_FS_free_download_request_ (dc->top_request);
2125 if (dc->active != NULL)
2127 GNUNET_CONTAINER_multihashmap_destroy (dc->active);
2130 GNUNET_free_non_null (dc->filename);
2131 GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2132 GNUNET_FS_uri_destroy (dc->uri);
2133 GNUNET_free_non_null (dc->temp_filename);
2134 GNUNET_free_non_null (dc->serialization);
2140 * Download parts of a file. Note that this will store
2141 * the blocks at the respective offset in the given file. Also, the
2142 * download is still using the blocking of the underlying FS
2143 * encoding. As a result, the download may *write* outside of the
2144 * given boundaries (if offset and length do not match the 32k FS
2145 * block boundaries). <p>
2147 * This function should be used to focus a download towards a
2148 * particular portion of the file (optimization), not to strictly
2149 * limit the download to exactly those bytes.
2151 * @param h handle to the file sharing subsystem
2152 * @param uri the URI of the file (determines what to download); CHK or LOC URI
2153 * @param meta known metadata for the file (can be NULL)
2154 * @param filename where to store the file, maybe NULL (then no file is
2155 * created on disk and data must be grabbed from the callbacks)
2156 * @param tempname where to store temporary file data, not used if filename is non-NULL;
2157 * can be NULL (in which case we will pick a name if needed); the temporary file
2158 * may already exist, in which case we will try to use the data that is there and
2159 * if it is not what is desired, will overwrite it
2160 * @param offset at what offset should we start the download (typically 0)
2161 * @param length how many bytes should be downloaded starting at offset
2162 * @param anonymity anonymity level to use for the download
2163 * @param options various options
2164 * @param cctx initial value for the client context for this download
2165 * @param parent parent download to associate this download with (use NULL
2166 * for top-level downloads; useful for manually-triggered recursive downloads)
2167 * @return context that can be used to control this download
2169 struct GNUNET_FS_DownloadContext *
2170 GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
2171 const struct GNUNET_FS_Uri *uri,
2172 const struct GNUNET_CONTAINER_MetaData *meta,
2173 const char *filename,
2174 const char *tempname,
2178 enum GNUNET_FS_DownloadOptions options,
2180 struct GNUNET_FS_DownloadContext *parent)
2182 struct GNUNET_FS_DownloadContext *dc;
2184 GNUNET_assert (GNUNET_FS_uri_test_chk (uri) ||
2185 GNUNET_FS_uri_test_loc (uri) );
2187 if ( (offset + length < offset) ||
2188 (offset + length > GNUNET_FS_uri_chk_get_file_size (uri)) )
2194 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2195 "Starting download `%s' of %llu bytes\n",
2197 (unsigned long long) length);
2199 dc = GNUNET_malloc (sizeof(struct GNUNET_FS_DownloadContext));
2201 dc->parent = parent;
2204 GNUNET_CONTAINER_DLL_insert (parent->child_head,
2208 dc->uri = GNUNET_FS_uri_dup (uri);
2209 dc->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
2210 dc->client_info = cctx;
2211 dc->start_time = GNUNET_TIME_absolute_get ();
2212 if (NULL != filename)
2214 dc->filename = GNUNET_strdup (filename);
2215 if (GNUNET_YES == GNUNET_DISK_file_test (filename))
2216 GNUNET_DISK_file_size (filename,
2220 if (GNUNET_FS_uri_test_loc (dc->uri))
2221 GNUNET_assert (GNUNET_OK ==
2222 GNUNET_FS_uri_loc_get_peer_identity (dc->uri,
2224 dc->offset = offset;
2225 dc->length = length;
2226 dc->anonymity = anonymity;
2227 dc->options = options;
2228 dc->active = GNUNET_CONTAINER_multihashmap_create (1 + 2 * (length / DBLOCK_SIZE));
2229 dc->treedepth = GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size(dc->uri));
2230 if ( (filename == NULL) &&
2231 (is_recursive_download (dc) ) )
2233 if (tempname != NULL)
2234 dc->temp_filename = GNUNET_strdup (tempname);
2236 dc->temp_filename = GNUNET_DISK_mktemp ("gnunet-directory-download-tmp");
2240 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2241 "Download tree has depth %u\n",
2246 dc->top = GNUNET_FS_make_top (dc->h,
2247 &GNUNET_FS_download_signal_suspend_,
2250 dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_,
2257 * Download parts of a file based on a search result. The download
2258 * will be associated with the search result (and the association
2259 * will be preserved when serializing/deserializing the state).
2260 * If the search is stopped, the download will not be aborted but
2261 * be 'promoted' to a stand-alone download.
2263 * As with the other download function, this will store
2264 * the blocks at the respective offset in the given file. Also, the
2265 * download is still using the blocking of the underlying FS
2266 * encoding. As a result, the download may *write* outside of the
2267 * given boundaries (if offset and length do not match the 32k FS
2268 * block boundaries). <p>
2270 * The given range can be used to focus a download towards a
2271 * particular portion of the file (optimization), not to strictly
2272 * limit the download to exactly those bytes.
2274 * @param h handle to the file sharing subsystem
2275 * @param sr the search result to use for the download (determines uri and
2276 * meta data and associations)
2277 * @param filename where to store the file, maybe NULL (then no file is
2278 * created on disk and data must be grabbed from the callbacks)
2279 * @param tempname where to store temporary file data, not used if filename is non-NULL;
2280 * can be NULL (in which case we will pick a name if needed); the temporary file
2281 * may already exist, in which case we will try to use the data that is there and
2282 * if it is not what is desired, will overwrite it
2283 * @param offset at what offset should we start the download (typically 0)
2284 * @param length how many bytes should be downloaded starting at offset
2285 * @param anonymity anonymity level to use for the download
2286 * @param options various download options
2287 * @param cctx initial value for the client context for this download
2288 * @return context that can be used to control this download
2290 struct GNUNET_FS_DownloadContext *
2291 GNUNET_FS_download_start_from_search (struct GNUNET_FS_Handle *h,
2292 struct GNUNET_FS_SearchResult *sr,
2293 const char *filename,
2294 const char *tempname,
2298 enum GNUNET_FS_DownloadOptions options,
2301 struct GNUNET_FS_DownloadContext *dc;
2303 if ( (sr == NULL) ||
2304 (sr->download != NULL) )
2309 GNUNET_assert (GNUNET_FS_uri_test_chk (sr->uri) ||
2310 GNUNET_FS_uri_test_loc (sr->uri) );
2311 if ( (offset + length < offset) ||
2312 (offset + length > sr->uri->data.chk.file_length) )
2318 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2319 "Starting download `%s' of %llu bytes\n",
2321 (unsigned long long) length);
2323 dc = GNUNET_malloc (sizeof(struct GNUNET_FS_DownloadContext));
2327 if (sr->probe_ctx != NULL)
2329 GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
2330 sr->probe_ctx = NULL;
2332 dc->uri = GNUNET_FS_uri_dup (sr->uri);
2333 dc->meta = GNUNET_CONTAINER_meta_data_duplicate (sr->meta);
2334 dc->client_info = cctx;
2335 dc->start_time = GNUNET_TIME_absolute_get ();
2336 if (NULL != filename)
2338 dc->filename = GNUNET_strdup (filename);
2339 if (GNUNET_YES == GNUNET_DISK_file_test (filename))
2340 GNUNET_DISK_file_size (filename,
2344 if (GNUNET_FS_uri_test_loc (dc->uri))
2345 GNUNET_assert (GNUNET_OK ==
2346 GNUNET_FS_uri_loc_get_peer_identity (dc->uri,
2348 dc->offset = offset;
2349 dc->length = length;
2350 dc->anonymity = anonymity;
2351 dc->options = options;
2352 dc->active = GNUNET_CONTAINER_multihashmap_create (1 + 2 * (length / DBLOCK_SIZE));
2353 dc->treedepth = GNUNET_FS_compute_depth (GNUNET_ntohll(dc->uri->data.chk.file_length));
2354 if ( (filename == NULL) &&
2355 (is_recursive_download (dc) ) )
2357 if (tempname != NULL)
2358 dc->temp_filename = GNUNET_strdup (tempname);
2360 dc->temp_filename = GNUNET_DISK_mktemp ("gnunet-directory-download-tmp");
2364 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2365 "Download tree has depth %u\n",
2368 dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_,
2375 * Start the downloading process (by entering the queue).
2377 * @param dc our download context
2380 GNUNET_FS_download_start_downloading_ (struct GNUNET_FS_DownloadContext *dc)
2382 if (dc->completed == dc->length)
2384 GNUNET_assert (dc->job_queue == NULL);
2385 dc->job_queue = GNUNET_FS_queue_ (dc->h,
2386 &activate_fs_download,
2387 &deactivate_fs_download,
2389 (dc->length + DBLOCK_SIZE-1) / DBLOCK_SIZE);
2394 * Stop a download (aborts if download is incomplete).
2396 * @param dc handle for the download
2397 * @param do_delete delete files of incomplete downloads
2400 GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc,
2403 struct GNUNET_FS_ProgressInfo pi;
2406 if (dc->top != NULL)
2407 GNUNET_FS_end_top (dc->h, dc->top);
2410 if (dc->task != GNUNET_SCHEDULER_NO_TASK)
2412 GNUNET_SCHEDULER_cancel (dc->task);
2413 dc->task = GNUNET_SCHEDULER_NO_TASK;
2415 if (dc->search != NULL)
2417 dc->search->download = NULL;
2420 if (dc->job_queue != NULL)
2422 GNUNET_FS_dequeue_ (dc->job_queue);
2423 dc->job_queue = NULL;
2427 GNUNET_FS_tree_encoder_finish (dc->te, NULL, NULL);
2430 have_children = (NULL != dc->child_head) ? GNUNET_YES : GNUNET_NO;
2431 while (NULL != dc->child_head)
2432 GNUNET_FS_download_stop (dc->child_head,
2434 if (dc->parent != NULL)
2435 GNUNET_CONTAINER_DLL_remove (dc->parent->child_head,
2436 dc->parent->child_tail,
2438 if (dc->serialization != NULL)
2439 GNUNET_FS_remove_sync_file_ (dc->h,
2440 ( (dc->parent != NULL) || (dc->search != NULL) )
2441 ? GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD
2442 : GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD ,
2444 if ( (GNUNET_YES == have_children) &&
2445 (dc->parent == NULL) )
2446 GNUNET_FS_remove_sync_dir_ (dc->h,
2447 (dc->search != NULL)
2448 ? GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD
2449 : GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
2451 pi.status = GNUNET_FS_STATUS_DOWNLOAD_STOPPED;
2452 GNUNET_FS_download_make_status_ (&pi, dc);
2453 GNUNET_FS_free_download_request_ (dc->top_request);
2454 dc->top_request = NULL;
2455 if (dc->active != NULL)
2457 GNUNET_CONTAINER_multihashmap_destroy (dc->active);
2460 if (dc->filename != NULL)
2462 if ( (dc->completed != dc->length) &&
2463 (GNUNET_YES == do_delete) )
2465 if (0 != UNLINK (dc->filename))
2466 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
2470 GNUNET_free (dc->filename);
2472 GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2473 GNUNET_FS_uri_destroy (dc->uri);
2474 if (NULL != dc->temp_filename)
2476 if (0 != UNLINK (dc->temp_filename))
2477 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
2480 GNUNET_free (dc->temp_filename);
2482 GNUNET_free_non_null (dc->serialization);
2486 /* end of fs_download.c */