mark as Automatic/Downloadable pure as gcc suggests
[ntk/apt.git] / apt-pkg / acquire-worker.cc
index a02c6bc..047a655 100644 (file)
@@ -1,6 +1,6 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
-// $Id: acquire-worker.cc,v 1.9 1998/11/01 05:27:33 jgg Exp $
+// $Id: acquire-worker.cc,v 1.34 2001/05/22 04:42:54 jgg Exp $
 /* ######################################################################
 
    Acquire Worker 
    ##################################################################### */
                                                                        /*}}}*/
 // Include Files                                                       /*{{{*/
-#ifdef __GNUG__
-#pragma implementation "apt-pkg/acquire-worker.h"
-#endif
+#include <config.h>
+
+#include <apt-pkg/acquire.h>
 #include <apt-pkg/acquire-worker.h>
 #include <apt-pkg/acquire-item.h>
 #include <apt-pkg/configuration.h>
 #include <apt-pkg/error.h>
 #include <apt-pkg/fileutl.h>
-#include <strutl.h>
+#include <apt-pkg/strutl.h>
+#include <apt-pkg/hashes.h>
+
+#include <string>
+#include <vector>
+#include <iostream>
+#include <sstream>
 
+#include <sys/stat.h>
+#include <stdlib.h>
 #include <unistd.h>
 #include <signal.h>
-#include <wait.h>
+#include <stdio.h>
+#include <errno.h>
+
+#include <apti18n.h>
                                                                        /*}}}*/
 
+using namespace std;
+
 // Worker::Worker - Constructor for Queue startup                      /*{{{*/
 // ---------------------------------------------------------------------
 /* */
-pkgAcquire::Worker::Worker(Queue *Q,MethodConfig *Cnf)
+pkgAcquire::Worker::Worker(Queue *Q,MethodConfig *Cnf,
+                          pkgAcquireStatus *Log) : Log(Log)
 {
    OwnerQ = Q;
    Config = Cnf;
    Access = Cnf->Access;
    CurrentItem = 0;
-
+   TotalSize = 0;
+   CurrentSize = 0;
+   
    Construct();   
 }
                                                                        /*}}}*/
@@ -49,6 +65,8 @@ pkgAcquire::Worker::Worker(MethodConfig *Cnf)
    Config = Cnf;
    Access = Cnf->Access;
    CurrentItem = 0;
+   TotalSize = 0;
+   CurrentSize = 0;
    
    Construct();   
 }
@@ -78,9 +96,11 @@ pkgAcquire::Worker::~Worker()
    
    if (Process > 0)
    {
-      kill(Process,SIGINT);
-      if (waitpid(Process,0,0) != Process)
-        _error->Warning("I waited but nothing was there!");
+      /* Closing of stdin is the signal to exit and die when the process
+         indicates it needs cleanup */
+      if (Config->NeedsCleanup == false)
+        kill(Process,SIGINT);
+      ExecWait(Process,Access.c_str(),true);
    }   
 }
                                                                        /*}}}*/
@@ -92,7 +112,12 @@ bool pkgAcquire::Worker::Start()
    // Get the method path
    string Method = _config->FindDir("Dir::Bin::Methods") + Access;
    if (FileExists(Method) == false)
-      return _error->Error("The method driver %s could not be found.",Method.c_str());
+   {
+      _error->Error(_("The method driver %s could not be found."),Method.c_str());
+      if (Access == "https")
+        _error->Notice(_("Is the package %s installed?"), "apt-transport-https");
+      return false;
+   }
 
    if (Debug == true)
       clog << "Starting method '" << Method << '\'' << endl;
@@ -107,23 +132,15 @@ bool pkgAcquire::Worker::Start()
       return false;
    }
    for (int I = 0; I != 4; I++)
-      SetCloseExec(Pipes[0],true);
+      SetCloseExec(Pipes[I],true);
    
    // Fork off the process
