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 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/indexfile.h>
  25 #include <apt-pkg/vendor.h>
  26 #include <apt-pkg/sourcelist.h>
  27 #include <apt-pkg/pkgrecords.h>
  28 #include <apt-pkg/indexrecords.h>
  29
  30 #ifdef __GNUG__
  31 #pragma interface "apt-pkg/acquire-item.h"
  32 #endif
  33
  34 // Item to acquire
  35 class pkgAcquire::Item
  36 {
  37    protected:
  38
  39    // Some private helper methods for registering URIs
  40    pkgAcquire *Owner;
  41    inline void QueueURI(ItemDesc &Item)
  42                  {Owner->Enqueue(Item);};
  43    inline void Dequeue() {Owner->Dequeue(this);};
  44
  45    // Safe rename function with timestamp preservation
  46    void Rename(string From,string To);
  47
  48    public:
  49
  50    // State of the item
  51    enum {StatIdle, StatFetching, StatDone, StatError, StatAuthError} Status;
  52    string ErrorText;
  53    unsigned long FileSize;
  54    unsigned long PartialSize;
  55    const char *Mode;
  56    unsigned long ID;
  57    bool Complete;
  58    bool Local;
  59
  60    // Number of queues we are inserted into
  61    unsigned int QueueCounter;
  62
  63    // File to write the fetch into
  64    string DestFile;
  65
  66    // Action members invoked by the worker
  67    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
  68    virtual void Done(string Message,unsigned long Size,string Md5Hash,
  69                      pkgAcquire::MethodConfig *Cnf);
  70    virtual void Start(string Message,unsigned long Size);
  71    virtual string Custom600Headers() {return string();};
  72    virtual string DescURI() = 0;
  73    virtual string ShortDesc() {return DescURI();}
  74    virtual void Finished() {};
  75
  76    // Inquire functions
  77    virtual string MD5Sum() {return string();};
  78    pkgAcquire *GetOwner() {return Owner;};
  79    virtual bool IsTrusted() {return false;};
  80
  81    Item(pkgAcquire *Owner);
  82    virtual ~Item();
  83 };
  84
  85 // Item class for index files
  86 class pkgAcqIndex : public pkgAcquire::Item
  87 {
  88    protected:
  89
  90    bool Decompression;
  91    bool Erase;
  92    pkgAcquire::ItemDesc Desc;
  93    string RealURI;
  94    string ExpectedMD5;
  95    string CompressionExtension;
  96
  97    public:
  98
  99    // Specialized action members
 100    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 101    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 102                      pkgAcquire::MethodConfig *Cnf);
 103    virtual string Custom600Headers();
 104    virtual string DescURI() {return RealURI + CompressionExtension;};
 105
 106    pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,
 107                string ShortDesct, string ExpectedMD5, string compressExt="");
 108 };
 109
 110 // Item class for translated package index files
 111 class pkgAcqIndexTrans : public pkgAcqIndex
 112 {
 113    public:
 114
 115    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 116    pkgAcqIndexTrans(pkgAcquire *Owner,string URI,string URIDesc,
 117                     string ShortDesct);
 118 };
 119
 120 struct IndexTarget
 121 {
 122    string URI;
 123    string Description;
 124    string ShortDesc;
 125    string MetaKey;
 126 };
 127
 128 // Item class for index signatures
 129 class pkgAcqMetaSig : public pkgAcquire::Item
 130 {
 131    protected:
 132
 133    pkgAcquire::ItemDesc Desc;
 134    string RealURI,MetaIndexURI,MetaIndexURIDesc,MetaIndexShortDesc;
 135    indexRecords* MetaIndexParser;
 136    const vector<struct IndexTarget*>* IndexTargets;
 137
 138    public:
 139
 140    // Specialized action members
 141    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 142    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 143                      pkgAcquire::MethodConfig *Cnf);
 144    virtual string Custom600Headers();
 145    virtual string DescURI() {return RealURI; };
 146
 147    pkgAcqMetaSig(pkgAcquire *Owner,string URI,string URIDesc, string ShortDesc,
 148                  string MetaIndexURI, string MetaIndexURIDesc, string MetaIndexShortDesc,
 149                  const vector<struct IndexTarget*>* IndexTargets,
 150                  indexRecords* MetaIndexParser);
 151 };
 152
 153 // Item class for index signatures
 154 class pkgAcqMetaIndex : public pkgAcquire::Item
 155 {
 156    protected:
 157
 158    pkgAcquire::ItemDesc Desc;
 159    string RealURI; // FIXME: is this redundant w/ Desc.URI?
 160    string SigFile;
 161    const vector<struct IndexTarget*>* IndexTargets;
 162    indexRecords* MetaIndexParser;
 163    bool AuthPass;
 164
 165    bool VerifyVendor();
 166    void RetrievalDone(string Message);
 167    void AuthDone(string Message);
 168    void QueueIndexes(bool verify);
 169
 170    public:
 171
 172    // Specialized action members
 173    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 174    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 175                      pkgAcquire::MethodConfig *Cnf);
 176    virtual string Custom600Headers();
 177    virtual string DescURI() {return RealURI; };
 178
 179    pkgAcqMetaIndex(pkgAcquire *Owner,
 180                    string URI,string URIDesc, string ShortDesc,
 181                    string SigFile,
 182                    const vector<struct IndexTarget*>* IndexTargets,
 183                    indexRecords* MetaIndexParser);
 184 };
 185
 186 // Item class for archive files
 187 class pkgAcqArchive : public pkgAcquire::Item
 188 {
 189    protected:
 190
 191    // State information for the retry mechanism
 192    pkgCache::VerIterator Version;
 193    pkgAcquire::ItemDesc Desc;
 194    pkgSourceList *Sources;
 195    pkgRecords *Recs;
 196    string MD5;
 197    string &StoreFilename;
 198    pkgCache::VerFileIterator Vf;
 199    unsigned int Retries;
 200    bool Trusted;
 201
 202    // Queue the next available file for download.
 203    bool QueueNext();
 204
 205    public:
 206
 207    // Specialized action members
 208    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 209    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 210                      pkgAcquire::MethodConfig *Cnf);
 211    virtual string MD5Sum() {return MD5;};
 212    virtual string DescURI() {return Desc.URI;};
 213    virtual string ShortDesc() {return Desc.ShortDesc;};
 214    virtual void Finished();
 215    virtual bool IsTrusted();
 216
 217    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
 218                  pkgRecords *Recs,pkgCache::VerIterator const &Version,
 219                  string &StoreFilename);
 220 };
 221
 222 // Fetch a generic file to the current directory
 223 class pkgAcqFile : public pkgAcquire::Item
 224 {
 225    pkgAcquire::ItemDesc Desc;
 226    string Md5Hash;
 227    unsigned int Retries;
 228
 229    public:
 230
 231    // Specialized action members
 232    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 233    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 234                      pkgAcquire::MethodConfig *Cnf);
 235    virtual string MD5Sum() {return Md5Hash;};
 236    virtual string DescURI() {return Desc.URI;};
 237
 238    pkgAcqFile(pkgAcquire *Owner,string URI,string MD5,unsigned long Size,
 239                   string Desc,string ShortDesc);
 240 };
 241
 242 #endif