Skip to content

Tag models #214

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

Open
mpivchev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Tag models #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions Sources/NextcloudKit/Models/NKDataFileXML.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,18 @@ public class NKDataFileXML: NSObject {
</d:propertyupdate>
"""

let requestBodySystemTags =
"""
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<d:propfind xmlns:d=\"DAV:\" xmlns:oc=\"http://owncloud.org/ns\" xmlns:nc=\"http://nextcloud.org/ns\">
<d:prop>
<oc:id />
<oc:display-name />
<nc:color />
</d:prop>
</d:propfind>
"""

func getRequestBodyFileListingFavorites(createProperties: [NKProperties]?, removeProperties: [NKProperties] = []) -> String {
let request = """
<?xml version=\"1.0\"?>
Expand Down
17 changes: 17 additions & 0 deletions Sources/NextcloudKit/Models/NKTag.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// SPDX-FileCopyrightText: Nextcloud GmbH
// SPDX-FileCopyrightText: 2026 Milen Pivchev
// SPDX-License-Identifier: GPL-3.0-or-later

import Foundation

public struct NKTag: Sendable, Equatable, Hashable {
public let id: String
public let name: String
public let color: String?

public init(id: String, name: String, color: String?) {
self.id = id
self.name = name
self.color = color
}
}
300 changes: 300 additions & 0 deletions Sources/NextcloudKit/NextcloudKit+Tags.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,300 @@
// SPDX-FileCopyrightText: Nextcloud GmbH
// SPDX-FileCopyrightText: 2026 Milen Pivchev
// SPDX-License-Identifier: GPL-3.0-or-later

import Foundation
import Alamofire
import SwiftyJSON
import SwiftyXMLParser

public extension NextcloudKit {
private var systemTagsPath: String { "/remote.php/dav/systemtags/" }
private var systemTagRelationsFilesPath: String { "/remote.php/dav/systemtags-relations/files/" }

/// Returns the list of tags available for the account.
///
/// - Parameters:
/// - account: The account performing the request.
/// - options: Optional request options.
/// - taskHandler: Callback for the underlying URL session task.
/// - completion: Completion handler returning account, tags, raw response and error.
func getTags(account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in },
completion: @escaping (_ account: String, _ tags: [NKTag]?, _ responseData: AFDataResponse<Data>?, _ error: NKError) -> Void) {
guard let nkSession = nkCommonInstance.nksessions.session(forAccount: account),
var headers = nkCommonInstance.getStandardHeaders(account: account, options: options, accept: "application/xml") else {
return options.queue.async { completion(account, nil, nil, .urlError) }
}

let endpoint = nkSession.urlBase + systemTagsPath
guard let url = endpoint.encodedToUrl else {
return options.queue.async { completion(account, nil, nil, .urlError) }
}

let method = HTTPMethod(rawValue: "PROPFIND")
headers.update(name: "Depth", value: "1")
var urlRequest: URLRequest
do {
try urlRequest = URLRequest(url: url, method: method, headers: headers)
urlRequest.httpBody = NKDataFileXML(nkCommonInstance: self.nkCommonInstance).requestBodySystemTags.data(using: .utf8)
urlRequest.timeoutInterval = options.timeout
} catch {
return options.queue.async { completion(account, nil, nil, NKError(error: error)) }
}

nkSession.sessionData.request(urlRequest, interceptor: NKInterceptor(nkCommonInstance: nkCommonInstance))
.validate(statusCode: 200..<300)
.onURLSessionTaskCreation { task in
task.taskDescription = options.taskDescription
taskHandler(task)
}
.responseData(queue: self.nkCommonInstance.backgroundQueue) { response in
switch response.result {
case .failure(let error):
let error = NKError(error: error, afResponse: response, responseData: response.data)
options.queue.async { completion(account, nil, response, error) }
case .success:
guard let xmlData = response.data else {
return options.queue.async { completion(account, nil, response, .invalidData) }
}
let tags = self.convertSystemTags(xmlData: xmlData)
options.queue.async { completion(account, tags, response, .success) }
}
}
}

