Skip to content

Commit

Permalink
[Cocoa] Upstream support for system context retrieval through UIIntel…
Browse files Browse the repository at this point in the history
…ligenceSupport

https://bugs.webkit.org/show_bug.cgi?id=275510

Reviewed by NOBODY (OOPS!).

Upstream support for system context retrieval through the UIIntelligenceSupport framework on iOS 18
and macOS Sequoia. See below for more comments.

* Source/WTF/Scripts/Preferences/UnifiedWebPreferences.yaml:
* Source/WTF/wtf/PlatformHave.h:

Add a new compile-time flag: `HAVE(UIINTELLIGENCESUPPORT_FRAMEWORK)`. Use this flag to enable the
runtime flag `TextExtractionEnabled` by default on supported platforms.

* Source/WebKit/Configurations/WebKitSwift.xcconfig:

Remove `WKWebView+TextExtraction.swift` as an excluded source, now that the file is no longer in
WebKitAdditions.

* Source/WebKit/DerivedSources.make:
* Source/WebKit/UIProcess/WebPageProxy.cpp:
(WebKit::WebPageProxy::didCommitLoadForFrame):

Remove an unnecessary compile-time flag, `ENABLE(TEXT_EXTRACTION)`. This was only used to avoid
eagerly loading `libWebKitSwift` on platforms where support for UIIntelligenceSupport is missing;
it's a bit cleaner to just turn the runtime feature off by default when the above compile-time flag,
`HAVE(UIINTELLIGENCESUPPORT_FRAMEWORK)`, is off.

* Source/WebKit/WebKit.xcodeproj/project.pbxproj:
* Source/WebKit/WebKitSwift/TextExtraction/WKWebView+TextExtraction.swift: Added.

Move this source file to `WebKitSwift/`, from WebKitAdditions.

(createEditable(for:)):
(createElementContent(for:)):
(createIntelligenceElement(_:)):
(WKWebView._intelligenceBaseClass):
(WKWebView._intelligenceCollectContent(in:collector:)):
(WKWebView._intelligenceCollectRemoteContent(in:remoteContextWrapper:)):
(WKWebView._requestTextExtraction(in:completionHandler:)):

Upstream support code for converting `WKTextExtractionItem` → `IntelligenceElement`.
  • Loading branch information
whsieh committed Jun 14, 2024
1 parent adef555 commit 99e6bd8
Show file tree
Hide file tree
Showing 7 changed files with 113 additions and 13 deletions.
5 changes: 3 additions & 2 deletions Source/WTF/Scripts/Preferences/UnifiedWebPreferences.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6593,8 +6593,9 @@ TextExtractionEnabled:
exposed: [ WebKit ]
defaultValue:
WebKit:
default: true

"HAVE(UIINTELLIGENCESUPPORT_FRAMEWORK)": true
default: false

TextIndicatorStylingEnabled:
type: bool
status: internal
Expand Down
9 changes: 9 additions & 0 deletions Source/WTF/wtf/PlatformHave.h
Original file line number Diff line number Diff line change
Expand Up @@ -1790,3 +1790,12 @@
#if PLATFORM(IOS) && !PLATFORM(IOS_SIMULATOR)
#define HAVE_MOBILE_KEY_BAG 1
#endif

#if !defined(HAVE_UIINTELLIGENCESUPPORT_FRAMEWORK) \
&& (((PLATFORM(IOS) || PLATFORM(MACCATALYST)) && __IPHONE_OS_VERSION_MIN_REQUIRED >= 180000) \
|| (PLATFORM(APPLETV) && __TV_OS_VERSION_MIN_REQUIRED >= 180000) \
|| (PLATFORM(WATCHOS) && __WATCH_OS_VERSION_MIN_REQUIRED >= 120000) \
|| (PLATFORM(VISION) && __XR_OS_VERSION_MIN_REQUIRED >= 20000) \
|| (PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 150000))
#define HAVE_UIINTELLIGENCESUPPORT_FRAMEWORK 1
#endif
5 changes: 1 addition & 4 deletions Source/WebKit/Configurations/WebKitSwift.xcconfig
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,7 @@ WK_HAVE_MARKETPLACE_KIT_xros = YES;
WK_EXCLUDED_MARKETPLACE_KIT_WRAPPER_FILES = $(WK_EXCLUDED_MARKETPLACE_KIT_WRAPPER_FILES_$(WK_AND_$(USE_INTERNAL_SDK)_$(WK_HAVE_MARKETPLACE_KIT)));
WK_EXCLUDED_MARKETPLACE_KIT_WRAPPER_FILES_NO = MarketplaceKitWrapper.swift;

