To check out this repository please hg clone the following URL, or open the URL using EasyMercurial or your preferred Mercurial client.

Statistics Download as Zip
| Branch: | Tag: | Revision:

root / app / models / query.rb @ 1533:59e13100ea95

History | View | Annotate | Download (28.4 KB)

1 0:513646585e45 Chris
# Redmine - project management software
2 1494:e248c7af89ec Chris
# Copyright (C) 2006-2014  Jean-Philippe Lang
3 0:513646585e45 Chris
#
4
# This program is free software; you can redistribute it and/or
5
# modify it under the terms of the GNU General Public License
6
# as published by the Free Software Foundation; either version 2
7
# of the License, or (at your option) any later version.
8 441:cbce1fd3b1b7 Chris
#
9 0:513646585e45 Chris
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
# GNU General Public License for more details.
13 441:cbce1fd3b1b7 Chris
#
14 0:513646585e45 Chris
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17
18 441:cbce1fd3b1b7 Chris
class QueryColumn
19 0:513646585e45 Chris
  attr_accessor :name, :sortable, :groupable, :default_order
20
  include Redmine::I18n
21 441:cbce1fd3b1b7 Chris
22 0:513646585e45 Chris
  def initialize(name, options={})
23
    self.name = name
24
    self.sortable = options[:sortable]
25
    self.groupable = options[:groupable] || false
26
    if groupable == true
27
      self.groupable = name.to_s
28
    end
29
    self.default_order = options[:default_order]
30 1115:433d4f72a19b Chris
    @inline = options.key?(:inline) ? options[:inline] : true
31 1464:261b3d9a4903 Chris
    @caption_key = options[:caption] || "field_#{name}".to_sym
32
    @frozen = options[:frozen]
33 0:513646585e45 Chris
  end
34 441:cbce1fd3b1b7 Chris
35 0:513646585e45 Chris
  def caption
36 1464:261b3d9a4903 Chris
    @caption_key.is_a?(Symbol) ? l(@caption_key) : @caption_key
37 0:513646585e45 Chris
  end
38 441:cbce1fd3b1b7 Chris
39 0:513646585e45 Chris
  # Returns true if the column is sortable, otherwise false
40
  def sortable?
41 909:cbb26bc654de Chris
    !@sortable.nil?
42
  end
43 1115:433d4f72a19b Chris
44 909:cbb26bc654de Chris
  def sortable
45
    @sortable.is_a?(Proc) ? @sortable.call : @sortable
46 0:513646585e45 Chris
  end
47 441:cbce1fd3b1b7 Chris
48 1115:433d4f72a19b Chris
  def inline?
49
    @inline
50
  end
51
52 1464:261b3d9a4903 Chris
  def frozen?
53
    @frozen
54
  end
55
56
  def value(object)
57
    object.send name
58 0:513646585e45 Chris
  end
59 441:cbce1fd3b1b7 Chris
60
  def css_classes
61
    name
62
  end
63 0:513646585e45 Chris
end
64
65
class QueryCustomFieldColumn < QueryColumn
66
67
  def initialize(custom_field)
68
    self.name = "cf_#{custom_field.id}".to_sym
69
    self.sortable = custom_field.order_statement || false
70 1115:433d4f72a19b Chris
    self.groupable = custom_field.group_statement || false
71
    @inline = true
72 0:513646585e45 Chris
    @cf = custom_field
73
  end
74 441:cbce1fd3b1b7 Chris
75 0:513646585e45 Chris
  def caption
76
    @cf.name
77
  end
78 441:cbce1fd3b1b7 Chris
79 0:513646585e45 Chris
  def custom_field
80
    @cf
81
  end
82 441:cbce1fd3b1b7 Chris
83 1464:261b3d9a4903 Chris
  def value(object)
84
    if custom_field.visible_by?(object.project, User.current)
85
      cv = object.custom_values.select {|v| v.custom_field_id == @cf.id}.collect {|v| @cf.cast_value(v.value)}
86
      cv.size > 1 ? cv.sort {|a,b| a.to_s <=> b.to_s} : cv.first
87
    else
88
      nil
89
    end
90 0:513646585e45 Chris
  end
91 441:cbce1fd3b1b7 Chris
92
  def css_classes
93
    @css_classes ||= "#{name} #{@cf.field_format}"
94
  end
95 0:513646585e45 Chris
end
96
97 1464:261b3d9a4903 Chris
class QueryAssociationCustomFieldColumn < QueryCustomFieldColumn
98
99
  def initialize(association, custom_field)
100
    super(custom_field)
101
    self.name = "#{association}.cf_#{custom_field.id}".to_sym
102
    # TODO: support sorting/grouping by association custom field
103
    self.sortable = false
104
    self.groupable = false
105
    @association = association
106
  end
107
108
  def value(object)
109
    if assoc = object.send(@association)
110
      super(assoc)
111
    end
112
  end
113
114
  def css_classes
115
    @css_classes ||= "#{@association}_cf_#{@cf.id} #{@cf.field_format}"
116
  end
117
end
118
119 0:513646585e45 Chris
class Query < ActiveRecord::Base
120
  class StatementInvalid < ::ActiveRecord::StatementInvalid
121
  end
122 441:cbce1fd3b1b7 Chris
123 1464:261b3d9a4903 Chris
  VISIBILITY_PRIVATE = 0
124
  VISIBILITY_ROLES   = 1
125
  VISIBILITY_PUBLIC  = 2
126
127 0:513646585e45 Chris
  belongs_to :project
128
  belongs_to :user
129 1464:261b3d9a4903 Chris
  has_and_belongs_to_many :roles, :join_table => "#{table_name_prefix}queries_roles#{table_name_suffix}", :foreign_key => "query_id"
130 0:513646585e45 Chris
  serialize :filters
131
  serialize :column_names
