]>
Commit | Line | Data |
---|---|---|
93bf083d AL |
1 | // -*- mode: cpp; mode: fold -*- |
2 | // Description /*{{{*/ | |
b3d44315 | 3 | // $Id: acquire-method.h,v 1.15.2.1 2003/12/24 23:09:17 mdz Exp $ |
93bf083d AL |
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 | /*}}}*/ | |
3174e150 MV |
13 | |
14 | /** \addtogroup acquire | |
15 | * @{ | |
16 | * | |
17 | * \file acquire-method.h | |
18 | */ | |
19 | ||
93bf083d AL |
20 | #ifndef PKGLIB_ACQUIRE_METHOD_H |
21 | #define PKGLIB_ACQUIRE_METHOD_H | |
22 | ||
b3501edb | 23 | #include <apt-pkg/hashes.h> |
ce62f1de DK |
24 | #include <apt-pkg/macros.h> |
25 | ||
f1bdfe81 | 26 | #include <stdarg.h> |
453b82a3 | 27 | #include <time.h> |
93bf083d | 28 | |
472ff00e DK |
29 | #include <string> |
30 | #include <vector> | |
31 | ||
b9dadc24 DK |
32 | #ifndef APT_8_CLEANER_HEADERS |
33 | #include <apt-pkg/configuration.h> | |
34 | #include <apt-pkg/strutl.h> | |
35 | #endif | |
36 | ||
93bf083d AL |
37 | class pkgAcqMethod |
38 | { | |
39 | protected: | |
93bf083d | 40 | |
be4401bf AL |
41 | struct FetchItem |
42 | { | |
43 | FetchItem *Next; | |
44 | ||
8f3ba4e8 DK |
45 | std::string Uri; |
46 | std::string DestFile; | |
be4401bf | 47 | time_t LastModified; |
a72ace20 | 48 | bool IndexFile; |
963b16dc | 49 | bool FailIgnore; |
d003a557 | 50 | HashStringList ExpectedHashes; |
dcd5856b | 51 | unsigned long long ExpectedSize; |
be4401bf AL |
52 | }; |
53 | ||
93bf083d AL |
54 | struct FetchResult |
55 | { | |
b3501edb | 56 | HashStringList Hashes; |
8f3ba4e8 | 57 | std::vector<std::string> GPGVOutput; |
93bf083d AL |
58 | time_t LastModified; |
59 | bool IMSHit; | |
8f3ba4e8 | 60 | std::string Filename; |
73da43e9 DK |
61 | unsigned long long Size; |
62 | unsigned long long ResumePoint; | |
a7c835af | 63 | |
b3501edb | 64 | void TakeHashes(class Hashes &Hash); |
93bf083d AL |
65 | FetchResult(); |
66 | }; | |
be4401bf AL |
67 | |
68 | // State | |
8f3ba4e8 | 69 | std::vector<std::string> Messages; |
be4401bf | 70 | FetchItem *Queue; |
5cb5d8dc | 71 | FetchItem *QueueBack; |
8f3ba4e8 DK |
72 | std::string FailReason; |
73 | std::string UsedMirror; | |
74 | std::string IP; | |
b2e465d6 | 75 | |
93bf083d | 76 | // Handlers for messages |
8f3ba4e8 | 77 | virtual bool Configuration(std::string Message); |
727f18af | 78 | virtual bool Fetch(FetchItem * /*Item*/) {return true;}; |
93bf083d AL |
79 | |
80 | // Outgoing messages | |
a72ace20 | 81 | void Fail(bool Transient = false); |
8f3ba4e8 DK |
82 | inline void Fail(const char *Why, bool Transient = false) {Fail(std::string(Why),Transient);}; |
83 | virtual void Fail(std::string Why, bool Transient = false); | |
14e097c1 MV |
84 | virtual void URIStart(FetchResult &Res); |
85 | virtual void URIDone(FetchResult &Res,FetchResult *Alt = 0); | |
86 | ||
8f3ba4e8 | 87 | bool MediaFail(std::string Required,std::string Drive); |
459681d3 | 88 | virtual void Exit() {}; |
8e5fc8f5 | 89 | |
f1bdfe81 DK |
90 | void PrintStatus(char const * const header, const char* Format, va_list &args) const; |
91 | ||
93bf083d | 92 | public: |
a72ace20 AL |
93 | enum CnfFlags {SingleInstance = (1<<0), |
94 | Pipeline = (1<<1), SendConfig = (1<<2), | |
459681d3 AL |
95 | LocalOnly = (1<<3), NeedsCleanup = (1<<4), |
96 | Removable = (1<<5)}; | |
93bf083d | 97 | |
be4401bf AL |
98 | void Log(const char *Format,...); |
99 | void Status(const char *Format,...); | |
100 | ||
8f3ba4e8 | 101 | void Redirect(const std::string &NewURI); |
ebb461fd | 102 | |
be4401bf | 103 | int Run(bool Single = false); |
8f3ba4e8 DK |
104 | inline void SetFailReason(std::string Msg) {FailReason = Msg;}; |
105 | inline void SetIP(std::string aIP) {IP = aIP;}; | |
93bf083d AL |
106 | |
107 | pkgAcqMethod(const char *Ver,unsigned long Flags = 0); | |
108 | virtual ~pkgAcqMethod() {}; | |
7b18d559 | 109 | void DropPrivsOrDie(); |
e1284a59 | 110 | private: |
ce62f1de | 111 | APT_HIDDEN void Dequeue(); |
93bf083d AL |
112 | }; |
113 | ||
3174e150 MV |
114 | /** @} */ |
115 | ||
93bf083d | 116 | #endif |