b1eda37cca
This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
71 lines
2.1 KiB
C++
71 lines
2.1 KiB
C++
/*
|
|
* Copyright (C) 2019 KeePassXC Team <team@keepassxc.org>
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 or (at your option)
|
|
* version 3 of the License.
|
|
*
|
|
* 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, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef KEEPASSXC_COMMAND_H
|
|
#define KEEPASSXC_COMMAND_H
|
|
|
|
#include <QCommandLineOption>
|
|
#include <QCommandLineParser>
|
|
#include <QList>
|
|
#include <QObject>
|
|
#include <QString>
|
|
#include <QStringList>
|
|
|
|
#include "core/Database.h"
|
|
|
|
// At the moment, there's no QT class for the positional arguments
|
|
// like there is for the options (QCommandLineOption).
|
|
struct CommandLineArgument
|
|
{
|
|
QString name;
|
|
QString description;
|
|
QString syntax;
|
|
};
|
|
|
|
class Command
|
|
{
|
|
public:
|
|
Command();
|
|
virtual ~Command();
|
|
virtual int execute(const QStringList& arguments) = 0;
|
|
QString name;
|
|
QString description;
|
|
QSharedPointer<Database> currentDatabase;
|
|
QList<CommandLineArgument> positionalArguments;
|
|
QList<CommandLineArgument> optionalArguments;
|
|
QList<QCommandLineOption> options;
|
|
|
|
QString getDescriptionLine();
|
|
QSharedPointer<QCommandLineParser> getCommandLineParser(const QStringList& arguments);
|
|
QString getHelpText();
|
|
|
|
static const QCommandLineOption HelpOption;
|
|
static const QCommandLineOption QuietOption;
|
|
static const QCommandLineOption KeyFileOption;
|
|
static const QCommandLineOption NoPasswordOption;
|
|
static const QCommandLineOption YubiKeyOption;
|
|
};
|
|
|
|
namespace Commands
|
|
{
|
|
void setupCommands(bool interactive);
|
|
QList<QSharedPointer<Command>> getCommands();
|
|
QSharedPointer<Command> getCommand(const QString& commandName);
|
|
} // namespace Commands
|
|
|
|
#endif // KEEPASSXC_COMMAND_H
|