[apt.git] / apt-pkg / policy.cc

// -*- mode: cpp; mode: fold -*-
// Description								/*{{{*/
// $Id: policy.cc,v 1.10 2003/08/12 00:17:37 mdz Exp $
/* ######################################################################

   Package Version Policy implementation

   This is just a really simple wrapper around pkgVersionMatch with
   some added goodies to manage the list of things..

   See man apt_preferences for what value means what.

   ##################################################################### */
									/*}}}*/
// Include Files							/*{{{*/
#include<config.h>

#include <apt-pkg/policy.h>
#include <apt-pkg/configuration.h>
#include <apt-pkg/cachefilter.h>
#include <apt-pkg/tagfile.h>
#include <apt-pkg/strutl.h>
#include <apt-pkg/fileutl.h>
#include <apt-pkg/error.h>
#include <apt-pkg/cacheiterators.h>
#include <apt-pkg/pkgcache.h>
#include <apt-pkg/versionmatch.h>
#include <apt-pkg/version.h>

#include <ctype.h>
#include <stddef.h>
#include <string.h>
#include <string>
#include <vector>
#include <iostream>
#include <sstream>

#include <apti18n.h>
									/*}}}*/

using namespace std;

// Policy::Init - Startup and bind to a cache				/*{{{*/
// ---------------------------------------------------------------------
/* Set the defaults for operation. The default mode with no loaded policy
   file matches the V0 policy engine. */
pkgPolicy::pkgPolicy(pkgCache *Owner) : Pins(nullptr), VerPins(nullptr),
   PFPriority(nullptr), Cache(Owner), d(NULL)
{
   if (Owner == 0)
      return;
   PFPriority = new signed short[Owner->Head().PackageFileCount];
   Pins = new Pin[Owner->Head().PackageCount];
   VerPins = new Pin[Owner->Head().VersionCount];

   for (unsigned long I = 0; I != Owner->Head().PackageCount; I++)
      Pins[I].Type = pkgVersionMatch::None;
   for (unsigned long I = 0; I != Owner->Head().VersionCount; I++)
      VerPins[I].Type = pkgVersionMatch::None;

   // The config file has a master override.
   string DefRel = _config->Find("APT::Default-Release");
   if (DefRel.empty() == false)
   {
      bool found = false;
      // FIXME: make ExpressionMatches static to use it here easily
      pkgVersionMatch vm("", pkgVersionMatch::None);
      for (pkgCache::PkgFileIterator F = Cache->FileBegin(); F != Cache->FileEnd(); ++F)
      {
	 if (vm.ExpressionMatches(DefRel, F.Archive()) ||
	     vm.ExpressionMatches(DefRel, F.Codename()) ||
	     vm.ExpressionMatches(DefRel, F.Version()) ||
	     (DefRel.length() > 2 && DefRel[1] == '='))
	    found = true;
      }
      if (found == false)
	 _error->Error(_("The value '%s' is invalid for APT::Default-Release as such a release is not available in the sources"), DefRel.c_str());
      else
	 CreatePin(pkgVersionMatch::Release,"",DefRel,990);
   }
   InitDefaults();
}
									/*}}}*/
// Policy::InitDefaults - Compute the default selections		/*{{{*/
// ---------------------------------------------------------------------
/* */
bool pkgPolicy::InitDefaults()
{   
   // Initialize the priorities based on the status of the package file
   for (pkgCache::PkgFileIterator I = Cache->FileBegin(); I != Cache->FileEnd(); ++I)
   {
      PFPriority[I->ID] = 500;
      if (I.Flagged(pkgCache::Flag::NotSource))
	 PFPriority[I->ID] = 100;
      else if (I.Flagged(pkgCache::Flag::ButAutomaticUpgrades))
	 PFPriority[I->ID] = 100;
      else if (I.Flagged(pkgCache::Flag::NotAutomatic))
	 PFPriority[I->ID] = 1;
   }

   // Apply the defaults..
   std::unique_ptr<bool[]> Fixed(new bool[Cache->HeaderP->PackageFileCount]);
   memset(Fixed.get(),0,sizeof(Fixed[0])*Cache->HeaderP->PackageFileCount);
   StatusOverride = false;
   for (vector<Pin>::const_iterator I = Defaults.begin(); I != Defaults.end(); ++I)
   {
      pkgVersionMatch Match(I->Data,I->Type);
      for (pkgCache::PkgFileIterator F = Cache->FileBegin(); F != Cache->FileEnd(); ++F)
      {
	 if (Fixed[F->ID] == false && Match.FileMatch(F) == true)
	 {
	    PFPriority[F->ID] = I->Priority;

	    if (PFPriority[F->ID] >= 1000)
	       StatusOverride = true;

	    Fixed[F->ID] = true;
	 }
      }
   }

   if (_config->FindB("Debug::pkgPolicy",false) == true)
      for (pkgCache::PkgFileIterator F = Cache->FileBegin(); F != Cache->FileEnd(); ++F)
	 std::clog << "Prio of " << F.FileName() << ' ' << PFPriority[F->ID] << std::endl;

   return true;
}
									/*}}}*/
// Policy::GetCandidateVer - Get the candidate install version		/*{{{*/
// ---------------------------------------------------------------------
/* Evaluate the package pins and the default list to deteremine what the
   best package is. */
