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 #ifdef __GNUG__
  27 #pragma interface "apt-pkg/acquire-method.h"
  28 #endif
  29
  30 class Hashes;
  31 class pkgAcqMethod
  32 {
  33    protected:
  34
  35    struct FetchItem
  36    {
  37       FetchItem *Next;
  38
  39       string Uri;
  40       string DestFile;
  41       time_t LastModified;
  42       bool IndexFile;
  43    };
  44
  45    struct FetchResult
  46    {
  47       string MD5Sum;
  48       string SHA1Sum;
  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 FailExtra;
  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    void Fail(string Why, bool Transient = false);
  74    void URIStart(FetchResult &Res);
  75    void URIDone(FetchResult &Res,FetchResult *Alt = 0);
  76    bool MediaFail(string Required,string Drive);
  77    virtual void Exit() {};
  78
  79    public:
  80
  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 SetFailExtraMsg(string Msg) {FailExtra = Msg;};
  91
  92    pkgAcqMethod(const char *Ver,unsigned long Flags = 0);
  93    virtual ~pkgAcqMethod() {};
  94 };
  95
  96 /** @} */
  97
  98 #endif