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 2, 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
26 * - extend API with support for publish simulation (-s)
27 * and URI-argument binding to keyword/namespace (-u)
29 #ifndef GNUNET_FS_LIB_H
30 #define GNUNET_FS_LIB_H
32 #include "gnunet_util_lib.h"
37 #if 0 /* keep Emacsens' auto-indent happy */
43 * Version number of the implementation.
46 * 1.x.x: initial version with triple GNUNET_hash and merkle tree
47 * 2.x.x: root node with mime-type, filename and version number
48 * 2.1.x: combined GNUNET_EC_ContentHashKey/3HASH encoding with 25:1 super-nodes
49 * 2.2.x: with directories
50 * 3.0.x: with namespaces
51 * 3.1.x: with namespace meta-data
52 * 3.2.x: with collections
53 * 4.0.x: with expiration, variable meta-data, kblocks
54 * 4.1.x: with new error and configuration handling
55 * 5.0.x: with location URIs
56 * 6.0.0: with support for OR in KSKs
57 * 6.1.x: with simplified namespace support
58 * 9.0.0: CPS-style integrated API
60 #define GNUNET_FS_VERSION 0x00090000
63 /* ******************** URI API *********************** */
65 #define GNUNET_FS_URI_PREFIX "gnunet://fs/"
66 #define GNUNET_FS_URI_KSK_INFIX "ksk/"
67 #define GNUNET_FS_URI_SKS_INFIX "sks/"
68 #define GNUNET_FS_URI_CHK_INFIX "chk/"
69 #define GNUNET_FS_URI_LOC_INFIX "loc/"
73 * A Universal Resource Identifier (URI), opaque.
79 * Iterator over keywords
82 * @param keyword the keyword
83 * @param is_mandatory is the keyword mandatory (in a search)
84 * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
86 typedef int (*GNUNET_FS_KeywordIterator) (void *cls,
91 * Get a unique key from a URI. This is for putting URIs
92 * into HashMaps. The key may change between FS implementations.
94 * @param uri uri to convert to a unique key
95 * @param key wherer to store the unique key
98 GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri,
99 GNUNET_HashCode * key);
102 * Convert a URI to a UTF-8 String.
104 * @param uri uri to convert to a string
105 * @return the UTF-8 string
108 GNUNET_FS_uri_to_string (const struct GNUNET_FS_Uri *uri);
111 * Convert keyword URI to a human readable format
112 * (i.e. the search query that was used in the first place)
114 * @param uri ksk uri to convert to a string
115 * @return string with the keywords
118 GNUNET_FS_uri_ksk_to_string_fancy (const struct GNUNET_FS_Uri *uri);
121 * Convert a UTF-8 String to a URI.
123 * @param uri string to parse
124 * @param emsg where to store the parser error message (if any)
125 * @return NULL on error
127 struct GNUNET_FS_Uri *
128 GNUNET_FS_uri_parse (const char *uri,
134 * @param uri uri to free
137 GNUNET_FS_uri_destroy (struct GNUNET_FS_Uri *uri);
141 * How many keywords are ANDed in this keyword URI?
143 * @param uri ksk uri to get the number of keywords from
144 * @return 0 if this is not a keyword URI
147 GNUNET_FS_uri_ksk_get_keyword_count (const struct GNUNET_FS_Uri *uri);
151 * Iterate over all keywords in this keyword URI.
153 * @param uri ksk uri to get the keywords from
154 * @param iterator function to call on each keyword
155 * @param iterator_cls closure for iterator
156 * @return -1 if this is not a keyword URI, otherwise number of
157 * keywords iterated over until iterator aborted
160 GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
161 GNUNET_FS_KeywordIterator iterator,
166 * Obtain the identity of the peer offering the data
168 * @param uri the location URI to inspect
169 * @param peer where to store the identify of the peer (presumably) offering the content
170 * @return GNUNET_SYSERR if this is not a location URI, otherwise GNUNET_OK
173 GNUNET_FS_uri_loc_get_peer_identity (const struct GNUNET_FS_Uri *uri,
174 struct GNUNET_PeerIdentity * peer);
178 * Obtain the URI of the content itself.
180 * @param uri location URI to get the content URI from
181 * @return NULL if argument is not a location URI
183 struct GNUNET_FS_Uri *
184 GNUNET_FS_uri_loc_get_uri (const struct GNUNET_FS_Uri *uri);
188 * Construct a location URI (this peer will be used for the location).
190 * @param baseURI content offered by the sender
191 * @param cfg configuration information (used to find our hostkey)
192 * @param expiration_time how long will the content be offered?
193 * @return the location URI, NULL on error
195 struct GNUNET_FS_Uri *
196 GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *baseUri,
197 struct GNUNET_CONFIGURATION_Handle *cfg,
198 struct GNUNET_TIME_Absolute expiration_time);
202 * Canonicalize keyword URI. Performs operations such
203 * as decapitalization and removal of certain characters.
204 * (useful for search).
206 * @param uri the URI to canonicalize
207 * @return canonicalized version of the URI, NULL on error
209 struct GNUNET_FS_Uri *
210 GNUNET_FS_uri_ksk_canonicalize (const struct GNUNET_FS_Uri *uri);
214 * Merge the sets of keywords from two KSK URIs.
215 * (useful for merging the canonicalized keywords with
216 * the original keywords for sharing).
218 * @param u1 first uri
219 * @param u2 second uri
220 * @return merged URI, NULL on error
222 struct GNUNET_FS_Uri *
223 GNUNET_FS_uri_ksk_merge (const struct GNUNET_FS_Uri *u1,
224 const struct GNUNET_FS_Uri *u2);
230 * @param uri the URI to duplicate
231 * @return copy of the URI
233 struct GNUNET_FS_Uri *
234 GNUNET_FS_uri_dup (const struct GNUNET_FS_Uri *uri);
238 * Create an FS URI from a single user-supplied string of keywords.
239 * The string is broken up at spaces into individual keywords.
240 * Keywords that start with "+" are mandatory. Double-quotes can
241 * be used to prevent breaking up strings at spaces (and also
242 * to specify non-mandatory keywords starting with "+").
244 * Keywords must contain a balanced number of double quotes and
245 * double quotes can not be used in the actual keywords (for
246 * example, the string '""foo bar""' will be turned into two
247 * "OR"ed keywords 'foo' and 'bar', not into '"foo bar"'.
249 * @param keywords the keyword string
250 * @param emsg where to store an error message
251 * @return an FS URI for the given keywords, NULL
252 * if keywords is not legal (i.e. empty).
254 struct GNUNET_FS_Uri *
255 GNUNET_FS_uri_ksk_create (const char *keywords,
260 * Create an FS URI from a user-supplied command line of keywords.
261 * Arguments should start with "+" to indicate mandatory
264 * @param argc number of keywords
265 * @param argv keywords (double quotes are not required for
266 * keywords containing spaces; however, double
267 * quotes are required for keywords starting with
268 * "+"); there is no mechanism for having double
269 * quotes in the actual keywords (if the user
270 * did specifically specify double quotes, the
271 * caller should convert each double quote
272 * into two single quotes).
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_from_args (unsigned int argc,
282 * Test if two URIs are equal.
284 * @param u1 one of the URIs
285 * @param u2 the other URI
286 * @return GNUNET_YES if the URIs are equal
289 GNUNET_FS_uri_test_equal (const struct GNUNET_FS_Uri *u1,
290 const struct GNUNET_FS_Uri *u2);
294 * Is this a namespace URI?
296 * @param uri the uri to check
297 * @return GNUNET_YES if this is an SKS uri
300 GNUNET_FS_uri_test_sks (const struct GNUNET_FS_Uri *uri);
304 * Get the ID of a namespace from the given
307 * @param uri the uri to get the namespace ID from
308 * @param nsid where to store the ID of the namespace
309 * @return GNUNET_OK on success
312 GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
313 GNUNET_HashCode * nsid);
317 * Get the content identifier of an SKS URI.
319 * @param uri the sks uri
320 * @return NULL on error (not a valid SKS URI)
323 GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri);
327 * Convert namespace URI to a human readable format
328 * (using the namespace description, if available).
330 * @param cfg configuration to use
331 * @param uri SKS uri to convert
332 * @return NULL on error (not an SKS URI)
335 GNUNET_FS_uri_sks_to_string_fancy (struct GNUNET_CONFIGURATION_Handle *cfg,
336 const struct GNUNET_FS_Uri *uri);
340 * Is this a keyword URI?
343 * @return GNUNET_YES if this is a KSK uri
346 GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri);
350 * Is this a file (or directory) URI?
352 * @param uri the uri to check
353 * @return GNUNET_YES if this is a CHK uri
356 GNUNET_FS_uri_test_chk (const struct GNUNET_FS_Uri *uri);
360 * What is the size of the file that this URI
363 * @param uri the CHK URI to inspect
364 * @return size of the file as specified in the CHK URI
367 GNUNET_FS_uri_chk_get_file_size (const struct GNUNET_FS_Uri *uri);
371 * Is this a location URI?
373 * @param uri the uri to check
374 * @return GNUNET_YES if this is a LOC uri
377 GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri);
381 * Construct a keyword-URI from meta-data (take all entries
382 * in the meta-data and construct one large keyword URI
383 * that lists all keywords that can be found in the meta-data).
386 struct GNUNET_FS_Uri *
387 GNUNET_FS_uri_ksk_create_from_meta_data (const struct GNUNET_CONTAINER_MetaData *md);
390 /* ******************** command-line option parsing API *********************** */
393 * Command-line option parser function that allows the user
394 * to specify one or more '-k' options with keywords. Each
395 * specified keyword will be added to the URI. A pointer to
396 * the URI must be passed as the "scls" argument.
398 * @param ctx command line processor context
399 * @param scls must be of type "struct GNUNET_FS_Uri **"
400 * @param option name of the option (typically 'k')
401 * @param value command line argument given
402 * @return GNUNET_OK on success
405 GNUNET_FS_getopt_set_keywords (struct GNUNET_GETOPT_CommandLineProcessorContext* ctx,
412 * Command-line option parser function that allows the user to specify
413 * one or more '-m' options with metadata. Each specified entry of
414 * the form "type=value" will be added to the metadata. A pointer to
415 * the metadata must be passed as the "scls" argument.
417 * @param ctx command line processor context
418 * @param scls must be of type "struct GNUNET_MetaData **"
419 * @param option name of the option (typically 'k')
420 * @param value command line argument given
421 * @return GNUNET_OK on success
424 GNUNET_FS_getopt_set_metadata (struct GNUNET_GETOPT_CommandLineProcessorContext* ctx,
431 /* ************************* sharing API ***************** */
435 * Possible status codes used in the callback for the
436 * various file-sharing operations. On each file (or search),
437 * the callback is guaranteed to be called once with "START"
438 * and once with STOPPED; calls with PROGRESS, ERROR or COMPLETED
439 * are optional and depend on the circumstances; parent operations
440 * will be STARTED before child-operations and STOPPED after
441 * their respective child-operations. START and STOP signals
442 * are typically generated either due to explicit client requests
443 * or because of suspend/resume operations.
445 enum GNUNET_FS_Status
448 * Notification that we have started to publish a file structure.
450 GNUNET_FS_STATUS_PUBLISH_START,
453 * Notification that we have resumed sharing a file structure.
455 GNUNET_FS_STATUS_PUBLISH_RESUME,
458 * Notification that we have suspended sharing a file structure.
460 GNUNET_FS_STATUS_PUBLISH_SUSPEND,
463 * Notification that we are making progress sharing a file structure.
465 GNUNET_FS_STATUS_PUBLISH_PROGRESS,
468 * Notification that an error was encountered sharing a file structure.
469 * The application will continue to receive resume/suspend events for
470 * this structure until "GNUNET_FS_publish_stop" is called.
472 GNUNET_FS_STATUS_PUBLISH_ERROR,
475 * Notification that we completed sharing a file structure.
476 * The application will continue to receive resume/suspend events for
477 * this structure until "GNUNET_FS_publish_stop" is called.
479 GNUNET_FS_STATUS_PUBLISH_COMPLETED,
482 * Notification that we have stopped
483 * the process of uploading a file structure; no
484 * futher events will be generated for this action.
486 GNUNET_FS_STATUS_PUBLISH_STOPPED,
489 * Notification that we have started this download.
491 GNUNET_FS_STATUS_DOWNLOAD_START,
494 * Notification that this download is being resumed.
496 GNUNET_FS_STATUS_DOWNLOAD_RESUME,
499 * Notification that this download was suspended.
501 GNUNET_FS_STATUS_DOWNLOAD_SUSPEND,
504 * Notification about progress with this download.
506 GNUNET_FS_STATUS_DOWNLOAD_PROGRESS,
509 * Notification that this download encountered an error.
511 GNUNET_FS_STATUS_DOWNLOAD_ERROR,
514 * Notification that this download completed. Note that for
515 * directories, completion does not imply completion of all files in
518 GNUNET_FS_STATUS_DOWNLOAD_COMPLETED,
521 * Notification that this download was stopped
522 * (final event with respect to this action).
524 GNUNET_FS_STATUS_DOWNLOAD_STOPPED,
527 * First event generated when a client requests
528 * a search to begin or when a namespace result
529 * automatically triggers the search for updates.
531 GNUNET_FS_STATUS_SEARCH_START,
534 * Last event when a search is being resumed;
535 * note that "GNUNET_FS_SEARCH_START" will not
536 * be generated in this case.
538 GNUNET_FS_STATUS_SEARCH_RESUME,
541 * Event generated for each search result
542 * when the respective search is resumed.
544 GNUNET_FS_STATUS_SEARCH_RESUME_RESULT,
547 * Last event when a search is being suspended;
548 * note that "GNUNET_FS_SEARCH_STOPPED" will not
549 * be generated in this case.
551 GNUNET_FS_STATUS_SEARCH_SUSPEND,
554 * Event generated for each search result
555 * when the respective search is suspended.
557 GNUNET_FS_STATUS_SEARCH_SUSPEND_RESULT,
560 * This search has yielded a result.
562 GNUNET_FS_STATUS_SEARCH_RESULT,
565 * We have discovered a new namespace.
567 GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE,
570 * We have additional data about the quality
571 * or availability of a search result.
573 GNUNET_FS_STATUS_SEARCH_UPDATE,
576 * Signals a problem with this search.
578 GNUNET_FS_STATUS_SEARCH_ERROR,
581 * Signals that this search was paused.
583 GNUNET_FS_STATUS_SEARCH_PAUSED,
586 * Signals that this search was continued (unpaused).
588 GNUNET_FS_STATUS_SEARCH_CONTINUED,
591 * Event generated for each search result
592 * when the respective search is stopped.
594 GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED,
597 * Last message from a search; this signals
598 * that there will be no further events associated
601 GNUNET_FS_STATUS_SEARCH_STOPPED,
604 * Notification that we started to unindex a file.
606 GNUNET_FS_STATUS_UNINDEX_START,
609 * Notification that we resumed unindexing of a file.
611 GNUNET_FS_STATUS_UNINDEX_RESUME,
614 * Notification that we suspended unindexing a file.
616 GNUNET_FS_STATUS_UNINDEX_SUSPEND,
619 * Notification that we made progress unindexing a file.
621 GNUNET_FS_STATUS_UNINDEX_PROGRESS,
624 * Notification that we encountered an error unindexing
627 GNUNET_FS_STATUS_UNINDEX_ERROR,
630 * Notification that the unindexing of this file
631 * was stopped (final event for this action).
633 GNUNET_FS_STATUS_UNINDEX_STOPPED
639 * Handle to one of our namespaces.
641 struct GNUNET_FS_Namespace;
645 * Handle for controlling an upload.
647 struct GNUNET_FS_PublishContext;
651 * Handle for controlling an unindexing operation.
653 struct GNUNET_FS_UnindexContext;
657 * Handle for controlling a search.
659 struct GNUNET_FS_SearchContext;
663 * Context for controlling a download.
665 struct GNUNET_FS_DownloadContext;
669 * Handle for detail information about a file that is being publishd.
670 * Specifies metadata, keywords, how to get the contents of the file
671 * (i.e. data-buffer in memory, filename on disk) and other options.
673 struct GNUNET_FS_FileInformation;
677 * Argument given to the progress callback with
678 * information about what is going on.
680 struct GNUNET_FS_ProgressInfo
684 * Values that depend on the event type.
689 * Values for all "GNUNET_FS_STATUS_PUBLISH_*" events.
694 * Context for controlling the upload.
696 struct GNUNET_FS_PublishContext *sc;
699 * Information about the file that is being publishd.
701 const struct GNUNET_FS_FileInformation *fi;
704 * Client context pointer (set the last time
705 * by the client for this operation; initially
706 * NULL on START/RESUME events).
711 * Client context pointer for the parent operation
712 * (if this is a file in a directory or a subdirectory).
717 * How large is the file overall? For directories,
718 * this is only the size of the directory itself,
719 * not of the other files contained within the
725 * At what time do we expect to finish the upload?
726 * (will be a value in the past for completed
729 struct GNUNET_TIME_Relative eta;
732 * How long has this upload been actively running
733 * (excludes times where the upload was suspended).
735 struct GNUNET_TIME_Relative duration;
738 * How many bytes have we completed?
743 * What anonymity level is used for this upload?
745 unsigned int anonymity;
748 * Additional values for specific events.
753 * These values are only valid for
754 * GNUNET_FS_STATUS_PUBLISH_PROGRESS events.
759 * Data block we just published.
764 * At what offset in the file is "data"?
769 * Length of the data block.
776 * These values are only valid for
777 * GNUNET_FS_STATUS_PUBLISH_RESUME events.
782 * Error message, NULL if no error was encountered so far.
787 * URI of the file (if the download had been completed)
789 const struct GNUNET_FS_Uri *chk_uri;
794 * These values are only valid for
795 * GNUNET_FS_STATUS_PUBLISH_COMPLETED events.
802 const struct GNUNET_FS_Uri *chk_uri;
807 * These values are only valid for
808 * GNUNET_FS_STATUS_PUBLISH_ERROR events.
813 * Error message, never NULL.
825 * Values for all "GNUNET_FS_STATUS_DOWNLOAD_*" events.
830 * Context for controlling the download.
832 struct GNUNET_FS_DownloadContext *dc;
835 * Client context pointer (set the last time
836 * by the client for this operation; initially
837 * NULL on START/RESUME events).
842 * Client context pointer for the parent operation
843 * (if this is a file in a directory or a subdirectory).
848 * URI used for this download.
850 const struct GNUNET_FS_Uri *uri;
853 * How large is the file overall? For directories,
854 * this is only the size of the directory itself,
855 * not of the other files contained within the
861 * At what time do we expect to finish the download?
862 * (will be a value in the past for completed
865 struct GNUNET_TIME_Relative eta;
868 * How long has this download been active?
870 struct GNUNET_TIME_Relative duration;
873 * How many bytes have we completed?
878 * What anonymity level is used for this download?
880 unsigned int anonymity;
883 * Additional values for specific events.
888 * These values are only valid for
889 * GNUNET_FS_STATUS_DOWNLOAD_PROGRESS events.
894 * Data block we just obtained.
899 * At what offset in the file is "data"?
904 * Length of the data block.
909 * Amount of trust we offered to get the block.
911 unsigned int trust_offered;
916 * These values are only valid for
917 * GNUNET_FS_STATUS_DOWNLOAD_START events.
922 * Known metadata for the download.
924 const struct GNUNET_MetaData *meta;
929 * These values are only valid for
930 * GNUNET_FS_STATUS_DOWNLOAD_RESUME events.
935 * Known metadata for the download.
937 const struct GNUNET_MetaData *meta;
940 * Error message, NULL if we have not encountered any error yet.
947 * These values are only valid for
948 * GNUNET_FS_STATUS_DOWNLOAD_ERROR events.
964 * Values for all "GNUNET_FS_STATUS_SEARCH_*" events.
969 * Context for controlling the search, NULL for
970 * searches that were not explicitly triggered
971 * by the client (i.e., searches for updates in
974 struct GNUNET_FS_SearchContext *sc;
977 * Client context pointer (set the last time by the client for
978 * this operation; initially NULL on START/RESUME events). Note
979 * that this value can only be set on START/RESUME; returning
980 * non-NULL on RESULT/RESUME_RESULT will actually update the
981 * private context for "UPDATE" events.
986 * Client parent-context pointer; NULL for top-level searches,
987 * non-NULL for automatically triggered searches for updates in
993 * What query is used for this search
994 * (list of keywords or SKS identifier).
996 const struct GNUNET_FS_Uri *query;
999 * How long has this search been actively running
1000 * (excludes times where the search was paused or
1003 struct GNUNET_TIME_Relative duration;
1006 * What anonymity level is used for this search?
1008 unsigned int anonymity;
1011 * How much trust have we been offering for this search
1014 unsigned int trust_offered;
1017 * Additional values for specific events.
1022 * These values are only valid for
1023 * GNUNET_FS_STATUS_SEARCH_RESULT events.
1028 * Metadata for the search result.
1030 const struct GNUNET_MetaData *meta;
1033 * URI for the search result.
1035 const struct GNUNET_FS_Uri *uri;
1040 * These values are only valid for
1041 * GNUNET_FS_STATUS_SEARCH_RESUME_RESULT events.
1046 * Metadata for the search result.
1048 const struct GNUNET_MetaData *meta;
1051 * URI for the search result.
1053 const struct GNUNET_FS_Uri *uri;
1056 * Current availability rank (negative:
1057 * unavailable, positive: available)
1059 int availability_rank;
1062 * On how many total queries is the given
1063 * availability_rank based?
1065 unsigned int availabiliy_certainty;
1068 * Updated applicability rank (the larger,
1069 * the better the result fits the search
1072 unsigned int applicabiliy_rank;
1077 * These values are only valid for
1078 * GNUNET_FS_STATUS_SEARCH_UPDATE events.
1083 * Private context set for for this result
1084 * during the "RESULT" event.
1089 * Metadata for the search result.
1091 const struct GNUNET_MetaData *meta;
1094 * URI for the search result.
1096 const struct GNUNET_FS_Uri *uri;
1099 * Current availability rank (negative:
1100 * unavailable, positive: available)
1102 int availability_rank;
1105 * On how many total queries is the given
1106 * availability_rank based?
1108 unsigned int availabiliy_certainty;
1111 * Updated applicability rank (the larger,
1112 * the better the result fits the search
1115 unsigned int applicabiliy_rank;
1120 * These values are only valid for
1121 * GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND events.
1122 * These events are automatically triggered for
1123 * each search result before the
1124 * GNUNET_FS_STATUS_SEARCH_SUSPEND event. This
1125 * happens primarily to give the client a chance
1126 * to clean up the "cctx" (if needed).
1131 * Private context set for for this result
1132 * during the "RESULT" event.
1137 * Metadata for the search result.
1139 const struct GNUNET_MetaData *meta;
1142 * URI for the search result.
1144 const struct GNUNET_FS_Uri *uri;
1149 * These values are only valid for
1150 * GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED events.
1151 * These events are automatically triggered for
1152 * each search result before the
1153 * GNUNET_FS_STATUS_SEARCH_STOPPED event. This
1154 * happens primarily to give the client a chance
1155 * to clean up the "cctx" (if needed).
1160 * Private context set for for this result
1161 * during the "RESULT" event.
1166 * Metadata for the search result.
1168 const struct GNUNET_MetaData *meta;
1171 * URI for the search result.
1173 const struct GNUNET_FS_Uri *uri;
1178 * These values are only valid for
1179 * GNUNET_FS_STATUS_SEARCH_RESUME events.
1184 * Error message, NULL if we have not encountered any error yet.
1186 const char *message;
1189 * Is this search currently paused?
1196 * These values are only valid for
1197 * GNUNET_FS_STATUS_SEARCH_ERROR events.
1204 const char *message;
1209 * Values for all "GNUNET_FS_STATUS_RESULT_NAMESPACE" events.
1214 * Handle to the namespace (NULL if it is not a local
1217 struct GNUNET_FS_Namespace *ns;
1220 * Short, human-readable name of the namespace.
1225 * Root identifier for the namespace, can be NULL.
1230 * Metadata for the namespace.
1232 const struct GNUNET_CONTAINER_MetaData *meta;
1235 * Hash-identifier for the namespace.
1246 * Values for all "GNUNET_FS_STATUS_UNINDEX_*" events.
1251 * Context for controlling the unindexing.
1253 struct GNUNET_FS_UnindexContext *uc;
1256 * Client context pointer (set the last time
1257 * by the client for this operation; initially
1258 * NULL on START/RESUME events).
1263 * Name of the file that is being unindexed.
1265 const char *filename;
1268 * How large is the file overall?
1273 * At what time do we expect to finish unindexing?
1274 * (will be a value in the past for completed
1275 * unindexing opeations).
1277 struct GNUNET_TIME_Relative eta;
1280 * How long has this upload been actively running
1281 * (excludes times where the upload was suspended).
1283 struct GNUNET_TIME_Relative duration;
1286 * How many bytes have we completed?
1291 * Additional values for specific events.
1296 * These values are only valid for
1297 * GNUNET_FS_STATUS_UNINDEX_PROGRESS events.
1302 * Data block we just unindexed.
1307 * At what offset in the file is "data"?
1312 * Length of the data block.
1319 * These values are only valid for
1320 * GNUNET_FS_STATUS_UNINDEX_RESUME events.
1325 * Error message, NULL if we have not encountered any error yet.
1327 const char *message;
1332 * These values are only valid for
1333 * GNUNET_FS_STATUS_UNINDEX_ERROR events.
1340 const char *message;
1351 * Specific status code (determines the event type).
1353 enum GNUNET_FS_Status status;
1359 * Notification of FS to a client about the progress of an
1360 * operation. Callbacks of this type will be used for uploads,
1361 * downloads and searches. Some of the arguments depend a bit
1362 * in their meaning on the context in which the callback is used.
1364 * @param cls closure
1365 * @param info details about the event, specifying the event type
1366 * and various bits about the event
1367 * @return client-context (for the next progress call
1368 * for this operation; should be set to NULL for
1369 * SUSPEND and STOPPED events). The value returned
1370 * will be passed to future callbacks in the respective
1371 * field in the GNUNET_FS_ProgressInfo struct.
1373 typedef void* (*GNUNET_FS_ProgressCallback)
1375 const struct GNUNET_FS_ProgressInfo *info);
1379 * Handle to the file-sharing service.
1381 struct GNUNET_FS_Handle;
1385 * Setup a connection to the file-sharing service.
1387 * @param sched scheduler to use
1388 * @param cfg configuration to use
1389 * @param client_name unique identifier for this client
1390 * @param upcb function to call to notify about FS actions
1391 * @param upcb_cls closure for upcb
1393 struct GNUNET_FS_Handle *
1394 GNUNET_FS_start (struct GNUNET_SCHEDULER_Handle *sched,
1395 const struct GNUNET_CONFIGURATION_Handle *cfg,
1396 const char *client_name,
1397 GNUNET_FS_ProgressCallback upcb,
1402 * Close our connection with the file-sharing service.
1403 * The callback given to GNUNET_FS_start will no longer be
1404 * called after this function returns.
1406 * @param h handle that was returned from GNUNET_FS_start
1409 GNUNET_FS_stop (struct GNUNET_FS_Handle *h);
1413 * Function called on entries in a GNUNET_FS_FileInformation publish-structure.
1415 * @param cls closure
1416 * @param fi the entry in the publish-structure
1417 * @param length length of the file or directory
1418 * @param meta metadata for the file or directory (can be modified)
1419 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1420 * @param anonymity pointer to selected anonymity level (can be modified)
1421 * @param priority pointer to selected priority (can be modified)
1422 * @param expirationTime pointer to selected expiration time (can be modified)
1423 * @param client_info pointer to client context set upon creation (can be modified)
1424 * @return GNUNET_OK to continue, GNUNET_NO to remove
1425 * this entry from the directory, GNUNET_SYSERR
1426 * to abort the iteration
1428 typedef int (*GNUNET_FS_FileInformationProcessor)(void *cls,
1429 struct GNUNET_FS_FileInformation *fi,
1431 struct GNUNET_CONTAINER_MetaData *meta,
1432 struct GNUNET_FS_Uri **uri,
1433 unsigned int *anonymity,
1434 unsigned int *priority,
1435 struct GNUNET_TIME_Absolute *expirationTime,
1436 void **client_info);
1440 * Recover file information structure from disk.
1442 * @param name filename for the structure on disk
1443 * @return NULL on error
1445 struct GNUNET_FS_FileInformation *
1446 GNUNET_FS_file_information_recover (const char *name);
1450 * Obtain the name under which this file information
1451 * structure is stored on disk. Only works for top-level
1452 * file information structures.
1454 * @param s structure to get the filename for
1455 * @return NULL on error, otherwise filename that
1456 * can be passed to "GNUNET_FS_file_information_recover"
1457 * to read this fi-struct from disk.
1460 GNUNET_FS_file_information_get_id (struct GNUNET_FS_FileInformation *s);
1464 * Synchronize this file-information struct with its mirror
1465 * on disk. Note that all internal FS-operations that change
1466 * file information data should already call "sync" internally,
1467 * so this function is likely not useful for clients.
1469 * @param s the struct to sync
1472 GNUNET_FS_file_information_sync (struct GNUNET_FS_FileInformation *s);
1476 * Create an entry for a file in a publish-structure.
1478 * @param filename name of the file or directory to publish
1479 * @param keywords under which keywords should this file be available
1480 * directly; can be NULL
1481 * @param meta metadata for the file
1482 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1483 * GNUNET_SYSERR for simulation
1484 * @param anonymity what is the desired anonymity level for sharing?
1485 * @param priority what is the priority for OUR node to
1486 * keep this file available? Use 0 for maximum anonymity and
1487 * minimum reliability...
1488 * @param expirationTime when should this content expire?
1489 * @return publish structure entry for the file
1491 struct GNUNET_FS_FileInformation *
1492 GNUNET_FS_file_information_create_from_file (void *client_info,
1493 const char *filename,
1494 const struct GNUNET_FS_Uri *keywords,
1495 const struct GNUNET_CONTAINER_MetaData *meta,
1497 unsigned int anonymity,
1498 unsigned int priority,
1499 struct GNUNET_TIME_Absolute expirationTime);
1503 * Create an entry for a file in a publish-structure.
1505 * @param length length of the file
1506 * @param data data for the file (should not be used afterwards by
1507 * the caller; caller will "free")
1508 * @param keywords under which keywords should this file be available
1509 * directly; can be NULL
1510 * @param meta metadata for the file
1511 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1512 * GNUNET_SYSERR for simulation
1513 * @param anonymity what is the desired anonymity level for sharing?
1514 * @param priority what is the priority for OUR node to
1515 * keep this file available? Use 0 for maximum anonymity and
1516 * minimum reliability...
1517 * @param expirationTime when should this content expire?
1518 * @return publish structure entry for the file
1520 struct GNUNET_FS_FileInformation *
1521 GNUNET_FS_file_information_create_from_data (void *client_info,
1524 const struct GNUNET_FS_Uri *keywords,
1525 const struct GNUNET_CONTAINER_MetaData *meta,
1527 unsigned int anonymity,
1528 unsigned int priority,
1529 struct GNUNET_TIME_Absolute expirationTime);
1533 * Function that provides data.
1535 * @param cls closure
1536 * @param offset offset to read from; it is possible
1537 * that the caller might need to go backwards
1539 * @param max maximum number of bytes that should be
1540 * copied to buf; readers are not allowed
1541 * to provide less data unless there is an error;
1542 * a value of "0" will be used at the end to allow
1543 * the reader to clean up its internal state
1544 * @param buf where the reader should write the data
1545 * @param emsg location for the reader to store an error message
1546 * @return number of bytes written, usually "max", 0 on error
1548 typedef size_t (*GNUNET_FS_DataReader)(void *cls,
1556 * Create an entry for a file in a publish-structure.
1558 * @param length length of the file
1559 * @param reader function that can be used to obtain the data for the file
1560 * @param reader_cls closure for "reader"
1561 * @param keywords under which keywords should this file be available
1562 * directly; can be NULL
1563 * @param meta metadata for the file
1564 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1565 * GNUNET_SYSERR for simulation
1566 * @param anonymity what is the desired anonymity level for sharing?
1567 * @param priority what is the priority for OUR node to
1568 * keep this file available? Use 0 for maximum anonymity and
1569 * minimum reliability...
1570 * @param expirationTime when should this content expire?
1571 * @return publish structure entry for the file
1573 struct GNUNET_FS_FileInformation *
1574 GNUNET_FS_file_information_create_from_reader (void *client_info,
1576 GNUNET_FS_DataReader reader,
1578 const struct GNUNET_FS_Uri *keywords,
1579 const struct GNUNET_CONTAINER_MetaData *meta,
1581 unsigned int anonymity,
1582 unsigned int priority,
1583 struct GNUNET_TIME_Absolute expirationTime);
1587 * Function that a "GNUNET_FS_DirectoryScanner" should call
1588 * for each entry in the directory.
1590 * @param cls closure
1591 * @param filename name of the file (including path); must end
1592 * in a "/" (even on W32) if this is a directory
1593 * @param fi information about the file (should not be
1594 * used henceforth by the caller)
1596 typedef void (*GNUNET_FS_FileProcessor)(void *cls,
1597 const char *filename,
1598 struct GNUNET_FS_FileInformation *fi);
1602 * Type of a function that will be used to scan a directory.
1604 * @param cls closure
1605 * @param dirname name of the directory to scan
1606 * @param do_index should files be indexed or inserted
1607 * @param anonymity desired anonymity level
1608 * @param priority priority for publishing
1609 * @param expirationTime expiration for publication
1610 * @param proc function to call on each entry
1611 * @param proc_cls closure for proc
1612 * @param emsg where to store an error message (on errors)
1613 * @return GNUNET_OK on success
1615 typedef int (*GNUNET_FS_DirectoryScanner)(void *cls,
1616 const char *dirname,
1618 unsigned int anonymity,
1619 unsigned int priority,
1620 struct GNUNET_TIME_Absolute expirationTime,
1621 GNUNET_FS_FileProcessor proc,
1628 * Simple, useful default implementation of a directory scanner
1629 * (GNUNET_FS_DirectoryScanner). This implementation expects to get a
1630 * UNIX filename, will publish all files in the directory except hidden
1631 * files (those starting with a "."). Metadata will be extracted
1632 * using GNU libextractor; the specific list of plugins should be
1633 * specified in "cls", passing NULL will disable (!) metadata
1634 * extraction. Keywords will be derived from the metadata and be
1635 * subject to default canonicalization. This is strictly a
1636 * convenience function.
1638 * @param cls must be of type "struct EXTRACTOR_Extractor*"
1639 * @param dirname name of the directory to scan
1640 * @param do_index should files be indexed or inserted
1641 * @param anonymity desired anonymity level
1642 * @param priority priority for publishing
1643 * @param expirationTime expiration for publication
1644 * @param proc function called on each entry
1645 * @param proc_cls closure for proc
1646 * @param emsg where to store an error message (on errors)
1647 * @return GNUNET_OK on success
1650 GNUNET_FS_directory_scanner_default (void *cls,
1651 const char *dirname,
1653 unsigned int anonymity,
1654 unsigned int priority,
1655 struct GNUNET_TIME_Absolute expirationTime,
1656 GNUNET_FS_FileProcessor proc,
1662 * Create a publish-structure from an existing file hierarchy, inferring
1663 * and organizing keywords and metadata as much as possible. This
1664 * function primarily performs the recursive build and re-organizes
1665 * keywords and metadata; for automatically getting metadata
1666 * extraction, scanning of directories and creation of the respective
1667 * GNUNET_FS_FileInformation entries the default scanner should be
1668 * passed (GNUNET_FS_directory_scanner_default). This is strictly a
1669 * convenience function.
1671 * @param filename name of the top-level file or directory
1672 * @param scanner function used to get a list of files in a directory
1673 * @param scanner_cls closure for scanner
1674 * @param do_index should files in the hierarchy be indexed?
1675 * @param anonymity what is the desired anonymity level for sharing?
1676 * @param priority what is the priority for OUR node to
1677 * keep this file available? Use 0 for maximum anonymity and
1678 * minimum reliability...
1679 * @param expirationTime when should this content expire?
1680 * @param emsg where to store an error message
1681 * @return publish structure entry for the directory, NULL on error
1683 struct GNUNET_FS_FileInformation *
1684 GNUNET_FS_file_information_create_from_directory (void *client_info,
1685 const char *filename,
1686 GNUNET_FS_DirectoryScanner scanner,
1689 unsigned int anonymity,
1690 unsigned int priority,
1691 struct GNUNET_TIME_Absolute expirationTime,
1696 * Create an entry for an empty directory in a publish-structure.
1697 * This function should be used by applications for which the
1698 * use of "GNUNET_FS_file_information_create_from_directory"
1699 * is not appropriate.
1701 * @param meta metadata for the directory
1702 * @param keywords under which keywords should this directory be available
1703 * directly; can be NULL
1704 * @param anonymity what is the desired anonymity level for sharing?
1705 * @param priority what is the priority for OUR node to
1706 * keep this file available? Use 0 for maximum anonymity and
1707 * minimum reliability...
1708 * @param expirationTime when should this content expire?
1709 * @return publish structure entry for the directory , NULL on error
1711 struct GNUNET_FS_FileInformation *
1712 GNUNET_FS_file_information_create_empty_directory (void *client_info,
1713 const struct GNUNET_CONTAINER_MetaData *meta,
1714 const struct GNUNET_FS_Uri *keywords,
1715 unsigned int anonymity,
1716 unsigned int priority,
1717 struct GNUNET_TIME_Absolute expirationTime);
1721 * Add an entry to a directory in a publish-structure. Clients
1722 * should never modify publish structures that were passed to
1723 * "GNUNET_FS_publish_start" already.
1725 * @param dir the directory
1726 * @param end the entry to add; the entry must not have been
1727 * added to any other directory at this point and
1728 * must not include "dir" in its structure
1729 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1732 GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
1733 struct GNUNET_FS_FileInformation *end);
1737 * Inspect a file or directory in a publish-structure. Clients
1738 * should never modify publish structures that were passed to
1739 * "GNUNET_FS_publish_start" already. When called on a directory,
1740 * this function will FIRST call "proc" with information about
1741 * the directory itself and then for each of the files in the
1742 * directory (but not for files in subdirectories). When called
1743 * on a file, "proc" will be called exactly once (with information
1744 * about the specific file).
1746 * @param dir the directory
1747 * @param proc function to call on each entry
1748 * @param proc_cls closure for proc
1751 GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir,
1752 GNUNET_FS_FileInformationProcessor proc,
1757 * Destroy publish-structure. Clients should never destroy publish
1758 * structures that were passed to "GNUNET_FS_publish_start" already.
1760 * @param fi structure to destroy
1761 * @param cleaner function to call on each entry in the structure
1762 * (useful to clean up client_info); can be NULL; return
1763 * values are ignored
1764 * @param cleaner_cls closure for cleaner
1767 GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi,
1768 GNUNET_FS_FileInformationProcessor cleaner,
1773 * Options for publishing. Compatible options
1774 * can be OR'ed together.
1776 enum GNUNET_FS_PublishOptions
1779 * No options (use defaults for everything).
1781 GNUNET_FS_PUBLISH_OPTION_NONE = 0,
1784 * Simulate publishing. With this option, no data will be stored
1785 * in the datastore. Useful for computing URIs from files.
1787 GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY = 1
1791 * Publish a file or directory.
1793 * @param h handle to the file sharing subsystem
1794 * @param ctx initial value to use for the '*ctx'
1795 * in the callback (for the GNUNET_FS_STATUS_PUBLISH_START event).
1796 * @param fi information about the file or directory structure to publish
1797 * @param namespace namespace to publish the file in, NULL for no namespace
1798 * @param nid identifier to use for the publishd content in the namespace
1799 * (can be NULL, must be NULL if namespace is NULL)
1800 * @param nuid update-identifier that will be used for future updates
1801 * (can be NULL, must be NULL if namespace or nid is NULL)
1802 * @param options options for the publication
1803 * @return context that can be used to control the publish operation
1805 struct GNUNET_FS_PublishContext *
1806 GNUNET_FS_publish_start (struct GNUNET_FS_Handle *h,
1808 struct GNUNET_FS_FileInformation *fi,
1809 struct GNUNET_FS_Namespace *namespace,
1812 enum GNUNET_FS_PublishOptions options);
1816 * Stop an upload. Will abort incomplete uploads (but
1817 * not remove blocks that have already been publishd) or
1818 * simply clean up the state for completed uploads.
1820 * @param sc context for the upload to stop
1823 GNUNET_FS_publish_stop (struct GNUNET_FS_PublishContext *sc);
1827 * Signature of a function called as the continuation of a KBlock or
1828 * SBlock publication.
1830 * @param cls closure
1831 * @param uri URI under which the block is now available, NULL on error
1832 * @param emsg error message, NULL on success
1834 typedef void (*GNUNET_FS_PublishContinuation)(void *cls,
1835 const struct GNUNET_FS_Uri *uri,
1840 * Publish a KBlock on GNUnet.
1842 * @param h handle to the file sharing subsystem
1843 * @param keywords keywords to use
1844 * @param meta metadata to use
1845 * @param uri URI to refer to in the KBlock
1846 * @param expirationTime when the KBlock expires
1847 * @param anonymity anonymity level for the KBlock
1848 * @param priority priority for the KBlock
1849 * @param cont continuation
1850 * @param cont_cls closure for cont
1853 GNUNET_FS_publish_ksk (struct GNUNET_FS_Handle *h,
1854 struct GNUNET_FS_Uri *keywords,
1855 struct GNUNET_CONTAINER_MetaData *meta,
1856 struct GNUNET_FS_Uri *uri,
1857 struct GNUNET_TIME_Absolute expirationTime,
1858 unsigned int anonymity,
1859 unsigned int priority,
1860 enum GNUNET_FS_PublishOptions options,
1861 GNUNET_FS_PublishContinuation cont,
1866 * Publish an SBlock on GNUnet.
1868 * @param h handle to the file sharing subsystem
1869 * @param namespace namespace to publish in
1870 * @param identifier identifier to use
1871 * @param update update identifier to use
1872 * @param meta metadata to use
1873 * @param uri URI to refer to in the SBlock
1874 * @param expirationTime when the SBlock expires
1875 * @param anonymity anonymity level for the SBlock
1876 * @param priority priority for the SBlock
1877 * @param cont continuation
1878 * @param cont_cls closure for cont
1881 GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
1882 struct GNUNET_FS_Namespace *namespace,
1883 const char *identifier,
1885 struct GNUNET_CONTAINER_MetaData *meta,
1886 struct GNUNET_FS_Uri *uri,
1887 struct GNUNET_TIME_Absolute expirationTime,
1888 unsigned int anonymity,
1889 unsigned int priority,
1890 enum GNUNET_FS_PublishOptions options,
1891 GNUNET_FS_PublishContinuation cont,
1896 * Type of a function called by "GNUNET_FS_get_indexed_files".
1898 * @param cls closure
1899 * @param filename the name of the file
1900 * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
1902 typedef int (*GNUNET_FS_IndexedFileProcessor) (void *cls,
1903 const char *filename);
1907 * Iterate over all indexed files.
1909 * @param h handle to the file sharing subsystem
1910 * @param iterator function to call on each indexed file
1911 * @param iterator_cls closure for iterator
1914 GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
1915 GNUNET_FS_IndexedFileProcessor iterator,
1916 void *iterator_cls);
1922 * @param h handle to the file sharing subsystem
1923 * @param filename file to unindex
1924 * @return NULL on error, otherwise handle
1926 struct GNUNET_FS_UnindexContext *
1927 GNUNET_FS_unindex (struct GNUNET_FS_Handle *h,
1928 const char *filename);
1932 * Clean up after completion of an unindex operation.
1937 GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc);
1941 * Publish an advertismement for a namespace.
1943 * @param h handle to the file sharing subsystem
1944 * @param namespace handle for the namespace that should be advertised
1945 * @param meta meta-data for the namespace advertisement
1946 * @param anonymity for the namespace advertismement
1947 * @param priority for the namespace advertisement
1948 * @param expiration for the namespace advertisement
1949 * @param advertisementURI the keyword (!) URI to advertise the
1950 * namespace under (we will create a GNUNET_EC_KNBlock)
1951 * @param rootEntry name of the root entry in the namespace (for
1952 * the namespace advertisement)
1954 * @return uri of the advertisement
1956 struct GNUNET_FS_Uri *
1957 GNUNET_FS_namespace_advertise (struct GNUNET_FS_Handle *h,
1958 struct GNUNET_FS_Namespace *namespace,
1959 const struct GNUNET_MetaData *meta,
1960 unsigned int anonymity,
1961 unsigned int priority,
1962 struct GNUNET_TIME_Absolute expiration,
1963 const struct GNUNET_FS_Uri *advertisementURI,
1964 const char *rootEntry);
1968 * Create a namespace with the given name; if one already
1969 * exists, return a handle to the existing namespace.
1971 * @param h handle to the file sharing subsystem
1972 * @param name name to use for the namespace
1973 * @return handle to the namespace, NULL on error
1975 struct GNUNET_FS_Namespace *
1976 GNUNET_FS_namespace_create (struct GNUNET_FS_Handle *h,
1981 * Delete a namespace handle. Can be used for a clean shutdown (free
1982 * memory) or also to freeze the namespace to prevent further
1983 * insertions by anyone.
1985 * @param namespace handle to the namespace that should be deleted / freed
1986 * @param freeze prevents future insertions; creating a namespace
1987 * with the same name again will create a fresh namespace instead
1989 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1992 GNUNET_FS_namespace_delete (struct GNUNET_FS_Namespace *namespace,
1997 * Callback with information about local (!) namespaces.
1998 * Contains the names of the local namespace and the global
2001 * @param cls closure
2002 * @param name human-readable identifier of the namespace
2003 * @param id hash identifier for the namespace
2005 typedef void (*GNUNET_FS_NamespaceInfoProcessor) (void *cls,
2007 const GNUNET_HashCode *id);
2011 * Build a list of all available local (!) namespaces The returned
2012 * names are only the nicknames since we only iterate over the local
2015 * @param h handle to the file sharing subsystem
2016 * @param cb function to call on each known namespace
2017 * @param cb_cls closure for cb
2020 GNUNET_FS_namespace_list (struct GNUNET_FS_Handle *h,
2021 GNUNET_FS_NamespaceInfoProcessor cb,
2026 * Function called on updateable identifiers.
2028 * @param cls closure
2029 * @param last_id last identifier
2030 * @param last_uri uri used for the content published under the last_id
2031 * @param last_meta metadata associated with last_uri
2032 * @param next_id identifier that should be used for updates
2035 (*GNUNET_FS_IdentifierProcessor)(void *cls,
2036 const char *last_id,
2037 const struct GNUNET_FS_Uri *last_uri,
2038 const struct GNUNET_CONTAINER_MetaData *last_meta,
2039 const char *next_id);
2043 * List all of the identifiers in the namespace for
2044 * which we could produce an update.
2046 * @param namespace namespace to inspect for updateable content
2047 * @param ip function to call on each updateable identifier
2048 * @param ip_cls closure for ip
2051 GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Namespace *namespace,
2052 GNUNET_FS_IdentifierProcessor ip,
2057 * Start search for content.
2059 * @param h handle to the file sharing subsystem
2060 * @param uri specifies the search parameters; can be
2061 * a KSK URI or an SKS URI.
2062 * @param anonymity desired level of anonymity
2063 * @return context that can be used to control the search
2065 struct GNUNET_FS_SearchContext *
2066 GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
2067 const struct GNUNET_FS_Uri *uri,
2068 unsigned int anonymity);
2074 * @param sc context for the search that should be paused
2077 GNUNET_FS_search_pause (struct GNUNET_FS_SearchContext *sc);
2081 * Continue paused search.
2083 * @param sc context for the search that should be resumed
2086 GNUNET_FS_search_continue (struct GNUNET_FS_SearchContext *sc);
2090 * Stop search for content.
2092 * @param sc context for the search that should be stopped
2095 GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc);
2099 * Download parts of a file. Note that this will store
2100 * the blocks at the respective offset in the given file. Also, the
2101 * download is still using the blocking of the underlying FS
2102 * encoding. As a result, the download may *write* outside of the
2103 * given boundaries (if offset and length do not match the 32k FS
2104 * block boundaries). <p>
2106 * This function should be used to focus a download towards a
2107 * particular portion of the file (optimization), not to strictly
2108 * limit the download to exactly those bytes.
2110 * @param h handle to the file sharing subsystem
2111 * @param uri the URI of the file (determines what to download); CHK or LOC URI
2112 * @param filename where to store the file, maybe NULL (then no file is
2113 * created on disk and data must be grabbed from the callbacks)
2114 * @param offset at what offset should we start the download (typically 0)
2115 * @param length how many bytes should be downloaded starting at offset
2116 * @param anonymity anonymity level to use for the download
2117 * @param no_temporaries set to GNUNET_YES to disallow generation of temporary files
2118 * @param recursive should this be a recursive download (useful for directories
2119 * to automatically trigger download of files in the directories)
2120 * @param parent parent download to associate this download with (use NULL
2121 * for top-level downloads; useful for manually-triggered recursive downloads)
2122 * @return context that can be used to control this download
2124 struct GNUNET_FS_DownloadContext *
2125 GNUNET_FS_file_download_start (struct GNUNET_FS_Handle *h,
2126 const struct GNUNET_FS_Uri *uri,
2127 const char *filename,
2128 unsigned long long offset,
2129 unsigned long long length,
2130 unsigned int anonymity,
2133 struct GNUNET_FS_DownloadContext *parent);
2137 * Stop a download (aborts if download is incomplete).
2139 * @param rm handle for the download
2140 * @param do_delete delete files of incomplete downloads
2143 GNUNET_FS_file_download_stop (struct GNUNET_FS_DownloadContext *rm,
2148 * Initialize collection.
2150 * @param h handle to the file sharing subsystem
2151 * @param namespace namespace to use for the collection
2152 * @return GNUNET_OK on success, GNUNET_SYSERR if another
2153 * namespace is already set for our collection
2156 GNUNET_FS_collection_start (struct GNUNET_FS_Handle *h,
2157 struct GNUNET_FS_Namespace *namespace);
2163 * @param h handle to the file sharing subsystem
2164 * @return GNUNET_OK on success, GNUNET_SYSERR if no collection is active
2167 GNUNET_FS_collection_stop (struct GNUNET_FS_Handle *h);
2171 * Are we using a collection?
2173 * @param h handle to the file sharing subsystem
2174 * @return NULL if there is no collection,
2176 struct GNUNET_FS_Namespace *
2177 GNUNET_FS_collection_get(struct GNUNET_FS_Handle *h);
2181 * Publish an update of the current collection information to the
2182 * network now. The function has no effect if the collection has not
2183 * changed since the last publication. If we are currently not
2184 * collecting, this function does nothing.
2186 * @param h handle to the file sharing subsystem
2188 void GNUNET_FS_collection_publish (struct GNUNET_FS_Handle *h);
2192 * If we are currently building a collection, publish the given file
2193 * information in that collection. If we are currently not
2194 * collecting, this function does nothing.
2196 * @param h handle to the file sharing subsystem
2197 * @param uri uri to add to the collection
2198 * @param meta metadata for the uri
2200 void GNUNET_FS_collection_add (const struct GNUNET_FS_Handle *h,
2201 const struct GNUNET_FS_Uri *uri,
2202 const struct GNUNET_CONTAINER_MetaData *meta);
2208 /* ******************** Directory API *********************** */
2211 #define GNUNET_FS_DIRECTORY_MIME "application/gnunet-directory"
2212 #define GNUNET_FS_DIRECTORY_MAGIC "\211GND\r\n\032\n"
2213 #define GNUNET_FS_DIRECTORY_EXT ".gnd"
2216 * Does the meta-data claim that this is a directory?
2217 * Checks if the mime-type is that of a GNUnet directory.
2219 * @return GNUNET_YES if it is, GNUNET_NO if it is not, GNUNET_SYSERR if
2220 * we have no mime-type information (treat as 'GNUNET_NO')
2223 GNUNET_FS_meta_data_test_for_directory (const struct GNUNET_CONTAINER_MetaData *md);
2227 * Set the MIMETYPE information for the given
2228 * metadata to "application/gnunet-directory".
2230 * @param md metadata to add mimetype to
2233 GNUNET_FS_meta_data_make_directory (struct GNUNET_CONTAINER_MetaData *md);
2237 * Function used to process entries in a directory.
2239 * @param cls closure
2240 * @param filename name of the file in the directory
2241 * @param uri URI of the file
2242 * @param metadata metadata for the file; metadata for
2243 * the directory if everything else is NULL/zero
2244 * @param length length of the available data for the file
2245 * (of type size_t since data must certainly fit
2246 * into memory; if files are larger than size_t
2247 * permits, then they will certainly not be
2248 * embedded with the directory itself).
2249 * @param data data available for the file (length bytes)
2251 typedef void (*GNUNET_FS_DirectoryEntryProcessor)(void *cls,
2252 const char *filename,
2253 const struct GNUNET_FS_Uri *uri,
2254 const struct GNUNET_CONTAINER_MetaData *meta,
2260 * Iterate over all entries in a directory. Note that directories
2261 * are structured such that it is possible to iterate over the
2262 * individual blocks as well as over the entire directory. Thus
2263 * a client can call this function on the buffer in the
2264 * GNUNET_FS_ProgressCallback. Also, directories can optionally
2265 * include the contents of (small) files embedded in the directory
2266 * itself; for those files, the processor may be given the
2267 * contents of the file directly by this function.
2269 * @param size number of bytes in data
2270 * @param data pointer to the beginning of the directory
2271 * @param offset offset of data in the directory
2272 * @param dep function to call on each entry
2273 * @param dep_cls closure for dep
2276 GNUNET_FS_directory_list_contents (size_t size,
2279 GNUNET_FS_DirectoryEntryProcessor dep,
2284 * Opaque handle to a directory builder.
2286 struct GNUNET_FS_DirectoryBuilder;
2289 * Create a directory builder.
2291 * @param mdir metadata for the directory
2293 struct GNUNET_FS_DirectoryBuilder *
2294 GNUNET_FS_directory_builder_create (const struct GNUNET_CONTAINER_MetaData *mdir);
2298 * Add an entry to a directory.
2300 * @param bld directory to extend
2301 * @param uri uri of the entry (must not be a KSK)
2302 * @param md metadata of the entry
2303 * @param data raw data of the entry, can be NULL, otherwise
2304 * data must point to exactly the number of bytes specified
2308 GNUNET_FS_directory_builder_add (struct GNUNET_FS_DirectoryBuilder *bld,
2309 const struct GNUNET_FS_Uri *uri,
2310 const struct GNUNET_CONTAINER_MetaData *md,
2315 * Finish building the directory. Frees the
2316 * builder context and returns the directory
2319 * @param bld directory to finish
2320 * @param size set to the number of bytes needed
2321 * @param data set to the encoded directory
2324 GNUNET_FS_directory_builder_finish (struct GNUNET_FS_DirectoryBuilder *bld,
2329 #if 0 /* keep Emacsens' auto-indent happy */