forked from swiftlang/swift-corelibs-foundation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathFileManager.swift
1441 lines (1202 loc) · 76.4 KB
/
FileManager.swift
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2019 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(FreeBSD)
// The values do not matter as long as they are nonzero.
fileprivate let UF_IMMUTABLE: Int32 = 1
fileprivate let SF_IMMUTABLE: Int32 = 1
fileprivate let UF_APPEND: Int32 = 1
fileprivate let UF_HIDDEN: Int32 = 1
#endif
import CoreFoundation
#if os(Windows)
import MSVCRT
#endif
open class FileManager : NSObject {
/* Returns the default singleton instance.
*/
private static let _default = FileManager()
open class var `default`: FileManager {
get {
return _default
}
}
/// Returns an array of URLs that identify the mounted volumes available on the device.
open func mountedVolumeURLs(includingResourceValuesForKeys propertyKeys: [URLResourceKey]?, options: VolumeEnumerationOptions = []) -> [URL]? {
return _mountedVolumeURLs(includingResourceValuesForKeys: propertyKeys, options: options)
}
/* Returns an NSArray of NSURLs identifying the the directory entries.
If the directory contains no entries, this method will return the empty array. When an array is specified for the 'keys' parameter, the specified property values will be pre-fetched and cached with each enumerated URL.
This method always does a shallow enumeration of the specified directory (i.e. it always acts as if NSDirectoryEnumerationSkipsSubdirectoryDescendants has been specified). If you need to perform a deep enumeration, use -[NSFileManager enumeratorAtURL:includingPropertiesForKeys:options:errorHandler:].
If you wish to only receive the URLs and no other attributes, then pass '0' for 'options' and an empty NSArray ('[NSArray array]') for 'keys'. If you wish to have the property caches of the vended URLs pre-populated with a default set of attributes, then pass '0' for 'options' and 'nil' for 'keys'.
*/
open func contentsOfDirectory(at url: URL, includingPropertiesForKeys keys: [URLResourceKey]?, options mask: DirectoryEnumerationOptions = []) throws -> [URL] {
var error : Error? = nil
let e = self.enumerator(at: url, includingPropertiesForKeys: keys, options: mask.union(.skipsSubdirectoryDescendants)) { (url, err) -> Bool in
error = err
return false
}
var result = [URL]()
if let e = e {
for url in e {
result.append(url as! URL)
}
if let error = error {
throw error
}
}
return result
}
internal enum _SearchPathDomain {
case system
case local
case network
case user
static let correspondingValues: [UInt: _SearchPathDomain] = [
SearchPathDomainMask.systemDomainMask.rawValue: .system,
SearchPathDomainMask.localDomainMask.rawValue: .local,
SearchPathDomainMask.networkDomainMask.rawValue: .network,
SearchPathDomainMask.userDomainMask.rawValue: .user,
]
static let searchOrder: [SearchPathDomainMask] = [
.systemDomainMask,
.localDomainMask,
.networkDomainMask,
.userDomainMask,
]
init?(_ domainMask: SearchPathDomainMask) {
if let value = _SearchPathDomain.correspondingValues[domainMask.rawValue] {
self = value
} else {
return nil
}
}
static func allInSearchOrder(from domainMask: SearchPathDomainMask) -> [_SearchPathDomain] {
var domains: [_SearchPathDomain] = []
for bit in _SearchPathDomain.searchOrder {
if domainMask.contains(bit) {
domains.append(_SearchPathDomain.correspondingValues[bit.rawValue]!)
}
}
return domains
}
}
/* -URLsForDirectory:inDomains: is analogous to NSSearchPathForDirectoriesInDomains(), but returns an array of NSURL instances for use with URL-taking APIs. This API is suitable when you need to search for a file or files which may live in one of a variety of locations in the domains specified.
*/
open func urls(for directory: SearchPathDirectory, in domainMask: SearchPathDomainMask) -> [URL] {
return _urls(for: directory, in: domainMask)
}
internal lazy var xdgHomeDirectory: String = {
let key = "HOME="
if let contents = try? String(contentsOfFile: "/etc/default/useradd", encoding: .utf8) {
for line in contents.components(separatedBy: "\n") {
if line.hasPrefix(key) {
let index = line.index(line.startIndex, offsetBy: key.count)
let str = String(line[index...]) as NSString
let homeDir = str.trimmingCharacters(in: CharacterSet.whitespaces)
if homeDir.count > 0 {
return homeDir
}
}
}
}
return "/home"
}()
private enum URLForDirectoryError: Error {
case directoryUnknown
}
/* -URLForDirectory:inDomain:appropriateForURL:create:error: is a URL-based replacement for FSFindFolder(). It allows for the specification and (optional) creation of a specific directory for a particular purpose (e.g. the replacement of a particular item on disk, or a particular Library directory.
You may pass only one of the values from the NSSearchPathDomainMask enumeration, and you may not pass NSAllDomainsMask.
*/
open func url(for directory: SearchPathDirectory, in domain: SearchPathDomainMask, appropriateFor reference: URL?, create
shouldCreate: Bool) throws -> URL {
var url: URL
if directory == .itemReplacementDirectory {
// We mimic Darwin here — .itemReplacementDirectory has a number of requirements for use and not meeting them is a programmer error and should panic out.
precondition(domain == .userDomainMask)
let referenceURL = reference!
// If the temporary directory and the reference URL are on the same device, use a subdirectory in the temporary directory. Otherwise, use a temporary directory at the same path as the filesystem that contains this file if it's writable. Fall back to the temporary directory if the latter doesn't work.
let temporaryDirectory = URL(fileURLWithPath: NSTemporaryDirectory())
let useTemporaryDirectory: Bool
let maybeVolumeIdentifier = try? temporaryDirectory.resourceValues(forKeys: [.volumeIdentifierKey]).volumeIdentifier as? AnyHashable
let maybeReferenceVolumeIdentifier = try? referenceURL.resourceValues(forKeys: [.volumeIdentifierKey]).volumeIdentifier as? AnyHashable
if let volumeIdentifier = maybeVolumeIdentifier,
let referenceVolumeIdentifier = maybeReferenceVolumeIdentifier {
useTemporaryDirectory = volumeIdentifier == referenceVolumeIdentifier
} else {
useTemporaryDirectory = !isWritableFile(atPath: referenceURL.deletingPathExtension().path)
}
// This is the same name Darwin uses.
if useTemporaryDirectory {
url = temporaryDirectory.appendingPathComponent("TemporaryItems")
} else {
url = referenceURL.deletingPathExtension()
}
} else {
let urls = self.urls(for: directory, in: domain)
guard let theURL = urls.first else {
// On Apple OSes, this case returns nil without filling in the error parameter; Swift then synthesizes an error rather than trap.
// We simulate that behavior by throwing a private error.
throw URLForDirectoryError.directoryUnknown
}
url = theURL
}
var nameStorage: String?
func itemReplacementDirectoryName(forAttempt attempt: Int) -> String {
let name: String
if let someName = nameStorage {
name = someName
} else {
// Sanitize the process name for filesystem use:
var someName = ProcessInfo.processInfo.processName
let characterSet = CharacterSet.alphanumerics.inverted
while let whereIsIt = someName.rangeOfCharacter(from: characterSet, options: [], range: nil) {
someName.removeSubrange(whereIsIt)
}
name = someName
nameStorage = someName
}
if attempt == 0 {
return "(A Document Being Saved By \(name))"
} else {
return "(A Document Being Saved By \(name) \(attempt + 1)"
}
}
// To avoid races, on Darwin, the item replacement directory is _ALWAYS_ created, even if create is false.
if shouldCreate || directory == .itemReplacementDirectory {
var attributes: [FileAttributeKey : Any] = [:]
switch _SearchPathDomain(domain) {
case .some(.user):
attributes[.posixPermissions] = 0o700
case .some(.system):
attributes[.posixPermissions] = 0o755
attributes[.ownerAccountID] = 0 // root
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
attributes[.ownerAccountID] = 80 // on Darwin, the admin group's fixed ID.
#endif
default:
break
}
if directory == .itemReplacementDirectory {
try createDirectory(at: url, withIntermediateDirectories: true, attributes: attributes)
var attempt = 0
while true {
do {
let attemptedURL = url.appendingPathComponent(itemReplacementDirectoryName(forAttempt: attempt))
try createDirectory(at: attemptedURL, withIntermediateDirectories: false)
url = attemptedURL
break
} catch {
if let error = error as? NSError, error.domain == NSCocoaErrorDomain, error.code == CocoaError.fileWriteFileExists.rawValue {
attempt += 1
} else {
throw error
}
}
}
} else {
try createDirectory(at: url, withIntermediateDirectories: true, attributes: attributes)
}
}
return url
}
/* Sets 'outRelationship' to NSURLRelationshipContains if the directory at 'directoryURL' directly or indirectly contains the item at 'otherURL', meaning 'directoryURL' is found while enumerating parent URLs starting from 'otherURL'. Sets 'outRelationship' to NSURLRelationshipSame if 'directoryURL' and 'otherURL' locate the same item, meaning they have the same NSURLFileResourceIdentifierKey value. If 'directoryURL' is not a directory, or does not contain 'otherURL' and they do not locate the same file, then sets 'outRelationship' to NSURLRelationshipOther. If an error occurs, returns NO and sets 'error'.
*/
open func getRelationship(_ outRelationship: UnsafeMutablePointer<URLRelationship>, ofDirectoryAt directoryURL: URL, toItemAt otherURL: URL) throws {
let from = try _canonicalizedPath(toFileAtPath: directoryURL.path)
let to = try _canonicalizedPath(toFileAtPath: otherURL.path)
if from == to {
outRelationship.pointee = .same
} else if to.hasPrefix(from) && to.count > from.count + 1 /* the contained file's canonicalized path must contain at least one path separator and one filename component */ {
let character = to[to.index(to.startIndex, offsetBy: from.length)]
if character == "/" || character == "\\" {
outRelationship.pointee = .contains
} else {
outRelationship.pointee = .other
}
} else {
outRelationship.pointee = .other
}
}
/* Similar to -[NSFileManager getRelationship:ofDirectoryAtURL:toItemAtURL:error:], except that the directory is instead defined by an NSSearchPathDirectory and NSSearchPathDomainMask. Pass 0 for domainMask to instruct the method to automatically choose the domain appropriate for 'url'. For example, to discover if a file is contained by a Trash directory, call [fileManager getRelationship:&result ofDirectory:NSTrashDirectory inDomain:0 toItemAtURL:url error:&error].
*/
open func getRelationship(_ outRelationship: UnsafeMutablePointer<URLRelationship>, of directory: SearchPathDirectory, in domainMask: SearchPathDomainMask, toItemAt url: URL) throws {
let actualMask: SearchPathDomainMask
if domainMask.isEmpty {
switch directory {
case .applicationDirectory: fallthrough
case .demoApplicationDirectory: fallthrough
case .developerApplicationDirectory: fallthrough
case .adminApplicationDirectory: fallthrough
case .developerDirectory: fallthrough
case .userDirectory: fallthrough
case .documentationDirectory:
actualMask = .localDomainMask
case .libraryDirectory: fallthrough
case .autosavedInformationDirectory: fallthrough
case .documentDirectory: fallthrough
case .desktopDirectory: fallthrough
case .cachesDirectory: fallthrough
case .applicationSupportDirectory: fallthrough
case .downloadsDirectory: fallthrough
case .inputMethodsDirectory: fallthrough
case .moviesDirectory: fallthrough
case .musicDirectory: fallthrough
case .picturesDirectory: fallthrough
case .sharedPublicDirectory: fallthrough
case .preferencePanesDirectory: fallthrough
case .applicationScriptsDirectory: fallthrough
case .itemReplacementDirectory: fallthrough
case .trashDirectory:
actualMask = .userDomainMask
case .coreServiceDirectory: fallthrough
case .printerDescriptionDirectory: fallthrough
case .allApplicationsDirectory: fallthrough
case .allLibrariesDirectory:
actualMask = .systemDomainMask
}
} else {
actualMask = domainMask
}
try getRelationship(outRelationship, ofDirectoryAt: try self.url(for: directory, in: actualMask, appropriateFor: url, create: false), toItemAt: url)
}
/* createDirectoryAtURL:withIntermediateDirectories:attributes:error: creates a directory at the specified URL. If you pass 'NO' for withIntermediateDirectories, the directory must not exist at the time this call is made. Passing 'YES' for withIntermediateDirectories will create any necessary intermediate directories. This method returns YES if all directories specified in 'url' were created and attributes were set. Directories are created with attributes specified by the dictionary passed to 'attributes'. If no dictionary is supplied, directories are created according to the umask of the process. This method returns NO if a failure occurs at any stage of the operation. If an error parameter was provided, a presentable NSError will be returned by reference.
*/
open func createDirectory(at url: URL, withIntermediateDirectories createIntermediates: Bool, attributes: [FileAttributeKey : Any]? = [:]) throws {
guard url.isFileURL else {
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnsupportedScheme.rawValue, userInfo: [NSURLErrorKey : url])
}
try self.createDirectory(atPath: url.path, withIntermediateDirectories: createIntermediates, attributes: attributes)
}
/* createSymbolicLinkAtURL:withDestinationURL:error: returns YES if the symbolic link that point at 'destURL' was able to be created at the location specified by 'url'. 'destURL' is always resolved against its base URL, if it has one. If 'destURL' has no base URL and it's 'relativePath' is indeed a relative path, then a relative symlink will be created. If this method returns NO, the link was unable to be created and an NSError will be returned by reference in the 'error' parameter. This method does not traverse a terminal symlink.
*/
open func createSymbolicLink(at url: URL, withDestinationURL destURL: URL) throws {
guard url.isFileURL else {
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnsupportedScheme.rawValue, userInfo: [NSURLErrorKey : url])
}
guard destURL.scheme == nil || destURL.isFileURL else {
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnsupportedScheme.rawValue, userInfo: [NSURLErrorKey : destURL])
}
try self.createSymbolicLink(atPath: url.path, withDestinationPath: destURL.path)
}
/* Instances of FileManager may now have delegates. Each instance has one delegate, and the delegate is not retained. In versions of Mac OS X prior to 10.5, the behavior of calling [[NSFileManager alloc] init] was undefined. In Mac OS X 10.5 "Leopard" and later, calling [[NSFileManager alloc] init] returns a new instance of an FileManager.
*/
open weak var delegate: FileManagerDelegate?
/* setAttributes:ofItemAtPath:error: returns YES when the attributes specified in the 'attributes' dictionary are set successfully on the item specified by 'path'. If this method returns NO, a presentable NSError will be provided by-reference in the 'error' parameter. If no error is required, you may pass 'nil' for the error.
This method replaces changeFileAttributes:atPath:.
*/
open func setAttributes(_ attributes: [FileAttributeKey : Any], ofItemAtPath path: String) throws {
try _setAttributes(attributes, ofItemAtPath: path)
}
internal func _setAttributes(_ attributeValues: [FileAttributeKey : Any], ofItemAtPath path: String, includingPrivateAttributes: Bool = false) throws {
var attributes = Set(attributeValues.keys)
if !includingPrivateAttributes {
attributes.formIntersection(FileAttributeKey.allPublicKeys)
}
try _fileSystemRepresentation(withPath: path, { fsRep in
var flagsToSet: UInt32 = 0
var flagsToUnset: UInt32 = 0
var newModificationDate: Date?
var newAccessDate: Date?
for attribute in attributes {
func prepareToSetOrUnsetFlag(_ flag: Int32) {
guard let shouldSet = attributeValues[attribute] as? Bool else {
fatalError("Can't set \(attribute) to \(attributeValues[attribute] as Any?)")
}
if shouldSet {
flagsToSet |= UInt32(flag)
} else {
flagsToUnset |= UInt32(flag)
}
}
switch attribute {
case .posixPermissions:
guard let number = attributeValues[attribute] as? NSNumber else {
fatalError("Can't set file permissions to \(attributeValues[attribute] as Any?)")
}
#if os(macOS) || os(iOS)
let modeT = number.uint16Value
#elseif os(Linux) || os(Android) || os(Windows)
let modeT = number.uint32Value
#endif
guard chmod(fsRep, mode_t(modeT)) == 0 else {
throw _NSErrorWithErrno(errno, reading: false, path: path)
}
case .modificationDate: fallthrough
case ._accessDate:
#if os(Windows)
// Setting this attribute is unsupported on these platforms.
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnknown.rawValue)
#else
guard let providedDate = attributeValues[attribute] as? Date else {
fatalError("Can't set \(attribute) to \(attributeValues[attribute] as Any?)")
}
if attribute == .modificationDate {
newModificationDate = providedDate
} else if attribute == ._accessDate {
newAccessDate = providedDate
}
#endif
case .immutable: fallthrough
case ._userImmutable:
prepareToSetOrUnsetFlag(UF_IMMUTABLE)
case ._systemImmutable:
prepareToSetOrUnsetFlag(SF_IMMUTABLE)
case .appendOnly:
prepareToSetOrUnsetFlag(UF_APPEND)
case ._hidden:
#if os(Windows)
let attrs = try windowsFileAttributes(atPath: path).dwFileAttributes
guard let isHidden = attributeValues[attribute] as? Bool else {
fatalError("Can't set \(attribute) to \(attributeValues[attribute] as Any?)")
}
let hiddenAttrs = isHidden
? attrs | DWORD(FILE_ATTRIBUTE_HIDDEN)
: attrs & DWORD(bitPattern: ~FILE_ATTRIBUTE_HIDDEN)
guard path.withCString(encodedAs: UTF16.self, { SetFileAttributesW($0, hiddenAttrs) }) else {
fatalError("Couldn't set \(path) to be hidden")
}
#else
prepareToSetOrUnsetFlag(UF_HIDDEN)
#endif
// FIXME: On Darwin, these can be set with setattrlist(); and of course chown/chgrp on other OSes.
case .ownerAccountID: fallthrough
case .ownerAccountName: fallthrough
case .groupOwnerAccountID: fallthrough
case .groupOwnerAccountName: fallthrough
case .creationDate: fallthrough
case .extensionHidden:
// Setting these attributes is unsupported (for now) in swift-corelibs-foundation
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnknown.rawValue)
default:
fatalError("This attribute is unknown or cannot be set: \(attribute)")
}
}
if flagsToSet != 0 || flagsToUnset != 0 {
#if !canImport(Darwin) && !os(FreeBSD)
// Setting these attributes is unsupported on these platforms.
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnknown.rawValue)
#else
let stat = try _lstatFile(atPath: path, withFileSystemRepresentation: fsRep)
var flags = stat.st_flags
flags |= flagsToSet
flags &= ~flagsToUnset
guard chflags(fsRep, flags) == 0 else {
throw _NSErrorWithErrno(errno, reading: false, path: path)
}
#endif
}
if newModificationDate != nil || newAccessDate != nil {
// Set dates as the very last step, to avoid other operations overwriting these values:
try _updateTimes(atPath: path, withFileSystemRepresentation: fsRep, accessTime: newAccessDate, modificationTime: newModificationDate)
}
})
}
/* createDirectoryAtPath:withIntermediateDirectories:attributes:error: creates a directory at the specified path. If you pass 'NO' for createIntermediates, the directory must not exist at the time this call is made. Passing 'YES' for 'createIntermediates' will create any necessary intermediate directories. This method returns YES if all directories specified in 'path' were created and attributes were set. Directories are created with attributes specified by the dictionary passed to 'attributes'. If no dictionary is supplied, directories are created according to the umask of the process. This method returns NO if a failure occurs at any stage of the operation. If an error parameter was provided, a presentable NSError will be returned by reference.
This method replaces createDirectoryAtPath:attributes:
*/
open func createDirectory(atPath path: String, withIntermediateDirectories createIntermediates: Bool, attributes: [FileAttributeKey : Any]? = [:]) throws {
return try _createDirectory(atPath: path, withIntermediateDirectories: createIntermediates, attributes: attributes)
}
/**
Performs a shallow search of the specified directory and returns the paths of any contained items.
This method performs a shallow search of the directory and therefore does not traverse symbolic links or return the contents of any subdirectories. This method also does not return URLs for the current directory (“.”), parent directory (“..”) but it does return other hidden files (files that begin with a period character).
The order of the files in the returned array is undefined.
- Parameter path: The path to the directory whose contents you want to enumerate.
- Throws: `NSError` if the directory does not exist, this error is thrown with the associated error code.
- Returns: An array of String each of which identifies a file, directory, or symbolic link contained in `path`. The order of the files returned is undefined.
*/
open func contentsOfDirectory(atPath path: String) throws -> [String] {
var contents: [String] = []
try _contentsOfDir(atPath: path, { (entryName, entryType) throws in
contents.append(entryName)
})
return contents
}
/**
Performs a deep enumeration of the specified directory and returns the paths of all of the contained subdirectories.
This method recurses the specified directory and its subdirectories. The method skips the “.” and “..” directories at each level of the recursion.
Because this method recurses the directory’s contents, you might not want to use it in performance-critical code. Instead, consider using the enumeratorAtURL:includingPropertiesForKeys:options:errorHandler: or enumeratorAtPath: method to enumerate the directory contents yourself. Doing so gives you more control over the retrieval of items and more opportunities to abort the enumeration or perform other tasks at the same time.
- Parameter path: The path of the directory to list.
- Throws: `NSError` if the directory does not exist, this error is thrown with the associated error code.
- Returns: An array of NSString objects, each of which contains the path of an item in the directory specified by path. If path is a symbolic link, this method traverses the link. This method returns nil if it cannot retrieve the device of the linked-to file.
*/
open func subpathsOfDirectory(atPath path: String) throws -> [String] {
return try _subpathsOfDirectory(atPath: path)
}
/* attributesOfItemAtPath:error: returns an NSDictionary of key/value pairs containing the attributes of the item (file, directory, symlink, etc.) at the path in question. If this method returns 'nil', an NSError will be returned by reference in the 'error' parameter. This method does not traverse a terminal symlink.
This method replaces fileAttributesAtPath:traverseLink:.
*/
open func attributesOfItem(atPath path: String) throws -> [FileAttributeKey : Any] {
return try _attributesOfItem(atPath: path)
}
internal func _attributesOfItem(atPath path: String, includingPrivateAttributes: Bool = false) throws -> [FileAttributeKey: Any] {
var result: [FileAttributeKey:Any] = [:]
#if os(Linux)
let (s, creationDate) = try _statxFile(atPath: path)
result[.creationDate] = creationDate
#else
let s = try _lstatFile(atPath: path)
#endif
result[.size] = NSNumber(value: UInt64(s.st_size))
result[.modificationDate] = s.lastModificationDate
if includingPrivateAttributes {
result[._accessDate] = s.lastAccessDate
}
result[.posixPermissions] = NSNumber(value: _filePermissionsMask(mode: UInt32(s.st_mode)))
result[.referenceCount] = NSNumber(value: UInt64(s.st_nlink))
result[.systemNumber] = NSNumber(value: UInt64(s.st_dev))
result[.systemFileNumber] = NSNumber(value: UInt64(s.st_ino))
#if os(Windows)
result[.deviceIdentifier] = NSNumber(value: UInt64(s.st_rdev))
let attributes = try windowsFileAttributes(atPath: path)
let type = FileAttributeType(attributes: attributes, atPath: path)
#else
if let pwd = getpwuid(s.st_uid), pwd.pointee.pw_name != nil {
let name = String(cString: pwd.pointee.pw_name)
result[.ownerAccountName] = name
}
if let grd = getgrgid(s.st_gid), grd.pointee.gr_name != nil {
let name = String(cString: grd.pointee.gr_name)
result[.groupOwnerAccountName] = name
}
let type = FileAttributeType(statMode: mode_t(s.st_mode))
#endif
result[.type] = type
if type == .typeBlockSpecial || type == .typeCharacterSpecial {
result[.deviceIdentifier] = NSNumber(value: UInt64(s.st_rdev))
}
#if canImport(Darwin)
if (s.st_flags & UInt32(UF_IMMUTABLE | SF_IMMUTABLE)) != 0 {
result[.immutable] = NSNumber(value: true)
}
if includingPrivateAttributes {
result[._userImmutable] = (s.st_flags & UInt32(UF_IMMUTABLE)) != 0
result[._systemImmutable] = (s.st_flags & UInt32(SF_IMMUTABLE)) != 0
result[._hidden] = (s.st_flags & UInt32(UF_HIDDEN)) != 0
}
if (s.st_flags & UInt32(UF_APPEND | SF_APPEND)) != 0 {
result[.appendOnly] = NSNumber(value: true)
}
#endif
#if os(Windows)
let attrs = attributes.dwFileAttributes
result[._hidden] = attrs & DWORD(FILE_ATTRIBUTE_HIDDEN) != 0
#endif
result[.ownerAccountID] = NSNumber(value: UInt64(s.st_uid))
result[.groupOwnerAccountID] = NSNumber(value: UInt64(s.st_gid))
return result
}
/* attributesOfFileSystemForPath:error: returns an NSDictionary of key/value pairs containing the attributes of the filesystem containing the provided path. If this method returns 'nil', an NSError will be returned by reference in the 'error' parameter. This method does not traverse a terminal symlink.
This method replaces fileSystemAttributesAtPath:.
*/
open func attributesOfFileSystem(forPath path: String) throws -> [FileAttributeKey : Any] {
return try _attributesOfFileSystem(forPath: path)
}
/* createSymbolicLinkAtPath:withDestination:error: returns YES if the symbolic link that point at 'destPath' was able to be created at the location specified by 'path'. If this method returns NO, the link was unable to be created and an NSError will be returned by reference in the 'error' parameter. This method does not traverse a terminal symlink.
This method replaces createSymbolicLinkAtPath:pathContent:
*/
open func createSymbolicLink(atPath path: String, withDestinationPath destPath: String) throws {
return try _createSymbolicLink(atPath: path, withDestinationPath: destPath)
}
/* destinationOfSymbolicLinkAtPath:error: returns a String containing the path of the item pointed at by the symlink specified by 'path'. If this method returns 'nil', an NSError will be thrown.
This method replaces pathContentOfSymbolicLinkAtPath:
*/
open func destinationOfSymbolicLink(atPath path: String) throws -> String {
return try _destinationOfSymbolicLink(atPath: path)
}
internal func extraErrorInfo(srcPath: String?, dstPath: String?, userVariant: String?) -> [String : Any] {
var result = [String : Any]()
result["NSSourceFilePathErrorKey"] = srcPath
result["NSDestinationFilePath"] = dstPath
result["NSUserStringVariant"] = userVariant.map(NSArray.init(object:))
return result
}
internal func shouldProceedAfterError(_ error: Error, copyingItemAtPath path: String, toPath: String, isURL: Bool) -> Bool {
guard let delegate = self.delegate else { return false }
if isURL {
return delegate.fileManager(self, shouldProceedAfterError: error, copyingItemAt: URL(fileURLWithPath: path), to: URL(fileURLWithPath: toPath))
} else {
return delegate.fileManager(self, shouldProceedAfterError: error, copyingItemAtPath: path, toPath: toPath)
}
}
internal func shouldCopyItemAtPath(_ path: String, toPath: String, isURL: Bool) -> Bool {
guard let delegate = self.delegate else { return true }
if isURL {
return delegate.fileManager(self, shouldCopyItemAt: URL(fileURLWithPath: path), to: URL(fileURLWithPath: toPath))
} else {
return delegate.fileManager(self, shouldCopyItemAtPath: path, toPath: toPath)
}
}
fileprivate func _copyItem(atPath srcPath: String, toPath dstPath: String, isURL: Bool) throws {
try _copyOrLinkDirectoryHelper(atPath: srcPath, toPath: dstPath) { (srcPath, dstPath, fileType) in
guard shouldCopyItemAtPath(srcPath, toPath: dstPath, isURL: isURL) else {
return
}
do {
switch fileType {
case .typeRegular:
try _copyRegularFile(atPath: srcPath, toPath: dstPath)
case .typeSymbolicLink:
try _copySymlink(atPath: srcPath, toPath: dstPath)
default:
break
}
} catch {
if !shouldProceedAfterError(error, copyingItemAtPath: srcPath, toPath: dstPath, isURL: isURL) {
throw error
}
}
}
}
internal func shouldProceedAfterError(_ error: Error, movingItemAtPath path: String, toPath: String, isURL: Bool) -> Bool {
guard let delegate = self.delegate else { return false }
if isURL {
return delegate.fileManager(self, shouldProceedAfterError: error, movingItemAt: URL(fileURLWithPath: path), to: URL(fileURLWithPath: toPath))
} else {
return delegate.fileManager(self, shouldProceedAfterError: error, movingItemAtPath: path, toPath: toPath)
}
}
internal func shouldMoveItemAtPath(_ path: String, toPath: String, isURL: Bool) -> Bool {
guard let delegate = self.delegate else { return true }
if isURL {
return delegate.fileManager(self, shouldMoveItemAt: URL(fileURLWithPath: path), to: URL(fileURLWithPath: toPath))
} else {
return delegate.fileManager(self, shouldMoveItemAtPath: path, toPath: toPath)
}
}
internal func shouldProceedAfterError(_ error: Error, linkingItemAtPath path: String, toPath: String, isURL: Bool) -> Bool {
guard let delegate = self.delegate else { return false }
if isURL {
return delegate.fileManager(self, shouldProceedAfterError: error, linkingItemAt: URL(fileURLWithPath: path), to: URL(fileURLWithPath: toPath))
} else {
return delegate.fileManager(self, shouldProceedAfterError: error, linkingItemAtPath: path, toPath: toPath)
}
}
internal func shouldLinkItemAtPath(_ path: String, toPath: String, isURL: Bool) -> Bool {
guard let delegate = self.delegate else { return true }
if isURL {
return delegate.fileManager(self, shouldLinkItemAt: URL(fileURLWithPath: path), to: URL(fileURLWithPath: toPath))
} else {
return delegate.fileManager(self, shouldLinkItemAtPath: path, toPath: toPath)
}
}
internal func shouldProceedAfterError(_ error: Error, removingItemAtPath path: String, isURL: Bool) -> Bool {
guard let delegate = self.delegate else { return false }
if isURL {
return delegate.fileManager(self, shouldProceedAfterError: error, removingItemAt: URL(fileURLWithPath: path))
} else {
return delegate.fileManager(self, shouldProceedAfterError: error, removingItemAtPath: path)
}
}
internal func shouldRemoveItemAtPath(_ path: String, isURL: Bool) -> Bool {
guard let delegate = self.delegate else { return true }
if isURL {
return delegate.fileManager(self, shouldRemoveItemAt: URL(fileURLWithPath: path))
} else {
return delegate.fileManager(self, shouldRemoveItemAtPath: path)
}
}
open func copyItem(atPath srcPath: String, toPath dstPath: String) throws {
try _copyItem(atPath: srcPath, toPath: dstPath, isURL: false)
}
open func moveItem(atPath srcPath: String, toPath dstPath: String) throws {
try _moveItem(atPath: srcPath, toPath: dstPath, isURL: false)
}
open func linkItem(atPath srcPath: String, toPath dstPath: String) throws {
try _linkItem(atPath: srcPath, toPath: dstPath, isURL: false)
}
open func removeItem(atPath path: String) throws {
try _removeItem(atPath: path, isURL: false)
}
open func copyItem(at srcURL: URL, to dstURL: URL) throws {
guard srcURL.isFileURL else {
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnsupportedScheme.rawValue, userInfo: [NSURLErrorKey : srcURL])
}
guard dstURL.isFileURL else {
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnsupportedScheme.rawValue, userInfo: [NSURLErrorKey : dstURL])
}
try _copyItem(atPath: srcURL.path, toPath: dstURL.path, isURL: true)
}
open func moveItem(at srcURL: URL, to dstURL: URL) throws {
guard srcURL.isFileURL else {
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnsupportedScheme.rawValue, userInfo: [NSURLErrorKey : srcURL])
}
guard dstURL.isFileURL else {
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnsupportedScheme.rawValue, userInfo: [NSURLErrorKey : dstURL])
}
try _moveItem(atPath: srcURL.path, toPath: dstURL.path, isURL: true)
}
open func linkItem(at srcURL: URL, to dstURL: URL) throws {
guard srcURL.isFileURL else {
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnsupportedScheme.rawValue, userInfo: [NSURLErrorKey : srcURL])
}
guard dstURL.isFileURL else {
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnsupportedScheme.rawValue, userInfo: [NSURLErrorKey : dstURL])
}
try _linkItem(atPath: srcURL.path, toPath: dstURL.path, isURL: true)
}
open func removeItem(at url: URL) throws {
guard url.isFileURL else {
throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnsupportedScheme.rawValue, userInfo: [NSURLErrorKey : url])
}
try _removeItem(atPath: url.path, isURL: true)
}
/* Process working directory management. Despite the fact that these are instance methods on FileManager, these methods report and change (respectively) the working directory for the entire process. Developers are cautioned that doing so is fraught with peril.
*/
open var currentDirectoryPath: String {
return _currentDirectoryPath()
}
@discardableResult
open func changeCurrentDirectoryPath(_ path: String) -> Bool {
return _changeCurrentDirectoryPath(path)
}
/* The following methods are of limited utility. Attempting to predicate behavior based on the current state of the filesystem or a particular file on the filesystem is encouraging odd behavior in the face of filesystem race conditions. It's far better to attempt an operation (like loading a file or creating a directory) and handle the error gracefully than it is to try to figure out ahead of time whether the operation will succeed.
*/
open func fileExists(atPath path: String) -> Bool {
return _fileExists(atPath: path, isDirectory: nil)
}
open func fileExists(atPath path: String, isDirectory: UnsafeMutablePointer<ObjCBool>?) -> Bool {
return _fileExists(atPath: path, isDirectory: isDirectory)
}
open func isReadableFile(atPath path: String) -> Bool {
return _isReadableFile(atPath: path)
}
open func isWritableFile(atPath path: String) -> Bool {
return _isWritableFile(atPath: path)
}
open func isExecutableFile(atPath path: String) -> Bool {
return _isExecutableFile(atPath: path)
}
/**
- parameters:
- path: The path to the file we are trying to determine is deletable.
- returns: `true` if the file is deletable, `false` otherwise.
*/
open func isDeletableFile(atPath path: String) -> Bool {
return _isDeletableFile(atPath: path)
}
internal func _compareDirectories(atPath path1: String, andPath path2: String) -> Bool {
guard let enumerator1 = enumerator(atPath: path1) else {
return false
}
guard let enumerator2 = enumerator(atPath: path2) else {
return false
}
enumerator1.skipDescendants()
enumerator2.skipDescendants()
var path1entries = Set<String>()
while let item = enumerator1.nextObject() as? String {
path1entries.insert(item)
}
while let item = enumerator2.nextObject() as? String {
if path1entries.remove(item) == nil {
return false
}
if contentsEqual(atPath: NSString(string: path1).appendingPathComponent(item), andPath: NSString(string: path2).appendingPathComponent(item)) == false {
return false
}
}
return path1entries.isEmpty
}
internal func _filePermissionsMask(mode : UInt32) -> Int {
#if os(Windows)
return Int(mode & ~UInt32(ucrt.S_IFMT))
#elseif canImport(Darwin)
return Int(mode & ~UInt32(S_IFMT))
#else
return Int(mode & ~S_IFMT)
#endif
}
internal func _permissionsOfItem(atPath path: String) throws -> Int {
let fileInfo = try _lstatFile(atPath: path)
return _filePermissionsMask(mode: UInt32(fileInfo.st_mode))
}
#if os(Linux)
// statx() is only supported by Linux kernels >= 4.11.0
internal lazy var supportsStatx: Bool = {
let requiredVersion = OperatingSystemVersion(majorVersion: 4, minorVersion: 11, patchVersion: 0)
return ProcessInfo.processInfo.isOperatingSystemAtLeast(requiredVersion)
}()
// renameat2() is only supported by Linux kernels >= 3.15
internal lazy var kernelSupportsRenameat2: Bool = {
let requiredVersion = OperatingSystemVersion(majorVersion: 3, minorVersion: 15, patchVersion: 0)
return ProcessInfo.processInfo.isOperatingSystemAtLeast(requiredVersion)
}()
#endif
internal func _compareFiles(withFileSystemRepresentation file1Rep: UnsafePointer<Int8>, andFileSystemRepresentation file2Rep: UnsafePointer<Int8>, size: Int64, bufSize: Int) -> Bool {
guard let file1 = FileHandle(fileSystemRepresentation: file1Rep, flags: O_RDONLY, createMode: 0) else { return false }
guard let file2 = FileHandle(fileSystemRepresentation: file2Rep, flags: O_RDONLY, createMode: 0) else { return false }
var buffer1 = UnsafeMutablePointer<UInt8>.allocate(capacity: bufSize)
var buffer2 = UnsafeMutablePointer<UInt8>.allocate(capacity: bufSize)
defer {
buffer1.deallocate()
buffer2.deallocate()
}
var bytesLeft = size
while bytesLeft > 0 {
let bytesToRead = Int(min(Int64(bufSize), bytesLeft))
guard let file1BytesRead = try? file1._readBytes(into: buffer1, length: bytesToRead), file1BytesRead == bytesToRead else {
return false
}
guard let file2BytesRead = try? file2._readBytes(into: buffer2, length: bytesToRead), file2BytesRead == bytesToRead else {
return false
}
guard memcmp(buffer1, buffer2, bytesToRead) == 0 else {
return false
}
bytesLeft -= Int64(bytesToRead)
}
return true
}
/* -contentsEqualAtPath:andPath: does not take into account data stored in the resource fork or filesystem extended attributes.
*/
open func contentsEqual(atPath path1: String, andPath path2: String) -> Bool {
return _contentsEqual(atPath: path1, andPath: path2)
}
// For testing only: this facility pins the language used by displayName to the passed-in language.
private var _overriddenDisplayNameLanguages: [String]? = nil
internal func _overridingDisplayNameLanguages<T>(with languages: [String], within body: () throws -> T) rethrows -> T {
let old = _overriddenDisplayNameLanguages
defer { _overriddenDisplayNameLanguages = old }
_overriddenDisplayNameLanguages = languages
return try body()
}
private var _preferredLanguages: [String] {
return _overriddenDisplayNameLanguages ?? Locale.preferredLanguages
}
/* displayNameAtPath: returns an NSString suitable for presentation to the user. For directories which have localization information, this will return the appropriate localized string. This string is not suitable for passing to anything that must interact with the filesystem.
*/
open func displayName(atPath path: String) -> String {
let url = URL(fileURLWithPath: path)
let name = url.lastPathComponent
let nameWithoutExtension = url.deletingPathExtension().lastPathComponent
// https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemAdvancedPT/LocalizingtheNameofaDirectory/LocalizingtheNameofaDirectory.html
// This localizes a X.localized directory:
if url.pathExtension == "localized" {
let dotLocalized = url.appendingPathComponent(".localized")
var isDirectory: ObjCBool = false
if fileExists(atPath: dotLocalized.path, isDirectory: &isDirectory),
isDirectory.boolValue {
for language in _preferredLanguages {
let stringsFile = dotLocalized.appendingPathComponent(language).appendingPathExtension("strings")
if let data = try? Data(contentsOf: stringsFile),
let plist = (try? PropertyListSerialization.propertyList(from: data, format: nil)) as? NSDictionary {
let localizedName = (plist[nameWithoutExtension] as? NSString)?._swiftObject
return localizedName ?? nameWithoutExtension
}
}
// If we get here and we don't have a good name for this, still hide the extension:
return nameWithoutExtension
}
}
// We do not have the bundle resources to map the names of system directories with .localized files on Darwin, and system directories do not exist on other platforms, so just skip that on swift-corelibs-foundation:
// URL resource values are not yet implemented: https://bugs.swift.org/browse/SR-10365
// return (try? url.resourceValues(forKeys: [.hasHiddenExtensionKey]))?.hasHiddenExtension == true ? nameWithoutExtension : name
return name
}
/* componentsToDisplayForPath: returns an NSArray of display names for the path provided. Localization will occur as in displayNameAtPath: above. This array cannot and should not be reassembled into an usable filesystem path for any kind of access.
*/
open func componentsToDisplay(forPath path: String) -> [String]? {
var url = URL(fileURLWithPath: path)
var count = url.pathComponents.count
var result: [String] = []
while count > 0 {
result.insert(displayName(atPath: url.path), at: 0)
url = url.deletingLastPathComponent()
count -= 1
}
return result
}
/* enumeratorAtPath: returns an NSDirectoryEnumerator rooted at the provided path. If the enumerator cannot be created, this returns NULL. Because NSDirectoryEnumerator is a subclass of NSEnumerator, the returned object can be used in the for...in construct.
*/
open func enumerator(atPath path: String) -> DirectoryEnumerator? {
return NSPathDirectoryEnumerator(path: path)
}
/* enumeratorAtURL:includingPropertiesForKeys:options:errorHandler: returns an NSDirectoryEnumerator rooted at the provided directory URL. The NSDirectoryEnumerator returns NSURLs from the -nextObject method. The optional 'includingPropertiesForKeys' parameter indicates which resource properties should be pre-fetched and cached with each enumerated URL. The optional 'errorHandler' block argument is invoked when an error occurs. Parameters to the block are the URL on which an error occurred and the error. When the error handler returns YES, enumeration continues if possible. Enumeration stops immediately when the error handler returns NO.
If you wish to only receive the URLs and no other attributes, then pass '0' for 'options' and an empty NSArray ('[NSArray array]') for 'keys'. If you wish to have the property caches of the vended URLs pre-populated with a default set of attributes, then pass '0' for 'options' and 'nil' for 'keys'.
*/
// Note: Because the error handler is an optional block, the compiler treats it as @escaping by default. If that behavior changes, the @escaping will need to be added back.
open func enumerator(at url: URL, includingPropertiesForKeys keys: [URLResourceKey]?, options mask: DirectoryEnumerationOptions = [], errorHandler handler: (/* @escaping */ (URL, Error) -> Bool)? = nil) -> DirectoryEnumerator? {
return NSURLDirectoryEnumerator(url: url, options: mask, errorHandler: handler)
}
/* subpathsAtPath: returns an NSArray of all contents and subpaths recursively from the provided path. This may be very expensive to compute for deep filesystem hierarchies, and should probably be avoided.
*/
open func subpaths(atPath path: String) -> [String]? {
return try? subpathsOfDirectory(atPath: path)
}