Class: FileUtils::Entry_

Inherits:

Object

• Object
• FileUtils::Entry_

Includes:

StreamUtils_

Defined in:

lib/fileutils.rb

Overview

:nodoc: internal use only

Constant Summary

S_IF_DOOR =

0xD000

Instance Method Summary

• #blockdev? ⇒ Boolean
• #chardev? ⇒ Boolean
• #chmod(mode) ⇒ Object
• #chown(uid, gid) ⇒ Object
• #copy(dest) ⇒ Object
• #copy_file(dest) ⇒ Object
• #copy_metadata(path) ⇒ Object
• #dereference? ⇒ Boolean
• #directory? ⇒ Boolean
• #door? ⇒ Boolean
• #entries ⇒ Object
• #exist? ⇒ Boolean
• #file? ⇒ Boolean
• #initialize(a, b = nil, deref = false) ⇒ Entry_ constructor

  A new instance of Entry_.

• #inspect ⇒ Object
• #lstat ⇒ Object
• #lstat! ⇒ Object
• #path ⇒ Object
• #pipe? ⇒ Boolean
• #platform_support ⇒ Object
• #postorder_traverse ⇒ Object
• #prefix ⇒ Object
• #preorder_traverse ⇒ Object (also: #traverse)
• #rel ⇒ Object
• #remove ⇒ Object
• #remove_dir1 ⇒ Object
• #remove_file ⇒ Object
• #socket? ⇒ Boolean
• #stat ⇒ Object
• #stat! ⇒ Object
• #symlink? ⇒ Boolean
• #wrap_traverse(pre, post) ⇒ Object

Constructor Details

#initialize(a, b = nil, deref = false) ⇒ Entry_

Returns a new instance of Entry_.

# File 'lib/fileutils.rb', line 1209

def initialize(a, b = nil, deref = false)
  @prefix = @rel = @path = nil
  if b
    @prefix = a
    @rel = b
  else
    @path = a
  end
  @deref = deref
  @stat = nil
  @lstat = nil
end

Instance Method Details

#blockdev? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/fileutils.rb', line 1275

def blockdev?
  s = lstat!
  s and s.blockdev?
end

#chardev? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/fileutils.rb', line 1270

def chardev?
  s = lstat!
  s and s.chardev?
end

#chmod(mode) ⇒ Object

# File 'lib/fileutils.rb', line 1341

def chmod(mode)
  if symlink?
    File.lchmod mode, path() if have_lchmod?
  else
    File.chmod mode, path()
  end
end

#chown(uid, gid) ⇒ Object

# File 'lib/fileutils.rb', line 1349

def chown(uid, gid)
  if symlink?
    File.lchown uid, gid, path() if have_lchown?
  else
    File.chown uid, gid, path()
  end
end

#copy(dest) ⇒ Object

# File 'lib/fileutils.rb', line 1357

def copy(dest)
  case
  when file?
    copy_file dest
  when directory?
    if !File.exist?(dest) and descendant_directory?(dest, path)
      raise ArgumentError, "cannot copy directory %s to itself %s" % [path, dest]
    end
    begin
      Dir.mkdir dest
    rescue
      raise unless File.directory?(dest)
    end
  when symlink?
    File.symlink File.readlink(path()), dest
  when chardev?
    raise "cannot handle device file" unless File.respond_to?(:mknod)
    mknod dest, ?c, 0666, lstat().rdev
  when blockdev?
    raise "cannot handle device file" unless File.respond_to?(:mknod)
    mknod dest, ?b, 0666, lstat().rdev
  when socket?
    raise "cannot handle socket" unless File.respond_to?(:mknod)
    mknod dest, nil, lstat().mode, 0
  when pipe?
    raise "cannot handle FIFO" unless File.respond_to?(:mkfifo)
    mkfifo dest, 0666
  when door?
    raise "cannot handle door: #{path()}"
  else
    raise "unknown file type: #{path()}"
  end
end

#copy_file(dest) ⇒ Object

# File 'lib/fileutils.rb', line 1391

def copy_file(dest)
  File.open(path()) do |s|
    File.open(dest, 'wb', s.stat.mode) do |f|
      IO.copy_stream(s, f)
    end
  end
end

#copy_metadata(path) ⇒ Object

# File 'lib/fileutils.rb', line 1399

def copy_metadata(path)
  st = lstat()
  if !st.symlink?
    File.utime st.atime, st.mtime, path
  end
  begin
    if st.symlink?
      begin
        File.lchown st.uid, st.gid, path
      rescue NotImplementedError
      end
    else
      File.chown st.uid, st.gid, path
    end
  rescue Errno::EPERM
    # clear setuid/setgid
    if st.symlink?
      begin
        File.lchmod st.mode & 01777, path
      rescue NotImplementedError
      end
    else
      File.chmod st.mode & 01777, path
    end
  else
    if st.symlink?
      begin
        File.lchmod st.mode, path
      rescue NotImplementedError
      end
    else
      File.chmod st.mode, path
    end
  end
