passenger 2.2.15 → 3.0.0.pre1

data/lib/phusion_passenger/standalone/app_finder.rb

@@ -0,0 +1,153 @@
+#  Phusion Passenger - http://www.modrails.com/
+#  Copyright (c) 2010 Phusion
+#
+#  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
+#
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in
+#  all copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#  THE SOFTWARE.
+require 'phusion_passenger/utils/file_system_watcher'
+
+module PhusionPassenger
+module Standalone
+
+# Security note: can run arbitrary ruby code by evaluating passenger.conf
+class AppFinder
+	attr_accessor :dirs
+	attr_reader :apps
+	
+	def self.looks_like_app_directory?(dir)
+		return File.exist?("#{dir}/config.ru") ||
+			File.exist?("#{dir}/config/environment.rb") ||
+			File.exist?("#{dir}/passenger_wsgi.py")
+	end
+	
+	def initialize(dirs, options = {})
+		@dirs = dirs
+		@options = options
+	end
+	
+	def scan
+		apps = []
+		watchlist = []
+		
+		app_root = find_app_root
+		apps << {
+			:server_names => ["_"],
+			:root => app_root
+		}
+		watchlist << app_root
+		watchlist << "#{app_root}/config" if File.exist?("#{app_root}/config")
+		watchlist << "#{app_root}/passenger.conf" if File.exist?("#{app_root}/passenger.conf")
+		
+		apps.sort! do |a, b|
+			a[:root] <=> b[:root]
+		end
+		apps.map! do |app|
+			config_filename = File.join(app[:root], "passenger.conf")
+			if File.exist?(config_filename)
+				local_options = load_config_file(:local_config, config_filename)
+				merged_options = @options.merge(app)
+				merged_options.merge!(local_options)
+				merged_options
+			else
+				@options.merge(app)
+			end
+		end
+		
+		@apps = apps
+		@watchlist = watchlist
+		return apps
+	end
+	
+	def monitor(termination_pipe)
+		raise "You must call #scan first" if !@apps
+		
+		watcher = PhusionPassenger::Utils::FileSystemWatcher.new(@watchlist, termination_pipe)
+		if wait_on_io(termination_pipe, 3)
+			return
+		end
+		
+		while true
+			changed = watcher.wait_for_change
+			watcher.close
+			if changed
+				old_apps = @apps
+				# The change could be caused by a write to some passenger.conf file.
+				# Wait for a short period so that the write has a chance to finish.
+				if wait_on_io(termination_pipe, 0.25)
+					return
+				end
+				
+				new_apps = scan
+				watcher = PhusionPassenger::Utils::FileSystemWatcher.new(@watchlist, termination_pipe)
+				if old_apps != new_apps
+					yield(new_apps)
+				end
+				
+				# Don't process change events again for a short while,
+				# but do detect changes while waiting.
+				if wait_on_io(termination_pipe, 3)
+					return
+				end
+			else
+				return
+			end
+		end
+	ensure
+		watcher.close if watcher
+	end
+	
+	##################
+
+private
+	def find_app_root
+		if @dirs.empty?
+			return File.expand_path(".")
+		else
+			return File.expand_path(@dirs[0])
+		end
+	end
+	
+	def load_config_file(context, filename)
+		require 'phusion_passenger/standalone/config_file' unless defined?(ConfigFile)
+		return ConfigFile.new(context, filename).options
+	end
+	
+	def looks_like_app_directory?(dir)
+		return AppFinder.looks_like_app_directory?(dir)
+	end
+	
+	def filename_to_server_names(filename)
+		basename = File.basename(filename)
+		names = [basename]
+		if basename !~ /^www\.$/i
+			names << "www.#{basename}"
+		end
+		return names
+	end
+	
+	# Wait until the given IO becomes readable, or until the timeout has
+	# been reached. Returns true if the IO became readable, false if the
+	# timeout has been reached.
+	def wait_on_io(io, timeout)
+		return !!select([io], nil, nil, timeout)
+	end
+end
+
+end # module Standalone
+end # module PhusionPassenger

data/lib/phusion_passenger/standalone/command.rb

