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