/
Request+AlamofireImage.swift
236 lines (198 loc) · 10 KB
/
Request+AlamofireImage.swift
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
//
// Request+AlamofireImage.swift
//
// Copyright (c) 2015 Alamofire Software Foundation (http://alamofire.org/)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
import Alamofire
import Foundation
#if os(iOS) || os(tvOS)
import UIKit
#elseif os(watchOS)
import UIKit
import WatchKit
#elseif os(macOS)
import Cocoa
#endif
public final class ImageResponseSerializer: ResponseSerializer {
// MARK: Properties
public static var deviceScreenScale: CGFloat { DataRequest.imageScale }
public let imageScale: CGFloat
public let inflateResponseImage: Bool
public let emptyResponseCodes: Set<Int>
public let emptyRequestMethods: Set<HTTPMethod>
static var acceptableImageContentTypes: Set<String> = {
var contentTypes: Set<String> = ["application/octet-stream",
"image/tiff",
"image/jpg",
"image/jpeg",
"image/jp2",
"image/gif",
"image/png",
"image/ico",
"image/x-icon",
"image/bmp",
"image/x-bmp",
"image/x-xbitmap",
"image/x-ms-bmp",
"image/x-win-bitmap"]
#if os(macOS) || os(iOS) // No WebP support on tvOS or watchOS.
if #available(macOS 11, iOS 14, *) {
contentTypes.formUnion(["image/webp"])
}
#endif
if #available(macOS 10.13, iOS 11, tvOS 11, watchOS 4, *) {
contentTypes.formUnion(["image/heic", "image/heif"])
}
return contentTypes
}()
static let streamImageInitialBytePattern = Data([255, 216]) // 0xffd8
// MARK: Initialization
public init(imageScale: CGFloat = ImageResponseSerializer.deviceScreenScale,
inflateResponseImage: Bool = true,
emptyResponseCodes: Set<Int> = ImageResponseSerializer.defaultEmptyResponseCodes,
emptyRequestMethods: Set<HTTPMethod> = ImageResponseSerializer.defaultEmptyRequestMethods) {
self.imageScale = imageScale
self.inflateResponseImage = inflateResponseImage
self.emptyResponseCodes = emptyResponseCodes
self.emptyRequestMethods = emptyRequestMethods
}
// MARK: Serialization
public func serialize(request: URLRequest?, response: HTTPURLResponse?, data: Data?, error: Error?) throws -> Image {
guard error == nil else { throw error! }
guard let data = data, !data.isEmpty else {
guard emptyResponseAllowed(forRequest: request, response: response) else {
throw AFError.responseSerializationFailed(reason: .inputDataNilOrZeroLength)
}
print("Returning empty image!")
return Image()
}
try validateContentType(for: request, response: response)
let image = try serializeImage(from: data)
return image
}
public func serializeImage(from data: Data) throws -> Image {
guard !data.isEmpty else {
throw AFError.responseSerializationFailed(reason: .inputDataNilOrZeroLength)
}
#if os(iOS) || os(tvOS) || os(watchOS)
guard let image = UIImage.af.threadSafeImage(with: data, scale: imageScale) else {
throw AFIError.imageSerializationFailed
}
if inflateResponseImage { image.af.inflate() }
#elseif os(macOS)
guard let bitmapImage = NSBitmapImageRep(data: data) else {
throw AFIError.imageSerializationFailed
}
let image = NSImage(size: NSSize(width: bitmapImage.pixelsWide, height: bitmapImage.pixelsHigh))
image.addRepresentation(bitmapImage)
#endif
return image
}
// MARK: Content Type Validation
/// Adds the content types specified to the list of acceptable images content types for validation.
///
/// - parameter contentTypes: The additional content types.
public class func addAcceptableImageContentTypes(_ contentTypes: Set<String>) {
ImageResponseSerializer.acceptableImageContentTypes.formUnion(contentTypes)
}
public func validateContentType(for request: URLRequest?, response: HTTPURLResponse?) throws {
if let url = request?.url, url.isFileURL { return }
guard let mimeType = response?.mimeType else {
let contentTypes = Array(ImageResponseSerializer.acceptableImageContentTypes)
throw AFError.responseValidationFailed(reason: .missingContentType(acceptableContentTypes: contentTypes))
}
guard ImageResponseSerializer.acceptableImageContentTypes.contains(mimeType) else {
let contentTypes = Array(ImageResponseSerializer.acceptableImageContentTypes)
throw AFError.responseValidationFailed(
reason: .unacceptableContentType(acceptableContentTypes: contentTypes, responseContentType: mimeType)
)
}
}
}
// MARK: - Image Scale
extension DataRequest {
public class var imageScale: CGFloat {
#if os(iOS) || os(tvOS)
return UIScreen.main.scale
#elseif os(watchOS)
return WKInterfaceDevice.current().screenScale
#elseif os(macOS)
return 1.0
#endif
}
}
// MARK: - iOS, tvOS, and watchOS
#if os(iOS) || os(tvOS) || os(watchOS)
extension DataRequest {
/// Adds a response handler to be called once the request has finished.
///
/// - parameter imageScale: The scale factor used when interpreting the image data to construct
/// `responseImage`. Specifying a scale factor of 1.0 results in an image whose
/// size matches the pixel-based dimensions of the image. Applying a different
/// scale factor changes the size of the image as reported by the size property.
/// This is set to the value of scale of the main screen by default, which
/// automatically scales images for retina displays, for instance.
/// `Screen.scale` by default.
/// - parameter inflateResponseImage: Whether to automatically inflate response image data for compressed formats
/// (such as PNG or JPEG). Enabling this can significantly improve drawing
/// performance as it allows a bitmap representation to be constructed in the
/// background rather than on the main thread. `true` by default.
/// - parameter queue: The queue on which the completion handler is dispatched. `.main` by default.
/// - parameter completionHandler: A closure to be executed once the request has finished. The closure takes 4
/// arguments: the URL request, the URL response, if one was received, the image,
/// if one could be created from the URL response and data, and any error produced
/// while creating the image.
///
/// - returns: The request.
@discardableResult
public func responseImage(imageScale: CGFloat = DataRequest.imageScale,
inflateResponseImage: Bool = true,
queue: DispatchQueue = .main,
completionHandler: @escaping (AFDataResponse<Image>) -> Void)
-> Self {
response(queue: queue,
responseSerializer: ImageResponseSerializer(imageScale: imageScale,
inflateResponseImage: inflateResponseImage),
completionHandler: completionHandler)
}
}
// MARK: - macOS
#elseif os(macOS)
extension DataRequest {
/// Adds a response handler to be called once the request has finished.
///
/// - Parameters:
/// - queue: The queue on which the completion handler is dispatched. `.main` by default.
/// - completionHandler: A closure to be executed once the request has finished. The closure takes 4 arguments:
/// the URL request, the URL response, if one was received, the image, if one could be
/// created from the URL response and data, and any error produced while creating the image.
///
/// - returns: The request.
@discardableResult
public func responseImage(queue: DispatchQueue = .main,
completionHandler: @escaping (AFDataResponse<Image>) -> Void)
-> Self {
response(queue: queue,
responseSerializer: ImageResponseSerializer(inflateResponseImage: false),
completionHandler: completionHandler)
}
}
#endif