From: Arvin Schnell <aschnell@suse.de>
Date: Thu, 17 Dec 2020 11:25:33 +0000 (+0100)
Subject: - added option to abbreviate columns in table
X-Git-Tag: v0.8.15~1^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=07525050e32c3e281cdba758863630ff78b9cebe;p=thirdparty%2Fsnapper.git

- added option to abbreviate columns in table
---

diff --git a/.github/workflows/ci-debian.yml b/.github/workflows/ci-debian.yml
index ca3f4aff..4282d2d1 100644
--- a/.github/workflows/ci-debian.yml
+++ b/.github/workflows/ci-debian.yml
@@ -10,7 +10,7 @@ jobs:
     steps:
 
     - name: Install additional packages
-      run: apt-get update && apt-get install -y --no-install-recommends acl-dev autoconf automake bzip2 docbook-xsl e2fslibs-dev g++ gettext libboost-dev libboost-system-dev libboost-test-dev libboost-thread-dev libbtrfs-dev libdbus-1-dev libjson-c-dev libmount-dev libpam-dev libtool libxml2-dev libz-dev locales-all make xsltproc
+      run: apt-get update && apt-get install -y --no-install-recommends acl-dev autoconf automake bzip2 docbook-xsl e2fslibs-dev g++ gettext libboost-dev libboost-system-dev libboost-test-dev libboost-thread-dev libbtrfs-dev libdbus-1-dev libjson-c-dev libmount-dev libpam-dev libtool libxml2-dev libz-dev locales-all make ncurses-dev xsltproc
 
     - name: List installed packages
       run: apt list --installed | sort
diff --git a/.github/workflows/ci-fedora.yml b/.github/workflows/ci-fedora.yml
index 48996a33..83e59f7c 100644
--- a/.github/workflows/ci-fedora.yml
+++ b/.github/workflows/ci-fedora.yml
@@ -10,7 +10,7 @@ jobs:
     steps:
 
     - name: Install additional packages
-      run: dnf -y install acl autoconf automake boost-devel btrfs-progs-devel bzip2 dbus-devel diffutils docbook-style-xsl e2fsprogs-devel gcc-c++ gettext glibc-langpack-de glibc-langpack-en json-c-devel libacl-devel libmount-devel libtool libxml2-devel libxslt make pam-devel
+      run: dnf -y install acl autoconf automake boost-devel btrfs-progs-devel bzip2 dbus-devel diffutils docbook-style-xsl e2fsprogs-devel gcc-c++ gettext glibc-langpack-de glibc-langpack-en json-c-devel libacl-devel libmount-devel libtool libxml2-devel libxslt make ncurses-devel pam-devel
 
     - name: List installed packages
       run: rpm -qa | sort
diff --git a/.github/workflows/ci-ubuntu.yml b/.github/workflows/ci-ubuntu.yml
index b89799fc..a34440e0 100644
--- a/.github/workflows/ci-ubuntu.yml
+++ b/.github/workflows/ci-ubuntu.yml
@@ -10,7 +10,7 @@ jobs:
     steps:
 
     - name: Install additional packages
-      run: apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends acl-dev autoconf automake bzip2 docbook-xsl e2fslibs-dev g++ gettext language-pack-de language-pack-en libboost-dev libboost-system-dev libboost-test-dev libboost-thread-dev libbtrfs-dev libdbus-1-dev libjson-c-dev libmount-dev libpam-dev libtool libxml2-dev libz-dev make xsltproc
+      run: apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends acl-dev autoconf automake bzip2 docbook-xsl e2fslibs-dev g++ gettext language-pack-de language-pack-en libboost-dev libboost-system-dev libboost-test-dev libboost-thread-dev libbtrfs-dev libdbus-1-dev libjson-c-dev libmount-dev libpam-dev libtool libxml2-dev libz-dev make ncurses-dev xsltproc
 
     - name: List installed packages
       run: apt list --installed | sort
