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 CustomField < ActiveRecord::Base
Chris@909:   has_many :custom_values, :dependent => :delete_all
Chris@909:   acts_as_list :scope => 'type = \'#{self.class}\''
Chris@909:   serialize :possible_values
Chris@909: 
Chris@909:   validates_presence_of :name, :field_format
Chris@909:   validates_uniqueness_of :name, :scope => :type
Chris@909:   validates_length_of :name, :maximum => 30
Chris@909:   validates_inclusion_of :field_format, :in => Redmine::CustomFieldFormat.available_formats
Chris@909: 
Chris@909:   validate :validate_values
Chris@909: 
Chris@909:   def initialize(attributes = nil)
Chris@909:     super
Chris@909:     self.possible_values ||= []
Chris@909:   end
Chris@909: 
Chris@909:   def before_validation
Chris@909:     # make sure these fields are not searchable
Chris@909:     self.searchable = false if %w(int float date bool).include?(field_format)
Chris@909:     true
Chris@909:   end
Chris@909: 
Chris@909:   def validate_values
Chris@909:     if self.field_format == "list"
Chris@909:       errors.add(:possible_values, :blank) if self.possible_values.nil? || self.possible_values.empty?
Chris@909:       errors.add(:possible_values, :invalid) unless self.possible_values.is_a? Array
Chris@909:     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@909:     # validate default value
Chris@909:     v = CustomValue.new(:custom_field => self.clone, :value => default_value, :customized => nil)
Chris@909:     v.custom_field.is_required = false
Chris@909:     errors.add(:default_value, :invalid) unless v.valid?
Chris@909:   end
Chris@909: 
Chris@909:   def possible_values_options(obj=nil)
Chris@909:     case field_format
Chris@909:     when 'user', 'version'
Chris@909:       if obj.respond_to?(:project) && obj.project
Chris@909:         case field_format
Chris@909:         when 'user'
Chris@909:           obj.project.users.sort.collect {|u| [u.to_s, u.id.to_s]}
Chris@909:         when 'version'
Chris@909:           obj.project.shared_versions.sort.collect {|u| [u.to_s, u.id.to_s]}
Chris@909:         end
Chris@909:       elsif obj.is_a?(Array)
Chris@909:         obj.collect {|o| possible_values_options(o)}.inject {|memo, v| memo & v}
Chris@909:       else
Chris@909:         []
Chris@909:       end
Chris@909:     else
Chris@909:       read_attribute :possible_values
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   def possible_values(obj=nil)
Chris@909:     case field_format
Chris@909:     when 'user', 'version'
Chris@909:       possible_values_options(obj).collect(&:last)
Chris@909:     else
Chris@909:       read_attribute :possible_values
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   # Makes possible_values accept a multiline string
Chris@909:   def possible_values=(arg)
Chris@909:     if arg.is_a?(Array)
Chris@909:       write_attribute(:possible_values, arg.compact.collect(&:strip).select {|v| !v.blank?})
Chris@909:     else
Chris@909:       self.possible_values = arg.to_s.split(/[\n\r]+/)
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   def cast_value(value)
Chris@909:     casted = nil
Chris@909:     unless value.blank?
Chris@909:       case field_format
Chris@909:       when 'string', 'text', 'list'
Chris@909:         casted = value
Chris@909:       when 'date'
Chris@909:         casted = begin; value.to_date; rescue; nil end
Chris@909:       when 'bool'
Chris@909:         casted = (value == '1' ? true : false)
Chris@909:       when 'int'
Chris@909:         casted = value.to_i
Chris@909:       when 'float'
Chris@909:         casted = value.to_f
Chris@909:       when 'user', 'version'
Chris@909:         casted = (value.blank? ? nil : field_format.classify.constantize.find_by_id(value.to_i))
Chris@909:       end
Chris@909:     end
Chris@909:     casted
Chris@909:   end
Chris@909: 
Chris@909:   # Returns a ORDER BY clause that can used to sort customized
Chris@909:   # objects by their value of the custom field.
Chris@909:   # Returns false, if the custom field can not be used for sorting.
Chris@909:   def order_statement
Chris@909:     case field_format
Chris@909:       when 'string', 'text', 'list', 'date', 'bool'
Chris@909:         # COALESCE is here to make sure that blank and NULL values are sorted equally
Chris@909:         "COALESCE((SELECT cv_sort.value FROM #{CustomValue.table_name} cv_sort" +
Chris@909:           " WHERE cv_sort.customized_type='#{self.class.customized_class.name}'" +
Chris@909:           " AND cv_sort.customized_id=#{self.class.customized_class.table_name}.id" +
Chris@909:           " AND cv_sort.custom_field_id=#{id} LIMIT 1), '')"
Chris@909:       when 'int', 'float'
Chris@909:         # Make the database cast values into numeric
Chris@909:         # Postgresql will raise an error if a value can not be casted!
Chris@909:         # CustomValue validations should ensure that it doesn't occur
Chris@909:         "(SELECT CAST(cv_sort.value AS decimal(60,3)) FROM #{CustomValue.table_name} cv_sort" +
Chris@909:           " WHERE cv_sort.customized_type='#{self.class.customized_class.name}'" +
Chris@909:           " AND cv_sort.customized_id=#{self.class.customized_class.table_name}.id" +
Chris@909:           " AND cv_sort.custom_field_id=#{id} AND cv_sort.value <> '' AND cv_sort.value IS NOT NULL LIMIT 1)"
Chris@909:       else
Chris@909:         nil
Chris@909:     end
Chris@909:   end
Chris@909: 
Chris@909:   def <=>(field)
Chris@909:     position <=> field.position
Chris@909:   end
Chris@909: 
Chris@909:   def self.customized_class
Chris@909:     self.name =~ /^(.+)CustomField$/
Chris@909:     begin; $1.constantize; rescue nil; end
Chris@909:   end
Chris@909: 
Chris@909:   # to move in project_custom_field
Chris@909:   def self.for_all
Chris@909:     find(:all, :conditions => ["is_for_all=?", true], :order => 'position')
Chris@909:   end
Chris@909: 
Chris@909:   def type_name
Chris@909:     nil
Chris@909:   end
Chris@909: end