diff options
Diffstat (limited to 'src/webenginequick/api/qquickwebengineprofile.cpp')
| -rw-r--r-- | src/webenginequick/api/qquickwebengineprofile.cpp | 202 |
1 files changed, 142 insertions, 60 deletions
diff --git a/src/webenginequick/api/qquickwebengineprofile.cpp b/src/webenginequick/api/qquickwebengineprofile.cpp index 6944de95f..edca5e99c 100644 --- a/src/webenginequick/api/qquickwebengineprofile.cpp +++ b/src/webenginequick/api/qquickwebengineprofile.cpp @@ -1,47 +1,12 @@ -/**************************************************************************** -** -** 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:LGPL$ -** 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 Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** 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-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qquickwebengineprofile.h" #include "qquickwebengineprofile_p.h" #include "qquickwebenginedownloadrequest_p.h" #include "qquickwebenginesettings_p.h" #include "qquickwebenginescriptcollection_p.h" +#include "qquickwebenginescriptcollection_p_p.h" #include "qquickwebengineview_p_p.h" #include "profile_adapter.h" @@ -49,6 +14,7 @@ #include <QtWebEngineCore/qwebenginescriptcollection.h> #include <QtWebEngineCore/private/qwebenginescriptcollection_p.h> +#include <QtWebEngineCore/qwebengineclienthints.h> #include <QtWebEngineCore/qwebenginecookiestore.h> #include <QtWebEngineCore/qwebenginenotification.h> #include <QtWebEngineCore/private/qwebenginedownloadrequest_p.h> @@ -56,6 +22,7 @@ #include <QtCore/qdir.h> #include <QtCore/qfileinfo.h> +#include <QtQml/qqmlcontext.h> #include <QtQml/qqmlengine.h> using QtWebEngineCore::ProfileAdapter; @@ -138,6 +105,8 @@ QT_BEGIN_NAMESPACE The download item is parented by the profile. If it is not accepted, it will be deleted immediately after the signal emission. This signal cannot be used with a queued connection. + + \note To use from C++ static_cast \a download to QWebEngineDownloadRequest */ /*! @@ -146,6 +115,8 @@ QT_BEGIN_NAMESPACE This signal is emitted whenever downloading stops, because it finished successfully, was cancelled, or was interrupted (for example, because connectivity was lost). The \a download argument holds the state of the finished download instance. + + \note To use from C++ static_cast \a download to QWebEngineDownloadRequest */ /*! @@ -158,11 +129,19 @@ QT_BEGIN_NAMESPACE \sa WebEngineProfile::presentNotification */ +/*! + \fn QQuickWebEngineProfile::clearHttpCacheCompleted() + \since 6.7 + + This signal is emitted when the clearHttpCache() operation is completed. + + \sa clearHttpCache() +*/ + QQuickWebEngineProfilePrivate::QQuickWebEngineProfilePrivate(ProfileAdapter *profileAdapter) : m_settings(new QQuickWebEngineSettings()) + , m_clientHints(new QWebEngineClientHints(profileAdapter)) , m_profileAdapter(profileAdapter) - , m_scriptCollection(new QQuickWebEngineScriptCollection(new QWebEngineScriptCollection( - new QWebEngineScriptCollectionPrivate(profileAdapter->userResourceController())))) { profileAdapter->addClient(this); // Fullscreen API was implemented before the supported setting, so we must @@ -181,6 +160,8 @@ QQuickWebEngineProfilePrivate::~QQuickWebEngineProfilePrivate() if (m_profileAdapter != QtWebEngineCore::ProfileAdapter::defaultProfileAdapter()) delete m_profileAdapter; + else if (m_profileAdapter) + m_profileAdapter->releaseAllWebContentsAdapterClients(); } void QQuickWebEngineProfilePrivate::addWebContentsAdapterClient(QtWebEngineCore::WebContentsAdapterClient *adapter) @@ -205,6 +186,11 @@ QQuickWebEngineSettings *QQuickWebEngineProfilePrivate::settings() const return m_settings.data(); } +QtWebEngineCore::WebEngineSettings *QQuickWebEngineProfilePrivate::coreSettings() const +{ + return QtWebEngineCore::WebEngineSettings::get(m_settings->d_ptr.data()); +} + void QQuickWebEngineProfilePrivate::cancelDownload(quint32 downloadId) { if (m_profileAdapter) @@ -238,10 +224,13 @@ void QQuickWebEngineProfilePrivate::downloadRequested(DownloadItemInfo &info) Q_Q(QQuickWebEngineProfile); Q_ASSERT(!m_ongoingDownloads.contains(info.id)); - QWebEngineDownloadRequestPrivate *itemPrivate = new QWebEngineDownloadRequestPrivate(m_profileAdapter, info.url); + QWebEngineDownloadRequestPrivate *itemPrivate = + new QWebEngineDownloadRequestPrivate(m_profileAdapter); itemPrivate->downloadId = info.id; - itemPrivate->downloadState = QWebEngineDownloadRequest::DownloadRequested; + itemPrivate->downloadState = info.accepted ? QWebEngineDownloadRequest::DownloadInProgress + : QWebEngineDownloadRequest::DownloadRequested; itemPrivate->startTime = info.startTime; + itemPrivate->downloadUrl = info.url; itemPrivate->totalBytes = info.totalBytes; itemPrivate->mimeType = info.mimeType; itemPrivate->downloadDirectory = QFileInfo(info.path).path(); @@ -305,6 +294,27 @@ void QQuickWebEngineProfilePrivate::showNotification(QSharedPointer<QtWebEngineC Q_EMIT q->presentNotification(notification); } +void QQuickWebEngineProfilePrivate::clearHttpCacheCompleted() +{ + Q_Q(QQuickWebEngineProfile); + Q_EMIT q->clearHttpCacheCompleted(); +} + +QQuickWebEngineScriptCollection *QQuickWebEngineProfilePrivate::getUserScripts() +{ + Q_Q(QQuickWebEngineProfile); + if (!m_scriptCollection) + m_scriptCollection.reset( + new QQuickWebEngineScriptCollection( + new QQuickWebEngineScriptCollectionPrivate( + new QWebEngineScriptCollectionPrivate( + m_profileAdapter->userResourceController())))); + + if (!m_scriptCollection->qmlEngine()) + m_scriptCollection->setQmlEngine(qmlEngine(q)); + + return m_scriptCollection.data(); +} /*! \qmltype WebEngineProfile \instantiates QQuickWebEngineProfile @@ -336,16 +346,16 @@ void QQuickWebEngineProfilePrivate::showNotification(QSharedPointer<QtWebEngineC */ /*! - \qmlsignal WebEngineProfile::downloadRequested(WebEngineDownloadItem download) + \qmlsignal WebEngineProfile::downloadRequested(WebEngineDownloadRequest download) This signal is emitted whenever a download has been triggered. The \a download argument holds the state of the download. - The download has to be explicitly accepted with WebEngineDownloadItem::accept() or the + The download has to be explicitly accepted with WebEngineDownloadRequest::accept() or the download will be cancelled by default. */ /*! - \qmlsignal WebEngineProfile::downloadFinished(WebEngineDownloadItem download) + \qmlsignal WebEngineProfile::downloadFinished(WebEngineDownloadRequest download) This signal is emitted whenever downloading stops, because it finished successfully, was cancelled, or was interrupted (for example, because connectivity was lost). @@ -362,6 +372,15 @@ void QQuickWebEngineProfilePrivate::showNotification(QSharedPointer<QtWebEngineC */ /*! + \qmlsignal WebEngineProfile::clearHttpCacheCompleted() + \since QtWebEngine 6.7 + + This signal is emitted when the clearHttpCache() operation is completed. + + \sa clearHttpCache() +*/ + +/*! Constructs a new profile with the parent \a parent. */ QQuickWebEngineProfile::QQuickWebEngineProfile(QObject *parent) @@ -432,7 +451,7 @@ void QQuickWebEngineProfile::setStorageName(const QString &name) Whether the web engine profile is \e off-the-record. An off-the-record profile forces cookies, the HTTP cache, and other normally persistent data - to be stored only in memory. + to be stored only in memory. Profile is off-the-record by default. */ @@ -441,7 +460,7 @@ void QQuickWebEngineProfile::setStorageName(const QString &name) Whether the web engine profile is \e off-the-record. An off-the-record profile forces cookies, the HTTP cache, and other normally persistent data - to be stored only in memory. + to be stored only in memory. Profile is off-the-record by default. */ bool QQuickWebEngineProfile::isOffTheRecord() const @@ -472,7 +491,7 @@ void QQuickWebEngineProfile::setOffTheRecord(bool offTheRecord) stored. Persistent data includes persistent cookies, HTML5 local storage, and visited links. By default, the storage is located below - QStandardPaths::writableLocation(QStandardPaths::DataLocation) in a directory named using + QStandardPaths::writableLocation(QStandardPaths::AppDataLocation) in a directory named using storageName. */ @@ -483,7 +502,7 @@ void QQuickWebEngineProfile::setOffTheRecord(bool offTheRecord) stored. Persistent data includes persistent cookies, HTML5 local storage, and visited links. By default, the storage is located below - QStandardPaths::writableLocation(QStandardPaths::DataLocation) in a directory named using + QStandardPaths::writableLocation(QStandardPaths::AppDataLocation) in a directory named using storageName. */ @@ -576,9 +595,9 @@ void QQuickWebEngineProfile::setHttpUserAgent(const QString &userAgent) \value WebEngineProfile.MemoryHttpCache Uses an in-memory cache. This is the only setting possible if offTheRecord is set or - no persistentStoragePath is available. + no storageName is available, which is the default. \value WebEngineProfile.DiskHttpCache - Uses a disk cache. This is the default value. + Uses a disk cache. This is the default value for non off-the-record profile with storageName. \value WebEngineProfile.NoCache Disables caching. (Added in 5.7) */ @@ -588,7 +607,7 @@ void QQuickWebEngineProfile::setHttpUserAgent(const QString &userAgent) This enumeration describes the type of the HTTP cache. - If the profile is off-the-record, MemoryHttpCache is returned. + If the profile is off-the-record or has no storageName set, MemoryHttpCache is returned. */ QQuickWebEngineProfile::HttpCacheType QQuickWebEngineProfile::httpCacheType() const @@ -613,10 +632,11 @@ void QQuickWebEngineProfile::setHttpCacheType(QQuickWebEngineProfile::HttpCacheT \value WebEngineProfile.NoPersistentCookies Both session and persistent cookies are stored in memory. This is the only setting - possible if offTheRecord is set or no persistentStoragePath is available. + possible if offTheRecord is set or no storageName is available, which is the default. \value WebEngineProfile.AllowPersistentCookies Cookies marked persistent are saved to and restored from disk, whereas session cookies - are only stored to disk for crash recovery. This is the default setting. + are only stored to disk for crash recovery. + This is the default value for non off-the-record profile with storageName. \value WebEngineProfile.ForcePersistentCookies Both session and persistent cookies are saved to and restored from disk. */ @@ -708,7 +728,7 @@ void QQuickWebEngineProfile::setHttpAcceptLanguage(const QString &httpAcceptLang /*! Returns the default profile. - The default profile uses the storage name "Default". + The default profile is off-the-record. \sa storageName() */ @@ -834,6 +854,41 @@ QString QQuickWebEngineProfile::downloadPath() const } /*! + \qmlproperty bool WebEngineProfile::isPushServiceEnabled + \since QtWebEngine 6.5 + + Whether the push messaging service is enabled. + \note By default the push messaging service is disabled. + \note \QWE uses the \l {https://firebase.google.com}{Firebase Cloud Messaging (FCM)} as a browser push service. + Therefore, all push messages will go through the Google push service and its respective servers. +*/ + +/*! + \property QQuickWebEngineProfile::isPushServiceEnabled + \since QtWebEngine 6.5 + + Whether the push messaging service is enabled. + \note By default the push messaging service is disabled. + \note \QWE uses the \l {https://firebase.google.com}{Firebase Cloud Messaging (FCM)} as a browser push service. + Therefore, all push messages will go through the Google push service and its respective servers. +*/ + +bool QQuickWebEngineProfile::isPushServiceEnabled() const +{ + const Q_D(QQuickWebEngineProfile); + return d->profileAdapter()->pushServiceEnabled(); +} + +void QQuickWebEngineProfile::setPushServiceEnabled(bool enabled) +{ + Q_D(QQuickWebEngineProfile); + if (isPushServiceEnabled() == enabled) + return; + d->profileAdapter()->setPushServiceEnabled(enabled); + emit pushServiceEnabledChanged(); +} + +/*! Returns the cookie store for this profile. */ @@ -849,7 +904,11 @@ QWebEngineCookieStore *QQuickWebEngineProfile::cookieStore() const Removes the profile's cache entries. - \sa WebEngineProfile::cachePath + \note Make sure that you do not start new navigation or any operation on the profile while + the clear operation is in progress. The clearHttpCacheCompleted() signal notifies about the + completion. + + \sa WebEngineProfile::cachePath clearHttpCacheCompleted() */ /*! @@ -857,7 +916,11 @@ QWebEngineCookieStore *QQuickWebEngineProfile::cookieStore() const Removes the profile's cache entries. - \sa WebEngineProfile::clearHttpCache + \note Make sure that you do not start new navigation or any operation on the profile while + the clear operation is in progress. The clearHttpCacheCompleted() signal notifies about the + completion. + + \sa WebEngineProfile::clearHttpCache() clearHttpCacheCompleted() */ void QQuickWebEngineProfile::clearHttpCache() { @@ -938,7 +1001,7 @@ QQuickWebEngineSettings *QQuickWebEngineProfile::settings() const } /*! - \qmlproperty list<WebEngineScript> WebEngineProfile::userScripts + \qmlproperty WebEngineScriptCollection WebEngineProfile::userScripts \since 1.5 Returns the collection of WebEngineScript objects that are injected into @@ -947,8 +1010,7 @@ QQuickWebEngineSettings *QQuickWebEngineProfile::settings() const QQuickWebEngineScriptCollection *QQuickWebEngineProfile::userScripts() const { - const Q_D(QQuickWebEngineProfile); - return d->m_scriptCollection.data(); + return d_ptr->getUserScripts(); } /*! @@ -966,6 +1028,26 @@ QWebEngineClientCertificateStore *QQuickWebEngineProfile::clientCertificateStore #endif } +/*! + Return the Client Hints settings associated with this browsing context. + + \since 6.8 + \sa QWebEngineClientHints +*/ +QWebEngineClientHints *QQuickWebEngineProfile::clientHints() const +{ + Q_D(const QQuickWebEngineProfile); + return d->m_clientHints.data(); +} + +void QQuickWebEngineProfile::ensureQmlContext(const QObject *object) +{ + if (!qmlContext(this)) { + auto engine = qmlEngine(object); + QQmlEngine::setContextForObject(this, new QQmlContext(engine, engine)); + } +} + QT_END_NAMESPACE #include "moc_qquickwebengineprofile.cpp" |