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"
35 * Start the given job (send signal, remove from pending queue, update
36 * counters and state).
38 * @param qe job to start
41 start_job (struct GNUNET_FS_QueueEntry *qe)
43 GNUNET_assert (NULL == qe->client);
44 qe->client = GNUNET_CLIENT_connect ("fs", qe->h->cfg);
45 if (qe->client == NULL)
50 qe->start (qe->cls, qe->client);
52 qe->h->active_blocks += qe->blocks;
53 qe->start_time = GNUNET_TIME_absolute_get ();
54 GNUNET_CONTAINER_DLL_remove (qe->h->pending_head, qe->h->pending_tail, qe);
55 GNUNET_CONTAINER_DLL_insert_after (qe->h->running_head, qe->h->running_tail,
56 qe->h->running_tail, qe);
61 * Stop the given job (send signal, remove from active queue, update
62 * counters and state).
64 * @param qe job to stop
67 stop_job (struct GNUNET_FS_QueueEntry *qe)
71 qe->h->active_downloads--;
72 qe->h->active_blocks -= qe->blocks;
74 GNUNET_TIME_relative_add (qe->run_time,
75 GNUNET_TIME_absolute_get_duration
77 GNUNET_CONTAINER_DLL_remove (qe->h->running_head, qe->h->running_tail, qe);
78 GNUNET_CONTAINER_DLL_insert_after (qe->h->pending_head, qe->h->pending_tail,
79 qe->h->pending_tail, qe);
84 * Process the jobs in the job queue, possibly starting some
85 * and stopping others.
87 * @param cls the 'struct GNUNET_FS_Handle'
88 * @param tc scheduler context
91 process_job_queue (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
93 struct GNUNET_FS_Handle *h = cls;
94 struct GNUNET_FS_QueueEntry *qe;
95 struct GNUNET_FS_QueueEntry *next;
96 struct GNUNET_TIME_Relative run_time;
97 struct GNUNET_TIME_Relative restart_at;
98 struct GNUNET_TIME_Relative rst;
99 struct GNUNET_TIME_Absolute end_time;
101 h->queue_job = GNUNET_SCHEDULER_NO_TASK;
102 next = h->pending_head;
103 while (NULL != (qe = next))
106 if (h->running_head == NULL)
111 if ((qe->blocks + h->active_blocks <= h->max_parallel_requests) &&
112 (h->active_downloads + 1 <= h->max_parallel_downloads))
118 if (h->pending_head == NULL)
119 return; /* no need to stop anything */
120 restart_at = GNUNET_TIME_UNIT_FOREVER_REL;
121 next = h->running_head;
122 while (NULL != (qe = next))
126 GNUNET_TIME_relative_multiply (h->avg_block_latency,
127 qe->blocks * qe->start_times);
128 end_time = GNUNET_TIME_absolute_add (qe->start_time, run_time);
129 rst = GNUNET_TIME_absolute_get_remaining (end_time);
130 restart_at = GNUNET_TIME_relative_min (rst, restart_at);
131 if (rst.rel_value > 0)
136 GNUNET_SCHEDULER_add_delayed (restart_at, &process_job_queue, h);
141 * Add a job to the queue.
143 * @param h handle to the overall FS state
144 * @param start function to call to begin the job
145 * @param stop function to call to pause the job, or on dequeue (if the job was running)
146 * @param cls closure for start and stop
147 * @param blocks number of blocks this jobs uses
148 * @return queue handle
150 struct GNUNET_FS_QueueEntry *
151 GNUNET_FS_queue_ (struct GNUNET_FS_Handle *h, GNUNET_FS_QueueStart start,
152 GNUNET_FS_QueueStop stop, void *cls, unsigned int blocks)
154 struct GNUNET_FS_QueueEntry *qe;
156 qe = GNUNET_malloc (sizeof (struct GNUNET_FS_QueueEntry));
161 qe->queue_time = GNUNET_TIME_absolute_get ();
163 GNUNET_CONTAINER_DLL_insert_after (h->pending_head, h->pending_tail,
164 h->pending_tail, qe);
165 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
166 GNUNET_SCHEDULER_cancel (h->queue_job);
167 h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h);
173 * Dequeue a job from the queue.
174 * @param qh handle for the job
177 GNUNET_FS_dequeue_ (struct GNUNET_FS_QueueEntry *qh)
179 struct GNUNET_FS_Handle *h;
182 if (qh->client != NULL)
184 GNUNET_CONTAINER_DLL_remove (h->pending_head, h->pending_tail, qh);
186 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
187 GNUNET_SCHEDULER_cancel (h->queue_job);
188 h->queue_job = GNUNET_SCHEDULER_add_now (&process_job_queue, h);
193 * Create a top-level activity entry.
195 * @param h global fs handle
196 * @param ssf suspend signal function to use
197 * @param ssf_cls closure for ssf
198 * @return fresh top-level activity handle
200 struct TopLevelActivity *
201 GNUNET_FS_make_top (struct GNUNET_FS_Handle *h, SuspendSignalFunction ssf,
204 struct TopLevelActivity *ret;
206 ret = GNUNET_malloc (sizeof (struct TopLevelActivity));
208 ret->ssf_cls = ssf_cls;
209 GNUNET_CONTAINER_DLL_insert (h->top_head, h->top_tail, ret);
215 * Destroy a top-level activity entry.
217 * @param h global fs handle
218 * @param top top level activity entry
221 GNUNET_FS_end_top (struct GNUNET_FS_Handle *h, struct TopLevelActivity *top)
223 GNUNET_CONTAINER_DLL_remove (h->top_head, h->top_tail, top);
230 * Closure for "data_reader_file".
235 * Name of the file to read.
240 * File descriptor, NULL if it has not yet been opened.
242 struct GNUNET_DISK_FileHandle *fd;
247 * Function that provides data by reading from a file.
249 * @param cls closure (points to the file information)
250 * @param offset offset to read from; it is possible
251 * that the caller might need to go backwards
253 * @param max maximum number of bytes that should be
254 * copied to buf; readers are not allowed
255 * to provide less data unless there is an error;
256 * a value of "0" will be used at the end to allow
257 * the reader to clean up its internal state
258 * @param buf where the reader should write the data
259 * @param emsg location for the reader to store an error message
260 * @return number of bytes written, usually "max", 0 on error
263 GNUNET_FS_data_reader_file_ (void *cls, uint64_t offset, size_t max, void *buf,
266 struct FileInfo *fi = cls;
272 GNUNET_DISK_file_close (fi->fd);
273 GNUNET_free (fi->filename);
280 GNUNET_DISK_file_open (fi->filename, GNUNET_DISK_OPEN_READ,
281 GNUNET_DISK_PERM_NONE);
284 GNUNET_asprintf (emsg, _("Could not open file `%s': %s"), fi->filename,
289 GNUNET_DISK_file_seek (fi->fd, offset, GNUNET_DISK_SEEK_SET);
290 ret = GNUNET_DISK_file_read (fi->fd, buf, max);
293 GNUNET_asprintf (emsg, _("Could not read file `%s': %s"), fi->filename,
299 GNUNET_asprintf (emsg, _("Short read reading from file `%s'!"),
308 * Create the closure for the 'GNUNET_FS_data_reader_file_' callback.
310 * @param filename file to read
311 * @return closure to use, NULL on error
314 GNUNET_FS_make_file_reader_context_ (const char *filename)
318 fi = GNUNET_malloc (sizeof (struct FileInfo));
319 fi->filename = GNUNET_STRINGS_filename_expand (filename);
320 if (fi->filename == NULL)
330 * Function that provides data by copying from a buffer.
332 * @param cls closure (points to the buffer)
333 * @param offset offset to read from; it is possible
334 * that the caller might need to go backwards
336 * @param max maximum number of bytes that should be
337 * copied to buf; readers are not allowed
338 * to provide less data unless there is an error;
339 * a value of "0" will be used at the end to allow
340 * the reader to clean up its internal state
341 * @param buf where the reader should write the data
342 * @param emsg location for the reader to store an error message
343 * @return number of bytes written, usually "max", 0 on error
346 GNUNET_FS_data_reader_copy_ (void *cls, uint64_t offset, size_t max, void *buf,
353 GNUNET_free_non_null (data);
356 memcpy (buf, &data[offset], max);
362 * Return the full filename where we would store state information
363 * (for serialization/deserialization).
365 * @param h master context
366 * @param ext component of the path
367 * @param ent entity identifier (or emtpy string for the directory)
368 * @return NULL on error
371 get_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext,
377 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
378 return NULL; /* persistence not requested */
380 GNUNET_CONFIGURATION_get_value_filename (h->cfg, "fs", "STATE_DIR",
383 GNUNET_asprintf (&ret, "%s%s%s%s%s%s%s", basename, DIR_SEPARATOR_STR,
384 h->client_name, DIR_SEPARATOR_STR, ext, DIR_SEPARATOR_STR,
386 GNUNET_free (basename);
392 * Return the full filename where we would store state information
393 * (for serialization/deserialization) that is associated with a
396 * @param h master context
397 * @param ext component of the path
398 * @param uni name of the parent operation
399 * @param ent entity identifier (or emtpy string for the directory)
400 * @return NULL on error
403 get_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
404 const char *uni, const char *ent)
409 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
410 return NULL; /* persistence not requested */
412 GNUNET_CONFIGURATION_get_value_filename (h->cfg, "fs", "STATE_DIR",
415 GNUNET_asprintf (&ret, "%s%s%s%s%s%s%s.dir%s%s", basename, DIR_SEPARATOR_STR,
416 h->client_name, DIR_SEPARATOR_STR, ext, DIR_SEPARATOR_STR,
417 uni, DIR_SEPARATOR_STR, ent);
418 GNUNET_free (basename);
424 * Return a read handle for 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
431 static struct GNUNET_BIO_ReadHandle *
432 get_read_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
435 struct GNUNET_BIO_ReadHandle *ret;
437 fn = get_serialization_file_name (h, ext, ent);
440 ret = GNUNET_BIO_read_open (fn);
447 * Return a write handle for serialization.
449 * @param h master context
450 * @param ext component of the path
451 * @param ent entity identifier (or emtpy string for the directory)
452 * @return NULL on error
454 static struct GNUNET_BIO_WriteHandle *
455 get_write_handle (struct GNUNET_FS_Handle *h, const char *ext, const char *ent)
458 struct GNUNET_BIO_WriteHandle *ret;
460 fn = get_serialization_file_name (h, ext, ent);
465 ret = GNUNET_BIO_write_open (fn);
474 * Return a write handle for serialization.
476 * @param h master context
477 * @param ext component of the path
478 * @param uni name of parent
479 * @param ent entity identifier (or emtpy string for the directory)
480 * @return NULL on error
482 static struct GNUNET_BIO_WriteHandle *
483 get_write_handle_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
484 const char *uni, const char *ent)
487 struct GNUNET_BIO_WriteHandle *ret;
489 fn = get_serialization_file_name_in_dir (h, ext, uni, ent);
492 ret = GNUNET_BIO_write_open (fn);
499 * Remove serialization/deserialization file from disk.
501 * @param h master context
502 * @param ext component of the path
503 * @param ent entity identifier
506 GNUNET_FS_remove_sync_file_ (struct GNUNET_FS_Handle *h, const char *ext,
511 if ((NULL == ent) || (0 == strlen (ent)))
516 filename = get_serialization_file_name (h, ext, ent);
517 if (filename != NULL)
519 if (0 != UNLINK (filename))
520 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
521 GNUNET_free (filename);
527 * Remove serialization/deserialization file from disk.
529 * @param h master context
530 * @param ext component of the path
531 * @param uni parent name
532 * @param ent entity identifier
535 remove_sync_file_in_dir (struct GNUNET_FS_Handle *h, const char *ext,
536 const char *uni, const char *ent)
540 if ((NULL == ent) || (0 == strlen (ent)))
545 filename = get_serialization_file_name_in_dir (h, ext, uni, ent);
546 if (filename != NULL)
548 if (0 != UNLINK (filename))
549 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
550 GNUNET_free (filename);
556 * Remove serialization/deserialization directory from disk.
558 * @param h master context
559 * @param ext component of the path
560 * @param uni unique name of parent
563 GNUNET_FS_remove_sync_dir_ (struct GNUNET_FS_Handle *h, const char *ext,
570 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
573 if ((GNUNET_OK == GNUNET_DISK_directory_test (dn)) &&
574 (GNUNET_OK != GNUNET_DISK_directory_remove (dn)))
575 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "rmdir", dn);
581 * Serialize a 'start_time'. Since we use start-times to
582 * calculate the duration of some operation, we actually
583 * do not serialize the absolute time but the (relative)
584 * duration since the start time. When we then
585 * deserialize the start time, we take the current time and
586 * subtract that duration so that we get again an absolute
587 * time stamp that will result in correct performance
590 * @param wh handle for writing
591 * @param timestamp time to serialize
592 * @return GNUNET_OK on success
595 write_start_time (struct GNUNET_BIO_WriteHandle *wh,
596 struct GNUNET_TIME_Absolute timestamp)
598 struct GNUNET_TIME_Relative dur;
600 dur = GNUNET_TIME_absolute_get_duration (timestamp);
601 return GNUNET_BIO_write_int64 (wh, dur.rel_value);
606 * Serialize a 'start_time'. Since we use start-times to
607 * calculate the duration of some operation, we actually
608 * do not serialize the absolute time but the (relative)
609 * duration since the start time. When we then
610 * deserialize the start time, we take the current time and
611 * subtract that duration so that we get again an absolute
612 * time stamp that will result in correct performance
615 * @param rh handle for reading
616 * @param timestamp where to write the deserialized timestamp
617 * @return GNUNET_OK on success
620 read_start_time (struct GNUNET_BIO_ReadHandle *rh,
621 struct GNUNET_TIME_Absolute *timestamp)
623 struct GNUNET_TIME_Relative dur;
625 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dur.rel_value))
626 return GNUNET_SYSERR;
627 *timestamp = GNUNET_TIME_absolute_subtract (GNUNET_TIME_absolute_get (), dur);
633 * Using the given serialization filename, try to deserialize
634 * the file-information tree associated with it.
636 * @param h master context
637 * @param filename name of the file (without directory) with
639 * @return NULL on error
641 static struct GNUNET_FS_FileInformation *
642 deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename);
646 * Using the given serialization filename, try to deserialize
647 * the file-information tree associated with it.
649 * @param h master context
650 * @param fn name of the file (without directory) with
652 * @param rh handle for reading
653 * @return NULL on error
655 static struct GNUNET_FS_FileInformation *
656 deserialize_fi_node (struct GNUNET_FS_Handle *h, const char *fn,
657 struct GNUNET_BIO_ReadHandle *rh)
659 struct GNUNET_FS_FileInformation *ret;
660 struct GNUNET_FS_FileInformation *nxt;
667 if (GNUNET_OK != GNUNET_BIO_read (rh, "status flag", &b, sizeof (b)))
672 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_FileInformation));
677 if ((GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "metadata", &ret->meta)) ||
678 (GNUNET_OK != GNUNET_BIO_read_string (rh, "ksk-uri", &ksks, 32 * 1024)) ||
680 (NULL == (ret->keywords = GNUNET_FS_uri_parse (ksks, NULL)))) ||
681 (GNUNET_YES != GNUNET_FS_uri_test_ksk (ret->keywords)) ||
682 (GNUNET_OK != GNUNET_BIO_read_string (rh, "chk-uri", &chks, 1024)) ||
684 ((NULL == (ret->chk_uri = GNUNET_FS_uri_parse (chks, NULL))) ||
685 (GNUNET_YES != GNUNET_FS_uri_test_chk (ret->chk_uri)))) ||
686 (GNUNET_OK != read_start_time (rh, &ret->start_time)) ||
687 (GNUNET_OK != GNUNET_BIO_read_string (rh, "emsg", &ret->emsg, 16 * 1024))
689 GNUNET_BIO_read_string (rh, "fn", &ret->filename, 16 * 1024)) ||
691 GNUNET_BIO_read_int64 (rh, &ret->bo.expiration_time.abs_value)) ||
692 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.anonymity_level)) ||
693 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.content_priority)) ||
694 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &ret->bo.replication_level)))
701 case 0: /* file-insert */
702 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
707 ret->is_directory = GNUNET_NO;
708 ret->data.file.do_index = GNUNET_NO;
709 ret->data.file.have_hash = GNUNET_NO;
710 ret->data.file.index_start_confirmed = GNUNET_NO;
711 if (GNUNET_NO == ret->is_published)
713 if (NULL == ret->filename)
715 ret->data.file.reader = &GNUNET_FS_data_reader_copy_;
716 ret->data.file.reader_cls =
717 GNUNET_malloc_large (ret->data.file.file_size);
718 if (ret->data.file.reader_cls == NULL)
721 GNUNET_BIO_read (rh, "file-data", ret->data.file.reader_cls,
722 ret->data.file.file_size))
730 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
731 ret->data.file.reader_cls =
732 GNUNET_FS_make_file_reader_context_ (ret->filename);
736 case 1: /* file-index, no hash */
737 if (NULL == ret->filename)
742 if (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size))
747 ret->is_directory = GNUNET_NO;
748 ret->data.file.do_index = GNUNET_YES;
749 ret->data.file.have_hash = GNUNET_NO;
750 ret->data.file.index_start_confirmed = GNUNET_NO;
751 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
752 ret->data.file.reader_cls =
753 GNUNET_FS_make_file_reader_context_ (ret->filename);
755 case 2: /* file-index-with-hash */
756 if (NULL == ret->filename)
761 if ((GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
763 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id,
764 sizeof (GNUNET_HashCode))))
769 ret->is_directory = GNUNET_NO;
770 ret->data.file.do_index = GNUNET_YES;
771 ret->data.file.have_hash = GNUNET_YES;
772 ret->data.file.index_start_confirmed = GNUNET_NO;
773 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
774 ret->data.file.reader_cls =
775 GNUNET_FS_make_file_reader_context_ (ret->filename);
777 case 3: /* file-index-with-hash-confirmed */
778 if (NULL == ret->filename)
783 if ((GNUNET_OK != GNUNET_BIO_read_int64 (rh, &ret->data.file.file_size)) ||
785 GNUNET_BIO_read (rh, "fileid", &ret->data.file.file_id,
786 sizeof (GNUNET_HashCode))))
791 ret->is_directory = GNUNET_NO;
792 ret->data.file.do_index = GNUNET_YES;
793 ret->data.file.have_hash = GNUNET_YES;
794 ret->data.file.index_start_confirmed = GNUNET_YES;
795 ret->data.file.reader = &GNUNET_FS_data_reader_file_;
796 ret->data.file.reader_cls =
797 GNUNET_FS_make_file_reader_context_ (ret->filename);
799 case 4: /* directory */
800 ret->is_directory = GNUNET_YES;
801 if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dsize)) ||
802 (NULL == (ret->data.dir.dir_data = GNUNET_malloc_large (dsize))) ||
804 GNUNET_BIO_read (rh, "dir-data", ret->data.dir.dir_data, dsize)) ||
806 GNUNET_BIO_read_string (rh, "ent-filename", &filename, 16 * 1024)))
811 ret->data.dir.dir_size = (uint32_t) dsize;
812 if (filename != NULL)
814 ret->data.dir.entries = deserialize_file_information (h, filename);
815 GNUNET_free (filename);
817 nxt = ret->data.dir.entries;
829 ret->serialization = GNUNET_strdup (fn);
831 GNUNET_BIO_read_string (rh, "nxt-filename", &filename, 16 * 1024))
836 if (filename != NULL)
838 ret->next = deserialize_file_information (h, filename);
839 GNUNET_free (filename);
842 GNUNET_free_non_null (ksks);
843 GNUNET_free_non_null (chks);
846 GNUNET_free_non_null (ksks);
847 GNUNET_free_non_null (chks);
848 GNUNET_free_non_null (filename);
849 GNUNET_FS_file_information_destroy (ret, NULL, NULL);
855 * Using the given serialization filename, try to deserialize
856 * the file-information tree associated with it.
858 * @param h master context
859 * @param filename name of the file (without directory) with
861 * @return NULL on error
863 static struct GNUNET_FS_FileInformation *
864 deserialize_file_information (struct GNUNET_FS_Handle *h, const char *filename)
866 struct GNUNET_FS_FileInformation *ret;
867 struct GNUNET_BIO_ReadHandle *rh;
870 rh = get_read_handle (h, GNUNET_FS_SYNC_PATH_FILE_INFO, filename);
873 ret = deserialize_fi_node (h, filename, rh);
874 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
876 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
877 _("Failed to resume publishing information `%s': %s\n"),
883 if (0 != UNLINK (filename))
884 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
891 * Given a serialization name (full absolute path), return the
892 * basename of the file (without the path), which must only
893 * consist of the 6 random characters.
895 * @param fullname name to extract the basename from
896 * @return copy of the basename, NULL on error
899 get_serialization_short_name (const char *fullname)
906 /* FIXME: we could do this faster since we know
907 * the length of 'end'... */
910 if (DIR_SEPARATOR == *nxt)
914 if ((end == NULL) || (strlen (end) == 0))
919 GNUNET_break (6 == strlen (end));
920 return GNUNET_strdup (end);
925 * Create a new random name for serialization. Also checks if persistence
926 * is enabled and returns NULL if not.
928 * @param h master context
929 * @param ext component of the path
930 * @return NULL on errror
933 make_serialization_file_name (struct GNUNET_FS_Handle *h, const char *ext)
939 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
940 return NULL; /* persistence not requested */
941 dn = get_serialization_file_name (h, ext, "");
944 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
949 fn = GNUNET_DISK_mktemp (dn);
952 return NULL; /* epic fail */
953 ret = get_serialization_short_name (fn);
960 * Create a new random name for serialization. Also checks if persistence
961 * is enabled and returns NULL if not.
963 * @param h master context
964 * @param ext component of the path
965 * @param uni name of parent
966 * @return NULL on errror
969 make_serialization_file_name_in_dir (struct GNUNET_FS_Handle *h,
970 const char *ext, const char *uni)
976 if (0 == (h->flags & GNUNET_FS_FLAGS_PERSISTENCE))
977 return NULL; /* persistence not requested */
978 dn = get_serialization_file_name_in_dir (h, ext, uni, "");
981 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dn))
986 fn = GNUNET_DISK_mktemp (dn);
989 return NULL; /* epic fail */
990 ret = get_serialization_short_name (fn);
997 * Copy all of the data from the reader to the write handle.
999 * @param wh write handle
1000 * @param fi file with reader
1001 * @return GNUNET_OK on success
1004 copy_from_reader (struct GNUNET_BIO_WriteHandle *wh,
1005 struct GNUNET_FS_FileInformation *fi)
1007 char buf[32 * 1024];
1015 while (off < fi->data.file.file_size)
1017 left = GNUNET_MIN (sizeof (buf), fi->data.file.file_size - off);
1019 fi->data.file.reader (fi->data.file.reader_cls, off, left, buf, &emsg);
1023 return GNUNET_SYSERR;
1025 if (GNUNET_OK != GNUNET_BIO_write (wh, buf, ret))
1026 return GNUNET_SYSERR;
1034 * Create a temporary file on disk to store the current
1037 * @param fi file information to sync with disk
1040 GNUNET_FS_file_information_sync_ (struct GNUNET_FS_FileInformation *fi)
1043 struct GNUNET_BIO_WriteHandle *wh;
1048 if (NULL == fi->serialization)
1050 make_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO);
1051 if (NULL == fi->serialization)
1053 wh = get_write_handle (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1057 GNUNET_free (fi->serialization);
1058 fi->serialization = NULL;
1061 if (GNUNET_YES == fi->is_directory)
1063 else if (GNUNET_YES == fi->data.file.index_start_confirmed)
1065 else if (GNUNET_YES == fi->data.file.have_hash)
1067 else if (GNUNET_YES == fi->data.file.do_index)
1071 if (fi->keywords != NULL)
1072 ksks = GNUNET_FS_uri_to_string (fi->keywords);
1075 if (fi->chk_uri != NULL)
1076 chks = GNUNET_FS_uri_to_string (fi->chk_uri);
1079 if ((GNUNET_OK != GNUNET_BIO_write (wh, &b, sizeof (b))) ||
1080 (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, fi->meta)) ||
1081 (GNUNET_OK != GNUNET_BIO_write_string (wh, ksks)) ||
1082 (GNUNET_OK != GNUNET_BIO_write_string (wh, chks)) ||
1083 (GNUNET_OK != write_start_time (wh, fi->start_time)) ||
1084 (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->emsg)) ||
1085 (GNUNET_OK != GNUNET_BIO_write_string (wh, fi->filename)) ||
1087 GNUNET_BIO_write_int64 (wh, fi->bo.expiration_time.abs_value)) ||
1088 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.anonymity_level)) ||
1089 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.content_priority)) ||
1090 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->bo.replication_level)))
1095 GNUNET_free_non_null (chks);
1097 GNUNET_free_non_null (ksks);
1102 case 0: /* file-insert */
1103 if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1108 if ((GNUNET_NO == fi->is_published) && (NULL == fi->filename))
1109 if (GNUNET_OK != copy_from_reader (wh, fi))
1115 case 1: /* file-index, no hash */
1116 if (NULL == fi->filename)
1121 if (GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size))
1127 case 2: /* file-index-with-hash */
1128 case 3: /* file-index-with-hash-confirmed */
1129 if (NULL == fi->filename)
1134 if ((GNUNET_OK != GNUNET_BIO_write_int64 (wh, fi->data.file.file_size)) ||
1136 GNUNET_BIO_write (wh, &fi->data.file.file_id,
1137 sizeof (GNUNET_HashCode))))
1143 case 4: /* directory */
1144 if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, fi->data.dir.dir_size)) ||
1146 GNUNET_BIO_write (wh, fi->data.dir.dir_data,
1147 (uint32_t) fi->data.dir.dir_size)) ||
1149 GNUNET_BIO_write_string (wh,
1150 (fi->data.dir.entries ==
1151 NULL) ? NULL : fi->data.dir.
1152 entries->serialization)))
1163 GNUNET_BIO_write_string (wh,
1165 NULL) ? fi->next->serialization : NULL))
1170 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1179 (void) GNUNET_BIO_write_close (wh);
1180 GNUNET_free_non_null (chks);
1181 GNUNET_free_non_null (ksks);
1182 fn = get_serialization_file_name (fi->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1186 if (0 != UNLINK (fn))
1187 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1190 GNUNET_free (fi->serialization);
1191 fi->serialization = NULL;
1197 * Find the entry in the file information struct where the
1198 * serialization filename matches the given name.
1200 * @param pos file information to search
1201 * @param srch filename to search for
1202 * @return NULL if srch was not found in this subtree
1204 static struct GNUNET_FS_FileInformation *
1205 find_file_position (struct GNUNET_FS_FileInformation *pos, const char *srch)
1207 struct GNUNET_FS_FileInformation *r;
1211 if (0 == strcmp (srch, pos->serialization))
1213 if (pos->is_directory)
1215 r = find_file_position (pos->data.dir.entries, srch);
1226 * Signal the FS's progress function that we are resuming
1229 * @param cls closure (of type "struct GNUNET_FS_PublishContext*")
1230 * @param fi the entry in the publish-structure
1231 * @param length length of the file or directory
1232 * @param meta metadata for the file or directory (can be modified)
1233 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1234 * @param bo block options (can be modified)
1235 * @param do_index should we index?
1236 * @param client_info pointer to client context set upon creation (can be modified)
1237 * @return GNUNET_OK to continue (always)
1240 fip_signal_resume (void *cls, struct GNUNET_FS_FileInformation *fi,
1241 uint64_t length, struct GNUNET_CONTAINER_MetaData *meta,
1242 struct GNUNET_FS_Uri **uri,
1243 struct GNUNET_FS_BlockOptions *bo, int *do_index,
1246 struct GNUNET_FS_PublishContext *sc = cls;
1247 struct GNUNET_FS_ProgressInfo pi;
1249 pi.status = GNUNET_FS_STATUS_PUBLISH_RESUME;
1250 pi.value.publish.specifics.resume.message = sc->fi->emsg;
1251 pi.value.publish.specifics.resume.chk_uri = sc->fi->chk_uri;
1252 *client_info = GNUNET_FS_publish_make_status_ (&pi, sc, fi, 0);
1258 * Function called with a filename of serialized publishing operation
1261 * @param cls the 'struct GNUNET_FS_Handle*'
1262 * @param filename complete filename (absolute path)
1263 * @return GNUNET_OK (continue to iterate)
1266 deserialize_publish_file (void *cls, const char *filename)
1268 struct GNUNET_FS_Handle *h = cls;
1269 struct GNUNET_BIO_ReadHandle *rh;
1270 struct GNUNET_FS_PublishContext *pc;
1278 pc = GNUNET_malloc (sizeof (struct GNUNET_FS_PublishContext));
1280 pc->serialization = get_serialization_short_name (filename);
1284 rh = GNUNET_BIO_read_open (filename);
1290 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-nid", &pc->nid, 1024))
1292 GNUNET_BIO_read_string (rh, "publish-nuid", &pc->nuid, 1024)) ||
1293 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
1294 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &all_done)) ||
1296 GNUNET_BIO_read_string (rh, "publish-firoot", &fi_root, 128)) ||
1297 (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-fipos", &fi_pos, 128))
1298 || (GNUNET_OK != GNUNET_BIO_read_string (rh, "publish-ns", &ns, 1024)))
1303 pc->options = options;
1304 pc->all_done = all_done;
1305 if (NULL == fi_root)
1310 pc->fi = deserialize_file_information (h, fi_root);
1318 pc->namespace = GNUNET_FS_namespace_create (h, ns);
1319 if (pc->namespace == NULL)
1321 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1323 ("Failed to recover namespace `%s', cannot resume publishing operation.\n"),
1328 if ((0 == (pc->options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY)) &&
1329 (GNUNET_YES != pc->all_done))
1331 pc->dsh = GNUNET_DATASTORE_connect (h->cfg);
1332 if (NULL == pc->dsh)
1337 pc->fi_pos = find_file_position (pc->fi, fi_pos);
1338 GNUNET_free (fi_pos);
1340 if (pc->fi_pos == NULL)
1342 /* failed to find position for resuming, outch! Will start from root! */
1344 if (pc->all_done != GNUNET_YES)
1345 pc->fi_pos = pc->fi;
1348 GNUNET_free (fi_root);
1350 /* generate RESUME event(s) */
1351 GNUNET_FS_file_information_inspect (pc->fi, &fip_signal_resume, pc);
1353 /* re-start publishing (if needed)... */
1354 if (pc->all_done != GNUNET_YES)
1356 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
1358 GNUNET_SCHEDULER_add_with_priority
1359 (GNUNET_SCHEDULER_PRIORITY_BACKGROUND, &GNUNET_FS_publish_main_, pc);
1361 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1363 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1364 _("Failure while resuming publishing operation `%s': %s\n"),
1368 GNUNET_free_non_null (ns);
1369 pc->top = GNUNET_FS_make_top (h, &GNUNET_FS_publish_signal_suspend_, pc);
1372 GNUNET_free_non_null (pc->nid);
1373 GNUNET_free_non_null (pc->nuid);
1374 GNUNET_free_non_null (fi_root);
1375 GNUNET_free_non_null (fi_pos);
1376 GNUNET_free_non_null (ns);
1377 if ((rh != NULL) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
1379 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1380 _("Failed to resume publishing operation `%s': %s\n"), filename,
1385 GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
1386 if (0 != UNLINK (filename))
1387 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
1388 GNUNET_free (pc->serialization);
1395 * Synchronize this publishing struct with its mirror
1396 * on disk. Note that all internal FS-operations that change
1397 * publishing structs should already call "sync" internally,
1398 * so this function is likely not useful for clients.
1400 * @param pc the struct to sync
1403 GNUNET_FS_publish_sync_ (struct GNUNET_FS_PublishContext *pc)
1405 struct GNUNET_BIO_WriteHandle *wh;
1407 if (NULL == pc->serialization)
1409 make_serialization_file_name (pc->h,
1410 GNUNET_FS_SYNC_PATH_MASTER_PUBLISH);
1411 if (NULL == pc->serialization)
1415 if (NULL == pc->fi->serialization)
1420 wh = get_write_handle (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1427 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nid)) ||
1428 (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->nuid)) ||
1429 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->options)) ||
1430 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pc->all_done)) ||
1431 (GNUNET_OK != GNUNET_BIO_write_string (wh, pc->fi->serialization)) ||
1433 GNUNET_BIO_write_string (wh,
1435 NULL) ? NULL : pc->fi_pos->serialization)) ||
1437 GNUNET_BIO_write_string (wh,
1439 NULL) ? NULL : pc->namespace->name)))
1444 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1453 (void) GNUNET_BIO_write_close (wh);
1454 GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1456 GNUNET_free (pc->serialization);
1457 pc->serialization = NULL;
1462 * Synchronize this unindex struct with its mirror
1463 * on disk. Note that all internal FS-operations that change
1464 * publishing structs should already call "sync" internally,
1465 * so this function is likely not useful for clients.
1467 * @param uc the struct to sync
1470 GNUNET_FS_unindex_sync_ (struct GNUNET_FS_UnindexContext *uc)
1472 struct GNUNET_BIO_WriteHandle *wh;
1474 if (NULL == uc->serialization)
1476 make_serialization_file_name (uc->h,
1477 GNUNET_FS_SYNC_PATH_MASTER_UNINDEX);
1478 if (NULL == uc->serialization)
1480 wh = get_write_handle (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1487 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uc->filename)) ||
1488 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, uc->file_size)) ||
1489 (GNUNET_OK != write_start_time (wh, uc->start_time)) ||
1490 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) uc->state)) ||
1491 ((uc->state == UNINDEX_STATE_FS_NOTIFY) &&
1493 GNUNET_BIO_write (wh, &uc->file_id, sizeof (GNUNET_HashCode)))) ||
1494 ((uc->state == UNINDEX_STATE_ERROR) &&
1495 (GNUNET_OK != GNUNET_BIO_write_string (wh, uc->emsg))))
1500 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1509 (void) GNUNET_BIO_write_close (wh);
1510 GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
1512 GNUNET_free (uc->serialization);
1513 uc->serialization = NULL;
1518 * Serialize a download request.
1520 * @param wh the 'struct GNUNET_BIO_WriteHandle*'
1521 * @param dr the 'struct DownloadRequest'
1522 * @return GNUNET_YES on success, GNUNET_NO on error
1525 write_download_request (struct GNUNET_BIO_WriteHandle *wh,
1526 struct DownloadRequest *dr)
1530 if ((GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->state)) ||
1531 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dr->offset)) ||
1532 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->num_children)) ||
1533 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dr->depth)))
1535 if ((dr->state == BRS_CHK_SET) &&
1537 GNUNET_BIO_write (wh, &dr->chk, sizeof (struct ContentHashKey))))
1539 for (i = 0; i < dr->num_children; i++)
1540 if (GNUNET_NO == write_download_request (wh, dr->children[i]))
1547 * Read a download request tree.
1549 * @param rh stream to read from
1550 * @return value the 'struct DownloadRequest', NULL on error
1552 static struct DownloadRequest *
1553 read_download_request (struct GNUNET_BIO_ReadHandle *rh)
1555 struct DownloadRequest *dr;
1558 dr = GNUNET_malloc (sizeof (struct DownloadRequest));
1560 if ((GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->state)) ||
1561 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dr->offset)) ||
1562 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->num_children)) ||
1563 (dr->num_children > CHK_PER_INODE) ||
1564 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dr->depth)) || ((dr->depth == 0)
1568 ((dr->depth > 0) && (dr->num_children == 0)))
1571 dr->num_children = 0;
1574 if (dr->num_children > 0)
1576 GNUNET_malloc (dr->num_children * sizeof (struct ContentHashKey));
1580 case BRS_RECONSTRUCT_DOWN:
1581 case BRS_RECONSTRUCT_META_UP:
1582 case BRS_RECONSTRUCT_UP:
1586 GNUNET_BIO_read (rh, "chk", &dr->chk, sizeof (struct ContentHashKey)))
1589 case BRS_DOWNLOAD_DOWN:
1590 case BRS_DOWNLOAD_UP:
1597 for (i = 0; i < dr->num_children; i++)
1599 if (NULL == (dr->children[i] = read_download_request (rh)))
1601 dr->children[i]->parent = dr;
1605 GNUNET_FS_free_download_request_ (dr);
1611 * Compute the name of the sync file (or directory) for the given download
1614 * @param dc download context to compute for
1615 * @param uni unique filename to use, use "" for the directory name
1616 * @param ext extension to use, use ".dir" for our own subdirectory
1617 * @return the expanded file name, NULL for none
1620 get_download_sync_filename (struct GNUNET_FS_DownloadContext *dc,
1621 const char *uni, const char *ext)
1626 if (dc->parent == NULL)
1627 return get_serialization_file_name (dc->h,
1630 GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD :
1631 GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
1633 if (dc->parent->serialization == NULL)
1635 par = get_download_sync_filename (dc->parent, dc->parent->serialization, "");
1638 GNUNET_asprintf (&epar, "%s.dir%s%s%s", par, DIR_SEPARATOR_STR, uni, ext);
1645 * Synchronize this download struct with its mirror
1646 * on disk. Note that all internal FS-operations that change
1647 * publishing structs should already call "sync" internally,
1648 * so this function is likely not useful for clients.
1650 * @param dc the struct to sync
1653 GNUNET_FS_download_sync_ (struct GNUNET_FS_DownloadContext *dc)
1655 struct GNUNET_BIO_WriteHandle *wh;
1660 if (NULL == dc->serialization)
1662 dir = get_download_sync_filename (dc, "", "");
1665 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (dir))
1670 fn = GNUNET_DISK_mktemp (dir);
1674 dc->serialization = get_serialization_short_name (fn);
1678 fn = get_download_sync_filename (dc, dc->serialization, "");
1681 GNUNET_free (dc->serialization);
1682 dc->serialization = NULL;
1687 wh = GNUNET_BIO_write_open (fn);
1690 GNUNET_free (dc->serialization);
1691 dc->serialization = NULL;
1695 GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_chk (dc->uri)) ||
1696 (GNUNET_YES == GNUNET_FS_uri_test_loc (dc->uri)));
1697 uris = GNUNET_FS_uri_to_string (dc->uri);
1698 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1699 (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, dc->meta)) ||
1700 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->emsg)) ||
1701 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->filename)) ||
1702 (GNUNET_OK != GNUNET_BIO_write_string (wh, dc->temp_filename)) ||
1703 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->old_file_size)) ||
1704 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->offset)) ||
1705 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->length)) ||
1706 (GNUNET_OK != GNUNET_BIO_write_int64 (wh, dc->completed)) ||
1707 (GNUNET_OK != write_start_time (wh, dc->start_time)) ||
1708 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, dc->anonymity)) ||
1709 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->options)) ||
1710 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) dc->has_finished)))
1715 if (NULL == dc->emsg)
1717 GNUNET_assert (dc->top_request != NULL);
1718 if (GNUNET_YES != write_download_request (wh, dc->top_request))
1724 GNUNET_free_non_null (uris);
1726 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1736 (void) GNUNET_BIO_write_close (wh);
1737 GNUNET_free_non_null (uris);
1738 if (0 != UNLINK (fn))
1739 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1741 GNUNET_free (dc->serialization);
1742 dc->serialization = NULL;
1747 * Synchronize this search result with its mirror
1748 * on disk. Note that all internal FS-operations that change
1749 * publishing structs should already call "sync" internally,
1750 * so this function is likely not useful for clients.
1752 * @param sr the struct to sync
1755 GNUNET_FS_search_result_sync_ (struct GNUNET_FS_SearchResult *sr)
1757 struct GNUNET_BIO_WriteHandle *wh;
1761 if (NULL == sr->serialization)
1763 make_serialization_file_name_in_dir (sr->sc->h,
1764 (sr->sc->psearch_result ==
1766 GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1767 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1768 sr->sc->serialization);
1769 if (NULL == sr->serialization)
1771 wh = get_write_handle_in_dir (sr->sc->h,
1772 (sr->sc->psearch_result ==
1773 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1774 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1775 sr->sc->serialization, sr->serialization);
1781 uris = GNUNET_FS_uri_to_string (sr->uri);
1782 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1784 GNUNET_BIO_write_string (wh,
1786 NULL ? sr->download->serialization : NULL)) ||
1788 GNUNET_BIO_write_string (wh,
1789 sr->update_search !=
1790 NULL ? sr->update_search->serialization : NULL))
1791 || (GNUNET_OK != GNUNET_BIO_write_meta_data (wh, sr->meta)) ||
1792 (GNUNET_OK != GNUNET_BIO_write (wh, &sr->key, sizeof (GNUNET_HashCode)))
1793 || (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->mandatory_missing)) ||
1794 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->optional_support)) ||
1795 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_success)) ||
1796 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sr->availability_trials)) ||
1797 (GNUNET_OK != GNUNET_BIO_write (wh, sr->keyword_bitmap,
1798 (sr->uri == NULL) ? 0 : (sr->uri->data.ksk.keywordCount + 7) / 8)) )
1804 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1810 GNUNET_free_non_null (uris);
1813 GNUNET_free_non_null (uris);
1815 (void) GNUNET_BIO_write_close (wh);
1816 remove_sync_file_in_dir (sr->sc->h,
1817 (sr->sc->psearch_result ==
1818 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1819 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
1820 sr->sc->serialization, sr->serialization);
1821 GNUNET_free (sr->serialization);
1822 sr->serialization = NULL;
1827 * Synchronize this search struct with its mirror
1828 * on disk. Note that all internal FS-operations that change
1829 * publishing structs should already call "sync" internally,
1830 * so this function is likely not useful for clients.
1832 * @param sc the struct to sync
1835 GNUNET_FS_search_sync_ (struct GNUNET_FS_SearchContext *sc)
1837 struct GNUNET_BIO_WriteHandle *wh;
1840 const char *category;
1843 (sc->psearch_result ==
1844 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
1845 GNUNET_FS_SYNC_PATH_CHILD_SEARCH;
1846 if (NULL == sc->serialization)
1847 sc->serialization = make_serialization_file_name (sc->h, category);
1848 if (NULL == sc->serialization)
1851 wh = get_write_handle (sc->h, category, sc->serialization);
1857 GNUNET_assert ((GNUNET_YES == GNUNET_FS_uri_test_ksk (sc->uri)) ||
1858 (GNUNET_YES == GNUNET_FS_uri_test_sks (sc->uri)));
1859 uris = GNUNET_FS_uri_to_string (sc->uri);
1860 in_pause = (sc->task != GNUNET_SCHEDULER_NO_TASK) ? 'r' : '\0';
1861 if ((GNUNET_OK != GNUNET_BIO_write_string (wh, uris)) ||
1862 (GNUNET_OK != write_start_time (wh, sc->start_time)) ||
1863 (GNUNET_OK != GNUNET_BIO_write_string (wh, sc->emsg)) ||
1864 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, (uint32_t) sc->options)) ||
1865 (GNUNET_OK != GNUNET_BIO_write (wh, &in_pause, sizeof (in_pause))) ||
1866 (GNUNET_OK != GNUNET_BIO_write_int32 (wh, sc->anonymity)))
1873 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
1882 (void) GNUNET_BIO_write_close (wh);
1883 GNUNET_free_non_null (uris);
1884 GNUNET_FS_remove_sync_file_ (sc->h, category, sc->serialization);
1885 GNUNET_free (sc->serialization);
1886 sc->serialization = NULL;
1891 * Function called with a filename of serialized unindexing operation
1894 * @param cls the 'struct GNUNET_FS_Handle*'
1895 * @param filename complete filename (absolute path)
1896 * @return GNUNET_OK (continue to iterate)
1899 deserialize_unindex_file (void *cls, const char *filename)
1901 struct GNUNET_FS_Handle *h = cls;
1902 struct GNUNET_BIO_ReadHandle *rh;
1903 struct GNUNET_FS_UnindexContext *uc;
1904 struct GNUNET_FS_ProgressInfo pi;
1908 uc = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
1910 uc->serialization = get_serialization_short_name (filename);
1911 rh = GNUNET_BIO_read_open (filename);
1918 GNUNET_BIO_read_string (rh, "unindex-fn", &uc->filename, 10 * 1024)) ||
1919 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &uc->file_size)) ||
1920 (GNUNET_OK != read_start_time (rh, &uc->start_time)) ||
1921 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &state)))
1926 uc->state = (enum UnindexState) state;
1929 case UNINDEX_STATE_HASHING:
1931 case UNINDEX_STATE_FS_NOTIFY:
1933 GNUNET_BIO_read (rh, "unindex-hash", &uc->file_id,
1934 sizeof (GNUNET_HashCode)))
1940 case UNINDEX_STATE_DS_REMOVE:
1942 case UNINDEX_STATE_COMPLETE:
1944 case UNINDEX_STATE_ERROR:
1946 GNUNET_BIO_read_string (rh, "unindex-emsg", &uc->emsg, 10 * 1024))
1956 uc->top = GNUNET_FS_make_top (h, &GNUNET_FS_unindex_signal_suspend_, uc);
1957 pi.status = GNUNET_FS_STATUS_UNINDEX_RESUME;
1958 pi.value.unindex.specifics.resume.message = uc->emsg;
1959 GNUNET_FS_unindex_make_status_ (&pi, uc,
1961 UNINDEX_STATE_COMPLETE) ? uc->file_size : 0);
1964 case UNINDEX_STATE_HASHING:
1966 GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, uc->filename,
1968 &GNUNET_FS_unindex_process_hash_, uc);
1970 case UNINDEX_STATE_FS_NOTIFY:
1971 uc->state = UNINDEX_STATE_HASHING;
1972 GNUNET_FS_unindex_process_hash_ (uc, &uc->file_id);
1974 case UNINDEX_STATE_DS_REMOVE:
1975 GNUNET_FS_unindex_do_remove_ (uc);
1977 case UNINDEX_STATE_COMPLETE:
1978 case UNINDEX_STATE_ERROR:
1979 /* no need to resume any operation, we were done */
1984 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
1986 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1987 _("Failure while resuming unindexing operation `%s': %s\n"),
1993 GNUNET_free_non_null (uc->filename);
1994 if ((rh != NULL) && (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg)))
1996 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1997 _("Failed to resume unindexing operation `%s': %s\n"), filename,
2001 if (uc->serialization != NULL)
2002 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2004 GNUNET_free_non_null (uc->serialization);
2011 * Deserialize a download.
2013 * @param h overall context
2014 * @param rh file to deserialize from
2015 * @param parent parent download
2016 * @param search associated search
2017 * @param serialization name under which the search was serialized
2020 deserialize_download (struct GNUNET_FS_Handle *h,
2021 struct GNUNET_BIO_ReadHandle *rh,
2022 struct GNUNET_FS_DownloadContext *parent,
2023 struct GNUNET_FS_SearchResult *search,
2024 const char *serialization);
2028 * Deserialize a search.
2030 * @param h overall context
2031 * @param rh file to deserialize from
2032 * @param psearch_result parent search result
2033 * @param serialization name under which the search was serialized
2035 static struct GNUNET_FS_SearchContext *
2036 deserialize_search (struct GNUNET_FS_Handle *h,
2037 struct GNUNET_BIO_ReadHandle *rh,
2038 struct GNUNET_FS_SearchResult *psearch_result,
2039 const char *serialization);
2043 * Function called with a filename of serialized search result
2046 * @param cls the 'struct GNUNET_FS_SearchContext*'
2047 * @param filename complete filename (absolute path)
2048 * @return GNUNET_OK (continue to iterate)
2051 deserialize_search_result (void *cls, const char *filename)
2053 struct GNUNET_FS_SearchContext *sc = cls;
2059 struct GNUNET_BIO_ReadHandle *rh;
2060 struct GNUNET_BIO_ReadHandle *drh;
2061 struct GNUNET_FS_SearchResult *sr;
2063 ser = get_serialization_short_name (filename);
2064 rh = GNUNET_BIO_read_open (filename);
2069 remove_sync_file_in_dir (sc->h,
2070 (sc->psearch_result ==
2071 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2072 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2073 sc->serialization, ser);
2082 sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
2084 sr->serialization = ser;
2085 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "result-uri", &uris, 10 * 1024))
2086 || (NULL == (sr->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2087 (GNUNET_OK != GNUNET_BIO_read_string (rh, "download-lnk", &download, 16))
2089 GNUNET_BIO_read_string (rh, "search-lnk", &update_srch, 16)) ||
2090 (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "result-meta", &sr->meta)) ||
2092 GNUNET_BIO_read (rh, "result-key", &sr->key, sizeof (GNUNET_HashCode)))
2093 || (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->mandatory_missing)) ||
2094 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->optional_support)) ||
2095 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_success)) ||
2096 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sr->availability_trials)))
2101 sr->keyword_bitmap = GNUNET_malloc ((sr->uri->data.ksk.keywordCount + 7) / 8); /* round up, count bits */
2102 if (GNUNET_OK != GNUNET_BIO_read (rh, "keyword-bitmap",
2104 (sr->uri == NULL) ? 0 : (sr->uri->data.ksk.keywordCount + 7) / 8))
2110 if (download != NULL)
2112 drh = get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD, download);
2115 deserialize_download (sc->h, drh, NULL, sr, download);
2116 if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2118 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2119 _("Failed to resume sub-download `%s': %s\n"), download,
2124 GNUNET_free (download);
2126 if (update_srch != NULL)
2129 get_read_handle (sc->h, GNUNET_FS_SYNC_PATH_CHILD_SEARCH, update_srch);
2132 deserialize_search (sc->h, drh, sr, update_srch);
2133 if (GNUNET_OK != GNUNET_BIO_read_close (drh, &emsg))
2135 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2136 _("Failed to resume sub-search `%s': %s\n"), update_srch,
2141 GNUNET_free (update_srch);
2143 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &sr->key, sr,
2144 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2145 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2147 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2148 _("Failure while resuming search operation `%s': %s\n"),
2154 GNUNET_free_non_null (download);
2155 GNUNET_free_non_null (emsg);
2156 GNUNET_free_non_null (uris);
2157 GNUNET_free_non_null (update_srch);
2158 if (sr->uri != NULL)
2159 GNUNET_FS_uri_destroy (sr->uri);
2160 if (sr->meta != NULL)
2161 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2162 GNUNET_free (sr->serialization);
2164 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2166 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2167 _("Failure while resuming search operation `%s': %s\n"),
2176 * Send the 'resume' signal to the callback; also actually
2177 * resume the download (put it in the queue). Does this
2178 * recursively for the top-level download and all child
2181 * @param dc download to resume
2184 signal_download_resume (struct GNUNET_FS_DownloadContext *dc)
2186 struct GNUNET_FS_DownloadContext *dcc;
2187 struct GNUNET_FS_ProgressInfo pi;
2189 pi.status = GNUNET_FS_STATUS_DOWNLOAD_RESUME;
2190 pi.value.download.specifics.resume.meta = dc->meta;
2191 pi.value.download.specifics.resume.message = dc->emsg;
2192 GNUNET_FS_download_make_status_ (&pi, dc);
2193 dcc = dc->child_head;
2196 signal_download_resume (dcc);
2199 if (dc->pending_head != NULL)
2200 GNUNET_FS_download_start_downloading_ (dc);
2205 * Signal resuming of a search to our clients (for the
2206 * top level search and all sub-searches).
2208 * @param sc search being resumed
2211 signal_search_resume (struct GNUNET_FS_SearchContext *sc);
2215 * Iterator over search results signaling resume to the client for
2218 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2219 * @param key current key code
2220 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2221 * @return GNUNET_YES (we should continue to iterate)
2224 signal_result_resume (void *cls, const GNUNET_HashCode * key, void *value)
2226 struct GNUNET_FS_SearchContext *sc = cls;
2227 struct GNUNET_FS_ProgressInfo pi;
2228 struct GNUNET_FS_SearchResult *sr = value;
2230 if (0 == sr->mandatory_missing)
2232 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME_RESULT;
2233 pi.value.search.specifics.resume_result.meta = sr->meta;
2234 pi.value.search.specifics.resume_result.uri = sr->uri;
2235 pi.value.search.specifics.resume_result.result = sr;
2236 pi.value.search.specifics.resume_result.availability_rank =
2237 2 * sr->availability_success - sr->availability_trials;
2238 pi.value.search.specifics.resume_result.availability_certainty =
2239 sr->availability_trials;
2240 pi.value.search.specifics.resume_result.applicability_rank =
2241 sr->optional_support;
2242 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
2244 if (sr->download != NULL)
2246 signal_download_resume (sr->download);
2250 GNUNET_FS_search_start_probe_ (sr);
2252 if (sr->update_search != NULL)
2253 signal_search_resume (sr->update_search);
2259 * Free memory allocated by the search context and its children
2261 * @param sc search context to free
2264 free_search_context (struct GNUNET_FS_SearchContext *sc);
2268 * Iterator over search results freeing each.
2270 * @param cls closure, the 'struct GNUNET_FS_SearchContext'
2271 * @param key current key code
2272 * @param value value in the hash map, the 'struct GNUNET_FS_SearchResult'
2273 * @return GNUNET_YES (we should continue to iterate)
2276 free_result (void *cls, const GNUNET_HashCode * key, void *value)
2278 struct GNUNET_FS_SearchResult *sr = value;
2280 if (sr->update_search != NULL)
2282 free_search_context (sr->update_search);
2283 GNUNET_assert (NULL == sr->update_search);
2285 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
2286 GNUNET_FS_uri_destroy (sr->uri);
2293 * Free memory allocated by the search context and its children
2295 * @param sc search context to free
2298 free_search_context (struct GNUNET_FS_SearchContext *sc)
2300 if (sc->serialization != NULL)
2302 GNUNET_FS_remove_sync_file_ (sc->h,
2303 (sc->psearch_result ==
2304 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2305 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2307 GNUNET_FS_remove_sync_dir_ (sc->h,
2308 (sc->psearch_result ==
2309 NULL) ? GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2310 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2313 GNUNET_free_non_null (sc->serialization);
2314 GNUNET_free_non_null (sc->emsg);
2315 if (sc->uri != NULL)
2316 GNUNET_FS_uri_destroy (sc->uri);
2317 if (sc->master_result_map != NULL)
2319 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map, &free_result,
2321 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
2328 * Function called with a filename of serialized sub-download
2331 * @param cls the 'struct GNUNET_FS_DownloadContext*' (parent)
2332 * @param filename complete filename (absolute path)
2333 * @return GNUNET_OK (continue to iterate)
2336 deserialize_subdownload (void *cls, const char *filename)
2338 struct GNUNET_FS_DownloadContext *parent = cls;
2341 struct GNUNET_BIO_ReadHandle *rh;
2343 ser = get_serialization_short_name (filename);
2344 rh = GNUNET_BIO_read_open (filename);
2347 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2349 ("Failed to resume sub-download `%s': could not open file `%s'\n"),
2354 deserialize_download (parent->h, rh, parent, NULL, ser);
2355 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2357 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2358 _("Failed to resume sub-download `%s': %s\n"), ser, emsg);
2367 * Free this download context and all of its descendants.
2368 * (only works during deserialization since not all possible
2369 * state it taken care of).
2371 * @param dc context to free
2374 free_download_context (struct GNUNET_FS_DownloadContext *dc)
2376 struct GNUNET_FS_DownloadContext *dcc;
2378 if (dc->meta != NULL)
2379 GNUNET_CONTAINER_meta_data_destroy (dc->meta);
2380 if (dc->uri != NULL)
2381 GNUNET_FS_uri_destroy (dc->uri);
2382 GNUNET_free_non_null (dc->temp_filename);
2383 GNUNET_free_non_null (dc->emsg);
2384 GNUNET_free_non_null (dc->filename);
2385 GNUNET_free_non_null (dc->serialization);
2386 while (NULL != (dcc = dc->child_head))
2388 GNUNET_CONTAINER_DLL_remove (dc->child_head, dc->child_tail, dcc);
2389 free_download_context (dcc);
2391 GNUNET_FS_free_download_request_ (dc->top_request);
2392 if (NULL != dc->active)
2393 GNUNET_CONTAINER_multihashmap_destroy (dc->active);
2399 * Deserialize a download.
2401 * @param h overall context
2402 * @param rh file to deserialize from
2403 * @param parent parent download
2404 * @param search associated search
2405 * @param serialization name under which the search was serialized
2408 deserialize_download (struct GNUNET_FS_Handle *h,
2409 struct GNUNET_BIO_ReadHandle *rh,
2410 struct GNUNET_FS_DownloadContext *parent,
2411 struct GNUNET_FS_SearchResult *search,
2412 const char *serialization)
2414 struct GNUNET_FS_DownloadContext *dc;
2423 dc = GNUNET_malloc (sizeof (struct GNUNET_FS_DownloadContext));
2424 dc->parent = parent;
2426 dc->serialization = GNUNET_strdup (serialization);
2428 GNUNET_BIO_read_string (rh, "download-uri", &uris, 10 * 1024)) ||
2429 (NULL == (dc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2430 ((GNUNET_YES != GNUNET_FS_uri_test_chk (dc->uri)) &&
2431 (GNUNET_YES != GNUNET_FS_uri_test_loc (dc->uri))) ||
2432 (GNUNET_OK != GNUNET_BIO_read_meta_data (rh, "download-meta", &dc->meta))
2434 GNUNET_BIO_read_string (rh, "download-emsg", &dc->emsg, 10 * 1024)) ||
2436 GNUNET_BIO_read_string (rh, "download-fn", &dc->filename, 10 * 1024)) ||
2438 GNUNET_BIO_read_string (rh, "download-tfn", &dc->temp_filename,
2440 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->old_file_size)) ||
2441 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->offset)) ||
2442 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->length)) ||
2443 (GNUNET_OK != GNUNET_BIO_read_int64 (rh, &dc->completed)) ||
2444 (GNUNET_OK != read_start_time (rh, &dc->start_time)) ||
2445 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &dc->anonymity)) ||
2446 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2447 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &status)))
2452 dc->options = (enum GNUNET_FS_DownloadOptions) options;
2454 GNUNET_CONTAINER_multihashmap_create (1 + 2 * (dc->length / DBLOCK_SIZE));
2455 dc->has_finished = (int) status;
2457 GNUNET_FS_compute_depth (GNUNET_FS_uri_chk_get_file_size (dc->uri));
2458 if (GNUNET_FS_uri_test_loc (dc->uri))
2459 GNUNET_assert (GNUNET_OK ==
2460 GNUNET_FS_uri_loc_get_peer_identity (dc->uri, &dc->target));
2461 if (dc->emsg == NULL)
2463 dc->top_request = read_download_request (rh);
2464 if (dc->top_request == NULL)
2470 dn = get_download_sync_filename (dc, dc->serialization, ".dir");
2473 if (GNUNET_YES == GNUNET_DISK_directory_test (dn))
2474 GNUNET_DISK_directory_scan (dn, &deserialize_subdownload, dc);
2479 GNUNET_abort (); // for debugging for now - FIXME
2480 GNUNET_CONTAINER_DLL_insert (parent->child_head, parent->child_tail, dc);
2484 dc->search = search;
2485 search->download = dc;
2487 if ((parent == NULL) && (search == NULL))
2490 GNUNET_FS_make_top (dc->h, &GNUNET_FS_download_signal_suspend_, dc);
2491 signal_download_resume (dc);
2494 dc->task = GNUNET_SCHEDULER_add_now (&GNUNET_FS_download_start_task_, dc);
2497 GNUNET_free_non_null (uris);
2498 GNUNET_free_non_null (emsg);
2499 free_download_context (dc);
2504 * Signal resuming of a search to our clients (for the
2505 * top level search and all sub-searches).
2507 * @param sc search being resumed
2510 signal_search_resume (struct GNUNET_FS_SearchContext *sc)
2512 struct GNUNET_FS_ProgressInfo pi;
2514 pi.status = GNUNET_FS_STATUS_SEARCH_RESUME;
2515 pi.value.search.specifics.resume.message = sc->emsg;
2516 pi.value.search.specifics.resume.is_paused =
2517 (sc->client == NULL) ? GNUNET_YES : GNUNET_NO;
2518 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
2519 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
2520 &signal_result_resume, sc);
2526 * Deserialize a search.
2528 * @param h overall context
2529 * @param rh file to deserialize from
2530 * @param psearch_result parent search result
2531 * @param serialization name under which the search was serialized
2533 static struct GNUNET_FS_SearchContext *
2534 deserialize_search (struct GNUNET_FS_Handle *h,
2535 struct GNUNET_BIO_ReadHandle *rh,
2536 struct GNUNET_FS_SearchResult *psearch_result,
2537 const char *serialization)
2539 struct GNUNET_FS_SearchContext *sc;
2546 if ((psearch_result != NULL) && (psearch_result->update_search != NULL))
2553 sc = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchContext));
2554 if (psearch_result != NULL)
2556 sc->psearch_result = psearch_result;
2557 psearch_result->update_search = sc;
2560 sc->serialization = GNUNET_strdup (serialization);
2561 if ((GNUNET_OK != GNUNET_BIO_read_string (rh, "search-uri", &uris, 10 * 1024))
2562 || (NULL == (sc->uri = GNUNET_FS_uri_parse (uris, &emsg))) ||
2563 ((GNUNET_YES != GNUNET_FS_uri_test_ksk (sc->uri)) &&
2564 (GNUNET_YES != GNUNET_FS_uri_test_sks (sc->uri))) ||
2565 (GNUNET_OK != read_start_time (rh, &sc->start_time)) ||
2567 GNUNET_BIO_read_string (rh, "search-emsg", &sc->emsg, 10 * 1024)) ||
2568 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &options)) ||
2570 GNUNET_BIO_read (rh, "search-pause", &in_pause, sizeof (in_pause))) ||
2571 (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &sc->anonymity)))
2576 sc->options = (enum GNUNET_FS_SearchOptions) options;
2577 sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16);
2578 dn = get_serialization_file_name_in_dir (h,
2579 (sc->psearch_result ==
2581 GNUNET_FS_SYNC_PATH_MASTER_SEARCH :
2582 GNUNET_FS_SYNC_PATH_CHILD_SEARCH,
2583 sc->serialization, "");
2586 if (GNUNET_YES == GNUNET_DISK_directory_test (dn))
2587 GNUNET_DISK_directory_scan (dn, &deserialize_search_result, sc);
2590 if (('\0' == in_pause) &&
2591 (GNUNET_OK != GNUNET_FS_search_start_searching_ (sc)))
2593 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2595 ("Could not resume running search, will resume as paused search\n"));
2597 signal_search_resume (sc);
2601 GNUNET_free_non_null (emsg);
2602 free_search_context (sc);
2603 GNUNET_free_non_null (uris);
2609 * Function called with a filename of serialized search operation
2612 * @param cls the 'struct GNUNET_FS_Handle*'
2613 * @param filename complete filename (absolute path)
2614 * @return GNUNET_OK (continue to iterate)
2617 deserialize_search_file (void *cls, const char *filename)
2619 struct GNUNET_FS_Handle *h = cls;
2622 struct GNUNET_BIO_ReadHandle *rh;
2623 struct GNUNET_FS_SearchContext *sc;
2625 ser = get_serialization_short_name (filename);
2626 rh = GNUNET_BIO_read_open (filename);
2631 GNUNET_FS_remove_sync_file_ (h, GNUNET_FS_SYNC_PATH_MASTER_SEARCH, ser);
2636 sc = deserialize_search (h, rh, NULL, ser);
2638 sc->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, sc);
2640 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2642 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2643 _("Failure while resuming search operation `%s': %s\n"),
2652 * Function called with a filename of serialized download operation
2655 * @param cls the 'struct GNUNET_FS_Handle*'
2656 * @param filename complete filename (absolute path)
2657 * @return GNUNET_OK (continue to iterate)
2660 deserialize_download_file (void *cls, const char *filename)
2662 struct GNUNET_FS_Handle *h = cls;
2665 struct GNUNET_BIO_ReadHandle *rh;
2667 ser = get_serialization_short_name (filename);
2668 rh = GNUNET_BIO_read_open (filename);
2671 if (0 != UNLINK (filename))
2672 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", filename);
2676 deserialize_download (h, rh, NULL, NULL, ser);
2678 if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
2680 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2681 _("Failure while resuming download operation `%s': %s\n"),
2690 * Deserialize informatin about pending operations.
2692 * @param master_path which master directory should be scanned
2693 * @param proc function to call for each entry (will get 'h' for 'cls')
2694 * @param h the 'struct GNUNET_FS_Handle*'
2697 deserialization_master (const char *master_path, GNUNET_FileNameCallback proc,
2698 struct GNUNET_FS_Handle *h)
2702 dn = get_serialization_file_name (h, master_path, "");
2705 if (GNUNET_YES == GNUNET_DISK_directory_test (dn))
2706 GNUNET_DISK_directory_scan (dn, proc, h);
2712 * Setup a connection to the file-sharing service.
2714 * @param cfg configuration to use
2715 * @param client_name unique identifier for this client
2716 * @param upcb function to call to notify about FS actions
2717 * @param upcb_cls closure for upcb
2718 * @param flags specific attributes for fs-operations
2719 * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
2720 * @return NULL on error
2722 struct GNUNET_FS_Handle *
2723 GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
2724 const char *client_name, GNUNET_FS_ProgressCallback upcb,
2725 void *upcb_cls, enum GNUNET_FS_Flags flags, ...)
2727 struct GNUNET_FS_Handle *ret;
2728 enum GNUNET_FS_OPTIONS opt;
2731 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Handle));
2733 ret->client_name = GNUNET_strdup (client_name);
2735 ret->upcb_cls = upcb_cls;
2737 ret->max_parallel_downloads = 1;
2738 ret->max_parallel_requests = 1;
2739 ret->avg_block_latency = GNUNET_TIME_UNIT_MINUTES; /* conservative starting point */
2740 va_start (ap, flags);
2741 while (GNUNET_FS_OPTIONS_END != (opt = va_arg (ap, enum GNUNET_FS_OPTIONS)))
2745 case GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM:
2746 ret->max_parallel_downloads = va_arg (ap, unsigned int);
2749 case GNUNET_FS_OPTIONS_REQUEST_PARALLELISM:
2750 ret->max_parallel_requests = va_arg (ap, unsigned int);
2755 GNUNET_free (ret->client_name);
2762 if (0 != (GNUNET_FS_FLAGS_PERSISTENCE & flags))
2764 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
2765 &deserialize_publish_file, ret);
2766 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
2767 &deserialize_search_file, ret);
2768 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_DOWNLOAD,
2769 &deserialize_download_file, ret);
2770 deserialization_master (GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
2771 &deserialize_unindex_file, ret);
2778 * Close our connection with the file-sharing service.
2779 * The callback given to GNUNET_FS_start will no longer be
2780 * called after this function returns.
2782 * @param h handle that was returned from GNUNET_FS_start
2785 GNUNET_FS_stop (struct GNUNET_FS_Handle *h)
2787 while (h->top_head != NULL)
2788 h->top_head->ssf (h->top_head->ssf_cls);
2789 if (h->queue_job != GNUNET_SCHEDULER_NO_TASK)
2790 GNUNET_SCHEDULER_cancel (h->queue_job);
2791 GNUNET_free (h->client_name);