apt-pkg/deb/debindexfile.cc

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: debindexfile.cc,v 1.5.2.3 2004/01/04 19:11:00 mdz Exp $
   4 /* ######################################################################
   5
   6    Debian Specific sources.list types and the three sorts of Debian
   7    index files.
   8
   9    ##################################################################### */
  10                                                                         /*}}}*/
  11 // Include Files                                                        /*{{{*/
  12 #ifdef __GNUG__
  13 #pragma implementation "apt-pkg/debindexfile.h"
  14 #endif
  15
  16 #include <apt-pkg/debindexfile.h>
  17 #include <apt-pkg/debsrcrecords.h>
  18 #include <apt-pkg/deblistparser.h>
  19 #include <apt-pkg/debrecords.h>
  20 #include <apt-pkg/sourcelist.h>
  21 #include <apt-pkg/configuration.h>
  22 #include <apt-pkg/progress.h>
  23 #include <apt-pkg/error.h>
  24 #include <apt-pkg/strutl.h>
  25 #include <apt-pkg/acquire-item.h>
  26 #include <apt-pkg/debmetaindex.h>
  27
  28 #include <sys/stat.h>
  29                                                                         /*}}}*/
  30
  31 // SourcesIndex::debSourcesIndex - Constructor                          /*{{{*/
  32 // ---------------------------------------------------------------------
  33 /* */
  34 debSourcesIndex::debSourcesIndex(string URI,string Dist,string Section,bool Trusted) :
  35      pkgIndexFile(Trusted), URI(URI), Dist(Dist), Section(Section)
  36 {
  37 }
  38                                                                         /*}}}*/
  39 // SourcesIndex::SourceInfo - Short 1 liner describing a source         /*{{{*/
  40 // ---------------------------------------------------------------------
  41 /* The result looks like:
  42      http://foo/ stable/main src 1.1.1 (dsc) */
  43 string debSourcesIndex::SourceInfo(pkgSrcRecords::Parser const &Record,
  44                                    pkgSrcRecords::File const &File) const
  45 {
  46    string Res;
  47    Res = ::URI::SiteOnly(URI) + ' ';
  48    if (Dist[Dist.size() - 1] == '/')
  49    {
  50       if (Dist != "/")
  51          Res += Dist;
  52    }
  53    else
  54       Res += Dist + '/' + Section;
  55
  56    Res += " ";
  57    Res += Record.Package();
  58    Res += " ";
  59    Res += Record.Version();
  60    if (File.Type.empty() == false)
  61       Res += " (" + File.Type + ")";
  62    return Res;
  63 }
  64                                                                         /*}}}*/
  65 // SourcesIndex::CreateSrcParser - Get a parser for the source files    /*{{{*/
  66 // ---------------------------------------------------------------------
  67 /* */
  68 pkgSrcRecords::Parser *debSourcesIndex::CreateSrcParser() const
  69 {
  70    string SourcesURI = URItoFileName(IndexURI("Sources"));
  71    return new debSrcRecordParser(_config->FindDir("Dir::State::lists") +
  72                                  SourcesURI,this);
  73 }
  74                                                                         /*}}}*/
  75 // SourcesIndex::Describe - Give a descriptive path to the index        /*{{{*/
  76 // ---------------------------------------------------------------------
  77 /* */
  78 string debSourcesIndex::Describe(bool Short) const
  79 {
  80    char S[300];
  81    if (Short == true)
  82       snprintf(S,sizeof(S),"%s",Info("Sources").c_str());
  83    else
  84       snprintf(S,sizeof(S),"%s (%s)",Info("Sources").c_str(),
  85                IndexFile("Sources").c_str());
  86
  87    return S;
  88 }
  89                                                                         /*}}}*/
  90 // SourcesIndex::Info - One liner describing the index URI              /*{{{*/
  91 // ---------------------------------------------------------------------
  92 /* */
  93 string debSourcesIndex::Info(const char *Type) const
  94 {
  95    string Info = ::URI::SiteOnly(URI) + ' ';
  96    if (Dist[Dist.size() - 1] == '/')
  97    {
  98       if (Dist != "/")
  99          Info += Dist;
 100    }
 101    else
 102       Info += Dist + '/' + Section;
 103    Info += " ";
 104    Info += Type;
 105    return Info;
 106 }
 107                                                                         /*}}}*/
 108 // SourcesIndex::Index* - Return the URI to the index files             /*{{{*/
 109 // ---------------------------------------------------------------------
 110 /* */
 111 inline string debSourcesIndex::IndexFile(const char *Type) const
 112 {
 113    return URItoFileName(IndexURI(Type));
 114 }
 115 string debSourcesIndex::IndexURI(const char *Type) const
 116 {
 117    string Res;
 118    if (Dist[Dist.size() - 1] == '/')
 119    {
 120       if (Dist != "/")
 121          Res = URI + Dist;
 122       else
 123          Res = URI;
 124    }
 125    else
 126       Res = URI + "dists/" + Dist + '/' + Section +
 127       "/source/";
 128
 129    Res += Type;
 130    return Res;
 131 }
 132                                                                         /*}}}*/
 133 // SourcesIndex::Exists - Check if the index is available               /*{{{*/
 134 // ---------------------------------------------------------------------
 135 /* */
 136 bool debSourcesIndex::Exists() const
 137 {
 138    return FileExists(IndexFile("Sources"));
 139 }
 140                                                                         /*}}}*/
 141 // SourcesIndex::Size - Return the size of the index                    /*{{{*/
 142 // ---------------------------------------------------------------------
 143 /* */
 144 unsigned long debSourcesIndex::Size() const
 145 {
 146    struct stat S;
 147    if (stat(IndexFile("Sources").c_str(),&S) != 0)
 148       return 0;
 149    return S.st_size;
 150 }
 151                                                                         /*}}}*/
 152
 153 // PackagesIndex::debPackagesIndex - Contructor                         /*{{{*/
 154 // ---------------------------------------------------------------------
 155 /* */
 156 debPackagesIndex::debPackagesIndex(string URI,string Dist,string Section,bool Trusted) :
 157                   pkgIndexFile(Trusted), URI(URI), Dist(Dist), Section(Section)
 158 {
 159 }
 160                                                                         /*}}}*/
 161 // PackagesIndex::ArchiveInfo - Short version of the archive url        /*{{{*/
 162 // ---------------------------------------------------------------------
 163 /* This is a shorter version that is designed to be < 60 chars or so */
 164 string debPackagesIndex::ArchiveInfo(pkgCache::VerIterator Ver) const
 165 {
 166    string Res = ::URI::SiteOnly(URI) + ' ';
 167    if (Dist[Dist.size() - 1] == '/')
 168    {
 169       if (Dist != "/")
 170          Res += Dist;
 171    }
 172    else
 173       Res += Dist + '/' + Section;
 174
 175    Res += " ";
 176    Res += Ver.ParentPkg().Name();
 177    Res += " ";
 178    Res += Ver.VerStr();
 179    return Res;
 180 }
 181                                                                         /*}}}*/
 182 // PackagesIndex::Describe - Give a descriptive path to the index       /*{{{*/
 183 // ---------------------------------------------------------------------
 184 /* This should help the user find the index in the sources.list and
 185    in the filesystem for problem solving */
 186 string debPackagesIndex::Describe(bool Short) const
 187 {
 188    char S[300];
 189    if (Short == true)
 190       snprintf(S,sizeof(S),"%s",Info("Packages").c_str());
 191    else
 192       snprintf(S,sizeof(S),"%s (%s)",Info("Packages").c_str(),
 193                IndexFile("Packages").c_str());
 194    return S;
 195 }
 196                                                                         /*}}}*/
 197 // PackagesIndex::Info - One liner describing the index URI             /*{{{*/
 198 // ---------------------------------------------------------------------
 199 /* */
 200 string debPackagesIndex::Info(const char *Type) const
 201 {
 202    string Info = ::URI::SiteOnly(URI) + ' ';
 203    if (Dist[Dist.size() - 1] == '/')
 204    {
 205       if (Dist != "/")
 206          Info += Dist;
 207    }
 208    else
 209       Info += Dist + '/' + Section;
 210    Info += " ";
 211    Info += Type;
 212    return Info;
 213 }
 214                                                                         /*}}}*/
 215 // PackagesIndex::Index* - Return the URI to the index files            /*{{{*/
 216 // ---------------------------------------------------------------------
 217 /* */
 218 inline string debPackagesIndex::IndexFile(const char *Type) const
 219 {
 220    return _config->FindDir("Dir::State::lists") + URItoFileName(IndexURI(Type));
 221 }
 222 string debPackagesIndex::IndexURI(const char *Type) const
 223 {
 224    string Res;
 225    if (Dist[Dist.size() - 1] == '/')
 226    {
 227       if (Dist != "/")
 228          Res = URI + Dist;
 229       else
 230          Res = URI;
 231    }
 232    else
 233       Res = URI + "dists/" + Dist + '/' + Section +
 234       "/binary-" + _config->Find("APT::Architecture") + '/';
 235
 236    Res += Type;
 237    return Res;
 238 }
 239                                                                         /*}}}*/
 240 // PackagesIndex::Exists - Check if the index is available              /*{{{*/
 241 // ---------------------------------------------------------------------
 242 /* */
 243 bool debPackagesIndex::Exists() const
 244 {
 245    return FileExists(IndexFile("Packages"));
 246 }
 247                                                                         /*}}}*/
 248 // PackagesIndex::Size - Return the size of the index                   /*{{{*/
 249 // ---------------------------------------------------------------------
 250 /* This is really only used for progress reporting. */
 251 unsigned long debPackagesIndex::Size() const
 252 {
 253    struct stat S;
 254    if (stat(IndexFile("Packages").c_str(),&S) != 0)
 255       return 0;
 256    return S.st_size;
 257 }
 258                                                                         /*}}}*/
 259 // PackagesIndex::Merge - Load the index file into a cache              /*{{{*/
 260 // ---------------------------------------------------------------------
 261 /* */
 262 bool debPackagesIndex::Merge(pkgCacheGenerator &Gen,OpProgress &Prog) const
 263 {
 264    string PackageFile = IndexFile("Packages");
 265    FileFd Pkg(PackageFile,FileFd::ReadOnly);
 266    debListParser Parser(&Pkg);
 267    if (_error->PendingError() == true)
 268       return _error->Error("Problem opening %s",PackageFile.c_str());
 269
 270    Prog.SubProgress(0,Info("Packages"));
 271    ::URI Tmp(URI);
 272    if (Gen.SelectFile(PackageFile,Tmp.Host,*this) == false)
 273       return _error->Error("Problem with SelectFile %s",PackageFile.c_str());
 274
 275    // Store the IMS information
 276    pkgCache::PkgFileIterator File = Gen.GetCurFile();
 277    struct stat St;
 278    if (fstat(Pkg.Fd(),&St) != 0)
 279       return _error->Errno("fstat","Failed to stat");
 280    File->Size = St.st_size;
 281    File->mtime = St.st_mtime;
 282
 283    if (Gen.MergeList(Parser) == false)
 284       return _error->Error("Problem with MergeList %s",PackageFile.c_str());
 285
 286    // Check the release file
 287    string ReleaseFile = debReleaseIndex(URI,Dist).MetaIndexFile("Release");
 288    if (FileExists(ReleaseFile) == true)
 289    {
 290       FileFd Rel(ReleaseFile,FileFd::ReadOnly);
 291       if (_error->PendingError() == true)
 292          return false;
 293       Parser.LoadReleaseInfo(File,Rel);
 294    }
 295
 296    return true;
 297 }
 298                                                                         /*}}}*/
 299 // PackagesIndex::FindInCache - Find this index                         /*{{{*/
 300 // ---------------------------------------------------------------------
 301 /* */
 302 pkgCache::PkgFileIterator debPackagesIndex::FindInCache(pkgCache &Cache) const
 303 {
 304    string FileName = IndexFile("Packages");
 305    pkgCache::PkgFileIterator File = Cache.FileBegin();
 306    for (; File.end() == false; File++)
 307    {
 308       if (FileName != File.FileName())
 309          continue;
 310
 311       struct stat St;
 312       if (stat(File.FileName(),&St) != 0)
 313          return pkgCache::PkgFileIterator(Cache);
 314       if ((unsigned)St.st_size != File->Size || St.st_mtime != File->mtime)
 315          return pkgCache::PkgFileIterator(Cache);
 316       return File;
 317    }
 318
 319    return File;
 320 }
 321                                                                         /*}}}*/
 322
 323 // TranslationsIndex::debTranslationsIndex - Contructor                 /*{{{*/
 324 // ---------------------------------------------------------------------
 325 /* */
 326 debTranslationsIndex::debTranslationsIndex(string URI,string Dist,string Section) :
 327                   pkgIndexFile(true), URI(URI), Dist(Dist), Section(Section)
 328 {
 329 }
 330                                                                         /*}}}*/
 331 // TranslationIndex::Trans* - Return the URI to the translation files   /*{{{*/
 332 // ---------------------------------------------------------------------
 333 /* */
 334 inline string debTranslationsIndex::IndexFile(const char *Type) const
 335 {
 336    return _config->FindDir("Dir::State::lists") + URItoFileName(IndexURI(Type));
 337 }
 338 string debTranslationsIndex::IndexURI(const char *Type) const
 339 {
 340    string Res;
 341    if (Dist[Dist.size() - 1] == '/')
 342    {
 343       if (Dist != "/")
 344          Res = URI + Dist;
 345       else
 346          Res = URI;
 347    }
 348    else
 349       Res = URI + "dists/" + Dist + '/' + Section +
 350       "/i18n/Translation-";
 351
 352    Res += Type;
 353    return Res;
 354 }
 355                                                                         /*}}}*/
 356 // TranslationsIndex::GetIndexes - Fetch the index files                /*{{{*/
 357 // ---------------------------------------------------------------------
 358 /* */
 359 bool debTranslationsIndex::GetIndexes(pkgAcquire *Owner) const
 360 {
 361    if (UseTranslation()) {
 362      string TranslationFile = "Translation-" + LanguageCode();
 363      new pkgAcqIndexTrans(Owner, IndexURI(LanguageCode().c_str()),
 364                           Info(TranslationFile.c_str()),
 365                           TranslationFile);
 366    }
 367
 368    return true;
 369 }
 370                                                                         /*}}}*/
 371 // TranslationsIndex::Describe - Give a descriptive path to the index   /*{{{*/
 372 // ---------------------------------------------------------------------
 373 /* This should help the user find the index in the sources.list and
 374    in the filesystem for problem solving */
 375 string debTranslationsIndex::Describe(bool Short) const
 376 {
 377    char S[300];
 378    if (Short == true)
 379       snprintf(S,sizeof(S),"%s",Info(TranslationFile().c_str()).c_str());
 380    else
 381       snprintf(S,sizeof(S),"%s (%s)",Info(TranslationFile().c_str()).c_str(),
 382                IndexFile(LanguageCode().c_str()).c_str());
 383    return S;
 384 }
 385                                                                         /*}}}*/
 386 // TranslationsIndex::Info - One liner describing the index URI         /*{{{*/
 387 // ---------------------------------------------------------------------
 388 /* */
 389 string debTranslationsIndex::Info(const char *Type) const
 390 {
 391    string Info = ::URI::SiteOnly(URI) + ' ';
 392    if (Dist[Dist.size() - 1] == '/')
 393    {
 394       if (Dist != "/")
 395          Info += Dist;
 396    }
 397    else
 398       Info += Dist + '/' + Section;
 399    Info += " ";
 400    Info += Type;
 401    return Info;
 402 }
 403                                                                         /*}}}*/
 404 // TranslationsIndex::Exists - Check if the index is available          /*{{{*/
 405 // ---------------------------------------------------------------------
 406 /* */
 407 bool debTranslationsIndex::Exists() const
 408 {
 409    return FileExists(IndexFile(LanguageCode().c_str()));
 410 }
 411                                                                         /*}}}*/
 412 // TranslationsIndex::Size - Return the size of the index               /*{{{*/
 413 // ---------------------------------------------------------------------
 414 /* This is really only used for progress reporting. */
 415 unsigned long debTranslationsIndex::Size() const
 416 {
 417    struct stat S;
 418    if (stat(IndexFile(LanguageCode().c_str()).c_str(),&S) != 0)
 419       return 0;
 420    return S.st_size;
 421 }
 422                                                                         /*}}}*/
 423 // TranslationsIndex::Merge - Load the index file into a cache          /*{{{*/
 424 // ---------------------------------------------------------------------
 425 /* */
 426 bool debTranslationsIndex::Merge(pkgCacheGenerator &Gen,OpProgress &Prog) const
 427 {
 428    // Check the translation file, if in use
 429    string TranslationFile = IndexFile(LanguageCode().c_str());
 430    if (UseTranslation() && FileExists(TranslationFile))
 431    {
 432      FileFd Trans(TranslationFile,FileFd::ReadOnly);
 433      debListParser TransParser(&Trans);
 434      if (_error->PendingError() == true)
 435        return false;
 436
 437      Prog.SubProgress(0, Info(TranslationFile.c_str()));
 438      if (Gen.SelectFile(TranslationFile,string(),*this) == false)
 439        return _error->Error("Problem with SelectFile %s",TranslationFile.c_str());
 440
 441      // Store the IMS information
 442      pkgCache::PkgFileIterator TransFile = Gen.GetCurFile();
 443      struct stat TransSt;
 444      if (fstat(Trans.Fd(),&TransSt) != 0)
 445        return _error->Errno("fstat","Failed to stat");
 446      TransFile->Size = TransSt.st_size;
 447      TransFile->mtime = TransSt.st_mtime;
 448
 449      if (Gen.MergeList(TransParser) == false)
 450        return _error->Error("Problem with MergeList %s",TranslationFile.c_str());
 451    }
 452
 453    return true;
 454 }
 455                                                                         /*}}}*/
 456 // TranslationsIndex::FindInCache - Find this index                             /*{{{*/
 457 // ---------------------------------------------------------------------
 458 /* */
 459 pkgCache::PkgFileIterator debTranslationsIndex::FindInCache(pkgCache &Cache) const
 460 {
 461    string FileName = TranslationFile();
 462
 463    pkgCache::PkgFileIterator File = Cache.FileBegin();
 464    for (; File.end() == false; File++)
 465    {
 466       if (FileName != File.FileName())
 467          continue;
 468
 469       struct stat St;
 470       if (stat(File.FileName(),&St) != 0)
 471          return pkgCache::PkgFileIterator(Cache);
 472       if ((unsigned)St.st_size != File->Size || St.st_mtime != File->mtime)
 473          return pkgCache::PkgFileIterator(Cache);
 474       return File;
 475    }
 476    return File;
 477 }
 478                                                                         /*}}}*/
 479 // StatusIndex::debStatusIndex - Constructor                            /*{{{*/
 480 // ---------------------------------------------------------------------
 481 /* */
 482 debStatusIndex::debStatusIndex(string File) : pkgIndexFile(true), File(File)
 483 {
 484 }
 485                                                                         /*}}}*/
 486 // StatusIndex::Size - Return the size of the index                     /*{{{*/
 487 // ---------------------------------------------------------------------
 488 /* */
 489 unsigned long debStatusIndex::Size() const
 490 {
 491    struct stat S;
 492    if (stat(File.c_str(),&S) != 0)
 493       return 0;
 494    return S.st_size;
 495 }
 496                                                                         /*}}}*/
 497 // StatusIndex::Merge - Load the index file into a cache                /*{{{*/
 498 // ---------------------------------------------------------------------
 499 /* */
 500 bool debStatusIndex::Merge(pkgCacheGenerator &Gen,OpProgress &Prog) const
 501 {
 502    FileFd Pkg(File,FileFd::ReadOnly);
 503    if (_error->PendingError() == true)
 504       return false;
 505    debListParser Parser(&Pkg);
 506    if (_error->PendingError() == true)
 507       return false;
 508
 509    Prog.SubProgress(0,File);
 510    if (Gen.SelectFile(File,string(),*this,pkgCache::Flag::NotSource) == false)
 511       return _error->Error("Problem with SelectFile %s",File.c_str());
 512
 513    // Store the IMS information
 514    pkgCache::PkgFileIterator CFile = Gen.GetCurFile();
 515    struct stat St;
 516    if (fstat(Pkg.Fd(),&St) != 0)
 517       return _error->Errno("fstat","Failed to stat");
 518    CFile->Size = St.st_size;
 519    CFile->mtime = St.st_mtime;
 520    CFile->Archive = Gen.WriteUniqString("now");
 521
 522    if (Gen.MergeList(Parser) == false)
 523       return _error->Error("Problem with MergeList %s",File.c_str());
 524    return true;
 525 }
 526                                                                         /*}}}*/
 527 // StatusIndex::FindInCache - Find this index                           /*{{{*/
 528 // ---------------------------------------------------------------------
 529 /* */
 530 pkgCache::PkgFileIterator debStatusIndex::FindInCache(pkgCache &Cache) const
 531 {
 532    pkgCache::PkgFileIterator File = Cache.FileBegin();
 533    for (; File.end() == false; File++)
 534    {
 535       if (this->File != File.FileName())
 536          continue;
 537
 538       struct stat St;
 539       if (stat(File.FileName(),&St) != 0)
 540          return pkgCache::PkgFileIterator(Cache);
 541       if ((unsigned)St.st_size != File->Size || St.st_mtime != File->mtime)
 542          return pkgCache::PkgFileIterator(Cache);
 543       return File;
 544    }
 545    return File;
 546 }
 547                                                                         /*}}}*/
 548 // StatusIndex::Exists - Check if the index is available                /*{{{*/
 549 // ---------------------------------------------------------------------
 550 /* */
 551 bool debStatusIndex::Exists() const
 552 {
 553    // Abort if the file does not exist.
 554    return true;
 555 }
 556                                                                         /*}}}*/
 557
 558 // Index File types for Debian                                          /*{{{*/
 559 class debIFTypeSrc : public pkgIndexFile::Type
 560 {
 561    public:
 562
 563    debIFTypeSrc() {Label = "Debian Source Index";};
 564 };
 565 class debIFTypePkg : public pkgIndexFile::Type
 566 {
 567    public:
 568
 569    virtual pkgRecords::Parser *CreatePkgParser(pkgCache::PkgFileIterator File) const
 570    {
 571       return new debRecordParser(File.FileName(),*File.Cache());
 572    };
 573    debIFTypePkg() {Label = "Debian Package Index";};
 574 };
 575 class debIFTypeTrans : public debIFTypePkg
 576 {
 577    public:
 578    debIFTypeTrans() {Label = "Debian Translation Index";};
 579 };
 580 class debIFTypeStatus : public pkgIndexFile::Type
 581 {
 582    public:
 583
 584    virtual pkgRecords::Parser *CreatePkgParser(pkgCache::PkgFileIterator File) const
 585    {
 586       return new debRecordParser(File.FileName(),*File.Cache());
 587    };
 588    debIFTypeStatus() {Label = "Debian dpkg status file";};
 589 };
 590 static debIFTypeSrc _apt_Src;
 591 static debIFTypePkg _apt_Pkg;
 592 static debIFTypeTrans _apt_Trans;
 593 static debIFTypeStatus _apt_Status;
 594
 595 const pkgIndexFile::Type *debSourcesIndex::GetType() const
 596 {
 597    return &_apt_Src;
 598 }
 599 const pkgIndexFile::Type *debPackagesIndex::GetType() const
 600 {
 601    return &_apt_Pkg;
 602 }
 603 const pkgIndexFile::Type *debTranslationsIndex::GetType() const
 604 {
 605    return &_apt_Trans;
 606 }
 607 const pkgIndexFile::Type *debStatusIndex::GetType() const
 608 {
 609    return &_apt_Status;
 610 }
 611
 612                                                                         /*}}}*/