Skip to content

Added an optional files filter #5

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
mark2b wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Added an optional files filter #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5c477a
URL filter added
mark2b May 12, 2023
a9c01be
Prevent file not found exception
mark2b May 14, 2023
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
4 changes: 2 additions & 2 deletions Sources/Tarscape/FileManager+Tar.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public extension FileManager {
}

@nonobjc
func createTar(at tarURL: URL, from dirURL: URL, options: KBTarArchiver.Options = [], progress: Progress? = nil) throws {
func createTar(at tarURL: URL, from dirURL: URL, filter: KBURLFilter? = nil, options: KBTarArchiver.Options = [], progress: Progress? = nil) throws {
let archiver = KBTarArchiver(directoryURL: dirURL, options: options)

var progressBody: ((Double, Int64) -> Void)?
Expand All @@ -41,7 +41,7 @@ public extension FileManager {
}
}

try KBTarArchiver(directoryURL: dirURL, options: options).archive(to: tarURL, progressBody: progressBody)
try KBTarArchiver(directoryURL: dirURL, filter: filter, options: options).archive(to: tarURL, progressBody: progressBody)
}

// MARK: - Objective-C Compatible Methods
Expand Down
23 changes: 19 additions & 4 deletions Sources/Tarscape/KBTarArchiver.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@

import Foundation

public typealias KBURLFilter = (_ url:URL) -> Bool

public class KBTarArchiver {

private let directoryURL: URL
private let filter: KBURLFilter?
private let options: Options
private var fileHandle: FileHandle!

Expand Down Expand Up @@ -49,7 +52,9 @@ public class KBTarArchiver {
let e = FileManager.default.enumerator(at: directoryURL, includingPropertiesForKeys: nil)!
var allFiles: [URL] = []
for case let fileURL as URL in e {
allFiles.append(fileURL)
if self.filter?(fileURL) ?? true {
allFiles.append(fileURL)
}
}
self.allFiles = allFiles
self._progressCount = Int64(allFiles.count)
Expand All @@ -68,9 +73,11 @@ public class KBTarArchiver {

/// Creates a new archiver object ready to generate a Tar file from the passed-in directory contents.
/// - Parameter directoryURL: The path to the directory for archiving.
/// - Parameter filter: Allows filter out specific files or directories. The default value is nil.
/// - Parameter options: Options for creating the archive. The default value is `[]`.
public init(directoryURL: URL, options: Options = []) {
public init(directoryURL: URL, filter: KBURLFilter? = nil, options: Options = []) {
self.directoryURL = directoryURL
self.filter = filter
self.options = options
}

Expand Down Expand Up @@ -120,7 +127,9 @@ public class KBTarArchiver {
let e = fm.enumerator(at: directoryURL, includingPropertiesForKeys: nil)!
var allFiles: [URL] = []
for case let fileURL as URL in e {
allFiles.append(fileURL)
if self.filter?(fileURL) ?? true {
allFiles.append(fileURL)
}
}
self.allFiles = allFiles
}
Expand All @@ -135,7 +144,9 @@ public class KBTarArchiver {
// we enumerate through the files.
let e = fm.enumerator(at: directoryURL, includingPropertiesForKeys: nil)!
for case let fileURL as URL in e {
try encode(fileURL: fileURL)
if self.filter?(fileURL) ?? true {
try encode(fileURL: fileURL)
}
}
}

Expand All @@ -153,6 +164,10 @@ public class KBTarArchiver {

private func encodeBinaryData(for fileURL: URL, subpath: String) throws {

guard FileManager.default.fileExists(atPath: fileURL.relativePath) else {
return
}

let fileAttributes = KBFileAttributes(fileURL: fileURL, supportAliasFiles: options.contains(.convertAliasFiles))

// Get the Tar type (directory, symbolic link or regular file).
Expand Down