SD增加缓存图片到离线目录

Author: hzlujunfeng

SDWebImage/SDImageCache.h

@@ -77,6 +77,13 @@ typedef enum SDImageCacheType SDImageCacheType;
  */
 - (void)storeImage:(UIImage *)image forKey:(NSString *)key;
 
+/**
+ * <NTES DIY SDWebImage>
+ * Store the image to an eternal folder unless user want to clean it.
+ * Used for offline image in download manager
+ */
+- (void)storeImage:(UIImage *)image forKey:(NSString *)key isEternal:(BOOL)isEternal;
+
 /**
  * Store an image into memory and optionally disk cache at the given key.
  *
@@ -99,6 +106,11 @@ typedef enum SDImageCacheType SDImageCacheType;
  */
 - (void)storeImage:(UIImage *)image recalculateFromImage:(BOOL)recalculate imageData:(NSData *)imageData forKey:(NSString *)key toDisk:(BOOL)toDisk;
 
+/**
+ * <NTES DIY SDWebImage>
+ */
+- (void)storeImage:(UIImage *)image recalculateFromImage:(BOOL)recalculate imageData:(NSData *)imageData forKey:(NSString *)key toDisk:(BOOL)toDisk isEternal:(BOOL)isEternal;
+
 /**
  * Query the disk cache asynchronously.
  *
@@ -127,6 +139,12 @@ typedef enum SDImageCacheType SDImageCacheType;
  */
 - (void)removeImageForKey:(NSString *)key;
 
+/**
+ * <NTES DIY SDWebImage>
+ * 删除离线目录里的图片（非缓存目录）
+ */
+- (void)removeImageFromEternalDisk:(NSString*)key;
+
 /**
  * Remove the image from memory and optionaly disk cache synchronously
  *
@@ -170,4 +188,8 @@ typedef enum SDImageCacheType SDImageCacheType;
  */
 - (BOOL)diskImageExistsWithKey:(NSString *)key;
 
+//<NTES DIY SDWebImage> make interface public
+- (NSString *)defaultCachePathForKey:(NSString *)key;
+- (NSString *)eternalCachePathForKey:(NSString *)key;
+
 @end

SDWebImage/SDImageCache.m

@@ -13,6 +13,12 @@
 #import <mach/mach.h>
 #import <mach/mach_host.h>
 
+//<NTES DIY SDWebImage>
+#ifndef kAppRootDirectory
+#define kAppRootDirectory @"UserData" //set up for application data root dir
+#endif
+#define NEW_ETERNAL_CACHE_DIR_NAME @"ImageStorage"
+
 static const NSInteger kDefaultCacheMaxCacheAge = 60 * 60 * 24 * 7; // 1 week
 // PNG signature bytes and data (below)
 static unsigned char kPNGSignatureBytes[8] = {0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A};
@@ -40,6 +46,9 @@ @interface SDImageCache ()
 @property (strong, nonatomic) NSMutableArray *customPaths;
 @property (SDDispatchQueueSetterSementics, nonatomic) dispatch_queue_t ioQueue;
 
+//<NTES DIY SDWebImage>
+@property (strong, nonatomic) NSString *eternalDiskCachePath;
+
 @end
 
 
@@ -82,9 +91,15 @@ - (id)initWithNamespace:(NSString *)ns
         _memCache.name = fullNamespace;
 
         // Init the disk cache
