Changeset 264014 in webkit

Timestamp:

Jul 7, 2020, 4:31:27 AM (6 years ago)

Author:

Tomoki Imai

Message:

[Win] Implement Pasteboard::writeCustomData for Web Inspector Console tab
​https://bugs.webkit.org/show_bug.cgi?id=213986

Reviewed by Fujii Hironori.

Source/WebCore:

Implement Pasteboard::writeCustomData and Pasteboard::typesSafeForBindings.
This fixes the issue which we cannot copy text in WebInspector's Console tab.

We enable some existing testcases for pasteboard.

• platform/Pasteboard.h:
• platform/PasteboardCustomData.cpp:

(WebCore::PasteboardCustomData::fromPersistenceDecoder): Construct PasteboardCustomData from WTF::Persistence::Decoder.
(WebCore::PasteboardCustomData::fromSharedBuffer): Use fromPersistenceDecoder function to implement.

• platform/PasteboardCustomData.h:
• platform/win/ClipboardUtilitiesWin.cpp:

(WebCore::createGlobalData): Add uint8_t* variant.

• platform/win/ClipboardUtilitiesWin.h:
• platform/win/PasteboardWin.cpp:

(WebCore::Pasteboard::finishCreatingPasteboard): Register new clipboard format CustomDataClipboardFormat.
(WebCore::Pasteboard::readPasteboardCustomData): Helper function to read PasteboardCustomData from the pasteboard.
(WebCore::Pasteboard::typesSafeForBindings): Implemented.
(WebCore::Pasteboard::readOrigin): Implemented.
(WebCore::Pasteboard::readStringInCustomData): Implemented.
(WebCore::Pasteboard::writeCustomData): Implemented.

Source/WebKit:

• Shared/WebPreferencesDefaultValues.h: Turn DEFAULT_CUSTOM_PASTEBOARD_DATA_ENABLED on for Windows

LayoutTests:

Now pasteboard tests related to custom data pass.

• platform/win/TestExpectations:

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/platform/win/TestExpectations (modified) (1 diff)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/platform/Pasteboard.h (modified) (1 diff)
• Source/WebCore/platform/PasteboardCustomData.cpp (modified) (2 diffs)
• Source/WebCore/platform/PasteboardCustomData.h (modified) (2 diffs)
• Source/WebCore/platform/win/ClipboardUtilitiesWin.cpp (modified) (1 diff)
• Source/WebCore/platform/win/ClipboardUtilitiesWin.h (modified) (1 diff)
• Source/WebCore/platform/win/PasteboardWin.cpp (modified) (6 diffs)
• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/Shared/WebPreferencesDefaultValues.h (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2020-07-07  Tomoki Imai  <Tomoki.Imai@sony.com>
+
+        [Win] Implement Pasteboard::writeCustomData for Web Inspector Console tab
+        https://bugs.webkit.org/show_bug.cgi?id=213986
+
+        Reviewed by Fujii Hironori.
+
+        Now pasteboard tests related to custom data pass.
+
+        * platform/win/TestExpectations:
+
 2020-07-07  Philippe Normand  <pnormand@igalia.com>
 

trunk/LayoutTests/platform/win/TestExpectations

@@ -1187 +1187 @@
 [ Debug ] editing/selection/4975120.html [ Skip ] # Debug Assertion
 
-# Custom pasteboard data is not supported on Windows.
-editing/pasteboard/clipboard-customData.html [ Skip ]
 http/tests/security/clipboard/copy-paste-url-across-origin-sanitizes-url.html [ Skip ]
 http/tests/security/clipboard/copy-paste-html-across-origin-sanitizes-html.html [ Skip ]

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2020-07-07  Tomoki Imai  <Tomoki.Imai@sony.com>
+
+        [Win] Implement Pasteboard::writeCustomData for Web Inspector Console tab
+        https://bugs.webkit.org/show_bug.cgi?id=213986
+
+        Reviewed by Fujii Hironori.
+
+        Implement Pasteboard::writeCustomData and Pasteboard::typesSafeForBindings.
+        This fixes the issue which we cannot copy text in WebInspector's Console tab.
+
+        We enable some existing testcases for pasteboard.
+
+        * platform/Pasteboard.h:
+        * platform/PasteboardCustomData.cpp:
+        (WebCore::PasteboardCustomData::fromPersistenceDecoder): Construct PasteboardCustomData from WTF::Persistence::Decoder.
+        (WebCore::PasteboardCustomData::fromSharedBuffer): Use fromPersistenceDecoder function to implement.
+        * platform/PasteboardCustomData.h:
+        * platform/win/ClipboardUtilitiesWin.cpp:
+        (WebCore::createGlobalData): Add uint8_t* variant.
+        * platform/win/ClipboardUtilitiesWin.h:
+        * platform/win/PasteboardWin.cpp:
+        (WebCore::Pasteboard::finishCreatingPasteboard): Register new clipboard format CustomDataClipboardFormat.
+        (WebCore::Pasteboard::readPasteboardCustomData): Helper function to read PasteboardCustomData from the pasteboard.
+        (WebCore::Pasteboard::typesSafeForBindings): Implemented.
+        (WebCore::Pasteboard::readOrigin): Implemented.
+        (WebCore::Pasteboard::readStringInCustomData): Implemented.
+        (WebCore::Pasteboard::writeCustomData): Implemented.
+
+
 2020-07-06  Simon Fraser  <simon.fraser@apple.com>
 

trunk/Source/WebCore/platform/Pasteboard.h

@@ -316 +316 @@
     void writeURLToDataObject(const URL&, const String&);
     void writePlainTextToDataObject(const String&, SmartReplaceOption);
+    Optional<PasteboardCustomData> readPasteboardCustomData();
 #endif
 

trunk/Source/WebCore/platform/PasteboardCustomData.cpp

@@ -93 +93 @@
 }
 
