REGRESSION(r122215) - CachedImage::likelyToBeUsedSoon crashes on accessing a deleted...
[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 "CachedImageClient.h"
30 #import "DOMElementInternal.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 #if ENABLE(DRAG_SUPPORT)
51 PassRefPtr<Clipboard> Clipboard::create(ClipboardAccessPolicy policy, DragData* dragData, Frame* frame)
52 {
53     return ClipboardMac::create(DragAndDrop, dragData->pasteboardName(), policy, dragData->containsFiles() ? ClipboardMac::DragAndDropFiles : ClipboardMac::DragAndDropData, frame);
54 }
55 #endif
56
57 ClipboardMac::ClipboardMac(ClipboardType clipboardType, const String& pasteboardName, ClipboardAccessPolicy policy, ClipboardContents clipboardContents, Frame *frame)
58     : Clipboard(policy, clipboardType)
59     , m_pasteboardName(pasteboardName)
60     , m_clipboardContents(clipboardContents)
61     , m_frame(frame)
62 {
63     m_changeCount = platformStrategies()->pasteboardStrategy()->changeCount(m_pasteboardName);
64 }
65
66 ClipboardMac::~ClipboardMac()
67 {
68     if (m_dragImage)
69         m_dragImage->removeClient(this);
70 }
71
72 bool ClipboardMac::hasData()
73 {
74     Vector<String> types;
75     platformStrategies()->pasteboardStrategy()->getTypes(types, m_pasteboardName);
76     return !types.isEmpty();
77 }
78     
79 static String cocoaTypeFromHTMLClipboardType(const String& type)
80 {
81     // http://www.whatwg.org/specs/web-apps/current-work/multipage/dnd.html#dom-datatransfer-setdata
82     String qType = type.lower();
83
84     if (qType == "text")
85         qType = "text/plain";
86     if (qType == "url")
87         qType = "text/uri-list";
88
89     // Ignore any trailing charset - JS strings are Unicode, which encapsulates the charset issue
90     if (qType == "text/plain" || qType.startsWith("text/plain;"))
91         return String(NSStringPboardType);
92     if (qType == "text/uri-list")
93         // special case because UTI doesn't work with Cocoa's URL type
94         return String(NSURLPboardType); // note special case in getData to read NSFilenamesType
95
96     // Blacklist types that might contain subframe information
97     if (qType == "text/rtf" || qType == "public.rtf" || qType == "com.apple.traditional-mac-plain-text")
98         return String();
99
100     // Try UTI now
101     String mimeType = qType;
102     RetainPtr<CFStringRef> utiType(AdoptCF, UTTypeCreatePreferredIdentifierForTag(kUTTagClassMIMEType, mimeType.createCFString(), NULL));
103     if (utiType) {
104         CFStringRef pbType = UTTypeCopyPreferredTagWithClass(utiType.get(), kUTTagClassNSPboardType);
105         if (pbType)
106             return pbType;
107     }
108
109     // No mapping, just pass the whole string though
110     return qType;
111 }
112
113 static String utiTypeFromCocoaType(const String& type)
114 {
115     RetainPtr<CFStringRef> typeCF = adoptCF(type.createCFString());
116     RetainPtr<CFStringRef> utiType(AdoptCF, UTTypeCreatePreferredIdentifierForTag(kUTTagClassNSPboardType, typeCF.get(), 0));
117     if (utiType) {
118         RetainPtr<CFStringRef> mimeType(AdoptCF, UTTypeCopyPreferredTagWithClass(utiType.get(), kUTTagClassMIMEType));
119         if (mimeType)
120             return String(mimeType.get());
121     }
122     return String();
123 }
124
125 static void addHTMLClipboardTypesForCocoaType(HashSet<String>& resultTypes, const String& cocoaType, const String& pasteboardName)
126 {
127     // UTI may not do these right, so make sure we get the right, predictable result
128     if (cocoaType == String(NSStringPboardType)) {
129         resultTypes.add("text/plain");
130         return;
131     }
132     if (cocoaType == String(NSURLPboardType)) {
133         resultTypes.add("text/uri-list");
134         return;
135     }
136     if (cocoaType == String(NSFilenamesPboardType)) {
137         // If file list is empty, add nothing.
138         // Note that there is a chance that the file list count could have changed since we grabbed the types array.
139         // However, this is not really an issue for us doing a sanity check here.
140         Vector<String> fileList;
141         platformStrategies()->pasteboardStrategy()->getPathnamesForType(fileList, String(NSFilenamesPboardType), pasteboardName);
142         if (!fileList.isEmpty()) {
143             // It is unknown if NSFilenamesPboardType always implies NSURLPboardType in Cocoa,
144             // but NSFilenamesPboardType should imply both 'text/uri-list' and 'Files'
145             resultTypes.add("text/uri-list");
146             resultTypes.add("Files");
147         }
148         return;
149     }
150     String utiType = utiTypeFromCocoaType(cocoaType);
151     if (!utiType.isEmpty()) {
152         resultTypes.add(utiType);
153         return;
154     }
155     // No mapping, just pass the whole string though
156     resultTypes.add(cocoaType);
157 }
158
159 void ClipboardMac::clearData(const String& type)
160 {
161     if (policy() != ClipboardWritable)
162         return;
163
164     // note NSPasteboard enforces changeCount itself on writing - can't write if not the owner
165
166     String cocoaType = cocoaTypeFromHTMLClipboardType(type);
167     if (!cocoaType.isEmpty())
168         platformStrategies()->pasteboardStrategy()->setStringForType("", cocoaType, m_pasteboardName);
169 }
170
171 void ClipboardMac::clearAllData()
172 {
173     if (policy() != ClipboardWritable)
174         return;
175
176     // note NSPasteboard enforces changeCount itself on writing - can't write if not the owner
177
178     Pasteboard pasteboard(m_pasteboardName);
179     pasteboard.clear();
180 }
181
182 static Vector<String> absoluteURLsFromPasteboardFilenames(const String& pasteboardName, bool onlyFirstURL = false)
183 {
184     Vector<String> fileList;
185     platformStrategies()->pasteboardStrategy()->getPathnamesForType(fileList, String(NSFilenamesPboardType), pasteboardName);
186
187     if (fileList.isEmpty())
188         return fileList;
189
190     size_t count = onlyFirstURL ? 1 : fileList.size();
191     Vector<String> urls;
192     for (size_t i = 0; i < count; i++) {
193         NSURL *url = [NSURL fileURLWithPath:fileList[i]];
194         urls.append(String([url absoluteString]));
195     }
196     return urls;
197 }
198
199 static Vector<String> absoluteURLsFromPasteboard(const String& pasteboardName, bool onlyFirstURL = false)
200 {
201     // NOTE: We must always check [availableTypes containsObject:] before accessing pasteboard data
202     // or CoreFoundation will printf when there is not data of the corresponding type.
203     Vector<String> availableTypes;
204     Vector<String> absoluteURLs;
205     platformStrategies()->pasteboardStrategy()->getTypes(availableTypes, pasteboardName);
206
207     // Try NSFilenamesPboardType because it contains a list
208     if (availableTypes.contains(String(NSFilenamesPboardType))) {
209         absoluteURLs = absoluteURLsFromPasteboardFilenames(pasteboardName, onlyFirstURL);
210         if (!absoluteURLs.isEmpty())
211             return absoluteURLs;
212     }
213
214     // Fallback to NSURLPboardType (which is a single URL)
215     if (availableTypes.contains(String(NSURLPboardType))) {
216         absoluteURLs.append(platformStrategies()->pasteboardStrategy()->stringForType(String(NSURLPboardType), pasteboardName));
217         return absoluteURLs;
218     }
219
220     // No file paths on the pasteboard, return nil
221     return Vector<String>();
222 }
223
224 String ClipboardMac::getData(const String& type) const
225 {
226     if (policy() != ClipboardReadable || m_clipboardContents == DragAndDropFiles)
227         return String();
228
229     const String& cocoaType = cocoaTypeFromHTMLClipboardType(type);
230     String cocoaValue;
231
232     // Grab the value off the pasteboard corresponding to the cocoaType
233     if (cocoaType == String(NSURLPboardType)) {
234         // "url" and "text/url-list" both map to NSURLPboardType in cocoaTypeFromHTMLClipboardType(), "url" only wants the first URL
235         bool onlyFirstURL = (equalIgnoringCase(type, "url"));
236         Vector<String> absoluteURLs = absoluteURLsFromPasteboard(m_pasteboardName, onlyFirstURL);
237         for (size_t i = 0; i < absoluteURLs.size(); i++)
238             cocoaValue = i ? "\n" + absoluteURLs[i]: absoluteURLs[i];
239     } else if (cocoaType == String(NSStringPboardType))
240         cocoaValue = [platformStrategies()->pasteboardStrategy()->stringForType(cocoaType, m_pasteboardName) precomposedStringWithCanonicalMapping];
241     else if (!cocoaType.isEmpty())
242         cocoaValue = platformStrategies()->pasteboardStrategy()->stringForType(cocoaType, m_pasteboardName);
243
244     // Enforce changeCount ourselves for security.  We check after reading instead of before to be
245     // sure it doesn't change between our testing the change count and accessing the data.
246     if (!cocoaValue.isEmpty() && m_changeCount == platformStrategies()->pasteboardStrategy()->changeCount(m_pasteboardName)) {
247         return cocoaValue;
248     }
249
250     return String();
251 }
252
253 bool ClipboardMac::setData(const String &type, const String &data)
254 {
255     if (policy() != ClipboardWritable || m_clipboardContents == DragAndDropFiles)
256         return false;
257     // note NSPasteboard enforces changeCount itself on writing - can't write if not the owner
258
259     const String& cocoaType = cocoaTypeFromHTMLClipboardType(type);
260     String cocoaData = data;
261
262     if (cocoaType == String(NSURLPboardType) || cocoaType == String(kUTTypeFileURL)) {
263         NSURL *url = [NSURL URLWithString:cocoaData];
264         if ([url isFileURL])
265             return false;
266
267         Vector<String> types;
268         types.append(cocoaType);
269         platformStrategies()->pasteboardStrategy()->setTypes(types, m_pasteboardName);
270         platformStrategies()->pasteboardStrategy()->setStringForType(cocoaData, cocoaType, m_pasteboardName);
271
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()->addTypes(types, m_pasteboardName);
280         platformStrategies()->pasteboardStrategy()->setStringForType(cocoaData, cocoaType, m_pasteboardName);
281         return true;
282     }
283
284     return false;
285 }
286
287 HashSet<String> ClipboardMac::types() const
288 {
289     if (policy() != ClipboardReadable && policy() != ClipboardTypesReadable)
290         return HashSet<String>();
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 HashSet<String>();
299
300     HashSet<String> result;
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, types[i], m_pasteboardName);
308     }
309
310     return result;
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 || m_clipboardContents == DragAndDropData)
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], File::AllContentTypes));
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, Pasteboard::CannotSmartReplace);
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 }