apt-pkg/acquire-method.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: acquire-method.h,v 1.15.2.1 2003/12/24 23:09:17 mdz Exp $
   4 /* ######################################################################
   5
   6    Acquire Method - Method helper class + functions
   7
   8    These functions are designed to be used within the method task to
   9    ease communication with APT.
  10
  11    ##################################################################### */
  12                                                                         /*}}}*/
  13 #ifndef PKGLIB_ACQUIRE_METHOD_H
  14 #define PKGLIB_ACQUIRE_METHOD_H
  15
  16 #include <apt-pkg/configuration.h>
  17 #include <apt-pkg/strutl.h>
  18
  19
  20 class Hashes;
  21 class pkgAcqMethod
  22 {
  23    protected:
  24
  25    struct FetchItem
  26    {
  27       FetchItem *Next;
  28
  29       string Uri;
  30       string DestFile;
  31       time_t LastModified;
  32       bool IndexFile;
  33    };
  34
  35    struct FetchResult
  36    {
  37       string MD5Sum;
  38       string SHA1Sum;
  39       vector<string> GPGVOutput;
  40       time_t LastModified;
  41       bool IMSHit;
  42       string Filename;
  43       unsigned long Size;
  44       unsigned long ResumePoint;
  45
  46       void TakeHashes(Hashes &Hash);
  47       FetchResult();
  48    };
  49
  50    // State
  51    vector<string> Messages;
  52    FetchItem *Queue;
  53    FetchItem *QueueBack;
  54    string FailExtra;
  55
  56    // Handlers for messages
  57    virtual bool Configuration(string Message);
  58    virtual bool Fetch(FetchItem * /*Item*/) {return true;};
  59
  60    // Outgoing messages
  61    void Fail(bool Transient = false);
  62    inline void Fail(const char *Why, bool Transient = false) {Fail(string(Why),Transient);};
  63    void Fail(string Why, bool Transient = false);
  64    void URIStart(FetchResult &Res);
  65    void URIDone(FetchResult &Res,FetchResult *Alt = 0);
  66    bool MediaFail(string Required,string Drive);
  67    virtual void Exit() {};
  68
  69    public:
  70
  71    enum CnfFlags {SingleInstance = (1<<0),
  72                   Pipeline = (1<<1), SendConfig = (1<<2),
  73                   LocalOnly = (1<<3), NeedsCleanup = (1<<4),
  74                   Removable = (1<<5)};
  75
  76    void Log(const char *Format,...);
  77    void Status(const char *Format,...);
  78
  79    int Run(bool Single = false);
  80    inline void SetFailExtraMsg(string Msg) {FailExtra = Msg;};
  81
  82    pkgAcqMethod(const char *Ver,unsigned long Flags = 0);
  83    virtual ~pkgAcqMethod() {};
  84 };
  85
  86 #endif