WK_EXCLUDED_TEXT_EXTRACTION_FILES = $(WK_EXCLUDED_TEXT_EXTRACTION_FILES_$(USE_INTERNAL_SDK))
WK_EXCLUDED_TEXT_EXTRACTION_FILES_ = WKWebView+TextExtraction.swift

EXCLUDED_SOURCE_FILE_NAMES = $(WK_EXCLUDED_COORDINATOR_FILES) $(WK_EXCLUDED_MARKETPLACE_KIT_WRAPPER_FILES) $(WK_EXCLUDED_TEXT_EXTRACTION_FILES) $(EXCLUDED_IOS_RESOURCE_FILE_NAMES) $(EXCLUDED_MACOS_PLUGIN_FILE_NAMES) $(WK_EXCLUDED_TEXT_STYLE_MANAGER_FILES)
EXCLUDED_SOURCE_FILE_NAMES = $(WK_EXCLUDED_COORDINATOR_FILES) $(WK_EXCLUDED_MARKETPLACE_KIT_WRAPPER_FILES) $(EXCLUDED_IOS_RESOURCE_FILE_NAMES) $(EXCLUDED_MACOS_PLUGIN_FILE_NAMES) $(WK_EXCLUDED_TEXT_STYLE_MANAGER_FILES)

SWIFT_INSTALL_OBJC_HEADER = NO
SWIFT_VERSION = 5.0;
Expand Down
1 change: 0 additions & 1 deletion Source/WebKit/DerivedSources.make
Original file line number Diff line number Diff line change
Expand Up @@ -897,7 +897,6 @@ all : module.private.modulemap

ifeq ($(USE_INTERNAL_SDK),YES)
WEBKIT_ADDITIONS_SWIFT_FILES = \
WKWebView+TextExtraction.swift \
#

$(WEBKIT_ADDITIONS_SWIFT_FILES): %.swift : %.swift.in
Expand Down
7 changes: 2 additions & 5 deletions Source/WebKit/UIProcess/WebPageProxy.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,7 @@
#include "UserMediaCaptureManagerProxy.h"
#include "VideoPresentationManagerProxy.h"
#include "VideoPresentationManagerProxyMessages.h"
#include "WKTextExtractionUtilities.h"
#include "WebPrivacyHelpers.h"
#include <WebCore/AttributedString.h>
#include <WebCore/CoreAudioCaptureDeviceManager.h>
Expand Down Expand Up @@ -389,10 +390,6 @@
#include "WebExtensionController.h"
#endif

#if ENABLE(TEXT_EXTRACTION)
#import "WKTextExtractionUtilities.h"
#endif

