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