/// Async wrapper around ``getTags(account:options:taskHandler:completion:)``.
func getTagsAsync(account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in }
) async -> (
account: String,
tags: [NKTag]?,
responseData: AFDataResponse<Data>?,
error: NKError
) {
await withCheckedContinuation { continuation in
getTags(account: account, options: options, taskHandler: taskHandler) { account, tags, responseData, error in
continuation.resume(returning: (
account: account,
tags: tags,
responseData: responseData,
error: error
))
}
}
}

/// Creates a new tag.
///
/// - Parameters:
/// - name: Tag display name.
/// - account: Account performing the request.
/// - options: Optional request options.
/// - taskHandler: Callback for the underlying URL session task.
/// - completion: Completion handler returning account, raw response and error.
func createTag(name: String,
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in },
completion: @escaping (_ account: String, _ responseData: AFDataResponse<Data>?, _ error: NKError) -> Void) {
guard let nkSession = nkCommonInstance.nksessions.session(forAccount: account),
let headers = nkCommonInstance.getStandardHeaders(account: account, options: options, contentType: "application/json", accept: "application/json"),
let url = (nkSession.urlBase + systemTagsPath).encodedToUrl else {
return options.queue.async { completion(account, nil, .urlError) }
}

var urlRequest: URLRequest
do {
try urlRequest = URLRequest(url: url, method: .post, headers: headers)
urlRequest.timeoutInterval = options.timeout
let payload = ["name": name]
urlRequest.httpBody = try JSONSerialization.data(withJSONObject: payload)
} catch {
return options.queue.async { completion(account, nil, NKError(error: error)) }
}

nkSession.sessionData.request(urlRequest, interceptor: NKInterceptor(nkCommonInstance: nkCommonInstance))
.validate(statusCode: 200..<300)
.onURLSessionTaskCreation { task in
task.taskDescription = options.taskDescription
taskHandler(task)
}
.responseData(queue: self.nkCommonInstance.backgroundQueue) { response in
let result = self.evaluateResponse(response)
options.queue.async { completion(account, response, result) }
}
}

/// Async wrapper around ``createTag(name:account:options:taskHandler:completion:)``.
func createTagAsync(name: String,
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in }
) async -> (
account: String,
responseData: AFDataResponse<Data>?,
error: NKError
) {
await withCheckedContinuation { continuation in
createTag(name: name, account: account, options: options, taskHandler: taskHandler) { account, responseData, error in
continuation.resume(returning: (
account: account,
responseData: responseData,
error: error
))
}
}
}

/// Assigns a tag to a file by file id.
///
/// - Parameters:
/// - tagId: The system tag id.
/// - fileId: The numeric file id.
/// - account: Account performing the request.
/// - options: Optional request options.
/// - taskHandler: Callback for the underlying URL session task.
/// - completion: Completion handler returning account, raw response and error.
func addTagToFile(tagId: String,
fileId: String,
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in },
completion: @escaping (_ account: String, _ responseData: AFDataResponse<Data>?, _ error: NKError) -> Void) {
guard let nkSession = nkCommonInstance.nksessions.session(forAccount: account),
let headers = nkCommonInstance.getStandardHeaders(account: account, options: options, contentType: "application/json", accept: "application/json"),
let url = (nkSession.urlBase + systemTagRelationsFilesPath + fileId + "/" + tagId).encodedToUrl else {
return options.queue.async { completion(account, nil, .urlError) }
}

var urlRequest: URLRequest
do {
try urlRequest = URLRequest(url: url, method: .put, headers: headers)
urlRequest.timeoutInterval = options.timeout
urlRequest.httpBody = Data()
} catch {
return options.queue.async { completion(account, nil, NKError(error: error)) }
}

nkSession.sessionData.request(urlRequest, interceptor: NKInterceptor(nkCommonInstance: nkCommonInstance))
.validate(statusCode: 200..<300)
.onURLSessionTaskCreation { task in
task.taskDescription = options.taskDescription
taskHandler(task)
}
.responseData(queue: self.nkCommonInstance.backgroundQueue) { response in
let result = self.evaluateResponse(response)
options.queue.async { completion(account, response, result) }
}
}

