Module: FileUtils
Relationships & Source Files | |
Namespace Children | |
Modules:
| |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
StreamUtils_
|
|
Instance Chain:
self,
StreamUtils_
|
|
Defined in: | lib/fileutils.rb |
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
require 'fileutils'
FileUtils.cd(dir, options)
FileUtils.cd(dir, options) {|dir| .... }
FileUtils.pwd()
FileUtils.mkdir(dir, options)
FileUtils.mkdir(list, options)
FileUtils.mkdir_p(dir, options)
FileUtils.mkdir_p(list, options)
FileUtils.rmdir(dir, options)
FileUtils.rmdir(list, options)
FileUtils.ln(old, new, options)
FileUtils.ln(list, destdir, options)
FileUtils.ln_s(old, new, options)
FileUtils.ln_s(list, destdir, options)
FileUtils.ln_sf(src, dest, options)
FileUtils.cp(src, dest, options)
FileUtils.cp(list, dir, options)
FileUtils.cp_r(src, dest, options)
FileUtils.cp_r(list, dir, options)
FileUtils.mv(src, dest, options)
FileUtils.mv(list, dir, options)
FileUtils.rm(list, options)
FileUtils.rm_r(list, options)
FileUtils.rm_rf(list, options)
FileUtils.install(src, dest, mode = <src's>, options)
FileUtils.chmod(mode, list, options)
FileUtils.chmod_R(mode, list, options)
FileUtils.chown(user, group, list, options)
FileUtils.chown_R(user, group, list, options)
FileUtils.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:
FileUtils.copy_entry(src, dest, preserve = false, dereference = false)
FileUtils.copy_file(src, dest, preserve = false, dereference = true)
FileUtils.copy_stream(srcstream, deststream)
FileUtils.remove_entry(path, force = false)
FileUtils.remove_entry_secure(path, force = false)
FileUtils.remove_file(path, force = false)
FileUtils.compare_file(path_a, path_b)
FileUtils.compare_stream(stream_a, stream_b)
FileUtils.uptodate?(file, cmp_list)
module 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 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 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
-
LOW_METHODS =
# File 'lib/fileutils.rb', line 1676singleton_methods(false) - collect_method(:noop).map(&:intern)
-
METHODS =
# File 'lib/fileutils.rb', line 1682singleton_methods() - [:private_module_function, :commands, :, :have_option?, :, :collect_method]
Class Attribute Summary
StreamUtils_ - Extended
Class Method Summary
-
.collect_method(opt)
Returns an Array of method names which have the option
opt
. -
.commands
Returns an Array of method names which have any options.
-
.have_option?(mid, opt) ⇒ Boolean
Returns true if the method
mid
have an optionopt
. -
.options
Returns an Array of option names.
-
.options_of(mid)
Returns an Array of option names of the method
mid
. -
.cd(dir, options = {}, &block)
(also: #chdir)
mod_func
Options: verbose.
-
.chdir(dir, options = {}, &block)
mod_func
Alias for #cd.
-
.chmod(mode, list, options = {})
mod_func
Options: noop verbose.
-
.chmod_R(mode, list, options = {})
mod_func
Options: noop verbose force.
-
.chown(user, group, list, options = {})
mod_func
Options: noop verbose.
-
.chown_R(user, group, list, options = {})
mod_func
Options: noop verbose force.
-
.cmp(a, b)
mod_func
Alias for #compare_file.
-
.compare_file(a, b)
(also: #identical?, #cmp)
mod_func
Returns true if the contents of a file A and a file B are identical.
-
.compare_stream(a, b)
mod_func
Returns true if the contents of a stream
a
andb
are identical. -
.copy(src, dest, options = {})
mod_func
Alias for #cp.
-
.copy_entry(src, dest, preserve = false, dereference_root = false, remove_destination = false)
mod_func
Copies a file system entry
src
todest
. -
.copy_file(src, dest, preserve = false, dereference = true)
mod_func
Copies file contents of
src
todest
. -
.copy_stream(src, dest)
mod_func
Copies stream
src
todest
. -
.cp(src, dest, options = {})
(also: #copy)
mod_func
Options: preserve noop verbose.
-
.cp_r(src, dest, options = {})
mod_func
Options: preserve noop verbose dereference_root remove_destination.
-
.getwd
mod_func
Alias for #pwd.
-
.identical?(a, b)
mod_func
Alias for #compare_file.
-
.install(src, dest, options = {})
mod_func
Options: mode preserve noop verbose.
-
.link(src, dest, options = {})
mod_func
Alias for #ln.
-
.ln(src, dest, options = {})
(also: #link)
mod_func
Options: force noop verbose.
-
.ln_s(src, dest, options = {})
(also: #symlink)
mod_func
Options: force noop verbose.
-
.ln_sf(src, dest, options = {})
mod_func
Options: noop verbose.
-
.makedirs(list, options = {})
mod_func
Alias for #mkdir_p.
-
.mkdir(list, options = {})
mod_func
Options: mode noop verbose.
-
.mkdir_p(list, options = {})
(also: #mkpath, #makedirs)
mod_func
Options: mode noop verbose.
-
.mkpath(list, options = {})
mod_func
Alias for #mkdir_p.
-
.move(src, dest, options = {})
mod_func
Alias for #mv.
-
.mv(src, dest, options = {})
(also: #move)
mod_func
Options: force noop verbose.
-
.pwd
(also: #getwd)
mod_func
Options: (none).
-
.remove(list, options = {})
mod_func
Alias for #rm.
-
.remove_dir(path, force = false)
mod_func
Removes a directory
dir
and its contents recursively. -
.remove_entry(path, force = false)
mod_func
This method removes a file system entry
path
. -
.remove_entry_secure(path, force = false)
mod_func
This method removes a file system entry
path
. -
.remove_file(path, force = false)
mod_func
Removes a file
path
. -
.rm(list, options = {})
(also: #remove)
mod_func
Options: force noop verbose.
-
.rm_f(list, options = {})
(also: #safe_unlink)
mod_func
Options: noop verbose.
-
.rm_r(list, options = {})
mod_func
Options: force noop verbose secure.
-
.rm_rf(list, options = {})
(also: #rmtree)
mod_func
Options: noop verbose secure.
-
.rmdir(list, options = {})
mod_func
Options: parents, noop, verbose.
-
.rmtree(list, options = {})
mod_func
Alias for #rm_rf.
-
.safe_unlink(list, options = {})
mod_func
Alias for #rm_f.
-
.symlink(src, dest, options = {})
mod_func
Alias for #ln_s.
-
.touch(list, options = {})
mod_func
Options: noop verbose mtime nocreate.
-
.uptodate?(new, old_list) ⇒ Boolean
mod_func
Options: (none).
StreamUtils_ - Extended
Instance Attribute Summary
StreamUtils_ - Included
Instance Method Summary
StreamUtils_ - Included
Class Method Details
.cd(dir, options = {}, &block) (mod_func) 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
.chdir(dir, options = {}, &block) (mod_func)
Alias for #cd.
# File 'lib/fileutils.rb', line 133
alias chdir cd
.chmod(mode, list, options = {}) (mod_func)
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.
.chmod_R(mode, list, options = {}) (mod_func)
Options: noop verbose force
Changes permission bits on the named files (in list
) to the bit pattern represented by mode
.
FileUtils.chmod_R 0700, "/tmp/app.#{$$}"
FileUtils.chmod_R "u=wrx", "/tmp/app.#{$$}"
# File 'lib/fileutils.rb', line 1017
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 = {}) (mod_func)
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
# File 'lib/fileutils.rb', line 1050
def chown(user, group, list, = {}) , OPT_TABLE['chown'] list = fu_list(list) sprintf('chown %s %s', (group ? "#{user}:#{group}" : user || ':'), 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 = {}) (mod_func)
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
# File 'lib/fileutils.rb', line 1079
def chown_R(user, group, list, = {}) , OPT_TABLE['chown_R'] list = fu_list(list) sprintf('chown -R%s %s %s', ( [:force] ? 'f' : ''), (group ? "#{user}:#{group}" : user || ':'), list.join(' ')) if [:verbose] return if [:noop] uid = fu_get_uid(user) gid = fu_get_gid(group) list.each do |root| Entry_.new(root).traverse do |ent| begin ent.chown uid, gid rescue raise unless [:force] end end end end
.cmp(a, b) (mod_func)
Alias for #compare_file.
# File 'lib/fileutils.rb', line 827
alias cmp compare_file
.collect_method(opt)
Returns an Array of method names which have the option opt
.
p FileUtils.collect_method(:preserve) #=> ["cp", "cp_r", "copy", "install"]
.commands
Returns an Array of method names which have any options.
p FileUtils.commands #=> ["chmod", "cp", "cp_r", "install", ...]
# File 'lib/fileutils.rb', line 1633
def FileUtils.commands OPT_TABLE.keys end
.compare_file(a, b) (mod_func) Also known as: #identical?, #cmp
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
# 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
.compare_stream(a, b) (mod_func)
Returns true if the contents of a stream a
and b
are identical.
# File 'lib/fileutils.rb', line 834
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(src, dest, options = {}) (mod_func)
Alias for #cp.
# File 'lib/fileutils.rb', line 409
alias copy cp
.copy_entry(src, dest, preserve = false, dereference_root = false, remove_destination = false) (mod_func)
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, and modified time. Permissions are copied regardless preserve
.
If dereference_root
is true, this method dereference tree root.
If remove_destination
is true, this method removes each destination file before copy.
# File 'lib/fileutils.rb', line 469
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) (mod_func)
Copies file contents of src
to dest
. Both of src
and dest
must be a path name.
.copy_stream(src, dest) (mod_func)
Copies stream src
to dest
. src
must respond to #read(n) and dest
must respond to #write(str).
# File 'lib/fileutils.rb', line 497
def copy_stream(src, dest) IO.copy_stream(src, dest) end
.cp(src, dest, options = {}) (mod_func) 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
# File 'lib/fileutils.rb', line 399
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 = {}) (mod_func)
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.
# File 'lib/fileutils.rb', line 438
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 (mod_func)
Alias for #pwd.
# File 'lib/fileutils.rb', line 108
alias getwd pwd
.have_option?(mid, opt) ⇒ Boolean
# File 'lib/fileutils.rb', line 1653
def FileUtils.have_option?(mid, opt) li = OPT_TABLE[mid.to_s] or raise ArgumentError, "no such method: #{mid}" li.include?(opt) end
.identical?(a, b) (mod_func)
Alias for #compare_file.
# File 'lib/fileutils.rb', line 826
alias identical? compare_file
.install(src, dest, options = {}) (mod_func)
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
# File 'lib/fileutils.rb', line 857
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 = File.stat(s) 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(src, dest, options = {}) (mod_func)
Alias for #ln.
# File 'lib/fileutils.rb', line 325
alias link ln
.ln(src, dest, options = {}) (mod_func) 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.
# File 'lib/fileutils.rb', line 314
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 = {}) (mod_func) 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'
# File 'lib/fileutils.rb', line 353
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 = {}) (mod_func)
Options: noop verbose
Same as
#ln_s(src, dest, :force => true)
.makedirs(list, options = {}) (mod_func)
Alias for #mkdir_p.
# File 'lib/fileutils.rb', line 240
alias makedirs mkdir_p
.mkdir(list, options = {}) (mod_func)
Options: mode noop verbose
Creates one or more directories.
FileUtils.mkdir 'test'
FileUtils.mkdir %w( tmp data )
FileUtils.mkdir 'notexist', :noop => true # Does not really create.
FileUtils.mkdir 'tmp', :mode => 0700
.mkdir_p(list, options = {}) (mod_func) 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.
# File 'lib/fileutils.rb', line 205
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| remove_trailing_slash(path)}.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.pop # root directory should exist stack.reverse_each do |dir| begin fu_mkdir dir, [:mode] rescue SystemCallError raise unless File.directory?(dir) end end end return *list end
.mkpath(list, options = {}) (mod_func)
Alias for #mkdir_p.
# File 'lib/fileutils.rb', line 239
alias mkpath mkdir_p
.move(src, dest, options = {}) (mod_func)
Alias for #mv.
# File 'lib/fileutils.rb', line 545
alias move mv
.mv(src, dest, options = {}) (mod_func) 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
# File 'lib/fileutils.rb', line 514
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, d 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
.options
Returns an Array of option names.
p FileUtils. #=> ["noop", "force", "verbose", "preserve", "mode"]
# File 'lib/fileutils.rb', line 1642
def FileUtils. OPT_TABLE.values.flatten.uniq.map {|sym| sym.to_s } end
.options_of(mid)
Returns an Array of option names of the method mid
.
p FileUtils. (:rm) #=> ["noop", "verbose", "force"]
# File 'lib/fileutils.rb', line 1663
def FileUtils. (mid) OPT_TABLE[mid.to_s].map {|sym| sym.to_s } end
.pwd (mod_func) Also known as: #getwd
Options: (none)
Returns the name of the current directory.
# File 'lib/fileutils.rb', line 103
def pwd Dir.pwd end
.remove(list, options = {}) (mod_func)
Alias for #rm.
# File 'lib/fileutils.rb', line 578
alias remove rm
.remove_dir(path, force = false) (mod_func)
Removes a directory dir
and its contents recursively. This method ignores StandardError if force
is true.
# File 'lib/fileutils.rb', line 805
def remove_dir(path, force = false) remove_entry path, force # FIXME?? check if it is a directory end
.remove_entry(path, force = false) (mod_func)
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.
# File 'lib/fileutils.rb', line 777
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) (mod_func)
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:
www.cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2005-0448 www.cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2004-0452
For fileutils.rb, this vulnerability is reported in [ruby-dev:26100].
# File 'lib/fileutils.rb', line 700
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) (mod_func)
Removes a file path
. This method ignores StandardError if force
is true.
# File 'lib/fileutils.rb', line 794
def remove_file(path, force = false) Entry_.new(path).remove_file rescue raise unless force end
.rm(list, options = {}) (mod_func) Also known as: #remove
Options: force noop verbose
Remove file(s) specified in list
. This method cannot remove directories. All StandardErrors are ignored when the :force
option is set.
FileUtils.rm %w( junk.txt dust.txt )
FileUtils.rm Dir.glob('*.so')
FileUtils.rm 'NotExistFile', :force => true # never raises exception
# File 'lib/fileutils.rb', line 566
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 = {}) (mod_func) Also known as: #safe_unlink
Options: noop verbose
Equivalent to
#rm(list, :force => true)
.rm_r(list, options = {}) (mod_func)
Options: force noop verbose secure
remove files list
list
… If list
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.
# File 'lib/fileutils.rb', line 626
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 = {}) (mod_func) 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.
.rmdir(list, options = {}) (mod_func)
Options: parents, noop, verbose
Removes one or more directories.
FileUtils.rmdir 'somedir'
FileUtils.rmdir %w(somedir anydir otherdir)
# Does not really remove directory; outputs message.
FileUtils.rmdir 'somedir', :verbose => true, :noop => true
# File 'lib/fileutils.rb', line 269
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 = remove_trailing_slash(dir)) if parents until (parent = File.dirname(dir)) == '.' or parent == dir dir = parent Dir.rmdir(dir) end end rescue Errno::ENOTEMPTY, Errno::EEXIST, Errno::ENOENT end end end
.rmtree(list, options = {}) (mod_func)
Alias for #rm_rf.
# File 'lib/fileutils.rb', line 662
alias rmtree rm_rf
.safe_unlink(list, options = {}) (mod_func)
Alias for #rm_f.
# File 'lib/fileutils.rb', line 599
alias safe_unlink rm_f
.symlink(src, dest, options = {}) (mod_func)
Alias for #ln_s.
# File 'lib/fileutils.rb', line 364
alias symlink ln_s
.touch(list, options = {}) (mod_func)
Options: noop verbose mtime nocreate
Updates modification time (mtime) and access time (atime) of file(s) in list
. Files are created if they don't exist.
FileUtils.touch 'timestamp'
FileUtils.touch Dir.glob('*.c'); system 'make'
# File 'lib/fileutils.rb', line 1143
def touch(list, = {}) , OPT_TABLE['touch'] list = fu_list(list) 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
(mod_func)
Options: (none)
Returns true if new
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'
# File 'lib/fileutils.rb', line 148
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
Instance Method Details
#apply_mask(mode, user_mask, op, mode_mask)
[ GitHub ]#remove_trailing_slash(dir)
[ GitHub ]# File 'lib/fileutils.rb', line 160
def remove_trailing_slash(dir) dir == '/' ? dir : dir.chomp(?/) end