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