annotate .svn/pristine/14/14309d64e537e5e954feb549559e6200d128036a.svn-base @ 1298:4f746d8966dd redmine_2.3_integration

Merge from redmine-2.3 branch to create new branch redmine-2.3-integration
author Chris Cannam
date Fri, 14 Jun 2013 09:28:30 +0100
parents 622f24f53b42
children
rev   line source
Chris@1295 1 # Redmine - project management software
Chris@1295 2 # Copyright (C) 2006-2012 Jean-Philippe Lang
Chris@1295 3 #
Chris@1295 4 # This program is free software; you can redistribute it and/or
Chris@1295 5 # modify it under the terms of the GNU General Public License
Chris@1295 6 # as published by the Free Software Foundation; either version 2
Chris@1295 7 # of the License, or (at your option) any later version.
Chris@1295 8 #
Chris@1295 9 # This program is distributed in the hope that it will be useful,
Chris@1295 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1295 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@1295 12 # GNU General Public License for more details.
Chris@1295 13 #
Chris@1295 14 # You should have received a copy of the GNU General Public License
Chris@1295 15 # along with this program; if not, write to the Free Software
Chris@1295 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@1295 17
Chris@1295 18 class CustomField < ActiveRecord::Base
Chris@1295 19 include Redmine::SubclassFactory
Chris@1295 20
Chris@1295 21 has_many :custom_values, :dependent => :delete_all
Chris@1295 22 acts_as_list :scope => 'type = \'#{self.class}\''
Chris@1295 23 serialize :possible_values
Chris@1295 24
Chris@1295 25 validates_presence_of :name, :field_format
Chris@1295 26 validates_uniqueness_of :name, :scope => :type
Chris@1295 27 validates_length_of :name, :maximum => 30
Chris@1295 28 validates_inclusion_of :field_format, :in => Redmine::CustomFieldFormat.available_formats
Chris@1295 29
Chris@1295 30 validate :validate_custom_field
Chris@1295 31 before_validation :set_searchable
Chris@1295 32
Chris@1295 33 CUSTOM_FIELDS_TABS = [
Chris@1295 34 {:name => 'IssueCustomField', :partial => 'custom_fields/index',
Chris@1295 35 :label => :label_issue_plural},
Chris@1295 36 {:name => 'TimeEntryCustomField', :partial => 'custom_fields/index',
Chris@1295 37 :label => :label_spent_time},
Chris@1295 38 {:name => 'ProjectCustomField', :partial => 'custom_fields/index',
Chris@1295 39 :label => :label_project_plural},
Chris@1295 40 {:name => 'VersionCustomField', :partial => 'custom_fields/index',
Chris@1295 41 :label => :label_version_plural},
Chris@1295 42 {:name => 'UserCustomField', :partial => 'custom_fields/index',
Chris@1295 43 :label => :label_user_plural},
Chris@1295 44 {:name => 'GroupCustomField', :partial => 'custom_fields/index',
Chris@1295 45 :label => :label_group_plural},
Chris@1295 46 {:name => 'TimeEntryActivityCustomField', :partial => 'custom_fields/index',
Chris@1295 47 :label => TimeEntryActivity::OptionName},
Chris@1295 48 {:name => 'IssuePriorityCustomField', :partial => 'custom_fields/index',
Chris@1295 49 :label => IssuePriority::OptionName},
Chris@1295 50 {:name => 'DocumentCategoryCustomField', :partial => 'custom_fields/index',
Chris@1295 51 :label => DocumentCategory::OptionName}
Chris@1295 52 ]
Chris@1295 53
Chris@1295 54 CUSTOM_FIELDS_NAMES = CUSTOM_FIELDS_TABS.collect{|v| v[:name]}
Chris@1295 55
Chris@1295 56 def field_format=(arg)
Chris@1295 57 # cannot change format of a saved custom field
Chris@1295 58 super if new_record?
Chris@1295 59 end
Chris@1295 60
Chris@1295 61 def set_searchable
Chris@1295 62 # make sure these fields are not searchable
Chris@1295 63 self.searchable = false if %w(int float date bool).include?(field_format)
Chris@1295 64 # make sure only these fields can have multiple values
Chris@1295 65 self.multiple = false unless %w(list user version).include?(field_format)
Chris@1295 66 true
Chris@1295 67 end
Chris@1295 68
Chris@1295 69 def validate_custom_field
Chris@1295 70 if self.field_format == "list"
Chris@1295 71 errors.add(:possible_values, :blank) if self.possible_values.nil? || self.possible_values.empty?
Chris@1295 72 errors.add(:possible_values, :invalid) unless self.possible_values.is_a? Array
Chris@1295 73 end
Chris@1295 74
Chris@1295 75 if regexp.present?
Chris@1295 76 begin
Chris@1295 77 Regexp.new(regexp)
Chris@1295 78 rescue
Chris@1295 79 errors.add(:regexp, :invalid)
Chris@1295 80 end
Chris@1295 81 end
Chris@1295 82
Chris@1295 83 if default_value.present? && !valid_field_value?(default_value)
Chris@1295 84 errors.add(:default_value, :invalid)
Chris@1295 85 end
Chris@1295 86 end
Chris@1295 87
Chris@1295 88 def possible_values_options(obj=nil)
Chris@1295 89 case field_format
Chris@1295 90 when 'user', 'version'
Chris@1295 91 if obj.respond_to?(:project) && obj.project
Chris@1295 92 case field_format
Chris@1295 93 when 'user'
Chris@1295 94 obj.project.users.sort.collect {|u| [u.to_s, u.id.to_s]}
Chris@1295 95 when 'version'
Chris@1295 96 obj.project.shared_versions.sort.collect {|u| [u.to_s, u.id.to_s]}
Chris@1295 97 end
Chris@1295 98 elsif obj.is_a?(Array)
Chris@1295 99 obj.collect {|o| possible_values_options(o)}.reduce(:&)
Chris@1295 100 else
Chris@1295 101 []
Chris@1295 102 end
Chris@1295 103 when 'bool'
Chris@1295 104 [[l(:general_text_Yes), '1'], [l(:general_text_No), '0']]
Chris@1295 105 else
Chris@1295 106 possible_values || []
Chris@1295 107 end
Chris@1295 108 end
Chris@1295 109
Chris@1295 110 def possible_values(obj=nil)
Chris@1295 111 case field_format
Chris@1295 112 when 'user', 'version'
Chris@1295 113 possible_values_options(obj).collect(&:last)
Chris@1295 114 when 'bool'
Chris@1295 115 ['1', '0']
Chris@1295 116 else
Chris@1295 117 values = super()
Chris@1295 118 if values.is_a?(Array)
Chris@1295 119 values.each do |value|
Chris@1295 120 value.force_encoding('UTF-8') if value.respond_to?(:force_encoding)
Chris@1295 121 end
Chris@1295 122 end
Chris@1295 123 values || []
Chris@1295 124 end
Chris@1295 125 end
Chris@1295 126
Chris@1295 127 # Makes possible_values accept a multiline string
Chris@1295 128 def possible_values=(arg)
Chris@1295 129 if arg.is_a?(Array)
Chris@1295 130 super(arg.compact.collect(&:strip).select {|v| !v.blank?})
Chris@1295 131 else
Chris@1295 132 self.possible_values = arg.to_s.split(/[\n\r]+/)
Chris@1295 133 end
Chris@1295 134 end
Chris@1295 135
Chris@1295 136 def cast_value(value)
Chris@1295 137 casted = nil
Chris@1295 138 unless value.blank?
Chris@1295 139 case field_format
Chris@1295 140 when 'string', 'text', 'list'
Chris@1295 141 casted = value
Chris@1295 142 when 'date'
Chris@1295 143 casted = begin; value.to_date; rescue; nil end
Chris@1295 144 when 'bool'
Chris@1295 145 casted = (value == '1' ? true : false)
Chris@1295 146 when 'int'
Chris@1295 147 casted = value.to_i
Chris@1295 148 when 'float'
Chris@1295 149 casted = value.to_f
Chris@1295 150 when 'user', 'version'
Chris@1295 151 casted = (value.blank? ? nil : field_format.classify.constantize.find_by_id(value.to_i))
Chris@1295 152 end
Chris@1295 153 end
Chris@1295 154 casted
Chris@1295 155 end
Chris@1295 156
Chris@1295 157 def value_from_keyword(keyword, customized)
Chris@1295 158 possible_values_options = possible_values_options(customized)
Chris@1295 159 if possible_values_options.present?
Chris@1295 160 keyword = keyword.to_s.downcase
Chris@1295 161 if v = possible_values_options.detect {|text, id| text.downcase == keyword}
Chris@1295 162 if v.is_a?(Array)
Chris@1295 163 v.last
Chris@1295 164 else
Chris@1295 165 v
Chris@1295 166 end
Chris@1295 167 end
Chris@1295 168 else
Chris@1295 169 keyword
Chris@1295 170 end
Chris@1295 171 end
Chris@1295 172
Chris@1295 173 # Returns a ORDER BY clause that can used to sort customized
Chris@1295 174 # objects by their value of the custom field.
Chris@1295 175 # Returns nil if the custom field can not be used for sorting.
Chris@1295 176 def order_statement
Chris@1295 177 return nil if multiple?
Chris@1295 178 case field_format
Chris@1295 179 when 'string', 'text', 'list', 'date', 'bool'
Chris@1295 180 # COALESCE is here to make sure that blank and NULL values are sorted equally
Chris@1295 181 "COALESCE((SELECT cv_sort.value FROM #{CustomValue.table_name} cv_sort" +
Chris@1295 182 " WHERE cv_sort.customized_type='#{self.class.customized_class.base_class.name}'" +
Chris@1295 183 " AND cv_sort.customized_id=#{self.class.customized_class.table_name}.id" +
Chris@1295 184 " AND cv_sort.custom_field_id=#{id} LIMIT 1), '')"
Chris@1295 185 when 'int', 'float'
Chris@1295 186 # Make the database cast values into numeric
Chris@1295 187 # Postgresql will raise an error if a value can not be casted!
Chris@1295 188 # CustomValue validations should ensure that it doesn't occur
Chris@1295 189 "(SELECT CAST(cv_sort.value AS decimal(60,3)) FROM #{CustomValue.table_name} cv_sort" +
Chris@1295 190 " WHERE cv_sort.customized_type='#{self.class.customized_class.base_class.name}'" +
Chris@1295 191 " AND cv_sort.customized_id=#{self.class.customized_class.table_name}.id" +
Chris@1295 192 " AND cv_sort.custom_field_id=#{id} AND cv_sort.value <> '' AND cv_sort.value IS NOT NULL LIMIT 1)"
Chris@1295 193 when 'user', 'version'
Chris@1295 194 value_class.fields_for_order_statement(value_join_alias)
Chris@1295 195 else
Chris@1295 196 nil
Chris@1295 197 end
Chris@1295 198 end
Chris@1295 199
Chris@1295 200 # Returns a GROUP BY clause that can used to group by custom value
Chris@1295 201 # Returns nil if the custom field can not be used for grouping.
Chris@1295 202 def group_statement
Chris@1295 203 return nil if multiple?
Chris@1295 204 case field_format
Chris@1295 205 when 'list', 'date', 'bool', 'int'
Chris@1295 206 order_statement
Chris@1295 207 when 'user', 'version'
Chris@1295 208 "COALESCE((SELECT cv_sort.value FROM #{CustomValue.table_name} cv_sort" +
Chris@1295 209 " WHERE cv_sort.customized_type='#{self.class.customized_class.base_class.name}'" +
Chris@1295 210 " AND cv_sort.customized_id=#{self.class.customized_class.table_name}.id" +
Chris@1295 211 " AND cv_sort.custom_field_id=#{id} LIMIT 1), '')"
Chris@1295 212 else
Chris@1295 213 nil
Chris@1295 214 end
Chris@1295 215 end
Chris@1295 216
Chris@1295 217 def join_for_order_statement
Chris@1295 218 case field_format
Chris@1295 219 when 'user', 'version'
Chris@1295 220 "LEFT OUTER JOIN #{CustomValue.table_name} #{join_alias}" +
Chris@1295 221 " ON #{join_alias}.customized_type = '#{self.class.customized_class.base_class.name}'" +
Chris@1295 222 " AND #{join_alias}.customized_id = #{self.class.customized_class.table_name}.id" +
Chris@1295 223 " AND #{join_alias}.custom_field_id = #{id}" +
Chris@1295 224 " AND #{join_alias}.value <> ''" +
Chris@1295 225 " AND #{join_alias}.id = (SELECT max(#{join_alias}_2.id) FROM #{CustomValue.table_name} #{join_alias}_2" +
Chris@1295 226 " WHERE #{join_alias}_2.customized_type = #{join_alias}.customized_type" +
Chris@1295 227 " AND #{join_alias}_2.customized_id = #{join_alias}.customized_id" +
Chris@1295 228 " AND #{join_alias}_2.custom_field_id = #{join_alias}.custom_field_id)" +
Chris@1295 229 " LEFT OUTER JOIN #{value_class.table_name} #{value_join_alias}" +
Chris@1295 230 " ON CAST(#{join_alias}.value as decimal(60,0)) = #{value_join_alias}.id"
Chris@1295 231 else
Chris@1295 232 nil
Chris@1295 233 end
Chris@1295 234 end
Chris@1295 235
Chris@1295 236 def join_alias
Chris@1295 237 "cf_#{id}"
Chris@1295 238 end
Chris@1295 239
Chris@1295 240 def value_join_alias
Chris@1295 241 join_alias + "_" + field_format
Chris@1295 242 end
Chris@1295 243
Chris@1295 244 def <=>(field)
Chris@1295 245 position <=> field.position
Chris@1295 246 end
Chris@1295 247
Chris@1295 248 # Returns the class that values represent
Chris@1295 249 def value_class
Chris@1295 250 case field_format
Chris@1295 251 when 'user', 'version'
Chris@1295 252 field_format.classify.constantize
Chris@1295 253 else
Chris@1295 254 nil
Chris@1295 255 end
Chris@1295 256 end
Chris@1295 257
Chris@1295 258 def self.customized_class
Chris@1295 259 self.name =~ /^(.+)CustomField$/
Chris@1295 260 begin; $1.constantize; rescue nil; end
Chris@1295 261 end
Chris@1295 262
Chris@1295 263 # to move in project_custom_field
Chris@1295 264 def self.for_all
Chris@1295 265 find(:all, :conditions => ["is_for_all=?", true], :order => 'position')
Chris@1295 266 end
Chris@1295 267
Chris@1295 268 def type_name
Chris@1295 269 nil
Chris@1295 270 end
Chris@1295 271
Chris@1295 272 # Returns the error messages for the given value
Chris@1295 273 # or an empty array if value is a valid value for the custom field
Chris@1295 274 def validate_field_value(value)
Chris@1295 275 errs = []
Chris@1295 276 if value.is_a?(Array)
Chris@1295 277 if !multiple?
Chris@1295 278 errs << ::I18n.t('activerecord.errors.messages.invalid')
Chris@1295 279 end
Chris@1295 280 if is_required? && value.detect(&:present?).nil?
Chris@1295 281 errs << ::I18n.t('activerecord.errors.messages.blank')
Chris@1295 282 end
Chris@1295 283 value.each {|v| errs += validate_field_value_format(v)}
Chris@1295 284 else
Chris@1295 285 if is_required? && value.blank?
Chris@1295 286 errs << ::I18n.t('activerecord.errors.messages.blank')
Chris@1295 287 end
Chris@1295 288 errs += validate_field_value_format(value)
Chris@1295 289 end
Chris@1295 290 errs
Chris@1295 291 end
Chris@1295 292
Chris@1295 293 # Returns true if value is a valid value for the custom field
Chris@1295 294 def valid_field_value?(value)
Chris@1295 295 validate_field_value(value).empty?
Chris@1295 296 end
Chris@1295 297
Chris@1295 298 def format_in?(*args)
Chris@1295 299 args.include?(field_format)
Chris@1295 300 end
Chris@1295 301
Chris@1295 302 protected
Chris@1295 303
Chris@1295 304 # Returns the error message for the given value regarding its format
Chris@1295 305 def validate_field_value_format(value)
Chris@1295 306 errs = []
Chris@1295 307 if value.present?
Chris@1295 308 errs << ::I18n.t('activerecord.errors.messages.invalid') unless regexp.blank? or value =~ Regexp.new(regexp)
Chris@1295 309 errs << ::I18n.t('activerecord.errors.messages.too_short', :count => min_length) if min_length > 0 and value.length < min_length
Chris@1295 310 errs << ::I18n.t('activerecord.errors.messages.too_long', :count => max_length) if max_length > 0 and value.length > max_length
Chris@1295 311
Chris@1295 312 # Format specific validations
Chris@1295 313 case field_format
Chris@1295 314 when 'int'
Chris@1295 315 errs << ::I18n.t('activerecord.errors.messages.not_a_number') unless value =~ /^[+-]?\d+$/
Chris@1295 316 when 'float'
Chris@1295 317 begin; Kernel.Float(value); rescue; errs << ::I18n.t('activerecord.errors.messages.invalid') end
Chris@1295 318 when 'date'
Chris@1295 319 errs << ::I18n.t('activerecord.errors.messages.not_a_date') unless value =~ /^\d{4}-\d{2}-\d{2}$/ && begin; value.to_date; rescue; false end
Chris@1295 320 when 'list'
Chris@1295 321 errs << ::I18n.t('activerecord.errors.messages.inclusion') unless possible_values.include?(value)
Chris@1295 322 end
Chris@1295 323 end
Chris@1295 324 errs
Chris@1295 325 end
Chris@1295 326 end