[iOS DnD] Allow the injected bundle to add client data when writing an image to the pasteboard

https://bugs.webkit.org/show_bug.cgi?id=173238
<rdar://problem/31943370>

Reviewed by Ryosuke Niwa and Tim Horton.

Source/WebCore:

Add clientTypes and clientData to PasteboardImage, and call out to the injected bundle using
getClientPasteboardDataForRange when writing a PasteboardImage. When generating item providers for dragging in
the UI process in PlatformPasteboard, add any available client data as representations to the initialization
list used to set the WebItemProviderPasteboard.

Test: DataInteraction.InjectedBundleImageElementData

* editing/ios/EditorIOS.mm:
(WebCore::Editor::writeImageToPasteboard):
* platform/Pasteboard.h:
* platform/ios/PlatformPasteboardIOS.mm:
(WebCore::PlatformPasteboard::writeObjectRepresentations):

Source/WebKit2:

Send PasteboardImage.clientTypes and PasteboardImage.clientData over IPC.

* Shared/WebCoreArgumentCoders.cpp:
(IPC::encodeClientTypesAndData):
(IPC::decodeClientTypesAndData):

Factor out common logic used to encode and decode client types and data into static helpers.

(IPC::ArgumentCoder<PasteboardWebContent>::encode):
(IPC::ArgumentCoder<PasteboardWebContent>::decode):
(IPC::ArgumentCoder<PasteboardImage>::encode):
(IPC::ArgumentCoder<PasteboardImage>::decode):

Tools:

Add a new unit test to verify that data inserted by the injected bundle when beginning a drag on an image
element is plumbed across to the UI delegate. Also refactors injected bundle unit tests to use the new version
of adjustedDataInteractionItemProvidersForItemProvider: that takes representing objects and additional data.

* TestWebKitAPI/Tests/ios/DataInteractionTests.mm:
(TestWebKitAPI::TEST):
* TestWebKitAPI/ios/DataInteractionSimulator.h:
* TestWebKitAPI/ios/DataInteractionSimulator.mm:
(-[DataInteractionSimulator _webView:adjustedDataInteractionItemProvidersForItemProvider:representingObjects:additionalData:]):
(-[DataInteractionSimulator _webView:adjustedDataInteractionItemProviders:]): Deleted.


git-svn-id: http://svn.webkit.org/repository/webkit/trunk@218128 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Author: [email protected]

Source/WebCore/ChangeLog

@@ -1,3 +1,24 @@
+2017-06-12  Wenson Hsieh  <[email protected]>
+
+        [iOS DnD] Allow the injected bundle to add client data when writing an image to the pasteboard
+        https://bugs.webkit.org/show_bug.cgi?id=173238
+        <rdar://problem/31943370>
+
+        Reviewed by Ryosuke Niwa and Tim Horton.
+
+        Add clientTypes and clientData to PasteboardImage, and call out to the injected bundle using
+        getClientPasteboardDataForRange when writing a PasteboardImage. When generating item providers for dragging in
+        the UI process in PlatformPasteboard, add any available client data as representations to the initialization
+        list used to set the WebItemProviderPasteboard.
+
+        Test: DataInteraction.InjectedBundleImageElementData
+
+        * editing/ios/EditorIOS.mm:
+        (WebCore::Editor::writeImageToPasteboard):
+        * platform/Pasteboard.h:
+        * platform/ios/PlatformPasteboardIOS.mm:
+        (WebCore::PlatformPasteboard::writeObjectRepresentations):
+
 2017-06-12  Sam Weinig  <[email protected]>
 
         [WebIDL] Re-implement GetOwnPropertySlot[ByIndex] generation to more closely follow WebIDL

Source/WebCore/editing/ios/EditorIOS.mm

@@ -211,6 +211,11 @@ static void getImage(Element& imageElement, RefPtr<Image>& image, CachedImage*&
     pasteboardImage.resourceMIMEType = pasteboard.resourceMIMEType(cachedImage->response().mimeType());
     pasteboardImage.resourceData = cachedImage->resourceBuffer();
 
+    Position beforeImagePosition(&imageElement, Position::PositionIsBeforeAnchor);
+    Position afterImagePosition(&imageElement, Position::PositionIsAfterAnchor);
+    RefPtr<Range> imageRange = Range::create(imageElement.document(), beforeImagePosition, afterImagePosition);
+    client()->getClientPasteboardDataForRange(imageRange.get(), pasteboardImage.clientTypes, pasteboardImage.clientData);
+
     pasteboard.write(pasteboardImage);
 }
 

Source/WebCore/platform/Pasteboard.h

