apt-pkg/acquire-item.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: acquire-item.h,v 1.16 1999/02/01 02:22:11 jgg 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    Two item classes are provided to provide functionality for downloading
  13    of Index files and downloading of Packages.
  14
  15    A Archive class is provided for downloading .deb files. It does Md5
  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/sourcelist.h>
  25 #include <apt-pkg/pkgrecords.h>
  26
  27 #ifdef __GNUG__
  28 #pragma interface "apt-pkg/acquire-item.h"
  29 #endif
  30
  31 // Item to acquire
  32 class pkgAcquire::Item
  33 {
  34    protected:
  35
  36    // Some private helper methods for registering URIs
  37    pkgAcquire *Owner;
  38    inline void QueueURI(ItemDesc &Item)
  39                  {Owner->Enqueue(Item);};
  40    inline void Dequeue() {Owner->Dequeue(this);};
  41
  42    // Safe rename function with timestamp preservation
  43    void Rename(string From,string To);
  44
  45    public:
  46
  47    // State of the item
  48    enum {StatIdle, StatFetching, StatDone, StatError} Status;
  49    string ErrorText;
  50    unsigned long FileSize;
  51    char *Mode;
  52    unsigned long ID;
  53    bool Complete;
  54    bool Local;
  55
  56    // Number of queues we are inserted into
  57    unsigned int QueueCounter;
  58
  59    // File to write the fetch into
  60    string DestFile;
  61
  62    // Action members invoked by the worker
  63    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
  64    virtual void Done(string Message,unsigned long Size,string Md5Hash);
  65    virtual void Start(string Message,unsigned long Size);
  66    virtual string Custom600Headers() {return string();};
  67
  68    // Inquire functions
  69    virtual string MD5Sum() {return string();};
  70    virtual string Describe() = 0;
  71
  72    Item(pkgAcquire *Owner);
  73    virtual ~Item();
  74 };
  75
  76 // Item class for index files
  77 class pkgAcqIndex : public pkgAcquire::Item
  78 {
  79    protected:
  80
  81    const pkgSourceList::Item *Location;
  82    bool Decompression;
  83    bool Erase;
  84    pkgAcquire::ItemDesc Desc;
  85
  86    public:
  87
  88    // Specialized action members
  89    virtual void Done(string Message,unsigned long Size,string Md5Hash);
  90    virtual string Custom600Headers();
  91    virtual string Describe();
  92
  93    pkgAcqIndex(pkgAcquire *Owner,const pkgSourceList::Item *Location);
  94 };
  95
  96 // Item class for index files
  97 class pkgAcqIndexRel : public pkgAcquire::Item
  98 {
  99    protected:
 100
 101    const pkgSourceList::Item *Location;
 102    pkgAcquire::ItemDesc Desc;
 103
 104    public:
 105
 106    // Specialized action members
 107    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 108    virtual void Done(string Message,unsigned long Size,string Md5Hash);
 109    virtual string Custom600Headers();
 110    virtual string Describe();
 111
 112    pkgAcqIndexRel(pkgAcquire *Owner,const pkgSourceList::Item *Location);
 113 };
 114
 115 // Item class for archive files
 116 class pkgAcqArchive : public pkgAcquire::Item
 117 {
 118    protected:
 119
 120    // State information for the retry mechanism
 121    pkgCache::VerIterator Version;
 122    pkgAcquire::ItemDesc Desc;
 123    pkgSourceList *Sources;
 124    pkgRecords *Recs;
 125    string MD5;
 126    string &StoreFilename;
 127    pkgCache::VerFileIterator Vf;
 128    unsigned int Retries;
 129
 130    // Queue the next available file for download.
 131    bool QueueNext();
 132
 133    public:
 134
 135    // Specialized action members
 136    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 137    virtual void Done(string Message,unsigned long Size,string Md5Hash);
 138    virtual string Describe();
 139    virtual string MD5Sum() {return MD5;};
 140
 141    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
 142                  pkgRecords *Recs,pkgCache::VerIterator const &Version,
 143                  string &StoreFilename);
 144 };
 145
 146 #endif