-   Process = fork();
-   if (Process < 0)
-   {
-      cerr << "FATAL -> Failed to fork." << endl;
-      exit(100);
-   }
-
-   // Spawn the subprocess
+   Process = ExecFork();
    if (Process == 0)
    {
       // Setup the FDs
       dup2(Pipes[1],STDOUT_FILENO);
       dup2(Pipes[2],STDIN_FILENO);
-      dup2(((filebuf *)clog.rdbuf())->fd(),STDERR_FILENO);
       SetCloseExec(STDOUT_FILENO,false);
       SetCloseExec(STDIN_FILENO,false);      
       SetCloseExec(STDERR_FILENO,false);
@@ -133,7 +150,7 @@ bool pkgAcquire::Worker::Start()
       Args[1] = 0;
       execv(Args[0],(char **)Args);
       cerr << "Failed to exec method " << Args[0] << endl;
-      exit(100);
+      _exit(100);
    }
 
    // Fix up our FDs
@@ -149,7 +166,7 @@ bool pkgAcquire::Worker::Start()
    // Read the configuration data
    if (WaitFd(InFd) == false ||
        ReadMessages() == false)
-      return _error->Error("Method %s did not start correctly",Method.c_str());
+      return _error->Error(_("Method %s did not start correctly"),Method.c_str());
 
    RunMessages();
    if (OwnerQ != 0)
@@ -192,7 +209,18 @@ bool pkgAcquire::Worker::RunMessages()
       pkgAcquire::Queue::QItem *Itm = 0;
       if (URI.empty() == false)
         Itm = OwnerQ->FindItem(URI,this);
-        
+
+      // update used mirror
+      string UsedMirror = LookupTag(Message,"UsedMirror", "");
+      if (!UsedMirror.empty() && 
+          Itm && 
+          Itm->Description.find(" ") != string::npos) 
+      {
+         Itm->Description.replace(0, Itm->Description.find(" "), UsedMirror);
+         // FIXME: will we need this as well?
+         //Itm->ShortDesc = UsedMirror;
+      }
+      
       // Determine the message number and dispatch
       switch (Number)
       {
@@ -213,6 +241,35 @@ bool pkgAcquire::Worker::RunMessages()
         Status = LookupTag(Message,"Message");
         break;
            
+         // 103 Redirect
+         case 103:
+         {
+            if (Itm == 0)
+            {
+               _error->Error("Method gave invalid 103 Redirect message");
+               break;
+            }
+            string NewURI = LookupTag(Message,"New-URI",URI.c_str());
+            Itm->URI = NewURI;
+
+           ItemDone();
+
+           pkgAcquire::Item *Owner = Itm->Owner;
+           pkgAcquire::ItemDesc Desc = *Itm;
+
+           // Change the status so that it can be dequeued
+           Owner->Status = pkgAcquire::Item::StatIdle;
+           // Mark the item as done (taking care of all queues)
+           // and then put it in the main queue again
+           OwnerQ->ItemDone(Itm);
+           OwnerQ->Owner->Enqueue(Desc);
+
+           if (Log != 0)
+              Log->Done(Desc);
+            break;
+         }
+   
         // 200 URI Start
         case 200:
         {
@@ -221,10 +278,20 @@ bool pkgAcquire::Worker::RunMessages()
               _error->Error("Method gave invalid 200 URI Start message");
               break;
            }
+           
            CurrentItem = Itm;
            CurrentSize = 0;
-           TotalSize = atoi(LookupTag(Message,"Size","0").c_str());
+           TotalSize = strtoull(LookupTag(Message,"Size","0").c_str(), NULL, 10);
+           ResumePoint = strtoull(LookupTag(Message,"Resume-Point","0").c_str(), NULL, 10);
+           Itm->Owner->Start(Message,strtoull(LookupTag(Message,"Size","0").c_str(), NULL, 10));
+
+           // Display update before completion
+           if (Log != 0 && Log->MorePulses == true)
+              Log->Pulse(Itm->Owner->GetOwner());
            
+           if (Log != 0)
+              Log->Fetch(*Itm);
+
            break;
         }
         
