[apt.git] / apt-pkg / acquire-worker.cc

// -*- mode: cpp; mode: fold -*-
// Description								/*{{{*/
// $Id: acquire-worker.cc,v 1.34 2001/05/22 04:42:54 jgg Exp $
/* ######################################################################

   Acquire Worker 

   The worker process can startup either as a Configuration prober
   or as a queue runner. As a configuration prober it only reads the
   configuration message and 
   
   ##################################################################### */
									/*}}}*/
// Include Files							/*{{{*/
#include <config.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 <apt-pkg/strutl.h>

#include <iostream>
#include <sstream>
#include <fstream>

#include <sys/stat.h>
#include <unistd.h>
#include <fcntl.h>
#include <signal.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,
			   pkgAcquireStatus *Log) : Log(Log)
{
   OwnerQ = Q;
   Config = Cnf;
   Access = Cnf->Access;
   CurrentItem = 0;
   TotalSize = 0;
   CurrentSize = 0;
   
   Construct();   
}
									/*}}}*/
// Worker::Worker - Constructor for method config startup		/*{{{*/
// ---------------------------------------------------------------------
/* */
pkgAcquire::Worker::Worker(MethodConfig *Cnf)
{
   OwnerQ = 0;
   Config = Cnf;
   Access = Cnf->Access;
   CurrentItem = 0;
   TotalSize = 0;
   CurrentSize = 0;
   
   Construct();   
}
									/*}}}*/
// Worker::Construct - Constructor helper				/*{{{*/
// ---------------------------------------------------------------------
/* */
void pkgAcquire::Worker::Construct()
{
   NextQueue = 0;
   NextAcquire = 0;
   Process = -1;
   InFd = -1;
   OutFd = -1;
   OutReady = false;
   InReady = false;
   Debug = _config->FindB("Debug::pkgAcquire::Worker",false);
}
									/*}}}*/
