[apt.git] / apt-private / acqprogress.cc

// -*- mode: cpp; mode: fold -*-
// Description								/*{{{*/
// $Id: acqprogress.cc,v 1.24 2003/04/27 01:56:48 doogie Exp $
/* ######################################################################

   Acquire Progress - Command line progress meter 
   
   ##################################################################### */
									/*}}}*/
// Include files							/*{{{*/
#include<config.h>

#include <apt-pkg/acquire.h>
#include <apt-pkg/acquire-item.h>
#include <apt-pkg/acquire-worker.h>
#include <apt-pkg/configuration.h>
#include <apt-pkg/strutl.h>
#include <apt-pkg/error.h>

#include <apt-private/acqprogress.h>

#include <string.h>
#include <stdio.h>
#include <signal.h>
#include <iostream>
#include <unistd.h>

#include <apti18n.h>
									/*}}}*/

using namespace std;

// AcqTextStatus::AcqTextStatus - Constructor				/*{{{*/
// ---------------------------------------------------------------------
/* */
AcqTextStatus::AcqTextStatus(unsigned int &ScreenWidth,unsigned int const Quiet) :
    pkgAcquireStatus(), ScreenWidth(ScreenWidth), ID(0), Quiet(Quiet)
{
   BlankLine[0] = 0;
   // testcases use it to disable pulses without disabling other user messages
   if (Quiet == 0 && _config->FindB("quiet::NoUpdate", false) == true)
      this->Quiet = 1;
}
									/*}}}*/
// AcqTextStatus::Start - Downloading has started			/*{{{*/
// ---------------------------------------------------------------------
/* */
void AcqTextStatus::Start()
{
   pkgAcquireStatus::Start();
   BlankLine[0] = 0;
   ID = 1;
}
									/*}}}*/
// AcqTextStatus::IMSHit - Called when an item got a HIT response	/*{{{*/
// ---------------------------------------------------------------------
/* */
void AcqTextStatus::IMSHit(pkgAcquire::ItemDesc &Itm)
{
   if (Quiet > 1)
      return;

   if (Quiet <= 0)
      cout << '\r' << BlankLine << '\r';

   cout << _("Hit ") << Itm.Description;
   cout << endl;
   Update = true;
}
									/*}}}*/
// AcqTextStatus::Fetch - An item has started to download		/*{{{*/
// ---------------------------------------------------------------------
/* This prints out the short description and the expected size */
void AcqTextStatus::Fetch(pkgAcquire::ItemDesc &Itm)
{
   Update = true;
   if (Itm.Owner->Complete == true)
      return;

   Itm.Owner->ID = ID++;

   if (Quiet > 1)
      return;

   if (Quiet <= 0)
      cout << '\r' << BlankLine << '\r';

   cout << _("Get:") << Itm.Owner->ID << ' ' << Itm.Description;
   if (Itm.Owner->FileSize != 0)
      cout << " [" << SizeToStr(Itm.Owner->FileSize) << "B]";
   cout << endl;
}
									/*}}}*/
// AcqTextStatus::Done - Completed a download				/*{{{*/
// ---------------------------------------------------------------------
/* We don't display anything... */
void AcqTextStatus::Done(pkgAcquire::ItemDesc &/*Itm*/)
{
   Update = true;
}
									/*}}}*/
// AcqTextStatus::Fail - Called when an item fails to download		/*{{{*/
// ---------------------------------------------------------------------
/* We print out the error text  */
void AcqTextStatus::Fail(pkgAcquire::ItemDesc &Itm)
{
   if (Quiet > 1)
      return;

   // Ignore certain kinds of transient failures (bad code)
   if (Itm.Owner->Status == pkgAcquire::Item::StatIdle)
      return;

   if (Quiet <= 0)
      cout << '\r' << BlankLine << '\r';

   if (Itm.Owner->Status == pkgAcquire::Item::StatDone)
   {
      cout << _("Ign ") << Itm.Description << endl;
      if (Itm.Owner->ErrorText.empty() == false &&
	    _config->FindB("Acquire::Progress::Ignore::ShowErrorText", false) == true)
	 cout << "  " << Itm.Owner->ErrorText << endl;
   }
   else
   {
      cout << _("Err ") << Itm.Description << endl;
      cout << "  " << Itm.Owner->ErrorText << endl;
   }

   Update = true;
}
									/*}}}*/
