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