| @@ -1,168 +1,169 | |||
|
|
1 | 1 | # redMine - project management software |
|
|
2 | 2 | # Copyright (C) 2006-2007 Jean-Philippe Lang |
|
|
3 | 3 | # |
|
|
4 | 4 | # This program is free software; you can redistribute it and/or |
|
|
5 | 5 | # modify it under the terms of the GNU General Public License |
|
|
6 | 6 | # as published by the Free Software Foundation; either version 2 |
|
|
7 | 7 | # of the License, or (at your option) any later version. |
|
|
8 | 8 | # |
|
|
9 | 9 | # This program is distributed in the hope that it will be useful, |
|
|
10 | 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
11 | 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
|
12 | 12 | # GNU General Public License for more details. |
|
|
13 | 13 | # |
|
|
14 | 14 | # You should have received a copy of the GNU General Public License |
|
|
15 | 15 | # along with this program; if not, write to the Free Software |
|
|
16 | 16 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
|
|
17 | 17 | |
|
|
18 | 18 | class Setting < ActiveRecord::Base |
|
|
19 | 19 | |
|
|
20 | 20 | DATE_FORMATS = [ |
|
|
21 | 21 | '%Y-%m-%d', |
|
|
22 | 22 | '%d/%m/%Y', |
|
|
23 | 23 | '%d.%m.%Y', |
|
|
24 | 24 | '%d-%m-%Y', |
|
|
25 | 25 | '%m/%d/%Y', |
|
|
26 | 26 | '%d %b %Y', |
|
|
27 | 27 | '%d %B %Y', |
|
|
28 | 28 | '%b %d, %Y', |
|
|
29 | 29 | '%B %d, %Y' |
|
|
30 | 30 | ] |
|
|
31 | 31 | |
|
|
32 | 32 | TIME_FORMATS = [ |
|
|
33 | 33 | '%H:%M', |
|
|
34 | 34 | '%I:%M %p' |
|
|
35 | 35 | ] |
|
|
36 | 36 | |
|
|
37 | 37 | ENCODINGS = %w(US-ASCII |
|
|
38 | 38 | windows-1250 |
|
|
39 | 39 | windows-1251 |
|
|
40 | 40 | windows-1252 |
|
|
41 | 41 | windows-1253 |
|
|
42 | 42 | windows-1254 |
|
|
43 | 43 | windows-1255 |
|
|
44 | 44 | windows-1256 |
|
|
45 | 45 | windows-1257 |
|
|
46 | 46 | windows-1258 |
|
|
47 | 47 | windows-31j |
|
|
48 | 48 | ISO-2022-JP |
|
|
49 | 49 | ISO-2022-KR |
|
|
50 | 50 | ISO-8859-1 |
|
|
51 | 51 | ISO-8859-2 |
|
|
52 | 52 | ISO-8859-3 |
|
|
53 | 53 | ISO-8859-4 |
|
|
54 | 54 | ISO-8859-5 |
|
|
55 | 55 | ISO-8859-6 |
|
|
56 | 56 | ISO-8859-7 |
|
|
57 | 57 | ISO-8859-8 |
|
|
58 | 58 | ISO-8859-9 |
|
|
59 | 59 | ISO-8859-13 |
|
|
60 | 60 | ISO-8859-15 |
|
|
61 | 61 | KOI8-R |
|
|
62 | 62 | UTF-8 |
|
|
63 | 63 | UTF-16 |
|
|
64 | 64 | UTF-16BE |
|
|
65 | 65 | UTF-16LE |
|
|
66 | 66 | EUC-JP |
|
|
67 | 67 | Shift_JIS |
|
|
68 | CP932 | |
|
|
68 | 69 | GB18030 |
|
|
69 | 70 | GBK |
|
|
70 | 71 | ISCII91 |
|
|
71 | 72 | EUC-KR |
|
|
72 | 73 | Big5 |
|
|
73 | 74 | Big5-HKSCS |
|
|
74 | 75 | TIS-620) |
|
|
75 | 76 | |
|
|
76 | 77 | cattr_accessor :available_settings |
|
|
77 | 78 | @@available_settings = YAML::load(File.open("#{RAILS_ROOT}/config/settings.yml")) |
|
|
78 | 79 | Redmine::Plugin.all.each do |plugin| |
|
|
79 | 80 | next unless plugin.settings |
|
|
80 | 81 | @@available_settings["plugin_#{plugin.id}"] = {'default' => plugin.settings[:default], 'serialized' => true} |
|
|
81 | 82 | end |
|
|
82 | 83 | |
|
|
83 | 84 | validates_uniqueness_of :name |
|
|
84 | 85 | validates_inclusion_of :name, :in => @@available_settings.keys |
|
|
85 | 86 | validates_numericality_of :value, :only_integer => true, :if => Proc.new { |setting| @@available_settings[setting.name]['format'] == 'int' } |
|
|
86 | 87 | |
|
|
87 | 88 | # Hash used to cache setting values |
|
|
88 | 89 | @cached_settings = {} |
|
|
89 | 90 | @cached_cleared_on = Time.now |
|
|
90 | 91 | |
|
|
91 | 92 | def value |
|
|
92 | 93 | v = read_attribute(:value) |
|
|
93 | 94 | # Unserialize serialized settings |
|
|
94 | 95 | v = YAML::load(v) if @@available_settings[name]['serialized'] && v.is_a?(String) |
|
|
95 | 96 | v = v.to_sym if @@available_settings[name]['format'] == 'symbol' && !v.blank? |
|
|
96 | 97 | v |
|
|
97 | 98 | end |
|
|
98 | 99 | |
|
|
99 | 100 | def value=(v) |
|
|
100 | 101 | v = v.to_yaml if v && @@available_settings[name] && @@available_settings[name]['serialized'] |
|
|
101 | 102 | write_attribute(:value, v.to_s) |
|
|
102 | 103 | end |
|
|
103 | 104 | |
|
|
104 | 105 | # Returns the value of the setting named name |
|
|
105 | 106 | def self.[](name) |
|
|
106 | 107 | v = @cached_settings[name] |
|
|
107 | 108 | v ? v : (@cached_settings[name] = find_or_default(name).value) |
|
|
108 | 109 | end |
|
|
109 | 110 | |
|
|
110 | 111 | def self.[]=(name, v) |
|
|
111 | 112 | setting = find_or_default(name) |
|
|
112 | 113 | setting.value = (v ? v : "") |
|
|
113 | 114 | @cached_settings[name] = nil |
|
|
114 | 115 | setting.save |
|
|
115 | 116 | setting.value |
|
|
116 | 117 | end |
|
|
117 | 118 | |
|
|
118 | 119 | # Defines getter and setter for each setting |
|
|
119 | 120 | # Then setting values can be read using: Setting.some_setting_name |
|
|
120 | 121 | # or set using Setting.some_setting_name = "some value" |
|
|
121 | 122 | @@available_settings.each do |name, params| |
|
|
122 | 123 | src = <<-END_SRC |
|
|
123 | 124 | def self.#{name} |
|
|
124 | 125 | self[:#{name}] |
|
|
125 | 126 | end |
|
|
126 | 127 | |
|
|
127 | 128 | def self.#{name}? |
|
|
128 | 129 | self[:#{name}].to_i > 0 |
|
|
129 | 130 | end |
|
|
130 | 131 | |
|
|
131 | 132 | def self.#{name}=(value) |
|
|
132 | 133 | self[:#{name}] = value |
|
|
133 | 134 | end |
|
|
134 | 135 | END_SRC |
|
|
135 | 136 | class_eval src, __FILE__, __LINE__ |
|
|
136 | 137 | end |
|
|
137 | 138 | |
|
|
138 | 139 | # Helper that returns an array based on per_page_options setting |
|
|
139 | 140 | def self.per_page_options_array |
|
|
140 | 141 | per_page_options.split(%r{[\s,]}).collect(&:to_i).select {|n| n > 0}.sort |
|
|
141 | 142 | end |
|
|
142 | 143 | |
|
|
143 | 144 | def self.openid? |
|
|
144 | 145 | Object.const_defined?(:OpenID) && self[:openid].to_i > 0 |
|
|
145 | 146 | end |
|
|
146 | 147 | |
|
|
147 | 148 | # Checks if settings have changed since the values were read |
|
|
148 | 149 | # and clears the cache hash if it's the case |
|
|
149 | 150 | # Called once per request |
|
|
150 | 151 | def self.check_cache |
|
|
151 | 152 | settings_updated_on = Setting.maximum(:updated_on) |
|
|
152 | 153 | if settings_updated_on && @cached_cleared_on <= settings_updated_on |
|
|
153 | 154 | @cached_settings.clear |
|
|
154 | 155 | @cached_cleared_on = Time.now |
|
|
155 | 156 | logger.info "Settings cache cleared." if logger |
|
|
156 | 157 | end |
|
|
157 | 158 | end |
|
|
158 | 159 | |
|
|
159 | 160 | private |
|
|
160 | 161 | # Returns the Setting instance for the setting named name |
|
|
161 | 162 | # (record found in database or new record with default value) |
|
|
162 | 163 | def self.find_or_default(name) |
|
|
163 | 164 | name = name.to_s |
|
|
164 | 165 | raise "There's no setting named #{name}" unless @@available_settings.has_key?(name) |
|
|
165 | 166 | setting = find_by_name(name) |
|
|
166 | 167 | setting ||= new(:name => name, :value => @@available_settings[name]['default']) if @@available_settings.has_key? name |
|
|
167 | 168 | end |
|
|
168 | 169 | end |
General Comments 0
You need to be logged in to leave comments.
Login now