rails--rails/actionpack/lib/action_dispatch/middleware/show_exceptions.rb

require 'action_dispatch/http/request'
require 'action_dispatch/middleware/exception_wrapper'
require 'active_support/deprecation'

module ActionDispatch
  # This middleware rescues any exception returned by the application
  # and wraps them in a format for the end user.
  class ShowExceptions
    RESCUES_TEMPLATE_PATH = File.join(File.dirname(__FILE__), 'templates')

    FAILSAFE_RESPONSE = [500, {'Content-Type' => 'text/html'},
      ["<html><body><h1>500 Internal Server Error</h1>" <<
       "If you are the administrator of this website, then please read this web " <<
       "application's log file and/or the web server's log file to find out what " <<
       "went wrong.</body></html>"]]

    class << self
      def rescue_responses
        ActiveSupport::Deprecation.warn "ActionDispatch::ShowExceptions.rescue_responses is deprecated. " \
          "Please configure your exceptions using a railtie or in your application config instead."
        ExceptionWrapper.rescue_responses
      end

      def rescue_templates
        ActiveSupport::Deprecation.warn "ActionDispatch::ShowExceptions.rescue_templates is deprecated. " \
          "Please configure your exceptions using a railtie or in your application config instead."
        ExceptionWrapper.rescue_templates
      end
    end

    def initialize(app, consider_all_requests_local = nil)
      ActiveSupport::Deprecation.warn "Passing consider_all_requests_local option to ActionDispatch::ShowExceptions middleware no longer works" unless consider_all_requests_local.nil?
      @app = app
    end

    def call(env)
      begin
        response  = @app.call(env)
      rescue Exception => exception
        raise exception if env['action_dispatch.show_exceptions'] == false
      end

      response || render_exception_with_failsafe(env, exception)
    end

    private

    # Define this method because some plugins were monkey patching it.
    # Remove this after 3.2 is out with the other deprecations in this class.
    def status_code(*)
    end

    def render_exception_with_failsafe(env, exception)
      render_exception(env, exception)
    rescue Exception => failsafe_error
      $stderr.puts "Error during failsafe response: #{failsafe_error}\n  #{failsafe_error.backtrace * "\n  "}"
      FAILSAFE_RESPONSE
    end

    def render_exception(env, exception)
      wrapper = ExceptionWrapper.new(env, exception)

      status      = wrapper.status_code
      locale_path = "#{public_path}/#{status}.#{I18n.locale}.html" if I18n.locale
      path        = "#{public_path}/#{status}.html"

      if locale_path && File.exist?(locale_path)
        render(status, File.read(locale_path))
      elsif File.exist?(path)
        render(status, File.read(path))
      else
        render(status, '')
      end
    end

    def render(status, body)
      [status, {'Content-Type' => "text/html; charset=#{Response.default_charset}", 'Content-Length' => body.bytesize.to_s}, [body]]
    end

    # TODO: Make this a middleware initialization parameter once
    # we removed the second option (which is deprecated)
    def public_path
      defined?(Rails.public_path) ? Rails.public_path : 'public_path'
    end
  end
end
All AD modules are "deferrable" 2009-12-22 18:11:21 -05:00			`require 'action_dispatch/http/request'`
Add an ExceptionWrapper that wraps an exception and provide convenience helpers. 2011-12-01 14:02:00 -05:00			`require 'action_dispatch/middleware/exception_wrapper'`
deprecation warning, changelog entry 2011-11-22 09:36:58 -05:00			`require 'active_support/deprecation'`
ActionPack components should no longer have undeclared dependencies. * Tests can be run in isolation * Dependencies added * A few tests modified to avoid depending on AS deps not depended on my files they were testing 2009-06-08 16:33:18 -04:00
Extract ActionController rescue templates into Rescue and ShowExceptions middleware. This commit breaks all exception catching plugins like ExceptionNotifier. These plugins should be rewritten as middleware instead overriding Controller#rescue_action_in_public. 2009-05-03 00:02:22 -04:00			`module ActionDispatch`
Split and improve show and debug exceptions middlewares. 2011-12-01 15:15:42 -05:00			`# This middleware rescues any exception returned by the application`
			`# and wraps them in a format for the end user.`
