File: FileManager%2BXDGSearchPaths.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (207 lines) | stat: -rw-r--r-- 9,393 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

#if !canImport(Darwin) && !os(Windows)

private func _xdgHomeURL() -> URL {
    if let homeEnvValue = ProcessInfo.processInfo.environment["HOME"], !homeEnvValue.isEmpty {
        return URL(filePath: homeEnvValue, directoryHint: .isDirectory)
    } else {
        return __xdgHomeURL
    }
}

private let __xdgHomeURL: URL = {
    if let data = try? Data(contentsOf: URL(filePath: "/etc/default/useradd", directoryHint: .notDirectory)) {
        let contents = String(decoding: data, as: UTF8.self)
        for line in contents.split(separator: "\n") {
            if line.starts(with: "HOME="), let equalsIndex = line.firstIndex(of: "=") {
                let path = String(line[line.index(after: equalsIndex)...])
                return URL(filePath: path, directoryHint: .isDirectory)
            }
        }
    }
    return URL(filePath: "/home", directoryHint: .isDirectory)
}()

/// A single base directory relative to which user-specific data files should be written. This directory is defined by the environment variable $XDG_DATA_HOME.
private func _xdgDataHomeURL() -> URL {
    // $XDG_DATA_HOME defines the base directory relative to which user specific data files should be stored. If $XDG_DATA_HOME is either not set or empty, a default equal to $HOME/.local/share should be used.
    if let envValue = ProcessInfo.processInfo.environment["XDG_DATA_HOME"], envValue.unicodeScalars.first == "/" {
        return URL(filePath: envValue, directoryHint: .isDirectory)
    }
    return _xdgHomeURL().appending(path: ".local/share", directoryHint: .isDirectory)
}

/// A single base directory relative to which user-specific non-essential (cached) data should be written. This directory is defined by the environment variable $XDG_CACHE_HOME.
private func _xdgCacheURL() -> URL {
    // $XDG_CACHE_HOME defines the base directory relative to which user specific non-essential data files should be stored. If $XDG_CACHE_HOME is either not set or empty, a default equal to $HOME/.cache should be used.
    if let envValue = ProcessInfo.processInfo.environment["XDG_CACHE_HOME"], envValue.unicodeScalars.first == "/" {
        return URL(filePath: envValue, directoryHint: .isDirectory)
    }
    return _xdgHomeURL().appending(component: ".cache", directoryHint: .isDirectory)
}

/// A single base directory relative to which user-specific configuration files should be written. This directory is defined by the environment variable $XDG_CONFIG_HOME.
private func _xdgConfigHomeURL() -> URL {
    // $XDG_CONFIG_HOME defines the base directory relative to which user specific configuration files should be stored. If $XDG_CONFIG_HOME is either not set or empty, a default equal to $HOME/.config should be used.
    if let envValue = ProcessInfo.processInfo.environment["XDG_CONFIG_HOME"], envValue.unicodeScalars.first == "/" {
        return URL(filePath: envValue, directoryHint: .isDirectory)
    }
    return _xdgHomeURL().appending(component: ".config", directoryHint: .isDirectory)
}

/// A set of preference ordered base directories relative to which configuration files should be searched. This set of directories is defined by the environment variable $XDG_CONFIG_DIRS.
private func _xdgConfigURLs() -> [URL] {
    // $XDG_CONFIG_DIRS defines the preference-ordered set of base directories to search for configuration files in addition to the $XDG_CONFIG_HOME base directory. The directories in $XDG_CONFIG_DIRS should be separated with a colon ':'.
    // If $XDG_CONFIG_DIRS is either not set or empty, a value equal to /etc/xdg should be used.
    if let envValue = ProcessInfo.processInfo.environment["XDG_CONFIG_DIRS"], !envValue.isEmpty {
        let directories = envValue.split(separator: ":")
        if !directories.isEmpty {
            return directories.map { URL(filePath: String($0), directoryHint: .isDirectory) }
        }
    }
    return [URL(filePath: "/etc/xdg", directoryHint: .isDirectory)]
}

private enum _XDGUserDirectory: String {
    case desktop = "DESKTOP"
    case download = "DOWNLOAD"
    case publicShare = "PUBLICSHARE"
    case documents = "DOCUMENTS"
    case music = "MUSIC"
    case pictures = "PICTURES"
    case videos = "VIDEOS"
    