diff --git a/VERSION b/VERSION
index 832bad27..7d87d994 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-0.8.14
+0.8.15
diff --git a/client/GlobalOptions.cc b/client/GlobalOptions.cc
index 06239bc9..a939b12b 100644
--- a/client/GlobalOptions.cc
+++ b/client/GlobalOptions.cc
@@ -43,6 +43,7 @@ namespace snapper
 	    + _("\t--utc\t\t\t\tDisplay dates and times in UTC.") + '\n'
 	    + _("\t--iso\t\t\t\tDisplay dates and times in ISO format.") + '\n'
 	    + _("\t--table-style, -t <style>\tTable style (integer).") + '\n'
+	    + _("\t--abbreviate\t\t\tAllow to abbreviate table columns.") + '\n'
 	    + _("\t--machine-readable <format>\tSet a machine-readable output format (csv, json).") + '\n'
 	    + _("\t--csvout\t\t\tSet CSV output format.") + '\n'
 	    + _("\t--jsonout\t\t\tSet JSON output format.") + '\n'
@@ -64,6 +65,7 @@ namespace snapper
 	    Option("utc",		no_argument),
 	    Option("iso",		no_argument),
 	    Option("table-style",	required_argument,	't'),
+	    Option("abbreviate",	no_argument),
 	    Option("machine-readable",	required_argument),
 	    Option("csvout",		no_argument),
 	    Option("jsonout",		no_argument),
@@ -88,6 +90,7 @@ namespace snapper
 	_version = opts.has_option("version");
 	_help = opts.has_option("help");
 	_table_style = table_style_value(opts);
+	_abbreviate = opts.has_option("abbreviate");
 	_output_format = output_format_value(opts);
 	_separator = separator_value(opts);
 	_config = config_value(opts);
diff --git a/client/GlobalOptions.h b/client/GlobalOptions.h
index 9c953dfd..4694dd63 100644
--- a/client/GlobalOptions.h
+++ b/client/GlobalOptions.h
@@ -53,6 +53,7 @@ namespace snapper
 	bool version() const { return _version; }
 	bool help() const { return _help; }
 	TableStyle table_style() const { return _table_style; }
+	bool abbreviate() const { return _abbreviate; }
 	OutputFormat output_format() const { return _output_format; }
 	string separator() const { return _separator; }
 	string config() const { return _config; }
@@ -80,6 +81,7 @@ namespace snapper
 	bool _version;
 	bool _help;
 	TableStyle _table_style;
+	bool _abbreviate;
 	OutputFormat _output_format;
 	string _separator;
 	string _config;
diff --git a/client/cmd-list.cc b/client/cmd-list.cc
index 9ec872ea..68b32ef8 100644
--- a/client/cmd-list.cc
+++ b/client/cmd-list.cc
@@ -555,6 +555,8 @@ namespace snapper
 				continue;
 
 			    formatter.header().push_back(header_for(list_mode, column));
+			    formatter.abbrev().push_back(global_options.abbreviate() &&
+							 column == Column::DESCRIPTION);
 			}
 
 			for (const ProxySnapshot& snapshot : output_helper.snapshots)
diff --git a/client/utils/Makefile.am b/client/utils/Makefile.am
index 092b3cfd..c55fc4ae 100644
--- a/client/utils/Makefile.am
+++ b/client/utils/Makefile.am
@@ -18,6 +18,5 @@ libutils_la_SOURCES =				\
 	CsvFormatter.cc	    CsvFormatter.h	\
 	JsonFormatter.cc    JsonFormatter.h
 
-
-libutils_la_LIBADD = ../../snapper/libsnapper.la
+libutils_la_LIBADD = ../../snapper/libsnapper.la -ltinfo
 
diff --git a/client/utils/Table.cc b/client/utils/Table.cc
index 7990ae22..659dcc0b 100644
--- a/client/utils/Table.cc
+++ b/client/utils/Table.cc
@@ -130,7 +130,7 @@ Table::Table()
   , _max_width(1, 0)
   , _width(0)
   , _style (Ascii)
