src/fs/fs.c

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