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