Add web action for saving the current web page

Add the possibility to save web pages as single HTML file,
complete HTML (with resource directory) or MHTML archive.

Change-Id: Ic7e7cfda9432f3534c13350a6369d79bb17fd8b3
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@theqtcompany.com>

6 files changed, 63 insertions, 0 deletions

diff --git a/src/webengine/api/qquickwebenginedownloaditem.cpp b/src/webengine/api/qquickwebenginedownloaditem.cpp
index da47388ee..6efa45e43 100644
--- a/src/webengine/api/qquickwebenginedownloaditem.cpp
+++ b/src/webengine/api/qquickwebenginedownloaditem.cpp
@@ -62,6 +62,7 @@ QQuickWebEngineDownloadItemPrivate::QQuickWebEngineDownloadItemPrivate(QQuickWeb
     : profile(p)
     , downloadId(-1)
     , downloadState(QQuickWebEngineDownloadItem::DownloadCancelled)
+    , savePageFormat(QQuickWebEngineDownloadItem::UnknownSaveFormat)
     , totalBytes(-1)
     , receivedBytes(0)
 {
@@ -249,6 +250,34 @@ void QQuickWebEngineDownloadItem::setPath(QString path)
     }
 }
 
+/*!
+    \qmlproperty enumeration WebEngineDownloadItem::savePageFormat
+
+    Describes the format that is used to save a web page.
+
+    \value UnknownSaveFormat This is not a request for downloading a complete web page.
+    \value SingleHtmlSaveFormat The page is saved as a single HTML page. Resources such as images
+           are not saved.
+    \value CompleteHtmlSaveFormat The page is saved as a complete HTML page, for example a directory
+            containing the single HTML page and the resources.
+    \value MimeHtmlSaveFormat The page is saved as a complete web page in the MIME HTML format.
+*/
+
+QQuickWebEngineDownloadItem::SavePageFormat QQuickWebEngineDownloadItem::savePageFormat() const
+{
+    Q_D(const QQuickWebEngineDownloadItem);
+    return d->savePageFormat;
+}
+
+void QQuickWebEngineDownloadItem::setSavePageFormat(QQuickWebEngineDownloadItem::SavePageFormat format)
+{
+    Q_D(QQuickWebEngineDownloadItem);
+    if (d->savePageFormat != format) {
+        d->savePageFormat = format;
+        Q_EMIT savePageFormatChanged();
+    }
+}
+
 QQuickWebEngineDownloadItem::QQuickWebEngineDownloadItem(QQuickWebEngineDownloadItemPrivate *p, QObject *parent)
     : QObject(parent)
     , d_ptr(p)
diff --git a/src/webengine/api/qquickwebenginedownloaditem_p.h b/src/webengine/api/qquickwebenginedownloaditem_p.h
index d0be2f99a..9d1a5a211 100644
--- a/src/webengine/api/qquickwebenginedownloaditem_p.h
+++ b/src/webengine/api/qquickwebenginedownloaditem_p.h
@@ -71,8 +71,17 @@ public:
     };
     Q_ENUM(DownloadState)
 
+    enum SavePageFormat {
+        UnknownSaveFormat = -1,
+        SingleHtmlSaveFormat,
+        CompleteHtmlSaveFormat,
+        MimeHtmlSaveFormat
+    };
+    Q_ENUM(SavePageFormat)
+
     Q_PROPERTY(quint32 id READ id CONSTANT FINAL)
     Q_PROPERTY(DownloadState state READ state NOTIFY stateChanged)
+    Q_PROPERTY(SavePageFormat savePageFormat READ savePageFormat WRITE setSavePageFormat NOTIFY savePageFormatChanged)
     Q_PROPERTY(qint64 totalBytes READ totalBytes NOTIFY totalBytesChanged)
     Q_PROPERTY(qint64 receivedBytes READ receivedBytes NOTIFY receivedBytesChanged)
     Q_PROPERTY(QString path READ path WRITE setPath NOTIFY pathChanged)
@@ -86,9 +95,12 @@ public:
     qint64 receivedBytes() const;
     QString path() const;
     void setPath(QString path);
+    SavePageFormat savePageFormat() const;
+    void setSavePageFormat(SavePageFormat format);
 
 Q_SIGNALS:
     void stateChanged();
+    void savePageFormatChanged();
     void receivedBytesChanged();
     void totalBytesChanged();
     void pathChanged();
diff --git a/src/webengine/api/qquickwebenginedownloaditem_p_p.h b/src/webengine/api/qquickwebenginedownloaditem_p_p.h
index 230f322b5..36b9eb349 100644
--- a/src/webengine/api/qquickwebenginedownloaditem_p_p.h
+++ b/src/webengine/api/qquickwebenginedownloaditem_p_p.h
@@ -69,6 +69,7 @@ public:
 
     quint32 downloadId;
     QQuickWebEngineDownloadItem::DownloadState downloadState;
