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