doc/files.dbk: Improve documentation for {src,}pkgcache.bin

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

diff --git a/apt-pkg/policy.cc b/apt-pkg/policy.cc
index 3cfc328298fd178dbc151a6e68f63f30174f7ad1..4711372bc4db61601711adf0207f5689a2643f44 100644 (file)
--- a/apt-pkg/policy.cc
+++ b/apt-pkg/policy.cc
@@ -4,22 +4,12 @@
 /* ######################################################################
 
    Package Version Policy implementation
 /* ######################################################################
 
    Package Version Policy implementation

-   
+

    This is just a really simple wrapper around pkgVersionMatch with
    some added goodies to manage the list of things..
    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 and ButAutomaticUpgrades sources
-   0 -> 100    = NotAutomatic sources like experimental
-   -inf -> 0   = Never selected   
-   
+
+   See man apt_preferences for what value means what.
+

    ##################################################################### */
                                                                        /*}}}*/
 // Include Files                                                       /*{{{*/
    ##################################################################### */
                                                                        /*}}}*/
 // Include Files                                                       /*{{{*/


@@ -36,6 +26,7 @@
 #include <apt-pkg/cacheiterators.h>
 #include <apt-pkg/pkgcache.h>
 #include <apt-pkg/versionmatch.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 <ctype.h>
 #include <stddef.h>


@@ -54,15 +45,19 @@ using namespace std;
 // ---------------------------------------------------------------------
 /* Set the defaults for operation. The default mode with no loaded policy
    file matches the V0 policy engine. */
 // ---------------------------------------------------------------------
 /* 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)
+pkgPolicy::pkgPolicy(pkgCache *Owner) : Pins(nullptr), VerPins(nullptr),
+   PFPriority(nullptr), Cache(Owner), d(NULL)

 {
 {

-   if (Owner == 0 || &(Owner->Head()) == 0)
+   if (Owner == 0)

       return;
    PFPriority = new signed short[Owner->Head().PackageFileCount];
    Pins = new Pin[Owner->Head().PackageCount];
       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().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");
 
    // The config file has a master override.
    string DefRel = _config->Find("APT::Default-Release");


@@ -73,9 +68,9 @@ pkgPolicy::pkgPolicy(pkgCache *Owner) : Pins(0), PFPriority(0), Cache(Owner)
       pkgVersionMatch vm("", pkgVersionMatch::None);
       for (pkgCache::PkgFileIterator F = Cache->FileBegin(); F != Cache->FileEnd(); ++F)
       {
       pkgVersionMatch vm("", pkgVersionMatch::None);
       for (pkgCache::PkgFileIterator F = Cache->FileBegin(); F != Cache->FileEnd(); ++F)
       {

-        if ((F->Archive != 0 && vm.ExpressionMatches(DefRel, F.Archive()) == true) ||
-            (F->Codename != 0 && vm.ExpressionMatches(DefRel, F.Codename()) == true) ||
-            (F->Version != 0 && vm.ExpressionMatches(DefRel, F.Version()) == true) ||
+        if (vm.ExpressionMatches(DefRel, F.Archive()) ||
+            vm.ExpressionMatches(DefRel, F.Codename()) ||
+            vm.ExpressionMatches(DefRel, F.Version()) ||

             (DefRel.length() > 2 && DefRel[1] == '='))
            found = true;
       }
             (DefRel.length() > 2 && DefRel[1] == '='))
            found = true;
       }


@@ -96,48 +91,40 @@ bool pkgPolicy::InitDefaults()
    for (pkgCache::PkgFileIterator I = Cache->FileBegin(); I != Cache->FileEnd(); ++I)
    {
       PFPriority[I->ID] = 500;
    for (pkgCache::PkgFileIterator I = Cache->FileBegin(); I != Cache->FileEnd(); ++I)
    {
       PFPriority[I->ID] = 500;

-      if ((I->Flags & pkgCache::Flag::NotSource) == pkgCache::Flag::NotSource)
+      if (I.Flagged(pkgCache::Flag::NotSource))

         PFPriority[I->ID] = 100;
         PFPriority[I->ID] = 100;

-      else if ((I->Flags & pkgCache::Flag::ButAutomaticUpgrades) == pkgCache::Flag::ButAutomaticUpgrades)
+      else if (I.Flagged(pkgCache::Flag::ButAutomaticUpgrades))

         PFPriority[I->ID] = 100;
         PFPriority[I->ID] = 100;

-      else if ((I->Flags & pkgCache::Flag::NotAutomatic) == pkgCache::Flag::NotAutomatic)
+      else if (I.Flagged(pkgCache::Flag::NotAutomatic))

         PFPriority[I->ID] = 1;
    }
 
    // Apply the defaults..
         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;
+   std::unique_ptr<bool[]> Fixed(new bool[Cache->HeaderP->PackageFileCount]);
+   memset(Fixed.get(),0,sizeof(Fixed[0])*Cache->HeaderP->PackageFileCount);

    StatusOverride = false;
    StatusOverride = false;

-   for (vector<Pin>::const_iterator I = Defaults.begin(); I != Defaults.end();
-       ++I, --Cur)
+   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)
       {
    {
       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 (Fixed[F->ID] == false && Match.FileMatch(F) == true)

         {
         {

-           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)
+           PFPriority[F->ID] = I->Priority;
+
+           if (PFPriority[F->ID] >= 1000)

               StatusOverride = true;
               StatusOverride = true;

-           
+

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

-        }      
-      }      
+        }
+      }

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

 }
                                                                        /*}}}*/
 // Policy::GetCandidateVer - Get the candidate install version         /*{{{*/
 }
                                                                        /*}}}*/
 // Policy::GetCandidateVer - Get the candidate install version         /*{{{*/