-PasteboardCustomData PasteboardCustomData::fromSharedBuffer(const SharedBuffer& buffer)
+PasteboardCustomData PasteboardCustomData::fromPersistenceDecoder(WTF::Persistence::Decoder&& decoder)
 {
     constexpr unsigned maxSupportedDataSerializationVersionNumber = 1;
 
     PasteboardCustomData result;
-    auto decoder = buffer.decoder();
     Optional<unsigned> version;
     decoder >> version;
@@ -124 +123 @@
 
     return result;
+}
+
+PasteboardCustomData PasteboardCustomData::fromSharedBuffer(const SharedBuffer& buffer)
+{
+    return fromPersistenceDecoder(buffer.decoder());
 }
 

trunk/Source/WebCore/platform/PasteboardCustomData.h

@@ -30 +30 @@
 #include <wtf/Variant.h>
 #include <wtf/Vector.h>
+#include <wtf/persistence/PersistentCoders.h>
 #include <wtf/text/WTFString.h>
 
@@ -62 +63 @@
     WEBCORE_EXPORT Ref<SharedBuffer> createSharedBuffer() const;
     WEBCORE_EXPORT static PasteboardCustomData fromSharedBuffer(const SharedBuffer&);
+    WEBCORE_EXPORT static PasteboardCustomData fromPersistenceDecoder(WTF::Persistence::Decoder&&);
 
     String readString(const String& type) const;

trunk/Source/WebCore/platform/win/ClipboardUtilitiesWin.cpp

@@ -216 +216 @@
 }
 
+HGLOBAL createGlobalData(const uint8_t* data, size_t length)
+{
+    HGLOBAL vm = ::GlobalAlloc(GPTR, length + 1);
+    if (!vm)
+        return 0;
+    uint8_t* buffer = static_cast<uint8_t*>(GlobalLock(vm));
+    memcpy(buffer, data, length);
+    buffer[length] = 0;
+    GlobalUnlock(vm);
+    return vm;
+}
+
 static String getFullCFHTML(IDataObject* data)
 {

trunk/Source/WebCore/platform/win/ClipboardUtilitiesWin.h

@@ -39 +39 @@
 HGLOBAL createGlobalData(const Vector<char>&);
 HGLOBAL createGlobalData(const URL& url, const String& title);
+HGLOBAL createGlobalData(const uint8_t*, size_t);
 
 FORMATETC* urlWFormat();

trunk/Source/WebCore/platform/win/PasteboardWin.cpp

@@ -65 +65 @@
 static UINT BookmarkClipboardFormat = 0;
 static UINT WebSmartPasteFormat = 0;
+static UINT CustomDataClipboardFormat = 0;
 
 static LRESULT CALLBACK PasteboardOwnerWndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
@@ -136 +137 @@
     BookmarkClipboardFormat = ::RegisterClipboardFormat(L"UniformResourceLocatorW");
     WebSmartPasteFormat = ::RegisterClipboardFormat(L"WebKit Smart Paste Format");
+    CustomDataClipboardFormat = ::RegisterClipboardFormat(L"WebKit Custom Data Format");
 }
 
@@ -241 +243 @@
 }
 
