apt-pkg/acquire-item.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: acquire-item.h,v 1.26 2003/02/02 03:13:13 doogie 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/indexfile.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    unsigned long PartialSize;
  52    const char *Mode;
  53    unsigned long ID;
  54    bool Complete;
  55    bool Local;
  56
  57    // Number of queues we are inserted into
  58    unsigned int QueueCounter;
  59
  60    // File to write the fetch into
  61    string DestFile;
  62
  63    // Action members invoked by the worker
  64    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
  65    virtual void Done(string Message,unsigned long Size,string Md5Hash,
  66                      pkgAcquire::MethodConfig *Cnf);
  67    virtual void Start(string Message,unsigned long Size);
  68    virtual string Custom600Headers() {return string();};
  69    virtual string DescURI() = 0;
  70    virtual void Finished() {};
  71
  72    // Inquire functions
  73    virtual string MD5Sum() {return string();};
  74    pkgAcquire *GetOwner() {return Owner;};
  75
  76    Item(pkgAcquire *Owner);
  77    virtual ~Item();
  78 };
  79
  80 // Item class for index files
  81 class pkgAcqIndex : public pkgAcquire::Item
  82 {
  83    protected:
  84
  85    bool Decompression;
  86    bool Erase;
  87    pkgAcquire::ItemDesc Desc;
  88    string RealURI;
  89
  90    public:
  91
  92    // Specialized action members
  93    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
  94    virtual void Done(string Message,unsigned long Size,string Md5Hash,
  95                      pkgAcquire::MethodConfig *Cnf);
  96    virtual string Custom600Headers();
  97    virtual string DescURI() {return RealURI + ".gz";};
  98
  99    pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,
 100                string ShortDesct);
 101 };
 102
 103 // Item class for index files
 104 class pkgAcqIndexRel : public pkgAcquire::Item
 105 {
 106    protected:
 107
 108    pkgAcquire::ItemDesc Desc;
 109    string RealURI;
 110
 111    public:
 112
 113    // Specialized action members
 114    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 115    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 116                      pkgAcquire::MethodConfig *Cnf);
 117    virtual string Custom600Headers();
 118    virtual string DescURI() {return RealURI;};
 119
 120    pkgAcqIndexRel(pkgAcquire *Owner,string URI,string URIDesc,
 121                string ShortDesct);
 122 };
 123
 124 // Item class for archive files
 125 class pkgAcqArchive : public pkgAcquire::Item
 126 {
 127    protected:
 128
 129    // State information for the retry mechanism
 130    pkgCache::VerIterator Version;
 131    pkgAcquire::ItemDesc Desc;
 132    pkgSourceList *Sources;
 133    pkgRecords *Recs;
 134    string MD5;
 135    string &StoreFilename;
 136    pkgCache::VerFileIterator Vf;
 137    unsigned int Retries;
 138
 139    // Queue the next available file for download.
 140    bool QueueNext();
 141
 142    public:
 143
 144    // Specialized action members
 145    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 146    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 147                      pkgAcquire::MethodConfig *Cnf);
 148    virtual string MD5Sum() {return MD5;};
 149    virtual string DescURI() {return Desc.URI;};
 150    virtual void Finished();
 151
 152    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
 153                  pkgRecords *Recs,pkgCache::VerIterator const &Version,
 154                  string &StoreFilename);
 155 };
 156
 157 // Fetch a generic file to the current directory
 158 class pkgAcqFile : public pkgAcquire::Item
 159 {
 160    pkgAcquire::ItemDesc Desc;
 161    string Md5Hash;
 162    unsigned int Retries;
 163
 164    public:
 165
 166    // Specialized action members
 167    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 168    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 169                      pkgAcquire::MethodConfig *Cnf);
 170    virtual string MD5Sum() {return Md5Hash;};
 171    virtual string DescURI() {return Desc.URI;};
 172
 173    pkgAcqFile(pkgAcquire *Owner,string URI,string MD5,unsigned long Size,
 174                   string Desc,string ShortDesc);
 175 };
 176
 177 #endif