// Worker::~Worker - Destructor						/*{{{*/
// ---------------------------------------------------------------------
/* */
pkgAcquire::Worker::~Worker()
{
   close(InFd);
   close(OutFd);
   
   if (Process > 0)
   {
      /* 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);
   }   
}
									/*}}}*/
// Worker::Start - Start the worker process				/*{{{*/
// ---------------------------------------------------------------------
/* This forks the method and inits the communication channel */
bool pkgAcquire::Worker::Start()
{
   // Get the method path
   string Method = _config->FindDir("Dir::Bin::Methods") + Access;
   if (FileExists(Method) == false)
   {
      _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;

   // Create the pipes
   int Pipes[4] = {-1,-1,-1,-1};
   if (pipe(Pipes) != 0 || pipe(Pipes+2) != 0)
   {
      _error->Errno("pipe","Failed to create IPC pipe to subprocess");
      for (int I = 0; I != 4; I++)
	 close(Pipes[I]);
      return false;
   }
   for (int I = 0; I != 4; I++)
      SetCloseExec(Pipes[I],true);
   
   // Fork off the process
   Process = ExecFork();
   if (Process == 0)
   {
      // Setup the FDs
      dup2(Pipes[1],STDOUT_FILENO);
      dup2(Pipes[2],STDIN_FILENO);
      SetCloseExec(STDOUT_FILENO,false);
      SetCloseExec(STDIN_FILENO,false);      
      SetCloseExec(STDERR_FILENO,false);
      
      const char *Args[2];
      Args[0] = Method.c_str();
      Args[1] = 0;
      execv(Args[0],(char **)Args);
      cerr << "Failed to exec method " << Args[0] << endl;
      _exit(100);
   }

   // Fix up our FDs
   InFd = Pipes[0];
   OutFd = Pipes[3];
   SetNonBlock(Pipes[0],true);
   SetNonBlock(Pipes[3],true);
   close(Pipes[1]);
   close(Pipes[2]);
   OutReady = false;
   InReady = true;
   
   // Read the configuration data
   if (WaitFd(InFd) == false ||
       ReadMessages() == false)
      return _error->Error(_("Method %s did not start correctly"),Method.c_str());

   RunMessages();
   if (OwnerQ != 0)
      SendConfiguration();
   
   return true;
}
									/*}}}*/
// Worker::ReadMessages - Read all pending messages into the list	/*{{{*/
// ---------------------------------------------------------------------
/* */
bool pkgAcquire::Worker::ReadMessages()
{
   if (::ReadMessages(InFd,MessageQueue) == false)
      return MethodFailure();
   return true;
}
									/*}}}*/
// Worker::RunMessage - Empty the message queue				/*{{{*/
// ---------------------------------------------------------------------
/* This takes the messages from the message queue and runs them through
   the parsers in order. */
bool pkgAcquire::Worker::RunMessages()
{
   while (MessageQueue.empty() == false)
   {
      string Message = MessageQueue.front();
      MessageQueue.erase(MessageQueue.begin());

      if (Debug == true)
	 clog << " <- " << Access << ':' << QuoteString(Message,"\n") << endl;
      
      // Fetch the message number
      char *End;
      int Number = strtol(Message.c_str(),&End,10);
      if (End == Message.c_str())
	 return _error->Error("Invalid message from method %s: %s",Access.c_str(),Message.c_str());

      string URI = LookupTag(Message,"URI");
      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)
      {
	 // 100 Capabilities
	 case 100:
	 if (Capabilities(Message) == false)
	    return _error->Error("Unable to process Capabilities message from %s",Access.c_str());
	 break;
	 
	 // 101 Log
	 case 101:
	 if (Debug == true)
	    clog << " <- (log) " << LookupTag(Message,"Message") << endl;
	 break;
	 
	 // 102 Status
	 case 102:
	 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:
	 {
	    if (Itm == 0)
	    {
	       _error->Error("Method gave invalid 200 URI Start message");
	       break;
	    }
	    
	    CurrentItem = Itm;
	    CurrentSize = 0;
	    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;
	 }
	 
	 // 201 URI Done
	 case 201:
	 {
	    if (Itm == 0)
	    {
	       _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);
	    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;
	 }	 
	 
	 // 400 URI Failure
	 case 400:
	 {
	    if (Itm == 0)
	    {
	       _error->Error("Method gave invalid 400 URI Failure message");
	       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);

	    // 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",Access.c_str(),LookupTag(Message,"Message").c_str());
	 break;
	 
	 // 403 Media Change
	 case 403:
	 MediaChange(Message); 
	 break;
      }      
   }
   return true;
}
									/*}}}*/
// Worker::Capabilities - 100 Capabilities handler			/*{{{*/
// ---------------------------------------------------------------------
/* This parses the capabilities message and dumps it into the configuration
   structure. */
bool pkgAcquire::Worker::Capabilities(string Message)
{
   if (Config == 0)
      return true;
   
   Config->Version = LookupTag(Message,"Version");
   Config->SingleInstance = StringToBool(LookupTag(Message,"Single-Instance"),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 <<
	      " 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;
}
									/*}}}*/
// Worker::SendConfiguration - Send the config to the method		/*{{{*/
// ---------------------------------------------------------------------
/* */
bool pkgAcquire::Worker::SendConfiguration()
{
   if (Config->SendConfig == false)
      return true;

   if (OutFd == -1)
      return false;

   /* Write out all of the configuration directives by walking the
      configuration tree */
   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.str(),"\n") << endl;
   OutQueue += Message.str();
   OutReady = true;

   return true;
}
									/*}}}*/
// Worker::QueueItem - Add an item to the outbound queue		/*{{{*/
// ---------------------------------------------------------------------
/* Send a URI Acquire message to the method */
bool pkgAcquire::Worker::QueueItem(pkgAcquire::Queue::QItem *Item)
{
   if (OutFd == -1)
      return false;
   
   string Message = "600 URI Acquire\n";
   Message.reserve(300);
   Message += "URI: " + Item->URI;
   Message += "\nFilename: " + Item->Owner->DestFile;
   Message += Item->Owner->Custom600Headers();
   Message += "\n\n";
   
   if (Debug == true)
      clog << " -> " << Access << ':' << QuoteString(Message,"\n") << endl;
   OutQueue += Message;
   OutReady = true;
   
   return true;
}
									/*}}}*/
// Worker::OutFdRead - Out bound FD is ready				/*{{{*/
// ---------------------------------------------------------------------
/* */
bool pkgAcquire::Worker::OutFdReady()
{
   int Res;
   do
   {
      Res = write(OutFd,OutQueue.c_str(),OutQueue.length());
   }
   while (Res < 0 && errno == EINTR);

   if (Res <= 0)
      return MethodFailure();

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