mirrors
/
SDWebImage
mirror of https://github.com/SDWebImage/SDWebImage.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
SDWebImage/CHANGELOG.md

33 KiB
Raw Blame History

4.0.0 - New platforms (Mac OS X and watchOS) + refactoring, on Jan 28th, 2017

See all tickets marked for the 4.0.0 release Versions 4.0.0-beta and 4.0.0-beta 2 list all the changes.

4.0.0 beta 2 - New platforms (Mac OS X and watchOS) + refactoring, on Oct 6th, 2016

See all tickets marked for the 4.0.0 release

Features

  • Add an option to scale down large images #787 00bf467 efad1e5 8d1a0ae. Fixed #538, #880 and #586. This one is a more robust solution than #884 or #894. Can be activated via SDWebImageScaleDownLargeImages or SDWebImageDownloaderScaleDownLargeImages

Fixes

  • Fixed #1668 CGContextDrawImage: invalid context 0x0 - b366d84

4.0.0 beta - New platforms (Mac OS X and watchOS) + refactoring, on Oct 5th, 2016

See all tickets marked for the 4.0.0 release

Infrastructure:

  • support for watchOS and OS X platforms #1595
  • the SDWebImage xcodeproj contains the following targets:
    • SDWebImage iOS static (iOS static lib)
    • SDWebImage watchOS static (watchOS static lib)
    • SDWebImage OSX (OSX dynamic framework)
    • SDWebImage iOS (iOS dynamic framework)
    • SDWebImage tvOS (tvOS dynamic framework)
    • SDWebImage watchOS (watchOS dynamic framework)
    • the SDWebImage Demo xcodeproj contains the following targets:
      • SDWebImage OSX Demo
      • SDWebImage iOS Demo
      • SDWebImage TV Demo
      • SDWebImage Watch Demo
  • bumped libwep version to 0.5.1
  • improved unit testing code coverage (35% -> 77%) and integrated CodeCov