    var url: URL {
        return url(userConfiguration: _XDGUserDirectory.configuredDirectoryURLs, osDefaultConfiguration: _XDGUserDirectory.osDefaultDirectoryURLs)
    }
    
    func url(userConfiguration: [_XDGUserDirectory: URL], osDefaultConfiguration: [_XDGUserDirectory: URL]) -> URL {
        if let url = userConfiguration[self] {
            return url
        } else if let url = osDefaultConfiguration[self] {
            return url
        } else {
            return self.defaultValue
        }
    }
    
    var defaultValue: URL {
        let component = switch self {
            case .desktop: "Desktop"
            case .download: "Downloads"
            case .publicShare: "Public"
            case .documents: "Documents"
            case .music: "Music"
            case .pictures: "Pictures"
            case .videos: "Videos"
        }
        return FileManager.default.homeDirectoryForCurrentUser.appending(component: component)
    }
    
    private static func parseConfigFile(_ url: URL) -> [_XDGUserDirectory: URL]? {
        guard let data = try? Data(contentsOf: url) else { return nil }
        let configuration = String(decoding: data, as: UTF8.self)
        
        var entries: [_XDGUserDirectory: URL] = [:]
        let home = FileManager.default.homeDirectoryForCurrentUser
        
        for line in configuration.split(separator: "\n") {
            if let equalsIdx = line.firstIndex(of: "=") {
                var variable = String(line[..<equalsIdx])._trimmingWhitespace()
                
                let prefix = "XDG_"
                let suffix = "_DIR"
                if variable.hasPrefix(prefix) && variable.hasSuffix(suffix) {
                    let endOfPrefix = variable.unicodeScalars.index(variable.startIndex, offsetBy: prefix.unicodeScalars.count)
                    let startOfSuffix = variable.unicodeScalars.index(variable.endIndex, offsetBy: -suffix.unicodeScalars.count)
                    
                    variable = String(variable[endOfPrefix ..< startOfSuffix])
                }
                
                guard let directory = _XDGUserDirectory(rawValue: variable) else {
                    continue
                }
                
                let path = String(line[line.unicodeScalars.index(after: equalsIdx)...])._trimmingWhitespace()
                if !path.isEmpty {
                    entries[directory] = URL(filePath: path, directoryHint: .isDirectory, relativeTo: home)
                }
            } else {
                return nil // Incorrect syntax.
            }
        }
        
        return entries
    }
    
    private static let configuredDirectoryURLs: [_XDGUserDirectory: URL] = {
        parseConfigFile(_xdgConfigHomeURL().appending(component: "user-dirs.dirs")) ?? [:]
    }()
    
    private static let osDefaultDirectoryURLs: [_XDGUserDirectory: URL] = {
        for directory in _xdgConfigURLs() {
            let configurationFile = directory.appending(component: "user-dirs.defaults")
            
            if let result = parseConfigFile(configurationFile) {
                return result
            }
        }
        
        return [:]
    }()
}

func _XDGSearchPathURL(for directory: FileManager.SearchPathDirectory, in domain: FileManager.SearchPathDomainMask) -> URL? {
    return switch (directory, domain) {
    case (.autosavedInformationDirectory, .userDomainMask):
        _xdgDataHomeURL().appending(component: "Autosave Information", directoryHint: .isDirectory)
        
    case (.desktopDirectory, .userDomainMask):
        _XDGUserDirectory.desktop.url
        
    case (.documentDirectory, .userDomainMask):
        _XDGUserDirectory.documents.url
        
    case (.cachesDirectory, .userDomainMask):
        _xdgCacheURL()
        
    case (.applicationSupportDirectory, .userDomainMask):
        _xdgDataHomeURL()
        
    case (.downloadsDirectory, .userDomainMask):
        _XDGUserDirectory.download.url
        
    case (.userDirectory, .localDomainMask):
        _xdgHomeURL()
        
    case (.moviesDirectory, .userDomainMask):
        _XDGUserDirectory.videos.url
        
    case (.musicDirectory, .userDomainMask):
        _XDGUserDirectory.music.url
        
    case (.picturesDirectory, .userDomainMask):
        _XDGUserDirectory.pictures.url
        
    case (.sharedPublicDirectory, .userDomainMask):
        _XDGUserDirectory.publicShare.url
        
    case (.trashDirectory, .localDomainMask), (.trashDirectory, .userDomainMask):
        FileManager.default.homeDirectoryForCurrentUser.appending(component: ".Trash", directoryHint: .isDirectory)
        
    default: nil
    }
}

#endif