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 2, or (at your
+ by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
* @file include/gnunet_fs_service.h
* @brief API for file-sharing via GNUnet
* @author Christian Grothoff
- *
- * TODO:
- * - extend API with support for publish simulation (-s)
- * and URI-argument binding to keyword/namespace (-u)
*/
#ifndef GNUNET_FS_LIB_H
#define GNUNET_FS_LIB_H
*/
struct GNUNET_FS_Uri *
GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *baseUri,
- struct GNUNET_CONFIGURATION_Handle *cfg,
+ const struct GNUNET_CONFIGURATION_Handle *cfg,
struct GNUNET_TIME_Absolute expiration_time);
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);
+
+
/**
* Get the ID of a namespace from the given
* namespace URI.
*/
int
GNUNET_FS_getopt_set_metadata (struct GNUNET_GETOPT_CommandLineProcessorContext* ctx,
- void *scls,
- const char *option,
- const char *value);
+ void *scls,
+ const char *option,
+ const char *value);
*/
GNUNET_FS_STATUS_DOWNLOAD_STOPPED,
+ /**
+ * Notification that this download is now actively being
+ * pursued (as opposed to waiting in the queue).
+ */
+ GNUNET_FS_STATUS_DOWNLOAD_ACTIVE,
+
+ /**
+ * Notification that this download is no longer actively
+ * being pursued (back in the queue).
+ */
+ GNUNET_FS_STATUS_DOWNLOAD_INACTIVE,
+
+ /**
+ * Notification that this download is no longer part of a
+ * recursive download or search but now a 'stand-alone'
+ * download (and may thus need to be moved in the GUI
+ * into a different category).
+ */
+ GNUNET_FS_STATUS_DOWNLOAD_LOST_PARENT,
+
/**
* First event generated when a client requests
* a search to begin or when a namespace result
*/
GNUNET_FS_STATUS_SEARCH_SUSPEND,
- /**
- * Event generated for each search result
- * when the respective search is suspended.
- */
- GNUNET_FS_STATUS_SEARCH_SUSPEND_RESULT,
-
/**
* This search has yielded a result.
*/
*/
GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED,
+ /**
+ * Event generated for each search result
+ * when the respective search is suspended.
+ */
+ GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND,
+
/**
* Last message from a search; this signals
* that there will be no further events associated
};
-/**
- * Handle to one of our namespaces.
- */
-struct GNUNET_FS_Namespace;
-
-
/**
* Handle for controlling an upload.
*/
struct GNUNET_FS_SearchContext;
+/**
+ * Result from a search. Opaque handle to refer to the search
+ * (typically used when starting a download associated with the search
+ * result).
+ */
+struct GNUNET_FS_SearchResult;
+
+
/**
* Context for controlling a download.
*/
/**
* Context for controlling the upload.
*/
- struct GNUNET_FS_PublishContext *sc;
+ struct GNUNET_FS_PublishContext *pc;
/**
* Information about the file that is being publishd.
* (if this is a file in a directory or a subdirectory).
*/
void *pctx;
+
+ /**
+ * Client context pointer for the associated search operation
+ * (specifically, context pointer for the specific search
+ * result, not the overall search); only set if this
+ * download was started from a search result.
+ */
+ void *sctx;
/**
* URI used for this download.
*/
uint32_t anonymity;
+ /**
+ * Is the download currently active.
+ */
+ int is_active;
+
/**
* Additional values for specific events.
*/
/**
* Client parent-context pointer; NULL for top-level searches,
- * non-NULL for automatically triggered searches for updates in
- * namespaces.
+ * refers to the client context of the associated search result
+ * for automatically triggered searches for updates in
+ * namespaces. In this case, 'presult' refers to that search
+ * result.
*/
void *pctx;
*/
const struct GNUNET_FS_Uri *uri;
+ /**
+ * Handle to the result (for starting downloads).
+ */
+ struct GNUNET_FS_SearchResult *result;
+
+ /**
+ * Applicability rank (the larger, the better the result
+ * fits the search criteria).
+ */
+ uint32_t applicability_rank;
+
} result;
/**
*/
const struct GNUNET_FS_Uri *uri;
+ /**
+ * Handle to the result (for starting downloads).
+ */
+ struct GNUNET_FS_SearchResult *result;
+
/**
* Current availability rank (negative:
* unavailable, positive: available)
* On how many total queries is the given
* availability_rank based?
*/
- uint32_t availabiliy_certainty;
+ uint32_t availability_certainty;
/**
* Updated applicability rank (the larger,
* the better the result fits the search
* criteria).
*/
- uint32_t applicabiliy_rank;
+ uint32_t applicability_rank;
} resume_result;
* Is persistence of operations desired?
* (will create SUSPEND/RESUME events).
*/
- GNUNET_FS_FLAGS_PERSISTENCE = 1
+ GNUNET_FS_FLAGS_PERSISTENCE = 1,
+
+ /**
+ * 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
};
/**
- * Options specified in the VARARGs
- * portion of GNUNET_FS_start.
+ * Options specified in the VARARGs portion of GNUNET_FS_start.
*/
enum GNUNET_FS_OPTIONS
{
* followed by an "unsigned int" giving the desired maximum number
* of parallel downloads).
*/
- GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM = 1
+ GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM = 1,
+
+ /**
+ * Maximum number of requests that should be pending at a given
+ * point in time (invidivual downloads may go above this, but
+ * if we are above this threshold, we should not activate any
+ * additional downloads.
+ */
+ GNUNET_FS_OPTIONS_REQUEST_PARALLELISM = 2
};
GNUNET_FS_stop (struct GNUNET_FS_Handle *h);
+/**
+ * Extract meta-data from a file.
+ *
+ * @param md metadata to set
+ * @param filename name of file to inspect
+ * @param extractors plugins to use
+ * @return GNUNET_SYSERR on error, otherwise the number
+ * of meta-data items obtained
+ */
+int
+GNUNET_FS_meta_data_extract_from_file (struct
+ GNUNET_CONTAINER_MetaData
+ *md, const char *filename,
+ struct EXTRACTOR_PluginList *
+ extractors);
+
+
/**
* Function called on entries in a GNUNET_FS_FileInformation publish-structure.
*
* @param uri pointer to the keywords that will be used for this entry (can be modified)
* @param anonymity pointer to selected anonymity level (can be modified)
* @param priority pointer to selected priority (can be modified)
+ * @param do_index should we index (can be modified)
* @param expirationTime pointer to selected expiration time (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
struct GNUNET_FS_Uri **uri,
uint32_t *anonymity,
uint32_t *priority,
+ int *do_index,
struct GNUNET_TIME_Absolute *expirationTime,
void **client_info);
-/**
- * Recover file information structure from disk.
- *
- * @param fn filename for the structure on disk
- * @return NULL on error
- */
-struct GNUNET_FS_FileInformation *
-GNUNET_FS_file_information_recover (const char *fn);
-
-
/**
* Obtain the name under which this file information
* structure is stored on disk. Only works for top-level
GNUNET_FS_file_information_get_id (struct GNUNET_FS_FileInformation *s);
-/**
- * Synchronize this file-information struct with its mirror
- * on disk. Note that all internal FS-operations that change
- * file information data should already call "sync" internally,
- * so this function is likely not useful for clients.
- *
- * @param fi the struct to sync
- */
-void
-GNUNET_FS_file_information_sync (struct GNUNET_FS_FileInformation *f);
-
/**
* Create an entry for a file in a publish-structure.
*
+ * @param h handle to the file sharing subsystem
+ * @param client_info initial client-info value for this entry
* @param filename name of the file or directory to publish
* @param keywords under which keywords should this file be available
* directly; can be NULL
* @return publish structure entry for the file
*/
struct GNUNET_FS_FileInformation *
-GNUNET_FS_file_information_create_from_file (void *client_info,
+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,
/**
* Create an entry for a file in a publish-structure.
*
+ * @param h handle to the file sharing subsystem
+ * @param client_info initial client-info value for this entry
* @param length length of the file
* @param data data for the file (should not be used afterwards by
* the caller; callee will "free")
* @return publish structure entry for the file
*/
struct GNUNET_FS_FileInformation *
-GNUNET_FS_file_information_create_from_data (void *client_info,
+GNUNET_FS_file_information_create_from_data (struct GNUNET_FS_Handle *h,
+ void *client_info,
uint64_t length,
void *data,
const struct GNUNET_FS_Uri *keywords,
/**
* Create an entry for a file in a publish-structure.
*
+ * @param h handle to the file sharing subsystem
+ * @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"
* @return publish structure entry for the file
*/
struct GNUNET_FS_FileInformation *
-GNUNET_FS_file_information_create_from_reader (void *client_info,
+GNUNET_FS_file_information_create_from_reader (struct GNUNET_FS_Handle *h,
+ void *client_info,
uint64_t length,
GNUNET_FS_DataReader reader,
void *reader_cls,
* Type of a function that will be used to scan a directory.
*
* @param cls closure
+ * @param h handle to the file sharing subsystem
* @param dirname name of the directory to scan
* @param do_index should files be indexed or inserted
* @param anonymity desired anonymity level
* @return GNUNET_OK on success
*/
typedef int (*GNUNET_FS_DirectoryScanner)(void *cls,
+ struct GNUNET_FS_Handle *h,
const char *dirname,
int do_index,
uint32_t anonymity,
* convenience function.
*
* @param cls must be of type "struct EXTRACTOR_Extractor*"
+ * @param h handle to the file sharing subsystem
* @param dirname name of the directory to scan
* @param do_index should files be indexed or inserted
* @param anonymity desired anonymity level
*/
int
GNUNET_FS_directory_scanner_default (void *cls,
+ struct GNUNET_FS_Handle *h,
const char *dirname,
int do_index,
uint32_t anonymity,
* passed (GNUNET_FS_directory_scanner_default). This is strictly a
* convenience function.
*
+ * @param h handle to the file sharing subsystem
+ * @param client_info initial client-info value for this entry
* @param filename name of the top-level file or directory
* @param scanner function used to get a list of files in a directory
* @param scanner_cls closure for scanner
* @return publish structure entry for the directory, NULL on error
*/
struct GNUNET_FS_FileInformation *
-GNUNET_FS_file_information_create_from_directory (void *client_info,
+GNUNET_FS_file_information_create_from_directory (struct GNUNET_FS_Handle *h,
+ void *client_info,
const char *filename,
GNUNET_FS_DirectoryScanner scanner,
void *scanner_cls,
* use of "GNUNET_FS_file_information_create_from_directory"
* is not appropriate.
*
- * @param meta metadata for the directory
+ * @param h handle to the file sharing subsystem
+ * @param client_info initial client-info value for this entry
* @param keywords under which keywords should this directory be available
* directly; can be NULL
+ * @param meta metadata for the directory
* @param anonymity what is the desired anonymity level for sharing?
* @param priority what is the priority for OUR node to
* keep this file available? Use 0 for maximum anonymity and
* @return publish structure entry for the directory , NULL on error
*/
struct GNUNET_FS_FileInformation *
-GNUNET_FS_file_information_create_empty_directory (void *client_info,
- const struct GNUNET_CONTAINER_MetaData *meta,
+GNUNET_FS_file_information_create_empty_directory (struct GNUNET_FS_Handle *h,
+ void *client_info,
const struct GNUNET_FS_Uri *keywords,
+ const struct GNUNET_CONTAINER_MetaData *meta,
uint32_t anonymity,
uint32_t priority,
struct GNUNET_TIME_Absolute expirationTime);
+/**
+ * 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
+ */
+int
+GNUNET_FS_file_information_is_directory (struct GNUNET_FS_FileInformation *ent);
+
+
/**
* Add an entry to a directory in a publish-structure. Clients
* should never modify publish structures that were passed to
/**
- * Stop an upload. Will abort incomplete uploads (but
- * not remove blocks that have already been publishd) or
- * simply clean up the state for completed uploads.
+ * Stop a publication. Will abort incomplete publications (but
+ * not remove blocks that have already been published) or
+ * simply clean up the state for completed publications.
* Must NOT be called from within the event callback!
*
- * @param sc context for the upload to stop
+ * @param pc context for the publication to stop
*/
void
-GNUNET_FS_publish_stop (struct GNUNET_FS_PublishContext *sc);
+GNUNET_FS_publish_stop (struct GNUNET_FS_PublishContext *pc);
/**
*/
void
GNUNET_FS_publish_ksk (struct GNUNET_FS_Handle *h,
- struct GNUNET_FS_Uri *ksk_uri,
- struct GNUNET_CONTAINER_MetaData *meta,
- struct GNUNET_FS_Uri *uri,
+ const struct GNUNET_FS_Uri *ksk_uri,
+ const struct GNUNET_CONTAINER_MetaData *meta,
+ const struct GNUNET_FS_Uri *uri,
struct GNUNET_TIME_Absolute expirationTime,
uint32_t anonymity,
uint32_t priority,
struct GNUNET_FS_Namespace *namespace,
const char *identifier,
const char *update,
- struct GNUNET_CONTAINER_MetaData *meta,
- struct GNUNET_FS_Uri *uri,
+ const struct GNUNET_CONTAINER_MetaData *meta,
+ const struct GNUNET_FS_Uri *uri,
struct GNUNET_TIME_Absolute expirationTime,
uint32_t anonymity,
uint32_t priority,
* Publish an advertismement for a namespace.
*
* @param h handle to the file sharing subsystem
+ * @param ksk_uri keywords to use for advertisment
* @param namespace handle for the namespace that should be advertised
* @param meta meta-data for the namespace advertisement
* @param anonymity for the namespace advertismement
* @param priority for the namespace advertisement
* @param expiration for the namespace advertisement
- * @param advertisementURI the keyword (!) URI to advertise the
- * namespace under (we will create a GNUNET_EC_KNBlock)
- * @param rootEntry name of the root entry in the namespace (for
- * the namespace advertisement)
- *
- * @return uri of the advertisement
+ * @param rootEntry name of the root of the namespace
+ * @param cont continuation
+ * @param cont_cls closure for cont
*/
-struct GNUNET_FS_Uri *
+void
GNUNET_FS_namespace_advertise (struct GNUNET_FS_Handle *h,
+ struct GNUNET_FS_Uri *ksk_uri,
struct GNUNET_FS_Namespace *namespace,
const struct GNUNET_CONTAINER_MetaData *meta,
uint32_t anonymity,
uint32_t priority,
struct GNUNET_TIME_Absolute expiration,
- const struct GNUNET_FS_Uri *advertisementURI,
- const char *rootEntry);
+ const char *rootEntry,
+ GNUNET_FS_PublishContinuation cont,
+ void *cont_cls);
/**
void *ip_cls);
+/**
+ * Options for searching. Compatible options
+ * can be OR'ed together.
+ */
+enum GNUNET_FS_SearchOptions
+ {
+ /**
+ * No options (use defaults for everything).
+ */
+ GNUNET_FS_SEARCH_OPTION_NONE = 0,
+
+ /**
+ * Only search the local host, do not search remote systems (no P2P)
+ */
+ GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY = 1
+
+ };
+
+
/**
* Start search for content.
*
* @param uri specifies the search parameters; can be
* a KSK URI or an SKS URI.
* @param anonymity desired level of anonymity
+ * @param options options for the search
+ * @param cctx initial value for the client context
* @return context that can be used to control the search
*/
-// FIXME: add a "void *" context for the client to arguments!?
struct GNUNET_FS_SearchContext *
GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
const struct GNUNET_FS_Uri *uri,
- uint32_t anonymity);
+ uint32_t anonymity,
+ enum GNUNET_FS_SearchOptions options,
+ void *cctx);
/**
* 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)
+ */
+ GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY = 1,
/**
* Do a recursive download (that is, automatically trigger the
* download of files in directories).
*/
- GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE = 1,
+ GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE = 2,
/**
* Do not append temporary data to
* the target file (for the IBlocks).
*/
- GNUNET_FS_DOWNLOAD_NO_TEMPORARIES = 2
+ 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!
+ */
+ GNUNET_FS_DOWNLOAD_IS_PROBE = (1<<31)
};
* @param meta known metadata for the file (can be NULL)
* @param filename where to store the file, maybe NULL (then no file is
* created on disk and data must be grabbed from the callbacks)
+ * @param tempname where to store temporary file data, not used if filename is non-NULL;
+ * can be NULL (in which case we will pick a name if needed); the temporary file
+ * may already exist, in which case we will try to use the data that is there and
+ * if it is not what is desired, will overwrite it
* @param offset at what offset should we start the download (typically 0)
* @param length how many bytes should be downloaded starting at offset
* @param anonymity anonymity level to use for the download
const struct GNUNET_FS_Uri *uri,
const struct GNUNET_CONTAINER_MetaData *meta,
const char *filename,
+ const char *tempname,
uint64_t offset,
uint64_t length,
uint32_t anonymity,
/**
- * Stop a download (aborts if download is incomplete).
- *
- * @param dc handle for the download
- * @param do_delete delete files of incomplete downloads
- */
-void
-GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc,
- int do_delete);
-
-
-/**
- * Initialize collection.
- *
- * @param h handle to the file sharing subsystem
- * @param namespace namespace to use for the collection
- * @return GNUNET_OK on success, GNUNET_SYSERR if another
- * namespace is already set for our collection
- */
-int
-GNUNET_FS_collection_start (struct GNUNET_FS_Handle *h,
- struct GNUNET_FS_Namespace *namespace);
-
-
-/**
- * Stop collection.
+ * Download parts of a file based on a search result. The download
+ * will be associated with the search result (and the association
+ * will be preserved when serializing/deserializing the state).
+ * If the search is stopped, the download will not be aborted but
+ * be 'promoted' to a stand-alone download.
*
- * @param h handle to the file sharing subsystem
- * @return GNUNET_OK on success, GNUNET_SYSERR if no collection is active
- */
-int
-GNUNET_FS_collection_stop (struct GNUNET_FS_Handle *h);
-
-
-/**
- * Are we using a collection?
+ * As with the other download function, this will store
+ * the blocks at the respective offset in the given file. Also, the
+ * 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>
*
- * @param h handle to the file sharing subsystem
- * @return NULL if there is no collection,
- */
-struct GNUNET_FS_Namespace *
-GNUNET_FS_collection_get(struct GNUNET_FS_Handle *h);
-
-
-/**
- * Publish an update of the current collection information to the
- * network now. The function has no effect if the collection has not
- * changed since the last publication. If we are currently not
- * collecting, this function does nothing.
+ * The given range can be used to focus a download towards a
+ * particular portion of the file (optimization), not to strictly
+ * limit the download to exactly those bytes.
*
* @param h handle to the file sharing subsystem
+ * @param sr the search result to use for the download (determines uri and
+ * meta data and associations)
+ * @param filename where to store the file, maybe NULL (then no file is
+ * created on disk and data must be grabbed from the callbacks)
+ * @param tempname where to store temporary file data, not used if filename is non-NULL;
+ * can be NULL (in which case we will pick a name if needed); the temporary file
+ * may already exist, in which case we will try to use the data that is there and
+ * if it is not what is desired, will overwrite it
+ * @param offset at what offset should we start the download (typically 0)
+ * @param length how many bytes should be downloaded starting at offset
+ * @param anonymity anonymity level to use for the download
+ * @param options various download options
+ * @param cctx initial value for the client context for this download
+ * @return context that can be used to control this download
*/
-void GNUNET_FS_collection_publish (struct GNUNET_FS_Handle *h);
+struct GNUNET_FS_DownloadContext *
+GNUNET_FS_download_start_from_search (struct GNUNET_FS_Handle *h,
+ struct GNUNET_FS_SearchResult *sr,
+ const char *filename,
+ const char *tempname,
+ uint64_t offset,
+ uint64_t length,
+ uint32_t anonymity,
+ enum GNUNET_FS_DownloadOptions options,
+ void *cctx);
/**
- * If we are currently building a collection, publish the given file
- * information in that collection. If we are currently not
- * collecting, this function does nothing.
+ * Stop a download (aborts if download is incomplete).
*
- * @param h handle to the file sharing subsystem
- * @param uri uri to add to the collection
- * @param meta metadata for the uri
+ * @param dc handle for the download
+ * @param do_delete delete files of incomplete downloads
*/
-void GNUNET_FS_collection_add (const struct GNUNET_FS_Handle *h,
- const struct GNUNET_FS_Uri *uri,
- const struct GNUNET_CONTAINER_MetaData *meta);
-
-
+void
+GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc,
+ int do_delete);
GNUNET_FS_meta_data_make_directory (struct GNUNET_CONTAINER_MetaData *md);
+/**
+ * Suggest a filename based on given metadata.
+ *
+ * @param md given meta data
+ * @return NULL if meta data is useless for suggesting a filename
+ */
+char *
+GNUNET_FS_meta_data_suggest_filename (const struct GNUNET_CONTAINER_MetaData *md);
+
+
/**
* Function used to process entries in a 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
*/
-void
+int
GNUNET_FS_directory_list_contents (size_t size,
const void *data,
uint64_t offset,
projects / oweals / gnunet.git / blobdiff