/// Async wrapper around ``addTagToFile(tagId:fileId:account:options:taskHandler:completion:)``.
func addTagToFileAsync(tagId: String,
fileId: String,
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in }
) async -> (
account: String,
responseData: AFDataResponse<Data>?,
error: NKError
) {
await withCheckedContinuation { continuation in
addTagToFile(tagId: tagId, fileId: fileId, account: account, options: options, taskHandler: taskHandler) { account, responseData, error in
continuation.resume(returning: (
account: account,
responseData: responseData,
error: error
))
}
}
}

/// Removes a tag assignment from a file.
///
/// - Parameters:
/// - tagId: The system tag id.
/// - fileId: The numeric file id.
/// - account: Account performing the request.
/// - options: Optional request options.
/// - taskHandler: Callback for the underlying URL session task.
/// - completion: Completion handler returning account, raw response and error.
func removeTagFromFile(tagId: String,
fileId: String,
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in },
completion: @escaping (_ account: String, _ responseData: AFDataResponse<Data>?, _ error: NKError) -> Void) {
guard let nkSession = nkCommonInstance.nksessions.session(forAccount: account),
let headers = nkCommonInstance.getStandardHeaders(account: account, options: options, contentType: "application/json", accept: "application/json"),
let url = (nkSession.urlBase + systemTagRelationsFilesPath + fileId + "/" + tagId).encodedToUrl else {
return options.queue.async { completion(account, nil, .urlError) }
}

var urlRequest: URLRequest
do {
try urlRequest = URLRequest(url: url, method: .delete, headers: headers)
urlRequest.timeoutInterval = options.timeout
} catch {
return options.queue.async { completion(account, nil, NKError(error: error)) }
}

nkSession.sessionData.request(urlRequest, interceptor: NKInterceptor(nkCommonInstance: nkCommonInstance))
.validate(statusCode: 200..<300)
.onURLSessionTaskCreation { task in
task.taskDescription = options.taskDescription
taskHandler(task)
}
.responseData(queue: self.nkCommonInstance.backgroundQueue) { response in
let result = self.evaluateResponse(response)
options.queue.async { completion(account, response, result) }
}
}

/// Async wrapper around ``removeTagFromFile(tagId:fileId:account:options:taskHandler:completion:)``.
func removeTagFromFileAsync(tagId: String,
fileId: String,
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in }
) async -> (
account: String,
responseData: AFDataResponse<Data>?,
error: NKError
) {
await withCheckedContinuation { continuation in
removeTagFromFile(tagId: tagId, fileId: fileId, account: account, options: options, taskHandler: taskHandler) { account, responseData, error in
continuation.resume(returning: (
account: account,
responseData: responseData,
error: error
))
}
}
}

private func convertSystemTags(xmlData: Data) -> [NKTag] {
let xml = XML.parse(xmlData)
let responses = xml["d:multistatus", "d:response"]
var tags: [NKTag] = []

for response in responses {
let propstat = response["d:propstat"][0]
guard let id = propstat["d:prop", "oc:id"].text,
let name = propstat["d:prop", "oc:display-name"].text else {
continue
}

var color: String?
if let colorHex = propstat["d:prop", "nc:color"].text, !colorHex.isEmpty {
color = colorHex.hasPrefix("#") ? colorHex : "#\(colorHex)"
}

tags.append(NKTag(id: id, name: name, color: color))
}

return tags
}
}
Loading