src/include/gnunet_fs_service.h

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