+    QQuickWebEngineDownloadItem::SavePageFormat savePageFormat;
     qint64 totalBytes;
     qint64 receivedBytes;
     QString downloadPath;
diff --git a/src/webengine/api/qquickwebengineprofile.cpp b/src/webengine/api/qquickwebengineprofile.cpp
index 303f038a8..0c3f7400b 100644
--- a/src/webengine/api/qquickwebengineprofile.cpp
+++ b/src/webengine/api/qquickwebengineprofile.cpp
@@ -45,12 +45,18 @@
 #include <QQmlEngine>
 
 #include "browser_context_adapter.h"
+#include <qtwebenginecoreglobal.h>
 #include "web_engine_settings.h"
 
 using QtWebEngineCore::BrowserContextAdapter;
 
 QT_BEGIN_NAMESPACE
 
+ASSERT_ENUMS_MATCH(QQuickWebEngineDownloadItem::UnknownSaveFormat, QtWebEngineCore::BrowserContextAdapterClient::UnknownSavePageFormat)
+ASSERT_ENUMS_MATCH(QQuickWebEngineDownloadItem::SingleHtmlSaveFormat, QtWebEngineCore::BrowserContextAdapterClient::SingleHtmlSaveFormat)
+ASSERT_ENUMS_MATCH(QQuickWebEngineDownloadItem::CompleteHtmlSaveFormat, QtWebEngineCore::BrowserContextAdapterClient::CompleteHtmlSaveFormat)
+ASSERT_ENUMS_MATCH(QQuickWebEngineDownloadItem::MimeHtmlSaveFormat, QtWebEngineCore::BrowserContextAdapterClient::MimeHtmlSaveFormat)
+
 QQuickWebEngineProfilePrivate::QQuickWebEngineProfilePrivate(BrowserContextAdapter* browserContext)
         : m_settings(new QQuickWebEngineSettings())
         , m_browserContextRef(browserContext)
@@ -94,6 +100,8 @@ void QQuickWebEngineProfilePrivate::downloadRequested(DownloadItemInfo &info)
     itemPrivate->downloadState = QQuickWebEngineDownloadItem::DownloadRequested;
     itemPrivate->totalBytes = info.totalBytes;
     itemPrivate->downloadPath = info.path;
+    itemPrivate->savePageFormat = static_cast<QQuickWebEngineDownloadItem::SavePageFormat>(
+                info.savePageFormat);
 
     QQuickWebEngineDownloadItem *download = new QQuickWebEngineDownloadItem(itemPrivate, q);
 
@@ -104,6 +112,7 @@ void QQuickWebEngineProfilePrivate::downloadRequested(DownloadItemInfo &info)
 
     QQuickWebEngineDownloadItem::DownloadState state = download->state();
     info.path = download->path();
+    info.savePageFormat = itemPrivate->savePageFormat;
     info.accepted = state != QQuickWebEngineDownloadItem::DownloadCancelled
                       && state != QQuickWebEngineDownloadItem::DownloadRequested;
 }
diff --git a/src/webengine/api/qquickwebengineview.cpp b/src/webengine/api/qquickwebengineview.cpp
index 9e0da060e..b9fa3d605 100644
--- a/src/webengine/api/qquickwebengineview.cpp
+++ b/src/webengine/api/qquickwebengineview.cpp
@@ -205,6 +205,14 @@ bool QQuickWebEngineViewPrivate::contextMenuRequested(const WebEngineContextMenu
         item = new MenuItemHandler(menu);
         QObject::connect(item, &MenuItemHandler::triggered, q, &QQuickWebEngineView::reload);
         ui()->addMenuItem(item, QQuickWebEngineView::tr("Reload"), QStringLiteral("view-refresh"));
+
+        if (!data.linkUrl.isValid()) {
+            item = new MenuItemHandler(menu);
+            QObject::connect(item, &MenuItemHandler::triggered, [q] {
+                q->triggerWebAction(QQuickWebEngineView::SavePage);
+            });
+            ui()->addMenuItem(item, QQuickWebEngineView::tr("Save"));
+        }
     } else {
         item = new MenuItemHandler(menu);
         QObject::connect(item, &MenuItemHandler::triggered, [q] { q->triggerWebAction(QQuickWebEngineView::Copy); });
@@ -1387,6 +1395,9 @@ void QQuickWebEngineView::triggerWebAction(WebAction action)
     case RequestClose:
         d->adapter->requestClose();
         break;
+    case SavePage:
+        d->adapter->save();
+        break;
     default:
         Q_UNREACHABLE();
     }
diff --git a/src/webengine/api/qquickwebengineview_p.h b/src/webengine/api/qquickwebengineview_p.h
index 4c4192b4c..a2f937968 100644
--- a/src/webengine/api/qquickwebengineview_p.h
+++ b/src/webengine/api/qquickwebengineview_p.h
@@ -233,6 +233,7 @@ public:
         ExitFullScreen,
         RequestClose,
         Unselect,
+        SavePage,
 
         WebActionCount
     };