2007-08-25 13:32:51 -04:00
# Copyright (c) 2005 Zed A. Shaw
2006-06-30 16:42:12 -04:00
# You can redistribute it and/or modify it under the same terms as Ruby.
#
2007-08-25 13:32:51 -04:00
# Additional work donated by contributors. See http://mongrel.rubyforge.org/attributions.html
2006-06-30 16:42:12 -04:00
# for more information.
2006-03-05 02:58:18 -05:00
require 'yaml'
2007-10-27 13:33:12 -04:00
require 'etc'
$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
2006-04-05 08:29:23 -04:00
require 'mongrel'
2006-03-26 15:01:50 -05:00
require 'mongrel/rails'
2007-10-27 13:33:12 -04:00
2007-11-12 16:13:03 -05:00
Mongrel::Gems.require 'gem_plugin'
2007-10-27 13:33:12 -04:00
# require 'ruby-debug'
# Debugger.start
2006-03-26 15:01:50 -05:00
2006-09-22 04:16:54 -04:00
module Mongrel
class Start < GemPlugin::Plugin "/commands"
include Mongrel::Command::Base
def configure
options [
["-e", "--environment ENV", "Rails environment to run as", :@environment, ENV['RAILS_ENV'] || "development"],
2006-09-26 17:25:44 -04:00
["-d", "--daemonize", "Run daemonized in the background", :@daemon, false],
2006-09-22 04:16:54 -04:00
['-p', '--port PORT', "Which port to bind to", :@port, 3000],
['-a', '--address ADDR', "Address to bind to", :@address, "0.0.0.0"],
['-l', '--log FILE', "Where to write log messages", :@log_file, "log/mongrel.log"],
['-P', '--pid FILE', "Where to write the PID", :@pid_file, "log/mongrel.pid"],
2008-05-22 02:12:37 -04:00
['-n', '--num-processors INT', "Number of processors active before clients denied", :@num_processors, 1024],
2007-10-15 15:45:26 -04:00
['-o', '--timeout TIME', "Time to wait (in seconds) before killing a stalled thread", :@timeout, 60],
2007-09-24 12:26:38 -04:00
['-t', '--throttle TIME', "Time to pause (in hundredths of a second) between accepting clients", :@throttle, 0],
2006-09-22 04:16:54 -04:00
['-m', '--mime PATH', "A YAML file that lists additional MIME types", :@mime_map, nil],
['-c', '--chdir PATH', "Change to dir before starting (will be expanded)", :@cwd, Dir.pwd],
['-r', '--root PATH', "Set the document root (default 'public')", :@docroot, "public"],
['-B', '--debug', "Enable debugging mode", :@debug, false],
['-C', '--config PATH', "Use a config file", :@config_file, nil],
2006-09-26 17:25:44 -04:00
['-S', '--script PATH', "Load the given file as an extra config script", :@config_script, nil],
['-G', '--generate PATH', "Generate a config file for use with -C", :@generate, nil],
2006-10-24 19:00:29 -04:00
['', '--user USER', "User to run as", :@user, nil],
['', '--group GROUP', "Group to run as", :@group, nil],
['', '--prefix PATH', "URL prefix for Rails app", :@prefix, nil]
2006-09-22 04:16:54 -04:00
]
end
2006-03-26 15:01:50 -05:00
2006-09-22 04:16:54 -04:00
def validate
2007-08-25 13:32:51 -04:00
if @config_file
valid_exists?(@config_file, "Config file not there: #@config_file")
return false unless @valid
@config_file = File.expand_path(@config_file)
load_config
return false unless @valid
end
2006-09-22 04:16:54 -04:00
@cwd = File.expand_path(@cwd)
valid_dir? @cwd, "Invalid path to change to during daemon mode: #@cwd"
2006-02-14 07:19:02 -05:00
2006-09-26 17:25:44 -04:00
# Change there to start, then we'll have to come back after daemonize
2006-09-22 04:16:54 -04:00
Dir.chdir(@cwd)
2006-02-14 07:19:02 -05:00
2007-08-25 13:32:51 -04:00
valid?(@prefix[0] == ?/ && @prefix[-1] != ?/, "Prefix must begin with / and not end in /") if @prefix
2006-09-22 04:16:54 -04:00
valid_dir? File.dirname(@log_file), "Path to log file not valid: #@log_file"
valid_dir? File.dirname(@pid_file), "Path to pid file not valid: #@pid_file"
valid_dir? @docroot, "Path to docroot not valid: #@docroot"
valid_exists? @mime_map, "MIME mapping file does not exist: #@mime_map" if @mime_map
valid_exists? @config_file, "Config file not there: #@config_file" if @config_file
valid_dir? File.dirname(@generate), "Problem accessing directory to #@generate" if @generate
valid_user? @user if @user
valid_group? @group if @group
2006-06-05 04:54:06 -04:00
2006-09-22 04:16:54 -04:00
return @valid
2006-05-12 15:39:42 -04:00
end
2006-09-22 04:16:54 -04:00
def run
if @generate
2007-08-25 13:32:51 -04:00
@generate = File.expand_path(@generate)
2006-09-26 17:25:44 -04:00
STDERR.puts "** Writing config to \"#@generate\"."
2006-09-22 04:16:54 -04:00
open(@generate, "w") {|f| f.write(settings.to_yaml) }
2007-08-13 22:01:57 -04:00
STDERR.puts "** Finished. Run \"mongrel_rails start -C #@generate\" to use the config file."
2006-09-22 04:16:54 -04:00
exit 0
2006-03-26 15:01:50 -05:00
end
2006-05-19 22:56:30 -04:00
2006-09-22 04:16:54 -04:00
config = Mongrel::Rails::RailsConfigurator.new(settings) do
if defaults[:daemon]
if File.exist? defaults[:pid_file]
2006-09-26 17:25:44 -04:00
log "!!! PID file #{defaults[:pid_file]} already exists. Mongrel could be running already. Check your #{defaults[:log_file]} for errors."
2006-12-15 23:26:54 -05:00
log "!!! Exiting with error. You must stop mongrel and clear the .pid before I'll attempt a start."
exit 1
2006-09-22 04:16:54 -04:00
end
2006-05-19 22:56:30 -04:00
2006-09-22 04:16:54 -04:00
daemonize
log "Daemonized, any open files are closed. Look at #{defaults[:pid_file]} and #{defaults[:log_file]} for info."
log "Settings loaded from #{@config_file} (they override command line)." if @config_file
2006-03-26 15:01:50 -05:00
end
2006-09-22 04:16:54 -04:00
log "Starting Mongrel listening at #{defaults[:host]}:#{defaults[:port]}"
2006-03-26 15:01:50 -05:00
2006-09-22 04:16:54 -04:00
listener do
mime = {}
if defaults[:mime_map]
log "Loading additional MIME types from #{defaults[:mime_map]}"
mime = load_mime_map(defaults[:mime_map], mime)
end
2006-03-26 15:01:50 -05:00
2006-09-22 04:16:54 -04:00
if defaults[:debug]
2006-09-26 17:25:44 -04:00
log "Installing debugging prefixed filters. Look in log/mongrel_debug for the files."
2006-09-22 04:16:54 -04:00
debug "/"
end
2006-04-01 03:43:30 -05:00
2006-09-22 04:16:54 -04:00
log "Starting Rails with #{defaults[:environment]} environment..."
log "Mounting Rails at #{defaults[:prefix]}..." if defaults[:prefix]
uri defaults[:prefix] || "/", :handler => rails(:mime => mime, :prefix => defaults[:prefix])
log "Rails loaded."
2006-03-05 02:58:18 -05:00
2006-09-22 04:16:54 -04:00
log "Loading any Rails specific GemPlugins"
load_plugins
if defaults[:config_script]
log "Loading #{defaults[:config_script]} external config script"
run_config(defaults[:config_script])
end
setup_rails_signals
end
end
2006-05-22 23:58:37 -04:00
2006-09-22 04:16:54 -04:00
config.run
2007-11-01 02:14:56 -04:00
config.log "Mongrel #{Mongrel::Const::MONGREL_VERSION} available at #{@address}:#{@port}"
2006-03-14 00:48:37 -05:00
2006-09-22 04:16:54 -04:00
if config.defaults[:daemon]
config.write_pid_file
2006-03-14 00:48:37 -05:00
else
2006-09-22 04:16:54 -04:00
config.log "Use CTRL-C to stop."
end
config.join
if config.needs_restart
if RUBY_PLATFORM !~ /mswin/
cmd = "ruby #{__FILE__} start #{original_args.join(' ')}"
config.log "Restarting with arguments: #{cmd}"
2007-10-18 15:40:48 -04:00
config.stop(false, true)
2006-09-26 00:51:02 -04:00
config.remove_pid_file
if config.defaults[:daemon]
system cmd
else
STDERR.puts "Can't restart unless in daemon mode."
exit 1
end
2006-09-22 04:16:54 -04:00
else
config.log "Win32 does not support restarts. Exiting."
end
2006-03-14 00:48:37 -05:00
end
2006-02-11 22:37:38 -05:00
end
2007-08-25 13:32:51 -04:00
def load_config
settings = {}
begin
settings = YAML.load_file(@config_file)
ensure
STDERR.puts "** Loading settings from #{@config_file} (they override command line)." unless @daemon || settings[:daemon]
end
settings[:includes] ||= ["mongrel"]
# Config file settings will override command line settings
settings.each do |key, value|
key = key.to_s
if config_keys.include?(key)
key = 'address' if key == 'host'
self.instance_variable_set("@#{key}", value)
else
failure "Unknown configuration setting: #{key}"
@valid = false
end
end
end
def config_keys
@config_keys ||=
2007-10-27 13:33:12 -04:00
%w(address host port cwd log_file pid_file environment docroot mime_map daemon debug includes config_script num_processors timeout throttle user group prefix)
2007-08-25 13:32:51 -04:00
end
def settings
config_keys.inject({}) do |hash, key|
value = self.instance_variable_get("@#{key}")
key = 'host' if key == 'address'
2007-10-27 13:33:12 -04:00
hash[key.to_sym] ||= value
2007-08-25 13:32:51 -04:00
hash
end
end
2006-02-14 07:19:02 -05:00
end
2006-02-11 22:37:38 -05:00
2006-09-22 04:16:54 -04:00
def Mongrel::send_signal(signal, pid_file)
pid = open(pid_file).read.to_i
print "Sending #{signal} to Mongrel at PID #{pid}..."
begin
Process.kill(signal, pid)
rescue Errno::ESRCH
puts "Process does not exist. Not running."
end
2006-05-19 22:56:30 -04:00
2006-09-22 04:16:54 -04:00
puts "Done."
end
2006-02-11 22:37:38 -05:00
2006-02-28 02:04:41 -05:00
2006-09-22 04:16:54 -04:00
class Stop < GemPlugin::Plugin "/commands"
include Mongrel::Command::Base
2006-02-11 22:37:38 -05:00
2006-09-22 04:16:54 -04:00
def configure
options [
2006-09-26 17:25:44 -04:00
['-c', '--chdir PATH', "Change to dir before starting (will be expanded).", :@cwd, "."],
2006-12-16 00:54:59 -05:00
['-f', '--force', "Force the shutdown (kill -9).", :@force, false],
['-w', '--wait SECONDS', "Wait SECONDS before forcing shutdown", :@wait, "0"],
2006-09-26 17:25:44 -04:00
['-P', '--pid FILE', "Where the PID file is located.", :@pid_file, "log/mongrel.pid"]
2006-09-22 04:16:54 -04:00
]
end
2006-05-19 22:56:30 -04:00
2006-09-22 04:16:54 -04:00
def validate
@cwd = File.expand_path(@cwd)
valid_dir? @cwd, "Invalid path to change to during daemon mode: #@cwd"
2006-02-14 07:19:02 -05:00
2006-09-22 04:16:54 -04:00
Dir.chdir @cwd
2006-02-14 07:19:02 -05:00
2006-09-26 17:25:44 -04:00
valid_exists? @pid_file, "PID file #@pid_file does not exist. Not running?"
2006-09-22 04:16:54 -04:00
return @valid
end
2006-02-11 22:37:38 -05:00
2006-09-22 04:16:54 -04:00
def run
if @force
2006-12-16 00:54:59 -05:00
@wait.to_i.times do |waiting|
exit(0) if not File.exist? @pid_file
sleep 1
end
Mongrel::send_signal("KILL", @pid_file) if File.exist? @pid_file
2006-09-22 04:16:54 -04:00
else
Mongrel::send_signal("TERM", @pid_file)
end
2006-02-26 16:39:40 -05:00
end
end
2006-09-22 04:16:54 -04:00
class Restart < GemPlugin::Plugin "/commands"
include Mongrel::Command::Base
2006-02-26 16:39:40 -05:00
2006-09-22 04:16:54 -04:00
def configure
options [
['-c', '--chdir PATH', "Change to dir before starting (will be expanded)", :@cwd, '.'],
['-s', '--soft', "Do a soft restart rather than a process exit restart", :@soft, false],
['-P', '--pid FILE', "Where the PID file is located", :@pid_file, "log/mongrel.pid"]
]
end
2006-05-19 22:56:30 -04:00
2006-09-22 04:16:54 -04:00
def validate
@cwd = File.expand_path(@cwd)
valid_dir? @cwd, "Invalid path to change to during daemon mode: #@cwd"
2006-02-26 16:39:40 -05:00
2006-09-22 04:16:54 -04:00
Dir.chdir @cwd
2006-02-26 16:39:40 -05:00
2006-09-26 17:25:44 -04:00
valid_exists? @pid_file, "PID file #@pid_file does not exist. Not running?"
2006-09-22 04:16:54 -04:00
return @valid
end
2006-02-26 16:39:40 -05:00
2006-09-22 04:16:54 -04:00
def run
if @soft
Mongrel::send_signal("HUP", @pid_file)
else
Mongrel::send_signal("USR2", @pid_file)
end
2006-02-11 20:30:33 -05:00
end
end
2006-02-09 21:38:18 -05:00
end
2006-02-11 20:30:33 -05:00
2006-03-25 16:15:30 -05:00
2006-03-06 00:31:39 -05:00
GemPlugin::Manager.instance.load "mongrel" => GemPlugin::INCLUDE, "rails" => GemPlugin::EXCLUDE
2006-09-26 17:25:44 -04:00
2006-03-28 10:41:52 -05:00
if not Mongrel::Command::Registry.instance.run ARGV
2006-05-19 22:56:30 -04:00
exit 1
2006-03-28 10:41:52 -05:00
end