]> git.saurik.com Git - apt.git/blame - apt-pkg/pkgcache.cc
Merge branch 'debian/sid' into debian/experimental
[apt.git] / apt-pkg / pkgcache.cc
CommitLineData
578bfd0a
AL
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
bac2e715 3// $Id: pkgcache.cc,v 1.37 2003/02/10 01:40:58 doogie Exp $
578bfd0a
AL
4/* ######################################################################
5
6 Package Cache - Accessor code for the cache
7
094a497d 8 Please see doc/apt-pkg/cache.sgml for a more detailed description of
578bfd0a
AL
9 this format. Also be sure to keep that file up-to-date!!
10
1e3f4083 11 This is the general utility functions for cache management. They provide
578bfd0a
AL
12 a complete set of accessor functions for the cache. The cacheiterators
13 header contains the STL-like iterators that can be used to easially
14 navigate the cache as well as seemlessly dereference the mmap'd
15 indexes. Use these always.
16
17 The main class provides for ways to get package indexes and some
18 general lookup functions to start the iterators.
19
20 ##################################################################### */
21 /*}}}*/
22// Include Files /*{{{*/
ea542140
DK
23#include<config.h>
24
094a497d 25#include <apt-pkg/pkgcache.h>
af29ffb4 26#include <apt-pkg/policy.h>
094a497d
AL
27#include <apt-pkg/version.h>
28#include <apt-pkg/error.h>
231fea14 29#include <apt-pkg/strutl.h>
b2e465d6 30#include <apt-pkg/configuration.h>
45df0ad2 31#include <apt-pkg/aptconfiguration.h>
453b82a3 32#include <apt-pkg/mmap.h>
5c0d3668 33#include <apt-pkg/macros.h>
578bfd0a 34
453b82a3
DK
35#include <stddef.h>
36#include <string.h>
37#include <ostream>
38#include <vector>
578bfd0a
AL
39#include <string>
40#include <sys/stat.h>
ea542140
DK
41
42#include <apti18n.h>
578bfd0a
AL
43 /*}}}*/
44
851a45a8
AL
45using std::string;
46
012b102a 47
578bfd0a
AL
48// Cache::Header::Header - Constructor /*{{{*/
49// ---------------------------------------------------------------------
50/* Simply initialize the header */
51pkgCache::Header::Header()
52{
53 Signature = 0x98FE76DC;
54
55 /* Whenever the structures change the major version should be bumped,
56 whenever the generator changes the minor version should be bumped. */
e8a7b0b2
DK
57 MajorVersion = 10;
58 MinorVersion = 0;
b2e465d6 59 Dirty = false;
578bfd0a
AL
60
61 HeaderSz = sizeof(pkgCache::Header);
52c41485 62 GroupSz = sizeof(pkgCache::Group);
578bfd0a
AL
63 PackageSz = sizeof(pkgCache::Package);
64 PackageFileSz = sizeof(pkgCache::PackageFile);
65 VersionSz = sizeof(pkgCache::Version);
a52f938b 66 DescriptionSz = sizeof(pkgCache::Description);
578bfd0a
AL
67 DependencySz = sizeof(pkgCache::Dependency);
68 ProvidesSz = sizeof(pkgCache::Provides);
dcb79bae 69 VerFileSz = sizeof(pkgCache::VerFile);
a52f938b 70 DescFileSz = sizeof(pkgCache::DescFile);
dcb79bae 71
52c41485 72 GroupCount = 0;
578bfd0a
AL
73 PackageCount = 0;
74 VersionCount = 0;
a52f938b 75 DescriptionCount = 0;
578bfd0a
AL
76 DependsCount = 0;
77 PackageFileCount = 0;
a7e66b17 78 VerFileCount = 0;
a52f938b 79 DescFileCount = 0;
a7e66b17 80 ProvidesCount = 0;
ad00ae81 81 MaxVerFileSize = 0;
a52f938b 82 MaxDescFileSize = 0;
578bfd0a
AL
83
84 FileList = 0;
85 StringList = 0;
b2e465d6
AL
86 VerSysName = 0;
87 Architecture = 0;
e8a7b0b2 88 HashTableSize = _config->FindI("APT::Cache-HashTableSize", 10 * 1048);
578bfd0a 89 memset(Pools,0,sizeof(Pools));
0688ccd8
JAK
90
91 CacheFileSize = 0;
578bfd0a
AL
92}
93 /*}}}*/
94// Cache::Header::CheckSizes - Check if the two headers have same *sz /*{{{*/
95// ---------------------------------------------------------------------
96/* */
97bool pkgCache::Header::CheckSizes(Header &Against) const
98{
99 if (HeaderSz == Against.HeaderSz &&
52c41485 100 GroupSz == Against.GroupSz &&
578bfd0a
AL
101 PackageSz == Against.PackageSz &&
102 PackageFileSz == Against.PackageFileSz &&
103 VersionSz == Against.VersionSz &&
a52f938b 104 DescriptionSz == Against.DescriptionSz &&
dcb79bae
AL
105 DependencySz == Against.DependencySz &&
106 VerFileSz == Against.VerFileSz &&
a52f938b 107 DescFileSz == Against.DescFileSz &&
578bfd0a
AL
108 ProvidesSz == Against.ProvidesSz)
109 return true;
110 return false;
111}
112 /*}}}*/
113
114// Cache::pkgCache - Constructor /*{{{*/
115// ---------------------------------------------------------------------
116/* */
b2e465d6 117pkgCache::pkgCache(MMap *Map, bool DoMap) : Map(*Map)
578bfd0a 118{
4cbf323f
MV
119 // call getArchitectures() with cached=false to ensure that the
120 // architectures cache is re-evaulated. this is needed in cases
121 // when the APT::Architecture field changes between two cache creations
122 MultiArchEnabled = APT::Configuration::getArchitectures(false).size() > 1;
b2e465d6
AL
123 if (DoMap == true)
124 ReMap();
578bfd0a
AL
125}
126 /*}}}*/
127// Cache::ReMap - Reopen the cache file /*{{{*/
128// ---------------------------------------------------------------------
129/* If the file is already closed then this will open it open it. */
a9fe5928 130bool pkgCache::ReMap(bool const &Errorchecks)
578bfd0a
AL
131{
132 // Apply the typecasts.
133 HeaderP = (Header *)Map.Data();
5bf15716 134 GrpP = (Group *)Map.Data();
578bfd0a 135 PkgP = (Package *)Map.Data();
dcb79bae 136 VerFileP = (VerFile *)Map.Data();
a52f938b 137 DescFileP = (DescFile *)Map.Data();
578bfd0a
AL
138 PkgFileP = (PackageFile *)Map.Data();
139 VerP = (Version *)Map.Data();
a52f938b 140 DescP = (Description *)Map.Data();
578bfd0a
AL
141 ProvideP = (Provides *)Map.Data();
142 DepP = (Dependency *)Map.Data();
143 StringItemP = (StringItem *)Map.Data();
144 StrP = (char *)Map.Data();
145
a9fe5928
DK
146 if (Errorchecks == false)
147 return true;
148
b2e465d6
AL
149 if (Map.Size() == 0 || HeaderP == 0)
150 return _error->Error(_("Empty package cache"));
578bfd0a
AL
151
152 // Check the header
153 Header DefHeader;
154 if (HeaderP->Signature != DefHeader.Signature ||
155 HeaderP->Dirty == true)
b2e465d6 156 return _error->Error(_("The package cache file is corrupted"));
578bfd0a
AL
157
158 if (HeaderP->MajorVersion != DefHeader.MajorVersion ||
159 HeaderP->MinorVersion != DefHeader.MinorVersion ||
160 HeaderP->CheckSizes(DefHeader) == false)
b2e465d6
AL
161 return _error->Error(_("The package cache file is an incompatible version"));
162
7d79339f
JAK
163 if (Map.Size() < HeaderP->CacheFileSize)
164 return _error->Error(_("The package cache file is corrupted, it is too small"));
165
7a223b93
DK
166 if (HeaderP->VerSysName == 0 || HeaderP->Architecture == 0 || HeaderP->Architectures == 0)
167 return _error->Error(_("The package cache file is corrupted"));
168
b2e465d6 169 // Locate our VS..
7a223b93 170 if ((VS = pkgVersioningSystem::GetVS(StrP + HeaderP->VerSysName)) == 0)
db0db9fe 171 return _error->Error(_("This APT does not support the versioning system '%s'"),StrP + HeaderP->VerSysName);
b2e465d6 172
7a223b93
DK
173 // Check the architecture
174 std::vector<std::string> archs = APT::Configuration::getArchitectures();
175 std::vector<std::string>::const_iterator a = archs.begin();
176 std::string list = *a;
177 for (++a; a != archs.end(); ++a)
178 list.append(",").append(*a);
179 if (_config->Find("APT::Architecture") != StrP + HeaderP->Architecture ||
180 list != StrP + HeaderP->Architectures)
181 return _error->Error(_("The package cache was built for different architectures: %s vs %s"), StrP + HeaderP->Architectures, list.c_str());
182
578bfd0a
AL
183 return true;
184}
185 /*}}}*/
186// Cache::Hash - Hash a string /*{{{*/
187// ---------------------------------------------------------------------
188/* This is used to generate the hash entries for the HashTable. With my
189 package list from bo this function gets 94% table usage on a 512 item
190 table (480 used items) */
4ad8619b 191map_id_t pkgCache::sHash(const string &Str) const
578bfd0a
AL
192{
193 unsigned long Hash = 0;
f7f0d6c7 194 for (string::const_iterator I = Str.begin(); I != Str.end(); ++I)
aa0fe657 195 Hash = 41 * Hash + tolower_ascii(*I);
e8a7b0b2 196 return Hash % HeaderP->HashTableSize;
578bfd0a
AL
197}
198
4ad8619b 199map_id_t pkgCache::sHash(const char *Str) const
578bfd0a 200{
aa0fe657
DK
201 unsigned long Hash = tolower_ascii(*Str);
202 for (const char *I = Str + 1; *I != 0; ++I)
203 Hash = 41 * Hash + tolower_ascii(*I);
e8a7b0b2 204 return Hash % HeaderP->HashTableSize;
578bfd0a 205}
8d4c859d
DK
206 /*}}}*/
207// Cache::SingleArchFindPkg - Locate a package by name /*{{{*/
208// ---------------------------------------------------------------------
209/* Returns 0 on error, pointer to the package otherwise
210 The multiArch enabled methods will fallback to this one as it is (a bit)
211 faster for single arch environments and realworld is mostly singlearch… */
212pkgCache::PkgIterator pkgCache::SingleArchFindPkg(const string &Name)
213{
214 // Look at the hash bucket
e8a7b0b2 215 Package *Pkg = PkgP + HeaderP->PkgHashTable()[Hash(Name)];
b686f453 216 for (; Pkg != PkgP; Pkg = PkgP + Pkg->Next)
8d4c859d 217 {
aa0fe657
DK
218 if (unlikely(Pkg->Name == 0))
219 continue;
220
221 int const cmp = strcasecmp(Name.c_str(), StrP + Pkg->Name);
222 if (cmp == 0)
223 return PkgIterator(*this, Pkg);
224 else if (cmp < 0)
225 break;
8d4c859d
DK
226 }
227 return PkgIterator(*this,0);
228}
578bfd0a
AL
229 /*}}}*/
230// Cache::FindPkg - Locate a package by name /*{{{*/
231// ---------------------------------------------------------------------
232/* Returns 0 on error, pointer to the package otherwise */
25396fb0
DK
233pkgCache::PkgIterator pkgCache::FindPkg(const string &Name) {
234 size_t const found = Name.find(':');
235 if (found == string::npos)
254b8ebb
DK
236 {
237 if (MultiArchCache() == false)
238 return SingleArchFindPkg(Name);
239 else
240 return FindPkg(Name, "native");
241 }
4d174dc8 242 string const Arch = Name.substr(found+1);
eddc9dd0
DK
243 /* Beware: This is specialcased to handle pkg:any in dependencies as
244 these are linked to virtual pkg:any named packages with all archs.
245 If you want any arch from a given pkg, use FindPkg(pkg,arch) */
4d174dc8
DK
246 if (Arch == "any")
247 return FindPkg(Name, "any");
248 return FindPkg(Name.substr(0, found), Arch);
25396fb0
DK
249}
250 /*}}}*/
251// Cache::FindPkg - Locate a package by name /*{{{*/
252// ---------------------------------------------------------------------
253/* Returns 0 on error, pointer to the package otherwise */
8d4c859d 254pkgCache::PkgIterator pkgCache::FindPkg(const string &Name, string const &Arch) {
c919ad6e 255 if (MultiArchCache() == false && Arch != "none") {
61d15f91 256 if (Arch == "native" || Arch == "all" || Arch == "any" ||
959470da 257 Arch == NativeArch())
8d4c859d
DK
258 return SingleArchFindPkg(Name);
259 else
260 return PkgIterator(*this,0);
261 }
5bf15716
DK
262 /* We make a detour via the GrpIterator here as
263 on a multi-arch environment a group is easier to
264 find than a package (less entries in the buckets) */
265 pkgCache::GrpIterator Grp = FindGrp(Name);
266 if (Grp.end() == true)
267 return PkgIterator(*this,0);
268
269 return Grp.FindPkg(Arch);
270}
271 /*}}}*/
272// Cache::FindGrp - Locate a group by name /*{{{*/
273// ---------------------------------------------------------------------
274/* Returns End-Pointer on error, pointer to the group otherwise */
275pkgCache::GrpIterator pkgCache::FindGrp(const string &Name) {
276 if (unlikely(Name.empty() == true))
277 return GrpIterator(*this,0);
278
279 // Look at the hash bucket for the group
e8a7b0b2 280 Group *Grp = GrpP + HeaderP->GrpHashTable()[sHash(Name)];
5bf15716 281 for (; Grp != GrpP; Grp = GrpP + Grp->Next) {
aa0fe657
DK
282 if (unlikely(Grp->Name == 0))
283 continue;
284
285 int const cmp = strcasecmp(Name.c_str(), StrP + Grp->Name);
286 if (cmp == 0)
5bf15716 287 return GrpIterator(*this, Grp);
aa0fe657
DK
288 else if (cmp < 0)
289 break;
5bf15716
DK
290 }
291
292 return GrpIterator(*this,0);
578bfd0a
AL
293}
294 /*}}}*/
b2e465d6
AL
295// Cache::CompTypeDeb - Return a string describing the compare type /*{{{*/
296// ---------------------------------------------------------------------
297/* This returns a string representation of the dependency compare
298 type in the weird debian style.. */
299const char *pkgCache::CompTypeDeb(unsigned char Comp)
300{
69c2ecbd
DK
301 const char * const Ops[] = {"","<=",">=","<<",">>","=","!="};
302 if (unlikely((unsigned)(Comp & 0xF) >= sizeof(Ops)/sizeof(Ops[0])))
303 return "";
304 return Ops[Comp & 0xF];
b2e465d6
AL
305}
306 /*}}}*/
307// Cache::CompType - Return a string describing the compare type /*{{{*/
308// ---------------------------------------------------------------------
69c2ecbd 309/* This returns a string representation of the dependency compare
b2e465d6
AL
310 type */
311const char *pkgCache::CompType(unsigned char Comp)
312{
69c2ecbd
DK
313 const char * const Ops[] = {"","<=",">=","<",">","=","!="};
314 if (unlikely((unsigned)(Comp & 0xF) >= sizeof(Ops)/sizeof(Ops[0])))
315 return "";
316 return Ops[Comp & 0xF];
b2e465d6
AL
317}
318 /*}}}*/
319// Cache::DepType - Return a string describing the dep type /*{{{*/
320// ---------------------------------------------------------------------
321/* */
322const char *pkgCache::DepType(unsigned char Type)
323{
324 const char *Types[] = {"",_("Depends"),_("PreDepends"),_("Suggests"),
325 _("Recommends"),_("Conflicts"),_("Replaces"),
f8ae7e8b 326 _("Obsoletes"),_("Breaks"), _("Enhances")};
308c7d30 327 if (Type < sizeof(Types)/sizeof(*Types))
b2e465d6
AL
328 return Types[Type];
329 return "";
330}
331 /*}}}*/
0149949b
AL
332// Cache::Priority - Convert a priority value to a string /*{{{*/
333// ---------------------------------------------------------------------
334/* */
335const char *pkgCache::Priority(unsigned char Prio)
336{
b2e465d6
AL
337 const char *Mapping[] = {0,_("important"),_("required"),_("standard"),
338 _("optional"),_("extra")};
0149949b
AL
339 if (Prio < _count(Mapping))
340 return Mapping[Prio];
341 return 0;
342}
343 /*}}}*/
5bf15716
DK
344// GrpIterator::FindPkg - Locate a package by arch /*{{{*/
345// ---------------------------------------------------------------------
346/* Returns an End-Pointer on error, pointer to the package otherwise */
e841200b 347pkgCache::PkgIterator pkgCache::GrpIterator::FindPkg(string Arch) const {
5bf15716
DK
348 if (unlikely(IsGood() == false || S->FirstPackage == 0))
349 return PkgIterator(*Owner, 0);
350
60dcec6d
DK
351 /* If we accept any package we simply return the "first"
352 package in this group (the last one added). */
353 if (Arch == "any")
354 return PkgIterator(*Owner, Owner->PkgP + S->FirstPackage);
355
959470da 356 char const* const myArch = Owner->NativeArch();
5bf15716
DK
357 /* Most of the time the package for our native architecture is
358 the one we add at first to the cache, but this would be the
359 last one we check, so we do it now. */
566046f4 360 if (Arch == "native" || Arch == myArch || Arch == "all") {
5bf15716 361 pkgCache::Package *Pkg = Owner->PkgP + S->LastPackage;
959470da 362 if (strcasecmp(myArch, Owner->StrP + Pkg->Arch) == 0)
5bf15716 363 return PkgIterator(*Owner, Pkg);
959470da 364 Arch = myArch;
5bf15716
DK
365 }
366
5bf15716
DK
367 /* Iterate over the list to find the matching arch
368 unfortunately this list includes "package noise"
369 (= different packages with same calculated hash),
370 so we need to check the name also */
371 for (pkgCache::Package *Pkg = PackageList(); Pkg != Owner->PkgP;
b686f453 372 Pkg = Owner->PkgP + Pkg->Next) {
5bf15716
DK
373 if (S->Name == Pkg->Name &&
374 stringcasecmp(Arch, Owner->StrP + Pkg->Arch) == 0)
375 return PkgIterator(*Owner, Pkg);
376 if ((Owner->PkgP + S->LastPackage) == Pkg)
377 break;
378 }
379
bd2fb30a
DK
380 return PkgIterator(*Owner, 0);
381}
382 /*}}}*/
383// GrpIterator::FindPreferredPkg - Locate the "best" package /*{{{*/
384// ---------------------------------------------------------------------
385/* Returns an End-Pointer on error, pointer to the package otherwise */
3db58cf4 386pkgCache::PkgIterator pkgCache::GrpIterator::FindPreferredPkg(bool const &PreferNonVirtual) const {
bd2fb30a 387 pkgCache::PkgIterator Pkg = FindPkg("native");
3db58cf4 388 if (Pkg.end() == false && (PreferNonVirtual == false || Pkg->VersionList != 0))
bd2fb30a
DK
389 return Pkg;
390
391 std::vector<std::string> const archs = APT::Configuration::getArchitectures();
392 for (std::vector<std::string>::const_iterator a = archs.begin();
393 a != archs.end(); ++a) {
394 Pkg = FindPkg(*a);
3db58cf4 395 if (Pkg.end() == false && (PreferNonVirtual == false || Pkg->VersionList != 0))
bd2fb30a
DK
396 return Pkg;
397 }
c919ad6e
DK
398 // packages without an architecture
399 Pkg = FindPkg("none");
400 if (Pkg.end() == false && (PreferNonVirtual == false || Pkg->VersionList != 0))
401 return Pkg;
bd2fb30a 402
3db58cf4
DK
403 if (PreferNonVirtual == true)
404 return FindPreferredPkg(false);
5bf15716
DK
405 return PkgIterator(*Owner, 0);
406}
407 /*}}}*/
408// GrpIterator::NextPkg - Locate the next package in the group /*{{{*/
409// ---------------------------------------------------------------------
410/* Returns an End-Pointer on error, pointer to the package otherwise.
c408e01e
DK
411 We can't simply ++ to the next as the next package of the last will
412 be from a different group (with the same hash value) */
e841200b 413pkgCache::PkgIterator pkgCache::GrpIterator::NextPkg(pkgCache::PkgIterator const &LastPkg) const {
5bf15716
DK
414 if (unlikely(IsGood() == false || S->FirstPackage == 0 ||
415 LastPkg.end() == true))
416 return PkgIterator(*Owner, 0);
417
c408e01e
DK
418 if (S->LastPackage == LastPkg.Index())
419 return PkgIterator(*Owner, 0);
5bf15716 420
b686f453 421 return PkgIterator(*Owner, Owner->PkgP + LastPkg->Next);
5bf15716
DK
422}
423 /*}}}*/
25396fb0
DK
424// GrpIterator::operator ++ - Postfix incr /*{{{*/
425// ---------------------------------------------------------------------
426/* This will advance to the next logical group in the hash table. */
d3e8fbb3 427void pkgCache::GrpIterator::operator ++(int)
25396fb0
DK
428{
429 // Follow the current links
430 if (S != Owner->GrpP)
431 S = Owner->GrpP + S->Next;
432
433 // Follow the hash table
e8a7b0b2 434 while (S == Owner->GrpP && (HashIndex+1) < (signed)Owner->HeaderP->HashTableSize)
25396fb0
DK
435 {
436 HashIndex++;
e8a7b0b2 437 S = Owner->GrpP + Owner->HeaderP->GrpHashTable()[HashIndex];
25396fb0 438 }
d3e8fbb3 439}
f55a958f
AL
440 /*}}}*/
441// PkgIterator::operator ++ - Postfix incr /*{{{*/
578bfd0a
AL
442// ---------------------------------------------------------------------
443/* This will advance to the next logical package in the hash table. */
d3e8fbb3 444void pkgCache::PkgIterator::operator ++(int)
578bfd0a
AL
445{
446 // Follow the current links
773e2c1f 447 if (S != Owner->PkgP)
b686f453 448 S = Owner->PkgP + S->Next;
b2e465d6 449
578bfd0a 450 // Follow the hash table
e8a7b0b2 451 while (S == Owner->PkgP && (HashIndex+1) < (signed)Owner->HeaderP->HashTableSize)
578bfd0a
AL
452 {
453 HashIndex++;
e8a7b0b2 454 S = Owner->PkgP + Owner->HeaderP->PkgHashTable()[HashIndex];
578bfd0a 455 }
d3e8fbb3 456}
578bfd0a 457 /*}}}*/
578bfd0a
AL
458// PkgIterator::State - Check the State of the package /*{{{*/
459// ---------------------------------------------------------------------
460/* By this we mean if it is either cleanly installed or cleanly removed. */
461pkgCache::PkgIterator::OkState pkgCache::PkgIterator::State() const
d38b7b3d 462{
773e2c1f
DK
463 if (S->InstState == pkgCache::State::ReInstReq ||
464 S->InstState == pkgCache::State::HoldReInstReq)
c7c1b0f6
AL
465 return NeedsUnpack;
466
773e2c1f
DK
467 if (S->CurrentState == pkgCache::State::UnPacked ||
468 S->CurrentState == pkgCache::State::HalfConfigured)
c6aa14e4
MV
469 // we leave triggers alone complettely. dpkg deals with
470 // them in a hard-to-predict manner and if they get
471 // resolved by dpkg before apt run dpkg --configure on
472 // the TriggersPending package dpkg returns a error
09fab244 473 //Pkg->CurrentState == pkgCache::State::TriggersAwaited
c6aa14e4 474 //Pkg->CurrentState == pkgCache::State::TriggersPending)
578bfd0a
AL
475 return NeedsConfigure;
476
773e2c1f
DK
477 if (S->CurrentState == pkgCache::State::HalfInstalled ||
478 S->InstState != pkgCache::State::Ok)
578bfd0a
AL
479 return NeedsUnpack;
480
481 return NeedsNothing;
482}
483 /*}}}*/
af29ffb4
MV
484// PkgIterator::CandVersion - Returns the candidate version string /*{{{*/
485// ---------------------------------------------------------------------
486/* Return string representing of the candidate version. */
487const char *
d3e8fbb3 488pkgCache::PkgIterator::CandVersion() const
af29ffb4
MV
489{
490 //TargetVer is empty, so don't use it.
749eb4cf 491 VerIterator version = pkgPolicy(Owner).GetCandidateVer(*this);
af29ffb4
MV
492 if (version.IsGood())
493 return version.VerStr();
494 return 0;
d3e8fbb3 495}
af29ffb4
MV
496 /*}}}*/
497// PkgIterator::CurVersion - Returns the current version string /*{{{*/
498// ---------------------------------------------------------------------
499/* Return string representing of the current version. */
500const char *
d3e8fbb3 501pkgCache::PkgIterator::CurVersion() const
af29ffb4
MV
502{
503 VerIterator version = CurrentVer();
504 if (version.IsGood())
505 return CurrentVer().VerStr();
506 return 0;
d3e8fbb3 507}
af29ffb4
MV
508 /*}}}*/
509// ostream operator to handle string representation of a package /*{{{*/
510// ---------------------------------------------------------------------
511/* Output name < cur.rent.version -> candid.ate.version | new.est.version > (section)
1e3f4083 512 Note that the characters <|>() are all literal above. Versions will be omitted
af29ffb4
MV
513 if they provide no new information (e.g. there is no newer version than candidate)
514 If no version and/or section can be found "none" is used. */
515std::ostream&
8f3ba4e8 516operator<<(std::ostream& out, pkgCache::PkgIterator Pkg)
af29ffb4
MV
517{
518 if (Pkg.end() == true)
519 return out << "invalid package";
520
521 string current = string(Pkg.CurVersion() == 0 ? "none" : Pkg.CurVersion());
522 string candidate = string(Pkg.CandVersion() == 0 ? "none" : Pkg.CandVersion());
523 string newest = string(Pkg.VersionList().end() ? "none" : Pkg.VersionList().VerStr());
524
5dd4c8b8 525 out << Pkg.Name() << " [ " << Pkg.Arch() << " ] < " << current;
af29ffb4
MV
526 if (current != candidate)
527 out << " -> " << candidate;
528 if ( newest != "none" && candidate != newest)
529 out << " | " << newest;
7a669774
DK
530 if (Pkg->VersionList == 0)
531 out << " > ( none )";
532 else
533 out << " > ( " << string(Pkg.VersionList().Section()==0?"unknown":Pkg.VersionList().Section()) << " )";
af29ffb4
MV
534 return out;
535}
536 /*}}}*/
75ce2062
DK
537// PkgIterator::FullName - Returns Name and (maybe) Architecture /*{{{*/
538// ---------------------------------------------------------------------
539/* Returns a name:arch string */
540std::string pkgCache::PkgIterator::FullName(bool const &Pretty) const
541{
542 string fullname = Name();
543 if (Pretty == false ||
959470da
DK
544 (strcmp(Arch(), "all") != 0 &&
545 strcmp(Owner->NativeArch(), Arch()) != 0))
75ce2062
DK
546 return fullname.append(":").append(Arch());
547 return fullname;
548}
549 /*}}}*/
578bfd0a
AL
550// DepIterator::IsCritical - Returns true if the dep is important /*{{{*/
551// ---------------------------------------------------------------------
552/* Currently critical deps are defined as depends, predepends and
308c7d30 553 conflicts (including dpkg's Breaks fields). */
e841200b 554bool pkgCache::DepIterator::IsCritical() const
578bfd0a 555{
359e46db 556 if (IsNegative() == true ||
773e2c1f
DK
557 S->Type == pkgCache::Dep::Depends ||
558 S->Type == pkgCache::Dep::PreDepends)
578bfd0a
AL
559 return true;
560 return false;
561}
562 /*}}}*/
df77d8a5
DK
563// DepIterator::IsNegative - Returns true if the dep is a negative one /*{{{*/
564// ---------------------------------------------------------------------
565/* Some dependencies are positive like Depends and Recommends, others
566 are negative like Conflicts which can and should be handled differently */
567bool pkgCache::DepIterator::IsNegative() const
568{
569 return S->Type == Dep::DpkgBreaks ||
570 S->Type == Dep::Conflicts ||
571 S->Type == Dep::Obsoletes;
572}
573 /*}}}*/
578bfd0a
AL
574// DepIterator::SmartTargetPkg - Resolve dep target pointers w/provides /*{{{*/
575// ---------------------------------------------------------------------
576/* This intellegently looks at dep target packages and tries to figure
577 out which package should be used. This is needed to nicely handle
578 provide mapping. If the target package has no other providing packages
579 then it returned. Otherwise the providing list is looked at to
580 see if there is one one unique providing package if so it is returned.
581 Otherwise true is returned and the target package is set. The return
b2e465d6
AL
582 result indicates whether the node should be expandable
583
584 In Conjunction with the DepCache the value of Result may not be
585 super-good since the policy may have made it uninstallable. Using
586 AllTargets is better in this case. */
e841200b 587bool pkgCache::DepIterator::SmartTargetPkg(PkgIterator &Result) const
578bfd0a
AL
588{
589 Result = TargetPkg();
590
591 // No provides at all
592 if (Result->ProvidesList == 0)
593 return false;
594
595 // There is the Base package and the providing ones which is at least 2
596 if (Result->VersionList != 0)
597 return true;
598
599 /* We have to skip over indirect provisions of the package that
600 owns the dependency. For instance, if libc5-dev depends on the
601 virtual package libc-dev which is provided by libc5-dev and libc6-dev
602 we must ignore libc5-dev when considering the provides list. */
603 PrvIterator PStart = Result.ProvidesList();
f7f0d6c7 604 for (; PStart.end() != true && PStart.OwnerPkg() == ParentPkg(); ++PStart);
578bfd0a
AL
605
606 // Nothing but indirect self provides
607 if (PStart.end() == true)
608 return false;
609
610 // Check for single packages in the provides list
611 PrvIterator P = PStart;
f7f0d6c7 612 for (; P.end() != true; ++P)
578bfd0a
AL
613 {
614 // Skip over self provides
615 if (P.OwnerPkg() == ParentPkg())
616 continue;
617 if (PStart.OwnerPkg() != P.OwnerPkg())
618 break;
619 }
b2e465d6
AL
620
621 Result = PStart.OwnerPkg();
578bfd0a
AL
622
623 // Check for non dups
624 if (P.end() != true)
625 return true;
b2e465d6 626
578bfd0a
AL
627 return false;
628}
629 /*}}}*/
630// DepIterator::AllTargets - Returns the set of all possible targets /*{{{*/
631// ---------------------------------------------------------------------
b2e465d6 632/* This is a more useful version of TargetPkg() that follows versioned
578bfd0a 633 provides. It includes every possible package-version that could satisfy
fbfb2a7c
AL
634 the dependency. The last item in the list has a 0. The resulting pointer
635 must be delete [] 'd */
e841200b 636pkgCache::Version **pkgCache::DepIterator::AllTargets() const
578bfd0a
AL
637{
638 Version **Res = 0;
639 unsigned long Size =0;
640 while (1)
641 {
642 Version **End = Res;
643 PkgIterator DPkg = TargetPkg();
644
645 // Walk along the actual package providing versions
f7f0d6c7 646 for (VerIterator I = DPkg.VersionList(); I.end() == false; ++I)
578bfd0a 647 {
85434114 648 if (IsIgnorable(I.ParentPkg()) == true)
578bfd0a 649 continue;
887c6940 650 if (IsSatisfied(I) == false)
578bfd0a 651 continue;
85434114 652
578bfd0a
AL
653 Size++;
654 if (Res != 0)
655 *End++ = I;
656 }
657
658 // Follow all provides
f7f0d6c7 659 for (PrvIterator I = DPkg.ProvidesList(); I.end() == false; ++I)
578bfd0a 660 {
85434114 661 if (IsIgnorable(I) == true)
578bfd0a 662 continue;
887c6940 663 if (IsSatisfied(I) == false)
85434114 664 continue;
5f909b67 665
578bfd0a
AL
666 Size++;
667 if (Res != 0)
668 *End++ = I.OwnerVer();
669 }
670
671 // Do it again and write it into the array
672 if (Res == 0)
673 {
674 Res = new Version *[Size+1];
675 Size = 0;
676 }
677 else
678 {
679 *End = 0;
680 break;
681 }
682 }
683
684 return Res;
685}
686 /*}}}*/
43d017d6
AL
687// DepIterator::GlobOr - Compute an OR group /*{{{*/
688// ---------------------------------------------------------------------
689/* This Takes an iterator, iterates past the current dependency grouping
690 and returns Start and End so that so End is the final element
691 in the group, if End == Start then D is End++ and End is the
692 dependency D was pointing to. Use in loops to iterate sensibly. */
693void pkgCache::DepIterator::GlobOr(DepIterator &Start,DepIterator &End)
694{
695 // Compute a single dependency element (glob or)
696 Start = *this;
697 End = *this;
018f1533 698 for (bool LastOR = true; end() == false && LastOR == true;)
43d017d6 699 {
773e2c1f 700 LastOR = (S->CompareOp & pkgCache::Dep::Or) == pkgCache::Dep::Or;
018f1533 701 (*this)++;
43d017d6
AL
702 if (LastOR == true)
703 End = (*this);
704 }
705}
706 /*}}}*/
85434114
DK
707// DepIterator::IsIgnorable - should this packag/providr be ignored? /*{{{*/
708// ---------------------------------------------------------------------
709/* Deps like self-conflicts should be ignored as well as implicit conflicts
710 on virtual packages. */
65512241 711bool pkgCache::DepIterator::IsIgnorable(PkgIterator const &/*Pkg*/) const
85434114 712{
021626db
DK
713 if (IsNegative() == false)
714 return false;
715
716 pkgCache::PkgIterator PP = ParentPkg();
717 pkgCache::PkgIterator PT = TargetPkg();
718 if (PP->Group != PT->Group)
719 return false;
720 // self-conflict
721 if (PP == PT)
722 return true;
723 pkgCache::VerIterator PV = ParentVer();
724 // ignore group-conflict on a M-A:same package - but not our implicit dependencies
725 // so that we can have M-A:same packages conflicting with their own real name
726 if ((PV->MultiArch & pkgCache::Version::Same) == pkgCache::Version::Same)
727 {
728 // Replaces: ${self}:other ( << ${binary:Version})
729 if (S->Type == pkgCache::Dep::Replaces && S->CompareOp == pkgCache::Dep::Less && strcmp(PV.VerStr(), TargetVer()) == 0)
730 return false;
731 // Breaks: ${self}:other (!= ${binary:Version})
732 if (S->Type == pkgCache::Dep::DpkgBreaks && S->CompareOp == pkgCache::Dep::NotEquals && strcmp(PV.VerStr(), TargetVer()) == 0)
733 return false;
734 return true;
735 }
85434114
DK
736
737 return false;
738}
739bool pkgCache::DepIterator::IsIgnorable(PrvIterator const &Prv) const
740{
741 if (IsNegative() == false)
742 return false;
743
744 PkgIterator const Pkg = ParentPkg();
745 /* Provides may never be applied against the same package (or group)
746 if it is a conflicts. See the comment above. */
747 if (Prv.OwnerPkg()->Group == Pkg->Group)
748 return true;
749 // Implicit group-conflicts should not be applied on providers of other groups
750 if (Pkg->Group == TargetPkg()->Group && Prv.OwnerPkg()->Group != Pkg->Group)
751 return true;
752
753 return false;
754}
755 /*}}}*/
d5648746
DK
756// DepIterator::IsMultiArchImplicit - added by the cache generation /*{{{*/
757// ---------------------------------------------------------------------
758/* MultiArch can be translated to SingleArch for an resolver and we did so,
759 by adding dependencies to help the resolver understand the problem, but
760 sometimes it is needed to identify these to ignore them… */
761bool pkgCache::DepIterator::IsMultiArchImplicit() const
762{
0f485ee5
TG
763 if (ParentPkg()->Arch != TargetPkg()->Arch &&
764 (S->Type == pkgCache::Dep::Replaces ||
765 S->Type == pkgCache::Dep::DpkgBreaks ||
766 S->Type == pkgCache::Dep::Conflicts))
d5648746
DK
767 return true;
768 return false;
769}
770 /*}}}*/
887c6940
DK
771// DepIterator::IsSatisfied - check if a version satisfied the dependency /*{{{*/
772bool pkgCache::DepIterator::IsSatisfied(VerIterator const &Ver) const
773{
774 return Owner->VS->CheckDep(Ver.VerStr(),S->CompareOp,TargetVer());
775}
776bool pkgCache::DepIterator::IsSatisfied(PrvIterator const &Prv) const
777{
778 return Owner->VS->CheckDep(Prv.ProvideVersion(),S->CompareOp,TargetVer());
779}
780 /*}}}*/
47f6d1b7
DK
781// ostream operator to handle string representation of a dependecy /*{{{*/
782// ---------------------------------------------------------------------
783/* */
8f3ba4e8 784std::ostream& operator<<(std::ostream& out, pkgCache::DepIterator D)
47f6d1b7
DK
785{
786 if (D.end() == true)
787 return out << "invalid dependency";
788
789 pkgCache::PkgIterator P = D.ParentPkg();
790 pkgCache::PkgIterator T = D.TargetPkg();
791
792 out << (P.end() ? "invalid pkg" : P.FullName(false)) << " " << D.DepType()
793 << " on ";
794 if (T.end() == true)
795 out << "invalid pkg";
796 else
797 out << T;
798
799 if (D->Version != 0)
800 out << " (" << D.CompType() << " " << D.TargetVer() << ")";
801
802 return out;
803}
804 /*}}}*/
578bfd0a
AL
805// VerIterator::CompareVer - Fast version compare for same pkgs /*{{{*/
806// ---------------------------------------------------------------------
807/* This just looks over the version list to see if B is listed before A. In
808 most cases this will return in under 4 checks, ver lists are short. */
809int pkgCache::VerIterator::CompareVer(const VerIterator &B) const
810{
811 // Check if they are equal
812 if (*this == B)
813 return 0;
814 if (end() == true)
815 return -1;
816 if (B.end() == true)
817 return 1;
818
819 /* Start at A and look for B. If B is found then A > B otherwise
820 B was before A so A < B */
821 VerIterator I = *this;
f7f0d6c7 822 for (;I.end() == false; ++I)
578bfd0a
AL
823 if (I == B)
824 return 1;
825 return -1;
826}
827 /*}}}*/
b518cca6
AL
828// VerIterator::Downloadable - Checks if the version is downloadable /*{{{*/
829// ---------------------------------------------------------------------
830/* */
0e6fe58e 831APT_PURE bool pkgCache::VerIterator::Downloadable() const
b518cca6
AL
832{
833 VerFileIterator Files = FileList();
f7f0d6c7 834 for (; Files.end() == false; ++Files)
f07b5628 835 if ((Files.File()->Flags & pkgCache::Flag::NotSource) != pkgCache::Flag::NotSource)
b518cca6
AL
836 return true;
837 return false;
838}
839 /*}}}*/
3c124dde
AL
840// VerIterator::Automatic - Check if this version is 'automatic' /*{{{*/
841// ---------------------------------------------------------------------
842/* This checks to see if any of the versions files are not NotAutomatic.
843 True if this version is selectable for automatic installation. */
0e6fe58e 844APT_PURE bool pkgCache::VerIterator::Automatic() const
3c124dde
AL
845{
846 VerFileIterator Files = FileList();
f7f0d6c7 847 for (; Files.end() == false; ++Files)
5ed56f93 848 // Do not check ButAutomaticUpgrades here as it is kind of automatic…
3c124dde
AL
849 if ((Files.File()->Flags & pkgCache::Flag::NotAutomatic) != pkgCache::Flag::NotAutomatic)
850 return true;
851 return false;
852}
853 /*}}}*/
854// VerIterator::NewestFile - Return the newest file version relation /*{{{*/
855// ---------------------------------------------------------------------
856/* This looks at the version numbers associated with all of the sources
857 this version is in and returns the highest.*/
858pkgCache::VerFileIterator pkgCache::VerIterator::NewestFile() const
859{
860 VerFileIterator Files = FileList();
861 VerFileIterator Highest = Files;
f7f0d6c7 862 for (; Files.end() == false; ++Files)
3c124dde 863 {
b2e465d6 864 if (Owner->VS->CmpReleaseVer(Files.File().Version(),Highest.File().Version()) > 0)
3c124dde
AL
865 Highest = Files;
866 }
867
868 return Highest;
869}
870 /*}}}*/
b2e465d6
AL
871// VerIterator::RelStr - Release description string /*{{{*/
872// ---------------------------------------------------------------------
873/* This describes the version from a release-centric manner. The output is a
874 list of Label:Version/Archive */
d4489d49 875string pkgCache::VerIterator::RelStr() const
b2e465d6
AL
876{
877 bool First = true;
878 string Res;
f7f0d6c7 879 for (pkgCache::VerFileIterator I = this->FileList(); I.end() == false; ++I)
b2e465d6
AL
880 {
881 // Do not print 'not source' entries'
882 pkgCache::PkgFileIterator File = I.File();
883 if ((File->Flags & pkgCache::Flag::NotSource) == pkgCache::Flag::NotSource)
884 continue;
885
886 // See if we have already printed this out..
887 bool Seen = false;
f7f0d6c7 888 for (pkgCache::VerFileIterator J = this->FileList(); I != J; ++J)
b2e465d6
AL
889 {
890 pkgCache::PkgFileIterator File2 = J.File();
891 if (File2->Label == 0 || File->Label == 0)
892 continue;
893
894 if (strcmp(File.Label(),File2.Label()) != 0)
895 continue;
896
897 if (File2->Version == File->Version)
898 {
899 Seen = true;
900 break;
901 }
10639577 902 if (File2->Version == 0 || File->Version == 0)
b2e465d6
AL
903 break;
904 if (strcmp(File.Version(),File2.Version()) == 0)
905 Seen = true;
906 }
907
908 if (Seen == true)
909 continue;
910
911 if (First == false)
912 Res += ", ";
913 else
914 First = false;
915
916 if (File->Label != 0)
917 Res = Res + File.Label() + ':';
918
919 if (File->Archive != 0)
920 {
921 if (File->Version == 0)
922 Res += File.Archive();
923 else
924 Res = Res + File.Version() + '/' + File.Archive();
925 }
926 else
927 {
928 // No release file, print the host name that this came from
929 if (File->Site == 0 || File.Site()[0] == 0)
930 Res += "localhost";
931 else
932 Res += File.Site();
933 }
5dd4c8b8 934 }
857e9c13 935 if (S->ParentPkg != 0)
5dd4c8b8 936 Res.append(" [").append(Arch()).append("]");
b2e465d6
AL
937 return Res;
938}
939 /*}}}*/
7a948ec7
DK
940// VerIterator::MultiArchType - string representing MultiArch flag /*{{{*/
941const char * pkgCache::VerIterator::MultiArchType() const
942{
943 if ((S->MultiArch & pkgCache::Version::Same) == pkgCache::Version::Same)
944 return "same";
945 else if ((S->MultiArch & pkgCache::Version::Foreign) == pkgCache::Version::Foreign)
946 return "foreign";
947 else if ((S->MultiArch & pkgCache::Version::Allowed) == pkgCache::Version::Allowed)
948 return "allowed";
949 return "none";
950}
951 /*}}}*/
578bfd0a
AL
952// PkgFileIterator::IsOk - Checks if the cache is in sync with the file /*{{{*/
953// ---------------------------------------------------------------------
954/* This stats the file and compares its stats with the ones that were
955 stored during generation. Date checks should probably also be
956 included here. */
957bool pkgCache::PkgFileIterator::IsOk()
958{
959 struct stat Buf;
960 if (stat(FileName(),&Buf) != 0)
961 return false;
962
773e2c1f 963 if (Buf.st_size != (signed)S->Size || Buf.st_mtime != S->mtime)
578bfd0a
AL
964 return false;
965
966 return true;
967}
968 /*}}}*/
af87ab54
AL
969// PkgFileIterator::RelStr - Return the release string /*{{{*/
970// ---------------------------------------------------------------------
971/* */
972string pkgCache::PkgFileIterator::RelStr()
973{
974 string Res;
975 if (Version() != 0)
976 Res = Res + (Res.empty() == true?"v=":",v=") + Version();
977 if (Origin() != 0)
978 Res = Res + (Res.empty() == true?"o=":",o=") + Origin();
979 if (Archive() != 0)
980 Res = Res + (Res.empty() == true?"a=":",a=") + Archive();
efc487fb
DK
981 if (Codename() != 0)
982 Res = Res + (Res.empty() == true?"n=":",n=") + Codename();
af87ab54
AL
983 if (Label() != 0)
984 Res = Res + (Res.empty() == true?"l=":",l=") + Label();
985 if (Component() != 0)
986 Res = Res + (Res.empty() == true?"c=":",c=") + Component();
5dd4c8b8
DK
987 if (Architecture() != 0)
988 Res = Res + (Res.empty() == true?"b=":",b=") + Architecture();
af87ab54
AL
989 return Res;
990}
991 /*}}}*/
012b102a
MV
992// VerIterator::TranslatedDescription - Return the a DescIter for locale/*{{{*/
993// ---------------------------------------------------------------------
d3e8fbb3 994/* return a DescIter for the current locale or the default if none is
012b102a
MV
995 * found
996 */
997pkgCache::DescIterator pkgCache::VerIterator::TranslatedDescription() const
998{
45df0ad2
DK
999 std::vector<string> const lang = APT::Configuration::getLanguages();
1000 for (std::vector<string>::const_iterator l = lang.begin();
f7f0d6c7 1001 l != lang.end(); ++l)
45df0ad2 1002 {
4b625b95
DK
1003 pkgCache::DescIterator Desc = DescriptionList();
1004 for (; Desc.end() == false; ++Desc)
0e7c3313 1005 if (*l == Desc.LanguageCode())
45df0ad2 1006 break;
4b625b95 1007 if (Desc.end() == true)
0e7c3313
DK
1008 {
1009 if (*l == "en")
1010 {
1011 Desc = DescriptionList();
1012 for (; Desc.end() == false; ++Desc)
1013 if (strcmp(Desc.LanguageCode(), "") == 0)
1014 break;
1015 if (Desc.end() == true)
1016 continue;
1017 }
1018 else
1019 continue;
1020 }
45df0ad2
DK
1021 return Desc;
1022 }
4b625b95
DK
1023 for (pkgCache::DescIterator Desc = DescriptionList();
1024 Desc.end() == false; ++Desc)
1025 if (strcmp(Desc.LanguageCode(), "") == 0)
1026 return Desc;
45df0ad2 1027 return DescriptionList();
d3e8fbb3 1028}
012b102a
MV
1029
1030 /*}}}*/
d5648746
DK
1031// PrvIterator::IsMultiArchImplicit - added by the cache generation /*{{{*/
1032// ---------------------------------------------------------------------
1033/* MultiArch can be translated to SingleArch for an resolver and we did so,
1034 by adding provides to help the resolver understand the problem, but
1035 sometimes it is needed to identify these to ignore them… */
1036bool pkgCache::PrvIterator::IsMultiArchImplicit() const
1037{
1038 pkgCache::PkgIterator const Owner = OwnerPkg();
1039 pkgCache::PkgIterator const Parent = ParentPkg();
ef5dc12c 1040 if (strcmp(Owner.Arch(), Parent.Arch()) != 0 || Owner->Name == Parent->Name)
d5648746
DK
1041 return true;
1042 return false;
1043}
1044 /*}}}*/
7a669774
DK
1045APT_DEPRECATED APT_PURE const char * pkgCache::PkgIterator::Section() const {/*{{{*/
1046 if (S->VersionList == 0)
1047 return 0;
1048 return VersionList().Section();
1049}
1050 /*}}}*/