apt-pkg/acquire-method.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: acquire-method.h,v 1.14 2001/02/20 07:03:17 jgg 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 pkgAcqMethod
  24 {
  25    protected:
  26
  27    struct FetchItem
  28    {
  29       FetchItem *Next;
  30
  31       string Uri;
  32       string DestFile;
  33       time_t LastModified;
  34       bool IndexFile;
  35    };
  36
  37    struct FetchResult
  38    {
  39       string MD5Sum;
  40       time_t LastModified;
  41       bool IMSHit;
  42       string Filename;
  43       unsigned long Size;
  44       unsigned long ResumePoint;
  45       FetchResult();
  46    };
  47
  48    // State
  49    vector<string> Messages;
  50    FetchItem *Queue;
  51    FetchItem *QueueBack;
  52    string FailExtra;
  53
  54    // Handlers for messages
  55    virtual bool Configuration(string Message);
  56    virtual bool Fetch(FetchItem * /*Item*/) {return true;};
  57
  58    // Outgoing messages
  59    void Fail(bool Transient = false);
  60    inline void Fail(const char *Why, bool Transient = false) {Fail(string(Why),Transient);};
  61    void Fail(string Why, bool Transient = false);
  62    void URIStart(FetchResult &Res);
  63    void URIDone(FetchResult &Res,FetchResult *Alt = 0);
  64    bool MediaFail(string Required,string Drive);
  65    virtual void Exit() {};
  66
  67    public:
  68
  69    enum CnfFlags {SingleInstance = (1<<0),
  70                   Pipeline = (1<<1), SendConfig = (1<<2),
  71                   LocalOnly = (1<<3), NeedsCleanup = (1<<4),
  72                   Removable = (1<<5)};
  73
  74    void Log(const char *Format,...);
  75    void Status(const char *Format,...);
  76
  77    int Run(bool Single = false);
  78    inline void SetFailExtraMsg(string Msg) {FailExtra = Msg;};
  79
  80    pkgAcqMethod(const char *Ver,unsigned long Flags = 0);
  81    virtual ~pkgAcqMethod() {};
  82 };
  83
  84 #endif