apt-pkg/pkgcache.cc

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