annotate app/models/query.rb @ 859:9a16b2c1fd56 bug_189

Close obsolete branch bug_189
author Chris Cannam
date Tue, 12 Jul 2011 16:42:08 +0100
parents cbce1fd3b1b7
children 0c939c159af4
rev   line source
Chris@0 1 # Redmine - project management software
Chris@441 2 # Copyright (C) 2006-2011 Jean-Philippe Lang
Chris@0 3 #
Chris@0 4 # This program is free software; you can redistribute it and/or
Chris@0 5 # modify it under the terms of the GNU General Public License
Chris@0 6 # as published by the Free Software Foundation; either version 2
Chris@0 7 # of the License, or (at your option) any later version.
Chris@441 8 #
Chris@0 9 # This program is distributed in the hope that it will be useful,
Chris@0 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@0 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@0 12 # GNU General Public License for more details.
Chris@441 13 #
Chris@0 14 # You should have received a copy of the GNU General Public License
Chris@0 15 # along with this program; if not, write to the Free Software
Chris@0 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@0 17
Chris@441 18 class QueryColumn
Chris@0 19 attr_accessor :name, :sortable, :groupable, :default_order
Chris@0 20 include Redmine::I18n
Chris@441 21
Chris@0 22 def initialize(name, options={})
Chris@0 23 self.name = name
Chris@0 24 self.sortable = options[:sortable]
Chris@0 25 self.groupable = options[:groupable] || false
Chris@0 26 if groupable == true
Chris@0 27 self.groupable = name.to_s
Chris@0 28 end
Chris@0 29 self.default_order = options[:default_order]
Chris@0 30 @caption_key = options[:caption] || "field_#{name}"
Chris@0 31 end
Chris@441 32
Chris@0 33 def caption
Chris@0 34 l(@caption_key)
Chris@0 35 end
Chris@441 36
Chris@0 37 # Returns true if the column is sortable, otherwise false
Chris@0 38 def sortable?
Chris@0 39 !sortable.nil?
Chris@0 40 end
Chris@441 41
Chris@0 42 def value(issue)
Chris@0 43 issue.send name
Chris@0 44 end
Chris@441 45
Chris@441 46 def css_classes
Chris@441 47 name
Chris@441 48 end
Chris@0 49 end
Chris@0 50
Chris@0 51 class QueryCustomFieldColumn < QueryColumn
Chris@0 52
Chris@0 53 def initialize(custom_field)
Chris@0 54 self.name = "cf_#{custom_field.id}".to_sym
Chris@0 55 self.sortable = custom_field.order_statement || false
Chris@0 56 if %w(list date bool int).include?(custom_field.field_format)
Chris@0 57 self.groupable = custom_field.order_statement
Chris@0 58 end
Chris@0 59 self.groupable ||= false
Chris@0 60 @cf = custom_field
Chris@0 61 end
Chris@441 62
Chris@0 63 def caption
Chris@0 64 @cf.name
Chris@0 65 end
Chris@441 66
Chris@0 67 def custom_field
Chris@0 68 @cf
Chris@0 69 end
Chris@441 70
Chris@0 71 def value(issue)
Chris@0 72 cv = issue.custom_values.detect {|v| v.custom_field_id == @cf.id}
Chris@0 73 cv && @cf.cast_value(cv.value)
Chris@0 74 end
Chris@441 75
Chris@441 76 def css_classes
Chris@441 77 @css_classes ||= "#{name} #{@cf.field_format}"
Chris@441 78 end
Chris@0 79 end
Chris@0 80
Chris@0 81 class Query < ActiveRecord::Base
Chris@0 82 class StatementInvalid < ::ActiveRecord::StatementInvalid
Chris@0 83 end
Chris@441 84
Chris@0 85 belongs_to :project
Chris@0 86 belongs_to :user
Chris@0 87 serialize :filters
Chris@0 88 serialize :column_names
Chris@0 89 serialize :sort_criteria, Array
Chris@441 90
Chris@0 91 attr_protected :project_id, :user_id
Chris@441 92
Chris@0 93 validates_presence_of :name, :on => :save
Chris@0 94 validates_length_of :name, :maximum => 255
Chris@441 95
Chris@441 96 @@operators = { "=" => :label_equals,
Chris@0 97 "!" => :label_not_equals,
Chris@0 98 "o" => :label_open_issues,
Chris@0 99 "c" => :label_closed_issues,
Chris@0 100 "!*" => :label_none,
Chris@0 101 "*" => :label_all,
Chris@0 102 ">=" => :label_greater_or_equal,
Chris@0 103 "<=" => :label_less_or_equal,
Chris@0 104 "<t+" => :label_in_less_than,
Chris@0 105 ">t+" => :label_in_more_than,
Chris@0 106 "t+" => :label_in,
Chris@0 107 "t" => :label_today,
Chris@0 108 "w" => :label_this_week,
Chris@0 109 ">t-" => :label_less_than_ago,
Chris@0 110 "<t-" => :label_more_than_ago,
Chris@0 111 "t-" => :label_ago,
Chris@0 112 "~" => :label_contains,
Chris@0 113 "!~" => :label_not_contains }
Chris@0 114
Chris@0 115 cattr_reader :operators
Chris@441 116
Chris@0 117 @@operators_by_filter_type = { :list => [ "=", "!" ],
Chris@0 118 :list_status => [ "o", "=", "!", "c", "*" ],
Chris@0 119 :list_optional => [ "=", "!", "!*", "*" ],
Chris@0 120 :list_subprojects => [ "*", "!*", "=" ],
Chris@0 121 :date => [ "<t+", ">t+", "t+", "t", "w", ">t-", "<t-", "t-" ],
Chris@0 122 :date_past => [ ">t-", "<t-", "t-", "t", "w" ],
Chris@0 123 :string => [ "=", "~", "!", "!~" ],
Chris@0 124 :text => [ "~", "!~" ],
Chris@0 125 :integer => [ "=", ">=", "<=", "!*", "*" ] }
Chris@0 126
Chris@0 127 cattr_reader :operators_by_filter_type
Chris@0 128
Chris@0 129 @@available_columns = [
Chris@0 130 QueryColumn.new(:project, :sortable => "#{Project.table_name}.name", :groupable => true),
Chris@0 131 QueryColumn.new(:tracker, :sortable => "#{Tracker.table_name}.position", :groupable => true),
Chris@0 132 QueryColumn.new(:parent, :sortable => ["#{Issue.table_name}.root_id", "#{Issue.table_name}.lft ASC"], :default_order => 'desc', :caption => :field_parent_issue),
Chris@0 133 QueryColumn.new(:status, :sortable => "#{IssueStatus.table_name}.position", :groupable => true),
Chris@0 134 QueryColumn.new(:priority, :sortable => "#{IssuePriority.table_name}.position", :default_order => 'desc', :groupable => true),
Chris@0 135 QueryColumn.new(:subject, :sortable => "#{Issue.table_name}.subject"),
Chris@0 136 QueryColumn.new(:author),
Chris@0 137 QueryColumn.new(:assigned_to, :sortable => ["#{User.table_name}.lastname", "#{User.table_name}.firstname", "#{User.table_name}.id"], :groupable => true),
Chris@0 138 QueryColumn.new(:updated_on, :sortable => "#{Issue.table_name}.updated_on", :default_order => 'desc'),
Chris@0 139 QueryColumn.new(:category, :sortable => "#{IssueCategory.table_name}.name", :groupable => true),
Chris@0 140 QueryColumn.new(:fixed_version, :sortable => ["#{Version.table_name}.effective_date", "#{Version.table_name}.name"], :default_order => 'desc', :groupable => true),
Chris@0 141 QueryColumn.new(:start_date, :sortable => "#{Issue.table_name}.start_date"),
Chris@0 142 QueryColumn.new(:due_date, :sortable => "#{Issue.table_name}.due_date"),
Chris@0 143 QueryColumn.new(:estimated_hours, :sortable => "#{Issue.table_name}.estimated_hours"),
Chris@0 144 QueryColumn.new(:done_ratio, :sortable => "#{Issue.table_name}.done_ratio", :groupable => true),
Chris@0 145 QueryColumn.new(:created_on, :sortable => "#{Issue.table_name}.created_on", :default_order => 'desc'),
Chris@0 146 ]
Chris@0 147 cattr_reader :available_columns
Chris@441 148
Chris@0 149 def initialize(attributes = nil)
Chris@0 150 super attributes
Chris@0 151 self.filters ||= { 'status_id' => {:operator => "o", :values => [""]} }
Chris@0 152 end
Chris@441 153
Chris@0 154 def after_initialize
Chris@0 155 # Store the fact that project is nil (used in #editable_by?)
Chris@0 156 @is_for_all = project.nil?
Chris@0 157 end
Chris@441 158
Chris@0 159 def validate
Chris@0 160 filters.each_key do |field|
Chris@441 161 errors.add label_for(field), :blank unless
Chris@0 162 # filter requires one or more values
Chris@441 163 (values_for(field) and !values_for(field).first.blank?) or
Chris@0 164 # filter doesn't require any value
Chris@0 165 ["o", "c", "!*", "*", "t", "w"].include? operator_for(field)
Chris@0 166 end if filters
Chris@0 167 end
Chris@441 168
Chris@0 169 def editable_by?(user)
Chris@0 170 return false unless user
Chris@0 171 # Admin can edit them all and regular users can edit their private queries
Chris@0 172 return true if user.admin? || (!is_public && self.user_id == user.id)
Chris@0 173 # Members can not edit public queries that are for all project (only admin is allowed to)
Chris@0 174 is_public && !@is_for_all && user.allowed_to?(:manage_public_queries, project)
Chris@0 175 end
Chris@441 176
Chris@0 177 def available_filters
Chris@0 178 return @available_filters if @available_filters
Chris@441 179
Chris@0 180 trackers = project.nil? ? Tracker.find(:all, :order => 'position') : project.rolled_up_trackers
Chris@441 181
Chris@441 182 @available_filters = { "status_id" => { :type => :list_status, :order => 1, :values => IssueStatus.find(:all, :order => 'position').collect{|s| [s.name, s.id.to_s] } },
Chris@441 183 "tracker_id" => { :type => :list, :order => 2, :values => trackers.collect{|s| [s.name, s.id.to_s] } },
Chris@0 184 "priority_id" => { :type => :list, :order => 3, :values => IssuePriority.all.collect{|s| [s.name, s.id.to_s] } },
Chris@441 185 "subject" => { :type => :text, :order => 8 },
Chris@441 186 "created_on" => { :type => :date_past, :order => 9 },
Chris@0 187 "updated_on" => { :type => :date_past, :order => 10 },
Chris@0 188 "start_date" => { :type => :date, :order => 11 },
Chris@0 189 "due_date" => { :type => :date, :order => 12 },
Chris@0 190 "estimated_hours" => { :type => :integer, :order => 13 },
Chris@0 191 "done_ratio" => { :type => :integer, :order => 14 }}
Chris@441 192
Chris@0 193 user_values = []
Chris@0 194 user_values << ["<< #{l(:label_me)} >>", "me"] if User.current.logged?
Chris@0 195 if project
Chris@0 196 user_values += project.users.sort.collect{|s| [s.name, s.id.to_s] }
Chris@0 197 else
Chris@119 198 all_projects = Project.visible.all
Chris@119 199 if all_projects.any?
Chris@119 200 # members of visible projects
Chris@119 201 user_values += User.active.find(:all, :conditions => ["#{User.table_name}.id IN (SELECT DISTINCT user_id FROM members WHERE project_id IN (?))", all_projects.collect(&:id)]).sort.collect{|s| [s.name, s.id.to_s] }
Chris@441 202
Chris@119 203 # project filter
Chris@119 204 project_values = []
Chris@119 205 Project.project_tree(all_projects) do |p, level|
Chris@119 206 prefix = (level > 0 ? ('--' * level + ' ') : '')
Chris@119 207 project_values << ["#{prefix}#{p.name}", p.id.to_s]
Chris@119 208 end
Chris@119 209 @available_filters["project_id"] = { :type => :list, :order => 1, :values => project_values} unless project_values.empty?
Chris@0 210 end
Chris@0 211 end
Chris@0 212 @available_filters["assigned_to_id"] = { :type => :list_optional, :order => 4, :values => user_values } unless user_values.empty?
Chris@0 213 @available_filters["author_id"] = { :type => :list, :order => 5, :values => user_values } unless user_values.empty?
chris@22 214
chris@37 215 group_values = Group.all.collect {|g| [g.name, g.id.to_s] }
chris@22 216 @available_filters["member_of_group"] = { :type => :list_optional, :order => 6, :values => group_values } unless group_values.empty?
chris@22 217
chris@37 218 role_values = Role.givable.collect {|r| [r.name, r.id.to_s] }
chris@22 219 @available_filters["assigned_to_role"] = { :type => :list_optional, :order => 7, :values => role_values } unless role_values.empty?
Chris@441 220
Chris@0 221 if User.current.logged?
Chris@0 222 @available_filters["watcher_id"] = { :type => :list, :order => 15, :values => [["<< #{l(:label_me)} >>", "me"]] }
Chris@0 223 end
Chris@441 224
Chris@0 225 if project
Chris@0 226 # project specific filters
Chris@441 227 categories = @project.issue_categories.all
Chris@441 228 unless categories.empty?
Chris@441 229 @available_filters["category_id"] = { :type => :list_optional, :order => 6, :values => categories.collect{|s| [s.name, s.id.to_s] } }
Chris@0 230 end
Chris@441 231 versions = @project.shared_versions.all
Chris@441 232 unless versions.empty?
Chris@441 233 @available_filters["fixed_version_id"] = { :type => :list_optional, :order => 7, :values => versions.sort.collect{|s| ["#{s.project.name} - #{s.name}", s.id.to_s] } }
Chris@0 234 end
Chris@441 235 unless @project.leaf?
Chris@441 236 subprojects = @project.descendants.visible.all
Chris@441 237 unless subprojects.empty?
Chris@441 238 @available_filters["subproject_id"] = { :type => :list_subprojects, :order => 13, :values => subprojects.collect{|s| [s.name, s.id.to_s] } }
Chris@441 239 end
Chris@0 240 end
Chris@0 241 add_custom_fields_filters(@project.all_issue_custom_fields)
Chris@0 242 else
Chris@0 243 # global filters for cross project issue list
Chris@0 244 system_shared_versions = Version.visible.find_all_by_sharing('system')
Chris@0 245 unless system_shared_versions.empty?
Chris@0 246 @available_filters["fixed_version_id"] = { :type => :list_optional, :order => 7, :values => system_shared_versions.sort.collect{|s| ["#{s.project.name} - #{s.name}", s.id.to_s] } }
Chris@0 247 end
Chris@0 248 add_custom_fields_filters(IssueCustomField.find(:all, :conditions => {:is_filter => true, :is_for_all => true}))
Chris@0 249 end
Chris@0 250 @available_filters
Chris@0 251 end
Chris@441 252
Chris@0 253 def add_filter(field, operator, values)
Chris@0 254 # values must be an array
Chris@0 255 return unless values and values.is_a? Array # and !values.first.empty?
Chris@0 256 # check if field is defined as an available filter
Chris@0 257 if available_filters.has_key? field
Chris@0 258 filter_options = available_filters[field]
Chris@0 259 # check if operator is allowed for that filter
Chris@0 260 #if @@operators_by_filter_type[filter_options[:type]].include? operator
Chris@0 261 # allowed_values = values & ([""] + (filter_options[:values] || []).collect {|val| val[1]})
Chris@0 262 # filters[field] = {:operator => operator, :values => allowed_values } if (allowed_values.first and !allowed_values.first.empty?) or ["o", "c", "!*", "*", "t"].include? operator
Chris@0 263 #end
Chris@0 264 filters[field] = {:operator => operator, :values => values }
Chris@0 265 end
Chris@0 266 end
Chris@441 267
Chris@0 268 def add_short_filter(field, expression)
Chris@0 269 return unless expression
Chris@0 270 parms = expression.scan(/^(o|c|!\*|!|\*)?(.*)$/).first
Chris@0 271 add_filter field, (parms[0] || "="), [parms[1] || ""]
Chris@0 272 end
Chris@0 273
Chris@0 274 # Add multiple filters using +add_filter+
Chris@0 275 def add_filters(fields, operators, values)
chris@37 276 if fields.is_a?(Array) && operators.is_a?(Hash) && values.is_a?(Hash)
chris@37 277 fields.each do |field|
chris@37 278 add_filter(field, operators[field], values[field])
chris@37 279 end
Chris@0 280 end
Chris@0 281 end
Chris@441 282
Chris@0 283 def has_filter?(field)
Chris@0 284 filters and filters[field]
Chris@0 285 end
Chris@441 286
Chris@0 287 def operator_for(field)
Chris@0 288 has_filter?(field) ? filters[field][:operator] : nil
Chris@0 289 end
Chris@441 290
Chris@0 291 def values_for(field)
Chris@0 292 has_filter?(field) ? filters[field][:values] : nil
Chris@0 293 end
Chris@441 294
Chris@0 295 def label_for(field)
Chris@0 296 label = available_filters[field][:name] if available_filters.has_key?(field)
Chris@0 297 label ||= field.gsub(/\_id$/, "")
Chris@0 298 end
Chris@0 299
Chris@0 300 def available_columns
Chris@0 301 return @available_columns if @available_columns
Chris@0 302 @available_columns = Query.available_columns
Chris@0 303 @available_columns += (project ?
Chris@0 304 project.all_issue_custom_fields :
Chris@0 305 IssueCustomField.find(:all)
Chris@441 306 ).collect {|cf| QueryCustomFieldColumn.new(cf) }
Chris@0 307 end
Chris@0 308
Chris@0 309 def self.available_columns=(v)
Chris@0 310 self.available_columns = (v)
Chris@0 311 end
Chris@441 312
Chris@0 313 def self.add_available_column(column)
Chris@0 314 self.available_columns << (column) if column.is_a?(QueryColumn)
Chris@0 315 end
Chris@441 316
Chris@0 317 # Returns an array of columns that can be used to group the results
Chris@0 318 def groupable_columns
Chris@0 319 available_columns.select {|c| c.groupable}
Chris@0 320 end
Chris@0 321
Chris@0 322 # Returns a Hash of columns and the key for sorting
Chris@0 323 def sortable_columns
Chris@0 324 {'id' => "#{Issue.table_name}.id"}.merge(available_columns.inject({}) {|h, column|
Chris@0 325 h[column.name.to_s] = column.sortable
Chris@0 326 h
Chris@0 327 })
Chris@0 328 end
Chris@441 329
Chris@0 330 def columns
Chris@0 331 if has_default_columns?
Chris@0 332 available_columns.select do |c|
Chris@0 333 # Adds the project column by default for cross-project lists
Chris@0 334 Setting.issue_list_default_columns.include?(c.name.to_s) || (c.name == :project && project.nil?)
Chris@0 335 end
Chris@0 336 else
Chris@0 337 # preserve the column_names order
Chris@0 338 column_names.collect {|name| available_columns.find {|col| col.name == name}}.compact
Chris@0 339 end
Chris@0 340 end
Chris@441 341
Chris@0 342 def column_names=(names)
Chris@0 343 if names
Chris@0 344 names = names.select {|n| n.is_a?(Symbol) || !n.blank? }
Chris@0 345 names = names.collect {|n| n.is_a?(Symbol) ? n : n.to_sym }
Chris@0 346 # Set column_names to nil if default columns
Chris@0 347 if names.map(&:to_s) == Setting.issue_list_default_columns
Chris@0 348 names = nil
Chris@0 349 end
Chris@0 350 end
Chris@0 351 write_attribute(:column_names, names)
Chris@0 352 end
Chris@441 353
Chris@0 354 def has_column?(column)
Chris@0 355 column_names && column_names.include?(column.name)
Chris@0 356 end
Chris@441 357
Chris@0 358 def has_default_columns?
Chris@0 359 column_names.nil? || column_names.empty?
Chris@0 360 end
Chris@441 361
Chris@0 362 def sort_criteria=(arg)
Chris@0 363 c = []
Chris@0 364 if arg.is_a?(Hash)
Chris@0 365 arg = arg.keys.sort.collect {|k| arg[k]}
Chris@0 366 end
Chris@0 367 c = arg.select {|k,o| !k.to_s.blank?}.slice(0,3).collect {|k,o| [k.to_s, o == 'desc' ? o : 'asc']}
Chris@0 368 write_attribute(:sort_criteria, c)
Chris@0 369 end
Chris@441 370
Chris@0 371 def sort_criteria
Chris@0 372 read_attribute(:sort_criteria) || []
Chris@0 373 end
Chris@441 374
Chris@0 375 def sort_criteria_key(arg)
Chris@0 376 sort_criteria && sort_criteria[arg] && sort_criteria[arg].first
Chris@0 377 end
Chris@441 378
Chris@0 379 def sort_criteria_order(arg)
Chris@0 380 sort_criteria && sort_criteria[arg] && sort_criteria[arg].last
Chris@0 381 end
Chris@441 382
Chris@0 383 # Returns the SQL sort order that should be prepended for grouping
Chris@0 384 def group_by_sort_order
Chris@0 385 if grouped? && (column = group_by_column)
Chris@0 386 column.sortable.is_a?(Array) ?
Chris@0 387 column.sortable.collect {|s| "#{s} #{column.default_order}"}.join(',') :
Chris@0 388 "#{column.sortable} #{column.default_order}"
Chris@0 389 end
Chris@0 390 end
Chris@441 391
Chris@0 392 # Returns true if the query is a grouped query
Chris@0 393 def grouped?
Chris@119 394 !group_by_column.nil?
Chris@0 395 end
Chris@441 396
Chris@0 397 def group_by_column
Chris@119 398 groupable_columns.detect {|c| c.groupable && c.name.to_s == group_by}
Chris@0 399 end
Chris@441 400
Chris@0 401 def group_by_statement
Chris@119 402 group_by_column.try(:groupable)
Chris@0 403 end
Chris@441 404
Chris@0 405 def project_statement
Chris@0 406 project_clauses = []
Chris@0 407 if project && !@project.descendants.active.empty?
Chris@0 408 ids = [project.id]
Chris@0 409 if has_filter?("subproject_id")
Chris@0 410 case operator_for("subproject_id")
Chris@0 411 when '='
Chris@0 412 # include the selected subprojects
Chris@0 413 ids += values_for("subproject_id").each(&:to_i)
Chris@0 414 when '!*'
Chris@0 415 # main project only
Chris@0 416 else
Chris@0 417 # all subprojects
Chris@0 418 ids += project.descendants.collect(&:id)
Chris@0 419 end
Chris@0 420 elsif Setting.display_subprojects_issues?
Chris@0 421 ids += project.descendants.collect(&:id)
Chris@0 422 end
Chris@0 423 project_clauses << "#{Project.table_name}.id IN (%s)" % ids.join(',')
Chris@0 424 elsif project
Chris@0 425 project_clauses << "#{Project.table_name}.id = %d" % project.id
Chris@0 426 end
Chris@441 427 project_clauses.any? ? project_clauses.join(' AND ') : nil
Chris@0 428 end
Chris@0 429
Chris@0 430 def statement
Chris@0 431 # filters clauses
Chris@0 432 filters_clauses = []
Chris@0 433 filters.each_key do |field|
Chris@0 434 next if field == "subproject_id"
Chris@0 435 v = values_for(field).clone
Chris@0 436 next unless v and !v.empty?
Chris@0 437 operator = operator_for(field)
Chris@441 438
Chris@0 439 # "me" value subsitution
Chris@0 440 if %w(assigned_to_id author_id watcher_id).include?(field)
Chris@0 441 v.push(User.current.logged? ? User.current.id.to_s : "0") if v.delete("me")
Chris@0 442 end
Chris@441 443
Chris@0 444 sql = ''
Chris@0 445 if field =~ /^cf_(\d+)$/
Chris@0 446 # custom field
Chris@0 447 db_table = CustomValue.table_name
Chris@0 448 db_field = 'value'
Chris@0 449 is_custom_filter = true
Chris@0 450 sql << "#{Issue.table_name}.id IN (SELECT #{Issue.table_name}.id FROM #{Issue.table_name} LEFT OUTER JOIN #{db_table} ON #{db_table}.customized_type='Issue' AND #{db_table}.customized_id=#{Issue.table_name}.id AND #{db_table}.custom_field_id=#{$1} WHERE "
Chris@0 451 sql << sql_for_field(field, operator, v, db_table, db_field, true) + ')'
Chris@0 452 elsif field == 'watcher_id'
Chris@0 453 db_table = Watcher.table_name
Chris@0 454 db_field = 'user_id'
Chris@0 455 sql << "#{Issue.table_name}.id #{ operator == '=' ? 'IN' : 'NOT IN' } (SELECT #{db_table}.watchable_id FROM #{db_table} WHERE #{db_table}.watchable_type='Issue' AND "
Chris@0 456 sql << sql_for_field(field, '=', v, db_table, db_field) + ')'
chris@22 457 elsif field == "member_of_group" # named field
chris@22 458 if operator == '*' # Any group
chris@22 459 groups = Group.all
chris@22 460 operator = '=' # Override the operator since we want to find by assigned_to
chris@22 461 elsif operator == "!*"
chris@22 462 groups = Group.all
chris@22 463 operator = '!' # Override the operator since we want to find by assigned_to
chris@22 464 else
chris@22 465 groups = Group.find_all_by_id(v)
chris@22 466 end
chris@22 467 groups ||= []
chris@22 468
chris@22 469 members_of_groups = groups.inject([]) {|user_ids, group|
chris@22 470 if group && group.user_ids.present?
chris@22 471 user_ids << group.user_ids
chris@22 472 end
chris@22 473 user_ids.flatten.uniq.compact
chris@22 474 }.sort.collect(&:to_s)
Chris@441 475
chris@22 476 sql << '(' + sql_for_field("assigned_to_id", operator, members_of_groups, Issue.table_name, "assigned_to_id", false) + ')'
chris@22 477
chris@22 478 elsif field == "assigned_to_role" # named field
chris@22 479 if operator == "*" # Any Role
chris@22 480 roles = Role.givable
chris@22 481 operator = '=' # Override the operator since we want to find by assigned_to
chris@22 482 elsif operator == "!*" # No role
chris@22 483 roles = Role.givable
chris@22 484 operator = '!' # Override the operator since we want to find by assigned_to
chris@22 485 else
chris@22 486 roles = Role.givable.find_all_by_id(v)
chris@22 487 end
chris@22 488 roles ||= []
Chris@441 489
chris@22 490 members_of_roles = roles.inject([]) {|user_ids, role|
chris@22 491 if role && role.members
chris@22 492 user_ids << role.members.collect(&:user_id)
chris@22 493 end
chris@22 494 user_ids.flatten.uniq.compact
chris@22 495 }.sort.collect(&:to_s)
Chris@441 496
chris@22 497 sql << '(' + sql_for_field("assigned_to_id", operator, members_of_roles, Issue.table_name, "assigned_to_id", false) + ')'
Chris@0 498 else
Chris@0 499 # regular field
Chris@0 500 db_table = Issue.table_name
Chris@0 501 db_field = field
Chris@0 502 sql << '(' + sql_for_field(field, operator, v, db_table, db_field) + ')'
Chris@0 503 end
Chris@0 504 filters_clauses << sql
Chris@441 505
Chris@0 506 end if filters and valid?
Chris@441 507
Chris@441 508 filters_clauses << project_statement
Chris@441 509 filters_clauses.reject!(&:blank?)
Chris@441 510
Chris@441 511 filters_clauses.any? ? filters_clauses.join(' AND ') : nil
Chris@0 512 end
Chris@441 513
Chris@0 514 # Returns the issue count
Chris@0 515 def issue_count
Chris@0 516 Issue.count(:include => [:status, :project], :conditions => statement)
Chris@0 517 rescue ::ActiveRecord::StatementInvalid => e
Chris@0 518 raise StatementInvalid.new(e.message)
Chris@0 519 end
Chris@441 520
Chris@0 521 # Returns the issue count by group or nil if query is not grouped
Chris@0 522 def issue_count_by_group
Chris@0 523 r = nil
Chris@0 524 if grouped?
Chris@0 525 begin
Chris@0 526 # Rails will raise an (unexpected) RecordNotFound if there's only a nil group value
Chris@441 527 r = Issue.visible.count(:group => group_by_statement, :include => [:status, :project], :conditions => statement)
Chris@0 528 rescue ActiveRecord::RecordNotFound
Chris@0 529 r = {nil => issue_count}
Chris@0 530 end
Chris@0 531 c = group_by_column
Chris@0 532 if c.is_a?(QueryCustomFieldColumn)
Chris@0 533 r = r.keys.inject({}) {|h, k| h[c.custom_field.cast_value(k)] = r[k]; h}
Chris@0 534 end
Chris@0 535 end
Chris@0 536 r
Chris@0 537 rescue ::ActiveRecord::StatementInvalid => e
Chris@0 538 raise StatementInvalid.new(e.message)
Chris@0 539 end
Chris@441 540
Chris@0 541 # Returns the issues
Chris@0 542 # Valid options are :order, :offset, :limit, :include, :conditions
Chris@0 543 def issues(options={})
Chris@0 544 order_option = [group_by_sort_order, options[:order]].reject {|s| s.blank?}.join(',')
Chris@0 545 order_option = nil if order_option.blank?
Chris@441 546
Chris@441 547 Issue.visible.find :all, :include => ([:status, :project] + (options[:include] || [])).uniq,
Chris@0 548 :conditions => Query.merge_conditions(statement, options[:conditions]),
Chris@0 549 :order => order_option,
Chris@0 550 :limit => options[:limit],
Chris@0 551 :offset => options[:offset]
Chris@0 552 rescue ::ActiveRecord::StatementInvalid => e
Chris@0 553 raise StatementInvalid.new(e.message)
Chris@0 554 end
Chris@0 555
Chris@0 556 # Returns the journals
Chris@0 557 # Valid options are :order, :offset, :limit
Chris@0 558 def journals(options={})
Chris@441 559 Journal.visible.find :all, :include => [:details, :user, {:issue => [:project, :author, :tracker, :status]}],
Chris@0 560 :conditions => statement,
Chris@0 561 :order => options[:order],
Chris@0 562 :limit => options[:limit],
Chris@0 563 :offset => options[:offset]
Chris@0 564 rescue ::ActiveRecord::StatementInvalid => e
Chris@0 565 raise StatementInvalid.new(e.message)
Chris@0 566 end
Chris@441 567
Chris@0 568 # Returns the versions
Chris@0 569 # Valid options are :conditions
Chris@0 570 def versions(options={})
Chris@441 571 Version.visible.find :all, :include => :project,
Chris@0 572 :conditions => Query.merge_conditions(project_statement, options[:conditions])
Chris@0 573 rescue ::ActiveRecord::StatementInvalid => e
Chris@0 574 raise StatementInvalid.new(e.message)
Chris@0 575 end
Chris@441 576
Chris@0 577 private
Chris@441 578
Chris@0 579 # Helper method to generate the WHERE sql for a +field+, +operator+ and a +value+
Chris@0 580 def sql_for_field(field, operator, value, db_table, db_field, is_custom_filter=false)
Chris@0 581 sql = ''
Chris@0 582 case operator
Chris@0 583 when "="
Chris@245 584 if value.any?
Chris@245 585 sql = "#{db_table}.#{db_field} IN (" + value.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + ")"
Chris@245 586 else
Chris@245 587 # IN an empty set
Chris@245 588 sql = "1=0"
Chris@245 589 end
Chris@0 590 when "!"
Chris@245 591 if value.any?
Chris@245 592 sql = "(#{db_table}.#{db_field} IS NULL OR #{db_table}.#{db_field} NOT IN (" + value.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + "))"
Chris@245 593 else
Chris@245 594 # NOT IN an empty set
Chris@245 595 sql = "1=1"
Chris@245 596 end
Chris@0 597 when "!*"
Chris@0 598 sql = "#{db_table}.#{db_field} IS NULL"
Chris@0 599 sql << " OR #{db_table}.#{db_field} = ''" if is_custom_filter
Chris@0 600 when "*"
Chris@0 601 sql = "#{db_table}.#{db_field} IS NOT NULL"
Chris@0 602 sql << " AND #{db_table}.#{db_field} <> ''" if is_custom_filter
Chris@0 603 when ">="
Chris@0 604 sql = "#{db_table}.#{db_field} >= #{value.first.to_i}"
Chris@0 605 when "<="
Chris@0 606 sql = "#{db_table}.#{db_field} <= #{value.first.to_i}"
Chris@0 607 when "o"
Chris@0 608 sql = "#{IssueStatus.table_name}.is_closed=#{connection.quoted_false}" if field == "status_id"
Chris@0 609 when "c"
Chris@0 610 sql = "#{IssueStatus.table_name}.is_closed=#{connection.quoted_true}" if field == "status_id"
Chris@0 611 when ">t-"
Chris@0 612 sql = date_range_clause(db_table, db_field, - value.first.to_i, 0)
Chris@0 613 when "<t-"
Chris@0 614 sql = date_range_clause(db_table, db_field, nil, - value.first.to_i)
Chris@0 615 when "t-"
Chris@0 616 sql = date_range_clause(db_table, db_field, - value.first.to_i, - value.first.to_i)
Chris@0 617 when ">t+"
Chris@0 618 sql = date_range_clause(db_table, db_field, value.first.to_i, nil)
Chris@0 619 when "<t+"
Chris@0 620 sql = date_range_clause(db_table, db_field, 0, value.first.to_i)
Chris@0 621 when "t+"
Chris@0 622 sql = date_range_clause(db_table, db_field, value.first.to_i, value.first.to_i)
Chris@0 623 when "t"
Chris@0 624 sql = date_range_clause(db_table, db_field, 0, 0)
Chris@0 625 when "w"
Chris@441 626 first_day_of_week = l(:general_first_day_of_week).to_i
Chris@441 627 day_of_week = Date.today.cwday
Chris@441 628 days_ago = (day_of_week >= first_day_of_week ? day_of_week - first_day_of_week : day_of_week + 7 - first_day_of_week)
Chris@441 629 sql = date_range_clause(db_table, db_field, - days_ago, - days_ago + 6)
Chris@0 630 when "~"
Chris@0 631 sql = "LOWER(#{db_table}.#{db_field}) LIKE '%#{connection.quote_string(value.first.to_s.downcase)}%'"
Chris@0 632 when "!~"
Chris@0 633 sql = "LOWER(#{db_table}.#{db_field}) NOT LIKE '%#{connection.quote_string(value.first.to_s.downcase)}%'"
Chris@0 634 end
Chris@441 635
Chris@0 636 return sql
Chris@0 637 end
Chris@441 638
Chris@0 639 def add_custom_fields_filters(custom_fields)
Chris@0 640 @available_filters ||= {}
Chris@441 641
Chris@0 642 custom_fields.select(&:is_filter?).each do |field|
Chris@0 643 case field.field_format
Chris@0 644 when "text"
Chris@0 645 options = { :type => :text, :order => 20 }
Chris@0 646 when "list"
Chris@0 647 options = { :type => :list_optional, :values => field.possible_values, :order => 20}
Chris@0 648 when "date"
Chris@0 649 options = { :type => :date, :order => 20 }
Chris@0 650 when "bool"
Chris@0 651 options = { :type => :list, :values => [[l(:general_text_yes), "1"], [l(:general_text_no), "0"]], :order => 20 }
Chris@441 652 when "user", "version"
Chris@441 653 next unless project
Chris@441 654 options = { :type => :list_optional, :values => field.possible_values_options(project), :order => 20}
Chris@0 655 else
Chris@0 656 options = { :type => :string, :order => 20 }
Chris@0 657 end
Chris@0 658 @available_filters["cf_#{field.id}"] = options.merge({ :name => field.name })
Chris@0 659 end
Chris@0 660 end
Chris@441 661
Chris@0 662 # Returns a SQL clause for a date or datetime field.
Chris@0 663 def date_range_clause(table, field, from, to)
Chris@0 664 s = []
Chris@0 665 if from
Chris@0 666 s << ("#{table}.#{field} > '%s'" % [connection.quoted_date((Date.yesterday + from).to_time.end_of_day)])
Chris@0 667 end
Chris@0 668 if to
Chris@0 669 s << ("#{table}.#{field} <= '%s'" % [connection.quoted_date((Date.today + to).to_time.end_of_day)])
Chris@0 670 end
Chris@0 671 s.join(' AND ')
Chris@0 672 end
Chris@0 673 end