@@ -0,0 +1,237 @@
+#  Phusion Passenger - http://www.modrails.com/
+#  Copyright (c) 2010 Phusion
+#
+#  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
+#
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in
+#  all copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#  THE SOFTWARE.
+require 'optparse'
+require 'phusion_passenger'
+require 'phusion_passenger/standalone/utils'
+
+module PhusionPassenger
+module Standalone
+
+class Command
+	DEFAULT_OPTIONS = {
+		:address       => '0.0.0.0',
+		:port          => 3000,
+		:env           => ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development',
+		:max_pool_size => 6,
+		:min_instances => 1,
+		:spawn_method  => 'smart-lv2',
+		:nginx_version => PREFERRED_NGINX_VERSION
+	}.freeze
+	
+	include Utils
+	
+	def self.show_in_command_list
+		return true
+	end
+	
+	def self.description
+		return nil
+	end
+	
+	def initialize(args)
+		@args = args.dup
+		@original_args = args.dup
+		@options = DEFAULT_OPTIONS.dup
+	end
+
+private
+	def require_daemon_controller
+		if !defined?(DaemonController)
+			begin
+				require 'daemon_controller'
+				begin
+					require 'daemon_controller/version'
+					too_old = DaemonController::VERSION_STRING < '0.2.5'
+				rescue LoadError
+					too_old = true
+				end
+				if too_old
+					error "Your version of daemon_controller is too old. " <<
+					      "You must install 0.2.5 or later. Please upgrade:\n\n" <<
+					      
+					      " sudo gem uninstall FooBarWidget-daemon_controller\n" <<
+					      " sudo gem install daemon_controller"
+					exit 1
+				end
+			rescue LoadError
+				error "Please install daemon_controller first:\n\n" <<
+				      " sudo gem install daemon_controller"
+				exit 1
+			end
+		end
+	end
+	
+	def require_erb
+		require 'erb' unless defined?(ERB)
+	end
+	
+	def require_optparse
+		require 'optparse' unless defined?(OptionParser)
+	end
+	
+	def require_app_finder
+		require 'phusion_passenger/standalone/app_finder' unless defined?(AppFinder)
+	end
+	
+	def debugging?
+		return ENV['PASSENGER_DEBUG'] && !ENV['PASSENGER_DEBUG'].empty?
+	end
+	
+	def parse_options!(command_name, description = nil)
+		help = false
+		
+		global_config_file = File.join(ENV['HOME'], LOCAL_DIR, "standalone", "config")
+		if File.exist?(global_config_file)
+			require 'phusion_passenger/standalone/config_file' unless defined?(ConfigFile)
+			global_options = ConfigFile.new(:global_config, global_config_file).options
+			@options.merge!(global_options)
+		end
+		
+		require_optparse
+		parser = OptionParser.new do |opts|
+			opts.banner = "Usage: passenger #{command_name} [options]"
+			opts.separator description if description
+			opts.separator " "
+			opts.separator "Options:"
+			yield opts
+			opts.on("-h", "--help", "Show this help message") do
+				help = true
+			end
+		end
+		parser.parse!(@args)
+		if help
+			puts parser
+			exit 0
+		end
+	end
+	
+	def error(message)
+		if message =~ /\n/
+			STDERR.puts("*** ERROR ***\n" << wrap_desc(message, 80, 0))
+		else
+			STDERR.puts(wrap_desc("*** ERROR: #{message}", 80, 0))
+		end
+		@plugin.call_hook(:error, message) if @plugin
+	end
+	
+	# Word wrap the given option description text so that it is formatted
+	# nicely in the --help output.
+	def wrap_desc(description_text, max_width = 43, newline_prefix_size = 37)
+		line_prefix = "\n" << (' ' * newline_prefix_size)
+		result = description_text.gsub(/(.{1,#{max_width}})( +|$\n?)|(.{1,#{max_width}})/, "\\1\\3#{line_prefix}")
+		result.strip!
+		return result
+	end
+	
+	def determine_various_resource_locations(create_subdirs = true)
+		require_app_finder
+		if @options[:socket_file]
+			pid_basename = "passenger.pid"
+			log_basename = "passenger.log"
+		else
+			pid_basename = "passenger.#{@options[:port]}.pid"
+			log_basename = "passenger.#{@options[:port]}.log"
+		end
+		if @args.empty?
+			if AppFinder.looks_like_app_directory?(".")
+				@options[:pid_file] ||= File.expand_path("tmp/pids/#{pid_basename}")
+				@options[:log_file] ||= File.expand_path("log/#{log_basename}")
+				if create_subdirs
+					ensure_directory_exists(File.dirname(@options[:pid_file]))
+					ensure_directory_exists(File.dirname(@options[:log_file]))
+				end
+			else
+				@options[:pid_file] ||= File.expand_path(pid_basename)
+				@options[:log_file] ||= File.expand_path(log_basename)
+			end
+		else
+			@options[:pid_file] ||= File.expand_path(File.join(@args[0], pid_basename))
+			@options[:log_file] ||= File.expand_path(File.join(@args[0], log_basename))
+		end
+	end
+	
+	def write_nginx_config_file
+		File.open(@config_filename, 'w') do |f|
+			f.chmod(0644)
+			template_filename = File.join(TEMPLATES_DIR, "standalone", "config.erb")
+			require_erb
+			erb = ERB.new(File.read(template_filename))
+			
+			if debugging?
+				passenger_root = SOURCE_ROOT
+			else
+				passenger_root = passenger_support_files_dir
+			end
+			# The template requires some helper methods which are defined in start_command.rb.
+			output = erb.result(binding)
+			f.write(output)
+			puts output if debugging?
+		end
+	end
+	
+	def determine_nginx_start_command
+		if @options[:nginx_bin]
+			nginx_bin = @options[:nginx_bin]
+		else
+			nginx_bin = "#{nginx_dir}/sbin/nginx"
+		end
+		return "#{nginx_bin} -c '#{@config_filename}'"
+	end
+	
+	# Returns the port on which to ping Nginx.
+	def nginx_ping_port
+		if @options[:ping_port]
+			return @options[:ping_port]
+		else
+			return @options[:port]
+		end
+	end
+	
+	def ping_nginx
+		require 'socket' unless defined?(UNIXSocket)
+		if @options[:socket_file]
+			UNIXSocket.new(@options[:socket_file])
+		else
+			TCPSocket.new(@options[:address], nginx_ping_port)
+		end
+	end
+	
+	def create_nginx_controller(extra_options = {})
+		require_daemon_controller
+		@config_filename = "/tmp/passenger-standalone.#{$$}.conf"
+		opts = {
+			:identifier    => 'Nginx',
+			:before_start  => method(:write_nginx_config_file),
+			:start_command => method(:determine_nginx_start_command),
+			:ping_command  => method(:ping_nginx),
+			:pid_file      => @options[:pid_file],
+			:log_file      => @options[:log_file],
+			:timeout       => 25
+		}
+		@nginx = DaemonController.new(opts.merge(extra_options))
+		@nginx_mutex = Mutex.new
+	end
+end
+
+end # module Standalone
+end # module PhusionPassenger

data/lib/phusion_passenger/standalone/config_file.rb

@@ -0,0 +1,119 @@
+#  Phusion Passenger - http://www.modrails.com/
+#  Copyright (c) 2010 Phusion
+#
+#  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
+#
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in
+#  all copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#  THE SOFTWARE.
+require 'erb'
+
+module PhusionPassenger
+module Standalone
+
+class ConfigFile
+	class DisallowedContextError < StandardError
+		attr_reader :filename
+		attr_reader :line
+		
+		def initialize(message, filename, line)
+			super(message)
+			@filename = filename
+			@line = line
+		end
+	end
+	
+	attr_reader :options
+	
+	def initialize(context, filename)
+		@options  = {}
+		@context  = context
+		@filename = filename
+		File.open(filename, 'r') do |f|
+			f.flock(File::LOCK_SH)
+			instance_eval(f.read, filename)
+		end
+	end
+	
+	def address(addr)
+		allowed_contexts(:port, :global_config)
+		@options[:address] = addr
+		@options[:tcp_explicitly_given] = true
+	end
+	
+	def port(number)
+		allowed_contexts(:port, :global_config)
+		@options[:port] = number
+		@options[:tcp_explicitly_given] = true
+	end
+	
+	def environment(name)
+		@options[:env] = name
+	end
+	
+	alias env environment
+	alias rails_env environment
+	alias rack_env environment
+	
+	def max_pool_size(number)
+		allowed_contexts(:max_pool_size, :global_config)
+		@options[:max_pool_size] = number
+	end
+	
+	def min_instances(number)
+		@options[:min_instances] = number
+	end
+	
+	def daemonize(on)
+		allowed_contexts(:daemonize, :global_config)
+		@options[:daemonize] = on
+	end
+	
+	def nginx_bin(filename)
+		allowed_contexts(:nginx_bin, :global_config)
+		@options[:nginx_bin] = filename
+	end
+	
+	def domain_name(name)
+		allowed_contexts(:domain_name, :local_config)
+		@options[:server_names] = [name]
+	end
+	
+	def domain_names(*names)
+		allowed_contexts(:domain_names, :local_config)
+		@options[:server_names] = names.to_a.flatten
+	end
+	
+	def analytics(value)
+		@options[:analytics] = value
+	end
+	
+	def debugger(value)
+		@options[:debugger] = value
+	end
+
+private
+	def allowed_contexts(option_name, *contexts)
+		if !contexts.include?(@context)
+			raise DisallowedContextError.new("The '#{option_name}' option may not be set in this config file.",
+				@filename, caller[1].split(':')[1].to_i)
+		end
+	end
+end
+
+end # module Standalone
+end # module PhusionPassenger