pkgCache::VerIterator pkgPolicy::GetCandidateVer(pkgCache::PkgIterator const &Pkg)
{
   if (_config->FindI("APT::Policy", 1) >= 1) {
      return GetCandidateVerNew(Pkg);
   }

   // Look for a package pin and evaluate it.
   signed Max = GetPriority(Pkg);
   pkgCache::VerIterator Pref = GetMatch(Pkg);

   // Alternatives in case we can not find our package pin (Bug#512318).
   signed MaxAlt = 0;
   pkgCache::VerIterator PrefAlt;

   // no package = no candidate version
   if (Pkg.end() == true)
      return Pref;

   // packages with a pin lower than 0 have no newer candidate than the current version
   if (Max < 0)
      return Pkg.CurrentVer();

   /* Falling through to the default version.. Setting Max to zero
      effectively excludes everything <= 0 which are the non-automatic
      priorities.. The status file is given a prio of 100 which will exclude
      not-automatic sources, except in a single shot not-installed mode.

      The user pin is subject to the same priority rules as default 
      selections. Thus there are two ways to create a pin - a pin that
      tracks the default when the default is taken away, and a permanent
      pin that stays at that setting.
    */
   bool PrefSeen = false;
   for (pkgCache::VerIterator Ver = Pkg.VersionList(); Ver.end() == false; ++Ver)
   {
      /* Lets see if this version is the installed version */
      bool instVer = (Pkg.CurrentVer() == Ver);

      if (Pref == Ver)
	 PrefSeen = true;

      for (pkgCache::VerFileIterator VF = Ver.FileList(); VF.end() == false; ++VF)
      {
	 /* If this is the status file, and the current version is not the
	    version in the status file (ie it is not installed, or somesuch)
	    then it is not a candidate for installation, ever. This weeds
	    out bogus entries that may be due to config-file states, or
	    other. */
	 if (VF.File().Flagged(pkgCache::Flag::NotSource) && instVer == false)
	    continue;

	 signed Prio = PFPriority[VF.File()->ID];
	 if (Prio > Max)
	 {
	    Pref = Ver;
	    Max = Prio;
	    PrefSeen = true;
	 }
	 if (Prio > MaxAlt)
	 {
	    PrefAlt = Ver;
	    MaxAlt = Prio;
	 }
      }

      if (instVer == true && Max < 1000)
      {
	 /* Not having seen the Pref yet means we have a specific pin below 1000
	    on a version below the current installed one, so ignore the specific pin
	    as this would be a downgrade otherwise */
	 if (PrefSeen == false || Pref.end() == true)
	 {
	    Pref = Ver;
	    PrefSeen = true;
	 }
	 /* Elevate our current selection (or the status file itself) so that only
	    a downgrade can override it from now on */
	 Max = 999;

	 // Fast path optimize.
	 if (StatusOverride == false)
	    break;
      }
   }
   // If we do not find our candidate, use the one with the highest pin.
   // This means that if there is a version available with pin > 0; there
   // will always be a candidate (Closes: #512318)
   if (!Pref.IsGood() && MaxAlt > 0)
       Pref = PrefAlt;

   return Pref;
}

// Policy::GetCandidateVer - Get the candidate install version		/*{{{*/
// ---------------------------------------------------------------------
/* Evaluate the package pins and the default list to deteremine what the
   best package is. */
pkgCache::VerIterator pkgPolicy::GetCandidateVerNew(pkgCache::PkgIterator const &Pkg)
{
   // TODO: Replace GetCandidateVer()
   pkgCache::VerIterator cand;
   pkgCache::VerIterator cur = Pkg.CurrentVer();
   int candPriority = -1;
   pkgVersioningSystem *vs = Cache->VS;

   for (pkgCache::VerIterator ver = Pkg.VersionList(); ver.end() == false; ver++) {
      int priority = GetPriority(ver, true);

      if (priority == 0 || priority <= candPriority)
	 continue;

      // TODO: Maybe optimize to not compare versions
      if (!cur.end() && priority < 1000
	  && (vs->CmpVersion(ver.VerStr(), cur.VerStr()) < 0))
	 continue;

      candPriority = priority;
      cand = ver;
   }

   return cand;
}
									/*}}}*/
// Policy::CreatePin - Create an entry in the pin table..		/*{{{*/
// ---------------------------------------------------------------------
/* For performance we have 3 tables, the default table, the main cache
   table (hashed to the cache). A blank package name indicates the pin
   belongs to the default table. Order of insertion matters here, the
   earlier defaults override later ones. */
