| 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/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> |
| 29 | #include <apt-pkg/hashes.h> |
| 30 | #include <apt-pkg/weakptr.h> |
| 31 | |
| 32 | /** \addtogroup acquire |
| 33 | * @{ |
| 34 | * |
| 35 | * \file acquire-item.h |
| 36 | */ |
| 37 | |
| 38 | /** \brief Represents the process by which a pkgAcquire object should {{{ |
| 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 | */ |
| 50 | class pkgAcquire::Item : public WeakPointable |
| 51 | { |
| 52 | protected: |
| 53 | |
| 54 | /** \brief The acquire object with which this item is associated. */ |
| 55 | pkgAcquire *Owner; |
| 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 | */ |
| 62 | inline void QueueURI(ItemDesc &Item) |
| 63 | {Owner->Enqueue(Item);}; |
| 64 | |
| 65 | /** \brief Remove this item from its owner's queue. */ |
| 66 | inline void Dequeue() {Owner->Dequeue(this);}; |
| 67 | |
| 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 | */ |
| 77 | void Rename(string From,string To); |
| 78 | |
| 79 | public: |
| 80 | |
| 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 | */ |
| 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 |
| 107 | } Status; |
| 108 | |
| 109 | /** \brief Contains a textual description of the error encountered |
| 110 | * if #Status is #StatError or #StatAuthError. |
| 111 | */ |
| 112 | string ErrorText; |
| 113 | |
| 114 | /** \brief The size of the object to fetch. */ |
| 115 | unsigned long long FileSize; |
| 116 | |
| 117 | /** \brief How much of the object was already fetched. */ |
| 118 | unsigned long long PartialSize; |
| 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 | */ |
| 123 | const char *Mode; |
| 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 | */ |
| 132 | unsigned long ID; |
| 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 | */ |
| 138 | bool Complete; |
| 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 | */ |
| 145 | bool Local; |
| 146 | string UsedMirror; |
| 147 | |
| 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 | */ |
| 156 | unsigned int QueueCounter; |
| 157 | |
| 158 | /** \brief The name of the file into which the retrieved object |
| 159 | * will be written. |
| 160 | */ |
| 161 | string DestFile; |
| 162 | |
| 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 | */ |
| 176 | virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); |
| 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. |
| 192 | * \param Hash The HashSum of the object that was fetched. |
| 193 | * \param Cnf The method via which the object was fetched. |
| 194 | * |
| 195 | * \sa pkgAcqMethod |
| 196 | */ |
| 197 | virtual void Done(string Message,unsigned long Size,string Hash, |
| 198 | pkgAcquire::MethodConfig *Cnf); |
| 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 | */ |
| 209 | virtual void Start(string Message,unsigned long Size); |
| 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 | */ |
| 219 | virtual string Custom600Headers() {return string();}; |
| 220 | |
| 221 | /** \brief A "descriptive" URI-like string. |
| 222 | * |
| 223 | * \return a URI that should be used to describe what is being fetched. |
| 224 | */ |
| 225 | virtual string DescURI() = 0; |
| 226 | /** \brief Short item description. |
| 227 | * |
| 228 | * \return a brief description of the object being fetched. |
| 229 | */ |
| 230 | virtual string ShortDesc() {return DescURI();} |
| 231 | |
| 232 | /** \brief Invoked by the worker when the download is completely done. */ |
| 233 | virtual void Finished() {}; |
| 234 | |
| 235 | /** \brief HashSum |
| 236 | * |
| 237 | * \return the HashSum of this object, if applicable; otherwise, an |
| 238 | * empty string. |
| 239 | */ |
| 240 | virtual string HashSum() {return string();}; |
| 241 | |
| 242 | /** \return the acquire process with which this item is associated. */ |
| 243 | pkgAcquire *GetOwner() {return Owner;}; |
| 244 | |
| 245 | /** \return \b true if this object is being fetched from a trusted source. */ |
| 246 | virtual bool IsTrusted() {return false;}; |
| 247 | |
| 248 | // report mirror problems |
| 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 | */ |
| 256 | void ReportMirrorFailure(string FailCode); |
| 257 | |
| 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 | */ |
| 270 | Item(pkgAcquire *Owner); |
| 271 | |
| 272 | /** \brief Remove this item from its owner's queue by invoking |
| 273 | * pkgAcquire::Remove. |
| 274 | */ |
| 275 | virtual ~Item(); |
| 276 | }; |
| 277 | /*}}}*/ |
| 278 | /** \brief Information about an index patch (aka diff). */ /*{{{*/ |
| 279 | struct DiffInfo { |
| 280 | /** The filename of the diff. */ |
| 281 | string file; |
| 282 | |
| 283 | /** The sha1 hash of the diff. */ |
| 284 | string sha1; |
| 285 | |
| 286 | /** The size of the diff. */ |
| 287 | unsigned long size; |
| 288 | }; |
| 289 | /*}}}*/ |
| 290 | /** \brief An item that is responsible for fetching an index file of {{{ |
| 291 | * package list diffs and starting the package list's download. |
| 292 | * |
| 293 | * This item downloads the Index file and parses it, then enqueues |
| 294 | * additional downloads of either the individual patches (using |
| 295 | * pkgAcqIndexDiffs) or the entire Packages file (using pkgAcqIndex). |
| 296 | * |
| 297 | * \sa pkgAcqIndexDiffs, pkgAcqIndex |
| 298 | */ |
| 299 | class pkgAcqDiffIndex : public pkgAcquire::Item |
| 300 | { |
| 301 | protected: |
| 302 | /** \brief If \b true, debugging information will be written to std::clog. */ |
| 303 | bool Debug; |
| 304 | |
| 305 | /** \brief The item that is currently being downloaded. */ |
| 306 | pkgAcquire::ItemDesc Desc; |
| 307 | |
| 308 | /** \brief The URI of the index file to recreate at our end (either |
| 309 | * by downloading it or by applying partial patches). |
| 310 | */ |
| 311 | string RealURI; |
| 312 | |
| 313 | /** \brief The Hash that the real index file should have after |
| 314 | * all patches have been applied. |
| 315 | */ |
| 316 | HashString ExpectedHash; |
| 317 | |
| 318 | /** \brief The index file which will be patched to generate the new |
| 319 | * file. |
| 320 | */ |
| 321 | string CurrentPackagesFile; |
| 322 | |
| 323 | /** \brief A description of the Packages file (stored in |
| 324 | * pkgAcquire::ItemDesc::Description). |
| 325 | */ |
| 326 | string Description; |
| 327 | |
| 328 | public: |
| 329 | // Specialized action members |
| 330 | virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); |
| 331 | virtual void Done(string Message,unsigned long Size,string Md5Hash, |
| 332 | pkgAcquire::MethodConfig *Cnf); |
| 333 | virtual string DescURI() {return RealURI + "Index";}; |
| 334 | virtual string Custom600Headers(); |
| 335 | |
| 336 | /** \brief Parse the Index file for a set of Packages diffs. |
| 337 | * |
| 338 | * Parses the Index file and creates additional download items as |
| 339 | * necessary. |
| 340 | * |
| 341 | * \param IndexDiffFile The name of the Index file. |
| 342 | * |
| 343 | * \return \b true if the Index file was successfully parsed, \b |
| 344 | * false otherwise. |
| 345 | */ |
| 346 | bool ParseDiffIndex(string IndexDiffFile); |
| 347 | |
| 348 | |
| 349 | /** \brief Create a new pkgAcqDiffIndex. |
| 350 | * |
| 351 | * \param Owner The Acquire object that owns this item. |
| 352 | * |
| 353 | * \param URI The URI of the list file to download. |
| 354 | * |
| 355 | * \param URIDesc A long description of the list file to download. |
| 356 | * |
| 357 | * \param ShortDesc A short description of the list file to download. |
| 358 | * |
| 359 | * \param ExpectedHash The list file's MD5 signature. |
| 360 | */ |
| 361 | pkgAcqDiffIndex(pkgAcquire *Owner,string URI,string URIDesc, |
| 362 | string ShortDesc, HashString ExpectedHash); |
| 363 | }; |
| 364 | /*}}}*/ |
| 365 | /** \brief An item that is responsible for fetching all the patches {{{ |
| 366 | * that need to be applied to a given package index file. |
| 367 | * |
| 368 | * After downloading and applying a single patch, this item will |
| 369 | * enqueue a new pkgAcqIndexDiffs to download and apply the remaining |
| 370 | * patches. If no patch can be found that applies to an intermediate |
| 371 | * file or if one of the patches cannot be downloaded, falls back to |
| 372 | * downloading the entire package index file using pkgAcqIndex. |
| 373 | * |
| 374 | * \sa pkgAcqDiffIndex, pkgAcqIndex |
| 375 | */ |
| 376 | class pkgAcqIndexDiffs : public pkgAcquire::Item |
| 377 | { |
| 378 | private: |
| 379 | |
| 380 | /** \brief Queue up the next diff download. |
| 381 | * |
| 382 | * Search for the next available diff that applies to the file |
| 383 | * that currently exists on disk, and enqueue it by calling |
| 384 | * QueueURI(). |
| 385 | * |
| 386 | * \return \b true if an applicable diff was found, \b false |
| 387 | * otherwise. |
| 388 | */ |
| 389 | bool QueueNextDiff(); |
| 390 | |
| 391 | /** \brief Handle tasks that must be performed after the item |
| 392 | * finishes downloading. |
| 393 | * |
| 394 | * Dequeues the item and checks the resulting file's md5sum |
| 395 | * against ExpectedHash after the last patch was applied. |
| 396 | * There is no need to check the md5/sha1 after a "normal" |
| 397 | * patch because QueueNextDiff() will check the sha1 later. |
| 398 | * |
| 399 | * \param allDone If \b true, the file was entirely reconstructed, |
| 400 | * and its md5sum is verified. |
| 401 | */ |
| 402 | void Finish(bool allDone=false); |
| 403 | |
| 404 | protected: |
| 405 | |
| 406 | /** \brief If \b true, debugging output will be written to |
| 407 | * std::clog. |
| 408 | */ |
| 409 | bool Debug; |
| 410 | |
| 411 | /** \brief A description of the item that is currently being |
| 412 | * downloaded. |
| 413 | */ |
| 414 | pkgAcquire::ItemDesc Desc; |
| 415 | |
| 416 | /** \brief The URI of the package index file that is being |
| 417 | * reconstructed. |
| 418 | */ |
| 419 | string RealURI; |
| 420 | |
| 421 | /** \brief The HashSum of the package index file that is being |
| 422 | * reconstructed. |
| 423 | */ |
| 424 | HashString ExpectedHash; |
| 425 | |
| 426 | /** A description of the file being downloaded. */ |
| 427 | string Description; |
| 428 | |
| 429 | /** The patches that remain to be downloaded, including the patch |
| 430 | * being downloaded right now. This list should be ordered so |
| 431 | * that each diff appears before any diff that depends on it. |
| 432 | * |
| 433 | * \todo These are indexed by sha1sum; why not use some sort of |
| 434 | * dictionary instead of relying on ordering and stripping them |
| 435 | * off the front? |
| 436 | */ |
| 437 | vector<DiffInfo> available_patches; |
| 438 | |
| 439 | /** Stop applying patches when reaching that sha1 */ |
| 440 | string ServerSha1; |
| 441 | |
| 442 | /** The current status of this patch. */ |
| 443 | enum DiffState |
| 444 | { |
| 445 | /** \brief The diff is in an unknown state. */ |
| 446 | StateFetchUnkown, |
| 447 | |
| 448 | /** \brief The diff is currently being fetched. */ |
| 449 | StateFetchDiff, |
| 450 | |
| 451 | /** \brief The diff is currently being uncompressed. */ |
| 452 | StateUnzipDiff, |
| 453 | |
| 454 | /** \brief The diff is currently being applied. */ |
| 455 | StateApplyDiff |
| 456 | } State; |
| 457 | |
| 458 | public: |
| 459 | |
| 460 | /** \brief Called when the patch file failed to be downloaded. |
| 461 | * |
| 462 | * This method will fall back to downloading the whole index file |
| 463 | * outright; its arguments are ignored. |
| 464 | */ |
| 465 | virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); |
| 466 | |
| 467 | virtual void Done(string Message,unsigned long Size,string Md5Hash, |
| 468 | pkgAcquire::MethodConfig *Cnf); |
| 469 | virtual string DescURI() {return RealURI + "Index";}; |
| 470 | |
| 471 | /** \brief Create an index diff item. |
| 472 | * |
| 473 | * After filling in its basic fields, this invokes Finish(true) if |
| 474 | * #diffs is empty, or QueueNextDiff() otherwise. |
| 475 | * |
| 476 | * \param Owner The pkgAcquire object that owns this item. |
| 477 | * |
| 478 | * \param URI The URI of the package index file being |
| 479 | * reconstructed. |
| 480 | * |
| 481 | * \param URIDesc A long description of this item. |
| 482 | * |
| 483 | * \param ShortDesc A brief description of this item. |
| 484 | * |
| 485 | * \param ExpectedHash The expected md5sum of the completely |
| 486 | * reconstructed package index file; the index file will be tested |
| 487 | * against this value when it is entirely reconstructed. |
| 488 | * |
| 489 | * \param diffs The remaining diffs from the index of diffs. They |
| 490 | * should be ordered so that each diff appears before any diff |
| 491 | * that depends on it. |
| 492 | */ |
| 493 | pkgAcqIndexDiffs(pkgAcquire *Owner,string URI,string URIDesc, |
| 494 | string ShortDesc, HashString ExpectedHash, |
| 495 | string ServerSha1, |
| 496 | vector<DiffInfo> diffs=vector<DiffInfo>()); |
| 497 | }; |
| 498 | /*}}}*/ |
| 499 | /** \brief An acquire item that is responsible for fetching an index {{{ |
| 500 | * file (e.g., Packages or Sources). |
| 501 | * |
| 502 | * \sa pkgAcqDiffIndex, pkgAcqIndexDiffs, pkgAcqIndexTrans |
| 503 | * |
| 504 | * \todo Why does pkgAcqIndex have protected members? |
| 505 | */ |
| 506 | class pkgAcqIndex : public pkgAcquire::Item |
| 507 | { |
| 508 | protected: |
| 509 | |
| 510 | /** \brief If \b true, the index file has been decompressed. */ |
| 511 | bool Decompression; |
| 512 | |
| 513 | /** \brief If \b true, the partially downloaded file will be |
| 514 | * removed when the download completes. |
| 515 | */ |
| 516 | bool Erase; |
| 517 | |
| 518 | /** \brief The download request that is currently being |
| 519 | * processed. |
| 520 | */ |
| 521 | pkgAcquire::ItemDesc Desc; |
| 522 | |
| 523 | /** \brief The object that is actually being fetched (minus any |
| 524 | * compression-related extensions). |
| 525 | */ |
| 526 | string RealURI; |
| 527 | |
| 528 | /** \brief The expected hashsum of the decompressed index file. */ |
| 529 | HashString ExpectedHash; |
| 530 | |
| 531 | /** \brief The compression-related file extension that is being |
| 532 | * added to the downloaded file (e.g., ".gz" or ".bz2"). |
| 533 | */ |
| 534 | string CompressionExtension; |
| 535 | |
| 536 | public: |
| 537 | |
| 538 | // Specialized action members |
| 539 | virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); |
| 540 | virtual void Done(string Message,unsigned long Size,string Md5Hash, |
| 541 | pkgAcquire::MethodConfig *Cnf); |
| 542 | virtual string Custom600Headers(); |
| 543 | virtual string DescURI() {return RealURI + CompressionExtension;}; |
| 544 | virtual string HashSum() {return ExpectedHash.toStr(); }; |
| 545 | |
| 546 | /** \brief Create a pkgAcqIndex. |
| 547 | * |
| 548 | * \param Owner The pkgAcquire object with which this item is |
| 549 | * associated. |
| 550 | * |
| 551 | * \param URI The URI of the index file that is to be downloaded. |
| 552 | * |
| 553 | * \param URIDesc A "URI-style" description of this index file. |
| 554 | * |
| 555 | * \param ShortDesc A brief description of this index file. |
| 556 | * |
| 557 | * \param ExpectedHash The expected hashsum of this index file. |
| 558 | * |
| 559 | * \param compressExt The compression-related extension with which |
| 560 | * this index file should be downloaded, or "" to autodetect |
| 561 | * Compression types can be set with config Acquire::CompressionTypes, |
| 562 | * default is ".lzma" or ".bz2" (if the needed binaries are present) |
| 563 | * fallback is ".gz" or none. |
| 564 | */ |
| 565 | pkgAcqIndex(pkgAcquire *Owner,string URI,string URIDesc, |
| 566 | string ShortDesc, HashString ExpectedHash, |
| 567 | string compressExt=""); |
| 568 | }; |
| 569 | /*}}}*/ |
| 570 | /** \brief An acquire item that is responsible for fetching a {{{ |
| 571 | * translated index file. |
| 572 | * |
| 573 | * The only difference from pkgAcqIndex is that transient failures |
| 574 | * are suppressed: no error occurs if the translated index file is |
| 575 | * missing. |
| 576 | */ |
| 577 | class pkgAcqIndexTrans : public pkgAcqIndex |
| 578 | { |
| 579 | public: |
| 580 | |
| 581 | virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); |
| 582 | virtual string Custom600Headers(); |
| 583 | |
| 584 | /** \brief Create a pkgAcqIndexTrans. |
| 585 | * |
| 586 | * \param Owner The pkgAcquire object with which this item is |
| 587 | * associated. |
| 588 | * |
| 589 | * \param URI The URI of the index file that is to be downloaded. |
| 590 | * |
| 591 | * \param URIDesc A "URI-style" description of this index file. |
| 592 | * |
| 593 | * \param ShortDesc A brief description of this index file. |
| 594 | */ |
| 595 | pkgAcqIndexTrans(pkgAcquire *Owner,string URI,string URIDesc, |
| 596 | string ShortDesc); |
| 597 | }; |
| 598 | /*}}}*/ |
| 599 | /** \brief Information about an index file. */ /*{{{*/ |
| 600 | struct IndexTarget |
| 601 | { |
| 602 | /** \brief A URI from which the index file can be downloaded. */ |
| 603 | string URI; |
| 604 | |
| 605 | /** \brief A description of the index file. */ |
| 606 | string Description; |
| 607 | |
| 608 | /** \brief A shorter description of the index file. */ |
| 609 | string ShortDesc; |
| 610 | |
| 611 | /** \brief The key by which this index file should be |
| 612 | * looked up within the meta signature file. |
| 613 | */ |
| 614 | string MetaKey; |
| 615 | }; |
| 616 | /*}}}*/ |
| 617 | /** \brief An acquire item that downloads the detached signature {{{ |
| 618 | * of a meta-index (Release) file, then queues up the release |
| 619 | * file itself. |
| 620 | * |
| 621 | * \todo Why protected members? |
| 622 | * |
| 623 | * \sa pkgAcqMetaIndex |
| 624 | */ |
| 625 | class pkgAcqMetaSig : public pkgAcquire::Item |
| 626 | { |
| 627 | protected: |
| 628 | /** \brief The last good signature file */ |
| 629 | string LastGoodSig; |
| 630 | |
| 631 | /** \brief The fetch request that is currently being processed. */ |
| 632 | pkgAcquire::ItemDesc Desc; |
| 633 | |
| 634 | /** \brief The URI of the signature file. Unlike Desc.URI, this is |
| 635 | * never modified; it is used to determine the file that is being |
| 636 | * downloaded. |
| 637 | */ |
| 638 | string RealURI; |
| 639 | |
| 640 | /** \brief The URI of the meta-index file to be fetched after the signature. */ |
| 641 | string MetaIndexURI; |
| 642 | |
| 643 | /** \brief A "URI-style" description of the meta-index file to be |
| 644 | * fetched after the signature. |
| 645 | */ |
| 646 | string MetaIndexURIDesc; |
| 647 | |
| 648 | /** \brief A brief description of the meta-index file to be fetched |
| 649 | * after the signature. |
| 650 | */ |
| 651 | string MetaIndexShortDesc; |
| 652 | |
| 653 | /** \brief A package-system-specific parser for the meta-index file. */ |
| 654 | indexRecords* MetaIndexParser; |
| 655 | |
| 656 | /** \brief The index files which should be looked up in the meta-index |
| 657 | * and then downloaded. |
| 658 | * |
| 659 | * \todo Why a list of pointers instead of a list of structs? |
| 660 | */ |
| 661 | const vector<struct IndexTarget*>* IndexTargets; |
| 662 | |
| 663 | public: |
| 664 | |
| 665 | // Specialized action members |
| 666 | virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); |
| 667 | virtual void Done(string Message,unsigned long Size,string Md5Hash, |
| 668 | pkgAcquire::MethodConfig *Cnf); |
| 669 | virtual string Custom600Headers(); |
| 670 | virtual string DescURI() {return RealURI; }; |
| 671 | |
| 672 | /** \brief Create a new pkgAcqMetaSig. */ |
| 673 | pkgAcqMetaSig(pkgAcquire *Owner,string URI,string URIDesc, string ShortDesc, |
| 674 | string MetaIndexURI, string MetaIndexURIDesc, string MetaIndexShortDesc, |
| 675 | const vector<struct IndexTarget*>* IndexTargets, |
| 676 | indexRecords* MetaIndexParser); |
| 677 | }; |
| 678 | /*}}}*/ |
| 679 | /** \brief An item that is responsible for downloading the meta-index {{{ |
| 680 | * file (i.e., Release) itself and verifying its signature. |
| 681 | * |
| 682 | * Once the download and verification are complete, the downloads of |
| 683 | * the individual index files are queued up using pkgAcqDiffIndex. |
| 684 | * If the meta-index file had a valid signature, the expected hashsums |
| 685 | * of the index files will be the md5sums listed in the meta-index; |
| 686 | * otherwise, the expected hashsums will be "" (causing the |
| 687 | * authentication of the index files to be bypassed). |
| 688 | */ |
| 689 | class pkgAcqMetaIndex : public pkgAcquire::Item |
| 690 | { |
| 691 | protected: |
| 692 | /** \brief The fetch command that is currently being processed. */ |
| 693 | pkgAcquire::ItemDesc Desc; |
| 694 | |
| 695 | /** \brief The URI that is actually being downloaded; never |
| 696 | * modified by pkgAcqMetaIndex. |
| 697 | */ |
| 698 | string RealURI; |
| 699 | |
| 700 | /** \brief The file in which the signature for this index was stored. |
| 701 | * |
| 702 | * If empty, the signature and the md5sums of the individual |
| 703 | * indices will not be checked. |
| 704 | */ |
| 705 | string SigFile; |
| 706 | |
| 707 | /** \brief The index files to download. */ |
| 708 | const vector<struct IndexTarget*>* IndexTargets; |
| 709 | |
| 710 | /** \brief The parser for the meta-index file. */ |
| 711 | indexRecords* MetaIndexParser; |
| 712 | |
| 713 | /** \brief If \b true, the index's signature is currently being verified. |
| 714 | */ |
| 715 | bool AuthPass; |
| 716 | // required to deal gracefully with problems caused by incorrect ims hits |
| 717 | bool IMSHit; |
| 718 | |
| 719 | /** \brief Check that the release file is a release file for the |
| 720 | * correct distribution. |
| 721 | * |
| 722 | * \return \b true if no fatal errors were encountered. |
| 723 | */ |
| 724 | bool VerifyVendor(string Message); |
| 725 | |
| 726 | /** \brief Called when a file is finished being retrieved. |
| 727 | * |
| 728 | * If the file was not downloaded to DestFile, a copy process is |
| 729 | * set up to copy it to DestFile; otherwise, Complete is set to \b |
| 730 | * true and the file is moved to its final location. |
| 731 | * |
| 732 | * \param Message The message block received from the fetch |
| 733 | * subprocess. |
| 734 | */ |
| 735 | void RetrievalDone(string Message); |
| 736 | |
| 737 | /** \brief Called when authentication succeeded. |
| 738 | * |
| 739 | * Sanity-checks the authenticated file, queues up the individual |
| 740 | * index files for download, and saves the signature in the lists |
| 741 | * directory next to the authenticated list file. |
| 742 | * |
| 743 | * \param Message The message block received from the fetch |
| 744 | * subprocess. |
| 745 | */ |
| 746 | void AuthDone(string Message); |
| 747 | |
| 748 | /** \brief Starts downloading the individual index files. |
| 749 | * |
| 750 | * \param verify If \b true, only indices whose expected hashsum |
| 751 | * can be determined from the meta-index will be downloaded, and |
| 752 | * the hashsums of indices will be checked (reporting |
| 753 | * #StatAuthError if there is a mismatch). If verify is \b false, |
| 754 | * no hashsum checking will be performed. |
| 755 | */ |
| 756 | void QueueIndexes(bool verify); |
| 757 | |
| 758 | public: |
| 759 | |
| 760 | // Specialized action members |
| 761 | virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); |
| 762 | virtual void Done(string Message,unsigned long Size, string Hash, |
| 763 | pkgAcquire::MethodConfig *Cnf); |
| 764 | virtual string Custom600Headers(); |
| 765 | virtual string DescURI() {return RealURI; }; |
| 766 | |
| 767 | /** \brief Create a new pkgAcqMetaIndex. */ |
| 768 | pkgAcqMetaIndex(pkgAcquire *Owner, |
| 769 | string URI,string URIDesc, string ShortDesc, |
| 770 | string SigFile, |
| 771 | const vector<struct IndexTarget*>* IndexTargets, |
| 772 | indexRecords* MetaIndexParser); |
| 773 | }; |
| 774 | /*}}}*/ |
| 775 | /** \brief An item that is responsible for fetching a package file. {{{ |
| 776 | * |
| 777 | * If the package file already exists in the cache, nothing will be |
| 778 | * done. |
| 779 | */ |
| 780 | class pkgAcqArchive : public pkgAcquire::Item |
| 781 | { |
| 782 | protected: |
| 783 | /** \brief The package version being fetched. */ |
| 784 | pkgCache::VerIterator Version; |
| 785 | |
| 786 | /** \brief The fetch command that is currently being processed. */ |
| 787 | pkgAcquire::ItemDesc Desc; |
| 788 | |
| 789 | /** \brief The list of sources from which to pick archives to |
| 790 | * download this package from. |
| 791 | */ |
| 792 | pkgSourceList *Sources; |
| 793 | |
| 794 | /** \brief A package records object, used to look up the file |
| 795 | * corresponding to each version of the package. |
| 796 | */ |
| 797 | pkgRecords *Recs; |
| 798 | |
| 799 | /** \brief The hashsum of this package. */ |
| 800 | HashString ExpectedHash; |
| 801 | |
| 802 | /** \brief A location in which the actual filename of the package |
| 803 | * should be stored. |
| 804 | */ |
| 805 | string &StoreFilename; |
| 806 | |
| 807 | /** \brief The next file for this version to try to download. */ |
| 808 | pkgCache::VerFileIterator Vf; |
| 809 | |
| 810 | /** \brief How many (more) times to try to find a new source from |
| 811 | * which to download this package version if it fails. |
| 812 | * |
| 813 | * Set from Acquire::Retries. |
| 814 | */ |
| 815 | unsigned int Retries; |
| 816 | |
| 817 | /** \brief \b true if this version file is being downloaded from a |
| 818 | * trusted source. |
| 819 | */ |
| 820 | bool Trusted; |
| 821 | |
| 822 | /** \brief Queue up the next available file for this version. */ |
| 823 | bool QueueNext(); |
| 824 | |
| 825 | public: |
| 826 | |
| 827 | virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); |
| 828 | virtual void Done(string Message,unsigned long Size,string Hash, |
| 829 | pkgAcquire::MethodConfig *Cnf); |
| 830 | virtual string DescURI() {return Desc.URI;}; |
| 831 | virtual string ShortDesc() {return Desc.ShortDesc;}; |
| 832 | virtual void Finished(); |
| 833 | virtual string HashSum() {return ExpectedHash.toStr(); }; |
| 834 | virtual bool IsTrusted(); |
| 835 | |
| 836 | /** \brief Create a new pkgAcqArchive. |
| 837 | * |
| 838 | * \param Owner The pkgAcquire object with which this item is |
| 839 | * associated. |
| 840 | * |
| 841 | * \param Sources The sources from which to download version |
| 842 | * files. |
| 843 | * |
| 844 | * \param Recs A package records object, used to look up the file |
| 845 | * corresponding to each version of the package. |
| 846 | * |
| 847 | * \param Version The package version to download. |
| 848 | * |
| 849 | * \param StoreFilename A location in which the actual filename of |
| 850 | * the package should be stored. It will be set to a guessed |
| 851 | * basename in the constructor, and filled in with a fully |
| 852 | * qualified filename once the download finishes. |
| 853 | */ |
| 854 | pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources, |
| 855 | pkgRecords *Recs,pkgCache::VerIterator const &Version, |
| 856 | string &StoreFilename); |
| 857 | }; |
| 858 | /*}}}*/ |
| 859 | /** \brief Retrieve an arbitrary file to the current directory. {{{ |
| 860 | * |
| 861 | * The file is retrieved even if it is accessed via a URL type that |
| 862 | * normally is a NOP, such as "file". If the download fails, the |
| 863 | * partial file is renamed to get a ".FAILED" extension. |
| 864 | */ |
| 865 | class pkgAcqFile : public pkgAcquire::Item |
| 866 | { |
| 867 | /** \brief The currently active download process. */ |
| 868 | pkgAcquire::ItemDesc Desc; |
| 869 | |
| 870 | /** \brief The hashsum of the file to download, if it is known. */ |
| 871 | HashString ExpectedHash; |
| 872 | |
| 873 | /** \brief How many times to retry the download, set from |
| 874 | * Acquire::Retries. |
| 875 | */ |
| 876 | unsigned int Retries; |
| 877 | |
| 878 | /** \brief Should this file be considered a index file */ |
| 879 | bool IsIndexFile; |
| 880 | |
| 881 | public: |
| 882 | |
| 883 | // Specialized action members |
| 884 | virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf); |
| 885 | virtual void Done(string Message,unsigned long Size,string CalcHash, |
| 886 | pkgAcquire::MethodConfig *Cnf); |
| 887 | virtual string DescURI() {return Desc.URI;}; |
| 888 | virtual string HashSum() {return ExpectedHash.toStr(); }; |
| 889 | virtual string Custom600Headers(); |
| 890 | |
| 891 | /** \brief Create a new pkgAcqFile object. |
| 892 | * |
| 893 | * \param Owner The pkgAcquire object with which this object is |
| 894 | * associated. |
| 895 | * |
| 896 | * \param URI The URI to download. |
| 897 | * |
| 898 | * \param Hash The hashsum of the file to download, if it is known; |
| 899 | * otherwise "". |
| 900 | * |
| 901 | * \param Size The size of the file to download, if it is known; |
| 902 | * otherwise 0. |
| 903 | * |
| 904 | * \param Desc A description of the file being downloaded. |
| 905 | * |
| 906 | * \param ShortDesc A brief description of the file being |
| 907 | * downloaded. |
| 908 | * |
| 909 | * \param DestDir The directory the file should be downloaded into. |
| 910 | * |
| 911 | * \param DestFilename The filename+path the file is downloaded to. |
| 912 | * |
| 913 | * \param IsIndexFile The file is considered a IndexFile and cache-control |
| 914 | * headers like "cache-control: max-age=0" are send |
| 915 | * |
| 916 | * If DestFilename is empty, download to DestDir/<basename> if |
| 917 | * DestDir is non-empty, $CWD/<basename> otherwise. If |
| 918 | * DestFilename is NOT empty, DestDir is ignored and DestFilename |
| 919 | * is the absolute name to which the file should be downloaded. |
| 920 | */ |
| 921 | |
| 922 | pkgAcqFile(pkgAcquire *Owner, string URI, string Hash, unsigned long Size, |
| 923 | string Desc, string ShortDesc, |
| 924 | const string &DestDir="", const string &DestFilename="", |
| 925 | bool IsIndexFile=false); |
| 926 | }; |
| 927 | /*}}}*/ |
| 928 | /** @} */ |
| 929 | |
| 930 | #endif |