-        NSArray *paths = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES);
-        _diskCachePath = [paths[0] stringByAppendingPathComponent:fullNamespace];
-
+//        NSArray *paths = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES);
+//        _diskCachePath = [paths[0] stringByAppendingPathComponent:fullNamespace];
+        
+        //<NTES DIY SDWebImage> init the disk cache
+        NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
+        NSString *rootDir = [paths[0] stringByAppendingPathComponent:kAppRootDirectory];
+        _diskCachePath = [rootDir stringByAppendingPathComponent:fullNamespace];
+        _eternalDiskCachePath = [rootDir stringByAppendingPathComponent:NEW_ETERNAL_CACHE_DIR_NAME];
+        
         dispatch_sync(_ioQueue, ^
         {
             _fileManager = NSFileManager.new;
@@ -144,6 +159,12 @@ - (NSString *)defaultCachePathForKey:(NSString *)key
     return [self cachePathForKey:key inPath:self.diskCachePath];
 }
 
+//<NTES DIY SDWebImage> 离线图片的文件路径
+- (NSString *)eternalCachePathForKey:(NSString *)key
+{
+    return [self cachePathForKey:key inPath:self.eternalDiskCachePath];
+}
+
 - (NSString *)cachedFileNameForKey:(NSString *)key
 {
     const char *str = [key UTF8String];
@@ -223,22 +244,108 @@ - (void)storeImage:(UIImage *)image recalculateFromImage:(BOOL)recalculate image
     }
 }
 
+/**
+ 不改原始方法-->
+ - (void)storeImage:(UIImage *)image recalculateFromImage:(BOOL)recalculate imageData:(NSData *)imageData forKey:(NSString *)key toDisk:(BOOL)toDisk 
+ 
+ */
+//<NTES DIY SDWebImage>（新增方法）
+- (void)storeImage:(UIImage *)image recalculateFromImage:(BOOL)recalculate imageData:(NSData *)imageData forKey:(NSString *)key toDisk:(BOOL)toDisk isEternal:(BOOL)isEternal
+{
+    if(!isEternal)
+    {
+        [self storeImage:image recalculateFromImage:recalculate imageData:imageData forKey:key toDisk:toDisk];
+        return;
+    }
+    
+    if (!image || !key)
+    {
+        return;
+    }
+    
+    [self.memCache setObject:image forKey:key cost:image.size.height * image.size.width * image.scale];
+    
+    if (toDisk)
+    {
+        dispatch_async(self.ioQueue, ^
+                       {
+                           NSData *data = imageData;
+                           
+                           if (image && (recalculate || !data))
+                           {
+#if TARGET_OS_IPHONE
+                               // We need to determine if the image is a PNG or a JPEG
+                               // PNGs are easier to detect because they have a unique signature (http://www.w3.org/TR/PNG-Structure.html)
+                               // The first eight bytes of a PNG file always contain the following (decimal) values:
+                               // 137 80 78 71 13 10 26 10
+                               
+                               // We assume the image is PNG, in case the imageData is nil (i.e. if trying to save a UIImage directly),
+                               // we will consider it PNG to avoid loosing the transparency
+                               BOOL imageIsPng = YES;
+                               
+                               // But if we have an image data, we will look at the preffix
+                               if ([imageData length] >= [kPNGSignatureData length])
+                               {
+                                   imageIsPng = ImageDataHasPNGPreffix(imageData);
+                               }
+                               
+                               if (imageIsPng)
+                               {
+                                   data = UIImagePNGRepresentation(image);
+                               }
+                               else
+                               {
+                                   data = UIImageJPEGRepresentation(image, (CGFloat)1.0);
+                               }
+#else
+                               data = [NSBitmapImageRep representationOfImageRepsInArray:image.representations usingType: NSJPEGFileType properties:nil];
+#endif
+                           }
+                           
+                           if (data)
+                           {
+                               // Can't use defaultManager another thread
+                               NSFileManager *fileManager = NSFileManager.new;
+                               
+                               if (![fileManager fileExistsAtPath:_eternalDiskCachePath]) //离线目录
+                               {
+                                   [fileManager createDirectoryAtPath:_eternalDiskCachePath withIntermediateDirectories:YES attributes:nil error:NULL];
+                               }
+                               
+                               [fileManager createFileAtPath:[self eternalCachePathForKey:key] contents:data attributes:nil];
+                           }
+                       });
+    }
+}
+
 - (void)storeImage:(UIImage *)image forKey:(NSString *)key
 {
     [self storeImage:image recalculateFromImage:YES imageData:nil forKey:key toDisk:YES];
 }
 