132
  serialize :sort_criteria, Array
133 1464:261b3d9a4903 Chris
  serialize :options, Hash
134 441:cbce1fd3b1b7 Chris
135 0:513646585e45 Chris
  attr_protected :project_id, :user_id
136 441:cbce1fd3b1b7 Chris
137 1115:433d4f72a19b Chris
  validates_presence_of :name
138 0:513646585e45 Chris
  validates_length_of :name, :maximum => 255
139 1464:261b3d9a4903 Chris
  validates :visibility, :inclusion => { :in => [VISIBILITY_PUBLIC, VISIBILITY_ROLES, VISIBILITY_PRIVATE] }
140 909:cbb26bc654de Chris
  validate :validate_query_filters
141 1464:261b3d9a4903 Chris
  validate do |query|
142
    errors.add(:base, l(:label_role_plural) + ' ' + l('activerecord.errors.messages.blank')) if query.visibility == VISIBILITY_ROLES && roles.blank?
143
  end
144 441:cbce1fd3b1b7 Chris
145 1464:261b3d9a4903 Chris
  after_save do |query|
146
    if query.visibility_changed? && query.visibility != VISIBILITY_ROLES
147
            query.roles.clear
148
          end
149
  end
150 0:513646585e45 Chris
151 1464:261b3d9a4903 Chris
  class_attribute :operators
152
  self.operators = {
153
    "="   => :label_equals,
154
    "!"   => :label_not_equals,
155
    "o"   => :label_open_issues,
156
    "c"   => :label_closed_issues,
157
    "!*"  => :label_none,
158
    "*"   => :label_any,
159
    ">="  => :label_greater_or_equal,
160
    "<="  => :label_less_or_equal,
161
    "><"  => :label_between,
162
    "<t+" => :label_in_less_than,
163
    ">t+" => :label_in_more_than,
164
    "><t+"=> :label_in_the_next_days,
165
    "t+"  => :label_in,
166
    "t"   => :label_today,
167
    "ld"  => :label_yesterday,
168
    "w"   => :label_this_week,
169
    "lw"  => :label_last_week,
170
    "l2w" => [:label_last_n_weeks, {:count => 2}],
171
    "m"   => :label_this_month,
172
    "lm"  => :label_last_month,
173
    "y"   => :label_this_year,
174
    ">t-" => :label_less_than_ago,
175
    "<t-" => :label_more_than_ago,
176
    "><t-"=> :label_in_the_past_days,
177
    "t-"  => :label_ago,
178
    "~"   => :label_contains,
179
    "!~"  => :label_not_contains,
180
    "=p"  => :label_any_issues_in_project,
181
    "=!p" => :label_any_issues_not_in_project,
182
    "!p"  => :label_no_issues_in_project
183
  }
184 441:cbce1fd3b1b7 Chris
185 1464:261b3d9a4903 Chris
  class_attribute :operators_by_filter_type
186
  self.operators_by_filter_type = {
187
    :list => [ "=", "!" ],
188
    :list_status => [ "o", "=", "!", "c", "*" ],
189
    :list_optional => [ "=", "!", "!*", "*" ],
190
    :list_subprojects => [ "*", "!*", "=" ],
191
    :date => [ "=", ">=", "<=", "><", "<t+", ">t+", "><t+", "t+", "t", "ld", "w", "lw", "l2w", "m", "lm", "y", ">t-", "<t-", "><t-", "t-", "!*", "*" ],
192
    :date_past => [ "=", ">=", "<=", "><", ">t-", "<t-", "><t-", "t-", "t", "ld", "w", "lw", "l2w", "m", "lm", "y", "!*", "*" ],
193
    :string => [ "=", "~", "!", "!~", "!*", "*" ],
194
    :text => [  "~", "!~", "!*", "*" ],
195
    :integer => [ "=", ">=", "<=", "><", "!*", "*" ],
196
    :float => [ "=", ">=", "<=", "><", "!*", "*" ],
197
    :relation => ["=", "=p", "=!p", "!p", "!*", "*"]
198
  }
199 0:513646585e45 Chris
200 1464:261b3d9a4903 Chris
  class_attribute :available_columns
201
  self.available_columns = []
202 0:513646585e45 Chris
203 1464:261b3d9a4903 Chris
  class_attribute :queried_class
204 441:cbce1fd3b1b7 Chris
205 1464:261b3d9a4903 Chris
  def queried_table_name
206
    @queried_table_name ||= self.class.queried_class.table_name
207
  end
208 909:cbb26bc654de Chris
209 1115:433d4f72a19b Chris
  def initialize(attributes=nil, *args)
210 0:513646585e45 Chris
    super attributes
211
    @is_for_all = project.nil?
212
  end
213 441:cbce1fd3b1b7 Chris
214 1464:261b3d9a4903 Chris
  # Builds the query from the given params
215
  def build_from_params(params)
216
    if params[:fields] || params[:f]
217
      self.filters = {}
218
      add_filters(params[:fields] || params[:f], params[:operators] || params[:op], params[:values] || params[:v])
219
    else
220
      available_filters.keys.each do |field|
221
        add_short_filter(field, params[field]) if params[field]
222
      end
223
    end
224
    self.group_by = params[:group_by] || (params[:query] && params[:query][:group_by])
225
    self.column_names = params[:c] || (params[:query] && params[:query][:column_names])
226
    self
227
  end
228
229
  # Builds a new query from the given params and attributes
230
  def self.build_from_params(params, attributes={})
231
    new(attributes).build_from_params(params)
232
  end
233
234 909:cbb26bc654de Chris
  def validate_query_filters
235 0:513646585e45 Chris
    filters.each_key do |field|
236 909:cbb26bc654de Chris
      if values_for(field)
237
        case type_for(field)
238
        when :integer