// AcqTextStatus::Stop - Finished downloading				/*{{{*/
// ---------------------------------------------------------------------
/* This prints out the bytes downloaded and the overall average line
   speed */
void AcqTextStatus::Stop()
{
   pkgAcquireStatus::Stop();
   if (Quiet > 1)
      return;

   if (Quiet <= 0)
      cout << '\r' << BlankLine << '\r' << flush;

   if (_config->FindB("quiet::NoStatistic", false) == true)
      return;

   if (FetchedBytes != 0 && _error->PendingError() == false)
      ioprintf(cout,_("Fetched %sB in %s (%sB/s)\n"),
	       SizeToStr(FetchedBytes).c_str(),
	       TimeToStr(ElapsedTime).c_str(),
	       SizeToStr(CurrentCPS).c_str());
}
									/*}}}*/
// AcqTextStatus::Pulse - Regular event pulse				/*{{{*/
// ---------------------------------------------------------------------
/* This draws the current progress. Each line has an overall percent
   meter and a per active item status meter along with an overall 
   bandwidth and ETA indicator. */
bool AcqTextStatus::Pulse(pkgAcquire *Owner)
{
   pkgAcquireStatus::Pulse(Owner);

   if (Quiet > 0)
      return true;

   enum {Long = 0,Medium,Short} Mode = Medium;

   char Buffer[sizeof(BlankLine)];
   char *End = Buffer + sizeof(Buffer);
   char *S = Buffer;
   if (ScreenWidth >= sizeof(Buffer))
      ScreenWidth = sizeof(Buffer)-1;

   // Put in the percent done
   sprintf(S,"%.0f%%", Percent);

   bool Shown = false;
   for (pkgAcquire::Worker *I = Owner->WorkersBegin(); I != 0;
	I = Owner->WorkerStep(I))
   {
      S += strlen(S);

      // There is no item running
      if (I->CurrentItem == 0)
      {
	 if (I->Status.empty() == false)
	 {
	    snprintf(S,End-S," [%s]",I->Status.c_str());
	    Shown = true;
	 }

	 continue;
      }

      Shown = true;

      // Add in the short description
      if (I->CurrentItem->Owner->ID != 0)
	 snprintf(S,End-S," [%lu %s",I->CurrentItem->Owner->ID,
		  I->CurrentItem->ShortDesc.c_str());
      else
	 snprintf(S,End-S," [%s",I->CurrentItem->ShortDesc.c_str());
      S += strlen(S);

      // Show the short mode string
      if (I->CurrentItem->Owner->ActiveSubprocess.empty() == false)
      {
	 snprintf(S,End-S, " %s", I->CurrentItem->Owner->ActiveSubprocess.c_str());
	 S += strlen(S);
      }

      // Add the current progress
      if (Mode == Long)
	 snprintf(S,End-S," %llu",I->CurrentSize);
      else
      {
	 if (Mode == Medium || I->TotalSize == 0)
	    snprintf(S,End-S," %sB",SizeToStr(I->CurrentSize).c_str());
      }
      S += strlen(S);

      // Add the total size and percent
      if (I->TotalSize > 0 && I->CurrentItem->Owner->Complete == false)
      {
	 if (Mode == Short)
	    snprintf(S,End-S," %.0f%%",
		     (I->CurrentSize*100.0)/I->TotalSize);
	 else
	    snprintf(S,End-S,"/%sB %.0f%%",SizeToStr(I->TotalSize).c_str(),
		     (I->CurrentSize*100.0)/I->TotalSize);
      }
      S += strlen(S);
      snprintf(S,End-S,"]");
   }

   // Show something..
   if (Shown == false)
      snprintf(S,End-S,_(" [Working]"));

   /* Put in the ETA and cps meter, block off signals to prevent strangeness
      during resizing */
   sigset_t Sigs,OldSigs;
   sigemptyset(&Sigs);
   sigaddset(&Sigs,SIGWINCH);
   sigprocmask(SIG_BLOCK,&Sigs,&OldSigs);

   if (CurrentCPS != 0)
   {
      char Tmp[300];
      unsigned long long ETA = (TotalBytes - CurrentBytes)/CurrentCPS;
      sprintf(Tmp," %sB/s %s",SizeToStr(CurrentCPS).c_str(),TimeToStr(ETA).c_str());
      unsigned int Len = strlen(Buffer);
      unsigned int LenT = strlen(Tmp);
      if (Len + LenT < ScreenWidth)
      {
	 memset(Buffer + Len,' ',ScreenWidth - Len);
	 strcpy(Buffer + ScreenWidth - LenT,Tmp);
      }
   }
   Buffer[ScreenWidth] = 0;
   BlankLine[ScreenWidth] = 0;
   sigprocmask(SIG_SETMASK,&OldSigs,0);

   // Draw the current status
   if (_config->FindB("Apt::Color", false) == true)
      cout << _config->Find("APT::Color::Yellow");
   if (strlen(Buffer) == strlen(BlankLine))
      cout << '\r' << Buffer << flush;
   else
      cout << '\r' << BlankLine << '\r' << Buffer << flush;
   if (_config->FindB("Apt::Color", false) == true)
      cout << _config->Find("APT::Color::Neutral") << flush;

   memset(BlankLine,' ',strlen(Buffer));
   BlankLine[strlen(Buffer)] = 0;

   Update = false;

   return true;
}
									/*}}}*/
