[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 <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 <apti18n.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>
									/*}}}*/

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)
      return _error->Error(_("The method driver %s could not be found."),Method.c_str());

   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);
      
      // 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;
	    
	 // 200 URI Start
	 case 200:
	 {
	    if (Itm == 0)
	    {
	       _error->Error("Method gave invalid 200 URI Start message");
	       break;
	    }
	    
	    CurrentItem = Itm;
	    CurrentSize = 0;
	    TotalSize = atoi(LookupTag(Message,"Size","0").c_str());
	    ResumePoint = atoi(LookupTag(Message,"Resume-Point","0").c_str());
	    Itm->Owner->Start(Message,atoi(LookupTag(Message,"Size","0").c_str()));

	    // 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);
	    if (TotalSize != 0 &&
		(unsigned)atoi(LookupTag(Message,"Size","0").c_str()) != TotalSize)
	       _error->Warning("Bizarre Error - File size is not what the server reported %s %lu",
			       LookupTag(Message,"Size","0").c_str(),TotalSize);

	    Owner->Done(Message,atoi(LookupTag(Message,"Size","0").c_str()),
			LookupTag(Message,"MD5-Hash"),Config);
	    ItemDone();
	    
	    // Log that we are done
	    if (Log != 0)
	    {
	       if (StringToBool(LookupTag(Message,"IMS-Hit"),false) == true ||
		   StringToBool(LookupTag(Message,"Alt-IMS-Hit"),false) == true)
	       {
		  /* 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") == "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;
      write(status_fd, status.str().c_str(), status.str().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;
   
   string Message = "601 Configuration\n";
   Message.reserve(2000);

   /* 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: " + QuoteString(Top->FullTag(),"=\"\n") + "=";
	 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';

   if (Debug == true)
      clog << " -> " << Access << ':' << QuoteString(Message,"\n") << endl;
   OutQueue += Message;
   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();

   // Hmm.. this should never happen.
   if (Res < 0)
      return true;
   
   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());
   
   ExecWait(Process,Access.c_str(),true);
   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 /{{{/
0118833a	15	#include <apt-pkg/acquire-worker.h>
0a8a80e5	16	#include <apt-pkg/acquire-item.h>
3b5421b4 AL	17	#include <apt-pkg/configuration.h>
	18	#include <apt-pkg/error.h>
	19	#include <apt-pkg/fileutl.h>
cdcc6d34	20	#include <apt-pkg/strutl.h>
3b5421b4	21
b2e465d6	22	#include <apti18n.h>
24a0d63a AL	23
24a0d63a AL	24	#include <iostream>
80a26ed1	25	#include <sstream>
24a0d63a	26	#include <fstream>
b2e465d6	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>
3b5421b4 AL	34	/}}}/
3b5421b4 AL	35
24a0d63a AL	36	using namespace std;
24a0d63a AL	37
3b5421b4 AL	38	// Worker::Worker - Constructor for Queue startup /{{{/
	39	// ---------------------------------------------------------------------
	40	/* */
8267fe24 AL	41	pkgAcquire::Worker::Worker(Queue Q,MethodConfig Cnf,
8267fe24 AL	42	pkgAcquireStatus *Log) : Log(Log)
3b5421b4 AL	43	{
3b5421b4 AL	44	OwnerQ = Q;
0a8a80e5 AL	45	Config = Cnf;
	46	Access = Cnf->Access;
	47	CurrentItem = 0;
18ef0a78 AL	48	TotalSize = 0;
	49	CurrentSize = 0;
	50
3b5421b4 AL	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;
0a8a80e5	62	CurrentItem = 0;
18ef0a78 AL	63	TotalSize = 0;
18ef0a78 AL	64	CurrentSize = 0;
0a8a80e5	65
3b5421b4 AL	66	Construct();
	67	}
	68	/}}}/
	69	// Worker::Construct - Constructor helper /{{{/
	70	// ---------------------------------------------------------------------
	71	/* */
	72	void pkgAcquire::Worker::Construct()
	73	{
0a8a80e5 AL	74	NextQueue = 0;
0a8a80e5 AL	75	NextAcquire = 0;
3b5421b4 AL	76	Process = -1;
	77	InFd = -1;
	78	OutFd = -1;
0a8a80e5 AL	79	OutReady = false;
0a8a80e5 AL	80	InReady = false;
3b5421b4 AL	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)
0a8a80e5	93	{
8e5fc8f5 AL	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);
ddc1d8d0	98	ExecWait(Process,Access.c_str(),true);
0a8a80e5	99	}
3b5421b4 AL	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)
b2e465d6	110	return _error->Error(_("The method driver %s could not be found."),Method.c_str());
3b5421b4 AL	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	}
8b89e57f	124	for (int I = 0; I != 4; I++)
4490f2de	125	SetCloseExec(Pipes[I],true);
8b89e57f	126
3b5421b4	127	// Fork off the process
54676e1a	128	Process = ExecFork();
3b5421b4 AL	129	if (Process == 0)
	130	{
	131	// Setup the FDs
	132	dup2(Pipes[1],STDOUT_FILENO);
	133	dup2(Pipes[2],STDIN_FILENO);
3b5421b4 AL	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;
0dbb95d8	143	_exit(100);
3b5421b4 AL	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]);
0a8a80e5 AL	153	OutReady = false;
0a8a80e5 AL	154	InReady = true;
3b5421b4 AL	155
	156	// Read the configuration data
	157	if (WaitFd(InFd) == false \|\|
	158	ReadMessages() == false)
