Add QGpgME code from libkleo
[gpgme.git] / lang / qt / src / hierarchicalkeylistjob.h
1 /*
2     hierarchicalkeylistjob.h
3
4     This file is part of qgpgme, the Qt API binding for gpgme
5     Copyright (c) 2004 Klarälvdalens Datakonsult AB
6     Copyright (c) 2016 Intevation GmbH
7
8     Libkleopatra is free software; you can redistribute it and/or
9     modify it under the terms of the GNU General Public License as
10     published by the Free Software Foundation; either version 2 of the
11     License, or (at your option) any later version.
12
13     Libkleopatra is distributed in the hope that it will be useful,
14     but WITHOUT ANY WARRANTY; without even the implied warranty of
15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16     General Public License for more details.
17
18     You should have received a copy of the GNU General Public License
19     along with this program; if not, write to the Free Software
20     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21
22     In addition, as a special exception, the copyright holders give
23     permission to link the code of this program with any edition of
24     the Qt library by Trolltech AS, Norway (or with modified versions
25     of Qt that use the same license as Qt), and distribute linked
26     combinations including the two.  You must obey the GNU General
27     Public License in all respects for all of the code used other than
28     Qt.  If you modify this file, you may extend this exception to
29     your version of the file, but you are not obligated to do so.  If
30     you do not wish to do so, delete this exception statement from
31     your version.
32 */
33
34 #ifndef __KLEO_HIERARCHICALKEYLISTJOB_H__
35 #define __KLEO_HIERARCHICALKEYLISTJOB_H__
36
37 #include "qgpgme_export.h"
38 #include "keylistjob.h"
39 #include "cryptobackend.h"
40
41 #ifdef BUILDING_QGPGME
42 # include "keylistresult.h"
43 #else
44 #include <gpgme++/keylistresult.h>
45 #endif
46
47 #include <QPointer>
48
49 #include <set>
50
51 namespace GpgME
52 {
53 class Error;
54 class Key;
55 }
56
57 namespace QGpgME
58 {
59 class KeyListJob;
60 }
61
62 namespace QGpgME
63 {
64
65 /**
66    @short A convenience job that additionally fetches all available issuers.
67
68    To use a HierarchicalKeyListJob, pass it a CryptoBackend
69    implementation, connect the progress() and result() signals to
70    suitable slots and then start the keylisting with a call to
71    start(). This call might fail, in which case the
72    HierarchicalKeyListJob instance will have scheduled it's own
73    destruction with a call to QObject::deleteLater().
74
75    After result() is emitted, the HierarchicalKeyListJob will
76    schedule its own destruction by calling QObject::deleteLater().
77 */
78 class QGPGME_EXPORT HierarchicalKeyListJob : public KeyListJob
79 {
80     Q_OBJECT
81 public:
82     explicit HierarchicalKeyListJob(const Protocol *protocol,
83                                     bool remote = false, bool includeSigs = false,
84                                     bool validating = false);
85     ~HierarchicalKeyListJob();
86
87     /**
88        Starts the keylist operation. \a patterns is a list of patterns
89        used to restrict the list of keys returned. Empty patterns are
90        ignored. \a patterns must not be empty or contain only empty
91        patterns; use the normal KeyListJob for a full listing.
92
93        The \a secretOnly parameter is ignored by
94        HierarchicalKeyListJob and must be set to false.
95     */
96     GpgME::Error start(const QStringList &patterns, bool secretOnly = false) Q_DECL_OVERRIDE;
97
98     GpgME::KeyListResult exec(const QStringList &patterns, bool secretOnly,
99                               std::vector<GpgME::Key> &keys) Q_DECL_OVERRIDE;
100
101 private Q_SLOTS:
102     void slotResult(const GpgME::KeyListResult &);
103     void slotNextKey(const GpgME::Key &key);
104     /*! \reimp from Job */
105     void slotCancel() Q_DECL_OVERRIDE;
106
107 private:
108     GpgME::Error startAJob();
109
110 private:
111     const Protocol *const mProtocol;
112     const bool mRemote;
113     const bool mIncludeSigs;
114     const bool mValidating;
115     bool mTruncated;
116     std::set<QString> mSentSet; // keys already sent (prevent duplicates even if the backend should return them)
117     std::set<QString> mScheduledSet; // keys already scheduled (by starting a job for them)
118     std::set<QString> mNextSet; // keys to schedule for the next iteraton
119     GpgME::KeyListResult mIntermediateResult;
120     QPointer<KeyListJob> mJob;
121 };
122
123 }
124
125 #endif // __KLEO_HIERARCHICALKEYLISTJOB_H__