Backwards incompatible changes

  • removed all deprecated methods (that we carried around for backwards compatibility in previous versions) #774
  • Renamed SDWebImageManager downloadImageWithURL:options:progress:completed: to loadImageWithURL:options:progress:completed: as it makes more sense, since we check the cache first and download only if needed a32a177
  • Deleted targets: SDWebImage+MKAnnotation, SDWebImage+WebP, SDWebImageFramework:
    • SDWebImage target that build as a static library (all subspecs included) -> libSDWebImage.a
    • SDWebImageiOS and SDWebImagetvOS targets that build as dynamic frameworks
  • Renamed the dynamic frameworks targets from WebImage to SDWebImage. Renamed the WebImage.h to SDWebImage.h to match the framework naming
  • Renamed the schemes for consistency. Updated the Tests Podfile + project.
  • For #883 Fix multiple requests for same image and then canceling one, several breaking changes were needed:
    • SDWebImageDownloader method - downloadImageWithURL:options:progress:completed: now returns a SDWebImageDownloadToken * instead of id <SDWebImageOperation> (give the ability to cancel downloads using the returned token)
    • SDWebImageDownloaderOperation initializer - initWithRequest:options:progress:completed:cancelled split into - initWithRequest:options and addHandlersForProgress:completed:. Note: there is no more cancel block
  • Modern Objective-C syntax done in 64382b9 includes:
    • initializers now return instancetype instead of id
    • explicit designated initializers (i.e. for SDImageCache)
  • For #1575 GIF support using FLAnimatedImage, several changes were needed:
    • replaced type SDWebImageQueryCompletedBlock with SDCacheQueryCompletedBlock and added an NSData * param
    • because of the change above, the done param of SDImageCache queryDiskCacheForKey:done: is now a SDCacheQueryCompletedBlock and those blocks must now include an NSData * param
    • replaced type SDWebImageCompletionWithFinishedBlock with SDInternalCompletionBlock and added an NSData * param
    • because of the change above, the completed param of SDWebImageManager loadImageWithURL:options:progress:completed: is now SDInternalCompletionBlock and those blocks must now include an NSData * param
    • for consistency with the previous change, also renamed SDWebImageCompletionBlock to SDExternalCompletionBlock
    • UIImage will no longer respond to sd_animatedGIFNamed: or sd_animatedImageByScalingAndCroppingToSize:
  • Xcode 7 Objective-C updates (Lightweight Generics and Nullability) #1581
    • breaks compatibility at least for Swift users of the framework
  • watchOS and OS X support #1595 required
    • renamed SDWebImage iOS static lib target to SDWebImage iOS static for clarity
  • improving the unit tests code coverage #1681 required
    • Refactored NSData ImageContentType category, instead of returning the contentType as a string, the new added method sd_imageFormatForImageData will return a SDImageFormat enum value
    • SDImageCache configuration properties moved into SDImageCacheConfig (which is now available via config property):
      • shouldDecompressImages
      • shouldDisableiCloud
      • shouldCacheImagesInMemory
      • maxCacheAge
      • maxCacheSize
    • The storeImage: methods from SDImageCache were async already, but declared as sync. Properly marked them as async + added completion. Got rid of the recalculate param. If the NSData is provided, use it. Otherwise, recalculate from the UIImage
    • Removed the synchronous methods diskImageExistsForURL: and cachedImageExistsForURL: from SDWebImageManager
    • Removed the synchronous method diskImageExistsWithKey: from SDImageCache
    • Get rid of the confusion caused by cleanDisk and clearDisk on SDImageCache. Renamed cleanDisk to deleteOldFiles. No longer expose the sync clearDisk and deleteOldFiles, just the async ones.
    • Renamed SDImageCache queryDiskCacheForKey:done: to queryCacheOperationForKey:done:
    • Another SDImageCache clarification: imageFromDiskCacheForKey: used to also check the memory cache which I think is misleading. Now imageFromDiskCacheForKey only checks the disk cache and the new method imageFromCacheForKey checks both caches
    • Got rid of removeImageForKey: and removeImageForKey:fromDisk: from SDImageCache that looked sync but were async. Left only the 2 async ones
    • Removed UIImageView sd_cancelCurrentHighlightedImageLoad
  • Added sd_ prefix to the activity indicator related methods (setShowActivityIndicatorView:, setIndicatorStyle:, showActivityIndicatorView, addActivityIndicator, removeActivityIndicator) #1640
  • Use dispatch_main_async_safe for all the completion blocks on the main queue (used to be dispatch_sync) - avoiding locks.
  • Removed dispatch_main_sync_safe as it can be mistakenly used
  • Add url as param to progress block SDWebImageDownloaderProgressBlock - #984

