Class: Chef::Win32::File

Inherits:

Object

Object
Chef::Win32::File

show all

Extended by:: API::File

Includes:: API::File

Defined in:: lib/chef/win32/file.rb,
lib/chef/win32/file/info.rb

Defined Under Namespace

Classes: Info

Constant Summary

Constants included from API::File

Constants included from API

API::WIN32_EPOC_MINUS_POSIX_EPOC

Constants included from API::System

Constants included from API::Security

Class Method Summary collapse

.info(file_name) ⇒ Object (also: stat)
.link(old_name, new_name) ⇒ Object

Creates a symbolic link called new_name for the file or directory old_name.
.readlink(link_name) ⇒ Object

Returns the path of the of the symbolic link referred to by file.
.symlink(old_name, new_name) ⇒ Object

Creates a symbolic link called new_name for the file or directory old_name.
.symlink?(file_name) ⇒ Boolean

Return true if the named file is a symbolic link, false otherwise.

Methods included from API::File

encode_path, file_handle, file_search_handle, path_prepender, retrieve_file_info

Methods included from API

extended, #make_uint64, #wtime_to_time

Class Method Details

.info(file_name) ⇒ `Object` Also known as: stat



104
105
106

# File 'lib/chef/win32/file.rb', line 104

def self.info(file_name)
  Info.new(file_name)
end

.link(old_name, new_name) ⇒ `Object`

Creates a symbolic link called new_name for the file or directory old_name.

This method requires Windows Vista or later to work. Otherwise, it returns nil as per MRI.

Raises:

(Errno::ENOENT)

# File 'lib/chef/win32/file.rb', line 36

def self.link(old_name, new_name)
  raise Errno::ENOENT, "(#{old_name}, #{new_name})" unless ::File.exist?(old_name)
  # TODO do a check for CreateHardLinkW and
  # raise NotImplemented exception on older Windows
  old_name = encode_path(old_name)
  new_name = encode_path(new_name)
  unless CreateHardLinkW(new_name, old_name, nil)
    Chef::Win32::Error.raise!
  end
end

.readlink(link_name) ⇒ `Object`

Returns the path of the of the symbolic link referred to by file.

Requires Windows Vista or later. On older versions of Windows it will raise a NotImplementedError, as per MRI.

Raises:

(Errno::ENOENT)

# File 'lib/chef/win32/file.rb', line 90

def self.readlink(link_name)
  raise Errno::ENOENT, link_name unless ::File.exist?(link_name)
  # TODO do a check for GetFinalPathNameByHandleW and
  # raise NotImplemented exception on older Windows
  file_handle(link_name) do |handle|
    buffer = FFI::MemoryPointer.new(0.chr * MAX_PATH)
    num_chars = GetFinalPathNameByHandleW(handle, buffer, buffer.size, FILE_NAME_NORMALIZED)
    if num_chars == 0
      Chef::Win32::Error.raise! #could be misleading if problem is too small buffer size as GetLastError won't report failure
    end
    buffer.read_wstring(num_chars).sub(path_prepender, "")
  end
end

.symlink(old_name, new_name) ⇒ `Object`

Creates a symbolic link called new_name for the file or directory old_name.

This method requires Windows Vista or later to work. Otherwise, it returns nil as per MRI.

Raises:

(Errno::ENOENT)

# File 'lib/chef/win32/file.rb', line 53

def self.symlink(old_name, new_name)
  raise Errno::ENOENT, "(#{old_name}, #{new_name})" unless ::File.exist?(old_name)
  # TODO do a check for CreateSymbolicLinkW and
  # raise NotImplemented exception on older Windows
  flags = ::File.directory?(old_name) ? SYMBOLIC_LINK_FLAG_DIRECTORY : 0
  old_name = encode_path(old_name)
  new_name = encode_path(new_name)
  unless CreateSymbolicLinkW(new_name, old_name, flags)
    Chef::Win32::Error.raise!
  end
end

.symlink?(file_name) ⇒ `Boolean`

Return true if the named file is a symbolic link, false otherwise.

This method requires Windows Vista or later to work. Otherwise, it always returns false as per MRI.

Returns:

(Boolean)

# File 'lib/chef/win32/file.rb', line 70

def self.symlink?(file_name)
  is_symlink = false
  path = encode_path(file_name)
  if ::File.exists?(file_name)
    if ((GetFileAttributesW(path) & FILE_ATTRIBUTE_REPARSE_POINT) > 0)
      file_search_handle(file_name) do |handle, find_data|
        if find_data[:dw_reserved_0] == IO_REPARSE_TAG_SYMLINK
          is_symlink = true
        end
      end
    end
  end
  is_symlink
end

Class: Chef::Win32::File

Defined Under Namespace

Constant Summary

Constants included from API::File

Constants included from API

Constants included from API::System

Constants included from API::Security

Class Method Summary collapse

Methods included from API::File

Methods included from API

Class Method Details

.info(file_name) ⇒ Object Also known as: stat

.link(old_name, new_name) ⇒ Object

.readlink(link_name) ⇒ Object

.symlink(old_name, new_name) ⇒ Object

.symlink?(file_name) ⇒ Boolean

.info(file_name) ⇒ `Object` Also known as: stat

.link(old_name, new_name) ⇒ `Object`

.readlink(link_name) ⇒ `Object`

.symlink(old_name, new_name) ⇒ `Object`

.symlink?(file_name) ⇒ `Boolean`