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 Done(string Message,unsigned long Size,string Md5Hash,
  94                      pkgAcquire::MethodConfig *Cnf);
  95    virtual string Custom600Headers();
  96    virtual string DescURI() {return RealURI + ".gz";};
  97
  98    pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,
  99                string ShortDesct);
 100 };
 101
 102 // Item class for index files
 103 class pkgAcqIndexRel : public pkgAcquire::Item
 104 {
 105    protected:
 106
 107    pkgAcquire::ItemDesc Desc;
 108    string RealURI;
 109
 110    public:
 111
 112    // Specialized action members
 113    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 114    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 115                      pkgAcquire::MethodConfig *Cnf);
 116    virtual string Custom600Headers();
 117    virtual string DescURI() {return RealURI;};
 118
 119    pkgAcqIndexRel(pkgAcquire *Owner,string URI,string URIDesc,
 120                string ShortDesct);
 121 };
 122
 123 // Item class for archive files
 124 class pkgAcqArchive : public pkgAcquire::Item
 125 {
 126    protected:
 127
 128    // State information for the retry mechanism
 129    pkgCache::VerIterator Version;
 130    pkgAcquire::ItemDesc Desc;
 131    pkgSourceList *Sources;
 132    pkgRecords *Recs;
 133    string MD5;
 134    string &StoreFilename;
 135    pkgCache::VerFileIterator Vf;
 136    unsigned int Retries;
 137
 138    // Queue the next available file for download.
 139    bool QueueNext();
 140
 141    public:
 142
 143    // Specialized action members
 144    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 145    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 146                      pkgAcquire::MethodConfig *Cnf);
 147    virtual string MD5Sum() {return MD5;};
 148    virtual string DescURI() {return Desc.URI;};
 149    virtual void Finished();
 150
 151    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
 152                  pkgRecords *Recs,pkgCache::VerIterator const &Version,
 153                  string &StoreFilename);
 154 };
 155
 156 // Fetch a generic file to the current directory
 157 class pkgAcqFile : public pkgAcquire::Item
 158 {
 159    pkgAcquire::ItemDesc Desc;
 160    string Md5Hash;
 161    unsigned int Retries;
 162
 163    public:
 164
 165    // Specialized action members
 166    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 167    virtual void Done(string Message,unsigned long Size,string Md5Hash,
 168                      pkgAcquire::MethodConfig *Cnf);
 169    virtual string MD5Sum() {return Md5Hash;};
 170    virtual string DescURI() {return Desc.URI;};
 171
 172    pkgAcqFile(pkgAcquire *Owner,string URI,string MD5,unsigned long Size,
 173                   string Desc,string ShortDesc);
 174 };
 175
 176 #endif