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