1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/******************************************************************************
* Copyright (C) 2015 Felix Rohrbach <kde@fxrh.de>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef QMATRIXCLIENT_BASEJOB_H
#define QMATRIXCLIENT_BASEJOB_H
#include <QtCore/QObject>
#include <QtCore/QJsonDocument>
#include <QtCore/QJsonObject>
#include <QtCore/QUrlQuery>
#include <QtCore/QScopedPointer>
class QNetworkReply;
class QSslError;
namespace QMatrixClient
{
class ConnectionData;
enum class JobHttpType { GetJob, PutJob, PostJob };
class BaseJob: public QObject
{
Q_OBJECT
public:
/* Just in case, the values are compatible with KJob
* (which BaseJob used to inherit from). */
enum ErrorCode { NoError = 0, NetworkError = 100,
JsonParseError, TimeoutError, ContentAccessError,
UserDefinedError = 512 };
BaseJob(ConnectionData* connection, JobHttpType type,
QString name, bool needsToken=true);
virtual ~BaseJob();
void start();
/**
* Abandons the result of this job, arrived or unarrived.
*
* This aborts waiting for a reply from the server (if there was
* any pending) and deletes the job object. It is always done quietly
* (as opposed to KJob::kill() that can trigger emitting the result).
*/
void abandon();
int error() const;
virtual QString errorString() const;
signals:
/**
* Emitted when the job is finished, in any case. It is used to notify
* observers that the job is terminated and that progress can be hidden.
*
* This should not be emitted directly by subclasses;
* use emitResult() instead.
*
* In general, to be notified of a job's completion, client code
* should connect to success() and failure()
* rather than finished(), so that kill() is indeed quiet.
* However if you store a list of jobs and they might get killed
* silently, then you must connect to this instead of result(),
* to avoid dangling pointers in your list.
*
* @param job the job that emitted this signal
* @internal
*
* @see success, failure
*/
void finished(BaseJob* job);
/**
* Emitted when the job is finished (except when killed).
*
* Use error to know if the job was finished with error.
*
* @param job the job that emitted this signal
*
* @see success, failure
*/
void result(BaseJob* job);
/**
* Emitted together with result() but only if there's no error.
*/
void success(BaseJob*);
/**
* Emitted together with result() if there's an error.
* Same as result(), this won't be emitted in case of kill().
*/
void failure(BaseJob*);
protected:
ConnectionData* connection() const;
// to implement
virtual QString apiPath() const = 0;
virtual QUrlQuery query() const;
virtual QJsonObject data() const;
/**
* Checks the received reply for sanity; calls setError/setErrorText
* respectively. setError() with any argument except NoError prevents
* further parseReply()/parseJson() invocations.
*
* @param reply the reply received from the server
*/
virtual bool checkReply(QNetworkReply* reply);
/**
* Processes the reply. By default, parses the reply into
* a QJsonDocument and calls parseJson() if it's a valid JSON.
* Overrides MUST ensure that fail() or emitResult() is called
* on every execution path exactly once.
*
* @param data raw contents of a HTTP reply from the server (without headers)
*/
virtual void parseReply(QByteArray data);
/**
* Processes the JSON document received from the Matrix server.
* By default emits a successful result without analysing the JSON.
* Overrides MUST ensure that fail() or emitResult() is called
* on every execution path exactly once.
*
* @param json valid JSON document received from the server
*/
virtual void parseJson(const QJsonDocument&);
/**
* Sets the error code.
*
* It should be called when an error is encountered in the job,
* just before calling emitResult(). Normally you might want to
* use fail() instead - it sets error code, error text, makes sure
* the job has finished and invokes emitResult after that.
*
* To extend the list of error codes, define an (anonymous) enum
* with additional values starting at BaseJob::UserDefinedError
*
* @param errorCode the error code
* @see emitResult(), fail()
*/
void setError(int errorCode);
/**
* Sets the error text. Usually is combined with a setError() call
* before it, as setErrorText() alone does not indicate the error status.
*/
void setErrorText(QString errorText);
/**
* Emits the result signal, and suicides this job.
* It first notifies the observers to hide the progress for this job
* using the finished() signal.
*
* @note: Deletes this job using deleteLater().
*
* @see result()
* @see finished()
*/
void emitResult();
/**
* Same as emitResult() but calls setError() and setErrorText()
* with respective arguments passed to it. Use it as a shortcut to
* finish the job with a failure status.
*/
void fail( int errorCode, QString errorString );
protected slots:
void timeout();
void sslErrors(const QList<QSslError>& errors);
private slots:
void gotReply();
private:
void finishJob(bool emitResult);
class Private;
QScopedPointer<Private> d;
};
}
#endif // QMATRIXCLIENT_BASEJOB_H
|
