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