-Vector<String> Pasteboard::typesSafeForBindings(const String&)
-{
-    notImplemented();
-    return { };
+Optional<PasteboardCustomData> Pasteboard::readPasteboardCustomData()
+{
+    if (::IsClipboardFormatAvailable(CustomDataClipboardFormat) && ::OpenClipboard(m_owner)) {
+        if (HANDLE cbData = ::GetClipboardData(CustomDataClipboardFormat)) {
+            size_t size = GlobalSize(cbData);
+            auto data = static_cast<uint8_t*>(GlobalLock(cbData));
+            auto customData = PasteboardCustomData::fromPersistenceDecoder({data, size});
+
+            GlobalUnlock(cbData);
+            ::CloseClipboard();
+
+            return customData;
+        }
+        ::CloseClipboard();
+    }
+
+    return WTF::nullopt;
+}
+
+Vector<String> Pasteboard::typesSafeForBindings(const String& origin)
+{
+    ListHashSet<String> domPasteboardTypes;
+
+    Optional<PasteboardCustomData> customData = readPasteboardCustomData();
+
+    if (customData && customData->origin() == origin) {
+        for (const auto& type : customData->orderedTypes())
+            domPasteboardTypes.add(type);
+    }
+
+    domPasteboardTypes.add("text/plain");
+    domPasteboardTypes.add("text/uri-list");
+    domPasteboardTypes.add("text/html");
+
+    return copyToVector(domPasteboardTypes);
 }
 
@@ -281 +314 @@
 String Pasteboard::readOrigin()
 {
-    notImplemented();
+    Optional<PasteboardCustomData> customData = readPasteboardCustomData();
+
+    if (customData)
+        return customData->origin();
+
     return { };
 }
@@ -305 +342 @@
 }
 
-String Pasteboard::readStringInCustomData(const String&)
-{
-    notImplemented();
+String Pasteboard::readStringInCustomData(const String& type)
+{
+    Optional<PasteboardCustomData> customData = readPasteboardCustomData();
+
+    if (customData)
+        return customData->readStringInCustomData(type);
+
     return { };
 }
@@ -1083 +1124 @@
 }
 
-void Pasteboard::writeCustomData(const Vector<PasteboardCustomData>&)
-{
+void Pasteboard::writeCustomData(const Vector<PasteboardCustomData>& data)
+{
+    if (data.isEmpty() || data.size() > 1) {
+        // We don't support more than one custom item in the clipboard.
+        return;
+    }
+
+    clear();
+
+    if (::OpenClipboard(m_owner)) {
+        const auto& customData = data.first();
+        customData.forEachPlatformStringOrBuffer([](auto& type, auto& stringOrBuffer) {
+            if (WTF::holds_alternative<String>(stringOrBuffer)) {
+                ClipboardDataType dataType = clipboardTypeFromMIMEType(type);
+
+                String str = WTF::get<String>(stringOrBuffer);
+                replaceNewlinesWithWindowsStyleNewlines(str);
+                HGLOBAL cbData = createGlobalData(str);
+
+                if (dataType == ClipboardDataTypeText) {
+                    if (cbData && !::SetClipboardData(CF_UNICODETEXT, cbData))
+                        ::GlobalFree(cbData);
+                } else if (dataType == ClipboardDataTypeURL) {
+                    if (cbData && !::SetClipboardData(BookmarkClipboardFormat, cbData))
+                        ::GlobalFree(cbData);
+                } else if (dataType == ClipboardDataTypeTextHTML) {
+                    if (cbData && !::SetClipboardData(HTMLClipboardFormat, cbData))
+                        ::GlobalFree(cbData);
+                }
+            }
+        });
+
+        if (customData.hasSameOriginCustomData() || !customData.origin().isEmpty()) {
+            auto sharedBuffer = customData.createSharedBuffer();
+            HGLOBAL cbData = createGlobalData(reinterpret_cast<const uint8_t*>(sharedBuffer->data()), sharedBuffer->size());
+            if (cbData && !::SetClipboardData(CustomDataClipboardFormat, cbData))
+                ::GlobalFree(cbData);
+        }
+
+        ::CloseClipboard();
+    }
 }
 

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2020-07-07  Tomoki Imai  <Tomoki.Imai@sony.com>
+
+        [Win] Implement Pasteboard::writeCustomData for Web Inspector Console tab
+        https://bugs.webkit.org/show_bug.cgi?id=213986
+
+        Reviewed by Fujii Hironori.
+
+        * Shared/WebPreferencesDefaultValues.h: Turn DEFAULT_CUSTOM_PASTEBOARD_DATA_ENABLED on for Windows
+
 2020-07-06  Simon Fraser  <simon.fraser@apple.com>
 

trunk/Source/WebKit/Shared/WebPreferencesDefaultValues.h

@@ -253 +253 @@
 #endif
 
-#if PLATFORM(COCOA) || PLATFORM(GTK)
+#if PLATFORM(COCOA) || PLATFORM(GTK) || PLATFORM(WIN)
 #define DEFAULT_CUSTOM_PASTEBOARD_DATA_ENABLED true
 #else