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