src/include/gnunet_fs_service.h

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