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)
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.
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.
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.
23 * @brief main FS functions (master initialization, serialization, deserialization, shared code)
24 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
29 #include "gnunet_fs_service.h"
34 * How many block requests can we have outstanding in parallel at a time by default?
36 #define DEFAULT_MAX_PARALLEL_REQUESTS (1024 * 10)
39 * How many downloads can we have outstanding in parallel at a time by default?
41 #define DEFAULT_MAX_PARALLEL_DOWNLOADS 16
44 * Start the given job (send signal, remove from pending queue, update
45 * counters and state).
47 * @param qe job to start
50 start_job (struct GNUNET_FS_QueueEntry *qe)
52 GNUNET_assert (NULL == qe->client);
53 qe->client = GNUNET_CLIENT_connect ("fs", qe->h->cfg);
54 if (qe->client == NULL)
59 qe->start (qe->cls, qe->client);
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);
70 * Stop the given job (send signal, remove from active queue, update
71 * counters and state).
73 * @param qe job to stop
76 stop_job (struct GNUNET_FS_QueueEntry *qe)
80 qe->h->active_downloads--;
81 qe->h->active_blocks -= qe->blocks;
83 GNUNET_TIME_relative_add (qe->run_time,
84 GNUNET_TIME_absolute_get_duration
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);
93 * Process the jobs in the job queue, possibly starting some
94 * and stopping others.
96 * @param cls the 'struct GNUNET_FS_Handle'
97 * @param tc scheduler context
100 process_job_queue (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
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;
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))
117 if (h->running_head == NULL)
122 if ((qe->blocks + h->active_blocks <= h->max_parallel_requests) &&
123 (h->active_downloads < h->max_parallel_downloads))
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))
137 GNUNET_TIME_relative_multiply (h->avg_block_latency,
138 qe->blocks * qe->start_times);
139 switch (qe->priority)
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));
150 case GNUNET_FS_QUEUE_PRIORITY_NORMAL:
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)
162 /* finally, start some more tasks if we now have empty slots */
163 next = h->pending_head;
164 while (NULL != (qe = next))
167 if ((qe->blocks + h->active_blocks <= h->max_parallel_requests) &&
168 (h->active_downloads < h->max_parallel_downloads))
175 GNUNET_SCHEDULER_add_delayed (restart_at, &process_job_queue, h);
180 * Add a job to the queue.
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
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)
195 struct GNUNET_FS_QueueEntry *qe;
197 qe = GNUNET_malloc (sizeof (struct GNUNET_FS_QueueEntry));
202 qe->queue_time = GNUNET_TIME_absolute_get ();
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);
215 * Dequeue a job from the queue.
216 * @param qh handle for the job
219 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qh)
221 struct GNUNET_FS_Handle *h;
224 if (qh->client != NULL)
226 GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, 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);
235 * Create a top-level activity entry.
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
242 struct TopLevelActivity *
243 GNUNET_FS_make_top (struct GNUNET_FS_Handle *h, SuspendSignalFunction ssf,
246 struct TopLevelActivity *ret;
248 ret = GNUNET_malloc (sizeof (struct TopLevelActivity));
250 ret->ssf_cls = ssf_cls;
251 GNUNET_CONTAINER_DLL_insert (h->top_head, h->top_tail, ret);
257 * Destroy a top-level activity entry.
259 * @param h global fs handle
260 * @param top top level activity entry
263 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h, struct TopLevelActivity *top)
265 GNUNET_CONTAINER_DLL_remove (h->top_head, h->top_tail, top);
272 * Closure for "data_reader_file".
277 * Name of the file to read.
282 * File descriptor, NULL if it has not yet been opened.
284 struct GNUNET_DISK_FileHandle *fd;
289 * Function that provides data by reading from a file.
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; set to UINT64_MAX to tell
295 * the reader that we won't be reading for a while
296 * (used to close the file descriptor but NOT fully
297 * clean up the reader's state); in this case,
298 * a value of '0' for max should be ignored
299 * @param max maximum number of bytes that should be
300 * copied to buf; readers are not allowed
301 * to provide less data unless there is an error;
302 * a value of "0" will be used at the end to allow
303 * the reader to clean up its internal state
304 * @param buf where the reader should write the data
305 * @param emsg location for the reader to store an error message
306 * @return number of bytes written, usually "max", 0 on error
309 GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf,
312 struct FileInfo *fi = cls;
315 if (UINT64_MAX == offset)
319 GNUNET_DISK_file_close (fi->fd);
327 GNUNET_DISK_file_close (fi->fd);
328 GNUNET_free (fi->filename);
335 GNUNET_DISK_file_open (fi->filename, GNUNET_DISK_OPEN_READ,
336 GNUNET_DISK_PERM_NONE);
339 GNUNET_asprintf (emsg, _("Could not open file `%s': %s"), fi->filename,
344 GNUNET_DISK_file_seek (fi->fd, offset, GNUNET_DISK_SEEK_SET);
345 ret = GNUNET_DISK_file_read (fi->fd, buf, max);
348 GNUNET_asprintf (emsg, _("Could not read file `%s': %s"), fi->filename,
354 GNUNET_asprintf (emsg, _("Short read reading from file `%s'!"),
363 * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
365 * @param filename file to read
366 * @return closure to use, NULL on error
369 GNUNET_FS_make_file_reader_context_ (const char *filename)
373 fi = GNUNET_malloc (sizeof (struct FileInfo));
374 fi->filename = GNUNET_STRINGS_filename_expand (filename);
375 if (fi->filename == NULL)
385 * Function that provides data by copying from a buffer.
387 * @param cls closure (points to the buffer)
388 * @param offset offset to read from; it is possible
389 * that the caller might need to go backwards
390 * a bit at times; set to UINT64_MAX to tell
391 * the reader that we won't be reading for a while
392 * (used to close the file descriptor but NOT fully
393 * clean up the reader's state); in this case,
394 * a value of '0' for max should be ignored
395 * @param max maximum number of bytes that should be
396 * copied to buf; readers are not allowed
397 * to provide less data unless there is an error;
398 * a value of "0" will be used at the end to allow
399 * the reader to clean up its internal state
400 * @param buf where the reader should write the data
401 * @param emsg location for the reader to store an error message
402 * @return number of bytes written, usually "max", 0 on error
405 GNUNET_FS_data_reader_copy_ (void *cls, uint64_t offset, size_t max, void *buf,
410 if (UINT64_MAX == offset)
414 GNUNET_free_non_null (data);
417 memcpy (buf, &data[offset], max);
423 * Return the full filename where we would store state information
424 * (for serialization/deserialization).
426 * @param h master context
427 * @param ext component of the path
428 * @param ent entity identifier (or emtpy string for the directory)
429 * @return NULL on error
432 get_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext,
438 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
439 return NULL; /* persistence not requested */
441 GNUNET_CONFIGURATION_get_value_filename (h->cfg, "fs", "STATE_DIR",
444 GNUNET_asprintf (&ret, "%s%s%s%s%s%s%s", basename, DIR_SEPARATOR_STR,
445 h->client_name, DIR_SEPARATOR_STR, ext, DIR_SEPARATOR_STR,
447 GNUNET_free (basename);
453 * Return the full filename where we would store state information
454 * (for serialization/deserialization) that is associated with a
457 * @param h master context
458 * @param ext component of the path
459 * @param uni name of the parent operation
460 * @param ent entity identifier (or emtpy string for the directory)
461 * @return NULL on error
464 get_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
465 const char *uni, const char *ent)
470 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
471 return NULL; /* persistence not requested */
473 GNUNET_CONFIGURATION_get_value_filename (h->cfg, "fs", "STATE_DIR",
476 GNUNET_asprintf (&ret, "%s%s%s%s%s%s%s.dir%s%s", basename, DIR_SEPARATOR_STR,
477 h->client_name, DIR_SEPARATOR_STR, ext, DIR_SEPARATOR_STR,
478 uni, DIR_SEPARATOR_STR, ent);
479 GNUNET_free (basename);
485 * Return a read handle for deserialization.
487 * @param h master context
488 * @param ext component of the path
489 * @param ent entity identifier (or emtpy string for the directory)
490 * @return NULL on error
492 static struct GNUNET_BIO_ReadHandle *
493 get_read_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
496 struct GNUNET_BIO_ReadHandle *ret;
498 fn = get_serialization_file_name (h, ext, ent);
501 ret = GNUNET_BIO_read_open (fn);
508 * Return a write handle for serialization.
510 * @param h master context
511 * @param ext component of the path
512 * @param ent entity identifier (or emtpy string for the directory)
513 * @return NULL on error
515 static struct GNUNET_BIO_WriteHandle *
516 get_write_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
519 struct GNUNET_BIO_WriteHandle *ret;
521 fn = get_serialization_file_name (h, ext, ent);
526 ret = GNUNET_BIO_write_open (fn);
535 * Return a write handle for serialization.
537 * @param h master context
538 * @param ext component of the path
539 * @param uni name of parent
540 * @param ent entity identifier (or emtpy string for the directory)
541 * @return NULL on error
543 static struct GNUNET_BIO_WriteHandle *
544 get_write_handle_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
545 const char *uni, const char *ent)
548 struct GNUNET_BIO_WriteHandle *ret;
550 fn = get_serialization_file_name_in_dir (h, ext, uni, ent);
553 ret = GNUNET_BIO_write_open (fn);
560 * Remove serialization/deserialization file from disk.
562 * @param h master context
563 * @param ext component of the path
564 * @param ent entity identifier
567 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext,
572 if ((NULL == ent) || (0 == strlen (ent)))
577 filename = get_serialization_file_name (h, ext, ent);
578 if (filename != NULL)
580 if (0 != UNLINK (filename))
581 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
582 GNUNET_free (filename);
588 * Remove serialization/deserialization file from disk.
590 * @param h master context
591 * @param ext component of the path
592 * @param uni parent name
593 * @param ent entity identifier
596 remove_sync_file_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
597 const char *uni, const char *ent)
601 if ((NULL == ent) || (0 == strlen (ent)))
606 filename = get_serialization_file_name_in_dir (h, ext, uni, ent);
607 if (filename != NULL)
609 if (0 != UNLINK (filename))
610 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
611 GNUNET_free (filename);
617 * Remove serialization/deserialization directory from disk.
619 * @param h master context
620 * @param ext component of the path
621 * @param uni unique name of parent
624 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext,
631 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
634 if ((GNUNET_OK == GNUNET_DISK_directory_test (dn)) &&
635 (GNUNET_OK != GNUNET_DISK_directory_remove (dn)))
636 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "rmdir", dn);
642 * Serialize a 'start_time'. Since we use start-times to
643 * calculate the duration of some operation, we actually
644 * do not serialize the absolute time but the (relative)
645 * duration since the start time. When we then
646 * deserialize the start time, we take the current time and
647 * subtract that duration so that we get again an absolute
648 * time stamp that will result in correct performance
651 * @param wh handle for writing
652 * @param timestamp time to serialize
653 * @return GNUNET_OK on success
656 write_start_time (struct GNUNET_BIO_WriteHandle *wh,
657 struct GNUNET_TIME_Absolute timestamp)
659 struct GNUNET_TIME_Relative dur;
661 dur = GNUNET_TIME_absolute_get_duration (timestamp);
662 return GNUNET_BIO_write_int64 (wh, dur.rel_value);
667 * Serialize a 'start_time'. Since we use start-times to
668 * calculate the duration of some operation, we actually
669 * do not serialize the absolute time but the (relative)
670 * duration since the start time. When we then
671 * deserialize the start time, we take the current time and
672 * subtract that duration so that we get again an absolute
673 * time stamp that will result in correct performance
676 * @param rh handle for reading
677 * @param timestamp where to write the deserialized timestamp
678 * @return GNUNET_OK on success
681 read_start_time (struct GNUNET_BIO_ReadHandle *rh,
682 struct GNUNET_TIME_Absolute *timestamp)
684 struct GNUNET_TIME_Relative dur;
686 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dur.rel_value))
687 return GNUNET_SYSERR;
688 *timestamp = GNUNET_TIME_absolute_subtract (GNUNET_TIME_absolute_get (), dur);
694 * Using the given serialization filename, try to deserialize
695 * the file-information tree associated with it.
697 * @param h master context
698 * @param filename name of the file (without directory) with
700 * @return NULL on error
702 static struct GNUNET_FS_FileInformation *
703 deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename);
707 * Using the given serialization filename, try to deserialize
708 * the file-information tree associated with it.
710 * @param h master context
711 * @param fn name of the file (without directory) with
713 * @param rh handle for reading
714 * @return NULL on error
716 static struct GNUNET_FS_FileInformation *
717 deserialize_fi_node (struct GNUNET_FS_Handle *h, const char *fn,
718 struct GNUNET_BIO_ReadHandle *rh)
720 struct GNUNET_FS_FileInformation *ret;
721 struct GNUNET_FS_FileInformation *nxt;
728 if (GNUNET_OK != GNUNET_BIO_read (rh, "status flag", &b, sizeof (b)))
733 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_FileInformation));
738 if ((GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "metadata", &ret->meta)) ||
739 (GNUNET_OK != GNUNET_BIO_read_string (rh, "ksk-uri", &ksks, 32 * 1024)) ||
741 ( (NULL == (ret->keywords = GNUNET_FS_uri_parse (ksks, NULL))) ||
742 (GNUNET_YES != GNUNET_FS_uri_test_ksk (ret->keywords)) ) ) ||
743 (GNUNET_OK != GNUNET_BIO_read_string (rh, "chk-uri", &chks, 1024)) ||
745 ( (NULL == (ret->chk_uri = GNUNET_FS_uri_parse (chks, NULL))) ||
746 (GNUNET_YES != GNUNET_FS_uri_test_chk (ret->chk_uri))) ) ||
747 (GNUNET_OK != read_start_time (rh, &ret->start_time)) ||
748 (GNUNET_OK != GNUNET_BIO_read_string (rh, "emsg", &ret->emsg, 16 * 1024))
750 GNUNET_BIO_read_string (rh, "fn", &ret->filename, 16 * 1024)) ||
752 GNUNET_BIO_read_int64 (rh, &ret->bo.expiration_time.abs_value)) ||
753 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.anonymity_level)) ||
754 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.content_priority)) ||
755 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.replication_level)))
762 case 0: /* file-insert */
763 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
768 ret->is_directory = GNUNET_NO;
769 ret->data.file.do_index = GNUNET_NO;
770 ret->data.file.have_hash = GNUNET_NO;
771 ret->data.file.index_start_confirmed = GNUNET_NO;
772 if (GNUNET_NO == ret->is_published)
774 if (NULL == ret->filename)
776 ret->data.file.reader = &GNUNET_FS_data_reader_copy_;
777 ret->data.file.reader_cls =
778 GNUNET_malloc_large (ret->data.file.file_size);
779 if (ret->data.file.reader_cls == NULL)
782 GNUNET_BIO_read (rh, "file-data", ret->data.file.reader_cls,
783 ret->data.file.file_size))
791 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
792 ret->data.file.reader_cls =
793 GNUNET_FS_make_file_reader_context_ (ret->filename);
797 case 1: /* file-index, no hash */
798 if (NULL == ret->filename)
803 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
808 ret->is_directory = GNUNET_NO;
809 ret->data.file.do_index = GNUNET_YES;
810 ret->data.file.have_hash = GNUNET_NO;
811 ret->data.file.index_start_confirmed = GNUNET_NO;
812 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
813 ret->data.file.reader_cls =
814 GNUNET_FS_make_file_reader_context_ (ret->filename);
816 case 2: /* file-index-with-hash */
817 if (NULL == ret->filename)
822 if ((GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
824 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id,
825 sizeof (GNUNET_HashCode))))
830 ret->is_directory = GNUNET_NO;
831 ret->data.file.do_index = GNUNET_YES;
832 ret->data.file.have_hash = GNUNET_YES;
833 ret->data.file.index_start_confirmed = GNUNET_NO;
834 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
835 ret->data.file.reader_cls =
836 GNUNET_FS_make_file_reader_context_ (ret->filename);
838 case 3: /* file-index-with-hash-confirmed */
839 if (NULL == ret->filename)
844 if ((GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
846 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id,
847 sizeof (GNUNET_HashCode))))
852 ret->is_directory = GNUNET_NO;
853 ret->data.file.do_index = GNUNET_YES;
854 ret->data.file.have_hash = GNUNET_YES;
855 ret->data.file.index_start_confirmed = GNUNET_YES;
856 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
857 ret->data.file.reader_cls =
858 GNUNET_FS_make_file_reader_context_ (ret->filename);
860 case 4: /* directory */
861 ret->is_directory = GNUNET_YES;
862 if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dsize)) ||
863 (NULL == (ret->data.dir.dir_data = GNUNET_malloc_large (dsize))) ||
865 GNUNET_BIO_read (rh, "dir-data", ret->data.dir.dir_data, dsize)) ||
867 GNUNET_BIO_read_string (rh, "ent-filename", &filename, 16 * 1024)))
872 ret->data.dir.dir_size = (uint32_t) dsize;
873 if (filename != NULL)
875 ret->data.dir.entries = deserialize_file_information (h, filename);
876 GNUNET_free (filename);
878 nxt = ret->data.dir.entries;
890 ret->serialization = GNUNET_strdup (fn);
892 GNUNET_BIO_read_string (rh, "nxt-filename", &filename, 16 * 1024))
897 if (filename != NULL)
899 ret->next = deserialize_file_information (h, filename);
900 GNUNET_free (filename);
903 GNUNET_free_non_null (ksks);
904 GNUNET_free_non_null (chks);
907 GNUNET_free_non_null (ksks);
908 GNUNET_free_non_null (chks);
909 GNUNET_free_non_null (filename);
910 GNUNET_FS_file_information_destroy (ret, NULL, NULL);
916 * Using the given serialization filename, try to deserialize
917 * the file-information tree associated with it.
919 * @param h master context
920 * @param filename name of the file (without directory) with
922 * @return NULL on error
924 static struct GNUNET_FS_FileInformation *
925 deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename)
927 struct GNUNET_FS_FileInformation *ret;
928 struct GNUNET_BIO_ReadHandle *rh;
931 rh = get_read_handle (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
934 ret = deserialize_fi_node (h, filename, rh);
935 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
937 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
938 _("Failed to resume publishing information `%s': %s\n"),
944 if (0 != UNLINK (filename))
945 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
952 * Given a serialization name (full absolute path), return the
953 * basename of the file (without the path), which must only
954 * consist of the 6 random characters.
956 * @param fullname name to extract the basename from
957 * @return copy of the basename, NULL on error
960 get_serialization_short_name (const char *fullname)
967 /* FIXME: we could do this faster since we know
968 * the length of 'end'... */
971 if (DIR_SEPARATOR == *nxt)
975 if ((end == NULL) || (strlen (end) == 0))
980 GNUNET_break (6 == strlen (end));
981 return GNUNET_strdup (end);
986 * Create a new random name for serialization. Also checks if persistence
987 * is enabled and returns NULL if not.
989 * @param h master context
990 * @param ext component of the path
991 * @return NULL on errror
994 make_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext)
1000 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1001 return NULL; /* persistence not requested */
1002 dn = get_serialization_file_name (h, ext, "");
1005 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1010 fn = GNUNET_DISK_mktemp (dn);
1013 return NULL; /* epic fail */
1014 ret = get_serialization_short_name (fn);
1021 * Create a new random name for serialization. Also checks if persistence
1022 * is enabled and returns NULL if not.
1024 * @param h master context
1025 * @param ext component of the path
1026 * @param uni name of parent
1027 * @return NULL on errror
1030 make_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h,
1031 const char *ext, const char *uni)
1037 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
1038 return NULL; /* persistence not requested */
1039 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
1042 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
1047 fn = GNUNET_DISK_mktemp (dn);
1050 return NULL; /* epic fail */
1051 ret = get_serialization_short_name (fn);
1058 * Copy all of the data from the reader to the write handle.
1060 * @param wh write handle
1061 * @param fi file with reader
1062 * @return GNUNET_OK on success
1065 copy_from_reader (struct GNUNET_BIO_WriteHandle *wh,
1066 struct GNUNET_FS_FileInformation *fi)
1068 char buf[32 * 1024];
1076 while (off < fi->data.file.file_size)
1078 left = GNUNET_MIN (sizeof (buf), fi->data.file.file_size - off);
1080 fi->data.file.reader (fi->data.file.reader_cls, off, left, buf, &emsg);
1084 return GNUNET_SYSERR;
1086 if (GNUNET_OK != GNUNET_BIO_write (wh, buf, ret))
1087 return GNUNET_SYSERR;
1095 * Create a temporary file on disk to store the current
1098 * @param fi file information to sync with disk
1101 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *fi)
1104 struct GNUNET_BIO_WriteHandle *wh;
1109 if (NULL == fi->serialization)
1111 make_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO);
1112 if (NULL == fi->serialization)
1114 wh = get_write_handle (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1118 GNUNET_free (fi->serialization);
1119 fi->serialization = NULL;
1122 if (GNUNET_YES == fi->is_directory)
1124 else if (GNUNET_YES == fi->data.file.index_start_confirmed)
1126 else if (GNUNET_YES == fi->data.file.have_hash)
1128 else if (GNUNET_YES == fi->data.file.do_index)
1132 if (fi->keywords != NULL)
1133 ksks = GNUNET_FS_uri_to_string (fi->keywords);
1136 if (fi->chk_uri != NULL)
1137 chks = GNUNET_FS_uri_to_string (fi->chk_uri);
1140 if ((GNUNET_OK != GNUNET_BIO_write (wh, &b, sizeof (b))) ||
1141 (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, fi->meta)) ||
1142 (GNUNET_OK != GNUNET_BIO_write_string (wh, ksks)) ||
1143 (GNUNET_OK != GNUNET_BIO_write_string (wh, chks)) ||
1144 (GNUNET_OK != write_start_time (wh, fi->start_time)) ||
1145 (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->emsg)) ||
1146 (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->filename)) ||
1148 GNUNET_BIO_write_int64 (wh, fi->bo.expiration_time.abs_value)) ||
1149 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.anonymity_level)) ||
1150 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.content_priority)) ||
1151 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.replication_level)))
1156 GNUNET_free_non_null (chks);
1158 GNUNET_free_non_null (ksks);
1163 case 0: /* file-insert */
1164 if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1169 if ((GNUNET_NO == fi->is_published) && (NULL == fi->filename))
1170 if (GNUNET_OK != copy_from_reader (wh, fi))
1176 case 1: /* file-index, no hash */
1177 if (NULL == fi->filename)
1182 if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1188 case 2: /* file-index-with-hash */
1189 case 3: /* file-index-with-hash-confirmed */
1190 if (NULL == fi->filename)
1195 if ((GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size)) ||
1197 GNUNET_BIO_write (wh, &fi->data.file.file_id,
1198 sizeof (GNUNET_HashCode))))
1204 case 4: /* directory */
1205 if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->data.dir.dir_size)) ||
1207 GNUNET_BIO_write (wh, fi->data.dir.dir_data,
1208 (uint32_t) fi->data.dir.dir_size)) ||
1210 GNUNET_BIO_write_string (wh,
1211 (fi->data.dir.entries ==
1212 NULL) ? NULL : fi->data.dir.
1213 entries->serialization)))
1224 GNUNET_BIO_write_string (wh,
1226 NULL) ? fi->next->serialization : NULL))
1231 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1240 (void) GNUNET_BIO_write_close (wh);
1241 GNUNET_free_non_null (chks);
1242 GNUNET_free_non_null (ksks);
1243 fn = get_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1247 if (0 != UNLINK (fn))
1248 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1251 GNUNET_free (fi->serialization);
1252 fi->serialization = NULL;
1258 * Find the entry in the file information struct where the
1259 * serialization filename matches the given name.
1261 * @param pos file information to search
1262 * @param srch filename to search for
1263 * @return NULL if srch was not found in this subtree
1265 static struct GNUNET_FS_FileInformation *
1266 find_file_position (struct GNUNET_FS_FileInformation *pos, const char *srch)
1268 struct GNUNET_FS_FileInformation *r;
1272 if (0 == strcmp (srch, pos->serialization))
1274 if (pos->is_directory == GNUNET_YES)
1276 r = find_file_position (pos->data.dir.entries, srch);
1287 * Signal the FS's progress function that we are resuming
1290 * @param cls closure (of type "struct GNUNET_FS_PublishContext*")
1291 * @param fi the entry in the publish-structure
1292 * @param length length of the file or directory
1293 * @param meta metadata for the file or directory (can be modified)
1294 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1295 * @param bo block options (can be modified)
1296 * @param do_index should we index?
1297 * @param client_info pointer to client context set upon creation (can be modified)
1298 * @return GNUNET_OK to continue (always)
1301 fip_signal_resume (void *cls, struct GNUNET_FS_FileInformation *fi,
1302 uint64_t length, struct GNUNET_CONTAINER_MetaData *meta,
1303 struct GNUNET_FS_Uri **uri,
1304 struct GNUNET_FS_BlockOptions *bo, int *do_index,
1307 struct GNUNET_FS_PublishContext *pc = cls;
1308 struct GNUNET_FS_ProgressInfo pi;
1310 if (GNUNET_YES == pc->skip_next_fi_callback)
1312 pc->skip_next_fi_callback = GNUNET_NO;
1315 pi.status = GNUNET_FS_STATUS_PUBLISH_RESUME;
1316 pi.value.publish.specifics.resume.message = pc->fi->emsg;
1317 pi.value.publish.specifics.resume.chk_uri = pc->fi->chk_uri;
1318 *client_info = GNUNET_FS_publish_make_status_ (&pi, pc, fi, 0);
1319 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta))
1321 /* process entries in directory */
1322 pc->skip_next_fi_callback = GNUNET_YES;
1323 GNUNET_FS_file_information_inspect (fi, &fip_signal_resume, pc);
1330 * Function called with a filename of serialized publishing operation
1333 * @param cls the 'struct GNUNET_FS_Handle*'
1334 * @param filename complete filename (absolute path)
1335 * @return GNUNET_OK (continue to iterate)
1338 deserialize_publish_file (void *cls, const char *filename)
1340 struct GNUNET_FS_Handle *h = cls;
1341 struct GNUNET_BIO_ReadHandle *rh;
1342 struct GNUNET_FS_PublishContext *pc;
1350 pc = GNUNET_malloc (sizeof (struct GNUNET_FS_PublishContext));
1352 pc->serialization = get_serialization_short_name (filename);
1356 rh = GNUNET_BIO_read_open (filename);
1362 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-nid", &pc->nid, 1024))
1364 GNUNET_BIO_read_string (rh, "publish-nuid", &pc->nuid, 1024)) ||
1365 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
1366 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &all_done)) ||
1368 GNUNET_BIO_read_string (rh, "publish-firoot", &fi_root, 128)) ||
1369 (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-fipos", &fi_pos, 128))
1370 || (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-ns", &ns, 1024)))
1375 pc->options = options;
1376 pc->all_done = all_done;
1377 if (NULL == fi_root)
1382 pc->fi = deserialize_file_information (h, fi_root);
1390 pc->namespace = GNUNET_FS_namespace_create (h, ns);
1391 if (pc->namespace == NULL)
1393 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1395 ("Failed to recover namespace `%s', cannot resume publishing operation.\n"),
1400 if ((0 == (pc->options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY)) &&
1401 (GNUNET_YES != pc->all_done))
1403 pc->dsh = GNUNET_DATASTORE_connect (h->cfg);
1404 if (NULL == pc->dsh)
1409 pc->fi_pos = find_file_position (pc->fi, fi_pos);
1410 GNUNET_free (fi_pos);
1412 if (pc->fi_pos == NULL)
1414 /* failed to find position for resuming, outch! Will start from root! */
1416 if (pc->all_done != GNUNET_YES)
1417 pc->fi_pos = pc->fi;
1420 GNUNET_free (fi_root);
1422 /* generate RESUME event(s) */
1423 GNUNET_FS_file_information_inspect (pc->fi, &fip_signal_resume, pc);
1425 /* re-start publishing (if needed)... */
1426 if (pc->all_done != GNUNET_YES)
1428 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
1430 GNUNET_SCHEDULER_add_with_priority
1431 (GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
1432 &GNUNET_FS_publish_main_, pc);
1434 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1436 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1437 _("Failure while resuming publishing operation `%s': %s\n"),
1441 GNUNET_free_non_null (ns);
1442 pc->top = GNUNET_FS_make_top (h, &GNUNET_FS_publish_signal_suspend_, pc);
1445 GNUNET_free_non_null (pc->nid);
1446 GNUNET_free_non_null (pc->nuid);
1447 GNUNET_free_non_null (fi_root);
1448 GNUNET_free_non_null (fi_pos);
1449 GNUNET_free_non_null (ns);
1450 if ((rh != NULL) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
1452 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1453 _("Failed to resume publishing operation `%s': %s\n"), filename,
1458 GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
1459 if (0 != UNLINK (filename))
1460 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
1461 GNUNET_free (pc->serialization);
1468 * Synchronize this publishing struct with its mirror
1469 * on disk. Note that all internal FS-operations that change
1470 * publishing structs should already call "sync" internally,
1471 * so this function is likely not useful for clients.
1473 * @param pc the struct to sync
1476 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc)
1478 struct GNUNET_BIO_WriteHandle *wh;
1480 if (NULL == pc->serialization)
1482 make_serialization_file_name (pc->h,
1483 GNUNET_FS_SYNC_PATH_MASTER_PUBLISH);
1484 if (NULL == pc->serialization)
1488 if (NULL == pc->fi->serialization)
1493 wh = get_write_handle (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1500 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nid)) ||
1501 (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nuid)) ||
1502 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->options)) ||
1503 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->all_done)) ||
1504 (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->fi->serialization)) ||
1506 GNUNET_BIO_write_string (wh,
1508 NULL) ? NULL : pc->fi_pos->serialization)) ||
1510 GNUNET_BIO_write_string (wh,
1512 NULL) ? NULL : pc->namespace->name)))
1517 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1526 (void) GNUNET_BIO_write_close (wh);
1527 GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1529 GNUNET_free (pc->serialization);
1530 pc->serialization = NULL;
1535 * Synchronize this unindex struct with its mirror
1536 * on disk. Note that all internal FS-operations that change
1537 * publishing structs should already call "sync" internally,
1538 * so this function is likely not useful for clients.
1540 * @param uc the struct to sync
1543 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc)
1545 struct GNUNET_BIO_WriteHandle *wh;
1548 if (NULL == uc->serialization)
1550 make_serialization_file_name (uc->h,
1551 GNUNET_FS_SYNC_PATH_MASTER_UNINDEX);
1552 if (NULL == uc->serialization)
1554 wh = get_write_handle (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1561 if (NULL != uc->ksk_uri)
1562 uris = GNUNET_FS_uri_to_string (uc->ksk_uri);
1565 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uc->filename)) ||
1566 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, uc->file_size)) ||
1567 (GNUNET_OK != write_start_time (wh, uc->start_time)) ||
1568 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->state)) ||
1570 GNUNET_BIO_write (wh, &uc->chk, sizeof (struct ContentHashKey))) ||
1571 (GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1572 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->ksk_offset)) ||
1573 ((uc->state == UNINDEX_STATE_FS_NOTIFY) &&
1575 GNUNET_BIO_write (wh, &uc->file_id, sizeof (GNUNET_HashCode)))) ||
1576 ((uc->state == UNINDEX_STATE_ERROR) &&
1577 (GNUNET_OK != GNUNET_BIO_write_string (wh, uc->emsg))))
1582 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1591 (void) GNUNET_BIO_write_close (wh);
1592 GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1594 GNUNET_free (uc->serialization);
1595 uc->serialization = NULL;
1600 * Serialize a download request.
1602 * @param wh the 'struct GNUNET_BIO_WriteHandle*'
1603 * @param dr the 'struct DownloadRequest'
1604 * @return GNUNET_YES on success, GNUNET_NO on error
1607 write_download_request (struct GNUNET_BIO_WriteHandle *wh,
1608 struct DownloadRequest *dr)
1612 if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->state)) ||
1613 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dr->offset)) ||
1614 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->num_children)) ||
1615 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->depth)))
1617 if ((dr->state == BRS_CHK_SET) &&
1619 GNUNET_BIO_write (wh, &dr->chk, sizeof (struct ContentHashKey))))
1621 for (i = 0; i < dr->num_children; i++)
1622 if (GNUNET_NO == write_download_request (wh, dr->children[i]))
1629 * Read a download request tree.
1631 * @param rh stream to read from
1632 * @return value the 'struct DownloadRequest', NULL on error
1634 static struct DownloadRequest *
1635 read_download_request (struct GNUNET_BIO_ReadHandle *rh)
1637 struct DownloadRequest *dr;
1640 dr = GNUNET_malloc (sizeof (struct DownloadRequest));
1642 if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->state)) ||
1643 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dr->offset)) ||
1644 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->num_children)) ||
1645 (dr->num_children > CHK_PER_INODE) ||
1646 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->depth)) || ((dr->depth == 0)
1650 ((dr->depth > 0) && (dr->num_children == 0)))
1653 dr->num_children = 0;
1656 if (dr->num_children > 0)
1658 GNUNET_malloc (dr->num_children * sizeof (struct ContentHashKey));
1662 case BRS_RECONSTRUCT_DOWN:
1663 case BRS_RECONSTRUCT_META_UP:
1664 case BRS_RECONSTRUCT_UP:
1668 GNUNET_BIO_read (rh, "chk", &dr->chk, sizeof (struct ContentHashKey)))
1671 case BRS_DOWNLOAD_DOWN:
1672 case BRS_DOWNLOAD_UP:
1679 for (i = 0; i < dr->num_children; i++)
1681 if (NULL == (dr->children[i] = read_download_request (rh)))
1683 dr->children[i]->parent = dr;
1687 GNUNET_FS_free_download_request_ (dr);
1693 * Compute the name of the sync file (or directory) for the given download
1696 * @param dc download context to compute for
1697 * @param uni unique filename to use, use "" for the directory name
1698 * @param ext extension to use, use ".dir" for our own subdirectory
1699 * @return the expanded file name, NULL for none
1702 get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc,
1703 const char *uni, const char *ext)
1708 if (dc->parent == NULL)
1709 return get_serialization_file_name (dc->h,
1712 GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
1713 GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
1715 if (dc->parent->serialization == NULL)
1717 par = get_download_sync_filename (dc->parent, dc->parent->serialization, "");
1720 GNUNET_asprintf (&epar, "%s.dir%s%s%s", par, DIR_SEPARATOR_STR, uni, ext);
1727 * Synchronize this download struct with its mirror
1728 * on disk. Note that all internal FS-operations that change
1729 * publishing structs should already call "sync" internally,
1730 * so this function is likely not useful for clients.
1732 * @param dc the struct to sync
1735 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc)
1737 struct GNUNET_BIO_WriteHandle *wh;
1742 if (0 != (dc->options & GNUNET_FS_DOWNLOAD_IS_PROBE))
1743 return; /* we don't sync probes */
1744 if (NULL == dc->serialization)
1746 dir = get_download_sync_filename (dc, "", "");
1749 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dir))
1754 fn = GNUNET_DISK_mktemp (dir);
1758 dc->serialization = get_serialization_short_name (fn);
1762 fn = get_download_sync_filename (dc, dc->serialization, "");
1765 GNUNET_free (dc->serialization);
1766 dc->serialization = NULL;
1771 wh = GNUNET_BIO_write_open (fn);
1774 GNUNET_free (dc->serialization);
1775 dc->serialization = NULL;
1779 GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_chk (dc->uri)) ||
1780 (GNUNET_YES == GNUNET_FS_uri_test_loc (dc->uri)));
1781 uris = GNUNET_FS_uri_to_string (dc->uri);
1782 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1783 (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, dc->meta)) ||
1784 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->emsg)) ||
1785 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->filename)) ||
1786 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->temp_filename)) ||
1787 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->old_file_size)) ||
1788 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->offset)) ||
1789 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->length)) ||
1790 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->completed)) ||
1791 (GNUNET_OK != write_start_time (wh, dc->start_time)) ||
1792 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dc->anonymity)) ||
1793 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->options)) ||
1794 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->has_finished)))
1799 if (NULL == dc->emsg)
1801 GNUNET_assert (dc->top_request != NULL);
1802 if (GNUNET_YES != write_download_request (wh, dc->top_request))
1808 GNUNET_free_non_null (uris);
1810 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1820 (void) GNUNET_BIO_write_close (wh);
1821 GNUNET_free_non_null (uris);
1822 if (0 != UNLINK (fn))
1823 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1825 GNUNET_free (dc->serialization);
1826 dc->serialization = NULL;
1831 * Synchronize this search result with its mirror
1832 * on disk. Note that all internal FS-operations that change
1833 * publishing structs should already call "sync" internally,
1834 * so this function is likely not useful for clients.
1836 * @param sr the struct to sync
1839 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr)
1841 struct GNUNET_BIO_WriteHandle *wh;
1845 if (NULL == sr->serialization)
1847 make_serialization_file_name_in_dir (sr->sc->h,
1848 (sr->sc->psearch_result ==
1850 GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1851 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1852 sr->sc->serialization);
1853 if (NULL == sr->serialization)
1855 wh = get_write_handle_in_dir (sr->sc->h,
1856 (sr->sc->psearch_result ==
1857 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1858 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1859 sr->sc->serialization, sr->serialization);
1865 uris = GNUNET_FS_uri_to_string (sr->uri);
1866 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1868 GNUNET_BIO_write_string (wh,
1870 NULL ? sr->download->serialization : NULL)) ||
1872 GNUNET_BIO_write_string (wh,
1873 sr->update_search !=
1874 NULL ? sr->update_search->serialization : NULL))
1875 || (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, sr->meta)) ||
1876 (GNUNET_OK != GNUNET_BIO_write (wh, &sr->key, sizeof (GNUNET_HashCode)))
1877 || (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->mandatory_missing)) ||
1878 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->optional_support)) ||
1879 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_success)) ||
1880 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_trials)) )
1885 if ( (sr->uri != NULL) &&
1886 (sr->sc->uri->type == ksk) &&
1887 (GNUNET_OK != GNUNET_BIO_write (wh, sr->keyword_bitmap,
1888 (sr->sc->uri->data.ksk.keywordCount + 7) / 8)) )
1893 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1899 GNUNET_free_non_null (uris);
1902 GNUNET_free_non_null (uris);
1904 (void) GNUNET_BIO_write_close (wh);
1905 remove_sync_file_in_dir (sr->sc->h,
1906 (sr->sc->psearch_result ==
1907 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1908 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1909 sr->sc->serialization, sr->serialization);
1910 GNUNET_free (sr->serialization);
1911 sr->serialization = NULL;
1916 * Synchronize this search struct with its mirror
1917 * on disk. Note that all internal FS-operations that change
1918 * publishing structs should already call "sync" internally,
1919 * so this function is likely not useful for clients.
1921 * @param sc the struct to sync
1924 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc)
1926 struct GNUNET_BIO_WriteHandle *wh;
1929 const char *category;
1932 (sc->psearch_result ==
1933 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1934 GNUNET_FS_SYNC_PATH_CHILD_SEARCH;
1935 if (NULL == sc->serialization)
1936 sc->serialization = make_serialization_file_name (sc->h, category);
1937 if (NULL == sc->serialization)
1940 wh = get_write_handle (sc->h, category, sc->serialization);
1946 GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_ksk (sc->uri)) ||
1947 (GNUNET_YES == GNUNET_FS_uri_test_sks (sc->uri)));
1948 uris = GNUNET_FS_uri_to_string (sc->uri);
1949 in_pause = (sc->task != GNUNET_SCHEDULER_NO_TASK) ? 'r' : '\0';
1950 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1951 (GNUNET_OK != write_start_time (wh, sc->start_time)) ||
1952 (GNUNET_OK != GNUNET_BIO_write_string (wh, sc->emsg)) ||
1953 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) sc->options)) ||
1954 (GNUNET_OK != GNUNET_BIO_write (wh, &in_pause, sizeof (in_pause))) ||
1955 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sc->anonymity)))
1962 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1971 (void) GNUNET_BIO_write_close (wh);
1972 GNUNET_free_non_null (uris);
1973 GNUNET_FS_remove_sync_file_ (sc->h, category, sc->serialization);
1974 GNUNET_free (sc->serialization);
1975 sc->serialization = NULL;
1980 * Function called with a filename of serialized unindexing operation
1983 * @param cls the 'struct GNUNET_FS_Handle*'
1984 * @param filename complete filename (absolute path)
1985 * @return GNUNET_OK (continue to iterate)
1988 deserialize_unindex_file (void *cls, const char *filename)
1990 struct GNUNET_FS_Handle *h = cls;
1991 struct GNUNET_BIO_ReadHandle *rh;
1992 struct GNUNET_FS_UnindexContext *uc;
1993 struct GNUNET_FS_ProgressInfo pi;
1998 uc = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
2000 uc->serialization = get_serialization_short_name (filename);
2001 rh = GNUNET_BIO_read_open (filename);
2009 GNUNET_BIO_read_string (rh, "unindex-fn", &uc->filename, 10 * 1024)) ||
2010 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &uc->file_size)) ||
2011 (GNUNET_OK != read_start_time (rh, &uc->start_time)) ||
2012 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &state)) ||
2013 (GNUNET_OK != GNUNET_BIO_read (rh, "uri", &uc->chk, sizeof (struct ContentHashKey))) ||
2014 (GNUNET_OK != GNUNET_BIO_read_string (rh, "unindex-kskuri", &uris, 10 * 1024)) ||
2015 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &uc->ksk_offset)) )
2017 GNUNET_free_non_null (uris);
2023 uc->ksk_uri = GNUNET_FS_uri_parse (uris, &emsg);
2025 if (NULL == uc->ksk_uri)
2031 if ( (uc->ksk_offset > 0) &&
2032 ( (NULL == uc->ksk_uri) ||
2033 (uc->ksk_offset > uc->ksk_uri->data.ksk.keywordCount) ) )
2038 uc->state = (enum UnindexState) state;
2041 case UNINDEX_STATE_HASHING:
2043 case UNINDEX_STATE_FS_NOTIFY:
2045 GNUNET_BIO_read (rh, "unindex-hash", &uc->file_id,
2046 sizeof (GNUNET_HashCode)))
2052 case UNINDEX_STATE_DS_REMOVE:
2053 case UNINDEX_STATE_EXTRACT_KEYWORDS:
2054 case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2056 case UNINDEX_STATE_COMPLETE:
2058 case UNINDEX_STATE_ERROR:
2060 GNUNET_BIO_read_string (rh, "unindex-emsg", &uc->emsg, 10 * 1024))
2070 uc->top = GNUNET_FS_make_top (h, &GNUNET_FS_unindex_signal_suspend_, uc);
2071 pi.status = GNUNET_FS_STATUS_UNINDEX_RESUME;
2072 pi.value.unindex.specifics.resume.message = uc->emsg;
2073 GNUNET_FS_unindex_make_status_ (&pi, uc,
2075 UNINDEX_STATE_COMPLETE) ? uc->file_size : 0);
2078 case UNINDEX_STATE_HASHING:
2080 GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, uc->filename,
2082 &GNUNET_FS_unindex_process_hash_, uc);
2084 case UNINDEX_STATE_FS_NOTIFY:
2085 uc->state = UNINDEX_STATE_HASHING;
2086 GNUNET_FS_unindex_process_hash_ (uc, &uc->file_id);
2088 case UNINDEX_STATE_DS_REMOVE:
2089 GNUNET_FS_unindex_do_remove_ (uc);
2091 case UNINDEX_STATE_EXTRACT_KEYWORDS:
2092 GNUNET_FS_unindex_do_extract_keywords_ (uc);
2094 case UNINDEX_STATE_DS_REMOVE_KBLOCKS:
2095 GNUNET_FS_unindex_do_remove_kblocks_ (uc);
2097 case UNINDEX_STATE_COMPLETE:
2098 case UNINDEX_STATE_ERROR:
2099 /* no need to resume any operation, we were done */
2104 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2106 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2107 _("Failure while resuming unindexing operation `%s': %s\n"),
2113 GNUNET_free_non_null (uc->filename);
2114 if ((rh != NULL) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
2116 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2117 _("Failed to resume unindexing operation `%s': %s\n"), filename,
2121 if (uc->serialization != NULL)
2122 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2124 GNUNET_free_non_null (uc->serialization);
2131 * Deserialize a download.
2133 * @param h overall context
2134 * @param rh file to deserialize from
2135 * @param parent parent download
2136 * @param search associated search
2137 * @param serialization name under which the search was serialized
2140 deserialize_download (struct GNUNET_FS_Handle *h,
2141 struct GNUNET_BIO_ReadHandle *rh,
2142 struct GNUNET_FS_DownloadContext *parent,
2143 struct GNUNET_FS_SearchResult *search,
2144 const char *serialization);
2148 * Deserialize a search.
2150 * @param h overall context
2151 * @param rh file to deserialize from
2152 * @param psearch_result parent search result
2153 * @param serialization name under which the search was serialized
2155 static struct GNUNET_FS_SearchContext *
2156 deserialize_search (struct GNUNET_FS_Handle *h,
2157 struct GNUNET_BIO_ReadHandle *rh,
2158 struct GNUNET_FS_SearchResult *psearch_result,
2159 const char *serialization);
2163 * Function called with a filename of serialized search result
2166 * @param cls the 'struct GNUNET_FS_SearchContext*'
2167 * @param filename complete filename (absolute path)
2168 * @return GNUNET_OK (continue to iterate)
2171 deserialize_search_result (void *cls, const char *filename)
2173 struct GNUNET_FS_SearchContext *sc = cls;
2179 struct GNUNET_BIO_ReadHandle *rh;
2180 struct GNUNET_BIO_ReadHandle *drh;
2181 struct GNUNET_FS_SearchResult *sr;
2183 ser = get_serialization_short_name (filename);
2184 rh = GNUNET_BIO_read_open (filename);
2189 remove_sync_file_in_dir (sc->h,
2190 (sc->psearch_result ==
2191 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2192 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2193 sc->serialization, ser);
2202 sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
2204 sr->serialization = ser;
2205 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "result-uri", &uris, 10 * 1024))
2206 || (NULL == (sr->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2207 (GNUNET_OK != GNUNET_BIO_read_string (rh, "download-lnk", &download, 16))
2209 GNUNET_BIO_read_string (rh, "search-lnk", &update_srch, 16)) ||
2210 (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "result-meta", &sr->meta)) ||
2212 GNUNET_BIO_read (rh, "result-key", &sr->key, sizeof (GNUNET_HashCode)))
2213 || (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->mandatory_missing)) ||
2214 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->optional_support)) ||
2215 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_success)) ||
2216 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_trials)))
2221 if (sr->sc->uri->type == ksk)
2223 sr->keyword_bitmap = GNUNET_malloc ((sr->sc->uri->data.ksk.keywordCount + 7) / 8); /* round up, count bits */
2224 if (GNUNET_OK != GNUNET_BIO_read (rh, "keyword-bitmap",
2226 (sr->sc->uri->data.ksk.keywordCount + 7) / 8))
2233 if (download != NULL)
2235 drh = get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD, download);
2238 deserialize_download (sc->h, drh, NULL, sr, download);
2239 if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2241 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2242 _("Failed to resume sub-download `%s': %s\n"), download,
2247 GNUNET_free (download);
2249 if (update_srch != NULL)
2252 get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_SEARCH, update_srch);
2255 deserialize_search (sc->h, drh, sr, update_srch);
2256 if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2258 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2259 _("Failed to resume sub-search `%s': %s\n"), update_srch,
2264 GNUNET_free (update_srch);
2266 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &sr->key, sr,
2267 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2268 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2270 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2271 _("Failure while resuming search operation `%s': %s\n"),
2277 GNUNET_free_non_null (download);
2278 GNUNET_free_non_null (emsg);
2279 GNUNET_free_non_null (uris);
2280 GNUNET_free_non_null (update_srch);
2281 if (sr->uri != NULL)
2282 GNUNET_FS_uri_destroy (sr->uri);
2283 if (sr->meta != NULL)
2284 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2285 GNUNET_free (sr->serialization);
2287 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2289 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2290 _("Failure while resuming search operation `%s': %s\n"),
2299 * Send the 'resume' signal to the callback; also actually
2300 * resume the download (put it in the queue). Does this
2301 * recursively for the top-level download and all child
2304 * @param dc download to resume
2307 signal_download_resume (struct GNUNET_FS_DownloadContext *dc)
2309 struct GNUNET_FS_DownloadContext *dcc;
2310 struct GNUNET_FS_ProgressInfo pi;
2312 pi.status = GNUNET_FS_STATUS_DOWNLOAD_RESUME;
2313 pi.value.download.specifics.resume.meta = dc->meta;
2314 pi.value.download.specifics.resume.message = dc->emsg;
2315 GNUNET_FS_download_make_status_ (&pi, dc);
2316 dcc = dc->child_head;
2319 signal_download_resume (dcc);
2322 if (dc->pending_head != NULL)
2323 GNUNET_FS_download_start_downloading_ (dc);
2328 * Signal resuming of a search to our clients (for the
2329 * top level search and all sub-searches).
2331 * @param sc search being resumed
2334 signal_search_resume (struct GNUNET_FS_SearchContext *sc);
2338 * Iterator over search results signaling resume to the client for
2341 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2342 * @param key current key code
2343 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2344 * @return GNUNET_YES (we should continue to iterate)
2347 signal_result_resume (void *cls, const GNUNET_HashCode * key, void *value)
2349 struct GNUNET_FS_SearchContext *sc = cls;
2350 struct GNUNET_FS_ProgressInfo pi;
2351 struct GNUNET_FS_SearchResult *sr = value;
2353 if (0 == sr->mandatory_missing)
2355 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME_RESULT;
2356 pi.value.search.specifics.resume_result.meta = sr->meta;
2357 pi.value.search.specifics.resume_result.uri = sr->uri;
2358 pi.value.search.specifics.resume_result.result = sr;
2359 pi.value.search.specifics.resume_result.availability_rank =
2360 2 * sr->availability_success - sr->availability_trials;
2361 pi.value.search.specifics.resume_result.availability_certainty =
2362 sr->availability_trials;
2363 pi.value.search.specifics.resume_result.applicability_rank =
2364 sr->optional_support;
2365 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
2367 if (sr->download != NULL)
2369 signal_download_resume (sr->download);
2373 GNUNET_FS_search_start_probe_ (sr);
2375 if (sr->update_search != NULL)
2376 signal_search_resume (sr->update_search);
2382 * Free memory allocated by the search context and its children
2384 * @param sc search context to free
2387 free_search_context (struct GNUNET_FS_SearchContext *sc);
2391 * Iterator over search results freeing each.
2393 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2394 * @param key current key code
2395 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2396 * @return GNUNET_YES (we should continue to iterate)
2399 free_result (void *cls, const GNUNET_HashCode * key, void *value)
2401 struct GNUNET_FS_SearchResult *sr = value;
2403 if (sr->update_search != NULL)
2405 free_search_context (sr->update_search);
2406 GNUNET_assert (NULL == sr->update_search);
2408 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2409 GNUNET_FS_uri_destroy (sr->uri);
2416 * Free memory allocated by the search context and its children
2418 * @param sc search context to free
2421 free_search_context (struct GNUNET_FS_SearchContext *sc)
2423 if (sc->serialization != NULL)
2425 GNUNET_FS_remove_sync_file_ (sc->h,
2426 (sc->psearch_result ==
2427 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2428 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2430 GNUNET_FS_remove_sync_dir_ (sc->h,
2431 (sc->psearch_result ==
2432 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2433 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2436 GNUNET_free_non_null (sc->serialization);
2437 GNUNET_free_non_null (sc->emsg);
2438 if (sc->uri != NULL)
2439 GNUNET_FS_uri_destroy (sc->uri);
2440 if (sc->master_result_map != NULL)
2442 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map, &free_result,
2444 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
2451 * Function called with a filename of serialized sub-download
2454 * @param cls the 'struct GNUNET_FS_DownloadContext*' (parent)
2455 * @param filename complete filename (absolute path)
2456 * @return GNUNET_OK (continue to iterate)
2459 deserialize_subdownload (void *cls, const char *filename)
2461 struct GNUNET_FS_DownloadContext *parent = cls;
2464 struct GNUNET_BIO_ReadHandle *rh;
2466 ser = get_serialization_short_name (filename);
2467 rh = GNUNET_BIO_read_open (filename);
2470 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2472 ("Failed to resume sub-download `%s': could not open file `%s'\n"),
2477 deserialize_download (parent->h, rh, parent, NULL, ser);
2478 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2480 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2481 _("Failed to resume sub-download `%s': %s\n"), ser, emsg);
2490 * Free this download context and all of its descendants.
2491 * (only works during deserialization since not all possible
2492 * state it taken care of).
2494 * @param dc context to free
2497 free_download_context (struct GNUNET_FS_DownloadContext *dc)
2499 struct GNUNET_FS_DownloadContext *dcc;
2501 if (dc->meta != NULL)
2502 GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2503 if (dc->uri != NULL)
2504 GNUNET_FS_uri_destroy (dc->uri);
2505 GNUNET_free_non_null (dc->temp_filename);
2506 GNUNET_free_non_null (dc->emsg);
2507 GNUNET_free_non_null (dc->filename);
2508 GNUNET_free_non_null (dc->serialization);
2509 while (NULL != (dcc = dc->child_head))
2511 GNUNET_CONTAINER_DLL_remove (dc->child_head, dc->child_tail, dcc);
2512 free_download_context (dcc);
2514 GNUNET_FS_free_download_request_ (dc->top_request);
2515 if (NULL != dc->active)
2516 GNUNET_CONTAINER_multihashmap_destroy (dc->active);
2522 * Deserialize a download.
2524 * @param h overall context
2525 * @param rh file to deserialize from
2526 * @param parent parent download
2527 * @param search associated search
2528 * @param serialization name under which the search was serialized
2531 deserialize_download (struct GNUNET_FS_Handle *h,
2532 struct GNUNET_BIO_ReadHandle *rh,
2533 struct GNUNET_FS_DownloadContext *parent,
2534 struct GNUNET_FS_SearchResult *search,
2535 const char *serialization)
2537 struct GNUNET_FS_DownloadContext *dc;
2546 dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2547 dc->parent = parent;
2549 dc->serialization = GNUNET_strdup (serialization);
2551 GNUNET_BIO_read_string (rh, "download-uri", &uris, 10 * 1024)) ||
2552 (NULL == (dc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2553 ((GNUNET_YES != GNUNET_FS_uri_test_chk (dc->uri)) &&
2554 (GNUNET_YES != GNUNET_FS_uri_test_loc (dc->uri))) ||
2555 (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "download-meta", &dc->meta))
2557 GNUNET_BIO_read_string (rh, "download-emsg", &dc->emsg, 10 * 1024)) ||
2559 GNUNET_BIO_read_string (rh, "download-fn", &dc->filename, 10 * 1024)) ||
2561 GNUNET_BIO_read_string (rh, "download-tfn", &dc->temp_filename,
2563 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->old_file_size)) ||
2564 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->offset)) ||
2565 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->length)) ||
2566 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->completed)) ||
2567 (GNUNET_OK != read_start_time (rh, &dc->start_time)) ||
2568 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dc->anonymity)) ||
2569 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2570 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &status)))
2575 dc->options = (enum GNUNET_FS_DownloadOptions) options;
2577 GNUNET_CONTAINER_multihashmap_create (1 + 2 * (dc->length / DBLOCK_SIZE));
2578 dc->has_finished = (int) status;
2580 GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
2581 if (GNUNET_FS_uri_test_loc (dc->uri))
2582 GNUNET_assert (GNUNET_OK ==
2583 GNUNET_FS_uri_loc_get_peer_identity (dc->uri, &dc->target));
2584 if (dc->emsg == NULL)
2586 dc->top_request = read_download_request (rh);
2587 if (dc->top_request == NULL)
2593 dn = get_download_sync_filename (dc, dc->serialization, ".dir");
2596 if (GNUNET_YES == GNUNET_DISK_directory_test (dn))
2597 GNUNET_DISK_directory_scan (dn, &deserialize_subdownload, dc);
2602 GNUNET_abort (); // for debugging for now - FIXME
2603 GNUNET_CONTAINER_DLL_insert (parent->child_head, parent->child_tail, dc);
2607 dc->search = search;
2608 search->download = dc;
2610 if ((parent == NULL) && (search == NULL))
2613 GNUNET_FS_make_top (dc->h, &GNUNET_FS_download_signal_suspend_, dc);
2614 signal_download_resume (dc);
2617 dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_, dc);
2620 GNUNET_free_non_null (uris);
2621 GNUNET_free_non_null (emsg);
2622 free_download_context (dc);
2627 * Signal resuming of a search to our clients (for the
2628 * top level search and all sub-searches).
2630 * @param sc search being resumed
2633 signal_search_resume (struct GNUNET_FS_SearchContext *sc)
2635 struct GNUNET_FS_ProgressInfo pi;
2637 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME;
2638 pi.value.search.specifics.resume.message = sc->emsg;
2639 pi.value.search.specifics.resume.is_paused =
2640 (sc->client == NULL) ? GNUNET_YES : GNUNET_NO;
2641 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
2642 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2643 &signal_result_resume, sc);
2649 * Deserialize a search.
2651 * @param h overall context
2652 * @param rh file to deserialize from
2653 * @param psearch_result parent search result
2654 * @param serialization name under which the search was serialized
2656 static struct GNUNET_FS_SearchContext *
2657 deserialize_search (struct GNUNET_FS_Handle *h,
2658 struct GNUNET_BIO_ReadHandle *rh,
2659 struct GNUNET_FS_SearchResult *psearch_result,
2660 const char *serialization)
2662 struct GNUNET_FS_SearchContext *sc;
2669 if ((psearch_result != NULL) && (psearch_result->update_search != NULL))
2676 sc = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchContext));
2677 if (psearch_result != NULL)
2679 sc->psearch_result = psearch_result;
2680 psearch_result->update_search = sc;
2683 sc->serialization = GNUNET_strdup (serialization);
2684 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "search-uri", &uris, 10 * 1024))
2685 || (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2686 ((GNUNET_YES != GNUNET_FS_uri_test_ksk (sc->uri)) &&
2687 (GNUNET_YES != GNUNET_FS_uri_test_sks (sc->uri))) ||
2688 (GNUNET_OK != read_start_time (rh, &sc->start_time)) ||
2690 GNUNET_BIO_read_string (rh, "search-emsg", &sc->emsg, 10 * 1024)) ||
2691 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2693 GNUNET_BIO_read (rh, "search-pause", &in_pause, sizeof (in_pause))) ||
2694 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sc->anonymity)))
2699 sc->options = (enum GNUNET_FS_SearchOptions) options;
2700 sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16);
2701 dn = get_serialization_file_name_in_dir (h,
2702 (sc->psearch_result ==
2704 GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2705 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2706 sc->serialization, "");
2709 if (GNUNET_YES == GNUNET_DISK_directory_test (dn))
2710 GNUNET_DISK_directory_scan (dn, &deserialize_search_result, sc);
2713 if (('\0' == in_pause) &&
2714 (GNUNET_OK != GNUNET_FS_search_start_searching_ (sc)))
2716 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2718 ("Could not resume running search, will resume as paused search\n"));
2720 signal_search_resume (sc);
2724 GNUNET_free_non_null (emsg);
2725 free_search_context (sc);
2726 GNUNET_free_non_null (uris);
2732 * Function called with a filename of serialized search operation
2735 * @param cls the 'struct GNUNET_FS_Handle*'
2736 * @param filename complete filename (absolute path)
2737 * @return GNUNET_OK (continue to iterate)
2740 deserialize_search_file (void *cls, const char *filename)
2742 struct GNUNET_FS_Handle *h = cls;
2745 struct GNUNET_BIO_ReadHandle *rh;
2746 struct GNUNET_FS_SearchContext *sc;
2749 if (0 != STAT (filename, &buf))
2751 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "stat", filename);
2754 if (S_ISDIR (buf.st_mode))
2755 return GNUNET_OK; /* skip directories */
2756 ser = get_serialization_short_name (filename);
2757 rh = GNUNET_BIO_read_open (filename);
2762 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, ser);
2767 sc = deserialize_search (h, rh, NULL, ser);
2769 sc->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, sc);
2771 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2773 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2774 _("Failure while resuming search operation `%s': %s\n"),
2783 * Function called with a filename of serialized download operation
2786 * @param cls the 'struct GNUNET_FS_Handle*'
2787 * @param filename complete filename (absolute path)
2788 * @return GNUNET_OK (continue to iterate)
2791 deserialize_download_file (void *cls, const char *filename)
2793 struct GNUNET_FS_Handle *h = cls;
2796 struct GNUNET_BIO_ReadHandle *rh;
2798 ser = get_serialization_short_name (filename);
2799 rh = GNUNET_BIO_read_open (filename);
2802 if (0 != UNLINK (filename))
2803 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
2807 deserialize_download (h, rh, NULL, NULL, ser);
2809 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2811 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2812 _("Failure while resuming download operation `%s': %s\n"),
2821 * Deserialize informatin about pending operations.
2823 * @param master_path which master directory should be scanned
2824 * @param proc function to call for each entry (will get 'h' for 'cls')
2825 * @param h the 'struct GNUNET_FS_Handle*'
2828 deserialization_master (const char *master_path, GNUNET_FileNameCallback proc,
2829 struct GNUNET_FS_Handle *h)
2833 dn = get_serialization_file_name (h, master_path, "");
2836 if (GNUNET_YES == GNUNET_DISK_directory_test (dn))
2837 GNUNET_DISK_directory_scan (dn, proc, h);
2843 * Setup a connection to the file-sharing service.
2845 * @param cfg configuration to use
2846 * @param client_name unique identifier for this client
2847 * @param upcb function to call to notify about FS actions
2848 * @param upcb_cls closure for upcb
2849 * @param flags specific attributes for fs-operations
2850 * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
2851 * @return NULL on error
2853 struct GNUNET_FS_Handle *
2854 GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
2855 const char *client_name, GNUNET_FS_ProgressCallback upcb,
2856 void *upcb_cls, enum GNUNET_FS_Flags flags, ...)
2858 struct GNUNET_FS_Handle *ret;
2859 enum GNUNET_FS_OPTIONS opt;
2862 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Handle));
2864 ret->client_name = GNUNET_strdup (client_name);
2866 ret->upcb_cls = upcb_cls;
2868 ret->max_parallel_downloads = DEFAULT_MAX_PARALLEL_DOWNLOADS;
2869 ret->max_parallel_requests = DEFAULT_MAX_PARALLEL_REQUESTS;
2870 ret->avg_block_latency = GNUNET_TIME_UNIT_MINUTES; /* conservative starting point */
2871 va_start (ap, flags);
2872 while (GNUNET_FS_OPTIONS_END != (opt = va_arg (ap, enum GNUNET_FS_OPTIONS)))
2876 case GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM:
2877 ret->max_parallel_downloads = va_arg (ap, unsigned int);
2880 case GNUNET_FS_OPTIONS_REQUEST_PARALLELISM:
2881 ret->max_parallel_requests = va_arg (ap, unsigned int);
2886 GNUNET_free (ret->client_name);
2893 if (0 != (GNUNET_FS_FLAGS_PERSISTENCE & flags))
2895 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
2896 &deserialize_publish_file, ret);
2897 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
2898 &deserialize_search_file, ret);
2899 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
2900 &deserialize_download_file, ret);
2901 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2902 &deserialize_unindex_file, ret);
2909 * Close our connection with the file-sharing service.
2910 * The callback given to GNUNET_FS_start will no longer be
2911 * called after this function returns.
2913 * @param h handle that was returned from GNUNET_FS_start
2916 GNUNET_FS_stop (struct GNUNET_FS_Handle *h)
2918 while (h->top_head != NULL)
2919 h->top_head->ssf (h->top_head->ssf_cls);
2920 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
2921 GNUNET_SCHEDULER_cancel (h->queue_job);
2922 GNUNET_free (h->client_name);