annotate .svn/pristine/a3/a39dfd4bdc71ffef44da946a57f879f5baad33bc.svn-base @ 1295:622f24f53b42 redmine-2.3

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