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