diff options
Diffstat (limited to 'src/webenginequick/api/qquickwebengineprofile.cpp')
| -rw-r--r-- | src/webenginequick/api/qquickwebengineprofile.cpp | 351 |
1 files changed, 313 insertions, 38 deletions
diff --git a/src/webenginequick/api/qquickwebengineprofile.cpp b/src/webenginequick/api/qquickwebengineprofile.cpp index 131e59ad0..0246eb645 100644 --- a/src/webenginequick/api/qquickwebengineprofile.cpp +++ b/src/webenginequick/api/qquickwebengineprofile.cpp @@ -14,10 +14,12 @@ #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> #include <QtWebEngineCore/qwebengineurlscheme.h> +#include <QtWebEngineCore/private/qwebenginepermission_p.h> #include <QtCore/qdir.h> #include <QtCore/qfileinfo.h> @@ -94,6 +96,28 @@ QT_BEGIN_NAMESPACE */ /*! + \enum QQuickWebEngineProfile::PersistentPermissionsPolicy + + \since 6.8 + + This enum describes the policy for permission persistence: + + \value NoPersistentPermissions + The application will ask for permissions every time they're needed, regardless of + whether they've been granted before or not. This is intended for backwards compatibility + with existing applications, and otherwise not recommended. + \value PersistentPermissionsInMemory + A request will be made only the first time a permission is needed. Any subsequent + requests will be automatically granted or denied, depending on the initial user choice. + This carries over to all pages that use the same QQuickWebEngineProfile instance, until the + application is shut down. This is the setting applied if \c off-the-record is set + or no persistent data path is available. + \value PersistentPermissionsOnDisk + Works the same way as \c PersistentPermissionsInMemory, but the permissions are saved to + and restored from disk. This is the default setting. +*/ + +/*! \fn QQuickWebEngineProfile::downloadRequested(QQuickWebEngineDownloadRequest *download) This signal is emitted whenever a download has been triggered. @@ -104,6 +128,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 */ /*! @@ -112,6 +138,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 */ /*! @@ -124,8 +152,18 @@ 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) { profileAdapter->addClient(this); @@ -209,10 +247,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(); @@ -276,6 +317,12 @@ 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); @@ -318,20 +365,20 @@ QQuickWebEngineScriptCollection *QQuickWebEngineProfilePrivate::getUserScripts() whether a profile is off-the-record. Each web engine view has an associated profile. Views that do not have a specific profile set - share a common default one. + share a common one, which is off-the-record by default. */ /*! - \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). @@ -348,7 +395,21 @@ QQuickWebEngineScriptCollection *QQuickWebEngineProfilePrivate::getUserScripts() */ /*! - Constructs a new profile with the parent \a parent. + \qmlsignal WebEngineProfile::clearHttpCacheCompleted() + \since QtWebEngine 6.7 + + This signal is emitted when the clearHttpCache() operation is completed. + + \sa clearHttpCache() +*/ + +/*! + Constructs a new off-the-record profile with the parent \a parent. + + An off-the-record profile leaves no record on the local machine, and has no + persistent data or cache. Thus, the HTTP cache can only be in memory and the + cookies can only be non-persistent. Trying to change these settings will + have no effect. */ QQuickWebEngineProfile::QQuickWebEngineProfile(QObject *parent) : QObject(parent), @@ -402,15 +463,18 @@ void QQuickWebEngineProfile::setStorageName(const QString &name) if (d->profileAdapter()->storageName() == name) return; ProfileAdapter::HttpCacheType oldCacheType = d->profileAdapter()->httpCacheType(); - ProfileAdapter::PersistentCookiesPolicy oldPolicy = d->profileAdapter()->persistentCookiesPolicy(); + ProfileAdapter::PersistentCookiesPolicy oldCookiePolicy = d->profileAdapter()->persistentCookiesPolicy(); + ProfileAdapter::PersistentPermissionsPolicy oldPermissionsPolicy = d->profileAdapter()->persistentPermissionsPolicy(); d->profileAdapter()->setStorageName(name); emit storageNameChanged(); emit persistentStoragePathChanged(); emit cachePathChanged(); if (d->profileAdapter()->httpCacheType() != oldCacheType) emit httpCacheTypeChanged(); - if (d->profileAdapter()->persistentCookiesPolicy() != oldPolicy) + if (d->profileAdapter()->persistentCookiesPolicy() != oldCookiePolicy) emit persistentCookiesPolicyChanged(); + if (d->profileAdapter()->persistentPermissionsPolicy() != oldPermissionsPolicy) + emit persistentPermissionsPolicyChanged(); } /*! @@ -419,6 +483,11 @@ 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. Profile is off-the-record by default. + + Changing a profile from \e off-the-record to disk-based behavior also requires setting a + proper storageName. + + \sa storageName() */ @@ -428,6 +497,11 @@ 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. Profile is off-the-record by default. + + Changing a profile from \e off-the-record to disk-based behavior also requires setting a + proper storageName. + + \sa setStorageName() */ bool QQuickWebEngineProfile::isOffTheRecord() const @@ -442,13 +516,16 @@ void QQuickWebEngineProfile::setOffTheRecord(bool offTheRecord) if (d->profileAdapter()->isOffTheRecord() == offTheRecord) return; ProfileAdapter::HttpCacheType oldCacheType = d->profileAdapter()->httpCacheType(); - ProfileAdapter::PersistentCookiesPolicy oldPolicy = d->profileAdapter()->persistentCookiesPolicy(); + ProfileAdapter::PersistentCookiesPolicy oldCookiePolicy = d->profileAdapter()->persistentCookiesPolicy(); + ProfileAdapter::PersistentPermissionsPolicy oldPermissionsPolicy = d->profileAdapter()->persistentPermissionsPolicy(); d->profileAdapter()->setOffTheRecord(offTheRecord); emit offTheRecordChanged(); if (d->profileAdapter()->httpCacheType() != oldCacheType) emit httpCacheTypeChanged(); - if (d->profileAdapter()->persistentCookiesPolicy() != oldPolicy) + if (d->profileAdapter()->persistentCookiesPolicy() != oldCookiePolicy) emit persistentCookiesPolicyChanged(); + if (d->profileAdapter()->persistentPermissionsPolicy() != oldPermissionsPolicy) + emit persistentPermissionsPolicyChanged(); } /*! @@ -595,7 +672,7 @@ void QQuickWebEngineProfile::setHttpCacheType(QQuickWebEngineProfile::HttpCacheT /*! \qmlproperty enumeration WebEngineProfile::persistentCookiesPolicy - This enumeration describes the policy of cookie persistency: + This enumeration describes the policy of cookie persistence: \value WebEngineProfile.NoPersistentCookies Both session and persistent cookies are stored in memory. This is the only setting @@ -631,6 +708,51 @@ void QQuickWebEngineProfile::setPersistentCookiesPolicy(QQuickWebEngineProfile:: } /*! + \qmlproperty enumeration WebEngineProfile::persistentPermissionsPolicy + + \since 6.8 + + This enumeration describes the policy for permission persistence: + + \value WebEngineProfile.NoPersistentPermissions + The application will ask for permissions every time they're needed, regardless of + whether they've been granted before or not. This is intended for backwards compatibility + with existing applications, and otherwise not recommended. + \value WebEngineProfile.PersistentPermissionsInMemory + A request will be made only the first time a permission is needed. Any subsequent + requests will be automatically granted or denied, depending on the initial user choice. + This carries over to all pages using the same QWebEngineProfile instance, until the + application is shut down. This is the setting applied if \c off-the-record is set + or no persistent data path is available. + \value WebEngineProfile.PersistentPermissionsOnDisk + Works the same way as \c PersistentPermissionsInMemory, but the permissions are saved to + and restored from disk. This is the default setting. +*/ + +/*! + \property QQuickWebEngineProfile::persistentPermissionsPolicy + \since 6.8 + + Describes the policy of permission persistence. + If the profile is off-the-record, NoPersistentCookies is returned. +*/ + +QQuickWebEngineProfile::PersistentPermissionsPolicy QQuickWebEngineProfile::persistentPermissionsPolicy() const +{ + Q_D(const QQuickWebEngineProfile); + return QQuickWebEngineProfile::PersistentPermissionsPolicy(d->profileAdapter()->persistentPermissionsPolicy()); +} + +void QQuickWebEngineProfile::setPersistentPermissionsPolicy(QQuickWebEngineProfile::PersistentPermissionsPolicy newPersistentPermissionsPolicy) +{ + Q_D(QQuickWebEngineProfile); + ProfileAdapter::PersistentPermissionsPolicy oldPolicy = d->profileAdapter()->persistentPermissionsPolicy(); + d->profileAdapter()->setPersistentPermissionsPolicy(ProfileAdapter::PersistentPermissionsPolicy(newPersistentPermissionsPolicy)); + if (d->profileAdapter()->persistentPermissionsPolicy() != oldPolicy) + emit persistentPermissionsPolicyChanged(); +} + +/*! \qmlproperty int WebEngineProfile::httpCacheMaximumSize The maximum size of the HTTP cache. If \c 0, the size will be controlled automatically by @@ -821,46 +943,38 @@ QString QQuickWebEngineProfile::downloadPath() const } /*! - \qmlproperty string WebEngineProfile::pushServiceEndpoint + \qmlproperty bool WebEngineProfile::isPushServiceEnabled \since QtWebEngine 6.5 - The address used to create subscriptions for a push messaging service. - - Subscription requests for the push service will be sent to the concatenation - of \a endpoint and a subscription ID (which is provided by the browser engine). - - \note Default endpoint used by Google Chrome browser is \c {https://fcm.googleapis.com/fcm/send/} - - \note By default, the endpoint is an empty URL and push messaging is disabled. + 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::pushServiceEndpoint + \property QQuickWebEngineProfile::isPushServiceEnabled \since QtWebEngine 6.5 - The address used to create subscriptions for a push messaging service. - - Subscription requests for the push service will be sent to the concatenation - of \a endpoint and a subscription ID (which is provided by the browser engine). - - \note Default endpoint used by Google Chrome browser is \c {https://fcm.googleapis.com/fcm/send/} - - \note By default, the endpoint is an empty URL and push messaging is disabled. + 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. */ -QUrl QQuickWebEngineProfile::pushServiceEndpoint() const +bool QQuickWebEngineProfile::isPushServiceEnabled() const { const Q_D(QQuickWebEngineProfile); - return d->profileAdapter()->pushServiceEndpoint(); + return d->profileAdapter()->pushServiceEnabled(); } -void QQuickWebEngineProfile::setPushServiceEndpoint(const QUrl &endpoint) +void QQuickWebEngineProfile::setPushServiceEnabled(bool enabled) { Q_D(QQuickWebEngineProfile); - if (pushServiceEndpoint() == endpoint) + if (isPushServiceEnabled() == enabled) return; - d->profileAdapter()->setPushServiceEndpoint(endpoint); - emit pushServiceEndpointChanged(); + d->profileAdapter()->setPushServiceEnabled(enabled); + emit pushServiceEnabledChanged(); } /*! @@ -879,7 +993,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() */ /*! @@ -887,7 +1005,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() { @@ -995,6 +1117,159 @@ 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(); +} + +/*! + \fn QQuickWebEngineProfile::getPermission(const QUrl &securityOrigin, QWebEnginePermission::Feature feature) const + + Returns a QWebEnginePermission object corresponding to a single permission for the provided \a securityOrigin and + \a feature. The object may be used to query for the current state of the permission, or to change it. It is not required + for a permission to already exist; the returned object may also be used to pre-grant a permission if a website is + known to use it. + + \note This may only be used for permanent feature types. Calling it with a transient \a feature will return an invalid object. + \since 6.8 + \sa listPermissions(), QWebEnginePermission::Feature + */ + +/*! + \qmlmethod void WebEngineProfile::getPermission(url securityOrigin, WebEnginePermission.Feature feature) const + + Returns a webEnginePermission object corresponding to a single permission for the provided \a securityOrigin and + \a feature. The object may be used to query for the current state of the permission, or to change it. It is not required + for a permission to already exist; the returned object may also be used to pre-grant a permission if a website is + known to use it. + + \note This may only be used for permanent feature types. Calling it with a transient \a feature will return an invalid object. + \since 6.8 + \sa listPermissions() + */ +QWebEnginePermission QQuickWebEngineProfile::getPermission(const QUrl &securityOrigin, QWebEnginePermission::Feature feature) const +{ + Q_D(const QQuickWebEngineProfile); + + if (feature == QWebEnginePermission::Unsupported) { + qWarning("Attempting to get unsupported permission. Returned object will be in an invalid state."); + return QWebEnginePermission(new QWebEnginePermissionPrivate()); + } + + if (QWebEnginePermission::isTransient(feature)) { + qWarning() << "Attempting to get permission for feature" << feature << ". Returned object will be in an invalid state."; + return QWebEnginePermission(new QWebEnginePermissionPrivate()); + } + + auto *pvt = new QWebEnginePermissionPrivate(securityOrigin, feature, nullptr, d->profileAdapter()); + return QWebEnginePermission(pvt); +} + +/*! + \qmlmethod list<webEnginePermission> WebEngineProfile::listPermissions() const + + Returns a \l list of webEnginePermission objects, each one representing a single permission currently + present in the permissions store. The returned list contains all previously granted/denied permissions for this profile, + except for those of a transient feature type. + + \since 6.8 + \sa getPermission() + */ + +/*! + Returns a QList of QWebEnginePermission objects, each one representing a single permission currently + present in the permissions store. The returned list contains all previously granted/denied permissions for this profile, + except for those of a transient feature type. + + \since 6.8 + \sa getPermission() + */ +QList<QWebEnginePermission> QQuickWebEngineProfile::listPermissions() const +{ + Q_D(const QQuickWebEngineProfile); + if (persistentPermissionsPolicy() == NoPersistentPermissions) + return QList<QWebEnginePermission>(); + return d->profileAdapter()->listPermissions(); +} + +/*! + \qmlmethod list<webEnginePermission> WebEngineProfile::listPermissions(url securityOrigin) const + + Returns a \l list of webEnginePermission objects, each one representing a single permission currently + present in the permissions store. The returned list contains all previously granted/denied permissions associated with a + specific \a securityOrigin for this profile, except for those of a transient feature type. + + \note Since permissions are granted on a per-origin basis, the provided \a securityOrigin will be stripped to its + origin form, and the returned list will contain all permissions for the origin. Thus, passing https://www.example.com/some/page.html + is the same as passing just https://www.example.com/. + \since 6.8 + \sa getPermission() + */ + +/*! + Returns a QList of QWebEnginePermission objects, each one representing a single permission currently + present in the permissions store. The returned list contains all previously granted/denied permissions associated with a + specific \a securityOrigin for this profile, except for those of a transient feature type. + + \note Since permissions are granted on a per-origin basis, the provided \a securityOrigin will be stripped to its + origin form, and the returned list will contain all permissions for the origin. Thus, passing https://www.example.com/some/page.html + is the same as passing just https://www.example.com/. + \since 6.8 + \sa getPermission() + */ +QList<QWebEnginePermission> QQuickWebEngineProfile::listPermissions(const QUrl &securityOrigin) const +{ + Q_D(const QQuickWebEngineProfile); + if (persistentPermissionsPolicy() == NoPersistentPermissions) + return QList<QWebEnginePermission>(); + return d->profileAdapter()->listPermissions(securityOrigin); +} + +/*! + \qmlmethod list<webEnginePermission> WebEngineProfile::listPermissions(WebEnginePermission.Feature feature) const + + Returns a \l list of webEnginePermission objects, each one representing a single permission currently + present in the permissions store. The returned list contains all previously granted/denied permissions of the \a feature + type for this profile. If the feature is of a transient or unsupported type, the list will be empty. + + \since 6.8 + \sa getPermission() + */ + +/*! + Returns a QList of QWebEnginePermission objects, each one representing a single permission currently + present in the permissions store. The returned list contains all previously granted/denied permissions of the \a feature + type for this profile. If the feature is of a transient or unsupported type, the list will be empty. + + \since 6.8 + \sa getPermission(), QWebEnginePermission::Feature + */ +QList<QWebEnginePermission> QQuickWebEngineProfile::listPermissions(QWebEnginePermission::Feature feature) const +{ + Q_D(const QQuickWebEngineProfile); + if (persistentPermissionsPolicy() == NoPersistentPermissions) + return QList<QWebEnginePermission>(); + + if (feature == QWebEnginePermission::Unsupported) { + qWarning("Attempting to get permission list for an unsupported type. Returned list will be empty."); + return QList<QWebEnginePermission>(); + } + + if (QWebEnginePermission::isTransient(feature)) { + qWarning() << "Attempting to get permission list for feature" << feature << ". Returned list will be empty."; + return QList<QWebEnginePermission>(); + } + + return d->profileAdapter()->listPermissions(QUrl(), feature); +} + void QQuickWebEngineProfile::ensureQmlContext(const QObject *object) { if (!qmlContext(this)) { |