Extract ActionController rescue templates into Rescue and ShowExceptions middleware. This commit breaks all exception catching plugins like ExceptionNotifier. These plugins should be rewritten as middleware instead overriding Controller#rescue_action_in_public. 2009-05-03 00:02:22 -04:00			`class ShowExceptions`
Merge Failsafe middleware into ShowExceptions 2009-05-17 13:24:42 -04:00			`RESCUES_TEMPLATE_PATH = File.join(File.dirname(__FILE__), 'templates')`

			`FAILSAFE_RESPONSE = [500, {'Content-Type' => 'text/html'},`
Make the default 500 Internal Server Error page more friendly. Many people don't know they're supposed to look in the log files. [#2716 state:resolved] Signed-off-by: Joshua Peek <josh@joshpeek.com> 2009-05-27 16:01:03 -04:00			`["<html><body><h1>500 Internal Server Error</h1>" <<`
			`"If you are the administrator of this website, then please read this web " <<`
			`"application's log file and/or the web server's log file to find out what " <<`
			`"went wrong.</body></html>"]]`
Extract ActionController rescue templates into Rescue and ShowExceptions middleware. This commit breaks all exception catching plugins like ExceptionNotifier. These plugins should be rewritten as middleware instead overriding Controller#rescue_action_in_public. 2009-05-03 00:02:22 -04:00
Add a deprecation to old show exceptions API (even though it was not public). 2011-12-01 14:16:12 -05:00			`class << self`
			`def rescue_responses`
			`ActiveSupport::Deprecation.warn "ActionDispatch::ShowExceptions.rescue_responses is deprecated. " \`
			`"Please configure your exceptions using a railtie or in your application config instead."`
			`ExceptionWrapper.rescue_responses`
			`end`

			`def rescue_templates`
			`ActiveSupport::Deprecation.warn "ActionDispatch::ShowExceptions.rescue_templates is deprecated. " \`
			`"Please configure your exceptions using a railtie or in your application config instead."`
			`ExceptionWrapper.rescue_templates`
			`end`
			`end`

deprecation warning, changelog entry 2011-11-22 09:36:58 -05:00			`def initialize(app, consider_all_requests_local = nil)`
			`ActiveSupport::Deprecation.warn "Passing consider_all_requests_local option to ActionDispatch::ShowExceptions middleware no longer works" unless consider_all_requests_local.nil?`
Extract ActionController rescue templates into Rescue and ShowExceptions middleware. This commit breaks all exception catching plugins like ExceptionNotifier. These plugins should be rewritten as middleware instead overriding Controller#rescue_action_in_public. 2009-05-03 00:02:22 -04:00			`@app = app`
			`end`

			`def call(env)`
Refactor to handle the X-Cascade without having to raise an exception 2010-10-18 17:05:22 -04:00			`begin`
Split ShowExceptions responsibilities in two middlewares. 2011-12-01 14:46:18 -05:00			`response = @app.call(env)`
Refactor to handle the X-Cascade without having to raise an exception 2010-10-18 17:05:22 -04:00			`rescue Exception => exception`
reraising should be in the rescue block 2011-01-12 13:01:31 -05:00			`raise exception if env['action_dispatch.show_exceptions'] == false`
RouteSet does not raise ActionController::RoutingError when no routes match anymore. Instead, it follows the X-Cascade convention. ShowExceptions checks for X-Cascade so that the routing error page can still be displayed. 2010-04-30 19:40:42 -04:00			`end`
Refactor to handle the X-Cascade without having to raise an exception 2010-10-18 17:05:22 -04:00
Fix failing cascade exception. 2011-12-03 05:38:25 -05:00			`response \|\| render_exception_with_failsafe(env, exception)`
Merge Failsafe middleware into ShowExceptions 2009-05-17 13:24:42 -04:00			`end`
Merge branch 'master' into wip_abstract_controller Conflicts: actionpack/lib/action_controller/abstract/callbacks.rb actionpack/lib/action_controller/abstract/renderer.rb actionpack/lib/action_controller/base/base.rb actionpack/lib/action_controller/dispatch/dispatcher.rb actionpack/lib/action_controller/routing/route_set.rb actionpack/lib/action_controller/testing/process.rb actionpack/test/abstract_controller/layouts_test.rb actionpack/test/controller/filters_test.rb actionpack/test/controller/helper_test.rb actionpack/test/controller/render_test.rb actionpack/test/new_base/test_helper.rb 2009-05-11 20:07:05 -04:00
Merge Failsafe middleware into ShowExceptions 2009-05-17 13:24:42 -04:00			`private`
Extract ActionController rescue templates into Rescue and ShowExceptions middleware. This commit breaks all exception catching plugins like ExceptionNotifier. These plugins should be rewritten as middleware instead overriding Controller#rescue_action_in_public. 2009-05-03 00:02:22 -04:00
Try to play nice with plugins doing monkey patches. 2011-12-02 03:57:43 -05:00			`# Define this method because some plugins were monkey patching it.`
			`# Remove this after 3.2 is out with the other deprecations in this class.`
			`def status_code(*)`
			`end`

Split and improve show and debug exceptions middlewares. 2011-12-01 15:15:42 -05:00			`def render_exception_with_failsafe(env, exception)`
			`render_exception(env, exception)`
			`rescue Exception => failsafe_error`
			`$stderr.puts "Error during failsafe response: #{failsafe_error}\n #{failsafe_error.backtrace * "\n "}"`
			`FAILSAFE_RESPONSE`
			`end`

Split ShowExceptions responsibilities in two middlewares. 2011-12-01 14:46:18 -05:00			`def render_exception(env, exception)`
			`wrapper = ExceptionWrapper.new(env, exception)`
Extract ActionController rescue templates into Rescue and ShowExceptions middleware. This commit breaks all exception catching plugins like ExceptionNotifier. These plugins should be rewritten as middleware instead overriding Controller#rescue_action_in_public. 2009-05-03 00:02:22 -04:00
Split ShowExceptions responsibilities in two middlewares. 2011-12-01 14:46:18 -05:00			`status = wrapper.status_code`
			`locale_path = "#{public_path}/#{status}.#{I18n.locale}.html" if I18n.locale`
			`path = "#{public_path}/#{status}.html"`
Extract ActionController rescue templates into Rescue and ShowExceptions middleware. This commit breaks all exception catching plugins like ExceptionNotifier. These plugins should be rewritten as middleware instead overriding Controller#rescue_action_in_public. 2009-05-03 00:02:22 -04:00
Split ShowExceptions responsibilities in two middlewares. 2011-12-01 14:46:18 -05:00			`if locale_path && File.exist?(locale_path)`
			`render(status, File.read(locale_path))`
			`elsif File.exist?(path)`
			`render(status, File.read(path))`
			`else`
			`render(status, '')`
Extract ActionController rescue templates into Rescue and ShowExceptions middleware. This commit breaks all exception catching plugins like ExceptionNotifier. These plugins should be rewritten as middleware instead overriding Controller#rescue_action_in_public. 2009-05-03 00:02:22 -04:00			`end`
Split ShowExceptions responsibilities in two middlewares. 2011-12-01 14:46:18 -05:00			`end`
Extract ActionController rescue templates into Rescue and ShowExceptions middleware. This commit breaks all exception catching plugins like ExceptionNotifier. These plugins should be rewritten as middleware instead overriding Controller#rescue_action_in_public. 2009-05-03 00:02:22 -04:00
Split ShowExceptions responsibilities in two middlewares. 2011-12-01 14:46:18 -05:00			`def render(status, body)`
			`[status, {'Content-Type' => "text/html; charset=#{Response.default_charset}", 'Content-Length' => body.bytesize.to_s}, [body]]`
			`end`
middlewares should use logger from env 2011-11-24 14:37:48 -05:00
Split ShowExceptions responsibilities in two middlewares. 2011-12-01 14:46:18 -05:00			`# TODO: Make this a middleware initialization parameter once`
Split and improve show and debug exceptions middlewares. 2011-12-01 15:15:42 -05:00			`# we removed the second option (which is deprecated)`
Split ShowExceptions responsibilities in two middlewares. 2011-12-01 14:46:18 -05:00			`def public_path`
			`defined?(Rails.public_path) ? Rails.public_path : 'public_path'`
			`end`
Extract ActionController rescue templates into Rescue and ShowExceptions middleware. This commit breaks all exception catching plugins like ExceptionNotifier. These plugins should be rewritten as middleware instead overriding Controller#rescue_action_in_public. 2009-05-03 00:02:22 -04:00			`end`
			`end`