src/fs/fs_api.c

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