passenger 2.2.15 → 3.0.0.pre1

data/lib/phusion_passenger/utils/file_system_watcher.rb

@@ -0,0 +1,186 @@
+#  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/native_support'
+
+module PhusionPassenger
+module Utils
+
+# Watches changes on one or more files or directories. To use this class,
+# construct an object, passing it file or directory names to watch, then
+# call #wait_for_change. #wait_for_change waits until one of the following
+# events has happened since the constructor was called:
+#
+# - One of the specified files has been renamed, deleted, or its access
+#   revoked. This will cause +true+ to be returned.
+# - One of the specified directories has been modified, renamed, deleted,
+#   or its access revoked. This will cause +true+ to be returned.
+# - +termination_pipe+ (as passed to the constructor) becomes readable.
+#   This will cause +nil+ to be returned.
+# - The thread is interrupted. This will cause +nil+ to be returned.
+# 
+# The constructor will attempt to stat and possible also open all specified
+# files/directories. If one of them cannot be statted or opened, then
+# +false+ will be returned by #wait_for_change.
+#
+# #wait_for_change may only be called once. After calling it one should
+# create a new object if one wishes to watch the filesystem again.
+#
+# Always call #close when a FileSystemWatcher object is no longer needed
+# in order to free resources.
+#
+# This class tries to use kqueue for efficient filesystem watching on
+# platforms that support it. On other platforms it'll fallback to stat
+# polling instead.
+
+if defined?(NativeSupport::FileSystemWatcher)
+	FileSystemWatcher = NativeSupport::FileSystemWatcher
+	
+	FileSystemWatcher.class_eval do
+		def self.new(filenames, termination_pipe = nil)
+			# Default parameter values, type conversion and exception
+			# handling in C is too much of a pain.
+			filenames = filenames.map do |filename|
+				filename.to_s
+			end
+			return _new(filenames, termination_pipe)
+		end
+		
+		def self.opens_files?
+			return true
+		end
+	end
+else
+	class FileSystemWatcher
+		attr_accessor :poll_interval
+		
+		def self.opens_files?
+			return false
+		end
+		
+		def initialize(filenames, termination_pipe = nil)
+			@poll_interval = 3
+			@termination_pipe = termination_pipe
+			@dirs  = []
+			@files = []
+		
+			begin
+				filenames.each do |filename|
+					stat = File.stat(filename)
+					if stat.directory?
+						@dirs << DirInfo.new(filename, stat)
+					else
+						@files << FileInfo.new(filename, stat)
+					end
+				end
+			rescue Errno::EACCES, Errno::ENOENT
+				@dirs = @files = nil
+			end
+		end
+		
+		def wait_for_change
+			if !@dirs
+				return false
+			end
+			
+			while true
+				if changed?
+					return true
+				elsif select([@termination_pipe], nil, nil, @poll_interval)
+					return nil
+				end
+			end
+		end
+	
+		def close
+		end
+		
+	private
+		class DirInfo
+			DOT    = "."
+			DOTDOT = ".."
+			
+			def initialize(filename, stat)
+				@filename = filename
+				@stat = stat
+				@subfiles = {}
+				Dir.foreach(filename) do |entry|
+					next if entry == DOT || entry == DOTDOT
+					subfilename = "#{filename}/#{entry}"
+					@subfiles[entry] = FileInfo.new(subfilename, File.stat(subfilename))
+				end
+			end
+			
+			def changed?
+				new_stat = File.stat(@filename)
+				if @stat.ino != new_stat.ino || !new_stat.directory? || @stat.mtime != new_stat.mtime
+					return true
+				end
+				
+				count = 0
+				Dir.foreach(@filename) do |entry|
+					next if entry == DOT || entry == DOTDOT
+					subfilename = "#{@filename}/#{entry}"
+				
+					file_info = @subfiles[entry]
+					if !file_info || file_info.changed?(false)
+						return true
+					else
+						count += 1
+					end
+				end
+				
+				return count != @subfiles.size
+			rescue Errno::EACCES, Errno::ENOENT
+				return true
+			end
+		end
+		
+		class FileInfo
+			def initialize(filename, stat)
+				@filename = filename
+				@stat = stat
+			end
+			
+			def changed?(check_mtime = true)
+				new_stat = File.stat(@filename)
+				if check_mtime
+					mtime_changed = @stat.mtime != new_stat.mtime || @stat.size != new_stat.size
+				else
+					mtime_changed = false
+				end
+				return @stat.ino != new_stat.ino || @stat.ftype != new_stat.ftype || mtime_changed
+			rescue Errno::EACCES, Errno::ENOENT
+				return true
+			end
+		end
+		
+		def changed?
+			return @dirs.any?  { |dir_info| dir_info.changed? } ||
+			       @files.any? { |file_info| file_info.changed? }
+		end
+	end
+end
+
+end # module Utils
+end # module PhusionPassenger

