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%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%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     {
 528       return NULL;
 529     }
 530   ret = GNUNET_BIO_write_open (fn);
 531   if (ret == NULL)
 532     fprintf (stderr,
 533              "Failed to create write handle for `%s' from `%s/%s'\n",
 534              fn, ext, ent);
 535   GNUNET_free (fn);
 536   return ret;
 537 }
 538
 539
 540 /**
 541  * Return a write handle for serialization.
 542  *
 543  * @param h master context
 544  * @param ext component of the path
 545  * @param uni name of parent
 546  * @param ent entity identifier (or emtpy string for the directory)
 547  * @return NULL on error
 548  */
 549 static struct GNUNET_BIO_WriteHandle *
 550 get_write_handle_in_dir (struct GNUNET_FS_Handle *h,
 551                          const char *ext,
 552                          const char *uni,
 553                          const char *ent)
 554 {
 555   char *fn;
 556   struct GNUNET_BIO_WriteHandle *ret;
 557
 558   fn = get_serialization_file_name_in_dir (h, ext, uni, ent);
 559   if (fn == NULL)
 560     return NULL;
 561   ret = GNUNET_BIO_write_open (fn);
 562   GNUNET_free (fn);
 563   return ret;
 564 }
 565
 566
 567 /**
 568  * Remove serialization/deserialization file from disk.
 569  *
 570  * @param h master context
 571  * @param ext component of the path
 572  * @param ent entity identifier
 573  */
 574 void
 575 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h,
 576                              const char *ext,
 577                              const char *ent)
 578 {
 579   char *filename;
 580
 581   if ( (NULL == ent) ||
 582        (0 == strlen (ent)) )
 583     {
 584       GNUNET_break (0);
 585       return;
 586     }
 587   filename = get_serialization_file_name (h, ext, ent);
 588   if (0 != UNLINK (filename))
 589     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 590                               "unlink",
 591                               filename);
 592   GNUNET_free (filename);
 593 }
 594
 595
 596 /**
 597  * Remove serialization/deserialization file from disk.
 598  *
 599  * @param h master context
 600  * @param ext component of the path
 601  * @param uni parent name
 602  * @param ent entity identifier
 603  */
 604 static void
 605 remove_sync_file_in_dir (struct GNUNET_FS_Handle *h,
 606                          const char *ext,
 607                          const char *uni,
 608                          const char *ent)
 609 {
 610   char *filename;
 611
 612   if ( (NULL == ent) ||
 613        (0 == strlen (ent)) )
 614     {
 615       GNUNET_break (0);
 616       return;
 617     }
 618   filename = get_serialization_file_name_in_dir (h, ext, uni, ent);
 619   if (0 != UNLINK (filename))
 620     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 621                               "unlink",
 622                               filename);
 623   GNUNET_free (filename);
 624 }
 625
 626
 627 /**
 628  * Remove serialization/deserialization directory from disk.
 629  *
 630  * @param h master context
 631  * @param ext component of the path
 632  * @param uni unique name of parent
 633  */
 634 void
 635 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h,
 636                             const char *ext,
 637                             const char *uni)
 638 {
 639   char *dn;
 640
 641   if (uni == NULL)
 642     return;
 643   dn = get_serialization_file_name_in_dir (h, ext, uni, "");
 644   if (dn == NULL)
 645     return;
 646   if ( (GNUNET_OK == GNUNET_DISK_directory_test (dn)) &&
 647        (GNUNET_OK != GNUNET_DISK_directory_remove (dn)) )
 648     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 649                               "rmdir",
 650                               dn);
 651   GNUNET_free (dn);
 652 }
 653
 654
 655 /**
 656  * Serialize a 'start_time'.  Since we use start-times to
 657  * calculate the duration of some operation, we actually
 658  * do not serialize the absolute time but the (relative)
 659  * duration since the start time.  When we then
 660  * deserialize the start time, we take the current time and
 661  * subtract that duration so that we get again an absolute
 662  * time stamp that will result in correct performance
 663  * calculations.
 664  *
 665  * @param wh handle for writing
 666  * @param timestamp time to serialize
 667  * @return GNUNET_OK on success
 668  */
 669 static int
 670 write_start_time (struct GNUNET_BIO_WriteHandle *wh,
 671                   struct GNUNET_TIME_Absolute timestamp)
 672 {
 673   struct GNUNET_TIME_Relative dur;
 674
 675   dur = GNUNET_TIME_absolute_get_duration (timestamp);
 676   return GNUNET_BIO_write_int64 (wh, dur.value);
 677 }
 678
 679
 680 /**
 681  * Serialize a 'start_time'.  Since we use start-times to
 682  * calculate the duration of some operation, we actually
 683  * do not serialize the absolute time but the (relative)
 684  * duration since the start time.  When we then
 685  * deserialize the start time, we take the current time and
 686  * subtract that duration so that we get again an absolute
 687  * time stamp that will result in correct performance
 688  * calculations.
 689  *
 690  * @param rh handle for reading
 691  * @param timestamp where to write the deserialized timestamp
 692  * @return GNUNET_OK on success
 693  */
 694 static int
 695 read_start_time (struct GNUNET_BIO_ReadHandle *rh,
 696                  struct GNUNET_TIME_Absolute *timestamp)
 697 {
 698   struct GNUNET_TIME_Relative dur;
 699   if (GNUNET_OK !=
 700       GNUNET_BIO_read_int64 (rh, &dur.value))
 701     return GNUNET_SYSERR;
 702   *timestamp = GNUNET_TIME_absolute_subtract (GNUNET_TIME_absolute_get (),
 703                                               dur);
 704   return GNUNET_OK;
 705 }
 706
 707
 708 /**
 709  * Using the given serialization filename, try to deserialize
 710  * the file-information tree associated with it.
 711  *
 712  * @param h master context
 713  * @param filename name of the file (without directory) with
 714  *        the infromation
 715  * @return NULL on error
 716  */
 717 static struct GNUNET_FS_FileInformation *
 718 deserialize_file_information (struct GNUNET_FS_Handle *h,
 719                               const char *filename);
 720
 721
 722 /**
 723  * Using the given serialization filename, try to deserialize
 724  * the file-information tree associated with it.
 725  *
 726  * @param h master context
 727  * @param fn name of the file (without directory) with
 728  *        the infromation
 729  * @param rh handle for reading
 730  * @return NULL on error
 731  */
 732 static struct GNUNET_FS_FileInformation *
 733 deserialize_fi_node (struct GNUNET_FS_Handle *h,
 734                      const char *fn,
 735                      struct GNUNET_BIO_ReadHandle *rh)
 736 {
 737   struct GNUNET_FS_FileInformation *ret;
 738   struct GNUNET_FS_FileInformation *nxt;
 739   char b;
 740   char *ksks;
 741   char *chks;
 742   char *filename;
 743   uint32_t dsize;
 744
 745   if (GNUNET_OK !=
 746       GNUNET_BIO_read (rh, "status flag", &b, sizeof(b)))
 747     {
 748       GNUNET_break (0);
 749       return NULL;
 750     }
 751   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_FileInformation));
 752   ret->h = h;
 753   ksks = NULL;
 754   chks = NULL;
 755   filename = NULL;
 756   if ( (GNUNET_OK !=
 757         GNUNET_BIO_read_meta_data (rh, "metadata", &ret->meta)) ||
 758        (GNUNET_OK !=
 759         GNUNET_BIO_read_string (rh, "ksk-uri", &ksks, 32*1024)) ||
 760        ( (ksks != NULL) &&
 761          (NULL ==
 762           (ret->keywords = GNUNET_FS_uri_parse (ksks, NULL))) ) ||
 763        (GNUNET_YES !=
 764         GNUNET_FS_uri_test_ksk (ret->keywords)) ||
 765        (GNUNET_OK !=
 766         GNUNET_BIO_read_string (rh, "chk-uri", &chks, 1024)) ||
 767        ( (chks != NULL) &&
 768          ( (NULL ==
 769             (ret->chk_uri = GNUNET_FS_uri_parse (chks, NULL))) ||
 770            (GNUNET_YES !=
 771             GNUNET_FS_uri_test_chk (ret->chk_uri)) ) ) ||
 772        (GNUNET_OK !=
 773         GNUNET_BIO_read_int64 (rh, &ret->expirationTime.value)) ||
 774        (GNUNET_OK !=
 775         read_start_time (rh, &ret->start_time)) ||
 776        (GNUNET_OK !=
 777         GNUNET_BIO_read_string (rh, "emsg", &ret->emsg, 16*1024)) ||
 778        (GNUNET_OK !=
 779         GNUNET_BIO_read_string (rh, "fn", &ret->filename, 16*1024)) ||
 780        (GNUNET_OK !=
 781         GNUNET_BIO_read_int32 (rh, &ret->anonymity)) ||
 782        (GNUNET_OK !=
 783         GNUNET_BIO_read_int32 (rh, &ret->priority)) )
 784     {
 785       GNUNET_break (0);
 786       goto cleanup;
 787     }
 788   switch (b)
 789     {
 790     case 0: /* file-insert */
 791       if (GNUNET_OK !=
 792           GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
 793         {
 794           GNUNET_break (0);
 795           goto cleanup;
 796         }
 797       ret->is_directory = GNUNET_NO;
 798       ret->data.file.do_index = GNUNET_NO;
 799       ret->data.file.have_hash = GNUNET_NO;
 800       ret->data.file.index_start_confirmed = GNUNET_NO;
 801       if (GNUNET_NO == ret->is_published)
 802         {
 803           if (NULL == ret->filename)
 804             {
 805               ret->data.file.reader = &GNUNET_FS_data_reader_copy_;
 806               ret->data.file.reader_cls = GNUNET_malloc_large (ret->data.file.file_size);
 807               if (ret->data.file.reader_cls == NULL)
 808                 goto cleanup;
 809               if (GNUNET_OK !=
 810                   GNUNET_BIO_read (rh, "file-data", ret->data.file.reader_cls, ret->data.file.file_size))
 811                 {
 812                   GNUNET_break (0);
 813                   goto cleanup;
 814                 }
 815             }
 816           else
 817             {
 818               ret->data.file.reader = &GNUNET_FS_data_reader_file_;
 819               ret->data.file.reader_cls = GNUNET_FS_make_file_reader_context_ (ret->filename);
 820             }
 821         }
 822       break;
 823     case 1: /* file-index, no hash */
 824       if (NULL == ret->filename)
 825         {
 826           GNUNET_break (0);
 827           goto cleanup;
 828         }
 829       if (GNUNET_OK !=
 830           GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
 831         {
 832           GNUNET_break (0);
 833           goto cleanup;
 834         }
 835       ret->is_directory = GNUNET_NO;
 836       ret->data.file.do_index = GNUNET_YES;
 837       ret->data.file.have_hash = GNUNET_NO;
 838       ret->data.file.index_start_confirmed = GNUNET_NO;
 839       ret->data.file.reader = &GNUNET_FS_data_reader_file_;
 840       ret->data.file.reader_cls = GNUNET_FS_make_file_reader_context_ (ret->filename);
 841       break;
 842     case 2: /* file-index-with-hash */
 843       if (NULL == ret->filename)
 844         {
 845           GNUNET_break (0);
 846           goto cleanup;
 847         }
 848       if ( (GNUNET_OK !=
 849             GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
 850            (GNUNET_OK !=
 851             GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id, sizeof (GNUNET_HashCode))) )
 852         {
 853           GNUNET_break (0);
 854           goto cleanup;
 855         }
 856       ret->is_directory = GNUNET_NO;
 857       ret->data.file.do_index = GNUNET_YES;
 858       ret->data.file.have_hash = GNUNET_YES;
 859       ret->data.file.index_start_confirmed = GNUNET_NO;
 860       ret->data.file.reader = &GNUNET_FS_data_reader_file_;
 861       ret->data.file.reader_cls = GNUNET_FS_make_file_reader_context_ (ret->filename);
 862       break;
 863     case 3: /* file-index-with-hash-confirmed */
 864       if (NULL == ret->filename)
 865         {
 866           GNUNET_break (0);
 867           goto cleanup;
 868         }
 869       if ( (GNUNET_OK !=
 870             GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
 871            (GNUNET_OK !=
 872             GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id, sizeof (GNUNET_HashCode))) )
 873         {
 874           GNUNET_break (0);
 875           goto cleanup;
 876         }
 877       ret->is_directory = GNUNET_NO;
 878       ret->data.file.do_index = GNUNET_YES;
 879       ret->data.file.have_hash = GNUNET_YES;
 880       ret->data.file.index_start_confirmed = GNUNET_YES;
 881       ret->data.file.reader = &GNUNET_FS_data_reader_file_;
 882       ret->data.file.reader_cls = GNUNET_FS_make_file_reader_context_ (ret->filename);
 883       break;
 884     case 4: /* directory */
 885       if ( (GNUNET_OK !=
 886             GNUNET_BIO_read_int32 (rh, &dsize)) ||
 887            (NULL == (ret->data.dir.dir_data = GNUNET_malloc_large (dsize))) ||
 888            (GNUNET_OK !=
 889             GNUNET_BIO_read (rh, "dir-data", ret->data.dir.dir_data, dsize)) ||
 890            (GNUNET_OK !=
 891             GNUNET_BIO_read_string (rh, "ent-filename", &filename, 16*1024)) )
 892         {
 893           GNUNET_break (0);
 894           goto cleanup;
 895         }
 896       ret->data.dir.dir_size = (uint32_t) dsize;
 897       ret->is_directory = GNUNET_YES;
 898       if (filename != NULL)
 899         {
 900           ret->data.dir.entries = deserialize_file_information (h, filename);
 901           GNUNET_free (filename);
 902           filename = NULL;
 903           nxt = ret->data.dir.entries;
 904           while (nxt != NULL)
 905             {
 906               nxt->dir = ret;
 907               nxt = nxt->next;
 908             }
 909         }
 910       break;
 911     default:
 912       GNUNET_break (0);
 913       goto cleanup;
 914     }
 915   ret->serialization = GNUNET_strdup (fn);
 916   if (GNUNET_OK !=
 917       GNUNET_BIO_read_string (rh, "nxt-filename", &filename, 16*1024))
 918     {
 919       GNUNET_break (0);
 920       goto cleanup;
 921     }
 922   if (filename != NULL)
 923     {
 924       ret->next = deserialize_file_information (h, filename);
 925       GNUNET_free (filename);
 926       filename = NULL;
 927     }
 928   GNUNET_free_non_null (ksks);
 929   GNUNET_free_non_null (chks);
 930   return ret;
 931  cleanup:
 932   GNUNET_free_non_null (ksks);
 933   GNUNET_free_non_null (chks);
 934   GNUNET_free_non_null (filename);
 935   GNUNET_FS_file_information_destroy (ret, NULL, NULL);
 936   return NULL;
 937 }
 938
 939
 940 /**
 941  * Using the given serialization filename, try to deserialize
 942  * the file-information tree associated with it.
 943  *
 944  * @param h master context
 945  * @param filename name of the file (without directory) with
 946  *        the infromation
 947  * @return NULL on error
 948  */
 949 static struct GNUNET_FS_FileInformation *
 950 deserialize_file_information (struct GNUNET_FS_Handle *h,
 951                               const char *filename)
 952 {
 953   struct GNUNET_FS_FileInformation *ret;
 954   struct GNUNET_BIO_ReadHandle *rh;
 955   char *emsg;
 956
 957   rh = get_read_handle (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
 958   if (rh == NULL)
 959     return NULL;
 960   ret = deserialize_fi_node (h, filename, rh);
 961   if (GNUNET_OK !=
 962       GNUNET_BIO_read_close (rh, &emsg))
 963     {
 964       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 965                   _("Failed to resume publishing information `%s': %s\n"),
 966                   filename,
 967                   emsg);
 968       GNUNET_free (emsg);
 969     }
 970   return ret;
 971 }
 972
 973
 974 /**
 975  * Given a serialization name (full absolute path), return the
 976  * basename of the file (without the path), which must only
 977  * consist of the 6 random characters.
 978  *
 979  * @param fullname name to extract the basename from
 980  * @return copy of the basename, NULL on error
 981  */
 982 static char *
 983 get_serialization_short_name (const char *fullname)
 984 {
 985   const char *end;
 986   const char *nxt;
 987
 988   end = NULL;
 989   nxt = fullname;
 990   /* FIXME: we could do this faster since we know
 991      the length of 'end'... */
 992   while ('\0' != *nxt)
 993     {
 994       if (DIR_SEPARATOR == *nxt)
 995         end = nxt + 1;
 996       nxt++;
 997     }
 998   if ( (end == NULL) ||
 999        (strlen (end) == 0) )
1000     {
1001       GNUNET_break (0);
1002       return NULL;
1003     }
1004   GNUNET_break (6 == strlen (end));
1005   return GNUNET_strdup (end);
1006 }
1007
1008
1009 /**
1010  * Create a new random name for serialization.  Also checks if persistence
1011  * is enabled and returns NULL if not.
1012  *
1013  * @param h master context
1014  * @param ext component of the path
1015  * @return NULL on errror
1016  */
1017 static char *
1018 make_serialization_file_name (struct GNUNET_FS_Handle *h,
1019                               const char *ext)
1020 {
1021   char *fn;
1022   char *dn;
1023   char *ret;
1024
1025   if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1026     return NULL; /* persistence not requested */
1027   dn = get_serialization_file_name (h, ext, "");
1028   if (GNUNET_OK !=
1029       GNUNET_DISK_directory_create_for_file (dn))
1030     {
1031       GNUNET_free (dn);
1032       return NULL;
1033     }
1034   fn = GNUNET_DISK_mktemp (dn);
1035   GNUNET_free (dn);
1036   if (fn == NULL)
1037     return NULL; /* epic fail */
1038   ret = get_serialization_short_name (fn);
1039   GNUNET_free (fn);
1040   return ret;
1041 }
1042
1043
1044 /**
1045  * Create a new random name for serialization.  Also checks if persistence
1046  * is enabled and returns NULL if not.
1047  *
1048  * @param h master context
1049  * @param ext component of the path
1050  * @param uni name of parent
1051  * @return NULL on errror
1052  */
1053 static char *
1054 make_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h,
1055                                      const char *ext,
1056                                      const char *uni)
1057 {
1058   char *fn;
1059   char *dn;
1060   char *ret;
1061
1062   if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1063     return NULL; /* persistence not requested */
1064   dn = get_serialization_file_name_in_dir (h, ext, uni, "");
1065   if (GNUNET_OK !=
1066       GNUNET_DISK_directory_create_for_file (dn))
1067     {
1068       GNUNET_free (dn);
1069       return NULL;
1070     }
1071   fn = GNUNET_DISK_mktemp (dn);
1072   GNUNET_free (dn);
1073   if (fn == NULL)
1074     return NULL; /* epic fail */
1075   ret = get_serialization_short_name (fn);
1076   GNUNET_free (fn);
1077   return ret;
1078 }
1079
1080
1081 /**
1082  * Copy all of the data from the reader to the write handle.
1083  *
1084  * @param wh write handle
1085  * @param fi file with reader
1086  * @return GNUNET_OK on success
1087  */
1088 static int
1089 copy_from_reader (struct GNUNET_BIO_WriteHandle *wh,
1090                   struct GNUNET_FS_FileInformation * fi)
1091 {
1092   char buf[32 * 1024];
1093   uint64_t off;
1094   size_t ret;
1095   char *emsg;
1096
1097   emsg = NULL;
1098   off = 0;
1099   while (off < fi->data.file.file_size)
1100     {
1101       ret = fi->data.file.reader (fi->data.file.reader_cls,
1102                                   off, sizeof (buf),
1103                                   buf,
1104                                   &emsg);
1105       if (ret == 0)
1106         {
1107           GNUNET_free (emsg);
1108           return GNUNET_SYSERR;
1109         }
1110       if (GNUNET_OK !=
1111           GNUNET_BIO_write (wh, buf, ret))
1112         return GNUNET_SYSERR;
1113       off += ret;
1114     }
1115   return GNUNET_OK;
1116 }
1117
1118
1119 /**
1120  * Create a temporary file on disk to store the current
1121  * state of "fi" in.
1122  *
1123  * @param fi file information to sync with disk
1124  */
1125 void
1126 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation * fi)
1127 {
1128   char *fn;
1129   struct GNUNET_BIO_WriteHandle *wh;
1130   char b;
1131   char *ksks;
1132   char *chks;
1133
1134   if (NULL == fi->serialization)
1135     fi->serialization = make_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO);
1136   if (NULL == fi->serialization)
1137     return;
1138   wh = get_write_handle (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO, fi->serialization);
1139   if (wh == NULL)
1140     {
1141       GNUNET_free (fi->serialization);
1142       fi->serialization = NULL;
1143       return;
1144     }
1145   if (GNUNET_YES == fi->is_directory)
1146     b = 4;
1147   else if (GNUNET_YES == fi->data.file.index_start_confirmed)
1148     b = 3;
1149   else if (GNUNET_YES == fi->data.file.have_hash)
1150     b = 2;
1151   else if (GNUNET_YES == fi->data.file.do_index)
1152     b = 1;
1153   else
1154     b = 0;
1155   if (fi->keywords != NULL)
1156     ksks = GNUNET_FS_uri_to_string (fi->keywords);
1157   else
1158     ksks = NULL;
1159   if (fi->chk_uri != NULL)
1160     chks = GNUNET_FS_uri_to_string (fi->chk_uri);
1161   else
1162     chks = NULL;
1163   if ( (GNUNET_OK !=
1164         GNUNET_BIO_write (wh, &b, sizeof (b))) ||
1165        (GNUNET_OK !=
1166         GNUNET_BIO_write_meta_data (wh, fi->meta)) ||
1167        (GNUNET_OK !=
1168         GNUNET_BIO_write_string (wh, ksks)) ||
1169        (GNUNET_OK !=
1170         GNUNET_BIO_write_string (wh, chks)) ||
1171        (GNUNET_OK !=
1172         GNUNET_BIO_write_int64 (wh, fi->expirationTime.value)) ||
1173        (GNUNET_OK !=
1174         write_start_time (wh, fi->start_time)) ||
1175        (GNUNET_OK !=
1176         GNUNET_BIO_write_string (wh, fi->emsg)) ||
1177        (GNUNET_OK !=
1178         GNUNET_BIO_write_string (wh, fi->filename)) ||
1179        (GNUNET_OK !=
1180         GNUNET_BIO_write_int32 (wh, fi->anonymity)) ||
1181        (GNUNET_OK !=
1182         GNUNET_BIO_write_int32 (wh, fi->priority)) )
1183     {
1184       GNUNET_break (0);
1185       goto cleanup;
1186     }
1187   GNUNET_free_non_null (chks);
1188   chks = NULL;
1189   GNUNET_free_non_null (ksks);
1190   ksks = NULL;
1191
1192   switch (b)
1193     {
1194     case 0: /* file-insert */
1195       if (GNUNET_OK !=
1196           GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1197         {
1198           GNUNET_break (0);
1199           goto cleanup;
1200         }
1201       if ( (GNUNET_NO == fi->is_published) &&
1202            (NULL == fi->filename) )
1203         if (GNUNET_OK !=
1204             copy_from_reader (wh, fi))
1205           {
1206             GNUNET_break (0);
1207             goto cleanup;
1208           }
1209       break;
1210     case 1: /* file-index, no hash */
1211       if (NULL == fi->filename)
1212         {
1213           GNUNET_break (0);
1214           goto cleanup;
1215         }
1216       if (GNUNET_OK !=
1217           GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1218         {
1219           GNUNET_break (0);
1220           goto cleanup;
1221         }
1222       break;
1223     case 2: /* file-index-with-hash */
1224     case 3: /* file-index-with-hash-confirmed */
1225       if (NULL == fi->filename)
1226         {
1227           GNUNET_break (0);
1228           goto cleanup;
1229         }
1230       if ( (GNUNET_OK !=
1231             GNUNET_BIO_write_int64 (wh, fi->data.file.file_size)) ||
1232            (GNUNET_OK !=
1233             GNUNET_BIO_write (wh, &fi->data.file.file_id, sizeof (GNUNET_HashCode))) )
1234         {
1235           GNUNET_break (0);
1236           goto cleanup;
1237         }
1238       break;
1239     case 4: /* directory */
1240       if ( (GNUNET_OK !=
1241             GNUNET_BIO_write_int32 (wh, fi->data.dir.dir_size)) ||
1242            (GNUNET_OK !=
1243             GNUNET_BIO_write (wh, fi->data.dir.dir_data, (uint32_t) fi->data.dir.dir_size)) ||
1244            (GNUNET_OK !=
1245             GNUNET_BIO_write_string (wh, fi->data.dir.entries->serialization)) )
1246         {
1247           GNUNET_break (0);
1248           goto cleanup;
1249         }
1250       break;
1251     default:
1252       GNUNET_assert (0);
1253       goto cleanup;
1254     }
1255   if (GNUNET_OK !=
1256       GNUNET_BIO_write_string (wh, (fi->next != NULL) ? fi->next->serialization : NULL))
1257     {
1258       GNUNET_break (0);
1259       goto cleanup;
1260     }
1261   if (GNUNET_OK !=
1262       GNUNET_BIO_write_close (wh))
1263     {
1264       GNUNET_break (0);
1265       goto cleanup;
1266     }
1267   return; /* done! */
1268  cleanup:
1269   (void) GNUNET_BIO_write_close (wh);
1270   GNUNET_free_non_null (chks);
1271   GNUNET_free_non_null (ksks);
1272   fn = get_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO, fi->serialization);
1273   if (0 != UNLINK (fn))
1274     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1275   GNUNET_free (fn);
1276   GNUNET_free (fi->serialization);
1277   fi->serialization = NULL;
1278 }
1279
1280
1281
1282 /**
1283  * Find the entry in the file information struct where the
1284  * serialization filename matches the given name.
1285  *
1286  * @param pos file information to search
1287  * @param srch filename to search for
1288  * @return NULL if srch was not found in this subtree
1289  */
1290 static struct GNUNET_FS_FileInformation *
1291 find_file_position (struct GNUNET_FS_FileInformation *pos,
1292                     const char *srch)
1293 {
1294   struct GNUNET_FS_FileInformation *r;
1295
1296   while (pos != NULL)
1297     {
1298       if (0 == strcmp (srch,
1299                        pos->serialization))
1300         return pos;
1301       if (pos->is_directory)
1302         {
1303           r = find_file_position (pos->data.dir.entries,
1304                                   srch);
1305           if (r != NULL)
1306             return r;
1307         }
1308       pos = pos->next;
1309     }
1310   return NULL;
1311 }
1312
1313
1314 /**
1315  * Signal the FS's progress function that we are resuming
1316  * an upload.
1317  *
1318  * @param cls closure (of type "struct GNUNET_FS_PublishContext*")
1319  * @param fi the entry in the publish-structure
1320  * @param length length of the file or directory
1321  * @param meta metadata for the file or directory (can be modified)
1322  * @param uri pointer to the keywords that will be used for this entry (can be modified)
1323  * @param anonymity pointer to selected anonymity level (can be modified)
1324  * @param priority pointer to selected priority (can be modified)
1325  * @param expirationTime pointer to selected expiration time (can be modified)
1326  * @param client_info pointer to client context set upon creation (can be modified)
1327  * @return GNUNET_OK to continue (always)
1328  */
1329 static int
1330 fip_signal_resume(void *cls,
1331                   struct GNUNET_FS_FileInformation *fi,
1332                   uint64_t length,
1333                   struct GNUNET_CONTAINER_MetaData *meta,
1334                   struct GNUNET_FS_Uri **uri,
1335                   uint32_t *anonymity,
1336                   uint32_t *priority,
1337                   struct GNUNET_TIME_Absolute *expirationTime,
1338                   void **client_info)
1339 {
1340   struct GNUNET_FS_PublishContext *sc = cls;
1341   struct GNUNET_FS_ProgressInfo pi;
1342
1343   pi.status = GNUNET_FS_STATUS_PUBLISH_RESUME;
1344   pi.value.publish.specifics.resume.message = sc->fi->emsg;
1345   pi.value.publish.specifics.resume.chk_uri = sc->fi->chk_uri;
1346   *client_info = GNUNET_FS_publish_make_status_ (&pi, sc, fi, 0);
1347   return GNUNET_OK;
1348 }
1349
1350
1351 /**
1352  * Function called with a filename of serialized publishing operation
1353  * to deserialize.
1354  *
1355  * @param cls the 'struct GNUNET_FS_Handle*'
1356  * @param filename complete filename (absolute path)
1357  * @return GNUNET_OK (continue to iterate)
1358  */
1359 static int
1360 deserialize_publish_file (void *cls,
1361                           const char *filename)
1362 {
1363   struct GNUNET_FS_Handle *h = cls;
1364   struct GNUNET_BIO_ReadHandle *rh;
1365   struct GNUNET_FS_PublishContext *pc;
1366   int32_t options;
1367   int32_t all_done;
1368   char *fi_root;
1369   char *ns;
1370   char *fi_pos;
1371   char *emsg;
1372
1373   pc = GNUNET_malloc (sizeof (struct GNUNET_FS_PublishContext));
1374   pc->h = h;
1375   pc->serialization = get_serialization_short_name (filename);
1376   fi_root = NULL;
1377   fi_pos = NULL;
1378   ns = NULL;
1379   rh = GNUNET_BIO_read_open (filename);
1380   if (rh == NULL)
1381     {
1382       GNUNET_break (0);
1383       goto cleanup;
1384     }
1385   if ( (GNUNET_OK !=
1386         GNUNET_BIO_read_string (rh, "publish-nid", &pc->nid, 1024)) ||
1387        (GNUNET_OK !=
1388         GNUNET_BIO_read_string (rh, "publish-nuid", &pc->nuid, 1024)) ||
1389        (GNUNET_OK !=
1390         GNUNET_BIO_read_int32 (rh, &options)) ||
1391        (GNUNET_OK !=
1392         GNUNET_BIO_read_int32 (rh, &all_done)) ||
1393        (GNUNET_OK !=
1394         GNUNET_BIO_read_string (rh, "publish-firoot", &fi_root, 128)) ||
1395        (GNUNET_OK !=
1396         GNUNET_BIO_read_string (rh, "publish-fipos", &fi_pos, 128)) ||
1397        (GNUNET_OK !=
1398         GNUNET_BIO_read_string (rh, "publish-ns", &ns, 1024)) )
1399     {
1400       GNUNET_break (0);
1401       goto cleanup;
1402     }
1403   pc->options = options;
1404   pc->all_done = all_done;
1405   pc->fi = deserialize_file_information (h, fi_root);
1406   if (pc->fi == NULL)
1407     {
1408       GNUNET_break (0);
1409       goto cleanup;
1410     }
1411   if (ns != NULL)
1412     {
1413       pc->namespace = GNUNET_FS_namespace_create (h, ns);
1414       if (pc->namespace == NULL)
1415         {
1416           GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1417                       _("Failed to recover namespace `%s', cannot resume publishing operation.\n"),
1418                       ns);
1419           goto cleanup;
1420         }
1421     }
1422   if (fi_pos != NULL)
1423     {
1424       pc->fi_pos = find_file_position (pc->fi,
1425                                        fi_pos);
1426       GNUNET_free (fi_pos);
1427       fi_pos = NULL;
1428       if (pc->fi_pos == NULL)
1429         {
1430           /* failed to find position for resuming, outch! Will start from root! */
1431           GNUNET_break (0);
1432           if (pc->all_done != GNUNET_YES)
1433             pc->fi_pos = pc->fi;
1434         }
1435     }
1436   /* generate RESUME event(s) */
1437   GNUNET_FS_file_information_inspect (pc->fi,
1438                                       &fip_signal_resume,
1439                                       pc);
1440
1441   /* re-start publishing (if needed)... */
1442   if (pc->all_done != GNUNET_YES)
1443     pc->upload_task
1444       = GNUNET_SCHEDULER_add_with_priority (h->sched,
1445                                             GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
1446                                             &GNUNET_FS_publish_main_,
1447                                             pc);
1448   if (GNUNET_OK !=
1449       GNUNET_BIO_read_close (rh, &emsg))
1450     {
1451       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1452                   _("Failure while resuming publishing operation `%s': %s\n"),
1453                   filename,
1454                   emsg);
1455       GNUNET_free (emsg);
1456     }
1457   GNUNET_free_non_null (ns);
1458   pc->top = GNUNET_FS_make_top (h, &GNUNET_FS_publish_signal_suspend_, pc);
1459   return GNUNET_OK;
1460  cleanup:
1461   GNUNET_free_non_null (pc->nid);
1462   GNUNET_free_non_null (pc->nuid);
1463   GNUNET_free_non_null (fi_root);
1464   GNUNET_free_non_null (fi_pos);
1465   GNUNET_free_non_null (ns);
1466   if ( (rh != NULL) &&
1467        (GNUNET_OK !=
1468         GNUNET_BIO_read_close (rh, &emsg)) )
1469     {
1470       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1471                   _("Failed to resume publishing operation `%s': %s\n"),
1472                   filename,
1473                   emsg);
1474       GNUNET_free (emsg);
1475     }
1476   if (pc->fi != NULL)
1477     GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
1478   if (0 != UNLINK (filename))
1479     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
1480   GNUNET_free_non_null (pc->serialization);
1481   GNUNET_free (pc);
1482   return GNUNET_OK;
1483 }
1484
1485
1486 /**
1487  * Synchronize this publishing struct with its mirror
1488  * on disk.  Note that all internal FS-operations that change
1489  * publishing structs should already call "sync" internally,
1490  * so this function is likely not useful for clients.
1491  *
1492  * @param pc the struct to sync
1493  */
1494 void
1495 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc)
1496 {
1497   struct GNUNET_BIO_WriteHandle *wh;
1498
1499   if (NULL == pc->serialization)
1500     pc->serialization = make_serialization_file_name (pc->h,
1501                                                       GNUNET_FS_SYNC_PATH_MASTER_PUBLISH);
1502   if (NULL == pc->serialization)
1503     return;
1504   if (NULL == pc->fi)
1505     return;
1506   if (NULL == pc->fi->serialization)
1507     {
1508       GNUNET_break (0);
1509       return;
1510     }
1511   wh = get_write_handle (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH, pc->serialization);
1512   if (wh == NULL)
1513     {
1514       GNUNET_break (0);
1515       goto cleanup;
1516     }
1517   if ( (GNUNET_OK !=
1518         GNUNET_BIO_write_string (wh, pc->nid)) ||
1519        (GNUNET_OK !=
1520         GNUNET_BIO_write_string (wh, pc->nuid)) ||
1521        (GNUNET_OK !=
1522         GNUNET_BIO_write_int32 (wh, pc->options)) ||
1523        (GNUNET_OK !=
1524         GNUNET_BIO_write_int32 (wh, pc->all_done)) ||
1525        (GNUNET_OK !=
1526         GNUNET_BIO_write_string (wh, pc->fi->serialization)) ||
1527        (GNUNET_OK !=
1528         GNUNET_BIO_write_string (wh, (pc->fi_pos == NULL) ? NULL : pc->fi_pos->serialization)) ||
1529        (GNUNET_OK !=
1530         GNUNET_BIO_write_string (wh, (pc->namespace == NULL) ? NULL : pc->namespace->name)) )
1531    {
1532      GNUNET_break (0);
1533      goto cleanup;
1534    }
1535  if (GNUNET_OK !=
1536      GNUNET_BIO_write_close (wh))
1537    {
1538      wh = NULL;
1539      GNUNET_break (0);
1540      goto cleanup;
1541    }
1542  return;
1543  cleanup:
1544  if (wh != NULL)
1545      (void) GNUNET_BIO_write_close (wh);
1546  GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH, pc->serialization);
1547  GNUNET_free (pc->serialization);
1548  pc->serialization = NULL;
1549 }
1550
1551
1552 /**
1553  * Synchronize this unindex struct with its mirror
1554  * on disk.  Note that all internal FS-operations that change
1555  * publishing structs should already call "sync" internally,
1556  * so this function is likely not useful for clients.
1557  *
1558  * @param uc the struct to sync
1559  */
1560 void
1561 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc)
1562 {
1563   struct GNUNET_BIO_WriteHandle *wh;
1564
1565   if (UNINDEX_STATE_ABORTED == uc->state)
1566     return;
1567   if (NULL == uc->serialization)
1568     uc->serialization = make_serialization_file_name (uc->h,
1569                                                       GNUNET_FS_SYNC_PATH_MASTER_UNINDEX);
1570   if (NULL == uc->serialization)
1571     return;
1572   wh = get_write_handle (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, uc->serialization);
1573   if (wh == NULL)
1574     {
1575       GNUNET_break (0);
1576       goto cleanup;
1577     }
1578   if ( (GNUNET_OK !=
1579         GNUNET_BIO_write_string (wh, uc->filename)) ||
1580        (GNUNET_OK !=
1581         GNUNET_BIO_write_int64 (wh, uc->file_size)) ||
1582        (GNUNET_OK !=
1583         write_start_time (wh, uc->start_time)) ||
1584        (GNUNET_OK !=
1585         GNUNET_BIO_write_int32 (wh, (uint32_t) uc->state)) ||
1586        ( (uc->state == UNINDEX_STATE_FS_NOTIFY) &&
1587          (GNUNET_OK !=
1588           GNUNET_BIO_write (wh, &uc->file_id, sizeof (GNUNET_HashCode))) ) ||
1589        ( (uc->state == UNINDEX_STATE_ERROR) &&
1590          (GNUNET_OK !=
1591           GNUNET_BIO_write_string (wh, uc->emsg)) ) )
1592     {
1593       GNUNET_break (0);
1594       goto cleanup;
1595     }
1596   if (GNUNET_OK !=
1597       GNUNET_BIO_write_close (wh))
1598     {
1599       wh = NULL;
1600       GNUNET_break (0);
1601       goto cleanup;
1602     }
1603   return;
1604  cleanup:
1605   if (wh != NULL)
1606     (void) GNUNET_BIO_write_close (wh);
1607   GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, uc->serialization);
1608   GNUNET_free (uc->serialization);
1609   uc->serialization = NULL;
1610 }
1611
1612
1613 /**
1614  * Serialize an active or pending download request.
1615  *
1616  * @param cls the 'struct GNUNET_BIO_WriteHandle*'
1617  * @param key unused, can be NULL
1618  * @param value the 'struct DownloadRequest'
1619  * @return GNUNET_YES on success, GNUNET_NO on error
1620  */
1621 static int
1622 write_download_request (void *cls,
1623                         const GNUNET_HashCode *key,
1624                         void *value)
1625 {
1626   struct GNUNET_BIO_WriteHandle *wh = cls;
1627   struct DownloadRequest *dr = value;
1628
1629   if ( (GNUNET_OK !=
1630         GNUNET_BIO_write (wh, &dr->chk, sizeof (struct ContentHashKey))) ||
1631        (GNUNET_OK !=
1632         GNUNET_BIO_write_int64 (wh, dr->offset)) ||
1633        (GNUNET_OK !=
1634         GNUNET_BIO_write_int32 (wh, dr->depth)) )
1635     return GNUNET_NO;
1636   return GNUNET_YES;
1637 }
1638
1639
1640 /**
1641  * Count active download requests.
1642  *
1643  * @param cls the 'uint32_t*' counter
1644  * @param key unused, can be NULL
1645  * @param value the 'struct DownloadRequest'
1646  * @return GNUNET_YES (continue iteration)
1647  */
1648 static int
1649 count_download_requests (void *cls,
1650                         const GNUNET_HashCode *key,
1651                         void *value)
1652 {
1653   uint32_t *counter = cls;
1654
1655   (*counter)++;
1656   return GNUNET_YES;
1657 }
1658
1659
1660 /**
1661  * Compute the name of the sync file (or directory) for the given download
1662  * context.
1663  *
1664  * @param dc download context to compute for
1665  * @param uni unique filename to use, use "" for the directory name
1666  * @return the expanded file name, NULL for none
1667  */
1668 static char *
1669 get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc,
1670                             const char *uni)
1671 {
1672   char *par;
1673   char *epar;
1674
1675   if (dc->parent == NULL)
1676     return get_serialization_file_name (dc->h,
1677                                         (dc->search != NULL) ?
1678                                         GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
1679                                         GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
1680                                         uni);
1681   if (dc->parent->serialization == NULL)
1682     return NULL;
1683   par = get_download_sync_filename (dc->parent, dc->parent->serialization);
1684   if (par == NULL)
1685     return NULL;
1686   GNUNET_asprintf (&epar,
1687                    "%s.dir%s%s",
1688                    par,
1689                    DIR_SEPARATOR_STR,
1690                    uni);
1691   GNUNET_free (par);
1692   return epar;
1693 }
1694
1695
1696 /**
1697  * Synchronize this download struct with its mirror
1698  * on disk.  Note that all internal FS-operations that change
1699  * publishing structs should already call "sync" internally,
1700  * so this function is likely not useful for clients.
1701  *
1702  * @param dc the struct to sync
1703  */
1704 void
1705 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc)
1706 {
1707   struct GNUNET_BIO_WriteHandle *wh;
1708   char *uris;
1709   char *fn;
1710   char *dir;
1711   uint32_t num_pending;
1712
1713   if (NULL == dc->serialization)
1714     {
1715       dir = get_download_sync_filename (dc, "");
1716       if (dir == NULL)
1717         return;
1718       if (GNUNET_OK !=
1719           GNUNET_DISK_directory_create_for_file (dir))
1720         {
1721           GNUNET_free (dir);
1722           return;
1723         }
1724       fn = GNUNET_DISK_mktemp (dir);
1725       GNUNET_free (dir);
1726       dc->serialization = get_serialization_short_name (fn);
1727     }
1728   else
1729     {
1730       fn = get_download_sync_filename (dc, dc->serialization);
1731     }
1732   wh = GNUNET_BIO_write_open (fn);
1733   if (wh == NULL)
1734     {
1735       GNUNET_free (dc->serialization);
1736       dc->serialization = NULL;
1737       GNUNET_free (fn);
1738       return;
1739     }
1740   GNUNET_assert ( (GNUNET_YES == GNUNET_FS_uri_test_chk (dc->uri)) ||
1741                   (GNUNET_YES == GNUNET_FS_uri_test_loc (dc->uri)) );
1742   uris = GNUNET_FS_uri_to_string (dc->uri);
1743   num_pending = 0;
1744   if (dc->emsg == NULL)
1745     (void) GNUNET_CONTAINER_multihashmap_iterate (dc->active,
1746                                                   &count_download_requests,
1747                                                   &num_pending);
1748   GNUNET_assert ( (dc->length == dc->completed) ||
1749                   (dc->emsg != NULL) ||
1750                   (num_pending > 0) );
1751   if ( (GNUNET_OK !=
1752         GNUNET_BIO_write_string (wh, uris)) ||
1753        (GNUNET_OK !=
1754         GNUNET_BIO_write_meta_data (wh, dc->meta)) ||
1755        (GNUNET_OK !=
1756         GNUNET_BIO_write_string (wh, dc->emsg)) ||
1757        (GNUNET_OK !=
1758         GNUNET_BIO_write_string (wh, dc->filename)) ||
1759        (GNUNET_OK !=
1760         GNUNET_BIO_write_string (wh, dc->temp_filename)) ||
1761        (GNUNET_OK !=
1762         GNUNET_BIO_write_int64 (wh, dc->old_file_size)) ||
1763        (GNUNET_OK !=
1764         GNUNET_BIO_write_int64 (wh, dc->offset)) ||
1765        (GNUNET_OK !=
1766         GNUNET_BIO_write_int64 (wh, dc->length)) ||
1767        (GNUNET_OK !=
1768         GNUNET_BIO_write_int64 (wh, dc->completed)) ||
1769        (GNUNET_OK !=
1770         write_start_time (wh, dc->start_time)) ||
1771        (GNUNET_OK !=
1772         GNUNET_BIO_write_int32 (wh, dc->anonymity)) ||
1773        (GNUNET_OK !=
1774         GNUNET_BIO_write_int32 (wh, (uint32_t) dc->options)) ||
1775        (GNUNET_OK !=
1776         GNUNET_BIO_write_int32 (wh, (uint32_t) dc->has_finished)) ||
1777        (GNUNET_OK !=
1778         GNUNET_BIO_write_int32 (wh, num_pending)) )
1779     {
1780       GNUNET_break (0);
1781       goto cleanup;
1782     }
1783   if (GNUNET_SYSERR ==
1784       GNUNET_CONTAINER_multihashmap_iterate (dc->active,
1785                                              &write_download_request,
1786                                              wh))
1787     {
1788       GNUNET_break (0);
1789       goto cleanup;
1790     }
1791   GNUNET_free_non_null (uris);
1792   if (GNUNET_OK !=
1793       GNUNET_BIO_write_close (wh))
1794     {
1795       wh = NULL;
1796       GNUNET_break (0);
1797       goto cleanup;
1798     }
1799   GNUNET_free (fn);
1800   return;
1801  cleanup:
1802   if (NULL != wh)
1803     (void) GNUNET_BIO_write_close (wh);
1804   GNUNET_free_non_null (uris);
1805   if (0 != UNLINK (fn))
1806     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1807   GNUNET_free (fn);
1808   GNUNET_free (dc->serialization);
1809   dc->serialization = NULL;
1810 }
1811
1812
1813 /**
1814  * Synchronize this search result with its mirror
1815  * on disk.  Note that all internal FS-operations that change
1816  * publishing structs should already call "sync" internally,
1817  * so this function is likely not useful for clients.
1818  *
1819  * @param sr the struct to sync
1820  */
1821 void
1822 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr)
1823 {
1824   struct GNUNET_BIO_WriteHandle *wh;
1825   char *uris;
1826
1827   uris = NULL;
1828   if (NULL == sr->serialization)
1829     sr->serialization = make_serialization_file_name_in_dir (sr->sc->h,
1830                                                              (sr->sc->psearch_result == NULL)
1831                                                              ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
1832                                                              : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1833                                                              sr->sc->serialization);
1834   if (NULL == sr->serialization)
1835     return;
1836   wh = get_write_handle_in_dir (sr->sc->h,
1837                                 (sr->sc->psearch_result == NULL)
1838                                 ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
1839                                 : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1840                                 sr->sc->serialization,
1841                                 sr->serialization);
1842   if (wh == NULL)
1843     {
1844       GNUNET_break (0);
1845       goto cleanup;
1846     }
1847   uris = GNUNET_FS_uri_to_string (sr->uri);
1848   if ( (GNUNET_OK !=
1849         GNUNET_BIO_write_string (wh, uris)) ||
1850        (GNUNET_OK !=
1851         GNUNET_BIO_write_string (wh, sr->download != NULL ? sr->download->serialization : NULL)) ||
1852        (GNUNET_OK !=
1853         GNUNET_BIO_write_string (wh, sr->update_search != NULL ? sr->update_search->serialization : NULL)) ||
1854        (GNUNET_OK !=
1855         GNUNET_BIO_write_meta_data (wh, sr->meta)) ||
1856        (GNUNET_OK !=
1857         GNUNET_BIO_write (wh, &sr->key, sizeof (GNUNET_HashCode))) ||
1858        (GNUNET_OK !=
1859         GNUNET_BIO_write_int32 (wh, sr->mandatory_missing)) ||
1860        (GNUNET_OK !=
1861         GNUNET_BIO_write_int32 (wh, sr->optional_support)) ||
1862        (GNUNET_OK !=
1863         GNUNET_BIO_write_int32 (wh, sr->availability_success)) ||
1864        (GNUNET_OK !=
1865         GNUNET_BIO_write_int32 (wh, sr->availability_trials)) )
1866     {
1867       GNUNET_break (0);
1868       goto cleanup;
1869     }
1870   if (GNUNET_OK !=
1871       GNUNET_BIO_write_close (wh))
1872     {
1873       wh = NULL;
1874       GNUNET_break (0);
1875       goto cleanup;
1876     }
1877   GNUNET_free_non_null (uris);
1878   return;
1879  cleanup:
1880   GNUNET_free_non_null (uris);
1881   if (wh != NULL)
1882     (void)  GNUNET_BIO_write_close (wh);
1883   remove_sync_file_in_dir (sr->sc->h,
1884                            (sr->sc->psearch_result == NULL)
1885                            ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
1886                            : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1887                            sr->sc->serialization,
1888                            sr->serialization);
1889   GNUNET_free (sr->serialization);
1890   sr->serialization = NULL;
1891 }
1892
1893
1894 /**
1895  * Synchronize this search struct with its mirror
1896  * on disk.  Note that all internal FS-operations that change
1897  * publishing structs should already call "sync" internally,
1898  * so this function is likely not useful for clients.
1899  *
1900  * @param sc the struct to sync
1901  */
1902 void
1903 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc)
1904 {
1905   struct GNUNET_BIO_WriteHandle *wh;
1906   char *uris;
1907   char in_pause;
1908   const char *category;
1909
1910   category = (sc->psearch_result == NULL)
1911     ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
1912     : GNUNET_FS_SYNC_PATH_CHILD_SEARCH;
1913   if (NULL == sc->serialization)
1914     sc->serialization = make_serialization_file_name (sc->h,
1915                                                       category);
1916   if (NULL == sc->serialization)
1917     return;
1918   wh = get_write_handle (sc->h, category, sc->serialization);
1919   if (wh == NULL)
1920     {
1921       GNUNET_break (0);
1922       goto cleanup;
1923     }
1924   GNUNET_assert ( (GNUNET_YES == GNUNET_FS_uri_test_ksk (sc->uri)) ||
1925                   (GNUNET_YES == GNUNET_FS_uri_test_sks (sc->uri)) );
1926   uris = GNUNET_FS_uri_to_string (sc->uri);
1927   in_pause = (sc->task != GNUNET_SCHEDULER_NO_TASK) ? 'r' : '\0';
1928   if ( (GNUNET_OK !=
1929         GNUNET_BIO_write_string (wh, uris)) ||
1930        (GNUNET_OK !=
1931         write_start_time (wh, sc->start_time)) ||
1932        (GNUNET_OK !=
1933         GNUNET_BIO_write_string (wh, sc->emsg)) ||
1934        (GNUNET_OK !=
1935         GNUNET_BIO_write_int32 (wh, (uint32_t) sc->options)) ||
1936        (GNUNET_OK !=
1937         GNUNET_BIO_write (wh, &in_pause, sizeof (in_pause))) ||
1938        (GNUNET_OK !=
1939         GNUNET_BIO_write_int32 (wh, sc->anonymity)) )
1940     {
1941       GNUNET_break (0);
1942       goto cleanup;
1943     }
1944   GNUNET_free (uris);
1945   uris = NULL;
1946   if (GNUNET_OK !=
1947       GNUNET_BIO_write_close (wh))
1948     {
1949       wh = NULL;
1950       GNUNET_break (0);
1951       goto cleanup;
1952     }
1953   return;
1954  cleanup:
1955   if (wh != NULL)
1956     (void) GNUNET_BIO_write_close (wh);
1957   GNUNET_free_non_null (uris);
1958   GNUNET_FS_remove_sync_file_ (sc->h, category, sc->serialization);
1959   GNUNET_free (sc->serialization);
1960   sc->serialization = NULL;
1961 }
1962
1963
1964 /**
1965  * Function called with a filename of serialized unindexing operation
1966  * to deserialize.
1967  *
1968  * @param cls the 'struct GNUNET_FS_Handle*'
1969  * @param filename complete filename (absolute path)
1970  * @return GNUNET_OK (continue to iterate)
1971  */
1972 static int
1973 deserialize_unindex_file (void *cls,
1974                           const char *filename)
1975 {
1976   struct GNUNET_FS_Handle *h = cls;
1977   struct GNUNET_BIO_ReadHandle *rh;
1978   struct GNUNET_FS_UnindexContext *uc;
1979   struct GNUNET_FS_ProgressInfo pi;
1980   char *emsg;
1981   uint32_t state;
1982
1983   uc = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
1984   uc->h = h;
1985   uc->serialization = get_serialization_short_name (filename);
1986   rh = GNUNET_BIO_read_open (filename);
1987   if (rh == NULL)
1988     {
1989       GNUNET_break (0);
1990       goto cleanup;
1991     }
1992   if ( (GNUNET_OK !=
1993         GNUNET_BIO_read_string (rh, "unindex-fn", &uc->filename, 10*1024)) ||
1994        (GNUNET_OK !=
1995         GNUNET_BIO_read_int64 (rh, &uc->file_size)) ||
1996        (GNUNET_OK !=
1997         read_start_time (rh, &uc->start_time)) ||
1998        (GNUNET_OK !=
1999         GNUNET_BIO_read_int32 (rh, &state)) )
2000     {
2001       GNUNET_break (0);
2002       goto cleanup;
2003     }
2004   uc->state = (enum UnindexState) state;
2005   switch (state)
2006     {
2007     case UNINDEX_STATE_HASHING:
2008       break;
2009     case UNINDEX_STATE_FS_NOTIFY:
2010       if (GNUNET_OK !=
2011           GNUNET_BIO_read (rh, "unindex-hash", &uc->file_id, sizeof (GNUNET_HashCode)))
2012         {
2013           GNUNET_break (0);
2014           goto cleanup;
2015         }
2016       break;
2017     case UNINDEX_STATE_DS_REMOVE:
2018       break;
2019     case UNINDEX_STATE_COMPLETE:
2020       break;
2021     case UNINDEX_STATE_ERROR:
2022       if (GNUNET_OK !=
2023           GNUNET_BIO_read_string (rh, "unindex-emsg", &uc->emsg, 10*1024))
2024         {
2025           GNUNET_break (0);
2026           goto cleanup;
2027         }
2028       break;
2029     case UNINDEX_STATE_ABORTED:
2030       GNUNET_break (0);
2031       goto cleanup;
2032     default:
2033       GNUNET_break (0);
2034       goto cleanup;
2035     }
2036   uc->top = GNUNET_FS_make_top (h,
2037                                 &GNUNET_FS_unindex_signal_suspend_,
2038                                 uc);
2039   pi.status = GNUNET_FS_STATUS_UNINDEX_RESUME;
2040   pi.value.unindex.specifics.resume.message = uc->emsg;
2041   GNUNET_FS_unindex_make_status_ (&pi,
2042                                   uc,
2043                                   (uc->state == UNINDEX_STATE_COMPLETE)
2044                                   ? uc->file_size
2045                                   : 0);
2046   switch (uc->state)
2047     {
2048     case UNINDEX_STATE_HASHING:
2049       GNUNET_CRYPTO_hash_file (uc->h->sched,
2050                                GNUNET_SCHEDULER_PRIORITY_IDLE,
2051                                uc->filename,
2052                                HASHING_BLOCKSIZE,
2053                                &GNUNET_FS_unindex_process_hash_,
2054                                uc);
2055       break;
2056     case UNINDEX_STATE_FS_NOTIFY:
2057       uc->state = UNINDEX_STATE_HASHING;
2058       GNUNET_FS_unindex_process_hash_ (uc,
2059                                        &uc->file_id);
2060       break;
2061     case UNINDEX_STATE_DS_REMOVE:
2062       GNUNET_FS_unindex_do_remove_ (uc);
2063       break;
2064     case UNINDEX_STATE_COMPLETE:
2065     case UNINDEX_STATE_ERROR:
2066       /* no need to resume any operation, we were done */
2067       break;
2068     default:
2069       break;
2070     }
2071   if (GNUNET_OK !=
2072       GNUNET_BIO_read_close (rh, &emsg))
2073     {
2074       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2075                   _("Failure while resuming unindexing operation `%s': %s\n"),
2076                   filename,
2077                   emsg);
2078       GNUNET_free (emsg);
2079     }
2080   return GNUNET_OK;
2081  cleanup:
2082   GNUNET_free_non_null (uc->filename);
2083   if ( (rh != NULL) &&
2084        (GNUNET_OK !=
2085         GNUNET_BIO_read_close (rh, &emsg)) )
2086     {
2087       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2088                   _("Failed to resume unindexing operation `%s': %s\n"),
2089                   filename,
2090                   emsg);
2091       GNUNET_free (emsg);
2092     }
2093   if (uc->serialization != NULL)
2094     GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, uc->serialization);
2095   GNUNET_free_non_null (uc->serialization);
2096   GNUNET_free (uc);
2097   return GNUNET_OK;
2098 }
2099
2100
2101 /**
2102  * Deserialize a download.
2103  *
2104  * @param h overall context
2105  * @param rh file to deserialize from
2106  * @param parent parent download
2107  * @param search associated search
2108  * @param serialization name under which the search was serialized
2109  */
2110 static void
2111 deserialize_download (struct GNUNET_FS_Handle *h,
2112                       struct GNUNET_BIO_ReadHandle *rh,
2113                       struct GNUNET_FS_DownloadContext *parent,
2114                       struct GNUNET_FS_SearchResult *search,
2115                       const char *serialization);
2116
2117
2118 /**
2119  * Deserialize a search.
2120  *
2121  * @param h overall context
2122  * @param rh file to deserialize from
2123  * @param psearch_result parent search result
2124  * @param serialization name under which the search was serialized
2125  */
2126 static struct GNUNET_FS_SearchContext *
2127 deserialize_search (struct GNUNET_FS_Handle *h,
2128                     struct GNUNET_BIO_ReadHandle *rh,
2129                     struct GNUNET_FS_SearchResult *psearch_result,
2130                     const char *serialization);
2131
2132
2133 /**
2134  * Function called with a filename of serialized search result
2135  * to deserialize.
2136  *
2137  * @param cls the 'struct GNUNET_FS_SearchContext*'
2138  * @param filename complete filename (absolute path)
2139  * @return GNUNET_OK (continue to iterate)
2140  */
2141 static int
2142 deserialize_search_result (void *cls,
2143                            const char *filename)
2144 {
2145   struct GNUNET_FS_SearchContext *sc = cls;
2146   char *ser;
2147   char *uris;
2148   char *emsg;
2149   char *download;
2150   char *update_srch;
2151   struct GNUNET_BIO_ReadHandle *rh;
2152   struct GNUNET_BIO_ReadHandle *drh;
2153   struct GNUNET_FS_SearchResult *sr;
2154
2155   ser = get_serialization_short_name (filename);
2156   rh = GNUNET_BIO_read_open (filename);
2157   if (rh == NULL)
2158     {
2159       if (ser != NULL)
2160         {
2161           remove_sync_file_in_dir (sc->h,
2162                                    (sc->psearch_result == NULL)
2163                                    ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2164                                    : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2165                                    sc->serialization,
2166                                    ser);
2167           GNUNET_free (ser);
2168         }
2169       return GNUNET_OK;
2170     }
2171   emsg = NULL;
2172   uris = NULL;
2173   download = NULL;
2174   sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
2175   sr->serialization = ser;
2176   if ( (GNUNET_OK !=
2177         GNUNET_BIO_read_string (rh, "result-uri", &uris, 10*1024)) ||
2178        (NULL == (sr->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2179        (GNUNET_OK !=
2180         GNUNET_BIO_read_string (rh, "download-lnk", &download, 16)) ||
2181        (GNUNET_OK !=
2182         GNUNET_BIO_read_string (rh, "search-lnk", &update_srch, 16)) ||
2183        (GNUNET_OK !=
2184         GNUNET_BIO_read_meta_data (rh, "result-meta", &sr->meta)) ||
2185        (GNUNET_OK !=
2186         GNUNET_BIO_read (rh, "result-key", &sr->key, sizeof (GNUNET_HashCode))) ||
2187        (GNUNET_OK !=
2188         GNUNET_BIO_read_int32 (rh, &sr->mandatory_missing)) ||
2189        (GNUNET_OK !=
2190         GNUNET_BIO_read_int32 (rh, &sr->optional_support)) ||
2191        (GNUNET_OK !=
2192         GNUNET_BIO_read_int32 (rh, &sr->availability_success)) ||
2193        (GNUNET_OK !=
2194         GNUNET_BIO_read_int32 (rh, &sr->availability_trials)) )
2195     {
2196       GNUNET_break (0);
2197       goto cleanup;
2198     }
2199   GNUNET_free (uris);
2200   if (download != NULL)
2201     {
2202       drh = get_read_handle (sc->h,
2203                              GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD,
2204                              download);
2205       deserialize_download (sc->h,
2206                             drh,
2207                             NULL,
2208                             sr,
2209                             download);
2210       if (GNUNET_OK !=
2211           GNUNET_BIO_read_close (drh, &emsg))
2212         {
2213           GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2214                       _("Failed to resume sub-download `%s': %s\n"),
2215                       download,
2216                       emsg);
2217           GNUNET_free (emsg);
2218         }
2219       GNUNET_free (download);
2220     }
2221   if (update_srch != NULL)
2222     {
2223       drh = get_read_handle (sc->h,
2224                              GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2225                              update_srch);
2226       deserialize_search (sc->h,
2227                           drh,
2228                           sr,
2229                           update_srch);
2230       if (GNUNET_OK !=
2231           GNUNET_BIO_read_close (drh, &emsg))
2232         {
2233           GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2234                       _("Failed to resume sub-search `%s': %s\n"),
2235                       update_srch,
2236                       emsg);
2237           GNUNET_free (emsg);
2238         }
2239       GNUNET_free (update_srch);
2240     }
2241   GNUNET_CONTAINER_multihashmap_put (sc->master_result_map,
2242                                      &sr->key,
2243                                      sr,
2244                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2245   return GNUNET_OK;
2246  cleanup:
2247   GNUNET_free_non_null (download);
2248   GNUNET_free_non_null (emsg);
2249   GNUNET_free_non_null (uris);
2250   if (sr->uri != NULL)
2251     GNUNET_FS_uri_destroy (sr->uri);
2252   if (sr->meta != NULL)
2253     GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2254   GNUNET_free (sr->serialization);
2255   GNUNET_free (sr);
2256   return GNUNET_OK;
2257 }
2258
2259
2260 /**
2261  * Send the 'resume' signal to the callback; also actually
2262  * resume the download (put it in the queue).  Does this
2263  * recursively for the top-level download and all child
2264  * downloads.
2265  *
2266  * @param dc download to resume
2267  */
2268 static void
2269 signal_download_resume (struct GNUNET_FS_DownloadContext *dc)
2270 {
2271   struct GNUNET_FS_DownloadContext *dcc;
2272   struct GNUNET_FS_ProgressInfo pi;
2273
2274   pi.status = GNUNET_FS_STATUS_DOWNLOAD_RESUME;
2275   pi.value.download.specifics.resume.meta = dc->meta;
2276   pi.value.download.specifics.resume.message = dc->emsg;
2277   GNUNET_FS_download_make_status_ (&pi,
2278                                    dc);
2279   dcc = dc->child_head;
2280   while (NULL != dcc)
2281     {
2282       signal_download_resume (dcc);
2283       dcc = dcc->next;
2284     }
2285   if (dc->pending != NULL)
2286     GNUNET_FS_download_start_downloading_ (dc);
2287 }
2288
2289
2290 /**
2291  * Signal resuming of a search to our clients (for the
2292  * top level search and all sub-searches).
2293  *
2294  * @param sc search being resumed
2295  */
2296 static void
2297 signal_search_resume (struct GNUNET_FS_SearchContext *sc);
2298
2299
2300 /**
2301  * Iterator over search results signaling resume to the client for
2302  * each result.
2303  *
2304  * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2305  * @param key current key code
2306  * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2307  * @return GNUNET_YES (we should continue to iterate)
2308  */
2309 static int
2310 signal_result_resume (void *cls,
2311                       const GNUNET_HashCode * key,
2312                       void *value)
2313 {
2314   struct GNUNET_FS_SearchContext *sc = cls;
2315   struct GNUNET_FS_ProgressInfo pi;
2316   struct GNUNET_FS_SearchResult *sr = value;
2317
2318   if (0 == sr->mandatory_missing)
2319     {
2320       pi.status = GNUNET_FS_STATUS_SEARCH_RESUME_RESULT;
2321       pi.value.search.specifics.resume_result.meta = sr->meta;
2322       pi.value.search.specifics.resume_result.uri = sr->uri;
2323       pi.value.search.specifics.resume_result.result = sr;
2324       pi.value.search.specifics.resume_result.availability_rank = 2*sr->availability_success - sr->availability_trials;
2325       pi.value.search.specifics.resume_result.availability_certainty = sr->availability_trials;
2326       pi.value.search.specifics.resume_result.applicability_rank = sr->optional_support;
2327       sr->client_info = GNUNET_FS_search_make_status_ (&pi,
2328                                                        sc);
2329     }
2330   if (sr->download != NULL)
2331     {
2332       signal_download_resume (sr->download);
2333     }
2334   else
2335     {
2336       GNUNET_FS_search_start_probe_ (sr);
2337     }
2338   if (sr->update_search != NULL)
2339     signal_search_resume (sr->update_search);
2340   return GNUNET_YES;
2341 }
2342
2343
2344 /**
2345  * Free memory allocated by the search context and its children
2346  *
2347  * @param sc search context to free
2348  */
2349 static void
2350 free_search_context (struct GNUNET_FS_SearchContext *sc);
2351
2352
2353 /**
2354  * Iterator over search results freeing each.
2355  *
2356  * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2357  * @param key current key code
2358  * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2359  * @return GNUNET_YES (we should continue to iterate)
2360  */
2361 static int
2362 free_result (void *cls,
2363              const GNUNET_HashCode * key,
2364              void *value)
2365 {
2366   struct GNUNET_FS_SearchResult *sr = value;
2367
2368   if (sr->update_search != NULL)
2369     {
2370       free_search_context (sr->update_search);
2371       GNUNET_assert (NULL == sr->update_search);
2372     }
2373   GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2374   GNUNET_FS_uri_destroy (sr->uri);
2375   GNUNET_free (sr);
2376   return GNUNET_YES;
2377 }
2378
2379
2380 /**
2381  * Free memory allocated by the search context and its children
2382  *
2383  * @param sc search context to free
2384  */
2385 static void
2386 free_search_context (struct GNUNET_FS_SearchContext *sc)
2387 {
2388   if (sc->serialization != NULL)
2389     {
2390       GNUNET_FS_remove_sync_file_ (sc->h,
2391                                    (sc->psearch_result == NULL)
2392                                    ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2393                                    : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2394                                    sc->serialization);
2395       GNUNET_FS_remove_sync_dir_ (sc->h,
2396                                    (sc->psearch_result == NULL)
2397                                    ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2398                                    : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2399                                   sc->serialization);
2400     }
2401   GNUNET_free_non_null (sc->serialization);
2402   GNUNET_free_non_null (sc->emsg);
2403   if (sc->uri != NULL)
2404     GNUNET_FS_uri_destroy (sc->uri);
2405   if (sc->master_result_map != NULL)
2406     {
2407       GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2408                                              &free_result,
2409                                              sc);
2410       GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
2411     }
2412   GNUNET_free (sc);
2413 }
2414
2415
2416 /**
2417  * Function called with a filename of serialized sub-download
2418  * to deserialize.
2419  *
2420  * @param cls the 'struct GNUNET_FS_DownloadContext*' (parent)
2421  * @param filename complete filename (absolute path)
2422  * @return GNUNET_OK (continue to iterate)
2423  */
2424 static int
2425 deserialize_subdownload (void *cls,
2426                          const char *filename)
2427 {
2428   struct GNUNET_FS_DownloadContext *parent = cls;
2429   char *ser;
2430   char *emsg;
2431   struct GNUNET_BIO_ReadHandle *rh;
2432
2433   ser = get_serialization_short_name (filename);
2434   rh = GNUNET_BIO_read_open (filename);
2435   deserialize_download (parent->h,
2436                         rh,
2437                         parent,
2438                         NULL,
2439                         ser);
2440   if (GNUNET_OK !=
2441       GNUNET_BIO_read_close (rh, &emsg))
2442     {
2443       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2444                   _("Failed to resume sub-download `%s': %s\n"),
2445                   ser,
2446                   emsg);
2447       GNUNET_free (emsg);
2448     }
2449   GNUNET_free (ser);
2450   return GNUNET_OK;
2451 }
2452
2453
2454 /**
2455  * Free this download context and all of its descendants.
2456  * (only works during deserialization since not all possible
2457  * state it taken care of).
2458  *
2459  * @param dc context to free
2460  */
2461 static void
2462 free_download_context (struct GNUNET_FS_DownloadContext *dc)
2463 {
2464   struct GNUNET_FS_DownloadContext *dcc;
2465   struct DownloadRequest *dr;
2466   if (dc->meta != NULL)
2467     GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2468   if (dc->uri != NULL)
2469     GNUNET_FS_uri_destroy (dc->uri);
2470   GNUNET_free_non_null (dc->temp_filename);
2471   GNUNET_free_non_null (dc->emsg);
2472   GNUNET_free_non_null (dc->filename);
2473   while (NULL != (dcc = dc->child_head))
2474     {
2475       GNUNET_CONTAINER_DLL_remove (dc->child_head,
2476                                    dc->child_tail,
2477                                    dcc);
2478       free_download_context (dcc);
2479     }
2480   while (NULL != (dr = dc->pending))
2481     {
2482       dc->pending = dr->next;
2483       GNUNET_free (dr);
2484     }
2485   GNUNET_free (dc);
2486 }
2487
2488
2489 /**
2490  * Deserialize a download.
2491  *
2492  * @param h overall context
2493  * @param rh file to deserialize from
2494  * @param parent parent download
2495  * @param search associated search
2496  * @param serialization name under which the search was serialized
2497  */
2498 static void
2499 deserialize_download (struct GNUNET_FS_Handle *h,
2500                       struct GNUNET_BIO_ReadHandle *rh,
2501                       struct GNUNET_FS_DownloadContext *parent,
2502                       struct GNUNET_FS_SearchResult *search,
2503                       const char *serialization)
2504 {
2505   struct GNUNET_FS_DownloadContext *dc;
2506   struct DownloadRequest *dr;
2507   char *emsg;
2508   char *uris;
2509   char *dn;
2510   uint32_t options;
2511   uint32_t status;
2512   uint32_t num_pending;
2513
2514   uris = NULL;
2515   emsg = NULL;
2516   dr = NULL;
2517   dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2518   dc->parent = parent;
2519   dc->h = h;
2520   dc->serialization = GNUNET_strdup (serialization);
2521   if ( (GNUNET_OK !=
2522         GNUNET_BIO_read_string (rh, "download-uri", &uris, 10*1024)) ||
2523        (NULL == (dc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2524        ( (GNUNET_YES != GNUNET_FS_uri_test_chk (dc->uri)) &&
2525          (GNUNET_YES != GNUNET_FS_uri_test_loc (dc->uri)) ) ||
2526        (GNUNET_OK !=
2527         GNUNET_BIO_read_meta_data (rh, "download-meta", &dc->meta)) ||
2528        (GNUNET_OK !=
2529         GNUNET_BIO_read_string (rh, "download-emsg", &dc->emsg, 10*1024)) ||
2530        (GNUNET_OK !=
2531         GNUNET_BIO_read_string (rh, "download-fn", &dc->filename, 10*1024)) ||
2532        (GNUNET_OK !=
2533         GNUNET_BIO_read_string (rh, "download-tfn", &dc->temp_filename, 10*1024)) ||
2534        (GNUNET_OK !=
2535         GNUNET_BIO_read_int64 (rh, &dc->old_file_size)) ||
2536        (GNUNET_OK !=
2537         GNUNET_BIO_read_int64 (rh, &dc->offset)) ||
2538        (GNUNET_OK !=
2539         GNUNET_BIO_read_int64 (rh, &dc->length)) ||
2540        (GNUNET_OK !=
2541         GNUNET_BIO_read_int64 (rh, &dc->completed)) ||
2542        (GNUNET_OK !=
2543         read_start_time (rh, &dc->start_time)) ||
2544        (GNUNET_OK !=
2545         GNUNET_BIO_read_int32 (rh, &dc->anonymity)) ||
2546        (GNUNET_OK !=
2547         GNUNET_BIO_read_int32 (rh, &options)) ||
2548        (GNUNET_OK !=
2549         GNUNET_BIO_read_int32 (rh, &status)) ||
2550        (GNUNET_OK !=
2551         GNUNET_BIO_read_int32 (rh, &num_pending)) )
2552     {
2553       GNUNET_break (0);
2554       goto cleanup;
2555     }
2556   dc->options = (enum GNUNET_FS_DownloadOptions) options;
2557   dc->active = GNUNET_CONTAINER_multihashmap_create (16);
2558   dc->has_finished = (int) status;
2559   dc->treedepth = GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
2560   if (GNUNET_FS_uri_test_loc (dc->uri))
2561     GNUNET_assert (GNUNET_OK ==
2562                    GNUNET_FS_uri_loc_get_peer_identity (dc->uri,
2563                                                         &dc->target));
2564   if ( (dc->length > dc->completed) &&
2565        (num_pending == 0) )
2566     {
2567       GNUNET_break (0);
2568       goto cleanup;
2569     }
2570   while (0 < num_pending--)
2571     {
2572       dr = GNUNET_malloc (sizeof (struct DownloadRequest));
2573       if ( (GNUNET_OK !=
2574             GNUNET_BIO_read (rh, "chk", &dr->chk, sizeof (struct ContentHashKey))) ||
2575            (GNUNET_OK !=
2576             GNUNET_BIO_read_int64 (rh, &dr->offset)) ||
2577            (GNUNET_OK !=
2578             GNUNET_BIO_read_int32 (rh, &dr->depth)) )
2579         {
2580           GNUNET_break (0);
2581           goto cleanup;
2582         }
2583       dr->is_pending = GNUNET_YES;
2584       dr->next = dc->pending;
2585       dc->pending = dr;
2586       dr = NULL;
2587     }
2588   dn = get_download_sync_filename (dc, "");
2589   if (dn != NULL)
2590     {
2591       if (GNUNET_YES ==
2592           GNUNET_DISK_directory_test (dn))
2593         GNUNET_DISK_directory_scan (dn, &deserialize_subdownload, dc);
2594       GNUNET_free (dn);
2595     }
2596   if (parent != NULL)
2597     GNUNET_CONTAINER_DLL_insert (parent->child_head,
2598                                  parent->child_tail,
2599                                  dc);
2600   if (search != NULL)
2601     {
2602       dc->search = search;
2603       search->download = dc;
2604     }
2605   if ( (parent == NULL) ||
2606        (search == NULL) )
2607     dc->top = GNUNET_FS_make_top (dc->h,
2608                                   &GNUNET_FS_download_signal_suspend_,
2609                                   dc);
2610   signal_download_resume (dc);
2611   GNUNET_free (uris);
2612   return;
2613  cleanup:
2614   GNUNET_free_non_null (uris);
2615   GNUNET_free_non_null (dr);
2616   GNUNET_free_non_null (emsg);
2617   free_download_context (dc);
2618 }
2619
2620
2621 /**
2622  * Signal resuming of a search to our clients (for the
2623  * top level search and all sub-searches).
2624  *
2625  * @param sc search being resumed
2626  */
2627 static void
2628 signal_search_resume (struct GNUNET_FS_SearchContext *sc)
2629 {
2630   struct GNUNET_FS_ProgressInfo pi;
2631
2632   pi.status = GNUNET_FS_STATUS_SEARCH_RESUME;
2633   pi.value.search.specifics.resume.message = sc->emsg;
2634   pi.value.search.specifics.resume.is_paused = (sc->client == NULL) ? GNUNET_YES : GNUNET_NO;
2635   sc->client_info = GNUNET_FS_search_make_status_ (&pi,
2636                                                    sc);
2637   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2638                                          &signal_result_resume,
2639                                          sc);
2640
2641 }
2642
2643
2644 /**
2645  * Deserialize a search.
2646  *
2647  * @param h overall context
2648  * @param rh file to deserialize from
2649  * @param psearch_result parent search result
2650  * @param serialization name under which the search was serialized
2651  */
2652 static struct GNUNET_FS_SearchContext *
2653 deserialize_search (struct GNUNET_FS_Handle *h,
2654                     struct GNUNET_BIO_ReadHandle *rh,
2655                     struct GNUNET_FS_SearchResult *psearch_result,
2656                     const char *serialization)
2657 {
2658   struct GNUNET_FS_SearchContext *sc;
2659   char *emsg;
2660   char *uris;
2661   char *dn;
2662   uint32_t options;
2663   char in_pause;
2664
2665   if ( (psearch_result != NULL) &&
2666        (psearch_result->update_search != NULL) )
2667     {
2668       GNUNET_break (0);
2669       return NULL;
2670     }
2671   uris = NULL;
2672   emsg = NULL;
2673   sc = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchContext));
2674   if (psearch_result != NULL)
2675     {
2676       sc->psearch_result = psearch_result;
2677       psearch_result->update_search = sc;
2678     }
2679   sc->h = h;
2680   sc->serialization = GNUNET_strdup (serialization);
2681   if ( (GNUNET_OK !=
2682         GNUNET_BIO_read_string (rh, "search-uri", &uris, 10*1024)) ||
2683        (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2684        ( (GNUNET_YES != GNUNET_FS_uri_test_ksk (sc->uri)) &&
2685          (GNUNET_YES != GNUNET_FS_uri_test_sks (sc->uri)) ) ||
2686        (GNUNET_OK !=
2687         read_start_time (rh, &sc->start_time)) ||
2688        (GNUNET_OK !=
2689         GNUNET_BIO_read_string (rh, "search-emsg", &sc->emsg, 10*1024)) ||
2690        (GNUNET_OK !=
2691         GNUNET_BIO_read_int32 (rh, &options)) ||
2692        (GNUNET_OK !=
2693         GNUNET_BIO_read (rh, "search-pause", &in_pause, sizeof (in_pause))) ||
2694        (GNUNET_OK !=
2695         GNUNET_BIO_read_int32 (rh, &sc->anonymity)) )
2696     {
2697       GNUNET_break (0);
2698       goto cleanup;
2699     }
2700   sc->options = (enum GNUNET_FS_SearchOptions) options;
2701   sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16);
2702   dn = get_serialization_file_name_in_dir (h,
2703                                            (sc->psearch_result == NULL)
2704                                            ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH
2705                                            : GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2706                                            sc->serialization,
2707                                            "");
2708   if (dn != NULL)
2709     {
2710       if (GNUNET_YES ==
2711           GNUNET_DISK_directory_test (dn))
2712         GNUNET_DISK_directory_scan (dn, &deserialize_search_result, sc);
2713       GNUNET_free (dn);
2714     }
2715   if ( ('\0' == in_pause) &&
2716        (GNUNET_OK !=
2717         GNUNET_FS_search_start_searching_ (sc)) )
2718     {
2719       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2720                   _("Could not resume running search, will resume as paused search\n"));
2721     }
2722   signal_search_resume (sc);
2723   GNUNET_free (uris);
2724   return sc;
2725  cleanup:
2726   GNUNET_free_non_null (emsg);
2727   free_search_context (sc);
2728   GNUNET_free_non_null (uris);
2729   return NULL;
2730 }
2731
2732
2733 /**
2734  * Function called with a filename of serialized search operation
2735  * to deserialize.
2736  *
2737  * @param cls the 'struct GNUNET_FS_Handle*'
2738  * @param filename complete filename (absolute path)
2739  * @return GNUNET_OK (continue to iterate)
2740  */
2741 static int
2742 deserialize_search_file (void *cls,
2743                           const char *filename)
2744 {
2745   struct GNUNET_FS_Handle *h = cls;
2746   char *ser;
2747   char *emsg;
2748   struct GNUNET_BIO_ReadHandle *rh;
2749   struct GNUNET_FS_SearchContext *sc;
2750
2751   ser = get_serialization_short_name (filename);
2752   rh = GNUNET_BIO_read_open (filename);
2753   if (rh == NULL)
2754     {
2755       if (ser != NULL)
2756         {
2757           GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, ser);
2758           GNUNET_free (ser);
2759         }
2760       return GNUNET_OK;
2761     }
2762   sc = deserialize_search (h, rh, NULL, ser);
2763   sc->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, sc);
2764   GNUNET_free (ser);
2765   if (GNUNET_OK !=
2766       GNUNET_BIO_read_close (rh, &emsg))
2767     {
2768       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2769                   _("Failure while resuming search operation `%s': %s\n"),
2770                   filename,
2771                   emsg);
2772       GNUNET_free (emsg);
2773     }
2774   return GNUNET_OK;
2775 }
2776
2777
2778 /**
2779  * Function called with a filename of serialized download operation
2780  * to deserialize.
2781  *
2782  * @param cls the 'struct GNUNET_FS_Handle*'
2783  * @param filename complete filename (absolute path)
2784  * @return GNUNET_OK (continue to iterate)
2785  */
2786 static int
2787 deserialize_download_file (void *cls,
2788                            const char *filename)
2789 {
2790   struct GNUNET_FS_Handle *h = cls;
2791   char *ser;
2792   char *emsg;
2793   struct GNUNET_BIO_ReadHandle *rh;
2794
2795   ser = get_serialization_short_name (filename);
2796   rh = GNUNET_BIO_read_open (filename);
2797   if (rh == NULL)
2798     {
2799       if (filename != NULL)
2800         {
2801           if (0 != UNLINK (filename))
2802             GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
2803                                       "unlink",
2804                                       filename);
2805           GNUNET_free (ser);
2806         }
2807       return GNUNET_OK;
2808     }
2809   deserialize_download (h, rh, NULL, NULL, ser);
2810   GNUNET_free (ser);
2811   if (GNUNET_OK !=
2812       GNUNET_BIO_read_close (rh, &emsg))
2813     {
2814       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2815                   _("Failure while resuming download operation `%s': %s\n"),
2816                   filename,
2817                   emsg);
2818       GNUNET_free (emsg);
2819     }
2820   return GNUNET_OK;
2821 }
2822
2823
2824 /**
2825  * Deserialize informatin about pending operations.
2826  *
2827  * @param master_path which master directory should be scanned
2828  * @param proc function to call for each entry (will get 'h' for 'cls')
2829  * @param h the 'struct GNUNET_FS_Handle*'
2830  */
2831 static void
2832 deserialization_master (const char *master_path,
2833                         GNUNET_FileNameCallback proc,
2834                         struct GNUNET_FS_Handle *h)
2835 {
2836   char *dn;
2837
2838   dn = get_serialization_file_name (h, master_path, "");
2839   if (dn == NULL)
2840     return;
2841   if (GNUNET_YES ==
2842       GNUNET_DISK_directory_test (dn))
2843     GNUNET_DISK_directory_scan (dn, proc, h);
2844   GNUNET_free (dn);
2845 }
2846
2847
2848 /**
2849  * Setup a connection to the file-sharing service.
2850  *
2851  * @param sched scheduler to use
2852  * @param cfg configuration to use
2853  * @param client_name unique identifier for this client
2854  * @param upcb function to call to notify about FS actions
2855  * @param upcb_cls closure for upcb
2856  * @param flags specific attributes for fs-operations
2857  * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
2858  * @return NULL on error
2859  */
2860 struct GNUNET_FS_Handle *
2861 GNUNET_FS_start (struct GNUNET_SCHEDULER_Handle *sched,
2862                  const struct GNUNET_CONFIGURATION_Handle *cfg,
2863                  const char *client_name,
2864                  GNUNET_FS_ProgressCallback upcb,
2865                  void *upcb_cls,
2866                  enum GNUNET_FS_Flags flags,
2867                  ...)
2868 {
2869   struct GNUNET_FS_Handle *ret;
2870   enum GNUNET_FS_OPTIONS opt;
2871   va_list ap;
2872
2873   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Handle));
2874   ret->sched = sched;
2875   ret->cfg = cfg;
2876   ret->client_name = GNUNET_strdup (client_name);
2877   ret->upcb = upcb;
2878   ret->upcb_cls = upcb_cls;
2879   ret->flags = flags;
2880   ret->max_parallel_downloads = 1;
2881   ret->max_parallel_requests = 1;
2882   ret->avg_block_latency = GNUNET_TIME_UNIT_MINUTES; /* conservative starting point */
2883   va_start (ap, flags);
2884   while (GNUNET_FS_OPTIONS_END != (opt = va_arg (ap, enum GNUNET_FS_OPTIONS)))
2885     {
2886       switch (opt)
2887         {
2888         case GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM:
2889           ret->max_parallel_downloads = va_arg (ap, unsigned int);
2890           break;
2891         case GNUNET_FS_OPTIONS_REQUEST_PARALLELISM:
2892           ret->max_parallel_requests = va_arg (ap, unsigned int);
2893           break;
2894         default:
2895           GNUNET_break (0);
2896           GNUNET_free (ret->client_name);
2897           GNUNET_free (ret);
2898           va_end (ap);
2899           return NULL;
2900         }
2901     }
2902   va_end (ap);
2903   if (0 != (GNUNET_FS_FLAGS_PERSISTENCE & flags))
2904     {
2905       deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
2906                               &deserialize_publish_file,
2907                               ret);
2908       deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
2909                               &deserialize_search_file,
2910                               ret);
2911       deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
2912                               &deserialize_download_file,
2913                               ret);
2914       deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2915                               &deserialize_unindex_file,
2916                               ret);
2917     }
2918   return ret;
2919 }
2920
2921
2922 /**
2923  * Close our connection with the file-sharing service.
2924  * The callback given to GNUNET_FS_start will no longer be
2925  * called after this function returns.
2926  *
2927  * @param h handle that was returned from GNUNET_FS_start
2928  */
2929 void
2930 GNUNET_FS_stop (struct GNUNET_FS_Handle *h)
2931 {
2932   while (h->top_head != NULL)
2933     h->top_head->ssf (h->top_head->ssf_cls);
2934   if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
2935     GNUNET_SCHEDULER_cancel (h->sched,
2936                              h->queue_job);
2937   GNUNET_free (h->client_name);
2938   GNUNET_free (h);
2939 }
2940
2941
2942 /* end of fs.c */