void pkgPolicy::CreatePin(pkgVersionMatch::MatchType Type,string Name,
			  string Data,signed short Priority)
{
   if (Name.empty() == true)
   {
      Pin *P = &*Defaults.insert(Defaults.end(),Pin());
      P->Type = Type;
      P->Priority = Priority;
      P->Data = Data;
      return;
   }

   size_t found = Name.rfind(':');
   string Arch;
   if (found != string::npos) {
      Arch = Name.substr(found+1);
      Name.erase(found);
   }

   // Allow pinning by wildcards
   // TODO: Maybe we should always prefer specific pins over non-
   // specific ones.
   if (Name[0] == '/' || Name.find_first_of("*[?") != string::npos)
   {
      pkgVersionMatch match(Data, Type);
      for (pkgCache::GrpIterator G = Cache->GrpBegin(); G.end() != true; ++G)
	 if (match.ExpressionMatches(Name, G.Name()))
	 {
	    if (Arch.empty() == false)
	       CreatePin(Type, string(G.Name()).append(":").append(Arch), Data, Priority);
	    else
	       CreatePin(Type, G.Name(), Data, Priority);
	 }
      return;
   }

   // find the package (group) this pin applies to
   pkgCache::GrpIterator Grp = Cache->FindGrp(Name);
   bool matched = false;
   if (Grp.end() == false)
   {
      std::string MatchingArch;
      if (Arch.empty() == true)
	 MatchingArch = Cache->NativeArch();
      else
	 MatchingArch = Arch;
      APT::CacheFilter::PackageArchitectureMatchesSpecification pams(MatchingArch);
      for (pkgCache::PkgIterator Pkg = Grp.PackageList(); Pkg.end() != true; Pkg = Grp.NextPkg(Pkg))
      {
	 if (pams(Pkg.Arch()) == false)
	    continue;
	 Pin *P = Pins + Pkg->ID;
	 // the first specific stanza for a package is the ruler,
	 // all others need to be ignored
	 if (P->Type != pkgVersionMatch::None)
	    P = &*Unmatched.insert(Unmatched.end(),PkgPin(Pkg.FullName()));
	 P->Type = Type;
	 P->Priority = Priority;
	 P->Data = Data;
	 matched = true;

	 // Find matching version(s) and copy the pin into it
	 pkgVersionMatch Match(P->Data,P->Type);
	 for (pkgCache::VerIterator Ver = Pkg.VersionList(); Ver.end() != true; Ver++)
	 {
	    if (Match.VersionMatches(Ver)) {
	       Pin *VP = VerPins + Ver->ID;
	       if (VP->Type == pkgVersionMatch::None)
		  *VP = *P;
	    }
	 }
      }
   }

   if (matched == false)
   {
      PkgPin *P = &*Unmatched.insert(Unmatched.end(),PkgPin(Name));
      if (Arch.empty() == false)
	 P->Pkg.append(":").append(Arch);
      P->Type = Type;
      P->Priority = Priority;
      P->Data = Data;
      return;
   }
}
									/*}}}*/
// Policy::GetMatch - Get the matching version for a package pin	/*{{{*/
// ---------------------------------------------------------------------
/* */
pkgCache::VerIterator pkgPolicy::GetMatch(pkgCache::PkgIterator const &Pkg)
{
   const Pin &PPkg = Pins[Pkg->ID];
   if (PPkg.Type == pkgVersionMatch::None)
      return pkgCache::VerIterator(*Pkg.Cache());

   pkgVersionMatch Match(PPkg.Data,PPkg.Type);
   return Match.Find(Pkg);
}
									/*}}}*/
// Policy::GetPriority - Get the priority of the package pin		/*{{{*/
// ---------------------------------------------------------------------
/* */
APT_PURE signed short pkgPolicy::GetPriority(pkgCache::PkgIterator const &Pkg)
{
   if (Pins[Pkg->ID].Type != pkgVersionMatch::None)
      return Pins[Pkg->ID].Priority;
   return 0;
}
APT_PURE signed short pkgPolicy::GetPriority(pkgCache::VerIterator const &Ver, bool ConsiderFiles)
{
   if (VerPins[Ver->ID].Type != pkgVersionMatch::None)
      return VerPins[Ver->ID].Priority;
   if (!ConsiderFiles)
      return 0;

   int priority = std::numeric_limits<int>::min();
   for (pkgCache::VerFileIterator file = Ver.FileList(); file.end() == false; file++)
   {
      /* If this is the status file, and the current version is not the
         version in the status file (ie it is not installed, or somesuch)
         then it is not a candidate for installation, ever. This weeds
         out bogus entries that may be due to config-file states, or
         other. */
      if (file.File().Flagged(pkgCache::Flag::NotSource) && Ver.ParentPkg().CurrentVer() != Ver) {
	 // Ignore
      } else if (GetPriority(file.File()) > priority) {
	 priority = GetPriority(file.File());
      }
   }

   return priority == std::numeric_limits<int>::min() ? 0 : priority;
}
APT_PURE signed short pkgPolicy::GetPriority(pkgCache::PkgFileIterator const &File)
{
   return PFPriority[File->ID];
}
									/*}}}*/
// ReadPinDir - Load the pin files from this dir into a Policy		/*{{{*/
// ---------------------------------------------------------------------
/* This will load each pin file in the given dir into a Policy. If the
   given dir is empty the dir set in Dir::Etc::PreferencesParts is used.
   Note also that this method will issue a warning if the dir does not
   exists but it will return true in this case! */
bool ReadPinDir(pkgPolicy &Plcy,string Dir)
{
   if (Dir.empty() == true)
      Dir = _config->FindDir("Dir::Etc::PreferencesParts");

   if (DirectoryExists(Dir) == false)
   {
      _error->WarningE("DirectoryExists",_("Unable to read %s"),Dir.c_str());
      return true;
   }

   vector<string> const List = GetListOfFilesInDir(Dir, "pref", true, true);

   // Read the files
   for (vector<string>::const_iterator I = List.begin(); I != List.end(); ++I)
      if (ReadPinFile(Plcy, *I) == false)
	 return false;
   return true;
}
									/*}}}*/
// ReadPinFile - Load the pin file into a Policy			/*{{{*/
// ---------------------------------------------------------------------
/* I'd like to see the preferences file store more than just pin information
   but right now that is the only stuff I have to store. Later there will
   have to be some kind of combined super parser to get the data into all
   the right classes.. */
