apt-pkg/acquire-method.h

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