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 FailExtra;
  63
  64    // Handlers for messages
  65    virtual bool Configuration(string Message);
  66    virtual bool Fetch(FetchItem * /*Item*/) {return true;};
  67
  68    // Outgoing messages
  69    void Fail(bool Transient = false);
  70    inline void Fail(const char *Why, bool Transient = false) {Fail(string(Why),Transient);};
  71    void Fail(string Why, bool Transient = false);
  72    void URIStart(FetchResult &Res);
  73    void URIDone(FetchResult &Res,FetchResult *Alt = 0);
  74    bool MediaFail(string Required,string Drive);
  75    virtual void Exit() {};
  76
  77    public:
  78
  79    enum CnfFlags {SingleInstance = (1<<0),
  80                   Pipeline = (1<<1), SendConfig = (1<<2),
  81                   LocalOnly = (1<<3), NeedsCleanup = (1<<4),
  82                   Removable = (1<<5)};
  83
  84    void Log(const char *Format,...);
  85    void Status(const char *Format,...);
  86
  87    int Run(bool Single = false);
  88    inline void SetFailExtraMsg(string Msg) {FailExtra = Msg;};
  89
  90    pkgAcqMethod(const char *Ver,unsigned long Flags = 0);
  91    virtual ~pkgAcqMethod() {};
  92 };
  93
  94 /** @} */
  95
  96 #endif