Changeset 271031 in webkit

Timestamp:

Dec 21, 2020 11:35:24 AM (19 months ago)

Author:

sihui_liu@apple.com

Message:

Check availability of speech recognition service before requesting permissions
​https://bugs.webkit.org/show_bug.cgi?id=220033

Reviewed by Youenn Fablet.

If speech recognition service is not available for target language (maybe the language is not supported, user
turns off dictation in system settings, etc), let's just fail the speech recognition request without prompting.

Manually tested with MiniBrowser.

• UIProcess/Cocoa/MediaPermissionUtilities.mm:

(WebKit::requestSpeechRecognitionAccess):
(WebKit::checkSpeechRecognitionServiceAccess):
(WebKit::checkSpeechRecognitionServiceAvailability):

• UIProcess/MediaPermissionUtilities.h:
• UIProcess/SpeechRecognitionPermissionManager.cpp:

(WebKit::SpeechRecognitionPermissionManager::request):
(WebKit::SpeechRecognitionPermissionManager::startProcessingRequest):

• UIProcess/SpeechRecognitionPermissionManager.h:
• UIProcess/SpeechRecognitionPermissionRequest.h:

(WebKit::SpeechRecognitionPermissionRequest::create):
(WebKit::SpeechRecognitionPermissionRequest::lang const):
(WebKit::SpeechRecognitionPermissionRequest::SpeechRecognitionPermissionRequest):

• UIProcess/SpeechRecognitionServer.cpp:

(WebKit::SpeechRecognitionServer::requestPermissionForRequest):

• UIProcess/SpeechRecognitionServer.h:
• UIProcess/WebPageProxy.cpp:

(WebKit::WebPageProxy::requestSpeechRecognitionPermission):

• UIProcess/WebPageProxy.h:
• UIProcess/WebProcessProxy.cpp:

(WebKit::WebProcessProxy::createSpeechRecognitionServer):

Location:

trunk/Source/WebKit

Files:

• ChangeLog (modified) (1 diff)
• UIProcess/Cocoa/MediaPermissionUtilities.mm (modified) (3 diffs)
• UIProcess/MediaPermissionUtilities.h (modified) (1 diff)
• UIProcess/SpeechRecognitionPermissionManager.cpp (modified) (3 diffs)
• UIProcess/SpeechRecognitionPermissionManager.h (modified) (1 diff)
• UIProcess/SpeechRecognitionPermissionRequest.h (modified) (2 diffs)
• UIProcess/SpeechRecognitionServer.cpp (modified) (2 diffs)
• UIProcess/SpeechRecognitionServer.h (modified) (1 diff)
• UIProcess/WebPageProxy.cpp (modified) (1 diff)
• UIProcess/WebPageProxy.h (modified) (1 diff)
• UIProcess/WebProcessProxy.cpp (modified) (2 diffs)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2020-12-21  Sihui Liu  <sihui_liu@apple.com>
+
+        Check availability of speech recognition service before requesting permissions
+        https://bugs.webkit.org/show_bug.cgi?id=220033
+
+        Reviewed by Youenn Fablet.
+
+        If speech recognition service is not available for target language (maybe the language is not supported, user 
+        turns off dictation in system settings, etc), let's just fail the speech recognition request without prompting.
+
+        Manually tested with MiniBrowser.
+
+        * UIProcess/Cocoa/MediaPermissionUtilities.mm:
+        (WebKit::requestSpeechRecognitionAccess):
+        (WebKit::checkSpeechRecognitionServiceAccess):
+        (WebKit::checkSpeechRecognitionServiceAvailability):
+        * UIProcess/MediaPermissionUtilities.h:
+        * UIProcess/SpeechRecognitionPermissionManager.cpp:
+        (WebKit::SpeechRecognitionPermissionManager::request):
+        (WebKit::SpeechRecognitionPermissionManager::startProcessingRequest):
+        * UIProcess/SpeechRecognitionPermissionManager.h:
+        * UIProcess/SpeechRecognitionPermissionRequest.h:
+        (WebKit::SpeechRecognitionPermissionRequest::create):
+        (WebKit::SpeechRecognitionPermissionRequest::lang const):
+        (WebKit::SpeechRecognitionPermissionRequest::SpeechRecognitionPermissionRequest):
+        * UIProcess/SpeechRecognitionServer.cpp:
+        (WebKit::SpeechRecognitionServer::requestPermissionForRequest):
+        * UIProcess/SpeechRecognitionServer.h:
+        * UIProcess/WebPageProxy.cpp:
+        (WebKit::WebPageProxy::requestSpeechRecognitionPermission):
+        * UIProcess/WebPageProxy.h:
+        * UIProcess/WebProcessProxy.cpp:
+        (WebKit::WebProcessProxy::createSpeechRecognitionServer):
+
 2020-12-21  Alicia Boya García  <aboya@igalia.com>
 

