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