@@ -110,6 +110,8 @@ struct PasteboardImage {
 #if !(PLATFORM(GTK) || PLATFORM(WIN))
     RefPtr<SharedBuffer> resourceData;
     String resourceMIMEType;
+    Vector<String> clientTypes;
+    Vector<RefPtr<SharedBuffer>> clientData;
 #endif
     String suggestedName;
 };

Source/WebCore/platform/ios/PlatformPasteboardIOS.mm

@@ -266,6 +266,12 @@ static void addRepresentationsForPlainText(WebItemProviderRegistrationInfoList *
 #if ENABLE(DATA_INTERACTION)
     RetainPtr<WebItemProviderRegistrationInfoList> itemsToRegister = adoptNS([[WebItemProviderRegistrationInfoList alloc] init]);
 
+    auto& types = pasteboardImage.clientTypes;
+    auto& data = pasteboardImage.clientData;
+    ASSERT(types.size() == data.size());
+    for (size_t i = 0, size = types.size(); i < size; ++i)
+        [itemsToRegister addData:data[i]->createNSData().get() forType:types[i]];
+
     if (auto image = pasteboardImage.image) {
         NSString *mimeType = pasteboardImage.resourceMIMEType;
         if (UTTypeIsDeclared((CFStringRef)mimeType)) {

Source/WebKit2/ChangeLog

@@ -1,3 +1,24 @@
+2017-06-12  Wenson Hsieh  <[email protected]>
+
+        [iOS DnD] Allow the injected bundle to add client data when writing an image to the pasteboard
+        https://bugs.webkit.org/show_bug.cgi?id=173238
+        <rdar://problem/31943370>
+
+        Reviewed by Ryosuke Niwa and Tim Horton.
+
+        Send PasteboardImage.clientTypes and PasteboardImage.clientData over IPC.
+
+        * Shared/WebCoreArgumentCoders.cpp:
+        (IPC::encodeClientTypesAndData):
+        (IPC::decodeClientTypesAndData):
+
+        Factor out common logic used to encode and decode client types and data into static helpers.
+
+        (IPC::ArgumentCoder<PasteboardWebContent>::encode):
+        (IPC::ArgumentCoder<PasteboardWebContent>::decode):
+        (IPC::ArgumentCoder<PasteboardImage>::encode):
+        (IPC::ArgumentCoder<PasteboardImage>::decode):
+
 2017-06-12  Wenson Hsieh  <[email protected]>
 
         [iOS DnD] Introduce hooks to override targeted drag previews when lifting and cancelling

Source/WebKit2/Shared/WebCoreArgumentCoders.cpp

@@ -1426,6 +1426,33 @@ bool ArgumentCoder<PasteboardURL>::decode(Decoder& decoder, PasteboardURL& conte
     return true;
 }
 
+static void encodeClientTypesAndData(Encoder& encoder, const Vector<String>& types, const Vector<RefPtr<SharedBuffer>>& data)
+{
+    ASSERT(types.size() == data.size());
+    encoder << types;
+    encoder << static_cast<uint64_t>(data.size());
+    for (size_t i = 0, size = types.size(); i < size; ++i)
+        encodeSharedBuffer(encoder, data[i].get());
+}
+
+static bool decodeClientTypesAndData(Decoder& decoder, Vector<String>& types, Vector<RefPtr<SharedBuffer>>& data)
+{
+    if (!decoder.decode(types))
+        return false;
+
+    uint64_t clientDataSize;
+    if (!decoder.decode(clientDataSize))
+        return false;
+
+    if (clientDataSize)
+        data.resize(clientDataSize);
+
+    for (size_t i = 0; i < clientDataSize; i++)
+        decodeSharedBuffer(decoder, data[i]);
+
+    return true;
+}
+
 void ArgumentCoder<PasteboardWebContent>::encode(Encoder& encoder, const PasteboardWebContent& content)
 {
     encoder << content.canSmartCopyOrDelete;
@@ -1436,10 +1463,7 @@ void ArgumentCoder<PasteboardWebContent>::encode(Encoder& encoder, const Pastebo
     encodeSharedBuffer(encoder, content.dataInRTFFormat.get());
     encodeSharedBuffer(encoder, content.dataInAttributedStringFormat.get());
 
-    encoder << content.clientTypes;
-    encoder << static_cast<uint64_t>(content.clientData.size());
-    for (size_t i = 0; i < content.clientData.size(); i++)
-        encodeSharedBuffer(encoder, content.clientData[i].get());
+    encodeClientTypesAndData(encoder, content.clientTypes, content.clientData);
 }
 
 bool ArgumentCoder<PasteboardWebContent>::decode(Decoder& decoder, PasteboardWebContent& content)
@@ -1456,15 +1480,8 @@ bool ArgumentCoder<PasteboardWebContent>::decode(Decoder& decoder, PasteboardWeb
         return false;
     if (!decodeSharedBuffer(decoder, content.dataInAttributedStringFormat))
         return false;
-    if (!decoder.decode(content.clientTypes))
+    if (!decodeClientTypesAndData(decoder, content.clientTypes, content.clientData))
         return false;
-    uint64_t clientDataSize;
-    if (!decoder.decode(clientDataSize))
-        return false;
-    if (clientDataSize)
-        content.clientData.resize(clientDataSize);
-    for (size_t i = 0; i < clientDataSize; i++)
-        decodeSharedBuffer(decoder, content.clientData[i]);
     return true;
 }
 
@@ -1477,6 +1494,7 @@ void ArgumentCoder<PasteboardImage>::encode(Encoder& encoder, const PasteboardIm
     encoder << pasteboardImage.suggestedName;
     if (pasteboardImage.resourceData)
         encodeSharedBuffer(encoder, pasteboardImage.resourceData.get());
+    encodeClientTypesAndData(encoder, pasteboardImage.clientTypes, pasteboardImage.clientData);
 }
 
 bool ArgumentCoder<PasteboardImage>::decode(Decoder& decoder, PasteboardImage& pasteboardImage)
@@ -1493,6 +1511,8 @@ bool ArgumentCoder<PasteboardImage>::decode(Decoder& decoder, PasteboardImage& p
         return false;
     if (!decodeSharedBuffer(decoder, pasteboardImage.resourceData))
         return false;
+    if (!decodeClientTypesAndData(decoder, pasteboardImage.clientTypes, pasteboardImage.clientData))
+        return false;
     return true;
 }
 

Tools/ChangeLog

@@ -1,3 +1,22 @@
+2017-06-12  Wenson Hsieh  <[email protected]>
+
+        [iOS DnD] Allow the injected bundle to add client data when writing an image to the pasteboard
+        https://bugs.webkit.org/show_bug.cgi?id=173238
+        <rdar://problem/31943370>
+
+        Reviewed by Ryosuke Niwa and Tim Horton.
+
+        Add a new unit test to verify that data inserted by the injected bundle when beginning a drag on an image
+        element is plumbed across to the UI delegate. Also refactors injected bundle unit tests to use the new version
+        of adjustedDataInteractionItemProvidersForItemProvider: that takes representing objects and additional data.
+
+        * TestWebKitAPI/Tests/ios/DataInteractionTests.mm:
+        (TestWebKitAPI::TEST):
+        * TestWebKitAPI/ios/DataInteractionSimulator.h:
+        * TestWebKitAPI/ios/DataInteractionSimulator.mm:
+        (-[DataInteractionSimulator _webView:adjustedDataInteractionItemProvidersForItemProvider:representingObjects:additionalData:]):
+        (-[DataInteractionSimulator _webView:adjustedDataInteractionItemProviders:]): Deleted.
+
 2017-06-12  Wenson Hsieh  <[email protected]>
 
         WebItemProviderPasteboard should call its completion block immediately after a synchronous load

Tools/TestWebKitAPI/Tests/ios/DataInteractionTests.mm

@@ -45,6 +45,8 @@
 typedef void (^FileLoadCompletionBlock)(NSURL *, BOOL, NSError *);
 typedef void (^DataLoadCompletionBlock)(NSData *, NSError *);
 
+static NSString *InjectedBundlePasteboardDataType = @"org.webkit.data";
+
 static UIImage *testIconImage()
 {
     return [UIImage imageNamed:@"TestWebKitAPI.resources/icon.png"];
@@ -759,26 +761,39 @@ static void checkSuggestedNameAndEstimatedSize(DataInteractionSimulator *simulat
     EXPECT_WK_STREQ("Hello world", [webView stringByEvaluatingJavaScript:@"editor.textContent"].UTF8String);
 }
 
-TEST(DataInteractionTests, AttachmentElementItemProviders)
+TEST(DataInteractionTests, InjectedBundleImageElementData)
+{
+    WKWebViewConfiguration *configuration = [WKWebViewConfiguration _test_configurationWithTestPlugInClassName:@"BundleEditingDelegatePlugIn"];
+    [configuration _setAttachmentElementEnabled:YES];
+    auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:CGRectMake(0, 0, 320, 500) configuration:configuration]);
+    [webView synchronouslyLoadTestPageNamed:@"image-and-contenteditable"];
+
+    __block RetainPtr<NSString> injectedString;
+    auto dataInteractionSimulator = adoptNS([[DataInteractionSimulator alloc] initWithWebView:webView.get()]);
+    [dataInteractionSimulator setConvertItemProvidersBlock:^NSArray *(UIItemProvider *itemProvider, NSArray *, NSDictionary *data)
+    {
+        injectedString = adoptNS([[NSString alloc] initWithData:data[InjectedBundlePasteboardDataType] encoding:NSUTF8StringEncoding]);
+        return @[ itemProvider ];
+    }];
+
+    [dataInteractionSimulator runFrom:CGPointMake(100, 50) to:CGPointMake(100, 250)];
+
+    EXPECT_WK_STREQ("hello", [injectedString UTF8String]);
+}
+
+TEST(DataInteractionTests, InjectedBundleAttachmentElementData)
 {
-    RetainPtr<WKWebViewConfiguration> configuration = [WKWebViewConfiguration _test_configurationWithTestPlugInClassName:@"BundleEditingDelegatePlugIn"];
+    WKWebViewConfiguration *configuration = [WKWebViewConfiguration _test_configurationWithTestPlugInClassName:@"BundleEditingDelegatePlugIn"];
     [configuration _setAttachmentElementEnabled:YES];
-    auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:CGRectMake(0, 0, 320, 500) configuration:configuration.get()]);
+    auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:CGRectMake(0, 0, 320, 500) configuration:configuration]);
     [webView synchronouslyLoadTestPageNamed:@"attachment-element"];
 
