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