bool ReadPinFile(pkgPolicy &Plcy,string File)
{
   if (File.empty() == true)
      File = _config->FindFile("Dir::Etc::Preferences");

   if (RealFileExists(File) == false)
      return true;
   
   FileFd Fd(File,FileFd::ReadOnly);
   pkgTagFile TF(&Fd);
   if (_error->PendingError() == true)
      return false;

   pkgUserTagSection Tags;
   while (TF.Step(Tags) == true)
   {
      // can happen when there are only comments in a record
      if (Tags.Count() == 0)
         continue;

      string Name = Tags.FindS("Package");
      if (Name.empty() == true)
	 return _error->Error(_("Invalid record in the preferences file %s, no Package header"), File.c_str());
      if (Name == "*")
	 Name = string();
      
      const char *Start;
      const char *End;
      if (Tags.Find("Pin",Start,End) == false)
	 continue;
	 
      const char *Word = Start;
      for (; Word != End && isspace(*Word) == 0; Word++);

      // Parse the type..
      pkgVersionMatch::MatchType Type;
      if (stringcasecmp(Start,Word,"version") == 0 && Name.empty() == false)
	 Type = pkgVersionMatch::Version;
      else if (stringcasecmp(Start,Word,"release") == 0)
	 Type = pkgVersionMatch::Release;
      else if (stringcasecmp(Start,Word,"origin") == 0)
	 Type = pkgVersionMatch::Origin;
      else
      {
	 _error->Warning(_("Did not understand pin type %s"),string(Start,Word).c_str());
	 continue;
      }
      for (; Word != End && isspace(*Word) != 0; Word++);

      int priority = Tags.FindI("Pin-Priority", 0);
      if (priority < std::numeric_limits<short>::min() ||
          priority > std::numeric_limits<short>::max() ||
	  _error->PendingError()) {
	 return _error->Error(_("%s: Value %s is outside the range of valid pin priorities (%d to %d)"),
			      File.c_str(), Tags.FindS("Pin-Priority").c_str(),
			      std::numeric_limits<short>::min(),
			      std::numeric_limits<short>::max());
      }
      if (priority == 0)
      {
         return _error->Error(_("No priority (or zero) specified for pin"));
      }

      istringstream s(Name);
      string pkg;
      while(!s.eof())
      {
	 s >> pkg;
         Plcy.CreatePin(Type, pkg, string(Word,End),priority);
      };
   }

   Plcy.InitDefaults();
   return true;
}
									/*}}}*/

pkgPolicy::~pkgPolicy() {delete [] PFPriority; delete [] Pins; delete [] VerPins; }
Commit	Line	Data
b2e465d6 AL	1	// -- mode: cpp; mode: fold --
b2e465d6 AL	2	// Description /{{{/
56298634	3	// $Id: policy.cc,v 1.10 2003/08/12 00:17:37 mdz Exp $
b2e465d6 AL	4	/* ######################################################################
	5
	6	Package Version Policy implementation
3f732aa6	7
b2e465d6 AL	8	This is just a really simple wrapper around pkgVersionMatch with
b2e465d6 AL	9	some added goodies to manage the list of things..
3f732aa6 DK	10
	11	See man apt_preferences for what value means what.
	12
b2e465d6 AL	13	##################################################################### */
	14	/}}}/
	15	// Include Files /{{{/
ea542140 DK	16	#include<config.h>
ea542140 DK	17
b2e465d6 AL	18	#include <apt-pkg/policy.h>
b2e465d6 AL	19	#include <apt-pkg/configuration.h>
9ed80cdd	20	#include <apt-pkg/cachefilter.h>
b2e465d6 AL	21	#include <apt-pkg/tagfile.h>
b2e465d6 AL	22	#include <apt-pkg/strutl.h>
46e39c8e	23	#include <apt-pkg/fileutl.h>
b2e465d6	24	#include <apt-pkg/error.h>
453b82a3 DK	25	#include <apt-pkg/cacheiterators.h>
	26	#include <apt-pkg/pkgcache.h>
	27	#include <apt-pkg/versionmatch.h>
a91aae40	28	#include <apt-pkg/version.h>
46e39c8e	29
453b82a3 DK	30	#include <ctype.h>
	31	#include <stddef.h>
	32	#include <string.h>
	33	#include <string>
	34	#include <vector>
e7b470ee	35	#include <iostream>
ac7f8f79	36	#include <sstream>
ea542140 DK	37
ea542140 DK	38	#include <apti18n.h>
b2e465d6 AL	39	/}}}/
b2e465d6 AL	40
e7b470ee AL	41	using namespace std;
e7b470ee AL	42
b2e465d6 AL	43	// Policy::Init - Startup and bind to a cache /{{{/
	44	// ---------------------------------------------------------------------
	45	/* Set the defaults for operation. The default mode with no loaded policy
	46	file matches the V0 policy engine. */