@@ -236,10 +303,61 @@ bool pkgAcquire::Worker::RunMessages()
               _error->Error("Method gave invalid 201 URI Done message");
               break;
            }
-
+           
+           pkgAcquire::Item *Owner = Itm->Owner;
+           pkgAcquire::ItemDesc Desc = *Itm;
+           
+           // Display update before completion
+           if (Log != 0 && Log->MorePulses == true)
+              Log->Pulse(Owner->GetOwner());
+           
            OwnerQ->ItemDone(Itm);
-           Itm->Owner->Done(Message,atoi(LookupTag(Message,"Size","0").c_str()),
-                                         LookupTag(Message,"MD5-Hash"));
+           unsigned long long const ServerSize = strtoull(LookupTag(Message,"Size","0").c_str(), NULL, 10);
+            bool isHit = StringToBool(LookupTag(Message,"IMS-Hit"),false) ||
+                         StringToBool(LookupTag(Message,"Alt-IMS-Hit"),false);
+            // Using the https method the server might return 200, but the
+            // If-Modified-Since condition is not satsified, libcurl will
+            // discard the download. In this case, however, TotalSize will be
+            // set to the actual size of the file, while ServerSize will be set
+            // to 0. Therefore, if the item is marked as a hit and the
+            // downloaded size (ServerSize) is 0, we ignore TotalSize.
+           if (TotalSize != 0 && (!isHit || ServerSize != 0) && ServerSize != TotalSize)
+              _error->Warning("Size of file %s is not what the server reported %s %llu",
+                              Owner->DestFile.c_str(), LookupTag(Message,"Size","0").c_str(),TotalSize);
+
+           // see if there is a hash to verify
+           string RecivedHash;
+           HashString expectedHash(Owner->HashSum());
+           if(!expectedHash.empty()) 
+           {
+              string hashTag = expectedHash.HashType()+"-Hash";
+              string hashSum = LookupTag(Message, hashTag.c_str());
+              if(!hashSum.empty())
+                 RecivedHash = expectedHash.HashType() + ":" + hashSum;
+              if(_config->FindB("Debug::pkgAcquire::Auth", false) == true)
+              {
+                 clog << "201 URI Done: " << Owner->DescURI() << endl
+                      << "RecivedHash: " << RecivedHash << endl
+                      << "ExpectedHash: " << expectedHash.toStr() 
+                      << endl << endl;
+              }
+           }
+           Owner->Done(Message, ServerSize, RecivedHash.c_str(), Config);
+           ItemDone();
+           
+           // Log that we are done
+           if (Log != 0)
+           {
+              if (isHit)
+              {
+                 /* Hide 'hits' for local only sources - we also manage to
+                    hide gets */
+                 if (Config->LocalOnly == false)
+                    Log->IMSHit(Desc);
+              }               
+              else
+                 Log->Done(Desc);
+           }
            break;
         }       
         
@@ -252,14 +370,38 @@ bool pkgAcquire::Worker::RunMessages()
               break;
            }
 
+           // Display update before completion
+           if (Log != 0 && Log->MorePulses == true)
+              Log->Pulse(Itm->Owner->GetOwner());
+           
+           pkgAcquire::Item *Owner = Itm->Owner;
+           pkgAcquire::ItemDesc Desc = *Itm;
            OwnerQ->ItemDone(Itm);
-           Itm->Owner->Failed(Message);
+
+           // set some status
+           if(LookupTag(Message,"FailReason") == "Timeout" || 
+              LookupTag(Message,"FailReason") == "TmpResolveFailure" ||
+              LookupTag(Message,"FailReason") == "ResolveFailure" ||
+              LookupTag(Message,"FailReason") == "ConnectionRefused") 
+              Owner->Status = pkgAcquire::Item::StatTransientNetworkError;
+
+           Owner->Failed(Message,Config);
+           ItemDone();
+
+           if (Log != 0)
+              Log->Fail(Desc);
+
            break;
         }       
         
         // 401 General Failure
         case 401:
-        _error->Error("Method %s General failure: %s",LookupTag(Message,"Message").c_str());
+        _error->Error("Method %s General failure: %s",Access.c_str(),LookupTag(Message,"Message").c_str());
+        break;
+        
+        // 403 Media Change
+        case 403:
+        MediaChange(Message); 
         break;
       }      
    }
@@ -277,20 +419,71 @@ bool pkgAcquire::Worker::Capabilities(string Message)
    
    Config->Version = LookupTag(Message,"Version");
    Config->SingleInstance = StringToBool(LookupTag(Message,"Single-Instance"),false);
-   Config->PreScan = StringToBool(LookupTag(Message,"Pre-Scan"),false);
    Config->Pipeline = StringToBool(LookupTag(Message,"Pipeline"),false);
    Config->SendConfig = StringToBool(LookupTag(Message,"Send-Config"),false);
+   Config->LocalOnly = StringToBool(LookupTag(Message,"Local-Only"),false);
+   Config->NeedsCleanup = StringToBool(LookupTag(Message,"Needs-Cleanup"),false);
+   Config->Removable = StringToBool(LookupTag(Message,"Removable"),false);
 
    // Some debug text
    if (Debug == true)
    {
       clog << "Configured access method " << Config->Access << endl;
-      clog << "Version:" << Config->Version << " SingleInstance:" <<
-        Config->SingleInstance << " PreScan: " << Config->PreScan <<
-        " Pipeline:" << Config->Pipeline << " SendConfig:" << 
-        Config->SendConfig << endl;
+      clog << "Version:" << Config->Version <<
+             " SingleInstance:" << Config->SingleInstance <<
+             " Pipeline:" << Config->Pipeline << 
+             " SendConfig:" << Config->SendConfig << 
+             " LocalOnly: " << Config->LocalOnly << 
+             " NeedsCleanup: " << Config->NeedsCleanup << 
+             " Removable: " << Config->Removable << endl;
    }
    
+   return true;
+}
+                                                                       /*}}}*/
+// Worker::MediaChange - Request a media change                                /*{{{*/
+// ---------------------------------------------------------------------
+/* */
+bool pkgAcquire::Worker::MediaChange(string Message)
+{
+   int status_fd = _config->FindI("APT::Status-Fd",-1);
+   if(status_fd > 0) 
+   {
+      string Media = LookupTag(Message,"Media");
+      string Drive = LookupTag(Message,"Drive"); 
+      ostringstream msg,status;
+      ioprintf(msg,_("Please insert the disc labeled: "
+                    "'%s' "
+                    "in the drive '%s' and press enter."),
+              Media.c_str(),Drive.c_str());
+      status << "media-change: "  // message
+            << Media  << ":"     // media
+            << Drive  << ":"     // drive
+            << msg.str()         // l10n message
+            << endl;
+
+      std::string const dlstatus = status.str();
+      FileFd::Write(status_fd, dlstatus.c_str(), dlstatus.size());
+   }
+
+   if (Log == 0 || Log->MediaChange(LookupTag(Message,"Media"),
+                                   LookupTag(Message,"Drive")) == false)
+   {
+      char S[300];
+      snprintf(S,sizeof(S),"603 Media Changed\nFailed: true\n\n");
+      if (Debug == true)
+        clog << " -> " << Access << ':' << QuoteString(S,"\n") << endl;
+      OutQueue += S;
+      OutReady = true;
+      return true;
+   }
+
+   char S[300];
+   snprintf(S,sizeof(S),"603 Media Changed\n\n");
+   if (Debug == true)
+      clog << " -> " << Access << ':' << QuoteString(S,"\n") << endl;
+   OutQueue += S;
+   OutReady = true;
    return true;
 }
                                                                        /*}}}*/
@@ -304,40 +497,19 @@ bool pkgAcquire::Worker::SendConfiguration()
 
    if (OutFd == -1)
       return false;
-   
-   string Message = "601 Configuration\n";
-   Message.reserve(2000);
 
