Skip to content

etagResource #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marinofaggiana merged 3 commits into from
Jul 9, 2025
Merged

etagResource #163

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6dfbc9
added etag
marinofaggiana Jul 9, 2025
b4ba990
cod
marinofaggiana Jul 9, 2025
670524a
cod
marinofaggiana Jul 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions Sources/NextcloudKit/NextcloudKit+API.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ public extension NextcloudKit {
/// - fileId: The identifier of the file to generate a preview for.
/// - width: The desired width of the preview image (default is 1024).
/// - height: The desired height of the preview image (default is 1024).
/// - etag: Optional entity tag used for caching validation.
/// - etag: Optional entity tag used for caching validation. ()
/// - crop: Indicates whether the image should be cropped (1 = true, default).
/// - cropMode: The cropping mode (default is "cover").
/// - forceIcon: If set to 1, forces icon generation (default is 0).
Expand All @@ -423,7 +423,8 @@ public extension NextcloudKit {
func downloadPreview(fileId: String,
width: Int = 1024,
height: Int = 1024,
etag: String? = nil,
etag: String,
etagResource: String? = nil,
crop: Int = 1,
cropMode: String = "cover",
forceIcon: Int = 0,
Expand All @@ -432,16 +433,19 @@ public extension NextcloudKit {
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in },
completion: @escaping (_ account: String, _ width: Int, _ height: Int, _ etag: String?, _ responseData: AFDataResponse<Data>?, _ error: NKError) -> Void) {
let endpoint = "index.php/core/preview?fileId=\(fileId)&x=\(width)&y=\(height)&a=\(crop)&mode=\(cropMode)&forceIcon=\(forceIcon)&mimeFallback=\(mimeFallback)"
//
// Adding the etag as a parameter in the endpoint URL is used to prevent URLCache from being used in case the image has been overwritten.
//
let endpoint = "index.php/core/preview?fileId=\(fileId)&x=\(width)&y=\(height)&a=\(crop)&mode=\(cropMode)&forceIcon=\(forceIcon)&mimeFallback=\(mimeFallback)&etag=\(etag)"
guard let nkSession = nkCommonInstance.nksessions.session(forAccount: account),
let url = nkCommonInstance.createStandardUrl(serverUrl: nkSession.urlBase, endpoint: endpoint, options: options),
var headers = nkCommonInstance.getStandardHeaders(account: account, options: options) else {
return options.queue.async { completion(account, width, height, nil, nil, .urlError) }
}

if var etag = etag {
etag = "\"" + etag + "\""
headers.update(name: "If-None-Match", value: etag)
if var etagResource = etagResource {
etagResource = "\"" + etagResource + "\""
headers.update(name: "If-None-Match", value: etagResource)
}

nkSession.sessionData.request(url, method: .get, encoding: URLEncoding.default, headers: headers, interceptor: NKInterceptor(nkCommonInstance: nkCommonInstance)).validate(statusCode: 200..<300).onURLSessionTaskCreation { task in
Expand Down Expand Up @@ -476,7 +480,8 @@ public extension NextcloudKit {
func downloadPreviewAsync(fileId: String,
width: Int = 1024,
height: Int = 1024,
etag: String? = nil,
etag: String,
etagResource: String? = nil,
crop: Int = 1,
cropMode: String = "cover",
forceIcon: Int = 0,
Expand All @@ -497,6 +502,7 @@ public extension NextcloudKit {
width: width,
height: height,
etag: etag,
etagResource: etagResource,
crop: crop,
cropMode: cropMode,
forceIcon: forceIcon,
Expand Down Expand Up @@ -631,7 +637,7 @@ public extension NextcloudKit {
fileNameLocalPath: String,
sizeImage: Int,
avatarSizeRounded: Int = 0,
etag: String?,
etagResource: String?,
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in },
Expand All @@ -643,9 +649,9 @@ public extension NextcloudKit {
return options.queue.async { completion(account, nil, nil, nil, nil, .urlError) }
}

if var etag = etag {
etag = "\"" + etag + "\""
headers.update(name: "If-None-Match", value: etag)
if var etagResource = etagResource {
etagResource = "\"" + etagResource + "\""
headers.update(name: "If-None-Match", value: etagResource)
}

nkSession.sessionData.request(url, method: .get, encoding: URLEncoding.default, headers: headers, interceptor: NKInterceptor(nkCommonInstance: nkCommonInstance)).validate(statusCode: 200..<300).onURLSessionTaskCreation { task in
Expand Down Expand Up @@ -743,7 +749,7 @@ public extension NextcloudKit {
fileNameLocalPath: String,
sizeImage: Int,
avatarSizeRounded: Int = 0,
etag: String?,
etagResource: String?,
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in }
Expand All @@ -760,7 +766,7 @@ public extension NextcloudKit {
fileNameLocalPath: fileNameLocalPath,
sizeImage: sizeImage,
avatarSizeRounded: avatarSizeRounded,
etag: etag,
etagResource: etagResource,
account: account,
options: options,
taskHandler: taskHandler) { account, imageAvatar, imageOriginal, etag, responseData, error in
Expand Down
Loading