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