apt-pkg/acquire-item.h

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