123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137 |
- # frozen_string_literal: true
-
- # Redmine - project management software
- # Copyright (C) 2006-2019 Jean-Philippe Lang
- #
- # This program is free software; you can redistribute it and/or
- # modify it under the terms of the GNU General Public License
- # as published by the Free Software Foundation; either version 2
- # of the License, or (at your option) any later version.
- #
- # This program is distributed in the hope that it will be useful,
- # but WITHOUT ANY WARRANTY; without even the implied warranty of
- # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- # GNU General Public License for more details.
- #
- # You should have received a copy of the GNU General Public License
- # along with this program; if not, write to the Free Software
- # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-
- module Redmine
- module Configuration
-
- # Configuration default values
- @defaults = {
- 'avatar_server_url' => 'https://www.gravatar.com',
- 'email_delivery' => nil,
- 'max_concurrent_ajax_uploads' => 2
- }
-
- @config = nil
-
- class << self
- # Loads the Redmine configuration file
- # Valid options:
- # * <tt>:file</tt>: the configuration file to load (default: config/configuration.yml)
- # * <tt>:env</tt>: the environment to load the configuration for (default: Rails.env)
- def load(options={})
- filename = options[:file] || File.join(Rails.root, 'config', 'configuration.yml')
- env = options[:env] || Rails.env
-
- @config = @defaults.dup
-
- load_deprecated_email_configuration(env)
- if File.file?(filename)
- @config.merge!(load_from_yaml(filename, env))
- end
-
- # Compatibility mode for those who copy email.yml over configuration.yml
- %w(delivery_method smtp_settings sendmail_settings).each do |key|
- if value = @config.delete(key)
- @config['email_delivery'] ||= {}
- @config['email_delivery'][key] = value
- end
- end
-
- if @config['email_delivery']
- ActionMailer::Base.perform_deliveries = true
- @config['email_delivery'].each do |k, v|
- # Comprehensive error message for those who used async_smtp and async_sendmail
- # delivery methods that are removed in Redmine 4.0.
- if k == 'delivery_method' && v.to_s =~ /\Aasync_(.+)/
- abort "Redmine now uses ActiveJob to send emails asynchronously and the :#{v} delivery method is no longer available.\n" +
- "Please update your config/configuration.yml to use :#$1 delivery method instead."
- end
- v.symbolize_keys! if v.respond_to?(:symbolize_keys!)
- ActionMailer::Base.send("#{k}=", v)
- end
- end
-
- check_regular_expressions
- @config
- end
-
- # Returns a configuration setting
- def [](name)
- load unless @config
- @config[name]
- end
-
- # Yields a block with the specified hash configuration settings
- def with(settings)
- settings.stringify_keys!
- load unless @config
- was = settings.keys.inject({}) {|h,v| h[v] = @config[v]; h}
- @config.merge! settings
- yield if block_given?
- @config.merge! was
- end
-
- private
-
- def load_from_yaml(filename, env)
- yaml = nil
- begin
- yaml = YAML::load(ERB.new(File.read(filename)).result)
- rescue ArgumentError
- abort "Your Redmine configuration file located at #{filename} is not a valid YAML file and could not be loaded."
- rescue SyntaxError => e
- abort "A syntax error occurred when parsing your Redmine configuration file located at #{filename} with ERB:\n#{e.message}"
- end
- conf = {}
- if yaml.is_a?(Hash)
- if yaml['default']
- conf.merge!(yaml['default'])
- end
- if yaml[env]
- conf.merge!(yaml[env])
- end
- else
- abort "Your Redmine configuration file located at #{filename} is not a valid Redmine configuration file."
- end
- conf
- end
-
- def load_deprecated_email_configuration(env)
- deprecated_email_conf = File.join(Rails.root, 'config', 'email.yml')
- if File.file?(deprecated_email_conf)
- warn "Storing outgoing emails configuration in config/email.yml is deprecated. You should now store it in config/configuration.yml using the email_delivery setting."
- @config.merge!({'email_delivery' => load_from_yaml(deprecated_email_conf, env)})
- end
- end
-
- # Checks the validness of regular expressions set for repository paths at startup
- def check_regular_expressions
- @config.each do |name, value|
- if value.present? && /^scm_.+_path_regexp$/.match?(name)
- begin
- Regexp.new value.to_s.strip
- rescue => e
- abort "Invalid regular expression set as #{name} setting in your Redmine configuration file:\n#{e.message}"
- end
- end
- end
- end
- end
- end
- end
|