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