-  , _screen_width(get_screen_width())
+  , _screen_width(snapper::get_screen_width())
   , _margin(0)
   , _force_break_after(-1)
   , _do_wrap(false)
@@ -147,14 +147,14 @@ void Table::setHeader (const TableHeader& tr) {
   updateColWidths (tr);
 }
 
-void Table::allowAbbrev(unsigned column) {
-  if (column >= _abbrev_col.size()) {
-    _abbrev_col.reserve(column + 1);
-    _abbrev_col.insert(_abbrev_col.end(), column - _abbrev_col.size() + 1, false);
-  }
-  _abbrev_col[column] = true;
+
+void
+Table::set_abbrev(const vector<bool>& abbrev)
+{
+    _abbrev_col = abbrev;
 }
 
+
 void Table::updateColWidths (const TableRow& tr) {
   // how much columns the separators add to the width of the table
   int sepwidth = _style == none ? 2 : 3;
diff --git a/client/utils/Table.h b/client/utils/Table.h
index b5e1f12b..b2beab17 100644
--- a/client/utils/Table.h
+++ b/client/utils/Table.h
@@ -111,7 +111,7 @@ public:
 
   void set_style(TableStyle st);
   void wrap(int force_break_after = -1);
-  void allowAbbrev(unsigned column);
+  void set_abbrev(const vector<bool>& abbrev);
   void margin(unsigned margin);
 
   Table ();
@@ -164,7 +164,5 @@ ostream& operator << (ostream& stream, const Table& table) {
   table.dumpTo (stream);
   return stream;
 }
-// Local Variables:
-// c-basic-offset: 2
-// End:
+
 #endif
diff --git a/client/utils/TableFormatter.cc b/client/utils/TableFormatter.cc
index b8a756b9..1f61431d 100644
--- a/client/utils/TableFormatter.cc
+++ b/client/utils/TableFormatter.cc
@@ -44,6 +44,7 @@ namespace snapper
 	    table_header.add(column.first, column.second);
 
 	table.setHeader(table_header);
+	table.set_abbrev(table_formatter._abbrev);
 
 	for (const vector<string>& row : table_formatter._rows)
 	{
diff --git a/client/utils/TableFormatter.h b/client/utils/TableFormatter.h
index c1b13663..cca2e045 100644
--- a/client/utils/TableFormatter.h
+++ b/client/utils/TableFormatter.h
@@ -50,6 +50,7 @@ namespace snapper
 	TableFormatter& operator=(const TableFormatter&) = delete;
 
 	vector<pair<string, TableAlign>>& header() { return _header; }
+	vector<bool>& abbrev() { return _abbrev; }
 	vector<vector<string>>& rows() { return _rows; }
 
 	friend ostream& operator<<(ostream& stream, const TableFormatter& table_formatter);
@@ -59,6 +60,7 @@ namespace snapper
 	const TableStyle style;
 
 	vector<pair<string, TableAlign>> _header;
+	vector<bool> _abbrev;
 	vector<vector<string>> _rows;
 
     };
diff --git a/client/utils/console.cc b/client/utils/console.cc
index 32d42721..c0ef53db 100644
--- a/client/utils/console.cc
+++ b/client/utils/console.cc
@@ -9,28 +9,56 @@
  * Miscellaneous console utilities.
  */
 
+
+#include <stdlib.h>
 #include <unistd.h>
-#include <string>
-#include <fstream>
-#include <iostream>
-#include <cstdlib>
+#include <term.h>
 
-using namespace std;
 
-unsigned get_screen_width()
+namespace snapper
 {
-  if (!::isatty(STDOUT_FILENO))
-    return -1; // no clipping
 
-  int width = 80;
 
-  const char *cols_env = getenv("COLUMNS");
-  if (cols_env)
-    width  = ::atoi (cols_env);
+    unsigned
+    get_screen_width_pure()
+    {
+	if (!isatty(STDOUT_FILENO))
+	    return -1; // no clipping
+
+	int width = 0;
+
+	const char* cols_env = getenv("COLUMNS");
+	if (cols_env)
+	{
+	    width = atoi(cols_env);
+	}
+	else
+	{
+	    // use terminfo from ncurses
+	    setupterm(NULL, STDOUT_FILENO, NULL);
+	    width = tigetnum("cols");
+
+	    /*
+	    // use readline
+	    rl_initialize();
+	    rl_get_screen_size(NULL, &width);
+	    */
+	}
+
+	// safe default
+	if (width <= 0)
+	    width = 80;
+
+	return width;
+    }
+
+
+    unsigned
+    get_screen_width()
+    {
+	static unsigned width = get_screen_width_pure();
 
-  // safe default
-  if (!width)
-    width = 80;
+	return width;
+    }
 
-  return width;
 }
diff --git a/client/utils/console.h b/client/utils/console.h
index db7dad66..9c01d634 100644
--- a/client/utils/console.h
+++ b/client/utils/console.h
@@ -9,16 +9,23 @@
  * Miscellaneous console utilities.
  */
 
-#ifndef CONSOLE_H_
-#define CONSOLE_H_
-
-/**
- * Reads COLUMNS environment variable or gets the screen width from readline,
- * in that order. Falls back to 80 if all that fails.
- *
- * \NOTE In case stdout is not connected to a terminal max. unsigned
- * is returned. This should prevent clipping when output is redirected.
- */
-unsigned get_screen_width();
+#ifndef SNAPPER_CONSOLE_H
+#define SNAPPER_CONSOLE_H
+
+
+namespace snapper
+{
+
+    /**
+     * Reads COLUMNS environment variable or gets the screen width from terminfo
+     * or readline, in that order. Falls back to 80 if all that fails.
+     *
+     * \NOTE In case stdout is not connected to a terminal max. unsigned
+     * is returned. This should prevent clipping when output is redirected.
+     */
+    unsigned get_screen_width();
+
+}
+
 
-#endif /* CONSOLE_H_ */
+#endif
diff --git a/dists/debian/changelog b/dists/debian/changelog
index 49a5fce7..8ed4d52a 100644
--- a/dists/debian/changelog
+++ b/dists/debian/changelog
@@ -1,3 +1,9 @@
+snapper (0.8.15) stable; urgency=low
+
+  * Updated to version 0.8.15
+
+ -- Arvin Schnell <aschnell@suse.com>  THu, 17 Dec 2020 10:22:04 +0000
+
 snapper (0.8.14) stable; urgency=low
 
   * Updated to version 0.8.14
diff --git a/dists/debian/snapper-Debian.dsc.in.in b/dists/debian/snapper-Debian.dsc.in.in
index 8c52c0e2..9350cbf5 100644
--- a/dists/debian/snapper-Debian.dsc.in.in
+++ b/dists/debian/snapper-Debian.dsc.in.in
@@ -4,7 +4,7 @@ Version: @VERSION@-1
 Binary: snapper
 Maintainer: Arvin Schnell <aschnell@suse.com>
 Architecture: any
-Build-Depends: debhelper (>= 4.1.16), acl-dev, dbus, g++, libboost-dev, libboost-thread-dev, libboost-system-dev, libboost-test-dev, libxml2-dev, libz-dev, libdbus-1-dev, libjson-c-dev, libpam-dev, xsltproc, docbook-xsl, locales-all
+Build-Depends: debhelper (>= 4.1.16), acl-dev, dbus, g++, libboost-dev, libboost-thread-dev, libboost-system-dev, libboost-test-dev, libxml2-dev, libz-dev, libdbus-1-dev, libjson-c-dev, libpam-dev, xsltproc, docbook-xsl, locales-all, ncurses-dev
 #
 # The 'Files' line is generated during 'make package':
 # Files:
diff --git a/dists/debian/snapper-Raspbian.dsc.in.in b/dists/debian/snapper-Raspbian.dsc.in.in
index 8c52c0e2..9350cbf5 100644
--- a/dists/debian/snapper-Raspbian.dsc.in.in
+++ b/dists/debian/snapper-Raspbian.dsc.in.in
@@ -4,7 +4,7 @@ Version: @VERSION@-1
 Binary: snapper
 Maintainer: Arvin Schnell <aschnell@suse.com>
 Architecture: any
-Build-Depends: debhelper (>= 4.1.16), acl-dev, dbus, g++, libboost-dev, libboost-thread-dev, libboost-system-dev, libboost-test-dev, libxml2-dev, libz-dev, libdbus-1-dev, libjson-c-dev, libpam-dev, xsltproc, docbook-xsl, locales-all
+Build-Depends: debhelper (>= 4.1.16), acl-dev, dbus, g++, libboost-dev, libboost-thread-dev, libboost-system-dev, libboost-test-dev, libxml2-dev, libz-dev, libdbus-1-dev, libjson-c-dev, libpam-dev, xsltproc, docbook-xsl, locales-all, ncurses-dev
 #
 # The 'Files' line is generated during 'make package':
 # Files:
diff --git a/dists/debian/snapper-xUbuntu.dsc.in.in b/dists/debian/snapper-xUbuntu.dsc.in.in
index b01e8ec0..6a25d85c 100644
--- a/dists/debian/snapper-xUbuntu.dsc.in.in
+++ b/dists/debian/snapper-xUbuntu.dsc.in.in
@@ -4,7 +4,7 @@ Version: @VERSION@-1
 Binary: snapper
 Maintainer: Arvin Schnell <aschnell@suse.com>
 Architecture: any
-Build-Depends: debhelper (>= 4.1.16), acl-dev, dbus, g++, libboost-dev, libboost-thread-dev, libboost-system-dev, libboost-test-dev, libxml2-dev, libz-dev, libdbus-1-dev, libjson-c-dev, libpam-dev, xsltproc, docbook-xsl, language-pack-en, language-pack-de
+Build-Depends: debhelper (>= 4.1.16), acl-dev, dbus, g++, libboost-dev, libboost-thread-dev, libboost-system-dev, libboost-test-dev, libxml2-dev, libz-dev, libdbus-1-dev, libjson-c-dev, libpam-dev, xsltproc, docbook-xsl, language-pack-en, language-pack-de, ncurses-dev
 #
 # The 'Files' line is generated during 'make package':
 # Files:
diff --git a/doc/snapper.xml.in b/doc/snapper.xml.in
index 16195fd8..337eae0a 100644
--- a/doc/snapper.xml.in
+++ b/doc/snapper.xml.in
@@ -223,6 +223,12 @@
 	  <para>Specifies table style. Table style is identified by an integer number.</para>
 	</listitem>
       </varlistentry>
+      <varlistentry>
+	<term><option>--abbreviate</option></term>
+	<listitem>
+	  <para>Try to abbreviate texts in some columns so that tables fit the width of the screen.</para>
+	</listitem>
+      </varlistentry>
       <varlistentry>
 	<term><option>--machine-readable <replaceable>format</replaceable></option></term>
 	<listitem>
diff --git a/package/snapper.changes b/package/snapper.changes
index 242f7dde..9235de30 100644
--- a/package/snapper.changes
+++ b/package/snapper.changes
@@ -1,3 +1,10 @@
+-------------------------------------------------------------------
+Thu Dec 17 12:20:59 CET 2020 - aschnell@suse.com
+
+- added option to abbreviate columns in table (see
+  gh#openSUSE/snapper#268)
+- version 0.8.15
+
 -------------------------------------------------------------------
 Fri Dec 04 10:05:05 CET 2020 - aschnell@suse.com
 
diff --git a/snapper.spec.in b/snapper.spec.in
index 20a35018..4e980f26 100644
--- a/snapper.spec.in
+++ b/snapper.spec.in
@@ -41,6 +41,7 @@ BuildRequires:  libacl-devel
 BuildRequires:  libtool
 BuildRequires:  libxml2-devel
 BuildRequires:  e2fsprogs-devel
+BuildRequires:  ncurses-devel
 %if 0%{?suse_version} > 1230
 BuildRequires:  libbtrfs-devel
 %endif