annotate .svn/pristine/2c/2c2981c9fdf45fa7fce93a5afc05807f4372fb62.svn-base @ 1524:82fac3dcf466 redmine-2.5-integration

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