Module: FileUtils
Overview
fileutils.rb
Copyright © 2000-2007 Minero Aoki
This program is free software. You can distribute/modify this program under the same terms of ruby.
module FileUtils
Namespace for several file utility methods for copying, moving, removing, etc.
Module Functions
cd(dir, options)
cd(dir, options) {|dir| .... }
pwd()
mkdir(dir, options)
mkdir(list, options)
mkdir_p(dir, options)
mkdir_p(list, options)
rmdir(dir, options)
rmdir(list, options)
ln(old, new, options)
ln(list, destdir, options)
ln_s(old, new, options)
ln_s(list, destdir, options)
ln_sf(src, dest, options)
cp(src, dest, options)
cp(list, dir, options)
cp_r(src, dest, options)
cp_r(list, dir, options)
mv(src, dest, options)
mv(list, dir, options)
rm(list, options)
rm_r(list, options)
rm_rf(list, options)
install(src, dest, mode = <src's>, options)
chmod(mode, list, options)
chmod_R(mode, list, options)
chown(user, group, list, options)
chown_R(user, group, list, options)
touch(list, options)
The options
parameter is a hash of options, taken from the list :force
, :noop
, :preserve
, and :verbose
. :noop
means that no changes are made. The other two are obvious. Each method documents the options that it honours.
All methods that have the concept of a “source” file or directory can take either one file or a list of files in that argument. See the method documentation for examples.
There are some ‘low level’ methods, which do not accept any option:
copy_entry(src, dest, preserve = false, dereference = false)
copy_file(src, dest, preserve = false, dereference = true)
copy_stream(srcstream, deststream)
remove_entry(path, force = false)
remove_entry_secure(path, force = false)
remove_file(path, force = false)
compare_file(path_a, path_b)
compare_stream(stream_a, stream_b)
uptodate?(file, cmp_list)
module FileUtils::Verbose
This module has all methods of FileUtils module, but it outputs messages before acting. This equates to passing the :verbose
flag to methods in FileUtils.
module FileUtils::NoWrite
This module has all methods of FileUtils module, but never changes files/directories. This equates to passing the :noop
flag to methods in FileUtils.
module FileUtils::DryRun
This module has all methods of FileUtils module, but never changes files/directories. This equates to passing the :noop
and :verbose
flags to methods in FileUtils.
Defined Under Namespace
Modules: DryRun, NoWrite, StreamUtils_, Verbose Classes: Entry_
Constant Summary collapse
- OPT_TABLE =
This hash table holds command options.
{}
Instance Method Summary collapse
-
#cd(dir, options = {}, &block) ⇒ Object
(also: #chdir)
Options: verbose.
-
#chmod(mode, list, options = {}) ⇒ Object
Options: noop verbose.
-
#chmod_R(mode, list, options = {}) ⇒ Object
Options: noop verbose force.
-
#chown(user, group, list, options = {}) ⇒ Object
Options: noop verbose.
-
#chown_R(user, group, list, options = {}) ⇒ Object
Options: noop verbose force.
-
#compare_file(a, b) ⇒ Object
(also: #identical?, #cmp)
Returns true if the contents of a file A and a file B are identical.
-
#compare_stream(a, b) ⇒ Object
Returns true if the contents of a stream
a
andb
are identical. -
#copy_entry(src, dest, preserve = false, dereference_root = false, remove_destination = false) ⇒ Object
Copies a file system entry
src
todest
. -
#copy_file(src, dest, preserve = false, dereference = true) ⇒ Object
Copies file contents of
src
todest
. -
#copy_stream(src, dest) ⇒ Object
Copies stream
src
todest
. -
#cp(src, dest, options = {}) ⇒ Object
(also: #copy)
Options: preserve noop verbose.
-
#cp_r(src, dest, options = {}) ⇒ Object
Options: preserve noop verbose dereference_root remove_destination.
-
#install(src, dest, options = {}) ⇒ Object
Options: mode preserve noop verbose.
-
#ln(src, dest, options = {}) ⇒ Object
(also: #link)
Options: force noop verbose.
-
#ln_s(src, dest, options = {}) ⇒ Object
(also: #symlink)
Options: force noop verbose.
-
#ln_sf(src, dest, options = {}) ⇒ Object
Options: noop verbose.
-
#mkdir(list, options = {}) ⇒ Object
Options: mode noop verbose.
-
#mkdir_p(list, options = {}) ⇒ Object
(also: #mkpath, #makedirs)
Options: mode noop verbose.
-
#mv(src, dest, options = {}) ⇒ Object
(also: #move)
Options: force noop verbose.
-
#pwd ⇒ Object
(also: #getwd)
Options: (none).
-
#remove_dir(path, force = false) ⇒ Object
Removes a directory
dir
and its contents recursively. -
#remove_entry(path, force = false) ⇒ Object
This method removes a file system entry
path
. -
#remove_entry_secure(path, force = false) ⇒ Object
This method removes a file system entry
path
. -
#remove_file(path, force = false) ⇒ Object
Removes a file
path
. -
#rm(list, options = {}) ⇒ Object
(also: #remove)
Options: force noop verbose.
-
#rm_f(list, options = {}) ⇒ Object
(also: #safe_unlink)
Options: noop verbose.
-
#rm_r(list, options = {}) ⇒ Object
Options: force noop verbose secure.
-
#rm_rf(list, options = {}) ⇒ Object
(also: #rmtree)
Options: noop verbose secure.
-
#rmdir(list, options = {}) ⇒ Object
Options: noop, verbose.
-
#touch(list, options = {}) ⇒ Object
Options: noop verbose.
-
#uptodate?(new, old_list) ⇒ Boolean
Options: (none).
Instance Method Details
#cd(dir, options = {}, &block) ⇒ Object Also known as: chdir
Options: verbose
Changes the current directory to the directory dir
.
If this method is called with block, resumes to the old working directory after the block execution finished.
FileUtils.cd('/', :verbose => true) # chdir and report it
FileUtils.cd('/') do # chdir
[...] # do something
end # return to original directory
203 204 205 206 207 208 |
# File 'lib/fileutils.rb', line 203 def cd(dir, = {}, &block) # :yield: dir , OPT_TABLE['cd'] "cd #{dir}" if [:verbose] Dir.chdir(dir, &block) 'cd -' if [:verbose] and block end |
#chmod(mode, list, options = {}) ⇒ Object
Options: noop verbose
Changes permission bits on the named files (in list
) to the bit pattern represented by mode
.
mode
is the symbolic and absolute mode can be used.
Absolute mode is
FileUtils.chmod 0755, 'somecommand'
FileUtils.chmod 0644, %w(my.rb your.rb his.rb her.rb)
FileUtils.chmod 0755, '/usr/bin/ruby', :verbose => true
Symbolic mode is
FileUtils.chmod "u=wrx,go=rx", 'somecommand'
FileUtils.chmod "u=wr,go=rr", %w(my.rb your.rb his.rb her.rb)
FileUtils.chmod "u=wrx,go=rx", '/usr/bin/ruby', :verbose => true
- “a”
-
is user, group, other mask.
- “u”
-
is user’s mask.
- “g”
-
is group’s mask.
- “o”
-
is other’s mask.
- “w”
-
is write permission.
- “r”
-
is read permission.
- “x”
-
is execute permission.
- “X”
-
is execute permission for directories only, must be used in conjunction with “+”
- “s”
-
is uid, gid.
- “t”
-
is sticky bit.
- “+”
-
is added to a class given the specified mode.
- “-”
-
Is removed from a given class given mode.
- “=”
-
Is the exact nature of the class will be given a specified mode.
1040 1041 1042 1043 1044 1045 1046 1047 1048 |
# File 'lib/fileutils.rb', line 1040 def chmod(mode, list, = {}) , OPT_TABLE['chmod'] list = fu_list(list) sprintf('chmod %s %s', mode_to_s(mode), list.join(' ')) if [:verbose] return if [:noop] list.each do |path| Entry_.new(path).chmod(fu_mode(mode, path)) end end |
#chmod_R(mode, list, options = {}) ⇒ Object
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 |
# File 'lib/fileutils.rb', line 1061 def chmod_R(mode, list, = {}) , OPT_TABLE['chmod_R'] list = fu_list(list) sprintf('chmod -R%s %s %s', ([:force] ? 'f' : ''), mode_to_s(mode), list.join(' ')) if [:verbose] return if [:noop] list.each do |root| Entry_.new(root).traverse do |ent| begin ent.chmod(fu_mode(mode, ent.path)) rescue raise unless [:force] end end end end |
#chown(user, group, list, options = {}) ⇒ Object
Options: noop verbose
Changes owner and group on the named files (in list
) to the user user
and the group group
. user
and group
may be an ID (Integer/String) or a name (String). If user
or group
is nil, this method does not change the attribute.
FileUtils.chown 'root', 'staff', '/usr/local/bin/ruby'
FileUtils.chown nil, 'bin', Dir.glob('/usr/bin/*'), :verbose => true
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 |
# File 'lib/fileutils.rb', line 1093 def chown(user, group, list, = {}) , OPT_TABLE['chown'] list = fu_list(list) sprintf('chown %s%s', [user,group].compact.join(':') + ' ', list.join(' ')) if [:verbose] return if [:noop] uid = fu_get_uid(user) gid = fu_get_gid(group) list.each do |path| Entry_.new(path).chown uid, gid end end |
#chown_R(user, group, list, options = {}) ⇒ Object
Options: noop verbose force
Changes owner and group on the named files (in list
) to the user user
and the group group
recursively. user
and group
may be an ID (Integer/String) or a name (String). If user
or group
is nil, this method does not change the attribute.
FileUtils.chown_R 'www', 'www', '/var/www/htdocs'
FileUtils.chown_R 'cvs', 'cvs', '/var/cvs', :verbose => true
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 |
# File 'lib/fileutils.rb', line 1121 def chown_R(user, group, list, = {}) , OPT_TABLE['chown_R'] list = fu_list(list) sprintf('chown -R%s %s%s', ([:force] ? 'f' : ''), [user,group].compact.join(':') + ' ', list.join(' ')) if [:verbose] return if [:noop] uid = fu_get_uid(user) gid = fu_get_gid(group) return unless uid or gid list.each do |root| Entry_.new(root).traverse do |ent| begin ent.chown uid, gid rescue raise unless [:force] end end end end |
#compare_file(a, b) ⇒ Object Also known as: identical?, cmp
878 879 880 881 882 883 884 885 |
# File 'lib/fileutils.rb', line 878 def compare_file(a, b) return false unless File.size(a) == File.size(b) File.open(a, 'rb') {|fa| File.open(b, 'rb') {|fb| return compare_stream(fa, fb) } } end |
#compare_stream(a, b) ⇒ Object
Returns true if the contents of a stream a
and b
are identical.
897 898 899 900 901 902 903 904 905 906 907 |
# File 'lib/fileutils.rb', line 897 def compare_stream(a, b) bsize = fu_stream_blksize(a, b) sa = "" sb = "" begin a.read(bsize, sa) b.read(bsize, sb) return true if sa.empty? && sb.empty? end while sa == sb false end |
#copy_entry(src, dest, preserve = false, dereference_root = false, remove_destination = false) ⇒ Object
Copies a file system entry src
to dest
. If src
is a directory, this method copies its contents recursively. This method preserves file types, c.f. symlink, directory… (FIFO, device files and etc. are not supported yet)
Both of src
and dest
must be a path name. src
must exist, dest
must not exist.
If preserve
is true, this method preserves owner, group, permissions and modified time.
If dereference_root
is true, this method dereference tree root.
If remove_destination
is true, this method removes each destination file before copy.
528 529 530 531 532 533 534 535 536 537 |
# File 'lib/fileutils.rb', line 528 def copy_entry(src, dest, preserve = false, dereference_root = false, remove_destination = false) Entry_.new(src, nil, dereference_root).wrap_traverse(proc do |ent| destent = Entry_.new(dest, ent.rel, false) File.unlink destent.path if remove_destination && File.file?(destent.path) ent.copy destent.path end, proc do |ent| destent = Entry_.new(dest, ent.rel, false) ent. destent.path if preserve end) end |
#copy_file(src, dest, preserve = false, dereference = true) ⇒ Object
Copies file contents of src
to dest
. Both of src
and dest
must be a path name.
545 546 547 548 549 |
# File 'lib/fileutils.rb', line 545 def copy_file(src, dest, preserve = false, dereference = true) ent = Entry_.new(src, nil, dereference) ent.copy_file dest ent. dest if preserve end |
#copy_stream(src, dest) ⇒ Object
Copies stream src
to dest
. src
must respond to #read(n) and dest
must respond to #write(str).
558 559 560 |
# File 'lib/fileutils.rb', line 558 def copy_stream(src, dest) IO.copy_stream(src, dest) end |
#cp(src, dest, options = {}) ⇒ Object Also known as: copy
Options: preserve noop verbose
Copies a file content src
to dest
. If dest
is a directory, copies src
to dest/src
.
If src
is a list of files, then dest
must be a directory.
FileUtils.cp 'eval.c', 'eval.c.org'
FileUtils.cp %w(cgi.rb complex.rb date.rb), '/usr/lib/ruby/1.6'
FileUtils.cp %w(cgi.rb complex.rb date.rb), '/usr/lib/ruby/1.6', :verbose => true
FileUtils.cp 'symlink', 'dest' # copy content, "dest" is not a symlink
462 463 464 465 466 467 468 469 |
# File 'lib/fileutils.rb', line 462 def cp(src, dest, = {}) , OPT_TABLE['cp'] "cp#{[:preserve] ? ' -p' : ''} #{[src,dest].flatten.join ' '}" if [:verbose] return if [:noop] fu_each_src_dest(src, dest) do |s, d| copy_file s, d, [:preserve] end end |
#cp_r(src, dest, options = {}) ⇒ Object
Options: preserve noop verbose dereference_root remove_destination
Copies src
to dest
. If src
is a directory, this method copies all its contents recursively. If dest
is a directory, copies src
to dest/src
.
src
can be a list of files.
# Installing ruby library "mylib" under the site_ruby
FileUtils.rm_r site_ruby + '/mylib', :force
FileUtils.cp_r 'lib/', site_ruby + '/mylib'
# Examples of copying several files to target directory.
FileUtils.cp_r %w(mail.rb field.rb debug/), site_ruby + '/tmail'
FileUtils.cp_r Dir.glob('*.rb'), '/home/aamine/lib/ruby', :noop => true, :verbose => true
# If you want to copy all contents of a directory instead of the
# directory itself, c.f. src/x -> dest/x, src/y -> dest/y,
# use following code.
FileUtils.cp_r 'src/.', 'dest' # cp_r('src', 'dest') makes dest/src,
# but this doesn't.
499 500 501 502 503 504 505 506 507 508 |
# File 'lib/fileutils.rb', line 499 def cp_r(src, dest, = {}) , OPT_TABLE['cp_r'] "cp -r#{[:preserve] ? 'p' : ''}#{[:remove_destination] ? ' --remove-destination' : ''} #{[src,dest].flatten.join ' '}" if [:verbose] return if [:noop] = .dup [:dereference_root] = true unless .key?(:dereference_root) fu_each_src_dest(src, dest) do |s, d| copy_entry s, d, [:preserve], [:dereference_root], [:remove_destination] end end |
#install(src, dest, options = {}) ⇒ Object
Options: mode preserve noop verbose
If src
is not same as dest
, copies it and changes the permission mode to mode
. If dest
is a directory, destination is dest
/src
. This method removes destination before copy.
FileUtils.install 'ruby', '/usr/local/bin/ruby', :mode => 0755, :verbose => true
FileUtils.install 'lib.rb', '/usr/local/lib/ruby/site_ruby', :verbose => true
921 922 923 924 925 926 927 928 929 930 931 932 933 |
# File 'lib/fileutils.rb', line 921 def install(src, dest, = {}) , OPT_TABLE['install'] "install -c#{[:preserve] && ' -p'}#{[:mode] ? (' -m 0%o' % [:mode]) : ''} #{[src,dest].flatten.join ' '}" if [:verbose] return if [:noop] fu_each_src_dest(src, dest) do |s, d, st| unless File.exist?(d) and compare_file(s, d) remove_file d, true copy_file s, d File.utime st.atime, st.mtime, d if [:preserve] File.chmod [:mode], d if [:mode] end end end |
#ln(src, dest, options = {}) ⇒ Object Also known as: link
Options: force noop verbose
ln(old, new, options = {})
Creates a hard link new
which points to old
. If new
already exists and it is a directory, creates a link new/old
. If new
already exists and it is not a directory, raises Errno::EEXIST. But if :force option is set, overwrite new
.
FileUtils.ln 'gcc', 'cc', :verbose => true
FileUtils.ln '/usr/bin/emacs21', '/usr/bin/emacs'
ln(list, destdir, options = {})
Creates several hard links in a directory, with each one pointing to the item in list
. If destdir
is not a directory, raises Errno::ENOTDIR.
include FileUtils
cd '/sbin'
FileUtils.ln %w(cp mv mkdir), '/bin' # Now /sbin/cp and /bin/cp are linked.
382 383 384 385 386 387 388 389 390 |
# File 'lib/fileutils.rb', line 382 def ln(src, dest, = {}) , OPT_TABLE['ln'] "ln#{[:force] ? ' -f' : ''} #{[src,dest].flatten.join ' '}" if [:verbose] return if [:noop] fu_each_src_dest0(src, dest) do |s,d| remove_file d, true if [:force] File.link s, d end end |
#ln_s(src, dest, options = {}) ⇒ Object Also known as: symlink
Options: force noop verbose
ln_s(old, new, options = {})
Creates a symbolic link new
which points to old
. If new
already exists and it is a directory, creates a symbolic link new/old
. If new
already exists and it is not a directory, raises Errno::EEXIST. But if :force option is set, overwrite new
.
FileUtils.ln_s '/usr/bin/ruby', '/usr/local/bin/ruby'
FileUtils.ln_s 'verylongsourcefilename.c', 'c', :force => true
ln_s(list, destdir, options = {})
Creates several symbolic links in a directory, with each one pointing to the item in list
. If destdir
is not a directory, raises Errno::ENOTDIR.
If destdir
is not a directory, raises Errno::ENOTDIR.
FileUtils.ln_s Dir.glob('bin/*.rb'), '/home/aamine/bin'
419 420 421 422 423 424 425 426 427 |
# File 'lib/fileutils.rb', line 419 def ln_s(src, dest, = {}) , OPT_TABLE['ln_s'] "ln -s#{[:force] ? 'f' : ''} #{[src,dest].flatten.join ' '}" if [:verbose] return if [:noop] fu_each_src_dest0(src, dest) do |s,d| remove_file d, true if [:force] File.symlink s, d end end |
#ln_sf(src, dest, options = {}) ⇒ Object
Options: noop verbose
Same as
#ln_s(src, dest, :force => true)
440 441 442 443 444 445 |
# File 'lib/fileutils.rb', line 440 def ln_sf(src, dest, = {}) , OPT_TABLE['ln_sf'] = .dup [:force] = true ln_s src, dest, end |
#mkdir(list, options = {}) ⇒ Object
247 248 249 250 251 252 253 254 255 256 |
# File 'lib/fileutils.rb', line 247 def mkdir(list, = {}) , OPT_TABLE['mkdir'] list = fu_list(list) "mkdir #{[:mode] ? ('-m %03o ' % [:mode]) : ''}#{list.join ' '}" if [:verbose] return if [:noop] list.each do |dir| fu_mkdir dir, [:mode] end end |
#mkdir_p(list, options = {}) ⇒ Object Also known as: mkpath, makedirs
Options: mode noop verbose
Creates a directory and all its parent directories. For example,
FileUtils.mkdir_p '/usr/local/lib/ruby'
causes to make following directories, if it does not exist.
* /usr
* /usr/local
* /usr/local/lib
* /usr/local/lib/ruby
You can pass several directories at a time in a list.
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 |
# File 'lib/fileutils.rb', line 276 def mkdir_p(list, = {}) , OPT_TABLE['mkdir_p'] list = fu_list(list) "mkdir -p #{[:mode] ? ('-m %03o ' % [:mode]) : ''}#{list.join ' '}" if [:verbose] return *list if [:noop] list.map {|path| path.chomp(?/) }.each do |path| # optimize for the most common case begin fu_mkdir path, [:mode] next rescue SystemCallError next if File.directory?(path) end stack = [] until path == stack.last # dirname("/")=="/", dirname("C:/")=="C:/" stack.push path path = File.dirname(path) end stack.reverse_each do |dir| begin fu_mkdir dir, [:mode] rescue SystemCallError raise unless File.directory?(dir) end end end return *list end |
#mv(src, dest, options = {}) ⇒ Object Also known as: move
Options: force noop verbose
Moves file(s) src
to dest
. If file
and dest
exist on the different disk partition, the file is copied then the original file is removed.
FileUtils.mv 'badname.rb', 'goodname.rb'
FileUtils.mv 'stuff.rb', '/notexist/lib/ruby', :force => true # no error
FileUtils.mv %w(junk.txt dust.txt), '/home/aamine/.trash/'
FileUtils.mv Dir.glob('test*.rb'), 'test', :noop => true, :verbose => true
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 |
# File 'lib/fileutils.rb', line 576 def mv(src, dest, = {}) , OPT_TABLE['mv'] "mv#{[:force] ? ' -f' : ''} #{[src,dest].flatten.join ' '}" if [:verbose] return if [:noop] fu_each_src_dest(src, dest) do |s, d| destent = Entry_.new(d, nil, true) begin if destent.exist? if destent.directory? raise Errno::EEXIST, dest else destent.remove_file if rename_cannot_overwrite_file? end end begin File.rename s, d rescue Errno::EXDEV copy_entry s, d, true if [:secure] remove_entry_secure s, [:force] else remove_entry s, [:force] end end rescue SystemCallError raise unless [:force] end end end |
#pwd ⇒ Object Also known as: getwd
Options: (none)
Returns the name of the current directory.
180 181 182 |
# File 'lib/fileutils.rb', line 180 def pwd Dir.pwd end |
#remove_dir(path, force = false) ⇒ Object
Removes a directory dir
and its contents recursively. This method ignores StandardError if force
is true.
866 867 868 |
# File 'lib/fileutils.rb', line 866 def remove_dir(path, force = false) remove_entry path, force # FIXME?? check if it is a directory end |
#remove_entry(path, force = false) ⇒ Object
This method removes a file system entry path
. path
might be a regular file, a directory, or something. If path
is a directory, remove it recursively.
See also #remove_entry_secure.
836 837 838 839 840 841 842 843 844 845 846 |
# File 'lib/fileutils.rb', line 836 def remove_entry(path, force = false) Entry_.new(path).postorder_traverse do |ent| begin ent.remove rescue raise unless force end end rescue raise unless force end |
#remove_entry_secure(path, force = false) ⇒ Object
This method removes a file system entry path
. path
shall be a regular file, a directory, or something. If path
is a directory, remove it recursively. This method is required to avoid TOCTTOU (time-of-check-to-time-of-use) local security vulnerability of #rm_r. #rm_r causes security hole when:
* Parent directory is world writable (including /tmp).
* Removing directory tree includes world writable directory.
* The system has symbolic link.
To avoid this security hole, this method applies special preprocess. If path
is a directory, this method chown(2) and chmod(2) all removing directories. This requires the current process is the owner of the removing whole directory tree, or is the super user (root).
WARNING: You must ensure that ALL parent directories cannot be moved by other untrusted users. For example, parent directories should not be owned by untrusted users, and should not be world writable except when the sticky bit set.
WARNING: Only the owner of the removing directory tree, or Unix super user (root) should invoke this method. Otherwise this method does not work.
For details of this security vulnerability, see Perl’s case:
http://www.cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2005-0448
http://www.cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2004-0452
For fileutils.rb, this vulnerability is reported in [ruby-dev:26100].
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 |
# File 'lib/fileutils.rb', line 756 def remove_entry_secure(path, force = false) unless fu_have_symlink? remove_entry path, force return end fullpath = File.(path) st = File.lstat(fullpath) unless st.directory? File.unlink fullpath return end # is a directory. parent_st = File.stat(File.dirname(fullpath)) unless parent_st.world_writable? remove_entry path, force return end unless parent_st.sticky? raise ArgumentError, "parent directory is world writable, FileUtils#remove_entry_secure does not work; abort: #{path.inspect} (parent directory mode #{'%o' % parent_st.mode})" end # freeze tree root euid = Process.euid File.open(fullpath + '/.') {|f| unless fu_stat_identical_entry?(st, f.stat) # symlink (TOC-to-TOU attack?) File.unlink fullpath return end f.chown euid, -1 f.chmod 0700 unless fu_stat_identical_entry?(st, File.lstat(fullpath)) # TOC-to-TOU attack? File.unlink fullpath return end } # ---- tree root is frozen ---- root = Entry_.new(path) root.preorder_traverse do |ent| if ent.directory? ent.chown euid, -1 ent.chmod 0700 end end root.postorder_traverse do |ent| begin ent.remove rescue raise unless force end end rescue raise unless force end |
#remove_file(path, force = false) ⇒ Object
Removes a file path
. This method ignores StandardError if force
is true.
854 855 856 857 858 |
# File 'lib/fileutils.rb', line 854 def remove_file(path, force = false) Entry_.new(path).remove_file rescue raise unless force end |
#rm(list, options = {}) ⇒ Object Also known as: remove
629 630 631 632 633 634 635 636 637 638 |
# File 'lib/fileutils.rb', line 629 def rm(list, = {}) , OPT_TABLE['rm'] list = fu_list(list) "rm#{[:force] ? ' -f' : ''} #{list.join ' '}" if [:verbose] return if [:noop] list.each do |path| remove_file path, [:force] end end |
#rm_f(list, options = {}) ⇒ Object Also known as: safe_unlink
Options: noop verbose
Equivalent to
#rm(list, :force => true)
652 653 654 655 656 657 |
# File 'lib/fileutils.rb', line 652 def rm_f(list, = {}) , OPT_TABLE['rm_f'] = .dup [:force] = true rm list, end |
#rm_r(list, options = {}) ⇒ Object
Options: force noop verbose secure
remove files list
[0] list
[1]… If list
[n] is a directory, removes its all contents recursively. This method ignores StandardError when :force option is set.
FileUtils.rm_r Dir.glob('/tmp/*')
FileUtils.rm_r '/', :force => true # :-)
WARNING: This method causes local vulnerability if one of parent directories or removing directory tree are world writable (including /tmp, whose permission is 1777), and the current process has strong privilege such as Unix super user (root), and the system has symbolic link. For secure removing, read the documentation of #remove_entry_secure carefully, and set :secure option to true. Default is :secure=>false.
NOTE: This method calls #remove_entry_secure if :secure option is set. See also #remove_entry_secure.
685 686 687 688 689 690 691 692 693 694 695 696 697 698 |
# File 'lib/fileutils.rb', line 685 def rm_r(list, = {}) , OPT_TABLE['rm_r'] # options[:secure] = true unless options.key?(:secure) list = fu_list(list) "rm -r#{[:force] ? 'f' : ''} #{list.join ' '}" if [:verbose] return if [:noop] list.each do |path| if [:secure] remove_entry_secure path, [:force] else remove_entry path, [:force] end end end |
#rm_rf(list, options = {}) ⇒ Object Also known as: rmtree
Options: noop verbose secure
Equivalent to
#rm_r(list, :force => true)
WARNING: This method causes local vulnerability. Read the documentation of #rm_r first.
712 713 714 715 716 717 |
# File 'lib/fileutils.rb', line 712 def rm_rf(list, = {}) , OPT_TABLE['rm_rf'] = .dup [:force] = true rm_r list, end |
#rmdir(list, options = {}) ⇒ Object
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'lib/fileutils.rb', line 339 def rmdir(list, = {}) , OPT_TABLE['rmdir'] list = fu_list(list) parents = [:parents] "rmdir #{parents ? '-p ' : ''}#{list.join ' '}" if [:verbose] return if [:noop] list.each do |dir| begin Dir.rmdir(dir = dir.chomp(?/)) if parents until (parent = File.dirname(dir)) == '.' or parent == dir Dir.rmdir(dir) end end rescue Errno::ENOTEMPTY, Errno::ENOENT end end end |
#touch(list, options = {}) ⇒ Object
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 |
# File 'lib/fileutils.rb', line 1197 def touch(list, = {}) , OPT_TABLE['touch'] list = fu_list(list) created = nocreate = [:nocreate] t = [:mtime] if [:verbose] "touch #{nocreate ? '-c ' : ''}#{t ? t.strftime('-t %Y%m%d%H%M.%S ') : ''}#{list.join ' '}" end return if [:noop] list.each do |path| created = nocreate begin File.utime(t, t, path) rescue Errno::ENOENT raise if created File.open(path, 'a') { ; } created = true retry if t end end end |
#uptodate?(new, old_list) ⇒ Boolean
Options: (none)
Returns true if newer
is newer than all old_list
. Non-existent files are older than any file.
FileUtils.uptodate?('hello.o', %w(hello.c hello.h)) or \
system 'make hello.o'
224 225 226 227 228 229 230 231 232 233 |
# File 'lib/fileutils.rb', line 224 def uptodate?(new, old_list) return false unless File.exist?(new) new_time = File.mtime(new) old_list.each do |old| if File.exist?(old) return false unless new_time > File.mtime(old) end end true end |