50bac728 DK	47	pkgPolicy::pkgPolicy(pkgCache *Owner) : Pins(nullptr), VerPins(nullptr),
50bac728 DK	48	PFPriority(nullptr), Cache(Owner), d(NULL)
b2e465d6	49	{
3f732aa6	50	if (Owner == 0)
c55b8a54	51	return;
b2e465d6 AL	52	PFPriority = new signed short[Owner->Head().PackageFileCount];
b2e465d6 AL	53	Pins = new Pin[Owner->Head().PackageCount];
9fb02ab0	54	VerPins = new Pin[Owner->Head().VersionCount];
b2e465d6 AL	55
	56	for (unsigned long I = 0; I != Owner->Head().PackageCount; I++)
	57	Pins[I].Type = pkgVersionMatch::None;
9fb02ab0 JAK	58	for (unsigned long I = 0; I != Owner->Head().VersionCount; I++)
9fb02ab0 JAK	59	VerPins[I].Type = pkgVersionMatch::None;
b2e465d6 AL	60
	61	// The config file has a master override.
	62	string DefRel = _config->Find("APT::Default-Release");
	63	if (DefRel.empty() == false)
a3bbbab7 DK	64	{
	65	bool found = false;
	66	// FIXME: make ExpressionMatches static to use it here easily
	67	pkgVersionMatch vm("", pkgVersionMatch::None);
	68	for (pkgCache::PkgFileIterator F = Cache->FileBegin(); F != Cache->FileEnd(); ++F)
	69	{
b07aeb1a DK	70	if (vm.ExpressionMatches(DefRel, F.Archive()) \|\|
	71	vm.ExpressionMatches(DefRel, F.Codename()) \|\|
	72	vm.ExpressionMatches(DefRel, F.Version()) \|\|
061c58b6	73	(DefRel.length() > 2 && DefRel[1] == '='))
a3bbbab7 DK	74	found = true;
	75	}
	76	if (found == false)
	77	_error->Error(_("The value '%s' is invalid for APT::Default-Release as such a release is not available in the sources"), DefRel.c_str());
	78	else
	79	CreatePin(pkgVersionMatch::Release,"",DefRel,990);
	80	}
b2e465d6 AL	81	InitDefaults();
	82	}
	83	/}}}/
	84	// Policy::InitDefaults - Compute the default selections /{{{/
	85	// ---------------------------------------------------------------------
	86	/* */
	87	bool pkgPolicy::InitDefaults()
	88	{
	89	// Initialize the priorities based on the status of the package file
f7f0d6c7	90	for (pkgCache::PkgFileIterator I = Cache->FileBegin(); I != Cache->FileEnd(); ++I)
b2e465d6 AL	91	{
b2e465d6 AL	92	PFPriority[I->ID] = 500;
b07aeb1a	93	if (I.Flagged(pkgCache::Flag::NotSource))
b2e465d6	94	PFPriority[I->ID] = 100;
b07aeb1a	95	else if (I.Flagged(pkgCache::Flag::ButAutomaticUpgrades))
5ed56f93	96	PFPriority[I->ID] = 100;
b07aeb1a	97	else if (I.Flagged(pkgCache::Flag::NotAutomatic))
5ed56f93	98	PFPriority[I->ID] = 1;
b2e465d6 AL	99	}
	100
	101	// Apply the defaults..
98cc7fd2 JAK	102	std::unique_ptr<bool[]> Fixed(new bool[Cache->HeaderP->PackageFileCount]);
98cc7fd2 JAK	103	memset(Fixed.get(),0,sizeof(Fixed[0])*Cache->HeaderP->PackageFileCount);
b2e465d6	104	StatusOverride = false;
ab640001	105	for (vector<Pin>::const_iterator I = Defaults.begin(); I != Defaults.end(); ++I)
b2e465d6 AL	106	{
b2e465d6 AL	107	pkgVersionMatch Match(I->Data,I->Type);
f7f0d6c7	108	for (pkgCache::PkgFileIterator F = Cache->FileBegin(); F != Cache->FileEnd(); ++F)
b2e465d6	109	{
ab640001	110	if (Fixed[F->ID] == false && Match.FileMatch(F) == true)
b2e465d6	111	{
ab640001 DK	112	PFPriority[F->ID] = I->Priority;
ab640001 DK	113
3f732aa6	114	if (PFPriority[F->ID] >= 1000)
b2e465d6	115	StatusOverride = true;
ab640001	116
b2e465d6	117	Fixed[F->ID] = true;
ab640001 DK	118	}
ab640001 DK	119	}
b2e465d6 AL	120	}
	121
	122	if (_config->FindB("Debug::pkgPolicy",false) == true)
f7f0d6c7	123	for (pkgCache::PkgFileIterator F = Cache->FileBegin(); F != Cache->FileEnd(); ++F)
ab640001 DK	124	std::clog << "Prio of " << F.FileName() << ' ' << PFPriority[F->ID] << std::endl;
	125
	126	return true;
b2e465d6 AL	127	}
	128	/}}}/
	129	// Policy::GetCandidateVer - Get the candidate install version /{{{/
	130	// ---------------------------------------------------------------------
	131	/* Evaluate the package pins and the default list to deteremine what the
	132	best package is. */
