mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
29cef5f795
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@2927 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
584 lines
14 KiB
Ruby
584 lines
14 KiB
Ruby
#
|
|
# shell/command-controller.rb -
|
|
# $Release Version: 0.6.0 $
|
|
# $Revision$
|
|
# $Date$
|
|
# by Keiju ISHITSUKA(Nippon Rational Inc.)
|
|
#
|
|
# --
|
|
#
|
|
#
|
|
#
|
|
|
|
require "e2mmap"
|
|
require "ftools"
|
|
require "thread"
|
|
|
|
require "shell/error"
|
|
require "shell/filter"
|
|
require "shell/system-command"
|
|
require "shell/builtin-command"
|
|
|
|
class Shell
|
|
class CommandProcessor
|
|
|
|
#
|
|
# initialize of Shell and related classes.
|
|
#
|
|
NoDelegateMethods = ["initialize", "expand_path"]
|
|
def self.initialize
|
|
|
|
install_builtin_commands
|
|
|
|
# define CommandProccessor#methods to Shell#methods and Filter#methods
|
|
for m in CommandProcessor.instance_methods - NoDelegateMethods
|
|
add_delegate_command_to_shell(m)
|
|
end
|
|
|
|
def self.method_added(id)
|
|
add_delegate_command_to_shell(id)
|
|
end
|
|
end
|
|
|
|
#
|
|
# include run file.
|
|
#
|
|
def self.run_config
|
|
begin
|
|
load File.expand_path("~/.rb_shell") if ENV.key?("HOME")
|
|
rescue LoadError, Errno::ENOENT
|
|
rescue
|
|
print "load error: #{rc}\n"
|
|
print $!.class, ": ", $!, "\n"
|
|
for err in $@[0, $@.size - 2]
|
|
print "\t", err, "\n"
|
|
end
|
|
end
|
|
end
|
|
|
|
def initialize(shell)
|
|
@shell = shell
|
|
@system_commands = {}
|
|
end
|
|
|
|
#
|
|
# CommandProcessor#expand_path(path)
|
|
# path: String
|
|
# return: String
|
|
# returns the absolute path for <path>
|
|
#
|
|
def expand_path(path)
|
|
@shell.expand_path(path)
|
|
end
|
|
|
|
#
|
|
# File related commands
|
|
# Shell#foreach
|
|
# Shell#open
|
|
# Shell#unlink
|
|
# Shell#test
|
|
#
|
|
# -
|
|
#
|
|
# CommandProcessor#foreach(path, rs)
|
|
# path: String
|
|
# rs: String - record separator
|
|
# iterator
|
|
# Same as:
|
|
# File#foreach (when path is file)
|
|
# Dir#foreach (when path is directory)
|
|
# path is relative to pwd
|
|
#
|
|
def foreach(path = nil, *rs)
|
|
path = "." unless path
|
|
path = expand_path(path)
|
|
|
|
if File.directory?(path)
|
|
Dir.foreach(path){|fn| yield fn}
|
|
else
|
|
IO.foreach(path, *rs){|l| yield l}
|
|
end
|
|
end
|
|
|
|
#
|
|
# CommandProcessor#open(path, mode)
|
|
# path: String
|
|
# mode: String
|
|
# return: File or Dir
|
|
# Same as:
|
|
# File#open (when path is file)
|
|
# Dir#open (when path is directory)
|
|
# mode has an effect only when path is a file
|
|
#
|
|
def open(path, mode)
|
|
path = expand_path(path)
|
|
if File.directory?(path)
|
|
Dir.open(path)
|
|
else
|
|
effect_umask do
|
|
File.open(path, mode)
|
|
end
|
|
end
|
|
end
|
|
# public :open
|
|
|
|
#
|
|
# CommandProcessor#unlink(path)
|
|
# same as:
|
|
# Dir#unlink (when path is directory)
|
|
# File#unlink (when path is file)
|
|
#
|
|
def unlink(path)
|
|
path = expand_path(path)
|
|
if File.directory?(path)
|
|
Dir.unlink(path)
|
|
else
|
|
IO.unlink(path)
|
|
end
|
|
end
|
|
|
|
#
|
|
# CommandProcessor#test(command, file1, file2)
|
|
# CommandProcessor#[command, file1, file2]
|
|
# command: char or String or Symbol
|
|
# file1: String
|
|
# file2: String(optional)
|
|
# return: Boolean
|
|
# same as:
|
|
# test() (when command is char or length 1 string or sumbol)
|
|
# FileTest.command (others)
|
|
# example:
|
|
# sh[?e, "foo"]
|
|
# sh[:e, "foo"]
|
|
# sh["e", "foo"]
|
|
# sh[:exists?, "foo"]
|
|
# sh["exists?", "foo"]
|
|
#
|
|
def test(command, file1, file2=nil)
|
|
file1 = expand_path(file1)
|
|
file2 = expand_path(file2) if file2
|
|
command = command.id2name if command.kind_of?(Symbol)
|
|
|
|
case command
|
|
when Integer
|
|
top_level_test(command, file1, file2)
|
|
when String
|
|
if command.size == 1
|
|
if file2
|
|
top_level_test(command, file1, file2)
|
|
else
|
|
top_level_test(command, file1)
|
|
end
|
|
else
|
|
if file2
|
|
FileTest.send(command, file1, file2)
|
|
else
|
|
FileTest.send(command, file1)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
alias [] test
|
|
|
|
#
|
|
# Dir related methods
|
|
#
|
|
# Shell#mkdir
|
|
# Shell#rmdir
|
|
#
|
|
#--
|
|
#
|
|
# CommandProcessor#mkdir(*path)
|
|
# path: String
|
|
# same as Dir.mkdir()
|
|
#
|
|
def mkdir(*path)
|
|
for dir in path
|
|
Dir.mkdir(expand_path(dir))
|
|
end
|
|
end
|
|
|
|
#
|
|
# CommandProcessor#rmdir(*path)
|
|
# path: String
|
|
# same as Dir.rmdir()
|
|
#
|
|
def rmdir(*path)
|
|
for dir in path
|
|
Dir.rmdir(expand_path(path))
|
|
end
|
|
end
|
|
|
|
#
|
|
# CommandProcessor#system(command, *opts)
|
|
# command: String
|
|
# opts: String
|
|
# retuen: SystemCommand
|
|
# Same as system() function
|
|
# example:
|
|
# print sh.system("ls", "-l")
|
|
# sh.system("ls", "-l") | sh.head > STDOUT
|
|
#
|
|
def system(command, *opts)
|
|
SystemCommand.new(@shell, find_system_command(command), *opts)
|
|
end
|
|
|
|
#
|
|
# ProcessCommand#rehash
|
|
# clear command hash table.
|
|
#
|
|
def rehash
|
|
@system_commands = {}
|
|
end
|
|
|
|
#
|
|
# ProcessCommand#transact
|
|
#
|
|
def check_point
|
|
@shell.process_controller.wait_all_jobs_execution
|
|
end
|
|
alias finish_all_jobs check_point
|
|
|
|
def transact(&block)
|
|
begin
|
|
@shell.instance_eval(&block)
|
|
ensure
|
|
check_point
|
|
end
|
|
end
|
|
|
|
#
|
|
# internal commands
|
|
#
|
|
def out(dev = STDOUT, &block)
|
|
dev.print transact(&block)
|
|
end
|
|
|
|
def echo(*strings)
|
|
Echo.new(@shell, *strings)
|
|
end
|
|
|
|
def cat(*filenames)
|
|
Cat.new(@shell, *filenames)
|
|
end
|
|
|
|
# def sort(*filenames)
|
|
# Sort.new(self, *filenames)
|
|
# end
|
|
|
|
def glob(pattern)
|
|
Glob.new(@shell, pattern)
|
|
end
|
|
|
|
def append(to, filter)
|
|
case to
|
|
when String
|
|
AppendFile.new(@shell, to, filter)
|
|
when IO
|
|
AppendIO.new(@shell, to, filter)
|
|
else
|
|
Shell.Fail CanNotMethodApply, "append", to.class
|
|
end
|
|
end
|
|
|
|
def tee(file)
|
|
Tee.new(@shell, file)
|
|
end
|
|
|
|
def concat(*jobs)
|
|
Concat.new(@shell, *jobs)
|
|
end
|
|
|
|
# %pwd, %cwd -> @pwd
|
|
def notify(*opts, &block)
|
|
Thread.exclusive do
|
|
Shell.notify(*opts) {|mes|
|
|
yield mes if iterator?
|
|
|
|
mes.gsub!("%pwd", "#{@cwd}")
|
|
mes.gsub!("%cwd", "#{@cwd}")
|
|
}
|
|
end
|
|
end
|
|
|
|
#
|
|
# private functions
|
|
#
|
|
def effect_umask
|
|
if @shell.umask
|
|
Thread.critical = true
|
|
save = File.umask
|
|
begin
|
|
yield
|
|
ensure
|
|
File.umask save
|
|
Thread.critical = false
|
|
end
|
|
else
|
|
yield
|
|
end
|
|
end
|
|
private :effect_umask
|
|
|
|
def find_system_command(command)
|
|
return command if /^\// =~ command
|
|
case path = @system_commands[command]
|
|
when String
|
|
if exists?(path)
|
|
return path
|
|
else
|
|
Shell.Fail CommandNotFound, command
|
|
end
|
|
when false
|
|
Shell.Fail CommandNotFound, command
|
|
end
|
|
|
|
for p in @shell.system_path
|
|
path = join(p, command)
|
|
if FileTest.exists?(path)
|
|
@system_commands[command] = path
|
|
return path
|
|
end
|
|
end
|
|
@system_commands[command] = false
|
|
Shell.Fail CommandNotFound, command
|
|
end
|
|
|
|
#
|
|
# CommandProcessor.def_system_command(command, path)
|
|
# command: String
|
|
# path: String
|
|
# define 'command()' method as method.
|
|
#
|
|
def self.def_system_command(command, path = command)
|
|
begin
|
|
eval((d = %Q[def #{command}(*opts)
|
|
SystemCommand.new(@shell, '#{path}', *opts)
|
|
end]), nil, __FILE__, __LINE__ - 1)
|
|
rescue SyntaxError
|
|
Shell.notify "warn: Can't define #{command} path: #{path}."
|
|
end
|
|
Shell.notify "Define #{command} path: #{path}.", Shell.debug?
|
|
Shell.notify("Definition of #{command}: ", d,
|
|
Shell.debug.kind_of?(Integer) && Shell.debug > 1)
|
|
end
|
|
|
|
def self.undef_system_command(command)
|
|
command = command.id2name if command.kind_of?(Symbol)
|
|
remove_method(command)
|
|
Shell.module_eval{remove_method(command)}
|
|
Filter.module_eval{remove_method(command)}
|
|
self
|
|
end
|
|
|
|
# define command alias
|
|
# ex)
|
|
# def_alias_command("ls_c", "ls", "-C", "-F")
|
|
# def_alias_command("ls_c", "ls"){|*opts| ["-C", "-F", *opts]}
|
|
#
|
|
@alias_map = {}
|
|
def self.alias_map
|
|
@alias_map
|
|
end
|
|
def self.alias_command(ali, command, *opts, &block)
|
|
ali = ali.id2name if ali.kind_of?(Symbol)
|
|
command = command.id2name if command.kind_of?(Symbol)
|
|
begin
|
|
if iterator?
|
|
@alias_map[ali.intern] = proc
|
|
|
|
eval((d = %Q[def #{ali}(*opts)
|
|
@shell.__send__(:#{command},
|
|
*(CommandProcessor.alias_map[:#{ali}].call *opts))
|
|
end]), nil, __FILE__, __LINE__ - 1)
|
|
|
|
else
|
|
args = opts.collect{|opt| '"' + opt + '"'}.join ","
|
|
eval((d = %Q[def #{ali}(*opts)
|
|
@shell.__send__(:#{command}, #{args}, *opts)
|
|
end]), nil, __FILE__, __LINE__ - 1)
|
|
end
|
|
rescue SyntaxError
|
|
Shell.notify "warn: Can't alias #{ali} command: #{command}."
|
|
Shell.notify("Definition of #{ali}: ", d)
|
|
raise
|
|
end
|
|
Shell.notify "Define #{ali} command: #{command}.", Shell.debug?
|
|
Shell.notify("Definition of #{ali}: ", d,
|
|
Shell.debug.kind_of?(Integer) && Shell.debug > 1)
|
|
self
|
|
end
|
|
|
|
def self.unalias_command(ali)
|
|
ali = ali.id2name if ali.kind_of?(Symbol)
|
|
@alias_map.delete ali.intern
|
|
undef_system_command(ali)
|
|
end
|
|
|
|
#
|
|
# CommandProcessor.def_builtin_commands(delegation_class, command_specs)
|
|
# delegation_class: Class or Module
|
|
# command_specs: [[command_name, [argument,...]],...]
|
|
# command_name: String
|
|
# arguments: String
|
|
# FILENAME?? -> expand_path(filename??)
|
|
# *FILENAME?? -> filename??.collect{|f|expand_path(f)}.join(", ")
|
|
# define command_name(argument,...) as
|
|
# delegation_class.command_name(argument,...)
|
|
#
|
|
def self.def_builtin_commands(delegation_class, command_specs)
|
|
for meth, args in command_specs
|
|
arg_str = args.collect{|arg| arg.downcase}.join(", ")
|
|
call_arg_str = args.collect{
|
|
|arg|
|
|
case arg
|
|
when /^(FILENAME.*)$/
|
|
format("expand_path(%s)", $1.downcase)
|
|
when /^(\*FILENAME.*)$/
|
|
# \*FILENAME* -> filenames.collect{|fn| expand_path(fn)}.join(", ")
|
|
$1.downcase + '.collect{|fn| expand_path(fn)}'
|
|
else
|
|
arg
|
|
end
|
|
}.join(", ")
|
|
d = %Q[def #{meth}(#{arg_str})
|
|
#{delegation_class}.#{meth}(#{call_arg_str})
|
|
end]
|
|
Shell.notify "Define #{meth}(#{arg_str})", Shell.debug?
|
|
Shell.notify("Definition of #{meth}: ", d,
|
|
Shell.debug.kind_of?(Integer) && Shell.debug > 1)
|
|
eval d
|
|
end
|
|
end
|
|
|
|
#
|
|
# CommandProcessor.install_system_commands(pre)
|
|
# pre: String - command name prefix
|
|
# defines every command which belongs in default_system_path via
|
|
# CommandProcessor.command(). It doesn't define already defined
|
|
# methods twice. By default, "pre_" is prefixes to each method
|
|
# name. Characters that may not be used in a method name are
|
|
# all converted to '_'. Definition errors are just ignored.
|
|
#
|
|
def self.install_system_commands(pre = "sys_")
|
|
defined_meth = {}
|
|
for m in Shell.methods
|
|
defined_meth[m] = true
|
|
end
|
|
sh = Shell.new
|
|
for path in Shell.default_system_path
|
|
next unless sh.directory? path
|
|
sh.cd path
|
|
sh.foreach do
|
|
|cn|
|
|
if !defined_meth[pre + cn] && sh.file?(cn) && sh.executable?(cn)
|
|
command = (pre + cn).gsub(/\W/, "_").sub(/^([0-9])/, '_\1')
|
|
begin
|
|
def_system_command(command, sh.expand_path(cn))
|
|
rescue
|
|
Shell.notify "warn: Can't define #{command} path: #{cn}"
|
|
end
|
|
defined_meth[command] = command
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
#----------------------------------------------------------------------
|
|
#
|
|
# class initializing methods -
|
|
#
|
|
#----------------------------------------------------------------------
|
|
def self.add_delegate_command_to_shell(id)
|
|
id = id.intern if id.kind_of?(String)
|
|
name = id.id2name
|
|
if Shell.method_defined?(id)
|
|
Shell.notify "warn: override definnition of Shell##{name}."
|
|
Shell.notify "warn: alias Shell##{name} to Shell##{name}_org.\n"
|
|
Shell.module_eval "alias #{name}_org #{name}"
|
|
end
|
|
Shell.notify "method added: Shell##{name}.", Shell.debug?
|
|
Shell.module_eval(%Q[def #{name}(*args, &block)
|
|
begin
|
|
@command_processor.__send__(:#{name}, *args, &block)
|
|
rescue Exception
|
|
$@.delete_if{|s| /:in `__getobj__'$/ =~ s} #`
|
|
$@.delete_if{|s| /^\\(eval\\):/ =~ s}
|
|
raise
|
|
end
|
|
end], __FILE__, __LINE__)
|
|
|
|
if Shell::Filter.method_defined?(id)
|
|
Shell.notify "warn: override definnition of Shell::Filter##{name}."
|
|
Shell.notify "warn: alias Shell##{name} to Shell::Filter##{name}_org."
|
|
Filter.module_eval "alias #{name}_org #{name}"
|
|
end
|
|
Shell.notify "method added: Shell::Filter##{name}.", Shell.debug?
|
|
Filter.module_eval(%Q[def #{name}(*args, &block)
|
|
begin
|
|
self | @shell.__send__(:#{name}, *args, &block)
|
|
rescue Exception
|
|
$@.delete_if{|s| /:in `__getobj__'$/ =~ s} #`
|
|
$@.delete_if{|s| /^\\(eval\\):/ =~ s}
|
|
raise
|
|
end
|
|
end], __FILE__, __LINE__)
|
|
end
|
|
|
|
#
|
|
# define default builtin commands
|
|
#
|
|
def self.install_builtin_commands
|
|
# method related File.
|
|
# (exclude open/foreach/unlink)
|
|
normal_delegation_file_methods = [
|
|
["atime", ["FILENAME"]],
|
|
["basename", ["fn", "*opts"]],
|
|
["chmod", ["mode", "*FILENAMES"]],
|
|
["chown", ["owner", "group", "*FILENAME"]],
|
|
["ctime", ["FILENAMES"]],
|
|
["delete", ["*FILENAMES"]],
|
|
["dirname", ["FILENAME"]],
|
|
["ftype", ["FILENAME"]],
|
|
["join", ["*items"]],
|
|
["link", ["FILENAME_O", "FILENAME_N"]],
|
|
["lstat", ["FILENAME"]],
|
|
["mtime", ["FILENAME"]],
|
|
["readlink", ["FILENAME"]],
|
|
["rename", ["FILENAME_FROM", "FILENAME_TO"]],
|
|
# ["size", ["FILENAME"]],
|
|
["split", ["pathname"]],
|
|
["stat", ["FILENAME"]],
|
|
["symlink", ["FILENAME_O", "FILENAME_N"]],
|
|
["truncate", ["FILENAME", "length"]],
|
|
["utime", ["atime", "mtime", "*FILENAMES"]]]
|
|
|
|
def_builtin_commands(File, normal_delegation_file_methods)
|
|
alias_method :rm, :delete
|
|
|
|
# method related FileTest
|
|
def_builtin_commands(FileTest,
|
|
FileTest.singleton_methods.collect{|m| [m, ["FILENAME"]]})
|
|
|
|
# method related ftools
|
|
normal_delegation_ftools_methods = [
|
|
["syscopy", ["FILENAME_FROM", "FILENAME_TO"]],
|
|
["copy", ["FILENAME_FROM", "FILENAME_TO"]],
|
|
["move", ["FILENAME_FROM", "FILENAME_TO"]],
|
|
["compare", ["FILENAME_FROM", "FILENAME_TO"]],
|
|
["safe_unlink", ["*FILENAMES"]],
|
|
["makedirs", ["*FILENAMES"]],
|
|
# ["chmod", ["mode", "*FILENAMES"]],
|
|
["install", ["FILENAME_FROM", "FILENAME_TO", "mode"]],
|
|
]
|
|
def_builtin_commands(File,
|
|
normal_delegation_ftools_methods)
|
|
alias_method :cmp, :compare
|
|
alias_method :mv, :move
|
|
alias_method :cp, :copy
|
|
alias_method :rm_f, :safe_unlink
|
|
alias_method :mkpath, :makedirs
|
|
end
|
|
|
|
end
|
|
end
|