[Attachment Support] Create attachment elements when dropping files on iOS
[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 "PasteboardItemInfo.h"
30 #include "URL.h"
31 #include <wtf/HashMap.h>
32 #include <wtf/ListHashSet.h>
33 #include <wtf/Noncopyable.h>
34 #include <wtf/Vector.h>
35 #include <wtf/text/WTFString.h>
36
37 #if PLATFORM(IOS)
38 OBJC_CLASS NSString;
39 #endif
40
41 #if PLATFORM(COCOA)
42 OBJC_CLASS NSArray;
43 #endif
44
45 #if PLATFORM(WIN)
46 #include "COMPtr.h"
47 #include "WCDataObject.h"
48 #include <objidl.h>
49 #include <windows.h>
50 typedef struct HWND__* HWND;
51 #endif
52
53 // FIXME: This class uses the DOM and makes calls to Editor.
54 // It should be divested of its knowledge of the frame and editor.
55
56 namespace WebCore {
57
58 class DocumentFragment;
59 class DragData;
60 class Element;
61 class Frame;
62 class PasteboardStrategy;
63 class Range;
64 class SelectionData;
65 class SharedBuffer;
66
67 enum ShouldSerializeSelectedTextForDataTransfer { DefaultSelectedTextType, IncludeImageAltTextForDataTransfer };
68
69 // For writing to the pasteboard. Generally sorted with the richest formats on top.
70
71 struct PasteboardWebContent {
72 #if PLATFORM(COCOA)
73     WEBCORE_EXPORT PasteboardWebContent();
74     WEBCORE_EXPORT ~PasteboardWebContent();
75     String contentOrigin;
76     bool canSmartCopyOrDelete;
77     RefPtr<SharedBuffer> dataInWebArchiveFormat;
78     RefPtr<SharedBuffer> dataInRTFDFormat;
79     RefPtr<SharedBuffer> dataInRTFFormat;
80     RefPtr<SharedBuffer> dataInAttributedStringFormat;
81     String dataInHTMLFormat;
82     String dataInStringFormat;
83     Vector<String> clientTypes;
84     Vector<RefPtr<SharedBuffer>> clientData;
85 #endif
86 #if PLATFORM(GTK)
87     bool canSmartCopyOrDelete;
88     String text;
89     String markup;
90 #endif
91 #if PLATFORM(WPE)
92     String text;
93     String markup;
94 #endif
95 };
96
97 struct PasteboardURL {
98     URL url;
99     String title;
100 #if PLATFORM(MAC)
101     String userVisibleForm;
102 #endif
103 #if PLATFORM(GTK)
104     String markup;
105 #endif
106 };
107
108 struct PasteboardImage {
109     WEBCORE_EXPORT PasteboardImage();
110     WEBCORE_EXPORT ~PasteboardImage();
111     RefPtr<Image> image;
112 #if PLATFORM(MAC)
113     RefPtr<SharedBuffer> dataInWebArchiveFormat;
114 #endif
115 #if !PLATFORM(WIN)
116     PasteboardURL url;
117 #endif
118 #if !(PLATFORM(GTK) || PLATFORM(WIN))
119     RefPtr<SharedBuffer> resourceData;
120     String resourceMIMEType;
121     Vector<String> clientTypes;
122     Vector<RefPtr<SharedBuffer>> clientData;
123 #endif
124     String suggestedName;
125     FloatSize imageSize;
126 };
127
128 // For reading from the pasteboard.
129
130 class PasteboardWebContentReader {
131 public:
132     String contentOrigin;
133
134     virtual ~PasteboardWebContentReader() = default;
135
136 #if PLATFORM(COCOA)
137     virtual bool readWebArchive(SharedBuffer&) = 0;
138     virtual bool readFilePaths(const Vector<String>&) = 0;
139     virtual bool readHTML(const String&) = 0;
140     virtual bool readRTFD(SharedBuffer&) = 0;
141     virtual bool readRTF(SharedBuffer&) = 0;
142     virtual bool readImage(Ref<SharedBuffer>&&, const String& type) = 0;
143     virtual bool readURL(const URL&, const String& title) = 0;
144 #endif
145     virtual bool readPlainText(const String&) = 0;
146 };
147
148 struct PasteboardPlainText {
149     String text;
150 #if PLATFORM(COCOA)
151     bool isURL;
152 #endif
153 };
154
155 struct PasteboardFileReader {
156     virtual ~PasteboardFileReader() = default;
157     virtual void readFilename(const String&) = 0;
158     virtual void readBuffer(const String& filename, const String& type, Ref<SharedBuffer>&&) = 0;
159 };
160
161 // FIXME: We need to ensure that the contents of sameOriginCustomData are not accessible across different origins.
162 struct PasteboardCustomData {
163     String origin;
164     Vector<String> orderedTypes;
165     HashMap<String, String> platformData;
166     HashMap<String, String> sameOriginCustomData;
167
168     WEBCORE_EXPORT Ref<SharedBuffer> createSharedBuffer() const;
169     WEBCORE_EXPORT static PasteboardCustomData fromSharedBuffer(const SharedBuffer&);
170
171 #if PLATFORM(COCOA)
172     static const char* cocoaType();
173 #endif
174 };
175
176 class Pasteboard {
177     WTF_MAKE_NONCOPYABLE(Pasteboard); WTF_MAKE_FAST_ALLOCATED;
178 public:
179     Pasteboard();
180     virtual ~Pasteboard();
181
182 #if PLATFORM(GTK)
183     explicit Pasteboard(const String& name);
184     explicit Pasteboard(SelectionData&);
185 #endif
186
187 #if PLATFORM(WIN)
188     explicit Pasteboard(IDataObject*);
189     explicit Pasteboard(WCDataObject*);
190     explicit Pasteboard(const DragDataMap&);
191 #endif
192
193     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForCopyAndPaste();
194
195     static bool isSafeTypeForDOMToReadAndWrite(const String&);
196     static bool canExposeURLToDOMWhenPasteboardContainsFiles(const String&);
197
198     virtual bool isStatic() const { return false; }
199
200     virtual bool hasData();
201     virtual Vector<String> typesSafeForBindings(const String& origin);
202     virtual Vector<String> typesForLegacyUnsafeBindings();
203     virtual String readOrigin();
204     virtual String readString(const String& type);
205     virtual String readStringInCustomData(const String& type);
206
207     virtual void writeString(const String& type, const String& data);
208     virtual void clear();
209     virtual void clear(const String& type);
210
211     virtual void read(PasteboardPlainText&);
212     virtual void read(PasteboardWebContentReader&);
213     virtual void read(PasteboardFileReader&);
214
215     virtual void write(const PasteboardURL&);
216     virtual void writeTrustworthyWebURLsPboardType(const PasteboardURL&);
217     virtual void write(const PasteboardImage&);
218     virtual void write(const PasteboardWebContent&);
219
220     virtual void writeCustomData(const PasteboardCustomData&);
221
222     virtual bool containsFiles();
223     virtual bool canSmartReplace();
224
225     virtual void writeMarkup(const String& markup);
226     enum SmartReplaceOption { CanSmartReplace, CannotSmartReplace };
227     virtual WEBCORE_EXPORT void writePlainText(const String&, SmartReplaceOption); // FIXME: Two separate functions would be clearer than one function with an argument.
228
229 #if ENABLE(DRAG_SUPPORT)
230     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForDragAndDrop();
231     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForDragAndDrop(const DragData&);
232
233     virtual void setDragImage(DragImage, const IntPoint& hotSpot);
234 #endif
235
236 #if PLATFORM(WIN)
237     RefPtr<DocumentFragment> documentFragment(Frame&, Range&, bool allowPlainText, bool& chosePlainText); // FIXME: Layering violation.
238     void writeImage(Element&, const URL&, const String& title); // FIXME: Layering violation.
239     void writeSelection(Range&, bool canSmartCopyOrDelete, Frame&, ShouldSerializeSelectedTextForDataTransfer = DefaultSelectedTextType); // FIXME: Layering violation.
240 #endif
241
242 #if PLATFORM(GTK)
243     const SelectionData& selectionData() const;
244     static std::unique_ptr<Pasteboard> createForGlobalSelection();
245 #endif
246
247 #if PLATFORM(IOS)
248     explicit Pasteboard(long changeCount);
249
250     static NSArray *supportedWebContentPasteboardTypes();
251     static String resourceMIMEType(NSString *mimeType);
252 #endif
253
254 #if PLATFORM(COCOA)
255     explicit Pasteboard(const String& pasteboardName);
256
257     static bool shouldTreatCocoaTypeAsFile(const String&);
258     WEBCORE_EXPORT static NSArray *supportedFileUploadPasteboardTypes();
259     const String& name() const { return m_pasteboardName; }
260     long changeCount() const;
261     const PasteboardCustomData& readCustomData();
262 #endif
263
264 #if PLATFORM(WIN)
265     COMPtr<IDataObject> dataObject() const { return m_dataObject; }
266     void setExternalDataObject(IDataObject*);
267     const DragDataMap& dragDataMap() const { return m_dragDataMap; }
268     void writeURLToWritableDataObject(const URL&, const String&);
269     COMPtr<WCDataObject> writableDataObject() const { return m_writableDataObject; }
270     void writeImageToDataObject(Element&, const URL&); // FIXME: Layering violation.
271 #endif
272
273 private:
274 #if PLATFORM(IOS)
275     bool respectsUTIFidelities() const;
276     void readRespectingUTIFidelities(PasteboardWebContentReader&);
277
278     enum class ReaderResult {
279         ReadType,
280         DidNotReadType,
281         PasteboardWasChangedExternally
282     };
283     ReaderResult readPasteboardWebContentDataForType(PasteboardWebContentReader&, PasteboardStrategy&, NSString *type, int itemIndex);
284 #endif
285
286 #if PLATFORM(WIN)
287     void finishCreatingPasteboard();
288     void writeRangeToDataObject(Range&, Frame&); // FIXME: Layering violation.
289     void writeURLToDataObject(const URL&, const String&);
290     void writePlainTextToDataObject(const String&, SmartReplaceOption);
291 #endif
292
293 #if PLATFORM(COCOA)
294     Vector<String> readFilePaths();
295     String readPlatformValueAsString(const String& domType, long changeCount, const String& pasteboardName);
296     static void addHTMLClipboardTypesForCocoaType(ListHashSet<String>& resultTypes, const String& cocoaType);
297     String readStringForPlatformType(const String&);
298     Vector<String> readTypesWithSecurityCheck();
299     RefPtr<SharedBuffer> readBufferForTypeWithSecurityCheck(const String&);
300 #endif
301
302 #if PLATFORM(GTK)
303     void writeToClipboard();
304     void readFromClipboard();
305     Ref<SelectionData> m_selectionData;
306     String m_name;
307 #endif
308
309 #if PLATFORM(COCOA)
310     String m_pasteboardName;
311     long m_changeCount;
312     std::optional<PasteboardCustomData> m_customDataCache;
313 #endif
314
315 #if PLATFORM(WIN)
316     HWND m_owner;
317     COMPtr<IDataObject> m_dataObject;
318     COMPtr<WCDataObject> m_writableDataObject;
319     DragDataMap m_dragDataMap;
320 #endif
321 };
322
323 #if PLATFORM(IOS)
324 extern NSString *WebArchivePboardType;
325 #endif
326
327 #if PLATFORM(MAC)
328 extern const char* const WebArchivePboardType;
329 extern const char* const WebURLNamePboardType;
330 #endif
331
332 #if !PLATFORM(GTK)
333
334 inline Pasteboard::~Pasteboard()
335 {
336 }
337
338 #endif
339
340 } // namespace WebCore