[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..
   
   Priority Table:
   
   1000 -> inf = Downgradeable priorities
   1000        = The 'no downgrade' pseduo-status file
   100 -> 1000 = Standard priorities
   990         = Config file override package files
   989         = Start for preference auto-priorities
   500         = Default package files
   100         = The status file
   0 -> 100    = NotAutomatic sources like experimental
   -inf -> 0   = Never selected   
   
   ##################################################################### */
									/*}}}*/
// Include Files							/*{{{*/
#include <apt-pkg/policy.h>
#include <apt-pkg/configuration.h>
#include <apt-pkg/tagfile.h>
#include <apt-pkg/strutl.h>
#include <apt-pkg/error.h>
#include <apt-pkg/sptr.h>
    
#include <apti18n.h>

#include <iostream>
#include <sstream>
									/*}}}*/

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(0), PFPriority(0), Cache(Owner)
{
   PFPriority = new signed short[Owner->Head().PackageFileCount];
   Pins = new Pin[Owner->Head().PackageCount];

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

   // The config file has a master override.
   string DefRel = _config->Find("APT::Default-Release");
   if (DefRel.empty() == false)
      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->Flags & pkgCache::Flag::NotSource) == pkgCache::Flag::NotSource)
	 PFPriority[I->ID] = 100;
      else
	 if ((I->Flags & pkgCache::Flag::NotAutomatic) == pkgCache::Flag::NotAutomatic)
	    PFPriority[I->ID] = 1;
   }

   // Apply the defaults..
   SPtrArray<bool> Fixed = new bool[Cache->HeaderP->PackageFileCount];
   memset(Fixed,0,sizeof(*Fixed)*Cache->HeaderP->PackageFileCount);
   signed Cur = 989;
   StatusOverride = false;
   for (vector<Pin>::const_iterator I = Defaults.begin(); I != Defaults.end();
	I++, Cur--)
   {
      pkgVersionMatch Match(I->Data,I->Type);
      for (pkgCache::PkgFileIterator F = Cache->FileBegin(); F != Cache->FileEnd(); F++)
      {
	 if (Match.FileMatch(F) == true && Fixed[F->ID] == false)
	 {
	    if (I->Priority != 0 && I->Priority > 0)
	       Cur = I->Priority;
	    
	    if (I->Priority < 0)
	       PFPriority[F->ID] =  I->Priority;
	    else
	       PFPriority[F->ID] = Cur;
	    
	    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++)
	 cout << "Prio of " << F.FileName() << ' ' << PFPriority[F->ID] << 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 Pkg)
{
   // Look for a package pin and evaluate it.
   signed Max = GetPriority(Pkg);
   pkgCache::VerIterator Pref = GetMatch(Pkg);

   /* 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 second pseduo-status file is at prio 1000, above which will permit
      the user to force-downgrade things.
      
      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.
    */
   for (pkgCache::VerIterator Ver = Pkg.VersionList(); Ver.end() == false; Ver++)
   {
      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()->Flags & pkgCache::Flag::NotSource) == pkgCache::Flag::NotSource &&
	     Pkg.CurrentVer() != Ver)
	    continue;
	 	 	 
	 signed Prio = PFPriority[VF.File()->ID];
	 if (Prio > Max)
	 {
	    Pref = Ver;
	    Max = Prio;
	 }	 
      }      
      
      if (Pkg.CurrentVer() == Ver && Max < 1000)
      {
	 /* Elevate our current selection (or the status file itself)
	    to the Pseudo-status priority. */
	 if (Pref.end() == true)
	    Pref = Ver;
	 Max = 1000;
	 
	 // Fast path optimize.
	 if (StatusOverride == false)
	    break;
      }            
   }
   return Pref;
}
									/*}}}*/
