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/macros.h>
  24
  25 #include <stdarg.h>
  26 #include <time.h>
  27
  28 #include <string>
  29 #include <vector>
  30
  31 #ifndef APT_8_CLEANER_HEADERS
  32 #include <apt-pkg/configuration.h>
  33 #include <apt-pkg/strutl.h>
  34 #endif
  35
  36 class Hashes;
  37 class pkgAcqMethod
  38 {
  39    protected:
  40
  41    struct FetchItem
  42    {
  43       FetchItem *Next;
  44
  45       std::string Uri;
  46       std::string DestFile;
  47       time_t LastModified;
  48       bool IndexFile;
  49       bool FailIgnore;
  50    };
  51
  52    struct FetchResult
  53    {
  54       std::string MD5Sum;
  55       std::string SHA1Sum;
  56       std::string SHA256Sum;
  57       std::string SHA512Sum;
  58       std::vector<std::string> GPGVOutput;
  59       time_t LastModified;
  60       bool IMSHit;
  61       std::string Filename;
  62       unsigned long long Size;
  63       unsigned long long ResumePoint;
  64
  65       void TakeHashes(Hashes &Hash);
  66       FetchResult();
  67    };
  68
  69    // State
  70    std::vector<std::string> Messages;
  71    FetchItem *Queue;
  72    FetchItem *QueueBack;
  73    std::string FailReason;
  74    std::string UsedMirror;
  75    std::string IP;
  76
  77    // Handlers for messages
  78    virtual bool Configuration(std::string Message);
  79    virtual bool Fetch(FetchItem * /*Item*/) {return true;};
  80
  81    // Outgoing messages
  82    void Fail(bool Transient = false);
  83    inline void Fail(const char *Why, bool Transient = false) {Fail(std::string(Why),Transient);};
  84    virtual void Fail(std::string Why, bool Transient = false);
  85    virtual void URIStart(FetchResult &Res);
  86    virtual void URIDone(FetchResult &Res,FetchResult *Alt = 0);
  87
  88    bool MediaFail(std::string Required,std::string Drive);
  89    virtual void Exit() {};
  90
  91    void PrintStatus(char const * const header, const char* Format, va_list &args) const;
  92
  93    public:
  94    enum CnfFlags {SingleInstance = (1<<0),
  95                   Pipeline = (1<<1), SendConfig = (1<<2),
  96                   LocalOnly = (1<<3), NeedsCleanup = (1<<4),
  97                   Removable = (1<<5)};
  98
  99    void Log(const char *Format,...);
 100    void Status(const char *Format,...);
 101
 102    void Redirect(const std::string &NewURI);
 103
 104    int Run(bool Single = false);
 105    inline void SetFailReason(std::string Msg) {FailReason = Msg;};
 106    inline void SetIP(std::string aIP) {IP = aIP;};
 107
 108    pkgAcqMethod(const char *Ver,unsigned long Flags = 0);
 109    virtual ~pkgAcqMethod() {};
 110
 111    private:
 112    APT_HIDDEN void Dequeue();
 113 };
 114
 115 /** @} */
 116
 117 #endif