* add hook for MarkInstall and MarkDelete (closes: #470035)
[ntk/apt.git] / apt-pkg / policy.cc
CommitLineData
b2e465d6
AL
1// -*- mode: cpp; mode: fold -*-
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
35#include <iostream>
1c62ab24 36#include <sstream>
b2e465d6
AL
37 /*}}}*/
38
e7b470ee
AL
39using namespace std;
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. */
45pkgPolicy::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/* */
64bool 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. */
117pkgCache::VerIterator pkgPolicy::GetCandidateVer(pkgCache::PkgIterator Pkg)
118{
b2e465d6 119 // Look for a package pin and evaluate it.
af87ab54
AL
120 signed Max = GetPriority(Pkg);
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++)
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. */
178void 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
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/* */
215pkgCache::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/* */
229signed 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 /*}}}*/
81e9789b
MV
242// PreferenceSection class - Overriding the default TrimRecord method /*{{{*/
243// ---------------------------------------------------------------------
244/* The preference file is a user generated file so the parser should
245 therefore be a bit more friendly by allowing comments and new lines
246 all over the place rather than forcing a special format */
247class PreferenceSection : public pkgTagSection
248{
249 void TrimRecord(bool BeforeRecord, const char* &End)
250 {
251 for (; Stop < End && (Stop[0] == '\n' || Stop[0] == '\r' || Stop[0] == '#'); Stop++)
252 if (Stop[0] == '#')
253 Stop = (const char*) memchr(Stop,'\n',End-Stop);
254 }
255};
256 /*}}}*/
b2e465d6
AL
257// ReadPinFile - Load the pin file into a Policy /*{{{*/
258// ---------------------------------------------------------------------
259/* I'd like to see the preferences file store more than just pin information
260 but right now that is the only stuff I have to store. Later there will
261 have to be some kind of combined super parser to get the data into all
262 the right classes.. */
263bool ReadPinFile(pkgPolicy &Plcy,string File)
264{
265 if (File.empty() == true)
266 File = _config->FindFile("Dir::Etc::Preferences");
267
268 if (FileExists(File) == false)
269 return true;
270
271 FileFd Fd(File,FileFd::ReadOnly);
272 pkgTagFile TF(&Fd);
273 if (_error->PendingError() == true)
274 return false;
275
81e9789b 276 PreferenceSection Tags;
b2e465d6
AL
277 while (TF.Step(Tags) == true)
278 {
279 string Name = Tags.FindS("Package");
280 if (Name.empty() == true)
281 return _error->Error(_("Invalid record in the preferences file, no Package header"));
282 if (Name == "*")
283 Name = string();
284
285 const char *Start;
286 const char *End;
287 if (Tags.Find("Pin",Start,End) == false)
288 continue;
289
290 const char *Word = Start;
291 for (; Word != End && isspace(*Word) == 0; Word++);
292
293 // Parse the type..
294 pkgVersionMatch::MatchType Type;
295 if (stringcasecmp(Start,Word,"version") == 0 && Name.empty() == false)
296 Type = pkgVersionMatch::Version;
297 else if (stringcasecmp(Start,Word,"release") == 0)
298 Type = pkgVersionMatch::Release;
299 else if (stringcasecmp(Start,Word,"origin") == 0)
300 Type = pkgVersionMatch::Origin;
301 else
302 {
303 _error->Warning(_("Did not understand pin type %s"),string(Start,Word).c_str());
304 continue;
305 }
306 for (; Word != End && isspace(*Word) != 0; Word++);
307
56298634
AL
308 short int priority = Tags.FindI("Pin-Priority", 0);
309 if (priority == 0)
310 {
311 _error->Warning(_("No priority (or zero) specified for pin"));
312 continue;
313 }
314
1c62ab24
MV
315 istringstream s(Name);
316 string pkg;
317 while(!s.eof())
318 {
319 s >> pkg;
320 Plcy.CreatePin(Type, pkg, string(Word,End),priority);
321 };
b2e465d6
AL
322 }
323
324 Plcy.InitDefaults();
325 return true;
326}
327 /*}}}*/