src/include/gnunet_fs_service.h

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