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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
// SPDX-FileCopyrightText: 2019 Yury Gubich <blue@macaw.me>
// SPDX-FileCopyrightText: 2020 Linus Jahn <lnj@kaidan.im>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
#include "QXmppClient.h"
#include "QXmppDiscoveryManager.h"
#include "QXmppHttpUploadIq.h"
#include "QXmppHttpUploadManager.h"
#include "QXmppTlsManager_p.h"
#include "QXmppUploadRequestManager.h"
#include "IntegrationTesting.h"
#include "TestClient.h"
#include "util.h"
#include <QMimeDatabase>
static const auto UPLOAD_SERVICE_NAME = QStringLiteral("upload.montague.tld");
constexpr quint64 MAX_FILE_SIZE = 500UL * 1024UL * 1024UL;
static void addUploadService(QXmppClient &client)
{
QVERIFY(client.findExtension<QXmppUploadRequestManager>());
QVERIFY(client.findExtension<QXmppDiscoveryManager>());
QByteArray xml =
"<iq from='" +
UPLOAD_SERVICE_NAME.toUtf8() +
"' id='step_02' to='romeo@montague.tld/garden' type='result'>"
"<query xmlns='http://jabber.org/protocol/disco#info'>"
"<identity category='store' type='file' name='HTTP File Upload' />"
"<feature var='urn:xmpp:http:upload:0' />"
"<x type='result' xmlns='jabber:x:data'>"
"<field var='FORM_TYPE' type='hidden'>"
"<value>urn:xmpp:http:upload:0</value>"
"</field>"
"<field var='max-file-size'>"
"<value>" +
QByteArray::number(MAX_FILE_SIZE) +
"</value>"
"</field>"
"</x>"
"</query>"
"</iq>";
auto *discovery = client.findExtension<QXmppDiscoveryManager>();
QVERIFY(discovery->handleStanza(xmlToDom(xml)));
}
class tst_QXmppHttpUploadManager : public QObject
{
Q_OBJECT
private:
// UploadRequestManager
Q_SLOT void testDiscoveryService_data();
Q_SLOT void testDiscoveryService();
Q_SLOT void testHandleStanza_data();
Q_SLOT void testHandleStanza();
Q_SLOT void testSending_data();
Q_SLOT void testSending();
Q_SLOT void testSendingFuture_data();
Q_SLOT void testSendingFuture();
Q_SLOT void testUploadService();
// HttpUploadManager
Q_SLOT void testUpload();
};
void tst_QXmppHttpUploadManager::testHandleStanza_data()
{
QTest::addColumn<QByteArray>("xml");
QTest::addColumn<bool>("accepted");
QTest::addColumn<bool>("event");
QTest::addColumn<bool>("error");
QTest::newRow("notAccepted")
<< QByteArray("<message xmlns='jabber:client' "
"from='romeo@montague.example' "
"to='romeo@montague.example/home' "
"type='chat'>"
"<received xmlns='urn:xmpp:carbons:2'>"
"<forwarded xmlns='urn:xmpp:forward:0'>"
"<message xmlns='jabber:client' "
"from='juliet@capulet.example/balcony' "
"to='romeo@montague.example/garden' "
"type='chat'>"
"<body>What man art thou that, thus bescreen'd in night, so stumblest on my counsel?</body>"
"<thread>0e3141cd80894871a68e6fe6b1ec56fa</thread>"
"</message>"
"</forwarded>"
"</received>"
"</message>")
<< false << false << false;
QTest::newRow("slotReceived")
<< QByteArray("<iq from='upload.montague.tld' id='step_03' to='romeo@montague.tld/garden' type='result'>"
"<slot xmlns='urn:xmpp:http:upload:0'>"
"<put url='https://upload.montague.tld/4a771ac1-f0b2-4a4a-9700-f2a26fa2bb67/tr%C3%A8s%20cool.jpg'>"
"<header name='Authorization'>Basic Base64String==</header>"
"<header name='Cookie'>foo=bar; user=romeo</header>"
"</put>"
"<get url='https://download.montague.tld/4a771ac1-f0b2-4a4a-9700-f2a26fa2bb67/tr%C3%A8s%20cool.jpg' />"
"</slot>"
"</iq>")
<< true << true << false;
QTest::newRow("tooLargeError")
<< QByteArray("<iq from='upload.montague.tld' id='step_03' to='romeo@montague.tld/garden' type='error'>"
"<request xmlns='urn:xmpp:http:upload:0' filename='très cool.jpg' size='23456' content-type='image/jpeg' />"
"<error type='modify'>"
"<not-acceptable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas' />"
"<text xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'>File too large. The maximum file size is 20000 bytes</text>"
"<file-too-large xmlns='urn:xmpp:http:upload:0'>"
"<max-file-size>20000</max-file-size>"
"</file-too-large>"
"</error>"
"</iq>")
<< true << true << true;
QTest::newRow("quotaReachedError")
<< QByteArray("<iq from='upload.montague.tld' id='step_03' to='romeo@montague.tld/garden' type='error'>"
"<request xmlns='urn:xmpp:http:upload:0' filename='très cool.jpg' size='23456' content-type='image/jpeg' />"
"<error type='wait'>"
"<resource-constraint xmlns='urn:ietf:params:xml:ns:xmpp-stanzas' />"
"<text xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'>Quota reached. You can only upload 5 files in 5 minutes</text>"
"<retry xmlns='urn:xmpp:http:upload:0' stamp='2017-12-03T23:42:05Z' />"
"</error>"
"</iq>")
<< true << true << true;
}
void tst_QXmppHttpUploadManager::testHandleStanza()
{
QFETCH(QByteArray, xml);
QFETCH(bool, accepted);
QFETCH(bool, event);
QFETCH(bool, error);
TestClient test;
auto *manager = test.addNewExtension<QXmppUploadRequestManager>();
bool eventReceived = false;
bool errorReceived = false;
QObject context;
connect(manager, &QXmppUploadRequestManager::slotReceived, &context, [&](const auto &) {
eventReceived = true;
errorReceived = false;
});
connect(manager, &QXmppUploadRequestManager::requestFailed, &context, [&](const auto &) {
eventReceived = true;
errorReceived = true;
});
bool realAccepted = manager->handleStanza(xmlToDom(xml));
QCOMPARE(realAccepted, accepted);
QCOMPARE(eventReceived, event);
QCOMPARE(errorReceived, error);
}
void tst_QXmppHttpUploadManager::testDiscoveryService_data()
{
QTest::addColumn<QByteArray>("xml");
QTest::addColumn<bool>("discovered");
QTest::newRow("mixDiscoveryStanzaIq")
<< QByteArray("<iq from='mix.shakespeare.example' id='lx09df27' to='hag66@shakespeare.example/UUID-c8y/1573' type='result'>"
"<query xmlns='http://jabber.org/protocol/disco#info'>"
"<identity category='conference' name='Shakespearean Chat Service' type='mix '/>"
"<feature var='urn:xmpp:mix:core:1' />"
"<feature var='urn:xmpp:mix:core:1#searchable' />"
"</query>"
"</iq>")
<< false;
QTest::newRow("HTTPUploadDiscoveryStanzaIq")
<< "<iq from='" +
UPLOAD_SERVICE_NAME.toUtf8() +
"' id='step_02' to='romeo@montague.tld/garden' type='result'>"
"<query xmlns='http://jabber.org/protocol/disco#info'>"
"<identity category='store' type='file' name='HTTP File Upload' />"
"<feature var='urn:xmpp:http:upload:0' />"
"<x type='result' xmlns='jabber:x:data'>"
"<field var='FORM_TYPE' type='hidden'>"
"<value>urn:xmpp:http:upload:0</value>"
"</field>"
"<field var='max-file-size'>"
"<value>" +
QByteArray::number(MAX_FILE_SIZE) +
"</value>"
"</field>"
"</x>"
"</query>"
"</iq>"
<< true;
}
void tst_QXmppHttpUploadManager::testDiscoveryService()
{
QFETCH(QByteArray, xml);
QFETCH(bool, discovered);
TestClient test;
auto *discovery = test.addNewExtension<QXmppDiscoveryManager>();
auto *manager = test.addNewExtension<QXmppUploadRequestManager>();
bool accepted = discovery->handleStanza(xmlToDom(xml));
QCOMPARE(accepted, true);
QCOMPARE(manager->serviceFound(), discovered);
if (manager->serviceFound()) {
QCOMPARE(manager->uploadServices().at(0).jid(), UPLOAD_SERVICE_NAME);
QCOMPARE(manager->uploadServices().at(0).sizeLimit(), qint64(MAX_FILE_SIZE));
}
}
void tst_QXmppHttpUploadManager::testSending_data()
{
QTest::addColumn<QFileInfo>("fileInfo");
QTest::addColumn<QString>("fileName");
QTest::addColumn<qint64>("fileSize");
QTest::addColumn<QString>("fileType");
QTest::newRow("fileInfo")
<< QFileInfo(":/test.svg")
<< "test.svg"
<< 2280LL
<< "image/svg+xml";
QTest::newRow("fileWithSizeBelowLimit")
<< QFileInfo()
<< "whatever.jpeg"
<< 698547LL
<< "image/jpeg";
QTest::newRow("fileWithSizeAboveLimit")
<< QFileInfo()
<< "some.pdf"
<< 65896498547LL
<< "application/pdf";
// there is no size above limit handling in request manager
// there is also no code that selects an upload service with proper
// size limit above requesting file size.
// Is it something to worry about?
}
void tst_QXmppHttpUploadManager::testSending()
{
QFETCH(QFileInfo, fileInfo);
QFETCH(QString, fileName);
QFETCH(qint64, fileSize);
QFETCH(QString, fileType);
auto expectedMimeType = QMimeDatabase().mimeTypeForName(fileType);
TestClient test;
test.addNewExtension<QXmppDiscoveryManager>();
auto *manager = test.addNewExtension<QXmppUploadRequestManager>();
addUploadService(test);
QString returnId;
if (!fileInfo.baseName().isEmpty()) {
returnId = manager->requestUploadSlot(fileInfo);
} else {
returnId = manager->requestUploadSlot(fileName, fileSize, expectedMimeType);
}
QXmppHttpUploadRequestIq iq;
parsePacket(iq, test.takePacket().toUtf8());
QCOMPARE(iq.type(), QXmppIq::Get);
QCOMPARE(iq.to(), UPLOAD_SERVICE_NAME);
QCOMPARE(iq.fileName(), fileName);
QCOMPARE(iq.size(), fileSize);
QCOMPARE(iq.contentType(), expectedMimeType);
// The client is not connected, so we never get an ID back (the packet was not sent).
QVERIFY(returnId.isNull());
}
void tst_QXmppHttpUploadManager::testSendingFuture_data()
{
testSending_data();
}
void tst_QXmppHttpUploadManager::testSendingFuture()
{
QFETCH(QFileInfo, fileInfo);
QFETCH(QString, fileName);
QFETCH(qint64, fileSize);
QFETCH(QString, fileType);
auto expectedMimeType = QMimeDatabase().mimeTypeForName(fileType);
TestClient test;
test.addNewExtension<QXmppDiscoveryManager>();
auto *manager = test.addNewExtension<QXmppUploadRequestManager>();
addUploadService(test);
auto future = [=]() {
if (!fileInfo.baseName().isEmpty()) {
return manager->requestSlot(fileInfo);
} else {
return manager->requestSlot(fileName, fileSize, expectedMimeType);
}
}();
QVERIFY(!future.isFinished());
// check sent packet
QXmppHttpUploadRequestIq iq;
parsePacket(iq, test.takePacket().toUtf8());
QCOMPARE(iq.type(), QXmppIq::Get);
QCOMPARE(iq.to(), UPLOAD_SERVICE_NAME);
QCOMPARE(iq.fileName(), fileName);
QCOMPARE(iq.size(), fileSize);
QCOMPARE(iq.contentType(), expectedMimeType);
// inject reply
QByteArray reply =
"<iq from='" + iq.to().toUtf8() + "' id='" + iq.id().toUtf8() + "' to='" + iq.from().toUtf8() +
"' type='result'>"
"<slot xmlns='urn:xmpp:http:upload:0'>"
"<put url='https://upload.montague.tld/4a771ac1-f0b2-4a4a-9700-f2a26fa2bb67/tr%C3%A8s%20cool.jpg'>"
"<header name='Authorization'>Basic Base64String==</header>"
"<header name='Content-type'>application/json</header>"
"<header name='Cookie'>foo=bar; user=romeo</header>"
"</put>"
"<get url='https://download.montague.tld/4a771ac1-f0b2-4a4a-9700-f2a26fa2bb67/tr%C3%A8s%20cool.jpg' />"
"</slot>"
"</iq>";
test.inject(reply);
auto slot = expectFutureVariant<QXmppHttpUploadSlotIq>(future);
QCOMPARE(slot.getUrl(), QUrl("https://download.montague.tld/4a771ac1-f0b2-4a4a-9700-f2a26fa2bb67/tr%C3%A8s%20cool.jpg"));
QCOMPARE(slot.putUrl(), QUrl("https://upload.montague.tld/4a771ac1-f0b2-4a4a-9700-f2a26fa2bb67/tr%C3%A8s%20cool.jpg"));
// checks that the disallowed 'Content-type' header is not set
QCOMPARE(slot.putHeaders().size(), 2);
QCOMPARE(slot.putHeaders().keys()[0], QStringLiteral("Authorization"));
QCOMPARE(slot.putHeaders().keys()[1], QStringLiteral("Cookie"));
}
void tst_QXmppHttpUploadManager::testUploadService()
{
QXmppUploadService service;
QCOMPARE(service.sizeLimit(), -1LL);
QVERIFY(service.jid().isNull());
service.setSizeLimit(256LL * 1024LL * 1024LL);
QCOMPARE(service.sizeLimit(), 256LL * 1024LL * 1024LL);
service.setJid(QStringLiteral("upload.shakespeare.lit"));
QCOMPARE(service.jid(), QStringLiteral("upload.shakespeare.lit"));
}
void tst_QXmppHttpUploadManager::testUpload()
{
using DiscoInfoResult = QXmppDiscoveryManager::InfoResult;
using DiscoItem = QXmppDiscoveryIq::Item;
SKIP_IF_INTEGRATION_TESTS_DISABLED()
TestClient test;
test.addNewExtension<QXmppTlsManager>();
auto *disco = test.addNewExtension<QXmppDiscoveryManager>();
test.addNewExtension<QXmppUploadRequestManager>();
auto *uploadManager = test.addNewExtension<QXmppHttpUploadManager>();
test.connectToServer(IntegrationTests::clientConfiguration());
QSignalSpy(&test, &QXmppClient::connected).wait();
QVERIFY(test.isConnected());
// get server items
auto items = expectVariant<QList<DiscoItem>>(wait(disco->requestDiscoItems(test.configuration().domain()).toFuture(this)));
// request disco info for each item
std::vector<QXmppTask<DiscoInfoResult>> infoFutures;
std::transform(items.cbegin(), items.cend(), std::back_inserter(infoFutures), [disco](const auto &item) {
return disco->requestDiscoInfo(item.jid(), item.node());
});
auto uploadServiceJid = [&]() {
for (auto &future : infoFutures) {
auto result = expectVariant<QXmppDiscoveryIq>(wait(future.toFuture(this)));
for (const auto &identity : result.identities()) {
if (identity.category() == "store" &&
identity.type() == "file" &&
result.features().contains("urn:xmpp:http:upload:0")) {
return result.from();
}
}
}
return QString();
}();
// check whether the server supports HTTP File Upload
if (uploadServiceJid.isEmpty()) {
QSKIP("The server does not support HTTP File Upload.");
}
auto upload = uploadManager->uploadFile(QFileInfo(":/test.svg"), "test_renamed.png", uploadServiceJid);
QVERIFY2(!upload->isFinished(), "Uploading resulted instantly in an error");
{
// check sent request
QXmppHttpUploadRequestIq iq;
parsePacket(iq, test.takeLastPacket().toUtf8());
QCOMPARE(iq.contentType().name(), QStringLiteral("image/svg+xml"));
QCOMPARE(iq.fileName(), QStringLiteral("test_renamed.png"));
QCOMPARE(iq.size(), 2280LL);
}
// test signals
QSignalSpy finishedSpy(upload.get(), &QXmppHttpUpload::finished);
QSignalSpy progressSpy(upload.get(), &QXmppHttpUpload::progressChanged);
finishedSpy.wait();
QCOMPARE(finishedSpy.size(), 1);
QVERIFY(!progressSpy.empty());
// test result
auto result = upload->result().value();
if (std::holds_alternative<QXmppError>(result)) {
qDebug() << "Upload failed:" << std::get<QXmppError>(result).description;
QVERIFY2(false, "Uploading the file failed");
}
auto url = expectVariant<QUrl>(std::move(result));
QCOMPARE(upload->bytesSent(), 2280ULL);
QCOMPARE(upload->bytesTotal(), 2280ULL);
QCOMPARE(upload->progress(), 1.0);
qDebug() << "Uploaded file to" << url.toDisplayString();
}
QTEST_MAIN(tst_QXmppHttpUploadManager)
#include "tst_qxmpphttpuploadmanager.moc"
|
