apt-pkg/acquire-item.h

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