qt, cpp: Enable dll build for windows
[gpgme.git] / lang / qt / src / wkspublishjob.h
1 /* wkspublishjob.h
2
3     Copyright (c) 2016 Intevation GmbH
4
5     QGpgME is free software; you can redistribute it and/or
6     modify it under the terms of the GNU General Public License as
7     published by the Free Software Foundation; either version 2 of the
8     License, or (at your option) any later version.
9
10     QGpgME is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13     General Public License for more details.
14
15     You should have received a copy of the GNU General Public License along
16     with this program; if not, write to the Free Software Foundation, Inc.,
17     51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18
19     In addition, as a special exception, the copyright holders give
20     permission to link the code of this program with any edition of
21     the Qt library by Trolltech AS, Norway (or with modified versions
22     of Qt that use the same license as Qt), and distribute linked
23     combinations including the two.  You must obey the GNU General
24     Public License in all respects for all of the code used other than
25     Qt.  If you modify this file, you may extend this exception to
26     your version of the file, but you are not obligated to do so.  If
27     you do not wish to do so, delete this exception statement from
28     your version.
29 */
30 #ifndef QGPGME_WKSPUBLISHJOB_H
31 #define QGPGME_WKSPUBLISHJOB_H
32
33 #include "job.h"
34
35 #include "qgpgme_export.h"
36
37 namespace GpgME
38 {
39     class Key;
40 } // namespace GpgME
41
42 namespace QGpgME {
43
44 /**
45  * Handles Web Key Service Publishing. Needs WKS tools installed and
46  * server support.
47  *
48  * Remember that after a result is emitted the job is auto deleted
49  * so you can only use it for a single action.
50  *
51  * The workflow is to call startCreate, check for errors and then
52  * send the RFC822 mail returned in returnedData.
53  *
54  * When the response is received start a startRecieve with the
55  * RFC822 mail received as paramater response. Check for errors
56  * and then send again send the result from returnedData back to
57  * the server.
58  *
59  */
60 class QGPGME_EXPORT WKSPublishJob: public Job
61 {
62     Q_OBJECT
63 protected:
64     explicit WKSPublishJob(QObject *parent);
65 public:
66     ~WKSPublishJob();
67
68
69     /** Start a check if WKS Publishing is supported. As this involves
70      * an HTTP Query it might take a while. Returns GPG_ERR_NOT_SUPPORED
71      * result if GnuPG is too old or the required tools are not installed.
72      *
73      * The error GPG_ERR_NOT_ENABLED indicates that wks-tools failed to
74      * detect a working wks service for this.
75      *
76      * @param the mailbox to check for.
77      **/
78     virtual void startCheck(const QString &mailbox) = 0;
79
80     /** Create a publish request.
81      * The returnedData from the result signal will contain
82      * the full Request as returned by gpg-wks-client --create
83      *
84      * @param fpr the fingerprint of the key to create the request for.
85      * @param mailbox A simple mail address without a Name.
86      */
87     virtual void startCreate(const char *fpr, const QString &mailbox) = 0;
88
89     /** Handle a submisson response. The returnedData in the result singnal
90      * will contain the confirmation response as returned by gpg-wks-client --receive
91      *
92      * @param response The response of the server.
93      **/
94     virtual void startReceive(const QByteArray &response) = 0;
95
96 Q_SIGNALS:
97     /* Result of the operation returned Data and returned Error are
98      * the results from gpg-wks-client's stdout or stderr respectively.
99      *
100      * As usual auditLogAsHtml and auditLogError can be ignored.
101      **/
102     void result(const GpgME::Error &error, const QByteArray &returnedData,
103                 const QByteArray &returnedError,
104                 const QString &auditLogAsHtml = QString(),
105                 const GpgME::Error &auditLogError = GpgME::Error());
106 };
107
108 }
109
110 #endif