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