#if ENABLE(QUICKLOOK_SANDBOX_RESTRICTIONS)
#include <wtf/spi/darwin/SandboxSPI.h>
#endif
Expand Down Expand Up @@ -6493,7 +6490,7 @@ void WebPageProxy::didCommitLoadForFrame(IPC::Connection& connection, FrameIdent
resetMediaCapability();
#endif

#if ENABLE(TEXT_EXTRACTION)
#if PLATFORM(COCOA)
if (frame->isMainFrame() && preferences().textExtractionEnabled())
prepareTextExtractionSupportIfNeeded();
#endif
Expand Down
2 changes: 1 addition & 1 deletion Source/WebKit/WebKit.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -8128,7 +8128,7 @@
F4648E91296E81F500744170 /* WebPrivacyHelpers.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = WebPrivacyHelpers.mm; sourceTree = "<group>"; };
F4660BC125DEF08100E86598 /* PasteboardAccessIntent.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = PasteboardAccessIntent.h; sourceTree = "<group>"; };
F476894628D2B5CD00073641 /* LayerTreeContext.serialization.in */ = {isa = PBXFileReference; lastKnownFileType = text; path = LayerTreeContext.serialization.in; sourceTree = "<group>"; };
F47AA6C92B7A80BB00CD8AE9 /* WKWebView+TextExtraction.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = "WKWebView+TextExtraction.swift"; path = "$(BUILT_PRODUCTS_DIR)/DerivedSources/WebKit/WKWebView+TextExtraction.swift"; sourceTree = "<group>"; };
F47AA6C92B7A80BB00CD8AE9 /* WKWebView+TextExtraction.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = "WKWebView+TextExtraction.swift"; path = "TextExtraction/WKWebView+TextExtraction.swift"; sourceTree = "<group>"; };
F48570A22644BEC400C05F71 /* Timeout.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Timeout.h; sourceTree = "<group>"; };
F488B90F2ACFC67A00792C16 /* RemoteWorkerInitializationData.serialization.in */ = {isa = PBXFileReference; lastKnownFileType = text; path = RemoteWorkerInitializationData.serialization.in; sourceTree = "<group>"; };
F488B9142AD09C9C00792C16 /* DocumentEditingContext.serialization.in */ = {isa = PBXFileReference; lastKnownFileType = text; path = DocumentEditingContext.serialization.in; sourceTree = "<group>"; };
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
// Copyright (C) 2024 Apple Inc. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
// BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.

#if canImport(UIIntelligenceSupport)

@_spiOnly import WebKit
@_spiOnly import UIIntelligenceSupport

#if canImport(UIKit)
@_spi(UIIntelligenceSupport) import UIKit
#else
@_spi(UIIntelligenceSupport) import AppKit
#endif

private func createEditable(for editable: WKTextExtractionEditable?) -> IntelligenceElement.Text.Editable? {
guard let editable else { return .none }
return .init(label: editable.label, prompt: editable.placeholder, contentType: nil, isSecure: editable.isSecure, isFocused: editable.isFocused)
}

private func createElementContent(for item: WKTextExtractionItem) -> IntelligenceElement.Content {
switch item {
case let text as WKTextExtractionTextItem:
var content = AttributedString(text.content)
if text.selectedRange.location != NSNotFound {
if let range = Range(text.selectedRange, in: content) {
content[range].intelligenceSelected = true
}
}
for link in text.links {
if let range = Range(link.range, in: content) {
content[range].intelligenceLink = link.url as URL
}
}
return .text(IntelligenceElement.Text(attributedText: content, editable: createEditable(for: text.editable)))
case let image as WKTextExtractionImageItem:
return .image(IntelligenceElement.Image(name: image.name, textDescription: image.altText))
default:
return .base
}
}

private func createIntelligenceElement(item: WKTextExtractionItem) -> IntelligenceElement {
var element = IntelligenceElement(boundingBox: item.rectInWebView, content: createElementContent(for: item))
element.subelements = item.children.map { child in createIntelligenceElement(item: child) }
return element
}

@_spi(WKIntelligenceSupport)
extension WKWebView {
open override var _intelligenceBaseClass: AnyClass {
WKWebView.self
}

open override func _intelligenceCollectContent(in visibleRect: CGRect, collector: UIIntelligenceElementCollector) {
collector.collect(.remote(collector.context.createRemoteContext()))
}

open override func _intelligenceCollectRemoteContent(in visibleRect: CGRect, remoteContextWrapper: UIIntelligenceCollectionRemoteContextWrapper) {
let coordinator = IntelligenceCollectionCoordinator.shared
coordinator.createCollector(remoteContextWrapper: remoteContextWrapper) { collector, error in
guard let collector else { return }
self._requestTextExtraction(in: visibleRect) { item in
if let item {
collector.collect(createIntelligenceElement(item: item))
}
coordinator.finishCollection(collector)
}
}
}

@objc private func _requestTextExtraction(in rect: CGRect, completionHandler: @escaping (WKTextExtractionItem?) -> Void) {
let context = WKTextExtractionRequest(rectInWebView: rect, completionHandler)
self.perform(Selector(("_requestTextExtractionForSwift:")), with: context)
}
}

#endif // canImport(UIIntelligenceSupport)

0 comments on commit 99e6bd8

Please sign in to comment.