1 // -*- mode: cpp; mode: fold -*-
3 // $Id: acquire-item.h,v 1.26.2.3 2004/01/02 18:51:00 mdz Exp $
4 /* ######################################################################
6 Acquire Item - Item to acquire
8 When an item is instantiated it will add it self to the local list in
9 the Owner Acquire class. Derived classes will then call QueueURI to
10 register all the URI's they wish to fetch at the initial moment.
12 Two item classes are provided to provide functionality for downloading
13 of Index files and downloading of Packages.
15 A Archive class is provided for downloading .deb files. It does Md5
16 checking and source location as well as a retry algorithm.
18 ##################################################################### */
20 #ifndef PKGLIB_ACQUIRE_ITEM_H
21 #define PKGLIB_ACQUIRE_ITEM_H
23 #include <apt-pkg/acquire.h>
24 #include <apt-pkg/indexfile.h>
25 #include <apt-pkg/vendor.h>
26 #include <apt-pkg/sourcelist.h>
27 #include <apt-pkg/pkgrecords.h>
28 #include <apt-pkg/indexrecords.h>
31 #pragma interface "apt-pkg/acquire-item.h"
35 class pkgAcquire::Item
39 // Some private helper methods for registering URIs
41 inline void QueueURI(ItemDesc
&Item
)
42 {Owner
->Enqueue(Item
);};
43 inline void Dequeue() {Owner
->Dequeue(this);};
45 // Safe rename function with timestamp preservation
46 void Rename(string From
,string To
);
51 enum {StatIdle
, StatFetching
, StatDone
, StatError
, StatAuthError
} Status
;
53 unsigned long FileSize
;
54 unsigned long PartialSize
;
60 // Number of queues we are inserted into
61 unsigned int QueueCounter
;
63 // File to write the fetch into
66 // Action members invoked by the worker
67 virtual void Failed(string Message
,pkgAcquire::MethodConfig
*Cnf
);
68 virtual void Done(string Message
,unsigned long Size
,string Md5Hash
,
69 pkgAcquire::MethodConfig
*Cnf
);
70 virtual void Start(string Message
,unsigned long Size
);
71 virtual string
Custom600Headers() {return string();};
72 virtual string
DescURI() = 0;
73 virtual string
ShortDesc() {return DescURI();}
74 virtual void Finished() {};
77 virtual string
MD5Sum() {return string();};
78 pkgAcquire
*GetOwner() {return Owner
;};
79 virtual bool IsTrusted() {return false;};
81 Item(pkgAcquire
*Owner
);
85 // Item class for index files
86 class pkgAcqIndex
: public pkgAcquire::Item
92 pkgAcquire::ItemDesc Desc
;
95 string CompressionExtension
;
99 // Specialized action members
100 virtual void Failed(string Message
,pkgAcquire::MethodConfig
*Cnf
);
101 virtual void Done(string Message
,unsigned long Size
,string Md5Hash
,
102 pkgAcquire::MethodConfig
*Cnf
);
103 virtual string
Custom600Headers();
104 virtual string
DescURI() {return RealURI
+ CompressionExtension
;};
106 pkgAcqIndex(pkgAcquire
*Owner
,string URI
,string URIDesc
,
107 string ShortDesct
, string ExpectedMD5
, string compressExt
="");
118 // Item class for index signatures
119 class pkgAcqMetaSig
: public pkgAcquire::Item
123 pkgAcquire::ItemDesc Desc
;
124 string RealURI
,MetaIndexURI
,MetaIndexURIDesc
,MetaIndexShortDesc
;
125 indexRecords
* MetaIndexParser
;
126 const vector
<struct IndexTarget
*>* IndexTargets
;
130 // Specialized action members
131 virtual void Failed(string Message
,pkgAcquire::MethodConfig
*Cnf
);
132 virtual void Done(string Message
,unsigned long Size
,string Md5Hash
,
133 pkgAcquire::MethodConfig
*Cnf
);
134 virtual string
Custom600Headers();
135 virtual string
DescURI() {return RealURI
; };
137 pkgAcqMetaSig(pkgAcquire
*Owner
,string URI
,string URIDesc
, string ShortDesc
,
138 string MetaIndexURI
, string MetaIndexURIDesc
, string MetaIndexShortDesc
,
139 const vector
<struct IndexTarget
*>* IndexTargets
,
140 indexRecords
* MetaIndexParser
);
143 // Item class for index signatures
144 class pkgAcqMetaIndex
: public pkgAcquire::Item
148 pkgAcquire::ItemDesc Desc
;
149 string RealURI
; // FIXME: is this redundant w/ Desc.URI?
151 const vector
<struct IndexTarget
*>* IndexTargets
;
152 indexRecords
* MetaIndexParser
;
154 bool IMSHit
; // required to fail gracefully on failures
157 void RetrievalDone(string Message
);
158 void AuthDone(string Message
);
159 void QueueIndexes(bool verify
);
163 // Specialized action members
164 virtual void Failed(string Message
,pkgAcquire::MethodConfig
*Cnf
);
165 virtual void Done(string Message
,unsigned long Size
,string Md5Hash
,
166 pkgAcquire::MethodConfig
*Cnf
);
167 virtual string
Custom600Headers();
168 virtual string
DescURI() {return RealURI
; };
170 pkgAcqMetaIndex(pkgAcquire
*Owner
,
171 string URI
,string URIDesc
, string ShortDesc
,
173 const vector
<struct IndexTarget
*>* IndexTargets
,
174 indexRecords
* MetaIndexParser
);
177 // Item class for archive files
178 class pkgAcqArchive
: public pkgAcquire::Item
182 // State information for the retry mechanism
183 pkgCache::VerIterator Version
;
184 pkgAcquire::ItemDesc Desc
;
185 pkgSourceList
*Sources
;
188 string
&StoreFilename
;
189 pkgCache::VerFileIterator Vf
;
190 unsigned int Retries
;
193 // Queue the next available file for download.
198 // Specialized action members
199 virtual void Failed(string Message
,pkgAcquire::MethodConfig
*Cnf
);
200 virtual void Done(string Message
,unsigned long Size
,string Md5Hash
,
201 pkgAcquire::MethodConfig
*Cnf
);
202 virtual string
MD5Sum() {return MD5
;};
203 virtual string
DescURI() {return Desc
.URI
;};
204 virtual string
ShortDesc() {return Desc
.ShortDesc
;};
205 virtual void Finished();
206 virtual bool IsTrusted();
208 pkgAcqArchive(pkgAcquire
*Owner
,pkgSourceList
*Sources
,
209 pkgRecords
*Recs
,pkgCache::VerIterator
const &Version
,
210 string
&StoreFilename
);
213 // Fetch a generic file to the current directory
214 class pkgAcqFile
: public pkgAcquire::Item
216 pkgAcquire::ItemDesc Desc
;
218 unsigned int Retries
;
222 // Specialized action members
223 virtual void Failed(string Message
,pkgAcquire::MethodConfig
*Cnf
);
224 virtual void Done(string Message
,unsigned long Size
,string Md5Hash
,
225 pkgAcquire::MethodConfig
*Cnf
);
226 virtual string
MD5Sum() {return Md5Hash
;};
227 virtual string
DescURI() {return Desc
.URI
;};
229 // If DestFilename is empty, download to DestDir/<basename> if
230 // DestDir is non-empty, $CWD/<basename> otherwise. If
231 // DestFilename is NOT empty, DestDir is ignored and DestFilename
232 // is the absolute name to which the file should be downloaded.
233 pkgAcqFile(pkgAcquire
*Owner
, string URI
, string MD5
, unsigned long Size
,
234 string Desc
, string ShortDesc
,
235 const string
&DestDir
="", const string
&DestFilename
="");