239 1115:433d4f72a19b Chris
          add_filter_error(field, :invalid) if values_for(field).detect {|v| v.present? && !v.match(/^[+-]?\d+$/) }
240 909:cbb26bc654de Chris
        when :float
241 1115:433d4f72a19b Chris
          add_filter_error(field, :invalid) if values_for(field).detect {|v| v.present? && !v.match(/^[+-]?\d+(\.\d*)?$/) }
242 909:cbb26bc654de Chris
        when :date, :date_past
243
          case operator_for(field)
244
          when "=", ">=", "<=", "><"
245 1517:dffacf8a6908 Chris
            add_filter_error(field, :invalid) if values_for(field).detect {|v|
246
              v.present? && (!v.match(/\A\d{4}-\d{2}-\d{2}(T\d{2}((:)?\d{2}){0,2}(Z|\d{2}:?\d{2})?)?\z/) || parse_date(v).nil?)
247
            }
248 1115:433d4f72a19b Chris
          when ">t-", "<t-", "t-", ">t+", "<t+", "t+", "><t+", "><t-"
249
            add_filter_error(field, :invalid) if values_for(field).detect {|v| v.present? && !v.match(/^\d+$/) }
250 909:cbb26bc654de Chris
          end
251
        end
252
      end
253
254 1115:433d4f72a19b Chris
      add_filter_error(field, :blank) unless
255 0:513646585e45 Chris
          # filter requires one or more values
256 441:cbce1fd3b1b7 Chris
          (values_for(field) and !values_for(field).first.blank?) or
257 0:513646585e45 Chris
          # filter doesn't require any value
258 1464:261b3d9a4903 Chris
          ["o", "c", "!*", "*", "t", "ld", "w", "lw", "l2w", "m", "lm", "y"].include? operator_for(field)
259 0:513646585e45 Chris
    end if filters
260
  end
261 909:cbb26bc654de Chris
262 1115:433d4f72a19b Chris
  def add_filter_error(field, message)
263
    m = label_for(field) + " " + l(message, :scope => 'activerecord.errors.messages')
264
    errors.add(:base, m)
265
  end
266
267 0:513646585e45 Chris
  def editable_by?(user)
268
    return false unless user
269
    # Admin can edit them all and regular users can edit their private queries
270 1464:261b3d9a4903 Chris
    return true if user.admin? || (is_private? && self.user_id == user.id)
271 0:513646585e45 Chris
    # Members can not edit public queries that are for all project (only admin is allowed to)
272 1464:261b3d9a4903 Chris
    is_public? && !@is_for_all && user.allowed_to?(:manage_public_queries, project)
273 0:513646585e45 Chris
  end
274 441:cbce1fd3b1b7 Chris
275 1115:433d4f72a19b Chris
  def trackers
276 1464:261b3d9a4903 Chris
    @trackers ||= project.nil? ? Tracker.sorted.all : project.rolled_up_trackers
277 1115:433d4f72a19b Chris
  end
278
279
  # Returns a hash of localized labels for all filter operators
280
  def self.operators_labels
281 1464:261b3d9a4903 Chris
    operators.inject({}) {|h, operator| h[operator.first] = l(*operator.last); h}
282 0:513646585e45 Chris
  end
283 441:cbce1fd3b1b7 Chris
284 1115:433d4f72a19b Chris
  # Returns a representation of the available filters for JSON serialization
285
  def available_filters_as_json
286
    json = {}
287
    available_filters.each do |field, options|
288
      json[field] = options.slice(:type, :name, :values).stringify_keys
289
    end
290
    json
291
  end
292
293
  def all_projects
294
    @all_projects ||= Project.visible.all
295
  end
296
297
  def all_projects_values
298
    return @all_projects_values if @all_projects_values
299
300
    values = []
301
    Project.project_tree(all_projects) do |p, level|
302
      prefix = (level > 0 ? ('--' * level + ' ') : '')
303
      values << ["#{prefix}#{p.name}", p.id.to_s]
304
    end
305
    @all_projects_values = values
306
  end
307
308 1464:261b3d9a4903 Chris
  # Adds available filters
309
  def initialize_available_filters
310
    # implemented by sub-classes
311
  end
312
  protected :initialize_available_filters
313
314
  # Adds an available filter
315
  def add_available_filter(field, options)
316
    @available_filters ||= ActiveSupport::OrderedHash.new
317
    @available_filters[field] = options
318
    @available_filters
319
  end
320
321
  # Removes an available filter
322
  def delete_available_filter(field)
323
    if @available_filters
324
      @available_filters.delete(field)
325
    end
326
  end
327
328
  # Return a hash of available filters
329
  def available_filters
330
    unless @available_filters
331
      initialize_available_filters
332
      @available_filters.each do |field, options|
333
        options[:name] ||= l(options[:label] || "field_#{field}".gsub(/_id$/, ''))
334
      end
335
    end
336
    @available_filters
337
  end
338
339
  def add_filter(field, operator, values=nil)
340 0:513646585e45 Chris
    # values must be an array
341 909:cbb26bc654de Chris
    return unless values.nil? || values.is_a?(Array)
342 0:513646585e45 Chris
    # check if field is defined as an available filter
343
    if available_filters.has_key? field
344
      filter_options = available_filters[field]
345 909:cbb26bc654de Chris
      filters[field] = {:operator => operator, :values => (values || [''])}
346 0:513646585e45 Chris
    end
347
  end
348 441:cbce1fd3b1b7 Chris
349 0:513646585e45 Chris
  def add_short_filter(field, expression)
350 909:cbb26bc654de Chris
    return unless expression && available_filters.has_key?(field)
351
    field_type = available_filters[field][:type]
352 1464:261b3d9a4903 Chris
    operators_by_filter_type[field_type].sort.reverse.detect do |operator|
