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       vector<string> GPGVOutput;
  47       time_t LastModified;
  48       bool IMSHit;
  49       string Filename;
  50       unsigned long Size;
  51       unsigned long ResumePoint;
  52
  53       void TakeHashes(Hashes &Hash);
  54       FetchResult();
  55    };
  56
  57    // State
  58    vector<string> Messages;
  59    FetchItem *Queue;
  60    FetchItem *QueueBack;
  61    string FailExtra;
  62
  63    // Handlers for messages
  64    virtual bool Configuration(string Message);
  65    virtual bool Fetch(FetchItem * /*Item*/) {return true;};
  66
  67    // Outgoing messages
  68    void Fail(bool Transient = false);
  69    inline void Fail(const char *Why, bool Transient = false) {Fail(string(Why),Transient);};
  70    void Fail(string Why, bool Transient = false);
  71    void URIStart(FetchResult &Res);
  72    void URIDone(FetchResult &Res,FetchResult *Alt = 0);
  73    bool MediaFail(string Required,string Drive);
  74    virtual void Exit() {};
  75
  76    public:
  77
  78    enum CnfFlags {SingleInstance = (1<<0),
  79                   Pipeline = (1<<1), SendConfig = (1<<2),
  80                   LocalOnly = (1<<3), NeedsCleanup = (1<<4),
  81                   Removable = (1<<5)};
  82
  83    void Log(const char *Format,...);
  84    void Status(const char *Format,...);
  85
  86    int Run(bool Single = false);
  87    inline void SetFailExtraMsg(string Msg) {FailExtra = Msg;};
  88
  89    pkgAcqMethod(const char *Ver,unsigned long Flags = 0);
  90    virtual ~pkgAcqMethod() {};
  91 };
  92
  93 /** @} */
  94
  95 #endif