@@ -146,6 +133,10 @@ bool pkgPolicy::InitDefaults()
    best package is. */
 pkgCache::VerIterator pkgPolicy::GetCandidateVer(pkgCache::PkgIterator const &Pkg)
 {
    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);
    // Look for a package pin and evaluate it.
    signed Max = GetPriority(Pkg);
    pkgCache::VerIterator Pref = GetMatch(Pkg);


@@ -166,9 +157,7 @@ pkgCache::VerIterator pkgPolicy::GetCandidateVer(pkgCache::PkgIterator const &Pk
       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.
       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
       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


@@ -190,8 +179,7 @@ pkgCache::VerIterator pkgPolicy::GetCandidateVer(pkgCache::PkgIterator const &Pk
            then it is not a candidate for installation, ever. This weeds
            out bogus entries that may be due to config-file states, or
            other. */
            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 &&
-            instVer == false)
+        if (VF.File().Flagged(pkgCache::Flag::NotSource) && instVer == false)

            continue;
 
         signed Prio = PFPriority[VF.File()->ID];
            continue;
 
         signed Prio = PFPriority[VF.File()->ID];


@@ -218,9 +206,9 @@ pkgCache::VerIterator pkgPolicy::GetCandidateVer(pkgCache::PkgIterator const &Pk
            Pref = Ver;
            PrefSeen = true;
         }
            Pref = Ver;
            PrefSeen = true;
         }

-        /* Elevate our current selection (or the status file itself)
-           to the Pseudo-status priority. */
-        Max = 1000;
+        /* 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)
 
         // Fast path optimize.
         if (StatusOverride == false)


@@ -235,6 +223,36 @@ pkgCache::VerIterator pkgPolicy::GetCandidateVer(pkgCache::PkgIterator const &Pk
 
    return Pref;
 }
 
    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);
+
+        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..              /*{{{*/
 // ---------------------------------------------------------------------
                                                                        /*}}}*/
 // Policy::CreatePin - Create an entry in the pin table..              /*{{{*/
 // ---------------------------------------------------------------------


@@ -302,6 +320,17 @@ void pkgPolicy::CreatePin(pkgVersionMatch::MatchType Type,string Name,
         P->Priority = Priority;
         P->Data = Data;
         matched = true;
         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;
+           }
+        }

       }
    }
 
       }
    }
 


@@ -336,35 +365,38 @@ pkgCache::VerIterator pkgPolicy::GetMatch(pkgCache::PkgIterator const &Pkg)
 APT_PURE signed short pkgPolicy::GetPriority(pkgCache::PkgIterator const &Pkg)
 {
    if (Pins[Pkg->ID].Type != pkgVersionMatch::None)
 APT_PURE 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 Pins[Pkg->ID].Priority;

-   }
-   

    return 0;
 }
    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];
 }
                                                                        /*}}}*/
 APT_PURE signed short pkgPolicy::GetPriority(pkgCache::PkgFileIterator const &File)
 {
    return PFPriority[File->ID];
 }
                                                                        /*}}}*/

-// PreferenceSection class - Overriding the default TrimRecord method  /*{{{*/
-// ---------------------------------------------------------------------
-/* The preference file is a user generated file so the parser should
-   therefore be a bit more friendly by allowing comments and new lines
-   all over the place rather than forcing a special format */
-class PreferenceSection : public pkgTagSection
-{
-   void TrimRecord(bool /*BeforeRecord*/, const char* &End)
-   {
-      for (; Stop < End && (Stop[0] == '\n' || Stop[0] == '\r' || Stop[0] == '#'); Stop++)
-        if (Stop[0] == '#')
-           Stop = (const char*) memchr(Stop,'\n',End-Stop);
-   }
-};
-                                                                       /*}}}*/

 // 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
 // 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


@@ -409,8 +441,8 @@ bool ReadPinFile(pkgPolicy &Plcy,string File)
    pkgTagFile TF(&Fd);
    if (_error->PendingError() == true)
       return false;
    pkgTagFile TF(&Fd);
    if (_error->PendingError() == true)
       return false;

-   
-   PreferenceSection Tags;
+
+   pkgUserTagSection Tags;

    while (TF.Step(Tags) == true)
    {
       // can happen when there are only comments in a record
    while (TF.Step(Tags) == true)
    {
       // can happen when there are only comments in a record


@@ -446,11 +478,18 @@ bool ReadPinFile(pkgPolicy &Plcy,string File)
       }
       for (; Word != End && isspace(*Word) != 0; Word++);
 
       }
       for (; Word != End && isspace(*Word) != 0; Word++);
 

-      short int priority = Tags.FindI("Pin-Priority", 0);
+      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)
       {
       if (priority == 0)
       {

-         _error->Warning(_("No priority (or zero) specified for pin"));
-         continue;
+         return _error->Error(_("No priority (or zero) specified for pin"));

       }
 
       istringstream s(Name);
       }
 
       istringstream s(Name);


@@ -466,3 +505,5 @@ bool ReadPinFile(pkgPolicy &Plcy,string File)
    return true;
 }
                                                                        /*}}}*/
    return true;
 }
                                                                        /*}}}*/

+
+pkgPolicy::~pkgPolicy() {delete [] PFPriority; delete [] Pins; delete [] VerPins; }