353 909:cbb26bc654de Chris
      next unless expression =~ /^#{Regexp.escape(operator)}(.*)$/
354 1464:261b3d9a4903 Chris
      values = $1
355
      add_filter field, operator, values.present? ? values.split('|') : ['']
356 909:cbb26bc654de Chris
    end || add_filter(field, '=', expression.split('|'))
357 0:513646585e45 Chris
  end
358
359
  # Add multiple filters using +add_filter+
360
  def add_filters(fields, operators, values)
361 909:cbb26bc654de Chris
    if fields.is_a?(Array) && operators.is_a?(Hash) && (values.nil? || values.is_a?(Hash))
362 37:94944d00e43c chris
      fields.each do |field|
363 909:cbb26bc654de Chris
        add_filter(field, operators[field], values && values[field])
364 37:94944d00e43c chris
      end
365 0:513646585e45 Chris
    end
366
  end
367 441:cbce1fd3b1b7 Chris
368 0:513646585e45 Chris
  def has_filter?(field)
369
    filters and filters[field]
370
  end
371 441:cbce1fd3b1b7 Chris
372 909:cbb26bc654de Chris
  def type_for(field)
373
    available_filters[field][:type] if available_filters.has_key?(field)
374
  end
375
376 0:513646585e45 Chris
  def operator_for(field)
377
    has_filter?(field) ? filters[field][:operator] : nil
378
  end
379 441:cbce1fd3b1b7 Chris
380 0:513646585e45 Chris
  def values_for(field)
381
    has_filter?(field) ? filters[field][:values] : nil
382
  end
383 441:cbce1fd3b1b7 Chris
384 909:cbb26bc654de Chris
  def value_for(field, index=0)
385
    (values_for(field) || [])[index]
386
  end
387
388 0:513646585e45 Chris
  def label_for(field)
389
    label = available_filters[field][:name] if available_filters.has_key?(field)
390 1115:433d4f72a19b Chris
    label ||= l("field_#{field.to_s.gsub(/_id$/, '')}", :default => field)
391 0:513646585e45 Chris
  end
392
393
  def self.add_available_column(column)
394
    self.available_columns << (column) if column.is_a?(QueryColumn)
395
  end
396 441:cbce1fd3b1b7 Chris
397 0:513646585e45 Chris
  # Returns an array of columns that can be used to group the results
398
  def groupable_columns
399
    available_columns.select {|c| c.groupable}
400
  end
401
402
  # Returns a Hash of columns and the key for sorting
403
  def sortable_columns
404 1464:261b3d9a4903 Chris
    available_columns.inject({}) {|h, column|
405
      h[column.name.to_s] = column.sortable
406
      h
407
    }
408 0:513646585e45 Chris
  end
409 441:cbce1fd3b1b7 Chris
410 0:513646585e45 Chris
  def columns
411 909:cbb26bc654de Chris
    # preserve the column_names order
412 1464:261b3d9a4903 Chris
    cols = (has_default_columns? ? default_columns_names : column_names).collect do |name|
413 909:cbb26bc654de Chris
       available_columns.find { |col| col.name == name }
414
    end.compact
415 1464:261b3d9a4903 Chris
    available_columns.select(&:frozen?) | cols
416 909:cbb26bc654de Chris
  end
417
418 1115:433d4f72a19b Chris
  def inline_columns
419
    columns.select(&:inline?)
420
  end
421
422
  def block_columns
423
    columns.reject(&:inline?)
424
  end
425
426
  def available_inline_columns
427
    available_columns.select(&:inline?)
428
  end
429
430
  def available_block_columns
431
    available_columns.reject(&:inline?)
432
  end
433
434 909:cbb26bc654de Chris
  def default_columns_names
435 1464:261b3d9a4903 Chris
    []
436 0:513646585e45 Chris
  end
437 441:cbce1fd3b1b7 Chris
438 0:513646585e45 Chris
  def column_names=(names)
439
    if names
440
      names = names.select {|n| n.is_a?(Symbol) || !n.blank? }
441
      names = names.collect {|n| n.is_a?(Symbol) ? n : n.to_sym }
442
      # Set column_names to nil if default columns
443 909:cbb26bc654de Chris
      if names == default_columns_names
444 0:513646585e45 Chris
        names = nil
445
      end
446
    end
447
    write_attribute(:column_names, names)
448
  end
449 441:cbce1fd3b1b7 Chris
450 0:513646585e45 Chris
  def has_column?(column)
451 1115:433d4f72a19b Chris
    column_names && column_names.include?(column.is_a?(QueryColumn) ? column.name : column)
452 0:513646585e45 Chris
  end
453 441:cbce1fd3b1b7 Chris
454 1464:261b3d9a4903 Chris
  def has_custom_field_column?
455
    columns.any? {|column| column.is_a? QueryCustomFieldColumn}
456
  end
457
458 0:513646585e45 Chris
  def has_default_columns?
459
    column_names.nil? || column_names.empty?
460
  end
461 441:cbce1fd3b1b7 Chris
462 0:513646585e45 Chris
  def sort_criteria=(arg)
463
    c = []
464
    if arg.is_a?(Hash)
465
      arg = arg.keys.sort.collect {|k| arg[k]}
466
    end
467 1115:433d4f72a19b Chris
    c = arg.select {|k,o| !k.to_s.blank?}.slice(0,3).collect {|k,o| [k.to_s, (o == 'desc' || o == false) ? 'desc' : 'asc']}
468 0:513646585e45 Chris
    write_attribute(:sort_criteria, c)
469
  end
470 441:cbce1fd3b1b7 Chris
471 0:513646585e45 Chris
  def sort_criteria
472
    read_attribute(:sort_criteria) || []
473
  end
474 441:cbce1fd3b1b7 Chris
475 0:513646585e45 Chris
  def sort_criteria_key(arg)
