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