src/include/gnunet_fs_service.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @file include/gnunet_fs_service.h
  22  * @brief API for file-sharing via GNUnet
  23  * @author Christian Grothoff
  24  */
  25 #ifndef GNUNET_FS_LIB_H
  26 #define GNUNET_FS_LIB_H
  27
  28 #include "gnunet_util_lib.h"
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38 /**
  39  * Version number of the implementation.
  40  * History:
  41  *
  42  * 1.x.x: initial version with triple GNUNET_hash and merkle tree
  43  * 2.x.x: root node with mime-type, filename and version number
  44  * 2.1.x: combined GNUNET_EC_ContentHashKey/3HASH encoding with 25:1 super-nodes
  45  * 2.2.x: with directories
  46  * 3.0.x: with namespaces
  47  * 3.1.x: with namespace meta-data
  48  * 3.2.x: with collections
  49  * 4.0.x: with expiration, variable meta-data, kblocks
  50  * 4.1.x: with new error and configuration handling
  51  * 5.0.x: with location URIs
  52  * 6.0.0: with support for OR in KSKs
  53  * 6.1.x: with simplified namespace support
  54  * 9.0.0: CPS-style integrated API
  55  */
  56 #define GNUNET_FS_VERSION 0x00090000
  57
  58
  59 /* ******************** URI API *********************** */
  60
  61 #define GNUNET_FS_URI_PREFIX "gnunet://fs/"
  62 #define GNUNET_FS_URI_KSK_INFIX "ksk/"
  63 #define GNUNET_FS_URI_SKS_INFIX "sks/"
  64 #define GNUNET_FS_URI_CHK_INFIX "chk/"
  65 #define GNUNET_FS_URI_LOC_INFIX "loc/"
  66
  67
  68 /**
  69  * A Universal Resource Identifier (URI), opaque.
  70  */
  71 struct GNUNET_FS_Uri;
  72
  73
  74 /**
  75  * Iterator over keywords
  76  *
  77  * @param cls closure
  78  * @param keyword the keyword
  79  * @param is_mandatory is the keyword mandatory (in a search)
  80  * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
  81  */
  82 typedef int (*GNUNET_FS_KeywordIterator) (void *cls,
  83                                           const char *keyword,
  84                                           int is_mandatory);
  85
  86 /**
  87  * Get a unique key from a URI.  This is for putting URIs
  88  * into HashMaps.  The key may change between FS implementations.
  89  *
  90  * @param uri uri to convert to a unique key
  91  * @param key wherer to store the unique key
  92  */
  93 void
  94 GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri,
  95                       GNUNET_HashCode * key);
  96
  97 /**
  98  * Convert a URI to a UTF-8 String.
  99  *
 100  * @param uri uri to convert to a string
 101  * @return the UTF-8 string
 102  */
 103 char *
 104 GNUNET_FS_uri_to_string (const struct GNUNET_FS_Uri *uri);
 105
 106 /**
 107  * Convert keyword URI to a human readable format
 108  * (i.e. the search query that was used in the first place)
 109  *
 110  * @param uri ksk uri to convert to a string
 111  * @return string with the keywords
 112  */
 113 char *
 114 GNUNET_FS_uri_ksk_to_string_fancy (const struct GNUNET_FS_Uri *uri);
 115
 116
 117 /**
 118  * Convert a UTF-8 String to a URI.
 119  *
 120  * @param uri string to parse
 121  * @param emsg where to store the parser error message (if any)
 122  * @return NULL on error
 123  */
 124 struct GNUNET_FS_Uri *
 125 GNUNET_FS_uri_parse (const char *uri,
 126                      char **emsg);
 127
 128 /**
 129  * Free URI.
 130  *
 131  * @param uri uri to free
 132  */
 133 void
 134 GNUNET_FS_uri_destroy (struct GNUNET_FS_Uri *uri);
 135
 136
 137 /**
 138  * How many keywords are ANDed in this keyword URI?
 139  *
 140  * @param uri ksk uri to get the number of keywords from
 141  * @return 0 if this is not a keyword URI
 142  */
 143 unsigned int
 144 GNUNET_FS_uri_ksk_get_keyword_count (const struct GNUNET_FS_Uri *uri);
 145
 146
 147 /**
 148  * Iterate over all keywords in this keyword URI.
 149  *
 150  * @param uri ksk uri to get the keywords from
 151  * @param iterator function to call on each keyword
 152  * @param iterator_cls closure for iterator
 153  * @return -1 if this is not a keyword URI, otherwise number of
 154  *   keywords iterated over until iterator aborted
 155  */
 156 int
 157 GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
 158                                 GNUNET_FS_KeywordIterator iterator,
 159                                 void *iterator_cls);
 160
 161
 162 /**
 163  * Obtain the identity of the peer offering the data
 164  *
 165  * @param uri the location URI to inspect
 166  * @param peer where to store the identify of the peer (presumably) offering the content
 167  * @return GNUNET_SYSERR if this is not a location URI, otherwise GNUNET_OK
 168  */
 169 int
 170 GNUNET_FS_uri_loc_get_peer_identity (const struct GNUNET_FS_Uri *uri,
 171                                      struct GNUNET_PeerIdentity * peer);
 172
 173
 174 /**
 175  * Obtain the URI of the content itself.
 176  *
 177  * @param uri location URI to get the content URI from
 178  * @return NULL if argument is not a location URI
 179  */
 180 struct GNUNET_FS_Uri *
 181 GNUNET_FS_uri_loc_get_uri (const struct GNUNET_FS_Uri *uri);
 182
 183
 184 /**
 185  * Obtain the expiration of the LOC URI.
 186  *
 187  * @param uri location URI to get the expiration from
 188  * @return expiration time of the URI
 189  */
 190 struct GNUNET_TIME_Absolute
 191 GNUNET_FS_uri_loc_get_expiration (const struct GNUNET_FS_Uri *uri);
 192
 193
 194 /**
 195  * Construct a location URI (this peer will be used for the location).
 196  *
 197  * @param baseUri content offered by the sender
 198  * @param cfg configuration information (used to find our hostkey)
 199  * @param expiration_time how long will the content be offered?
 200  * @return the location URI, NULL on error
 201  */
 202 struct GNUNET_FS_Uri *
 203 GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *baseUri,
 204                           struct GNUNET_CONFIGURATION_Handle *cfg,
 205                           struct GNUNET_TIME_Absolute expiration_time);
 206
 207
 208 /**
 209  * Canonicalize keyword URI.  Performs operations such
 210  * as decapitalization and removal of certain characters.
 211  * (useful for search).
 212  *
 213  * @param uri the URI to canonicalize
 214  * @return canonicalized version of the URI, NULL on error
 215  */
 216 struct GNUNET_FS_Uri *
 217 GNUNET_FS_uri_ksk_canonicalize (const struct GNUNET_FS_Uri *uri);
 218
 219
 220 /**
 221  * Merge the sets of keywords from two KSK URIs.
 222  * (useful for merging the canonicalized keywords with
 223  * the original keywords for sharing).
 224  *
 225  * @param u1 first uri
 226  * @param u2 second uri
 227  * @return merged URI, NULL on error
 228  */
 229 struct GNUNET_FS_Uri *
 230 GNUNET_FS_uri_ksk_merge (const struct GNUNET_FS_Uri *u1,
 231                          const struct GNUNET_FS_Uri *u2);
 232
 233
 234 /**
 235  * Duplicate URI.
 236  *
 237  * @param uri the URI to duplicate
 238  * @return copy of the URI
 239  */
 240 struct GNUNET_FS_Uri *
 241 GNUNET_FS_uri_dup (const struct GNUNET_FS_Uri *uri);
 242
 243
 244 /**
 245  * Create an FS URI from a single user-supplied string of keywords.
 246  * The string is broken up at spaces into individual keywords.
 247  * Keywords that start with "+" are mandatory.  Double-quotes can
 248  * be used to prevent breaking up strings at spaces (and also
 249  * to specify non-mandatory keywords starting with "+").
 250  *
 251  * Keywords must contain a balanced number of double quotes and
 252  * double quotes can not be used in the actual keywords (for
 253  * example, the string '""foo bar""' will be turned into two
 254  * "OR"ed keywords 'foo' and 'bar', not into '"foo bar"'.
 255  *
 256  * @param keywords the keyword string
 257  * @param emsg where to store an error message
 258  * @return an FS URI for the given keywords, NULL
 259  *  if keywords is not legal (i.e. empty).
 260  */
 261 struct GNUNET_FS_Uri *
 262 GNUNET_FS_uri_ksk_create (const char *keywords,
 263                           char **emsg);
 264
 265
 266 /**
 267  * Create an FS URI from a user-supplied command line of keywords.
 268  * Arguments should start with "+" to indicate mandatory
 269  * keywords.
 270  *
 271  * @param argc number of keywords
 272  * @param argv keywords (double quotes are not required for
 273  *             keywords containing spaces; however, double
 274  *             quotes are required for keywords starting with
 275  *             "+"); there is no mechanism for having double
 276  *             quotes in the actual keywords (if the user
 277  *             did specifically specify double quotes, the
 278  *             caller should convert each double quote
 279  *             into two single quotes).
 280  * @return an FS URI for the given keywords, NULL
 281  *  if keywords is not legal (i.e. empty).
 282  */
 283 struct GNUNET_FS_Uri *
 284 GNUNET_FS_uri_ksk_create_from_args (unsigned int argc,
 285                                     const char **argv);
 286
 287
 288 /**
 289  * Test if two URIs are equal.
 290  *
 291  * @param u1 one of the URIs
 292  * @param u2 the other URI
 293  * @return GNUNET_YES if the URIs are equal
 294  */
 295 int
 296 GNUNET_FS_uri_test_equal (const struct GNUNET_FS_Uri *u1,
 297                           const struct GNUNET_FS_Uri *u2);
 298
 299
 300 /**
 301  * Is this a namespace URI?
 302  *
 303  * @param uri the uri to check
 304  * @return GNUNET_YES if this is an SKS uri
 305  */
 306 int
 307 GNUNET_FS_uri_test_sks (const struct GNUNET_FS_Uri *uri);
 308
 309
 310 /**
 311  * Handle to one of our namespaces.
 312  */
 313 struct GNUNET_FS_Namespace;
 314
 315
 316 /**
 317  * Create an SKS URI from a namespace and an identifier.
 318  *
 319  * @param ns namespace
 320  * @param id identifier
 321  * @param emsg where to store an error message
 322  * @return an FS URI for the given namespace and identifier
 323  */
 324 struct GNUNET_FS_Uri *
 325 GNUNET_FS_uri_sks_create (struct GNUNET_FS_Namespace *ns,
 326                           const char *id,
 327                           char **emsg);
 328
 329
 330 /**
 331  * Get the ID of a namespace from the given
 332  * namespace URI.
 333  *
 334  * @param uri the uri to get the namespace ID from
 335  * @param nsid where to store the ID of the namespace
 336  * @return GNUNET_OK on success
 337  */
 338 int
 339 GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
 340                                  GNUNET_HashCode * nsid);
 341
 342
 343 /**
 344  * Get the content identifier of an SKS URI.
 345  *
 346  * @param uri the sks uri
 347  * @return NULL on error (not a valid SKS URI)
 348  */
 349 char *
 350 GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri);
 351
 352
 353 /**
 354  * Convert namespace URI to a human readable format
 355  * (using the namespace description, if available).
 356  *
 357  * @param cfg configuration to use
 358  * @param uri SKS uri to convert
 359  * @return NULL on error (not an SKS URI)
 360  */
 361 char *
 362 GNUNET_FS_uri_sks_to_string_fancy (struct GNUNET_CONFIGURATION_Handle *cfg,
 363                                    const struct GNUNET_FS_Uri *uri);
 364
 365
 366 /**
 367  * Is this a keyword URI?
 368  *
 369  * @param uri the uri
 370  * @return GNUNET_YES if this is a KSK uri
 371  */
 372 int
 373 GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri);
 374
 375
 376 /**
 377  * Is this a file (or directory) URI?
 378  *
 379  * @param uri the uri to check
 380  * @return GNUNET_YES if this is a CHK uri
 381  */
 382 int
 383 GNUNET_FS_uri_test_chk (const struct GNUNET_FS_Uri *uri);
 384
 385
 386 /**
 387  * What is the size of the file that this URI
 388  * refers to?
 389  *
 390  * @param uri the CHK (or LOC) URI to inspect
 391  * @return size of the file as specified in the CHK URI
 392  */
 393 uint64_t
 394 GNUNET_FS_uri_chk_get_file_size (const struct GNUNET_FS_Uri *uri);
 395
 396
 397 /**
 398  * Is this a location URI?
 399  *
 400  * @param uri the uri to check
 401  * @return GNUNET_YES if this is a LOC uri
 402  */
 403 int
 404 GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri);
 405
 406
 407 /**
 408  * Construct a keyword-URI from meta-data (take all entries
 409  * in the meta-data and construct one large keyword URI
 410  * that lists all keywords that can be found in the meta-data).
 411  *
 412  * @param md metadata to use
 413  * @return NULL on error, otherwise a KSK URI
 414  */
 415 struct GNUNET_FS_Uri *
 416 GNUNET_FS_uri_ksk_create_from_meta_data (const struct GNUNET_CONTAINER_MetaData *md);
 417
 418
 419 /* ******************** command-line option parsing API *********************** */
 420
 421 /**
 422  * Command-line option parser function that allows the user
 423  * to specify one or more '-k' options with keywords.  Each
 424  * specified keyword will be added to the URI.  A pointer to
 425  * the URI must be passed as the "scls" argument.
 426  *
 427  * @param ctx command line processor context
 428  * @param scls must be of type "struct GNUNET_FS_Uri **"
 429  * @param option name of the option (typically 'k')
 430  * @param value command line argument given
 431  * @return GNUNET_OK on success
 432  */
 433 int
 434 GNUNET_FS_getopt_set_keywords (struct GNUNET_GETOPT_CommandLineProcessorContext* ctx,
 435                                          void *scls,
 436                                          const char *option,
 437                                          const char *value);
 438
 439
 440 /**
 441  * Command-line option parser function that allows the user to specify
 442  * one or more '-m' options with metadata.  Each specified entry of
 443  * the form "type=value" will be added to the metadata.  A pointer to
 444  * the metadata must be passed as the "scls" argument.
 445  *
 446  * @param ctx command line processor context
 447  * @param scls must be of type "struct GNUNET_CONTAINER_MetaData **"
 448  * @param option name of the option (typically 'k')
 449  * @param value command line argument given
 450  * @return GNUNET_OK on success
 451  */
 452 int
 453 GNUNET_FS_getopt_set_metadata (struct GNUNET_GETOPT_CommandLineProcessorContext* ctx,
 454                                void *scls,
 455                                const char *option,
 456                                const char *value);
 457
 458
 459
 460 /* ************************* sharing API ***************** */
 461
 462
 463 /**
 464  * Possible status codes used in the callback for the
 465  * various file-sharing operations.  On each file (or search),
 466  * the callback is guaranteed to be called once with "START"
 467  * and once with STOPPED; calls with PROGRESS, ERROR or COMPLETED
 468  * are optional and depend on the circumstances; parent operations
 469  * will be STARTED before child-operations and STOPPED after
 470  * their respective child-operations.  START and STOP signals
 471  * are typically generated either due to explicit client requests
 472  * or because of suspend/resume operations.
 473  */
 474 enum GNUNET_FS_Status
 475 {
 476   /**
 477    * Notification that we have started to publish a file structure.
 478    */
 479   GNUNET_FS_STATUS_PUBLISH_START,
 480
 481   /**
 482    * Notification that we have resumed sharing a file structure.
 483    */
 484   GNUNET_FS_STATUS_PUBLISH_RESUME,
 485
 486   /**
 487    * Notification that we have suspended sharing a file structure.
 488    */
 489   GNUNET_FS_STATUS_PUBLISH_SUSPEND,
 490
 491   /**
 492    * Notification that we are making progress sharing a file structure.
 493    */
 494   GNUNET_FS_STATUS_PUBLISH_PROGRESS,
 495
 496   /**
 497    * Notification that an error was encountered  sharing a file structure.
 498    * The application will continue to receive resume/suspend events for
 499    * this structure until "GNUNET_FS_publish_stop" is called.
 500    */
 501   GNUNET_FS_STATUS_PUBLISH_ERROR,
 502
 503   /**
 504    * Notification that we completed sharing a file structure.
 505    * The application will continue to receive resume/suspend events for
 506    * this structure until "GNUNET_FS_publish_stop" is called.
 507    */
 508   GNUNET_FS_STATUS_PUBLISH_COMPLETED,
 509
 510   /**
 511    * Notification that we have stopped
 512    * the process of uploading a file structure; no
 513    * futher events will be generated for this action.
 514    */
 515   GNUNET_FS_STATUS_PUBLISH_STOPPED,
 516
 517   /**
 518    * Notification that we have started this download.
 519    */
 520   GNUNET_FS_STATUS_DOWNLOAD_START,
 521
 522   /**
 523    * Notification that this download is being resumed.
 524    */
 525   GNUNET_FS_STATUS_DOWNLOAD_RESUME,
 526
 527   /**
 528    * Notification that this download was suspended.
 529    */
 530   GNUNET_FS_STATUS_DOWNLOAD_SUSPEND,
 531
 532   /**
 533    * Notification about progress with this download.
 534    */
 535   GNUNET_FS_STATUS_DOWNLOAD_PROGRESS,
 536
 537   /**
 538    * Notification that this download encountered an error.
 539    */
 540   GNUNET_FS_STATUS_DOWNLOAD_ERROR,
 541
 542   /**
 543    * Notification that this download completed.  Note that for
 544    * directories, completion does not imply completion of all files in
 545    * the directory.
 546    */
 547   GNUNET_FS_STATUS_DOWNLOAD_COMPLETED,
 548
 549   /**
 550    * Notification that this download was stopped
 551    * (final event with respect to this action).
 552    */
 553   GNUNET_FS_STATUS_DOWNLOAD_STOPPED,
 554
 555   /**
 556    * Notification that this download is now actively being
 557    * pursued (as opposed to waiting in the queue).
 558    */
 559   GNUNET_FS_STATUS_DOWNLOAD_ACTIVE,
 560
 561   /**
 562    * Notification that this download is no longer actively
 563    * being pursued (back in the queue).
 564    */
 565   GNUNET_FS_STATUS_DOWNLOAD_INACTIVE,
 566
 567   /**
 568    * Notification that this download is no longer part of a
 569    * recursive download or search but now a 'stand-alone'
 570    * download (and may thus need to be moved in the GUI
 571    * into a different category).
 572    */
 573   GNUNET_FS_STATUS_DOWNLOAD_LOST_PARENT,
 574
 575   /**
 576    * First event generated when a client requests
 577    * a search to begin or when a namespace result
 578    * automatically triggers the search for updates.
 579    */
 580   GNUNET_FS_STATUS_SEARCH_START,
 581
 582   /**
 583    * Last event when a search is being resumed;
 584    * note that "GNUNET_FS_SEARCH_START" will not
 585    * be generated in this case.
 586    */
 587   GNUNET_FS_STATUS_SEARCH_RESUME,
 588
 589   /**
 590    * Event generated for each search result
 591    * when the respective search is resumed.
 592    */
 593   GNUNET_FS_STATUS_SEARCH_RESUME_RESULT,
 594
 595   /**
 596    * Last event when a search is being suspended;
 597    * note that "GNUNET_FS_SEARCH_STOPPED" will not
 598    * be generated in this case.
 599    */
 600   GNUNET_FS_STATUS_SEARCH_SUSPEND,
 601
 602   /**
 603    * This search has yielded a result.
 604    */
 605   GNUNET_FS_STATUS_SEARCH_RESULT,
 606
 607   /**
 608    * We have discovered a new namespace.
 609    */
 610   GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE,
 611
 612   /**
 613    * We have additional data about the quality
 614    * or availability of a search result.
 615    */
 616   GNUNET_FS_STATUS_SEARCH_UPDATE,
 617
 618   /**
 619    * Signals a problem with this search.
 620    */
 621   GNUNET_FS_STATUS_SEARCH_ERROR,
 622
 623   /**
 624    * Signals that this search was paused.
 625    */
 626   GNUNET_FS_STATUS_SEARCH_PAUSED,
 627
 628   /**
 629    * Signals that this search was continued (unpaused).
 630    */
 631   GNUNET_FS_STATUS_SEARCH_CONTINUED,
 632
 633   /**
 634    * Event generated for each search result
 635    * when the respective search is stopped.
 636    */
 637   GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED,
 638
 639   /**
 640    * Event generated for each search result
 641    * when the respective search is suspended.
 642    */
 643   GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND,
 644
 645   /**
 646    * Last message from a search; this signals
 647    * that there will be no further events associated
 648    * with this search.
 649    */
 650   GNUNET_FS_STATUS_SEARCH_STOPPED,
 651
 652   /**
 653    * Notification that we started to unindex a file.
 654    */
 655   GNUNET_FS_STATUS_UNINDEX_START,
 656
 657   /**
 658    * Notification that we resumed unindexing of a file.
 659    */
 660   GNUNET_FS_STATUS_UNINDEX_RESUME,
 661
 662   /**
 663    * Notification that we suspended unindexing a file.
 664    */
 665   GNUNET_FS_STATUS_UNINDEX_SUSPEND,
 666
 667   /**
 668    * Notification that we made progress unindexing a file.
 669    */
 670   GNUNET_FS_STATUS_UNINDEX_PROGRESS,
 671
 672   /**
 673    * Notification that we encountered an error unindexing
 674    * a file.
 675    */
 676   GNUNET_FS_STATUS_UNINDEX_ERROR,
 677
 678   /**
 679    * Notification that the unindexing of this file
 680    * was completed.
 681    */
 682   GNUNET_FS_STATUS_UNINDEX_COMPLETED,
 683
 684   /**
 685    * Notification that the unindexing of this file
 686    * was stopped (final event for this action).
 687    */
 688   GNUNET_FS_STATUS_UNINDEX_STOPPED
 689
 690 };
 691
 692
 693 /**
 694  * Handle for controlling an upload.
 695  */
 696 struct GNUNET_FS_PublishContext;
 697
 698
 699 /**
 700  * Handle for controlling an unindexing operation.
 701  */
 702 struct GNUNET_FS_UnindexContext;
 703
 704
 705 /**
 706  * Handle for controlling a search.
 707  */
 708 struct GNUNET_FS_SearchContext;
 709
 710
 711 /**
 712  * Result from a search.  Opaque handle to refer to the search
 713  * (typically used when starting a download associated with the search
 714  * result).
 715  */
 716 struct GNUNET_FS_SearchResult;
 717
 718
 719 /**
 720  * Context for controlling a download.
 721  */
 722 struct GNUNET_FS_DownloadContext;
 723
 724
 725 /**
 726  * Handle for detail information about a file that is being publishd.
 727  * Specifies metadata, keywords, how to get the contents of the file
 728  * (i.e. data-buffer in memory, filename on disk) and other options.
 729  */
 730 struct GNUNET_FS_FileInformation;
 731
 732
 733 /**
 734  * Argument given to the progress callback with
 735  * information about what is going on.
 736  */
 737 struct GNUNET_FS_ProgressInfo
 738 {
 739
 740   /**
 741    * Values that depend on the event type.
 742    */
 743   union {
 744
 745     /**
 746      * Values for all "GNUNET_FS_STATUS_PUBLISH_*" events.
 747      */
 748     struct {
 749
 750       /**
 751        * Context for controlling the upload.
 752        */
 753       struct GNUNET_FS_PublishContext *pc;
 754
 755       /**
 756        * Information about the file that is being publishd.
 757        */
 758       const struct GNUNET_FS_FileInformation *fi;
 759
 760       /**
 761        * Client context pointer (set the last time by the client for
 762        * this operation; initially NULL on START/RESUME events).
 763        */
 764       void *cctx;
 765
 766       /**
 767        * Client context pointer for the parent operation
 768        * (if this is a file in a directory or a subdirectory).
 769        */
 770       void *pctx;
 771
 772       /**
 773        * Name of the file being published; can be NULL.
 774        */
 775       const char *filename;
 776
 777       /**
 778        * How large is the file overall?  For directories,
 779        * this is only the size of the directory itself,
 780        * not of the other files contained within the
 781        * directory.
 782        */
 783       uint64_t size;
 784
 785       /**
 786        * At what time do we expect to finish the upload?
 787        * (will be a value in the past for completed
 788        * uploads).
 789        */
 790       struct GNUNET_TIME_Relative eta;
 791
 792       /**
 793        * How long has this upload been actively running
 794        * (excludes times where the upload was suspended).
 795        */
 796       struct GNUNET_TIME_Relative duration;
 797
 798       /**
 799        * How many bytes have we completed?
 800        */
 801       uint64_t completed;
 802
 803       /**
 804        * What anonymity level is used for this upload?
 805        */
 806       uint32_t anonymity;
 807
 808       /**
 809        * Additional values for specific events.
 810        */
 811       union {
 812
 813         /**
 814          * These values are only valid for
 815          * GNUNET_FS_STATUS_PUBLISH_PROGRESS events.
 816          */
 817         struct {
 818
 819           /**
 820            * Data block we just published.
 821            */
 822           const void *data;
 823
 824           /**
 825            * At what offset in the file is "data"?
 826            */
 827           uint64_t offset;
 828
 829           /**
 830            * Length of the data block.
 831            */
 832           uint64_t data_len;
 833
 834           /**
 835            * Depth of the given block in the tree;
 836            * 0 would be the highest level (the first
 837            * call is guaranteed to be for the lowest
 838            * level).
 839            */
 840           unsigned int depth;
 841
 842         } progress;
 843
 844         /**
 845          * These values are only valid for
 846          * GNUNET_FS_STATUS_PUBLISH_RESUME events.
 847          */
 848         struct {
 849
 850           /**
 851            * Error message, NULL if no error was encountered so far.
 852            */
 853           const char *message;
 854
 855           /**
 856            * URI of the file (if the download had been completed)
 857            */
 858           const struct GNUNET_FS_Uri *chk_uri;
 859
 860         } resume;
 861
 862         /**
 863          * These values are only valid for
 864          * GNUNET_FS_STATUS_PUBLISH_COMPLETED events.
 865          */
 866         struct {
 867
 868           /**
 869            * URI of the file.
 870            */
 871           const struct GNUNET_FS_Uri *chk_uri;
 872
 873         } completed;
 874
 875         /**
 876          * These values are only valid for
 877          * GNUNET_FS_STATUS_PUBLISH_ERROR events.
 878          */
 879         struct {
 880
 881           /**
 882            * Error message, never NULL.
 883            */
 884           const char *message;
 885
 886         } error;
 887
 888       } specifics;
 889
 890     } publish;
 891
 892
 893     /**
 894      * Values for all "GNUNET_FS_STATUS_DOWNLOAD_*" events.
 895      */
 896     struct {
 897
 898       /**
 899        * Context for controlling the download.
 900        */
 901       struct GNUNET_FS_DownloadContext *dc;
 902
 903       /**
 904        * Client context pointer (set the last time
 905        * by the client for this operation; initially
 906        * NULL on START/RESUME events).
 907        */
 908       void *cctx;
 909
 910       /**
 911        * Client context pointer for the parent operation
 912        * (if this is a file in a directory or a subdirectory).
 913        */
 914       void *pctx;
 915
 916       /**
 917        * Client context pointer for the associated search operation
 918        * (specifically, context pointer for the specific search
 919        * result, not the overall search); only set if this
 920        * download was started from a search result.
 921        */
 922       void *sctx;
 923
 924       /**
 925        * URI used for this download.
 926        */
 927       const struct GNUNET_FS_Uri *uri;
 928
 929       /**
 930        * Name of the file that we are downloading.
 931        */
 932       const char *filename;
 933
 934       /**
 935        * How large is the download overall?  This
 936        * is NOT necessarily the size from the
 937        * URI since we may be doing a partial download.
 938        */
 939       uint64_t size;
 940
 941       /**
 942        * At what time do we expect to finish the download?
 943        * (will be a value in the past for completed
 944        * uploads).
 945        */
 946       struct GNUNET_TIME_Relative eta;
 947
 948       /**
 949        * How long has this download been active?
 950        */
 951       struct GNUNET_TIME_Relative duration;
 952
 953       /**
 954        * How many bytes have we completed?
 955        */
 956       uint64_t completed;
 957
 958       /**
 959        * What anonymity level is used for this download?
 960        */
 961       uint32_t anonymity;
 962
 963       /**
 964        * Additional values for specific events.
 965        */
 966       union {
 967
 968         /**
 969          * These values are only valid for
 970          * GNUNET_FS_STATUS_DOWNLOAD_PROGRESS events.
 971          */
 972         struct {
 973
 974           /**
 975            * Data block we just obtained.
 976            */
 977           const void *data;
 978
 979           /**
 980            * At what offset in the file is "data"?
 981            */
 982           uint64_t offset;
 983
 984           /**
 985            * Length of the data block.
 986            */
 987           uint64_t data_len;
 988
 989           /**
 990            * Depth of the given block in the tree;
 991            * 0 would be the highest level (the first
 992            * call is guaranteed to be for the lowest
 993            * level).
 994            */
 995           unsigned int depth;
 996
 997         } progress;
 998
 999         /**
1000          * These values are only valid for
1001          * GNUNET_FS_STATUS_DOWNLOAD_START events.
1002          */
1003         struct {
1004
1005           /**
1006            * Known metadata for the download.
1007            */
1008           const struct GNUNET_CONTAINER_MetaData *meta;
1009
1010         } start;
1011
1012         /**
1013          * These values are only valid for
1014          * GNUNET_FS_STATUS_DOWNLOAD_RESUME events.
1015          */
1016         struct {
1017
1018           /**
1019            * Known metadata for the download.
1020            */
1021           const struct GNUNET_CONTAINER_MetaData *meta;
1022
1023           /**
1024            * Error message, NULL if we have not encountered any error yet.
1025            */
1026           const char *message;
1027
1028         } resume;
1029
1030         /**
1031          * These values are only valid for
1032          * GNUNET_FS_STATUS_DOWNLOAD_ERROR events.
1033          */
1034         struct {
1035
1036           /**
1037            * Error message.
1038            */
1039           const char *message;
1040
1041         } error;
1042
1043       } specifics;
1044
1045     } download;
1046
1047     /**
1048      * Values for all "GNUNET_FS_STATUS_SEARCH_*" events.
1049      */
1050     struct {
1051
1052       /**
1053        * Context for controlling the search, NULL for
1054        * searches that were not explicitly triggered
1055        * by the client (i.e., searches for updates in
1056        * namespaces).
1057        */
1058       struct GNUNET_FS_SearchContext *sc;
1059
1060       /**
1061        * Client context pointer (set the last time by the client for
1062        * this operation; initially NULL on START/RESUME events).  Note
1063        * that this value can only be set on START/RESUME; returning
1064        * non-NULL on RESULT/RESUME_RESULT will actually update the
1065        * private context for "UPDATE" events.
1066        */
1067       void *cctx;
1068
1069       /**
1070        * Client parent-context pointer; NULL for top-level searches,
1071        * refers to the client context of the associated search result
1072        * for automatically triggered searches for updates in
1073        * namespaces.  In this case, 'presult' refers to that search
1074        * result.
1075        */
1076       void *pctx;
1077
1078       /**
1079        * What query is used for this search
1080        * (list of keywords or SKS identifier).
1081        */
1082       const struct GNUNET_FS_Uri *query;
1083
1084       /**
1085        * How long has this search been actively running
1086        * (excludes times where the search was paused or
1087        * suspended).
1088        */
1089       struct GNUNET_TIME_Relative duration;
1090
1091       /**
1092        * What anonymity level is used for this search?
1093        */
1094       uint32_t anonymity;
1095
1096       /**
1097        * Additional values for specific events.
1098        */
1099       union {
1100
1101         /**
1102          * These values are only valid for
1103          * GNUNET_FS_STATUS_SEARCH_RESULT events.
1104          */
1105         struct {
1106
1107           /**
1108            * Metadata for the search result.
1109            */
1110           const struct GNUNET_CONTAINER_MetaData *meta;
1111
1112           /**
1113            * URI for the search result.
1114            */
1115           const struct GNUNET_FS_Uri *uri;
1116
1117           /**
1118            * Handle to the result (for starting downloads).
1119            */
1120           struct GNUNET_FS_SearchResult *result;
1121
1122           /**
1123            * Applicability rank (the larger, the better the result
1124            * fits the search criteria).
1125            */
1126           uint32_t applicability_rank;
1127
1128         } result;
1129
1130         /**
1131          * These values are only valid for
1132          * GNUNET_FS_STATUS_SEARCH_RESUME_RESULT events.
1133          */
1134         struct {
1135
1136           /**
1137            * Metadata for the search result.
1138            */
1139           const struct GNUNET_CONTAINER_MetaData *meta;
1140
1141           /**
1142            * URI for the search result.
1143            */
1144           const struct GNUNET_FS_Uri *uri;
1145
1146           /**
1147            * Handle to the result (for starting downloads).
1148            */
1149           struct GNUNET_FS_SearchResult *result;
1150
1151           /**
1152            * Current availability rank (negative:
1153            * unavailable, positive: available)
1154            */
1155           int32_t availability_rank;
1156
1157           /**
1158            * On how many total queries is the given
1159            * availability_rank based?
1160            */
1161           uint32_t availability_certainty;
1162
1163           /**
1164            * Updated applicability rank (the larger,
1165            * the better the result fits the search
1166            * criteria).
1167            */
1168           uint32_t applicability_rank;
1169
1170         } resume_result;
1171
1172         /**
1173          * These values are only valid for
1174          * GNUNET_FS_STATUS_SEARCH_UPDATE events.
1175          */
1176         struct {
1177
1178           /**
1179            * Private context set for for this result
1180            * during the "RESULT" event.
1181            */
1182           void *cctx;
1183
1184           /**
1185            * Metadata for the search result.
1186            */
1187           const struct GNUNET_CONTAINER_MetaData *meta;
1188
1189           /**
1190            * URI for the search result.
1191            */
1192           const struct GNUNET_FS_Uri *uri;
1193
1194           /**
1195            * Current availability rank (negative:
1196            * unavailable, positive: available)
1197            */
1198           int32_t availability_rank;
1199
1200           /**
1201            * On how many total queries is the given
1202            * availability_rank based?
1203            */
1204           uint32_t availability_certainty;
1205
1206           /**
1207            * Updated applicability rank (the larger,
1208            * the better the result fits the search
1209            * criteria).
1210            */
1211           uint32_t applicability_rank;
1212
1213         } update;
1214
1215         /**
1216          * These values are only valid for
1217          * GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND events.
1218          * These events are automatically triggered for
1219          * each search result before the
1220          * GNUNET_FS_STATUS_SEARCH_SUSPEND event.  This
1221          * happens primarily to give the client a chance
1222          * to clean up the "cctx" (if needed).
1223          */
1224         struct {
1225
1226           /**
1227            * Private context set for for this result
1228            * during the "RESULT" event.
1229            */
1230           void *cctx;
1231
1232           /**
1233            * Metadata for the search result.
1234            */
1235           const struct GNUNET_CONTAINER_MetaData *meta;
1236
1237           /**
1238            * URI for the search result.
1239            */
1240           const struct GNUNET_FS_Uri *uri;
1241
1242         } result_suspend;
1243
1244         /**
1245          * These values are only valid for
1246          * GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED events.
1247          * These events are automatically triggered for
1248          * each search result before the
1249          * GNUNET_FS_STATUS_SEARCH_STOPPED event.  This
1250          * happens primarily to give the client a chance
1251          * to clean up the "cctx" (if needed).
1252          */
1253         struct {
1254
1255           /**
1256            * Private context set for for this result
1257            * during the "RESULT" event.
1258            */
1259           void *cctx;
1260
1261           /**
1262            * Metadata for the search result.
1263            */
1264           const struct GNUNET_CONTAINER_MetaData *meta;
1265
1266           /**
1267            * URI for the search result.
1268            */
1269           const struct GNUNET_FS_Uri *uri;
1270
1271         } result_stopped;
1272
1273         /**
1274          * These values are only valid for
1275          * GNUNET_FS_STATUS_SEARCH_RESUME events.
1276          */
1277         struct {
1278
1279           /**
1280            * Error message, NULL if we have not encountered any error yet.
1281            */
1282           const char *message;
1283
1284           /**
1285            * Is this search currently paused?
1286            */
1287           int is_paused;
1288
1289         } resume;
1290
1291         /**
1292          * These values are only valid for
1293          * GNUNET_FS_STATUS_SEARCH_ERROR events.
1294          */
1295         struct {
1296
1297           /**
1298            * Error message.
1299            */
1300           const char *message;
1301
1302         } error;
1303
1304         /**
1305          * Values for all "GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE" events.
1306          */
1307         struct {
1308
1309           /**
1310            * Handle to the namespace (NULL if it is not a local
1311            * namespace).
1312            */
1313           struct GNUNET_FS_Namespace *ns;
1314
1315           /**
1316            * Short, human-readable name of the namespace.
1317            */
1318           const char *name;
1319
1320           /**
1321            * Root identifier for the namespace, can be NULL.
1322            */
1323           const char *root;
1324
1325           /**
1326            * Metadata for the namespace.
1327            */
1328           const struct GNUNET_CONTAINER_MetaData *meta;
1329
1330           /**
1331            * Hash-identifier for the namespace.
1332            */
1333           GNUNET_HashCode id;
1334
1335         } namespace;
1336
1337       } specifics;
1338
1339     } search;
1340
1341     /**
1342      * Values for all "GNUNET_FS_STATUS_UNINDEX_*" events.
1343      */
1344     struct {
1345
1346       /**
1347        * Context for controlling the unindexing.
1348        */
1349       struct GNUNET_FS_UnindexContext *uc;
1350
1351       /**
1352        * Client context pointer (set the last time
1353        * by the client for this operation; initially
1354        * NULL on START/RESUME events).
1355        */
1356       void *cctx;
1357
1358       /**
1359        * Name of the file that is being unindexed.
1360        */
1361       const char *filename;
1362
1363       /**
1364        * How large is the file overall?
1365        */
1366       uint64_t size;
1367
1368       /**
1369        * At what time do we expect to finish unindexing?
1370        * (will be a value in the past for completed
1371        * unindexing opeations).
1372        */
1373       struct GNUNET_TIME_Relative eta;
1374
1375       /**
1376        * How long has this upload been actively running
1377        * (excludes times where the upload was suspended).
1378        */
1379       struct GNUNET_TIME_Relative duration;
1380
1381       /**
1382        * How many bytes have we completed?
1383        */
1384       uint64_t completed;
1385
1386       /**
1387        * Additional values for specific events.
1388        */
1389       union {
1390
1391         /**
1392          * These values are only valid for
1393          * GNUNET_FS_STATUS_UNINDEX_PROGRESS events.
1394          */
1395         struct {
1396
1397           /**
1398            * Data block we just unindexed.
1399            */
1400           const void *data;
1401
1402           /**
1403            * At what offset in the file is "data"?
1404            */
1405           uint64_t offset;
1406
1407           /**
1408            * Length of the data block.
1409            */
1410           uint64_t data_len;
1411
1412           /**
1413            * Depth of the given block in the tree;
1414            * 0 would be the highest level (the first
1415            * call is guaranteed to be for the lowest
1416            * level).
1417            */
1418           unsigned int depth;
1419
1420         } progress;
1421
1422         /**
1423          * These values are only valid for
1424          * GNUNET_FS_STATUS_UNINDEX_RESUME events.
1425          */
1426         struct {
1427
1428           /**
1429            * Error message, NULL if we have not encountered any error yet.
1430            */
1431           const char *message;
1432
1433         } resume;
1434
1435         /**
1436          * These values are only valid for
1437          * GNUNET_FS_STATUS_UNINDEX_ERROR events.
1438          */
1439         struct {
1440
1441           /**
1442            * Error message.
1443            */
1444           const char *message;
1445
1446         } error;
1447
1448       } specifics;
1449
1450     } unindex;
1451
1452   } value;
1453
1454   /**
1455    * Specific status code (determines the event type).
1456    */
1457   enum GNUNET_FS_Status status;
1458
1459 };
1460
1461
1462 /**
1463  * Notification of FS to a client about the progress of an
1464  * operation.  Callbacks of this type will be used for uploads,
1465  * downloads and searches.  Some of the arguments depend a bit
1466  * in their meaning on the context in which the callback is used.
1467  *
1468  * @param cls closure
1469  * @param info details about the event, specifying the event type
1470  *        and various bits about the event
1471  * @return client-context (for the next progress call
1472  *         for this operation; should be set to NULL for
1473  *         SUSPEND and STOPPED events).  The value returned
1474  *         will be passed to future callbacks in the respective
1475  *         field in the GNUNET_FS_ProgressInfo struct.
1476  */
1477 typedef void* (*GNUNET_FS_ProgressCallback)
1478   (void *cls,
1479    const struct GNUNET_FS_ProgressInfo *info);
1480
1481
1482 /**
1483  * General (global) option flags for file-sharing.
1484  */
1485 enum GNUNET_FS_Flags
1486   {
1487     /**
1488      * No special flags set.
1489      */
1490     GNUNET_FS_FLAGS_NONE = 0,
1491
1492     /**
1493      * Is persistence of operations desired?
1494      * (will create SUSPEND/RESUME events).
1495      */
1496     GNUNET_FS_FLAGS_PERSISTENCE = 1,
1497
1498     /**
1499      * Should we automatically trigger probes for search results
1500      * to determine availability?
1501      * (will create GNUNET_FS_STATUS_SEARCH_UPDATE events).
1502      */
1503     GNUNET_FS_FLAGS_DO_PROBES = 2
1504
1505   };
1506
1507 /**
1508  * Options specified in the VARARGs portion of GNUNET_FS_start.
1509  */
1510 enum GNUNET_FS_OPTIONS
1511   {
1512
1513     /**
1514      * Last option in the VARARG list.
1515      */
1516     GNUNET_FS_OPTIONS_END = 0,
1517
1518     /**
1519      * Select the desired amount of parallelism (this option should be
1520      * followed by an "unsigned int" giving the desired maximum number
1521      * of parallel downloads).
1522      */
1523     GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM = 1,
1524
1525     /**
1526      * Maximum number of requests that should be pending at a given
1527      * point in time (invidivual downloads may go above this, but
1528      * if we are above this threshold, we should not activate any
1529      * additional downloads.
1530      */
1531     GNUNET_FS_OPTIONS_REQUEST_PARALLELISM = 2
1532
1533   };
1534
1535
1536 /**
1537  * Handle to the file-sharing service.
1538  */
1539 struct GNUNET_FS_Handle;
1540
1541
1542 /**
1543  * Setup a connection to the file-sharing service.
1544  *
1545  * @param sched scheduler to use
1546  * @param cfg configuration to use
1547  * @param client_name unique identifier for this client
1548  * @param upcb function to call to notify about FS actions
1549  * @param upcb_cls closure for upcb
1550  * @param flags specific attributes for fs-operations
1551  * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
1552  * @return NULL on error
1553  */
1554 struct GNUNET_FS_Handle *
1555 GNUNET_FS_start (struct GNUNET_SCHEDULER_Handle *sched,
1556                  const struct GNUNET_CONFIGURATION_Handle *cfg,
1557                  const char *client_name,
1558                  GNUNET_FS_ProgressCallback upcb,
1559                  void *upcb_cls,
1560                  enum GNUNET_FS_Flags flags,
1561                  ...);
1562
1563
1564 /**
1565  * Close our connection with the file-sharing service.
1566  * The callback given to GNUNET_FS_start will no longer be
1567  * called after this function returns.
1568  *
1569  * @param h handle that was returned from GNUNET_FS_start
1570  */
1571 void
1572 GNUNET_FS_stop (struct GNUNET_FS_Handle *h);
1573
1574
1575 /**
1576  * Extract meta-data from a file.
1577  *
1578  * @param md metadata to set
1579  * @param filename name of file to inspect
1580  * @param extractors plugins to use
1581  * @return GNUNET_SYSERR on error, otherwise the number
1582  *   of meta-data items obtained
1583  */
1584 int
1585 GNUNET_FS_meta_data_extract_from_file (struct
1586                                        GNUNET_CONTAINER_MetaData
1587                                        *md, const char *filename,
1588                                        struct EXTRACTOR_PluginList *
1589                                        extractors);
1590
1591
1592 /**
1593  * Function called on entries in a GNUNET_FS_FileInformation publish-structure.
1594  *
1595  * @param cls closure
1596  * @param fi the entry in the publish-structure
1597  * @param length length of the file or directory
1598  * @param meta metadata for the file or directory (can be modified)
1599  * @param uri pointer to the keywords that will be used for this entry (can be modified)
1600  * @param anonymity pointer to selected anonymity level (can be modified)
1601  * @param priority pointer to selected priority (can be modified)
1602  * @param do_index should we index (can be modified)
1603  * @param expirationTime pointer to selected expiration time (can be modified)
1604  * @param client_info pointer to client context set upon creation (can be modified)
1605  * @return GNUNET_OK to continue, GNUNET_NO to remove
1606  *         this entry from the directory, GNUNET_SYSERR
1607  *         to abort the iteration
1608  */
1609 typedef int (*GNUNET_FS_FileInformationProcessor)(void *cls,
1610                                                   struct GNUNET_FS_FileInformation *fi,
1611                                                   uint64_t length,
1612                                                   struct GNUNET_CONTAINER_MetaData *meta,
1613                                                   struct GNUNET_FS_Uri **uri,
1614                                                   uint32_t *anonymity,
1615                                                   uint32_t *priority,
1616                                                   int *do_index,
1617                                                   struct GNUNET_TIME_Absolute *expirationTime,
1618                                                   void **client_info);
1619
1620
1621 /**
1622  * Obtain the name under which this file information
1623  * structure is stored on disk.  Only works for top-level
1624  * file information structures.
1625  *
1626  * @param s structure to get the filename for
1627  * @return NULL on error, otherwise filename that
1628  *         can be passed to "GNUNET_FS_file_information_recover"
1629  *         to read this fi-struct from disk.
1630  */
1631 const char *
1632 GNUNET_FS_file_information_get_id (struct GNUNET_FS_FileInformation *s);
1633
1634
1635
1636 /**
1637  * Create an entry for a file in a publish-structure.
1638  *
1639  * @param h handle to the file sharing subsystem
1640  * @param client_info initial client-info value for this entry
1641  * @param filename name of the file or directory to publish
1642  * @param keywords under which keywords should this file be available
1643  *         directly; can be NULL
1644  * @param meta metadata for the file
1645  * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1646  *                GNUNET_SYSERR for simulation
1647  * @param anonymity what is the desired anonymity level for sharing?
1648  * @param priority what is the priority for OUR node to
1649  *   keep this file available?  Use 0 for maximum anonymity and
1650  *   minimum reliability...
1651  * @param expirationTime when should this content expire?
1652  * @return publish structure entry for the file
1653  */
1654 struct GNUNET_FS_FileInformation *
1655 GNUNET_FS_file_information_create_from_file (struct GNUNET_FS_Handle *h,
1656                                              void *client_info,
1657                                              const char *filename,
1658                                              const struct GNUNET_FS_Uri *keywords,
1659                                              const struct GNUNET_CONTAINER_MetaData *meta,
1660                                              int do_index,
1661                                              uint32_t anonymity,
1662                                              uint32_t priority,
1663                                              struct GNUNET_TIME_Absolute expirationTime);
1664
1665
1666 /**
1667  * Create an entry for a file in a publish-structure.
1668  *
1669  * @param h handle to the file sharing subsystem
1670  * @param client_info initial client-info value for this entry
1671  * @param length length of the file
1672  * @param data data for the file (should not be used afterwards by
1673  *        the caller; callee will "free")
1674  * @param keywords under which keywords should this file be available
1675  *         directly; can be NULL
1676  * @param meta metadata for the file
1677  * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1678  *                GNUNET_SYSERR for simulation
1679  * @param anonymity what is the desired anonymity level for sharing?
1680  * @param priority what is the priority for OUR node to
1681  *   keep this file available?  Use 0 for maximum anonymity and
1682  *   minimum reliability...
1683  * @param expirationTime when should this content expire?
1684  * @return publish structure entry for the file
1685  */
1686 struct GNUNET_FS_FileInformation *
1687 GNUNET_FS_file_information_create_from_data (struct GNUNET_FS_Handle *h,
1688                                              void *client_info,
1689                                              uint64_t length,
1690                                              void *data,
1691                                              const struct GNUNET_FS_Uri *keywords,
1692                                              const struct GNUNET_CONTAINER_MetaData *meta,
1693                                              int do_index,
1694                                              uint32_t anonymity,
1695                                              uint32_t priority,
1696                                              struct GNUNET_TIME_Absolute expirationTime);
1697
1698
1699 /**
1700  * Function that provides data.
1701  *
1702  * @param cls closure
1703  * @param offset offset to read from; it is possible
1704  *            that the caller might need to go backwards
1705  *            a bit at times
1706  * @param max maximum number of bytes that should be
1707  *            copied to buf; readers are not allowed
1708  *            to provide less data unless there is an error;
1709  *            a value of "0" will be used at the end to allow
1710  *            the reader to clean up its internal state
1711  * @param buf where the reader should write the data
1712  * @param emsg location for the reader to store an error message
1713  * @return number of bytes written, usually "max", 0 on error
1714  */
1715 typedef size_t (*GNUNET_FS_DataReader)(void *cls,
1716                                        uint64_t offset,
1717                                        size_t max,
1718                                        void *buf,
1719                                        char **emsg);
1720
1721
1722 /**
1723  * Create an entry for a file in a publish-structure.
1724  *
1725  * @param h handle to the file sharing subsystem
1726  * @param client_info initial client-info value for this entry
1727  * @param length length of the file
1728  * @param reader function that can be used to obtain the data for the file
1729  * @param reader_cls closure for "reader"
1730  * @param keywords under which keywords should this file be available
1731  *         directly; can be NULL
1732  * @param meta metadata for the file
1733  * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1734  *                GNUNET_SYSERR for simulation
1735  * @param anonymity what is the desired anonymity level for sharing?
1736  * @param priority what is the priority for OUR node to
1737  *   keep this file available?  Use 0 for maximum anonymity and
1738  *   minimum reliability...
1739  * @param expirationTime when should this content expire?
1740  * @return publish structure entry for the file
1741  */
1742 struct GNUNET_FS_FileInformation *
1743 GNUNET_FS_file_information_create_from_reader (struct GNUNET_FS_Handle *h,
1744                                                void *client_info,
1745                                                uint64_t length,
1746                                                GNUNET_FS_DataReader reader,
1747                                                void *reader_cls,
1748                                                const struct GNUNET_FS_Uri *keywords,
1749                                                const struct GNUNET_CONTAINER_MetaData *meta,
1750                                                int do_index,
1751                                                uint32_t anonymity,
1752                                                uint32_t priority,
1753                                                struct GNUNET_TIME_Absolute expirationTime);
1754
1755
1756 /**
1757  * Function that a "GNUNET_FS_DirectoryScanner" should call
1758  * for each entry in the directory.
1759  *
1760  * @param cls closure
1761  * @param filename name of the file (including path); must end
1762  *          in a "/" (even on W32) if this is a directory
1763  * @param fi information about the file (should not be
1764  *        used henceforth by the caller)
1765  */
1766 typedef void (*GNUNET_FS_FileProcessor)(void *cls,
1767                                         const char *filename,
1768                                         struct GNUNET_FS_FileInformation *fi);
1769
1770
1771 /**
1772  * Type of a function that will be used to scan a directory.
1773  *
1774  * @param cls closure
1775  * @param h handle to the file sharing subsystem
1776  * @param dirname name of the directory to scan
1777  * @param do_index should files be indexed or inserted
1778  * @param anonymity desired anonymity level
1779  * @param priority priority for publishing
1780  * @param expirationTime expiration for publication
1781  * @param proc function to call on each entry
1782  * @param proc_cls closure for proc
1783  * @param emsg where to store an error message (on errors)
1784  * @return GNUNET_OK on success
1785  */
1786 typedef int (*GNUNET_FS_DirectoryScanner)(void *cls,
1787                                           struct GNUNET_FS_Handle *h,
1788                                           const char *dirname,
1789                                           int do_index,
1790                                           uint32_t anonymity,
1791                                           uint32_t priority,
1792                                           struct GNUNET_TIME_Absolute expirationTime,
1793                                           GNUNET_FS_FileProcessor proc,
1794                                           void *proc_cls,
1795                                           char **emsg);
1796
1797
1798
1799 /**
1800  * Simple, useful default implementation of a directory scanner
1801  * (GNUNET_FS_DirectoryScanner).  This implementation expects to get a
1802  * UNIX filename, will publish all files in the directory except hidden
1803  * files (those starting with a ".").  Metadata will be extracted
1804  * using GNU libextractor; the specific list of plugins should be
1805  * specified in "cls", passing NULL will disable (!)  metadata
1806  * extraction.  Keywords will be derived from the metadata and be
1807  * subject to default canonicalization.  This is strictly a
1808  * convenience function.
1809  *
1810  * @param cls must be of type "struct EXTRACTOR_Extractor*"
1811  * @param h handle to the file sharing subsystem
1812  * @param dirname name of the directory to scan
1813  * @param do_index should files be indexed or inserted
1814  * @param anonymity desired anonymity level
1815  * @param priority priority for publishing
1816  * @param expirationTime expiration for publication
1817  * @param proc function called on each entry
1818  * @param proc_cls closure for proc
1819  * @param emsg where to store an error message (on errors)
1820  * @return GNUNET_OK on success
1821  */
1822 int
1823 GNUNET_FS_directory_scanner_default (void *cls,
1824                                      struct GNUNET_FS_Handle *h,
1825                                      const char *dirname,
1826                                      int do_index,
1827                                      uint32_t anonymity,
1828                                      uint32_t priority,
1829                                      struct GNUNET_TIME_Absolute expirationTime,
1830                                      GNUNET_FS_FileProcessor proc,
1831                                      void *proc_cls,
1832                                      char **emsg);
1833
1834
1835 /**
1836  * Create a publish-structure from an existing file hierarchy, inferring
1837  * and organizing keywords and metadata as much as possible.  This
1838  * function primarily performs the recursive build and re-organizes
1839  * keywords and metadata; for automatically getting metadata
1840  * extraction, scanning of directories and creation of the respective
1841  * GNUNET_FS_FileInformation entries the default scanner should be
1842  * passed (GNUNET_FS_directory_scanner_default).  This is strictly a
1843  * convenience function.
1844  *
1845  * @param h handle to the file sharing subsystem
1846  * @param client_info initial client-info value for this entry
1847  * @param filename name of the top-level file or directory
1848  * @param scanner function used to get a list of files in a directory
1849  * @param scanner_cls closure for scanner
1850  * @param do_index should files in the hierarchy be indexed?
1851  * @param anonymity what is the desired anonymity level for sharing?
1852  * @param priority what is the priority for OUR node to
1853  *   keep this file available?  Use 0 for maximum anonymity and
1854  *   minimum reliability...
1855  * @param expirationTime when should this content expire?
1856  * @param emsg where to store an error message
1857  * @return publish structure entry for the directory, NULL on error
1858  */
1859 struct GNUNET_FS_FileInformation *
1860 GNUNET_FS_file_information_create_from_directory (struct GNUNET_FS_Handle *h,
1861                                                   void *client_info,
1862                                                   const char *filename,
1863                                                   GNUNET_FS_DirectoryScanner scanner,
1864                                                   void *scanner_cls,
1865                                                   int do_index,
1866                                                   uint32_t anonymity,
1867                                                   uint32_t priority,
1868                                                   struct GNUNET_TIME_Absolute expirationTime,
1869                                                   char **emsg);
1870
1871
1872 /**
1873  * Create an entry for an empty directory in a publish-structure.
1874  * This function should be used by applications for which the
1875  * use of "GNUNET_FS_file_information_create_from_directory"
1876  * is not appropriate.
1877  *
1878  * @param h handle to the file sharing subsystem
1879  * @param client_info initial client-info value for this entry
1880  * @param keywords under which keywords should this directory be available
1881  *         directly; can be NULL
1882  * @param meta metadata for the directory
1883  * @param anonymity what is the desired anonymity level for sharing?
1884  * @param priority what is the priority for OUR node to
1885  *   keep this file available?  Use 0 for maximum anonymity and
1886  *   minimum reliability...
1887  * @param expirationTime when should this content expire?
1888  * @return publish structure entry for the directory , NULL on error
1889  */
1890 struct GNUNET_FS_FileInformation *
1891 GNUNET_FS_file_information_create_empty_directory (struct GNUNET_FS_Handle *h,
1892                                                    void *client_info,
1893                                                    const struct GNUNET_FS_Uri *keywords,
1894                                                    const struct GNUNET_CONTAINER_MetaData *meta,
1895                                                    uint32_t anonymity,
1896                                                    uint32_t priority,
1897                                                    struct GNUNET_TIME_Absolute expirationTime);
1898
1899
1900 /**
1901  * Test if a given entry represents a directory.
1902  *
1903  * @param ent check if this FI represents a directory
1904  * @return GNUNET_YES if so, GNUNET_NO if not
1905  */
1906 int
1907 GNUNET_FS_file_information_is_directory (struct GNUNET_FS_FileInformation *ent);
1908
1909
1910 /**
1911  * Add an entry to a directory in a publish-structure.  Clients
1912  * should never modify publish structures that were passed to
1913  * "GNUNET_FS_publish_start" already.
1914  *
1915  * @param dir the directory
1916  * @param ent the entry to add; the entry must not have been
1917  *            added to any other directory at this point and
1918  *            must not include "dir" in its structure
1919  * @return GNUNET_OK on success, GNUNET_SYSERR on error
1920  */
1921 int
1922 GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
1923                                 struct GNUNET_FS_FileInformation *ent);
1924
1925
1926 /**
1927  * Inspect a file or directory in a publish-structure.  Clients
1928  * should never modify publish structures that were passed to
1929  * "GNUNET_FS_publish_start" already.  When called on a directory,
1930  * this function will FIRST call "proc" with information about
1931  * the directory itself and then for each of the files in the
1932  * directory (but not for files in subdirectories).  When called
1933  * on a file, "proc" will be called exactly once (with information
1934  * about the specific file).
1935  *
1936  * @param dir the directory
1937  * @param proc function to call on each entry
1938  * @param proc_cls closure for proc
1939  */
1940 void
1941 GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir,
1942                                     GNUNET_FS_FileInformationProcessor proc,
1943                                     void *proc_cls);
1944
1945
1946 /**
1947  * Destroy publish-structure.  Clients should never destroy publish
1948  * structures that were passed to "GNUNET_FS_publish_start" already.
1949  *
1950  * @param fi structure to destroy
1951  * @param cleaner function to call on each entry in the structure
1952  *        (useful to clean up client_info); can be NULL; return
1953  *        values are ignored
1954  * @param cleaner_cls closure for cleaner
1955  */
1956 void
1957 GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi,
1958                                     GNUNET_FS_FileInformationProcessor cleaner,
1959                                     void *cleaner_cls);
1960
1961
1962 /**
1963  * Options for publishing.  Compatible options
1964  * can be OR'ed together.
1965  */
1966 enum GNUNET_FS_PublishOptions
1967   {
1968     /**
1969      * No options (use defaults for everything).
1970      */
1971     GNUNET_FS_PUBLISH_OPTION_NONE = 0,
1972
1973     /**
1974      * Simulate publishing.  With this option, no data will be stored
1975      * in the datastore.  Useful for computing URIs from files.
1976      */
1977     GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY = 1
1978   };
1979
1980 /**
1981  * Publish a file or directory.
1982  *
1983  * @param h handle to the file sharing subsystem
1984  * @param fi information about the file or directory structure to publish
1985  * @param namespace namespace to publish the file in, NULL for no namespace
1986  * @param nid identifier to use for the publishd content in the namespace
1987  *        (can be NULL, must be NULL if namespace is NULL)
1988  * @param nuid update-identifier that will be used for future updates
1989  *        (can be NULL, must be NULL if namespace or nid is NULL)
1990  * @param options options for the publication
1991  * @return context that can be used to control the publish operation
1992  */
1993 struct GNUNET_FS_PublishContext *
1994 GNUNET_FS_publish_start (struct GNUNET_FS_Handle *h,
1995                          struct GNUNET_FS_FileInformation *fi,
1996                          struct GNUNET_FS_Namespace *namespace,
1997                          const char *nid,
1998                          const char *nuid,
1999                          enum GNUNET_FS_PublishOptions options);
2000
2001
2002 /**
2003  * Stop a publication.  Will abort incomplete publications (but
2004  * not remove blocks that have already been published) or
2005  * simply clean up the state for completed publications.
2006  * Must NOT be called from within the event callback!
2007  *
2008  * @param pc context for the publication to stop
2009  */
2010 void
2011 GNUNET_FS_publish_stop (struct GNUNET_FS_PublishContext *pc);
2012
2013
2014 /**
2015  * Signature of a function called as the continuation of a KBlock or
2016  * SBlock publication.
2017  *
2018  * @param cls closure
2019  * @param uri URI under which the block is now available, NULL on error
2020  * @param emsg error message, NULL on success
2021  */
2022 typedef void (*GNUNET_FS_PublishContinuation)(void *cls,
2023                                               const struct GNUNET_FS_Uri *uri,
2024                                               const char *emsg);
2025
2026
2027 /**
2028  * Publish a KBlock on GNUnet.
2029  *
2030  * @param h handle to the file sharing subsystem
2031  * @param ksk_uri keywords to use
2032  * @param meta metadata to use
2033  * @param uri URI to refer to in the KBlock
2034  * @param expirationTime when the KBlock expires
2035  * @param anonymity anonymity level for the KBlock
2036  * @param priority priority for the KBlock
2037  * @param cont continuation
2038  * @param cont_cls closure for cont
2039  */
2040 void
2041 GNUNET_FS_publish_ksk (struct GNUNET_FS_Handle *h,
2042                        const struct GNUNET_FS_Uri *ksk_uri,
2043                        const struct GNUNET_CONTAINER_MetaData *meta,
2044                        const struct GNUNET_FS_Uri *uri,
2045                        struct GNUNET_TIME_Absolute expirationTime,
2046                        uint32_t anonymity,
2047                        uint32_t priority,
2048                        enum GNUNET_FS_PublishOptions options,
2049                        GNUNET_FS_PublishContinuation cont,
2050                        void *cont_cls);
2051
2052
2053 /**
2054  * Publish an SBlock on GNUnet.
2055  *
2056  * @param h handle to the file sharing subsystem
2057  * @param namespace namespace to publish in
2058  * @param identifier identifier to use
2059  * @param update update identifier to use
2060  * @param meta metadata to use
2061  * @param uri URI to refer to in the SBlock
2062  * @param expirationTime when the SBlock expires
2063  * @param anonymity anonymity level for the SBlock
2064  * @param priority priority for the SBlock
2065  * @param cont continuation
2066  * @param cont_cls closure for cont
2067  */
2068 void
2069 GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
2070                        struct GNUNET_FS_Namespace *namespace,
2071                        const char *identifier,
2072                        const char *update,
2073                        const struct GNUNET_CONTAINER_MetaData *meta,
2074                        const struct GNUNET_FS_Uri *uri,
2075                        struct GNUNET_TIME_Absolute expirationTime,
2076                        uint32_t anonymity,
2077                        uint32_t priority,
2078                        enum GNUNET_FS_PublishOptions options,
2079                        GNUNET_FS_PublishContinuation cont,
2080                        void *cont_cls);
2081
2082
2083 /**
2084  * Type of a function called by "GNUNET_FS_get_indexed_files".
2085  *
2086  * @param cls closure
2087  * @param filename the name of the file
2088  * @param file_id hash of the contents of the indexed file
2089  * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
2090  */
2091 typedef int (*GNUNET_FS_IndexedFileProcessor) (void *cls,
2092                                                const char *filename,
2093                                                const GNUNET_HashCode *file_id);
2094
2095
2096 /**
2097  * Iterate over all indexed files.
2098  *
2099  * @param h handle to the file sharing subsystem
2100  * @param iterator function to call on each indexed file
2101  * @param iterator_cls closure for iterator
2102  * @param cont continuation to call when done;
2103  *             reason should be "TIMEOUT" (on
2104  *             error) or  "PREREQ_DONE" (on success)
2105  * @param cont_cls closure for cont
2106  */
2107 void
2108 GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
2109                              GNUNET_FS_IndexedFileProcessor iterator,
2110                              void *iterator_cls,
2111                              GNUNET_SCHEDULER_Task cont,
2112                              void *cont_cls);
2113
2114
2115 /**
2116  * Unindex a file.
2117  *
2118  * @param h handle to the file sharing subsystem
2119  * @param filename file to unindex
2120  * @param cctx initial value for the client context
2121  * @return NULL on error, otherwise handle
2122  */
2123 struct GNUNET_FS_UnindexContext *
2124 GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h,
2125                          const char *filename,
2126                          void *cctx);
2127
2128
2129 /**
2130  * Clean up after completion of an unindex operation.
2131  *
2132  * @param uc handle
2133  */
2134 void
2135 GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc);
2136
2137
2138 /**
2139  * Publish an advertismement for a namespace.
2140  *
2141  * @param h handle to the file sharing subsystem
2142  * @param ksk_uri keywords to use for advertisment
2143  * @param namespace handle for the namespace that should be advertised
2144  * @param meta meta-data for the namespace advertisement
2145  * @param anonymity for the namespace advertismement
2146  * @param priority for the namespace advertisement
2147  * @param expiration for the namespace advertisement
2148  * @param rootEntry name of the root of the namespace
2149  * @param cont continuation
2150  * @param cont_cls closure for cont
2151  */
2152 void
2153 GNUNET_FS_namespace_advertise (struct GNUNET_FS_Handle *h,
2154                                struct GNUNET_FS_Uri *ksk_uri,
2155                                struct GNUNET_FS_Namespace *namespace,
2156                                const struct GNUNET_CONTAINER_MetaData *meta,
2157                                uint32_t anonymity,
2158                                uint32_t priority,
2159                                struct GNUNET_TIME_Absolute expiration,
2160                                const char *rootEntry,
2161                                GNUNET_FS_PublishContinuation cont,
2162                                void *cont_cls);
2163
2164
2165 /**
2166  * Create a namespace with the given name; if one already
2167  * exists, return a handle to the existing namespace.
2168  *
2169  * @param h handle to the file sharing subsystem
2170  * @param name name to use for the namespace
2171  * @return handle to the namespace, NULL on error
2172  */
2173 struct GNUNET_FS_Namespace *
2174 GNUNET_FS_namespace_create (struct GNUNET_FS_Handle *h,
2175                             const char *name);
2176
2177
2178 /**
2179  * Delete a namespace handle.  Can be used for a clean shutdown (free
2180  * memory) or also to freeze the namespace to prevent further
2181  * insertions by anyone.
2182  *
2183  * @param namespace handle to the namespace that should be deleted / freed
2184  * @param freeze prevents future insertions; creating a namespace
2185  *        with the same name again will create a fresh namespace instead
2186  *
2187  * @return GNUNET_OK on success, GNUNET_SYSERR on error
2188  */
2189 int
2190 GNUNET_FS_namespace_delete (struct GNUNET_FS_Namespace *namespace,
2191                             int freeze);
2192
2193
2194 /**
2195  * Callback with information about local (!) namespaces.
2196  * Contains the names of the local namespace and the global
2197  * ID.
2198  *
2199  * @param cls closure
2200  * @param name human-readable identifier of the namespace
2201  * @param id hash identifier for the namespace
2202  */
2203 typedef void (*GNUNET_FS_NamespaceInfoProcessor) (void *cls,
2204                                                   const char *name,
2205                                                   const GNUNET_HashCode *id);
2206
2207
2208 /**
2209  * Build a list of all available local (!) namespaces The returned
2210  * names are only the nicknames since we only iterate over the local
2211  * namespaces.
2212  *
2213  * @param h handle to the file sharing subsystem
2214  * @param cb function to call on each known namespace
2215  * @param cb_cls closure for cb
2216  */
2217 void
2218 GNUNET_FS_namespace_list (struct GNUNET_FS_Handle *h,
2219                           GNUNET_FS_NamespaceInfoProcessor cb,
2220                           void *cb_cls);
2221
2222
2223 /**
2224  * Function called on updateable identifiers.
2225  *
2226  * @param cls closure
2227  * @param last_id last identifier
2228  * @param last_uri uri used for the content published under the last_id
2229  * @param last_meta metadata associated with last_uri
2230  * @param next_id identifier that should be used for updates
2231  */
2232 typedef void
2233 (*GNUNET_FS_IdentifierProcessor)(void *cls,
2234                                  const char *last_id,
2235                                  const struct GNUNET_FS_Uri *last_uri,
2236                                  const struct GNUNET_CONTAINER_MetaData *last_meta,
2237                                  const char *next_id);
2238
2239
2240 /**
2241  * List all of the identifiers in the namespace for
2242  * which we could produce an update.
2243  *
2244  * @param namespace namespace to inspect for updateable content
2245  * @param ip function to call on each updateable identifier
2246  * @param ip_cls closure for ip
2247  */
2248 void
2249 GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Namespace *namespace,
2250                                      GNUNET_FS_IdentifierProcessor ip,
2251                                      void *ip_cls);
2252
2253
2254 /**
2255  * Options for searching.  Compatible options
2256  * can be OR'ed together.
2257  */
2258 enum GNUNET_FS_SearchOptions
2259   {
2260     /**
2261      * No options (use defaults for everything).
2262      */
2263     GNUNET_FS_SEARCH_OPTION_NONE = 0,
2264
2265     /**
2266      * Only search the local host, do not search remote systems (no P2P)
2267      */
2268     GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY = 1
2269
2270   };
2271
2272
2273 /**
2274  * Start search for content.
2275  *
2276  * @param h handle to the file sharing subsystem
2277  * @param uri specifies the search parameters; can be
2278  *        a KSK URI or an SKS URI.
2279  * @param anonymity desired level of anonymity
2280  * @param options options for the search
2281  * @param cctx initial value for the client context
2282  * @return context that can be used to control the search
2283  */
2284 struct GNUNET_FS_SearchContext *
2285 GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
2286                         const struct GNUNET_FS_Uri *uri,
2287                         uint32_t anonymity,
2288                         enum GNUNET_FS_SearchOptions options,
2289                         void *cctx);
2290
2291
2292 /**
2293  * Pause search.
2294  *
2295  * @param sc context for the search that should be paused
2296  */
2297 void
2298 GNUNET_FS_search_pause (struct GNUNET_FS_SearchContext *sc);
2299
2300
2301 /**
2302  * Continue paused search.
2303  *
2304  * @param sc context for the search that should be resumed
2305  */
2306 void
2307 GNUNET_FS_search_continue (struct GNUNET_FS_SearchContext *sc);
2308
2309
2310 /**
2311  * Stop search for content.
2312  *
2313  * @param sc context for the search that should be stopped
2314  */
2315 void
2316 GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc);
2317
2318
2319
2320
2321 /**
2322  * Options for downloading.  Compatible options
2323  * can be OR'ed together.
2324  */
2325 enum GNUNET_FS_DownloadOptions
2326   {
2327     /**
2328      * No options (use defaults for everything).
2329      */
2330     GNUNET_FS_DOWNLOAD_OPTION_NONE = 0,
2331
2332     /**
2333      * Only download from the local host, do not access remote systems (no P2P)
2334      */
2335     GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY = 1,
2336
2337     /**
2338      * Do a recursive download (that is, automatically trigger the
2339      * download of files in directories).
2340      */
2341     GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE = 2,
2342
2343     /**
2344      * Do not append temporary data to
2345      * the target file (for the IBlocks).
2346      */
2347     GNUNET_FS_DOWNLOAD_NO_TEMPORARIES = 4,
2348
2349     /**
2350      * Internal option used to flag this download as a 'probe' for a
2351      * search result.  Impacts the priority with which the download is
2352      * run and causes signalling callbacks to be done differently.
2353      * Also, probe downloads are not serialized on suspension.  Normal
2354      * clients should not use this!
2355      */
2356     GNUNET_FS_DOWNLOAD_IS_PROBE = (1<<31)
2357
2358   };
2359
2360
2361
2362 /**
2363  * Download parts of a file.  Note that this will store
2364  * the blocks at the respective offset in the given file.  Also, the
2365  * download is still using the blocking of the underlying FS
2366  * encoding.  As a result, the download may *write* outside of the
2367  * given boundaries (if offset and length do not match the 32k FS
2368  * block boundaries). <p>
2369  *
2370  * The given range can be used to focus a download towards a
2371  * particular portion of the file (optimization), not to strictly
2372  * limit the download to exactly those bytes.
2373  *
2374  * @param h handle to the file sharing subsystem
2375  * @param uri the URI of the file (determines what to download); CHK or LOC URI
2376  * @param meta known metadata for the file (can be NULL)
2377  * @param filename where to store the file, maybe NULL (then no file is
2378  *        created on disk and data must be grabbed from the callbacks)
2379  * @param tempname where to store temporary file data, not used if filename is non-NULL;
2380  *        can be NULL (in which case we will pick a name if needed); the temporary file
2381  *        may already exist, in which case we will try to use the data that is there and
2382  *        if it is not what is desired, will overwrite it
2383  * @param offset at what offset should we start the download (typically 0)
2384  * @param length how many bytes should be downloaded starting at offset
2385  * @param anonymity anonymity level to use for the download
2386  * @param options various download options
2387  * @param cctx initial value for the client context for this download
2388  * @param parent parent download to associate this download with (use NULL
2389  *        for top-level downloads; useful for manually-triggered recursive downloads)
2390  * @return context that can be used to control this download
2391  */
2392 struct GNUNET_FS_DownloadContext *
2393 GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
2394                           const struct GNUNET_FS_Uri *uri,
2395                           const struct GNUNET_CONTAINER_MetaData *meta,
2396                           const char *filename,
2397                           const char *tempname,
2398                           uint64_t offset,
2399                           uint64_t length,
2400                           uint32_t anonymity,
2401                           enum GNUNET_FS_DownloadOptions options,
2402                           void *cctx,
2403                           struct GNUNET_FS_DownloadContext *parent);
2404
2405
2406 /**
2407  * Download parts of a file based on a search result.  The download
2408  * will be associated with the search result (and the association
2409  * will be preserved when serializing/deserializing the state).
2410  * If the search is stopped, the download will not be aborted but
2411  * be 'promoted' to a stand-alone download.
2412  *
2413  * As with the other download function, this will store
2414  * the blocks at the respective offset in the given file.  Also, the
2415  * download is still using the blocking of the underlying FS
2416  * encoding.  As a result, the download may *write* outside of the
2417  * given boundaries (if offset and length do not match the 32k FS
2418  * block boundaries). <p>
2419  *
2420  * The given range can be used to focus a download towards a
2421  * particular portion of the file (optimization), not to strictly
2422  * limit the download to exactly those bytes.
2423  *
2424  * @param h handle to the file sharing subsystem
2425  * @param sr the search result to use for the download (determines uri and
2426  *        meta data and associations)
2427  * @param filename where to store the file, maybe NULL (then no file is
2428  *        created on disk and data must be grabbed from the callbacks)
2429  * @param tempname where to store temporary file data, not used if filename is non-NULL;
2430  *        can be NULL (in which case we will pick a name if needed); the temporary file
2431  *        may already exist, in which case we will try to use the data that is there and
2432  *        if it is not what is desired, will overwrite it
2433  * @param offset at what offset should we start the download (typically 0)
2434  * @param length how many bytes should be downloaded starting at offset
2435  * @param anonymity anonymity level to use for the download
2436  * @param options various download options
2437  * @param cctx initial value for the client context for this download
2438  * @return context that can be used to control this download
2439  */
2440 struct GNUNET_FS_DownloadContext *
2441 GNUNET_FS_download_start_from_search (struct GNUNET_FS_Handle *h,
2442                                       struct GNUNET_FS_SearchResult *sr,
2443                                       const char *filename,
2444                                       const char *tempname,
2445                                       uint64_t offset,
2446                                       uint64_t length,
2447                                       uint32_t anonymity,
2448                                       enum GNUNET_FS_DownloadOptions options,
2449                                       void *cctx);
2450
2451
2452 /**
2453  * Stop a download (aborts if download is incomplete).
2454  *
2455  * @param dc handle for the download
2456  * @param do_delete delete files of incomplete downloads
2457  */
2458 void
2459 GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc,
2460                          int do_delete);
2461
2462
2463 /**
2464  * Initialize collection.
2465  *
2466  * @param h handle to the file sharing subsystem
2467  * @param namespace namespace to use for the collection
2468  * @return GNUNET_OK on success, GNUNET_SYSERR if another
2469  *         namespace is already set for our collection
2470  */
2471 int
2472 GNUNET_FS_collection_start (struct GNUNET_FS_Handle *h,
2473                             struct GNUNET_FS_Namespace *namespace);
2474
2475
2476 /**
2477  * Stop collection.
2478  *
2479  * @param h handle to the file sharing subsystem
2480  * @return GNUNET_OK on success, GNUNET_SYSERR if no collection is active
2481  */
2482 int
2483 GNUNET_FS_collection_stop (struct GNUNET_FS_Handle *h);
2484
2485
2486 /**
2487  * Are we using a collection?
2488  *
2489  * @param h handle to the file sharing subsystem
2490  * @return NULL if there is no collection,
2491  */
2492 struct GNUNET_FS_Namespace *
2493 GNUNET_FS_collection_get(struct GNUNET_FS_Handle *h);
2494
2495
2496 /**
2497  * Publish an update of the current collection information to the
2498  * network now.  The function has no effect if the collection has not
2499  * changed since the last publication.  If we are currently not
2500  * collecting, this function does nothing.
2501  *
2502  * @param h handle to the file sharing subsystem
2503  */
2504 void GNUNET_FS_collection_publish (struct GNUNET_FS_Handle *h);
2505
2506
2507 /**
2508  * If we are currently building a collection, publish the given file
2509  * information in that collection.  If we are currently not
2510  * collecting, this function does nothing.
2511  *
2512  * @param h handle to the file sharing subsystem
2513  * @param uri uri to add to the collection
2514  * @param meta metadata for the uri
2515  */
2516 void GNUNET_FS_collection_add (const struct GNUNET_FS_Handle *h,
2517                                const struct GNUNET_FS_Uri *uri,
2518                                const struct GNUNET_CONTAINER_MetaData *meta);
2519
2520
2521
2522
2523
2524 /* ******************** Directory API *********************** */
2525
2526
2527 #define GNUNET_FS_DIRECTORY_MIME  "application/gnunet-directory"
2528 #define GNUNET_FS_DIRECTORY_MAGIC "\211GND\r\n\032\n"
2529 #define GNUNET_FS_DIRECTORY_EXT   ".gnd"
2530
2531 /**
2532  * Does the meta-data claim that this is a directory?
2533  * Checks if the mime-type is that of a GNUnet directory.
2534  *
2535  * @return GNUNET_YES if it is, GNUNET_NO if it is not, GNUNET_SYSERR if
2536  *  we have no mime-type information (treat as 'GNUNET_NO')
2537  */
2538 int
2539 GNUNET_FS_meta_data_test_for_directory (const struct GNUNET_CONTAINER_MetaData *md);
2540
2541
2542 /**
2543  * Set the MIMETYPE information for the given
2544  * metadata to "application/gnunet-directory".
2545  *
2546  * @param md metadata to add mimetype to
2547  */
2548 void
2549 GNUNET_FS_meta_data_make_directory (struct GNUNET_CONTAINER_MetaData *md);
2550
2551
2552 /**
2553  * Suggest a filename based on given metadata.
2554  *
2555  * @param md given meta data
2556  * @return NULL if meta data is useless for suggesting a filename
2557  */
2558 char *
2559 GNUNET_FS_meta_data_suggest_filename (const struct GNUNET_CONTAINER_MetaData *md);
2560
2561
2562 /**
2563  * Function used to process entries in a directory.
2564  *
2565  * @param cls closure
2566  * @param filename name of the file in the directory
2567  * @param uri URI of the file
2568  * @param metadata metadata for the file; metadata for
2569  *        the directory if everything else is NULL/zero
2570  * @param length length of the available data for the file
2571  *           (of type size_t since data must certainly fit
2572  *            into memory; if files are larger than size_t
2573  *            permits, then they will certainly not be
2574  *            embedded with the directory itself).
2575  * @param data data available for the file (length bytes)
2576  */
2577 typedef void (*GNUNET_FS_DirectoryEntryProcessor)(void *cls,
2578                                                   const char *filename,
2579                                                   const struct GNUNET_FS_Uri *uri,
2580                                                   const struct GNUNET_CONTAINER_MetaData *meta,
2581                                                   size_t length,
2582                                                   const void *data);
2583
2584
2585 /**
2586  * Iterate over all entries in a directory.  Note that directories
2587  * are structured such that it is possible to iterate over the
2588  * individual blocks as well as over the entire directory.  Thus
2589  * a client can call this function on the buffer in the
2590  * GNUNET_FS_ProgressCallback.  Also, directories can optionally
2591  * include the contents of (small) files embedded in the directory
2592  * itself; for those files, the processor may be given the
2593  * contents of the file directly by this function.
2594  *
2595  * @param size number of bytes in data
2596  * @param data pointer to the beginning of the directory
2597  * @param offset offset of data in the directory
2598  * @param dep function to call on each entry
2599  * @param dep_cls closure for dep
2600  */
2601 void
2602 GNUNET_FS_directory_list_contents (size_t size,
2603                                    const void *data,
2604                                    uint64_t offset,
2605                                    GNUNET_FS_DirectoryEntryProcessor dep,
2606                                    void *dep_cls);
2607
2608
2609 /**
2610  * Opaque handle to a directory builder.
2611  */
2612 struct GNUNET_FS_DirectoryBuilder;
2613
2614 /**
2615  * Create a directory builder.
2616  *
2617  * @param mdir metadata for the directory
2618  */
2619 struct GNUNET_FS_DirectoryBuilder *
2620 GNUNET_FS_directory_builder_create (const struct GNUNET_CONTAINER_MetaData *mdir);
2621
2622
2623 /**
2624  * Add an entry to a directory.
2625  *
2626  * @param bld directory to extend
2627  * @param uri uri of the entry (must not be a KSK)
2628  * @param md metadata of the entry
2629  * @param data raw data of the entry, can be NULL, otherwise
2630  *        data must point to exactly the number of bytes specified
2631  *        by the uri
2632  */
2633 void
2634 GNUNET_FS_directory_builder_add (struct GNUNET_FS_DirectoryBuilder *bld,
2635                                  const struct GNUNET_FS_Uri *uri,
2636                                  const struct GNUNET_CONTAINER_MetaData *md,
2637                                  const void *data);
2638
2639
2640 /**
2641  * Finish building the directory.  Frees the
2642  * builder context and returns the directory
2643  * in-memory.
2644  *
2645  * @param bld directory to finish
2646  * @param rsize set to the number of bytes needed
2647  * @param rdata set to the encoded directory
2648  * @return GNUNET_OK on success
2649  */
2650 int
2651 GNUNET_FS_directory_builder_finish (struct GNUNET_FS_DirectoryBuilder *bld,
2652                                     size_t *rsize,
2653                                     void **rdata);
2654
2655
2656 #if 0                           /* keep Emacsens' auto-indent happy */
2657 {
2658 #endif
2659 #ifdef __cplusplus
2660 }
2661 #endif
2662
2663
2664 #endif