476
    sort_criteria && sort_criteria[arg] && sort_criteria[arg].first
477
  end
478 441:cbce1fd3b1b7 Chris
479 0:513646585e45 Chris
  def sort_criteria_order(arg)
480
    sort_criteria && sort_criteria[arg] && sort_criteria[arg].last
481
  end
482 441:cbce1fd3b1b7 Chris
483 1115:433d4f72a19b Chris
  def sort_criteria_order_for(key)
484
    sort_criteria.detect {|k, order| key.to_s == k}.try(:last)
485
  end
486
487 0:513646585e45 Chris
  # Returns the SQL sort order that should be prepended for grouping
488
  def group_by_sort_order
489
    if grouped? && (column = group_by_column)
490 1115:433d4f72a19b Chris
      order = sort_criteria_order_for(column.name) || column.default_order
491 0:513646585e45 Chris
      column.sortable.is_a?(Array) ?
492 1115:433d4f72a19b Chris
        column.sortable.collect {|s| "#{s} #{order}"}.join(',') :
493
        "#{column.sortable} #{order}"
494 0:513646585e45 Chris
    end
495
  end
496 441:cbce1fd3b1b7 Chris
497 0:513646585e45 Chris
  # Returns true if the query is a grouped query
498
  def grouped?
499 119:8661b858af72 Chris
    !group_by_column.nil?
500 0:513646585e45 Chris
  end
501 441:cbce1fd3b1b7 Chris
502 0:513646585e45 Chris
  def group_by_column
503 119:8661b858af72 Chris
    groupable_columns.detect {|c| c.groupable && c.name.to_s == group_by}
504 0:513646585e45 Chris
  end
505 441:cbce1fd3b1b7 Chris
506 0:513646585e45 Chris
  def group_by_statement
507 119:8661b858af72 Chris
    group_by_column.try(:groupable)
508 0:513646585e45 Chris
  end
509 441:cbce1fd3b1b7 Chris
510 0:513646585e45 Chris
  def project_statement
511
    project_clauses = []
512 909:cbb26bc654de Chris
    if project && !project.descendants.active.empty?
513 0:513646585e45 Chris
      ids = [project.id]
514
      if has_filter?("subproject_id")
515
        case operator_for("subproject_id")
516
        when '='
517
          # include the selected subprojects
518
          ids += values_for("subproject_id").each(&:to_i)
519
        when '!*'
520
          # main project only
521
        else
522
          # all subprojects
523
          ids += project.descendants.collect(&:id)
524
        end
525
      elsif Setting.display_subprojects_issues?
526
        ids += project.descendants.collect(&:id)
527
      end
528
      project_clauses << "#{Project.table_name}.id IN (%s)" % ids.join(',')
529
    elsif project
530
      project_clauses << "#{Project.table_name}.id = %d" % project.id
531
    end
532 441:cbce1fd3b1b7 Chris
    project_clauses.any? ? project_clauses.join(' AND ') : nil
533 0:513646585e45 Chris
  end
534
535
  def statement
536
    # filters clauses
537
    filters_clauses = []
538
    filters.each_key do |field|
539
      next if field == "subproject_id"
540
      v = values_for(field).clone
541
      next unless v and !v.empty?
542
      operator = operator_for(field)
543 441:cbce1fd3b1b7 Chris
544 0:513646585e45 Chris
      # "me" value subsitution
545 1464:261b3d9a4903 Chris
      if %w(assigned_to_id author_id user_id watcher_id).include?(field)
546 909:cbb26bc654de Chris
        if v.delete("me")
547
          if User.current.logged?
548
            v.push(User.current.id.to_s)
549
            v += User.current.group_ids.map(&:to_s) if field == 'assigned_to_id'
550
          else
551
            v.push("0")
552
          end
553
        end
554 0:513646585e45 Chris
      end
555 441:cbce1fd3b1b7 Chris
556 1115:433d4f72a19b Chris
      if field == 'project_id'
557
        if v.delete('mine')
558
          v += User.current.memberships.map(&:project_id).map(&:to_s)
559
        end
560
      end
561
562
      if field =~ /cf_(\d+)$/
563 0:513646585e45 Chris
        # custom field
564 909:cbb26bc654de Chris
        filters_clauses << sql_for_custom_field(field, operator, v, $1)
565
      elsif respond_to?("sql_for_#{field}_field")
566
        # specific statement
567
        filters_clauses << send("sql_for_#{field}_field", field, operator, v)
568 0:513646585e45 Chris
      else
569
        # regular field
570 1464:261b3d9a4903 Chris
        filters_clauses << '(' + sql_for_field(field, operator, v, queried_table_name, field) + ')'
571 0:513646585e45 Chris
      end
572
    end if filters and valid?
573 441:cbce1fd3b1b7 Chris
574 1464:261b3d9a4903 Chris
    if (c = group_by_column) && c.is_a?(QueryCustomFieldColumn)
575
      # Excludes results for which the grouped custom field is not visible
576
      filters_clauses << c.custom_field.visibility_by_project_condition
577
    end
578
579 441:cbce1fd3b1b7 Chris
    filters_clauses << project_statement
580
    filters_clauses.reject!(&:blank?)
581
582
    filters_clauses.any? ? filters_clauses.join(' AND ') : nil
583 0:513646585e45 Chris
  end
584 441:cbce1fd3b1b7 Chris
585 0:513646585e45 Chris
  private
586 441:cbce1fd3b1b7 Chris
587 909:cbb26bc654de Chris
  def sql_for_custom_field(field, operator, value, custom_field_id)
588
    db_table = CustomValue.table_name
589
    db_field = 'value'
590 1115:433d4f72a19b Chris
    filter = @available_filters[field]
591
    return nil unless filter
592 1517:dffacf8a6908 Chris
    if filter[:field].format.target_class && filter[:field].format.target_class <= User
