diff options
Diffstat (limited to 'actionpack')
| -rw-r--r-- | actionpack/CHANGELOG | 2 | ||||
| -rw-r--r-- | actionpack/lib/action_controller/dispatcher.rb | 183 | ||||
| -rw-r--r-- | actionpack/test/abstract_unit.rb | 3 | ||||
| -rw-r--r-- | actionpack/test/controller/dispatcher_test.rb | 115 |
4 files changed, 302 insertions, 1 deletions
diff --git a/actionpack/CHANGELOG b/actionpack/CHANGELOG index bd5e99ab16..9bfa90dfd9 100644 --- a/actionpack/CHANGELOG +++ b/actionpack/CHANGELOG @@ -1,5 +1,7 @@ *SVN* +* Move Railties' Dispatcher to ActionController::Dispatcher, introduce before_ and after_dispatch callbacks, and warm up to non-CGI requests. [Jeremy Kemper] + * The tag helper may bypass escaping. [Jeremy Kemper] * Cache asset ids. [Jeremy Kemper] diff --git a/actionpack/lib/action_controller/dispatcher.rb b/actionpack/lib/action_controller/dispatcher.rb new file mode 100644 index 0000000000..e06c2ebe36 --- /dev/null +++ b/actionpack/lib/action_controller/dispatcher.rb @@ -0,0 +1,183 @@ +module ActionController + # Dispatches requests to the appropriate controller and takes care of + # reloading the app after each request when Dependencies.load? is true. + class Dispatcher + class << self + # Backward-compatible class method takes CGI-specific args. Deprecated + # in favor of Dispatcher.new(output, request, response).dispatch! + def dispatch(cgi = nil, session_options = CgiRequest::DEFAULT_SESSION_OPTIONS, output = $stdout) + new(output).dispatch_cgi(cgi, session_options) + end + + # Declare a block to be called before each dispatch. + # Run in the order declared. + def before_dispatch(*method_names, &block) + callbacks[:before].concat method_names + callbacks[:before] << block if block_given? + end + + # Declare a block to be called after each dispatch. + # Run in reverse of the order declared. + def after_dispatch(*method_names, &block) + callbacks[:after].concat method_names + callbacks[:after] << block if block_given? + end + + # Add a preparation callback. Preparation callbacks are run before every + # request in development mode, and before the first request in production + # mode. + # + # An optional identifier may be supplied for the callback. If provided, + # to_prepare may be called again with the same identifier to replace the + # existing callback. Passing an identifier is a suggested practice if the + # code adding a preparation block may be reloaded. + def to_prepare(identifier = nil, &block) + # Already registered: update the existing callback + if identifier + if callback = callbacks[:prepare].assoc(identifier) + callback[1] = block + else + callbacks[:prepare] << [identifier, block] + end + else + callbacks[:prepare] << block + end + end + + # If the block raises, send status code as a last-ditch response. + def failsafe_response(fallback_output, status, originating_exception = nil) + yield + rescue Exception => exception + begin + log_failsafe_exception(status, originating_exception || exception) + body = failsafe_response_body(status) + fallback_output.write "Status: #{status}\r\nContent-Type: text/html\r\n\r\n#{body}" + nil + rescue Exception => failsafe_error # Logger or IO errors + $stderr.puts "Error during failsafe response: #{failsafe_error}" + $stderr.puts "(originally #{originating_exception})" if originating_exception + end + end + + private + def failsafe_response_body(status) + error_path = "#{error_file_path}/#{status.to_s[0..3]}.html" + + if File.exist?(error_path) + File.read(error_path) + else + "<html><body><h1>#{status}</h1></body></html>" + end + end + + def log_failsafe_exception(status, exception) + message = "/!\ FAILSAFE /!\ #{Time.now}\n Status: #{status}\n" + message << " #{exception}\n #{exception.backtrace.join("\n ")}" if exception + failsafe_logger.fatal message + end + + def failsafe_logger + if defined?(::RAILS_DEFAULT_LOGGER) && !::RAILS_DEFAULT_LOGGER.nil? + ::RAILS_DEFAULT_LOGGER + else + Logger.new($stderr) + end + end + end + + cattr_accessor :error_file_path + self.error_file_path = "#{::RAILS_ROOT}/public" if defined? ::RAILS_ROOT + + cattr_accessor :callbacks + self.callbacks = Hash.new { |h, k| h[k] = [] } + + attr_accessor_with_default :unprepared, true + + + before_dispatch :reload_application + before_dispatch :prepare_application + after_dispatch :flush_logger + after_dispatch :cleanup_application + + def initialize(output, request = nil, response = nil) + @output, @request, @response = output, request, response + end + + def dispatch + run_callbacks :before + handle_request + rescue Exception => exception + failsafe_rescue exception + ensure + run_callbacks :after, :reverse_each + end + + def dispatch_cgi(cgi, session_options) + if cgi ||= self.class.failsafe_response(@output, '400 Bad Request') { CGI.new } + @request = CgiRequest.new(cgi, session_options) + @response = CgiResponse.new(cgi) + dispatch + end + rescue Exception => exception + failsafe_rescue exception + end + + def reload_application + if Dependencies.load? + Routing::Routes.reload + self.unprepared = true + end + end + + def prepare_application(force = false) + require_dependency 'application' unless defined?(::ApplicationController) + ActiveRecord::Base.verify_active_connections! if defined?(ActiveRecord) + + if unprepared || force + run_callbacks :prepare + self.unprepared = false + end + end + + # Cleanup the application by clearing out loaded classes so they can + # be reloaded on the next request without restarting the server. + def cleanup_application(force = false) + if Dependencies.load? || force + ActiveRecord::Base.reset_subclasses if defined?(ActiveRecord) + Dependencies.clear + ActiveRecord::Base.clear_reloadable_connections! if defined?(ActiveRecord) + end + end + + def flush_logger + RAILS_DEFAULT_LOGGER.flush if defined?(RAILS_DEFAULT_LOGGER) && RAILS_DEFAULT_LOGGER.respond_to?(:flush) + end + + protected + def handle_request + @controller = Routing::Routes.recognize(@request) + @controller.process(@request, @response).out(@output) + end + + def run_callbacks(kind, enumerator = :each) + callbacks[kind].send(enumerator) do |callback| + case callback + when Proc; callback.call(self) + when String, Symbol; send(callback) + when Array; callback[1].call(self) + else raise ArgumentError, "Unrecognized callback #{callback.inspect}" + end + end + end + + def failsafe_rescue(exception) + self.class.failsafe_response(@output, '500 Internal Server Error', exception) do + if @controller ||= defined?(::ApplicationController) ? ::ApplicationController : Base + @controller.process_with_exception(@request, @response, exception).out(@output) + else + raise exception + end + end + end + end +end diff --git a/actionpack/test/abstract_unit.rb b/actionpack/test/abstract_unit.rb index e47570823f..700bc1f5e3 100644 --- a/actionpack/test/abstract_unit.rb +++ b/actionpack/test/abstract_unit.rb @@ -30,6 +30,7 @@ def uses_mocha(test_name) require 'stubba' end yield -rescue LoadError +rescue LoadError => load_error + raise unless load_error.message =~ /mocha/i $stderr.puts "Skipping #{test_name} tests. `gem install mocha` and try again." end diff --git a/actionpack/test/controller/dispatcher_test.rb b/actionpack/test/controller/dispatcher_test.rb new file mode 100644 index 0000000000..f2bc091a72 --- /dev/null +++ b/actionpack/test/controller/dispatcher_test.rb @@ -0,0 +1,115 @@ +require "#{File.dirname(__FILE__)}/../abstract_unit" + +uses_mocha 'dispatcher tests' do + +require 'action_controller/dispatcher' + +class DispatcherTest < Test::Unit::TestCase + Dispatcher = ActionController::Dispatcher + + def setup + @output = StringIO.new + ENV['REQUEST_METHOD'] = 'GET' + + Dispatcher.callbacks[:prepare].clear + @dispatcher = Dispatcher.new(@output) + end + + def teardown + ENV['REQUEST_METHOD'] = nil + end + + def test_clears_dependencies_after_dispatch_if_in_loading_mode + Dependencies.stubs(:load?).returns(true) + + ActionController::Routing::Routes.expects(:reload).once + Dependencies.expects(:clear).once + + dispatch + end + + def test_leaves_dependencies_after_dispatch_if_not_in_loading_mode + Dependencies.stubs(:load?).returns(false) + + ActionController::Routing::Routes.expects(:reload).never + Dependencies.expects(:clear).never + + dispatch + end + + def test_failsafe_response + CGI.expects(:new).raises('some multipart parsing failure') + + ActionController::Routing::Routes.stubs(:reload) + Dispatcher.stubs(:log_failsafe_exception) + + assert_nothing_raised { dispatch } + + assert_equal "Status: 400 Bad Request\r\nContent-Type: text/html\r\n\r\n<html><body><h1>400 Bad Request</h1></body></html>", @output.string + end + + def test_reload_application_sets_unprepared_if_loading_dependencies + Dependencies.stubs(:load?).returns(false) + ActionController::Routing::Routes.expects(:reload).never + @dispatcher.unprepared = false + @dispatcher.send(:reload_application) + assert !@dispatcher.unprepared + + Dependencies.stubs(:load?).returns(true) + ActionController::Routing::Routes.expects(:reload).once + @dispatcher.send(:reload_application) + assert @dispatcher.unprepared + end + + def test_prepare_application_runs_callbacks_if_unprepared + a = b = c = nil + Dispatcher.to_prepare { a = b = c = 1 } + Dispatcher.to_prepare { b = c = 2 } + Dispatcher.to_prepare { c = 3 } + + # Skip the callbacks when already prepared. + @dispatcher.unprepared = false + @dispatcher.send :prepare_application + assert_nil a || b || c + + # Perform the callbacks when unprepared. + @dispatcher.unprepared = true + @dispatcher.send :prepare_application + assert_equal 1, a + assert_equal 2, b + assert_equal 3, c + + # But when not :load, make sure they are only run once + a = b = c = nil + @dispatcher.send :prepare_application + assert_nil a || b || c + end + + def test_to_prepare_with_identifier_replaces + a = b = nil + Dispatcher.to_prepare(:unique_id) { a = b = 1 } + Dispatcher.to_prepare(:unique_id) { a = 2 } + + @dispatcher.unprepared = true + @dispatcher.send :prepare_application + assert_equal 2, a + assert_equal nil, b + end + + private + def dispatch(output = @output) + controller = mock + controller.stubs(:process).returns(controller) + controller.stubs(:out).with(output).returns('response') + + ActionController::Routing::Routes.stubs(:recognize).returns(controller) + + Dispatcher.dispatch(nil, {}, output) + end + + def assert_subclasses(howmany, klass, message = klass.subclasses.inspect) + assert_equal howmany, klass.subclasses.size, message + end +end + +end |