// 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)
{
   Pin *P = 0;
   
   if (Name.empty() == true)
      P = &*Defaults.insert(Defaults.end(),PkgPin());
   else
   {
      // Get a spot to put the pin
      pkgCache::PkgIterator Pkg = Cache->FindPkg(Name);
      if (Pkg.end() == true)
      {
	 // Check the unmatched table
	 for (vector<PkgPin>::iterator I = Unmatched.begin(); 
	      I != Unmatched.end() && P == 0; I++)
	    if (I->Pkg == Name)
	       P = &*I;
	 
	 if (P == 0)
	    P = &*Unmatched.insert(Unmatched.end(),PkgPin());      
      }
      else
      {
	 P = Pins + Pkg->ID;
      }      
   }
   
   // Set..
   P->Type = Type;
   P->Priority = Priority;
   P->Data = Data;
}
									/*}}}*/
// Policy::GetMatch - Get the matching version for a package pin	/*{{{*/
// ---------------------------------------------------------------------
/* */
pkgCache::VerIterator pkgPolicy::GetMatch(pkgCache::PkgIterator Pkg)
{
   const Pin &PPkg = Pins[Pkg->ID];
   if (PPkg.Type != pkgVersionMatch::None)
   {
      pkgVersionMatch Match(PPkg.Data,PPkg.Type);
      return Match.Find(Pkg);
   }
   return pkgCache::VerIterator(*Pkg.Cache());
}
									/*}}}*/
// Policy::GetPriority - Get the priority of the package pin		/*{{{*/
// ---------------------------------------------------------------------
/* */
signed short pkgPolicy::GetPriority(pkgCache::PkgIterator const &Pkg)
{
   if (Pins[Pkg->ID].Type != pkgVersionMatch::None)
   {
      // In this case 0 means default priority
      if (Pins[Pkg->ID].Priority == 0)
	 return 989;
      return Pins[Pkg->ID].Priority;
   }
   
   return 0;
}
									/*}}}*/

// 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 (FileExists(File) == false)
      return true;
   
   FileFd Fd(File,FileFd::ReadOnly);
   pkgTagFile TF(&Fd);
   if (_error->PendingError() == true)
      return false;
   
   pkgTagSection Tags;
   while (TF.Step(Tags) == true)
   {
      string Name = Tags.FindS("Package");
      if (Name.empty() == true)
	 return _error->Error(_("Invalid record in the preferences file, no Package header"));
      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++);

      short int priority = Tags.FindI("Pin-Priority", 0);
      if (priority == 0)
      {
         _error->Warning(_("No priority (or zero) specified for pin"));
         continue;
      }

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

   Plcy.InitDefaults();
   return true;
}
									/*}}}*/
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
	7
	8	This is just a really simple wrapper around pkgVersionMatch with
	9	some added goodies to manage the list of things..
	10
	11	Priority Table:
	12
	13	1000 -> inf = Downgradeable priorities
	14	1000 = The 'no downgrade' pseduo-status file
	15	100 -> 1000 = Standard priorities
	16	990 = Config file override package files
	17	989 = Start for preference auto-priorities
	18	500 = Default package files
	19	100 = The status file
	20	0 -> 100 = NotAutomatic sources like experimental
	21	-inf -> 0 = Never selected
	22
	23	##################################################################### */
	24	/}}}/
	25	// Include Files /{{{/
b2e465d6 AL	26	#include <apt-pkg/policy.h>
	27	#include <apt-pkg/configuration.h>
	28	#include <apt-pkg/tagfile.h>
	29	#include <apt-pkg/strutl.h>
	30	#include <apt-pkg/error.h>
	31	#include <apt-pkg/sptr.h>
	32
	33	#include <apti18n.h>