593 1115:433d4f72a19b Chris
      if value.delete('me')
594
        value.push User.current.id.to_s
595
      end
596
    end
597
    not_in = nil
598
    if operator == '!'
599
      # Makes ! operator work for custom fields with multiple values
600
      operator = '='
601
      not_in = 'NOT'
602
    end
603
    customized_key = "id"
604 1464:261b3d9a4903 Chris
    customized_class = queried_class
605 1115:433d4f72a19b Chris
    if field =~ /^(.+)\.cf_/
606
      assoc = $1
607
      customized_key = "#{assoc}_id"
608 1464:261b3d9a4903 Chris
      customized_class = queried_class.reflect_on_association(assoc.to_sym).klass.base_class rescue nil
609
      raise "Unknown #{queried_class.name} association #{assoc}" unless customized_class
610 1115:433d4f72a19b Chris
    end
611 1464:261b3d9a4903 Chris
    where = sql_for_field(field, operator, value, db_table, db_field, true)
612
    if operator =~ /[<>]/
613
      where = "(#{where}) AND #{db_table}.#{db_field} <> ''"
614
    end
615
    "#{queried_table_name}.#{customized_key} #{not_in} IN (" +
616
      "SELECT #{customized_class.table_name}.id FROM #{customized_class.table_name}" +
617
      " LEFT OUTER JOIN #{db_table} ON #{db_table}.customized_type='#{customized_class}' AND #{db_table}.customized_id=#{customized_class.table_name}.id AND #{db_table}.custom_field_id=#{custom_field_id}" +
618
      " WHERE (#{where}) AND (#{filter[:field].visibility_by_project_condition}))"
619 909:cbb26bc654de Chris
  end
620
621 0:513646585e45 Chris
  # Helper method to generate the WHERE sql for a +field+, +operator+ and a +value+
622
  def sql_for_field(field, operator, value, db_table, db_field, is_custom_filter=false)
623
    sql = ''
624
    case operator
625
    when "="
626 245:051f544170fe Chris
      if value.any?
627 909:cbb26bc654de Chris
        case type_for(field)
628
        when :date, :date_past
629 1517:dffacf8a6908 Chris
          sql = date_clause(db_table, db_field, parse_date(value.first), parse_date(value.first))
630 909:cbb26bc654de Chris
        when :integer
631 1115:433d4f72a19b Chris
          if is_custom_filter
632 1464:261b3d9a4903 Chris
            sql = "(#{db_table}.#{db_field} <> '' AND CAST(CASE #{db_table}.#{db_field} WHEN '' THEN '0' ELSE #{db_table}.#{db_field} END AS decimal(30,3)) = #{value.first.to_i})"
633 1115:433d4f72a19b Chris
          else
634
            sql = "#{db_table}.#{db_field} = #{value.first.to_i}"
635
          end
636 909:cbb26bc654de Chris
        when :float
637 1115:433d4f72a19b Chris
          if is_custom_filter
638 1464:261b3d9a4903 Chris
            sql = "(#{db_table}.#{db_field} <> '' AND CAST(CASE #{db_table}.#{db_field} WHEN '' THEN '0' ELSE #{db_table}.#{db_field} END AS decimal(30,3)) BETWEEN #{value.first.to_f - 1e-5} AND #{value.first.to_f + 1e-5})"
639 1115:433d4f72a19b Chris
          else
640
            sql = "#{db_table}.#{db_field} BETWEEN #{value.first.to_f - 1e-5} AND #{value.first.to_f + 1e-5}"
641
          end
642 909:cbb26bc654de Chris
        else
643
          sql = "#{db_table}.#{db_field} IN (" + value.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + ")"
644
        end
645 245:051f544170fe Chris
      else
646
        # IN an empty set
647
        sql = "1=0"
648
      end
649 0:513646585e45 Chris
    when "!"
650 245:051f544170fe Chris
      if value.any?
651
        sql = "(#{db_table}.#{db_field} IS NULL OR #{db_table}.#{db_field} NOT IN (" + value.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + "))"
652
      else
653
        # NOT IN an empty set
654
        sql = "1=1"
655
      end
656 0:513646585e45 Chris
    when "!*"
657
      sql = "#{db_table}.#{db_field} IS NULL"
658
      sql << " OR #{db_table}.#{db_field} = ''" if is_custom_filter
659
    when "*"
660
      sql = "#{db_table}.#{db_field} IS NOT NULL"
661
      sql << " AND #{db_table}.#{db_field} <> ''" if is_custom_filter
662
    when ">="
663 909:cbb26bc654de Chris
      if [:date, :date_past].include?(type_for(field))
664 1517:dffacf8a6908 Chris
        sql = date_clause(db_table, db_field, parse_date(value.first), nil)
665 909:cbb26bc654de Chris
      else
666
        if is_custom_filter
667 1464:261b3d9a4903 Chris
          sql = "(#{db_table}.#{db_field} <> '' AND CAST(CASE #{db_table}.#{db_field} WHEN '' THEN '0' ELSE #{db_table}.#{db_field} END AS decimal(30,3)) >= #{value.first.to_f})"
668 909:cbb26bc654de Chris
        else
669
          sql = "#{db_table}.#{db_field} >= #{value.first.to_f}"
670
        end
671
      end
672 0:513646585e45 Chris
    when "<="
673 909:cbb26bc654de Chris
      if [:date, :date_past].include?(type_for(field))
674 1517:dffacf8a6908 Chris
        sql = date_clause(db_table, db_field, nil, parse_date(value.first))
675 909:cbb26bc654de Chris
      else
676
        if is_custom_filter
677 1464:261b3d9a4903 Chris
          sql = "(#{db_table}.#{db_field} <> '' AND CAST(CASE #{db_table}.#{db_field} WHEN '' THEN '0' ELSE #{db_table}.#{db_field} END AS decimal(30,3)) <= #{value.first.to_f})"
