src/include/gnunet_fs_service.h

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