apt-pkg/acquire-item.h

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