apt-pkg/acquire-item.h

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