SessionManager.swift 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750
  1. //
  2. // SessionManager.swift
  3. //
  4. // Copyright (c) 2014-2016 Alamofire Software Foundation (http://alamofire.org/)
  5. //
  6. // Permission is hereby granted, free of charge, to any person obtaining a copy
  7. // of this software and associated documentation files (the "Software"), to deal
  8. // in the Software without restriction, including without limitation the rights
  9. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. // copies of the Software, and to permit persons to whom the Software is
  11. // furnished to do so, subject to the following conditions:
  12. //
  13. // The above copyright notice and this permission notice shall be included in
  14. // all copies or substantial portions of the Software.
  15. //
  16. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22. // THE SOFTWARE.
  23. //
  24. import Foundation
  25. /// Responsible for creating and managing `Request` objects, as well as their underlying `NSURLSession`.
  26. open class SessionManager {
  27. // MARK: - Helper Types
  28. /// Defines whether the `MultipartFormData` encoding was successful and contains result of the encoding as
  29. /// associated values.
  30. ///
  31. /// - Success: Represents a successful `MultipartFormData` encoding and contains the new `UploadRequest` along with
  32. /// streaming information.
  33. /// - Failure: Used to represent a failure in the `MultipartFormData` encoding and also contains the encoding
  34. /// error.
  35. public enum MultipartFormDataEncodingResult {
  36. case success(request: UploadRequest, streamingFromDisk: Bool, streamFileURL: URL?)
  37. case failure(Error)
  38. }
  39. // MARK: - Properties
  40. /// A default instance of `SessionManager`, used by top-level Alamofire request methods, and suitable for use
  41. /// directly for any ad hoc requests.
  42. open static let `default`: SessionManager = {
  43. let configuration = URLSessionConfiguration.default
  44. configuration.httpAdditionalHeaders = SessionManager.defaultHTTPHeaders
  45. return SessionManager(configuration: configuration)
  46. }()
  47. /// Creates default values for the "Accept-Encoding", "Accept-Language" and "User-Agent" headers.
  48. open static let defaultHTTPHeaders: HTTPHeaders = {
  49. // Accept-Encoding HTTP Header; see https://tools.ietf.org/html/rfc7230#section-4.2.3
  50. let acceptEncoding: String = "gzip;q=1.0, compress;q=0.5"
  51. // Accept-Language HTTP Header; see https://tools.ietf.org/html/rfc7231#section-5.3.5
  52. let acceptLanguage = Locale.preferredLanguages.prefix(6).enumerated().map { index, languageCode in
  53. let quality = 1.0 - (Double(index) * 0.1)
  54. return "\(languageCode);q=\(quality)"
  55. }.joined(separator: ", ")
  56. // User-Agent Header; see https://tools.ietf.org/html/rfc7231#section-5.5.3
  57. // Example: `iOS Example/1.0 (com.alamofire.iOS-Example; build:1; iOS 9.3.0) Alamofire/3.4.2`
  58. let userAgent: String = {
  59. if let info = Bundle.main.infoDictionary {
  60. let executable = info[kCFBundleExecutableKey as String] as? String ?? "Unknown"
  61. let bundle = info[kCFBundleIdentifierKey as String] as? String ?? "Unknown"
  62. let appVersion = info["CFBundleShortVersionString"] as? String ?? "Unknown"
  63. let appBuild = info[kCFBundleVersionKey as String] as? String ?? "Unknown"
  64. let osNameVersion: String = {
  65. let version = ProcessInfo.processInfo.operatingSystemVersion
  66. let versionString = "\(version.majorVersion).\(version.minorVersion).\(version.patchVersion)"
  67. let osName: String = {
  68. #if os(iOS)
  69. return "iOS"
  70. #elseif os(watchOS)
  71. return "watchOS"
  72. #elseif os(tvOS)
  73. return "tvOS"
  74. #elseif os(OSX)
  75. return "OS X"
  76. #elseif os(Linux)
  77. return "Linux"
  78. #else
  79. return "Unknown"
  80. #endif
  81. }()
  82. return "\(osName) \(versionString)"
  83. }()
  84. let alamofireVersion: String = {
  85. guard
  86. let afInfo = Bundle(for: SessionManager.self).infoDictionary,
  87. let build = afInfo["CFBundleShortVersionString"]
  88. else { return "Unknown" }
  89. return "Alamofire/\(build)"
  90. }()
  91. return "\(executable)/\(appVersion) (\(bundle); build:\(appBuild); \(osNameVersion)) \(alamofireVersion)"
  92. }
  93. return "Alamofire"
  94. }()
  95. return [
  96. "Accept-Encoding": acceptEncoding,
  97. "Accept-Language": acceptLanguage,
  98. "User-Agent": userAgent
  99. ]
  100. }()
  101. /// Default memory threshold used when encoding `MultipartFormData` in bytes.
  102. open static let multipartFormDataEncodingMemoryThreshold: UInt64 = 10_000_000
  103. /// The underlying session.
  104. open let session: URLSession
  105. /// The session delegate handling all the task and session delegate callbacks.
  106. open let delegate: SessionDelegate
  107. /// Whether to start requests immediately after being constructed. `true` by default.
  108. open var startRequestsImmediately: Bool = true
  109. /// The request adapter called each time a new request is created.
  110. open var adapter: RequestAdapter?
  111. /// The request retrier called each time a request encounters an error to determine whether to retry the request.
  112. open var retrier: RequestRetrier? {
  113. get { return delegate.retrier }
  114. set { delegate.retrier = newValue }
  115. }
  116. /// The background completion handler closure provided by the UIApplicationDelegate
  117. /// `application:handleEventsForBackgroundURLSession:completionHandler:` method. By setting the background
  118. /// completion handler, the SessionDelegate `sessionDidFinishEventsForBackgroundURLSession` closure implementation
  119. /// will automatically call the handler.
  120. ///
  121. /// If you need to handle your own events before the handler is called, then you need to override the
  122. /// SessionDelegate `sessionDidFinishEventsForBackgroundURLSession` and manually call the handler when finished.
  123. ///
  124. /// `nil` by default.
  125. open var backgroundCompletionHandler: (() -> Void)?
  126. let queue = DispatchQueue(label: "org.alamofire.session-manager." + UUID().uuidString)
  127. // MARK: - Lifecycle
  128. /// Creates an instance with the specified `configuration`, `delegate` and `serverTrustPolicyManager`.
  129. ///
  130. /// - parameter configuration: The configuration used to construct the managed session.
  131. /// `URLSessionConfiguration.default` by default.
  132. /// - parameter delegate: The delegate used when initializing the session. `SessionDelegate()` by
  133. /// default.
  134. /// - parameter serverTrustPolicyManager: The server trust policy manager to use for evaluating all server trust
  135. /// challenges. `nil` by default.
  136. ///
  137. /// - returns: The new `SessionManager` instance.
  138. public init(
  139. configuration: URLSessionConfiguration = URLSessionConfiguration.default,
  140. delegate: SessionDelegate = SessionDelegate(),
  141. serverTrustPolicyManager: ServerTrustPolicyManager? = nil)
  142. {
  143. self.delegate = delegate
  144. self.session = URLSession(configuration: configuration, delegate: delegate, delegateQueue: nil)
  145. commonInit(serverTrustPolicyManager: serverTrustPolicyManager)
  146. }
  147. /// Creates an instance with the specified `session`, `delegate` and `serverTrustPolicyManager`.
  148. ///
  149. /// - parameter session: The URL session.
  150. /// - parameter delegate: The delegate of the URL session. Must equal the URL session's delegate.
  151. /// - parameter serverTrustPolicyManager: The server trust policy manager to use for evaluating all server trust
  152. /// challenges. `nil` by default.
  153. ///
  154. /// - returns: The new `SessionManager` instance if the URL session's delegate matches; `nil` otherwise.
  155. public init?(
  156. session: URLSession,
  157. delegate: SessionDelegate,
  158. serverTrustPolicyManager: ServerTrustPolicyManager? = nil)
  159. {
  160. guard delegate === session.delegate else { return nil }
  161. self.delegate = delegate
  162. self.session = session
  163. commonInit(serverTrustPolicyManager: serverTrustPolicyManager)
  164. }
  165. private func commonInit(serverTrustPolicyManager: ServerTrustPolicyManager?) {
  166. session.serverTrustPolicyManager = serverTrustPolicyManager
  167. delegate.sessionManager = self
  168. delegate.sessionDidFinishEventsForBackgroundURLSession = { [weak self] session in
  169. guard let strongSelf = self else { return }
  170. DispatchQueue.main.async { strongSelf.backgroundCompletionHandler?() }
  171. }
  172. }
  173. deinit {
  174. session.invalidateAndCancel()
  175. }
  176. // MARK: - Data Request
  177. /// Creates a `DataRequest` to retrieve the contents of a URL based on the specified `urlString`, `method`,
  178. /// `parameters`, `encoding` and `headers`.
  179. ///
  180. /// - parameter urlString: The URL string.
  181. /// - parameter method: The HTTP method. `.get` by default.
  182. /// - parameter parameters: The parameters. `nil` by default.
  183. /// - parameter encoding: The parameter encoding. `URLEncoding.default` by default.
  184. /// - parameter headers: The HTTP headers. `nil` by default.
  185. ///
  186. /// - returns: The created `DataRequest`.
  187. @discardableResult
  188. open func request(
  189. _ urlString: URLStringConvertible,
  190. method: HTTPMethod = .get,
  191. parameters: Parameters? = nil,
  192. encoding: ParameterEncoding = URLEncoding.default,
  193. headers: HTTPHeaders? = nil)
  194. -> DataRequest
  195. {
  196. do {
  197. let urlRequest = try URLRequest(urlString: urlString, method: method, headers: headers)
  198. let encodedURLRequest = try encoding.encode(urlRequest, with: parameters)
  199. return request(resource: encodedURLRequest)
  200. } catch {
  201. return DataRequest(session: session, requestType: .data, error: error)
  202. }
  203. }
  204. /// Creates a `DataRequest` to retrieve the contents of a URL based on the specified `urlRequest`.
  205. ///
  206. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  207. ///
  208. /// - parameter urlRequest: The URL request.
  209. ///
  210. /// - returns: The created `DataRequest`.
  211. open func request(resource urlRequest: URLRequestConvertible) -> DataRequest {
  212. do {
  213. let originalRequest = try urlRequest.asURLRequest()
  214. let originalTask = DataRequest.Requestable(urlRequest: originalRequest)
  215. let task = try originalTask.task(session: session, adapter: adapter, queue: queue)
  216. let request = DataRequest(session: session, requestType: .data, task: task, originalTask: originalTask)
  217. delegate[task] = request
  218. if startRequestsImmediately { request.resume() }
  219. return request
  220. } catch {
  221. return DataRequest(session: session, requestType: .data, error: error)
  222. }
  223. }
  224. // MARK: - Download Request
  225. // MARK: URL Request
  226. /// Creates a `DownloadRequest` to retrieve the contents of a URL based on the specified `urlString`, `method`,
  227. /// `parameters`, `encoding`, `headers` and save them to the `destination`.
  228. ///
  229. /// If `destination` is not specified, the contents will remain in the temporary location determined by the
  230. /// underlying URL session.
  231. ///
  232. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  233. ///
  234. /// - parameter urlString: The URL string.
  235. /// - parameter method: The HTTP method. `.get` by default.
  236. /// - parameter parameters: The parameters. `nil` by default.
  237. /// - parameter encoding: The parameter encoding. `URLEncoding.default` by default.
  238. /// - parameter headers: The HTTP headers. `nil` by default.
  239. /// - parameter destination: The closure used to determine the destination of the downloaded file. `nil` by default.
  240. ///
  241. /// - returns: The created `DownloadRequest`.
  242. @discardableResult
  243. open func download(
  244. _ urlString: URLStringConvertible,
  245. method: HTTPMethod = .get,
  246. parameters: Parameters? = nil,
  247. encoding: ParameterEncoding = URLEncoding.default,
  248. headers: HTTPHeaders? = nil,
  249. to destination: DownloadRequest.DownloadFileDestination? = nil)
  250. -> DownloadRequest
  251. {
  252. do {
  253. let urlRequest = try URLRequest(urlString: urlString, method: method, headers: headers)
  254. let encodedURLRequest = try encoding.encode(urlRequest, with: parameters)
  255. return download(resource: encodedURLRequest, to: destination)
  256. } catch {
  257. return DownloadRequest(session: session, requestType: .download, error: error)
  258. }
  259. }
  260. /// Creates a `DownloadRequest` to retrieve the contents of a URL based on the specified `urlRequest` and save
  261. /// them to the `destination`.
  262. ///
  263. /// If `destination` is not specified, the contents will remain in the temporary location determined by the
  264. /// underlying URL session.
  265. ///
  266. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  267. ///
  268. /// - parameter urlRequest: The URL request
  269. /// - parameter destination: The closure used to determine the destination of the downloaded file. `nil` by default.
  270. ///
  271. /// - returns: The created `DownloadRequest`.
  272. @discardableResult
  273. open func download(
  274. resource urlRequest: URLRequestConvertible,
  275. to destination: DownloadRequest.DownloadFileDestination? = nil)
  276. -> DownloadRequest
  277. {
  278. do {
  279. let urlRequest = try urlRequest.asURLRequest()
  280. return download(.request(urlRequest), to: destination)
  281. } catch {
  282. return DownloadRequest(session: session, requestType: .download, error: error)
  283. }
  284. }
  285. // MARK: Resume Data
  286. /// Creates a `DownloadRequest` from the `resumeData` produced from a previous request cancellation to retrieve
  287. /// the contents of the original request and save them to the `destination`.
  288. ///
  289. /// If `destination` is not specified, the contents will remain in the temporary location determined by the
  290. /// underlying URL session.
  291. ///
  292. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  293. ///
  294. /// - parameter resumeData: The resume data. This is an opaque data blob produced by `URLSessionDownloadTask`
  295. /// when a task is cancelled. See `URLSession -downloadTask(withResumeData:)` for
  296. /// additional information.
  297. /// - parameter destination: The closure used to determine the destination of the downloaded file. `nil` by default.
  298. ///
  299. /// - returns: The created `DownloadRequest`.
  300. @discardableResult
  301. open func download(
  302. resourceWithin resumeData: Data,
  303. to destination: DownloadRequest.DownloadFileDestination? = nil)
  304. -> DownloadRequest
  305. {
  306. return download(.resumeData(resumeData), to: destination)
  307. }
  308. // MARK: Private - Download Implementation
  309. private func download(
  310. _ downloadable: DownloadRequest.Downloadable,
  311. to destination: DownloadRequest.DownloadFileDestination?)
  312. -> DownloadRequest
  313. {
  314. do {
  315. let task = try downloadable.task(session: session, adapter: adapter, queue: queue)
  316. let request = DownloadRequest(session: session, requestType: .download, task: task, originalTask: downloadable)
  317. request.downloadDelegate.destination = destination
  318. delegate[task] = request
  319. if startRequestsImmediately { request.resume() }
  320. return request
  321. } catch {
  322. return DownloadRequest(session: session, requestType: .download, error: error)
  323. }
  324. }
  325. // MARK: - Upload Request
  326. // MARK: File
  327. /// Creates an `UploadRequest` from the specified `method`, `urlString` and `headers` for uploading the `file`.
  328. ///
  329. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  330. ///
  331. /// - parameter file: The file to upload.
  332. /// - parameter urlString: The URL string.
  333. /// - parameter method: The HTTP method. `.post` by default.
  334. /// - parameter headers: The HTTP headers. `nil` by default.
  335. ///
  336. /// - returns: The created `UploadRequest`.
  337. @discardableResult
  338. open func upload(
  339. _ fileURL: URL,
  340. to urlString: URLStringConvertible,
  341. method: HTTPMethod = .post,
  342. headers: HTTPHeaders? = nil)
  343. -> UploadRequest
  344. {
  345. do {
  346. let urlRequest = try URLRequest(urlString: urlString, method: method, headers: headers)
  347. return upload(fileURL, with: urlRequest)
  348. } catch {
  349. return UploadRequest(session: session, requestType: .upload, error: error)
  350. }
  351. }
  352. /// Creates a `UploadRequest` from the specified `urlRequest` for uploading the `file`.
  353. ///
  354. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  355. ///
  356. /// - parameter file: The file to upload.
  357. /// - parameter urlRequest: The URL request.
  358. ///
  359. /// - returns: The created `UploadRequest`.
  360. @discardableResult
  361. open func upload(_ fileURL: URL, with urlRequest: URLRequestConvertible) -> UploadRequest {
  362. do {
  363. let urlRequest = try urlRequest.asURLRequest()
  364. return upload(.file(fileURL, urlRequest))
  365. } catch {
  366. return UploadRequest(session: session, requestType: .upload, error: error)
  367. }
  368. }
  369. // MARK: Data
  370. /// Creates an `UploadRequest` from the specified `method`, `urlString` and `headers` for uploading the `data`.
  371. ///
  372. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  373. ///
  374. /// - parameter data: The data to upload.
  375. /// - parameter urlString: The URL string.
  376. /// - parameter method: The HTTP method. `.post` by default.
  377. /// - parameter headers: The HTTP headers. `nil` by default.
  378. ///
  379. /// - returns: The created `UploadRequest`.
  380. @discardableResult
  381. open func upload(
  382. _ data: Data,
  383. to urlString: URLStringConvertible,
  384. method: HTTPMethod = .post,
  385. headers: HTTPHeaders? = nil)
  386. -> UploadRequest
  387. {
  388. do {
  389. let urlRequest = try URLRequest(urlString: urlString, method: method, headers: headers)
  390. return upload(data, with: urlRequest)
  391. } catch {
  392. return UploadRequest(session: session, requestType: .upload, error: error)
  393. }
  394. }
  395. /// Creates an `UploadRequest` from the specified `urlRequest` for uploading the `data`.
  396. ///
  397. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  398. ///
  399. /// - parameter data: The data to upload.
  400. /// - parameter urlRequest: The URL request.
  401. ///
  402. /// - returns: The created `UploadRequest`.
  403. @discardableResult
  404. open func upload(_ data: Data, with urlRequest: URLRequestConvertible) -> UploadRequest {
  405. do {
  406. let urlRequest = try urlRequest.asURLRequest()
  407. return upload(.data(data, urlRequest))
  408. } catch {
  409. return UploadRequest(session: session, requestType: .upload, error: error)
  410. }
  411. }
  412. // MARK: InputStream
  413. /// Creates an `UploadRequest` from the specified `method`, `urlString` and `headers` for uploading the `stream`.
  414. ///
  415. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  416. ///
  417. /// - parameter stream: The stream to upload.
  418. /// - parameter urlString: The URL string.
  419. /// - parameter method: The HTTP method. `.post` by default.
  420. /// - parameter headers: The HTTP headers. `nil` by default.
  421. ///
  422. /// - returns: The created `UploadRequest`.
  423. @discardableResult
  424. open func upload(
  425. _ stream: InputStream,
  426. to urlString: URLStringConvertible,
  427. method: HTTPMethod = .post,
  428. headers: HTTPHeaders? = nil)
  429. -> UploadRequest
  430. {
  431. do {
  432. let urlRequest = try URLRequest(urlString: urlString, method: method, headers: headers)
  433. return upload(stream, with: urlRequest)
  434. } catch {
  435. return UploadRequest(session: session, requestType: .upload, error: error)
  436. }
  437. }
  438. /// Creates an `UploadRequest` from the specified `urlRequest` for uploading the `stream`.
  439. ///
  440. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  441. ///
  442. /// - parameter stream: The stream to upload.
  443. /// - parameter urlRequest: The URL request.
  444. ///
  445. /// - returns: The created `UploadRequest`.
  446. @discardableResult
  447. open func upload(_ stream: InputStream, with urlRequest: URLRequestConvertible) -> UploadRequest {
  448. do {
  449. let urlRequest = try urlRequest.asURLRequest()
  450. return upload(.stream(stream, urlRequest))
  451. } catch {
  452. return UploadRequest(session: session, requestType: .upload, error: error)
  453. }
  454. }
  455. // MARK: MultipartFormData
  456. /// Encodes `multipartFormData` using `encodingMemoryThreshold` and calls `encodingCompletion` with new
  457. /// `UploadRequest` using the `method`, `urlString` and `headers`.
  458. ///
  459. /// It is important to understand the memory implications of uploading `MultipartFormData`. If the cummulative
  460. /// payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
  461. /// efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
  462. /// be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
  463. /// footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
  464. /// used for larger payloads such as video content.
  465. ///
  466. /// The `encodingMemoryThreshold` parameter allows Alamofire to automatically determine whether to encode in-memory
  467. /// or stream from disk. If the content length of the `MultipartFormData` is below the `encodingMemoryThreshold`,
  468. /// encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
  469. /// during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
  470. /// technique was used.
  471. ///
  472. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  473. ///
  474. /// - parameter multipartFormData: The closure used to append body parts to the `MultipartFormData`.
  475. /// - parameter encodingMemoryThreshold: The encoding memory threshold in bytes.
  476. /// `multipartFormDataEncodingMemoryThreshold` by default.
  477. /// - parameter urlString: The URL string.
  478. /// - parameter method: The HTTP method. `.post` by default.
  479. /// - parameter headers: The HTTP headers. `nil` by default.
  480. /// - parameter encodingCompletion: The closure called when the `MultipartFormData` encoding is complete.
  481. open func upload(
  482. multipartFormData: @escaping (MultipartFormData) -> Void,
  483. usingThreshold encodingMemoryThreshold: UInt64 = SessionManager.multipartFormDataEncodingMemoryThreshold,
  484. to urlString: URLStringConvertible,
  485. method: HTTPMethod = .post,
  486. headers: HTTPHeaders? = nil,
  487. encodingCompletion: ((MultipartFormDataEncodingResult) -> Void)?)
  488. {
  489. do {
  490. let urlRequest = try URLRequest(urlString: urlString, method: method, headers: headers)
  491. return upload(
  492. multipartFormData: multipartFormData,
  493. usingThreshold: encodingMemoryThreshold,
  494. with: urlRequest,
  495. encodingCompletion: encodingCompletion
  496. )
  497. } catch {
  498. DispatchQueue.main.async { encodingCompletion?(.failure(error)) }
  499. }
  500. }
  501. /// Encodes `multipartFormData` using `encodingMemoryThreshold` and calls `encodingCompletion` with new
  502. /// `UploadRequest` using the `urlRequest`.
  503. ///
  504. /// It is important to understand the memory implications of uploading `MultipartFormData`. If the cummulative
  505. /// payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
  506. /// efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
  507. /// be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
  508. /// footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
  509. /// used for larger payloads such as video content.
  510. ///
  511. /// The `encodingMemoryThreshold` parameter allows Alamofire to automatically determine whether to encode in-memory
  512. /// or stream from disk. If the content length of the `MultipartFormData` is below the `encodingMemoryThreshold`,
  513. /// encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
  514. /// during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
  515. /// technique was used.
  516. ///
  517. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  518. ///
  519. /// - parameter multipartFormData: The closure used to append body parts to the `MultipartFormData`.
  520. /// - parameter encodingMemoryThreshold: The encoding memory threshold in bytes.
  521. /// `multipartFormDataEncodingMemoryThreshold` by default.
  522. /// - parameter urlRequest: The URL request.
  523. /// - parameter encodingCompletion: The closure called when the `MultipartFormData` encoding is complete.
  524. open func upload(
  525. multipartFormData: @escaping (MultipartFormData) -> Void,
  526. usingThreshold encodingMemoryThreshold: UInt64 = SessionManager.multipartFormDataEncodingMemoryThreshold,
  527. with urlRequest: URLRequestConvertible,
  528. encodingCompletion: ((MultipartFormDataEncodingResult) -> Void)?)
  529. {
  530. DispatchQueue.global(qos: .utility).async {
  531. let formData = MultipartFormData()
  532. multipartFormData(formData)
  533. do {
  534. var urlRequestWithContentType = try urlRequest.asURLRequest()
  535. urlRequestWithContentType.setValue(formData.contentType, forHTTPHeaderField: "Content-Type")
  536. let isBackgroundSession = self.session.configuration.identifier != nil
  537. if formData.contentLength < encodingMemoryThreshold && !isBackgroundSession {
  538. let data = try formData.encode()
  539. let encodingResult = MultipartFormDataEncodingResult.success(
  540. request: self.upload(data, with: urlRequestWithContentType),
  541. streamingFromDisk: false,
  542. streamFileURL: nil
  543. )
  544. DispatchQueue.main.async { encodingCompletion?(encodingResult) }
  545. } else {
  546. let fileManager = FileManager.default
  547. let tempDirectoryURL = URL(fileURLWithPath: NSTemporaryDirectory())
  548. let directoryURL = tempDirectoryURL.appendingPathComponent("org.alamofire.manager/multipart.form.data")
  549. let fileName = UUID().uuidString
  550. let fileURL = directoryURL.appendingPathComponent(fileName)
  551. var directoryError: Error?
  552. // Create directory inside serial queue to ensure two threads don't do this in parallel
  553. self.queue.sync {
  554. do {
  555. try fileManager.createDirectory(at: directoryURL, withIntermediateDirectories: true, attributes: nil)
  556. } catch {
  557. directoryError = error
  558. }
  559. }
  560. if let directoryError = directoryError { throw directoryError }
  561. try formData.writeEncodedData(to: fileURL)
  562. DispatchQueue.main.async {
  563. let encodingResult = MultipartFormDataEncodingResult.success(
  564. request: self.upload(fileURL, with: urlRequestWithContentType),
  565. streamingFromDisk: true,
  566. streamFileURL: fileURL
  567. )
  568. encodingCompletion?(encodingResult)
  569. }
  570. }
  571. } catch {
  572. DispatchQueue.main.async { encodingCompletion?(.failure(error)) }
  573. }
  574. }
  575. }
  576. // MARK: Private - Upload Implementation
  577. private func upload(_ uploadable: UploadRequest.Uploadable) -> UploadRequest {
  578. do {
  579. let task = try uploadable.task(session: session, adapter: adapter, queue: queue)
  580. let request = UploadRequest(session: session, requestType: .upload, task: task, originalTask: uploadable)
  581. if case let .stream(inputStream, _) = uploadable {
  582. request.delegate.taskNeedNewBodyStream = { _, _ in inputStream }
  583. }
  584. delegate[task] = request
  585. if startRequestsImmediately { request.resume() }
  586. return request
  587. } catch {
  588. return UploadRequest(session: session, requestType: .upload, error: error)
  589. }
  590. }
  591. #if !os(watchOS)
  592. // MARK: - Stream Request
  593. // MARK: Hostname and Port
  594. /// Creates a `StreamRequest` for bidirectional streaming using the `hostname` and `port`.
  595. ///
  596. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  597. ///
  598. /// - parameter hostName: The hostname of the server to connect to.
  599. /// - parameter port: The port of the server to connect to.
  600. ///
  601. /// - returns: The created `StreamRequest`.
  602. @discardableResult
  603. open func stream(withHostName hostName: String, port: Int) -> StreamRequest {
  604. return stream(.stream(hostName: hostName, port: port))
  605. }
  606. // MARK: NetService
  607. /// Creates a `StreamRequest` for bidirectional streaming using the `netService`.
  608. ///
  609. /// If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.
  610. ///
  611. /// - parameter netService: The net service used to identify the endpoint.
  612. ///
  613. /// - returns: The created `StreamRequest`.
  614. @discardableResult
  615. open func stream(with netService: NetService) -> StreamRequest {
  616. return stream(.netService(netService))
  617. }
  618. // MARK: Private - Stream Implementation
  619. private func stream(_ streamable: StreamRequest.Streamable) -> StreamRequest {
  620. do {
  621. let task = try streamable.task(session: session, adapter: adapter, queue: queue)
  622. let request = StreamRequest(session: session, requestType: .upload, task: task, originalTask: streamable)
  623. delegate[task] = request
  624. if startRequestsImmediately { request.resume() }
  625. return request
  626. } catch {
  627. return StreamRequest(session: session, requestType: .upload, error: error)
  628. }
  629. }
  630. #endif
  631. // MARK: - Internal - Retry Request
  632. func retry(_ request: Request) -> Bool {
  633. guard let originalTask = request.originalTask else { return false }
  634. do {
  635. let task = try originalTask.task(session: session, adapter: adapter, queue: queue)
  636. request.delegate.task = task // resets all task delegate data
  637. request.startTime = CFAbsoluteTimeGetCurrent()
  638. request.endTime = nil
  639. task.resume()
  640. return true
  641. } catch {
  642. request.delegate.error = error
  643. return false
  644. }
  645. }
  646. }