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(TARGET_OF);
 141       APT_CASE(CREATED_BY);
 142       APT_CASE(PDIFFS);
 143       APT_CASE(DEFAULTENABLED);
 144       APT_CASE(COMPRESSIONTYPES);
 145       APT_CASE(SOURCESENTRY);
 146       APT_CASE(BY_HASH);
 147 #undef APT_CASE
 148       case FILENAME: return _config->FindDir("Dir::State::lists") + URItoFileName(URI);
 149       case EXISTING_FILENAME:
 150          std::string const filename = Option(FILENAME);
 151          std::vector<std::string> const types = VectorizeString(Option(COMPRESSIONTYPES), ' ');
 152          for (std::vector<std::string>::const_iterator t = types.begin(); t != types.end(); ++t)
 153          {
 154             if (t->empty())
 155                continue;
 156             std::string const file = (*t == "uncompressed") ? filename : (filename + "." + *t);
 157             if (FileExists(file))
 158                return file;
 159          }
 160          return "";
 161    }
 162    std::map<std::string,std::string>::const_iterator const M = Options.find(Key);
 163    if (M == Options.end())
 164       return "";
 165    return M->second;
 166 }
 167                                                                         /*}}}*/
 168 bool IndexTarget::OptionBool(OptionKeys const EnumKey) const            /*{{{*/
 169 {
 170    return StringToBool(Option(EnumKey));
 171 }
 172                                                                         /*}}}*/
 173 std::string IndexTarget::Format(std::string format) const               /*{{{*/
 174 {
 175    for (std::map<std::string, std::string>::const_iterator O = Options.begin(); O != Options.end(); ++O)
 176    {
 177       format = SubstVar(format, std::string("$(") + O->first + ")", O->second);
 178    }
 179    format = SubstVar(format, "$(METAKEY)", MetaKey);
 180    format = SubstVar(format, "$(SHORTDESC)", ShortDesc);
 181    format = SubstVar(format, "$(DESCRIPTION)", Description);
 182    format = SubstVar(format, "$(URI)", URI);
 183    format = SubstVar(format, "$(FILENAME)", Option(IndexTarget::FILENAME));
 184    return format;
 185 }
 186                                                                         /*}}}*/
 187
 188 pkgDebianIndexTargetFile::pkgDebianIndexTargetFile(IndexTarget const &Target, bool const Trusted) :/*{{{*/
 189    pkgDebianIndexFile(Trusted), d(NULL), Target(Target)
 190 {
 191 }
 192                                                                         /*}}}*/
 193 std::string pkgDebianIndexTargetFile::ArchiveURI(std::string const &File) const/*{{{*/
 194 {
 195    return Target.Option(IndexTarget::REPO_URI) + File;
 196 }
 197                                                                         /*}}}*/
 198 std::string pkgDebianIndexTargetFile::Describe(bool const Short) const  /*{{{*/
 199 {
 200    if (Short)
 201       return Target.Description;
 202    return Target.Description + " (" + IndexFileName() + ")";
 203 }
 204                                                                         /*}}}*/
 205 std::string pkgDebianIndexTargetFile::IndexFileName() const                     /*{{{*/
 206 {
 207    std::string const s = Target.Option(IndexTarget::FILENAME);
 208    if (FileExists(s))
 209       return s;
 210
 211    std::vector<std::string> const types = VectorizeString(Target.Option(IndexTarget::COMPRESSIONTYPES), ' ');
 212    for (std::vector<std::string>::const_iterator t = types.begin(); t != types.end(); ++t)
 213    {
 214       std::string p = s + '.' + *t;
 215       if (FileExists(p))
 216          return p;
 217    }
 218    return s;
 219 }
 220                                                                         /*}}}*/
 221 unsigned long pkgDebianIndexTargetFile::Size() const                            /*{{{*/
 222 {
 223    unsigned long size = 0;
 224
 225    /* we need to ignore errors here; if the lists are absent, just return 0 */
 226    _error->PushToStack();
 227
 228    FileFd f(IndexFileName(), FileFd::ReadOnly, FileFd::Extension);
 229    if (!f.Failed())
 230       size = f.Size();
 231
 232    if (_error->PendingError() == true)
 233        size = 0;
 234    _error->RevertToStack();
 235
 236    return size;
 237 }
 238                                                                         /*}}}*/
 239 bool pkgDebianIndexTargetFile::Exists() const                                   /*{{{*/
 240 {
 241    return FileExists(IndexFileName());
 242 }
 243                                                                         /*}}}*/
 244 std::string pkgDebianIndexTargetFile::GetArchitecture() const                   /*{{{*/
 245 {
 246    return Target.Option(IndexTarget::ARCHITECTURE);
 247 }
 248                                                                         /*}}}*/
 249 std::string pkgDebianIndexTargetFile::GetComponent() const                      /*{{{*/
 250 {
 251    return Target.Option(IndexTarget::COMPONENT);
 252 }
 253                                                                         /*}}}*/
 254 bool pkgDebianIndexTargetFile::OpenListFile(FileFd &Pkg, std::string const &FileName)/*{{{*/
 255 {
 256    if (Pkg.Open(FileName, FileFd::ReadOnly, FileFd::Extension) == false)
 257       return _error->Error("Problem opening %s",FileName.c_str());
 258    return true;
 259 }
 260                                                                         /*}}}*/
 261 std::string pkgDebianIndexTargetFile::GetProgressDescription() const
 262 {
 263    return Target.Description;
 264 }
 265
 266 pkgDebianIndexRealFile::pkgDebianIndexRealFile(std::string const &pFile, bool const Trusted) :/*{{{*/
 267    pkgDebianIndexFile(Trusted), d(NULL)
 268 {
 269    if (pFile == "/nonexistent/stdin")
 270       File = pFile;
 271    else
 272       File = flAbsPath(pFile);
 273 }
 274                                                                         /*}}}*/
 275 // IndexRealFile::Size - Return the size of the index                   /*{{{*/
 276 unsigned long pkgDebianIndexRealFile::Size() const
 277 {
 278    struct stat S;
 279    if (stat(File.c_str(),&S) != 0)
 280       return 0;
 281    return S.st_size;
 282 }
 283                                                                         /*}}}*/
 284 bool pkgDebianIndexRealFile::Exists() const                                     /*{{{*/
 285 {
 286    return FileExists(File);
 287 }
 288                                                                         /*}}}*/
 289 std::string pkgDebianIndexRealFile::Describe(bool const /*Short*/) const/*{{{*/
 290 {
 291    return File;
 292 }
 293                                                                         /*}}}*/
 294 std::string pkgDebianIndexRealFile::ArchiveURI(std::string const &/*File*/) const/*{{{*/
 295 {
 296    return "file:" + File;
 297 }
 298                                                                         /*}}}*/
 299 std::string pkgDebianIndexRealFile::IndexFileName() const                       /*{{{*/
 300 {
 301    return File;
 302 }
 303                                                                         /*}}}*/
 304 std::string pkgDebianIndexRealFile::GetProgressDescription() const
 305 {
 306    return File;
 307 }
 308 bool pkgDebianIndexRealFile::OpenListFile(FileFd &Pkg, std::string const &FileName)/*{{{*/
 309 {
 310    if (Pkg.Open(FileName, FileFd::ReadOnly, FileFd::None) == false)
 311       return _error->Error("Problem opening %s",FileName.c_str());
 312    return true;
 313 }
 314                                                                         /*}}}*/
 315
 316 pkgDebianIndexFile::pkgDebianIndexFile(bool const Trusted) : pkgIndexFile(Trusted)
 317 {
 318 }
 319 pkgDebianIndexFile::~pkgDebianIndexFile()
 320 {
 321 }
 322 pkgCacheListParser * pkgDebianIndexFile::CreateListParser(FileFd &Pkg)
 323 {
 324    if (Pkg.IsOpen() == false)
 325       return NULL;
 326    _error->PushToStack();
 327    pkgCacheListParser * const Parser = new debListParser(&Pkg);
 328    bool const newError = _error->PendingError();
 329    _error->MergeWithStack();
 330    return newError ? NULL : Parser;
 331 }
 332 bool pkgDebianIndexFile::Merge(pkgCacheGenerator &Gen,OpProgress * const Prog)
 333 {
 334    std::string const PackageFile = IndexFileName();
 335    FileFd Pkg;
 336    if (OpenListFile(Pkg, PackageFile) == false)
 337       return false;
 338    _error->PushToStack();
 339    std::unique_ptr<pkgCacheListParser> Parser(CreateListParser(Pkg));
 340    bool const newError = _error->PendingError();
 341    _error->MergeWithStack();
 342    if (newError == false && Parser == nullptr)
 343       return true;
 344    if (Parser == NULL)
 345       return false;
 346
 347    if (Prog != NULL)
 348       Prog->SubProgress(0, GetProgressDescription());
 349
 350    if (Gen.SelectFile(PackageFile, *this, GetArchitecture(), GetComponent(), GetIndexFlags()) == false)
 351       return _error->Error("Problem with SelectFile %s",PackageFile.c_str());
 352
 353    // Store the IMS information
 354    pkgCache::PkgFileIterator File = Gen.GetCurFile();
 355    pkgCacheGenerator::Dynamic<pkgCache::PkgFileIterator> DynFile(File);
 356    File->Size = Pkg.FileSize();
 357    File->mtime = Pkg.ModificationTime();
 358
 359    if (Gen.MergeList(*Parser) == false)
 360       return _error->Error("Problem with MergeList %s",PackageFile.c_str());
 361    return true;
 362 }
 363 pkgCache::PkgFileIterator pkgDebianIndexFile::FindInCache(pkgCache &Cache) const
 364 {
 365    std::string const FileName = IndexFileName();
 366    pkgCache::PkgFileIterator File = Cache.FileBegin();
 367    for (; File.end() == false; ++File)
 368    {
 369        if (File.FileName() == NULL || FileName != File.FileName())
 370          continue;
 371
 372       struct stat St;
 373       if (stat(File.FileName(),&St) != 0)
 374       {
 375          if (_config->FindB("Debug::pkgCacheGen", false))
 376             std::clog << "DebianIndexFile::FindInCache - stat failed on " << File.FileName() << std::endl;
 377          return pkgCache::PkgFileIterator(Cache);
 378       }
 379       if ((map_filesize_t)St.st_size != File->Size || St.st_mtime != File->mtime)
 380       {
 381          if (_config->FindB("Debug::pkgCacheGen", false))
 382             std::clog << "DebianIndexFile::FindInCache - size (" << St.st_size << " <> " << File->Size
 383                         << ") or mtime (" << St.st_mtime << " <> " << File->mtime
 384                         << ") doesn't match for " << File.FileName() << std::endl;
 385          return pkgCache::PkgFileIterator(Cache);
 386       }
 387       return File;
 388    }
 389
 390    return File;
 391 }
 392
 393 APT_CONST pkgIndexFile::~pkgIndexFile() {}
 394 APT_CONST pkgDebianIndexTargetFile::~pkgDebianIndexTargetFile() {}
 395 APT_CONST pkgDebianIndexRealFile::~pkgDebianIndexRealFile() {}