apt-pkg/acquire-worker.cc

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