1 // -*- mode: cpp; mode: fold -*-
3 // $Id: acquire-item.cc,v 1.46.2.9 2004/01/16 18:51:11 mdz Exp $
4 /* ######################################################################
6 Acquire Item - Item to acquire
8 Each item can download to exactly one file at a time. This means you
9 cannot create an item that fetches two uri's to two files at the same
10 time. The pkgAcqIndex class creates a second class upon instantiation
11 to fetch the other index files because of this.
13 ##################################################################### */
15 // Include Files /*{{{*/
16 #include <apt-pkg/acquire-item.h>
17 #include <apt-pkg/configuration.h>
18 #include <apt-pkg/aptconfiguration.h>
19 #include <apt-pkg/sourcelist.h>
20 #include <apt-pkg/vendorlist.h>
21 #include <apt-pkg/error.h>
22 #include <apt-pkg/strutl.h>
23 #include <apt-pkg/fileutl.h>
24 #include <apt-pkg/md5.h>
25 #include <apt-pkg/sha1.h>
26 #include <apt-pkg/tagfile.h>
40 // Acquire::Item::Item - Constructor /*{{{*/
41 // ---------------------------------------------------------------------
43 pkgAcquire::Item::Item(pkgAcquire *Owner) : Owner(Owner), FileSize(0),
44 PartialSize(0), Mode(0), ID(0), Complete(false),
45 Local(false), QueueCounter(0)
51 // Acquire::Item::~Item - Destructor /*{{{*/
52 // ---------------------------------------------------------------------
54 pkgAcquire::Item::~Item()
59 // Acquire::Item::Failed - Item failed to download /*{{{*/
60 // ---------------------------------------------------------------------
61 /* We return to an idle state if there are still other queues that could
63 void pkgAcquire::Item::Failed(string Message,pkgAcquire::MethodConfig *Cnf)
66 ErrorText = LookupTag(Message,"Message");
67 if (QueueCounter <= 1)
69 /* This indicates that the file is not available right now but might
70 be sometime later. If we do a retry cycle then this should be
72 if (Cnf->LocalOnly == true &&
73 StringToBool(LookupTag(Message,"Transient-Failure"),false) == true)
85 // Acquire::Item::Start - Item has begun to download /*{{{*/
86 // ---------------------------------------------------------------------
87 /* Stash status and the file size. Note that setting Complete means
88 sub-phases of the acquire process such as decompresion are operating */
89 void pkgAcquire::Item::Start(string /*Message*/,unsigned long Size)
91 Status = StatFetching;
92 if (FileSize == 0 && Complete == false)
96 // Acquire::Item::Done - Item downloaded OK /*{{{*/
97 // ---------------------------------------------------------------------
99 void pkgAcquire::Item::Done(string Message,unsigned long Size,string Hash,
100 pkgAcquire::MethodConfig *Cnf)
102 // We just downloaded something..
103 string FileName = LookupTag(Message,"Filename");
104 // we only inform the Log class if it was actually not a local thing
105 if (Complete == false && !Local && FileName == DestFile)
108 Owner->Log->Fetched(Size,atoi(LookupTag(Message,"Resume-Point","0").c_str()));
115 ErrorText = string();
116 Owner->Dequeue(this);
119 // Acquire::Item::Rename - Rename a file /*{{{*/
120 // ---------------------------------------------------------------------
121 /* This helper function is used by alot of item methods as thier final
123 void pkgAcquire::Item::Rename(string From,string To)
125 if (rename(From.c_str(),To.c_str()) != 0)
128 snprintf(S,sizeof(S),_("rename failed, %s (%s -> %s)."),strerror(errno),
129 From.c_str(),To.c_str());
135 // AcqDiffIndex::AcqDiffIndex - Constructor /*{{{*/
136 // ---------------------------------------------------------------------
137 /* Get the DiffIndex file first and see if there are patches availabe
138 * If so, create a pkgAcqIndexDiffs fetcher that will get and apply the
139 * patches. If anything goes wrong in that process, it will fall back to
140 * the original packages file
142 pkgAcqDiffIndex::pkgAcqDiffIndex(pkgAcquire *Owner,
143 string URI,string URIDesc,string ShortDesc,
144 HashString ExpectedHash)
145 : Item(Owner), RealURI(URI), ExpectedHash(ExpectedHash),
149 Debug = _config->FindB("Debug::pkgAcquire::Diffs",false);
151 Desc.Description = URIDesc + "/DiffIndex";
153 Desc.ShortDesc = ShortDesc;
154 Desc.URI = URI + ".diff/Index";
156 DestFile = _config->FindDir("Dir::State::lists") + "partial/";
157 DestFile += URItoFileName(URI) + string(".DiffIndex");
160 std::clog << "pkgAcqDiffIndex: " << Desc.URI << std::endl;
162 // look for the current package file
163 CurrentPackagesFile = _config->FindDir("Dir::State::lists");
164 CurrentPackagesFile += URItoFileName(RealURI);
166 // FIXME: this file:/ check is a hack to prevent fetching
167 // from local sources. this is really silly, and
168 // should be fixed cleanly as soon as possible
169 if(!FileExists(CurrentPackagesFile) ||
170 Desc.URI.substr(0,strlen("file:/")) == "file:/")
172 // we don't have a pkg file or we don't want to queue
174 std::clog << "No index file, local or canceld by user" << std::endl;
180 std::clog << "pkgAcqIndexDiffs::pkgAcqIndexDiffs(): "
181 << CurrentPackagesFile << std::endl;
187 // AcqIndex::Custom600Headers - Insert custom request headers /*{{{*/
188 // ---------------------------------------------------------------------
189 /* The only header we use is the last-modified header. */
190 string pkgAcqDiffIndex::Custom600Headers()
192 string Final = _config->FindDir("Dir::State::lists");
193 Final += URItoFileName(RealURI) + string(".IndexDiff");
196 std::clog << "Custom600Header-IMS: " << Final << std::endl;
199 if (stat(Final.c_str(),&Buf) != 0)
200 return "\nIndex-File: true";
202 return "\nIndex-File: true\nLast-Modified: " + TimeRFC1123(Buf.st_mtime);
205 bool pkgAcqDiffIndex::ParseDiffIndex(string IndexDiffFile) /*{{{*/
208 std::clog << "pkgAcqIndexDiffs::ParseIndexDiff() " << IndexDiffFile
213 vector<DiffInfo> available_patches;
215 FileFd Fd(IndexDiffFile,FileFd::ReadOnly);
217 if (_error->PendingError() == true)
220 if(TF.Step(Tags) == true)
226 string const tmp = Tags.FindS("SHA1-Current");
227 std::stringstream ss(tmp);
228 ss >> ServerSha1 >> size;
229 unsigned long const ServerSize = atol(size.c_str());
231 FileFd fd(CurrentPackagesFile, FileFd::ReadOnly);
233 SHA1.AddFD(fd.Fd(), fd.Size());
234 string const local_sha1 = SHA1.Result();
236 if(local_sha1 == ServerSha1)
238 // we have the same sha1 as the server
240 std::clog << "Package file is up-to-date" << std::endl;
241 // set found to true, this will queue a pkgAcqIndexDiffs with
242 // a empty availabe_patches
248 std::clog << "SHA1-Current: " << ServerSha1 << std::endl;
250 // check the historie and see what patches we need
251 string const history = Tags.FindS("SHA1-History");
252 std::stringstream hist(history);
253 while(hist >> d.sha1 >> size >> d.file)
255 // read until the first match is found
256 // from that point on, we probably need all diffs
257 if(d.sha1 == local_sha1)
259 else if (found == false)
263 std::clog << "Need to get diff: " << d.file << std::endl;
264 available_patches.push_back(d);
267 if (available_patches.empty() == false)
269 // patching with too many files is rather slow compared to a fast download
270 unsigned long const fileLimit = _config->FindI("Acquire::PDiffs::FileLimit", 0);
271 if (fileLimit != 0 && fileLimit < available_patches.size())
274 std::clog << "Need " << available_patches.size() << " diffs (Limit is " << fileLimit
275 << ") so fallback to complete download" << std::endl;
279 // see if the patches are too big
280 found = false; // it was true and it will be true again at the end
281 d = *available_patches.begin();
282 string const firstPatch = d.file;
283 unsigned long patchesSize = 0;
284 std::stringstream patches(Tags.FindS("SHA1-Patches"));
285 while(patches >> d.sha1 >> size >> d.file)
287 if (firstPatch == d.file)
289 else if (found == false)
292 patchesSize += atol(size.c_str());
294 unsigned long const sizeLimit = ServerSize * _config->FindI("Acquire::PDiffs::SizeLimit", 100);
295 if (sizeLimit > 0 && (sizeLimit/100) < patchesSize)
298 std::clog << "Need " << patchesSize << " bytes (Limit is " << sizeLimit/100
299 << ") so fallback to complete download" << std::endl;
305 // we have something, queue the next diff
309 string::size_type const last_space = Description.rfind(" ");
310 if(last_space != string::npos)
311 Description.erase(last_space, Description.size()-last_space);
312 new pkgAcqIndexDiffs(Owner, RealURI, Description, Desc.ShortDesc,
313 ExpectedHash, available_patches);
321 // Nothing found, report and return false
322 // Failing here is ok, if we return false later, the full
323 // IndexFile is queued
325 std::clog << "Can't find a patch in the index file" << std::endl;
329 void pkgAcqDiffIndex::Failed(string Message,pkgAcquire::MethodConfig *Cnf) /*{{{*/
332 std::clog << "pkgAcqDiffIndex failed: " << Desc.URI << std::endl
333 << "Falling back to normal index file aquire" << std::endl;
335 new pkgAcqIndex(Owner, RealURI, Description, Desc.ShortDesc,
343 void pkgAcqDiffIndex::Done(string Message,unsigned long Size,string Md5Hash, /*{{{*/
344 pkgAcquire::MethodConfig *Cnf)
347 std::clog << "pkgAcqDiffIndex::Done(): " << Desc.URI << std::endl;
349 Item::Done(Message,Size,Md5Hash,Cnf);
352 FinalFile = _config->FindDir("Dir::State::lists")+URItoFileName(RealURI);
354 // sucess in downloading the index
356 FinalFile += string(".IndexDiff");
358 std::clog << "Renaming: " << DestFile << " -> " << FinalFile
360 Rename(DestFile,FinalFile);
361 chmod(FinalFile.c_str(),0644);
362 DestFile = FinalFile;
364 if(!ParseDiffIndex(DestFile))
365 return Failed("", NULL);
373 // AcqIndexDiffs::AcqIndexDiffs - Constructor /*{{{*/
374 // ---------------------------------------------------------------------
375 /* The package diff is added to the queue. one object is constructed
376 * for each diff and the index
378 pkgAcqIndexDiffs::pkgAcqIndexDiffs(pkgAcquire *Owner,
379 string URI,string URIDesc,string ShortDesc,
380 HashString ExpectedHash,
381 vector<DiffInfo> diffs)
382 : Item(Owner), RealURI(URI), ExpectedHash(ExpectedHash),
383 available_patches(diffs)
386 DestFile = _config->FindDir("Dir::State::lists") + "partial/";
387 DestFile += URItoFileName(URI);
389 Debug = _config->FindB("Debug::pkgAcquire::Diffs",false);
391 Description = URIDesc;
393 Desc.ShortDesc = ShortDesc;
395 if(available_patches.size() == 0)
397 // we are done (yeah!)
403 State = StateFetchDiff;
408 void pkgAcqIndexDiffs::Failed(string Message,pkgAcquire::MethodConfig *Cnf) /*{{{*/
411 std::clog << "pkgAcqIndexDiffs failed: " << Desc.URI << std::endl
412 << "Falling back to normal index file aquire" << std::endl;
413 new pkgAcqIndex(Owner, RealURI, Description,Desc.ShortDesc,
418 // Finish - helper that cleans the item out of the fetcher queue /*{{{*/
419 void pkgAcqIndexDiffs::Finish(bool allDone)
421 // we restore the original name, this is required, otherwise
422 // the file will be cleaned
425 DestFile = _config->FindDir("Dir::State::lists");
426 DestFile += URItoFileName(RealURI);
428 if(!ExpectedHash.empty() && !ExpectedHash.VerifyFile(DestFile))
430 Status = StatAuthError;
431 ErrorText = _("MD5Sum mismatch");
432 Rename(DestFile,DestFile + ".FAILED");
437 // this is for the "real" finish
442 std::clog << "\n\nallDone: " << DestFile << "\n" << std::endl;
447 std::clog << "Finishing: " << Desc.URI << std::endl;
454 bool pkgAcqIndexDiffs::QueueNextDiff() /*{{{*/
457 // calc sha1 of the just patched file
458 string FinalFile = _config->FindDir("Dir::State::lists");
459 FinalFile += URItoFileName(RealURI);
461 FileFd fd(FinalFile, FileFd::ReadOnly);
463 SHA1.AddFD(fd.Fd(), fd.Size());
464 string local_sha1 = string(SHA1.Result());
466 std::clog << "QueueNextDiff: "
467 << FinalFile << " (" << local_sha1 << ")"<<std::endl;
469 // remove all patches until the next matching patch is found
470 // this requires the Index file to be ordered
471 for(vector<DiffInfo>::iterator I=available_patches.begin();
472 available_patches.size() > 0 &&
473 I != available_patches.end() &&
474 (*I).sha1 != local_sha1;
477 available_patches.erase(I);
480 // error checking and falling back if no patch was found
481 if(available_patches.size() == 0)
487 // queue the right diff
488 Desc.URI = string(RealURI) + ".diff/" + available_patches[0].file + ".gz";
489 Desc.Description = Description + " " + available_patches[0].file + string(".pdiff");
490 DestFile = _config->FindDir("Dir::State::lists") + "partial/";
491 DestFile += URItoFileName(RealURI + ".diff/" + available_patches[0].file);
494 std::clog << "pkgAcqIndexDiffs::QueueNextDiff(): " << Desc.URI << std::endl;
501 void pkgAcqIndexDiffs::Done(string Message,unsigned long Size,string Md5Hash, /*{{{*/
502 pkgAcquire::MethodConfig *Cnf)
505 std::clog << "pkgAcqIndexDiffs::Done(): " << Desc.URI << std::endl;
507 Item::Done(Message,Size,Md5Hash,Cnf);
510 FinalFile = _config->FindDir("Dir::State::lists")+URItoFileName(RealURI);
512 // sucess in downloading a diff, enter ApplyDiff state
513 if(State == StateFetchDiff)
517 std::clog << "Sending to gzip method: " << FinalFile << std::endl;
519 string FileName = LookupTag(Message,"Filename");
520 State = StateUnzipDiff;
522 Desc.URI = "gzip:" + FileName;
523 DestFile += ".decomp";
529 // sucess in downloading a diff, enter ApplyDiff state
530 if(State == StateUnzipDiff)
533 // rred excepts the patch as $FinalFile.ed
534 Rename(DestFile,FinalFile+".ed");
537 std::clog << "Sending to rred method: " << FinalFile << std::endl;
539 State = StateApplyDiff;
541 Desc.URI = "rred:" + FinalFile;
548 // success in download/apply a diff, queue next (if needed)
549 if(State == StateApplyDiff)
551 // remove the just applied patch
552 available_patches.erase(available_patches.begin());
557 std::clog << "Moving patched file in place: " << std::endl
558 << DestFile << " -> " << FinalFile << std::endl;
560 Rename(DestFile,FinalFile);
561 chmod(FinalFile.c_str(),0644);
563 // see if there is more to download
564 if(available_patches.size() > 0) {
565 new pkgAcqIndexDiffs(Owner, RealURI, Description, Desc.ShortDesc,
566 ExpectedHash, available_patches);
573 // AcqIndex::AcqIndex - Constructor /*{{{*/
574 // ---------------------------------------------------------------------
575 /* The package file is added to the queue and a second class is
576 instantiated to fetch the revision file */
577 pkgAcqIndex::pkgAcqIndex(pkgAcquire *Owner,
578 string URI,string URIDesc,string ShortDesc,
579 HashString ExpectedHash, string comprExt)
580 : Item(Owner), RealURI(URI), ExpectedHash(ExpectedHash)
582 Decompression = false;
585 DestFile = _config->FindDir("Dir::State::lists") + "partial/";
586 DestFile += URItoFileName(URI);
590 // autoselect the compression method
591 std::vector<std::string> types = APT::Configuration::getCompressionTypes();
592 if (types.empty() == true)
595 comprExt = "." + types[0];
597 CompressionExtension = ((comprExt == "plain" || comprExt == ".") ? "" : comprExt);
599 Desc.URI = URI + CompressionExtension;
601 Desc.Description = URIDesc;
603 Desc.ShortDesc = ShortDesc;
608 // AcqIndex::Custom600Headers - Insert custom request headers /*{{{*/
609 // ---------------------------------------------------------------------
610 /* The only header we use is the last-modified header. */
611 string pkgAcqIndex::Custom600Headers()
613 string Final = _config->FindDir("Dir::State::lists");
614 Final += URItoFileName(RealURI);
617 if (stat(Final.c_str(),&Buf) != 0)
618 return "\nIndex-File: true";
620 return "\nIndex-File: true\nLast-Modified: " + TimeRFC1123(Buf.st_mtime);
623 void pkgAcqIndex::Failed(string Message,pkgAcquire::MethodConfig *Cnf) /*{{{*/
625 std::vector<std::string> types = APT::Configuration::getCompressionTypes();
627 for (std::vector<std::string>::const_iterator t = types.begin();
628 t != types.end(); t++)
630 // jump over all already tried compression types
631 const unsigned int nameLen = Desc.URI.size() - (*t).size();
632 if(Desc.URI.substr(nameLen) != *t)
635 // we want to try it with the next extension (and make sure to
636 // not skip over the end)
638 if (t == types.end())
641 // queue new download
642 Desc.URI = Desc.URI.substr(0, nameLen) + *t;
643 new pkgAcqIndex(Owner, RealURI, Desc.Description, Desc.ShortDesc,
644 ExpectedHash, string(".").append(*t));
652 // on decompression failure, remove bad versions in partial/
653 if(Decompression && Erase) {
654 string s = _config->FindDir("Dir::State::lists") + "partial/";
655 s += URItoFileName(RealURI);
659 Item::Failed(Message,Cnf);
662 // AcqIndex::Done - Finished a fetch /*{{{*/
663 // ---------------------------------------------------------------------
664 /* This goes through a number of states.. On the initial fetch the
665 method could possibly return an alternate filename which points
666 to the uncompressed version of the file. If this is so the file
667 is copied into the partial directory. In all other cases the file
668 is decompressed with a gzip uri. */
669 void pkgAcqIndex::Done(string Message,unsigned long Size,string Hash,
670 pkgAcquire::MethodConfig *Cfg)
672 Item::Done(Message,Size,Hash,Cfg);
674 if (Decompression == true)
676 if (_config->FindB("Debug::pkgAcquire::Auth", false))
678 std::cerr << std::endl << RealURI << ": Computed Hash: " << Hash;
679 std::cerr << " Expected Hash: " << ExpectedHash.toStr() << std::endl;
682 if (!ExpectedHash.empty() && ExpectedHash.toStr() != Hash)
684 Status = StatAuthError;
685 ErrorText = _("Hash Sum mismatch");
686 Rename(DestFile,DestFile + ".FAILED");
689 // Done, move it into position
690 string FinalFile = _config->FindDir("Dir::State::lists");
691 FinalFile += URItoFileName(RealURI);
692 Rename(DestFile,FinalFile);
693 chmod(FinalFile.c_str(),0644);
695 /* We restore the original name to DestFile so that the clean operation
697 DestFile = _config->FindDir("Dir::State::lists") + "partial/";
698 DestFile += URItoFileName(RealURI);
700 // Remove the compressed version.
702 unlink(DestFile.c_str());
709 // Handle the unzipd case
710 string FileName = LookupTag(Message,"Alt-Filename");
711 if (FileName.empty() == false)
713 // The files timestamp matches
714 if (StringToBool(LookupTag(Message,"Alt-IMS-Hit"),false) == true)
716 Decompression = true;
718 DestFile += ".decomp";
719 Desc.URI = "copy:" + FileName;
725 FileName = LookupTag(Message,"Filename");
726 if (FileName.empty() == true)
729 ErrorText = "Method gave a blank filename";
732 // The files timestamp matches
733 if (StringToBool(LookupTag(Message,"IMS-Hit"),false) == true)
736 if (FileName == DestFile)
741 string compExt = flExtension(flNotDir(URI(Desc.URI).Path));
744 // get the binary name for your used compression type
745 decompProg = _config->Find(string("Acquire::CompressionTypes::").append(compExt),"");
746 if(decompProg.empty() == false);
747 // flExtensions returns the full name if no extension is found
748 // this is why we have this complicated compare operation here
749 // FIMXE: add a new flJustExtension() that return "" if no
750 // extension is found and use that above so that it can
751 // be tested against ""
752 else if(compExt == flNotDir(URI(Desc.URI).Path))
755 _error->Error("Unsupported extension: %s", compExt.c_str());
759 Decompression = true;
760 DestFile += ".decomp";
761 Desc.URI = decompProg + ":" + FileName;
763 Mode = decompProg.c_str();
766 // AcqIndexTrans::pkgAcqIndexTrans - Constructor /*{{{*/
767 // ---------------------------------------------------------------------
768 /* The Translation file is added to the queue */
769 pkgAcqIndexTrans::pkgAcqIndexTrans(pkgAcquire *Owner,
770 string URI,string URIDesc,string ShortDesc)
771 : pkgAcqIndex(Owner, URI, URIDesc, ShortDesc, HashString(), "")
775 // AcqIndexTrans::Failed - Silence failure messages for missing files /*{{{*/
776 // ---------------------------------------------------------------------
778 void pkgAcqIndexTrans::Failed(string Message,pkgAcquire::MethodConfig *Cnf)
780 if (Cnf->LocalOnly == true ||
781 StringToBool(LookupTag(Message,"Transient-Failure"),false) == false)
790 Item::Failed(Message,Cnf);
793 pkgAcqMetaSig::pkgAcqMetaSig(pkgAcquire *Owner, /*{{{*/
794 string URI,string URIDesc,string ShortDesc,
795 string MetaIndexURI, string MetaIndexURIDesc,
796 string MetaIndexShortDesc,
797 const vector<IndexTarget*>* IndexTargets,
798 indexRecords* MetaIndexParser) :
799 Item(Owner), RealURI(URI), MetaIndexURI(MetaIndexURI),
800 MetaIndexURIDesc(MetaIndexURIDesc), MetaIndexShortDesc(MetaIndexShortDesc),
801 MetaIndexParser(MetaIndexParser), IndexTargets(IndexTargets)
803 DestFile = _config->FindDir("Dir::State::lists") + "partial/";
804 DestFile += URItoFileName(URI);
806 // remove any partial downloaded sig-file in partial/.
807 // it may confuse proxies and is too small to warrant a
808 // partial download anyway
809 unlink(DestFile.c_str());
812 Desc.Description = URIDesc;
814 Desc.ShortDesc = ShortDesc;
817 string Final = _config->FindDir("Dir::State::lists");
818 Final += URItoFileName(RealURI);
820 if (stat(Final.c_str(),&Buf) == 0)
822 // File was already in place. It needs to be re-downloaded/verified
823 // because Release might have changed, we do give it a differnt
824 // name than DestFile because otherwise the http method will
825 // send If-Range requests and there are too many broken servers
826 // out there that do not understand them
827 LastGoodSig = DestFile+".reverify";
828 Rename(Final,LastGoodSig);
834 // pkgAcqMetaSig::Custom600Headers - Insert custom request headers /*{{{*/
835 // ---------------------------------------------------------------------
836 /* The only header we use is the last-modified header. */
837 string pkgAcqMetaSig::Custom600Headers()
840 if (stat(LastGoodSig.c_str(),&Buf) != 0)
841 return "\nIndex-File: true";
843 return "\nIndex-File: true\nLast-Modified: " + TimeRFC1123(Buf.st_mtime);
846 void pkgAcqMetaSig::Done(string Message,unsigned long Size,string MD5,
847 pkgAcquire::MethodConfig *Cfg)
849 Item::Done(Message,Size,MD5,Cfg);
851 string FileName = LookupTag(Message,"Filename");
852 if (FileName.empty() == true)
855 ErrorText = "Method gave a blank filename";
859 if (FileName != DestFile)
861 // We have to copy it into place
863 Desc.URI = "copy:" + FileName;
870 // put the last known good file back on i-m-s hit (it will
871 // be re-verified again)
872 // Else do nothing, we have the new file in DestFile then
873 if(StringToBool(LookupTag(Message,"IMS-Hit"),false) == true)
874 Rename(LastGoodSig, DestFile);
876 // queue a pkgAcqMetaIndex to be verified against the sig we just retrieved
877 new pkgAcqMetaIndex(Owner, MetaIndexURI, MetaIndexURIDesc, MetaIndexShortDesc,
878 DestFile, IndexTargets, MetaIndexParser);
882 void pkgAcqMetaSig::Failed(string Message,pkgAcquire::MethodConfig *Cnf)/*{{{*/
884 string Final = _config->FindDir("Dir::State::lists") + URItoFileName(RealURI);
886 // if we get a network error we fail gracefully
887 if(Status == StatTransientNetworkError)
889 Item::Failed(Message,Cnf);
890 // move the sigfile back on transient network failures
891 if(FileExists(DestFile))
892 Rename(LastGoodSig,Final);
894 // set the status back to , Item::Failed likes to reset it
895 Status = pkgAcquire::Item::StatTransientNetworkError;
899 // Delete any existing sigfile when the acquire failed
900 unlink(Final.c_str());
902 // queue a pkgAcqMetaIndex with no sigfile
903 new pkgAcqMetaIndex(Owner, MetaIndexURI, MetaIndexURIDesc, MetaIndexShortDesc,
904 "", IndexTargets, MetaIndexParser);
906 if (Cnf->LocalOnly == true ||
907 StringToBool(LookupTag(Message,"Transient-Failure"),false) == false)
916 Item::Failed(Message,Cnf);
919 pkgAcqMetaIndex::pkgAcqMetaIndex(pkgAcquire *Owner, /*{{{*/
920 string URI,string URIDesc,string ShortDesc,
922 const vector<struct IndexTarget*>* IndexTargets,
923 indexRecords* MetaIndexParser) :
924 Item(Owner), RealURI(URI), SigFile(SigFile), IndexTargets(IndexTargets),
925 MetaIndexParser(MetaIndexParser), AuthPass(false), IMSHit(false)
927 DestFile = _config->FindDir("Dir::State::lists") + "partial/";
928 DestFile += URItoFileName(URI);
931 Desc.Description = URIDesc;
933 Desc.ShortDesc = ShortDesc;
939 // pkgAcqMetaIndex::Custom600Headers - Insert custom request headers /*{{{*/
940 // ---------------------------------------------------------------------
941 /* The only header we use is the last-modified header. */
942 string pkgAcqMetaIndex::Custom600Headers()
944 string Final = _config->FindDir("Dir::State::lists");
945 Final += URItoFileName(RealURI);
948 if (stat(Final.c_str(),&Buf) != 0)
949 return "\nIndex-File: true";
951 return "\nIndex-File: true\nLast-Modified: " + TimeRFC1123(Buf.st_mtime);
954 void pkgAcqMetaIndex::Done(string Message,unsigned long Size,string Hash, /*{{{*/
955 pkgAcquire::MethodConfig *Cfg)
957 Item::Done(Message,Size,Hash,Cfg);
959 // MetaIndexes are done in two passes: one to download the
960 // metaindex with an appropriate method, and a second to verify it
961 // with the gpgv method
963 if (AuthPass == true)
969 RetrievalDone(Message);
971 // Still more retrieving to do
976 // There was no signature file, so we are finished. Download
977 // the indexes without verification.
982 // There was a signature file, so pass it to gpgv for
985 if (_config->FindB("Debug::pkgAcquire::Auth", false))
986 std::cerr << "Metaindex acquired, queueing gpg verification ("
987 << SigFile << "," << DestFile << ")\n";
989 Desc.URI = "gpgv:" + SigFile;
996 void pkgAcqMetaIndex::RetrievalDone(string Message) /*{{{*/
998 // We have just finished downloading a Release file (it is not
1001 string FileName = LookupTag(Message,"Filename");
1002 if (FileName.empty() == true)
1005 ErrorText = "Method gave a blank filename";
1009 if (FileName != DestFile)
1012 Desc.URI = "copy:" + FileName;
1017 // see if the download was a IMSHit
1018 IMSHit = StringToBool(LookupTag(Message,"IMS-Hit"),false);
1021 string FinalFile = _config->FindDir("Dir::State::lists");
1022 FinalFile += URItoFileName(RealURI);
1024 // If we get a IMS hit we can remove the empty file in partial
1025 // othersie we move the file in place
1027 unlink(DestFile.c_str());
1029 Rename(DestFile,FinalFile);
1031 chmod(FinalFile.c_str(),0644);
1032 DestFile = FinalFile;
1035 void pkgAcqMetaIndex::AuthDone(string Message) /*{{{*/
1037 // At this point, the gpgv method has succeeded, so there is a
1038 // valid signature from a key in the trusted keyring. We
1039 // perform additional verification of its contents, and use them
1040 // to verify the indexes we are about to download
1042 if (!MetaIndexParser->Load(DestFile))
1044 Status = StatAuthError;
1045 ErrorText = MetaIndexParser->ErrorText;
1049 if (!VerifyVendor(Message))
1054 if (_config->FindB("Debug::pkgAcquire::Auth", false))
1055 std::cerr << "Signature verification succeeded: "
1056 << DestFile << std::endl;
1058 // Download further indexes with verification
1061 // Done, move signature file into position
1063 string VerifiedSigFile = _config->FindDir("Dir::State::lists") +
1064 URItoFileName(RealURI) + ".gpg";
1065 Rename(SigFile,VerifiedSigFile);
1066 chmod(VerifiedSigFile.c_str(),0644);
1069 void pkgAcqMetaIndex::QueueIndexes(bool verify) /*{{{*/
1071 for (vector <struct IndexTarget*>::const_iterator Target = IndexTargets->begin();
1072 Target != IndexTargets->end();
1075 HashString ExpectedIndexHash;
1078 const indexRecords::checkSum *Record = MetaIndexParser->Lookup((*Target)->MetaKey);
1081 Status = StatAuthError;
1082 ErrorText = "Unable to find expected entry "
1083 + (*Target)->MetaKey + " in Meta-index file (malformed Release file?)";
1086 ExpectedIndexHash = Record->Hash;
1087 if (_config->FindB("Debug::pkgAcquire::Auth", false))
1089 std::cerr << "Queueing: " << (*Target)->URI << std::endl;
1090 std::cerr << "Expected Hash: " << ExpectedIndexHash.toStr() << std::endl;
1092 if (ExpectedIndexHash.empty())
1094 Status = StatAuthError;
1095 ErrorText = "Unable to find hash sum for "
1096 + (*Target)->MetaKey + " in Meta-index file";
1101 // Queue Packages file (either diff or full packages files, depending
1102 // on the users option)
1103 if(_config->FindB("Acquire::PDiffs",true) == true)
1104 new pkgAcqDiffIndex(Owner, (*Target)->URI, (*Target)->Description,
1105 (*Target)->ShortDesc, ExpectedIndexHash);
1107 new pkgAcqIndex(Owner, (*Target)->URI, (*Target)->Description,
1108 (*Target)->ShortDesc, ExpectedIndexHash);
1112 bool pkgAcqMetaIndex::VerifyVendor(string Message) /*{{{*/
1114 // // Maybe this should be made available from above so we don't have
1115 // // to read and parse it every time?
1116 // pkgVendorList List;
1117 // List.ReadMainList();
1119 // const Vendor* Vndr = NULL;
1120 // for (std::vector<string>::const_iterator I = GPGVOutput.begin(); I != GPGVOutput.end(); I++)
1122 // string::size_type pos = (*I).find("VALIDSIG ");
1123 // if (_config->FindB("Debug::Vendor", false))
1124 // std::cerr << "Looking for VALIDSIG in \"" << (*I) << "\": pos " << pos
1126 // if (pos != std::string::npos)
1128 // string Fingerprint = (*I).substr(pos+sizeof("VALIDSIG"));
1129 // if (_config->FindB("Debug::Vendor", false))
1130 // std::cerr << "Looking for \"" << Fingerprint << "\" in vendor..." <<
1132 // Vndr = List.FindVendor(Fingerprint) != "";
1133 // if (Vndr != NULL);
1137 string::size_type pos;
1139 // check for missing sigs (that where not fatal because otherwise we had
1142 string msg = _("There is no public key available for the "
1143 "following key IDs:\n");
1144 pos = Message.find("NO_PUBKEY ");
1145 if (pos != std::string::npos)
1147 string::size_type start = pos+strlen("NO_PUBKEY ");
1148 string Fingerprint = Message.substr(start, Message.find("\n")-start);
1149 missingkeys += (Fingerprint);
1151 if(!missingkeys.empty())
1152 _error->Warning("%s", string(msg+missingkeys).c_str());
1154 string Transformed = MetaIndexParser->GetExpectedDist();
1156 if (Transformed == "../project/experimental")
1158 Transformed = "experimental";
1161 pos = Transformed.rfind('/');
1162 if (pos != string::npos)
1164 Transformed = Transformed.substr(0, pos);
1167 if (Transformed == ".")
1172 if (_config->FindB("Debug::pkgAcquire::Auth", false))
1174 std::cerr << "Got Codename: " << MetaIndexParser->GetDist() << std::endl;
1175 std::cerr << "Expecting Dist: " << MetaIndexParser->GetExpectedDist() << std::endl;
1176 std::cerr << "Transformed Dist: " << Transformed << std::endl;
1179 if (MetaIndexParser->CheckDist(Transformed) == false)
1181 // This might become fatal one day
1182 // Status = StatAuthError;
1183 // ErrorText = "Conflicting distribution; expected "
1184 // + MetaIndexParser->GetExpectedDist() + " but got "
1185 // + MetaIndexParser->GetDist();
1187 if (!Transformed.empty())
1189 _error->Warning("Conflicting distribution: %s (expected %s but got %s)",
1190 Desc.Description.c_str(),
1191 Transformed.c_str(),
1192 MetaIndexParser->GetDist().c_str());
1199 // pkgAcqMetaIndex::Failed - no Release file present or no signature file present /*{{{*/
1200 // ---------------------------------------------------------------------
1202 void pkgAcqMetaIndex::Failed(string Message,pkgAcquire::MethodConfig *Cnf)
1204 if (AuthPass == true)
1206 // if we fail the authentication but got the file via a IMS-Hit
1207 // this means that the file wasn't downloaded and that it might be
1208 // just stale (server problem, proxy etc). we delete what we have
1209 // queue it again without i-m-s
1210 // alternatively we could just unlink the file and let the user try again
1216 unlink(DestFile.c_str());
1218 DestFile = _config->FindDir("Dir::State::lists") + "partial/";
1219 DestFile += URItoFileName(RealURI);
1225 // gpgv method failed
1226 _error->Warning("GPG error: %s: %s",
1227 Desc.Description.c_str(),
1228 LookupTag(Message,"Message").c_str());
1232 // No Release file was present, or verification failed, so fall
1233 // back to queueing Packages files without verification
1234 QueueIndexes(false);
1237 // AcqArchive::AcqArchive - Constructor /*{{{*/
1238 // ---------------------------------------------------------------------
1239 /* This just sets up the initial fetch environment and queues the first
1241 pkgAcqArchive::pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
1242 pkgRecords *Recs,pkgCache::VerIterator const &Version,
1243 string &StoreFilename) :
1244 Item(Owner), Version(Version), Sources(Sources), Recs(Recs),
1245 StoreFilename(StoreFilename), Vf(Version.FileList()),
1248 Retries = _config->FindI("Acquire::Retries",0);
1250 if (Version.Arch() == 0)
1252 _error->Error(_("I wasn't able to locate a file for the %s package. "
1253 "This might mean you need to manually fix this package. "
1254 "(due to missing arch)"),
1255 Version.ParentPkg().Name());
1259 /* We need to find a filename to determine the extension. We make the
1260 assumption here that all the available sources for this version share
1261 the same extension.. */
1262 // Skip not source sources, they do not have file fields.
1263 for (; Vf.end() == false; Vf++)
1265 if ((Vf.File()->Flags & pkgCache::Flag::NotSource) != 0)
1270 // Does not really matter here.. we are going to fail out below
1271 if (Vf.end() != true)
1273 // If this fails to get a file name we will bomb out below.
1274 pkgRecords::Parser &Parse = Recs->Lookup(Vf);
1275 if (_error->PendingError() == true)
1278 // Generate the final file name as: package_version_arch.foo
1279 StoreFilename = QuoteString(Version.ParentPkg().Name(),"_:") + '_' +
1280 QuoteString(Version.VerStr(),"_:") + '_' +
1281 QuoteString(Version.Arch(),"_:.") +
1282 "." + flExtension(Parse.FileName());
1285 // check if we have one trusted source for the package. if so, switch
1286 // to "TrustedOnly" mode
1287 for (pkgCache::VerFileIterator i = Version.FileList(); i.end() == false; i++)
1289 pkgIndexFile *Index;
1290 if (Sources->FindIndex(i.File(),Index) == false)
1292 if (_config->FindB("Debug::pkgAcquire::Auth", false))
1294 std::cerr << "Checking index: " << Index->Describe()
1295 << "(Trusted=" << Index->IsTrusted() << ")\n";
1297 if (Index->IsTrusted()) {
1303 // "allow-unauthenticated" restores apts old fetching behaviour
1304 // that means that e.g. unauthenticated file:// uris are higher
1305 // priority than authenticated http:// uris
1306 if (_config->FindB("APT::Get::AllowUnauthenticated",false) == true)
1310 if (QueueNext() == false && _error->PendingError() == false)
1311 _error->Error(_("I wasn't able to locate file for the %s package. "
1312 "This might mean you need to manually fix this package."),
1313 Version.ParentPkg().Name());
1316 // AcqArchive::QueueNext - Queue the next file source /*{{{*/
1317 // ---------------------------------------------------------------------
1318 /* This queues the next available file version for download. It checks if
1319 the archive is already available in the cache and stashs the MD5 for
1321 bool pkgAcqArchive::QueueNext()
1323 for (; Vf.end() == false; Vf++)
1325 // Ignore not source sources
1326 if ((Vf.File()->Flags & pkgCache::Flag::NotSource) != 0)
1329 // Try to cross match against the source list
1330 pkgIndexFile *Index;
1331 if (Sources->FindIndex(Vf.File(),Index) == false)
1334 // only try to get a trusted package from another source if that source
1336 if(Trusted && !Index->IsTrusted())
1339 // Grab the text package record
1340 pkgRecords::Parser &Parse = Recs->Lookup(Vf);
1341 if (_error->PendingError() == true)
1344 string PkgFile = Parse.FileName();
1345 if(Parse.SHA256Hash() != "")
1346 ExpectedHash = HashString("SHA256", Parse.SHA256Hash());
1347 else if (Parse.SHA1Hash() != "")
1348 ExpectedHash = HashString("SHA1", Parse.SHA1Hash());
1350 ExpectedHash = HashString("MD5Sum", Parse.MD5Hash());
1351 if (PkgFile.empty() == true)
1352 return _error->Error(_("The package index files are corrupted. No Filename: "
1353 "field for package %s."),
1354 Version.ParentPkg().Name());
1356 Desc.URI = Index->ArchiveURI(PkgFile);
1357 Desc.Description = Index->ArchiveInfo(Version);
1359 Desc.ShortDesc = Version.ParentPkg().Name();
1361 // See if we already have the file. (Legacy filenames)
1362 FileSize = Version->Size;
1363 string FinalFile = _config->FindDir("Dir::Cache::Archives") + flNotDir(PkgFile);
1365 if (stat(FinalFile.c_str(),&Buf) == 0)
1367 // Make sure the size matches
1368 if ((unsigned)Buf.st_size == Version->Size)
1373 StoreFilename = DestFile = FinalFile;
1377 /* Hmm, we have a file and its size does not match, this means it is
1378 an old style mismatched arch */
1379 unlink(FinalFile.c_str());
1382 // Check it again using the new style output filenames
1383 FinalFile = _config->FindDir("Dir::Cache::Archives") + flNotDir(StoreFilename);
1384 if (stat(FinalFile.c_str(),&Buf) == 0)
1386 // Make sure the size matches
1387 if ((unsigned)Buf.st_size == Version->Size)
1392 StoreFilename = DestFile = FinalFile;
1396 /* Hmm, we have a file and its size does not match, this shouldnt
1398 unlink(FinalFile.c_str());
1401 DestFile = _config->FindDir("Dir::Cache::Archives") + "partial/" + flNotDir(StoreFilename);
1403 // Check the destination file
1404 if (stat(DestFile.c_str(),&Buf) == 0)
1406 // Hmm, the partial file is too big, erase it
1407 if ((unsigned)Buf.st_size > Version->Size)
1408 unlink(DestFile.c_str());
1410 PartialSize = Buf.st_size;
1415 Desc.URI = Index->ArchiveURI(PkgFile);
1416 Desc.Description = Index->ArchiveInfo(Version);
1418 Desc.ShortDesc = Version.ParentPkg().Name();
1427 // AcqArchive::Done - Finished fetching /*{{{*/
1428 // ---------------------------------------------------------------------
1430 void pkgAcqArchive::Done(string Message,unsigned long Size,string CalcHash,
1431 pkgAcquire::MethodConfig *Cfg)
1433 Item::Done(Message,Size,CalcHash,Cfg);
1436 if (Size != Version->Size)
1439 ErrorText = _("Size mismatch");
1444 if(ExpectedHash.toStr() != CalcHash)
1447 ErrorText = _("Hash Sum mismatch");
1448 if(FileExists(DestFile))
1449 Rename(DestFile,DestFile + ".FAILED");
1453 // Grab the output filename
1454 string FileName = LookupTag(Message,"Filename");
1455 if (FileName.empty() == true)
1458 ErrorText = "Method gave a blank filename";
1464 // Reference filename
1465 if (FileName != DestFile)
1467 StoreFilename = DestFile = FileName;
1472 // Done, move it into position
1473 string FinalFile = _config->FindDir("Dir::Cache::Archives");
1474 FinalFile += flNotDir(StoreFilename);
1475 Rename(DestFile,FinalFile);
1477 StoreFilename = DestFile = FinalFile;
1481 // AcqArchive::Failed - Failure handler /*{{{*/
1482 // ---------------------------------------------------------------------
1483 /* Here we try other sources */
1484 void pkgAcqArchive::Failed(string Message,pkgAcquire::MethodConfig *Cnf)
1486 ErrorText = LookupTag(Message,"Message");
1488 /* We don't really want to retry on failed media swaps, this prevents
1489 that. An interesting observation is that permanent failures are not
1491 if (Cnf->Removable == true &&
1492 StringToBool(LookupTag(Message,"Transient-Failure"),false) == true)
1494 // Vf = Version.FileList();
1495 while (Vf.end() == false) Vf++;
1496 StoreFilename = string();
1497 Item::Failed(Message,Cnf);
1501 if (QueueNext() == false)
1503 // This is the retry counter
1505 Cnf->LocalOnly == false &&
1506 StringToBool(LookupTag(Message,"Transient-Failure"),false) == true)
1509 Vf = Version.FileList();
1510 if (QueueNext() == true)
1514 StoreFilename = string();
1515 Item::Failed(Message,Cnf);
1519 // AcqArchive::IsTrusted - Determine whether this archive comes from a trusted source /*{{{*/
1520 // ---------------------------------------------------------------------
1521 bool pkgAcqArchive::IsTrusted()
1526 // AcqArchive::Finished - Fetching has finished, tidy up /*{{{*/
1527 // ---------------------------------------------------------------------
1529 void pkgAcqArchive::Finished()
1531 if (Status == pkgAcquire::Item::StatDone &&
1534 StoreFilename = string();
1537 // AcqFile::pkgAcqFile - Constructor /*{{{*/
1538 // ---------------------------------------------------------------------
1539 /* The file is added to the queue */
1540 pkgAcqFile::pkgAcqFile(pkgAcquire *Owner,string URI,string Hash,
1541 unsigned long Size,string Dsc,string ShortDesc,
1542 const string &DestDir, const string &DestFilename) :
1543 Item(Owner), ExpectedHash(Hash)
1545 Retries = _config->FindI("Acquire::Retries",0);
1547 if(!DestFilename.empty())
1548 DestFile = DestFilename;
1549 else if(!DestDir.empty())
1550 DestFile = DestDir + "/" + flNotDir(URI);
1552 DestFile = flNotDir(URI);
1556 Desc.Description = Dsc;
1559 // Set the short description to the archive component
1560 Desc.ShortDesc = ShortDesc;
1562 // Get the transfer sizes
1565 if (stat(DestFile.c_str(),&Buf) == 0)
1567 // Hmm, the partial file is too big, erase it
1568 if ((unsigned)Buf.st_size > Size)
1569 unlink(DestFile.c_str());
1571 PartialSize = Buf.st_size;
1577 // AcqFile::Done - Item downloaded OK /*{{{*/
1578 // ---------------------------------------------------------------------
1580 void pkgAcqFile::Done(string Message,unsigned long Size,string CalcHash,
1581 pkgAcquire::MethodConfig *Cnf)
1583 Item::Done(Message,Size,CalcHash,Cnf);
1586 if(!ExpectedHash.empty() && ExpectedHash.toStr() != CalcHash)
1589 ErrorText = "Hash Sum mismatch";
1590 Rename(DestFile,DestFile + ".FAILED");
1594 string FileName = LookupTag(Message,"Filename");
1595 if (FileName.empty() == true)
1598 ErrorText = "Method gave a blank filename";
1604 // The files timestamp matches
1605 if (StringToBool(LookupTag(Message,"IMS-Hit"),false) == true)
1608 // We have to copy it into place
1609 if (FileName != DestFile)
1612 if (_config->FindB("Acquire::Source-Symlinks",true) == false ||
1613 Cnf->Removable == true)
1615 Desc.URI = "copy:" + FileName;
1620 // Erase the file if it is a symlink so we can overwrite it
1622 if (lstat(DestFile.c_str(),&St) == 0)
1624 if (S_ISLNK(St.st_mode) != 0)
1625 unlink(DestFile.c_str());
1629 if (symlink(FileName.c_str(),DestFile.c_str()) != 0)
1631 ErrorText = "Link to " + DestFile + " failure ";
1638 // AcqFile::Failed - Failure handler /*{{{*/
1639 // ---------------------------------------------------------------------
1640 /* Here we try other sources */
1641 void pkgAcqFile::Failed(string Message,pkgAcquire::MethodConfig *Cnf)
1643 ErrorText = LookupTag(Message,"Message");
1645 // This is the retry counter
1647 Cnf->LocalOnly == false &&
1648 StringToBool(LookupTag(Message,"Transient-Failure"),false) == true)
1655 Item::Failed(Message,Cnf);