end

#dereference? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/fileutils.rb', line 1242

def dereference?
  @deref
end

#directory? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/fileutils.rb', line 1260

def directory?
  s = lstat!
  s and s.directory?
end

#door? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/fileutils.rb', line 1292

def door?
  s = lstat!
  s and (s.mode & 0xF000 == S_IF_DOOR)
end

#entries ⇒ Object

# File 'lib/fileutils.rb', line 1297

def entries
  opts = {}
  opts[:encoding] = ::Encoding::UTF_8 if fu_windows?
  Dir.entries(path(), opts)\
      .reject {|n| n == '.' or n == '..' }\
      .map {|n| Entry_.new(prefix(), join(rel(), n.untaint)) }
end

#exist? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/fileutils.rb', line 1246

def exist?
  begin
    lstat
    true
  rescue Errno::ENOENT
    false
  end
end

#file? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/fileutils.rb', line 1255

def file?
  s = lstat!
  s and s.file?
end

#inspect ⇒ Object

# File 'lib/fileutils.rb', line 1222

def inspect
  "\#<#{self.class} #{path()}>"
end

#lstat ⇒ Object

# File 'lib/fileutils.rb', line 1327

def lstat
  if dereference?
    @lstat ||= File.stat(path())
  else
    @lstat ||= File.lstat(path())
  end
end

#lstat! ⇒ Object

# File 'lib/fileutils.rb', line 1335

def lstat!
  lstat()
rescue SystemCallError
  nil
end

#path ⇒ Object

# File 'lib/fileutils.rb', line 1226

def path
  if @path
    File.path(@path)
  else
    join(@prefix, @rel)
  end
end

#pipe? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/fileutils.rb', line 1285

def pipe?
  s = lstat!
  s and s.pipe?
end

#platform_support ⇒ Object

# File 'lib/fileutils.rb', line 1455

def platform_support
  return yield unless fu_windows?
  first_time_p = true
  begin
    yield
  rescue Errno::ENOENT
    raise
  rescue => err
    if first_time_p
      first_time_p = false
      begin
        File.chmod 0700, path()   # Windows does not have symlink
        retry
      rescue SystemCallError
      end
    end
    raise err
  end
end

#postorder_traverse ⇒ Object

# File 'lib/fileutils.rb', line 1485

def postorder_traverse
  if directory?
    entries().each do |ent|
      ent.postorder_traverse do |e|
        yield e
      end
    end
  end
ensure
  yield self
end

#prefix ⇒ Object

# File 'lib/fileutils.rb', line 1234

def prefix
  @prefix || @path
end

#preorder_traverse ⇒ Object Also known as: traverse

# File 'lib/fileutils.rb', line 1475

def preorder_traverse
  stack = [self]
  while ent = stack.pop
    yield ent
    stack.concat ent.entries.reverse if ent.directory?
  end
end

#rel ⇒ Object

# File 'lib/fileutils.rb', line 1238

def rel
  @rel
end

#remove ⇒ Object

# File 'lib/fileutils.rb', line 1435

def remove
  if directory?
    remove_dir1
  else
    remove_file
  end
end

#remove_dir1 ⇒ Object

# File 'lib/fileutils.rb', line 1443

def remove_dir1
  platform_support {
    Dir.rmdir path().chomp(?/)
  }
end

#remove_file ⇒ Object

# File 'lib/fileutils.rb', line 1449

def remove_file
  platform_support {
    File.unlink path
  }
end

#socket? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/fileutils.rb', line 1280

def socket?
  s = lstat!
  s and s.socket?
end

#stat ⇒ Object

# File 'lib/fileutils.rb', line 1305

def stat
  return @stat if @stat
  if lstat() and lstat().symlink?
    @stat = File.stat(path())
  else
    @stat = lstat()
  end
  @stat
end

#stat! ⇒ Object

# File 'lib/fileutils.rb', line 1315

def stat!
  return @stat if @stat
  if lstat! and lstat!.symlink?
    @stat = File.stat(path())
  else
    @stat = lstat!
  end
  @stat
rescue SystemCallError
  nil
end

#symlink? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/fileutils.rb', line 1265

def symlink?
  s = lstat!
  s and s.symlink?
end

#wrap_traverse(pre, post) ⇒ Object

# File 'lib/fileutils.rb', line 1497

def wrap_traverse(pre, post)
  pre.call self
  if directory?
    entries.each do |ent|
      ent.wrap_traverse pre, post
    end
  end
  post.call self
end