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 for index diffs
  86
  87 struct DiffInfo {
  88    string file;
  89    string sha1;
  90    unsigned long size;
  91 };
  92
  93 class pkgAcqDiffIndex : public pkgAcquire::Item
  94 {
  95  protected:
  96    bool Debug;
  97    pkgAcquire::ItemDesc Desc;
  98    string RealURI;
  99    string ExpectedMD5;
 100    string CurrentPackagesFile;
 101    string Description;
 102
 103  public:
 104    // Specialized action members
 105    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 106    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 107                      pkgAcquire::MethodConfig *Cnf);
 108    virtual string DescURI() {return RealURI + "Index";};
 109    virtual string Custom600Headers();
 110
 111    // helpers
 112    bool ParseDiffIndex(string IndexDiffFile);
 113
 114    pkgAcqDiffIndex(pkgAcquire *Owner,string URI,string URIDesc,
 115                    string ShortDesct, string ExpectedMD5);
 116 };
 117
 118 class pkgAcqIndexDiffs : public pkgAcquire::Item
 119 {
 120    protected:
 121    bool Debug;
 122    pkgAcquire::ItemDesc Desc;
 123    string RealURI;
 124    string ExpectedMD5;
 125
 126    // this is the SHA-1 sum we expect after the patching
 127    string Description;
 128    vector<DiffInfo> available_patches;
 129    enum {StateFetchIndex,StateFetchDiff,StateUnzipDiff,StateApplyDiff} State;
 130
 131    public:
 132
 133    // Specialized action members
 134    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 135    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 136                      pkgAcquire::MethodConfig *Cnf);
 137    virtual string DescURI() {return RealURI + "Index";};
 138
 139    // various helpers
 140    bool QueueNextDiff();
 141    bool ApplyDiff(string PatchFile);
 142    void Finish(bool allDone=false);
 143
 144    pkgAcqIndexDiffs(pkgAcquire *Owner,string URI,string URIDesc,
 145                     string ShortDesct, string ExpectedMD5,
 146                     vector<DiffInfo> diffs=vector<DiffInfo>());
 147 };
 148
 149 // Item class for index files
 150 class pkgAcqIndex : public pkgAcquire::Item
 151 {
 152    protected:
 153
 154    bool Decompression;
 155    bool Erase;
 156    pkgAcquire::ItemDesc Desc;
 157    string RealURI;
 158    string ExpectedMD5;
 159    string CompressionExtension;
 160
 161    public:
 162
 163    // Specialized action members
 164    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 165    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 166                      pkgAcquire::MethodConfig *Cnf);
 167    virtual string Custom600Headers();
 168    virtual string DescURI() {return RealURI + CompressionExtension;};
 169
 170    pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,
 171                string ShortDesct, string ExpectedMD5, string compressExt="");
 172 };
 173
 174 // Item class for translated package index files
 175 class pkgAcqIndexTrans : public pkgAcqIndex
 176 {
 177    public:
 178
 179    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 180    pkgAcqIndexTrans(pkgAcquire *Owner,string URI,string URIDesc,
 181                     string ShortDesct);
 182 };
 183
 184 struct IndexTarget
 185 {
 186    string URI;
 187    string Description;
 188    string ShortDesc;
 189    string MetaKey;
 190 };
 191
 192 // Item class for index signatures
 193 class pkgAcqMetaSig : public pkgAcquire::Item
 194 {
 195    protected:
 196
 197    pkgAcquire::ItemDesc Desc;
 198    string RealURI,MetaIndexURI,MetaIndexURIDesc,MetaIndexShortDesc;
 199    indexRecords* MetaIndexParser;
 200    const vector<struct IndexTarget*>* IndexTargets;
 201
 202    public:
 203
 204    // Specialized action members
 205    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 206    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 207                      pkgAcquire::MethodConfig *Cnf);
 208    virtual string Custom600Headers();
 209    virtual string DescURI() {return RealURI; };
 210
 211    pkgAcqMetaSig(pkgAcquire *Owner,string URI,string URIDesc, string ShortDesc,
 212                  string MetaIndexURI, string MetaIndexURIDesc, string MetaIndexShortDesc,
 213                  const vector<struct IndexTarget*>* IndexTargets,
 214                  indexRecords* MetaIndexParser);
 215 };
 216
 217 // Item class for index signatures
 218 class pkgAcqMetaIndex : public pkgAcquire::Item
 219 {
 220    protected:
 221
 222    pkgAcquire::ItemDesc Desc;
 223    string RealURI; // FIXME: is this redundant w/ Desc.URI?
 224    string SigFile;
 225    const vector<struct IndexTarget*>* IndexTargets;
 226    indexRecords* MetaIndexParser;
 227    bool AuthPass;
 228
 229    bool VerifyVendor();
 230    void RetrievalDone(string Message);
 231    void AuthDone(string Message);
 232    void QueueIndexes(bool verify);
 233
 234    public:
 235
 236    // Specialized action members
 237    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 238    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 239                      pkgAcquire::MethodConfig *Cnf);
 240    virtual string Custom600Headers();
 241    virtual string DescURI() {return RealURI; };
 242
 243    pkgAcqMetaIndex(pkgAcquire *Owner,
 244                    string URI,string URIDesc, string ShortDesc,
 245                    string SigFile,
 246                    const vector<struct IndexTarget*>* IndexTargets,
 247                    indexRecords* MetaIndexParser);
 248 };
 249
 250 // Item class for archive files
 251 class pkgAcqArchive : public pkgAcquire::Item
 252 {
 253    protected:
 254
 255    // State information for the retry mechanism
 256    pkgCache::VerIterator Version;
 257    pkgAcquire::ItemDesc Desc;
 258    pkgSourceList *Sources;
 259    pkgRecords *Recs;
 260    string MD5;
 261    string &StoreFilename;
 262    pkgCache::VerFileIterator Vf;
 263    unsigned int Retries;
 264    bool Trusted;
 265
 266    // Queue the next available file for download.
 267    bool QueueNext();
 268
 269    public:
 270
 271    // Specialized action members
 272    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 273    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 274                      pkgAcquire::MethodConfig *Cnf);
 275    virtual string MD5Sum() {return MD5;};
 276    virtual string DescURI() {return Desc.URI;};
 277    virtual string ShortDesc() {return Desc.ShortDesc;};
 278    virtual void Finished();
 279    virtual bool IsTrusted();
 280
 281    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
 282                  pkgRecords *Recs,pkgCache::VerIterator const &Version,
 283                  string &StoreFilename);
 284 };
 285
 286 // Fetch a generic file to the current directory
 287 class pkgAcqFile : public pkgAcquire::Item
 288 {
 289    pkgAcquire::ItemDesc Desc;
 290    string Md5Hash;
 291    unsigned int Retries;
 292
 293    public:
 294
 295    // Specialized action members
 296    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 297    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 298                      pkgAcquire::MethodConfig *Cnf);
 299    virtual string MD5Sum() {return Md5Hash;};
 300    virtual string DescURI() {return Desc.URI;};
 301
 302    pkgAcqFile(pkgAcquire *Owner,string URI,string MD5,unsigned long Size,
 303                   string Desc,string ShortDesc);
 304 };
 305
 306 #endif