123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893 |
- /*
- * This file is part of the SDWebImage package.
- * (c) Olivier Poitrey <rs@dailymotion.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- #import "SDImageCache.h"
- #import "NSImage+Compatibility.h"
- #import "SDImageCodersManager.h"
- #import "SDImageCoderHelper.h"
- #import "SDAnimatedImage.h"
- #import "UIImage+MemoryCacheCost.h"
- #import "UIImage+Metadata.h"
- #import "UIImage+ExtendedCacheData.h"
- static NSString * _defaultDiskCacheDirectory;
- @interface SDImageCache ()
- #pragma mark - Properties
- @property (nonatomic, strong, readwrite, nonnull) id<SDMemoryCache> memoryCache;
- @property (nonatomic, strong, readwrite, nonnull) id<SDDiskCache> diskCache;
- @property (nonatomic, copy, readwrite, nonnull) SDImageCacheConfig *config;
- @property (nonatomic, copy, readwrite, nonnull) NSString *diskCachePath;
- @property (nonatomic, strong, nullable) dispatch_queue_t ioQueue;
- @end
- @implementation SDImageCache
- #pragma mark - Singleton, init, dealloc
- + (nonnull instancetype)sharedImageCache {
- static dispatch_once_t once;
- static id instance;
- dispatch_once(&once, ^{
- instance = [self new];
- });
- return instance;
- }
- + (NSString *)defaultDiskCacheDirectory {
- if (!_defaultDiskCacheDirectory) {
- _defaultDiskCacheDirectory = [[self userCacheDirectory] stringByAppendingPathComponent:@"com.hackemist.SDImageCache"];
- }
- return _defaultDiskCacheDirectory;
- }
- + (void)setDefaultDiskCacheDirectory:(NSString *)defaultDiskCacheDirectory {
- _defaultDiskCacheDirectory = [defaultDiskCacheDirectory copy];
- }
- - (instancetype)init {
- return [self initWithNamespace:@"default"];
- }
- - (nonnull instancetype)initWithNamespace:(nonnull NSString *)ns {
- return [self initWithNamespace:ns diskCacheDirectory:nil];
- }
- - (nonnull instancetype)initWithNamespace:(nonnull NSString *)ns
- diskCacheDirectory:(nullable NSString *)directory {
- return [self initWithNamespace:ns diskCacheDirectory:directory config:SDImageCacheConfig.defaultCacheConfig];
- }
- - (nonnull instancetype)initWithNamespace:(nonnull NSString *)ns
- diskCacheDirectory:(nullable NSString *)directory
- config:(nullable SDImageCacheConfig *)config {
- if ((self = [super init])) {
- NSAssert(ns, @"Cache namespace should not be nil");
-
- // Create IO serial queue
- _ioQueue = dispatch_queue_create("com.hackemist.SDImageCache", DISPATCH_QUEUE_SERIAL);
-
- if (!config) {
- config = SDImageCacheConfig.defaultCacheConfig;
- }
- _config = [config copy];
-
- // Init the memory cache
- NSAssert([config.memoryCacheClass conformsToProtocol:@protocol(SDMemoryCache)], @"Custom memory cache class must conform to `SDMemoryCache` protocol");
- _memoryCache = [[config.memoryCacheClass alloc] initWithConfig:_config];
-
- // Init the disk cache
- if (!directory) {
- // Use default disk cache directory
- directory = [self.class defaultDiskCacheDirectory];
- }
- _diskCachePath = [directory stringByAppendingPathComponent:ns];
-
- NSAssert([config.diskCacheClass conformsToProtocol:@protocol(SDDiskCache)], @"Custom disk cache class must conform to `SDDiskCache` protocol");
- _diskCache = [[config.diskCacheClass alloc] initWithCachePath:_diskCachePath config:_config];
-
- // Check and migrate disk cache directory if need
- [self migrateDiskCacheDirectory];
- #if SD_UIKIT
- // Subscribe to app events
- [[NSNotificationCenter defaultCenter] addObserver:self
- selector:@selector(applicationWillTerminate:)
- name:UIApplicationWillTerminateNotification
- object:nil];
- [[NSNotificationCenter defaultCenter] addObserver:self
- selector:@selector(applicationDidEnterBackground:)
- name:UIApplicationDidEnterBackgroundNotification
- object:nil];
- #endif
- #if SD_MAC
- [[NSNotificationCenter defaultCenter] addObserver:self
- selector:@selector(applicationWillTerminate:)
- name:NSApplicationWillTerminateNotification
- object:nil];
- #endif
- }
- return self;
- }
- - (void)dealloc {
- [[NSNotificationCenter defaultCenter] removeObserver:self];
- }
- #pragma mark - Cache paths
- - (nullable NSString *)cachePathForKey:(nullable NSString *)key {
- if (!key) {
- return nil;
- }
- return [self.diskCache cachePathForKey:key];
- }
- + (nullable NSString *)userCacheDirectory {
- NSArray<NSString *> *paths = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES);
- return paths.firstObject;
- }
- - (void)migrateDiskCacheDirectory {
- if ([self.diskCache isKindOfClass:[SDDiskCache class]]) {
- static dispatch_once_t onceToken;
- dispatch_once(&onceToken, ^{
- // ~/Library/Caches/com.hackemist.SDImageCache/default/
- NSString *newDefaultPath = [[[self.class userCacheDirectory] stringByAppendingPathComponent:@"com.hackemist.SDImageCache"] stringByAppendingPathComponent:@"default"];
- // ~/Library/Caches/default/com.hackemist.SDWebImageCache.default/
- NSString *oldDefaultPath = [[[self.class userCacheDirectory] stringByAppendingPathComponent:@"default"] stringByAppendingPathComponent:@"com.hackemist.SDWebImageCache.default"];
- dispatch_async(self.ioQueue, ^{
- [((SDDiskCache *)self.diskCache) moveCacheDirectoryFromPath:oldDefaultPath toPath:newDefaultPath];
- });
- });
- }
- }
- #pragma mark - Store Ops
- - (void)storeImage:(nullable UIImage *)image
- forKey:(nullable NSString *)key
- completion:(nullable SDWebImageNoParamsBlock)completionBlock {
- [self storeImage:image imageData:nil forKey:key toDisk:YES completion:completionBlock];
- }
- - (void)storeImage:(nullable UIImage *)image
- forKey:(nullable NSString *)key
- toDisk:(BOOL)toDisk
- completion:(nullable SDWebImageNoParamsBlock)completionBlock {
- [self storeImage:image imageData:nil forKey:key toDisk:toDisk completion:completionBlock];
- }
- - (void)storeImage:(nullable UIImage *)image
- imageData:(nullable NSData *)imageData
- forKey:(nullable NSString *)key
- toDisk:(BOOL)toDisk
- completion:(nullable SDWebImageNoParamsBlock)completionBlock {
- return [self storeImage:image imageData:imageData forKey:key toMemory:YES toDisk:toDisk completion:completionBlock];
- }
- - (void)storeImage:(nullable UIImage *)image
- imageData:(nullable NSData *)imageData
- forKey:(nullable NSString *)key
- toMemory:(BOOL)toMemory
- toDisk:(BOOL)toDisk
- completion:(nullable SDWebImageNoParamsBlock)completionBlock {
- if (!image || !key) {
- if (completionBlock) {
- completionBlock();
- }
- return;
- }
- // if memory cache is enabled
- if (toMemory && self.config.shouldCacheImagesInMemory) {
- NSUInteger cost = image.sd_memoryCost;
- [self.memoryCache setObject:image forKey:key cost:cost];
- }
-
- if (toDisk) {
- dispatch_async(self.ioQueue, ^{
- @autoreleasepool {
- NSData *data = imageData;
- if (!data && [image conformsToProtocol:@protocol(SDAnimatedImage)]) {
- // If image is custom animated image class, prefer its original animated data
- data = [((id<SDAnimatedImage>)image) animatedImageData];
- }
- if (!data && image) {
- // Check image's associated image format, may return .undefined
- SDImageFormat format = image.sd_imageFormat;
- if (format == SDImageFormatUndefined) {
- // If image is animated, use GIF (APNG may be better, but has bugs before macOS 10.14)
- if (image.sd_isAnimated) {
- format = SDImageFormatGIF;
- } else {
- // If we do not have any data to detect image format, check whether it contains alpha channel to use PNG or JPEG format
- if ([SDImageCoderHelper CGImageContainsAlpha:image.CGImage]) {
- format = SDImageFormatPNG;
- } else {
- format = SDImageFormatJPEG;
- }
- }
- }
- data = [[SDImageCodersManager sharedManager] encodedDataWithImage:image format:format options:nil];
- }
- [self _storeImageDataToDisk:data forKey:key];
- if (image) {
- // Check extended data
- id extendedObject = image.sd_extendedObject;
- if ([extendedObject conformsToProtocol:@protocol(NSCoding)]) {
- NSData *extendedData;
- if (@available(iOS 11, tvOS 11, macOS 10.13, watchOS 4, *)) {
- NSError *error;
- extendedData = [NSKeyedArchiver archivedDataWithRootObject:extendedObject requiringSecureCoding:NO error:&error];
- if (error) {
- NSLog(@"NSKeyedArchiver archive failed with error: %@", error);
- }
- } else {
- @try {
- #pragma clang diagnostic push
- #pragma clang diagnostic ignored "-Wdeprecated-declarations"
- extendedData = [NSKeyedArchiver archivedDataWithRootObject:extendedObject];
- #pragma clang diagnostic pop
- } @catch (NSException *exception) {
- NSLog(@"NSKeyedArchiver archive failed with exception: %@", exception);
- }
- }
- if (extendedData) {
- [self.diskCache setExtendedData:extendedData forKey:key];
- }
- }
- }
- }
-
- if (completionBlock) {
- dispatch_async(dispatch_get_main_queue(), ^{
- completionBlock();
- });
- }
- });
- } else {
- if (completionBlock) {
- completionBlock();
- }
- }
- }
- - (void)storeImageToMemory:(UIImage *)image forKey:(NSString *)key {
- if (!image || !key) {
- return;
- }
- NSUInteger cost = image.sd_memoryCost;
- [self.memoryCache setObject:image forKey:key cost:cost];
- }
- - (void)storeImageDataToDisk:(nullable NSData *)imageData
- forKey:(nullable NSString *)key {
- if (!imageData || !key) {
- return;
- }
-
- dispatch_sync(self.ioQueue, ^{
- [self _storeImageDataToDisk:imageData forKey:key];
- });
- }
- // Make sure to call from io queue by caller
- - (void)_storeImageDataToDisk:(nullable NSData *)imageData forKey:(nullable NSString *)key {
- if (!imageData || !key) {
- return;
- }
-
- [self.diskCache setData:imageData forKey:key];
- }
- #pragma mark - Query and Retrieve Ops
- - (void)diskImageExistsWithKey:(nullable NSString *)key completion:(nullable SDImageCacheCheckCompletionBlock)completionBlock {
- dispatch_async(self.ioQueue, ^{
- BOOL exists = [self _diskImageDataExistsWithKey:key];
- if (completionBlock) {
- dispatch_async(dispatch_get_main_queue(), ^{
- completionBlock(exists);
- });
- }
- });
- }
- - (BOOL)diskImageDataExistsWithKey:(nullable NSString *)key {
- if (!key) {
- return NO;
- }
-
- __block BOOL exists = NO;
- dispatch_sync(self.ioQueue, ^{
- exists = [self _diskImageDataExistsWithKey:key];
- });
-
- return exists;
- }
- // Make sure to call from io queue by caller
- - (BOOL)_diskImageDataExistsWithKey:(nullable NSString *)key {
- if (!key) {
- return NO;
- }
-
- return [self.diskCache containsDataForKey:key];
- }
- - (void)diskImageDataQueryForKey:(NSString *)key completion:(SDImageCacheQueryDataCompletionBlock)completionBlock {
- dispatch_async(self.ioQueue, ^{
- NSData *imageData = [self diskImageDataBySearchingAllPathsForKey:key];
- if (completionBlock) {
- dispatch_async(dispatch_get_main_queue(), ^{
- completionBlock(imageData);
- });
- }
- });
- }
- - (nullable NSData *)diskImageDataForKey:(nullable NSString *)key {
- if (!key) {
- return nil;
- }
- __block NSData *imageData = nil;
- dispatch_sync(self.ioQueue, ^{
- imageData = [self diskImageDataBySearchingAllPathsForKey:key];
- });
-
- return imageData;
- }
- - (nullable UIImage *)imageFromMemoryCacheForKey:(nullable NSString *)key {
- return [self.memoryCache objectForKey:key];
- }
- - (nullable UIImage *)imageFromDiskCacheForKey:(nullable NSString *)key {
- return [self imageFromDiskCacheForKey:key options:0 context:nil];
- }
- - (nullable UIImage *)imageFromDiskCacheForKey:(nullable NSString *)key options:(SDImageCacheOptions)options context:(nullable SDWebImageContext *)context {
- NSData *data = [self diskImageDataForKey:key];
- UIImage *diskImage = [self diskImageForKey:key data:data options:options context:context];
- if (diskImage && self.config.shouldCacheImagesInMemory) {
- NSUInteger cost = diskImage.sd_memoryCost;
- [self.memoryCache setObject:diskImage forKey:key cost:cost];
- }
- return diskImage;
- }
- - (nullable UIImage *)imageFromCacheForKey:(nullable NSString *)key {
- return [self imageFromCacheForKey:key options:0 context:nil];
- }
- - (nullable UIImage *)imageFromCacheForKey:(nullable NSString *)key options:(SDImageCacheOptions)options context:(nullable SDWebImageContext *)context {
- // First check the in-memory cache...
- UIImage *image = [self imageFromMemoryCacheForKey:key];
- if (image) {
- return image;
- }
-
- // Second check the disk cache...
- image = [self imageFromDiskCacheForKey:key options:options context:context];
- return image;
- }
- - (nullable NSData *)diskImageDataBySearchingAllPathsForKey:(nullable NSString *)key {
- if (!key) {
- return nil;
- }
-
- NSData *data = [self.diskCache dataForKey:key];
- if (data) {
- return data;
- }
-
- // Addtional cache path for custom pre-load cache
- if (self.additionalCachePathBlock) {
- NSString *filePath = self.additionalCachePathBlock(key);
- if (filePath) {
- data = [NSData dataWithContentsOfFile:filePath options:self.config.diskCacheReadingOptions error:nil];
- }
- }
- return data;
- }
- - (nullable UIImage *)diskImageForKey:(nullable NSString *)key {
- NSData *data = [self diskImageDataForKey:key];
- return [self diskImageForKey:key data:data];
- }
- - (nullable UIImage *)diskImageForKey:(nullable NSString *)key data:(nullable NSData *)data {
- return [self diskImageForKey:key data:data options:0 context:nil];
- }
- - (nullable UIImage *)diskImageForKey:(nullable NSString *)key data:(nullable NSData *)data options:(SDImageCacheOptions)options context:(SDWebImageContext *)context {
- if (data) {
- UIImage *image = SDImageCacheDecodeImageData(data, key, [[self class] imageOptionsFromCacheOptions:options], context);
- if (image) {
- // Check extended data
- NSData *extendedData = [self.diskCache extendedDataForKey:key];
- if (extendedData) {
- id extendedObject;
- if (@available(iOS 11, tvOS 11, macOS 10.13, watchOS 4, *)) {
- NSError *error;
- NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc] initForReadingFromData:extendedData error:&error];
- unarchiver.requiresSecureCoding = NO;
- extendedObject = [unarchiver decodeTopLevelObjectForKey:NSKeyedArchiveRootObjectKey error:&error];
- if (error) {
- NSLog(@"NSKeyedUnarchiver unarchive failed with error: %@", error);
- }
- } else {
- @try {
- #pragma clang diagnostic push
- #pragma clang diagnostic ignored "-Wdeprecated-declarations"
- extendedObject = [NSKeyedUnarchiver unarchiveObjectWithData:extendedData];
- #pragma clang diagnostic pop
- } @catch (NSException *exception) {
- NSLog(@"NSKeyedUnarchiver unarchive failed with exception: %@", exception);
- }
- }
- image.sd_extendedObject = extendedObject;
- }
- }
- return image;
- } else {
- return nil;
- }
- }
- - (nullable NSOperation *)queryCacheOperationForKey:(NSString *)key done:(SDImageCacheQueryCompletionBlock)doneBlock {
- return [self queryCacheOperationForKey:key options:0 done:doneBlock];
- }
- - (nullable NSOperation *)queryCacheOperationForKey:(NSString *)key options:(SDImageCacheOptions)options done:(SDImageCacheQueryCompletionBlock)doneBlock {
- return [self queryCacheOperationForKey:key options:options context:nil done:doneBlock];
- }
- - (nullable NSOperation *)queryCacheOperationForKey:(nullable NSString *)key options:(SDImageCacheOptions)options context:(nullable SDWebImageContext *)context done:(nullable SDImageCacheQueryCompletionBlock)doneBlock {
- return [self queryCacheOperationForKey:key options:options context:context cacheType:SDImageCacheTypeAll done:doneBlock];
- }
- - (nullable NSOperation *)queryCacheOperationForKey:(nullable NSString *)key options:(SDImageCacheOptions)options context:(nullable SDWebImageContext *)context cacheType:(SDImageCacheType)queryCacheType done:(nullable SDImageCacheQueryCompletionBlock)doneBlock {
- if (!key) {
- if (doneBlock) {
- doneBlock(nil, nil, SDImageCacheTypeNone);
- }
- return nil;
- }
- // Invalid cache type
- if (queryCacheType == SDImageCacheTypeNone) {
- if (doneBlock) {
- doneBlock(nil, nil, SDImageCacheTypeNone);
- }
- return nil;
- }
-
- // First check the in-memory cache...
- UIImage *image;
- if (queryCacheType != SDImageCacheTypeDisk) {
- image = [self imageFromMemoryCacheForKey:key];
- }
-
- if (image) {
- if (options & SDImageCacheDecodeFirstFrameOnly) {
- // Ensure static image
- Class animatedImageClass = image.class;
- if (image.sd_isAnimated || ([animatedImageClass isSubclassOfClass:[UIImage class]] && [animatedImageClass conformsToProtocol:@protocol(SDAnimatedImage)])) {
- #if SD_MAC
- image = [[NSImage alloc] initWithCGImage:image.CGImage scale:image.scale orientation:kCGImagePropertyOrientationUp];
- #else
- image = [[UIImage alloc] initWithCGImage:image.CGImage scale:image.scale orientation:image.imageOrientation];
- #endif
- }
- } else if (options & SDImageCacheMatchAnimatedImageClass) {
- // Check image class matching
- Class animatedImageClass = image.class;
- Class desiredImageClass = context[SDWebImageContextAnimatedImageClass];
- if (desiredImageClass && ![animatedImageClass isSubclassOfClass:desiredImageClass]) {
- image = nil;
- }
- }
- }
- BOOL shouldQueryMemoryOnly = (queryCacheType == SDImageCacheTypeMemory) || (image && !(options & SDImageCacheQueryMemoryData));
- if (shouldQueryMemoryOnly) {
- if (doneBlock) {
- doneBlock(image, nil, SDImageCacheTypeMemory);
- }
- return nil;
- }
-
- // Second check the disk cache...
- NSOperation *operation = [NSOperation new];
- // Check whether we need to synchronously query disk
- // 1. in-memory cache hit & memoryDataSync
- // 2. in-memory cache miss & diskDataSync
- BOOL shouldQueryDiskSync = ((image && options & SDImageCacheQueryMemoryDataSync) ||
- (!image && options & SDImageCacheQueryDiskDataSync));
- void(^queryDiskBlock)(void) = ^{
- if (operation.isCancelled) {
- if (doneBlock) {
- doneBlock(nil, nil, SDImageCacheTypeNone);
- }
- return;
- }
-
- @autoreleasepool {
- NSData *diskData = [self diskImageDataBySearchingAllPathsForKey:key];
- UIImage *diskImage;
- if (image) {
- // the image is from in-memory cache, but need image data
- diskImage = image;
- } else if (diskData) {
- BOOL shouldCacheToMomery = YES;
- if (context[SDWebImageContextStoreCacheType]) {
- SDImageCacheType cacheType = [context[SDWebImageContextStoreCacheType] integerValue];
- shouldCacheToMomery = (cacheType == SDImageCacheTypeAll || cacheType == SDImageCacheTypeMemory);
- }
- // decode image data only if in-memory cache missed
- diskImage = [self diskImageForKey:key data:diskData options:options context:context];
- if (shouldCacheToMomery && diskImage && self.config.shouldCacheImagesInMemory) {
- NSUInteger cost = diskImage.sd_memoryCost;
- [self.memoryCache setObject:diskImage forKey:key cost:cost];
- }
- }
-
- if (doneBlock) {
- if (shouldQueryDiskSync) {
- doneBlock(diskImage, diskData, SDImageCacheTypeDisk);
- } else {
- dispatch_async(dispatch_get_main_queue(), ^{
- doneBlock(diskImage, diskData, SDImageCacheTypeDisk);
- });
- }
- }
- }
- };
-
- // Query in ioQueue to keep IO-safe
- if (shouldQueryDiskSync) {
- dispatch_sync(self.ioQueue, queryDiskBlock);
- } else {
- dispatch_async(self.ioQueue, queryDiskBlock);
- }
-
- return operation;
- }
- #pragma mark - Remove Ops
- - (void)removeImageForKey:(nullable NSString *)key withCompletion:(nullable SDWebImageNoParamsBlock)completion {
- [self removeImageForKey:key fromDisk:YES withCompletion:completion];
- }
- - (void)removeImageForKey:(nullable NSString *)key fromDisk:(BOOL)fromDisk withCompletion:(nullable SDWebImageNoParamsBlock)completion {
- [self removeImageForKey:key fromMemory:YES fromDisk:fromDisk withCompletion:completion];
- }
- - (void)removeImageForKey:(nullable NSString *)key fromMemory:(BOOL)fromMemory fromDisk:(BOOL)fromDisk withCompletion:(nullable SDWebImageNoParamsBlock)completion {
- if (key == nil) {
- return;
- }
- if (fromMemory && self.config.shouldCacheImagesInMemory) {
- [self.memoryCache removeObjectForKey:key];
- }
- if (fromDisk) {
- dispatch_async(self.ioQueue, ^{
- [self.diskCache removeDataForKey:key];
-
- if (completion) {
- dispatch_async(dispatch_get_main_queue(), ^{
- completion();
- });
- }
- });
- } else if (completion) {
- completion();
- }
- }
- - (void)removeImageFromMemoryForKey:(NSString *)key {
- if (!key) {
- return;
- }
-
- [self.memoryCache removeObjectForKey:key];
- }
- - (void)removeImageFromDiskForKey:(NSString *)key {
- if (!key) {
- return;
- }
- dispatch_sync(self.ioQueue, ^{
- [self _removeImageFromDiskForKey:key];
- });
- }
- // Make sure to call from io queue by caller
- - (void)_removeImageFromDiskForKey:(NSString *)key {
- if (!key) {
- return;
- }
-
- [self.diskCache removeDataForKey:key];
- }
- #pragma mark - Cache clean Ops
- - (void)clearMemory {
- [self.memoryCache removeAllObjects];
- }
- - (void)clearDiskOnCompletion:(nullable SDWebImageNoParamsBlock)completion {
- dispatch_async(self.ioQueue, ^{
- [self.diskCache removeAllData];
- if (completion) {
- dispatch_async(dispatch_get_main_queue(), ^{
- completion();
- });
- }
- });
- }
- - (void)deleteOldFilesWithCompletionBlock:(nullable SDWebImageNoParamsBlock)completionBlock {
- dispatch_async(self.ioQueue, ^{
- [self.diskCache removeExpiredData];
- if (completionBlock) {
- dispatch_async(dispatch_get_main_queue(), ^{
- completionBlock();
- });
- }
- });
- }
- #pragma mark - UIApplicationWillTerminateNotification
- #if SD_UIKIT || SD_MAC
- - (void)applicationWillTerminate:(NSNotification *)notification {
- [self deleteOldFilesWithCompletionBlock:nil];
- }
- #endif
- #pragma mark - UIApplicationDidEnterBackgroundNotification
- #if SD_UIKIT
- - (void)applicationDidEnterBackground:(NSNotification *)notification {
- if (!self.config.shouldRemoveExpiredDataWhenEnterBackground) {
- return;
- }
- Class UIApplicationClass = NSClassFromString(@"UIApplication");
- if(!UIApplicationClass || ![UIApplicationClass respondsToSelector:@selector(sharedApplication)]) {
- return;
- }
- UIApplication *application = [UIApplication performSelector:@selector(sharedApplication)];
- __block UIBackgroundTaskIdentifier bgTask = [application beginBackgroundTaskWithExpirationHandler:^{
- // Clean up any unfinished task business by marking where you
- // stopped or ending the task outright.
- [application endBackgroundTask:bgTask];
- bgTask = UIBackgroundTaskInvalid;
- }];
- // Start the long-running task and return immediately.
- [self deleteOldFilesWithCompletionBlock:^{
- [application endBackgroundTask:bgTask];
- bgTask = UIBackgroundTaskInvalid;
- }];
- }
- #endif
- #pragma mark - Cache Info
- - (NSUInteger)totalDiskSize {
- __block NSUInteger size = 0;
- dispatch_sync(self.ioQueue, ^{
- size = [self.diskCache totalSize];
- });
- return size;
- }
- - (NSUInteger)totalDiskCount {
- __block NSUInteger count = 0;
- dispatch_sync(self.ioQueue, ^{
- count = [self.diskCache totalCount];
- });
- return count;
- }
- - (void)calculateSizeWithCompletionBlock:(nullable SDImageCacheCalculateSizeBlock)completionBlock {
- dispatch_async(self.ioQueue, ^{
- NSUInteger fileCount = [self.diskCache totalCount];
- NSUInteger totalSize = [self.diskCache totalSize];
- if (completionBlock) {
- dispatch_async(dispatch_get_main_queue(), ^{
- completionBlock(fileCount, totalSize);
- });
- }
- });
- }
- #pragma mark - Helper
- + (SDWebImageOptions)imageOptionsFromCacheOptions:(SDImageCacheOptions)cacheOptions {
- SDWebImageOptions options = 0;
- if (cacheOptions & SDImageCacheScaleDownLargeImages) options |= SDWebImageScaleDownLargeImages;
- if (cacheOptions & SDImageCacheDecodeFirstFrameOnly) options |= SDWebImageDecodeFirstFrameOnly;
- if (cacheOptions & SDImageCachePreloadAllFrames) options |= SDWebImagePreloadAllFrames;
- if (cacheOptions & SDImageCacheAvoidDecodeImage) options |= SDWebImageAvoidDecodeImage;
- if (cacheOptions & SDImageCacheMatchAnimatedImageClass) options |= SDWebImageMatchAnimatedImageClass;
-
- return options;
- }
- @end
- @implementation SDImageCache (SDImageCache)
- #pragma mark - SDImageCache
- - (id<SDWebImageOperation>)queryImageForKey:(NSString *)key options:(SDWebImageOptions)options context:(nullable SDWebImageContext *)context completion:(nullable SDImageCacheQueryCompletionBlock)completionBlock {
- return [self queryImageForKey:key options:options context:context cacheType:SDImageCacheTypeAll completion:completionBlock];
- }
- - (id<SDWebImageOperation>)queryImageForKey:(NSString *)key options:(SDWebImageOptions)options context:(nullable SDWebImageContext *)context cacheType:(SDImageCacheType)cacheType completion:(nullable SDImageCacheQueryCompletionBlock)completionBlock {
- SDImageCacheOptions cacheOptions = 0;
- if (options & SDWebImageQueryMemoryData) cacheOptions |= SDImageCacheQueryMemoryData;
- if (options & SDWebImageQueryMemoryDataSync) cacheOptions |= SDImageCacheQueryMemoryDataSync;
- if (options & SDWebImageQueryDiskDataSync) cacheOptions |= SDImageCacheQueryDiskDataSync;
- if (options & SDWebImageScaleDownLargeImages) cacheOptions |= SDImageCacheScaleDownLargeImages;
- if (options & SDWebImageAvoidDecodeImage) cacheOptions |= SDImageCacheAvoidDecodeImage;
- if (options & SDWebImageDecodeFirstFrameOnly) cacheOptions |= SDImageCacheDecodeFirstFrameOnly;
- if (options & SDWebImagePreloadAllFrames) cacheOptions |= SDImageCachePreloadAllFrames;
- if (options & SDWebImageMatchAnimatedImageClass) cacheOptions |= SDImageCacheMatchAnimatedImageClass;
-
- return [self queryCacheOperationForKey:key options:cacheOptions context:context cacheType:cacheType done:completionBlock];
- }
- - (void)storeImage:(UIImage *)image imageData:(NSData *)imageData forKey:(nullable NSString *)key cacheType:(SDImageCacheType)cacheType completion:(nullable SDWebImageNoParamsBlock)completionBlock {
- switch (cacheType) {
- case SDImageCacheTypeNone: {
- [self storeImage:image imageData:imageData forKey:key toMemory:NO toDisk:NO completion:completionBlock];
- }
- break;
- case SDImageCacheTypeMemory: {
- [self storeImage:image imageData:imageData forKey:key toMemory:YES toDisk:NO completion:completionBlock];
- }
- break;
- case SDImageCacheTypeDisk: {
- [self storeImage:image imageData:imageData forKey:key toMemory:NO toDisk:YES completion:completionBlock];
- }
- break;
- case SDImageCacheTypeAll: {
- [self storeImage:image imageData:imageData forKey:key toMemory:YES toDisk:YES completion:completionBlock];
- }
- break;
- default: {
- if (completionBlock) {
- completionBlock();
- }
- }
- break;
- }
- }
- - (void)removeImageForKey:(NSString *)key cacheType:(SDImageCacheType)cacheType completion:(nullable SDWebImageNoParamsBlock)completionBlock {
- switch (cacheType) {
- case SDImageCacheTypeNone: {
- [self removeImageForKey:key fromMemory:NO fromDisk:NO withCompletion:completionBlock];
- }
- break;
- case SDImageCacheTypeMemory: {
- [self removeImageForKey:key fromMemory:YES fromDisk:NO withCompletion:completionBlock];
- }
- break;
- case SDImageCacheTypeDisk: {
- [self removeImageForKey:key fromMemory:NO fromDisk:YES withCompletion:completionBlock];
- }
- break;
- case SDImageCacheTypeAll: {
- [self removeImageForKey:key fromMemory:YES fromDisk:YES withCompletion:completionBlock];
- }
- break;
- default: {
- if (completionBlock) {
- completionBlock();
- }
- }
- break;
- }
- }
- - (void)containsImageForKey:(NSString *)key cacheType:(SDImageCacheType)cacheType completion:(nullable SDImageCacheContainsCompletionBlock)completionBlock {
- switch (cacheType) {
- case SDImageCacheTypeNone: {
- if (completionBlock) {
- completionBlock(SDImageCacheTypeNone);
- }
- }
- break;
- case SDImageCacheTypeMemory: {
- BOOL isInMemoryCache = ([self imageFromMemoryCacheForKey:key] != nil);
- if (completionBlock) {
- completionBlock(isInMemoryCache ? SDImageCacheTypeMemory : SDImageCacheTypeNone);
- }
- }
- break;
- case SDImageCacheTypeDisk: {
- [self diskImageExistsWithKey:key completion:^(BOOL isInDiskCache) {
- if (completionBlock) {
- completionBlock(isInDiskCache ? SDImageCacheTypeDisk : SDImageCacheTypeNone);
- }
- }];
- }
- break;
- case SDImageCacheTypeAll: {
- BOOL isInMemoryCache = ([self imageFromMemoryCacheForKey:key] != nil);
- if (isInMemoryCache) {
- if (completionBlock) {
- completionBlock(SDImageCacheTypeMemory);
- }
- return;
- }
- [self diskImageExistsWithKey:key completion:^(BOOL isInDiskCache) {
- if (completionBlock) {
- completionBlock(isInDiskCache ? SDImageCacheTypeDisk : SDImageCacheTypeNone);
- }
- }];
- }
- break;
- default:
- if (completionBlock) {
- completionBlock(SDImageCacheTypeNone);
- }
- break;
- }
- }
- - (void)clearWithCacheType:(SDImageCacheType)cacheType completion:(SDWebImageNoParamsBlock)completionBlock {
- switch (cacheType) {
- case SDImageCacheTypeNone: {
- if (completionBlock) {
- completionBlock();
- }
- }
- break;
- case SDImageCacheTypeMemory: {
- [self clearMemory];
- if (completionBlock) {
- completionBlock();
- }
- }
- break;
- case SDImageCacheTypeDisk: {
- [self clearDiskOnCompletion:completionBlock];
- }
- break;
- case SDImageCacheTypeAll: {
- [self clearMemory];
- [self clearDiskOnCompletion:completionBlock];
- }
- break;
- default: {
- if (completionBlock) {
- completionBlock();
- }
- }
- break;
- }
- }
- @end
|