Changeset 167343 in webkit

Timestamp:

Apr 15, 2014, 10:16:36 PM (11 years ago)

Author:

mitz@apple.com

Message:

[Cocoa] Add a form delegate method corresponding to willSubmitForm
​https://bugs.webkit.org/show_bug.cgi?id=131718

Reviewed by Tim Horton.

• UIProcess/API/Cocoa/WKWebView.mm:

(-[WKWebView _setFormDelegate:]): Changed to define and create a FormClient (which derives
from API::FormClient and messages a delegate), and set it as the form client.

• UIProcess/API/Cocoa/_WKFormDelegate.h: Declared new delegate method.

• WebProcess/InjectedBundle/API/Cocoa/WKWebProcessPlugInFormDelegatePrivate.h: Added a

variant of willSubmitForm that returs a user object to pass to the delegate in the UI
process, giving it a temporary name with “new”.

• WebProcess/InjectedBundle/API/mac/WKWebProcessPlugInBrowserContextController.mm:

(-[WKWebProcessPlugInBrowserContextController _setFormDelegate:]): Changed willSubmitForm()
to check for the new bundle delegate method first and encode the user object as user data.
Moved the encoding of an NSObject <NSSecureCoding> as user data into a helper function.

Location:

trunk/Source/WebKit2

Files:

• ChangeLog (modified) (1 diff)
• UIProcess/API/Cocoa/WKWebView.mm (modified) (3 diffs)
• UIProcess/API/Cocoa/_WKFormDelegate.h (modified) (1 diff)
• WebProcess/InjectedBundle/API/Cocoa/WKWebProcessPlugInFormDelegatePrivate.h (modified) (1 diff)
• WebProcess/InjectedBundle/API/mac/WKWebProcessPlugInBrowserContextController.mm (modified) (2 diffs)

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2014-04-15  Dan Bernstein  <mitz@apple.com>
+
+        [Cocoa] Add a form delegate method corresponding to willSubmitForm
+        https://bugs.webkit.org/show_bug.cgi?id=131718
+
+        Reviewed by Tim Horton.
+
+        * UIProcess/API/Cocoa/WKWebView.mm:
+        (-[WKWebView _setFormDelegate:]): Changed to define and create a FormClient (which derives
+        from API::FormClient and messages a delegate), and set it as the form client.
+
+        * UIProcess/API/Cocoa/_WKFormDelegate.h: Declared new delegate method.
+
+        * WebProcess/InjectedBundle/API/Cocoa/WKWebProcessPlugInFormDelegatePrivate.h: Added a
+        variant of willSubmitForm that returs a user object to pass to the delegate in the UI
+        process, giving it a temporary name with “new”.
+
+        * WebProcess/InjectedBundle/API/mac/WKWebProcessPlugInBrowserContextController.mm:
+        (-[WKWebProcessPlugInBrowserContextController _setFormDelegate:]): Changed willSubmitForm()
+        to check for the new bundle delegate method first and encode the user object as user data.
+        Moved the encoding of an NSObject <NSSecureCoding> as user data into a helper function.
+
 2014-04-15  Hyowon Kim  <hw1008.kim@samsung.com>
 

trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm

@@ -29 +29 @@
 #if WK_API_ENABLED
 
+#import "APIFormClient.h"
 #import "FindClient.h"
 #import "NavigationState.h"
@@ -53 +54 @@
 #import "WebCertificateInfo.h"
 #import "WebContext.h"
+#import "WebFormSubmissionListenerProxy.h"
 #import "WebPageGroup.h"
 #import "WebPageProxy.h"
 #import "WebProcessProxy.h"
 #import "_WKFindDelegate.h"
+#import "_WKFormDelegate.h"
 #import "_WKRemoteObjectRegistryInternal.h"
 #import "_WKVisitedLinkProviderInternal.h"
