-fixing #3034
[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_malloc (sizeof (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, const char *filename)
1048 {
1049   struct GNUNET_FS_FileInformation *ret;
1050   struct GNUNET_BIO_ReadHandle *rh;
1051   char *emsg;
1052   char *fn;
1053
1054   rh = get_read_handle (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
1055   if (NULL == rh)
1056     return NULL;
1057   ret = deserialize_fi_node (h, filename, rh);
1058   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1059   {
1060     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1061                 _("Failed to resume publishing information `%s': %s\n"),
1062                 filename, emsg);
1063     GNUNET_free (emsg);
1064   }
1065   if (NULL == ret)
1066   {
1067     fn = get_serialization_file_name (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
1068     if (NULL != fn)
1069     {
1070       if (0 != UNLINK (fn))
1071         GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1072       GNUNET_free (fn);
1073     }
1074   }
1075   return ret;
1076 }
1077
1078
1079 /**
1080  * Given a serialization name (full absolute path), return the
1081  * basename of the file (without the path), which must only
1082  * consist of the 6 random characters.
1083  *
1084  * @param fullname name to extract the basename from
1085  * @return copy of the basename, NULL on error
1086  */
1087 static char *
1088 get_serialization_short_name (const char *fullname)
1089 {
1090   const char *end;
1091   const char *nxt;
1092
1093   end = NULL;
1094   nxt = fullname;
1095   /* FIXME: we could do this faster since we know
1096    * the length of 'end'... */
1097   while ('\0' != *nxt)
1098   {
1099     if (DIR_SEPARATOR == *nxt)
1100       end = nxt + 1;
1101     nxt++;
1102   }
1103   if ((NULL == end) || (0 == strlen (end)))
1104   {
1105     GNUNET_break (0);
1106     return NULL;
1107   }
1108   GNUNET_break (6 == strlen (end));
1109   return GNUNET_strdup (end);
1110 }
1111
1112
1113 /**
1114  * Create a new random name for serialization.  Also checks if persistence
1115  * is enabled and returns NULL if not.
1116  *
1117  * @param h master context
1118  * @param ext component of the path
1119  * @return NULL on errror
1120  */
1121 static char *
1122 make_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext)
1123 {
1124   char *fn;
1125   char *dn;
1126   char *ret;
1127
1128   if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1129     return NULL;                /* persistence not requested */
1130   dn = get_serialization_file_name (h, ext, "");
1131   if (NULL == dn)
1132     return NULL;
1133   if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1134   {
1135     GNUNET_free (dn);
1136     return NULL;
1137   }
1138   fn = GNUNET_DISK_mktemp (dn);
1139   GNUNET_free (dn);
1140   if (NULL == fn)
1141     return NULL;                /* epic fail */
1142   ret = get_serialization_short_name (fn);
1143   GNUNET_free (fn);
1144   return ret;
1145 }
1146
1147
1148 /**
1149  * Create a new random name for serialization.  Also checks if persistence
1150  * is enabled and returns NULL if not.
1151  *
1152  * @param h master context
1153  * @param ext component of the path
1154  * @param uni name of parent
1155  * @return NULL on errror
1156  */
1157 static char *
1158 make_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h,
1159                                      const char *ext, const char *uni)
1160 {
1161   char *fn;
1162   char *dn;
1163   char *ret;
1164
1165   if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1166     return NULL;                /* persistence not requested */
1167   dn = get_serialization_file_name_in_dir (h, ext, uni, "");
1168   if (NULL == dn)
1169     return NULL;
1170   if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1171   {
1172     GNUNET_free (dn);
1173     return NULL;
1174   }
1175   fn = GNUNET_DISK_mktemp (dn);
1176   GNUNET_free (dn);
1177   if (NULL == fn)
1178     return NULL;                /* epic fail */
1179   ret = get_serialization_short_name (fn);
1180   GNUNET_free (fn);
1181   return ret;
1182 }
1183
1184
1185 /**
1186  * Copy all of the data from the reader to the write handle.
1187  *
1188  * @param wh write handle
1189  * @param fi file with reader
1190  * @return #GNUNET_OK on success
1191  */
1192 static int
1193 copy_from_reader (struct GNUNET_BIO_WriteHandle *wh,
1194                   struct GNUNET_FS_FileInformation *fi)
1195 {
1196   char buf[32 * 1024];
1197   uint64_t off;
1198   size_t ret;
1199   size_t left;
1200   char *emsg;
1201
1202   emsg = NULL;
1203   off = 0;
1204   while (off < fi->data.file.file_size)
1205   {
1206     left = GNUNET_MIN (sizeof (buf), fi->data.file.file_size - off);
1207     ret =
1208         fi->data.file.reader (fi->data.file.reader_cls, off, left, buf, &emsg);
1209     if (0 == ret)
1210     {
1211       GNUNET_free (emsg);
1212       return GNUNET_SYSERR;
1213     }
1214     if (GNUNET_OK != GNUNET_BIO_write (wh, buf, ret))
1215       return GNUNET_SYSERR;
1216     off += ret;
1217   }
1218   return GNUNET_OK;
1219 }
1220
1221
1222 /**
1223  * Create a temporary file on disk to store the current
1224  * state of "fi" in.
1225  *
1226  * @param fi file information to sync with disk
1227  */
1228 void
1229 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *fi)
1230 {
1231   char *fn;
1232   struct GNUNET_BIO_WriteHandle *wh;
1233   char b;
1234   char *ksks;
1235   char *chks;
1236
1237   if (NULL == fi->serialization)
1238     fi->serialization =
1239         make_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO);
1240   if (NULL == fi->serialization)
1241     return;
1242   wh = get_write_handle (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1243                          fi->serialization);
1244   if (NULL == wh)
1245   {
1246     GNUNET_free (fi->serialization);
1247     fi->serialization = NULL;
1248     return;
1249   }
1250   if (GNUNET_YES == fi->is_directory)
1251     b = 4;
1252   else if (GNUNET_YES == fi->data.file.index_start_confirmed)
1253     b = 3;
1254   else if (GNUNET_YES == fi->data.file.have_hash)
1255     b = 2;
1256   else if (GNUNET_YES == fi->data.file.do_index)
1257     b = 1;
1258   else
1259     b = 0;
1260   if (NULL != fi->keywords)
1261     ksks = GNUNET_FS_uri_to_string (fi->keywords);
1262   else
1263     ksks = NULL;
1264   if (NULL != fi->chk_uri)
1265     chks = GNUNET_FS_uri_to_string (fi->chk_uri);
1266   else
1267     chks = NULL;
1268   if ((GNUNET_OK != GNUNET_BIO_write (wh, &b, sizeof (b))) ||
1269       (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, fi->meta)) ||
1270       (GNUNET_OK != GNUNET_BIO_write_string (wh, ksks)) ||
1271       (GNUNET_OK != GNUNET_BIO_write_string (wh, chks)) ||
1272       (GNUNET_OK != write_start_time (wh, fi->start_time)) ||
1273       (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->emsg)) ||
1274       (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->filename)) ||
1275       (GNUNET_OK !=
1276        GNUNET_BIO_write_int64 (wh, fi->bo.expiration_time.abs_value_us)) ||
1277       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.anonymity_level)) ||
1278       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.content_priority)) ||
1279       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.replication_level)))
1280   {
1281     GNUNET_break (0);
1282     goto cleanup;
1283   }
1284   GNUNET_free_non_null (chks);
1285   chks = NULL;
1286   GNUNET_free_non_null (ksks);
1287   ksks = NULL;
1288
1289   switch (b)
1290   {
1291   case 0:                      /* file-insert */
1292     if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1293     {
1294       GNUNET_break (0);
1295       goto cleanup;
1296     }
1297     if ((GNUNET_NO == fi->is_published) && (NULL == fi->filename))
1298       if (GNUNET_OK != copy_from_reader (wh, fi))
1299       {
1300         GNUNET_break (0);
1301         goto cleanup;
1302       }
1303     break;
1304   case 1:                      /* file-index, no hash */
1305     if (NULL == fi->filename)
1306     {
1307       GNUNET_break (0);
1308       goto cleanup;
1309     }
1310     if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1311     {
1312       GNUNET_break (0);
1313       goto cleanup;
1314     }
1315     break;
1316   case 2:                      /* file-index-with-hash */
1317   case 3:                      /* file-index-with-hash-confirmed */
1318     if (NULL == fi->filename)
1319     {
1320       GNUNET_break (0);
1321       goto cleanup;
1322     }
1323     if ((GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size)) ||
1324         (GNUNET_OK !=
1325          GNUNET_BIO_write (wh, &fi->data.file.file_id,
1326                            sizeof (struct GNUNET_HashCode))))
1327     {
1328       GNUNET_break (0);
1329       goto cleanup;
1330     }
1331     break;
1332   case 4:                      /* directory */
1333     if ( (NULL != fi->data.dir.entries) &&
1334          (NULL == fi->data.dir.entries->serialization) )
1335       GNUNET_FS_file_information_sync_ (fi->data.dir.entries);
1336     if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->data.dir.dir_size)) ||
1337         (GNUNET_OK !=
1338          GNUNET_BIO_write (wh, fi->data.dir.dir_data,
1339                            (uint32_t) fi->data.dir.dir_size)) ||
1340         (GNUNET_OK !=
1341          GNUNET_BIO_write_string (wh,
1342                                   (fi->data.dir.entries ==
1343                                    NULL) ? NULL : fi->data.dir.
1344                                   entries->serialization)))
1345     {
1346       GNUNET_break (0);
1347       goto cleanup;
1348     }
1349     break;
1350   default:
1351     GNUNET_assert (0);
1352     goto cleanup;
1353   }
1354   if ( (NULL != fi->next) &&
1355        (NULL == fi->next->serialization) )
1356     GNUNET_FS_file_information_sync_ (fi->next);
1357   if (GNUNET_OK !=
1358       GNUNET_BIO_write_string (wh,
1359                                (fi->next !=
1360                                 NULL) ? fi->next->serialization : NULL))
1361   {
1362     GNUNET_break (0);
1363     goto cleanup;
1364   }
1365   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1366   {
1367     wh = NULL;
1368     GNUNET_break (0);
1369     goto cleanup;
1370   }
1371   return;                       /* done! */
1372 cleanup:
1373   if (NULL != wh)
1374     (void) GNUNET_BIO_write_close (wh);
1375   GNUNET_free_non_null (chks);
1376   GNUNET_free_non_null (ksks);
1377   fn = get_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1378                                     fi->serialization);
1379   if (NULL != fn)
1380   {
1381     if (0 != UNLINK (fn))
1382       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1383     GNUNET_free (fn);
1384   }
1385   GNUNET_free (fi->serialization);
1386   fi->serialization = NULL;
1387 }
1388
1389
1390
1391 /**
1392  * Find the entry in the file information struct where the
1393  * serialization filename matches the given name.
1394  *
1395  * @param pos file information to search
1396  * @param srch filename to search for
1397  * @return NULL if srch was not found in this subtree
1398  */
1399 static struct GNUNET_FS_FileInformation *
1400 find_file_position (struct GNUNET_FS_FileInformation *pos, 
1401                     const char *srch)
1402 {
1403   struct GNUNET_FS_FileInformation *r;
1404
1405   while (NULL != pos)
1406   {
1407     if (0 == strcmp (srch, pos->serialization))
1408       return pos;
1409     if ( (GNUNET_YES == pos->is_directory) &&
1410          (NULL != (r = find_file_position (pos->data.dir.entries, srch))) )
1411       return r;    
1412     pos = pos->next;
1413   }
1414   return NULL;
1415 }
1416
1417
1418 /**
1419  * Signal the FS's progress function that we are resuming
1420  * an upload.
1421  *
1422  * @param cls closure (of type `struct GNUNET_FS_PublishContext *`, for the parent (!))
1423  * @param fi the entry in the publish-structure
1424  * @param length length of the file or directory
1425  * @param meta metadata for the file or directory (can be modified)
1426  * @param uri pointer to the keywords that will be used for this entry (can be modified)
1427  * @param bo block options (can be modified)
1428  * @param do_index should we index?
1429  * @param client_info pointer to client context set upon creation (can be modified)
1430  * @return #GNUNET_OK to continue (always)
1431  */
1432 static int
1433 fip_signal_resume (void *cls, struct GNUNET_FS_FileInformation *fi,
1434                    uint64_t length, struct GNUNET_CONTAINER_MetaData *meta,
1435                    struct GNUNET_FS_Uri **uri,
1436                    struct GNUNET_FS_BlockOptions *bo, int *do_index,
1437                    void **client_info)
1438 {
1439   struct GNUNET_FS_PublishContext *pc = cls;
1440   struct GNUNET_FS_ProgressInfo pi;
1441
1442   if (GNUNET_YES == pc->skip_next_fi_callback)
1443   {
1444     pc->skip_next_fi_callback = GNUNET_NO;
1445     return GNUNET_OK;
1446   }
1447   pi.status = GNUNET_FS_STATUS_PUBLISH_RESUME;
1448   pi.value.publish.specifics.resume.message = fi->emsg;
1449   pi.value.publish.specifics.resume.chk_uri = fi->chk_uri;
1450   *client_info = GNUNET_FS_publish_make_status_ (&pi, pc, fi, 0);
1451   if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta))
1452   {
1453     /* process entries in directory */
1454     pc->skip_next_fi_callback = GNUNET_YES;
1455     GNUNET_FS_file_information_inspect (fi, &fip_signal_resume, pc);
1456   }
1457   return GNUNET_OK;
1458 }
1459
1460
1461 /**
1462  * Function called with a filename of serialized publishing operation
1463  * to deserialize.
1464  *
1465  * @param cls the `struct GNUNET_FS_Handle *`
1466  * @param filename complete filename (absolute path)
1467  * @return #GNUNET_OK (continue to iterate)
1468  */
1469 static int
1470 deserialize_publish_file (void *cls, const char *filename)
1471 {
1472   struct GNUNET_FS_Handle *h = cls;
1473   struct GNUNET_BIO_ReadHandle *rh;
1474   struct GNUNET_FS_PublishContext *pc;
1475   int32_t options;
1476   int32_t all_done;
1477   int32_t have_ns;
1478   char *fi_root;
1479   struct GNUNET_CRYPTO_EccPrivateKey ns;
1480   char *fi_pos;
1481   char *emsg;
1482
1483   pc = GNUNET_new (struct GNUNET_FS_PublishContext);
1484   pc->h = h;
1485   pc->serialization = get_serialization_short_name (filename);
1486   fi_root = NULL;
1487   fi_pos = NULL;
1488   rh = GNUNET_BIO_read_open (filename);
1489   if (NULL == rh)
1490   {
1491     GNUNET_break (0);
1492     goto cleanup;
1493   }
1494   if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-nid", &pc->nid, 1024))
1495       || (GNUNET_OK !=
1496           GNUNET_BIO_read_string (rh, "publish-nuid", &pc->nuid, 1024)) ||
1497       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
1498       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &all_done)) ||
1499       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &have_ns)) ||
1500       (GNUNET_OK !=
1501        GNUNET_BIO_read_string (rh, "publish-firoot", &fi_root, 128)) ||
1502       (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-fipos", &fi_pos, 128))
1503       || ( (GNUNET_YES == have_ns) &&
1504            (GNUNET_OK != GNUNET_BIO_read (rh, "publish-ns", &ns, sizeof (ns)))) )
1505   {
1506     GNUNET_break (0);
1507     goto cleanup;
1508   }
1509   pc->options = options;
1510   pc->all_done = all_done;
1511   if (NULL == fi_root)
1512   {
1513     GNUNET_break (0);
1514     goto cleanup;
1515   }
1516   pc->fi = deserialize_file_information (h, fi_root);
1517   if (NULL == pc->fi)
1518   {
1519     GNUNET_break (0);
1520     goto cleanup;
1521   }
1522   if (GNUNET_YES == have_ns)
1523   {
1524     pc->ns = GNUNET_new (struct GNUNET_CRYPTO_EccPrivateKey);
1525     *pc->ns = ns;
1526   }
1527   if ((0 == (pc->options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY)) &&
1528       (GNUNET_YES != pc->all_done))
1529   {
1530     pc->dsh = GNUNET_DATASTORE_connect (h->cfg);
1531     if (NULL == pc->dsh)
1532       goto cleanup;
1533   }
1534   if (NULL != fi_pos)
1535   {
1536     pc->fi_pos = find_file_position (pc->fi, fi_pos);
1537     GNUNET_free (fi_pos);
1538     fi_pos = NULL;
1539     if (NULL == pc->fi_pos)
1540     {
1541       /* failed to find position for resuming, outch! Will start from root! */
1542       GNUNET_break (0);
1543       if (GNUNET_YES != pc->all_done)
1544         pc->fi_pos = pc->fi;
1545     }
1546   }
1547   GNUNET_free (fi_root);
1548   fi_root = NULL;
1549   /* generate RESUME event(s) */
1550   GNUNET_FS_file_information_inspect (pc->fi, &fip_signal_resume, pc);
1551
1552   /* re-start publishing (if needed)... */
1553   if (GNUNET_YES != pc->all_done)
1554   {
1555     GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
1556     pc->upload_task =
1557         GNUNET_SCHEDULER_add_with_priority
1558         (GNUNET_SCHEDULER_PRIORITY_BACKGROUND, 
1559          &GNUNET_FS_publish_main_, pc);
1560   }
1561   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1562   {
1563     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1564                 _("Failure while resuming publishing operation `%s': %s\n"),
1565                 filename, emsg);
1566     GNUNET_free (emsg);
1567   }
1568   pc->top = GNUNET_FS_make_top (h, &GNUNET_FS_publish_signal_suspend_, pc);
1569   return GNUNET_OK;
1570 cleanup:
1571   GNUNET_free_non_null (pc->nid);
1572   GNUNET_free_non_null (pc->nuid);
1573   GNUNET_free_non_null (fi_root);
1574   GNUNET_free_non_null (fi_pos);
1575   if ((NULL != rh) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
1576   {
1577     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1578                 _("Failed to resume publishing operation `%s': %s\n"), filename,
1579                 emsg);
1580     GNUNET_free (emsg);
1581   }
1582   if (NULL != pc->fi)
1583     GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
1584   if (0 != UNLINK (filename))
1585     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
1586   GNUNET_free (pc->serialization);
1587   GNUNET_free (pc);
1588   return GNUNET_OK;
1589 }
1590
1591
1592 /**
1593  * Synchronize this publishing struct with its mirror
1594  * on disk.  Note that all internal FS-operations that change
1595  * publishing structs should already call "sync" internally,
1596  * so this function is likely not useful for clients.
1597  *
1598  * @param pc the struct to sync
1599  */
1600 void
1601 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc)
1602 {
1603   struct GNUNET_BIO_WriteHandle *wh;
1604   int32_t have_ns;
1605
1606   if (NULL == pc->serialization)
1607     pc->serialization =
1608         make_serialization_file_name (pc->h,
1609                                       GNUNET_FS_SYNC_PATH_MASTER_PUBLISH);
1610   if (NULL == pc->serialization)
1611     return;
1612   if (NULL == pc->fi)
1613     return;
1614   if (NULL == pc->fi->serialization)
1615   {
1616     GNUNET_break (0);
1617     return;
1618   }
1619   wh = get_write_handle (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1620                          pc->serialization);
1621   if (NULL == wh)
1622   {
1623     GNUNET_break (0);
1624     goto cleanup;
1625   }
1626   have_ns = (NULL != pc->ns) ? GNUNET_YES : GNUNET_NO;
1627   if ((GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nid)) ||
1628       (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nuid)) ||
1629       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->options)) ||
1630       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->all_done)) ||
1631       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, have_ns)) ||
1632       (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->fi->serialization)) ||
1633       (GNUNET_OK !=
1634        GNUNET_BIO_write_string (wh,
1635                                 (NULL == pc->fi_pos) ? NULL : pc->fi_pos->serialization)) ||
1636       ( (NULL != pc->ns) &&
1637         GNUNET_BIO_write (wh,
1638                           pc->ns,
1639                           sizeof (struct GNUNET_CRYPTO_EccPrivateKey)) ) )
1640   {
1641     GNUNET_break (0);
1642     goto cleanup;
1643   }
1644   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1645   {
1646     wh = NULL;
1647     GNUNET_break (0);
1648     goto cleanup;
1649   }
1650   return;
1651 cleanup:
1652   if (NULL != wh)
1653     (void) GNUNET_BIO_write_close (wh);
1654   GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1655                                pc->serialization);
1656   GNUNET_free (pc->serialization);
1657   pc->serialization = NULL;
1658 }
1659
1660
1661 /**
1662  * Synchronize this unindex struct with its mirror
1663  * on disk.  Note that all internal FS-operations that change
1664  * publishing structs should already call "sync" internally,
1665  * so this function is likely not useful for clients.
1666  *
1667  * @param uc the struct to sync
1668  */
1669 void
1670 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc)
1671 {
1672   struct GNUNET_BIO_WriteHandle *wh;
1673   char *uris;
1674
1675   if (NULL == uc->serialization)
1676     uc->serialization =
1677         make_serialization_file_name (uc->h,
1678                                       GNUNET_FS_SYNC_PATH_MASTER_UNINDEX);
1679   if (NULL == uc->serialization)
1680     return;
1681   wh = get_write_handle (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1682                          uc->serialization);
1683   if (NULL == wh)
1684   {
1685     GNUNET_break (0);
1686     goto cleanup;
1687   }
1688   if (NULL != uc->ksk_uri)
1689     uris = GNUNET_FS_uri_to_string (uc->ksk_uri);
1690   else
1691     uris = NULL;
1692   if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uc->filename)) ||
1693       (GNUNET_OK != GNUNET_BIO_write_int64 (wh, uc->file_size)) ||
1694       (GNUNET_OK != write_start_time (wh, uc->start_time)) ||
1695       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->state)) ||
1696       (GNUNET_OK !=
1697        GNUNET_BIO_write (wh, &uc->chk, sizeof (struct ContentHashKey))) ||
1698       (GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1699       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->ksk_offset)) ||
1700       ((uc->state == UNINDEX_STATE_FS_NOTIFY) &&
1701        (GNUNET_OK !=
1702         GNUNET_BIO_write (wh, &uc->file_id, sizeof (struct GNUNET_HashCode)))) ||
1703       ((uc->state == UNINDEX_STATE_ERROR) &&
1704        (GNUNET_OK != GNUNET_BIO_write_string (wh, uc->emsg))))
1705   {
1706     GNUNET_break (0);
1707     goto cleanup;
1708   }
1709   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1710   {
1711     wh = NULL;
1712     GNUNET_break (0);
1713     goto cleanup;
1714   }
1715   return;
1716 cleanup:
1717   if (NULL != wh)
1718     (void) GNUNET_BIO_write_close (wh);
1719   GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1720                                uc->serialization);
1721   GNUNET_free (uc->serialization);
1722   uc->serialization = NULL;
1723 }
1724
1725
1726 /**
1727  * Serialize a download request.
1728  *
1729  * @param wh the 'struct GNUNET_BIO_WriteHandle*'
1730  * @param dr the 'struct DownloadRequest'
1731  * @return GNUNET_YES on success, GNUNET_NO on error
1732  */
1733 static int
1734 write_download_request (struct GNUNET_BIO_WriteHandle *wh,
1735                         struct DownloadRequest *dr)
1736 {
1737   unsigned int i;
1738
1739   if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->state)) ||
1740       (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dr->offset)) ||
1741       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->num_children)) ||
1742       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->depth)))
1743     return GNUNET_NO;
1744   if ((BRS_CHK_SET == dr->state) &&
1745       (GNUNET_OK !=
1746        GNUNET_BIO_write (wh, &dr->chk, sizeof (struct ContentHashKey))))
1747     return GNUNET_NO;
1748   for (i = 0; i < dr->num_children; i++)
1749     if (GNUNET_NO == write_download_request (wh, dr->children[i]))
1750       return GNUNET_NO;
1751   return GNUNET_YES;
1752 }
1753
1754
1755 /**
1756  * Read a download request tree.
1757  *
1758  * @param rh mesh to read from
1759  * @return value the 'struct DownloadRequest', NULL on error
1760  */
1761 static struct DownloadRequest *
1762 read_download_request (struct GNUNET_BIO_ReadHandle *rh)
1763 {
1764   struct DownloadRequest *dr;
1765   unsigned int i;
1766
1767   dr = GNUNET_malloc (sizeof (struct DownloadRequest));
1768   if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->state)) ||
1769       (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dr->offset)) ||
1770       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->num_children)) ||
1771       (dr->num_children > CHK_PER_INODE) ||
1772       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->depth)) || ((0 == dr->depth)
1773                                                                 &&
1774                                                                 (dr->num_children
1775                                                                  > 0)) ||
1776       ((dr->depth > 0) && (0 == dr->num_children)))
1777   {
1778     GNUNET_break (0);
1779     dr->num_children = 0;
1780     goto cleanup;
1781   }
1782   if (dr->num_children > 0)
1783     dr->children =
1784         GNUNET_malloc (dr->num_children * sizeof (struct DownloadRequest *));
1785   switch (dr->state)
1786   {
1787   case BRS_INIT:
1788   case BRS_RECONSTRUCT_DOWN:
1789   case BRS_RECONSTRUCT_META_UP:
1790   case BRS_RECONSTRUCT_UP:
1791     break;
1792   case BRS_CHK_SET:
1793     if (GNUNET_OK !=
1794         GNUNET_BIO_read (rh, "chk", &dr->chk, sizeof (struct ContentHashKey)))
1795       goto cleanup;
1796     break;
1797   case BRS_DOWNLOAD_DOWN:
1798   case BRS_DOWNLOAD_UP:
1799   case BRS_ERROR:
1800     break;
1801   default:
1802     GNUNET_break (0);
1803     goto cleanup;
1804   }
1805   for (i = 0; i < dr->num_children; i++)
1806   {
1807     if (NULL == (dr->children[i] = read_download_request (rh)))
1808       goto cleanup;
1809     dr->children[i]->parent = dr;
1810   }
1811   return dr;
1812 cleanup:
1813   GNUNET_FS_free_download_request_ (dr);
1814   return NULL;
1815 }
1816
1817
1818 /**
1819  * Compute the name of the sync file (or directory) for the given download
1820  * context.
1821  *
1822  * @param dc download context to compute for
1823  * @param uni unique filename to use, use "" for the directory name
1824  * @param ext extension to use, use ".dir" for our own subdirectory
1825  * @return the expanded file name, NULL for none
1826  */
1827 static char *
1828 get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc,
1829                             const char *uni, const char *ext)
1830 {
1831   char *par;
1832   char *epar;
1833
1834   if (dc->parent == NULL)
1835     return get_serialization_file_name (dc->h,
1836                                         (dc->search != NULL) ?
1837                                         GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
1838                                         GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
1839                                         uni);
1840   if (NULL == dc->parent->serialization)
1841     return NULL;
1842   par = get_download_sync_filename (dc->parent, dc->parent->serialization, "");
1843   if (NULL == par)
1844     return NULL;
1845   GNUNET_asprintf (&epar, "%s.dir%s%s%s", par, DIR_SEPARATOR_STR, uni, ext);
1846   GNUNET_free (par);
1847   return epar;
1848 }
1849
1850
1851 /**
1852  * Synchronize this download struct with its mirror
1853  * on disk.  Note that all internal FS-operations that change
1854  * publishing structs should already call "sync" internally,
1855  * so this function is likely not useful for clients.
1856  *
1857  * @param dc the struct to sync
1858  */
1859 void
1860 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc)
1861 {
1862   struct GNUNET_BIO_WriteHandle *wh;
1863   char *uris;
1864   char *fn;
1865   char *dir;
1866
1867   if (0 != (dc->options & GNUNET_FS_DOWNLOAD_IS_PROBE))
1868     return; /* we don't sync probes */
1869   if (NULL == dc->serialization)
1870   {
1871     dir = get_download_sync_filename (dc, "", "");
1872     if (NULL == dir)
1873       return;
1874     if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dir))
1875     {
1876       GNUNET_free (dir);
1877       return;
1878     }
1879     fn = GNUNET_DISK_mktemp (dir);
1880     GNUNET_free (dir);
1881     if (NULL == fn)
1882       return;
1883     dc->serialization = get_serialization_short_name (fn);
1884   }
1885   else
1886   {
1887     fn = get_download_sync_filename (dc, dc->serialization, "");
1888     if (NULL == fn)
1889     {
1890       GNUNET_free (dc->serialization);
1891       dc->serialization = NULL;
1892       GNUNET_free (fn);
1893       return;
1894     }
1895   }
1896   wh = GNUNET_BIO_write_open (fn);
1897   if (NULL == wh)
1898   {
1899     GNUNET_free (dc->serialization);
1900     dc->serialization = NULL;
1901     GNUNET_free (fn);
1902     return;
1903   }
1904   GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_chk (dc->uri)) ||
1905                  (GNUNET_YES == GNUNET_FS_uri_test_loc (dc->uri)));
1906   uris = GNUNET_FS_uri_to_string (dc->uri);
1907   if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1908       (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, dc->meta)) ||
1909       (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->emsg)) ||
1910       (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->filename)) ||
1911       (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->temp_filename)) ||
1912       (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->old_file_size)) ||
1913       (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->offset)) ||
1914       (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->length)) ||
1915       (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->completed)) ||
1916       (GNUNET_OK != write_start_time (wh, dc->start_time)) ||
1917       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dc->anonymity)) ||
1918       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->options)) ||
1919       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->has_finished)))
1920   {
1921     GNUNET_break (0);
1922     goto cleanup;
1923   }
1924   if (NULL == dc->emsg)
1925   {
1926     GNUNET_assert (dc->top_request != NULL);
1927     if (GNUNET_YES != write_download_request (wh, dc->top_request))
1928     {
1929       GNUNET_break (0);
1930       goto cleanup;
1931     }
1932   }
1933   GNUNET_free_non_null (uris);
1934   uris = NULL;
1935   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1936   {
1937     wh = NULL;
1938     GNUNET_break (0);
1939     goto cleanup;
1940   }
1941   GNUNET_free (fn);
1942   return;
1943 cleanup:
1944   if (NULL != wh)
1945     (void) GNUNET_BIO_write_close (wh);
1946   GNUNET_free_non_null (uris);
1947   if (0 != UNLINK (fn))
1948     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1949   GNUNET_free (fn);
1950   GNUNET_free (dc->serialization);
1951   dc->serialization = NULL;
1952 }
1953
1954
1955 /**
1956  * Synchronize this search result with its mirror
1957  * on disk.  Note that all internal FS-operations that change
1958  * publishing structs should already call "sync" internally,
1959  * so this function is likely not useful for clients.
1960  *
1961  * @param sr the struct to sync
1962  */
1963 void
1964 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr)
1965 {
1966   struct GNUNET_BIO_WriteHandle *wh;
1967   char *uris;
1968
1969   if (NULL == sr->sc)
1970     return;
1971   uris = NULL;
1972   if (NULL == sr->serialization)
1973     sr->serialization =
1974         make_serialization_file_name_in_dir (sr->h,
1975                                              (sr->sc->psearch_result ==
1976                                               NULL) ?
1977                                              GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1978                                              GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1979                                              sr->sc->serialization);
1980   if (NULL == sr->serialization)
1981     return;
1982   wh = get_write_handle_in_dir (sr->h,
1983                                 (sr->sc->psearch_result ==
1984                                  NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1985                                 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1986                                 sr->sc->serialization, sr->serialization);
1987   if (NULL == wh)
1988   {
1989     GNUNET_break (0);
1990     goto cleanup;
1991   }
1992   uris = GNUNET_FS_uri_to_string (sr->uri);
1993   if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1994       (GNUNET_OK !=
1995        GNUNET_BIO_write_string (wh,
1996                                 sr->download !=
1997                                 NULL ? sr->download->serialization : NULL)) ||
1998       (GNUNET_OK !=
1999        GNUNET_BIO_write_string (wh,
2000                                 sr->update_search !=
2001                                 NULL ? sr->update_search->serialization : NULL))
2002       || (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, sr->meta)) ||
2003       (GNUNET_OK != GNUNET_BIO_write (wh, &sr->key, sizeof (struct GNUNET_HashCode)))
2004       || (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->mandatory_missing)) ||
2005       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->optional_support)) ||
2006       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_success)) ||
2007       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_trials)) )
2008   {
2009     GNUNET_break (0);
2010     goto cleanup;
2011   }
2012   if ( (NULL != sr->uri) &&
2013        (GNUNET_FS_URI_KSK == sr->sc->uri->type) &&
2014        (GNUNET_OK != GNUNET_BIO_write (wh, sr->keyword_bitmap,
2015                                        (sr->sc->uri->data.ksk.keywordCount + 7) / 8)) )
2016   {
2017     GNUNET_break (0);
2018     goto cleanup;
2019   }
2020   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
2021   {
2022     wh = NULL;
2023     GNUNET_break (0);
2024     goto cleanup;
2025   }
2026   GNUNET_free_non_null (uris);
2027   return;
2028 cleanup:
2029   GNUNET_free_non_null (uris);
2030   if (NULL != wh)
2031     (void) GNUNET_BIO_write_close (wh);
2032   remove_sync_file_in_dir (sr->h,
2033                            (NULL == sr->sc->psearch_result) 
2034                            ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH 
2035                            : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2036                            sr->sc->serialization, sr->serialization);
2037   GNUNET_free (sr->serialization);
2038   sr->serialization = NULL;
2039 }
2040
2041
2042 /**
2043  * Synchronize this search struct with its mirror
2044  * on disk.  Note that all internal FS-operations that change
2045  * publishing structs should already call "sync" internally,
2046  * so this function is likely not useful for clients.
2047  *
2048  * @param sc the struct to sync
2049  */
2050 void
2051 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc)
2052 {
2053   struct GNUNET_BIO_WriteHandle *wh;
2054   char *uris;
2055   char in_pause;
2056   const char *category;
2057
2058   category =
2059       (NULL == sc->psearch_result) 
2060     ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH 
2061     : GNUNET_FS_SYNC_PATH_CHILD_SEARCH;
2062   if (NULL == sc->serialization)
2063     sc->serialization = make_serialization_file_name (sc->h, category);
2064   if (NULL == sc->serialization)
2065     return;
2066   uris = NULL;
2067   wh = get_write_handle (sc->h, category, sc->serialization);
2068   if (NULL == wh)
2069   {
2070     GNUNET_break (0);
2071     goto cleanup;
2072   }
2073   GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_ksk (sc->uri)) ||
2074                  (GNUNET_YES == GNUNET_FS_uri_test_sks (sc->uri)));
2075   uris = GNUNET_FS_uri_to_string (sc->uri);
2076   in_pause = (sc->task != GNUNET_SCHEDULER_NO_TASK) ? 'r' : '\0';
2077   if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
2078       (GNUNET_OK != write_start_time (wh, sc->start_time)) ||
2079       (GNUNET_OK != GNUNET_BIO_write_string (wh, sc->emsg)) ||
2080       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) sc->options)) ||
2081       (GNUNET_OK != GNUNET_BIO_write (wh, &in_pause, sizeof (in_pause))) ||
2082       (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sc->anonymity)))
2083   {
2084     GNUNET_break (0);
2085     goto cleanup;
2086   }
2087   GNUNET_free (uris);
2088   uris = NULL;
2089   if (GNUNET_OK != GNUNET_BIO_write_close (wh))
2090   {
2091     wh = NULL;
2092     GNUNET_break (0);
2093     goto cleanup;
2094   }
2095   return;
2096 cleanup:
2097   if (NULL != wh)
2098     (void) GNUNET_BIO_write_close (wh);
2099   GNUNET_free_non_null (uris);
2100   GNUNET_FS_remove_sync_file_ (sc->h, category, sc->serialization);
2101   GNUNET_free (sc->serialization);
2102   sc->serialization = NULL;
2103 }
2104
2105
2106 /**
2107  * Function called with a filename of serialized unindexing operation
2108  * to deserialize.
2109  *
2110  * @param cls the 'struct GNUNET_FS_Handle*'
2111  * @param filename complete filename (absolute path)
2112  * @return GNUNET_OK (continue to iterate)
2113  */
2114 static int
2115 deserialize_unindex_file (void *cls, const char *filename)
2116 {
2117   struct GNUNET_FS_Handle *h = cls;
2118   struct GNUNET_BIO_ReadHandle *rh;
2119   struct GNUNET_FS_UnindexContext *uc;
2120   struct GNUNET_FS_ProgressInfo pi;
2121   char *emsg;
2122   char *uris;
2123   uint32_t state;
2124
2125   uc = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
2126   uc->h = h;
2127   uc->serialization = get_serialization_short_name (filename);
2128   rh = GNUNET_BIO_read_open (filename);
2129   if (NULL == rh)
2130   {
2131     GNUNET_break (0);
2132     goto cleanup;
2133   }
2134   uris = NULL;
2135   if ((GNUNET_OK !=
2136        GNUNET_BIO_read_string (rh, "unindex-fn", &uc->filename, 10 * 1024)) ||
2137       (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &uc->file_size)) ||
2138       (GNUNET_OK != read_start_time (rh, &uc->start_time)) ||
2139       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &state)) ||
2140       (GNUNET_OK != GNUNET_BIO_read (rh, "uri", &uc->chk, sizeof (struct ContentHashKey))) ||
2141       (GNUNET_OK != GNUNET_BIO_read_string (rh, "unindex-kskuri", &uris, 10 * 1024)) ||
2142       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &uc->ksk_offset)) )
2143   {
2144     GNUNET_free_non_null (uris);
2145     GNUNET_break (0);
2146     goto cleanup;
2147   }
2148   if (NULL != uris)
2149   {
2150     uc->ksk_uri = GNUNET_FS_uri_parse (uris, &emsg);
2151     GNUNET_free (uris);
2152     if (NULL == uc->ksk_uri)
2153     {
2154       GNUNET_break (0);
2155       GNUNET_free_non_null (emsg);
2156       goto cleanup;
2157     }
2158   }
2159   if ( (uc->ksk_offset > 0) &&
2160        ( (NULL == uc->ksk_uri) ||
2161          (uc->ksk_offset > uc->ksk_uri->data.ksk.keywordCount) ) )
2162   {
2163     GNUNET_break (0);
2164     goto cleanup;
2165   }  
2166   uc->state = (enum UnindexState) state;
2167   switch (state)
2168   {
2169   case UNINDEX_STATE_HASHING:
2170     break;
2171   case UNINDEX_STATE_FS_NOTIFY:
2172     if (GNUNET_OK !=
2173         GNUNET_BIO_read (rh, "unindex-hash", &uc->file_id,
2174                          sizeof (struct GNUNET_HashCode)))
2175     {
2176       GNUNET_break (0);
2177       goto cleanup;
2178     }
2179     break;
2180   case UNINDEX_STATE_DS_REMOVE:
2181   case UNINDEX_STATE_EXTRACT_KEYWORDS:
2182   case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2183     break;
2184   case UNINDEX_STATE_COMPLETE:
2185     break;
2186   case UNINDEX_STATE_ERROR:
2187     if (GNUNET_OK !=
2188         GNUNET_BIO_read_string (rh, "unindex-emsg", &uc->emsg, 10 * 1024))
2189     {
2190       GNUNET_break (0);
2191       goto cleanup;
2192     }
2193     break;
2194   default:
2195     GNUNET_break (0);
2196     goto cleanup;
2197   }
2198   uc->top = GNUNET_FS_make_top (h, &GNUNET_FS_unindex_signal_suspend_, uc);
2199   pi.status = GNUNET_FS_STATUS_UNINDEX_RESUME;
2200   pi.value.unindex.specifics.resume.message = uc->emsg;
2201   GNUNET_FS_unindex_make_status_ (&pi, uc,
2202                                   (uc->state ==
2203                                    UNINDEX_STATE_COMPLETE) ? uc->file_size : 0);
2204   switch (uc->state)
2205   {
2206   case UNINDEX_STATE_HASHING:
2207     uc->fhc =
2208         GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, uc->filename,
2209                                  HASHING_BLOCKSIZE,
2210                                  &GNUNET_FS_unindex_process_hash_, uc);
2211     break;
2212   case UNINDEX_STATE_FS_NOTIFY:
2213     uc->state = UNINDEX_STATE_HASHING;
2214     GNUNET_FS_unindex_process_hash_ (uc, &uc->file_id);
2215     break;
2216   case UNINDEX_STATE_DS_REMOVE:
2217     GNUNET_FS_unindex_do_remove_ (uc);
2218     break;
2219   case UNINDEX_STATE_EXTRACT_KEYWORDS:
2220     GNUNET_FS_unindex_do_extract_keywords_ (uc);
2221     break;
2222   case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2223     GNUNET_FS_unindex_do_remove_kblocks_ (uc);
2224     break;
2225   case UNINDEX_STATE_COMPLETE:
2226   case UNINDEX_STATE_ERROR:
2227     /* no need to resume any operation, we were done */
2228     break;
2229   default:
2230     break;
2231   }
2232   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2233   {
2234     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2235                 _("Failure while resuming unindexing operation `%s': %s\n"),
2236                 filename, emsg);
2237     GNUNET_free (emsg);
2238   }
2239   return GNUNET_OK;
2240 cleanup:
2241   GNUNET_free_non_null (uc->filename);
2242   if ((NULL != rh) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
2243   {
2244     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2245                 _("Failed to resume unindexing operation `%s': %s\n"), filename,
2246                 emsg);
2247     GNUNET_free (emsg);
2248   }
2249   if (NULL != uc->serialization)
2250     GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2251                                  uc->serialization);
2252   GNUNET_free_non_null (uc->serialization);
2253   GNUNET_free (uc);
2254   return GNUNET_OK;
2255 }
2256
2257
2258 /**
2259  * Deserialize a download.
2260  *
2261  * @param h overall context
2262  * @param rh file to deserialize from
2263  * @param parent parent download
2264  * @param search associated search
2265  * @param serialization name under which the search was serialized
2266  */
2267 static void
2268 deserialize_download (struct GNUNET_FS_Handle *h,
2269                       struct GNUNET_BIO_ReadHandle *rh,
2270                       struct GNUNET_FS_DownloadContext *parent,
2271                       struct GNUNET_FS_SearchResult *search,
2272                       const char *serialization);
2273
2274
2275 /**
2276  * Deserialize a search.
2277  *
2278  * @param h overall context
2279  * @param rh file to deserialize from
2280  * @param psearch_result parent search result
2281  * @param serialization name under which the search was serialized
2282  */
2283 static struct GNUNET_FS_SearchContext *
2284 deserialize_search (struct GNUNET_FS_Handle *h,
2285                     struct GNUNET_BIO_ReadHandle *rh,
2286                     struct GNUNET_FS_SearchResult *psearch_result,
2287                     const char *serialization);
2288
2289
2290 /**
2291  * Function called with a filename of serialized search result
2292  * to deserialize.
2293  *
2294  * @param cls the 'struct GNUNET_FS_SearchContext*'
2295  * @param filename complete filename (absolute path)
2296  * @return GNUNET_OK (continue to iterate)
2297  */
2298 static int
2299 deserialize_search_result (void *cls, const char *filename)
2300 {
2301   struct GNUNET_FS_SearchContext *sc = cls;
2302   char *ser;
2303   char *uris;
2304   char *emsg;
2305   char *download;
2306   char *update_srch;
2307   struct GNUNET_BIO_ReadHandle *rh;
2308   struct GNUNET_BIO_ReadHandle *drh;
2309   struct GNUNET_FS_SearchResult *sr;
2310
2311   ser = get_serialization_short_name (filename);
2312   rh = GNUNET_BIO_read_open (filename);
2313   if (NULL == rh)
2314   {
2315     if (NULL != ser)
2316     {
2317       remove_sync_file_in_dir (sc->h,
2318                                (NULL == sc->psearch_result) 
2319                                ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH 
2320                                : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2321                                sc->serialization, ser);
2322       GNUNET_free (ser);
2323     }
2324     return GNUNET_OK;
2325   }
2326   emsg = NULL;
2327   uris = NULL;
2328   download = NULL;
2329   update_srch = NULL;
2330   sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
2331   sr->h = sc->h;
2332   sr->sc = sc;
2333   sr->serialization = ser;
2334   if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "result-uri", &uris, 10 * 1024))
2335       || (NULL == (sr->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2336       (GNUNET_OK != GNUNET_BIO_read_string (rh, "download-lnk", &download, 16))
2337       || (GNUNET_OK !=
2338           GNUNET_BIO_read_string (rh, "search-lnk", &update_srch, 16)) ||
2339       (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "result-meta", &sr->meta)) ||
2340       (GNUNET_OK !=
2341        GNUNET_BIO_read (rh, "result-key", &sr->key, sizeof (struct GNUNET_HashCode)))
2342       || (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->mandatory_missing)) ||
2343       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->optional_support)) ||
2344       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_success)) ||
2345       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_trials)))
2346   {
2347     GNUNET_break (0);
2348     goto cleanup;
2349   }
2350   if (GNUNET_FS_URI_KSK == sr->sc->uri->type)
2351   {
2352     sr->keyword_bitmap = GNUNET_malloc ((sr->sc->uri->data.ksk.keywordCount + 7) / 8); /* round up, count bits */
2353     if (GNUNET_OK != GNUNET_BIO_read (rh, "keyword-bitmap",
2354                                       sr->keyword_bitmap,
2355                                       (sr->sc->uri->data.ksk.keywordCount + 7) / 8))
2356     {
2357       GNUNET_break (0);
2358       goto cleanup;
2359     }
2360   }
2361   GNUNET_free (uris);
2362   if (NULL != download)
2363   {
2364     drh = get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD, download);
2365     if (NULL != drh)
2366     {
2367       deserialize_download (sc->h, drh, NULL, sr, download);
2368       if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2369       {
2370         GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2371                     _("Failed to resume sub-download `%s': %s\n"), download,
2372                     emsg);
2373         GNUNET_free (emsg);
2374       }
2375     }
2376     GNUNET_free (download);
2377   }
2378   if (NULL != update_srch)
2379   {
2380     drh =
2381         get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_SEARCH, update_srch);
2382     if (NULL != drh)
2383     {
2384       deserialize_search (sc->h, drh, sr, update_srch);
2385       if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2386       {
2387         GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2388                     _("Failed to resume sub-search `%s': %s\n"), update_srch,
2389                     emsg);
2390         GNUNET_free (emsg);
2391       }
2392     }
2393     GNUNET_free (update_srch);
2394   }
2395   GNUNET_break (GNUNET_YES ==
2396                 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &sr->key, sr,
2397                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
2398   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2399   {
2400     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2401                 _("Failure while resuming search operation `%s': %s\n"),
2402                 filename, emsg);
2403     GNUNET_free (emsg);
2404   }
2405   return GNUNET_OK;
2406 cleanup:
2407   GNUNET_free_non_null (download);
2408   GNUNET_free_non_null (emsg);
2409   GNUNET_free_non_null (uris);
2410   GNUNET_free_non_null (update_srch);
2411   if (NULL != sr->uri)
2412     GNUNET_FS_uri_destroy (sr->uri);
2413   if (NULL != sr->meta)
2414     GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2415   GNUNET_free (sr->serialization);
2416   GNUNET_free (sr);
2417   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2418   {
2419     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2420                 _("Failure while resuming search operation `%s': %s\n"),
2421                 filename, emsg);
2422     GNUNET_free (emsg);
2423   }
2424   return GNUNET_OK;
2425 }
2426
2427
2428 /**
2429  * Send the 'resume' signal to the callback; also actually
2430  * resume the download (put it in the queue).  Does this
2431  * recursively for the top-level download and all child
2432  * downloads.
2433  *
2434  * @param dc download to resume
2435  */
2436 static void
2437 signal_download_resume (struct GNUNET_FS_DownloadContext *dc)
2438 {
2439   struct GNUNET_FS_DownloadContext *dcc;
2440   struct GNUNET_FS_ProgressInfo pi;
2441
2442   pi.status = GNUNET_FS_STATUS_DOWNLOAD_RESUME;
2443   pi.value.download.specifics.resume.meta = dc->meta;
2444   pi.value.download.specifics.resume.message = dc->emsg;
2445   GNUNET_FS_download_make_status_ (&pi, dc);
2446   dcc = dc->child_head;
2447   while (NULL != dcc)
2448   {
2449     signal_download_resume (dcc);
2450     dcc = dcc->next;
2451   }
2452   if (NULL != dc->pending_head)
2453     GNUNET_FS_download_start_downloading_ (dc);
2454 }
2455
2456
2457 /**
2458  * Signal resuming of a search to our clients (for the
2459  * top level search and all sub-searches).
2460  *
2461  * @param sc search being resumed
2462  */
2463 static void
2464 signal_search_resume (struct GNUNET_FS_SearchContext *sc);
2465
2466
2467 /**
2468  * Iterator over search results signaling resume to the client for
2469  * each result.
2470  *
2471  * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2472  * @param key current key code
2473  * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2474  * @return GNUNET_YES (we should continue to iterate)
2475  */
2476 static int
2477 signal_result_resume (void *cls, const struct GNUNET_HashCode * key, void *value)
2478 {
2479   struct GNUNET_FS_SearchContext *sc = cls;
2480   struct GNUNET_FS_ProgressInfo pi;
2481   struct GNUNET_FS_SearchResult *sr = value;
2482
2483   if (0 == sr->mandatory_missing)
2484   {
2485     pi.status = GNUNET_FS_STATUS_SEARCH_RESUME_RESULT;
2486     pi.value.search.specifics.resume_result.meta = sr->meta;
2487     pi.value.search.specifics.resume_result.uri = sr->uri;
2488     pi.value.search.specifics.resume_result.result = sr;
2489     pi.value.search.specifics.resume_result.availability_rank =
2490         2 * sr->availability_success - sr->availability_trials;
2491     pi.value.search.specifics.resume_result.availability_certainty =
2492         sr->availability_trials;
2493     pi.value.search.specifics.resume_result.applicability_rank =
2494         sr->optional_support;
2495     sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
2496   }
2497   if (NULL != sr->download)
2498   {
2499     signal_download_resume (sr->download);
2500   }
2501   else
2502   {
2503     GNUNET_FS_search_start_probe_ (sr);
2504   }
2505   if (NULL != sr->update_search)
2506     signal_search_resume (sr->update_search);
2507   return GNUNET_YES;
2508 }
2509
2510
2511 /**
2512  * Free memory allocated by the search context and its children
2513  *
2514  * @param sc search context to free
2515  */
2516 static void
2517 free_search_context (struct GNUNET_FS_SearchContext *sc);
2518
2519
2520 /**
2521  * Iterator over search results freeing each.
2522  *
2523  * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2524  * @param key current key code
2525  * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2526  * @return GNUNET_YES (we should continue to iterate)
2527  */
2528 static int
2529 free_result (void *cls, const struct GNUNET_HashCode * key, void *value)
2530 {
2531   struct GNUNET_FS_SearchResult *sr = value;
2532
2533   if (NULL != sr->update_search)
2534   {
2535     free_search_context (sr->update_search);
2536     GNUNET_assert (NULL == sr->update_search);
2537   }
2538   GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2539   GNUNET_FS_uri_destroy (sr->uri);
2540   GNUNET_free (sr);
2541   return GNUNET_YES;
2542 }
2543
2544
2545 /**
2546  * Free memory allocated by the search context and its children
2547  *
2548  * @param sc search context to free
2549  */
2550 static void
2551 free_search_context (struct GNUNET_FS_SearchContext *sc)
2552 {
2553   if (NULL != sc->serialization)
2554   {
2555     GNUNET_FS_remove_sync_file_ (sc->h,
2556                                  (sc->psearch_result ==
2557                                   NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2558                                  GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2559                                  sc->serialization);
2560     GNUNET_FS_remove_sync_dir_ (sc->h,
2561                                 (sc->psearch_result ==
2562                                  NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2563                                 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2564                                 sc->serialization);
2565   }
2566   GNUNET_free_non_null (sc->serialization);
2567   GNUNET_free_non_null (sc->emsg);
2568   if (NULL != sc->uri)
2569     GNUNET_FS_uri_destroy (sc->uri);
2570   if (NULL != sc->master_result_map)
2571   {
2572     GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map, &free_result,
2573                                            sc);
2574     GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
2575   }
2576   GNUNET_free (sc);
2577 }
2578
2579
2580 /**
2581  * Function called with a filename of serialized sub-download
2582  * to deserialize.
2583  *
2584  * @param cls the 'struct GNUNET_FS_DownloadContext*' (parent)
2585  * @param filename complete filename (absolute path)
2586  * @return GNUNET_OK (continue to iterate)
2587  */
2588 static int
2589 deserialize_subdownload (void *cls, const char *filename)
2590 {
2591   struct GNUNET_FS_DownloadContext *parent = cls;
2592   char *ser;
2593   char *emsg;
2594   struct GNUNET_BIO_ReadHandle *rh;
2595
2596   ser = get_serialization_short_name (filename);
2597   rh = GNUNET_BIO_read_open (filename);
2598   if (NULL == rh)
2599   {
2600     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2601                 _
2602                 ("Failed to resume sub-download `%s': could not open file `%s'\n"),
2603                 ser, filename);
2604     GNUNET_free (ser);
2605     return GNUNET_OK;
2606   }
2607   deserialize_download (parent->h, rh, parent, NULL, ser);
2608   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2609   {
2610     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2611                 _("Failed to resume sub-download `%s': %s\n"), ser, emsg);
2612     GNUNET_free (emsg);
2613   }
2614   GNUNET_free (ser);
2615   return GNUNET_OK;
2616 }
2617
2618
2619 /**
2620  * Free this download context and all of its descendants.
2621  * (only works during deserialization since not all possible
2622  * state it taken care of).
2623  *
2624  * @param dc context to free
2625  */
2626 static void
2627 free_download_context (struct GNUNET_FS_DownloadContext *dc)
2628 {
2629   struct GNUNET_FS_DownloadContext *dcc;
2630
2631   if (NULL != dc->meta)
2632     GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2633   if (NULL != dc->uri)
2634     GNUNET_FS_uri_destroy (dc->uri);
2635   GNUNET_free_non_null (dc->temp_filename);
2636   GNUNET_free_non_null (dc->emsg);
2637   GNUNET_free_non_null (dc->filename);
2638   GNUNET_free_non_null (dc->serialization);
2639   while (NULL != (dcc = dc->child_head))
2640   {
2641     GNUNET_CONTAINER_DLL_remove (dc->child_head, dc->child_tail, dcc);
2642     free_download_context (dcc);
2643   }
2644   GNUNET_FS_free_download_request_ (dc->top_request);
2645   if (NULL != dc->active)
2646     GNUNET_CONTAINER_multihashmap_destroy (dc->active);
2647   GNUNET_free (dc);
2648 }
2649
2650
2651 /**
2652  * Deserialize a download.
2653  *
2654  * @param h overall context
2655  * @param rh file to deserialize from
2656  * @param parent parent download
2657  * @param search associated search
2658  * @param serialization name under which the search was serialized
2659  */
2660 static void
2661 deserialize_download (struct GNUNET_FS_Handle *h,
2662                       struct GNUNET_BIO_ReadHandle *rh,
2663                       struct GNUNET_FS_DownloadContext *parent,
2664                       struct GNUNET_FS_SearchResult *search,
2665                       const char *serialization)
2666 {
2667   struct GNUNET_FS_DownloadContext *dc;
2668   char *emsg;
2669   char *uris;
2670   char *dn;
2671   uint32_t options;
2672   uint32_t status;
2673
2674   uris = NULL;
2675   emsg = NULL;
2676   dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2677   dc->parent = parent;
2678   dc->h = h;
2679   dc->serialization = GNUNET_strdup (serialization);
2680   if ((GNUNET_OK !=
2681        GNUNET_BIO_read_string (rh, "download-uri", &uris, 10 * 1024)) ||
2682       (NULL == (dc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2683       ((GNUNET_YES != GNUNET_FS_uri_test_chk (dc->uri)) &&
2684        (GNUNET_YES != GNUNET_FS_uri_test_loc (dc->uri))) ||
2685       (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "download-meta", &dc->meta))
2686       || (GNUNET_OK !=
2687           GNUNET_BIO_read_string (rh, "download-emsg", &dc->emsg, 10 * 1024)) ||
2688       (GNUNET_OK !=
2689        GNUNET_BIO_read_string (rh, "download-fn", &dc->filename, 10 * 1024)) ||
2690       (GNUNET_OK !=
2691        GNUNET_BIO_read_string (rh, "download-tfn", &dc->temp_filename,
2692                                10 * 1024)) ||
2693       (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->old_file_size)) ||
2694       (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->offset)) ||
2695       (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->length)) ||
2696       (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->completed)) ||
2697       (GNUNET_OK != read_start_time (rh, &dc->start_time)) ||
2698       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dc->anonymity)) ||
2699       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2700       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &status)))
2701   {
2702     GNUNET_break (0);
2703     goto cleanup;
2704   }
2705   dc->options = (enum GNUNET_FS_DownloadOptions) options;
2706   dc->active =
2707     GNUNET_CONTAINER_multihashmap_create (1 + 2 * (dc->length / DBLOCK_SIZE), GNUNET_NO);
2708   dc->has_finished = (int) status;
2709   dc->treedepth =
2710       GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
2711   if (GNUNET_FS_uri_test_loc (dc->uri))
2712     GNUNET_assert (GNUNET_OK ==
2713                    GNUNET_FS_uri_loc_get_peer_identity (dc->uri, &dc->target));
2714   if (NULL == dc->emsg)
2715   {
2716     dc->top_request = read_download_request (rh);
2717     if (NULL == dc->top_request)
2718     {
2719       GNUNET_break (0);
2720       goto cleanup;
2721     }
2722   }
2723   dn = get_download_sync_filename (dc, dc->serialization, ".dir");
2724   if (NULL != dn)
2725   {
2726     if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
2727       GNUNET_DISK_directory_scan (dn, &deserialize_subdownload, dc);
2728     GNUNET_free (dn);
2729   }
2730   if (NULL != parent)
2731   {
2732     GNUNET_CONTAINER_DLL_insert (parent->child_head, parent->child_tail, dc);
2733   }
2734   if (NULL != search)
2735   {
2736     dc->search = search;
2737     search->download = dc;
2738   }
2739   if ((NULL == parent) && (NULL == search))
2740   {
2741     dc->top =
2742         GNUNET_FS_make_top (dc->h, &GNUNET_FS_download_signal_suspend_, dc);
2743     signal_download_resume (dc);
2744   }
2745   GNUNET_free (uris);
2746   dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_, dc);
2747   return;
2748 cleanup:
2749   GNUNET_free_non_null (uris);
2750   GNUNET_free_non_null (emsg);
2751   free_download_context (dc);
2752 }
2753
2754
2755 /**
2756  * Signal resuming of a search to our clients (for the
2757  * top level search and all sub-searches).
2758  *
2759  * @param sc search being resumed
2760  */
2761 static void
2762 signal_search_resume (struct GNUNET_FS_SearchContext *sc)
2763 {
2764   struct GNUNET_FS_ProgressInfo pi;
2765
2766   pi.status = GNUNET_FS_STATUS_SEARCH_RESUME;
2767   pi.value.search.specifics.resume.message = sc->emsg;
2768   pi.value.search.specifics.resume.is_paused =
2769       (NULL == sc->client) ? GNUNET_YES : GNUNET_NO;
2770   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
2771   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2772                                          &signal_result_resume, sc);
2773
2774 }
2775
2776
2777 /**
2778  * Deserialize a search.
2779  *
2780  * @param h overall context
2781  * @param rh file to deserialize from
2782  * @param psearch_result parent search result
2783  * @param serialization name under which the search was serialized
2784  */
2785 static struct GNUNET_FS_SearchContext *
2786 deserialize_search (struct GNUNET_FS_Handle *h,
2787                     struct GNUNET_BIO_ReadHandle *rh,
2788                     struct GNUNET_FS_SearchResult *psearch_result,
2789                     const char *serialization)
2790 {
2791   struct GNUNET_FS_SearchContext *sc;
2792   char *emsg;
2793   char *uris;
2794   char *dn;
2795   uint32_t options;
2796   char in_pause;
2797
2798   if ((NULL != psearch_result) && (NULL != psearch_result->update_search))
2799   {
2800     GNUNET_break (0);
2801     return NULL;
2802   }
2803   uris = NULL;
2804   emsg = NULL;
2805   sc = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchContext));
2806   if (NULL != psearch_result)
2807   {
2808     sc->psearch_result = psearch_result;
2809     psearch_result->update_search = sc;
2810   }
2811   sc->h = h;
2812   sc->serialization = GNUNET_strdup (serialization);
2813   if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "search-uri", &uris, 10 * 1024))
2814       || (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2815       ((GNUNET_YES != GNUNET_FS_uri_test_ksk (sc->uri)) &&
2816        (GNUNET_YES != GNUNET_FS_uri_test_sks (sc->uri))) ||
2817       (GNUNET_OK != read_start_time (rh, &sc->start_time)) ||
2818       (GNUNET_OK !=
2819        GNUNET_BIO_read_string (rh, "search-emsg", &sc->emsg, 10 * 1024)) ||
2820       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2821       (GNUNET_OK !=
2822        GNUNET_BIO_read (rh, "search-pause", &in_pause, sizeof (in_pause))) ||
2823       (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sc->anonymity)))
2824   {
2825     GNUNET_break (0);
2826     goto cleanup;
2827   }
2828   sc->options = (enum GNUNET_FS_SearchOptions) options;
2829   sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_NO);
2830   dn = get_serialization_file_name_in_dir (h,
2831                                            (sc->psearch_result ==
2832                                             NULL) ?
2833                                            GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2834                                            GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2835                                            sc->serialization, "");
2836   if (NULL != dn)
2837   {
2838     if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
2839       GNUNET_DISK_directory_scan (dn, &deserialize_search_result, sc);
2840     GNUNET_free (dn);
2841   }
2842   if (('\0' == in_pause) &&
2843       (GNUNET_OK != GNUNET_FS_search_start_searching_ (sc)))
2844   {
2845     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2846                 _
2847                 ("Could not resume running search, will resume as paused search\n"));
2848   }
2849   signal_search_resume (sc);
2850   GNUNET_free (uris);
2851   return sc;
2852 cleanup:
2853   GNUNET_free_non_null (emsg);
2854   free_search_context (sc);
2855   GNUNET_free_non_null (uris);
2856   return NULL;
2857 }
2858
2859
2860 /**
2861  * Function called with a filename of serialized search operation
2862  * to deserialize.
2863  *
2864  * @param cls the 'struct GNUNET_FS_Handle*'
2865  * @param filename complete filename (absolute path)
2866  * @return GNUNET_OK (continue to iterate)
2867  */
2868 static int
2869 deserialize_search_file (void *cls, const char *filename)
2870 {
2871   struct GNUNET_FS_Handle *h = cls;
2872   char *ser;
2873   char *emsg;
2874   struct GNUNET_BIO_ReadHandle *rh;
2875   struct GNUNET_FS_SearchContext *sc;
2876   struct stat buf;
2877
2878   if (0 != STAT (filename, &buf))
2879   {
2880     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "stat", filename);
2881     return GNUNET_OK;
2882   }
2883   if (S_ISDIR (buf.st_mode))
2884     return GNUNET_OK; /* skip directories */
2885   ser = get_serialization_short_name (filename);
2886   rh = GNUNET_BIO_read_open (filename);
2887   if (NULL == rh)
2888   {
2889     if (NULL != ser)
2890     {
2891       GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, ser);
2892       GNUNET_free (ser);
2893     }
2894     return GNUNET_OK;
2895   }
2896   sc = deserialize_search (h, rh, NULL, ser);
2897   if (NULL != sc)
2898     sc->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, sc);
2899   GNUNET_free (ser);
2900   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2901   {
2902     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2903                 _("Failure while resuming search operation `%s': %s\n"),
2904                 filename, emsg);
2905     GNUNET_free (emsg);
2906   }
2907   return GNUNET_OK;
2908 }
2909
2910
2911 /**
2912  * Function called with a filename of serialized download operation
2913  * to deserialize.
2914  *
2915  * @param cls the 'struct GNUNET_FS_Handle*'
2916  * @param filename complete filename (absolute path)
2917  * @return GNUNET_OK (continue to iterate)
2918  */
2919 static int
2920 deserialize_download_file (void *cls, const char *filename)
2921 {
2922   struct GNUNET_FS_Handle *h = cls;
2923   char *ser;
2924   char *emsg;
2925   struct GNUNET_BIO_ReadHandle *rh;
2926
2927   ser = get_serialization_short_name (filename);
2928   rh = GNUNET_BIO_read_open (filename);
2929   if (NULL == rh)
2930   {
2931     if (0 != UNLINK (filename))
2932       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
2933     GNUNET_free (ser);
2934     return GNUNET_OK;
2935   }
2936   deserialize_download (h, rh, NULL, NULL, ser);
2937   GNUNET_free (ser);
2938   if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2939   {
2940     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2941                 _("Failure while resuming download operation `%s': %s\n"),
2942                 filename, emsg);
2943     GNUNET_free (emsg);
2944   }
2945   return GNUNET_OK;
2946 }
2947
2948
2949 /**
2950  * Deserialize informatin about pending operations.
2951  *
2952  * @param master_path which master directory should be scanned
2953  * @param proc function to call for each entry (will get 'h' for 'cls')
2954  * @param h the 'struct GNUNET_FS_Handle*'
2955  */
2956 static void
2957 deserialization_master (const char *master_path, GNUNET_FileNameCallback proc,
2958                         struct GNUNET_FS_Handle *h)
2959 {
2960   char *dn;
2961
2962   dn = get_serialization_file_name (h, master_path, "");
2963   if (NULL == dn)
2964     return;
2965   if (GNUNET_YES == GNUNET_DISK_directory_test (dn, GNUNET_YES))
2966     GNUNET_DISK_directory_scan (dn, proc, h);
2967   GNUNET_free (dn);
2968 }
2969
2970
2971 /**
2972  * Setup a connection to the file-sharing service.
2973  *
2974  * @param cfg configuration to use
2975  * @param client_name unique identifier for this client
2976  * @param upcb function to call to notify about FS actions
2977  * @param upcb_cls closure for upcb
2978  * @param flags specific attributes for fs-operations
2979  * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
2980  * @return NULL on error
2981  */
2982 struct GNUNET_FS_Handle *
2983 GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
2984                  const char *client_name, GNUNET_FS_ProgressCallback upcb,
2985                  void *upcb_cls, enum GNUNET_FS_Flags flags, ...)
2986 {
2987   struct GNUNET_FS_Handle *ret;
2988   enum GNUNET_FS_OPTIONS opt;
2989   va_list ap;
2990
2991   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Handle));
2992   ret->cfg = cfg;
2993   ret->client_name = GNUNET_strdup (client_name);
2994   ret->upcb = upcb;
2995   ret->upcb_cls = upcb_cls;
2996   ret->flags = flags;
2997   ret->max_parallel_downloads = DEFAULT_MAX_PARALLEL_DOWNLOADS;
2998   ret->max_parallel_requests = DEFAULT_MAX_PARALLEL_REQUESTS;
2999   ret->avg_block_latency = GNUNET_TIME_UNIT_MINUTES;    /* conservative starting point */
3000   va_start (ap, flags);
3001   while (GNUNET_FS_OPTIONS_END != (opt = va_arg (ap, enum GNUNET_FS_OPTIONS)))
3002   {
3003     switch (opt)
3004     {
3005     case GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM:
3006       ret->max_parallel_downloads = va_arg (ap, unsigned int);
3007
3008       break;
3009     case GNUNET_FS_OPTIONS_REQUEST_PARALLELISM:
3010       ret->max_parallel_requests = va_arg (ap, unsigned int);
3011
3012       break;
3013     default:
3014       GNUNET_break (0);
3015       GNUNET_free (ret->client_name);
3016       GNUNET_free (ret);
3017       va_end (ap);
3018       return NULL;
3019     }
3020   }
3021   va_end (ap);
3022   if (0 != (GNUNET_FS_FLAGS_PERSISTENCE & flags))
3023   {
3024     deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
3025                             &deserialize_publish_file, ret);
3026     deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
3027                             &deserialize_search_file, ret);
3028     deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
3029                             &deserialize_download_file, ret);
3030     deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
3031                             &deserialize_unindex_file, ret);
3032   }
3033   return ret;
3034 }
3035
3036
3037 /**
3038  * Close our connection with the file-sharing service.
3039  * The callback given to GNUNET_FS_start will no longer be
3040  * called after this function returns.
3041  *
3042  * @param h handle that was returned from GNUNET_FS_start
3043  */
3044 void
3045 GNUNET_FS_stop (struct GNUNET_FS_Handle *h)
3046 {
3047   while (h->top_head != NULL)
3048     h->top_head->ssf (h->top_head->ssf_cls);
3049   if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
3050     GNUNET_SCHEDULER_cancel (h->queue_job);
3051   GNUNET_free (h->client_name);
3052   GNUNET_free (h);
3053 }
3054
3055
3056 /* end of fs.c */