]> git.saurik.com Git - apt.git/blame - apt-pkg/acquire-item.h
* cmdline/apt-get.cc:
[apt.git] / apt-pkg / acquire-item.h
CommitLineData
0118833a
AL
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
7db98ffc 3// $Id: acquire-item.h,v 1.26.2.3 2004/01/02 18:51:00 mdz Exp $
0118833a
AL
4/* ######################################################################
5
6 Acquire Item - Item to acquire
7
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
17caf1b1 10 register all the URI's they wish to fetch at the initial moment.
0118833a 11
770c32ec 12 Three item classes are provided to provide functionality for
a52f938b 13 downloading of Index, Translation and Packages files.
0118833a 14
495e5cb2 15 A Archive class is provided for downloading .deb files. It does Hash
17caf1b1 16 checking and source location as well as a retry algorithm.
b185acc2 17
0118833a
AL
18 ##################################################################### */
19 /*}}}*/
20#ifndef PKGLIB_ACQUIRE_ITEM_H
21#define PKGLIB_ACQUIRE_ITEM_H
22
23#include <apt-pkg/acquire.h>
b2e465d6 24#include <apt-pkg/indexfile.h>
7db98ffc
MZ
25#include <apt-pkg/vendor.h>
26#include <apt-pkg/sourcelist.h>
03e39e59 27#include <apt-pkg/pkgrecords.h>
7db98ffc 28#include <apt-pkg/indexrecords.h>
495e5cb2 29#include <apt-pkg/hashes.h>
229fb1a3 30#include <apt-pkg/weakptr.h>
0118833a 31
3174e150
MV
32/** \addtogroup acquire
33 * @{
34 *
35 * \file acquire-item.h
36 */
37
92fcbfc1 38/** \brief Represents the process by which a pkgAcquire object should {{{
3174e150
MV
39 * retrieve a file or a collection of files.
40 *
41 * By convention, Item subclasses should insert themselves into the
42 * acquire queue when they are created by calling QueueURI(), and
43 * remove themselves by calling Dequeue() when either Done() or
44 * Failed() is invoked. Item objects are also responsible for
45 * notifying the download progress indicator (accessible via
46 * #Owner->Log) of their status.
47 *
48 * \see pkgAcquire
49 */
229fb1a3 50class pkgAcquire::Item : public WeakPointable
0118833a
AL
51{
52 protected:
53
3174e150 54 /** \brief The acquire object with which this item is associated. */
0118833a 55 pkgAcquire *Owner;
3174e150
MV
56
57 /** \brief Insert this item into its owner's queue.
58 *
59 * \param ItemDesc Metadata about this item (its URI and
60 * description).
61 */
8267fe24
AL
62 inline void QueueURI(ItemDesc &Item)
63 {Owner->Enqueue(Item);};
3174e150
MV
64
65 /** \brief Remove this item from its owner's queue. */
681d76d0 66 inline void Dequeue() {Owner->Dequeue(this);};
0118833a 67
3174e150
MV
68 /** \brief Rename a file without modifying its timestamp.
69 *
70 * Many item methods call this as their final action.
71 *
72 * \param From The file to be renamed.
73 *
74 * \param To The new name of #From. If #To exists it will be
75 * overwritten.
76 */
8b89e57f
AL
77 void Rename(string From,string To);
78
0118833a
AL
79 public:
80
3174e150
MV
81 /** \brief The current status of this item. */
82 enum ItemState
83 {
84 /** \brief The item is waiting to be downloaded. */
85 StatIdle,
86
87 /** \brief The item is currently being downloaded. */
88 StatFetching,
89
90 /** \brief The item has been successfully downloaded. */
91 StatDone,
92
93 /** \brief An error was encountered while downloading this
94 * item.
95 */
96 StatError,
97
98 /** \brief The item was downloaded but its authenticity could
99 * not be verified.
100 */
6ca714d5
MV
101 StatAuthError,
102
103 /** \brief The item was could not be downloaded because of
104 * a transient network error (e.g. network down)
105 */
106 StatTransientNetworkError
3174e150
MV
107 } Status;
108
109 /** \brief Contains a textual description of the error encountered
110 * if #Status is #StatError or #StatAuthError.
111 */
c88edf1d 112 string ErrorText;
3174e150
MV
113
114 /** \brief The size of the object to fetch. */
e2c66de5 115 unsigned long long FileSize;
3174e150
MV
116
117 /** \brief How much of the object was already fetched. */
e2c66de5 118 unsigned long long PartialSize;
3174e150
MV
119
120 /** \brief If not \b NULL, contains the name of a subprocess that
121 * is operating on this object (for instance, "gzip" or "gpgv").
122 */
b2e465d6 123 const char *Mode;
3174e150
MV
124
125 /** \brief A client-supplied unique identifier.
126 *
127 * This field is initalized to 0; it is meant to be filled in by
128 * clients that wish to use it to uniquely identify items.
129 *
130 * \todo it's unused in apt itself
131 */
b98f2859 132 unsigned long ID;
3174e150
MV
133
134 /** \brief If \b true, the entire object has been successfully fetched.
135 *
136 * Subclasses should set this to \b true when appropriate.
137 */
8267fe24 138 bool Complete;
3174e150
MV
139
140 /** \brief If \b true, the URI of this object is "local".
141 *
142 * The only effect of this field is to exclude the object from the
143 * download progress indicator's overall statistics.
144 */
a6568219 145 bool Local;
36280399 146 string UsedMirror;
30e1eab5 147
3174e150
MV
148 /** \brief The number of fetch queues into which this item has been
149 * inserted.
150 *
151 * There is one queue for each source from which an item could be
152 * downloaded.
153 *
154 * \sa pkgAcquire
155 */
0118833a 156 unsigned int QueueCounter;
0118833a 157
3174e150
MV
158 /** \brief The name of the file into which the retrieved object
159 * will be written.
160 */
0a8a80e5 161 string DestFile;
7d8afa39 162
3174e150
MV
163 /** \brief Invoked by the acquire worker when the object couldn't
164 * be fetched.
165 *
166 * This is a branch of the continuation of the fetch process.
167 *
168 * \param Message An RFC822-formatted message from the acquire
169 * method describing what went wrong. Use LookupTag() to parse
170 * it.
171 *
172 * \param Cnf The method via which the worker tried to fetch this object.
173 *
174 * \sa pkgAcqMethod
175 */
7d8afa39 176 virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
3174e150
MV
177
178 /** \brief Invoked by the acquire worker when the object was
179 * fetched successfully.
180 *
181 * Note that the object might \e not have been written to
182 * DestFile; check for the presence of an Alt-Filename entry in
183 * Message to find the file to which it was really written.
184 *
185 * Done is often used to switch from one stage of the processing
186 * to the next (e.g. fetching, unpacking, copying). It is one
187 * branch of the continuation of the fetch process.
188 *
189 * \param Message Data from the acquire method. Use LookupTag()
190 * to parse it.
191 * \param Size The size of the object that was fetched.
495e5cb2 192 * \param Hash The HashSum of the object that was fetched.
3174e150
MV
193 * \param Cnf The method via which the object was fetched.
194 *
195 * \sa pkgAcqMethod
196 */
73da43e9 197 virtual void Done(string Message,unsigned long long Size,string Hash,
459681d3 198 pkgAcquire::MethodConfig *Cnf);
3174e150
MV
199
200 /** \brief Invoked when the worker starts to fetch this object.
201 *
202 * \param Message RFC822-formatted data from the worker process.
203 * Use LookupTag() to parse it.
204 *
205 * \param Size The size of the object being fetched.
206 *
207 * \sa pkgAcqMethod
208 */
73da43e9 209 virtual void Start(string Message,unsigned long long Size);
3174e150
MV
210
211 /** \brief Custom headers to be sent to the fetch process.
212 *
213 * \return a string containing RFC822-style headers that are to be
214 * inserted into the 600 URI Acquire message sent to the fetch
215 * subprocess. The headers are inserted after a newline-less
216 * line, so they should (if nonempty) have a leading newline and
217 * no trailing newline.
218 */
17caf1b1 219 virtual string Custom600Headers() {return string();};
3174e150
MV
220
221 /** \brief A "descriptive" URI-like string.
222 *
223 * \return a URI that should be used to describe what is being fetched.
224 */
36375005 225 virtual string DescURI() = 0;
3174e150
MV
226 /** \brief Short item description.
227 *
228 * \return a brief description of the object being fetched.
229 */
7db98ffc 230 virtual string ShortDesc() {return DescURI();}
3174e150
MV
231
232 /** \brief Invoked by the worker when the download is completely done. */
ab559b35 233 virtual void Finished() {};
17caf1b1 234
495e5cb2 235 /** \brief HashSum
3174e150 236 *
495e5cb2 237 * \return the HashSum of this object, if applicable; otherwise, an
3174e150
MV
238 * empty string.
239 */
495e5cb2 240 virtual string HashSum() {return string();};
3174e150
MV
241
242 /** \return the acquire process with which this item is associated. */
c5ccf175 243 pkgAcquire *GetOwner() {return Owner;};
3174e150
MV
244
245 /** \return \b true if this object is being fetched from a trusted source. */
7db98ffc 246 virtual bool IsTrusted() {return false;};
c5ccf175 247
36280399 248 // report mirror problems
702c84fb
MV
249 /** \brief Report mirror problem
250 *
251 * This allows reporting mirror failures back to a centralized
252 * server. The apt-report-mirror-failure script is called for this
253 *
254 * \param FailCode A short failure string that is send
255 */
36280399
MV
256 void ReportMirrorFailure(string FailCode);
257
3174e150
MV
258
259 /** \brief Initialize an item.
260 *
261 * Adds the item to the list of items known to the acquire
262 * process, but does not place it into any fetch queues (you must
263 * manually invoke QueueURI() to do so).
264 *
265 * Initializes all fields of the item other than Owner to 0,
266 * false, or the empty string.
267 *
268 * \param Owner The new owner of this item.
269 */
0118833a 270 Item(pkgAcquire *Owner);
3174e150
MV
271
272 /** \brief Remove this item from its owner's queue by invoking
273 * pkgAcquire::Remove.
274 */
0118833a
AL
275 virtual ~Item();
276};
92fcbfc1
DK
277 /*}}}*/
278/** \brief Information about an index patch (aka diff). */ /*{{{*/
002d9943 279struct DiffInfo {
3174e150 280 /** The filename of the diff. */
002d9943 281 string file;
3174e150
MV
282
283 /** The sha1 hash of the diff. */
002d9943 284 string sha1;
3174e150
MV
285
286 /** The size of the diff. */
002d9943
MV
287 unsigned long size;
288};
92fcbfc1 289 /*}}}*/
ab53c018
DK
290/** \brief An item that is responsible for fetching a SubIndex {{{
291 *
292 * The MetaIndex file includes only records for important indexes
293 * and records for these SubIndex files so these can carry records
294 * for addition files like PDiffs and Translations
295 */
296class pkgAcqSubIndex : public pkgAcquire::Item
297{
298 protected:
299 /** \brief If \b true, debugging information will be written to std::clog. */
300 bool Debug;
301
302 /** \brief The item that is currently being downloaded. */
303 pkgAcquire::ItemDesc Desc;
304
305 /** \brief The Hash that this file should have after download
306 */
307 HashString ExpectedHash;
308
309 public:
310 // Specialized action members
311 virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
73da43e9 312 virtual void Done(string Message,unsigned long long Size,string Md5Hash,
ab53c018
DK
313 pkgAcquire::MethodConfig *Cnf);
314 virtual string DescURI() {return Desc.URI;};
315 virtual string Custom600Headers();
316 virtual bool ParseIndex(string const &IndexFile);
317
4c6cf493 318 /** \brief Create a new pkgAcqSubIndex.
ab53c018
DK
319 *
320 * \param Owner The Acquire object that owns this item.
321 *
322 * \param URI The URI of the list file to download.
323 *
324 * \param URIDesc A long description of the list file to download.
325 *
326 * \param ShortDesc A short description of the list file to download.
327 *
328 * \param ExpectedHash The list file's MD5 signature.
329 */
330 pkgAcqSubIndex(pkgAcquire *Owner, string const &URI,string const &URIDesc,
331 string const &ShortDesc, HashString const &ExpectedHash);
332};
333 /*}}}*/
92fcbfc1 334/** \brief An item that is responsible for fetching an index file of {{{
3174e150
MV
335 * package list diffs and starting the package list's download.
336 *
337 * This item downloads the Index file and parses it, then enqueues
338 * additional downloads of either the individual patches (using
339 * pkgAcqIndexDiffs) or the entire Packages file (using pkgAcqIndex).
340 *
341 * \sa pkgAcqIndexDiffs, pkgAcqIndex
342 */
2237bd01
MV
343class pkgAcqDiffIndex : public pkgAcquire::Item
344{
345 protected:
3174e150 346 /** \brief If \b true, debugging information will be written to std::clog. */
2237bd01 347 bool Debug;
3174e150
MV
348
349 /** \brief The item that is currently being downloaded. */
002d9943 350 pkgAcquire::ItemDesc Desc;
3174e150
MV
351
352 /** \brief The URI of the index file to recreate at our end (either
353 * by downloading it or by applying partial patches).
354 */
2237bd01 355 string RealURI;
3174e150 356
495e5cb2 357 /** \brief The Hash that the real index file should have after
3174e150
MV
358 * all patches have been applied.
359 */
495e5cb2 360 HashString ExpectedHash;
3174e150
MV
361
362 /** \brief The index file which will be patched to generate the new
363 * file.
364 */
002d9943 365 string CurrentPackagesFile;
3174e150
MV
366
367 /** \brief A description of the Packages file (stored in
368 * pkgAcquire::ItemDesc::Description).
369 */
002d9943 370 string Description;
2237bd01
MV
371
372 public:
373 // Specialized action members
374 virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
73da43e9 375 virtual void Done(string Message,unsigned long long Size,string Md5Hash,
2237bd01
MV
376 pkgAcquire::MethodConfig *Cnf);
377 virtual string DescURI() {return RealURI + "Index";};
378 virtual string Custom600Headers();
379
3174e150
MV
380 /** \brief Parse the Index file for a set of Packages diffs.
381 *
382 * Parses the Index file and creates additional download items as
383 * necessary.
384 *
385 * \param IndexDiffFile The name of the Index file.
386 *
387 * \return \b true if the Index file was successfully parsed, \b
388 * false otherwise.
389 */
2237bd01
MV
390 bool ParseDiffIndex(string IndexDiffFile);
391
3174e150
MV
392
393 /** \brief Create a new pkgAcqDiffIndex.
394 *
395 * \param Owner The Acquire object that owns this item.
396 *
397 * \param URI The URI of the list file to download.
398 *
399 * \param URIDesc A long description of the list file to download.
400 *
401 * \param ShortDesc A short description of the list file to download.
402 *
495e5cb2 403 * \param ExpectedHash The list file's MD5 signature.
3174e150 404 */
2237bd01 405 pkgAcqDiffIndex(pkgAcquire *Owner,string URI,string URIDesc,
495e5cb2 406 string ShortDesc, HashString ExpectedHash);
002d9943 407};
92fcbfc1
DK
408 /*}}}*/
409/** \brief An item that is responsible for fetching all the patches {{{
3174e150
MV
410 * that need to be applied to a given package index file.
411 *
412 * After downloading and applying a single patch, this item will
413 * enqueue a new pkgAcqIndexDiffs to download and apply the remaining
414 * patches. If no patch can be found that applies to an intermediate
415 * file or if one of the patches cannot be downloaded, falls back to
416 * downloading the entire package index file using pkgAcqIndex.
417 *
418 * \sa pkgAcqDiffIndex, pkgAcqIndex
419 */
ac5b205a
MV
420class pkgAcqIndexDiffs : public pkgAcquire::Item
421{
3174e150
MV
422 private:
423
424 /** \brief Queue up the next diff download.
425 *
426 * Search for the next available diff that applies to the file
427 * that currently exists on disk, and enqueue it by calling
428 * QueueURI().
429 *
430 * \return \b true if an applicable diff was found, \b false
431 * otherwise.
432 */
433 bool QueueNextDiff();
434
435 /** \brief Handle tasks that must be performed after the item
436 * finishes downloading.
437 *
438 * Dequeues the item and checks the resulting file's md5sum
495e5cb2 439 * against ExpectedHash after the last patch was applied.
3174e150
MV
440 * There is no need to check the md5/sha1 after a "normal"
441 * patch because QueueNextDiff() will check the sha1 later.
442 *
443 * \param allDone If \b true, the file was entirely reconstructed,
444 * and its md5sum is verified.
445 */
446 void Finish(bool allDone=false);
447
ac5b205a 448 protected:
3174e150
MV
449
450 /** \brief If \b true, debugging output will be written to
451 * std::clog.
452 */
ac5b205a 453 bool Debug;
3174e150
MV
454
455 /** \brief A description of the item that is currently being
456 * downloaded.
457 */
ac5b205a 458 pkgAcquire::ItemDesc Desc;
3174e150
MV
459
460 /** \brief The URI of the package index file that is being
461 * reconstructed.
462 */
ac5b205a 463 string RealURI;
3174e150 464
495e5cb2 465 /** \brief The HashSum of the package index file that is being
3174e150
MV
466 * reconstructed.
467 */
495e5cb2 468 HashString ExpectedHash;
4a0a786f 469
3174e150 470 /** A description of the file being downloaded. */
ac5b205a 471 string Description;
3174e150
MV
472
473 /** The patches that remain to be downloaded, including the patch
474 * being downloaded right now. This list should be ordered so
475 * that each diff appears before any diff that depends on it.
476 *
477 * \todo These are indexed by sha1sum; why not use some sort of
478 * dictionary instead of relying on ordering and stripping them
479 * off the front?
480 */
94dc9d7d 481 vector<DiffInfo> available_patches;
8a3207f4
DK
482
483 /** Stop applying patches when reaching that sha1 */
484 string ServerSha1;
485
3174e150
MV
486 /** The current status of this patch. */
487 enum DiffState
488 {
489 /** \brief The diff is in an unknown state. */
490 StateFetchUnkown,
491
492 /** \brief The diff is currently being fetched. */
493 StateFetchDiff,
494
495 /** \brief The diff is currently being uncompressed. */
caffd480 496 StateUnzipDiff, // FIXME: No longer used
3174e150
MV
497
498 /** \brief The diff is currently being applied. */
499 StateApplyDiff
500 } State;
6cb30d01 501
ac5b205a
MV
502 public:
503
3174e150
MV
504 /** \brief Called when the patch file failed to be downloaded.
505 *
506 * This method will fall back to downloading the whole index file
507 * outright; its arguments are ignored.
508 */
ac5b205a 509 virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
3174e150 510
73da43e9 511 virtual void Done(string Message,unsigned long long Size,string Md5Hash,
ac5b205a
MV
512 pkgAcquire::MethodConfig *Cnf);
513 virtual string DescURI() {return RealURI + "Index";};
ac5b205a 514
3174e150
MV
515 /** \brief Create an index diff item.
516 *
517 * After filling in its basic fields, this invokes Finish(true) if
518 * #diffs is empty, or QueueNextDiff() otherwise.
519 *
520 * \param Owner The pkgAcquire object that owns this item.
521 *
522 * \param URI The URI of the package index file being
523 * reconstructed.
524 *
525 * \param URIDesc A long description of this item.
526 *
527 * \param ShortDesc A brief description of this item.
528 *
495e5cb2 529 * \param ExpectedHash The expected md5sum of the completely
3174e150
MV
530 * reconstructed package index file; the index file will be tested
531 * against this value when it is entirely reconstructed.
532 *
533 * \param diffs The remaining diffs from the index of diffs. They
534 * should be ordered so that each diff appears before any diff
535 * that depends on it.
536 */
ac5b205a 537 pkgAcqIndexDiffs(pkgAcquire *Owner,string URI,string URIDesc,
495e5cb2 538 string ShortDesc, HashString ExpectedHash,
8a3207f4 539 string ServerSha1,
6cb30d01 540 vector<DiffInfo> diffs=vector<DiffInfo>());
ac5b205a 541};
92fcbfc1
DK
542 /*}}}*/
543/** \brief An acquire item that is responsible for fetching an index {{{
3174e150
MV
544 * file (e.g., Packages or Sources).
545 *
546 * \sa pkgAcqDiffIndex, pkgAcqIndexDiffs, pkgAcqIndexTrans
547 *
548 * \todo Why does pkgAcqIndex have protected members?
549 */
0118833a
AL
550class pkgAcqIndex : public pkgAcquire::Item
551{
552 protected:
3174e150
MV
553
554 /** \brief If \b true, the index file has been decompressed. */
8b89e57f 555 bool Decompression;
3174e150
MV
556
557 /** \brief If \b true, the partially downloaded file will be
558 * removed when the download completes.
559 */
bfd22fc0 560 bool Erase;
3174e150
MV
561
562 /** \brief The download request that is currently being
563 * processed.
564 */
8267fe24 565 pkgAcquire::ItemDesc Desc;
3174e150
MV
566
567 /** \brief The object that is actually being fetched (minus any
568 * compression-related extensions).
569 */
b2e465d6 570 string RealURI;
3174e150 571
495e5cb2
MV
572 /** \brief The expected hashsum of the decompressed index file. */
573 HashString ExpectedHash;
3174e150 574
5d885723
DK
575 /** \brief The compression-related file extensions that are being
576 * added to the downloaded file one by one if first fails (e.g., "gz bz2").
3174e150 577 */
13e8426f
MV
578 string CompressionExtension;
579
0118833a
AL
580 public:
581
17caf1b1 582 // Specialized action members
debc84b2 583 virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
73da43e9 584 virtual void Done(string Message,unsigned long long Size,string Md5Hash,
459681d3 585 pkgAcquire::MethodConfig *Cnf);
0a8a80e5 586 virtual string Custom600Headers();
5d885723 587 virtual string DescURI() {return Desc.URI;};
8a8feb29 588 virtual string HashSum() {return ExpectedHash.toStr(); };
0118833a 589
3174e150
MV
590 /** \brief Create a pkgAcqIndex.
591 *
592 * \param Owner The pkgAcquire object with which this item is
593 * associated.
594 *
595 * \param URI The URI of the index file that is to be downloaded.
596 *
597 * \param URIDesc A "URI-style" description of this index file.
598 *
599 * \param ShortDesc A brief description of this index file.
600 *
495e5cb2 601 * \param ExpectedHash The expected hashsum of this index file.
3174e150
MV
602 *
603 * \param compressExt The compression-related extension with which
604 * this index file should be downloaded, or "" to autodetect
e85b4cd5
DK
605 * Compression types can be set with config Acquire::CompressionTypes,
606 * default is ".lzma" or ".bz2" (if the needed binaries are present)
607 * fallback is ".gz" or none.
3174e150 608 */
b2e465d6 609 pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc,
f060e833
MV
610 string ShortDesc, HashString ExpectedHash,
611 string compressExt="");
5d885723
DK
612 pkgAcqIndex(pkgAcquire *Owner, struct IndexTarget const * const Target,
613 HashString const &ExpectedHash, indexRecords const *MetaIndexParser);
614 void Init(string const &URI, string const &URIDesc, string const &ShortDesc);
0118833a 615};
92fcbfc1
DK
616 /*}}}*/
617/** \brief An acquire item that is responsible for fetching a {{{
3174e150
MV
618 * translated index file.
619 *
620 * The only difference from pkgAcqIndex is that transient failures
621 * are suppressed: no error occurs if the translated index file is
622 * missing.
623 */
a52f938b
OS
624class pkgAcqIndexTrans : public pkgAcqIndex
625{
626 public:
627
628 virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
963b16dc 629 virtual string Custom600Headers();
3174e150
MV
630
631 /** \brief Create a pkgAcqIndexTrans.
632 *
633 * \param Owner The pkgAcquire object with which this item is
634 * associated.
635 *
636 * \param URI The URI of the index file that is to be downloaded.
637 *
638 * \param URIDesc A "URI-style" description of this index file.
639 *
640 * \param ShortDesc A brief description of this index file.
3174e150 641 */
a52f938b 642 pkgAcqIndexTrans(pkgAcquire *Owner,string URI,string URIDesc,
3174e150 643 string ShortDesc);
ab53c018
DK
644 pkgAcqIndexTrans(pkgAcquire *Owner, struct IndexTarget const * const Target,
645 HashString const &ExpectedHash, indexRecords const *MetaIndexParser);
a52f938b 646};
92fcbfc1
DK
647 /*}}}*/
648/** \brief Information about an index file. */ /*{{{*/
7db98ffc
MZ
649struct IndexTarget
650{
3174e150 651 /** \brief A URI from which the index file can be downloaded. */
7db98ffc 652 string URI;
3174e150
MV
653
654 /** \brief A description of the index file. */
7db98ffc 655 string Description;
3174e150
MV
656
657 /** \brief A shorter description of the index file. */
7db98ffc 658 string ShortDesc;
3174e150
MV
659
660 /** \brief The key by which this index file should be
661 * looked up within the meta signature file.
662 */
7db98ffc 663 string MetaKey;
ab53c018
DK
664
665 //FIXME: We should use virtual methods here instead…
666 bool IsOptional() const;
667 bool IsSubIndex() const;
7db98ffc 668};
92fcbfc1 669 /*}}}*/
ab53c018
DK
670/** \brief Information about an optional index file. */ /*{{{*/
671struct OptionalIndexTarget : public IndexTarget
672{
7db98ffc 673};
92fcbfc1 674 /*}}}*/
ab53c018 675
92fcbfc1 676/** \brief An acquire item that downloads the detached signature {{{
3174e150
MV
677 * of a meta-index (Release) file, then queues up the release
678 * file itself.
679 *
680 * \todo Why protected members?
681 *
682 * \sa pkgAcqMetaIndex
683 */
7db98ffc 684class pkgAcqMetaSig : public pkgAcquire::Item
0118833a
AL
685{
686 protected:
ef942597
MV
687 /** \brief The last good signature file */
688 string LastGoodSig;
689
3174e150 690 /** \brief The fetch request that is currently being processed. */
8267fe24 691 pkgAcquire::ItemDesc Desc;
3174e150
MV
692
693 /** \brief The URI of the signature file. Unlike Desc.URI, this is
694 * never modified; it is used to determine the file that is being
695 * downloaded.
696 */
697 string RealURI;
698
699 /** \brief The URI of the meta-index file to be fetched after the signature. */
700 string MetaIndexURI;
701
702 /** \brief A "URI-style" description of the meta-index file to be
703 * fetched after the signature.
704 */
705 string MetaIndexURIDesc;
706
707 /** \brief A brief description of the meta-index file to be fetched
708 * after the signature.
709 */
710 string MetaIndexShortDesc;
711
712 /** \brief A package-system-specific parser for the meta-index file. */
7db98ffc 713 indexRecords* MetaIndexParser;
3174e150
MV
714
715 /** \brief The index files which should be looked up in the meta-index
716 * and then downloaded.
717 *
718 * \todo Why a list of pointers instead of a list of structs?
719 */
7db98ffc
MZ
720 const vector<struct IndexTarget*>* IndexTargets;
721
0118833a
AL
722 public:
723
17caf1b1 724 // Specialized action members
681d76d0 725 virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
73da43e9 726 virtual void Done(string Message,unsigned long long Size,string Md5Hash,
7db98ffc 727 pkgAcquire::MethodConfig *Cnf);
0a8a80e5 728 virtual string Custom600Headers();
7db98ffc
MZ
729 virtual string DescURI() {return RealURI; };
730
3174e150 731 /** \brief Create a new pkgAcqMetaSig. */
7db98ffc
MZ
732 pkgAcqMetaSig(pkgAcquire *Owner,string URI,string URIDesc, string ShortDesc,
733 string MetaIndexURI, string MetaIndexURIDesc, string MetaIndexShortDesc,
734 const vector<struct IndexTarget*>* IndexTargets,
735 indexRecords* MetaIndexParser);
736};
92fcbfc1
DK
737 /*}}}*/
738/** \brief An item that is responsible for downloading the meta-index {{{
3174e150
MV
739 * file (i.e., Release) itself and verifying its signature.
740 *
741 * Once the download and verification are complete, the downloads of
742 * the individual index files are queued up using pkgAcqDiffIndex.
495e5cb2 743 * If the meta-index file had a valid signature, the expected hashsums
3174e150 744 * of the index files will be the md5sums listed in the meta-index;
495e5cb2 745 * otherwise, the expected hashsums will be "" (causing the
3174e150
MV
746 * authentication of the index files to be bypassed).
747 */
7db98ffc
MZ
748class pkgAcqMetaIndex : public pkgAcquire::Item
749{
750 protected:
3174e150 751 /** \brief The fetch command that is currently being processed. */
7db98ffc 752 pkgAcquire::ItemDesc Desc;
3174e150
MV
753
754 /** \brief The URI that is actually being downloaded; never
755 * modified by pkgAcqMetaIndex.
756 */
757 string RealURI;
758
759 /** \brief The file in which the signature for this index was stored.
760 *
761 * If empty, the signature and the md5sums of the individual
762 * indices will not be checked.
763 */
7db98ffc 764 string SigFile;
3174e150
MV
765
766 /** \brief The index files to download. */
7db98ffc 767 const vector<struct IndexTarget*>* IndexTargets;
3174e150
MV
768
769 /** \brief The parser for the meta-index file. */
7db98ffc 770 indexRecords* MetaIndexParser;
3174e150
MV
771
772 /** \brief If \b true, the index's signature is currently being verified.
773 */
7db98ffc 774 bool AuthPass;
ce424cd4
MV
775 // required to deal gracefully with problems caused by incorrect ims hits
776 bool IMSHit;
7db98ffc 777
3174e150
MV
778 /** \brief Check that the release file is a release file for the
779 * correct distribution.
780 *
781 * \return \b true if no fatal errors were encountered.
782 */
ce424cd4 783 bool VerifyVendor(string Message);
3174e150
MV
784
785 /** \brief Called when a file is finished being retrieved.
786 *
787 * If the file was not downloaded to DestFile, a copy process is
788 * set up to copy it to DestFile; otherwise, Complete is set to \b
789 * true and the file is moved to its final location.
790 *
791 * \param Message The message block received from the fetch
792 * subprocess.
793 */
7db98ffc 794 void RetrievalDone(string Message);
3174e150
MV
795
796 /** \brief Called when authentication succeeded.
797 *
798 * Sanity-checks the authenticated file, queues up the individual
799 * index files for download, and saves the signature in the lists
800 * directory next to the authenticated list file.
801 *
802 * \param Message The message block received from the fetch
803 * subprocess.
804 */
7db98ffc 805 void AuthDone(string Message);
3174e150
MV
806
807 /** \brief Starts downloading the individual index files.
808 *
495e5cb2 809 * \param verify If \b true, only indices whose expected hashsum
3174e150 810 * can be determined from the meta-index will be downloaded, and
495e5cb2 811 * the hashsums of indices will be checked (reporting
3174e150 812 * #StatAuthError if there is a mismatch). If verify is \b false,
495e5cb2 813 * no hashsum checking will be performed.
3174e150 814 */
7db98ffc
MZ
815 void QueueIndexes(bool verify);
816
817 public:
0a8a80e5 818
7db98ffc
MZ
819 // Specialized action members
820 virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
73da43e9 821 virtual void Done(string Message,unsigned long long Size, string Hash,
7db98ffc
MZ
822 pkgAcquire::MethodConfig *Cnf);
823 virtual string Custom600Headers();
824 virtual string DescURI() {return RealURI; };
825
3174e150 826 /** \brief Create a new pkgAcqMetaIndex. */
7db98ffc
MZ
827 pkgAcqMetaIndex(pkgAcquire *Owner,
828 string URI,string URIDesc, string ShortDesc,
829 string SigFile,
830 const vector<struct IndexTarget*>* IndexTargets,
831 indexRecords* MetaIndexParser);
0118833a 832};
92fcbfc1 833 /*}}}*/
fe0f7911
DK
834/** \brief An item repsonsible for downloading clearsigned metaindexes {{{*/
835class pkgAcqMetaClearSig : public pkgAcqMetaIndex
836{
837 /** \brief The URI of the meta-index file for the detached signature */
838 string MetaIndexURI;
839
840 /** \brief A "URI-style" description of the meta-index file */
841 string MetaIndexURIDesc;
842
843 /** \brief A brief description of the meta-index file */
844 string MetaIndexShortDesc;
845
846 /** \brief The URI of the detached meta-signature file if the clearsigned one failed. */
847 string MetaSigURI;
848
849 /** \brief A "URI-style" description of the meta-signature file */
850 string MetaSigURIDesc;
851
852 /** \brief A brief description of the meta-signature file */
853 string MetaSigShortDesc;
854
855public:
856 void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
8d6c5839 857 virtual string Custom600Headers();
fe0f7911
DK
858
859 /** \brief Create a new pkgAcqMetaClearSig. */
860 pkgAcqMetaClearSig(pkgAcquire *Owner,
861 string const &URI, string const &URIDesc, string const &ShortDesc,
862 string const &MetaIndexURI, string const &MetaIndexURIDesc, string const &MetaIndexShortDesc,
863 string const &MetaSigURI, string const &MetaSigURIDesc, string const &MetaSigShortDesc,
864 const vector<struct IndexTarget*>* IndexTargets,
865 indexRecords* MetaIndexParser);
866};
867 /*}}}*/
92fcbfc1 868/** \brief An item that is responsible for fetching a package file. {{{
3174e150
MV
869 *
870 * If the package file already exists in the cache, nothing will be
871 * done.
872 */
03e39e59
AL
873class pkgAcqArchive : public pkgAcquire::Item
874{
875 protected:
3174e150 876 /** \brief The package version being fetched. */
03e39e59 877 pkgCache::VerIterator Version;
3174e150
MV
878
879 /** \brief The fetch command that is currently being processed. */
03e39e59 880 pkgAcquire::ItemDesc Desc;
3174e150
MV
881
882 /** \brief The list of sources from which to pick archives to
883 * download this package from.
884 */
03e39e59 885 pkgSourceList *Sources;
3174e150
MV
886
887 /** \brief A package records object, used to look up the file
888 * corresponding to each version of the package.
889 */
03e39e59 890 pkgRecords *Recs;
3174e150 891
495e5cb2 892 /** \brief The hashsum of this package. */
8a8feb29 893 HashString ExpectedHash;
3174e150
MV
894
895 /** \brief A location in which the actual filename of the package
896 * should be stored.
897 */
30e1eab5 898 string &StoreFilename;
3174e150
MV
899
900 /** \brief The next file for this version to try to download. */
b185acc2 901 pkgCache::VerFileIterator Vf;
3174e150
MV
902
903 /** \brief How many (more) times to try to find a new source from
904 * which to download this package version if it fails.
905 *
906 * Set from Acquire::Retries.
907 */
7d8afa39 908 unsigned int Retries;
3174e150
MV
909
910 /** \brief \b true if this version file is being downloaded from a
911 * trusted source.
912 */
7db98ffc 913 bool Trusted;
17caf1b1 914
3174e150 915 /** \brief Queue up the next available file for this version. */
b185acc2 916 bool QueueNext();
03e39e59
AL
917
918 public:
919
7d8afa39 920 virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
73da43e9 921 virtual void Done(string Message,unsigned long long Size,string Hash,
459681d3 922 pkgAcquire::MethodConfig *Cnf);
36375005 923 virtual string DescURI() {return Desc.URI;};
7db98ffc 924 virtual string ShortDesc() {return Desc.ShortDesc;};
ab559b35 925 virtual void Finished();
8a8feb29 926 virtual string HashSum() {return ExpectedHash.toStr(); };
7db98ffc 927 virtual bool IsTrusted();
03e39e59 928
3174e150
MV
929 /** \brief Create a new pkgAcqArchive.
930 *
931 * \param Owner The pkgAcquire object with which this item is
932 * associated.
933 *
934 * \param Sources The sources from which to download version
935 * files.
936 *
937 * \param Recs A package records object, used to look up the file
938 * corresponding to each version of the package.
939 *
940 * \param Version The package version to download.
941 *
942 * \param StoreFilename A location in which the actual filename of
943 * the package should be stored. It will be set to a guessed
944 * basename in the constructor, and filled in with a fully
945 * qualified filename once the download finishes.
946 */
03e39e59 947 pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
30e1eab5
AL
948 pkgRecords *Recs,pkgCache::VerIterator const &Version,
949 string &StoreFilename);
03e39e59 950};
92fcbfc1
DK
951 /*}}}*/
952/** \brief Retrieve an arbitrary file to the current directory. {{{
3174e150
MV
953 *
954 * The file is retrieved even if it is accessed via a URL type that
955 * normally is a NOP, such as "file". If the download fails, the
956 * partial file is renamed to get a ".FAILED" extension.
957 */
36375005
AL
958class pkgAcqFile : public pkgAcquire::Item
959{
3174e150 960 /** \brief The currently active download process. */
36375005 961 pkgAcquire::ItemDesc Desc;
3174e150 962
495e5cb2 963 /** \brief The hashsum of the file to download, if it is known. */
8a8feb29 964 HashString ExpectedHash;
3174e150
MV
965
966 /** \brief How many times to retry the download, set from
967 * Acquire::Retries.
968 */
08cfc005 969 unsigned int Retries;
36375005 970
77278c2b
MV
971 /** \brief Should this file be considered a index file */
972 bool IsIndexFile;
973
36375005
AL
974 public:
975
976 // Specialized action members
08cfc005 977 virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
73da43e9 978 virtual void Done(string Message,unsigned long long Size,string CalcHash,
459681d3 979 pkgAcquire::MethodConfig *Cnf);
36375005 980 virtual string DescURI() {return Desc.URI;};
8a8feb29 981 virtual string HashSum() {return ExpectedHash.toStr(); };
77278c2b 982 virtual string Custom600Headers();
3174e150
MV
983
984 /** \brief Create a new pkgAcqFile object.
985 *
986 * \param Owner The pkgAcquire object with which this object is
987 * associated.
988 *
989 * \param URI The URI to download.
990 *
495e5cb2 991 * \param Hash The hashsum of the file to download, if it is known;
3174e150
MV
992 * otherwise "".
993 *
994 * \param Size The size of the file to download, if it is known;
995 * otherwise 0.
996 *
997 * \param Desc A description of the file being downloaded.
998 *
999 * \param ShortDesc A brief description of the file being
1000 * downloaded.
39c7baef
MV
1001 *
1002 * \param DestDir The directory the file should be downloaded into.
1003 *
1004 * \param DestFilename The filename+path the file is downloaded to.
1005 *
77278c2b
MV
1006 * \param IsIndexFile The file is considered a IndexFile and cache-control
1007 * headers like "cache-control: max-age=0" are send
39c7baef
MV
1008 *
1009 * If DestFilename is empty, download to DestDir/<basename> if
1010 * DestDir is non-empty, $CWD/<basename> otherwise. If
1011 * DestFilename is NOT empty, DestDir is ignored and DestFilename
1012 * is the absolute name to which the file should be downloaded.
3174e150 1013 */
39c7baef 1014
73da43e9 1015 pkgAcqFile(pkgAcquire *Owner, string URI, string Hash, unsigned long long Size,
46e00f9d 1016 string Desc, string ShortDesc,
77278c2b
MV
1017 const string &DestDir="", const string &DestFilename="",
1018 bool IsIndexFile=false);
36375005 1019};
92fcbfc1 1020 /*}}}*/
3174e150
MV
1021/** @} */
1022
0118833a 1023#endif