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 #ifndef PKGLIB_ACQUIRE_METHOD_H
  14 #define PKGLIB_ACQUIRE_METHOD_H
  15
  16 #include <apt-pkg/configuration.h>
  17 #include <apt-pkg/strutl.h>
  18
  19 #ifdef __GNUG__
  20 #pragma interface "apt-pkg/acquire-method.h"
  21 #endif
  22
  23 class Hashes;
  24 class pkgAcqMethod
  25 {
  26    protected:
  27
  28    struct FetchItem
  29    {
  30       FetchItem *Next;
  31
  32       string Uri;
  33       string DestFile;
  34       time_t LastModified;
  35       bool IndexFile;
  36    };
  37
  38    struct FetchResult
  39    {
  40       string MD5Sum;
  41       string SHA1Sum;
  42       vector<string> GPGVOutput;
  43       time_t LastModified;
  44       bool IMSHit;
  45       string Filename;
  46       unsigned long Size;
  47       unsigned long ResumePoint;
  48
  49       void TakeHashes(Hashes &Hash);
  50       FetchResult();
  51    };
  52
  53    // State
  54    vector<string> Messages;
  55    FetchItem *Queue;
  56    FetchItem *QueueBack;
  57    string FailExtra;
  58
  59    // Handlers for messages
  60    virtual bool Configuration(string Message);
  61    virtual bool Fetch(FetchItem * /*Item*/) {return true;};
  62
  63    // Outgoing messages
  64    void Fail(bool Transient = false);
  65    inline void Fail(const char *Why, bool Transient = false) {Fail(string(Why),Transient);};
  66    void Fail(string Why, bool Transient = false);
  67    void URIStart(FetchResult &Res);
  68    void URIDone(FetchResult &Res,FetchResult *Alt = 0);
  69    bool MediaFail(string Required,string Drive);
  70    virtual void Exit() {};
  71
  72    public:
  73
  74    enum CnfFlags {SingleInstance = (1<<0),
  75                   Pipeline = (1<<1), SendConfig = (1<<2),
  76                   LocalOnly = (1<<3), NeedsCleanup = (1<<4),
  77                   Removable = (1<<5)};
  78
  79    void Log(const char *Format,...);
  80    void Status(const char *Format,...);
  81
  82    int Run(bool Single = false);
  83    inline void SetFailExtraMsg(string Msg) {FailExtra = Msg;};
  84
  85    pkgAcqMethod(const char *Ver,unsigned long Flags = 0);
  86    virtual ~pkgAcqMethod() {};
  87 };
  88
  89 #endif