/*
This file is part of GNUnet
- (C) 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2004--2013 GNUnet e.V.
- GNUnet is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Affero General Public License for more details.
*/
/**
- * @file include/gnunet_fs_service.h
- * @brief API for file-sharing via GNUnet
* @author Christian Grothoff
+ *
+ * @file
+ * API for file sharing via GNUnet
+ *
+ * @defgroup fs FS service
+ * File sharing
+ *
+ * @see [Documentation](https://gnunet.org/file-sharing-service)
+ *
+ * @{
*/
#ifndef GNUNET_FS_LIB_H
#define GNUNET_FS_LIB_H
#include "gnunet_util_lib.h"
-#include "gnunet_scheduler_lib.h"
#ifdef __cplusplus
extern "C"
* 6.1.x: with simplified namespace support
* 9.0.0: CPS-style integrated API
* 9.1.1: asynchronous directory scanning
+ * 9.2.0: unified K-Block and S-block format (#2564)
+ * 9.3.0: base32crockford encoded URLs
*/
-#define GNUNET_FS_VERSION 0x00090103
+#define GNUNET_FS_VERSION 0x00090300
/* ******************** URI API *********************** */
*/
struct GNUNET_FS_Uri;
+
/**
* Iterator over keywords
*
* @param cls closure
* @param keyword the keyword
* @param is_mandatory is the keyword mandatory (in a search)
- * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
+ * @return #GNUNET_OK to continue to iterate, #GNUNET_SYSERR to abort
*/
-typedef int (*GNUNET_FS_KeywordIterator) (void *cls, const char *keyword,
- int is_mandatory);
+typedef int
+(*GNUNET_FS_KeywordIterator) (void *cls,
+ const char *keyword,
+ int is_mandatory);
+
+
/**
* Get a unique key from a URI. This is for putting URIs
*
* @param uri uri to convert to a unique key
* @param key wherer to store the unique key
+ * @return #GNUNET_OK on success
*/
-void
-GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri, struct GNUNET_HashCode * key);
+int
+GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri,
+ struct GNUNET_HashCode *key);
+
/**
* Convert a URI to a UTF-8 String.
char *
GNUNET_FS_uri_to_string (const struct GNUNET_FS_Uri *uri);
+
/**
* Convert keyword URI to a human readable format
* (i.e. the search query that was used in the first place)
* @param is_mandatory is this keyword mandatory?
*/
void
-GNUNET_FS_uri_ksk_add_keyword (struct GNUNET_FS_Uri *uri, const char *keyword,
+GNUNET_FS_uri_ksk_add_keyword (struct GNUNET_FS_Uri *uri,
+ const char *keyword,
int is_mandatory);
* @return NULL on error
*/
struct GNUNET_FS_Uri *
-GNUNET_FS_uri_parse (const char *uri, char **emsg);
+GNUNET_FS_uri_parse (const char *uri,
+ char **emsg);
+
/**
* Free URI.
*
* @param uri ksk uri to get the keywords from
* @param iterator function to call on each keyword
- * @param iterator_cls closure for iterator
+ * @param iterator_cls closure for @a iterator
* @return -1 if this is not a keyword URI, otherwise number of
* keywords iterated over until iterator aborted
*/
*
* @param uri the location URI to inspect
* @param peer where to store the identify of the peer (presumably) offering the content
- * @return GNUNET_SYSERR if this is not a location URI, otherwise GNUNET_OK
+ * @return #GNUNET_SYSERR if this is not a location URI, otherwise #GNUNET_OK
*/
int
GNUNET_FS_uri_loc_get_peer_identity (const struct GNUNET_FS_Uri *uri,
/**
* Construct a location URI (this peer will be used for the location).
+ * This function should only be called from within gnunet-service-fs,
+ * as it requires the peer's private key which is generally unavailable
+ * to processes directly under the user's control. However, for
+ * testing and as it logically fits under URIs, it is in this API.
*
- * @param baseUri content offered by the sender
- * @param cfg configuration information (used to find our hostkey)
+ * @param base_uri content offered by the sender
+ * @param sign_key private key of the peer
* @param expiration_time how long will the content be offered?
* @return the location URI, NULL on error
*/
struct GNUNET_FS_Uri *
-GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *baseUri,
- const struct GNUNET_CONFIGURATION_Handle *cfg,
+GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *base_uri,
+ const struct GNUNET_CRYPTO_EddsaPrivateKey *sign_key,
struct GNUNET_TIME_Absolute expiration_time);
* if keywords is not legal (i.e. empty).
*/
struct GNUNET_FS_Uri *
-GNUNET_FS_uri_ksk_create (const char *keywords, char **emsg);
+GNUNET_FS_uri_ksk_create (const char *keywords,
+ char **emsg);
/**
* if keywords is not legal (i.e. empty).
*/
struct GNUNET_FS_Uri *
-GNUNET_FS_uri_ksk_create_from_args (unsigned int argc, const char **argv);
+GNUNET_FS_uri_ksk_create_from_args (unsigned int argc,
+ const char **argv);
/**
*
* @param u1 one of the URIs
* @param u2 the other URI
- * @return GNUNET_YES if the URIs are equal
+ * @return #GNUNET_YES if the URIs are equal
*/
int
GNUNET_FS_uri_test_equal (const struct GNUNET_FS_Uri *u1,
* Is this a namespace URI?
*
* @param uri the uri to check
- * @return GNUNET_YES if this is an SKS uri
+ * @return #GNUNET_YES if this is an SKS uri
*/
int
GNUNET_FS_uri_test_sks (const struct GNUNET_FS_Uri *uri);
-/**
- * Handle to one of our namespaces.
- */
-struct GNUNET_FS_Namespace;
-
-
-/**
- * Create an SKS URI from a namespace and an identifier.
- *
- * @param ns namespace
- * @param id identifier
- * @param emsg where to store an error message
- * @return an FS URI for the given namespace and identifier
- */
-struct GNUNET_FS_Uri *
-GNUNET_FS_uri_sks_create (struct GNUNET_FS_Namespace *ns, const char *id,
- char **emsg);
-
-
/**
* Create an SKS URI from a namespace ID and an identifier.
*
- * @param nsid namespace ID
+ * @param ns pseudonym to use
* @param id identifier
* @return an FS URI for the given namespace and identifier
*/
struct GNUNET_FS_Uri *
-GNUNET_FS_uri_sks_create_from_nsid (struct GNUNET_HashCode * nsid, const char *id);
+GNUNET_FS_uri_sks_create (const struct GNUNET_CRYPTO_EcdsaPublicKey *ns,
+ const char *id);
/**
- * Get the ID of a namespace from the given
+ * Get the public key of a namespace from the given
* namespace URI.
*
* @param uri the uri to get the namespace ID from
- * @param nsid where to store the ID of the namespace
- * @return GNUNET_OK on success
+ * @param pseudonym where to store the public key of the namespace
+ * @return #GNUNET_OK on success
*/
int
GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
- struct GNUNET_HashCode * nsid);
+ struct GNUNET_CRYPTO_EcdsaPublicKey *pseudonym);
/**
GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri);
-/**
- * Convert namespace URI to a human readable format
- * (using the namespace description, if available).
- *
- * @param cfg configuration to use
- * @param uri SKS uri to convert
- * @return NULL on error (not an SKS URI)
- */
-char *
-GNUNET_FS_uri_sks_to_string_fancy (struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_FS_Uri *uri);
-
-
/**
* Is this a keyword URI?
*
* @param uri the uri
- * @return GNUNET_YES if this is a KSK uri
+ * @return #GNUNET_YES if this is a KSK uri
*/
int
GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri);
* Is this a file (or directory) URI?
*
* @param uri the uri to check
- * @return GNUNET_YES if this is a CHK uri
+ * @return #GNUNET_YES if this is a CHK uri
*/
int
GNUNET_FS_uri_test_chk (const struct GNUNET_FS_Uri *uri);
* Is this a location URI?
*
* @param uri the uri to check
- * @return GNUNET_YES if this is a LOC uri
+ * @return #GNUNET_YES if this is a LOC uri
*/
int
GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri);
/* ******************** command-line option parsing API *********************** */
/**
- * Command-line option parser function that allows the user
- * to specify one or more '-k' options with keywords. Each
- * specified keyword will be added to the URI. A pointer to
- * the URI must be passed as the "scls" argument.
+ * Allow user to specify keywords.
*
- * @param ctx command line processor context
- * @param scls must be of type "struct GNUNET_FS_Uri **"
- * @param option name of the option (typically 'k')
- * @param value command line argument given
- * @return GNUNET_OK on success
+ * @param shortName short name of the option
+ * @param name long name of the option
+ * @param argumentHelp help text for the option argument
+ * @param description long help text for the option
+ * @param[out] topKeywords set to the desired value
*/
-int
-GNUNET_FS_getopt_set_keywords (struct GNUNET_GETOPT_CommandLineProcessorContext
- *ctx, void *scls, const char *option,
- const char *value);
+struct GNUNET_GETOPT_CommandLineOption
+GNUNET_FS_GETOPT_KEYWORDS (char shortName,
+ const char *name,
+ const char *argumentHelp,
+ const char *description,
+ struct GNUNET_FS_Uri **topKeywords);
+/**
+ * Allow user to specify metadata.
+ *
+ * @param shortName short name of the option
+ * @param name long name of the option
+ * @param argumentHelp help text for the option argument
+ * @param description long help text for the option
+ * @param[out] metadata set to the desired value
+ */
+struct GNUNET_GETOPT_CommandLineOption
+GNUNET_FS_GETOPT_METADATA (char shortName,
+ const char *name,
+ const char *argumentHelp,
+ const char *description,
+ struct GNUNET_CONTAINER_MetaData **meta);
/**
* Command-line option parser function that allows the user to specify
* the metadata must be passed as the "scls" argument.
*
* @param ctx command line processor context
- * @param scls must be of type "struct GNUNET_CONTAINER_MetaData **"
+ * @param scls must be of type `struct GNUNET_CONTAINER_MetaData **`
* @param option name of the option (typically 'k')
* @param value command line argument given
- * @return GNUNET_OK on success
+ * @return #GNUNET_OK on success
*/
int
-GNUNET_FS_getopt_set_metadata (struct GNUNET_GETOPT_CommandLineProcessorContext
- *ctx, void *scls, const char *option,
+GNUNET_FS_getopt_set_metadata (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
+ void *scls,
+ const char *option,
const char *value);
* Notification that the unindexing of this file
* was stopped (final event for this action).
*/
- GNUNET_FS_STATUS_UNINDEX_STOPPED = 36
+ GNUNET_FS_STATUS_UNINDEX_STOPPED = 36,
+
+ /**
+ * Notification that we are making progress sharing a directory.
+ */
+ GNUNET_FS_STATUS_PUBLISH_PROGRESS_DIRECTORY = 37
+
};
/**
* These values are only valid for
- * GNUNET_FS_STATUS_PUBLISH_PROGRESS events.
+ * #GNUNET_FS_STATUS_PUBLISH_PROGRESS events.
*/
struct
{
/**
* These values are only valid for
- * GNUNET_FS_STATUS_PUBLISH_RESUME events.
+ * #GNUNET_FS_STATUS_PUBLISH_PROGRESS_DIRECTORY events.
+ */
+ struct
+ {
+
+ /**
+ * How far are we along in the overall directory?
+ */
+ uint64_t completed;
+
+ /**
+ * How big do we estimate the entire directory to be?
+ */
+ uint64_t total;
+
+ /**
+ * At what time do we expect to finish the upload of the
+ * CONTENTS of the directory. (The direcory itself will take
+ * extra time, indicated with the "eta" member at the
+ * "publish"-level of this struct.)
+ */
+ struct GNUNET_TIME_Relative eta;
+
+ } progress_directory;
+
+ /**
+ * These values are only valid for
+ * #GNUNET_FS_STATUS_PUBLISH_RESUME events.
*/
struct
{
*/
const struct GNUNET_FS_Uri *chk_uri;
+ /**
+ * SKS URI of the file (if the download had been completed)
+ */
+ const struct GNUNET_FS_Uri *sks_uri;
+
} resume;
/**
* These values are only valid for
- * GNUNET_FS_STATUS_PUBLISH_COMPLETED events.
+ * #GNUNET_FS_STATUS_PUBLISH_COMPLETED events.
*/
struct
{
/**
- * URI of the file.
+ * CHK URI of the file.
*/
const struct GNUNET_FS_Uri *chk_uri;
+ /**
+ * SKS URI of the file (if the download had been completed)
+ */
+ const struct GNUNET_FS_Uri *sks_uri;
+
} completed;
/**
* These values are only valid for
- * GNUNET_FS_STATUS_PUBLISH_ERROR events.
+ * #GNUNET_FS_STATUS_PUBLISH_ERROR events.
*/
struct
{
/**
* These values are only valid for
- * GNUNET_FS_STATUS_DOWNLOAD_PROGRESS events.
+ * #GNUNET_FS_STATUS_DOWNLOAD_PROGRESS events.
*/
struct
{
/**
* How much time passed between us asking for this block and
- * actually getting it? GNUNET_TIME_UNIT_FOREVER_REL if unknown.
+ * actually getting it? #GNUNET_TIME_UNIT_FOREVER_REL if unknown.
*/
struct GNUNET_TIME_Relative block_download_duration;
/**
* These values are only valid for
- * GNUNET_FS_STATUS_DOWNLOAD_START events.
+ * #GNUNET_FS_STATUS_DOWNLOAD_START events.
*/
struct
{
/**
* These values are only valid for
- * GNUNET_FS_STATUS_DOWNLOAD_RESUME events.
+ * #GNUNET_FS_STATUS_DOWNLOAD_RESUME events.
*/
struct
{
/**
* These values are only valid for
- * GNUNET_FS_STATUS_DOWNLOAD_ERROR events.
+ * #GNUNET_FS_STATUS_DOWNLOAD_ERROR events.
*/
struct
{
/**
* These values are only valid for
- * GNUNET_FS_STATUS_SEARCH_RESULT events.
+ * #GNUNET_FS_STATUS_SEARCH_RESULT events.
*/
struct
{
/**
* These values are only valid for
- * GNUNET_FS_STATUS_SEARCH_RESUME_RESULT events.
+ * #GNUNET_FS_STATUS_SEARCH_RESUME_RESULT events.
*/
struct
{
/**
* These values are only valid for
- * GNUNET_FS_STATUS_SEARCH_UPDATE events.
+ * #GNUNET_FS_STATUS_SEARCH_UPDATE events.
*/
struct
{
/**
* These values are only valid for
- * GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND events.
+ * #GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND events.
* These events are automatically triggered for
* each search result before the
- * GNUNET_FS_STATUS_SEARCH_SUSPEND event. This
+ * #GNUNET_FS_STATUS_SEARCH_SUSPEND event. This
* happens primarily to give the client a chance
* to clean up the "cctx" (if needed).
*/
/**
* These values are only valid for
- * GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED events.
+ * #GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED events.
* These events are automatically triggered for
* each search result before the
- * GNUNET_FS_STATUS_SEARCH_STOPPED event. This
+ * #GNUNET_FS_STATUS_SEARCH_STOPPED event. This
* happens primarily to give the client a chance
* to clean up the "cctx" (if needed).
*/
/**
* These values are only valid for
- * GNUNET_FS_STATUS_SEARCH_RESUME events.
+ * #GNUNET_FS_STATUS_SEARCH_RESUME events.
*/
struct
{
/**
* These values are only valid for
- * GNUNET_FS_STATUS_SEARCH_ERROR events.
+ * #GNUNET_FS_STATUS_SEARCH_ERROR events.
*/
struct
{
} error;
/**
- * Values for all "GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE" events.
+ * Values for #GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE events.
*/
struct
{
- /**
- * Handle to the namespace (NULL if it is not a local
- * namespace).
- */
- struct GNUNET_FS_Namespace *ns;
-
/**
* Short, human-readable name of the namespace.
*/
const struct GNUNET_CONTAINER_MetaData *meta;
/**
- * Hash-identifier for the namespace.
+ * Public key of the namespace.
*/
- struct GNUNET_HashCode id;
+ struct GNUNET_CRYPTO_EcdsaPublicKey pseudonym;
} ns;
/**
* These values are only valid for
- * GNUNET_FS_STATUS_UNINDEX_PROGRESS events.
+ * #GNUNET_FS_STATUS_UNINDEX_PROGRESS events.
*/
struct
{
/**
* These values are only valid for
- * GNUNET_FS_STATUS_UNINDEX_RESUME events.
+ * #GNUNET_FS_STATUS_UNINDEX_RESUME events.
*/
struct
{
/**
* These values are only valid for
- * GNUNET_FS_STATUS_UNINDEX_ERROR events.
+ * #GNUNET_FS_STATUS_UNINDEX_ERROR events.
*/
struct
{
*/
enum GNUNET_FS_Status status;
+ /**
+ * File-sharing handle that generated the event.
+ */
+ struct GNUNET_FS_Handle *fsh;
};
* for this operation; should be set to NULL for
* SUSPEND and STOPPED events). The value returned
* will be passed to future callbacks in the respective
- * field in the GNUNET_FS_ProgressInfo struct.
+ * field in the `struct GNUNET_FS_ProgressInfo`.
*/
-typedef void *(*GNUNET_FS_ProgressCallback) (void *cls,
- const struct GNUNET_FS_ProgressInfo *info);
+typedef void *
+(*GNUNET_FS_ProgressCallback) (void *cls,
+ const struct GNUNET_FS_ProgressInfo *info);
/**
*/
enum GNUNET_FS_Flags
{
- /**
- * No special flags set.
- */
+ /**
+ * No special flags set.
+ */
GNUNET_FS_FLAGS_NONE = 0,
- /**
- * Is persistence of operations desired?
- * (will create SUSPEND/RESUME events).
- */
+ /**
+ * Is persistence of operations desired?
+ * (will create SUSPEND/RESUME events).
+ */
GNUNET_FS_FLAGS_PERSISTENCE = 1,
- /**
- * Should we automatically trigger probes for search results
- * to determine availability?
- * (will create GNUNET_FS_STATUS_SEARCH_UPDATE events).
- */
+ /**
+ * Should we automatically trigger probes for search results
+ * to determine availability?
+ * (will create #GNUNET_FS_STATUS_SEARCH_UPDATE events).
+ */
GNUNET_FS_FLAGS_DO_PROBES = 2
};
};
-/**
- * Return the current year (i.e. '2011').
- */
-unsigned int
-GNUNET_FS_get_current_year (void);
-
-
-/**
- * Convert a year to an expiration time of January 1st of that year.
- *
- * @param year a year (after 1970, please ;-)).
- * @return absolute time for January 1st of that year.
- */
-struct GNUNET_TIME_Absolute
-GNUNET_FS_year_to_time (unsigned int year);
-
-
-/**
- * Convert an expiration time to the respective year (rounds)
- *
- * @param at absolute time
- * @return year a year (after 1970), 0 on error
- */
-unsigned int
-GNUNET_FS_time_to_year (struct GNUNET_TIME_Absolute at);
-
-
/**
* Handle to the file-sharing service.
*/
* @param cfg configuration to use
* @param client_name unique identifier for this client
* @param upcb function to call to notify about FS actions
- * @param upcb_cls closure for upcb
+ * @param upcb_cls closure for @a upcb
* @param flags specific attributes for fs-operations
- * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
+ * @param ... list of optional options, terminated with #GNUNET_FS_OPTIONS_END
* @return NULL on error
*/
struct GNUNET_FS_Handle *
GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const char *client_name, GNUNET_FS_ProgressCallback upcb,
- void *upcb_cls, enum GNUNET_FS_Flags flags, ...);
+ const char *client_name,
+ GNUNET_FS_ProgressCallback upcb,
+ void *upcb_cls,
+ enum GNUNET_FS_Flags flags,
+ ...);
/**
* Close our connection with the file-sharing service.
- * The callback given to GNUNET_FS_start will no longer be
+ * The callback given to #GNUNET_FS_start() will no longer be
* called after this function returns.
+ * This function MUST NOT be called from within the
+ * callback itself.
*
- * @param h handle that was returned from GNUNET_FS_start
+ * @param h handle that was returned from #GNUNET_FS_start()
*/
void
GNUNET_FS_stop (struct GNUNET_FS_Handle *h);
/**
- * Function called on entries in a GNUNET_FS_FileInformation publish-structure.
+ * Function called on entries in a `struct GNUNET_FS_FileInformation` iteration.
*
* @param cls closure
* @param fi the entry in the publish-structure
* @param bo block options (can be modified)
* @param do_index should we index (can be modified)
* @param client_info pointer to client context set upon creation (can be modified)
- * @return GNUNET_OK to continue, GNUNET_NO to remove
- * this entry from the directory, GNUNET_SYSERR
+ * @return #GNUNET_OK to continue, #GNUNET_NO to remove
+ * this entry from the directory, #GNUNET_SYSERR
* to abort the iteration
*/
-typedef int (*GNUNET_FS_FileInformationProcessor) (void *cls,
- struct
- GNUNET_FS_FileInformation *
- fi, uint64_t length,
- struct
- GNUNET_CONTAINER_MetaData *
- meta,
- struct GNUNET_FS_Uri ** uri,
- struct GNUNET_FS_BlockOptions
- * bo, int *do_index,
- void **client_info);
+typedef int
+(*GNUNET_FS_FileInformationProcessor) (void *cls,
+ struct GNUNET_FS_FileInformation *fi,
+ uint64_t length,
+ struct GNUNET_CONTAINER_MetaData *meta,
+ struct GNUNET_FS_Uri ** uri,
+ struct GNUNET_FS_BlockOptions *bo,
+ int *do_index,
+ void **client_info);
/**
* file information structures.
*
* @param s structure to get the filename for
- * @return NULL on error, otherwise filename that
- * can be passed to "GNUNET_FS_file_information_recover"
+ * @return NULL on error, otherwise filename that can be used
* to read this fi-struct from disk.
*/
const char *
* @param keywords under which keywords should this file be available
* directly; can be NULL
* @param meta metadata for the file
- * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
- * GNUNET_SYSERR for simulation
+ * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
+ * #GNUNET_SYSERR for simulation
* @param bo block options
* @return publish structure entry for the file
*/
GNUNET_FS_file_information_create_from_file (struct GNUNET_FS_Handle *h,
void *client_info,
const char *filename,
- const struct GNUNET_FS_Uri
- *keywords,
- const struct
- GNUNET_CONTAINER_MetaData *meta,
+ const struct GNUNET_FS_Uri *keywords,
+ const struct GNUNET_CONTAINER_MetaData *meta,
int do_index,
- const struct GNUNET_FS_BlockOptions
- *bo);
+ const struct GNUNET_FS_BlockOptions *bo);
/**
* @param keywords under which keywords should this file be available
* directly; can be NULL
* @param meta metadata for the file
- * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
- * GNUNET_SYSERR for simulation
+ * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
+ * #GNUNET_SYSERR for simulation
* @param bo block options
* @return publish structure entry for the file
*/
struct GNUNET_FS_FileInformation *
GNUNET_FS_file_information_create_from_data (struct GNUNET_FS_Handle *h,
- void *client_info, uint64_t length,
+ void *client_info,
+ uint64_t length,
void *data,
- const struct GNUNET_FS_Uri
- *keywords,
- const struct
- GNUNET_CONTAINER_MetaData *meta,
+ const struct GNUNET_FS_Uri *keywords,
+ const struct GNUNET_CONTAINER_MetaData *meta,
int do_index,
- const struct GNUNET_FS_BlockOptions
- *bo);
+ const struct GNUNET_FS_BlockOptions *bo);
/**
* the reader to clean up its internal state
* @param buf where the reader should write the data
* @param emsg location for the reader to store an error message
- * @return number of bytes written, usually "max", 0 on error
+ * @return number of bytes written, usually @a max, 0 on error
*/
-typedef size_t (*GNUNET_FS_DataReader) (void *cls, uint64_t offset, size_t max,
- void *buf, char **emsg);
+typedef size_t
+(*GNUNET_FS_DataReader) (void *cls,
+ uint64_t offset,
+ size_t max,
+ void *buf,
+ char **emsg);
/**
* @param client_info initial client-info value for this entry
* @param length length of the file
* @param reader function that can be used to obtain the data for the file
- * @param reader_cls closure for "reader"
+ * @param reader_cls closure for @a reader
* @param keywords under which keywords should this file be available
* directly; can be NULL
* @param meta metadata for the file
- * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
- * GNUNET_SYSERR for simulation
+ * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
+ * #GNUNET_SYSERR for simulation
* @param bo block options
* @return publish structure entry for the file
*/
/**
* Create an entry for an empty directory in a publish-structure.
- * This function should be used by applications for which the
- * use of "GNUNET_FS_file_information_create_from_directory"
- * is not appropriate.
*
* @param h handle to the file sharing subsystem
* @param client_info initial client-info value for this entry
* Test if a given entry represents a directory.
*
* @param ent check if this FI represents a directory
- * @return GNUNET_YES if so, GNUNET_NO if not
+ * @return #GNUNET_YES if so, #GNUNET_NO if not
*/
int
GNUNET_FS_file_information_is_directory (const struct GNUNET_FS_FileInformation
/**
* Add an entry to a directory in a publish-structure. Clients
* should never modify publish structures that were passed to
- * "GNUNET_FS_publish_start" already.
+ * #GNUNET_FS_publish_start() already.
*
* @param dir the directory
* @param ent the entry to add; the entry must not have been
* added to any other directory at this point and
- * must not include "dir" in its structure
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * must not include @a dir in its structure
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
/**
* Inspect a file or directory in a publish-structure. Clients
* should never modify publish structures that were passed to
- * "GNUNET_FS_publish_start" already. When called on a directory,
- * this function will FIRST call "proc" with information about
+ * #GNUNET_FS_publish_start already. When called on a directory,
+ * this function will FIRST call @a proc with information about
* the directory itself and then for each of the files in the
* directory (but not for files in subdirectories). When called
- * on a file, "proc" will be called exactly once (with information
+ * on a file, @a proc will be called exactly once (with information
* about the specific file).
*
* @param dir the directory
* @param proc function to call on each entry
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
*/
void
GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir,
/**
* Destroy publish-structure. Clients should never destroy publish
- * structures that were passed to "GNUNET_FS_publish_start" already.
+ * structures that were passed to #GNUNET_FS_publish_start already.
*
* @param fi structure to destroy
* @param cleaner function to call on each entry in the structure
* (useful to clean up client_info); can be NULL; return
* values are ignored
- * @param cleaner_cls closure for cleaner
+ * @param cleaner_cls closure for @a cleaner
*/
void
GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi,
*/
enum GNUNET_FS_PublishOptions
{
- /**
- * No options (use defaults for everything).
- */
+ /**
+ * No options (use defaults for everything).
+ */
GNUNET_FS_PUBLISH_OPTION_NONE = 0,
- /**
- * Simulate publishing. With this option, no data will be stored
- * in the datastore. Useful for computing URIs from files.
- */
+ /**
+ * Simulate publishing. With this option, no data will be stored
+ * in the datastore. Useful for computing URIs from files.
+ */
GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY = 1
};
+
/**
* Publish a file or directory.
*
struct GNUNET_FS_PublishContext *
GNUNET_FS_publish_start (struct GNUNET_FS_Handle *h,
struct GNUNET_FS_FileInformation *fi,
- struct GNUNET_FS_Namespace *ns, const char *nid,
+ const struct GNUNET_CRYPTO_EcdsaPrivateKey *ns,
+ const char *nid,
const char *nuid,
enum GNUNET_FS_PublishOptions options);
* @param uri URI under which the block is now available, NULL on error
* @param emsg error message, NULL on success
*/
-typedef void (*GNUNET_FS_PublishContinuation) (void *cls,
- const struct GNUNET_FS_Uri * uri,
- const char *emsg);
+typedef void
+(*GNUNET_FS_PublishContinuation) (void *cls,
+ const struct GNUNET_FS_Uri *uri,
+ const char *emsg);
/**
* @param bo block options
* @param options publication options
* @param cont continuation
- * @param cont_cls closure for cont
- * @return NULL on error ('cont' will still be called)
+ * @param cont_cls closure for @a cont
+ * @return NULL on error (@a cont will still be called)
*/
struct GNUNET_FS_PublishKskContext *
GNUNET_FS_publish_ksk (struct GNUNET_FS_Handle *h,
* @param bo block options
* @param options publication options
* @param cont continuation
- * @param cont_cls closure for cont
- * @return NULL on error ('cont' will still be called)
+ * @param cont_cls closure for @a cont
+ * @return NULL on error (@a cont will still be called)
*/
struct GNUNET_FS_PublishSksContext *
GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
- struct GNUNET_FS_Namespace *ns,
- const char *identifier, const char *update,
+ const struct GNUNET_CRYPTO_EcdsaPrivateKey *ns,
+ const char *identifier,
+ const char *update,
const struct GNUNET_CONTAINER_MetaData *meta,
const struct GNUNET_FS_Uri *uri,
const struct GNUNET_FS_BlockOptions *bo,
/**
- * Type of a function called by "GNUNET_FS_get_indexed_files".
+ * Type of a function called by #GNUNET_FS_get_indexed_files.
*
* @param cls closure
* @param filename the name of the file, NULL for end of list
* @param file_id hash of the contents of the indexed file
- * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
+ * @return #GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort
*/
-typedef int (*GNUNET_FS_IndexedFileProcessor) (void *cls, const char *filename,
- const struct GNUNET_HashCode * file_id);
+typedef int
+(*GNUNET_FS_IndexedFileProcessor) (void *cls,
+ const char *filename,
+ const struct GNUNET_HashCode *file_id);
/**
*
* @param h handle to the file sharing subsystem
* @param iterator function to call on each indexed file
- * @param iterator_cls closure for iterator
- * @return NULL on error ('iter' is not called)
+ * @param iterator_cls closure for @a iterator
+ * @return NULL on error (@a iterator is not called)
*/
struct GNUNET_FS_GetIndexedContext *
GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
* @return NULL on error, otherwise handle
*/
struct GNUNET_FS_UnindexContext *
-GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h, const char *filename,
+GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h,
+ const char *filename,
void *cctx);
GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc);
-/**
- * Context for advertising a namespace.
- */
-struct GNUNET_FS_AdvertisementContext;
-
-
-/**
- * Publish an advertismement for a namespace.
- *
- * @param h handle to the file sharing subsystem
- * @param ksk_uri keywords to use for advertisment
- * @param ns handle for the namespace that should be advertised
- * @param meta meta-data for the namespace advertisement
- * @param bo block options
- * @param rootEntry name of the root of the namespace
- * @param cont continuation
- * @param cont_cls closure for cont
- * @return NULL on error ('cont' will still be called)
- */
-struct GNUNET_FS_AdvertisementContext *
-GNUNET_FS_namespace_advertise (struct GNUNET_FS_Handle *h,
- struct GNUNET_FS_Uri *ksk_uri,
- struct GNUNET_FS_Namespace *ns,
- const struct GNUNET_CONTAINER_MetaData *meta,
- const struct GNUNET_FS_BlockOptions *bo,
- const char *rootEntry,
- GNUNET_FS_PublishContinuation cont,
- void *cont_cls);
-
-
-/**
- * Abort the namespace advertisement operation.
- *
- * @param ac context of the operation to abort.
- */
-void
-GNUNET_FS_namespace_advertise_cancel (struct GNUNET_FS_AdvertisementContext *ac);
-
-
-/**
- * Create a namespace with the given name; if one already
- * exists, return a handle to the existing namespace.
- *
- * @param h handle to the file sharing subsystem
- * @param name name to use for the namespace
- * @return handle to the namespace, NULL on error (i.e. invalid filename)
- */
-struct GNUNET_FS_Namespace *
-GNUNET_FS_namespace_create (struct GNUNET_FS_Handle *h, const char *name);
-
-
-/**
- * Open the namespace with the given name; if it does not exist,
- * or the key file is corrupted, the function fails.
- *
- * @param h handle to the file sharing subsystem
- * @param name name of the namespace
- * @return handle to the namespace,
- * NULL on error (i.e. invalid filename, non-existent filename)
- */
-struct GNUNET_FS_Namespace *
-GNUNET_FS_namespace_open_existing (struct GNUNET_FS_Handle *h, const char *name);
-
-
-/**
- * Context for creating a namespace asynchronously.
- */
-struct GNUNET_FS_NamespaceCreationContext;
-
-/**
- * Function called upon completion of 'GNUNET_FS_namespace_create_start'.
- *
- * @param cls closure
- * @param ns NULL on error, otherwise the namespace (which must be free'd by the callee)
- * @param emsg NULL on success, otherwise an error message
- */
-typedef void (*GNUNET_FS_NamespaceCreationCallback)(void *cls,
- struct GNUNET_FS_Namespace *ns, const char *emsg);
-
-
-/**
- * Create a namespace with the given name; if one already
- * exists, return a handle to the existing namespace immediately.
- * Otherwise create a namespace asynchronously.
- *
- * @param h handle to the file sharing subsystem
- * @param name name to use for the namespace
- * @return namespace creation context, NULL on error (i.e. invalid filename)
- */
-struct GNUNET_FS_NamespaceCreationContext *
-GNUNET_FS_namespace_create_start (struct GNUNET_FS_Handle *h, const char *name,
- GNUNET_FS_NamespaceCreationCallback cont, void *cont_cls);
-
-
-/**
- * Abort namespace creation.
- *
- * @param ncc namespace creation context to abort
- */
-void
-GNUNET_FS_namespace_create_stop (struct GNUNET_FS_NamespaceCreationContext *ncc);
-
-
-/**
- * Duplicate a namespace handle.
- *
- * @param ns namespace handle
- * @return duplicated handle to the namespace
- */
-struct GNUNET_FS_Namespace *
-GNUNET_FS_namespace_dup (struct GNUNET_FS_Namespace *ns);
-
-
-/**
- * Get hash of the public key of a namespace.
- *
- * @param ns namespace
- * @param id buffer to store the key in
- * @return GNUNET_OK on success
- * GNUNET_SYSERR on failure (contents of id remain intact)
- */
-int
-GNUNET_FS_namespace_get_public_key_hash (struct GNUNET_FS_Namespace *ns,
- struct GNUNET_HashCode *id);
-
-
-/**
- * Delete a namespace handle. Can be used for a clean shutdown (free
- * memory) or also to freeze the namespace to prevent further
- * insertions by anyone.
- *
- * @param ns handle to the namespace that should be deleted / freed
- * @param freeze prevents future insertions; creating a namespace
- * with the same name again will create a fresh namespace instead
- *
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
- */
-int
-GNUNET_FS_namespace_delete (struct GNUNET_FS_Namespace *ns, int freeze);
-
-
-/**
- * Callback with information about local (!) namespaces.
- * Contains the names of the local namespace and the global
- * ID.
- *
- * @param cls closure
- * @param name human-readable identifier of the namespace
- * @param id hash identifier for the namespace
- */
-typedef void (*GNUNET_FS_NamespaceInfoProcessor) (void *cls, const char *name,
- const struct GNUNET_HashCode * id);
-
-
-/**
- * Build a list of all available local (!) namespaces The returned
- * names are only the nicknames since we only iterate over the local
- * namespaces.
- *
- * @param h handle to the file sharing subsystem
- * @param cb function to call on each known namespace
- * @param cb_cls closure for cb
- */
-void
-GNUNET_FS_namespace_list (struct GNUNET_FS_Handle *h,
- GNUNET_FS_NamespaceInfoProcessor cb, void *cb_cls);
-
-
/**
* Function called on updateable identifiers.
*
* @param cls closure
* @param last_id last identifier
- * @param last_uri uri used for the content published under the last_id
- * @param last_meta metadata associated with last_uri
+ * @param last_uri uri used for the content published under the @a last_id
+ * @param last_meta metadata associated with @a last_uri
* @param next_id identifier that should be used for updates
*/
-typedef void (*GNUNET_FS_IdentifierProcessor) (void *cls, const char *last_id,
- const struct GNUNET_FS_Uri *
- last_uri,
- const struct
- GNUNET_CONTAINER_MetaData *
- last_meta, const char *next_id);
+typedef void (*GNUNET_FS_IdentifierProcessor) (void *cls,
+ const char *last_id,
+ const struct GNUNET_FS_Uri *last_uri,
+ const struct GNUNET_CONTAINER_MetaData *last_meta,
+ const char *next_id);
/**
* has a name. Each node can have any number of URI/meta-data entries
* which can each be linked to other nodes. Cycles are possible.
*
- * Calling this function with "next_id" NULL will cause the library to
- * call "ip" with a root for each strongly connected component of the
+ * Calling this function with @a next_id NULL will cause the library to
+ * call @a ip with a root for each strongly connected component of the
* graph (a root being a node from which all other nodes in the Scc
* are reachable).
*
- * Calling this function with "next_id" being the name of a node will
- * cause the library to call "ip" with all children of the node. Note
+ * Calling this function with @a next_id being the name of a node will
+ * cause the library to call @a ip with all children of the node. Note
* that cycles within an SCC are possible (including self-loops).
*
+ * @param h fs handle to use
* @param ns namespace to inspect for updateable content
* @param next_id ID to look for; use NULL to look for SCC roots
* @param ip function to call on each updateable identifier
- * @param ip_cls closure for ip
+ * @param ip_cls closure for @a ip
*/
void
-GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Namespace *ns,
+GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Handle *h,
+ const struct GNUNET_CRYPTO_EcdsaPrivateKey *ns,
const char *next_id,
GNUNET_FS_IdentifierProcessor ip,
void *ip_cls);
GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc);
+/**
+ * Start download probes for the given search result.
+ *
+ * @param h file-sharing handle to use for the operation
+ * @param uri URI to probe
+ * @param meta meta data associated with the URI
+ * @param client_info client info pointer to use for associated events
+ * @param anonymity anonymity level to use for the probes
+ * @return the search result handle to access the probe activity
+ */
+struct GNUNET_FS_SearchResult *
+GNUNET_FS_probe (struct GNUNET_FS_Handle *h,
+ const struct GNUNET_FS_Uri *uri,
+ const struct GNUNET_CONTAINER_MetaData *meta,
+ void *client_info,
+ uint32_t anonymity);
+
+
+/**
+ * Stop probe activity. Must ONLY be used on values
+ * returned from #GNUNET_FS_probe.
+ *
+ * @param sr search result to stop probing for (freed)
+ * @return the value of the 'client_info' pointer
+ */
+void *
+GNUNET_FS_probe_stop (struct GNUNET_FS_SearchResult *sr);
/**
*/
enum GNUNET_FS_DownloadOptions
{
- /**
- * No options (use defaults for everything).
- */
+ /**
+ * No options (use defaults for everything).
+ */
GNUNET_FS_DOWNLOAD_OPTION_NONE = 0,
- /**
- * Only download from the local host, do not access remote systems (no P2P)
- */
+ /**
+ * Only download from the local host, do not access remote systems (no P2P)
+ */
GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY = 1,
- /**
- * Do a recursive download (that is, automatically trigger the
- * download of files in directories).
- */
+ /**
+ * Do a recursive download (that is, automatically trigger the
+ * download of files in directories).
+ */
GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE = 2,
- /**
- * Do not append temporary data to
- * the target file (for the IBlocks).
- */
+ /**
+ * Do not append temporary data to
+ * the target file (for the IBlocks).
+ */
GNUNET_FS_DOWNLOAD_NO_TEMPORARIES = 4,
- /**
- * Internal option used to flag this download as a 'probe' for a
- * search result. Impacts the priority with which the download is
- * run and causes signalling callbacks to be done differently.
- * Also, probe downloads are not serialized on suspension. Normal
- * clients should not use this!
- */
+ /**
+ * Internal option used to flag this download as a 'probe' for a
+ * search result. Impacts the priority with which the download is
+ * run and causes signalling callbacks to be done differently.
+ * Also, probe downloads are not serialized on suspension. Normal
+ * clients should not use this!
+ */
GNUNET_FS_DOWNLOAD_IS_PROBE = (1 << 31)
};
* download is still using the blocking of the underlying FS
* encoding. As a result, the download may *write* outside of the
* given boundaries (if offset and length do not match the 32k FS
- * block boundaries). <p>
+ * block boundaries).
*
* The given range can be used to focus a download towards a
* particular portion of the file (optimization), not to strictly
* download is still using the blocking of the underlying FS
* encoding. As a result, the download may *write* outside of the
* given boundaries (if offset and length do not match the 32k FS
- * block boundaries). <p>
+ * block boundaries).
*
* The given range can be used to focus a download towards a
* particular portion of the file (optimization), not to strictly
GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc, int do_delete);
+/**
+ * Suspend a download.
+ *
+ * @param dc handle for the download
+ */
+void
+GNUNET_FS_download_suspend (struct GNUNET_FS_DownloadContext *dc);
+
+
+/**
+ * Resume a suspended download.
+ *
+ * @param dc handle for the download
+ */
+void
+GNUNET_FS_download_resume (struct GNUNET_FS_DownloadContext *dc);
+
+
/* ******************** Directory API *********************** */
* Does the meta-data claim that this is a directory?
* Checks if the mime-type is that of a GNUnet directory.
*
- * @return GNUNET_YES if it is, GNUNET_NO if it is not, GNUNET_SYSERR if
- * we have no mime-type information (treat as 'GNUNET_NO')
+ * @return #GNUNET_YES if it is, #GNUNET_NO if it is not, #GNUNET_SYSERR if
+ * we have no mime-type information (treat as #GNUNET_NO)
*/
int
GNUNET_FS_meta_data_test_for_directory (const struct GNUNET_CONTAINER_MetaData
* @return NULL if meta data is useless for suggesting a filename
*/
char *
-GNUNET_FS_meta_data_suggest_filename (const struct GNUNET_CONTAINER_MetaData
- *md);
+GNUNET_FS_meta_data_suggest_filename (const struct GNUNET_CONTAINER_MetaData *md);
/**
* @param data pointer to the beginning of the directory
* @param offset offset of data in the directory
* @param dep function to call on each entry
- * @param dep_cls closure for dep
- * @return GNUNET_OK if this could be a block in a directory,
- * GNUNET_NO if this could be part of a directory (but not 100% OK)
- * GNUNET_SYSERR if 'data' does not represent a directory
+ * @param dep_cls closure for @a dep
+ * @return #GNUNET_OK if this could be a block in a directory,
+ * #GNUNET_NO if this could be part of a directory (but not 100% OK)
+ * #GNUNET_SYSERR if 'data' does not represent a directory
*/
int
GNUNET_FS_directory_list_contents (size_t size, const void *data,
*/
struct GNUNET_FS_DirectoryBuilder;
+
/**
* Create a directory builder.
*
* @param bld directory to finish
* @param rsize set to the number of bytes needed
* @param rdata set to the encoded directory
- * @return GNUNET_OK on success
+ * @return #GNUNET_OK on success
*/
int
GNUNET_FS_directory_builder_finish (struct GNUNET_FS_DirectoryBuilder *bld,
*
* @param cls closure
* @param filename which file we are making progress on
- * @param is_directory GNUNET_YES if this is a directory,
- * GNUNET_NO if this is a file
- * GNUNET_SYSERR if it is neither (or unknown)
+ * @param is_directory #GNUNET_YES if this is a directory,
+ * #GNUNET_NO if this is a file
+ * #GNUNET_SYSERR if it is neither (or unknown)
* @param reason kind of progress we are making
*/
-typedef void (*GNUNET_FS_DirScannerProgressCallback) (void *cls,
+typedef void (*GNUNET_FS_DirScannerProgressCallback) (void *cls,
const char *filename,
- int is_directory,
+ int is_directory,
enum GNUNET_FS_DirScannerProgressUpdateReason reason);
char *short_filename;
/**
- * GNUNET_YES if this is a directory
+ * #GNUNET_YES if this is a directory
*/
int is_directory;
/**
- * Opaqe handle to an asynchronous directory scanning activity.
+ * Opaque handle to an asynchronous directory scanning activity.
*/
struct GNUNET_FS_DirScanner;
* Start a directory scanner.
*
* @param filename name of the directory to scan
- * @param disable_extractor GNUNET_YES to not to run libextractor on files (only build a tree)
+ * @param disable_extractor #GNUNET_YES to not run libextractor on files (only
+ * build a tree)
* @param ex if not NULL, must be a list of extra plugins for extractor
* @param cb the callback to call when there are scanning progress messages
- * @param cb_cls closure for 'cb'
+ * @param cb_cls closure for @a cb
* @return directory scanner object to be used for controlling the scanner
*/
struct GNUNET_FS_DirScanner *
GNUNET_FS_directory_scan_start (const char *filename,
- int disable_extractor,
+ int disable_extractor,
const char *ex,
- GNUNET_FS_DirScannerProgressCallback cb,
+ GNUNET_FS_DirScannerProgressCallback cb,
void *cb_cls);
/**
- * Abort the scan. Must not be called from within the progress_callback
+ * Abort the scan. Must not be called from within the progress_callback
* function.
*
* @param ds directory scanner structure
/**
* Obtain the result of the scan after the scan has signalled
- * completion. Must not be called prior to completion. The 'ds' is
+ * completion. Must not be called prior to completion. The @a ds is
* freed as part of this call.
*
* @param ds directory scanner structure
}
#endif
-
#endif
+
+/** @} */ /* end of group */
projects / oweals / gnunet.git / blobdiff