678 909:cbb26bc654de Chris
        else
679
          sql = "#{db_table}.#{db_field} <= #{value.first.to_f}"
680
        end
681
      end
682
    when "><"
683
      if [:date, :date_past].include?(type_for(field))
684 1517:dffacf8a6908 Chris
        sql = date_clause(db_table, db_field, parse_date(value[0]), parse_date(value[1]))
685 909:cbb26bc654de Chris
      else
686
        if is_custom_filter
687 1464:261b3d9a4903 Chris
          sql = "(#{db_table}.#{db_field} <> '' AND CAST(CASE #{db_table}.#{db_field} WHEN '' THEN '0' ELSE #{db_table}.#{db_field} END AS decimal(30,3)) BETWEEN #{value[0].to_f} AND #{value[1].to_f})"
688 909:cbb26bc654de Chris
        else
689
          sql = "#{db_table}.#{db_field} BETWEEN #{value[0].to_f} AND #{value[1].to_f}"
690
        end
691
      end
692 0:513646585e45 Chris
    when "o"
693 1464:261b3d9a4903 Chris
      sql = "#{queried_table_name}.status_id IN (SELECT id FROM #{IssueStatus.table_name} WHERE is_closed=#{connection.quoted_false})" if field == "status_id"
694 0:513646585e45 Chris
    when "c"
695 1464:261b3d9a4903 Chris
      sql = "#{queried_table_name}.status_id IN (SELECT id FROM #{IssueStatus.table_name} WHERE is_closed=#{connection.quoted_true})" if field == "status_id"
696 1115:433d4f72a19b Chris
    when "><t-"
697
      # between today - n days and today
698
      sql = relative_date_clause(db_table, db_field, - value.first.to_i, 0)
699 0:513646585e45 Chris
    when ">t-"
700 1115:433d4f72a19b Chris
      # >= today - n days
701
      sql = relative_date_clause(db_table, db_field, - value.first.to_i, nil)
702 0:513646585e45 Chris
    when "<t-"
703 1115:433d4f72a19b Chris
      # <= today - n days
704 909:cbb26bc654de Chris
      sql = relative_date_clause(db_table, db_field, nil, - value.first.to_i)
705 0:513646585e45 Chris
    when "t-"
706 1115:433d4f72a19b Chris
      # = n days in past
707 909:cbb26bc654de Chris
      sql = relative_date_clause(db_table, db_field, - value.first.to_i, - value.first.to_i)
708 1115:433d4f72a19b Chris
    when "><t+"
709
      # between today and today + n days
710
      sql = relative_date_clause(db_table, db_field, 0, value.first.to_i)
711 0:513646585e45 Chris
    when ">t+"
712 1115:433d4f72a19b Chris
      # >= today + n days
713 909:cbb26bc654de Chris
      sql = relative_date_clause(db_table, db_field, value.first.to_i, nil)
714 0:513646585e45 Chris
    when "<t+"
715 1115:433d4f72a19b Chris
      # <= today + n days
716
      sql = relative_date_clause(db_table, db_field, nil, value.first.to_i)
717 0:513646585e45 Chris
    when "t+"
718 1115:433d4f72a19b Chris
      # = today + n days
719 909:cbb26bc654de Chris
      sql = relative_date_clause(db_table, db_field, value.first.to_i, value.first.to_i)
720 0:513646585e45 Chris
    when "t"
721 1115:433d4f72a19b Chris
      # = today
722 909:cbb26bc654de Chris
      sql = relative_date_clause(db_table, db_field, 0, 0)
723 1464:261b3d9a4903 Chris
    when "ld"
724
      # = yesterday
725
      sql = relative_date_clause(db_table, db_field, -1, -1)
726 0:513646585e45 Chris
    when "w"
727 1115:433d4f72a19b Chris
      # = this week
728 441:cbce1fd3b1b7 Chris
      first_day_of_week = l(:general_first_day_of_week).to_i
729
      day_of_week = Date.today.cwday
730
      days_ago = (day_of_week >= first_day_of_week ? day_of_week - first_day_of_week : day_of_week + 7 - first_day_of_week)
731 909:cbb26bc654de Chris
      sql = relative_date_clause(db_table, db_field, - days_ago, - days_ago + 6)
732 1464:261b3d9a4903 Chris
    when "lw"
733
      # = last week
734
      first_day_of_week = l(:general_first_day_of_week).to_i
735
      day_of_week = Date.today.cwday
736
      days_ago = (day_of_week >= first_day_of_week ? day_of_week - first_day_of_week : day_of_week + 7 - first_day_of_week)
737
      sql = relative_date_clause(db_table, db_field, - days_ago - 7, - days_ago - 1)
738
    when "l2w"
739
      # = last 2 weeks
740
      first_day_of_week = l(:general_first_day_of_week).to_i
741
      day_of_week = Date.today.cwday
742
      days_ago = (day_of_week >= first_day_of_week ? day_of_week - first_day_of_week : day_of_week + 7 - first_day_of_week)
743
      sql = relative_date_clause(db_table, db_field, - days_ago - 14, - days_ago - 1)
744
    when "m"
745
      # = this month
746
      date = Date.today
747
      sql = date_clause(db_table, db_field, date.beginning_of_month, date.end_of_month)
748
    when "lm"
749
      # = last month
750
      date = Date.today.prev_month
751
      sql = date_clause(db_table, db_field, date.beginning_of_month, date.end_of_month)
752
    when "y"
753
      # = this year
754
      date = Date.today
755
      sql = date_clause(db_table, db_field, date.beginning_of_year, date.end_of_year)
756 0:513646585e45 Chris
    when "~"