9ee8287e	133	pkgCache::VerIterator pkgPolicy::GetCandidateVer(pkgCache::PkgIterator const &Pkg)
b2e465d6	134	{
a91aae40 JAK	135	if (_config->FindI("APT::Policy", 1) >= 1) {
	136	return GetCandidateVerNew(Pkg);
	137	}
	138
b2e465d6	139	// Look for a package pin and evaluate it.
af87ab54 AL	140	signed Max = GetPriority(Pkg);
af87ab54 AL	141	pkgCache::VerIterator Pref = GetMatch(Pkg);
e7b470ee	142
8f5525e9 JAK	143	// Alternatives in case we can not find our package pin (Bug#512318).
	144	signed MaxAlt = 0;
	145	pkgCache::VerIterator PrefAlt;
	146
9f5bf66a DK	147	// no package = no candidate version
	148	if (Pkg.end() == true)
	149	return Pref;
	150
	151	// packages with a pin lower than 0 have no newer candidate than the current version
	152	if (Max < 0)
	153	return Pkg.CurrentVer();
	154
b2e465d6 AL	155	/* Falling through to the default version.. Setting Max to zero
	156	effectively excludes everything <= 0 which are the non-automatic
	157	priorities.. The status file is given a prio of 100 which will exclude
	158	not-automatic sources, except in a single shot not-installed mode.
3f732aa6	159
b2e465d6 AL	160	The user pin is subject to the same priority rules as default
	161	selections. Thus there are two ways to create a pin - a pin that
	162	tracks the default when the default is taken away, and a permanent
	163	pin that stays at that setting.
	164	*/
16808002	165	bool PrefSeen = false;
f7f0d6c7	166	for (pkgCache::VerIterator Ver = Pkg.VersionList(); Ver.end() == false; ++Ver)
10639577	167	{
9ee8287e DK	168	/* Lets see if this version is the installed version */
9ee8287e DK	169	bool instVer = (Pkg.CurrentVer() == Ver);
9ee8287e	170
16808002 DK	171	if (Pref == Ver)
	172	PrefSeen = true;
	173
f7f0d6c7	174	for (pkgCache::VerFileIterator VF = Ver.FileList(); VF.end() == false; ++VF)
b2e465d6	175	{
6aeda9fa AL	176	/* If this is the status file, and the current version is not the
	177	version in the status file (ie it is not installed, or somesuch)
	178	then it is not a candidate for installation, ever. This weeds
	179	out bogus entries that may be due to config-file states, or
	180	other. */
b07aeb1a	181	if (VF.File().Flagged(pkgCache::Flag::NotSource) && instVer == false)
6aeda9fa	182	continue;
9ee8287e	183
b2e465d6 AL	184	signed Prio = PFPriority[VF.File()->ID];
	185	if (Prio > Max)
	186	{
	187	Pref = Ver;
	188	Max = Prio;
16808002	189	PrefSeen = true;
8f5525e9 JAK	190	}
	191	if (Prio > MaxAlt)
	192	{
	193	PrefAlt = Ver;
	194	MaxAlt = Prio;
16808002 DK	195	}
	196	}
	197
9ee8287e	198	if (instVer == true && Max < 1000)
b2e465d6	199	{
16808002 DK	200	/* Not having seen the Pref yet means we have a specific pin below 1000
	201	on a version below the current installed one, so ignore the specific pin
	202	as this would be a downgrade otherwise */
	203	if (PrefSeen == false \|\| Pref.end() == true)
	204	{
	205	Pref = Ver;
	206	PrefSeen = true;
	207	}
3f732aa6 DK	208	/* Elevate our current selection (or the status file itself) so that only
	209	a downgrade can override it from now on */
	210	Max = 999;
16808002	211
b2e465d6 AL	212	// Fast path optimize.
	213	if (StatusOverride == false)
	214	break;
16808002	215	}
b2e465d6	216	}
8f5525e9 JAK	217	// If we do not find our candidate, use the one with the highest pin.
	218	// This means that if there is a version available with pin > 0; there
	219	// will always be a candidate (Closes: #512318)
	220	if (!Pref.IsGood() && MaxAlt > 0)
	221	Pref = PrefAlt;
9ee8287e	222
b2e465d6 AL	223	return Pref;
b2e465d6 AL	224	}
a91aae40 JAK	225
	226	// Policy::GetCandidateVer - Get the candidate install version /{{{/
	227	// ---------------------------------------------------------------------
	228	/* Evaluate the package pins and the default list to deteremine what the
	229	best package is. */
	230	pkgCache::VerIterator pkgPolicy::GetCandidateVerNew(pkgCache::PkgIterator const &Pkg)
	231	{
	232	// TODO: Replace GetCandidateVer()
	233	pkgCache::VerIterator cand;
3436218c	234	pkgCache::VerIterator cur = Pkg.CurrentVer();
a91aae40	235	int candPriority = -1;
a91aae40 JAK	236	pkgVersioningSystem *vs = Cache->VS;
	237
	238	for (pkgCache::VerIterator ver = Pkg.VersionList(); ver.end() == false; ver++) {
632f2476	239	int priority = GetPriority(ver, true);
a91aae40	240
632f2476 JAK	241	if (priority == 0 \|\| priority <= candPriority)
632f2476 JAK	242	continue;
3436218c	243
632f2476 JAK	244	// TODO: Maybe optimize to not compare versions
	245	if (!cur.end() && priority < 1000
	246	&& (vs->CmpVersion(ver.VerStr(), cur.VerStr()) < 0))
	247	continue;
a91aae40 JAK	248
a91aae40 JAK	249	candPriority = priority;
a91aae40 JAK	250	cand = ver;
	251	}
	252
	253	return cand;
	254	}
