From: José Iván López González <jlopez@suse.com>
Date: Wed, 30 Oct 2019 23:12:29 +0000 (+0000)
Subject: Add Command base class
X-Git-Tag: v0.8.6~10^2~12
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=bcbd95f27f5a3dff755c4c77162d5576a2fa15a8;p=thirdparty%2Fsnapper.git

Add Command base class
---

diff --git a/client/Command.cc b/client/Command.cc
new file mode 100644
index 00000000..16afbb30
--- /dev/null
+++ b/client/Command.cc
@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) [2019] SUSE LLC
+ *
+ * All Rights Reserved.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of version 2 of the GNU General Public License as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, contact Novell, Inc.
+ *
+ * To contact Novell about this file by physical or electronic mail, you may
+ * find current contact information at www.novell.com.
+ */
+
+#include "client/Command.h"
+
+using namespace std;
+
+namespace snapper
+{
+    namespace cli
+    {
+
+	Command::Command(const GlobalOptions& global_options, GetOpts& options_parser,
+	    ProxySnappers& snappers) :
+	    _options_parser(options_parser), _global_options(global_options), _snappers(snappers)
+	{}
+
+
+	bool Command::has_errors() const
+	{
+	    return !errors().empty();
+	}
+
+
+	Command::~Command()
+	{}
+
+    }
+}
diff --git a/client/Command.h b/client/Command.h
new file mode 100644
index 00000000..9ce77600
--- /dev/null
+++ b/client/Command.h
@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) [2019] SUSE LLC
+ *
+ * All Rights Reserved.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of version 2 of the GNU General Public License as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, contact Novell, Inc.
+ *
+ * To contact Novell about this file by physical or electronic mail, you may
+ * find current contact information at www.novell.com.
+ */
+
+#ifndef SNAPPER_CLI_COMMAND_H
+#define SNAPPER_CLI_COMMAND_H
+
+#include <string>
+#include <vector>
+
+#include "client/GlobalOptions.h"
+#include "client/proxy.h"
+#include "client/utils/GetOpts.h"
+#include "client/utils/Table.h"
+
+namespace snapper
+{
+    namespace cli
+    {
+
+	class Command
+	{
+
+	public:
+
+	    class ColumnsOption;
+
+	    class GetConfig;
+
+	    class ListConfigs;
+
+	    class ListSnapshots;
+
+	    Command(const GlobalOptions& global_options, GetOpts& options_parser,
+		ProxySnappers& snappers);
+
+	    const GlobalOptions& global_options() const
+	    {
+		return _global_options;
+	    }
+
+	    ProxySnappers& snappers() const
+	    {
+		return _snappers;
+	    }
+
+	    virtual bool has_errors() const;
+
+	    virtual std::vector<std::string> errors() const = 0;
+
+	    virtual void run() = 0;
+
+	    virtual ~Command();
+
+	protected:
+
+	    GetOpts& _options_parser;
+
+	private:
+
+	    const GlobalOptions& _global_options;
+
+	    ProxySnappers& _snappers;
+
+	};
+
+    }
+}
+
+#endif
diff --git a/client/GlobalOptions.cc b/client/GlobalOptions.cc
new file mode 100644
index 00000000..7a168ac3
--- /dev/null
+++ b/client/GlobalOptions.cc
@@ -0,0 +1,248 @@
+/*
+ * Copyright (c) [2019] SUSE LLC
+ *
+ * All Rights Reserved.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of version 2 of the GNU General Public License as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, contact Novell, Inc.
+ *
+ * To contact Novell about this file by physical or electronic mail, you may
+ * find current contact information at www.novell.com.
+ */
+
+#include <snapper/AppUtil.h>
+
+#include "client/GlobalOptions.h"
+#include "client/utils/text.h"
+#include "client/utils/TableFormatter.h"
+#include "client/utils/CsvFormatter.h"
+
+using namespace std;
+
+namespace snapper
+{
+    namespace cli
+    {
+
+	namespace
+	{
+
+	    const string CSV_OPTION = "csv";
+
+	    const string JSON_OPTION = "json";
+
+	    const string DEFAULT_CONFIG = "root";
+
+	    const string DEFAULT_ROOT = "/";
+
+	    const option OPTIONS[15] = {
+		{ "quiet",		no_argument,		0,	'q' },
+		{ "verbose",		no_argument,		0,	'v' },
+		{ "utc",		no_argument,		0,	0 },
+		{ "iso",		no_argument,		0,	0 },
+		{ "table-style",	required_argument,	0,	't' },
+		{ "machine-readable",	required_argument,	0,	0},
+		{ "csvout",		no_argument,		0,	0},
+		{ "jsonout",		no_argument,		0,	0},
+		{ "separator",		required_argument,	0,	0},
+		{ "config",		required_argument,	0,	'c' },
+		{ "no-dbus",		no_argument,		0,	0 },
+		{ "root",		required_argument,	0,	'r' },
+		{ "version",		no_argument,		0,	0 },
+		{ "help",		no_argument,		0,	'h' },
+		{ 0, 0, 0, 0 }
+	    };
+
+	}
+
+
+	string GlobalOptions::help_text()
+	{
+	    return string(_("    Global options:")) + '\n'
+		+ _("\t--quiet, -q\t\t\tSuppress normal output.") + '\n'
+		+ _("\t--verbose, -v\t\t\tIncrease verbosity.") + '\n'
+		+ _("\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--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'
+		+ _("\t--separator <separator>\t\tCharacter separator for CSV output format.") + '\n'
+		+ _("\t--config, -c <name>\t\tSet name of config to use.") + '\n'
+		+ _("\t--no-dbus\t\t\tOperate without DBus.") + '\n'
+		+ _("\t--root, -r <path>\t\tOperate on target root (works only without DBus).") + '\n'
+		+ _("\t--version\t\t\tPrint version and exit.") + '\n';
+	}
+
+
+	GlobalOptions::GlobalOptions(GetOpts& parser) :
+	    Options(parser)
+	{
+	    parse_options();
+
+	    _quiet = has_option("quiet");
+	    _verbose = has_option("verbose");
+	    _utc = has_option("utc");
+	    _iso = has_option("iso");
+	    _no_dbus = has_option("no-dbus");
+	    _version = has_option("version");
+	    _help = has_option("help");
+	    _table_style = table_style_value();
+	    _output_format = output_format_value();
+	    _separator = separator_value();
+	    _config = config_value();
+	    _root = root_value();
+	}
+
+
+	void GlobalOptions::parse_options()
+	{
+	    _options = _parser.parse(OPTIONS);
+	}
+
+
+	vector<string> GlobalOptions::errors() const
+	{
+	    vector<string> detected_errors;
+
+	    if (wrong_table_style())
+		detected_errors.push_back(table_style_error());
+
+	    if (wrong_machine_readable())
+		detected_errors.push_back(machine_readable_error());
+
+	    if (missing_no_dbus())
+		detected_errors.push_back(missing_no_dbus_error());
+
+	    return detected_errors;
+	}
+
+
+	TableLineStyle GlobalOptions::table_style_value() const
+	{
+	    if (has_option("table-style") && !wrong_table_style())
+		return (TableLineStyle) table_style_raw();
+
+	    return TableFormatter::default_style();
+	}
+
+
+	GlobalOptions::OutputFormat GlobalOptions::output_format_value() const
+	{
+	    if (has_option("csvout") || machine_readable_value() == CSV_OPTION)
+		return OutputFormat::CSV;
+
+	    if (has_option("jsonout") || machine_readable_value() == JSON_OPTION)
+		return OutputFormat::JSON;
+
+	    return OutputFormat::TABLE;
+	}
+
+
+	string GlobalOptions::machine_readable_value() const
+	{
+	    if (has_option("machine-readable"))
+		return get_option("machine-readable")->second;
+
+	    return "";
+	}
+
+
+	string GlobalOptions::separator_value() const
+	{
+	    if (has_option("separator"))
+		return get_option("separator")->second;
+
+	    return CsvFormatter::default_separator();
+	}
+
+
+	string GlobalOptions::config_value() const
+	{
+	    if (has_option("config"))
+		return get_option("config")->second;
+
+	    return DEFAULT_CONFIG;
+	}
+
+
+	string GlobalOptions::root_value() const
+	{
+	    if (has_option("root"))
+		return get_option("root")->second;
+
+	    return DEFAULT_ROOT;
+	}
+
+
+	unsigned int GlobalOptions::table_style_raw() const
+	{
+	    return stoul(get_option("table-style")->second);
+	}
+
+
+	bool GlobalOptions::wrong_table_style() const
+	{
+	    if (!has_option("table-style"))
+		return false;
+
+	    if (table_style_raw() >= Table::numStyles)
+		return true;
+
+	    return false;
+	}
+
+
+	bool GlobalOptions::wrong_machine_readable() const
+	{
+	    if (!has_option("machine-readable"))
+		return false;
+
+	    string value = machine_readable_value();
+
+	    if (value != CSV_OPTION && value != JSON_OPTION)
+		return true;
+
+	    return false;
+	}
+
+
+	bool GlobalOptions::missing_no_dbus() const
+	{
+	    return has_option("root") && !has_option("no-dbus");
+	}
+
+
+	string GlobalOptions::table_style_error() const
+	{
+	    return sformat(_("Invalid table style %d."), table_style_raw()) + " " +
+		   sformat(_("Use an integer number from %d to %d."), 0, Table::numStyles - 1);
+	}
+
+
+	string GlobalOptions::machine_readable_error() const
+	{
+	    string format = machine_readable_value();
+
+	    return sformat(_("Invalid machine readable format %s."), format.c_str()) + " " +
+		   sformat(_("Use %s or %s."), CSV_OPTION.c_str(), JSON_OPTION.c_str());
+	}
+
+
+	string GlobalOptions::missing_no_dbus_error() const
+	{
+	    return _("root argument can be used only together with no-dbus.\n"
+		     "Try 'snapper --help' for more information.");
+	}
+
+    }
+}
diff --git a/client/GlobalOptions.h b/client/GlobalOptions.h
new file mode 100644
index 00000000..89c16b94
--- /dev/null
+++ b/client/GlobalOptions.h
@@ -0,0 +1,169 @@
+/*
+ * Copyright (c) [2019] SUSE LLC
+ *
+ * All Rights Reserved.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of version 2 of the GNU General Public License as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, contact Novell, Inc.
+ *
+ * To contact Novell about this file by physical or electronic mail, you may
+ * find current contact information at www.novell.com.
+ */
+
+#ifndef SNAPPER_CLI_GLOBAL_OPTIONS_H
+#define SNAPPER_CLI_GLOBAL_OPTIONS_H
+
+#include <string>
+
+#include "client/Options.h"
+#include "client/utils/GetOpts.h"
+#include "client/utils/Table.h"
+
+namespace snapper
+{
+    namespace cli
+    {
+
+	class GlobalOptions : public Options
+	{
+
+	public:
+
+	    enum OutputFormat { TABLE, CSV, JSON };
+
+	    static std::string help_text();
+
+	    GlobalOptions(GetOpts& parser);
+
+	    virtual std::vector<std::string> errors() const override;
+
+	    bool quiet() const
+	    {
+		return _quiet;
+	    }
+
+	    bool verbose() const
+	    {
+		return _verbose;
+	    }
+
+	    bool utc() const
+	    {
+		return _utc;
+	    }
+
+	    bool iso() const
+	    {
+		return _iso;
+	    }
+
+	    bool no_dbus() const
+	    {
+		return _no_dbus;
+	    }
+
+	    bool version() const
+	    {
+		return _version;
+	    }
+
+	    bool help() const
+	    {
+		return _help;
+	    }
+
+	    TableLineStyle table_style() const
+	    {
+		return _table_style;
+	    }
+
+	    OutputFormat output_format() const
+	    {
+		return _output_format;
+	    }
+
+	    string separator() const
+	    {
+		return _separator;
+	    }
+
+	    string config() const
+	    {
+		return _config;
+	    }
+
+
+	    string root() const
+	    {
+		return _root;
+	    }
+
+	private:
+
+	    void parse_options();
+
+	    TableLineStyle table_style_value() const;
+
+	    OutputFormat output_format_value() const;
+
+	    std::string machine_readable_value() const;
+
+	    std::string separator_value() const;
+
+	    std::string config_value() const;
+
+	    std::string root_value() const;
+
+	    unsigned int table_style_raw() const;
+
+	    bool wrong_table_style() const;
+
+	    bool wrong_machine_readable() const;
+
+	    bool missing_no_dbus() const;
+
+	    std::string table_style_error() const;
+
+	    std::string machine_readable_error() const;
+
+	    std::string missing_no_dbus_error() const;
+
+	    bool _quiet;
+
+	    bool _verbose;
+
+	    bool _utc;
+
+	    bool _iso;
+
+	    bool _no_dbus;
+
+	    bool _version;
+
+	    bool _help;
+
+	    TableLineStyle _table_style;
+
+	    OutputFormat _output_format;
+
+	    string _separator;
+
+	    string _config;
+
+	    string _root;
+
+	};
+
+    }
+}
+
+#endif
\ No newline at end of file
diff --git a/client/Makefile.am b/client/Makefile.am
index e8f9a5eb..46ce46c4 100644
--- a/client/Makefile.am
+++ b/client/Makefile.am
@@ -2,24 +2,33 @@
 # Makefile.am for snapper/client
 #
 
-SUBDIRS = utils
+SUBDIRS = 		\
+	utils		\
+	Command
 
 AM_CPPFLAGS = -I$(top_srcdir) $(DBUS_CFLAGS)
 
 bin_PROGRAMS = snapper
 
-snapper_SOURCES =			\
-	snapper.cc			\
-	types.cc	types.h		\
-	commands.cc	commands.h	\
-	cleanup.cc	cleanup.h	\
-	proxy.cc	proxy.h		\
-	proxy-dbus.cc	proxy-dbus.h	\
-	proxy-lib.cc	proxy-lib.h	\
-	misc.cc		misc.h		\
-	errors.cc	errors.h
-
-snapper_LDADD = ../snapper/libsnapper.la utils/libutils.la ../dbus/libdbus.la
+snapper_SOURCES =					\
+	snapper.cc					\
+	types.cc		types.h			\
+	commands.cc		commands.h		\
+	cleanup.cc		cleanup.h		\
+	proxy.cc		proxy.h			\
+	proxy-dbus.cc		proxy-dbus.h		\
+	proxy-lib.cc		proxy-lib.h		\
+	misc.cc			misc.h			\
+	errors.cc		errors.h		\
+	Options.cc		Options.h		\
+	GlobalOptions.cc	GlobalOptions.h		\
+	Command.cc		Command.h
+
+snapper_LDADD = 			\
+	../snapper/libsnapper.la	\
+	utils/libutils.la		\
+	Command/libcommand.la		\
+	../dbus/libdbus.la
 
 libexecdir = /usr/lib/snapper
 
diff --git a/client/Options.cc b/client/Options.cc
new file mode 100644
index 00000000..0f2f4449
--- /dev/null
+++ b/client/Options.cc
@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) [2019] SUSE LLC
+ *
+ * All Rights Reserved.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of version 2 of the GNU General Public License as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, contact Novell, Inc.
+ *
+ * To contact Novell about this file by physical or electronic mail, you may
+ * find current contact information at www.novell.com.
+ */
+
+#include <string>
+
+#include "client/Options.h"
+#include "client/utils/text.h"
+
+using namespace std;
+
+namespace snapper
+{
+    namespace cli
+    {
+
+	Options::Options(GetOpts& parser) :
+	    _parser(parser), _options()
+	{}
+
+
+	Options::~Options()
+	{}
+
+
+	bool Options::has_option(const string option_name) const
+	{
+	    GetOpts::parsed_opts::const_iterator option = get_option(option_name);
+
+	    return option != _options.end();
+	}
+
+
+	GetOpts::parsed_opts::const_iterator
+	Options::get_option(const string option_name) const
+	{
+	    return _options.find(option_name);
+	}
+
+
+	bool Options::has_errors() const
+	{
+	    return !errors().empty();
+	}
+
+    }
+}
diff --git a/client/Options.h b/client/Options.h
new file mode 100644
index 00000000..10bfe1dd
--- /dev/null
+++ b/client/Options.h
@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) [2019] SUSE LLC
+ *
+ * All Rights Reserved.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of version 2 of the GNU General Public License as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, contact Novell, Inc.
+ *
+ * To contact Novell about this file by physical or electronic mail, you may
+ * find current contact information at www.novell.com.
+ */
+
+#ifndef SNAPPER_CLI_OPTIONS_H
+#define SNAPPER_CLI_OPTIONS_H
+
+#include <string>
+#include <vector>
+
+#include "client/utils/GetOpts.h"
+
+namespace snapper
+{
+    namespace cli
+    {
+
+	class Options
+	{
+
+	public:
+
+	    Options(GetOpts& parser);
+
+	    virtual bool has_errors() const;
+
+	    virtual std::vector<std::string> errors() const = 0;
+
+	    virtual ~Options();
+
+	protected:
+
+	    bool has_option(const std::string option_name) const;
+
+	    GetOpts::parsed_opts::const_iterator
+	    get_option(const std::string option_name) const;
+
+	    GetOpts& _parser;
+
+	    GetOpts::parsed_opts _options;
+
+	};
+
+    }
+}
+
+#endif
\ No newline at end of file
diff --git a/client/utils/GetOpts.h b/client/utils/GetOpts.h
index 78154af6..56de143e 100644
--- a/client/utils/GetOpts.h
+++ b/client/utils/GetOpts.h
@@ -1,3 +1,5 @@
+#ifndef GET_OPTS_H
+#define GET_OPTS_H
 
 #include <getopt.h>
 #include <string>
@@ -42,3 +44,4 @@ private:
 
 };
 
+#endif