// AcqTextStatus::MediaChange - Media need to be swapped		/*{{{*/
// ---------------------------------------------------------------------
/* Prompt for a media swap */
bool AcqTextStatus::MediaChange(string Media,string Drive)
{
   // If we do not output on a terminal and one of the options to avoid user
   // interaction is given, we assume that no user is present who could react
   // on your media change request
   if (isatty(STDOUT_FILENO) != 1 && Quiet >= 2 &&
       (_config->FindB("APT::Get::Assume-Yes",false) == true ||
	_config->FindB("APT::Get::Force-Yes",false) == true ||
	_config->FindB("APT::Get::Trivial-Only",false) == true))

      return false;

   if (Quiet <= 0)
      cout << '\r' << BlankLine << '\r';
   ioprintf(cout,_("Media change: please insert the disc labeled\n"
		   " '%s'\n"
		   "in the drive '%s' and press enter\n"),
	    Media.c_str(),Drive.c_str());

   char C = 0;
   bool bStatus = true;
   while (C != '\n' && C != '\r')
   {
      int len = read(STDIN_FILENO,&C,1);
      if(C == 'c' || len <= 0)
	 bStatus = false;
   }

   if(bStatus)
      Update = true;
   return bStatus;
}
									/*}}}*/
Commit	Line	Data
b9179170 MV	1	// -- mode: cpp; mode: fold --
	2	// Description /{{{/
	3	// $Id: acqprogress.cc,v 1.24 2003/04/27 01:56:48 doogie Exp $
	4	/* ######################################################################
	5
	6	Acquire Progress - Command line progress meter
	7
	8	##################################################################### */
	9	/}}}/
	10	// Include files /{{{/
	11	#include<config.h>
	12
453b82a3	13	#include <apt-pkg/acquire.h>
b9179170 MV	14	#include <apt-pkg/acquire-item.h>
	15	#include <apt-pkg/acquire-worker.h>
	16	#include <apt-pkg/configuration.h>
	17	#include <apt-pkg/strutl.h>
	18	#include <apt-pkg/error.h>
	19
453b82a3 DK	20	#include <apt-private/acqprogress.h>
	21
	22	#include <string.h>
b9179170 MV	23	#include <stdio.h>
	24	#include <signal.h>
	25	#include <iostream>
	26	#include <unistd.h>
	27
b9179170 MV	28	#include <apti18n.h>
	29	/}}}/
	30
	31	using namespace std;
	32
	33	// AcqTextStatus::AcqTextStatus - Constructor /{{{/
	34	// ---------------------------------------------------------------------
	35	/* */
18cce398 DK	36	AcqTextStatus::AcqTextStatus(unsigned int &ScreenWidth,unsigned int const Quiet) :
18cce398 DK	37	pkgAcquireStatus(), ScreenWidth(ScreenWidth), ID(0), Quiet(Quiet)
b9179170 MV	38	{
b9179170 MV	39	BlankLine[0] = 0;
18cce398 DK	40	// testcases use it to disable pulses without disabling other user messages
	41	if (Quiet == 0 && _config->FindB("quiet::NoUpdate", false) == true)
	42	this->Quiet = 1;
b9179170 MV	43	}
	44	/}}}/
	45	// AcqTextStatus::Start - Downloading has started /{{{/
	46	// ---------------------------------------------------------------------
	47	/* */