b2e465d6 AL	255	/}}}/
	256	// Policy::CreatePin - Create an entry in the pin table.. /{{{/
	257	// ---------------------------------------------------------------------
	258	/* For performance we have 3 tables, the default table, the main cache
	259	table (hashed to the cache). A blank package name indicates the pin
	260	belongs to the default table. Order of insertion matters here, the
	261	earlier defaults override later ones. */
	262	void pkgPolicy::CreatePin(pkgVersionMatch::MatchType Type,string Name,
	263	string Data,signed short Priority)
	264	{
b2e465d6	265	if (Name.empty() == true)
b2e465d6	266	{
00c6e1a3	267	Pin P = &Defaults.insert(Defaults.end(),Pin());
4a6d2163 DK	268	P->Type = Type;
	269	P->Priority = Priority;
	270	P->Data = Data;
	271	return;
	272	}
00c6e1a3 MV	273
	274	size_t found = Name.rfind(':');
	275	string Arch;
	276	if (found != string::npos) {
	277	Arch = Name.substr(found+1);
	278	Name.erase(found);
	279	}
	280
1a4c9766 JAK	281	// Allow pinning by wildcards
	282	// TODO: Maybe we should always prefer specific pins over non-
	283	// specific ones.
a8d7c101 DK	284	if (Name[0] == '/' \|\| Name.find_first_of("*[?") != string::npos)
	285	{
	286	pkgVersionMatch match(Data, Type);
	287	for (pkgCache::GrpIterator G = Cache->GrpBegin(); G.end() != true; ++G)
	288	if (match.ExpressionMatches(Name, G.Name()))
00c6e1a3 MV	289	{
	290	if (Arch.empty() == false)
	291	CreatePin(Type, string(G.Name()).append(":").append(Arch), Data, Priority);
	292	else
	293	CreatePin(Type, G.Name(), Data, Priority);
	294	}
1a4c9766 JAK	295	return;
1a4c9766 JAK	296	}
4a6d2163	297
00c6e1a3	298	// find the package (group) this pin applies to
9ed80cdd DK	299	pkgCache::GrpIterator Grp = Cache->FindGrp(Name);
	300	bool matched = false;
	301	if (Grp.end() == false)
	302	{
	303	std::string MatchingArch;
	304	if (Arch.empty() == true)
	305	MatchingArch = Cache->NativeArch();
	306	else
	307	MatchingArch = Arch;
	308	APT::CacheFilter::PackageArchitectureMatchesSpecification pams(MatchingArch);
	309	for (pkgCache::PkgIterator Pkg = Grp.PackageList(); Pkg.end() != true; Pkg = Grp.NextPkg(Pkg))
	310	{
	311	if (pams(Pkg.Arch()) == false)
	312	continue;
	313	Pin *P = Pins + Pkg->ID;
	314	// the first specific stanza for a package is the ruler,
	315	// all others need to be ignored
	316	if (P->Type != pkgVersionMatch::None)
	317	P = &*Unmatched.insert(Unmatched.end(),PkgPin(Pkg.FullName()));
	318	P->Type = Type;
	319	P->Priority = Priority;
	320	P->Data = Data;
	321	matched = true;
7fd9c353 JAK	322
	323	// Find matching version(s) and copy the pin into it
	324	pkgVersionMatch Match(P->Data,P->Type);
	325	for (pkgCache::VerIterator Ver = Pkg.VersionList(); Ver.end() != true; Ver++)
	326	{
	327	if (Match.VersionMatches(Ver)) {
	328	Pin *VP = VerPins + Ver->ID;
	329	if (VP->Type == pkgVersionMatch::None)
	330	VP = P;
	331	}
	332	}
9ed80cdd	333	}
00c6e1a3 MV	334	}
00c6e1a3 MV	335
9ed80cdd	336	if (matched == false)
4a6d2163	337	{
00c6e1a3 MV	338	PkgPin P = &Unmatched.insert(Unmatched.end(),PkgPin(Name));
	339	if (Arch.empty() == false)
	340	P->Pkg.append(":").append(Arch);
	341	P->Type = Type;
	342	P->Priority = Priority;
	343	P->Data = Data;
	344	return;
	345	}
b2e465d6 AL	346	}
b2e465d6 AL	347	/}}}/
af87ab54 AL	348	// Policy::GetMatch - Get the matching version for a package pin /{{{/
	349	// ---------------------------------------------------------------------
	350	/* */
9ee8287e	351	pkgCache::VerIterator pkgPolicy::GetMatch(pkgCache::PkgIterator const &Pkg)
af87ab54 AL	352	{
af87ab54 AL	353	const Pin &PPkg = Pins[Pkg->ID];
9ee8287e DK	354	if (PPkg.Type == pkgVersionMatch::None)
	355	return pkgCache::VerIterator(*Pkg.Cache());
	356
	357	pkgVersionMatch Match(PPkg.Data,PPkg.Type);
	358	return Match.Find(Pkg);
af87ab54 AL	359	}
	360	/}}}/
	361	// Policy::GetPriority - Get the priority of the package pin /{{{/
	362	// ---------------------------------------------------------------------
	363	/* */
a02db58f	364	APT_PURE signed short pkgPolicy::GetPriority(pkgCache::PkgIterator const &Pkg)
af87ab54 AL	365	{
af87ab54 AL	366	if (Pins[Pkg->ID].Type != pkgVersionMatch::None)
af87ab54	367	return Pins[Pkg->ID].Priority;
af87ab54	368	return 0;
6d38011b	369	}
a0a66955	370	APT_PURE signed short pkgPolicy::GetPriority(pkgCache::VerIterator const &Ver, bool ConsiderFiles)
9fb02ab0 JAK	371	{
	372	if (VerPins[Ver->ID].Type != pkgVersionMatch::None)
	373	return VerPins[Ver->ID].Priority;
a0a66955	374	if (!ConsiderFiles)
10b39ae6	375	return 0;
5f9386e5	376
9b7d159f	377	int priority = std::numeric_limits<int>::min();
5f9386e5 JAK	378	for (pkgCache::VerFileIterator file = Ver.FileList(); file.end() == false; file++)
5f9386e5 JAK	379	{
3d5e93f7 JAK	380	/* If this is the status file, and the current version is not the
	381	version in the status file (ie it is not installed, or somesuch)
	382	then it is not a candidate for installation, ever. This weeds
	383	out bogus entries that may be due to config-file states, or
	384	other. */
	385	if (file.File().Flagged(pkgCache::Flag::NotSource) && Ver.ParentPkg().CurrentVer() != Ver) {
1d203ce7	386	// Ignore
3d5e93f7 JAK	387	} else if (GetPriority(file.File()) > priority) {
	388	priority = GetPriority(file.File());
	389	}
5f9386e5 JAK	390	}
5f9386e5 JAK	391
9b7d159f	392	return priority == std::numeric_limits<int>::min() ? 0 : priority;
9fb02ab0	393	}
a02db58f	394	APT_PURE signed short pkgPolicy::GetPriority(pkgCache::PkgFileIterator const &File)
6d38011b DK	395	{
6d38011b DK	396	return PFPriority[File->ID];
af87ab54 AL	397	}
af87ab54 AL	398	/}}}/
ef1dff93 DK	399	// ReadPinDir - Load the pin files from this dir into a Policy /{{{/
ef1dff93 DK	400	// ---------------------------------------------------------------------
6009e60d DK	401	/* This will load each pin file in the given dir into a Policy. If the
	402	given dir is empty the dir set in Dir::Etc::PreferencesParts is used.
	403	Note also that this method will issue a warning if the dir does not
	404	exists but it will return true in this case! */
