Skip to content
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

Add hasQuarantineAttribute to FileSystem #411

Merged
merged 2 commits into from
Apr 20, 2023
Merged

Add hasQuarantineAttribute to FileSystem #411

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b070e9f
Add `hasQuarantineAttribute` to `FileSystem`
MaxDesiatov Apr 20, 2023
d49d620
Address PR feedback, fix tests on Linux
MaxDesiatov Apr 20, 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
16 changes: 16 additions & 0 deletions Sources/TSCBasic/FileSystem.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,10 @@ public protocol FileSystem: AnyObject, Sendable {
/// Check whether the given path is accessible and writable.
func isWritable(_ path: AbsolutePath) -> Bool

/// Returns `true` if a given path has a quarantine attribute applied if when file system supports this attribute.
/// Returns `false` if such attribute is not applied or it isn't supported.
func hasQuarantineAttribute(_ path: AbsolutePath) -> Bool

// FIXME: Actual file system interfaces will allow more efficient access to
// more data than just the name here.
//
Expand Down Expand Up @@ -293,6 +297,8 @@ public extension FileSystem {
func withLock<T>(on path: AbsolutePath, type: FileLock.LockType, _ body: () throws -> T) throws -> T {
throw FileSystemError(.unsupported, path)
}

func hasQuarantineAttribute(_ path: AbsolutePath) -> Bool { false }
}

/// Concrete FileSystem implementation which communicates with the local file system.
Expand Down Expand Up @@ -341,6 +347,16 @@ private final class LocalFileSystem: FileSystem {
return FileInfo(attrs)
}

func hasQuarantineAttribute(_ path: AbsolutePath) -> Bool {
#if os(macOS)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should probably be canImport(Darwin)?

let bufLength = getxattr(path.pathString, "com.apple.quarantine", nil, 0, 0, 0)

return bufLength > 0
#else
return false
#endif
}

var currentWorkingDirectory: AbsolutePath? {
let cwdStr = FileManager.default.currentDirectoryPath

Expand Down
11 changes: 11 additions & 0 deletions Tests/TSCBasicTests/FileSystemTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -860,6 +860,17 @@ class FileSystemTests: XCTestCase {
try _testFileSystemFileLock(fileSystem: fs, fileA: fileA, fileB: fileB, lockFile: lockFile)
}

func testQuarantineAttribute() throws {
try withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
let filePath = tempDir.appending(component: "quarantined")
try localFileSystem.writeFileContents(filePath, bytes: "")
try Process.checkNonZeroExit(args: "xattr", "-w", "com.apple.quarantine", "foo", filePath.pathString)
XCTAssertTrue(localFileSystem.hasQuarantineAttribute(filePath))
try Process.checkNonZeroExit(args: "xattr", "-d", "com.apple.quarantine", filePath.pathString)
XCTAssertFalse(localFileSystem.hasQuarantineAttribute(filePath))
}
}

private func _testFileSystemFileLock(fileSystem fs: FileSystem, fileA: AbsolutePath, fileB: AbsolutePath, lockFile: AbsolutePath) throws {
// write initial value, since reader may start before writers and files would not exist
try fs.writeFileContents(fileA, bytes: "0")
Expand Down