capistrano-edge 2.5.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) hide show
  1. data/CHANGELOG.rdoc +770 -0
  2. data/Manifest +104 -0
  3. data/README.rdoc +66 -0
  4. data/Rakefile +35 -0
  5. data/bin/cap +4 -0
  6. data/bin/capify +95 -0
  7. data/capistrano.gemspec +51 -0
  8. data/examples/sample.rb +14 -0
  9. data/lib/capistrano.rb +2 -0
  10. data/lib/capistrano/callback.rb +45 -0
  11. data/lib/capistrano/cli.rb +47 -0
  12. data/lib/capistrano/cli/execute.rb +84 -0
  13. data/lib/capistrano/cli/help.rb +125 -0
  14. data/lib/capistrano/cli/help.txt +75 -0
  15. data/lib/capistrano/cli/options.rb +224 -0
  16. data/lib/capistrano/cli/ui.rb +40 -0
  17. data/lib/capistrano/command.rb +283 -0
  18. data/lib/capistrano/configuration.rb +43 -0
  19. data/lib/capistrano/configuration/actions/file_transfer.rb +47 -0
  20. data/lib/capistrano/configuration/actions/inspect.rb +46 -0
  21. data/lib/capistrano/configuration/actions/invocation.rb +293 -0
  22. data/lib/capistrano/configuration/callbacks.rb +148 -0
  23. data/lib/capistrano/configuration/connections.rb +204 -0
  24. data/lib/capistrano/configuration/execution.rb +143 -0
  25. data/lib/capistrano/configuration/loading.rb +197 -0
  26. data/lib/capistrano/configuration/namespaces.rb +197 -0
  27. data/lib/capistrano/configuration/roles.rb +73 -0
  28. data/lib/capistrano/configuration/servers.rb +85 -0
  29. data/lib/capistrano/configuration/variables.rb +127 -0
  30. data/lib/capistrano/errors.rb +15 -0
  31. data/lib/capistrano/extensions.rb +57 -0
  32. data/lib/capistrano/logger.rb +59 -0
  33. data/lib/capistrano/processable.rb +53 -0
  34. data/lib/capistrano/recipes/compat.rb +32 -0
  35. data/lib/capistrano/recipes/deploy.rb +438 -0
  36. data/lib/capistrano/recipes/deploy/dependencies.rb +44 -0
  37. data/lib/capistrano/recipes/deploy/local_dependency.rb +54 -0
  38. data/lib/capistrano/recipes/deploy/remote_dependency.rb +105 -0
  39. data/lib/capistrano/recipes/deploy/scm.rb +19 -0
  40. data/lib/capistrano/recipes/deploy/scm/accurev.rb +169 -0
  41. data/lib/capistrano/recipes/deploy/scm/base.rb +196 -0
  42. data/lib/capistrano/recipes/deploy/scm/bzr.rb +83 -0
  43. data/lib/capistrano/recipes/deploy/scm/cvs.rb +152 -0
  44. data/lib/capistrano/recipes/deploy/scm/darcs.rb +85 -0
  45. data/lib/capistrano/recipes/deploy/scm/git.rb +274 -0
  46. data/lib/capistrano/recipes/deploy/scm/mercurial.rb +137 -0
  47. data/lib/capistrano/recipes/deploy/scm/none.rb +44 -0
  48. data/lib/capistrano/recipes/deploy/scm/perforce.rb +138 -0
  49. data/lib/capistrano/recipes/deploy/scm/subversion.rb +121 -0
  50. data/lib/capistrano/recipes/deploy/strategy.rb +19 -0
  51. data/lib/capistrano/recipes/deploy/strategy/base.rb +79 -0
  52. data/lib/capistrano/recipes/deploy/strategy/checkout.rb +20 -0
  53. data/lib/capistrano/recipes/deploy/strategy/copy.rb +210 -0
  54. data/lib/capistrano/recipes/deploy/strategy/export.rb +20 -0
  55. data/lib/capistrano/recipes/deploy/strategy/remote.rb +52 -0
  56. data/lib/capistrano/recipes/deploy/strategy/remote_cache.rb +56 -0
  57. data/lib/capistrano/recipes/deploy/templates/maintenance.rhtml +53 -0
  58. data/lib/capistrano/recipes/ext/rails-database-migrations.rb +50 -0
  59. data/lib/capistrano/recipes/ext/web-disable-enable.rb +40 -0
  60. data/lib/capistrano/recipes/standard.rb +37 -0
  61. data/lib/capistrano/recipes/templates/maintenance.rhtml +53 -0
  62. data/lib/capistrano/recipes/upgrade.rb +33 -0
  63. data/lib/capistrano/role.rb +102 -0
  64. data/lib/capistrano/server_definition.rb +56 -0
  65. data/lib/capistrano/shell.rb +260 -0
  66. data/lib/capistrano/ssh.rb +99 -0
  67. data/lib/capistrano/task_definition.rb +70 -0
  68. data/lib/capistrano/transfer.rb +216 -0
  69. data/lib/capistrano/version.rb +18 -0
  70. data/setup.rb +1346 -0
  71. data/test/cli/execute_test.rb +132 -0
  72. data/test/cli/help_test.rb +165 -0
  73. data/test/cli/options_test.rb +317 -0
  74. data/test/cli/ui_test.rb +28 -0
  75. data/test/cli_test.rb +17 -0
  76. data/test/command_test.rb +286 -0
  77. data/test/configuration/actions/file_transfer_test.rb +61 -0
  78. data/test/configuration/actions/inspect_test.rb +65 -0
  79. data/test/configuration/actions/invocation_test.rb +224 -0
  80. data/test/configuration/callbacks_test.rb +220 -0
  81. data/test/configuration/connections_test.rb +349 -0
  82. data/test/configuration/execution_test.rb +175 -0
  83. data/test/configuration/loading_test.rb +132 -0
  84. data/test/configuration/namespace_dsl_test.rb +311 -0
  85. data/test/configuration/roles_test.rb +144 -0
  86. data/test/configuration/servers_test.rb +121 -0
  87. data/test/configuration/variables_test.rb +184 -0
  88. data/test/configuration_test.rb +88 -0
  89. data/test/deploy/local_dependency_test.rb +76 -0
  90. data/test/deploy/remote_dependency_test.rb +114 -0
  91. data/test/deploy/scm/accurev_test.rb +23 -0
  92. data/test/deploy/scm/base_test.rb +55 -0
  93. data/test/deploy/scm/git_test.rb +184 -0
  94. data/test/deploy/scm/mercurial_test.rb +129 -0
  95. data/test/deploy/scm/none_test.rb +35 -0
  96. data/test/deploy/strategy/copy_test.rb +258 -0
  97. data/test/extensions_test.rb +69 -0
  98. data/test/fixtures/cli_integration.rb +5 -0
  99. data/test/fixtures/config.rb +5 -0
  100. data/test/fixtures/custom.rb +3 -0
  101. data/test/logger_test.rb +123 -0
  102. data/test/role_test.rb +11 -0
  103. data/test/server_definition_test.rb +121 -0
  104. data/test/shell_test.rb +90 -0
  105. data/test/ssh_test.rb +104 -0
  106. data/test/task_definition_test.rb +101 -0
  107. data/test/transfer_test.rb +160 -0
  108. data/test/utils.rb +38 -0
  109. metadata +321 -0
