make fancy-progress fg/bg color configurable
[ntk/apt.git] / apt-pkg / install-progress.cc
CommitLineData
453b82a3
DK
1#include <config.h>
2
e6ad8031
MV
3#include <apt-pkg/configuration.h>
4#include <apt-pkg/fileutl.h>
31f97d7b 5#include <apt-pkg/strutl.h>
af36becc 6#include <apt-pkg/install-progress.h>
c7ea1eba 7
453b82a3
DK
8#include <signal.h>
9#include <unistd.h>
10#include <iostream>
11#include <string>
12#include <vector>
31f97d7b 13#include <sys/ioctl.h>
e6ad8031 14#include <sstream>
5e9458e2 15#include <fcntl.h>
5ed88785 16#include <algorithm>
c23e6cd5 17#include <stdio.h>
e96e4e9c 18
453b82a3
DK
19#include <apti18n.h>
20
31f97d7b
MV
21namespace APT {
22namespace Progress {
23
61f954bf
MV
24
25/* Return a APT::Progress::PackageManager based on the global
26 * apt configuration (i.e. APT::Status-Fd and APT::Status-deb822-Fd)
27 */
bd5f39b3
MV
28PackageManager* PackageManagerProgressFactory()
29{
30 // select the right progress
31 int status_fd = _config->FindI("APT::Status-Fd", -1);
32 int status_deb822_fd = _config->FindI("APT::Status-deb822-Fd", -1);
33
34 APT::Progress::PackageManager *progress = NULL;
35 if (status_deb822_fd > 0)
36 progress = new APT::Progress::PackageManagerProgressDeb822Fd(
37 status_deb822_fd);
38 else if (status_fd > 0)
39 progress = new APT::Progress::PackageManagerProgressFd(status_fd);
40 else if(_config->FindB("Dpkg::Progress-Fancy", false) == true)
41 progress = new APT::Progress::PackageManagerFancy();
42 else if (_config->FindB("Dpkg::Progress",
43 _config->FindB("DpkgPM::Progress", false)) == true)
44 progress = new APT::Progress::PackageManagerText();
45 else
46 progress = new APT::Progress::PackageManager();
47 return progress;
48}
49
65512241 50bool PackageManager::StatusChanged(std::string /*PackageName*/,
e6ad8031
MV
51 unsigned int StepsDone,
52 unsigned int TotalSteps,
65512241 53 std::string /*HumanReadableAction*/)
6c5ae8ed
MV
54{
55 int reporting_steps = _config->FindI("DpkgPM::Reporting-Steps", 1);
56 percentage = StepsDone/(float)TotalSteps * 100.0;
57 strprintf(progress_str, _("Progress: [%3i%%]"), (int)percentage);
58
59 if(percentage < (last_reported_progress + reporting_steps))
60 return false;
61
62 return true;
63}
64
e6ad8031 65PackageManagerProgressFd::PackageManagerProgressFd(int progress_fd)
65dbd5a1 66 : StepsDone(0), StepsTotal(1)
e6ad8031
MV
67{
68 OutStatusFd = progress_fd;
69}
70
f9935b1c
MV
71void PackageManagerProgressFd::WriteToStatusFd(std::string s)
72{
73 if(OutStatusFd <= 0)
74 return;
75 FileFd::Write(OutStatusFd, s.c_str(), s.size());
76}
77
e45c4617 78void PackageManagerProgressFd::StartDpkg()
e6ad8031 79{
5e9458e2
MV
80 if(OutStatusFd <= 0)
81 return;
82
83 // FIXME: use SetCloseExec here once it taught about throwing
84 // exceptions instead of doing _exit(100) on failure
85 fcntl(OutStatusFd,F_SETFD,FD_CLOEXEC);
e6ad8031
MV
86
87 // send status information that we are about to fork dpkg
f9935b1c
MV
88 std::ostringstream status;
89 status << "pmstatus:dpkg-exec:"
90 << (StepsDone/float(StepsTotal)*100.0)
91 << ":" << _("Running dpkg")
92 << std::endl;
93 WriteToStatusFd(status.str());
e6ad8031
MV
94}
95
a02db58f 96APT_CONST void PackageManagerProgressFd::Stop()
e6ad8031 97{
e6ad8031
MV
98}
99
100void PackageManagerProgressFd::Error(std::string PackageName,
101 unsigned int StepsDone,
102 unsigned int TotalSteps,
103 std::string ErrorMessage)
104{
105 std::ostringstream status;
106 status << "pmerror:" << PackageName
107 << ":" << (StepsDone/float(TotalSteps)*100.0)
108 << ":" << ErrorMessage
109 << std::endl;
f9935b1c 110 WriteToStatusFd(status.str());
e6ad8031
MV
111}
112
113void PackageManagerProgressFd::ConffilePrompt(std::string PackageName,
114 unsigned int StepsDone,
115 unsigned int TotalSteps,
116 std::string ConfMessage)
117{
118 std::ostringstream status;
119 status << "pmconffile:" << PackageName
120 << ":" << (StepsDone/float(TotalSteps)*100.0)
121 << ":" << ConfMessage
122 << std::endl;
f9935b1c 123 WriteToStatusFd(status.str());
e6ad8031
MV
124}
125
126
127bool PackageManagerProgressFd::StatusChanged(std::string PackageName,
128 unsigned int xStepsDone,
129 unsigned int xTotalSteps,
130 std::string pkg_action)
131{
132 StepsDone = xStepsDone;
133 StepsTotal = xTotalSteps;
134
135 // build the status str
136 std::ostringstream status;
dd640f3c 137 status << "pmstatus:" << StringSplit(PackageName, ":")[0]
e6ad8031
MV
138 << ":" << (StepsDone/float(StepsTotal)*100.0)
139 << ":" << pkg_action
140 << std::endl;
f9935b1c 141 WriteToStatusFd(status.str());
65dbd5a1
MV
142
143 if(_config->FindB("Debug::APT::Progress::PackageManagerFd", false) == true)
144 std::cerr << "progress: " << PackageName << " " << xStepsDone
145 << " " << xTotalSteps << " " << pkg_action
146 << std::endl;
147
148
e6ad8031
MV
149 return true;
150}
151
c7ea1eba
MV
152
153PackageManagerProgressDeb822Fd::PackageManagerProgressDeb822Fd(int progress_fd)
154 : StepsDone(0), StepsTotal(1)
155{
156 OutStatusFd = progress_fd;
157}
158
159void PackageManagerProgressDeb822Fd::WriteToStatusFd(std::string s)
160{
161 FileFd::Write(OutStatusFd, s.c_str(), s.size());
162}
163
790d41f6 164void PackageManagerProgressDeb822Fd::StartDpkg()
c7ea1eba
MV
165{
166 // FIXME: use SetCloseExec here once it taught about throwing
167 // exceptions instead of doing _exit(100) on failure
168 fcntl(OutStatusFd,F_SETFD,FD_CLOEXEC);
169
170 // send status information that we are about to fork dpkg
171 std::ostringstream status;
172 status << "Status: " << "progress" << std::endl
173 << "Percent: " << (StepsDone/float(StepsTotal)*100.0) << std::endl
174 << "Message: " << _("Running dpkg") << std::endl
175 << std::endl;
176 WriteToStatusFd(status.str());
177}
178
a02db58f 179APT_CONST void PackageManagerProgressDeb822Fd::Stop()
c7ea1eba 180{
c7ea1eba
MV
181}
182
183void PackageManagerProgressDeb822Fd::Error(std::string PackageName,
184 unsigned int StepsDone,
185 unsigned int TotalSteps,
186 std::string ErrorMessage)
187{
188 std::ostringstream status;
189 status << "Status: " << "Error" << std::endl
190 << "Package:" << PackageName << std::endl
191 << "Percent: " << (StepsDone/float(TotalSteps)*100.0) << std::endl
192 << "Message: " << ErrorMessage << std::endl
193 << std::endl;
194 WriteToStatusFd(status.str());
195}
196
197void PackageManagerProgressDeb822Fd::ConffilePrompt(std::string PackageName,
198 unsigned int StepsDone,
199 unsigned int TotalSteps,
200 std::string ConfMessage)
201{
202 std::ostringstream status;
203 status << "Status: " << "ConfFile" << std::endl
204 << "Package:" << PackageName << std::endl
205 << "Percent: " << (StepsDone/float(TotalSteps)*100.0) << std::endl
206 << "Message: " << ConfMessage << std::endl
207 << std::endl;
208 WriteToStatusFd(status.str());
209}
210
211
212bool PackageManagerProgressDeb822Fd::StatusChanged(std::string PackageName,
213 unsigned int xStepsDone,
214 unsigned int xTotalSteps,
215 std::string message)
216{
217 StepsDone = xStepsDone;
218 StepsTotal = xTotalSteps;
219
220 // build the status str
221 std::ostringstream status;
222 status << "Status: " << "progress" << std::endl
223 << "Package: " << PackageName << std::endl
224 << "Percent: " << (StepsDone/float(StepsTotal)*100.0) << std::endl
225 << "Message: " << message << std::endl
226 << std::endl;
227 WriteToStatusFd(status.str());
228
229 return true;
230}
231
5ed88785
MV
232
233PackageManagerFancy::PackageManagerFancy()
234 : child_pty(-1)
235{
236 // setup terminal size
237 old_SIGWINCH = signal(SIGWINCH, PackageManagerFancy::staticSIGWINCH);
238 instances.push_back(this);
239}
240std::vector<PackageManagerFancy*> PackageManagerFancy::instances;
241
242PackageManagerFancy::~PackageManagerFancy()
243{
244 instances.erase(find(instances.begin(), instances.end(), this));
245 signal(SIGWINCH, old_SIGWINCH);
246}
247
248void PackageManagerFancy::staticSIGWINCH(int signum)
249{
250 std::vector<PackageManagerFancy *>::const_iterator I;
9ce3cfc9 251 for(I = instances.begin(); I != instances.end(); ++I)
5ed88785
MV
252 (*I)->HandleSIGWINCH(signum);
253}
254
e96e4e9c
MV
255int PackageManagerFancy::GetNumberTerminalRows()
256{
257 struct winsize win;
5ed88785 258 // FIXME: get from "child_pty" instead?
e96e4e9c
MV
259 if(ioctl(STDOUT_FILENO, TIOCGWINSZ, (char *)&win) != 0)
260 return -1;
5ed88785
MV
261
262 if(_config->FindB("Debug::InstallProgress::Fancy", false) == true)
263 std::cerr << "GetNumberTerminalRows: " << win.ws_row << std::endl;
e96e4e9c
MV
264
265 return win.ws_row;
266}
c7ea1eba 267
db78c60c 268void PackageManagerFancy::SetupTerminalScrollArea(int nr_rows)
31f97d7b 269{
5ed88785
MV
270 if(_config->FindB("Debug::InstallProgress::Fancy", false) == true)
271 std::cerr << "SetupTerminalScrollArea: " << nr_rows << std::endl;
272
31f97d7b
MV
273 // scroll down a bit to avoid visual glitch when the screen
274 // area shrinks by one row
275 std::cout << "\n";
276
277 // save cursor
278 std::cout << "\033[s";
279
280 // set scroll region (this will place the cursor in the top left)
5ed88785 281 std::cout << "\033[0;" << nr_rows - 1 << "r";
31f97d7b
MV
282
283 // restore cursor but ensure its inside the scrolling area
284 std::cout << "\033[u";
285 static const char *move_cursor_up = "\033[1A";
286 std::cout << move_cursor_up;
db78c60c 287
5ed88785 288 // ensure its flushed
31f97d7b 289 std::flush(std::cout);
31f97d7b 290
5ed88785
MV
291 // setup tty size to ensure xterm/linux console are working properly too
292 // see bug #731738
293 struct winsize win;
294 ioctl(child_pty, TIOCGWINSZ, (char *)&win);
295 win.ws_row = nr_rows - 1;
296 ioctl(child_pty, TIOCSWINSZ, (char *)&win);
e96e4e9c
MV
297}
298
299void PackageManagerFancy::HandleSIGWINCH(int)
300{
301 int nr_terminal_rows = GetNumberTerminalRows();
302 SetupTerminalScrollArea(nr_terminal_rows);
31f97d7b
MV
303}
304
5ed88785 305void PackageManagerFancy::Start(int a_child_pty)
31f97d7b 306{
5ed88785 307 child_pty = a_child_pty;
e96e4e9c 308 int nr_terminal_rows = GetNumberTerminalRows();
db78c60c
MV
309 if (nr_terminal_rows > 0)
310 SetupTerminalScrollArea(nr_terminal_rows);
31f97d7b
MV
311}
312
a22fdebf 313void PackageManagerFancy::Stop()
31f97d7b 314{
e96e4e9c 315 int nr_terminal_rows = GetNumberTerminalRows();
db78c60c
MV
316 if (nr_terminal_rows > 0)
317 {
318 SetupTerminalScrollArea(nr_terminal_rows + 1);
31f97d7b 319
db78c60c
MV
320 // override the progress line (sledgehammer)
321 static const char* clear_screen_below_cursor = "\033[J";
322 std::cout << clear_screen_below_cursor;
323 }
5ed88785 324 child_pty = -1;
31f97d7b
MV
325}
326
6c5ae8ed 327bool PackageManagerFancy::StatusChanged(std::string PackageName,
31f97d7b 328 unsigned int StepsDone,
e6ad8031
MV
329 unsigned int TotalSteps,
330 std::string HumanReadableAction)
31f97d7b 331{
e6ad8031
MV
332 if (!PackageManager::StatusChanged(PackageName, StepsDone, TotalSteps,
333 HumanReadableAction))
6c5ae8ed 334 return false;
31f97d7b 335
e96e4e9c 336 int row = GetNumberTerminalRows();
31f97d7b 337
453b82a3
DK
338 static std::string save_cursor = "\033[s";
339 static std::string restore_cursor = "\033[u";
340
c34d1202
MV
341 // green
342 static std::string set_bg_color = DeQuoteString(
343 _config->Find("Dpkg::Progress-Fancy::Progress-fg", "%1b[42m"));
344 // black
345 static std::string set_fg_color = DeQuoteString(
346 _config->Find("Dpkg::Progress-Fancy::Progress-bg", "%1b[30m"));
453b82a3
DK
347
348 static std::string restore_bg = "\033[49m";
349 static std::string restore_fg = "\033[39m";
350
31f97d7b
MV
351 std::cout << save_cursor
352 // move cursor position to last row
353 << "\033[" << row << ";0f"
354 << set_bg_color
355 << set_fg_color
356 << progress_str
357 << restore_cursor
358 << restore_bg
359 << restore_fg;
360 std::flush(std::cout);
361 last_reported_progress = percentage;
6c5ae8ed
MV
362
363 return true;
31f97d7b
MV
364}
365
6c5ae8ed 366bool PackageManagerText::StatusChanged(std::string PackageName,
31f97d7b 367 unsigned int StepsDone,
e6ad8031
MV
368 unsigned int TotalSteps,
369 std::string HumanReadableAction)
31f97d7b 370{
e6ad8031 371 if (!PackageManager::StatusChanged(PackageName, StepsDone, TotalSteps, HumanReadableAction))
6c5ae8ed 372 return false;
31f97d7b
MV
373
374 std::cout << progress_str << "\r\n";
375 std::flush(std::cout);
376
377 last_reported_progress = percentage;
6c5ae8ed
MV
378
379 return true;
31f97d7b
MV
380}
381
382
c7ea1eba 383
d3e8fbb3
DK
384} // namespace progress
385} // namespace apt