Add API for favicon database

[ChangeLog][QtWebEngineCore][QWebEngineProfile] Add new API
to access icon database asynchronously.
[ChangeLog][QtWebEngineQuick] image:/favicon/ URLs now can be used to access
icon database.

Pick-to: 6.2
Task-number: QTBUG-51184
Change-Id: I6096ad9a4210670ed59458c4fa099a02595e8a1e
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>

3 files changed, 249 insertions, 0 deletions

diff --git a/tests/auto/quick/qmltests/CMakeLists.txt b/tests/auto/quick/qmltests/CMakeLists.txt
index 487d07dc8..0a75060dc 100644
--- a/tests/auto/quick/qmltests/CMakeLists.txt
+++ b/tests/auto/quick/qmltests/CMakeLists.txt
@@ -18,6 +18,7 @@ set(testList
     tst_desktopBehaviorLoadHtml.qml
     tst_download.qml
     tst_favicon.qml
+    tst_faviconDatabase.qml
     tst_filePicker.qml
     tst_findText.qml
     tst_focusOnNavigation.qml
diff --git a/tests/auto/quick/qmltests/data/tst_faviconDatabase.qml b/tests/auto/quick/qmltests/data/tst_faviconDatabase.qml
new file mode 100644
index 000000000..181c652d7
--- /dev/null
+++ b/tests/auto/quick/qmltests/data/tst_faviconDatabase.qml
@@ -0,0 +1,235 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 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$
+**
+****************************************************************************/
+
+import QtQuick
+import QtTest
+import QtWebEngine
+import Test.util
+import "../../qmltests/data"
+
+TestWebEngineView {
+    id: webEngineView
+    width: 200
+    height: 400
+
+    TempDir { id: tempDir }
+
+    property QtObject defaultProfile: WebEngineProfile {
+        offTheRecord: true
+    }
+
+    property QtObject nonOTRProfile: WebEngineProfile {
+        persistentStoragePath: tempDir.path() + '/WebEngineFavicon'
+        offTheRecord: false
+    }
+
+    function getFaviconPixel(faviconImage) {
+        var grabImage = Qt.createQmlObject("
+                import QtQuick\n
+                Image { }", testCase)
+        var faviconCanvas = Qt.createQmlObject("
+                import QtQuick\n
+                Canvas { }", testCase)
+
+        testCase.tryVerify(function() { return faviconImage.status == Image.Ready });
+        faviconImage.grabToImage(function(result) {
+                grabImage.source = result.url
+            });
+        testCase.tryVerify(function() { return grabImage.status == Image.Ready });
+
+        faviconCanvas.width = faviconImage.width;
+        faviconCanvas.height = faviconImage.height;
+        var ctx = faviconCanvas.getContext("2d");
+        ctx.drawImage(grabImage, 0, 0, grabImage.width, grabImage.height);
+        var imageData = ctx.getImageData(Math.round(faviconCanvas.width/2),
+                                         Math.round(faviconCanvas.height/2),
+                                         faviconCanvas.width,
+                                         faviconCanvas.height);
+
+        grabImage.destroy();
+        faviconCanvas.destroy();
+
+        return imageData.data;
+    }
+
+    SignalSpy {
+        id: iconChangedSpy
+        target: webEngineView
+        signalName: "iconChanged"
+    }
+
+    TestCase {
+        id: testCase
+        name: "WebEngineFaviconDatabase"
+        when: windowShown
+
+        function init() {
+            // It is worth to restore the initial state with loading a blank page before all test functions.
+            webEngineView.url = 'about:blank';
+            verify(webEngineView.waitForLoadSucceeded());
+            iconChangedSpy.clear();
+            webEngineView.settings.touchIconsEnabled = false;
+            webEngineView.settings.autoLoadIconsForPage = true;
+        }
+
+        function cleanupTestCase() {
+            tempDir.removeRecursive(nonOTRProfile.persistentStoragePath);
+        }
+
+        function test_iconDatabase_data() {
+            return [
+                   { tag: "OTR", profile: defaultProfile },
+                   { tag: "non-OTR", profile: nonOTRProfile },
+            ];
+        }
+
+        function test_iconDatabase(row)
+        {
+            webEngineView.profile = row.profile;
+            compare(iconChangedSpy.count, 0);
+
+            var faviconImage = Qt.createQmlObject("
+                    import QtQuick\n
+                    Image { width: 16; height: 16; sourceSize: Qt.size(width, height); cache: false; }", testCase);
+
+            var pixel;
+            compare(iconChangedSpy.count, 0);
+
+            webEngineView.url = Qt.resolvedUrl("favicon.html"); // favicon.png -> 165
+            verify(webEngineView.waitForLoadSucceeded());
+
+            iconChangedSpy.wait();
+            compare(iconChangedSpy.count, 1);
+
+            var previousIcon = webEngineView.icon;
+            iconChangedSpy.clear();
+
+            webEngineView.url = Qt.resolvedUrl("favicon-shortcut.html"); // qt32.ico -> 251
+            verify(webEngineView.waitForLoadSucceeded());
+
+            tryCompare(iconChangedSpy, "count", 2);
+
+            // Icon database is not accessible with OTR profile.
+            faviconImage.source = previousIcon;
+            pixel = getFaviconPixel(faviconImage);
+            compare(pixel[0], webEngineView.profile.offTheRecord ? 0 : 165);
+
+            // This should pass with OTR too because icon is requested for the current page.
+            faviconImage.source = "image://favicon/" + Qt.resolvedUrl("favicon-shortcut.html");
+            pixel = getFaviconPixel(faviconImage);
+            compare(pixel[0], 251);
+
+            faviconImage.source = "image://favicon/" + Qt.resolvedUrl("favicon.html");
+            pixel = getFaviconPixel(faviconImage);
+            compare(pixel[0], webEngineView.profile.offTheRecord ? 0 : 165);
+
+            faviconImage.destroy();
+            webEngineView.profile = defaultProfile;
+        }
+
+        function test_iconDatabaseMultiView()
+        {
+            var pixel;
+
+            var faviconImage = Qt.createQmlObject("
+                    import QtQuick\n
+                    Image { width: 16; height: 16; sourceSize: Qt.size(width, height); cache: false; }", testCase);
+
+            var webEngineView1 = Qt.createQmlObject("
+                    import QtWebEngine\n
+                    import Test.util\n
+                    import '../../qmltests/data'\n
+                    TestWebEngineView {\n
+                        TempDir { id: tempDir }
+                        profile: WebEngineProfile {\n
+                            persistentStoragePath: tempDir.path() + '/WebEngineFavicon1'\n
+                            offTheRecord: false\n
+                        }\n
+                    }", testCase);
+
+            var webEngineView2 = Qt.createQmlObject("
+                    import QtWebEngine\n
+                    import Test.util\n
+                    import '../../qmltests/data'\n
+                    TestWebEngineView {\n
+                        TempDir { id: tempDir }
+                        profile: WebEngineProfile {\n
+                            persistentStoragePath: tempDir.path() + '/WebEngineFavicon2'\n
+                            offTheRecord: false\n
+                        }\n
+                    }", testCase);
+
+            // Moke sure the icons have not been stored in the database yet.
+            var icon1 = "image://favicon/" + Qt.resolvedUrl("icons/favicon.png");
+            faviconImage.source = icon1;
+            pixel = getFaviconPixel(faviconImage);
+            compare(pixel[0], 0);
+
+            var icon2 = "image://favicon/" + Qt.resolvedUrl("icons/qt32.ico");
+            faviconImage.source = icon2;
+            pixel = getFaviconPixel(faviconImage);
+            compare(pixel[0], 0);
+
+            webEngineView1.url = Qt.resolvedUrl("favicon.html"); // favicon.png -> 165
+            verify(webEngineView1.waitForLoadSucceeded());
+            tryCompare(webEngineView1, "icon", icon1);
+            webEngineView1.url = "about:blank";
+            verify(webEngineView1.waitForLoadSucceeded());
+
+            webEngineView2.url = Qt.resolvedUrl("favicon-shortcut.html"); // qt32.ico -> 251
+            verify(webEngineView2.waitForLoadSucceeded());
+            tryCompare(webEngineView2, "icon", icon2);
+            webEngineView2.url = "about:blank";
+            verify(webEngineView2.waitForLoadSucceeded());
+
+            faviconImage.source = "";
+            compare(webEngineView1.icon, "");
+            compare(webEngineView2.icon, "");
+
+            faviconImage.source = icon1;
+            pixel = getFaviconPixel(faviconImage);
+            compare(pixel[0], 165);
+
+            faviconImage.source = icon2;
+            pixel = getFaviconPixel(faviconImage);
+            compare(pixel[0], 251);
+
+            faviconImage.source = "image://favicon/file:///does.not.exist.ico";
+            pixel = getFaviconPixel(faviconImage);
+            compare(pixel[0], 0);
+
+            webEngineView1.destroy();
+            webEngineView2.destroy();
+            faviconImage.destroy();
+
+            tempDir.removeRecursive(webEngineView1.profile.persistentStoragePath)
+            tempDir.removeRecursive(webEngineView2.profile.persistentStoragePath)
+        }
+    }
+}
+
diff --git a/tests/auto/quick/qmltests/tst_qmltests.cpp b/tests/auto/quick/qmltests/tst_qmltests.cpp
index 689c47995..67b64c237 100644
--- a/tests/auto/quick/qmltests/tst_qmltests.cpp
+++ b/tests/auto/quick/qmltests/tst_qmltests.cpp
@@ -112,6 +112,19 @@ public:
         return tempDir.isValid() ? tempDir.path() : QString();
     }
 
+    Q_INVOKABLE void removeRecursive(const QString dirname)
+    {
+        QDir dir(dirname);
+        QFileInfoList entries(dir.entryInfoList(QDir::Dirs | QDir::Files | QDir::NoDotAndDotDot));
+        for (int i = 0; i < entries.count(); ++i) {
+            if (entries[i].isDir())
+                removeRecursive(entries[i].filePath());
+            else
+                dir.remove(entries[i].fileName());
+        }
+        QDir().rmdir(dirname);
+    }
+
 private:
     QTemporaryDir tempDir;
 };