data/lib/phusion_passenger/utils/hosts_file_parser.rb

@@ -0,0 +1,130 @@
+# encoding: binary
+#  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.
+
+module PhusionPassenger
+module Utils
+
+# A /etc/hosts parser. Also supports writing groups of data to the file.
+class HostsFileParser
+	def self.flush_dns_cache!
+		if RUBY_PLATFORM =~ /darwin/
+			system("dscacheutil -flushcache")
+		end
+	end
+	
+	def initialize(filename_or_io = "/etc/hosts")
+		if filename_or_io.respond_to?(:readline)
+			read_and_parse(filename_or_io)
+		else
+			File.open(filename_or_io, "rb") do |f|
+				read_and_parse(f)
+			end
+		end
+	end
+	
+	def ip_count
+		return @ips.size
+	end
+	
+	def host_count
+		return @host_names.size
+	end
+	
+	def resolve(host_name)
+		if host_name.downcase == "localhost"
+			return "127.0.0.1"
+		else
+			return @host_names[host_name.downcase]
+		end
+	end
+	
+	def resolves_to_localhost?(hostname)
+		ip = resolve(hostname)
+		return ip == "127.0.0.1" || ip == "::1" || ip == "0.0.0.0"
+	end
+	
+	def add_group_data(marker, data)
+		begin_index = find_line(0, "###### BEGIN #{marker} ######")
+		end_index = find_line(begin_index + 1, "###### END #{marker} ######") if begin_index
+		if begin_index && end_index
+			@lines[begin_index + 1 .. end_index - 1] = data.split("\n")
+		else
+			@lines << "###### BEGIN #{marker} ######"
+			@lines.concat(data.split("\n"))
+			@lines << "###### END #{marker} ######"
+		end
+	end
+	
+	def write(io)
+		@lines.each do |line|
+			io.puts(line)
+		end
+	end
+
+private
+	def read_and_parse(io)
+		lines = []
+		ips = {}
+		all_host_names = {}
+		while !io.eof?
+			line = io.readline
+			line.sub!(/\n\Z/m, '')
+			lines << line
+			ip, host_names = parse_line(line)
+			if ip
+				ips[ip] ||= []
+				ips[ip].concat(host_names)
+				host_names.each do |host_name|
+					all_host_names[host_name.downcase] = ip
+				end
+			end
+		end
+		@lines      = lines
+		@ips        = ips
+		@host_names = all_host_names
+	end
+	
+	def parse_line(line)
+		return nil if line =~ /^[\s\t]*#/
+		line = line.strip
+		return nil if line.empty?
+		ip, *host_names = line.split(/[ \t]+/)
+		return [ip, host_names]
+	end
+	
+	def find_line(start_index, content)
+		i = start_index
+		while i < @lines.size
+			if @lines[i] == content
+				return i
+			else
+				i += 1
+			end
+		end
+		return nil
+	end
+end
+
+end
+end

data/lib/phusion_passenger/utils/tmpdir.rb

