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        * FIXME: rename to 'pc'.
 753        */
 754       struct GNUNET_FS_PublishContext *sc;
 755
 756       /**
 757        * Information about the file that is being publishd.
 758        */
 759       const struct GNUNET_FS_FileInformation *fi;
 760
 761       /**
 762        * Client context pointer (set the last time by the client for
 763        * this operation; initially NULL on START/RESUME events).
 764        */
 765       void *cctx;
 766
 767       /**
 768        * Client context pointer for the parent operation
 769        * (if this is a file in a directory or a subdirectory).
 770        */
 771       void *pctx;
 772
 773       /**
 774        * Name of the file being published; can be NULL.
 775        */
 776       const char *filename;
 777
 778       /**
 779        * How large is the file overall?  For directories,
 780        * this is only the size of the directory itself,
 781        * not of the other files contained within the
 782        * directory.
 783        */
 784       uint64_t size;
 785
 786       /**
 787        * At what time do we expect to finish the upload?
 788        * (will be a value in the past for completed
 789        * uploads).
 790        */
 791       struct GNUNET_TIME_Relative eta;
 792
 793       /**
 794        * How long has this upload been actively running
 795        * (excludes times where the upload was suspended).
 796        */
 797       struct GNUNET_TIME_Relative duration;
 798
 799       /**
 800        * How many bytes have we completed?
 801        */
 802       uint64_t completed;
 803
 804       /**
 805        * What anonymity level is used for this upload?
 806        */
 807       uint32_t anonymity;
 808
 809       /**
 810        * Additional values for specific events.
 811        */
 812       union {
 813
 814         /**
 815          * These values are only valid for
 816          * GNUNET_FS_STATUS_PUBLISH_PROGRESS events.
 817          */
 818         struct {
 819
 820           /**
 821            * Data block we just published.
 822            */
 823           const void *data;
 824
 825           /**
 826            * At what offset in the file is "data"?
 827            */
 828           uint64_t offset;
 829
 830           /**
 831            * Length of the data block.
 832            */
 833           uint64_t data_len;
 834
 835           /**
 836            * Depth of the given block in the tree;
 837            * 0 would be the highest level (the first
 838            * call is guaranteed to be for the lowest
 839            * level).
 840            */
 841           unsigned int depth;
 842
 843         } progress;
 844
 845         /**
 846          * These values are only valid for
 847          * GNUNET_FS_STATUS_PUBLISH_RESUME events.
 848          */
 849         struct {
 850
 851           /**
 852            * Error message, NULL if no error was encountered so far.
 853            */
 854           const char *message;
 855
 856           /**
 857            * URI of the file (if the download had been completed)
 858            */
 859           const struct GNUNET_FS_Uri *chk_uri;
 860
 861         } resume;
 862
 863         /**
 864          * These values are only valid for
 865          * GNUNET_FS_STATUS_PUBLISH_COMPLETED events.
 866          */
 867         struct {
 868
 869           /**
 870            * URI of the file.
 871            */
 872           const struct GNUNET_FS_Uri *chk_uri;
 873
 874         } completed;
 875
 876         /**
 877          * These values are only valid for
 878          * GNUNET_FS_STATUS_PUBLISH_ERROR events.
 879          */
 880         struct {
 881
 882           /**
 883            * Error message, never NULL.
 884            */
 885           const char *message;
 886
 887         } error;
 888
 889       } specifics;
 890
 891     } publish;
 892
 893
 894     /**
 895      * Values for all "GNUNET_FS_STATUS_DOWNLOAD_*" events.
 896      */
 897     struct {
 898
 899       /**
 900        * Context for controlling the download.
 901        */
 902       struct GNUNET_FS_DownloadContext *dc;
 903
 904       /**
 905        * Client context pointer (set the last time
 906        * by the client for this operation; initially
 907        * NULL on START/RESUME events).
 908        */
 909       void *cctx;
 910
 911       /**
 912        * Client context pointer for the parent operation
 913        * (if this is a file in a directory or a subdirectory).
 914        */
 915       void *pctx;
 916
 917       /**
 918        * Client context pointer for the associated search operation
 919        * (specifically, context pointer for the specific search
 920        * result, not the overall search); only set if this
 921        * download was started from a search result.
 922        */
 923       void *sctx;
 924
 925       /**
 926        * URI used for this download.
 927        */
 928       const struct GNUNET_FS_Uri *uri;
 929
 930       /**
 931        * Name of the file that we are downloading.
 932        */
 933       const char *filename;
 934
 935       /**
 936        * How large is the download overall?  This
 937        * is NOT necessarily the size from the
 938        * URI since we may be doing a partial download.
 939        */
 940       uint64_t size;
 941
 942       /**
 943        * At what time do we expect to finish the download?
 944        * (will be a value in the past for completed
 945        * uploads).
 946        */
 947       struct GNUNET_TIME_Relative eta;
 948
 949       /**
 950        * How long has this download been active?
 951        */
 952       struct GNUNET_TIME_Relative duration;
 953
 954       /**
 955        * How many bytes have we completed?
 956        */
 957       uint64_t completed;
 958
 959       /**
 960        * What anonymity level is used for this download?
 961        */
 962       uint32_t anonymity;
 963
 964       /**
 965        * Additional values for specific events.
 966        */
 967       union {
 968
 969         /**
 970          * These values are only valid for
 971          * GNUNET_FS_STATUS_DOWNLOAD_PROGRESS events.
 972          */
 973         struct {
 974
 975           /**
 976            * Data block we just obtained.
 977            */
 978           const void *data;
 979
 980           /**
 981            * At what offset in the file is "data"?
 982            */
 983           uint64_t offset;
 984
 985           /**
 986            * Length of the data block.
 987            */
 988           uint64_t data_len;
 989
 990           /**
 991            * Depth of the given block in the tree;
 992            * 0 would be the highest level (the first
 993            * call is guaranteed to be for the lowest
 994            * level).
 995            */
 996           unsigned int depth;
 997
 998         } progress;
 999
1000         /**
1001          * These values are only valid for
1002          * GNUNET_FS_STATUS_DOWNLOAD_START events.
1003          */
1004         struct {
1005
1006           /**
1007            * Known metadata for the download.
1008            */
1009           const struct GNUNET_CONTAINER_MetaData *meta;
1010
1011         } start;
1012
1013         /**
1014          * These values are only valid for
1015          * GNUNET_FS_STATUS_DOWNLOAD_RESUME events.
1016          */
1017         struct {
1018
1019           /**
1020            * Known metadata for the download.
1021            */
1022           const struct GNUNET_CONTAINER_MetaData *meta;
1023
1024           /**
1025            * Error message, NULL if we have not encountered any error yet.
1026            */
1027           const char *message;
1028
1029         } resume;
1030
1031         /**
1032          * These values are only valid for
1033          * GNUNET_FS_STATUS_DOWNLOAD_ERROR events.
1034          */
1035         struct {
1036
1037           /**
1038            * Error message.
1039            */
1040           const char *message;
1041
1042         } error;
1043
1044       } specifics;
1045
1046     } download;
1047
1048     /**
1049      * Values for all "GNUNET_FS_STATUS_SEARCH_*" events.
1050      */
1051     struct {
1052
1053       /**
1054        * Context for controlling the search, NULL for
1055        * searches that were not explicitly triggered
1056        * by the client (i.e., searches for updates in
1057        * namespaces).
1058        */
1059       struct GNUNET_FS_SearchContext *sc;
1060
1061       /**
1062        * Client context pointer (set the last time by the client for
1063        * this operation; initially NULL on START/RESUME events).  Note
1064        * that this value can only be set on START/RESUME; returning
1065        * non-NULL on RESULT/RESUME_RESULT will actually update the
1066        * private context for "UPDATE" events.
1067        */
1068       void *cctx;
1069
1070       /**
1071        * Client parent-context pointer; NULL for top-level searches,
1072        * refers to the client context of the associated search result
1073        * for automatically triggered searches for updates in
1074        * namespaces.  In this case, 'presult' refers to that search
1075        * result.
1076        */
1077       void *pctx;
1078
1079       /**
1080        * What query is used for this search
1081        * (list of keywords or SKS identifier).
1082        */
1083       const struct GNUNET_FS_Uri *query;
1084
1085       /**
1086        * How long has this search been actively running
1087        * (excludes times where the search was paused or
1088        * suspended).
1089        */
1090       struct GNUNET_TIME_Relative duration;
1091
1092       /**
1093        * What anonymity level is used for this search?
1094        */
1095       uint32_t anonymity;
1096
1097       /**
1098        * Additional values for specific events.
1099        */
1100       union {
1101
1102         /**
1103          * These values are only valid for
1104          * GNUNET_FS_STATUS_SEARCH_RESULT events.
1105          */
1106         struct {
1107
1108           /**
1109            * Metadata for the search result.
1110            */
1111           const struct GNUNET_CONTAINER_MetaData *meta;
1112
1113           /**
1114            * URI for the search result.
1115            */
1116           const struct GNUNET_FS_Uri *uri;
1117
1118           /**
1119            * Handle to the result (for starting downloads).
1120            */
1121           struct GNUNET_FS_SearchResult *result;
1122
1123           /**
1124            * Applicability rank (the larger, the better the result
1125            * fits the search criteria).
1126            */
1127           uint32_t applicability_rank;
1128
1129         } result;
1130
1131         /**
1132          * These values are only valid for
1133          * GNUNET_FS_STATUS_SEARCH_RESUME_RESULT events.
1134          */
1135         struct {
1136
1137           /**
1138            * Metadata for the search result.
1139            */
1140           const struct GNUNET_CONTAINER_MetaData *meta;
1141
1142           /**
1143            * URI for the search result.
1144            */
1145           const struct GNUNET_FS_Uri *uri;
1146
1147           /**
1148            * Handle to the result (for starting downloads).
1149            */
1150           struct GNUNET_FS_SearchResult *result;
1151
1152           /**
1153            * Current availability rank (negative:
1154            * unavailable, positive: available)
1155            */
1156           int32_t availability_rank;
1157
1158           /**
1159            * On how many total queries is the given
1160            * availability_rank based?
1161            */
1162           uint32_t availability_certainty;
1163
1164           /**
1165            * Updated applicability rank (the larger,
1166            * the better the result fits the search
1167            * criteria).
1168            */
1169           uint32_t applicability_rank;
1170
1171         } resume_result;
1172
1173         /**
1174          * These values are only valid for
1175          * GNUNET_FS_STATUS_SEARCH_UPDATE events.
1176          */
1177         struct {
1178
1179           /**
1180            * Private context set for for this result
1181            * during the "RESULT" event.
1182            */
1183           void *cctx;
1184
1185           /**
1186            * Metadata for the search result.
1187            */
1188           const struct GNUNET_CONTAINER_MetaData *meta;
1189
1190           /**
1191            * URI for the search result.
1192            */
1193           const struct GNUNET_FS_Uri *uri;
1194
1195           /**
1196            * Current availability rank (negative:
1197            * unavailable, positive: available)
1198            */
1199           int32_t availability_rank;
1200
1201           /**
1202            * On how many total queries is the given
1203            * availability_rank based?
1204            */
1205           uint32_t availability_certainty;
1206
1207           /**
1208            * Updated applicability rank (the larger,
1209            * the better the result fits the search
1210            * criteria).
1211            */
1212           uint32_t applicability_rank;
1213
1214         } update;
1215
1216         /**
1217          * These values are only valid for
1218          * GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND events.
1219          * These events are automatically triggered for
1220          * each search result before the
1221          * GNUNET_FS_STATUS_SEARCH_SUSPEND event.  This
1222          * happens primarily to give the client a chance
1223          * to clean up the "cctx" (if needed).
1224          */
1225         struct {
1226
1227           /**
1228            * Private context set for for this result
1229            * during the "RESULT" event.
1230            */
1231           void *cctx;
1232
1233           /**
1234            * Metadata for the search result.
1235            */
1236           const struct GNUNET_CONTAINER_MetaData *meta;
1237
1238           /**
1239            * URI for the search result.
1240            */
1241           const struct GNUNET_FS_Uri *uri;
1242
1243         } result_suspend;
1244
1245         /**
1246          * These values are only valid for
1247          * GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED events.
1248          * These events are automatically triggered for
1249          * each search result before the
1250          * GNUNET_FS_STATUS_SEARCH_STOPPED event.  This
1251          * happens primarily to give the client a chance
1252          * to clean up the "cctx" (if needed).
1253          */
1254         struct {
1255
1256           /**
1257            * Private context set for for this result
1258            * during the "RESULT" event.
1259            */
1260           void *cctx;
1261
1262           /**
1263            * Metadata for the search result.
1264            */
1265           const struct GNUNET_CONTAINER_MetaData *meta;
1266
1267           /**
1268            * URI for the search result.
1269            */
1270           const struct GNUNET_FS_Uri *uri;
1271
1272         } result_stopped;
1273
1274         /**
1275          * These values are only valid for
1276          * GNUNET_FS_STATUS_SEARCH_RESUME events.
1277          */
1278         struct {
1279
1280           /**
1281            * Error message, NULL if we have not encountered any error yet.
1282            */
1283           const char *message;
1284
1285           /**
1286            * Is this search currently paused?
1287            */
1288           int is_paused;
1289
1290         } resume;
1291
1292         /**
1293          * These values are only valid for
1294          * GNUNET_FS_STATUS_SEARCH_ERROR events.
1295          */
1296         struct {
1297
1298           /**
1299            * Error message.
1300            */
1301           const char *message;
1302
1303         } error;
1304
1305         /**
1306          * Values for all "GNUNET_FS_STATUS_SEARCH_RESULT_NAMESPACE" events.
1307          */
1308         struct {
1309
1310           /**
1311            * Handle to the namespace (NULL if it is not a local
1312            * namespace).
1313            */
1314           struct GNUNET_FS_Namespace *ns;
1315
1316           /**
1317            * Short, human-readable name of the namespace.
1318            */
1319           const char *name;
1320
1321           /**
1322            * Root identifier for the namespace, can be NULL.
1323            */
1324           const char *root;
1325
1326           /**
1327            * Metadata for the namespace.
1328            */
1329           const struct GNUNET_CONTAINER_MetaData *meta;
1330
1331           /**
1332            * Hash-identifier for the namespace.
1333            */
1334           GNUNET_HashCode id;
1335
1336         } namespace;
1337
1338       } specifics;
1339
1340     } search;
1341
1342     /**
1343      * Values for all "GNUNET_FS_STATUS_UNINDEX_*" events.
1344      */
1345     struct {
1346
1347       /**
1348        * Context for controlling the unindexing.
1349        */
1350       struct GNUNET_FS_UnindexContext *uc;
1351
1352       /**
1353        * Client context pointer (set the last time
1354        * by the client for this operation; initially
1355        * NULL on START/RESUME events).
1356        */
1357       void *cctx;
1358
1359       /**
1360        * Name of the file that is being unindexed.
1361        */
1362       const char *filename;
1363
1364       /**
1365        * How large is the file overall?
1366        */
1367       uint64_t size;
1368
1369       /**
1370        * At what time do we expect to finish unindexing?
1371        * (will be a value in the past for completed
1372        * unindexing opeations).
1373        */
1374       struct GNUNET_TIME_Relative eta;
1375
1376       /**
1377        * How long has this upload been actively running
1378        * (excludes times where the upload was suspended).
1379        */
1380       struct GNUNET_TIME_Relative duration;
1381
1382       /**
1383        * How many bytes have we completed?
1384        */
1385       uint64_t completed;
1386
1387       /**
1388        * Additional values for specific events.
1389        */
1390       union {
1391
1392         /**
1393          * These values are only valid for
1394          * GNUNET_FS_STATUS_UNINDEX_PROGRESS events.
1395          */
1396         struct {
1397
1398           /**
1399            * Data block we just unindexed.
1400            */
1401           const void *data;
1402
1403           /**
1404            * At what offset in the file is "data"?
1405            */
1406           uint64_t offset;
1407
1408           /**
1409            * Length of the data block.
1410            */
1411           uint64_t data_len;
1412
1413           /**
1414            * Depth of the given block in the tree;
1415            * 0 would be the highest level (the first
1416            * call is guaranteed to be for the lowest
1417            * level).
1418            */
1419           unsigned int depth;
1420
1421         } progress;
1422
1423         /**
1424          * These values are only valid for
1425          * GNUNET_FS_STATUS_UNINDEX_RESUME events.
1426          */
1427         struct {
1428
1429           /**
1430            * Error message, NULL if we have not encountered any error yet.
1431            */
1432           const char *message;
1433
1434         } resume;
1435
1436         /**
1437          * These values are only valid for
1438          * GNUNET_FS_STATUS_UNINDEX_ERROR events.
1439          */
1440         struct {
1441
1442           /**
1443            * Error message.
1444            */
1445           const char *message;
1446
1447         } error;
1448
1449       } specifics;
1450
1451     } unindex;
1452
1453   } value;
1454
1455   /**
1456    * Specific status code (determines the event type).
1457    */
1458   enum GNUNET_FS_Status status;
1459
1460 };
1461
1462
1463 /**
1464  * Notification of FS to a client about the progress of an
1465  * operation.  Callbacks of this type will be used for uploads,
1466  * downloads and searches.  Some of the arguments depend a bit
1467  * in their meaning on the context in which the callback is used.
1468  *
1469  * @param cls closure
1470  * @param info details about the event, specifying the event type
1471  *        and various bits about the event
1472  * @return client-context (for the next progress call
1473  *         for this operation; should be set to NULL for
1474  *         SUSPEND and STOPPED events).  The value returned
1475  *         will be passed to future callbacks in the respective
1476  *         field in the GNUNET_FS_ProgressInfo struct.
1477  */
1478 typedef void* (*GNUNET_FS_ProgressCallback)
1479   (void *cls,
1480    const struct GNUNET_FS_ProgressInfo *info);
1481
1482
1483 /**
1484  * General (global) option flags for file-sharing.
1485  */
1486 enum GNUNET_FS_Flags
1487   {
1488     /**
1489      * No special flags set.
1490      */
1491     GNUNET_FS_FLAGS_NONE = 0,
1492
1493     /**
1494      * Is persistence of operations desired?
1495      * (will create SUSPEND/RESUME events).
1496      */
1497     GNUNET_FS_FLAGS_PERSISTENCE = 1,
1498
1499     /**
1500      * Should we automatically trigger probes for search results
1501      * to determine availability?
1502      * (will create GNUNET_FS_STATUS_SEARCH_UPDATE events).
1503      */
1504     GNUNET_FS_FLAGS_DO_PROBES = 2
1505
1506   };
1507
1508 /**
1509  * Options specified in the VARARGs portion of GNUNET_FS_start.
1510  */
1511 enum GNUNET_FS_OPTIONS
1512   {
1513
1514     /**
1515      * Last option in the VARARG list.
1516      */
1517     GNUNET_FS_OPTIONS_END = 0,
1518
1519     /**
1520      * Select the desired amount of parallelism (this option should be
1521      * followed by an "unsigned int" giving the desired maximum number
1522      * of parallel downloads).
1523      */
1524     GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM = 1,
1525
1526     /**
1527      * Maximum number of requests that should be pending at a given
1528      * point in time (invidivual downloads may go above this, but
1529      * if we are above this threshold, we should not activate any
1530      * additional downloads.
1531      */
1532     GNUNET_FS_OPTIONS_REQUEST_PARALLELISM = 2
1533
1534   };
1535
1536
1537 /**
1538  * Handle to the file-sharing service.
1539  */
1540 struct GNUNET_FS_Handle;
1541
1542
1543 /**
1544  * Setup a connection to the file-sharing service.
1545  *
1546  * @param sched scheduler to use
1547  * @param cfg configuration to use
1548  * @param client_name unique identifier for this client
1549  * @param upcb function to call to notify about FS actions
1550  * @param upcb_cls closure for upcb
1551  * @param flags specific attributes for fs-operations
1552  * @param ... list of optional options, terminated with GNUNET_FS_OPTIONS_END
1553  * @return NULL on error
1554  */
1555 struct GNUNET_FS_Handle *
1556 GNUNET_FS_start (struct GNUNET_SCHEDULER_Handle *sched,
1557                  const struct GNUNET_CONFIGURATION_Handle *cfg,
1558                  const char *client_name,
1559                  GNUNET_FS_ProgressCallback upcb,
1560                  void *upcb_cls,
1561                  enum GNUNET_FS_Flags flags,
1562                  ...);
1563
1564
1565 /**
1566  * Close our connection with the file-sharing service.
1567  * The callback given to GNUNET_FS_start will no longer be
1568  * called after this function returns.
1569  *
1570  * @param h handle that was returned from GNUNET_FS_start
1571  */
1572 void
1573 GNUNET_FS_stop (struct GNUNET_FS_Handle *h);
1574
1575
1576 /**
1577  * Extract meta-data from a file.
1578  *
1579  * @param md metadata to set
1580  * @param filename name of file to inspect
1581  * @param extractors plugins to use
1582  * @return GNUNET_SYSERR on error, otherwise the number
1583  *   of meta-data items obtained
1584  */
1585 int
1586 GNUNET_FS_meta_data_extract_from_file (struct
1587                                        GNUNET_CONTAINER_MetaData
1588                                        *md, const char *filename,
1589                                        struct EXTRACTOR_PluginList *
1590                                        extractors);
1591
1592
1593 /**
1594  * Function called on entries in a GNUNET_FS_FileInformation publish-structure.
1595  *
1596  * @param cls closure
1597  * @param fi the entry in the publish-structure
1598  * @param length length of the file or directory
1599  * @param meta metadata for the file or directory (can be modified)
1600  * @param uri pointer to the keywords that will be used for this entry (can be modified)
1601  * @param anonymity pointer to selected anonymity level (can be modified)
1602  * @param priority pointer to selected priority (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                                                   struct GNUNET_TIME_Absolute *expirationTime,
1617                                                   void **client_info);
1618
1619
1620 /**
1621  * Obtain the name under which this file information
1622  * structure is stored on disk.  Only works for top-level
1623  * file information structures.
1624  *
1625  * @param s structure to get the filename for
1626  * @return NULL on error, otherwise filename that
1627  *         can be passed to "GNUNET_FS_file_information_recover"
1628  *         to read this fi-struct from disk.
1629  */
1630 const char *
1631 GNUNET_FS_file_information_get_id (struct GNUNET_FS_FileInformation *s);
1632
1633
1634
1635 /**
1636  * Create an entry for a file in a publish-structure.
1637  *
1638  * @param h handle to the file sharing subsystem
1639  * @param client_info initial client-info value for this entry
1640  * @param filename name of the file or directory to publish
1641  * @param keywords under which keywords should this file be available
1642  *         directly; can be NULL
1643  * @param meta metadata for the file
1644  * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1645  *                GNUNET_SYSERR for simulation
1646  * @param anonymity what is the desired anonymity level for sharing?
1647  * @param priority what is the priority for OUR node to
1648  *   keep this file available?  Use 0 for maximum anonymity and
1649  *   minimum reliability...
1650  * @param expirationTime when should this content expire?
1651  * @return publish structure entry for the file
1652  */
1653 struct GNUNET_FS_FileInformation *
1654 GNUNET_FS_file_information_create_from_file (struct GNUNET_FS_Handle *h,
1655                                              void *client_info,
1656                                              const char *filename,
1657                                              const struct GNUNET_FS_Uri *keywords,
1658                                              const struct GNUNET_CONTAINER_MetaData *meta,
1659                                              int do_index,
1660                                              uint32_t anonymity,
1661                                              uint32_t priority,
1662                                              struct GNUNET_TIME_Absolute expirationTime);
1663
1664
1665 /**
1666  * Create an entry for a file in a publish-structure.
1667  *
1668  * @param h handle to the file sharing subsystem
1669  * @param client_info initial client-info value for this entry
1670  * @param length length of the file
1671  * @param data data for the file (should not be used afterwards by
1672  *        the caller; callee will "free")
1673  * @param keywords under which keywords should this file be available
1674  *         directly; can be NULL
1675  * @param meta metadata for the file
1676  * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1677  *                GNUNET_SYSERR for simulation
1678  * @param anonymity what is the desired anonymity level for sharing?
1679  * @param priority what is the priority for OUR node to
1680  *   keep this file available?  Use 0 for maximum anonymity and
1681  *   minimum reliability...
1682  * @param expirationTime when should this content expire?
1683  * @return publish structure entry for the file
1684  */
1685 struct GNUNET_FS_FileInformation *
1686 GNUNET_FS_file_information_create_from_data (struct GNUNET_FS_Handle *h,
1687                                              void *client_info,
1688                                              uint64_t length,
1689                                              void *data,
1690                                              const struct GNUNET_FS_Uri *keywords,
1691                                              const struct GNUNET_CONTAINER_MetaData *meta,
1692                                              int do_index,
1693                                              uint32_t anonymity,
1694                                              uint32_t priority,
1695                                              struct GNUNET_TIME_Absolute expirationTime);
1696
1697
1698 /**
1699  * Function that provides data.
1700  *
1701  * @param cls closure
1702  * @param offset offset to read from; it is possible
1703  *            that the caller might need to go backwards
1704  *            a bit at times
1705  * @param max maximum number of bytes that should be
1706  *            copied to buf; readers are not allowed
1707  *            to provide less data unless there is an error;
1708  *            a value of "0" will be used at the end to allow
1709  *            the reader to clean up its internal state
1710  * @param buf where the reader should write the data
1711  * @param emsg location for the reader to store an error message
1712  * @return number of bytes written, usually "max", 0 on error
1713  */
1714 typedef size_t (*GNUNET_FS_DataReader)(void *cls,
1715                                        uint64_t offset,
1716                                        size_t max,
1717                                        void *buf,
1718                                        char **emsg);
1719
1720
1721 /**
1722  * Create an entry for a file in a publish-structure.
1723  *
1724  * @param h handle to the file sharing subsystem
1725  * @param client_info initial client-info value for this entry
1726  * @param length length of the file
1727  * @param reader function that can be used to obtain the data for the file
1728  * @param reader_cls closure for "reader"
1729  * @param keywords under which keywords should this file be available
1730  *         directly; can be NULL
1731  * @param meta metadata for the file
1732  * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
1733  *                GNUNET_SYSERR for simulation
1734  * @param anonymity what is the desired anonymity level for sharing?
1735  * @param priority what is the priority for OUR node to
1736  *   keep this file available?  Use 0 for maximum anonymity and
1737  *   minimum reliability...
1738  * @param expirationTime when should this content expire?
1739  * @return publish structure entry for the file
1740  */
1741 struct GNUNET_FS_FileInformation *
1742 GNUNET_FS_file_information_create_from_reader (struct GNUNET_FS_Handle *h,
1743                                                void *client_info,
1744                                                uint64_t length,
1745                                                GNUNET_FS_DataReader reader,
1746                                                void *reader_cls,
1747                                                const struct GNUNET_FS_Uri *keywords,
1748                                                const struct GNUNET_CONTAINER_MetaData *meta,
1749                                                int do_index,
1750                                                uint32_t anonymity,
1751                                                uint32_t priority,
1752                                                struct GNUNET_TIME_Absolute expirationTime);
1753
1754
1755 /**
1756  * Function that a "GNUNET_FS_DirectoryScanner" should call
1757  * for each entry in the directory.
1758  *
1759  * @param cls closure
1760  * @param filename name of the file (including path); must end
1761  *          in a "/" (even on W32) if this is a directory
1762  * @param fi information about the file (should not be
1763  *        used henceforth by the caller)
1764  */
1765 typedef void (*GNUNET_FS_FileProcessor)(void *cls,
1766                                         const char *filename,
1767                                         struct GNUNET_FS_FileInformation *fi);
1768
1769
1770 /**
1771  * Type of a function that will be used to scan a directory.
1772  *
1773  * @param cls closure
1774  * @param h handle to the file sharing subsystem
1775  * @param dirname name of the directory to scan
1776  * @param do_index should files be indexed or inserted
1777  * @param anonymity desired anonymity level
1778  * @param priority priority for publishing
1779  * @param expirationTime expiration for publication
1780  * @param proc function to call on each entry
1781  * @param proc_cls closure for proc
1782  * @param emsg where to store an error message (on errors)
1783  * @return GNUNET_OK on success
1784  */
1785 typedef int (*GNUNET_FS_DirectoryScanner)(void *cls,
1786                                           struct GNUNET_FS_Handle *h,
1787                                           const char *dirname,
1788                                           int do_index,
1789                                           uint32_t anonymity,
1790                                           uint32_t priority,
1791                                           struct GNUNET_TIME_Absolute expirationTime,
1792                                           GNUNET_FS_FileProcessor proc,
1793                                           void *proc_cls,
1794                                           char **emsg);
1795
1796
1797
1798 /**
1799  * Simple, useful default implementation of a directory scanner
1800  * (GNUNET_FS_DirectoryScanner).  This implementation expects to get a
1801  * UNIX filename, will publish all files in the directory except hidden
1802  * files (those starting with a ".").  Metadata will be extracted
1803  * using GNU libextractor; the specific list of plugins should be
1804  * specified in "cls", passing NULL will disable (!)  metadata
1805  * extraction.  Keywords will be derived from the metadata and be
1806  * subject to default canonicalization.  This is strictly a
1807  * convenience function.
1808  *
1809  * @param cls must be of type "struct EXTRACTOR_Extractor*"
1810  * @param h handle to the file sharing subsystem
1811  * @param dirname name of the directory to scan
1812  * @param do_index should files be indexed or inserted
1813  * @param anonymity desired anonymity level
1814  * @param priority priority for publishing
1815  * @param expirationTime expiration for publication
1816  * @param proc function called on each entry
1817  * @param proc_cls closure for proc
1818  * @param emsg where to store an error message (on errors)
1819  * @return GNUNET_OK on success
1820  */
1821 int
1822 GNUNET_FS_directory_scanner_default (void *cls,
1823                                      struct GNUNET_FS_Handle *h,
1824                                      const char *dirname,
1825                                      int do_index,
1826                                      uint32_t anonymity,
1827                                      uint32_t priority,
1828                                      struct GNUNET_TIME_Absolute expirationTime,
1829                                      GNUNET_FS_FileProcessor proc,
1830                                      void *proc_cls,
1831                                      char **emsg);
1832
1833
1834 /**
1835  * Create a publish-structure from an existing file hierarchy, inferring
1836  * and organizing keywords and metadata as much as possible.  This
1837  * function primarily performs the recursive build and re-organizes
1838  * keywords and metadata; for automatically getting metadata
1839  * extraction, scanning of directories and creation of the respective
1840  * GNUNET_FS_FileInformation entries the default scanner should be
1841  * passed (GNUNET_FS_directory_scanner_default).  This is strictly a
1842  * convenience function.
1843  *
1844  * @param h handle to the file sharing subsystem
1845  * @param client_info initial client-info value for this entry
1846  * @param filename name of the top-level file or directory
1847  * @param scanner function used to get a list of files in a directory
1848  * @param scanner_cls closure for scanner
1849  * @param do_index should files in the hierarchy be indexed?
1850  * @param anonymity what is the desired anonymity level for sharing?
1851  * @param priority what is the priority for OUR node to
1852  *   keep this file available?  Use 0 for maximum anonymity and
1853  *   minimum reliability...
1854  * @param expirationTime when should this content expire?
1855  * @param emsg where to store an error message
1856  * @return publish structure entry for the directory, NULL on error
1857  */
1858 struct GNUNET_FS_FileInformation *
1859 GNUNET_FS_file_information_create_from_directory (struct GNUNET_FS_Handle *h,
1860                                                   void *client_info,
1861                                                   const char *filename,
1862                                                   GNUNET_FS_DirectoryScanner scanner,
1863                                                   void *scanner_cls,
1864                                                   int do_index,
1865                                                   uint32_t anonymity,
1866                                                   uint32_t priority,
1867                                                   struct GNUNET_TIME_Absolute expirationTime,
1868                                                   char **emsg);
1869
1870
1871 /**
1872  * Create an entry for an empty directory in a publish-structure.
1873  * This function should be used by applications for which the
1874  * use of "GNUNET_FS_file_information_create_from_directory"
1875  * is not appropriate.
1876  *
1877  * @param h handle to the file sharing subsystem
1878  * @param client_info initial client-info value for this entry
1879  * @param keywords under which keywords should this directory be available
1880  *         directly; can be NULL
1881  * @param meta metadata for the directory
1882  * @param anonymity what is the desired anonymity level for sharing?
1883  * @param priority what is the priority for OUR node to
1884  *   keep this file available?  Use 0 for maximum anonymity and
1885  *   minimum reliability...
1886  * @param expirationTime when should this content expire?
1887  * @return publish structure entry for the directory , NULL on error
1888  */
1889 struct GNUNET_FS_FileInformation *
1890 GNUNET_FS_file_information_create_empty_directory (struct GNUNET_FS_Handle *h,
1891                                                    void *client_info,
1892                                                    const struct GNUNET_FS_Uri *keywords,
1893                                                    const struct GNUNET_CONTAINER_MetaData *meta,
1894                                                    uint32_t anonymity,
1895                                                    uint32_t priority,
1896                                                    struct GNUNET_TIME_Absolute expirationTime);
1897
1898
1899 /**
1900  * Add an entry to a directory in a publish-structure.  Clients
1901  * should never modify publish structures that were passed to
1902  * "GNUNET_FS_publish_start" already.
1903  *
1904  * @param dir the directory
1905  * @param ent the entry to add; the entry must not have been
1906  *            added to any other directory at this point and
1907  *            must not include "dir" in its structure
1908  * @return GNUNET_OK on success, GNUNET_SYSERR on error
1909  */
1910 int
1911 GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
1912                                 struct GNUNET_FS_FileInformation *ent);
1913
1914
1915 /**
1916  * Inspect a file or directory in a publish-structure.  Clients
1917  * should never modify publish structures that were passed to
1918  * "GNUNET_FS_publish_start" already.  When called on a directory,
1919  * this function will FIRST call "proc" with information about
1920  * the directory itself and then for each of the files in the
1921  * directory (but not for files in subdirectories).  When called
1922  * on a file, "proc" will be called exactly once (with information
1923  * about the specific file).
1924  *
1925  * @param dir the directory
1926  * @param proc function to call on each entry
1927  * @param proc_cls closure for proc
1928  */
1929 void
1930 GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir,
1931                                     GNUNET_FS_FileInformationProcessor proc,
1932                                     void *proc_cls);
1933
1934
1935 /**
1936  * Destroy publish-structure.  Clients should never destroy publish
1937  * structures that were passed to "GNUNET_FS_publish_start" already.
1938  *
1939  * @param fi structure to destroy
1940  * @param cleaner function to call on each entry in the structure
1941  *        (useful to clean up client_info); can be NULL; return
1942  *        values are ignored
1943  * @param cleaner_cls closure for cleaner
1944  */
1945 void
1946 GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi,
1947                                     GNUNET_FS_FileInformationProcessor cleaner,
1948                                     void *cleaner_cls);
1949
1950
1951 /**
1952  * Options for publishing.  Compatible options
1953  * can be OR'ed together.
1954  */
1955 enum GNUNET_FS_PublishOptions
1956   {
1957     /**
1958      * No options (use defaults for everything).
1959      */
1960     GNUNET_FS_PUBLISH_OPTION_NONE = 0,
1961
1962     /**
1963      * Simulate publishing.  With this option, no data will be stored
1964      * in the datastore.  Useful for computing URIs from files.
1965      */
1966     GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY = 1
1967   };
1968
1969 /**
1970  * Publish a file or directory.
1971  *
1972  * @param h handle to the file sharing subsystem
1973  * @param fi information about the file or directory structure to publish
1974  * @param namespace namespace to publish the file in, NULL for no namespace
1975  * @param nid identifier to use for the publishd content in the namespace
1976  *        (can be NULL, must be NULL if namespace is NULL)
1977  * @param nuid update-identifier that will be used for future updates
1978  *        (can be NULL, must be NULL if namespace or nid is NULL)
1979  * @param options options for the publication
1980  * @return context that can be used to control the publish operation
1981  */
1982 struct GNUNET_FS_PublishContext *
1983 GNUNET_FS_publish_start (struct GNUNET_FS_Handle *h,
1984                          struct GNUNET_FS_FileInformation *fi,
1985                          struct GNUNET_FS_Namespace *namespace,
1986                          const char *nid,
1987                          const char *nuid,
1988                          enum GNUNET_FS_PublishOptions options);
1989
1990
1991 /**
1992  * Stop a publication.  Will abort incomplete publications (but
1993  * not remove blocks that have already been published) or
1994  * simply clean up the state for completed publications.
1995  * Must NOT be called from within the event callback!
1996  *
1997  * @param pc context for the publication to stop
1998  */
1999 void
2000 GNUNET_FS_publish_stop (struct GNUNET_FS_PublishContext *pc);
2001
2002
2003 /**
2004  * Signature of a function called as the continuation of a KBlock or
2005  * SBlock publication.
2006  *
2007  * @param cls closure
2008  * @param uri URI under which the block is now available, NULL on error
2009  * @param emsg error message, NULL on success
2010  */
2011 typedef void (*GNUNET_FS_PublishContinuation)(void *cls,
2012                                               const struct GNUNET_FS_Uri *uri,
2013                                               const char *emsg);
2014
2015
2016 /**
2017  * Publish a KBlock on GNUnet.
2018  *
2019  * @param h handle to the file sharing subsystem
2020  * @param ksk_uri keywords to use
2021  * @param meta metadata to use
2022  * @param uri URI to refer to in the KBlock
2023  * @param expirationTime when the KBlock expires
2024  * @param anonymity anonymity level for the KBlock
2025  * @param priority priority for the KBlock
2026  * @param cont continuation
2027  * @param cont_cls closure for cont
2028  */
2029 void
2030 GNUNET_FS_publish_ksk (struct GNUNET_FS_Handle *h,
2031                        const struct GNUNET_FS_Uri *ksk_uri,
2032                        const struct GNUNET_CONTAINER_MetaData *meta,
2033                        const struct GNUNET_FS_Uri *uri,
2034                        struct GNUNET_TIME_Absolute expirationTime,
2035                        uint32_t anonymity,
2036                        uint32_t priority,
2037                        enum GNUNET_FS_PublishOptions options,
2038                        GNUNET_FS_PublishContinuation cont,
2039                        void *cont_cls);
2040
2041
2042 /**
2043  * Publish an SBlock on GNUnet.
2044  *
2045  * @param h handle to the file sharing subsystem
2046  * @param namespace namespace to publish in
2047  * @param identifier identifier to use
2048  * @param update update identifier to use
2049  * @param meta metadata to use
2050  * @param uri URI to refer to in the SBlock
2051  * @param expirationTime when the SBlock expires
2052  * @param anonymity anonymity level for the SBlock
2053  * @param priority priority for the SBlock
2054  * @param cont continuation
2055  * @param cont_cls closure for cont
2056  */
2057 void
2058 GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
2059                        struct GNUNET_FS_Namespace *namespace,
2060                        const char *identifier,
2061                        const char *update,
2062                        const struct GNUNET_CONTAINER_MetaData *meta,
2063                        const struct GNUNET_FS_Uri *uri,
2064                        struct GNUNET_TIME_Absolute expirationTime,
2065                        uint32_t anonymity,
2066                        uint32_t priority,
2067                        enum GNUNET_FS_PublishOptions options,
2068                        GNUNET_FS_PublishContinuation cont,
2069                        void *cont_cls);
2070
2071
2072 /**
2073  * Type of a function called by "GNUNET_FS_get_indexed_files".
2074  *
2075  * @param cls closure
2076  * @param filename the name of the file
2077  * @param file_id hash of the contents of the indexed file
2078  * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
2079  */
2080 typedef int (*GNUNET_FS_IndexedFileProcessor) (void *cls,
2081                                                const char *filename,
2082                                                const GNUNET_HashCode *file_id);
2083
2084
2085 /**
2086  * Iterate over all indexed files.
2087  *
2088  * @param h handle to the file sharing subsystem
2089  * @param iterator function to call on each indexed file
2090  * @param iterator_cls closure for iterator
2091  * @param cont continuation to call when done;
2092  *             reason should be "TIMEOUT" (on
2093  *             error) or  "PREREQ_DONE" (on success)
2094  * @param cont_cls closure for cont
2095  */
2096 void
2097 GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
2098                              GNUNET_FS_IndexedFileProcessor iterator,
2099                              void *iterator_cls,
2100                              GNUNET_SCHEDULER_Task cont,
2101                              void *cont_cls);
2102
2103
2104 /**
2105  * Unindex a file.
2106  *
2107  * @param h handle to the file sharing subsystem
2108  * @param filename file to unindex
2109  * @param cctx initial value for the client context
2110  * @return NULL on error, otherwise handle
2111  */
2112 struct GNUNET_FS_UnindexContext *
2113 GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h,
2114                          const char *filename,
2115                          void *cctx);
2116
2117
2118 /**
2119  * Clean up after completion of an unindex operation.
2120  *
2121  * @param uc handle
2122  */
2123 void
2124 GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc);
2125
2126
2127 /**
2128  * Publish an advertismement for a namespace.
2129  *
2130  * @param h handle to the file sharing subsystem
2131  * @param ksk_uri keywords to use for advertisment
2132  * @param namespace handle for the namespace that should be advertised
2133  * @param meta meta-data for the namespace advertisement
2134  * @param anonymity for the namespace advertismement
2135  * @param priority for the namespace advertisement
2136  * @param expiration for the namespace advertisement
2137  * @param rootEntry name of the root of the namespace
2138  * @param cont continuation
2139  * @param cont_cls closure for cont
2140  */
2141 void
2142 GNUNET_FS_namespace_advertise (struct GNUNET_FS_Handle *h,
2143                                struct GNUNET_FS_Uri *ksk_uri,
2144                                struct GNUNET_FS_Namespace *namespace,
2145                                const struct GNUNET_CONTAINER_MetaData *meta,
2146                                uint32_t anonymity,
2147                                uint32_t priority,
2148                                struct GNUNET_TIME_Absolute expiration,
2149                                const char *rootEntry,
2150                                GNUNET_FS_PublishContinuation cont,
2151                                void *cont_cls);
2152
2153
2154 /**
2155  * Create a namespace with the given name; if one already
2156  * exists, return a handle to the existing namespace.
2157  *
2158  * @param h handle to the file sharing subsystem
2159  * @param name name to use for the namespace
2160  * @return handle to the namespace, NULL on error
2161  */
2162 struct GNUNET_FS_Namespace *
2163 GNUNET_FS_namespace_create (struct GNUNET_FS_Handle *h,
2164                             const char *name);
2165
2166
2167 /**
2168  * Delete a namespace handle.  Can be used for a clean shutdown (free
2169  * memory) or also to freeze the namespace to prevent further
2170  * insertions by anyone.
2171  *
2172  * @param namespace handle to the namespace that should be deleted / freed
2173  * @param freeze prevents future insertions; creating a namespace
2174  *        with the same name again will create a fresh namespace instead
2175  *
2176  * @return GNUNET_OK on success, GNUNET_SYSERR on error
2177  */
2178 int
2179 GNUNET_FS_namespace_delete (struct GNUNET_FS_Namespace *namespace,
2180                             int freeze);
2181
2182
2183 /**
2184  * Callback with information about local (!) namespaces.
2185  * Contains the names of the local namespace and the global
2186  * ID.
2187  *
2188  * @param cls closure
2189  * @param name human-readable identifier of the namespace
2190  * @param id hash identifier for the namespace
2191  */
2192 typedef void (*GNUNET_FS_NamespaceInfoProcessor) (void *cls,
2193                                                   const char *name,
2194                                                   const GNUNET_HashCode *id);
2195
2196
2197 /**
2198  * Build a list of all available local (!) namespaces The returned
2199  * names are only the nicknames since we only iterate over the local
2200  * namespaces.
2201  *
2202  * @param h handle to the file sharing subsystem
2203  * @param cb function to call on each known namespace
2204  * @param cb_cls closure for cb
2205  */
2206 void
2207 GNUNET_FS_namespace_list (struct GNUNET_FS_Handle *h,
2208                           GNUNET_FS_NamespaceInfoProcessor cb,
2209                           void *cb_cls);
2210
2211
2212 /**
2213  * Function called on updateable identifiers.
2214  *
2215  * @param cls closure
2216  * @param last_id last identifier
2217  * @param last_uri uri used for the content published under the last_id
2218  * @param last_meta metadata associated with last_uri
2219  * @param next_id identifier that should be used for updates
2220  */
2221 typedef void
2222 (*GNUNET_FS_IdentifierProcessor)(void *cls,
2223                                  const char *last_id,
2224                                  const struct GNUNET_FS_Uri *last_uri,
2225                                  const struct GNUNET_CONTAINER_MetaData *last_meta,
2226                                  const char *next_id);
2227
2228
2229 /**
2230  * List all of the identifiers in the namespace for
2231  * which we could produce an update.
2232  *
2233  * @param namespace namespace to inspect for updateable content
2234  * @param ip function to call on each updateable identifier
2235  * @param ip_cls closure for ip
2236  */
2237 void
2238 GNUNET_FS_namespace_list_updateable (struct GNUNET_FS_Namespace *namespace,
2239                                      GNUNET_FS_IdentifierProcessor ip,
2240                                      void *ip_cls);
2241
2242
2243 /**
2244  * Options for searching.  Compatible options
2245  * can be OR'ed together.
2246  */
2247 enum GNUNET_FS_SearchOptions
2248   {
2249     /**
2250      * No options (use defaults for everything).
2251      */
2252     GNUNET_FS_SEARCH_OPTION_NONE = 0,
2253
2254     /**
2255      * Only search the local host, do not search remote systems (no P2P)
2256      */
2257     GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY = 1
2258
2259   };
2260
2261
2262 /**
2263  * Start search for content.
2264  *
2265  * @param h handle to the file sharing subsystem
2266  * @param uri specifies the search parameters; can be
2267  *        a KSK URI or an SKS URI.
2268  * @param anonymity desired level of anonymity
2269  * @param options options for the search
2270  * @param cctx initial value for the client context
2271  * @return context that can be used to control the search
2272  */
2273 struct GNUNET_FS_SearchContext *
2274 GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
2275                         const struct GNUNET_FS_Uri *uri,
2276                         uint32_t anonymity,
2277                         enum GNUNET_FS_SearchOptions options,
2278                         void *cctx);
2279
2280
2281 /**
2282  * Pause search.
2283  *
2284  * @param sc context for the search that should be paused
2285  */
2286 void
2287 GNUNET_FS_search_pause (struct GNUNET_FS_SearchContext *sc);
2288
2289
2290 /**
2291  * Continue paused search.
2292  *
2293  * @param sc context for the search that should be resumed
2294  */
2295 void
2296 GNUNET_FS_search_continue (struct GNUNET_FS_SearchContext *sc);
2297
2298
2299 /**
2300  * Stop search for content.
2301  *
2302  * @param sc context for the search that should be stopped
2303  */
2304 void
2305 GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc);
2306
2307
2308
2309
2310 /**
2311  * Options for downloading.  Compatible options
2312  * can be OR'ed together.
2313  */
2314 enum GNUNET_FS_DownloadOptions
2315   {
2316     /**
2317      * No options (use defaults for everything).
2318      */
2319     GNUNET_FS_DOWNLOAD_OPTION_NONE = 0,
2320
2321     /**
2322      * Only download from the local host, do not access remote systems (no P2P)
2323      */
2324     GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY = 1,
2325
2326     /**
2327      * Do a recursive download (that is, automatically trigger the
2328      * download of files in directories).
2329      */
2330     GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE = 2,
2331
2332     /**
2333      * Do not append temporary data to
2334      * the target file (for the IBlocks).
2335      */
2336     GNUNET_FS_DOWNLOAD_NO_TEMPORARIES = 4,
2337
2338     /**
2339      * Internal option used to flag this download as a 'probe' for a
2340      * search result.  Impacts the priority with which the download is
2341      * run and causes signalling callbacks to be done differently.
2342      * Also, probe downloads are not serialized on suspension.  Normal
2343      * clients should not use this!
2344      */
2345     GNUNET_FS_DOWNLOAD_IS_PROBE = (1<<31)
2346
2347   };
2348
2349
2350
2351 /**
2352  * Download parts of a file.  Note that this will store
2353  * the blocks at the respective offset in the given file.  Also, the
2354  * download is still using the blocking of the underlying FS
2355  * encoding.  As a result, the download may *write* outside of the
2356  * given boundaries (if offset and length do not match the 32k FS
2357  * block boundaries). <p>
2358  *
2359  * The given range can be used to focus a download towards a
2360  * particular portion of the file (optimization), not to strictly
2361  * limit the download to exactly those bytes.
2362  *
2363  * @param h handle to the file sharing subsystem
2364  * @param uri the URI of the file (determines what to download); CHK or LOC URI
2365  * @param meta known metadata for the file (can be NULL)
2366  * @param filename where to store the file, maybe NULL (then no file is
2367  *        created on disk and data must be grabbed from the callbacks)
2368  * @param tempname where to store temporary file data, not used if filename is non-NULL;
2369  *        can be NULL (in which case we will pick a name if needed); the temporary file
2370  *        may already exist, in which case we will try to use the data that is there and
2371  *        if it is not what is desired, will overwrite it
2372  * @param offset at what offset should we start the download (typically 0)
2373  * @param length how many bytes should be downloaded starting at offset
2374  * @param anonymity anonymity level to use for the download
2375  * @param options various download options
2376  * @param cctx initial value for the client context for this download
2377  * @param parent parent download to associate this download with (use NULL
2378  *        for top-level downloads; useful for manually-triggered recursive downloads)
2379  * @return context that can be used to control this download
2380  */
2381 struct GNUNET_FS_DownloadContext *
2382 GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
2383                           const struct GNUNET_FS_Uri *uri,
2384                           const struct GNUNET_CONTAINER_MetaData *meta,
2385                           const char *filename,
2386                           const char *tempname,
2387                           uint64_t offset,
2388                           uint64_t length,
2389                           uint32_t anonymity,
2390                           enum GNUNET_FS_DownloadOptions options,
2391                           void *cctx,
2392                           struct GNUNET_FS_DownloadContext *parent);
2393
2394
2395 /**
2396  * Download parts of a file based on a search result.  The download
2397  * will be associated with the search result (and the association
2398  * will be preserved when serializing/deserializing the state).
2399  * If the search is stopped, the download will not be aborted but
2400  * be 'promoted' to a stand-alone download.
2401  *
2402  * As with the other download function, this will store
2403  * the blocks at the respective offset in the given file.  Also, the
2404  * download is still using the blocking of the underlying FS
2405  * encoding.  As a result, the download may *write* outside of the
2406  * given boundaries (if offset and length do not match the 32k FS
2407  * block boundaries). <p>
2408  *
2409  * The given range can be used to focus a download towards a
2410  * particular portion of the file (optimization), not to strictly
2411  * limit the download to exactly those bytes.
2412  *
2413  * @param h handle to the file sharing subsystem
2414  * @param sr the search result to use for the download (determines uri and
2415  *        meta data and associations)
2416  * @param filename where to store the file, maybe NULL (then no file is
2417  *        created on disk and data must be grabbed from the callbacks)
2418  * @param tempname where to store temporary file data, not used if filename is non-NULL;
2419  *        can be NULL (in which case we will pick a name if needed); the temporary file
2420  *        may already exist, in which case we will try to use the data that is there and
2421  *        if it is not what is desired, will overwrite it
2422  * @param offset at what offset should we start the download (typically 0)
2423  * @param length how many bytes should be downloaded starting at offset
2424  * @param anonymity anonymity level to use for the download
2425  * @param options various download options
2426  * @param cctx initial value for the client context for this download
2427  * @return context that can be used to control this download
2428  */
2429 struct GNUNET_FS_DownloadContext *
2430 GNUNET_FS_download_start_from_search (struct GNUNET_FS_Handle *h,
2431                                       struct GNUNET_FS_SearchResult *sr,
2432                                       const char *filename,
2433                                       const char *tempname,
2434                                       uint64_t offset,
2435                                       uint64_t length,
2436                                       uint32_t anonymity,
2437                                       enum GNUNET_FS_DownloadOptions options,
2438                                       void *cctx);
2439
2440
2441 /**
2442  * Stop a download (aborts if download is incomplete).
2443  *
2444  * @param dc handle for the download
2445  * @param do_delete delete files of incomplete downloads
2446  */
2447 void
2448 GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc,
2449                          int do_delete);
2450
2451
2452 /**
2453  * Initialize collection.
2454  *
2455  * @param h handle to the file sharing subsystem
2456  * @param namespace namespace to use for the collection
2457  * @return GNUNET_OK on success, GNUNET_SYSERR if another
2458  *         namespace is already set for our collection
2459  */
2460 int
2461 GNUNET_FS_collection_start (struct GNUNET_FS_Handle *h,
2462                             struct GNUNET_FS_Namespace *namespace);
2463
2464
2465 /**
2466  * Stop collection.
2467  *
2468  * @param h handle to the file sharing subsystem
2469  * @return GNUNET_OK on success, GNUNET_SYSERR if no collection is active
2470  */
2471 int
2472 GNUNET_FS_collection_stop (struct GNUNET_FS_Handle *h);
2473
2474
2475 /**
2476  * Are we using a collection?
2477  *
2478  * @param h handle to the file sharing subsystem
2479  * @return NULL if there is no collection,
2480  */
2481 struct GNUNET_FS_Namespace *
2482 GNUNET_FS_collection_get(struct GNUNET_FS_Handle *h);
2483
2484
2485 /**
2486  * Publish an update of the current collection information to the
2487  * network now.  The function has no effect if the collection has not
2488  * changed since the last publication.  If we are currently not
2489  * collecting, this function does nothing.
2490  *
2491  * @param h handle to the file sharing subsystem
2492  */
2493 void GNUNET_FS_collection_publish (struct GNUNET_FS_Handle *h);
2494
2495
2496 /**
2497  * If we are currently building a collection, publish the given file
2498  * information in that collection.  If we are currently not
2499  * collecting, this function does nothing.
2500  *
2501  * @param h handle to the file sharing subsystem
2502  * @param uri uri to add to the collection
2503  * @param meta metadata for the uri
2504  */
2505 void GNUNET_FS_collection_add (const struct GNUNET_FS_Handle *h,
2506                                const struct GNUNET_FS_Uri *uri,
2507                                const struct GNUNET_CONTAINER_MetaData *meta);
2508
2509
2510
2511
2512
2513 /* ******************** Directory API *********************** */
2514
2515
2516 #define GNUNET_FS_DIRECTORY_MIME  "application/gnunet-directory"
2517 #define GNUNET_FS_DIRECTORY_MAGIC "\211GND\r\n\032\n"
2518 #define GNUNET_FS_DIRECTORY_EXT   ".gnd"
2519
2520 /**
2521  * Does the meta-data claim that this is a directory?
2522  * Checks if the mime-type is that of a GNUnet directory.
2523  *
2524  * @return GNUNET_YES if it is, GNUNET_NO if it is not, GNUNET_SYSERR if
2525  *  we have no mime-type information (treat as 'GNUNET_NO')
2526  */
2527 int
2528 GNUNET_FS_meta_data_test_for_directory (const struct GNUNET_CONTAINER_MetaData *md);
2529
2530
2531 /**
2532  * Set the MIMETYPE information for the given
2533  * metadata to "application/gnunet-directory".
2534  *
2535  * @param md metadata to add mimetype to
2536  */
2537 void
2538 GNUNET_FS_meta_data_make_directory (struct GNUNET_CONTAINER_MetaData *md);
2539
2540
2541 /**
2542  * Suggest a filename based on given metadata.
2543  *
2544  * @param md given meta data
2545  * @return NULL if meta data is useless for suggesting a filename
2546  */
2547 char *
2548 GNUNET_FS_meta_data_suggest_filename (const struct GNUNET_CONTAINER_MetaData *md);
2549
2550
2551 /**
2552  * Function used to process entries in a directory.
2553  *
2554  * @param cls closure
2555  * @param filename name of the file in the directory
2556  * @param uri URI of the file
2557  * @param metadata metadata for the file; metadata for
2558  *        the directory if everything else is NULL/zero
2559  * @param length length of the available data for the file
2560  *           (of type size_t since data must certainly fit
2561  *            into memory; if files are larger than size_t
2562  *            permits, then they will certainly not be
2563  *            embedded with the directory itself).
2564  * @param data data available for the file (length bytes)
2565  */
2566 typedef void (*GNUNET_FS_DirectoryEntryProcessor)(void *cls,
2567                                                   const char *filename,
2568                                                   const struct GNUNET_FS_Uri *uri,
2569                                                   const struct GNUNET_CONTAINER_MetaData *meta,
2570                                                   size_t length,
2571                                                   const void *data);
2572
2573
2574 /**
2575  * Iterate over all entries in a directory.  Note that directories
2576  * are structured such that it is possible to iterate over the
2577  * individual blocks as well as over the entire directory.  Thus
2578  * a client can call this function on the buffer in the
2579  * GNUNET_FS_ProgressCallback.  Also, directories can optionally
2580  * include the contents of (small) files embedded in the directory
2581  * itself; for those files, the processor may be given the
2582  * contents of the file directly by this function.
2583  *
2584  * @param size number of bytes in data
2585  * @param data pointer to the beginning of the directory
2586  * @param offset offset of data in the directory
2587  * @param dep function to call on each entry
2588  * @param dep_cls closure for dep
2589  */
2590 void
2591 GNUNET_FS_directory_list_contents (size_t size,
2592                                    const void *data,
2593                                    uint64_t offset,
2594                                    GNUNET_FS_DirectoryEntryProcessor dep,
2595                                    void *dep_cls);
2596
2597
2598 /**
2599  * Opaque handle to a directory builder.
2600  */
2601 struct GNUNET_FS_DirectoryBuilder;
2602
2603 /**
2604  * Create a directory builder.
2605  *
2606  * @param mdir metadata for the directory
2607  */
2608 struct GNUNET_FS_DirectoryBuilder *
2609 GNUNET_FS_directory_builder_create (const struct GNUNET_CONTAINER_MetaData *mdir);
2610
2611
2612 /**
2613  * Add an entry to a directory.
2614  *
2615  * @param bld directory to extend
2616  * @param uri uri of the entry (must not be a KSK)
2617  * @param md metadata of the entry
2618  * @param data raw data of the entry, can be NULL, otherwise
2619  *        data must point to exactly the number of bytes specified
2620  *        by the uri
2621  */
2622 void
2623 GNUNET_FS_directory_builder_add (struct GNUNET_FS_DirectoryBuilder *bld,
2624                                  const struct GNUNET_FS_Uri *uri,
2625                                  const struct GNUNET_CONTAINER_MetaData *md,
2626                                  const void *data);
2627
2628
2629 /**
2630  * Finish building the directory.  Frees the
2631  * builder context and returns the directory
2632  * in-memory.
2633  *
2634  * @param bld directory to finish
2635  * @param rsize set to the number of bytes needed
2636  * @param rdata set to the encoded directory
2637  * @return GNUNET_OK on success
2638  */
2639 int
2640 GNUNET_FS_directory_builder_finish (struct GNUNET_FS_DirectoryBuilder *bld,
2641                                     size_t *rsize,
2642                                     void **rdata);
2643
2644
2645 #if 0                           /* keep Emacsens' auto-indent happy */
2646 {
2647 #endif
2648 #ifdef __cplusplus
2649 }
2650 #endif
2651
2652
2653 #endif