trunk/Source/WebKit/UIProcess/Cocoa/MediaPermissionUtilities.mm

@@ -39 +39 @@
 #import <wtf/spi/darwin/SandboxSPI.h>
 
-#if HAVE(SPEECHRECOGNIZER)
-#import <Speech/Speech.h>
-
-SOFT_LINK_FRAMEWORK(Speech)
-SOFT_LINK_CLASS(Speech, SFSpeechRecognizer)
-#endif
-
 #import <pal/cocoa/AVFoundationSoftLink.h>
+#import <pal/cocoa/SpeechSoftLink.h>
 
 SOFT_LINK_PRIVATE_FRAMEWORK(TCC)
@@ -255 +249 @@
         completionHandler(authorized);
     });
-    [getSFSpeechRecognizerClass() requestAuthorization:decisionHandler.get()];
+    [PAL::getSFSpeechRecognizerClass() requestAuthorization:decisionHandler.get()];
 }
 
 MediaPermissionResult checkSpeechRecognitionServiceAccess()
 {
-    auto authorizationStatus = [getSFSpeechRecognizerClass() authorizationStatus];
+    auto authorizationStatus = [PAL::getSFSpeechRecognizerClass() authorizationStatus];
     if (authorizationStatus == SFSpeechRecognizerAuthorizationStatusDenied || authorizationStatus == SFSpeechRecognizerAuthorizationStatusRestricted)
         return MediaPermissionResult::Denied;
@@ -268 +262 @@
 }
 
+bool checkSpeechRecognitionServiceAvailability(const String& localeIdentifier)
+{
+    auto recognizer = localeIdentifier.isEmpty() ? adoptNS([PAL::allocSFSpeechRecognizerInstance() init]) : adoptNS([PAL::allocSFSpeechRecognizerInstance() initWithLocale:[NSLocale localeWithLocaleIdentifier:localeIdentifier]]);
+    return recognizer && [recognizer isAvailable];
+}
+
 #endif // HAVE(SPEECHRECOGNIZER)
 

trunk/Source/WebKit/UIProcess/MediaPermissionUtilities.h

@@ -69 +69 @@
 void requestSpeechRecognitionAccess(CompletionHandler<void(bool authorized)>&&);
 MediaPermissionResult checkSpeechRecognitionServiceAccess();
+bool checkSpeechRecognitionServiceAvailability(const String& localeIdentifier);
 #endif
 

trunk/Source/WebKit/UIProcess/SpeechRecognitionPermissionManager.cpp

@@ -76 +76 @@
 }
     
