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