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