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