123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373 |
- # frozen_string_literal: true
-
- # Redmine - project management software
- # Copyright (C) 2006-2022 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.
-
- class Setting < ActiveRecord::Base
- PASSWORD_CHAR_CLASSES = {
- 'uppercase' => /[A-Z]/,
- 'lowercase' => /[a-z]/,
- 'digits' => /[0-9]/,
- 'special_chars' => /[[:ascii:]&&[:graph:]&&[:^alnum:]]/
- }
-
- DATE_FORMATS = [
- '%Y-%m-%d',
- '%d/%m/%Y',
- '%d.%m.%Y',
- '%d-%m-%Y',
- '%m/%d/%Y',
- '%d %b %Y',
- '%d %B %Y',
- '%b %d, %Y',
- '%B %d, %Y'
- ]
-
- TIME_FORMATS = [
- '%H:%M',
- '%I:%M %p'
- ]
-
- ENCODINGS = %w(US-ASCII
- windows-1250
- windows-1251
- windows-1252
- windows-1253
- windows-1254
- windows-1255
- windows-1256
- windows-1257
- windows-1258
- windows-31j
- windows-874
- ISO-2022-JP
- ISO-8859-1
- ISO-8859-2
- ISO-8859-3
- ISO-8859-4
- ISO-8859-5
- ISO-8859-6
- ISO-8859-7
- ISO-8859-8
- ISO-8859-9
- ISO-8859-13
- ISO-8859-15
- KOI8-R
- UTF-8
- UTF-16
- UTF-16BE
- UTF-16LE
- EUC-JP
- Shift_JIS
- CP932
- CP949
- GB18030
- GBK
- EUC-KR
- Big5
- Big5-HKSCS
- TIS-620)
-
- cattr_accessor :available_settings
- self.available_settings ||= {}
-
- validates_uniqueness_of(
- :name,
- :case_sensitive => true,
- :if => Proc.new do |setting|
- setting.new_record? || setting.name_changed?
- end
- )
- validates_inclusion_of :name, :in => Proc.new {available_settings.keys}
- validates_numericality_of(
- :value, :only_integer => true,
- :if => Proc.new do |setting|
- (s = available_settings[setting.name]) && s['format'] == 'int'
- end
- )
-
- # Hash used to cache setting values
- @cached_settings = {}
- @cached_cleared_on = Time.now
-
- def value
- v = read_attribute(:value)
- # Unserialize serialized settings
- if available_settings[name]['serialized'] && v.is_a?(String)
- # YAML.load works as YAML.safe_load if Psych >= 4.0 is installed
- v = YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(v) : YAML.load(v)
- v = force_utf8_strings(v)
- end
- v = v.to_sym if available_settings[name]['format'] == 'symbol' && !v.blank?
- v
- end
-
- def value=(v)
- v = v.to_yaml if v && available_settings[name] && available_settings[name]['serialized']
- write_attribute(:value, v.to_s)
- end
-
- # Returns the value of the setting named name
- def self.[](name)
- @cached_settings[name] ||= find_or_default(name).value
- end
-
- def self.[]=(name, v)
- setting = find_or_default(name)
- setting.value = v || ''
- @cached_settings[name] = nil
- setting.save
- setting.value
- end
-
- # Updates multiple settings from params and sends a security notification if needed
- def self.set_all_from_params(settings)
- return nil unless settings.is_a?(Hash)
-
- settings = settings.dup.symbolize_keys
-
- errors = validate_all_from_params(settings)
- return errors if errors.present?
-
- changes = []
- settings.each do |name, value|
- next unless available_settings[name.to_s]
-
- previous_value = Setting[name]
- set_from_params name, value
- if available_settings[name.to_s]['security_notifications'] && Setting[name] != previous_value
- changes << name
- end
- end
- if changes.any?
- Mailer.deliver_settings_updated(User.current, changes)
- end
- nil
- end
-
- def self.validate_all_from_params(settings)
- messages = []
- [
- [:mail_handler_enable_regex_delimiters,
- :mail_handler_body_delimiters,
- /[\r\n]+/],
- [:mail_handler_enable_regex_excluded_filenames,
- :mail_handler_excluded_filenames,
- /\s*,\s*/]
- ].each do |enable_regex, regex_field, delimiter|
- if settings.key?(regex_field) || settings.key?(enable_regex)
- regexp = Setting.send("#{enable_regex}?")
- if settings.key?(enable_regex)
- regexp = settings[enable_regex].to_s != '0'
- end
- if regexp
- settings[regex_field].to_s.split(delimiter).each do |value|
- begin
- Regexp.new(value)
- rescue RegexpError => e
- messages << [regex_field, "#{l('activerecord.errors.messages.not_a_regexp')} (#{e.message})"]
- end
- end
- end
- end
- end
- if settings.key?(:mail_from)
- begin
- mail_from = Mail::Address.new(settings[:mail_from])
- raise unless EmailAddress::EMAIL_REGEXP.match?(mail_from.address)
- rescue
- messages << [:mail_from, l('activerecord.errors.messages.invalid')]
- end
- end
- messages
- end
-
- # Sets a setting value from params
- def self.set_from_params(name, params)
- params = params.dup
- params.delete_if {|v| v.blank?} if params.is_a?(Array)
- params.symbolize_keys! if params.is_a?(Hash)
-
- m = "#{name}_from_params"
- if respond_to? m
- self[name.to_sym] = send m, params
- else
- self[name.to_sym] = params
- end
- end
-
- # Returns a hash suitable for commit_update_keywords setting
- #
- # Example:
- # params = {:keywords => ['fixes', 'closes'], :status_id => ["3", "5"], :done_ratio => ["", "100"]}
- # Setting.commit_update_keywords_from_params(params)
- # # => [{'keywords => 'fixes', 'status_id' => "3"}, {'keywords => 'closes', 'status_id' => "5", 'done_ratio' => "100"}]
- def self.commit_update_keywords_from_params(params)
- s = []
- if params.is_a?(Hash) && params.key?(:keywords) && params.values.all? {|v| v.is_a? Array}
- attributes = params.except(:keywords).keys
- params[:keywords].each_with_index do |keywords, i|
- next if keywords.blank?
-
- s << attributes.inject({}) do |h, a|
- value = params[a][i].to_s
- h[a.to_s] = value if value.present?
- h
- end.merge('keywords' => keywords)
- end
- end
- s
- end
-
- def self.twofa_from_params(params)
- # unpair all current 2FA pairings when switching off 2FA
- Redmine::Twofa.unpair_all! if params == '0' && self.twofa?
- params
- end
-
- def self.twofa_required?
- twofa == '2'
- end
-
- def self.twofa_optional?
- %w[1 3].include? twofa
- end
-
- def self.twofa_required_for_administrators?
- twofa == '3'
- end
-
- # Helper that returns an array based on per_page_options setting
- def self.per_page_options_array
- per_page_options.split(%r{[\s,]}).collect(&:to_i).select {|n| n > 0}.sort
- end
-
- # Helper that returns a Hash with single update keywords as keys
- def self.commit_update_keywords_array
- a = []
- if commit_update_keywords.is_a?(Array)
- commit_update_keywords.each do |rule|
- next unless rule.is_a?(Hash)
-
- rule = rule.dup
- rule.delete_if {|k, v| v.blank?}
- keywords = rule['keywords'].to_s.downcase.split(",").map(&:strip).reject(&:blank?)
- next if keywords.empty?
-
- a << rule.merge('keywords' => keywords)
- end
- end
- a
- end
-
- # Checks if settings have changed since the values were read
- # and clears the cache hash if it's the case
- # Called once per request
- def self.check_cache
- settings_updated_on = Setting.maximum(:updated_on)
- if settings_updated_on && @cached_cleared_on <= settings_updated_on
- clear_cache
- end
- end
-
- # Clears the settings cache
- def self.clear_cache
- @cached_settings.clear
- @cached_cleared_on = Time.now
- logger.info "Settings cache cleared." if logger
- end
-
- def self.define_plugin_setting(plugin)
- if plugin.settings
- name = "plugin_#{plugin.id}"
- define_setting name, {'default' => plugin.settings[:default], 'serialized' => true}
- end
- end
-
- # Defines getter and setter for each setting
- # Then setting values can be read using: Setting.some_setting_name
- # or set using Setting.some_setting_name = "some value"
- def self.define_setting(name, options={})
- available_settings[name.to_s] = options
-
- src = <<~END_SRC
- def self.#{name}
- self[:#{name}]
- end
-
- def self.#{name}?
- self[:#{name}].to_i > 0
- end
-
- def self.#{name}=(value)
- self[:#{name}] = value
- end
- END_SRC
- class_eval src, __FILE__, __LINE__
- end
-
- def self.load_available_settings
- YAML::load(File.open("#{Rails.root}/config/settings.yml")).each do |name, options|
- define_setting name, options
- end
- end
-
- def self.load_plugin_settings
- Redmine::Plugin.all.each do |plugin|
- define_plugin_setting(plugin)
- end
- end
-
- load_available_settings
- load_plugin_settings
-
- private
-
- def force_utf8_strings(arg)
- if arg.is_a?(String)
- arg.dup.force_encoding('UTF-8')
- elsif arg.is_a?(Array)
- arg.map do |a|
- force_utf8_strings(a)
- end
- elsif arg.is_a?(Hash)
- arg = arg.dup
- arg.each do |k, v|
- arg[k] = force_utf8_strings(v)
- end
- arg
- else
- arg
- end
- end
-
- # Returns the Setting instance for the setting named name
- # (record found in database or new record with default value)
- def self.find_or_default(name)
- name = name.to_s
- raise "There's no setting named #{name}" unless available_settings.has_key?(name)
-
- setting = where(:name => name).order(:id => :desc).first
- unless setting
- setting = new
- setting.name = name
- setting.value = available_settings[name]['default']
- end
- setting
- end
- private_class_method :find_or_default
- end
|