Module: Bundler::FileUtils
Relationships & Source Files | |
Namespace Children | |
Modules:
| |
Classes:
| |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
StreamUtils_
|
|
Instance Chain:
self,
StreamUtils_
|
|
Defined in: | lib/bundler/vendor/fileutils/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 'bundler/vendor/fileutils/lib/fileutils'
Bundler::FileUtils.cd(dir, ** )
Bundler::FileUtils.cd(dir, ** ) {|dir| block }
Bundler::FileUtils.pwd()
Bundler::FileUtils.mkdir(dir, ** )
Bundler::FileUtils.mkdir(list, ** )
Bundler::FileUtils.mkdir_p(dir, ** )
Bundler::FileUtils.mkdir_p(list, ** )
Bundler::FileUtils.rmdir(dir, ** )
Bundler::FileUtils.rmdir(list, ** )
Bundler::FileUtils.ln(target, link, ** )
Bundler::FileUtils.ln(targets, dir, ** )
Bundler::FileUtils.ln_s(target, link, ** )
Bundler::FileUtils.ln_s(targets, dir, ** )
Bundler::FileUtils.ln_sf(target, link, ** )
Bundler::FileUtils.cp(src, dest, ** )
Bundler::FileUtils.cp(list, dir, ** )
Bundler::FileUtils.cp_r(src, dest, ** )
Bundler::FileUtils.cp_r(list, dir, ** )
Bundler::FileUtils.mv(src, dest, ** )
Bundler::FileUtils.mv(list, dir, ** )
Bundler::FileUtils.rm(list, ** )
Bundler::FileUtils.rm_r(list, ** )
Bundler::FileUtils.rm_rf(list, ** )
Bundler::FileUtils.install(src, dest, ** )
Bundler::FileUtils.chmod(mode, list, ** )
Bundler::FileUtils.chmod_R(mode, list, ** )
Bundler::FileUtils.chown(user, group, list, ** )
Bundler::FileUtils.chown_R(user, group, list, ** )
Bundler::FileUtils.touch(list, ** )
Possible .options are:
:force
-
forced operation (rewrite files if exist, remove directories if not empty, etc.);
:verbose
-
print command to be run, in bash syntax, before performing it;
:preserve
-
preserve object’s group, user and modification time on copying;
:noop
-
no changes are made (usable in combination with
:verbose
which will print the command to run)
Each method documents the options that it honours. See also .commands, .options and .options_of methods to introspect which command have which options.
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 keyword arguments:
Bundler::FileUtils.copy_entry(src, dest, preserve = false, dereference_root = false, remove_destination = false)
Bundler::FileUtils.copy_file(src, dest, preserve = false, dereference = true)
Bundler::FileUtils.copy_stream(srcstream, deststream)
Bundler::FileUtils.remove_entry(path, force = false)
Bundler::FileUtils.remove_entry_secure(path, force = false)
Bundler::FileUtils.remove_file(path, force = false)
Bundler::FileUtils.compare_file(path_a, path_b)
Bundler::FileUtils.compare_stream(stream_a, stream_b)
Bundler::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 =
Internal use only
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1685singleton_methods(false) - collect_method(:noop).map(&:intern)
-
METHODS =
Internal use only
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1692singleton_methods() - [:private_module_function, # :nodoc: :commands, :, :have_option?, :, :collect_method]
-
OPT_TABLE =
Internal use only
This hash table holds command options.
{}
-
VERSION =
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 105"1.4.1"
Class Method Summary
-
.collect_method(opt)
Returns an Array of methods names which have the option
opt
. -
.commands
Returns an Array of names of high-level methods that accept any keyword arguments.
-
.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, verbose: nil, &block)
(also: #chdir)
mod_func
Changes the current directory to the directory
dir
. -
.chdir(dir, verbose: nil, &block)
mod_func
Alias for #cd.
-
.chmod(mode, list, noop: nil, verbose: nil)
mod_func
Changes permission bits on the named files (in
list
) to the bit pattern represented bymode
. -
.chmod_R(mode, list, noop: nil, verbose: nil, force: nil)
mod_func
Changes permission bits on the named files (in
list
) to the bit pattern represented bymode
. -
.chown(user, group, list, noop: nil, verbose: nil)
mod_func
Changes owner and group on the named files (in
list
) to the useruser
and the groupgroup
. -
.chown_R(user, group, list, noop: nil, verbose: nil, force: nil)
mod_func
Changes owner and group on the named files (in
list
) to the useruser
and the groupgroup
recursively. -
.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 fileb
are identical. -
.compare_stream(a, b)
mod_func
Returns true if the contents of a stream
a
andb
are identical. -
.copy(src, dest, preserve: nil, noop: nil, verbose: nil)
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, preserve: nil, noop: nil, verbose: nil)
(also: #copy)
mod_func
Copies a file content
src
todest
. -
.cp_lr(src, dest, noop: nil, verbose: nil, dereference_root: true, remove_destination: false)
mod_func
Hard link
src
todest
. -
.cp_r(src, dest, preserve: nil, noop: nil, verbose: nil, dereference_root: true, remove_destination: nil)
mod_func
Copies
src
todest
. -
.getwd
mod_func
Alias for #pwd.
-
.identical?(a, b)
mod_func
Alias for #compare_file.
-
.install(src, dest, mode: nil, owner: nil, group: nil, preserve: nil, noop: nil, verbose: nil)
mod_func
If
src
is not same asdest
, copies it and changes the permission mode tomode
. -
.link(src, dest, force: nil, noop: nil, verbose: nil)
mod_func
Alias for #ln.
-
.link_entry(src, dest, dereference_root = false, remove_destination = false)
mod_func
Hard links a file system entry
src
todest
. -
.ln(target, link, force: nil, noop: nil, verbose: nil)
(also: #link)
mod_func
In the first form, creates a hard link .link which points to
target
. -
.ln_s(target, link, force: nil, noop: nil, verbose: nil)
(also: #symlink)
mod_func
In the first form, creates a symbolic link .link which points to
target
. -
.ln_sf(*args)
mod_func
Same as.
-
.makedirs(list, mode: nil, noop: nil, verbose: nil)
mod_func
Alias for #mkdir_p.
-
.mkdir(list, mode: nil, noop: nil, verbose: nil)
mod_func
Creates one or more directories.
-
.mkdir_p(list, mode: nil, noop: nil, verbose: nil)
(also: #mkpath, #makedirs)
mod_func
Creates a directory and all its parent directories.
-
.mkpath(list, mode: nil, noop: nil, verbose: nil)
mod_func
Alias for #mkdir_p.
-
.move(src, dest, force: nil, noop: nil, verbose: nil, secure: nil)
mod_func
Alias for #mv.
-
.mv(src, dest, force: nil, noop: nil, verbose: nil, secure: nil)
(also: #move)
mod_func
Moves file(s)
src
todest
. -
.pwd
(also: #getwd)
mod_func
Returns the name of the current directory.
-
.remove(list, force: nil, noop: nil, verbose: nil)
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, force: nil, noop: nil, verbose: nil)
(also: #remove)
mod_func
Remove file(s) specified in
list
. -
.rm_f(list, noop: nil, verbose: nil)
(also: #safe_unlink)
mod_func
Equivalent to.
-
.rm_r(list, force: nil, noop: nil, verbose: nil, secure: nil)
mod_func
remove files
list
list
… -
.rm_rf(list, noop: nil, verbose: nil, secure: nil)
(also: #rmtree)
mod_func
Equivalent to.
-
.rmdir(list, parents: nil, noop: nil, verbose: nil)
mod_func
Removes one or more directories.
-
.rmtree(list, noop: nil, verbose: nil, secure: nil)
mod_func
Alias for #rm_rf.
-
.safe_unlink(list, noop: nil, verbose: nil)
mod_func
Alias for #rm_f.
-
.symlink(src, dest, force: nil, noop: nil, verbose: nil)
mod_func
Alias for #ln_s.
-
.touch(list, noop: nil, verbose: nil, mtime: nil, nocreate: nil)
mod_func
Updates modification time (mtime) and access time (atime) of file(s) in
list
. -
.uptodate?(new, old_list) ⇒ Boolean
mod_func
Returns true if
new
is newer than allold_list
. - .private_module_function(name) Internal use only
StreamUtils_
- Extended
Instance Attribute Summary
- #fu_have_symlink? ⇒ Boolean readonly Internal use only
Instance Method Summary
- #apply_mask(mode, user_mask, op, mode_mask) Internal use only
- #fu_each_src_dest(src, dest) Internal use only
- #fu_each_src_dest0(src, dest) Internal use only
- #fu_get_gid(group) Internal use only
- #fu_get_uid(user) Internal use only
-
#fu_list(arg)
Internal use only
class
Entry_
. - #fu_mkdir(path, mode) Internal use only
- #fu_mode(mode, path) Internal use only
- #fu_output_message(msg) Internal use only
- #fu_same?(a, b) ⇒ Boolean Internal use only
- #fu_stat_identical_entry?(a, b) ⇒ Boolean Internal use only
- #mode_to_s(mode) Internal use only
- #remove_trailing_slash(dir) Internal use only
- #symbolic_modes_to_i(mode_sym, path) Internal use only
- #user_mask(target) Internal use only
StreamUtils_
- Included
Class Method Details
.cd(dir, verbose: nil, &block) (mod_func) Also known as: #chdir
Changes the current directory to the directory dir
.
If this method is called with block, resumes to the previous working directory after the block execution has finished.
Bundler::FileUtils.cd('/') # change directory
Bundler::FileUtils.cd('/', verbose: true) # change directory and report it
Bundler::FileUtils.cd('/') do # change directory
# ... # do something
end # return to original directory
.chdir(dir, verbose: nil, &block) (mod_func)
Alias for #cd.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 145
alias chdir cd
.chmod(mode, list, noop: nil, verbose: nil) (mod_func)
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
Bundler::FileUtils.chmod 0755, 'somecommand'
Bundler::FileUtils.chmod 0644, %w(my.rb your.rb his.rb her.rb)
Bundler::FileUtils.chmod 0755, '/usr/bin/ruby', verbose: true
Symbolic mode is
Bundler::FileUtils.chmod "u=wrx,go=rx", 'somecommand'
Bundler::FileUtils.chmod "u=wr,go=rr", %w(my.rb your.rb his.rb her.rb)
Bundler::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, noop: nil, verbose: nil, force: nil) (mod_func)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1029
def chmod_R(mode, list, noop: nil, verbose: nil, force: nil) 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, noop: nil, verbose: nil) (mod_func)
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.
Bundler::FileUtils.chown 'root', 'staff', '/usr/local/bin/ruby'
Bundler::FileUtils.chown nil, 'bin', Dir.glob('/usr/bin/*'), verbose: true
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1057
def chown(user, group, list, noop: nil, verbose: nil) 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, noop: nil, verbose: nil, force: nil) (mod_func)
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.
Bundler::FileUtils.chown_R 'www', 'www', '/var/www/htdocs'
Bundler::FileUtils.chown_R 'cvs', 'cvs', '/var/cvs', verbose: true
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1081
def chown_R(user, group, list, noop: nil, verbose: nil, force: nil) 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/bundler/vendor/fileutils/lib/fileutils.rb', line 827
alias cmp compare_file
.collect_method(opt)
Returns an Array of methods names which have the option opt
.
p Bundler::FileUtils.collect_method(:preserve) #=> ["cp", "cp_r", "copy", "install"]
.commands
Returns an Array of names of high-level methods that accept any keyword arguments.
p Bundler::FileUtils.commands #=> ["chmod", "cp", "cp_r", "install", ...]
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1640
def self.commands OPT_TABLE.keys end
.compare_file(a, b) (mod_func) Also known as: #identical?, #cmp
# File 'lib/bundler/vendor/fileutils/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/bundler/vendor/fileutils/lib/fileutils.rb', line 834
def compare_stream(a, b) bsize = fu_stream_blksize(a, b) if RUBY_VERSION > "2.4" sa = String.new(capacity: bsize) sb = String.new(capacity: bsize) else sa = String.new sb = String.new end 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, preserve: nil, noop: nil, verbose: nil) (mod_func)
Alias for #cp.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 435
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/bundler/vendor/fileutils/lib/fileutils.rb', line 489
def copy_entry(src, dest, preserve = false, dereference_root = false, remove_destination = false) if dereference_root src = File.realpath(src) end Entry_.new(src, nil, false).wrap_traverse(proc do |ent| destent = Entry_.new(dest, ent.rel, false) File.unlink destent.path if remove_destination && (File.file?(destent.path) || File.symlink?(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/bundler/vendor/fileutils/lib/fileutils.rb', line 521
def copy_stream(src, dest) IO.copy_stream(src, dest) end
.cp(src, dest, preserve: nil, noop: nil, verbose: nil) (mod_func) Also known as: #copy
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.
Bundler::FileUtils.cp 'eval.c', 'eval.c.org'
Bundler::FileUtils.cp %w(cgi.rb complex.rb date.rb), '/usr/lib/ruby/1.6'
Bundler::FileUtils.cp %w(cgi.rb complex.rb date.rb), '/usr/lib/ruby/1.6', verbose: true
Bundler::FileUtils.cp 'symlink', 'dest' # copy content, "dest" is not a symlink
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 426
def cp(src, dest, preserve: nil, noop: nil, verbose: nil) "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_lr(src, dest, noop: nil, verbose: nil, dereference_root: true, remove_destination: false) (mod_func)
Hard link src
to dest
. If src
is a directory, this method links all its contents recursively. If dest
is a directory, links src
to dest/src
.
src
can be a list of files.
If dereference_root
is true, this method dereference tree root.
If remove_destination
is true, this method removes each destination file before copy.
Bundler::FileUtils.rm_r site_ruby + '/mylib', force: true
Bundler::FileUtils.cp_lr 'lib/', site_ruby + '/mylib'
# Examples of linking several files to target directory.
Bundler::FileUtils.cp_lr %w(mail.rb field.rb debug/), site_ruby + '/tmail'
Bundler::FileUtils.cp_lr Dir.glob('*.rb'), '/home/aamine/lib/ruby', noop: true, verbose: true
# If you want to link all contents of a directory instead of the
# directory itself, c.f. src/x -> dest/x, src/y -> dest/y,
# use the following code.
Bundler::FileUtils.cp_lr 'src/.', 'dest' # cp_lr('src', 'dest') makes dest/src, but this doesn't.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 339
def cp_lr(src, dest, noop: nil, verbose: nil, dereference_root: true, remove_destination: false) "cp -lr#{remove_destination ? ' --remove-destination' : ''} #{[src,dest].flatten.join ' '}" if verbose return if noop fu_each_src_dest(src, dest) do |s, d| link_entry s, d, dereference_root, remove_destination end end
.cp_r(src, dest, preserve: nil, noop: nil, verbose: nil, dereference_root: true, remove_destination: nil) (mod_func)
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.
If dereference_root
is true, this method dereference tree root.
If remove_destination
is true, this method removes each destination file before copy.
# Installing Ruby library "mylib" under the site_ruby
Bundler::FileUtils.rm_r site_ruby + '/mylib', force: true
Bundler::FileUtils.cp_r 'lib/', site_ruby + '/mylib'
# Examples of copying several files to target directory.
Bundler::FileUtils.cp_r %w(mail.rb field.rb debug/), site_ruby + '/tmail'
Bundler::FileUtils.cp_r Dir.glob('*.rb'), '/home/foo/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.
Bundler::FileUtils.cp_r 'src/.', 'dest' # cp_r('src', 'dest') makes dest/src,
# but this doesn't.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 463
def cp_r(src, dest, preserve: nil, noop: nil, verbose: nil, dereference_root: true, remove_destination: nil) "cp -r#{preserve ? 'p' : ''}#{remove_destination ? ' --remove-destination' : ''} #{[src,dest].flatten.join ' '}" if verbose return if noop 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/bundler/vendor/fileutils/lib/fileutils.rb', line 120
alias getwd pwd
.have_option?(mid, opt) ⇒ Boolean
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1660
def self.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/bundler/vendor/fileutils/lib/fileutils.rb', line 826
alias identical? compare_file
.install(src, dest, mode: nil, owner: nil, group: nil, preserve: nil, noop: nil, verbose: nil) (mod_func)
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.
Bundler::FileUtils.install 'ruby', '/usr/local/bin/ruby', mode: 0755, verbose: true
Bundler::FileUtils.install 'lib.rb', '/usr/local/lib/ruby/site_ruby', verbose: true
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 862
def install(src, dest, mode: nil, owner: nil, group: nil, preserve: nil, noop: nil, verbose: nil) if verbose msg = +"install -c" msg << ' -p' if preserve msg << ' -m ' << mode_to_s(mode) if mode msg << " -o #{owner}" if owner msg << " -g #{group}" if group msg << ' ' << [src,dest].flatten.join(' ') msg end return if noop uid = fu_get_uid(owner) gid = fu_get_gid(group) 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 fu_mode(mode, st), d if mode File.chown uid, gid, d if uid or gid end end end
.link(src, dest, force: nil, noop: nil, verbose: nil) (mod_func)
Alias for #ln.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 313
alias link ln
.link_entry(src, dest, dereference_root = false, remove_destination = false) (mod_func)
Hard links a file system entry src
to dest
. If src
is a directory, this method links its contents recursively.
Both of src
and dest
must be a path name. src
must exist, dest
must not exist.
If dereference_root
is true, this method dereferences the tree root.
If remove_destination
is true, this method removes each destination file before copy.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 406
def link_entry(src, dest, 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.link destent.path end end
.ln(target, link, force: nil, noop: nil, verbose: nil) (mod_func)
.ln(target, dir, force: nil, noop: nil, verbose: nil)
.ln(targets, dir, force: nil, noop: nil, verbose: nil)
Also known as: #link
In the first form, creates a hard link .link which points to target
. If .link already exists, raises Errno::EEXIST
. But if the force
option is set, overwrites .link.
Bundler::FileUtils.ln 'gcc', 'cc', verbose: true
Bundler::FileUtils.ln '/usr/bin/emacs21', '/usr/bin/emacs'
In the second form, creates a link dir/target
pointing to target
. In the third form, creates several hard links in the directory dir
, pointing to each item in targets
. If dir
is not a directory, raises Errno::ENOTDIR
.
Bundler::FileUtils.cd '/sbin'
Bundler::FileUtils.ln %w(cp mv mkdir), '/bin' # Now /sbin/cp and /bin/cp are linked.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 303
def ln(src, dest, force: nil, noop: nil, verbose: nil) "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(target, link, force: nil, noop: nil, verbose: nil) (mod_func)
.ln_s(target, dir, force: nil, noop: nil, verbose: nil)
.ln_s(targets, dir, force: nil, noop: nil, verbose: nil)
Also known as: #symlink
In the first form, creates a symbolic link .link which points to target
. If .link already exists, raises Errno::EEXIST
. But if the force
option is set, overwrites .link.
Bundler::FileUtils.ln_s '/usr/bin/ruby', '/usr/local/bin/ruby'
Bundler::FileUtils.ln_s 'verylongsourcefilename.c', 'c', force: true
In the second form, creates a link dir/target
pointing to target
. In the third form, creates several symbolic links in the directory dir
, pointing to each item in targets
. If dir
is not a directory, raises Errno::ENOTDIR
.
Bundler::FileUtils.ln_s Dir.glob('/bin/*.rb'), '/home/foo/bin'
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 369
def ln_s(src, dest, force: nil, noop: nil, verbose: nil) "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(*args) (mod_func)
[ GitHub ]# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 390
def ln_sf(src, dest, noop: nil, verbose: nil) ln_s src, dest, force: true, noop: noop, verbose: verbose end
.makedirs(list, mode: nil, noop: nil, verbose: nil) (mod_func)
Alias for #mkdir_p.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 240
alias makedirs mkdir_p
.mkdir(list, mode: nil, noop: nil, verbose: nil) (mod_func)
.mkdir_p(list, mode: nil, noop: nil, verbose: nil) (mod_func) Also known as: #mkpath, #makedirs
Creates a directory and all its parent directories. For example,
Bundler::FileUtils.mkdir_p '/usr/local/lib/ruby'
causes to make following directories, if they do 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/bundler/vendor/fileutils/lib/fileutils.rb', line 206
def mkdir_p(list, mode: nil, noop: nil, verbose: nil) 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, mode: nil, noop: nil, verbose: nil) (mod_func)
Alias for #mkdir_p.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 239
alias mkpath mkdir_p
.move(src, dest, force: nil, noop: nil, verbose: nil, secure: nil) (mod_func)
Alias for #mv.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 565
alias move mv
.mv(src, dest, force: nil, noop: nil, verbose: nil, secure: nil) (mod_func) Also known as: #move
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.
Bundler::FileUtils.mv 'badname.rb', 'goodname.rb'
Bundler::FileUtils.mv 'stuff.rb', '/notexist/lib/ruby', force: true # no error
Bundler::FileUtils.mv %w(junk.txt dust.txt), '/home/foo/.trash/'
Bundler::FileUtils.mv Dir.glob('test*.rb'), 'test', noop: true, verbose: true
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 536
def mv(src, dest, force: nil, noop: nil, verbose: nil, secure: nil) "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 end end begin File.rename s, d rescue Errno::EXDEV, Errno::EPERM # move from unencrypted to encrypted dir (ext4) 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 Bundler::FileUtils. #=> ["noop", "force", "verbose", "preserve", "mode"]
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1649
def self. OPT_TABLE.values.flatten.uniq.map {|sym| sym.to_s } end
.options_of(mid)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1670
def self. (mid) OPT_TABLE[mid.to_s].map {|sym| sym.to_s } end
.private_module_function(name)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 107
def self.private_module_function(name) #:nodoc: module_function name private_class_method name end
.pwd (mod_func) Also known as: #getwd
Returns the name of the current directory.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 115
def pwd Dir.pwd end
.remove(list, force: nil, noop: nil, verbose: nil) (mod_func)
Alias for #rm.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 587
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/bundler/vendor/fileutils/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/bundler/vendor/fileutils/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:
For fileutils.rb, this vulnerability is reported in [ruby-dev:26100].
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 684
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, Bundler::FileUtils#remove_entry_secure does not work; abort: #{path.inspect} (parent directory mode #{'%o' % parent_st.mode})" end # freeze tree root euid = Process.euid dot_file = fullpath + "/." begin File.open(dot_file) {|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 } rescue Errno::EISDIR # JRuby in non-native mode can't open files as dirs File.lstat(dot_file).tap {|fstat| unless fu_stat_identical_entry?(st, fstat) # symlink (TOC-to-TOU attack?) File.unlink fullpath return end File.chown euid, -1, dot_file File.chmod 0700, dot_file } end 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/bundler/vendor/fileutils/lib/fileutils.rb', line 794
def remove_file(path, force = false) Entry_.new(path).remove_file rescue raise unless force end
.rm(list, force: nil, noop: nil, verbose: nil) (mod_func) Also known as: #remove
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 576
def rm(list, force: nil, noop: nil, verbose: nil) 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, noop: nil, verbose: nil) (mod_func) Also known as: #safe_unlink
[ GitHub ]# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 595
def rm_f(list, noop: nil, verbose: nil) rm list, force: true, noop: noop, verbose: verbose end
.rm_r(list, force: nil, noop: nil, verbose: nil, secure: nil) (mod_func)
remove files list
list
… If list
is a directory, removes its all contents recursively. This method ignores StandardError when :force
option is set.
Bundler::FileUtils.rm_r Dir.glob('/tmp/*')
Bundler::FileUtils.rm_r 'some_dir', 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/bundler/vendor/fileutils/lib/fileutils.rb', line 622
def rm_r(list, force: nil, noop: nil, verbose: nil, secure: nil) 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, noop: nil, verbose: nil, secure: nil) (mod_func) Also known as: #rmtree
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 644
def rm_rf(list, noop: nil, verbose: nil, secure: nil) rm_r list, force: true, noop: noop, verbose: verbose, secure: secure end
.rmdir(list, parents: nil, noop: nil, verbose: nil) (mod_func)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 263
def rmdir(list, parents: nil, noop: nil, verbose: nil) list = fu_list(list) "rmdir #{parents ? '-p ' : ''}#{list.join ' '}" if verbose return if noop list.each do |dir| Dir.rmdir(dir = remove_trailing_slash(dir)) if parents begin until (parent = File.dirname(dir)) == '.' or parent == dir dir = parent Dir.rmdir(dir) end rescue Errno::ENOTEMPTY, Errno::EEXIST, Errno::ENOENT end end end end
.rmtree(list, noop: nil, verbose: nil, secure: nil) (mod_func)
Alias for #rm_rf.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 649
alias rmtree rm_rf
.safe_unlink(list, noop: nil, verbose: nil) (mod_func)
Alias for #rm_f.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 600
alias safe_unlink rm_f
.symlink(src, dest, force: nil, noop: nil, verbose: nil) (mod_func)
Alias for #ln_s.
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 379
alias symlink ln_s
.touch(list, noop: nil, verbose: nil, mtime: nil, nocreate: nil) (mod_func)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1137
def touch(list, noop: nil, verbose: nil, mtime: nil, nocreate: nil) list = fu_list(list) 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)
Returns true if new
is newer than all old_list
. Non-existent files are older than any file.
Bundler::FileUtils.uptodate?('hello.o', %w(hello.c hello.h)) or \
system 'make hello.o'
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 155
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 Attribute Details
#fu_have_symlink? ⇒ Boolean
(readonly)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 756
def fu_have_symlink? #:nodoc: File.symlink nil, nil rescue NotImplementedError return false rescue TypeError return true end
Instance Method Details
#apply_mask(mode, user_mask, op, mode_mask)
#fu_each_src_dest(src, dest)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1585
def fu_each_src_dest(src, dest) #:nodoc: fu_each_src_dest0(src, dest) do |s, d| raise ArgumentError, "same file: #{s} and #{d}" if fu_same?(s, d) yield s, d end end
#fu_each_src_dest0(src, dest)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1593
def fu_each_src_dest0(src, dest) #:nodoc: if tmp = Array.try_convert(src) tmp.each do |s| s = File.path(s) yield s, File.join(dest, File.basename(s)) end else src = File.path(src) if File.directory?(dest) yield src, File.join(dest, File.basename(src)) else yield src, File.path(dest) end end end
#fu_get_gid(group)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1116
def fu_get_gid(group) #:nodoc: return nil unless group case group when Integer group when /\A\d+\z/ group.to_i else require 'etc' Etc.getgrnam(group) ? Etc.getgrnam(group).gid : nil end end
#fu_get_uid(user)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1102
def fu_get_uid(user) #:nodoc: return nil unless user case user when Integer user when /\A\d+\z/ user.to_i else require 'etc' Etc.getpwnam(user) ? Etc.getpwnam(user).uid : nil end end
#fu_list(arg)
class FileUtils::Entry_
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1580
def fu_list(arg) #:nodoc: [arg].flatten.map {|path| File.path(path) } end
#fu_mkdir(path, mode)
#fu_mode(mode, path)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 971
def fu_mode(mode, path) #:nodoc: mode.is_a?(String) ? symbolic_modes_to_i(mode, path) : mode end
#fu_output_message(msg)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1615
def (msg) #:nodoc: output = @fileutils_output if defined?(@fileutils_output) output ||= $stderr if defined?(@fileutils_label) msg = @fileutils_label + msg end output.puts msg end
#fu_same?(a, b) ⇒ Boolean
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 1610
def fu_same?(a, b) #:nodoc: File.identical?(a, b) end
#fu_stat_identical_entry?(a, b) ⇒ Boolean
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 765
def fu_stat_identical_entry?(a, b) #:nodoc: a.dev == b.dev and a.ino == b.ino end
#mode_to_s(mode)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 976
def mode_to_s(mode) #:nodoc: mode.is_a?(String) ? mode : "%o" % mode end
#remove_trailing_slash(dir)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 167
def remove_trailing_slash(dir) #:nodoc: dir == '/' ? dir : dir.chomp(?/) end
#symbolic_modes_to_i(mode_sym, path)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 919
def symbolic_modes_to_i(mode_sym, path) #:nodoc: mode = if File::Stat === path path.mode else File.stat(path).mode end mode_sym.split(/,/).inject(mode & 07777) do |current_mode, clause| target, *actions = clause.split(/([=+-])/) raise ArgumentError, "invalid file mode: #{mode_sym}" if actions.empty? target = 'a' if target.empty? user_mask = user_mask(target) actions.each_slice(2) do |op, perm| need_apply = op == '=' mode_mask = (perm || '').each_char.inject(0) do |mask, chr| case chr when "r" mask | 0444 when "w" mask | 0222 when "x" mask | 0111 when "X" if FileTest.directory? path mask | 0111 else mask end when "s" mask | 06000 when "t" mask | 01000 when "u", "g", "o" if mask.nonzero? current_mode = apply_mask(current_mode, user_mask, op, mask) end need_apply = false copy_mask = user_mask(chr) (current_mode & copy_mask) / (copy_mask & 0111) * (user_mask & 0111) else raise ArgumentError, "invalid `perm' symbol in file mode: #{chr}" end end if mode_mask.nonzero? || need_apply current_mode = apply_mask(current_mode, user_mask, op, mode_mask) end end current_mode end end
#user_mask(target)
# File 'lib/bundler/vendor/fileutils/lib/fileutils.rb', line 889
def user_mask(target) #:nodoc: target.each_char.inject(0) do |mask, chr| case chr when "u" mask | 04700 when "g" mask | 02070 when "o" mask | 01007 when "a" mask | 07777 else raise ArgumentError, "invalid `who' symbol in file mode: #{chr}" end end end