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         unsigned long TransactionID=0);
 302
 303    /** \brief Remove this item from its owner's queue by invoking
 304     *  pkgAcquire::Remove.
 305     */
 306    virtual ~Item();
 307
 308    protected:
 309
 310    enum RenameOnErrorState {
 311       HashSumMismatch,
 312       SizeMismatch,
 313       InvalidFormat
 314    };
 315
 316    /** \brief Rename failed file and set error
 317     *
 318     * \param state respresenting the error we encountered
 319     */
 320    bool RenameOnError(RenameOnErrorState const state);
 321
 322    /** \brief The HashSums of the item is supposed to have than done */
 323    HashStringList ExpectedHashes;
 324
 325    /** \brief The item that is currently being downloaded. */
 326    pkgAcquire::ItemDesc Desc;
 327 };
 328                                                                         /*}}}*/
 329 /** \brief Information about an index patch (aka diff). */              /*{{{*/
 330 struct DiffInfo {
 331    /** The filename of the diff. */
 332    std::string file;
 333
 334    /** The sha1 hash of the diff. */
 335    std::string sha1;
 336
 337    /** The size of the diff. */
 338    unsigned long size;
 339 };
 340                                                                         /*}}}*/
 341 /** \brief An item that is responsible for fetching a SubIndex          {{{
 342  *
 343  *  The MetaIndex file includes only records for important indexes
 344  *  and records for these SubIndex files so these can carry records
 345  *  for addition files like PDiffs and Translations
 346  */
 347 class pkgAcqSubIndex : public pkgAcquire::Item
 348 {
 349  protected:
 350    /** \brief If \b true, debugging information will be written to std::clog. */
 351    bool Debug;
 352
 353  public:
 354    // Specialized action members
 355    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 356    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
 357                      pkgAcquire::MethodConfig *Cnf);
 358    virtual std::string DescURI() const {return Desc.URI;};
 359    virtual std::string Custom600Headers() const;
 360    virtual bool ParseIndex(std::string const &IndexFile);
 361
 362    /** \brief Create a new pkgAcqSubIndex.
 363     *
 364     *  \param Owner The Acquire object that owns this item.
 365     *
 366     *  \param URI The URI of the list file to download.
 367     *
 368     *  \param URIDesc A long description of the list file to download.
 369     *
 370     *  \param ShortDesc A short description of the list file to download.
 371     *
 372     *  \param ExpectedHashes The list file's hashsums which are expected.
 373     */
 374    pkgAcqSubIndex(pkgAcquire *Owner,
 375                   unsigned long TransactionID,
 376                   std::string const &URI,std::string const &URIDesc,
 377                    std::string const &ShortDesc, HashStringList const &ExpectedHashes);
 378 };
 379                                                                         /*}}}*/
 380
 381 /** \brief An item that is responsible for downloading the meta-index   {{{
 382  *  file (i.e., Release) itself and verifying its signature.
 383  *
 384  *  Once the download and verification are complete, the downloads of
 385  *  the individual index files are queued up using pkgAcqDiffIndex.
 386  *  If the meta-index file had a valid signature, the expected hashsums
 387  *  of the index files will be the md5sums listed in the meta-index;
 388  *  otherwise, the expected hashsums will be "" (causing the
 389  *  authentication of the index files to be bypassed).
 390  */
 391 class pkgAcqMetaIndex : public pkgAcquire::Item
 392 {
 393    protected:
 394    /** \brief The URI that is actually being downloaded; never
 395     *  modified by pkgAcqMetaIndex.
 396     */
 397    std::string RealURI;
 398
 399    /** \brief The file in which the signature for this index was stored.
 400     *
 401     *  If empty, the signature and the md5sums of the individual
 402     *  indices will not be checked.
 403     */
 404    std::string SigFile;
 405
 406    /** \brief The index files to download. */
 407    const std::vector<IndexTarget*>* IndexTargets;
 408
 409    /** \brief The parser for the meta-index file. */
 410    indexRecords* MetaIndexParser;
 411
 412    /** \brief If \b true, the index's signature is currently being verified.
 413     */
 414    bool AuthPass;
 415    // required to deal gracefully with problems caused by incorrect ims hits
 416    bool IMSHit;
 417
 418    /** \brief Check that the release file is a release file for the
 419     *  correct distribution.
 420     *
 421     *  \return \b true if no fatal errors were encountered.
 422     */
 423    bool VerifyVendor(std::string Message);
 424
 425    /** \brief Called when a file is finished being retrieved.
 426     *
 427     *  If the file was not downloaded to DestFile, a copy process is
 428     *  set up to copy it to DestFile; otherwise, Complete is set to \b
 429     *  true and the file is moved to its final location.
 430     *
 431     *  \param Message The message block received from the fetch
 432     *  subprocess.
 433     */
 434    void RetrievalDone(std::string Message);
 435
 436    /** \brief Called when authentication succeeded.
 437     *
 438     *  Sanity-checks the authenticated file, queues up the individual
 439     *  index files for download, and saves the signature in the lists
 440     *  directory next to the authenticated list file.
 441     *
 442     *  \param Message The message block received from the fetch
 443     *  subprocess.
 444     */
 445    void AuthDone(std::string Message);
 446
 447    /** \brief Starts downloading the individual index files.
 448     *
 449     *  \param verify If \b true, only indices whose expected hashsum
 450     *  can be determined from the meta-index will be downloaded, and
 451     *  the hashsums of indices will be checked (reporting
 452     *  #StatAuthError if there is a mismatch).  If verify is \b false,
 453     *  no hashsum checking will be performed.
 454     */
 455    void QueueIndexes(bool verify);
 456
 457    /** \brief The URI of the meta-index file for the detached signature */
 458    std::string MetaIndexSigURI;
 459
 460    /** \brief A "URI-style" description of the meta-index file */
 461    std::string MetaIndexSigURIDesc;
 462
 463    /** \brief A brief description of the meta-index file */
 464    std::string MetaIndexSigShortDesc;
 465
 466    /** \brief delayed constructor */
 467    void Init(std::string URIDesc, std::string ShortDesc);
 468
 469    public:
 470
 471    // Specialized action members
 472    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 473    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
 474                      pkgAcquire::MethodConfig *Cnf);
 475    virtual std::string Custom600Headers() const;
 476    virtual std::string DescURI() const {return RealURI; };
 477    virtual void Finished();
 478
 479    /** \brief Create a new pkgAcqMetaIndex. */
 480    pkgAcqMetaIndex(pkgAcquire *Owner,
 481                    unsigned long TransactionID,
 482                    std::string URI,std::string URIDesc, std::string ShortDesc,
 483                    std::string MetaIndexSigURI, std::string MetaIndexSigURIDesc, std::string MetaIndexSigShortDesc,
 484                    const std::vector<IndexTarget*>* IndexTargets,
 485                    indexRecords* MetaIndexParser);
 486 };
 487                                                                         /*}}}*/
 488 /** \brief An item repsonsible for downloading clearsigned metaindexes  {{{*/
 489 class pkgAcqMetaClearSig : public pkgAcqMetaIndex
 490 {
 491    /** \brief The URI of the meta-index file for the detached signature */
 492    std::string MetaIndexURI;
 493
 494    /** \brief A "URI-style" description of the meta-index file */
 495    std::string MetaIndexURIDesc;
 496
 497    /** \brief A brief description of the meta-index file */
 498    std::string MetaIndexShortDesc;
 499
 500    /** \brief The URI of the detached meta-signature file if the clearsigned one failed. */
 501    std::string MetaSigURI;
 502
 503    /** \brief A "URI-style" description of the meta-signature file */
 504    std::string MetaSigURIDesc;
 505
 506    /** \brief A brief description of the meta-signature file */
 507    std::string MetaSigShortDesc;
 508
 509 public:
 510    void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 511    virtual std::string Custom600Headers() const;
 512
 513    /** \brief Create a new pkgAcqMetaClearSig. */
 514    pkgAcqMetaClearSig(pkgAcquire *Owner,
 515                 std::string const &URI, std::string const &URIDesc, std::string const &ShortDesc,
 516                 std::string const &MetaIndexURI, std::string const &MetaIndexURIDesc, std::string const &MetaIndexShortDesc,
 517                 std::string const &MetaSigURI, std::string const &MetaSigURIDesc, std::string const &MetaSigShortDesc,
 518                 const std::vector<IndexTarget*>* IndexTargets,
 519                 indexRecords* MetaIndexParser);
 520    virtual ~pkgAcqMetaClearSig();
 521 };
 522                                                                         /*}}}*/
 523
 524
 525 /** \brief Common base class for all classes that deal with fetching    {{{
 526            indexes
 527  */
 528 class pkgAcqBaseIndex : public pkgAcquire::Item
 529 {
 530  protected:
 531    /** \brief Pointer to the IndexTarget data
 532     */
 533    const struct IndexTarget * Target;
 534    indexRecords *MetaIndexParser;
 535
 536    pkgAcqBaseIndex(pkgAcquire *Owner,
 537                    unsigned long TransactionID,
 538                    struct IndexTarget const * const Target,
 539                    HashStringList const &ExpectedHashes,
 540                    indexRecords *MetaIndexParser)
 541       : Item(Owner, ExpectedHashes), Target(Target),
 542         MetaIndexParser(MetaIndexParser) {};
 543 };
 544                                                                         /*}}}*/
 545 /** \brief An item that is responsible for fetching an index file of    {{{
 546  *  package list diffs and starting the package list's download.
 547  *
 548  *  This item downloads the Index file and parses it, then enqueues
 549  *  additional downloads of either the individual patches (using
 550  *  pkgAcqIndexDiffs) or the entire Packages file (using pkgAcqIndex).
 551  *
 552  *  \sa pkgAcqIndexDiffs, pkgAcqIndex
 553  */
 554 class pkgAcqDiffIndex : public pkgAcqBaseIndex
 555 {
 556  protected:
 557    /** \brief If \b true, debugging information will be written to std::clog. */
 558    bool Debug;
 559
 560    /** \brief The URI of the index file to recreate at our end (either
 561     *  by downloading it or by applying partial patches).
 562     */
 563    std::string RealURI;
 564
 565    /** \brief The index file which will be patched to generate the new
 566     *  file.
 567     */
 568    std::string CurrentPackagesFile;
 569
 570    /** \brief A description of the Packages file (stored in
 571     *  pkgAcquire::ItemDesc::Description).
 572     */
 573    std::string Description;
 574
 575  public:
 576    // Specialized action members
 577    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 578    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
 579                      pkgAcquire::MethodConfig *Cnf);
 580    virtual std::string DescURI() const {return RealURI + "Index";};
 581    virtual std::string Custom600Headers() const;
 582
 583    /** \brief Parse the Index file for a set of Packages diffs.
 584     *
 585     *  Parses the Index file and creates additional download items as
 586     *  necessary.
 587     *
 588     *  \param IndexDiffFile The name of the Index file.
 589     *
 590     *  \return \b true if the Index file was successfully parsed, \b
 591     *  false otherwise.
 592     */
 593    bool ParseDiffIndex(std::string IndexDiffFile);
 594
 595
 596    /** \brief Create a new pkgAcqDiffIndex.
 597     *
 598     *  \param Owner The Acquire object that owns this item.
 599     *
 600     *  \param URI The URI of the list file to download.
 601     *
 602     *  \param URIDesc A long description of the list file to download.
 603     *
 604     *  \param ShortDesc A short description of the list file to download.
 605     *
 606     *  \param ExpectedHashes The list file's hashsums which are expected.
 607     */
 608    pkgAcqDiffIndex(pkgAcquire *Owner,
 609                    unsigned long TransactionID,
 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(pkgAcquire *Owner,
 698                          unsigned long TransactionID,
 699                          struct IndexTarget const * const Target,
 700                          HashStringList const &ExpectedHash,
 701                          indexRecords *MetaIndexParser,
 702                          DiffInfo const &patch,
 703                          std::vector<pkgAcqIndexMergeDiffs*> const * const allPatches);
 704 };
 705                                                                         /*}}}*/
 706 /** \brief An item that is responsible for fetching server-merge patches {{{
 707  *  that need to be applied to a given package index file.
 708  *
 709  *  After downloading and applying a single patch, this item will
 710  *  enqueue a new pkgAcqIndexDiffs to download and apply the remaining
 711  *  patches.  If no patch can be found that applies to an intermediate
 712  *  file or if one of the patches cannot be downloaded, falls back to
 713  *  downloading the entire package index file using pkgAcqIndex.
 714  *
 715  *  \sa pkgAcqDiffIndex, pkgAcqIndex
 716  */
 717 class pkgAcqIndexDiffs : public pkgAcqBaseIndex
 718 {
 719    private:
 720
 721    /** \brief Queue up the next diff download.
 722     *
 723     *  Search for the next available diff that applies to the file
 724     *  that currently exists on disk, and enqueue it by calling
 725     *  QueueURI().
 726     *
 727     *  \return \b true if an applicable diff was found, \b false
 728     *  otherwise.
 729     */
 730    bool QueueNextDiff();
 731
 732    /** \brief Handle tasks that must be performed after the item
 733     *  finishes downloading.
 734     *
 735     *  Dequeues the item and checks the resulting file's hashsums
 736     *  against ExpectedHashes after the last patch was applied.
 737     *  There is no need to check the md5/sha1 after a "normal"
 738     *  patch because QueueNextDiff() will check the sha1 later.
 739     *
 740     *  \param allDone If \b true, the file was entirely reconstructed,
 741     *  and its md5sum is verified.
 742     */
 743    void Finish(bool allDone=false);
 744
 745    protected:
 746
 747    /** \brief If \b true, debugging output will be written to
 748     *  std::clog.
 749     */
 750    bool Debug;
 751
 752    /** \brief The URI of the package index file that is being
 753     *  reconstructed.
 754     */
 755    std::string RealURI;
 756
 757    /** A description of the file being downloaded. */
 758    std::string Description;
 759
 760    /** The patches that remain to be downloaded, including the patch
 761     *  being downloaded right now.  This list should be ordered so
 762     *  that each diff appears before any diff that depends on it.
 763     *
 764     *  \todo These are indexed by sha1sum; why not use some sort of
 765     *  dictionary instead of relying on ordering and stripping them
 766     *  off the front?
 767     */
 768    std::vector<DiffInfo> available_patches;
 769
 770    /** Stop applying patches when reaching that sha1 */
 771    std::string ServerSha1;
 772
 773    /** The current status of this patch. */
 774    enum DiffState
 775      {
 776         /** \brief The diff is in an unknown state. */
 777          StateFetchUnkown,
 778
 779          /** \brief The diff is currently being fetched. */
 780          StateFetchDiff,
 781
 782          /** \brief The diff is currently being uncompressed. */
 783          StateUnzipDiff, // FIXME: No longer used
 784
 785          /** \brief The diff is currently being applied. */
 786          StateApplyDiff
 787    } State;
 788
 789    public:
 790
 791    /** \brief Called when the patch file failed to be downloaded.
 792     *
 793     *  This method will fall back to downloading the whole index file
 794     *  outright; its arguments are ignored.
 795     */
 796    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 797
 798    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
 799                      pkgAcquire::MethodConfig *Cnf);
 800    virtual std::string DescURI() const {return RealURI + "Index";};
 801
 802    /** \brief Create an index diff item.
 803     *
 804     *  After filling in its basic fields, this invokes Finish(true) if
 805     *  \a diffs is empty, or QueueNextDiff() otherwise.
 806     *
 807     *  \param Owner The pkgAcquire object that owns this item.
 808     *
 809     *  \param URI The URI of the package index file being
 810     *  reconstructed.
 811     *
 812     *  \param URIDesc A long description of this item.
 813     *
 814     *  \param ShortDesc A brief description of this item.
 815     *
 816     *  \param ExpectedHashes The expected md5sum of the completely
 817     *  reconstructed package index file; the index file will be tested
 818     *  against this value when it is entirely reconstructed.
 819     *
 820     *  \param ServerSha1 is the sha1sum of the current file on the server
 821     *
 822     *  \param diffs The remaining diffs from the index of diffs.  They
 823     *  should be ordered so that each diff appears before any diff
 824     *  that depends on it.
 825     */
 826    pkgAcqIndexDiffs(pkgAcquire *Owner,
 827                     unsigned long TransactionID,
 828                     struct IndexTarget const * const Target,
 829                     HashStringList const &ExpectedHash,
 830                     indexRecords *MetaIndexParser,
 831                     std::string ServerSha1,
 832                     std::vector<DiffInfo> diffs=std::vector<DiffInfo>());
 833 };
 834                                                                         /*}}}*/
 835 /** \brief An acquire item that is responsible for fetching an index    {{{
 836  *  file (e.g., Packages or Sources).
 837  *
 838  *  \sa pkgAcqDiffIndex, pkgAcqIndexDiffs, pkgAcqIndexTrans
 839  *
 840  *  \todo Why does pkgAcqIndex have protected members?
 841  */
 842 class pkgAcqIndex : public pkgAcqBaseIndex
 843 {
 844    protected:
 845
 846    /** \brief If \b true, the index file has been decompressed. */
 847    bool Decompression;
 848
 849    /** \brief If \b true, the partially downloaded file will be
 850     *  removed when the download completes.
 851     */
 852    bool Erase;
 853
 854    // Unused, used to be used to verify that "Packages: " header was there
 855    bool __DELME_ON_NEXT_ABI_BREAK_Verify;
 856
 857    /** \brief The object that is actually being fetched (minus any
 858     *  compression-related extensions).
 859     */
 860    std::string RealURI;
 861
 862    /** \brief The compression-related file extensions that are being
 863     *  added to the downloaded file one by one if first fails (e.g., "gz bz2").
 864     */
 865    std::string CompressionExtension;
 866
 867    /** \brief Do the changes needed to fetch via AptByHash (if needed) */
 868    void InitByHashIfNeeded(const std::string MetaKey);
 869
 870    /** \brief Auto select the right compression to use */
 871    void AutoSelectCompression();
 872
 873    public:
 874
 875    // Specialized action members
 876    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 877    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
 878                      pkgAcquire::MethodConfig *Cnf);
 879    virtual std::string Custom600Headers() const;
 880    virtual std::string DescURI() const {return Desc.URI;};
 881
 882    /** \brief Create a pkgAcqIndex.
 883     *
 884     *  \param Owner The pkgAcquire object with which this item is
 885     *  associated.
 886     *
 887     *  \param URI The URI of the index file that is to be downloaded.
 888     *
 889     *  \param URIDesc A "URI-style" description of this index file.
 890     *
 891     *  \param ShortDesc A brief description of this index file.
 892     *
 893     *  \param ExpectedHashes The expected hashsum of this index file.
 894     *
 895     *  \param compressExt The compression-related extension with which
 896     *  this index file should be downloaded, or "" to autodetect
 897     *  Compression types can be set with config Acquire::CompressionTypes,
 898     *  default is ".lzma" or ".bz2" (if the needed binaries are present)
 899     *  fallback is ".gz" or none.
 900     */
 901    pkgAcqIndex(pkgAcquire *Owner,std::string URI,std::string URIDesc,
 902                std::string ShortDesc, HashStringList const &ExpectedHashes,
 903                std::string compressExt="");
 904    pkgAcqIndex(pkgAcquire *Owner, unsigned long TransactionID,
 905                IndexTarget const * const Target,
 906                HashStringList const &ExpectedHash,
 907                indexRecords *MetaIndexParser);
 908
 909    void Init(std::string const &URI, std::string const &URIDesc,
 910              std::string const &ShortDesc);
 911 };
 912                                                                         /*}}}*/
 913 /** \brief An acquire item that is responsible for fetching a           {{{
 914  *  translated index file.
 915  *
 916  *  The only difference from pkgAcqIndex is that transient failures
 917  *  are suppressed: no error occurs if the translated index file is
 918  *  missing.
 919  */
 920 class pkgAcqIndexTrans : public pkgAcqIndex
 921 {
 922    public:
 923
 924    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 925    virtual std::string Custom600Headers() const;
 926
 927    /** \brief Create a pkgAcqIndexTrans.
 928     *
 929     *  \param Owner The pkgAcquire object with which this item is
 930     *  associated.
 931     *
 932     *  \param URI The URI of the index file that is to be downloaded.
 933     *
 934     *  \param URIDesc A "URI-style" description of this index file.
 935     *
 936     *  \param ShortDesc A brief description of this index file.
 937     */
 938    pkgAcqIndexTrans(pkgAcquire *Owner,
 939                     std::string URI,std::string URIDesc,
 940                     std::string ShortDesc);
 941    pkgAcqIndexTrans(pkgAcquire *Owner,
 942                     unsigned long TransactionID,
 943                     IndexTarget const * const Target,
 944                     HashStringList const &ExpectedHashes,
 945                     indexRecords *MetaIndexParser);
 946 };
 947                                                                         /*}}}*/
 948 /** \brief Information about an index file. */                          /*{{{*/
 949 class IndexTarget
 950 {
 951  public:
 952    /** \brief A URI from which the index file can be downloaded. */
 953    std::string URI;
 954
 955    /** \brief A description of the index file. */
 956    std::string Description;
 957
 958    /** \brief A shorter description of the index file. */
 959    std::string ShortDesc;
 960
 961    /** \brief The key by which this index file should be
 962     *  looked up within the meta signature file.
 963     */
 964    std::string MetaKey;
 965
 966    virtual bool IsOptional() const {
 967       return false;
 968    }
 969    virtual bool IsSubIndex() const {
 970       return false;
 971    }
 972 };
 973                                                                         /*}}}*/
 974 /** \brief Information about an optional index file. */                 /*{{{*/
 975 class OptionalIndexTarget : public IndexTarget
 976 {
 977    virtual bool IsOptional() const {
 978       return true;
 979    }
 980 };
 981                                                                         /*}}}*/
 982 /** \brief Information about an subindex index file. */                 /*{{{*/
 983 class SubIndexTarget : public IndexTarget
 984 {
 985    virtual bool IsSubIndex() const {
 986       return true;
 987    }
 988 };
 989                                                                         /*}}}*/
 990 /** \brief Information about an subindex index file. */                 /*{{{*/
 991 class OptionalSubIndexTarget : public OptionalIndexTarget
 992 {
 993    virtual bool IsSubIndex() const {
 994       return true;
 995    }
 996 };
 997                                                                         /*}}}*/
 998
 999 /** \brief An acquire item that downloads the detached signature        {{{
1000  *  of a meta-index (Release) file, then queues up the release
1001  *  file itself.
1002  *
1003  *  \todo Why protected members?
1004  *
1005  *  \sa pkgAcqMetaIndex
1006  */
1007 class pkgAcqMetaSig : public pkgAcquire::Item
1008 {
1009    protected:
1010    /** \brief The last good signature file */
1011    std::string LastGoodSig;
1012
1013    /** \brief The URI of the signature file.  Unlike Desc.URI, this is
1014     *  never modified; it is used to determine the file that is being
1015     *  downloaded.
1016     */
1017    std::string RealURI;
1018
1019    /** \brief A package-system-specific parser for the meta-index file. */
1020    indexRecords* MetaIndexParser;
1021
1022    /** \brief The file we need to verify */
1023    std::string MetaIndexFile;
1024
1025    /** \brief The index files which should be looked up in the meta-index
1026     *  and then downloaded.
1027     *
1028     *  \todo Why a list of pointers instead of a list of structs?
1029     */
1030    const std::vector<IndexTarget*>* IndexTargets;
1031
1032    /** \brief If we are in fetching or download state */
1033    bool AuthPass;
1034
1035    /** \brief Was this file already on disk */
1036    bool IMSHit;
1037
1038    public:
1039
1040    // Specialized action members
1041    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
1042    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
1043                      pkgAcquire::MethodConfig *Cnf);
1044    virtual std::string Custom600Headers() const;
1045    virtual std::string DescURI() const {return RealURI; };
1046
1047    /** \brief Create a new pkgAcqMetaSig. */
1048    pkgAcqMetaSig(pkgAcquire *Owner,
1049                  unsigned long TransactionID,
1050                  std::string URI,std::string URIDesc, std::string ShortDesc,
1051                  std::string MetaIndexFile,
1052                  const std::vector<IndexTarget*>* IndexTargets,
1053                  indexRecords* MetaIndexParser);
1054    virtual ~pkgAcqMetaSig();
1055 };
1056                                                                         /*}}}*/
1057 /** \brief An item that is responsible for fetching a package file.     {{{
1058  *
1059  *  If the package file already exists in the cache, nothing will be
1060  *  done.
1061  */
1062 class pkgAcqArchive : public pkgAcquire::Item
1063 {
1064    protected:
1065    /** \brief The package version being fetched. */
1066    pkgCache::VerIterator Version;
1067
1068    /** \brief The list of sources from which to pick archives to
1069     *  download this package from.
1070     */
1071    pkgSourceList *Sources;
1072
1073    /** \brief A package records object, used to look up the file
1074     *  corresponding to each version of the package.
1075     */
1076    pkgRecords *Recs;
1077
1078    /** \brief A location in which the actual filename of the package
1079     *  should be stored.
1080     */
1081    std::string &StoreFilename;
1082
1083    /** \brief The next file for this version to try to download. */
1084    pkgCache::VerFileIterator Vf;
1085
1086    /** \brief How many (more) times to try to find a new source from
1087     *  which to download this package version if it fails.
1088     *
1089     *  Set from Acquire::Retries.
1090     */
1091    unsigned int Retries;
1092
1093    /** \brief \b true if this version file is being downloaded from a
1094     *  trusted source.
1095     */
1096    bool Trusted;
1097
1098    /** \brief Queue up the next available file for this version. */
1099    bool QueueNext();
1100
1101    public:
1102
1103    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
1104    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
1105                      pkgAcquire::MethodConfig *Cnf);
1106    virtual std::string DescURI() const {return Desc.URI;};
1107    virtual std::string ShortDesc() const {return Desc.ShortDesc;};
1108    virtual void Finished();
1109    virtual bool IsTrusted() const;
1110
1111    /** \brief Create a new pkgAcqArchive.
1112     *
1113     *  \param Owner The pkgAcquire object with which this item is
1114     *  associated.
1115     *
1116     *  \param Sources The sources from which to download version
1117     *  files.
1118     *
1119     *  \param Recs A package records object, used to look up the file
1120     *  corresponding to each version of the package.
1121     *
1122     *  \param Version The package version to download.
1123     *
1124     *  \param[out] StoreFilename A location in which the actual filename of
1125     *  the package should be stored.  It will be set to a guessed
1126     *  basename in the constructor, and filled in with a fully
1127     *  qualified filename once the download finishes.
1128     */
1129    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
1130                  pkgRecords *Recs,pkgCache::VerIterator const &Version,
1131                  std::string &StoreFilename);
1132 };
1133                                                                         /*}}}*/
1134 /** \brief Retrieve an arbitrary file to the current directory.         {{{
1135  *
1136  *  The file is retrieved even if it is accessed via a URL type that
1137  *  normally is a NOP, such as "file".  If the download fails, the
1138  *  partial file is renamed to get a ".FAILED" extension.
1139  */
1140 class pkgAcqFile : public pkgAcquire::Item
1141 {
1142    /** \brief How many times to retry the download, set from
1143     *  Acquire::Retries.
1144     */
1145    unsigned int Retries;
1146
1147    /** \brief Should this file be considered a index file */
1148    bool IsIndexFile;
1149
1150    public:
1151
1152    // Specialized action members
1153    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
1154    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &CalcHashes,
1155                      pkgAcquire::MethodConfig *Cnf);
1156    virtual std::string DescURI() const {return Desc.URI;};
1157    virtual std::string Custom600Headers() const;
1158
1159    /** \brief Create a new pkgAcqFile object.
1160     *
1161     *  \param Owner The pkgAcquire object with which this object is
1162     *  associated.
1163     *
1164     *  \param URI The URI to download.
1165     *
1166     *  \param Hashes The hashsums of the file to download, if they are known;
1167     *  otherwise empty list.
1168     *
1169     *  \param Size The size of the file to download, if it is known;
1170     *  otherwise 0.
1171     *
1172     *  \param Desc A description of the file being downloaded.
1173     *
1174     *  \param ShortDesc A brief description of the file being
1175     *  downloaded.
1176     *
1177     *  \param DestDir The directory the file should be downloaded into.
1178     *
1179     *  \param DestFilename The filename+path the file is downloaded to.
1180     *
1181     *  \param IsIndexFile The file is considered a IndexFile and cache-control
1182     *                     headers like "cache-control: max-age=0" are send
1183     *
1184     * If DestFilename is empty, download to DestDir/\<basename\> if
1185     * DestDir is non-empty, $CWD/\<basename\> otherwise.  If
1186     * DestFilename is NOT empty, DestDir is ignored and DestFilename
1187     * is the absolute name to which the file should be downloaded.
1188     */
1189
1190    pkgAcqFile(pkgAcquire *Owner, std::string URI, HashStringList const &Hashes, unsigned long long Size,
1191               std::string Desc, std::string ShortDesc,
1192               const std::string &DestDir="", const std::string &DestFilename="",
1193               bool IsIndexFile=false);
1194 };
1195                                                                         /*}}}*/
1196 /** @} */
1197
1198 #endif