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