* Install-Reason -> Auto-Installed in pkgstates
[apt.git] / apt-pkg / acquire-method.h
CommitLineData
93bf083d
AL
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
7db98ffc 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 /*}}}*/
13#ifndef PKGLIB_ACQUIRE_METHOD_H
14#define PKGLIB_ACQUIRE_METHOD_H
15
16#include <apt-pkg/configuration.h>
cdcc6d34 17#include <apt-pkg/strutl.h>
93bf083d
AL
18
19#ifdef __GNUG__
20#pragma interface "apt-pkg/acquire-method.h"
21#endif
22
a7c835af 23class Hashes;
93bf083d
AL
24class pkgAcqMethod
25{
26 protected:
93bf083d 27
be4401bf
AL
28 struct FetchItem
29 {
30 FetchItem *Next;
31
32 string Uri;
33 string DestFile;
34 time_t LastModified;
a72ace20 35 bool IndexFile;
be4401bf
AL
36 };
37
93bf083d
AL
38 struct FetchResult
39 {
40 string MD5Sum;
a7c835af 41 string SHA1Sum;
7db98ffc 42 vector<string> GPGVOutput;
93bf083d
AL
43 time_t LastModified;
44 bool IMSHit;
45 string Filename;
46 unsigned long Size;
a7c835af
AL
47 unsigned long ResumePoint;
48
49 void TakeHashes(Hashes &Hash);
93bf083d
AL
50 FetchResult();
51 };
be4401bf
AL
52
53 // State
54 vector<string> Messages;
55 FetchItem *Queue;
5cb5d8dc 56 FetchItem *QueueBack;
b2e465d6
AL
57 string FailExtra;
58
93bf083d
AL
59 // Handlers for messages
60 virtual bool Configuration(string Message);
727f18af 61 virtual bool Fetch(FetchItem * /*Item*/) {return true;};
93bf083d
AL
62
63 // Outgoing messages
a72ace20 64 void Fail(bool Transient = false);
958fac63 65 inline void Fail(const char *Why, bool Transient = false) {Fail(string(Why),Transient);};
a72ace20 66 void Fail(string Why, bool Transient = false);
be4401bf 67 void URIStart(FetchResult &Res);
93bf083d 68 void URIDone(FetchResult &Res,FetchResult *Alt = 0);
018f1533 69 bool MediaFail(string Required,string Drive);
459681d3 70 virtual void Exit() {};
8e5fc8f5 71
93bf083d 72 public:
a72ace20
AL
73
74 enum CnfFlags {SingleInstance = (1<<0),
75 Pipeline = (1<<1), SendConfig = (1<<2),
459681d3
AL
76 LocalOnly = (1<<3), NeedsCleanup = (1<<4),
77 Removable = (1<<5)};
93bf083d 78
be4401bf
AL
79 void Log(const char *Format,...);
80 void Status(const char *Format,...);
81
82 int Run(bool Single = false);
b2e465d6 83 inline void SetFailExtraMsg(string Msg) {FailExtra = Msg;};
93bf083d
AL
84
85 pkgAcqMethod(const char *Ver,unsigned long Flags = 0);
86 virtual ~pkgAcqMethod() {};
87};
88
89#endif