<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[167343] trunk/Source/WebKit2</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/167343">167343</a></dd>
<dt>Author</dt> <dd>mitz@apple.com</dd>
<dt>Date</dt> <dd>2014-04-15 22:16:36 -0700 (Tue, 15 Apr 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>[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.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKWebViewmm">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoa_WKFormDelegateh">trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKFormDelegate.h</a></li>
<li><a href="#trunkSourceWebKit2WebProcessInjectedBundleAPICocoaWKWebProcessPlugInFormDelegatePrivateh">trunk/Source/WebKit2/WebProcess/InjectedBundle/API/Cocoa/WKWebProcessPlugInFormDelegatePrivate.h</a></li>
<li><a href="#trunkSourceWebKit2WebProcessInjectedBundleAPImacWKWebProcessPlugInBrowserContextControllermm">trunk/Source/WebKit2/WebProcess/InjectedBundle/API/mac/WKWebProcessPlugInBrowserContextController.mm</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (167342 => 167343)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog        2014-04-16 03:45:28 UTC (rev 167342)
+++ trunk/Source/WebKit2/ChangeLog        2014-04-16 05:16:36 UTC (rev 167343)
</span><span class="lines">@@ -1,3 +1,25 @@
</span><ins>+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.
+
</ins><span class="cx"> 2014-04-15 Hyowon Kim <hw1008.kim@samsung.com>
</span><span class="cx">
</span><span class="cx"> Make page overlay functionality working on coordinated graphics.
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKWebViewmm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm (167342 => 167343)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm        2014-04-16 03:45:28 UTC (rev 167342)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm        2014-04-16 05:16:36 UTC (rev 167343)
</span><span class="lines">@@ -28,6 +28,7 @@
</span><span class="cx">
</span><span class="cx"> #if WK_API_ENABLED
</span><span class="cx">
</span><ins>+#import "APIFormClient.h"
</ins><span class="cx"> #import "FindClient.h"
</span><span class="cx"> #import "NavigationState.h"
</span><span class="cx"> #import "RemoteLayerTreeTransaction.h"
</span><span class="lines">@@ -52,10 +53,12 @@
</span><span class="cx"> #import "WebBackForwardList.h"
</span><span class="cx"> #import "WebCertificateInfo.h"
</span><span class="cx"> #import "WebContext.h"
</span><ins>+#import "WebFormSubmissionListenerProxy.h"
</ins><span class="cx"> #import "WebPageGroup.h"
</span><span class="cx"> #import "WebPageProxy.h"
</span><span class="cx"> #import "WebProcessProxy.h"
</span><span class="cx"> #import "_WKFindDelegate.h"
</span><ins>+#import "_WKFormDelegate.h"
</ins><span class="cx"> #import "_WKRemoteObjectRegistryInternal.h"
</span><span class="cx"> #import "_WKVisitedLinkProviderInternal.h"
</span><span class="cx"> #import <wtf/RetainPtr.h>
</span><span class="lines">@@ -1185,6 +1188,59 @@
</span><span class="cx"> - (void)_setFormDelegate:(id <_WKFormDelegate>)formDelegate
</span><span class="cx"> {
</span><span class="cx"> _formDelegate = formDelegate;
</span><ins>+
+ 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);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> #pragma mark iOS-specific methods
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoa_WKFormDelegateh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKFormDelegate.h (167342 => 167343)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKFormDelegate.h        2014-04-16 03:45:28 UTC (rev 167342)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/_WKFormDelegate.h        2014-04-16 05:16:36 UTC (rev 167343)
</span><span class="lines">@@ -37,6 +37,7 @@
</span><span class="cx"> @optional
</span><span class="cx">
</span><span class="cx"> - (void)_webView:(WKWebView *)webView didStartInputSession:(id <_WKFormInputSession>)inputSession;
</span><ins>+- (void)_webView:(WKWebView *)webView willSubmitFormValues:(NSDictionary *)values userObject:(NSObject <NSSecureCoding> *)userObject submissionHandler:(void (^)(void))submissionHandler;
</ins><span class="cx">
</span><span class="cx"> #if TARGET_OS_IPHONE
</span><span class="cx"> - (void)_webView:(WKWebView *)webView accessoryViewCustomButtonTappedInFormInputSession:(id <_WKFormInputSession>)inputSession;
</span></span></pre></div>
<a id="trunkSourceWebKit2WebProcessInjectedBundleAPICocoaWKWebProcessPlugInFormDelegatePrivateh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/WebProcess/InjectedBundle/API/Cocoa/WKWebProcessPlugInFormDelegatePrivate.h (167342 => 167343)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/WebProcess/InjectedBundle/API/Cocoa/WKWebProcessPlugInFormDelegatePrivate.h        2014-04-16 03:45:28 UTC (rev 167342)
+++ trunk/Source/WebKit2/WebProcess/InjectedBundle/API/Cocoa/WKWebProcessPlugInFormDelegatePrivate.h        2014-04-16 05:16:36 UTC (rev 167343)
</span><span class="lines">@@ -40,6 +40,10 @@
</span><span class="cx"> - (void)_webProcessPlugInBrowserContextController:(WKWebProcessPlugInBrowserContextController *)controller willSubmitForm:(WKWebProcessPlugInNodeHandle *)form toFrame:(WKWebProcessPlugInFrame *)frame fromFrame:(WKWebProcessPlugInFrame *)sourceFrame withValues:(NSDictionary *)values;
</span><span class="cx"> - (void)_webProcessPlugInBrowserContextController:(WKWebProcessPlugInBrowserContextController *)controller textDidChangeInTextField:(WKWebProcessPlugInNodeHandle *)textField inFrame:(WKWebProcessPlugInFrame *)frame initiatedByUserTyping:(BOOL)initiatedByUserTyping;
</span><span class="cx">
</span><ins>+// 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;
+
</ins><span class="cx"> // The return value is exposed in the UI process via the userObject property of the _WKFormInputSession object.
</span><span class="cx"> - (NSObject <NSSecureCoding> *)_webProcessPlugInBrowserContextController:(WKWebProcessPlugInBrowserContextController *)controller willBeginInputSessionForElement:(WKWebProcessPlugInNodeHandle *)node inFrame:(WKWebProcessPlugInFrame *)frame;
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2WebProcessInjectedBundleAPImacWKWebProcessPlugInBrowserContextControllermm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/WebProcess/InjectedBundle/API/mac/WKWebProcessPlugInBrowserContextController.mm (167342 => 167343)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/WebProcess/InjectedBundle/API/mac/WKWebProcessPlugInBrowserContextController.mm        2014-04-16 03:45:28 UTC (rev 167342)
+++ trunk/Source/WebKit2/WebProcess/InjectedBundle/API/mac/WKWebProcessPlugInBrowserContextController.mm        2014-04-16 05:16:36 UTC (rev 167343)
</span><span class="lines">@@ -407,15 +407,41 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ static void encodeUserObject(NSObject <NSSecureCoding> *userObject, RefPtr<API::Object>& userData)
+ {
+ if (!userObject)
+ return;
+
+ auto data = adoptNS([[NSMutableData alloc] init]);
+ auto archiver = adoptNS([[NSKeyedArchiver alloc] initForWritingWithMutableData:data.get()]);
+ [archiver setRequiresSecureCoding:YES];
+ @try {
+ [archiver encodeObject:userObject forKey:@"userObject"];
+ } @catch (NSException *exception) {
+ LOG_ERROR("Failed to encode user object: %@", exception);
+ return;
+ }
+ [archiver finishEncoding];
+
+ userData = API::Data::createWithoutCopying((const unsigned char*)[data bytes], [data length], releaseNSData, data.leakRef()).leakRef();
+ }
+
</ins><span class="cx"> virtual void willSubmitForm(WebPage*, HTMLFormElement* formElement, WebFrame* frame, WebFrame* sourceFrame, const Vector<std::pair<WTF::String, WTF::String>>& values, RefPtr<API::Object>& userData) override
</span><span class="cx"> {
</span><span class="cx"> auto formDelegate = m_controller->_formDelegate.get();
</span><span class="cx">
</span><del>- if ([formDelegate respondsToSelector:@selector(_webProcessPlugInBrowserContextController:willSubmitForm:toFrame:fromFrame:withValues:)]) {
</del><ins>+ if ([formDelegate respondsToSelector:@selector(_webProcessPlugInBrowserContextController:newWillSubmitForm:toFrame:fromFrame:withValues:)]) {
</ins><span class="cx"> auto valueMap = adoptNS([[NSMutableDictionary alloc] initWithCapacity:values.size()]);
</span><span class="cx"> for (const auto& pair : values)
</span><span class="cx"> [valueMap setObject:pair.second forKey:pair.first];
</span><span class="cx">
</span><ins>+ 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];
+
</ins><span class="cx"> [formDelegate _webProcessPlugInBrowserContextController:m_controller willSubmitForm:wrapper(*InjectedBundleNodeHandle::getOrCreate(formElement).get()) toFrame:wrapper(*frame) fromFrame:wrapper(*sourceFrame) withValues:valueMap.get()];
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="lines">@@ -441,21 +467,7 @@
</span><span class="cx"> return;
</span><span class="cx">
</span><span class="cx"> NSObject <NSSecureCoding> *userObject = [formDelegate _webProcessPlugInBrowserContextController:m_controller willBeginInputSessionForElement:wrapper(*WebKit::InjectedBundleNodeHandle::getOrCreate(element)) inFrame:wrapper(*frame)];
</span><del>- if (!userObject)
- return;
-
- auto data = adoptNS([[NSMutableData alloc] init]);
- auto archiver = adoptNS([[NSKeyedArchiver alloc] initForWritingWithMutableData:data.get()]);
- [archiver setRequiresSecureCoding:YES];
- @try {
- [archiver encodeObject:userObject forKey:@"userObject"];
- } @catch (NSException *exception) {
- LOG_ERROR("Failed to encode user object: %@", exception);
- return;
- }
- [archiver finishEncoding];
-
- userData = API::Data::createWithoutCopying((const unsigned char*)[data bytes], [data length], releaseNSData, data.leakRef()).leakRef();
</del><ins>+ encodeUserObject(userObject, userData);
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> private:
</span></span></pre>
</div>
</div>
</body>
</html>