apt-pkg/acquire-worker.cc

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: acquire-worker.cc,v 1.34 2001/05/22 04:42:54 jgg Exp $
   4 /* ######################################################################
   5
   6    Acquire Worker
   7
   8    The worker process can startup either as a Configuration prober
   9    or as a queue runner. As a configuration prober it only reads the
  10    configuration message and
  11
  12    ##################################################################### */
  13                                                                         /*}}}*/
  14 // Include Files                                                        /*{{{*/
  15 #include <apt-pkg/acquire-worker.h>
  16 #include <apt-pkg/acquire-item.h>
  17 #include <apt-pkg/configuration.h>
  18 #include <apt-pkg/error.h>
  19 #include <apt-pkg/fileutl.h>
  20 #include <apt-pkg/strutl.h>
  21
  22 #include <apti18n.h>
  23
  24 #include <iostream>
  25 #include <sstream>
  26 #include <fstream>
  27
  28 #include <sys/stat.h>
  29 #include <unistd.h>
  30 #include <fcntl.h>
  31 #include <signal.h>
  32 #include <stdio.h>
  33 #include <errno.h>
  34                                                                         /*}}}*/
  35
  36 using namespace std;
  37
  38 // Worker::Worker - Constructor for Queue startup                       /*{{{*/
  39 // ---------------------------------------------------------------------
  40 /* */
  41 pkgAcquire::Worker::Worker(Queue *Q,MethodConfig *Cnf,
  42                            pkgAcquireStatus *Log) : Log(Log)
  43 {
  44    OwnerQ = Q;
  45    Config = Cnf;
  46    Access = Cnf->Access;
  47    CurrentItem = 0;
  48    TotalSize = 0;
  49    CurrentSize = 0;
  50
  51    Construct();
  52 }
  53                                                                         /*}}}*/
  54 // Worker::Worker - Constructor for method config startup               /*{{{*/
  55 // ---------------------------------------------------------------------
  56 /* */
  57 pkgAcquire::Worker::Worker(MethodConfig *Cnf)
  58 {
  59    OwnerQ = 0;
  60    Config = Cnf;
  61    Access = Cnf->Access;
  62    CurrentItem = 0;
  63    TotalSize = 0;
  64    CurrentSize = 0;
  65
  66    Construct();
  67 }
  68                                                                         /*}}}*/
  69 // Worker::Construct - Constructor helper                               /*{{{*/
  70 // ---------------------------------------------------------------------
  71 /* */
  72 void pkgAcquire::Worker::Construct()
  73 {
  74    NextQueue = 0;
  75    NextAcquire = 0;
  76    Process = -1;
  77    InFd = -1;
  78    OutFd = -1;
  79    OutReady = false;
  80    InReady = false;
  81    Debug = _config->FindB("Debug::pkgAcquire::Worker",false);
  82 }
  83                                                                         /*}}}*/
  84 // Worker::~Worker - Destructor                                         /*{{{*/
  85 // ---------------------------------------------------------------------
  86 /* */
  87 pkgAcquire::Worker::~Worker()
  88 {
  89    close(InFd);
  90    close(OutFd);
  91
  92    if (Process > 0)
  93    {
  94       /* Closing of stdin is the signal to exit and die when the process
  95          indicates it needs cleanup */
  96       if (Config->NeedsCleanup == false)
  97          kill(Process,SIGINT);
  98       ExecWait(Process,Access.c_str(),true);
  99    }
 100 }
 101                                                                         /*}}}*/
 102 // Worker::Start - Start the worker process                             /*{{{*/
 103 // ---------------------------------------------------------------------
 104 /* This forks the method and inits the communication channel */
 105 bool pkgAcquire::Worker::Start()
 106 {
 107    // Get the method path
 108    string Method = _config->FindDir("Dir::Bin::Methods") + Access;
 109    if (FileExists(Method) == false)
 110       return _error->Error(_("The method driver %s could not be found."),Method.c_str());
 111
 112    if (Debug == true)
 113       clog << "Starting method '" << Method << '\'' << endl;
 114
 115    // Create the pipes
 116    int Pipes[4] = {-1,-1,-1,-1};
 117    if (pipe(Pipes) != 0 || pipe(Pipes+2) != 0)
 118    {
 119       _error->Errno("pipe","Failed to create IPC pipe to subprocess");
 120       for (int I = 0; I != 4; I++)
 121          close(Pipes[I]);
 122       return false;
 123    }
 124    for (int I = 0; I != 4; I++)
 125       SetCloseExec(Pipes[I],true);
 126
 127    // Fork off the process
 128    Process = ExecFork();
 129    if (Process == 0)
 130    {
 131       // Setup the FDs
 132       dup2(Pipes[1],STDOUT_FILENO);
 133       dup2(Pipes[2],STDIN_FILENO);
 134       SetCloseExec(STDOUT_FILENO,false);
 135       SetCloseExec(STDIN_FILENO,false);
 136       SetCloseExec(STDERR_FILENO,false);
 137
 138       const char *Args[2];
 139       Args[0] = Method.c_str();
 140       Args[1] = 0;
 141       execv(Args[0],(char **)Args);
 142       cerr << "Failed to exec method " << Args[0] << endl;
 143       _exit(100);
 144    }
 145
 146    // Fix up our FDs
 147    InFd = Pipes[0];
 148    OutFd = Pipes[3];
 149    SetNonBlock(Pipes[0],true);
 150    SetNonBlock(Pipes[3],true);
 151    close(Pipes[1]);
 152    close(Pipes[2]);
 153    OutReady = false;
 154    InReady = true;
 155
 156    // Read the configuration data
 157    if (WaitFd(InFd) == false ||
 158        ReadMessages() == false)
 159       return _error->Error(_("Method %s did not start correctly"),Method.c_str());
 160
 161    RunMessages();
 162    if (OwnerQ != 0)
 163       SendConfiguration();
 164
 165    return true;
 166 }
 167                                                                         /*}}}*/
 168 // Worker::ReadMessages - Read all pending messages into the list       /*{{{*/
 169 // ---------------------------------------------------------------------
 170 /* */
 171 bool pkgAcquire::Worker::ReadMessages()
 172 {
 173    if (::ReadMessages(InFd,MessageQueue) == false)
 174       return MethodFailure();
 175    return true;
 176 }
 177                                                                         /*}}}*/
 178 // Worker::RunMessage - Empty the message queue                         /*{{{*/
 179 // ---------------------------------------------------------------------
 180 /* This takes the messages from the message queue and runs them through
 181    the parsers in order. */
 182 bool pkgAcquire::Worker::RunMessages()
 183 {
 184    while (MessageQueue.empty() == false)
 185    {
 186       string Message = MessageQueue.front();
 187       MessageQueue.erase(MessageQueue.begin());
 188
 189       if (Debug == true)
 190          clog << " <- " << Access << ':' << QuoteString(Message,"\n") << endl;
 191
 192       // Fetch the message number
 193       char *End;
 194       int Number = strtol(Message.c_str(),&End,10);
 195       if (End == Message.c_str())
 196          return _error->Error("Invalid message from method %s: %s",Access.c_str(),Message.c_str());
 197
 198       string URI = LookupTag(Message,"URI");
 199       pkgAcquire::Queue::QItem *Itm = 0;
 200       if (URI.empty() == false)
 201          Itm = OwnerQ->FindItem(URI,this);
 202
 203       // Determine the message number and dispatch
 204       switch (Number)
 205       {
 206          // 100 Capabilities
 207          case 100:
 208          if (Capabilities(Message) == false)
 209             return _error->Error("Unable to process Capabilities message from %s",Access.c_str());
 210          break;
 211
 212          // 101 Log
 213          case 101:
 214          if (Debug == true)
 215             clog << " <- (log) " << LookupTag(Message,"Message") << endl;
 216          break;
 217
 218          // 102 Status
 219          case 102:
 220          Status = LookupTag(Message,"Message");
 221          break;
 222
 223          // 200 URI Start
 224          case 200:
 225          {
 226             if (Itm == 0)
 227             {
 228                _error->Error("Method gave invalid 200 URI Start message");
 229                break;
 230             }
 231
 232             CurrentItem = Itm;
 233             CurrentSize = 0;
 234             TotalSize = atoi(LookupTag(Message,"Size","0").c_str());
 235             ResumePoint = atoi(LookupTag(Message,"Resume-Point","0").c_str());
 236             Itm->Owner->Start(Message,atoi(LookupTag(Message,"Size","0").c_str()));
 237
 238             // Display update before completion
 239             if (Log != 0 && Log->MorePulses == true)
 240                Log->Pulse(Itm->Owner->GetOwner());
 241
 242             if (Log != 0)
 243                Log->Fetch(*Itm);
 244
 245             break;
 246          }
 247
 248          // 201 URI Done
 249          case 201:
 250          {
 251             if (Itm == 0)
 252             {
 253                _error->Error("Method gave invalid 201 URI Done message");
 254                break;
 255             }
 256
 257             pkgAcquire::Item *Owner = Itm->Owner;
 258             pkgAcquire::ItemDesc Desc = *Itm;
 259
 260             // Display update before completion
 261             if (Log != 0 && Log->MorePulses == true)
 262                Log->Pulse(Owner->GetOwner());
 263
 264             OwnerQ->ItemDone(Itm);
 265             if (TotalSize != 0 &&
 266                 (unsigned)atoi(LookupTag(Message,"Size","0").c_str()) != TotalSize)
 267                _error->Warning("Bizarre Error - File size is not what the server reported %s %lu",
 268                                LookupTag(Message,"Size","0").c_str(),TotalSize);
 269
 270             Owner->Done(Message,atoi(LookupTag(Message,"Size","0").c_str()),
 271                         LookupTag(Message,"MD5-Hash"),Config);
 272             ItemDone();
 273
 274             // Log that we are done
 275             if (Log != 0)
 276             {
 277                if (StringToBool(LookupTag(Message,"IMS-Hit"),false) == true ||
 278                    StringToBool(LookupTag(Message,"Alt-IMS-Hit"),false) == true)
 279                {
 280                   /* Hide 'hits' for local only sources - we also manage to
 281                      hide gets */
 282                   if (Config->LocalOnly == false)
 283                      Log->IMSHit(Desc);
 284                }
 285                else
 286                   Log->Done(Desc);
 287             }
 288             break;
 289          }
 290
 291          // 400 URI Failure
 292          case 400:
 293          {
 294             if (Itm == 0)
 295             {
 296                _error->Error("Method gave invalid 400 URI Failure message");
 297                break;
 298             }
 299
 300             // Display update before completion
 301             if (Log != 0 && Log->MorePulses == true)
 302                Log->Pulse(Itm->Owner->GetOwner());
 303
 304             pkgAcquire::Item *Owner = Itm->Owner;
 305             pkgAcquire::ItemDesc Desc = *Itm;
 306             OwnerQ->ItemDone(Itm);
 307
 308             // set some status
 309             if(LookupTag(Message,"FailReason") == "Timeout" ||
 310                LookupTag(Message,"FailReason") == "TmpResolveFailure" ||
 311                LookupTag(Message,"FailReason") == "ConnectionRefused")
 312                Owner->Status = pkgAcquire::Item::StatTransientNetworkError;
 313
 314             Owner->Failed(Message,Config);
 315             ItemDone();
 316
 317             if (Log != 0)
 318                Log->Fail(Desc);
 319
 320             break;
 321          }
 322
 323          // 401 General Failure
 324          case 401:
 325          _error->Error("Method %s General failure: %s",Access.c_str(),LookupTag(Message,"Message").c_str());
 326          break;
 327
 328          // 403 Media Change
 329          case 403:
 330          MediaChange(Message);
 331          break;
 332       }
 333    }
 334    return true;
 335 }
 336                                                                         /*}}}*/
 337 // Worker::Capabilities - 100 Capabilities handler                      /*{{{*/
 338 // ---------------------------------------------------------------------
 339 /* This parses the capabilities message and dumps it into the configuration
 340    structure. */
 341 bool pkgAcquire::Worker::Capabilities(string Message)
 342 {
 343    if (Config == 0)
 344       return true;
 345
 346    Config->Version = LookupTag(Message,"Version");
 347    Config->SingleInstance = StringToBool(LookupTag(Message,"Single-Instance"),false);
 348    Config->Pipeline = StringToBool(LookupTag(Message,"Pipeline"),false);
 349    Config->SendConfig = StringToBool(LookupTag(Message,"Send-Config"),false);
 350    Config->LocalOnly = StringToBool(LookupTag(Message,"Local-Only"),false);
 351    Config->NeedsCleanup = StringToBool(LookupTag(Message,"Needs-Cleanup"),false);
 352    Config->Removable = StringToBool(LookupTag(Message,"Removable"),false);
 353
 354    // Some debug text
 355    if (Debug == true)
 356    {
 357       clog << "Configured access method " << Config->Access << endl;
 358       clog << "Version:" << Config->Version <<
 359               " SingleInstance:" << Config->SingleInstance <<
 360               " Pipeline:" << Config->Pipeline <<
 361               " SendConfig:" << Config->SendConfig <<
 362               " LocalOnly: " << Config->LocalOnly <<
 363               " NeedsCleanup: " << Config->NeedsCleanup <<
 364               " Removable: " << Config->Removable << endl;
 365    }
 366
 367    return true;
 368 }
 369                                                                         /*}}}*/
 370 // Worker::MediaChange - Request a media change                         /*{{{*/
 371 // ---------------------------------------------------------------------
 372 /* */
 373 bool pkgAcquire::Worker::MediaChange(string Message)
 374 {
 375    int status_fd = _config->FindI("APT::Status-Fd",-1);
 376    if(status_fd > 0)
 377    {
 378       string Media = LookupTag(Message,"Media");
 379       string Drive = LookupTag(Message,"Drive");
 380       ostringstream msg,status;
 381       ioprintf(msg,_("Please insert the disc labeled: "
 382                      "'%s' "
 383                      "in the drive '%s' and press enter."),
 384                Media.c_str(),Drive.c_str());
 385       status << "media-change: "  // message
 386              << Media  << ":"     // media
 387              << Drive  << ":"     // drive
 388              << msg.str()         // l10n message
 389              << endl;
 390       write(status_fd, status.str().c_str(), status.str().size());
 391    }
 392
 393    if (Log == 0 || Log->MediaChange(LookupTag(Message,"Media"),
 394                                     LookupTag(Message,"Drive")) == false)
 395    {
 396       char S[300];
 397       snprintf(S,sizeof(S),"603 Media Changed\nFailed: true\n\n");
 398       if (Debug == true)
 399          clog << " -> " << Access << ':' << QuoteString(S,"\n") << endl;
 400       OutQueue += S;
 401       OutReady = true;
 402       return true;
 403    }
 404
 405    char S[300];
 406    snprintf(S,sizeof(S),"603 Media Changed\n\n");
 407    if (Debug == true)
 408       clog << " -> " << Access << ':' << QuoteString(S,"\n") << endl;
 409    OutQueue += S;
 410    OutReady = true;
 411    return true;
 412 }
 413                                                                         /*}}}*/
 414 // Worker::SendConfiguration - Send the config to the method            /*{{{*/
 415 // ---------------------------------------------------------------------
 416 /* */
 417 bool pkgAcquire::Worker::SendConfiguration()
 418 {
 419    if (Config->SendConfig == false)
 420       return true;
 421
 422    if (OutFd == -1)
 423       return false;
 424
 425    string Message = "601 Configuration\n";
 426    Message.reserve(2000);
 427
 428    /* Write out all of the configuration directives by walking the
 429       configuration tree */
 430    const Configuration::Item *Top = _config->Tree(0);
 431    for (; Top != 0;)
 432    {
 433       if (Top->Value.empty() == false)
 434       {
 435          string Line = "Config-Item: " + QuoteString(Top->FullTag(),"=\"\n") + "=";
 436          Line += QuoteString(Top->Value,"\n") + '\n';
 437          Message += Line;
 438       }
 439
 440       if (Top->Child != 0)
 441       {
 442          Top = Top->Child;
 443          continue;
 444       }
 445
 446       while (Top != 0 && Top->Next == 0)
 447          Top = Top->Parent;
 448       if (Top != 0)
 449          Top = Top->Next;
 450    }
 451    Message += '\n';
 452
 453    if (Debug == true)
 454       clog << " -> " << Access << ':' << QuoteString(Message,"\n") << endl;
 455    OutQueue += Message;
 456    OutReady = true;
 457
 458    return true;
 459 }
 460                                                                         /*}}}*/
 461 // Worker::QueueItem - Add an item to the outbound queue                /*{{{*/
 462 // ---------------------------------------------------------------------
 463 /* Send a URI Acquire message to the method */
 464 bool pkgAcquire::Worker::QueueItem(pkgAcquire::Queue::QItem *Item)
 465 {
 466    if (OutFd == -1)
 467       return false;
 468
 469    string Message = "600 URI Acquire\n";
 470    Message.reserve(300);
 471    Message += "URI: " + Item->URI;
 472    Message += "\nFilename: " + Item->Owner->DestFile;
 473    Message += Item->Owner->Custom600Headers();
 474    Message += "\n\n";
 475
 476    if (Debug == true)
 477       clog << " -> " << Access << ':' << QuoteString(Message,"\n") << endl;
 478    OutQueue += Message;
 479    OutReady = true;
 480
 481    return true;
 482 }
 483                                                                         /*}}}*/
 484 // Worker::OutFdRead - Out bound FD is ready                            /*{{{*/
 485 // ---------------------------------------------------------------------
 486 /* */
 487 bool pkgAcquire::Worker::OutFdReady()
 488 {
 489    int Res;
 490    do
 491    {
 492       Res = write(OutFd,OutQueue.c_str(),OutQueue.length());
 493    }
 494    while (Res < 0 && errno == EINTR);
 495
 496    if (Res <= 0)
 497       return MethodFailure();
 498
 499    // Hmm.. this should never happen.
 500    if (Res < 0)
 501       return true;
 502
 503    OutQueue.erase(0,Res);
 504    if (OutQueue.empty() == true)
 505       OutReady = false;
 506
 507    return true;
 508 }
 509                                                                         /*}}}*/
 510 // Worker::InFdRead - In bound FD is ready                              /*{{{*/
 511 // ---------------------------------------------------------------------
 512 /* */
 513 bool pkgAcquire::Worker::InFdReady()
 514 {
 515    if (ReadMessages() == false)
 516       return false;
 517    RunMessages();
 518    return true;
 519 }
 520                                                                         /*}}}*/
 521 // Worker::MethodFailure - Called when the method fails                 /*{{{*/
 522 // ---------------------------------------------------------------------
 523 /* This is called when the method is belived to have failed, probably because
 524    read returned -1. */
 525 bool pkgAcquire::Worker::MethodFailure()
 526 {
 527    _error->Error("Method %s has died unexpectedly!",Access.c_str());
 528
 529    ExecWait(Process,Access.c_str(),true);
 530    Process = -1;
 531    close(InFd);
 532    close(OutFd);
 533    InFd = -1;
 534    OutFd = -1;
 535    OutReady = false;
 536    InReady = false;
 537    OutQueue = string();
 538    MessageQueue.erase(MessageQueue.begin(),MessageQueue.end());
 539
 540    return false;
 541 }
 542                                                                         /*}}}*/
 543 // Worker::Pulse - Called periodically                                  /*{{{*/
 544 // ---------------------------------------------------------------------
 545 /* */
 546 void pkgAcquire::Worker::Pulse()
 547 {
 548    if (CurrentItem == 0)
 549       return;
 550
 551    struct stat Buf;
 552    if (stat(CurrentItem->Owner->DestFile.c_str(),&Buf) != 0)
 553       return;
 554    CurrentSize = Buf.st_size;
 555
 556    // Hmm? Should not happen...
 557    if (CurrentSize > TotalSize && TotalSize != 0)
 558       TotalSize = CurrentSize;
 559 }
 560                                                                         /*}}}*/
 561 // Worker::ItemDone - Called when the current item is finished          /*{{{*/
 562 // ---------------------------------------------------------------------
 563 /* */
 564 void pkgAcquire::Worker::ItemDone()
 565 {
 566    CurrentItem = 0;
 567    CurrentSize = 0;
 568    TotalSize = 0;
 569    Status = string();
 570 }
 571                                                                         /*}}}*/