c48aa491952f3705c2b31d1a683db78685c8670b
[WebKit-https.git] / Source / WebCore / platform / mac / ClipboardMac.mm
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2008, 2010 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 COMPUTER, 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 COMPUTER, 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 #import "config.h"
27 #import "ClipboardMac.h"
28
29 #import "DOMElementInternal.h"
30 #import "DragClient.h"
31 #import "DragController.h"
32 #import "DragData.h"
33 #import "Editor.h"
34 #import "FileList.h"
35 #import "Frame.h"
36 #import "Image.h"
37 #import "Page.h"
38 #import "Pasteboard.h"
39 #import "PasteboardStrategy.h"
40 #import "PlatformStrategies.h"
41 #import "RenderImage.h"
42 #import "ScriptExecutionContext.h"
43 #import "SecurityOrigin.h"
44 #import "WebCoreSystemInterface.h"
45
46
47 namespace WebCore {
48
49 PassRefPtr<Clipboard> Clipboard::create(ClipboardAccessPolicy policy, DragData* dragData, Frame* frame)
50 {
51     return ClipboardMac::create(DragAndDrop, [dragData->pasteboard() name], policy, frame);
52 }
53
54 ClipboardMac::ClipboardMac(ClipboardType clipboardType, const String& pasteboardName, ClipboardAccessPolicy policy, Frame *frame)
55     : Clipboard(policy, clipboardType)
56     , m_pasteboardName(pasteboardName)
57     , m_frame(frame)
58 {
59     m_changeCount = platformStrategies()->pasteboardStrategy()->changeCount(m_pasteboardName);
60 }
61
62 ClipboardMac::~ClipboardMac()
63 {
64 }
65
66 bool ClipboardMac::hasData()
67 {
68     Vector<String> types;
69     platformStrategies()->pasteboardStrategy()->getTypes(types, m_pasteboardName);
70     return !types.isEmpty();
71 }
72     
73 static String cocoaTypeFromHTMLClipboardType(const String& type)
74 {
75     // http://www.whatwg.org/specs/web-apps/current-work/multipage/dnd.html#dom-datatransfer-setdata
76     String qType = type.lower();
77
78     if (qType == "text")
79         qType = "text/plain";
80     if (qType == "url")
81         qType = "text/uri-list";
82
83     // Ignore any trailing charset - JS strings are Unicode, which encapsulates the charset issue
84     if (qType == "text/plain" || qType.startsWith("text/plain;"))
85         return String(NSStringPboardType);
86     if (qType == "text/uri-list")
87         // special case because UTI doesn't work with Cocoa's URL type
88         return String(NSURLPboardType); // note special case in getData to read NSFilenamesType
89
90     // Try UTI now
91     String mimeType = qType;
92     RetainPtr<CFStringRef> utiType(AdoptCF, UTTypeCreatePreferredIdentifierForTag(kUTTagClassMIMEType, mimeType.createCFString(), NULL));
93     if (utiType) {
94         CFStringRef pbType = UTTypeCopyPreferredTagWithClass(utiType.get(), kUTTagClassNSPboardType);
95         if (pbType)
96             return pbType;
97     }
98
99     // No mapping, just pass the whole string though
100     return qType;
101 }
102
103 static String utiTypeFromCocoaType(const String& type)
104 {
105     RetainPtr<CFStringRef> utiType(AdoptCF, UTTypeCreatePreferredIdentifierForTag(kUTTagClassNSPboardType, type.createCFString(), NULL));
106     if (utiType) {
107         RetainPtr<CFStringRef> mimeType(AdoptCF, UTTypeCopyPreferredTagWithClass(utiType.get(), kUTTagClassMIMEType));
108         if (mimeType)
109             return String(mimeType.get());
110     }
111     return String();
112 }
113
114 static void addHTMLClipboardTypesForCocoaType(HashSet<String>& resultTypes, const String& cocoaType, const String& pasteboardName)
115 {
116     // UTI may not do these right, so make sure we get the right, predictable result
117     if (cocoaType == String(NSStringPboardType)) {
118         resultTypes.add("text/plain");
119         return;
120     }
121     if (cocoaType == String(NSURLPboardType)) {
122         resultTypes.add("text/uri-list");
123         return;
124     }
125     if (cocoaType == String(NSFilenamesPboardType)) {
126         // If file list is empty, add nothing.
127         // Note that there is a chance that the file list count could have changed since we grabbed the types array.
128         // However, this is not really an issue for us doing a sanity check here.
129         Vector<String> fileList;
130         platformStrategies()->pasteboardStrategy()->getPathnamesForType(fileList, String(NSFilenamesPboardType), pasteboardName);
131         if (!fileList.isEmpty()) {
132             // It is unknown if NSFilenamesPboardType always implies NSURLPboardType in Cocoa,
133             // but NSFilenamesPboardType should imply both 'text/uri-list' and 'Files'
134             resultTypes.add("text/uri-list");
135             resultTypes.add("Files");
136         }
137         return;
138     }
139     String utiType = utiTypeFromCocoaType(cocoaType);
140     if (!utiType.isEmpty()) {
141         resultTypes.add(utiType);
142         return;
143     }
144     // No mapping, just pass the whole string though
145     resultTypes.add(cocoaType);
146 }
147
148 void ClipboardMac::clearData(const String& type)
149 {
150     if (policy() != ClipboardWritable)
151         return;
152
153     // note NSPasteboard enforces changeCount itself on writing - can't write if not the owner
154
155     String cocoaType = cocoaTypeFromHTMLClipboardType(type);
156     if (!cocoaType.isEmpty())
157         platformStrategies()->pasteboardStrategy()->setStringForType("", cocoaType, m_pasteboardName);
158 }
159
160 void ClipboardMac::clearAllData()
161 {
162     if (policy() != ClipboardWritable)
163         return;
164
165     // note NSPasteboard enforces changeCount itself on writing - can't write if not the owner
166
167     Pasteboard pasteboard(m_pasteboardName);
168     pasteboard.clear();
169 }
170
171 static Vector<String> absoluteURLsFromPasteboardFilenames(const String& pasteboardName, bool onlyFirstURL = false)
172 {
173     Vector<String> fileList;
174     platformStrategies()->pasteboardStrategy()->getPathnamesForType(fileList, String(NSFilenamesPboardType), pasteboardName);
175
176     if (fileList.isEmpty())
177         return fileList;
178
179     size_t count = onlyFirstURL ? 1 : fileList.size();
180     Vector<String> urls;
181     for (size_t i = 0; i < count; i++) {
182         NSURL *url = [NSURL fileURLWithPath:fileList[i]];
183         urls.append(String([url absoluteString]));
184     }
185     return urls;
186 }
187
188 static Vector<String> absoluteURLsFromPasteboard(const String& pasteboardName, bool onlyFirstURL = false)
189 {
190     // NOTE: We must always check [availableTypes containsObject:] before accessing pasteboard data
191     // or CoreFoundation will printf when there is not data of the corresponding type.
192     Vector<String> availableTypes;
193     Vector<String> absoluteURLs;
194     platformStrategies()->pasteboardStrategy()->getTypes(availableTypes, pasteboardName);
195
196     // Try NSFilenamesPboardType because it contains a list
197     if (availableTypes.contains(String(NSFilenamesPboardType))) {
198         absoluteURLs = absoluteURLsFromPasteboardFilenames(pasteboardName, onlyFirstURL);
199         if (!absoluteURLs.isEmpty())
200             return absoluteURLs;
201     }
202
203     // Fallback to NSURLPboardType (which is a single URL)
204     if (availableTypes.contains(String(NSURLPboardType))) {
205         platformStrategies()->pasteboardStrategy()->getPathnamesForType(absoluteURLs, String(NSURLPboardType), pasteboardName);
206         if (!absoluteURLs.isEmpty())
207             return absoluteURLs;
208     }
209
210     // No file paths on the pasteboard, return nil
211     return Vector<String>();
212 }
213
214 String ClipboardMac::getData(const String& type, bool& success) const
215 {
216     success = false;
217     if (policy() != ClipboardReadable)
218         return String();
219
220     const String& cocoaType = cocoaTypeFromHTMLClipboardType(type);
221     String cocoaValue;
222
223     // Grab the value off the pasteboard corresponding to the cocoaType
224     if (cocoaType == String(NSURLPboardType)) {
225         // "url" and "text/url-list" both map to NSURLPboardType in cocoaTypeFromHTMLClipboardType(), "url" only wants the first URL
226         bool onlyFirstURL = (equalIgnoringCase(type, "url"));
227         Vector<String> absoluteURLs = absoluteURLsFromPasteboard(m_pasteboardName, onlyFirstURL);
228         for (size_t i = 0; i < absoluteURLs.size(); i++)
229             cocoaValue = i ? "\n" + absoluteURLs[i]: absoluteURLs[i];
230     } else if (cocoaType == String(NSStringPboardType))
231         cocoaValue = [platformStrategies()->pasteboardStrategy()->stringForType(cocoaType, m_pasteboardName) precomposedStringWithCanonicalMapping];
232     else if (!cocoaType.isEmpty())
233         cocoaValue = platformStrategies()->pasteboardStrategy()->stringForType(cocoaType, m_pasteboardName);
234
235     // Enforce changeCount ourselves for security.  We check after reading instead of before to be
236     // sure it doesn't change between our testing the change count and accessing the data.
237     if (!cocoaValue.isEmpty() && m_changeCount == platformStrategies()->pasteboardStrategy()->changeCount(m_pasteboardName)) {
238         success = true;
239         return cocoaValue;
240     }
241
242     return String();
243 }
244
245 bool ClipboardMac::setData(const String &type, const String &data)
246 {
247     if (policy() != ClipboardWritable)
248         return false;
249     // note NSPasteboard enforces changeCount itself on writing - can't write if not the owner
250
251     const String& cocoaType = cocoaTypeFromHTMLClipboardType(type);
252     String cocoaData = data;
253
254     if (cocoaType == String(NSURLPboardType)) {
255         Vector<String> types;
256         types.append(String(NSURLPboardType));
257
258         platformStrategies()->pasteboardStrategy()->setTypes(types, m_pasteboardName);
259         platformStrategies()->pasteboardStrategy()->setStringForType(cocoaData, String(NSURLPboardType), m_pasteboardName);
260         NSURL *url = [[NSURL alloc] initWithString:cocoaData];
261
262         if ([url isFileURL] && m_frame->document()->securityOrigin()->canLoadLocalResources()) {
263             types.append(String(NSFilenamesPboardType));
264             platformStrategies()->pasteboardStrategy()->setTypes(types, m_pasteboardName);
265             Vector<String> fileList;
266             fileList.append(String([url path]));
267             platformStrategies()->pasteboardStrategy()->setPathnamesForType(fileList, String(NSFilenamesPboardType), m_pasteboardName);
268         }
269
270         [url release];
271         return true;
272     }
273
274     if (!cocoaType.isEmpty()) {
275         // everything else we know of goes on the pboard as a string
276         Vector<String> types;
277         types.append(cocoaType);
278         platformStrategies()->pasteboardStrategy()->setTypes(types, m_pasteboardName);
279         platformStrategies()->pasteboardStrategy()->setStringForType(cocoaData, cocoaType, m_pasteboardName);
280         return true;
281     }
282
283     return false;
284 }
285
286 HashSet<String> ClipboardMac::types() const
287 {
288     if (policy() != ClipboardReadable && policy() != ClipboardTypesReadable)
289         return HashSet<String>();
290
291     Vector<String> types;
292     platformStrategies()->pasteboardStrategy()->getTypes(types, m_pasteboardName);
293
294     // Enforce changeCount ourselves for security.  We check after reading instead of before to be
295     // sure it doesn't change between our testing the change count and accessing the data.
296     if (m_changeCount != platformStrategies()->pasteboardStrategy()->changeCount(m_pasteboardName))
297         return HashSet<String>();
298
299     HashSet<String> result;
300     // FIXME: This loop could be split into two stages. One which adds all the HTML5 specified types
301     // and a second which adds all the extra types from the cocoa clipboard (which is Mac-only behavior).
302     for (size_t i = 0; i < types.size(); i++) {
303         if (types[i] == "NeXT plain ascii pasteboard type")
304             continue;   // skip this ancient type that gets auto-supplied by some system conversion
305
306         addHTMLClipboardTypesForCocoaType(result, types[i], m_pasteboardName);
307     }
308
309     return result;
310 }
311
312 // FIXME: We could cache the computed fileList if necessary
313 // Currently each access gets a new copy, setData() modifications to the
314 // clipboard are not reflected in any FileList objects the page has accessed and stored
315 PassRefPtr<FileList> ClipboardMac::files() const
316 {
317     if (policy() != ClipboardReadable)
318         return FileList::create();
319
320     Vector<String> absoluteURLs = absoluteURLsFromPasteboardFilenames(m_pasteboardName);
321
322     RefPtr<FileList> fileList = FileList::create();
323     for (size_t i = 0; i < absoluteURLs.size(); i++) {
324         NSURL *absoluteURL = [NSURL URLWithString:absoluteURLs[i]];
325         ASSERT([absoluteURL isFileURL]);
326         fileList->append(File::create([absoluteURL path]));
327     }
328     return fileList.release(); // We will always return a FileList, sometimes empty
329 }
330
331 // The rest of these getters don't really have any impact on security, so for now make no checks
332
333 void ClipboardMac::setDragImage(CachedImage* img, const IntPoint &loc)
334 {
335     setDragImage(img, 0, loc);
336 }
337
338 void ClipboardMac::setDragImageElement(Node *node, const IntPoint &loc)
339 {
340     setDragImage(0, node, loc);
341 }
342
343 void ClipboardMac::setDragImage(CachedImage* image, Node *node, const IntPoint &loc)
344 {
345     if (policy() == ClipboardImageWritable || policy() == ClipboardWritable) {
346         if (m_dragImage)
347             m_dragImage->removeClient(this);
348         m_dragImage = image;
349         if (m_dragImage)
350             m_dragImage->addClient(this);
351
352         m_dragLoc = loc;
353         m_dragImageElement = node;
354         
355         if (dragStarted() && m_changeCount == platformStrategies()->pasteboardStrategy()->changeCount(m_pasteboardName)) {
356             NSPoint cocoaLoc;
357             NSImage* cocoaImage = dragNSImage(cocoaLoc);
358             if (cocoaImage) {
359                 // Dashboard wants to be able to set the drag image during dragging, but Cocoa does not allow this.
360                 // Instead we must drop down to the CoreGraphics API.
361                 wkSetDragImage(cocoaImage, cocoaLoc);
362
363                 // Hack: We must post an event to wake up the NSDragManager, which is sitting in a nextEvent call
364                 // up the stack from us because the CoreFoundation drag manager does not use the run loop by itself.
365                 // This is the most innocuous event to use, per Kristen Forster.
366                 NSEvent* ev = [NSEvent mouseEventWithType:NSMouseMoved location:NSZeroPoint
367                     modifierFlags:0 timestamp:0 windowNumber:0 context:nil eventNumber:0 clickCount:0 pressure:0];
368                 [NSApp postEvent:ev atStart:YES];
369             }
370         }
371         // Else either 1) we haven't started dragging yet, so we rely on the part to install this drag image
372         // as part of getting the drag kicked off, or 2) Someone kept a ref to the clipboard and is trying to
373         // set the image way too late.
374     }
375 }
376     
377 void ClipboardMac::writeRange(Range* range, Frame* frame)
378 {
379     ASSERT(range);
380     ASSERT(frame);
381     Pasteboard pasteboard(m_pasteboardName);
382     pasteboard.writeSelection(range, frame->editor()->smartInsertDeleteEnabled() && frame->selection()->granularity() == WordGranularity, frame);
383 }
384
385 void ClipboardMac::writePlainText(const String& text)
386 {
387     Pasteboard pasteboard(m_pasteboardName);
388     pasteboard.writePlainText(text);
389 }
390
391 void ClipboardMac::writeURL(const KURL& url, const String& title, Frame* frame)
392 {   
393     ASSERT(frame);
394     ASSERT(m_pasteboardName);
395     Pasteboard pasteboard(m_pasteboardName);
396     pasteboard.writeURL(url, title, frame);
397 }
398     
399 #if ENABLE(DRAG_SUPPORT)
400 void ClipboardMac::declareAndWriteDragImage(Element* element, const KURL& url, const String& title, Frame* frame)
401 {
402     ASSERT(frame);
403     if (Page* page = frame->page())
404         page->dragController()->client()->declareAndWriteDragImage(m_pasteboardName, kit(element), url, title, frame);
405 }
406 #endif // ENABLE(DRAG_SUPPORT)
407     
408 DragImageRef ClipboardMac::createDragImage(IntPoint& loc) const
409 {
410     NSPoint nsloc = {loc.x(), loc.y()};
411     DragImageRef result = dragNSImage(nsloc);
412     loc = (IntPoint)nsloc;
413     return result;
414 }
415     
416 NSImage *ClipboardMac::dragNSImage(NSPoint& loc) const
417 {
418     NSImage *result = nil;
419     if (m_dragImageElement) {
420         if (m_frame) {
421             NSRect imageRect;
422             NSRect elementRect;
423             result = m_frame->snapshotDragImage(m_dragImageElement.get(), &imageRect, &elementRect);
424             // Client specifies point relative to element, not the whole image, which may include child
425             // layers spread out all over the place.
426             loc.x = elementRect.origin.x - imageRect.origin.x + m_dragLoc.x();
427             loc.y = elementRect.origin.y - imageRect.origin.y + m_dragLoc.y();
428             loc.y = imageRect.size.height - loc.y;
429         }
430     } else if (m_dragImage) {
431         result = m_dragImage->image()->getNSImage();
432         
433         loc = m_dragLoc;
434         loc.y = [result size].height - loc.y;
435     }
436     return result;
437 }
438
439 }