*/
/**
* @file include/gnunet_fs_service.h
- * @brief API for file-sharing via GNUnet
+ * @brief API for file-sharing via GNUnet
* @author Christian Grothoff
*/
#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.0.0: with support for OR in KSKs
* 6.1.x: with simplified namespace support
* 9.0.0: CPS-style integrated API
+ * 9.1.1: asynchronous directory scanning
*/
-#define GNUNET_FS_VERSION 0x00090000
+#define GNUNET_FS_VERSION 0x00090102
/* ******************** URI API *********************** */
*/
struct GNUNET_FS_Uri;
-
/**
* Iterator over keywords
*
* Convert keyword URI to a human readable format
* (i.e. the search query that was used in the first place)
*
- * @param uri ksk uri to convert to a string
+ * @param uri ksk uri to convert to a string
* @return string with the keywords
*/
char *
struct GNUNET_TIME_Absolute expiration_time);
-/**
- * Canonicalize keyword URI. Performs operations such
- * as decapitalization and removal of certain characters.
- * (useful for search).
- *
- * @param uri the URI to canonicalize
- * @return canonicalized version of the URI, NULL on error
- */
-struct GNUNET_FS_Uri *
-GNUNET_FS_uri_ksk_canonicalize (const struct GNUNET_FS_Uri *uri);
-
-
/**
* Merge the sets of keywords from two KSK URIs.
- * (useful for merging the canonicalized keywords with
- * the original keywords for sharing).
*
* @param u1 first uri
* @param u2 second uri
/**
- * Possible status codes used in the callback for the
+ * Possible status codes used in the callback for the
* various file-sharing operations. On each file (or search),
* the callback is guaranteed to be called once with "START"
* and once with STOPPED; calls with PROGRESS, ERROR or COMPLETED
* are optional and depend on the circumstances; parent operations
* will be STARTED before child-operations and STOPPED after
- * their respective child-operations. START and STOP signals
+ * their respective child-operations. START and STOP signals
* are typically generated either due to explicit client requests
* or because of suspend/resume operations.
*/
/**
* Notification that we have started to publish a file structure.
*/
- GNUNET_FS_STATUS_PUBLISH_START,
+ GNUNET_FS_STATUS_PUBLISH_START = 0,
/**
* Notification that we have resumed sharing a file structure.
*/
- GNUNET_FS_STATUS_PUBLISH_RESUME,
+ GNUNET_FS_STATUS_PUBLISH_RESUME = 1,
/**
* Notification that we have suspended sharing a file structure.
*/
- GNUNET_FS_STATUS_PUBLISH_SUSPEND,
+ GNUNET_FS_STATUS_PUBLISH_SUSPEND = 2,
/**
* Notification that we are making progress sharing a file structure.
*/
- GNUNET_FS_STATUS_PUBLISH_PROGRESS,
+ GNUNET_FS_STATUS_PUBLISH_PROGRESS = 3,
/**
* Notification that an error was encountered sharing a file structure.
* The application will continue to receive resume/suspend events for
* this structure until "GNUNET_FS_publish_stop" is called.
*/
- GNUNET_FS_STATUS_PUBLISH_ERROR,
+ GNUNET_FS_STATUS_PUBLISH_ERROR = 4,
/**
* Notification that we completed sharing a file structure.
* The application will continue to receive resume/suspend events for
* this structure until "GNUNET_FS_publish_stop" is called.
*/
- GNUNET_FS_STATUS_PUBLISH_COMPLETED,
+ GNUNET_FS_STATUS_PUBLISH_COMPLETED = 5,
/**
* Notification that we have stopped
* the process of uploading a file structure; no
* futher events will be generated for this action.
*/
- GNUNET_FS_STATUS_PUBLISH_STOPPED,
+ GNUNET_FS_STATUS_PUBLISH_STOPPED = 6,
/**
* Notification that we have started this download.
*/
- GNUNET_FS_STATUS_DOWNLOAD_START,
+ GNUNET_FS_STATUS_DOWNLOAD_START = 7,
/**
* Notification that this download is being resumed.
*/
- GNUNET_FS_STATUS_DOWNLOAD_RESUME,
+ GNUNET_FS_STATUS_DOWNLOAD_RESUME = 8,
/**
* Notification that this download was suspended.
*/
- GNUNET_FS_STATUS_DOWNLOAD_SUSPEND,
+ GNUNET_FS_STATUS_DOWNLOAD_SUSPEND = 9,
/**
* Notification about progress with this download.
*/
- GNUNET_FS_STATUS_DOWNLOAD_PROGRESS,
+ GNUNET_FS_STATUS_DOWNLOAD_PROGRESS = 10,
/**
* Notification that this download encountered an error.
*/
- GNUNET_FS_STATUS_DOWNLOAD_ERROR,
+ GNUNET_FS_STATUS_DOWNLOAD_ERROR = 11,
/**
* Notification that this download completed. Note that for
* directories, completion does not imply completion of all files in
* the directory.
*/
- GNUNET_FS_STATUS_DOWNLOAD_COMPLETED,
+ GNUNET_FS_STATUS_DOWNLOAD_COMPLETED = 12,
/**
* Notification that this download was stopped
* (final event with respect to this action).
*/
- GNUNET_FS_STATUS_DOWNLOAD_STOPPED,
+ GNUNET_FS_STATUS_DOWNLOAD_STOPPED = 13,
/**
* Notification that this download is now actively being
* pursued (as opposed to waiting in the queue).
*/
- GNUNET_FS_STATUS_DOWNLOAD_ACTIVE,
+ GNUNET_FS_STATUS_DOWNLOAD_ACTIVE = 14,
/**
* Notification that this download is no longer actively
* being pursued (back in the queue).
*/
- GNUNET_FS_STATUS_DOWNLOAD_INACTIVE,
+ GNUNET_FS_STATUS_DOWNLOAD_INACTIVE = 15,
/**
* Notification that this download is no longer part of a
* download (and may thus need to be moved in the GUI
* into a different category).
*/
- GNUNET_FS_STATUS_DOWNLOAD_LOST_PARENT,
+ GNUNET_FS_STATUS_DOWNLOAD_LOST_PARENT = 16,
/**
- * First event generated when a client requests
+ * First event generated when a client requests
* a search to begin or when a namespace result
* automatically triggers the search for updates.
*/
- GNUNET_FS_STATUS_SEARCH_START,
+ GNUNET_FS_STATUS_SEARCH_START = 17,
/**
* Last event when a search is being resumed;
* note that "GNUNET_FS_SEARCH_START" will not
* be generated in this case.
*/
- GNUNET_FS_STATUS_SEARCH_RESUME,
+ GNUNET_FS_STATUS_SEARCH_RESUME = 18,
/**
* Event generated for each search result
* when the respective search is resumed.
*/
- GNUNET_FS_STATUS_SEARCH_RESUME_RESULT,
+ GNUNET_FS_STATUS_SEARCH_RESUME_RESULT = 19,
/**
* Last event when a search is being suspended;
* note that "GNUNET_FS_SEARCH_STOPPED" will not
* be generated in this case.
*/
- GNUNET_FS_STATUS_SEARCH_SUSPEND,
+ GNUNET_FS_STATUS_SEARCH_SUSPEND = 20,
/**
* This search has yielded a result.
*/
- GNUNET_FS_STATUS_SEARCH_RESULT,
+ GNUNET_FS_STATUS_SEARCH_RESULT = 21,
/**
* We have discovered a new namespace.
*/
- GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE,
+ GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE = 22,
/**
* We have additional data about the quality
* or availability of a search result.
*/
- GNUNET_FS_STATUS_SEARCH_UPDATE,
+ GNUNET_FS_STATUS_SEARCH_UPDATE = 23,
/**
* Signals a problem with this search.
*/
- GNUNET_FS_STATUS_SEARCH_ERROR,
+ GNUNET_FS_STATUS_SEARCH_ERROR = 24,
/**
* Signals that this search was paused.
*/
- GNUNET_FS_STATUS_SEARCH_PAUSED,
+ GNUNET_FS_STATUS_SEARCH_PAUSED = 25,
/**
* Signals that this search was continued (unpaused).
*/
- GNUNET_FS_STATUS_SEARCH_CONTINUED,
+ GNUNET_FS_STATUS_SEARCH_CONTINUED = 26,
/**
* Event generated for each search result
* when the respective search is stopped.
*/
- GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED,
+ GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED = 27,
/**
* Event generated for each search result
* when the respective search is suspended.
*/
- GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND,
+ GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND = 28,
/**
* Last message from a search; this signals
* that there will be no further events associated
* with this search.
*/
- GNUNET_FS_STATUS_SEARCH_STOPPED,
+ GNUNET_FS_STATUS_SEARCH_STOPPED = 29,
/**
* Notification that we started to unindex a file.
*/
- GNUNET_FS_STATUS_UNINDEX_START,
+ GNUNET_FS_STATUS_UNINDEX_START = 30,
/**
* Notification that we resumed unindexing of a file.
*/
- GNUNET_FS_STATUS_UNINDEX_RESUME,
+ GNUNET_FS_STATUS_UNINDEX_RESUME = 31,
/**
* Notification that we suspended unindexing a file.
*/
- GNUNET_FS_STATUS_UNINDEX_SUSPEND,
+ GNUNET_FS_STATUS_UNINDEX_SUSPEND = 32,
/**
* Notification that we made progress unindexing a file.
*/
- GNUNET_FS_STATUS_UNINDEX_PROGRESS,
+ GNUNET_FS_STATUS_UNINDEX_PROGRESS = 33,
/**
* Notification that we encountered an error unindexing
* a file.
*/
- GNUNET_FS_STATUS_UNINDEX_ERROR,
+ GNUNET_FS_STATUS_UNINDEX_ERROR = 34,
/**
* Notification that the unindexing of this file
* was completed.
*/
- GNUNET_FS_STATUS_UNINDEX_COMPLETED,
+ GNUNET_FS_STATUS_UNINDEX_COMPLETED = 35,
/**
* Notification that the unindexing of this file
* was stopped (final event for this action).
*/
- GNUNET_FS_STATUS_UNINDEX_STOPPED
+ GNUNET_FS_STATUS_UNINDEX_STOPPED = 36
};
/**
* How large is the file overall? For directories,
* this is only the size of the directory itself,
- * not of the other files contained within the
+ * not of the other files contained within the
* directory.
*/
uint64_t size;
uint64_t data_len;
/**
- * Depth of the given block in the tree;
+ * Depth of the given block in the tree;
* 0 would be the lowest level (DBLOCKs).
*/
unsigned int depth;
/**
* Client context pointer for the associated search operation
* (specifically, context pointer for the specific search
- * result, not the overall search); only set if this
+ * result, not the overall search); only set if this
* download was started from a search result.
*/
void *sctx;
uint64_t data_len;
/**
- * Depth of the given block in the tree;
+ * Depth of the given block in the tree;
* 0 would be the lowest level (DBLOCKS).
*/
unsigned int depth;
+ /**
+ * How much trust did we offer for downloading this block?
+ */
+ unsigned int trust_offered;
+
+ /**
+ * How much time passed between us asking for this block and
+ * actually getting it? GNUNET_TIME_UNIT_FOREVER_REL if unknown.
+ */
+ struct GNUNET_TIME_Relative block_download_duration;
+
} progress;
/**
* These values are only valid for
* GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND events.
* These events are automatically triggered for
- * each search result before the
+ * each search result before the
* 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.
* These events are automatically triggered for
- * each search result before the
+ * each search result before the
* GNUNET_FS_STATUS_SEARCH_STOPPED event. This
* happens primarily to give the client a chance
* to clean up the "cctx" (if needed).
uint64_t data_len;
/**
- * Depth of the given block in the tree;
+ * Depth of the given block in the tree;
* 0 would be the lowest level (DBLOCKS).
*/
unsigned int depth;
/**
- * Notification of FS to a client about the progress of an
+ * Notification of FS to a client about the progress of an
* operation. Callbacks of this type will be used for uploads,
- * downloads and searches. Some of the arguments depend a bit
+ * downloads and searches. Some of the arguments depend a bit
* in their meaning on the context in which the callback is used.
*
* @param cls closure
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.
*/
* Setup a connection to the file-sharing service.
*
* @param cfg configuration to use
- * @param client_name unique identifier for this client
+ * @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 flags specific attributes for fs-operations
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.
*
GNUNET_FS_file_information_get_id (struct GNUNET_FS_FileInformation *s);
+/**
+ * Obtain the filename from the file information structure.
+ *
+ * @param s structure to get the filename for
+ * @return "filename" field of the structure (can be NULL)
+ */
+const char *
+GNUNET_FS_file_information_get_filename (struct GNUNET_FS_FileInformation *s);
+
+
+/**
+ * Set the filename in the file information structure.
+ * If filename was already set, frees it before setting the new one.
+ * Makes a copy of the argument.
+ *
+ * @param s structure to get the filename for
+ * @param filename filename to set
+ */
+void
+GNUNET_FS_file_information_set_filename (struct GNUNET_FS_FileInformation *s,
+ const char *filename);
+
/**
* Create an entry for a file in a publish-structure.
* @param cls closure
* @param offset offset to read from; it is possible
* that the caller might need to go backwards
- * a bit at times
- * @param max maximum number of bytes that should be
+ * a bit at times; set to UINT64_MAX to tell
+ * the reader that we won't be reading for a while
+ * (used to close the file descriptor but NOT fully
+ * clean up the reader's state); in this case,
+ * a value of '0' for max should be ignored
+ * @param max maximum number of bytes that should be
* copied to buf; readers are not allowed
* to provide less data unless there is an error;
* a value of "0" will be used at the end to allow
* @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 function that can be used to obtain the data for the file
* @param reader_cls closure for "reader"
* @param keywords under which keywords should this file be available
* directly; can be NULL
GNUNET_FS_BlockOptions *bo);
-/**
- * Function that a "GNUNET_FS_DirectoryScanner" should call
- * for each entry in the directory.
- *
- * @param cls closure
- * @param filename name of the file (including path); must end
- * in a "/" (even on W32) if this is a directory
- * @param fi information about the file (should not be
- * used henceforth by the caller)
- */
-typedef void (*GNUNET_FS_FileProcessor) (void *cls, const char *filename,
- struct GNUNET_FS_FileInformation * fi);
-
-
-/**
- * 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 bo block options
- * @param proc function to call on each entry
- * @param proc_cls closure for proc
- * @param emsg where to store an error message (on errors)
- * @return GNUNET_OK on success
- */
-typedef int (*GNUNET_FS_DirectoryScanner) (void *cls,
- struct GNUNET_FS_Handle * h,
- const char *dirname, int do_index,
- const struct GNUNET_FS_BlockOptions *
- bo, GNUNET_FS_FileProcessor proc,
- void *proc_cls, char **emsg);
-
-
-
-/**
- * Simple, useful default implementation of a directory scanner
- * (GNUNET_FS_DirectoryScanner). This implementation expects to get a
- * UNIX filename, will publish all files in the directory except hidden
- * files (those starting with a "."). Metadata will be extracted
- * using GNU libextractor; the specific list of plugins should be
- * specified in "cls", passing NULL will disable (!) metadata
- * extraction. Keywords will be derived from the metadata and be
- * subject to default canonicalization. This is strictly a
- * 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 bo block options
- * @param proc function called on each entry
- * @param proc_cls closure for proc
- * @param emsg where to store an error message (on errors)
- * @return GNUNET_OK on success
- */
-int
-GNUNET_FS_directory_scanner_default (void *cls, struct GNUNET_FS_Handle *h,
- const char *dirname, int do_index,
- const struct GNUNET_FS_BlockOptions *bo,
- GNUNET_FS_FileProcessor proc,
- void *proc_cls, char **emsg);
-
-
-/**
- * Create a publish-structure from an existing file hierarchy, inferring
- * and organizing keywords and metadata as much as possible. This
- * function primarily performs the recursive build and re-organizes
- * keywords and metadata; for automatically getting metadata
- * extraction, scanning of directories and creation of the respective
- * GNUNET_FS_FileInformation entries the default scanner should be
- * 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
- * @param do_index should files in the hierarchy be indexed?
- * @param bo block options
- * @param emsg where to store an error message
- * @return publish structure entry for the directory, NULL on error
- */
-struct GNUNET_FS_FileInformation *
-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,
- int do_index,
- const struct
- GNUNET_FS_BlockOptions *bo,
- char **emsg);
-
-
/**
* Create an entry for an empty directory in a publish-structure.
* This function should be used by applications for which the
* directly; can be NULL
* @param meta metadata for the directory
* @param bo block options
+ * @param filename name of the directory; can be NULL
* @return publish structure entry for the directory , NULL on error
*/
struct GNUNET_FS_FileInformation *
GNUNET_CONTAINER_MetaData
*meta,
const struct
- GNUNET_FS_BlockOptions *bo);
+ GNUNET_FS_BlockOptions *bo,
+ const char *filename);
/**
*
* @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
+ * 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
*/
* @param namespace namespace to publish the file in, NULL for no namespace
* @param nid identifier to use for the publishd content in the namespace
* (can be NULL, must be NULL if namespace is NULL)
- * @param nuid update-identifier that will be used for future updates
+ * @param nuid update-identifier that will be used for future updates
* (can be NULL, must be NULL if namespace or nid is NULL)
- * @param options options for the publication
+ * @param options options for the publication
* @return context that can be used to control the publish operation
*/
struct GNUNET_FS_PublishContext *
/**
- * Stop a publication. Will abort incomplete publications (but
+ * 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!
const char *emsg);
+/**
+ * Handle to cancel publish KSK operation.
+ */
+struct GNUNET_FS_PublishKskContext;
+
+
/**
* Publish a KBlock on GNUnet.
*
* @param options publication options
* @param cont continuation
* @param cont_cls closure for cont
+ * @return NULL on error ('cont' will still be called)
*/
-void
+struct GNUNET_FS_PublishKskContext *
GNUNET_FS_publish_ksk (struct GNUNET_FS_Handle *h,
const struct GNUNET_FS_Uri *ksk_uri,
const struct GNUNET_CONTAINER_MetaData *meta,
GNUNET_FS_PublishContinuation cont, void *cont_cls);
+/**
+ * Abort the KSK publishing operation.
+ *
+ * @param pkc context of the operation to abort.
+ */
+void
+GNUNET_FS_publish_ksk_cancel (struct GNUNET_FS_PublishKskContext *pkc);
+
+
+/**
+ * Handle to cancel publish SKS operation.
+ */
+struct GNUNET_FS_PublishSksContext;
+
+
/**
* Publish an SBlock on GNUnet.
*
* @param options publication options
* @param cont continuation
* @param cont_cls closure for cont
+ * @return NULL on error ('cont' will still be called)
*/
-void
+struct GNUNET_FS_PublishSksContext *
GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
struct GNUNET_FS_Namespace *namespace,
const char *identifier, const char *update,
GNUNET_FS_PublishContinuation cont, void *cont_cls);
+/**
+ * Abort the SKS publishing operation.
+ *
+ * @param psc context of the operation to abort.
+ */
+void
+GNUNET_FS_publish_sks_cancel (struct GNUNET_FS_PublishSksContext *psc);
+
+
/**
* Type of a function called by "GNUNET_FS_get_indexed_files".
*
* @param cls closure
- * @param filename the name of the file
+ * @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
*/
const GNUNET_HashCode * file_id);
+/**
+ * Handle to cancel 'GNUNET_FS_get_indexed_files'.
+ */
+struct GNUNET_FS_GetIndexedContext;
+
+
/**
* Iterate over all indexed files.
*
* @param h handle to the file sharing subsystem
* @param iterator function to call on each indexed file
* @param iterator_cls closure for iterator
- * @param cont continuation to call when done;
- * reason should be "TIMEOUT" (on
- * error) or "PREREQ_DONE" (on success)
- * @param cont_cls closure for cont
+ * @return NULL on error ('iter' is not called)
*/
-void
+struct GNUNET_FS_GetIndexedContext *
GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
GNUNET_FS_IndexedFileProcessor iterator,
- void *iterator_cls, GNUNET_SCHEDULER_Task cont,
- void *cont_cls);
+ void *iterator_cls);
+
+
+/**
+ * Cancel iteration over all indexed files.
+ *
+ * @param gic operation to cancel
+ */
+void
+GNUNET_FS_get_indexed_files_cancel (struct GNUNET_FS_GetIndexedContext *gic);
/**
* @param h handle to the file sharing subsystem
* @param filename file to unindex
* @param cctx initial value for the client context
- * @return NULL on error, otherwise handle
+ * @return NULL on error, otherwise handle
*/
struct GNUNET_FS_UnindexContext *
GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h, const char *filename,
/**
- * Publish an advertismement for a namespace.
+ * 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 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)
*/
-void
+struct GNUNET_FS_AdvertisementContext *
GNUNET_FS_namespace_advertise (struct GNUNET_FS_Handle *h,
struct GNUNET_FS_Uri *ksk_uri,
struct GNUNET_FS_Namespace *namespace,
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.
GNUNET_FS_namespace_create (struct GNUNET_FS_Handle *h, const char *name);
+/**
+ * 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);
+
+
/**
* Delete a namespace handle. Can be used for a clean shutdown (free
* memory) or also to freeze the namespace to prevent further
* Function called on updateable identifiers.
*
* @param cls closure
- * @param last_id last identifier
+ * @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 next_id identifier that should be used for updates
* produce an update. Namespace updates form a graph where each node
* 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
* 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
* that cycles within an SCC are possible (including self-loops).
/**
- * Pause search.
+ * Pause search.
*
* @param sc context for the search that should be paused
*/
/**
* Set the MIMETYPE information for the given
* metadata to "application/gnunet-directory".
- *
+ *
* @param md metadata to add mimetype to
*/
void
/**
* Suggest a filename based on given metadata.
- *
+ *
* @param md given meta data
* @return NULL if meta data is useless for suggesting a filename
*/
/**
* Create a directory builder.
- *
+ *
* @param mdir metadata for the directory
*/
struct GNUNET_FS_DirectoryBuilder *
/**
* Add an entry to a directory.
- *
+ *
* @param bld directory to extend
* @param uri uri of the entry (must not be a KSK)
* @param md metadata of the entry
size_t * rsize, void **rdata);
+/* ******************** DirScanner API *********************** */
+
+/**
+ * Progress reasons of the directory scanner.
+ */
+enum GNUNET_FS_DirScannerProgressUpdateReason
+{
+
+ /**
+ * We've started processing a file or directory.
+ */
+ GNUNET_FS_DIRSCANNER_FILE_START = 0,
+
+ /**
+ * We're having trouble accessing a file (soft-error); it will
+ * be ignored.
+ */
+ GNUNET_FS_DIRSCANNER_FILE_IGNORED,
+
+ /**
+ * We've found all files (in the pre-pass).
+ */
+ GNUNET_FS_DIRSCANNER_ALL_COUNTED,
+
+ /**
+ * We've finished extracting meta data from a file.
+ */
+ GNUNET_FS_DIRSCANNER_EXTRACT_FINISHED,
+
+ /**
+ * Last call to the progress function: we have finished scanning
+ * the directory.
+ */
+ GNUNET_FS_DIRSCANNER_FINISHED,
+
+ /**
+ * There was an internal error. Application should abort the scan.
+ */
+ GNUNET_FS_DIRSCANNER_INTERNAL_ERROR
+
+};
+
+
+/**
+ * Function called over time as the directory scanner makes
+ * progress on the job at hand.
+ *
+ * @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 reason kind of progress we are making
+ */
+typedef void (*GNUNET_FS_DirScannerProgressCallback) (void *cls,
+ const char *filename,
+ int is_directory,
+ enum GNUNET_FS_DirScannerProgressUpdateReason reason);
+
+
+/**
+ * A node of a directory tree (produced by dirscanner)
+ */
+struct GNUNET_FS_ShareTreeItem
+{
+ /**
+ * This is a doubly-linked list
+ */
+ struct GNUNET_FS_ShareTreeItem *prev;
+
+ /**
+ * This is a doubly-linked list
+ */
+ struct GNUNET_FS_ShareTreeItem *next;
+
+ /**
+ * This is a doubly-linked tree
+ * NULL for top-level entries.
+ */
+ struct GNUNET_FS_ShareTreeItem *parent;
+
+ /**
+ * This is a doubly-linked tree
+ * NULL for files and empty directories
+ */
+ struct GNUNET_FS_ShareTreeItem *children_head;
+
+ /**
+ * This is a doubly-linked tree
+ * NULL for files and empty directories
+ */
+ struct GNUNET_FS_ShareTreeItem *children_tail;
+
+ /**
+ * Metadata for this file or directory
+ */
+ struct GNUNET_CONTAINER_MetaData *meta;
+
+ /**
+ * Keywords for this file or directory (derived from metadata).
+ */
+ struct GNUNET_FS_Uri *ksk_uri;
+
+ /**
+ * Name of the file/directory
+ */
+ char *filename;
+
+ /**
+ * Base name of the file/directory.
+ */
+ char *short_filename;
+
+ /**
+ * GNUNET_YES if this is a directory
+ */
+ int is_directory;
+
+};
+
+
+/**
+ * Opaqe 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 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'
+ * @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,
+ const char *ex,
+ GNUNET_FS_DirScannerProgressCallback cb,
+ void *cb_cls);
+
+
+/**
+ * Abort the scan. Must not be called from within the progress_callback
+ * function.
+ *
+ * @param ds directory scanner structure
+ */
+void
+GNUNET_FS_directory_scan_abort (struct GNUNET_FS_DirScanner *ds);
+
+
+/**
+ * Obtain the result of the scan after the scan has signalled
+ * completion. Must not be called prior to completion. The 'ds' is
+ * freed as part of this call.
+ *
+ * @param ds directory scanner structure
+ * @return the results of the scan (a directory tree)
+ */
+struct GNUNET_FS_ShareTreeItem *
+GNUNET_FS_directory_scan_get_result (struct GNUNET_FS_DirScanner *ds);
+
+
+/**
+ * Process a share item tree, moving frequent keywords up and
+ * copying frequent metadata up.
+ *
+ * @param toplevel toplevel directory in the tree, returned by the scanner
+ */
+void
+GNUNET_FS_share_tree_trim (struct GNUNET_FS_ShareTreeItem *toplevel);
+
+
+/**
+ * Release memory of a share item tree.
+ *
+ * @param toplevel toplevel of the tree to be freed
+ */
+void
+GNUNET_FS_share_tree_free (struct GNUNET_FS_ShareTreeItem *toplevel);
+
+
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif