apt-pkg/acquire-item.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: acquire-item.h,v 1.26.2.3 2004/01/02 18:51:00 mdz Exp $
   4 /* ######################################################################
   5
   6    Acquire Item - Item to acquire
   7
   8    When an item is instantiated it will add it self to the local list in
   9    the Owner Acquire class. Derived classes will then call QueueURI to
  10    register all the URI's they wish to fetch at the initial moment.
  11
  12    Three item classes are provided to provide functionality for
  13    downloading of Index, Translation and Packages files.
  14
  15    A Archive class is provided for downloading .deb files. It does Hash
  16    checking and source location as well as a retry algorithm.
  17
  18    ##################################################################### */
  19                                                                         /*}}}*/
  20 #ifndef PKGLIB_ACQUIRE_ITEM_H
  21 #define PKGLIB_ACQUIRE_ITEM_H
  22
  23 #include <apt-pkg/acquire.h>
  24 #include <apt-pkg/hashes.h>
  25 #include <apt-pkg/weakptr.h>
  26 #include <apt-pkg/pkgcache.h>
  27 #include <apt-pkg/cacheiterators.h>
  28
  29 #include <string>
  30 #include <vector>
  31
  32 #ifndef APT_8_CLEANER_HEADERS
  33 #include <apt-pkg/indexfile.h>
  34 #include <apt-pkg/vendor.h>
  35 #include <apt-pkg/sourcelist.h>
  36 #include <apt-pkg/pkgrecords.h>
  37 #include <apt-pkg/indexrecords.h>
  38 #endif
  39
  40 /** \addtogroup acquire
  41  *  @{
  42  *
  43  *  \file acquire-item.h
  44  */
  45
  46 class indexRecords;
  47 class pkgRecords;
  48 class pkgSourceList;
  49 class IndexTarget;
  50 class pkgAcqMetaIndex;
  51
  52 /** \brief Represents the process by which a pkgAcquire object should   {{{
  53  *  retrieve a file or a collection of files.
  54  *
  55  *  By convention, Item subclasses should insert themselves into the
  56  *  acquire queue when they are created by calling QueueURI(), and
  57  *  remove themselves by calling Dequeue() when either Done() or
  58  *  Failed() is invoked.  Item objects are also responsible for
  59  *  notifying the download progress indicator (accessible via
  60  *  #Owner->Log) of their status.
  61  *
  62  *  \see pkgAcquire
  63  */
  64 class pkgAcquire::Item : public WeakPointable
  65 {
  66    protected:
  67
  68    /** \brief The acquire object with which this item is associated. */
  69    pkgAcquire *Owner;
  70
  71    /** \brief Insert this item into its owner's queue.
  72     *
  73     *  \param Item Metadata about this item (its URI and
  74     *  description).
  75     */
  76    inline void QueueURI(ItemDesc &Item)
  77                  {Owner->Enqueue(Item);};
  78
  79    /** \brief Remove this item from its owner's queue. */
  80    inline void Dequeue() {Owner->Dequeue(this);};
  81
  82    /** \brief Rename a file without modifying its timestamp.
  83     *
  84     *  Many item methods call this as their final action.
  85     *
  86     *  \param From The file to be renamed.
  87     *
  88     *  \param To The new name of \a From.  If \a To exists it will be
  89     *  overwritten.
  90     */
  91    void Rename(std::string From,std::string To);
  92
  93    public:
  94
  95    /** \brief The current status of this item. */
  96    enum ItemState
  97      {
  98        /** \brief The item is waiting to be downloaded. */
  99        StatIdle,
 100
 101        /** \brief The item is currently being downloaded. */
 102        StatFetching,
 103
 104        /** \brief The item has been successfully downloaded. */
 105        StatDone,
 106
 107        /** \brief An error was encountered while downloading this
 108         *  item.
 109         */
 110        StatError,
 111
 112        /** \brief The item was downloaded but its authenticity could
 113         *  not be verified.
 114         */
 115        StatAuthError,
 116
 117        /** \brief The item was could not be downloaded because of
 118         *  a transient network error (e.g. network down)
 119         */
 120        StatTransientNetworkError,
 121      } Status;
 122
 123    /** \brief Contains a textual description of the error encountered
 124     *  if #ItemState is #StatError or #StatAuthError.
 125     */
 126    std::string ErrorText;
 127
 128    /** \brief The size of the object to fetch. */
 129    unsigned long long FileSize;
 130
 131    /** \brief How much of the object was already fetched. */
 132    unsigned long long PartialSize;
 133
 134    /** \brief If not \b NULL, contains the name of a subprocess that
 135     *  is operating on this object (for instance, "gzip" or "gpgv").
 136     */
 137    const char *Mode;
 138
 139    /** \brief A client-supplied unique identifier.
 140     *
 141     *  This field is initalized to 0; it is meant to be filled in by
 142     *  clients that wish to use it to uniquely identify items.
 143     *
 144     *  \todo it's unused in apt itself
 145     */
 146    unsigned long ID;
 147
 148    /** \brief If \b true, the entire object has been successfully fetched.
 149     *
 150     *  Subclasses should set this to \b true when appropriate.
 151     */
 152    bool Complete;
 153
 154    /** \brief If \b true, the URI of this object is "local".
 155     *
 156     *  The only effect of this field is to exclude the object from the
 157     *  download progress indicator's overall statistics.
 158     */
 159    bool Local;
 160    std::string UsedMirror;
 161
 162    /** \brief The number of fetch queues into which this item has been
 163     *  inserted.
 164     *
 165     *  There is one queue for each source from which an item could be
 166     *  downloaded.
 167     *
 168     *  \sa pkgAcquire
 169     */
 170    unsigned int QueueCounter;
 171
 172    /** \brief TransactionID */
 173    unsigned long TransactionID;
 174
 175    /** \brief The number of additional fetch items that are expected
 176     *  once this item is done.
 177     *
 178     *  Some items like pkgAcqMeta{Index,Sig} will queue additional
 179     *  items. This variable can be set by the methods if it knows
 180     *  in advance how many items to expect to get a more accurate
 181     *  progress.
 182     */
 183    unsigned int ExpectedAdditionalItems;
 184
 185    /** \brief The name of the file into which the retrieved object
 186     *  will be written.
 187     */
 188    std::string DestFile;
 189
 190    /** \brief storge name until a transaction is finished */
 191    std::string PartialFile;
 192
 193    /** \brief Invoked by the acquire worker when the object couldn't
 194     *  be fetched.
 195     *
 196     *  This is a branch of the continuation of the fetch process.
 197     *
 198     *  \param Message An RFC822-formatted message from the acquire
 199     *  method describing what went wrong.  Use LookupTag() to parse
 200     *  it.
 201     *
 202     *  \param Cnf The method via which the worker tried to fetch this object.
 203     *
 204     *  \sa pkgAcqMethod
 205     */
 206    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 207
 208    /** \brief Invoked by the acquire worker when the object was
 209     *  fetched successfully.
 210     *
 211     *  Note that the object might \e not have been written to
 212     *  DestFile; check for the presence of an Alt-Filename entry in
 213     *  Message to find the file to which it was really written.
 214     *
 215     *  Done is often used to switch from one stage of the processing
 216     *  to the next (e.g. fetching, unpacking, copying).  It is one
 217     *  branch of the continuation of the fetch process.
 218     *
 219     *  \param Message Data from the acquire method.  Use LookupTag()
 220     *  to parse it.
 221     *  \param Size The size of the object that was fetched.
 222     *  \param Hashes The HashSums of the object that was fetched.
 223     *  \param Cnf The method via which the object was fetched.
 224     *
 225     *  \sa pkgAcqMethod
 226     */
 227    virtual void Done(std::string Message, unsigned long long Size, HashStringList const &Hashes,
 228                      pkgAcquire::MethodConfig *Cnf);
 229
 230    /** \brief Invoked when the worker starts to fetch this object.
 231     *
 232     *  \param Message RFC822-formatted data from the worker process.
 233     *  Use LookupTag() to parse it.
 234     *
 235     *  \param Size The size of the object being fetched.
 236     *
 237     *  \sa pkgAcqMethod
 238     */
 239    virtual void Start(std::string Message,unsigned long long Size);
 240
 241    /** \brief Custom headers to be sent to the fetch process.
 242     *
 243     *  \return a string containing RFC822-style headers that are to be
 244     *  inserted into the 600 URI Acquire message sent to the fetch
 245     *  subprocess.  The headers are inserted after a newline-less
 246     *  line, so they should (if nonempty) have a leading newline and
 247     *  no trailing newline.
 248     */
 249    virtual std::string Custom600Headers() const {return std::string();};
 250
 251    /** \brief A "descriptive" URI-like string.
 252     *
 253     *  \return a URI that should be used to describe what is being fetched.
 254     */
 255    virtual std::string DescURI() const = 0;
 256    /** \brief Short item description.
 257     *
 258     *  \return a brief description of the object being fetched.
 259     */
 260    virtual std::string ShortDesc() const {return DescURI();}
 261
 262    /** \brief Invoked by the worker when the download is completely done. */
 263    virtual void Finished() {};
 264
 265    /** \brief HashSums
 266     *
 267     *  \return the HashSums of this object, if applicable; otherwise, an
 268     *  empty list.
 269     */
 270    HashStringList HashSums() const {return ExpectedHashes;};
 271    std::string HashSum() const {HashStringList const hashes = HashSums(); HashString const * const hs = hashes.find(NULL); return hs != NULL ? hs->toStr() : ""; };
 272
 273    /** \return the acquire process with which this item is associated. */
 274    pkgAcquire *GetOwner() const {return Owner;};
 275
 276    /** \return \b true if this object is being fetched from a trusted source. */
 277    virtual bool IsTrusted() const {return false;};
 278
 279    // report mirror problems
 280    /** \brief Report mirror problem
 281     *
 282     *  This allows reporting mirror failures back to a centralized
 283     *  server. The apt-report-mirror-failure script is called for this
 284     *
 285     *  \param FailCode A short failure string that is send
 286     */
 287    void ReportMirrorFailure(std::string FailCode);
 288
 289
 290    /** \brief Initialize an item.
 291     *
 292     *  Adds the item to the list of items known to the acquire
 293     *  process, but does not place it into any fetch queues (you must
 294     *  manually invoke QueueURI() to do so).
 295     *
 296     *  \param Owner The new owner of this item.
 297     *  \param ExpectedHashes of the file represented by this item
 298     */
 299    Item(pkgAcquire *Owner,
 300         HashStringList const &ExpectedHashes=HashStringList());
 301
 302    /** \brief Remove this item from its owner's queue by invoking
 303     *  pkgAcquire::Remove.
 304     */
 305    virtual ~Item();
 306
 307    protected:
 308
 309    enum RenameOnErrorState {
 310       HashSumMismatch,
 311       SizeMismatch,
 312       InvalidFormat
 313    };
 314
 315    /** \brief Rename failed file and set error
 316     *
 317     * \param state respresenting the error we encountered
 318     */
 319    bool RenameOnError(RenameOnErrorState const state);
 320
 321    /** \brief The HashSums of the item is supposed to have than done */
 322    HashStringList ExpectedHashes;
 323
 324    /** \brief The item that is currently being downloaded. */
 325    pkgAcquire::ItemDesc Desc;
 326 };
 327                                                                         /*}}}*/
 328 /** \brief Information about an index patch (aka diff). */              /*{{{*/
 329 struct DiffInfo {
 330    /** The filename of the diff. */
 331    std::string file;
 332
 333    /** The sha1 hash of the diff. */
 334    std::string sha1;
 335
 336    /** The size of the diff. */
 337    unsigned long size;
 338 };
 339                                                                         /*}}}*/
 340 /** \brief An item that is responsible for fetching a SubIndex          {{{
 341  *
 342  *  The MetaIndex file includes only records for important indexes
 343  *  and records for these SubIndex files so these can carry records
 344  *  for addition files like PDiffs and Translations
 345  */
 346 class pkgAcqSubIndex : public pkgAcquire::Item
 347 {
 348  protected:
 349    /** \brief If \b true, debugging information will be written to std::clog. */
 350    bool Debug;
 351
 352  public:
 353    // Specialized action members
 354    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 355    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
 356                      pkgAcquire::MethodConfig *Cnf);
 357    virtual std::string DescURI() const {return Desc.URI;};
 358    virtual std::string Custom600Headers() const;
 359    virtual bool ParseIndex(std::string const &IndexFile);
 360
 361    /** \brief Create a new pkgAcqSubIndex.
 362     *
 363     *  \param Owner The Acquire object that owns this item.
 364     *
 365     *  \param URI The URI of the list file to download.
 366     *
 367     *  \param URIDesc A long description of the list file to download.
 368     *
 369     *  \param ShortDesc A short description of the list file to download.
 370     *
 371     *  \param ExpectedHashes The list file's hashsums which are expected.
 372     */
 373    pkgAcqSubIndex(pkgAcquire *Owner, std::string const &URI,std::string const &URIDesc,
 374                    std::string const &ShortDesc, HashStringList const &ExpectedHashes);
 375 };
 376                                                                         /*}}}*/
 377
 378 /** \brief An item that is responsible for downloading the meta-index   {{{
 379  *  file (i.e., Release) itself and verifying its signature.
 380  *
 381  *  Once the download and verification are complete, the downloads of
 382  *  the individual index files are queued up using pkgAcqDiffIndex.
 383  *  If the meta-index file had a valid signature, the expected hashsums
 384  *  of the index files will be the md5sums listed in the meta-index;
 385  *  otherwise, the expected hashsums will be "" (causing the
 386  *  authentication of the index files to be bypassed).
 387  */
 388 class pkgAcqMetaIndex : public pkgAcquire::Item
 389 {
 390    protected:
 391    /** \brief The URI that is actually being downloaded; never
 392     *  modified by pkgAcqMetaIndex.
 393     */
 394    std::string RealURI;
 395
 396    /** \brief The file in which the signature for this index was stored.
 397     *
 398     *  If empty, the signature and the md5sums of the individual
 399     *  indices will not be checked.
 400     */
 401    std::string SigFile;
 402
 403    /** \brief The index files to download. */
 404    const std::vector<IndexTarget*>* IndexTargets;
 405
 406    /** \brief The parser for the meta-index file. */
 407    indexRecords* MetaIndexParser;
 408
 409    /** \brief If \b true, the index's signature is currently being verified.
 410     */
 411    bool AuthPass;
 412    // required to deal gracefully with problems caused by incorrect ims hits
 413    bool IMSHit;
 414
 415    /** \brief Check that the release file is a release file for the
 416     *  correct distribution.
 417     *
 418     *  \return \b true if no fatal errors were encountered.
 419     */
 420    bool VerifyVendor(std::string Message);
 421
 422    /** \brief Called when a file is finished being retrieved.
 423     *
 424     *  If the file was not downloaded to DestFile, a copy process is
 425     *  set up to copy it to DestFile; otherwise, Complete is set to \b
 426     *  true and the file is moved to its final location.
 427     *
 428     *  \param Message The message block received from the fetch
 429     *  subprocess.
 430     */
 431    void RetrievalDone(std::string Message);
 432
 433    /** \brief Called when authentication succeeded.
 434     *
 435     *  Sanity-checks the authenticated file, queues up the individual
 436     *  index files for download, and saves the signature in the lists
 437     *  directory next to the authenticated list file.
 438     *
 439     *  \param Message The message block received from the fetch
 440     *  subprocess.
 441     */
 442    void AuthDone(std::string Message);
 443
 444    /** \brief Starts downloading the individual index files.
 445     *
 446     *  \param verify If \b true, only indices whose expected hashsum
 447     *  can be determined from the meta-index will be downloaded, and
 448     *  the hashsums of indices will be checked (reporting
 449     *  #StatAuthError if there is a mismatch).  If verify is \b false,
 450     *  no hashsum checking will be performed.
 451     */
 452    void QueueIndexes(bool verify);
 453
 454    /** \brief The URI of the meta-index file for the detached signature */
 455    std::string MetaIndexSigURI;
 456
 457    /** \brief A "URI-style" description of the meta-index file */
 458    std::string MetaIndexSigURIDesc;
 459
 460    /** \brief A brief description of the meta-index file */
 461    std::string MetaIndexSigShortDesc;
 462
 463    public:
 464
 465    // Specialized action members
 466    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 467    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
 468                      pkgAcquire::MethodConfig *Cnf);
 469    virtual std::string Custom600Headers() const;
 470    virtual std::string DescURI() const {return RealURI; };
 471    virtual void Finished();
 472
 473    /** \brief Create a new pkgAcqMetaIndex. */
 474    pkgAcqMetaIndex(pkgAcquire *Owner,
 475                    std::string URI,std::string URIDesc, std::string ShortDesc,
 476                    std::string MetaIndexSigURI, std::string MetaIndexSigURIDesc, std::string MetaIndexSigShortDesc,
 477                    const std::vector<IndexTarget*>* IndexTargets,
 478                    indexRecords* MetaIndexParser);
 479 };
 480                                                                         /*}}}*/
 481 /** \brief An item repsonsible for downloading clearsigned metaindexes  {{{*/
 482 class pkgAcqMetaClearSig : public pkgAcqMetaIndex
 483 {
 484    /** \brief The URI of the meta-index file for the detached signature */
 485    std::string MetaIndexURI;
 486
 487    /** \brief A "URI-style" description of the meta-index file */
 488    std::string MetaIndexURIDesc;
 489
 490    /** \brief A brief description of the meta-index file */
 491    std::string MetaIndexShortDesc;
 492
 493    /** \brief The URI of the detached meta-signature file if the clearsigned one failed. */
 494    std::string MetaSigURI;
 495
 496    /** \brief A "URI-style" description of the meta-signature file */
 497    std::string MetaSigURIDesc;
 498
 499    /** \brief A brief description of the meta-signature file */
 500    std::string MetaSigShortDesc;
 501
 502 public:
 503    void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 504    virtual std::string Custom600Headers() const;
 505
 506    /** \brief Create a new pkgAcqMetaClearSig. */
 507    pkgAcqMetaClearSig(pkgAcquire *Owner,
 508                 std::string const &URI, std::string const &URIDesc, std::string const &ShortDesc,
 509                 std::string const &MetaIndexURI, std::string const &MetaIndexURIDesc, std::string const &MetaIndexShortDesc,
 510                 std::string const &MetaSigURI, std::string const &MetaSigURIDesc, std::string const &MetaSigShortDesc,
 511                 const std::vector<IndexTarget*>* IndexTargets,
 512                 indexRecords* MetaIndexParser);
 513    virtual ~pkgAcqMetaClearSig();
 514 };
 515                                                                         /*}}}*/
 516
 517
 518 /** \brief Common base class for all classes that deal with fetching    {{{
 519            indexes
 520  */
 521 class pkgAcqBaseIndex : public pkgAcquire::Item
 522 {
 523  protected:
 524    /** \brief Pointer to the IndexTarget data
 525     */
 526    const struct IndexTarget * Target;
 527    indexRecords *MetaIndexParser;
 528    pkgAcqMetaIndex *MetaOwner;
 529
 530    pkgAcqBaseIndex(pkgAcqMetaIndex *MetaOwner,
 531                    struct IndexTarget const * const Target,
 532                    HashStringList const &ExpectedHashes,
 533                    indexRecords *MetaIndexParser)
 534       : Item(MetaOwner->GetOwner(), ExpectedHashes), Target(Target),
 535         MetaIndexParser(MetaIndexParser), MetaOwner(MetaOwner) {};
 536
 537    pkgAcqBaseIndex(pkgAcquire *Owner,
 538                    struct IndexTarget const * const Target,
 539                    HashStringList const &ExpectedHashes,
 540                    indexRecords *MetaIndexParser)
 541       : Item(Owner, ExpectedHashes), Target(Target),
 542         MetaIndexParser(MetaIndexParser), MetaOwner(0) {};
 543
 544 };
 545                                                                         /*}}}*/
 546 /** \brief An item that is responsible for fetching an index file of    {{{
 547  *  package list diffs and starting the package list's download.
 548  *
 549  *  This item downloads the Index file and parses it, then enqueues
 550  *  additional downloads of either the individual patches (using
 551  *  pkgAcqIndexDiffs) or the entire Packages file (using pkgAcqIndex).
 552  *
 553  *  \sa pkgAcqIndexDiffs, pkgAcqIndex
 554  */
 555 class pkgAcqDiffIndex : public pkgAcqBaseIndex
 556 {
 557  protected:
 558    /** \brief If \b true, debugging information will be written to std::clog. */
 559    bool Debug;
 560
 561    /** \brief The URI of the index file to recreate at our end (either
 562     *  by downloading it or by applying partial patches).
 563     */
 564    std::string RealURI;
 565
 566    /** \brief The index file which will be patched to generate the new
 567     *  file.
 568     */
 569    std::string CurrentPackagesFile;
 570
 571    /** \brief A description of the Packages file (stored in
 572     *  pkgAcquire::ItemDesc::Description).
 573     */
 574    std::string Description;
 575
 576  public:
 577    // Specialized action members
 578    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 579    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
 580                      pkgAcquire::MethodConfig *Cnf);
 581    virtual std::string DescURI() const {return RealURI + "Index";};
 582    virtual std::string Custom600Headers() const;
 583
 584    /** \brief Parse the Index file for a set of Packages diffs.
 585     *
 586     *  Parses the Index file and creates additional download items as
 587     *  necessary.
 588     *
 589     *  \param IndexDiffFile The name of the Index file.
 590     *
 591     *  \return \b true if the Index file was successfully parsed, \b
 592     *  false otherwise.
 593     */
 594    bool ParseDiffIndex(std::string IndexDiffFile);
 595
 596
 597    /** \brief Create a new pkgAcqDiffIndex.
 598     *
 599     *  \param Owner The Acquire object that owns this item.
 600     *
 601     *  \param URI The URI of the list file to download.
 602     *
 603     *  \param URIDesc A long description of the list file to download.
 604     *
 605     *  \param ShortDesc A short description of the list file to download.
 606     *
 607     *  \param ExpectedHashes The list file's hashsums which are expected.
 608     */
 609    pkgAcqDiffIndex(pkgAcqMetaIndex *MetaIndexOwner,
 610                    struct IndexTarget const * const Target,
 611                    HashStringList const &ExpectedHashes,
 612                    indexRecords *MetaIndexParser);
 613 };
 614                                                                         /*}}}*/
 615 /** \brief An item that is responsible for fetching client-merge patches {{{
 616  *  that need to be applied to a given package index file.
 617  *
 618  *  Instead of downloading and applying each patch one by one like its
 619  *  sister #pkgAcqIndexDiffs this class will download all patches at once
 620  *  and call rred with all the patches downloaded once. Rred will then
 621  *  merge and apply them in one go, which should be a lot faster – but is
 622  *  incompatible with server-based merges of patches like reprepro can do.
 623  *
 624  *  \sa pkgAcqDiffIndex, pkgAcqIndex
 625  */
 626 class pkgAcqIndexMergeDiffs : public pkgAcqBaseIndex
 627 {
 628    protected:
 629
 630    /** \brief If \b true, debugging output will be written to
 631     *  std::clog.
 632     */
 633    bool Debug;
 634
 635    /** \brief URI of the package index file that is being
 636     *  reconstructed.
 637     */
 638    std::string RealURI;
 639
 640    /** \brief description of the file being downloaded. */
 641    std::string Description;
 642
 643    /** \brief information about the current patch */
 644    struct DiffInfo const patch;
 645
 646    /** \brief list of all download items for the patches */
 647    std::vector<pkgAcqIndexMergeDiffs*> const * const allPatches;
 648
 649    /** The current status of this patch. */
 650    enum DiffState
 651    {
 652       /** \brief The diff is currently being fetched. */
 653       StateFetchDiff,
 654
 655       /** \brief The diff is currently being applied. */
 656       StateApplyDiff,
 657
 658       /** \brief the work with this diff is done */
 659       StateDoneDiff,
 660
 661       /** \brief something bad happened and fallback was triggered */
 662       StateErrorDiff
 663    } State;
 664
 665    public:
 666    /** \brief Called when the patch file failed to be downloaded.
 667     *
 668     *  This method will fall back to downloading the whole index file
 669     *  outright; its arguments are ignored.
 670     */
 671    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 672    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
 673          pkgAcquire::MethodConfig *Cnf);
 674    virtual std::string DescURI() const {return RealURI + "Index";};
 675
 676    /** \brief Create an index merge-diff item.
 677     *
 678     *  \param Owner The pkgAcquire object that owns this item.
 679     *
 680     *  \param URI The URI of the package index file being
 681     *  reconstructed.
 682     *
 683     *  \param URIDesc A long description of this item.
 684     *
 685     *  \param ShortDesc A brief description of this item.
 686     *
 687     *  \param ExpectedHashes The expected md5sum of the completely
 688     *  reconstructed package index file; the index file will be tested
 689     *  against this value when it is entirely reconstructed.
 690     *
 691     *  \param patch contains infos about the patch this item is supposed
 692     *  to download which were read from the index
 693     *
 694     *  \param allPatches contains all related items so that each item can
 695     *  check if it was the last one to complete the download step
 696     */
 697    pkgAcqIndexMergeDiffs(pkgAcqMetaIndex *MetaIndexOwner,
 698                          struct IndexTarget const * const Target,
 699                          HashStringList const &ExpectedHash,
 700                          indexRecords *MetaIndexParser,
 701                          DiffInfo const &patch,
 702                          std::vector<pkgAcqIndexMergeDiffs*> const * const allPatches);
 703 };
 704                                                                         /*}}}*/
 705 /** \brief An item that is responsible for fetching server-merge patches {{{
 706  *  that need to be applied to a given package index file.
 707  *
 708  *  After downloading and applying a single patch, this item will
 709  *  enqueue a new pkgAcqIndexDiffs to download and apply the remaining
 710  *  patches.  If no patch can be found that applies to an intermediate
 711  *  file or if one of the patches cannot be downloaded, falls back to
 712  *  downloading the entire package index file using pkgAcqIndex.
 713  *
 714  *  \sa pkgAcqDiffIndex, pkgAcqIndex
 715  */
 716 class pkgAcqIndexDiffs : public pkgAcqBaseIndex
 717 {
 718    private:
 719
 720    /** \brief Queue up the next diff download.
 721     *
 722     *  Search for the next available diff that applies to the file
 723     *  that currently exists on disk, and enqueue it by calling
 724     *  QueueURI().
 725     *
 726     *  \return \b true if an applicable diff was found, \b false
 727     *  otherwise.
 728     */
 729    bool QueueNextDiff();
 730
 731    /** \brief Handle tasks that must be performed after the item
 732     *  finishes downloading.
 733     *
 734     *  Dequeues the item and checks the resulting file's hashsums
 735     *  against ExpectedHashes after the last patch was applied.
 736     *  There is no need to check the md5/sha1 after a "normal"
 737     *  patch because QueueNextDiff() will check the sha1 later.
 738     *
 739     *  \param allDone If \b true, the file was entirely reconstructed,
 740     *  and its md5sum is verified.
 741     */
 742    void Finish(bool allDone=false);
 743
 744    protected:
 745
 746    /** \brief If \b true, debugging output will be written to
 747     *  std::clog.
 748     */
 749    bool Debug;
 750
 751    /** \brief The URI of the package index file that is being
 752     *  reconstructed.
 753     */
 754    std::string RealURI;
 755
 756    /** A description of the file being downloaded. */
 757    std::string Description;
 758
 759    /** The patches that remain to be downloaded, including the patch
 760     *  being downloaded right now.  This list should be ordered so
 761     *  that each diff appears before any diff that depends on it.
 762     *
 763     *  \todo These are indexed by sha1sum; why not use some sort of
 764     *  dictionary instead of relying on ordering and stripping them
 765     *  off the front?
 766     */
 767    std::vector<DiffInfo> available_patches;
 768
 769    /** Stop applying patches when reaching that sha1 */
 770    std::string ServerSha1;
 771
 772    /** The current status of this patch. */
 773    enum DiffState
 774      {
 775         /** \brief The diff is in an unknown state. */
 776          StateFetchUnkown,
 777
 778          /** \brief The diff is currently being fetched. */
 779          StateFetchDiff,
 780
 781          /** \brief The diff is currently being uncompressed. */
 782          StateUnzipDiff, // FIXME: No longer used
 783
 784          /** \brief The diff is currently being applied. */
 785          StateApplyDiff
 786    } State;
 787
 788    public:
 789
 790    /** \brief Called when the patch file failed to be downloaded.
 791     *
 792     *  This method will fall back to downloading the whole index file
 793     *  outright; its arguments are ignored.
 794     */
 795    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 796
 797    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
 798                      pkgAcquire::MethodConfig *Cnf);
 799    virtual std::string DescURI() const {return RealURI + "Index";};
 800
 801    /** \brief Create an index diff item.
 802     *
 803     *  After filling in its basic fields, this invokes Finish(true) if
 804     *  \a diffs is empty, or QueueNextDiff() otherwise.
 805     *
 806     *  \param Owner The pkgAcquire object that owns this item.
 807     *
 808     *  \param URI The URI of the package index file being
 809     *  reconstructed.
 810     *
 811     *  \param URIDesc A long description of this item.
 812     *
 813     *  \param ShortDesc A brief description of this item.
 814     *
 815     *  \param ExpectedHashes The expected md5sum of the completely
 816     *  reconstructed package index file; the index file will be tested
 817     *  against this value when it is entirely reconstructed.
 818     *
 819     *  \param ServerSha1 is the sha1sum of the current file on the server
 820     *
 821     *  \param diffs The remaining diffs from the index of diffs.  They
 822     *  should be ordered so that each diff appears before any diff
 823     *  that depends on it.
 824     */
 825    pkgAcqIndexDiffs(pkgAcqMetaIndex *MetaIndexOwner,
 826                     struct IndexTarget const * const Target,
 827                     HashStringList const &ExpectedHash,
 828                     indexRecords *MetaIndexParser,
 829                     std::string ServerSha1,
 830                     std::vector<DiffInfo> diffs=std::vector<DiffInfo>());
 831 };
 832                                                                         /*}}}*/
 833 /** \brief An acquire item that is responsible for fetching an index    {{{
 834  *  file (e.g., Packages or Sources).
 835  *
 836  *  \sa pkgAcqDiffIndex, pkgAcqIndexDiffs, pkgAcqIndexTrans
 837  *
 838  *  \todo Why does pkgAcqIndex have protected members?
 839  */
 840 class pkgAcqIndex : public pkgAcqBaseIndex
 841 {
 842    protected:
 843
 844    /** \brief If \b true, the index file has been decompressed. */
 845    bool Decompression;
 846
 847    /** \brief If \b true, the partially downloaded file will be
 848     *  removed when the download completes.
 849     */
 850    bool Erase;
 851
 852    // Unused, used to be used to verify that "Packages: " header was there
 853    bool __DELME_ON_NEXT_ABI_BREAK_Verify;
 854
 855    /** \brief The object that is actually being fetched (minus any
 856     *  compression-related extensions).
 857     */
 858    std::string RealURI;
 859
 860    /** \brief The compression-related file extensions that are being
 861     *  added to the downloaded file one by one if first fails (e.g., "gz bz2").
 862     */
 863    std::string CompressionExtension;
 864
 865    /** \brief Do the changes needed to fetch via AptByHash (if needed) */
 866    void InitByHashIfNeeded(const std::string MetaKey);
 867
 868    /** \brief Auto select the right compression to use */
 869    void AutoSelectCompression();
 870
 871    public:
 872
 873    // Specialized action members
 874    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 875    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
 876                      pkgAcquire::MethodConfig *Cnf);
 877    virtual std::string Custom600Headers() const;
 878    virtual std::string DescURI() const {return Desc.URI;};
 879
 880    /** \brief Create a pkgAcqIndex.
 881     *
 882     *  \param Owner The pkgAcquire object with which this item is
 883     *  associated.
 884     *
 885     *  \param URI The URI of the index file that is to be downloaded.
 886     *
 887     *  \param URIDesc A "URI-style" description of this index file.
 888     *
 889     *  \param ShortDesc A brief description of this index file.
 890     *
 891     *  \param ExpectedHashes The expected hashsum of this index file.
 892     *
 893     *  \param compressExt The compression-related extension with which
 894     *  this index file should be downloaded, or "" to autodetect
 895     *  Compression types can be set with config Acquire::CompressionTypes,
 896     *  default is ".lzma" or ".bz2" (if the needed binaries are present)
 897     *  fallback is ".gz" or none.
 898     */
 899    pkgAcqIndex(pkgAcquire *Owner,std::string URI,std::string URIDesc,
 900                std::string ShortDesc, HashStringList const &ExpectedHashes,
 901                std::string compressExt="");
 902 #if 0
 903    pkgAcqIndex(pkgAcquire *Owner,
 904                IndexTarget const * const Target,
 905                HashStringList const &ExpectedHash,
 906                indexRecords *MetaIndexParser);
 907 #endif
 908    pkgAcqIndex(pkgAcqMetaIndex *MetaIndexOwner,
 909                IndexTarget const * const Target,
 910                HashStringList const &ExpectedHash,
 911                indexRecords *MetaIndexParser);
 912
 913    void Init(std::string const &URI, std::string const &URIDesc,
 914              std::string const &ShortDesc);
 915 };
 916                                                                         /*}}}*/
 917 /** \brief An acquire item that is responsible for fetching a           {{{
 918  *  translated index file.
 919  *
 920  *  The only difference from pkgAcqIndex is that transient failures
 921  *  are suppressed: no error occurs if the translated index file is
 922  *  missing.
 923  */
 924 class pkgAcqIndexTrans : public pkgAcqIndex
 925 {
 926    public:
 927
 928    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 929    virtual std::string Custom600Headers() const;
 930
 931    /** \brief Create a pkgAcqIndexTrans.
 932     *
 933     *  \param Owner The pkgAcquire object with which this item is
 934     *  associated.
 935     *
 936     *  \param URI The URI of the index file that is to be downloaded.
 937     *
 938     *  \param URIDesc A "URI-style" description of this index file.
 939     *
 940     *  \param ShortDesc A brief description of this index file.
 941     */
 942    pkgAcqIndexTrans(pkgAcquire *Owner,
 943                     std::string URI,std::string URIDesc,
 944                     std::string ShortDesc);
 945    pkgAcqIndexTrans(pkgAcqMetaIndex *Owner, IndexTarget const * const Target,
 946                     HashStringList const &ExpectedHashes,
 947                     indexRecords *MetaIndexParser);
 948 };
 949                                                                         /*}}}*/
 950 /** \brief Information about an index file. */                          /*{{{*/
 951 class IndexTarget
 952 {
 953  public:
 954    /** \brief A URI from which the index file can be downloaded. */
 955    std::string URI;
 956
 957    /** \brief A description of the index file. */
 958    std::string Description;
 959
 960    /** \brief A shorter description of the index file. */
 961    std::string ShortDesc;
 962
 963    /** \brief The key by which this index file should be
 964     *  looked up within the meta signature file.
 965     */
 966    std::string MetaKey;
 967
 968    virtual bool IsOptional() const {
 969       return false;
 970    }
 971    virtual bool IsSubIndex() const {
 972       return false;
 973    }
 974 };
 975                                                                         /*}}}*/
 976 /** \brief Information about an optional index file. */                 /*{{{*/
 977 class OptionalIndexTarget : public IndexTarget
 978 {
 979    virtual bool IsOptional() const {
 980       return true;
 981    }
 982 };
 983                                                                         /*}}}*/
 984 /** \brief Information about an subindex index file. */                 /*{{{*/
 985 class SubIndexTarget : public IndexTarget
 986 {
 987    virtual bool IsSubIndex() const {
 988       return true;
 989    }
 990 };
 991                                                                         /*}}}*/
 992 /** \brief Information about an subindex index file. */                 /*{{{*/
 993 class OptionalSubIndexTarget : public OptionalIndexTarget
 994 {
 995    virtual bool IsSubIndex() const {
 996       return true;
 997    }
 998 };
 999                                                                         /*}}}*/
1000
1001 /** \brief An acquire item that downloads the detached signature        {{{
1002  *  of a meta-index (Release) file, then queues up the release
1003  *  file itself.
1004  *
1005  *  \todo Why protected members?
1006  *
1007  *  \sa pkgAcqMetaIndex
1008  */
1009 class pkgAcqMetaSig : public pkgAcquire::Item
1010 {
1011    protected:
1012    /** \brief The last good signature file */
1013    std::string LastGoodSig;
1014
1015    /** \brief The URI of the signature file.  Unlike Desc.URI, this is
1016     *  never modified; it is used to determine the file that is being
1017     *  downloaded.
1018     */
1019    std::string RealURI;
1020
1021    /** \brief A package-system-specific parser for the meta-index file. */
1022    indexRecords* MetaIndexParser;
1023
1024    /** \brief The file we need to verify */
1025    std::string MetaIndexFile;
1026
1027    /** \brief The index files which should be looked up in the meta-index
1028     *  and then downloaded.
1029     *
1030     *  \todo Why a list of pointers instead of a list of structs?
1031     */
1032    const std::vector<IndexTarget*>* IndexTargets;
1033
1034    /** \brief if we are in fetching or download state */
1035    bool AuthPass;
1036
1037    public:
1038
1039    // Specialized action members
1040    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
1041    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
1042                      pkgAcquire::MethodConfig *Cnf);
1043    virtual std::string Custom600Headers() const;
1044    virtual std::string DescURI() const {return RealURI; };
1045
1046    /** \brief Create a new pkgAcqMetaSig. */
1047    pkgAcqMetaSig(pkgAcqMetaIndex *MetaOwner,
1048                  std::string URI,std::string URIDesc, std::string ShortDesc,
1049                  std::string MetaIndexFile,
1050                  const std::vector<IndexTarget*>* IndexTargets,
1051                  indexRecords* MetaIndexParser);
1052    virtual ~pkgAcqMetaSig();
1053 };
1054                                                                         /*}}}*/
1055 /** \brief An item that is responsible for fetching a package file.     {{{
1056  *
1057  *  If the package file already exists in the cache, nothing will be
1058  *  done.
1059  */
1060 class pkgAcqArchive : public pkgAcquire::Item
1061 {
1062    protected:
1063    /** \brief The package version being fetched. */
1064    pkgCache::VerIterator Version;
1065
1066    /** \brief The list of sources from which to pick archives to
1067     *  download this package from.
1068     */
1069    pkgSourceList *Sources;
1070
1071    /** \brief A package records object, used to look up the file
1072     *  corresponding to each version of the package.
1073     */
1074    pkgRecords *Recs;
1075
1076    /** \brief A location in which the actual filename of the package
1077     *  should be stored.
1078     */
1079    std::string &StoreFilename;
1080
1081    /** \brief The next file for this version to try to download. */
1082    pkgCache::VerFileIterator Vf;
1083
1084    /** \brief How many (more) times to try to find a new source from
1085     *  which to download this package version if it fails.
1086     *
1087     *  Set from Acquire::Retries.
1088     */
1089    unsigned int Retries;
1090
1091    /** \brief \b true if this version file is being downloaded from a
1092     *  trusted source.
1093     */
1094    bool Trusted;
1095
1096    /** \brief Queue up the next available file for this version. */
1097    bool QueueNext();
1098
1099    public:
1100
1101    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
1102    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
1103                      pkgAcquire::MethodConfig *Cnf);
1104    virtual std::string DescURI() const {return Desc.URI;};
1105    virtual std::string ShortDesc() const {return Desc.ShortDesc;};
1106    virtual void Finished();
1107    virtual bool IsTrusted() const;
1108
1109    /** \brief Create a new pkgAcqArchive.
1110     *
1111     *  \param Owner The pkgAcquire object with which this item is
1112     *  associated.
1113     *
1114     *  \param Sources The sources from which to download version
1115     *  files.
1116     *
1117     *  \param Recs A package records object, used to look up the file
1118     *  corresponding to each version of the package.
1119     *
1120     *  \param Version The package version to download.
1121     *
1122     *  \param[out] StoreFilename A location in which the actual filename of
1123     *  the package should be stored.  It will be set to a guessed
1124     *  basename in the constructor, and filled in with a fully
1125     *  qualified filename once the download finishes.
1126     */
1127    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
1128                  pkgRecords *Recs,pkgCache::VerIterator const &Version,
1129                  std::string &StoreFilename);
1130 };
1131                                                                         /*}}}*/
1132 /** \brief Retrieve an arbitrary file to the current directory.         {{{
1133  *
1134  *  The file is retrieved even if it is accessed via a URL type that
1135  *  normally is a NOP, such as "file".  If the download fails, the
1136  *  partial file is renamed to get a ".FAILED" extension.
1137  */
1138 class pkgAcqFile : public pkgAcquire::Item
1139 {
1140    /** \brief How many times to retry the download, set from
1141     *  Acquire::Retries.
1142     */
1143    unsigned int Retries;
1144
1145    /** \brief Should this file be considered a index file */
1146    bool IsIndexFile;
1147
1148    public:
1149
1150    // Specialized action members
1151    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
1152    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &CalcHashes,
1153                      pkgAcquire::MethodConfig *Cnf);
1154    virtual std::string DescURI() const {return Desc.URI;};
1155    virtual std::string Custom600Headers() const;
1156
1157    /** \brief Create a new pkgAcqFile object.
1158     *
1159     *  \param Owner The pkgAcquire object with which this object is
1160     *  associated.
1161     *
1162     *  \param URI The URI to download.
1163     *
1164     *  \param Hashes The hashsums of the file to download, if they are known;
1165     *  otherwise empty list.
1166     *
1167     *  \param Size The size of the file to download, if it is known;
1168     *  otherwise 0.
1169     *
1170     *  \param Desc A description of the file being downloaded.
1171     *
1172     *  \param ShortDesc A brief description of the file being
1173     *  downloaded.
1174     *
1175     *  \param DestDir The directory the file should be downloaded into.
1176     *
1177     *  \param DestFilename The filename+path the file is downloaded to.
1178     *
1179     *  \param IsIndexFile The file is considered a IndexFile and cache-control
1180     *                     headers like "cache-control: max-age=0" are send
1181     *
1182     * If DestFilename is empty, download to DestDir/\<basename\> if
1183     * DestDir is non-empty, $CWD/\<basename\> otherwise.  If
1184     * DestFilename is NOT empty, DestDir is ignored and DestFilename
1185     * is the absolute name to which the file should be downloaded.
1186     */
1187
1188    pkgAcqFile(pkgAcquire *Owner, std::string URI, HashStringList const &Hashes, unsigned long long Size,
1189               std::string Desc, std::string ShortDesc,
1190               const std::string &DestDir="", const std::string &DestFilename="",
1191               bool IsIndexFile=false);
1192 };
1193                                                                         /*}}}*/
1194 /** @} */
1195
1196 #endif