diff options
Diffstat (limited to 'src/core/api')
64 files changed, 3749 insertions, 608 deletions
diff --git a/src/core/api/CMakeLists.txt b/src/core/api/CMakeLists.txt index 452569974..2a06baec6 100644 --- a/src/core/api/CMakeLists.txt +++ b/src/core/api/CMakeLists.txt @@ -1,5 +1,5 @@ # Copyright (C) 2022 The Qt Company Ltd. -# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 +# SPDX-License-Identifier: BSD-3-Clause find_package(Qt6 ${PROJECT_VERSION} REQUIRED COMPONENTS Gui Network Quick) find_package(Qt6 ${PROJECT_VERSION} QUIET OPTIONAL_COMPONENTS WebChannel Positioning) @@ -12,11 +12,14 @@ qt_internal_add_module(WebEngineCore qwebenginecertificateerror.cpp qwebenginecertificateerror.h qwebengineclientcertificateselection.cpp qwebengineclientcertificateselection.h qwebengineclientcertificatestore.cpp qwebengineclientcertificatestore.h + qwebengineclienthints.cpp qwebengineclienthints.h qwebenginecontextmenurequest.cpp qwebenginecontextmenurequest.h qwebenginecontextmenurequest_p.h qwebenginecookiestore.cpp qwebenginecookiestore.h qwebenginecookiestore_p.h + qwebenginedesktopmediarequest.cpp qwebenginedesktopmediarequest.h qwebenginedesktopmediarequest_p.h qwebenginedownloadrequest.cpp qwebenginedownloadrequest.h qwebenginedownloadrequest_p.h qwebenginefilesystemaccessrequest.cpp qwebenginefilesystemaccessrequest.h qwebenginefindtextresult.cpp qwebenginefindtextresult.h + qwebengineframe.cpp qwebengineframe.h qwebenginefullscreenrequest.cpp qwebenginefullscreenrequest.h qwebenginehistory.cpp qwebenginehistory.h qwebenginehistory_p.h qwebenginehttprequest.cpp qwebenginehttprequest.h @@ -26,6 +29,7 @@ qt_internal_add_module(WebEngineCore qwebenginenewwindowrequest.cpp qwebenginenewwindowrequest.h qwebenginenewwindowrequest_p.h qwebenginenotification.cpp qwebenginenotification.h qwebenginepage.cpp qwebenginepage.h qwebenginepage_p.h + qwebenginepermission.cpp qwebenginepermission.h qwebenginepermission_p.h qwebengineprofile.cpp qwebengineprofile.h qwebengineprofile_p.h qwebenginequotarequest.cpp qwebenginequotarequest.h qwebengineregisterprotocolhandlerrequest.cpp qwebengineregisterprotocolhandlerrequest.h @@ -33,18 +37,21 @@ qt_internal_add_module(WebEngineCore qwebenginescriptcollection.cpp qwebenginescriptcollection.h qwebenginescriptcollection_p.h qwebenginesettings.cpp qwebenginesettings.h qwebengineurlrequestinfo.cpp qwebengineurlrequestinfo.h qwebengineurlrequestinfo_p.h - qwebengineurlrequestinterceptor.h + qwebengineurlrequestinterceptor.h qwebengineurlrequestinterceptor.cpp qwebengineurlrequestjob.cpp qwebengineurlrequestjob.h qwebengineurlscheme.cpp qwebengineurlscheme.h qwebengineurlschemehandler.cpp qwebengineurlschemehandler.h + qwebengineglobalsettings.cpp qwebengineglobalsettings.h qwebengineglobalsettings_p.h + qwebenginewebauthuxrequest.cpp qwebenginewebauthuxrequest.h qwebenginewebauthuxrequest_p.h DEFINES BUILDING_CHROMIUM - NOMINMAX INCLUDE_DIRECTORIES ../ ../../3rdparty/chromium ../../3rdparty/chromium/third_party/abseil-cpp ../../3rdparty/chromium/third_party/perfetto/include + ../../3rdparty/chromium/third_party/boringssl/src/include + ../../3rdparty/chromium/base/allocator/partition_allocator/src LIBRARIES Qt::CorePrivate Qt::GuiPrivate @@ -54,15 +61,31 @@ qt_internal_add_module(WebEngineCore Qt::Gui Qt::Network Qt::Quick + EXTRA_CMAKE_FILES + "${CMAKE_CURRENT_LIST_DIR}/${INSTALL_CMAKE_NAMESPACE}WebEngineCoreDeploySupport.cmake" + NO_GENERATE_CPP_EXPORTS ) set_target_properties(WebEngineCore PROPERTIES QTWEBENGINEPROCESS_NAME ${qtWebEngineProcessName}) - +set_target_properties(WebEngineCore PROPERTIES CXX_STANDARD 20) # Chromium included headers are not clean qt_skip_warnings_are_errors(WebEngineCore) +if(MSVC AND NOT CLANG) + target_compile_options(WebEngineCore PRIVATE "/Zc:preprocessor") +endif() + if(CLANG OR GCC) - target_compile_options(WebEngineCore PRIVATE "-Wno-unused-parameter") + target_compile_options(WebEngineCore PRIVATE + "-Wno-unused-parameter" + "-Wno-expansion-to-defined" + ) +endif() + +if(GCC) + target_compile_options(WebEngineCore PRIVATE + "-Wno-packed-not-aligned" + ) endif() qt_internal_extend_target(WebEngineCore CONDITION QT_FEATURE_webengine_webchannel @@ -74,6 +97,11 @@ qt_internal_extend_target(WebEngineCore CONDITION QT_FEATURE_webengine_geolocati Qt::Positioning ) +get_install_config(config) +get_architectures(archs) +get_configs(configs) +list(GET archs 0 arch) + ## # DOCS ## @@ -82,18 +110,16 @@ qt_internal_add_docs(WebEngineCore ../doc/qtwebengine.qdocconf ) -add_custom_command( - OUTPUT chromium_attributions.qdoc - COMMAND ${Python3_EXECUTABLE} chromium/tools/licenses.py - --file-template ../core/doc/about_credits.tmpl - --entry-template ../core/doc/about_credits_entry.tmpl - credits ${CMAKE_CURRENT_BINARY_DIR}/chromium_attributions.qdoc - DEPENDS ../doc/about_credits.tmpl ../doc/about_credits_entry.tmpl - WORKING_DIRECTORY ${WEBENGINE_ROOT_SOURCE_DIR}/src/3rdparty - USES_TERMINAL +add_code_attributions_target( + TARGET generate_chromium_attributions + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/chromium_attributions.qdoc + GN_TARGET :QtWebEngineCore + FILE_TEMPLATE ../doc/about_credits.tmpl + ENTRY_TEMPLATE ../doc/about_credits_entry.tmpl + BUILDDIR ${buildDir}/${config}/${arch} ) -add_custom_target(generate_chromium_attributions DEPENDS chromium_attributions.qdoc) -add_dependencies(generate_docs_WebEngineCore generate_chromium_attributions) +add_dependencies(generate_chromium_attributions run_core_GnDone) +add_dependencies(prepare_docs_WebEngineCore generate_chromium_attributions) ## # WEBENGINECORE RESOURCES @@ -109,22 +135,49 @@ set(resourceList qtwebengine_resources.pak qtwebengine_resources_200p.pak qtwebengine_devtools_resources.pak) -get_install_config(config) -get_architectures(archs) -list(GET archs 0 arch) +set(stamps ${buildDir}/${config}/${arch}/QtWebEngineCore.stamp) + +qt_internal_get_filename_path_mode(path_mode) + +if(QT_FEATURE_webengine_v8_context_snapshot) + foreach(arch ${archs}) + foreach(config ${configs}) + if(MACOS) + set(ext_arch ".${arch}") + # QTBUG-118120 gn does not support x86_64h + if(ext_arch STREQUAL "x86_64h") + set(ext_arch "x86_64") + endif() + else() + unset(ext_arch) + endif() + if("${config}" STREQUAL "Debug") + set(ext_debug ".debug") + else() + unset(ext_debug) + endif() + get_filename_component(resSourcePath ${buildDir}/${config}/${arch}/v8_context_snapshot${ext_arch}${ext_debug}.bin ${path_mode}) + list(APPEND resourceFiles ${resSourcePath}) + if(MACOS) + set(stamps ${stamps} ${buildDir}/${config}/${arch}/obj/tools/v8_context_snapshot/v8_context_snapshot.stamp) + endif() + endforeach() + endforeach() +endif() foreach(loc ${localeList}) - get_filename_component(locSourcePath ${buildDir}/${config}/${arch}/qtwebengine_locales/${loc}.pak REALPATH) + get_filename_component(locSourcePath ${buildDir}/${config}/${arch}/qtwebengine_locales/${loc}.pak ${path_mode}) list(APPEND localeFiles ${locSourcePath}) endforeach() foreach(res ${resourceList}) - get_filename_component(resSourcePath ${buildDir}/${config}/${arch}/${res} REALPATH) + get_filename_component(resSourcePath ${buildDir}/${config}/${arch}/${res} ${path_mode}) list(APPEND resourceFiles ${resSourcePath}) endforeach() -if (NOT QT_FEATURE_webengine_system_icu) - get_filename_component(icuFile ${buildDir}/${config}/${arch}/icudtl.dat REALPATH) + +if(NOT QT_FEATURE_webengine_system_icu) + get_filename_component(icuFile ${buildDir}/${config}/${arch}/icudtl.dat ${path_mode}) list(APPEND resourceFiles ${icuFile}) set_target_properties(WebEngineCore PROPERTIES ICUDTL_FILE ${icuFile}) endif() @@ -144,7 +197,7 @@ if(QT_FEATURE_framework) GENERATED TRUE ) - add_custom_command(OUTPUT ${allResourceFiles} DEPENDS ${buildDir}/${config}/${arch}/QtWebEngineCore.stamp) + add_custom_command(OUTPUT ${allResourceFiles} DEPENDS "${stamps}") add_custom_target(generate_resources_${config} DEPENDS ${allResourceFiles}) addCopyCommand(WebEngineCore "${localeFiles}" diff --git a/src/core/api/Qt6WebEngineCoreDeploySupport.cmake b/src/core/api/Qt6WebEngineCoreDeploySupport.cmake new file mode 100644 index 000000000..e67eb212b --- /dev/null +++ b/src/core/api/Qt6WebEngineCoreDeploySupport.cmake @@ -0,0 +1,173 @@ +# Copyright (C) 2023 The Qt Company Ltd. +# SPDX-License-Identifier: BSD-3-Clause + +# NOTE: This code should only ever be executed in script mode. It expects to be +# used either as part of an install(CODE) call or called by a script +# invoked via cmake -P as a POST_BUILD step. It would not normally be +# included directly, it should be pulled in automatically by the deploy +# support set up by qtbase. + +cmake_minimum_required(VERSION 3.16...3.21) + +_qt_internal_add_deployment_hook(_qt_internal_webenginecore_deploy_hook) + +if(NOT QT_DEPLOY_WEBENGINECORE_RESOURCES_DIR) + set(QT_DEPLOY_WEBENGINECORE_RESOURCES_DIR "resources") +endif() + +function(_qt_internal_webenginecore_status_message) + if(__QT_DEPLOY_VERBOSE) + message(STATUS ${ARGV}) + endif() +endfunction() + +function(_qt_internal_webenginecore_deploy_hook) + set(no_value_options "") + set(single_value_options "") + set(multi_value_options RESOLVED_DEPENDENCIES) + cmake_parse_arguments(PARSE_ARGV 0 arg + "${no_value_options}" "${single_value_options}" "${multi_value_options}" + ) + + set(webenginecore_dependency_found FALSE) + foreach(dependency IN LISTS arg_RESOLVED_DEPENDENCIES) + if(dependency MATCHES "/libQt[0-9]+WebEngineCore[^/]+") + set(webenginecore_dependency_found TRUE) + break() + endif() + endforeach() + + if(NOT webenginecore_dependency_found) + _qt_internal_webenginecore_status_message( + "No QtWebEngineCore dependency found. " + "Skipping deployment of QtWebEngine assets." + ) + return() + endif() + + _qt_internal_deploy_webenginecore() +endfunction() + +function(_qt_internal_deploy_webenginecore) + _qt_internal_deploy_webenginecore_binary() + _qt_internal_deploy_webenginecore_data() + _qt_internal_deploy_webenginecore_translations() +endfunction() + +function(_qt_internal_deploy_webenginecore_binary) + _qt_internal_webenginecore_status_message("Deploying the WebEngineCore process binary") + + set(candidates "QtWebEngineProcess") + if(__QT_DEPLOY_ACTIVE_CONFIG STREQUAL "Debug" AND __QT_DEPLOY_SYSTEM_NAME STREQUAL "Windows") + list(PREPEND candidates "QtWebEngineProcessd") + endif() + + list(TRANSFORM candidates + PREPEND "${__QT_DEPLOY_QT_INSTALL_PREFIX}/${__QT_DEPLOY_QT_INSTALL_LIBEXECS}/" + ) + + set(process_path "") + foreach(file_path IN LISTS candidates) + if(EXISTS "${file_path}") + set(process_path "${file_path}") + break() + endif() + endforeach() + + set(install_destination "${QT_DEPLOY_PREFIX}/") + if(__QT_DEPLOY_SYSTEM_NAME STREQUAL "Windows") + string(APPEND install_destination "${QT_DEPLOY_BIN_DIR}") + else() + string(APPEND install_destination "${QT_DEPLOY_LIBEXEC_DIR}") + endif() + file(INSTALL "${process_path}" DESTINATION "${install_destination}") + + get_filename_component(process_file_name "${process_path}" NAME) + if(CMAKE_VERSION GREATER_EQUAL "3.19") + file(CHMOD "${install_destination}/${process_file_name}" + PERMISSIONS OWNER_EXECUTE OWNER_READ OWNER_WRITE + GROUP_EXECUTE GROUP_READ + WORLD_EXECUTE WORLD_READ + ) + else() + execute_process( + COMMAND chmod 0755 "${install_destination}/${process_file_name}" + ) + endif() +endfunction() + +function(_qt_internal_deploy_webenginecore_data) + _qt_internal_webenginecore_status_message("Deploying the WebEngineCore data files") + set(data_files + icudtl.dat + qtwebengine_devtools_resources.pak + qtwebengine_resources.pak + qtwebengine_resources_100p.pak + qtwebengine_resources_200p.pak + ) + get_filename_component(resources_dir "resources" ABSOLUTE + BASE_DIR "${__QT_DEPLOY_QT_INSTALL_PREFIX}/${__QT_DEPLOY_QT_INSTALL_DATA}" + ) + + _qt_internal_webenginecore_find_v8_context_snapshot( + snapshot_file + RESOURCES_DIR "${resources_dir}" + ) + if(NOT snapshot_file STREQUAL "") + list(APPEND data_files "${snapshot_file}") + endif() + + get_filename_component(install_destination "${QT_DEPLOY_WEBENGINECORE_RESOURCES_DIR}" ABSOLUTE + BASE_DIR "${QT_DEPLOY_PREFIX}/${QT_DEPLOY_DATA_DIR}" + ) + foreach(data_file IN LISTS data_files) + file(INSTALL "${resources_dir}/${data_file}" DESTINATION "${install_destination}") + endforeach() +endfunction() + +# The V8 snapshot file comes as debug or release build. Multi-config builds have both, a self-built +# Qt might only have the debug one. +# +# This function returns the file name of the V8 context snapshot file in ${out_var}. +# If no snapshot could be found, ${out_var} is the empty string. +function(_qt_internal_webenginecore_find_v8_context_snapshot out_var) + set(no_value_options "") + set(single_value_options RESOURCES_DIR) + set(multi_value_options "") + cmake_parse_arguments(PARSE_ARGV 1 arg + "${no_value_options}" "${single_value_options}" "${multi_value_options}" + ) + + set(result "") + set(candidates + v8_context_snapshot.bin + v8_context_snapshot.debug.bin + ) + if(__QT_DEPLOY_QT_IS_MULTI_CONFIG_BUILD_WITH_DEBUG + AND __QT_DEPLOY_ACTIVE_CONFIG STREQUAL "Debug") + # Favor the debug version of the snapshot. + list(REVERSE candidates) + endif() + foreach(candidate IN LISTS candidates) + if(EXISTS "${arg_RESOURCES_DIR}/${candidate}") + set(result "${candidate}") + break() + endif() + endforeach() + set("${out_var}" "${result}" PARENT_SCOPE) +endfunction() + +function(_qt_internal_deploy_webenginecore_translations) + _qt_internal_webenginecore_status_message("Deploying the WebEngineCore translations") + + get_filename_component(locales_dir "qtwebengine_locales" ABSOLUTE + BASE_DIR "${__QT_DEPLOY_QT_INSTALL_PREFIX}/${__QT_DEPLOY_QT_INSTALL_TRANSLATIONS}" + ) + get_filename_component(install_destination "qtwebengine_locales" ABSOLUTE + BASE_DIR "${QT_DEPLOY_PREFIX}/${QT_DEPLOY_TRANSLATIONS_DIR}" + ) + file(GLOB locale_files "${locales_dir}/*.pak") + foreach(locale_file IN LISTS locale_files) + file(INSTALL "${locale_file}" DESTINATION "${install_destination}") + endforeach() +endfunction() diff --git a/src/core/api/Qt6WebEngineCoreMacros.cmake b/src/core/api/Qt6WebEngineCoreMacros.cmake index 7ada4d00b..8bb731548 100644 --- a/src/core/api/Qt6WebEngineCoreMacros.cmake +++ b/src/core/api/Qt6WebEngineCoreMacros.cmake @@ -1,5 +1,11 @@ # Copyright (C) 2022 The Qt Company Ltd. -# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 +# SPDX-License-Identifier: BSD-3-Clause + +# Install support uses the CMAKE_INSTALL_xxxDIR variables. Include this here +# so that it is more likely to get pulled in earlier at a higher level, and also +# to avoid re-including it many times later +include(GNUInstallDirs) +_qt_internal_add_deploy_support("${CMAKE_CURRENT_LIST_DIR}/Qt6WebEngineCoreDeploySupport.cmake") function(qt6_add_webengine_dictionary) set(options) @@ -23,7 +29,7 @@ function(qt6_add_webengine_dictionary) set(copyCommand COMMAND ${CMAKE_COMMAND} -E copy_directory ${ARGS_OUTPUT_DIRECTORY}/dict ${ARGS_OUTPUT_DIRECTORY}/$<CONFIG> ) - elseif(isBundle) + elseif(APPLE AND isBundle) get_target_property(outputName ${ARGS_TARGET} OUTPUT_NAME) if(NOT outputName) set(outputName ${ARGS_TARGET}) diff --git a/src/core/api/configure.cmake b/src/core/api/configure.cmake index 3b859048a..f8488c057 100644 --- a/src/core/api/configure.cmake +++ b/src/core/api/configure.cmake @@ -1,17 +1,19 @@ # Copyright (C) 2022 The Qt Company Ltd. -# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 +# SPDX-License-Identifier: BSD-3-Clause #### Libraries if(NOT QT_CONFIGURE_RUNNING) - find_package(GLIB2 COMPONENTS gio) + find_package(GLIB2 COMPONENTS GIO) find_package(GSSAPI) find_package(PkgConfig) - if(PkgConfig_FOUND) + if(PkgConfig_FOUND AND QT_FEATURE_pkg_config) pkg_check_modules(ALSA alsa IMPORTED_TARGET) pkg_check_modules(PULSEAUDIO libpulse>=0.9.10 libpulse-mainloop-glib) pkg_check_modules(XDAMAGE xdamage) pkg_check_modules(POPPLER_CPP poppler-cpp IMPORTED_TARGET) + pkg_check_modules(GBM gbm) + pkg_check_modules(LIBVA libva>=1.14) if(NOT GIO_FOUND) pkg_check_modules(GIO gio-2.0) endif() @@ -62,9 +64,9 @@ qt_feature("webengine-system-alsa" PRIVATE LABEL "Use ALSA" CONDITION UNIX AND TEST_alsa ) -qt_feature("webengine-v8-snapshot-support" PRIVATE - LABEL "Building v8 snapshot supported" - CONDITION NOT UNIX OR NOT QT_FEATURE_cross_compile OR ( TEST_architecture_arch STREQUAL arm64 ) OR TEST_webengine_host_compiler +qt_feature("webengine-v8-context-snapshot" PRIVATE + LABEL "Use v8 context snapshot" + AUTODETECT NOT CMAKE_CROSSCOMPILING ) qt_feature("webengine-geolocation" PUBLIC LABEL "Geolocation" @@ -75,6 +77,12 @@ qt_feature("webengine-system-pulseaudio" PRIVATE AUTODETECT UNIX CONDITION PULSEAUDIO_FOUND ) +qt_feature("webengine-system-gbm" PRIVATE + SECTION "WebEngine" + LABEL "Use system GBM" + AUTODETECT UNIX + CONDITION GBM_FOUND +) qt_feature("webengine-printing-and-pdf" PRIVATE LABEL "Printing and PDF" PURPOSE "Provides printing and output to PDF." @@ -150,9 +158,32 @@ qt_feature("webengine-sanitizer" PRIVATE AUTODETECT CLANG CONDITION CLANG AND ECM_ENABLE_SANITIZERS ) +qt_feature("webengine-vulkan" PRIVATE + SECTION "WebEngine" + LABEL "Vulkan support" + PURPOSE "Enables support for Vulkan rendering" + CONDITION QT_FEATURE_vulkan +) +qt_feature("webengine-vaapi" PRIVATE + SECTION "WebEngine" + LABEL "VA-API support" + PURPOSE "Enables support for VA-API hardware acceleration" + AUTODETECT GBM_FOUND AND LIBVA_FOUND AND QT_FEATURE_vulkan + # hardware accelerated encoding requires bundled libvpx + CONDITION LINUX AND NOT QT_FEATURE_webengine_system_libvpx +) +list(LENGTH CMAKE_OSX_ARCHITECTURES osx_arch_count) +qt_feature("webenginedriver" PUBLIC + SECTION "WebEngine" + LABEL "Build WebEngineDriver" + PURPOSE "Enables WebEngineDriver build" + CONDITION NOT CMAKE_CROSSCOMPILING + AND NOT (CMAKE_OSX_ARCHITECTURES AND osx_arch_count GREATER 1) + DISABLE CMAKE_BUILD_TYPE STREQUAL Debug +) # internal testing feature qt_feature("webengine-system-poppler" PRIVATE - LABEL "popler" + LABEL "poppler" CONDITION UNIX AND TEST_poppler ) qt_configure_add_summary_section(NAME "Qt WebEngineCore") @@ -178,17 +209,23 @@ qt_configure_add_summary_entry( CONDITION UNIX ) qt_configure_add_summary_entry( - ARGS "webengine-v8-snapshot-support" - CONDITION UNIX AND cross_compile + ARGS "webengine-vulkan" + CONDITION QT_FEATURE_vulkan +) +qt_configure_add_summary_entry( + ARGS "webengine-vaapi" + CONDITION LINUX ) qt_configure_add_summary_entry( ARGS "webengine-system-alsa" - CONDITION UNIX + CONDITION LINUX ) qt_configure_add_summary_entry( ARGS "webengine-system-pulseaudio" - CONDITION UNIX + CONDITION LINUX ) +qt_configure_add_summary_entry(ARGS "webengine-v8-context-snapshot") +qt_configure_add_summary_entry(ARGS "webenginedriver") qt_configure_end_summary_section() # end of "Qt WebEngineCore" section if(CMAKE_CROSSCOMPILING) check_thumb(armThumb) @@ -203,11 +240,16 @@ if(CMAKE_CROSSCOMPILING) endif() qt_configure_add_report_entry( TYPE WARNING - MESSAGE "V8 snapshot cannot be built. Most likely, the 32-bit host compiler does not work. Please make sure you have 32-bit devel environment installed." - CONDITION UNIX AND cross_compile AND NOT QT_FEATURE_webengine_v8_snapshot_support + MESSAGE "WebRTC requires XDamage with qpa_xcb." + CONDITION QT_FEATURE_webengine_ozone_x11 AND NOT XDAMAGE_FOUND +) +qt_configure_add_report_entry( + TYPE WARNING + MESSAGE "VA-API is incompatible with system libvpx." + CONDITION QT_FEATURE_webengine_system_libvpx AND QT_FEATURE_webengine_vaapi ) qt_configure_add_report_entry( TYPE WARNING - MESSAGE "WebRTC requires XDamage with qpa_xcb." - CONDITION QT_FEATURE_webengine_ozone_x11 AND NOT XDAMAGE_FOUND + MESSAGE "System GBM is disabled. The bundled minigbm supports Intel only, you might need to install libgbm to avoid rendering issues." + CONDITION LINUX AND NOT QT_FEATURE_webengine_system_gbm ) diff --git a/src/core/api/qt_cmdline.cmake b/src/core/api/qt_cmdline.cmake index 4199da168..fe7092b8c 100644 --- a/src/core/api/qt_cmdline.cmake +++ b/src/core/api/qt_cmdline.cmake @@ -1,5 +1,5 @@ # Copyright (C) 2022 The Qt Company Ltd. -# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 +# SPDX-License-Identifier: BSD-3-Clause qt_commandline_option(webengine-embedded-build TYPE boolean) qt_commandline_option(webengine-pepper-plugins TYPE boolean) diff --git a/src/core/api/qtwebenginecoreglobal.cpp b/src/core/api/qtwebenginecoreglobal.cpp index e16f9c727..d5112ccb3 100644 --- a/src/core/api/qtwebenginecoreglobal.cpp +++ b/src/core/api/qtwebenginecoreglobal.cpp @@ -6,44 +6,26 @@ #include <QGuiApplication> #if QT_CONFIG(opengl) # include <QOpenGLContext> -#ifdef Q_OS_MACOS -#include <sys/types.h> -#include <sys/sysctl.h> -#include <QOffscreenSurface> -#include "macos_context_type_helper.h" -#endif #endif #include <QThread> #include <QQuickWindow> #include "web_engine_context.h" +#include "web_engine_library_info.h" -#if QT_CONFIG(opengl) +#include "base/base_paths.h" +#include "base/i18n/icu_util.h" +#include "base/path_service.h" +#include "net/base/registry_controlled_domains/registry_controlled_domain.h" + +#if QT_CONFIG(opengl) && !defined(Q_OS_MACOS) QT_BEGIN_NAMESPACE Q_GUI_EXPORT void qt_gl_set_global_share_context(QOpenGLContext *context); Q_GUI_EXPORT QOpenGLContext *qt_gl_global_share_context(); QT_END_NAMESPACE #endif -#if QT_CONFIG(opengl) -#ifdef Q_OS_MACOS -static bool needsOfflineRendererWorkaround() -{ - size_t hwmodelsize = 0; - - if (sysctlbyname("hw.model", nullptr, &hwmodelsize, nullptr, 0) == -1) - return false; - - char hwmodel[hwmodelsize]; - if (sysctlbyname("hw.model", &hwmodel, &hwmodelsize, nullptr, 0) == -1) - return false; - - return QString::fromLatin1(hwmodel) == QLatin1String("MacPro6,1"); -} -#endif -#endif - namespace QtWebEngineCore { -#if QT_CONFIG(opengl) +#if QT_CONFIG(opengl) && !defined(Q_OS_MACOS) static QOpenGLContext *shareContext; static void deleteShareContext() @@ -60,16 +42,20 @@ static void deleteShareContext() // after the QGuiApplication creation, when AA_ShareOpenGLContexts fills // the same need but the flag has to be set earlier. -Q_WEBENGINECORE_PRIVATE_EXPORT void initialize() +Q_WEBENGINECORE_EXPORT void initialize() { -#if QT_CONFIG(opengl) +#if QT_CONFIG(opengl) && !defined(Q_OS_MACOS) #ifdef Q_OS_WIN32 qputenv("QT_D3DCREATE_MULTITHREADED", "1"); #endif -#ifdef Q_OS_MACOS - if (needsOfflineRendererWorkaround()) - qputenv("QT_MAC_PRO_WEBENGINE_WORKAROUND", "1"); + auto api = QQuickWindow::graphicsApi(); + if (api != QSGRendererInterface::OpenGL +#if QT_VERSION >= QT_VERSION_CHECK(6, 4, 0) + && api != QSGRendererInterface::Vulkan && api != QSGRendererInterface::Metal + && api != QSGRendererInterface::Direct3D11 #endif + ) + QQuickWindow::setGraphicsApi(QSGRendererInterface::OpenGL); // No need to override the shared context if QApplication already set one (e.g with Qt::AA_ShareOpenGLContexts). if (!qt_gl_global_share_context()) { @@ -94,57 +80,6 @@ Q_WEBENGINECORE_PRIVATE_EXPORT void initialize() shareContext = new QOpenGLContext; QSurfaceFormat format = QSurfaceFormat::defaultFormat(); -#if defined(Q_OS_MACOS) - if (format == QSurfaceFormat()) { - QOpenGLContext testContext; - - // Chromium turns off OpenGL for CoreProfiles with versions < 4.1 - // The newest Mac that only supports 3.3 was released in Mid 2011, - // so it should be safe to request 4.1, but we still double check it - // works in order not to set an invalid default surface format. - format.setVersion(4, 1); - format.setProfile(QSurfaceFormat::CoreProfile); - - testContext.setFormat(format); - if (testContext.create()) { - QOffscreenSurface surface; - surface.setFormat(format); - surface.create(); - - if (testContext.makeCurrent(&surface)) { - // The Cocoa QPA integration allows sharing between OpenGL 3.2 and 4.1 contexts, - // which means even though we requested a 4.1 context, if we only get a 3.2 - // context, it will still work an Chromium will not black list it. - if (testContext.format().version() >= qMakePair(3, 2) - && testContext.format().profile() == QSurfaceFormat::CoreProfile - && !isCurrentContextSoftware()) { - QSurfaceFormat::setDefaultFormat(format); - } else { - qWarning("The available OpenGL surface format was either not version 3.2 " - "or higher or not a Core Profile.\n" - "Chromium on macOS will fall back to software rendering in this " - "case.\n" - "Hardware acceleration and features such as WebGL will not be " - "available."); - format = QSurfaceFormat::defaultFormat(); - } - testContext.doneCurrent(); - } - surface.destroy(); - } - } else { - // The user explicitly requested a specific surface format that does not fit Chromium's - // requirements. Warn them about this. - if (format.version() < qMakePair(3, 2) - || format.profile() != QSurfaceFormat::CoreProfile) { - qWarning("An OpenGL surfcace format was requested that is either not version 3.2 " - "or higher or a not Core Profile.\n" - "Chromium on macOS will fall back to software rendering in this case.\n" - "Hardware acceleration and features such as WebGL will not be available."); - } - } -#endif - shareContext->setFormat(format); shareContext->create(); qAddPostRoutine(deleteShareContext); @@ -154,22 +89,7 @@ Q_WEBENGINECORE_PRIVATE_EXPORT void initialize() app->setAttribute(Qt::AA_ShareOpenGLContexts); } -#if defined(Q_OS_MACOS) - // Check that the default QSurfaceFormat OpenGL profile is compatible with the global OpenGL - // shared context profile, otherwise this could lead to a nasty crash. - QSurfaceFormat sharedFormat = qt_gl_global_share_context()->format(); - QSurfaceFormat defaultFormat = QSurfaceFormat::defaultFormat(); - - if (defaultFormat.profile() != sharedFormat.profile() - && defaultFormat.profile() == QSurfaceFormat::CoreProfile - && defaultFormat.version() >= qMakePair(3, 2)) { - qFatal("QWebEngine: Default QSurfaceFormat OpenGL profile is not compatible with the " - "global shared context OpenGL profile. Please make sure you set a compatible " - "QSurfaceFormat before the QtGui application instance is created."); - } -#endif - -#endif // QT_CONFIG(opengl) +#endif // QT_CONFIG(opengl) && !defined(Q_OS_MACOS) } bool closingDown() @@ -194,21 +114,29 @@ sandbox::SandboxInterfaceInfo *staticSandboxInterfaceInfo(sandbox::SandboxInterf #endif static void initialize() { -#if QT_CONFIG(opengl) - if (QCoreApplication::instance()) { - // On window/ANGLE, calling QtWebEngineQuick::initialize from DllMain will result in a crash. - if (!qt_gl_global_share_context()) { - qWarning("Qt WebEngine seems to be initialized from a plugin. Please " - "set Qt::AA_ShareOpenGLContexts using QCoreApplication::setAttribute and " - "QSGRendererInterface::OpenGLRhi using QQuickWindow::setGraphicsApi " - "before constructing QGuiApplication."); - } - return; - } - // QCoreApplication is not yet instantiated, ensuring the call will be deferred - qAddPreRoutine(QtWebEngineCore::initialize); - QQuickWindow::setGraphicsApi(QSGRendererInterface::OpenGLRhi); +#if QT_CONFIG(opengl) && !defined(Q_OS_MACOS) + // QCoreApplication is not yet instantiated, ensuring the call will be deferred + qAddPreRoutine(QtWebEngineCore::initialize); #endif // QT_CONFIG(opengl) } +QT_BEGIN_NAMESPACE + +QString qWebEngineGetDomainAndRegistry(const QUrl &url) { + base::FilePath icuDataPath; + // Let's assume that ICU is already initialized if DIR_QT_LIBRARY_DATA is set. + if (!base::PathService::Get(base::DIR_QT_LIBRARY_DATA, &icuDataPath)) { + icuDataPath = WebEngineLibraryInfo::getPath(base::DIR_QT_LIBRARY_DATA); + if (!base::PathService::OverrideAndCreateIfNeeded(base::DIR_QT_LIBRARY_DATA, icuDataPath, false, false)) + qWarning("Failed to set ICU data path."); + base::i18n::InitializeICU(); + } + + const QString host = url.host(); + const std::string domain = net::registry_controlled_domains::GetDomainAndRegistry(host.toStdString(), net::registry_controlled_domains::INCLUDE_PRIVATE_REGISTRIES); + return QString::fromStdString(domain); +} + +QT_END_NAMESPACE + Q_CONSTRUCTOR_FUNCTION(initialize) diff --git a/src/core/api/qtwebenginecoreglobal.h b/src/core/api/qtwebenginecoreglobal.h index 305040808..0041a72be 100644 --- a/src/core/api/qtwebenginecoreglobal.h +++ b/src/core/api/qtwebenginecoreglobal.h @@ -9,6 +9,8 @@ QT_BEGIN_NAMESPACE +class QUrl; + #if defined(BUILDING_CHROMIUM) # define Q_WEBENGINECORE_EXPORT Q_DECL_EXPORT #else @@ -18,9 +20,12 @@ QT_BEGIN_NAMESPACE #define ASSERT_ENUMS_MATCH(A, B) Q_STATIC_ASSERT_X(static_cast<int>(A) == static_cast<int>(B), "The enum values must match"); Q_WEBENGINECORE_EXPORT Q_DECL_CONST_FUNCTION const char *qWebEngineVersion() noexcept; +Q_WEBENGINECORE_EXPORT Q_DECL_CONST_FUNCTION const char *qWebEngineProcessName() noexcept; Q_WEBENGINECORE_EXPORT Q_DECL_CONST_FUNCTION const char *qWebEngineChromiumVersion() noexcept; Q_WEBENGINECORE_EXPORT Q_DECL_CONST_FUNCTION const char *qWebEngineChromiumSecurityPatchVersion() noexcept; +Q_WEBENGINECORE_EXPORT QString qWebEngineGetDomainAndRegistry(const QUrl &url); + QT_END_NAMESPACE #endif // QTWEBENGINECOREGLOBAL_H diff --git a/src/core/api/qtwebenginecoreglobal_p.h b/src/core/api/qtwebenginecoreglobal_p.h index 6bd1c5a06..a63568c8a 100644 --- a/src/core/api/qtwebenginecoreglobal_p.h +++ b/src/core/api/qtwebenginecoreglobal_p.h @@ -27,18 +27,16 @@ #define QT_NOT_USED Q_UNREACHABLE(); // This will assert in debug. #endif -#define Q_WEBENGINECORE_PRIVATE_EXPORT Q_WEBENGINECORE_EXPORT - namespace QtWebEngineCore { -Q_WEBENGINECORE_PRIVATE_EXPORT int processMain(int argc, const char **argv); -Q_WEBENGINECORE_PRIVATE_EXPORT bool closingDown(); +Q_WEBENGINECORE_EXPORT int processMain(int argc, const char **argv); +Q_WEBENGINECORE_EXPORT bool closingDown(); } // namespace #if defined(Q_OS_WIN) namespace sandbox { struct SandboxInterfaceInfo; } namespace QtWebEngineSandbox { -Q_WEBENGINECORE_PRIVATE_EXPORT sandbox::SandboxInterfaceInfo *staticSandboxInterfaceInfo(sandbox::SandboxInterfaceInfo *info = nullptr); +Q_WEBENGINECORE_EXPORT sandbox::SandboxInterfaceInfo *staticSandboxInterfaceInfo(sandbox::SandboxInterfaceInfo *info = nullptr); void initializeStaticCopy(int argc, const char **argv); } #endif diff --git a/src/core/api/qwebenginecertificateerror.cpp b/src/core/api/qwebenginecertificateerror.cpp index 90d8a542d..85c5d5127 100644 --- a/src/core/api/qwebenginecertificateerror.cpp +++ b/src/core/api/qwebenginecertificateerror.cpp @@ -88,6 +88,19 @@ QUrl QWebEngineCertificateError::url() const } /*! + \property QWebEngineCertificateError::isMainFrame + \since 6.8 + + Returns whether the certificate error comes from the main frame. If false, + the error comes from a sub-resource and most likely needs to be rejected without + user input. +*/ +bool QWebEngineCertificateError::isMainFrame() const +{ + return d->isMainFrame(); +} + +/*! Returns the type of the error. \sa description(), isOverridable() diff --git a/src/core/api/qwebenginecertificateerror.h b/src/core/api/qwebenginecertificateerror.h index c4a3585f4..3eef3dcca 100644 --- a/src/core/api/qwebenginecertificateerror.h +++ b/src/core/api/qwebenginecertificateerror.h @@ -24,6 +24,7 @@ class Q_WEBENGINECORE_EXPORT QWebEngineCertificateError Q_PROPERTY(Type type READ type CONSTANT FINAL) Q_PROPERTY(QString description READ description CONSTANT FINAL) Q_PROPERTY(bool overridable READ isOverridable CONSTANT FINAL) + Q_PROPERTY(bool isMainFrame READ isMainFrame CONSTANT FINAL REVISION(6, 8)) public: QWebEngineCertificateError(const QWebEngineCertificateError &other); @@ -57,6 +58,7 @@ public: QUrl url() const; bool isOverridable() const; QString description() const; + bool isMainFrame() const; Q_INVOKABLE void defer(); Q_INVOKABLE void rejectCertificate(); diff --git a/src/core/api/qwebengineclientcertificatestore.cpp b/src/core/api/qwebengineclientcertificatestore.cpp index e7837afce..3d231c05f 100644 --- a/src/core/api/qwebengineclientcertificatestore.cpp +++ b/src/core/api/qwebengineclientcertificatestore.cpp @@ -20,7 +20,21 @@ QT_BEGIN_NAMESPACE The class allows to store client certificates in an in-memory store. When a web site requests an SSL client certificate, the QWebEnginePage::selectClientCertificate signal is emitted with matching certificates from the native certificate store or the in-memory store. - The getInstance() method can be used to access the single instance of the class. + + The class instance can be obtained with the QWebEngineProfile::clientCertificateStore() method. + + \code + QFile certFile(":/resouces/certificate.crt"); + certFile.open(QIODevice::ReadOnly); + const QSslCertificate cert(certFile.readAll(), QSsl::Pem); + + QFile keyFile(":/resources/privatekey.key"); + keyFile.open(QIODevice::ReadOnly); + const QSslKey sslKey(keyFile.readAll(), QSsl::Rsa, QSsl::Pem, QSsl::PrivateKey, ""); + + QWebEngineProfile profile; + profile.clientCertificateStore()->add(cert, sslKey); + \endcode */ QWebEngineClientCertificateStore::QWebEngineClientCertificateStore(QtWebEngineCore::ClientCertificateStoreData *storeData) @@ -54,7 +68,7 @@ void QWebEngineClientCertificateStore::add(const QSslCertificate &certificate, c QList<QSslCertificate> QWebEngineClientCertificateStore::certificates() const { QList<QSslCertificate> certificateList; - for (auto data : qAsConst(m_storeData->extraCerts)) + for (auto data : std::as_const(m_storeData->extraCerts)) certificateList.append(data->certificate); return certificateList; } diff --git a/src/core/api/qwebengineclienthints.cpp b/src/core/api/qwebengineclienthints.cpp new file mode 100644 index 000000000..907d4ae76 --- /dev/null +++ b/src/core/api/qwebengineclienthints.cpp @@ -0,0 +1,211 @@ +// Copyright (C) 2023 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 "qwebengineclienthints.h" + +#include "profile_adapter.h" + +#include <QJsonObject> + +QT_BEGIN_NAMESPACE + +/*! + \class QWebEngineClientHints + \brief The QWebEngineClientHints class provides an object to customize User-Agent Client Hints used by a profile. + + \since 6.8 + + \inmodule QtWebEngineCore + + QWebEngineClientHints allows configuration of exposing browser and platform information via + User-Agent response and request headers, and a JavaScript API. + + The information accessed via this API is split into two groups: low entropy and high entropy hints. + Low entropy hints (\l{QWebEngineClientHints::platform}{platform} and \l{QWebEngineClientHints::mobile}{mobile}) + are those that do not give away much information; the API makes these accessible with every request and they can not + be disabled by QWebEngineClientHints::setAllClientHintsEnabled. + + All the others are high entropy hints; they have the potential to give away more information, therefore they can be + disabled by QWebEngineClientHints::setAllClientHintsEnabled. + + Each profile object has its own QWebEngineClientHints object, which configures the + Client Hint settings for that browsing context. If a Client Hint is not configured for a web engine + profile, its default value is deduced from the system. + + \sa QWebEngineProfile::clientHints(), QQuickWebEngineProfile::clientHints() +*/ + +QWebEngineClientHints::QWebEngineClientHints(QtWebEngineCore::ProfileAdapter *profileAdapter) + : m_profileAdapter(profileAdapter) +{ +} + +QWebEngineClientHints::~QWebEngineClientHints() +{ +} + +/*! + \property QWebEngineClientHints::arch + The value of the \c{Sec-CH-UA-Arch} HTTP header and \c{architecture} member of NavigatorUAData in JavaScript. +*/ +QString QWebEngineClientHints::arch() const +{ + return m_profileAdapter->clientHint(QtWebEngineCore::ProfileAdapter::UAArchitecture).toString(); +} + +/*! + \property QWebEngineClientHints::platform + The value of the \c{Sec-CH-UA-Platform} HTTP header and \c{platform} member of NavigatorUAData in JavaScript. + + Can not be disabled. +*/ +QString QWebEngineClientHints::platform() const +{ + return m_profileAdapter->clientHint(QtWebEngineCore::ProfileAdapter::UAPlatform).toString(); +} + +/*! + \property QWebEngineClientHints::model + The value of the \c{Sec-CH-UA-Model} HTTP header and \c{model} member of NavigatorUAData in JavaScript. +*/ +QString QWebEngineClientHints::model() const +{ + return m_profileAdapter->clientHint(QtWebEngineCore::ProfileAdapter::UAModel).toString(); +} + +/*! + \property QWebEngineClientHints::mobile + The value of the \c{Sec-CH-UA-Mobile} HTTP header and \c{mobile} member of NavigatorUAData in JavaScript. + + Can not be disabled. +*/ +bool QWebEngineClientHints::isMobile() const +{ + return m_profileAdapter->clientHint(QtWebEngineCore::ProfileAdapter::UAMobile).toBool(); +} + +/*! + \property QWebEngineClientHints::fullVersion + The value of the \c{Sec-CH-UA-Full-Version} HTTP header and \c{uaFullVersion} member of NavigatorUAData in JavaScript. +*/ +QString QWebEngineClientHints::fullVersion() const +{ + return m_profileAdapter->clientHint(QtWebEngineCore::ProfileAdapter::UAFullVersion).toString(); +} + +/*! + \property QWebEngineClientHints::platformVersion + The value of the \c{Sec-CH-UA-Platform-Version} HTTP header and \c{platformVersion} member of NavigatorUAData in JavaScript. +*/ +QString QWebEngineClientHints::platformVersion() const +{ + return m_profileAdapter->clientHint(QtWebEngineCore::ProfileAdapter::UAPlatformVersion).toString(); +} + +/*! + \property QWebEngineClientHints::bitness + The value of the \c{Sec-CH-UA-Bitness} HTTP header and \c{bitness} member of NavigatorUAData in JavaScript. +*/ +QString QWebEngineClientHints::bitness() const +{ + return m_profileAdapter->clientHint(QtWebEngineCore::ProfileAdapter::UABitness).toString(); +} + +/*! + \property QWebEngineClientHints::fullVersionList + The value of the \c{Sec-CH-UA-Full-Version-List} HTTP header and \c{fullVersionList} member of NavigatorUAData in JavaScript. + + It holds brand name and version number pairs in a QHash. The provided values will be automatically extended by the currently used version + of Chromium and a semi-random brand. +*/ +QHash<QString,QString> QWebEngineClientHints::fullVersionList() const +{ + QHash<QString, QString> ret; + QJsonObject fullVersionList = m_profileAdapter->clientHint(QtWebEngineCore::ProfileAdapter::UAFullVersionList).toJsonObject(); + for (const QString &key : fullVersionList.keys()) + ret.insert(key, fullVersionList.value(key).toString()); + return ret; +} + +/*! + \property QWebEngineClientHints::wow64 + The value of the \c{Sec-CH-UA-Wow64} HTTP header and \c{wow64} member of NavigatorUAData in JavaScript. +*/ +bool QWebEngineClientHints::isWow64() const +{ + return m_profileAdapter->clientHint(QtWebEngineCore::ProfileAdapter::UAWOW64).toBool(); +} + +void QWebEngineClientHints::setArch(const QString &arch) +{ + m_profileAdapter->setClientHint(QtWebEngineCore::ProfileAdapter::UAArchitecture, QVariant(arch)); +} + +void QWebEngineClientHints::setPlatform(const QString &platform) +{ + m_profileAdapter->setClientHint(QtWebEngineCore::ProfileAdapter::UAPlatform, QVariant(platform)); +} + +void QWebEngineClientHints::setModel(const QString &model) +{ + m_profileAdapter->setClientHint(QtWebEngineCore::ProfileAdapter::UAModel, QVariant(model)); +} + +void QWebEngineClientHints::setIsMobile(const bool mobile) +{ + m_profileAdapter->setClientHint(QtWebEngineCore::ProfileAdapter::UAMobile, QVariant(mobile)); +} + +void QWebEngineClientHints::setFullVersion(const QString &fullVerson) +{ + m_profileAdapter->setClientHint(QtWebEngineCore::ProfileAdapter::UAFullVersion, QVariant(fullVerson)); +} + +void QWebEngineClientHints::setPlatformVersion(const QString &platformVersion) +{ + m_profileAdapter->setClientHint(QtWebEngineCore::ProfileAdapter::UAPlatformVersion, QVariant(platformVersion)); +} + +void QWebEngineClientHints::setBitness(const QString &bitness) +{ + m_profileAdapter->setClientHint(QtWebEngineCore::ProfileAdapter::UABitness, QVariant(bitness)); +} + +void QWebEngineClientHints::setFullVersionList(const QHash<QString,QString> &fullVersionList) +{ + QJsonObject jsonObject; + for (auto i = fullVersionList.cbegin(), end = fullVersionList.cend(); i != end; ++i) + jsonObject.insert(i.key(), QJsonValue(i.value())); + m_profileAdapter->setClientHint(QtWebEngineCore::ProfileAdapter::UAFullVersionList, QVariant(jsonObject)); +} + +void QWebEngineClientHints::setIsWow64(const bool wow64) +{ + m_profileAdapter->setClientHint(QtWebEngineCore::ProfileAdapter::UAWOW64, QVariant(wow64)); +} + +/*! + \property QWebEngineClientHints::isAllClientHintsEnabled + This property controls whether the Client Hints HTTP headers are sent by WebEngine or not. + + Enabled by default. +*/ +bool QWebEngineClientHints::isAllClientHintsEnabled() +{ + return m_profileAdapter->clientHintsEnabled(); +} + +void QWebEngineClientHints::setAllClientHintsEnabled(bool enabled) +{ + m_profileAdapter->setClientHintsEnabled(enabled); +} + +/*! + Resets all Client Hints settings to their default values. +*/ +void QWebEngineClientHints::resetAll() +{ + m_profileAdapter->resetClientHints(); +} + +QT_END_NAMESPACE diff --git a/src/core/api/qwebengineclienthints.h b/src/core/api/qwebengineclienthints.h new file mode 100644 index 000000000..8956b5cb6 --- /dev/null +++ b/src/core/api/qwebengineclienthints.h @@ -0,0 +1,72 @@ +// Copyright (C) 2023 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 + +#ifndef QWEBENGINECLIENTHINTS_H +#define QWEBENGINECLIENTHINTS_H + +#include <QtWebEngineCore/qtwebenginecoreglobal.h> + +#include <QtCore/qobject.h> +#include <QtCore/qhash.h> + +namespace QtWebEngineCore { +class ProfileAdapter; +} + +QT_BEGIN_NAMESPACE + +class Q_WEBENGINECORE_EXPORT QWebEngineClientHints +{ + Q_GADGET + Q_PROPERTY(QString arch READ arch WRITE setArch) + Q_PROPERTY(QString platform READ platform WRITE setPlatform) + Q_PROPERTY(QString model READ model WRITE setModel) + Q_PROPERTY(bool mobile READ isMobile WRITE setIsMobile) + Q_PROPERTY(QString fullVersion READ fullVersion WRITE setFullVersion) + Q_PROPERTY(QString platformVersion READ platformVersion WRITE setPlatformVersion) + Q_PROPERTY(QString bitness READ bitness WRITE setBitness) + Q_PROPERTY(QHash<QString,QString> fullVersionList READ fullVersionList WRITE setFullVersionList) + Q_PROPERTY(bool wow64 READ isWow64 WRITE setIsWow64) + + Q_PROPERTY(bool isAllClientHintsEnabled READ isAllClientHintsEnabled WRITE setAllClientHintsEnabled) + +public: + ~QWebEngineClientHints(); + + QString arch() const; + QString platform() const; + QString model() const; + bool isMobile() const; + QString fullVersion() const; + QString platformVersion() const; + QString bitness() const; + QHash<QString,QString> fullVersionList() const; + bool isWow64() const; + + void setArch(const QString &); + void setPlatform(const QString &); + void setModel(const QString &); + void setIsMobile(const bool); + void setFullVersion(const QString &); + void setPlatformVersion(const QString &); + void setBitness(const QString &); + void setFullVersionList(const QHash<QString,QString> &); + void setIsWow64(const bool); + + bool isAllClientHintsEnabled(); + void setAllClientHintsEnabled(bool enabled); + + void resetAll(); + +private: + explicit QWebEngineClientHints(QtWebEngineCore::ProfileAdapter *profileAdapter); + Q_DISABLE_COPY(QWebEngineClientHints) + friend class QWebEngineProfilePrivate; + friend class QQuickWebEngineProfilePrivate; + + QtWebEngineCore::ProfileAdapter *m_profileAdapter; +}; + +QT_END_NAMESPACE + +#endif // QWEBENGINECLIENTHINTS_H diff --git a/src/core/api/qwebenginecookiestore.cpp b/src/core/api/qwebenginecookiestore.cpp index c17fde475..6c4536a4a 100644 --- a/src/core/api/qwebenginecookiestore.cpp +++ b/src/core/api/qwebenginecookiestore.cpp @@ -58,7 +58,7 @@ void QWebEngineCookieStorePrivate::processPendingUserCookies() if (m_pendingUserCookies.isEmpty()) return; - for (const CookieData &cookieData : qAsConst(m_pendingUserCookies)) { + for (const CookieData &cookieData : std::as_const(m_pendingUserCookies)) { if (cookieData.wasDelete) delegate->deleteCookie(cookieData.cookie, cookieData.origin); else diff --git a/src/core/api/qwebenginecookiestore_p.h b/src/core/api/qwebenginecookiestore_p.h index ac9395301..51200436d 100644 --- a/src/core/api/qwebenginecookiestore_p.h +++ b/src/core/api/qwebenginecookiestore_p.h @@ -29,7 +29,7 @@ class CookieMonsterDelegateQt; QT_BEGIN_NAMESPACE -class Q_WEBENGINECORE_PRIVATE_EXPORT QWebEngineCookieStorePrivate +class Q_WEBENGINECORE_EXPORT QWebEngineCookieStorePrivate { Q_DECLARE_PUBLIC(QWebEngineCookieStore) struct CookieData { diff --git a/src/core/api/qwebenginedesktopmediarequest.cpp b/src/core/api/qwebenginedesktopmediarequest.cpp new file mode 100644 index 000000000..dae69a68c --- /dev/null +++ b/src/core/api/qwebenginedesktopmediarequest.cpp @@ -0,0 +1,206 @@ +// Copyright (C) 2023 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 "desktop_media_controller.h" +#include "qwebenginedesktopmediarequest.h" +#include "qwebenginedesktopmediarequest_p.h" + +QT_BEGIN_NAMESPACE + +QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QWebEngineDesktopMediaRequestPrivate) + +/*! + \class QWebEngineDesktopMediaRequest + \brief A request for populating a dialog with available sources for screen capturing. + + \since 6.7 + + \inmodule QtWebEngineCore + + To allow web applications to capture contents of a display, applications must connect + to QWebEnginePage::desktopMediaRequested, which takes a QWebEngineDesktopMediaRequest + instance as an argument. + + If a web application requests access to the contents of a display, + QWebEnginePage::desktopMediaRequested will be emitted with a + QWebEngineDesktopMediaRequest instance as an argument which holds references to + QAbstractListModels for available windows and screens that can be captured. + + The data model's \e Qt::DisplayRole specifies the name of the source which is the title of a + window or the number of the display. + The model is dynamically updates if the available list of sources has changed e.g a window is + opened/closed. + + The signal handler needs to then either call QWebEngineDesktopMediaRequest:selectScreen() or + QWebEngineDesktopMediaRequest::selectWindow() to accept the request and start screensharing. + \sa QWebEnginePage::desktopMediaRequested(). +*/ + +class QWebEngineMediaSourceModel : public QAbstractListModel +{ +public: + ~QWebEngineMediaSourceModel() override; + + int rowCount(const QModelIndex &parent = QModelIndex()) const override; + QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override; + +private: + friend class QWebEngineDesktopMediaRequestPrivate; + explicit QWebEngineMediaSourceModel(QtWebEngineCore::DesktopMediaListQt *mediaList); + QtWebEngineCore::DesktopMediaListQt *m_mediaList; +}; + +QWebEngineMediaSourceModel::QWebEngineMediaSourceModel(QtWebEngineCore::DesktopMediaListQt *mediaList) + : m_mediaList(mediaList) +{ + QObject::connect(m_mediaList, &QtWebEngineCore::DesktopMediaListQt::sourceAdded, this, + [this](int index) { + beginInsertRows(QModelIndex(), index, index); + endInsertRows(); + }); + QObject::connect(m_mediaList, &QtWebEngineCore::DesktopMediaListQt::sourceRemoved, this, + [this](int index) { + beginRemoveRows(QModelIndex(), index, index); + endRemoveRows(); + }); + QObject::connect(m_mediaList, &QtWebEngineCore::DesktopMediaListQt::sourceMoved, this, + [this](int oldIndex, int newIndex) { + beginMoveRows(QModelIndex(), oldIndex, oldIndex, QModelIndex(), newIndex); + endMoveRows(); + }); + QObject::connect(m_mediaList, &QtWebEngineCore::DesktopMediaListQt::sourceNameChanged, this, + [this](int index) { + Q_EMIT dataChanged(QModelIndex(), QModelIndex(), + { Qt::DisplayRole }); + }); +} + +QWebEngineMediaSourceModel::~QWebEngineMediaSourceModel() { } + +int QWebEngineMediaSourceModel::rowCount(const QModelIndex &) const +{ + return m_mediaList->getSourceCount(); +} + +QVariant QWebEngineMediaSourceModel::data(const QModelIndex &index, int role) const +{ + if (!index.isValid()) + return QVariant(); + switch (role) { + case Qt::DisplayRole: + case Qt::EditRole: + return m_mediaList->getSourceName(index.row()); + default: + break; + } + return QVariant(); +} + +QWebEngineDesktopMediaRequestPrivate::QWebEngineDesktopMediaRequestPrivate( + QtWebEngineCore::DesktopMediaController *controller) + : controller(controller) + , m_screensModel(new QWebEngineMediaSourceModel(controller->screens())) + , m_windowsModel(new QWebEngineMediaSourceModel(controller->windows())) +{ +} + +QWebEngineDesktopMediaRequestPrivate::~QWebEngineDesktopMediaRequestPrivate() +{ + // Keep old behavior, if there were no user action select the primary screen. + if (!didSelectOrCancel) + controller->selectScreen(0); +} + +void QWebEngineDesktopMediaRequestPrivate::selectWindow(const QModelIndex &index) +{ + Q_ASSERT(index.model() == m_windowsModel.get()); + if (!index.isValid()) + return; + didSelectOrCancel = true; + controller->selectWindow(index.row()); +} + +void QWebEngineDesktopMediaRequestPrivate::selectScreen(const QModelIndex &index) +{ + Q_ASSERT(index.model() == m_screensModel.get()); + if (!index.isValid()) + return; + didSelectOrCancel = true; + controller->selectScreen(index.row()); +} + +void QWebEngineDesktopMediaRequestPrivate::cancel() +{ + // Notifies webrtc so it can free up it's resources. + didSelectOrCancel = true; + controller->cancel(); +} + +QWebEngineDesktopMediaRequest::QWebEngineDesktopMediaRequest( + QtWebEngineCore::DesktopMediaController *controller) + : d(new QWebEngineDesktopMediaRequestPrivate(controller)) +{ +} + +QWebEngineDesktopMediaRequest::~QWebEngineDesktopMediaRequest() = default; + +QWebEngineDesktopMediaRequest::QWebEngineDesktopMediaRequest( + const QWebEngineDesktopMediaRequest &other) noexcept = default; + +QWebEngineDesktopMediaRequest &QWebEngineDesktopMediaRequest::operator=( + const QWebEngineDesktopMediaRequest &other) noexcept = default; + +QWebEngineDesktopMediaRequest::QWebEngineDesktopMediaRequest( + QWebEngineDesktopMediaRequest &&other) noexcept = default; + +/*! + Returns a QAbstractListModel for the available screens. + + \sa windowsModel() +*/ +QAbstractListModel *QWebEngineDesktopMediaRequest::screensModel() const +{ + return d->m_screensModel.get(); +} + +/*! + Returns a QAbstractListModel for the available windows. + + \sa screensModel() +*/ +QAbstractListModel *QWebEngineDesktopMediaRequest::windowsModel() const +{ + return d->m_windowsModel.get(); +} + +/*! + Selects the window on the \a index to be captured. + + \sa QWebEngineDesktopMediaRequest::selectScreen() +*/ +void QWebEngineDesktopMediaRequest::selectWindow(const QModelIndex &index) const +{ + d->selectWindow(index); +} + +/*! + Selects the screen on the \a index to be captured. + + \sa QWebEngineDesktopMediaRequest::selectWindow() +*/ +void QWebEngineDesktopMediaRequest::selectScreen(const QModelIndex &index) const +{ + d->selectScreen(index); +} + +/*! + Rejects a request. Screen capturing will be aborted. +*/ +void QWebEngineDesktopMediaRequest::cancel() const +{ + d->cancel(); +} + +QT_END_NAMESPACE + +#include "moc_qwebenginedesktopmediarequest.cpp" diff --git a/src/core/api/qwebenginedesktopmediarequest.h b/src/core/api/qwebenginedesktopmediarequest.h new file mode 100644 index 000000000..ebf66bce4 --- /dev/null +++ b/src/core/api/qwebenginedesktopmediarequest.h @@ -0,0 +1,59 @@ +// Copyright (C) 2023 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 + +#ifndef QWEBENGINEDESKTOPMEDIAREQUEST_H +#define QWEBENGINEDESKTOPMEDIAREQUEST_H + +#include <QtCore/qabstractitemmodel.h> +#include <QtCore/qshareddata.h> +#include <QtCore/qobject.h> +#include <QtWebEngineCore/qtwebenginecoreglobal.h> + +namespace QtWebEngineCore { +class DesktopMediaController; +} + +QT_BEGIN_NAMESPACE +class QWebEnginePagePrivate; +class QQuickWebEngineViewPrivate; +class QWebEngineDesktopMediaRequestPrivate; +QT_DECLARE_QESDP_SPECIALIZATION_DTOR_WITH_EXPORT(QWebEngineDesktopMediaRequestPrivate, + Q_WEBENGINECORE_EXPORT) + +class QWebEngineDesktopMediaRequest +{ + Q_GADGET_EXPORT(Q_WEBENGINECORE_EXPORT) + Q_PROPERTY(QAbstractListModel *screensModel READ screensModel FINAL) + Q_PROPERTY(QAbstractListModel *windowsModel READ windowsModel FINAL) + +public: + Q_WEBENGINECORE_EXPORT ~QWebEngineDesktopMediaRequest(); + + Q_WEBENGINECORE_EXPORT + QWebEngineDesktopMediaRequest(const QWebEngineDesktopMediaRequest &other) noexcept; + Q_WEBENGINECORE_EXPORT + QWebEngineDesktopMediaRequest(QWebEngineDesktopMediaRequest &&other) noexcept; + Q_WEBENGINECORE_EXPORT + QWebEngineDesktopMediaRequest &operator=(const QWebEngineDesktopMediaRequest &other) noexcept; + QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QWebEngineDesktopMediaRequest) + void swap(QWebEngineDesktopMediaRequest &other) noexcept { d.swap(other.d); } + + Q_WEBENGINECORE_EXPORT QAbstractListModel *screensModel() const; + Q_WEBENGINECORE_EXPORT QAbstractListModel *windowsModel() const; + + Q_WEBENGINECORE_EXPORT Q_INVOKABLE void selectScreen(const QModelIndex &index) const; + Q_WEBENGINECORE_EXPORT Q_INVOKABLE void selectWindow(const QModelIndex &index) const; + Q_WEBENGINECORE_EXPORT Q_INVOKABLE void cancel() const; + +private: + friend class QWebEnginePagePrivate; + friend class QQuickWebEngineViewPrivate; + Q_WEBENGINECORE_EXPORT explicit QWebEngineDesktopMediaRequest( + QtWebEngineCore::DesktopMediaController *controller); + QExplicitlySharedDataPointer<QWebEngineDesktopMediaRequestPrivate> d; +}; +Q_DECLARE_SHARED(QWebEngineDesktopMediaRequest) + +QT_END_NAMESPACE + +#endif // QWEBENGINEDESKTOPMEDIAREQUEST_H diff --git a/src/core/api/qwebenginedesktopmediarequest_p.h b/src/core/api/qwebenginedesktopmediarequest_p.h new file mode 100644 index 000000000..3add71bc0 --- /dev/null +++ b/src/core/api/qwebenginedesktopmediarequest_p.h @@ -0,0 +1,49 @@ +// Copyright (C) 2023 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 + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#ifndef QWEBENGINEDESKTOPMEDIAREQUEST_P_H +#define QWEBENGINEDESKTOPMEDIAREQUEST_P_H + +#include <QtCore/qabstractitemmodel.h> +#include <QtCore/QSharedData> +#include <QtCore/qobject.h> +#include <QtWebEngineCore/qtwebenginecoreglobal.h> + +namespace QtWebEngineCore { +class DesktopMediaController; +} + +QT_BEGIN_NAMESPACE +class QWebEngineMediaSourceModel; + +class QWebEngineDesktopMediaRequestPrivate : public QSharedData +{ +public: + ~QWebEngineDesktopMediaRequestPrivate(); + explicit QWebEngineDesktopMediaRequestPrivate( + QtWebEngineCore::DesktopMediaController *controller); + + void selectScreen(const QModelIndex &index); + void selectWindow(const QModelIndex &index); + void cancel(); + + bool didSelectOrCancel = false; + std::unique_ptr<QtWebEngineCore::DesktopMediaController> controller; + std::unique_ptr<QWebEngineMediaSourceModel> m_screensModel; + std::unique_ptr<QWebEngineMediaSourceModel> m_windowsModel; +}; + +QT_END_NAMESPACE + +#endif // QWEBENGINEDESKTOPMEDIAREQUEST_P_H diff --git a/src/core/api/qwebenginedownloadrequest.cpp b/src/core/api/qwebenginedownloadrequest.cpp index 97f6051b4..cbf46b448 100644 --- a/src/core/api/qwebenginedownloadrequest.cpp +++ b/src/core/api/qwebenginedownloadrequest.cpp @@ -123,20 +123,9 @@ static inline QWebEngineDownloadRequest::DownloadInterruptReason toDownloadInter QWebEnginePage::download, QWebEnginePage::save */ -QWebEngineDownloadRequestPrivate::QWebEngineDownloadRequestPrivate(QtWebEngineCore::ProfileAdapter *adapter, const QUrl &url) - : downloadFinished(false) - , downloadId(-1) - , downloadState(QWebEngineDownloadRequest::DownloadCancelled) - , savePageFormat(QWebEngineDownloadRequest::MimeHtmlSaveFormat) - , interruptReason(QWebEngineDownloadRequest::NoReason) - , downloadUrl(url) - , downloadPaused(false) - , isCustomFileName(false) - , totalBytes(-1) - , receivedBytes(0) - , isSavePageDownload(false) - , profileAdapter(adapter) - , adapterClient(nullptr) +QWebEngineDownloadRequestPrivate::QWebEngineDownloadRequestPrivate( + QtWebEngineCore::ProfileAdapter *adapter) + : profileAdapter(adapter) { } @@ -230,16 +219,22 @@ void QWebEngineDownloadRequest::cancel() QWebEngineDownloadRequest::DownloadState state = d->downloadState; - if (state == QWebEngineDownloadRequest::DownloadCompleted - || state == QWebEngineDownloadRequest::DownloadCancelled) + if (state == QWebEngineDownloadRequest::DownloadCompleted) return; - // We directly cancel the download request if the user cancels - // before it even started, so no need to notify the profile here. + bool cancelled = state == QWebEngineDownloadRequest::DownloadCancelled; + if (cancelled) + return; + + // Check if the download manager has a DownloadItem for this ID + // (network downloads or in progress page/resource saves) if (state == QWebEngineDownloadRequest::DownloadInProgress) { if (d->profileAdapter) - d->profileAdapter->cancelDownload(d->downloadId); - } else { + cancelled = d->profileAdapter->cancelDownload(d->downloadId); + } + + // Not cancelled downloads are not even started yet at this point + if (!cancelled) { d->downloadState = QWebEngineDownloadRequest::DownloadCancelled; Q_EMIT stateChanged(d->downloadState); d->setFinished(); @@ -391,7 +386,7 @@ QWebEngineDownloadRequest::DownloadState QWebEngineDownloadRequest::state() cons } /*! - Returns the the total amount of data to download in bytes. + Returns the total amount of data to download in bytes. \c -1 means the size is unknown. */ @@ -612,7 +607,7 @@ QString QWebEngineDownloadRequest::interruptReasonString() const QWebEnginePage *QWebEngineDownloadRequest::page() const { Q_D(const QWebEngineDownloadRequest); - if (d->adapterClient->clientType() == QtWebEngineCore::WebContentsAdapterClient::WidgetsClient) + if (d->adapterClient && d->adapterClient->clientType() == QtWebEngineCore::WebContentsAdapterClient::WidgetsClient) return const_cast<QWebEnginePage *>(static_cast<const QWebEnginePage *>(d->adapterClient->holdingQObject())); return nullptr; } diff --git a/src/core/api/qwebenginedownloadrequest_p.h b/src/core/api/qwebenginedownloadrequest_p.h index 814af59cb..eef6c9bb5 100644 --- a/src/core/api/qwebenginedownloadrequest_p.h +++ b/src/core/api/qwebenginedownloadrequest_p.h @@ -28,35 +28,38 @@ class WebContentsAdapterClient; QT_BEGIN_NAMESPACE -class Q_WEBENGINECORE_PRIVATE_EXPORT QWebEngineDownloadRequestPrivate +class Q_WEBENGINECORE_EXPORT QWebEngineDownloadRequestPrivate { public: - QWebEngineDownloadRequestPrivate(QtWebEngineCore::ProfileAdapter *adapter, const QUrl &url); + QWebEngineDownloadRequestPrivate(QtWebEngineCore::ProfileAdapter *adapter); ~QWebEngineDownloadRequestPrivate(); void update(const QtWebEngineCore::ProfileAdapterClient::DownloadItemInfo &info); void setFinished(); - bool downloadFinished; - quint32 downloadId; + bool downloadFinished = false; + quint32 downloadId = -1; qint64 startTime; - QWebEngineDownloadRequest::DownloadState downloadState; - QWebEngineDownloadRequest::SavePageFormat savePageFormat; - QWebEngineDownloadRequest::DownloadInterruptReason interruptReason; + QWebEngineDownloadRequest::DownloadState downloadState = + QWebEngineDownloadRequest::DownloadCancelled; + QWebEngineDownloadRequest::SavePageFormat savePageFormat = + QWebEngineDownloadRequest::MimeHtmlSaveFormat; + QWebEngineDownloadRequest::DownloadInterruptReason interruptReason = + QWebEngineDownloadRequest::NoReason; QString downloadPath; - const QUrl downloadUrl; + QUrl downloadUrl; QString mimeType; - bool downloadPaused; + bool downloadPaused = false; QString suggestedFileName; QString downloadDirectory; QString downloadFileName; - bool isCustomFileName; - qint64 totalBytes; - qint64 receivedBytes; - bool isSavePageDownload; + bool isCustomFileName = false; + qint64 totalBytes = -1; + qint64 receivedBytes = 0; + bool isSavePageDownload = false; QWebEngineDownloadRequest *q_ptr; QPointer<QtWebEngineCore::ProfileAdapter> profileAdapter; - QtWebEngineCore::WebContentsAdapterClient *adapterClient; + QtWebEngineCore::WebContentsAdapterClient *adapterClient = nullptr; Q_DECLARE_PUBLIC(QWebEngineDownloadRequest) }; diff --git a/src/core/api/qwebenginefilesystemaccessrequest.cpp b/src/core/api/qwebenginefilesystemaccessrequest.cpp index 6527e1766..3f901b671 100644 --- a/src/core/api/qwebenginefilesystemaccessrequest.cpp +++ b/src/core/api/qwebenginefilesystemaccessrequest.cpp @@ -27,6 +27,25 @@ QT_BEGIN_NAMESPACE either call accept() or reject(). */ +/*! + \enum QWebEngineFileSystemAccessRequest::AccessFlag + + This enum describes the type of the requested access: read, write or both. The options + can be OR-ed together from the following list: + + \value Read + \value Write +*/ + +/*! + \enum QWebEngineFileSystemAccessRequest::HandleType + + This enum describes the type of the requested file system entry. + + \value File + \value Directory +*/ + QWebEngineFileSystemAccessRequest::QWebEngineFileSystemAccessRequest( const QWebEngineFileSystemAccessRequest &other) = default; QWebEngineFileSystemAccessRequest &QWebEngineFileSystemAccessRequest::operator=( diff --git a/src/core/api/qwebengineframe.cpp b/src/core/api/qwebengineframe.cpp new file mode 100644 index 000000000..fa2cbb507 --- /dev/null +++ b/src/core/api/qwebengineframe.cpp @@ -0,0 +1,263 @@ +// Copyright (C) 2024 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 "qwebengineframe.h" + +#include "qwebenginescript.h" +#include <QtQml/qqmlengine.h> +#include <QtGui/qpagelayout.h> +#include <QtGui/qpageranges.h> + +#include "web_contents_adapter_client.h" +#include "web_contents_adapter.h" + +QT_BEGIN_NAMESPACE + +/*! + \class QWebEngineFrame + \brief The QWebEngineFrame class gives information about and control over a page frame. + \since 6.8 + + \inmodule QtWebEngineCore + + A web engine frame represents a single frame within a web page, such as those created by + \c <frame> or \c <iframe> HTML elements. + An active QWebEnginePage has one or more frames arranged in a tree structure. The top-level + frame, the root of this tree, can be accessed through the mainFrame() method, and + children() provides a frame's direct descendants. + + A frame's lifetime is, at most, as long as the QWebEnginePage object that produced it. + However, frames may be created and deleted spontaneously and dynamically, for example through + navigation and script execution. Because of this, many QWebEngineFrame methods return + optional values, which will be \c std::nullopt if the frame no longer exists. +*/ + +/*! \internal + */ +QWebEngineFrame::QWebEngineFrame(QtWebEngineCore::WebContentsAdapterClient *adapter, quint64 id) + : m_adapterClient(adapter), m_id(id) +{ +} + +/*! + Returns \c{true} if this object represents an existing frame; \c{false} otherwise. + + Once a frame is invalid, it never becomes valid again. +*/ +bool QWebEngineFrame::isValid() const +{ + return m_adapterClient->webContentsAdapter()->hasFrame(m_id); +} + +/*! + Returns the frame name; that is, what would be returned by \c window.name in JavaScript. + + If the frame could not be found, returns a null QString. + + \sa htmlName +*/ +QString QWebEngineFrame::name() const +{ + return m_adapterClient->webContentsAdapter()->frameName(m_id); +} + +/*! + Returns the value of the frame's \c name HTML attribute, or an empty string if it has none. + + If the frame could not be found, returns a null QString. + + \sa name +*/ +QString QWebEngineFrame::htmlName() const +{ + return m_adapterClient->webContentsAdapter()->frameHtmlName(m_id); +} + +/*! + Returns a list of the frame's children in an arbitrary order. + + If the frame could not be found, returns an empty list. + */ +QList<QWebEngineFrame> QWebEngineFrame::children() const +{ + QList<QWebEngineFrame> result; + for (auto childId : m_adapterClient->webContentsAdapter()->frameChildren(m_id)) + result.push_back(QWebEngineFrame{ m_adapterClient, childId }); + return result; +} + +/*! + Returns the URL of the content currently loaded in this frame. + + If the frame could not be found, returns an empty QUrl. + */ +QUrl QWebEngineFrame::url() const +{ + return m_adapterClient->webContentsAdapter()->frameUrl(m_id); +} + +/*! + Returns the size of the frame within the viewport. + + If the frame could not be found, returns QSizeF(). + */ +QSizeF QWebEngineFrame::size() const +{ + return m_adapterClient->webContentsAdapter()->frameSize(m_id); +} + +/*! + Returns \c{true} if this object represents the page's main frame; \c{false} otherwise. +*/ +bool QWebEngineFrame::isMainFrame() const +{ + return m_adapterClient->webContentsAdapter()->mainFrameId() == m_id; +} + +/*! \fn void QWebEngineFrame::runJavaScript(const QString &script, const std::function<void(const QVariant &)> &callback) + \fn void QWebEngineFrame::runJavaScript(const QString &script, quint32 worldId) + \fn void QWebEngineFrame::runJavaScript(const QString &script, quint32 worldId, const + std::function<void(const QVariant &)> &callback) + + Runs the JavaScript code contained in \a script on this frame, without checking + whether the DOM of the page has been constructed. + To avoid conflicts with other scripts executed on the page, the world in + which the script is run is specified by \a worldId. The world ID values are + the same as provided by QWebEngineScript::ScriptWorldId, and between \c 0 + and \c 256. If you leave out the \c world ID, the script is run in the + \c MainWorld. + When the script has been executed, \a callback is called with the result of the last + executed statement. \c callback can be any of a function pointer, a functor or a lambda, + and it is expected to take a QVariant parameter. For example: + \code + page.runJavaScript("document.title", [](const QVariant &v) { qDebug() << v.toString(); }); + \endcode + Only plain data can be returned from JavaScript as the result value. + Supported data types include all of the JSON data types as well as, for + example, \c{Date} and \c{ArrayBuffer}. Unsupported data types include, for + example, \c{Function} and \c{Promise}. + \warning Do not execute lengthy routines in the callback function, because it might block the + rendering of the web engine page. + \warning We guarantee that the \a callback is always called, but it might be + done during page destruction. When QWebEnginePage is deleted, the callback is triggered with an + invalid value and it is not safe to use the corresponding QWebEnginePage or QWebEngineView + instance inside it. + \sa QWebEngineScript::ScriptWorldId, QWebEnginePage::runJavaScript, {Script Injection} + */ +void QWebEngineFrame::runJavaScript(const QString &script, + const std::function<void(const QVariant &)> &callback) +{ + runJavaScript(script, QWebEngineScript::MainWorld, callback); +} + +void QWebEngineFrame::runJavaScript(const QString &script, quint32 worldId, + const std::function<void(const QVariant &)> &callback) +{ + m_adapterClient->runJavaScript(script, worldId, m_id, callback); +} + +void QWebEngineFrame::runJavaScript(const QString &script, quint32 worldId) +{ + runJavaScript(script, worldId, std::function<void(const QVariant &)>{}); +} + +void QWebEngineFrame::runJavaScript(const QString &script, const QJSValue &callback) +{ + runJavaScript(script, QWebEngineScript::MainWorld, callback); +} + +void QWebEngineFrame::runJavaScript(const QString &script, quint32 worldId, + const QJSValue &callback) +{ + std::function<void(const QVariant &)> wrappedCallback; + if (!callback.isUndefined()) { + const QObject *holdingObject = m_adapterClient->holdingQObject(); + wrappedCallback = [holdingObject, callback](const QVariant &result) { + if (auto engine = qmlEngine(holdingObject)) { + QJSValueList args; + args.append(engine->toScriptValue(result)); + callback.call(args); + } else { + qWarning("No QML engine found to execute runJavaScript() callback"); + } + }; + } + runJavaScript(script, worldId, wrappedCallback); +} + +/*! + Renders the current content of the frame into a PDF document and saves it in the location + specified in \a filePath. Printing uses a page size of A4, portrait layout, and includes the + full range of pages. + + This method issues an asynchronous request for printing the web page into a PDF and returns + immediately. To be informed about the result of the request, connect to the \l + QWebEnginePage::pdfPrintingFinished() signal. + + \note The \l QWebEnginePage::Stop web action can be used to interrupt this asynchronous + operation. + + If a file already exists at the provided file path, it will be overwritten. + + \sa QWebEnginePage::pdfPrintingFinished() + */ +void QWebEngineFrame::printToPdf(const QString &filePath) +{ + QPageLayout layout(QPageSize(QPageSize::A4), QPageLayout::Portrait, QMarginsF()); + m_adapterClient->printToPdf(filePath, layout, QPageRanges(), m_id); +} + +/*! + Renders the current content of the frame into a PDF document and returns a byte array containing + the PDF data as parameter to \a callback. Printing uses a page size of A4, portrait layout, and + includes the full range of pages. + + The \a callback must take a const reference to a QByteArray as parameter. If printing was + successful, this byte array will contain the PDF data, otherwise, the byte array will be empty. + + \note The \l QWebEnginePage::Stop web action can be used to interrupt this operation. +*/ +void QWebEngineFrame::printToPdf(const std::function<void(const QByteArray &)> &callback) +{ + std::function wrappedCallback = [callback](QSharedPointer<QByteArray> result) { + if (callback) + callback(result ? *result : QByteArray()); + }; + QPageLayout layout(QPageSize(QPageSize::A4), QPageLayout::Portrait, QMarginsF()); + m_adapterClient->printToPdf(std::move(wrappedCallback), layout, QPageRanges(), m_id); +} + +void QWebEngineFrame::printToPdf(const QJSValue &callback) +{ + std::function<void(QSharedPointer<QByteArray>)> wrappedCallback; + if (!callback.isUndefined()) { + const QObject *holdingObject = m_adapterClient->holdingQObject(); + wrappedCallback = [holdingObject, callback](QSharedPointer<QByteArray> result) { + if (auto engine = qmlEngine(holdingObject)) { + QJSValueList args; + args.append(engine->toScriptValue(result ? *result : QByteArray())); + callback.call(args); + } else { + qWarning("No QML engine found to execute runJavaScript() callback"); + } + }; + } + QPageLayout layout(QPageSize(QPageSize::A4), QPageLayout::Portrait, QMarginsF()); + m_adapterClient->printToPdf(std::move(wrappedCallback), layout, QPageRanges(), m_id); +} + +/*! \fn bool QWebEngineFrame::operator==(const QWebEngineFrame &left, const QWebEngineFrame &right) noexcept + + Returns \c{true} if \a left and \a right represent the same frame in the same web page, + otherwise \c{false}. + */ + +/*! \fn bool QWebEngineFrame::operator!=(const QWebEngineFrame &left, const QWebEngineFrame &right) noexcept + + Returns \c{true} if \a left and \a right represent different frames in the same web page, + otherwise \c{false}. + */ + +QT_END_NAMESPACE + +#include "moc_qwebengineframe.cpp" diff --git a/src/core/api/qwebengineframe.h b/src/core/api/qwebengineframe.h new file mode 100644 index 000000000..b6953cdd2 --- /dev/null +++ b/src/core/api/qwebengineframe.h @@ -0,0 +1,80 @@ +// Copyright (C) 2024 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 + +#ifndef QWEBENGINEFRAME_H +#define QWEBENGINEFRAME_H + +#include <QtWebEngineCore/qtwebenginecoreglobal.h> +#include <QtQml/qqmlregistration.h> +#include <QtQml/qjsvalue.h> +#include <QtCore/qcompare.h> +#include <QtCore/QList> +#include <QtCore/QSizeF> +#include <QtCore/QString> +#include <QtCore/QUrl> + +namespace QtWebEngineCore { +class WebContentsAdapterClient; +} + +QT_BEGIN_NAMESPACE + +class Q_WEBENGINECORE_EXPORT QWebEngineFrame +{ + Q_GADGET + + Q_PROPERTY(bool isValid READ isValid FINAL) + Q_PROPERTY(QString name READ name FINAL) + Q_PROPERTY(QString htmlName READ htmlName FINAL) + Q_PROPERTY(QUrl url READ url FINAL) + Q_PROPERTY(QSizeF size READ size FINAL) + Q_PROPERTY(bool isMainFrame READ isMainFrame FINAL) + +public: + QML_VALUE_TYPE(webEngineFrame) + QML_ADDED_IN_VERSION(6, 8) + + bool isValid() const; + QString name() const; + QString htmlName() const; + QList<QWebEngineFrame> children() const; + QUrl url() const; + QSizeF size() const; + bool isMainFrame() const; + + void runJavaScript(const QString &script, + const std::function<void(const QVariant &)> &callback); + void runJavaScript(const QString &script, quint32 worldId, + const std::function<void(const QVariant &)> &callback); + Q_INVOKABLE void runJavaScript(const QString &script, quint32 worldId = 0); + Q_INVOKABLE void runJavaScript(const QString &script, const QJSValue &callback); + Q_INVOKABLE void runJavaScript(const QString &script, quint32 worldId, + const QJSValue &callback); + + Q_INVOKABLE void printToPdf(const QString &filePath); + void printToPdf(const std::function<void(const QByteArray &)> &callback); + Q_INVOKABLE void printToPdf(const QJSValue &callback); + + friend inline bool comparesEqual(const QWebEngineFrame &lhs, + const QWebEngineFrame &rhs) noexcept + { + return lhs.m_adapterClient == rhs.m_adapterClient && lhs.m_id == rhs.m_id; + } + + Q_DECLARE_EQUALITY_COMPARABLE(QWebEngineFrame); + +private: + friend class QWebEnginePage; + friend class QWebEnginePagePrivate; + friend class QQuickWebEngineView; + friend class QQuickWebEngineViewPrivate; + + QWebEngineFrame(QtWebEngineCore::WebContentsAdapterClient *page, quint64 id); + + QtWebEngineCore::WebContentsAdapterClient *m_adapterClient; + quint64 m_id; +}; + +QT_END_NAMESPACE + +#endif // QWEBENGINEFRAME_H diff --git a/src/core/api/qwebengineglobalsettings.cpp b/src/core/api/qwebengineglobalsettings.cpp new file mode 100644 index 000000000..6aadd5517 --- /dev/null +++ b/src/core/api/qwebengineglobalsettings.cpp @@ -0,0 +1,125 @@ +// Copyright (C) 2023 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 "qwebengineglobalsettings.h" +#include "qwebengineglobalsettings_p.h" +#include <QDebug> + +#ifdef signals +#undef signals +#endif + +namespace QtWebEngineCore { +extern void configureStubHostResolver(QWebEngineGlobalSettings::SecureDnsMode dnsMode, + std::string dnsOverHttpsTemplates, bool insecureDnsClientEnabled, + bool additionalInsecureDnsTypesEnabled); +extern bool isValidTemplates(std::string templates); + +} // namespace QtWebEngineCore + +QT_BEGIN_NAMESPACE + +/*! + \namespace QWebEngineGlobalSettings + \brief The QWebEngineGlobalSettings namespace holds global settings of the web engine. + \since 6.6 + \inmodule QtWebEngineCore + + The QWebEngineGlobalSettings namespace holds global properties of the web engine. + + Invoke setDnsMode() to configure DNS-over-HTTPS. + + \sa QWebEngineGlobalSettings::setDnsMode() +*/ + +/*! + \enum QWebEngineGlobalSettings::SecureDnsMode + + This enum sets the DNS-over-HTTPS mode used by the DnsMode structure: + + \value SystemOnly This is the default. Use the system DNS host resolution. + \value SecureWithFallback Enable DNS-over-HTTPS (DoH). DoH servers have to be + provided through \l {QWebEngineGlobalSettings::DnsMode::serverTemplates}{serverTemplates} in + the DnsMode structure. If a host cannot be resolved via the provided servers, + the system DNS host resolution is used. + \value SecureOnly Enable DNS-over-HTTPS and only allow hosts to be resolved + this way. DoH servers have to be provided through + \l {QWebEngineGlobalSettings::DnsMode::serverTemplates}{serverTemplates} in the DnsMode + structure. If the DNS-over-HTTPS resolution fails, there is no fallback and the DNS host + resolution fails completely. +*/ + +/*! + \class QWebEngineGlobalSettings::DnsMode + \brief The DnsMode struct provides means to specify the DNS host resolution mode. + \since 6.6 + \inmodule QtWebEngineCore + + The QWebEngineGlobalSettings::DnsMode structure describes the DNS mode and + the associated DNS server template used for the DNS host resolution. +*/ + +/*! + \variable QWebEngineGlobalSettings::DnsMode::secureMode + \brief The DNS mode used for the host resolution. + + Set \a secureMode to SecureDnsMode::SecureOnly to only allow DNS-over-HTTPS host resolution + using servers from \a serverTemplates. + + Set \a secureMode to SecureDnsMode::SecureWithFallback to enable DNS-over-HTTPS host resolution + using servers from \a serverTemplates, with a fallback to the system DNS. + + \sa QWebEngineGlobalSettings::SecureDnsMode +*/ + +/*! + \variable QWebEngineGlobalSettings::DnsMode::serverTemplates + \brief A list of server URI templates used for secure DNS-over-HTTPS host resolution. + + The \c serverTemplates structure member lists + \l{https://datatracker.ietf.org/d7oc/html/rfc6570}{URI templates}. + An example of a URI template is https://dns.google/dns-query{?dns}. +*/ + +/*! + \fn void QWebEngineGlobalSettings::setDnsMode(DnsMode dnsMode) + + Sets \a dnsMode for DNS-over-HTTPS host resolution. + + This function returns \c false if the \l {QWebEngineGlobalSettings::DnsMode::serverTemplates} + {serverTemplates} list in the \l {QWebEngineGlobalSettings::DnsMode}{DnsMode} structure is empty + or contains URI templates that cannot be parsed for SecureDnsMode::SecureOnly or + SecureDnsMode::SecureWithFallback. Otherwise, it returns \c true meaning that the DNS mode + change is triggered. +*/ + +bool QWebEngineGlobalSettings::setDnsMode(DnsMode dnsMode) +{ + QWebEngineGlobalSettingsPrivate *d = QWebEngineGlobalSettingsPrivate::instance(); + if (dnsMode.secureMode != SecureDnsMode::SystemOnly) { + const QString servers = dnsMode.serverTemplates.join(QChar::Space); + const std::string templates = servers.toStdString(); + if (!QtWebEngineCore::isValidTemplates(templates)) + return false; + d->dnsOverHttpsTemplates = templates; + } + d->dnsMode = dnsMode.secureMode; + d->configureStubHostResolver(); + return true; +} + +/*! + \internal +*/ +QWebEngineGlobalSettingsPrivate *QWebEngineGlobalSettingsPrivate::instance() +{ + static QWebEngineGlobalSettingsPrivate settings; + return &settings; +} + +void QWebEngineGlobalSettingsPrivate::configureStubHostResolver() +{ + QtWebEngineCore::configureStubHostResolver(dnsMode, dnsOverHttpsTemplates, insecureDnsClientEnabled, additionalInsecureDnsTypesEnabled); +} + +QT_END_NAMESPACE diff --git a/src/core/api/qwebengineglobalsettings.h b/src/core/api/qwebengineglobalsettings.h new file mode 100644 index 000000000..a9eff6d12 --- /dev/null +++ b/src/core/api/qwebengineglobalsettings.h @@ -0,0 +1,30 @@ +// Copyright (C) 2023 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 + +#ifndef QWEBENGINEGLOBALSETTINGS_H +#define QWEBENGINEGLOBALSETTINGS_H + +#if 0 +#pragma qt_class(QWebEngineGlobalSettings) +#endif + +#include <QtWebEngineCore/qtwebenginecoreglobal.h> +#include <QtCore/QObject> +#include <QtCore/QScopedPointer> + +QT_BEGIN_NAMESPACE + +namespace QWebEngineGlobalSettings { +// Mapping net::SecureDnsMode +enum class SecureDnsMode : quint8 { SystemOnly = 0, SecureWithFallback = 1, SecureOnly = 2 }; +struct DnsMode +{ + SecureDnsMode secureMode = SecureDnsMode::SystemOnly; + QStringList serverTemplates; +}; +Q_WEBENGINECORE_EXPORT bool setDnsMode(DnsMode dnsMode); +} + +QT_END_NAMESPACE + +#endif // QWEBENGINEGLOBALSETTINGS_H diff --git a/src/core/api/qwebengineglobalsettings_p.h b/src/core/api/qwebengineglobalsettings_p.h new file mode 100644 index 000000000..8e35ad68c --- /dev/null +++ b/src/core/api/qwebengineglobalsettings_p.h @@ -0,0 +1,44 @@ +// Copyright (C) 2023 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 + +#ifndef QWEBENGINEGLOBALSETTINGS_P_H +#define QWEBENGINEGLOBALSETTINGS_P_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#include "qtwebenginecoreglobal_p.h" +#include "qwebengineglobalsettings.h" +#include <string> + +QT_BEGIN_NAMESPACE + +class Q_WEBENGINECORE_EXPORT QWebEngineGlobalSettingsPrivate +{ +public: + QWebEngineGlobalSettingsPrivate() + : dnsMode(QWebEngineGlobalSettings::SecureDnsMode::SystemOnly) + , dnsOverHttpsTemplates("") + , insecureDnsClientEnabled(false) + , additionalInsecureDnsTypesEnabled(false){}; + + static QWebEngineGlobalSettingsPrivate *instance(); + QWebEngineGlobalSettings::SecureDnsMode dnsMode; + std::string dnsOverHttpsTemplates; + const bool insecureDnsClientEnabled; + const bool additionalInsecureDnsTypesEnabled; + + void configureStubHostResolver(); +}; + +QT_END_NAMESPACE + +#endif // QWEBENGINEGLOBALSETTINGS_P_H diff --git a/src/core/api/qwebenginehistory.cpp b/src/core/api/qwebenginehistory.cpp index b70c0b73d..5d2fc8e9e 100644 --- a/src/core/api/qwebenginehistory.cpp +++ b/src/core/api/qwebenginehistory.cpp @@ -242,13 +242,6 @@ QWebEngineHistory::QWebEngineHistory(QWebEngineHistoryPrivate *d) : d_ptr(d) { } QWebEngineHistory::~QWebEngineHistory() { } -/*! - \qmlmethod void WebEngineHistory::clear() - \since QtWebEngine 1.11 - - Clears the history. -*/ - void QWebEngineHistory::clear() { Q_D(const QWebEngineHistory); diff --git a/src/core/api/qwebenginehistory_p.h b/src/core/api/qwebenginehistory_p.h index 99c42d7eb..fe28f4a0e 100644 --- a/src/core/api/qwebenginehistory_p.h +++ b/src/core/api/qwebenginehistory_p.h @@ -72,7 +72,7 @@ public: int offsetForIndex(int) const override; }; -class Q_WEBENGINECORE_PRIVATE_EXPORT QWebEngineHistoryPrivate +class Q_WEBENGINECORE_EXPORT QWebEngineHistoryPrivate { public: typedef std::function<QUrl (const QUrl &)> ImageProviderUrl; diff --git a/src/core/api/qwebenginehttprequest.cpp b/src/core/api/qwebenginehttprequest.cpp index bb822d6e3..050213d1e 100644 --- a/src/core/api/qwebenginehttprequest.cpp +++ b/src/core/api/qwebenginehttprequest.cpp @@ -151,7 +151,7 @@ QWebEngineHttpRequest QWebEngineHttpRequest::postRequest(const QUrl &url, QByteArray key = QUrl::toPercentEncoding(it.key()); QByteArray value = QUrl::toPercentEncoding(it.value()); - if (buffer.length() > 0) + if (buffer.size() > 0) buffer += '&'; buffer.append(key).append('=').append(value); } diff --git a/src/core/api/qwebengineloadinginfo.cpp b/src/core/api/qwebengineloadinginfo.cpp index 14ec26be4..a72117e9d 100644 --- a/src/core/api/qwebengineloadinginfo.cpp +++ b/src/core/api/qwebengineloadinginfo.cpp @@ -22,13 +22,15 @@ Q_STATIC_ASSERT(static_cast<int>(WebEngineError::HttpStatusCodeDomain) == static class QWebEngineLoadingInfo::QWebEngineLoadingInfoPrivate : public QSharedData { public: QWebEngineLoadingInfoPrivate(const QUrl& url, LoadStatus status, bool isErrorPage, - const QString& errorString, int errorCode, ErrorDomain errorDomain) + const QString& errorString, int errorCode, ErrorDomain errorDomain, + const QMultiMap<QByteArray,QByteArray>& responseHeaders) : url(url) , status(status) , isErrorPage(isErrorPage) , errorString(errorString) , errorCode(errorCode) , errorDomain(errorDomain) + , responseHeaders(responseHeaders) { } @@ -38,6 +40,7 @@ public: QString errorString; int errorCode; ErrorDomain errorDomain; + QMultiMap<QByteArray,QByteArray> responseHeaders; }; /*! @@ -52,8 +55,10 @@ public: \sa QWebEnginePage::loadStarted, QWebEnginePage::loadFinished, WebEngineView::loadingChanged */ QWebEngineLoadingInfo::QWebEngineLoadingInfo(const QUrl& url, LoadStatus status, bool isErrorPage, - const QString& errorString, int errorCode, ErrorDomain errorDomain) - : d_ptr(new QWebEngineLoadingInfoPrivate(url, status, isErrorPage, errorString, errorCode, errorDomain)) + const QString& errorString, int errorCode, ErrorDomain errorDomain, + const QMultiMap<QByteArray,QByteArray>& responseHeaders) + : d_ptr(new QWebEngineLoadingInfoPrivate(url, status, isErrorPage, errorString, errorCode, errorDomain, + responseHeaders)) { } @@ -157,6 +162,19 @@ int QWebEngineLoadingInfo::errorCode() const return d->errorCode; } +/*! + \property QWebEngineLoadingInfo::responseHeaders + \since 6.6 + \brief Holds the response headers when \c QWebEngineLoadingInfo::status() + is equal to \c QWebEngineLoadingInfo::LoadSucceededStatus or + \c QWebEngineLoadingInfo::LoadFailedStatus. +*/ +QMultiMap<QByteArray,QByteArray> QWebEngineLoadingInfo::responseHeaders() const +{ + Q_D(const QWebEngineLoadingInfo); + return d->responseHeaders; +} + QT_END_NAMESPACE #include "moc_qwebengineloadinginfo.cpp" diff --git a/src/core/api/qwebengineloadinginfo.h b/src/core/api/qwebengineloadinginfo.h index a17588a57..48d14601a 100644 --- a/src/core/api/qwebengineloadinginfo.h +++ b/src/core/api/qwebengineloadinginfo.h @@ -6,8 +6,9 @@ #include <QtWebEngineCore/qtwebenginecoreglobal.h> -#include <QtCore/qshareddata.h> +#include <QtCore/qmap.h> #include <QtCore/qobject.h> +#include <QtCore/qshareddata.h> #include <QtCore/qurl.h> namespace QtWebEngineCore { @@ -26,6 +27,7 @@ class Q_WEBENGINECORE_EXPORT QWebEngineLoadingInfo Q_PROPERTY(QString errorString READ errorString CONSTANT FINAL) Q_PROPERTY(ErrorDomain errorDomain READ errorDomain CONSTANT FINAL) Q_PROPERTY(int errorCode READ errorCode CONSTANT FINAL) + Q_PROPERTY(QMultiMap<QByteArray,QByteArray> responseHeaders READ responseHeaders CONSTANT REVISION(6,6) FINAL) public: enum LoadStatus { @@ -60,11 +62,13 @@ public: QString errorString() const; ErrorDomain errorDomain() const; int errorCode() const; + QMultiMap<QByteArray,QByteArray> responseHeaders() const; private: QWebEngineLoadingInfo(const QUrl &url, LoadStatus status, bool isErrorPage = false, const QString &errorString = QString(), int errorCode = 0, - ErrorDomain errorDomain = NoErrorDomain); + ErrorDomain errorDomain = NoErrorDomain, + const QMultiMap<QByteArray,QByteArray> &responseHeaders = {}); class QWebEngineLoadingInfoPrivate; Q_DECLARE_PRIVATE(QWebEngineLoadingInfo) QExplicitlySharedDataPointer<QWebEngineLoadingInfoPrivate> d_ptr; diff --git a/src/core/api/qwebenginemessagepumpscheduler.cpp b/src/core/api/qwebenginemessagepumpscheduler.cpp index 62244c787..a435e2c0c 100644 --- a/src/core/api/qwebenginemessagepumpscheduler.cpp +++ b/src/core/api/qwebenginemessagepumpscheduler.cpp @@ -11,9 +11,14 @@ QWebEngineMessagePumpScheduler::QWebEngineMessagePumpScheduler(std::function<voi : m_callback(std::move(callback)) {} -void QWebEngineMessagePumpScheduler::scheduleWork() +void QWebEngineMessagePumpScheduler::scheduleImmediateWork() { - QCoreApplication::postEvent(this, new QTimerEvent(0)); + QCoreApplication::postEvent(this, new QTimerEvent(0), Qt::NormalEventPriority); +} + +void QWebEngineMessagePumpScheduler::scheduleIdleWork() +{ + QCoreApplication::postEvent(this, new QTimerEvent(0), Qt::LowEventPriority); } void QWebEngineMessagePumpScheduler::scheduleDelayedWork(int delay) diff --git a/src/core/api/qwebenginemessagepumpscheduler_p.h b/src/core/api/qwebenginemessagepumpscheduler_p.h index 7e84b4190..37f7dd9a6 100644 --- a/src/core/api/qwebenginemessagepumpscheduler_p.h +++ b/src/core/api/qwebenginemessagepumpscheduler_p.h @@ -23,12 +23,13 @@ QT_BEGIN_NAMESPACE -class Q_WEBENGINECORE_PRIVATE_EXPORT QWebEngineMessagePumpScheduler : public QObject +class Q_WEBENGINECORE_EXPORT QWebEngineMessagePumpScheduler : public QObject { Q_OBJECT public: QWebEngineMessagePumpScheduler(std::function<void()> callback); - void scheduleWork(); + void scheduleImmediateWork(); + void scheduleIdleWork(); void scheduleDelayedWork(int delay); protected: diff --git a/src/core/api/qwebenginenavigationrequest.cpp b/src/core/api/qwebenginenavigationrequest.cpp index c14a7bf41..dc7447b88 100644 --- a/src/core/api/qwebenginenavigationrequest.cpp +++ b/src/core/api/qwebenginenavigationrequest.cpp @@ -9,15 +9,17 @@ QT_BEGIN_NAMESPACE class QWebEngineNavigationRequestPrivate { public: - QWebEngineNavigationRequestPrivate(const QUrl& url, QWebEngineNavigationRequest::NavigationType navigationType, bool mainFrame) + QWebEngineNavigationRequestPrivate(const QUrl& url, QWebEngineNavigationRequest::NavigationType navigationType, bool mainFrame, bool formData) : url(url) , navigationType(navigationType) , isMainFrame(mainFrame) + , hasFormData(formData) {} QUrl url; QWebEngineNavigationRequest::NavigationType navigationType; bool isMainFrame; + bool hasFormData; bool isAccepted = true; }; @@ -51,9 +53,9 @@ public: /*! \internal */ -QWebEngineNavigationRequest::QWebEngineNavigationRequest(const QUrl& url, QWebEngineNavigationRequest::NavigationType navigationType, bool mainFrame, QObject* parent) +QWebEngineNavigationRequest::QWebEngineNavigationRequest(const QUrl& url, QWebEngineNavigationRequest::NavigationType navigationType, bool mainFrame, bool formData, QObject* parent) : QObject(parent) - , d_ptr(new QWebEngineNavigationRequestPrivate(url, navigationType, mainFrame)) + , d_ptr(new QWebEngineNavigationRequestPrivate(url, navigationType, mainFrame, formData)) { } @@ -89,7 +91,10 @@ void QWebEngineNavigationRequest::setAction(QWebEngineNavigationRequest::Navigat return; acceptRequest ? accept() : reject(); +QT_WARNING_PUSH +QT_WARNING_DISABLE_DEPRECATED emit actionChanged(); +QT_WARNING_POP } #endif /*! @@ -171,6 +176,25 @@ bool QWebEngineNavigationRequest::isMainFrame() const return d->isMainFrame; } +/*! + \property QWebEngineNavigationRequest::hasFormData + \brief Whether the navigation request contains form data + \since 6.8 +*/ +/*! + \qmlproperty bool WebEngineNavigationRequest::hasFormData + \since 6.8 + \readonly + + Whether the navigation request contains form data +*/ + +bool QWebEngineNavigationRequest::hasFormData() const +{ + Q_D(const QWebEngineNavigationRequest); + return d->hasFormData; +} + /*! \internal */ bool QWebEngineNavigationRequest::isAccepted() const { diff --git a/src/core/api/qwebenginenavigationrequest.h b/src/core/api/qwebenginenavigationrequest.h index 12fc2b4a1..a810a59fe 100644 --- a/src/core/api/qwebenginenavigationrequest.h +++ b/src/core/api/qwebenginenavigationrequest.h @@ -17,6 +17,7 @@ class Q_WEBENGINECORE_EXPORT QWebEngineNavigationRequest : public QObject Q_OBJECT Q_PROPERTY(QUrl url READ url CONSTANT FINAL) Q_PROPERTY(bool isMainFrame READ isMainFrame CONSTANT FINAL) + Q_PROPERTY(bool hasFormData READ hasFormData CONSTANT REVISION(6, 8) FINAL) Q_PROPERTY(NavigationType navigationType READ navigationType CONSTANT FINAL) public: @@ -36,6 +37,7 @@ public: QUrl url() const; bool isMainFrame() const; + bool hasFormData() const; NavigationType navigationType() const; Q_INVOKABLE void accept(); @@ -60,7 +62,7 @@ Q_SIGNALS: #endif private: - QWebEngineNavigationRequest(const QUrl &url, NavigationType navigationType, bool mainFrame, + QWebEngineNavigationRequest(const QUrl &url, NavigationType navigationType, bool mainFrame, bool formData, QObject *parent = nullptr); friend class QWebEnginePagePrivate; diff --git a/src/core/api/qwebenginenewwindowrequest.cpp b/src/core/api/qwebenginenewwindowrequest.cpp index 951753136..895033fd1 100644 --- a/src/core/api/qwebenginenewwindowrequest.cpp +++ b/src/core/api/qwebenginenewwindowrequest.cpp @@ -25,7 +25,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype WebEngineNewWindowRequest \instantiates QWebEngineNewWindowRequest - \inqmlmodule QtWebEngineQuick + \inqmlmodule QtWebEngine \since QtWebEngine 1.12 \brief A utility type for the WebEngineView::newWindowRequested signal. diff --git a/src/core/api/qwebenginepage.cpp b/src/core/api/qwebenginepage.cpp index 3b83a0b97..f0260fd0d 100644 --- a/src/core/api/qwebenginepage.cpp +++ b/src/core/api/qwebenginepage.cpp @@ -2,9 +2,11 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qwebenginepage.h" +#include "authenticator_request_dialog_controller.h" #include "qwebenginepage_p.h" #include "qwebenginecertificateerror.h" +#include "qwebenginedesktopmediarequest.h" #include "qwebenginefilesystemaccessrequest.h" #include "qwebenginefindtextresult.h" #include "qwebenginefullscreenrequest.h" @@ -17,11 +19,12 @@ #include "qwebenginenewwindowrequest_p.h" #include "qwebengineprofile.h" #include "qwebengineprofile_p.h" -#include "qwebenginequotarequest.h" #include "qwebengineregisterprotocolhandlerrequest.h" #include "qwebenginescript.h" #include "qwebenginescriptcollection_p.h" #include "qwebenginesettings.h" +#include "qwebenginewebauthuxrequest.h" +#include "qwebenginepermission_p.h" #include "authentication_dialog_controller.h" #include "autofill_popup_controller.h" @@ -34,6 +37,7 @@ #include "render_widget_host_view_qt_delegate.h" #include "render_widget_host_view_qt_delegate_client.h" #include "render_widget_host_view_qt_delegate_item.h" +#include "touch_selection_menu_controller.h" #include "web_contents_adapter.h" #include <QAction> @@ -42,8 +46,10 @@ #include <QClipboard> #include <QKeyEvent> #include <QIcon> + #include <QLoggingCategory> #include <QMimeData> +#include <QtCore/QPointer> #include <QRect> #include <QTimer> #include <QUrl> @@ -103,7 +109,9 @@ QWebEnginePagePrivate::QWebEnginePagePrivate(QWebEngineProfile *_profile) { memset(actions, 0, sizeof(actions)); +#if QT_DEPRECATED_SINCE(6, 5) qRegisterMetaType<QWebEngineQuotaRequest>(); +#endif qRegisterMetaType<QWebEngineRegisterProtocolHandlerRequest>(); qRegisterMetaType<QWebEngineFileSystemAccessRequest>(); qRegisterMetaType<QWebEngineFindTextResult>(); @@ -192,6 +200,12 @@ void QWebEnginePagePrivate::iconChanged(const QUrl &url) Q_EMIT q->iconChanged(iconUrl.isEmpty() ? QIcon() : adapter->icon()); } +void QWebEnginePagePrivate::zoomFactorChanged(qreal factor) +{ + Q_Q(QWebEnginePage); + Q_EMIT q->zoomFactorChanged(factor); +} + void QWebEnginePagePrivate::loadProgressChanged(int progress) { Q_Q(QWebEnginePage); @@ -261,6 +275,20 @@ void QWebEnginePagePrivate::loadFinished(QWebEngineLoadingInfo info) }); } +void QWebEnginePagePrivate::printToPdf(const QString &filePath, const QPageLayout &layout, + const QPageRanges &ranges, quint64 frameId) +{ + adapter->printToPDF(layout, ranges, filePath, frameId); +} + +void QWebEnginePagePrivate::printToPdf(std::function<void(QSharedPointer<QByteArray>)> &&callback, + const QPageLayout &layout, const QPageRanges &ranges, + quint64 frameId) +{ + adapter->printToPDFCallbackResult(std::move(callback), layout, ranges, /*colorMode*/ true, + /*useCustomMargins*/ true, frameId); +} + void QWebEnginePagePrivate::didPrintPageToPdf(const QString &filePath, bool success) { Q_Q(QWebEnginePage); @@ -329,6 +357,109 @@ void QWebEnginePagePrivate::createNewWindow(WindowOpenDisposition disposition, b Q_EMIT q->newWindowRequested(request); } +QString QWebEnginePagePrivate::actionText(int action) +{ + switch (action) { + case QWebEnginePage::Back: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Back); + case QWebEnginePage::Forward: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Forward); + case QWebEnginePage::Stop: + return QWebEnginePage::tr("Stop"); + case QWebEnginePage::Reload: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Reload); + case QWebEnginePage::ReloadAndBypassCache: + return QWebEnginePage::tr("Reload and Bypass Cache"); + case QWebEnginePage::Cut: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Cut); + case QWebEnginePage::Copy: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Copy); + case QWebEnginePage::Paste: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Paste); + case QWebEnginePage::Undo: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Undo); + case QWebEnginePage::Redo: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Redo); + case QWebEnginePage::SelectAll: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::SelectAll); + case QWebEnginePage::PasteAndMatchStyle: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::PasteAndMatchStyle); + case QWebEnginePage::OpenLinkInThisWindow: + return QWebEnginePage::tr("Open link in this window"); + case QWebEnginePage::OpenLinkInNewWindow: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::OpenLinkInNewWindow); + case QWebEnginePage::OpenLinkInNewTab: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::OpenLinkInNewTab); + case QWebEnginePage::OpenLinkInNewBackgroundTab: + return QWebEnginePage::tr("Open link in new background tab"); + case QWebEnginePage::CopyLinkToClipboard: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::CopyLinkToClipboard); + case QWebEnginePage::DownloadLinkToDisk: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::DownloadLinkToDisk); + case QWebEnginePage::CopyImageToClipboard: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::CopyImageToClipboard); + case QWebEnginePage::CopyImageUrlToClipboard: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::CopyImageUrlToClipboard); + case QWebEnginePage::DownloadImageToDisk: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::DownloadImageToDisk); + case QWebEnginePage::CopyMediaUrlToClipboard: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::CopyMediaUrlToClipboard); + case QWebEnginePage::ToggleMediaControls: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::ToggleMediaControls); + case QWebEnginePage::ToggleMediaLoop: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::ToggleMediaLoop); + case QWebEnginePage::ToggleMediaPlayPause: + return QWebEnginePage::tr("Toggle Play/Pause"); + case QWebEnginePage::ToggleMediaMute: + return QWebEnginePage::tr("Toggle Mute"); + case QWebEnginePage::DownloadMediaToDisk: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::DownloadMediaToDisk); + case QWebEnginePage::InspectElement: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::InspectElement); + case QWebEnginePage::ExitFullScreen: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::ExitFullScreen); + case QWebEnginePage::RequestClose: + return QWebEnginePage::tr("Close Page"); + case QWebEnginePage::Unselect: + return QWebEnginePage::tr("Unselect"); + case QWebEnginePage::SavePage: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::SavePage); + case QWebEnginePage::ViewSource: + return RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::ViewSource); + case QWebEnginePage::ToggleBold: + return QWebEnginePage::tr("&Bold"); + case QWebEnginePage::ToggleItalic: + return QWebEnginePage::tr("&Italic"); + case QWebEnginePage::ToggleUnderline: + return QWebEnginePage::tr("&Underline"); + case QWebEnginePage::ToggleStrikethrough: + return QWebEnginePage::tr("&Strikethrough"); + case QWebEnginePage::AlignLeft: + return QWebEnginePage::tr("Align &Left"); + case QWebEnginePage::AlignCenter: + return QWebEnginePage::tr("Align &Center"); + case QWebEnginePage::AlignRight: + return QWebEnginePage::tr("Align &Right"); + case QWebEnginePage::AlignJustified: + return QWebEnginePage::tr("Align &Justified"); + case QWebEnginePage::Indent: + return QWebEnginePage::tr("&Indent"); + case QWebEnginePage::Outdent: + return QWebEnginePage::tr("&Outdent"); + case QWebEnginePage::InsertOrderedList: + return QWebEnginePage::tr("Insert &Ordered List"); + case QWebEnginePage::InsertUnorderedList: + return QWebEnginePage::tr("Insert &Unordered List"); + case QWebEnginePage::ChangeTextDirectionLTR: + return QWebEnginePage::tr("Change text direction left to right"); + case QWebEnginePage::ChangeTextDirectionRTL: + return QWebEnginePage::tr("Change text direction right to left"); + default: + break; + } + return {}; +} + class WebContentsAdapterOwner : public QObject { public: @@ -351,6 +482,8 @@ bool QWebEnginePagePrivate::adoptWebContents(WebContentsAdapter *webContents) m_isBeingAdopted = true; + webContents->setRequestInterceptor(adapter->requestInterceptor()); + // This throws away the WebContentsAdapter that has been used until now. // All its states, particularly the loading URL, are replaced by the adopted WebContentsAdapter. WebContentsAdapterOwner *adapterOwner = new WebContentsAdapterOwner(adapter->sharedFromThis()); @@ -377,10 +510,16 @@ void QWebEnginePagePrivate::windowCloseRejected() // Do nothing for now. } -void QWebEnginePagePrivate::didRunJavaScript(quint64 requestId, const QVariant& result) +void QWebEnginePagePrivate::runJavaScript(const QString &script, quint32 worldId, quint64 frameId, + const std::function<void(const QVariant &)> &callback) { - if (auto callback = m_variantCallbacks.take(requestId)) - callback(result); + ensureInitialized(); + if (adapter->lifecycleState() == WebContentsAdapter::LifecycleState::Discarded) { + qWarning("runJavaScript: disabled in Discarded state"); + if (callback) + callback(QVariant()); + } else + adapter->runJavaScript(script, worldId, frameId, callback); } void QWebEnginePagePrivate::didFetchDocumentMarkup(quint64 requestId, const QString& result) @@ -395,27 +534,18 @@ void QWebEnginePagePrivate::didFetchDocumentInnerText(quint64 requestId, const Q callback(result); } -void QWebEnginePagePrivate::didPrintPage(quint64 requestId, QSharedPointer<QByteArray> result) +void QWebEnginePagePrivate::didPrintPage(QSharedPointer<QByteArray> result) { #if QT_CONFIG(webengine_printing_and_pdf) - // If no currentPrinter is set that means that were printing to PDF only. - if (!currentPrinter) { - if (!result.data()) - return; - if (auto callback = m_pdfResultCallbacks.take(requestId)) - callback(*(result.data())); - return; - } - + Q_ASSERT(currentPrinter); if (view) view->didPrintPage(currentPrinter, result); else currentPrinter = nullptr; #else - // we should never enter this branch, but just for safe-keeping... + // should not get here Q_UNUSED(result); - if (auto callback = m_pdfResultCallbacks.take(requestId)) - callback(QByteArray()); + Q_ASSERT(false); #endif } @@ -460,52 +590,121 @@ void QWebEnginePagePrivate::showColorDialog(QSharedPointer<ColorChooserControlle void QWebEnginePagePrivate::runMediaAccessPermissionRequest(const QUrl &securityOrigin, WebContentsAdapterClient::MediaRequestFlags requestFlags) { Q_Q(QWebEnginePage); - QWebEnginePage::Feature feature; - if (requestFlags.testFlag(WebContentsAdapterClient::MediaAudioCapture) && - requestFlags.testFlag(WebContentsAdapterClient::MediaVideoCapture)) - feature = QWebEnginePage::MediaAudioVideoCapture; + QWebEnginePermission::Feature feature; + + if (requestFlags.testFlag(WebContentsAdapterClient::MediaAudioCapture) + && requestFlags.testFlag(WebContentsAdapterClient::MediaVideoCapture)) + feature = QWebEnginePermission::MediaAudioVideoCapture; else if (requestFlags.testFlag(WebContentsAdapterClient::MediaAudioCapture)) - feature = QWebEnginePage::MediaAudioCapture; + feature = QWebEnginePermission::MediaAudioCapture; else if (requestFlags.testFlag(WebContentsAdapterClient::MediaVideoCapture)) - feature = QWebEnginePage::MediaVideoCapture; - else if (requestFlags.testFlag(WebContentsAdapterClient::MediaDesktopAudioCapture) && - requestFlags.testFlag(WebContentsAdapterClient::MediaDesktopVideoCapture)) - feature = QWebEnginePage::DesktopAudioVideoCapture; + feature = QWebEnginePermission::MediaVideoCapture; + else if (requestFlags.testFlag(WebContentsAdapterClient::MediaDesktopAudioCapture) + && requestFlags.testFlag(WebContentsAdapterClient::MediaDesktopVideoCapture)) + feature = QWebEnginePermission::DesktopAudioVideoCapture; else // if (requestFlags.testFlag(WebContentsAdapterClient::MediaDesktopVideoCapture)) - feature = QWebEnginePage::DesktopVideoCapture; - Q_EMIT q->featurePermissionRequested(securityOrigin, feature); + feature = QWebEnginePermission::DesktopVideoCapture; + + Q_EMIT q->permissionRequested(createFeaturePermissionObject(securityOrigin, feature)); + +#if QT_DEPRECATED_SINCE(6, 8) + QT_WARNING_PUSH + QT_WARNING_DISABLE_DEPRECATED + QWebEnginePage::Feature deprecatedFeature; + + if (requestFlags.testFlag(WebContentsAdapterClient::MediaAudioCapture) + && requestFlags.testFlag(WebContentsAdapterClient::MediaVideoCapture)) + deprecatedFeature = QWebEnginePage::MediaAudioVideoCapture; + else if (requestFlags.testFlag(WebContentsAdapterClient::MediaAudioCapture)) + deprecatedFeature = QWebEnginePage::MediaAudioCapture; + else if (requestFlags.testFlag(WebContentsAdapterClient::MediaVideoCapture)) + deprecatedFeature = QWebEnginePage::MediaVideoCapture; + else if (requestFlags.testFlag(WebContentsAdapterClient::MediaDesktopAudioCapture) + && requestFlags.testFlag(WebContentsAdapterClient::MediaDesktopVideoCapture)) + deprecatedFeature = QWebEnginePage::DesktopAudioVideoCapture; + else // if (requestFlags.testFlag(WebContentsAdapterClient::MediaDesktopVideoCapture)) + deprecatedFeature = QWebEnginePage::DesktopVideoCapture; + + Q_EMIT q->featurePermissionRequested(securityOrigin, deprecatedFeature); + QT_WARNING_POP +#endif // QT_DEPRECATED_SINCE(6, 8) } -static QWebEnginePage::Feature toFeature(QtWebEngineCore::ProfileAdapter::PermissionType type) +#if QT_DEPRECATED_SINCE(6, 8) +QT_WARNING_PUSH +QT_WARNING_DISABLE_DEPRECATED +static QWebEnginePage::Feature toDeprecatedFeature(QWebEnginePermission::Feature feature) { - switch (type) { - case QtWebEngineCore::ProfileAdapter::NotificationPermission: + switch (feature) { + case QWebEnginePermission::Feature::Notifications: return QWebEnginePage::Notifications; - case QtWebEngineCore::ProfileAdapter::GeolocationPermission: + case QWebEnginePermission::Feature::Geolocation: return QWebEnginePage::Geolocation; - default: + case QWebEnginePermission::Feature::ClipboardReadWrite: + return QWebEnginePage::ClipboardReadWrite; + case QWebEnginePermission::Feature::LocalFontsAccess: + return QWebEnginePage::LocalFontsAccess; + case QWebEnginePermission::Feature::MediaAudioCapture: + return QWebEnginePage::MediaAudioCapture; + case QWebEnginePermission::Feature::MediaVideoCapture: + return QWebEnginePage::MediaVideoCapture; + case QWebEnginePermission::Feature::MediaAudioVideoCapture: + return QWebEnginePage::MediaAudioVideoCapture; + case QWebEnginePermission::Feature::DesktopVideoCapture: + return QWebEnginePage::DesktopVideoCapture; + case QWebEnginePermission::Feature::DesktopAudioVideoCapture: + return QWebEnginePage::DesktopAudioVideoCapture; + case QWebEnginePermission::Feature::MouseLock: + return QWebEnginePage::MouseLock; + case QWebEnginePermission::Feature::Unsupported: break; } + Q_UNREACHABLE(); return QWebEnginePage::Feature(-1); } +QT_WARNING_POP +#endif // QT_DEPRECATED_SINCE(6, 8) -void QWebEnginePagePrivate::runFeaturePermissionRequest(QtWebEngineCore::ProfileAdapter::PermissionType permission, const QUrl &securityOrigin) +void QWebEnginePagePrivate::runFeaturePermissionRequest(QWebEnginePermission::Feature feature, const QUrl &securityOrigin) { Q_Q(QWebEnginePage); - Q_EMIT q->featurePermissionRequested(securityOrigin, toFeature(permission)); + switch (feature) { + case QWebEnginePermission::Notifications: + case QWebEnginePermission::Geolocation: + case QWebEnginePermission::ClipboardReadWrite: + case QWebEnginePermission::LocalFontsAccess: + Q_EMIT q->permissionRequested(createFeaturePermissionObject(securityOrigin, feature)); +#if QT_DEPRECATED_SINCE(6, 8) + QT_WARNING_PUSH + QT_WARNING_DISABLE_DEPRECATED + Q_EMIT q->featurePermissionRequested(securityOrigin, toDeprecatedFeature(feature)); + QT_WARNING_POP +#endif // QT_DEPRECATED_SINCE(6, 8) + return; + case QWebEnginePermission::MouseLock: + case QWebEnginePermission::MediaAudioCapture: + case QWebEnginePermission::MediaVideoCapture: + case QWebEnginePermission::MediaAudioVideoCapture: + case QWebEnginePermission::DesktopAudioVideoCapture: + case QWebEnginePermission::DesktopVideoCapture: + case QWebEnginePermission::Unsupported: + Q_UNREACHABLE(); + return; + } } void QWebEnginePagePrivate::runMouseLockPermissionRequest(const QUrl &securityOrigin) { Q_Q(QWebEnginePage); - Q_EMIT q->featurePermissionRequested(securityOrigin, QWebEnginePage::MouseLock); -} + Q_EMIT q->permissionRequested(createFeaturePermissionObject(securityOrigin, QWebEnginePermission::MouseLock)); -void QWebEnginePagePrivate::runQuotaRequest(QWebEngineQuotaRequest request) -{ - Q_Q(QWebEnginePage); - Q_EMIT q->quotaRequested(request); +#if QT_DEPRECATED_SINCE(6, 8) + QT_WARNING_PUSH + QT_WARNING_DISABLE_DEPRECATED + Q_EMIT q->featurePermissionRequested(securityOrigin, QWebEnginePage::MouseLock); + QT_WARNING_POP +#endif // QT_DEPRECATED_SINCE(6, 8) } void QWebEnginePagePrivate::runRegisterProtocolHandlerRequest(QWebEngineRegisterProtocolHandlerRequest request) @@ -514,6 +713,15 @@ void QWebEnginePagePrivate::runRegisterProtocolHandlerRequest(QWebEngineRegister Q_EMIT q->registerProtocolHandlerRequested(request); } +/*! + \fn void QWebEnginePage::fileSystemAccessRequested(QWebEngineFileSystemAccessRequest request) + \since 6.4 + + This signal is emitted when the web page requests access to local files or directories. + + The request object \a request can be used to accept or reject the request. +*/ + void QWebEnginePagePrivate::runFileSystemAccessRequest(QWebEngineFileSystemAccessRequest request) { Q_Q(QWebEnginePage); @@ -679,6 +887,18 @@ void QWebEnginePagePrivate::ensureInitialized() const adapter->loadDefault(); } +void QWebEnginePagePrivate::showWebAuthDialog(QWebEngineWebAuthUxRequest *request) +{ + Q_Q(QWebEnginePage); + Q_EMIT q->webAuthUxRequested(request); +} + +QWebEnginePermission QWebEnginePagePrivate::createFeaturePermissionObject(const QUrl &securityOrigin, QWebEnginePermission::Feature feature) +{ + auto *returnPrivate = new QWebEnginePermissionPrivate{securityOrigin, feature, adapter, profileAdapter()}; + return QWebEnginePermission(returnPrivate); +} + QWebEnginePage::QWebEnginePage(QObject* parent) : QObject(parent) , d_ptr(new QWebEnginePagePrivate()) @@ -742,12 +962,13 @@ QWebEnginePage::QWebEnginePage(QObject* parent) /*! \fn QWebEnginePage::quotaRequested(QWebEngineQuotaRequest quotaRequest) \since 5.11 + \deprecated [6.5] This signal is no longer emitted. - This signal is emitted when the web page requests larger persistent storage - than the application's current allocation in File System API. The default quota - is 0 bytes. + Requesting host quota is no longer supported by Chromium. + The behavior of navigator.webkitPersistentStorage + is identical to navigator.webkitTemporaryStorage. - The request object \a quotaRequest can be used to accept or reject the request. + For further details, see https://crbug.com/1233525 */ /*! @@ -845,11 +1066,9 @@ QWebEnginePage::~QWebEnginePage() setDevToolsPage(nullptr); emit _q_aboutToDelete(); - for (auto varFun : qAsConst(d_ptr->m_variantCallbacks)) - varFun(QVariant()); - for (auto strFun : qAsConst(d_ptr->m_stringCallbacks)) + d_ptr->adapter->clearJavaScriptCallbacks(); + for (auto strFun : std::as_const(d_ptr->m_stringCallbacks)) strFun(QString()); - d_ptr->m_variantCallbacks.clear(); d_ptr->m_stringCallbacks.clear(); } } @@ -1047,148 +1266,7 @@ QAction *QWebEnginePage::action(WebAction action) const if (d->actions[action]) return d->actions[action]; - QString text; - switch (action) { - case Back: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Back); - break; - case Forward: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Forward); - break; - case Stop: - text = tr("Stop"); - break; - case Reload: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Reload); - break; - case ReloadAndBypassCache: - text = tr("Reload and Bypass Cache"); - break; - case Cut: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Cut); - break; - case Copy: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Copy); - break; - case Paste: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Paste); - break; - case Undo: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Undo); - break; - case Redo: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::Redo); - break; - case SelectAll: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::SelectAll); - break; - case PasteAndMatchStyle: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::PasteAndMatchStyle); - break; - case OpenLinkInThisWindow: - text = tr("Open link in this window"); - break; - case OpenLinkInNewWindow: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::OpenLinkInNewWindow); - break; - case OpenLinkInNewTab: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::OpenLinkInNewTab); - break; - case OpenLinkInNewBackgroundTab: - text = tr("Open link in new background tab"); - break; - case CopyLinkToClipboard: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::CopyLinkToClipboard); - break; - case DownloadLinkToDisk: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::DownloadLinkToDisk); - break; - case CopyImageToClipboard: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::CopyImageToClipboard); - break; - case CopyImageUrlToClipboard: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::CopyImageUrlToClipboard); - break; - case DownloadImageToDisk: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::DownloadImageToDisk); - break; - case CopyMediaUrlToClipboard: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::CopyMediaUrlToClipboard); - break; - case ToggleMediaControls: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::ToggleMediaControls); - break; - case ToggleMediaLoop: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::ToggleMediaLoop); - break; - case ToggleMediaPlayPause: - text = tr("Toggle Play/Pause"); - break; - case ToggleMediaMute: - text = tr("Toggle Mute"); - break; - case DownloadMediaToDisk: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::DownloadMediaToDisk); - break; - case InspectElement: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::InspectElement); - break; - case ExitFullScreen: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::ExitFullScreen); - break; - case RequestClose: - text = tr("Close Page"); - break; - case Unselect: - text = tr("Unselect"); - break; - case SavePage: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::SavePage); - break; - case ViewSource: - text = RenderViewContextMenuQt::getMenuItemName(RenderViewContextMenuQt::ContextMenuItem::ViewSource); - break; - case ToggleBold: - text = tr("&Bold"); - break; - case ToggleItalic: - text = tr("&Italic"); - break; - case ToggleUnderline: - text = tr("&Underline"); - break; - case ToggleStrikethrough: - text = tr("&Strikethrough"); - break; - case AlignLeft: - text = tr("Align &Left"); - break; - case AlignCenter: - text = tr("Align &Center"); - break; - case AlignRight: - text = tr("Align &Right"); - break; - case AlignJustified: - text = tr("Align &Justified"); - break; - case Indent: - text = tr("&Indent"); - break; - case Outdent: - text = tr("&Outdent"); - break; - case InsertOrderedList: - text = tr("Insert &Ordered List"); - break; - case InsertUnorderedList: - text = tr("Insert &Unordered List"); - break; - case NoWebAction: - case WebActionCount: - Q_UNREACHABLE(); - break; - } + const QString text = QWebEnginePagePrivate::actionText(action); QAction *a = new QAction(const_cast<QWebEnginePage*>(this)); a->setText(text); @@ -1457,6 +1535,12 @@ void QWebEnginePage::triggerAction(WebAction action, bool) case InsertUnorderedList: runJavaScript(QStringLiteral("document.execCommand('insertUnorderedList');"), QWebEngineScript::ApplicationWorld); break; + case ChangeTextDirectionLTR: + d->adapter->changeTextDirection(true /*left to right*/); + break; + case ChangeTextDirectionRTL: + d->adapter->changeTextDirection(false /*left to right*/); + break; case NoWebAction: break; case WebActionCount: @@ -1500,6 +1584,15 @@ bool QWebEnginePage::event(QEvent *e) return QObject::event(e); } +void QWebEnginePagePrivate::desktopMediaRequested( + QtWebEngineCore::DesktopMediaController *controller) +{ + Q_Q(QWebEnginePage); + QTimer::singleShot(0, q, [q, controller]() { + Q_EMIT q->desktopMediaRequested(QWebEngineDesktopMediaRequest(controller)); + }); +} + void QWebEnginePagePrivate::contextMenuRequested(QWebEngineContextMenuRequest *data) { if (view) @@ -1507,7 +1600,7 @@ void QWebEnginePagePrivate::contextMenuRequested(QWebEngineContextMenuRequest *d } /*! - \fn bool QWebEnginePage::navigationRequested(QWebEngineNavigationRequest &request) + \fn void QWebEnginePage::navigationRequested(QWebEngineNavigationRequest &request) \since 6.2 This signal is emitted on navigation together with the call the acceptNavigationRequest(). @@ -1516,13 +1609,13 @@ void QWebEnginePagePrivate::contextMenuRequested(QWebEngineContextMenuRequest *d \sa acceptNavigationRequest() */ -void QWebEnginePagePrivate::navigationRequested(int navigationType, const QUrl &url, bool &accepted, bool isMainFrame) +void QWebEnginePagePrivate::navigationRequested(int navigationType, const QUrl &url, bool &accepted, bool isMainFrame, bool hasFormData) { Q_Q(QWebEnginePage); accepted = q->acceptNavigationRequest(url, static_cast<QWebEnginePage::NavigationType>(navigationType), isMainFrame); if (accepted) { - QWebEngineNavigationRequest navigationRequest(url, static_cast<QWebEngineNavigationRequest::NavigationType>(navigationType), isMainFrame); + QWebEngineNavigationRequest navigationRequest(url, static_cast<QWebEngineNavigationRequest::NavigationType>(navigationType), isMainFrame, hasFormData); Q_EMIT q->navigationRequested(navigationRequest); accepted = navigationRequest.isAccepted(); } @@ -1648,6 +1741,20 @@ void QWebEnginePagePrivate::setToolTip(const QString &toolTipText) view->setToolTip(toolTipText); } +/*! + \fn void QWebEnginePage::printRequested() + \since 5.12 + + This signal is emitted when the JavaScript \c{window.print()} method is called on the main + frame, or the user pressed the print button of PDF viewer plugin. + Typically, the signal handler can simply call printToPdf(). + + Since 6.8, this signal is only emitted for the main frame, instead of being emitted for any + frame that requests printing. + + \sa printToPdf(), printRequestedByFrame() +*/ + void QWebEnginePagePrivate::printRequested() { Q_Q(QWebEnginePage); @@ -1658,6 +1765,50 @@ void QWebEnginePagePrivate::printRequested() view->printRequested(); } +/*! + \fn void QWebEnginePage::printRequestedByFrame(QWebEngineFrame frame) + \since 6.8 + + This signal is emitted when the JavaScript \c{window.print()} method is called on \a frame. + If the frame is the main frame, \c{printRequested} is emitted instead. + + \sa printRequested(), printToPdf(), QWebEngineFrame::printToPdf() +*/ + +void QWebEnginePagePrivate::printRequestedByFrame(quint64 frameId) +{ + Q_Q(QWebEnginePage); + QWebEngineFrame frame(this, frameId); + QTimer::singleShot(0, q, [q, frame]() { Q_EMIT q->printRequestedByFrame(frame); }); + if (view) + view->printRequestedByFrame(frame); +} + +QtWebEngineCore::TouchHandleDrawableDelegate * +QWebEnginePagePrivate::createTouchHandleDelegate(const QMap<int, QImage> &images) +{ + return view->createTouchHandleDelegate(images); +} + +void QWebEnginePagePrivate::showTouchSelectionMenu( + QtWebEngineCore::TouchSelectionMenuController *controller, const QRect &selectionBounds, + const QSize &handleSize) +{ + Q_UNUSED(handleSize); + + if (controller->buttonCount() == 1) { + controller->runContextMenu(); + return; + } + + view->showTouchSelectionMenu(controller, selectionBounds); +} + +void QWebEnginePagePrivate::hideTouchSelectionMenu() +{ + view->hideTouchSelectionMenu(); +} + void QWebEnginePagePrivate::lifecycleStateChanged(LifecycleState state) { Q_Q(QWebEnginePage); @@ -1685,7 +1836,9 @@ void QWebEnginePagePrivate::visibleChanged(bool visible) The page does not take ownership of the pointer. This interceptor is called after any interceptors on the profile, and unlike profile interceptors, only - URL requests from this page are intercepted. + URL requests from this page are intercepted. If the original request was + already blocked or redirected by the profile interceptor, it will not be + intercepted by this. To unset the request interceptor, set a \c nullptr. @@ -1698,83 +1851,64 @@ void QWebEnginePage::setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *i d->adapter->setRequestInterceptor(interceptor); } +#if QT_DEPRECATED_SINCE(6, 8) +QT_WARNING_PUSH +QT_WARNING_DISABLE_DEPRECATED void QWebEnginePage::setFeaturePermission(const QUrl &securityOrigin, QWebEnginePage::Feature feature, QWebEnginePage::PermissionPolicy policy) { Q_D(QWebEnginePage); - if (policy == PermissionUnknown) { - switch (feature) { - case MediaAudioVideoCapture: - case MediaAudioCapture: - case MediaVideoCapture: - case DesktopAudioVideoCapture: - case DesktopVideoCapture: - case MouseLock: - break; - case Geolocation: - d->adapter->grantFeaturePermission(securityOrigin, ProfileAdapter::GeolocationPermission, ProfileAdapter::AskPermission); - break; - case Notifications: - d->adapter->grantFeaturePermission(securityOrigin, ProfileAdapter::NotificationPermission, ProfileAdapter::AskPermission); - break; - } - return; + QWebEnginePermission::Feature f; + QWebEnginePermission::State s; + + switch (feature) { + case QWebEnginePage::Notifications: + f = QWebEnginePermission::Notifications; + break; + case QWebEnginePage::Geolocation: + f = QWebEnginePermission::Geolocation; + break; + case QWebEnginePage::MediaAudioCapture: + f = QWebEnginePermission::MediaAudioCapture; + break; + case QWebEnginePage::MediaVideoCapture: + f = QWebEnginePermission::MediaVideoCapture; + break; + case QWebEnginePage::MediaAudioVideoCapture: + f = QWebEnginePermission::MediaAudioVideoCapture; + break; + case QWebEnginePage::MouseLock: + f = QWebEnginePermission::MouseLock; + break; + case QWebEnginePage::DesktopVideoCapture: + f = QWebEnginePermission::DesktopVideoCapture; + break; + case QWebEnginePage::DesktopAudioVideoCapture: + f = QWebEnginePermission::DesktopAudioVideoCapture; + break; + case QWebEnginePage::ClipboardReadWrite: + f = QWebEnginePermission::ClipboardReadWrite; + break; + case QWebEnginePage::LocalFontsAccess: + f = QWebEnginePermission::LocalFontsAccess; + break; } - const WebContentsAdapterClient::MediaRequestFlags audioVideoCaptureFlags( - WebContentsAdapterClient::MediaVideoCapture | - WebContentsAdapterClient::MediaAudioCapture); - const WebContentsAdapterClient::MediaRequestFlags desktopAudioVideoCaptureFlags( - WebContentsAdapterClient::MediaDesktopVideoCapture | - WebContentsAdapterClient::MediaDesktopAudioCapture); - - if (policy == PermissionGrantedByUser) { - switch (feature) { - case MediaAudioVideoCapture: - d->adapter->grantMediaAccessPermission(securityOrigin, audioVideoCaptureFlags); - break; - case MediaAudioCapture: - d->adapter->grantMediaAccessPermission(securityOrigin, WebContentsAdapterClient::MediaAudioCapture); - break; - case MediaVideoCapture: - d->adapter->grantMediaAccessPermission(securityOrigin, WebContentsAdapterClient::MediaVideoCapture); - break; - case DesktopAudioVideoCapture: - d->adapter->grantMediaAccessPermission(securityOrigin, desktopAudioVideoCaptureFlags); - break; - case DesktopVideoCapture: - d->adapter->grantMediaAccessPermission(securityOrigin, WebContentsAdapterClient::MediaDesktopVideoCapture); - break; - case MouseLock: - d->adapter->grantMouseLockPermission(securityOrigin, true); - break; - case Geolocation: - d->adapter->grantFeaturePermission(securityOrigin, ProfileAdapter::GeolocationPermission, ProfileAdapter::AllowedPermission); - break; - case Notifications: - d->adapter->grantFeaturePermission(securityOrigin, ProfileAdapter::NotificationPermission, ProfileAdapter::AllowedPermission); - break; - } - } else { // if (policy == PermissionDeniedByUser) - switch (feature) { - case MediaAudioVideoCapture: - case MediaAudioCapture: - case MediaVideoCapture: - case DesktopAudioVideoCapture: - case DesktopVideoCapture: - d->adapter->grantMediaAccessPermission(securityOrigin, WebContentsAdapterClient::MediaNone); - break; - case Geolocation: - d->adapter->grantFeaturePermission(securityOrigin, ProfileAdapter::GeolocationPermission, ProfileAdapter::DeniedPermission); - break; - case MouseLock: - d->adapter->grantMouseLockPermission(securityOrigin, false); - break; - case Notifications: - d->adapter->grantFeaturePermission(securityOrigin, ProfileAdapter::NotificationPermission, ProfileAdapter::DeniedPermission); - break; - } + switch (policy) { + case QWebEnginePage::PermissionUnknown: + s = QWebEnginePermission::Ask; + break; + case QWebEnginePage::PermissionDeniedByUser: + s = QWebEnginePermission::Denied; + break; + case QWebEnginePage::PermissionGrantedByUser: + s = QWebEnginePermission::Granted; + break; } + + d->adapter->setFeaturePermission(securityOrigin, f, s); } +QT_WARNING_POP +#endif // QT_DEPRECATED_SINCE(6, 8) static inline QWebEnginePage::FileSelectionMode toPublic(FilePickerController::FileChooserMode mode) { @@ -1961,7 +2095,7 @@ void QWebEnginePage::setZoomFactor(qreal factor) Q_D(QWebEnginePage); d->defaultZoomFactor = factor; - if (d->adapter->isInitialized()) { + if (d->adapter->isInitialized() && !qFuzzyCompare(factor, zoomFactor())) { d->adapter->setZoomFactor(factor); // MEMO: should reset if factor was not applied due to being invalid d->defaultZoomFactor = zoomFactor(); @@ -1970,34 +2104,13 @@ void QWebEnginePage::setZoomFactor(qreal factor) void QWebEnginePage::runJavaScript(const QString& scriptSource, const std::function<void(const QVariant &)> &resultCallback) { - Q_D(QWebEnginePage); - d->ensureInitialized(); - if (d->adapter->lifecycleState() == WebContentsAdapter::LifecycleState::Discarded) { - qWarning("runJavaScript: disabled in Discarded state"); - if (resultCallback) - resultCallback(QVariant()); - return; - } - quint64 requestId = d->adapter->runJavaScriptCallbackResult(scriptSource, QWebEngineScript::MainWorld); - d->m_variantCallbacks.insert(requestId, resultCallback); + runJavaScript(scriptSource, QWebEngineScript::MainWorld, resultCallback); } void QWebEnginePage::runJavaScript(const QString& scriptSource, quint32 worldId, const std::function<void(const QVariant &)> &resultCallback) { Q_D(QWebEnginePage); - d->ensureInitialized(); - if (d->adapter->lifecycleState() == WebContentsAdapter::LifecycleState::Discarded) { - qWarning("runJavaScript: disabled in Discarded state"); - if (resultCallback) - resultCallback(QVariant()); - return; - } - if (resultCallback) { - quint64 requestId = d->adapter->runJavaScriptCallbackResult(scriptSource, worldId); - d->m_variantCallbacks.insert(requestId, resultCallback); - } else { - d->adapter->runJavaScript(scriptSource, worldId); - } + d->runJavaScript(scriptSource, worldId, WebContentsAdapter::kUseMainFrameId, resultCallback); } /*! @@ -2110,6 +2223,24 @@ void QWebEnginePage::setDevToolsPage(QWebEnginePage *devToolsPage) } } +/*! + \since 6.6 + Returns the id of the developer tools host associated with this page. + + If remote debugging is enabled (see \l{Qt WebEngine Developer Tools}), the id can be used to + build the URL to connect to the developer tool websocket: + \c{ws://localhost:<debugggin-port>/devtools/page/<id>)}. The websocket can be used to to interact + with the page using the \l{https://chromedevtools.github.io/devtools-protocol/}{DevTools + Protocol}. +*/ + +QString QWebEnginePage::devToolsId() const +{ + Q_D(const QWebEnginePage); + d->ensureInitialized(); + return d->adapter->devToolsId(); +} + ASSERT_ENUMS_MATCH(FilePickerController::Open, QWebEnginePage::FileSelectOpen) ASSERT_ENUMS_MATCH(FilePickerController::OpenMultiple, QWebEnginePage::FileSelectOpenMultiple) ASSERT_ENUMS_MATCH(FilePickerController::UploadFolder, QWebEnginePage::FileSelectUploadFolder) @@ -2228,6 +2359,9 @@ QSizeF QWebEnginePage::contentsSize() const To be informed about the result of the request, connect to the signal pdfPrintingFinished(). + \note The \l QWebEnginePage::Stop web action can be used to interrupt + this asynchronous operation. + If a file already exists at the provided file path, it will be overwritten. \sa pdfPrintingFinished() */ @@ -2236,7 +2370,7 @@ void QWebEnginePage::printToPdf(const QString &filePath, const QPageLayout &layo #if QT_CONFIG(webengine_printing_and_pdf) Q_D(QWebEnginePage); d->ensureInitialized(); - d->adapter->printToPDF(layout, ranges, filePath); + d->printToPdf(filePath, layout, ranges, WebContentsAdapter::kUseMainFrameId); #else Q_UNUSED(filePath); Q_UNUSED(layout); @@ -2253,17 +2387,22 @@ void QWebEnginePage::printToPdf(const QString &filePath, const QPageLayout &layo The \a resultCallback must take a const reference to a QByteArray as parameter. If printing was successful, this byte array will contain the PDF data, otherwise, the byte array will be empty. + \note The \l QWebEnginePage::Stop web action can be used to interrupt this operation. + \warning We guarantee that the callback (\a resultCallback) is always called, but it might be done during page destruction. When QWebEnginePage is deleted, the callback is triggered with an invalid value and it is not safe to use the corresponding QWebEnginePage or QWebEngineView instance inside it. */ void QWebEnginePage::printToPdf(const std::function<void(const QByteArray&)> &resultCallback, const QPageLayout &layout, const QPageRanges &ranges) { - Q_D(QWebEnginePage); #if QT_CONFIG(webengine_printing_and_pdf) + Q_D(QWebEnginePage); d->ensureInitialized(); - quint64 requestId = d->adapter->printToPDFCallbackResult(layout, ranges); - d->m_pdfResultCallbacks.insert(requestId, resultCallback); + std::function wrappedCallback = [resultCallback](QSharedPointer<QByteArray> result) { + if (resultCallback && result) + resultCallback(*result); + }; + d->printToPdf(std::move(wrappedCallback), layout, ranges, WebContentsAdapter::kUseMainFrameId); #else Q_UNUSED(layout); Q_UNUSED(ranges); @@ -2413,6 +2552,33 @@ void QWebEnginePage::setVisible(bool visible) d->adapter->setVisible(visible); } +/*! + \since 6.8 + + The main, top-level frame of the page. All other frames on this page are accessible + as children of the main frame. +*/ +QWebEngineFrame QWebEnginePage::mainFrame() +{ + Q_D(QWebEnginePage); + return QWebEngineFrame(d, d->adapter->mainFrameId()); +} + +/*! + \since 6.8 + + Returns the frame with the given \a name. If there are multiple frames with the same + name, which one is returned is arbitrary. If no frame was found, returns \c std::nullopt. +*/ +std::optional<QWebEngineFrame> QWebEnginePage::findFrameByName(const QString &name) +{ + Q_D(QWebEnginePage); + if (auto maybeId = d->adapter->findFrameIdByName(name)) { + return QWebEngineFrame(d, *maybeId); + } + return {}; +} + QDataStream &operator<<(QDataStream &stream, const QWebEngineHistory &history) { auto adapter = history.d_func()->adapter(); diff --git a/src/core/api/qwebenginepage.h b/src/core/api/qwebenginepage.h index f4cca0582..cca7c55e7 100644 --- a/src/core/api/qwebenginepage.h +++ b/src/core/api/qwebenginepage.h @@ -7,6 +7,9 @@ #include <QtWebEngineCore/qtwebenginecoreglobal.h> #include <QtWebEngineCore/qwebengineclientcertificateselection.h> #include <QtWebEngineCore/qwebenginedownloadrequest.h> +#include <QtWebEngineCore/qwebenginequotarequest.h> +#include <QtWebEngineCore/qwebengineframe.h> +#include <QtWebEngineCore/qwebenginepermission.h> #include <QtCore/qobject.h> #include <QtCore/qurl.h> @@ -15,6 +18,7 @@ #include <QtGui/qtgui-config.h> #include <functional> +#include <optional> QT_BEGIN_NAMESPACE @@ -25,6 +29,7 @@ class QRect; class QVariant; class QWebChannel; class QWebEngineCertificateError; +class QWebEngineDesktopMediaRequest; class QWebEngineFileSystemAccessRequest; class QWebEngineFindTextResult; class QWebEngineFullScreenRequest; @@ -35,11 +40,11 @@ class QWebEngineNavigationRequest; class QWebEngineNewWindowRequest; class QWebEnginePagePrivate; class QWebEngineProfile; -class QWebEngineQuotaRequest; class QWebEngineRegisterProtocolHandlerRequest; class QWebEngineScriptCollection; class QWebEngineSettings; class QWebEngineUrlRequestInterceptor; +class QWebEngineWebAuthUxRequest; class Q_WEBENGINECORE_EXPORT QWebEnginePage : public QObject { @@ -47,9 +52,9 @@ class Q_WEBENGINECORE_EXPORT QWebEnginePage : public QObject Q_PROPERTY(QString selectedText READ selectedText) Q_PROPERTY(bool hasSelection READ hasSelection) Q_PROPERTY(QUrl requestedUrl READ requestedUrl) - Q_PROPERTY(qreal zoomFactor READ zoomFactor WRITE setZoomFactor) - Q_PROPERTY(QString title READ title) - Q_PROPERTY(QUrl url READ url WRITE setUrl) + Q_PROPERTY(qreal zoomFactor READ zoomFactor WRITE setZoomFactor NOTIFY zoomFactorChanged) + Q_PROPERTY(QString title READ title NOTIFY titleChanged) + Q_PROPERTY(QUrl url READ url WRITE setUrl NOTIFY urlChanged) Q_PROPERTY(QUrl iconUrl READ iconUrl NOTIFY iconUrlChanged) Q_PROPERTY(QIcon icon READ icon NOTIFY iconChanged) Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor) @@ -122,6 +127,9 @@ public: InsertOrderedList, InsertUnorderedList, + ChangeTextDirectionLTR, + ChangeTextDirectionRTL, + WebActionCount }; Q_ENUM(WebAction) @@ -140,12 +148,19 @@ public: }; Q_ENUM(WebWindowType) - enum PermissionPolicy { +#if QT_DEPRECATED_SINCE(6, 8) +QT_WARNING_PUSH QT_WARNING_DISABLE_DEPRECATED + enum QT_DEPRECATED_VERSION_X_6_8( + "QWebEnginePage::PermissionPolicy has been deprecated. " + "The updated permissions API uses QWebEnginePermission::State.") + PermissionPolicy { PermissionUnknown, PermissionGrantedByUser, PermissionDeniedByUser }; Q_ENUM(PermissionPolicy) +QT_WARNING_POP +#endif // must match WebContentsAdapterClient::NavigationType enum NavigationType { @@ -159,7 +174,12 @@ public: }; Q_ENUM(NavigationType) - enum Feature { +#if QT_DEPRECATED_SINCE(6, 8) +QT_WARNING_PUSH QT_WARNING_DISABLE_DEPRECATED + enum QT_DEPRECATED_VERSION_X_6_8( + "QWebEnginePage::Feature has been deprecated. " + "The updated permissions API uses QWebEnginePermission::Feature.") + Feature { Notifications = 0, Geolocation = 1, MediaAudioCapture = 2, @@ -167,9 +187,13 @@ public: MediaAudioVideoCapture, MouseLock, DesktopVideoCapture, - DesktopAudioVideoCapture + DesktopAudioVideoCapture, + ClipboardReadWrite, + LocalFontsAccess, }; Q_ENUM(Feature) +QT_WARNING_POP +#endif // Ex-QWebFrame enum @@ -227,7 +251,12 @@ public: void findText(const QString &subString, FindFlags options = {}, const std::function<void(const QWebEngineFindTextResult &)> &resultCallback = std::function<void(const QWebEngineFindTextResult &)>()); +#if QT_DEPRECATED_SINCE(6, 8) +QT_WARNING_PUSH QT_WARNING_DISABLE_DEPRECATED + QT_DEPRECATED_VERSION_X_6_8("Setting permissions through QWebEnginePage has been deprecated. Please use QWebEnginePermission instead.") void setFeaturePermission(const QUrl &securityOrigin, Feature feature, PermissionPolicy policy); +QT_WARNING_POP +#endif bool isLoading() const; @@ -282,6 +311,7 @@ public: QWebEnginePage *inspectedPage() const; void setDevToolsPage(QWebEnginePage *page); QWebEnginePage *devToolsPage() const; + QString devToolsId() const; void setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor); @@ -293,6 +323,9 @@ public: bool isVisible() const; void setVisible(bool visible); + QWebEngineFrame mainFrame(); + std::optional<QWebEngineFrame> findFrameByName(const QString &name); + void acceptAsNewWindow(QWebEngineNewWindowRequest &request); Q_SIGNALS: @@ -306,10 +339,27 @@ Q_SIGNALS: void geometryChangeRequested(const QRect &geom); void windowCloseRequested(); +#if QT_DEPRECATED_SINCE(6, 8) +#if !defined(Q_MOC_RUN) +QT_WARNING_PUSH +QT_WARNING_DISABLE_DEPRECATED +#endif // !defined(Q_MOC_RUN) + QT_MOC_COMPAT QT_DEPRECATED_VERSION_X_6_8("The signal has been deprecated; please use permissionRequested instead.") void featurePermissionRequested(const QUrl &securityOrigin, QWebEnginePage::Feature feature); + QT_MOC_COMPAT QT_DEPRECATED_VERSION_X_6_8("The signal has been deprecated, and no longer functions.") void featurePermissionRequestCanceled(const QUrl &securityOrigin, QWebEnginePage::Feature feature); +#if !defined(Q_MOC_RUN) +QT_WARNING_POP +#endif // !defined(Q_MOC_RUN) +#endif // QT_DEPRECATED_SINCE(6, 8) + void fullScreenRequested(QWebEngineFullScreenRequest fullScreenRequest); + void permissionRequested(QWebEnginePermission permissionRequest); + +#if QT_DEPRECATED_SINCE(6, 5) + QT_DEPRECATED_VERSION_X_6_5("Requesting host quota is no longer supported.") void quotaRequested(QWebEngineQuotaRequest quotaRequest); +#endif void registerProtocolHandlerRequested(QWebEngineRegisterProtocolHandlerRequest request); void fileSystemAccessRequested(QWebEngineFileSystemAccessRequest request); void selectClientCertificate(QWebEngineClientCertificateSelection clientCertSelection); @@ -317,6 +367,7 @@ Q_SIGNALS: void proxyAuthenticationRequired(const QUrl &requestUrl, QAuthenticator *authenticator, const QString &proxyHost); void renderProcessTerminated(RenderProcessTerminationStatus terminationStatus, int exitCode); + void desktopMediaRequested(const QWebEngineDesktopMediaRequest &request); void certificateError(const QWebEngineCertificateError &certificateError); void navigationRequested(QWebEngineNavigationRequest &request); void newWindowRequested(QWebEngineNewWindowRequest &request); @@ -327,6 +378,7 @@ Q_SIGNALS: void iconUrlChanged(const QUrl &url); void iconChanged(const QIcon &icon); + void zoomFactorChanged(qreal factor); void scrollPositionChanged(const QPointF &position); void contentsSizeChanged(const QSizeF &size); void audioMutedChanged(bool muted); @@ -335,6 +387,7 @@ Q_SIGNALS: void pdfPrintingFinished(const QString &filePath, bool success); void printRequested(); + void printRequestedByFrame(QWebEngineFrame frame); void visibleChanged(bool visible); @@ -346,6 +399,8 @@ Q_SIGNALS: // TODO: fixme / rewrite bindPageToView void _q_aboutToDelete(); + void webAuthUxRequested(QWebEngineWebAuthUxRequest *request); + protected: virtual QWebEnginePage *createWindow(WebWindowType type); virtual QStringList chooseFiles(FileSelectionMode mode, const QStringList &oldFiles, diff --git a/src/core/api/qwebenginepage_p.h b/src/core/api/qwebenginepage_p.h index 8bdf6de5c..77d3dd8c2 100644 --- a/src/core/api/qwebenginepage_p.h +++ b/src/core/api/qwebenginepage_p.h @@ -74,12 +74,18 @@ public: virtual void didPrintPage(QPrinter *&printer, QSharedPointer<QByteArray> result) = 0; virtual void didPrintPageToPdf(const QString &filePath, bool success) = 0; virtual void printRequested() = 0; + virtual void printRequestedByFrame(QWebEngineFrame frame) = 0; virtual void showAutofillPopup(QtWebEngineCore::AutofillPopupController *controller, const QRect &bounds, bool autoselectFirstSuggestion) = 0; virtual void hideAutofillPopup() = 0; + virtual QtWebEngineCore::TouchHandleDrawableDelegate * + createTouchHandleDelegate(const QMap<int, QImage> &) = 0; + virtual void showTouchSelectionMenu(QtWebEngineCore::TouchSelectionMenuController *, + const QRect &) = 0; + virtual void hideTouchSelectionMenu() = 0; }; -class Q_WEBENGINECORE_PRIVATE_EXPORT QWebEnginePagePrivate : public QtWebEngineCore::WebContentsAdapterClient +class Q_WEBENGINECORE_EXPORT QWebEnginePagePrivate : public QtWebEngineCore::WebContentsAdapterClient { public: Q_DECLARE_PUBLIC(QWebEnginePage) @@ -97,6 +103,7 @@ public: void titleChanged(const QString &) override; void urlChanged() override; void iconChanged(const QUrl &) override; + void zoomFactorChanged(qreal factor) override; void loadProgressChanged(int progress) override; void didUpdateTargetURL(const QUrl &) override; void selectionChanged() override; @@ -117,17 +124,22 @@ public: bool isBeingAdopted() override; void close() override; void windowCloseRejected() override; + void desktopMediaRequested(QtWebEngineCore::DesktopMediaController *) override; void contextMenuRequested(QWebEngineContextMenuRequest *request) override; - void navigationRequested(int navigationType, const QUrl &url, bool &accepted, bool isMainFrame) override; + void navigationRequested(int navigationType, const QUrl &url, bool &accepted, bool isMainFrame, bool hasFormData) override; void requestFullScreenMode(const QUrl &origin, bool fullscreen) override; bool isFullScreenMode() const override; void javascriptDialog(QSharedPointer<QtWebEngineCore::JavaScriptDialogController>) override; void runFileChooser(QSharedPointer<QtWebEngineCore::FilePickerController>) override; void showColorDialog(QSharedPointer<QtWebEngineCore::ColorChooserController>) override; - void didRunJavaScript(quint64 requestId, const QVariant &result) override; + void runJavaScript(const QString &script, quint32 worldId, quint64 frameId, + const std::function<void(const QVariant &)> &callback) override; void didFetchDocumentMarkup(quint64 requestId, const QString &result) override; void didFetchDocumentInnerText(quint64 requestId, const QString &result) override; - void didPrintPage(quint64 requestId, QSharedPointer<QByteArray> result) override; + void printToPdf(const QString &filePath, const QPageLayout &layout, const QPageRanges &ranges, + quint64 frameId) override; + void printToPdf(std::function<void(QSharedPointer<QByteArray>)> &&callback, + const QPageLayout &layout, const QPageRanges &ranges, quint64 frameId) override; void didPrintPageToPdf(const QString &filePath, bool success) override; bool passOnFocus(bool reverse) override; void javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, const QString &message, @@ -136,9 +148,8 @@ public: QSharedPointer<QtWebEngineCore::AuthenticationDialogController>) override; void releaseProfile() override; void runMediaAccessPermissionRequest(const QUrl &securityOrigin, MediaRequestFlags requestFlags) override; - void runFeaturePermissionRequest(QtWebEngineCore::ProfileAdapter::PermissionType permission, const QUrl &securityOrigin) override; + void runFeaturePermissionRequest(QWebEnginePermission::Feature feature, const QUrl &securityOrigin) override; void runMouseLockPermissionRequest(const QUrl &securityOrigin) override; - void runQuotaRequest(QWebEngineQuotaRequest) override; void runRegisterProtocolHandlerRequest(QWebEngineRegisterProtocolHandlerRequest) override; void runFileSystemAccessRequest(QWebEngineFileSystemAccessRequest) override; QObject *accessibilityParentObject() override; @@ -156,16 +167,20 @@ public: bool isEnabled() const override; void setToolTip(const QString &toolTipText) override; void printRequested() override; + void printRequestedByFrame(quint64 frameId) override; QtWebEngineCore::TouchHandleDrawableDelegate * - createTouchHandleDelegate(const QMap<int, QImage> &) override { return nullptr; } - void showTouchSelectionMenu(QtWebEngineCore::TouchSelectionMenuController *, const QRect &, const QSize &) override { } - void hideTouchSelectionMenu() override { } + createTouchHandleDelegate(const QMap<int, QImage> &) override; + void showTouchSelectionMenu(QtWebEngineCore::TouchSelectionMenuController *, const QRect &, + const QSize &) override; + void hideTouchSelectionMenu() override; const QObject *holdingQObject() const override; ClientType clientType() override { return QtWebEngineCore::WebContentsAdapterClient::WidgetsClient; } void findTextFinished(const QWebEngineFindTextResult &result) override; void showAutofillPopup(QtWebEngineCore::AutofillPopupController *controller, const QRect &bounds, bool autoselectFirstSuggestion) override; void hideAutofillPopup() override; + void showWebAuthDialog(QWebEngineWebAuthUxRequest *controller) override; + QWebEnginePermission createFeaturePermissionObject(const QUrl &securityOrigin, QWebEnginePermission::Feature feature) override; QtWebEngineCore::ProfileAdapter *profileAdapter() override; QtWebEngineCore::WebContentsAdapter *webContentsAdapter() override; @@ -177,10 +192,13 @@ public: bool adoptWebContents(QtWebEngineCore::WebContentsAdapter *webContents); QtWebEngineCore::WebContentsAdapter *webContents() { return adapter.data(); } void recreateFromSerializedHistory(QDataStream &input); + void didPrintPage(QSharedPointer<QByteArray> result); void setFullScreenMode(bool); void ensureInitialized() const; + static QString actionText(int action); + QSharedPointer<QtWebEngineCore::WebContentsAdapter> adapter; QWebEngineHistory *history; QWebEngineProfile *profile; @@ -195,7 +213,6 @@ public: QWebChannel *webChannel; unsigned int webChannelWorldId; QUrl iconUrl; - bool m_navigationActionTriggered; QPointer<QWebEnginePage> inspectedPage; QPointer<QWebEnginePage> devToolsPage; bool defaultAudioMuted; @@ -206,9 +223,7 @@ public: QPrinter *currentPrinter = nullptr; #endif - mutable QMap<quint64, std::function<void(const QVariant &)>> m_variantCallbacks; mutable QMap<quint64, std::function<void(const QString &)>> m_stringCallbacks; - QMap<quint64, std::function<void(const QByteArray &)>> m_pdfResultCallbacks; mutable QAction *actions[QWebEnginePage::WebActionCount]; }; diff --git a/src/core/api/qwebenginepermission.cpp b/src/core/api/qwebenginepermission.cpp new file mode 100644 index 000000000..d898b8c7e --- /dev/null +++ b/src/core/api/qwebenginepermission.cpp @@ -0,0 +1,307 @@ +// Copyright (C) 2024 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 "qwebenginepermission.h" +#include "qwebenginepermission_p.h" +#include "web_contents_adapter.h" +#include "profile_adapter.h" + +QT_BEGIN_NAMESPACE + +QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QWebEnginePermissionPrivate) + +QWebEnginePermissionPrivate::QWebEnginePermissionPrivate() + : QSharedData() + , feature(QWebEnginePermission::Unsupported) +{ +} + +QWebEnginePermissionPrivate::QWebEnginePermissionPrivate(const QUrl &origin_, QWebEnginePermission::Feature feature_, + QSharedPointer<QtWebEngineCore::WebContentsAdapter> webContentsAdapter_, QtWebEngineCore::ProfileAdapter *profileAdapter_) + : QSharedData() + , origin(origin_) + , feature(feature_) + , webContentsAdapter(webContentsAdapter_) + , profileAdapter(profileAdapter_) +{ +} + +/*! + \class QWebEnginePermission + \inmodule QtWebEngineCore + \since 6.8 + \brief A QWebEnginePermission is an object used to access and modify the state of a single permission that's been + granted or denied to a specific origin URL. + + The typical usage pattern is as follows: + \list 1 + \li A website requests a specific feature, triggering the QWebEnginePage::permissionRequested() signal; + \li The signal handler triggers a prompt asking the user whether they want to grant the permission; + \li When the user has made their decision, the application calls \l grant() or \l deny(); + \endlist + + Alternatively, an application interested in modifying already granted permissions may use QWebEngineProfile::listPermissions() + to get a list of existing permissions associated with a profile, or QWebEngineProfile::getPermission() to get + a QWebEnginePermission object for a specific permission. + + The \l origin() property can be used to query which origin the QWebEnginePermission is associated with, while the + \l feature() property describes the associated feature. A website origin is the combination of its scheme, hostname, + and port. Permissions are granted on a per-origin basis; thus, if the web page \c{https://www.example.com:12345/some/page.html} + requests a permission, it will be granted to the origin \c{https://www.example.com:12345/}. + + \l QWebEnginePermission::Feature describes all the feature types Qt WebEngine supports. Some Features are transient; + in practice, this means that they are never remembered, and a website that uses them will trigger a permission + prompt every time the Feature is needed. Transient Features cannot be granted in advance. + + The usability lifetime of a QWebEnginePermission is tied either to its associated QWebEnginePage + (for transient feature types), or QWebEngineProfile (for permanent feature types). A transient permission is one which + needs to be explicitly granted or denied every time it's needed (e.g. webcam/screen sharing permission), whereas a permanent + one might be stored inside the current profile, depending on the value of QWebEngineProfile::persistentPermissionsPolicy(). + You can check whether a QWebEnginePermission is in a valid state using its \l isValid() property. For invalid objects, calls to \l grant(), + \l deny(), or \l reset() will do nothing, while calls to \l state() will always return QWebEnginePermission::Invalid. + + \sa QWebEnginePage::permissionRequested(), QWebEngineProfile::getPermission(), QWebEngineProfile::listPermissions() +*/ + +/*! \fn QWebEnginePermission::QWebEnginePermission() + \internal +*/ + +/*! \internal */ +QWebEnginePermission::QWebEnginePermission() + : d_ptr(new QWebEnginePermissionPrivate()) +{ +} + +/*! \internal */ +QWebEnginePermission::QWebEnginePermission(QWebEnginePermissionPrivate *pvt) + : d_ptr(pvt) +{ +} + +QWebEnginePermission::QWebEnginePermission(const QWebEnginePermission &other) + : d_ptr(new QWebEnginePermissionPrivate(*other.d_ptr)) +{ +} + +QWebEnginePermission::~QWebEnginePermission() = default; + +QWebEnginePermission &QWebEnginePermission::operator=(const QWebEnginePermission &other) +{ + if (this == &other) + return *this; + + d_ptr.reset(new QWebEnginePermissionPrivate(*other.d_ptr)); + return *this; +} + +bool QWebEnginePermission::comparesEqual(const QWebEnginePermission &other) const +{ + if (this == &other) + return true; + + if (d_ptr->feature != other.d_ptr->feature || d_ptr->origin != other.d_ptr->origin) + return false; + + if (isTransient(d_ptr->feature)) { + if (d_ptr->webContentsAdapter != other.d_ptr->webContentsAdapter) + return false; + } else { + QtWebEngineCore::ProfileAdapter *thisProfile = d_ptr->webContentsAdapter + ? d_ptr->webContentsAdapter.toStrongRef()->profileAdapter() + : d_ptr->profileAdapter.get(); + QtWebEngineCore::ProfileAdapter *otherProfile = d_ptr->webContentsAdapter + ? other.d_ptr->webContentsAdapter.toStrongRef()->profileAdapter() + : other.d_ptr->profileAdapter.get(); + + if (thisProfile != otherProfile) + return false; + } + + return true; +} + +/*! + \property QWebEnginePermission::origin + \brief The URL of the permission's associated origin. + + A website origin is the combination of its scheme, hostname, and port. Permissions are granted on a + per-origin basis; thus, if the web page \c{https://www.example.com:12345/some/page.html} + requests a permission, it will be granted to the origin \c{https://www.example.com:12345/}. +*/ +const QUrl QWebEnginePermission::origin() const +{ + return d_ptr->origin; +} + +/*! + \enum QWebEnginePermission::Feature + + This enum type holds the type of the requested feature: + + \value MediaAudioCapture Access to a microphone, or another audio source. This feature is transient. + \value MediaVideoCapture Access to a webcam, or another video source. This feature is transient. + \value MediaAudioVideoCapture Combination of \l MediaAudioCapture and \l MediaVideoCapture. This feature is transient. + \value DesktopVideoCapture Access to the contents of the user's screen. This feature is transient. + \value DesktopAudioVideoCapture Access to the contents of the user's screen, and application audio. This feature is transient. + \value MouseLock Locks the pointer inside an element on the web page. This feature is transient. + \value Notifications Allows the website to send notifications to the user. + \value Geolocation Access to the user's physical location. + \value ClipboardReadWrite Access to the user's clipboard. + \value LocalFontsAccess Access to the fonts installed on the user's machine. Only available on desktops. + \value Unsupported An unsupported feature type. + + \note Transient feature types are ones that will never be remembered by the underlying storage, and will trigger + a permission request every time a website tries to use them. Transient Features can only be denied/granted + as they're needed; any attempts to pre-grant a transient Feature will fail. +*/ + +/*! + \property QWebEnginePermission::feature + \brief The feature type associated with this permission. +*/ +QWebEnginePermission::Feature QWebEnginePermission::feature() const +{ + return d_ptr->feature; +} + +/*! + \enum QWebEnginePermission::State + + This enum type holds the current state of the requested feature: + + \value Invalid Object is in an invalid state, and any attempts to modify the described permission will fail. + \value Ask Either the permission has not been requested before, or the feature() is transient. + \value Granted Permission has already been granted. + \value Denied Permission has already been denied. +*/ + +/*! + \property QWebEnginePermission::state + \brief The current state of the permission. + + If a permission for the specified \l feature() and \l origin() has already been granted or denied, + the return value is QWebEnginePermission::Granted, or QWebEnginePermission::Denied, respectively. + When this is the first time the permission is requested, or if the \l feature() is transient, + the return value is QWebEnginePermission::Ask. If the object is in an invalid state, the returned + value is QWebEnginePermission::Invalid. + + \sa isValid(), isTransient() +*/ +QWebEnginePermission::State QWebEnginePermission::state() const +{ + if (!isValid()) + return Invalid; + if (d_ptr->webContentsAdapter) + return d_ptr->webContentsAdapter.toStrongRef()->getPermissionState(origin(), feature()); + if (d_ptr->profileAdapter) + return d_ptr->profileAdapter->getPermissionState(origin(), feature()); + Q_UNREACHABLE(); + return Ask; +} + +/*! + \property QWebEnginePermission::isValid + \brief Indicates whether attempts to change the permission's state will be successful. + + An invalid QWebEnginePermission is either: + \list + \li One whose \l feature() is unsupported; + \li One whose \l feature() is transient, and the associated page/view has been destroyed; + \li One whose \l feature() is permanent, but the associated profile has been destroyed; + \li One whose \l origin() is invalid. + \endlist + + \sa isTransient() +*/ +bool QWebEnginePermission::isValid() const +{ + if (feature() == Unsupported) + return false; + if (isTransient(feature()) && !d_ptr->webContentsAdapter) + return false; + if (!d_ptr->profileAdapter) + return false; + if (!d_ptr->origin.isValid()) + return false; + return true; +} + +/*! + Allows the associated origin to access the requested feature. Does nothing when \l isValid() evaluates to false. + + \sa deny(), reset(), isValid() +*/ +void QWebEnginePermission::grant() const +{ + if (!isValid()) + return; + if (d_ptr->webContentsAdapter) + d_ptr->webContentsAdapter.toStrongRef()->setFeaturePermission(origin(), feature(), Granted); + else if (d_ptr->profileAdapter) + d_ptr->profileAdapter->setPermission(origin(), feature(), Granted); +} + +/*! + Stops the associated origin from accessing the requested feature. Does nothing when \l isValid() evaluates to false. + + \sa grant(), reset(), isValid() +*/ +void QWebEnginePermission::deny() const +{ + if (!isValid()) + return; + if (d_ptr->webContentsAdapter) + d_ptr->webContentsAdapter.toStrongRef()->setFeaturePermission(origin(), feature(), Denied); + else if (d_ptr->profileAdapter) + d_ptr->profileAdapter->setPermission(origin(), feature(), Denied); +} + +/*! + Removes the permission from the profile's underlying storage. By default, permissions are stored on disk (except for + off-the-record profiles, where permissions are stored in memory and are destroyed with the profile). + This means that an already granted/denied permission will not be requested twice, but will get automatically + granted/denied every subsequent time a website requests it. Calling reset() allows the query to be asked + again the next time the website requests it. + + Does nothing when \l isValid() evaluates to false. + + \sa grant(), deny(), isValid(), QWebEngineProfile::persistentPermissionsPolicy() +*/ +void QWebEnginePermission::reset() const +{ + if (!isValid()) + return; + if (d_ptr->webContentsAdapter) + d_ptr->webContentsAdapter.toStrongRef()->setFeaturePermission(origin(), feature(), Ask); + else if (d_ptr->profileAdapter) + d_ptr->profileAdapter->setPermission(origin(), feature(), Ask); +} + +/*! + Returns whether \a feature is transient, meaning that a permission will be requested + every time the associated functionality is used by a web page. +*/ +bool QWebEnginePermission::isTransient(QWebEnginePermission::Feature feature) +{ + switch (feature) { + case QWebEnginePermission::MediaAudioCapture: + case QWebEnginePermission::MediaVideoCapture: + case QWebEnginePermission::MediaAudioVideoCapture: + case QWebEnginePermission::DesktopVideoCapture: + case QWebEnginePermission::DesktopAudioVideoCapture: + case QWebEnginePermission::MouseLock: + return true; + case QWebEnginePermission::Notifications: + case QWebEnginePermission::Geolocation: + case QWebEnginePermission::ClipboardReadWrite: + case QWebEnginePermission::LocalFontsAccess: + return false; + case QWebEnginePermission::Unsupported: + return false; + } +} + +QT_END_NAMESPACE + +#include "moc_qwebenginepermission.cpp" diff --git a/src/core/api/qwebenginepermission.h b/src/core/api/qwebenginepermission.h new file mode 100644 index 000000000..09db8ce36 --- /dev/null +++ b/src/core/api/qwebenginepermission.h @@ -0,0 +1,90 @@ +// Copyright (C) 2024 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 + +#ifndef QWEBENGINEPERMISSION_H +#define QWEBENGINEPERMISSION_H + +#include <QtWebEngineCore/qtwebenginecoreglobal.h> +#include <QtCore/qobject.h> +#include <QtCore/qurl.h> +#include <QtCore/qshareddata.h> + +QT_BEGIN_NAMESPACE + +struct QWebEnginePermissionPrivate; +QT_DECLARE_QESDP_SPECIALIZATION_DTOR_WITH_EXPORT(QWebEnginePermissionPrivate, + Q_WEBENGINECORE_EXPORT) + +class QWebEnginePermission +{ + Q_GADGET_EXPORT(Q_WEBENGINECORE_EXPORT) + Q_PROPERTY(QUrl origin READ origin CONSTANT FINAL) + Q_PROPERTY(Feature feature READ feature CONSTANT FINAL) + Q_PROPERTY(State state READ state CONSTANT FINAL) + Q_PROPERTY(bool isValid READ isValid CONSTANT FINAL) + Q_CLASSINFO("RegisterEnumClassesUnscoped", "false") + +public: + Q_WEBENGINECORE_EXPORT QWebEnginePermission(); + + Q_WEBENGINECORE_EXPORT QWebEnginePermission(const QWebEnginePermission &other); + Q_WEBENGINECORE_EXPORT QWebEnginePermission(QWebEnginePermissionPrivate *pvt); + Q_WEBENGINECORE_EXPORT ~QWebEnginePermission(); + + Q_WEBENGINECORE_EXPORT QWebEnginePermission &operator=(const QWebEnginePermission &other); + QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QWebEnginePermission) + void swap(QWebEnginePermission &other) noexcept { d_ptr.swap(other.d_ptr); } + + enum Feature : quint8 { + Unsupported, + MediaAudioCapture, + MediaVideoCapture, + MediaAudioVideoCapture, + DesktopVideoCapture, + DesktopAudioVideoCapture, + MouseLock, + Notifications, + Geolocation, + ClipboardReadWrite, + LocalFontsAccess, + }; + Q_ENUM(Feature) + + enum State : quint8 { + Invalid, + Ask, + Granted, + Denied + }; + Q_ENUM(State) + + Q_WEBENGINECORE_EXPORT const QUrl origin() const; + Q_WEBENGINECORE_EXPORT Feature feature() const; + Q_WEBENGINECORE_EXPORT State state() const; + Q_WEBENGINECORE_EXPORT bool isValid() const; + + Q_WEBENGINECORE_EXPORT Q_INVOKABLE void grant() const; + Q_WEBENGINECORE_EXPORT Q_INVOKABLE void deny() const; + Q_WEBENGINECORE_EXPORT Q_INVOKABLE void reset() const; + + Q_WEBENGINECORE_EXPORT Q_INVOKABLE static bool isTransient(QWebEnginePermission::Feature feature); + +private: + inline friend bool operator==(const QWebEnginePermission &lhs, const QWebEnginePermission &rhs) + { return lhs.comparesEqual(rhs); }; + inline friend bool operator!=(const QWebEnginePermission &lhs, const QWebEnginePermission &rhs) + { return !lhs.comparesEqual(rhs); }; + + Q_WEBENGINECORE_EXPORT bool comparesEqual(const QWebEnginePermission &other) const; + +protected: + QExplicitlySharedDataPointer<QWebEnginePermissionPrivate> d_ptr; +}; + + + +Q_DECLARE_SHARED(QWebEnginePermission) + +QT_END_NAMESPACE + +#endif // QWEBENGINEPERMISSION_H diff --git a/src/core/api/qwebenginepermission_p.h b/src/core/api/qwebenginepermission_p.h new file mode 100644 index 000000000..94c898873 --- /dev/null +++ b/src/core/api/qwebenginepermission_p.h @@ -0,0 +1,46 @@ +// Copyright (C) 2024 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 + +#ifndef QWEBENGINEPERMISSION_P_H +#define QWEBENGINEPERMISSION_P_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#include "qwebenginepermission.h" + +#include <QtCore/qpointer.h> +#include <QtCore/qsharedpointer.h> +#include <QtCore/qshareddata.h> + +namespace QtWebEngineCore { +class WebContentsAdapter; +class ProfileAdapter; +} + +QT_BEGIN_NAMESPACE + +struct QWebEnginePermissionPrivate : public QSharedData +{ + Q_WEBENGINECORE_EXPORT QWebEnginePermissionPrivate(); + Q_WEBENGINECORE_EXPORT QWebEnginePermissionPrivate(const QUrl &, QWebEnginePermission::Feature, + QSharedPointer<QtWebEngineCore::WebContentsAdapter>, QtWebEngineCore::ProfileAdapter *); + + QUrl origin; + QWebEnginePermission::Feature feature; + + QWeakPointer<QtWebEngineCore::WebContentsAdapter> webContentsAdapter; + QPointer<QtWebEngineCore::ProfileAdapter> profileAdapter; +}; + +QT_END_NAMESPACE + +#endif // QWEBENGINEPERMISSION_P_H diff --git a/src/core/api/qwebengineprofile.cpp b/src/core/api/qwebengineprofile.cpp index 4eacc8dc7..5d7bb5559 100644 --- a/src/core/api/qwebengineprofile.cpp +++ b/src/core/api/qwebengineprofile.cpp @@ -3,6 +3,7 @@ #include "qwebengineprofile.h" #include "qwebengineprofile_p.h" +#include "qwebengineclienthints.h" #include "qwebenginecookiestore.h" #include "qwebenginedownloadrequest.h" #include "qwebenginedownloadrequest_p.h" @@ -10,6 +11,7 @@ #include "qwebenginesettings.h" #include "qwebenginescriptcollection.h" #include "qwebenginescriptcollection_p.h" +#include "qwebenginepermission_p.h" #include "qtwebenginecoreglobal.h" #include "profile_adapter.h" #include "visited_links_manager_qt.h" @@ -92,7 +94,7 @@ using QtWebEngineCore::ProfileAdapter; /*! \enum QWebEngineProfile::PersistentCookiesPolicy - This enum describes policy for cookie persistency: + This enum describes policy for cookie persistence: \value NoPersistentCookies Both session and persistent cookies are stored in memory. This is the only setting @@ -104,6 +106,28 @@ using QtWebEngineCore::ProfileAdapter; Both session and persistent cookies are saved to and restored from disk. */ +/*! + \enum QWebEngineProfile::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 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 PersistentPermissionsOnDisk + Works the same way as \c PersistentPermissionsInMemory, but the permissions are saved to + and restored from disk. This is the default setting. +*/ + void QWebEngineProfilePrivate::showNotification(QSharedPointer<QtWebEngineCore::UserNotificationController> &controller) { if (m_notificationPresenter) { @@ -128,11 +152,22 @@ void QWebEngineProfilePrivate::showNotification(QSharedPointer<QtWebEngineCore:: \sa QWebEngineDownloadRequest, QWebEnginePage::download() */ +/*! + \fn QWebEngineProfile::clearHttpCacheCompleted() + + \since 6.7 + + This signal is emitted when the clearHttpCache() operation is completed. + + \sa QWebEngineProfile::clearHttpCache() +*/ + QWebEngineProfilePrivate::QWebEngineProfilePrivate(ProfileAdapter* profileAdapter) : m_settings(new QWebEngineSettings()) , m_profileAdapter(profileAdapter) , m_scriptCollection(new QWebEngineScriptCollection( new QWebEngineScriptCollectionPrivate(profileAdapter->userResourceController()))) + , m_clientHints(new QWebEngineClientHints(profileAdapter)) { m_profileAdapter->addClient(this); } @@ -186,11 +221,14 @@ void QWebEngineProfilePrivate::downloadRequested(DownloadItemInfo &info) Q_Q(QWebEngineProfile); 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 = info.accepted ? QWebEngineDownloadRequest::DownloadInProgress : QWebEngineDownloadRequest::DownloadRequested; itemPrivate->startTime = info.startTime; + itemPrivate->downloadUrl = info.url; + itemPrivate->totalBytes = info.totalBytes; itemPrivate->downloadDirectory = QFileInfo(info.path).path(); itemPrivate->downloadFileName = QFileInfo(info.path).fileName(); itemPrivate->suggestedFileName = info.suggestedFileName; @@ -238,6 +276,12 @@ void QWebEngineProfilePrivate::downloadUpdated(const DownloadItemInfo &info) download->d_func()->update(info); } +void QWebEngineProfilePrivate::clearHttpCacheCompleted() +{ + Q_Q(QWebEngineProfile); + Q_EMIT q->clearHttpCacheCompleted(); +} + void QWebEngineProfilePrivate::addWebContentsAdapterClient(QtWebEngineCore::WebContentsAdapterClient *adapter) { Q_ASSERT(m_profileAdapter); @@ -390,6 +434,37 @@ void QWebEngineProfile::setDownloadPath(const QString &path) } /*! + \since 6.5 + + Returns \c true if the push messaging service is enabled. + \note By default the push messaging service is disabled. + + \sa setPushServiceEnabled() +*/ +bool QWebEngineProfile::isPushServiceEnabled() const +{ + const Q_D(QWebEngineProfile); + return d->profileAdapter()->pushServiceEnabled(); +} + +/*! + \since 6.5 + + Enables the push messaging service if \a enable is \c true, otherwise disables it. + + \note \QWE uses \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. + + \sa isPushServiceEnabled() +*/ +void QWebEngineProfile::setPushServiceEnabled(bool enable) +{ + Q_D(QWebEngineProfile); + d->profileAdapter()->setPushServiceEnabled(enable); +} + +/*! Returns the path used for caches. By default, this is below StandardPaths::CacheLocation in a QtWebengine/StorageName specific @@ -426,7 +501,7 @@ void QWebEngineProfile::setCachePath(const QString &path) "Windows NT 6.2" (Windows 8), unless the application does contain a manifest that declares newer Windows versions as supported. - \sa setHttpUserAgent() + \sa setHttpUserAgent(), {windows_manifest} {Windows Application Manifest} */ QString QWebEngineProfile::httpUserAgent() const { @@ -461,7 +536,10 @@ QWebEngineProfile::HttpCacheType QWebEngineProfile::httpCacheType() const /*! Sets the HTTP cache type to \a httpCacheType. - \sa httpCacheType(), setCachePath() + \note Setting the \a httpCacheType to NoCache on the profile, which has already some cache + entries does not trigger the removal of those entries. + + \sa httpCacheType(), setCachePath(), clearHttpCache() */ void QWebEngineProfile::setHttpCacheType(QWebEngineProfile::HttpCacheType httpCacheType) { @@ -516,6 +594,31 @@ void QWebEngineProfile::setPersistentCookiesPolicy(QWebEngineProfile::Persistent } /*! + Returns the current policy for persistent permissions. + + Off-the-record profiles are not allowed to save data to the disk, so they can only return + PersistentPermissionsInMemory or NoPersistentPermissions. + + \sa setPersistentPermissionsPolicy() +*/ +QWebEngineProfile::PersistentPermissionsPolicy QWebEngineProfile::persistentPermissionsPolicy() const +{ + Q_D(const QWebEngineProfile); + return QWebEngineProfile::PersistentPermissionsPolicy(d->profileAdapter()->persistentPermissionsPolicy()); +} + +/*! + Sets the policy for persistent permissions to \a newPersistentPermissionsPolicy. + + \sa persistentPermissionsPolicy() +*/ +void QWebEngineProfile::setPersistentPermissionsPolicy(QWebEngineProfile::PersistentPermissionsPolicy newPersistentPermissionsPolicy) +{ + Q_D(QWebEngineProfile); + d->profileAdapter()->setPersistentPermissionsPolicy(ProfileAdapter::PersistentPermissionsPolicy(newPersistentPermissionsPolicy)); +} + +/*! Returns the maximum size of the HTTP cache in bytes. Will return \c 0 if the size is automatically controlled by QtWebEngine. @@ -780,6 +883,12 @@ void QWebEngineProfile::removeAllUrlSchemeHandlers() \since 5.7 Removes the profile's cache entries. + + \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 QWebEngineProfile::clearHttpCacheCompleted() */ void QWebEngineProfile::clearHttpCache() { @@ -868,6 +977,107 @@ void QWebEngineProfile::requestIconForIconURL(const QUrl &url, int desiredSizeIn iconAvailableCallback); } +/*! + * 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 + */ +QWebEnginePermission QWebEngineProfile::getPermission(const QUrl &securityOrigin, QWebEnginePermission::Feature feature) const +{ + Q_D(const QWebEngineProfile); + + 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); +} + +/*! + * 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(), QWebEnginePermission::Feature + */ +QList<QWebEnginePermission> QWebEngineProfile::listPermissions() const +{ + Q_D(const QWebEngineProfile); + if (persistentPermissionsPolicy() == NoPersistentPermissions) + return QList<QWebEnginePermission>(); + return d->profileAdapter()->listPermissions(); +} + +/*! + * 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(), QWebEnginePermission::Feature + */ +QList<QWebEnginePermission> QWebEngineProfile::listPermissions(const QUrl &securityOrigin) const +{ + Q_D(const QWebEngineProfile); + if (persistentPermissionsPolicy() == NoPersistentPermissions) + return QList<QWebEnginePermission>(); + return d->profileAdapter()->listPermissions(securityOrigin); +} + +/*! + * 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> QWebEngineProfile::listPermissions(QWebEnginePermission::Feature feature) const +{ + Q_D(const QWebEngineProfile); + 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); +} + +/*! + Return the Client Hints settings associated with this browsing context. + + \since 6.8 + \sa QWebEngineClientHints +*/ +QWebEngineClientHints *QWebEngineProfile::clientHints() const +{ + Q_D(const QWebEngineProfile); + return d->m_clientHints.data(); +} + QT_END_NAMESPACE #include "moc_qwebengineprofile.cpp" diff --git a/src/core/api/qwebengineprofile.h b/src/core/api/qwebengineprofile.h index c29202973..573f39e7d 100644 --- a/src/core/api/qwebengineprofile.h +++ b/src/core/api/qwebengineprofile.h @@ -5,6 +5,7 @@ #define QWEBENGINEPROFILE_H #include <QtWebEngineCore/qtwebenginecoreglobal.h> +#include <QtWebEngineCore/qwebenginepermission.h> #include <QtCore/qobject.h> #include <QtCore/qscopedpointer.h> @@ -17,6 +18,7 @@ QT_BEGIN_NAMESPACE class QUrl; class QWebEngineClientCertificateStore; +class QWebEngineClientHints; class QWebEngineCookieStore; class QWebEngineDownloadRequest; class QWebEngineNotification; @@ -48,6 +50,13 @@ public: }; Q_ENUM(PersistentCookiesPolicy) + enum PersistentPermissionsPolicy : quint8 { + NoPersistentPermissions, + PersistentPermissionsInMemory, + PersistentPermissionsOnDisk, + }; + Q_ENUM(PersistentPermissionsPolicy) + QString storageName() const; bool isOffTheRecord() const; @@ -69,6 +78,9 @@ public: PersistentCookiesPolicy persistentCookiesPolicy() const; void setPersistentCookiesPolicy(QWebEngineProfile::PersistentCookiesPolicy); + PersistentPermissionsPolicy persistentPermissionsPolicy() const; + void setPersistentPermissionsPolicy(QWebEngineProfile::PersistentPermissionsPolicy); + int httpCacheMaximumSize() const; void setHttpCacheMaximumSize(int maxSize); @@ -81,6 +93,7 @@ public: QWebEngineSettings *settings() const; QWebEngineScriptCollection *scripts() const; + QWebEngineClientHints *clientHints() const; const QWebEngineUrlSchemeHandler *urlSchemeHandler(const QByteArray &) const; void installUrlSchemeHandler(const QByteArray &scheme, QWebEngineUrlSchemeHandler *); @@ -98,6 +111,9 @@ public: QString downloadPath() const; void setDownloadPath(const QString &path); + bool isPushServiceEnabled() const; + void setPushServiceEnabled(bool enabled); + void setNotificationPresenter(std::function<void(std::unique_ptr<QWebEngineNotification>)> notificationPresenter); QWebEngineClientCertificateStore *clientCertificateStore(); @@ -105,10 +121,16 @@ public: void requestIconForPageURL(const QUrl &url, int desiredSizeInPixel, std::function<void(const QIcon &, const QUrl &, const QUrl &)> iconAvailableCallback) const; void requestIconForIconURL(const QUrl &url, int desiredSizeInPixel, std::function<void(const QIcon &, const QUrl &)> iconAvailableCallback) const; + QWebEnginePermission getPermission(const QUrl &securityOrigin, QWebEnginePermission::Feature feature) const; + QList<QWebEnginePermission> listPermissions() const; + QList<QWebEnginePermission> listPermissions(const QUrl &securityOrigin) const; + QList<QWebEnginePermission> listPermissions(QWebEnginePermission::Feature feature) const; + static QWebEngineProfile *defaultProfile(); Q_SIGNALS: void downloadRequested(QWebEngineDownloadRequest *download); + void clearHttpCacheCompleted(); private: Q_DISABLE_COPY(QWebEngineProfile) diff --git a/src/core/api/qwebengineprofile_p.h b/src/core/api/qwebengineprofile_p.h index b12f778bc..0ccc27037 100644 --- a/src/core/api/qwebengineprofile_p.h +++ b/src/core/api/qwebengineprofile_p.h @@ -31,12 +31,13 @@ class WebEngineSettings; QT_BEGIN_NAMESPACE +class QWebEngineClientHints; class QWebEngineNotification; class QWebEngineProfile; class QWebEngineScriptCollection; class QWebEngineSettings; -class Q_WEBENGINECORE_PRIVATE_EXPORT QWebEngineProfilePrivate : public QtWebEngineCore::ProfileAdapterClient { +class Q_WEBENGINECORE_EXPORT QWebEngineProfilePrivate : public QtWebEngineCore::ProfileAdapterClient { public: Q_DECLARE_PUBLIC(QWebEngineProfile) QWebEngineProfilePrivate(QtWebEngineCore::ProfileAdapter *profileAdapter); @@ -54,6 +55,7 @@ public: void downloadUpdated(const DownloadItemInfo &info) override; void showNotification(QSharedPointer<QtWebEngineCore::UserNotificationController> &) override; + void clearHttpCacheCompleted() override; void addWebContentsAdapterClient(QtWebEngineCore::WebContentsAdapterClient *adapter) override; void removeWebContentsAdapterClient(QtWebEngineCore::WebContentsAdapterClient *adapter) override; @@ -63,6 +65,7 @@ private: QWebEngineSettings *m_settings; QPointer<QtWebEngineCore::ProfileAdapter> m_profileAdapter; QScopedPointer<QWebEngineScriptCollection> m_scriptCollection; + QScopedPointer<QWebEngineClientHints> m_clientHints; QMap<quint32, QPointer<QWebEngineDownloadRequest>> m_ongoingDownloads; std::function<void(std::unique_ptr<QWebEngineNotification>)> m_notificationPresenter; }; diff --git a/src/core/api/qwebenginequotarequest.cpp b/src/core/api/qwebenginequotarequest.cpp index ca1289625..3c312216d 100644 --- a/src/core/api/qwebenginequotarequest.cpp +++ b/src/core/api/qwebenginequotarequest.cpp @@ -3,76 +3,54 @@ #include "qwebenginequotarequest.h" -#include "quota_request_controller.h" +#if QT_DEPRECATED_SINCE(6, 5) QT_BEGIN_NAMESPACE /*! \class QWebEngineQuotaRequest - \brief The QWebEngineQuotaRequest class enables accepting or rejecting - requests for larger persistent storage than the application's current - allocation in File System API. - \since 5.11 \inmodule QtWebEngineCore + \deprecated [6.5] Requesting host quota is no longer supported by Chromium. + + The behavior of navigator.webkitPersistentStorage + is identical to navigator.webkitTemporaryStorage. - This class is used by the QWebEnginePage::quotaRequested() signal to \l - accept() or \l reject() a request for an increase in the persistent storage - allocated to the application. The default quota is 0 bytes. + For further details, see https://crbug.com/1233525 */ /*! \fn QWebEngineQuotaRequest::QWebEngineQuotaRequest() \internal */ -/*! \internal */ -QWebEngineQuotaRequest::QWebEngineQuotaRequest(QSharedPointer<QtWebEngineCore::QuotaRequestController> controller) - : d_ptr(controller) -{} - -/*! - Rejects a request for larger persistent storage. -*/ void QWebEngineQuotaRequest::reject() { - d_ptr->reject(); } -/*! - Accepts a request for larger persistent storage. -*/ void QWebEngineQuotaRequest::accept() { - d_ptr->accept(); } /*! \property QWebEngineQuotaRequest::origin - \brief The URL of the web page that issued the quota request. */ QUrl QWebEngineQuotaRequest::origin() const { - return d_ptr->origin(); + return QUrl(); } /*! \property QWebEngineQuotaRequest::requestedSize - \brief Contains the size of the requested disk space in bytes. */ qint64 QWebEngineQuotaRequest::requestedSize() const { - return d_ptr->requestedSize(); + return 0; } -/*! \fn bool QWebEngineQuotaRequest::operator==(const QWebEngineQuotaRequest &that) const - Returns \c true if \a that points to the same object as this quota request. -*/ +QT_END_NAMESPACE -/*! \fn bool QWebEngineQuotaRequest::operator!=(const QWebEngineQuotaRequest &that) const - Returns \c true if \a that points to a different object than this request. -*/ +#endif // QT_DEPRECATED_SINCE(6, 5) -QT_END_NAMESPACE #include "moc_qwebenginequotarequest.cpp" diff --git a/src/core/api/qwebenginequotarequest.h b/src/core/api/qwebenginequotarequest.h index c10789360..f542f5576 100644 --- a/src/core/api/qwebenginequotarequest.h +++ b/src/core/api/qwebenginequotarequest.h @@ -6,13 +6,9 @@ #include <QtWebEngineCore/qtwebenginecoreglobal.h> -#include <QtCore/qsharedpointer.h> #include <QtCore/qurl.h> -namespace QtWebEngineCore { -class QuotaPermissionContextQt; -class QuotaRequestController; -} // namespace QtWebEngineCore +#if QT_DEPRECATED_SINCE(6, 5) QT_BEGIN_NAMESPACE @@ -22,20 +18,18 @@ class Q_WEBENGINECORE_EXPORT QWebEngineQuotaRequest Q_PROPERTY(QUrl origin READ origin CONSTANT FINAL) Q_PROPERTY(qint64 requestedSize READ requestedSize CONSTANT FINAL) public: + QT_DEPRECATED_VERSION_X_6_5("Requesting host quota is no longer supported.") QWebEngineQuotaRequest() {} Q_INVOKABLE void accept(); Q_INVOKABLE void reject(); QUrl origin() const; qint64 requestedSize() const; - bool operator==(const QWebEngineQuotaRequest &that) const { return d_ptr == that.d_ptr; } - bool operator!=(const QWebEngineQuotaRequest &that) const { return d_ptr != that.d_ptr; } - -private: - QWebEngineQuotaRequest(QSharedPointer<QtWebEngineCore::QuotaRequestController>); - friend QtWebEngineCore::QuotaPermissionContextQt; - QSharedPointer<QtWebEngineCore::QuotaRequestController> d_ptr; + bool operator==(const QWebEngineQuotaRequest &) const { Q_UNREACHABLE(); } + bool operator!=(const QWebEngineQuotaRequest &) const { Q_UNREACHABLE(); } }; QT_END_NAMESPACE +#endif // QT_DEPRECATED_SINCE(6, 5) + #endif // QWEBENGINEQUOTAREQUEST_H diff --git a/src/core/api/qwebenginescriptcollection.cpp b/src/core/api/qwebenginescriptcollection.cpp index 0b157755c..7867192b6 100644 --- a/src/core/api/qwebenginescriptcollection.cpp +++ b/src/core/api/qwebenginescriptcollection.cpp @@ -120,7 +120,7 @@ QWebEngineScriptCollectionPrivate::QWebEngineScriptCollectionPrivate(QtWebEngine int QWebEngineScriptCollectionPrivate::count() const { - return m_scripts.count(); + return m_scripts.size(); } bool QWebEngineScriptCollectionPrivate::contains(const QWebEngineScript &s) const @@ -148,7 +148,7 @@ QList<QWebEngineScript> QWebEngineScriptCollectionPrivate::toList(const QString return m_scripts; QList<QWebEngineScript> ret; - for (const QWebEngineScript &script : qAsConst(m_scripts)) + for (const QWebEngineScript &script : std::as_const(m_scripts)) if (scriptName == script.name()) ret.append(script); return ret; @@ -173,7 +173,7 @@ void QWebEngineScriptCollectionPrivate::initializationFinished(QSharedPointer<Qt Q_ASSERT(m_contents); Q_ASSERT(contents); - for (const QWebEngineScript &script : qAsConst(m_scripts)) + for (const QWebEngineScript &script : std::as_const(m_scripts)) m_scriptController->addUserScript(*script.d, contents.data()); m_contents = contents; } diff --git a/src/core/api/qwebenginescriptcollection_p.h b/src/core/api/qwebenginescriptcollection_p.h index d675e128a..67b3aa4a7 100644 --- a/src/core/api/qwebenginescriptcollection_p.h +++ b/src/core/api/qwebenginescriptcollection_p.h @@ -27,7 +27,7 @@ class UserResourceControllerHost; } // namespace QT_BEGIN_NAMESPACE -class Q_WEBENGINECORE_PRIVATE_EXPORT QWebEngineScriptCollectionPrivate +class Q_WEBENGINECORE_EXPORT QWebEngineScriptCollectionPrivate { public: QWebEngineScriptCollectionPrivate(QtWebEngineCore::UserResourceControllerHost *, QSharedPointer<QtWebEngineCore::WebContentsAdapter> = QSharedPointer<QtWebEngineCore::WebContentsAdapter>()); diff --git a/src/core/api/qwebenginesettings.cpp b/src/core/api/qwebenginesettings.cpp index e9f0eb4db..f19d8efe5 100644 --- a/src/core/api/qwebenginesettings.cpp +++ b/src/core/api/qwebenginesettings.cpp @@ -103,4 +103,19 @@ void QWebEngineSettings::setParentSettings(QWebEngineSettings *parentSettings) d_ptr->setParentSettings(parentSettings->d_ptr.data()); } +void QWebEngineSettings::setImageAnimationPolicy(QWebEngineSettings::ImageAnimationPolicy policy) +{ + d_ptr->setImageAnimationPolicy(policy); +} + +QWebEngineSettings::ImageAnimationPolicy QWebEngineSettings::imageAnimationPolicy() const +{ + return d_ptr->imageAnimationPolicy(); +} + +void QWebEngineSettings::resetImageAnimationPolicy() +{ + d_ptr->setImageAnimationPolicy(QWebEngineSettings::InheritedImageAnimationPolicy); +} + QT_END_NAMESPACE diff --git a/src/core/api/qwebenginesettings.h b/src/core/api/qwebenginesettings.h index 09656f670..7f89f1ea6 100644 --- a/src/core/api/qwebenginesettings.h +++ b/src/core/api/qwebenginesettings.h @@ -60,6 +60,8 @@ public: DnsPrefetchEnabled, PdfViewerEnabled, NavigateOnDropEnabled, + ReadingFromCanvasEnabled, + ForceDarkMode, }; enum FontSize { @@ -76,6 +78,13 @@ public: AllowAllUnknownUrlSchemes }; + enum ImageAnimationPolicy { + InheritedImageAnimationPolicy = 0, + AllowImageAnimation, + AnimateImageOnce, + DisallowImageAnimation + }; + public: ~QWebEngineSettings(); void setFontFamily(FontFamily which, const QString &family); @@ -97,6 +106,10 @@ public: void setUnknownUrlSchemePolicy(UnknownUrlSchemePolicy policy); void resetUnknownUrlSchemePolicy(); + void setImageAnimationPolicy(ImageAnimationPolicy policy); + ImageAnimationPolicy imageAnimationPolicy() const; + void resetImageAnimationPolicy(); + private: explicit QWebEngineSettings(QWebEngineSettings *parentSettings = nullptr); void setParentSettings(QWebEngineSettings *parentSettings); diff --git a/src/core/api/qwebengineurlrequestinfo.cpp b/src/core/api/qwebengineurlrequestinfo.cpp index e330a16d9..b323b5ec3 100644 --- a/src/core/api/qwebengineurlrequestinfo.cpp +++ b/src/core/api/qwebengineurlrequestinfo.cpp @@ -5,9 +5,17 @@ #include "qwebengineurlrequestinfo_p.h" #include "web_contents_adapter_client.h" +#include "net/resource_request_body_qt.h" + +#include <memory> +#include <utility> QT_BEGIN_NAMESPACE +// We changed the type from QScopedPointer to unique_ptr, make sure it's binary compatible: +static_assert(sizeof(QScopedPointer<QWebEngineUrlRequestInfoPrivate>) + == sizeof(std::unique_ptr<QWebEngineUrlRequestInfoPrivate>)); + ASSERT_ENUMS_MATCH(QtWebEngineCore::WebContentsAdapterClient::LinkNavigation, QWebEngineUrlRequestInfo::NavigationTypeLink) ASSERT_ENUMS_MATCH(QtWebEngineCore::WebContentsAdapterClient::TypedNavigation, QWebEngineUrlRequestInfo::NavigationTypeTyped) ASSERT_ENUMS_MATCH(QtWebEngineCore::WebContentsAdapterClient::FormSubmittedNavigation, @@ -69,10 +77,11 @@ ASSERT_ENUMS_MATCH(QtWebEngineCore::WebContentsAdapterClient::RedirectNavigation execution of this function is finished. */ -QWebEngineUrlRequestInfoPrivate::QWebEngineUrlRequestInfoPrivate(QWebEngineUrlRequestInfo::ResourceType resource, - QWebEngineUrlRequestInfo::NavigationType navigation, - const QUrl &u, const QUrl &fpu, const QUrl &i, - const QByteArray &m) +QWebEngineUrlRequestInfoPrivate::QWebEngineUrlRequestInfoPrivate( + QWebEngineUrlRequestInfo::ResourceType resource, + QWebEngineUrlRequestInfo::NavigationType navigation, const QUrl &u, const QUrl &fpu, + const QUrl &i, const QByteArray &m, QtWebEngineCore::ResourceRequestBody *const rb, + const QHash<QByteArray, QByteArray> &h) : resourceType(resource) , navigationType(navigation) , shouldBlockRequest(false) @@ -82,6 +91,8 @@ QWebEngineUrlRequestInfoPrivate::QWebEngineUrlRequestInfoPrivate(QWebEngineUrlRe , initiator(i) , method(m) , changed(false) + , extraHeaders(h) + , resourceRequestBody(rb) {} /*! @@ -92,14 +103,17 @@ QWebEngineUrlRequestInfo::QWebEngineUrlRequestInfo() {} /*! \internal */ -QWebEngineUrlRequestInfo::QWebEngineUrlRequestInfo(QWebEngineUrlRequestInfo &&p) : d_ptr(p.d_ptr.take()) {} +QWebEngineUrlRequestInfo::QWebEngineUrlRequestInfo(QWebEngineUrlRequestInfo &&p) + : d_ptr(std::move(p.d_ptr)) +{ +} /*! \internal */ QWebEngineUrlRequestInfo &QWebEngineUrlRequestInfo::operator=(QWebEngineUrlRequestInfo &&p) { - d_ptr.reset(p.d_ptr.take()); + d_ptr = std::move(p.d_ptr); return *this; } @@ -147,6 +161,7 @@ QWebEngineUrlRequestInfo::QWebEngineUrlRequestInfo(QWebEngineUrlRequestInfoPriva \value ResourceTypeNavigationPreloadSubFrame A sub-frame service worker navigation preload request. (Added in Qt 5.14) \value ResourceTypeWebSocket A WebSocket request. (Added in Qt 6.4) \value ResourceTypeUnknown Unknown request type. + \value ResourceTypeJson A JSON module. (Added in Qt 6.9) \note For forward compatibility all values not matched should be treated as unknown, not just \c ResourceTypeUnknown. @@ -229,6 +244,20 @@ QByteArray QWebEngineUrlRequestInfo::requestMethod() const } /*! + Returns a pointer to a QIODevice that gives access to the request body. + The request body can contain data for example when the request is + a POST request. If the request body is empty the QIODevice reflects this + and does not return any data when performing read operations on it. + + \since 6.7 +*/ + +QIODevice *QWebEngineUrlRequestInfo::requestBody() const +{ + return d_ptr->resourceRequestBody; +} + +/*! \internal */ bool QWebEngineUrlRequestInfo::changed() const @@ -274,8 +303,36 @@ void QWebEngineUrlRequestInfo::block(bool shouldBlock) void QWebEngineUrlRequestInfo::setHttpHeader(const QByteArray &name, const QByteArray &value) { - d_ptr->changed = true; + // Headers are case insentive, so we need to compare manually + for (auto it = d_ptr->extraHeaders.begin(); it != d_ptr->extraHeaders.end(); ++it) { + if (it.key().compare(name, Qt::CaseInsensitive) == 0) { + d_ptr->extraHeaders.erase(it); + break; + } + } + d_ptr->extraHeaders.insert(name, value); } +/*! + Returns the request headers. + \since 6.5 + \note Not all headers are visible at this stage as Chromium will add + security and proxy headers at a later stage. +*/ + +QHash<QByteArray, QByteArray> QWebEngineUrlRequestInfo::httpHeaders() const +{ + return d_ptr->extraHeaders; +} + +/*! + \internal +*/ +void QWebEngineUrlRequestInfoPrivate::appendFileToResourceRequestBodyForTest(const QString &path) +{ + if (resourceRequestBody) + resourceRequestBody->appendFilesForTest(path); +} + QT_END_NAMESPACE diff --git a/src/core/api/qwebengineurlrequestinfo.h b/src/core/api/qwebengineurlrequestinfo.h index 125e5373c..b8a02d07a 100644 --- a/src/core/api/qwebengineurlrequestinfo.h +++ b/src/core/api/qwebengineurlrequestinfo.h @@ -6,14 +6,18 @@ #include <QtWebEngineCore/qtwebenginecoreglobal.h> -#include <QtCore/qscopedpointer.h> #include <QtCore/qurl.h> +#include <QtCore/qiodevice.h> + +#include <memory> namespace QtWebEngineCore { class ContentBrowserClientQt; class InterceptedRequest; } // namespace QtWebEngineCore +class TestPostRequestInterceptor; + QT_BEGIN_NAMESPACE class QWebEngineUrlRequestInfoPrivate; @@ -43,8 +47,9 @@ public: ResourceTypePluginResource, // A resource requested by a plugin ResourceTypeNavigationPreloadMainFrame = 19, // A main-frame service worker navigation preload request ResourceTypeNavigationPreloadSubFrame, // A sub-frame service worker navigation preload request + ResourceTypeJson, // a JSON module (import ... with { type: "json" }) #ifndef Q_QDOC - ResourceTypeLast = ResourceTypeNavigationPreloadSubFrame, + ResourceTypeLast = ResourceTypeJson, #endif ResourceTypeWebSocket = 254, ResourceTypeUnknown = 255 @@ -67,15 +72,18 @@ public: QUrl firstPartyUrl() const; QUrl initiator() const; QByteArray requestMethod() const; + QIODevice *requestBody() const; bool changed() const; void block(bool shouldBlock); void redirect(const QUrl &url); void setHttpHeader(const QByteArray &name, const QByteArray &value); + QHash<QByteArray, QByteArray> httpHeaders() const; private: friend class QtWebEngineCore::ContentBrowserClientQt; friend class QtWebEngineCore::InterceptedRequest; + friend class ::TestPostRequestInterceptor; Q_DISABLE_COPY(QWebEngineUrlRequestInfo) Q_DECLARE_PRIVATE(QWebEngineUrlRequestInfo) @@ -86,7 +94,7 @@ private: QWebEngineUrlRequestInfo(QWebEngineUrlRequestInfo &&p); QWebEngineUrlRequestInfo &operator=(QWebEngineUrlRequestInfo &&p); ~QWebEngineUrlRequestInfo(); - QScopedPointer<QWebEngineUrlRequestInfoPrivate> d_ptr; + std::unique_ptr<QWebEngineUrlRequestInfoPrivate> d_ptr; }; QT_END_NAMESPACE diff --git a/src/core/api/qwebengineurlrequestinfo_p.h b/src/core/api/qwebengineurlrequestinfo_p.h index ec9cdda69..95cc72362 100644 --- a/src/core/api/qwebengineurlrequestinfo_p.h +++ b/src/core/api/qwebengineurlrequestinfo_p.h @@ -27,15 +27,22 @@ namespace net { class URLRequest; } +namespace QtWebEngineCore { +class ResourceRequestBody; +} + QT_BEGIN_NAMESPACE -class QWebEngineUrlRequestInfoPrivate +class Q_WEBENGINECORE_EXPORT QWebEngineUrlRequestInfoPrivate { Q_DECLARE_PUBLIC(QWebEngineUrlRequestInfo) public: QWebEngineUrlRequestInfoPrivate(QWebEngineUrlRequestInfo::ResourceType resource, - QWebEngineUrlRequestInfo::NavigationType navigation, const QUrl &u, const QUrl &fpu, - const QUrl &i, const QByteArray &m); + QWebEngineUrlRequestInfo::NavigationType navigation, + const QUrl &u, const QUrl &fpu, const QUrl &i, + const QByteArray &m, + QtWebEngineCore::ResourceRequestBody *const rb = nullptr, + const QHash<QByteArray, QByteArray> &h = {}); QWebEngineUrlRequestInfo::ResourceType resourceType; QWebEngineUrlRequestInfo::NavigationType navigationType; @@ -47,8 +54,11 @@ public: const QByteArray method; bool changed; QHash<QByteArray, QByteArray> extraHeaders; + QtWebEngineCore::ResourceRequestBody *const resourceRequestBody; QWebEngineUrlRequestInfo *q_ptr; + + void appendFileToResourceRequestBodyForTest(const QString &path); }; QT_END_NAMESPACE diff --git a/src/core/api/qwebengineurlrequestinterceptor.cpp b/src/core/api/qwebengineurlrequestinterceptor.cpp new file mode 100644 index 000000000..c3cd49a5b --- /dev/null +++ b/src/core/api/qwebengineurlrequestinterceptor.cpp @@ -0,0 +1,11 @@ +// Copyright (C) 2021 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 "qwebengineurlrequestinterceptor.h" + +QT_BEGIN_NAMESPACE + +// Has to stay empty till Qt7 +QWebEngineUrlRequestInterceptor::~QWebEngineUrlRequestInterceptor() = default; + +QT_END_NAMESPACE diff --git a/src/core/api/qwebengineurlrequestinterceptor.h b/src/core/api/qwebengineurlrequestinterceptor.h index 98f135e73..2ca8ee914 100644 --- a/src/core/api/qwebengineurlrequestinterceptor.h +++ b/src/core/api/qwebengineurlrequestinterceptor.h @@ -14,10 +14,9 @@ QT_BEGIN_NAMESPACE class Q_WEBENGINECORE_EXPORT QWebEngineUrlRequestInterceptor : public QObject { Q_OBJECT - Q_DISABLE_COPY(QWebEngineUrlRequestInterceptor) public: explicit QWebEngineUrlRequestInterceptor(QObject *p = nullptr) : QObject(p) {} - + ~QWebEngineUrlRequestInterceptor() override; virtual void interceptRequest(QWebEngineUrlRequestInfo &info) = 0; }; diff --git a/src/core/api/qwebengineurlrequestjob.cpp b/src/core/api/qwebengineurlrequestjob.cpp index 6c0adfddf..5ad22f344 100644 --- a/src/core/api/qwebengineurlrequestjob.cpp +++ b/src/core/api/qwebengineurlrequestjob.cpp @@ -32,7 +32,7 @@ QT_BEGIN_NAMESPACE This enum type holds the type of the error that occurred: \value NoError - The request was successful. + The request was successful. (Deprecated since Qt 6.7) \value UrlNotFound The requested URL was not found. \value UrlInvalid @@ -112,6 +112,32 @@ QMap<QByteArray, QByteArray> QWebEngineUrlRequestJob::requestHeaders() const } /*! + Returns a pointer to a QIODevice that gives access to the request body. + The request body can contain data for example when the request is + a POST request. If the request body is empty the QIODevice reflects this + and does not return any data when performing read operations on it. + + \since 6.7 + \sa QIODevice +*/ +QIODevice *QWebEngineUrlRequestJob::requestBody() const +{ + return d_ptr->requestBody(); +} + +/*! + \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 QMultiMap<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..858c03e6e 100644 --- a/src/core/api/qwebengineurlrequestjob.h +++ b/src/core/api/qwebengineurlrequestjob.h @@ -26,7 +26,10 @@ public: ~QWebEngineUrlRequestJob(); enum Error { - NoError = 0, +#if QT_DEPRECATED_SINCE(6, 7) + NoError Q_DECL_ENUMERATOR_DEPRECATED_X( + "This attribute has no effect.") = 0, +#endif UrlNotFound, UrlInvalid, RequestAborted, @@ -39,10 +42,13 @@ public: QByteArray requestMethod() const; QUrl initiator() const; QMap<QByteArray, QByteArray> requestHeaders() const; + QIODevice *requestBody() const; void reply(const QByteArray &contentType, QIODevice *device); void fail(Error error); void redirect(const QUrl &url); + void setAdditionalResponseHeaders( + const QMultiMap<QByteArray, QByteArray> &additionalResponseHeaders) const; private: QWebEngineUrlRequestJob(QtWebEngineCore::URLRequestCustomJobDelegate *); diff --git a/src/core/api/qwebengineurlscheme.cpp b/src/core/api/qwebengineurlscheme.cpp index 4af89c616..be56a3048 100644 --- a/src/core/api/qwebengineurlscheme.cpp +++ b/src/core/api/qwebengineurlscheme.cpp @@ -162,6 +162,11 @@ public: this includes access from other schemes. The appropriate CORS headers are generated automatically by the QWebEngineUrlRequestJob class. By default only \c http and \c https are CORS enabled. (Added in Qt 5.14) + + \value [since 6.6] FetchApiAllowed + Enables a URL scheme to be used by the HTML5 fetch API and \c XMLHttpRequest.send with + a body. By default only \c http and \c https can be send to using the Fetch API or with + an XMLHttpRequest with a body. */ QWebEngineUrlScheme::QWebEngineUrlScheme(QWebEngineUrlSchemePrivate *d) : d(d) {} @@ -367,7 +372,7 @@ void QWebEngineUrlScheme::registerScheme(const QWebEngineUrlScheme &scheme) */ QWebEngineUrlScheme QWebEngineUrlScheme::schemeByName(const QByteArray &name) { - base::StringPiece namePiece{ name.data(), static_cast<size_t>(name.size()) }; + std::string_view namePiece{ name.data(), static_cast<size_t>(name.size()) }; if (const url::CustomScheme *cs = url::CustomScheme::FindScheme(namePiece)) return QWebEngineUrlScheme(new QWebEngineUrlSchemePrivate(*cs)); return QWebEngineUrlScheme(); diff --git a/src/core/api/qwebengineurlscheme.h b/src/core/api/qwebengineurlscheme.h index 5b6e088cf..35498a68e 100644 --- a/src/core/api/qwebengineurlscheme.h +++ b/src/core/api/qwebengineurlscheme.h @@ -42,6 +42,7 @@ public: ViewSourceAllowed = 0x20, ContentSecurityPolicyIgnored = 0x40, CorsEnabled = 0x80, + FetchApiAllowed = 0x100, }; Q_DECLARE_FLAGS(Flags, Flag) Q_FLAG(Flags) diff --git a/src/core/api/qwebengineurlschemehandler.cpp b/src/core/api/qwebengineurlschemehandler.cpp index e78a206d6..e01ecef49 100644 --- a/src/core/api/qwebengineurlschemehandler.cpp +++ b/src/core/api/qwebengineurlschemehandler.cpp @@ -12,9 +12,23 @@ QT_BEGIN_NAMESPACE \brief The QWebEngineUrlSchemeHandler class is a base class for handling custom URL schemes. \since 5.6 + A custom scheme handler is, broadly speaking, similar to a web application + served over HTTP. However, because custom schemes are integrated directly + into the web engine, they have the advantage in terms of efficiency and security: + There is no need for generating and parsing HTTP messages or for transferring data + over sockets, nor any way to intercept or monitor the traffic. + To implement a custom URL scheme for QtWebEngine, you first have to create an instance of QWebEngineUrlScheme and register it using QWebEngineUrlScheme::registerScheme(). + As custom schemes are integrated directly into the web engine, they do not + necessarily need to follow the standard security rules which apply to + ordinary web content. Depending on the chosen configuration, content served + over a custom scheme may be given access to local resources, be set to + ignore Content-Security-Policy rules, or conversely, be denied access to any + other content entirely. If it is to be accessed by normal content, ensure cross-origin + access is enabled, and if accessed from HTTPS that it is marked as secure. + \note Make sure that you create and register the scheme object \e before the QGuiApplication or QApplication object is instantiated. @@ -30,10 +44,23 @@ QT_BEGIN_NAMESPACE { public: MySchemeHandler(QObject *parent = nullptr); - void requestStarted(QWebEngineUrlRequestJob *request) + void requestStarted(QWebEngineUrlRequestJob *job) { - // .... + const QByteArray method = job->requestMethod(); + const QUrl url = job->requestUrl(); + + if (isValidUrl(url)) { + if (method == QByteArrayLiteral("GET")) { + job->reply(QByteArrayLiteral("text/html"), makeReply(url)); + else // Unsupported method + job->fail(QWebEngineUrlRequestJob::RequestDenied); + } else { + // Invalid URL + job->fail(QWebEngineUrlRequestJob::UrlNotFound); + } } + bool isValidUrl(const QUrl &url) const // .... + QIODevice *makeReply(const QUrl &url) // .... }; int main(int argc, char **argv) @@ -56,7 +83,7 @@ QT_BEGIN_NAMESPACE \inmodule QtWebEngineCore - \sa {QWebEngineUrlScheme}, {WebEngine Widgets WebUI Example} + \sa {QWebEngineUrlScheme} */ /*! diff --git a/src/core/api/qwebenginewebauthuxrequest.cpp b/src/core/api/qwebenginewebauthuxrequest.cpp new file mode 100644 index 000000000..1f09e55bb --- /dev/null +++ b/src/core/api/qwebenginewebauthuxrequest.cpp @@ -0,0 +1,480 @@ +// Copyright (C) 2023 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 "qwebenginewebauthuxrequest.h" +#include "qwebenginewebauthuxrequest_p.h" +#include "authenticator_request_dialog_controller.h" + +/*! + \qmltype WebEngineWebAuthUxRequest + \instantiates QWebEngineWebAuthUxRequest + \inqmlmodule QtWebEngine + \since QtWebEngine 6.7 + \brief Encapsulates the data of a WebAuth UX request. + + Web engine's WebAuth UX requests are passed to the user in the + \l WebEngineView::webAuthUxRequested() signal. + + For more information about how to handle web engine authenticator requests, see the + \l{WebEngine Quick Nano Browser}{Nano Browser}. +*/ + +/*! + \class QWebEngineWebAuthUxRequest + \brief The QWebEngineWebAuthUxRequest class encapsulates the data of a WebAuth UX request. + \since 6.7 + + \inmodule QtWebEngineCore + + This class contains the information and API for WebAuth UX. WebAuth may require user + interaction during the authentication process. These requests are handled by displaying a + dialog to users. QtWebEngine currently supports user verification, resident credentials, + and display request failure UX requests. + + QWebEngineWebAuthUxRequest models a WebAuth UX request throughout its life cycle, + starting with showing a UX dialog, updating it's content through state changes, and + finally closing the dialog. + + WebAuth UX requests are normally triggered when the authenticator requires user interaction. + It is the QWebEnginePage's responsibility to notify the application of the new WebAuth UX + requests, which it does by emitting the + \l{QWebEnginePage::webAuthUxRequested}{webAuthUxRequested} signal together with a newly + created QWebEngineWebAuthUxRequest. The application can then examine this request and + display a WebAuth UX dialog. + + The QWebEngineWebAuthUxRequest object periodically emits the \l + {QWebEngineWebAuthUxRequest::}{stateChanged} signal to notify potential + observers of the current WebAuth UX states. The observers update the WebAuth dialog + accordingly. + + For more information about how to handle web engine authenticator requests, see the + \l{WebEngine Widgets Simple Browser Example}{Simple Browser}. +*/ + +/*! + \struct QWebEngineWebAuthPinRequest + \brief The QWebEngineWebAuthPinRequest class encapsulates the data of a PIN WebAuth UX request. + \since 6.7 + + \inmodule QtWebEngineCore + + This encapsulates the following information related to a PIN request made by an authenticator. + \list + \li The reason for the PIN prompt. + \li The error details for the PIN prompt. + \li The number of attempts remaining before a hard lock. Should be ignored unless + \l{QWebEngineWebAuthPinRequest::reason} is + \l{QWebEngineWebAuthUxRequest::PinEntryReason::Challenge}. + \li The minimum PIN length the authenticator will accept for the PIN. + \endlist + Use this structure to update the WebAuth UX dialog when the WebAuth UX state is \l + QWebEngineWebAuthUxRequest::WebAuthUxState::CollectPin. +*/ + +/*! + \property QWebEngineWebAuthPinRequest::reason + \brief The reason for the PIN prompt. +*/ + +/*! + \property QWebEngineWebAuthPinRequest::error + \brief The error details for the PIN prompt. +*/ + +/*! + \property QWebEngineWebAuthPinRequest::remainingAttempts + \brief The number of attempts remaining before a hard lock. Should be ignored unless + \l{QWebEngineWebAuthPinRequest::reason} is + \l{QWebEngineWebAuthUxRequest::PinEntryReason::Challenge}. +*/ + +/*! + \property QWebEngineWebAuthPinRequest::minPinLength + \brief The minimum PIN length the authenticator will accept for the PIN. +*/ + +/*! + \qmltype WebEngineWebAuthPinRequest + \instantiates QWebEngineWebAuthPinRequest + \inqmlmodule QtWebEngine + \since QtWebEngine 6.8 + \brief Encapsulates the data of a PIN WebAuth UX request. + + This encapsulates the following information related to a PIN request made by an authenticator. + \list + \li The reason for the PIN prompt. + \li The error details for the PIN prompt. + \li The number of attempts remaining before a hard lock. Should be ignored unless + \l{WebEngineWebAuthPinRequest::reason} is + \l{WebEngineWebAuthUxRequest.PinEntryReason.Challenge}. + \li The minimum PIN length that the authenticator will accept for the PIN. + \endlist + Use this structure to update the WebAuth UX dialog when the WebAuth UX state is \l + WebEngineWebAuthUxRequest.WebAuthUxState.CollectPin. +*/ + +/*! + \qmlproperty enumeration WebEngineWebAuthPinRequest::reason + \brief The reason for the PIN prompt. + + \value WebEngineWebAuthUxRequest.PinEntryReason.Set A new PIN is being set. + \value WebEngineWebAuthUxRequest.PinEntryReason.Change The existing PIN must be changed before using this authenticator. + \value WebEngineWebAuthUxRequest.PinEntryReason.Challenge The existing PIN is being collected to prove user verification. +*/ + +/*! + \qmlproperty enumeration WebEngineWebAuthPinRequest::error + \brief The error details for the PIN prompt. + + \value WebEngineWebAuthUxRequest.PinEntryError.NoError No error has occurred. + \value WebEngineWebAuthUxRequest.PinEntryError.InternalUvLocked Internal UV is locked, so we are falling back to PIN. + \value WebEngineWebAuthUxRequest.PinEntryError.WrongPin The PIN the user entered does not match the authenticator PIN. + \value WebEngineWebAuthUxRequest.PinEntryError.TooShort The new PIN the user entered is too short. + \value WebEngineWebAuthUxRequest.PinEntryError.InvalidCharacters The new PIN the user entered contains invalid characters. + \value WebEngineWebAuthUxRequest.PinEntryError.SameAsCurrentPin The new PIN the user entered is the same as the currently set PIN. +*/ + +/*! + \qmlproperty int WebEngineWebAuthPinRequest::remainingAttempts + \brief The number of attempts remaining before a hard lock. Should be ignored unless + \l{WebEngineWebAuthPinRequest::reason} is + \l{WebEngineWebAuthUxRequest.PinEntryReason.Challenge}. +*/ + +/*! + \qmlproperty int WebEngineWebAuthPinRequest::minPinLength + \brief The minimum PIN length that the authenticator will accept for the PIN. +*/ + +/*! + \enum QWebEngineWebAuthUxRequest::WebAuthUxState + + This enum describes the state of the current WebAuth UX request. + + \value NotStarted WebAuth UX request not started yet. + \value SelectAccount The authenticator requires resident credential details. + The application needs to display an account details dialog, and + the user needs to select an account to proceed. + \value CollectPin The authenticator requires user verification. + The application needs to display a PIN request dialog. + \value FinishTokenCollection The authenticator requires token/user verification (like tap on + the FIDO key) to complete the process. + \value RequestFailed WebAuth request failed. Display error details. + \value Cancelled WebAuth request is cancelled. Close the WebAuth dialog. + \value Completed WebAuth request is completed. Close the WebAuth dialog. +*/ + +/*! + \enum QWebEngineWebAuthUxRequest::PinEntryReason + + This enum describes the reasons that may prompt the authenticator to ask for a PIN. + + \value Set A new PIN is being set. + \value Change The existing PIN must be changed before using this authenticator. + \value Challenge The existing PIN is being collected to prove user verification. +*/ + +/*! + \enum QWebEngineWebAuthUxRequest::PinEntryError + + This enum describes the errors that may prompt the authenticator to ask for a PIN. + + \value NoError No error has occurred. + \value InternalUvLocked Internal UV is locked, so we are falling back to PIN. + \value WrongPin The PIN the user entered does not match the authenticator PIN. + \value TooShort The new PIN the user entered is too short. + \value InvalidCharacters The new PIN the user entered contains invalid characters. + \value SameAsCurrentPin The new PIN the user entered is the same as the currently set PIN. +*/ + +/*! + \enum QWebEngineWebAuthUxRequest::RequestFailureReason + + This enum describes the reason for WebAuth request failure. + + \value Timeout The authentication session has timed out. + \value KeyNotRegistered Key is not registered with the authenticator. + \value KeyAlreadyRegistered Key is already registered with the authenticator. + Try to register with another Key or use another authenticator. + \value SoftPinBlock The authenticator is blocked as the user entered the wrong key many times. + \value HardPinBlock The authenticator is blocked as the user entered the wrong key many times + and reset the PIN to use the specific authenticator again. + \value AuthenticatorRemovedDuringPinEntry Authenticator removed during PIN entry. + \value AuthenticatorMissingResidentKeys Authenticator doesn't have resident key support. + \value AuthenticatorMissingUserVerification Authenticator doesn't + have user verification support. + \value AuthenticatorMissingLargeBlob Authenticator doesn't have large blob support. + \value NoCommonAlgorithms No common algorithm. + \value StorageFull The resident credential could not be created because the + authenticator has insufficient storage. + \value UserConsentDenied User consent denied. + \value WinUserCancelled The user clicked \uicontrol Cancel in the native windows UI. +*/ + +/*! + \fn void QWebEngineWebAuthUxRequest::stateChanged(WebAuthUxState state) + + This signal is emitted whenever the WebAuth UX's \a state changes. + + \sa state, WebAuthUxState +*/ + +/*! + \qmlsignal void WebEngineWebAuthUxRequest::stateChanged(WebAuthUxState state) + This signal is emitted whenever the WebAuth UX's \a state changes. + + \sa state, QWebEngineWebAuthUxRequest::WebAuthUxState +*/ + +/*! \internal + */ +QWebEngineWebAuthUxRequestPrivate::QWebEngineWebAuthUxRequestPrivate( + QtWebEngineCore::AuthenticatorRequestDialogController *controller) + : webAuthDialogController(controller) +{ + m_currentState = controller->state(); +} + +/*! \internal + */ +QWebEngineWebAuthUxRequestPrivate::~QWebEngineWebAuthUxRequestPrivate() { } + +/*! \internal + */ +QWebEngineWebAuthUxRequest::QWebEngineWebAuthUxRequest(QWebEngineWebAuthUxRequestPrivate *p) + : d_ptr(p) +{ + connect(d_ptr->webAuthDialogController, + &QtWebEngineCore::AuthenticatorRequestDialogController::stateChanged, + [this](WebAuthUxState currentState) { + Q_D(QWebEngineWebAuthUxRequest); + d->m_currentState = currentState; + Q_EMIT stateChanged(d->m_currentState); + }); +} + +/*! \internal + */ +QWebEngineWebAuthUxRequest::~QWebEngineWebAuthUxRequest() { } + +/*! + \qmlproperty stringlist WebEngineWebAuthUxRequest::userNames + \brief The available user names for the resident credential support. + + This is needed when the current WebAuth request's UX state is + WebEngineWebAuthUxRequest.WebAuthUxState.SelectAccount. The + WebAuth dialog displays user names. The user needs to select an + account to proceed. + + \sa state setSelectedAccount() QWebEngineWebAuthUxRequest::userNames +*/ +/*! + \property QWebEngineWebAuthUxRequest::userNames + \brief The available user names for the resident credential support. + This is needed when the current WebAuth request's UX state is \l SelectAccount. + The WebAuth dialog displays user names. The user needs to select an account to proceed. + + \sa SelectAccount setSelectedAccount() +*/ +QStringList QWebEngineWebAuthUxRequest::userNames() const +{ + const Q_D(QWebEngineWebAuthUxRequest); + + return d->webAuthDialogController->userNames(); +} + +/*! + \qmlproperty string WebEngineWebAuthUxRequest::relyingPartyId + \brief The WebAuth request's relying party id. +*/ +/*! + \property QWebEngineWebAuthUxRequest::relyingPartyId + \brief The WebAuth request's relying party id. +*/ +QString QWebEngineWebAuthUxRequest::relyingPartyId() const +{ + const Q_D(QWebEngineWebAuthUxRequest); + + return d->webAuthDialogController->relyingPartyId(); +} + +/*! + \qmlproperty QWebEngineWebAuthPinRequest WebEngineWebAuthUxRequest::pinRequest + \brief The WebAuth request's PIN request information. + + \sa QWebEngineWebAuthPinRequest +*/ +/*! + \property QWebEngineWebAuthUxRequest::pinRequest + \brief The WebAuth request's PIN request information. + + This is needed when the current WebAuth request state is \l CollectPin. + WebAuth Dialog displays a PIN request dialog. The user needs to enter a PIN and + invoke \l setPin() to proceed. + + \sa QWebEngineWebAuthPinRequest CollectPin setPin() +*/ +QWebEngineWebAuthPinRequest QWebEngineWebAuthUxRequest::pinRequest() const +{ + const Q_D(QWebEngineWebAuthUxRequest); + + return d->webAuthDialogController->pinRequest(); +} + +/*! + \qmlproperty enumeration WebEngineWebAuthUxRequest::state + \brief The WebAuth request's current UX state. + + \value WebEngineWebAuthUxRequest.WebAuthUxState.NotStarted WebAuth UX request not started yet. + \value WebEngineWebAuthUxRequest.WebAuthUxState.SelectAccount The authenticator requires + resident credential details. The application needs to display an account details dialog, + and the user needs to select an account to proceed. + \value WebEngineWebAuthUxRequest.WebAuthUxState.CollectPin The authenticator requires user verification. + The application needs to display a PIN request dialog. + \value WebEngineWebAuthUxRequest.WebAuthUxState.FinishTokenCollection The authenticator requires + token/user verification (like tap on the FIDO key) to complete the process. + \value WebEngineWebAuthUxRequest.WebAuthUxState.RequestFailed WebAuth request failed. Display error details. + \value WebEngineWebAuthUxRequest.WebAuthUxState.Cancelled WebAuth request is cancelled. + Close the WebAuth dialog. + \value WebEngineWebAuthUxRequest.WebAuthUxState.Completed WebAuth request is completed. + Close the WebAuth dialog. +*/ +/*! + \property QWebEngineWebAuthUxRequest::state + \brief The WebAuth request's current UX state. + + \l stateChanged() is emitted when the current state changes. + Update the WebAuth dialog in reponse to the changes in state. +*/ +QWebEngineWebAuthUxRequest::WebAuthUxState QWebEngineWebAuthUxRequest::state() const +{ + return d_ptr->m_currentState; +} + +/*! + \qmlmethod void WebEngineWebAuthUxRequest::setSelectedAccount(const QString &selectedAccount) + + Sends the \a selectedAccount name to the authenticator. + This is needed when the current WebAuth request's UX state is + WebEngineWebAuthUxRequest.WebAuthUxState.SelectAccount. The + WebAuth request is blocked until the user selects an account and + invokes this method. + + \sa WebEngineWebAuthUxRequest::userNames state +*/ +/*! + Sends the \a selectedAccount name to the authenticator. + This is needed when the current WebAuth request's UX state is \l SelectAccount. + The WebAuth request is blocked until the user selects an account and invokes this method. + + \sa userNames SelectAccount +*/ +void QWebEngineWebAuthUxRequest::setSelectedAccount(const QString &selectedAccount) +{ + Q_D(QWebEngineWebAuthUxRequest); + + d->webAuthDialogController->sendSelectAccountResponse(selectedAccount); +} + +/*! + \qmlmethod void WebEngineWebAuthUxRequest::setPin(const QString &pin) + Sends the \a pin to the authenticator that prompts for a PIN. + This is needed when the current WebAuth request's UX state is + WebEngineWebAuthUxRequest.WebAuthUxState.CollectPin. The WebAuth + request is blocked until the user responds with a PIN. + + \sa QWebEngineWebAuthPinRequest state +*/ +/*! + Sends the \a pin to the authenticator that prompts for a PIN. + This is needed when the current WebAuth request's UX state is \l CollectPin. + The WebAuth request is blocked until the user responds with a PIN. + + \sa QWebEngineWebAuthPinRequest CollectPin +*/ +void QWebEngineWebAuthUxRequest::setPin(const QString &pin) +{ + Q_D(QWebEngineWebAuthUxRequest); + d->webAuthDialogController->sendCollectPinResponse(pin); +} + +/*! + \qmlmethod void WebEngineWebAuthUxRequest::cancel() + Cancels the current WebAuth request. + + \sa QWebEngineWebAuthUxRequest::Cancelled, WebEngineWebAuthUxRequest::stateChanged() +*/ +/*! + Cancels the current WebAuth request. + + \sa QWebEngineWebAuthUxRequest::Cancelled, stateChanged() +*/ +void QWebEngineWebAuthUxRequest::cancel() +{ + Q_D(QWebEngineWebAuthUxRequest); + + d->webAuthDialogController->reject(); +} + +/*! + \qmlmethod void WebEngineWebAuthUxRequest::retry() + Retries the current WebAuth request. + + \sa stateChanged() +*/ +/*! + Retries the current WebAuth request. + + \sa stateChanged() +*/ +void QWebEngineWebAuthUxRequest::retry() +{ + const Q_D(QWebEngineWebAuthUxRequest); + + d->webAuthDialogController->retryRequest(); +} + +/*! + \qmlproperty enumeration WebEngineWebAuthUxRequest::requestFailureReason + \brief The WebAuth request's failure reason. + + \value WebEngineWebAuthUxRequest.RequestFailureReason.Timeout The authentication session has timed out. + \value WebEngineWebAuthUxRequest.RequestFailureReason.KeyNotRegistered Key is not registered with the authenticator. + \value WebEngineWebAuthUxRequest.RequestFailureReason.KeyAlreadyRegistered Key is already registered with + the authenticator. Try to register with another key or use another authenticator. + \value WebEngineWebAuthUxRequest.RequestFailureReason.SoftPinBlock The authenticator is blocked as the user + entered the wrong key many times. + \value WebEngineWebAuthUxRequest.RequestFailureReason.HardPinBlock The authenticator is blocked as the user entered + the wrong key many times and reset the PIN to use the specific authenticator again. + \value WebEngineWebAuthUxRequest.RequestFailureReason.AuthenticatorRemovedDuringPinEntry Authenticator + removed during PIN entry. + \value WebEngineWebAuthUxRequest.RequestFailureReason.AuthenticatorMissingResidentKeys Authenticator doesn't + have resident key support. + \value WebEngineWebAuthUxRequest.RequestFailureReason.AuthenticatorMissingUserVerification Authenticator doesn't + have user verification support. + \value WebEngineWebAuthUxRequest.RequestFailureReason.AuthenticatorMissingLargeBlob Authenticator doesn't have + large blob support. + \value WebEngineWebAuthUxRequest.RequestFailureReason.NoCommonAlgorithms No common algorithm. + \value WebEngineWebAuthUxRequest.RequestFailureReason.StorageFull The resident credential could not be created + because the authenticator has insufficient storage. + \value WebEngineWebAuthUxRequest.RequestFailureReason.UserConsentDenied User consent denied. + \value WebEngineWebAuthUxRequest.RequestFailureReason.WinUserCancelled The user clicked \uicontrol Cancel + in the native windows UI. + + \sa stateChanged() +*/ +/*! + \property QWebEngineWebAuthUxRequest::requestFailureReason + \brief The WebAuth request's failure reason. + + \sa stateChanged() QWebEngineWebAuthUxRequest::RequestFailureReason +*/ +QWebEngineWebAuthUxRequest::RequestFailureReason +QWebEngineWebAuthUxRequest::requestFailureReason() const +{ + const Q_D(QWebEngineWebAuthUxRequest); + + return d->webAuthDialogController->requestFailureReason(); +} + +#include "moc_qwebenginewebauthuxrequest.cpp" diff --git a/src/core/api/qwebenginewebauthuxrequest.h b/src/core/api/qwebenginewebauthuxrequest.h new file mode 100644 index 000000000..111f52847 --- /dev/null +++ b/src/core/api/qwebenginewebauthuxrequest.h @@ -0,0 +1,117 @@ +// Copyright (C) 2023 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 + +#ifndef QWEBENGINEWEBAUTHUXREQUEST_H +#define QWEBENGINEWEBAUTHUXREQUEST_H + +#include <QtWebEngineCore/qtwebenginecoreglobal.h> +#include <QtCore/qobject.h> + +namespace QtWebEngineCore { +class AuthenticatorRequestDialogControllerPrivate; +} + +QT_BEGIN_NAMESPACE + +class QWebEngineWebAuthUxRequestPrivate; +struct QWebEngineWebAuthPinRequest; + +class Q_WEBENGINECORE_EXPORT QWebEngineWebAuthUxRequest : public QObject +{ + Q_OBJECT + + Q_PROPERTY(QStringList userNames READ userNames CONSTANT FINAL) + Q_PROPERTY(WebAuthUxState state READ state NOTIFY stateChanged FINAL) + Q_PROPERTY(QString relyingPartyId READ relyingPartyId CONSTANT FINAL) + Q_PROPERTY(QWebEngineWebAuthPinRequest pinRequest READ pinRequest CONSTANT FINAL) + Q_PROPERTY(RequestFailureReason requestFailureReason READ requestFailureReason CONSTANT FINAL) + Q_CLASSINFO("RegisterEnumClassesUnscoped", "false") +public: + enum class WebAuthUxState { + NotStarted, + SelectAccount, + CollectPin, + FinishTokenCollection, + RequestFailed, + Cancelled, + Completed, + }; + Q_ENUM(WebAuthUxState) + + enum class PinEntryReason { + Set, + Change, + Challenge, + }; + Q_ENUM(PinEntryReason) + + enum class PinEntryError { + NoError, + InternalUvLocked, + WrongPin, + TooShort, + InvalidCharacters, + SameAsCurrentPin, + }; + Q_ENUM(PinEntryError) + + enum class RequestFailureReason { + Timeout, + KeyNotRegistered, + KeyAlreadyRegistered, + SoftPinBlock, + HardPinBlock, + AuthenticatorRemovedDuringPinEntry, + AuthenticatorMissingResidentKeys, + AuthenticatorMissingUserVerification, + AuthenticatorMissingLargeBlob, + NoCommonAlgorithms, + StorageFull, + UserConsentDenied, + WinUserCancelled, + }; + Q_ENUM(RequestFailureReason) + + ~QWebEngineWebAuthUxRequest() override; + + QStringList userNames() const; + QString relyingPartyId() const; + QWebEngineWebAuthPinRequest pinRequest() const; + WebAuthUxState state() const; + RequestFailureReason requestFailureReason() const; + +Q_SIGNALS: + void stateChanged(QWebEngineWebAuthUxRequest::WebAuthUxState state); + +public Q_SLOTS: + void cancel(); + void retry(); + void setSelectedAccount(const QString &selectedAccount); + void setPin(const QString &pin); + +protected: + explicit QWebEngineWebAuthUxRequest(QWebEngineWebAuthUxRequestPrivate *); + + std::unique_ptr<QWebEngineWebAuthUxRequestPrivate> d_ptr; + friend class QtWebEngineCore::AuthenticatorRequestDialogControllerPrivate; + Q_DECLARE_PRIVATE(QWebEngineWebAuthUxRequest) +}; + +struct QWebEngineWebAuthPinRequest +{ + Q_GADGET_EXPORT(Q_WEBENGINECORE_EXPORT) + + Q_PROPERTY(QWebEngineWebAuthUxRequest::PinEntryReason reason MEMBER reason CONSTANT FINAL) + Q_PROPERTY(QWebEngineWebAuthUxRequest::PinEntryError error MEMBER error CONSTANT FINAL) + Q_PROPERTY(qint32 minPinLength MEMBER minPinLength CONSTANT FINAL) + Q_PROPERTY(int remainingAttempts MEMBER remainingAttempts CONSTANT FINAL) +public: + QWebEngineWebAuthUxRequest::PinEntryReason reason; + QWebEngineWebAuthUxRequest::PinEntryError error; + qint32 minPinLength; + int remainingAttempts; +}; + +QT_END_NAMESPACE + +#endif // QWEBENGINEWEBAUTHUXREQUEST_H diff --git a/src/core/api/qwebenginewebauthuxrequest_p.h b/src/core/api/qwebenginewebauthuxrequest_p.h new file mode 100644 index 000000000..4c685bac7 --- /dev/null +++ b/src/core/api/qwebenginewebauthuxrequest_p.h @@ -0,0 +1,43 @@ +// Copyright (C) 2023 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 + +#ifndef QWEBENGINEWEBAUTHUXREQUEST_P_H +#define QWEBENGINEWEBAUTHUXREQUEST_P_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#include "qtwebenginecoreglobal_p.h" +#include "qwebenginewebauthuxrequest.h" +#include <QtCore/QSharedPointer> + +namespace QtWebEngineCore { +class WebContentsAdapterClient; +class AuthenticatorRequestDialogController; +} + +QT_BEGIN_NAMESPACE + +class Q_WEBENGINECORE_EXPORT QWebEngineWebAuthUxRequestPrivate +{ + +public: + QWebEngineWebAuthUxRequestPrivate( + QtWebEngineCore::AuthenticatorRequestDialogController *controller); + ~QWebEngineWebAuthUxRequestPrivate(); + + QWebEngineWebAuthUxRequest::WebAuthUxState m_currentState = + QWebEngineWebAuthUxRequest::WebAuthUxState::NotStarted; + QtWebEngineCore::AuthenticatorRequestDialogController *webAuthDialogController; +}; + +QT_END_NAMESPACE +#endif // QWEBENGINEWEBAUTHUXREQUEST_P_H |