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>

7 files changed, 68 insertions, 0 deletions

diff --git a/src/webenginewidgets/api/qwebenginedownloaditem.cpp b/src/webenginewidgets/api/qwebenginedownloaditem.cpp
index 6c9413280..9650f5e0e 100644
--- a/src/webenginewidgets/api/qwebenginedownloaditem.cpp
+++ b/src/webenginewidgets/api/qwebenginedownloaditem.cpp
@@ -76,6 +76,7 @@ QWebEngineDownloadItemPrivate::QWebEngineDownloadItemPrivate(QWebEngineProfilePr
     , downloadFinished(false)
     , downloadId(-1)
     , downloadState(QWebEngineDownloadItem::DownloadCancelled)
+    , savePageFormat(QWebEngineDownloadItem::MimeHtmlSaveFormat)
     , downloadUrl(url)
     , totalBytes(-1)
     , receivedBytes(0)
@@ -201,6 +202,19 @@ quint32 QWebEngineDownloadItem::id() const
 */
 
 /*!
+    \enum QWebEngineDownloadItem::SavePageFormat
+
+    This enum 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.
+*/
+
+/*!
     Returns the download item's current state.
 
     \sa QWebEngineDownloadItem::DownloadState
@@ -289,6 +303,28 @@ bool QWebEngineDownloadItem::isFinished() const
     return d->downloadFinished;
 }
 
+/*!
+    Returns the format the web page will be saved in if this is a download request for a web page.
+
+    \sa setSavePageFormat()
+*/
+QWebEngineDownloadItem::SavePageFormat QWebEngineDownloadItem::savePageFormat() const
+{
+    Q_D(const QWebEngineDownloadItem);
+    return d->savePageFormat;
+}
+
+/*!
+    Sets the format the web page will be saved in if this is a download request for a web page.
+
+    \sa savePageFormat()
+*/
+void QWebEngineDownloadItem::setSavePageFormat(QWebEngineDownloadItem::SavePageFormat format)
+{
+    Q_D(QWebEngineDownloadItem);
+    d->savePageFormat = format;
+}
+
 QWebEngineDownloadItem::QWebEngineDownloadItem(QWebEngineDownloadItemPrivate *p, QObject *parent)
     : QObject(parent)
     , d_ptr(p)
diff --git a/src/webenginewidgets/api/qwebenginedownloaditem.h b/src/webenginewidgets/api/qwebenginedownloaditem.h
index 38b9a4ad8..b0c4c2988 100644
--- a/src/webenginewidgets/api/qwebenginedownloaditem.h
+++ b/src/webenginewidgets/api/qwebenginedownloaditem.h
@@ -61,6 +61,14 @@ public:
     };
     Q_ENUM(DownloadState)
 
+    enum SavePageFormat {
+        UnknownSaveFormat = -1,
+        SingleHtmlSaveFormat,
+        CompleteHtmlSaveFormat,
+        MimeHtmlSaveFormat
+    };
+    Q_ENUM(SavePageFormat)
+
     quint32 id() const;
     DownloadState state() const;
     qint64 totalBytes() const;
@@ -69,6 +77,8 @@ public:
     QString path() const;
     void setPath(QString path);
     bool isFinished() const;
+    SavePageFormat savePageFormat() const;
+    void setSavePageFormat(SavePageFormat format);
 
 public Q_SLOTS:
     void accept();
diff --git a/src/webenginewidgets/api/qwebenginedownloaditem_p.h b/src/webenginewidgets/api/qwebenginedownloaditem_p.h
index 87dc4114a..ab38d7d03 100644
--- a/src/webenginewidgets/api/qwebenginedownloaditem_p.h
+++ b/src/webenginewidgets/api/qwebenginedownloaditem_p.h
@@ -68,6 +68,7 @@ public:
     bool downloadFinished;
     quint32 downloadId;
     QWebEngineDownloadItem::DownloadState downloadState;
+    QWebEngineDownloadItem::SavePageFormat savePageFormat;
     QString downloadPath;
     const QUrl downloadUrl;
 
diff --git a/src/webenginewidgets/api/qwebenginepage.cpp b/src/webenginewidgets/api/qwebenginepage.cpp
index 7d7ffdcf0..ee5702309 100644
--- a/src/webenginewidgets/api/qwebenginepage.cpp
+++ b/src/webenginewidgets/api/qwebenginepage.cpp
@@ -707,6 +707,9 @@ QAction *QWebEnginePage::action(WebAction action) const
     case Unselect:
         text = tr("Unselect");
         break;