+//<NTES DIY SDWebImage>（新增方法）
+- (void)storeImage:(UIImage *)image forKey:(NSString *)key isEternal:(BOOL)isEternal
+{
+    [self storeImage:image recalculateFromImage:YES imageData:nil forKey:key toDisk:YES isEternal:isEternal];
+}
+
 - (void)storeImage:(UIImage *)image forKey:(NSString *)key toDisk:(BOOL)toDisk
 {
     [self storeImage:image recalculateFromImage:YES imageData:nil forKey:key toDisk:toDisk];
 }
 
+//<NTES DIY SDWebImage>（改动原始方法）
 - (BOOL)diskImageExistsWithKey:(NSString *)key
 {
     __block BOOL exists = NO;
     dispatch_sync(_ioQueue, ^
     {
         exists = [_fileManager fileExistsAtPath:[self defaultCachePathForKey:key]];
+        //<NTES DIY SDWebImage>默认路径找不到，去离线目录找一次
+        if(!exists)
+        {
+            exists = [_fileManager fileExistsAtPath:[self eternalCachePathForKey:key]];
+        }
     });
 
     return exists;
@@ -269,6 +376,7 @@ - (UIImage *)imageFromDiskCacheForKey:(NSString *)key
     return diskImage;
 }
 
+//<NTES DIY SDWebImage>(改动原始方法）
 - (NSData *)diskImageDataBySearchingAllPathsForKey:(NSString *)key
 {
     NSString *defaultPath = [self defaultCachePathForKey:key];
@@ -277,6 +385,14 @@ - (NSData *)diskImageDataBySearchingAllPathsForKey:(NSString *)key
     {
         return data;
     }
+    
+    //<NTES DIY SDWebImage> 查找离线目录
+    NSString *eternalPath = [self eternalCachePathForKey:key];
+    NSData *eternalData = [NSData dataWithContentsOfFile:eternalPath];
+    if (eternalData)
+    {
+        return eternalData;
+    }
 
     for (NSString *path in self.customPaths)
     {
@@ -380,6 +496,25 @@ - (void)removeImageForKey:(NSString *)key fromDisk:(BOOL)fromDisk
     }
 }
 
+/**
+ * 从离线目录删除图片
+ */
+//<NTES DIY SDWebImage>(新增方法)
+- (void)removeImageFromEternalDisk:(NSString*)key
+{
+    if (key == nil)
+    {
+        return;
+    }
+    
+    [self.memCache removeObjectForKey:key];
+    
+    dispatch_async(self.ioQueue, ^
+                   {
+                       [[NSFileManager defaultManager] removeItemAtPath:[self eternalCachePathForKey:key] error:nil];
+                   });
+}
+
 - (void)setMaxMemoryCost:(NSUInteger)maxMemoryCost
 {
     self.memCache.totalCostLimit = maxMemoryCost;

SDWebImage/SDWebImageManager.h

@@ -177,6 +177,12 @@ SDWebImageManager *manager = [SDWebImageManager sharedManager];
                                   progress:(SDWebImageDownloaderProgressBlock)progressBlock
                                  completed:(SDWebImageCompletedWithFinishedBlock)completedBlock;
 
+/** <NTES DIY SDWebImage>
+ * 下载图片到离线目录
+ */
+- (id<SDWebImageOperation>)downloadWithURL:(NSURL *)url options:(SDWebImageOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageCompletedWithFinishedBlock)completedBlock isEternal:(BOOL)isEternal;
+
+
 /**
  * Cancel all current opreations
  */

SDWebImage/SDWebImageManager.m

@@ -72,7 +72,20 @@ - (BOOL)diskImageExistsForURL:(NSURL *)url
     return [self.imageCache diskImageExistsWithKey:key];
 }
 
+
+
+/**
+ * <NTES DIY SDWebImage> （改动原方法）
+ */
 - (id<SDWebImageOperation>)downloadWithURL:(NSURL *)url options:(SDWebImageOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageCompletedWithFinishedBlock)completedBlock
+{
+    return [self downloadWithURL:url options:options progress:progressBlock completed:completedBlock isEternal:NO];
+}
+
+/** <NTES DIY SDWebImage>
+ * 下载图片到离线目录
+ */
+- (id<SDWebImageOperation>)downloadWithURL:(NSURL *)url options:(SDWebImageOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageCompletedWithFinishedBlock)completedBlock isEternal:(BOOL)isEternal
 {    
     // Invoking this method without a completedBlock is pointless
     NSParameterAssert(completedBlock);
@@ -200,8 +213,9 @@ - (BOOL)diskImageExistsForURL:(NSURL *)url
 
                             if (transformedImage && finished)
                             {
+                                //<NTES DIY SDWebImage>
                                 BOOL imageWasTransformed = ![transformedImage isEqual:downloadedImage];
-                                [self.imageCache storeImage:transformedImage recalculateFromImage:imageWasTransformed imageData:data forKey:key toDisk:cacheOnDisk];
+                                [self.imageCache storeImage:transformedImage recalculateFromImage:imageWasTransformed imageData:data forKey:key toDisk:cacheOnDisk isEternal:isEternal];
                             }
                         });
                     }
@@ -214,7 +228,8 @@ - (BOOL)diskImageExistsForURL:(NSURL *)url
 
                         if (downloadedImage && finished)
                         {
-                            [self.imageCache storeImage:downloadedImage recalculateFromImage:NO imageData:data forKey:key toDisk:cacheOnDisk];
+                            //<NTES DIY SDWebImage>
+                            [self.imageCache storeImage:downloadedImage recalculateFromImage:NO imageData:data forKey:key toDisk:cacheOnDisk isEternal:isEternal];
                         }
                     }
                 }
@@ -231,6 +246,23 @@ - (BOOL)diskImageExistsForURL:(NSURL *)url
         }
         else if (image)
         {
+            //<NTES DIY SDWebImage>
+            //【缓存里已有的图片未保存到离线目录里的问题】可能1:离线图片时图片已在缓存与内存中；可能2:离线图片时图片仅在内存中但不在缓存中
+            //【离线图片如果下载失败，增加恢复机制，需要外部支持，如播放页面加载下载歌曲图片时显示声明图片需要离线】
+            if(isEternal)
+            {
+                NSString *cachePath = [self.imageCache defaultCachePathForKey:key];
+                NSString *eternalPath = [self.imageCache eternalCachePathForKey:key];
+                if(![[NSFileManager defaultManager] fileExistsAtPath:eternalPath] && ![[NSFileManager defaultManager] fileExistsAtPath:cachePath])
+                {
+                    [self.imageCache storeImage:image forKey:key isEternal:YES];
+                }
+                else if(![[NSFileManager defaultManager] fileExistsAtPath:eternalPath] && [[NSFileManager defaultManager] fileExistsAtPath:cachePath])
+                {
+                    [[NSFileManager defaultManager] moveItemAtPath:cachePath toPath:eternalPath error:nil];
+                }
+            }
+            
             dispatch_main_sync_safe(^
             {
                 completedBlock(image, nil, cacheType, YES);

SDWebImage/UIButton+WebCache.h

@@ -93,6 +93,12 @@
  */
 - (void)setImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options completed:(SDWebImageCompletedBlock)completedBlock;
 
+/**
+ * <NTES DIY SDWebImage>
+ * UIButton增加离线保存图片
+ */
+- (void)setImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options completed:(SDWebImageCompletedBlock)completedBlock isEternal:(BOOL)isEternal;
+
 /**
  * Set the backgroundImageView `image` with an `url`.
  *
@@ -171,6 +177,12 @@
  */
 - (void)setBackgroundImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options completed:(SDWebImageCompletedBlock)completedBlock;
 
+/**
+ * <NTES DIY SDWebImage>
+ * UIButton增加离线保存背景图片
+ */
+- (void)setBackgroundImageWithURL:(NSURL *)url forState:(UIControlState)state placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options completed:(SDWebImageCompletedBlock)completedBlock isEternal:(BOOL)isEternal;
+
 /**
  * Cancel the current download
  */