Module: FileUtils
- Defined in:
- lib/fileutils.rb
Overview
fileutils.rb
Copyright (c) 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.
Constant Summary collapse
- OPT_TABLE =
This hash table holds command options.
{}
Class Method Summary collapse
-
.cd(dir, options = {}, &block) ⇒ Object
Options: verbose.
-
.chdir ⇒ Object
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.
-
.cmp ⇒ Object
Returns true if the contents of a file A and a file B are identical.
-
.compare_file(a, b) ⇒ Object
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 ⇒ Object
Options: preserve noop verbose.
-
.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
Options: preserve noop verbose.
-
.cp_r(src, dest, options = {}) ⇒ Object
Options: preserve noop verbose dereference_root remove_destination.
-
.getwd ⇒ Object
Options: (none).
-
.identical? ⇒ Object
Returns true if the contents of a file A and a file B are identical.
-
.install(src, dest, options = {}) ⇒ Object
Options: mode preserve noop verbose.
-
.link ⇒ Object
Options: force noop verbose.
-
.ln(src, dest, options = {}) ⇒ Object
Options: force noop verbose.
-
.ln_s(src, dest, options = {}) ⇒ Object
Options: force noop verbose.
-
.ln_sf(src, dest, options = {}) ⇒ Object
Options: noop verbose.
-
.makedirs ⇒ Object
Options: mode noop verbose.
-
.mkdir(list, options = {}) ⇒ Object
Options: mode noop verbose.
-
.mkdir_p(list, options = {}) ⇒ Object
Options: mode noop verbose.
-
.mkpath ⇒ Object
Options: mode noop verbose.
-
.move ⇒ Object
Options: force noop verbose.
-
.mv(src, dest, options = {}) ⇒ Object
Options: force noop verbose.
-
.private_module_function(name) ⇒ Object
:nodoc:.
-
.pwd ⇒ Object
Options: (none).
-
.remove ⇒ Object
Options: force noop verbose.
-
.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
Options: force noop verbose.
-
.rm_f(list, options = {}) ⇒ Object
Options: noop verbose.
-
.rm_r(list, options = {}) ⇒ Object
Options: force noop verbose secure.
-
.rm_rf(list, options = {}) ⇒ Object
Options: noop verbose secure.
-
.rmdir(list, options = {}) ⇒ Object
Options: noop, verbose.
-
.rmtree ⇒ Object
Options: noop verbose secure.
-
.safe_unlink ⇒ Object
Options: noop verbose.
-
.symlink ⇒ Object
Options: force noop verbose.
-
.touch(list, options = {}) ⇒ Object
Options: noop verbose.
-
.uptodate?(new, old_list, options = nil) ⇒ Boolean
Options: (none).
Instance Method Summary collapse
-
#fu_have_symlink? ⇒ Boolean
:nodoc:.
-
#fu_mkdir(path, mode) ⇒ Object
:nodoc:.
-
#fu_mode(mode, path) ⇒ Object
:nodoc:.
-
#fu_stat_identical_entry?(a, b) ⇒ Boolean
:nodoc:.
-
#mode_mask(mode, path) ⇒ Object
:nodoc:.
-
#rename_cannot_overwrite_file? ⇒ Boolean
:nodoc:.
-
#symbolic_modes_to_i(modes, path) ⇒ Object
:nodoc:.
-
#user_mask(target) ⇒ Object
:nodoc:.
Class Method Details
.cd(dir, options = {}, &block) ⇒ Object
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
122 123 124 125 126 127 |
# File 'lib/fileutils.rb', line 122 def cd(dir, = {}, &block) # :yield: dir , OPT_TABLE['cd'] "cd #{dir}" if [:verbose] Dir.chdir(dir, &block) 'cd -' if [:verbose] and block end |
.chdir ⇒ Object
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
130 131 132 133 134 135 |
# File 'lib/fileutils.rb', line 130 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.
"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.
964 965 966 967 968 969 970 971 972 |
# File 'lib/fileutils.rb', line 964 def chmod(mode, list, = {}) , OPT_TABLE['chmod'] list = fu_list(list) sprintf('chmod %o %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
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 |
# File 'lib/fileutils.rb', line 986 def chmod_R(mode, list, = {}) , OPT_TABLE['chmod_R'] list = fu_list(list) sprintf('chmod -R%s %o %s', ([:force] ? 'f' : ''), 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
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 |
# File 'lib/fileutils.rb', line 1019 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
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 |
# File 'lib/fileutils.rb', line 1048 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 |
.cmp ⇒ Object
Returns true if the contents of a file A and a file B are identical.
FileUtils.compare_file('somefile', 'somefile') #=> true
FileUtils.compare_file('/bin/cp', '/bin/mv') #=> maybe false
817 818 819 820 821 822 823 824 |
# File 'lib/fileutils.rb', line 817 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_file(a, b) ⇒ Object
806 807 808 809 810 811 812 813 |
# File 'lib/fileutils.rb', line 806 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.
824 825 826 827 828 829 830 831 832 833 834 835 836 837 |
# File 'lib/fileutils.rb', line 824 def compare_stream(a, b) bsize = fu_stream_blksize(a, b) sa = sb = nil while sa == sb sa = a.read(bsize) sb = b.read(bsize) unless sa and sb if sa.nil? and sb.nil? return true end end end false end |
.copy ⇒ Object
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
401 402 403 404 405 406 407 408 |
# File 'lib/fileutils.rb', line 401 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 |
.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.
461 462 463 464 465 466 467 468 |
# File 'lib/fileutils.rb', line 461 def copy_entry(src, dest, preserve = false, dereference_root = false, remove_destination = false) Entry_.new(src, nil, dereference_root).traverse do |ent| destent = Entry_.new(dest, ent.rel, false) File.unlink destent.path if remove_destination && File.file?(destent.path) ent.copy destent.path 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.
475 476 477 478 479 |
# File 'lib/fileutils.rb', line 475 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).
487 488 489 |
# File 'lib/fileutils.rb', line 487 def copy_stream(src, dest) IO.copy_stream(src, dest) end |
.cp(src, dest, options = {}) ⇒ Object
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
391 392 393 394 395 396 397 398 |
# File 'lib/fileutils.rb', line 391 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 src/dest,
# but this doesn't.
430 431 432 433 434 435 436 437 438 439 |
# File 'lib/fileutils.rb', line 430 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 |
.getwd ⇒ Object
Options: (none)
Returns the name of the current directory.
105 106 107 |
# File 'lib/fileutils.rb', line 105 def pwd Dir.pwd end |
.identical? ⇒ Object
Returns true if the contents of a file A and a file B are identical.
FileUtils.compare_file('somefile', 'somefile') #=> true
FileUtils.compare_file('/bin/cp', '/bin/mv') #=> maybe false
816 817 818 819 820 821 822 823 |
# File 'lib/fileutils.rb', line 816 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 |
.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
850 851 852 853 854 855 856 857 858 859 860 861 862 |
# File 'lib/fileutils.rb', line 850 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 |
.link ⇒ Object
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.
317 318 319 320 321 322 323 324 325 |
# File 'lib/fileutils.rb', line 317 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(src, dest, options = {}) ⇒ Object
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.
306 307 308 309 310 311 312 313 314 |
# File 'lib/fileutils.rb', line 306 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
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'
345 346 347 348 349 350 351 352 353 |
# File 'lib/fileutils.rb', line 345 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)
368 369 370 371 372 373 |
# File 'lib/fileutils.rb', line 368 def ln_sf(src, dest, = {}) , OPT_TABLE['ln_sf'] = .dup [:force] = true ln_s src, dest, end |
.makedirs ⇒ Object
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.
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 |
# File 'lib/fileutils.rb', line 233 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 |
.mkdir(list, options = {}) ⇒ Object
169 170 171 172 173 174 175 176 177 178 |
# File 'lib/fileutils.rb', line 169 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
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.
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 |
# File 'lib/fileutils.rb', line 199 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 |
.mkpath ⇒ Object
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.
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 |
# File 'lib/fileutils.rb', line 232 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 |
.move ⇒ Object
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
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 |
# File 'lib/fileutils.rb', line 535 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 |
.mv(src, dest, options = {}) ⇒ Object
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
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 |
# File 'lib/fileutils.rb', line 504 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 |
.private_module_function(name) ⇒ Object
:nodoc:
87 88 89 90 |
# File 'lib/fileutils.rb', line 87 def self.private_module_function(name) #:nodoc: module_function name private_class_method name end |
.pwd ⇒ Object
Options: (none)
Returns the name of the current directory.
100 101 102 |
# File 'lib/fileutils.rb', line 100 def pwd Dir.pwd end |
.remove ⇒ Object
568 569 570 571 572 573 574 575 576 577 |
# File 'lib/fileutils.rb', line 568 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 |
.remove_dir(path, force = false) ⇒ Object
Removes a directory dir
and its contents recursively. This method ignores StandardError if force
is true.
795 796 797 |
# File 'lib/fileutils.rb', line 795 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.
767 768 769 770 771 772 773 774 775 776 777 |
# File 'lib/fileutils.rb', line 767 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].
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 |
# File 'lib/fileutils.rb', line 690 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.
784 785 786 787 788 |
# File 'lib/fileutils.rb', line 784 def remove_file(path, force = false) Entry_.new(path).remove_file rescue raise unless force end |
.rm(list, options = {}) ⇒ Object
556 557 558 559 560 561 562 563 564 565 |
# File 'lib/fileutils.rb', line 556 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
Options: noop verbose
Equivalent to
#rm(list, :force => true)
581 582 583 584 585 586 |
# File 'lib/fileutils.rb', line 581 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.
616 617 618 619 620 621 622 623 624 625 626 627 628 629 |
# File 'lib/fileutils.rb', line 616 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
Options: noop verbose secure
Equivalent to
#rm_r(list, :force => true)
WARNING: This method causes local vulnerability. Read the documentation of #rm_r first.
644 645 646 647 648 649 |
# File 'lib/fileutils.rb', line 644 def rm_rf(list, = {}) , OPT_TABLE['rm_rf'] = .dup [:force] = true rm_r list, end |
.rmdir(list, options = {}) ⇒ Object
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 |
# File 'lib/fileutils.rb', line 262 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 |
.rmtree ⇒ Object
Options: noop verbose secure
Equivalent to
#rm_r(list, :force => true)
WARNING: This method causes local vulnerability. Read the documentation of #rm_r first.
652 653 654 655 656 657 |
# File 'lib/fileutils.rb', line 652 def rm_rf(list, = {}) , OPT_TABLE['rm_rf'] = .dup [:force] = true rm_r list, end |
.safe_unlink ⇒ Object
Options: noop verbose
Equivalent to
#rm(list, :force => true)
589 590 591 592 593 594 |
# File 'lib/fileutils.rb', line 589 def rm_f(list, = {}) , OPT_TABLE['rm_f'] = .dup [:force] = true rm list, end |
.symlink ⇒ Object
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'
356 357 358 359 360 361 362 363 364 |
# File 'lib/fileutils.rb', line 356 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 |
.touch(list, options = {}) ⇒ Object
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 |
# File 'lib/fileutils.rb', line 1125 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, options = nil) ⇒ 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'
145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/fileutils.rb', line 145 def uptodate?(new, old_list, = nil) raise ArgumentError, 'uptodate? does not accept any option' if 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 |
Instance Method Details
#fu_have_symlink? ⇒ Boolean
:nodoc:
746 747 748 749 750 751 752 |
# File 'lib/fileutils.rb', line 746 def fu_have_symlink? #:nodoc: File.symlink nil, nil rescue NotImplementedError return false rescue return true end |
#fu_mkdir(path, mode) ⇒ Object
:nodoc:
241 242 243 244 245 246 247 248 249 |
# File 'lib/fileutils.rb', line 241 def fu_mkdir(path, mode) #:nodoc: path = path.chomp(?/) if mode Dir.mkdir path, mode File.chmod mode, path else Dir.mkdir path end end |
#fu_mode(mode, path) ⇒ Object
:nodoc:
928 929 930 |
# File 'lib/fileutils.rb', line 928 def fu_mode(mode, path) #:nodoc: mode.is_a?(String) ? symbolic_modes_to_i(mode, path) : mode end |
#fu_stat_identical_entry?(a, b) ⇒ Boolean
:nodoc:
755 756 757 |
# File 'lib/fileutils.rb', line 755 def fu_stat_identical_entry?(a, b) #:nodoc: a.dev == b.dev and a.ino == b.ino end |
#mode_mask(mode, path) ⇒ Object
:nodoc:
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 |
# File 'lib/fileutils.rb', line 885 def mode_mask(mode, path) #:nodoc: mask = 0 mode.each_byte do |byte_chr| case byte_chr.chr when "r" mask |= 0444 when "w" mask |= 0222 when "x" mask |= 0111 when "X" mask |= 0111 if FileTest::directory? path when "s" mask |= 06000 when "t" mask |= 01000 end end mask end |
#rename_cannot_overwrite_file? ⇒ Boolean
:nodoc:
541 542 543 |
# File 'lib/fileutils.rb', line 541 def rename_cannot_overwrite_file? #:nodoc: /cygwin|mswin|mingw|bccwin|emx/ =~ RUBY_PLATFORM end |
#symbolic_modes_to_i(modes, path) ⇒ Object
:nodoc:
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 |
# File 'lib/fileutils.rb', line 907 def symbolic_modes_to_i(modes, path) #:nodoc: current_mode = (File.stat(path).mode & 07777) modes.split(/,/).inject(0) do |mode, mode_sym| mode_sym = "a#{mode_sym}" if mode_sym =~ %r!^[+-=]! target, mode = mode_sym.split %r![+-=]! user_mask = user_mask(target) mode_mask = mode_mask(mode ? mode : "", path) case mode_sym when /=/ current_mode &= ~(user_mask) current_mode |= user_mask & mode_mask when /\+/ current_mode |= user_mask & mode_mask when /-/ current_mode &= ~(user_mask & mode_mask) end end end |
#user_mask(target) ⇒ Object
:nodoc:
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 |
# File 'lib/fileutils.rb', line 867 def user_mask(target) #:nodoc: mask = 0 target.each_byte do |byte_chr| case byte_chr.chr when "u" mask |= 04700 when "g" mask |= 02070 when "o" mask |= 01007 when "a" mask |= 07777 end end mask end |