-   /* Write out all of the configuration directives by walking the 
+   /* Write out all of the configuration directives by walking the
       configuration tree */
-   const Configuration::Item *Top = _config->Tree(0);
-   for (; Top != 0;)
-   {
-      if (Top->Value.empty() == false)
-      {
-        string Line = "Config-Item: " + Top->FullTag() + "=";
-        Line += QuoteString(Top->Value,"\n") + '\n';
-        Message += Line;
-      }
-      
-      if (Top->Child != 0)
-      {
-        Top = Top->Child;
-        continue;
-      }
-      
-      while (Top != 0 && Top->Next == 0)
-        Top = Top->Parent;
-      if (Top != 0)
-        Top = Top->Next;
-   }   
-   Message += '\n';
+   std::ostringstream Message;
+   Message << "601 Configuration\n";
+   _config->Dump(Message, NULL, "Config-Item: %F=%V\n", false);
+   Message << '\n';
 
    if (Debug == true)
-      clog << " -> " << Access << ':' << QuoteString(Message,"\n") << endl;
-   OutQueue += Message;
-   OutReady = true; 
-   
+      clog << " -> " << Access << ':' << QuoteString(Message.str(),"\n") << endl;
+   OutQueue += Message.str();
+   OutReady = true;
+
    return true;
 }
                                                                        /*}}}*/
@@ -369,14 +541,16 @@ bool pkgAcquire::Worker::QueueItem(pkgAcquire::Queue::QItem *Item)
 /* */
 bool pkgAcquire::Worker::OutFdReady()
 {
-   int Res = write(OutFd,OutQueue.begin(),OutQueue.length());
+   int Res;
+   do
+   {
+      Res = write(OutFd,OutQueue.c_str(),OutQueue.length());
+   }
+   while (Res < 0 && errno == EINTR);
+
    if (Res <= 0)
       return MethodFailure();
 
-   // Hmm.. this should never happen.
-   if (Res < 0)
-      return true;
-   
    OutQueue.erase(0,Res);
    if (OutQueue.empty() == true)
       OutReady = false;
@@ -397,13 +571,14 @@ bool pkgAcquire::Worker::InFdReady()
                                                                        /*}}}*/
 // Worker::MethodFailure - Called when the method fails                        /*{{{*/
 // ---------------------------------------------------------------------
-/* This is called when the method is belived to have failed, probably because
+/* This is called when the method is believed to have failed, probably because
    read returned -1. */
 bool pkgAcquire::Worker::MethodFailure()
 {
-   cerr << "Method " << Access << " has died unexpectedly!" << endl;
-   if (waitpid(Process,0,0) != Process)
-      _error->Warning("I waited but nothing was there!");
+   _error->Error("Method %s has died unexpectedly!",Access.c_str());
+   
+   // do not reap the child here to show meaningfull error to the user
+   ExecWait(Process,Access.c_str(),false);
    Process = -1;
    close(InFd);
    close(OutFd);
@@ -417,3 +592,32 @@ bool pkgAcquire::Worker::MethodFailure()
    return false;
 }
                                                                        /*}}}*/
+// Worker::Pulse - Called periodically                                         /*{{{*/
+// ---------------------------------------------------------------------
+/* */
+void pkgAcquire::Worker::Pulse()
+{
+   if (CurrentItem == 0)
+      return;
+   struct stat Buf;
+   if (stat(CurrentItem->Owner->DestFile.c_str(),&Buf) != 0)
+      return;
+   CurrentSize = Buf.st_size;
+   
+   // Hmm? Should not happen...
+   if (CurrentSize > TotalSize && TotalSize != 0)
+      TotalSize = CurrentSize;
+}
+                                                                       /*}}}*/
+// Worker::ItemDone - Called when the current item is finished         /*{{{*/
+// ---------------------------------------------------------------------
+/* */
+void pkgAcquire::Worker::ItemDone()
+{
+   CurrentItem = 0;
+   CurrentSize = 0;
+   TotalSize = 0;
+   Status = string();
+}
+                                                                       /*}}}*/