+    case SavePage:
+        text = tr("Save &Page");
+        break;
     default:
         break;
     }
@@ -883,6 +886,9 @@ void QWebEnginePage::triggerAction(WebAction action, bool)
     case RequestClose:
         d->adapter->requestClose();
         break;
+    case SavePage:
+        d->adapter->save();
+        break;
     default:
         Q_UNREACHABLE();
     }
@@ -1075,6 +1081,9 @@ QMenu *QWebEnginePage::createStandardContextMenu()
         action = new QAction(QIcon::fromTheme(QStringLiteral("view-refresh")), tr("&Reload"), menu);
         connect(action, &QAction::triggered, d->view, &QWebEngineView::reload);
         menu->addAction(action);
+
+        if (!contextMenuData.linkUrl.isValid())
+            menu->addAction(QWebEnginePage::action(SavePage));
     } else {
         menu->addAction(QWebEnginePage::action(Copy));
         menu->addAction(QWebEnginePage::action(Unselect));
diff --git a/src/webenginewidgets/api/qwebenginepage.h b/src/webenginewidgets/api/qwebenginepage.h
index 69f8822b1..b3c592708 100644
--- a/src/webenginewidgets/api/qwebenginepage.h
+++ b/src/webenginewidgets/api/qwebenginepage.h
@@ -113,6 +113,7 @@ public:
         ExitFullScreen,
         RequestClose,
         Unselect,
+        SavePage,
 
         WebActionCount
     };
diff --git a/src/webenginewidgets/api/qwebengineprofile.cpp b/src/webenginewidgets/api/qwebengineprofile.cpp
index e1cde4f08..9955f7728 100644
--- a/src/webenginewidgets/api/qwebengineprofile.cpp
+++ b/src/webenginewidgets/api/qwebengineprofile.cpp
@@ -45,11 +45,17 @@
 #include "qwebenginescriptcollection_p.h"
 
 #include "browser_context_adapter.h"
+#include <qtwebenginecoreglobal.h>
 #include "web_engine_visited_links_manager.h"
 #include "web_engine_settings.h"
 
 QT_BEGIN_NAMESPACE
 
+ASSERT_ENUMS_MATCH(QWebEngineDownloadItem::UnknownSaveFormat, QtWebEngineCore::BrowserContextAdapterClient::UnknownSavePageFormat)
+ASSERT_ENUMS_MATCH(QWebEngineDownloadItem::SingleHtmlSaveFormat, QtWebEngineCore::BrowserContextAdapterClient::SingleHtmlSaveFormat)
+ASSERT_ENUMS_MATCH(QWebEngineDownloadItem::CompleteHtmlSaveFormat, QtWebEngineCore::BrowserContextAdapterClient::CompleteHtmlSaveFormat)
+ASSERT_ENUMS_MATCH(QWebEngineDownloadItem::MimeHtmlSaveFormat, QtWebEngineCore::BrowserContextAdapterClient::MimeHtmlSaveFormat)
+
 using QtWebEngineCore::BrowserContextAdapter;
 
 /*!
@@ -150,6 +156,7 @@ void QWebEngineProfilePrivate::downloadRequested(DownloadItemInfo &info)
     itemPrivate->downloadId = info.id;
     itemPrivate->downloadState = QWebEngineDownloadItem::DownloadRequested;
     itemPrivate->downloadPath = info.path;
+    itemPrivate->savePageFormat = static_cast<QWebEngineDownloadItem::SavePageFormat>(info.savePageFormat);
 
     QWebEngineDownloadItem *download = new QWebEngineDownloadItem(itemPrivate, q);
 
@@ -160,6 +167,8 @@ void QWebEngineProfilePrivate::downloadRequested(DownloadItemInfo &info)
     QWebEngineDownloadItem::DownloadState state = download->state();
 
     info.path = download->path();
+    info.savePageFormat = static_cast<QtWebEngineCore::BrowserContextAdapterClient::SavePageFormat>(
+                download->savePageFormat());
     info.accepted = state != QWebEngineDownloadItem::DownloadCancelled;
 
     if (state == QWebEngineDownloadItem::DownloadRequested) {
diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
index 1eee2d187..d3c540016 100644
--- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
@@ -123,6 +123,8 @@
            handler is run, and the user can confirm or reject to close the page. If the close
            request is confirmed, \c windowCloseRequested is emitted. (Added in Qt 5.6)
     \value Unselect Clear the current selection. (Added in Qt 5.7)
+    \value SavePage Save the current page to disk. MHTML is the default format that is used to store
+           the web page on disk. (Added in Qt 5.7)
 
     \omitvalue WebActionCount