-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
file.cr
974 lines (881 loc) · 29.4 KB
/
file.cr
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
class File < IO::FileDescriptor
end
require "./file/error"
require "crystal/system/file"
# A `File` instance represents a file entry in the local file system and allows using it as an `IO`.
#
# ```
# file = File.new("path/to/file")
# content = file.gets_to_end
# file.close
#
# # Implicit close with `open` and a block:
# content = File.open("path/to/file") do |file|
# file.gets_to_end
# end
#
# # Shortcut of the above:
# content = File.read("path/to/file")
#
# # Write to a file by opening with a "write mode" specified.
# File.open("path/to/file", "w") do |file|
# file.print "hello"
# end
# # Content of file on disk will now be "hello".
#
# # Shortcut of the above:
# File.write("path/to/file", "hello")
# ```
#
# See `new` for various options *mode* can be.
#
# ## Temporary Files
#
# Every tempfile is operated as a `File`, including initializing, reading and writing.
#
# ```
# tempfile = File.tempfile("foo")
#
# File.size(tempfile.path) # => 6
# File.info(tempfile.path).modification_time # => 2015-10-20 13:11:12 UTC
# File.exists?(tempfile.path) # => true
# File.read_lines(tempfile.path) # => ["foobar"]
# ```
#
# Files created from `tempfile` are stored in a directory that handles
# temporary files (`Dir.tempdir`):
#
# ```
# File.tempfile("foo").path # => "/tmp/foo.ulBCPS"
# ```
#
# It is encouraged to delete a tempfile after using it, which
# ensures they are not left behind in your filesystem until garbage collected.
#
# ```
# tempfile = File.tempfile("foo")
# tempfile.delete
# ```
class File < IO::FileDescriptor
# The file/directory separator character. `'/'` on all platforms.
SEPARATOR = '/'
# The file/directory separator string. `"/"` on all platforms.
SEPARATOR_STRING = "/"
# :nodoc:
DEFAULT_CREATE_PERMISSIONS = File::Permissions.new(0o644)
# The name of the null device on the host platform. `/dev/null` on UNIX and `NUL`
# on win32.
#
# When this device is opened using `File.open`, read operations will always
# return EOF, and any data written will be immediately discarded.
#
# ```
# File.open(File::NULL, "w") do |file|
# file.puts "this is discarded"
# end
# ```
NULL = {% if flag?(:win32) %}
"NUL"
{% else %}
"/dev/null"
{% end %}
# Options used to control the behavior of `Dir.glob`.
@[Flags]
enum MatchOptions
# Includes files whose name begins with a period (`.`).
DotFiles
# Includes files which have a hidden attribute backed by the native
# filesystem.
#
# On Windows, this matches files that have the NTFS hidden attribute set.
# This option alone doesn't match files with _both_ the hidden and the
# system attributes, `OSHidden` must also be used.
#
# On other systems, this has no effect.
NativeHidden
# Includes files which are considered hidden by operating system
# conventions (apart from `DotFiles`), but not by the filesystem.
#
# On Windows, this option alone has no effect. However, combining it with
# `NativeHidden` matches files that have both the NTFS hidden and system
# attributes set. Note that files with just the system attribute, but not
# the hidden attribute, are always matched regardless of this option or
# `NativeHidden`.
#
# On other systems, this has no effect.
OSHidden
# Returns a suitable platform-specific default set of options for
# `Dir.glob` and `Dir.[]`.
#
# Currently this is always `NativeHidden | OSHidden`.
def self.glob_default
NativeHidden | OSHidden
end
end
include Crystal::System::File
# This constructor is provided for subclasses to be able to initialize an
# `IO::FileDescriptor` with a *path* and *fd*.
private def initialize(@path, fd, blocking = false, encoding = nil, invalid = nil)
self.set_encoding(encoding, invalid: invalid) if encoding
super(fd, blocking)
end
# :nodoc:
def self.from_fd(path : String, fd : Int, *, blocking = false, encoding = nil, invalid = nil)
new(path, fd, blocking: blocking, encoding: encoding, invalid: invalid)
end
# Opens the file named by *filename*.
#
# *mode* must be one of the following file open modes:
#
# ```text
# Mode | Description
# -----------+------------------------------------------------------
# r rb | Read-only, starts at the beginning of the file.
# r+ r+b rb+ | Read-write, starts at the beginning of the file.
# w wb | Write-only, truncates existing file to zero length or
# | creates a new file if the file doesn't exist.
# w+ w+b wb+ | Read-write, truncates existing file to zero length or
# | creates a new file if the file doesn't exist.
# a ab | Write-only, all writes seek to the end of the file,
# | creates a new file if the file doesn't exist.
# a+ a+b ab+ | Read-write, all writes seek to the end of the file,
# | creates a new file if the file doesn't exist.
# ```
#
# Line endings are preserved on all platforms. The `b` mode flag has no
# effect; it is provided only for POSIX compatibility.
def self.new(filename : Path | String, mode = "r", perm = DEFAULT_CREATE_PERMISSIONS, encoding = nil, invalid = nil)
filename = filename.to_s
fd = Crystal::System::File.open(filename, mode, perm)
new(filename, fd, blocking: true, encoding: encoding, invalid: invalid)
end
getter path : String
# Returns a `File::Info` object for the file given by *path* or returns `nil`
# if the file does not exist.
#
# If *follow_symlinks* is set (the default), symbolic links are followed. Otherwise,
# symbolic links return information on the symlink itself.
#
# ```
# File.write("foo", "foo")
# File.info?("foo").try(&.size) # => 3
# File.info?("non_existent") # => nil
#
# File.symlink("foo", "bar")
# File.info?("bar", follow_symlinks: false).try(&.type.symlink?) # => true
# ```
#
# Use `IO::FileDescriptor#info` if the file is already open.
def self.info?(path : Path | String, follow_symlinks = true) : Info?
Crystal::System::File.info?(path.to_s, follow_symlinks)
end
# Returns a `File::Info` object for the file given by *path* or raises
# `File::Error` in case of an error.
#
# If *follow_symlinks* is set (the default), symbolic links are followed. Otherwise,
# symbolic links return information on the symlink itself.
#
# ```
# File.write("foo", "foo")
# File.info("foo").size # => 3
# File.info("foo").modification_time # => 2015-09-23 06:24:19 UTC
#
# File.symlink("foo", "bar")
# File.info("bar", follow_symlinks: false).type.symlink? # => true
# ```
#
# Use `IO::FileDescriptor#info` if the file is already open.
def self.info(path : Path | String, follow_symlinks = true) : Info
Crystal::System::File.info(path.to_s, follow_symlinks)
end
# Returns whether the file given by *path* exists.
#
# Symbolic links are dereferenced, posibly recursively. Returns `false` if a
# symbolic link refers to a non-existent file.
#
# ```
# File.delete("foo") if File.exists?("foo")
# File.exists?("foo") # => false
# File.write("foo", "foo")
# File.exists?("foo") # => true
# ```
def self.exists?(path : Path | String) : Bool
Crystal::System::File.exists?(path.to_s)
end
# Returns `true` if *path1* and *path2* represents the same file.
# The comparison take symlinks in consideration if *follow_symlinks* is `true`.
def self.same?(path1 : Path | String, path2 : Path | String, follow_symlinks = false) : Bool
info(path1.to_s, follow_symlinks).same_file? info(path2.to_s, follow_symlinks)
end
# Compares two files *filename1* to *filename2* to determine if they are identical.
# Returns `true` if content are the same, `false` otherwise.
#
# ```
# File.write("file.cr", "1")
# File.write("bar.cr", "1")
# File.same_content?("file.cr", "bar.cr") # => true
# ```
def self.same_content?(path1 : Path | String, path2 : Path | String) : Bool
open(path1, "rb") do |file1|
open(path2, "rb") do |file2|
return false unless file1.size == file2.size
same_content?(file1, file2)
end
end
end
# Returns the size of the file at *filename* in bytes.
# Raises `File::NotFoundError` if the file at *filename* does not exist.
#
# ```
# File.size("foo") # raises File::NotFoundError
# File.write("foo", "foo")
# File.size("foo") # => 3
# ```
def self.size(filename : Path | String) : Int64
info(filename).size
end
# Returns `true` if the file at *path* is empty, otherwise returns `false`.
# Raises `File::NotFoundError` if the file at *path* does not exist.
#
# ```
# File.write("foo", "")
# File.empty?("foo") # => true
# File.write("foo", "foo")
# File.empty?("foo") # => false
# ```
def self.empty?(path : Path | String) : Bool
size(path) == 0
end
# Returns `true` if *path* is readable by the real user id of this process else returns `false`.
#
# ```
# File.write("foo", "foo")
# File.readable?("foo") # => true
# ```
def self.readable?(path : Path | String) : Bool
Crystal::System::File.readable?(path.to_s)
end
# Returns `true` if *path* is writable by the real user id of this process else returns `false`.
#
# ```
# File.write("foo", "foo")
# File.writable?("foo") # => true
# ```
def self.writable?(path : Path | String) : Bool
Crystal::System::File.writable?(path.to_s)
end
# Returns `true` if *path* is executable by the real user id of this process else returns `false`.
#
# ```
# File.write("foo", "foo")
# File.executable?("foo") # => false
# ```
def self.executable?(path : Path | String) : Bool
Crystal::System::File.executable?(path.to_s)
end
# Returns `true` if given *path* exists and is a file.
#
# ```
# File.write("foo", "")
# Dir.mkdir("dir1")
# File.file?("foo") # => true
# File.file?("dir1") # => false
# File.file?("foobar") # => false
# ```
def self.file?(path : Path | String) : Bool
if info = info?(path)
info.type.file?
else
false
end
end
# Returns `true` if the given *path* exists and is a directory.
#
# ```
# File.write("foo", "")
# Dir.mkdir("dir2")
# File.directory?("foo") # => false
# File.directory?("dir2") # => true
# File.directory?("foobar") # => false
# ```
def self.directory?(path : Path | String) : Bool
Dir.exists?(path)
end
# Returns all components of the given *path* except the last one.
#
# ```
# File.dirname("/foo/bar/file.cr") # => "/foo/bar"
# ```
def self.dirname(path : Path | String) : String
Path.new(path).dirname
end
# Returns the last component of the given *path*.
#
# ```
# File.basename("/foo/bar/file.cr") # => "file.cr"
# ```
def self.basename(path : Path | String) : String
Path.new(path).basename
end
# Returns the last component of the given *path*.
#
# If *suffix* is present at the end of *path*, it is removed.
#
# ```
# File.basename("/foo/bar/file.cr", ".cr") # => "file"
# ```
def self.basename(path : Path | String, suffix : String) : String
Path.new(path).basename(suffix.check_no_null_byte)
end
# Changes the owner of the specified file.
#
# ```
# File.chown("/foo/bar/baz.cr", 1001, 100)
# File.chown("/foo/bar", gid: 100)
# ```
#
# Unless *follow_symlinks* is set to `true`, then the owner symlink itself will
# be changed, otherwise the owner of the symlink destination file will be
# changed. For example, assuming symlinks as `foo -> bar -> baz`:
#
# ```
# File.chown("foo", gid: 100) # changes foo's gid
# File.chown("foo", gid: 100, follow_symlinks: true) # changes baz's gid
# ```
#
# Use `#chown` if the `File` is already open.
def self.chown(path : Path | String, uid : Int = -1, gid : Int = -1, follow_symlinks = false) : Nil
Crystal::System::File.chown(path.to_s, uid, gid, follow_symlinks)
end
# Changes the permissions of the specified file.
#
# Symlinks are dereferenced, so that only the permissions of the symlink
# destination are changed, never the permissions of the symlink itself.
#
# ```
# File.chmod("foo", 0o755)
# File.info("foo").permissions.value # => 0o755
#
# File.chmod("foo", 0o700)
# File.info("foo").permissions.value # => 0o700
# ```
#
# Use `#chmod` if the `File` is already open.
def self.chmod(path : Path | String, permissions : Int | Permissions) : Nil
Crystal::System::File.chmod(path.to_s, permissions)
end
# Deletes the file at *path*. Raises `File::Error` on failure.
#
# On Windows, this also deletes reparse points, including symbolic links,
# regardless of whether the reparse point is a directory.
#
# ```
# File.write("foo", "")
# File.delete("./foo")
# File.delete("./bar") # raises File::NotFoundError (No such file or directory)
# ```
def self.delete(path : Path | String) : Nil
Crystal::System::File.delete(path.to_s, raise_on_missing: true)
end
# Deletes the file at *path*, or returns `false` if the file does not exist.
# Raises `File::Error` on other kinds of failure.
#
# On Windows, this also deletes reparse points, including symbolic links,
# regardless of whether the reparse point is a directory.
#
# ```
# File.write("foo", "")
# File.delete?("./foo") # => true
# File.delete?("./bar") # => false
# ```
def self.delete?(path : Path | String) : Bool
Crystal::System::File.delete(path.to_s, raise_on_missing: false)
end
# Returns *filename*'s extension, or an empty string if it has no extension.
#
# ```
# File.extname("foo.cr") # => ".cr"
# ```
def self.extname(filename : Path | String) : String
Path.new(filename).extension
end
# Converts *path* to an absolute path. Relative paths are
# referenced from the current working directory of the process unless
# *dir* is given, in which case it will be used as the starting point.
# "~" is expanded to the value passed to *home*.
# If it is `false` (default), home is not expanded.
# If `true`, it is expanded to the user's home directory (`Path.home`).
#
# ```
# File.expand_path("foo") # => "/home/.../foo"
# File.expand_path("~/foo", home: "/bar") # => "/bar/foo"
# File.expand_path("baz", "/foo/bar") # => "/foo/bar/baz"
# ```
def self.expand_path(path : Path | String, dir = nil, *, home = false) : String
Path.new(path).expand(dir || Dir.current, home: home).to_s
end
class BadPatternError < Exception
end
# Matches *path* against *pattern*.
#
# The pattern syntax is similar to shell filename globbing. It may contain the following metacharacters:
#
# * `*` matches an unlimited number of arbitrary characters excluding `/`.
# * `"*"` matches all regular files.
# * `"c*"` matches all files beginning with `c`.
# * `"*c"` matches all files ending with `c`.
# * `"*c*"` matches all files that have `c` in them (including at the beginning or end).
# * `**` matches directories recursively if followed by `/`.
# If this path segment contains any other characters, it is the same as the usual `*`.
# * `?` matches any one character excluding `/`.
# * character sets:
# * `[abc]` matches any one of these character.
# * `[^abc]` matches any one character other than these.
# * `[a-z]` matches any one character in the range.
# * `{a,b}` matches subpattern `a` or `b`.
# * `\\` escapes the next character.
#
# NOTE: Only `/` is recognized as path separator in both *pattern* and *path*.
def self.match?(pattern : String, path : Path | String) : Bool
expanded_patterns = [] of String
File.expand_brace_pattern(pattern, expanded_patterns)
expanded_patterns.each do |expanded_pattern|
return true if match_single_pattern(expanded_pattern, path.to_s)
end
false
end
private def self.match_single_pattern(pattern : String, path : String)
# linear-time algorithm adapted from https://research.swtch.com/glob
preader = Char::Reader.new(pattern)
sreader = Char::Reader.new(path)
next_ppos = 0
next_spos = 0
strlen = path.bytesize
escaped = false
while true
pnext = preader.has_next?
snext = sreader.has_next?
return true unless pnext || snext
if pnext
pchar = preader.current_char
char = sreader.current_char
case {pchar, escaped}
when {'\\', false}
escaped = true
preader.next_char
next
when {'?', false}
if snext && char != '/'
preader.next_char
sreader.next_char
next
end
when {'*', false}
double_star = preader.peek_next_char == '*'
if char == '/' && !double_star
preader.next_char
next_spos = 0
next
else
next_ppos = preader.pos
next_spos = sreader.pos + sreader.current_char_width
preader.next_char
preader.next_char if double_star
next
end
when {'[', false}
pnext = preader.has_next?
character_matched = false
character_set_open = true
escaped = false
inverted = false
case preader.peek_next_char
when '^'
inverted = true
preader.next_char
when ']'
raise BadPatternError.new "Invalid character set: empty character set"
else
# Nothing
# TODO: check if this branch is fine
end
while pnext
pchar = preader.next_char
case {pchar, escaped}
when {'\\', false}
escaped = true
when {']', false}
character_set_open = false
break
when {'-', false}
raise BadPatternError.new "Invalid character set: missing range start"
else
escaped = false
if preader.has_next? && preader.peek_next_char == '-'
preader.next_char
range_end = preader.next_char
case range_end
when ']'
raise BadPatternError.new "Invalid character set: missing range end"
when '\\'
range_end = preader.next_char
else
# Nothing
# TODO: check if this branch is fine
end
range = (pchar..range_end)
character_matched = true if range.includes?(char)
elsif char == pchar
character_matched = true
end
end
pnext = preader.has_next?
false
end
raise BadPatternError.new "Invalid character set: unterminated character set" if character_set_open
if character_matched != inverted && snext
preader.next_char
sreader.next_char
next
end
else
escaped = false
if snext && sreader.current_char == pchar
preader.next_char
sreader.next_char
next
end
end
end
if 0 < next_spos <= strlen
preader.pos = next_ppos
sreader.pos = next_spos
next
end
raise BadPatternError.new "Empty escape character" if escaped
return false
end
end
# :nodoc:
def self.expand_brace_pattern(pattern : String, expanded) : Array(String)?
reader = Char::Reader.new(pattern)
lbrace = nil
rbrace = nil
alt_start = nil
alternatives = [] of String
nest = 0
escaped = false
reader.each do |char|
case {char, escaped}
when {'{', false}
lbrace = reader.pos if nest == 0
nest += 1
when {'}', false}
nest -= 1
if nest == 0
rbrace = reader.pos
start = (alt_start || lbrace).not_nil! + 1
alternatives << pattern.byte_slice(start, reader.pos - start)
break
end
when {',', false}
if nest == 1
start = (alt_start || lbrace).not_nil! + 1
alternatives << pattern.byte_slice(start, reader.pos - start)
alt_start = reader.pos
end
when {'\\', false}
escaped = true
else
escaped = false
end
end
if lbrace && rbrace
front = pattern.byte_slice(0, lbrace)
back = pattern.byte_slice(rbrace + 1)
alternatives.each do |alt|
brace_pattern = {front, alt, back}.join
expand_brace_pattern brace_pattern, expanded
end
else
expanded << pattern
end
end
# Resolves the real path of *path* by following symbolic links.
def self.realpath(path : Path | String) : String
Crystal::System::File.realpath(path.to_s)
end
# :ditto:
@[Deprecated("Use `.realpath` instead.")]
def self.real_path(path : Path | String) : String
realpath(path)
end
# Creates a new link (also known as a hard link) at *new_path* to an existing file
# given by *old_path*.
def self.link(old_path : Path | String, new_path : Path | String) : Nil
Crystal::System::File.link(old_path.to_s, new_path.to_s)
end
# Creates a symbolic link at *new_path* to an existing file given by *old_path*.
def self.symlink(old_path : Path | String, new_path : Path | String) : Nil
Crystal::System::File.symlink(old_path.to_s, new_path.to_s)
end
# Returns `true` if the *path* is a symbolic link.
def self.symlink?(path : Path | String) : Bool
if info = info?(path, follow_symlinks: false)
info.type.symlink?
else
false
end
end
# Returns value of a symbolic link .
def self.readlink(path : Path | String) : String
Crystal::System::File.readlink(path.to_s)
end
# Opens the file named by *filename*. If a file is being created, its initial
# permissions may be set using the *perm* parameter.
#
# See `self.new` for what *mode* can be.
def self.open(filename : Path | String, mode = "r", perm = DEFAULT_CREATE_PERMISSIONS, encoding = nil, invalid = nil) : self
new filename, mode, perm, encoding, invalid
end
# Opens the file named by *filename*. If a file is being created, its initial
# permissions may be set using the *perm* parameter. Then given block will be passed the opened
# file as an argument, the file will be automatically closed when the block returns.
#
# See `self.new` for what *mode* can be.
def self.open(filename : Path | String, mode = "r", perm = DEFAULT_CREATE_PERMISSIONS, encoding = nil, invalid = nil, &)
file = new filename, mode, perm, encoding, invalid
begin
yield file
ensure
file.close
end
end
# Returns the content of *filename* as a string.
#
# ```
# File.write("bar", "foo")
# File.read("bar") # => "foo"
# ```
def self.read(filename : Path | String, encoding = nil, invalid = nil) : String
open(filename, "r") do |file|
if encoding
file.set_encoding(encoding, invalid: invalid)
file.gets_to_end
else
# We try to read a string with an initialize capacity
# equal to the file's size, but the size might not be
# correct or even be zero (for example for /proc files)
size = file.size.to_i
size = 256 if size == 0
String.build(size) do |io|
IO.copy(file, io)
end
end
end
end
# Yields each line in *filename* to the given block.
#
# ```
# File.write("foobar", "foo\nbar")
#
# array = [] of String
# File.each_line("foobar") do |line|
# array << line
# end
# array # => ["foo", "bar"]
# ```
def self.each_line(filename : Path | String, encoding = nil, invalid = nil, chomp = true, &)
open(filename, "r", encoding: encoding, invalid: invalid) do |file|
file.each_line(chomp: chomp) do |line|
yield line
end
end
end
# Returns all lines in *filename* as an array of strings.
#
# ```
# File.write("foobar", "foo\nbar")
# File.read_lines("foobar") # => ["foo", "bar"]
# ```
def self.read_lines(filename : Path | String, encoding = nil, invalid = nil, chomp = true) : Array(String)
lines = [] of String
each_line(filename, encoding: encoding, invalid: invalid, chomp: chomp) do |line|
lines << line
end
lines
end
# Writes the given *content* to *filename*.
#
# By default, an existing file will be overwritten.
#
# *filename* will be created if it does not already exist.
#
# ```
# File.write("foo", "bar")
# File.write("foo", "baz", mode: "a")
# ```
#
# NOTE: If the content is a `Slice(UInt8)`, those bytes will be written.
# If it's an `IO`, all bytes from the `IO` will be written.
# Otherwise, the string representation of *content* will be written
# (the result of invoking `to_s` on *content*).
#
# See `self.new` for what *mode* can be.
def self.write(filename : Path | String, content, perm = DEFAULT_CREATE_PERMISSIONS, encoding = nil, invalid = nil, mode = "w")
open(filename, mode, perm, encoding: encoding, invalid: invalid) do |file|
case content
when Bytes
file.sync = true
file.write(content)
when IO
file.sync = true
IO.copy(content, file)
else
file.print(content)
end
end
end
# Copies the file *src* to the file *dst*.
# Permission bits are copied too.
#
# ```
# File.touch("afile")
# File.chmod("afile", 0o600)
# File.copy("afile", "afile_copy")
# File.info("afile_copy").permissions.value # => 0o600
# ```
def self.copy(src : String | Path, dst : String | Path) : Nil
open(src) do |s|
open(dst, "wb") do |d|
# TODO use sendfile or copy_file_range syscall. See #8926, #8919
IO.copy(s, d)
d.flush # need to flush in case permissions are read-only
# Set the permissions after the content is written in case src permissions is read-only
d.chmod(s.info.permissions)
end
end
end
# Returns a new string formed by joining the strings using `File::SEPARATOR`.
#
# ```
# File.join("foo", "bar", "baz") # => "foo/bar/baz"
# File.join("foo/", "/bar/", "/baz") # => "foo/bar/baz"
# File.join("/foo/", "/bar/", "/baz/") # => "/foo/bar/baz/"
# ```
def self.join(*parts : String | Path) : String
Path.new(*parts).to_s
end
# Returns a new string formed by joining the strings using `File::SEPARATOR`.
#
# ```
# File.join({"foo", "bar", "baz"}) # => "foo/bar/baz"
# File.join({"foo/", "/bar/", "/baz"}) # => "foo/bar/baz"
# File.join(["/foo/", "/bar/", "/baz/"]) # => "/foo/bar/baz/"
# ```
def self.join(parts : Enumerable) : String
Path.new(parts).to_s
end
# Moves *old_filename* to *new_filename*.
#
# ```
# File.write("afile", "foo")
# File.exists?("afile") # => true
#
# File.rename("afile", "afile.cr")
# File.exists?("afile") # => false
# File.exists?("afile.cr") # => true
# ```
def self.rename(old_filename : Path | String, new_filename : Path | String) : Nil
if error = Crystal::System::File.rename(old_filename.to_s, new_filename.to_s)
raise error
end
end
# Rename the current `File`
def rename(new_filename : Path | String) : Nil
File.rename(@path, new_filename)
@path = new_filename.to_s
end
# Sets the access and modification times of *filename*.
#
# Use `#utime` if the `File` is already open.
def self.utime(atime : Time, mtime : Time, filename : Path | String) : Nil
Crystal::System::File.utime(atime, mtime, filename.to_s)
end
# Attempts to set the access and modification times of the file named
# in the *filename* parameter to the value given in *time*.
#
# If the file does not exist, it will be created.
#
# Use `#touch` if the `File` is already open.
def self.touch(filename : Path | String, time : Time = Time.utc) : Nil
open(filename, "a") { } unless exists?(filename)
utime time, time, filename
end
# Returns the size in bytes of the currently opened file.
def size : Int64
info.size
end
# Truncates the file to the specified *size*. Requires that the current file is opened
# for writing.
def truncate(size = 0) : Nil
flush
system_truncate(size)
end
# Yields an `IO` to read a section inside this file.
# Multiple sections can be read concurrently.
def read_at(offset, bytesize, & : IO ->)
self_bytesize = self.size
unless 0 <= offset <= self_bytesize
raise ArgumentError.new("Offset out of bounds")
end
if bytesize < 0
raise ArgumentError.new("Negative bytesize")
end
unless 0 <= offset + bytesize <= self_bytesize
raise ArgumentError.new("Bytesize out of bounds")
end
io = PReader.new(self, offset, bytesize)
yield io ensure io.close
end
def inspect(io : IO) : Nil
io << "#<File:" << @path
io << " (closed)" if closed?
io << '>'
end
# Changes the owner of the specified file.
#
# ```
# file.chown(1001, 100)
# file.chown(gid: 100)
# ```
def chown(uid : Int = -1, gid : Int = -1) : Nil
Crystal::System::File.fchown(@path, fd, uid, gid)
end
# Changes the permissions of the specified file.
#
# ```
# file.chmod(0o755)
# file.info.permissions.value # => 0o755
#
# file.chmod(0o700)
# file.info.permissions.value # => 0o700
# ```
def chmod(permissions : Int | Permissions) : Nil
system_chmod(@path, permissions)
end
# Sets the access and modification times
def utime(atime : Time, mtime : Time) : Nil
system_utime(atime, mtime, @path)
end
# Attempts to set the access and modification times
# to the value given in *time*.
def touch(time : Time = Time.utc) : Nil
utime time, time
end
# Deletes this file.
def delete : Nil
File.delete(@path)
end
end
require "./file/*"