summaryrefslogtreecommitdiffstats
path: root/lib/redmine/field_format.rb
blob: 70a60a577315f15e90cfeec597810bb5008b229c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# frozen_string_literal: true

# Redmine - project management software
# Copyright (C) 2006-2020  Jean-Philippe Lang
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

require 'uri'

module Redmine
  module FieldFormat
    def self.add(name, klass)
      all[name.to_s] = klass.instance
    end

    def self.delete(name)
      all.delete(name.to_s)
    end

    def self.all
      @formats ||= Hash.new(Base.instance)
    end

    def self.available_formats
      all.keys
    end

    def self.find(name)
      all[name.to_s]
    end

    # Return an array of custom field formats which can be used in select_tag
    def self.as_select(class_name=nil)
      formats = all.values.select do |format|
        format.class.customized_class_names.nil? ||
          format.class.customized_class_names.include?(class_name)
      end
      formats.map do |format|
        [::I18n.t(format.label), format.name]
      end.sort_by(&:first)
    end

    # Returns an array of formats that can be used for a custom field class
    def self.formats_for_custom_field_class(klass=nil)
      all.values.select do |format|
        format.class.customized_class_names.nil? ||
          format.class.customized_class_names.include?(klass.name)
      end
    end

    class Base
      include Singleton
      include Redmine::I18n
      include Redmine::Helpers::URL
      include ERB::Util

      class_attribute :format_name
      self.format_name = nil

      # Set this to true if the format supports multiple values
      class_attribute :multiple_supported
      self.multiple_supported = false

      # Set this to true if the format supports filtering on custom values
      class_attribute :is_filter_supported
      self.is_filter_supported = true

      # Set this to true if the format supports textual search on custom values
      class_attribute :searchable_supported
      self.searchable_supported = false

      # Set this to true if field values can be summed up
      class_attribute :totalable_supported
      self.totalable_supported = false

      # Set this to false if field cannot be bulk edited
      class_attribute :bulk_edit_supported
      self.bulk_edit_supported = true

      # Restricts the classes that the custom field can be added to
      # Set to nil for no restrictions
      class_attribute :customized_class_names
      self.customized_class_names = nil

      # Name of the partial for editing the custom field
      class_attribute :form_partial
      self.form_partial = nil

      class_attribute :change_as_diff
      self.change_as_diff = false

      class_attribute :change_no_details
      self.change_no_details = false

      def self.add(name)
        self.format_name = name
        Redmine::FieldFormat.add(name, self)
      end
      private_class_method :add

      def self.field_attributes(*args)
        CustomField.store_accessor :format_store, *args
      end

      field_attributes :url_pattern, :full_width_layout

      def name
        self.class.format_name
      end

      def label
        "label_#{name}"
      end

      def set_custom_field_value(custom_field, custom_field_value, value)
        if value.is_a?(Array)
          value = value.map(&:to_s).reject{|v| v==''}.uniq
          if value.empty?
            value << ''
          end
        else
          value = value.to_s
        end

        value
      end

      def cast_custom_value(custom_value)
        cast_value(custom_value.custom_field, custom_value.value, custom_value.customized)
      end

      def cast_value(custom_field, value, customized=nil)
        if value.blank?
          nil
        elsif value.is_a?(Array)
          casted = value.map do |v|
            cast_single_value(custom_field, v, customized)
          end
          casted.compact.sort
        else
          cast_single_value(custom_field, value, customized)
        end
      end

      def cast_single_value(custom_field, value, customized=nil)
        value.to_s
      end

      def target_class
        nil
      end

      def possible_custom_value_options(custom_value)
        possible_values_options(custom_value.custom_field, custom_value.customized)
      end

      def possible_values_options(custom_field, object=nil)
        []
      end

      def value_from_keyword(custom_field, keyword, object)
        possible_values_options = possible_values_options(custom_field, object)
        if possible_values_options.present?
          parse_keyword(custom_field, keyword) do |k|
            if v = possible_values_options.detect {|text, id| k.casecmp(text) == 0}
              if v.is_a?(Array)
                v.last
              else
                v
              end
            end
          end
        else
          keyword
        end
      end

      def parse_keyword(custom_field, keyword, &block)
        separator = Regexp.escape ","
        keyword = keyword.dup.to_s

        if custom_field.multiple?
          values = []
          while keyword.length > 0
            k = keyword.dup
            loop do
              if value = yield(k.strip)
                values << value
                break
              elsif k.slice!(/#{separator}([^#{separator}]*)\Z/).nil?
                break
              end
            end
            keyword.slice!(/\A#{Regexp.escape k}#{separator}?/)
          end
          values
        else
          yield keyword.strip
        end
      end
      protected :parse_keyword

      # Returns the validation errors for custom_field
      # Should return an empty array if custom_field is valid
      def validate_custom_field(custom_field)
        errors = []
        pattern = custom_field.url_pattern
        if pattern.present? && !uri_with_safe_scheme?(url_pattern_without_tokens(pattern))
          errors << [:url_pattern, :invalid]
        end
        errors
      end

      # Returns the validation error messages for custom_value
      # Should return an empty array if custom_value is valid
      # custom_value is a CustomFieldValue.
      def validate_custom_value(custom_value)
        values = Array.wrap(custom_value.value).reject {|value| value.to_s == ''}
        errors = values.map do |value|
          validate_single_value(custom_value.custom_field, value, custom_value.customized)
        end
        errors.flatten.uniq
      end

      def validate_single_value(custom_field, value, customized=nil)
        []
      end

      # CustomValue after_save callback
      def after_save_custom_value(custom_field, custom_value)
      end

      def formatted_custom_value(view, custom_value, html=false)
        formatted_value(view, custom_value.custom_field, custom_value.value, custom_value.customized, html)
      end

      def formatted_value(view, custom_field, value, customized=nil, html=false)
        casted = cast_value(custom_field, value, customized)
        if html && custom_field.url_pattern.present?
          texts_and_urls = Array.wrap(casted).map do |single_value|
            text = view.format_object(single_value, false).to_s
            url = url_from_pattern(custom_field, single_value, customized)
            [text, url]
          end
          links = texts_and_urls.sort_by(&:first).map do |text, url|
            css_class = (/^https?:\/\//.match?(url)) ? 'external' : nil
            view.link_to_if uri_with_safe_scheme?(url), text, url, :class => css_class
          end
          links.join(', ').html_safe
        else
          casted
        end
      end

      # Returns an URL generated with the custom field URL pattern
      # and variables substitution:
      # %value% => the custom field value
      # %id% => id of the customized object
      # %project_id% => id of the project of the customized object if defined
      # %project_identifier% => identifier of the project of the customized object if defined
      # %m1%, %m2%... => capture groups matches of the custom field regexp if defined
      def url_from_pattern(custom_field, value, customized)
        url = custom_field.url_pattern.to_s.dup
        url.gsub!('%value%') {Addressable::URI.encode value.to_s}
        url.gsub!('%id%') {Addressable::URI.encode customized.id.to_s}
        url.gsub!('%project_id%') do
          Addressable::URI.encode(
            (customized.respond_to?(:project) ? customized.project.try(:id) : nil).to_s
          )
        end
        url.gsub!('%project_identifier%') do
          Addressable::URI.encode(
            (customized.respond_to?(:project) ? customized.project.try(:identifier) : nil).to_s
          )
        end
        if custom_field.regexp.present?
          url.gsub!(%r{%m(\d+)%}) do
            m = $1.to_i
            if matches ||= value.to_s.match(Regexp.new(custom_field.regexp))
              Addressable::URI.encode matches[m].to_s
            end
          end
        end
        url
      end
      protected :url_from_pattern

      # Returns the URL pattern with substitution tokens removed,
      # for validation purpose
      def url_pattern_without_tokens(url_pattern)
        url_pattern.to_s.gsub(/%(value|id|project_id|project_identifier|m\d+)%/, '')
      end
      protected :url_pattern_without_tokens

      def edit_tag(view, tag_id, tag_name, custom_value, options={})
        view.text_field_tag(tag_name, custom_value.value, options.merge(:id => tag_id))
      end

      def bulk_edit_tag(view, tag_id, tag_name, custom_field, objects, value, options={})
        view.text_field_tag(tag_name, value, options.merge(:id => tag_id)) +
          bulk_clear_tag(view, tag_id, tag_name, custom_field, value)
      end

      def bulk_clear_tag(view, tag_id, tag_name, custom_field, value)
        if custom_field.is_required?
          ''.html_safe
        else
          view.content_tag(
            'label',
            view.check_box_tag(
              tag_name,
              '__none__', (value == '__none__'), :id => nil,
              :data => {:disables => "##{tag_id}"}) + l(:button_clear),
            :class => 'inline'
          )
        end
      end
      protected :bulk_clear_tag

      def query_filter_options(custom_field, query)
        {:type => :string}
      end

      def before_custom_field_save(custom_field)
      end

      # Returns a ORDER BY clause that can used to sort customized
      # objects by their value of the custom field.
      # Returns nil if the custom field can not be used for sorting.
      def order_statement(custom_field)
        # COALESCE is here to make sure that blank and NULL values are sorted equally
        Arel.sql "COALESCE(#{join_alias custom_field}.value, '')"
      end

      # Returns a GROUP BY clause that can used to group by custom value
      # Returns nil if the custom field can not be used for grouping.
      def group_statement(custom_field)
        nil
      end

      # Returns a JOIN clause that is added to the query when sorting by custom values
      def join_for_order_statement(custom_field)
        alias_name = join_alias(custom_field)

        "LEFT OUTER JOIN #{CustomValue.table_name} #{alias_name}" +
          " ON #{alias_name}.customized_type = '#{custom_field.class.customized_class.base_class.name}'" +
          " AND #{alias_name}.customized_id = #{custom_field.class.customized_class.table_name}.id" +
          " AND #{alias_name}.custom_field_id = #{custom_field.id}" +
          " AND (#{custom_field.visibility_by_project_condition})" +
          " AND #{alias_name}.value <> ''" +
          " AND #{alias_name}.id = (SELECT max(#{alias_name}_2.id) FROM #{CustomValue.table_name} #{alias_name}_2" +
            " WHERE #{alias_name}_2.customized_type = #{alias_name}.customized_type" +
            " AND #{alias_name}_2.customized_id = #{alias_name}.customized_id" +
            " AND #{alias_name}_2.custom_field_id = #{alias_name}.custom_field_id)"
      end

      def join_alias(custom_field)
        "cf_#{custom_field.id}"
      end
      protected :join_alias
    end

    class Unbounded < Base
      def validate_single_value(custom_field, value, customized=nil)
        errs = super
        value = value.to_s
        unless custom_field.regexp.blank? or Regexp.new(custom_field.regexp).match?(value)
          errs << ::I18n.t('activerecord.errors.messages.invalid')
        end
        if custom_field.min_length && value.length < custom_field.min_length
          errs << ::I18n.t('activerecord.errors.messages.too_short', :count => custom_field.min_length)
        end
        if custom_field.max_length && custom_field.max_length > 0 && value.length > custom_field.max_length
          errs << ::I18n.t('activerecord.errors.messages.too_long', :count => custom_field.max_length)
        end
        errs
      end
    end

    class StringFormat < Unbounded
      add 'string'
      self.searchable_supported = true
      self.form_partial = 'custom_fields/formats/string'
      field_attributes :text_formatting

      def formatted_value(view, custom_field, value, customized=nil, html=false)
        if html
          if custom_field.url_pattern.present?
            super
          elsif custom_field.text_formatting == 'full'
            view.textilizable(value, :object => customized)
          else
            value.to_s
          end
        else
          value.to_s
        end
      end
    end

    class TextFormat < Unbounded
      add 'text'
      self.searchable_supported = true
      self.form_partial = 'custom_fields/formats/text'
      self.change_as_diff = true

      def formatted_value(view, custom_field, value, customized=nil, html=false)
        if html
          if value.present?
            if custom_field.text_formatting == 'full'
              view.textilizable(value, :object => customized)
            else
              view.simple_format(html_escape(value))
            end
          else
            ''
          end
        else
          value.to_s
        end
      end

      def edit_tag(view, tag_id, tag_name, custom_value, options={})
        view.text_area_tag(tag_name, custom_value.value, options.merge(:id => tag_id, :rows => 8))
      end

      def bulk_edit_tag(view, tag_id, tag_name, custom_field, objects, value, options={})
        view.text_area_tag(tag_name, value, options.merge(:id => tag_id, :rows => 8)) +
          '<br />'.html_safe +
          bulk_clear_tag(view, tag_id, tag_name, custom_field, value)
      end

      def query_filter_options(custom_field, query)
        {:type => :text}
      end
    end

    class LinkFormat < StringFormat
      add 'link'
      self.searchable_supported = false
      self.form_partial = 'custom_fields/formats/link'

      def formatted_value(view, custom_field, value, customized=nil, html=false)
        if html && value.present?
          if custom_field.url_pattern.present?
            url = url_from_pattern(custom_field, value, customized)
          else
            url = value.to_s
            unless %r{\A[a-z]+://}i.match?(url)
              # no protocol found, use http by default
              url = "http://" + url
            end
          end
          css_class = (/^https?:\/\//.match?(url)) ? 'external' : nil
          view.link_to value.to_s.truncate(40), url, :class => css_class
        else
          value.to_s
        end
      end
    end

    class Numeric < Unbounded
      self.form_partial = 'custom_fields/formats/numeric'
      self.totalable_supported = true

      def order_statement(custom_field)
        # Make the database cast values into numeric
        # Postgresql will raise an error if a value can not be casted!
        # CustomValue validations should ensure that it doesn't occur
        Arel.sql(
          "CAST(CASE #{join_alias custom_field}.value" \
                 " WHEN '' THEN '0' ELSE #{join_alias custom_field}.value" \
                 " END AS decimal(30,3))"
        )
      end

      # Returns totals for the given scope
      def total_for_scope(custom_field, scope)
        scope.joins(:custom_values).
          where(:custom_values => {:custom_field_id => custom_field.id}).
          where.not(:custom_values => {:value => ''}).
          sum("CAST(#{CustomValue.table_name}.value AS decimal(30,3))")
      end

      def cast_total_value(custom_field, value)
        cast_single_value(custom_field, value)
      end
    end

    class IntFormat < Numeric
      add 'int'

      def label
        "label_integer"
      end

      def cast_single_value(custom_field, value, customized=nil)
        value.to_i
      end

      def validate_single_value(custom_field, value, customized=nil)
        errs = super
        errs << ::I18n.t('activerecord.errors.messages.not_a_number') unless /^[+-]?\d+$/.match?(value.to_s.strip)
        errs
      end

      def query_filter_options(custom_field, query)
        {:type => :integer}
      end

      def group_statement(custom_field)
        order_statement(custom_field)
      end
    end

    class FloatFormat < Numeric
      add 'float'

      def cast_single_value(custom_field, value, customized=nil)
        value.to_f
      end

      def cast_total_value(custom_field, value)
        value.to_f.round(2)
      end

      def validate_single_value(custom_field, value, customized=nil)
        errs = super
        errs << ::I18n.t('activerecord.errors.messages.invalid') unless (Kernel.Float(value) rescue nil)
        errs
      end

      def query_filter_options(custom_field, query)
        {:type => :float}
      end
    end

    class DateFormat < Unbounded
      add 'date'
      self.form_partial = 'custom_fields/formats/date'

      def cast_single_value(custom_field, value, customized=nil)
        value.to_date rescue nil
      end

      def validate_single_value(custom_field, value, customized=nil)
        if /^\d{4}-\d{2}-\d{2}$/.match?(value) && (value.to_date rescue false)
          []
        else
          [::I18n.t('activerecord.errors.messages.not_a_date')]
        end
      end

      def edit_tag(view, tag_id, tag_name, custom_value, options={})
        view.date_field_tag(tag_name, custom_value.value, options.merge(:id => tag_id, :size => 10)) +
          view.calendar_for(tag_id)
      end

      def bulk_edit_tag(view, tag_id, tag_name, custom_field, objects, value, options={})
        view.date_field_tag(tag_name, value, options.merge(:id => tag_id, :size => 10)) +
          view.calendar_for(tag_id) +
          bulk_clear_tag(view, tag_id, tag_name, custom_field, value)
      end

      def query_filter_options(custom_field, query)
        {:type => :date}
      end

      def group_statement(custom_field)
        order_statement(custom_field)
      end
    end

    class List < Base
      self.multiple_supported = true
      field_attributes :edit_tag_style

      def edit_tag(view, tag_id, tag_name, custom_value, options={})
        if custom_value.custom_field.edit_tag_style == 'check_box'
          check_box_edit_tag(view, tag_id, tag_name, custom_value, options)
        else
          select_edit_tag(view, tag_id, tag_name, custom_value, options)
        end
      end

      def bulk_edit_tag(view, tag_id, tag_name, custom_field, objects, value, options={})
        opts = []
        opts << [l(:label_no_change_option), ''] unless custom_field.multiple?
        opts << [l(:label_none), '__none__'] unless custom_field.is_required?
        opts += possible_values_options(custom_field, objects)
        view.select_tag(
          tag_name,
          view.options_for_select(opts, value),
          options.merge(:multiple => custom_field.multiple?)
        )
      end

      def query_filter_options(custom_field, query)
        {
          :type => :list_optional,
          :values => lambda {query_filter_values(custom_field, query)}
        }
      end

      protected

      # Returns the values that are available in the field filter
      def query_filter_values(custom_field, query)
        possible_values_options(custom_field, query.project)
      end

      # Renders the edit tag as a select tag
      def select_edit_tag(view, tag_id, tag_name, custom_value, options={})
        blank_option = ''.html_safe
        unless custom_value.custom_field.multiple?
          if custom_value.custom_field.is_required?
            unless custom_value.custom_field.default_value.present?
              blank_option =
                view.content_tag(
                  'option',
                  "--- #{l(:actionview_instancetag_blank_option)} ---",
                  :value => ''
                )
            end
          else
            blank_option = view.content_tag('option', '&nbsp;'.html_safe, :value => '')
          end
        end
        options_tags =
          blank_option +
           view.options_for_select(possible_custom_value_options(custom_value), custom_value.value)
        s =
          view.select_tag(
            tag_name, options_tags,
            options.merge(:id => tag_id, :multiple => custom_value.custom_field.multiple?)
          )
        if custom_value.custom_field.multiple?
          s << view.hidden_field_tag(tag_name, '')
        end
        s
      end

      # Renders the edit tag as check box or radio tags
      def check_box_edit_tag(view, tag_id, tag_name, custom_value, options={})
        opts = []
        unless custom_value.custom_field.multiple? || custom_value.custom_field.is_required?
          opts << ["(#{l(:label_none)})", '']
        end
        opts += possible_custom_value_options(custom_value)
        s = ''.html_safe
        tag_method = custom_value.custom_field.multiple? ? :check_box_tag : :radio_button_tag
        opts.each do |label, value|
          value ||= label
          checked = (custom_value.value.is_a?(Array) && custom_value.value.include?(value)) ||
                      custom_value.value.to_s == value
          tag = view.send(tag_method, tag_name, value, checked, :id => nil)
          s << view.content_tag('label', tag + ' ' + label)
        end
        if custom_value.custom_field.multiple?
          s << view.hidden_field_tag(tag_name, '', :id => nil)
        end
        css = "#{options[:class]} check_box_group"
        view.content_tag('span', s, options.merge(:class => css))
      end
    end

    class ListFormat < List
      add 'list'
      self.searchable_supported = true
      self.form_partial = 'custom_fields/formats/list'

      def possible_custom_value_options(custom_value)
        options = possible_values_options(custom_value.custom_field)
        missing = [custom_value.value].flatten.reject(&:blank?) - options
        if missing.any?
          options += missing
        end
        options
      end

      def possible_values_options(custom_field, object=nil)
        custom_field.possible_values
      end

      def validate_custom_field(custom_field)
        errors = []
        errors << [:possible_values, :blank] if custom_field.possible_values.blank?
        errors << [:possible_values, :invalid] unless custom_field.possible_values.is_a? Array
        errors
      end

      def validate_custom_value(custom_value)
        values = Array.wrap(custom_value.value).reject {|value| value.to_s == ''}
        invalid_values = values - Array.wrap(custom_value.value_was) - custom_value.custom_field.possible_values
        if invalid_values.any?
          [::I18n.t('activerecord.errors.messages.inclusion')]
        else
          []
        end
      end

      def group_statement(custom_field)
        order_statement(custom_field)
      end
    end

    class BoolFormat < List
      add 'bool'
      self.multiple_supported = false
      self.form_partial = 'custom_fields/formats/bool'

      def label
        "label_boolean"
      end

      def cast_single_value(custom_field, value, customized=nil)
        value == '1' ? true : false
      end

      def possible_values_options(custom_field, object=nil)
        [[::I18n.t(:general_text_Yes), '1'], [::I18n.t(:general_text_No), '0']]
      end

      def group_statement(custom_field)
        order_statement(custom_field)
      end

      def edit_tag(view, tag_id, tag_name, custom_value, options={})
        case custom_value.custom_field.edit_tag_style
        when 'check_box'
          single_check_box_edit_tag(view, tag_id, tag_name, custom_value, options)
        when 'radio'
          check_box_edit_tag(view, tag_id, tag_name, custom_value, options)
        else
          select_edit_tag(view, tag_id, tag_name, custom_value, options)
        end
      end

      # Renders the edit tag as a simple check box
      def single_check_box_edit_tag(view, tag_id, tag_name, custom_value, options={})
        s = ''.html_safe
        s << view.hidden_field_tag(tag_name, '0', :id => nil)
        s << view.check_box_tag(tag_name, '1', custom_value.value.to_s == '1', :id => tag_id)
        view.content_tag('span', s, options)
      end
    end

    class RecordList < List
      self.customized_class_names = %w(Issue TimeEntry Version Document Project)

      def cast_single_value(custom_field, value, customized=nil)
        target_class.find_by_id(value.to_i) if value.present?
      end

      def target_class
        @target_class ||= self.class.name[/^(.*::)?(.+)Format$/, 2].constantize rescue nil
      end

      def reset_target_class
        @target_class = nil
      end

      def possible_custom_value_options(custom_value)
        options = possible_values_options(custom_value.custom_field, custom_value.customized)
        missing = [custom_value.value_was].flatten.reject(&:blank?) - options.map(&:last)
        if missing.any?
          options += target_class.where(:id => missing.map(&:to_i)).map {|o| [o.to_s, o.id.to_s]}
        end
        options
      end

      def validate_custom_value(custom_value)
        values = Array.wrap(custom_value.value).reject {|value| value.to_s == ''}
        invalid_values = values - possible_custom_value_options(custom_value).map(&:last)
        if invalid_values.any?
          [::I18n.t('activerecord.errors.messages.inclusion')]
        else
          []
        end
      end

      def order_statement(custom_field)
        if target_class.respond_to?(:fields_for_order_statement)
          target_class.fields_for_order_statement(value_join_alias(custom_field))
        end
      end

      def group_statement(custom_field)
        Arel.sql "COALESCE(#{join_alias custom_field}.value, '')"
      end

      def join_for_order_statement(custom_field)
        alias_name = join_alias(custom_field)

        "LEFT OUTER JOIN #{CustomValue.table_name} #{alias_name}" \
          " ON #{alias_name}.customized_type = '#{custom_field.class.customized_class.base_class.name}'" \
          " AND #{alias_name}.customized_id = #{custom_field.class.customized_class.table_name}.id" \
          " AND #{alias_name}.custom_field_id = #{custom_field.id}" \
          " AND (#{custom_field.visibility_by_project_condition})" \
          " AND #{alias_name}.value <> ''" \
          " AND #{alias_name}.id = (SELECT max(#{alias_name}_2.id) FROM #{CustomValue.table_name} #{alias_name}_2" \
            " WHERE #{alias_name}_2.customized_type = #{alias_name}.customized_type" \
            " AND #{alias_name}_2.customized_id = #{alias_name}.customized_id" \
            " AND #{alias_name}_2.custom_field_id = #{alias_name}.custom_field_id)" \
          " LEFT OUTER JOIN #{target_class.table_name} #{value_join_alias custom_field}" \
          " ON CAST(CASE #{alias_name}.value WHEN '' THEN '0' ELSE #{alias_name}.value END AS decimal(30,0))" \
            " = #{value_join_alias custom_field}.id"
      end

      def value_join_alias(custom_field)
        join_alias(custom_field) + "_" + custom_field.field_format
      end
      protected :value_join_alias
    end

    class EnumerationFormat < RecordList
      add 'enumeration'
      self.form_partial = 'custom_fields/formats/enumeration'

      def label
        "label_field_format_enumeration"
      end

      def target_class
        @target_class ||= CustomFieldEnumeration
      end

      def possible_values_options(custom_field, object=nil)
        possible_values_records(custom_field, object).map {|u| [u.name, u.id.to_s]}
      end

      def possible_values_records(custom_field, object=nil)
        custom_field.enumerations.active
      end

      def value_from_keyword(custom_field, keyword, object)
        parse_keyword(custom_field, keyword) do |k|
          custom_field.enumerations.where("LOWER(name) LIKE LOWER(?)", k).first.try(:id)
        end
      end
    end

    class UserFormat < RecordList
      add 'user'
      self.form_partial = 'custom_fields/formats/user'
      field_attributes :user_role

      def possible_values_options(custom_field, object=nil)
        users = possible_values_records(custom_field, object)
        options = users.map {|u| [u.name, u.id.to_s]}
        options = [["<< #{l(:label_me)} >>", User.current.id]] + options if users.include?(User.current)
        options
      end

      def possible_values_records(custom_field, object=nil)
        if object.is_a?(Array)
          projects = object.map {|o| o.respond_to?(:project) ? o.project : nil}.compact.uniq
          projects.map {|project| possible_values_records(custom_field, project)}.reduce(:&) || []
        elsif object.respond_to?(:project) && object.project
          scope = object.project.users
          if custom_field.user_role.is_a?(Array)
            role_ids = custom_field.user_role.map(&:to_s).reject(&:blank?).map(&:to_i)
            if role_ids.any?
              scope =
                scope.where("#{Member.table_name}.id IN (SELECT DISTINCT member_id FROM" \
                            " #{MemberRole.table_name} WHERE role_id IN (?))", role_ids)
            end
          end
          scope.sorted
        else
          []
        end
      end

      def value_from_keyword(custom_field, keyword, object)
        users = possible_values_records(custom_field, object).to_a
        parse_keyword(custom_field, keyword) do |k|
          Principal.detect_by_keyword(users, k).try(:id)
        end
      end

      def before_custom_field_save(custom_field)
        super
        if custom_field.user_role.is_a?(Array)
          custom_field.user_role.map!(&:to_s).reject!(&:blank?)
        end
      end

      def query_filter_values(custom_field, query)
        query.author_values
      end
    end

    class VersionFormat < RecordList
      add 'version'
      self.form_partial = 'custom_fields/formats/version'
      field_attributes :version_status

      def possible_values_options(custom_field, object=nil)
        possible_values_records(custom_field, object).sort.collect do |v|
          [v.to_s, v.id.to_s]
        end
      end

      def before_custom_field_save(custom_field)
        super
        if custom_field.version_status.is_a?(Array)
          custom_field.version_status.map!(&:to_s).reject!(&:blank?)
        end
      end

      protected

      def query_filter_values(custom_field, query)
        versions = possible_values_records(custom_field, query.project, true)
        Version.sort_by_status(versions).collect do |s|
          ["#{s.project.name} - #{s.name}", s.id.to_s, l("version_status_#{s.status}")]
        end
      end

      def possible_values_records(custom_field, object=nil, all_statuses=false)
        if object.is_a?(Array)
          projects = object.map {|o| o.respond_to?(:project) ? o.project : nil}.compact.uniq
          projects.map {|project| possible_values_records(custom_field, project)}.reduce(:&) || []
        elsif object.respond_to?(:project) && object.project
          scope = object.project.shared_versions
          filtered_versions_options(custom_field, scope, all_statuses)
        elsif object.nil?
          scope = ::Version.visible.where(:sharing => 'system')
          filtered_versions_options(custom_field, scope, all_statuses)
        else
          []
        end
      end

      def filtered_versions_options(custom_field, scope, all_statuses=false)
        if !all_statuses && custom_field.version_status.is_a?(Array)
          statuses = custom_field.version_status.map(&:to_s).reject(&:blank?)
          if statuses.any?
            scope = scope.where(:status => statuses.map(&:to_s))
          end
        end
        scope
      end
    end

    class AttachmentFormat < Base
      add 'attachment'
      self.form_partial = 'custom_fields/formats/attachment'
      self.is_filter_supported = false
      self.change_no_details = true
      self.bulk_edit_supported = false
      field_attributes :extensions_allowed

      def set_custom_field_value(custom_field, custom_field_value, value)
        attachment_present = false

        if value.is_a?(Hash)
          attachment_present = true
          value = value.except(:blank)

          if value.values.any? && value.values.all? {|v| v.is_a?(Hash)}
            value = value.values.first
          end

          if value.key?(:id)
            value = set_custom_field_value_by_id(custom_field, custom_field_value, value[:id])
          elsif value[:token].present?
            if attachment = Attachment.find_by_token(value[:token])
              value = attachment.id.to_s
            else
              value = ''
            end
          elsif value.key?(:file)
            attachment = Attachment.new(:file => value[:file], :author => User.current)
            if attachment.save
              value = attachment.id.to_s
            else
              value = ''
            end
          else
            attachment_present = false
            value = ''
          end
        elsif value.is_a?(String)
          value = set_custom_field_value_by_id(custom_field, custom_field_value, value)
        end
        custom_field_value.instance_variable_set "@attachment_present", attachment_present

        value
      end

      def set_custom_field_value_by_id(custom_field, custom_field_value, id)
        attachment = Attachment.find_by_id(id)
        if attachment && attachment.container.is_a?(CustomValue) &&
             attachment.container.customized == custom_field_value.customized
          id.to_s
        else
          ''
        end
      end
      private :set_custom_field_value_by_id

      def cast_single_value(custom_field, value, customized=nil)
        Attachment.find_by_id(value.to_i) if value.present? && value.respond_to?(:to_i)
      end

      def validate_custom_value(custom_value)
        errors = []

        if custom_value.value.blank?
          if custom_value.instance_variable_get("@attachment_present")
            errors << ::I18n.t('activerecord.errors.messages.invalid')
          end
        else
          if custom_value.value.present?
            attachment = Attachment.find_by(:id => custom_value.value.to_s)
            extensions = custom_value.custom_field.extensions_allowed
            if attachment && extensions.present? && !attachment.extension_in?(extensions)
              errors <<
                "#{::I18n.t('activerecord.errors.messages.invalid')}" \
                  " (#{l(:setting_attachment_extensions_allowed)}: #{extensions})"
            end
          end
        end

        errors.uniq
      end

      def after_save_custom_value(custom_field, custom_value)
        if custom_value.saved_change_to_value?
          if custom_value.value.present?
            attachment = Attachment.find_by(:id => custom_value.value.to_s)
            if attachment
              attachment.container = custom_value
              attachment.save!
            end
          end
          if custom_value.value_before_last_save.present?
            attachment = Attachment.find_by(:id => custom_value.value_before_last_save.to_s)
            if attachment
              attachment.destroy
            end
          end
        end
      end

      def edit_tag(view, tag_id, tag_name, custom_value, options={})
        attachment = nil
        if custom_value.value.present?
          attachment = Attachment.find_by_id(custom_value.value)
        end

        view.hidden_field_tag("#{tag_name}[blank]", "") +
          view.render(:partial => 'attachments/form',
            :locals => {
              :attachment_param => tag_name,
              :multiple => false,
              :description => false,
              :saved_attachments => [attachment].compact,
              :filedrop => true,
              :attachment_format_custom_field => true
            })
      end
    end
  end
end