-void SpeechRecognitionPermissionManager::request(const WebCore::ClientOrigin& origin, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&& completiontHandler)
-{
-    m_requests.append(SpeechRecognitionPermissionRequest::create(origin, WTFMove(completiontHandler)));
+void SpeechRecognitionPermissionManager::request(const String& lang, const WebCore::ClientOrigin& origin, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&& completiontHandler)
+{
+    m_requests.append(SpeechRecognitionPermissionRequest::create(lang, origin, WTFMove(completiontHandler)));
     if (m_requests.size() == 1)
         startNextRequest();
@@ -105 +105 @@
 
     m_page.syncIfMockDevicesEnabledChanged();
-    if (m_page.preferences().mockCaptureDevicesEnabled()) {
+    bool mockCaptureDevicesEnabled = m_page.preferences().mockCaptureDevicesEnabled();
+    if (mockCaptureDevicesEnabled) {
         m_microphoneCheck = CheckResult::Granted;
         m_speechRecognitionServiceCheck = CheckResult::Granted;
+    }
+
+#if HAVE(SPEECHRECOGNIZER)
+    if (!mockCaptureDevicesEnabled && m_speechRecognitionServiceCheck != CheckResult::Denied) {
+        // Speech recognition service can be unavailable when user does not enable dictation in system settings.
+        // Let's avoid prompting user in that case.
+        if (!checkSpeechRecognitionServiceAvailability(m_requests.first()->lang()))
+            m_speechRecognitionServiceCheck = CheckResult::Denied;
+    }
+#endif
+
+    if (m_microphoneCheck == CheckResult::Denied || m_speechRecognitionServiceCheck == CheckResult::Denied) {
+        completeCurrentRequest(SpeechRecognitionPermissionDecision::Deny);
+        return;
     }
 
@@ -119 +134 @@
     }
 
-    if (m_microphoneCheck == CheckResult::Denied || m_speechRecognitionServiceCheck == CheckResult::Denied || m_userPermissionCheck == CheckResult::Denied) {
+    if (m_userPermissionCheck == CheckResult::Denied) {
         completeCurrentRequest(SpeechRecognitionPermissionDecision::Deny);
         return;

trunk/Source/WebKit/UIProcess/SpeechRecognitionPermissionManager.h

@@ -40 +40 @@
     explicit SpeechRecognitionPermissionManager(WebPageProxy&);
     ~SpeechRecognitionPermissionManager();
-    void request(const WebCore::ClientOrigin&, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&&);
+    void request(const String& lang, const WebCore::ClientOrigin&, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&&);
 
     void decideByDefaultAction(const WebCore::SecurityOrigin&, CompletionHandler<void(bool)>&&);

trunk/Source/WebKit/UIProcess/SpeechRecognitionPermissionRequest.h

@@ -36 +36 @@
 class SpeechRecognitionPermissionRequest : public RefCounted<SpeechRecognitionPermissionRequest> {
 public:
-    static Ref<SpeechRecognitionPermissionRequest> create(const WebCore::ClientOrigin& origin, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&& completionHandler)
+    static Ref<SpeechRecognitionPermissionRequest> create(const String& lang, const WebCore::ClientOrigin& origin, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&& completionHandler)
     {
-        return adoptRef(*new SpeechRecognitionPermissionRequest(origin, WTFMove(completionHandler)));
+        return adoptRef(*new SpeechRecognitionPermissionRequest(lang, origin, WTFMove(completionHandler)));
     }
 
@@ -48 +48 @@
 
     const WebCore::ClientOrigin& origin() const { return m_origin; }
+    const String& lang() const { return m_lang; }
 
 private:
-    SpeechRecognitionPermissionRequest(const WebCore::ClientOrigin& origin, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&& completionHandler)
-        : m_origin(origin)
+    SpeechRecognitionPermissionRequest(const String& lang, const WebCore::ClientOrigin& origin, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&& completionHandler)
+        : m_lang(lang)
+        , m_origin(origin)
         , m_completionHandler(WTFMove(completionHandler))
     { }
 
+    String m_lang;
     WebCore::ClientOrigin m_origin;
     CompletionHandler<void(SpeechRecognitionPermissionDecision)> m_completionHandler;

trunk/Source/WebKit/UIProcess/SpeechRecognitionServer.cpp

@@ -37 +37 @@
 namespace WebKit {
 
-
 SpeechRecognitionServer::SpeechRecognitionServer(Ref<IPC::Connection>&& connection, SpeechRecognitionServerIdentifier identifier, SpeechRecognitionPermissionChecker&& permissionChecker, SpeechRecognitionCheckIfMockSpeechRecognitionEnabled&& checkIfEnabled
 #if ENABLE(MEDIA_STREAM)
@@ -65 +64 @@
 void SpeechRecognitionServer::requestPermissionForRequest(WebCore::SpeechRecognitionRequest& request)
 {
-    m_permissionChecker(request.clientOrigin(), [this, weakThis = makeWeakPtr(this), weakRequest = makeWeakPtr(request)](SpeechRecognitionPermissionDecision decision) mutable {
+    m_permissionChecker(request.lang(), request.clientOrigin(), [this, weakThis = makeWeakPtr(this), weakRequest = makeWeakPtr(request)](auto decision) mutable {
         if (!weakThis)
             return;

trunk/Source/WebKit/UIProcess/SpeechRecognitionServer.h

@@ -47 +47 @@
 
 using SpeechRecognitionServerIdentifier = WebCore::PageIdentifier;
-using SpeechRecognitionPermissionChecker = Function<void(const WebCore::ClientOrigin&, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&&)>;
+using SpeechRecognitionPermissionChecker = Function<void(const String&, const WebCore::ClientOrigin&, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&&)>;
 using SpeechRecognitionCheckIfMockSpeechRecognitionEnabled = Function<bool()>;
 

trunk/Source/WebKit/UIProcess/WebPageProxy.cpp

@@ -10344 +10344 @@
 }
 
-void WebPageProxy::requestSpeechRecognitionPermission(const WebCore::ClientOrigin& clientOrigin, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&& completionHandler)
+void WebPageProxy::requestSpeechRecognitionPermission(const String& lang, const WebCore::ClientOrigin& clientOrigin, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&& completionHandler)
 {
     if (!m_speechRecognitionPermissionManager)
         m_speechRecognitionPermissionManager = makeUnique<SpeechRecognitionPermissionManager>(*this);
 
-    m_speechRecognitionPermissionManager->request(clientOrigin, WTFMove(completionHandler));
+    m_speechRecognitionPermissionManager->request(lang, clientOrigin, WTFMove(completionHandler));
 }
 

trunk/Source/WebKit/UIProcess/WebPageProxy.h

@@ -1830 +1830 @@
     size_t suspendMediaPlaybackCounter() { return m_suspendMediaPlaybackCounter; }
 
-    void requestSpeechRecognitionPermission(const WebCore::ClientOrigin&, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&&);
+    void requestSpeechRecognitionPermission(const String& lang, const WebCore::ClientOrigin&, CompletionHandler<void(SpeechRecognitionPermissionDecision)>&&);
     void requestSpeechRecognitionPermissionByDefaultAction(const WebCore::SecurityOrigin&, CompletionHandler<void(bool)>&&);
 

trunk/Source/WebKit/UIProcess/WebProcessProxy.cpp

@@ -1723 +1723 @@
     ASSERT(!m_speechRecognitionServerMap.contains(identifier));
     auto& speechRecognitionServer = m_speechRecognitionServerMap.add(identifier, nullptr).iterator->value;
-    auto permissionChecker = [weakPage = makeWeakPtr(targetPage)](auto& origin, auto&& completionHandler) mutable {
+    auto permissionChecker = [weakPage = makeWeakPtr(targetPage)](auto& lang, auto& origin, auto&& completionHandler) mutable {
         if (!weakPage) {
             completionHandler(SpeechRecognitionPermissionDecision::Deny);
@@ -1729 +1729 @@
         }
 
-        weakPage->requestSpeechRecognitionPermission(origin, WTFMove(completionHandler));
+        weakPage->requestSpeechRecognitionPermission(lang, origin, WTFMove(completionHandler));
     };
     auto checkIfMockCaptureDevicesEnabled = [weakPage = makeWeakPtr(targetPage)]() {