e7b470ee AL	34
e7b470ee AL	35	#include <iostream>
1c62ab24	36	#include <sstream>
b2e465d6 AL	37	/}}}/
b2e465d6 AL	38
e7b470ee AL	39	using namespace std;
e7b470ee AL	40
b2e465d6 AL	41	// Policy::Init - Startup and bind to a cache /{{{/
	42	// ---------------------------------------------------------------------
	43	/* Set the defaults for operation. The default mode with no loaded policy
	44	file matches the V0 policy engine. */
	45	pkgPolicy::pkgPolicy(pkgCache *Owner) : Pins(0), PFPriority(0), Cache(Owner)
	46	{
	47	PFPriority = new signed short[Owner->Head().PackageFileCount];
	48	Pins = new Pin[Owner->Head().PackageCount];
	49
	50	for (unsigned long I = 0; I != Owner->Head().PackageCount; I++)
	51	Pins[I].Type = pkgVersionMatch::None;
	52
	53	// The config file has a master override.
	54	string DefRel = _config->Find("APT::Default-Release");
	55	if (DefRel.empty() == false)
	56	CreatePin(pkgVersionMatch::Release,"",DefRel,990);
	57
	58	InitDefaults();
	59	}
	60	/}}}/
	61	// Policy::InitDefaults - Compute the default selections /{{{/
	62	// ---------------------------------------------------------------------
	63	/* */
	64	bool pkgPolicy::InitDefaults()
	65	{
	66	// Initialize the priorities based on the status of the package file
	67	for (pkgCache::PkgFileIterator I = Cache->FileBegin(); I != Cache->FileEnd(); I++)
	68	{
	69	PFPriority[I->ID] = 500;
	70	if ((I->Flags & pkgCache::Flag::NotSource) == pkgCache::Flag::NotSource)
	71	PFPriority[I->ID] = 100;
	72	else
	73	if ((I->Flags & pkgCache::Flag::NotAutomatic) == pkgCache::Flag::NotAutomatic)
	74	PFPriority[I->ID] = 1;
	75	}
	76
	77	// Apply the defaults..
20ebd488	78	SPtrArray<bool> Fixed = new bool[Cache->HeaderP->PackageFileCount];
b2e465d6 AL	79	memset(Fixed,0,sizeof(Fixed)Cache->HeaderP->PackageFileCount);
	80	signed Cur = 989;
	81	StatusOverride = false;
	82	for (vector<Pin>::const_iterator I = Defaults.begin(); I != Defaults.end();
	83	I++, Cur--)
	84	{
	85	pkgVersionMatch Match(I->Data,I->Type);
	86	for (pkgCache::PkgFileIterator F = Cache->FileBegin(); F != Cache->FileEnd(); F++)
	87	{
b2e465d6 AL	88	if (Match.FileMatch(F) == true && Fixed[F->ID] == false)
	89	{
	90	if (I->Priority != 0 && I->Priority > 0)
	91	Cur = I->Priority;
	92
	93	if (I->Priority < 0)
	94	PFPriority[F->ID] = I->Priority;
	95	else
	96	PFPriority[F->ID] = Cur;
	97
	98	if (PFPriority[F->ID] > 1000)
	99	StatusOverride = true;
	100
	101	Fixed[F->ID] = true;
	102	}
	103	}
	104	}
	105
	106	if (_config->FindB("Debug::pkgPolicy",false) == true)
	107	for (pkgCache::PkgFileIterator F = Cache->FileBegin(); F != Cache->FileEnd(); F++)
	108	cout << "Prio of " << F.FileName() << ' ' << PFPriority[F->ID] << endl;
	109
	110	return true;
	111	}
	112	/}}}/
	113	// Policy::GetCandidateVer - Get the candidate install version /{{{/
	114	// ---------------------------------------------------------------------
	115	/* Evaluate the package pins and the default list to deteremine what the
	116	best package is. */
	117	pkgCache::VerIterator pkgPolicy::GetCandidateVer(pkgCache::PkgIterator Pkg)
	118	{
b2e465d6	119	// Look for a package pin and evaluate it.
af87ab54 AL	120	signed Max = GetPriority(Pkg);
af87ab54 AL	121	pkgCache::VerIterator Pref = GetMatch(Pkg);
e7b470ee	122
b2e465d6 AL	123	/* Falling through to the default version.. Setting Max to zero
	124	effectively excludes everything <= 0 which are the non-automatic
	125	priorities.. The status file is given a prio of 100 which will exclude
	126	not-automatic sources, except in a single shot not-installed mode.
	127	The second pseduo-status file is at prio 1000, above which will permit
	128	the user to force-downgrade things.
	129
	130	The user pin is subject to the same priority rules as default
	131	selections. Thus there are two ways to create a pin - a pin that
	132	tracks the default when the default is taken away, and a permanent
	133	pin that stays at that setting.
	134	*/
	135	for (pkgCache::VerIterator Ver = Pkg.VersionList(); Ver.end() == false; Ver++)
10639577	136	{
b2e465d6 AL	137	for (pkgCache::VerFileIterator VF = Ver.FileList(); VF.end() == false; VF++)
b2e465d6 AL	138	{
6aeda9fa AL	139	/* If this is the status file, and the current version is not the
	140	version in the status file (ie it is not installed, or somesuch)
	141	then it is not a candidate for installation, ever. This weeds
	142	out bogus entries that may be due to config-file states, or
	143	other. */
	144	if ((VF.File()->Flags & pkgCache::Flag::NotSource) == pkgCache::Flag::NotSource &&
	145	Pkg.CurrentVer() != Ver)
	146	continue;
	147
b2e465d6 AL	148	signed Prio = PFPriority[VF.File()->ID];
	149	if (Prio > Max)
	150	{
	151	Pref = Ver;
	152	Max = Prio;
	153	}
	154	}
	155
	156	if (Pkg.CurrentVer() == Ver && Max < 1000)
	157	{
	158	/* Elevate our current selection (or the status file itself)
	159	to the Pseudo-status priority. */
	160	if (Pref.end() == true)
	161	Pref = Ver;
	162	Max = 1000;
	163
	164	// Fast path optimize.
	165	if (StatusOverride == false)
	166	break;
	167	}
	168	}
b2e465d6 AL	169	return Pref;
	170	}
	171	/}}}/
	172	// Policy::CreatePin - Create an entry in the pin table.. /{{{/
	173	// ---------------------------------------------------------------------
	174	/* For performance we have 3 tables, the default table, the main cache
	175	table (hashed to the cache). A blank package name indicates the pin
	176	belongs to the default table. Order of insertion matters here, the
	177	earlier defaults override later ones. */
	178	void pkgPolicy::CreatePin(pkgVersionMatch::MatchType Type,string Name,
	179	string Data,signed short Priority)
	180	{
b2e465d6 AL	181	Pin *P = 0;
	182
	183	if (Name.empty() == true)
b8b7c37d	184	P = &*Defaults.insert(Defaults.end(),PkgPin());
b2e465d6 AL	185	else
	186	{
	187	// Get a spot to put the pin
d4887f3c	188	pkgCache::PkgIterator Pkg = Cache->FindPkg(Name);
b2e465d6 AL	189	if (Pkg.end() == true)
	190	{
	191	// Check the unmatched table
	192	for (vector<PkgPin>::iterator I = Unmatched.begin();
	193	I != Unmatched.end() && P == 0; I++)
	194	if (I->Pkg == Name)
d4887f3c	195	P = &*I;
b2e465d6 AL	196
b2e465d6 AL	197	if (P == 0)
b8b7c37d	198	P = &*Unmatched.insert(Unmatched.end(),PkgPin());
b2e465d6 AL	199	}
	200	else
	201	{
	202	P = Pins + Pkg->ID;
	203	}
	204	}
	205
	206	// Set..
	207	P->Type = Type;
	208	P->Priority = Priority;
	209	P->Data = Data;
	210	}
	211	/}}}/
