apt-pkg/acquire-item.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: acquire-item.h,v 1.19 1999/04/11 21:23:09 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    unsigned long PartialSize;
  52    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    virtual void Start(string Message,unsigned long Size);
  67    virtual string Custom600Headers() {return string();};
  68    virtual string DescURI() = 0;
  69
  70    // Inquire functions
  71    virtual string MD5Sum() {return string();};
  72
  73    Item(pkgAcquire *Owner);
  74    virtual ~Item();
  75 };
  76
  77 // Item class for index files
  78 class pkgAcqIndex : public pkgAcquire::Item
  79 {
  80    protected:
  81
  82    const pkgSourceList::Item *Location;
  83    bool Decompression;
  84    bool Erase;
  85    pkgAcquire::ItemDesc Desc;
  86
  87    public:
  88
  89    // Specialized action members
  90    virtual void Done(string Message,unsigned long Size,string Md5Hash);
  91    virtual string Custom600Headers();
  92    virtual string DescURI() {return Location->PackagesURI();};
  93
  94    pkgAcqIndex(pkgAcquire *Owner,const pkgSourceList::Item *Location);
  95 };
  96
  97 // Item class for index files
  98 class pkgAcqIndexRel : public pkgAcquire::Item
  99 {
 100    protected:
 101
 102    const pkgSourceList::Item *Location;
 103    pkgAcquire::ItemDesc Desc;
 104
 105    public:
 106
 107    // Specialized action members
 108    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 109    virtual void Done(string Message,unsigned long Size,string Md5Hash);
 110    virtual string Custom600Headers();
 111    virtual string DescURI() {return Location->ReleaseURI();};
 112
 113    pkgAcqIndexRel(pkgAcquire *Owner,const pkgSourceList::Item *Location);
 114 };
 115
 116 // Item class for archive files
 117 class pkgAcqArchive : public pkgAcquire::Item
 118 {
 119    protected:
 120
 121    // State information for the retry mechanism
 122    pkgCache::VerIterator Version;
 123    pkgAcquire::ItemDesc Desc;
 124    pkgSourceList *Sources;
 125    pkgRecords *Recs;
 126    string MD5;
 127    string &StoreFilename;
 128    pkgCache::VerFileIterator Vf;
 129    unsigned int Retries;
 130
 131    // Queue the next available file for download.
 132    bool QueueNext();
 133
 134    public:
 135
 136    // Specialized action members
 137    virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
 138    virtual void Done(string Message,unsigned long Size,string Md5Hash);
 139    virtual string MD5Sum() {return MD5;};
 140    virtual string DescURI() {return Desc.URI;};
 141
 142    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
 143                  pkgRecords *Recs,pkgCache::VerIterator const &Version,
 144                  string &StoreFilename);
 145 };
 146
 147 // Fetch a generic file to the current directory
 148 class pkgAcqFile : public pkgAcquire::Item
 149 {
 150    pkgAcquire::ItemDesc Desc;
 151    string MD5;
 152
 153    public:
 154
 155    // Specialized action members
 156    virtual void Done(string Message,unsigned long Size,string Md5Hash);
 157    virtual string MD5Sum() {return MD5;};
 158    virtual string DescURI() {return Desc.URI;};
 159
 160    pkgAcqFile(pkgAcquire *Owner,string URI,string MD5,unsigned long Size,
 161                   string Desc,string ShortDesc);
 162 };
 163
 164 #endif