ftparchive/cachedb.cc

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: cachedb.cc,v 1.7 2004/05/08 19:41:01 mdz Exp $
   4 /* ######################################################################
   5
   6    CacheDB
   7
   8    Simple uniform interface to a cache database.
   9
  10    ##################################################################### */
  11                                                                         /*}}}*/
  12 // Include Files                                                        /*{{{*/
  13 #include <config.h>
  14
  15 #include <apt-pkg/error.h>
  16 #include <apt-pkg/md5.h>
  17 #include <apt-pkg/sha1.h>
  18 #include <apt-pkg/sha2.h>
  19 #include <apt-pkg/strutl.h>
  20 #include <apt-pkg/configuration.h>
  21 #include <apt-pkg/fileutl.h>
  22 #include <apt-pkg/debfile.h>
  23 #include <apt-pkg/gpgv.h>
  24 #include <apt-pkg/hashes.h>
  25
  26 #include <netinet/in.h>       // htonl, etc
  27 #include <ctype.h>
  28 #include <stddef.h>
  29 #include <sys/stat.h>
  30 #include <strings.h>
  31
  32 #include "cachedb.h"
  33
  34 #include <apti18n.h>
  35                                                                         /*}}}*/
  36
  37 CacheDB::CacheDB(std::string const &DB)
  38    : Dbp(0), Fd(NULL), DebFile(0)
  39 {
  40    TmpKey[0]='\0';
  41    ReadyDB(DB);
  42 }
  43
  44 CacheDB::~CacheDB()
  45 {
  46    ReadyDB();
  47    delete DebFile;
  48 }
  49
  50 // CacheDB::ReadyDB - Ready the DB2                                     /*{{{*/
  51 // ---------------------------------------------------------------------
  52 /* This opens the DB2 file for caching package information */
  53 bool CacheDB::ReadyDB(std::string const &DB)
  54 {
  55    int err;
  56
  57    ReadOnly = _config->FindB("APT::FTPArchive::ReadOnlyDB",false);
  58
  59    // Close the old DB
  60    if (Dbp != 0)
  61       Dbp->close(Dbp,0);
  62
  63    /* Check if the DB was disabled while running and deal with a
  64       corrupted DB */
  65    if (DBFailed() == true)
  66    {
  67       _error->Warning(_("DB was corrupted, file renamed to %s.old"),DBFile.c_str());
  68       rename(DBFile.c_str(),(DBFile+".old").c_str());
  69    }
  70
  71    DBLoaded = false;
  72    Dbp = 0;
  73    DBFile = std::string();
  74
  75    if (DB.empty())
  76       return true;
  77
  78    db_create(&Dbp, NULL, 0);
  79    if ((err = Dbp->open(Dbp, NULL, DB.c_str(), NULL, DB_BTREE,
  80                         (ReadOnly?DB_RDONLY:DB_CREATE),
  81                         0644)) != 0)
  82    {
  83       if (err == DB_OLD_VERSION)
  84       {
  85           _error->Warning(_("DB is old, attempting to upgrade %s"),DBFile.c_str());
  86           err = Dbp->upgrade(Dbp, DB.c_str(), 0);
  87           if (!err)
  88              err = Dbp->open(Dbp, NULL, DB.c_str(), NULL, DB_HASH,
  89                             (ReadOnly?DB_RDONLY:DB_CREATE), 0644);
  90
  91       }
  92       // the database format has changed from DB_HASH to DB_BTREE in
  93       // apt 0.6.44
  94       if (err == EINVAL)
  95       {
  96          _error->Error(_("DB format is invalid. If you upgraded from an older version of apt, please remove and re-create the database."));
  97       }
  98       if (err)
  99       {
 100           Dbp = 0;
 101           return _error->Error(_("Unable to open DB file %s: %s"),DB.c_str(), db_strerror(err));
 102       }
 103    }
 104
 105    DBFile = DB;
 106    DBLoaded = true;
 107    return true;
 108 }
 109                                                                         /*}}}*/
 110 // CacheDB::OpenFile - Open the file                                    /*{{{*/
 111 // ---------------------------------------------------------------------
 112 /* */
 113 bool CacheDB::OpenFile()
 114 {
 115    // always close existing file first
 116    CloseFile();
 117
 118    // open a new file
 119    Fd = new FileFd(FileName,FileFd::ReadOnly);
 120    if (_error->PendingError() == true)
 121    {
 122       CloseFile();
 123       return false;
 124    }
 125    return true;
 126 }
 127                                                                         /*}}}*/
 128 // CacheDB::CloseFile - Close the file                                  /*{{{*/
 129 void CacheDB::CloseFile()
 130 {
 131    if(Fd != NULL)
 132    {
 133       delete Fd;
 134       Fd = NULL;
 135    }
 136 }
 137                                                                         /*}}}*/
 138 // CacheDB::OpenDebFile - Open a debfile                                /*{{{*/
 139 bool CacheDB::OpenDebFile()
 140 {
 141    // always close existing file first
 142    CloseDebFile();
 143
 144    // first open the fd, then pass it to the debDebFile
 145    if(OpenFile() == false)
 146       return false;
 147    DebFile = new debDebFile(*Fd);
 148    if (_error->PendingError() == true)
 149       return false;
 150    return true;
 151 }
 152                                                                         /*}}}*/
 153 // CacheDB::CloseDebFile - Close a debfile again                        /*{{{*/
 154 void CacheDB::CloseDebFile()
 155 {
 156    CloseFile();
 157
 158    if(DebFile != NULL)
 159    {
 160       delete DebFile;
 161       DebFile = NULL;
 162    }
 163 }
 164                                                                         /*}}}*/
 165 // CacheDB::GetFileStat - Get stats from the file                       /*{{{*/
 166 // ---------------------------------------------------------------------
 167 /* This gets the size from the database if it's there.  If we need
 168  * to look at the file, also get the mtime from the file. */
 169 bool CacheDB::GetFileStat(bool const &doStat)
 170 {
 171    if ((CurStat.Flags & FlSize) == FlSize && doStat == false)
 172       return true;
 173
 174    /* Get it from the file. */
 175    if (OpenFile() == false)
 176       return false;
 177
 178    // Stat the file
 179    struct stat St;
 180    if (fstat(Fd->Fd(),&St) != 0)
 181    {
 182       CloseFile();
 183       return _error->Errno("fstat",
 184                            _("Failed to stat %s"),FileName.c_str());
 185    }
 186    CurStat.FileSize = St.st_size;
 187    CurStat.mtime = htonl(St.st_mtime);
 188    CurStat.Flags |= FlSize;
 189
 190    return true;
 191 }
 192                                                                         /*}}}*/
 193 // CacheDB::GetCurStatCompatOldFormat                                   /*{{{*/
 194 // ---------------------------------------------------------------------
 195 /* Read the old (32bit FileSize) StateStore format from disk */
 196 bool CacheDB::GetCurStatCompatOldFormat()
 197 {
 198    InitQueryStats();
 199    Data.data = &CurStatOldFormat;
 200    Data.flags = DB_DBT_USERMEM;
 201    Data.ulen = sizeof(CurStatOldFormat);
 202    if (Get() == false)
 203    {
 204       CurStat.Flags = 0;
 205    } else {
 206       CurStat.Flags = CurStatOldFormat.Flags;
 207       CurStat.mtime = CurStatOldFormat.mtime;
 208       CurStat.FileSize = CurStatOldFormat.FileSize;
 209       memcpy(CurStat.MD5, CurStatOldFormat.MD5, sizeof(CurStat.MD5));
 210       memcpy(CurStat.SHA1, CurStatOldFormat.SHA1, sizeof(CurStat.SHA1));
 211       memcpy(CurStat.SHA256, CurStatOldFormat.SHA256, sizeof(CurStat.SHA256));
 212    }
 213    return true;
 214 }
 215                                                                         /*}}}*/
 216 // CacheDB::GetCurStatCompatOldFormat                                   /*{{{*/
 217 // ---------------------------------------------------------------------
 218 /* Read the new (64bit FileSize) StateStore format from disk */
 219 bool CacheDB::GetCurStatCompatNewFormat()
 220 {
 221    InitQueryStats();
 222    Data.data = &CurStat;
 223    Data.flags = DB_DBT_USERMEM;
 224    Data.ulen = sizeof(CurStat);
 225    if (Get() == false)
 226    {
 227       CurStat.Flags = 0;
 228    }
 229    return true;
 230 }
 231                                                                         /*}}}*/
 232 // CacheDB::GetCurStat - Set the CurStat variable.                      /*{{{*/
 233 // ---------------------------------------------------------------------
 234 /* Sets the CurStat variable.  Either to 0 if no database is used
 235  * or to the value in the database if one is used */
 236 bool CacheDB::GetCurStat()
 237 {
 238    memset(&CurStat,0,sizeof(CurStat));
 239
 240    if (DBLoaded)
 241    {
 242       // do a first query to just get the size of the data on disk
 243       InitQueryStats();
 244       Data.data = &CurStat;
 245       Data.flags = DB_DBT_USERMEM;
 246       Data.ulen = 0;
 247       Get();
 248
 249       if (Data.size == 0)
 250       {
 251          // nothing needs to be done, we just have not data for this deb
 252       }
 253       // check if the record is written in the old format (32bit filesize)
 254       else if(Data.size == sizeof(CurStatOldFormat))
 255       {
 256          GetCurStatCompatOldFormat();
 257       }
 258       else if(Data.size == sizeof(CurStat))
 259       {
 260          GetCurStatCompatNewFormat();
 261       } else {
 262          return _error->Error("Cache record size mismatch (%ul)", Data.size);
 263       }
 264
 265       CurStat.Flags = ntohl(CurStat.Flags);
 266       CurStat.FileSize = ntohl(CurStat.FileSize);
 267    }
 268    return true;
 269 }
 270                                                                         /*}}}*/
 271 // CacheDB::GetFileInfo - Get all the info about the file               /*{{{*/
 272 // ---------------------------------------------------------------------
 273 bool CacheDB::GetFileInfo(std::string const &FileName, bool const &DoControl, bool const &DoContents,
 274                                 bool const &GenContentsOnly, bool const DoSource, unsigned int const DoHashes,
 275                           bool const &checkMtime)
 276 {
 277    this->FileName = FileName;
 278
 279    if (GetCurStat() == false)
 280       return false;
 281    OldStat = CurStat;
 282
 283    if (GetFileStat(checkMtime) == false)
 284       return false;
 285
 286    /* if mtime changed, update CurStat from disk */
 287    if (checkMtime == true && OldStat.mtime != CurStat.mtime)
 288       CurStat.Flags = FlSize;
 289
 290    Stats.Bytes += CurStat.FileSize;
 291    ++Stats.Packages;
 292
 293    if ((DoControl && LoadControl() == false)
 294          || (DoContents && LoadContents(GenContentsOnly) == false)
 295          || (DoSource && LoadSource() == false)
 296          || (DoHashes != 0 && GetHashes(false, DoHashes) == false)
 297       )
 298    {
 299       return false;
 300    }
 301
 302    return true;
 303 }
 304                                                                         /*}}}*/
 305 bool CacheDB::LoadSource()                                              /*{{{*/
 306 {
 307    // Try to read the control information out of the DB.
 308    if ((CurStat.Flags & FlSource) == FlSource)
 309    {
 310       // Lookup the control information
 311       InitQuerySource();
 312       if (Get() == true && Dsc.TakeDsc(Data.data, Data.size) == true)
 313       {
 314             return true;
 315       }
 316       CurStat.Flags &= ~FlSource;
 317    }
 318    if (OpenFile() == false)
 319       return false;
 320
 321    Stats.Misses++;
 322    if (Dsc.Read(FileName) == false)
 323       return false;
 324
 325    if (Dsc.Length == 0)
 326       return _error->Error(_("Failed to read .dsc"));
 327
 328    // Write back the control information
 329    InitQuerySource();
 330    if (Put(Dsc.Data.c_str(), Dsc.Length) == true)
 331       CurStat.Flags |= FlSource;
 332
 333    return true;
 334 }
 335                                                                         /*}}}*/
 336 // CacheDB::LoadControl - Load Control information                      /*{{{*/
 337 // ---------------------------------------------------------------------
 338 /* */
 339 bool CacheDB::LoadControl()
 340 {
 341    // Try to read the control information out of the DB.
 342    if ((CurStat.Flags & FlControl) == FlControl)
 343    {
 344       // Lookup the control information
 345       InitQueryControl();
 346       if (Get() == true && Control.TakeControl(Data.data,Data.size) == true)
 347             return true;
 348       CurStat.Flags &= ~FlControl;
 349    }
 350
 351    if(OpenDebFile() == false)
 352       return false;
 353
 354    Stats.Misses++;
 355    if (Control.Read(*DebFile) == false)
 356       return false;
 357
 358    if (Control.Control == 0)
 359       return _error->Error(_("Archive has no control record"));
 360
 361    // Write back the control information
 362    InitQueryControl();
 363    if (Put(Control.Control,Control.Length) == true)
 364       CurStat.Flags |= FlControl;
 365    return true;
 366 }
 367                                                                         /*}}}*/
 368 // CacheDB::LoadContents - Load the File Listing                        /*{{{*/
 369 // ---------------------------------------------------------------------
 370 /* */
 371 bool CacheDB::LoadContents(bool const &GenOnly)
 372 {
 373    // Try to read the control information out of the DB.
 374    if ((CurStat.Flags & FlContents) == FlContents)
 375    {
 376       if (GenOnly == true)
 377          return true;
 378
 379       // Lookup the contents information
 380       InitQueryContent();
 381       if (Get() == true)
 382       {
 383          if (Contents.TakeContents(Data.data,Data.size) == true)
 384             return true;
 385       }
 386
 387       CurStat.Flags &= ~FlContents;
 388    }
 389
 390    if(OpenDebFile() == false)
 391       return false;
 392
 393    Stats.Misses++;
 394    if (Contents.Read(*DebFile) == false)
 395       return false;
 396
 397    // Write back the control information
 398    InitQueryContent();
 399    if (Put(Contents.Data,Contents.CurSize) == true)
 400       CurStat.Flags |= FlContents;
 401    return true;
 402 }
 403                                                                         /*}}}*/
 404 // CacheDB::GetHashes - Get the hashs                                   /*{{{*/
 405 static std::string bytes2hex(uint8_t *bytes, size_t length) {
 406    char buf[3];
 407    std::string space;
 408
 409    space.reserve(length*2 + 1);
 410    for (size_t i = 0; i < length; i++) {
 411       snprintf(buf, sizeof(buf), "%02x", bytes[i]);
 412       space.append(buf);
 413    }
 414    return space;
 415 }
 416
 417 static inline unsigned char xdig2num(char const &dig) {
 418    if (isdigit(dig)) return dig - '0';
 419    if ('a' <= dig && dig <= 'f') return dig - 'a' + 10;
 420    if ('A' <= dig && dig <= 'F') return dig - 'A' + 10;
 421    return 0;
 422 }
 423
 424 static void hex2bytes(uint8_t *bytes, const char *hex, int length) {
 425    while (length-- > 0) {
 426       *bytes = 0;
 427       if (isxdigit(hex[0]) && isxdigit(hex[1])) {
 428           *bytes = xdig2num(hex[0]) * 16 + xdig2num(hex[1]);
 429           hex += 2;
 430       }
 431       bytes++;
 432    }
 433 }
 434 bool CacheDB::GetHashes(bool const GenOnly, unsigned int const DoHashes)
 435 {
 436    unsigned int FlHashes = DoHashes & (Hashes::MD5SUM | Hashes::SHA1SUM | Hashes::SHA256SUM | Hashes::SHA512SUM);
 437    HashesList.clear();
 438
 439    if (FlHashes != 0)
 440    {
 441       if (OpenFile() == false)
 442          return false;
 443
 444       Hashes hashes;
 445       if (Fd->Seek(0) == false || hashes.AddFD(*Fd, CurStat.FileSize, FlHashes) == false)
 446          return false;
 447
 448       HashStringList hl = hashes.GetHashStringList();
 449       for (HashStringList::const_iterator hs = hl.begin(); hs != hl.end(); ++hs)
 450       {
 451          HashesList.push_back(*hs);
 452          if (strcasecmp(hs->HashType().c_str(), "SHA512") == 0)
 453          {
 454             Stats.SHA512Bytes += CurStat.FileSize;
 455             hex2bytes(CurStat.SHA512, hs->HashValue().data(), sizeof(CurStat.SHA512));
 456             CurStat.Flags |= FlSHA512;
 457          }
 458          else if (strcasecmp(hs->HashType().c_str(), "SHA256") == 0)
 459          {
 460             Stats.SHA256Bytes += CurStat.FileSize;
 461             hex2bytes(CurStat.SHA256, hs->HashValue().data(), sizeof(CurStat.SHA256));
 462             CurStat.Flags |= FlSHA256;
 463          }
 464          else if (strcasecmp(hs->HashType().c_str(), "SHA1") == 0)
 465          {
 466             Stats.SHA1Bytes += CurStat.FileSize;
 467             hex2bytes(CurStat.SHA1, hs->HashValue().data(), sizeof(CurStat.SHA1));
 468             CurStat.Flags |= FlSHA1;
 469          }
 470          else if (strcasecmp(hs->HashType().c_str(), "MD5Sum") == 0)
 471          {
 472             Stats.MD5Bytes += CurStat.FileSize;
 473             hex2bytes(CurStat.MD5, hs->HashValue().data(), sizeof(CurStat.MD5));
 474             CurStat.Flags |= FlMD5;
 475          }
 476          else if (strcasecmp(hs->HashType().c_str(), "Checksum-FileSize") == 0)
 477          {
 478             // we store it in a different field already
 479          }
 480          else
 481             return _error->Error("Got unknown unrequested hashtype %s", hs->HashType().c_str());
 482       }
 483    }
 484    if (GenOnly == true)
 485       return true;
 486
 487    return HashesList.push_back(HashString("MD5Sum", bytes2hex(CurStat.MD5, sizeof(CurStat.MD5)))) &&
 488       HashesList.push_back(HashString("SHA1", bytes2hex(CurStat.SHA1, sizeof(CurStat.SHA1)))) &&
 489       HashesList.push_back(HashString("SHA256", bytes2hex(CurStat.SHA256, sizeof(CurStat.SHA256)))) &&
 490       HashesList.push_back(HashString("SHA512", bytes2hex(CurStat.SHA512, sizeof(CurStat.SHA512))));
 491 }
 492                                                                         /*}}}*/
 493 // CacheDB::Finish - Write back the cache structure                     /*{{{*/
 494 // ---------------------------------------------------------------------
 495 /* */
 496 bool CacheDB::Finish()
 497 {
 498    // Optimize away some writes.
 499    if (CurStat.Flags == OldStat.Flags &&
 500        CurStat.mtime == OldStat.mtime)
 501       return true;
 502
 503    // Write the stat information
 504    CurStat.Flags = htonl(CurStat.Flags);
 505    CurStat.FileSize = htonl(CurStat.FileSize);
 506    InitQueryStats();
 507    Put(&CurStat,sizeof(CurStat));
 508    CurStat.Flags = ntohl(CurStat.Flags);
 509    CurStat.FileSize = ntohl(CurStat.FileSize);
 510
 511    return true;
 512 }
 513                                                                         /*}}}*/
 514 // CacheDB::Clean - Clean the Database                                  /*{{{*/
 515 // ---------------------------------------------------------------------
 516 /* Tidy the database by removing files that no longer exist at all. */
 517 bool CacheDB::Clean()
 518 {
 519    if (DBLoaded == false)
 520       return true;
 521
 522    /* I'm not sure what VERSION_MINOR should be here.. 2.4.14 certainly
 523       needs the lower one and 2.7.7 needs the upper.. */
 524    DBC *Cursor;
 525    if ((errno = Dbp->cursor(Dbp, NULL, &Cursor, 0)) != 0)
 526       return _error->Error(_("Unable to get a cursor"));
 527
 528    DBT Key;
 529    DBT Data;
 530    memset(&Key,0,sizeof(Key));
 531    memset(&Data,0,sizeof(Data));
 532    while ((errno = Cursor->c_get(Cursor,&Key,&Data,DB_NEXT)) == 0)
 533    {
 534       const char *Colon = (char*)memrchr(Key.data, ':', Key.size);
 535       if (Colon)
 536       {
 537          if (stringcmp(Colon + 1, (char *)Key.data+Key.size,"st") == 0 ||
 538              stringcmp(Colon + 1, (char *)Key.data+Key.size,"cl") == 0 ||
 539              stringcmp(Colon + 1, (char *)Key.data+Key.size,"cs") == 0 ||
 540              stringcmp(Colon + 1, (char *)Key.data+Key.size,"cn") == 0)
 541          {
 542             std::string FileName = std::string((const char *)Key.data,Colon);
 543             if (FileExists(FileName) == true) {
 544                 continue;
 545             }
 546          }
 547       }
 548       Cursor->c_del(Cursor,0);
 549    }
 550    int res = Dbp->compact(Dbp, NULL, NULL, NULL, NULL, DB_FREE_SPACE, NULL);
 551    if (res < 0)
 552       _error->Warning("compact failed with result %i", res);
 553
 554    if(_config->FindB("Debug::APT::FTPArchive::Clean", false) == true)
 555       Dbp->stat_print(Dbp, 0);
 556
 557
 558    return true;
 559 }
 560                                                                         /*}}}*/