af87ab54 AL	212	// Policy::GetMatch - Get the matching version for a package pin /{{{/
	213	// ---------------------------------------------------------------------
	214	/* */
	215	pkgCache::VerIterator pkgPolicy::GetMatch(pkgCache::PkgIterator Pkg)
	216	{
	217	const Pin &PPkg = Pins[Pkg->ID];
	218	if (PPkg.Type != pkgVersionMatch::None)
	219	{
	220	pkgVersionMatch Match(PPkg.Data,PPkg.Type);
e7b470ee	221	return Match.Find(Pkg);
af87ab54 AL	222	}
	223	return pkgCache::VerIterator(*Pkg.Cache());
	224	}
	225	/}}}/
	226	// Policy::GetPriority - Get the priority of the package pin /{{{/
	227	// ---------------------------------------------------------------------
	228	/* */
	229	signed short pkgPolicy::GetPriority(pkgCache::PkgIterator const &Pkg)
	230	{
	231	if (Pins[Pkg->ID].Type != pkgVersionMatch::None)
	232	{
	233	// In this case 0 means default priority
	234	if (Pins[Pkg->ID].Priority == 0)
	235	return 989;
	236	return Pins[Pkg->ID].Priority;
	237	}
	238
	239	return 0;
	240	}
	241	/}}}/
