Chris@909: # Redmine - project management software Chris@909: # Copyright (C) 2006-2011 Jean-Philippe Lang Chris@909: # Chris@909: # This program is free software; you can redistribute it and/or Chris@909: # modify it under the terms of the GNU General Public License Chris@909: # as published by the Free Software Foundation; either version 2 Chris@909: # of the License, or (at your option) any later version. Chris@909: # Chris@909: # This program is distributed in the hope that it will be useful, Chris@909: # but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@909: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@909: # GNU General Public License for more details. Chris@909: # Chris@909: # You should have received a copy of the GNU General Public License Chris@909: # along with this program; if not, write to the Free Software Chris@909: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Chris@909: Chris@909: class Setting < ActiveRecord::Base Chris@909: Chris@909: DATE_FORMATS = [ Chris@909: '%Y-%m-%d', Chris@909: '%d/%m/%Y', Chris@909: '%d.%m.%Y', Chris@909: '%d-%m-%Y', Chris@909: '%m/%d/%Y', Chris@909: '%d %b %Y', Chris@909: '%d %B %Y', Chris@909: '%b %d, %Y', Chris@909: '%B %d, %Y' Chris@909: ] Chris@909: Chris@909: TIME_FORMATS = [ Chris@909: '%H:%M', Chris@909: '%I:%M %p' Chris@909: ] Chris@909: Chris@909: ENCODINGS = %w(US-ASCII Chris@909: windows-1250 Chris@909: windows-1251 Chris@909: windows-1252 Chris@909: windows-1253 Chris@909: windows-1254 Chris@909: windows-1255 Chris@909: windows-1256 Chris@909: windows-1257 Chris@909: windows-1258 Chris@909: windows-31j Chris@909: ISO-2022-JP Chris@909: ISO-2022-KR Chris@909: ISO-8859-1 Chris@909: ISO-8859-2 Chris@909: ISO-8859-3 Chris@909: ISO-8859-4 Chris@909: ISO-8859-5 Chris@909: ISO-8859-6 Chris@909: ISO-8859-7 Chris@909: ISO-8859-8 Chris@909: ISO-8859-9 Chris@909: ISO-8859-13 Chris@909: ISO-8859-15 Chris@909: KOI8-R Chris@909: UTF-8 Chris@909: UTF-16 Chris@909: UTF-16BE Chris@909: UTF-16LE Chris@909: EUC-JP Chris@909: Shift_JIS Chris@909: CP932 Chris@909: GB18030 Chris@909: GBK Chris@909: ISCII91 Chris@909: EUC-KR Chris@909: Big5 Chris@909: Big5-HKSCS Chris@909: TIS-620) Chris@909: Chris@909: cattr_accessor :available_settings Chris@909: @@available_settings = YAML::load(File.open("#{Rails.root}/config/settings.yml")) Chris@909: Redmine::Plugin.all.each do |plugin| Chris@909: next unless plugin.settings Chris@909: @@available_settings["plugin_#{plugin.id}"] = {'default' => plugin.settings[:default], 'serialized' => true} Chris@909: end Chris@909: Chris@909: validates_uniqueness_of :name Chris@909: validates_inclusion_of :name, :in => @@available_settings.keys Chris@909: validates_numericality_of :value, :only_integer => true, :if => Proc.new { |setting| @@available_settings[setting.name]['format'] == 'int' } Chris@909: Chris@909: # Hash used to cache setting values Chris@909: @cached_settings = {} Chris@909: @cached_cleared_on = Time.now Chris@909: Chris@909: def value Chris@909: v = read_attribute(:value) Chris@909: # Unserialize serialized settings Chris@909: v = YAML::load(v) if @@available_settings[name]['serialized'] && v.is_a?(String) Chris@909: v = v.to_sym if @@available_settings[name]['format'] == 'symbol' && !v.blank? Chris@909: v Chris@909: end Chris@909: Chris@909: def value=(v) Chris@909: v = v.to_yaml if v && @@available_settings[name] && @@available_settings[name]['serialized'] Chris@909: write_attribute(:value, v.to_s) Chris@909: end Chris@909: Chris@909: # Returns the value of the setting named name Chris@909: def self.[](name) Chris@909: v = @cached_settings[name] Chris@909: v ? v : (@cached_settings[name] = find_or_default(name).value) Chris@909: end Chris@909: Chris@909: def self.[]=(name, v) Chris@909: setting = find_or_default(name) Chris@909: setting.value = (v ? v : "") Chris@909: @cached_settings[name] = nil Chris@909: setting.save Chris@909: setting.value Chris@909: end Chris@909: Chris@909: # Defines getter and setter for each setting Chris@909: # Then setting values can be read using: Setting.some_setting_name Chris@909: # or set using Setting.some_setting_name = "some value" Chris@909: @@available_settings.each do |name, params| Chris@909: src = <<-END_SRC Chris@909: def self.#{name} Chris@909: self[:#{name}] Chris@909: end Chris@909: Chris@909: def self.#{name}? Chris@909: self[:#{name}].to_i > 0 Chris@909: end Chris@909: Chris@909: def self.#{name}=(value) Chris@909: self[:#{name}] = value Chris@909: end Chris@909: END_SRC Chris@909: class_eval src, __FILE__, __LINE__ Chris@909: end Chris@909: Chris@909: # Helper that returns an array based on per_page_options setting Chris@909: def self.per_page_options_array Chris@909: per_page_options.split(%r{[\s,]}).collect(&:to_i).select {|n| n > 0}.sort Chris@909: end Chris@909: Chris@909: def self.openid? Chris@909: Object.const_defined?(:OpenID) && self[:openid].to_i > 0 Chris@909: end Chris@909: Chris@909: # Checks if settings have changed since the values were read Chris@909: # and clears the cache hash if it's the case Chris@909: # Called once per request Chris@909: def self.check_cache Chris@909: settings_updated_on = Setting.maximum(:updated_on) Chris@909: if settings_updated_on && @cached_cleared_on <= settings_updated_on Chris@909: clear_cache Chris@909: end Chris@909: end Chris@909: Chris@909: # Clears the settings cache Chris@909: def self.clear_cache Chris@909: @cached_settings.clear Chris@909: @cached_cleared_on = Time.now Chris@909: logger.info "Settings cache cleared." if logger Chris@909: end Chris@909: Chris@909: private Chris@909: # Returns the Setting instance for the setting named name Chris@909: # (record found in database or new record with default value) Chris@909: def self.find_or_default(name) Chris@909: name = name.to_s Chris@909: raise "There's no setting named #{name}" unless @@available_settings.has_key?(name) Chris@909: setting = find_by_name(name) Chris@909: unless setting Chris@909: setting = new(:name => name) Chris@909: setting.value = @@available_settings[name]['default'] Chris@909: end Chris@909: setting Chris@909: end Chris@909: end