d3e8fbb3	48	void AcqTextStatus::Start()
b9179170	49	{
d3e8fbb3	50	pkgAcquireStatus::Start();
b9179170 MV	51	BlankLine[0] = 0;
b9179170 MV	52	ID = 1;
d3e8fbb3	53	}
b9179170 MV	54	/}}}/
	55	// AcqTextStatus::IMSHit - Called when an item got a HIT response /{{{/
	56	// ---------------------------------------------------------------------
	57	/* */
	58	void AcqTextStatus::IMSHit(pkgAcquire::ItemDesc &Itm)
	59	{
	60	if (Quiet > 1)
	61	return;
	62
	63	if (Quiet <= 0)
d3e8fbb3 DK	64	cout << '\r' << BlankLine << '\r';
d3e8fbb3 DK	65
b9179170	66	cout << _("Hit ") << Itm.Description;
b9179170 MV	67	cout << endl;
b9179170 MV	68	Update = true;
d3e8fbb3	69	}
b9179170 MV	70	/}}}/
	71	// AcqTextStatus::Fetch - An item has started to download /{{{/
	72	// ---------------------------------------------------------------------
	73	/* This prints out the short description and the expected size */
	74	void AcqTextStatus::Fetch(pkgAcquire::ItemDesc &Itm)
	75	{
	76	Update = true;
	77	if (Itm.Owner->Complete == true)
	78	return;
d3e8fbb3	79
b9179170	80	Itm.Owner->ID = ID++;
d3e8fbb3	81
b9179170 MV	82	if (Quiet > 1)
	83	return;
	84
	85	if (Quiet <= 0)
	86	cout << '\r' << BlankLine << '\r';
d3e8fbb3	87
b9179170 MV	88	cout << _("Get:") << Itm.Owner->ID << ' ' << Itm.Description;
	89	if (Itm.Owner->FileSize != 0)
	90	cout << " [" << SizeToStr(Itm.Owner->FileSize) << "B]";
	91	cout << endl;
d3e8fbb3	92	}
b9179170 MV	93	/}}}/
	94	// AcqTextStatus::Done - Completed a download /{{{/
	95	// ---------------------------------------------------------------------
	96	/* We don't display anything... */
