Skip to content

Fully enable posixPermissions attribute on Windows #733

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
merged 1 commit into from
Jul 15, 2024
Merged

Fully enable posixPermissions attribute on Windows #733

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
25 changes: 25 additions & 0 deletions Sources/FoundationEssentials/FileManager/FileManager+Files.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -780,6 +780,24 @@ extension _FileManagerImpl {
throw CocoaError.errorWithFilePath(.featureUnsupported, path)
}

var attributesToSet: DWORD?
if let mode {
let existingAttributes = GetFileAttributesW($0)
guard existingAttributes != INVALID_FILE_ATTRIBUTES else {
throw CocoaError.errorWithFilePath(path, win32: GetLastError(), reading: true)
}
let isReadOnly = (existingAttributes & FILE_ATTRIBUTE_READONLY) != 0
let requestedReadOnly = (mode & UInt(_S_IWRITE)) == 0
if isReadOnly && !requestedReadOnly {
guard SetFileAttributesW($0, existingAttributes & ~FILE_ATTRIBUTE_READONLY) else {
throw CocoaError.errorWithFilePath(path, win32: GetLastError(), reading: false)
}
} else if !isReadOnly && requestedReadOnly {
// Make the file read-only later after setting other attributes
attributesToSet = existingAttributes | FILE_ATTRIBUTE_READONLY
}
}

if let modification = attributes[.modificationDate] as? Date {
let seconds = modification.timeIntervalSince1601

Expand All @@ -803,6 +821,13 @@ extension _FileManagerImpl {
throw CocoaError.errorWithFilePath(path, win32: GetLastError(), reading: false)
}
}

// Finally, make the file read-only if requested
if let attributesToSet {
guard SetFileAttributesW($0, attributesToSet) else {
throw CocoaError.errorWithFilePath(path, win32: GetLastError(), reading: false)
}
}
}
#else
try fileManager.withFileSystemRepresentation(for: path) { fileSystemRepresentation in
Expand Down
29 changes: 22 additions & 7 deletions Tests/FoundationEssentialsTests/FileManager/FileManagerTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,13 +545,12 @@ final class FileManagerTests : XCTestCase {
}

func testFileAccessAtPath() throws {
#if os(Windows)
throw XCTSkip("Windows filesystems do not conform to POSIX semantics")
#else
#if !os(Windows)
guard getuid() != 0 else {
// Root users can always access anything, so this test will not function when run as root
throw XCTSkip("This test is not available when running as the root user")
}
#endif

try FileManagerPlayground {
File("000", attributes: [.posixPermissions: 0o000])
Expand All @@ -563,18 +562,29 @@ final class FileManagerTests : XCTestCase {
File("666", attributes: [.posixPermissions: 0o666])
File("777", attributes: [.posixPermissions: 0o777])
}.test {
#if os(Windows)
// All files are readable on Windows
Copy link
Member

Choose a reason for hiding this comment

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

Well, there are unreadable files, just that the ACLing properties are far more complex.

let readable = ["000", "111", "222", "333", "444", "555", "666", "777"]
// None of these files are executable on Windows
let executable: [String] = []
#else
let readable = ["444", "555", "666", "777"]
let writable = ["222", "333", "666", "777"]
let executable = ["111", "333", "555", "777"]
#endif
let writable = ["222", "333", "666", "777"]
for number in 0...7 {
let file = "\(number)\(number)\(number)"
XCTAssertEqual($0.isReadableFile(atPath: file), readable.contains(file), "'\(file)' failed readable check")
XCTAssertEqual($0.isWritableFile(atPath: file), writable.contains(file), "'\(file)' failed writable check")
XCTAssertEqual($0.isExecutableFile(atPath: file), executable.contains(file), "'\(file)' failed executable check")
#if os(Windows)
// Only writable files are deletable on Windows
XCTAssertEqual($0.isDeletableFile(atPath: file), writable.contains(file), "'\(file)' failed deletable check")
#else
XCTAssertTrue($0.isDeletableFile(atPath: file), "'\(file)' failed deletable check")
#endif
}
}
#endif
}

func testFileSystemAttributesAtPath() throws {
Expand Down Expand Up @@ -654,16 +664,21 @@ final class FileManagerTests : XCTestCase {
File("foo", attributes: [.posixPermissions : UInt16(0o644)])
}.test {
let attributes = try $0.attributesOfItem(atPath: "foo")
#if !os(Windows)

// Ensure the unconventional UInt16 was accepted as input
#if os(Windows)
XCTAssertEqual(attributes[.posixPermissions] as? UInt, 0o600)
#else
XCTAssertEqual(attributes[.posixPermissions] as? UInt, 0o644)
#endif

#if FOUNDATION_FRAMEWORK
// Where we have NSNumber, ensure that we can get the value back as an unconventional Double value
XCTAssertEqual(attributes[.posixPermissions] as? Double, Double(0o644))
// Ensure that the file type can be converted to a String when it is an ObjC enum
XCTAssertEqual(attributes[.type] as? String, FileAttributeType.typeRegular.rawValue)
#endif
#endif

// Ensure that the file type can be converted to a FileAttributeType when it is an ObjC enum and in swift-foundation
XCTAssertEqual(attributes[.type] as? FileAttributeType, .typeRegular)

Expand Down