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 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWebEngine module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "../util.h"
#include <QtCore/qbuffer.h>
#include <QtCore/qmimedatabase.h>
#include <QtTest/QtTest>
#include <QtWebEngineCore/qwebengineurlrequestinterceptor.h>
#include <QtWebEngineCore/qwebengineurlrequestjob.h>
#include <QtWebEngineCore/qwebenginecookiestore.h>
#include <QtWebEngineCore/qwebengineurlscheme.h>
#include <QtWebEngineCore/qwebengineurlschemehandler.h>
#include <QtWebEngineWidgets/qwebengineprofile.h>
#include <QtWebEngineWidgets/qwebenginepage.h>
#include <QtWebEngineWidgets/qwebenginesettings.h>
#include <QtWebEngineWidgets/qwebengineview.h>
#include <QtWebEngineWidgets/qwebenginedownloaditem.h>
#if QT_CONFIG(webengine_webchannel)
#include <QWebChannel>
#endif
#include <httpserver.h>
#include <httpreqrep.h>
#include <map>
#include <mutex>
class tst_QWebEngineProfile : public QObject
{
Q_OBJECT
private Q_SLOTS:
void initTestCase();
void init();
void cleanup();
void privateProfile();
void testProfile();
void clearDataFromCache();
void disableCache();
void urlSchemeHandlers();
void urlSchemeHandlerFailRequest();
void urlSchemeHandlerFailOnRead();
void urlSchemeHandlerStreaming();
void urlSchemeHandlerRequestHeaders();
void urlSchemeHandlerInstallation();
void urlSchemeHandlerXhrStatus();
void urlSchemeHandlerScriptModule();
void urlSchemeHandlerLongReply();
void customUserAgent();
void httpAcceptLanguage();
void downloadItem();
void changePersistentPath();
void changeHttpUserAgent();
void changeHttpAcceptLanguage();
void changeUseForGlobalCertificateVerification();
void changePersistentCookiesPolicy();
void initiator();
void badDeleteOrder();
void qtbug_71895(); // this should be the last test
};
void tst_QWebEngineProfile::initTestCase()
{
QWebEngineUrlScheme foo("foo");
QWebEngineUrlScheme stream("stream");
QWebEngineUrlScheme letterto("letterto");
QWebEngineUrlScheme aviancarrier("aviancarrier");
QWebEngineUrlScheme myscheme("myscheme");
foo.setSyntax(QWebEngineUrlScheme::Syntax::Host);
stream.setSyntax(QWebEngineUrlScheme::Syntax::HostAndPort);
stream.setDefaultPort(8080);
letterto.setSyntax(QWebEngineUrlScheme::Syntax::Path);
aviancarrier.setSyntax(QWebEngineUrlScheme::Syntax::Path);
aviancarrier.setFlags(QWebEngineUrlScheme::CorsEnabled);
QWebEngineUrlScheme::registerScheme(foo);
QWebEngineUrlScheme::registerScheme(stream);
QWebEngineUrlScheme::registerScheme(letterto);
QWebEngineUrlScheme::registerScheme(aviancarrier);
QWebEngineUrlScheme::registerScheme(myscheme);
}
void tst_QWebEngineProfile::init()
{
//make sure defualt global profile is 'default' across all the tests
QWebEngineProfile *profile = QWebEngineProfile::defaultProfile();
QVERIFY(profile);
QVERIFY(!profile->isOffTheRecord());
QCOMPARE(profile->storageName(), QStringLiteral("Default"));
QCOMPARE(profile->httpCacheType(), QWebEngineProfile::DiskHttpCache);
QCOMPARE(profile->persistentCookiesPolicy(), QWebEngineProfile::AllowPersistentCookies);
QCOMPARE(profile->cachePath(), QStandardPaths::writableLocation(QStandardPaths::CacheLocation)
+ QStringLiteral("/QtWebEngine/Default"));
QCOMPARE(profile->persistentStoragePath(), QStandardPaths::writableLocation(QStandardPaths::DataLocation)
+ QStringLiteral("/QtWebEngine/Default"));
}
void tst_QWebEngineProfile::cleanup()
{
QWebEngineProfile *profile = QWebEngineProfile::defaultProfile();
profile->setCachePath(QString());
profile->setPersistentStoragePath(QString());
profile->setHttpCacheType(QWebEngineProfile::DiskHttpCache);
profile->removeAllUrlSchemeHandlers();
}
void tst_QWebEngineProfile::privateProfile()
{
QWebEngineProfile otrProfile;
QVERIFY(otrProfile.isOffTheRecord());
QCOMPARE(otrProfile.httpCacheType(), QWebEngineProfile::MemoryHttpCache);
QCOMPARE(otrProfile.persistentCookiesPolicy(), QWebEngineProfile::NoPersistentCookies);
QCOMPARE(otrProfile.cachePath(), QString());
QCOMPARE(otrProfile.persistentStoragePath(), QStandardPaths::writableLocation(QStandardPaths::DataLocation)
+ QStringLiteral("/QtWebEngine/OffTheRecord"));
// TBD: setters do not really work
otrProfile.setCachePath(QStringLiteral("/home/foo/bar"));
QCOMPARE(otrProfile.cachePath(), QString());
otrProfile.setPersistentStoragePath(QStringLiteral("/home/foo/bar"));
QCOMPARE(otrProfile.persistentStoragePath(), QStringLiteral("/home/foo/bar"));
otrProfile.setHttpCacheType(QWebEngineProfile::DiskHttpCache);
QCOMPARE(otrProfile.httpCacheType(), QWebEngineProfile::MemoryHttpCache);
otrProfile.setPersistentCookiesPolicy(QWebEngineProfile::ForcePersistentCookies);
QCOMPARE(otrProfile.persistentCookiesPolicy(), QWebEngineProfile::NoPersistentCookies);
}
void tst_QWebEngineProfile::testProfile()
{
QWebEngineProfile profile(QStringLiteral("Test"));
QVERIFY(!profile.isOffTheRecord());
QCOMPARE(profile.storageName(), QStringLiteral("Test"));
QCOMPARE(profile.httpCacheType(), QWebEngineProfile::DiskHttpCache);
QCOMPARE(profile.persistentCookiesPolicy(), QWebEngineProfile::AllowPersistentCookies);
QCOMPARE(profile.cachePath(), QStandardPaths::writableLocation(QStandardPaths::CacheLocation)
+ QStringLiteral("/QtWebEngine/Test"));
QCOMPARE(profile.persistentStoragePath(), QStandardPaths::writableLocation(QStandardPaths::DataLocation)
+ QStringLiteral("/QtWebEngine/Test"));
}
class AutoDir : public QDir
{
public:
AutoDir(const QString &p) : QDir(p)
{
makeAbsolute();
removeRecursively();
}
~AutoDir() { removeRecursively(); }
};
qint64 totalSize(QDir dir)
{
qint64 sum = 0;
const QDir::Filters filters{QDir::Dirs, QDir::Files, QDir::NoSymLinks, QDir::NoDotAndDotDot};
for (const QFileInfo &entry : dir.entryInfoList(filters)) {
if (entry.isFile())
sum += entry.size();
else if (entry.isDir())
sum += totalSize(entry.filePath());
}
return sum;
}
class TestServer : public HttpServer
{
public:
TestServer()
{
connect(this, &HttpServer::newRequest, this, &TestServer::onNewRequest);
}
private:
void onNewRequest(HttpReqRep *rr)
{
const QDir resourceDir(TESTS_SOURCE_DIR "qwebengineprofile/resources");
QString path = rr->requestPath();
path.remove(0, 1);
if (rr->requestMethod() != "GET" || !resourceDir.exists(path)) {
rr->sendResponse(404);
return;
}
QFile file(resourceDir.filePath(path));
file.open(QIODevice::ReadOnly);
QByteArray data = file.readAll();
rr->setResponseBody(data);
QMimeDatabase db;
QMimeType mime = db.mimeTypeForFileNameAndData(file.fileName(), data);
rr->setResponseHeader(QByteArrayLiteral("content-type"), mime.name().toUtf8());
if (!mime.inherits("text/html"))
rr->setResponseHeader(QByteArrayLiteral("cache-control"),
QByteArrayLiteral("public, max-age=31536000"));
rr->sendResponse();
}
};
void tst_QWebEngineProfile::clearDataFromCache()
{
TestServer server;
QSignalSpy serverSpy(&server, &HttpServer::newRequest);
QVERIFY(server.start());
AutoDir cacheDir("./tst_QWebEngineProfile_clearDataFromCache");
QWebEngineProfile profile(QStringLiteral("Test"));
profile.setCachePath(cacheDir.path());
profile.setHttpCacheType(QWebEngineProfile::DiskHttpCache);
QWebEnginePage page(&profile);
QVERIFY(loadSync(&page, server.url("/hedgehog.html")));
// Wait for GET /favicon.ico
QTRY_COMPARE(serverSpy.size(), 3);
QVERIFY(cacheDir.exists("Cache"));
qint64 sizeBeforeClear = totalSize(cacheDir);
profile.clearHttpCache();
// Wait for cache to be cleared.
QTest::qWait(1000);
QVERIFY(sizeBeforeClear > totalSize(cacheDir));
(void)server.stop();
}
void tst_QWebEngineProfile::disableCache()
{
TestServer server;
QVERIFY(server.start());
AutoDir cacheDir("./tst_QWebEngineProfile_disableCache");
QWebEnginePage page;
QWebEngineProfile *profile = page.profile();
profile->setCachePath(cacheDir.path());
QVERIFY(!cacheDir.exists("Cache"));
profile->setHttpCacheType(QWebEngineProfile::NoCache);
// Wait for cache to be cleared.
QTest::qWait(1000);
QVERIFY(loadSync(&page, server.url("/hedgehog.html")));
QVERIFY(!cacheDir.exists("Cache"));
profile->setHttpCacheType(QWebEngineProfile::DiskHttpCache);
QVERIFY(loadSync(&page, server.url("/hedgehog.html")));
QVERIFY(cacheDir.exists("Cache"));
(void)server.stop();
}
class RedirectingUrlSchemeHandler : public QWebEngineUrlSchemeHandler
{
public:
void requestStarted(QWebEngineUrlRequestJob *job)
{
job->redirect(QUrl(QStringLiteral("data:text/plain;charset=utf-8,")
+ job->requestUrl().fileName()));
}
};
class ReplyingUrlSchemeHandler : public QWebEngineUrlSchemeHandler
{
public:
ReplyingUrlSchemeHandler(QObject *parent = nullptr)
: QWebEngineUrlSchemeHandler(parent)
{
}
~ReplyingUrlSchemeHandler()
{
}
void requestStarted(QWebEngineUrlRequestJob *job)
{
QBuffer *buffer = new QBuffer(job);
buffer->setData(job->requestUrl().toString().toUtf8());
m_buffers.append(buffer);
job->reply("text/plain;charset=utf-8", buffer);
}
QList<QPointer<QBuffer>> m_buffers;
};
class StreamingIODevice : public QIODevice {
Q_OBJECT
public:
StreamingIODevice(QObject *parent) : QIODevice(parent), m_bytesRead(0), m_bytesAvailable(0)
{
setOpenMode(QIODevice::ReadOnly);
m_timer.start(100, this);
}
bool isSequential() const override { return true; }
qint64 bytesAvailable() const override
{
const std::lock_guard<QRecursiveMutex> lock(m_mutex);
return m_bytesAvailable;
}
bool atEnd() const override
{
const std::lock_guard<QRecursiveMutex> lock(m_mutex);
return (m_data.size() >= 1000 && m_bytesRead >= 1000);
}
protected:
void timerEvent(QTimerEvent *) override
{
const std::lock_guard<QRecursiveMutex> lock(m_mutex);
m_bytesAvailable += 200;
m_data.append(200, 'c');
emit readyRead();
if (m_data.size() >= 1000) {
m_timer.stop();
emit readChannelFinished();
}
}
qint64 readData(char *data, qint64 maxlen) override
{
const std::lock_guard<QRecursiveMutex> lock(m_mutex);
qint64 len = qMin(qint64(m_bytesAvailable), maxlen);
if (len) {
memcpy(data, m_data.constData() + m_bytesRead, len);
m_bytesAvailable -= len;
m_bytesRead += len;
} else if (atEnd())
return -1;
return len;
}
qint64 writeData(const char *, qint64) override
{
return 0;
}
private:
#if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
mutable QMutex m_mutex{QMutex::Recursive};
using QRecursiveMutex = QMutex;
#else
mutable QRecursiveMutex m_mutex;
#endif
QByteArray m_data;
QBasicTimer m_timer;
int m_bytesRead;
int m_bytesAvailable;
};
class StreamingUrlSchemeHandler : public QWebEngineUrlSchemeHandler
{
public:
StreamingUrlSchemeHandler(QObject *parent = nullptr)
: QWebEngineUrlSchemeHandler(parent)
{
}
void requestStarted(QWebEngineUrlRequestJob *job)
{
job->reply("text/plain;charset=utf-8", new StreamingIODevice(job));
}
};
void tst_QWebEngineProfile::urlSchemeHandlers()
{
RedirectingUrlSchemeHandler lettertoHandler;
QWebEngineProfile profile(QStringLiteral("urlSchemeHandlers"));
profile.installUrlSchemeHandler("letterto", &lettertoHandler);
QWebEngineView view;
view.setPage(new QWebEnginePage(&profile, &view));
view.settings()->setAttribute(QWebEngineSettings::ErrorPageEnabled, false);
QString emailAddress = QStringLiteral("egon@olsen-banden.dk");
QVERIFY(loadSync(&view, QUrl(QStringLiteral("letterto:") + emailAddress)));
QCOMPARE(toPlainTextSync(view.page()), emailAddress);
// Install a gopher handler after the view has been fully initialized.
ReplyingUrlSchemeHandler gopherHandler;
profile.installUrlSchemeHandler("gopher", &gopherHandler);
QUrl url = QUrl(QStringLiteral("gopher://olsen-banden.dk/benny"));
QVERIFY(loadSync(&view, url));
QCOMPARE(toPlainTextSync(view.page()), url.toString());
// Remove the letterto scheme, and check whether it is not handled anymore.
profile.removeUrlScheme("letterto");
emailAddress = QStringLiteral("kjeld@olsen-banden.dk");
QVERIFY(loadSync(&view, QUrl(QStringLiteral("letterto:") + emailAddress), false));
QVERIFY(toPlainTextSync(view.page()) != emailAddress);
// Check if gopher is still working after removing letterto.
url = QUrl(QStringLiteral("gopher://olsen-banden.dk/yvonne"));
QVERIFY(loadSync(&view, url));
QCOMPARE(toPlainTextSync(view.page()), url.toString());
// Does removeAll work?
profile.removeAllUrlSchemeHandlers();
url = QUrl(QStringLiteral("gopher://olsen-banden.dk/harry"));
QVERIFY(loadSync(&view, url, false));
QVERIFY(toPlainTextSync(view.page()) != url.toString());
// Install a handler that is owned by the view. Make sure this doesn't crash on shutdown.
profile.installUrlSchemeHandler("aviancarrier", new ReplyingUrlSchemeHandler(&view));
url = QUrl(QStringLiteral("aviancarrier:inspector.mortensen@politistyrke.dk"));
QVERIFY(loadSync(&view, url));
QCOMPARE(toPlainTextSync(view.page()), url.toString());
// Check that all buffers got deleted
QCOMPARE(gopherHandler.m_buffers.count(), 2);
for (int i = 0; i < gopherHandler.m_buffers.count(); ++i)
QVERIFY(gopherHandler.m_buffers.at(i).isNull());
}
class FailingUrlSchemeHandler : public QWebEngineUrlSchemeHandler
{
public:
void requestStarted(QWebEngineUrlRequestJob *job) override
{
job->fail(QWebEngineUrlRequestJob::UrlInvalid);
}
};
class FailingIODevice : public QIODevice
{
public:
FailingIODevice(QWebEngineUrlRequestJob *job) : m_job(job)
{
}
qint64 readData(char *, qint64) override
{
m_job->fail(QWebEngineUrlRequestJob::RequestFailed);
return -1;
}
qint64 writeData(const char *, qint64) override
{
m_job->fail(QWebEngineUrlRequestJob::RequestFailed);
return -1;
}
void close() override
{
QIODevice::close();
deleteLater();
}
private:
QWebEngineUrlRequestJob *m_job;
};
class FailOnReadUrlSchemeHandler : public QWebEngineUrlSchemeHandler
{
public:
void requestStarted(QWebEngineUrlRequestJob *job) override
{
job->reply(QByteArrayLiteral("text/plain"), new FailingIODevice(job));
}
};
void tst_QWebEngineProfile::urlSchemeHandlerFailRequest()
{
FailingUrlSchemeHandler handler;
QWebEngineProfile profile;
profile.installUrlSchemeHandler("foo", &handler);
QWebEngineView view;
QSignalSpy loadFinishedSpy(&view, SIGNAL(loadFinished(bool)));
view.setPage(new QWebEnginePage(&profile, &view));
view.settings()->setAttribute(QWebEngineSettings::ErrorPageEnabled, false);
view.load(QUrl(QStringLiteral("foo://bar")));
QVERIFY(loadFinishedSpy.wait());
QCOMPARE(toPlainTextSync(view.page()), QString());
}
void tst_QWebEngineProfile::urlSchemeHandlerFailOnRead()
{
FailOnReadUrlSchemeHandler handler;
QWebEngineProfile profile;
profile.installUrlSchemeHandler("foo", &handler);
QWebEngineView view;
QSignalSpy loadFinishedSpy(&view, SIGNAL(loadFinished(bool)));
view.setPage(new QWebEnginePage(&profile, &view));
view.settings()->setAttribute(QWebEngineSettings::ErrorPageEnabled, false);
view.load(QUrl(QStringLiteral("foo://bar")));
QVERIFY(loadFinishedSpy.wait());
QCOMPARE(toPlainTextSync(view.page()), QString());
}
void tst_QWebEngineProfile::urlSchemeHandlerStreaming()
{
StreamingUrlSchemeHandler handler;
QWebEngineProfile profile;
profile.installUrlSchemeHandler("stream", &handler);
QWebEngineView view;
QSignalSpy loadFinishedSpy(&view, SIGNAL(loadFinished(bool)));
view.setPage(new QWebEnginePage(&profile, &view));
view.settings()->setAttribute(QWebEngineSettings::ErrorPageEnabled, false);
view.load(QUrl(QStringLiteral("stream://whatever")));
QTRY_COMPARE_WITH_TIMEOUT(loadFinishedSpy.count(), 1, 30000);
QByteArray result;
result.append(1000, 'c');
QCOMPARE(toPlainTextSync(view.page()), QString::fromLatin1(result));
}
class ExtraHeaderInterceptor : public QWebEngineUrlRequestInterceptor
{
public:
ExtraHeaderInterceptor() { }
void setExtraHeader(const QByteArray &key, const QByteArray &value)
{
m_extraKey = key;
m_extraValue = value;
}
void interceptRequest(QWebEngineUrlRequestInfo &info) override
{
if (info.requestUrl().scheme() == QLatin1String("myscheme"))
info.setHttpHeader(m_extraKey, m_extraValue);
}
QByteArray m_extraKey;
QByteArray m_extraValue;
};
class RequestHeadersUrlSchemeHandler : public ReplyingUrlSchemeHandler
{
public:
void setExpectedHeader(const QByteArray &key, const QByteArray &value)
{
m_expectedKey = key;
m_expectedValue = value;
}
void requestStarted(QWebEngineUrlRequestJob *job) override
{
const auto requestHeaders = job->requestHeaders();
QVERIFY(requestHeaders.contains(m_expectedKey));
QCOMPARE(requestHeaders.value(m_expectedKey), m_expectedValue);
ReplyingUrlSchemeHandler::requestStarted(job);
}
QByteArray m_expectedKey;
QByteArray m_expectedValue;
};
void tst_QWebEngineProfile::urlSchemeHandlerRequestHeaders()
{
RequestHeadersUrlSchemeHandler handler;
ExtraHeaderInterceptor interceptor;
handler.setExpectedHeader("Hello", "World");
interceptor.setExtraHeader("Hello", "World");
QWebEngineProfile profile;
profile.installUrlSchemeHandler("myscheme", &handler);
profile.setUrlRequestInterceptor(&interceptor);
QWebEnginePage page(&profile);
QSignalSpy loadFinishedSpy(&page, SIGNAL(loadFinished(bool)));
page.load(QUrl(QStringLiteral("myscheme://whatever")));
QTRY_COMPARE_WITH_TIMEOUT(loadFinishedSpy.count(), 1, 30000);
}
void tst_QWebEngineProfile::urlSchemeHandlerInstallation()
{
FailingUrlSchemeHandler handler;
QWebEngineProfile profile;
// Builtin schemes that *cannot* be overridden.
for (auto scheme : { "about", "blob", "data", "javascript", "qrc", "https", "http", "file",
"ftp", "wss", "ws", "filesystem", "FileSystem" }) {
QTest::ignoreMessage(
QtWarningMsg,
QRegularExpression("Cannot install a URL scheme handler overriding internal scheme.*"));
auto prevHandler = profile.urlSchemeHandler(scheme);
profile.installUrlSchemeHandler(scheme, &handler);
QCOMPARE(profile.urlSchemeHandler(scheme), prevHandler);
}
// Builtin schemes that *can* be overridden.
for (auto scheme : { "gopher", "GOPHER" }) {
profile.installUrlSchemeHandler(scheme, &handler);
QCOMPARE(profile.urlSchemeHandler(scheme), &handler);
profile.removeUrlScheme(scheme);
}
// Other schemes should be registered with QWebEngineUrlScheme first, but
// handler installation still succeeds to preserve backwards compatibility.
QTest::ignoreMessage(
QtWarningMsg,
QRegularExpression("Please register the custom scheme.*"));
profile.installUrlSchemeHandler("tst", &handler);
QCOMPARE(profile.urlSchemeHandler("tst"), &handler);
// Existing handler cannot be overridden.
FailingUrlSchemeHandler handler2;
QTest::ignoreMessage(
QtWarningMsg,
QRegularExpression("URL scheme handler already installed.*"));
profile.installUrlSchemeHandler("tst", &handler2);
QCOMPARE(profile.urlSchemeHandler("tst"), &handler);
profile.removeUrlScheme("tst");
}
#if QT_CONFIG(webengine_webchannel)
class XhrStatusHost : public QObject
{
Q_OBJECT
public:
std::map<QUrl, int> requests;
bool isReady()
{
static const auto sig = QMetaMethod::fromSignal(&XhrStatusHost::load);
return isSignalConnected(sig);
}
Q_SIGNALS:
void load(QUrl url);
public Q_SLOTS:
void loadFinished(QUrl url, int status)
{
requests[url] = status;
}
private:
};
class XhrStatusUrlSchemeHandler : public QWebEngineUrlSchemeHandler
{
public:
void requestStarted(QWebEngineUrlRequestJob *job)
{
QString path = job->requestUrl().path();
if (path == "/") {
QBuffer *buffer = new QBuffer(job);
buffer->open(QBuffer::ReadWrite);
buffer->write(QByteArrayLiteral(R"(
<html>
<body>
<script src="qwebchannel.js"></script>
<script>
new QWebChannel(qt.webChannelTransport, (channel) => {
const host = channel.objects.host;
host.load.connect((url) => {
const xhr = new XMLHttpRequest();
xhr.onload = () => { host.loadFinished(url, xhr.status); };
xhr.onerror = () => { host.loadFinished(url, -1); };
xhr.open("GET", url, true);
xhr.send();
});
});
</script>
</body>
</html>
)"));
buffer->seek(0);
job->reply("text/html", buffer);
} else if (path == "/qwebchannel.js") {
QFile *file = new QFile(":/qtwebchannel/qwebchannel.js", job);
file->open(QFile::ReadOnly);
job->reply("application/javascript", file);
} else if (path == "/ok") {
QBuffer *buffer = new QBuffer(job);
buffer->buffer() = QByteArrayLiteral("ok");
job->reply("text/plain", buffer);
} else if (path == "/redirect") {
QUrl url = job->requestUrl();
url.setPath("/ok");
job->redirect(url);
} else if (path == "/fail") {
job->fail(QWebEngineUrlRequestJob::RequestFailed);
} else {
job->fail(QWebEngineUrlRequestJob::UrlNotFound);
}
}
};
#endif
void tst_QWebEngineProfile::urlSchemeHandlerXhrStatus()
{
#if QT_CONFIG(webengine_webchannel)
XhrStatusUrlSchemeHandler handler;
XhrStatusHost host;
QWebEngineProfile profile;
QWebEnginePage page(&profile);
QWebChannel channel;
channel.registerObject("host", &host);
profile.installUrlSchemeHandler("aviancarrier", &handler);
page.setWebChannel(&channel);
page.load(QUrl("aviancarrier:/"));
QTRY_VERIFY_WITH_TIMEOUT(host.isReady(), 30000);
host.load(QUrl("aviancarrier:/ok"));
host.load(QUrl("aviancarrier:/redirect"));
host.load(QUrl("aviancarrier:/fail"));
host.load(QUrl("aviancarrier:/notfound"));
QTRY_COMPARE(host.requests.size(), 4u);
QCOMPARE(host.requests[QUrl("aviancarrier:/ok")], 200);
QCOMPARE(host.requests[QUrl("aviancarrier:/redirect")], 200);
QCOMPARE(host.requests[QUrl("aviancarrier:/fail")], -1);
QCOMPARE(host.requests[QUrl("aviancarrier:/notfound")], -1);
#else
QSKIP("No QtWebChannel");
#endif
}
class ScriptsUrlSchemeHandler : public QWebEngineUrlSchemeHandler
{
public:
void requestStarted(QWebEngineUrlRequestJob *job)
{
auto *script = new QBuffer(job);
script->setData(QByteArrayLiteral("window.test = 'SUCCESS';"));
job->reply("text/javascript", script);
}
};
void tst_QWebEngineProfile::urlSchemeHandlerScriptModule()
{
ScriptsUrlSchemeHandler handler;
QWebEngineProfile profile;
profile.installUrlSchemeHandler("aviancarrier", &handler);
QWebEnginePage page(&profile);
QSignalSpy loadFinishedSpy(&page, SIGNAL(loadFinished(bool)));
page.setHtml(QStringLiteral("<html><head><script src=\"aviancarrier:///\"></script></head><body>Test1</body></html>"));
QTRY_COMPARE(loadFinishedSpy.count(), 1);
QCOMPARE(evaluateJavaScriptSync(&page, QStringLiteral("test")).toString(), QStringLiteral("SUCCESS"));
loadFinishedSpy.clear();
page.setHtml(QStringLiteral("<html><head><script type=\"module\" src=\"aviancarrier:///\"></script></head><body>Test2</body></html>"));
QTRY_COMPARE(loadFinishedSpy.count(), 1);
QCOMPARE(evaluateJavaScriptSync(&page, QStringLiteral("test")).toString(), QStringLiteral("SUCCESS"));
}
class LongReplyUrlSchemeHandler : public QWebEngineUrlSchemeHandler
{
public:
LongReplyUrlSchemeHandler(QObject *parent = nullptr) : QWebEngineUrlSchemeHandler(parent) {}
~LongReplyUrlSchemeHandler() {}
void requestStarted(QWebEngineUrlRequestJob *job)
{
QBuffer *buffer = new QBuffer(job);
buffer->setData(QByteArray(128 * 1024, ' ') +
"<html><head><title>Minify this!</title></head></html>");
job->reply("text/html", buffer);
}
};
void tst_QWebEngineProfile::urlSchemeHandlerLongReply()
{
LongReplyUrlSchemeHandler handler;
QWebEngineProfile profile;
profile.installUrlSchemeHandler("aviancarrier", &handler);
QWebEnginePage page(&profile);
page.load(QUrl("aviancarrier:/"));
QTRY_COMPARE(page.title(), QString("Minify this!"));
}
void tst_QWebEngineProfile::customUserAgent()
{
QString defaultUserAgent = QWebEngineProfile::defaultProfile()->httpUserAgent();
QWebEnginePage page;
QSignalSpy loadFinishedSpy(&page, SIGNAL(loadFinished(bool)));
page.setHtml(QStringLiteral("<html><body>Hello world!</body></html>"));
QTRY_COMPARE(loadFinishedSpy.count(), 1);
// First test the user-agent is default
QCOMPARE(evaluateJavaScriptSync(&page, QStringLiteral("navigator.userAgent")).toString(), defaultUserAgent);
const QString testUserAgent = QStringLiteral("tst_QWebEngineProfile 1.0");
QWebEngineProfile testProfile;
testProfile.setHttpUserAgent(testUserAgent);
// Test a new profile with custom user-agent works
QWebEnginePage page2(&testProfile);
QSignalSpy loadFinishedSpy2(&page2, SIGNAL(loadFinished(bool)));
page2.setHtml(QStringLiteral("<html><body>Hello again!</body></html>"));
QTRY_COMPARE(loadFinishedSpy2.count(), 1);
QCOMPARE(evaluateJavaScriptSync(&page2, QStringLiteral("navigator.userAgent")).toString(), testUserAgent);
QCOMPARE(evaluateJavaScriptSync(&page, QStringLiteral("navigator.userAgent")).toString(), defaultUserAgent);
// Test an existing page and profile with custom user-agent works
QWebEngineProfile::defaultProfile()->setHttpUserAgent(testUserAgent);
QCOMPARE(evaluateJavaScriptSync(&page, QStringLiteral("navigator.userAgent")).toString(), testUserAgent);
}
void tst_QWebEngineProfile::httpAcceptLanguage()
{
QWebEnginePage page;
QSignalSpy loadFinishedSpy(&page, SIGNAL(loadFinished(bool)));
page.setHtml(QStringLiteral("<html><body>Hello world!</body></html>"));
QTRY_COMPARE(loadFinishedSpy.count(), 1);
QStringList defaultLanguages = evaluateJavaScriptSync(&page, QStringLiteral("navigator.languages")).toStringList();
const QString testLang = QStringLiteral("xx-YY");
QWebEngineProfile testProfile;
testProfile.setHttpAcceptLanguage(testLang);
// Test a completely new profile
QWebEnginePage page2(&testProfile);
QSignalSpy loadFinishedSpy2(&page2, SIGNAL(loadFinished(bool)));
page2.setHtml(QStringLiteral("<html><body>Hello again!</body></html>"));
QTRY_COMPARE(loadFinishedSpy2.count(), 1);
QCOMPARE(evaluateJavaScriptSync(&page2, QStringLiteral("navigator.languages")).toStringList(), QStringList(testLang));
// Test the old one wasn't affected
QCOMPARE(evaluateJavaScriptSync(&page, QStringLiteral("navigator.languages")).toStringList(), defaultLanguages);
// Test changing an existing page and profile
QWebEngineProfile::defaultProfile()->setHttpAcceptLanguage(testLang);
QCOMPARE(evaluateJavaScriptSync(&page, QStringLiteral("navigator.languages")).toStringList(), QStringList(testLang));
}
void tst_QWebEngineProfile::downloadItem()
{
qRegisterMetaType<QWebEngineDownloadItem *>();
QWebEngineProfile testProfile;
QWebEnginePage page(&testProfile);
QSignalSpy downloadSpy(&testProfile, SIGNAL(downloadRequested(QWebEngineDownloadItem *)));
page.load(QUrl::fromLocalFile(QCoreApplication::applicationFilePath()));
QTRY_COMPARE(downloadSpy.count(), 1);
}
void tst_QWebEngineProfile::changePersistentPath()
{
TestServer server;
QVERIFY(server.start());
AutoDir dataDir1(QStandardPaths::writableLocation(QStandardPaths::DataLocation)
+ QStringLiteral("/QtWebEngine/Test"));
AutoDir dataDir2(QStandardPaths::writableLocation(QStandardPaths::DataLocation)
+ QStringLiteral("/QtWebEngine/Test2"));
QWebEngineProfile testProfile(QStringLiteral("Test"));
QCOMPARE(testProfile.persistentStoragePath(), dataDir1.path());
// Make sure the profile has been used:
QWebEnginePage page(&testProfile);
QVERIFY(loadSync(&page, server.url("/hedgehog.html")));
// Test we do not crash (QTBUG-55322):
testProfile.setPersistentStoragePath(dataDir2.path());
QCOMPARE(testProfile.persistentStoragePath(), dataDir2.path());
QVERIFY(loadSync(&page, server.url("/hedgehog.html")));
QVERIFY(dataDir2.exists());
(void)server.stop();
}
void tst_QWebEngineProfile::changeHttpUserAgent()
{
TestServer server;
QVERIFY(server.start());
QVector<QByteArray> userAgents;
connect(&server, &HttpServer::newRequest, [&](HttpReqRep *rr) {
if (rr->requestPath() == "/hedgehog.html")
userAgents.push_back(rr->requestHeader(QByteArrayLiteral("user-agent")));
});
QWebEngineProfile profile(QStringLiteral("Test"));
std::unique_ptr<QWebEnginePage> page;
page.reset(new QWebEnginePage(&profile));
QVERIFY(loadSync(page.get(), server.url("/hedgehog.html")));
page.reset();
profile.setHttpUserAgent("webturbine/42");
page.reset(new QWebEnginePage(&profile));
QVERIFY(loadSync(page.get(), server.url("/hedgehog.html")));
QCOMPARE(userAgents.size(), 2);
QCOMPARE(userAgents[1], "webturbine/42");
QVERIFY(userAgents[0] != userAgents[1]);
QVERIFY(server.stop());
}
void tst_QWebEngineProfile::changeHttpAcceptLanguage()
{
TestServer server;
QVERIFY(server.start());
QVector<QByteArray> languages;
connect(&server, &HttpServer::newRequest, [&](HttpReqRep *rr) {
if (rr->requestPath() == "/hedgehog.html")
languages.push_back(rr->requestHeader(QByteArrayLiteral("accept-language")));
});
QWebEngineProfile profile(QStringLiteral("Test"));
std::unique_ptr<QWebEnginePage> page;
page.reset(new QWebEnginePage(&profile));
QVERIFY(loadSync(page.get(), server.url("/hedgehog.html")));
page.reset();
profile.setHttpAcceptLanguage("fi");
page.reset(new QWebEnginePage(&profile));
QVERIFY(loadSync(page.get(), server.url("/hedgehog.html")));
QCOMPARE(languages.size(), 2);
QCOMPARE(languages[1], "fi");
QVERIFY(languages[0] != languages[1]);
QVERIFY(server.stop());
}
void tst_QWebEngineProfile::changeUseForGlobalCertificateVerification()
{
TestServer server;
QVERIFY(server.start());
// Check that we don't crash
QWebEngineProfile profile(QStringLiteral("Test"));
std::unique_ptr<QWebEnginePage> page;
page.reset(new QWebEnginePage(&profile));
QVERIFY(loadSync(page.get(), server.url("/hedgehog.html")));
page.reset();
profile.setUseForGlobalCertificateVerification(true);
page.reset(new QWebEnginePage(&profile));
QVERIFY(loadSync(page.get(), server.url("/hedgehog.html")));
// Don't check for error: there can be disconnects during GET hedgehog.png.
(void)server.stop();
}
void tst_QWebEngineProfile::changePersistentCookiesPolicy()
{
TestServer server;
QVERIFY(server.start());
AutoDir dataDir("./tst_QWebEngineProfile_dataDir");
QWebEngineProfile profile(QStringLiteral("Test"));
QWebEnginePage page(&profile);
profile.setPersistentStoragePath(dataDir.path());
profile.setPersistentCookiesPolicy(QWebEngineProfile::NoPersistentCookies);
QVERIFY(loadSync(&page, server.url("/hedgehog.html")));
QVERIFY(!dataDir.exists("Cookies"));
profile.setPersistentCookiesPolicy(QWebEngineProfile::ForcePersistentCookies);
QVERIFY(loadSync(&page, server.url("/hedgehog.html")));
QVERIFY(dataDir.exists("Cookies"));
(void)server.stop();
}
class InitiatorSpy : public QWebEngineUrlSchemeHandler
{
public:
QUrl initiator;
void requestStarted(QWebEngineUrlRequestJob *job) override
{
initiator = job->initiator();
job->fail(QWebEngineUrlRequestJob::RequestDenied);
}
};
void tst_QWebEngineProfile::initiator()
{
InitiatorSpy handler;
QWebEngineProfile profile;
profile.installUrlSchemeHandler("foo", &handler);
QWebEnginePage page(&profile, nullptr);
QSignalSpy loadFinishedSpy(&page, SIGNAL(loadFinished(bool)));
page.load(QUrl("about:blank"));
QTRY_COMPARE(loadFinishedSpy.count(), 1);
loadFinishedSpy.clear();
// about:blank has a unique origin, so initiator should be QUrl("null")
evaluateJavaScriptSync(&page, "window.location = 'foo:bar'");
QTRY_COMPARE(loadFinishedSpy.count(), 1);
loadFinishedSpy.clear();
QCOMPARE(handler.initiator, QUrl("null"));
page.setHtml("", QUrl("http://test:123/foo%20bar"));
QTRY_COMPARE(loadFinishedSpy.count(), 1);
loadFinishedSpy.clear();
// baseUrl determines the origin, so QUrl("http://test:123")
evaluateJavaScriptSync(&page, "window.location = 'foo:bar'");
QTRY_COMPARE(loadFinishedSpy.count(), 1);
loadFinishedSpy.clear();
QCOMPARE(handler.initiator, QUrl("http://test:123"));
// Directly calling load/setUrl should have initiator QUrl(), meaning
// browser-initiated, trusted.
page.load(QUrl("foo:bar"));
QTRY_COMPARE(loadFinishedSpy.count(), 1);
QCOMPARE(handler.initiator, QUrl());
}
void tst_QWebEngineProfile::badDeleteOrder()
{
QWebEngineProfile *profile = new QWebEngineProfile();
QWebEngineView *view = new QWebEngineView();
view->resize(640, 480);
view->show();
QVERIFY(QTest::qWaitForWindowExposed(view));
QWebEnginePage *page = new QWebEnginePage(profile, view);
view->setPage(page);
QSignalSpy spyLoadFinished(page, SIGNAL(loadFinished(bool)));
page->setHtml(QStringLiteral("<html><body><h1>Badly handled page!</h1></body></html>"));
QTRY_COMPARE(spyLoadFinished.count(), 1);
delete profile;
delete view;
}
void tst_QWebEngineProfile::qtbug_71895()
{
QWebEngineView view;
QSignalSpy loadSpy(view.page(), SIGNAL(loadFinished(bool)));
view.setUrl(QUrl("https://www.qt.io"));
view.show();
view.page()->profile()->clearHttpCache();
view.page()->profile()->setHttpCacheType(QWebEngineProfile::NoCache);
view.page()->profile()->cookieStore()->deleteAllCookies();
view.page()->profile()->setPersistentCookiesPolicy(QWebEngineProfile::NoPersistentCookies);
bool gotSignal = loadSpy.count() || loadSpy.wait(20000);
if (!gotSignal)
QSKIP("Couldn't load page from network, skipping test.");
}
QTEST_MAIN(tst_QWebEngineProfile)
#include "tst_qwebengineprofile.moc"
|