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