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_Absolute 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.
789 * These values are only valid for
790 * GNUNET_FS_STATUS_PUBLISH_ERROR events.
795 * Error message, never NULL.
807 * Values for all "GNUNET_FS_STATUS_DOWNLOAD_*" events.
812 * Context for controlling the download.
814 struct GNUNET_FS_DownloadContext *dc;
817 * Client context pointer (set the last time
818 * by the client for this operation; initially
819 * NULL on START/RESUME events).
824 * Client context pointer for the parent operation
825 * (if this is a file in a directory or a subdirectory).
830 * URI used for this download.
832 const struct GNUNET_FS_Uri *uri;
835 * How large is the file overall? For directories,
836 * this is only the size of the directory itself,
837 * not of the other files contained within the
843 * At what time do we expect to finish the download?
844 * (will be a value in the past for completed
847 struct GNUNET_TIME_Absolute eta;
850 * How long has this download been active?
852 struct GNUNET_TIME_Relative duration;
855 * How many bytes have we completed?
860 * What anonymity level is used for this download?
862 unsigned int anonymity;
865 * Additional values for specific events.
870 * These values are only valid for
871 * GNUNET_FS_STATUS_DOWNLOAD_PROGRESS events.
876 * Data block we just obtained.
881 * At what offset in the file is "data"?
886 * Length of the data block.
891 * Amount of trust we offered to get the block.
893 unsigned int trust_offered;
898 * These values are only valid for
899 * GNUNET_FS_STATUS_DOWNLOAD_START events.
904 * Known metadata for the download.
906 const struct GNUNET_MetaData *meta;
911 * These values are only valid for
912 * GNUNET_FS_STATUS_DOWNLOAD_RESUME events.
917 * Known metadata for the download.
919 const struct GNUNET_MetaData *meta;
922 * Error message, NULL if we have not encountered any error yet.
929 * These values are only valid for
930 * GNUNET_FS_STATUS_DOWNLOAD_ERROR events.
946 * Values for all "GNUNET_FS_STATUS_SEARCH_*" events.
951 * Context for controlling the search, NULL for
952 * searches that were not explicitly triggered
953 * by the client (i.e., searches for updates in
956 struct GNUNET_FS_SearchContext *sc;
959 * Client context pointer (set the last time by the client for
960 * this operation; initially NULL on START/RESUME events). Note
961 * that this value can only be set on START/RESUME; returning
962 * non-NULL on RESULT/RESUME_RESULT will actually update the
963 * private context for "UPDATE" events.
968 * Client parent-context pointer; NULL for top-level searches,
969 * non-NULL for automatically triggered searches for updates in
975 * What query is used for this search
976 * (list of keywords or SKS identifier).
978 const struct GNUNET_FS_Uri *query;
981 * How long has this search been actively running
982 * (excludes times where the search was paused or
985 struct GNUNET_TIME_Relative duration;
988 * What anonymity level is used for this search?
990 unsigned int anonymity;
993 * How much trust have we been offering for this search
996 unsigned int trust_offered;
999 * Additional values for specific events.
1004 * These values are only valid for
1005 * GNUNET_FS_STATUS_SEARCH_RESULT events.
1010 * Metadata for the search result.
1012 const struct GNUNET_MetaData *meta;
1015 * URI for the search result.
1017 const struct GNUNET_FS_Uri *uri;
1022 * These values are only valid for
1023 * GNUNET_FS_STATUS_SEARCH_RESUME_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;
1038 * Current availability rank (negative:
1039 * unavailable, positive: available)
1041 int availability_rank;
1044 * On how many total queries is the given
1045 * availability_rank based?
1047 unsigned int availabiliy_certainty;
1050 * Updated applicability rank (the larger,
1051 * the better the result fits the search
1054 unsigned int applicabiliy_rank;
1059 * These values are only valid for
1060 * GNUNET_FS_STATUS_SEARCH_UPDATE events.
1065 * Private context set for for this result
1066 * during the "RESULT" event.
1071 * Metadata for the search result.
1073 const struct GNUNET_MetaData *meta;
1076 * URI for the search result.
1078 const struct GNUNET_FS_Uri *uri;
1081 * Current availability rank (negative:
1082 * unavailable, positive: available)
1084 int availability_rank;
1087 * On how many total queries is the given
1088 * availability_rank based?
1090 unsigned int availabiliy_certainty;
1093 * Updated applicability rank (the larger,
1094 * the better the result fits the search
1097 unsigned int applicabiliy_rank;
1102 * These values are only valid for
1103 * GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND events.
1104 * These events are automatically triggered for
1105 * each search result before the
1106 * GNUNET_FS_STATUS_SEARCH_SUSPEND event. This
1107 * happens primarily to give the client a chance
1108 * to clean up the "cctx" (if needed).
1113 * Private context set for for this result
1114 * during the "RESULT" event.
1119 * Metadata for the search result.
1121 const struct GNUNET_MetaData *meta;
1124 * URI for the search result.
1126 const struct GNUNET_FS_Uri *uri;
1131 * These values are only valid for
1132 * GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED events.
1133 * These events are automatically triggered for
1134 * each search result before the
1135 * GNUNET_FS_STATUS_SEARCH_STOPPED event. This
1136 * happens primarily to give the client a chance
1137 * to clean up the "cctx" (if needed).
1142 * Private context set for for this result
1143 * during the "RESULT" event.
1148 * Metadata for the search result.
1150 const struct GNUNET_MetaData *meta;
1153 * URI for the search result.
1155 const struct GNUNET_FS_Uri *uri;
1160 * These values are only valid for
1161 * GNUNET_FS_STATUS_SEARCH_RESUME events.
1166 * Error message, NULL if we have not encountered any error yet.
1168 const char *message;
1171 * Is this search currently paused?
1178 * These values are only valid for
1179 * GNUNET_FS_STATUS_SEARCH_ERROR events.
1186 const char *message;
1191 * Values for all "GNUNET_FS_STATUS_RESULT_NAMESPACE" events.
1196 * Handle to the namespace (NULL if it is not a local
1199 struct GNUNET_FS_Namespace *ns;
1202 * Short, human-readable name of the namespace.
1207 * Root identifier for the namespace, can be NULL.
1212 * Metadata for the namespace.
1214 const struct GNUNET_CONTAINER_MetaData *meta;
1217 * Hash-identifier for the namespace.
1228 * Values for all "GNUNET_FS_STATUS_UNINDEX_*" events.
1233 * Context for controlling the unindexing.
1235 struct GNUNET_FS_UnindexContext *uc;
1238 * Client context pointer (set the last time
1239 * by the client for this operation; initially
1240 * NULL on START/RESUME events).
1245 * Name of the file that is being unindexed.
1247 const char *filename;
1250 * How large is the file overall?
1255 * At what time do we expect to finish unindexing?
1256 * (will be a value in the past for completed
1257 * unindexing opeations).
1259 struct GNUNET_TIME_Absolute eta;
1262 * How long has this upload been actively running
1263 * (excludes times where the upload was suspended).
1265 struct GNUNET_TIME_Relative duration;
1268 * How many bytes have we completed?
1273 * Additional values for specific events.
1278 * These values are only valid for
1279 * GNUNET_FS_STATUS_UNINDEX_PROGRESS events.
1284 * Data block we just unindexed.
1289 * At what offset in the file is "data"?
1294 * Length of the data block.
1301 * These values are only valid for
1302 * GNUNET_FS_STATUS_UNINDEX_RESUME events.
1307 * Error message, NULL if we have not encountered any error yet.
1309 const char *message;
1314 * These values are only valid for
1315 * GNUNET_FS_STATUS_UNINDEX_ERROR events.
1322 const char *message;
1333 * Specific status code (determines the event type).
1335 enum GNUNET_FS_Status status;
1341 * Notification of FS to a client about the progress of an
1342 * operation. Callbacks of this type will be used for uploads,
1343 * downloads and searches. Some of the arguments depend a bit
1344 * in their meaning on the context in which the callback is used.
1346 * @param cls closure
1347 * @param info details about the event, specifying the event type
1348 * and various bits about the event
1349 * @return client-context (for the next progress call
1350 * for this operation; should be set to NULL for
1351 * SUSPEND and STOPPED events). The value returned
1352 * will be passed to future callbacks in the respective
1353 * field in the GNUNET_FS_ProgressInfo struct.
1355 typedef void* (*GNUNET_FS_ProgressCallback)
1357 const struct GNUNET_FS_ProgressInfo *info);
1361 * Handle to the file-sharing service.
1363 struct GNUNET_FS_Handle;
1367 * Setup a connection to the file-sharing service.
1369 * @param sched scheduler to use
1370 * @param cfg configuration to use
1371 * @param client_name unique identifier for this client
1372 * @param upcb function to call to notify about FS actions
1373 * @param upcb_cls closure for upcb
1375 struct GNUNET_FS_Handle *
1376 GNUNET_FS_start (struct GNUNET_SCHEDULER_Handle *sched,
1377 const struct GNUNET_CONFIGURATION_Handle *cfg,
1378 const char *client_name,
1379 GNUNET_FS_ProgressCallback upcb,
1384 * Close our connection with the file-sharing service.
1385 * The callback given to GNUNET_FS_start will no longer be
1386 * called after this function returns.
1388 * @param h handle that was returned from GNUNET_FS_start
1391 GNUNET_FS_stop (struct GNUNET_FS_Handle *h);
1395 * Function called on entries in a GNUNET_FS_FileInformation publish-structure.
1397 * @param cls closure
1398 * @param fi the entry in the publish-structure
1399 * @param length length of the file or directory
1400 * @param meta metadata for the file or directory (can be modified)
1401 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1402 * @param anonymity pointer to selected anonymity level (can be modified)
1403 * @param priority pointer to selected priority (can be modified)
1404 * @param expirationTime pointer to selected expiration time (can be modified)
1405 * @param client_info pointer to client context set upon creation (can be modified)
1406 * @return GNUNET_OK to continue, GNUNET_NO to remove
1407 * this entry from the directory, GNUNET_SYSERR
1408 * to abort the iteration
1410 typedef int (*GNUNET_FS_FileInformationProcessor)(void *cls,
1411 struct GNUNET_FS_FileInformation *fi,
1413 struct GNUNET_CONTAINER_MetaData *meta,
1414 struct GNUNET_FS_Uri **uri,
1415 unsigned int *anonymity,
1416 unsigned int *priority,
1417 struct GNUNET_TIME_Absolute *expirationTime,
1418 void **client_info);
1422 * Recover file information structure from disk.
1424 * @param name filename for the structure on disk
1425 * @return NULL on error
1427 struct GNUNET_FS_FileInformation *
1428 GNUNET_FS_file_information_recover (const char *name);
1432 * Obtain the name under which this file information
1433 * structure is stored on disk. Only works for top-level
1434 * file information structures.
1436 * @param s structure to get the filename for
1437 * @return NULL on error, otherwise filename that
1438 * can be passed to "GNUNET_FS_file_information_recover"
1439 * to read this fi-struct from disk.
1442 GNUNET_FS_file_information_get_id (struct GNUNET_FS_FileInformation *s);
1446 * Synchronize this file-information struct with its mirror
1447 * on disk. Note that all internal FS-operations that change
1448 * file information data should already call "sync" internally,
1449 * so this function is likely not useful for clients.
1451 * @param s the struct to sync
1454 GNUNET_FS_file_information_sync (struct GNUNET_FS_FileInformation *s);
1458 * Create an entry for a file in a publish-structure.
1460 * @param filename name of the file or directory to publish
1461 * @param keywords under which keywords should this file be available
1462 * directly; can be NULL
1463 * @param meta metadata for the file
1464 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1465 * GNUNET_SYSERR for simulation
1466 * @param anonymity what is the desired anonymity level for sharing?
1467 * @param priority what is the priority for OUR node to
1468 * keep this file available? Use 0 for maximum anonymity and
1469 * minimum reliability...
1470 * @param expirationTime when should this content expire?
1471 * @return publish structure entry for the file
1473 struct GNUNET_FS_FileInformation *
1474 GNUNET_FS_file_information_create_from_file (void *client_info,
1475 const char *filename,
1476 const struct GNUNET_FS_Uri *keywords,
1477 const struct GNUNET_CONTAINER_MetaData *meta,
1479 unsigned int anonymity,
1480 unsigned int priority,
1481 struct GNUNET_TIME_Absolute expirationTime);
1485 * Create an entry for a file in a publish-structure.
1487 * @param length length of the file
1488 * @param data data for the file (should not be used afterwards by
1489 * the caller; caller will "free")
1490 * @param keywords under which keywords should this file be available
1491 * directly; can be NULL
1492 * @param meta metadata for the file
1493 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1494 * GNUNET_SYSERR for simulation
1495 * @param anonymity what is the desired anonymity level for sharing?
1496 * @param priority what is the priority for OUR node to
1497 * keep this file available? Use 0 for maximum anonymity and
1498 * minimum reliability...
1499 * @param expirationTime when should this content expire?
1500 * @return publish structure entry for the file
1502 struct GNUNET_FS_FileInformation *
1503 GNUNET_FS_file_information_create_from_data (void *client_info,
1506 const struct GNUNET_FS_Uri *keywords,
1507 const struct GNUNET_CONTAINER_MetaData *meta,
1509 unsigned int anonymity,
1510 unsigned int priority,
1511 struct GNUNET_TIME_Absolute expirationTime);
1515 * Function that provides data.
1517 * @param cls closure
1518 * @param offset offset to read from; it is possible
1519 * that the caller might need to go backwards
1521 * @param max maximum number of bytes that should be
1522 * copied to buf; readers are not allowed
1523 * to provide less data unless there is an error;
1524 * a value of "0" will be used at the end to allow
1525 * the reader to clean up its internal state
1526 * @param buf where the reader should write the data
1527 * @param emsg location for the reader to store an error message
1528 * @return number of bytes written, usually "max", 0 on error
1530 typedef size_t (*GNUNET_FS_DataReader)(void *cls,
1538 * Create an entry for a file in a publish-structure.
1540 * @param length length of the file
1541 * @param reader function that can be used to obtain the data for the file
1542 * @param reader_cls closure for "reader"
1543 * @param keywords under which keywords should this file be available
1544 * directly; can be NULL
1545 * @param meta metadata for the file
1546 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1547 * GNUNET_SYSERR for simulation
1548 * @param anonymity what is the desired anonymity level for sharing?
1549 * @param priority what is the priority for OUR node to
1550 * keep this file available? Use 0 for maximum anonymity and
1551 * minimum reliability...
1552 * @param expirationTime when should this content expire?
1553 * @return publish structure entry for the file
1555 struct GNUNET_FS_FileInformation *
1556 GNUNET_FS_file_information_create_from_reader (void *client_info,
1558 GNUNET_FS_DataReader reader,
1560 const struct GNUNET_FS_Uri *keywords,
1561 const struct GNUNET_CONTAINER_MetaData *meta,
1563 unsigned int anonymity,
1564 unsigned int priority,
1565 struct GNUNET_TIME_Absolute expirationTime);
1569 * Function that a "GNUNET_FS_DirectoryScanner" should call
1570 * for each entry in the directory.
1572 * @param cls closure
1573 * @param filename name of the file (including path); must end
1574 * in a "/" (even on W32) if this is a directory
1575 * @param fi information about the file (should not be
1576 * used henceforth by the caller)
1578 typedef void (*GNUNET_FS_FileProcessor)(void *cls,
1579 const char *filename,
1580 struct GNUNET_FS_FileInformation *fi);
1584 * Type of a function that will be used to scan a directory.
1586 * @param cls closure
1587 * @param dirname name of the directory to scan
1588 * @param do_index should files be indexed or inserted
1589 * @param anonymity desired anonymity level
1590 * @param priority priority for publishing
1591 * @param expirationTime expiration for publication
1592 * @param proc function to call on each entry
1593 * @param proc_cls closure for proc
1594 * @param emsg where to store an error message (on errors)
1595 * @return GNUNET_OK on success
1597 typedef int (*GNUNET_FS_DirectoryScanner)(void *cls,
1598 const char *dirname,
1600 unsigned int anonymity,
1601 unsigned int priority,
1602 struct GNUNET_TIME_Absolute expirationTime,
1603 GNUNET_FS_FileProcessor proc,
1610 * Simple, useful default implementation of a directory scanner
1611 * (GNUNET_FS_DirectoryScanner). This implementation expects to get a
1612 * UNIX filename, will publish all files in the directory except hidden
1613 * files (those starting with a "."). Metadata will be extracted
1614 * using GNU libextractor; the specific list of plugins should be
1615 * specified in "cls", passing NULL will disable (!) metadata
1616 * extraction. Keywords will be derived from the metadata and be
1617 * subject to default canonicalization. This is strictly a
1618 * convenience function.
1620 * @param cls must be of type "struct EXTRACTOR_Extractor*"
1621 * @param dirname name of the directory to scan
1622 * @param do_index should files be indexed or inserted
1623 * @param anonymity desired anonymity level
1624 * @param priority priority for publishing
1625 * @param expirationTime expiration for publication
1626 * @param proc function called on each entry
1627 * @param proc_cls closure for proc
1628 * @param emsg where to store an error message (on errors)
1629 * @return GNUNET_OK on success
1632 GNUNET_FS_directory_scanner_default (void *cls,
1633 const char *dirname,
1635 unsigned int anonymity,
1636 unsigned int priority,
1637 struct GNUNET_TIME_Absolute expirationTime,
1638 GNUNET_FS_FileProcessor proc,
1644 * Create a publish-structure from an existing file hierarchy, inferring
1645 * and organizing keywords and metadata as much as possible. This
1646 * function primarily performs the recursive build and re-organizes
1647 * keywords and metadata; for automatically getting metadata
1648 * extraction, scanning of directories and creation of the respective
1649 * GNUNET_FS_FileInformation entries the default scanner should be
1650 * passed (GNUNET_FS_directory_scanner_default). This is strictly a
1651 * convenience function.
1653 * @param filename name of the top-level file or directory
1654 * @param scanner function used to get a list of files in a directory
1655 * @param scanner_cls closure for scanner
1656 * @param do_index should files in the hierarchy be indexed?
1657 * @param anonymity what is the desired anonymity level for sharing?
1658 * @param priority what is the priority for OUR node to
1659 * keep this file available? Use 0 for maximum anonymity and
1660 * minimum reliability...
1661 * @param expirationTime when should this content expire?
1662 * @param emsg where to store an error message
1663 * @return publish structure entry for the directory, NULL on error
1665 struct GNUNET_FS_FileInformation *
1666 GNUNET_FS_file_information_create_from_directory (void *client_info,
1667 const char *filename,
1668 GNUNET_FS_DirectoryScanner scanner,
1671 unsigned int anonymity,
1672 unsigned int priority,
1673 struct GNUNET_TIME_Absolute expirationTime,
1678 * Create an entry for an empty directory in a publish-structure.
1679 * This function should be used by applications for which the
1680 * use of "GNUNET_FS_file_information_create_from_directory"
1681 * is not appropriate.
1683 * @param meta metadata for the directory
1684 * @param keywords under which keywords should this directory be available
1685 * directly; can be NULL
1686 * @param anonymity what is the desired anonymity level for sharing?
1687 * @param priority what is the priority for OUR node to
1688 * keep this file available? Use 0 for maximum anonymity and
1689 * minimum reliability...
1690 * @param expirationTime when should this content expire?
1691 * @return publish structure entry for the directory , NULL on error
1693 struct GNUNET_FS_FileInformation *
1694 GNUNET_FS_file_information_create_empty_directory (void *client_info,
1695 const struct GNUNET_CONTAINER_MetaData *meta,
1696 const struct GNUNET_FS_Uri *keywords,
1697 unsigned int anonymity,
1698 unsigned int priority,
1699 struct GNUNET_TIME_Absolute expirationTime);
1703 * Add an entry to a directory in a publish-structure. Clients
1704 * should never modify publish structures that were passed to
1705 * "GNUNET_FS_publish_start" already.
1707 * @param dir the directory
1708 * @param end the entry to add; the entry must not have been
1709 * added to any other directory at this point and
1710 * must not include "dir" in its structure
1711 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1714 GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
1715 struct GNUNET_FS_FileInformation *end);
1719 * Inspect a file or directory in a publish-structure. Clients
1720 * should never modify publish structures that were passed to
1721 * "GNUNET_FS_publish_start" already. When called on a directory,
1722 * this function will FIRST call "proc" with information about
1723 * the directory itself and then for each of the files in the
1724 * directory (but not for files in subdirectories). When called
1725 * on a file, "proc" will be called exactly once (with information
1726 * about the specific file).
1728 * @param dir the directory
1729 * @param proc function to call on each entry
1730 * @param proc_cls closure for proc
1733 GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir,
1734 GNUNET_FS_FileInformationProcessor proc,
1739 * Destroy publish-structure. Clients should never destroy publish
1740 * structures that were passed to "GNUNET_FS_publish_start" already.
1742 * @param fi structure to destroy
1743 * @param cleaner function to call on each entry in the structure
1744 * (useful to clean up client_info); can be NULL; return
1745 * values are ignored
1746 * @param cleaner_cls closure for cleaner
1749 GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi,
1750 GNUNET_FS_FileInformationProcessor cleaner,
1755 * Publish a file or directory.
1757 * @param h handle to the file sharing subsystem
1758 * @param ctx initial value to use for the '*ctx'
1759 * in the callback (for the GNUNET_FS_STATUS_PUBLISH_START event).
1760 * @param fi information about the file or directory structure to publish
1761 * @param namespace namespace to publish the file in, NULL for no namespace
1762 * @param nid identifier to use for the publishd content in the namespace
1763 * (can be NULL, must be NULL if namespace is NULL)
1764 * @param nuid update-identifier that will be used for future updates
1765 * (can be NULL, must be NULL if namespace or nid is NULL)
1766 * @return context that can be used to control the publish operation
1768 struct GNUNET_FS_PublishContext *
1769 GNUNET_FS_publish_start (struct GNUNET_FS_Handle *h,
1771 struct GNUNET_FS_FileInformation *fi,
1772 struct GNUNET_FS_Namespace *namespace,
1778 * Stop an upload. Will abort incomplete uploads (but
1779 * not remove blocks that have already been publishd) or
1780 * simply clean up the state for completed uploads.
1782 * @param sc context for the upload to stop
1785 GNUNET_FS_publish_stop (struct GNUNET_FS_PublishContext *sc);
1789 * Type of a function called by "GNUNET_FS_get_indexed_files".
1791 * @param cls closure
1792 * @param filename the name of the file
1793 * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
1795 typedef int (*GNUNET_FS_IndexedFileProcessor) (void *cls,
1796 const char *filename);
1800 * Iterate over all indexed files.
1802 * @param h handle to the file sharing subsystem
1803 * @param iterator function to call on each indexed file
1804 * @param iterator_cls closure for iterator
1807 GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
1808 GNUNET_FS_IndexedFileProcessor iterator,
1809 void *iterator_cls);
1815 * @param h handle to the file sharing subsystem
1816 * @param filename file to unindex
1817 * @return NULL on error, otherwise handle
1819 struct GNUNET_FS_UnindexContext *
1820 GNUNET_FS_unindex (struct GNUNET_FS_Handle *h,
1821 const char *filename);
1825 * Clean up after completion of an unindex operation.
1830 GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc);
1834 * Publish an advertismement for a namespace.
1836 * @param h handle to the file sharing subsystem
1837 * @param namespace handle for the namespace that should be advertised
1838 * @param meta meta-data for the namespace advertisement
1839 * @param anonymity for the namespace advertismement
1840 * @param priority for the namespace advertisement
1841 * @param expiration for the namespace advertisement
1842 * @param advertisementURI the keyword (!) URI to advertise the
1843 * namespace under (we will create a GNUNET_EC_KNBlock)
1844 * @param rootEntry name of the root entry in the namespace (for
1845 * the namespace advertisement)
1847 * @return uri of the advertisement
1849 struct GNUNET_FS_Uri *
1850 GNUNET_FS_namespace_advertise (struct GNUNET_FS_Handle *h,
1851 struct GNUNET_FS_Namespace *namespace,
1852 const struct GNUNET_MetaData *meta,
1853 unsigned int anonymity,
1854 unsigned int priority,
1855 struct GNUNET_TIME_Absolute expiration,
1856 const struct GNUNET_FS_Uri *advertisementURI,
1857 const char *rootEntry);
1861 * Create a namespace with the given name; if one already
1862 * exists, return a handle to the existing namespace.
1864 * @param h handle to the file sharing subsystem
1865 * @param name name to use for the namespace
1866 * @return handle to the namespace, NULL on error
1868 struct GNUNET_FS_Namespace *
1869 GNUNET_FS_namespace_create (struct GNUNET_FS_Handle *h,
1874 * Delete a namespace handle. Can be used for a clean shutdown (free
1875 * memory) or also to freeze the namespace to prevent further
1876 * insertions by anyone.
1878 * @param namespace handle to the namespace that should be deleted / freed
1879 * @param freeze prevents future insertions; creating a namespace
1880 * with the same name again will create a fresh namespace instead
1882 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1885 GNUNET_FS_namespace_delete (struct GNUNET_FS_Namespace *namespace,
1890 * Callback with information about local (!) namespaces.
1891 * Contains the names of the local namespace and the global
1894 * @param cls closure
1895 * @param name human-readable identifier of the namespace
1896 * @param id hash identifier for the namespace
1898 typedef void (*GNUNET_FS_NamespaceInfoProcessor) (void *cls,
1900 const GNUNET_HashCode *id);
1904 * Build a list of all available local (!) namespaces The returned
1905 * names are only the nicknames since we only iterate over the local
1908 * @param h handle to the file sharing subsystem
1909 * @param cb function to call on each known namespace
1910 * @param cb_cls closure for cb
1913 GNUNET_FS_namespace_list (struct GNUNET_FS_Handle *h,
1914 GNUNET_FS_NamespaceInfoProcessor cb,
1919 * Function called on updateable identifiers.
1921 * @param cls closure
1922 * @param last_id last identifier
1923 * @param last_uri uri used for the content published under the last_id
1924 * @param last_meta metadata associated with last_uri
1925 * @param next_id identifier that should be used for updates
1928 (*GNUNET_FS_IdentifierProcessor)(void *cls,
1929 const char *last_id,
1930 const struct GNUNET_FS_Uri *last_uri,
1931 const struct GNUNET_CONTAINER_MetaData *last_meta,
1932 const char *next_id);
1936 * List all of the identifiers in the namespace for
1937 * which we could produce an update.
1939 * @param namespace namespace to inspect for updateable content
1940 * @param ip function to call on each updateable identifier
1941 * @param ip_cls closure for ip
1944 GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Namespace *namespace,
1945 GNUNET_FS_IdentifierProcessor ip,
1950 * Start search for content.
1952 * @param h handle to the file sharing subsystem
1953 * @param uri specifies the search parameters; can be
1954 * a KSK URI or an SKS URI.
1955 * @param anonymity desired level of anonymity
1956 * @return context that can be used to control the search
1958 struct GNUNET_FS_SearchContext *
1959 GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
1960 const struct GNUNET_FS_Uri *uri,
1961 unsigned int anonymity);
1967 * @param sc context for the search that should be paused
1970 GNUNET_FS_search_pause (struct GNUNET_FS_SearchContext *sc);
1974 * Continue paused search.
1976 * @param sc context for the search that should be resumed
1979 GNUNET_FS_search_continue (struct GNUNET_FS_SearchContext *sc);
1983 * Stop search for content.
1985 * @param sc context for the search that should be stopped
1988 GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc);
1992 * Download parts of a file. Note that this will store
1993 * the blocks at the respective offset in the given file. Also, the
1994 * download is still using the blocking of the underlying FS
1995 * encoding. As a result, the download may *write* outside of the
1996 * given boundaries (if offset and length do not match the 32k FS
1997 * block boundaries). <p>
1999 * This function should be used to focus a download towards a
2000 * particular portion of the file (optimization), not to strictly
2001 * limit the download to exactly those bytes.
2003 * @param h handle to the file sharing subsystem
2004 * @param uri the URI of the file (determines what to download); CHK or LOC URI
2005 * @param filename where to store the file, maybe NULL (then no file is
2006 * created on disk and data must be grabbed from the callbacks)
2007 * @param offset at what offset should we start the download (typically 0)
2008 * @param length how many bytes should be downloaded starting at offset
2009 * @param anonymity anonymity level to use for the download
2010 * @param no_temporaries set to GNUNET_YES to disallow generation of temporary files
2011 * @param recursive should this be a recursive download (useful for directories
2012 * to automatically trigger download of files in the directories)
2013 * @param parent parent download to associate this download with (use NULL
2014 * for top-level downloads; useful for manually-triggered recursive downloads)
2015 * @return context that can be used to control this download
2017 struct GNUNET_FS_DownloadContext *
2018 GNUNET_FS_file_download_start (struct GNUNET_FS_Handle *h,
2019 const struct GNUNET_FS_Uri *uri,
2020 const char *filename,
2021 unsigned long long offset,
2022 unsigned long long length,
2023 unsigned int anonymity,
2026 struct GNUNET_FS_DownloadContext *parent);
2030 * Stop a download (aborts if download is incomplete).
2032 * @param rm handle for the download
2033 * @param do_delete delete files of incomplete downloads
2036 GNUNET_FS_file_download_stop (struct GNUNET_FS_DownloadContext *rm,
2041 * Initialize collection.
2043 * @param h handle to the file sharing subsystem
2044 * @param namespace namespace to use for the collection
2045 * @return GNUNET_OK on success, GNUNET_SYSERR if another
2046 * namespace is already set for our collection
2049 GNUNET_FS_collection_start (struct GNUNET_FS_Handle *h,
2050 struct GNUNET_FS_Namespace *namespace);
2056 * @param h handle to the file sharing subsystem
2057 * @return GNUNET_OK on success, GNUNET_SYSERR if no collection is active
2060 GNUNET_FS_collection_stop (struct GNUNET_FS_Handle *h);
2064 * Are we using a collection?
2066 * @param h handle to the file sharing subsystem
2067 * @return NULL if there is no collection,
2069 struct GNUNET_FS_Namespace *
2070 GNUNET_FS_collection_get(struct GNUNET_FS_Handle *h);
2074 * Publish an update of the current collection information to the
2075 * network now. The function has no effect if the collection has not
2076 * changed since the last publication. If we are currently not
2077 * collecting, this function does nothing.
2079 * @param h handle to the file sharing subsystem
2081 void GNUNET_FS_collection_publish (struct GNUNET_FS_Handle *h);
2085 * If we are currently building a collection, publish the given file
2086 * information in that collection. If we are currently not
2087 * collecting, this function does nothing.
2089 * @param h handle to the file sharing subsystem
2090 * @param uri uri to add to the collection
2091 * @param meta metadata for the uri
2093 void GNUNET_FS_collection_add (const struct GNUNET_FS_Handle *h,
2094 const struct GNUNET_FS_Uri *uri,
2095 const struct GNUNET_CONTAINER_MetaData *meta);
2101 /* ******************** Directory API *********************** */
2104 #define GNUNET_FS_DIRECTORY_MIME "application/gnunet-directory"
2105 #define GNUNET_FS_DIRECTORY_MAGIC "\211GND\r\n\032\n"
2106 #define GNUNET_FS_DIRECTORY_EXT ".gnd"
2109 * Does the meta-data claim that this is a directory?
2110 * Checks if the mime-type is that of a GNUnet directory.
2112 * @return GNUNET_YES if it is, GNUNET_NO if it is not, GNUNET_SYSERR if
2113 * we have no mime-type information (treat as 'GNUNET_NO')
2116 GNUNET_FS_meta_data_test_for_directory (const struct GNUNET_CONTAINER_MetaData *md);
2120 * Set the MIMETYPE information for the given
2121 * metadata to "application/gnunet-directory".
2123 * @param md metadata to add mimetype to
2126 GNUNET_FS_meta_data_make_directory (struct GNUNET_CONTAINER_MetaData *md);
2130 * Function used to process entries in a directory.
2132 * @param cls closure
2133 * @param filename name of the file in the directory
2134 * @param uri URI of the file
2135 * @param metadata metadata for the file; metadata for
2136 * the directory if everything else is NULL/zero
2137 * @param length length of the available data for the file
2138 * (of type size_t since data must certainly fit
2139 * into memory; if files are larger than size_t
2140 * permits, then they will certainly not be
2141 * embedded with the directory itself).
2142 * @param data data available for the file (length bytes)
2144 typedef void (*GNUNET_FS_DirectoryEntryProcessor)(void *cls,
2145 const char *filename,
2146 const struct GNUNET_FS_Uri *uri,
2147 const struct GNUNET_CONTAINER_MetaData *meta,
2153 * Iterate over all entries in a directory. Note that directories
2154 * are structured such that it is possible to iterate over the
2155 * individual blocks as well as over the entire directory. Thus
2156 * a client can call this function on the buffer in the
2157 * GNUNET_FS_ProgressCallback. Also, directories can optionally
2158 * include the contents of (small) files embedded in the directory
2159 * itself; for those files, the processor may be given the
2160 * contents of the file directly by this function.
2162 * @param size number of bytes in data
2163 * @param data pointer to the beginning of the directory
2164 * @param offset offset of data in the directory
2165 * @param dep function to call on each entry
2166 * @param dep_cls closure for dep
2169 GNUNET_FS_directory_list_contents (size_t size,
2172 GNUNET_FS_DirectoryEntryProcessor dep,
2177 * Opaque handle to a directory builder.
2179 struct GNUNET_FS_DirectoryBuilder;
2182 * Create a directory builder.
2184 * @param mdir metadata for the directory
2186 struct GNUNET_FS_DirectoryBuilder *
2187 GNUNET_FS_directory_builder_create (const struct GNUNET_CONTAINER_MetaData *mdir);
2191 * Add an entry to a directory.
2193 * @param bld directory to extend
2194 * @param uri uri of the entry (must not be a KSK)
2195 * @param md metadata of the entry
2196 * @param data raw data of the entry, can be NULL, otherwise
2197 * data must point to exactly the number of bytes specified
2201 GNUNET_FS_directory_builder_add (struct GNUNET_FS_DirectoryBuilder *bld,
2202 const struct GNUNET_FS_Uri *uri,
2203 const struct GNUNET_CONTAINER_MetaData *md,
2208 * Finish building the directory. Frees the
2209 * builder context and returns the directory
2212 * @param bld directory to finish
2213 * @param size set to the number of bytes needed
2214 * @param data set to the encoded directory
2217 GNUNET_FS_directory_builder_finish (struct GNUNET_FS_DirectoryBuilder *bld,
2222 #if 0 /* keep Emacsens' auto-indent happy */