src/include/gnunet_fs_service.h

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