Add progressbar to "Dpkg::Progress-Fancy"

A text progressbar is now displayed in the Dpkg::Progress-Fancy
mode. It can be turned off via the apt option
Dpkg::Progress-Fancy::Progress-Bar=false

4 files changed, 98 insertions, 12 deletions

diff --git a/apt-pkg/install-progress.cc b/apt-pkg/install-progress.cc
index 96334b006..8bb587f67 100644
--- a/apt-pkg/install-progress.cc
+++ b/apt-pkg/install-progress.cc
@@ -252,17 +252,22 @@ void PackageManagerFancy::staticSIGWINCH(int signum)
       (*I)->HandleSIGWINCH(signum);
 }
 
-int PackageManagerFancy::GetNumberTerminalRows()
+PackageManagerFancy::TermSize
+PackageManagerFancy::GetTerminalSize()
 {
    struct winsize win;
+   PackageManagerFancy::TermSize s;
+
    // FIXME: get from "child_pty" instead?
    if(ioctl(STDOUT_FILENO, TIOCGWINSZ, (char *)&win) != 0)
-      return -1;
+      return s;
 
    if(_config->FindB("Debug::InstallProgress::Fancy", false) == true)
-      std::cerr << "GetNumberTerminalRows: " << win.ws_row << std::endl;
-   
-   return win.ws_row;
+      std::cerr << "GetTerminalSize: " << win.ws_row << std::endl;
+
+   s.rows = win.ws_row;
+   s.columns = win.ws_col;
+   return s;
 }
 
 void PackageManagerFancy::SetupTerminalScrollArea(int nr_rows)
@@ -298,21 +303,21 @@ void PackageManagerFancy::SetupTerminalScrollArea(int nr_rows)
 
 void PackageManagerFancy::HandleSIGWINCH(int)
 {
-   int nr_terminal_rows = GetNumberTerminalRows();
+   int nr_terminal_rows = GetTerminalSize().rows;
    SetupTerminalScrollArea(nr_terminal_rows);
 }
 
 void PackageManagerFancy::Start(int a_child_pty)
 {
    child_pty = a_child_pty;
-   int nr_terminal_rows = GetNumberTerminalRows();
+   int nr_terminal_rows = GetTerminalSize().rows;
    if (nr_terminal_rows > 0)
       SetupTerminalScrollArea(nr_terminal_rows);
 }
 
 void PackageManagerFancy::Stop()
 {
-   int nr_terminal_rows = GetNumberTerminalRows();
+   int nr_terminal_rows = GetTerminalSize().rows;
    if (nr_terminal_rows > 0)
    {
       SetupTerminalScrollArea(nr_terminal_rows + 1);
@@ -324,6 +329,26 @@ void PackageManagerFancy::Stop()
    child_pty = -1;
 }
 
+std::string 
+PackageManagerFancy::GetTextProgressStr(float Percent, int OutputSize)
+{
+   std::string output;
+   int i;
+   
+   // should we raise a exception here instead?
+   if (Percent < 0.0 || Percent > 1.0 || OutputSize < 3)
+      return output;
+   
+   int BarSize = OutputSize - 2; // bar without the leading "[" and trailing "]"
+   output += "[";
+   for(i=0; i < BarSize*Percent; i++)
+      output += "#";
+   for (/*nothing*/; i < BarSize; i++)
+      output += ".";
+   output += "]";
+   return output;
+}
+
 bool PackageManagerFancy::StatusChanged(std::string PackageName, 
                                         unsigned int StepsDone,
                                         unsigned int TotalSteps,
@@ -333,7 +358,7 @@ bool PackageManagerFancy::StatusChanged(std::string PackageName,
           HumanReadableAction))
       return false;
 
-   int row = GetNumberTerminalRows();
+   PackageManagerFancy::TermSize size = GetTerminalSize();
 
    static std::string save_cursor = "\033[s";
    static std::string restore_cursor = "\033[u";
@@ -350,14 +375,30 @@ bool PackageManagerFancy::StatusChanged(std::string PackageName,
 
    std::cout << save_cursor
       // move cursor position to last row
-             << "\033[" << row << ";0f" 
+             << "\033[" << size.rows << ";0f" 
              << set_bg_color
              << set_fg_color
              << progress_str
-             << restore_cursor
              << restore_bg
              << restore_fg;
    std::flush(std::cout);
+
+   // draw text progress bar
+   if (_config->FindB("Dpkg::Progress-Fancy::Progress-Bar", true))
+   {
+      int padding = 4;
+      float progressbar_size = size.columns - padding - progress_str.size();
+      float current_percent = (float)StepsDone/(float)TotalSteps;
+      std::cout << " " 
+                << GetTextProgressStr(current_percent, progressbar_size)
+                << " ";
+      std::flush(std::cout);
+   }
+
+   // restore
+   std::cout << restore_cursor;
+   std::flush(std::cout);
+
    last_reported_progress = percentage;
 
    return true;
diff --git a/apt-pkg/install-progress.h b/apt-pkg/install-progress.h
index baf245376..112b034fb 100644
--- a/apt-pkg/install-progress.h
+++ b/apt-pkg/install-progress.h
@@ -125,7 +125,12 @@ namespace Progress {
     void SetupTerminalScrollArea(int nr_rows);
     void HandleSIGWINCH(int);
 
-    int GetNumberTerminalRows();
+    typedef struct {
+       int rows;
+       int columns;
+    } TermSize;
+    TermSize GetTerminalSize();
+
     sighandler_t old_SIGWINCH;
     int child_pty;
 
@@ -138,6 +143,10 @@ namespace Progress {
                                unsigned int StepsDone,
                                unsigned int TotalSteps,
                                std::string HumanReadableAction);
+
+    // return a progress bar of the given size for the given progress 
+    // percent between 0.0 and 1.0 in the form "[####...]"
+    static std::string GetTextProgressStr(float percent, int OutputSize);
  };
 
  class PackageManagerText : public PackageManager
diff --git a/test/libapt/install_progress_test.cc b/test/libapt/install_progress_test.cc
new file mode 100644
index 000000000..be1a3411e
--- /dev/null
+++ b/test/libapt/install_progress_test.cc
@@ -0,0 +1,30 @@
+#include <config.h>
+
+#include <apt-pkg/install-progress.h>
+
+#include <string>
+
+#include "assert.h"
+
+int main() {
+   APT::Progress::PackageManagerFancy p;
+   std::string s;   
+
+   s= p.GetTextProgressStr(0.5, 60);
+   equals(s.size(), 60);
+   
+   s= p.GetTextProgressStr(0.5, 4);
+   equals(s, "[#.]");
+
+   s= p.GetTextProgressStr(0.1, 12);
+   equals(s, "[#.........]");
+   
+   s= p.GetTextProgressStr(0.9, 12);
+   equals(s, "[#########.]");
+
+   // deal with incorrect inputs gracefully (or should we die instead?)
+   s= p.GetTextProgressStr(-999, 12);
+   equals(s, "");
+
+   return 0;
+}
diff --git a/test/libapt/makefile b/test/libapt/makefile
index 66d6ea783..e03b5e6aa 100644
--- a/test/libapt/makefile
+++ b/test/libapt/makefile
@@ -123,3 +123,9 @@ SLIBS = -lapt-pkg
 SOURCE = sourcelist_test.cc
 include $(PROGRAM_H)
 
+# test install-progress
+PROGRAM = InstallProgress${BASENAME}
+SLIBS = -lapt-pkg
+SOURCE = install_progress_test.cc
+include $(PROGRAM_H)
+