123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212 |
- /*
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
- #import <objc/runtime.h>
- #import <atomic>
- #import <mach/mach_time.h>
- #import <ImageIO/ImageIO.h>
- #import <FBReactNativeSpec/FBReactNativeSpec.h>
- #import <React/RCTConvert.h>
- #import <React/RCTDefines.h>
- #import <React/RCTImageCache.h>
- #import <React/RCTImageLoader.h>
- #import <React/RCTImageLoaderWithAttributionProtocol.h>
- #import <React/RCTImageUtils.h>
- #import <React/RCTLog.h>
- #import <React/RCTNetworking.h>
- #import <React/RCTUtils.h>
- #import "RCTImagePlugins.h"
- using namespace facebook::react;
- static BOOL imagePerfInstrumentationEnabled = NO;
- BOOL RCTImageLoadingPerfInstrumentationEnabled(void)
- {
- return imagePerfInstrumentationEnabled;
- }
- void RCTEnableImageLoadingPerfInstrumentation(BOOL enabled)
- {
- imagePerfInstrumentationEnabled = enabled;
- }
- static NSInteger RCTImageBytesForImage(UIImage *image)
- {
- NSInteger singleImageBytes = image.size.width * image.size.height * image.scale * image.scale * 4;
- return image.images ? image.images.count * singleImageBytes : singleImageBytes;
- }
- static uint64_t monotonicTimeGetCurrentNanoseconds(void)
- {
- static struct mach_timebase_info tb_info = {0};
- static dispatch_once_t onceToken;
- dispatch_once(&onceToken, ^{
- __unused int ret = mach_timebase_info(&tb_info);
- assert(0 == ret);
- });
- return (mach_absolute_time() * tb_info.numer) / tb_info.denom;
- }
- @interface RCTImageLoader() <NativeImageLoaderIOSSpec, RCTImageLoaderWithAttributionProtocol>
- @end
- @implementation UIImage (React)
- - (NSInteger)reactDecodedImageBytes
- {
- NSNumber *imageBytes = objc_getAssociatedObject(self, _cmd);
- if (!imageBytes) {
- imageBytes = @(RCTImageBytesForImage(self));
- }
- return [imageBytes integerValue];
- }
- - (void)setReactDecodedImageBytes:(NSInteger)bytes
- {
- objc_setAssociatedObject(self, @selector(reactDecodedImageBytes), @(bytes), OBJC_ASSOCIATION_RETAIN_NONATOMIC);
- }
- @end
- @implementation RCTImageLoader
- {
- NSArray<id<RCTImageURLLoader>> * (^_loadersProvider)(void);
- NSArray<id<RCTImageDataDecoder>> * (^_decodersProvider)(void);
- NSArray<id<RCTImageURLLoader>> *_loaders;
- NSArray<id<RCTImageDataDecoder>> *_decoders;
- NSOperationQueue *_imageDecodeQueue;
- dispatch_queue_t _URLRequestQueue;
- id<RCTImageCache> _imageCache;
- NSMutableArray *_pendingTasks;
- NSInteger _activeTasks;
- NSMutableArray *_pendingDecodes;
- NSInteger _scheduledDecodes;
- NSUInteger _activeBytes;
- __weak id<RCTImageRedirectProtocol> _redirectDelegate;
- }
- @synthesize bridge = _bridge;
- @synthesize maxConcurrentLoadingTasks = _maxConcurrentLoadingTasks;
- @synthesize maxConcurrentDecodingTasks = _maxConcurrentDecodingTasks;
- @synthesize maxConcurrentDecodingBytes = _maxConcurrentDecodingBytes;
- @synthesize turboModuleLookupDelegate = _turboModuleLookupDelegate;
- RCT_EXPORT_MODULE()
- - (instancetype)init
- {
- return [self initWithRedirectDelegate:nil];
- }
- + (BOOL)requiresMainQueueSetup
- {
- return NO;
- }
- - (instancetype)initWithRedirectDelegate:(id<RCTImageRedirectProtocol>)redirectDelegate
- {
- if (self = [super init]) {
- _redirectDelegate = redirectDelegate;
- }
- return self;
- }
- - (instancetype)initWithRedirectDelegate:(id<RCTImageRedirectProtocol>)redirectDelegate
- loadersProvider:(NSArray<id<RCTImageURLLoader>> * (^)(void))getLoaders
- decodersProvider:(NSArray<id<RCTImageDataDecoder>> * (^)(void))getHandlers
- {
- if (self = [self initWithRedirectDelegate:redirectDelegate]) {
- _loadersProvider = getLoaders;
- _decodersProvider = getHandlers;
- }
- return self;
- }
- - (void)setUp
- {
- // Set defaults
- _maxConcurrentLoadingTasks = _maxConcurrentLoadingTasks ?: 4;
- _maxConcurrentDecodingTasks = _maxConcurrentDecodingTasks ?: 2;
- _maxConcurrentDecodingBytes = _maxConcurrentDecodingBytes ?: 30 * 1024 * 1024; // 30MB
- _URLRequestQueue = dispatch_queue_create("com.facebook.react.ImageLoaderURLRequestQueue", DISPATCH_QUEUE_SERIAL);
- }
- - (float)handlerPriority
- {
- return 2;
- }
- #pragma mark - RCTImageLoaderProtocol 1/3
- - (id<RCTImageCache>)imageCache
- {
- if (!_imageCache) {
- //set up with default cache
- _imageCache = [RCTImageCache new];
- }
- return _imageCache;
- }
- - (void)setImageCache:(id<RCTImageCache>)cache
- {
- if (_imageCache) {
- RCTLogWarn(@"RCTImageCache was already set and has now been overridden.");
- }
- _imageCache = cache;
- }
- - (id<RCTImageURLLoader>)imageURLLoaderForURL:(NSURL *)URL
- {
- if (!_maxConcurrentLoadingTasks) {
- [self setUp];
- }
- if (!_loaders) {
- // Get loaders, sorted in reverse priority order (highest priority first)
- if (_loadersProvider) {
- _loaders = _loadersProvider();
- } else {
- RCTAssert(_bridge, @"Trying to find RCTImageURLLoaders and bridge not set.");
- _loaders = [_bridge modulesConformingToProtocol:@protocol(RCTImageURLLoader)];
- }
- _loaders = [_loaders sortedArrayUsingComparator:^NSComparisonResult(id<RCTImageURLLoader> a, id<RCTImageURLLoader> b) {
- float priorityA = [a respondsToSelector:@selector(loaderPriority)] ? [a loaderPriority] : 0;
- float priorityB = [b respondsToSelector:@selector(loaderPriority)] ? [b loaderPriority] : 0;
- if (priorityA > priorityB) {
- return NSOrderedAscending;
- } else if (priorityA < priorityB) {
- return NSOrderedDescending;
- } else {
- return NSOrderedSame;
- }
- }];
- }
- if (RCT_DEBUG) {
- // Check for handler conflicts
- float previousPriority = 0;
- id<RCTImageURLLoader> previousLoader = nil;
- for (id<RCTImageURLLoader> loader in _loaders) {
- float priority = [loader respondsToSelector:@selector(loaderPriority)] ? [loader loaderPriority] : 0;
- if (previousLoader && priority < previousPriority) {
- return previousLoader;
- }
- if ([loader canLoadImageURL:URL]) {
- if (previousLoader) {
- if (priority == previousPriority) {
- RCTLogError(@"The RCTImageURLLoaders %@ and %@ both reported that"
- " they can load the URL %@, and have equal priority"
- " (%g). This could result in non-deterministic behavior.",
- loader, previousLoader, URL, priority);
- }
- } else {
- previousLoader = loader;
- previousPriority = priority;
- }
- }
- }
- return previousLoader;
- }
- // Normal code path
- for (id<RCTImageURLLoader> loader in _loaders) {
- if ([loader canLoadImageURL:URL]) {
- return loader;
- }
- }
- return nil;
- }
- # pragma mark - Private Image Decoding & Resizing
- - (id<RCTImageDataDecoder>)imageDataDecoderForData:(NSData *)data
- {
- if (!_maxConcurrentLoadingTasks) {
- [self setUp];
- }
- if (!_decoders) {
- // Get decoders, sorted in reverse priority order (highest priority first)
- if (_decodersProvider) {
- _decoders = _decodersProvider();
- } else {
- RCTAssert(_bridge, @"Trying to find RCTImageDataDecoders and bridge not set.");
- _decoders = [_bridge modulesConformingToProtocol:@protocol(RCTImageDataDecoder)];
- }
- _decoders = [_decoders sortedArrayUsingComparator:^NSComparisonResult(id<RCTImageDataDecoder> a, id<RCTImageDataDecoder> b) {
- float priorityA = [a respondsToSelector:@selector(decoderPriority)] ? [a decoderPriority] : 0;
- float priorityB = [b respondsToSelector:@selector(decoderPriority)] ? [b decoderPriority] : 0;
- if (priorityA > priorityB) {
- return NSOrderedAscending;
- } else if (priorityA < priorityB) {
- return NSOrderedDescending;
- } else {
- return NSOrderedSame;
- }
- }];
- }
- if (RCT_DEBUG) {
- // Check for handler conflicts
- float previousPriority = 0;
- id<RCTImageDataDecoder> previousDecoder = nil;
- for (id<RCTImageDataDecoder> decoder in _decoders) {
- float priority = [decoder respondsToSelector:@selector(decoderPriority)] ? [decoder decoderPriority] : 0;
- if (previousDecoder && priority < previousPriority) {
- return previousDecoder;
- }
- if ([decoder canDecodeImageData:data]) {
- if (previousDecoder) {
- if (priority == previousPriority) {
- RCTLogError(@"The RCTImageDataDecoders %@ and %@ both reported that"
- " they can decode the data <NSData %p; %tu bytes>, and"
- " have equal priority (%g). This could result in"
- " non-deterministic behavior.",
- decoder, previousDecoder, data, data.length, priority);
- }
- } else {
- previousDecoder = decoder;
- previousPriority = priority;
- }
- }
- }
- return previousDecoder;
- }
- // Normal code path
- for (id<RCTImageDataDecoder> decoder in _decoders) {
- if ([decoder canDecodeImageData:data]) {
- return decoder;
- }
- }
- return nil;
- }
- static UIImage *RCTResizeImageIfNeeded(UIImage *image,
- CGSize size,
- CGFloat scale,
- RCTResizeMode resizeMode)
- {
- if (CGSizeEqualToSize(size, CGSizeZero) ||
- CGSizeEqualToSize(image.size, CGSizeZero) ||
- CGSizeEqualToSize(image.size, size)) {
- return image;
- }
- CGRect targetSize = RCTTargetRect(image.size, size, scale, resizeMode);
- CGAffineTransform transform = RCTTransformFromTargetRect(image.size, targetSize);
- image = RCTTransformImage(image, size, scale, transform);
- return image;
- }
- #pragma mark - RCTImageLoaderProtocol 2/3
- - (nullable RCTImageLoaderCancellationBlock)loadImageWithURLRequest:(NSURLRequest *)imageURLRequest
- callback:(RCTImageLoaderCompletionBlock)callback
- {
- return [self loadImageWithURLRequest:imageURLRequest
- priority:RCTImageLoaderPriorityImmediate
- callback:callback];
- }
- - (nullable RCTImageLoaderCancellationBlock)loadImageWithURLRequest:(NSURLRequest *)imageURLRequest
- priority:(RCTImageLoaderPriority)priority
- callback:(RCTImageLoaderCompletionBlock)callback {
- return [self loadImageWithURLRequest:imageURLRequest
- size:CGSizeZero
- scale:1
- clipped:YES
- resizeMode:RCTResizeModeStretch
- priority:priority
- progressBlock:nil
- partialLoadBlock:nil
- completionBlock:callback];
- }
- - (nullable RCTImageLoaderCancellationBlock)loadImageWithURLRequest:(NSURLRequest *)imageURLRequest
- size:(CGSize)size
- scale:(CGFloat)scale
- clipped:(BOOL)clipped
- resizeMode:(RCTResizeMode)resizeMode
- progressBlock:(RCTImageLoaderProgressBlock)progressBlock
- partialLoadBlock:(RCTImageLoaderPartialLoadBlock)partialLoadBlock
- completionBlock:(RCTImageLoaderCompletionBlock)completionBlock
- {
- return [self loadImageWithURLRequest:imageURLRequest
- size:size
- scale:scale
- clipped:clipped
- resizeMode:resizeMode
- priority:RCTImageLoaderPriorityImmediate
- progressBlock:progressBlock
- partialLoadBlock:partialLoadBlock
- completionBlock:completionBlock];
- }
- - (nullable RCTImageLoaderCancellationBlock)loadImageWithURLRequest:(NSURLRequest *)imageURLRequest
- size:(CGSize)size
- scale:(CGFloat)scale
- clipped:(BOOL)clipped
- resizeMode:(RCTResizeMode)resizeMode
- priority:(RCTImageLoaderPriority)priority
- progressBlock:(RCTImageLoaderProgressBlock)progressBlock
- partialLoadBlock:(RCTImageLoaderPartialLoadBlock)partialLoadBlock
- completionBlock:(RCTImageLoaderCompletionBlock)completionBlock
- {
- RCTImageURLLoaderRequest *request = [self loadImageWithURLRequest:imageURLRequest
- size:size
- scale:scale
- clipped:clipped
- resizeMode:resizeMode
- priority:priority
- attribution:{}
- progressBlock:progressBlock
- partialLoadBlock:partialLoadBlock
- completionBlock:completionBlock];
- return ^{
- [request cancel];
- };
- }
- #pragma mark - Private Downloader Methods
- - (void)dequeueTasks
- {
- dispatch_async(_URLRequestQueue, ^{
- // Remove completed tasks
- NSMutableArray *tasksToRemove = nil;
- for (RCTNetworkTask *task in self->_pendingTasks.reverseObjectEnumerator) {
- switch (task.status) {
- case RCTNetworkTaskFinished:
- if (!tasksToRemove) {
- tasksToRemove = [NSMutableArray new];
- }
- [tasksToRemove addObject:task];
- self->_activeTasks--;
- break;
- case RCTNetworkTaskPending:
- break;
- case RCTNetworkTaskInProgress:
- // Check task isn't "stuck"
- if (task.requestToken == nil) {
- RCTLogWarn(@"Task orphaned for request %@", task.request);
- if (!tasksToRemove) {
- tasksToRemove = [NSMutableArray new];
- }
- [tasksToRemove addObject:task];
- self->_activeTasks--;
- [task cancel];
- }
- break;
- }
- }
- if (tasksToRemove) {
- [self->_pendingTasks removeObjectsInArray:tasksToRemove];
- }
- // Start queued decode
- NSInteger activeDecodes = self->_scheduledDecodes - self->_pendingDecodes.count;
- while (activeDecodes == 0 || (self->_activeBytes <= self->_maxConcurrentDecodingBytes &&
- activeDecodes <= self->_maxConcurrentDecodingTasks)) {
- dispatch_block_t decodeBlock = self->_pendingDecodes.firstObject;
- if (decodeBlock) {
- [self->_pendingDecodes removeObjectAtIndex:0];
- decodeBlock();
- } else {
- break;
- }
- }
- // Start queued tasks
- for (RCTNetworkTask *task in self->_pendingTasks) {
- if (MAX(self->_activeTasks, self->_scheduledDecodes) >= self->_maxConcurrentLoadingTasks) {
- break;
- }
- if (task.status == RCTNetworkTaskPending) {
- [task start];
- self->_activeTasks++;
- }
- }
- });
- }
- /**
- * This returns either an image, or raw image data, depending on the loading
- * path taken. This is useful if you want to skip decoding, e.g. when preloading
- * the image, or retrieving metadata.
- */
- - (RCTImageURLLoaderRequest *)_loadImageOrDataWithURLRequest:(NSURLRequest *)request
- size:(CGSize)size
- scale:(CGFloat)scale
- resizeMode:(RCTResizeMode)resizeMode
- priority:(RCTImageLoaderPriority)priority
- attribution:(const ImageURLLoaderAttribution &)attribution
- progressBlock:(RCTImageLoaderProgressBlock)progressHandler
- partialLoadBlock:(RCTImageLoaderPartialLoadBlock)partialLoadHandler
- completionBlock:(void (^)(NSError *error, id imageOrData, BOOL cacheResult, NSURLResponse *response))completionBlock
- {
- {
- NSMutableURLRequest *mutableRequest = [request mutableCopy];
- [NSURLProtocol setProperty:@"RCTImageLoader"
- forKey:@"trackingName"
- inRequest:mutableRequest];
- // Add missing png extension
- if (request.URL.fileURL && request.URL.pathExtension.length == 0) {
- mutableRequest.URL = [request.URL URLByAppendingPathExtension:@"png"];
- }
- if (_redirectDelegate != nil) {
- mutableRequest.URL = [_redirectDelegate redirectAssetsURL:mutableRequest.URL];
- }
- request = mutableRequest;
- }
- // Create a copy here so the value is retained when accessed in the blocks below.
- ImageURLLoaderAttribution attributionCopy(attribution);
- // Find suitable image URL loader
- id<RCTImageURLLoader> loadHandler = [self imageURLLoaderForURL:request.URL];
- BOOL requiresScheduling = [loadHandler respondsToSelector:@selector(requiresScheduling)] ?
- [loadHandler requiresScheduling] : YES;
- BOOL cacheResult = [loadHandler respondsToSelector:@selector(shouldCacheLoadedImages)] ?
- [loadHandler shouldCacheLoadedImages] : YES;
- auto cancelled = std::make_shared<std::atomic<int>>(0);
- __block dispatch_block_t cancelLoad = nil;
- __block NSLock *cancelLoadLock = [NSLock new];
- NSString *requestId = [NSString stringWithFormat:@"%@-%llu",[[NSUUID UUID] UUIDString], monotonicTimeGetCurrentNanoseconds()];
- void (^completionHandler)(NSError *, id, NSURLResponse *) = ^(NSError *error, id imageOrData, NSURLResponse *response) {
- [cancelLoadLock lock];
- cancelLoad = nil;
- [cancelLoadLock unlock];
- // If we've received an image, we should try to set it synchronously,
- // if it's data, do decoding on a background thread.
- if (RCTIsMainQueue() && ![imageOrData isKindOfClass:[UIImage class]]) {
- // Most loaders do not return on the main thread, so caller is probably not
- // expecting it, and may do expensive post-processing in the callback
- dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
- if (!std::atomic_load(cancelled.get())) {
- completionBlock(error, imageOrData, cacheResult, response);
- }
- });
- } else if (!std::atomic_load(cancelled.get())) {
- completionBlock(error, imageOrData, cacheResult, response);
- }
- };
- // If the loader doesn't require scheduling we call it directly on
- // the main queue.
- if (loadHandler && !requiresScheduling) {
- if ([loadHandler conformsToProtocol:@protocol(RCTImageURLLoaderWithAttribution)]) {
- return [(id<RCTImageURLLoaderWithAttribution>)loadHandler loadImageForURL:request.URL
- size:size
- scale:scale
- resizeMode:resizeMode
- requestId:requestId
- priority:priority
- attribution:attributionCopy
- progressHandler:progressHandler
- partialLoadHandler:partialLoadHandler
- completionHandler:^(NSError *error, UIImage *image) {
- completionHandler(error, image, nil);
- }];
- }
- RCTImageLoaderCancellationBlock cb = [loadHandler loadImageForURL:request.URL
- size:size
- scale:scale
- resizeMode:resizeMode
- progressHandler:progressHandler
- partialLoadHandler:partialLoadHandler
- completionHandler:^(NSError *error, UIImage *image) {
- completionHandler(error, image, nil);
- }];
- return [[RCTImageURLLoaderRequest alloc] initWithRequestId:nil imageURL:request.URL cancellationBlock:cb];
- }
- // All access to URL cache must be serialized
- if (!_URLRequestQueue) {
- [self setUp];
- }
- __weak RCTImageLoader *weakSelf = self;
- dispatch_async(_URLRequestQueue, ^{
- __typeof(self) strongSelf = weakSelf;
- if (atomic_load(cancelled.get()) || !strongSelf) {
- return;
- }
- if (loadHandler) {
- dispatch_block_t cancelLoadLocal;
- if ([loadHandler conformsToProtocol:@protocol(RCTImageURLLoaderWithAttribution)]) {
- RCTImageURLLoaderRequest *loaderRequest = [(id<RCTImageURLLoaderWithAttribution>)loadHandler loadImageForURL:request.URL
- size:size
- scale:scale
- resizeMode:resizeMode
- requestId:requestId
- priority:priority
- attribution:attributionCopy
- progressHandler:progressHandler
- partialLoadHandler:partialLoadHandler
- completionHandler:^(NSError *error, UIImage *image) {
- completionHandler(error, image, nil);
- }];
- cancelLoadLocal = loaderRequest.cancellationBlock;
- } else {
- cancelLoadLocal = [loadHandler loadImageForURL:request.URL
- size:size
- scale:scale
- resizeMode:resizeMode
- progressHandler:progressHandler
- partialLoadHandler:partialLoadHandler
- completionHandler:^(NSError *error, UIImage *image) {
- completionHandler(error, image, nil);
- }];
- }
- [cancelLoadLock lock];
- cancelLoad = cancelLoadLocal;
- [cancelLoadLock unlock];
- } else {
- UIImage *image;
- if (cacheResult) {
- image = [[strongSelf imageCache] imageForUrl:request.URL.absoluteString
- size:size
- scale:scale
- resizeMode:resizeMode];
- }
- if (image) {
- completionHandler(nil, image, nil);
- } else {
- // Use networking module to load image
- dispatch_block_t cancelLoadLocal = [strongSelf _loadURLRequest:request
- progressBlock:progressHandler
- completionBlock:completionHandler];
- [cancelLoadLock lock];
- cancelLoad = cancelLoadLocal;
- [cancelLoadLock unlock];
- }
- }
- });
- return [[RCTImageURLLoaderRequest alloc] initWithRequestId:requestId imageURL:request.URL cancellationBlock:^{
- BOOL alreadyCancelled = atomic_fetch_or(cancelled.get(), 1);
- if (alreadyCancelled) {
- return;
- }
- [cancelLoadLock lock];
- dispatch_block_t cancelLoadLocal = cancelLoad;
- cancelLoad = nil;
- [cancelLoadLock unlock];
- if (cancelLoadLocal) {
- cancelLoadLocal();
- }
- }];
- }
- - (RCTImageLoaderCancellationBlock)_loadURLRequest:(NSURLRequest *)request
- progressBlock:(RCTImageLoaderProgressBlock)progressHandler
- completionBlock:(void (^)(NSError *error, id imageOrData, NSURLResponse *response))completionHandler
- {
- // Check if networking module is available
- if (RCT_DEBUG && ![_bridge respondsToSelector:@selector(networking)]
- && ![_turboModuleLookupDelegate moduleForName:"RCTNetworking"]) {
- RCTLogError(@"No suitable image URL loader found for %@. You may need to "
- " import the RCTNetwork library in order to load images.",
- request.URL.absoluteString);
- return NULL;
- }
- RCTNetworking *networking = [_bridge networking];
- if (!networking) {
- networking = [_turboModuleLookupDelegate moduleForName:"RCTNetworking"];
- }
- // Check if networking module can load image
- if (RCT_DEBUG && ![networking canHandleRequest:request]) {
- RCTLogError(@"No suitable image URL loader found for %@", request.URL.absoluteString);
- return NULL;
- }
- // Use networking module to load image
- RCTURLRequestCompletionBlock processResponse = ^(NSURLResponse *response, NSData *data, NSError *error) {
- // Check for system errors
- if (error) {
- completionHandler(error, nil, response);
- return;
- } else if (!response) {
- completionHandler(RCTErrorWithMessage(@"Response metadata error"), nil, response);
- return;
- } else if (!data) {
- completionHandler(RCTErrorWithMessage(@"Unknown image download error"), nil, response);
- return;
- }
- // Check for http errors
- if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
- NSInteger statusCode = ((NSHTTPURLResponse *)response).statusCode;
- if (statusCode != 200) {
- NSString *errorMessage = [NSString stringWithFormat:@"Failed to load %@", response.URL];
- NSDictionary *userInfo = @{NSLocalizedDescriptionKey: errorMessage};
- completionHandler([[NSError alloc] initWithDomain:NSURLErrorDomain
- code:statusCode
- userInfo:userInfo], nil, response);
- return;
- }
- }
- // Call handler
- completionHandler(nil, data, response);
- };
- // Download image
- __weak __typeof(self) weakSelf = self;
- __block RCTNetworkTask *task =
- [networking networkTaskWithRequest:request
- completionBlock:^(NSURLResponse *response, NSData *data, NSError *error) {
- __typeof(self) strongSelf = weakSelf;
- if (!strongSelf) {
- return;
- }
- if (error || !response || !data) {
- NSError *someError = nil;
- if (error) {
- someError = error;
- } else if (!response) {
- someError = RCTErrorWithMessage(@"Response metadata error");
- } else {
- someError = RCTErrorWithMessage(@"Unknown image download error");
- }
- completionHandler(someError, nil, response);
- [strongSelf dequeueTasks];
- return;
- }
- dispatch_async(strongSelf->_URLRequestQueue, ^{
- // Process image data
- processResponse(response, data, nil);
- // Prepare for next task
- [strongSelf dequeueTasks];
- });
- }];
- task.downloadProgressBlock = ^(int64_t progress, int64_t total) {
- if (progressHandler) {
- progressHandler(progress, total);
- }
- };
- if (task) {
- if (!_pendingTasks) {
- _pendingTasks = [NSMutableArray new];
- }
- [_pendingTasks addObject:task];
- [self dequeueTasks];
- }
- return ^{
- __typeof(self) strongSelf = weakSelf;
- if (!strongSelf || !task) {
- return;
- }
- dispatch_async(strongSelf->_URLRequestQueue, ^{
- [task cancel];
- task = nil;
- });
- [strongSelf dequeueTasks];
- };
- }
- #pragma mark - RCTImageLoaderWithAttributionProtocol
- - (RCTImageURLLoaderRequest *)loadImageWithURLRequest:(NSURLRequest *)imageURLRequest
- size:(CGSize)size
- scale:(CGFloat)scale
- clipped:(BOOL)clipped
- resizeMode:(RCTResizeMode)resizeMode
- priority:(RCTImageLoaderPriority)priority
- attribution:(const ImageURLLoaderAttribution &)attribution
- progressBlock:(RCTImageLoaderProgressBlock)progressBlock
- partialLoadBlock:(RCTImageLoaderPartialLoadBlock)partialLoadBlock
- completionBlock:(RCTImageLoaderCompletionBlock)completionBlock
- {
- auto cancelled = std::make_shared<std::atomic<int>>(0);
- __block dispatch_block_t cancelLoad = nil;
- __block NSLock *cancelLoadLock = [NSLock new];
- dispatch_block_t cancellationBlock = ^{
- BOOL alreadyCancelled = atomic_fetch_or(cancelled.get(), 1);
- if (alreadyCancelled) {
- return;
- }
- [cancelLoadLock lock];
- dispatch_block_t cancelLoadLocal = cancelLoad;
- cancelLoad = nil;
- [cancelLoadLock unlock];
- if (cancelLoadLocal) {
- cancelLoadLocal();
- }
- };
- __weak RCTImageLoader *weakSelf = self;
- void (^completionHandler)(NSError *, id, BOOL, NSURLResponse *) = ^(NSError *error, id imageOrData, BOOL cacheResult, NSURLResponse *response) {
- __typeof(self) strongSelf = weakSelf;
- if (std::atomic_load(cancelled.get()) || !strongSelf) {
- return;
- }
- if (!imageOrData || [imageOrData isKindOfClass:[UIImage class]]) {
- [cancelLoadLock lock];
- cancelLoad = nil;
- [cancelLoadLock unlock];
- completionBlock(error, imageOrData);
- return;
- }
- RCTImageLoaderCompletionBlock decodeCompletionHandler = ^(NSError *error_, UIImage *image) {
- if (cacheResult && image) {
- // Store decoded image in cache
- [[strongSelf imageCache] addImageToCache:image
- URL:imageURLRequest.URL.absoluteString
- size:size
- scale:scale
- resizeMode:resizeMode
- response:response];
- }
- [cancelLoadLock lock];
- cancelLoad = nil;
- [cancelLoadLock unlock];
- completionBlock(error_, image);
- };
- dispatch_block_t cancelLoadLocal = [strongSelf decodeImageData:imageOrData
- size:size
- scale:scale
- clipped:clipped
- resizeMode:resizeMode
- completionBlock:decodeCompletionHandler];
- [cancelLoadLock lock];
- cancelLoad = cancelLoadLocal;
- [cancelLoadLock unlock];
- };
- RCTImageURLLoaderRequest *loaderRequest = [self _loadImageOrDataWithURLRequest:imageURLRequest
- size:size
- scale:scale
- resizeMode:resizeMode
- priority:priority
- attribution:attribution
- progressBlock:progressBlock
- partialLoadBlock:partialLoadBlock
- completionBlock:completionHandler];
- cancelLoad = loaderRequest.cancellationBlock;
- return [[RCTImageURLLoaderRequest alloc] initWithRequestId:loaderRequest.requestId imageURL:imageURLRequest.URL cancellationBlock:cancellationBlock];
- }
- - (void)trackURLImageContentDidSetForRequest:(RCTImageURLLoaderRequest *)loaderRequest
- {
- if (!loaderRequest) {
- return;
- }
- id<RCTImageURLLoader> loadHandler = [self imageURLLoaderForURL:loaderRequest.imageURL];
- if ([loadHandler respondsToSelector:@selector(trackURLImageContentDidSetForRequest:)]) {
- [(id<RCTImageURLLoaderWithAttribution>)loadHandler trackURLImageContentDidSetForRequest:loaderRequest];
- }
- }
- - (void)trackURLImageVisibilityForRequest:(RCTImageURLLoaderRequest *)loaderRequest imageView:(UIView *)imageView
- {
- if (!loaderRequest || !imageView) {
- return;
- }
- id<RCTImageURLLoader> loadHandler = [self imageURLLoaderForURL:loaderRequest.imageURL];
- if ([loadHandler respondsToSelector:@selector(trackURLImageVisibilityForRequest:imageView:)]) {
- [(id<RCTImageURLLoaderWithAttribution>)loadHandler trackURLImageVisibilityForRequest:loaderRequest imageView:imageView];
- }
- }
- - (void)trackURLImageDidDestroy:(RCTImageURLLoaderRequest *)loaderRequest
- {
- if (!loaderRequest) {
- return;
- }
- id<RCTImageURLLoader> loadHandler = [self imageURLLoaderForURL:loaderRequest.imageURL];
- if ([loadHandler respondsToSelector:@selector(trackURLImageDidDestroy:)]) {
- [(id<RCTImageURLLoaderWithAttribution>)loadHandler trackURLImageDidDestroy:loaderRequest];
- }
- }
- #pragma mark - RCTImageLoaderProtocol 3/3
- - (RCTImageLoaderCancellationBlock)decodeImageData:(NSData *)data
- size:(CGSize)size
- scale:(CGFloat)scale
- clipped:(BOOL)clipped
- resizeMode:(RCTResizeMode)resizeMode
- completionBlock:(RCTImageLoaderCompletionBlock)completionBlock
- {
- if (data.length == 0) {
- completionBlock(RCTErrorWithMessage(@"No image data"), nil);
- return ^{};
- }
- auto cancelled = std::make_shared<std::atomic<int>>(0);
- void (^completionHandler)(NSError *, UIImage *) = ^(NSError *error, UIImage *image) {
- if (RCTIsMainQueue()) {
- // Most loaders do not return on the main thread, so caller is probably not
- // expecting it, and may do expensive post-processing in the callback
- dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
- if (!std::atomic_load(cancelled.get())) {
- completionBlock(error, clipped ? RCTResizeImageIfNeeded(image, size, scale, resizeMode) : image);
- }
- });
- } else if (!std::atomic_load(cancelled.get())) {
- completionBlock(error, clipped ? RCTResizeImageIfNeeded(image, size, scale, resizeMode) : image);
- }
- };
- id<RCTImageDataDecoder> imageDecoder = [self imageDataDecoderForData:data];
- if (imageDecoder) {
- return [imageDecoder decodeImageData:data
- size:size
- scale:scale
- resizeMode:resizeMode
- completionHandler:completionHandler] ?: ^{};
- } else {
- dispatch_block_t decodeBlock = ^{
- // Calculate the size, in bytes, that the decompressed image will require
- NSInteger decodedImageBytes = (size.width * scale) * (size.height * scale) * 4;
- // Mark these bytes as in-use
- self->_activeBytes += decodedImageBytes;
- // Do actual decompression on a concurrent background queue
- dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
- if (!std::atomic_load(cancelled.get())) {
- // Decompress the image data (this may be CPU and memory intensive)
- UIImage *image = RCTDecodeImageWithData(data, size, scale, resizeMode);
- #if RCT_DEV
- CGSize imagePixelSize = RCTSizeInPixels(image.size, image.scale);
- CGSize screenPixelSize = RCTSizeInPixels(RCTScreenSize(), RCTScreenScale());
- if (imagePixelSize.width * imagePixelSize.height >
- screenPixelSize.width * screenPixelSize.height) {
- RCTLogInfo(@"[PERF ASSETS] Loading image at size %@, which is larger "
- "than the screen size %@", NSStringFromCGSize(imagePixelSize),
- NSStringFromCGSize(screenPixelSize));
- }
- #endif
- if (image) {
- completionHandler(nil, image);
- } else {
- NSString *errorMessage = [NSString stringWithFormat:@"Error decoding image data <NSData %p; %tu bytes>", data, data.length];
- NSError *finalError = RCTErrorWithMessage(errorMessage);
- completionHandler(finalError, nil);
- }
- }
- // We're no longer retaining the uncompressed data, so now we'll mark
- // the decoding as complete so that the loading task queue can resume.
- dispatch_async(self->_URLRequestQueue, ^{
- self->_scheduledDecodes--;
- self->_activeBytes -= decodedImageBytes;
- [self dequeueTasks];
- });
- });
- };
- if (!_URLRequestQueue) {
- [self setUp];
- }
- dispatch_async(_URLRequestQueue, ^{
- // The decode operation retains the compressed image data until it's
- // complete, so we'll mark it as having started, in order to block
- // further image loads from happening until we're done with the data.
- self->_scheduledDecodes++;
- if (!self->_pendingDecodes) {
- self->_pendingDecodes = [NSMutableArray new];
- }
- NSInteger activeDecodes = self->_scheduledDecodes - self->_pendingDecodes.count - 1;
- if (activeDecodes == 0 || (self->_activeBytes <= self->_maxConcurrentDecodingBytes &&
- activeDecodes <= self->_maxConcurrentDecodingTasks)) {
- decodeBlock();
- } else {
- [self->_pendingDecodes addObject:decodeBlock];
- }
- });
- return ^{
- std::atomic_store(cancelled.get(), 1);
- };
- }
- }
- - (RCTImageLoaderCancellationBlock)getImageSizeForURLRequest:(NSURLRequest *)imageURLRequest
- block:(void(^)(NSError *error, CGSize size))callback
- {
- void (^completion)(NSError *, id, BOOL, NSURLResponse *) = ^(NSError *error, id imageOrData, BOOL cacheResult, NSURLResponse *response) {
- CGSize size;
- if ([imageOrData isKindOfClass:[NSData class]]) {
- NSDictionary *meta = RCTGetImageMetadata(imageOrData);
- NSInteger imageOrientation = [meta[(id)kCGImagePropertyOrientation] integerValue];
- switch (imageOrientation) {
- case kCGImagePropertyOrientationLeft:
- case kCGImagePropertyOrientationRight:
- case kCGImagePropertyOrientationLeftMirrored:
- case kCGImagePropertyOrientationRightMirrored:
- // swap width and height
- size = (CGSize){
- [meta[(id)kCGImagePropertyPixelHeight] floatValue],
- [meta[(id)kCGImagePropertyPixelWidth] floatValue],
- };
- break;
- case kCGImagePropertyOrientationUp:
- case kCGImagePropertyOrientationDown:
- case kCGImagePropertyOrientationUpMirrored:
- case kCGImagePropertyOrientationDownMirrored:
- default:
- size = (CGSize){
- [meta[(id)kCGImagePropertyPixelWidth] floatValue],
- [meta[(id)kCGImagePropertyPixelHeight] floatValue],
- };
- break;
- }
- } else {
- UIImage *image = imageOrData;
- size = (CGSize){
- image.size.width * image.scale,
- image.size.height * image.scale,
- };
- }
- callback(error, size);
- };
- RCTImageURLLoaderRequest *loaderRequest = [self _loadImageOrDataWithURLRequest:imageURLRequest
- size:CGSizeZero
- scale:1
- resizeMode:RCTResizeModeStretch
- priority: RCTImageLoaderPriorityImmediate
- attribution:{}
- progressBlock:NULL
- partialLoadBlock:NULL
- completionBlock:completion];
- return loaderRequest.cancellationBlock;
- }
- - (NSDictionary *)getImageCacheStatus:(NSArray *)requests
- {
- NSMutableDictionary *results = [NSMutableDictionary dictionary];
- for (id request in requests) {
- NSURLRequest *urlRequest = [RCTConvert NSURLRequest:request];
- if (urlRequest) {
- NSCachedURLResponse *cachedResponse = [NSURLCache.sharedURLCache cachedResponseForRequest:urlRequest];
- if (cachedResponse) {
- if (cachedResponse.storagePolicy == NSURLCacheStorageAllowedInMemoryOnly) {
- results[urlRequest.URL.absoluteString] = @"memory";
- } else if (NSURLCache.sharedURLCache.currentMemoryUsage == 0) {
- // We can't check whether the file is cached on disk or memory.
- // However, if currentMemoryUsage is disabled, it must be read from disk.
- results[urlRequest.URL.absoluteString] = @"disk";
- } else {
- results[urlRequest.URL.absoluteString] = @"disk/memory";
- }
- }
- }
- }
- return results;
- }
- #pragma mark - RCTURLRequestHandler
- - (BOOL)canHandleRequest:(NSURLRequest *)request
- {
- NSURL *requestURL = request.URL;
- // If the data being loaded is a video, return NO
- // Even better may be to implement this on the RCTImageURLLoader that would try to load it,
- // but we'd have to run the logic both in RCTPhotoLibraryImageLoader and
- // RCTAssetsLibraryRequestHandler. Once we drop iOS7 though, we'd drop
- // RCTAssetsLibraryRequestHandler and can move it there.
- static NSRegularExpression *videoRegex;
- static dispatch_once_t onceToken;
- dispatch_once(&onceToken, ^{
- NSError *error = nil;
- videoRegex = [NSRegularExpression regularExpressionWithPattern:@"(?:&|^)ext=MOV(?:&|$)"
- options:NSRegularExpressionCaseInsensitive
- error:&error];
- if (error) {
- RCTLogError(@"%@", error);
- }
- });
- NSString *query = requestURL.query;
- if (
- query != nil &&
- [videoRegex firstMatchInString:query
- options:0
- range:NSMakeRange(0, query.length)]
- ) {
- return NO;
- }
- for (id<RCTImageURLLoader> loader in _loaders) {
- // Don't use RCTImageURLLoader protocol for modules that already conform to
- // RCTURLRequestHandler as it's inefficient to decode an image and then
- // convert it back into data
- if (![loader conformsToProtocol:@protocol(RCTURLRequestHandler)] &&
- [loader canLoadImageURL:requestURL]) {
- return YES;
- }
- }
- return NO;
- }
- - (id)sendRequest:(NSURLRequest *)request withDelegate:(id<RCTURLRequestDelegate>)delegate
- {
- __block RCTImageLoaderCancellationBlock requestToken;
- requestToken = [self loadImageWithURLRequest:request callback:^(NSError *error, UIImage *image) {
- if (error) {
- [delegate URLRequest:requestToken didCompleteWithError:error];
- return;
- }
- NSString *mimeType = nil;
- NSData *imageData = nil;
- if (RCTImageHasAlpha(image.CGImage)) {
- mimeType = @"image/png";
- imageData = UIImagePNGRepresentation(image);
- } else {
- mimeType = @"image/jpeg";
- imageData = UIImageJPEGRepresentation(image, 1.0);
- }
- NSURLResponse *response = [[NSURLResponse alloc] initWithURL:request.URL
- MIMEType:mimeType
- expectedContentLength:imageData.length
- textEncodingName:nil];
- [delegate URLRequest:requestToken didReceiveResponse:response];
- [delegate URLRequest:requestToken didReceiveData:imageData];
- [delegate URLRequest:requestToken didCompleteWithError:nil];
- }];
- return requestToken;
- }
- - (void)cancelRequest:(id)requestToken
- {
- if (requestToken) {
- ((RCTImageLoaderCancellationBlock)requestToken)();
- }
- }
- - (std::shared_ptr<facebook::react::TurboModule>)
- getTurboModuleWithJsInvoker:(std::shared_ptr<facebook::react::CallInvoker>)jsInvoker
- nativeInvoker:(std::shared_ptr<facebook::react::CallInvoker>)nativeInvoker
- perfLogger:(id<RCTTurboModulePerformanceLogger>)perfLogger
- {
- return std::make_shared<facebook::react::NativeImageLoaderIOSSpecJSI>(self, jsInvoker, nativeInvoker, perfLogger);
- }
- RCT_EXPORT_METHOD(getSize:(NSString *)uri resolve:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
- {
- NSURLRequest *request = [RCTConvert NSURLRequest:uri];
- [self getImageSizeForURLRequest:request
- block:^(NSError *error, CGSize size) {
- if (error) {
- reject(
- @"E_GET_SIZE_FAILURE",
- [NSString stringWithFormat: @"Failed to getSize of %@", uri],
- error);
- } else {
- resolve(@[@(size.width), @(size.height)]);
- }
- }];
- }
- RCT_EXPORT_METHOD(getSizeWithHeaders:(NSString *)uri
- headers:(NSDictionary *)headers
- resolve:(RCTPromiseResolveBlock)resolve
- reject:(RCTPromiseRejectBlock)reject)
- {
- NSURL *URL = [RCTConvert NSURL:uri];
- NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:URL];
- [headers enumerateKeysAndObjectsUsingBlock:^(NSString *key, id value, BOOL *stop) {
- [request addValue:[RCTConvert NSString:value] forHTTPHeaderField:key];
- }];
- [self getImageSizeForURLRequest:request
- block:^(NSError *error, CGSize size) {
- if (error) {
- reject(@"E_GET_SIZE_FAILURE", nil, error);
- return;
- }
- resolve(@{@"width":@(size.width),@"height":@(size.height)});
- }];
- }
- RCT_EXPORT_METHOD(prefetchImage:(NSString *)uri
- resolve:(RCTPromiseResolveBlock)resolve
- reject:(RCTPromiseRejectBlock)reject)
- {
- NSURLRequest *request = [RCTConvert NSURLRequest:uri];
- [self loadImageWithURLRequest:request
- priority:RCTImageLoaderPriorityPrefetch
- callback:^(NSError *error, UIImage *image) {
- if (error) {
- reject(@"E_PREFETCH_FAILURE", nil, error);
- return;
- }
- resolve(@YES);
- }];
- }
- RCT_EXPORT_METHOD(queryCache:(NSArray *)uris
- resolve:(RCTPromiseResolveBlock)resolve
- reject:(RCTPromiseRejectBlock)reject)
- {
- resolve([self getImageCacheStatus:uris]);
- }
- @end
- /**
- * DEPRECATED!! DO NOT USE
- * Instead use `[_bridge moduleForClass:[RCTImageLoader class]]`
- */
- @implementation RCTBridge (RCTImageLoader)
- - (RCTImageLoader *)imageLoader
- {
- RCTLogWarn(@"Calling bridge.imageLoader is deprecated and will not work in newer versions of RN. Please update to the "
- "moduleForClass API or turboModuleLookupDelegate API.");
- return [self moduleForClass:[RCTImageLoader class]];
- }
- @end
- Class RCTImageLoaderCls(void)
- {
- return RCTImageLoader.class;
- }
|