apt-pkg/acquire-item.h

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