b2e465d6 AL	242
	243	// ReadPinFile - Load the pin file into a Policy /{{{/
	244	// ---------------------------------------------------------------------
	245	/* I'd like to see the preferences file store more than just pin information
	246	but right now that is the only stuff I have to store. Later there will
	247	have to be some kind of combined super parser to get the data into all
	248	the right classes.. */
	249	bool ReadPinFile(pkgPolicy &Plcy,string File)
	250	{
	251	if (File.empty() == true)
	252	File = _config->FindFile("Dir::Etc::Preferences");
	253
	254	if (FileExists(File) == false)
	255	return true;
	256
	257	FileFd Fd(File,FileFd::ReadOnly);
	258	pkgTagFile TF(&Fd);
	259	if (_error->PendingError() == true)
	260	return false;
	261
	262	pkgTagSection Tags;
	263	while (TF.Step(Tags) == true)
	264	{
	265	string Name = Tags.FindS("Package");
	266	if (Name.empty() == true)
	267	return _error->Error(_("Invalid record in the preferences file, no Package header"));
	268	if (Name == "*")
	269	Name = string();
	270
	271	const char *Start;
	272	const char *End;
	273	if (Tags.Find("Pin",Start,End) == false)
	274	continue;
	275
	276	const char *Word = Start;
	277	for (; Word != End && isspace(*Word) == 0; Word++);
	278
	279	// Parse the type..
	280	pkgVersionMatch::MatchType Type;
	281	if (stringcasecmp(Start,Word,"version") == 0 && Name.empty() == false)
	282	Type = pkgVersionMatch::Version;
	283	else if (stringcasecmp(Start,Word,"release") == 0)
	284	Type = pkgVersionMatch::Release;
	285	else if (stringcasecmp(Start,Word,"origin") == 0)
	286	Type = pkgVersionMatch::Origin;
	287	else
	288	{
	289	_error->Warning(_("Did not understand pin type %s"),string(Start,Word).c_str());
	290	continue;
	291	}
	292	for (; Word != End && isspace(*Word) != 0; Word++);
	293
56298634 AL	294	short int priority = Tags.FindI("Pin-Priority", 0);
	295	if (priority == 0)
	296	{
	297	_error->Warning(_("No priority (or zero) specified for pin"));
	298	continue;
	299	}
	300
1c62ab24 MV	301	istringstream s(Name);
	302	string pkg;
	303	while(!s.eof())
	304	{
	305	s >> pkg;
	306	Plcy.CreatePin(Type, pkg, string(Word,End),priority);
	307	};
b2e465d6 AL	308	}
	309
	310	Plcy.InitDefaults();
	311	return true;
	312	}
	313	/}}}/