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