Qt: Add support for EncryptJobs with generic flags

* lang/qt/src/encryptjob.h, lang/qt/src/signencryptjob.h,
lang/qt/src/qgpgmeencryptjob.h, lang/qt/src/qgpgmeencryptjob.cpp,
lang/qt/src/qgpgmesignencryptjob.cpp,
lang/qt/src/qgpgmeencryptjob.cpp: Add start and exec overloads
that accept generic EncryptFlags.

--
While this technically is an ABI break (vtable change) there
are no known classes outside qgpgme that inherit encryptjob
or signencryptjob. And the new functions should be added
to the bottom of the vtable.
This commit is contained in:
Andre Heinecke 2016-08-09 13:10:08 +02:00
parent 1737239379
commit 34b456c3fb
6 changed files with 100 additions and 22 deletions

View File

@ -39,6 +39,12 @@
#include <memory> #include <memory>
#include <vector> #include <vector>
#ifdef BUILDING_QGPGME
# include "context.h"
#else
# include <gpgme++/context.h>
#endif
class QByteArray; class QByteArray;
class QIODevice; class QIODevice;
@ -103,13 +109,24 @@ public:
virtual GpgME::EncryptionResult exec(const std::vector<GpgME::Key> &recipients, virtual GpgME::EncryptionResult exec(const std::vector<GpgME::Key> &recipients,
const QByteArray &plainText, const QByteArray &plainText,
bool alwaysTrust, QByteArray &cipherText) = 0; bool alwaysTrust, QByteArray &cipherText) = 0;
/*! /*!
This is a hack to request BASE64 output (instead of whatever This is a hack to request BASE64 output (instead of whatever
comes out normally). comes out normally).
*/ */
virtual void setOutputIsBase64Encoded(bool) = 0; virtual void setOutputIsBase64Encoded(bool) = 0;
/** Like start but with an additional argument for EncryptionFlags for
* more flexibility. */
virtual void start(const std::vector<GpgME::Key> &recipients,
const std::shared_ptr<QIODevice> &plainText,
const std::shared_ptr<QIODevice> &cipherText = std::shared_ptr<QIODevice>(),
const GpgME::Context::EncryptionFlags flags = GpgME::Context::None) = 0;
/** Like exec but with an additional argument for EncryptionFlags for
* more flexibility. */
virtual GpgME::EncryptionResult exec(const std::vector<GpgME::Key> &recipients,
const QByteArray &plainText,
const GpgME::Context::EncryptionFlags flags, QByteArray &cipherText) = 0;
Q_SIGNALS: Q_SIGNALS:
void result(const GpgME::EncryptionResult &result, const QByteArray &cipherText, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error()); void result(const GpgME::EncryptionResult &result, const QByteArray &cipherText, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
}; };

View File

