Chris@441: # Redmine - project management software
Chris@1295: # Copyright (C) 2006-2013  Jean-Philippe Lang
Chris@0: #
Chris@0: # This program is free software; you can redistribute it and/or
Chris@0: # modify it under the terms of the GNU General Public License
Chris@0: # as published by the Free Software Foundation; either version 2
Chris@0: # of the License, or (at your option) any later version.
Chris@909: #
Chris@0: # This program is distributed in the hope that it will be useful,
Chris@0: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@0: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@0: # GNU General Public License for more details.
Chris@909: #
Chris@0: # You should have received a copy of the GNU General Public License
Chris@0: # along with this program; if not, write to the Free Software
Chris@0: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@0: 
Chris@0: class CustomField < ActiveRecord::Base
Chris@1115:   include Redmine::SubclassFactory
Chris@1115: 
Chris@0:   has_many :custom_values, :dependent => :delete_all
Chris@0:   acts_as_list :scope => 'type = \'#{self.class}\''
Chris@0:   serialize :possible_values
Chris@909: 
Chris@0:   validates_presence_of :name, :field_format
Chris@0:   validates_uniqueness_of :name, :scope => :type
Chris@0:   validates_length_of :name, :maximum => 30
Chris@0:   validates_inclusion_of :field_format, :in => Redmine::CustomFieldFormat.available_formats
Chris@0: 
Chris@1115:   validate :validate_custom_field
Chris@1115:   before_validation :set_searchable
Chris@1295:   after_save :handle_multiplicity_change
Chris@1295: 
Chris@1295:   scope :sorted, lambda { order("#{table_name}.position ASC") }
Chris@909: 
Chris@1115:   CUSTOM_FIELDS_TABS = [
Chris@1115:     {:name => 'IssueCustomField', :partial => 'custom_fields/index',
Chris@1115:      :label => :label_issue_plural},
Chris@1115:     {:name => 'TimeEntryCustomField', :partial => 'custom_fields/index',
Chris@1115:      :label => :label_spent_time},
Chris@1115:     {:name => 'ProjectCustomField', :partial => 'custom_fields/index',
Chris@1115:      :label => :label_project_plural},
Chris@1115:     {:name => 'VersionCustomField', :partial => 'custom_fields/index',
Chris@1115:      :label => :label_version_plural},
Chris@1115:     {:name => 'UserCustomField', :partial => 'custom_fields/index',
Chris@1115:      :label => :label_user_plural},
Chris@1115:     {:name => 'GroupCustomField', :partial => 'custom_fields/index',
Chris@1115:      :label => :label_group_plural},
Chris@1115:     {:name => 'TimeEntryActivityCustomField', :partial => 'custom_fields/index',
Chris@1115:      :label => TimeEntryActivity::OptionName},
Chris@1115:     {:name => 'IssuePriorityCustomField', :partial => 'custom_fields/index',
Chris@1115:      :label => IssuePriority::OptionName},
Chris@1115:     {:name => 'DocumentCategoryCustomField', :partial => 'custom_fields/index',
Chris@1115:      :label => DocumentCategory::OptionName}
Chris@1115:   ]
Chris@1115: 
Chris@1115:   CUSTOM_FIELDS_NAMES = CUSTOM_FIELDS_TABS.collect{|v| v[:name]}
Chris@1115: 
Chris@1115:   def field_format=(arg)
Chris@1115:     # cannot change format of a saved custom field
Chris@1115:     super if new_record?
Chris@0:   end
Chris@909: 
Chris@1115:   def set_searchable
Chris@0:     # make sure these fields are not searchable
Chris@0:     self.searchable = false if %w(int float date bool).include?(field_format)
Chris@1115:     # make sure only these fields can have multiple values
Chris@1115:     self.multiple = false unless %w(list user version).include?(field_format)
Chris@0:     true
Chris@0:   end
Chris@909: 
Chris@1115:   def validate_custom_field
Chris@0:     if self.field_format == "list"
Chris@0:       errors.add(:possible_values, :blank) if self.possible_values.nil? || self.possible_values.empty?
Chris@0:       errors.add(:possible_values, :invalid) unless self.possible_values.is_a? Array
Chris@0:     end
Chris@909: 
Chris@909:     if regexp.present?
Chris@909:       begin
Chris@909:         Regexp.new(regexp)
Chris@909:       rescue
Chris@909:         errors.add(:regexp, :invalid)
Chris@909:       end
Chris@909:     end
Chris@909: 
Chris@1115:     if default_value.present? && !valid_field_value?(default_value)
Chris@1115:       errors.add(:default_value, :invalid)
Chris@1115:     end
Chris@0:   end
Chris@909: 
Chris@441:   def possible_values_options(obj=nil)
Chris@441:     case field_format
Chris@441:     when 'user', 'version'
Chris@441:       if obj.respond_to?(:project) && obj.project
Chris@441:         case field_format
Chris@441:         when 'user'
Chris@441:           obj.project.users.sort.collect {|u| [u.to_s, u.id.to_s]}
Chris@441:         when 'version'
Chris@909:           obj.project.shared_versions.sort.collect {|u| [u.to_s, u.id.to_s]}
Chris@441:         end
Chris@441:       elsif obj.is_a?(Array)
Chris@1115:         obj.collect {|o| possible_values_options(o)}.reduce(:&)
Chris@441:       else
Chris@441:         []
Chris@441:       end
Chris@1115:     when 'bool'
Chris@1115:       [[l(:general_text_Yes), '1'], [l(:general_text_No), '0']]
Chris@441:     else
Chris@1115:       possible_values || []
Chris@441:     end
Chris@441:   end
Chris@909: 
Chris@441:   def possible_values(obj=nil)
Chris@441:     case field_format
Chris@441:     when 'user', 'version'
Chris@441:       possible_values_options(obj).collect(&:last)
Chris@1115:     when 'bool'
Chris@1115:       ['1', '0']
Chris@441:     else
Chris@1115:       values = super()
Chris@1115:       if values.is_a?(Array)
Chris@1115:         values.each do |value|
Chris@1115:           value.force_encoding('UTF-8') if value.respond_to?(:force_encoding)
Chris@1115:         end
Chris@1115:       end
Chris@1115:       values || []
Chris@441:     end
Chris@441:   end
Chris@909: 
Chris@0:   # Makes possible_values accept a multiline string
Chris@0:   def possible_values=(arg)
Chris@0:     if arg.is_a?(Array)
Chris@1115:       super(arg.compact.collect(&:strip).select {|v| !v.blank?})
Chris@0:     else
Chris@0:       self.possible_values = arg.to_s.split(/[\n\r]+/)
Chris@0:     end
Chris@0:   end
Chris@909: 
Chris@0:   def cast_value(value)
Chris@0:     casted = nil
Chris@0:     unless value.blank?
Chris@0:       case field_format
Chris@0:       when 'string', 'text', 'list'
Chris@0:         casted = value
Chris@0:       when 'date'
Chris@0:         casted = begin; value.to_date; rescue; nil end
Chris@0:       when 'bool'
Chris@0:         casted = (value == '1' ? true : false)
Chris@0:       when 'int'
Chris@0:         casted = value.to_i
Chris@0:       when 'float'
Chris@0:         casted = value.to_f
Chris@441:       when 'user', 'version'
Chris@441:         casted = (value.blank? ? nil : field_format.classify.constantize.find_by_id(value.to_i))
Chris@0:       end
Chris@0:     end
Chris@0:     casted
Chris@0:   end
Chris@909: 
Chris@1115:   def value_from_keyword(keyword, customized)
Chris@1115:     possible_values_options = possible_values_options(customized)
Chris@1115:     if possible_values_options.present?
Chris@1115:       keyword = keyword.to_s.downcase
Chris@1115:       if v = possible_values_options.detect {|text, id| text.downcase == keyword}
Chris@1115:         if v.is_a?(Array)
Chris@1115:           v.last
Chris@1115:         else
Chris@1115:           v
Chris@1115:         end
Chris@1115:       end
Chris@1115:     else
Chris@1115:       keyword
Chris@1115:     end
Chris@1115:   end
Chris@1295: 
Chris@0:   # Returns a ORDER BY clause that can used to sort customized
Chris@0:   # objects by their value of the custom field.
Chris@1115:   # Returns nil if the custom field can not be used for sorting.
Chris@0:   def order_statement
Chris@1115:     return nil if multiple?
Chris@0:     case field_format
Chris@0:       when 'string', 'text', 'list', 'date', 'bool'
Chris@0:         # COALESCE is here to make sure that blank and NULL values are sorted equally
Chris@1295:         "COALESCE(#{join_alias}.value, '')"
Chris@0:       when 'int', 'float'
Chris@0:         # Make the database cast values into numeric
Chris@0:         # Postgresql will raise an error if a value can not be casted!
Chris@0:         # CustomValue validations should ensure that it doesn't occur
Chris@1295:         "CAST(CASE #{join_alias}.value WHEN '' THEN '0' ELSE #{join_alias}.value END AS decimal(30,3))"
Chris@1115:       when 'user', 'version'
Chris@1115:         value_class.fields_for_order_statement(value_join_alias)
Chris@0:       else
Chris@0:         nil
Chris@0:     end
Chris@0:   end
Chris@0: 
Chris@1115:   # Returns a GROUP BY clause that can used to group by custom value
Chris@1115:   # Returns nil if the custom field can not be used for grouping.
Chris@1295:   def group_statement
Chris@1115:     return nil if multiple?
Chris@1115:     case field_format
Chris@1115:       when 'list', 'date', 'bool', 'int'
Chris@1115:         order_statement
Chris@1115:       when 'user', 'version'
Chris@1295:         "COALESCE(#{join_alias}.value, '')"
Chris@1115:       else
Chris@1115:         nil
Chris@1115:     end
Chris@1115:   end
Chris@1115: 
Chris@1115:   def join_for_order_statement
Chris@1115:     case field_format
Chris@1115:       when 'user', 'version'
Chris@1115:         "LEFT OUTER JOIN #{CustomValue.table_name} #{join_alias}" +
Chris@1115:           " ON #{join_alias}.customized_type = '#{self.class.customized_class.base_class.name}'" +
Chris@1115:           " AND #{join_alias}.customized_id = #{self.class.customized_class.table_name}.id" +
Chris@1115:           " AND #{join_alias}.custom_field_id = #{id}" +
Chris@1115:           " AND #{join_alias}.value <> ''" +
Chris@1115:           " AND #{join_alias}.id = (SELECT max(#{join_alias}_2.id) FROM #{CustomValue.table_name} #{join_alias}_2" +
Chris@1115:             " WHERE #{join_alias}_2.customized_type = #{join_alias}.customized_type" +
Chris@1115:             " AND #{join_alias}_2.customized_id = #{join_alias}.customized_id" +
Chris@1115:             " AND #{join_alias}_2.custom_field_id = #{join_alias}.custom_field_id)" +
Chris@1115:           " LEFT OUTER JOIN #{value_class.table_name} #{value_join_alias}" +
Chris@1295:           " ON CAST(CASE #{join_alias}.value WHEN '' THEN '0' ELSE #{join_alias}.value END AS decimal(30,0)) = #{value_join_alias}.id"
Chris@1295:       when 'int', 'float'
Chris@1295:         "LEFT OUTER JOIN #{CustomValue.table_name} #{join_alias}" +
Chris@1295:           " ON #{join_alias}.customized_type = '#{self.class.customized_class.base_class.name}'" +
Chris@1295:           " AND #{join_alias}.customized_id = #{self.class.customized_class.table_name}.id" +
Chris@1295:           " AND #{join_alias}.custom_field_id = #{id}" +
Chris@1295:           " AND #{join_alias}.value <> ''" +
Chris@1295:           " AND #{join_alias}.id = (SELECT max(#{join_alias}_2.id) FROM #{CustomValue.table_name} #{join_alias}_2" +
Chris@1295:             " WHERE #{join_alias}_2.customized_type = #{join_alias}.customized_type" +
Chris@1295:             " AND #{join_alias}_2.customized_id = #{join_alias}.customized_id" +
Chris@1295:             " AND #{join_alias}_2.custom_field_id = #{join_alias}.custom_field_id)"
Chris@1295:       when 'string', 'text', 'list', 'date', 'bool'
Chris@1295:         "LEFT OUTER JOIN #{CustomValue.table_name} #{join_alias}" +
Chris@1295:           " ON #{join_alias}.customized_type = '#{self.class.customized_class.base_class.name}'" +
Chris@1295:           " AND #{join_alias}.customized_id = #{self.class.customized_class.table_name}.id" +
Chris@1295:           " AND #{join_alias}.custom_field_id = #{id}" +
Chris@1295:           " AND #{join_alias}.id = (SELECT max(#{join_alias}_2.id) FROM #{CustomValue.table_name} #{join_alias}_2" +
Chris@1295:             " WHERE #{join_alias}_2.customized_type = #{join_alias}.customized_type" +
Chris@1295:             " AND #{join_alias}_2.customized_id = #{join_alias}.customized_id" +
Chris@1295:             " AND #{join_alias}_2.custom_field_id = #{join_alias}.custom_field_id)"
Chris@1115:       else
Chris@1115:         nil
Chris@1115:     end
Chris@1115:   end
Chris@1115: 
Chris@1115:   def join_alias
Chris@1115:     "cf_#{id}"
Chris@1115:   end
Chris@1115: 
Chris@1115:   def value_join_alias
Chris@1115:     join_alias + "_" + field_format
Chris@1115:   end
Chris@1115: 
Chris@0:   def <=>(field)
Chris@0:     position <=> field.position
Chris@0:   end
Chris@909: 
Chris@1115:   # Returns the class that values represent
Chris@1115:   def value_class
Chris@1115:     case field_format
Chris@1115:       when 'user', 'version'
Chris@1115:         field_format.classify.constantize
Chris@1115:       else
Chris@1115:         nil
Chris@1115:     end
Chris@1115:   end
Chris@1115: 
Chris@0:   def self.customized_class
Chris@0:     self.name =~ /^(.+)CustomField$/
Chris@0:     begin; $1.constantize; rescue nil; end
Chris@0:   end
Chris@909: 
Chris@0:   # to move in project_custom_field
Chris@0:   def self.for_all
Chris@1295:     where(:is_for_all => true).order('position').all
Chris@0:   end
Chris@909: 
Chris@0:   def type_name
Chris@0:     nil
Chris@0:   end
Chris@1115: 
Chris@1115:   # Returns the error messages for the given value
Chris@1115:   # or an empty array if value is a valid value for the custom field
Chris@1115:   def validate_field_value(value)
Chris@1115:     errs = []
Chris@1115:     if value.is_a?(Array)
Chris@1115:       if !multiple?
Chris@1115:         errs << ::I18n.t('activerecord.errors.messages.invalid')
Chris@1115:       end
Chris@1115:       if is_required? && value.detect(&:present?).nil?
Chris@1115:         errs << ::I18n.t('activerecord.errors.messages.blank')
Chris@1115:       end
Chris@1115:       value.each {|v| errs += validate_field_value_format(v)}
Chris@1115:     else
Chris@1115:       if is_required? && value.blank?
Chris@1115:         errs << ::I18n.t('activerecord.errors.messages.blank')
Chris@1115:       end
Chris@1115:       errs += validate_field_value_format(value)
Chris@1115:     end
Chris@1115:     errs
Chris@1115:   end
Chris@1115: 
Chris@1115:   # Returns true if value is a valid value for the custom field
Chris@1115:   def valid_field_value?(value)
Chris@1115:     validate_field_value(value).empty?
Chris@1115:   end
Chris@1115: 
Chris@1115:   def format_in?(*args)
Chris@1115:     args.include?(field_format)
Chris@1115:   end
Chris@1115: 
Chris@1115:   protected
Chris@1115: 
Chris@1115:   # Returns the error message for the given value regarding its format
Chris@1115:   def validate_field_value_format(value)
Chris@1115:     errs = []
Chris@1115:     if value.present?
Chris@1115:       errs << ::I18n.t('activerecord.errors.messages.invalid') unless regexp.blank? or value =~ Regexp.new(regexp)
Chris@1115:       errs << ::I18n.t('activerecord.errors.messages.too_short', :count => min_length) if min_length > 0 and value.length < min_length
Chris@1115:       errs << ::I18n.t('activerecord.errors.messages.too_long', :count => max_length) if max_length > 0 and value.length > max_length
Chris@1115: 
Chris@1115:       # Format specific validations
Chris@1115:       case field_format
Chris@1115:       when 'int'
Chris@1115:         errs << ::I18n.t('activerecord.errors.messages.not_a_number') unless value =~ /^[+-]?\d+$/
Chris@1115:       when 'float'
Chris@1115:         begin; Kernel.Float(value); rescue; errs << ::I18n.t('activerecord.errors.messages.invalid') end
Chris@1115:       when 'date'
Chris@1115:         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@1115:       when 'list'
Chris@1115:         errs << ::I18n.t('activerecord.errors.messages.inclusion') unless possible_values.include?(value)
Chris@1115:       end
Chris@1115:     end
Chris@1115:     errs
Chris@1115:   end
Chris@1295: 
Chris@1295:   # Removes multiple values for the custom field after setting the multiple attribute to false
Chris@1295:   # We kepp the value with the highest id for each customized object
Chris@1295:   def handle_multiplicity_change
Chris@1295:     if !new_record? && multiple_was && !multiple
Chris@1295:       ids = custom_values.
Chris@1295:         where("EXISTS(SELECT 1 FROM #{CustomValue.table_name} cve WHERE cve.custom_field_id = #{CustomValue.table_name}.custom_field_id" +
Chris@1295:           " AND cve.customized_type = #{CustomValue.table_name}.customized_type AND cve.customized_id = #{CustomValue.table_name}.customized_id" +
Chris@1295:           " AND cve.id > #{CustomValue.table_name}.id)").
Chris@1295:         pluck(:id)
Chris@1295: 
Chris@1295:       if ids.any?
Chris@1295:         custom_values.where(:id => ids).delete_all
Chris@1295:       end
Chris@1295:     end
Chris@1295:   end
Chris@0: end