f3827363bfd9fd347685325c1a4bfa1d365c9f4a
[WebKit-https.git] / Source / WebKit / mac / Misc / WebNSPasteboardExtras.mm
1 /*
2  * Copyright (C) 2005, 2006, 2007 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #if !PLATFORM(IOS)
30
31 #import "WebNSPasteboardExtras.h"
32
33 #import "DOMElementInternal.h"
34 #import "WebArchive.h"
35 #import "WebFrameInternal.h"
36 #import "WebHTMLViewInternal.h"
37 #import "WebNSURLExtras.h"
38 #import "WebResourcePrivate.h"
39 #import "WebURLsWithTitles.h"
40 #import "WebViewPrivate.h"
41 #import <WebCore/CachedImage.h>
42 #import <WebCore/Element.h>
43 #import <WebCore/Image.h>
44 #import <WebCore/MIMETypeRegistry.h>
45 #import <WebCore/RenderAttachment.h>
46 #import <WebCore/RenderImage.h>
47 #import <WebKitLegacy/DOMExtensions.h>
48 #import <WebKitLegacy/DOMPrivate.h>
49 #import <WebKitSystemInterface.h>
50 #import <wtf/Assertions.h>
51 #import <wtf/RetainPtr.h>
52 #import <wtf/StdLibExtras.h>
53
54 using namespace WebCore;
55
56 NSString *WebURLPboardType = @"public.url";
57 NSString *WebURLNamePboardType = @"public.url-name";
58
59 @implementation NSPasteboard (WebExtras)
60
61 + (NSArray *)_web_writableTypesForURL
62 {
63     static NSArray *types = [[NSArray alloc] initWithObjects:
64         WebURLsWithTitlesPboardType,
65         NSURLPboardType,
66         WebURLPboardType,
67         WebURLNamePboardType,
68         NSStringPboardType,
69         nil];
70     return types;
71 }
72
73 static inline NSArray *_createWritableTypesForImageWithoutArchive()
74 {
75     NSMutableArray *types = [[NSMutableArray alloc] initWithObjects:NSTIFFPboardType, nil];
76     [types addObjectsFromArray:[NSPasteboard _web_writableTypesForURL]];
77     return types;
78 }
79
80 static NSArray *_writableTypesForImageWithoutArchive (void)
81 {
82     static NSArray *types = _createWritableTypesForImageWithoutArchive();
83     return types;
84 }
85
86 static inline NSArray *_createWritableTypesForImageWithArchive()
87 {
88     NSMutableArray *types = [_writableTypesForImageWithoutArchive() mutableCopy];
89     [types addObject:NSRTFDPboardType];
90     [types addObject:WebArchivePboardType];
91     return types;
92 }
93
94 static NSArray *_writableTypesForImageWithArchive (void)
95 {
96     static NSArray *types = _createWritableTypesForImageWithArchive();
97     return types;
98 }
99
100 + (NSArray *)_web_writableTypesForImageIncludingArchive:(BOOL)hasArchive
101 {
102     return hasArchive 
103         ? _writableTypesForImageWithArchive()
104         : _writableTypesForImageWithoutArchive();
105 }
106
107 + (NSArray *)_web_dragTypesForURL
108 {
109     return [NSArray arrayWithObjects:
110         WebURLsWithTitlesPboardType,
111         NSURLPboardType,
112         WebURLPboardType,
113         WebURLNamePboardType,
114         NSStringPboardType,
115         NSFilenamesPboardType,
116         nil];
117 }
118
119 - (NSURL *)_web_bestURL
120 {
121     NSArray *types = [self types];
122
123     if ([types containsObject:NSURLPboardType]) {
124         NSURL *URLFromPasteboard = [NSURL URLFromPasteboard:self];
125         NSString *scheme = [URLFromPasteboard scheme];
126         if ([scheme isEqualToString:@"http"] || [scheme isEqualToString:@"https"]) {
127             return [URLFromPasteboard _webkit_canonicalize];
128         }
129     }
130
131     if ([types containsObject:NSStringPboardType]) {
132         NSString *URLString = [self stringForType:NSStringPboardType];
133         if ([URLString _webkit_looksLikeAbsoluteURL]) {
134             NSURL *URL = [[NSURL _webkit_URLWithUserTypedString:URLString] _webkit_canonicalize];
135             if (URL) {
136                 return URL;
137             }
138         }
139     }
140
141     if ([types containsObject:NSFilenamesPboardType]) {
142         NSArray *files = [self propertyListForType:NSFilenamesPboardType];
143         // FIXME: Maybe it makes more sense to allow multiple files and only use the first one?
144         if ([files count] == 1) {
145             NSString *file = [files objectAtIndex:0];
146             // FIXME: We are filtering out directories because that's what the original code used to
147             // do. Without this check, if the URL points to a local directory, Safari will open the
148             // parent directory of the directory in Finder. This check should go away as soon as
149             // possible.
150             BOOL isDirectory;
151             if ([[NSFileManager defaultManager] fileExistsAtPath:file isDirectory:&isDirectory] && isDirectory)
152                 return nil;
153             return [[NSURL fileURLWithPath:file] _webkit_canonicalize];
154         }
155     }
156
157     return nil;
158 }
159
160 - (void)_web_writeURL:(NSURL *)URL andTitle:(NSString *)title types:(NSArray *)types
161 {
162     ASSERT(URL);
163
164     if ([title length] == 0) {
165         title = [[URL path] lastPathComponent];
166         if ([title length] == 0)
167             title = [URL _web_userVisibleString];
168     }
169     
170     if ([types containsObject:NSURLPboardType])
171         [URL writeToPasteboard:self];
172     if ([types containsObject:WebURLPboardType])
173         [self setString:[URL _web_originalDataAsString] forType:WebURLPboardType];
174     if ([types containsObject:WebURLNamePboardType])
175         [self setString:title forType:WebURLNamePboardType];
176     if ([types containsObject:NSStringPboardType])
177         [self setString:[URL _web_userVisibleString] forType:NSStringPboardType];
178     if ([types containsObject:WebURLsWithTitlesPboardType])
179         [WebURLsWithTitles writeURLs:[NSArray arrayWithObject:URL] andTitles:[NSArray arrayWithObject:title] toPasteboard:self];
180 }
181
182 + (int)_web_setFindPasteboardString:(NSString *)string withOwner:(id)owner
183 {
184     NSPasteboard *findPasteboard = [NSPasteboard pasteboardWithName:NSFindPboard];
185     [findPasteboard declareTypes:[NSArray arrayWithObject:NSStringPboardType] owner:owner];
186     [findPasteboard setString:string forType:NSStringPboardType];
187     return [findPasteboard changeCount];
188 }
189
190 - (void)_web_writeFileWrapperAsRTFDAttachment:(NSFileWrapper *)wrapper
191 {
192     NSTextAttachment *attachment = [[NSTextAttachment alloc] initWithFileWrapper:wrapper];
193     
194     NSAttributedString *string = [NSAttributedString attributedStringWithAttachment:attachment];
195     [attachment release];
196     
197     NSData *RTFDData = [string RTFDFromRange:NSMakeRange(0, [string length]) documentAttributes:@{ }];
198     [self setData:RTFDData forType:NSRTFDPboardType];
199 }
200
201
202 - (void)_web_writePromisedRTFDFromArchive:(WebArchive*)archive containsImage:(BOOL)containsImage
203 {
204     ASSERT(archive);
205     // This image data is either the only subresource of an archive (HTML image case)
206     // or the main resource (standalone image case).
207     NSArray *subresources = [archive subresources];
208     WebResource *resource = [archive mainResource];
209     if (containsImage && [subresources count] > 0 
210         && MIMETypeRegistry::isSupportedImageResourceMIMEType([[subresources objectAtIndex:0] MIMEType]))
211         resource = (WebResource *)[subresources objectAtIndex:0];
212     ASSERT(resource != nil);
213     
214     ASSERT(!containsImage || MIMETypeRegistry::isSupportedImageResourceMIMEType([resource MIMEType]));
215     if (!containsImage || MIMETypeRegistry::isSupportedImageResourceMIMEType([resource MIMEType]))
216         [self _web_writeFileWrapperAsRTFDAttachment:[resource _fileWrapperRepresentation]];
217     
218 }
219
220 static CachedImage* imageFromElement(DOMElement *domElement)
221 {
222     auto* element = core(domElement);
223     if (!element)
224         return nullptr;
225     auto* renderer = element->renderer();
226     if (!is<RenderImage>(renderer))
227         return nullptr;
228     auto* image = downcast<RenderImage>(*renderer).cachedImage();
229     if (!image || image->errorOccurred())
230         return nullptr;
231     return image;
232 }
233
234 - (void)_web_writeImage:(NSImage *)image
235                 element:(DOMElement *)element
236                     URL:(NSURL *)URL 
237                   title:(NSString *)title
238                 archive:(WebArchive *)archive
239                   types:(NSArray *)types
240                  source:(WebHTMLView *)source
241 {
242     ASSERT(image || element);
243     ASSERT(URL);
244
245     [self _web_writeURL:URL andTitle:title types:types];
246     
247     if ([types containsObject:NSTIFFPboardType]) {
248         if (image)
249             [self setData:[image TIFFRepresentation] forType:NSTIFFPboardType];
250         else if (source && element)
251             [source setPromisedDragTIFFDataSource:imageFromElement(element)];
252         else if (element)
253             [self setData:[element _imageTIFFRepresentation] forType:NSTIFFPboardType];
254     }
255     
256     if (archive) {
257         if ([types containsObject:WebArchivePboardType])
258             [self setData:[archive data] forType:WebArchivePboardType];
259         return;
260     }
261
262     // We should not have declared types that we aren't going to write (4031826).
263     ASSERT(![types containsObject:NSRTFDPboardType]);
264     ASSERT(![types containsObject:WebArchivePboardType]);
265 }
266
267 - (id)_web_declareAndWriteDragImageForElement:(DOMElement *)element
268                                        URL:(NSURL *)URL 
269                                      title:(NSString *)title
270                                    archive:(WebArchive *)archive
271                                     source:(WebHTMLView *)source
272 {
273     ASSERT(self == [NSPasteboard pasteboardWithName:NSDragPboard]);
274
275     NSString *extension = @"";
276     RetainPtr<NSMutableArray> types = adoptNS([[NSMutableArray alloc] initWithObjects:NSFilesPromisePboardType, nil]);
277     if (auto* renderer = core(element)->renderer()) {
278         if (is<RenderImage>(*renderer)) {
279             if (auto* image = downcast<RenderImage>(*renderer).cachedImage()) {
280                 // FIXME: This doesn't check errorOccured the way imageFromElement does.
281                 extension = image->image()->filenameExtension();
282                 if (![extension length])
283                     return nullptr;
284                 [types addObjectsFromArray:[NSPasteboard _web_writableTypesForImageIncludingArchive:(archive != nil)]];
285                 [self declareTypes:types.get() owner:source];
286             }
287         }
288 #if ENABLE(ATTACHMENT_ELEMENT)
289         else if (is<RenderAttachment>(*renderer)) {
290             extension = URL.pathExtension;
291             [types addObjectsFromArray:[NSPasteboard _web_dragTypesForURL]];
292             [self declareTypes:types.get() owner:source];
293             RetainPtr<NSMutableArray> paths = adoptNS([[NSMutableArray alloc] init]);
294             [paths.get() addObject:title];
295             [self setPropertyList:paths.get() forType:NSFilenamesPboardType];
296         }
297 #endif
298     }
299
300     [self _web_writeImage:nil element:element URL:URL title:title archive:archive types:types.get() source:source];
301
302     NSArray *extensions = [[NSArray alloc] initWithObjects:extension, nil];
303     [self setPropertyList:extensions forType:NSFilesPromisePboardType];
304     [extensions release];
305
306     return source;
307 }
308
309 @end
310
311 #endif // !PLATFORM(IOS)