Chris@1517: # Redmine - project management software
Chris@1517: # Copyright (C) 2006-2014  Jean-Philippe Lang
Chris@1517: #
Chris@1517: # This program is free software; you can redistribute it and/or
Chris@1517: # modify it under the terms of the GNU General Public License
Chris@1517: # as published by the Free Software Foundation; either version 2
Chris@1517: # of the License, or (at your option) any later version.
Chris@1517: #
Chris@1517: # This program is distributed in the hope that it will be useful,
Chris@1517: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1517: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1517: # GNU General Public License for more details.
Chris@1517: #
Chris@1517: # You should have received a copy of the GNU General Public License
Chris@1517: # along with this program; if not, write to the Free Software
Chris@1517: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1517: 
Chris@1517: module Redmine
Chris@1517:   module FieldFormat
Chris@1517:     def self.add(name, klass)
Chris@1517:       all[name.to_s] = klass.instance
Chris@1517:     end
Chris@1517: 
Chris@1517:     def self.delete(name)
Chris@1517:       all.delete(name.to_s)
Chris@1517:     end
Chris@1517: 
Chris@1517:     def self.all
Chris@1517:       @formats ||= Hash.new(Base.instance)
Chris@1517:     end
Chris@1517: 
Chris@1517:     def self.available_formats
Chris@1517:       all.keys
Chris@1517:     end
Chris@1517: 
Chris@1517:     def self.find(name)
Chris@1517:       all[name.to_s]
Chris@1517:     end
Chris@1517: 
Chris@1517:     # Return an array of custom field formats which can be used in select_tag
Chris@1517:     def self.as_select(class_name=nil)
Chris@1517:       formats = all.values.select do |format|
Chris@1517:         format.class.customized_class_names.nil? || format.class.customized_class_names.include?(class_name)
Chris@1517:       end
Chris@1517:       formats.map {|format| [::I18n.t(format.label), format.name] }.sort_by(&:first)
Chris@1517:     end
Chris@1517: 
Chris@1517:     class Base
Chris@1517:       include Singleton
Chris@1517:       include Redmine::I18n
Chris@1517:       include ERB::Util
Chris@1517: 
Chris@1517:       class_attribute :format_name
Chris@1517:       self.format_name = nil
Chris@1517: 
Chris@1517:       # Set this to true if the format supports multiple values
Chris@1517:       class_attribute :multiple_supported
Chris@1517:       self.multiple_supported = false
Chris@1517: 
Chris@1517:       # Set this to true if the format supports textual search on custom values
Chris@1517:       class_attribute :searchable_supported
Chris@1517:       self.searchable_supported = false
Chris@1517: 
Chris@1517:       # Restricts the classes that the custom field can be added to
Chris@1517:       # Set to nil for no restrictions
Chris@1517:       class_attribute :customized_class_names
Chris@1517:       self.customized_class_names = nil
Chris@1517: 
Chris@1517:       # Name of the partial for editing the custom field
Chris@1517:       class_attribute :form_partial
Chris@1517:       self.form_partial = nil
Chris@1517: 
Chris@1517:       def self.add(name)
Chris@1517:         self.format_name = name
Chris@1517:         Redmine::FieldFormat.add(name, self)
Chris@1517:       end
Chris@1517:       private_class_method :add
Chris@1517: 
Chris@1517:       def self.field_attributes(*args)
Chris@1517:         CustomField.store_accessor :format_store, *args
Chris@1517:       end
Chris@1517: 
Chris@1517:       field_attributes :url_pattern
Chris@1517: 
Chris@1517:       def name
Chris@1517:         self.class.format_name
Chris@1517:       end
Chris@1517: 
Chris@1517:       def label
Chris@1517:         "label_#{name}"
Chris@1517:       end
Chris@1517: 
Chris@1517:       def cast_custom_value(custom_value)
Chris@1517:         cast_value(custom_value.custom_field, custom_value.value, custom_value.customized)
Chris@1517:       end
Chris@1517: 
Chris@1517:       def cast_value(custom_field, value, customized=nil)
Chris@1517:         if value.blank?
Chris@1517:           nil
Chris@1517:         elsif value.is_a?(Array)
Chris@1517:           casted = value.map do |v|
Chris@1517:             cast_single_value(custom_field, v, customized)
Chris@1517:           end
Chris@1517:           casted.compact.sort
Chris@1517:         else
Chris@1517:           cast_single_value(custom_field, value, customized)
Chris@1517:         end
Chris@1517:       end
Chris@1517: 
Chris@1517:       def cast_single_value(custom_field, value, customized=nil)
Chris@1517:         value.to_s
Chris@1517:       end
Chris@1517: 
Chris@1517:       def target_class
Chris@1517:         nil
Chris@1517:       end
Chris@1517:  
Chris@1517:       def possible_custom_value_options(custom_value)
Chris@1517:         possible_values_options(custom_value.custom_field, custom_value.customized)
Chris@1517:       end
Chris@1517: 
Chris@1517:       def possible_values_options(custom_field, object=nil)
Chris@1517:         []
Chris@1517:       end
Chris@1517: 
Chris@1517:       # Returns the validation errors for custom_field
Chris@1517:       # Should return an empty array if custom_field is valid
Chris@1517:       def validate_custom_field(custom_field)
Chris@1517:         []
Chris@1517:       end
Chris@1517: 
Chris@1517:       # Returns the validation error messages for custom_value
Chris@1517:       # Should return an empty array if custom_value is valid
Chris@1517:       def validate_custom_value(custom_value)
Chris@1517:         values = Array.wrap(custom_value.value).reject {|value| value.to_s == ''}
Chris@1517:         errors = values.map do |value|
Chris@1517:           validate_single_value(custom_value.custom_field, value, custom_value.customized)
Chris@1517:         end
Chris@1517:         errors.flatten.uniq
Chris@1517:       end
Chris@1517: 
Chris@1517:       def validate_single_value(custom_field, value, customized=nil)
Chris@1517:         []
Chris@1517:       end
Chris@1517: 
Chris@1517:       def formatted_custom_value(view, custom_value, html=false)
Chris@1517:         formatted_value(view, custom_value.custom_field, custom_value.value, custom_value.customized, html)
Chris@1517:       end
Chris@1517: 
Chris@1517:       def formatted_value(view, custom_field, value, customized=nil, html=false)
Chris@1517:         casted = cast_value(custom_field, value, customized)
Chris@1517:         if html && custom_field.url_pattern.present?
Chris@1517:           texts_and_urls = Array.wrap(casted).map do |single_value|
Chris@1517:             text = view.format_object(single_value, false).to_s
Chris@1517:             url = url_from_pattern(custom_field, single_value, customized)
Chris@1517:             [text, url]
Chris@1517:           end
Chris@1517:           links = texts_and_urls.sort_by(&:first).map {|text, url| view.link_to text, url}
Chris@1517:           links.join(', ').html_safe
Chris@1517:         else
Chris@1517:           casted
Chris@1517:         end
Chris@1517:       end
Chris@1517: 
Chris@1517:       # Returns an URL generated with the custom field URL pattern
Chris@1517:       # and variables substitution:
Chris@1517:       # %value% => the custom field value
Chris@1517:       # %id% => id of the customized object
Chris@1517:       # %project_id% => id of the project of the customized object if defined
Chris@1517:       # %project_identifier% => identifier of the project of the customized object if defined
Chris@1517:       # %m1%, %m2%... => capture groups matches of the custom field regexp if defined
Chris@1517:       def url_from_pattern(custom_field, value, customized)
Chris@1517:         url = custom_field.url_pattern.to_s.dup
Chris@1517:         url.gsub!('%value%') {value.to_s}
Chris@1517:         url.gsub!('%id%') {customized.id.to_s}
Chris@1517:         url.gsub!('%project_id%') {(customized.respond_to?(:project) ? customized.project.try(:id) : nil).to_s}
Chris@1517:         url.gsub!('%project_identifier%') {(customized.respond_to?(:project) ? customized.project.try(:identifier) : nil).to_s}
Chris@1517:         if custom_field.regexp.present?
Chris@1517:           url.gsub!(%r{%m(\d+)%}) do
Chris@1517:             m = $1.to_i
Chris@1517:             if matches ||= value.to_s.match(Regexp.new(custom_field.regexp))
Chris@1517:               matches[m].to_s
Chris@1517:             end
Chris@1517:           end
Chris@1517:         end
Chris@1517:         url
Chris@1517:       end
Chris@1517:       protected :url_from_pattern
Chris@1517: 
Chris@1517:       def edit_tag(view, tag_id, tag_name, custom_value, options={})
Chris@1517:         view.text_field_tag(tag_name, custom_value.value, options.merge(:id => tag_id))
Chris@1517:       end
Chris@1517: 
Chris@1517:       def bulk_edit_tag(view, tag_id, tag_name, custom_field, objects, value, options={})
Chris@1517:         view.text_field_tag(tag_name, value, options.merge(:id => tag_id)) +
Chris@1517:           bulk_clear_tag(view, tag_id, tag_name, custom_field, value)
Chris@1517:       end
Chris@1517: 
Chris@1517:       def bulk_clear_tag(view, tag_id, tag_name, custom_field, value)
Chris@1517:         if custom_field.is_required?
Chris@1517:           ''.html_safe
Chris@1517:         else
Chris@1517:           view.content_tag('label',
Chris@1517:             view.check_box_tag(tag_name, '__none__', (value == '__none__'), :id => nil, :data => {:disables => "##{tag_id}"}) + l(:button_clear),
Chris@1517:             :class => 'inline'
Chris@1517:           )
Chris@1517:         end
Chris@1517:       end
Chris@1517:       protected :bulk_clear_tag
Chris@1517: 
Chris@1517:       def query_filter_options(custom_field, query)
Chris@1517:         {:type => :string}
Chris@1517:       end
Chris@1517: 
Chris@1517:       def before_custom_field_save(custom_field)
Chris@1517:       end
Chris@1517: 
Chris@1517:       # Returns a ORDER BY clause that can used to sort customized
Chris@1517:       # objects by their value of the custom field.
Chris@1517:       # Returns nil if the custom field can not be used for sorting.
Chris@1517:       def order_statement(custom_field)
Chris@1517:         # COALESCE is here to make sure that blank and NULL values are sorted equally
Chris@1517:         "COALESCE(#{join_alias custom_field}.value, '')"
Chris@1517:       end
Chris@1517: 
Chris@1517:       # Returns a GROUP BY clause that can used to group by custom value
Chris@1517:       # Returns nil if the custom field can not be used for grouping.
Chris@1517:       def group_statement(custom_field)
Chris@1517:         nil
Chris@1517:       end
Chris@1517: 
Chris@1517:       # Returns a JOIN clause that is added to the query when sorting by custom values
Chris@1517:       def join_for_order_statement(custom_field)
Chris@1517:         alias_name = join_alias(custom_field)
Chris@1517: 
Chris@1517:         "LEFT OUTER JOIN #{CustomValue.table_name} #{alias_name}" +
Chris@1517:           " ON #{alias_name}.customized_type = '#{custom_field.class.customized_class.base_class.name}'" +
Chris@1517:           " AND #{alias_name}.customized_id = #{custom_field.class.customized_class.table_name}.id" +
Chris@1517:           " AND #{alias_name}.custom_field_id = #{custom_field.id}" +
Chris@1517:           " AND (#{custom_field.visibility_by_project_condition})" +
Chris@1517:           " AND #{alias_name}.value <> ''" +
Chris@1517:           " AND #{alias_name}.id = (SELECT max(#{alias_name}_2.id) FROM #{CustomValue.table_name} #{alias_name}_2" +
Chris@1517:             " WHERE #{alias_name}_2.customized_type = #{alias_name}.customized_type" +
Chris@1517:             " AND #{alias_name}_2.customized_id = #{alias_name}.customized_id" +
Chris@1517:             " AND #{alias_name}_2.custom_field_id = #{alias_name}.custom_field_id)"
Chris@1517:       end
Chris@1517: 
Chris@1517:       def join_alias(custom_field)
Chris@1517:         "cf_#{custom_field.id}"
Chris@1517:       end
Chris@1517:       protected :join_alias
Chris@1517:     end
Chris@1517: 
Chris@1517:     class Unbounded < Base
Chris@1517:       def validate_single_value(custom_field, value, customized=nil)
Chris@1517:         errs = super
Chris@1517:         value = value.to_s
Chris@1517:         unless custom_field.regexp.blank? or value =~ Regexp.new(custom_field.regexp)
Chris@1517:           errs << ::I18n.t('activerecord.errors.messages.invalid')
Chris@1517:         end
Chris@1517:         if custom_field.min_length && value.length < custom_field.min_length
Chris@1517:           errs << ::I18n.t('activerecord.errors.messages.too_short', :count => custom_field.min_length)
Chris@1517:         end
Chris@1517:         if custom_field.max_length && custom_field.max_length > 0 && value.length > custom_field.max_length
Chris@1517:           errs << ::I18n.t('activerecord.errors.messages.too_long', :count => custom_field.max_length)
Chris@1517:         end
Chris@1517:         errs
Chris@1517:       end
Chris@1517:     end
Chris@1517: 
Chris@1517:     class StringFormat < Unbounded
Chris@1517:       add 'string'
Chris@1517:       self.searchable_supported = true
Chris@1517:       self.form_partial = 'custom_fields/formats/string'
Chris@1517:       field_attributes :text_formatting
Chris@1517: 
Chris@1517:       def formatted_value(view, custom_field, value, customized=nil, html=false)
Chris@1517:         if html
Chris@1517:           if custom_field.url_pattern.present?
Chris@1517:             super
Chris@1517:           elsif custom_field.text_formatting == 'full'
Chris@1517:             view.textilizable(value, :object => customized)
Chris@1517:           else
Chris@1517:             value.to_s
Chris@1517:           end
Chris@1517:         else
Chris@1517:           value.to_s
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517: 
Chris@1517:     class TextFormat < Unbounded
Chris@1517:       add 'text'
Chris@1517:       self.searchable_supported = true
Chris@1517:       self.form_partial = 'custom_fields/formats/text'
Chris@1517: 
Chris@1517:       def formatted_value(view, custom_field, value, customized=nil, html=false)
Chris@1517:         if html
Chris@1517:           if custom_field.text_formatting == 'full'
Chris@1517:             view.textilizable(value, :object => customized)
Chris@1517:           else
Chris@1517:             view.simple_format(html_escape(value))
Chris@1517:           end
Chris@1517:         else
Chris@1517:           value.to_s
Chris@1517:         end
Chris@1517:       end
Chris@1517: 
Chris@1517:       def edit_tag(view, tag_id, tag_name, custom_value, options={})
Chris@1517:         view.text_area_tag(tag_name, custom_value.value, options.merge(:id => tag_id, :rows => 3))
Chris@1517:       end
Chris@1517: 
Chris@1517:       def bulk_edit_tag(view, tag_id, tag_name, custom_field, objects, value, options={})
Chris@1517:         view.text_area_tag(tag_name, value, options.merge(:id => tag_id, :rows => 3)) +
Chris@1517:           '<br />'.html_safe +
Chris@1517:           bulk_clear_tag(view, tag_id, tag_name, custom_field, value)
Chris@1517:       end
Chris@1517: 
Chris@1517:       def query_filter_options(custom_field, query)
Chris@1517:         {:type => :text}
Chris@1517:       end
Chris@1517:     end
Chris@1517: 
Chris@1517:     class LinkFormat < StringFormat
Chris@1517:       add 'link'
Chris@1517:       self.searchable_supported = false
Chris@1517:       self.form_partial = 'custom_fields/formats/link'
Chris@1517: 
Chris@1517:       def formatted_value(view, custom_field, value, customized=nil, html=false)
Chris@1517:         if html
Chris@1517:           if custom_field.url_pattern.present?
Chris@1517:             url = url_from_pattern(custom_field, value, customized)
Chris@1517:           else
Chris@1517:             url = value.to_s
Chris@1517:             unless url =~ %r{\A[a-z]+://}i
Chris@1517:               # no protocol found, use http by default
Chris@1517:               url = "http://" + url
Chris@1517:             end
Chris@1517:           end
Chris@1517:           view.link_to value.to_s, url
Chris@1517:         else
Chris@1517:           value.to_s
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517: 
Chris@1517:     class Numeric < Unbounded
Chris@1517:       self.form_partial = 'custom_fields/formats/numeric'
Chris@1517: 
Chris@1517:       def order_statement(custom_field)
Chris@1517:         # Make the database cast values into numeric
Chris@1517:         # Postgresql will raise an error if a value can not be casted!
Chris@1517:         # CustomValue validations should ensure that it doesn't occur
Chris@1517:         "CAST(CASE #{join_alias custom_field}.value WHEN '' THEN '0' ELSE #{join_alias custom_field}.value END AS decimal(30,3))"
Chris@1517:       end
Chris@1517:     end
Chris@1517: 
Chris@1517:     class IntFormat < Numeric
Chris@1517:       add 'int'
Chris@1517: 
Chris@1517:       def label
Chris@1517:         "label_integer"
Chris@1517:       end
Chris@1517: 
Chris@1517:       def cast_single_value(custom_field, value, customized=nil)
Chris@1517:         value.to_i
Chris@1517:       end
Chris@1517: 
Chris@1517:       def validate_single_value(custom_field, value, customized=nil)
Chris@1517:         errs = super
Chris@1517:         errs << ::I18n.t('activerecord.errors.messages.not_a_number') unless value =~ /^[+-]?\d+$/
Chris@1517:         errs
Chris@1517:       end
Chris@1517: 
Chris@1517:       def query_filter_options(custom_field, query)
Chris@1517:         {:type => :integer}
Chris@1517:       end
Chris@1517: 
Chris@1517:       def group_statement(custom_field)
Chris@1517:         order_statement(custom_field)
Chris@1517:       end
Chris@1517:     end
Chris@1517: 
Chris@1517:     class FloatFormat < Numeric
Chris@1517:       add 'float'
Chris@1517: 
Chris@1517:       def cast_single_value(custom_field, value, customized=nil)
Chris@1517:         value.to_f
Chris@1517:       end
Chris@1517: 
Chris@1517:       def validate_single_value(custom_field, value, customized=nil)
Chris@1517:         errs = super
Chris@1517:         errs << ::I18n.t('activerecord.errors.messages.invalid') unless (Kernel.Float(value) rescue nil)
Chris@1517:         errs
Chris@1517:       end
Chris@1517: 
Chris@1517:       def query_filter_options(custom_field, query)
Chris@1517:         {:type => :float}
Chris@1517:       end
Chris@1517:     end
Chris@1517: 
Chris@1517:     class DateFormat < Unbounded
Chris@1517:       add 'date'
Chris@1517:       self.form_partial = 'custom_fields/formats/date'
Chris@1517: 
Chris@1517:       def cast_single_value(custom_field, value, customized=nil)
Chris@1517:         value.to_date rescue nil
Chris@1517:       end
Chris@1517: 
Chris@1517:       def validate_single_value(custom_field, value, customized=nil)
Chris@1517:         if value =~ /^\d{4}-\d{2}-\d{2}$/ && (value.to_date rescue false)
Chris@1517:           []
Chris@1517:         else
Chris@1517:           [::I18n.t('activerecord.errors.messages.not_a_date')]
Chris@1517:         end
Chris@1517:       end
Chris@1517: 
Chris@1517:       def edit_tag(view, tag_id, tag_name, custom_value, options={})
Chris@1517:         view.text_field_tag(tag_name, custom_value.value, options.merge(:id => tag_id, :size => 10)) +
Chris@1517:           view.calendar_for(tag_id)
Chris@1517:       end
Chris@1517: 
Chris@1517:       def bulk_edit_tag(view, tag_id, tag_name, custom_field, objects, value, options={})
Chris@1517:         view.text_field_tag(tag_name, value, options.merge(:id => tag_id, :size => 10)) +
Chris@1517:           view.calendar_for(tag_id) +
Chris@1517:           bulk_clear_tag(view, tag_id, tag_name, custom_field, value)
Chris@1517:       end
Chris@1517: 
Chris@1517:       def query_filter_options(custom_field, query)
Chris@1517:         {:type => :date}
Chris@1517:       end
Chris@1517: 
Chris@1517:       def group_statement(custom_field)
Chris@1517:         order_statement(custom_field)
Chris@1517:       end
Chris@1517:     end
Chris@1517: 
Chris@1517:     class List < Base
Chris@1517:       self.multiple_supported = true
Chris@1517:       field_attributes :edit_tag_style
Chris@1517: 
Chris@1517:       def edit_tag(view, tag_id, tag_name, custom_value, options={})
Chris@1517:         if custom_value.custom_field.edit_tag_style == 'check_box'
Chris@1517:           check_box_edit_tag(view, tag_id, tag_name, custom_value, options)
Chris@1517:         else
Chris@1517:           select_edit_tag(view, tag_id, tag_name, custom_value, options)
Chris@1517:         end
Chris@1517:       end
Chris@1517: 
Chris@1517:       def bulk_edit_tag(view, tag_id, tag_name, custom_field, objects, value, options={})
Chris@1517:         opts = []
Chris@1517:         opts << [l(:label_no_change_option), ''] unless custom_field.multiple?
Chris@1517:         opts << [l(:label_none), '__none__'] unless custom_field.is_required?
Chris@1517:         opts += possible_values_options(custom_field, objects)
Chris@1517:         view.select_tag(tag_name, view.options_for_select(opts, value), options.merge(:multiple => custom_field.multiple?))
Chris@1517:       end
Chris@1517: 
Chris@1517:       def query_filter_options(custom_field, query)
Chris@1517:         {:type => :list_optional, :values => possible_values_options(custom_field, query.project)}
Chris@1517:       end
Chris@1517: 
Chris@1517:       protected
Chris@1517: 
Chris@1517:       # Renders the edit tag as a select tag
Chris@1517:       def select_edit_tag(view, tag_id, tag_name, custom_value, options={})
Chris@1517:         blank_option = ''.html_safe
Chris@1517:         unless custom_value.custom_field.multiple?
Chris@1517:           if custom_value.custom_field.is_required?
Chris@1517:             unless custom_value.custom_field.default_value.present?
Chris@1517:               blank_option = view.content_tag('option', "--- #{l(:actionview_instancetag_blank_option)} ---", :value => '')
Chris@1517:             end
Chris@1517:           else
Chris@1517:             blank_option = view.content_tag('option', '&nbsp;'.html_safe, :value => '')
Chris@1517:           end
Chris@1517:         end
Chris@1517:         options_tags = blank_option + view.options_for_select(possible_custom_value_options(custom_value), custom_value.value)
Chris@1517:         s = view.select_tag(tag_name, options_tags, options.merge(:id => tag_id, :multiple => custom_value.custom_field.multiple?))
Chris@1517:         if custom_value.custom_field.multiple?
Chris@1517:           s << view.hidden_field_tag(tag_name, '')
Chris@1517:         end
Chris@1517:         s
Chris@1517:       end
Chris@1517: 
Chris@1517:       # Renders the edit tag as check box or radio tags
Chris@1517:       def check_box_edit_tag(view, tag_id, tag_name, custom_value, options={})
Chris@1517:         opts = []
Chris@1517:         unless custom_value.custom_field.multiple? || custom_value.custom_field.is_required?
Chris@1517:           opts << ["(#{l(:label_none)})", '']
Chris@1517:         end
Chris@1517:         opts += possible_custom_value_options(custom_value)
Chris@1517:         s = ''.html_safe
Chris@1517:         tag_method = custom_value.custom_field.multiple? ? :check_box_tag : :radio_button_tag
Chris@1517:         opts.each do |label, value|
Chris@1517:           value ||= label
Chris@1517:           checked = (custom_value.value.is_a?(Array) && custom_value.value.include?(value)) || custom_value.value.to_s == value
Chris@1517:           tag = view.send(tag_method, tag_name, value, checked, :id => tag_id)
Chris@1517:           # set the id on the first tag only
Chris@1517:           tag_id = nil
Chris@1517:           s << view.content_tag('label', tag + ' ' + label) 
Chris@1517:         end
Chris@1517:         if custom_value.custom_field.multiple?
Chris@1517:           s << view.hidden_field_tag(tag_name, '')
Chris@1517:         end
Chris@1517:         css = "#{options[:class]} check_box_group"
Chris@1517:         view.content_tag('span', s, options.merge(:class => css))
Chris@1517:       end
Chris@1517:     end
Chris@1517: 
Chris@1517:     class ListFormat < List
Chris@1517:       add 'list'
Chris@1517:       self.searchable_supported = true
Chris@1517:       self.form_partial = 'custom_fields/formats/list'
Chris@1517:  
Chris@1517:       def possible_custom_value_options(custom_value)
Chris@1517:         options = possible_values_options(custom_value.custom_field)
Chris@1517:         missing = [custom_value.value].flatten.reject(&:blank?) - options
Chris@1517:         if missing.any?
Chris@1517:           options += missing
Chris@1517:         end
Chris@1517:         options
Chris@1517:       end
Chris@1517: 
Chris@1517:       def possible_values_options(custom_field, object=nil)
Chris@1517:         custom_field.possible_values
Chris@1517:       end
Chris@1517: 
Chris@1517:       def validate_custom_field(custom_field)
Chris@1517:         errors = []
Chris@1517:         errors << [:possible_values, :blank] if custom_field.possible_values.blank?
Chris@1517:         errors << [:possible_values, :invalid] unless custom_field.possible_values.is_a? Array
Chris@1517:         errors
Chris@1517:       end
Chris@1517: 
Chris@1517:       def validate_custom_value(custom_value)
Chris@1517:         values = Array.wrap(custom_value.value).reject {|value| value.to_s == ''}
Chris@1517:         invalid_values = values - Array.wrap(custom_value.value_was) - custom_value.custom_field.possible_values
Chris@1517:         if invalid_values.any?
Chris@1517:           [::I18n.t('activerecord.errors.messages.inclusion')]
Chris@1517:         else
Chris@1517:           []
Chris@1517:         end
Chris@1517:       end
Chris@1517: 
Chris@1517:       def group_statement(custom_field)
Chris@1517:         order_statement(custom_field)
Chris@1517:       end
Chris@1517:     end
Chris@1517: 
Chris@1517:     class BoolFormat < List
Chris@1517:       add 'bool'
Chris@1517:       self.multiple_supported = false
Chris@1517:       self.form_partial = 'custom_fields/formats/bool'
Chris@1517: 
Chris@1517:       def label
Chris@1517:         "label_boolean"
Chris@1517:       end
Chris@1517: 
Chris@1517:       def cast_single_value(custom_field, value, customized=nil)
Chris@1517:         value == '1' ? true : false
Chris@1517:       end
Chris@1517: 
Chris@1517:       def possible_values_options(custom_field, object=nil)
Chris@1517:         [[::I18n.t(:general_text_Yes), '1'], [::I18n.t(:general_text_No), '0']]
Chris@1517:       end
Chris@1517: 
Chris@1517:       def group_statement(custom_field)
Chris@1517:         order_statement(custom_field)
Chris@1517:       end
Chris@1517: 
Chris@1517:       def edit_tag(view, tag_id, tag_name, custom_value, options={})
Chris@1517:         case custom_value.custom_field.edit_tag_style
Chris@1517:         when 'check_box'
Chris@1517:           single_check_box_edit_tag(view, tag_id, tag_name, custom_value, options)
Chris@1517:         when 'radio'
Chris@1517:           check_box_edit_tag(view, tag_id, tag_name, custom_value, options)
Chris@1517:         else
Chris@1517:           select_edit_tag(view, tag_id, tag_name, custom_value, options)
Chris@1517:         end
Chris@1517:       end
Chris@1517: 
Chris@1517:       # Renders the edit tag as a simple check box
Chris@1517:       def single_check_box_edit_tag(view, tag_id, tag_name, custom_value, options={})
Chris@1517:         s = ''.html_safe
Chris@1517:         s << view.hidden_field_tag(tag_name, '0', :id => nil)
Chris@1517:         s << view.check_box_tag(tag_name, '1', custom_value.value.to_s == '1', :id => tag_id)
Chris@1517:         view.content_tag('span', s, options)
Chris@1517:       end
Chris@1517:     end
Chris@1517: 
Chris@1517:     class RecordList < List
Chris@1517:       self.customized_class_names = %w(Issue TimeEntry Version Project)
Chris@1517: 
Chris@1517:       def cast_single_value(custom_field, value, customized=nil)
Chris@1517:         target_class.find_by_id(value.to_i) if value.present?
Chris@1517:       end
Chris@1517: 
Chris@1517:       def target_class
Chris@1517:         @target_class ||= self.class.name[/^(.*::)?(.+)Format$/, 2].constantize rescue nil
Chris@1517:       end
Chris@1517:  
Chris@1517:       def possible_custom_value_options(custom_value)
Chris@1517:         options = possible_values_options(custom_value.custom_field, custom_value.customized)
Chris@1517:         missing = [custom_value.value_was].flatten.reject(&:blank?) - options.map(&:last)
Chris@1517:         if missing.any?
Chris@1517:           options += target_class.where(:id => missing.map(&:to_i)).map {|o| [o.to_s, o.id.to_s]}
Chris@1517:           #TODO: use #sort_by! when ruby1.8 support is dropped
Chris@1517:           options = options.sort_by(&:first)
Chris@1517:         end
Chris@1517:         options
Chris@1517:       end
Chris@1517: 
Chris@1517:       def order_statement(custom_field)
Chris@1517:         if target_class.respond_to?(:fields_for_order_statement)
Chris@1517:           target_class.fields_for_order_statement(value_join_alias(custom_field))
Chris@1517:         end
Chris@1517:       end
Chris@1517: 
Chris@1517:       def group_statement(custom_field)
Chris@1517:         "COALESCE(#{join_alias custom_field}.value, '')"
Chris@1517:       end
Chris@1517: 
Chris@1517:       def join_for_order_statement(custom_field)
Chris@1517:         alias_name = join_alias(custom_field)
Chris@1517: 
Chris@1517:         "LEFT OUTER JOIN #{CustomValue.table_name} #{alias_name}" +
Chris@1517:           " ON #{alias_name}.customized_type = '#{custom_field.class.customized_class.base_class.name}'" +
Chris@1517:           " AND #{alias_name}.customized_id = #{custom_field.class.customized_class.table_name}.id" +
Chris@1517:           " AND #{alias_name}.custom_field_id = #{custom_field.id}" +
Chris@1517:           " AND (#{custom_field.visibility_by_project_condition})" +
Chris@1517:           " AND #{alias_name}.value <> ''" +
Chris@1517:           " AND #{alias_name}.id = (SELECT max(#{alias_name}_2.id) FROM #{CustomValue.table_name} #{alias_name}_2" +
Chris@1517:             " WHERE #{alias_name}_2.customized_type = #{alias_name}.customized_type" +
Chris@1517:             " AND #{alias_name}_2.customized_id = #{alias_name}.customized_id" +
Chris@1517:             " AND #{alias_name}_2.custom_field_id = #{alias_name}.custom_field_id)" +
Chris@1517:           " LEFT OUTER JOIN #{target_class.table_name} #{value_join_alias custom_field}" +
Chris@1517:           " ON CAST(CASE #{alias_name}.value WHEN '' THEN '0' ELSE #{alias_name}.value END AS decimal(30,0)) = #{value_join_alias custom_field}.id"
Chris@1517:       end
Chris@1517: 
Chris@1517:       def value_join_alias(custom_field)
Chris@1517:         join_alias(custom_field) + "_" + custom_field.field_format
Chris@1517:       end
Chris@1517:       protected :value_join_alias
Chris@1517:     end
Chris@1517: 
Chris@1517:     class UserFormat < RecordList
Chris@1517:       add 'user'
Chris@1517:       self.form_partial = 'custom_fields/formats/user'
Chris@1517:       field_attributes :user_role
Chris@1517: 
Chris@1517:       def possible_values_options(custom_field, object=nil)
Chris@1517:         if object.is_a?(Array)
Chris@1517:           projects = object.map {|o| o.respond_to?(:project) ? o.project : nil}.compact.uniq
Chris@1517:           projects.map {|project| possible_values_options(custom_field, project)}.reduce(:&) || []
Chris@1517:         elsif object.respond_to?(:project) && object.project
Chris@1517:           scope = object.project.users
Chris@1517:           if custom_field.user_role.is_a?(Array)
Chris@1517:             role_ids = custom_field.user_role.map(&:to_s).reject(&:blank?).map(&:to_i)
Chris@1517:             if role_ids.any?
Chris@1517:               scope = scope.where("#{Member.table_name}.id IN (SELECT DISTINCT member_id FROM #{MemberRole.table_name} WHERE role_id IN (?))", role_ids)
Chris@1517:             end
Chris@1517:           end
Chris@1517:           scope.sorted.collect {|u| [u.to_s, u.id.to_s]}
Chris@1517:         else
Chris@1517:           []
Chris@1517:         end
Chris@1517:       end
Chris@1517: 
Chris@1517:       def before_custom_field_save(custom_field)
Chris@1517:         super
Chris@1517:         if custom_field.user_role.is_a?(Array)
Chris@1517:           custom_field.user_role.map!(&:to_s).reject!(&:blank?)
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517: 
Chris@1517:     class VersionFormat < RecordList
Chris@1517:       add 'version'
Chris@1517:       self.form_partial = 'custom_fields/formats/version'
Chris@1517:       field_attributes :version_status
Chris@1517: 
Chris@1517:       def possible_values_options(custom_field, object=nil)
Chris@1517:         if object.is_a?(Array)
Chris@1517:           projects = object.map {|o| o.respond_to?(:project) ? o.project : nil}.compact.uniq
Chris@1517:           projects.map {|project| possible_values_options(custom_field, project)}.reduce(:&) || []
Chris@1517:         elsif object.respond_to?(:project) && object.project
Chris@1517:           scope = object.project.shared_versions
Chris@1517:           if custom_field.version_status.is_a?(Array)
Chris@1517:             statuses = custom_field.version_status.map(&:to_s).reject(&:blank?)
Chris@1517:             if statuses.any?
Chris@1517:               scope = scope.where(:status => statuses.map(&:to_s))
Chris@1517:             end
Chris@1517:           end
Chris@1517:           scope.sort.collect {|u| [u.to_s, u.id.to_s]}
Chris@1517:         else
Chris@1517:           []
Chris@1517:         end
Chris@1517:       end
Chris@1517: 
Chris@1517:       def before_custom_field_save(custom_field)
Chris@1517:         super
Chris@1517:         if custom_field.version_status.is_a?(Array)
Chris@1517:           custom_field.version_status.map!(&:to_s).reject!(&:blank?)
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: end