gpgme/lang/qt/src/changeexpiryjob.h
Ingo Klöcker 144d580607 qt: Allow changing expiration date of primary key and all subkeys
* lang/qt/src/Makefile.am (qgpgme_sources): Add changeexpiryjob.cpp.
* lang/qt/src/changeexpiryjob.cpp: New.
* lang/qt/src/changeexpiryjob.h (enum ChangeExpiryJob::Option,
typedef ChangeExpiryJob::Options, ChangeExpiryJob::setOptions,
ChangeExpiryJob::options): New.
* lang/qt/src/qgpgmechangeexpiryjob.cpp (change_expiry): Update the
expiration date of primary key and/or some/all subkeys.
(QGpgMEChangeExpiryJob::start): Add options to call of change_expiry.
(ChangeExpiryJob::start): Moved implementation to changeexpiryjob.cpp.
--

Additionally, to the default behavior (update expiration of primary
key if no subkeys are specified resp. update expiration of specified
subkeys) it is now possible to update the expiration of the primary key
_and_ the specified/all subkeys.

GnuPG-bug-id: 4717
2021-06-28 11:56:12 +02:00

116 lines
3.8 KiB
C++

/*
changeexpiryjob.h
This file is part of qgpgme, the Qt API binding for gpgme
Copyright (c) 2008 Klarälvdalens Datakonsult AB
Copyright (c) 2016 by Bundesamt für Sicherheit in der Informationstechnik
Software engineering by Intevation GmbH
QGpgME 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 of the
License, or (at your option) any later version.
QGpgME 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, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
In addition, as a special exception, the copyright holders give
permission to link the code of this program with any edition of
the Qt library by Trolltech AS, Norway (or with modified versions
of Qt that use the same license as Qt), and distribute linked
combinations including the two. You must obey the GNU General
Public License in all respects for all of the code used other than
Qt. If you modify this file, you may extend this exception to
your version of the file, but you are not obligated to do so. If
you do not wish to do so, delete this exception statement from
your version.
*/
#ifndef __KLEO_CHANGEEXPIRYJOB_H__
#define __KLEO_CHANGEEXPIRYJOB_H__
#include "job.h"
#ifdef BUILDING_QGPGME
# include "key.h"
#else
# include <gpgme++/key.h>
#endif
#include <vector>
namespace GpgME
{
class Error;
}
class QDateTime;
namespace QGpgME
{
/**
@short An abstract base class to change expiry asynchronously
To use a ChangeExpiryJob, first obtain an instance from the
CryptoBackend implementation, connect the progress() and result()
signals to suitable slots and then start the job with a call
to start(). This call might fail, in which case the ChangeExpiryJob
instance will have scheduled it's own destruction with a call to
QObject::deleteLater().
After result() is emitted, the ChangeExpiryJob will schedule it's own
destruction by calling QObject::deleteLater().
*/
class QGPGME_EXPORT ChangeExpiryJob : public Job
{
Q_OBJECT
public:
enum Option {
Default = 0x00,
UpdatePrimaryKey = 0x01,
UpdateAllSubkeys = 0x02,
};
Q_DECLARE_FLAGS(Options, Option)
protected:
explicit ChangeExpiryJob(QObject *parent);
public:
~ChangeExpiryJob();
void setOptions(Options options);
Options options() const;
/**
Starts the change-expiry operation. \a key is the key to change
the expiry of. \a expiry is the new expiry time. If \a expiry
is not valid, \a key is set to never expire.
*/
virtual GpgME::Error start(const GpgME::Key &key, const QDateTime &expiry) = 0;
/**
Starts the change-expiry operation. \a key is the key to change,
\a subkeys is a list of subkeys of the key, and \a expiry is the
new expiry time. If \a subkeys is empty, then the expiry of \a key
is changed. Otherwise, the expiry of \a subkeys is changed. If
\a expiry is not valid, then \a key or \a subkeys are set to never expire.
*/
virtual GpgME::Error start(const GpgME::Key &key, const QDateTime &expiry,
const std::vector<GpgME::Subkey> &subkeys);
Q_SIGNALS:
void result(const GpgME::Error &result, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
};
Q_DECLARE_OPERATORS_FOR_FLAGS(ChangeExpiryJob::Options)
}
#endif // __KLEO_CHANGEEXPIRYJOB_H__