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