-    NSString *injectedTypeIdentifier = @"org.webkit.data";
     __block RetainPtr<NSString> injectedString;
     auto dataInteractionSimulator = adoptNS([[DataInteractionSimulator alloc] initWithWebView:webView.get()]);
-    [dataInteractionSimulator setConvertItemProvidersBlock:^NSArray *(NSArray *originalItemProviders)
+    [dataInteractionSimulator setConvertItemProvidersBlock:^NSArray *(UIItemProvider *itemProvider, NSArray *, NSDictionary *data)
     {
-        for (UIItemProvider *provider in originalItemProviders) {
-            NSData *injectedData = [provider copyDataRepresentationForTypeIdentifier:injectedTypeIdentifier error:nil];
-            if (!injectedData.length)
-                continue;
-            injectedString = adoptNS([[NSString alloc] initWithData:injectedData encoding:NSUTF8StringEncoding]);
-            break;
-        }
-        return originalItemProviders;
+        injectedString = adoptNS([[NSString alloc] initWithData:data[InjectedBundlePasteboardDataType] encoding:NSUTF8StringEncoding]);
+        return @[ itemProvider ];
     }];
 
     [dataInteractionSimulator runFrom:CGPointMake(50, 50) to:CGPointMake(50, 400)];

Tools/TestWebKitAPI/ios/DataInteractionSimulator.h

@@ -75,7 +75,7 @@ typedef NS_ENUM(NSInteger, DataInteractionPhase) {
 @property (nonatomic) BOOL allowsFocusToStartInputSession;
 @property (nonatomic) BOOL shouldEnsureUIApplication;
 @property (nonatomic) BlockPtr<BOOL(_WKActivatedElementInfo *)> showCustomActionSheetBlock;
-@property (nonatomic) BlockPtr<NSArray *(NSArray *)> convertItemProvidersBlock;
+@property (nonatomic) BlockPtr<NSArray *(UIItemProvider *, NSArray *, NSDictionary *)> convertItemProvidersBlock;
 @property (nonatomic, strong) NSArray *externalItemProviders;
 @property (nonatomic) BlockPtr<NSUInteger(NSUInteger, id)> overrideDataInteractionOperationBlock;
 @property (nonatomic) BlockPtr<void(BOOL, NSArray *)> dataInteractionOperationCompletionBlock;

Tools/TestWebKitAPI/ios/DataInteractionSimulator.mm

@@ -305,9 +305,9 @@ - (NSUInteger)_webView:(WKWebView *)webView willUpdateDataInteractionOperationTo
     return self.overrideDataInteractionOperationBlock ? self.overrideDataInteractionOperationBlock(operation, session) : operation;
 }
 
-- (NSArray<UIItemProvider *>*)_webView:(WKWebView *)webView adjustedDataInteractionItemProviders:(NSArray<UIItemProvider *>*)originalItemProviders
+- (NSArray *)_webView:(WKWebView *)webView adjustedDataInteractionItemProvidersForItemProvider:(UIItemProvider *)itemProvider representingObjects:(NSArray *)representingObjects additionalData:(NSDictionary *)additionalData
 {
-    return self.convertItemProvidersBlock ? self.convertItemProvidersBlock(originalItemProviders) : originalItemProviders;
+    return self.convertItemProvidersBlock ? self.convertItemProvidersBlock(itemProvider, representingObjects, additionalData) : @[ itemProvider ];
 }
 
 - (BOOL)_webView:(WKWebView *)webView showCustomSheetForElement:(_WKActivatedElementInfo *)element