On ToT, event.dataTransfer.getData("text/uri-list") returns an empty string when...
[WebKit-https.git] / Source / WebCore / platform / Pasteboard.h
1 /*
2  * Copyright (C) 2006, 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "DragImage.h"
29 #include "URL.h"
30 #include <wtf/HashMap.h>
31 #include <wtf/ListHashSet.h>
32 #include <wtf/Noncopyable.h>
33 #include <wtf/Vector.h>
34 #include <wtf/text/WTFString.h>
35
36 #if PLATFORM(IOS)
37 OBJC_CLASS NSString;
38 #endif
39
40 #if PLATFORM(COCOA)
41 OBJC_CLASS NSArray;
42 #endif
43
44 #if PLATFORM(WIN)
45 #include "COMPtr.h"
46 #include "WCDataObject.h"
47 #include <objidl.h>
48 #include <windows.h>
49 typedef struct HWND__* HWND;
50 #endif
51
52 // FIXME: This class uses the DOM and makes calls to Editor.
53 // It should be divested of its knowledge of the frame and editor.
54
55 namespace WebCore {
56
57 class DocumentFragment;
58 class DragData;
59 class Element;
60 class Frame;
61 class PasteboardStrategy;
62 class Range;
63 class SelectionData;
64 class SharedBuffer;
65
66 enum ShouldSerializeSelectedTextForDataTransfer { DefaultSelectedTextType, IncludeImageAltTextForDataTransfer };
67
68 // For writing to the pasteboard. Generally sorted with the richest formats on top.
69
70 struct PasteboardWebContent {
71 #if PLATFORM(COCOA)
72     WEBCORE_EXPORT PasteboardWebContent();
73     WEBCORE_EXPORT ~PasteboardWebContent();
74     bool canSmartCopyOrDelete;
75     RefPtr<SharedBuffer> dataInWebArchiveFormat;
76     RefPtr<SharedBuffer> dataInRTFDFormat;
77     RefPtr<SharedBuffer> dataInRTFFormat;
78     RefPtr<SharedBuffer> dataInAttributedStringFormat;
79     String dataInHTMLFormat;
80     String dataInStringFormat;
81     Vector<String> clientTypes;
82     Vector<RefPtr<SharedBuffer>> clientData;
83 #endif
84 #if PLATFORM(GTK)
85     bool canSmartCopyOrDelete;
86     String text;
87     String markup;
88 #endif
89 #if PLATFORM(WPE)
90     String text;
91     String markup;
92 #endif
93 };
94
95 struct PasteboardURL {
96     URL url;
97     String title;
98 #if PLATFORM(MAC)
99     String userVisibleForm;
100 #endif
101 #if PLATFORM(GTK)
102     String markup;
103 #endif
104 };
105
106 struct PasteboardImage {
107     WEBCORE_EXPORT PasteboardImage();
108     WEBCORE_EXPORT ~PasteboardImage();
109     RefPtr<Image> image;
110 #if PLATFORM(MAC)
111     RefPtr<SharedBuffer> dataInWebArchiveFormat;
112 #endif
113 #if !PLATFORM(WIN)
114     PasteboardURL url;
115 #endif
116 #if !(PLATFORM(GTK) || PLATFORM(WIN))
117     RefPtr<SharedBuffer> resourceData;
118     String resourceMIMEType;
119     Vector<String> clientTypes;
120     Vector<RefPtr<SharedBuffer>> clientData;
121 #endif
122     String suggestedName;
123     FloatSize imageSize;
124 };
125
126 // For reading from the pasteboard.
127
128 class PasteboardWebContentReader {
129 public:
130     virtual ~PasteboardWebContentReader() { }
131
132 #if !(PLATFORM(GTK) || PLATFORM(WIN))
133     virtual bool readWebArchive(SharedBuffer&) = 0;
134     virtual bool readFilenames(const Vector<String>&) = 0;
135     virtual bool readHTML(const String&) = 0;
136     virtual bool readRTFD(SharedBuffer&) = 0;
137     virtual bool readRTF(SharedBuffer&) = 0;
138     virtual bool readImage(Ref<SharedBuffer>&&, const String& type) = 0;
139     virtual bool readURL(const URL&, const String& title) = 0;
140 #endif
141     virtual bool readPlainText(const String&) = 0;
142 };
143
144 struct PasteboardPlainText {
145     String text;
146 #if PLATFORM(COCOA)
147     bool isURL;
148 #endif
149 };
150
151 struct PasteboardFileReader {
152     virtual ~PasteboardFileReader() = default;
153     virtual void readFilename(const String&) = 0;
154     virtual void readBuffer(const String& filename, const String& type, Ref<SharedBuffer>&&) = 0;
155 };
156
157 // FIXME: We need to ensure that the contents of sameOriginCustomData are not accessible across different origins.
158 struct PasteboardCustomData {
159     String origin;
160     Vector<String> orderedTypes;
161     HashMap<String, String> platformData;
162     HashMap<String, String> sameOriginCustomData;
163
164     WEBCORE_EXPORT Ref<SharedBuffer> createSharedBuffer() const;
165     WEBCORE_EXPORT static PasteboardCustomData fromSharedBuffer(const SharedBuffer&);
166
167 #if PLATFORM(COCOA)
168     static const char* cocoaType();
169 #endif
170 };
171
172 class Pasteboard {
173     WTF_MAKE_NONCOPYABLE(Pasteboard); WTF_MAKE_FAST_ALLOCATED;
174 public:
175     Pasteboard();
176     virtual ~Pasteboard();
177
178 #if PLATFORM(GTK)
179     explicit Pasteboard(const String& name);
180     explicit Pasteboard(SelectionData&);
181 #endif
182
183 #if PLATFORM(WIN)
184     explicit Pasteboard(IDataObject*);
185     explicit Pasteboard(WCDataObject*);
186     explicit Pasteboard(const DragDataMap&);
187 #endif
188
189     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForCopyAndPaste();
190
191     static bool isSafeTypeForDOMToReadAndWrite(const String&);
192     static bool canExposeURLToDOMWhenPasteboardContainsFiles(const String&);
193
194     virtual bool isStatic() const { return false; }
195
196     virtual bool hasData();
197     virtual Vector<String> typesSafeForBindings(const String& origin);
198     virtual Vector<String> typesForLegacyUnsafeBindings();
199     virtual String readOrigin();
200     virtual String readString(const String& type);
201     virtual String readStringInCustomData(const String& type);
202
203     virtual void writeString(const String& type, const String& data);
204     virtual void clear();
205     virtual void clear(const String& type);
206
207     virtual void read(PasteboardPlainText&);
208     virtual void read(PasteboardWebContentReader&);
209     virtual void read(PasteboardFileReader&);
210
211     virtual void write(const PasteboardURL&);
212     virtual void writeTrustworthyWebURLsPboardType(const PasteboardURL&);
213     virtual void write(const PasteboardImage&);
214     virtual void write(const PasteboardWebContent&);
215
216     virtual void writeCustomData(const PasteboardCustomData&);
217
218     virtual bool containsFiles();
219     virtual bool canSmartReplace();
220
221     virtual void writeMarkup(const String& markup);
222     enum SmartReplaceOption { CanSmartReplace, CannotSmartReplace };
223     virtual WEBCORE_EXPORT void writePlainText(const String&, SmartReplaceOption); // FIXME: Two separate functions would be clearer than one function with an argument.
224
225 #if ENABLE(DRAG_SUPPORT)
226     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForDragAndDrop();
227     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForDragAndDrop(const DragData&);
228
229     virtual void setDragImage(DragImage, const IntPoint& hotSpot);
230 #endif
231
232 #if PLATFORM(WIN)
233     RefPtr<DocumentFragment> documentFragment(Frame&, Range&, bool allowPlainText, bool& chosePlainText); // FIXME: Layering violation.
234     void writeImage(Element&, const URL&, const String& title); // FIXME: Layering violation.
235     void writeSelection(Range&, bool canSmartCopyOrDelete, Frame&, ShouldSerializeSelectedTextForDataTransfer = DefaultSelectedTextType); // FIXME: Layering violation.
236 #endif
237
238 #if PLATFORM(GTK)
239     const SelectionData& selectionData() const;
240     static std::unique_ptr<Pasteboard> createForGlobalSelection();
241 #endif
242
243 #if PLATFORM(IOS)
244     explicit Pasteboard(long changeCount);
245
246     static NSArray *supportedWebContentPasteboardTypes();
247     static String resourceMIMEType(NSString *mimeType);
248 #endif
249
250 #if PLATFORM(COCOA)
251     explicit Pasteboard(const String& pasteboardName);
252
253     static bool shouldTreatCocoaTypeAsFile(const String&);
254     WEBCORE_EXPORT static NSArray *supportedFileUploadPasteboardTypes();
255     const String& name() const { return m_pasteboardName; }
256     long changeCount() const;
257     const PasteboardCustomData& readCustomData();
258 #endif
259
260 #if PLATFORM(WIN)
261     COMPtr<IDataObject> dataObject() const { return m_dataObject; }
262     void setExternalDataObject(IDataObject*);
263     const DragDataMap& dragDataMap() const { return m_dragDataMap; }
264     void writeURLToWritableDataObject(const URL&, const String&);
265     COMPtr<WCDataObject> writableDataObject() const { return m_writableDataObject; }
266     void writeImageToDataObject(Element&, const URL&); // FIXME: Layering violation.
267 #endif
268
269 private:
270 #if PLATFORM(IOS)
271     bool respectsUTIFidelities() const;
272     void readRespectingUTIFidelities(PasteboardWebContentReader&);
273 #endif
274
275 #if PLATFORM(WIN)
276     void finishCreatingPasteboard();
277     void writeRangeToDataObject(Range&, Frame&); // FIXME: Layering violation.
278     void writeURLToDataObject(const URL&, const String&);
279     void writePlainTextToDataObject(const String&, SmartReplaceOption);
280 #endif
281
282 #if PLATFORM(COCOA)
283     Vector<String> readFilenames();
284     String readPlatformValueAsString(const String& domType, long changeCount, const String& pasteboardName);
285     static void addHTMLClipboardTypesForCocoaType(ListHashSet<String>& resultTypes, const String& cocoaType);
286     String readStringForPlatformType(const String&);
287     Vector<String> readTypesWithSecurityCheck();
288     RefPtr<SharedBuffer> readBufferForTypeWithSecurityCheck(const String&);
289 #endif
290
291 #if PLATFORM(GTK)
292     void writeToClipboard();
293     void readFromClipboard();
294     Ref<SelectionData> m_selectionData;
295     String m_name;
296 #endif
297
298 #if PLATFORM(COCOA)
299     String m_pasteboardName;
300     long m_changeCount;
301     std::optional<PasteboardCustomData> m_customDataCache;
302 #endif
303
304 #if PLATFORM(WIN)
305     HWND m_owner;
306     COMPtr<IDataObject> m_dataObject;
307     COMPtr<WCDataObject> m_writableDataObject;
308     DragDataMap m_dragDataMap;
309 #endif
310 };
311
312 #if PLATFORM(IOS)
313 extern NSString *WebArchivePboardType;
314 #endif
315
316 #if PLATFORM(MAC)
317 extern const char* const WebArchivePboardType;
318 extern const char* const WebURLNamePboardType;
319 #endif
320
321 #if !PLATFORM(GTK)
322
323 inline Pasteboard::~Pasteboard()
324 {
325 }
326
327 #endif
328
329 } // namespace WebCore