]> git.saurik.com Git - apt.git/blame - ftparchive/cachedb.cc
fix a few typos in strings, comments and manpage of apt-ftparchive
[apt.git] / ftparchive / cachedb.cc
CommitLineData
b2e465d6
AL
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
c9569a1e 3// $Id: cachedb.cc,v 1.7 2004/05/08 19:41:01 mdz Exp $
b2e465d6
AL
4/* ######################################################################
5
6 CacheDB
7
8 Simple uniform interface to a cache database.
9
10 ##################################################################### */
11 /*}}}*/
12// Include Files /*{{{*/
b2e465d6
AL
13#include "cachedb.h"
14
dc738e7a 15#include <apti18n.h>
b2e465d6
AL
16#include <apt-pkg/error.h>
17#include <apt-pkg/md5.h>
cde41ae8
MV
18#include <apt-pkg/sha1.h>
19#include <apt-pkg/sha256.h>
b2e465d6
AL
20#include <apt-pkg/strutl.h>
21#include <apt-pkg/configuration.h>
22
23#include <netinet/in.h> // htonl, etc
24 /*}}}*/
25
26// CacheDB::ReadyDB - Ready the DB2 /*{{{*/
27// ---------------------------------------------------------------------
28/* This opens the DB2 file for caching package information */
9209ec47 29bool CacheDB::ReadyDB(string const &DB)
b2e465d6 30{
c9569a1e
AL
31 int err;
32
b2e465d6
AL
33 ReadOnly = _config->FindB("APT::FTPArchive::ReadOnlyDB",false);
34
35 // Close the old DB
36 if (Dbp != 0)
37 Dbp->close(Dbp,0);
38
39 /* Check if the DB was disabled while running and deal with a
40 corrupted DB */
41 if (DBFailed() == true)
42 {
dc738e7a 43 _error->Warning(_("DB was corrupted, file renamed to %s.old"),DBFile.c_str());
b2e465d6
AL
44 rename(DBFile.c_str(),(DBFile+".old").c_str());
45 }
46
47 DBLoaded = false;
48 Dbp = 0;
49 DBFile = string();
50
51 if (DB.empty())
52 return true;
c9569a1e
AL
53
54 db_create(&Dbp, NULL, 0);
cde41ae8 55 if ((err = Dbp->open(Dbp, NULL, DB.c_str(), NULL, DB_BTREE,
b2e465d6 56 (ReadOnly?DB_RDONLY:DB_CREATE),
c9569a1e 57 0644)) != 0)
b2e465d6 58 {
c9569a1e
AL
59 if (err == DB_OLD_VERSION)
60 {
61 _error->Warning(_("DB is old, attempting to upgrade %s"),DBFile.c_str());
62 err = Dbp->upgrade(Dbp, DB.c_str(), 0);
63 if (!err)
64 err = Dbp->open(Dbp, NULL, DB.c_str(), NULL, DB_HASH,
65 (ReadOnly?DB_RDONLY:DB_CREATE), 0644);
66
67 }
eb2bc4f2
MV
68 // the database format has changed from DB_HASH to DB_BTREE in
69 // apt 0.6.44
70 if (err == EINVAL)
71 {
c6474fb6 72 _error->Error(_("DB format is invalid. If you upgraded from an older version of apt, please remove and re-create the database."));
eb2bc4f2 73 }
c9569a1e
AL
74 if (err)
75 {
76 Dbp = 0;
77 return _error->Error(_("Unable to open DB file %s: %s"),DB.c_str(), db_strerror(err));
78 }
b2e465d6
AL
79 }
80
81 DBFile = DB;
82 DBLoaded = true;
83 return true;
84}
85 /*}}}*/
c6474fb6 86// CacheDB::OpenFile - Open the file /*{{{*/
b2e465d6 87// ---------------------------------------------------------------------
cde41ae8
MV
88/* */
89bool CacheDB::OpenFile()
90{
91 Fd = new FileFd(FileName,FileFd::ReadOnly);
92 if (_error->PendingError() == true)
93 {
94 delete Fd;
95 Fd = NULL;
96 return false;
97 }
98 return true;
99}
100 /*}}}*/
101// CacheDB::GetFileStat - Get stats from the file /*{{{*/
102// ---------------------------------------------------------------------
103/* This gets the size from the database if it's there. If we need
104 * to look at the file, also get the mtime from the file. */
ff574e76 105bool CacheDB::GetFileStat(bool const &doStat)
cde41ae8 106{
ff574e76 107 if ((CurStat.Flags & FlSize) == FlSize && doStat == false)
cde41ae8
MV
108 {
109 /* Already worked out the file size */
110 }
111 else
112 {
113 /* Get it from the file. */
114 if (Fd == NULL && OpenFile() == false)
115 {
116 return false;
117 }
118 // Stat the file
119 struct stat St;
120 if (fstat(Fd->Fd(),&St) != 0)
121 {
122 return _error->Errno("fstat",
123 _("Failed to stat %s"),FileName.c_str());
124 }
125 CurStat.FileSize = St.st_size;
126 CurStat.mtime = htonl(St.st_mtime);
127 CurStat.Flags |= FlSize;
128 }
129 return true;
130}
131 /*}}}*/
132// CacheDB::GetCurStat - Set the CurStat variable. /*{{{*/
133// ---------------------------------------------------------------------
134/* Sets the CurStat variable. Either to 0 if no database is used
135 * or to the value in the database if one is used */
136bool CacheDB::GetCurStat()
b2e465d6 137{
b2e465d6
AL
138 memset(&CurStat,0,sizeof(CurStat));
139
cde41ae8
MV
140 if (DBLoaded)
141 {
c6474fb6 142 /* First see if there is anything about it
cde41ae8 143 in the database */
b2e465d6 144
cde41ae8 145 /* Get the flags (and mtime) */
b2e465d6 146 InitQuery("st");
b2e465d6
AL
147 // Ensure alignment of the returned structure
148 Data.data = &CurStat;
149 Data.ulen = sizeof(CurStat);
150 Data.flags = DB_DBT_USERMEM;
cde41ae8 151 if (Get() == false)
b2e465d6 152 {
b2e465d6 153 CurStat.Flags = 0;
b2e465d6 154 }
cde41ae8
MV
155 CurStat.Flags = ntohl(CurStat.Flags);
156 CurStat.FileSize = ntohl(CurStat.FileSize);
b2e465d6 157 }
cde41ae8
MV
158 return true;
159}
160 /*}}}*/
161// CacheDB::GetFileInfo - Get all the info about the file /*{{{*/
162// ---------------------------------------------------------------------
9209ec47
DK
163bool CacheDB::GetFileInfo(string const &FileName, bool const &DoControl, bool const &DoContents,
164 bool const &GenContentsOnly, bool const &DoMD5, bool const &DoSHA1,
165 bool const &DoSHA256, bool const &checkMtime)
cde41ae8
MV
166{
167 this->FileName = FileName;
168
169 if (GetCurStat() == false)
b2e465d6 170 {
cde41ae8 171 return false;
b2e465d6 172 }
b2e465d6 173 OldStat = CurStat;
ff574e76
DK
174
175 if (GetFileStat(checkMtime) == false)
cde41ae8
MV
176 {
177 delete Fd;
178 Fd = NULL;
179 return false;
180 }
181
ff574e76
DK
182 /* if mtime changed, update CurStat from disk */
183 if (checkMtime == true && OldStat.mtime != CurStat.mtime)
184 CurStat.Flags = FlSize;
185
cde41ae8
MV
186 Stats.Bytes += CurStat.FileSize;
187 Stats.Packages++;
188
2a5f8389
DK
189 if ((DoControl && LoadControl() == false)
190 || (DoContents && LoadContents(GenContentsOnly) == false)
191 || (DoMD5 && GetMD5(false) == false)
192 || (DoSHA1 && GetSHA1(false) == false)
193 || (DoSHA256 && GetSHA256(false) == false))
cde41ae8
MV
194 {
195 delete Fd;
196 Fd = NULL;
197 delete DebFile;
198 DebFile = NULL;
199 return false;
200 }
201
202 delete Fd;
203 Fd = NULL;
204 delete DebFile;
205 DebFile = NULL;
206
b2e465d6
AL
207 return true;
208}
209 /*}}}*/
210// CacheDB::LoadControl - Load Control information /*{{{*/
211// ---------------------------------------------------------------------
212/* */
213bool CacheDB::LoadControl()
214{
215 // Try to read the control information out of the DB.
216 if ((CurStat.Flags & FlControl) == FlControl)
217 {
218 // Lookup the control information
219 InitQuery("cl");
220 if (Get() == true && Control.TakeControl(Data.data,Data.size) == true)
221 return true;
222 CurStat.Flags &= ~FlControl;
223 }
224
cde41ae8
MV
225 if (Fd == NULL && OpenFile() == false)
226 {
227 return false;
228 }
b2e465d6
AL
229 // Create a deb instance to read the archive
230 if (DebFile == 0)
231 {
232 DebFile = new debDebFile(*Fd);
233 if (_error->PendingError() == true)
234 return false;
235 }
236
237 Stats.Misses++;
238 if (Control.Read(*DebFile) == false)
239 return false;
240
241 if (Control.Control == 0)
dc738e7a 242 return _error->Error(_("Archive has no control record"));
b2e465d6
AL
243
244 // Write back the control information
245 InitQuery("cl");
246 if (Put(Control.Control,Control.Length) == true)
247 CurStat.Flags |= FlControl;
248 return true;
249}
250 /*}}}*/
251// CacheDB::LoadContents - Load the File Listing /*{{{*/
252// ---------------------------------------------------------------------
253/* */
9209ec47 254bool CacheDB::LoadContents(bool const &GenOnly)
b2e465d6
AL
255{
256 // Try to read the control information out of the DB.
257 if ((CurStat.Flags & FlContents) == FlContents)
258 {
259 if (GenOnly == true)
260 return true;
261
262 // Lookup the contents information
263 InitQuery("cn");
264 if (Get() == true)
265 {
266 if (Contents.TakeContents(Data.data,Data.size) == true)
267 return true;
268 }
269
270 CurStat.Flags &= ~FlContents;
271 }
272
cde41ae8
MV
273 if (Fd == NULL && OpenFile() == false)
274 {
275 return false;
276 }
b2e465d6
AL
277 // Create a deb instance to read the archive
278 if (DebFile == 0)
279 {
280 DebFile = new debDebFile(*Fd);
281 if (_error->PendingError() == true)
282 return false;
283 }
284
285 if (Contents.Read(*DebFile) == false)
286 return false;
287
288 // Write back the control information
289 InitQuery("cn");
290 if (Put(Contents.Data,Contents.CurSize) == true)
291 CurStat.Flags |= FlContents;
292 return true;
293}
294 /*}}}*/
cde41ae8
MV
295
296static string bytes2hex(uint8_t *bytes, size_t length) {
297 char space[65];
298 if (length * 2 > sizeof(space) - 1) length = (sizeof(space) - 1) / 2;
299 for (size_t i = 0; i < length; i++)
300 snprintf(&space[i*2], 3, "%02x", bytes[i]);
301 return string(space);
302}
303
9209ec47 304static inline unsigned char xdig2num(char const &dig) {
cde41ae8
MV
305 if (isdigit(dig)) return dig - '0';
306 if ('a' <= dig && dig <= 'f') return dig - 'a' + 10;
307 if ('A' <= dig && dig <= 'F') return dig - 'A' + 10;
308 return 0;
309}
310
311static void hex2bytes(uint8_t *bytes, const char *hex, int length) {
312 while (length-- > 0) {
313 *bytes = 0;
314 if (isxdigit(hex[0]) && isxdigit(hex[1])) {
315 *bytes = xdig2num(hex[0]) * 16 + xdig2num(hex[1]);
316 hex += 2;
317 }
318 bytes++;
319 }
320}
321
b2e465d6
AL
322// CacheDB::GetMD5 - Get the MD5 hash /*{{{*/
323// ---------------------------------------------------------------------
324/* */
9209ec47 325bool CacheDB::GetMD5(bool const &GenOnly)
b2e465d6
AL
326{
327 // Try to read the control information out of the DB.
328 if ((CurStat.Flags & FlMD5) == FlMD5)
329 {
330 if (GenOnly == true)
331 return true;
332
cde41ae8 333 MD5Res = bytes2hex(CurStat.MD5, sizeof(CurStat.MD5));
b2e465d6
AL
334 return true;
335 }
b2e465d6 336
cde41ae8 337 Stats.MD5Bytes += CurStat.FileSize;
b2e465d6 338
cde41ae8
MV
339 if (Fd == NULL && OpenFile() == false)
340 {
341 return false;
342 }
b2e465d6 343 MD5Summation MD5;
cde41ae8 344 if (Fd->Seek(0) == false || MD5.AddFD(Fd->Fd(),CurStat.FileSize) == false)
b2e465d6
AL
345 return false;
346
347 MD5Res = MD5.Result();
cde41ae8 348 hex2bytes(CurStat.MD5, MD5Res.data(), sizeof(CurStat.MD5));
b2e465d6
AL
349 CurStat.Flags |= FlMD5;
350 return true;
351}
352 /*}}}*/
cde41ae8
MV
353// CacheDB::GetSHA1 - Get the SHA1 hash /*{{{*/
354// ---------------------------------------------------------------------
355/* */
9209ec47 356bool CacheDB::GetSHA1(bool const &GenOnly)
cde41ae8
MV
357{
358 // Try to read the control information out of the DB.
359 if ((CurStat.Flags & FlSHA1) == FlSHA1)
360 {
361 if (GenOnly == true)
362 return true;
363
364 SHA1Res = bytes2hex(CurStat.SHA1, sizeof(CurStat.SHA1));
365 return true;
366 }
367
368 Stats.SHA1Bytes += CurStat.FileSize;
369
370 if (Fd == NULL && OpenFile() == false)
371 {
372 return false;
373 }
374 SHA1Summation SHA1;
375 if (Fd->Seek(0) == false || SHA1.AddFD(Fd->Fd(),CurStat.FileSize) == false)
376 return false;
377
378 SHA1Res = SHA1.Result();
379 hex2bytes(CurStat.SHA1, SHA1Res.data(), sizeof(CurStat.SHA1));
380 CurStat.Flags |= FlSHA1;
381 return true;
382}
383 /*}}}*/
384// CacheDB::GetSHA256 - Get the SHA256 hash /*{{{*/
385// ---------------------------------------------------------------------
386/* */
9209ec47 387bool CacheDB::GetSHA256(bool const &GenOnly)
cde41ae8
MV
388{
389 // Try to read the control information out of the DB.
390 if ((CurStat.Flags & FlSHA256) == FlSHA256)
391 {
392 if (GenOnly == true)
393 return true;
394
395 SHA256Res = bytes2hex(CurStat.SHA256, sizeof(CurStat.SHA256));
396 return true;
397 }
398
399 Stats.SHA256Bytes += CurStat.FileSize;
400
401 if (Fd == NULL && OpenFile() == false)
402 {
403 return false;
404 }
405 SHA256Summation SHA256;
406 if (Fd->Seek(0) == false || SHA256.AddFD(Fd->Fd(),CurStat.FileSize) == false)
407 return false;
408
409 SHA256Res = SHA256.Result();
410 hex2bytes(CurStat.SHA256, SHA256Res.data(), sizeof(CurStat.SHA256));
411 CurStat.Flags |= FlSHA256;
412 return true;
413}
414 /*}}}*/
b2e465d6
AL
415// CacheDB::Finish - Write back the cache structure /*{{{*/
416// ---------------------------------------------------------------------
417/* */
418bool CacheDB::Finish()
419{
420 // Optimize away some writes.
421 if (CurStat.Flags == OldStat.Flags &&
9bfe66dc 422 CurStat.mtime == OldStat.mtime)
b2e465d6
AL
423 return true;
424
425 // Write the stat information
426 CurStat.Flags = htonl(CurStat.Flags);
cde41ae8 427 CurStat.FileSize = htonl(CurStat.FileSize);
b2e465d6
AL
428 InitQuery("st");
429 Put(&CurStat,sizeof(CurStat));
430 CurStat.Flags = ntohl(CurStat.Flags);
cde41ae8
MV
431 CurStat.FileSize = ntohl(CurStat.FileSize);
432
b2e465d6
AL
433 return true;
434}
435 /*}}}*/
436// CacheDB::Clean - Clean the Database /*{{{*/
437// ---------------------------------------------------------------------
438/* Tidy the database by removing files that no longer exist at all. */
439bool CacheDB::Clean()
440{
441 if (DBLoaded == false)
442 return true;
443
444 /* I'm not sure what VERSION_MINOR should be here.. 2.4.14 certainly
445 needs the lower one and 2.7.7 needs the upper.. */
b2e465d6 446 DBC *Cursor;
c9569a1e 447 if ((errno = Dbp->cursor(Dbp, NULL, &Cursor, 0)) != 0)
dc738e7a 448 return _error->Error(_("Unable to get a cursor"));
b2e465d6
AL
449
450 DBT Key;
451 DBT Data;
452 memset(&Key,0,sizeof(Key));
453 memset(&Data,0,sizeof(Data));
454 while ((errno = Cursor->c_get(Cursor,&Key,&Data,DB_NEXT)) == 0)
455 {
592b401a
MV
456 const char *Colon = (char*)memrchr(Key.data, ':', Key.size);
457 if (Colon)
b2e465d6 458 {
592b401a
MV
459 if (stringcmp(Colon + 1, (char *)Key.data+Key.size,"st") == 0 ||
460 stringcmp(Colon + 1, (char *)Key.data+Key.size,"cl") == 0 ||
461 stringcmp(Colon + 1, (char *)Key.data+Key.size,"cn") == 0)
b2e465d6 462 {
592b401a 463 if (FileExists(string((const char *)Key.data,Colon)) == true)
b2e465d6
AL
464 continue;
465 }
466 }
467
468 Cursor->c_del(Cursor,0);
469 }
09fab244 470 Dbp->compact(Dbp, NULL, NULL, NULL, NULL, DB_FREE_SPACE, NULL);
b2e465d6
AL
471
472 return true;
473}
474 /*}}}*/