apt-pkg/indexfile.cc

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: indexfile.cc,v 1.2.2.1 2003/12/24 23:09:17 mdz Exp $
   4 /* ######################################################################
   5
   6    Index File - Abstraction for an index of archive/souce file.
   7
   8    ##################################################################### */
   9                                                                         /*}}}*/
  10 // Include Files                                                        /*{{{*/
  11 #include<config.h>
  12
  13 #include <apt-pkg/configuration.h>
  14 #include <apt-pkg/indexfile.h>
  15 #include <apt-pkg/error.h>
  16 #include <apt-pkg/fileutl.h>
  17 #include <apt-pkg/aptconfiguration.h>
  18 #include <apt-pkg/pkgcache.h>
  19 #include <apt-pkg/pkgcachegen.h>
  20 #include <apt-pkg/cacheiterators.h>
  21 #include <apt-pkg/srcrecords.h>
  22 #include <apt-pkg/strutl.h>
  23 #include <apt-pkg/progress.h>
  24 #include <apt-pkg/deblistparser.h>
  25 #include <apt-pkg/macros.h>
  26
  27 #include <apt-pkg/debindexfile.h>
  28
  29 #include <sys/stat.h>
  30
  31 #include <string>
  32 #include <vector>
  33 #include <clocale>
  34 #include <cstring>
  35 #include <memory>
  36                                                                         /*}}}*/
  37
  38 // Global list of Item supported
  39 static  pkgIndexFile::Type *ItmList[10];
  40 pkgIndexFile::Type **pkgIndexFile::Type::GlobalList = ItmList;
  41 unsigned long pkgIndexFile::Type::GlobalListLen = 0;
  42
  43 // Type::Type - Constructor                                             /*{{{*/
  44 // ---------------------------------------------------------------------
  45 /* */
  46 pkgIndexFile::Type::Type()
  47 {
  48    ItmList[GlobalListLen] = this;
  49    GlobalListLen++;
  50    Label = NULL;
  51 }
  52                                                                         /*}}}*/
  53 // Type::GetType - Locate the type by name                              /*{{{*/
  54 // ---------------------------------------------------------------------
  55 /* */
  56 pkgIndexFile::Type *pkgIndexFile::Type::GetType(const char *Type)
  57 {
  58    for (unsigned I = 0; I != GlobalListLen; I++)
  59       if (strcmp(GlobalList[I]->Label,Type) == 0)
  60          return GlobalList[I];
  61    return 0;
  62 }
  63                                                                         /*}}}*/
  64 pkgIndexFile::pkgIndexFile(bool const Trusted) :                        /*{{{*/
  65    d(NULL), Trusted(Trusted)
  66 {
  67 }
  68                                                                         /*}}}*/
  69 // IndexFile::ArchiveInfo - Stub                                        /*{{{*/
  70 std::string pkgIndexFile::ArchiveInfo(pkgCache::VerIterator const &Ver) const
  71 {
  72    debDebPkgFileIndex const * const debfile = dynamic_cast<debDebPkgFileIndex const*>(this);
  73    if (debfile != nullptr)
  74       return debfile->ArchiveInfo_impl(Ver);
  75    return std::string();
  76 }
  77                                                                         /*}}}*/
  78 // IndexFile::FindInCache - Stub                                        /*{{{*/
  79 pkgCache::PkgFileIterator pkgIndexFile::FindInCache(pkgCache &Cache) const
  80 {
  81    return pkgCache::PkgFileIterator(Cache);
  82 }
  83                                                                         /*}}}*/
  84 // IndexFile::SourceIndex - Stub                                        /*{{{*/
  85 std::string pkgIndexFile::SourceInfo(pkgSrcRecords::Parser const &/*Record*/,
  86                                 pkgSrcRecords::File const &/*File*/) const
  87 {
  88    return std::string();
  89 }
  90                                                                         /*}}}*/
  91 // IndexFile::TranslationsAvailable - Check if will use Translation     /*{{{*/
  92 bool pkgIndexFile::TranslationsAvailable() {
  93         return (APT::Configuration::getLanguages().empty() != true);
  94 }
  95                                                                         /*}}}*/
  96 // IndexFile::CheckLanguageCode - Check the Language Code               /*{{{*/
  97 bool pkgIndexFile::CheckLanguageCode(const char * const Lang)
  98 {
  99   if (strlen(Lang) == 2 || (strlen(Lang) == 5 && Lang[2] == '_'))
 100     return true;
 101
 102   if (strcmp(Lang,"C") != 0)
 103     _error->Warning("Wrong language code %s", Lang);
 104
 105   return false;
 106 }
 107                                                                         /*}}}*/
 108 // IndexFile::LanguageCode - Return the Language Code                   /*{{{*/
 109 std::string pkgIndexFile::LanguageCode() {
 110 APT_IGNORE_DEPRECATED_PUSH
 111         if (TranslationsAvailable() == false)
 112                 return "";
 113         return APT::Configuration::getLanguages()[0];
 114 APT_IGNORE_DEPRECATED_POP
 115 }
 116                                                                         /*}}}*/
 117
 118 // IndexTarget - Constructor                                            /*{{{*/
 119 IndexTarget::IndexTarget(std::string const &MetaKey, std::string const &ShortDesc,
 120       std::string const &LongDesc, std::string const &URI, bool const IsOptional,
 121       bool const KeepCompressed, std::map<std::string, std::string> const &Options) :
 122    URI(URI), Description(LongDesc), ShortDesc(ShortDesc), MetaKey(MetaKey),
 123    IsOptional(IsOptional), KeepCompressed(KeepCompressed), Options(Options)
 124 {
 125 }
 126                                                                         /*}}}*/
 127 std::string IndexTarget::Option(OptionKeys const EnumKey) const         /*{{{*/
 128 {
 129    std::string Key;
 130    switch (EnumKey)
 131    {
 132 #define APT_CASE(X) case X: Key = #X; break
 133       APT_CASE(SITE);
 134       APT_CASE(RELEASE);
 135       APT_CASE(COMPONENT);
 136       APT_CASE(LANGUAGE);
 137       APT_CASE(ARCHITECTURE);
 138       APT_CASE(BASE_URI);
 139       APT_CASE(REPO_URI);
 140       APT_CASE(IDENTIFIER);
 141       APT_CASE(TARGET_OF);
 142       APT_CASE(CREATED_BY);
 143       APT_CASE(FALLBACK_OF);
 144       APT_CASE(PDIFFS);
 145       APT_CASE(DEFAULTENABLED);
 146       APT_CASE(COMPRESSIONTYPES);
 147       APT_CASE(SOURCESENTRY);
 148       APT_CASE(BY_HASH);
 149       APT_CASE(KEEPCOMPRESSEDAS);
 150       APT_CASE(ALLOW_INSECURE);
 151       APT_CASE(ALLOW_WEAK);
 152       APT_CASE(ALLOW_DOWNGRADE_TO_INSECURE);
 153 #undef APT_CASE
 154       case FILENAME:
 155       {
 156          auto const M = Options.find("FILENAME");
 157          if (M == Options.end())
 158             return _config->FindDir("Dir::State::lists") + URItoFileName(URI);
 159          return M->second;
 160       }
 161       case EXISTING_FILENAME:
 162          std::string const filename = Option(FILENAME);
 163          std::vector<std::string> const types = VectorizeString(Option(COMPRESSIONTYPES), ' ');
 164          for (std::vector<std::string>::const_iterator t = types.begin(); t != types.end(); ++t)
 165          {
 166             if (t->empty())
 167                continue;
 168             std::string const file = (*t == "uncompressed") ? filename : (filename + "." + *t);
 169             if (FileExists(file))
 170                return file;
 171          }
 172          return "";
 173    }
 174    std::map<std::string,std::string>::const_iterator const M = Options.find(Key);
 175    if (M == Options.end())
 176       return "";
 177    return M->second;
 178 }
 179                                                                         /*}}}*/
 180 bool IndexTarget::OptionBool(OptionKeys const EnumKey) const            /*{{{*/
 181 {
 182    return StringToBool(Option(EnumKey), false);
 183 }
 184                                                                         /*}}}*/
 185 std::string IndexTarget::Format(std::string format) const               /*{{{*/
 186 {
 187    for (std::map<std::string, std::string>::const_iterator O = Options.begin(); O != Options.end(); ++O)
 188    {
 189       format = SubstVar(format, std::string("$(") + O->first + ")", O->second);
 190    }
 191    format = SubstVar(format, "$(METAKEY)", MetaKey);
 192    format = SubstVar(format, "$(SHORTDESC)", ShortDesc);
 193    format = SubstVar(format, "$(DESCRIPTION)", Description);
 194    format = SubstVar(format, "$(URI)", URI);
 195    format = SubstVar(format, "$(FILENAME)", Option(IndexTarget::FILENAME));
 196    return format;
 197 }
 198                                                                         /*}}}*/
 199
 200 pkgDebianIndexTargetFile::pkgDebianIndexTargetFile(IndexTarget const &Target, bool const Trusted) :/*{{{*/
 201    pkgDebianIndexFile(Trusted), d(NULL), Target(Target)
 202 {
 203 }
 204                                                                         /*}}}*/
 205 std::string pkgDebianIndexTargetFile::ArchiveURI(std::string const &File) const/*{{{*/
 206 {
 207    return Target.Option(IndexTarget::REPO_URI) + File;
 208 }
 209                                                                         /*}}}*/
 210 std::string pkgDebianIndexTargetFile::Describe(bool const Short) const  /*{{{*/
 211 {
 212    if (Short)
 213       return Target.Description;
 214    return Target.Description + " (" + IndexFileName() + ")";
 215 }
 216                                                                         /*}}}*/
 217 std::string pkgDebianIndexTargetFile::IndexFileName() const                     /*{{{*/
 218 {
 219    std::string const s = Target.Option(IndexTarget::FILENAME);
 220    if (FileExists(s))
 221       return s;
 222
 223    std::vector<std::string> const types = VectorizeString(Target.Option(IndexTarget::COMPRESSIONTYPES), ' ');
 224    for (std::vector<std::string>::const_iterator t = types.begin(); t != types.end(); ++t)
 225    {
 226       std::string p = s + '.' + *t;
 227       if (FileExists(p))
 228          return p;
 229    }
 230    return s;
 231 }
 232                                                                         /*}}}*/
 233 unsigned long pkgDebianIndexTargetFile::Size() const                            /*{{{*/
 234 {
 235    unsigned long size = 0;
 236
 237    /* we need to ignore errors here; if the lists are absent, just return 0 */
 238    _error->PushToStack();
 239
 240    FileFd f(IndexFileName(), FileFd::ReadOnly, FileFd::Extension);
 241    if (!f.Failed())
 242       size = f.Size();
 243
 244    if (_error->PendingError() == true)
 245        size = 0;
 246    _error->RevertToStack();
 247
 248    return size;
 249 }
 250                                                                         /*}}}*/
 251 bool pkgDebianIndexTargetFile::Exists() const                                   /*{{{*/
 252 {
 253    return FileExists(IndexFileName());
 254 }
 255                                                                         /*}}}*/
 256 std::string pkgDebianIndexTargetFile::GetArchitecture() const                   /*{{{*/
 257 {
 258    return Target.Option(IndexTarget::ARCHITECTURE);
 259 }
 260                                                                         /*}}}*/
 261 std::string pkgDebianIndexTargetFile::GetComponent() const                      /*{{{*/
 262 {
 263    return Target.Option(IndexTarget::COMPONENT);
 264 }
 265                                                                         /*}}}*/
 266 bool pkgDebianIndexTargetFile::OpenListFile(FileFd &Pkg, std::string const &FileName)/*{{{*/
 267 {
 268    if (Pkg.Open(FileName, FileFd::ReadOnly, FileFd::Extension) == false)
 269       return _error->Error("Problem opening %s",FileName.c_str());
 270    return true;
 271 }
 272                                                                         /*}}}*/
 273 std::string pkgDebianIndexTargetFile::GetProgressDescription() const
 274 {
 275    return Target.Description;
 276 }
 277
 278 pkgDebianIndexRealFile::pkgDebianIndexRealFile(std::string const &pFile, bool const Trusted) :/*{{{*/
 279    pkgDebianIndexFile(Trusted), d(NULL)
 280 {
 281    if (pFile.empty())
 282       ;
 283    else if (pFile == "/nonexistent/stdin")
 284       File = pFile;
 285    else
 286       File = flAbsPath(pFile);
 287 }
 288                                                                         /*}}}*/
 289 // IndexRealFile::Size - Return the size of the index                   /*{{{*/
 290 unsigned long pkgDebianIndexRealFile::Size() const
 291 {
 292    struct stat S;
 293    if (stat(File.c_str(),&S) != 0)
 294       return 0;
 295    return S.st_size;
 296 }
 297                                                                         /*}}}*/
 298 bool pkgDebianIndexRealFile::Exists() const                                     /*{{{*/
 299 {
 300    return FileExists(File);
 301 }
 302                                                                         /*}}}*/
 303 std::string pkgDebianIndexRealFile::Describe(bool const /*Short*/) const/*{{{*/
 304 {
 305    return File;
 306 }
 307                                                                         /*}}}*/
 308 std::string pkgDebianIndexRealFile::ArchiveURI(std::string const &/*File*/) const/*{{{*/
 309 {
 310    return "file:" + File;
 311 }
 312                                                                         /*}}}*/
 313 std::string pkgDebianIndexRealFile::IndexFileName() const                       /*{{{*/
 314 {
 315    return File;
 316 }
 317                                                                         /*}}}*/
 318 std::string pkgDebianIndexRealFile::GetProgressDescription() const
 319 {
 320    return File;
 321 }
 322 bool pkgDebianIndexRealFile::OpenListFile(FileFd &Pkg, std::string const &FileName)/*{{{*/
 323 {
 324    if (Pkg.Open(FileName, FileFd::ReadOnly, FileFd::Extension) == false)
 325       return _error->Error("Problem opening %s",FileName.c_str());
 326    return true;
 327 }
 328                                                                         /*}}}*/
 329
 330 pkgDebianIndexFile::pkgDebianIndexFile(bool const Trusted) : pkgIndexFile(Trusted)
 331 {
 332 }
 333 pkgDebianIndexFile::~pkgDebianIndexFile()
 334 {
 335 }
 336 pkgCacheListParser * pkgDebianIndexFile::CreateListParser(FileFd &Pkg)
 337 {
 338    if (Pkg.IsOpen() == false)
 339       return nullptr;
 340    _error->PushToStack();
 341    pkgCacheListParser * const Parser = new debListParser(&Pkg);
 342    bool const newError = _error->PendingError();
 343    _error->MergeWithStack();
 344    if (newError)
 345    {
 346       delete Parser;
 347       _error->ReturnError();
 348       return nullptr;
 349    }
 350    else
 351       return Parser;
 352 }
 353 bool pkgDebianIndexFile::Merge(pkgCacheGenerator &Gen,OpProgress * const Prog)
 354 {
 355    std::string const PackageFile = IndexFileName();
 356    FileFd Pkg;
 357    if (OpenListFile(Pkg, PackageFile) == false)
 358       return false;
 359    _error->PushToStack();
 360    std::unique_ptr<pkgCacheListParser> Parser(CreateListParser(Pkg));
 361    bool const newError = _error->PendingError();
 362    _error->MergeWithStack();
 363    if (newError == false && Parser == nullptr)
 364       return true;
 365    if (Parser == NULL)
 366       return false;
 367
 368    if (Prog != NULL)
 369       Prog->SubProgress(0, GetProgressDescription());
 370
 371    if (Gen.SelectFile(PackageFile, *this, GetArchitecture(), GetComponent(), GetIndexFlags()) == false)
 372       return _error->Error("Problem with SelectFile %s",PackageFile.c_str());
 373
 374    // Store the IMS information
 375    pkgCache::PkgFileIterator File = Gen.GetCurFile();
 376    pkgCacheGenerator::Dynamic<pkgCache::PkgFileIterator> DynFile(File);
 377    File->Size = Pkg.FileSize();
 378    File->mtime = Pkg.ModificationTime();
 379
 380    if (Gen.MergeList(*Parser) == false)
 381       return _error->Error("Problem with MergeList %s",PackageFile.c_str());
 382    return true;
 383 }
 384 pkgCache::PkgFileIterator pkgDebianIndexFile::FindInCache(pkgCache &Cache) const
 385 {
 386    std::string const FileName = IndexFileName();
 387    pkgCache::PkgFileIterator File = Cache.FileBegin();
 388    for (; File.end() == false; ++File)
 389    {
 390        if (File.FileName() == NULL || FileName != File.FileName())
 391          continue;
 392
 393       struct stat St;
 394       if (stat(File.FileName(),&St) != 0)
 395       {
 396          if (_config->FindB("Debug::pkgCacheGen", false))
 397             std::clog << "DebianIndexFile::FindInCache - stat failed on " << File.FileName() << std::endl;
 398          return pkgCache::PkgFileIterator(Cache);
 399       }
 400       if ((map_filesize_t)St.st_size != File->Size || St.st_mtime != File->mtime)
 401       {
 402          if (_config->FindB("Debug::pkgCacheGen", false))
 403             std::clog << "DebianIndexFile::FindInCache - size (" << St.st_size << " <> " << File->Size
 404                         << ") or mtime (" << St.st_mtime << " <> " << File->mtime
 405                         << ") doesn't match for " << File.FileName() << std::endl;
 406          return pkgCache::PkgFileIterator(Cache);
 407       }
 408       return File;
 409    }
 410
 411    return File;
 412 }
 413
 414 APT_CONST pkgIndexFile::~pkgIndexFile() {}
 415 APT_CONST pkgDebianIndexTargetFile::~pkgDebianIndexTargetFile() {}
 416 APT_CONST pkgDebianIndexRealFile::~pkgDebianIndexRealFile() {}