(141584267) URL inits should resolve file reference paths (#1140)

Author: jrflat

Sources/FoundationEssentials/URL/URL.swift

@@ -634,6 +634,8 @@ public struct URL: Equatable, Sendable, Hashable {
     }()
 #endif
 
+    internal static let fileIDPrefix = Array("/.file/id=".utf8)
+
 #if FOUNDATION_FRAMEWORK
 
     private var _url: NSURL
@@ -747,10 +749,7 @@ public struct URL: Equatable, Sendable, Hashable {
         if isDirectory {
             flags.insert(.isDirectory)
         }
-
-        let fileIDPrefix = [UInt8(ascii: "/"), UInt8(ascii: "."), UInt8(ascii: "f"), UInt8(ascii: "i"), UInt8(ascii: "l"), UInt8(ascii: "e"), UInt8(ascii: "/"), UInt8(ascii: "i"), UInt8(ascii: "d"), UInt8(ascii: "=")]
-
-        if path.starts(with: fileIDPrefix) {
+        if parseInfo.pathHasFileID {
             flags.insert(.pathHasFileID)
         }
         if !isDirectory && !parseInfo.pathHasPercent {
@@ -784,6 +783,10 @@ public struct URL: Equatable, Sendable, Hashable {
         }
         #if FOUNDATION_FRAMEWORK
         _url = URL._nsURL(from: _parseInfo, baseParseInfo: _baseParseInfo)
+        if self.isFileURL && _parseInfo.pathHasFileID {
+            // _baseParseInfo cannot have a file ID because it came from `URL`
+            self = URL(reference: _url)
+        }
         #endif // FOUNDATION_FRAMEWORK
     }
 
@@ -809,6 +812,9 @@ public struct URL: Equatable, Sendable, Hashable {
         }
         #if FOUNDATION_FRAMEWORK
         _url = URL._nsURL(from: _parseInfo, baseParseInfo: _baseParseInfo)
+        if self.isFileURL && _parseInfo.pathHasFileID {
+            self = URL(reference: _url)
+        }
         #endif // FOUNDATION_FRAMEWORK
     }
 
@@ -830,6 +836,9 @@ public struct URL: Equatable, Sendable, Hashable {
         _parseInfo = parseInfo
         #if FOUNDATION_FRAMEWORK
         _url = URL._nsURL(from: _parseInfo, baseParseInfo: _baseParseInfo)
+        if self.isFileURL && _parseInfo.pathHasFileID {
+            self = URL(reference: _url)
+        }
         #endif // FOUNDATION_FRAMEWORK
     }
 
@@ -854,6 +863,9 @@ public struct URL: Equatable, Sendable, Hashable {
         }
         #if FOUNDATION_FRAMEWORK
         _url = URL._nsURL(from: _parseInfo, baseParseInfo: _baseParseInfo)
+        if self.isFileURL && _parseInfo.pathHasFileID {
+            self = URL(reference: _url)
+        }
         #endif // FOUNDATION_FRAMEWORK
     }
 
@@ -878,6 +890,9 @@ public struct URL: Equatable, Sendable, Hashable {
         _parseInfo = parseInfo
         #if FOUNDATION_FRAMEWORK
         _url = URL._nsURL(from: _parseInfo, baseParseInfo: _baseParseInfo)
+        if self.isFileURL && _parseInfo.pathHasFileID {
+            self = URL(reference: _url)
+        }
         #endif // FOUNDATION_FRAMEWORK
     }
 
@@ -2120,9 +2135,9 @@ public struct URL: Equatable, Sendable, Hashable {
             _parseInfo = parseInfo
         } else {
             // Go to compatibility jail (allow `URL` as a dummy string container for `NSURL` instead of crashing)
-            _parseInfo = URLParseInfo(urlString: _url.relativeString, urlParser: .RFC3986, schemeRange: nil, userRange: nil, passwordRange: nil, hostRange: nil, portRange: nil, pathRange: nil, queryRange: nil, fragmentRange: nil, isIPLiteral: false, didPercentEncodeHost: false, pathHasPercent: false)
+            _parseInfo = URLParseInfo(urlString: _url.relativeString, urlParser: .RFC3986, schemeRange: nil, userRange: nil, passwordRange: nil, hostRange: nil, portRange: nil, pathRange: nil, queryRange: nil, fragmentRange: nil, isIPLiteral: false, didPercentEncodeHost: false, pathHasPercent: false, pathHasFileID: false)
         }
-        _baseParseInfo = reference.baseURL?._parseInfo
+        _baseParseInfo = reference.baseURL?.absoluteURL._parseInfo
     }
 
     private var reference: NSURL {

Sources/FoundationEssentials/URL/URLParser.swift

@@ -31,8 +31,9 @@ final class URLParseInfo: Sendable {
     let isIPLiteral: Bool
     let didPercentEncodeHost: Bool
     let pathHasPercent: Bool
+    let pathHasFileID: Bool
 
-    init(urlString: String, urlParser: URLParserKind, schemeRange: Range<String.Index>?, userRange: Range<String.Index>?, passwordRange: Range<String.Index>?, hostRange: Range<String.Index>?, portRange: Range<String.Index>?, pathRange: Range<String.Index>?, queryRange: Range<String.Index>?, fragmentRange: Range<String.Index>?, isIPLiteral: Bool, didPercentEncodeHost: Bool, pathHasPercent: Bool) {
+    init(urlString: String, urlParser: URLParserKind, schemeRange: Range<String.Index>?, userRange: Range<String.Index>?, passwordRange: Range<String.Index>?, hostRange: Range<String.Index>?, portRange: Range<String.Index>?, pathRange: Range<String.Index>?, queryRange: Range<String.Index>?, fragmentRange: Range<String.Index>?, isIPLiteral: Bool, didPercentEncodeHost: Bool, pathHasPercent: Bool, pathHasFileID: Bool) {
         self.urlString = urlString
         self.urlParser = urlParser
         self.schemeRange = schemeRange
@@ -46,6 +47,7 @@ final class URLParseInfo: Sendable {
         self.isIPLiteral = isIPLiteral
         self.didPercentEncodeHost = didPercentEncodeHost
         self.pathHasPercent = pathHasPercent
+        self.pathHasFileID = pathHasFileID
     }
 
     var hasAuthority: Bool {
@@ -131,6 +133,7 @@ fileprivate struct URLBufferParseInfo {
     var isIPLiteral: Bool = false
     var didPercentEncodeHost: Bool = false
     var pathHasPercent: Bool = false
+    var pathHasFileID: Bool = false
 }
 
 internal enum URLParserKind {
@@ -735,7 +738,8 @@ internal struct RFC3986Parser: URLParserProtocol {
             fragmentRange: convert(bufferParseInfo.fragmentRange),
             isIPLiteral: bufferParseInfo.isIPLiteral,
             didPercentEncodeHost: bufferParseInfo.didPercentEncodeHost,
-            pathHasPercent: bufferParseInfo.pathHasPercent
+            pathHasPercent: bufferParseInfo.pathHasPercent,
+            pathHasFileID: bufferParseInfo.pathHasFileID
         )
     }
 
@@ -851,6 +855,10 @@ internal struct RFC3986Parser: URLParserProtocol {
 
         let pathStartIndex = currentIndex
         var sawPercent = false
+        if buffer[pathStartIndex...].starts(with: URL.fileIDPrefix) {
+            parseInfo.pathHasFileID = true
+            currentIndex = buffer.index(pathStartIndex, offsetBy: URL.fileIDPrefix.count)
+        }
         while currentIndex != buffer.endIndex {
             let v = buffer[currentIndex]
             if v == UInt8(ascii: "?") || v == UInt8(ascii: "#") {