src/include/gnunet_fs_service.h

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