path: root/railties/lib/rails/application/configuration.rb

require 'active_support/core_ext/kernel/reporting'
require 'active_support/file_update_checker'
require 'rails/engine/configuration'
require 'rails/source_annotation_extractor'

require 'active_support/deprecation'
require 'active_support/core_ext/string/strip' # for strip_heredoc

module Rails
  class Application
    class Configuration < ::Rails::Engine::Configuration
      attr_accessor :allow_concurrency, :asset_host, :autoflush_log,
                    :cache_classes, :cache_store, :consider_all_requests_local, :console,
                    :eager_load, :exceptions_app, :file_watcher, :filter_parameters,
                    :force_ssl, :helpers_paths, :logger, :log_formatter, :log_tags,
                    :railties_order, :relative_url_root, :secret_key_base, :secret_token,
                    :ssl_options, :public_file_server,
                    :session_options, :time_zone, :reload_classes_only_on_change,
                    :beginning_of_week, :filter_redirect, :x, :enable_dependency_loading

      attr_writer :log_level
      attr_reader :encoding, :api_only, :static_cache_control

      def initialize(*)
        super
        self.encoding = "utf-8"
        @allow_concurrency               = nil
        @consider_all_requests_local     = false
        @filter_parameters               = []
        @filter_redirect                 = []
        @helpers_paths                   = []
        @public_file_server              = ActiveSupport::OrderedOptions.new
        @public_file_server.enabled      = true
        @public_file_server.index_name   = "index"
        @force_ssl                       = false
        @ssl_options                     = {}
        @session_store                   = nil
        @time_zone                       = "UTC"
        @beginning_of_week               = :monday
        @log_level                       = nil
        @generators                      = app_generators
        @cache_store                     = [ :file_store, "#{root}/tmp/cache/" ]
        @railties_order                  = [:all]
        @relative_url_root               = ENV["RAILS_RELATIVE_URL_ROOT"]
        @reload_classes_only_on_change   = true
        @file_watcher                    = ActiveSupport::FileUpdateChecker
        @exceptions_app                  = nil
        @autoflush_log                   = true
        @log_formatter                   = ActiveSupport::Logger::SimpleFormatter.new
        @eager_load                      = nil
        @secret_token                    = nil
        @secret_key_base                 = nil
        @api_only                        = false
        @debug_exception_response_format = nil
        @x                               = Custom.new
        @enable_dependency_loading       = false
      end

      def static_cache_control=(value)
        ActiveSupport::Deprecation.warn <<-eow.strip_heredoc
          `config.static_cache_control` is deprecated and will be removed in Rails 5.1.
          Please use
          `config.public_file_server.headers = { 'Cache-Control' => '#{value}' }`
          instead.
        eow

        @static_cache_control = value
      end

      def serve_static_files
        ActiveSupport::Deprecation.warn <<-eow.strip_heredoc
          `config.serve_static_files` is deprecated and will be removed in Rails 5.1.
          Please use `config.public_file_server.enabled` instead.
        eow

        @public_file_server.enabled
      end

      def serve_static_files=(value)
        ActiveSupport::Deprecation.warn <<-eow.strip_heredoc
          `config.serve_static_files` is deprecated and will be removed in Rails 5.1.
          Please use `config.public_file_server.enabled = #{value}` instead.
        eow

        @public_file_server.enabled = value
      end

      def encoding=(value)
        @encoding = value
        silence_warnings do
          Encoding.default_external = value
          Encoding.default_internal = value
        end
      end

      def api_only=(value)
        @api_only = value
        generators.api_only = value

        @debug_exception_response_format ||= :api
      end

      def debug_exception_response_format
        @debug_exception_response_format || :default
      end

      def debug_exception_response_format=(value)
        @debug_exception_response_format = value
      end

      def paths
        @paths ||= begin
          paths = super
          paths.add "config/database",    with: "config/database.yml"
          paths.add "config/secrets",     with: "config/secrets.yml"
          paths.add "config/environment", with: "config/environment.rb"
          paths.add "lib/templates"
          paths.add "log",                with: "log/#{Rails.env}.log"
          paths.add "public"
          paths.add "public/javascripts"
          paths.add "public/stylesheets"
          paths.add "tmp"
          paths
        end
      end

      # Loads and returns the entire raw configuration of database from
      # values stored in `config/database.yml`.
      def database_configuration
        path = paths["config/database"].existent.first
        yaml = Pathname.new(path) if path

        config = if yaml && yaml.exist?
          require "yaml"
          require "erb"
          YAML.load(ERB.new(yaml.read).result) || {}
        elsif ENV['DATABASE_URL']
          # Value from ENV['DATABASE_URL'] is set to default database connection
          # by Active Record.
          {}
        else
          raise "Could not load database configuration. No such file - #{paths["config/database"].instance_variable_get(:@paths)}"
        end

        config
      rescue Psych::SyntaxError => e
        raise "YAML syntax error occurred while parsing #{paths["config/database"].first}. " \
              "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
              "Error: #{e.message}"
      rescue => e
        raise e, "Cannot load `Rails.application.database_configuration`:\n#{e.message}", e.backtrace
      end

      def log_level
        @log_level ||= (Rails.env.production? ? :info : :debug)
      end

      def colorize_logging
        ActiveSupport::LogSubscriber.colorize_logging
      end

      def colorize_logging=(val)
        ActiveSupport::LogSubscriber.colorize_logging = val
        self.generators.colorize_logging = val
      end

      def session_store(new_session_store = nil, **options)
        if new_session_store
          if new_session_store == :active_record_store
            begin
              ActionDispatch::Session::ActiveRecordStore
            rescue NameError
              raise "`ActiveRecord::SessionStore` is extracted out of Rails into a gem. " \
                "Please add `activerecord-session_store` to your Gemfile to use it."
            end
          end

          @session_store = new_session_store
          @session_options = options || {}
        else
          case @session_store
          when :disabled
            nil
          when :active_record_store
            ActionDispatch::Session::ActiveRecordStore
          when Symbol
            ActionDispatch::Session.const_get(@session_store.to_s.camelize)
          else
            @session_store
          end
        end
      end

      def session_store? #:nodoc:
        @session_store
      end

      def annotations
        SourceAnnotationExtractor::Annotation
      end

      class Custom #:nodoc:
        def initialize
          @configurations = Hash.new
        end

        def method_missing(method, *args)
          if method =~ /=$/
            @configurations[$`.to_sym] = args.first
          else
            @configurations.fetch(method) {
              @configurations[method] = ActiveSupport::OrderedOptions.new
            }
          end
        end

        def respond_to_missing?(symbol, *)
          true
        end
      end
    end
  end
end