65512241	97	void AcqTextStatus::Done(pkgAcquire::ItemDesc &/Itm/)
b9179170 MV	98	{
b9179170 MV	99	Update = true;
d3e8fbb3	100	}
b9179170 MV	101	/}}}/
	102	// AcqTextStatus::Fail - Called when an item fails to download /{{{/
	103	// ---------------------------------------------------------------------
	104	/* We print out the error text */
	105	void AcqTextStatus::Fail(pkgAcquire::ItemDesc &Itm)
	106	{
	107	if (Quiet > 1)
	108	return;
	109
	110	// Ignore certain kinds of transient failures (bad code)
	111	if (Itm.Owner->Status == pkgAcquire::Item::StatIdle)
	112	return;
d3e8fbb3	113
b9179170 MV	114	if (Quiet <= 0)
b9179170 MV	115	cout << '\r' << BlankLine << '\r';
d3e8fbb3	116
b9179170 MV	117	if (Itm.Owner->Status == pkgAcquire::Item::StatDone)
	118	{
	119	cout << _("Ign ") << Itm.Description << endl;
d6cf2345 DK	120	if (Itm.Owner->ErrorText.empty() == false &&
d6cf2345 DK	121	_config->FindB("Acquire::Progress::Ignore::ShowErrorText", false) == true)
4dbfe436	122	cout << " " << Itm.Owner->ErrorText << endl;
b9179170 MV	123	}
	124	else
	125	{
	126	cout << _("Err ") << Itm.Description << endl;
	127	cout << " " << Itm.Owner->ErrorText << endl;
	128	}
d3e8fbb3	129
b9179170	130	Update = true;
d3e8fbb3	131	}
b9179170 MV	132	/}}}/
	133	// AcqTextStatus::Stop - Finished downloading /{{{/
	134	// ---------------------------------------------------------------------
	135	/* This prints out the bytes downloaded and the overall average line
	136	speed */
	137	void AcqTextStatus::Stop()
	138	{
	139	pkgAcquireStatus::Stop();
	140	if (Quiet > 1)
	141	return;
	142
	143	if (Quiet <= 0)
	144	cout << '\r' << BlankLine << '\r' << flush;
	145
0c8171d7 DK	146	if (_config->FindB("quiet::NoStatistic", false) == true)
	147	return;
	148
b9179170 MV	149	if (FetchedBytes != 0 && _error->PendingError() == false)
	150	ioprintf(cout,_("Fetched %sB in %s (%sB/s)\n"),
	151	SizeToStr(FetchedBytes).c_str(),
	152	TimeToStr(ElapsedTime).c_str(),
	153	SizeToStr(CurrentCPS).c_str());
	154	}
	155	/}}}/
	156	// AcqTextStatus::Pulse - Regular event pulse /{{{/
	157	// ---------------------------------------------------------------------
	158	/* This draws the current progress. Each line has an overall percent
	159	meter and a per active item status meter along with an overall
	160	bandwidth and ETA indicator. */
	161	bool AcqTextStatus::Pulse(pkgAcquire *Owner)
	162	{
	163	pkgAcquireStatus::Pulse(Owner);
d3e8fbb3	164
b9179170 MV	165	if (Quiet > 0)
b9179170 MV	166	return true;
d3e8fbb3	167
b9179170	168	enum {Long = 0,Medium,Short} Mode = Medium;
d3e8fbb3	169
b9179170 MV	170	char Buffer[sizeof(BlankLine)];
	171	char *End = Buffer + sizeof(Buffer);
	172	char *S = Buffer;
	173	if (ScreenWidth >= sizeof(Buffer))
	174	ScreenWidth = sizeof(Buffer)-1;
	175
	176	// Put in the percent done
96c6cab1	177	sprintf(S,"%.0f%%", Percent);
b9179170 MV	178
	179	bool Shown = false;
	180	for (pkgAcquire::Worker *I = Owner->WorkersBegin(); I != 0;
	181	I = Owner->WorkerStep(I))
	182	{
	183	S += strlen(S);
d3e8fbb3 DK	184
d3e8fbb3 DK	185	// There is no item running
b9179170 MV	186	if (I->CurrentItem == 0)
	187	{
	188	if (I->Status.empty() == false)
	189	{
	190	snprintf(S,End-S," [%s]",I->Status.c_str());
	191	Shown = true;
	192	}
d3e8fbb3	193
b9179170 MV	194	continue;
	195	}
	196
	197	Shown = true;
d3e8fbb3	198
b9179170 MV	199	// Add in the short description
	200	if (I->CurrentItem->Owner->ID != 0)
	201	snprintf(S,End-S," [%lu %s",I->CurrentItem->Owner->ID,
	202	I->CurrentItem->ShortDesc.c_str());
	203	else
	204	snprintf(S,End-S," [%s",I->CurrentItem->ShortDesc.c_str());
	205	S += strlen(S);
	206
	207	// Show the short mode string
ffbe056d	208	if (I->CurrentItem->Owner->ActiveSubprocess.empty() == false)
b9179170	209	{
ffbe056d	210	snprintf(S,End-S, " %s", I->CurrentItem->Owner->ActiveSubprocess.c_str());
b9179170 MV	211	S += strlen(S);
b9179170 MV	212	}
d3e8fbb3	213
b9179170 MV	214	// Add the current progress
	215	if (Mode == Long)
	216	snprintf(S,End-S," %llu",I->CurrentSize);
	217	else
	218	{
	219	if (Mode == Medium \|\| I->TotalSize == 0)
	220	snprintf(S,End-S," %sB",SizeToStr(I->CurrentSize).c_str());
	221	}
	222	S += strlen(S);
d3e8fbb3	223
b9179170 MV	224	// Add the total size and percent
	225	if (I->TotalSize > 0 && I->CurrentItem->Owner->Complete == false)
	226	{
	227	if (Mode == Short)
	228	snprintf(S,End-S," %.0f%%",
	229	(I->CurrentSize*100.0)/I->TotalSize);
	230	else
	231	snprintf(S,End-S,"/%sB %.0f%%",SizeToStr(I->TotalSize).c_str(),
	232	(I->CurrentSize*100.0)/I->TotalSize);
d3e8fbb3	233	}
b9179170 MV	234	S += strlen(S);
	235	snprintf(S,End-S,"]");
	236	}
	237
	238	// Show something..
	239	if (Shown == false)
	240	snprintf(S,End-S,_(" [Working]"));
d3e8fbb3	241
b9179170 MV	242	/* Put in the ETA and cps meter, block off signals to prevent strangeness
	243	during resizing */
	244	sigset_t Sigs,OldSigs;
	245	sigemptyset(&Sigs);
	246	sigaddset(&Sigs,SIGWINCH);
	247	sigprocmask(SIG_BLOCK,&Sigs,&OldSigs);
d3e8fbb3	248
b9179170	249	if (CurrentCPS != 0)
d3e8fbb3	250	{
b9179170 MV	251	char Tmp[300];
	252	unsigned long long ETA = (TotalBytes - CurrentBytes)/CurrentCPS;
	253	sprintf(Tmp," %sB/s %s",SizeToStr(CurrentCPS).c_str(),TimeToStr(ETA).c_str());
	254	unsigned int Len = strlen(Buffer);
	255	unsigned int LenT = strlen(Tmp);
	256	if (Len + LenT < ScreenWidth)
d3e8fbb3	257	{
b9179170 MV	258	memset(Buffer + Len,' ',ScreenWidth - Len);
b9179170 MV	259	strcpy(Buffer + ScreenWidth - LenT,Tmp);
d3e8fbb3	260	}
b9179170 MV	261	}
	262	Buffer[ScreenWidth] = 0;
	263	BlankLine[ScreenWidth] = 0;
	264	sigprocmask(SIG_SETMASK,&OldSigs,0);
	265
	266	// Draw the current status
	267	if (_config->FindB("Apt::Color", false) == true)
	268	cout << _config->Find("APT::Color::Yellow");
	269	if (strlen(Buffer) == strlen(BlankLine))
	270	cout << '\r' << Buffer << flush;
	271	else
	272	cout << '\r' << BlankLine << '\r' << Buffer << flush;
	273	if (_config->FindB("Apt::Color", false) == true)
6f34deea	274	cout << _config->Find("APT::Color::Neutral") << flush;
b9179170 MV	275
	276	memset(BlankLine,' ',strlen(Buffer));
	277	BlankLine[strlen(Buffer)] = 0;
d3e8fbb3	278
b9179170 MV	279	Update = false;
	280
	281	return true;
	282	}
	283	/}}}/
	284	// AcqTextStatus::MediaChange - Media need to be swapped /{{{/
	285	// ---------------------------------------------------------------------
	286	/* Prompt for a media swap */
	287	bool AcqTextStatus::MediaChange(string Media,string Drive)
	288	{
	289	// If we do not output on a terminal and one of the options to avoid user
	290	// interaction is given, we assume that no user is present who could react
	291	// on your media change request
	292	if (isatty(STDOUT_FILENO) != 1 && Quiet >= 2 &&
	293	(_config->FindB("APT::Get::Assume-Yes",false) == true \|\|
	294	_config->FindB("APT::Get::Force-Yes",false) == true \|\|
	295	_config->FindB("APT::Get::Trivial-Only",false) == true))
	296
	297	return false;
	298
	299	if (Quiet <= 0)
	300	cout << '\r' << BlankLine << '\r';
	301	ioprintf(cout,_("Media change: please insert the disc labeled\n"
	302	" '%s'\n"
	303	"in the drive '%s' and press enter\n"),
	304	Media.c_str(),Drive.c_str());
	305
	306	char C = 0;
	307	bool bStatus = true;
	308	while (C != '\n' && C != '\r')
	309	{
	310	int len = read(STDIN_FILENO,&C,1);
	311	if(C == 'c' \|\| len <= 0)
	312	bStatus = false;
	313	}
	314
	315	if(bStatus)
	316	Update = true;
	317	return bStatus;
	318	}
	319	/}}}/