@@ -1186 +1189 @@
 {
     _formDelegate = formDelegate;
+
+    class FormClient : public API::FormClient {
+    public:
+        explicit FormClient(WKWebView *webView)
+            : m_webView(webView)
+        {
+        }
+
+        virtual ~FormClient() { }
+
+        virtual bool willSubmitForm(WebKit::WebPageProxy*, WebKit::WebFrameProxy*, WebKit::WebFrameProxy* sourceFrame, const Vector<std::pair<WTF::String, WTF::String>>& textFieldValues, API::Object* userData, WebKit::WebFormSubmissionListenerProxy* listener) override
+        {
+            if (userData && userData->type() != API::Object::Type::Data) {
+                ASSERT(!userData || userData->type() == API::Object::Type::Data);
+                m_webView->_page->process().connection()->markCurrentlyDispatchedMessageAsInvalid();
+                return false;
+            }
+
+            auto formDelegate = m_webView->_formDelegate.get();
+
+            if (![formDelegate respondsToSelector:@selector(_webView:willSubmitFormValues:userObject:submissionHandler:)])
+                return false;
+
+            auto valueMap = adoptNS([[NSMutableDictionary alloc] initWithCapacity:textFieldValues.size()]);
+            for (const auto& pair : textFieldValues)
+                [valueMap setObject:pair.second forKey:pair.first];
+
+            NSObject <NSSecureCoding> *userObject = nil;
+            if (API::Data* data = static_cast<API::Data*>(userData)) {
+                auto nsData = adoptNS([[NSData alloc] initWithBytesNoCopy:const_cast<void*>(static_cast<const void*>(data->bytes())) length:data->size() freeWhenDone:NO]);
+                auto unarchiver = adoptNS([[NSKeyedUnarchiver alloc] initForReadingWithData:nsData.get()]);
+                [unarchiver setRequiresSecureCoding:YES];
+                @try {
+                    userObject = [unarchiver decodeObjectOfClass:[NSObject class] forKey:@"userObject"];
+                } @catch (NSException *exception) {
+                    LOG_ERROR("Failed to decode user data: %@", exception);
+                }
+            }
+
+            [formDelegate _webView:m_webView willSubmitFormValues:valueMap.get() userObject:userObject submissionHandler:^{
+                listener->continueSubmission();
+            }];
+            return true;
+        }
+
+    private:
+        WKWebView *m_webView;
+    };
+
+    if (formDelegate)
+        _page->setFormClient(std::make_unique<FormClient>(self));
+    else
+        _page->setFormClient(nullptr);
 }
 

trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKFormDelegate.h

@@ -38 +38 @@
 
 - (void)_webView:(WKWebView *)webView didStartInputSession:(id <_WKFormInputSession>)inputSession;
+- (void)_webView:(WKWebView *)webView willSubmitFormValues:(NSDictionary *)values userObject:(NSObject <NSSecureCoding> *)userObject submissionHandler:(void (^)(void))submissionHandler;
 
 #if TARGET_OS_IPHONE

trunk/Source/WebKit2/WebProcess/InjectedBundle/API/Cocoa/WKWebProcessPlugInFormDelegatePrivate.h

@@ -41 +41 @@
 - (void)_webProcessPlugInBrowserContextController:(WKWebProcessPlugInBrowserContextController *)controller textDidChangeInTextField:(WKWebProcessPlugInNodeHandle *)textField inFrame:(WKWebProcessPlugInFrame *)frame initiatedByUserTyping:(BOOL)initiatedByUserTyping;
 
+// FIXME: Once no one implements the above willSubmitForm:, remove "new" from the name.
+// The return value is exposed in the UI process via the userObject parameter to [id <_WKFormDelegate> _webView:willSubmitFormValues:userObject:submissionHandler:].
+- (NSObject <NSSecureCoding> *)_webProcessPlugInBrowserContextController:(WKWebProcessPlugInBrowserContextController *)controller newWillSubmitForm:(WKWebProcessPlugInNodeHandle *)form toFrame:(WKWebProcessPlugInFrame *)frame fromFrame:(WKWebProcessPlugInFrame *)sourceFrame withValues:(NSDictionary *)values;
+
 // The return value is exposed in the UI process via the userObject property of the _WKFormInputSession object.
 - (NSObject <NSSecureCoding> *)_webProcessPlugInBrowserContextController:(WKWebProcessPlugInBrowserContextController *)controller willBeginInputSessionForElement:(WKWebProcessPlugInNodeHandle *)node inFrame:(WKWebProcessPlugInFrame *)frame;

trunk/Source/WebKit2/WebProcess/InjectedBundle/API/mac/WKWebProcessPlugInBrowserContextController.mm

@@ -408 +408 @@
         }
 
