2 This file is part of GNUnet
3 (C) 2004, 2005, 2006, 2007, 2008, 2009 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.
21 * @file include/gnunet_fs_service.h
22 * @brief API for file-sharing via GNUnet
23 * @author Christian Grothoff
25 #ifndef GNUNET_FS_LIB_H
26 #define GNUNET_FS_LIB_H
28 #include "gnunet_util_lib.h"
29 #include "gnunet_scheduler_lib.h"
34 #if 0 /* keep Emacsens' auto-indent happy */
40 * Version number of the implementation.
43 * 1.x.x: initial version with triple GNUNET_hash and merkle tree
44 * 2.x.x: root node with mime-type, filename and version number
45 * 2.1.x: combined GNUNET_EC_ContentHashKey/3HASH encoding with 25:1 super-nodes
46 * 2.2.x: with directories
47 * 3.0.x: with namespaces
48 * 3.1.x: with namespace meta-data
49 * 3.2.x: with collections
50 * 4.0.x: with expiration, variable meta-data, kblocks
51 * 4.1.x: with new error and configuration handling
52 * 5.0.x: with location URIs
53 * 6.0.0: with support for OR in KSKs
54 * 6.1.x: with simplified namespace support
55 * 9.0.0: CPS-style integrated API
56 * 9.1.1: asynchronous directory scanning
58 #define GNUNET_FS_VERSION 0x00090103
61 /* ******************** URI API *********************** */
63 #define GNUNET_FS_URI_PREFIX "gnunet://fs/"
64 #define GNUNET_FS_URI_KSK_INFIX "ksk/"
65 #define GNUNET_FS_URI_SKS_INFIX "sks/"
66 #define GNUNET_FS_URI_CHK_INFIX "chk/"
67 #define GNUNET_FS_URI_LOC_INFIX "loc/"
71 * How often do we signal applications that a probe for a particular
72 * search result is running? (used to visualize probes).
74 #define GNUNET_FS_PROBE_UPDATE_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 250)
77 * A Universal Resource Identifier (URI), opaque.
82 * Iterator over keywords
85 * @param keyword the keyword
86 * @param is_mandatory is the keyword mandatory (in a search)
87 * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
89 typedef int (*GNUNET_FS_KeywordIterator) (void *cls, const char *keyword,
93 * Get a unique key from a URI. This is for putting URIs
94 * into HashMaps. The key may change between FS implementations.
96 * @param uri uri to convert to a unique key
97 * @param key wherer to store the unique key
100 GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri, struct GNUNET_HashCode * key);
103 * Convert a URI to a UTF-8 String.
105 * @param uri uri to convert to a string
106 * @return the UTF-8 string
109 GNUNET_FS_uri_to_string (const struct GNUNET_FS_Uri *uri);
112 * Convert keyword URI to a human readable format
113 * (i.e. the search query that was used in the first place)
115 * @param uri ksk uri to convert to a string
116 * @return string with the keywords
119 GNUNET_FS_uri_ksk_to_string_fancy (const struct GNUNET_FS_Uri *uri);
123 * Add the given keyword to the set of keywords represented by the URI.
124 * Does nothing if the keyword is already present.
126 * @param uri ksk uri to modify
127 * @param keyword keyword to add
128 * @param is_mandatory is this keyword mandatory?
131 GNUNET_FS_uri_ksk_add_keyword (struct GNUNET_FS_Uri *uri, const char *keyword,
136 * Remove the given keyword from the set of keywords represented by the URI.
137 * Does nothing if the keyword is not present.
139 * @param uri ksk uri to modify
140 * @param keyword keyword to add
143 GNUNET_FS_uri_ksk_remove_keyword (struct GNUNET_FS_Uri *uri,
144 const char *keyword);
148 * Convert a UTF-8 String to a URI.
150 * @param uri string to parse
151 * @param emsg where to store the parser error message (if any)
152 * @return NULL on error
154 struct GNUNET_FS_Uri *
155 GNUNET_FS_uri_parse (const char *uri, char **emsg);
160 * @param uri uri to free
163 GNUNET_FS_uri_destroy (struct GNUNET_FS_Uri *uri);
167 * How many keywords are ANDed in this keyword URI?
169 * @param uri ksk uri to get the number of keywords from
170 * @return 0 if this is not a keyword URI
173 GNUNET_FS_uri_ksk_get_keyword_count (const struct GNUNET_FS_Uri *uri);
177 * Iterate over all keywords in this keyword URI.
179 * @param uri ksk uri to get the keywords from
180 * @param iterator function to call on each keyword
181 * @param iterator_cls closure for iterator
182 * @return -1 if this is not a keyword URI, otherwise number of
183 * keywords iterated over until iterator aborted
186 GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
187 GNUNET_FS_KeywordIterator iterator,
192 * Obtain the identity of the peer offering the data
194 * @param uri the location URI to inspect
195 * @param peer where to store the identify of the peer (presumably) offering the content
196 * @return GNUNET_SYSERR if this is not a location URI, otherwise GNUNET_OK
199 GNUNET_FS_uri_loc_get_peer_identity (const struct GNUNET_FS_Uri *uri,
200 struct GNUNET_PeerIdentity *peer);
204 * Obtain the URI of the content itself.
206 * @param uri location URI to get the content URI from
207 * @return NULL if argument is not a location URI
209 struct GNUNET_FS_Uri *
210 GNUNET_FS_uri_loc_get_uri (const struct GNUNET_FS_Uri *uri);
214 * Obtain the expiration of the LOC URI.
216 * @param uri location URI to get the expiration from
217 * @return expiration time of the URI
219 struct GNUNET_TIME_Absolute
220 GNUNET_FS_uri_loc_get_expiration (const struct GNUNET_FS_Uri *uri);
224 * Construct a location URI (this peer will be used for the location).
226 * @param baseUri content offered by the sender
227 * @param cfg configuration information (used to find our hostkey)
228 * @param expiration_time how long will the content be offered?
229 * @return the location URI, NULL on error
231 struct GNUNET_FS_Uri *
232 GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *baseUri,
233 const struct GNUNET_CONFIGURATION_Handle *cfg,
234 struct GNUNET_TIME_Absolute expiration_time);
238 * Merge the sets of keywords from two KSK URIs.
240 * @param u1 first uri
241 * @param u2 second uri
242 * @return merged URI, NULL on error
244 struct GNUNET_FS_Uri *
245 GNUNET_FS_uri_ksk_merge (const struct GNUNET_FS_Uri *u1,
246 const struct GNUNET_FS_Uri *u2);
252 * @param uri the URI to duplicate
253 * @return copy of the URI
255 struct GNUNET_FS_Uri *
256 GNUNET_FS_uri_dup (const struct GNUNET_FS_Uri *uri);
260 * Create an FS URI from a single user-supplied string of keywords.
261 * The string is broken up at spaces into individual keywords.
262 * Keywords that start with "+" are mandatory. Double-quotes can
263 * be used to prevent breaking up strings at spaces (and also
264 * to specify non-mandatory keywords starting with "+").
266 * Keywords must contain a balanced number of double quotes and
267 * double quotes can not be used in the actual keywords (for
268 * example, the string '""foo bar""' will be turned into two
269 * "OR"ed keywords 'foo' and 'bar', not into '"foo bar"'.
271 * @param keywords the keyword string
272 * @param emsg where to store an error message
273 * @return an FS URI for the given keywords, NULL
274 * if keywords is not legal (i.e. empty).
276 struct GNUNET_FS_Uri *
277 GNUNET_FS_uri_ksk_create (const char *keywords, char **emsg);
281 * Create an FS URI from a user-supplied command line of keywords.
282 * Arguments should start with "+" to indicate mandatory
285 * @param argc number of keywords
286 * @param argv keywords (double quotes are not required for
287 * keywords containing spaces; however, double
288 * quotes are required for keywords starting with
289 * "+"); there is no mechanism for having double
290 * quotes in the actual keywords (if the user
291 * did specifically specify double quotes, the
292 * caller should convert each double quote
293 * into two single quotes).
294 * @return an FS URI for the given keywords, NULL
295 * if keywords is not legal (i.e. empty).
297 struct GNUNET_FS_Uri *
298 GNUNET_FS_uri_ksk_create_from_args (unsigned int argc, const char **argv);
302 * Test if two URIs are equal.
304 * @param u1 one of the URIs
305 * @param u2 the other URI
306 * @return GNUNET_YES if the URIs are equal
309 GNUNET_FS_uri_test_equal (const struct GNUNET_FS_Uri *u1,
310 const struct GNUNET_FS_Uri *u2);
314 * Is this a namespace URI?
316 * @param uri the uri to check
317 * @return GNUNET_YES if this is an SKS uri
320 GNUNET_FS_uri_test_sks (const struct GNUNET_FS_Uri *uri);
324 * Handle to one of our namespaces.
326 struct GNUNET_FS_Namespace;
330 * Create an SKS URI from a namespace and an identifier.
332 * @param ns namespace
333 * @param id identifier
334 * @param emsg where to store an error message
335 * @return an FS URI for the given namespace and identifier
337 struct GNUNET_FS_Uri *
338 GNUNET_FS_uri_sks_create (struct GNUNET_FS_Namespace *ns, const char *id,
343 * Create an SKS URI from a namespace ID and an identifier.
345 * @param nsid namespace ID
346 * @param id identifier
347 * @return an FS URI for the given namespace and identifier
349 struct GNUNET_FS_Uri *
350 GNUNET_FS_uri_sks_create_from_nsid (struct GNUNET_HashCode * nsid, const char *id);
354 * Get the ID of a namespace from the given
357 * @param uri the uri to get the namespace ID from
358 * @param nsid where to store the ID of the namespace
359 * @return GNUNET_OK on success
362 GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
363 struct GNUNET_HashCode * nsid);
367 * Get the content identifier of an SKS URI.
369 * @param uri the sks uri
370 * @return NULL on error (not a valid SKS URI)
373 GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri);
377 * Convert namespace URI to a human readable format
378 * (using the namespace description, if available).
380 * @param cfg configuration to use
381 * @param uri SKS uri to convert
382 * @return NULL on error (not an SKS URI)
385 GNUNET_FS_uri_sks_to_string_fancy (struct GNUNET_CONFIGURATION_Handle *cfg,
386 const struct GNUNET_FS_Uri *uri);
390 * Is this a keyword URI?
393 * @return GNUNET_YES if this is a KSK uri
396 GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri);
400 * Is this a file (or directory) URI?
402 * @param uri the uri to check
403 * @return GNUNET_YES if this is a CHK uri
406 GNUNET_FS_uri_test_chk (const struct GNUNET_FS_Uri *uri);
410 * What is the size of the file that this URI
413 * @param uri the CHK (or LOC) URI to inspect
414 * @return size of the file as specified in the CHK URI
417 GNUNET_FS_uri_chk_get_file_size (const struct GNUNET_FS_Uri *uri);
421 * Is this a location URI?
423 * @param uri the uri to check
424 * @return GNUNET_YES if this is a LOC uri
427 GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri);
431 * Construct a keyword-URI from meta-data (take all entries
432 * in the meta-data and construct one large keyword URI
433 * that lists all keywords that can be found in the meta-data).
435 * @param md metadata to use
436 * @return NULL on error, otherwise a KSK URI
438 struct GNUNET_FS_Uri *
439 GNUNET_FS_uri_ksk_create_from_meta_data (const struct GNUNET_CONTAINER_MetaData
443 /* ******************** command-line option parsing API *********************** */
446 * Command-line option parser function that allows the user
447 * to specify one or more '-k' options with keywords. Each
448 * specified keyword will be added to the URI. A pointer to
449 * the URI must be passed as the "scls" argument.
451 * @param ctx command line processor context
452 * @param scls must be of type "struct GNUNET_FS_Uri **"
453 * @param option name of the option (typically 'k')
454 * @param value command line argument given
455 * @return GNUNET_OK on success
458 GNUNET_FS_getopt_set_keywords (struct GNUNET_GETOPT_CommandLineProcessorContext
459 *ctx, void *scls, const char *option,
464 * Command-line option parser function that allows the user to specify
465 * one or more '-m' options with metadata. Each specified entry of
466 * the form "type=value" will be added to the metadata. A pointer to
467 * the metadata must be passed as the "scls" argument.
469 * @param ctx command line processor context
470 * @param scls must be of type "struct GNUNET_CONTAINER_MetaData **"
471 * @param option name of the option (typically 'k')
472 * @param value command line argument given
473 * @return GNUNET_OK on success
476 GNUNET_FS_getopt_set_metadata (struct GNUNET_GETOPT_CommandLineProcessorContext
477 *ctx, void *scls, const char *option,
482 /* ************************* sharing API ***************** */
486 * Possible status codes used in the callback for the
487 * various file-sharing operations. On each file (or search),
488 * the callback is guaranteed to be called once with "START"
489 * and once with STOPPED; calls with PROGRESS, ERROR or COMPLETED
490 * are optional and depend on the circumstances; parent operations
491 * will be STARTED before child-operations and STOPPED after
492 * their respective child-operations. START and STOP signals
493 * are typically generated either due to explicit client requests
494 * or because of suspend/resume operations.
496 enum GNUNET_FS_Status
499 * Notification that we have started to publish a file structure.
501 GNUNET_FS_STATUS_PUBLISH_START = 0,
504 * Notification that we have resumed sharing a file structure.
506 GNUNET_FS_STATUS_PUBLISH_RESUME = 1,
509 * Notification that we have suspended sharing a file structure.
511 GNUNET_FS_STATUS_PUBLISH_SUSPEND = 2,
514 * Notification that we are making progress sharing a file structure.
516 GNUNET_FS_STATUS_PUBLISH_PROGRESS = 3,
519 * Notification that an error was encountered sharing a file structure.
520 * The application will continue to receive resume/suspend events for
521 * this structure until "GNUNET_FS_publish_stop" is called.
523 GNUNET_FS_STATUS_PUBLISH_ERROR = 4,
526 * Notification that we completed sharing a file structure.
527 * The application will continue to receive resume/suspend events for
528 * this structure until "GNUNET_FS_publish_stop" is called.
530 GNUNET_FS_STATUS_PUBLISH_COMPLETED = 5,
533 * Notification that we have stopped
534 * the process of uploading a file structure; no
535 * futher events will be generated for this action.
537 GNUNET_FS_STATUS_PUBLISH_STOPPED = 6,
540 * Notification that we have started this download.
542 GNUNET_FS_STATUS_DOWNLOAD_START = 7,
545 * Notification that this download is being resumed.
547 GNUNET_FS_STATUS_DOWNLOAD_RESUME = 8,
550 * Notification that this download was suspended.
552 GNUNET_FS_STATUS_DOWNLOAD_SUSPEND = 9,
555 * Notification about progress with this download.
557 GNUNET_FS_STATUS_DOWNLOAD_PROGRESS = 10,
560 * Notification that this download encountered an error.
562 GNUNET_FS_STATUS_DOWNLOAD_ERROR = 11,
565 * Notification that this download completed. Note that for
566 * directories, completion does not imply completion of all files in
569 GNUNET_FS_STATUS_DOWNLOAD_COMPLETED = 12,
572 * Notification that this download was stopped
573 * (final event with respect to this action).
575 GNUNET_FS_STATUS_DOWNLOAD_STOPPED = 13,
578 * Notification that this download is now actively being
579 * pursued (as opposed to waiting in the queue).
581 GNUNET_FS_STATUS_DOWNLOAD_ACTIVE = 14,
584 * Notification that this download is no longer actively
585 * being pursued (back in the queue).
587 GNUNET_FS_STATUS_DOWNLOAD_INACTIVE = 15,
590 * Notification that this download is no longer part of a
591 * recursive download or search but now a 'stand-alone'
592 * download (and may thus need to be moved in the GUI
593 * into a different category).
595 GNUNET_FS_STATUS_DOWNLOAD_LOST_PARENT = 16,
598 * First event generated when a client requests
599 * a search to begin or when a namespace result
600 * automatically triggers the search for updates.
602 GNUNET_FS_STATUS_SEARCH_START = 17,
605 * Last event when a search is being resumed;
606 * note that "GNUNET_FS_SEARCH_START" will not
607 * be generated in this case.
609 GNUNET_FS_STATUS_SEARCH_RESUME = 18,
612 * Event generated for each search result
613 * when the respective search is resumed.
615 GNUNET_FS_STATUS_SEARCH_RESUME_RESULT = 19,
618 * Last event when a search is being suspended;
619 * note that "GNUNET_FS_SEARCH_STOPPED" will not
620 * be generated in this case.
622 GNUNET_FS_STATUS_SEARCH_SUSPEND = 20,
625 * This search has yielded a result.
627 GNUNET_FS_STATUS_SEARCH_RESULT = 21,
630 * We have discovered a new namespace.
632 GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE = 22,
635 * We have additional data about the quality
636 * or availability of a search result.
638 GNUNET_FS_STATUS_SEARCH_UPDATE = 23,
641 * Signals a problem with this search.
643 GNUNET_FS_STATUS_SEARCH_ERROR = 24,
646 * Signals that this search was paused.
648 GNUNET_FS_STATUS_SEARCH_PAUSED = 25,
651 * Signals that this search was continued (unpaused).
653 GNUNET_FS_STATUS_SEARCH_CONTINUED = 26,
656 * Event generated for each search result
657 * when the respective search is stopped.
659 GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED = 27,
662 * Event generated for each search result
663 * when the respective search is suspended.
665 GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND = 28,
668 * Last message from a search; this signals
669 * that there will be no further events associated
672 GNUNET_FS_STATUS_SEARCH_STOPPED = 29,
675 * Notification that we started to unindex a file.
677 GNUNET_FS_STATUS_UNINDEX_START = 30,
680 * Notification that we resumed unindexing of a file.
682 GNUNET_FS_STATUS_UNINDEX_RESUME = 31,
685 * Notification that we suspended unindexing a file.
687 GNUNET_FS_STATUS_UNINDEX_SUSPEND = 32,
690 * Notification that we made progress unindexing a file.
692 GNUNET_FS_STATUS_UNINDEX_PROGRESS = 33,
695 * Notification that we encountered an error unindexing
698 GNUNET_FS_STATUS_UNINDEX_ERROR = 34,
701 * Notification that the unindexing of this file
704 GNUNET_FS_STATUS_UNINDEX_COMPLETED = 35,
707 * Notification that the unindexing of this file
708 * was stopped (final event for this action).
710 GNUNET_FS_STATUS_UNINDEX_STOPPED = 36
715 * Handle for controlling an upload.
717 struct GNUNET_FS_PublishContext;
721 * Handle for controlling an unindexing operation.
723 struct GNUNET_FS_UnindexContext;
727 * Handle for controlling a search.
729 struct GNUNET_FS_SearchContext;
733 * Result from a search. Opaque handle to refer to the search
734 * (typically used when starting a download associated with the search
737 struct GNUNET_FS_SearchResult;
741 * Context for controlling a download.
743 struct GNUNET_FS_DownloadContext;
747 * Handle for detail information about a file that is being publishd.
748 * Specifies metadata, keywords, how to get the contents of the file
749 * (i.e. data-buffer in memory, filename on disk) and other options.
751 struct GNUNET_FS_FileInformation;
755 * Argument given to the progress callback with
756 * information about what is going on.
758 struct GNUNET_FS_ProgressInfo
762 * Values that depend on the event type.
768 * Values for all "GNUNET_FS_STATUS_PUBLISH_*" events.
774 * Context for controlling the upload.
776 struct GNUNET_FS_PublishContext *pc;
779 * Information about the file that is being publishd.
781 const struct GNUNET_FS_FileInformation *fi;
784 * Client context pointer (set the last time by the client for
785 * this operation; initially NULL on START/RESUME events).
790 * Client context pointer for the parent operation
791 * (if this is a file in a directory or a subdirectory).
796 * Name of the file being published; can be NULL.
798 const char *filename;
801 * How large is the file overall? For directories,
802 * this is only the size of the directory itself,
803 * not of the other files contained within the
809 * At what time do we expect to finish the upload?
810 * (will be a value in the past for completed
813 struct GNUNET_TIME_Relative eta;
816 * How long has this upload been actively running
817 * (excludes times where the upload was suspended).
819 struct GNUNET_TIME_Relative duration;
822 * How many bytes have we completed?
827 * What anonymity level is used for this upload?
832 * Additional values for specific events.
838 * These values are only valid for
839 * GNUNET_FS_STATUS_PUBLISH_PROGRESS events.
845 * Data block we just published.
850 * At what offset in the file is "data"?
855 * Length of the data block.
860 * Depth of the given block in the tree;
861 * 0 would be the lowest level (DBLOCKs).
868 * These values are only valid for
869 * GNUNET_FS_STATUS_PUBLISH_RESUME events.
875 * Error message, NULL if no error was encountered so far.
880 * URI of the file (if the download had been completed)
882 const struct GNUNET_FS_Uri *chk_uri;
887 * These values are only valid for
888 * GNUNET_FS_STATUS_PUBLISH_COMPLETED events.
896 const struct GNUNET_FS_Uri *chk_uri;
901 * These values are only valid for
902 * GNUNET_FS_STATUS_PUBLISH_ERROR events.
908 * Error message, never NULL.
920 * Values for all "GNUNET_FS_STATUS_DOWNLOAD_*" events.
926 * Context for controlling the download.
928 struct GNUNET_FS_DownloadContext *dc;
931 * Client context pointer (set the last time
932 * by the client for this operation; initially
933 * NULL on START/RESUME events).
938 * Client context pointer for the parent operation
939 * (if this is a file in a directory or a subdirectory).
944 * Client context pointer for the associated search operation
945 * (specifically, context pointer for the specific search
946 * result, not the overall search); only set if this
947 * download was started from a search result.
952 * URI used for this download.
954 const struct GNUNET_FS_Uri *uri;
957 * Name of the file that we are downloading.
959 const char *filename;
962 * How large is the download overall? This
963 * is NOT necessarily the size from the
964 * URI since we may be doing a partial download.
969 * At what time do we expect to finish the download?
970 * (will be a value in the past for completed
973 struct GNUNET_TIME_Relative eta;
976 * How long has this download been active?
978 struct GNUNET_TIME_Relative duration;
981 * How many bytes have we completed?
986 * What anonymity level is used for this download?
991 * Is the download currently active.
996 * Additional values for specific events.
1002 * These values are only valid for
1003 * GNUNET_FS_STATUS_DOWNLOAD_PROGRESS events.
1009 * Data block we just obtained, can be NULL (even if
1010 * data_len > 0) if we found the entire block 'intact' on
1011 * disk. In this case, it is also possible for 'data_len'
1012 * to be larger than an individual (32k) block.
1017 * At what offset in the file is "data"?
1022 * Length of the data block.
1027 * How much time passed between us asking for this block and
1028 * actually getting it? GNUNET_TIME_UNIT_FOREVER_REL if unknown.
1030 struct GNUNET_TIME_Relative block_download_duration;
1033 * Depth of the given block in the tree;
1034 * 0 would be the lowest level (DBLOCKS).
1039 * How much respect did we offer for downloading this block? (estimate,
1040 * because we might have the same request pending for multiple clients,
1041 * and of course because a transmission may have failed at a lower
1044 uint32_t respect_offered;
1047 * How often did we transmit the request? (estimate,
1048 * because we might have the same request pending for multiple clients,
1049 * and of course because a transmission may have failed at a lower
1052 uint32_t num_transmissions;
1057 * These values are only valid for
1058 * GNUNET_FS_STATUS_DOWNLOAD_START events.
1064 * Known metadata for the download.
1066 const struct GNUNET_CONTAINER_MetaData *meta;
1071 * These values are only valid for
1072 * GNUNET_FS_STATUS_DOWNLOAD_RESUME events.
1078 * Known metadata for the download.
1080 const struct GNUNET_CONTAINER_MetaData *meta;
1083 * Error message, NULL if we have not encountered any error yet.
1085 const char *message;
1090 * These values are only valid for
1091 * GNUNET_FS_STATUS_DOWNLOAD_ERROR events.
1099 const char *message;
1108 * Values for all "GNUNET_FS_STATUS_SEARCH_*" events.
1114 * Context for controlling the search, NULL for
1115 * searches that were not explicitly triggered
1116 * by the client (i.e., searches for updates in
1119 struct GNUNET_FS_SearchContext *sc;
1122 * Client context pointer (set the last time by the client for
1123 * this operation; initially NULL on START/RESUME events). Note
1124 * that this value can only be set on START/RESUME; returning
1125 * non-NULL on RESULT/RESUME_RESULT will actually update the
1126 * private context for "UPDATE" events.
1131 * Client parent-context pointer; NULL for top-level searches,
1132 * refers to the client context of the associated search result
1133 * for automatically triggered searches for updates in
1134 * namespaces. In this case, 'presult' refers to that search
1140 * What query is used for this search
1141 * (list of keywords or SKS identifier).
1143 const struct GNUNET_FS_Uri *query;
1146 * How long has this search been actively running
1147 * (excludes times where the search was paused or
1150 struct GNUNET_TIME_Relative duration;
1153 * What anonymity level is used for this search?
1158 * Additional values for specific events.
1164 * These values are only valid for
1165 * GNUNET_FS_STATUS_SEARCH_RESULT events.
1171 * Metadata for the search result.
1173 const struct GNUNET_CONTAINER_MetaData *meta;
1176 * URI for the search result.
1178 const struct GNUNET_FS_Uri *uri;
1181 * Handle to the result (for starting downloads).
1183 struct GNUNET_FS_SearchResult *result;
1186 * Applicability rank (the larger, the better the result
1187 * fits the search criteria).
1189 uint32_t applicability_rank;
1194 * These values are only valid for
1195 * GNUNET_FS_STATUS_SEARCH_RESUME_RESULT events.
1201 * Metadata for the search result.
1203 const struct GNUNET_CONTAINER_MetaData *meta;
1206 * URI for the search result.
1208 const struct GNUNET_FS_Uri *uri;
1211 * Handle to the result (for starting downloads).
1213 struct GNUNET_FS_SearchResult *result;
1216 * Current availability rank (negative:
1217 * unavailable, positive: available)
1219 int32_t availability_rank;
1222 * On how many total queries is the given
1223 * availability_rank based?
1225 uint32_t availability_certainty;
1228 * Updated applicability rank (the larger,
1229 * the better the result fits the search
1232 uint32_t applicability_rank;
1237 * These values are only valid for
1238 * GNUNET_FS_STATUS_SEARCH_UPDATE events.
1244 * Private context set for for this result
1245 * during the "RESULT" event.
1250 * Metadata for the search result.
1252 const struct GNUNET_CONTAINER_MetaData *meta;
1255 * URI for the search result.
1257 const struct GNUNET_FS_Uri *uri;
1260 * Current availability rank (negative:
1261 * unavailable, positive: available)
1263 int32_t availability_rank;
1266 * On how many total queries is the given
1267 * availability_rank based?
1269 uint32_t availability_certainty;
1272 * Updated applicability rank (the larger,
1273 * the better the result fits the search
1276 uint32_t applicability_rank;
1279 * How long has the current probe been active?
1281 struct GNUNET_TIME_Relative current_probe_time;
1286 * These values are only valid for
1287 * GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND events.
1288 * These events are automatically triggered for
1289 * each search result before the
1290 * GNUNET_FS_STATUS_SEARCH_SUSPEND event. This
1291 * happens primarily to give the client a chance
1292 * to clean up the "cctx" (if needed).
1298 * Private context set for for this result
1299 * during the "RESULT" event.
1304 * Metadata for the search result.
1306 const struct GNUNET_CONTAINER_MetaData *meta;
1309 * URI for the search result.
1311 const struct GNUNET_FS_Uri *uri;
1316 * These values are only valid for
1317 * GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED events.
1318 * These events are automatically triggered for
1319 * each search result before the
1320 * GNUNET_FS_STATUS_SEARCH_STOPPED event. This
1321 * happens primarily to give the client a chance
1322 * to clean up the "cctx" (if needed).
1328 * Private context set for for this result
1329 * during the "RESULT" event.
1334 * Metadata for the search result.
1336 const struct GNUNET_CONTAINER_MetaData *meta;
1339 * URI for the search result.
1341 const struct GNUNET_FS_Uri *uri;
1346 * These values are only valid for
1347 * GNUNET_FS_STATUS_SEARCH_RESUME events.
1353 * Error message, NULL if we have not encountered any error yet.
1355 const char *message;
1358 * Is this search currently paused?
1365 * These values are only valid for
1366 * GNUNET_FS_STATUS_SEARCH_ERROR events.
1374 const char *message;
1379 * Values for all "GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE" events.
1385 * Handle to the namespace (NULL if it is not a local
1388 struct GNUNET_FS_Namespace *ns;
1391 * Short, human-readable name of the namespace.
1396 * Root identifier for the namespace, can be NULL.
1401 * Metadata for the namespace.
1403 const struct GNUNET_CONTAINER_MetaData *meta;
1406 * Hash-identifier for the namespace.
1408 struct GNUNET_HashCode id;
1417 * Values for all "GNUNET_FS_STATUS_UNINDEX_*" events.
1423 * Context for controlling the unindexing.
1425 struct GNUNET_FS_UnindexContext *uc;
1428 * Client context pointer (set the last time
1429 * by the client for this operation; initially
1430 * NULL on START/RESUME events).
1435 * Name of the file that is being unindexed.
1437 const char *filename;
1440 * How large is the file overall?
1445 * At what time do we expect to finish unindexing?
1446 * (will be a value in the past for completed
1447 * unindexing opeations).
1449 struct GNUNET_TIME_Relative eta;
1452 * How long has this upload been actively running
1453 * (excludes times where the upload was suspended).
1455 struct GNUNET_TIME_Relative duration;
1458 * How many bytes have we completed?
1463 * Additional values for specific events.
1469 * These values are only valid for
1470 * GNUNET_FS_STATUS_UNINDEX_PROGRESS events.
1476 * Data block we just unindexed.
1481 * At what offset in the file is "data"?
1486 * Length of the data block.
1491 * Depth of the given block in the tree;
1492 * 0 would be the lowest level (DBLOCKS).
1499 * These values are only valid for
1500 * GNUNET_FS_STATUS_UNINDEX_RESUME events.
1506 * Error message, NULL if we have not encountered any error yet.
1508 const char *message;
1513 * These values are only valid for
1514 * GNUNET_FS_STATUS_UNINDEX_ERROR events.
1522 const char *message;
1533 * Specific status code (determines the event type).
1535 enum GNUNET_FS_Status status;
1541 * Notification of FS to a client about the progress of an
1542 * operation. Callbacks of this type will be used for uploads,
1543 * downloads and searches. Some of the arguments depend a bit
1544 * in their meaning on the context in which the callback is used.
1546 * @param cls closure
1547 * @param info details about the event, specifying the event type
1548 * and various bits about the event
1549 * @return client-context (for the next progress call
1550 * for this operation; should be set to NULL for
1551 * SUSPEND and STOPPED events). The value returned
1552 * will be passed to future callbacks in the respective
1553 * field in the GNUNET_FS_ProgressInfo struct.
1555 typedef void *(*GNUNET_FS_ProgressCallback) (void *cls,
1556 const struct GNUNET_FS_ProgressInfo *info);
1560 * General (global) option flags for file-sharing.
1562 enum GNUNET_FS_Flags
1565 * No special flags set.
1567 GNUNET_FS_FLAGS_NONE = 0,
1570 * Is persistence of operations desired?
1571 * (will create SUSPEND/RESUME events).
1573 GNUNET_FS_FLAGS_PERSISTENCE = 1,
1576 * Should we automatically trigger probes for search results
1577 * to determine availability?
1578 * (will create GNUNET_FS_STATUS_SEARCH_UPDATE events).
1580 GNUNET_FS_FLAGS_DO_PROBES = 2
1585 * Options specified in the VARARGs portion of GNUNET_FS_start.
1587 enum GNUNET_FS_OPTIONS
1591 * Last option in the VARARG list.
1593 GNUNET_FS_OPTIONS_END = 0,
1596 * Select the desired amount of parallelism (this option should be
1597 * followed by an "unsigned int" giving the desired maximum number
1598 * of parallel downloads).
1600 GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM = 1,
1603 * Maximum number of requests that should be pending at a given
1604 * point in time (invidivual downloads may go above this, but
1605 * if we are above this threshold, we should not activate any
1606 * additional downloads.
1608 GNUNET_FS_OPTIONS_REQUEST_PARALLELISM = 2
1613 * Settings for publishing a block (which may of course also
1614 * apply to an entire directory or file).
1616 struct GNUNET_FS_BlockOptions
1620 * At what time should the block expire? Data blocks (DBLOCKS and
1621 * IBLOCKS) may still be used even if they are expired (however,
1622 * they'd be removed quickly from the datastore if we are short on
1623 * space), all other types of blocks will no longer be returned
1624 * after they expire.
1626 struct GNUNET_TIME_Absolute expiration_time;
1629 * At which anonymity level should the block be shared?
1630 * (0: no anonymity, 1: normal GAP, >1: with cover traffic).
1632 uint32_t anonymity_level;
1635 * How important is it for us to store the block? If we run
1636 * out of space, the highest-priority, non-expired blocks will
1639 uint32_t content_priority;
1642 * How often should we try to migrate the block to other peers?
1643 * Only used if "CONTENT_PUSHING" is set to YES, in which case we
1644 * first push each block to other peers according to their
1645 * replication levels. Once each block has been pushed that many
1646 * times to other peers, blocks are chosen for migration at random.
1647 * Naturally, there is no guarantee that the other peers will keep
1648 * these blocks for any period of time (since they won't have any
1649 * priority or might be too busy to even store the block in the
1652 uint32_t replication_level;
1658 * Return the current year (i.e. '2011').
1661 GNUNET_FS_get_current_year (void);
1665 * Convert a year to an expiration time of January 1st of that year.
1667 * @param year a year (after 1970, please ;-)).
1668 * @return absolute time for January 1st of that year.
1670 struct GNUNET_TIME_Absolute
1671 GNUNET_FS_year_to_time (unsigned int year);
1675 * Convert an expiration time to the respective year (rounds)
1677 * @param at absolute time
1678 * @return year a year (after 1970), 0 on error
1681 GNUNET_FS_time_to_year (struct GNUNET_TIME_Absolute at);
1685 * Handle to the file-sharing service.
1687 struct GNUNET_FS_Handle;
1691 * Setup a connection to the file-sharing service.
1693 * @param cfg configuration to use
1694 * @param client_name unique identifier for this client
1695 * @param upcb function to call to notify about FS actions
1696 * @param upcb_cls closure for upcb
1697 * @param flags specific attributes for fs-operations
1698 * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
1699 * @return NULL on error
1701 struct GNUNET_FS_Handle *
1702 GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
1703 const char *client_name, GNUNET_FS_ProgressCallback upcb,
1704 void *upcb_cls, enum GNUNET_FS_Flags flags, ...);
1708 * Close our connection with the file-sharing service.
1709 * The callback given to GNUNET_FS_start will no longer be
1710 * called after this function returns.
1712 * @param h handle that was returned from GNUNET_FS_start
1715 GNUNET_FS_stop (struct GNUNET_FS_Handle *h);
1719 * Function called on entries in a GNUNET_FS_FileInformation publish-structure.
1721 * @param cls closure
1722 * @param fi the entry in the publish-structure
1723 * @param length length of the file or directory
1724 * @param meta metadata for the file or directory (can be modified)
1725 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1726 * @param bo block options (can be modified)
1727 * @param do_index should we index (can be modified)
1728 * @param client_info pointer to client context set upon creation (can be modified)
1729 * @return GNUNET_OK to continue, GNUNET_NO to remove
1730 * this entry from the directory, GNUNET_SYSERR
1731 * to abort the iteration
1733 typedef int (*GNUNET_FS_FileInformationProcessor) (void *cls,
1735 GNUNET_FS_FileInformation *
1736 fi, uint64_t length,
1738 GNUNET_CONTAINER_MetaData *
1740 struct GNUNET_FS_Uri ** uri,
1741 struct GNUNET_FS_BlockOptions
1742 * bo, int *do_index,
1743 void **client_info);
1747 * Obtain the name under which this file information
1748 * structure is stored on disk. Only works for top-level
1749 * file information structures.
1751 * @param s structure to get the filename for
1752 * @return NULL on error, otherwise filename that
1753 * can be passed to "GNUNET_FS_file_information_recover"
1754 * to read this fi-struct from disk.
1757 GNUNET_FS_file_information_get_id (struct GNUNET_FS_FileInformation *s);
1761 * Obtain the filename from the file information structure.
1763 * @param s structure to get the filename for
1764 * @return "filename" field of the structure (can be NULL)
1767 GNUNET_FS_file_information_get_filename (struct GNUNET_FS_FileInformation *s);
1771 * Set the filename in the file information structure.
1772 * If filename was already set, frees it before setting the new one.
1773 * Makes a copy of the argument.
1775 * @param s structure to get the filename for
1776 * @param filename filename to set
1779 GNUNET_FS_file_information_set_filename (struct GNUNET_FS_FileInformation *s,
1780 const char *filename);
1784 * Create an entry for a file in a publish-structure.
1786 * @param h handle to the file sharing subsystem
1787 * @param client_info initial client-info value for this entry
1788 * @param filename name of the file or directory to publish
1789 * @param keywords under which keywords should this file be available
1790 * directly; can be NULL
1791 * @param meta metadata for the file
1792 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1793 * GNUNET_SYSERR for simulation
1794 * @param bo block options
1795 * @return publish structure entry for the file
1797 struct GNUNET_FS_FileInformation *
1798 GNUNET_FS_file_information_create_from_file (struct GNUNET_FS_Handle *h,
1800 const char *filename,
1801 const struct GNUNET_FS_Uri
1804 GNUNET_CONTAINER_MetaData *meta,
1806 const struct GNUNET_FS_BlockOptions
1811 * Create an entry for a file in a publish-structure.
1813 * @param h handle to the file sharing subsystem
1814 * @param client_info initial client-info value for this entry
1815 * @param length length of the file
1816 * @param data data for the file (should not be used afterwards by
1817 * the caller; callee will "free")
1818 * @param keywords under which keywords should this file be available
1819 * directly; can be NULL
1820 * @param meta metadata for the file
1821 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1822 * GNUNET_SYSERR for simulation
1823 * @param bo block options
1824 * @return publish structure entry for the file
1826 struct GNUNET_FS_FileInformation *
1827 GNUNET_FS_file_information_create_from_data (struct GNUNET_FS_Handle *h,
1828 void *client_info, uint64_t length,
1830 const struct GNUNET_FS_Uri
1833 GNUNET_CONTAINER_MetaData *meta,
1835 const struct GNUNET_FS_BlockOptions
1840 * Function that provides data.
1842 * @param cls closure
1843 * @param offset offset to read from; it is possible
1844 * that the caller might need to go backwards
1845 * a bit at times; set to UINT64_MAX to tell
1846 * the reader that we won't be reading for a while
1847 * (used to close the file descriptor but NOT fully
1848 * clean up the reader's state); in this case,
1849 * a value of '0' for max should be ignored
1850 * @param max maximum number of bytes that should be
1851 * copied to buf; readers are not allowed
1852 * to provide less data unless there is an error;
1853 * a value of "0" will be used at the end to allow
1854 * the reader to clean up its internal state
1855 * @param buf where the reader should write the data
1856 * @param emsg location for the reader to store an error message
1857 * @return number of bytes written, usually "max", 0 on error
1859 typedef size_t (*GNUNET_FS_DataReader) (void *cls, uint64_t offset, size_t max,
1860 void *buf, char **emsg);
1864 * Create an entry for a file in a publish-structure.
1866 * @param h handle to the file sharing subsystem
1867 * @param client_info initial client-info value for this entry
1868 * @param length length of the file
1869 * @param reader function that can be used to obtain the data for the file
1870 * @param reader_cls closure for "reader"
1871 * @param keywords under which keywords should this file be available
1872 * directly; can be NULL
1873 * @param meta metadata for the file
1874 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1875 * GNUNET_SYSERR for simulation
1876 * @param bo block options
1877 * @return publish structure entry for the file
1879 struct GNUNET_FS_FileInformation *
1880 GNUNET_FS_file_information_create_from_reader (struct GNUNET_FS_Handle *h,
1883 GNUNET_FS_DataReader reader,
1885 const struct GNUNET_FS_Uri
1888 GNUNET_CONTAINER_MetaData *meta,
1891 GNUNET_FS_BlockOptions *bo);
1895 * Create an entry for an empty directory in a publish-structure.
1896 * This function should be used by applications for which the
1897 * use of "GNUNET_FS_file_information_create_from_directory"
1898 * is not appropriate.
1900 * @param h handle to the file sharing subsystem
1901 * @param client_info initial client-info value for this entry
1902 * @param keywords under which keywords should this directory be available
1903 * directly; can be NULL
1904 * @param meta metadata for the directory
1905 * @param bo block options
1906 * @param filename name of the directory; can be NULL
1907 * @return publish structure entry for the directory , NULL on error
1909 struct GNUNET_FS_FileInformation *
1910 GNUNET_FS_file_information_create_empty_directory (struct GNUNET_FS_Handle *h,
1912 const struct GNUNET_FS_Uri
1915 GNUNET_CONTAINER_MetaData
1918 GNUNET_FS_BlockOptions *bo,
1919 const char *filename);
1923 * Test if a given entry represents a directory.
1925 * @param ent check if this FI represents a directory
1926 * @return GNUNET_YES if so, GNUNET_NO if not
1929 GNUNET_FS_file_information_is_directory (const struct GNUNET_FS_FileInformation
1934 * Add an entry to a directory in a publish-structure. Clients
1935 * should never modify publish structures that were passed to
1936 * "GNUNET_FS_publish_start" already.
1938 * @param dir the directory
1939 * @param ent the entry to add; the entry must not have been
1940 * added to any other directory at this point and
1941 * must not include "dir" in its structure
1942 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1945 GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
1946 struct GNUNET_FS_FileInformation *ent);
1950 * Inspect a file or directory in a publish-structure. Clients
1951 * should never modify publish structures that were passed to
1952 * "GNUNET_FS_publish_start" already. When called on a directory,
1953 * this function will FIRST call "proc" with information about
1954 * the directory itself and then for each of the files in the
1955 * directory (but not for files in subdirectories). When called
1956 * on a file, "proc" will be called exactly once (with information
1957 * about the specific file).
1959 * @param dir the directory
1960 * @param proc function to call on each entry
1961 * @param proc_cls closure for proc
1964 GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir,
1965 GNUNET_FS_FileInformationProcessor proc,
1970 * Destroy publish-structure. Clients should never destroy publish
1971 * structures that were passed to "GNUNET_FS_publish_start" already.
1973 * @param fi structure to destroy
1974 * @param cleaner function to call on each entry in the structure
1975 * (useful to clean up client_info); can be NULL; return
1976 * values are ignored
1977 * @param cleaner_cls closure for cleaner
1980 GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi,
1981 GNUNET_FS_FileInformationProcessor cleaner,
1986 * Options for publishing. Compatible options
1987 * can be OR'ed together.
1989 enum GNUNET_FS_PublishOptions
1992 * No options (use defaults for everything).
1994 GNUNET_FS_PUBLISH_OPTION_NONE = 0,
1997 * Simulate publishing. With this option, no data will be stored
1998 * in the datastore. Useful for computing URIs from files.
2000 GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY = 1
2004 * Publish a file or directory.
2006 * @param h handle to the file sharing subsystem
2007 * @param fi information about the file or directory structure to publish
2008 * @param ns namespace to publish the file in, NULL for no namespace
2009 * @param nid identifier to use for the publishd content in the namespace
2010 * (can be NULL, must be NULL if namespace is NULL)
2011 * @param nuid update-identifier that will be used for future updates
2012 * (can be NULL, must be NULL if namespace or nid is NULL)
2013 * @param options options for the publication
2014 * @return context that can be used to control the publish operation
2016 struct GNUNET_FS_PublishContext *
2017 GNUNET_FS_publish_start (struct GNUNET_FS_Handle *h,
2018 struct GNUNET_FS_FileInformation *fi,
2019 struct GNUNET_FS_Namespace *ns, const char *nid,
2021 enum GNUNET_FS_PublishOptions options);
2025 * Stop a publication. Will abort incomplete publications (but
2026 * not remove blocks that have already been published) or
2027 * simply clean up the state for completed publications.
2028 * Must NOT be called from within the event callback!
2030 * @param pc context for the publication to stop
2033 GNUNET_FS_publish_stop (struct GNUNET_FS_PublishContext *pc);
2037 * Signature of a function called as the continuation of a KBlock or
2038 * SBlock publication.
2040 * @param cls closure
2041 * @param uri URI under which the block is now available, NULL on error
2042 * @param emsg error message, NULL on success
2044 typedef void (*GNUNET_FS_PublishContinuation) (void *cls,
2045 const struct GNUNET_FS_Uri * uri,
2050 * Handle to cancel publish KSK operation.
2052 struct GNUNET_FS_PublishKskContext;
2056 * Publish a KBlock on GNUnet.
2058 * @param h handle to the file sharing subsystem
2059 * @param ksk_uri keywords to use
2060 * @param meta metadata to use
2061 * @param uri URI to refer to in the KBlock
2062 * @param bo block options
2063 * @param options publication options
2064 * @param cont continuation
2065 * @param cont_cls closure for cont
2066 * @return NULL on error ('cont' will still be called)
2068 struct GNUNET_FS_PublishKskContext *
2069 GNUNET_FS_publish_ksk (struct GNUNET_FS_Handle *h,
2070 const struct GNUNET_FS_Uri *ksk_uri,
2071 const struct GNUNET_CONTAINER_MetaData *meta,
2072 const struct GNUNET_FS_Uri *uri,
2073 const struct GNUNET_FS_BlockOptions *bo,
2074 enum GNUNET_FS_PublishOptions options,
2075 GNUNET_FS_PublishContinuation cont, void *cont_cls);
2079 * Abort the KSK publishing operation.
2081 * @param pkc context of the operation to abort.
2084 GNUNET_FS_publish_ksk_cancel (struct GNUNET_FS_PublishKskContext *pkc);
2088 * Handle to cancel publish SKS operation.
2090 struct GNUNET_FS_PublishSksContext;
2094 * Publish an SBlock on GNUnet.
2096 * @param h handle to the file sharing subsystem
2097 * @param ns namespace to publish in
2098 * @param identifier identifier to use
2099 * @param update update identifier to use
2100 * @param meta metadata to use
2101 * @param uri URI to refer to in the SBlock
2102 * @param bo block options
2103 * @param options publication options
2104 * @param cont continuation
2105 * @param cont_cls closure for cont
2106 * @return NULL on error ('cont' will still be called)
2108 struct GNUNET_FS_PublishSksContext *
2109 GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
2110 struct GNUNET_FS_Namespace *ns,
2111 const char *identifier, const char *update,
2112 const struct GNUNET_CONTAINER_MetaData *meta,
2113 const struct GNUNET_FS_Uri *uri,
2114 const struct GNUNET_FS_BlockOptions *bo,
2115 enum GNUNET_FS_PublishOptions options,
2116 GNUNET_FS_PublishContinuation cont, void *cont_cls);
2120 * Abort the SKS publishing operation.
2122 * @param psc context of the operation to abort.
2125 GNUNET_FS_publish_sks_cancel (struct GNUNET_FS_PublishSksContext *psc);
2129 * Type of a function called by "GNUNET_FS_get_indexed_files".
2131 * @param cls closure
2132 * @param filename the name of the file, NULL for end of list
2133 * @param file_id hash of the contents of the indexed file
2134 * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
2136 typedef int (*GNUNET_FS_IndexedFileProcessor) (void *cls, const char *filename,
2137 const struct GNUNET_HashCode * file_id);
2141 * Handle to cancel 'GNUNET_FS_get_indexed_files'.
2143 struct GNUNET_FS_GetIndexedContext;
2147 * Iterate over all indexed files.
2149 * @param h handle to the file sharing subsystem
2150 * @param iterator function to call on each indexed file
2151 * @param iterator_cls closure for iterator
2152 * @return NULL on error ('iter' is not called)
2154 struct GNUNET_FS_GetIndexedContext *
2155 GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
2156 GNUNET_FS_IndexedFileProcessor iterator,
2157 void *iterator_cls);
2161 * Cancel iteration over all indexed files.
2163 * @param gic operation to cancel
2166 GNUNET_FS_get_indexed_files_cancel (struct GNUNET_FS_GetIndexedContext *gic);
2172 * @param h handle to the file sharing subsystem
2173 * @param filename file to unindex
2174 * @param cctx initial value for the client context
2175 * @return NULL on error, otherwise handle
2177 struct GNUNET_FS_UnindexContext *
2178 GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h, const char *filename,
2183 * Clean up after completion of an unindex operation.
2188 GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc);
2192 * Context for advertising a namespace.
2194 struct GNUNET_FS_AdvertisementContext;
2198 * Publish an advertismement for a namespace.
2200 * @param h handle to the file sharing subsystem
2201 * @param ksk_uri keywords to use for advertisment
2202 * @param ns handle for the namespace that should be advertised
2203 * @param meta meta-data for the namespace advertisement
2204 * @param bo block options
2205 * @param rootEntry name of the root of the namespace
2206 * @param cont continuation
2207 * @param cont_cls closure for cont
2208 * @return NULL on error ('cont' will still be called)
2210 struct GNUNET_FS_AdvertisementContext *
2211 GNUNET_FS_namespace_advertise (struct GNUNET_FS_Handle *h,
2212 struct GNUNET_FS_Uri *ksk_uri,
2213 struct GNUNET_FS_Namespace *ns,
2214 const struct GNUNET_CONTAINER_MetaData *meta,
2215 const struct GNUNET_FS_BlockOptions *bo,
2216 const char *rootEntry,
2217 GNUNET_FS_PublishContinuation cont,
2222 * Abort the namespace advertisement operation.
2224 * @param ac context of the operation to abort.
2227 GNUNET_FS_namespace_advertise_cancel (struct GNUNET_FS_AdvertisementContext *ac);
2231 * Create a namespace with the given name; if one already
2232 * exists, return a handle to the existing namespace.
2234 * @param h handle to the file sharing subsystem
2235 * @param name name to use for the namespace
2236 * @return handle to the namespace, NULL on error (i.e. invalid filename)
2238 struct GNUNET_FS_Namespace *
2239 GNUNET_FS_namespace_create (struct GNUNET_FS_Handle *h, const char *name);
2243 * Open the namespace with the given name; if it does not exist,
2244 * or the key file is corrupted, the function fails.
2246 * @param h handle to the file sharing subsystem
2247 * @param name name of the namespace
2248 * @return handle to the namespace,
2249 * NULL on error (i.e. invalid filename, non-existent filename)
2251 struct GNUNET_FS_Namespace *
2252 GNUNET_FS_namespace_open_existing (struct GNUNET_FS_Handle *h, const char *name);
2256 * Context for creating a namespace asynchronously.
2258 struct GNUNET_FS_NamespaceCreationContext;
2261 * Function called upon completion of 'GNUNET_FS_namespace_create_start'.
2263 * @param cls closure
2264 * @param ns NULL on error, otherwise the namespace (which must be free'd by the callee)
2265 * @param emsg NULL on success, otherwise an error message
2267 typedef void (*GNUNET_FS_NamespaceCreationCallback)(void *cls,
2268 struct GNUNET_FS_Namespace *ns, const char *emsg);
2272 * Create a namespace with the given name; if one already
2273 * exists, return a handle to the existing namespace immediately.
2274 * Otherwise create a namespace asynchronously.
2276 * @param h handle to the file sharing subsystem
2277 * @param name name to use for the namespace
2278 * @return namespace creation context, NULL on error (i.e. invalid filename)
2280 struct GNUNET_FS_NamespaceCreationContext *
2281 GNUNET_FS_namespace_create_start (struct GNUNET_FS_Handle *h, const char *name,
2282 GNUNET_FS_NamespaceCreationCallback cont, void *cont_cls);
2286 * Abort namespace creation.
2288 * @param ncc namespace creation context to abort
2291 GNUNET_FS_namespace_create_stop (struct GNUNET_FS_NamespaceCreationContext *ncc);
2295 * Rename a local namespace.
2297 * @param h handle to the file sharing subsystem
2298 * @param old_name old name of the namespace
2299 * @param new_name new name of the namespace
2300 * @return GNUNET_OK on success, GNUNET_SYSERR on error (see errno for details)
2303 GNUNET_FS_namespace_rename (struct GNUNET_FS_Handle *h, const char *old_name,
2304 const char *new_name);
2308 * Duplicate a namespace handle.
2310 * @param ns namespace handle
2311 * @return duplicated handle to the namespace
2313 struct GNUNET_FS_Namespace *
2314 GNUNET_FS_namespace_dup (struct GNUNET_FS_Namespace *ns);
2318 * Get hash of the public key of a namespace.
2320 * @param ns namespace
2321 * @param id buffer to store the key in
2322 * @return GNUNET_OK on success
2323 * GNUNET_SYSERR on failure (contents of id remain intact)
2326 GNUNET_FS_namespace_get_public_key_hash (struct GNUNET_FS_Namespace *ns,
2327 struct GNUNET_HashCode *id);
2331 * Delete a namespace handle. Can be used for a clean shutdown (free
2332 * memory) or also to freeze the namespace to prevent further
2333 * insertions by anyone.
2335 * @param ns handle to the namespace that should be deleted / freed
2336 * @param freeze prevents future insertions; creating a namespace
2337 * with the same name again will create a fresh namespace instead
2339 * @return GNUNET_OK on success, GNUNET_SYSERR on error
2342 GNUNET_FS_namespace_delete (struct GNUNET_FS_Namespace *ns, int freeze);
2346 * Callback with information about local (!) namespaces.
2347 * Contains the names of the local namespace and the global
2350 * @param cls closure
2351 * @param name human-readable identifier of the namespace
2352 * @param id hash identifier for the namespace
2354 typedef void (*GNUNET_FS_NamespaceInfoProcessor) (void *cls, const char *name,
2355 const struct GNUNET_HashCode * id);
2359 * Build a list of all available local (!) namespaces The returned
2360 * names are only the nicknames since we only iterate over the local
2363 * @param h handle to the file sharing subsystem
2364 * @param cb function to call on each known namespace
2365 * @param cb_cls closure for cb
2368 GNUNET_FS_namespace_list (struct GNUNET_FS_Handle *h,
2369 GNUNET_FS_NamespaceInfoProcessor cb, void *cb_cls);
2373 * Function called on updateable identifiers.
2375 * @param cls closure
2376 * @param last_id last identifier
2377 * @param last_uri uri used for the content published under the last_id
2378 * @param last_meta metadata associated with last_uri
2379 * @param next_id identifier that should be used for updates
2381 typedef void (*GNUNET_FS_IdentifierProcessor) (void *cls, const char *last_id,
2382 const struct GNUNET_FS_Uri *
2385 GNUNET_CONTAINER_MetaData *
2386 last_meta, const char *next_id);
2390 * List all of the identifiers in the namespace for which we could
2391 * produce an update. Namespace updates form a graph where each node
2392 * has a name. Each node can have any number of URI/meta-data entries
2393 * which can each be linked to other nodes. Cycles are possible.
2395 * Calling this function with "next_id" NULL will cause the library to
2396 * call "ip" with a root for each strongly connected component of the
2397 * graph (a root being a node from which all other nodes in the Scc
2400 * Calling this function with "next_id" being the name of a node will
2401 * cause the library to call "ip" with all children of the node. Note
2402 * that cycles within an SCC are possible (including self-loops).
2404 * @param ns namespace to inspect for updateable content
2405 * @param next_id ID to look for; use NULL to look for SCC roots
2406 * @param ip function to call on each updateable identifier
2407 * @param ip_cls closure for ip
2410 GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Namespace *ns,
2411 const char *next_id,
2412 GNUNET_FS_IdentifierProcessor ip,
2417 * Options for searching. Compatible options
2418 * can be OR'ed together.
2420 enum GNUNET_FS_SearchOptions
2423 * No options (use defaults for everything).
2425 GNUNET_FS_SEARCH_OPTION_NONE = 0,
2428 * Only search the local host, do not search remote systems (no P2P)
2430 GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY = 1
2435 * Start search for content.
2437 * @param h handle to the file sharing subsystem
2438 * @param uri specifies the search parameters; can be
2439 * a KSK URI or an SKS URI.
2440 * @param anonymity desired level of anonymity
2441 * @param options options for the search
2442 * @param cctx initial value for the client context
2443 * @return context that can be used to control the search
2445 struct GNUNET_FS_SearchContext *
2446 GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
2447 const struct GNUNET_FS_Uri *uri, uint32_t anonymity,
2448 enum GNUNET_FS_SearchOptions options, void *cctx);
2454 * @param sc context for the search that should be paused
2457 GNUNET_FS_search_pause (struct GNUNET_FS_SearchContext *sc);
2461 * Continue paused search.
2463 * @param sc context for the search that should be resumed
2466 GNUNET_FS_search_continue (struct GNUNET_FS_SearchContext *sc);
2470 * Stop search for content.
2472 * @param sc context for the search that should be stopped
2475 GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc);
2481 * Options for downloading. Compatible options
2482 * can be OR'ed together.
2484 enum GNUNET_FS_DownloadOptions
2487 * No options (use defaults for everything).
2489 GNUNET_FS_DOWNLOAD_OPTION_NONE = 0,
2492 * Only download from the local host, do not access remote systems (no P2P)
2494 GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY = 1,
2497 * Do a recursive download (that is, automatically trigger the
2498 * download of files in directories).
2500 GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE = 2,
2503 * Do not append temporary data to
2504 * the target file (for the IBlocks).
2506 GNUNET_FS_DOWNLOAD_NO_TEMPORARIES = 4,
2509 * Internal option used to flag this download as a 'probe' for a
2510 * search result. Impacts the priority with which the download is
2511 * run and causes signalling callbacks to be done differently.
2512 * Also, probe downloads are not serialized on suspension. Normal
2513 * clients should not use this!
2515 GNUNET_FS_DOWNLOAD_IS_PROBE = (1 << 31)
2521 * Download parts of a file. Note that this will store
2522 * the blocks at the respective offset in the given file. Also, the
2523 * download is still using the blocking of the underlying FS
2524 * encoding. As a result, the download may *write* outside of the
2525 * given boundaries (if offset and length do not match the 32k FS
2526 * block boundaries). <p>
2528 * The given range can be used to focus a download towards a
2529 * particular portion of the file (optimization), not to strictly
2530 * limit the download to exactly those bytes.
2532 * @param h handle to the file sharing subsystem
2533 * @param uri the URI of the file (determines what to download); CHK or LOC URI
2534 * @param meta known metadata for the file (can be NULL)
2535 * @param filename where to store the file, maybe NULL (then no file is
2536 * created on disk and data must be grabbed from the callbacks)
2537 * @param tempname where to store temporary file data, not used if filename is non-NULL;
2538 * can be NULL (in which case we will pick a name if needed); the temporary file
2539 * may already exist, in which case we will try to use the data that is there and
2540 * if it is not what is desired, will overwrite it
2541 * @param offset at what offset should we start the download (typically 0)
2542 * @param length how many bytes should be downloaded starting at offset
2543 * @param anonymity anonymity level to use for the download
2544 * @param options various download options
2545 * @param cctx initial value for the client context for this download
2546 * @param parent parent download to associate this download with (use NULL
2547 * for top-level downloads; useful for manually-triggered recursive downloads)
2548 * @return context that can be used to control this download
2550 struct GNUNET_FS_DownloadContext *
2551 GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
2552 const struct GNUNET_FS_Uri *uri,
2553 const struct GNUNET_CONTAINER_MetaData *meta,
2554 const char *filename, const char *tempname,
2555 uint64_t offset, uint64_t length, uint32_t anonymity,
2556 enum GNUNET_FS_DownloadOptions options, void *cctx,
2557 struct GNUNET_FS_DownloadContext *parent);
2561 * Download parts of a file based on a search result. The download
2562 * will be associated with the search result (and the association
2563 * will be preserved when serializing/deserializing the state).
2564 * If the search is stopped, the download will not be aborted but
2565 * be 'promoted' to a stand-alone download.
2567 * As with the other download function, this will store
2568 * the blocks at the respective offset in the given file. Also, the
2569 * download is still using the blocking of the underlying FS
2570 * encoding. As a result, the download may *write* outside of the
2571 * given boundaries (if offset and length do not match the 32k FS
2572 * block boundaries). <p>
2574 * The given range can be used to focus a download towards a
2575 * particular portion of the file (optimization), not to strictly
2576 * limit the download to exactly those bytes.
2578 * @param h handle to the file sharing subsystem
2579 * @param sr the search result to use for the download (determines uri and
2580 * meta data and associations)
2581 * @param filename where to store the file, maybe NULL (then no file is
2582 * created on disk and data must be grabbed from the callbacks)
2583 * @param tempname where to store temporary file data, not used if filename is non-NULL;
2584 * can be NULL (in which case we will pick a name if needed); the temporary file
2585 * may already exist, in which case we will try to use the data that is there and
2586 * if it is not what is desired, will overwrite it
2587 * @param offset at what offset should we start the download (typically 0)
2588 * @param length how many bytes should be downloaded starting at offset
2589 * @param anonymity anonymity level to use for the download
2590 * @param options various download options
2591 * @param cctx initial value for the client context for this download
2592 * @return context that can be used to control this download
2594 struct GNUNET_FS_DownloadContext *
2595 GNUNET_FS_download_start_from_search (struct GNUNET_FS_Handle *h,
2596 struct GNUNET_FS_SearchResult *sr,
2597 const char *filename,
2598 const char *tempname, uint64_t offset,
2599 uint64_t length, uint32_t anonymity,
2600 enum GNUNET_FS_DownloadOptions options,
2605 * Stop a download (aborts if download is incomplete).
2607 * @param dc handle for the download
2608 * @param do_delete delete files of incomplete downloads
2611 GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc, int do_delete);
2615 /* ******************** Directory API *********************** */
2618 #define GNUNET_FS_DIRECTORY_MIME "application/gnunet-directory"
2619 #define GNUNET_FS_DIRECTORY_MAGIC "\211GND\r\n\032\n"
2620 #define GNUNET_FS_DIRECTORY_EXT ".gnd"
2623 * Does the meta-data claim that this is a directory?
2624 * Checks if the mime-type is that of a GNUnet directory.
2626 * @return GNUNET_YES if it is, GNUNET_NO if it is not, GNUNET_SYSERR if
2627 * we have no mime-type information (treat as 'GNUNET_NO')
2630 GNUNET_FS_meta_data_test_for_directory (const struct GNUNET_CONTAINER_MetaData
2635 * Set the MIMETYPE information for the given
2636 * metadata to "application/gnunet-directory".
2638 * @param md metadata to add mimetype to
2641 GNUNET_FS_meta_data_make_directory (struct GNUNET_CONTAINER_MetaData *md);
2645 * Suggest a filename based on given metadata.
2647 * @param md given meta data
2648 * @return NULL if meta data is useless for suggesting a filename
2651 GNUNET_FS_meta_data_suggest_filename (const struct GNUNET_CONTAINER_MetaData
2656 * Function used to process entries in a directory.
2658 * @param cls closure
2659 * @param filename name of the file in the directory
2660 * @param uri URI of the file
2661 * @param metadata metadata for the file; metadata for
2662 * the directory if everything else is NULL/zero
2663 * @param length length of the available data for the file
2664 * (of type size_t since data must certainly fit
2665 * into memory; if files are larger than size_t
2666 * permits, then they will certainly not be
2667 * embedded with the directory itself).
2668 * @param data data available for the file (length bytes)
2670 typedef void (*GNUNET_FS_DirectoryEntryProcessor) (void *cls,
2671 const char *filename,
2672 const struct GNUNET_FS_Uri *
2675 GNUNET_CONTAINER_MetaData *
2676 meta, size_t length,
2681 * Iterate over all entries in a directory. Note that directories
2682 * are structured such that it is possible to iterate over the
2683 * individual blocks as well as over the entire directory. Thus
2684 * a client can call this function on the buffer in the
2685 * GNUNET_FS_ProgressCallback. Also, directories can optionally
2686 * include the contents of (small) files embedded in the directory
2687 * itself; for those files, the processor may be given the
2688 * contents of the file directly by this function.
2690 * @param size number of bytes in data
2691 * @param data pointer to the beginning of the directory
2692 * @param offset offset of data in the directory
2693 * @param dep function to call on each entry
2694 * @param dep_cls closure for dep
2695 * @return GNUNET_OK if this could be a block in a directory,
2696 * GNUNET_NO if this could be part of a directory (but not 100% OK)
2697 * GNUNET_SYSERR if 'data' does not represent a directory
2700 GNUNET_FS_directory_list_contents (size_t size, const void *data,
2702 GNUNET_FS_DirectoryEntryProcessor dep,
2707 * Opaque handle to a directory builder.
2709 struct GNUNET_FS_DirectoryBuilder;
2712 * Create a directory builder.
2714 * @param mdir metadata for the directory
2716 struct GNUNET_FS_DirectoryBuilder *
2717 GNUNET_FS_directory_builder_create (const struct GNUNET_CONTAINER_MetaData
2722 * Add an entry to a directory.
2724 * @param bld directory to extend
2725 * @param uri uri of the entry (must not be a KSK)
2726 * @param md metadata of the entry
2727 * @param data raw data of the entry, can be NULL, otherwise
2728 * data must point to exactly the number of bytes specified
2732 GNUNET_FS_directory_builder_add (struct GNUNET_FS_DirectoryBuilder *bld,
2733 const struct GNUNET_FS_Uri *uri,
2734 const struct GNUNET_CONTAINER_MetaData *md,
2739 * Finish building the directory. Frees the
2740 * builder context and returns the directory
2743 * @param bld directory to finish
2744 * @param rsize set to the number of bytes needed
2745 * @param rdata set to the encoded directory
2746 * @return GNUNET_OK on success
2749 GNUNET_FS_directory_builder_finish (struct GNUNET_FS_DirectoryBuilder *bld,
2750 size_t * rsize, void **rdata);
2753 /* ******************** DirScanner API *********************** */
2756 * Progress reasons of the directory scanner.
2758 enum GNUNET_FS_DirScannerProgressUpdateReason
2762 * We've started processing a file or directory.
2764 GNUNET_FS_DIRSCANNER_FILE_START = 0,
2767 * We're having trouble accessing a file (soft-error); it will
2770 GNUNET_FS_DIRSCANNER_FILE_IGNORED,
2773 * We've found all files (in the pre-pass).
2775 GNUNET_FS_DIRSCANNER_ALL_COUNTED,
2778 * We've finished extracting meta data from a file.
2780 GNUNET_FS_DIRSCANNER_EXTRACT_FINISHED,
2783 * Last call to the progress function: we have finished scanning
2786 GNUNET_FS_DIRSCANNER_FINISHED,
2789 * There was an internal error. Application should abort the scan.
2791 GNUNET_FS_DIRSCANNER_INTERNAL_ERROR
2797 * Function called over time as the directory scanner makes
2798 * progress on the job at hand.
2800 * @param cls closure
2801 * @param filename which file we are making progress on
2802 * @param is_directory GNUNET_YES if this is a directory,
2803 * GNUNET_NO if this is a file
2804 * GNUNET_SYSERR if it is neither (or unknown)
2805 * @param reason kind of progress we are making
2807 typedef void (*GNUNET_FS_DirScannerProgressCallback) (void *cls,
2808 const char *filename,
2810 enum GNUNET_FS_DirScannerProgressUpdateReason reason);
2814 * A node of a directory tree (produced by dirscanner)
2816 struct GNUNET_FS_ShareTreeItem
2819 * This is a doubly-linked list
2821 struct GNUNET_FS_ShareTreeItem *prev;
2824 * This is a doubly-linked list
2826 struct GNUNET_FS_ShareTreeItem *next;
2829 * This is a doubly-linked tree
2830 * NULL for top-level entries.
2832 struct GNUNET_FS_ShareTreeItem *parent;
2835 * This is a doubly-linked tree
2836 * NULL for files and empty directories
2838 struct GNUNET_FS_ShareTreeItem *children_head;
2841 * This is a doubly-linked tree
2842 * NULL for files and empty directories
2844 struct GNUNET_FS_ShareTreeItem *children_tail;
2847 * Metadata for this file or directory
2849 struct GNUNET_CONTAINER_MetaData *meta;
2852 * Keywords for this file or directory (derived from metadata).
2854 struct GNUNET_FS_Uri *ksk_uri;
2857 * Name of the file/directory
2862 * Base name of the file/directory.
2864 char *short_filename;
2867 * GNUNET_YES if this is a directory
2875 * Opaqe handle to an asynchronous directory scanning activity.
2877 struct GNUNET_FS_DirScanner;
2881 * Start a directory scanner.
2883 * @param filename name of the directory to scan
2884 * @param disable_extractor GNUNET_YES to not to run libextractor on files (only build a tree)
2885 * @param ex if not NULL, must be a list of extra plugins for extractor
2886 * @param cb the callback to call when there are scanning progress messages
2887 * @param cb_cls closure for 'cb'
2888 * @return directory scanner object to be used for controlling the scanner
2890 struct GNUNET_FS_DirScanner *
2891 GNUNET_FS_directory_scan_start (const char *filename,
2892 int disable_extractor,
2894 GNUNET_FS_DirScannerProgressCallback cb,
2899 * Abort the scan. Must not be called from within the progress_callback
2902 * @param ds directory scanner structure
2905 GNUNET_FS_directory_scan_abort (struct GNUNET_FS_DirScanner *ds);
2909 * Obtain the result of the scan after the scan has signalled
2910 * completion. Must not be called prior to completion. The 'ds' is
2911 * freed as part of this call.
2913 * @param ds directory scanner structure
2914 * @return the results of the scan (a directory tree)
2916 struct GNUNET_FS_ShareTreeItem *
2917 GNUNET_FS_directory_scan_get_result (struct GNUNET_FS_DirScanner *ds);
2921 * Process a share item tree, moving frequent keywords up and
2922 * copying frequent metadata up.
2924 * @param toplevel toplevel directory in the tree, returned by the scanner
2927 GNUNET_FS_share_tree_trim (struct GNUNET_FS_ShareTreeItem *toplevel);
2931 * Release memory of a share item tree.
2933 * @param toplevel toplevel of the tree to be freed
2936 GNUNET_FS_share_tree_free (struct GNUNET_FS_ShareTreeItem *toplevel);
2939 #if 0 /* keep Emacsens' auto-indent happy */