Refactor naming and usage of CLI commands

- Rename and alter the description of some command line options
  according to validation results from task QTIFW-1635. The
  suggested additions are not added in this change.
- Remove options "framework-version" and "silentUpdate", these
  should not be needed anymore.
- Combine options "installPackages" and "installDefault" into
  single "install" command.

- Change command line syntax from "binary [options]" to
  "binary [options] command <arguments>".
- Re-order & group known option variables and "--help" printing
  order based on their topic.
- Move CommandLineParser class files under src/libs/installer
  and add private class for future options extension.

Short versions of command line options should be added in a
follow-up commit.

Task-number: QTIFW-1671
Change-Id: Ie0d393368b5275c8ffa1ab8833885b149af3178e
Reviewed-by: Katja Marttila <katja.marttila@qt.io>

1 files changed, 170 insertions, 0 deletions

diff --git a/src/libs/installer/commandlineparser.cpp b/src/libs/installer/commandlineparser.cpp
new file mode 100644
index 000000000..0a5ce94de
--- /dev/null
+++ b/src/libs/installer/commandlineparser.cpp
@@ -0,0 +1,170 @@
+/**************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt Installer Framework.
+**
+** $QT_BEGIN_LICENSE:GPL-EXCEPT$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+**************************************************************************/
+
+#include "commandlineparser.h"
+
+#include "constants.h"
+#include "globals.h"
+
+namespace CommandLineOptions {
+
+const char Command[] = "Command";
+const char Arguments[] = "Args";
+const char InstallerValue[] = "InstallerValue";
+
+} // namespace CommandLineOptions
+
+CommandLineParser::CommandLineParser()
+    : d(new CommandLineParserPrivate())
+{
+    static const QString preformatted = QLatin1String("\nCommands:\n")
+        + QString::fromLatin1("\t%1 - install default or selected packages - <pkg1 pkg2 pkg3...>\n")
+            .arg(QLatin1String(CommandLineOptions::Install))
+        + QString::fromLatin1("\t%1 - show available updates information on maintenance tool\n")
+            .arg(QLatin1String(CommandLineOptions::CheckUpdates))
+        + QString::fromLatin1("\t%1 - update all or selected packages - <pkg1 pkg2 pkg3...>\n")
+            .arg(QLatin1String(CommandLineOptions::Update))
+        + QString::fromLatin1("\t%1 - uninstall packages and their child components - <pkg1 pkg2 pkg3...>\n")
+            .arg(QLatin1String(CommandLineOptions::Remove))
+        + QString::fromLatin1("\t%1 - list currently installed packages\n")
+            .arg(QLatin1String(CommandLineOptions::List))
+        + QString::fromLatin1("\t%1 - search available packages - <regexp>")
+            .arg(QLatin1String(CommandLineOptions::Search));
+
+    m_parser.setApplicationDescription(preformatted);
+
+    // Help & version information
+    m_parser.addHelpOption();
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::Version),
+        QLatin1String("Displays version information.")));
+
+    // Output related options
+    m_parser.addOption(QCommandLineOption(QStringList()
+        << QLatin1String(CommandLineOptions::VerboseShort)
+        << QLatin1String(CommandLineOptions::VerboseLong),
+        QLatin1String("Verbose mode. Prints out more information.")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::LoggingRules),
+        QLatin1String("Enables logging according to passed rules. Comma separated logging rules "
+                      "have the following syntax: loggingCategory=true/false. Passing empty logging "
+                      "rules enables all logging categories. The following rules enable a single "
+                      "category: ifw.*=false, ifw.category=true. The following logging categories "
+                      "are available:\n") + QInstaller::loggingCategories().join(QLatin1Char('\n')),
+        QLatin1String("rules")));
+
+    // Repository management options
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::AddRepository),
+        QLatin1String("Add a local or remote repository to the list of user defined repositories."),
+        QLatin1String("URI,...")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::AddTmpRepository),
+        QLatin1String("Add a local or remote repository to the list of temporary available repositories."),
+        QLatin1String("URI,...")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::SetTmpRepository),
+        QLatin1String("Set a local or remote repository as temporary repository, it is the only "
+                      "one used during fetch.\nNote: URI must be prefixed with the protocol, i.e. "
+                      "file:///, https://, http:// or ftp://."),
+        QLatin1String("URI,...")));
+
+    // Proxy options
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::SystemProxy),
+        QLatin1String("Use system proxy on Windows and Linux. This option has no effect on macOS. (Default)")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::NoProxy),
+        QLatin1String("Do not use system proxy.")));
+
+    // Starting mode options
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::StartUpdater),
+        QLatin1String("Start application in updater mode. This will override the internal "
+                      "marker that is used to distinguish which kind of binary is currently running.")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::StartPackageManager),
+        QLatin1String("Start application in package manager mode. This will override the internal "
+                      "marker that is used to distinguish which kind of binary is currently running.")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::StartUninstaller),
+        QLatin1String("Start application in uninstaller mode. This will override the internal "
+                      "marker that is used to distinguish which kind of binary is currently running.")));
+
+    // Misc installation options
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::Root),
+        QLatin1String("Set installation root directory."),
+        QLatin1String("directory")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::Platform),
+        QLatin1String("Use the specified platform plugin."),
+        QLatin1String("plugin")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::NoForceInstallation),
+        QLatin1String("Allow deselecting components that are marked as forced.")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::NoSizeChecking),
+        QLatin1String("Disable checking of free space for installation target.")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::ShowVirtualComponents),
+        QLatin1String("Show virtual components in installer and package manager.")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::InstallCompressedRepository),
+        QLatin1String("Installs QBSP or 7z file. The QBSP (Board Support Package) file must be a .7z "
+                      "file which contains a valid repository."),
+        QLatin1String("URI,...")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::CreateLocalRepository),
+        QLatin1String("Create a local repository inside the installation directory. This option "
+                      "has no effect on online installers.")));
+
+    // Developer options
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::Script),
+        QLatin1String("Execute the script given as argument."),
+        QLatin1String("file")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::StartServer),
+        QLatin1String("Starts the application as headless process waiting for commands to execute. Mode "
+                      "can be DEBUG or PRODUCTION. In DEBUG mode, the option values can be omitted. Note: "
+                      "The server will not shutdown on his own, you need to quit the process by hand."),
+        QLatin1String("mode, socketname, key")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::StartClient),
+        QLatin1String("Starts the application to debug the client-server communication. If a value is "
+                      "omitted, the client will use a default instead. Note: The server process is not "
+                      "started by the client application in that case, you need to start it on your own."),
+        QLatin1String("socketname, key")));
+    m_parser.addOption(QCommandLineOption(QLatin1String(CommandLineOptions::SquishPort),
+        QLatin1String("Give a port where Squish can connect to. If no port is given, default port 11233 is "
+                      "used. Note: To enable Squish support you first need to build IFW with SQUISH_PATH "
+                      "parameter where SQUISH_PATH is pointing to your Squish installation folder: "
+                      "<path_to_qt>/bin/qmake -r SQUISH_PATH=<pat_to_squish>"),
+        QLatin1String("port number")));
+
+    // Custom extension options
+    m_parser.addOptions(d->extensionsOptions());
+
+    // Positional arguments
+    m_parser.addPositionalArgument(QLatin1String(CommandLineOptions::Command),
+        QLatin1String("Command to be run by installer."),
+        QLatin1String("command"));
+    m_parser.addPositionalArgument(QLatin1String(CommandLineOptions::Arguments),
+        QLatin1String("Extra arguments for command, each separated by space."),
+        QLatin1String("<args>"));
+    m_parser.addPositionalArgument(QLatin1String(CommandLineOptions::InstallerValue),
+        QLatin1String("Key-value pair to be set internally by the framework."),
+        QLatin1String("<key=value>"));
+
+}
+
+CommandLineParser::~CommandLineParser()
+{
+    delete d;
+}