apt-pkg/acquire-item.h

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