e68ca100 JAK	405	bool ReadPinDir(pkgPolicy &Plcy,string Dir)
	406	{
	407	if (Dir.empty() == true)
	408	Dir = _config->FindDir("Dir::Etc::PreferencesParts");
	409
448eaf8b	410	if (DirectoryExists(Dir) == false)
6009e60d	411	{
448eaf8b	412	_error->WarningE("DirectoryExists",_("Unable to read %s"),Dir.c_str());
6009e60d DK	413	return true;
	414	}
	415
b39c1859	416	vector<string> const List = GetListOfFilesInDir(Dir, "pref", true, true);
e68ca100 JAK	417
e68ca100 JAK	418	// Read the files
f7f0d6c7	419	for (vector<string>::const_iterator I = List.begin(); I != List.end(); ++I)
e68ca100 JAK	420	if (ReadPinFile(Plcy, *I) == false)
	421	return false;
	422	return true;
	423	}
81e9789b	424	/}}}/
b2e465d6 AL	425	// ReadPinFile - Load the pin file into a Policy /{{{/
	426	// ---------------------------------------------------------------------
	427	/* I'd like to see the preferences file store more than just pin information
	428	but right now that is the only stuff I have to store. Later there will
	429	have to be some kind of combined super parser to get the data into all
	430	the right classes.. */
	431	bool ReadPinFile(pkgPolicy &Plcy,string File)
	432	{
	433	if (File.empty() == true)
	434	File = _config->FindFile("Dir::Etc::Preferences");
	435
36f1098a	436	if (RealFileExists(File) == false)
b2e465d6 AL	437	return true;
	438
	439	FileFd Fd(File,FileFd::ReadOnly);
	440	pkgTagFile TF(&Fd);
	441	if (_error->PendingError() == true)
	442	return false;
81460e32 DK	443
81460e32 DK	444	pkgUserTagSection Tags;
b2e465d6 AL	445	while (TF.Step(Tags) == true)
b2e465d6 AL	446	{
75ab11ae MV	447	// can happen when there are only comments in a record
	448	if (Tags.Count() == 0)
	449	continue;
	450
b2e465d6 AL	451	string Name = Tags.FindS("Package");
b2e465d6 AL	452	if (Name.empty() == true)
e68ca100	453	return _error->Error(_("Invalid record in the preferences file %s, no Package header"), File.c_str());
b2e465d6 AL	454	if (Name == "*")
	455	Name = string();
	456
	457	const char *Start;
	458	const char *End;
	459	if (Tags.Find("Pin",Start,End) == false)
	460	continue;
	461
	462	const char *Word = Start;
	463	for (; Word != End && isspace(*Word) == 0; Word++);
	464
	465	// Parse the type..
	466	pkgVersionMatch::MatchType Type;
	467	if (stringcasecmp(Start,Word,"version") == 0 && Name.empty() == false)
	468	Type = pkgVersionMatch::Version;
	469	else if (stringcasecmp(Start,Word,"release") == 0)
	470	Type = pkgVersionMatch::Release;
	471	else if (stringcasecmp(Start,Word,"origin") == 0)
	472	Type = pkgVersionMatch::Origin;
	473	else
	474	{
	475	_error->Warning(_("Did not understand pin type %s"),string(Start,Word).c_str());
	476	continue;
	477	}
	478	for (; Word != End && isspace(*Word) != 0; Word++);
	479
809aa216 JAK	480	int priority = Tags.FindI("Pin-Priority", 0);
	481	if (priority < std::numeric_limits<short>::min() \|\|
	482	priority > std::numeric_limits<short>::max() \|\|
	483	_error->PendingError()) {
	484	return _error->Error(_("%s: Value %s is outside the range of valid pin priorities (%d to %d)"),
	485	File.c_str(), Tags.FindS("Pin-Priority").c_str(),
	486	std::numeric_limits<short>::min(),
	487	std::numeric_limits<short>::max());
	488	}
56298634 AL	489	if (priority == 0)
56298634 AL	490	{
809aa216	491	return _error->Error(_("No priority (or zero) specified for pin"));
56298634 AL	492	}
56298634 AL	493
1c62ab24 MV	494	istringstream s(Name);
	495	string pkg;
	496	while(!s.eof())
	497	{
	498	s >> pkg;
	499	Plcy.CreatePin(Type, pkg, string(Word,End),priority);
	500	};
b2e465d6 AL	501	}
	502
	503	Plcy.InitDefaults();
	504	return true;
	505	}
	506	/}}}/
c8a4ce6c	507
9fb02ab0	508	pkgPolicy::~pkgPolicy() {delete [] PFPriority; delete [] Pins; delete [] VerPins; }