@@ -0,0 +1,99 @@
1
+ begin
2
+ require 'rubygems'
3
+ gem 'net-ssh', ">= 2.0.10"
4
+ rescue LoadError, NameError
5
+ end
6
+
7
+ require 'net/ssh'
8
+
9
+ module Capistrano
10
+ # A helper class for dealing with SSH connections.
11
+ class SSH
12
+ # Patch an accessor onto an SSH connection so that we can record the server
13
+ # definition object that defines the connection. This is useful because
14
+ # the gateway returns connections whose "host" is 127.0.0.1, instead of
15
+ # the host on the other side of the tunnel.
16
+ module Server #:nodoc:
17
+ def self.apply_to(connection, server)
18
+ connection.extend(Server)
19
+ connection.xserver = server
20
+ connection
21
+ end
22
+
23
+ attr_accessor :xserver
24
+ end
25
+
26
+ # An abstraction to make it possible to connect to the server via public key
27
+ # without prompting for the password. If the public key authentication fails
28
+ # this will fall back to password authentication.
29
+ #
30
+ # +server+ must be an instance of ServerDefinition.
31
+ #
32
+ # If a block is given, the new session is yielded to it, otherwise the new
33
+ # session is returned.
34
+ #
35
+ # If an :ssh_options key exists in +options+, it is passed to the Net::SSH
36
+ # constructor. Values in +options+ are then merged into it, and any
37
+ # connection information in +server+ is added last, so that +server+ info
38
+ # takes precedence over +options+, which takes precendence over ssh_options.
39
+ def self.connect(server, options={})
40
+ connection_strategy(server, options) do |host, user, connection_options|
41
+ connection = Net::SSH.start(host, user, connection_options)
42
+ Server.apply_to(connection, server)
43
+ end
44
+ end
45
+
46
+ # Abstracts the logic for establishing an SSH connection (which includes
47
+ # testing for connection failures and retrying with a password, and so forth,
48
+ # mostly made complicated because of the fact that some of these variables
49
+ # might be lazily evaluated and try to do something like prompt the user,
50
+ # which should only happen when absolutely necessary.
51
+ #
52
+ # This will yield the hostname, username, and a hash of connection options
53
+ # to the given block, which should return a new connection.
54
+ def self.connection_strategy(server, options={}, &block)
55
+ methods = [ %w(publickey hostbased), %w(password keyboard-interactive) ]
56
+ password_value = nil
57
+
58
+ # construct the hash of ssh options that should be passed more-or-less
59
+ # directly to Net::SSH. This will be the general ssh options, merged with
60
+ # the server-specific ssh-options.
61
+ ssh_options = (options[:ssh_options] || {}).merge(server.options[:ssh_options] || {})
62
+
63
+ # load any SSH configuration files that were specified in the SSH options. This
64
+ # will load from ~/.ssh/config and /etc/ssh_config by default (see Net::SSH
65
+ # for details). Merge the explicitly given ssh_options over the top of the info
66
+ # from the config file.
67
+ ssh_options = Net::SSH.configuration_for(server.host, ssh_options.fetch(:config, true)).merge(ssh_options)
68
+
69
+ # Once we've loaded the config, we don't need Net::SSH to do it again.
70
+ ssh_options[:config] = false
71
+
72
+ user = server.user || options[:user] || ssh_options[:username] ||
73
+ ssh_options[:user] || ServerDefinition.default_user
74
+ port = server.port || options[:port] || ssh_options[:port]
75
+
76
+ # the .ssh/config file might have changed the host-name on us
77
+ host = ssh_options.fetch(:host_name, server.host)
78
+
79
+ ssh_options[:port] = port if port
80
+
81
+ # delete these, since we've determined which username to use by this point
82
+ ssh_options.delete(:username)
83
+ ssh_options.delete(:user)
84
+
85
+ begin
86
+ connection_options = ssh_options.merge(
87
+ :password => password_value,
88
+ :auth_methods => ssh_options[:auth_methods] || methods.shift
89
+ )
90
+
91
+ yield host, user, connection_options
92
+ rescue Net::SSH::AuthenticationFailed
93
+ raise if methods.empty? || ssh_options[:auth_methods]
94
+ password_value = options[:password]
95
+ retry
96
+ end
97
+ end
98
+ end
99
+ end
@@ -0,0 +1,70 @@
1
+ require 'capistrano/server_definition'
2
+
3
+ module Capistrano
4
+ # Represents the definition of a single task.
5
+ class TaskDefinition
6
+ attr_reader :name, :namespace, :options, :body, :desc, :on_error, :max_hosts
7
+
8
+ def initialize(name, namespace, options={}, &block)
9
+ @name, @namespace, @options = name, namespace, options
10
+ @desc = @options.delete(:desc)
11
+ @on_error = options.delete(:on_error)
12
+ @max_hosts = options[:max_hosts] && options[:max_hosts].to_i
13
+ @body = block or raise ArgumentError, "a task requires a block"
14
+ @servers = nil
15
+ end
16
+
17
+ # Returns the task's fully-qualified name, including the namespace
18
+ def fully_qualified_name
19
+ @fully_qualified_name ||= begin
20
+ if namespace.default_task == self
21
+ namespace.fully_qualified_name
22
+ else
23
+ [namespace.fully_qualified_name, name].compact.join(":")
24
+ end
25
+ end
26
+ end
27
+
28
+ # Returns the description for this task, with newlines collapsed and
29
+ # whitespace stripped. Returns the empty string if there is no
30
+ # description for this task.
31
+ def description(rebuild=false)
32
+ @description = nil if rebuild
33
+ @description ||= begin
34
+ description = @desc || ""
35
+
36
+ indentation = description[/\A\s+/]
37
+ if indentation
38
+ reformatted_description = ""
39
+ description.strip.each_line do |line|
40
+ line = line.chomp.sub(/^#{indentation}/, "")
41
+ line = line.gsub(/#{indentation}\s*/, " ") if line[/^\S/]
42
+ reformatted_description << line << "\n"
43
+ end
44
+ description = reformatted_description
45
+ end
46
+
47
+ description.strip.gsub(/\r\n/, "\n")
48
+ end
49
+ end
50
+
51
+ # Returns the first sentence of the full description. If +max_length+ is
52
+ # given, the result will be truncated if it is longer than +max_length+,
53
+ # and an ellipsis appended.
54
+ def brief_description(max_length=nil)
55
+ brief = description[/^.*?\.(?=\s|$)/] || description
56
+
57
+ if max_length && brief.length > max_length
58
+ brief = brief[0,max_length-3] + "..."
59
+ end
60
+
61
+ brief
62
+ end
63
+
64
+ # Indicates whether the task wants to continue, even if a server has failed
65
+ # previously
66
+ def continue_on_error?
67
+ @on_error == :continue
68
+ end
69
+ end
70
+ end
@@ -0,0 +1,216 @@
1
+ require 'net/scp'
2
+ require 'net/sftp'
3
+
4
+ require 'capistrano/processable'
5
+
6
+ module Capistrano
7
+ class Transfer
8
+ include Processable
9
+
10
+ def self.process(direction, from, to, sessions, options={}, &block)
11
+ new(direction, from, to, sessions, options, &block).process!
12
+ end
13
+
14
+ attr_reader :sessions
15
+ attr_reader :options
16
+ attr_reader :callback
17
+
18
+ attr_reader :transport
19
+ attr_reader :direction
20
+ attr_reader :from
21
+ attr_reader :to
22
+
23
+ attr_reader :logger
24
+ attr_reader :transfers
25
+
26
+ def initialize(direction, from, to, sessions, options={}, &block)
27
+ @direction = direction
28
+ @from = from
29
+ @to = to
30
+ @sessions = sessions
31
+ @options = options
32
+ @callback = block
33
+
34
+ @transport = options.fetch(:via, :sftp)
35
+ @logger = options.delete(:logger)
36
+
37
+ @session_map = {}
38
+
39
+ prepare_transfers
40
+ end
41
+
42
+ def process!
43
+ loop do
44
+ begin
45
+ break unless process_iteration { active? }
46
+ rescue Exception => error
47
+ if error.respond_to?(:session)
48
+ handle_error(error)
49
+ else
50
+ raise
51
+ end
52
+ end
53
+ end
54
+
55
+ failed = transfers.select { |txfr| txfr[:failed] }
56
+ if failed.any?
57
+ hosts = failed.map { |txfr| txfr[:server] }
58
+ errors = failed.map { |txfr| "#{txfr[:error]} (#{txfr[:error].message})" }.uniq.join(", ")
59
+ error = TransferError.new("#{operation} via #{transport} failed on #{hosts.join(',')}: #{errors}")
60
+ error.hosts = hosts
61
+
62
+ logger.important(error.message) if logger
63
+ raise error
64
+ end
65
+
66
+ logger.debug "#{transport} #{operation} complete" if logger
67
+ self
68
+ end
69
+
70
+ def active?
71
+ transfers.any? { |transfer| transfer.active? }
72
+ end
73
+
74
+ def operation
75
+ "#{direction}load"
76
+ end
77
+
78
+ def sanitized_from
79
+ if from.responds_to?(:read)
80
+ "#<#{from.class}>"
81
+ else
82
+ from
83
+ end
84
+ end
85
+
86
+ def sanitized_to
87
+ if to.responds_to?(:read)
88
+ "#<#{to.class}>"
89
+ else
90
+ to
91
+ end
92
+ end
93
+
94
+ private
95
+
96
+ def session_map
97
+ @session_map
98
+ end
99
+
100
+ def prepare_transfers
101
+ logger.info "#{transport} #{operation} #{from} -> #{to}" if logger
102
+
103
+ @transfers = sessions.map do |session|
104
+ session_from = normalize(from, session)
105
+ session_to = normalize(to, session)
106
+
107
+ session_map[session] = case transport
108
+ when :sftp
109
+ prepare_sftp_transfer(session_from, session_to, session)
110
+ when :scp
111
+ prepare_scp_transfer(session_from, session_to, session)
112
+ else
113
+ raise ArgumentError, "unsupported transport type: #{transport.inspect}"
114
+ end
115
+ end
116
+ end
117
+
118
+ def prepare_scp_transfer(from, to, session)
119
+ real_callback = callback || Proc.new do |channel, name, sent, total|
120
+ logger.trace "[#{channel[:host]}] #{name}" if logger && sent == 0
121
+ end
122
+
123
+ channel = case direction
124
+ when :up
125
+ session.scp.upload(from, to, options, &real_callback)
126
+ when :down
127
+ session.scp.download(from, to, options, &real_callback)
128
+ else
129
+ raise ArgumentError, "unsupported transfer direction: #{direction.inspect}"
130
+ end
131
+
132
+ channel[:server] = session.xserver
133
+ channel[:host] = session.xserver.host
134
+
135
+ return channel
136
+ end
137
+
138
+ class SFTPTransferWrapper
139
+ attr_reader :operation
140
+
141
+ def initialize(session, &callback)
142
+ session.sftp(false).connect do |sftp|
143
+ @operation = callback.call(sftp)
144
+ end
145
+ end
146
+
147
+ def active?
148
+ @operation.nil? || @operation.active?
149
+ end
150
+
151
+ def [](key)
152
+ @operation[key]
153
+ end
154
+
155
+ def []=(key, value)
156
+ @operation[key] = value
157
+ end
158
+
159
+ def abort!
160
+ @operation.abort!
161
+ end
162
+ end
163
+
164
+ def prepare_sftp_transfer(from, to, session)
165
+ SFTPTransferWrapper.new(session) do |sftp|
166
+ real_callback = Proc.new do |event, op, *args|
167
+ if callback
168
+ callback.call(event, op, *args)
169
+ elsif event == :open
170
+ logger.trace "[#{op[:host]}] #{args[0].remote}"
171
+ elsif event == :finish
172
+ logger.trace "[#{op[:host]}] done"
173
+ end
174
+ end
175
+
176
+ opts = options.dup
177
+ opts[:properties] = (opts[:properties] || {}).merge(
178
+ :server => session.xserver,
179
+ :host => session.xserver.host)
180
+
181
+ case direction
182
+ when :up
183
+ sftp.upload(from, to, opts, &real_callback)
184
+ when :down
185
+ sftp.download(from, to, opts, &real_callback)
186
+ else
187
+ raise ArgumentError, "unsupported transfer direction: #{direction.inspect}"
188
+ end
189
+ end
190
+ end
191
+
192
+ def normalize(argument, session)
193
+ if argument.is_a?(String)
194
+ argument.gsub(/\$CAPISTRANO:HOST\$/, session.xserver.host)
195
+ elsif argument.respond_to?(:read)
196
+ pos = argument.pos
197
+ clone = StringIO.new(argument.read)
198
+ clone.pos = argument.pos = pos
199
+ clone
200
+ else
201
+ argument
202
+ end
203
+ end
204
+
205
+ def handle_error(error)
206
+ transfer = session_map[error.session]
207
+ transfer[:error] = error
208
+ transfer[:failed] = true
209
+
210
+ case transport
211
+ when :sftp then transfer.abort!
212
+ when :scp then transfer.close
213
+ end
214
+ end
215
+ end
216
+ end
@@ -0,0 +1,18 @@
1
+ require 'net/ssh/version'
2
+
3
+ module Capistrano
4
+
5
+ # Describes the current version of Capistrano.
6
+ class Version < Net::SSH::Version
7
+ MAJOR = 2
8
+ MINOR = 5
9
+ TINY = 5
10
+
11
+ # The current version, as a Version instance
12
+ CURRENT = new(MAJOR, MINOR, TINY)
13
+
14
+ # The current version, as a String instance
15
+ STRING = CURRENT.to_s
16
+ end
17
+
18
+ end
@@ -0,0 +1,1346 @@
1
+ #
2
+ # setup.rb
3
+ #
4
+ # Copyright (c) 2000-2004 Minero Aoki
5
+ #
6
+ # This program is free software.
7
+ # You can distribute/modify this program under the terms of
8
+ # the GNU Lesser General Public License version 2.1.
9
+ #
10
+
11
+ #
12
+ # For backward compatibility
13
+ #
14
+
15
+ unless Enumerable.method_defined?(:map)
16
+ module Enumerable
17
+ alias map collect
18
+ end
19
+ end
20
+
21
+ unless Enumerable.method_defined?(:detect)
22
+ module Enumerable
23
+ alias detect find
24
+ end
25
+ end
26
+
27
+ unless Enumerable.method_defined?(:select)
28
+ module Enumerable
29
+ alias select find_all
30
+ end
31
+ end
32
+
33
+ unless Enumerable.method_defined?(:reject)
34
+ module Enumerable
35
+ def reject
36
+ result = []
37
+ each do |i|
38
+ result.push i unless yield(i)
39
+ end
40
+ result
41
+ end
42
+ end
43
+ end
44
+
45
+ unless Enumerable.method_defined?(:inject)
46
+ module Enumerable
47
+ def inject(result)
48
+ each do |i|
49
+ result = yield(result, i)
50
+ end
51
+ result
52
+ end
53
+ end
54
+ end
55
+
56
+ unless Enumerable.method_defined?(:any?)
57
+ module Enumerable
58
+ def any?
59
+ each do |i|
60
+ return true if yield(i)
61
+ end
62
+ false
63
+ end
64
+ end
65
+ end
66
+
67
+ unless File.respond_to?(:read)
68
+ def File.read(fname)
69
+ open(fname) {|f|
70
+ return f.read
71
+ }
72
+ end
73
+ end
74
+
75
+ #
76
+ # Application independent utilities
77
+ #
78
+
79
+ def File.binread(fname)
80
+ open(fname, 'rb') {|f|
81
+ return f.read
82
+ }
83
+ end
84
+
85
+ # for corrupted windows stat(2)
86
+ def File.dir?(path)
87
+ File.directory?((path[-1,1] == '/') ? path : path + '/')
88
+ end
89
+
90
+ #
91
+ # Config
92
+ #
93
+
94
+ if arg = ARGV.detect{|arg| /\A--rbconfig=/ =~ arg }
95
+ ARGV.delete(arg)
96
+ require arg.split(/=/, 2)[1]
97
+ $".push 'rbconfig.rb'
98
+ else
99
+ require 'rbconfig'
100
+ end
101
+
102
+ def multipackage_install?
103
+ FileTest.directory?(File.dirname($0) + '/packages')
104
+ end
105
+
106
+
107
+ class ConfigTable
108
+
109
+ c = ::Config::CONFIG
110
+
111
+ rubypath = c['bindir'] + '/' + c['ruby_install_name']
112
+
113
+ major = c['MAJOR'].to_i
114
+ minor = c['MINOR'].to_i
115
+ teeny = c['TEENY'].to_i
116
+ version = "#{major}.#{minor}"
117
+
118
+ # ruby ver. >= 1.4.4?
119
+ newpath_p = ((major >= 2) or
120
+ ((major == 1) and
121
+ ((minor >= 5) or
122
+ ((minor == 4) and (teeny >= 4)))))
123
+
124
+ subprefix = lambda {|path|
125
+ path.sub(/\A#{Regexp.quote(c['prefix'])}/o, '$prefix')
126
+ }
127
+
128
+ if c['rubylibdir']
129
+ # V < 1.6.3
130
+ stdruby = subprefix.call(c['rubylibdir'])
131
+ siteruby = subprefix.call(c['sitedir'])
132
+ versite = subprefix.call(c['sitelibdir'])
133
+ sodir = subprefix.call(c['sitearchdir'])
134
+ elsif newpath_p
135
+ # 1.4.4 <= V <= 1.6.3
136
+ stdruby = "$prefix/lib/ruby/#{version}"
137
+ siteruby = subprefix.call(c['sitedir'])
138
+ versite = siteruby + '/' + version
139
+ sodir = "$site-ruby/#{c['arch']}"
140
+ else
141
+ # V < 1.4.4
142
+ stdruby = "$prefix/lib/ruby/#{version}"
143
+ siteruby = "$prefix/lib/ruby/#{version}/site_ruby"
144
+ versite = siteruby
145
+ sodir = "$site-ruby/#{c['arch']}"
146
+ end
147
+
148
+ if arg = c['configure_args'].split.detect {|arg| /--with-make-prog=/ =~ arg }
149
+ makeprog = arg.sub(/'/, '').split(/=/, 2)[1]
150
+ else
151
+ makeprog = 'make'
152
+ end
153
+
154
+ common_descripters = [
155
+ [ 'prefix', [ c['prefix'],
156
+ 'path',
157
+ 'path prefix of target environment' ] ],
158
+ [ 'std-ruby', [ stdruby,
159
+ 'path',
160
+ 'the directory for standard ruby libraries' ] ],
161
+ [ 'site-ruby-common', [ siteruby,
162
+ 'path',
163
+ 'the directory for version-independent non-standard ruby libraries' ] ],
164
+ [ 'site-ruby', [ versite,
165
+ 'path',
166
+ 'the directory for non-standard ruby libraries' ] ],
167
+ [ 'bin-dir', [ '$prefix/bin',
168
+ 'path',
169
+ 'the directory for commands' ] ],
170
+ [ 'rb-dir', [ '$site-ruby',
171
+ 'path',
172
+ 'the directory for ruby scripts' ] ],
173
+ [ 'so-dir', [ sodir,
174
+ 'path',
175
+ 'the directory for ruby extentions' ] ],
176
+ [ 'data-dir', [ '$prefix/share',
177
+ 'path',
178
+ 'the directory for shared data' ] ],
179
+ [ 'ruby-path', [ rubypath,
180
+ 'path',
181
+ 'path to set to #! line' ] ],
182
+ [ 'ruby-prog', [ rubypath,
183
+ 'name',
184
+ 'the ruby program using for installation' ] ],
185
+ [ 'make-prog', [ makeprog,
186
+ 'name',
187
+ 'the make program to compile ruby extentions' ] ],
188
+ [ 'without-ext', [ 'no',
189
+ 'yes/no',
190
+ 'does not compile/install ruby extentions' ] ]
191
+ ]
192
+ multipackage_descripters = [
193
+ [ 'with', [ '',
194
+ 'name,name...',
195
+ 'package names that you want to install',
196
+ 'ALL' ] ],
197
+ [ 'without', [ '',
198
+ 'name,name...',
199
+ 'package names that you do not want to install',
200
+ 'NONE' ] ]
201
+ ]
202
+ if multipackage_install?
203
+ DESCRIPTER = common_descripters + multipackage_descripters
204
+ else
205
+ DESCRIPTER = common_descripters
206
+ end
207
+
208
+ SAVE_FILE = 'config.save'
209
+
210
+ def ConfigTable.each_name(&block)
211
+ keys().each(&block)
212
+ end
213
+
214
+ def ConfigTable.keys
215
+ DESCRIPTER.map {|name, *dummy| name }
216
+ end
217
+
218
+ def ConfigTable.each_definition(&block)
219
+ DESCRIPTER.each(&block)
220
+ end
221
+
222
+ def ConfigTable.get_entry(name)
223
+ name, ent = DESCRIPTER.assoc(name)
224
+ ent
225
+ end
226
+
227
+ def ConfigTable.get_entry!(name)
228
+ get_entry(name) or raise ArgumentError, "no such config: #{name}"
229
+ end
230
+
231
+ def ConfigTable.add_entry(name, vals)
232
+ ConfigTable::DESCRIPTER.push [name,vals]
233
+ end
234
+
235
+ def ConfigTable.remove_entry(name)
236
+ get_entry(name) or raise ArgumentError, "no such config: #{name}"
237
+ DESCRIPTER.delete_if {|n, arr| n == name }
238
+ end
239
+
240
+ def ConfigTable.config_key?(name)
241
+ get_entry(name) ? true : false
242
+ end
243
+
244
+ def ConfigTable.bool_config?(name)
245
+ ent = get_entry(name) or return false
246
+ ent[1] == 'yes/no'
247
+ end
248
+
249
+ def ConfigTable.value_config?(name)
250
+ ent = get_entry(name) or return false
251
+ ent[1] != 'yes/no'
252
+ end
253
+
254
+ def ConfigTable.path_config?(name)
255
+ ent = get_entry(name) or return false
256
+ ent[1] == 'path'
257
+ end
258
+
259
+
260
+ class << self
261
+ alias newobj new
262
+ end
263
+
264
+ def ConfigTable.new
265
+ c = newobj()
266
+ c.initialize_from_table
267
+ c
268
+ end
269
+
270
+ def ConfigTable.load
271
+ c = newobj()
272
+ c.initialize_from_file
273
+ c
274
+ end
275
+
276
+ def initialize_from_table
277
+ @table = {}
278
+ DESCRIPTER.each do |k, (default, vname, desc, default2)|
279
+ @table[k] = default
280
+ end
281
+ end
282
+
283
+ def initialize_from_file
284
+ raise InstallError, "#{File.basename $0} config first"\
285
+ unless File.file?(SAVE_FILE)
286
+ @table = {}
287
+ File.foreach(SAVE_FILE) do |line|
288
+ k, v = line.split(/=/, 2)
289
+ @table[k] = v.strip
290
+ end
291
+ end
292
+
293
+ def save
294
+ File.open(SAVE_FILE, 'w') {|f|
295
+ @table.each do |k, v|
296
+ f.printf "%s=%s\n", k, v if v
297
+ end
298
+ }
299
+ end
300
+
301
+ def []=(k, v)
302
+ raise InstallError, "unknown config option #{k}"\
303
+ unless ConfigTable.config_key?(k)
304
+ @table[k] = v
305
+ end
306
+
307
+ def [](key)
308
+ return nil unless @table[key]
309
+ @table[key].gsub(%r<\$([^/]+)>) { self[$1] }
310
+ end
311
+
312
+ def set_raw(key, val)
313
+ @table[key] = val
314
+ end
315
+
316
+ def get_raw(key)
317
+ @table[key]
318
+ end
319
+
320
+ end
321
+
322
+
323
+ module MetaConfigAPI
324
+
325
+ def eval_file_ifexist(fname)
326
+ instance_eval File.read(fname), fname, 1 if File.file?(fname)
327
+ end
328
+
329
+ def config_names
330
+ ConfigTable.keys
331
+ end
332
+
333
+ def config?(name)
334
+ ConfigTable.config_key?(name)
335
+ end
336
+
337
+ def bool_config?(name)
338
+ ConfigTable.bool_config?(name)
339
+ end
340
+
341
+ def value_config?(name)
342
+ ConfigTable.value_config?(name)
343
+ end
344
+
345
+ def path_config?(name)
346
+ ConfigTable.path_config?(name)
347
+ end
348
+
349
+ def add_config(name, argname, default, desc)
350
+ ConfigTable.add_entry name,[default,argname,desc]
351
+ end
352
+
353
+ def add_path_config(name, default, desc)
354
+ add_config name, 'path', default, desc
355
+ end
356
+
357
+ def add_bool_config(name, default, desc)
358
+ add_config name, 'yes/no', default ? 'yes' : 'no', desc
359
+ end
360
+
361
+ def set_config_default(name, default)
362
+ if bool_config?(name)
363
+ ConfigTable.get_entry!(name)[0] = (default ? 'yes' : 'no')
364
+ else
365
+ ConfigTable.get_entry!(name)[0] = default
366
+ end
367
+ end
368
+
369
+ def remove_config(name)
370
+ ent = ConfigTable.get_entry(name)
371
+ ConfigTable.remove_entry name
372
+ ent
373
+ end
374
+
375
+ end
376
+
377
+ #
378
+ # File Operations
379
+ #
380
+
381
+ module FileOperations
382
+
383
+ def mkdir_p(dirname, prefix = nil)
384
+ dirname = prefix + dirname if prefix
385
+ $stderr.puts "mkdir -p #{dirname}" if verbose?
386
+ return if no_harm?
387
+
388
+ # does not check '/'... it's too abnormal case
389
+ dirs = dirname.split(%r<(?=/)>)
390
+ if /\A[a-z]:\z/i =~ dirs[0]
391
+ disk = dirs.shift
392
+ dirs[0] = disk + dirs[0]
393
+ end
394
+ dirs.each_index do |idx|
395
+ path = dirs[0..idx].join('')
396
+ Dir.mkdir path unless File.dir?(path)
397
+ end
398
+ end
399
+
400
+ def rm_f(fname)
401
+ $stderr.puts "rm -f #{fname}" if verbose?
402
+ return if no_harm?
403
+
404
+ if File.exist?(fname) or File.symlink?(fname)
405
+ File.chmod 0777, fname
406
+ File.unlink fname
407
+ end
408
+ end
409
+
410
+ def rm_rf(dn)
411
+ $stderr.puts "rm -rf #{dn}" if verbose?
412
+ return if no_harm?
413
+
414
+ Dir.chdir dn
415
+ Dir.foreach('.') do |fn|
416
+ next if fn == '.'
417
+ next if fn == '..'
418
+ if File.dir?(fn)
419
+ verbose_off {
420
+ rm_rf fn
421
+ }
422
+ else
423
+ verbose_off {
424
+ rm_f fn
425
+ }
426
+ end
427
+ end
428
+ Dir.chdir '..'
429
+ Dir.rmdir dn
430
+ end
431
+
432
+ def move_file(src, dest)
433
+ File.unlink dest if File.exist?(dest)
434
+ begin
435
+ File.rename src, dest
436
+ rescue
437
+ File.open(dest, 'wb') {|f| f.write File.binread(src) }
438
+ File.chmod File.stat(src).mode, dest
439
+ File.unlink src
440
+ end
441
+ end
442
+
443
+ def install(from, dest, mode, prefix = nil)
444
+ $stderr.puts "install #{from} #{dest}" if verbose?
445
+ return if no_harm?
446
+
447
+ realdest = prefix + dest if prefix
448
+ realdest = File.join(realdest, File.basename(from)) if File.dir?(realdest)
449
+ str = File.binread(from)
450
+ if diff?(str, realdest)
451
+ verbose_off {
452
+ rm_f realdest if File.exist?(realdest)
453
+ }
454
+ File.open(realdest, 'wb') {|f|
455
+ f.write str
456
+ }
457
+ File.chmod mode, realdest
458
+
459
+ File.open("#{objdir_root()}/InstalledFiles", 'a') {|f|
460
+ if prefix
461
+ f.puts realdest.sub(prefix, '')
462
+ else
463
+ f.puts realdest
464
+ end
465
+ }
466
+ end
467
+ end
468
+
469
+ def diff?(new_content, path)
470
+ return true unless File.exist?(path)
471
+ new_content != File.binread(path)
472
+ end
473
+
474
+ def command(str)
475
+ $stderr.puts str if verbose?
476
+ system str or raise RuntimeError, "'system #{str}' failed"
477
+ end
478
+
479
+ def ruby(str)
480
+ command config('ruby-prog') + ' ' + str
481
+ end
482
+
483
+ def make(task = '')
484
+ command config('make-prog') + ' ' + task
485
+ end
486
+
487
+ def extdir?(dir)
488
+ File.exist?(dir + '/MANIFEST')
489
+ end
490
+
491
+ def all_files_in(dirname)
492
+ Dir.open(dirname) {|d|
493
+ return d.select {|ent| File.file?("#{dirname}/#{ent}") }
494
+ }
495
+ end
496
+
497
+ REJECT_DIRS = %w(
498
+ CVS SCCS RCS CVS.adm .svn
499
+ )
500
+
501
+ def all_dirs_in(dirname)
502
+ Dir.open(dirname) {|d|
503
+ return d.select {|n| File.dir?("#{dirname}/#{n}") } - %w(. ..) - REJECT_DIRS
504
+ }
505
+ end
506
+
507
+ end
508
+
509
+ #
510
+ # Main Installer
511
+ #
512
+
513
+ class InstallError < StandardError; end
514
+
515
+
516
+ module HookUtils
517
+
518
+ def run_hook(name)
519
+ try_run_hook "#{curr_srcdir()}/#{name}" or
520
+ try_run_hook "#{curr_srcdir()}/#{name}.rb"
521
+ end
522
+
523
+ def try_run_hook(fname)
524
+ return false unless File.file?(fname)
525
+ begin
526
+ instance_eval File.read(fname), fname, 1
527
+ rescue
528
+ raise InstallError, "hook #{fname} failed:\n" + $!.message
529
+ end
530
+ true
531
+ end
532
+
533
+ end
534
+
535
+
536
+ module HookScriptAPI
537
+
538
+ def get_config(key)
539
+ @config[key]
540
+ end
541
+
542
+ alias config get_config
543
+
544
+ def set_config(key, val)
545
+ @config[key] = val
546
+ end
547
+
548
+ #
549
+ # srcdir/objdir (works only in the package directory)
550
+ #
551
+
552
+ #abstract srcdir_root
553
+ #abstract objdir_root
554
+ #abstract relpath
555
+
556
+ def curr_srcdir
557
+ "#{srcdir_root()}/#{relpath()}"
558
+ end
559
+
560
+ def curr_objdir
561
+ "#{objdir_root()}/#{relpath()}"
562
+ end
563
+
564
+ def srcfile(path)
565
+ "#{curr_srcdir()}/#{path}"
566
+ end
567
+
568
+ def srcexist?(path)
569
+ File.exist?(srcfile(path))
570
+ end
571
+
572
+ def srcdirectory?(path)
573
+ File.dir?(srcfile(path))
574
+ end
575
+
576
+ def srcfile?(path)
577
+ File.file? srcfile(path)
578
+ end
579
+
580
+ def srcentries(path = '.')
581
+ Dir.open("#{curr_srcdir()}/#{path}") {|d|
582
+ return d.to_a - %w(. ..)
583
+ }
584
+ end
585
+
586
+ def srcfiles(path = '.')
587
+ srcentries(path).select {|fname|
588
+ File.file?(File.join(curr_srcdir(), path, fname))
589
+ }
590
+ end
591
+
592
+ def srcdirectories(path = '.')
593
+ srcentries(path).select {|fname|
594
+ File.dir?(File.join(curr_srcdir(), path, fname))
595
+ }
596
+ end
597
+
598
+ end
599
+
600
+
601
+ class ToplevelInstaller
602
+
603
+ Version = '3.2.4'
604
+ Copyright = 'Copyright (c) 2000-2004 Minero Aoki'
605
+
606
+ TASKS = [
607
+ [ 'config', 'saves your configurations' ],
608
+ [ 'show', 'shows current configuration' ],
609
+ [ 'setup', 'compiles ruby extentions and others' ],
610
+ [ 'install', 'installs files' ],
611
+ [ 'clean', "does `make clean' for each extention" ],
612
+ [ 'distclean',"does `make distclean' for each extention" ]
613
+ ]
614
+
615
+ def ToplevelInstaller.invoke
616
+ instance().invoke
617
+ end
618
+
619
+ @singleton = nil
620
+
621
+ def ToplevelInstaller.instance
622
+ @singleton ||= new(File.dirname($0))
623
+ @singleton
624
+ end
625
+
626
+ include MetaConfigAPI
627
+
628
+ def initialize(ardir_root)
629
+ @config = nil
630
+ @options = { 'verbose' => true }
631
+ @ardir = File.expand_path(ardir_root)
632
+ end
633
+
634
+ def inspect
635
+ "#<#{self.class} #{__id__()}>"
636
+ end
637
+
638
+ def invoke
639
+ run_metaconfigs
640
+ task = parsearg_global()
641
+ @config = load_config(task)
642
+ __send__ "parsearg_#{task}"
643
+ init_installers
644
+ __send__ "exec_#{task}"
645
+ end
646
+
647
+ def run_metaconfigs
648
+ eval_file_ifexist "#{@ardir}/metaconfig"
649
+ end
650
+
651
+ def load_config(task)
652
+ case task
653
+ when 'config'
654
+ ConfigTable.new
655
+ when 'clean', 'distclean'
656
+ if File.exist?('config.save')
657
+ then ConfigTable.load
658
+ else ConfigTable.new
659
+ end
660
+ else
661
+ ConfigTable.load
662
+ end
663
+ end
664
+
665
+ def init_installers
666
+ @installer = Installer.new(@config, @options, @ardir, File.expand_path('.'))
667
+ end
668
+
669
+ #
670
+ # Hook Script API bases
671
+ #
672
+
673
+ def srcdir_root
674
+ @ardir
675
+ end
676
+
677
+ def objdir_root
678
+ '.'
679
+ end
680
+
681
+ def relpath
682
+ '.'
683
+ end
684
+
685
+ #
686
+ # Option Parsing
687
+ #
688
+
689
+ def parsearg_global
690
+ valid_task = /\A(?:#{TASKS.map {|task,desc| task }.join '|'})\z/
691
+
692
+ while arg = ARGV.shift
693
+ case arg
694
+ when /\A\w+\z/
695
+ raise InstallError, "invalid task: #{arg}" unless valid_task =~ arg
696
+ return arg
697
+
698
+ when '-q', '--quiet'
699
+ @options['verbose'] = false
700
+
701
+ when '--verbose'
702
+ @options['verbose'] = true
703
+
704
+ when '-h', '--help'
705
+ print_usage $stdout
706
+ exit 0
707
+
708
+ when '-v', '--version'
709
+ puts "#{File.basename($0)} version #{Version}"
710
+ exit 0
711
+
712
+ when '--copyright'
713
+ puts Copyright
714
+ exit 0
715
+
716
+ else
717
+ raise InstallError, "unknown global option '#{arg}'"
718
+ end
719
+ end
720
+
721
+ raise InstallError, <<EOS
722
+ No task or global option given.
723
+ Typical installation procedure is:
724
+ $ ruby #{File.basename($0)} config
725
+ $ ruby #{File.basename($0)} setup
726
+ # ruby #{File.basename($0)} install (may require root privilege)
727
+ EOS
728
+ end
729
+
730
+
731
+ def parsearg_no_options
732
+ raise InstallError, "#{task}: unknown options: #{ARGV.join ' '}"\
733
+ unless ARGV.empty?
734
+ end
735
+
736
+ alias parsearg_show parsearg_no_options
737
+ alias parsearg_setup parsearg_no_options
738
+ alias parsearg_clean parsearg_no_options
739
+ alias parsearg_distclean parsearg_no_options
740
+
741
+ def parsearg_config
742
+ re = /\A--(#{ConfigTable.keys.join '|'})(?:=(.*))?\z/
743
+ @options['config-opt'] = []
744
+
745
+ while i = ARGV.shift
746
+ if /\A--?\z/ =~ i
747
+ @options['config-opt'] = ARGV.dup
748
+ break
749
+ end
750
+ m = re.match(i) or raise InstallError, "config: unknown option #{i}"
751
+ name, value = m.to_a[1,2]
752
+ if value
753
+ if ConfigTable.bool_config?(name)
754
+ raise InstallError, "config: --#{name} allows only yes/no for argument"\
755
+ unless /\A(y(es)?|n(o)?|t(rue)?|f(alse))\z/i =~ value
756
+ value = (/\Ay(es)?|\At(rue)/i =~ value) ? 'yes' : 'no'
757
+ end
758
+ else
759
+ raise InstallError, "config: --#{name} requires argument"\
760
+ unless ConfigTable.bool_config?(name)
761
+ value = 'yes'
762
+ end
763
+ @config[name] = value
764
+ end
765
+ end
766
+
767
+ def parsearg_install
768
+ @options['no-harm'] = false
769
+ @options['install-prefix'] = ''
770
+ while a = ARGV.shift
771
+ case a
772
+ when /\A--no-harm\z/
773
+ @options['no-harm'] = true
774
+ when /\A--prefix=(.*)\z/
775
+ path = $1
776
+ path = File.expand_path(path) unless path[0,1] == '/'
777
+ @options['install-prefix'] = path
778
+ else
779
+ raise InstallError, "install: unknown option #{a}"
780
+ end
781
+ end
782
+ end
783
+
784
+ def print_usage(out)
785
+ out.puts 'Typical Installation Procedure:'
786
+ out.puts " $ ruby #{File.basename $0} config"
787
+ out.puts " $ ruby #{File.basename $0} setup"
788
+ out.puts " # ruby #{File.basename $0} install (may require root privilege)"
789
+ out.puts
790
+ out.puts 'Detailed Usage:'
791
+ out.puts " ruby #{File.basename $0} <global option>"
792
+ out.puts " ruby #{File.basename $0} [<global options>] <task> [<task options>]"
793
+
794
+ fmt = " %-20s %s\n"
795
+ out.puts
796
+ out.puts 'Global options:'
797
+ out.printf fmt, '-q,--quiet', 'suppress message outputs'
798
+ out.printf fmt, ' --verbose', 'output messages verbosely'
799
+ out.printf fmt, '-h,--help', 'print this message'
800
+ out.printf fmt, '-v,--version', 'print version and quit'
801
+ out.printf fmt, ' --copyright', 'print copyright and quit'
802
+
803
+ out.puts
804
+ out.puts 'Tasks:'
805
+ TASKS.each do |name, desc|
806
+ out.printf " %-10s %s\n", name, desc
807
+ end
808
+
809
+ out.puts
810
+ out.puts 'Options for config:'
811
+ ConfigTable.each_definition do |name, (default, arg, desc, default2)|
812
+ out.printf " %-20s %s [%s]\n",
813
+ '--'+ name + (ConfigTable.bool_config?(name) ? '' : '='+arg),
814
+ desc,
815
+ default2 || default
816
+ end
817
+ out.printf " %-20s %s [%s]\n",
818
+ '--rbconfig=path', 'your rbconfig.rb to load', "running ruby's"
819
+
820
+ out.puts
821
+ out.puts 'Options for install:'
822
+ out.printf " %-20s %s [%s]\n",
823
+ '--no-harm', 'only display what to do if given', 'off'
824
+ out.printf " %-20s %s [%s]\n",
825
+ '--prefix', 'install path prefix', '$prefix'
826
+
827
+ out.puts
828
+ end
829
+
830
+ #
831
+ # Task Handlers
832
+ #
833
+
834
+ def exec_config
835
+ @installer.exec_config
836
+ @config.save # must be final
837
+ end
838
+
839
+ def exec_setup
840
+ @installer.exec_setup
841
+ end
842
+
843
+ def exec_install
844
+ @installer.exec_install
845
+ end
846
+
847
+ def exec_show
848
+ ConfigTable.each_name do |k|
849
+ v = @config.get_raw(k)
850
+ if not v or v.empty?
851
+ v = '(not specified)'
852
+ end
853
+ printf "%-10s %s\n", k, v
854
+ end
855
+ end
856
+
857
+ def exec_clean
858
+ @installer.exec_clean
859
+ end
860
+
861
+ def exec_distclean
862
+ @installer.exec_distclean
863
+ end
864
+
865
+ end
866
+
867
+
868
+ class ToplevelInstallerMulti < ToplevelInstaller
869
+
870
+ include HookUtils
871
+ include HookScriptAPI
872
+ include FileOperations
873
+
874
+ def initialize(ardir)
875
+ super
876
+ @packages = all_dirs_in("#{@ardir}/packages")
877
+ raise 'no package exists' if @packages.empty?
878
+ end
879
+
880
+ def run_metaconfigs
881
+ eval_file_ifexist "#{@ardir}/metaconfig"
882
+ @packages.each do |name|
883
+ eval_file_ifexist "#{@ardir}/packages/#{name}/metaconfig"
884
+ end
885
+ end
886
+
887
+ def init_installers
888
+ @installers = {}
889
+ @packages.each do |pack|
890
+ @installers[pack] = Installer.new(@config, @options,
891
+ "#{@ardir}/packages/#{pack}",
892
+ "packages/#{pack}")
893
+ end
894
+
895
+ with = extract_selection(config('with'))
896
+ without = extract_selection(config('without'))
897
+ @selected = @installers.keys.select {|name|
898
+ (with.empty? or with.include?(name)) \
899
+ and not without.include?(name)
900
+ }
901
+ end
902
+
903
+ def extract_selection(list)
904
+ a = list.split(/,/)
905
+ a.each do |name|
906
+ raise InstallError, "no such package: #{name}" \
907
+ unless @installers.key?(name)
908
+ end
909
+ a
910
+ end
911
+
912
+ def print_usage(f)
913
+ super
914
+ f.puts 'Inluded packages:'
915
+ f.puts ' ' + @packages.sort.join(' ')
916
+ f.puts
917
+ end
918
+
919
+ #
920
+ # multi-package metaconfig API
921
+ #
922
+
923
+ attr_reader :packages
924
+
925
+ def declare_packages(list)
926
+ raise 'package list is empty' if list.empty?
927
+ list.each do |name|
928
+ raise "directory packages/#{name} does not exist"\
929
+ unless File.dir?("#{@ardir}/packages/#{name}")
930
+ end
931
+ @packages = list
932
+ end
933
+
934
+ #
935
+ # Task Handlers
936
+ #
937
+
938
+ def exec_config
939
+ run_hook 'pre-config'
940
+ each_selected_installers {|inst| inst.exec_config }
941
+ run_hook 'post-config'
942
+ @config.save # must be final
943
+ end
944
+
945
+ def exec_setup
946
+ run_hook 'pre-setup'
947
+ each_selected_installers {|inst| inst.exec_setup }
948
+ run_hook 'post-setup'
949
+ end
950
+
951
+ def exec_install
952
+ run_hook 'pre-install'
953
+ each_selected_installers {|inst| inst.exec_install }
954
+ run_hook 'post-install'
955
+ end
956
+
957
+ def exec_clean
958
+ rm_f 'config.save'
959
+ run_hook 'pre-clean'
960
+ each_selected_installers {|inst| inst.exec_clean }
961
+ run_hook 'post-clean'
962
+ end
963
+
964
+ def exec_distclean
965
+ rm_f 'config.save'
966
+ run_hook 'pre-distclean'
967
+ each_selected_installers {|inst| inst.exec_distclean }
968
+ run_hook 'post-distclean'
969
+ end
970
+
971
+ #
972
+ # lib
973
+ #
974
+
975
+ def each_selected_installers
976
+ Dir.mkdir 'packages' unless File.dir?('packages')
977
+ @selected.each do |pack|
978
+ $stderr.puts "Processing the package `#{pack}' ..." if @options['verbose']
979
+ Dir.mkdir "packages/#{pack}" unless File.dir?("packages/#{pack}")
980
+ Dir.chdir "packages/#{pack}"
981
+ yield @installers[pack]
982
+ Dir.chdir '../..'
983
+ end
984
+ end
985
+
986
+ def verbose?
987
+ @options['verbose']
988
+ end
989
+
990
+ def no_harm?
991
+ @options['no-harm']
992
+ end
993
+
994
+ end
995
+
996
+
997
+ class Installer
998
+
999
+ FILETYPES = %w( bin lib ext data )
1000
+
1001
+ include HookScriptAPI
1002
+ include HookUtils
1003
+ include FileOperations
1004
+
1005
+ def initialize(config, opt, srcroot, objroot)
1006
+ @config = config
1007
+ @options = opt
1008
+ @srcdir = File.expand_path(srcroot)
1009
+ @objdir = File.expand_path(objroot)
1010
+ @currdir = '.'
1011
+ end
1012
+
1013
+ def inspect
1014
+ "#<#{self.class} #{File.basename(@srcdir)}>"
1015
+ end
1016
+
1017
+ #
1018
+ # Hook Script API bases
1019
+ #
1020
+
1021
+ def srcdir_root
1022
+ @srcdir
1023
+ end
1024
+
1025
+ def objdir_root
1026
+ @objdir
1027
+ end
1028
+
1029
+ def relpath
1030
+ @currdir
1031
+ end
1032
+
1033
+ #
1034
+ # configs/options
1035
+ #
1036
+
1037
+ def no_harm?
1038
+ @options['no-harm']
1039
+ end
1040
+
1041
+ def verbose?
1042
+ @options['verbose']
1043
+ end
1044
+
1045
+ def verbose_off
1046
+ begin
1047
+ save, @options['verbose'] = @options['verbose'], false
1048
+ yield
1049
+ ensure
1050
+ @options['verbose'] = save
1051
+ end
1052
+ end
1053
+
1054
+ #
1055
+ # TASK config
1056
+ #
1057
+
1058
+ def exec_config
1059
+ exec_task_traverse 'config'
1060
+ end
1061
+
1062
+ def config_dir_bin(rel)
1063
+ end
1064
+
1065
+ def config_dir_lib(rel)
1066
+ end
1067
+
1068
+ def config_dir_ext(rel)
1069
+ extconf if extdir?(curr_srcdir())
1070
+ end
1071
+
1072
+ def extconf
1073
+ opt = @options['config-opt'].join(' ')
1074
+ command "#{config('ruby-prog')} #{curr_srcdir()}/extconf.rb #{opt}"
1075
+ end
1076
+
1077
+ def config_dir_data(rel)
1078
+ end
1079
+
1080
+ #
1081
+ # TASK setup
1082
+ #
1083
+
1084
+ def exec_setup
1085
+ exec_task_traverse 'setup'
1086
+ end
1087
+
1088
+ def setup_dir_bin(rel)
1089
+ all_files_in(curr_srcdir()).each do |fname|
1090
+ adjust_shebang "#{curr_srcdir()}/#{fname}"
1091
+ end
1092
+ end
1093
+
1094
+ # modify: #!/usr/bin/ruby
1095
+ # modify: #! /usr/bin/ruby
1096
+ # modify: #!ruby
1097
+ # not modify: #!/usr/bin/env ruby
1098
+ SHEBANG_RE = /\A\#!\s*\S*ruby\S*/
1099
+
1100
+ def adjust_shebang(path)
1101
+ return if no_harm?
1102
+
1103
+ tmpfile = File.basename(path) + '.tmp'
1104
+ begin
1105
+ File.open(path, 'rb') {|r|
1106
+ File.open(tmpfile, 'wb') {|w|
1107
+ first = r.gets
1108
+ return unless SHEBANG_RE =~ first
1109
+
1110
+ $stderr.puts "adjusting shebang: #{File.basename path}" if verbose?
1111
+ w.print first.sub(SHEBANG_RE, '#!' + config('ruby-path'))
1112
+ w.write r.read
1113
+ }
1114
+ }
1115
+ move_file tmpfile, File.basename(path)
1116
+ ensure
1117
+ File.unlink tmpfile if File.exist?(tmpfile)
1118
+ end
1119
+ end
1120
+
1121
+ def setup_dir_lib(rel)
1122
+ end
1123
+
1124
+ def setup_dir_ext(rel)
1125
+ make if extdir?(curr_srcdir())
1126
+ end
1127
+
1128
+ def setup_dir_data(rel)
1129
+ end
1130
+
1131
+ #
1132
+ # TASK install
1133
+ #
1134
+
1135
+ def exec_install
1136
+ exec_task_traverse 'install'
1137
+ end
1138
+
1139
+ def install_dir_bin(rel)
1140
+ list = collect_filenames_auto
1141
+ install_files list, "#{config('bin-dir')}/#{rel}", 0755
1142
+ install_cmd_files list, "#{config('bin-dir')}/#{rel}", 0755
1143
+ end
1144
+
1145
+ def install_dir_lib(rel)
1146
+ install_files ruby_scripts(), "#{config('rb-dir')}/#{rel}", 0644
1147
+ end
1148
+
1149
+ def install_dir_ext(rel)
1150
+ return unless extdir?(curr_srcdir())
1151
+ install_files ruby_extentions('.'),
1152
+ "#{config('so-dir')}/#{File.dirname(rel)}",
1153
+ 0555
1154
+ end
1155
+
1156
+ def install_dir_data(rel)
1157
+ install_files collect_filenames_auto(), "#{config('data-dir')}/#{rel}", 0644
1158
+ end
1159
+
1160
+ def install_cmd_files(list, dest, mode)
1161
+ if Config::CONFIG["arch"] =~ /dos|win32/i
1162
+ mkdir_p dest, @options['install-prefix']
1163
+ list.each do |fname|
1164
+ next if no_harm?
1165
+ File.open(File.join(dest, "#{fname}.cmd"), "w") do |file|
1166
+ file.puts "@ruby \"#{File.join(dest, fname)}\" %*"
1167
+ end
1168
+ File.chmod mode, File.join(dest, "#{fname}.cmd")
1169
+ end
1170
+ end
1171
+ end
1172
+
1173
+ def install_files(list, dest, mode)
1174
+ mkdir_p dest, @options['install-prefix']
1175
+ list.each do |fname|
1176
+ install fname, dest, mode, @options['install-prefix']
1177
+ end
1178
+ end
1179
+
1180
+ def ruby_scripts
1181
+ collect_filenames_auto().select {|n| /\.(r(b|html)|txt)\z/ =~ n}
1182
+ end
1183
+
1184
+ # picked up many entries from cvs-1.11.1/src/ignore.c
1185
+ reject_patterns = %w(
1186
+ core RCSLOG tags TAGS .make.state
1187
+ .nse_depinfo #* .#* cvslog.* ,* .del-* *.olb
1188
+ *~ *.old *.bak *.BAK *.orig *.rej _$* *$
1189
+
1190
+ *.org *.in .*
1191
+ )
1192
+ mapping = {
1193
+ '.' => '\.',
1194
+ '$' => '\$',
1195
+ '#' => '\#',
1196
+ '*' => '.*'
1197
+ }
1198
+ REJECT_PATTERNS = Regexp.new('\A(?:' +
1199
+ reject_patterns.map {|pat|
1200
+ pat.gsub(/[\.\$\#\*]/) {|ch| mapping[ch] }
1201
+ }.join('|') +
1202
+ ')\z')
1203
+
1204
+ def collect_filenames_auto
1205
+ mapdir((existfiles() - hookfiles()).reject {|fname|
1206
+ REJECT_PATTERNS =~ fname
1207
+ })
1208
+ end
1209
+
1210
+ def existfiles
1211
+ all_files_in(curr_srcdir()) | all_files_in('.')
1212
+ end
1213
+
1214
+ def hookfiles
1215
+ %w( pre-%s post-%s pre-%s.rb post-%s.rb ).map {|fmt|
1216
+ %w( config setup install clean ).map {|t| sprintf(fmt, t) }
1217
+ }.flatten
1218
+ end
1219
+
1220
+ def mapdir(filelist)
1221
+ filelist.map {|fname|
1222
+ if File.exist?(fname) # objdir
1223
+ fname
1224
+ else # srcdir
1225
+ File.join(curr_srcdir(), fname)
1226
+ end
1227
+ }
1228
+ end
1229
+
1230
+ def ruby_extentions(dir)
1231
+ _ruby_extentions(dir) or
1232
+ raise InstallError, "no ruby extention exists: 'ruby #{$0} setup' first"
1233
+ end
1234
+
1235
+ DLEXT = /\.#{ ::Config::CONFIG['DLEXT'] }\z/
1236
+
1237
+ def _ruby_extentions(dir)
1238
+ Dir.open(dir) {|d|
1239
+ return d.select {|fname| DLEXT =~ fname }
1240
+ }
1241
+ end
1242
+
1243
+ #
1244
+ # TASK clean
1245
+ #
1246
+
1247
+ def exec_clean
1248
+ exec_task_traverse 'clean'
1249
+ rm_f 'config.save'
1250
+ rm_f 'InstalledFiles'
1251
+ end
1252
+
1253
+ def clean_dir_bin(rel)
1254
+ end
1255
+
1256
+ def clean_dir_lib(rel)
1257
+ end
1258
+
1259
+ def clean_dir_ext(rel)
1260
+ return unless extdir?(curr_srcdir())
1261
+ make 'clean' if File.file?('Makefile')
1262
+ end
1263
+
1264
+ def clean_dir_data(rel)
1265
+ end
1266
+
1267
+ #
1268
+ # TASK distclean
1269
+ #
1270
+
1271
+ def exec_distclean
1272
+ exec_task_traverse 'distclean'
1273
+ rm_f 'config.save'
1274
+ rm_f 'InstalledFiles'
1275
+ end
1276
+
1277
+ def distclean_dir_bin(rel)
1278
+ end
1279
+
1280
+ def distclean_dir_lib(rel)
1281
+ end
1282
+
1283
+ def distclean_dir_ext(rel)
1284
+ return unless extdir?(curr_srcdir())
1285
+ make 'distclean' if File.file?('Makefile')
1286
+ end
1287
+
1288
+ #
1289
+ # lib
1290
+ #
1291
+
1292
+ def exec_task_traverse(task)
1293
+ run_hook "pre-#{task}"
1294
+ FILETYPES.each do |type|
1295
+ if config('without-ext') == 'yes' and type == 'ext'
1296
+ $stderr.puts 'skipping ext/* by user option' if verbose?
1297
+ next
1298
+ end
1299
+ traverse task, type, "#{task}_dir_#{type}"
1300
+ end
1301
+ run_hook "post-#{task}"
1302
+ end
1303
+
1304
+ def traverse(task, rel, mid)
1305
+ dive_into(rel) {
1306
+ run_hook "pre-#{task}"
1307
+ __send__ mid, rel.sub(%r[\A.*?(?:/|\z)], '')
1308
+ all_dirs_in(curr_srcdir()).each do |d|
1309
+ traverse task, "#{rel}/#{d}", mid
1310
+ end
1311
+ run_hook "post-#{task}"
1312
+ }
1313
+ end
1314
+
1315
+ def dive_into(rel)
1316
+ return unless File.dir?("#{@srcdir}/#{rel}")
1317
+
1318
+ dir = File.basename(rel)
1319
+ Dir.mkdir dir unless File.dir?(dir)
1320
+ prevdir = Dir.pwd
1321
+ Dir.chdir dir
1322
+ $stderr.puts '---> ' + rel if verbose?
1323
+ @currdir = rel
1324
+ yield
1325
+ Dir.chdir prevdir
1326
+ $stderr.puts '<--- ' + rel if verbose?
1327
+ @currdir = File.dirname(rel)
1328
+ end
1329
+
1330
+ end
1331
+
1332
+
1333
+ if $0 == __FILE__
1334
+ begin
1335
+ if multipackage_install?
1336
+ ToplevelInstallerMulti.invoke
1337
+ else
1338
+ ToplevelInstaller.invoke
1339
+ end
1340
+ rescue
1341
+ raise if $DEBUG
1342
+ $stderr.puts $!.message
1343
+ $stderr.puts "Try 'ruby #{$0} --help' for detailed usage."
1344
+ exit 1
1345
+ end
1346
+ end