Features:

  • Switched our GIF support to a better implementation: FLAnimatedImage by Flipboard #1575
    • requires iOS 8+ (it's the only way due to FLAnimatedImage requirements)
    • the implementation relies on a WebCache category on top of FLAnimatedImageView
    • details in the README
  • Converted any remaining code to Modern Objective-C syntax - 64382b9
  • Xcode 7 Objective-C updates (Lightweight Generics and Nullability) #1581
  • via #1595 Clarified and simplified the usage of TARGET_OS_* macros. Added SD_MAC, SD_UIKIT, SD_IOS, SD_TV, SD_WATCH. The biggest issue here was TARGET_OS_MAC was 1 for all platforms and we couldn't rely on it.
  • Replaces #1398 Allow to customise cache and image downloader instances used with SDWebImageManager - added a new initializer (initWithCache:downloader:) 9112170
  • UIImage responds to sd_imageData and sd_imageDataAsFormat: via the MultiFormat category. Those methods transform a UIImage to the NSData representation 82d1f2e
  • Created SDWebImageDownloaderOperationInterface to describe the behavior of a downloader operation. Any custom operation must conform to this protocol df3b6a5
  • Refactored all the duplicate code from our WebCache categories into a UIView WebCache category. All the other categories will make calls to this one. Customization of setting the image is done via the setImageBlock and the operationKey e1840c3
  • Due to the change above, the activity indicator can now be added to UIButton, MKAnnotationView, UIImageView
  • Animated WebP support #1438
  • The shared objects (not really singletons) should allow subclassing, therefore the return type of the shared resource method should be instancetype and not a fixed type - c57cf7e
  • Allow to specify NSURLSessionConfiguration for SDWebImageDownloader #1654
  • Add url as param to progress block SDWebImageDownloaderProgressBlock - #984

Fixes:

  • Fix multiple requests for same image and then canceling one #883 + 8a78586
  • Fixed #1444 and the master build thanks to @kenmaz
  • Fixed an issue with the SDWebImageDownloaderOperation : cancelInternal was not called because of the old mechanism rellying on the thread property - probably because that thread did not have a runloop. Removed that and now cancelInternal is called as expected f4bdae6
  • Replaced #781 on replacing dispatch_sync with dispatch_async for the main queue 062e50a f7e8246 c77adf4 fdb8b2c 265ace4 0c47bc3. Check for main queue instead of main thread.
  • Fixed #1619 iOS 10 crash (setObjectForKey: object cannot be nil) - #1676 7940577
  • Fixed #1326 #1424 (Carthage bitcode issue) - #1593
  • Fixed #1639 via #1657 (Add support for downloading images behind redirect)
  • Replaced #1537 via 9cd6779 - fixed a potential retain cycle
  • Updated dispatch_main_async_safe macro in order to avoid redefinition when included as Pod
  • Fixed #1089 by updating the docs on the calling queue for the progressBlock (background queue)
  • Fixed a compilation issue on FLAnimatedImageView+WebCache - #1687

3.8.2 Patch release for 3.8.0 on Sep 5th, 2016

Fixes:

  • Fixed #1608 #1623 #1644 Crash in [NSURLCache cachedResponseForRequest:] - the fix is actually avoiding to access NSURLCache which appears to generate a race condition. We only call it if necesarry (SDWebImageRefreshCached is used and the image cannot be cached by the system when it's too big or behind authentication)

3.8.1 Patch release for 3.8.0 on Jun 7th, 2016

Fixes:

  • SDWebImage 3.8.0 get wrong image #1589 - the issue was caused by the changes in 3.8.0 (Removed the URL query params from the filename (key) fb0cdb6d 1bf62d4 #1584 - fixes #1433 #1553 #1583 #1585) - Reverted.
  • Note: The solution for those issues (i.e. #1433 #1553) is to set the SDWebImageManager cacheKeyFilter block and do their own calculations there.

3.8.0 Minor release - Replaces NSURLConnection (deprecated) with NSURLSession - on Jun 6th, 2016

Infrastructure:

  • Had to update the iOS deployment target to 7.0 from 5 - 6545a3a

Features:

  • Replace deprecated NSURLConnection with NSURLSession #1578 #1586 - fixes #1291 #1318 #823 #1566 #1515
  • Allow to customise cache and image downloader instances used with SDWebImageManager 86fc47bf7b - fixes #1398 #870

Fixes:

  • Removed the URL query params from the filename (key) fb0cdb6d 1bf62d4 #1584 - fixes #1433 #1553 #1583 #1585
  • Fixed the WebP build with the official 1.0.0 CocoaPods release f1a471e - fixes #1444
  • Updated doc: removeImageForKey: not synchronous e6e5c51 - fixes #1379 #1415

3.7.6 Patch release for 3.7.0 on May 8th, 2016

Infrastructure:

  • Changed the libwebp git url so that people from China can access it - #1390 (from https://chromium.googlesource.com/webm/libwebp to https://github.com/webmproject/libwebp)

Features:

  • Added cancelAllDownloads method to SDWebImageDownloader #1504
  • Added API to save image NSData to disk cache: [SDImageCache storeImageDataToDisk:forKey:] #1453

Fixes:

  • Fix #1449: Version 3.7.5 breaks semantic versioning (removes public API). Re-added sd_setImageWithPreviousCachedImageWithURL:andPlaceholderImage:options:progress:completed: and deprecated it. Will remove it in 4.0.0 b40124c
  • Fix CGContextDrawImage: invalid context 0x0 - #1496 (fixes #1401 #1454 #1457)
  • Fix CGBitmapContextCreateImage: invalid context 0x0 - #1464 (fixes #1423)
  • Fix changed image size when loading from disk #1540 (fixes #1437)
  • Repair memory release in the iPad environment #1549 (had to switch #if TARGET_OS_IPHONE to #if TARGET_OS_IOS)
  • Fixed completion logic in MKAnnotationView+WebCache #1547
  • Optimize the decoder to avoid unwanted blended layer - #1527 (fixes #1524)
  • Protect against malformed frame for GIFs - #1447
  • updated doc: #1462 #1466 #1486 #1532 #1461

3.7.5 Patch release for 3.7.0 on Jan 21st, 2016

  • fixed #1425 and #1426 - Continuation of Fix #1366, addresses #1350 and reverts a part of #1221 - from commit 6406d8e, the wrong usage of dispatch_apply
  • fixed #1422 - Added a fallback for #976 so that if there are images saved with the old format (no extension), they can still be loaded

3.7.4 Patch release for 3.7.0 with tvOS support on Jan 8th, 2016

Updates

  • bumped libwep version to 0.4.4

Features:

  • added tvOS support #1327 and #1358 - fix #1368 and #1302

Fixes:

  • #1217 contains several of the above fixes
  • fix #391 -> option to cache only on Disk. will replace #1130
  • fix #343 -> iCloud backup Option
  • fix #371 -> CGBitmapContextCreate: unsupported parameter combination + #1268 #1412 #1340
  • fix #576 -> scale set to screen scale
  • fix #1035 -> progress queue with dispatch_async
  • new feature -> activity indicator using auto layout. The activity indicator feature will replace #131
  • #1218 progress callbacks now report on main thread - fixes #1035
  • #1321 Added a new constructor to SDWebImagePrefetcher - replaces #956
  • #976 append the original path extension to the hash filename - fixes #967
  • replaced #999 with #1221
  • added cache tests #1125
  • #1236 fixes #1203
  • bf899e2 fixes #1261 #1263 compilation issue CocoaPods vs non-CocoaPods
  • #1367 fixes a bug where image scale & orientation are ignored when decoding / decompressing an image
  • cac21e1 fixes #1366, addresses #1350 and reverts a part of #1221 - from commit 6406d8e, the wrong usage of dispatch_apply
  • #1363 fixes #1361 sd_cancelBackgroundImageLoadForState
  • #1348 Create a strong ref of weakOperation in the entry of The image download subOperation, use the strong ref instead weakOperation. At the same time, repair some logic of the 'If cancelled'
  • dcb7985 replaces #1345 - Load local credential file
  • #1323 don't to perform download if url is "" but not nil
  • #1310 Added support for SDWebImageAvoidAutoSetImage option to UIButton and highlighted UIImageView categories
  • #1308 Added Swift installation tips
  • 32923fa Xcode 7.1 updates
  • #1297 cleaner implementation of failedUrl error handling - fixes #1275
  • #1280 Fix sd_animatedImageByScalingAndCroppingToSize
  • Remove logging from the image prefetcher - #1276
  • Fix typos #1256 #1257 #1258 #1331 #1290

3.7.3 Patch release for 3.7.0 with iOS8+ framework and Carthage on Jun 13th, 2015

  • Adds support for iOS 8+ Framework and Carthage #1071 #1081 #1101

  • [Refactor] Use NSMutableSet for failed URLs' storage instead of array #1076

  • Make a constant for the error domain #1011

  • Improve operation behavior #988

  • Bug fix: Collection <__NSArrayM: > was mutated while being enumerated #985

  • added SDWebImageAvoidAutoSetImage option to avoid automatic image addition in UIImageView and let developer to do it himself #1188

  • Added support for custom disk cache folder with fall back for caches directory #1153

  • Added some files to the workspace so they are easier to edit 8431481

  • Doc update 72ed897 7f99c01 #1016 #1038 #1045

  • [Memory Issue] Clear SDWebImagePrefetcher progressBlock when it has completed #1017

  • avoid warning <Error>: ImageIO: CGImageSourceCreateWithData data parameter is nil if imageData is nil 88ee3c6 #1018

  • allow override diskCachePath #1041

  • Use __typeof(self) when assigning weak reference for block #1054

  • [Refactor] Implement cache cost calculation as a inline function #1075

  • @3x support 9620fff #1005

  • Fix parenthesis to avoid crashes #1104

  • Add NSCache countLimit property #1140

  • failedURLs can be removed at the appropriate time #1111

  • Purge NSCache on system memory notifications #1143

  • Determines at runtime is UIApplication is available as per #1082 #1085

  • Fixes http://git.chromium.org/webm/libwebp.git/info/refs not valid #1175 + Reverted #1193 + #1177

  • 404 image url was causing the test to fail 0e761f4

  • Fix for transparency being lost in transformed images. #1121

  • Add handling for additional error codes that shouldn't be considered a permanent failure #1159

  • add webp accepted content type only if WebP enabled #1178

  • fix ImageIO: CGImageSourceCreateWithData data parameter is nil #1167

  • Applied patch for issue #1074 SDWebImage residing in swift module breaks the debugger #1138

  • Fixed URLs with trailing parameters get assigned an incorrect image scale value #1157 #1158

  • Add newline to avoid compiler warning in WebImage.h #1199

3.7.2 Updated patch release for 3.7.0 on Mar 17th, 2015

Updates

  • bumped libwep version to 0.4.3

Features:

  • implement SDWebImageDownloaderAllowInvalidSSLCertificates option - #937
  • flag to transform animated images (SDWebImageTransformAnimatedImage) - #703
  • allows user to override default SDWebImageDownloaderOperation - #876
  • adds option to decompress images and select prefetcher queue - #996

Fixes:

  • fixed #809 cancelAll crash - #838
  • fixed #900 by adding a new flag SD_LOG_NONE that allows silencing the SD logs from the Prefetcher
  • fixed #895 unsafe setImage in setImageWithURL: - #896
  • fix NSNotificationCenter dispatch on subthreads - #987
  • fix SDWebImageDownloader threading issue - #1046
  • fixed duplicate failed urls are added into failedURLs - #994
  • increased default maxConcurrentOperationCount, fixes #527 - #897
  • handle empty urls NSArray - #929
  • decoding webp, depends on source image data alpha status - #936
  • fix #610 display progressive jpeg issue - #840
  • the code from SDWebImageDownloaderOperation connection:didFailWithError: should match the code from connectionDidFinishLoading:. This fixes #872 - 7f39e5e
  • 304 - Not Modified HTTP status code handling - #942
  • cost compute fix - #941
  • initialise kPNGSignatureData data - #981

Documentation

  • documentation updated

3.7.1 Patch release for 3.7.0 on Jul 23rd, 2014

  • fixed sd_imageOrientationFromImageData: crash if imageSource is nil - #819 #813 #808 #828 - temporary fix
  • fixed SDWebImageCombinedOperation cancel crash (also visible as SDWebImageManager cancelAll) - 28109c4 #798 #809
  • fixed duplicate symbols when using with webp via pods - #795
  • fixed missing mark from pragma mark - #827

3.7.0 Xcode6, arm64, highlight UIImageView, imageURL ref, NTLM, ... on Jul 14th, 2014

Features

  • Add category for imageView's highlighted state UIImageView+HighlightedWebCache - #646 #765
  • Keep a reference to the image URL - #560
  • Pass imageURL in completedBlock - #770
  • Implemented NTLM auth support. Replaced deprecated auth challenge methods from NSURLConnectionDelegate - #711 50c4d1d
  • Ability to suspend image downloaders SDWebImageDownloader setSuspended: - #734
  • Delay the loading of the placeholder image until after load - #701
  • Ability to save images to cache directly - #714
  • Support for image orientation - #764
  • Added async SDImageCache removeImageForKey:withCompletion: - #732 cd4b925
  • Exposed cache paths - #339
  • Exposed SDWebImageManager cacheKeyForURL: - 5fd21e5
  • Exposing SDWebImageManager instance from the SDWebImagePrefetcher class - 6c409cd
  • SDWebImageManager uses the shared instance of SDWebImageDownloader - 0772019
  • Refactor the cancel logic - #771 6d01e80 23874cd a6f11b3
  • Added method SDWebImageManager cachedImageExistsForURL: to check if an image exists in either the disk OR the memory cache - #644
  • Added option to use the cached image instead of the placeholder for UIImageView. Replaces #541 - #599 30f6726
  • Created workspace + added unit tests target
  • Updated documentation - #476 #384 #526 #376 a8f5627

Bugfixes

  • Fixed Xcode 6 builds - #741 0b47342
  • Fixed diskImageExistsWithKey: deadlock - #625 6e4fbaf For consistency, added async methods in SDWebImageManager cachedImageExistsForURL:completion: and diskImageExistsForURL:completion:
  • Fixed race condition that causes cancellation of one download operation to stop a run loop that is now used for another download operation. Race is introduced through performSelector:onThread:withObject:waitUntilDone: - #698
  • Fixed race condition between operation cancelation and loading finish - 39db378 #621 #783
  • Fixed race condition in SDWebImageManager if one operation is cancelled - f080e38 #699
  • Fixed issue where cancelled operations aren't removed from runningOperations - #68
  • Should not add url to failedURLs when timeout, cancel and so on - #766 #707
  • Fixed potential object mutated while being enumerated crash - #727 #728 (revert a threading fix from #727)
  • Fixed NSURLConnection response statusCode not valid (e.g. 404), downloader never stops its runloop and hangs the operation queue - #735
  • Fixed SDWebImageRefreshCached bug for large images - #744
  • Added proper handling for SDWebImageDownloaderLowPriority - #713 #745
  • Fixed fixing potential bug when sending a nil url for UIButton+WebCache - #761 #763
  • Fixed issue #529 - if the cacheKeyFilter was set, this was ignored when computing the scaledImageForKey. For most of the developers that did not set cacheKeyFilter, the code will work exactly the same - eb91fdd
  • Returning error in setImage completedBlock if the url was nil. Added dispatch_main_async_safe macro - #505 af3e4f8
  • Avoid premature completion of prefetcher if request fails - #751
  • Return nil from SDScaledImageForKey if the input image is nil - #365 #750
  • Do not load placeholder image if SDWebImageDelayPlaceholder option specified - #780
  • Make sure we call the startPrefetchingAtIndex: method from main queue - #694
  • Save image in cache before calling completion block - #700
  • Fixed arm64 warnings - #685 #720 #721 #687
  • Improved logging - #721
  • Added SDWebImageCompat.m to SDWebImage+MKAnnotation target

3.6 Fix and cleanup on Mar 24th, 2014

3.5.4 ARM64 Support on Feb 24th, 2014

3.5.3 on Jan 7th, 2014

3.5.2 on Jan 2nd, 2014

3.5.1 on Dec 3rd, 2013

3.5 WebP Target, iOS 7, Fixes on Oct 4th, 2013

  • Fix iOS 7 related issues
  • Move WebP support to a dedicated target
  • Removed strong reference to UIImageView which was causing a crash in the nested block
  • Fix timeout issue
  • Add some methods that allow to check if an image exists on disk without taking it off disk and decompressing it first

3.4 Animated image category, bug fixes on Aug 13th, 2013

  • Add calculateSizeWithCompletionBlock
  • Add multiple download of images for animationImages property of UIImageView
  • Add background task for disk cleanup #306
  • Fix dead thread issue on iOS 5 #444, #399, #466
  • Make IO operations cancelable to fix perf issue with heavy images #462
  • Fix crash Collection <__NSArrayM: ...> was mutated while being enumerated. #471

3.3 WebP, Animated GIF and more on Jun 14th, 2013

  • WebP image format support #410
  • Animated GIF support #375
  • Custom image cache search paths #156
  • Bug fixes

3.2 Bug fixes on Mar 13th, 2013

  • SDWebImageRefreshCached download option #326
  • New SDWebImageManager delegate methods ebd63a88c1
  • Fix long standing issue with alpha en JPEGs #299
  • Add synchronous disk-cache loading method #297
  • Fix SDWebImageCacheMemoryOnly flag
  • Bug fixes

3.1 Bug fixes on Jan 21st, 2013

3.0 Complete rewrite on Nov 29th, 2012

  • Complete rewrite of the library using GCD, ARC, NSCache and blocks
  • Drop compatibility with iOS 3 and 4

2.7.4 Bug fixes on Nov 14th, 2012

2.7.3 on Nov 3rd, 2012

2.7.2 on Oct 23rd, 2012

2.7.1 on Oct 19th, 2012

2.7 on Sep 8th, 2012

2.6 on May 4th, 2012

2.5 on Mar 22nd, 2012

2.4 on Oct 1st, 2011

2.3 on Sep 16th, 2010

2.2 on Aug 29th, 2010

2.1.0 on Jun 12th, 2010

2.1 on Jun 12th, 2010

2.0.0 on Jun 9th, 2010

2.0 on Jun 9th, 2010

1.0.0 on Dec 31st, 2009

1.0 on Dec 31st, 2009