Skip to content

URL(filePath: path, directoryHint: .notDirectory) should strip trailing slashes #867

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
Aug 19, 2024
Merged

URL(filePath: path, directoryHint: .notDirectory) should strip trailing slashes #867

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
60 changes: 28 additions & 32 deletions Sources/FoundationEssentials/URL/URL.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2022,24 +2022,28 @@ extension URL {

#if !NO_FILESYSTEM
private static func isDirectory(_ path: String) -> Bool {
#if !FOUNDATION_FRAMEWORK
#if os(Windows)
let path = path.replacing(._slash, with: ._backslash)
#endif
#if !FOUNDATION_FRAMEWORK
var isDirectory: Bool = false
_ = FileManager.default.fileExists(atPath: path, isDirectory: &isDirectory)
return isDirectory
#else
#else
var isDirectory: ObjCBool = false
_ = FileManager.default.fileExists(atPath: path, isDirectory: &isDirectory)
return isDirectory.boolValue
#endif
#endif
}
#endif // !NO_FILESYSTEM

/// Checks if a file path is absolute and standardizes the inputted file path on Windows
/// Assumes the path only contains `/` as the path separator
internal static func isAbsolute(standardizing filePath: inout String) -> Bool {
#if os(Windows)
var isAbsolute = false
let utf8 = filePath.utf8
if utf8.first == ._backslash {
if utf8.first == ._slash {
// Either an absolute path or a UNC path
isAbsolute = true
} else if utf8.count >= 3 {
Expand All @@ -2052,18 +2056,18 @@ extension URL {
isAbsolute = (
first.isAlpha
&& (second == ._colon || second == ._pipe)
&& third == ._backslash
&& third == ._slash
)

if isAbsolute {
// Standardize to "\[drive-letter]:\..."
// Standardize to "/[drive-letter]:/..."
if second == ._pipe {
var filePathArray = Array(utf8)
filePathArray[1] = ._colon
filePathArray.insert(._backslash, at: 0)
filePathArray.insert(._slash, at: 0)
filePath = String(decoding: filePathArray, as: UTF8.self)
} else {
filePath = "\\" + filePath
filePath = "/" + filePath
}
}
}
Expand Down Expand Up @@ -2107,10 +2111,9 @@ extension URL {
}

#if os(Windows)
let slash = UInt8(ascii: "\\")
var filePath = path.replacing(UInt8(ascii: "/"), with: slash)
// Convert any "\" to "/" before storing the URL parse info
var filePath = path.replacing(._backslash, with: ._slash)
#else
let slash = UInt8(ascii: "/")
var filePath = path
#endif

Expand All @@ -2122,41 +2125,31 @@ extension URL {
}
#endif

func absoluteFilePath() -> String {
guard !isAbsolute, let baseURL else {
return filePath
}
let basePath = baseURL.path()
#if os(Windows)
let urlPath = filePath.replacing(UInt8(ascii: "\\"), with: UInt8(ascii: "/"))
return URL.fileSystemPath(for: basePath.merging(relativePath: urlPath)).replacing(UInt8(ascii: "/"), with: UInt8(ascii: "\\"))
#else
return URL.fileSystemPath(for: basePath.merging(relativePath: filePath))
#endif
}

let isDirectory: Bool
switch directoryHint {
case .isDirectory:
isDirectory = true
case .notDirectory:
filePath = filePath._droppingTrailingSlashes
isDirectory = false
case .checkFileSystem:
#if !NO_FILESYSTEM
func absoluteFilePath() -> String {
guard !isAbsolute, let baseURL else {
return filePath
}
let absolutePath = baseURL.path().merging(relativePath: filePath)
return URL.fileSystemPath(for: absolutePath)
}
isDirectory = URL.isDirectory(absoluteFilePath())
#else
isDirectory = filePath.utf8.last == slash
isDirectory = filePath.utf8.last == ._slash
#endif
case .inferFromPath:
isDirectory = filePath.utf8.last == slash
isDirectory = filePath.utf8.last == ._slash
}

#if os(Windows)
// Convert any "\" back to "/" before storing the URL parse info
filePath = filePath.replacing(UInt8(ascii: "\\"), with: UInt8(ascii: "/"))
#endif

if !filePath.isEmpty && filePath.utf8.last != UInt8(ascii: "/") && isDirectory {
if isDirectory && !filePath.isEmpty && filePath.utf8.last != ._slash {
filePath += "/"
}
var components = URLComponents()
Expand Down Expand Up @@ -2434,6 +2427,9 @@ extension URL {
guard var filePath = path else {
return nil
}
#if os(Windows)
filePath = filePath.replacing(._backslash, with: ._slash)
#endif
guard URL.isAbsolute(standardizing: &filePath) else {
return nil
}
Expand Down
36 changes: 36 additions & 0 deletions Tests/FoundationEssentialsTests/URLTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,6 +586,42 @@ final class URLTests : XCTestCase {
XCTAssertEqual(url.fileSystemPath, "/path/slashes")
}

func testURLNotDirectoryHintStripsTrailingSlash() throws {
// Supply a path with a trailing slash but say it's not a direcotry
var url = URL(filePath: "/path/", directoryHint: .notDirectory)
XCTAssertFalse(url.hasDirectoryPath)
XCTAssertEqual(url.path(), "/path")

url = URL(fileURLWithPath: "/path/", isDirectory: false)
XCTAssertFalse(url.hasDirectoryPath)
XCTAssertEqual(url.path(), "/path")

url = URL(filePath: "/path///", directoryHint: .notDirectory)
XCTAssertFalse(url.hasDirectoryPath)
XCTAssertEqual(url.path(), "/path")

url = URL(fileURLWithPath: "/path///", isDirectory: false)
XCTAssertFalse(url.hasDirectoryPath)
XCTAssertEqual(url.path(), "/path")

// With .checkFileSystem, don't modify the path for a non-existent file
url = URL(filePath: "/my/non/existent/path/", directoryHint: .checkFileSystem)
XCTAssertTrue(url.hasDirectoryPath)
XCTAssertEqual(url.path(), "/my/non/existent/path/")

url = URL(fileURLWithPath: "/my/non/existent/path/")
XCTAssertTrue(url.hasDirectoryPath)
XCTAssertEqual(url.path(), "/my/non/existent/path/")

url = URL(filePath: "/my/non/existent/path", directoryHint: .checkFileSystem)
XCTAssertFalse(url.hasDirectoryPath)
XCTAssertEqual(url.path(), "/my/non/existent/path")

url = URL(fileURLWithPath: "/my/non/existent/path")
XCTAssertFalse(url.hasDirectoryPath)
XCTAssertEqual(url.path(), "/my/non/existent/path")
}

func testURLComponentsPercentEncodedUnencodedProperties() throws {
var comp = URLComponents()

Expand Down