/*
This file is part of GNUnet
- (C) 2004--2013 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
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.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @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
* 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 0x00090200
+#define GNUNET_FS_VERSION 0x00090300
/* ******************** URI API *********************** */
* @param is_mandatory is the keyword mandatory (in a search)
* @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);
* @param is_mandatory is this keyword mandatory?
*/
void
-GNUNET_FS_uri_ksk_add_keyword (struct GNUNET_FS_Uri *uri,
+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);
/**
*
* @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);
* @return an FS URI for the given namespace and identifier
*/
struct GNUNET_FS_Uri *
-GNUNET_FS_uri_sks_create (const struct GNUNET_CRYPTO_EccPublicKey *ns,
+GNUNET_FS_uri_sks_create (const struct GNUNET_CRYPTO_EcdsaPublicKey *ns,
const char *id);
*
* @param uri the uri to get the namespace ID from
* @param pseudonym where to store the public key of the namespace
- * @return GNUNET_OK on success
+ * @return #GNUNET_OK on success
*/
int
GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
- struct GNUNET_CRYPTO_EccPublicKey *pseudonym);
+ struct GNUNET_CRYPTO_EcdsaPublicKey *pseudonym);
/**
* 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);
* @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
+ * @return #GNUNET_OK on success
*/
int
-GNUNET_FS_getopt_set_keywords (struct GNUNET_GETOPT_CommandLineProcessorContext
- *ctx, void *scls, const char *option,
+GNUNET_FS_getopt_set_keywords (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
+ void *scls,
+ const char *option,
const char *value);
* 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
+
};
} progress;
+ /**
+ * These values are only valid for
+ * #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.
*/
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;
/**
{
/**
- * 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;
/**
/**
* Public key of the namespace.
*/
- struct GNUNET_CRYPTO_EccPublicKey pseudonym;
+ struct GNUNET_CRYPTO_EcdsaPublicKey pseudonym;
} ns;
* will be passed to future callbacks in the respective
* 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);
/**
};
-/**
- * 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.
*/
*/
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
/**
* 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
struct GNUNET_FS_PublishContext *
GNUNET_FS_publish_start (struct GNUNET_FS_Handle *h,
struct GNUNET_FS_FileInformation *fi,
- const struct GNUNET_CRYPTO_EccPrivateKey *ns,
+ 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);
/**
*/
struct GNUNET_FS_PublishSksContext *
GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
- const struct GNUNET_CRYPTO_EccPrivateKey *ns,
- const char *identifier,
+ const struct GNUNET_CRYPTO_EcdsaPrivateKey *ns,
+ const char *identifier,
const char *update,
const struct GNUNET_CONTAINER_MetaData *meta,
const struct GNUNET_FS_Uri *uri,
* @param file_id hash of the contents of the indexed file
* @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 @a iterator
- * @return NULL on error ('iter' is not called)
+ * @return NULL on error (@a iterator is not called)
*/
struct GNUNET_FS_GetIndexedContext *
GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
*
* @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,
+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 struct GNUNET_CONTAINER_MetaData *last_meta,
const char *next_id);
*/
void
GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Handle *h,
- const struct GNUNET_CRYPTO_EccPrivateKey *ns,
+ const struct GNUNET_CRYPTO_EcdsaPrivateKey *ns,
const char *next_id,
GNUNET_FS_IdentifierProcessor ip,
void *ip_cls);
*/
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)
};
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 *********************** */
* #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);
/**
- * 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 @a cb
*/
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);
}
#endif
-
#endif
+
+/** @} */ /* end of group */