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