2 This file is part of GNUnet
3 Copyright (C) 2004--2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
21 * @author Christian Grothoff
24 * API for file sharing via GNUnet
26 * @defgroup fs FS service
29 * @see [Documentation](https://gnunet.org/file-sharing-service)
33 #ifndef GNUNET_FS_LIB_H
34 #define GNUNET_FS_LIB_H
36 #include "gnunet_util_lib.h"
41 #if 0 /* keep Emacsens' auto-indent happy */
47 * Version number of the implementation.
50 * 1.x.x: initial version with triple GNUNET_hash and merkle tree
51 * 2.x.x: root node with mime-type, filename and version number
52 * 2.1.x: combined GNUNET_EC_ContentHashKey/3HASH encoding with 25:1 super-nodes
53 * 2.2.x: with directories
54 * 3.0.x: with namespaces
55 * 3.1.x: with namespace meta-data
56 * 3.2.x: with collections
57 * 4.0.x: with expiration, variable meta-data, kblocks
58 * 4.1.x: with new error and configuration handling
59 * 5.0.x: with location URIs
60 * 6.0.0: with support for OR in KSKs
61 * 6.1.x: with simplified namespace support
62 * 9.0.0: CPS-style integrated API
63 * 9.1.1: asynchronous directory scanning
64 * 9.2.0: unified K-Block and S-block format (#2564)
65 * 9.3.0: base32crockford encoded URLs
67 #define GNUNET_FS_VERSION 0x00090300
70 /* ******************** URI API *********************** */
72 #define GNUNET_FS_URI_PREFIX "gnunet://fs/"
73 #define GNUNET_FS_URI_KSK_INFIX "ksk/"
74 #define GNUNET_FS_URI_SKS_INFIX "sks/"
75 #define GNUNET_FS_URI_CHK_INFIX "chk/"
76 #define GNUNET_FS_URI_LOC_INFIX "loc/"
80 * How often do we signal applications that a probe for a particular
81 * search result is running? (used to visualize probes).
83 #define GNUNET_FS_PROBE_UPDATE_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 250)
86 * A Universal Resource Identifier (URI), opaque.
92 * Iterator over keywords
95 * @param keyword the keyword
96 * @param is_mandatory is the keyword mandatory (in a search)
97 * @return #GNUNET_OK to continue to iterate, #GNUNET_SYSERR to abort
100 (*GNUNET_FS_KeywordIterator) (void *cls,
107 * Get a unique key from a URI. This is for putting URIs
108 * into HashMaps. The key may change between FS implementations.
110 * @param uri uri to convert to a unique key
111 * @param key wherer to store the unique key
112 * @return #GNUNET_OK on success
115 GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri,
116 struct GNUNET_HashCode *key);
120 * Convert a URI to a UTF-8 String.
122 * @param uri uri to convert to a string
123 * @return the UTF-8 string
126 GNUNET_FS_uri_to_string (const struct GNUNET_FS_Uri *uri);
130 * Convert keyword URI to a human readable format
131 * (i.e. the search query that was used in the first place)
133 * @param uri ksk uri to convert to a string
134 * @return string with the keywords
137 GNUNET_FS_uri_ksk_to_string_fancy (const struct GNUNET_FS_Uri *uri);
141 * Add the given keyword to the set of keywords represented by the URI.
142 * Does nothing if the keyword is already present.
144 * @param uri ksk uri to modify
145 * @param keyword keyword to add
146 * @param is_mandatory is this keyword mandatory?
149 GNUNET_FS_uri_ksk_add_keyword (struct GNUNET_FS_Uri *uri,
155 * Remove the given keyword from the set of keywords represented by the URI.
156 * Does nothing if the keyword is not present.
158 * @param uri ksk uri to modify
159 * @param keyword keyword to add
162 GNUNET_FS_uri_ksk_remove_keyword (struct GNUNET_FS_Uri *uri,
163 const char *keyword);
167 * Convert a UTF-8 String to a URI.
169 * @param uri string to parse
170 * @param emsg where to store the parser error message (if any)
171 * @return NULL on error
173 struct GNUNET_FS_Uri *
174 GNUNET_FS_uri_parse (const char *uri,
181 * @param uri uri to free
184 GNUNET_FS_uri_destroy (struct GNUNET_FS_Uri *uri);
188 * How many keywords are ANDed in this keyword URI?
190 * @param uri ksk uri to get the number of keywords from
191 * @return 0 if this is not a keyword URI
194 GNUNET_FS_uri_ksk_get_keyword_count (const struct GNUNET_FS_Uri *uri);
198 * Iterate over all keywords in this keyword URI.
200 * @param uri ksk uri to get the keywords from
201 * @param iterator function to call on each keyword
202 * @param iterator_cls closure for @a iterator
203 * @return -1 if this is not a keyword URI, otherwise number of
204 * keywords iterated over until iterator aborted
207 GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
208 GNUNET_FS_KeywordIterator iterator,
213 * Obtain the identity of the peer offering the data
215 * @param uri the location URI to inspect
216 * @param peer where to store the identify of the peer (presumably) offering the content
217 * @return #GNUNET_SYSERR if this is not a location URI, otherwise #GNUNET_OK
220 GNUNET_FS_uri_loc_get_peer_identity (const struct GNUNET_FS_Uri *uri,
221 struct GNUNET_PeerIdentity *peer);
225 * Obtain the URI of the content itself.
227 * @param uri location URI to get the content URI from
228 * @return NULL if argument is not a location URI
230 struct GNUNET_FS_Uri *
231 GNUNET_FS_uri_loc_get_uri (const struct GNUNET_FS_Uri *uri);
235 * Obtain the expiration of the LOC URI.
237 * @param uri location URI to get the expiration from
238 * @return expiration time of the URI
240 struct GNUNET_TIME_Absolute
241 GNUNET_FS_uri_loc_get_expiration (const struct GNUNET_FS_Uri *uri);
245 * Construct a location URI (this peer will be used for the location).
246 * This function should only be called from within gnunet-service-fs,
247 * as it requires the peer's private key which is generally unavailable
248 * to processes directly under the user's control. However, for
249 * testing and as it logically fits under URIs, it is in this API.
251 * @param base_uri content offered by the sender
252 * @param sign_key private key of the peer
253 * @param expiration_time how long will the content be offered?
254 * @return the location URI, NULL on error
256 struct GNUNET_FS_Uri *
257 GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *base_uri,
258 const struct GNUNET_CRYPTO_EddsaPrivateKey *sign_key,
259 struct GNUNET_TIME_Absolute expiration_time);
263 * Merge the sets of keywords from two KSK URIs.
265 * @param u1 first uri
266 * @param u2 second uri
267 * @return merged URI, NULL on error
269 struct GNUNET_FS_Uri *
270 GNUNET_FS_uri_ksk_merge (const struct GNUNET_FS_Uri *u1,
271 const struct GNUNET_FS_Uri *u2);
277 * @param uri the URI to duplicate
278 * @return copy of the URI
280 struct GNUNET_FS_Uri *
281 GNUNET_FS_uri_dup (const struct GNUNET_FS_Uri *uri);
285 * Create an FS URI from a single user-supplied string of keywords.
286 * The string is broken up at spaces into individual keywords.
287 * Keywords that start with "+" are mandatory. Double-quotes can
288 * be used to prevent breaking up strings at spaces (and also
289 * to specify non-mandatory keywords starting with "+").
291 * Keywords must contain a balanced number of double quotes and
292 * double quotes can not be used in the actual keywords (for
293 * example, the string '""foo bar""' will be turned into two
294 * "OR"ed keywords 'foo' and 'bar', not into '"foo bar"'.
296 * @param keywords the keyword string
297 * @param emsg where to store an error message
298 * @return an FS URI for the given keywords, NULL
299 * if keywords is not legal (i.e. empty).
301 struct GNUNET_FS_Uri *
302 GNUNET_FS_uri_ksk_create (const char *keywords,
307 * Create an FS URI from a user-supplied command line of keywords.
308 * Arguments should start with "+" to indicate mandatory
311 * @param argc number of keywords
312 * @param argv keywords (double quotes are not required for
313 * keywords containing spaces; however, double
314 * quotes are required for keywords starting with
315 * "+"); there is no mechanism for having double
316 * quotes in the actual keywords (if the user
317 * did specifically specify double quotes, the
318 * caller should convert each double quote
319 * into two single quotes).
320 * @return an FS URI for the given keywords, NULL
321 * if keywords is not legal (i.e. empty).
323 struct GNUNET_FS_Uri *
324 GNUNET_FS_uri_ksk_create_from_args (unsigned int argc,
329 * Test if two URIs are equal.
331 * @param u1 one of the URIs
332 * @param u2 the other URI
333 * @return #GNUNET_YES if the URIs are equal
336 GNUNET_FS_uri_test_equal (const struct GNUNET_FS_Uri *u1,
337 const struct GNUNET_FS_Uri *u2);
341 * Is this a namespace URI?
343 * @param uri the uri to check
344 * @return #GNUNET_YES if this is an SKS uri
347 GNUNET_FS_uri_test_sks (const struct GNUNET_FS_Uri *uri);
351 * Create an SKS URI from a namespace ID and an identifier.
353 * @param ns pseudonym to use
354 * @param id identifier
355 * @return an FS URI for the given namespace and identifier
357 struct GNUNET_FS_Uri *
358 GNUNET_FS_uri_sks_create (const struct GNUNET_CRYPTO_EcdsaPublicKey *ns,
363 * Get the public key of a namespace from the given
366 * @param uri the uri to get the namespace ID from
367 * @param pseudonym where to store the public key of the namespace
368 * @return #GNUNET_OK on success
371 GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
372 struct GNUNET_CRYPTO_EcdsaPublicKey *pseudonym);
376 * Get the content identifier of an SKS URI.
378 * @param uri the sks uri
379 * @return NULL on error (not a valid SKS URI)
382 GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri);
386 * Is this a keyword URI?
389 * @return #GNUNET_YES if this is a KSK uri
392 GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri);
396 * Is this a file (or directory) URI?
398 * @param uri the uri to check
399 * @return #GNUNET_YES if this is a CHK uri
402 GNUNET_FS_uri_test_chk (const struct GNUNET_FS_Uri *uri);
406 * What is the size of the file that this URI
409 * @param uri the CHK (or LOC) URI to inspect
410 * @return size of the file as specified in the CHK URI
413 GNUNET_FS_uri_chk_get_file_size (const struct GNUNET_FS_Uri *uri);
417 * Is this a location URI?
419 * @param uri the uri to check
420 * @return #GNUNET_YES if this is a LOC uri
423 GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri);
427 * Construct a keyword-URI from meta-data (take all entries
428 * in the meta-data and construct one large keyword URI
429 * that lists all keywords that can be found in the meta-data).
431 * @param md metadata to use
432 * @return NULL on error, otherwise a KSK URI
434 struct GNUNET_FS_Uri *
435 GNUNET_FS_uri_ksk_create_from_meta_data (const struct GNUNET_CONTAINER_MetaData
439 /* ******************** command-line option parsing API *********************** */
442 * Allow user to specify keywords.
444 * @param shortName short name of the option
445 * @param name long name of the option
446 * @param argumentHelp help text for the option argument
447 * @param description long help text for the option
448 * @param[out] topKeywords set to the desired value
450 struct GNUNET_GETOPT_CommandLineOption
451 GNUNET_FS_GETOPT_KEYWORDS (char shortName,
453 const char *argumentHelp,
454 const char *description,
455 struct GNUNET_FS_Uri **topKeywords);
458 * Allow user to specify metadata.
460 * @param shortName short name of the option
461 * @param name long name of the option
462 * @param argumentHelp help text for the option argument
463 * @param description long help text for the option
464 * @param[out] metadata set to the desired value
466 struct GNUNET_GETOPT_CommandLineOption
467 GNUNET_FS_GETOPT_METADATA (char shortName,
469 const char *argumentHelp,
470 const char *description,
471 struct GNUNET_CONTAINER_MetaData **meta);
474 * Command-line option parser function that allows the user to specify
475 * one or more '-m' options with metadata. Each specified entry of
476 * the form "type=value" will be added to the metadata. A pointer to
477 * the metadata must be passed as the "scls" argument.
479 * @param ctx command line processor context
480 * @param scls must be of type `struct GNUNET_CONTAINER_MetaData **`
481 * @param option name of the option (typically 'k')
482 * @param value command line argument given
483 * @return #GNUNET_OK on success
486 GNUNET_FS_getopt_set_metadata (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
493 /* ************************* sharing API ***************** */
497 * Possible status codes used in the callback for the
498 * various file-sharing operations. On each file (or search),
499 * the callback is guaranteed to be called once with "START"
500 * and once with STOPPED; calls with PROGRESS, ERROR or COMPLETED
501 * are optional and depend on the circumstances; parent operations
502 * will be STARTED before child-operations and STOPPED after
503 * their respective child-operations. START and STOP signals
504 * are typically generated either due to explicit client requests
505 * or because of suspend/resume operations.
507 enum GNUNET_FS_Status
510 * Notification that we have started to publish a file structure.
512 GNUNET_FS_STATUS_PUBLISH_START = 0,
515 * Notification that we have resumed sharing a file structure.
517 GNUNET_FS_STATUS_PUBLISH_RESUME = 1,
520 * Notification that we have suspended sharing a file structure.
522 GNUNET_FS_STATUS_PUBLISH_SUSPEND = 2,
525 * Notification that we are making progress sharing a file structure.
527 GNUNET_FS_STATUS_PUBLISH_PROGRESS = 3,
530 * Notification that an error was encountered sharing a file structure.
531 * The application will continue to receive resume/suspend events for
532 * this structure until "GNUNET_FS_publish_stop" is called.
534 GNUNET_FS_STATUS_PUBLISH_ERROR = 4,
537 * Notification that we completed sharing a file structure.
538 * The application will continue to receive resume/suspend events for
539 * this structure until "GNUNET_FS_publish_stop" is called.
541 GNUNET_FS_STATUS_PUBLISH_COMPLETED = 5,
544 * Notification that we have stopped
545 * the process of uploading a file structure; no
546 * futher events will be generated for this action.
548 GNUNET_FS_STATUS_PUBLISH_STOPPED = 6,
551 * Notification that we have started this download.
553 GNUNET_FS_STATUS_DOWNLOAD_START = 7,
556 * Notification that this download is being resumed.
558 GNUNET_FS_STATUS_DOWNLOAD_RESUME = 8,
561 * Notification that this download was suspended.
563 GNUNET_FS_STATUS_DOWNLOAD_SUSPEND = 9,
566 * Notification about progress with this download.
568 GNUNET_FS_STATUS_DOWNLOAD_PROGRESS = 10,
571 * Notification that this download encountered an error.
573 GNUNET_FS_STATUS_DOWNLOAD_ERROR = 11,
576 * Notification that this download completed. Note that for
577 * directories, completion does not imply completion of all files in
580 GNUNET_FS_STATUS_DOWNLOAD_COMPLETED = 12,
583 * Notification that this download was stopped
584 * (final event with respect to this action).
586 GNUNET_FS_STATUS_DOWNLOAD_STOPPED = 13,
589 * Notification that this download is now actively being
590 * pursued (as opposed to waiting in the queue).
592 GNUNET_FS_STATUS_DOWNLOAD_ACTIVE = 14,
595 * Notification that this download is no longer actively
596 * being pursued (back in the queue).
598 GNUNET_FS_STATUS_DOWNLOAD_INACTIVE = 15,
601 * Notification that this download is no longer part of a
602 * recursive download or search but now a 'stand-alone'
603 * download (and may thus need to be moved in the GUI
604 * into a different category).
606 GNUNET_FS_STATUS_DOWNLOAD_LOST_PARENT = 16,
609 * First event generated when a client requests
610 * a search to begin or when a namespace result
611 * automatically triggers the search for updates.
613 GNUNET_FS_STATUS_SEARCH_START = 17,
616 * Last event when a search is being resumed;
617 * note that "GNUNET_FS_SEARCH_START" will not
618 * be generated in this case.
620 GNUNET_FS_STATUS_SEARCH_RESUME = 18,
623 * Event generated for each search result
624 * when the respective search is resumed.
626 GNUNET_FS_STATUS_SEARCH_RESUME_RESULT = 19,
629 * Last event when a search is being suspended;
630 * note that "GNUNET_FS_SEARCH_STOPPED" will not
631 * be generated in this case.
633 GNUNET_FS_STATUS_SEARCH_SUSPEND = 20,
636 * This search has yielded a result.
638 GNUNET_FS_STATUS_SEARCH_RESULT = 21,
641 * We have discovered a new namespace.
643 GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE = 22,
646 * We have additional data about the quality
647 * or availability of a search result.
649 GNUNET_FS_STATUS_SEARCH_UPDATE = 23,
652 * Signals a problem with this search.
654 GNUNET_FS_STATUS_SEARCH_ERROR = 24,
657 * Signals that this search was paused.
659 GNUNET_FS_STATUS_SEARCH_PAUSED = 25,
662 * Signals that this search was continued (unpaused).
664 GNUNET_FS_STATUS_SEARCH_CONTINUED = 26,
667 * Event generated for each search result
668 * when the respective search is stopped.
670 GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED = 27,
673 * Event generated for each search result
674 * when the respective search is suspended.
676 GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND = 28,
679 * Last message from a search; this signals
680 * that there will be no further events associated
683 GNUNET_FS_STATUS_SEARCH_STOPPED = 29,
686 * Notification that we started to unindex a file.
688 GNUNET_FS_STATUS_UNINDEX_START = 30,
691 * Notification that we resumed unindexing of a file.
693 GNUNET_FS_STATUS_UNINDEX_RESUME = 31,
696 * Notification that we suspended unindexing a file.
698 GNUNET_FS_STATUS_UNINDEX_SUSPEND = 32,
701 * Notification that we made progress unindexing a file.
703 GNUNET_FS_STATUS_UNINDEX_PROGRESS = 33,
706 * Notification that we encountered an error unindexing
709 GNUNET_FS_STATUS_UNINDEX_ERROR = 34,
712 * Notification that the unindexing of this file
715 GNUNET_FS_STATUS_UNINDEX_COMPLETED = 35,
718 * Notification that the unindexing of this file
719 * was stopped (final event for this action).
721 GNUNET_FS_STATUS_UNINDEX_STOPPED = 36,
724 * Notification that we are making progress sharing a directory.
726 GNUNET_FS_STATUS_PUBLISH_PROGRESS_DIRECTORY = 37
732 * Handle for controlling an upload.
734 struct GNUNET_FS_PublishContext;
738 * Handle for controlling an unindexing operation.
740 struct GNUNET_FS_UnindexContext;
744 * Handle for controlling a search.
746 struct GNUNET_FS_SearchContext;
750 * Result from a search. Opaque handle to refer to the search
751 * (typically used when starting a download associated with the search
754 struct GNUNET_FS_SearchResult;
758 * Context for controlling a download.
760 struct GNUNET_FS_DownloadContext;
764 * Handle for detail information about a file that is being publishd.
765 * Specifies metadata, keywords, how to get the contents of the file
766 * (i.e. data-buffer in memory, filename on disk) and other options.
768 struct GNUNET_FS_FileInformation;
772 * Argument given to the progress callback with
773 * information about what is going on.
775 struct GNUNET_FS_ProgressInfo
779 * Values that depend on the event type.
785 * Values for all "GNUNET_FS_STATUS_PUBLISH_*" events.
791 * Context for controlling the upload.
793 struct GNUNET_FS_PublishContext *pc;
796 * Information about the file that is being publishd.
798 const struct GNUNET_FS_FileInformation *fi;
801 * Client context pointer (set the last time by the client for
802 * this operation; initially NULL on START/RESUME events).
807 * Client context pointer for the parent operation
808 * (if this is a file in a directory or a subdirectory).
813 * Name of the file being published; can be NULL.
815 const char *filename;
818 * How large is the file overall? For directories,
819 * this is only the size of the directory itself,
820 * not of the other files contained within the
826 * At what time do we expect to finish the upload?
827 * (will be a value in the past for completed
830 struct GNUNET_TIME_Relative eta;
833 * How long has this upload been actively running
834 * (excludes times where the upload was suspended).
836 struct GNUNET_TIME_Relative duration;
839 * How many bytes have we completed?
844 * What anonymity level is used for this upload?
849 * Additional values for specific events.
855 * These values are only valid for
856 * #GNUNET_FS_STATUS_PUBLISH_PROGRESS events.
862 * Data block we just published.
867 * At what offset in the file is "data"?
872 * Length of the data block.
877 * Depth of the given block in the tree;
878 * 0 would be the lowest level (DBLOCKs).
885 * These values are only valid for
886 * #GNUNET_FS_STATUS_PUBLISH_PROGRESS_DIRECTORY events.
892 * How far are we along in the overall directory?
897 * How big do we estimate the entire directory to be?
902 * At what time do we expect to finish the upload of the
903 * CONTENTS of the directory. (The direcory itself will take
904 * extra time, indicated with the "eta" member at the
905 * "publish"-level of this struct.)
907 struct GNUNET_TIME_Relative eta;
909 } progress_directory;
912 * These values are only valid for
913 * #GNUNET_FS_STATUS_PUBLISH_RESUME events.
919 * Error message, NULL if no error was encountered so far.
924 * URI of the file (if the download had been completed)
926 const struct GNUNET_FS_Uri *chk_uri;
929 * SKS URI of the file (if the download had been completed)
931 const struct GNUNET_FS_Uri *sks_uri;
936 * These values are only valid for
937 * #GNUNET_FS_STATUS_PUBLISH_COMPLETED events.
943 * CHK URI of the file.
945 const struct GNUNET_FS_Uri *chk_uri;
948 * SKS URI of the file (if the download had been completed)
950 const struct GNUNET_FS_Uri *sks_uri;
955 * These values are only valid for
956 * #GNUNET_FS_STATUS_PUBLISH_ERROR events.
962 * Error message, never NULL.
974 * Values for all "GNUNET_FS_STATUS_DOWNLOAD_*" events.
980 * Context for controlling the download.
982 struct GNUNET_FS_DownloadContext *dc;
985 * Client context pointer (set the last time
986 * by the client for this operation; initially
987 * NULL on START/RESUME events).
992 * Client context pointer for the parent operation
993 * (if this is a file in a directory or a subdirectory).
998 * Client context pointer for the associated search operation
999 * (specifically, context pointer for the specific search
1000 * result, not the overall search); only set if this
1001 * download was started from a search result.
1006 * URI used for this download.
1008 const struct GNUNET_FS_Uri *uri;
1011 * Name of the file that we are downloading.
1013 const char *filename;
1016 * How large is the download overall? This
1017 * is NOT necessarily the size from the
1018 * URI since we may be doing a partial download.
1023 * At what time do we expect to finish the download?
1024 * (will be a value in the past for completed
1027 struct GNUNET_TIME_Relative eta;
1030 * How long has this download been active?
1032 struct GNUNET_TIME_Relative duration;
1035 * How many bytes have we completed?
1040 * What anonymity level is used for this download?
1045 * Is the download currently active.
1050 * Additional values for specific events.
1056 * These values are only valid for
1057 * #GNUNET_FS_STATUS_DOWNLOAD_PROGRESS events.
1063 * Data block we just obtained, can be NULL (even if
1064 * data_len > 0) if we found the entire block 'intact' on
1065 * disk. In this case, it is also possible for 'data_len'
1066 * to be larger than an individual (32k) block.
1071 * At what offset in the file is "data"?
1076 * Length of the data block.
1081 * How much time passed between us asking for this block and
1082 * actually getting it? #GNUNET_TIME_UNIT_FOREVER_REL if unknown.
1084 struct GNUNET_TIME_Relative block_download_duration;
1087 * Depth of the given block in the tree;
1088 * 0 would be the lowest level (DBLOCKS).
1093 * How much respect did we offer for downloading this block? (estimate,
1094 * because we might have the same request pending for multiple clients,
1095 * and of course because a transmission may have failed at a lower
1098 uint32_t respect_offered;
1101 * How often did we transmit the request? (estimate,
1102 * because we might have the same request pending for multiple clients,
1103 * and of course because a transmission may have failed at a lower
1106 uint32_t num_transmissions;
1111 * These values are only valid for
1112 * #GNUNET_FS_STATUS_DOWNLOAD_START events.
1118 * Known metadata for the download.
1120 const struct GNUNET_CONTAINER_MetaData *meta;
1125 * These values are only valid for
1126 * #GNUNET_FS_STATUS_DOWNLOAD_RESUME events.
1132 * Known metadata for the download.
1134 const struct GNUNET_CONTAINER_MetaData *meta;
1137 * Error message, NULL if we have not encountered any error yet.
1139 const char *message;
1144 * These values are only valid for
1145 * #GNUNET_FS_STATUS_DOWNLOAD_ERROR events.
1153 const char *message;
1162 * Values for all "GNUNET_FS_STATUS_SEARCH_*" events.
1168 * Context for controlling the search, NULL for
1169 * searches that were not explicitly triggered
1170 * by the client (i.e., searches for updates in
1173 struct GNUNET_FS_SearchContext *sc;
1176 * Client context pointer (set the last time by the client for
1177 * this operation; initially NULL on START/RESUME events). Note
1178 * that this value can only be set on START/RESUME; returning
1179 * non-NULL on RESULT/RESUME_RESULT will actually update the
1180 * private context for "UPDATE" events.
1185 * Client parent-context pointer; NULL for top-level searches,
1186 * refers to the client context of the associated search result
1187 * for automatically triggered searches for updates in
1188 * namespaces. In this case, 'presult' refers to that search
1194 * What query is used for this search
1195 * (list of keywords or SKS identifier).
1197 const struct GNUNET_FS_Uri *query;
1200 * How long has this search been actively running
1201 * (excludes times where the search was paused or
1204 struct GNUNET_TIME_Relative duration;
1207 * What anonymity level is used for this search?
1212 * Additional values for specific events.
1218 * These values are only valid for
1219 * #GNUNET_FS_STATUS_SEARCH_RESULT events.
1225 * Metadata for the search result.
1227 const struct GNUNET_CONTAINER_MetaData *meta;
1230 * URI for the search result.
1232 const struct GNUNET_FS_Uri *uri;
1235 * Handle to the result (for starting downloads).
1237 struct GNUNET_FS_SearchResult *result;
1240 * Applicability rank (the larger, the better the result
1241 * fits the search criteria).
1243 uint32_t applicability_rank;
1248 * These values are only valid for
1249 * #GNUNET_FS_STATUS_SEARCH_RESUME_RESULT events.
1255 * Metadata for the search result.
1257 const struct GNUNET_CONTAINER_MetaData *meta;
1260 * URI for the search result.
1262 const struct GNUNET_FS_Uri *uri;
1265 * Handle to the result (for starting downloads).
1267 struct GNUNET_FS_SearchResult *result;
1270 * Current availability rank (negative:
1271 * unavailable, positive: available)
1273 int32_t availability_rank;
1276 * On how many total queries is the given
1277 * availability_rank based?
1279 uint32_t availability_certainty;
1282 * Updated applicability rank (the larger,
1283 * the better the result fits the search
1286 uint32_t applicability_rank;
1291 * These values are only valid for
1292 * #GNUNET_FS_STATUS_SEARCH_UPDATE events.
1298 * Private context set for for this result
1299 * during the "RESULT" event.
1304 * Metadata for the search result.
1306 const struct GNUNET_CONTAINER_MetaData *meta;
1309 * URI for the search result.
1311 const struct GNUNET_FS_Uri *uri;
1314 * Current availability rank (negative:
1315 * unavailable, positive: available)
1317 int32_t availability_rank;
1320 * On how many total queries is the given
1321 * availability_rank based?
1323 uint32_t availability_certainty;
1326 * Updated applicability rank (the larger,
1327 * the better the result fits the search
1330 uint32_t applicability_rank;
1333 * How long has the current probe been active?
1335 struct GNUNET_TIME_Relative current_probe_time;
1340 * These values are only valid for
1341 * #GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND events.
1342 * These events are automatically triggered for
1343 * each search result before the
1344 * #GNUNET_FS_STATUS_SEARCH_SUSPEND event. This
1345 * happens primarily to give the client a chance
1346 * to clean up the "cctx" (if needed).
1352 * Private context set for for this result
1353 * during the "RESULT" event.
1358 * Metadata for the search result.
1360 const struct GNUNET_CONTAINER_MetaData *meta;
1363 * URI for the search result.
1365 const struct GNUNET_FS_Uri *uri;
1370 * These values are only valid for
1371 * #GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED events.
1372 * These events are automatically triggered for
1373 * each search result before the
1374 * #GNUNET_FS_STATUS_SEARCH_STOPPED event. This
1375 * happens primarily to give the client a chance
1376 * to clean up the "cctx" (if needed).
1382 * Private context set for for this result
1383 * during the "RESULT" event.
1388 * Metadata for the search result.
1390 const struct GNUNET_CONTAINER_MetaData *meta;
1393 * URI for the search result.
1395 const struct GNUNET_FS_Uri *uri;
1400 * These values are only valid for
1401 * #GNUNET_FS_STATUS_SEARCH_RESUME events.
1407 * Error message, NULL if we have not encountered any error yet.
1409 const char *message;
1412 * Is this search currently paused?
1419 * These values are only valid for
1420 * #GNUNET_FS_STATUS_SEARCH_ERROR events.
1428 const char *message;
1433 * Values for #GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE events.
1439 * Short, human-readable name of the namespace.
1444 * Root identifier for the namespace, can be NULL.
1449 * Metadata for the namespace.
1451 const struct GNUNET_CONTAINER_MetaData *meta;
1454 * Public key of the namespace.
1456 struct GNUNET_CRYPTO_EcdsaPublicKey pseudonym;
1465 * Values for all "GNUNET_FS_STATUS_UNINDEX_*" events.
1471 * Context for controlling the unindexing.
1473 struct GNUNET_FS_UnindexContext *uc;
1476 * Client context pointer (set the last time
1477 * by the client for this operation; initially
1478 * NULL on START/RESUME events).
1483 * Name of the file that is being unindexed.
1485 const char *filename;
1488 * How large is the file overall?
1493 * At what time do we expect to finish unindexing?
1494 * (will be a value in the past for completed
1495 * unindexing opeations).
1497 struct GNUNET_TIME_Relative eta;
1500 * How long has this upload been actively running
1501 * (excludes times where the upload was suspended).
1503 struct GNUNET_TIME_Relative duration;
1506 * How many bytes have we completed?
1511 * Additional values for specific events.
1517 * These values are only valid for
1518 * #GNUNET_FS_STATUS_UNINDEX_PROGRESS events.
1524 * Data block we just unindexed.
1529 * At what offset in the file is "data"?
1534 * Length of the data block.
1539 * Depth of the given block in the tree;
1540 * 0 would be the lowest level (DBLOCKS).
1547 * These values are only valid for
1548 * #GNUNET_FS_STATUS_UNINDEX_RESUME events.
1554 * Error message, NULL if we have not encountered any error yet.
1556 const char *message;
1561 * These values are only valid for
1562 * #GNUNET_FS_STATUS_UNINDEX_ERROR events.
1570 const char *message;
1581 * Specific status code (determines the event type).
1583 enum GNUNET_FS_Status status;
1586 * File-sharing handle that generated the event.
1588 struct GNUNET_FS_Handle *fsh;
1593 * Notification of FS to a client about the progress of an
1594 * operation. Callbacks of this type will be used for uploads,
1595 * downloads and searches. Some of the arguments depend a bit
1596 * in their meaning on the context in which the callback is used.
1598 * @param cls closure
1599 * @param info details about the event, specifying the event type
1600 * and various bits about the event
1601 * @return client-context (for the next progress call
1602 * for this operation; should be set to NULL for
1603 * SUSPEND and STOPPED events). The value returned
1604 * will be passed to future callbacks in the respective
1605 * field in the `struct GNUNET_FS_ProgressInfo`.
1608 (*GNUNET_FS_ProgressCallback) (void *cls,
1609 const struct GNUNET_FS_ProgressInfo *info);
1613 * General (global) option flags for file-sharing.
1615 enum GNUNET_FS_Flags
1618 * No special flags set.
1620 GNUNET_FS_FLAGS_NONE = 0,
1623 * Is persistence of operations desired?
1624 * (will create SUSPEND/RESUME events).
1626 GNUNET_FS_FLAGS_PERSISTENCE = 1,
1629 * Should we automatically trigger probes for search results
1630 * to determine availability?
1631 * (will create #GNUNET_FS_STATUS_SEARCH_UPDATE events).
1633 GNUNET_FS_FLAGS_DO_PROBES = 2
1638 * Options specified in the VARARGs portion of GNUNET_FS_start.
1640 enum GNUNET_FS_OPTIONS
1644 * Last option in the VARARG list.
1646 GNUNET_FS_OPTIONS_END = 0,
1649 * Select the desired amount of parallelism (this option should be
1650 * followed by an "unsigned int" giving the desired maximum number
1651 * of parallel downloads).
1653 GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM = 1,
1656 * Maximum number of requests that should be pending at a given
1657 * point in time (invidivual downloads may go above this, but
1658 * if we are above this threshold, we should not activate any
1659 * additional downloads.
1661 GNUNET_FS_OPTIONS_REQUEST_PARALLELISM = 2
1666 * Settings for publishing a block (which may of course also
1667 * apply to an entire directory or file).
1669 struct GNUNET_FS_BlockOptions
1673 * At what time should the block expire? Data blocks (DBLOCKS and
1674 * IBLOCKS) may still be used even if they are expired (however,
1675 * they'd be removed quickly from the datastore if we are short on
1676 * space), all other types of blocks will no longer be returned
1677 * after they expire.
1679 struct GNUNET_TIME_Absolute expiration_time;
1682 * At which anonymity level should the block be shared?
1683 * (0: no anonymity, 1: normal GAP, >1: with cover traffic).
1685 uint32_t anonymity_level;
1688 * How important is it for us to store the block? If we run
1689 * out of space, the highest-priority, non-expired blocks will
1692 uint32_t content_priority;
1695 * How often should we try to migrate the block to other peers?
1696 * Only used if "CONTENT_PUSHING" is set to YES, in which case we
1697 * first push each block to other peers according to their
1698 * replication levels. Once each block has been pushed that many
1699 * times to other peers, blocks are chosen for migration at random.
1700 * Naturally, there is no guarantee that the other peers will keep
1701 * these blocks for any period of time (since they won't have any
1702 * priority or might be too busy to even store the block in the
1705 uint32_t replication_level;
1711 * Handle to the file-sharing service.
1713 struct GNUNET_FS_Handle;
1717 * Setup a connection to the file-sharing service.
1719 * @param cfg configuration to use
1720 * @param client_name unique identifier for this client
1721 * @param upcb function to call to notify about FS actions
1722 * @param upcb_cls closure for @a upcb
1723 * @param flags specific attributes for fs-operations
1724 * @param ... list of optional options, terminated with #GNUNET_FS_OPTIONS_END
1725 * @return NULL on error
1727 struct GNUNET_FS_Handle *
1728 GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
1729 const char *client_name,
1730 GNUNET_FS_ProgressCallback upcb,
1732 enum GNUNET_FS_Flags flags,
1737 * Close our connection with the file-sharing service.
1738 * The callback given to #GNUNET_FS_start() will no longer be
1739 * called after this function returns.
1740 * This function MUST NOT be called from within the
1743 * @param h handle that was returned from #GNUNET_FS_start()
1746 GNUNET_FS_stop (struct GNUNET_FS_Handle *h);
1750 * Function called on entries in a `struct GNUNET_FS_FileInformation` iteration.
1752 * @param cls closure
1753 * @param fi the entry in the publish-structure
1754 * @param length length of the file or directory
1755 * @param meta metadata for the file or directory (can be modified)
1756 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1757 * @param bo block options (can be modified)
1758 * @param do_index should we index (can be modified)
1759 * @param client_info pointer to client context set upon creation (can be modified)
1760 * @return #GNUNET_OK to continue, #GNUNET_NO to remove
1761 * this entry from the directory, #GNUNET_SYSERR
1762 * to abort the iteration
1765 (*GNUNET_FS_FileInformationProcessor) (void *cls,
1766 struct GNUNET_FS_FileInformation *fi,
1768 struct GNUNET_CONTAINER_MetaData *meta,
1769 struct GNUNET_FS_Uri ** uri,
1770 struct GNUNET_FS_BlockOptions *bo,
1772 void **client_info);
1776 * Obtain the name under which this file information
1777 * structure is stored on disk. Only works for top-level
1778 * file information structures.
1780 * @param s structure to get the filename for
1781 * @return NULL on error, otherwise filename that can be used
1782 * to read this fi-struct from disk.
1785 GNUNET_FS_file_information_get_id (struct GNUNET_FS_FileInformation *s);
1789 * Obtain the filename from the file information structure.
1791 * @param s structure to get the filename for
1792 * @return "filename" field of the structure (can be NULL)
1795 GNUNET_FS_file_information_get_filename (struct GNUNET_FS_FileInformation *s);
1799 * Set the filename in the file information structure.
1800 * If filename was already set, frees it before setting the new one.
1801 * Makes a copy of the argument.
1803 * @param s structure to get the filename for
1804 * @param filename filename to set
1807 GNUNET_FS_file_information_set_filename (struct GNUNET_FS_FileInformation *s,
1808 const char *filename);
1812 * Create an entry for a file in a publish-structure.
1814 * @param h handle to the file sharing subsystem
1815 * @param client_info initial client-info value for this entry
1816 * @param filename name of the file or directory to publish
1817 * @param keywords under which keywords should this file be available
1818 * directly; can be NULL
1819 * @param meta metadata for the file
1820 * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
1821 * #GNUNET_SYSERR for simulation
1822 * @param bo block options
1823 * @return publish structure entry for the file
1825 struct GNUNET_FS_FileInformation *
1826 GNUNET_FS_file_information_create_from_file (struct GNUNET_FS_Handle *h,
1828 const char *filename,
1829 const struct GNUNET_FS_Uri *keywords,
1830 const struct GNUNET_CONTAINER_MetaData *meta,
1832 const struct GNUNET_FS_BlockOptions *bo);
1836 * Create an entry for a file in a publish-structure.
1838 * @param h handle to the file sharing subsystem
1839 * @param client_info initial client-info value for this entry
1840 * @param length length of the file
1841 * @param data data for the file (should not be used afterwards by
1842 * the caller; callee will "free")
1843 * @param keywords under which keywords should this file be available
1844 * directly; can be NULL
1845 * @param meta metadata for the file
1846 * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
1847 * #GNUNET_SYSERR for simulation
1848 * @param bo block options
1849 * @return publish structure entry for the file
1851 struct GNUNET_FS_FileInformation *
1852 GNUNET_FS_file_information_create_from_data (struct GNUNET_FS_Handle *h,
1856 const struct GNUNET_FS_Uri *keywords,
1857 const struct GNUNET_CONTAINER_MetaData *meta,
1859 const struct GNUNET_FS_BlockOptions *bo);
1863 * Function that provides data.
1865 * @param cls closure
1866 * @param offset offset to read from; it is possible
1867 * that the caller might need to go backwards
1868 * a bit at times; set to UINT64_MAX to tell
1869 * the reader that we won't be reading for a while
1870 * (used to close the file descriptor but NOT fully
1871 * clean up the reader's state); in this case,
1872 * a value of '0' for max should be ignored
1873 * @param max maximum number of bytes that should be
1874 * copied to buf; readers are not allowed
1875 * to provide less data unless there is an error;
1876 * a value of "0" will be used at the end to allow
1877 * the reader to clean up its internal state
1878 * @param buf where the reader should write the data
1879 * @param emsg location for the reader to store an error message
1880 * @return number of bytes written, usually @a max, 0 on error
1883 (*GNUNET_FS_DataReader) (void *cls,
1891 * Create an entry for a file in a publish-structure.
1893 * @param h handle to the file sharing subsystem
1894 * @param client_info initial client-info value for this entry
1895 * @param length length of the file
1896 * @param reader function that can be used to obtain the data for the file
1897 * @param reader_cls closure for @a reader
1898 * @param keywords under which keywords should this file be available
1899 * directly; can be NULL
1900 * @param meta metadata for the file
1901 * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
1902 * #GNUNET_SYSERR for simulation
1903 * @param bo block options
1904 * @return publish structure entry for the file
1906 struct GNUNET_FS_FileInformation *
1907 GNUNET_FS_file_information_create_from_reader (struct GNUNET_FS_Handle *h,
1910 GNUNET_FS_DataReader reader,
1912 const struct GNUNET_FS_Uri
1915 GNUNET_CONTAINER_MetaData *meta,
1918 GNUNET_FS_BlockOptions *bo);
1922 * Create an entry for an empty directory in a publish-structure.
1924 * @param h handle to the file sharing subsystem
1925 * @param client_info initial client-info value for this entry
1926 * @param keywords under which keywords should this directory be available
1927 * directly; can be NULL
1928 * @param meta metadata for the directory
1929 * @param bo block options
1930 * @param filename name of the directory; can be NULL
1931 * @return publish structure entry for the directory , NULL on error
1933 struct GNUNET_FS_FileInformation *
1934 GNUNET_FS_file_information_create_empty_directory (struct GNUNET_FS_Handle *h,
1936 const struct GNUNET_FS_Uri
1939 GNUNET_CONTAINER_MetaData
1942 GNUNET_FS_BlockOptions *bo,
1943 const char *filename);
1947 * Test if a given entry represents a directory.
1949 * @param ent check if this FI represents a directory
1950 * @return #GNUNET_YES if so, #GNUNET_NO if not
1953 GNUNET_FS_file_information_is_directory (const struct GNUNET_FS_FileInformation
1958 * Add an entry to a directory in a publish-structure. Clients
1959 * should never modify publish structures that were passed to
1960 * #GNUNET_FS_publish_start() already.
1962 * @param dir the directory
1963 * @param ent the entry to add; the entry must not have been
1964 * added to any other directory at this point and
1965 * must not include @a dir in its structure
1966 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1969 GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
1970 struct GNUNET_FS_FileInformation *ent);
1974 * Inspect a file or directory in a publish-structure. Clients
1975 * should never modify publish structures that were passed to
1976 * #GNUNET_FS_publish_start already. When called on a directory,
1977 * this function will FIRST call @a proc with information about
1978 * the directory itself and then for each of the files in the
1979 * directory (but not for files in subdirectories). When called
1980 * on a file, @a proc will be called exactly once (with information
1981 * about the specific file).
1983 * @param dir the directory
1984 * @param proc function to call on each entry
1985 * @param proc_cls closure for @a proc
1988 GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir,
1989 GNUNET_FS_FileInformationProcessor proc,
1994 * Destroy publish-structure. Clients should never destroy publish
1995 * structures that were passed to #GNUNET_FS_publish_start already.
1997 * @param fi structure to destroy
1998 * @param cleaner function to call on each entry in the structure
1999 * (useful to clean up client_info); can be NULL; return
2000 * values are ignored
2001 * @param cleaner_cls closure for @a cleaner
2004 GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi,
2005 GNUNET_FS_FileInformationProcessor cleaner,
2010 * Options for publishing. Compatible options
2011 * can be OR'ed together.
2013 enum GNUNET_FS_PublishOptions
2016 * No options (use defaults for everything).
2018 GNUNET_FS_PUBLISH_OPTION_NONE = 0,
2021 * Simulate publishing. With this option, no data will be stored
2022 * in the datastore. Useful for computing URIs from files.
2024 GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY = 1
2029 * Publish a file or directory.
2031 * @param h handle to the file sharing subsystem
2032 * @param fi information about the file or directory structure to publish
2033 * @param ns namespace to publish the file in, NULL for no namespace
2034 * @param nid identifier to use for the publishd content in the namespace
2035 * (can be NULL, must be NULL if namespace is NULL)
2036 * @param nuid update-identifier that will be used for future updates
2037 * (can be NULL, must be NULL if namespace or nid is NULL)
2038 * @param options options for the publication
2039 * @return context that can be used to control the publish operation
2041 struct GNUNET_FS_PublishContext *
2042 GNUNET_FS_publish_start (struct GNUNET_FS_Handle *h,
2043 struct GNUNET_FS_FileInformation *fi,
2044 const struct GNUNET_CRYPTO_EcdsaPrivateKey *ns,
2047 enum GNUNET_FS_PublishOptions options);
2051 * Stop a publication. Will abort incomplete publications (but
2052 * not remove blocks that have already been published) or
2053 * simply clean up the state for completed publications.
2054 * Must NOT be called from within the event callback!
2056 * @param pc context for the publication to stop
2059 GNUNET_FS_publish_stop (struct GNUNET_FS_PublishContext *pc);
2063 * Signature of a function called as the continuation of a KBlock or
2064 * SBlock publication.
2066 * @param cls closure
2067 * @param uri URI under which the block is now available, NULL on error
2068 * @param emsg error message, NULL on success
2071 (*GNUNET_FS_PublishContinuation) (void *cls,
2072 const struct GNUNET_FS_Uri *uri,
2077 * Handle to cancel publish KSK operation.
2079 struct GNUNET_FS_PublishKskContext;
2083 * Publish a KBlock on GNUnet.
2085 * @param h handle to the file sharing subsystem
2086 * @param ksk_uri keywords to use
2087 * @param meta metadata to use
2088 * @param uri URI to refer to in the KBlock
2089 * @param bo block options
2090 * @param options publication options
2091 * @param cont continuation
2092 * @param cont_cls closure for @a cont
2093 * @return NULL on error (@a cont will still be called)
2095 struct GNUNET_FS_PublishKskContext *
2096 GNUNET_FS_publish_ksk (struct GNUNET_FS_Handle *h,
2097 const struct GNUNET_FS_Uri *ksk_uri,
2098 const struct GNUNET_CONTAINER_MetaData *meta,
2099 const struct GNUNET_FS_Uri *uri,
2100 const struct GNUNET_FS_BlockOptions *bo,
2101 enum GNUNET_FS_PublishOptions options,
2102 GNUNET_FS_PublishContinuation cont, void *cont_cls);
2106 * Abort the KSK publishing operation.
2108 * @param pkc context of the operation to abort.
2111 GNUNET_FS_publish_ksk_cancel (struct GNUNET_FS_PublishKskContext *pkc);
2115 * Handle to cancel publish SKS operation.
2117 struct GNUNET_FS_PublishSksContext;
2121 * Publish an SBlock on GNUnet.
2123 * @param h handle to the file sharing subsystem
2124 * @param ns namespace to publish in
2125 * @param identifier identifier to use
2126 * @param update update identifier to use
2127 * @param meta metadata to use
2128 * @param uri URI to refer to in the SBlock
2129 * @param bo block options
2130 * @param options publication options
2131 * @param cont continuation
2132 * @param cont_cls closure for @a cont
2133 * @return NULL on error (@a cont will still be called)
2135 struct GNUNET_FS_PublishSksContext *
2136 GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
2137 const struct GNUNET_CRYPTO_EcdsaPrivateKey *ns,
2138 const char *identifier,
2140 const struct GNUNET_CONTAINER_MetaData *meta,
2141 const struct GNUNET_FS_Uri *uri,
2142 const struct GNUNET_FS_BlockOptions *bo,
2143 enum GNUNET_FS_PublishOptions options,
2144 GNUNET_FS_PublishContinuation cont, void *cont_cls);
2148 * Abort the SKS publishing operation.
2150 * @param psc context of the operation to abort.
2153 GNUNET_FS_publish_sks_cancel (struct GNUNET_FS_PublishSksContext *psc);
2157 * Type of a function called by #GNUNET_FS_get_indexed_files.
2159 * @param cls closure
2160 * @param filename the name of the file, NULL for end of list
2161 * @param file_id hash of the contents of the indexed file
2162 * @return #GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort
2165 (*GNUNET_FS_IndexedFileProcessor) (void *cls,
2166 const char *filename,
2167 const struct GNUNET_HashCode *file_id);
2171 * Handle to cancel 'GNUNET_FS_get_indexed_files'.
2173 struct GNUNET_FS_GetIndexedContext;
2177 * Iterate over all indexed files.
2179 * @param h handle to the file sharing subsystem
2180 * @param iterator function to call on each indexed file
2181 * @param iterator_cls closure for @a iterator
2182 * @return NULL on error (@a iterator is not called)
2184 struct GNUNET_FS_GetIndexedContext *
2185 GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
2186 GNUNET_FS_IndexedFileProcessor iterator,
2187 void *iterator_cls);
2191 * Cancel iteration over all indexed files.
2193 * @param gic operation to cancel
2196 GNUNET_FS_get_indexed_files_cancel (struct GNUNET_FS_GetIndexedContext *gic);
2202 * @param h handle to the file sharing subsystem
2203 * @param filename file to unindex
2204 * @param cctx initial value for the client context
2205 * @return NULL on error, otherwise handle
2207 struct GNUNET_FS_UnindexContext *
2208 GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h,
2209 const char *filename,
2214 * Clean up after completion of an unindex operation.
2219 GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc);
2223 * Function called on updateable identifiers.
2225 * @param cls closure
2226 * @param last_id last identifier
2227 * @param last_uri uri used for the content published under the @a last_id
2228 * @param last_meta metadata associated with @a last_uri
2229 * @param next_id identifier that should be used for updates
2231 typedef void (*GNUNET_FS_IdentifierProcessor) (void *cls,
2232 const char *last_id,
2233 const struct GNUNET_FS_Uri *last_uri,
2234 const struct GNUNET_CONTAINER_MetaData *last_meta,
2235 const char *next_id);
2239 * List all of the identifiers in the namespace for which we could
2240 * produce an update. Namespace updates form a graph where each node
2241 * has a name. Each node can have any number of URI/meta-data entries
2242 * which can each be linked to other nodes. Cycles are possible.
2244 * Calling this function with @a next_id NULL will cause the library to
2245 * call @a ip with a root for each strongly connected component of the
2246 * graph (a root being a node from which all other nodes in the Scc
2249 * Calling this function with @a next_id being the name of a node will
2250 * cause the library to call @a ip with all children of the node. Note
2251 * that cycles within an SCC are possible (including self-loops).
2253 * @param h fs handle to use
2254 * @param ns namespace to inspect for updateable content
2255 * @param next_id ID to look for; use NULL to look for SCC roots
2256 * @param ip function to call on each updateable identifier
2257 * @param ip_cls closure for @a ip
2260 GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Handle *h,
2261 const struct GNUNET_CRYPTO_EcdsaPrivateKey *ns,
2262 const char *next_id,
2263 GNUNET_FS_IdentifierProcessor ip,
2268 * Options for searching. Compatible options
2269 * can be OR'ed together.
2271 enum GNUNET_FS_SearchOptions
2274 * No options (use defaults for everything).
2276 GNUNET_FS_SEARCH_OPTION_NONE = 0,
2279 * Only search the local host, do not search remote systems (no P2P)
2281 GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY = 1
2286 * Start search for content.
2288 * @param h handle to the file sharing subsystem
2289 * @param uri specifies the search parameters; can be
2290 * a KSK URI or an SKS URI.
2291 * @param anonymity desired level of anonymity
2292 * @param options options for the search
2293 * @param cctx initial value for the client context
2294 * @return context that can be used to control the search
2296 struct GNUNET_FS_SearchContext *
2297 GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
2298 const struct GNUNET_FS_Uri *uri, uint32_t anonymity,
2299 enum GNUNET_FS_SearchOptions options, void *cctx);
2305 * @param sc context for the search that should be paused
2308 GNUNET_FS_search_pause (struct GNUNET_FS_SearchContext *sc);
2312 * Continue paused search.
2314 * @param sc context for the search that should be resumed
2317 GNUNET_FS_search_continue (struct GNUNET_FS_SearchContext *sc);
2321 * Stop search for content.
2323 * @param sc context for the search that should be stopped
2326 GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc);
2330 * Start download probes for the given search result.
2332 * @param h file-sharing handle to use for the operation
2333 * @param uri URI to probe
2334 * @param meta meta data associated with the URI
2335 * @param client_info client info pointer to use for associated events
2336 * @param anonymity anonymity level to use for the probes
2337 * @return the search result handle to access the probe activity
2339 struct GNUNET_FS_SearchResult *
2340 GNUNET_FS_probe (struct GNUNET_FS_Handle *h,
2341 const struct GNUNET_FS_Uri *uri,
2342 const struct GNUNET_CONTAINER_MetaData *meta,
2344 uint32_t anonymity);
2348 * Stop probe activity. Must ONLY be used on values
2349 * returned from #GNUNET_FS_probe.
2351 * @param sr search result to stop probing for (freed)
2352 * @return the value of the 'client_info' pointer
2355 GNUNET_FS_probe_stop (struct GNUNET_FS_SearchResult *sr);
2359 * Options for downloading. Compatible options
2360 * can be OR'ed together.
2362 enum GNUNET_FS_DownloadOptions
2365 * No options (use defaults for everything).
2367 GNUNET_FS_DOWNLOAD_OPTION_NONE = 0,
2370 * Only download from the local host, do not access remote systems (no P2P)
2372 GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY = 1,
2375 * Do a recursive download (that is, automatically trigger the
2376 * download of files in directories).
2378 GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE = 2,
2381 * Do not append temporary data to
2382 * the target file (for the IBlocks).
2384 GNUNET_FS_DOWNLOAD_NO_TEMPORARIES = 4,
2387 * Internal option used to flag this download as a 'probe' for a
2388 * search result. Impacts the priority with which the download is
2389 * run and causes signalling callbacks to be done differently.
2390 * Also, probe downloads are not serialized on suspension. Normal
2391 * clients should not use this!
2393 GNUNET_FS_DOWNLOAD_IS_PROBE = (1 << 31)
2399 * Download parts of a file. Note that this will store
2400 * the blocks at the respective offset in the given file. Also, the
2401 * download is still using the blocking of the underlying FS
2402 * encoding. As a result, the download may *write* outside of the
2403 * given boundaries (if offset and length do not match the 32k FS
2404 * block boundaries).
2406 * The given range can be used to focus a download towards a
2407 * particular portion of the file (optimization), not to strictly
2408 * limit the download to exactly those bytes.
2410 * @param h handle to the file sharing subsystem
2411 * @param uri the URI of the file (determines what to download); CHK or LOC URI
2412 * @param meta known metadata for the file (can be NULL)
2413 * @param filename where to store the file, maybe NULL (then no file is
2414 * created on disk and data must be grabbed from the callbacks)
2415 * @param tempname where to store temporary file data, not used if filename is non-NULL;
2416 * can be NULL (in which case we will pick a name if needed); the temporary file
2417 * may already exist, in which case we will try to use the data that is there and
2418 * if it is not what is desired, will overwrite it
2419 * @param offset at what offset should we start the download (typically 0)
2420 * @param length how many bytes should be downloaded starting at offset
2421 * @param anonymity anonymity level to use for the download
2422 * @param options various download options
2423 * @param cctx initial value for the client context for this download
2424 * @param parent parent download to associate this download with (use NULL
2425 * for top-level downloads; useful for manually-triggered recursive downloads)
2426 * @return context that can be used to control this download
2428 struct GNUNET_FS_DownloadContext *
2429 GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
2430 const struct GNUNET_FS_Uri *uri,
2431 const struct GNUNET_CONTAINER_MetaData *meta,
2432 const char *filename, const char *tempname,
2433 uint64_t offset, uint64_t length, uint32_t anonymity,
2434 enum GNUNET_FS_DownloadOptions options, void *cctx,
2435 struct GNUNET_FS_DownloadContext *parent);
2439 * Download parts of a file based on a search result. The download
2440 * will be associated with the search result (and the association
2441 * will be preserved when serializing/deserializing the state).
2442 * If the search is stopped, the download will not be aborted but
2443 * be 'promoted' to a stand-alone download.
2445 * As with the other download function, this will store
2446 * the blocks at the respective offset in the given file. Also, the
2447 * download is still using the blocking of the underlying FS
2448 * encoding. As a result, the download may *write* outside of the
2449 * given boundaries (if offset and length do not match the 32k FS
2450 * block boundaries).
2452 * The given range can be used to focus a download towards a
2453 * particular portion of the file (optimization), not to strictly
2454 * limit the download to exactly those bytes.
2456 * @param h handle to the file sharing subsystem
2457 * @param sr the search result to use for the download (determines uri and
2458 * meta data and associations)
2459 * @param filename where to store the file, maybe NULL (then no file is
2460 * created on disk and data must be grabbed from the callbacks)
2461 * @param tempname where to store temporary file data, not used if filename is non-NULL;
2462 * can be NULL (in which case we will pick a name if needed); the temporary file
2463 * may already exist, in which case we will try to use the data that is there and
2464 * if it is not what is desired, will overwrite it
2465 * @param offset at what offset should we start the download (typically 0)
2466 * @param length how many bytes should be downloaded starting at offset
2467 * @param anonymity anonymity level to use for the download
2468 * @param options various download options
2469 * @param cctx initial value for the client context for this download
2470 * @return context that can be used to control this download
2472 struct GNUNET_FS_DownloadContext *
2473 GNUNET_FS_download_start_from_search (struct GNUNET_FS_Handle *h,
2474 struct GNUNET_FS_SearchResult *sr,
2475 const char *filename,
2476 const char *tempname, uint64_t offset,
2477 uint64_t length, uint32_t anonymity,
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, int do_delete);
2493 * Suspend a download.
2495 * @param dc handle for the download
2498 GNUNET_FS_download_suspend (struct GNUNET_FS_DownloadContext *dc);
2502 * Resume a suspended download.
2504 * @param dc handle for the download
2507 GNUNET_FS_download_resume (struct GNUNET_FS_DownloadContext *dc);
2511 /* ******************** Directory API *********************** */
2514 #define GNUNET_FS_DIRECTORY_MIME "application/gnunet-directory"
2515 #define GNUNET_FS_DIRECTORY_MAGIC "\211GND\r\n\032\n"
2516 #define GNUNET_FS_DIRECTORY_EXT ".gnd"
2519 * Does the meta-data claim that this is a directory?
2520 * Checks if the mime-type is that of a GNUnet directory.
2522 * @return #GNUNET_YES if it is, #GNUNET_NO if it is not, #GNUNET_SYSERR if
2523 * we have no mime-type information (treat as #GNUNET_NO)
2526 GNUNET_FS_meta_data_test_for_directory (const struct GNUNET_CONTAINER_MetaData
2531 * Set the MIMETYPE information for the given
2532 * metadata to "application/gnunet-directory".
2534 * @param md metadata to add mimetype to
2537 GNUNET_FS_meta_data_make_directory (struct GNUNET_CONTAINER_MetaData *md);
2541 * Suggest a filename based on given metadata.
2543 * @param md given meta data
2544 * @return NULL if meta data is useless for suggesting a filename
2547 GNUNET_FS_meta_data_suggest_filename (const struct GNUNET_CONTAINER_MetaData *md);
2551 * Function used to process entries in a directory.
2553 * @param cls closure
2554 * @param filename name of the file in the directory
2555 * @param uri URI of the file
2556 * @param metadata metadata for the file; metadata for
2557 * the directory if everything else is NULL/zero
2558 * @param length length of the available data for the file
2559 * (of type size_t since data must certainly fit
2560 * into memory; if files are larger than size_t
2561 * permits, then they will certainly not be
2562 * embedded with the directory itself).
2563 * @param data data available for the file (length bytes)
2565 typedef void (*GNUNET_FS_DirectoryEntryProcessor) (void *cls,
2566 const char *filename,
2567 const struct GNUNET_FS_Uri *
2570 GNUNET_CONTAINER_MetaData *
2571 meta, size_t length,
2576 * Iterate over all entries in a directory. Note that directories
2577 * are structured such that it is possible to iterate over the
2578 * individual blocks as well as over the entire directory. Thus
2579 * a client can call this function on the buffer in the
2580 * GNUNET_FS_ProgressCallback. Also, directories can optionally
2581 * include the contents of (small) files embedded in the directory
2582 * itself; for those files, the processor may be given the
2583 * contents of the file directly by this function.
2585 * @param size number of bytes in data
2586 * @param data pointer to the beginning of the directory
2587 * @param offset offset of data in the directory
2588 * @param dep function to call on each entry
2589 * @param dep_cls closure for @a dep
2590 * @return #GNUNET_OK if this could be a block in a directory,
2591 * #GNUNET_NO if this could be part of a directory (but not 100% OK)
2592 * #GNUNET_SYSERR if 'data' does not represent a directory
2595 GNUNET_FS_directory_list_contents (size_t size, const void *data,
2597 GNUNET_FS_DirectoryEntryProcessor dep,
2602 * Opaque handle to a directory builder.
2604 struct GNUNET_FS_DirectoryBuilder;
2608 * Create a directory builder.
2610 * @param mdir metadata for the directory
2612 struct GNUNET_FS_DirectoryBuilder *
2613 GNUNET_FS_directory_builder_create (const struct GNUNET_CONTAINER_MetaData
2618 * Add an entry to a directory.
2620 * @param bld directory to extend
2621 * @param uri uri of the entry (must not be a KSK)
2622 * @param md metadata of the entry
2623 * @param data raw data of the entry, can be NULL, otherwise
2624 * data must point to exactly the number of bytes specified
2628 GNUNET_FS_directory_builder_add (struct GNUNET_FS_DirectoryBuilder *bld,
2629 const struct GNUNET_FS_Uri *uri,
2630 const struct GNUNET_CONTAINER_MetaData *md,
2635 * Finish building the directory. Frees the
2636 * builder context and returns the directory
2639 * @param bld directory to finish
2640 * @param rsize set to the number of bytes needed
2641 * @param rdata set to the encoded directory
2642 * @return #GNUNET_OK on success
2645 GNUNET_FS_directory_builder_finish (struct GNUNET_FS_DirectoryBuilder *bld,
2646 size_t * rsize, void **rdata);
2649 /* ******************** DirScanner API *********************** */
2652 * Progress reasons of the directory scanner.
2654 enum GNUNET_FS_DirScannerProgressUpdateReason
2658 * We've started processing a file or directory.
2660 GNUNET_FS_DIRSCANNER_FILE_START = 0,
2663 * We're having trouble accessing a file (soft-error); it will
2666 GNUNET_FS_DIRSCANNER_FILE_IGNORED,
2669 * We've found all files (in the pre-pass).
2671 GNUNET_FS_DIRSCANNER_ALL_COUNTED,
2674 * We've finished extracting meta data from a file.
2676 GNUNET_FS_DIRSCANNER_EXTRACT_FINISHED,
2679 * Last call to the progress function: we have finished scanning
2682 GNUNET_FS_DIRSCANNER_FINISHED,
2685 * There was an internal error. Application should abort the scan.
2687 GNUNET_FS_DIRSCANNER_INTERNAL_ERROR
2693 * Function called over time as the directory scanner makes
2694 * progress on the job at hand.
2696 * @param cls closure
2697 * @param filename which file we are making progress on
2698 * @param is_directory #GNUNET_YES if this is a directory,
2699 * #GNUNET_NO if this is a file
2700 * #GNUNET_SYSERR if it is neither (or unknown)
2701 * @param reason kind of progress we are making
2703 typedef void (*GNUNET_FS_DirScannerProgressCallback) (void *cls,
2704 const char *filename,
2706 enum GNUNET_FS_DirScannerProgressUpdateReason reason);
2710 * A node of a directory tree (produced by dirscanner)
2712 struct GNUNET_FS_ShareTreeItem
2715 * This is a doubly-linked list
2717 struct GNUNET_FS_ShareTreeItem *prev;
2720 * This is a doubly-linked list
2722 struct GNUNET_FS_ShareTreeItem *next;
2725 * This is a doubly-linked tree
2726 * NULL for top-level entries.
2728 struct GNUNET_FS_ShareTreeItem *parent;
2731 * This is a doubly-linked tree
2732 * NULL for files and empty directories
2734 struct GNUNET_FS_ShareTreeItem *children_head;
2737 * This is a doubly-linked tree
2738 * NULL for files and empty directories
2740 struct GNUNET_FS_ShareTreeItem *children_tail;
2743 * Metadata for this file or directory
2745 struct GNUNET_CONTAINER_MetaData *meta;
2748 * Keywords for this file or directory (derived from metadata).
2750 struct GNUNET_FS_Uri *ksk_uri;
2753 * Name of the file/directory
2758 * Base name of the file/directory.
2760 char *short_filename;
2763 * #GNUNET_YES if this is a directory
2771 * Opaque handle to an asynchronous directory scanning activity.
2773 struct GNUNET_FS_DirScanner;
2777 * Start a directory scanner.
2779 * @param filename name of the directory to scan
2780 * @param disable_extractor #GNUNET_YES to not run libextractor on files (only
2782 * @param ex if not NULL, must be a list of extra plugins for extractor
2783 * @param cb the callback to call when there are scanning progress messages
2784 * @param cb_cls closure for @a cb
2785 * @return directory scanner object to be used for controlling the scanner
2787 struct GNUNET_FS_DirScanner *
2788 GNUNET_FS_directory_scan_start (const char *filename,
2789 int disable_extractor,
2791 GNUNET_FS_DirScannerProgressCallback cb,
2796 * Abort the scan. Must not be called from within the progress_callback
2799 * @param ds directory scanner structure
2802 GNUNET_FS_directory_scan_abort (struct GNUNET_FS_DirScanner *ds);
2806 * Obtain the result of the scan after the scan has signalled
2807 * completion. Must not be called prior to completion. The @a ds is
2808 * freed as part of this call.
2810 * @param ds directory scanner structure
2811 * @return the results of the scan (a directory tree)
2813 struct GNUNET_FS_ShareTreeItem *
2814 GNUNET_FS_directory_scan_get_result (struct GNUNET_FS_DirScanner *ds);
2818 * Process a share item tree, moving frequent keywords up and
2819 * copying frequent metadata up.
2821 * @param toplevel toplevel directory in the tree, returned by the scanner
2824 GNUNET_FS_share_tree_trim (struct GNUNET_FS_ShareTreeItem *toplevel);
2828 * Release memory of a share item tree.
2830 * @param toplevel toplevel of the tree to be freed
2833 GNUNET_FS_share_tree_free (struct GNUNET_FS_ShareTreeItem *toplevel);
2836 #if 0 /* keep Emacsens' auto-indent happy */
2845 /** @} */ /* end of group */