mirror of
https://github.com/keepassxreboot/keepassxc.git
synced 2025-08-10 15:30:34 -04:00
CLI: Export database as CSV
* Changed `Extract` to `Export` to support additional formats * Allow database expot as CSV. Added a `--format` option to the `Export` command for that, which defaults to xml, so the current behavior is unchanged. *The `CsvExporter` had to be refactored a bit, but nothing major. It can now print to a file or return a string.
This commit is contained in:
parent
547c246e88
commit
77fcde875e
11 changed files with 157 additions and 89 deletions
|
@ -23,7 +23,7 @@ set(cli_SOURCES
|
|||
Diceware.cpp
|
||||
Edit.cpp
|
||||
Estimate.cpp
|
||||
Extract.cpp
|
||||
Export.cpp
|
||||
Generate.cpp
|
||||
List.cpp
|
||||
Locate.cpp
|
||||
|
|
|
@ -29,7 +29,7 @@
|
|||
#include "Diceware.h"
|
||||
#include "Edit.h"
|
||||
#include "Estimate.h"
|
||||
#include "Extract.h"
|
||||
#include "Export.h"
|
||||
#include "Generate.h"
|
||||
#include "List.h"
|
||||
#include "Locate.h"
|
||||
|
@ -114,7 +114,7 @@ void populateCommands()
|
|||
commands.insert(QString("diceware"), new Diceware());
|
||||
commands.insert(QString("edit"), new Edit());
|
||||
commands.insert(QString("estimate"), new Estimate());
|
||||
commands.insert(QString("extract"), new Extract());
|
||||
commands.insert(QString("export"), new Export());
|
||||
commands.insert(QString("generate"), new Generate());
|
||||
commands.insert(QString("locate"), new Locate());
|
||||
commands.insert(QString("ls"), new List());
|
||||
|
|
65
src/cli/Export.cpp
Normal file
65
src/cli/Export.cpp
Normal file
|
@ -0,0 +1,65 @@
|
|||
/*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
#include <cstdlib>
|
||||
#include <stdio.h>
|
||||
|
||||
#include "Export.h"
|
||||
|
||||
#include "cli/TextStream.h"
|
||||
#include "cli/Utils.h"
|
||||
#include "core/Database.h"
|
||||
#include "format/CsvExporter.h"
|
||||
|
||||
const QCommandLineOption Export::FormatOption =
|
||||
QCommandLineOption(QStringList() << "f"
|
||||
<< "format",
|
||||
QObject::tr("Format to use when exporting. Available choices are xml or csv. Defaults to xml."),
|
||||
QObject::tr("xml|csv"));
|
||||
|
||||
Export::Export()
|
||||
{
|
||||
name = QString("export");
|
||||
options.append(Export::FormatOption);
|
||||
description = QObject::tr("Exports the content of a database to standard output in the specified format.");
|
||||
}
|
||||
|
||||
|
||||
int Export::executeWithDatabase(QSharedPointer<Database> database, QSharedPointer<QCommandLineParser> parser)
|
||||
{
|
||||
TextStream outputTextStream(Utils::STDOUT, QIODevice::WriteOnly);
|
||||
TextStream errorTextStream(Utils::STDERR, QIODevice::WriteOnly);
|
||||
|
||||
QString format = parser->value(Export::FormatOption);
|
||||
if (format.isEmpty() || format == QString("xml")) {
|
||||
QByteArray xmlData;
|
||||
QString errorMessage;
|
||||
if (!database->extract(xmlData, &errorMessage)) {
|
||||
errorTextStream << QObject::tr("Unable to export database to XML: %1").arg(errorMessage) << endl;
|
||||
return EXIT_FAILURE;
|
||||
}
|
||||
outputTextStream << xmlData.constData() << endl;
|
||||
} else if (format == QString("csv")) {
|
||||
CsvExporter csvExporter;
|
||||
outputTextStream << csvExporter.exportDatabase(database);
|
||||
} else {
|
||||
errorTextStream << QObject::tr("Unsupported format %1").arg(format) << endl;
|
||||
return EXIT_FAILURE;
|
||||
}
|
||||
|
||||
return EXIT_SUCCESS;
|
||||
}
|
|
@ -15,17 +15,19 @@
|
|||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#ifndef KEEPASSXC_EXTRACT_H
|
||||
#define KEEPASSXC_EXTRACT_H
|
||||
#ifndef KEEPASSXC_EXPORT_H
|
||||
#define KEEPASSXC_EXPORT_H
|
||||
|
||||
#include "DatabaseCommand.h"
|
||||
|
||||
class Extract : public DatabaseCommand
|
||||
class Export : public DatabaseCommand
|
||||
{
|
||||
public:
|
||||
Extract();
|
||||
Export();
|
||||
|
||||
int executeWithDatabase(QSharedPointer<Database> db, QSharedPointer<QCommandLineParser> parser) override;
|
||||
|
||||
static const QCommandLineOption FormatOption;
|
||||
};
|
||||
|
||||
#endif // KEEPASSXC_EXTRACT_H
|
||||
#endif // KEEPASSXC_EXPORT_H
|
|
@ -1,46 +0,0 @@
|
|||
/*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
#include <cstdlib>
|
||||
#include <stdio.h>
|
||||
|
||||
#include "Extract.h"
|
||||
|
||||
#include "cli/TextStream.h"
|
||||
#include "cli/Utils.h"
|
||||
#include "core/Database.h"
|
||||
|
||||
Extract::Extract()
|
||||
{
|
||||
name = QString("extract");
|
||||
description = QObject::tr("Extract and print the content of a database.");
|
||||
}
|
||||
|
||||
int Extract::executeWithDatabase(QSharedPointer<Database> database, QSharedPointer<QCommandLineParser>)
|
||||
{
|
||||
TextStream outputTextStream(Utils::STDOUT, QIODevice::WriteOnly);
|
||||
TextStream errorTextStream(Utils::STDERR, QIODevice::WriteOnly);
|
||||
|
||||
QByteArray xmlData;
|
||||
QString errorMessage;
|
||||
if (!database->extract(xmlData, &errorMessage)) {
|
||||
errorTextStream << QObject::tr("Unable to extract database %1").arg(errorMessage) << endl;
|
||||
return EXIT_FAILURE;
|
||||
}
|
||||
outputTextStream << xmlData.constData() << endl;
|
||||
return EXIT_SUCCESS;
|
||||
}
|
|
@ -36,8 +36,8 @@ The same password generation options as documented for the generate command can
|
|||
.IP "estimate [options] [password]"
|
||||
Estimates the entropy of a password. The password to estimate can be provided as a positional argument, or using the standard input.
|
||||
|
||||
.IP "extract [options] <database>"
|
||||
Extracts and prints the contents of a database to standard output in XML format.
|
||||
.IP "export [options] <database>"
|
||||
Exports the content of a database to standard output in the specified format (defaults to XML).
|
||||
|
||||
.IP "generate [options]"
|
||||
Generate a random password.
|
||||
|
@ -164,6 +164,12 @@ otherwise the program will fail. If the wordlist has < 4000 words a warning will
|
|||
be printed to STDERR.
|
||||
|
||||
|
||||
.SS "Export options"
|
||||
|
||||
.IP "-f, --format"
|
||||
Format to use when exporting. Available choices are xml or csv. Defaults to xml.
|
||||
|
||||
|
||||
.SS "List options"
|
||||
|
||||
.IP "-R, --recursive"
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue