Module: FileUtils

Extended by:
StreamUtils_
Includes:
StreamUtils_
Defined in:
lib/rake.rb,
lib/un.rb,
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.

Defined Under Namespace

Modules: DryRun, NoWrite, StreamUtils_, Verbose Classes: Entry_

Constant Summary

RUBY_EXT =
((RbConfig::CONFIG['ruby_install_name'] =~ /\.(com|cmd|exe|bat|rb|sh)$/) ?
"" :
RbConfig::CONFIG['EXEEXT'])
RUBY =
File.join(
RbConfig::CONFIG['bindir'],
RbConfig::CONFIG['ruby_install_name'] + RUBY_EXT).
sub(/.*\s.*/m, '"\&"')
LN_SUPPORTED =
[true]
OPT_TABLE =

This hash table holds command options.

{}
METHODS =
singleton_methods() - [:private_module_function,
:commands, :options, :have_option?, :options_of, :collect_method]

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) private_module_function(name)

: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

Instance Method Details

- (Object) cd(dir, options = {}, &block) 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


118
119
120
121
122
123
# File 'lib/fileutils.rb', line 118

def cd(dir, options = {}, &block) # :yield: dir
  fu_check_options options, OPT_TABLE['cd']
  fu_output_message "cd #{dir}" if options[:verbose]
  Dir.chdir(dir, &block)
  fu_output_message 'cd -' if options[:verbose] and block
end

- (Object) chmod(mode, list, options = {})

Options: noop verbose

Changes permission bits on the named files (in list) to the bit pattern represented by mode.

FileUtils.chmod 0755, 'somecommand'
FileUtils.chmod 0644, %w(my.rb your.rb his.rb her.rb)
FileUtils.chmod 0755, '/usr/bin/ruby', :verbose => true


871
872
873
874
875
876
877
878
879
# File 'lib/fileutils.rb', line 871

def chmod(mode, list, options = {})
  fu_check_options options, OPT_TABLE['chmod']
  list = fu_list(list)
  fu_output_message sprintf('chmod %o %s', mode, list.join(' ')) if options[:verbose]
  return if options[:noop]
  list.each do |path|
    Entry_.new(path).chmod mode
  end
end

- (Object) chmod_R(mode, list, options = {})

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.#{$$}"


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'lib/fileutils.rb', line 892

def chmod_R(mode, list, options = {})
  fu_check_options options, OPT_TABLE['chmod_R']
  list = fu_list(list)
  fu_output_message sprintf('chmod -R%s %o %s',
                            (options[:force] ? 'f' : ''),
                            mode, list.join(' ')) if options[:verbose]
  return if options[:noop]
  list.each do |root|
    Entry_.new(root).traverse do |ent|
      begin
        ent.chmod mode
      rescue
        raise unless options[:force]
      end
    end
  end
end

- (Object) chown(user, group, list, options = {})

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


925
926
927
928
929
930
931
932
933
934
935
936
937
# File 'lib/fileutils.rb', line 925

def chown(user, group, list, options = {})
  fu_check_options options, OPT_TABLE['chown']
  list = fu_list(list)
  fu_output_message sprintf('chown %s%s',
                            [user,group].compact.join(':') + ' ',
                            list.join(' ')) if options[:verbose]
  return if options[:noop]
  uid = fu_get_uid(user)
  gid = fu_get_gid(group)
  list.each do |path|
    Entry_.new(path).chown uid, gid
  end
end

- (Object) chown_R(user, group, list, options = {})

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


954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
# File 'lib/fileutils.rb', line 954

def chown_R(user, group, list, options = {})
  fu_check_options options, OPT_TABLE['chown_R']
  list = fu_list(list)
  fu_output_message sprintf('chown -R%s %s%s',
                            (options[:force] ? 'f' : ''),
                            [user,group].compact.join(':') + ' ',
                            list.join(' ')) if options[:verbose]
  return if options[: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 options[:force]
      end
    end
  end
end

- (Object) compare_file(a, b) 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


800
801
802
803
804
805
806
807
# File 'lib/fileutils.rb', line 800

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

- (Object) compare_stream(a, b)

Returns true if the contents of a stream a and b are identical.



818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'lib/fileutils.rb', line 818

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

- (Object) copy_entry(src, dest, preserve = false, dereference_root = false, remove_destination = false)

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.



460
461
462
463
464
465
466
467
# File 'lib/fileutils.rb', line 460

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

- (Object) copy_file(src, dest, preserve = false, dereference = true)

Copies file contents of src to dest. Both of src and dest must be a path name.



474
475
476
477
478
# File 'lib/fileutils.rb', line 474

def copy_file(src, dest, preserve = false, dereference = true)
  ent = Entry_.new(src, nil, dereference)
  ent.copy_file dest
  ent. dest if preserve
end

- (Object) copy_stream(src, dest)

Copies stream src to dest. src must respond to #read(n) and dest must respond to #write(str).



486
487
488
# File 'lib/fileutils.rb', line 486

def copy_stream(src, dest)
  IO.copy_stream(src, dest)
end

- (Object) cp(src, dest, options = {})

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


387
388
389
390
391
392
393
394
# File 'lib/fileutils.rb', line 387

def cp(src, dest, options = {})
  fu_check_options options, OPT_TABLE['cp']
  fu_output_message "cp#{options[:preserve] ? ' -p' : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
  return if options[:noop]
  fu_each_src_dest(src, dest) do |s, d|
    copy_file s, d, options[:preserve]
  end
end

- (Object) cp_r(src, dest, options = {})

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.


429
430
431
432
433
434
435
436
437
438
# File 'lib/fileutils.rb', line 429

def cp_r(src, dest, options = {})
  fu_check_options options, OPT_TABLE['cp_r']
  fu_output_message "cp -r#{options[:preserve] ? 'p' : ''}#{options[:remove_destination] ? ' --remove-destination' : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
  return if options[:noop]
  options = options.dup
  options[:dereference_root] = true unless options.key?(:dereference_root)
  fu_each_src_dest(src, dest) do |s, d|
    copy_entry s, d, options[:preserve], options[:dereference_root], options[:remove_destination]
  end
end

- (Boolean) fu_have_symlink?

:nodoc

Returns:

  • (Boolean)


740
741
742
743
744
745
746
# File 'lib/fileutils.rb', line 740

def fu_have_symlink?   #:nodoc
  File.symlink nil, nil
rescue NotImplementedError
  return false
rescue
  return true
end

- (Object) fu_mkdir(path, mode)

:nodoc:



237
238
239
240
241
242
243
244
245
# File 'lib/fileutils.rb', line 237

def fu_mkdir(path, mode)   #:nodoc:
  path = path.sub(%r</\z>, '')
  if mode
    Dir.mkdir path, mode
    File.chmod mode, path
  else
    Dir.mkdir path
  end
end

- (Boolean) fu_stat_identical_entry?(a, b)

:nodoc:

Returns:

  • (Boolean)


749
750
751
# File 'lib/fileutils.rb', line 749

def fu_stat_identical_entry?(a, b)   #:nodoc:
  a.dev == b.dev and a.ino == b.ino
end

- (Object) install(src, dest, options = {})

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


844
845
846
847
848
849
850
851
852
853
854
855
856
# File 'lib/fileutils.rb', line 844

def install(src, dest, options = {})
  fu_check_options options, OPT_TABLE['install']
  fu_output_message "install -c#{options[:preserve] && ' -p'}#{options[:mode] ? (' -m 0%o' % options[:mode]) : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
  return if options[: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 options[:preserve]
      File.chmod options[:mode], d if options[:mode]
    end
  end
end

- (Object) ln(src, dest, options = {}) 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.


302
303
304
305
306
307
308
309
310
# File 'lib/fileutils.rb', line 302

def ln(src, dest, options = {})
  fu_check_options options, OPT_TABLE['ln']
  fu_output_message "ln#{options[:force] ? ' -f' : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
  return if options[:noop]
  fu_each_src_dest0(src, dest) do |s,d|
    remove_file d, true if options[:force]
    File.link s, d
  end
end

- (Object) ln_s(src, dest, options = {}) 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'


341
342
343
344
345
346
347
348
349
# File 'lib/fileutils.rb', line 341

def ln_s(src, dest, options = {})
  fu_check_options options, OPT_TABLE['ln_s']
  fu_output_message "ln -s#{options[:force] ? 'f' : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
  return if options[:noop]
  fu_each_src_dest0(src, dest) do |s,d|
    remove_file d, true if options[:force]
    File.symlink s, d
  end
end

- (Object) ln_sf(src, dest, options = {})

Options: noop verbose

Same as

#ln_s(src, dest, :force)


364
365
366
367
368
369
# File 'lib/fileutils.rb', line 364

def ln_sf(src, dest, options = {})
  fu_check_options options, OPT_TABLE['ln_sf']
  options = options.dup
  options[:force] = true
  ln_s src, dest, options
end

- (Object) mkdir(list, options = {})

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


165
166
167
168
169
170
171
172
173
174
# File 'lib/fileutils.rb', line 165

def mkdir(list, options = {})
  fu_check_options options, OPT_TABLE['mkdir']
  list = fu_list(list)
  fu_output_message "mkdir #{options[:mode] ? ('-m %03o ' % options[:mode]) : ''}#{list.join ' '}" if options[:verbose]
  return if options[:noop]

  list.each do |dir|
    fu_mkdir dir, options[:mode]
  end
end

- (Object) mkdir_p(list, options = {}) 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.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'lib/fileutils.rb', line 195

def mkdir_p(list, options = {})
  fu_check_options options, OPT_TABLE['mkdir_p']
  list = fu_list(list)
  fu_output_message "mkdir -p #{options[:mode] ? ('-m %03o ' % options[:mode]) : ''}#{list.join ' '}" if options[:verbose]
  return *list if options[:noop]

  list.map {|path| path.sub(%r</\z>, '') }.each do |path|
    # optimize for the most common case
    begin
      fu_mkdir path, options[: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, options[:mode]
      rescue SystemCallError => err
        raise unless File.directory?(dir)
      end
    end
  end

  return *list
end

- (Object) mv(src, dest, options = {}) 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


503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
# File 'lib/fileutils.rb', line 503

def mv(src, dest, options = {})
  fu_check_options options, OPT_TABLE['mv']
  fu_output_message "mv#{options[:force] ? ' -f' : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
  return if options[: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 options[:secure]
          remove_entry_secure s, options[:force]
        else
          remove_entry s, options[:force]
        end
      end
    rescue SystemCallError
      raise unless options[:force]
    end
  end
end

- (Object) pwd Also known as: getwd

Options: (none)

Returns the name of the current directory.



100
101
102
# File 'lib/fileutils.rb', line 100

def pwd
  Dir.pwd
end

- (Object) remove_dir(path, force = false)

Removes a directory dir and its contents recursively. This method ignores StandardError if force is true.



789
790
791
# File 'lib/fileutils.rb', line 789

def remove_dir(path, force = false)
  remove_entry path, force   # FIXME?? check if it is a directory
end

- (Object) remove_entry(path, force = false)

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.



761
762
763
764
765
766
767
768
769
770
771
# File 'lib/fileutils.rb', line 761

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

- (Object) remove_entry_secure(path, force = false)

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 are not world writable. Otherwise this method does not work. Only exception is temporary directory like /tmp and /var/tmp, whose permission is 1777.

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].



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
# File 'lib/fileutils.rb', line 689

def remove_entry_secure(path, force = false)
  unless fu_have_symlink?
    remove_entry path, force
    return
  end
  fullpath = File.expand_path(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
  }
  # ---- 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

- (Object) remove_file(path, force = false)

Removes a file path. This method ignores StandardError if force is true.



778
779
780
781
782
# File 'lib/fileutils.rb', line 778

def remove_file(path, force = false)
  Entry_.new(path).remove_file
rescue
  raise unless force
end

- (Boolean) rename_cannot_overwrite_file?

:nodoc:

Returns:

  • (Boolean)


540
541
542
# File 'lib/fileutils.rb', line 540

def rename_cannot_overwrite_file?   #:nodoc:
  /cygwin|mswin|mingw|bccwin|emx/ =~ RUBY_PLATFORM
end

- (Object) rm(list, options = {}) 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


555
556
557
558
559
560
561
562
563
564
# File 'lib/fileutils.rb', line 555

def rm(list, options = {})
  fu_check_options options, OPT_TABLE['rm']
  list = fu_list(list)
  fu_output_message "rm#{options[:force] ? ' -f' : ''} #{list.join ' '}" if options[:verbose]
  return if options[:noop]

  list.each do |path|
    remove_file path, options[:force]
  end
end

- (Object) rm_f(list, options = {}) Also known as: safe_unlink

Options: noop verbose

Equivalent to

#rm(list, :force => true)


580
581
582
583
584
585
# File 'lib/fileutils.rb', line 580

def rm_f(list, options = {})
  fu_check_options options, OPT_TABLE['rm_f']
  options = options.dup
  options[:force] = true
  rm list, options
end

- (Object) rm_r(list, options = {})

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.



615
616
617
618
619
620
621
622
623
624
625
626
627
628
# File 'lib/fileutils.rb', line 615

def rm_r(list, options = {})
  fu_check_options options, OPT_TABLE['rm_r']
  # options[:secure] = true unless options.key?(:secure)
  list = fu_list(list)
  fu_output_message "rm -r#{options[:force] ? 'f' : ''} #{list.join ' '}" if options[:verbose]
  return if options[:noop]
  list.each do |path|
    if options[:secure]
      remove_entry_secure path, options[:force]
    else
      remove_entry path, options[:force]
    end
  end
end

- (Object) rm_rf(list, options = {}) 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.



643
644
645
646
647
648
# File 'lib/fileutils.rb', line 643

def rm_rf(list, options = {})
  fu_check_options options, OPT_TABLE['rm_rf']
  options = options.dup
  options[:force] = true
  rm_r list, options
end

- (Object) rmdir(list, options = {})

Options: 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


258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/fileutils.rb', line 258

def rmdir(list, options = {})
  fu_check_options options, OPT_TABLE['rmdir']
  list = fu_list(list)
  parents = options[:parents]
  fu_output_message "rmdir #{parents ? '-p ' : ''}#{list.join ' '}" if options[:verbose]
  return if options[:noop]
  list.each do |dir|
    begin
      Dir.rmdir(dir = dir.sub(%r</\z>, ''))
      if parents
        until (parent = File.dirname(dir)) == '.' or parent == dir
          Dir.rmdir(dir)
        end
      end
    rescue Errno::ENOTEMPTY, Errno::ENOENT
    end
  end
end

- (Object) ruby(*args, &block)

Run a Ruby interpreter with the given arguments.

Example:

ruby %{-pe '$_.upcase!' <README}


1022
1023
1024
1025
1026
1027
1028
1029
# File 'lib/rake.rb', line 1022

def ruby(*args,&block)
  options = (Hash === args.last) ? args.pop : {}
  if args.length > 1 then
    sh(*([RUBY] + args + [options]), &block)
  else
    sh("#{RUBY} #{args.first}", options, &block)
  end
end

- (Object) safe_ln(*args)

Attempt to do a normal file link, but fall back to a copy if the link

fails.


1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
# File 'lib/rake.rb', line 1035

def safe_ln(*args)
  unless LN_SUPPORTED[0]
    cp(*args)
  else
    begin
      ln(*args)
    rescue StandardError, NotImplementedError => ex
      LN_SUPPORTED[0] = false
      cp(*args)
    end
  end
end

- (Object) sh(*cmd, &block)

Run the system command cmd. If multiple arguments are given the command is not run with the shell (same semantics as Kernel::exec and Kernel::system).

Example:

sh %{ls -ltr}

sh 'ls', 'file with spaces'

# check exit status after command runs
sh %{grep pattern file} do |ok, res|
  if ! ok
    puts "pattern not found (status = #{res.exitstatus})"
  end
end


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
# File 'lib/rake.rb', line 986

def sh(*cmd, &block)
  options = (Hash === cmd.last) ? cmd.pop : {}
  unless block_given?
    show_command = cmd.join(" ")
    show_command = show_command[0,42] + "..." unless $trace
    # TODO code application logic heref show_command.length > 45
    block = lambda { |ok, status|
      ok or fail "Command failed with status (#{status.exitstatus}): [#{show_command}]"
    }
  end
  if RakeFileUtils.verbose_flag == :default
    options[:verbose] = true
  else
    options[:verbose] ||= RakeFileUtils.verbose_flag
  end
  options[:noop]    ||= RakeFileUtils.nowrite_flag
  rake_check_options options, :noop, :verbose
  rake_output_message cmd.join(" ") if options[:verbose]
  unless options[:noop]
    res = rake_system(*cmd)
    status = $?
    status = PseudoStatus.new(1) if !res && status.nil?
    block.call(res, status)
  end
end

- (Object) split_all(path)

Split a file path into individual directory names.

Example:

split_all("a/b/c") =>  ['a', 'b', 'c']


1053
1054
1055
1056
1057
1058
# File 'lib/rake.rb', line 1053

def split_all(path)
  head, tail = File.split(path)
  return [tail] if head == '.' || tail == '/'
  return [head, tail] if head == '/'
  return split_all(head) + [tail]
end

- (Object) touch(list, options = {})

Options: noop verbose

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'


1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
# File 'lib/fileutils.rb', line 1031

def touch(list, options = {})
  fu_check_options options, OPT_TABLE['touch']
  list = fu_list(list)
  created = nocreate = options[:nocreate]
  t = options[:mtime]
  if options[:verbose]
    fu_output_message "touch #{nocreate ? ' -c' : ''}#{t ? t.strftime(' -t %Y%m%d%H%M.%S') : ''}#{list.join ' '}"
  end
  return if options[: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

- (Boolean) uptodate?(new, old_list, options = nil)

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'

Returns:

  • (Boolean)

Raises:

  • (ArgumentError)


141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/fileutils.rb', line 141

def uptodate?(new, old_list, options = nil)
  raise ArgumentError, 'uptodate? does not accept any option' if options

  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