@ -65,7 +65,7 @@ static QGpgMEEncryptJob::result_type encrypt(Context *ctx, QThread *thread,
const std::vector<Key> &recipients, const std::vector<Key> &recipients,
const std::weak_ptr<QIODevice> &plainText_, const std::weak_ptr<QIODevice> &plainText_,
const std::weak_ptr<QIODevice> &cipherText_, const std::weak_ptr<QIODevice> &cipherText_,
bool alwaysTrust, const Context::EncryptionFlags eflags,
bool outputIsBsse64Encoded) bool outputIsBsse64Encoded)
{ {
@ -78,9 +78,6 @@ static QGpgMEEncryptJob::result_type encrypt(Context *ctx, QThread *thread,
QGpgME::QIODeviceDataProvider in(plainText); QGpgME::QIODeviceDataProvider in(plainText);
const Data indata(&in); const Data indata(&in);
const Context::EncryptionFlags eflags =
alwaysTrust ? Context::AlwaysTrust : Context::None;
if (!cipherText) { if (!cipherText) {
QGpgME::QByteArrayDataProvider out; QGpgME::QByteArrayDataProvider out;
Data outdata(&out); Data outdata(&out);
@ -109,41 +106,54 @@ static QGpgMEEncryptJob::result_type encrypt(Context *ctx, QThread *thread,
} }
static QGpgMEEncryptJob::result_type encrypt_qba(Context *ctx, const std::vector<Key> &recipients, const QByteArray &plainText, bool alwaysTrust, bool outputIsBsse64Encoded) static QGpgMEEncryptJob::result_type encrypt_qba(Context *ctx, const std::vector<Key> &recipients, const QByteArray &plainText, const Context::EncryptionFlags eflags, bool outputIsBsse64Encoded)
{ {
const std::shared_ptr<QBuffer> buffer(new QBuffer); const std::shared_ptr<QBuffer> buffer(new QBuffer);
buffer->setData(plainText); buffer->setData(plainText);
if (!buffer->open(QIODevice::ReadOnly)) { if (!buffer->open(QIODevice::ReadOnly)) {
assert(!"This should never happen: QBuffer::open() failed"); assert(!"This should never happen: QBuffer::open() failed");
} }
return encrypt(ctx, 0, recipients, buffer, std::shared_ptr<QIODevice>(), alwaysTrust, outputIsBsse64Encoded); return encrypt(ctx, 0, recipients, buffer, std::shared_ptr<QIODevice>(), eflags, outputIsBsse64Encoded);
} }
Error QGpgMEEncryptJob::start(const std::vector<Key> &recipients, const QByteArray &plainText, bool alwaysTrust) Error QGpgMEEncryptJob::start(const std::vector<Key> &recipients, const QByteArray &plainText, bool alwaysTrust)
{ {
run(std::bind(&encrypt_qba, std::placeholders::_1, recipients, plainText, alwaysTrust, mOutputIsBase64Encoded)); run(std::bind(&encrypt_qba, std::placeholders::_1, recipients, plainText,
alwaysTrust ? Context::AlwaysTrust : Context::None, mOutputIsBase64Encoded));
return Error(); return Error();
} }
void QGpgMEEncryptJob::start(const std::vector<Key> &recipients, const std::shared_ptr<QIODevice> &plainText, const std::shared_ptr<QIODevice> &cipherText, bool alwaysTrust) void QGpgMEEncryptJob::start(const std::vector<Key> &recipients, const std::shared_ptr<QIODevice> &plainText,
const std::shared_ptr<QIODevice> &cipherText, const Context::EncryptionFlags eflags)
{ {
run(std::bind(&encrypt, run(std::bind(&encrypt,
std::placeholders::_1, std::placeholders::_2, std::placeholders::_1, std::placeholders::_2,
recipients, recipients,
std::placeholders::_3, std::placeholders::_4, std::placeholders::_3, std::placeholders::_4,
alwaysTrust, eflags,
mOutputIsBase64Encoded), mOutputIsBase64Encoded),
plainText, cipherText); plainText, cipherText);
} }
EncryptionResult QGpgMEEncryptJob::exec(const std::vector<Key> &recipients, const QByteArray &plainText, bool alwaysTrust, QByteArray &cipherText) EncryptionResult QGpgMEEncryptJob::exec(const std::vector<Key> &recipients, const QByteArray &plainText,
const Context::EncryptionFlags eflags, QByteArray &cipherText)
{ {
const result_type r = encrypt_qba(context(), recipients, plainText, alwaysTrust, mOutputIsBase64Encoded); const result_type r = encrypt_qba(context(), recipients, plainText, eflags, mOutputIsBase64Encoded);
cipherText = std::get<1>(r); cipherText = std::get<1>(r);
resultHook(r); resultHook(r);
return mResult; return mResult;
} }
void QGpgMEEncryptJob::start(const std::vector<Key> &recipients, const std::shared_ptr<QIODevice> &plainText, const std::shared_ptr<QIODevice> &cipherText, bool alwaysTrust)
{
return start(recipients, plainText, cipherText, alwaysTrust ? Context::AlwaysTrust : Context::None);
}
EncryptionResult QGpgMEEncryptJob::exec(const std::vector<Key> &recipients, const QByteArray &plainText, bool alwaysTrust, QByteArray &cipherText)
{
return exec(recipients, plainText, alwaysTrust ? Context::AlwaysTrust : Context::None, cipherText);
}
void QGpgMEEncryptJob::resultHook(const result_type &tuple) void QGpgMEEncryptJob::resultHook(const result_type &tuple)
{ {
mResult = std::get<0>(tuple); mResult = std::get<0>(tuple);

View File

@ -82,6 +82,16 @@ public:
GpgME::EncryptionResult exec(const std::vector<GpgME::Key> &recipients, GpgME::EncryptionResult exec(const std::vector<GpgME::Key> &recipients,
const QByteArray &plainText, bool alwaysTrust, const QByteArray &plainText, bool alwaysTrust,
QByteArray &cipherText) Q_DECL_OVERRIDE; QByteArray &cipherText) Q_DECL_OVERRIDE;
/* from EncryptJob */
void start(const std::vector<GpgME::Key> &recipients,
const std::shared_ptr<QIODevice> &plainText,
const std::shared_ptr<QIODevice> &cipherText,
const GpgME::Context::EncryptionFlags flags) Q_DECL_OVERRIDE;
/* from EncryptJob */
GpgME::EncryptionResult exec(const std::vector<GpgME::Key> &recipients,
const QByteArray &plainText, const GpgME::Context::EncryptionFlags flags,
QByteArray &cipherText) Q_DECL_OVERRIDE;
/* from EncryptJob */ /* from EncryptJob */
void setOutputIsBase64Encoded(bool on) Q_DECL_OVERRIDE; void setOutputIsBase64Encoded(bool on) Q_DECL_OVERRIDE;

View File

@ -62,7 +62,9 @@ void QGpgMESignEncryptJob::setOutputIsBase64Encoded(bool on)
mOutputIsBase64Encoded = on; mOutputIsBase64Encoded = on;
} }
static QGpgMESignEncryptJob::result_type sign_encrypt(Context *ctx, QThread *thread, const std::vector<Key> &signers, const std::vector<Key> &recipients, const std::weak_ptr<QIODevice> &plainText_, const std::weak_ptr<QIODevice> &cipherText_, bool alwaysTrust, bool outputIsBsse64Encoded) static QGpgMESignEncryptJob::result_type sign_encrypt(Context *ctx, QThread *thread, const std::vector<Key> &signers,
const std::vector<Key> &recipients, const std::weak_ptr<QIODevice> &plainText_,
const std::weak_ptr<QIODevice> &cipherText_, const Context::EncryptionFlags eflags, bool outputIsBsse64Encoded)
{ {
const std::shared_ptr<QIODevice> &plainText = plainText_.lock(); const std::shared_ptr<QIODevice> &plainText = plainText_.lock();
const std::shared_ptr<QIODevice> &cipherText = cipherText_.lock(); const std::shared_ptr<QIODevice> &cipherText = cipherText_.lock();
@ -73,9 +75,6 @@ static QGpgMESignEncryptJob::result_type sign_encrypt(Context *ctx, QThread *thr
QGpgME::QIODeviceDataProvider in(plainText); QGpgME::QIODeviceDataProvider in(plainText);
const Data indata(&in); const Data indata(&in);
const Context::EncryptionFlags eflags =
alwaysTrust ? Context::AlwaysTrust : Context::None;
ctx->clearSigningKeys(); ctx->clearSigningKeys();
Q_FOREACH (const Key &signer, signers) Q_FOREACH (const Key &signer, signers)
if (!signer.isNull()) if (!signer.isNull())
@ -111,35 +110,48 @@ static QGpgMESignEncryptJob::result_type sign_encrypt(Context *ctx, QThread *thr
} }
static QGpgMESignEncryptJob::result_type sign_encrypt_qba(Context *ctx, const std::vector<Key> &signers, const std::vector<Key> &recipients, const QByteArray &plainText, bool alwaysTrust, bool outputIsBsse64Encoded) static QGpgMESignEncryptJob::result_type sign_encrypt_qba(Context *ctx, const std::vector<Key> &signers,
const std::vector<Key> &recipients, const QByteArray &plainText, const Context::EncryptionFlags eflags, bool outputIsBsse64Encoded)
{ {
const std::shared_ptr<QBuffer> buffer(new QBuffer); const std::shared_ptr<QBuffer> buffer(new QBuffer);
buffer->setData(plainText); buffer->setData(plainText);
if (!buffer->open(QIODevice::ReadOnly)) { if (!buffer->open(QIODevice::ReadOnly)) {
assert(!"This should never happen: QBuffer::open() failed"); assert(!"This should never happen: QBuffer::open() failed");
} }
return sign_encrypt(ctx, 0, signers, recipients, buffer, std::shared_ptr<QIODevice>(), alwaysTrust, outputIsBsse64Encoded); return sign_encrypt(ctx, 0, signers, recipients, buffer, std::shared_ptr<QIODevice>(), eflags, outputIsBsse64Encoded);
} }
Error QGpgMESignEncryptJob::start(const std::vector<Key> &signers, const std::vector<Key> &recipients, const QByteArray &plainText, bool alwaysTrust) Error QGpgMESignEncryptJob::start(const std::vector<Key> &signers, const std::vector<Key> &recipients, const QByteArray &plainText, bool alwaysTrust)
{ {
run(std::bind(&sign_encrypt_qba, std::placeholders::_1, signers, recipients, plainText, alwaysTrust, mOutputIsBase64Encoded)); run(std::bind(&sign_encrypt_qba, std::placeholders::_1, signers, recipients, plainText, alwaysTrust ? Context::AlwaysTrust : Context::None, mOutputIsBase64Encoded));
return Error(); return Error();
} }
void QGpgMESignEncryptJob::start(const std::vector<Key> &signers, const std::vector<Key> &recipients,
const std::shared_ptr<QIODevice> &plainText, const std::shared_ptr<QIODevice> &cipherText, const Context::EncryptionFlags eflags)
{
run(std::bind(&sign_encrypt, std::placeholders::_1, std::placeholders::_2, signers, recipients, std::placeholders::_3, std::placeholders::_4, eflags, mOutputIsBase64Encoded), plainText, cipherText);
}
void QGpgMESignEncryptJob::start(const std::vector<Key> &signers, const std::vector<Key> &recipients, const std::shared_ptr<QIODevice> &plainText, const std::shared_ptr<QIODevice> &cipherText, bool alwaysTrust) void QGpgMESignEncryptJob::start(const std::vector<Key> &signers, const std::vector<Key> &recipients, const std::shared_ptr<QIODevice> &plainText, const std::shared_ptr<QIODevice> &cipherText, bool alwaysTrust)
{ {
run(std::bind(&sign_encrypt, std::placeholders::_1, std::placeholders::_2, signers, recipients, std::placeholders::_3, std::placeholders::_4, alwaysTrust, mOutputIsBase64Encoded), plainText, cipherText); return start(signers, recipients, plainText, cipherText, alwaysTrust ? Context::AlwaysTrust : Context::None);
} }
std::pair<SigningResult, EncryptionResult> QGpgMESignEncryptJob::exec(const std::vector<Key> &signers, const std::vector<Key> &recipients, const QByteArray &plainText, bool alwaysTrust, QByteArray &cipherText) std::pair<SigningResult, EncryptionResult> QGpgMESignEncryptJob::exec(const std::vector<Key> &signers, const std::vector<Key> &recipients, const QByteArray &plainText, const Context::EncryptionFlags eflags, QByteArray &cipherText)
{ {
const result_type r = sign_encrypt_qba(context(), signers, recipients, plainText, alwaysTrust, mOutputIsBase64Encoded); const result_type r = sign_encrypt_qba(context(), signers, recipients, plainText, eflags, mOutputIsBase64Encoded);
cipherText = std::get<2>(r); cipherText = std::get<2>(r);
resultHook(r); resultHook(r);
return mResult; return mResult;
} }
std::pair<SigningResult, EncryptionResult> QGpgMESignEncryptJob::exec(const std::vector<Key> &signers, const std::vector<Key> &recipients, const QByteArray &plainText, bool alwaysTrust, QByteArray &cipherText)
{
return exec(signers, recipients, plainText, alwaysTrust ? Context::AlwaysTrust : Context::None, cipherText);
}
#if 0 #if 0
TODO port? TODO port?

View File

@ -87,12 +87,24 @@ public:
const std::shared_ptr<QIODevice> &cipherText, const std::shared_ptr<QIODevice> &cipherText,
bool alwaysTrust) Q_DECL_OVERRIDE; bool alwaysTrust) Q_DECL_OVERRIDE;
void start(const std::vector<GpgME::Key> &signers,
const std::vector<GpgME::Key> &recipients,
const std::shared_ptr<QIODevice> &plainText,
const std::shared_ptr<QIODevice> &cipherText,
const GpgME::Context::EncryptionFlags flags) Q_DECL_OVERRIDE;
std::pair<GpgME::SigningResult, GpgME::EncryptionResult> std::pair<GpgME::SigningResult, GpgME::EncryptionResult>
exec(const std::vector<GpgME::Key> &signers, exec(const std::vector<GpgME::Key> &signers,
const std::vector<GpgME::Key> &recipients, const std::vector<GpgME::Key> &recipients,
const QByteArray &plainText, bool alwaysTrust, const QByteArray &plainText, bool alwaysTrust,
QByteArray &cipherText) Q_DECL_OVERRIDE; QByteArray &cipherText) Q_DECL_OVERRIDE;
std::pair<GpgME::SigningResult, GpgME::EncryptionResult>
exec(const std::vector<GpgME::Key> &signers,
const std::vector<GpgME::Key> &recipients,
const QByteArray &plainText, const GpgME::Context::EncryptionFlags flags,
QByteArray &cipherText) Q_DECL_OVERRIDE;
/* from SignEncryptJob */ /* from SignEncryptJob */
void setOutputIsBase64Encoded(bool on) Q_DECL_OVERRIDE; void setOutputIsBase64Encoded(bool on) Q_DECL_OVERRIDE;

View File

@ -38,8 +38,10 @@
#ifdef BUILDING_QGPGME #ifdef BUILDING_QGPGME
# include "global.h" # include "global.h"
# include "context.h"
#else #else
# include <gpgme++/global.h> # include <gpgme++/global.h>
# include <gpgme++/context.h>
#endif #endif
#include <memory> #include <memory>
@ -123,6 +125,21 @@ public:
*/ */
virtual void setOutputIsBase64Encoded(bool) = 0; virtual void setOutputIsBase64Encoded(bool) = 0;
/** Like start but with an additional argument for EncryptionFlags for
* more flexibility. */
virtual void start(const std::vector<GpgME::Key> &signers,
const std::vector<GpgME::Key> &recipients,
const std::shared_ptr<QIODevice> &plainText,
const std::shared_ptr<QIODevice> &cipherText = std::shared_ptr<QIODevice>(),
const GpgME::Context::EncryptionFlags flags = GpgME::Context::None) = 0;
/** Like exec but with an additional argument for EncryptionFlags for
* more flexibility. */
virtual std::pair<GpgME::SigningResult, GpgME::EncryptionResult>
exec(const std::vector<GpgME::Key> &signers,
const std::vector<GpgME::Key> &recipients,
const QByteArray &plainText,
const GpgME::Context::EncryptionFlags flags, QByteArray &cipherText) = 0;
Q_SIGNALS: Q_SIGNALS:
void result(const GpgME::SigningResult &signingresult, void result(const GpgME::SigningResult &signingresult,
const GpgME::EncryptionResult &encryptionresult, const GpgME::EncryptionResult &encryptionresult,