Skip to content

Search media #206

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
Jan 28, 2026
Merged

Search media #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f29c5f
removed
marinofaggiana Jan 28, 2026
8e9ce92
public search
marinofaggiana Jan 28, 2026
35063ec
public
marinofaggiana Jan 28, 2026
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
2 changes: 1 addition & 1 deletion Sources/NextcloudKit/Models/NKProperties.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public enum NKProperties: String, CaseIterable {
/// open-cloud-mesh.org
case sharepermissionscloudmesh = "<share-permissions xmlns=\"http://open-cloud-mesh.org/ns\"/>"

static func properties(createProperties: [NKProperties]?, removeProperties: [NKProperties] = []) -> String {
static public func properties(createProperties: [NKProperties]?, removeProperties: [NKProperties] = []) -> String {
var properties = allCases.map { $0.rawValue }.joined()
if let createProperties {
properties = ""
Expand Down
144 changes: 16 additions & 128 deletions Sources/NextcloudKit/NextcloudKit+WebDAV.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -725,119 +725,7 @@ public extension NextcloudKit {
}
}

/// Searches media files within a specified date range on the server.
///
/// - Parameters:
/// - path: The directory path to search within (default is empty string for root).
/// - lessDate: The upper bound date filter (files older than this).
/// - greaterDate: The lower bound date filter (files newer than this).
/// - elementDate: The file date attribute to filter on (e.g., "created", "modified").
/// - limit: Maximum number of files to return.
/// - account: The Nextcloud account identifier.
/// - options: Optional request options (headers, queue, etc.).
/// - taskHandler: Callback for monitoring the underlying `URLSessionTask`.
/// - completion: Completion handler returning:
/// - account: The account used for the request.
/// - files: Optional array of matching `NKFile` objects.
/// - responseData: Raw Alamofire response data.
/// - error: An `NKError` describing success or failure.
func searchMedia(path: String = "",
lessDate: Any,
greaterDate: Any,
elementDate: String,
limit: Int,
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in },
completion: @escaping (_ account: String, _ files: [NKFile]?, _ responseData: AFDataResponse<Data>?, _ error: NKError) -> Void) {
guard let nkSession = nkCommonInstance.nksessions.session(forAccount: account) else {
return options.queue.async { completion(account, nil, nil, .urlError) }
}
let files: [NKFile] = []
let elementDate = elementDate + "/"
var greaterDateString: String?, lessDateString: String?
let href = "/files/" + nkSession.userId + path
if let lessDate = lessDate as? Date {
lessDateString = lessDate.formatted(using: "yyyy-MM-dd'T'HH:mm:ssZZZZZ")
} else if let lessDate = lessDate as? Int {
lessDateString = String(lessDate)
}
if let greaterDate = greaterDate as? Date {
greaterDateString = greaterDate.formatted(using: "yyyy-MM-dd'T'HH:mm:ssZZZZZ")
} else if let greaterDate = greaterDate as? Int {
greaterDateString = String(greaterDate)
}
guard let lessDateString, let greaterDateString else {
return options.queue.async { completion(account, files, nil, .invalidDate) }
}

let httpBodyString = String(format: NKDataFileXML(nkCommonInstance: self.nkCommonInstance).getRequestBodySearchMedia(createProperties: options.createProperties, removeProperties: options.removeProperties), href, elementDate, elementDate, lessDateString, elementDate, greaterDateString, String(limit))

guard let httpBody = httpBodyString.data(using: .utf8) else {
return options.queue.async {
completion(account, files, nil, .invalidData)
}
}


search(serverUrl: nkSession.urlBase, httpBody: httpBody, showHiddenFiles: false, includeHiddenFiles: [], account: account, options: options) { task in
taskHandler(task)
} completion: { account, files, responseData, error in
options.queue.async { completion(account, files, responseData, error) }
}
}

/// Asynchronously searches media files with date filters.
///
/// - Parameters:
/// - path: Directory path to search.
/// - lessDate: Upper date bound filter.
/// - greaterDate: Lower date bound filter.
/// - elementDate: File date attribute to filter on.
/// - limit: Maximum number of results.
/// - account: Nextcloud account identifier.
/// - options: Optional request options.
/// - taskHandler: Callback for URLSessionTask monitoring.
///
/// - Returns: A tuple containing:
/// - account: Account used for the request.
/// - files: Optional array of `NKFile` matching results.
/// - responseData: Raw server response data.
/// - error: Resulting `NKError`.
func searchMediaAsync(path: String = "",
lessDate: Any,
greaterDate: Any,
elementDate: String,
limit: Int,
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in }
) async -> (
account: String,
files: [NKFile]?,
responseData: AFDataResponse<Data>?,
error: NKError
) {
await withCheckedContinuation { continuation in
searchMedia(path: path,
lessDate: lessDate,
greaterDate: greaterDate,
elementDate: elementDate,
limit: limit,
account: account,
options: options,
taskHandler: taskHandler) { account, files, responseData, error in
continuation.resume(returning: (
account: account,
files: files,
responseData: responseData,
error: error
))
}
}
}

/// Performs a private search request with a custom HTTP body on the server.
/// Performs a search request with a custom HTTP body on the server.
///
/// - Parameters:
/// - serverUrl: The base URL of the Nextcloud server.
Expand All @@ -852,14 +740,14 @@ public extension NextcloudKit {
/// - files: Optional array of `NKFile` matching the search.
/// - responseData: Raw response data from Alamofire.
/// - error: An `NKError` indicating success or failure.
private func search(serverUrl: String,
httpBody: Data,
showHiddenFiles: Bool,
includeHiddenFiles: [String],
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in },
completion: @escaping (_ account: String, _ files: [NKFile]?, _ responseData: AFDataResponse<Data>?, _ error: NKError) -> Void) {
func search(serverUrl: String,
httpBody: Data,
showHiddenFiles: Bool,
includeHiddenFiles: [String],
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in },
completion: @escaping (_ account: String, _ files: [NKFile]?, _ responseData: AFDataResponse<Data>?, _ error: NKError) -> Void) {
guard let nkSession = nkCommonInstance.nksessions.session(forAccount: account),
let headers = nkCommonInstance.getStandardHeaders(account: account, options: options, contentType: "application/xml", accept: "application/xml") else {
return options.queue.async { completion(account, nil, nil, .urlError) }
Expand Down Expand Up @@ -914,13 +802,13 @@ public extension NextcloudKit {
/// - files: Optional array of `NKFile` results.
/// - responseData: Raw response data.
/// - error: Resulting `NKError`.
private func searchAsync(serverUrl: String,
httpBody: Data,
showHiddenFiles: Bool,
includeHiddenFiles: [String],
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in }
func searchAsync(serverUrl: String,
httpBody: Data,
showHiddenFiles: Bool,
includeHiddenFiles: [String],
account: String,
options: NKRequestOptions = NKRequestOptions(),
taskHandler: @escaping (_ task: URLSessionTask) -> Void = { _ in }
) async -> (
account: String,
files: [NKFile]?,
Expand Down
Loading