757
      sql = "LOWER(#{db_table}.#{db_field}) LIKE '%#{connection.quote_string(value.first.to_s.downcase)}%'"
758
    when "!~"
759
      sql = "LOWER(#{db_table}.#{db_field}) NOT LIKE '%#{connection.quote_string(value.first.to_s.downcase)}%'"
760 909:cbb26bc654de Chris
    else
761
      raise "Unknown query operator #{operator}"
762 0:513646585e45 Chris
    end
763 441:cbce1fd3b1b7 Chris
764 0:513646585e45 Chris
    return sql
765
  end
766 441:cbce1fd3b1b7 Chris
767 1464:261b3d9a4903 Chris
  # Adds a filter for the given custom field
768
  def add_custom_field_filter(field, assoc=nil)
769 1517:dffacf8a6908 Chris
    options = field.format.query_filter_options(field, self)
770
    if field.format.target_class && field.format.target_class <= User
771
      if options[:values].is_a?(Array) && User.current.logged?
772
        options[:values].unshift ["<< #{l(:label_me)} >>", "me"]
773 1464:261b3d9a4903 Chris
      end
774
    end
775 1517:dffacf8a6908 Chris
776 1464:261b3d9a4903 Chris
    filter_id = "cf_#{field.id}"
777
    filter_name = field.name
778
    if assoc.present?
779
      filter_id = "#{assoc}.#{filter_id}"
780
      filter_name = l("label_attribute_of_#{assoc}", :name => filter_name)
781
    end
782
    add_available_filter filter_id, options.merge({
783
      :name => filter_name,
784
      :field => field
785
    })
786
  end
787 441:cbce1fd3b1b7 Chris
788 1464:261b3d9a4903 Chris
  # Adds filters for the given custom fields scope
789
  def add_custom_fields_filters(scope, assoc=nil)
790
    scope.visible.where(:is_filter => true).sorted.each do |field|
791
      add_custom_field_filter(field, assoc)
792 1115:433d4f72a19b Chris
    end
793
  end
794
795 1464:261b3d9a4903 Chris
  # Adds filters for the given associations custom fields
796 1115:433d4f72a19b Chris
  def add_associations_custom_fields_filters(*associations)
797 1464:261b3d9a4903 Chris
    fields_by_class = CustomField.visible.where(:is_filter => true).group_by(&:class)
798 1115:433d4f72a19b Chris
    associations.each do |assoc|
799 1464:261b3d9a4903 Chris
      association_klass = queried_class.reflect_on_association(assoc).klass
800 1115:433d4f72a19b Chris
      fields_by_class.each do |field_class, fields|
801
        if field_class.customized_class <= association_klass
802 1464:261b3d9a4903 Chris
          fields.sort.each do |field|
803
            add_custom_field_filter(field, assoc)
804
          end
805 1115:433d4f72a19b Chris
        end
806
      end
807 0:513646585e45 Chris
    end
808
  end
809 441:cbce1fd3b1b7 Chris
810 0:513646585e45 Chris
  # Returns a SQL clause for a date or datetime field.
811 909:cbb26bc654de Chris
  def date_clause(table, field, from, to)
812 0:513646585e45 Chris
    s = []
813
    if from
814 1517:dffacf8a6908 Chris
      if from.is_a?(Date)
815
        from = Time.local(from.year, from.month, from.day).yesterday.end_of_day
816
      else
817
        from = from - 1 # second
818
      end
819 1115:433d4f72a19b Chris
      if self.class.default_timezone == :utc
820 1517:dffacf8a6908 Chris
        from = from.utc
821 1115:433d4f72a19b Chris
      end
822 1517:dffacf8a6908 Chris
      s << ("#{table}.#{field} > '%s'" % [connection.quoted_date(from)])
823 0:513646585e45 Chris
    end
824
    if to
825 1517:dffacf8a6908 Chris
      if to.is_a?(Date)
826
        to = Time.local(to.year, to.month, to.day).end_of_day
827
      end
828 1115:433d4f72a19b Chris
      if self.class.default_timezone == :utc
829 1517:dffacf8a6908 Chris
        to = to.utc
830 1115:433d4f72a19b Chris
      end
831 1517:dffacf8a6908 Chris
      s << ("#{table}.#{field} <= '%s'" % [connection.quoted_date(to)])
832 0:513646585e45 Chris
    end
833
    s.join(' AND ')
834
  end
835 909:cbb26bc654de Chris
836
  # Returns a SQL clause for a date or datetime field using relative dates.
837
  def relative_date_clause(table, field, days_from, days_to)
838
    date_clause(table, field, (days_from ? Date.today + days_from : nil), (days_to ? Date.today + days_to : nil))
839
  end
840 1115:433d4f72a19b Chris
841 1517:dffacf8a6908 Chris
  # Returns a Date or Time from the given filter value
842
  def parse_date(arg)
843
    if arg.to_s =~ /\A\d{4}-\d{2}-\d{2}T/
844
      Time.parse(arg) rescue nil
845
    else
846
      Date.parse(arg) rescue nil
847
    end
848
  end
849
850 1115:433d4f72a19b Chris
  # Additional joins required for the given sort options
851
  def joins_for_order_statement(order_options)
852
    joins = []
853
854
    if order_options
855
      if order_options.include?('authors')
856 1464:261b3d9a4903 Chris
        joins << "LEFT OUTER JOIN #{User.table_name} authors ON authors.id = #{queried_table_name}.author_id"
857 1115:433d4f72a19b Chris
      end
858
      order_options.scan(/cf_\d+/).uniq.each do |name|
859
        column = available_columns.detect {|c| c.name.to_s == name}
860
        join = column && column.custom_field.join_for_order_statement
861
        if join
862
          joins << join
863
        end
864
      end
865
    end
866
867
    joins.any? ? joins.join(' ') : nil
868
  end
869 0:513646585e45 Chris
end