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