123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553 |
- /*
- * 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 "SDImageCachesManager.h"
- #import "SDImageCachesManagerOperation.h"
- #import "SDImageCache.h"
- #import "SDInternalMacros.h"
- @interface SDImageCachesManager ()
- @property (nonatomic, strong, nonnull) dispatch_semaphore_t cachesLock;
- @end
- @implementation SDImageCachesManager
- {
- NSMutableArray<id<SDImageCache>> *_imageCaches;
- }
- + (SDImageCachesManager *)sharedManager {
- static dispatch_once_t onceToken;
- static SDImageCachesManager *manager;
- dispatch_once(&onceToken, ^{
- manager = [[SDImageCachesManager alloc] init];
- });
- return manager;
- }
- - (instancetype)init {
- self = [super init];
- if (self) {
- self.queryOperationPolicy = SDImageCachesManagerOperationPolicySerial;
- self.storeOperationPolicy = SDImageCachesManagerOperationPolicyHighestOnly;
- self.removeOperationPolicy = SDImageCachesManagerOperationPolicyConcurrent;
- self.containsOperationPolicy = SDImageCachesManagerOperationPolicySerial;
- self.clearOperationPolicy = SDImageCachesManagerOperationPolicyConcurrent;
- // initialize with default image caches
- _imageCaches = [NSMutableArray arrayWithObject:[SDImageCache sharedImageCache]];
- _cachesLock = dispatch_semaphore_create(1);
- }
- return self;
- }
- - (NSArray<id<SDImageCache>> *)caches {
- SD_LOCK(self.cachesLock);
- NSArray<id<SDImageCache>> *caches = [_imageCaches copy];
- SD_UNLOCK(self.cachesLock);
- return caches;
- }
- - (void)setCaches:(NSArray<id<SDImageCache>> *)caches {
- SD_LOCK(self.cachesLock);
- [_imageCaches removeAllObjects];
- if (caches.count) {
- [_imageCaches addObjectsFromArray:caches];
- }
- SD_UNLOCK(self.cachesLock);
- }
- #pragma mark - Cache IO operations
- - (void)addCache:(id<SDImageCache>)cache {
- if (![cache conformsToProtocol:@protocol(SDImageCache)]) {
- return;
- }
- SD_LOCK(self.cachesLock);
- [_imageCaches addObject:cache];
- SD_UNLOCK(self.cachesLock);
- }
- - (void)removeCache:(id<SDImageCache>)cache {
- if (![cache conformsToProtocol:@protocol(SDImageCache)]) {
- return;
- }
- SD_LOCK(self.cachesLock);
- [_imageCaches removeObject:cache];
- SD_UNLOCK(self.cachesLock);
- }
- #pragma mark - SDImageCache
- - (id<SDWebImageOperation>)queryImageForKey:(NSString *)key options:(SDWebImageOptions)options context:(SDWebImageContext *)context completion:(SDImageCacheQueryCompletionBlock)completionBlock {
- if (!key) {
- return nil;
- }
- NSArray<id<SDImageCache>> *caches = self.caches;
- NSUInteger count = caches.count;
- if (count == 0) {
- return nil;
- } else if (count == 1) {
- return [caches.firstObject queryImageForKey:key options:options context:context completion:completionBlock];
- }
- switch (self.queryOperationPolicy) {
- case SDImageCachesManagerOperationPolicyHighestOnly: {
- id<SDImageCache> cache = caches.lastObject;
- return [cache queryImageForKey:key options:options context:context completion:completionBlock];
- }
- break;
- case SDImageCachesManagerOperationPolicyLowestOnly: {
- id<SDImageCache> cache = caches.firstObject;
- return [cache queryImageForKey:key options:options context:context completion:completionBlock];
- }
- break;
- case SDImageCachesManagerOperationPolicyConcurrent: {
- SDImageCachesManagerOperation *operation = [SDImageCachesManagerOperation new];
- [operation beginWithTotalCount:caches.count];
- [self concurrentQueryImageForKey:key options:options context:context completion:completionBlock enumerator:caches.reverseObjectEnumerator operation:operation];
- return operation;
- }
- break;
- case SDImageCachesManagerOperationPolicySerial: {
- SDImageCachesManagerOperation *operation = [SDImageCachesManagerOperation new];
- [operation beginWithTotalCount:caches.count];
- [self serialQueryImageForKey:key options:options context:context completion:completionBlock enumerator:caches.reverseObjectEnumerator operation:operation];
- return operation;
- }
- break;
- default:
- return nil;
- break;
- }
- }
- - (void)storeImage:(UIImage *)image imageData:(NSData *)imageData forKey:(NSString *)key cacheType:(SDImageCacheType)cacheType completion:(SDWebImageNoParamsBlock)completionBlock {
- if (!key) {
- return;
- }
- NSArray<id<SDImageCache>> *caches = self.caches;
- NSUInteger count = caches.count;
- if (count == 0) {
- return;
- } else if (count == 1) {
- [caches.firstObject storeImage:image imageData:imageData forKey:key cacheType:cacheType completion:completionBlock];
- return;
- }
- switch (self.storeOperationPolicy) {
- case SDImageCachesManagerOperationPolicyHighestOnly: {
- id<SDImageCache> cache = caches.lastObject;
- [cache storeImage:image imageData:imageData forKey:key cacheType:cacheType completion:completionBlock];
- }
- break;
- case SDImageCachesManagerOperationPolicyLowestOnly: {
- id<SDImageCache> cache = caches.firstObject;
- [cache storeImage:image imageData:imageData forKey:key cacheType:cacheType completion:completionBlock];
- }
- break;
- case SDImageCachesManagerOperationPolicyConcurrent: {
- SDImageCachesManagerOperation *operation = [SDImageCachesManagerOperation new];
- [operation beginWithTotalCount:caches.count];
- [self concurrentStoreImage:image imageData:imageData forKey:key cacheType:cacheType completion:completionBlock enumerator:caches.reverseObjectEnumerator operation:operation];
- }
- break;
- case SDImageCachesManagerOperationPolicySerial: {
- [self serialStoreImage:image imageData:imageData forKey:key cacheType:cacheType completion:completionBlock enumerator:caches.reverseObjectEnumerator];
- }
- break;
- default:
- break;
- }
- }
- - (void)removeImageForKey:(NSString *)key cacheType:(SDImageCacheType)cacheType completion:(SDWebImageNoParamsBlock)completionBlock {
- if (!key) {
- return;
- }
- NSArray<id<SDImageCache>> *caches = self.caches;
- NSUInteger count = caches.count;
- if (count == 0) {
- return;
- } else if (count == 1) {
- [caches.firstObject removeImageForKey:key cacheType:cacheType completion:completionBlock];
- return;
- }
- switch (self.removeOperationPolicy) {
- case SDImageCachesManagerOperationPolicyHighestOnly: {
- id<SDImageCache> cache = caches.lastObject;
- [cache removeImageForKey:key cacheType:cacheType completion:completionBlock];
- }
- break;
- case SDImageCachesManagerOperationPolicyLowestOnly: {
- id<SDImageCache> cache = caches.firstObject;
- [cache removeImageForKey:key cacheType:cacheType completion:completionBlock];
- }
- break;
- case SDImageCachesManagerOperationPolicyConcurrent: {
- SDImageCachesManagerOperation *operation = [SDImageCachesManagerOperation new];
- [operation beginWithTotalCount:caches.count];
- [self concurrentRemoveImageForKey:key cacheType:cacheType completion:completionBlock enumerator:caches.reverseObjectEnumerator operation:operation];
- }
- break;
- case SDImageCachesManagerOperationPolicySerial: {
- [self serialRemoveImageForKey:key cacheType:cacheType completion:completionBlock enumerator:caches.reverseObjectEnumerator];
- }
- break;
- default:
- break;
- }
- }
- - (void)containsImageForKey:(NSString *)key cacheType:(SDImageCacheType)cacheType completion:(SDImageCacheContainsCompletionBlock)completionBlock {
- if (!key) {
- return;
- }
- NSArray<id<SDImageCache>> *caches = self.caches;
- NSUInteger count = caches.count;
- if (count == 0) {
- return;
- } else if (count == 1) {
- [caches.firstObject containsImageForKey:key cacheType:cacheType completion:completionBlock];
- return;
- }
- switch (self.clearOperationPolicy) {
- case SDImageCachesManagerOperationPolicyHighestOnly: {
- id<SDImageCache> cache = caches.lastObject;
- [cache containsImageForKey:key cacheType:cacheType completion:completionBlock];
- }
- break;
- case SDImageCachesManagerOperationPolicyLowestOnly: {
- id<SDImageCache> cache = caches.firstObject;
- [cache containsImageForKey:key cacheType:cacheType completion:completionBlock];
- }
- break;
- case SDImageCachesManagerOperationPolicyConcurrent: {
- SDImageCachesManagerOperation *operation = [SDImageCachesManagerOperation new];
- [operation beginWithTotalCount:caches.count];
- [self concurrentContainsImageForKey:key cacheType:cacheType completion:completionBlock enumerator:caches.reverseObjectEnumerator operation:operation];
- }
- break;
- case SDImageCachesManagerOperationPolicySerial: {
- SDImageCachesManagerOperation *operation = [SDImageCachesManagerOperation new];
- [operation beginWithTotalCount:caches.count];
- [self serialContainsImageForKey:key cacheType:cacheType completion:completionBlock enumerator:caches.reverseObjectEnumerator operation:operation];
- }
- break;
- default:
- break;
- }
- }
- - (void)clearWithCacheType:(SDImageCacheType)cacheType completion:(SDWebImageNoParamsBlock)completionBlock {
- NSArray<id<SDImageCache>> *caches = self.caches;
- NSUInteger count = caches.count;
- if (count == 0) {
- return;
- } else if (count == 1) {
- [caches.firstObject clearWithCacheType:cacheType completion:completionBlock];
- return;
- }
- switch (self.clearOperationPolicy) {
- case SDImageCachesManagerOperationPolicyHighestOnly: {
- id<SDImageCache> cache = caches.lastObject;
- [cache clearWithCacheType:cacheType completion:completionBlock];
- }
- break;
- case SDImageCachesManagerOperationPolicyLowestOnly: {
- id<SDImageCache> cache = caches.firstObject;
- [cache clearWithCacheType:cacheType completion:completionBlock];
- }
- break;
- case SDImageCachesManagerOperationPolicyConcurrent: {
- SDImageCachesManagerOperation *operation = [SDImageCachesManagerOperation new];
- [operation beginWithTotalCount:caches.count];
- [self concurrentClearWithCacheType:cacheType completion:completionBlock enumerator:caches.reverseObjectEnumerator operation:operation];
- }
- break;
- case SDImageCachesManagerOperationPolicySerial: {
- [self serialClearWithCacheType:cacheType completion:completionBlock enumerator:caches.reverseObjectEnumerator];
- }
- break;
- default:
- break;
- }
- }
- #pragma mark - Concurrent Operation
- - (void)concurrentQueryImageForKey:(NSString *)key options:(SDWebImageOptions)options context:(SDWebImageContext *)context completion:(SDImageCacheQueryCompletionBlock)completionBlock enumerator:(NSEnumerator<id<SDImageCache>> *)enumerator operation:(SDImageCachesManagerOperation *)operation {
- NSParameterAssert(enumerator);
- NSParameterAssert(operation);
- for (id<SDImageCache> cache in enumerator) {
- [cache queryImageForKey:key options:options context:context completion:^(UIImage * _Nullable image, NSData * _Nullable data, SDImageCacheType cacheType) {
- if (operation.isCancelled) {
- // Cancelled
- return;
- }
- if (operation.isFinished) {
- // Finished
- return;
- }
- [operation completeOne];
- if (image) {
- // Success
- [operation done];
- if (completionBlock) {
- completionBlock(image, data, cacheType);
- }
- return;
- }
- if (operation.pendingCount == 0) {
- // Complete
- [operation done];
- if (completionBlock) {
- completionBlock(nil, nil, SDImageCacheTypeNone);
- }
- }
- }];
- }
- }
- - (void)concurrentStoreImage:(UIImage *)image imageData:(NSData *)imageData forKey:(NSString *)key cacheType:(SDImageCacheType)cacheType completion:(SDWebImageNoParamsBlock)completionBlock enumerator:(NSEnumerator<id<SDImageCache>> *)enumerator operation:(SDImageCachesManagerOperation *)operation {
- NSParameterAssert(enumerator);
- NSParameterAssert(operation);
- for (id<SDImageCache> cache in enumerator) {
- [cache storeImage:image imageData:imageData forKey:key cacheType:cacheType completion:^{
- if (operation.isCancelled) {
- // Cancelled
- return;
- }
- if (operation.isFinished) {
- // Finished
- return;
- }
- [operation completeOne];
- if (operation.pendingCount == 0) {
- // Complete
- [operation done];
- if (completionBlock) {
- completionBlock();
- }
- }
- }];
- }
- }
- - (void)concurrentRemoveImageForKey:(NSString *)key cacheType:(SDImageCacheType)cacheType completion:(SDWebImageNoParamsBlock)completionBlock enumerator:(NSEnumerator<id<SDImageCache>> *)enumerator operation:(SDImageCachesManagerOperation *)operation {
- NSParameterAssert(enumerator);
- NSParameterAssert(operation);
- for (id<SDImageCache> cache in enumerator) {
- [cache removeImageForKey:key cacheType:cacheType completion:^{
- if (operation.isCancelled) {
- // Cancelled
- return;
- }
- if (operation.isFinished) {
- // Finished
- return;
- }
- [operation completeOne];
- if (operation.pendingCount == 0) {
- // Complete
- [operation done];
- if (completionBlock) {
- completionBlock();
- }
- }
- }];
- }
- }
- - (void)concurrentContainsImageForKey:(NSString *)key cacheType:(SDImageCacheType)cacheType completion:(SDImageCacheContainsCompletionBlock)completionBlock enumerator:(NSEnumerator<id<SDImageCache>> *)enumerator operation:(SDImageCachesManagerOperation *)operation {
- NSParameterAssert(enumerator);
- NSParameterAssert(operation);
- for (id<SDImageCache> cache in enumerator) {
- [cache containsImageForKey:key cacheType:cacheType completion:^(SDImageCacheType containsCacheType) {
- if (operation.isCancelled) {
- // Cancelled
- return;
- }
- if (operation.isFinished) {
- // Finished
- return;
- }
- [operation completeOne];
- if (containsCacheType != SDImageCacheTypeNone) {
- // Success
- [operation done];
- if (completionBlock) {
- completionBlock(containsCacheType);
- }
- return;
- }
- if (operation.pendingCount == 0) {
- // Complete
- [operation done];
- if (completionBlock) {
- completionBlock(SDImageCacheTypeNone);
- }
- }
- }];
- }
- }
- - (void)concurrentClearWithCacheType:(SDImageCacheType)cacheType completion:(SDWebImageNoParamsBlock)completionBlock enumerator:(NSEnumerator<id<SDImageCache>> *)enumerator operation:(SDImageCachesManagerOperation *)operation {
- NSParameterAssert(enumerator);
- NSParameterAssert(operation);
- for (id<SDImageCache> cache in enumerator) {
- [cache clearWithCacheType:cacheType completion:^{
- if (operation.isCancelled) {
- // Cancelled
- return;
- }
- if (operation.isFinished) {
- // Finished
- return;
- }
- [operation completeOne];
- if (operation.pendingCount == 0) {
- // Complete
- [operation done];
- if (completionBlock) {
- completionBlock();
- }
- }
- }];
- }
- }
- #pragma mark - Serial Operation
- - (void)serialQueryImageForKey:(NSString *)key options:(SDWebImageOptions)options context:(SDWebImageContext *)context completion:(SDImageCacheQueryCompletionBlock)completionBlock enumerator:(NSEnumerator<id<SDImageCache>> *)enumerator operation:(SDImageCachesManagerOperation *)operation {
- NSParameterAssert(enumerator);
- NSParameterAssert(operation);
- id<SDImageCache> cache = enumerator.nextObject;
- if (!cache) {
- // Complete
- [operation done];
- if (completionBlock) {
- completionBlock(nil, nil, SDImageCacheTypeNone);
- }
- return;
- }
- @weakify(self);
- [cache queryImageForKey:key options:options context:context completion:^(UIImage * _Nullable image, NSData * _Nullable data, SDImageCacheType cacheType) {
- @strongify(self);
- if (operation.isCancelled) {
- // Cancelled
- return;
- }
- if (operation.isFinished) {
- // Finished
- return;
- }
- [operation completeOne];
- if (image) {
- // Success
- [operation done];
- if (completionBlock) {
- completionBlock(image, data, cacheType);
- }
- return;
- }
- // Next
- [self serialQueryImageForKey:key options:options context:context completion:completionBlock enumerator:enumerator operation:operation];
- }];
- }
- - (void)serialStoreImage:(UIImage *)image imageData:(NSData *)imageData forKey:(NSString *)key cacheType:(SDImageCacheType)cacheType completion:(SDWebImageNoParamsBlock)completionBlock enumerator:(NSEnumerator<id<SDImageCache>> *)enumerator {
- NSParameterAssert(enumerator);
- id<SDImageCache> cache = enumerator.nextObject;
- if (!cache) {
- // Complete
- if (completionBlock) {
- completionBlock();
- }
- return;
- }
- @weakify(self);
- [cache storeImage:image imageData:imageData forKey:key cacheType:cacheType completion:^{
- @strongify(self);
- // Next
- [self serialStoreImage:image imageData:imageData forKey:key cacheType:cacheType completion:completionBlock enumerator:enumerator];
- }];
- }
- - (void)serialRemoveImageForKey:(NSString *)key cacheType:(SDImageCacheType)cacheType completion:(SDWebImageNoParamsBlock)completionBlock enumerator:(NSEnumerator<id<SDImageCache>> *)enumerator {
- NSParameterAssert(enumerator);
- id<SDImageCache> cache = enumerator.nextObject;
- if (!cache) {
- // Complete
- if (completionBlock) {
- completionBlock();
- }
- return;
- }
- @weakify(self);
- [cache removeImageForKey:key cacheType:cacheType completion:^{
- @strongify(self);
- // Next
- [self serialRemoveImageForKey:key cacheType:cacheType completion:completionBlock enumerator:enumerator];
- }];
- }
- - (void)serialContainsImageForKey:(NSString *)key cacheType:(SDImageCacheType)cacheType completion:(SDImageCacheContainsCompletionBlock)completionBlock enumerator:(NSEnumerator<id<SDImageCache>> *)enumerator operation:(SDImageCachesManagerOperation *)operation {
- NSParameterAssert(enumerator);
- NSParameterAssert(operation);
- id<SDImageCache> cache = enumerator.nextObject;
- if (!cache) {
- // Complete
- [operation done];
- if (completionBlock) {
- completionBlock(SDImageCacheTypeNone);
- }
- return;
- }
- @weakify(self);
- [cache containsImageForKey:key cacheType:cacheType completion:^(SDImageCacheType containsCacheType) {
- @strongify(self);
- if (operation.isCancelled) {
- // Cancelled
- return;
- }
- if (operation.isFinished) {
- // Finished
- return;
- }
- [operation completeOne];
- if (containsCacheType != SDImageCacheTypeNone) {
- // Success
- [operation done];
- if (completionBlock) {
- completionBlock(containsCacheType);
- }
- return;
- }
- // Next
- [self serialContainsImageForKey:key cacheType:cacheType completion:completionBlock enumerator:enumerator operation:operation];
- }];
- }
- - (void)serialClearWithCacheType:(SDImageCacheType)cacheType completion:(SDWebImageNoParamsBlock)completionBlock enumerator:(NSEnumerator<id<SDImageCache>> *)enumerator {
- NSParameterAssert(enumerator);
- id<SDImageCache> cache = enumerator.nextObject;
- if (!cache) {
- // Complete
- if (completionBlock) {
- completionBlock();
- }
- return;
- }
- @weakify(self);
- [cache clearWithCacheType:cacheType completion:^{
- @strongify(self);
- // Next
- [self serialClearWithCacheType:cacheType completion:completionBlock enumerator:enumerator];
- }];
- }
- @end
|