@@ -0,0 +1,70 @@
+#  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.
+
+module PhusionPassenger
+
+module Utils
+protected
+	@@passenger_tmpdir = nil
+	
+	def passenger_tmpdir(create = true)
+		PhusionPassenger::Utils.passenger_tmpdir(create)
+	end
+	
+	# Returns the directory in which to store Phusion Passenger-specific
+	# temporary files. If +create+ is true, then this method creates the
+	# directory if it doesn't exist.
+	def self.passenger_tmpdir(create = true)
+		dir = @@passenger_tmpdir
+		if dir.nil? || dir.empty?
+			tmpdir = "/tmp"
+			["PASSENGER_TEMP_DIR", "PASSENGER_TMPDIR"].each do |name|
+				if ENV.has_key?(name) && !ENV[name].empty?
+					tmpdir = ENV[name]
+					break
+				end
+			end
+			dir = "#{tmpdir}/passenger.1.0.#{Process.pid}"
+			dir.gsub!(%r{//+}, '/')
+			@@passenger_tmpdir = dir
+		end
+		if create && !File.exist?(dir)
+			# This is a very minimal implementation of the subdirectory
+			# creation logic in ServerInstanceDir.h. This implementation
+			# is only meant to make the unit tests pass. For production
+			# systems one should pre-create the temp directory with
+			# ServerInstanceDir.h.
+			system("mkdir", "-p", "-m", "u=rwxs,g=rwx,o=rwx", dir)
+			system("mkdir", "-p", "-m", "u=rwxs,g=rwx,o=rwx", "#{dir}/generation-0")
+			system("mkdir", "-p", "-m", "u=rwxs,g=rwx,o=rwx", "#{dir}/backends")
+			system("mkdir", "-p", "-m", "u=rwxs,g=rwx,o=rwx", "#{dir}/spawn-server")
+		end
+		return dir
+	end
+	
+	def self.passenger_tmpdir=(dir)
+		@@passenger_tmpdir = dir
+	end
+end
+
+end

data/lib/phusion_passenger/utils/unseekable_socket.rb

@@ -0,0 +1,196 @@
+#  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'   # So that we can know whether #writev is supported.
+
+module PhusionPassenger
+module Utils
+
+# Some frameworks (e.g. Merb) call _seek_ and _rewind_ on the input stream
+# if it responds to these methods. In case of Phusion Passenger, the input
+# stream is a socket, and altough socket objects respond to _seek_ and
+# _rewind_, calling these methods will raise an exception. We don't want
+# this to happen so in AbstractRequestHandler we wrap the client socket
+# into an UnseekableSocket wrapper, which doesn't respond to these methods.
+#
+# We used to dynamically undef _seek_ and _rewind_ on sockets, but this
+# blows the Ruby interpreter's method cache and made things slower.
+# Wrapping a socket is faster despite extra method calls.
+#
+# Furthermore, all exceptions originating from the wrapped socket will
+# be annotated. One can check whether a certain exception originates
+# from the wrapped socket by calling #source_of_exception?
+class UnseekableSocket
+	def self.wrap(socket)
+		return new.wrap(socket)
+	end
+	
+	def wrap(socket)
+		# Some people report that sometimes their Ruby (MRI/REE)
+		# processes get stuck with 100% CPU usage. Upon further
+		# inspection with strace, it turns out that these Ruby
+		# processes are continuously calling lseek() on a socket,
+		# which of course returns ESPIPE as error. gdb reveals
+		# lseek() is called by fwrite(), which in turn is called
+		# by rb_fwrite(). The affected socket is the
+		# AbstractRequestHandler client socket.
+		#
+		# I inspected the MRI source code and didn't find
+		# anything that would explain this behavior. This makes
+		# me think that it's a glibc bug, but that's very
+		# unlikely.
+		#
+		# The rb_fwrite() implementation takes an entirely
+		# different code path if I set 'sync' to true: it will
+		# skip fwrite() and use write() instead. So here we set
+		# 'sync' to true in the hope that this will work around
+		# the problem.
+		socket.sync = true
+		
+		# There's no need to set the encoding for Ruby 1.9 because
+		# abstract_request_handler.rb is tagged with 'encoding: binary'.
+		
+		@socket = socket
+		
+		return self
+	end
+	
+	# Don't allow disabling of sync.
+	def sync=(value)
+	end
+	
+	# Socket is sync'ed so flushing shouldn't do anything.
+	def flush
+	end
+	
+	# Already set to binary mode.
+	def binmode
+	end
+	
+	def to_io
+		self
+	end
+	
+	def addr
+		@socket.addr
+	rescue => e
+		raise annotate(e)
+	end
+	
+	def write(string)
+		@socket.write(string)
+	rescue => e
+		raise annotate(e)
+	end
+	
+	def writev(components)
+		@socket.writev(components)
+	rescue => e
+		raise annotate(e)
+	end if IO.method_defined?(:writev)
+	
+	def writev2(components, components2)
+		@socket.writev2(components, components2)
+	rescue => e
+		raise annotate(e)
+	end if IO.method_defined?(:writev2)
+	
+	def writev3(components, components2, components3)
+		@socket.writev3(components, components2, components3)
+	rescue => e
+		raise annotate(e)
+	end if IO.method_defined?(:writev3)
+	
+	def puts(*args)
+		@socket.puts(*args)
+	rescue => e
+		raise annotate(e)
+	end
+	
+	def gets
+		@socket.gets
+	rescue => e
+		raise annotate(e)
+	end
+	
+	def read(*args)
+		@socket.read(*args)
+	rescue => e
+		raise annotate(e)
+	end
+	
+	def readpartial(*args)
+		@socket.readpartial(*args)
+	rescue => e
+		raise annotate(e)
+	end
+	
+	def readline
+		@socket.readline
+	rescue => e
+		raise annotate(e)
+	end
+	
+	def each(&block)
+		@socket.each(&block)
+	rescue => e
+		raise annotate(e)
+	end
+	
+	def closed?
+		@socket.closed?
+	rescue => e
+		raise annotate(e)
+	end
+	
+	def close
+		@socket.close
+	rescue => e
+		raise annotate(e)
+	end
+	
+	def close_read
+		@socket.close_read
+	rescue => e
+		raise annotate(e)
+	end
+	
+	def close_write
+		@socket.close_write
+	rescue => e
+		raise annotate(e)
+	end
+	
+	def source_of_exception?(exception)
+		return exception.instance_variable_get(:"@from_unseekable_socket") == @socket.object_id
+	end
+
+private
+	def annotate(exception)
+		exception.instance_variable_set(:"@from_unseekable_socket", @socket.object_id)
+		return exception
+	end
+end
+
+end # module Utils
+end # module PhusionPassenger