fix more leaks
[oweals/gnunet.git] / src / fs / fs_api.c
1 /*
2      This file is part of GNUnet.
3      (C) 2001--2012 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 3, 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 /**
22  * @file fs/fs_api.c
23  * @brief main FS functions (master initialization, serialization, deserialization, shared code)
24  * @author Christian Grothoff
25  */
26
27 #include "platform.h"
28 #include "gnunet_util_lib.h"
29 #include "gnunet_fs_service.h"
30 #include "fs_api.h"
31 #include "fs_tree.h"
32
33 /**
34  * How many block requests can we have outstanding in parallel at a time by default?
35  */
36 #define DEFAULT_MAX_PARALLEL_REQUESTS (1024 * 10)
37
38 /**
39  * How many downloads can we have outstanding in parallel at a time by default?
40  */
41 #define DEFAULT_MAX_PARALLEL_DOWNLOADS 16
42
43 /**
44  * Start the given job (send signal, remove from pending queue, update
45  * counters and state).
46  *
47  * @param qe job to start
48  */
49 static void
50 start_job (struct GNUNET_FS_QueueEntry *qe)
51 {
52   GNUNET_assert (NULL == qe->client);
53   qe->client = GNUNET_CLIENT_connect ("fs", qe->h->cfg);
54   if (NULL == qe->client)
55   {
56     GNUNET_break (0);
57     return;
58   }
59   qe->start (qe->cls, qe->client);
60   qe->start_times++;
61   qe->h->active_blocks += qe->blocks;
62   qe->h->active_downloads++;
63   qe->start_time = GNUNET_TIME_absolute_get ();
64   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
65               "Starting job %p (%u active)\n",
66               qe,
67               qe->h->active_downloads);
68   GNUNET_CONTAINER_DLL_remove (qe->h->pending_head, qe->h->pending_tail, qe);
69   GNUNET_CONTAINER_DLL_insert_after (qe->h->running_head, qe->h->running_tail,
70                                      qe->h->running_tail, qe);
71 }
72
73
74 /**
75  * Stop the given job (send signal, remove from active queue, update
76  * counters and state).
77  *
78  * @param qe job to stop
79  */
80 static void
81 stop_job (struct GNUNET_FS_QueueEntry *qe)
82 {
83   qe->client = NULL;
84   qe->stop (qe->cls);
85   GNUNET_assert (0 < qe->h->active_downloads);
86   qe->h->active_downloads--;
87   qe->h->active_blocks -= qe->blocks;
88   qe->run_time =
89       GNUNET_TIME_relative_add (qe->run_time,
90                                 GNUNET_TIME_absolute_get_duration
91                                 (qe->start_time));
92   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
93               "Stopping job %p (%u active)\n",
94               qe,
95               qe->h->active_downloads);
96   GNUNET_CONTAINER_DLL_remove (qe->h->running_head, qe->h->running_tail, qe);
97   GNUNET_CONTAINER_DLL_insert_after (qe->h->pending_head, qe->h->pending_tail,
98                                      qe->h->pending_tail, qe);
99 }
100
101
102 /**
103  * Process the jobs in the job queue, possibly starting some
104  * and stopping others.
105  *
106  * @param cls the 'struct GNUNET_FS_Handle'
107  * @param tc scheduler context
108  */
109 static void
110 process_job_queue (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
111 {
112   struct GNUNET_FS_Handle *h = cls;
113   struct GNUNET_FS_QueueEntry *qe;
114   struct GNUNET_FS_QueueEntry *next;
115   struct GNUNET_TIME_Relative run_time;
116   struct GNUNET_TIME_Relative restart_at;
117   struct GNUNET_TIME_Relative rst;
118   struct GNUNET_TIME_Absolute end_time;
119   unsigned int num_downloads_waiting;
120   unsigned int num_downloads_active;
121   unsigned int num_downloads_expired;
122   unsigned int num_probes_active;
123   unsigned int num_probes_waiting;
124   unsigned int num_probes_expired;
125   int num_probes_change;
126   int num_downloads_change;
127   int block_limit_hit;
128
129   h->queue_job = GNUNET_SCHEDULER_NO_TASK;
130   /* restart_at will be set to the time when it makes sense to
131      re-evaluate the job queue (unless, of course, jobs complete
132      or are added, then we'll be triggered immediately */
133   restart_at = GNUNET_TIME_UNIT_FOREVER_REL;
134   /* first, calculate some basic statistics on pending jobs */
135   num_probes_waiting = 0;
136   num_downloads_waiting = 0;
137   for (qe = h->pending_head; NULL != qe; qe = qe->next)
138   {
139     switch (qe->priority)
140     {
141     case GNUNET_FS_QUEUE_PRIORITY_PROBE:
142       num_probes_waiting++;
143       break;
144     case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
145       num_downloads_waiting++;
146       break;
147     default:
148       GNUNET_break (0);
149       break;
150     }
151   }
152   /* now, calculate some basic statistics on running jobs */
153   num_probes_active = 0;
154   num_probes_expired = 0;
155   num_downloads_active = 0;
156   num_downloads_expired = 0;
157   next = h->running_head;
158   while (NULL != (qe = next))
159   {
160     next = qe->next;
161     switch (qe->priority)
162     {
163     case GNUNET_FS_QUEUE_PRIORITY_PROBE:
164       run_time = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2);
165       end_time = GNUNET_TIME_absolute_add (qe->start_time, run_time);
166       rst = GNUNET_TIME_absolute_get_remaining (end_time);
167       if (0 == rst.rel_value_us)
168       {
169         num_probes_expired++;
170         stop_job (qe);
171       }
172       else
173       {
174         num_probes_active++;
175         restart_at = GNUNET_TIME_relative_min (rst, restart_at);
176       }
177       break;
178     case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
179       run_time =
180         GNUNET_TIME_relative_multiply (h->avg_block_latency,
181                                        qe->blocks * qe->start_times);
182       end_time = GNUNET_TIME_absolute_add (qe->start_time, run_time);
183       rst = GNUNET_TIME_absolute_get_remaining (end_time);
184       if (0 == rst.rel_value_us)
185       {
186         num_downloads_expired++;
187         stop_job (qe);
188       }
189       else
190       {
191         num_downloads_active++;
192         restart_at = GNUNET_TIME_relative_min (rst, restart_at);
193       }
194       break;
195     default:
196       GNUNET_break (0);
197       break;
198     }
199   }
200   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
201               "PA: %u, PE: %u, PW: %u; DA: %u, DE: %u, DW: %u\n",
202               num_probes_active,
203               num_probes_expired,
204               num_probes_waiting,
205               num_downloads_active,
206               num_downloads_expired,
207               num_downloads_waiting);
208   /* calculate start/stop decisions */
209   if (h->active_downloads + num_downloads_waiting > h->max_parallel_requests)
210   {
211     /* stop probes if possible */
212     num_probes_change = - num_probes_active;
213     num_downloads_change = h->max_parallel_requests - h->active_downloads;
214   }
215   else
216   {
217     /* start all downloads */
218     num_downloads_change = num_downloads_waiting;
219     /* start as many probes as we can */
220     num_probes_change = GNUNET_MIN (num_probes_waiting,
221                                     h->max_parallel_requests - (h->active_downloads + num_downloads_waiting));
222   }
223
224   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
225               "Changing %d probes and %d downloads\n",
226               num_probes_change,
227               num_downloads_change);
228   /* actually stop probes */
229   next = h->running_head;
230   while (NULL != (qe = next))
231   {
232     next = qe->next;
233     if (GNUNET_FS_QUEUE_PRIORITY_PROBE != qe->priority)
234       continue;
235     if (num_probes_change < 0)
236     {
237       stop_job (qe);
238       num_probes_change++;
239       if (0 == num_probes_change)
240         break;
241     }
242   }
243   GNUNET_break (0 <= num_probes_change);
244
245   /* start some more tasks if we now have empty slots */
246   block_limit_hit = GNUNET_NO;
247   next = h->pending_head;
248   while ( (NULL != (qe = next)) &&
249           ( (num_probes_change > 0) ||
250             (num_downloads_change > 0) ) )
251   {
252     next = qe->next;
253     switch (qe->priority)
254     {
255     case GNUNET_FS_QUEUE_PRIORITY_PROBE:
256       if (num_probes_change > 0)
257       {
258         start_job (qe);
259         num_probes_change--;
260         run_time = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2);
261         restart_at = GNUNET_TIME_relative_min (run_time, restart_at);
262       }
263       break;
264     case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
265       if ( (num_downloads_change > 0) &&
266            ( (qe->blocks + h->active_blocks <= h->max_parallel_requests) ||
267              ( (qe->blocks > h->max_parallel_requests) &&
268                (0 == h->active_downloads) ) ) )
269       {
270         start_job (qe);
271         num_downloads_change--;
272       }
273       else if (num_downloads_change > 0)
274         block_limit_hit = GNUNET_YES;
275       break;
276     default:
277       GNUNET_break (0);
278       break;
279     }
280   }
281   GNUNET_break ( (0 == num_downloads_change) || (GNUNET_YES == block_limit_hit) );
282   GNUNET_break (0 == num_probes_change);
283
284   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
285               "AD: %u, MP: %u; %d probes and %d downloads to start, will run again in %s\n",
286               h->active_downloads,
287               h->max_parallel_requests, 
288               num_probes_change,
289               num_downloads_change,
290               GNUNET_STRINGS_relative_time_to_string (restart_at, GNUNET_YES));
291
292   /* make sure we run again */
293   h->queue_job =
294       GNUNET_SCHEDULER_add_delayed (restart_at, &process_job_queue, h);
295 }
296
297
298 /**
299  * Add a job to the queue.
300  *
301  * @param h handle to the overall FS state
302  * @param start function to call to begin the job
303  * @param stop function to call to pause the job, or on dequeue (if the job was running)
304  * @param cls closure for start and stop
305  * @param blocks number of blocks this jobs uses
306  * @param priority how important is this download
307  * @return queue handle
308  */
309 struct GNUNET_FS_QueueEntry *
310 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h, GNUNET_FS_QueueStart start,
311                   GNUNET_FS_QueueStop stop, void *cls, unsigned int blocks,
312                   enum GNUNET_FS_QueuePriority priority)
313 {
314   struct GNUNET_FS_QueueEntry *qe;
315
316   qe = GNUNET_malloc (sizeof (struct GNUNET_FS_QueueEntry));
317   qe->h = h;
318   qe->start = start;
319   qe->stop = stop;
320   qe->cls = cls;
321   qe->queue_time = GNUNET_TIME_absolute_get ();
322   qe->blocks = blocks;
323   qe->priority = priority;
324   GNUNET_CONTAINER_DLL_insert_after (h->pending_head, h->pending_tail,
325                                      h->pending_tail, qe);
326   if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
327     GNUNET_SCHEDULER_cancel (h->queue_job);
328   h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h);
329   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
330               "Queueing job %p\n",
331               qe);
332   return qe;
333 }
334
335
336 /**
337  * Dequeue a job from the queue.
338  *
339  * @param qe handle for the job
340  */
341 void
342 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qe)
343 {
344   struct GNUNET_FS_Handle *h;
345
346   h = qe->h;
347   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
348               "Dequeueing job %p\n",
349               qe);
350   if (NULL != qe->client)
351     stop_job (qe);
352   GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, qe);
353   GNUNET_free (qe);
354   if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
355     GNUNET_SCHEDULER_cancel (h->queue_job);
356   h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h);
357 }
358
359
360 /**
361  * Create a top-level activity entry.
362  *
363  * @param h global fs handle
364  * @param ssf suspend signal function to use
365  * @param ssf_cls closure for ssf
366  * @return fresh top-level activity handle
367  */
368 struct TopLevelActivity *
369 GNUNET_FS_make_top (struct GNUNET_FS_Handle *h, SuspendSignalFunction ssf,
370                     void *ssf_cls)
371 {
372   struct TopLevelActivity *ret;
373
374   ret = GNUNET_malloc (sizeof (struct TopLevelActivity));
375   ret->ssf = ssf;
376   ret->ssf_cls = ssf_cls;
377   GNUNET_CONTAINER_DLL_insert (h->top_head, h->top_tail, ret);
378   return ret;
379 }
380
381
382 /**
383  * Destroy a top-level activity entry.
384  *
385  * @param h global fs handle
386  * @param top top level activity entry
387  */
388 void
389 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h, struct TopLevelActivity *top)
390 {
391   GNUNET_CONTAINER_DLL_remove (h->top_head, h->top_tail, top);
392   GNUNET_free (top);
393 }
394
395
396
397 /**
398  * Closure for "data_reader_file".
399  */
400 struct FileInfo
401 {
402   /**
403    * Name of the file to read.
404    */
405   char *filename;
406
407   /**
408    * File descriptor, NULL if it has not yet been opened.
409    */
410   struct GNUNET_DISK_FileHandle *fd;
411 };
412
413
414 /**
415  * Function that provides data by reading from a file.
416  *
417  * @param cls closure (points to the file information)
418  * @param offset offset to read from; it is possible
419  *            that the caller might need to go backwards
420  *            a bit at times; set to UINT64_MAX to tell
421  *            the reader that we won't be reading for a while
422  *            (used to close the file descriptor but NOT fully
423  *             clean up the reader's state); in this case,
424  *            a value of '0' for max should be ignored
425  * @param max maximum number of bytes that should be
426  *            copied to buf; readers are not allowed
427  *            to provide less data unless there is an error;
428  *            a value of "0" will be used at the end to allow
429  *            the reader to clean up its internal state
430  * @param buf where the reader should write the data
431  * @param emsg location for the reader to store an error message
432  * @return number of bytes written, usually "max", 0 on error
433  */
434 size_t
435 GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf,
436                              char **emsg)
437 {
438   struct FileInfo *fi = cls;
439   ssize_t ret;
440
441   if (UINT64_MAX == offset)
442   {
443     if (NULL != fi->fd)
444     {
445       GNUNET_DISK_file_close (fi->fd);
446       fi->fd = NULL;
447     }
448     return 0;
449   }
450   if (0 == max)
451   {
452     if (NULL != fi->fd)
453       GNUNET_DISK_file_close (fi->fd);
454     GNUNET_free (fi->filename);
455     GNUNET_free (fi);
456     return 0;
457   }
458   if (NULL == fi->fd)
459   {
460     fi->fd =
461         GNUNET_DISK_file_open (fi->filename, GNUNET_DISK_OPEN_READ,
462                                GNUNET_DISK_PERM_NONE);
463     if (NULL == fi->fd)
464     {
465       GNUNET_asprintf (emsg, _("Could not open file `%s': %s"), fi->filename,
466                        STRERROR (errno));
467       return 0;
468     }
469   }
470   if ( (GNUNET_SYSERR ==
471         GNUNET_DISK_file_seek (fi->fd, offset, GNUNET_DISK_SEEK_SET)) ||
472        (-1 == (ret = GNUNET_DISK_file_read (fi->fd, buf, max))) )
473   {
474     GNUNET_asprintf (emsg, _("Could not read file `%s': %s"), fi->filename,
475                      STRERROR (errno));
476     return 0;
477   }
478   if (ret != max)
479   {
480     GNUNET_asprintf (emsg, _("Short read reading from file `%s'!"),
481                      fi->filename);
482     return 0;
483   }
484   return max;
485 }
486
487
488 /**
489  * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
490  *
491  * @param filename file to read
492  * @return closure to use, NULL on error
493  */
494 void *
495 GNUNET_FS_make_file_reader_context_ (const char *filename)
496 {
497   struct FileInfo *fi;
498
499   fi = GNUNET_new (struct FileInfo);
500   fi->filename = GNUNET_STRINGS_filename_expand (filename);
501   if (NULL == fi->filename)
502   {
503     GNUNET_free (fi);
504     return NULL;
505   }
506   return fi;
507 }
508
509
510 /**
511  * Function that provides data by copying from a buffer.
512  *
513  * @param cls closure (points to the buffer)
514  * @param offset offset to read from; it is possible
515  *            that the caller might need to go backwards
516  *            a bit at times; set to UINT64_MAX to tell
517  *            the reader that we won't be reading for a while
518  *            (used to close the file descriptor but NOT fully
519  *             clean up the reader's state); in this case,
520  *            a value of '0' for max should be ignored
521  * @param max maximum number of bytes that should be
522  *            copied to buf; readers are not allowed
523  *            to provide less data unless there is an error;
524  *            a value of "0" will be used at the end to allow
525  *            the reader to clean up its internal state
526  * @param buf where the reader should write the data
527  * @param emsg location for the reader to store an error message
528  * @return number of bytes written, usually "max", 0 on error
529  */
530 size_t
531 GNUNET_FS_data_reader_copy_ (void *cls, uint64_t offset, size_t max, void *buf,
532                              char **emsg)
533 {
534   char *data = cls;
535
536   if (UINT64_MAX == offset)
537     return 0;
538   if (0 == max)
539   {
540     GNUNET_free_non_null (data);
541     return 0;
542   }
543   memcpy (buf, &data[offset], max);
544   return max;
545 }
546
547
548 /**
549  * Return the full filename where we would store state information
550  * (for serialization/deserialization).
551  *
552  * @param h master context
553  * @param ext component of the path
554  * @param ent entity identifier (or emtpy string for the directory)
555  * @return NULL on error
556  */
557 static char *
558 get_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext,
559                              const char *ent)
560 {
561   char *basename;
562   char *ret;
563
564   if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
565     return NULL;                /* persistence not requested */
566   if (GNUNET_OK !=
567       GNUNET_CONFIGURATION_get_value_filename (h->cfg, "fs", "STATE_DIR",
568                                                &basename))
569     return NULL;
570   GNUNET_asprintf (&ret, "%s%s%s%s%s%s%s", basename, DIR_SEPARATOR_STR,
571                    h->client_name, DIR_SEPARATOR_STR, ext, DIR_SEPARATOR_STR,
572                    ent);
573   GNUNET_free (basename);
574   return ret;
575 }
576
577
578 /**
579  * Return the full filename where we would store state information
580  * (for serialization/deserialization) that is associated with a
581  * parent operation.
582  *
583  * @param h master context
584  * @param ext component of the path
585  * @param uni name of the parent operation
586  * @param ent entity identifier (or emtpy string for the directory)
587  * @return NULL on error
588  */
589 static char *
590 get_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
591                                     const char *uni, const char *ent)
592 {
593   char *basename;
594   char *ret;
595
596   if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
597     return NULL;                /* persistence not requested */
598   if (GNUNET_OK !=
599       GNUNET_CONFIGURATION_get_value_filename (h->cfg, "fs", "STATE_DIR",
600                                                &basename))
601     return NULL;
602   GNUNET_asprintf (&ret, "%s%s%s%s%s%s%s.dir%s%s", basename, DIR_SEPARATOR_STR,
603                    h->client_name, DIR_SEPARATOR_STR, ext, DIR_SEPARATOR_STR,
604                    uni, DIR_SEPARATOR_STR, ent);
605   GNUNET_free (basename);
606   return ret;
607 }
608
609
610 /**
611  * Return a read handle for deserialization.
612  *
613  * @param h master context
614  * @param ext component of the path
615  * @param ent entity identifier (or emtpy string for the directory)
616  * @return NULL on error
617  */
618 static struct GNUNET_BIO_ReadHandle *
619 get_read_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
620 {
621   char *fn;
622   struct GNUNET_BIO_ReadHandle *ret;
623
624   fn = get_serialization_file_name (h, ext, ent);
625   if (NULL == fn)
626     return NULL;
627   ret = GNUNET_BIO_read_open (fn);
628   GNUNET_free (fn);
629   return ret;
630 }
631
632
633 /**
634  * Return a write handle for serialization.
635  *
636  * @param h master context
637  * @param ext component of the path
638  * @param ent entity identifier (or emtpy string for the directory)
639  * @return NULL on error
640  */
641 static struct GNUNET_BIO_WriteHandle *
642 get_write_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
643 {
644   char *fn;
645   struct GNUNET_BIO_WriteHandle *ret;
646
647   fn = get_serialization_file_name (h, ext, ent);
648   if (NULL == fn)
649     return NULL;
650   ret = GNUNET_BIO_write_open (fn);
651   GNUNET_break (NULL != ret);
652   GNUNET_free (fn);
653   return ret;
654 }
655
656
657 /**
658  * Return a write handle for serialization.
659  *
660  * @param h master context
661  * @param ext component of the path
662  * @param uni name of parent
663  * @param ent entity identifier (or emtpy string for the directory)
664  * @return NULL on error
665  */
666 static struct GNUNET_BIO_WriteHandle *
667 get_write_handle_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
668                          const char *uni, const char *ent)
669 {
670   char *fn;
671   struct GNUNET_BIO_WriteHandle *ret;
672
673   fn = get_serialization_file_name_in_dir (h, ext, uni, ent);
674   if (NULL == fn)
675     return NULL;
676   ret = GNUNET_BIO_write_open (fn);
677   GNUNET_free (fn);
678   return ret;
679 }
680
681
682 /**
683  * Remove serialization/deserialization file from disk.
684  *
685  * @param h master context
686  * @param ext component of the path
687  * @param ent entity identifier
688  */
689 void
690 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext,
691                              const char *ent)
692 {
693   char *filename;
694
695   if ((NULL == ent) || (0 == strlen (ent)))
696   {
697     GNUNET_break (0);
698     return;
699   }
700   filename = get_serialization_file_name (h, ext, ent);
701   if (NULL != filename)
702   {
703     if (0 != UNLINK (filename))
704       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
705     GNUNET_free (filename);
706   }
707 }
708
709
710 /**
711  * Remove serialization/deserialization file from disk.
712  *
713  * @param h master context
714  * @param ext component of the path
715  * @param uni parent name
716  * @param ent entity identifier
717  */
718 static void
719 remove_sync_file_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
720                          const char *uni, const char *ent)
721 {
722   char *filename;
723
724   if ((NULL == ent) || (0 == strlen (ent)))
725   {
726     GNUNET_break (0);
727     return;
728   }
729   filename = get_serialization_file_name_in_dir (h, ext, uni, ent);
730   if (NULL == filename)
731     return;
732   if (0 != UNLINK (filename))
733     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
734   GNUNET_free (filename);
735 }
736
737
738 /**
739  * Remove serialization/deserialization directory from disk.
740  *
741  * @param h master context
742  * @param ext component of the path
743  * @param uni unique name of parent
744  */
745 void
746 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext,
747                             const char *uni)
748 {
749   char *dn;
750
751   if (NULL == uni)
752     return;
753   dn = get_serialization_file_name_in_dir (h, ext, uni, "");
754   if (NULL == dn)
755     return;
756   if ((GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES)) &&
757       (GNUNET_OK != GNUNET_DISK_directory_remove (dn)))
758     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "rmdir", dn);
759   GNUNET_free (dn);
760 }
761
762
763 /**
764  * Serialize a 'start_time'.  Since we use start-times to
765  * calculate the duration of some operation, we actually
766  * do not serialize the absolute time but the (relative)
767  * duration since the start time.  When we then
768  * deserialize the start time, we take the current time and
769  * subtract that duration so that we get again an absolute
770  * time stamp that will result in correct performance
771  * calculations.
772  *
773  * @param wh handle for writing
774  * @param timestamp time to serialize
775  * @return GNUNET_OK on success
776  */
777 static int
778 write_start_time (struct GNUNET_BIO_WriteHandle *wh,
779                   struct GNUNET_TIME_Absolute timestamp)
780 {
781   struct GNUNET_TIME_Relative dur;
782
783   dur = GNUNET_TIME_absolute_get_duration (timestamp);
784   return GNUNET_BIO_write_int64 (wh, dur.rel_value_us);
785 }
786
787
788 /**
789  * Serialize a 'start_time'.  Since we use start-times to
790  * calculate the duration of some operation, we actually
791  * do not serialize the absolute time but the (relative)
792  * duration since the start time.  When we then
793  * deserialize the start time, we take the current time and
794  * subtract that duration so that we get again an absolute
795  * time stamp that will result in correct performance
796  * calculations.
797  *
798  * @param rh handle for reading
799  * @param timestamp where to write the deserialized timestamp
800  * @return GNUNET_OK on success
801  */
802 static int
803 read_start_time (struct GNUNET_BIO_ReadHandle *rh,
804                  struct GNUNET_TIME_Absolute *timestamp)
805 {
806   struct GNUNET_TIME_Relative dur;
807
808   if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dur.rel_value_us))
809     return GNUNET_SYSERR;
810   *timestamp = GNUNET_TIME_absolute_subtract (GNUNET_TIME_absolute_get (), dur);
811   return GNUNET_OK;
812 }
813
814
815 /**
816  * Using the given serialization filename, try to deserialize
817  * the file-information tree associated with it.
818  *
819  * @param h master context
820  * @param filename name of the file (without directory) with
821  *        the infromation
822  * @return NULL on error
823  */
824 static struct GNUNET_FS_FileInformation *
825 deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename);
826
827
828 /**
829  * Using the given serialization filename, try to deserialize
830  * the file-information tree associated with it.
831  *
832  * @param h master context
833  * @param fn name of the file (without directory) with
834  *        the infromation
835  * @param rh handle for reading
836  * @return NULL on error
837  */
838 static struct GNUNET_FS_FileInformation *
839 deserialize_fi_node (struct GNUNET_FS_Handle *h, const char *fn,
840                      struct GNUNET_BIO_ReadHandle *rh)
841 {
842   struct GNUNET_FS_FileInformation *ret;
843   struct GNUNET_FS_FileInformation *nxt;
844   char b;
845   char *ksks;
846   char *chks;
847   char *filename;
848   uint32_t dsize;
849
850   if (GNUNET_OK != GNUNET_BIO_read (rh, "status flag", &b, sizeof (b)))
851   {
852     GNUNET_break (0);
853     return NULL;
854   }
855   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_FileInformation));
856   ret->h = h;
857   ksks = NULL;
858   chks = NULL;
859   filename = NULL;
860   if ((GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "metadata", &ret->meta)) ||
861       (GNUNET_OK != GNUNET_BIO_read_string (rh, "ksk-uri", &ksks, 32 * 1024)) ||
862       ( (NULL != ksks) &&
863         ( (NULL == (ret->keywords = GNUNET_FS_uri_parse (ksks, NULL))) ||
864           (GNUNET_YES != GNUNET_FS_uri_test_ksk (ret->keywords)) ) ) ||
865       (GNUNET_OK != GNUNET_BIO_read_string (rh, "chk-uri", &chks, 1024)) ||
866       ( (NULL != chks) &&
867         ( (NULL == (ret->chk_uri = GNUNET_FS_uri_parse (chks, NULL))) ||
868           (GNUNET_YES != GNUNET_FS_uri_test_chk (ret->chk_uri))) ) ||
869       (GNUNET_OK != read_start_time (rh, &ret->start_time)) ||
870       (GNUNET_OK != GNUNET_BIO_read_string (rh, "emsg", &ret->emsg, 16 * 1024))
871       || (GNUNET_OK !=
872           GNUNET_BIO_read_string (rh, "fn", &ret->filename, 16 * 1024)) ||
873       (GNUNET_OK !=
874        GNUNET_BIO_read_int64 (rh, &ret->bo.expiration_time.abs_value_us)) ||
875       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.anonymity_level)) ||
876       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.content_priority)) ||
877       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.replication_level)))
878   {
879     GNUNET_break (0);
880     goto cleanup;
881   }
882   switch (b)
883   {
884   case 0:                      /* file-insert */
885     if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
886     {
887       GNUNET_break (0);
888       goto cleanup;
889     }
890     ret->is_directory = GNUNET_NO;
891     ret->data.file.do_index = GNUNET_NO;
892     ret->data.file.have_hash = GNUNET_NO;
893     ret->data.file.index_start_confirmed = GNUNET_NO;
894     if (GNUNET_NO == ret->is_published)
895     {
896       if (NULL == ret->filename)
897       {
898         ret->data.file.reader = &GNUNET_FS_data_reader_copy_;
899         ret->data.file.reader_cls =
900             GNUNET_malloc_large (ret->data.file.file_size);
901         if (ret->data.file.reader_cls == NULL)
902           goto cleanup;
903         if (GNUNET_OK !=
904             GNUNET_BIO_read (rh, "file-data", ret->data.file.reader_cls,
905                              ret->data.file.file_size))
906         {
907           GNUNET_break (0);
908           goto cleanup;
909         }
910       }
911       else
912       {
913         ret->data.file.reader = &GNUNET_FS_data_reader_file_;
914         ret->data.file.reader_cls =
915             GNUNET_FS_make_file_reader_context_ (ret->filename);
916       }
917     }
918     break;
919   case 1:                      /* file-index, no hash */
920     if (NULL == ret->filename)
921     {
922       GNUNET_break (0);
923       goto cleanup;
924     }
925     if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
926     {
927       GNUNET_break (0);
928       goto cleanup;
929     }
930     ret->is_directory = GNUNET_NO;
931     ret->data.file.do_index = GNUNET_YES;
932     ret->data.file.have_hash = GNUNET_NO;
933     ret->data.file.index_start_confirmed = GNUNET_NO;
934     ret->data.file.reader = &GNUNET_FS_data_reader_file_;
935     ret->data.file.reader_cls =
936         GNUNET_FS_make_file_reader_context_ (ret->filename);
937     break;
938   case 2:                      /* file-index-with-hash */
939     if (NULL == ret->filename)
940     {
941       GNUNET_break (0);
942       goto cleanup;
943     }
944     if ((GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
945         (GNUNET_OK !=
946          GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id,
947                           sizeof (struct GNUNET_HashCode))))
948     {
949       GNUNET_break (0);
950       goto cleanup;
951     }
952     ret->is_directory = GNUNET_NO;
953     ret->data.file.do_index = GNUNET_YES;
954     ret->data.file.have_hash = GNUNET_YES;
955     ret->data.file.index_start_confirmed = GNUNET_NO;
956     ret->data.file.reader = &GNUNET_FS_data_reader_file_;
957     ret->data.file.reader_cls =
958         GNUNET_FS_make_file_reader_context_ (ret->filename);
959     break;
960   case 3:                      /* file-index-with-hash-confirmed */
961     if (NULL == ret->filename)
962     {
963       GNUNET_break (0);
964       goto cleanup;
965     }
966     if ((GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
967         (GNUNET_OK !=
968          GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id,
969                           sizeof (struct GNUNET_HashCode))))
970     {
971       GNUNET_break (0);
972       goto cleanup;
973     }
974     ret->is_directory = GNUNET_NO;
975     ret->data.file.do_index = GNUNET_YES;
976     ret->data.file.have_hash = GNUNET_YES;
977     ret->data.file.index_start_confirmed = GNUNET_YES;
978     ret->data.file.reader = &GNUNET_FS_data_reader_file_;
979     ret->data.file.reader_cls =
980         GNUNET_FS_make_file_reader_context_ (ret->filename);
981     break;
982   case 4:                      /* directory */
983     ret->is_directory = GNUNET_YES;
984     if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dsize)) ||
985         (NULL == (ret->data.dir.dir_data = GNUNET_malloc_large (dsize))) ||
986         (GNUNET_OK !=
987          GNUNET_BIO_read (rh, "dir-data", ret->data.dir.dir_data, dsize)) ||
988         (GNUNET_OK !=
989          GNUNET_BIO_read_string (rh, "ent-filename", &filename, 16 * 1024)))
990     {
991       GNUNET_break (0);
992       goto cleanup;
993     }
994     ret->data.dir.dir_size = (uint32_t) dsize;
995     if (NULL != filename)
996     {
997       ret->data.dir.entries = deserialize_file_information (h, filename);
998       GNUNET_free (filename);
999       filename = NULL;
1000       nxt = ret->data.dir.entries;
1001       while (NULL != nxt)
1002       {
1003         nxt->dir = ret;
1004         nxt = nxt->next;
1005       }
1006     }
1007     break;
1008   default:
1009     GNUNET_break (0);
1010     goto cleanup;
1011   }
1012   ret->serialization = GNUNET_strdup (fn);
1013   if (GNUNET_OK !=
1014       GNUNET_BIO_read_string (rh, "nxt-filename", &filename, 16 * 1024))
1015   {
1016     GNUNET_break (0);
1017     goto cleanup;
1018   }
1019   if (NULL != filename)
1020   {
1021     ret->next = deserialize_file_information (h, filename);
1022     GNUNET_free (filename);
1023     filename = NULL;
1024   }
1025   GNUNET_free_non_null (ksks);
1026   GNUNET_free_non_null (chks);
1027   return ret;
1028 cleanup:
1029   GNUNET_free_non_null (ksks);
1030   GNUNET_free_non_null (chks);
1031   GNUNET_free_non_null (filename);
1032   GNUNET_FS_file_information_destroy (ret, NULL, NULL);
1033   return NULL;
1034 }
1035
1036
1037 /**
1038  * Using the given serialization filename, try to deserialize
1039  * the file-information tree associated with it.
1040  *
1041  * @param h master context
1042  * @param filename name of the file (without directory) with
1043  *        the infromation
1044  * @return NULL on error
1045  */
1046 static struct GNUNET_FS_FileInformation *
1047 deserialize_file_information (struct GNUNET_FS_Handle *h,
1048                               const char *filename)
1049 {
1050   struct GNUNET_FS_FileInformation *ret;
1051   struct GNUNET_BIO_ReadHandle *rh;
1052   char *emsg;
1053   char *fn;
1054
1055   rh = get_read_handle (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
1056   if (NULL == rh)
1057     return NULL;
1058   ret = deserialize_fi_node (h, filename, rh);
1059   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1060   {
1061     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1062                 _("Failed to resume publishing information `%s': %s\n"),
1063                 filename, emsg);
1064     GNUNET_free (emsg);
1065   }
1066   if (NULL == ret)
1067   {
1068     fn = get_serialization_file_name (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
1069     if (NULL != fn)
1070     {
1071       if (0 != UNLINK (fn))
1072         GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1073       GNUNET_free (fn);
1074     }
1075   }
1076   return ret;
1077 }
1078
1079
1080 /**
1081  * Given a serialization name (full absolute path), return the
1082  * basename of the file (without the path), which must only
1083  * consist of the 6 random characters.
1084  *
1085  * @param fullname name to extract the basename from
1086  * @return copy of the basename, NULL on error
1087  */
1088 static char *
1089 get_serialization_short_name (const char *fullname)
1090 {
1091   const char *end;
1092   const char *nxt;
1093
1094   end = NULL;
1095   nxt = fullname;
1096   /* FIXME: we could do this faster since we know
1097    * the length of 'end'... */
1098   while ('\0' != *nxt)
1099   {
1100     if (DIR_SEPARATOR == *nxt)
1101       end = nxt + 1;
1102     nxt++;
1103   }
1104   if ((NULL == end) || (0 == strlen (end)))
1105   {
1106     GNUNET_break (0);
1107     return NULL;
1108   }
1109   GNUNET_break (6 == strlen (end));
1110   return GNUNET_strdup (end);
1111 }
1112
1113
1114 /**
1115  * Create a new random name for serialization.  Also checks if persistence
1116  * is enabled and returns NULL if not.
1117  *
1118  * @param h master context
1119  * @param ext component of the path
1120  * @return NULL on errror
1121  */
1122 static char *
1123 make_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext)
1124 {
1125   char *fn;
1126   char *dn;
1127   char *ret;
1128
1129   if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1130     return NULL;                /* persistence not requested */
1131   dn = get_serialization_file_name (h, ext, "");
1132   if (NULL == dn)
1133     return NULL;
1134   if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1135   {
1136     GNUNET_free (dn);
1137     return NULL;
1138   }
1139   fn = GNUNET_DISK_mktemp (dn);
1140   GNUNET_free (dn);
1141   if (NULL == fn)
1142     return NULL;                /* epic fail */
1143   ret = get_serialization_short_name (fn);
1144   GNUNET_free (fn);
1145   return ret;
1146 }
1147
1148
1149 /**
1150  * Create a new random name for serialization.  Also checks if persistence
1151  * is enabled and returns NULL if not.
1152  *
1153  * @param h master context
1154  * @param ext component of the path
1155  * @param uni name of parent
1156  * @return NULL on errror
1157  */
1158 static char *
1159 make_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h,
1160                                      const char *ext, const char *uni)
1161 {
1162   char *fn;
1163   char *dn;
1164   char *ret;
1165
1166   if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1167     return NULL;                /* persistence not requested */
1168   dn = get_serialization_file_name_in_dir (h, ext, uni, "");
1169   if (NULL == dn)
1170     return NULL;
1171   if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1172   {
1173     GNUNET_free (dn);
1174     return NULL;
1175   }
1176   fn = GNUNET_DISK_mktemp (dn);
1177   GNUNET_free (dn);
1178   if (NULL == fn)
1179     return NULL;                /* epic fail */
1180   ret = get_serialization_short_name (fn);
1181   GNUNET_free (fn);
1182   return ret;
1183 }
1184
1185
1186 /**
1187  * Copy all of the data from the reader to the write handle.
1188  *
1189  * @param wh write handle
1190  * @param fi file with reader
1191  * @return #GNUNET_OK on success
1192  */
1193 static int
1194 copy_from_reader (struct GNUNET_BIO_WriteHandle *wh,
1195                   struct GNUNET_FS_FileInformation *fi)
1196 {
1197   char buf[32 * 1024];
1198   uint64_t off;
1199   size_t ret;
1200   size_t left;
1201   char *emsg;
1202
1203   emsg = NULL;
1204   off = 0;
1205   while (off < fi->data.file.file_size)
1206   {
1207     left = GNUNET_MIN (sizeof (buf), fi->data.file.file_size - off);
1208     ret =
1209         fi->data.file.reader (fi->data.file.reader_cls, off, left, buf, &emsg);
1210     if (0 == ret)
1211     {
1212       GNUNET_free (emsg);
1213       return GNUNET_SYSERR;
1214     }
1215     if (GNUNET_OK != GNUNET_BIO_write (wh, buf, ret))
1216       return GNUNET_SYSERR;
1217     off += ret;
1218   }
1219   return GNUNET_OK;
1220 }
1221
1222
1223 /**
1224  * Create a temporary file on disk to store the current
1225  * state of "fi" in.
1226  *
1227  * @param fi file information to sync with disk
1228  */
1229 void
1230 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *fi)
1231 {
1232   char *fn;
1233   struct GNUNET_BIO_WriteHandle *wh;
1234   char b;
1235   char *ksks;
1236   char *chks;
1237
1238   if (NULL == fi->serialization)
1239     fi->serialization =
1240         make_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO);
1241   if (NULL == fi->serialization)
1242     return;
1243   wh = get_write_handle (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1244                          fi->serialization);
1245   if (NULL == wh)
1246   {
1247     GNUNET_free (fi->serialization);
1248     fi->serialization = NULL;
1249     return;
1250   }
1251   if (GNUNET_YES == fi->is_directory)
1252     b = 4;
1253   else if (GNUNET_YES == fi->data.file.index_start_confirmed)
1254     b = 3;
1255   else if (GNUNET_YES == fi->data.file.have_hash)
1256     b = 2;
1257   else if (GNUNET_YES == fi->data.file.do_index)
1258     b = 1;
1259   else
1260     b = 0;
1261   if (NULL != fi->keywords)
1262     ksks = GNUNET_FS_uri_to_string (fi->keywords);
1263   else
1264     ksks = NULL;
1265   if (NULL != fi->chk_uri)
1266     chks = GNUNET_FS_uri_to_string (fi->chk_uri);
1267   else
1268     chks = NULL;
1269   if ((GNUNET_OK != GNUNET_BIO_write (wh, &b, sizeof (b))) ||
1270       (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, fi->meta)) ||
1271       (GNUNET_OK != GNUNET_BIO_write_string (wh, ksks)) ||
1272       (GNUNET_OK != GNUNET_BIO_write_string (wh, chks)) ||
1273       (GNUNET_OK != write_start_time (wh, fi->start_time)) ||
1274       (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->emsg)) ||
1275       (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->filename)) ||
1276       (GNUNET_OK !=
1277        GNUNET_BIO_write_int64 (wh, fi->bo.expiration_time.abs_value_us)) ||
1278       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.anonymity_level)) ||
1279       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.content_priority)) ||
1280       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.replication_level)))
1281   {
1282     GNUNET_break (0);
1283     goto cleanup;
1284   }
1285   GNUNET_free_non_null (chks);
1286   chks = NULL;
1287   GNUNET_free_non_null (ksks);
1288   ksks = NULL;
1289
1290   switch (b)
1291   {
1292   case 0:                      /* file-insert */
1293     if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1294     {
1295       GNUNET_break (0);
1296       goto cleanup;
1297     }
1298     if ((GNUNET_NO == fi->is_published) && (NULL == fi->filename))
1299       if (GNUNET_OK != copy_from_reader (wh, fi))
1300       {
1301         GNUNET_break (0);
1302         goto cleanup;
1303       }
1304     break;
1305   case 1:                      /* file-index, no hash */
1306     if (NULL == fi->filename)
1307     {
1308       GNUNET_break (0);
1309       goto cleanup;
1310     }
1311     if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1312     {
1313       GNUNET_break (0);
1314       goto cleanup;
1315     }
1316     break;
1317   case 2:                      /* file-index-with-hash */
1318   case 3:                      /* file-index-with-hash-confirmed */
1319     if (NULL == fi->filename)
1320     {
1321       GNUNET_break (0);
1322       goto cleanup;
1323     }
1324     if ((GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size)) ||
1325         (GNUNET_OK !=
1326          GNUNET_BIO_write (wh, &fi->data.file.file_id,
1327                            sizeof (struct GNUNET_HashCode))))
1328     {
1329       GNUNET_break (0);
1330       goto cleanup;
1331     }
1332     break;
1333   case 4:                      /* directory */
1334     if ( (NULL != fi->data.dir.entries) &&
1335          (NULL == fi->data.dir.entries->serialization) )
1336       GNUNET_FS_file_information_sync_ (fi->data.dir.entries);
1337     if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->data.dir.dir_size)) ||
1338         (GNUNET_OK !=
1339          GNUNET_BIO_write (wh, fi->data.dir.dir_data,
1340                            (uint32_t) fi->data.dir.dir_size)) ||
1341         (GNUNET_OK !=
1342          GNUNET_BIO_write_string (wh,
1343                                   (fi->data.dir.entries ==
1344                                    NULL) ? NULL : fi->data.dir.
1345                                   entries->serialization)))
1346     {
1347       GNUNET_break (0);
1348       goto cleanup;
1349     }
1350     break;
1351   default:
1352     GNUNET_assert (0);
1353     goto cleanup;
1354   }
1355   if ( (NULL != fi->next) &&
1356        (NULL == fi->next->serialization) )
1357     GNUNET_FS_file_information_sync_ (fi->next);
1358   if (GNUNET_OK !=
1359       GNUNET_BIO_write_string (wh,
1360                                (fi->next !=
1361                                 NULL) ? fi->next->serialization : NULL))
1362   {
1363     GNUNET_break (0);
1364     goto cleanup;
1365   }
1366   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1367   {
1368     wh = NULL;
1369     GNUNET_break (0);
1370     goto cleanup;
1371   }
1372   return;                       /* done! */
1373 cleanup:
1374   if (NULL != wh)
1375     (void) GNUNET_BIO_write_close (wh);
1376   GNUNET_free_non_null (chks);
1377   GNUNET_free_non_null (ksks);
1378   fn = get_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1379                                     fi->serialization);
1380   if (NULL != fn)
1381   {
1382     if (0 != UNLINK (fn))
1383       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1384     GNUNET_free (fn);
1385   }
1386   GNUNET_free (fi->serialization);
1387   fi->serialization = NULL;
1388 }
1389
1390
1391
1392 /**
1393  * Find the entry in the file information struct where the
1394  * serialization filename matches the given name.
1395  *
1396  * @param pos file information to search
1397  * @param srch filename to search for
1398  * @return NULL if srch was not found in this subtree
1399  */
1400 static struct GNUNET_FS_FileInformation *
1401 find_file_position (struct GNUNET_FS_FileInformation *pos,
1402                     const char *srch)
1403 {
1404   struct GNUNET_FS_FileInformation *r;
1405
1406   while (NULL != pos)
1407   {
1408     if (0 == strcmp (srch, pos->serialization))
1409       return pos;
1410     if ( (GNUNET_YES == pos->is_directory) &&
1411          (NULL != (r = find_file_position (pos->data.dir.entries, srch))) )
1412       return r;
1413     pos = pos->next;
1414   }
1415   return NULL;
1416 }
1417
1418
1419 /**
1420  * Signal the FS's progress function that we are resuming
1421  * an upload.
1422  *
1423  * @param cls closure (of type `struct GNUNET_FS_PublishContext *`, for the parent (!))
1424  * @param fi the entry in the publish-structure
1425  * @param length length of the file or directory
1426  * @param meta metadata for the file or directory (can be modified)
1427  * @param uri pointer to the keywords that will be used for this entry (can be modified)
1428  * @param bo block options (can be modified)
1429  * @param do_index should we index?
1430  * @param client_info pointer to client context set upon creation (can be modified)
1431  * @return #GNUNET_OK to continue (always)
1432  */
1433 static int
1434 fip_signal_resume (void *cls, struct GNUNET_FS_FileInformation *fi,
1435                    uint64_t length, struct GNUNET_CONTAINER_MetaData *meta,
1436                    struct GNUNET_FS_Uri **uri,
1437                    struct GNUNET_FS_BlockOptions *bo, int *do_index,
1438                    void **client_info)
1439 {
1440   struct GNUNET_FS_PublishContext *pc = cls;
1441   struct GNUNET_FS_ProgressInfo pi;
1442
1443   if (GNUNET_YES == pc->skip_next_fi_callback)
1444   {
1445     pc->skip_next_fi_callback = GNUNET_NO;
1446     return GNUNET_OK;
1447   }
1448   pi.status = GNUNET_FS_STATUS_PUBLISH_RESUME;
1449   pi.value.publish.specifics.resume.message = fi->emsg;
1450   pi.value.publish.specifics.resume.chk_uri = fi->chk_uri;
1451   *client_info = GNUNET_FS_publish_make_status_ (&pi, pc, fi, 0);
1452   if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta))
1453   {
1454     /* process entries in directory */
1455     pc->skip_next_fi_callback = GNUNET_YES;
1456     GNUNET_FS_file_information_inspect (fi, &fip_signal_resume, pc);
1457   }
1458   return GNUNET_OK;
1459 }
1460
1461
1462 /**
1463  * Function called with a filename of serialized publishing operation
1464  * to deserialize.
1465  *
1466  * @param cls the `struct GNUNET_FS_Handle *`
1467  * @param filename complete filename (absolute path)
1468  * @return #GNUNET_OK (continue to iterate)
1469  */
1470 static int
1471 deserialize_publish_file (void *cls, const char *filename)
1472 {
1473   struct GNUNET_FS_Handle *h = cls;
1474   struct GNUNET_BIO_ReadHandle *rh;
1475   struct GNUNET_FS_PublishContext *pc;
1476   int32_t options;
1477   int32_t all_done;
1478   int32_t have_ns;
1479   char *fi_root;
1480   struct GNUNET_CRYPTO_EccPrivateKey ns;
1481   char *fi_pos;
1482   char *emsg;
1483
1484   pc = GNUNET_new (struct GNUNET_FS_PublishContext);
1485   pc->h = h;
1486   pc->serialization = get_serialization_short_name (filename);
1487   fi_root = NULL;
1488   fi_pos = NULL;
1489   rh = GNUNET_BIO_read_open (filename);
1490   if (NULL == rh)
1491   {
1492     GNUNET_break (0);
1493     goto cleanup;
1494   }
1495   if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-nid", &pc->nid, 1024))
1496       || (GNUNET_OK !=
1497           GNUNET_BIO_read_string (rh, "publish-nuid", &pc->nuid, 1024)) ||
1498       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
1499       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &all_done)) ||
1500       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &have_ns)) ||
1501       (GNUNET_OK !=
1502        GNUNET_BIO_read_string (rh, "publish-firoot", &fi_root, 128)) ||
1503       (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-fipos", &fi_pos, 128))
1504       || ( (GNUNET_YES == have_ns) &&
1505            (GNUNET_OK != GNUNET_BIO_read (rh, "publish-ns", &ns, sizeof (ns)))) )
1506   {
1507     GNUNET_break (0);
1508     goto cleanup;
1509   }
1510   pc->options = options;
1511   pc->all_done = all_done;
1512   if (NULL == fi_root)
1513   {
1514     GNUNET_break (0);
1515     goto cleanup;
1516   }
1517   pc->fi = deserialize_file_information (h, fi_root);
1518   if (NULL == pc->fi)
1519   {
1520     GNUNET_break (0);
1521     goto cleanup;
1522   }
1523   if (GNUNET_YES == have_ns)
1524   {
1525     pc->ns = GNUNET_new (struct GNUNET_CRYPTO_EccPrivateKey);
1526     *pc->ns = ns;
1527   }
1528   if ((0 == (pc->options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY)) &&
1529       (GNUNET_YES != pc->all_done))
1530   {
1531     pc->dsh = GNUNET_DATASTORE_connect (h->cfg);
1532     if (NULL == pc->dsh)
1533       goto cleanup;
1534   }
1535   if (NULL != fi_pos)
1536   {
1537     pc->fi_pos = find_file_position (pc->fi, fi_pos);
1538     GNUNET_free (fi_pos);
1539     fi_pos = NULL;
1540     if (NULL == pc->fi_pos)
1541     {
1542       /* failed to find position for resuming, outch! Will start from root! */
1543       GNUNET_break (0);
1544       if (GNUNET_YES != pc->all_done)
1545         pc->fi_pos = pc->fi;
1546     }
1547   }
1548   GNUNET_free (fi_root);
1549   fi_root = NULL;
1550   /* generate RESUME event(s) */
1551   GNUNET_FS_file_information_inspect (pc->fi, &fip_signal_resume, pc);
1552
1553   /* re-start publishing (if needed)... */
1554   if (GNUNET_YES != pc->all_done)
1555   {
1556     GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
1557     pc->upload_task =
1558         GNUNET_SCHEDULER_add_with_priority
1559         (GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
1560          &GNUNET_FS_publish_main_, pc);
1561   }
1562   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1563   {
1564     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1565                 _("Failure while resuming publishing operation `%s': %s\n"),
1566                 filename, emsg);
1567     GNUNET_free (emsg);
1568   }
1569   pc->top = GNUNET_FS_make_top (h, &GNUNET_FS_publish_signal_suspend_, pc);
1570   return GNUNET_OK;
1571 cleanup:
1572   GNUNET_free_non_null (pc->nid);
1573   GNUNET_free_non_null (pc->nuid);
1574   GNUNET_free_non_null (fi_root);
1575   GNUNET_free_non_null (fi_pos);
1576   if ((NULL != rh) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
1577   {
1578     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1579                 _("Failed to resume publishing operation `%s': %s\n"), filename,
1580                 emsg);
1581     GNUNET_free (emsg);
1582   }
1583   if (NULL != pc->fi)
1584     GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
1585   if (0 != UNLINK (filename))
1586     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
1587   GNUNET_free (pc->serialization);
1588   GNUNET_free (pc);
1589   return GNUNET_OK;
1590 }
1591
1592
1593 /**
1594  * Synchronize this publishing struct with its mirror
1595  * on disk.  Note that all internal FS-operations that change
1596  * publishing structs should already call "sync" internally,
1597  * so this function is likely not useful for clients.
1598  *
1599  * @param pc the struct to sync
1600  */
1601 void
1602 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc)
1603 {
1604   struct GNUNET_BIO_WriteHandle *wh;
1605   int32_t have_ns;
1606
1607   if (NULL == pc->serialization)
1608     pc->serialization =
1609         make_serialization_file_name (pc->h,
1610                                       GNUNET_FS_SYNC_PATH_MASTER_PUBLISH);
1611   if (NULL == pc->serialization)
1612     return;
1613   if (NULL == pc->fi)
1614     return;
1615   if (NULL == pc->fi->serialization)
1616   {
1617     GNUNET_break (0);
1618     return;
1619   }
1620   wh = get_write_handle (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1621                          pc->serialization);
1622   if (NULL == wh)
1623   {
1624     GNUNET_break (0);
1625     goto cleanup;
1626   }
1627   have_ns = (NULL != pc->ns) ? GNUNET_YES : GNUNET_NO;
1628   if ((GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nid)) ||
1629       (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nuid)) ||
1630       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->options)) ||
1631       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->all_done)) ||
1632       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, have_ns)) ||
1633       (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->fi->serialization)) ||
1634       (GNUNET_OK !=
1635        GNUNET_BIO_write_string (wh,
1636                                 (NULL == pc->fi_pos) ? NULL : pc->fi_pos->serialization)) ||
1637       ( (NULL != pc->ns) &&
1638         (GNUNET_OK != GNUNET_BIO_write (wh,
1639                                         pc->ns,
1640                                         sizeof (struct GNUNET_CRYPTO_EccPrivateKey)) ) ))
1641   {
1642     GNUNET_break (0);
1643     goto cleanup;
1644   }
1645   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1646   {
1647     wh = NULL;
1648     GNUNET_break (0);
1649     goto cleanup;
1650   }
1651   return;
1652 cleanup:
1653   if (NULL != wh)
1654     (void) GNUNET_BIO_write_close (wh);
1655   GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1656                                pc->serialization);
1657   GNUNET_free (pc->serialization);
1658   pc->serialization = NULL;
1659 }
1660
1661
1662 /**
1663  * Synchronize this unindex struct with its mirror
1664  * on disk.  Note that all internal FS-operations that change
1665  * publishing structs should already call "sync" internally,
1666  * so this function is likely not useful for clients.
1667  *
1668  * @param uc the struct to sync
1669  */
1670 void
1671 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc)
1672 {
1673   struct GNUNET_BIO_WriteHandle *wh;
1674   char *uris;
1675
1676   if (NULL == uc->serialization)
1677     uc->serialization =
1678         make_serialization_file_name (uc->h,
1679                                       GNUNET_FS_SYNC_PATH_MASTER_UNINDEX);
1680   if (NULL == uc->serialization)
1681     return;
1682   wh = get_write_handle (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1683                          uc->serialization);
1684   if (NULL == wh)
1685   {
1686     GNUNET_break (0);
1687     goto cleanup;
1688   }
1689   if (NULL != uc->ksk_uri)
1690     uris = GNUNET_FS_uri_to_string (uc->ksk_uri);
1691   else
1692     uris = NULL;
1693   if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uc->filename)) ||
1694       (GNUNET_OK != GNUNET_BIO_write_int64 (wh, uc->file_size)) ||
1695       (GNUNET_OK != write_start_time (wh, uc->start_time)) ||
1696       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->state)) ||
1697       (GNUNET_OK !=
1698        GNUNET_BIO_write (wh, &uc->chk, sizeof (struct ContentHashKey))) ||
1699       (GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1700       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->ksk_offset)) ||
1701       ((uc->state == UNINDEX_STATE_FS_NOTIFY) &&
1702        (GNUNET_OK !=
1703         GNUNET_BIO_write (wh, &uc->file_id, sizeof (struct GNUNET_HashCode)))) ||
1704       ((uc->state == UNINDEX_STATE_ERROR) &&
1705        (GNUNET_OK != GNUNET_BIO_write_string (wh, uc->emsg))))
1706   {
1707     GNUNET_break (0);
1708     goto cleanup;
1709   }
1710   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1711   {
1712     wh = NULL;
1713     GNUNET_break (0);
1714     goto cleanup;
1715   }
1716   return;
1717 cleanup:
1718   if (NULL != wh)
1719     (void) GNUNET_BIO_write_close (wh);
1720   GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1721                                uc->serialization);
1722   GNUNET_free (uc->serialization);
1723   uc->serialization = NULL;
1724 }
1725
1726
1727 /**
1728  * Serialize a download request.
1729  *
1730  * @param wh the `struct GNUNET_BIO_WriteHandle*`
1731  * @param dr the the request to write to disk
1732  * @return #GNUNET_YES on success, #GNUNET_NO on error
1733  */
1734 static int
1735 write_download_request (struct GNUNET_BIO_WriteHandle *wh,
1736                         struct DownloadRequest *dr)
1737 {
1738   unsigned int i;
1739
1740   if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->state)) ||
1741       (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dr->offset)) ||
1742       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->num_children)) ||
1743       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->depth)))
1744     return GNUNET_NO;
1745   if ((BRS_CHK_SET == dr->state) &&
1746       (GNUNET_OK !=
1747        GNUNET_BIO_write (wh, &dr->chk, sizeof (struct ContentHashKey))))
1748     return GNUNET_NO;
1749   for (i = 0; i < dr->num_children; i++)
1750     if (GNUNET_NO == write_download_request (wh, dr->children[i]))
1751       return GNUNET_NO;
1752   return GNUNET_YES;
1753 }
1754
1755
1756 /**
1757  * Read a download request tree.
1758  *
1759  * @param rh mesh to read from
1760  * @return value the download request read from disk, NULL on error
1761  */
1762 static struct DownloadRequest *
1763 read_download_request (struct GNUNET_BIO_ReadHandle *rh)
1764 {
1765   struct DownloadRequest *dr;
1766   unsigned int i;
1767
1768   dr = GNUNET_malloc (sizeof (struct DownloadRequest));
1769   if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->state)) ||
1770       (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dr->offset)) ||
1771       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->num_children)) ||
1772       (dr->num_children > CHK_PER_INODE) ||
1773       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->depth)) || ((0 == dr->depth)
1774                                                                 &&
1775                                                                 (dr->num_children
1776                                                                  > 0)) ||
1777       ((dr->depth > 0) && (0 == dr->num_children)))
1778   {
1779     GNUNET_break (0);
1780     dr->num_children = 0;
1781     goto cleanup;
1782   }
1783   if (dr->num_children > 0)
1784     dr->children =
1785         GNUNET_malloc (dr->num_children * sizeof (struct DownloadRequest *));
1786   switch (dr->state)
1787   {
1788   case BRS_INIT:
1789   case BRS_RECONSTRUCT_DOWN:
1790   case BRS_RECONSTRUCT_META_UP:
1791   case BRS_RECONSTRUCT_UP:
1792     break;
1793   case BRS_CHK_SET:
1794     if (GNUNET_OK !=
1795         GNUNET_BIO_read (rh, "chk", &dr->chk, sizeof (struct ContentHashKey)))
1796       goto cleanup;
1797     break;
1798   case BRS_DOWNLOAD_DOWN:
1799   case BRS_DOWNLOAD_UP:
1800   case BRS_ERROR:
1801     break;
1802   default:
1803     GNUNET_break (0);
1804     goto cleanup;
1805   }
1806   for (i = 0; i < dr->num_children; i++)
1807   {
1808     if (NULL == (dr->children[i] = read_download_request (rh)))
1809       goto cleanup;
1810     dr->children[i]->parent = dr;
1811   }
1812   return dr;
1813 cleanup:
1814   GNUNET_FS_free_download_request_ (dr);
1815   return NULL;
1816 }
1817
1818
1819 /**
1820  * Compute the name of the sync file (or directory) for the given download
1821  * context.
1822  *
1823  * @param dc download context to compute for
1824  * @param uni unique filename to use, use "" for the directory name
1825  * @param ext extension to use, use ".dir" for our own subdirectory
1826  * @return the expanded file name, NULL for none
1827  */
1828 static char *
1829 get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc,
1830                             const char *uni, const char *ext)
1831 {
1832   char *par;
1833   char *epar;
1834
1835   if (dc->parent == NULL)
1836     return get_serialization_file_name (dc->h,
1837                                         (dc->search != NULL) ?
1838                                         GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
1839                                         GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
1840                                         uni);
1841   if (NULL == dc->parent->serialization)
1842     return NULL;
1843   par = get_download_sync_filename (dc->parent, dc->parent->serialization, "");
1844   if (NULL == par)
1845     return NULL;
1846   GNUNET_asprintf (&epar, "%s.dir%s%s%s", par, DIR_SEPARATOR_STR, uni, ext);
1847   GNUNET_free (par);
1848   return epar;
1849 }
1850
1851
1852 /**
1853  * Synchronize this download struct with its mirror
1854  * on disk.  Note that all internal FS-operations that change
1855  * publishing structs should already call "sync" internally,
1856  * so this function is likely not useful for clients.
1857  *
1858  * @param dc the struct to sync
1859  */
1860 void
1861 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc)
1862 {
1863   struct GNUNET_BIO_WriteHandle *wh;
1864   char *uris;
1865   char *fn;
1866   char *dir;
1867
1868   if (0 != (dc->options & GNUNET_FS_DOWNLOAD_IS_PROBE))
1869     return; /* we don't sync probes */
1870   if (NULL == dc->serialization)
1871   {
1872     dir = get_download_sync_filename (dc, "", "");
1873     if (NULL == dir)
1874       return;
1875     if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dir))
1876     {
1877       GNUNET_free (dir);
1878       return;
1879     }
1880     fn = GNUNET_DISK_mktemp (dir);
1881     GNUNET_free (dir);
1882     if (NULL == fn)
1883       return;
1884     dc->serialization = get_serialization_short_name (fn);
1885   }
1886   else
1887   {
1888     fn = get_download_sync_filename (dc, dc->serialization, "");
1889     if (NULL == fn)
1890     {
1891       GNUNET_free (dc->serialization);
1892       dc->serialization = NULL;
1893       GNUNET_free (fn);
1894       return;
1895     }
1896   }
1897   wh = GNUNET_BIO_write_open (fn);
1898   if (NULL == wh)
1899   {
1900     GNUNET_free (dc->serialization);
1901     dc->serialization = NULL;
1902     GNUNET_free (fn);
1903     return;
1904   }
1905   GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_chk (dc->uri)) ||
1906                  (GNUNET_YES == GNUNET_FS_uri_test_loc (dc->uri)));
1907   uris = GNUNET_FS_uri_to_string (dc->uri);
1908   if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1909       (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, dc->meta)) ||
1910       (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->emsg)) ||
1911       (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->filename)) ||
1912       (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->temp_filename)) ||
1913       (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->old_file_size)) ||
1914       (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->offset)) ||
1915       (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->length)) ||
1916       (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->completed)) ||
1917       (GNUNET_OK != write_start_time (wh, dc->start_time)) ||
1918       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dc->anonymity)) ||
1919       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->options)) ||
1920       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->has_finished)))
1921   {
1922     GNUNET_break (0);
1923     goto cleanup;
1924   }
1925   if (NULL == dc->emsg)
1926   {
1927     GNUNET_assert (dc->top_request != NULL);
1928     if (GNUNET_YES != write_download_request (wh, dc->top_request))
1929     {
1930       GNUNET_break (0);
1931       goto cleanup;
1932     }
1933   }
1934   GNUNET_free_non_null (uris);
1935   uris = NULL;
1936   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1937   {
1938     wh = NULL;
1939     GNUNET_break (0);
1940     goto cleanup;
1941   }
1942   GNUNET_free (fn);
1943   return;
1944 cleanup:
1945   if (NULL != wh)
1946     (void) GNUNET_BIO_write_close (wh);
1947   GNUNET_free_non_null (uris);
1948   if (0 != UNLINK (fn))
1949     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1950   GNUNET_free (fn);
1951   GNUNET_free (dc->serialization);
1952   dc->serialization = NULL;
1953 }
1954
1955
1956 /**
1957  * Synchronize this search result with its mirror
1958  * on disk.  Note that all internal FS-operations that change
1959  * publishing structs should already call "sync" internally,
1960  * so this function is likely not useful for clients.
1961  *
1962  * @param sr the struct to sync
1963  */
1964 void
1965 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr)
1966 {
1967   struct GNUNET_BIO_WriteHandle *wh;
1968   char *uris;
1969
1970   if (NULL == sr->sc)
1971     return;
1972   uris = NULL;
1973   if (NULL == sr->serialization)
1974     sr->serialization =
1975         make_serialization_file_name_in_dir (sr->h,
1976                                              (sr->sc->psearch_result ==
1977                                               NULL) ?
1978                                              GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1979                                              GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1980                                              sr->sc->serialization);
1981   if (NULL == sr->serialization)
1982     return;
1983   wh = get_write_handle_in_dir (sr->h,
1984                                 (sr->sc->psearch_result ==
1985                                  NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1986                                 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1987                                 sr->sc->serialization, sr->serialization);
1988   if (NULL == wh)
1989   {
1990     GNUNET_break (0);
1991     goto cleanup;
1992   }
1993   uris = GNUNET_FS_uri_to_string (sr->uri);
1994   if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1995       (GNUNET_OK !=
1996        GNUNET_BIO_write_string (wh,
1997                                 sr->download !=
1998                                 NULL ? sr->download->serialization : NULL)) ||
1999       (GNUNET_OK !=
2000        GNUNET_BIO_write_string (wh,
2001                                 sr->update_search !=
2002                                 NULL ? sr->update_search->serialization : NULL))
2003       || (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, sr->meta)) ||
2004       (GNUNET_OK != GNUNET_BIO_write (wh, &sr->key, sizeof (struct GNUNET_HashCode)))
2005       || (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->mandatory_missing)) ||
2006       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->optional_support)) ||
2007       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_success)) ||
2008       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_trials)) )
2009   {
2010     GNUNET_break (0);
2011     goto cleanup;
2012   }
2013   if ( (NULL != sr->uri) &&
2014        (GNUNET_FS_URI_KSK == sr->sc->uri->type) &&
2015        (GNUNET_OK != GNUNET_BIO_write (wh, sr->keyword_bitmap,
2016                                        (sr->sc->uri->data.ksk.keywordCount + 7) / 8)) )
2017   {
2018     GNUNET_break (0);
2019     goto cleanup;
2020   }
2021   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
2022   {
2023     wh = NULL;
2024     GNUNET_break (0);
2025     goto cleanup;
2026   }
2027   GNUNET_free_non_null (uris);
2028   return;
2029 cleanup:
2030   GNUNET_free_non_null (uris);
2031   if (NULL != wh)
2032     (void) GNUNET_BIO_write_close (wh);
2033   remove_sync_file_in_dir (sr->h,
2034                            (NULL == sr->sc->psearch_result)
2035                            ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2036                            : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2037                            sr->sc->serialization, sr->serialization);
2038   GNUNET_free (sr->serialization);
2039   sr->serialization = NULL;
2040 }
2041
2042
2043 /**
2044  * Synchronize this search struct with its mirror
2045  * on disk.  Note that all internal FS-operations that change
2046  * publishing structs should already call "sync" internally,
2047  * so this function is likely not useful for clients.
2048  *
2049  * @param sc the struct to sync
2050  */
2051 void
2052 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc)
2053 {
2054   struct GNUNET_BIO_WriteHandle *wh;
2055   char *uris;
2056   char in_pause;
2057   const char *category;
2058
2059   category =
2060       (NULL == sc->psearch_result)
2061     ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2062     : GNUNET_FS_SYNC_PATH_CHILD_SEARCH;
2063   if (NULL == sc->serialization)
2064     sc->serialization = make_serialization_file_name (sc->h, category);
2065   if (NULL == sc->serialization)
2066     return;
2067   uris = NULL;
2068   wh = get_write_handle (sc->h, category, sc->serialization);
2069   if (NULL == wh)
2070   {
2071     GNUNET_break (0);
2072     goto cleanup;
2073   }
2074   GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_ksk (sc->uri)) ||
2075                  (GNUNET_YES == GNUNET_FS_uri_test_sks (sc->uri)));
2076   uris = GNUNET_FS_uri_to_string (sc->uri);
2077   in_pause = (sc->task != GNUNET_SCHEDULER_NO_TASK) ? 'r' : '\0';
2078   if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
2079       (GNUNET_OK != write_start_time (wh, sc->start_time)) ||
2080       (GNUNET_OK != GNUNET_BIO_write_string (wh, sc->emsg)) ||
2081       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) sc->options)) ||
2082       (GNUNET_OK != GNUNET_BIO_write (wh, &in_pause, sizeof (in_pause))) ||
2083       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sc->anonymity)))
2084   {
2085     GNUNET_break (0);
2086     goto cleanup;
2087   }
2088   GNUNET_free (uris);
2089   uris = NULL;
2090   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
2091   {
2092     wh = NULL;
2093     GNUNET_break (0);
2094     goto cleanup;
2095   }
2096   return;
2097 cleanup:
2098   if (NULL != wh)
2099     (void) GNUNET_BIO_write_close (wh);
2100   GNUNET_free_non_null (uris);
2101   GNUNET_FS_remove_sync_file_ (sc->h, category, sc->serialization);
2102   GNUNET_free (sc->serialization);
2103   sc->serialization = NULL;
2104 }
2105
2106
2107 /**
2108  * Function called with a filename of serialized unindexing operation
2109  * to deserialize.
2110  *
2111  * @param cls the 'struct GNUNET_FS_Handle*'
2112  * @param filename complete filename (absolute path)
2113  * @return GNUNET_OK (continue to iterate)
2114  */
2115 static int
2116 deserialize_unindex_file (void *cls, const char *filename)
2117 {
2118   struct GNUNET_FS_Handle *h = cls;
2119   struct GNUNET_BIO_ReadHandle *rh;
2120   struct GNUNET_FS_UnindexContext *uc;
2121   struct GNUNET_FS_ProgressInfo pi;
2122   char *emsg;
2123   char *uris;
2124   uint32_t state;
2125
2126   uc = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
2127   uc->h = h;
2128   uc->serialization = get_serialization_short_name (filename);
2129   rh = GNUNET_BIO_read_open (filename);
2130   if (NULL == rh)
2131   {
2132     GNUNET_break (0);
2133     goto cleanup;
2134   }
2135   uris = NULL;
2136   if ((GNUNET_OK !=
2137        GNUNET_BIO_read_string (rh, "unindex-fn", &uc->filename, 10 * 1024)) ||
2138       (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &uc->file_size)) ||
2139       (GNUNET_OK != read_start_time (rh, &uc->start_time)) ||
2140       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &state)) ||
2141       (GNUNET_OK != GNUNET_BIO_read (rh, "uri", &uc->chk, sizeof (struct ContentHashKey))) ||
2142       (GNUNET_OK != GNUNET_BIO_read_string (rh, "unindex-kskuri", &uris, 10 * 1024)) ||
2143       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &uc->ksk_offset)) )
2144   {
2145     GNUNET_free_non_null (uris);
2146     GNUNET_break (0);
2147     goto cleanup;
2148   }
2149   if (NULL != uris)
2150   {
2151     uc->ksk_uri = GNUNET_FS_uri_parse (uris, &emsg);
2152     GNUNET_free (uris);
2153     if (NULL == uc->ksk_uri)
2154     {
2155       GNUNET_break (0);
2156       GNUNET_free_non_null (emsg);
2157       goto cleanup;
2158     }
2159   }
2160   if ( (uc->ksk_offset > 0) &&
2161        ( (NULL == uc->ksk_uri) ||
2162          (uc->ksk_offset > uc->ksk_uri->data.ksk.keywordCount) ) )
2163   {
2164     GNUNET_break (0);
2165     goto cleanup;
2166   }
2167   uc->state = (enum UnindexState) state;
2168   switch (state)
2169   {
2170   case UNINDEX_STATE_HASHING:
2171     break;
2172   case UNINDEX_STATE_FS_NOTIFY:
2173     if (GNUNET_OK !=
2174         GNUNET_BIO_read (rh, "unindex-hash", &uc->file_id,
2175                          sizeof (struct GNUNET_HashCode)))
2176     {
2177       GNUNET_break (0);
2178       goto cleanup;
2179     }
2180     break;
2181   case UNINDEX_STATE_DS_REMOVE:
2182   case UNINDEX_STATE_EXTRACT_KEYWORDS:
2183   case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2184     break;
2185   case UNINDEX_STATE_COMPLETE:
2186     break;
2187   case UNINDEX_STATE_ERROR:
2188     if (GNUNET_OK !=
2189         GNUNET_BIO_read_string (rh, "unindex-emsg", &uc->emsg, 10 * 1024))
2190     {
2191       GNUNET_break (0);
2192       goto cleanup;
2193     }
2194     break;
2195   default:
2196     GNUNET_break (0);
2197     goto cleanup;
2198   }
2199   uc->top = GNUNET_FS_make_top (h, &GNUNET_FS_unindex_signal_suspend_, uc);
2200   pi.status = GNUNET_FS_STATUS_UNINDEX_RESUME;
2201   pi.value.unindex.specifics.resume.message = uc->emsg;
2202   GNUNET_FS_unindex_make_status_ (&pi, uc,
2203                                   (uc->state ==
2204                                    UNINDEX_STATE_COMPLETE) ? uc->file_size : 0);
2205   switch (uc->state)
2206   {
2207   case UNINDEX_STATE_HASHING:
2208     uc->fhc =
2209         GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, uc->filename,
2210                                  HASHING_BLOCKSIZE,
2211                                  &GNUNET_FS_unindex_process_hash_, uc);
2212     break;
2213   case UNINDEX_STATE_FS_NOTIFY:
2214     uc->state = UNINDEX_STATE_HASHING;
2215     GNUNET_FS_unindex_process_hash_ (uc, &uc->file_id);
2216     break;
2217   case UNINDEX_STATE_DS_REMOVE:
2218     GNUNET_FS_unindex_do_remove_ (uc);
2219     break;
2220   case UNINDEX_STATE_EXTRACT_KEYWORDS:
2221     GNUNET_FS_unindex_do_extract_keywords_ (uc);
2222     break;
2223   case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2224     GNUNET_FS_unindex_do_remove_kblocks_ (uc);
2225     break;
2226   case UNINDEX_STATE_COMPLETE:
2227   case UNINDEX_STATE_ERROR:
2228     /* no need to resume any operation, we were done */
2229     break;
2230   default:
2231     break;
2232   }
2233   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2234   {
2235     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2236                 _("Failure while resuming unindexing operation `%s': %s\n"),
2237                 filename, emsg);
2238     GNUNET_free (emsg);
2239   }
2240   return GNUNET_OK;
2241 cleanup:
2242   GNUNET_free_non_null (uc->filename);
2243   if ((NULL != rh) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
2244   {
2245     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2246                 _("Failed to resume unindexing operation `%s': %s\n"), filename,
2247                 emsg);
2248     GNUNET_free (emsg);
2249   }
2250   if (NULL != uc->serialization)
2251     GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2252                                  uc->serialization);
2253   GNUNET_free_non_null (uc->serialization);
2254   GNUNET_free (uc);
2255   return GNUNET_OK;
2256 }
2257
2258
2259 /**
2260  * Deserialize a download.
2261  *
2262  * @param h overall context
2263  * @param rh file to deserialize from
2264  * @param parent parent download
2265  * @param search associated search
2266  * @param serialization name under which the search was serialized
2267  */
2268 static void
2269 deserialize_download (struct GNUNET_FS_Handle *h,
2270                       struct GNUNET_BIO_ReadHandle *rh,
2271                       struct GNUNET_FS_DownloadContext *parent,
2272                       struct GNUNET_FS_SearchResult *search,
2273                       const char *serialization);
2274
2275
2276 /**
2277  * Deserialize a search.
2278  *
2279  * @param h overall context
2280  * @param rh file to deserialize from
2281  * @param psearch_result parent search result
2282  * @param serialization name under which the search was serialized
2283  */
2284 static struct GNUNET_FS_SearchContext *
2285 deserialize_search (struct GNUNET_FS_Handle *h,
2286                     struct GNUNET_BIO_ReadHandle *rh,
2287                     struct GNUNET_FS_SearchResult *psearch_result,
2288                     const char *serialization);
2289
2290
2291 /**
2292  * Function called with a filename of serialized search result
2293  * to deserialize.
2294  *
2295  * @param cls the 'struct GNUNET_FS_SearchContext*'
2296  * @param filename complete filename (absolute path)
2297  * @return GNUNET_OK (continue to iterate)
2298  */
2299 static int
2300 deserialize_search_result (void *cls, const char *filename)
2301 {
2302   struct GNUNET_FS_SearchContext *sc = cls;
2303   char *ser;
2304   char *uris;
2305   char *emsg;
2306   char *download;
2307   char *update_srch;
2308   struct GNUNET_BIO_ReadHandle *rh;
2309   struct GNUNET_BIO_ReadHandle *drh;
2310   struct GNUNET_FS_SearchResult *sr;
2311
2312   ser = get_serialization_short_name (filename);
2313   rh = GNUNET_BIO_read_open (filename);
2314   if (NULL == rh)
2315   {
2316     if (NULL != ser)
2317     {
2318       remove_sync_file_in_dir (sc->h,
2319                                (NULL == sc->psearch_result)
2320                                ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2321                                : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2322                                sc->serialization, ser);
2323       GNUNET_free (ser);
2324     }
2325     return GNUNET_OK;
2326   }
2327   emsg = NULL;
2328   uris = NULL;
2329   download = NULL;
2330   update_srch = NULL;
2331   sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
2332   sr->h = sc->h;
2333   sr->sc = sc;
2334   sr->serialization = ser;
2335   if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "result-uri", &uris, 10 * 1024))
2336       || (NULL == (sr->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2337       (GNUNET_OK != GNUNET_BIO_read_string (rh, "download-lnk", &download, 16))
2338       || (GNUNET_OK !=
2339           GNUNET_BIO_read_string (rh, "search-lnk", &update_srch, 16)) ||
2340       (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "result-meta", &sr->meta)) ||
2341       (GNUNET_OK !=
2342        GNUNET_BIO_read (rh, "result-key", &sr->key, sizeof (struct GNUNET_HashCode)))
2343       || (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->mandatory_missing)) ||
2344       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->optional_support)) ||
2345       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_success)) ||
2346       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_trials)))
2347   {
2348     GNUNET_break (0);
2349     goto cleanup;
2350   }
2351   if (GNUNET_FS_URI_KSK == sr->sc->uri->type)
2352   {
2353     sr->keyword_bitmap = GNUNET_malloc ((sr->sc->uri->data.ksk.keywordCount + 7) / 8); /* round up, count bits */
2354     if (GNUNET_OK != GNUNET_BIO_read (rh, "keyword-bitmap",
2355                                       sr->keyword_bitmap,
2356                                       (sr->sc->uri->data.ksk.keywordCount + 7) / 8))
2357     {
2358       GNUNET_break (0);
2359       goto cleanup;
2360     }
2361   }
2362   GNUNET_free (uris);
2363   if (NULL != download)
2364   {
2365     drh = get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD, download);
2366     if (NULL != drh)
2367     {
2368       deserialize_download (sc->h, drh, NULL, sr, download);
2369       if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2370       {
2371         GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2372                     _("Failed to resume sub-download `%s': %s\n"), download,
2373                     emsg);
2374         GNUNET_free (emsg);
2375       }
2376     }
2377     GNUNET_free (download);
2378   }
2379   if (NULL != update_srch)
2380   {
2381     drh =
2382         get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_SEARCH, update_srch);
2383     if (NULL != drh)
2384     {
2385       deserialize_search (sc->h, drh, sr, update_srch);
2386       if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2387       {
2388         GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2389                     _("Failed to resume sub-search `%s': %s\n"), update_srch,
2390                     emsg);
2391         GNUNET_free (emsg);
2392       }
2393     }
2394     GNUNET_free (update_srch);
2395   }
2396   GNUNET_break (GNUNET_YES ==
2397                 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &sr->key, sr,
2398                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
2399   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2400   {
2401     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2402                 _("Failure while resuming search operation `%s': %s\n"),
2403                 filename, emsg);
2404     GNUNET_free (emsg);
2405   }
2406   return GNUNET_OK;
2407 cleanup:
2408   GNUNET_free_non_null (download);
2409   GNUNET_free_non_null (emsg);
2410   GNUNET_free_non_null (uris);
2411   GNUNET_free_non_null (update_srch);
2412   if (NULL != sr->uri)
2413     GNUNET_FS_uri_destroy (sr->uri);
2414   if (NULL != sr->meta)
2415     GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2416   GNUNET_free (sr->serialization);
2417   GNUNET_free (sr);
2418   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2419   {
2420     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2421                 _("Failure while resuming search operation `%s': %s\n"),
2422                 filename, emsg);
2423     GNUNET_free (emsg);
2424   }
2425   return GNUNET_OK;
2426 }
2427
2428
2429 /**
2430  * Send the 'resume' signal to the callback; also actually
2431  * resume the download (put it in the queue).  Does this
2432  * recursively for the top-level download and all child
2433  * downloads.
2434  *
2435  * @param dc download to resume
2436  */
2437 static void
2438 signal_download_resume (struct GNUNET_FS_DownloadContext *dc)
2439 {
2440   struct GNUNET_FS_DownloadContext *dcc;
2441   struct GNUNET_FS_ProgressInfo pi;
2442
2443   pi.status = GNUNET_FS_STATUS_DOWNLOAD_RESUME;
2444   pi.value.download.specifics.resume.meta = dc->meta;
2445   pi.value.download.specifics.resume.message = dc->emsg;
2446   GNUNET_FS_download_make_status_ (&pi, dc);
2447   dcc = dc->child_head;
2448   while (NULL != dcc)
2449   {
2450     signal_download_resume (dcc);
2451     dcc = dcc->next;
2452   }
2453   if (NULL != dc->pending_head)
2454     GNUNET_FS_download_start_downloading_ (dc);
2455 }
2456
2457
2458 /**
2459  * Signal resuming of a search to our clients (for the
2460  * top level search and all sub-searches).
2461  *
2462  * @param sc search being resumed
2463  */
2464 static void
2465 signal_search_resume (struct GNUNET_FS_SearchContext *sc);
2466
2467
2468 /**
2469  * Iterator over search results signaling resume to the client for
2470  * each result.
2471  *
2472  * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2473  * @param key current key code
2474  * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2475  * @return GNUNET_YES (we should continue to iterate)
2476  */
2477 static int
2478 signal_result_resume (void *cls, const struct GNUNET_HashCode * key, void *value)
2479 {
2480   struct GNUNET_FS_SearchContext *sc = cls;
2481   struct GNUNET_FS_ProgressInfo pi;
2482   struct GNUNET_FS_SearchResult *sr = value;
2483
2484   if (0 == sr->mandatory_missing)
2485   {
2486     pi.status = GNUNET_FS_STATUS_SEARCH_RESUME_RESULT;
2487     pi.value.search.specifics.resume_result.meta = sr->meta;
2488     pi.value.search.specifics.resume_result.uri = sr->uri;
2489     pi.value.search.specifics.resume_result.result = sr;
2490     pi.value.search.specifics.resume_result.availability_rank =
2491         2 * sr->availability_success - sr->availability_trials;
2492     pi.value.search.specifics.resume_result.availability_certainty =
2493         sr->availability_trials;
2494     pi.value.search.specifics.resume_result.applicability_rank =
2495         sr->optional_support;
2496     sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
2497   }
2498   if (NULL != sr->download)
2499   {
2500     signal_download_resume (sr->download);
2501   }
2502   else
2503   {
2504     GNUNET_FS_search_start_probe_ (sr);
2505   }
2506   if (NULL != sr->update_search)
2507     signal_search_resume (sr->update_search);
2508   return GNUNET_YES;
2509 }
2510
2511
2512 /**
2513  * Free memory allocated by the search context and its children
2514  *
2515  * @param sc search context to free
2516  */
2517 static void
2518 free_search_context (struct GNUNET_FS_SearchContext *sc);
2519
2520
2521 /**
2522  * Iterator over search results freeing each.
2523  *
2524  * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2525  * @param key current key code
2526  * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2527  * @return GNUNET_YES (we should continue to iterate)
2528  */
2529 static int
2530 free_result (void *cls, const struct GNUNET_HashCode * key, void *value)
2531 {
2532   struct GNUNET_FS_SearchResult *sr = value;
2533
2534   if (NULL != sr->update_search)
2535   {
2536     free_search_context (sr->update_search);
2537     GNUNET_assert (NULL == sr->update_search);
2538   }
2539   GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2540   GNUNET_FS_uri_destroy (sr->uri);
2541   GNUNET_free (sr);
2542   return GNUNET_YES;
2543 }
2544
2545
2546 /**
2547  * Free memory allocated by the search context and its children
2548  *
2549  * @param sc search context to free
2550  */
2551 static void
2552 free_search_context (struct GNUNET_FS_SearchContext *sc)
2553 {
2554   if (NULL != sc->serialization)
2555   {
2556     GNUNET_FS_remove_sync_file_ (sc->h,
2557                                  (sc->psearch_result ==
2558                                   NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2559                                  GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2560                                  sc->serialization);
2561     GNUNET_FS_remove_sync_dir_ (sc->h,
2562                                 (sc->psearch_result ==
2563                                  NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2564                                 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2565                                 sc->serialization);
2566   }
2567   GNUNET_free_non_null (sc->serialization);
2568   GNUNET_free_non_null (sc->emsg);
2569   if (NULL != sc->uri)
2570     GNUNET_FS_uri_destroy (sc->uri);
2571   if (NULL != sc->master_result_map)
2572   {
2573     GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map, &free_result,
2574                                            sc);
2575     GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
2576   }
2577   GNUNET_free (sc);
2578 }
2579
2580
2581 /**
2582  * Function called with a filename of serialized sub-download
2583  * to deserialize.
2584  *
2585  * @param cls the 'struct GNUNET_FS_DownloadContext*' (parent)
2586  * @param filename complete filename (absolute path)
2587  * @return GNUNET_OK (continue to iterate)
2588  */
2589 static int
2590 deserialize_subdownload (void *cls, const char *filename)
2591 {
2592   struct GNUNET_FS_DownloadContext *parent = cls;
2593   char *ser;
2594   char *emsg;
2595   struct GNUNET_BIO_ReadHandle *rh;
2596
2597   ser = get_serialization_short_name (filename);
2598   rh = GNUNET_BIO_read_open (filename);
2599   if (NULL == rh)
2600   {
2601     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2602                 _
2603                 ("Failed to resume sub-download `%s': could not open file `%s'\n"),
2604                 ser, filename);
2605     GNUNET_free (ser);
2606     return GNUNET_OK;
2607   }
2608   deserialize_download (parent->h, rh, parent, NULL, ser);
2609   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2610   {
2611     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2612                 _("Failed to resume sub-download `%s': %s\n"), ser, emsg);
2613     GNUNET_free (emsg);
2614   }
2615   GNUNET_free (ser);
2616   return GNUNET_OK;
2617 }
2618
2619
2620 /**
2621  * Free this download context and all of its descendants.
2622  * (only works during deserialization since not all possible
2623  * state it taken care of).
2624  *
2625  * @param dc context to free
2626  */
2627 static void
2628 free_download_context (struct GNUNET_FS_DownloadContext *dc)
2629 {
2630   struct GNUNET_FS_DownloadContext *dcc;
2631
2632   if (NULL != dc->meta)
2633     GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2634   if (NULL != dc->uri)
2635     GNUNET_FS_uri_destroy (dc->uri);
2636   GNUNET_free_non_null (dc->temp_filename);
2637   GNUNET_free_non_null (dc->emsg);
2638   GNUNET_free_non_null (dc->filename);
2639   GNUNET_free_non_null (dc->serialization);
2640   while (NULL != (dcc = dc->child_head))
2641   {
2642     GNUNET_CONTAINER_DLL_remove (dc->child_head, dc->child_tail, dcc);
2643     free_download_context (dcc);
2644   }
2645   GNUNET_FS_free_download_request_ (dc->top_request);
2646   if (NULL != dc->active)
2647     GNUNET_CONTAINER_multihashmap_destroy (dc->active);
2648   GNUNET_free (dc);
2649 }
2650
2651
2652 /**
2653  * Deserialize a download.
2654  *
2655  * @param h overall context
2656  * @param rh file to deserialize from
2657  * @param parent parent download
2658  * @param search associated search
2659  * @param serialization name under which the search was serialized
2660  */
2661 static void
2662 deserialize_download (struct GNUNET_FS_Handle *h,
2663                       struct GNUNET_BIO_ReadHandle *rh,
2664                       struct GNUNET_FS_DownloadContext *parent,
2665                       struct GNUNET_FS_SearchResult *search,
2666                       const char *serialization)
2667 {
2668   struct GNUNET_FS_DownloadContext *dc;
2669   char *emsg;
2670   char *uris;
2671   char *dn;
2672   uint32_t options;
2673   uint32_t status;
2674
2675   uris = NULL;
2676   emsg = NULL;
2677   dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2678   dc->parent = parent;
2679   dc->h = h;
2680   dc->serialization = GNUNET_strdup (serialization);
2681   if ((GNUNET_OK !=
2682        GNUNET_BIO_read_string (rh, "download-uri", &uris, 10 * 1024)) ||
2683       (NULL == (dc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2684       ((GNUNET_YES != GNUNET_FS_uri_test_chk (dc->uri)) &&
2685        (GNUNET_YES != GNUNET_FS_uri_test_loc (dc->uri))) ||
2686       (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "download-meta", &dc->meta))
2687       || (GNUNET_OK !=
2688           GNUNET_BIO_read_string (rh, "download-emsg", &dc->emsg, 10 * 1024)) ||
2689       (GNUNET_OK !=
2690        GNUNET_BIO_read_string (rh, "download-fn", &dc->filename, 10 * 1024)) ||
2691       (GNUNET_OK !=
2692        GNUNET_BIO_read_string (rh, "download-tfn", &dc->temp_filename,
2693                                10 * 1024)) ||
2694       (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->old_file_size)) ||
2695       (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->offset)) ||
2696       (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->length)) ||
2697       (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->completed)) ||
2698       (GNUNET_OK != read_start_time (rh, &dc->start_time)) ||
2699       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dc->anonymity)) ||
2700       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2701       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &status)))
2702   {
2703     GNUNET_break (0);
2704     goto cleanup;
2705   }
2706   dc->options = (enum GNUNET_FS_DownloadOptions) options;
2707   dc->active =
2708     GNUNET_CONTAINER_multihashmap_create (1 + 2 * (dc->length / DBLOCK_SIZE), GNUNET_NO);
2709   dc->has_finished = (int) status;
2710   dc->treedepth =
2711       GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
2712   if (GNUNET_FS_uri_test_loc (dc->uri))
2713     GNUNET_assert (GNUNET_OK ==
2714                    GNUNET_FS_uri_loc_get_peer_identity (dc->uri, &dc->target));
2715   if (NULL == dc->emsg)
2716   {
2717     dc->top_request = read_download_request (rh);
2718     if (NULL == dc->top_request)
2719     {
2720       GNUNET_break (0);
2721       goto cleanup;
2722     }
2723   }
2724   dn = get_download_sync_filename (dc, dc->serialization, ".dir");
2725   if (NULL != dn)
2726   {
2727     if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
2728       GNUNET_DISK_directory_scan (dn, &deserialize_subdownload, dc);
2729     GNUNET_free (dn);
2730   }
2731   if (NULL != parent)
2732   {
2733     GNUNET_CONTAINER_DLL_insert (parent->child_head, parent->child_tail, dc);
2734   }
2735   if (NULL != search)
2736   {
2737     dc->search = search;
2738     search->download = dc;
2739   }
2740   if ((NULL == parent) && (NULL == search))
2741   {
2742     dc->top =
2743         GNUNET_FS_make_top (dc->h, &GNUNET_FS_download_signal_suspend_, dc);
2744     signal_download_resume (dc);
2745   }
2746   GNUNET_free (uris);
2747   dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_, dc);
2748   return;
2749 cleanup:
2750   GNUNET_free_non_null (uris);
2751   GNUNET_free_non_null (emsg);
2752   free_download_context (dc);
2753 }
2754
2755
2756 /**
2757  * Signal resuming of a search to our clients (for the
2758  * top level search and all sub-searches).
2759  *
2760  * @param sc search being resumed
2761  */
2762 static void
2763 signal_search_resume (struct GNUNET_FS_SearchContext *sc)
2764 {
2765   struct GNUNET_FS_ProgressInfo pi;
2766
2767   pi.status = GNUNET_FS_STATUS_SEARCH_RESUME;
2768   pi.value.search.specifics.resume.message = sc->emsg;
2769   pi.value.search.specifics.resume.is_paused =
2770       (NULL == sc->client) ? GNUNET_YES : GNUNET_NO;
2771   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
2772   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2773                                          &signal_result_resume, sc);
2774
2775 }
2776
2777
2778 /**
2779  * Deserialize a search.
2780  *
2781  * @param h overall context
2782  * @param rh file to deserialize from
2783  * @param psearch_result parent search result
2784  * @param serialization name under which the search was serialized
2785  */
2786 static struct GNUNET_FS_SearchContext *
2787 deserialize_search (struct GNUNET_FS_Handle *h,
2788                     struct GNUNET_BIO_ReadHandle *rh,
2789                     struct GNUNET_FS_SearchResult *psearch_result,
2790                     const char *serialization)
2791 {
2792   struct GNUNET_FS_SearchContext *sc;
2793   char *emsg;
2794   char *uris;
2795   char *dn;
2796   uint32_t options;
2797   char in_pause;
2798
2799   if ((NULL != psearch_result) && (NULL != psearch_result->update_search))
2800   {
2801     GNUNET_break (0);
2802     return NULL;
2803   }
2804   uris = NULL;
2805   emsg = NULL;
2806   sc = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchContext));
2807   if (NULL != psearch_result)
2808   {
2809     sc->psearch_result = psearch_result;
2810     psearch_result->update_search = sc;
2811   }
2812   sc->h = h;
2813   sc->serialization = GNUNET_strdup (serialization);
2814   if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "search-uri", &uris, 10 * 1024))
2815       || (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2816       ((GNUNET_YES != GNUNET_FS_uri_test_ksk (sc->uri)) &&
2817        (GNUNET_YES != GNUNET_FS_uri_test_sks (sc->uri))) ||
2818       (GNUNET_OK != read_start_time (rh, &sc->start_time)) ||
2819       (GNUNET_OK !=
2820        GNUNET_BIO_read_string (rh, "search-emsg", &sc->emsg, 10 * 1024)) ||
2821       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2822       (GNUNET_OK !=
2823        GNUNET_BIO_read (rh, "search-pause", &in_pause, sizeof (in_pause))) ||
2824       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sc->anonymity)))
2825   {
2826     GNUNET_break (0);
2827     goto cleanup;
2828   }
2829   sc->options = (enum GNUNET_FS_SearchOptions) options;
2830   sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_NO);
2831   dn = get_serialization_file_name_in_dir (h,
2832                                            (sc->psearch_result ==
2833                                             NULL) ?
2834                                            GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2835                                            GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2836                                            sc->serialization, "");
2837   if (NULL != dn)
2838   {
2839     if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
2840       GNUNET_DISK_directory_scan (dn, &deserialize_search_result, sc);
2841     GNUNET_free (dn);
2842   }
2843   if (('\0' == in_pause) &&
2844       (GNUNET_OK != GNUNET_FS_search_start_searching_ (sc)))
2845   {
2846     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2847                 _
2848                 ("Could not resume running search, will resume as paused search\n"));
2849   }
2850   signal_search_resume (sc);
2851   GNUNET_free (uris);
2852   return sc;
2853 cleanup:
2854   GNUNET_free_non_null (emsg);
2855   free_search_context (sc);
2856   GNUNET_free_non_null (uris);
2857   return NULL;
2858 }
2859
2860
2861 /**
2862  * Function called with a filename of serialized search operation
2863  * to deserialize.
2864  *
2865  * @param cls the 'struct GNUNET_FS_Handle*'
2866  * @param filename complete filename (absolute path)
2867  * @return GNUNET_OK (continue to iterate)
2868  */
2869 static int
2870 deserialize_search_file (void *cls, const char *filename)
2871 {
2872   struct GNUNET_FS_Handle *h = cls;
2873   char *ser;
2874   char *emsg;
2875   struct GNUNET_BIO_ReadHandle *rh;
2876   struct GNUNET_FS_SearchContext *sc;
2877   struct stat buf;
2878
2879   if (0 != STAT (filename, &buf))
2880   {
2881     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "stat", filename);
2882     return GNUNET_OK;
2883   }
2884   if (S_ISDIR (buf.st_mode))
2885     return GNUNET_OK; /* skip directories */
2886   ser = get_serialization_short_name (filename);
2887   rh = GNUNET_BIO_read_open (filename);
2888   if (NULL == rh)
2889   {
2890     if (NULL != ser)
2891     {
2892       GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, ser);
2893       GNUNET_free (ser);
2894     }
2895     return GNUNET_OK;
2896   }
2897   sc = deserialize_search (h, rh, NULL, ser);
2898   if (NULL != sc)
2899     sc->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, sc);
2900   GNUNET_free (ser);
2901   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2902   {
2903     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2904                 _("Failure while resuming search operation `%s': %s\n"),
2905                 filename, emsg);
2906     GNUNET_free (emsg);
2907   }
2908   return GNUNET_OK;
2909 }
2910
2911
2912 /**
2913  * Function called with a filename of serialized download operation
2914  * to deserialize.
2915  *
2916  * @param cls the 'struct GNUNET_FS_Handle*'
2917  * @param filename complete filename (absolute path)
2918  * @return GNUNET_OK (continue to iterate)
2919  */
2920 static int
2921 deserialize_download_file (void *cls, const char *filename)
2922 {
2923   struct GNUNET_FS_Handle *h = cls;
2924   char *ser;
2925   char *emsg;
2926   struct GNUNET_BIO_ReadHandle *rh;
2927
2928   ser = get_serialization_short_name (filename);
2929   rh = GNUNET_BIO_read_open (filename);
2930   if (NULL == rh)
2931   {
2932     if (0 != UNLINK (filename))
2933       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
2934     GNUNET_free (ser);
2935     return GNUNET_OK;
2936   }
2937   deserialize_download (h, rh, NULL, NULL, ser);
2938   GNUNET_free (ser);
2939   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2940   {
2941     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2942                 _("Failure while resuming download operation `%s': %s\n"),
2943                 filename, emsg);
2944     GNUNET_free (emsg);
2945   }
2946   return GNUNET_OK;
2947 }
2948
2949
2950 /**
2951  * Deserialize informatin about pending operations.
2952  *
2953  * @param master_path which master directory should be scanned
2954  * @param proc function to call for each entry (will get 'h' for 'cls')
2955  * @param h the 'struct GNUNET_FS_Handle*'
2956  */
2957 static void
2958 deserialization_master (const char *master_path, GNUNET_FileNameCallback proc,
2959                         struct GNUNET_FS_Handle *h)
2960 {
2961   char *dn;
2962
2963   dn = get_serialization_file_name (h, master_path, "");
2964   if (NULL == dn)
2965     return;
2966   if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
2967     GNUNET_DISK_directory_scan (dn, proc, h);
2968   GNUNET_free (dn);
2969 }
2970
2971
2972 /**
2973  * Setup a connection to the file-sharing service.
2974  *
2975  * @param cfg configuration to use
2976  * @param client_name unique identifier for this client
2977  * @param upcb function to call to notify about FS actions
2978  * @param upcb_cls closure for upcb
2979  * @param flags specific attributes for fs-operations
2980  * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
2981  * @return NULL on error
2982  */
2983 struct GNUNET_FS_Handle *
2984 GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
2985                  const char *client_name, GNUNET_FS_ProgressCallback upcb,
2986                  void *upcb_cls, enum GNUNET_FS_Flags flags, ...)
2987 {
2988   struct GNUNET_FS_Handle *ret;
2989   enum GNUNET_FS_OPTIONS opt;
2990   va_list ap;
2991
2992   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Handle));
2993   ret->cfg = cfg;
2994   ret->client_name = GNUNET_strdup (client_name);
2995   ret->upcb = upcb;
2996   ret->upcb_cls = upcb_cls;
2997   ret->flags = flags;
2998   ret->max_parallel_downloads = DEFAULT_MAX_PARALLEL_DOWNLOADS;
2999   ret->max_parallel_requests = DEFAULT_MAX_PARALLEL_REQUESTS;
3000   ret->avg_block_latency = GNUNET_TIME_UNIT_MINUTES;    /* conservative starting point */
3001   va_start (ap, flags);
3002   while (GNUNET_FS_OPTIONS_END != (opt = va_arg (ap, enum GNUNET_FS_OPTIONS)))
3003   {
3004     switch (opt)
3005     {
3006     case GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM:
3007       ret->max_parallel_downloads = va_arg (ap, unsigned int);
3008
3009       break;
3010     case GNUNET_FS_OPTIONS_REQUEST_PARALLELISM:
3011       ret->max_parallel_requests = va_arg (ap, unsigned int);
3012
3013       break;
3014     default:
3015       GNUNET_break (0);
3016       GNUNET_free (ret->client_name);
3017       GNUNET_free (ret);
3018       va_end (ap);
3019       return NULL;
3020     }
3021   }
3022   va_end (ap);
3023   if (0 != (GNUNET_FS_FLAGS_PERSISTENCE & flags))
3024   {
3025     deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
3026                             &deserialize_publish_file, ret);
3027     deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
3028                             &deserialize_search_file, ret);
3029     deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
3030                             &deserialize_download_file, ret);
3031     deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
3032                             &deserialize_unindex_file, ret);
3033   }
3034   return ret;
3035 }
3036
3037
3038 /**
3039  * Close our connection with the file-sharing service.
3040  * The callback given to GNUNET_FS_start will no longer be
3041  * called after this function returns.
3042  *
3043  * @param h handle that was returned from GNUNET_FS_start
3044  */
3045 void
3046 GNUNET_FS_stop (struct GNUNET_FS_Handle *h)
3047 {
3048   while (h->top_head != NULL)
3049     h->top_head->ssf (h->top_head->ssf_cls);
3050   if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
3051     GNUNET_SCHEDULER_cancel (h->queue_job);
3052   GNUNET_free (h->client_name);
3053   GNUNET_free (h);
3054 }
3055
3056
3057 /* end of fs.c */