2 This file is part of GNUnet
3 (C) 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
21 * @file include/gnunet_fs_service.h
22 * @brief API for file-sharing via GNUnet
23 * @author Christian Grothoff
25 #ifndef GNUNET_FS_LIB_H
26 #define GNUNET_FS_LIB_H
28 #include "gnunet_util_lib.h"
33 #if 0 /* keep Emacsens' auto-indent happy */
39 * Version number of the implementation.
42 * 1.x.x: initial version with triple GNUNET_hash and merkle tree
43 * 2.x.x: root node with mime-type, filename and version number
44 * 2.1.x: combined GNUNET_EC_ContentHashKey/3HASH encoding with 25:1 super-nodes
45 * 2.2.x: with directories
46 * 3.0.x: with namespaces
47 * 3.1.x: with namespace meta-data
48 * 3.2.x: with collections
49 * 4.0.x: with expiration, variable meta-data, kblocks
50 * 4.1.x: with new error and configuration handling
51 * 5.0.x: with location URIs
52 * 6.0.0: with support for OR in KSKs
53 * 6.1.x: with simplified namespace support
54 * 9.0.0: CPS-style integrated API
56 #define GNUNET_FS_VERSION 0x00090000
59 /* ******************** URI API *********************** */
61 #define GNUNET_FS_URI_PREFIX "gnunet://fs/"
62 #define GNUNET_FS_URI_KSK_INFIX "ksk/"
63 #define GNUNET_FS_URI_SKS_INFIX "sks/"
64 #define GNUNET_FS_URI_CHK_INFIX "chk/"
65 #define GNUNET_FS_URI_LOC_INFIX "loc/"
69 * A Universal Resource Identifier (URI), opaque.
75 * Iterator over keywords
78 * @param keyword the keyword
79 * @param is_mandatory is the keyword mandatory (in a search)
80 * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
82 typedef int (*GNUNET_FS_KeywordIterator) (void *cls,
87 * Get a unique key from a URI. This is for putting URIs
88 * into HashMaps. The key may change between FS implementations.
90 * @param uri uri to convert to a unique key
91 * @param key wherer to store the unique key
94 GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri,
95 GNUNET_HashCode * key);
98 * Convert a URI to a UTF-8 String.
100 * @param uri uri to convert to a string
101 * @return the UTF-8 string
104 GNUNET_FS_uri_to_string (const struct GNUNET_FS_Uri *uri);
107 * Convert keyword URI to a human readable format
108 * (i.e. the search query that was used in the first place)
110 * @param uri ksk uri to convert to a string
111 * @return string with the keywords
114 GNUNET_FS_uri_ksk_to_string_fancy (const struct GNUNET_FS_Uri *uri);
118 * Convert a UTF-8 String to a URI.
120 * @param uri string to parse
121 * @param emsg where to store the parser error message (if any)
122 * @return NULL on error
124 struct GNUNET_FS_Uri *
125 GNUNET_FS_uri_parse (const char *uri,
131 * @param uri uri to free
134 GNUNET_FS_uri_destroy (struct GNUNET_FS_Uri *uri);
138 * How many keywords are ANDed in this keyword URI?
140 * @param uri ksk uri to get the number of keywords from
141 * @return 0 if this is not a keyword URI
144 GNUNET_FS_uri_ksk_get_keyword_count (const struct GNUNET_FS_Uri *uri);
148 * Iterate over all keywords in this keyword URI.
150 * @param uri ksk uri to get the keywords from
151 * @param iterator function to call on each keyword
152 * @param iterator_cls closure for iterator
153 * @return -1 if this is not a keyword URI, otherwise number of
154 * keywords iterated over until iterator aborted
157 GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
158 GNUNET_FS_KeywordIterator iterator,
163 * Obtain the identity of the peer offering the data
165 * @param uri the location URI to inspect
166 * @param peer where to store the identify of the peer (presumably) offering the content
167 * @return GNUNET_SYSERR if this is not a location URI, otherwise GNUNET_OK
170 GNUNET_FS_uri_loc_get_peer_identity (const struct GNUNET_FS_Uri *uri,
171 struct GNUNET_PeerIdentity * peer);
175 * Obtain the URI of the content itself.
177 * @param uri location URI to get the content URI from
178 * @return NULL if argument is not a location URI
180 struct GNUNET_FS_Uri *
181 GNUNET_FS_uri_loc_get_uri (const struct GNUNET_FS_Uri *uri);
185 * Obtain the expiration of the LOC URI.
187 * @param uri location URI to get the expiration from
188 * @return expiration time of the URI
190 struct GNUNET_TIME_Absolute
191 GNUNET_FS_uri_loc_get_expiration (const struct GNUNET_FS_Uri *uri);
195 * Construct a location URI (this peer will be used for the location).
197 * @param baseUri content offered by the sender
198 * @param cfg configuration information (used to find our hostkey)
199 * @param expiration_time how long will the content be offered?
200 * @return the location URI, NULL on error
202 struct GNUNET_FS_Uri *
203 GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *baseUri,
204 const struct GNUNET_CONFIGURATION_Handle *cfg,
205 struct GNUNET_TIME_Absolute expiration_time);
209 * Canonicalize keyword URI. Performs operations such
210 * as decapitalization and removal of certain characters.
211 * (useful for search).
213 * @param uri the URI to canonicalize
214 * @return canonicalized version of the URI, NULL on error
216 struct GNUNET_FS_Uri *
217 GNUNET_FS_uri_ksk_canonicalize (const struct GNUNET_FS_Uri *uri);
221 * Merge the sets of keywords from two KSK URIs.
222 * (useful for merging the canonicalized keywords with
223 * the original keywords for sharing).
225 * @param u1 first uri
226 * @param u2 second uri
227 * @return merged URI, NULL on error
229 struct GNUNET_FS_Uri *
230 GNUNET_FS_uri_ksk_merge (const struct GNUNET_FS_Uri *u1,
231 const struct GNUNET_FS_Uri *u2);
237 * @param uri the URI to duplicate
238 * @return copy of the URI
240 struct GNUNET_FS_Uri *
241 GNUNET_FS_uri_dup (const struct GNUNET_FS_Uri *uri);
245 * Create an FS URI from a single user-supplied string of keywords.
246 * The string is broken up at spaces into individual keywords.
247 * Keywords that start with "+" are mandatory. Double-quotes can
248 * be used to prevent breaking up strings at spaces (and also
249 * to specify non-mandatory keywords starting with "+").
251 * Keywords must contain a balanced number of double quotes and
252 * double quotes can not be used in the actual keywords (for
253 * example, the string '""foo bar""' will be turned into two
254 * "OR"ed keywords 'foo' and 'bar', not into '"foo bar"'.
256 * @param keywords the keyword string
257 * @param emsg where to store an error message
258 * @return an FS URI for the given keywords, NULL
259 * if keywords is not legal (i.e. empty).
261 struct GNUNET_FS_Uri *
262 GNUNET_FS_uri_ksk_create (const char *keywords,
267 * Create an FS URI from a user-supplied command line of keywords.
268 * Arguments should start with "+" to indicate mandatory
271 * @param argc number of keywords
272 * @param argv keywords (double quotes are not required for
273 * keywords containing spaces; however, double
274 * quotes are required for keywords starting with
275 * "+"); there is no mechanism for having double
276 * quotes in the actual keywords (if the user
277 * did specifically specify double quotes, the
278 * caller should convert each double quote
279 * into two single quotes).
280 * @return an FS URI for the given keywords, NULL
281 * if keywords is not legal (i.e. empty).
283 struct GNUNET_FS_Uri *
284 GNUNET_FS_uri_ksk_create_from_args (unsigned int argc,
289 * Test if two URIs are equal.
291 * @param u1 one of the URIs
292 * @param u2 the other URI
293 * @return GNUNET_YES if the URIs are equal
296 GNUNET_FS_uri_test_equal (const struct GNUNET_FS_Uri *u1,
297 const struct GNUNET_FS_Uri *u2);
301 * Is this a namespace URI?
303 * @param uri the uri to check
304 * @return GNUNET_YES if this is an SKS uri
307 GNUNET_FS_uri_test_sks (const struct GNUNET_FS_Uri *uri);
311 * Handle to one of our namespaces.
313 struct GNUNET_FS_Namespace;
317 * Create an SKS URI from a namespace and an identifier.
319 * @param ns namespace
320 * @param id identifier
321 * @param emsg where to store an error message
322 * @return an FS URI for the given namespace and identifier
324 struct GNUNET_FS_Uri *
325 GNUNET_FS_uri_sks_create (struct GNUNET_FS_Namespace *ns,
331 * Create an SKS URI from a namespace ID and an identifier.
333 * @param nsid namespace ID
334 * @param id identifier
335 * @return an FS URI for the given namespace and identifier
337 struct GNUNET_FS_Uri *
338 GNUNET_FS_uri_sks_create_from_nsid (GNUNET_HashCode *nsid,
343 * Get the ID of a namespace from the given
346 * @param uri the uri to get the namespace ID from
347 * @param nsid where to store the ID of the namespace
348 * @return GNUNET_OK on success
351 GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
352 GNUNET_HashCode * nsid);
356 * Get the content identifier of an SKS URI.
358 * @param uri the sks uri
359 * @return NULL on error (not a valid SKS URI)
362 GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri);
366 * Convert namespace URI to a human readable format
367 * (using the namespace description, if available).
369 * @param cfg configuration to use
370 * @param uri SKS uri to convert
371 * @return NULL on error (not an SKS URI)
374 GNUNET_FS_uri_sks_to_string_fancy (struct GNUNET_CONFIGURATION_Handle *cfg,
375 const struct GNUNET_FS_Uri *uri);
379 * Is this a keyword URI?
382 * @return GNUNET_YES if this is a KSK uri
385 GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri);
389 * Is this a file (or directory) URI?
391 * @param uri the uri to check
392 * @return GNUNET_YES if this is a CHK uri
395 GNUNET_FS_uri_test_chk (const struct GNUNET_FS_Uri *uri);
399 * What is the size of the file that this URI
402 * @param uri the CHK (or LOC) URI to inspect
403 * @return size of the file as specified in the CHK URI
406 GNUNET_FS_uri_chk_get_file_size (const struct GNUNET_FS_Uri *uri);
410 * Is this a location URI?
412 * @param uri the uri to check
413 * @return GNUNET_YES if this is a LOC uri
416 GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri);
420 * Construct a keyword-URI from meta-data (take all entries
421 * in the meta-data and construct one large keyword URI
422 * that lists all keywords that can be found in the meta-data).
424 * @param md metadata to use
425 * @return NULL on error, otherwise a KSK URI
427 struct GNUNET_FS_Uri *
428 GNUNET_FS_uri_ksk_create_from_meta_data (const struct GNUNET_CONTAINER_MetaData *md);
431 /* ******************** command-line option parsing API *********************** */
434 * Command-line option parser function that allows the user
435 * to specify one or more '-k' options with keywords. Each
436 * specified keyword will be added to the URI. A pointer to
437 * the URI must be passed as the "scls" argument.
439 * @param ctx command line processor context
440 * @param scls must be of type "struct GNUNET_FS_Uri **"
441 * @param option name of the option (typically 'k')
442 * @param value command line argument given
443 * @return GNUNET_OK on success
446 GNUNET_FS_getopt_set_keywords (struct GNUNET_GETOPT_CommandLineProcessorContext* ctx,
453 * Command-line option parser function that allows the user to specify
454 * one or more '-m' options with metadata. Each specified entry of
455 * the form "type=value" will be added to the metadata. A pointer to
456 * the metadata must be passed as the "scls" argument.
458 * @param ctx command line processor context
459 * @param scls must be of type "struct GNUNET_CONTAINER_MetaData **"
460 * @param option name of the option (typically 'k')
461 * @param value command line argument given
462 * @return GNUNET_OK on success
465 GNUNET_FS_getopt_set_metadata (struct GNUNET_GETOPT_CommandLineProcessorContext* ctx,
472 /* ************************* sharing API ***************** */
476 * Possible status codes used in the callback for the
477 * various file-sharing operations. On each file (or search),
478 * the callback is guaranteed to be called once with "START"
479 * and once with STOPPED; calls with PROGRESS, ERROR or COMPLETED
480 * are optional and depend on the circumstances; parent operations
481 * will be STARTED before child-operations and STOPPED after
482 * their respective child-operations. START and STOP signals
483 * are typically generated either due to explicit client requests
484 * or because of suspend/resume operations.
486 enum GNUNET_FS_Status
489 * Notification that we have started to publish a file structure.
491 GNUNET_FS_STATUS_PUBLISH_START,
494 * Notification that we have resumed sharing a file structure.
496 GNUNET_FS_STATUS_PUBLISH_RESUME,
499 * Notification that we have suspended sharing a file structure.
501 GNUNET_FS_STATUS_PUBLISH_SUSPEND,
504 * Notification that we are making progress sharing a file structure.
506 GNUNET_FS_STATUS_PUBLISH_PROGRESS,
509 * Notification that an error was encountered sharing a file structure.
510 * The application will continue to receive resume/suspend events for
511 * this structure until "GNUNET_FS_publish_stop" is called.
513 GNUNET_FS_STATUS_PUBLISH_ERROR,
516 * Notification that we completed sharing a file structure.
517 * The application will continue to receive resume/suspend events for
518 * this structure until "GNUNET_FS_publish_stop" is called.
520 GNUNET_FS_STATUS_PUBLISH_COMPLETED,
523 * Notification that we have stopped
524 * the process of uploading a file structure; no
525 * futher events will be generated for this action.
527 GNUNET_FS_STATUS_PUBLISH_STOPPED,
530 * Notification that we have started this download.
532 GNUNET_FS_STATUS_DOWNLOAD_START,
535 * Notification that this download is being resumed.
537 GNUNET_FS_STATUS_DOWNLOAD_RESUME,
540 * Notification that this download was suspended.
542 GNUNET_FS_STATUS_DOWNLOAD_SUSPEND,
545 * Notification about progress with this download.
547 GNUNET_FS_STATUS_DOWNLOAD_PROGRESS,
550 * Notification that this download encountered an error.
552 GNUNET_FS_STATUS_DOWNLOAD_ERROR,
555 * Notification that this download completed. Note that for
556 * directories, completion does not imply completion of all files in
559 GNUNET_FS_STATUS_DOWNLOAD_COMPLETED,
562 * Notification that this download was stopped
563 * (final event with respect to this action).
565 GNUNET_FS_STATUS_DOWNLOAD_STOPPED,
568 * Notification that this download is now actively being
569 * pursued (as opposed to waiting in the queue).
571 GNUNET_FS_STATUS_DOWNLOAD_ACTIVE,
574 * Notification that this download is no longer actively
575 * being pursued (back in the queue).
577 GNUNET_FS_STATUS_DOWNLOAD_INACTIVE,
580 * Notification that this download is no longer part of a
581 * recursive download or search but now a 'stand-alone'
582 * download (and may thus need to be moved in the GUI
583 * into a different category).
585 GNUNET_FS_STATUS_DOWNLOAD_LOST_PARENT,
588 * First event generated when a client requests
589 * a search to begin or when a namespace result
590 * automatically triggers the search for updates.
592 GNUNET_FS_STATUS_SEARCH_START,
595 * Last event when a search is being resumed;
596 * note that "GNUNET_FS_SEARCH_START" will not
597 * be generated in this case.
599 GNUNET_FS_STATUS_SEARCH_RESUME,
602 * Event generated for each search result
603 * when the respective search is resumed.
605 GNUNET_FS_STATUS_SEARCH_RESUME_RESULT,
608 * Last event when a search is being suspended;
609 * note that "GNUNET_FS_SEARCH_STOPPED" will not
610 * be generated in this case.
612 GNUNET_FS_STATUS_SEARCH_SUSPEND,
615 * This search has yielded a result.
617 GNUNET_FS_STATUS_SEARCH_RESULT,
620 * We have discovered a new namespace.
622 GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE,
625 * We have additional data about the quality
626 * or availability of a search result.
628 GNUNET_FS_STATUS_SEARCH_UPDATE,
631 * Signals a problem with this search.
633 GNUNET_FS_STATUS_SEARCH_ERROR,
636 * Signals that this search was paused.
638 GNUNET_FS_STATUS_SEARCH_PAUSED,
641 * Signals that this search was continued (unpaused).
643 GNUNET_FS_STATUS_SEARCH_CONTINUED,
646 * Event generated for each search result
647 * when the respective search is stopped.
649 GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED,
652 * Event generated for each search result
653 * when the respective search is suspended.
655 GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND,
658 * Last message from a search; this signals
659 * that there will be no further events associated
662 GNUNET_FS_STATUS_SEARCH_STOPPED,
665 * Notification that we started to unindex a file.
667 GNUNET_FS_STATUS_UNINDEX_START,
670 * Notification that we resumed unindexing of a file.
672 GNUNET_FS_STATUS_UNINDEX_RESUME,
675 * Notification that we suspended unindexing a file.
677 GNUNET_FS_STATUS_UNINDEX_SUSPEND,
680 * Notification that we made progress unindexing a file.
682 GNUNET_FS_STATUS_UNINDEX_PROGRESS,
685 * Notification that we encountered an error unindexing
688 GNUNET_FS_STATUS_UNINDEX_ERROR,
691 * Notification that the unindexing of this file
694 GNUNET_FS_STATUS_UNINDEX_COMPLETED,
697 * Notification that the unindexing of this file
698 * was stopped (final event for this action).
700 GNUNET_FS_STATUS_UNINDEX_STOPPED
706 * Handle for controlling an upload.
708 struct GNUNET_FS_PublishContext;
712 * Handle for controlling an unindexing operation.
714 struct GNUNET_FS_UnindexContext;
718 * Handle for controlling a search.
720 struct GNUNET_FS_SearchContext;
724 * Result from a search. Opaque handle to refer to the search
725 * (typically used when starting a download associated with the search
728 struct GNUNET_FS_SearchResult;
732 * Context for controlling a download.
734 struct GNUNET_FS_DownloadContext;
738 * Handle for detail information about a file that is being publishd.
739 * Specifies metadata, keywords, how to get the contents of the file
740 * (i.e. data-buffer in memory, filename on disk) and other options.
742 struct GNUNET_FS_FileInformation;
746 * Argument given to the progress callback with
747 * information about what is going on.
749 struct GNUNET_FS_ProgressInfo
753 * Values that depend on the event type.
758 * Values for all "GNUNET_FS_STATUS_PUBLISH_*" events.
763 * Context for controlling the upload.
765 struct GNUNET_FS_PublishContext *pc;
768 * Information about the file that is being publishd.
770 const struct GNUNET_FS_FileInformation *fi;
773 * Client context pointer (set the last time by the client for
774 * this operation; initially NULL on START/RESUME events).
779 * Client context pointer for the parent operation
780 * (if this is a file in a directory or a subdirectory).
785 * Name of the file being published; can be NULL.
787 const char *filename;
790 * How large is the file overall? For directories,
791 * this is only the size of the directory itself,
792 * not of the other files contained within the
798 * At what time do we expect to finish the upload?
799 * (will be a value in the past for completed
802 struct GNUNET_TIME_Relative eta;
805 * How long has this upload been actively running
806 * (excludes times where the upload was suspended).
808 struct GNUNET_TIME_Relative duration;
811 * How many bytes have we completed?
816 * What anonymity level is used for this upload?
821 * Additional values for specific events.
826 * These values are only valid for
827 * GNUNET_FS_STATUS_PUBLISH_PROGRESS events.
832 * Data block we just published.
837 * At what offset in the file is "data"?
842 * Length of the data block.
847 * Depth of the given block in the tree;
848 * 0 would be the highest level (the first
849 * call is guaranteed to be for the lowest
857 * These values are only valid for
858 * GNUNET_FS_STATUS_PUBLISH_RESUME events.
863 * Error message, NULL if no error was encountered so far.
868 * URI of the file (if the download had been completed)
870 const struct GNUNET_FS_Uri *chk_uri;
875 * These values are only valid for
876 * GNUNET_FS_STATUS_PUBLISH_COMPLETED events.
883 const struct GNUNET_FS_Uri *chk_uri;
888 * These values are only valid for
889 * GNUNET_FS_STATUS_PUBLISH_ERROR events.
894 * Error message, never NULL.
906 * Values for all "GNUNET_FS_STATUS_DOWNLOAD_*" events.
911 * Context for controlling the download.
913 struct GNUNET_FS_DownloadContext *dc;
916 * Client context pointer (set the last time
917 * by the client for this operation; initially
918 * NULL on START/RESUME events).
923 * Client context pointer for the parent operation
924 * (if this is a file in a directory or a subdirectory).
929 * Client context pointer for the associated search operation
930 * (specifically, context pointer for the specific search
931 * result, not the overall search); only set if this
932 * download was started from a search result.
937 * URI used for this download.
939 const struct GNUNET_FS_Uri *uri;
942 * Name of the file that we are downloading.
944 const char *filename;
947 * How large is the download overall? This
948 * is NOT necessarily the size from the
949 * URI since we may be doing a partial download.
954 * At what time do we expect to finish the download?
955 * (will be a value in the past for completed
958 struct GNUNET_TIME_Relative eta;
961 * How long has this download been active?
963 struct GNUNET_TIME_Relative duration;
966 * How many bytes have we completed?
971 * What anonymity level is used for this download?
976 * Is the download currently active.
981 * Additional values for specific events.
986 * These values are only valid for
987 * GNUNET_FS_STATUS_DOWNLOAD_PROGRESS events.
992 * Data block we just obtained.
997 * At what offset in the file is "data"?
1002 * Length of the data block.
1007 * Depth of the given block in the tree;
1008 * 0 would be the highest level (the first
1009 * call is guaranteed to be for the lowest
1017 * These values are only valid for
1018 * GNUNET_FS_STATUS_DOWNLOAD_START events.
1023 * Known metadata for the download.
1025 const struct GNUNET_CONTAINER_MetaData *meta;
1030 * These values are only valid for
1031 * GNUNET_FS_STATUS_DOWNLOAD_RESUME events.
1036 * Known metadata for the download.
1038 const struct GNUNET_CONTAINER_MetaData *meta;
1041 * Error message, NULL if we have not encountered any error yet.
1043 const char *message;
1048 * These values are only valid for
1049 * GNUNET_FS_STATUS_DOWNLOAD_ERROR events.
1056 const char *message;
1065 * Values for all "GNUNET_FS_STATUS_SEARCH_*" events.
1070 * Context for controlling the search, NULL for
1071 * searches that were not explicitly triggered
1072 * by the client (i.e., searches for updates in
1075 struct GNUNET_FS_SearchContext *sc;
1078 * Client context pointer (set the last time by the client for
1079 * this operation; initially NULL on START/RESUME events). Note
1080 * that this value can only be set on START/RESUME; returning
1081 * non-NULL on RESULT/RESUME_RESULT will actually update the
1082 * private context for "UPDATE" events.
1087 * Client parent-context pointer; NULL for top-level searches,
1088 * refers to the client context of the associated search result
1089 * for automatically triggered searches for updates in
1090 * namespaces. In this case, 'presult' refers to that search
1096 * What query is used for this search
1097 * (list of keywords or SKS identifier).
1099 const struct GNUNET_FS_Uri *query;
1102 * How long has this search been actively running
1103 * (excludes times where the search was paused or
1106 struct GNUNET_TIME_Relative duration;
1109 * What anonymity level is used for this search?
1114 * Additional values for specific events.
1119 * These values are only valid for
1120 * GNUNET_FS_STATUS_SEARCH_RESULT events.
1125 * Metadata for the search result.
1127 const struct GNUNET_CONTAINER_MetaData *meta;
1130 * URI for the search result.
1132 const struct GNUNET_FS_Uri *uri;
1135 * Handle to the result (for starting downloads).
1137 struct GNUNET_FS_SearchResult *result;
1140 * Applicability rank (the larger, the better the result
1141 * fits the search criteria).
1143 uint32_t applicability_rank;
1148 * These values are only valid for
1149 * GNUNET_FS_STATUS_SEARCH_RESUME_RESULT events.
1154 * Metadata for the search result.
1156 const struct GNUNET_CONTAINER_MetaData *meta;
1159 * URI for the search result.
1161 const struct GNUNET_FS_Uri *uri;
1164 * Handle to the result (for starting downloads).
1166 struct GNUNET_FS_SearchResult *result;
1169 * Current availability rank (negative:
1170 * unavailable, positive: available)
1172 int32_t availability_rank;
1175 * On how many total queries is the given
1176 * availability_rank based?
1178 uint32_t availability_certainty;
1181 * Updated applicability rank (the larger,
1182 * the better the result fits the search
1185 uint32_t applicability_rank;
1190 * These values are only valid for
1191 * GNUNET_FS_STATUS_SEARCH_UPDATE events.
1196 * Private context set for for this result
1197 * during the "RESULT" event.
1202 * Metadata for the search result.
1204 const struct GNUNET_CONTAINER_MetaData *meta;
1207 * URI for the search result.
1209 const struct GNUNET_FS_Uri *uri;
1212 * Current availability rank (negative:
1213 * unavailable, positive: available)
1215 int32_t availability_rank;
1218 * On how many total queries is the given
1219 * availability_rank based?
1221 uint32_t availability_certainty;
1224 * Updated applicability rank (the larger,
1225 * the better the result fits the search
1228 uint32_t applicability_rank;
1233 * These values are only valid for
1234 * GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND events.
1235 * These events are automatically triggered for
1236 * each search result before the
1237 * GNUNET_FS_STATUS_SEARCH_SUSPEND event. This
1238 * happens primarily to give the client a chance
1239 * to clean up the "cctx" (if needed).
1244 * Private context set for for this result
1245 * during the "RESULT" event.
1250 * Metadata for the search result.
1252 const struct GNUNET_CONTAINER_MetaData *meta;
1255 * URI for the search result.
1257 const struct GNUNET_FS_Uri *uri;
1262 * These values are only valid for
1263 * GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED events.
1264 * These events are automatically triggered for
1265 * each search result before the
1266 * GNUNET_FS_STATUS_SEARCH_STOPPED event. This
1267 * happens primarily to give the client a chance
1268 * to clean up the "cctx" (if needed).
1273 * Private context set for for this result
1274 * during the "RESULT" event.
1279 * Metadata for the search result.
1281 const struct GNUNET_CONTAINER_MetaData *meta;
1284 * URI for the search result.
1286 const struct GNUNET_FS_Uri *uri;
1291 * These values are only valid for
1292 * GNUNET_FS_STATUS_SEARCH_RESUME events.
1297 * Error message, NULL if we have not encountered any error yet.
1299 const char *message;
1302 * Is this search currently paused?
1309 * These values are only valid for
1310 * GNUNET_FS_STATUS_SEARCH_ERROR events.
1317 const char *message;
1322 * Values for all "GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE" events.
1327 * Handle to the namespace (NULL if it is not a local
1330 struct GNUNET_FS_Namespace *ns;
1333 * Short, human-readable name of the namespace.
1338 * Root identifier for the namespace, can be NULL.
1343 * Metadata for the namespace.
1345 const struct GNUNET_CONTAINER_MetaData *meta;
1348 * Hash-identifier for the namespace.
1359 * Values for all "GNUNET_FS_STATUS_UNINDEX_*" events.
1364 * Context for controlling the unindexing.
1366 struct GNUNET_FS_UnindexContext *uc;
1369 * Client context pointer (set the last time
1370 * by the client for this operation; initially
1371 * NULL on START/RESUME events).
1376 * Name of the file that is being unindexed.
1378 const char *filename;
1381 * How large is the file overall?
1386 * At what time do we expect to finish unindexing?
1387 * (will be a value in the past for completed
1388 * unindexing opeations).
1390 struct GNUNET_TIME_Relative eta;
1393 * How long has this upload been actively running
1394 * (excludes times where the upload was suspended).
1396 struct GNUNET_TIME_Relative duration;
1399 * How many bytes have we completed?
1404 * Additional values for specific events.
1409 * These values are only valid for
1410 * GNUNET_FS_STATUS_UNINDEX_PROGRESS events.
1415 * Data block we just unindexed.
1420 * At what offset in the file is "data"?
1425 * Length of the data block.
1430 * Depth of the given block in the tree;
1431 * 0 would be the highest level (the first
1432 * call is guaranteed to be for the lowest
1440 * These values are only valid for
1441 * GNUNET_FS_STATUS_UNINDEX_RESUME events.
1446 * Error message, NULL if we have not encountered any error yet.
1448 const char *message;
1453 * These values are only valid for
1454 * GNUNET_FS_STATUS_UNINDEX_ERROR events.
1461 const char *message;
1472 * Specific status code (determines the event type).
1474 enum GNUNET_FS_Status status;
1480 * Notification of FS to a client about the progress of an
1481 * operation. Callbacks of this type will be used for uploads,
1482 * downloads and searches. Some of the arguments depend a bit
1483 * in their meaning on the context in which the callback is used.
1485 * @param cls closure
1486 * @param info details about the event, specifying the event type
1487 * and various bits about the event
1488 * @return client-context (for the next progress call
1489 * for this operation; should be set to NULL for
1490 * SUSPEND and STOPPED events). The value returned
1491 * will be passed to future callbacks in the respective
1492 * field in the GNUNET_FS_ProgressInfo struct.
1494 typedef void* (*GNUNET_FS_ProgressCallback)
1496 const struct GNUNET_FS_ProgressInfo *info);
1500 * General (global) option flags for file-sharing.
1502 enum GNUNET_FS_Flags
1505 * No special flags set.
1507 GNUNET_FS_FLAGS_NONE = 0,
1510 * Is persistence of operations desired?
1511 * (will create SUSPEND/RESUME events).
1513 GNUNET_FS_FLAGS_PERSISTENCE = 1,
1516 * Should we automatically trigger probes for search results
1517 * to determine availability?
1518 * (will create GNUNET_FS_STATUS_SEARCH_UPDATE events).
1520 GNUNET_FS_FLAGS_DO_PROBES = 2
1525 * Options specified in the VARARGs portion of GNUNET_FS_start.
1527 enum GNUNET_FS_OPTIONS
1531 * Last option in the VARARG list.
1533 GNUNET_FS_OPTIONS_END = 0,
1536 * Select the desired amount of parallelism (this option should be
1537 * followed by an "unsigned int" giving the desired maximum number
1538 * of parallel downloads).
1540 GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM = 1,
1543 * Maximum number of requests that should be pending at a given
1544 * point in time (invidivual downloads may go above this, but
1545 * if we are above this threshold, we should not activate any
1546 * additional downloads.
1548 GNUNET_FS_OPTIONS_REQUEST_PARALLELISM = 2
1554 * Handle to the file-sharing service.
1556 struct GNUNET_FS_Handle;
1560 * Setup a connection to the file-sharing service.
1562 * @param sched scheduler to use
1563 * @param cfg configuration to use
1564 * @param client_name unique identifier for this client
1565 * @param upcb function to call to notify about FS actions
1566 * @param upcb_cls closure for upcb
1567 * @param flags specific attributes for fs-operations
1568 * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
1569 * @return NULL on error
1571 struct GNUNET_FS_Handle *
1572 GNUNET_FS_start (struct GNUNET_SCHEDULER_Handle *sched,
1573 const struct GNUNET_CONFIGURATION_Handle *cfg,
1574 const char *client_name,
1575 GNUNET_FS_ProgressCallback upcb,
1577 enum GNUNET_FS_Flags flags,
1582 * Close our connection with the file-sharing service.
1583 * The callback given to GNUNET_FS_start will no longer be
1584 * called after this function returns.
1586 * @param h handle that was returned from GNUNET_FS_start
1589 GNUNET_FS_stop (struct GNUNET_FS_Handle *h);
1593 * Extract meta-data from a file.
1595 * @param md metadata to set
1596 * @param filename name of file to inspect
1597 * @param extractors plugins to use
1598 * @return GNUNET_SYSERR on error, otherwise the number
1599 * of meta-data items obtained
1602 GNUNET_FS_meta_data_extract_from_file (struct
1603 GNUNET_CONTAINER_MetaData
1604 *md, const char *filename,
1605 struct EXTRACTOR_PluginList *
1610 * Function called on entries in a GNUNET_FS_FileInformation publish-structure.
1612 * @param cls closure
1613 * @param fi the entry in the publish-structure
1614 * @param length length of the file or directory
1615 * @param meta metadata for the file or directory (can be modified)
1616 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1617 * @param anonymity pointer to selected anonymity level (can be modified)
1618 * @param priority pointer to selected priority (can be modified)
1619 * @param do_index should we index (can be modified)
1620 * @param expirationTime pointer to selected expiration time (can be modified)
1621 * @param client_info pointer to client context set upon creation (can be modified)
1622 * @return GNUNET_OK to continue, GNUNET_NO to remove
1623 * this entry from the directory, GNUNET_SYSERR
1624 * to abort the iteration
1626 typedef int (*GNUNET_FS_FileInformationProcessor)(void *cls,
1627 struct GNUNET_FS_FileInformation *fi,
1629 struct GNUNET_CONTAINER_MetaData *meta,
1630 struct GNUNET_FS_Uri **uri,
1631 uint32_t *anonymity,
1634 struct GNUNET_TIME_Absolute *expirationTime,
1635 void **client_info);
1639 * Obtain the name under which this file information
1640 * structure is stored on disk. Only works for top-level
1641 * file information structures.
1643 * @param s structure to get the filename for
1644 * @return NULL on error, otherwise filename that
1645 * can be passed to "GNUNET_FS_file_information_recover"
1646 * to read this fi-struct from disk.
1649 GNUNET_FS_file_information_get_id (struct GNUNET_FS_FileInformation *s);
1654 * Create an entry for a file in a publish-structure.
1656 * @param h handle to the file sharing subsystem
1657 * @param client_info initial client-info value for this entry
1658 * @param filename name of the file or directory to publish
1659 * @param keywords under which keywords should this file be available
1660 * directly; can be NULL
1661 * @param meta metadata for the file
1662 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1663 * GNUNET_SYSERR for simulation
1664 * @param anonymity what is the desired anonymity level for sharing?
1665 * @param priority what is the priority for OUR node to
1666 * keep this file available? Use 0 for maximum anonymity and
1667 * minimum reliability...
1668 * @param expirationTime when should this content expire?
1669 * @return publish structure entry for the file
1671 struct GNUNET_FS_FileInformation *
1672 GNUNET_FS_file_information_create_from_file (struct GNUNET_FS_Handle *h,
1674 const char *filename,
1675 const struct GNUNET_FS_Uri *keywords,
1676 const struct GNUNET_CONTAINER_MetaData *meta,
1680 struct GNUNET_TIME_Absolute expirationTime);
1684 * Create an entry for a file in a publish-structure.
1686 * @param h handle to the file sharing subsystem
1687 * @param client_info initial client-info value for this entry
1688 * @param length length of the file
1689 * @param data data for the file (should not be used afterwards by
1690 * the caller; callee will "free")
1691 * @param keywords under which keywords should this file be available
1692 * directly; can be NULL
1693 * @param meta metadata for the file
1694 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1695 * GNUNET_SYSERR for simulation
1696 * @param anonymity what is the desired anonymity level for sharing?
1697 * @param priority what is the priority for OUR node to
1698 * keep this file available? Use 0 for maximum anonymity and
1699 * minimum reliability...
1700 * @param expirationTime when should this content expire?
1701 * @return publish structure entry for the file
1703 struct GNUNET_FS_FileInformation *
1704 GNUNET_FS_file_information_create_from_data (struct GNUNET_FS_Handle *h,
1708 const struct GNUNET_FS_Uri *keywords,
1709 const struct GNUNET_CONTAINER_MetaData *meta,
1713 struct GNUNET_TIME_Absolute expirationTime);
1717 * Function that provides data.
1719 * @param cls closure
1720 * @param offset offset to read from; it is possible
1721 * that the caller might need to go backwards
1723 * @param max maximum number of bytes that should be
1724 * copied to buf; readers are not allowed
1725 * to provide less data unless there is an error;
1726 * a value of "0" will be used at the end to allow
1727 * the reader to clean up its internal state
1728 * @param buf where the reader should write the data
1729 * @param emsg location for the reader to store an error message
1730 * @return number of bytes written, usually "max", 0 on error
1732 typedef size_t (*GNUNET_FS_DataReader)(void *cls,
1740 * Create an entry for a file in a publish-structure.
1742 * @param h handle to the file sharing subsystem
1743 * @param client_info initial client-info value for this entry
1744 * @param length length of the file
1745 * @param reader function that can be used to obtain the data for the file
1746 * @param reader_cls closure for "reader"
1747 * @param keywords under which keywords should this file be available
1748 * directly; can be NULL
1749 * @param meta metadata for the file
1750 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1751 * GNUNET_SYSERR for simulation
1752 * @param anonymity what is the desired anonymity level for sharing?
1753 * @param priority what is the priority for OUR node to
1754 * keep this file available? Use 0 for maximum anonymity and
1755 * minimum reliability...
1756 * @param expirationTime when should this content expire?
1757 * @return publish structure entry for the file
1759 struct GNUNET_FS_FileInformation *
1760 GNUNET_FS_file_information_create_from_reader (struct GNUNET_FS_Handle *h,
1763 GNUNET_FS_DataReader reader,
1765 const struct GNUNET_FS_Uri *keywords,
1766 const struct GNUNET_CONTAINER_MetaData *meta,
1770 struct GNUNET_TIME_Absolute expirationTime);
1774 * Function that a "GNUNET_FS_DirectoryScanner" should call
1775 * for each entry in the directory.
1777 * @param cls closure
1778 * @param filename name of the file (including path); must end
1779 * in a "/" (even on W32) if this is a directory
1780 * @param fi information about the file (should not be
1781 * used henceforth by the caller)
1783 typedef void (*GNUNET_FS_FileProcessor)(void *cls,
1784 const char *filename,
1785 struct GNUNET_FS_FileInformation *fi);
1789 * Type of a function that will be used to scan a directory.
1791 * @param cls closure
1792 * @param h handle to the file sharing subsystem
1793 * @param dirname name of the directory to scan
1794 * @param do_index should files be indexed or inserted
1795 * @param anonymity desired anonymity level
1796 * @param priority priority for publishing
1797 * @param expirationTime expiration for publication
1798 * @param proc function to call on each entry
1799 * @param proc_cls closure for proc
1800 * @param emsg where to store an error message (on errors)
1801 * @return GNUNET_OK on success
1803 typedef int (*GNUNET_FS_DirectoryScanner)(void *cls,
1804 struct GNUNET_FS_Handle *h,
1805 const char *dirname,
1809 struct GNUNET_TIME_Absolute expirationTime,
1810 GNUNET_FS_FileProcessor proc,
1817 * Simple, useful default implementation of a directory scanner
1818 * (GNUNET_FS_DirectoryScanner). This implementation expects to get a
1819 * UNIX filename, will publish all files in the directory except hidden
1820 * files (those starting with a "."). Metadata will be extracted
1821 * using GNU libextractor; the specific list of plugins should be
1822 * specified in "cls", passing NULL will disable (!) metadata
1823 * extraction. Keywords will be derived from the metadata and be
1824 * subject to default canonicalization. This is strictly a
1825 * convenience function.
1827 * @param cls must be of type "struct EXTRACTOR_Extractor*"
1828 * @param h handle to the file sharing subsystem
1829 * @param dirname name of the directory to scan
1830 * @param do_index should files be indexed or inserted
1831 * @param anonymity desired anonymity level
1832 * @param priority priority for publishing
1833 * @param expirationTime expiration for publication
1834 * @param proc function called on each entry
1835 * @param proc_cls closure for proc
1836 * @param emsg where to store an error message (on errors)
1837 * @return GNUNET_OK on success
1840 GNUNET_FS_directory_scanner_default (void *cls,
1841 struct GNUNET_FS_Handle *h,
1842 const char *dirname,
1846 struct GNUNET_TIME_Absolute expirationTime,
1847 GNUNET_FS_FileProcessor proc,
1853 * Create a publish-structure from an existing file hierarchy, inferring
1854 * and organizing keywords and metadata as much as possible. This
1855 * function primarily performs the recursive build and re-organizes
1856 * keywords and metadata; for automatically getting metadata
1857 * extraction, scanning of directories and creation of the respective
1858 * GNUNET_FS_FileInformation entries the default scanner should be
1859 * passed (GNUNET_FS_directory_scanner_default). This is strictly a
1860 * convenience function.
1862 * @param h handle to the file sharing subsystem
1863 * @param client_info initial client-info value for this entry
1864 * @param filename name of the top-level file or directory
1865 * @param scanner function used to get a list of files in a directory
1866 * @param scanner_cls closure for scanner
1867 * @param do_index should files in the hierarchy be indexed?
1868 * @param anonymity what is the desired anonymity level for sharing?
1869 * @param priority what is the priority for OUR node to
1870 * keep this file available? Use 0 for maximum anonymity and
1871 * minimum reliability...
1872 * @param expirationTime when should this content expire?
1873 * @param emsg where to store an error message
1874 * @return publish structure entry for the directory, NULL on error
1876 struct GNUNET_FS_FileInformation *
1877 GNUNET_FS_file_information_create_from_directory (struct GNUNET_FS_Handle *h,
1879 const char *filename,
1880 GNUNET_FS_DirectoryScanner scanner,
1885 struct GNUNET_TIME_Absolute expirationTime,
1890 * Create an entry for an empty directory in a publish-structure.
1891 * This function should be used by applications for which the
1892 * use of "GNUNET_FS_file_information_create_from_directory"
1893 * is not appropriate.
1895 * @param h handle to the file sharing subsystem
1896 * @param client_info initial client-info value for this entry
1897 * @param keywords under which keywords should this directory be available
1898 * directly; can be NULL
1899 * @param meta metadata for the directory
1900 * @param anonymity what is the desired anonymity level for sharing?
1901 * @param priority what is the priority for OUR node to
1902 * keep this file available? Use 0 for maximum anonymity and
1903 * minimum reliability...
1904 * @param expirationTime when should this content expire?
1905 * @return publish structure entry for the directory , NULL on error
1907 struct GNUNET_FS_FileInformation *
1908 GNUNET_FS_file_information_create_empty_directory (struct GNUNET_FS_Handle *h,
1910 const struct GNUNET_FS_Uri *keywords,
1911 const struct GNUNET_CONTAINER_MetaData *meta,
1914 struct GNUNET_TIME_Absolute expirationTime);
1918 * Test if a given entry represents a directory.
1920 * @param ent check if this FI represents a directory
1921 * @return GNUNET_YES if so, GNUNET_NO if not
1924 GNUNET_FS_file_information_is_directory (struct GNUNET_FS_FileInformation *ent);
1928 * Add an entry to a directory in a publish-structure. Clients
1929 * should never modify publish structures that were passed to
1930 * "GNUNET_FS_publish_start" already.
1932 * @param dir the directory
1933 * @param ent the entry to add; the entry must not have been
1934 * added to any other directory at this point and
1935 * must not include "dir" in its structure
1936 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1939 GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
1940 struct GNUNET_FS_FileInformation *ent);
1944 * Inspect a file or directory in a publish-structure. Clients
1945 * should never modify publish structures that were passed to
1946 * "GNUNET_FS_publish_start" already. When called on a directory,
1947 * this function will FIRST call "proc" with information about
1948 * the directory itself and then for each of the files in the
1949 * directory (but not for files in subdirectories). When called
1950 * on a file, "proc" will be called exactly once (with information
1951 * about the specific file).
1953 * @param dir the directory
1954 * @param proc function to call on each entry
1955 * @param proc_cls closure for proc
1958 GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir,
1959 GNUNET_FS_FileInformationProcessor proc,
1964 * Destroy publish-structure. Clients should never destroy publish
1965 * structures that were passed to "GNUNET_FS_publish_start" already.
1967 * @param fi structure to destroy
1968 * @param cleaner function to call on each entry in the structure
1969 * (useful to clean up client_info); can be NULL; return
1970 * values are ignored
1971 * @param cleaner_cls closure for cleaner
1974 GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi,
1975 GNUNET_FS_FileInformationProcessor cleaner,
1980 * Options for publishing. Compatible options
1981 * can be OR'ed together.
1983 enum GNUNET_FS_PublishOptions
1986 * No options (use defaults for everything).
1988 GNUNET_FS_PUBLISH_OPTION_NONE = 0,
1991 * Simulate publishing. With this option, no data will be stored
1992 * in the datastore. Useful for computing URIs from files.
1994 GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY = 1
1998 * Publish a file or directory.
2000 * @param h handle to the file sharing subsystem
2001 * @param fi information about the file or directory structure to publish
2002 * @param namespace namespace to publish the file in, NULL for no namespace
2003 * @param nid identifier to use for the publishd content in the namespace
2004 * (can be NULL, must be NULL if namespace is NULL)
2005 * @param nuid update-identifier that will be used for future updates
2006 * (can be NULL, must be NULL if namespace or nid is NULL)
2007 * @param options options for the publication
2008 * @return context that can be used to control the publish operation
2010 struct GNUNET_FS_PublishContext *
2011 GNUNET_FS_publish_start (struct GNUNET_FS_Handle *h,
2012 struct GNUNET_FS_FileInformation *fi,
2013 struct GNUNET_FS_Namespace *namespace,
2016 enum GNUNET_FS_PublishOptions options);
2020 * Stop a publication. Will abort incomplete publications (but
2021 * not remove blocks that have already been published) or
2022 * simply clean up the state for completed publications.
2023 * Must NOT be called from within the event callback!
2025 * @param pc context for the publication to stop
2028 GNUNET_FS_publish_stop (struct GNUNET_FS_PublishContext *pc);
2032 * Signature of a function called as the continuation of a KBlock or
2033 * SBlock publication.
2035 * @param cls closure
2036 * @param uri URI under which the block is now available, NULL on error
2037 * @param emsg error message, NULL on success
2039 typedef void (*GNUNET_FS_PublishContinuation)(void *cls,
2040 const struct GNUNET_FS_Uri *uri,
2045 * Publish a KBlock on GNUnet.
2047 * @param h handle to the file sharing subsystem
2048 * @param ksk_uri keywords to use
2049 * @param meta metadata to use
2050 * @param uri URI to refer to in the KBlock
2051 * @param expirationTime when the KBlock expires
2052 * @param anonymity anonymity level for the KBlock
2053 * @param priority priority for the KBlock
2054 * @param cont continuation
2055 * @param cont_cls closure for cont
2058 GNUNET_FS_publish_ksk (struct GNUNET_FS_Handle *h,
2059 const struct GNUNET_FS_Uri *ksk_uri,
2060 const struct GNUNET_CONTAINER_MetaData *meta,
2061 const struct GNUNET_FS_Uri *uri,
2062 struct GNUNET_TIME_Absolute expirationTime,
2065 enum GNUNET_FS_PublishOptions options,
2066 GNUNET_FS_PublishContinuation cont,
2071 * Publish an SBlock on GNUnet.
2073 * @param h handle to the file sharing subsystem
2074 * @param namespace namespace to publish in
2075 * @param identifier identifier to use
2076 * @param update update identifier to use
2077 * @param meta metadata to use
2078 * @param uri URI to refer to in the SBlock
2079 * @param expirationTime when the SBlock expires
2080 * @param anonymity anonymity level for the SBlock
2081 * @param priority priority for the SBlock
2082 * @param cont continuation
2083 * @param cont_cls closure for cont
2086 GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
2087 struct GNUNET_FS_Namespace *namespace,
2088 const char *identifier,
2090 const struct GNUNET_CONTAINER_MetaData *meta,
2091 const struct GNUNET_FS_Uri *uri,
2092 struct GNUNET_TIME_Absolute expirationTime,
2095 enum GNUNET_FS_PublishOptions options,
2096 GNUNET_FS_PublishContinuation cont,
2101 * Type of a function called by "GNUNET_FS_get_indexed_files".
2103 * @param cls closure
2104 * @param filename the name of the file
2105 * @param file_id hash of the contents of the indexed file
2106 * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
2108 typedef int (*GNUNET_FS_IndexedFileProcessor) (void *cls,
2109 const char *filename,
2110 const GNUNET_HashCode *file_id);
2114 * Iterate over all indexed files.
2116 * @param h handle to the file sharing subsystem
2117 * @param iterator function to call on each indexed file
2118 * @param iterator_cls closure for iterator
2119 * @param cont continuation to call when done;
2120 * reason should be "TIMEOUT" (on
2121 * error) or "PREREQ_DONE" (on success)
2122 * @param cont_cls closure for cont
2125 GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
2126 GNUNET_FS_IndexedFileProcessor iterator,
2128 GNUNET_SCHEDULER_Task cont,
2135 * @param h handle to the file sharing subsystem
2136 * @param filename file to unindex
2137 * @param cctx initial value for the client context
2138 * @return NULL on error, otherwise handle
2140 struct GNUNET_FS_UnindexContext *
2141 GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h,
2142 const char *filename,
2147 * Clean up after completion of an unindex operation.
2152 GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc);
2156 * Publish an advertismement for a namespace.
2158 * @param h handle to the file sharing subsystem
2159 * @param ksk_uri keywords to use for advertisment
2160 * @param namespace handle for the namespace that should be advertised
2161 * @param meta meta-data for the namespace advertisement
2162 * @param anonymity for the namespace advertismement
2163 * @param priority for the namespace advertisement
2164 * @param expiration for the namespace advertisement
2165 * @param rootEntry name of the root of the namespace
2166 * @param cont continuation
2167 * @param cont_cls closure for cont
2170 GNUNET_FS_namespace_advertise (struct GNUNET_FS_Handle *h,
2171 struct GNUNET_FS_Uri *ksk_uri,
2172 struct GNUNET_FS_Namespace *namespace,
2173 const struct GNUNET_CONTAINER_MetaData *meta,
2176 struct GNUNET_TIME_Absolute expiration,
2177 const char *rootEntry,
2178 GNUNET_FS_PublishContinuation cont,
2183 * Create a namespace with the given name; if one already
2184 * exists, return a handle to the existing namespace.
2186 * @param h handle to the file sharing subsystem
2187 * @param name name to use for the namespace
2188 * @return handle to the namespace, NULL on error
2190 struct GNUNET_FS_Namespace *
2191 GNUNET_FS_namespace_create (struct GNUNET_FS_Handle *h,
2196 * Delete a namespace handle. Can be used for a clean shutdown (free
2197 * memory) or also to freeze the namespace to prevent further
2198 * insertions by anyone.
2200 * @param namespace handle to the namespace that should be deleted / freed
2201 * @param freeze prevents future insertions; creating a namespace
2202 * with the same name again will create a fresh namespace instead
2204 * @return GNUNET_OK on success, GNUNET_SYSERR on error
2207 GNUNET_FS_namespace_delete (struct GNUNET_FS_Namespace *namespace,
2212 * Callback with information about local (!) namespaces.
2213 * Contains the names of the local namespace and the global
2216 * @param cls closure
2217 * @param name human-readable identifier of the namespace
2218 * @param id hash identifier for the namespace
2220 typedef void (*GNUNET_FS_NamespaceInfoProcessor) (void *cls,
2222 const GNUNET_HashCode *id);
2226 * Build a list of all available local (!) namespaces The returned
2227 * names are only the nicknames since we only iterate over the local
2230 * @param h handle to the file sharing subsystem
2231 * @param cb function to call on each known namespace
2232 * @param cb_cls closure for cb
2235 GNUNET_FS_namespace_list (struct GNUNET_FS_Handle *h,
2236 GNUNET_FS_NamespaceInfoProcessor cb,
2241 * Function called on updateable identifiers.
2243 * @param cls closure
2244 * @param last_id last identifier
2245 * @param last_uri uri used for the content published under the last_id
2246 * @param last_meta metadata associated with last_uri
2247 * @param next_id identifier that should be used for updates
2250 (*GNUNET_FS_IdentifierProcessor)(void *cls,
2251 const char *last_id,
2252 const struct GNUNET_FS_Uri *last_uri,
2253 const struct GNUNET_CONTAINER_MetaData *last_meta,
2254 const char *next_id);
2258 * List all of the identifiers in the namespace for which we could
2259 * produce an update. Namespace updates form a graph where each node
2260 * has a name. Each node can have any number of URI/meta-data entries
2261 * which can each be linked to other nodes. Cycles are possible.
2263 * Calling this function with "next_id" NULL will cause the library to
2264 * call "ip" with a root for each strongly connected component of the
2265 * graph (a root being a node from which all other nodes in the Scc
2268 * Calling this function with "next_id" being the name of a node will
2269 * cause the library to call "ip" with all children of the node. Note
2270 * that cycles within an SCC are possible (including self-loops).
2272 * @param namespace namespace to inspect for updateable content
2273 * @param next_id ID to look for; use NULL to look for SCC roots
2274 * @param ip function to call on each updateable identifier
2275 * @param ip_cls closure for ip
2278 GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Namespace *namespace,
2279 const char *next_id,
2280 GNUNET_FS_IdentifierProcessor ip,
2285 * Options for searching. Compatible options
2286 * can be OR'ed together.
2288 enum GNUNET_FS_SearchOptions
2291 * No options (use defaults for everything).
2293 GNUNET_FS_SEARCH_OPTION_NONE = 0,
2296 * Only search the local host, do not search remote systems (no P2P)
2298 GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY = 1
2304 * Start search for content.
2306 * @param h handle to the file sharing subsystem
2307 * @param uri specifies the search parameters; can be
2308 * a KSK URI or an SKS URI.
2309 * @param anonymity desired level of anonymity
2310 * @param options options for the search
2311 * @param cctx initial value for the client context
2312 * @return context that can be used to control the search
2314 struct GNUNET_FS_SearchContext *
2315 GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
2316 const struct GNUNET_FS_Uri *uri,
2318 enum GNUNET_FS_SearchOptions options,
2325 * @param sc context for the search that should be paused
2328 GNUNET_FS_search_pause (struct GNUNET_FS_SearchContext *sc);
2332 * Continue paused search.
2334 * @param sc context for the search that should be resumed
2337 GNUNET_FS_search_continue (struct GNUNET_FS_SearchContext *sc);
2341 * Stop search for content.
2343 * @param sc context for the search that should be stopped
2346 GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc);
2352 * Options for downloading. Compatible options
2353 * can be OR'ed together.
2355 enum GNUNET_FS_DownloadOptions
2358 * No options (use defaults for everything).
2360 GNUNET_FS_DOWNLOAD_OPTION_NONE = 0,
2363 * Only download from the local host, do not access remote systems (no P2P)
2365 GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY = 1,
2368 * Do a recursive download (that is, automatically trigger the
2369 * download of files in directories).
2371 GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE = 2,
2374 * Do not append temporary data to
2375 * the target file (for the IBlocks).
2377 GNUNET_FS_DOWNLOAD_NO_TEMPORARIES = 4,
2380 * Internal option used to flag this download as a 'probe' for a
2381 * search result. Impacts the priority with which the download is
2382 * run and causes signalling callbacks to be done differently.
2383 * Also, probe downloads are not serialized on suspension. Normal
2384 * clients should not use this!
2386 GNUNET_FS_DOWNLOAD_IS_PROBE = (1<<31)
2393 * Download parts of a file. Note that this will store
2394 * the blocks at the respective offset in the given file. Also, the
2395 * download is still using the blocking of the underlying FS
2396 * encoding. As a result, the download may *write* outside of the
2397 * given boundaries (if offset and length do not match the 32k FS
2398 * block boundaries). <p>
2400 * The given range can be used to focus a download towards a
2401 * particular portion of the file (optimization), not to strictly
2402 * limit the download to exactly those bytes.
2404 * @param h handle to the file sharing subsystem
2405 * @param uri the URI of the file (determines what to download); CHK or LOC URI
2406 * @param meta known metadata for the file (can be NULL)
2407 * @param filename where to store the file, maybe NULL (then no file is
2408 * created on disk and data must be grabbed from the callbacks)
2409 * @param tempname where to store temporary file data, not used if filename is non-NULL;
2410 * can be NULL (in which case we will pick a name if needed); the temporary file
2411 * may already exist, in which case we will try to use the data that is there and
2412 * if it is not what is desired, will overwrite it
2413 * @param offset at what offset should we start the download (typically 0)
2414 * @param length how many bytes should be downloaded starting at offset
2415 * @param anonymity anonymity level to use for the download
2416 * @param options various download options
2417 * @param cctx initial value for the client context for this download
2418 * @param parent parent download to associate this download with (use NULL
2419 * for top-level downloads; useful for manually-triggered recursive downloads)
2420 * @return context that can be used to control this download
2422 struct GNUNET_FS_DownloadContext *
2423 GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
2424 const struct GNUNET_FS_Uri *uri,
2425 const struct GNUNET_CONTAINER_MetaData *meta,
2426 const char *filename,
2427 const char *tempname,
2431 enum GNUNET_FS_DownloadOptions options,
2433 struct GNUNET_FS_DownloadContext *parent);
2437 * Download parts of a file based on a search result. The download
2438 * will be associated with the search result (and the association
2439 * will be preserved when serializing/deserializing the state).
2440 * If the search is stopped, the download will not be aborted but
2441 * be 'promoted' to a stand-alone download.
2443 * As with the other download function, this will store
2444 * the blocks at the respective offset in the given file. Also, the
2445 * download is still using the blocking of the underlying FS
2446 * encoding. As a result, the download may *write* outside of the
2447 * given boundaries (if offset and length do not match the 32k FS
2448 * block boundaries). <p>
2450 * The given range can be used to focus a download towards a
2451 * particular portion of the file (optimization), not to strictly
2452 * limit the download to exactly those bytes.
2454 * @param h handle to the file sharing subsystem
2455 * @param sr the search result to use for the download (determines uri and
2456 * meta data and associations)
2457 * @param filename where to store the file, maybe NULL (then no file is
2458 * created on disk and data must be grabbed from the callbacks)
2459 * @param tempname where to store temporary file data, not used if filename is non-NULL;
2460 * can be NULL (in which case we will pick a name if needed); the temporary file
2461 * may already exist, in which case we will try to use the data that is there and
2462 * if it is not what is desired, will overwrite it
2463 * @param offset at what offset should we start the download (typically 0)
2464 * @param length how many bytes should be downloaded starting at offset
2465 * @param anonymity anonymity level to use for the download
2466 * @param options various download options
2467 * @param cctx initial value for the client context for this download
2468 * @return context that can be used to control this download
2470 struct GNUNET_FS_DownloadContext *
2471 GNUNET_FS_download_start_from_search (struct GNUNET_FS_Handle *h,
2472 struct GNUNET_FS_SearchResult *sr,
2473 const char *filename,
2474 const char *tempname,
2478 enum GNUNET_FS_DownloadOptions options,
2483 * Stop a download (aborts if download is incomplete).
2485 * @param dc handle for the download
2486 * @param do_delete delete files of incomplete downloads
2489 GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc,
2494 /* ******************** Directory API *********************** */
2497 #define GNUNET_FS_DIRECTORY_MIME "application/gnunet-directory"
2498 #define GNUNET_FS_DIRECTORY_MAGIC "\211GND\r\n\032\n"
2499 #define GNUNET_FS_DIRECTORY_EXT ".gnd"
2502 * Does the meta-data claim that this is a directory?
2503 * Checks if the mime-type is that of a GNUnet directory.
2505 * @return GNUNET_YES if it is, GNUNET_NO if it is not, GNUNET_SYSERR if
2506 * we have no mime-type information (treat as 'GNUNET_NO')
2509 GNUNET_FS_meta_data_test_for_directory (const struct GNUNET_CONTAINER_MetaData *md);
2513 * Set the MIMETYPE information for the given
2514 * metadata to "application/gnunet-directory".
2516 * @param md metadata to add mimetype to
2519 GNUNET_FS_meta_data_make_directory (struct GNUNET_CONTAINER_MetaData *md);
2523 * Suggest a filename based on given metadata.
2525 * @param md given meta data
2526 * @return NULL if meta data is useless for suggesting a filename
2529 GNUNET_FS_meta_data_suggest_filename (const struct GNUNET_CONTAINER_MetaData *md);
2533 * Function used to process entries in a directory.
2535 * @param cls closure
2536 * @param filename name of the file in the directory
2537 * @param uri URI of the file
2538 * @param metadata metadata for the file; metadata for
2539 * the directory if everything else is NULL/zero
2540 * @param length length of the available data for the file
2541 * (of type size_t since data must certainly fit
2542 * into memory; if files are larger than size_t
2543 * permits, then they will certainly not be
2544 * embedded with the directory itself).
2545 * @param data data available for the file (length bytes)
2547 typedef void (*GNUNET_FS_DirectoryEntryProcessor)(void *cls,
2548 const char *filename,
2549 const struct GNUNET_FS_Uri *uri,
2550 const struct GNUNET_CONTAINER_MetaData *meta,
2556 * Iterate over all entries in a directory. Note that directories
2557 * are structured such that it is possible to iterate over the
2558 * individual blocks as well as over the entire directory. Thus
2559 * a client can call this function on the buffer in the
2560 * GNUNET_FS_ProgressCallback. Also, directories can optionally
2561 * include the contents of (small) files embedded in the directory
2562 * itself; for those files, the processor may be given the
2563 * contents of the file directly by this function.
2565 * @param size number of bytes in data
2566 * @param data pointer to the beginning of the directory
2567 * @param offset offset of data in the directory
2568 * @param dep function to call on each entry
2569 * @param dep_cls closure for dep
2570 * @return GNUNET_OK if this could be a block in a directory,
2571 * GNUNET_NO if this could be part of a directory (but not 100% OK)
2572 * GNUNET_SYSERR if 'data' does not represent a directory
2575 GNUNET_FS_directory_list_contents (size_t size,
2578 GNUNET_FS_DirectoryEntryProcessor dep,
2583 * Opaque handle to a directory builder.
2585 struct GNUNET_FS_DirectoryBuilder;
2588 * Create a directory builder.
2590 * @param mdir metadata for the directory
2592 struct GNUNET_FS_DirectoryBuilder *
2593 GNUNET_FS_directory_builder_create (const struct GNUNET_CONTAINER_MetaData *mdir);
2597 * Add an entry to a directory.
2599 * @param bld directory to extend
2600 * @param uri uri of the entry (must not be a KSK)
2601 * @param md metadata of the entry
2602 * @param data raw data of the entry, can be NULL, otherwise
2603 * data must point to exactly the number of bytes specified
2607 GNUNET_FS_directory_builder_add (struct GNUNET_FS_DirectoryBuilder *bld,
2608 const struct GNUNET_FS_Uri *uri,
2609 const struct GNUNET_CONTAINER_MetaData *md,
2614 * Finish building the directory. Frees the
2615 * builder context and returns the directory
2618 * @param bld directory to finish
2619 * @param rsize set to the number of bytes needed
2620 * @param rdata set to the encoded directory
2621 * @return GNUNET_OK on success
2624 GNUNET_FS_directory_builder_finish (struct GNUNET_FS_DirectoryBuilder *bld,
2629 #if 0 /* keep Emacsens' auto-indent happy */