apt-pkg/acquire-item.cc

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: acquire-item.cc,v 1.46.2.9 2004/01/16 18:51:11 mdz Exp $
   4 /* ######################################################################
   5
   6    Acquire Item - Item to acquire
   7
   8    Each item can download to exactly one file at a time. This means you
   9    cannot create an item that fetches two uri's to two files at the same
  10    time. The pkgAcqIndex class creates a second class upon instantiation
  11    to fetch the other index files because of this.
  12
  13    ##################################################################### */
  14                                                                         /*}}}*/
  15 // Include Files                                                        /*{{{*/
  16 #include <config.h>
  17
  18 #include <apt-pkg/acquire-item.h>
  19 #include <apt-pkg/configuration.h>
  20 #include <apt-pkg/aptconfiguration.h>
  21 #include <apt-pkg/sourcelist.h>
  22 #include <apt-pkg/error.h>
  23 #include <apt-pkg/strutl.h>
  24 #include <apt-pkg/fileutl.h>
  25 #include <apt-pkg/sha1.h>
  26 #include <apt-pkg/tagfile.h>
  27 #include <apt-pkg/indexrecords.h>
  28 #include <apt-pkg/acquire.h>
  29 #include <apt-pkg/hashes.h>
  30 #include <apt-pkg/indexfile.h>
  31 #include <apt-pkg/pkgcache.h>
  32 #include <apt-pkg/cacheiterators.h>
  33 #include <apt-pkg/pkgrecords.h>
  34
  35 #include <stddef.h>
  36 #include <stdlib.h>
  37 #include <string.h>
  38 #include <iostream>
  39 #include <vector>
  40 #include <sys/stat.h>
  41 #include <unistd.h>
  42 #include <errno.h>
  43 #include <string>
  44 #include <sstream>
  45 #include <stdio.h>
  46 #include <ctime>
  47
  48 #include <apti18n.h>
  49                                                                         /*}}}*/
  50
  51 using namespace std;
  52
  53 // Acquire::Item::Item - Constructor                                    /*{{{*/
  54 // ---------------------------------------------------------------------
  55 /* */
  56 pkgAcquire::Item::Item(pkgAcquire *Owner) : Owner(Owner), FileSize(0),
  57                        PartialSize(0), Mode(0), ID(0), Complete(false),
  58                        Local(false), QueueCounter(0)
  59 {
  60    Owner->Add(this);
  61    Status = StatIdle;
  62 }
  63                                                                         /*}}}*/
  64 // Acquire::Item::~Item - Destructor                                    /*{{{*/
  65 // ---------------------------------------------------------------------
  66 /* */
  67 pkgAcquire::Item::~Item()
  68 {
  69    Owner->Remove(this);
  70 }
  71                                                                         /*}}}*/
  72 // Acquire::Item::Failed - Item failed to download                      /*{{{*/
  73 // ---------------------------------------------------------------------
  74 /* We return to an idle state if there are still other queues that could
  75    fetch this object */
  76 void pkgAcquire::Item::Failed(string Message,pkgAcquire::MethodConfig *Cnf)
  77 {
  78    Status = StatIdle;
  79    ErrorText = LookupTag(Message,"Message");
  80    UsedMirror =  LookupTag(Message,"UsedMirror");
  81    if (QueueCounter <= 1)
  82    {
  83       /* This indicates that the file is not available right now but might
  84          be sometime later. If we do a retry cycle then this should be
  85          retried [CDROMs] */
  86       if (Cnf->LocalOnly == true &&
  87           StringToBool(LookupTag(Message,"Transient-Failure"),false) == true)
  88       {
  89          Status = StatIdle;
  90          Dequeue();
  91          return;
  92       }
  93
  94       Status = StatError;
  95       Dequeue();
  96    }
  97
  98    // report mirror failure back to LP if we actually use a mirror
  99    string FailReason = LookupTag(Message, "FailReason");
 100    if(FailReason.size() != 0)
 101       ReportMirrorFailure(FailReason);
 102    else
 103       ReportMirrorFailure(ErrorText);
 104 }
 105                                                                         /*}}}*/
 106 // Acquire::Item::Start - Item has begun to download                    /*{{{*/
 107 // ---------------------------------------------------------------------
 108 /* Stash status and the file size. Note that setting Complete means
 109    sub-phases of the acquire process such as decompresion are operating */
 110 void pkgAcquire::Item::Start(string /*Message*/,unsigned long long Size)
 111 {
 112    Status = StatFetching;
 113    if (FileSize == 0 && Complete == false)
 114       FileSize = Size;
 115 }
 116                                                                         /*}}}*/
 117 // Acquire::Item::Done - Item downloaded OK                             /*{{{*/
 118 // ---------------------------------------------------------------------
 119 /* */
 120 void pkgAcquire::Item::Done(string Message,unsigned long long Size,string /*Hash*/,
 121                             pkgAcquire::MethodConfig * /*Cnf*/)
 122 {
 123    // We just downloaded something..
 124    string FileName = LookupTag(Message,"Filename");
 125    UsedMirror =  LookupTag(Message,"UsedMirror");
 126    if (Complete == false && !Local && FileName == DestFile)
 127    {
 128       if (Owner->Log != 0)
 129          Owner->Log->Fetched(Size,atoi(LookupTag(Message,"Resume-Point","0").c_str()));
 130    }
 131
 132    if (FileSize == 0)
 133       FileSize= Size;
 134    Status = StatDone;
 135    ErrorText = string();
 136    Owner->Dequeue(this);
 137 }
 138                                                                         /*}}}*/
 139 // Acquire::Item::Rename - Rename a file                                /*{{{*/
 140 // ---------------------------------------------------------------------
 141 /* This helper function is used by a lot of item methods as their final
 142    step */
 143 void pkgAcquire::Item::Rename(string From,string To)
 144 {
 145    if (rename(From.c_str(),To.c_str()) != 0)
 146    {
 147       char S[300];
 148       snprintf(S,sizeof(S),_("rename failed, %s (%s -> %s)."),strerror(errno),
 149               From.c_str(),To.c_str());
 150       Status = StatError;
 151       ErrorText = S;
 152    }
 153 }
 154                                                                         /*}}}*/
 155 bool pkgAcquire::Item::RenameOnError(pkgAcquire::Item::RenameOnErrorState const error)/*{{{*/
 156 {
 157    if(FileExists(DestFile))
 158       Rename(DestFile, DestFile + ".FAILED");
 159
 160    switch (error)
 161    {
 162       case HashSumMismatch:
 163          ErrorText = _("Hash Sum mismatch");
 164          Status = StatAuthError;
 165          ReportMirrorFailure("HashChecksumFailure");
 166          break;
 167       case SizeMismatch:
 168          ErrorText = _("Size mismatch");
 169          Status = StatAuthError;
 170          ReportMirrorFailure("SizeFailure");
 171          break;
 172       case InvalidFormat:
 173          ErrorText = _("Invalid file format");
 174          Status = StatError;
 175          // do not report as usually its not the mirrors fault, but Portal/Proxy
 176          break;
 177    }
 178    return false;
 179 }
 180                                                                         /*}}}*/
 181 // Acquire::Item::ReportMirrorFailure                                   /*{{{*/
 182 // ---------------------------------------------------------------------
 183 void pkgAcquire::Item::ReportMirrorFailure(string FailCode)
 184 {
 185    // we only act if a mirror was used at all
 186    if(UsedMirror.empty())
 187       return;
 188 #if 0
 189    std::cerr << "\nReportMirrorFailure: "
 190              << UsedMirror
 191              << " Uri: " << DescURI()
 192              << " FailCode: "
 193              << FailCode << std::endl;
 194 #endif
 195    const char *Args[40];
 196    unsigned int i = 0;
 197    string report = _config->Find("Methods::Mirror::ProblemReporting",
 198                                  "/usr/lib/apt/apt-report-mirror-failure");
 199    if(!FileExists(report))
 200       return;
 201    Args[i++] = report.c_str();
 202    Args[i++] = UsedMirror.c_str();
 203    Args[i++] = DescURI().c_str();
 204    Args[i++] = FailCode.c_str();
 205    Args[i++] = NULL;
 206    pid_t pid = ExecFork();
 207    if(pid < 0)
 208    {
 209       _error->Error("ReportMirrorFailure Fork failed");
 210       return;
 211    }
 212    else if(pid == 0)
 213    {
 214       execvp(Args[0], (char**)Args);
 215       std::cerr << "Could not exec " << Args[0] << std::endl;
 216       _exit(100);
 217    }
 218    if(!ExecWait(pid, "report-mirror-failure"))
 219    {
 220       _error->Warning("Couldn't report problem to '%s'",
 221                       _config->Find("Methods::Mirror::ProblemReporting").c_str());
 222    }
 223 }
 224                                                                         /*}}}*/
 225 // AcqSubIndex::AcqSubIndex - Constructor                               /*{{{*/
 226 // ---------------------------------------------------------------------
 227 /* Get a sub-index file based on checksums from a 'master' file and
 228    possibly query additional files */
 229 pkgAcqSubIndex::pkgAcqSubIndex(pkgAcquire *Owner, string const &URI,
 230                                  string const &URIDesc, string const &ShortDesc,
 231                                  HashString const &ExpectedHash)
 232    : Item(Owner), ExpectedHash(ExpectedHash)
 233 {
 234    /* XXX: Beware: Currently this class does nothing (of value) anymore ! */
 235    Debug = _config->FindB("Debug::pkgAcquire::SubIndex",false);
 236
 237    DestFile = _config->FindDir("Dir::State::lists") + "partial/";
 238    DestFile += URItoFileName(URI);
 239
 240    Desc.URI = URI;
 241    Desc.Description = URIDesc;
 242    Desc.Owner = this;
 243    Desc.ShortDesc = ShortDesc;
 244
 245    QueueURI(Desc);
 246
 247    if(Debug)
 248       std::clog << "pkgAcqSubIndex: " << Desc.URI << std::endl;
 249 }
 250                                                                         /*}}}*/
 251 // AcqSubIndex::Custom600Headers - Insert custom request headers        /*{{{*/
 252 // ---------------------------------------------------------------------
 253 /* The only header we use is the last-modified header. */
 254 string pkgAcqSubIndex::Custom600Headers()
 255 {
 256    string Final = _config->FindDir("Dir::State::lists");
 257    Final += URItoFileName(Desc.URI);
 258
 259    struct stat Buf;
 260    if (stat(Final.c_str(),&Buf) != 0)
 261       return "\nIndex-File: true\nFail-Ignore: true\n";
 262    return "\nIndex-File: true\nFail-Ignore: true\nLast-Modified: " + TimeRFC1123(Buf.st_mtime);
 263 }
 264                                                                         /*}}}*/
 265 void pkgAcqSubIndex::Failed(string Message,pkgAcquire::MethodConfig * /*Cnf*/)/*{{{*/
 266 {
 267    if(Debug)
 268       std::clog << "pkgAcqSubIndex failed: " << Desc.URI << " with " << Message << std::endl;
 269
 270    Complete = false;
 271    Status = StatDone;
 272    Dequeue();
 273
 274    // No good Index is provided
 275 }
 276                                                                         /*}}}*/
 277 void pkgAcqSubIndex::Done(string Message,unsigned long long Size,string Md5Hash,        /*{{{*/
 278                            pkgAcquire::MethodConfig *Cnf)
 279 {
 280    if(Debug)
 281       std::clog << "pkgAcqSubIndex::Done(): " << Desc.URI << std::endl;
 282
 283    string FileName = LookupTag(Message,"Filename");
 284    if (FileName.empty() == true)
 285    {
 286       Status = StatError;
 287       ErrorText = "Method gave a blank filename";
 288       return;
 289    }
 290
 291    if (FileName != DestFile)
 292    {
 293       Local = true;
 294       Desc.URI = "copy:" + FileName;
 295       QueueURI(Desc);
 296       return;
 297    }
 298
 299    Item::Done(Message,Size,Md5Hash,Cnf);
 300
 301    string FinalFile = _config->FindDir("Dir::State::lists")+URItoFileName(Desc.URI);
 302
 303    /* Downloaded invalid transindex => Error (LP: #346386) (Closes: #627642) */
 304    indexRecords SubIndexParser;
 305    if (FileExists(DestFile) == true && !SubIndexParser.Load(DestFile)) {
 306       Status = StatError;
 307       ErrorText = SubIndexParser.ErrorText;
 308       return;
 309    }
 310
 311    // success in downloading the index
 312    // rename the index
 313    if(Debug)
 314       std::clog << "Renaming: " << DestFile << " -> " << FinalFile << std::endl;
 315    Rename(DestFile,FinalFile);
 316    chmod(FinalFile.c_str(),0644);
 317    DestFile = FinalFile;
 318
 319    if(ParseIndex(DestFile) == false)
 320       return Failed("", NULL);
 321
 322    Complete = true;
 323    Status = StatDone;
 324    Dequeue();
 325    return;
 326 }
 327                                                                         /*}}}*/
 328 bool pkgAcqSubIndex::ParseIndex(string const &IndexFile)                /*{{{*/
 329 {
 330    indexRecords SubIndexParser;
 331    if (FileExists(IndexFile) == false || SubIndexParser.Load(IndexFile) == false)
 332       return false;
 333    // so something with the downloaded index
 334    return true;
 335 }
 336                                                                         /*}}}*/
 337 // AcqDiffIndex::AcqDiffIndex - Constructor                             /*{{{*/
 338 // ---------------------------------------------------------------------
 339 /* Get the DiffIndex file first and see if there are patches available
 340  * If so, create a pkgAcqIndexDiffs fetcher that will get and apply the
 341  * patches. If anything goes wrong in that process, it will fall back to
 342  * the original packages file
 343  */
 344 pkgAcqDiffIndex::pkgAcqDiffIndex(pkgAcquire *Owner,
 345                                  string URI,string URIDesc,string ShortDesc,
 346                                  HashString ExpectedHash)
 347    : Item(Owner), RealURI(URI), ExpectedHash(ExpectedHash),
 348      Description(URIDesc)
 349 {
 350
 351    Debug = _config->FindB("Debug::pkgAcquire::Diffs",false);
 352
 353    Desc.Description = URIDesc + "/DiffIndex";
 354    Desc.Owner = this;
 355    Desc.ShortDesc = ShortDesc;
 356    Desc.URI = URI + ".diff/Index";
 357
 358    DestFile = _config->FindDir("Dir::State::lists") + "partial/";
 359    DestFile += URItoFileName(Desc.URI);
 360
 361    if(Debug)
 362       std::clog << "pkgAcqDiffIndex: " << Desc.URI << std::endl;
 363
 364    // look for the current package file
 365    CurrentPackagesFile = _config->FindDir("Dir::State::lists");
 366    CurrentPackagesFile += URItoFileName(RealURI);
 367
 368    // FIXME: this file:/ check is a hack to prevent fetching
 369    //        from local sources. this is really silly, and
 370    //        should be fixed cleanly as soon as possible
 371    if(!FileExists(CurrentPackagesFile) ||
 372       Desc.URI.substr(0,strlen("file:/")) == "file:/")
 373    {
 374       // we don't have a pkg file or we don't want to queue
 375       if(Debug)
 376          std::clog << "No index file, local or canceld by user" << std::endl;
 377       Failed("", NULL);
 378       return;
 379    }
 380
 381    if(Debug)
 382       std::clog << "pkgAcqDiffIndex::pkgAcqDiffIndex(): "
 383          << CurrentPackagesFile << std::endl;
 384
 385    QueueURI(Desc);
 386
 387 }
 388                                                                         /*}}}*/
 389 // AcqIndex::Custom600Headers - Insert custom request headers           /*{{{*/
 390 // ---------------------------------------------------------------------
 391 /* The only header we use is the last-modified header. */
 392 string pkgAcqDiffIndex::Custom600Headers()
 393 {
 394    string Final = _config->FindDir("Dir::State::lists");
 395    Final += URItoFileName(Desc.URI);
 396
 397    if(Debug)
 398       std::clog << "Custom600Header-IMS: " << Final << std::endl;
 399
 400    struct stat Buf;
 401    if (stat(Final.c_str(),&Buf) != 0)
 402       return "\nIndex-File: true";
 403
 404    return "\nIndex-File: true\nLast-Modified: " + TimeRFC1123(Buf.st_mtime);
 405 }
 406                                                                         /*}}}*/
 407 bool pkgAcqDiffIndex::ParseDiffIndex(string IndexDiffFile)              /*{{{*/
 408 {
 409    if(Debug)
 410       std::clog << "pkgAcqDiffIndex::ParseIndexDiff() " << IndexDiffFile
 411          << std::endl;
 412
 413    pkgTagSection Tags;
 414    string ServerSha1;
 415    vector<DiffInfo> available_patches;
 416
 417    FileFd Fd(IndexDiffFile,FileFd::ReadOnly);
 418    pkgTagFile TF(&Fd);
 419    if (_error->PendingError() == true)
 420       return false;
 421
 422    if(TF.Step(Tags) == true)
 423    {
 424       bool found = false;
 425       DiffInfo d;
 426       string size;
 427
 428       string const tmp = Tags.FindS("SHA1-Current");
 429       std::stringstream ss(tmp);
 430       ss >> ServerSha1 >> size;
 431       unsigned long const ServerSize = atol(size.c_str());
 432
 433       FileFd fd(CurrentPackagesFile, FileFd::ReadOnly);
 434       SHA1Summation SHA1;
 435       SHA1.AddFD(fd);
 436       string const local_sha1 = SHA1.Result();
 437
 438       if(local_sha1 == ServerSha1)
 439       {
 440          // we have the same sha1 as the server so we are done here
 441          if(Debug)
 442             std::clog << "Package file is up-to-date" << std::endl;
 443          // list cleanup needs to know that this file as well as the already
 444          // present index is ours, so we create an empty diff to save it for us
 445          new pkgAcqIndexDiffs(Owner, RealURI, Description, Desc.ShortDesc,
 446                ExpectedHash, ServerSha1, available_patches);
 447          return true;
 448       }
 449       else
 450       {
 451          if(Debug)
 452             std::clog << "SHA1-Current: " << ServerSha1 << " and we start at "<< fd.Name() << " " << fd.Size() << " " << local_sha1 << std::endl;
 453
 454          // check the historie and see what patches we need
 455          string const history = Tags.FindS("SHA1-History");
 456          std::stringstream hist(history);
 457          while(hist >> d.sha1 >> size >> d.file)
 458          {
 459             // read until the first match is found
 460             // from that point on, we probably need all diffs
 461             if(d.sha1 == local_sha1)
 462                found=true;
 463             else if (found == false)
 464                continue;
 465
 466             if(Debug)
 467                std::clog << "Need to get diff: " << d.file << std::endl;
 468             available_patches.push_back(d);
 469          }
 470
 471          if (available_patches.empty() == false)
 472          {
 473             // patching with too many files is rather slow compared to a fast download
 474             unsigned long const fileLimit = _config->FindI("Acquire::PDiffs::FileLimit", 0);
 475             if (fileLimit != 0 && fileLimit < available_patches.size())
 476             {
 477                if (Debug)
 478                   std::clog << "Need " << available_patches.size() << " diffs (Limit is " << fileLimit
 479                         << ") so fallback to complete download" << std::endl;
 480                return false;
 481             }
 482
 483             // see if the patches are too big
 484             found = false; // it was true and it will be true again at the end
 485             d = *available_patches.begin();
 486             string const firstPatch = d.file;
 487             unsigned long patchesSize = 0;
 488             std::stringstream patches(Tags.FindS("SHA1-Patches"));
 489             while(patches >> d.sha1 >> size >> d.file)
 490             {
 491                if (firstPatch == d.file)
 492                   found = true;
 493                else if (found == false)
 494                   continue;
 495
 496                patchesSize += atol(size.c_str());
 497             }
 498             unsigned long const sizeLimit = ServerSize * _config->FindI("Acquire::PDiffs::SizeLimit", 100);
 499             if (sizeLimit > 0 && (sizeLimit/100) < patchesSize)
 500             {
 501                if (Debug)
 502                   std::clog << "Need " << patchesSize << " bytes (Limit is " << sizeLimit/100
 503                         << ") so fallback to complete download" << std::endl;
 504                return false;
 505             }
 506          }
 507       }
 508
 509       // we have something, queue the next diff
 510       if(found)
 511       {
 512          // queue the diffs
 513          string::size_type const last_space = Description.rfind(" ");
 514          if(last_space != string::npos)
 515             Description.erase(last_space, Description.size()-last_space);
 516
 517          /* decide if we should download patches one by one or in one go:
 518             The first is good if the server merges patches, but many don't so client
 519             based merging can be attempt in which case the second is better.
 520             "bad things" will happen if patches are merged on the server,
 521             but client side merging is attempt as well */
 522          bool pdiff_merge = _config->FindB("Acquire::PDiffs::Merge", true);
 523          if (pdiff_merge == true)
 524          {
 525             // reprepro adds this flag if it has merged patches on the server
 526             std::string const precedence = Tags.FindS("X-Patch-Precedence");
 527             pdiff_merge = (precedence != "merged");
 528          }
 529
 530          if (pdiff_merge == false)
 531             new pkgAcqIndexDiffs(Owner, RealURI, Description, Desc.ShortDesc,
 532                   ExpectedHash, ServerSha1, available_patches);
 533          else
 534          {
 535             std::vector<pkgAcqIndexMergeDiffs*> *diffs = new std::vector<pkgAcqIndexMergeDiffs*>(available_patches.size());
 536             for(size_t i = 0; i < available_patches.size(); ++i)
 537                (*diffs)[i] = new pkgAcqIndexMergeDiffs(Owner, RealURI, Description, Desc.ShortDesc, ExpectedHash,
 538                      available_patches[i], diffs);
 539          }
 540
 541          Complete = false;
 542          Status = StatDone;
 543          Dequeue();
 544          return true;
 545       }
 546    }
 547
 548    // Nothing found, report and return false
 549    // Failing here is ok, if we return false later, the full
 550    // IndexFile is queued
 551    if(Debug)
 552       std::clog << "Can't find a patch in the index file" << std::endl;
 553    return false;
 554 }
 555                                                                         /*}}}*/
 556 void pkgAcqDiffIndex::Failed(string Message,pkgAcquire::MethodConfig * /*Cnf*/)/*{{{*/
 557 {
 558    if(Debug)
 559       std::clog << "pkgAcqDiffIndex failed: " << Desc.URI << " with " << Message << std::endl
 560                 << "Falling back to normal index file acquire" << std::endl;
 561
 562    new pkgAcqIndex(Owner, RealURI, Description, Desc.ShortDesc,
 563                    ExpectedHash);
 564
 565    Complete = false;
 566    Status = StatDone;
 567    Dequeue();
 568 }
 569                                                                         /*}}}*/
 570 void pkgAcqDiffIndex::Done(string Message,unsigned long long Size,string Md5Hash,       /*{{{*/
 571                            pkgAcquire::MethodConfig *Cnf)
 572 {
 573    if(Debug)
 574       std::clog << "pkgAcqDiffIndex::Done(): " << Desc.URI << std::endl;
 575
 576    Item::Done(Message,Size,Md5Hash,Cnf);
 577
 578    string FinalFile;
 579    FinalFile = _config->FindDir("Dir::State::lists")+URItoFileName(RealURI);
 580
 581    // success in downloading the index
 582    // rename the index
 583    FinalFile += string(".IndexDiff");
 584    if(Debug)
 585       std::clog << "Renaming: " << DestFile << " -> " << FinalFile
 586                 << std::endl;
 587    Rename(DestFile,FinalFile);
 588    chmod(FinalFile.c_str(),0644);
 589    DestFile = FinalFile;
 590
 591    if(!ParseDiffIndex(DestFile))
 592       return Failed("", NULL);
 593
 594    Complete = true;
 595    Status = StatDone;
 596    Dequeue();
 597    return;
 598 }
 599                                                                         /*}}}*/
 600 // AcqIndexDiffs::AcqIndexDiffs - Constructor                           /*{{{*/
 601 // ---------------------------------------------------------------------
 602 /* The package diff is added to the queue. one object is constructed
 603  * for each diff and the index
 604  */
 605 pkgAcqIndexDiffs::pkgAcqIndexDiffs(pkgAcquire *Owner,
 606                                    string URI,string URIDesc,string ShortDesc,
 607                                    HashString ExpectedHash,
 608                                    string ServerSha1,
 609                                    vector<DiffInfo> diffs)
 610    : Item(Owner), RealURI(URI), ExpectedHash(ExpectedHash),
 611      available_patches(diffs), ServerSha1(ServerSha1)
 612 {
 613
 614    DestFile = _config->FindDir("Dir::State::lists") + "partial/";
 615    DestFile += URItoFileName(URI);
 616
 617    Debug = _config->FindB("Debug::pkgAcquire::Diffs",false);
 618
 619    Description = URIDesc;
 620    Desc.Owner = this;
 621    Desc.ShortDesc = ShortDesc;
 622
 623    if(available_patches.empty() == true)
 624    {
 625       // we are done (yeah!)
 626       Finish(true);
 627    }
 628    else
 629    {
 630       // get the next diff
 631       State = StateFetchDiff;
 632       QueueNextDiff();
 633    }
 634 }
 635                                                                         /*}}}*/
 636 void pkgAcqIndexDiffs::Failed(string Message,pkgAcquire::MethodConfig * /*Cnf*/)/*{{{*/
 637 {
 638    if(Debug)
 639       std::clog << "pkgAcqIndexDiffs failed: " << Desc.URI << " with " << Message << std::endl
 640                 << "Falling back to normal index file acquire" << std::endl;
 641    new pkgAcqIndex(Owner, RealURI, Description,Desc.ShortDesc,
 642                    ExpectedHash);
 643    Finish();
 644 }
 645                                                                         /*}}}*/
 646 // Finish - helper that cleans the item out of the fetcher queue        /*{{{*/
 647 void pkgAcqIndexDiffs::Finish(bool allDone)
 648 {
 649    // we restore the original name, this is required, otherwise
 650    // the file will be cleaned
 651    if(allDone)
 652    {
 653       DestFile = _config->FindDir("Dir::State::lists");
 654       DestFile += URItoFileName(RealURI);
 655
 656       if(!ExpectedHash.empty() && !ExpectedHash.VerifyFile(DestFile))
 657       {
 658          RenameOnError(HashSumMismatch);
 659          Dequeue();
 660          return;
 661       }
 662
 663       // this is for the "real" finish
 664       Complete = true;
 665       Status = StatDone;
 666       Dequeue();
 667       if(Debug)
 668          std::clog << "\n\nallDone: " << DestFile << "\n" << std::endl;
 669       return;
 670    }
 671
 672    if(Debug)
 673       std::clog << "Finishing: " << Desc.URI << std::endl;
 674    Complete = false;
 675    Status = StatDone;
 676    Dequeue();
 677    return;
 678 }
 679                                                                         /*}}}*/
 680 bool pkgAcqIndexDiffs::QueueNextDiff()                                  /*{{{*/
 681 {
 682
 683    // calc sha1 of the just patched file
 684    string FinalFile = _config->FindDir("Dir::State::lists");
 685    FinalFile += URItoFileName(RealURI);
 686
 687    FileFd fd(FinalFile, FileFd::ReadOnly);
 688    SHA1Summation SHA1;
 689    SHA1.AddFD(fd);
 690    string local_sha1 = string(SHA1.Result());
 691    if(Debug)
 692       std::clog << "QueueNextDiff: "
 693                 << FinalFile << " (" << local_sha1 << ")"<<std::endl;
 694
 695    // final file reached before all patches are applied
 696    if(local_sha1 == ServerSha1)
 697    {
 698       Finish(true);
 699       return true;
 700    }
 701
 702    // remove all patches until the next matching patch is found
 703    // this requires the Index file to be ordered
 704    for(vector<DiffInfo>::iterator I=available_patches.begin();
 705        available_patches.empty() == false &&
 706           I != available_patches.end() &&
 707           I->sha1 != local_sha1;
 708        ++I)
 709    {
 710       available_patches.erase(I);
 711    }
 712
 713    // error checking and falling back if no patch was found
 714    if(available_patches.empty() == true)
 715    {
 716       Failed("", NULL);
 717       return false;
 718    }
 719
 720    // queue the right diff
 721    Desc.URI = RealURI + ".diff/" + available_patches[0].file + ".gz";
 722    Desc.Description = Description + " " + available_patches[0].file + string(".pdiff");
 723    DestFile = _config->FindDir("Dir::State::lists") + "partial/";
 724    DestFile += URItoFileName(RealURI + ".diff/" + available_patches[0].file);
 725
 726    if(Debug)
 727       std::clog << "pkgAcqIndexDiffs::QueueNextDiff(): " << Desc.URI << std::endl;
 728
 729    QueueURI(Desc);
 730
 731    return true;
 732 }
 733                                                                         /*}}}*/
 734 void pkgAcqIndexDiffs::Done(string Message,unsigned long long Size,string Md5Hash,      /*{{{*/
 735                             pkgAcquire::MethodConfig *Cnf)
 736 {
 737    if(Debug)
 738       std::clog << "pkgAcqIndexDiffs::Done(): " << Desc.URI << std::endl;
 739
 740    Item::Done(Message,Size,Md5Hash,Cnf);
 741
 742    string FinalFile;
 743    FinalFile = _config->FindDir("Dir::State::lists")+URItoFileName(RealURI);
 744
 745    // success in downloading a diff, enter ApplyDiff state
 746    if(State == StateFetchDiff)
 747    {
 748
 749       // rred excepts the patch as $FinalFile.ed
 750       Rename(DestFile,FinalFile+".ed");
 751
 752       if(Debug)
 753          std::clog << "Sending to rred method: " << FinalFile << std::endl;
 754
 755       State = StateApplyDiff;
 756       Local = true;
 757       Desc.URI = "rred:" + FinalFile;
 758       QueueURI(Desc);
 759       Mode = "rred";
 760       return;
 761    }
 762
 763
 764    // success in download/apply a diff, queue next (if needed)
 765    if(State == StateApplyDiff)
 766    {
 767       // remove the just applied patch
 768       available_patches.erase(available_patches.begin());
 769       unlink((FinalFile + ".ed").c_str());
 770
 771       // move into place
 772       if(Debug)
 773       {
 774          std::clog << "Moving patched file in place: " << std::endl
 775                    << DestFile << " -> " << FinalFile << std::endl;
 776       }
 777       Rename(DestFile,FinalFile);
 778       chmod(FinalFile.c_str(),0644);
 779
 780       // see if there is more to download
 781       if(available_patches.empty() == false) {
 782          new pkgAcqIndexDiffs(Owner, RealURI, Description, Desc.ShortDesc,
 783                               ExpectedHash, ServerSha1, available_patches);
 784          return Finish();
 785       } else
 786          return Finish(true);
 787    }
 788 }
 789                                                                         /*}}}*/
 790 // AcqIndexMergeDiffs::AcqIndexMergeDiffs - Constructor                 /*{{{*/
 791 pkgAcqIndexMergeDiffs::pkgAcqIndexMergeDiffs(pkgAcquire *Owner,
 792                                    string const &URI, string const &URIDesc,
 793                                    string const &ShortDesc, HashString const &ExpectedHash,
 794                                    DiffInfo const &patch,
 795                                    std::vector<pkgAcqIndexMergeDiffs*> const * const allPatches)
 796    : Item(Owner), RealURI(URI), ExpectedHash(ExpectedHash),
 797      patch(patch),allPatches(allPatches), State(StateFetchDiff)
 798 {
 799
 800    DestFile = _config->FindDir("Dir::State::lists") + "partial/";
 801    DestFile += URItoFileName(URI);
 802
 803    Debug = _config->FindB("Debug::pkgAcquire::Diffs",false);
 804
 805    Description = URIDesc;
 806    Desc.Owner = this;
 807    Desc.ShortDesc = ShortDesc;
 808
 809    Desc.URI = RealURI + ".diff/" + patch.file + ".gz";
 810    Desc.Description = Description + " " + patch.file + string(".pdiff");
 811    DestFile = _config->FindDir("Dir::State::lists") + "partial/";
 812    DestFile += URItoFileName(RealURI + ".diff/" + patch.file);
 813
 814    if(Debug)
 815       std::clog << "pkgAcqIndexMergeDiffs: " << Desc.URI << std::endl;
 816
 817    QueueURI(Desc);
 818 }
 819                                                                         /*}}}*/
 820 void pkgAcqIndexMergeDiffs::Failed(string Message,pkgAcquire::MethodConfig * /*Cnf*/)/*{{{*/
 821 {
 822    if(Debug)
 823       std::clog << "pkgAcqIndexMergeDiffs failed: " << Desc.URI << " with " << Message << std::endl;
 824    Complete = false;
 825    Status = StatDone;
 826    Dequeue();
 827
 828    // check if we are the first to fail, otherwise we are done here
 829    State = StateDoneDiff;
 830    for (std::vector<pkgAcqIndexMergeDiffs *>::const_iterator I = allPatches->begin();
 831          I != allPatches->end(); ++I)
 832       if ((*I)->State == StateErrorDiff)
 833          return;
 834
 835    // first failure means we should fallback
 836    State = StateErrorDiff;
 837    std::clog << "Falling back to normal index file acquire" << std::endl;
 838    new pkgAcqIndex(Owner, RealURI, Description,Desc.ShortDesc,
 839                    ExpectedHash);
 840 }
 841                                                                         /*}}}*/
 842 void pkgAcqIndexMergeDiffs::Done(string Message,unsigned long long Size,string Md5Hash, /*{{{*/
 843                             pkgAcquire::MethodConfig *Cnf)
 844 {
 845    if(Debug)
 846       std::clog << "pkgAcqIndexMergeDiffs::Done(): " << Desc.URI << std::endl;
 847
 848    Item::Done(Message,Size,Md5Hash,Cnf);
 849
 850    string const FinalFile = _config->FindDir("Dir::State::lists") + URItoFileName(RealURI);
 851
 852    if (State == StateFetchDiff)
 853    {
 854       // rred expects the patch as $FinalFile.ed.$patchname.gz
 855       Rename(DestFile, FinalFile + ".ed." + patch.file + ".gz");
 856
 857       // check if this is the last completed diff
 858       State = StateDoneDiff;
 859       for (std::vector<pkgAcqIndexMergeDiffs *>::const_iterator I = allPatches->begin();
 860             I != allPatches->end(); ++I)
 861          if ((*I)->State != StateDoneDiff)
 862          {
 863             if(Debug)
 864                std::clog << "Not the last done diff in the batch: " << Desc.URI << std::endl;
 865             return;
 866          }
 867
 868       // this is the last completed diff, so we are ready to apply now
 869       State = StateApplyDiff;
 870
 871       if(Debug)
 872          std::clog << "Sending to rred method: " << FinalFile << std::endl;
 873
 874       Local = true;
 875       Desc.URI = "rred:" + FinalFile;
 876       QueueURI(Desc);
 877       Mode = "rred";
 878       return;
 879    }
 880    // success in download/apply all diffs, clean up
 881    else if (State == StateApplyDiff)
 882    {
 883       // see if we really got the expected file
 884       if(!ExpectedHash.empty() && !ExpectedHash.VerifyFile(DestFile))
 885       {
 886          RenameOnError(HashSumMismatch);
 887          return;
 888       }
 889
 890       // move the result into place
 891       if(Debug)
 892          std::clog << "Moving patched file in place: " << std::endl
 893                    << DestFile << " -> " << FinalFile << std::endl;
 894       Rename(DestFile, FinalFile);
 895       chmod(FinalFile.c_str(), 0644);
 896
 897       // otherwise lists cleanup will eat the file
 898       DestFile = FinalFile;
 899
 900       // ensure the ed's are gone regardless of list-cleanup
 901       for (std::vector<pkgAcqIndexMergeDiffs *>::const_iterator I = allPatches->begin();
 902             I != allPatches->end(); ++I)
 903       {
 904             std::string patch = FinalFile + ".ed." + (*I)->patch.file + ".gz";
 905             unlink(patch.c_str());
 906       }
 907
 908       // all set and done
 909       Complete = true;
 910       if(Debug)
 911          std::clog << "allDone: " << DestFile << "\n" << std::endl;
 912    }
 913 }
 914                                                                         /*}}}*/
 915 // AcqIndex::AcqIndex - Constructor                                     /*{{{*/
 916 // ---------------------------------------------------------------------
 917 /* The package file is added to the queue and a second class is
 918    instantiated to fetch the revision file */
 919 pkgAcqIndex::pkgAcqIndex(pkgAcquire *Owner,
 920                          string URI,string URIDesc,string ShortDesc,
 921                          HashString ExpectedHash, string comprExt)
 922    : Item(Owner), RealURI(URI), ExpectedHash(ExpectedHash)
 923 {
 924    if(comprExt.empty() == true)
 925    {
 926       // autoselect the compression method
 927       std::vector<std::string> types = APT::Configuration::getCompressionTypes();
 928       for (std::vector<std::string>::const_iterator t = types.begin(); t != types.end(); ++t)
 929          comprExt.append(*t).append(" ");
 930       if (comprExt.empty() == false)
 931          comprExt.erase(comprExt.end()-1);
 932    }
 933    CompressionExtension = comprExt;
 934
 935    Init(URI, URIDesc, ShortDesc);
 936 }
 937 pkgAcqIndex::pkgAcqIndex(pkgAcquire *Owner, IndexTarget const *Target,
 938                          HashString const &ExpectedHash, indexRecords const *MetaIndexParser)
 939    : Item(Owner), RealURI(Target->URI), ExpectedHash(ExpectedHash)
 940 {
 941    // autoselect the compression method
 942    std::vector<std::string> types = APT::Configuration::getCompressionTypes();
 943    CompressionExtension = "";
 944    if (ExpectedHash.empty() == false)
 945    {
 946       for (std::vector<std::string>::const_iterator t = types.begin(); t != types.end(); ++t)
 947          if (*t == "uncompressed" || MetaIndexParser->Exists(string(Target->MetaKey).append(".").append(*t)) == true)
 948             CompressionExtension.append(*t).append(" ");
 949    }
 950    else
 951    {
 952       for (std::vector<std::string>::const_iterator t = types.begin(); t != types.end(); ++t)
 953          CompressionExtension.append(*t).append(" ");
 954    }
 955    if (CompressionExtension.empty() == false)
 956       CompressionExtension.erase(CompressionExtension.end()-1);
 957
 958    Init(Target->URI, Target->Description, Target->ShortDesc);
 959 }
 960                                                                         /*}}}*/
 961 // AcqIndex::Init - defered Constructor                                 /*{{{*/
 962 void pkgAcqIndex::Init(string const &URI, string const &URIDesc, string const &ShortDesc) {
 963    Decompression = false;
 964    Erase = false;
 965
 966    DestFile = _config->FindDir("Dir::State::lists") + "partial/";
 967    DestFile += URItoFileName(URI);
 968
 969    std::string const comprExt = CompressionExtension.substr(0, CompressionExtension.find(' '));
 970    if (comprExt == "uncompressed")
 971       Desc.URI = URI;
 972    else {
 973       Desc.URI = URI + '.' + comprExt;
 974       DestFile = DestFile + '.' + comprExt;
 975    }
 976
 977    Desc.Description = URIDesc;
 978    Desc.Owner = this;
 979    Desc.ShortDesc = ShortDesc;
 980
 981    QueueURI(Desc);
 982 }
 983                                                                         /*}}}*/
 984 // AcqIndex::Custom600Headers - Insert custom request headers           /*{{{*/
 985 // ---------------------------------------------------------------------
 986 /* The only header we use is the last-modified header. */
 987 string pkgAcqIndex::Custom600Headers()
 988 {
 989    std::string const compExt = CompressionExtension.substr(0, CompressionExtension.find(' '));
 990    string Final = _config->FindDir("Dir::State::lists");
 991    Final += URItoFileName(RealURI);
 992    if (_config->FindB("Acquire::GzipIndexes",false))
 993       Final += compExt;
 994
 995    string msg = "\nIndex-File: true";
 996    // FIXME: this really should use "IndexTarget::IsOptional()" but that
 997    //        seems to be difficult without breaking ABI
 998    if (ShortDesc().find("Translation") != 0)
 999       msg += "\nFail-Ignore: true";
1000    struct stat Buf;
1001    if (stat(Final.c_str(),&Buf) == 0)
1002       msg += "\nLast-Modified: " + TimeRFC1123(Buf.st_mtime);
1003
1004    return msg;
1005 }
1006                                                                         /*}}}*/
1007 void pkgAcqIndex::Failed(string Message,pkgAcquire::MethodConfig *Cnf)  /*{{{*/
1008 {
1009    size_t const nextExt = CompressionExtension.find(' ');
1010    if (nextExt != std::string::npos)
1011    {
1012       CompressionExtension = CompressionExtension.substr(nextExt+1);
1013       Init(RealURI, Desc.Description, Desc.ShortDesc);
1014       return;
1015    }
1016
1017    // on decompression failure, remove bad versions in partial/
1018    if (Decompression && Erase) {
1019       string s = _config->FindDir("Dir::State::lists") + "partial/";
1020       s.append(URItoFileName(RealURI));
1021       unlink(s.c_str());
1022    }
1023
1024    Item::Failed(Message,Cnf);
1025 }
1026                                                                         /*}}}*/
1027 // pkgAcqIndex::GetFinalFilename - Return the full final file path      /*{{{*/
1028 std::string pkgAcqIndex::GetFinalFilename(std::string const &URI,
1029                                           std::string const &compExt)
1030 {
1031    std::string FinalFile = _config->FindDir("Dir::State::lists");
1032    FinalFile += URItoFileName(URI);
1033    if (_config->FindB("Acquire::GzipIndexes",false) == true)
1034       FinalFile += '.' + compExt;
1035    return FinalFile;
1036 }
1037                                                                         /*}}}*/
1038 // AcqIndex::ReverifyAfterIMS - Reverify index after an ims-hit         /*{{{*/
1039 void pkgAcqIndex::ReverifyAfterIMS(std::string const &FileName)
1040 {
1041    std::string const compExt = CompressionExtension.substr(0, CompressionExtension.find(' '));
1042    if (_config->FindB("Acquire::GzipIndexes",false) == true)
1043       DestFile += compExt;
1044
1045    string FinalFile = GetFinalFilename(RealURI, compExt);
1046    Rename(FinalFile, FileName);
1047    Decompression = true;
1048    Desc.URI = "copy:" + FileName;
1049    QueueURI(Desc);
1050 }
1051                                                                         /*}}}*/
1052 // AcqIndex::Done - Finished a fetch                                    /*{{{*/
1053 // ---------------------------------------------------------------------
1054 /* This goes through a number of states.. On the initial fetch the
1055    method could possibly return an alternate filename which points
1056    to the uncompressed version of the file. If this is so the file
1057    is copied into the partial directory. In all other cases the file
1058    is decompressed with a gzip uri. */
1059 void pkgAcqIndex::Done(string Message,unsigned long long Size,string Hash,
1060                        pkgAcquire::MethodConfig *Cfg)
1061 {
1062    Item::Done(Message,Size,Hash,Cfg);
1063    std::string const compExt = CompressionExtension.substr(0, CompressionExtension.find(' '));
1064
1065    if (Decompression == true)
1066    {
1067       if (_config->FindB("Debug::pkgAcquire::Auth", false))
1068       {
1069          std::cerr << std::endl << RealURI << ": Computed Hash: " << Hash;
1070          std::cerr << "  Expected Hash: " << ExpectedHash.toStr() << std::endl;
1071       }
1072
1073       if (!ExpectedHash.empty() && ExpectedHash.toStr() != Hash)
1074       {
1075          Desc.URI = RealURI;
1076          RenameOnError(HashSumMismatch);
1077          return;
1078       }
1079
1080       // FIXME: this can go away once we only ever download stuff that
1081       //        has a valid hash and we never do GET based probing
1082       //
1083       /* Always verify the index file for correctness (all indexes must
1084        * have a Package field) (LP: #346386) (Closes: #627642)
1085        */
1086       FileFd fd(DestFile, FileFd::ReadOnly, FileFd::Extension);
1087       // Only test for correctness if the file is not empty (empty is ok)
1088       if (fd.Size() > 0)
1089       {
1090          pkgTagSection sec;
1091          pkgTagFile tag(&fd);
1092
1093          // all our current indexes have a field 'Package' in each section
1094          if (_error->PendingError() == true || tag.Step(sec) == false || sec.Exists("Package") == false)
1095          {
1096             RenameOnError(InvalidFormat);
1097             return;
1098          }
1099       }
1100
1101       // Done, move it into position
1102       string FinalFile = GetFinalFilename(RealURI, compExt);
1103       Rename(DestFile,FinalFile);
1104       chmod(FinalFile.c_str(),0644);
1105
1106       /* We restore the original name to DestFile so that the clean operation
1107          will work OK */
1108       DestFile = _config->FindDir("Dir::State::lists") + "partial/";
1109       DestFile += URItoFileName(RealURI);
1110       if (_config->FindB("Acquire::GzipIndexes",false))
1111          DestFile += '.' + compExt;
1112
1113       // Remove the compressed version.
1114       if (Erase == true)
1115          unlink(DestFile.c_str());
1116       return;
1117    }
1118
1119    Erase = false;
1120    Complete = true;
1121
1122    // Handle the unzipd case
1123    string FileName = LookupTag(Message,"Alt-Filename");
1124    if (FileName.empty() == false)
1125    {
1126       Decompression = true;
1127       Local = true;
1128       DestFile += ".decomp";
1129       Desc.URI = "copy:" + FileName;
1130       QueueURI(Desc);
1131       Mode = "copy";
1132       return;
1133    }
1134
1135    FileName = LookupTag(Message,"Filename");
1136    if (FileName.empty() == true)
1137    {
1138       Status = StatError;
1139       ErrorText = "Method gave a blank filename";
1140    }
1141
1142    if (FileName == DestFile)
1143       Erase = true;
1144    else
1145       Local = true;
1146
1147    // The files timestamp matches, for non-local URLs reverify the local
1148    // file, for local file, uncompress again to ensure the hashsum is still
1149    // matching the Release file
1150    if (!Local && StringToBool(LookupTag(Message,"IMS-Hit"),false) == true)
1151    {
1152       // set destfile to the final destfile
1153       if(_config->FindB("Acquire::GzipIndexes",false) == false)
1154       {
1155          DestFile = _config->FindDir("Dir::State::lists") + "partial/";
1156          DestFile += URItoFileName(RealURI);
1157       }
1158
1159       ReverifyAfterIMS(FileName);
1160       return;
1161    }
1162    string decompProg;
1163
1164    // If we enable compressed indexes, queue for hash verification
1165    if (_config->FindB("Acquire::GzipIndexes",false))
1166    {
1167       DestFile = _config->FindDir("Dir::State::lists");
1168       DestFile += URItoFileName(RealURI) + '.' + compExt;
1169
1170       Decompression = true;
1171       Desc.URI = "copy:" + FileName;
1172       QueueURI(Desc);
1173
1174       return;
1175     }
1176
1177    // get the binary name for your used compression type
1178    decompProg = _config->Find(string("Acquire::CompressionTypes::").append(compExt),"");
1179    if(decompProg.empty() == false);
1180    else if(compExt == "uncompressed")
1181       decompProg = "copy";
1182    else {
1183       _error->Error("Unsupported extension: %s", compExt.c_str());
1184       return;
1185    }
1186
1187    Decompression = true;
1188    DestFile += ".decomp";
1189    Desc.URI = decompProg + ":" + FileName;
1190    QueueURI(Desc);
1191
1192    // FIXME: this points to a c++ string that goes out of scope
1193    Mode = decompProg.c_str();
1194 }
1195                                                                         /*}}}*/
1196 // AcqIndexTrans::pkgAcqIndexTrans - Constructor                        /*{{{*/
1197 // ---------------------------------------------------------------------
1198 /* The Translation file is added to the queue */
1199 pkgAcqIndexTrans::pkgAcqIndexTrans(pkgAcquire *Owner,
1200                             string URI,string URIDesc,string ShortDesc)
1201   : pkgAcqIndex(Owner, URI, URIDesc, ShortDesc, HashString(), "")
1202 {
1203 }
1204 pkgAcqIndexTrans::pkgAcqIndexTrans(pkgAcquire *Owner, IndexTarget const *Target,
1205                          HashString const &ExpectedHash, indexRecords const *MetaIndexParser)
1206   : pkgAcqIndex(Owner, Target, ExpectedHash, MetaIndexParser)
1207 {
1208 }
1209                                                                         /*}}}*/
1210 // AcqIndexTrans::Custom600Headers - Insert custom request headers      /*{{{*/
1211 // ---------------------------------------------------------------------
1212 string pkgAcqIndexTrans::Custom600Headers()
1213 {
1214    std::string const compExt = CompressionExtension.substr(0, CompressionExtension.find(' '));
1215    string Final = _config->FindDir("Dir::State::lists");
1216    Final += URItoFileName(RealURI);
1217    if (_config->FindB("Acquire::GzipIndexes",false))
1218       Final += compExt;
1219
1220    struct stat Buf;
1221    if (stat(Final.c_str(),&Buf) != 0)
1222       return "\nFail-Ignore: true\nIndex-File: true";
1223    return "\nFail-Ignore: true\nIndex-File: true\nLast-Modified: " + TimeRFC1123(Buf.st_mtime);
1224 }
1225                                                                         /*}}}*/
1226 // AcqIndexTrans::Failed - Silence failure messages for missing files   /*{{{*/
1227 // ---------------------------------------------------------------------
1228 /* */
1229 void pkgAcqIndexTrans::Failed(string Message,pkgAcquire::MethodConfig *Cnf)
1230 {
1231    size_t const nextExt = CompressionExtension.find(' ');
1232    if (nextExt != std::string::npos)
1233    {
1234       CompressionExtension = CompressionExtension.substr(nextExt+1);
1235       Init(RealURI, Desc.Description, Desc.ShortDesc);
1236       Status = StatIdle;
1237       return;
1238    }
1239
1240    if (Cnf->LocalOnly == true ||
1241        StringToBool(LookupTag(Message,"Transient-Failure"),false) == false)
1242    {
1243       // Ignore this
1244       Status = StatDone;
1245       Complete = false;
1246       Dequeue();
1247       return;
1248    }
1249
1250    Item::Failed(Message,Cnf);
1251 }
1252                                                                         /*}}}*/
1253 pkgAcqMetaSig::pkgAcqMetaSig(pkgAcquire *Owner,                         /*{{{*/
1254                              string URI,string URIDesc,string ShortDesc,
1255                              string MetaIndexURI, string MetaIndexURIDesc,
1256                              string MetaIndexShortDesc,
1257                              const vector<IndexTarget*>* IndexTargets,
1258                              indexRecords* MetaIndexParser) :
1259    Item(Owner), RealURI(URI), MetaIndexURI(MetaIndexURI),
1260    MetaIndexURIDesc(MetaIndexURIDesc), MetaIndexShortDesc(MetaIndexShortDesc),
1261    MetaIndexParser(MetaIndexParser), IndexTargets(IndexTargets)
1262 {
1263    DestFile = _config->FindDir("Dir::State::lists") + "partial/";
1264    DestFile += URItoFileName(URI);
1265
1266    // remove any partial downloaded sig-file in partial/.
1267    // it may confuse proxies and is too small to warrant a
1268    // partial download anyway
1269    unlink(DestFile.c_str());
1270
1271    // Create the item
1272    Desc.Description = URIDesc;
1273    Desc.Owner = this;
1274    Desc.ShortDesc = ShortDesc;
1275    Desc.URI = URI;
1276
1277    string Final = _config->FindDir("Dir::State::lists");
1278    Final += URItoFileName(RealURI);
1279    if (RealFileExists(Final) == true)
1280    {
1281       // File was already in place.  It needs to be re-downloaded/verified
1282       // because Release might have changed, we do give it a different
1283       // name than DestFile because otherwise the http method will
1284       // send If-Range requests and there are too many broken servers
1285       // out there that do not understand them
1286       LastGoodSig = DestFile+".reverify";
1287       Rename(Final,LastGoodSig);
1288    }
1289
1290    QueueURI(Desc);
1291 }
1292                                                                         /*}}}*/
1293 pkgAcqMetaSig::~pkgAcqMetaSig()                                         /*{{{*/
1294 {
1295    // if the file was never queued undo file-changes done in the constructor
1296    if (QueueCounter == 1 && Status == StatIdle && FileSize == 0 && Complete == false &&
1297          LastGoodSig.empty() == false)
1298    {
1299       string const Final = _config->FindDir("Dir::State::lists") + URItoFileName(RealURI);
1300       if (RealFileExists(Final) == false && RealFileExists(LastGoodSig) == true)
1301          Rename(LastGoodSig, Final);
1302    }
1303
1304 }
1305                                                                         /*}}}*/
1306 // pkgAcqMetaSig::Custom600Headers - Insert custom request headers      /*{{{*/
1307 // ---------------------------------------------------------------------
1308 /* The only header we use is the last-modified header. */
1309 string pkgAcqMetaSig::Custom600Headers()
1310 {
1311    struct stat Buf;
1312    if (stat(LastGoodSig.c_str(),&Buf) != 0)
1313       return "\nIndex-File: true";
1314
1315    return "\nIndex-File: true\nLast-Modified: " + TimeRFC1123(Buf.st_mtime);
1316 }
1317
1318 void pkgAcqMetaSig::Done(string Message,unsigned long long Size,string MD5,
1319                          pkgAcquire::MethodConfig *Cfg)
1320 {
1321    Item::Done(Message,Size,MD5,Cfg);
1322
1323    string FileName = LookupTag(Message,"Filename");
1324    if (FileName.empty() == true)
1325    {
1326       Status = StatError;
1327       ErrorText = "Method gave a blank filename";
1328       return;
1329    }
1330
1331    if (FileName != DestFile)
1332    {
1333       // We have to copy it into place
1334       Local = true;
1335       Desc.URI = "copy:" + FileName;
1336       QueueURI(Desc);
1337       return;
1338    }
1339
1340    Complete = true;
1341
1342    // put the last known good file back on i-m-s hit (it will
1343    // be re-verified again)
1344    // Else do nothing, we have the new file in DestFile then
1345    if(StringToBool(LookupTag(Message,"IMS-Hit"),false) == true)
1346       Rename(LastGoodSig, DestFile);
1347
1348    // queue a pkgAcqMetaIndex to be verified against the sig we just retrieved
1349    new pkgAcqMetaIndex(Owner, MetaIndexURI, MetaIndexURIDesc,
1350                        MetaIndexShortDesc,  DestFile, IndexTargets,
1351                        MetaIndexParser);
1352
1353 }
1354                                                                         /*}}}*/
1355 void pkgAcqMetaSig::Failed(string Message,pkgAcquire::MethodConfig *Cnf)/*{{{*/
1356 {
1357    string Final = _config->FindDir("Dir::State::lists") + URItoFileName(RealURI);
1358
1359    // if we get a network error we fail gracefully
1360    if(Status == StatTransientNetworkError)
1361    {
1362       Item::Failed(Message,Cnf);
1363       // move the sigfile back on transient network failures
1364       if(FileExists(LastGoodSig))
1365          Rename(LastGoodSig,Final);
1366
1367       // set the status back to , Item::Failed likes to reset it
1368       Status = pkgAcquire::Item::StatTransientNetworkError;
1369       return;
1370    }
1371
1372    // Delete any existing sigfile when the acquire failed
1373    unlink(Final.c_str());
1374
1375    // queue a pkgAcqMetaIndex with no sigfile
1376    new pkgAcqMetaIndex(Owner, MetaIndexURI, MetaIndexURIDesc, MetaIndexShortDesc,
1377                        "", IndexTargets, MetaIndexParser);
1378
1379    if (Cnf->LocalOnly == true ||
1380        StringToBool(LookupTag(Message,"Transient-Failure"),false) == false)
1381    {
1382       // Ignore this
1383       Status = StatDone;
1384       Complete = false;
1385       Dequeue();
1386       return;
1387    }
1388
1389    Item::Failed(Message,Cnf);
1390 }
1391                                                                         /*}}}*/
1392 pkgAcqMetaIndex::pkgAcqMetaIndex(pkgAcquire *Owner,                     /*{{{*/
1393                                  string URI,string URIDesc,string ShortDesc,
1394                                  string SigFile,
1395                                  const vector<struct IndexTarget*>* IndexTargets,
1396                                  indexRecords* MetaIndexParser) :
1397    Item(Owner), RealURI(URI), SigFile(SigFile), IndexTargets(IndexTargets),
1398    MetaIndexParser(MetaIndexParser), AuthPass(false), IMSHit(false)
1399 {
1400    DestFile = _config->FindDir("Dir::State::lists") + "partial/";
1401    DestFile += URItoFileName(URI);
1402
1403    // Create the item
1404    Desc.Description = URIDesc;
1405    Desc.Owner = this;
1406    Desc.ShortDesc = ShortDesc;
1407    Desc.URI = URI;
1408
1409    QueueURI(Desc);
1410 }
1411                                                                         /*}}}*/
1412 // pkgAcqMetaIndex::Custom600Headers - Insert custom request headers    /*{{{*/
1413 // ---------------------------------------------------------------------
1414 /* The only header we use is the last-modified header. */
1415 string pkgAcqMetaIndex::Custom600Headers()
1416 {
1417    string Final = _config->FindDir("Dir::State::lists");
1418    Final += URItoFileName(RealURI);
1419
1420    struct stat Buf;
1421    if (stat(Final.c_str(),&Buf) != 0)
1422       return "\nIndex-File: true";
1423
1424    return "\nIndex-File: true\nLast-Modified: " + TimeRFC1123(Buf.st_mtime);
1425 }
1426                                                                         /*}}}*/
1427 void pkgAcqMetaIndex::Done(string Message,unsigned long long Size,string Hash,  /*{{{*/
1428                            pkgAcquire::MethodConfig *Cfg)
1429 {
1430    Item::Done(Message,Size,Hash,Cfg);
1431
1432    // MetaIndexes are done in two passes: one to download the
1433    // metaindex with an appropriate method, and a second to verify it
1434    // with the gpgv method
1435
1436    if (AuthPass == true)
1437    {
1438       AuthDone(Message);
1439
1440       // all cool, move Release file into place
1441       Complete = true;
1442    }
1443    else
1444    {
1445       RetrievalDone(Message);
1446       if (!Complete)
1447          // Still more retrieving to do
1448          return;
1449
1450       if (SigFile == "")
1451       {
1452          // There was no signature file, so we are finished.  Download
1453          // the indexes and do only hashsum verification if possible
1454          MetaIndexParser->Load(DestFile);
1455          QueueIndexes(false);
1456       }
1457       else
1458       {
1459          // There was a signature file, so pass it to gpgv for
1460          // verification
1461
1462          if (_config->FindB("Debug::pkgAcquire::Auth", false))
1463             std::cerr << "Metaindex acquired, queueing gpg verification ("
1464                       << SigFile << "," << DestFile << ")\n";
1465          AuthPass = true;
1466          Desc.URI = "gpgv:" + SigFile;
1467          QueueURI(Desc);
1468          Mode = "gpgv";
1469          return;
1470       }
1471    }
1472
1473    if (Complete == true)
1474    {
1475       string FinalFile = _config->FindDir("Dir::State::lists");
1476       FinalFile += URItoFileName(RealURI);
1477       if (SigFile == DestFile)
1478          SigFile = FinalFile;
1479       Rename(DestFile,FinalFile);
1480       chmod(FinalFile.c_str(),0644);
1481       DestFile = FinalFile;
1482    }
1483 }
1484                                                                         /*}}}*/
1485 void pkgAcqMetaIndex::RetrievalDone(string Message)                     /*{{{*/
1486 {
1487    // We have just finished downloading a Release file (it is not
1488    // verified yet)
1489
1490    string FileName = LookupTag(Message,"Filename");
1491    if (FileName.empty() == true)
1492    {
1493       Status = StatError;
1494       ErrorText = "Method gave a blank filename";
1495       return;
1496    }
1497
1498    if (FileName != DestFile)
1499    {
1500       Local = true;
1501       Desc.URI = "copy:" + FileName;
1502       QueueURI(Desc);
1503       return;
1504    }
1505
1506    // make sure to verify against the right file on I-M-S hit
1507    IMSHit = StringToBool(LookupTag(Message,"IMS-Hit"),false);
1508    if(IMSHit)
1509    {
1510       string FinalFile = _config->FindDir("Dir::State::lists");
1511       FinalFile += URItoFileName(RealURI);
1512       if (SigFile == DestFile)
1513       {
1514          SigFile = FinalFile;
1515          // constructor of pkgAcqMetaClearSig moved it out of the way,
1516          // now move it back in on IMS hit for the 'old' file
1517          string const OldClearSig = DestFile + ".reverify";
1518          if (RealFileExists(OldClearSig) == true)
1519             Rename(OldClearSig, FinalFile);
1520       }
1521       DestFile = FinalFile;
1522    }
1523    Complete = true;
1524 }
1525                                                                         /*}}}*/
1526 void pkgAcqMetaIndex::AuthDone(string Message)                          /*{{{*/
1527 {
1528    // At this point, the gpgv method has succeeded, so there is a
1529    // valid signature from a key in the trusted keyring.  We
1530    // perform additional verification of its contents, and use them
1531    // to verify the indexes we are about to download
1532
1533    if (!MetaIndexParser->Load(DestFile))
1534    {
1535       Status = StatAuthError;
1536       ErrorText = MetaIndexParser->ErrorText;
1537       return;
1538    }
1539
1540    if (!VerifyVendor(Message))
1541    {
1542       return;
1543    }
1544
1545    if (_config->FindB("Debug::pkgAcquire::Auth", false))
1546       std::cerr << "Signature verification succeeded: "
1547                 << DestFile << std::endl;
1548
1549    // do not trust any previously unverified content that we may have
1550    string LastGoodSigFile = _config->FindDir("Dir::State::lists").append("partial/").append(URItoFileName(RealURI));
1551    if (DestFile != SigFile)
1552       LastGoodSigFile.append(".gpg");
1553    LastGoodSigFile.append(".reverify");
1554    if(IMSHit == false && RealFileExists(LastGoodSigFile) == false)
1555    {
1556       for (vector <struct IndexTarget*>::const_iterator Target = IndexTargets->begin();
1557            Target != IndexTargets->end();
1558            ++Target)
1559       {
1560          // remove old indexes
1561          std::string index = _config->FindDir("Dir::State::lists") +
1562             URItoFileName((*Target)->URI);
1563          unlink(index.c_str());
1564          // and also old gzipindexes
1565          std::vector<std::string> types = APT::Configuration::getCompressionTypes();
1566          for (std::vector<std::string>::const_iterator t = types.begin(); t != types.end(); ++t)
1567          {
1568             index += '.' + (*t);
1569             unlink(index.c_str());
1570          }
1571       }
1572    }
1573
1574
1575    // Download further indexes with verification
1576    QueueIndexes(true);
1577
1578    // is it a clearsigned MetaIndex file?
1579    if (DestFile == SigFile)
1580       return;
1581
1582    // Done, move signature file into position
1583    string VerifiedSigFile = _config->FindDir("Dir::State::lists") +
1584       URItoFileName(RealURI) + ".gpg";
1585    Rename(SigFile,VerifiedSigFile);
1586    chmod(VerifiedSigFile.c_str(),0644);
1587 }
1588                                                                         /*}}}*/
1589 void pkgAcqMetaIndex::QueueIndexes(bool verify)                         /*{{{*/
1590 {
1591 #if 0
1592    /* Reject invalid, existing Release files (LP: #346386) (Closes: #627642)
1593     * FIXME: Disabled; it breaks unsigned repositories without hashes */
1594    if (!verify && FileExists(DestFile) && !MetaIndexParser->Load(DestFile))
1595    {
1596       Status = StatError;
1597       ErrorText = MetaIndexParser->ErrorText;
1598       return;
1599    }
1600 #endif
1601    bool transInRelease = false;
1602    {
1603       std::vector<std::string> const keys = MetaIndexParser->MetaKeys();
1604       for (std::vector<std::string>::const_iterator k = keys.begin(); k != keys.end(); ++k)
1605          // FIXME: Feels wrong to check for hardcoded string here, but what should we do else…
1606          if (k->find("Translation-") != std::string::npos)
1607          {
1608             transInRelease = true;
1609             break;
1610          }
1611    }
1612
1613    for (vector <struct IndexTarget*>::const_iterator Target = IndexTargets->begin();
1614         Target != IndexTargets->end();
1615         ++Target)
1616    {
1617       HashString ExpectedIndexHash;
1618       const indexRecords::checkSum *Record = MetaIndexParser->Lookup((*Target)->MetaKey);
1619       bool compressedAvailable = false;
1620       if (Record == NULL)
1621       {
1622          if ((*Target)->IsOptional() == true)
1623          {
1624             std::vector<std::string> types = APT::Configuration::getCompressionTypes();
1625             for (std::vector<std::string>::const_iterator t = types.begin(); t != types.end(); ++t)
1626                if (MetaIndexParser->Exists((*Target)->MetaKey + "." + *t) == true)
1627                {
1628                   compressedAvailable = true;
1629                   break;
1630                }
1631          }
1632          else if (verify == true)
1633          {
1634             Status = StatAuthError;
1635             strprintf(ErrorText, _("Unable to find expected entry '%s' in Release file (Wrong sources.list entry or malformed file)"), (*Target)->MetaKey.c_str());
1636             return;
1637          }
1638       }
1639       else
1640       {
1641          ExpectedIndexHash = Record->Hash;
1642          if (_config->FindB("Debug::pkgAcquire::Auth", false))
1643          {
1644             std::cerr << "Queueing: " << (*Target)->URI << std::endl;
1645             std::cerr << "Expected Hash: " << ExpectedIndexHash.toStr() << std::endl;
1646             std::cerr << "For: " << Record->MetaKeyFilename << std::endl;
1647          }
1648          if (verify == true && ExpectedIndexHash.empty() == true && (*Target)->IsOptional() == false)
1649          {
1650             Status = StatAuthError;
1651             strprintf(ErrorText, _("Unable to find hash sum for '%s' in Release file"), (*Target)->MetaKey.c_str());
1652             return;
1653          }
1654       }
1655
1656       if ((*Target)->IsOptional() == true)
1657       {
1658          if ((*Target)->IsSubIndex() == true)
1659             new pkgAcqSubIndex(Owner, (*Target)->URI, (*Target)->Description,
1660                                 (*Target)->ShortDesc, ExpectedIndexHash);
1661          else if (transInRelease == false || Record != NULL || compressedAvailable == true)
1662          {
1663             if (_config->FindB("Acquire::PDiffs",true) == true && transInRelease == true &&
1664                 MetaIndexParser->Exists((*Target)->MetaKey + ".diff/Index") == true)
1665                new pkgAcqDiffIndex(Owner, (*Target)->URI, (*Target)->Description,
1666                                    (*Target)->ShortDesc, ExpectedIndexHash);
1667             else
1668                new pkgAcqIndexTrans(Owner, *Target, ExpectedIndexHash, MetaIndexParser);
1669          }
1670          continue;
1671       }
1672
1673       /* Queue Packages file (either diff or full packages files, depending
1674          on the users option) - we also check if the PDiff Index file is listed
1675          in the Meta-Index file. Ideal would be if pkgAcqDiffIndex would test this
1676          instead, but passing the required info to it is to much hassle */
1677       if(_config->FindB("Acquire::PDiffs",true) == true && (verify == false ||
1678           MetaIndexParser->Exists((*Target)->MetaKey + ".diff/Index") == true))
1679          new pkgAcqDiffIndex(Owner, (*Target)->URI, (*Target)->Description,
1680                              (*Target)->ShortDesc, ExpectedIndexHash);
1681       else
1682          new pkgAcqIndex(Owner, *Target, ExpectedIndexHash, MetaIndexParser);
1683    }
1684 }
1685                                                                         /*}}}*/
1686 bool pkgAcqMetaIndex::VerifyVendor(string Message)                      /*{{{*/
1687 {
1688    string::size_type pos;
1689
1690    // check for missing sigs (that where not fatal because otherwise we had
1691    // bombed earlier)
1692    string missingkeys;
1693    string msg = _("There is no public key available for the "
1694                   "following key IDs:\n");
1695    pos = Message.find("NO_PUBKEY ");
1696    if (pos != std::string::npos)
1697    {
1698       string::size_type start = pos+strlen("NO_PUBKEY ");
1699       string Fingerprint = Message.substr(start, Message.find("\n")-start);
1700       missingkeys += (Fingerprint);
1701    }
1702    if(!missingkeys.empty())
1703       _error->Warning("%s", (msg + missingkeys).c_str());
1704
1705    string Transformed = MetaIndexParser->GetExpectedDist();
1706
1707    if (Transformed == "../project/experimental")
1708    {
1709       Transformed = "experimental";
1710    }
1711
1712    pos = Transformed.rfind('/');
1713    if (pos != string::npos)
1714    {
1715       Transformed = Transformed.substr(0, pos);
1716    }
1717
1718    if (Transformed == ".")
1719    {
1720       Transformed = "";
1721    }
1722
1723    if (_config->FindB("Acquire::Check-Valid-Until", true) == true &&
1724        MetaIndexParser->GetValidUntil() > 0) {
1725       time_t const invalid_since = time(NULL) - MetaIndexParser->GetValidUntil();
1726       if (invalid_since > 0)
1727          // TRANSLATOR: The first %s is the URL of the bad Release file, the second is
1728          // the time since then the file is invalid - formated in the same way as in
1729          // the download progress display (e.g. 7d 3h 42min 1s)
1730          return _error->Error(
1731             _("Release file for %s is expired (invalid since %s). "
1732               "Updates for this repository will not be applied."),
1733             RealURI.c_str(), TimeToStr(invalid_since).c_str());
1734    }
1735
1736    if (_config->FindB("Debug::pkgAcquire::Auth", false))
1737    {
1738       std::cerr << "Got Codename: " << MetaIndexParser->GetDist() << std::endl;
1739       std::cerr << "Expecting Dist: " << MetaIndexParser->GetExpectedDist() << std::endl;
1740       std::cerr << "Transformed Dist: " << Transformed << std::endl;
1741    }
1742
1743    if (MetaIndexParser->CheckDist(Transformed) == false)
1744    {
1745       // This might become fatal one day
1746 //       Status = StatAuthError;
1747 //       ErrorText = "Conflicting distribution; expected "
1748 //          + MetaIndexParser->GetExpectedDist() + " but got "
1749 //          + MetaIndexParser->GetDist();
1750 //       return false;
1751       if (!Transformed.empty())
1752       {
1753          _error->Warning(_("Conflicting distribution: %s (expected %s but got %s)"),
1754                          Desc.Description.c_str(),
1755                          Transformed.c_str(),
1756                          MetaIndexParser->GetDist().c_str());
1757       }
1758    }
1759
1760    return true;
1761 }
1762                                                                         /*}}}*/
1763 // pkgAcqMetaIndex::Failed - no Release file present or no signature file present       /*{{{*/
1764 // ---------------------------------------------------------------------
1765 /* */
1766 void pkgAcqMetaIndex::Failed(string Message,pkgAcquire::MethodConfig * /*Cnf*/)
1767 {
1768    if (AuthPass == true)
1769    {
1770       // gpgv method failed, if we have a good signature
1771       string LastGoodSigFile = _config->FindDir("Dir::State::lists").append("partial/").append(URItoFileName(RealURI));
1772       if (DestFile != SigFile)
1773          LastGoodSigFile.append(".gpg");
1774       LastGoodSigFile.append(".reverify");
1775
1776       if(FileExists(LastGoodSigFile))
1777       {
1778          string VerifiedSigFile = _config->FindDir("Dir::State::lists") + URItoFileName(RealURI);
1779          if (DestFile != SigFile)
1780             VerifiedSigFile.append(".gpg");
1781          Rename(LastGoodSigFile, VerifiedSigFile);
1782          Status = StatTransientNetworkError;
1783          _error->Warning(_("An error occurred during the signature "
1784                            "verification. The repository is not updated "
1785                            "and the previous index files will be used. "
1786                            "GPG error: %s: %s\n"),
1787                          Desc.Description.c_str(),
1788                          LookupTag(Message,"Message").c_str());
1789          RunScripts("APT::Update::Auth-Failure");
1790          return;
1791       } else if (LookupTag(Message,"Message").find("NODATA") != string::npos) {
1792          /* Invalid signature file, reject (LP: #346386) (Closes: #627642) */
1793          _error->Error(_("GPG error: %s: %s"),
1794                          Desc.Description.c_str(),
1795                          LookupTag(Message,"Message").c_str());
1796          return;
1797       } else {
1798          _error->Warning(_("GPG error: %s: %s"),
1799                          Desc.Description.c_str(),
1800                          LookupTag(Message,"Message").c_str());
1801       }
1802       // gpgv method failed
1803       ReportMirrorFailure("GPGFailure");
1804    }
1805
1806    /* Always move the meta index, even if gpgv failed. This ensures
1807     * that PackageFile objects are correctly filled in */
1808    if (FileExists(DestFile)) {
1809       string FinalFile = _config->FindDir("Dir::State::lists");
1810       FinalFile += URItoFileName(RealURI);
1811       /* InRelease files become Release files, otherwise
1812        * they would be considered as trusted later on */
1813       if (SigFile == DestFile) {
1814          RealURI = RealURI.replace(RealURI.rfind("InRelease"), 9,
1815                                        "Release");
1816          FinalFile = FinalFile.replace(FinalFile.rfind("InRelease"), 9,
1817                                        "Release");
1818          SigFile = FinalFile;
1819       }
1820       Rename(DestFile,FinalFile);
1821       chmod(FinalFile.c_str(),0644);
1822
1823       DestFile = FinalFile;
1824    }
1825
1826    // No Release file was present, or verification failed, so fall
1827    // back to queueing Packages files without verification
1828    QueueIndexes(false);
1829 }
1830                                                                         /*}}}*/
1831 pkgAcqMetaClearSig::pkgAcqMetaClearSig(pkgAcquire *Owner,               /*{{{*/
1832                 string const &URI, string const &URIDesc, string const &ShortDesc,
1833                 string const &MetaIndexURI, string const &MetaIndexURIDesc, string const &MetaIndexShortDesc,
1834                 string const &MetaSigURI, string const &MetaSigURIDesc, string const &MetaSigShortDesc,
1835                 const vector<struct IndexTarget*>* IndexTargets,
1836                 indexRecords* MetaIndexParser) :
1837         pkgAcqMetaIndex(Owner, URI, URIDesc, ShortDesc, "", IndexTargets, MetaIndexParser),
1838         MetaIndexURI(MetaIndexURI), MetaIndexURIDesc(MetaIndexURIDesc), MetaIndexShortDesc(MetaIndexShortDesc),
1839         MetaSigURI(MetaSigURI), MetaSigURIDesc(MetaSigURIDesc), MetaSigShortDesc(MetaSigShortDesc)
1840 {
1841    SigFile = DestFile;
1842
1843    // keep the old InRelease around in case of transistent network errors
1844    string const Final = _config->FindDir("Dir::State::lists") + URItoFileName(RealURI);
1845    if (RealFileExists(Final) == true)
1846    {
1847       string const LastGoodSig = DestFile + ".reverify";
1848       Rename(Final,LastGoodSig);
1849    }
1850 }
1851                                                                         /*}}}*/
1852 pkgAcqMetaClearSig::~pkgAcqMetaClearSig()                               /*{{{*/
1853 {
1854    // if the file was never queued undo file-changes done in the constructor
1855    if (QueueCounter == 1 && Status == StatIdle && FileSize == 0 && Complete == false)
1856    {
1857       string const Final = _config->FindDir("Dir::State::lists") + URItoFileName(RealURI);
1858       string const LastGoodSig = DestFile + ".reverify";
1859       if (RealFileExists(Final) == false && RealFileExists(LastGoodSig) == true)
1860          Rename(LastGoodSig, Final);
1861    }
1862 }
1863                                                                         /*}}}*/
1864 // pkgAcqMetaClearSig::Custom600Headers - Insert custom request headers /*{{{*/
1865 // ---------------------------------------------------------------------
1866 // FIXME: this can go away once the InRelease file is used widely
1867 string pkgAcqMetaClearSig::Custom600Headers()
1868 {
1869    string Final = _config->FindDir("Dir::State::lists");
1870    Final += URItoFileName(RealURI);
1871
1872    struct stat Buf;
1873    if (stat(Final.c_str(),&Buf) != 0)
1874    {
1875       Final = DestFile + ".reverify";
1876       if (stat(Final.c_str(),&Buf) != 0)
1877          return "\nIndex-File: true\nFail-Ignore: true\n";
1878    }
1879
1880    return "\nIndex-File: true\nFail-Ignore: true\nLast-Modified: " + TimeRFC1123(Buf.st_mtime);
1881 }
1882                                                                         /*}}}*/
1883 void pkgAcqMetaClearSig::Failed(string Message,pkgAcquire::MethodConfig *Cnf) /*{{{*/
1884 {
1885    if (AuthPass == false)
1886    {
1887       // Remove the 'old' InRelease file if we try Release.gpg now as otherwise
1888       // the file will stay around and gives a false-auth impression (CVE-2012-0214)
1889       string FinalFile = _config->FindDir("Dir::State::lists");
1890       FinalFile.append(URItoFileName(RealURI));
1891       if (FileExists(FinalFile))
1892          unlink(FinalFile.c_str());
1893
1894       new pkgAcqMetaSig(Owner,
1895                         MetaSigURI, MetaSigURIDesc, MetaSigShortDesc,
1896                         MetaIndexURI, MetaIndexURIDesc, MetaIndexShortDesc,
1897                         IndexTargets, MetaIndexParser);
1898       if (Cnf->LocalOnly == true ||
1899           StringToBool(LookupTag(Message, "Transient-Failure"), false) == false)
1900          Dequeue();
1901    }
1902    else
1903       pkgAcqMetaIndex::Failed(Message, Cnf);
1904 }
1905                                                                         /*}}}*/
1906 // AcqArchive::AcqArchive - Constructor                                 /*{{{*/
1907 // ---------------------------------------------------------------------
1908 /* This just sets up the initial fetch environment and queues the first
1909    possibilitiy */
1910 pkgAcqArchive::pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
1911                              pkgRecords *Recs,pkgCache::VerIterator const &Version,
1912                              string &StoreFilename) :
1913                Item(Owner), Version(Version), Sources(Sources), Recs(Recs),
1914                StoreFilename(StoreFilename), Vf(Version.FileList()),
1915                Trusted(false)
1916 {
1917    Retries = _config->FindI("Acquire::Retries",0);
1918
1919    if (Version.Arch() == 0)
1920    {
1921       _error->Error(_("I wasn't able to locate a file for the %s package. "
1922                       "This might mean you need to manually fix this package. "
1923                       "(due to missing arch)"),
1924                     Version.ParentPkg().FullName().c_str());
1925       return;
1926    }
1927
1928    /* We need to find a filename to determine the extension. We make the
1929       assumption here that all the available sources for this version share
1930       the same extension.. */
1931    // Skip not source sources, they do not have file fields.
1932    for (; Vf.end() == false; ++Vf)
1933    {
1934       if ((Vf.File()->Flags & pkgCache::Flag::NotSource) != 0)
1935          continue;
1936       break;
1937    }
1938
1939    // Does not really matter here.. we are going to fail out below
1940    if (Vf.end() != true)
1941    {
1942       // If this fails to get a file name we will bomb out below.
1943       pkgRecords::Parser &Parse = Recs->Lookup(Vf);
1944       if (_error->PendingError() == true)
1945          return;
1946
1947       // Generate the final file name as: package_version_arch.foo
1948       StoreFilename = QuoteString(Version.ParentPkg().Name(),"_:") + '_' +
1949                       QuoteString(Version.VerStr(),"_:") + '_' +
1950                       QuoteString(Version.Arch(),"_:.") +
1951                       "." + flExtension(Parse.FileName());
1952    }
1953
1954    // check if we have one trusted source for the package. if so, switch
1955    // to "TrustedOnly" mode - but only if not in AllowUnauthenticated mode
1956    bool const allowUnauth = _config->FindB("APT::Get::AllowUnauthenticated", false);
1957    bool const debugAuth = _config->FindB("Debug::pkgAcquire::Auth", false);
1958    bool seenUntrusted = false;
1959    for (pkgCache::VerFileIterator i = Version.FileList(); i.end() == false; ++i)
1960    {
1961       pkgIndexFile *Index;
1962       if (Sources->FindIndex(i.File(),Index) == false)
1963          continue;
1964
1965       if (debugAuth == true)
1966          std::cerr << "Checking index: " << Index->Describe()
1967                    << "(Trusted=" << Index->IsTrusted() << ")" << std::endl;
1968
1969       if (Index->IsTrusted() == true)
1970       {
1971          Trusted = true;
1972          if (allowUnauth == false)
1973             break;
1974       }
1975       else
1976          seenUntrusted = true;
1977    }
1978
1979    // "allow-unauthenticated" restores apts old fetching behaviour
1980    // that means that e.g. unauthenticated file:// uris are higher
1981    // priority than authenticated http:// uris
1982    if (allowUnauth == true && seenUntrusted == true)
1983       Trusted = false;
1984
1985    // Select a source
1986    if (QueueNext() == false && _error->PendingError() == false)
1987       _error->Error(_("Can't find a source to download version '%s' of '%s'"),
1988                     Version.VerStr(), Version.ParentPkg().FullName(false).c_str());
1989 }
1990                                                                         /*}}}*/
1991 // AcqArchive::QueueNext - Queue the next file source                   /*{{{*/
1992 // ---------------------------------------------------------------------
1993 /* This queues the next available file version for download. It checks if
1994    the archive is already available in the cache and stashs the MD5 for
1995    checking later. */
1996 bool pkgAcqArchive::QueueNext()
1997 {
1998    string const ForceHash = _config->Find("Acquire::ForceHash");
1999    for (; Vf.end() == false; ++Vf)
2000    {
2001       // Ignore not source sources
2002       if ((Vf.File()->Flags & pkgCache::Flag::NotSource) != 0)
2003          continue;
2004
2005       // Try to cross match against the source list
2006       pkgIndexFile *Index;
2007       if (Sources->FindIndex(Vf.File(),Index) == false)
2008             continue;
2009
2010       // only try to get a trusted package from another source if that source
2011       // is also trusted
2012       if(Trusted && !Index->IsTrusted())
2013          continue;
2014
2015       // Grab the text package record
2016       pkgRecords::Parser &Parse = Recs->Lookup(Vf);
2017       if (_error->PendingError() == true)
2018          return false;
2019
2020       string PkgFile = Parse.FileName();
2021       if (ForceHash.empty() == false)
2022       {
2023          if(stringcasecmp(ForceHash, "sha512") == 0)
2024             ExpectedHash = HashString("SHA512", Parse.SHA512Hash());
2025          else if(stringcasecmp(ForceHash, "sha256") == 0)
2026             ExpectedHash = HashString("SHA256", Parse.SHA256Hash());
2027          else if (stringcasecmp(ForceHash, "sha1") == 0)
2028             ExpectedHash = HashString("SHA1", Parse.SHA1Hash());
2029          else
2030             ExpectedHash = HashString("MD5Sum", Parse.MD5Hash());
2031       }
2032       else
2033       {
2034          string Hash;
2035          if ((Hash = Parse.SHA512Hash()).empty() == false)
2036             ExpectedHash = HashString("SHA512", Hash);
2037          else if ((Hash = Parse.SHA256Hash()).empty() == false)
2038             ExpectedHash = HashString("SHA256", Hash);
2039          else if ((Hash = Parse.SHA1Hash()).empty() == false)
2040             ExpectedHash = HashString("SHA1", Hash);
2041          else
2042             ExpectedHash = HashString("MD5Sum", Parse.MD5Hash());
2043       }
2044       if (PkgFile.empty() == true)
2045          return _error->Error(_("The package index files are corrupted. No Filename: "
2046                               "field for package %s."),
2047                               Version.ParentPkg().Name());
2048
2049       Desc.URI = Index->ArchiveURI(PkgFile);
2050       Desc.Description = Index->ArchiveInfo(Version);
2051       Desc.Owner = this;
2052       Desc.ShortDesc = Version.ParentPkg().FullName(true);
2053
2054       // See if we already have the file. (Legacy filenames)
2055       FileSize = Version->Size;
2056       string FinalFile = _config->FindDir("Dir::Cache::Archives") + flNotDir(PkgFile);
2057       struct stat Buf;
2058       if (stat(FinalFile.c_str(),&Buf) == 0)
2059       {
2060          // Make sure the size matches
2061          if ((unsigned long long)Buf.st_size == Version->Size)
2062          {
2063             Complete = true;
2064             Local = true;
2065             Status = StatDone;
2066             StoreFilename = DestFile = FinalFile;
2067             return true;
2068          }
2069
2070          /* Hmm, we have a file and its size does not match, this means it is
2071             an old style mismatched arch */
2072          unlink(FinalFile.c_str());
2073       }
2074
2075       // Check it again using the new style output filenames
2076       FinalFile = _config->FindDir("Dir::Cache::Archives") + flNotDir(StoreFilename);
2077       if (stat(FinalFile.c_str(),&Buf) == 0)
2078       {
2079          // Make sure the size matches
2080          if ((unsigned long long)Buf.st_size == Version->Size)
2081          {
2082             Complete = true;
2083             Local = true;
2084             Status = StatDone;
2085             StoreFilename = DestFile = FinalFile;
2086             return true;
2087          }
2088
2089          /* Hmm, we have a file and its size does not match, this shouldn't
2090             happen.. */
2091          unlink(FinalFile.c_str());
2092       }
2093
2094       DestFile = _config->FindDir("Dir::Cache::Archives") + "partial/" + flNotDir(StoreFilename);
2095
2096       // Check the destination file
2097       if (stat(DestFile.c_str(),&Buf) == 0)
2098       {
2099          // Hmm, the partial file is too big, erase it
2100          if ((unsigned long long)Buf.st_size > Version->Size)
2101             unlink(DestFile.c_str());
2102          else
2103             PartialSize = Buf.st_size;
2104       }
2105
2106       // Disables download of archives - useful if no real installation follows,
2107       // e.g. if we are just interested in proposed installation order
2108       if (_config->FindB("Debug::pkgAcqArchive::NoQueue", false) == true)
2109       {
2110          Complete = true;
2111          Local = true;
2112          Status = StatDone;
2113          StoreFilename = DestFile = FinalFile;
2114          return true;
2115       }
2116
2117       // Create the item
2118       Local = false;
2119       QueueURI(Desc);
2120
2121       ++Vf;
2122       return true;
2123    }
2124    return false;
2125 }
2126                                                                         /*}}}*/
2127 // AcqArchive::Done - Finished fetching                                 /*{{{*/
2128 // ---------------------------------------------------------------------
2129 /* */
2130 void pkgAcqArchive::Done(string Message,unsigned long long Size,string CalcHash,
2131                          pkgAcquire::MethodConfig *Cfg)
2132 {
2133    Item::Done(Message,Size,CalcHash,Cfg);
2134
2135    // Check the size
2136    if (Size != Version->Size)
2137    {
2138       RenameOnError(SizeMismatch);
2139       return;
2140    }
2141
2142    // Check the hash
2143    if(ExpectedHash.toStr() != CalcHash)
2144    {
2145       RenameOnError(HashSumMismatch);
2146       return;
2147    }
2148
2149    // Grab the output filename
2150    string FileName = LookupTag(Message,"Filename");
2151    if (FileName.empty() == true)
2152    {
2153       Status = StatError;
2154       ErrorText = "Method gave a blank filename";
2155       return;
2156    }
2157
2158    Complete = true;
2159
2160    // Reference filename
2161    if (FileName != DestFile)
2162    {
2163       StoreFilename = DestFile = FileName;
2164       Local = true;
2165       return;
2166    }
2167
2168    // Done, move it into position
2169    string FinalFile = _config->FindDir("Dir::Cache::Archives");
2170    FinalFile += flNotDir(StoreFilename);
2171    Rename(DestFile,FinalFile);
2172
2173    StoreFilename = DestFile = FinalFile;
2174    Complete = true;
2175 }
2176                                                                         /*}}}*/
2177 // AcqArchive::Failed - Failure handler                                 /*{{{*/
2178 // ---------------------------------------------------------------------
2179 /* Here we try other sources */
2180 void pkgAcqArchive::Failed(string Message,pkgAcquire::MethodConfig *Cnf)
2181 {
2182    ErrorText = LookupTag(Message,"Message");
2183
2184    /* We don't really want to retry on failed media swaps, this prevents
2185       that. An interesting observation is that permanent failures are not
2186       recorded. */
2187    if (Cnf->Removable == true &&
2188        StringToBool(LookupTag(Message,"Transient-Failure"),false) == true)
2189    {
2190       // Vf = Version.FileList();
2191       while (Vf.end() == false) ++Vf;
2192       StoreFilename = string();
2193       Item::Failed(Message,Cnf);
2194       return;
2195    }
2196
2197    if (QueueNext() == false)
2198    {
2199       // This is the retry counter
2200       if (Retries != 0 &&
2201           Cnf->LocalOnly == false &&
2202           StringToBool(LookupTag(Message,"Transient-Failure"),false) == true)
2203       {
2204          Retries--;
2205          Vf = Version.FileList();
2206          if (QueueNext() == true)
2207             return;
2208       }
2209
2210       StoreFilename = string();
2211       Item::Failed(Message,Cnf);
2212    }
2213 }
2214                                                                         /*}}}*/
2215 // AcqArchive::IsTrusted - Determine whether this archive comes from a trusted source /*{{{*/
2216 // ---------------------------------------------------------------------
2217 APT_PURE bool pkgAcqArchive::IsTrusted()
2218 {
2219    return Trusted;
2220 }
2221                                                                         /*}}}*/
2222 // AcqArchive::Finished - Fetching has finished, tidy up                /*{{{*/
2223 // ---------------------------------------------------------------------
2224 /* */
2225 void pkgAcqArchive::Finished()
2226 {
2227    if (Status == pkgAcquire::Item::StatDone &&
2228        Complete == true)
2229       return;
2230    StoreFilename = string();
2231 }
2232                                                                         /*}}}*/
2233 // AcqFile::pkgAcqFile - Constructor                                    /*{{{*/
2234 // ---------------------------------------------------------------------
2235 /* The file is added to the queue */
2236 pkgAcqFile::pkgAcqFile(pkgAcquire *Owner,string URI,string Hash,
2237                        unsigned long long Size,string Dsc,string ShortDesc,
2238                        const string &DestDir, const string &DestFilename,
2239                        bool IsIndexFile) :
2240                        Item(Owner), ExpectedHash(Hash), IsIndexFile(IsIndexFile)
2241 {
2242    Retries = _config->FindI("Acquire::Retries",0);
2243
2244    if(!DestFilename.empty())
2245       DestFile = DestFilename;
2246    else if(!DestDir.empty())
2247       DestFile = DestDir + "/" + flNotDir(URI);
2248    else
2249       DestFile = flNotDir(URI);
2250
2251    // Create the item
2252    Desc.URI = URI;
2253    Desc.Description = Dsc;
2254    Desc.Owner = this;
2255
2256    // Set the short description to the archive component
2257    Desc.ShortDesc = ShortDesc;
2258
2259    // Get the transfer sizes
2260    FileSize = Size;
2261    struct stat Buf;
2262    if (stat(DestFile.c_str(),&Buf) == 0)
2263    {
2264       // Hmm, the partial file is too big, erase it
2265       if ((Size > 0) && (unsigned long long)Buf.st_size > Size)
2266          unlink(DestFile.c_str());
2267       else
2268          PartialSize = Buf.st_size;
2269    }
2270
2271    QueueURI(Desc);
2272 }
2273                                                                         /*}}}*/
2274 // AcqFile::Done - Item downloaded OK                                   /*{{{*/
2275 // ---------------------------------------------------------------------
2276 /* */
2277 void pkgAcqFile::Done(string Message,unsigned long long Size,string CalcHash,
2278                       pkgAcquire::MethodConfig *Cnf)
2279 {
2280    Item::Done(Message,Size,CalcHash,Cnf);
2281
2282    // Check the hash
2283    if(!ExpectedHash.empty() && ExpectedHash.toStr() != CalcHash)
2284    {
2285       RenameOnError(HashSumMismatch);
2286       return;
2287    }
2288
2289    string FileName = LookupTag(Message,"Filename");
2290    if (FileName.empty() == true)
2291    {
2292       Status = StatError;
2293       ErrorText = "Method gave a blank filename";
2294       return;
2295    }
2296
2297    Complete = true;
2298
2299    // The files timestamp matches
2300    if (StringToBool(LookupTag(Message,"IMS-Hit"),false) == true)
2301       return;
2302
2303    // We have to copy it into place
2304    if (FileName != DestFile)
2305    {
2306       Local = true;
2307       if (_config->FindB("Acquire::Source-Symlinks",true) == false ||
2308           Cnf->Removable == true)
2309       {
2310          Desc.URI = "copy:" + FileName;
2311          QueueURI(Desc);
2312          return;
2313       }
2314
2315       // Erase the file if it is a symlink so we can overwrite it
2316       struct stat St;
2317       if (lstat(DestFile.c_str(),&St) == 0)
2318       {
2319          if (S_ISLNK(St.st_mode) != 0)
2320             unlink(DestFile.c_str());
2321       }
2322
2323       // Symlink the file
2324       if (symlink(FileName.c_str(),DestFile.c_str()) != 0)
2325       {
2326          ErrorText = "Link to " + DestFile + " failure ";
2327          Status = StatError;
2328          Complete = false;
2329       }
2330    }
2331 }
2332                                                                         /*}}}*/
2333 // AcqFile::Failed - Failure handler                                    /*{{{*/
2334 // ---------------------------------------------------------------------
2335 /* Here we try other sources */
2336 void pkgAcqFile::Failed(string Message,pkgAcquire::MethodConfig *Cnf)
2337 {
2338    ErrorText = LookupTag(Message,"Message");
2339
2340    // This is the retry counter
2341    if (Retries != 0 &&
2342        Cnf->LocalOnly == false &&
2343        StringToBool(LookupTag(Message,"Transient-Failure"),false) == true)
2344    {
2345       Retries--;
2346       QueueURI(Desc);
2347       return;
2348    }
2349
2350    Item::Failed(Message,Cnf);
2351 }
2352                                                                         /*}}}*/
2353 // AcqIndex::Custom600Headers - Insert custom request headers           /*{{{*/
2354 // ---------------------------------------------------------------------
2355 /* The only header we use is the last-modified header. */
2356 string pkgAcqFile::Custom600Headers()
2357 {
2358    if (IsIndexFile)
2359       return "\nIndex-File: true";
2360    return "";
2361 }
2362                                                                         /*}}}*/