b2e465d6	159	return _error->Error(_("Method %s did not start correctly"),Method.c_str());
3b5421b4 AL	160
3b5421b4 AL	161	RunMessages();
8b89e57f AL	162	if (OwnerQ != 0)
8b89e57f AL	163	SendConfiguration();
3b5421b4 AL	164
	165	return true;
	166	}
	167	/}}}/
	168	// Worker::ReadMessages - Read all pending messages into the list /{{{/
	169	// ---------------------------------------------------------------------
0a8a80e5	170	/* */
3b5421b4 AL	171	bool pkgAcquire::Worker::ReadMessages()
3b5421b4 AL	172	{
0a8a80e5 AL	173	if (::ReadMessages(InFd,MessageQueue) == false)
0a8a80e5 AL	174	return MethodFailure();
3b5421b4 AL	175	return true;
	176	}
	177	/}}}/
3b5421b4 AL	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());
0a8a80e5 AL	188
	189	if (Debug == true)
	190	clog << " <- " << Access << ':' << QuoteString(Message,"\n") << endl;
3b5421b4 AL	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
c88edf1d AL	198	string URI = LookupTag(Message,"URI");
	199	pkgAcquire::Queue::QItem *Itm = 0;
	200	if (URI.empty() == false)
	201	Itm = OwnerQ->FindItem(URI,this);
bfd22fc0	202
3b5421b4 AL	203	// Determine the message number and dispatch
	204	switch (Number)
	205	{
0a8a80e5	206	// 100 Capabilities
3b5421b4 AL	207	case 100:
	208	if (Capabilities(Message) == false)
	209	return _error->Error("Unable to process Capabilities message from %s",Access.c_str());
	210	break;
0a8a80e5 AL	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:
c88edf1d AL	225	{
	226	if (Itm == 0)
	227	{
93bf083d	228	_error->Error("Method gave invalid 200 URI Start message");
c88edf1d AL	229	break;
c88edf1d AL	230	}
8267fe24	231
c88edf1d AL	232	CurrentItem = Itm;
	233	CurrentSize = 0;
	234	TotalSize = atoi(LookupTag(Message,"Size","0").c_str());
8b75eb1c	235	ResumePoint = atoi(LookupTag(Message,"Resume-Point","0").c_str());
8267fe24	236	Itm->Owner->Start(Message,atoi(LookupTag(Message,"Size","0").c_str()));
8b75eb1c	237
c5ccf175 AL	238	// Display update before completion
	239	if (Log != 0 && Log->MorePulses == true)
	240	Log->Pulse(Itm->Owner->GetOwner());
	241
8267fe24 AL	242	if (Log != 0)
	243	Log->Fetch(*Itm);
	244
c88edf1d AL	245	break;
c88edf1d AL	246	}
0a8a80e5 AL	247
	248	// 201 URI Done
	249	case 201:
c88edf1d AL	250	{
	251	if (Itm == 0)
	252	{
93bf083d	253	_error->Error("Method gave invalid 201 URI Done message");
c88edf1d AL	254	break;
c88edf1d AL	255	}
c5ccf175	256
bfd22fc0	257	pkgAcquire::Item *Owner = Itm->Owner;
8267fe24	258	pkgAcquire::ItemDesc Desc = *Itm;
c5ccf175 AL	259
	260	// Display update before completion
	261	if (Log != 0 && Log->MorePulses == true)
	262	Log->Pulse(Owner->GetOwner());
	263
be4401bf	264	OwnerQ->ItemDone(Itm);
b2e465d6	265	if (TotalSize != 0 &&
bf3abeed	266	(unsigned)atoi(LookupTag(Message,"Size","0").c_str()) != TotalSize)
b2e465d6	267	_error->Warning("Bizarre Error - File size is not what the server reported %s %lu",
18ef0a78	268	LookupTag(Message,"Size","0").c_str(),TotalSize);
bdae53f1 AL	269
bdae53f1 AL	270	Owner->Done(Message,atoi(LookupTag(Message,"Size","0").c_str()),
459681d3	271	LookupTag(Message,"MD5-Hash"),Config);
8267fe24 AL	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)
c46824ce AL	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	}
8267fe24 AL	285	else
8267fe24 AL	286	Log->Done(Desc);
18ef0a78	287	}
c88edf1d AL	288	break;
c88edf1d AL	289	}
0a8a80e5 AL	290
	291	// 400 URI Failure
	292	case 400:
c88edf1d AL	293	{
	294	if (Itm == 0)
	295	{
93bf083d	296	_error->Error("Method gave invalid 400 URI Failure message");
c88edf1d AL	297	break;
	298	}
	299
c5ccf175 AL	300	// Display update before completion
	301	if (Log != 0 && Log->MorePulses == true)
	302	Log->Pulse(Itm->Owner->GetOwner());
	303
bfd22fc0	304	pkgAcquire::Item *Owner = Itm->Owner;
8267fe24	305	pkgAcquire::ItemDesc Desc = *Itm;
c88edf1d	306	OwnerQ->ItemDone(Itm);
7e5f33eb MV	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
7d8afa39	314	Owner->Failed(Message,Config);
8267fe24	315	ItemDone();
7d8afa39	316
8267fe24 AL	317	if (Log != 0)
8267fe24 AL	318	Log->Fail(Desc);
7d8afa39	319
c88edf1d AL	320	break;
c88edf1d AL	321	}
0a8a80e5 AL	322
	323	// 401 General Failure
	324	case 401:
b2e465d6	325	_error->Error("Method %s General failure: %s",Access.c_str(),LookupTag(Message,"Message").c_str());
0a8a80e5	326	break;
542ec555 AL	327
	328	// 403 Media Change
	329	case 403:
	330	MediaChange(Message);
	331	break;
3b5421b4 AL	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);
0a8a80e5 AL	348	Config->Pipeline = StringToBool(LookupTag(Message,"Pipeline"),false);
0a8a80e5 AL	349	Config->SendConfig = StringToBool(LookupTag(Message,"Send-Config"),false);
e331f6ed	350	Config->LocalOnly = StringToBool(LookupTag(Message,"Local-Only"),false);
8e5fc8f5	351	Config->NeedsCleanup = StringToBool(LookupTag(Message,"Needs-Cleanup"),false);
459681d3	352	Config->Removable = StringToBool(LookupTag(Message,"Removable"),false);
3b5421b4 AL	353
	354	// Some debug text
	355	if (Debug == true)
	356	{
	357	clog << "Configured access method " << Config->Access << endl;
459681d3 AL	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;
3b5421b4 AL	365	}
3b5421b4 AL	366
542ec555 AL	367	return true;
	368	}
	369	/}}}/
	370	// Worker::MediaChange - Request a media change /{{{/
	371	// ---------------------------------------------------------------------
	372	/* */
	373	bool pkgAcquire::Worker::MediaChange(string Message)
	374	{
80a26ed1 MV	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;
1a82c63e MV	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());
80a26ed1	385	status << "media-change: " // message
1a82c63e MV	386	<< Media << ":" // media
	387	<< Drive << ":" // drive
	388	<< msg.str() // l10n message
80a26ed1 MV	389	<< endl;
	390	write(status_fd, status.str().c_str(), status.str().size());
	391	}
	392
542ec555 AL	393	if (Log == 0 \|\| Log->MediaChange(LookupTag(Message,"Media"),
	394	LookupTag(Message,"Drive")) == false)
	395	{
	396	char S[300];
96bc43c4	397	snprintf(S,sizeof(S),"603 Media Changed\nFailed: true\n\n");
542ec555 AL	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];
96bc43c4	406	snprintf(S,sizeof(S),"603 Media Changed\n\n");
542ec555 AL	407	if (Debug == true)
	408	clog << " -> " << Access << ':' << QuoteString(S,"\n") << endl;
	409	OutQueue += S;
	410	OutReady = true;
3b5421b4 AL	411	return true;
3b5421b4 AL	412	}
0118833a	413	/}}}/
0a8a80e5 AL	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	{
b2e465d6	435	string Line = "Config-Item: " + QuoteString(Top->FullTag(),"=\"\n") + "=";
0a8a80e5 AL	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	{
b0db36b1 AL	489	int Res;
	490	do
	491	{
24a0d63a	492	Res = write(OutFd,OutQueue.c_str(),OutQueue.length());
b0db36b1 AL	493	}
	494	while (Res < 0 && errno == EINTR);
	495
0a8a80e5 AL	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	{
76d97c26 AL	527	_error->Error("Method %s has died unexpectedly!",Access.c_str());
76d97c26 AL	528
ddc1d8d0	529	ExecWait(Process,Access.c_str(),true);
0a8a80e5 AL	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	/}}}/
8267fe24 AL	543	// Worker::Pulse - Called periodically /{{{/
	544	// ---------------------------------------------------------------------
	545	/* */
	546	void pkgAcquire::Worker::Pulse()
	547	{
	548	if (CurrentItem == 0)
	549	return;
542ec555	550
8267fe24 AL	551	struct stat Buf;
	552	if (stat(CurrentItem->Owner->DestFile.c_str(),&Buf) != 0)
	553	return;
	554	CurrentSize = Buf.st_size;
18ef0a78 AL	555
	556	// Hmm? Should not happen...
	557	if (CurrentSize > TotalSize && TotalSize != 0)
	558	TotalSize = CurrentSize;
8267fe24 AL	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	/}}}/