Unreviewed build fix after r232511.
[WebKit-https.git] / Source / WebCore / platform / ios / WebItemProviderPasteboard.mm
1 /*
2  * Copyright (C) 2017-2018 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #import "WebItemProviderPasteboard.h"
28
29 #if ENABLE(DATA_INTERACTION)
30
31 #import <Foundation/NSItemProvider.h>
32 #import <Foundation/NSProgress.h>
33 #import <MobileCoreServices/MobileCoreServices.h>
34 #import <UIKit/NSItemProvider+UIKitAdditions.h>
35 #import <UIKit/UIColor.h>
36 #import <UIKit/UIImage.h>
37 #import <WebCore/FileSystem.h>
38 #import <WebCore/Pasteboard.h>
39 #import <pal/spi/ios/UIKitSPI.h>
40 #import <wtf/BlockPtr.h>
41 #import <wtf/OSObjectPtr.h>
42 #import <wtf/RetainPtr.h>
43 #import <wtf/SoftLinking.h>
44
45 SOFT_LINK_FRAMEWORK(UIKit)
46 SOFT_LINK_CLASS(UIKit, UIColor)
47 SOFT_LINK_CLASS(UIKit, UIImage)
48 SOFT_LINK_CLASS(UIKit, UIItemProvider)
49
50 typedef void(^ItemProviderDataLoadCompletionHandler)(NSData *, NSError *);
51 typedef void(^ItemProviderFileLoadCompletionHandler)(NSURL *, BOOL, NSError *);
52 typedef NSMutableDictionary<NSString *, NSURL *> TypeToFileURLMap;
53
54 using WebCore::Pasteboard;
55 using WebCore::PasteboardCustomData;
56
57 @interface WebItemProviderDataRegistrar : NSObject <WebItemProviderRegistrar>
58 - (instancetype)initWithData:(NSData *)data type:(NSString *)utiType;
59 @property (nonatomic, readonly) NSString *typeIdentifier;
60 @property (nonatomic, readonly) NSData *data;
61 @end
62
63 @implementation WebItemProviderDataRegistrar {
64     RetainPtr<NSString> _typeIdentifier;
65     RetainPtr<NSData> _data;
66 }
67
68 - (instancetype)initWithData:(NSData *)data type:(NSString *)utiType
69 {
70     if (!(self = [super init]))
71         return nil;
72
73     _data = data;
74     _typeIdentifier = utiType;
75     return self;
76 }
77
78 - (NSString *)typeIdentifier
79 {
80     return _typeIdentifier.get();
81 }
82
83 - (NSData *)data
84 {
85     return _data.get();
86 }
87
88 - (NSString *)typeIdentifierForClient
89 {
90     return self.typeIdentifier;
91 }
92
93 - (NSData *)dataForClient
94 {
95     return self.data;
96 }
97
98 - (void)registerItemProvider:(NSItemProvider *)itemProvider
99 {
100     [itemProvider registerDataRepresentationForTypeIdentifier:self.typeIdentifier visibility:UIItemProviderRepresentationOptionsVisibilityAll loadHandler:[itemData = _data] (ItemProviderDataLoadCompletionHandler completionHandler) -> NSProgress * {
101         completionHandler(itemData.get(), nil);
102         return nil;
103     }];
104 }
105
106 - (NSString *)description
107 {
108     return [NSString stringWithFormat:@"(%@ => %tu bytes)", _typeIdentifier.get(), [_data length]];
109 }
110
111 @end
112
113 @interface WebItemProviderWritableObjectRegistrar : NSObject <WebItemProviderRegistrar>
114 - (instancetype)initWithObject:(id <UIItemProviderWriting>)representingObject;
115 @property (nonatomic, readonly) id <UIItemProviderWriting> representingObject;
116 @end
117
118 @implementation WebItemProviderWritableObjectRegistrar {
119     RetainPtr<id <UIItemProviderWriting>> _representingObject;
120 }
121
122 - (instancetype)initWithObject:(id <UIItemProviderWriting>)representingObject
123 {
124     if (!(self = [super init]))
125         return nil;
126
127     _representingObject = representingObject;
128     return self;
129 }
130
131 - (id <UIItemProviderWriting>)representingObject
132 {
133     return _representingObject.get();
134 }
135
136 - (id <NSItemProviderWriting>)representingObjectForClient
137 {
138     return self.representingObject;
139 }
140
141 - (void)registerItemProvider:(NSItemProvider *)itemProvider
142 {
143     [itemProvider registerObject:self.representingObject visibility:UIItemProviderRepresentationOptionsVisibilityAll];
144 }
145
146 - (NSString *)description
147 {
148     return [NSString stringWithFormat:@"(%@)", [_representingObject class]];
149 }
150
151 @end
152
153 @interface WebItemProviderPromisedFileRegistrar : NSObject <WebItemProviderRegistrar>
154 - (instancetype)initWithType:(NSString *)utiType callback:(void(^)(WebItemProviderFileCallback))callback;
155 @property (nonatomic, readonly) NSString *typeIdentifier;
156 @end
157
158 @implementation WebItemProviderPromisedFileRegistrar {
159     RetainPtr<NSString> _typeIdentifier;
160     BlockPtr<void(WebItemProviderFileCallback)> _callback;
161 }
162
163 - (instancetype)initWithType:(NSString *)utiType callback:(void(^)(WebItemProviderFileCallback))callback
164 {
165     if (!(self = [super init]))
166         return nil;
167
168     _typeIdentifier = utiType;
169     _callback = callback;
170     return self;
171 }
172
173 - (void)registerItemProvider:(NSItemProvider *)itemProvider
174 {
175     [itemProvider registerFileRepresentationForTypeIdentifier:_typeIdentifier.get() fileOptions:0 visibility:NSItemProviderRepresentationVisibilityAll loadHandler:[callback = _callback] (ItemProviderFileLoadCompletionHandler completionHandler) -> NSProgress * {
176         callback([protectedCompletionHandler = makeBlockPtr(completionHandler)] (NSURL *fileURL, NSError *error) {
177             protectedCompletionHandler(fileURL, NO, error);
178         });
179         return nil;
180     }];
181 }
182
183 - (NSString *)typeIdentifier
184 {
185     return _typeIdentifier.get();
186 }
187
188 - (NSString *)description
189 {
190     return [NSString stringWithFormat:@"(file promise: %@)", _typeIdentifier.get()];
191 }
192
193 @end
194
195 @interface WebItemProviderRegistrationInfoList ()
196 {
197     RetainPtr<NSMutableArray> _representations;
198 }
199 @end
200
201 @implementation WebItemProviderRegistrationInfoList
202
203 - (instancetype)init
204 {
205     if (self = [super init]) {
206         _representations = adoptNS([[NSMutableArray alloc] init]);
207         _preferredPresentationSize = CGSizeZero;
208         _preferredPresentationStyle = WebPreferredPresentationStyleUnspecified;
209     }
210
211     return self;
212 }
213
214 - (void)dealloc
215 {
216     [_suggestedName release];
217     [_teamData release];
218     [super dealloc];
219 }
220
221 - (void)addData:(NSData *)data forType:(NSString *)typeIdentifier
222 {
223     auto representation = adoptNS([[WebItemProviderDataRegistrar alloc] initWithData:data type:typeIdentifier]);
224     [_representations addObject:representation.get()];
225 }
226
227 - (void)addRepresentingObject:(id <UIItemProviderWriting>)object
228 {
229     ASSERT([object conformsToProtocol:@protocol(UIItemProviderWriting)]);
230     auto representation = adoptNS([[WebItemProviderWritableObjectRegistrar alloc] initWithObject:object]);
231     [_representations addObject:representation.get()];
232 }
233
234 - (void)addPromisedType:(NSString *)typeIdentifier fileCallback:(void(^)(WebItemProviderFileCallback))callback
235 {
236     auto representation = adoptNS([[WebItemProviderPromisedFileRegistrar alloc] initWithType:typeIdentifier callback:callback]);
237     [_representations addObject:representation.get()];
238 }
239
240 - (NSUInteger)numberOfItems
241 {
242     return [_representations count];
243 }
244
245 - (id <WebItemProviderRegistrar>)itemAtIndex:(NSUInteger)index
246 {
247     if (index >= self.numberOfItems)
248         return nil;
249
250     return [_representations objectAtIndex:index];
251 }
252
253 - (void)enumerateItems:(void (^)(id <WebItemProviderRegistrar>, NSUInteger))block
254 {
255     for (NSUInteger index = 0; index < self.numberOfItems; ++index)
256         block([self itemAtIndex:index], index);
257 }
258
259 static UIPreferredPresentationStyle uiPreferredPresentationStyle(WebPreferredPresentationStyle style)
260 {
261     switch (style) {
262     case WebPreferredPresentationStyleUnspecified:
263         return UIPreferredPresentationStyleUnspecified;
264     case WebPreferredPresentationStyleInline:
265         return UIPreferredPresentationStyleInline;
266     case WebPreferredPresentationStyleAttachment:
267         return UIPreferredPresentationStyleAttachment;
268     default:
269         ASSERT_NOT_REACHED();
270         return UIPreferredPresentationStyleUnspecified;
271     }
272 }
273
274 - (UIItemProvider *)itemProvider
275 {
276     if (!self.numberOfItems)
277         return nil;
278
279     auto itemProvider = adoptNS([allocUIItemProviderInstance() init]);
280     for (id <WebItemProviderRegistrar> representation in _representations.get())
281         [representation registerItemProvider:itemProvider.get()];
282     [itemProvider setPreferredPresentationSize:self.preferredPresentationSize];
283     [itemProvider setSuggestedName:self.suggestedName];
284     [itemProvider setPreferredPresentationStyle:uiPreferredPresentationStyle(self.preferredPresentationStyle)];
285     [itemProvider setTeamData:self.teamData];
286     return itemProvider.autorelease();
287 }
288
289 - (NSString *)description
290 {
291     __block NSMutableString *description = [NSMutableString string];
292     [description appendFormat:@"<%@: %p", [self class], self];
293     [self enumerateItems:^(id <WebItemProviderRegistrar> item, NSUInteger index) {
294         if (index)
295             [description appendString:@", "];
296         [description appendString:[item description]];
297     }];
298     [description appendString:@">"];
299     return description;
300 }
301
302 @end
303
304 @interface WebItemProviderLoadResult : NSObject
305
306 - (instancetype)initWithItemProvider:(NSItemProvider *)itemProvider typesToLoad:(NSArray<NSString *> *)typesToLoad;
307 - (NSURL *)fileURLForType:(NSString *)type;
308 - (void)setFileURL:(NSURL *)url forType:(NSString *)type;
309 @property (nonatomic, readonly) NSArray<NSURL *> *loadedFileURLs;
310 @property (nonatomic, readonly) NSArray<NSString *> *loadedTypeIdentifiers;
311 @property (nonatomic, readonly) BOOL canBeRepresentedAsFileUpload;
312 @property (nonatomic, readonly) NSItemProvider *itemProvider;
313 @property (nonatomic, readonly) NSArray<NSString *> *typesToLoad;
314
315 @end
316
317 @implementation WebItemProviderLoadResult {
318     RetainPtr<TypeToFileURLMap> _fileURLs;
319     RetainPtr<NSItemProvider> _itemProvider;
320     RetainPtr<NSArray<NSString *>> _typesToLoad;
321 }
322
323 + (instancetype)loadResultWithItemProvider:(NSItemProvider *)itemProvider typesToLoad:(NSArray<NSString *> *)typesToLoad
324 {
325     return [[[self alloc] initWithItemProvider:itemProvider typesToLoad:typesToLoad] autorelease];
326 }
327
328 - (instancetype)initWithItemProvider:(NSItemProvider *)itemProvider typesToLoad:(NSArray<NSString *> *)typesToLoad
329 {
330     if (!(self = [super init]))
331         return nil;
332
333     _fileURLs = adoptNS([[NSMutableDictionary alloc] init]);
334     _itemProvider = itemProvider;
335     _typesToLoad = typesToLoad;
336
337     return self;
338 }
339
340 - (BOOL)canBeRepresentedAsFileUpload
341 {
342     return [_itemProvider preferredPresentationStyle] != UIPreferredPresentationStyleInline;
343 }
344
345 - (NSArray<NSString *> *)typesToLoad
346 {
347     return _typesToLoad.get();
348 }
349
350 - (NSURL *)fileURLForType:(NSString *)type
351 {
352     return [_fileURLs objectForKey:type];
353 }
354
355 - (void)setFileURL:(NSURL *)url forType:(NSString *)type
356 {
357     [_fileURLs setObject:url forKey:type];
358 }
359
360 - (NSArray<NSURL *> *)loadedFileURLs
361 {
362     return [_fileURLs allValues];
363 }
364
365 - (NSArray<NSString *> *)loadedTypeIdentifiers
366 {
367     return [_fileURLs allKeys];
368 }
369
370 - (NSItemProvider *)itemProvider
371 {
372     return _itemProvider.get();
373 }
374
375 - (NSString *)description
376 {
377     __block NSMutableString *description = [NSMutableString string];
378     [description appendFormat:@"<%@: %p typesToLoad: [ ", [self class], self];
379     [_typesToLoad enumerateObjectsUsingBlock:^(NSString *type, NSUInteger index, BOOL *) {
380         [description appendString:type];
381         if (index + 1 < [_typesToLoad count])
382             [description appendString:@", "];
383     }];
384     [description appendFormat:@" ] fileURLs: { "];
385     __block NSUInteger index = 0;
386     [_fileURLs enumerateKeysAndObjectsUsingBlock:^(NSString *type, NSURL *url, BOOL *) {
387         [description appendFormat:@"%@ => \"%@\"", type, url.path];
388         if (++index < [_fileURLs count])
389             [description appendString:@", "];
390     }];
391     [description appendFormat:@" }>"];
392     return description;
393 }
394
395 @end
396
397 @interface WebItemProviderPasteboard ()
398
399 @property (nonatomic) NSInteger numberOfItems;
400 @property (nonatomic) NSInteger changeCount;
401 @property (nonatomic) NSInteger pendingOperationCount;
402
403 @end
404
405 @implementation WebItemProviderPasteboard {
406     // FIXME: These ivars should be refactored to be Vector<RetainPtr<Type>> instead of generic NSArrays.
407     RetainPtr<NSArray> _itemProviders;
408     RetainPtr<NSArray> _supportedTypeIdentifiers;
409     RetainPtr<WebItemProviderRegistrationInfoList> _stagedRegistrationInfoList;
410
411     Vector<RetainPtr<WebItemProviderLoadResult>> _loadResults;
412 }
413
414 + (instancetype)sharedInstance
415 {
416     static WebItemProviderPasteboard *sharedPasteboard = nil;
417     static dispatch_once_t onceToken;
418     dispatch_once(&onceToken, ^() {
419         sharedPasteboard = [[WebItemProviderPasteboard alloc] init];
420     });
421     return sharedPasteboard;
422 }
423
424 - (instancetype)init
425 {
426     if (self = [super init]) {
427         _itemProviders = adoptNS([[NSArray alloc] init]);
428         _changeCount = 0;
429         _pendingOperationCount = 0;
430         _supportedTypeIdentifiers = nil;
431         _stagedRegistrationInfoList = nil;
432         _loadResults = { };
433     }
434     return self;
435 }
436
437 - (void)updateSupportedTypeIdentifiers:(NSArray<NSString *> *)types
438 {
439     _supportedTypeIdentifiers = types;
440 }
441
442 - (NSArray<NSString *> *)pasteboardTypesByFidelityForItemAtIndex:(NSUInteger)index
443 {
444     return [self itemProviderAtIndex:index].registeredTypeIdentifiers ?: @[ ];
445 }
446
447 - (NSArray<NSString *> *)pasteboardTypes
448 {
449     NSMutableSet<NSString *> *allTypes = [NSMutableSet set];
450     NSMutableArray<NSString *> *allTypesInOrder = [NSMutableArray array];
451     for (UIItemProvider *provider in _itemProviders.get()) {
452         for (NSString *typeIdentifier in provider.registeredTypeIdentifiers) {
453             if ([allTypes containsObject:typeIdentifier])
454                 continue;
455
456             [allTypes addObject:typeIdentifier];
457             [allTypesInOrder addObject:typeIdentifier];
458         }
459     }
460     return allTypesInOrder;
461 }
462
463 - (NSArray<__kindof NSItemProvider *> *)itemProviders
464 {
465     return _itemProviders.get();
466 }
467
468 - (void)setItemProviders:(NSArray<__kindof NSItemProvider *> *)itemProviders
469 {
470     itemProviders = itemProviders ?: [NSArray array];
471     if (_itemProviders == itemProviders || [_itemProviders isEqualToArray:itemProviders])
472         return;
473
474     _itemProviders = itemProviders;
475     _changeCount++;
476
477     if (!itemProviders.count)
478         _loadResults = { };
479 }
480
481 - (NSInteger)numberOfItems
482 {
483     return [_itemProviders count];
484 }
485
486 - (NSData *)_preLoadedDataConformingToType:(NSString *)typeIdentifier forItemProviderAtIndex:(NSUInteger)index
487 {
488     if (_loadResults.size() != [_itemProviders count]) {
489         ASSERT_NOT_REACHED();
490         return nil;
491     }
492
493     WebItemProviderLoadResult *loadResult = _loadResults[index].get();
494     for (NSString *loadedType in loadResult.loadedTypeIdentifiers) {
495         if (!UTTypeConformsTo((CFStringRef)loadedType, (CFStringRef)typeIdentifier))
496             continue;
497
498         // We've already loaded data relevant for this UTI type onto disk, so there's no need to ask the UIItemProvider for the same data again.
499         if (NSData *result = [NSData dataWithContentsOfURL:[loadResult fileURLForType:loadedType] options:NSDataReadingMappedIfSafe error:nil])
500             return result;
501     }
502     return nil;
503 }
504
505 - (NSData *)dataForPasteboardType:(NSString *)pasteboardType
506 {
507     return [self dataForPasteboardType:pasteboardType inItemSet:[NSIndexSet indexSetWithIndexesInRange:NSMakeRange(0, self.numberOfItems)]].firstObject;
508 }
509
510 - (NSArray *)dataForPasteboardType:(NSString *)pasteboardType inItemSet:(NSIndexSet *)itemSet
511 {
512     if (_loadResults.isEmpty())
513         return @[ ];
514
515     auto values = adoptNS([[NSMutableArray alloc] init]);
516     RetainPtr<WebItemProviderPasteboard> retainedSelf = self;
517     [itemSet enumerateIndexesUsingBlock:[retainedSelf, pasteboardType, values] (NSUInteger index, BOOL *) {
518         UIItemProvider *provider = [retainedSelf itemProviderAtIndex:index];
519         if (!provider)
520             return;
521
522         if (NSData *loadedData = [retainedSelf _preLoadedDataConformingToType:pasteboardType forItemProviderAtIndex:index])
523             [values addObject:loadedData];
524     }];
525     return values.autorelease();
526 }
527
528 static NSArray<Class<UIItemProviderReading>> *allLoadableClasses()
529 {
530     return @[ [getUIColorClass() class], [getUIImageClass() class], [NSURL class], [NSString class], [NSAttributedString class] ];
531 }
532
533 static Class classForTypeIdentifier(NSString *typeIdentifier, NSString *&outTypeIdentifierToLoad)
534 {
535     outTypeIdentifierToLoad = typeIdentifier;
536
537     // First, try to load a platform UIItemProviderReading-conformant object as-is.
538     for (Class<UIItemProviderReading> loadableClass in allLoadableClasses()) {
539         if ([[loadableClass readableTypeIdentifiersForItemProvider] containsObject:(NSString *)typeIdentifier])
540             return loadableClass;
541     }
542
543     // If we were unable to load any object, check if the given type identifier is still something
544     // WebKit knows how to handle.
545     if ([typeIdentifier isEqualToString:(NSString *)kUTTypeHTML]) {
546         // Load kUTTypeHTML as a plain text HTML string.
547         outTypeIdentifierToLoad = (NSString *)kUTTypePlainText;
548         return [NSString class];
549     }
550
551     return nil;
552 }
553
554 - (NSArray *)valuesForPasteboardType:(NSString *)pasteboardType inItemSet:(NSIndexSet *)itemSet
555 {
556     if (_loadResults.isEmpty())
557         return @[ ];
558
559     auto values = adoptNS([[NSMutableArray alloc] init]);
560     RetainPtr<WebItemProviderPasteboard> retainedSelf = self;
561     [itemSet enumerateIndexesUsingBlock:[retainedSelf, pasteboardType, values] (NSUInteger index, BOOL *) {
562         UIItemProvider *provider = [retainedSelf itemProviderAtIndex:index];
563         if (!provider)
564             return;
565
566         NSString *typeIdentifierToLoad;
567         Class readableClass = classForTypeIdentifier(pasteboardType, typeIdentifierToLoad);
568         if (!readableClass)
569             return;
570
571         NSData *preloadedData = [retainedSelf _preLoadedDataConformingToType:pasteboardType forItemProviderAtIndex:index];
572         if (!preloadedData)
573             return;
574
575         if (id <NSItemProviderReading> readObject = [readableClass objectWithItemProviderData:preloadedData typeIdentifier:(NSString *)typeIdentifierToLoad error:nil])
576             [values addObject:readObject];
577     }];
578
579     return values.autorelease();
580 }
581
582 - (NSInteger)changeCount
583 {
584     return _changeCount;
585 }
586
587 - (NSURL *)preferredFileUploadURLAtIndex:(NSUInteger)index fileType:(NSString **)outFileType
588 {
589     if (outFileType)
590         *outFileType = nil;
591
592     if (index >= _loadResults.size())
593         return nil;
594
595     auto result = _loadResults[index];
596     if (![result canBeRepresentedAsFileUpload])
597         return nil;
598
599     NSItemProvider *itemProvider = [result itemProvider];
600     for (NSString *registeredTypeIdentifier in itemProvider.registeredTypeIdentifiers) {
601         // Search for the highest fidelity non-private type identifier we loaded from the item provider.
602         if (!UTTypeIsDeclared((CFStringRef)registeredTypeIdentifier) && !UTTypeIsDynamic((CFStringRef)registeredTypeIdentifier))
603             continue;
604
605         for (NSString *loadedTypeIdentifier in [result loadedTypeIdentifiers]) {
606             if (!UTTypeConformsTo((CFStringRef)registeredTypeIdentifier, (CFStringRef)loadedTypeIdentifier))
607                 continue;
608
609             if (outFileType)
610                 *outFileType = loadedTypeIdentifier;
611             return [result fileURLForType:loadedTypeIdentifier];
612         }
613     }
614
615     return nil;
616 }
617
618 - (NSArray<NSURL *> *)allDroppedFileURLs
619 {
620     NSMutableArray<NSURL *> *fileURLs = [NSMutableArray array];
621     for (auto loadResult : _loadResults) {
622         if ([loadResult canBeRepresentedAsFileUpload])
623             [fileURLs addObjectsFromArray:[loadResult loadedFileURLs]];
624     }
625     return fileURLs;
626 }
627
628 static BOOL typeConformsToTypes(NSString *type, NSArray *conformsToTypes)
629 {
630     // A type is considered appropriate to load if it conforms to one or more supported types.
631     for (NSString *conformsToType in conformsToTypes) {
632         if (UTTypeConformsTo((CFStringRef)type, (CFStringRef)conformsToType))
633             return YES;
634     }
635     return NO;
636 }
637
638 - (NSInteger)numberOfFiles
639 {
640     NSArray *supportedFileTypes = Pasteboard::supportedFileUploadPasteboardTypes();
641     NSInteger numberOfFiles = 0;
642     for (UIItemProvider *itemProvider in _itemProviders.get()) {
643         if (itemProvider.preferredPresentationStyle == UIPreferredPresentationStyleInline)
644             continue;
645
646         for (NSString *identifier in itemProvider.registeredTypeIdentifiers) {
647             if (!typeConformsToTypes(identifier, supportedFileTypes))
648                 continue;
649             ++numberOfFiles;
650             break;
651         }
652     }
653     return numberOfFiles;
654 }
655
656 static NSURL *linkTemporaryItemProviderFilesToDropStagingDirectory(NSURL *url, NSString *suggestedName, NSString *typeIdentifier)
657 {
658     static NSString *defaultDropFolderName = @"folder";
659     static NSString *defaultDropFileName = @"file";
660     static NSString *dataInteractionDirectoryPrefix = @"data-interaction";
661     if (!url)
662         return nil;
663
664     NSString *temporaryDataInteractionDirectory = WebCore::FileSystem::createTemporaryDirectory(dataInteractionDirectoryPrefix);
665     if (!temporaryDataInteractionDirectory)
666         return nil;
667
668     NSURL *destination = nil;
669     BOOL isFolder = UTTypeConformsTo((CFStringRef)typeIdentifier, kUTTypeFolder);
670     NSFileManager *fileManager = [NSFileManager defaultManager];
671
672     if (!suggestedName)
673         suggestedName = url.lastPathComponent ?: (isFolder ? defaultDropFolderName : defaultDropFileName);
674
675     if (![suggestedName containsString:@"."] && !isFolder)
676         suggestedName = [suggestedName stringByAppendingPathExtension:url.pathExtension];
677
678     destination = [NSURL fileURLWithPath:[temporaryDataInteractionDirectory stringByAppendingPathComponent:suggestedName]];
679     return [fileManager linkItemAtURL:url toURL:destination error:nil] ? destination : nil;
680 }
681
682 - (NSArray<NSString *> *)typeIdentifiersToLoadForRegisteredTypeIdentfiers:(NSArray<NSString *> *)registeredTypeIdentifiers
683 {
684     NSMutableSet *typesToLoad = [NSMutableSet set];
685     NSString *highestFidelityContentType = nil;
686
687     BOOL containsFlatRTFD = [registeredTypeIdentifiers containsObject:(NSString *)kUTTypeFlatRTFD];
688     // First, we want to either load the highest fidelity supported type or the highest fidelity generic content type.
689     for (NSString *registeredTypeIdentifier in registeredTypeIdentifiers) {
690         if (containsFlatRTFD && [registeredTypeIdentifier isEqualToString:(NSString *)kUTTypeRTFD]) {
691             // In the case where attachments are enabled and we're accepting all types of content using attachment
692             // elements as a fallback representation, if the source writes attributed strings to the pasteboard with
693             // com.apple.rtfd at a higher fidelity than com.apple.flat-rtfd, we'll end up loading only com.apple.rtfd
694             // and dropping the text as an attachment element because we cannot convert the dropped content to markup.
695             // Instead, if flat RTFD is present in the item provider, always prefer that over RTFD so that dropping as
696             // regular web content isn't overridden by enabling attachment elements.
697             continue;
698         }
699
700         if (typeConformsToTypes(registeredTypeIdentifier, _supportedTypeIdentifiers.get())) {
701             [typesToLoad addObject:registeredTypeIdentifier];
702             break;
703         }
704
705         if (!highestFidelityContentType && UTTypeConformsTo((CFStringRef)registeredTypeIdentifier, kUTTypeContent))
706             highestFidelityContentType = registeredTypeIdentifier;
707     }
708     if (!typesToLoad.count && highestFidelityContentType)
709         [typesToLoad addObject:highestFidelityContentType];
710
711     // For compatibility with DataTransfer APIs, additionally load web-exposed types. Since this is the only chance to
712     // fault in any data at all, we need to load up front any information that the page may ask for later down the line.
713     NSString *customPasteboardDataUTI = @(PasteboardCustomData::cocoaType());
714     for (NSString *registeredTypeIdentifier in registeredTypeIdentifiers) {
715         if ([typesToLoad containsObject:registeredTypeIdentifier])
716             continue;
717         if ([registeredTypeIdentifier isEqualToString:customPasteboardDataUTI])
718             [typesToLoad addObject:customPasteboardDataUTI];
719         if (UTTypeConformsTo((CFStringRef)registeredTypeIdentifier, kUTTypeURL))
720             [typesToLoad addObject:(NSString *)kUTTypeURL];
721         if (UTTypeConformsTo((CFStringRef)registeredTypeIdentifier, kUTTypeHTML))
722             [typesToLoad addObject:(NSString *)kUTTypeHTML];
723         if (UTTypeConformsTo((CFStringRef)registeredTypeIdentifier, kUTTypePlainText))
724             [typesToLoad addObject:(NSString *)kUTTypePlainText];
725     }
726
727     return typesToLoad.allObjects;
728 }
729
730 - (void)doAfterLoadingProvidedContentIntoFileURLs:(WebItemProviderFileLoadBlock)action
731 {
732     [self doAfterLoadingProvidedContentIntoFileURLs:action synchronousTimeout:0];
733 }
734
735 - (void)doAfterLoadingProvidedContentIntoFileURLs:(WebItemProviderFileLoadBlock)action synchronousTimeout:(NSTimeInterval)synchronousTimeout
736 {
737     _loadResults.clear();
738
739     auto changeCountBeforeLoading = _changeCount;
740     auto loadResults = adoptNS([[NSMutableArray alloc] initWithCapacity:[_itemProviders count]]);
741
742     // First, figure out which item providers we want to try and load files from.
743     BOOL foundAnyDataToLoad = NO;
744     RetainPtr<WebItemProviderPasteboard> protectedSelf = self;
745     for (NSItemProvider *itemProvider in _itemProviders.get()) {
746         NSArray<NSString *> *typeIdentifiersToLoad = [protectedSelf typeIdentifiersToLoadForRegisteredTypeIdentfiers:itemProvider.registeredTypeIdentifiers];
747         foundAnyDataToLoad |= typeIdentifiersToLoad.count;
748         [loadResults addObject:[WebItemProviderLoadResult loadResultWithItemProvider:itemProvider typesToLoad:typeIdentifiersToLoad]];
749     }
750
751     if (!foundAnyDataToLoad) {
752         action(@[ ]);
753         return;
754     }
755
756     auto setFileURLsLock = adoptNS([[NSLock alloc] init]);
757     auto synchronousFileLoadingGroup = adoptOSObject(dispatch_group_create());
758     auto fileLoadingGroup = adoptOSObject(dispatch_group_create());
759     for (WebItemProviderLoadResult *loadResult in loadResults.get()) {
760         for (NSString *typeToLoad in loadResult.typesToLoad) {
761             dispatch_group_enter(fileLoadingGroup.get());
762             dispatch_group_enter(synchronousFileLoadingGroup.get());
763             [loadResult.itemProvider loadFileRepresentationForTypeIdentifier:typeToLoad completionHandler:[protectedLoadResult = retainPtr(loadResult), synchronousFileLoadingGroup, setFileURLsLock, protectedTypeToLoad = retainPtr(typeToLoad), fileLoadingGroup] (NSURL *url, NSError *) {
764                 // After executing this completion block, UIKit removes the file at the given URL. However, we need this data to persist longer for the web content process.
765                 // To address this, we hard link the given URL to a new temporary file in the temporary directory. This follows the same flow as regular file upload, in
766                 // WKFileUploadPanel.mm. The temporary files are cleaned up by the system at a later time.
767                 if (NSURL *destination = linkTemporaryItemProviderFilesToDropStagingDirectory(url, [protectedLoadResult itemProvider].suggestedName, protectedTypeToLoad.get())) {
768                     [setFileURLsLock lock];
769                     [protectedLoadResult setFileURL:destination forType:protectedTypeToLoad.get()];
770                     [setFileURLsLock unlock];
771                 }
772                 dispatch_group_leave(fileLoadingGroup.get());
773                 dispatch_group_leave(synchronousFileLoadingGroup.get());
774             }];
775         }
776     }
777
778     RetainPtr<WebItemProviderPasteboard> retainedSelf = self;
779     auto itemLoadCompletion = [retainedSelf, synchronousFileLoadingGroup, fileLoadingGroup, loadResults, completionBlock = makeBlockPtr(action), changeCountBeforeLoading] {
780         if (changeCountBeforeLoading == retainedSelf->_changeCount) {
781             for (WebItemProviderLoadResult *loadResult in loadResults.get())
782                 retainedSelf->_loadResults.append(loadResult);
783         }
784
785         completionBlock([retainedSelf allDroppedFileURLs]);
786     };
787
788     if (synchronousTimeout > 0 && !dispatch_group_wait(synchronousFileLoadingGroup.get(), dispatch_time(DISPATCH_TIME_NOW, synchronousTimeout * NSEC_PER_SEC))) {
789         itemLoadCompletion();
790         return;
791     }
792
793     dispatch_group_notify(fileLoadingGroup.get(), dispatch_get_main_queue(), itemLoadCompletion);
794 }
795
796 - (UIItemProvider *)itemProviderAtIndex:(NSUInteger)index
797 {
798     return index < [_itemProviders count] ? [_itemProviders objectAtIndex:index] : nil;
799 }
800
801 - (BOOL)hasPendingOperation
802 {
803     return _pendingOperationCount;
804 }
805
806 - (void)incrementPendingOperationCount
807 {
808     _pendingOperationCount++;
809 }
810
811 - (void)decrementPendingOperationCount
812 {
813     _pendingOperationCount--;
814 }
815
816 - (void)enumerateItemProvidersWithBlock:(void (^)(UIItemProvider *itemProvider, NSUInteger index, BOOL *stop))block
817 {
818     [_itemProviders enumerateObjectsUsingBlock:block];
819 }
820
821 - (void)stageRegistrationList:(nullable WebItemProviderRegistrationInfoList *)info
822 {
823     _stagedRegistrationInfoList = info.numberOfItems ? info : nil;
824 }
825
826 - (WebItemProviderRegistrationInfoList *)takeRegistrationList
827 {
828     auto stagedRegistrationInfoList = _stagedRegistrationInfoList;
829     _stagedRegistrationInfoList = nil;
830     return stagedRegistrationInfoList.autorelease();
831 }
832
833 @end
834
835 #endif // ENABLE(DATA_INTERACTION)