-        virtual void willSubmitForm(WebPage*, HTMLFormElement* formElement, WebFrame* frame, WebFrame* sourceFrame, const Vector<std::pair<WTF::String, WTF::String>>& values, RefPtr<API::Object>& userData) override
-        {
-            auto formDelegate = m_controller->_formDelegate.get();
-
-            if ([formDelegate respondsToSelector:@selector(_webProcessPlugInBrowserContextController:willSubmitForm:toFrame:fromFrame:withValues:)]) {
-                auto valueMap = adoptNS([[NSMutableDictionary alloc] initWithCapacity:values.size()]);
-                for (const auto& pair : values)
-                    [valueMap setObject:pair.second forKey:pair.first];
-
-                [formDelegate _webProcessPlugInBrowserContextController:m_controller willSubmitForm:wrapper(*InjectedBundleNodeHandle::getOrCreate(formElement).get()) toFrame:wrapper(*frame) fromFrame:wrapper(*sourceFrame) withValues:valueMap.get()];
-            }
-        }
-
-        virtual void textDidChangeInTextField(WebPage*, HTMLInputElement* inputElement, WebFrame* frame, bool initiatedByUserTyping) override
-        {
-            auto formDelegate = m_controller->_formDelegate.get();
-
-            if ([formDelegate respondsToSelector:@selector(_webProcessPlugInBrowserContextController:textDidChangeInTextField:inFrame:initiatedByUserTyping:)])
-                [formDelegate _webProcessPlugInBrowserContextController:m_controller textDidChangeInTextField:wrapper(*WebKit::InjectedBundleNodeHandle::getOrCreate(inputElement)) inFrame:wrapper(*frame) initiatedByUserTyping:initiatedByUserTyping];
-        }
-
-        static void releaseNSData(unsigned char*, const void* untypedData)
-        {
-            [(NSData *)untypedData release];
-        }
-
-        virtual void willBeginInputSession(WebPage*, Element* element, WebFrame* frame, RefPtr<API::Object>& userData) override
-        {
-            auto formDelegate = m_controller->_formDelegate.get();
-
-            if (![formDelegate respondsToSelector:@selector(_webProcessPlugInBrowserContextController:willBeginInputSessionForElement:inFrame:)])
-                return;
-
-            NSObject <NSSecureCoding> *userObject = [formDelegate _webProcessPlugInBrowserContextController:m_controller willBeginInputSessionForElement:wrapper(*WebKit::InjectedBundleNodeHandle::getOrCreate(element)) inFrame:wrapper(*frame)];
+        static void encodeUserObject(NSObject <NSSecureCoding> *userObject, RefPtr<API::Object>& userData)
+        {
             if (!userObject)
                 return;
@@ -459 +427 @@
         }
 
+        virtual void willSubmitForm(WebPage*, HTMLFormElement* formElement, WebFrame* frame, WebFrame* sourceFrame, const Vector<std::pair<WTF::String, WTF::String>>& values, RefPtr<API::Object>& userData) override
+        {
+            auto formDelegate = m_controller->_formDelegate.get();
+
+            if ([formDelegate respondsToSelector:@selector(_webProcessPlugInBrowserContextController:newWillSubmitForm:toFrame:fromFrame:withValues:)]) {
+                auto valueMap = adoptNS([[NSMutableDictionary alloc] initWithCapacity:values.size()]);
+                for (const auto& pair : values)
+                    [valueMap setObject:pair.second forKey:pair.first];
+
+                NSObject <NSSecureCoding> *userObject = [formDelegate _webProcessPlugInBrowserContextController:m_controller newWillSubmitForm:wrapper(*InjectedBundleNodeHandle::getOrCreate(formElement).get()) toFrame:wrapper(*frame) fromFrame:wrapper(*sourceFrame) withValues:valueMap.get()];
+                encodeUserObject(userObject, userData);
+            } else if ([formDelegate respondsToSelector:@selector(_webProcessPlugInBrowserContextController:willSubmitForm:toFrame:fromFrame:withValues:)]) {
+                auto valueMap = adoptNS([[NSMutableDictionary alloc] initWithCapacity:values.size()]);
+                for (const auto& pair : values)
+                    [valueMap setObject:pair.second forKey:pair.first];
+
+                [formDelegate _webProcessPlugInBrowserContextController:m_controller willSubmitForm:wrapper(*InjectedBundleNodeHandle::getOrCreate(formElement).get()) toFrame:wrapper(*frame) fromFrame:wrapper(*sourceFrame) withValues:valueMap.get()];
+            }
+        }
+
+        virtual void textDidChangeInTextField(WebPage*, HTMLInputElement* inputElement, WebFrame* frame, bool initiatedByUserTyping) override
+        {
+            auto formDelegate = m_controller->_formDelegate.get();
+
+            if ([formDelegate respondsToSelector:@selector(_webProcessPlugInBrowserContextController:textDidChangeInTextField:inFrame:initiatedByUserTyping:)])
+                [formDelegate _webProcessPlugInBrowserContextController:m_controller textDidChangeInTextField:wrapper(*WebKit::InjectedBundleNodeHandle::getOrCreate(inputElement)) inFrame:wrapper(*frame) initiatedByUserTyping:initiatedByUserTyping];
+        }
+
+        static void releaseNSData(unsigned char*, const void* untypedData)
+        {
+            [(NSData *)untypedData release];
+        }
+
+        virtual void willBeginInputSession(WebPage*, Element* element, WebFrame* frame, RefPtr<API::Object>& userData) override
+        {
+            auto formDelegate = m_controller->_formDelegate.get();
+
+            if (![formDelegate respondsToSelector:@selector(_webProcessPlugInBrowserContextController:willBeginInputSessionForElement:inFrame:)])
+                return;
+
+            NSObject <NSSecureCoding> *userObject = [formDelegate _webProcessPlugInBrowserContextController:m_controller willBeginInputSessionForElement:wrapper(*WebKit::InjectedBundleNodeHandle::getOrCreate(element)) inFrame:wrapper(*frame)];
+            encodeUserObject(userObject, userData);
+        }
+
     private:
         WKWebProcessPlugInBrowserContextController *m_controller;