QWebEngineUrlRequestJob: Add function to set additional reponse headers

Add additional response headers field to URLRequestCustomJobDelegate.
Those fields can be set via
QWebEngineUrlRequestJob::setAdditionalResponseHeaders(
const QMap<QByteArray, QByteArray> &
). They are added to URLRequestCustomJobProxy::m_client when
URLRequestCustomJobProxy::reply(std::string, QIODevice) is called, and
added to the response headers within
CustomURLLoaderFactory::notifyHeadersComplete().

Fixes: QTBUG-106578
Change-Id: Ie0f0af07a5381c6f24ec0a1ee1b5bcb0e8c4fa5f
Reviewed-by: Michael Brüning <michael.bruning@qt.io>

7 files changed, 39 insertions, 4 deletions

diff --git a/src/core/api/qwebengineurlrequestjob.cpp b/src/core/api/qwebengineurlrequestjob.cpp
index 6c0adfddf..099efef8e 100644
--- a/src/core/api/qwebengineurlrequestjob.cpp
+++ b/src/core/api/qwebengineurlrequestjob.cpp
@@ -112,6 +112,18 @@ QMap<QByteArray, QByteArray> QWebEngineUrlRequestJob::requestHeaders() const
 }
 
 /*!
+    \since 6.6
+    Set \a additionalResponseHeaders. These additional headers of the response
+    are only used when QWebEngineUrlRequestJob::reply(const QByteArray&, QIODevice*)
+    is called.
+*/
+void QWebEngineUrlRequestJob::setAdditionalResponseHeaders(
+        const QMap<QByteArray, QByteArray> &additionalResponseHeaders) const
+{
+    d_ptr->setAdditionalResponseHeaders(additionalResponseHeaders);
+}
+
+/*!
     Replies to the request with \a device and the content type \a contentType.
     Content type is similar to the HTTP Content-Type header, and can either be
     a MIME type, or a MIME type and charset encoding combined like this:
diff --git a/src/core/api/qwebengineurlrequestjob.h b/src/core/api/qwebengineurlrequestjob.h
index 79947ccc4..75e065566 100644
--- a/src/core/api/qwebengineurlrequestjob.h
+++ b/src/core/api/qwebengineurlrequestjob.h
@@ -43,6 +43,8 @@ public:
     void reply(const QByteArray &contentType, QIODevice *device);
     void fail(Error error);
     void redirect(const QUrl &url);
+    void setAdditionalResponseHeaders(
+            const QMap<QByteArray, QByteArray> &additionalResponseHeaders) const;
 
 private:
     QWebEngineUrlRequestJob(QtWebEngineCore::URLRequestCustomJobDelegate *);
diff --git a/src/core/net/custom_url_loader_factory.cpp b/src/core/net/custom_url_loader_factory.cpp
index 19a1a884f..bd19aa436 100644
--- a/src/core/net/custom_url_loader_factory.cpp
+++ b/src/core/net/custom_url_loader_factory.cpp
@@ -262,6 +262,11 @@ private:
                 headers += "Access-Control-Allow-Credentials: true\n";
             }
         }
+        for (auto it = m_additionalResponseHeaders.cbegin();
+             it != m_additionalResponseHeaders.cend(); ++it) {
+            headers += it.key().toLower().toStdString() + ": " + it.value().toLower().toStdString()
+                    + "\n";
+        }
         m_head->headers = base::MakeRefCounted<net::HttpResponseHeaders>(net::HttpUtil::AssembleRawHeaders(headers));
         m_head->encoded_data_length = m_head->headers->raw_headers().length();
 
diff --git a/src/core/net/url_request_custom_job_delegate.cpp b/src/core/net/url_request_custom_job_delegate.cpp
index 22d26f735..07a1de1ec 100644
--- a/src/core/net/url_request_custom_job_delegate.cpp
+++ b/src/core/net/url_request_custom_job_delegate.cpp
@@ -51,13 +51,20 @@ QMap<QByteArray, QByteArray> URLRequestCustomJobDelegate::requestHeaders() const
     return m_requestHeaders;
 }
 
+void URLRequestCustomJobDelegate::setAdditionalResponseHeaders(
+        const QMap<QByteArray, QByteArray> &additionalResponseHeaders)
+{
+    m_additionalResponseHeaders = additionalResponseHeaders;
+}
+
 void URLRequestCustomJobDelegate::reply(const QByteArray &contentType, QIODevice *device)
 {
     if (device)
         QObject::connect(device, &QIODevice::readyRead, this, &URLRequestCustomJobDelegate::slotReadyRead);
     m_proxy->m_ioTaskRunner->PostTask(FROM_HERE,
-                                      base::BindOnce(&URLRequestCustomJobProxy::reply,
-                                                     m_proxy, contentType.toStdString(),device));
+                                      base::BindOnce(&URLRequestCustomJobProxy::reply, m_proxy,
+                                                     contentType.toStdString(), device,
+                                                     std::move(m_additionalResponseHeaders)));
 }
 
 void URLRequestCustomJobDelegate::slotReadyRead()
diff --git a/src/core/net/url_request_custom_job_delegate.h b/src/core/net/url_request_custom_job_delegate.h
index 7b0d6538c..6b6ee68cf 100644
--- a/src/core/net/url_request_custom_job_delegate.h
+++ b/src/core/net/url_request_custom_job_delegate.h
@@ -48,6 +48,8 @@ public:
     QUrl initiator() const;
     QMap<QByteArray, QByteArray> requestHeaders() const;
 
+    void
+    setAdditionalResponseHeaders(const QMap<QByteArray, QByteArray> &additionalResponseHeaders);
     void reply(const QByteArray &contentType, QIODevice *device);
     void redirect(const QUrl &url);
     void abort();
@@ -69,6 +71,7 @@ private:
     QByteArray m_method;
     QUrl m_initiatorOrigin;
     const QMap<QByteArray, QByteArray> m_requestHeaders;
+    QMap<QByteArray, QByteArray> m_additionalResponseHeaders;
 };
 
 } // namespace
diff --git a/src/core/net/url_request_custom_job_proxy.cpp b/src/core/net/url_request_custom_job_proxy.cpp
index 45372f020..d7adcc7e8 100644
--- a/src/core/net/url_request_custom_job_proxy.cpp
+++ b/src/core/net/url_request_custom_job_proxy.cpp
@@ -40,7 +40,8 @@ void URLRequestCustomJobProxy::release()
     }
 }
 
-void URLRequestCustomJobProxy::reply(std::string contentType, QIODevice *device)
+void URLRequestCustomJobProxy::reply(std::string contentType, QIODevice *device,
+                                     QMap<QByteArray, QByteArray> additionalResponseHeaders)
 {
     if (!m_client)
         return;
@@ -58,6 +59,7 @@ void URLRequestCustomJobProxy::reply(std::string contentType, QIODevice *device)
     }
     m_client->m_mimeType = qcontentType.toStdString();
     m_client->m_device = device;
+    m_client->m_additionalResponseHeaders = additionalResponseHeaders;
     if (m_client->m_device && !m_client->m_device->isReadable())
         m_client->m_device->open(QIODevice::ReadOnly);
 
diff --git a/src/core/net/url_request_custom_job_proxy.h b/src/core/net/url_request_custom_job_proxy.h
index 3795f7f14..1f8c77da2 100644
--- a/src/core/net/url_request_custom_job_proxy.h
+++ b/src/core/net/url_request_custom_job_proxy.h
@@ -10,6 +10,8 @@
 #include "url/gurl.h"
 #include "url/origin.h"
 #include <QtCore/QPointer>
+#include <QMap>
+#include <QByteArray>
 
 QT_FORWARD_DECLARE_CLASS(QIODevice)
 
@@ -29,6 +31,7 @@ public:
     public:
         std::string m_mimeType;
         std::string m_charset;
+        QMap<QByteArray, QByteArray> m_additionalResponseHeaders;
         GURL m_redirect;
         QIODevice *m_device;
         int64_t m_firstBytePosition;
@@ -49,7 +52,8 @@ public:
 
     // Called from URLRequestCustomJobDelegate via post:
     //void setReplyCharset(const std::string &);
-    void reply(std::string mimeType, QIODevice *device);
+    void reply(std::string mimeType, QIODevice *device,
+               QMap<QByteArray, QByteArray> additionalResponseHeaders);
     void redirect(GURL url);
     void abort();
     void fail(int error);