apt-pkg/acquire-item.h

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