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 #ifdef __GNUG__
  20 #pragma interface "apt-pkg/acquire-method.h"
  21 #endif
  22
  23 class Hashes;
  24 class pkgAcqMethod
  25 {
  26    protected:
  27
  28    struct FetchItem
  29    {
  30       FetchItem *Next;
  31
  32       string Uri;
  33       string DestFile;
  34       time_t LastModified;
  35       bool IndexFile;
  36       string ExpectedMD5;
  37    };
  38
  39    struct FetchResult
  40    {
  41       string MD5Sum;
  42       string SHA1Sum;
  43       vector<string> GPGVOutput;
  44       time_t LastModified;
  45       bool IMSHit;
  46       string Filename;
  47       unsigned long Size;
  48       unsigned long ResumePoint;
  49
  50       void TakeHashes(Hashes &Hash);
  51       FetchResult();
  52    };
  53
  54    // State
  55    vector<string> Messages;
  56    FetchItem *Queue;
  57    FetchItem *QueueBack;
  58    string FailReason;
  59    string UsedMirror;
  60    string IP;
  61
  62    // Handlers for messages
  63    virtual bool Configuration(string Message);
  64    virtual bool Fetch(FetchItem * /*Item*/) {return true;};
  65
  66    // Outgoing messages
  67    void Fail(bool Transient = false);
  68    inline void Fail(const char *Why, bool Transient = false) {Fail(string(Why),Transient);};
  69    virtual void Fail(string Why, bool Transient = false);
  70    virtual void URIStart(FetchResult &Res);
  71    virtual void URIDone(FetchResult &Res,FetchResult *Alt = 0);
  72
  73    bool MediaFail(string Required,string Drive);
  74    virtual void Exit() {};
  75
  76    public:
  77    enum CnfFlags {SingleInstance = (1<<0),
  78                   Pipeline = (1<<1), SendConfig = (1<<2),
  79                   LocalOnly = (1<<3), NeedsCleanup = (1<<4),
  80                   Removable = (1<<5)};
  81
  82    void Log(const char *Format,...);
  83    void Status(const char *Format,...);
  84
  85    int Run(bool Single = false);
  86    inline void SetFailReason(string Msg) {FailReason = Msg;};
  87    inline void SetIP(string aIP) {IP = aIP;};
  88
  89    pkgAcqMethod(const char *Ver,unsigned long Flags = 0);
  90    virtual ~pkgAcqMethod() {};
  91 };
  92
  93 #endif