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/hashes.h>
  24 #include <apt-pkg/macros.h>
  25
  26 #include <stdarg.h>
  27 #include <time.h>
  28
  29 #include <string>
  30 #include <vector>
  31
  32 #ifndef APT_8_CLEANER_HEADERS
  33 #include <apt-pkg/configuration.h>
  34 #include <apt-pkg/strutl.h>
  35 #endif
  36
  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       HashStringList ExpectedHashes;
  51       // a maximum size we will download, this can be the exact filesize
  52       // for when we know it or a arbitrary limit when we don't know the
  53       // filesize (like a InRelease file)
  54       unsigned long long MaximumSize;
  55    };
  56
  57    struct FetchResult
  58    {
  59       HashStringList Hashes;
  60       std::vector<std::string> GPGVOutput;
  61       time_t LastModified;
  62       bool IMSHit;
  63       std::string Filename;
  64       unsigned long long Size;
  65       unsigned long long ResumePoint;
  66
  67       void TakeHashes(class Hashes &Hash);
  68       FetchResult();
  69    };
  70
  71    // State
  72    std::vector<std::string> Messages;
  73    FetchItem *Queue;
  74    FetchItem *QueueBack;
  75    std::string FailReason;
  76    std::string UsedMirror;
  77    std::string IP;
  78
  79    // Handlers for messages
  80    virtual bool Configuration(std::string Message);
  81    virtual bool Fetch(FetchItem * /*Item*/) {return true;};
  82
  83    // Outgoing messages
  84    void Fail(bool Transient = false);
  85    inline void Fail(const char *Why, bool Transient = false) {Fail(std::string(Why),Transient);};
  86    virtual void Fail(std::string Why, bool Transient = false);
  87    virtual void URIStart(FetchResult &Res);
  88    virtual void URIDone(FetchResult &Res,FetchResult *Alt = 0);
  89
  90    bool MediaFail(std::string Required,std::string Drive);
  91    virtual void Exit() {};
  92
  93    void PrintStatus(char const * const header, const char* Format, va_list &args) const;
  94
  95    public:
  96    enum CnfFlags {SingleInstance = (1<<0),
  97                   Pipeline = (1<<1), SendConfig = (1<<2),
  98                   LocalOnly = (1<<3), NeedsCleanup = (1<<4),
  99                   Removable = (1<<5)};
 100
 101    void Log(const char *Format,...);
 102    void Status(const char *Format,...);
 103
 104    void Redirect(const std::string &NewURI);
 105
 106    int Run(bool Single = false);
 107    inline void SetFailReason(std::string Msg) {FailReason = Msg;};
 108    inline void SetIP(std::string aIP) {IP = aIP;};
 109
 110    pkgAcqMethod(const char *Ver,unsigned long Flags = 0);
 111    virtual ~pkgAcqMethod() {};
 112    void DropPrivsOrDie();
 113    private:
 114    APT_HIDDEN void Dequeue();
 115 };
 116
 117 /** @} */
 118
 119 #endif