##// END OF EJS Templates
jro_apps » redmine
RSS
Refactor: Extracted new method Query#sql_for_field from Query#statement in...
Eric Davis -
r2088:ea77929d62a3
parent child
Show More
Side by Side Unified
Context file:
r2088:ea77929d62a3 Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,397 +1,406
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2008 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 class QueryColumn
19 19 attr_accessor :name, :sortable, :default_order
20 20 include GLoc
21 21
22 22 def initialize(name, options={})
23 23 self.name = name
24 24 self.sortable = options[:sortable]
25 25 self.default_order = options[:default_order]
26 26 end
27 27
28 28 def caption
29 29 set_language_if_valid(User.current.language)
30 30 l("field_#{name}")
31 31 end
32 32 end
33 33
34 34 class QueryCustomFieldColumn < QueryColumn
35 35
36 36 def initialize(custom_field)
37 37 self.name = "cf_#{custom_field.id}".to_sym
38 38 self.sortable = false
39 39 @cf = custom_field
40 40 end
41 41
42 42 def caption
43 43 @cf.name
44 44 end
45 45
46 46 def custom_field
47 47 @cf
48 48 end
49 49 end
50 50
51 51 class Query < ActiveRecord::Base
52 52 belongs_to :project
53 53 belongs_to :user
54 54 serialize :filters
55 55 serialize :column_names
56 56
57 57 attr_protected :project_id, :user_id
58 58
59 59 validates_presence_of :name, :on => :save
60 60 validates_length_of :name, :maximum => 255
61 61
62 62 @@operators = { "=" => :label_equals,
63 63 "!" => :label_not_equals,
64 64 "o" => :label_open_issues,
65 65 "c" => :label_closed_issues,
66 66 "!*" => :label_none,
67 67 "*" => :label_all,
68 68 ">=" => '>=',
69 69 "<=" => '<=',
70 70 "<t+" => :label_in_less_than,
71 71 ">t+" => :label_in_more_than,
72 72 "t+" => :label_in,
73 73 "t" => :label_today,
74 74 "w" => :label_this_week,
75 75 ">t-" => :label_less_than_ago,
76 76 "<t-" => :label_more_than_ago,
77 77 "t-" => :label_ago,
78 78 "~" => :label_contains,
79 79 "!~" => :label_not_contains }
80 80
81 81 cattr_reader :operators
82 82
83 83 @@operators_by_filter_type = { :list => [ "=", "!" ],
84 84 :list_status => [ "o", "=", "!", "c", "*" ],
85 85 :list_optional => [ "=", "!", "!*", "*" ],
86 86 :list_subprojects => [ "*", "!*", "=" ],
87 87 :date => [ "<t+", ">t+", "t+", "t", "w", ">t-", "<t-", "t-" ],
88 88 :date_past => [ ">t-", "<t-", "t-", "t", "w" ],
89 89 :string => [ "=", "~", "!", "!~" ],
90 90 :text => [ "~", "!~" ],
91 91 :integer => [ "=", ">=", "<=", "!*", "*" ] }
92 92
93 93 cattr_reader :operators_by_filter_type
94 94
95 95 @@available_columns = [
96 96 QueryColumn.new(:tracker, :sortable => "#{Tracker.table_name}.position"),
97 97 QueryColumn.new(:status, :sortable => "#{IssueStatus.table_name}.position"),
98 98 QueryColumn.new(:priority, :sortable => "#{Enumeration.table_name}.position", :default_order => 'desc'),
99 99 QueryColumn.new(:subject, :sortable => "#{Issue.table_name}.subject"),
100 100 QueryColumn.new(:author),
101 101 QueryColumn.new(:assigned_to, :sortable => "#{User.table_name}.lastname"),
102 102 QueryColumn.new(:updated_on, :sortable => "#{Issue.table_name}.updated_on", :default_order => 'desc'),
103 103 QueryColumn.new(:category, :sortable => "#{IssueCategory.table_name}.name"),
104 104 QueryColumn.new(:fixed_version, :sortable => "#{Version.table_name}.effective_date", :default_order => 'desc'),
105 105 QueryColumn.new(:start_date, :sortable => "#{Issue.table_name}.start_date"),
106 106 QueryColumn.new(:due_date, :sortable => "#{Issue.table_name}.due_date"),
107 107 QueryColumn.new(:estimated_hours, :sortable => "#{Issue.table_name}.estimated_hours"),
108 108 QueryColumn.new(:done_ratio, :sortable => "#{Issue.table_name}.done_ratio"),
109 109 QueryColumn.new(:created_on, :sortable => "#{Issue.table_name}.created_on", :default_order => 'desc'),
110 110 ]
111 111 cattr_reader :available_columns
112 112
113 113 def initialize(attributes = nil)
114 114 super attributes
115 115 self.filters ||= { 'status_id' => {:operator => "o", :values => [""]} }
116 116 set_language_if_valid(User.current.language)
117 117 end
118 118
119 119 def after_initialize
120 120 # Store the fact that project is nil (used in #editable_by?)
121 121 @is_for_all = project.nil?
122 122 end
123 123
124 124 def validate
125 125 filters.each_key do |field|
126 126 errors.add label_for(field), :activerecord_error_blank unless
127 127 # filter requires one or more values
128 128 (values_for(field) and !values_for(field).first.blank?) or
129 129 # filter doesn't require any value
130 130 ["o", "c", "!*", "*", "t", "w"].include? operator_for(field)
131 131 end if filters
132 132 end
133 133
134 134 def editable_by?(user)
135 135 return false unless user
136 136 # Admin can edit them all and regular users can edit their private queries
137 137 return true if user.admin? || (!is_public && self.user_id == user.id)
138 138 # Members can not edit public queries that are for all project (only admin is allowed to)
139 139 is_public && !@is_for_all && user.allowed_to?(:manage_public_queries, project)
140 140 end
141 141
142 142 def available_filters
143 143 return @available_filters if @available_filters
144 144
145 145 trackers = project.nil? ? Tracker.find(:all, :order => 'position') : project.rolled_up_trackers
146 146
147 147 @available_filters = { "status_id" => { :type => :list_status, :order => 1, :values => IssueStatus.find(:all, :order => 'position').collect{|s| [s.name, s.id.to_s] } },
148 148 "tracker_id" => { :type => :list, :order => 2, :values => trackers.collect{|s| [s.name, s.id.to_s] } },
149 149 "priority_id" => { :type => :list, :order => 3, :values => Enumeration.find(:all, :conditions => ['opt=?','IPRI'], :order => 'position').collect{|s| [s.name, s.id.to_s] } },
150 150 "subject" => { :type => :text, :order => 8 },
151 151 "created_on" => { :type => :date_past, :order => 9 },
152 152 "updated_on" => { :type => :date_past, :order => 10 },
153 153 "start_date" => { :type => :date, :order => 11 },
154 154 "due_date" => { :type => :date, :order => 12 },
155 155 "estimated_hours" => { :type => :integer, :order => 13 },
156 156 "done_ratio" => { :type => :integer, :order => 14 }}
157 157
158 158 user_values = []
159 159 user_values << ["<< #{l(:label_me)} >>", "me"] if User.current.logged?
160 160 if project
161 161 user_values += project.users.sort.collect{|s| [s.name, s.id.to_s] }
162 162 else
163 163 # members of the user's projects
164 164 user_values += User.current.projects.collect(&:users).flatten.uniq.sort.collect{|s| [s.name, s.id.to_s] }
165 165 end
166 166 @available_filters["assigned_to_id"] = { :type => :list_optional, :order => 4, :values => user_values } unless user_values.empty?
167 167 @available_filters["author_id"] = { :type => :list, :order => 5, :values => user_values } unless user_values.empty?
168 168
169 169 if project
170 170 # project specific filters
171 171 unless @project.issue_categories.empty?
172 172 @available_filters["category_id"] = { :type => :list_optional, :order => 6, :values => @project.issue_categories.collect{|s| [s.name, s.id.to_s] } }
173 173 end
174 174 unless @project.versions.empty?
175 175 @available_filters["fixed_version_id"] = { :type => :list_optional, :order => 7, :values => @project.versions.sort.collect{|s| [s.name, s.id.to_s] } }
176 176 end
177 177 unless @project.active_children.empty?
178 178 @available_filters["subproject_id"] = { :type => :list_subprojects, :order => 13, :values => @project.active_children.collect{|s| [s.name, s.id.to_s] } }
179 179 end
180 180 add_custom_fields_filters(@project.all_issue_custom_fields)
181 181 else
182 182 # global filters for cross project issue list
183 183 add_custom_fields_filters(IssueCustomField.find(:all, :conditions => {:is_filter => true, :is_for_all => true}))
184 184 end
185 185 @available_filters
186 186 end
187 187
188 188 def add_filter(field, operator, values)
189 189 # values must be an array
190 190 return unless values and values.is_a? Array # and !values.first.empty?
191 191 # check if field is defined as an available filter
192 192 if available_filters.has_key? field
193 193 filter_options = available_filters[field]
194 194 # check if operator is allowed for that filter
195 195 #if @@operators_by_filter_type[filter_options[:type]].include? operator
196 196 # allowed_values = values & ([""] + (filter_options[:values] || []).collect {|val| val[1]})
197 197 # filters[field] = {:operator => operator, :values => allowed_values } if (allowed_values.first and !allowed_values.first.empty?) or ["o", "c", "!*", "*", "t"].include? operator
198 198 #end
199 199 filters[field] = {:operator => operator, :values => values }
200 200 end
201 201 end
202 202
203 203 def add_short_filter(field, expression)
204 204 return unless expression
205 205 parms = expression.scan(/^(o|c|\!|\*)?(.*)$/).first
206 206 add_filter field, (parms[0] || "="), [parms[1] || ""]
207 207 end
208 208
209 209 def has_filter?(field)
210 210 filters and filters[field]
211 211 end
212 212
213 213 def operator_for(field)
214 214 has_filter?(field) ? filters[field][:operator] : nil
215 215 end
216 216
217 217 def values_for(field)
218 218 has_filter?(field) ? filters[field][:values] : nil
219 219 end
220 220
221 221 def label_for(field)
222 222 label = available_filters[field][:name] if available_filters.has_key?(field)
223 223 label ||= field.gsub(/\_id$/, "")
224 224 end
225 225
226 226 def available_columns
227 227 return @available_columns if @available_columns
228 228 @available_columns = Query.available_columns
229 229 @available_columns += (project ?
230 230 project.all_issue_custom_fields :
231 231 IssueCustomField.find(:all, :conditions => {:is_for_all => true})
232 232 ).collect {|cf| QueryCustomFieldColumn.new(cf) }
233 233 end
234 234
235 235 def columns
236 236 if has_default_columns?
237 237 available_columns.select {|c| Setting.issue_list_default_columns.include?(c.name.to_s) }
238 238 else
239 239 # preserve the column_names order
240 240 column_names.collect {|name| available_columns.find {|col| col.name == name}}.compact
241 241 end
242 242 end
243 243
244 244 def column_names=(names)
245 245 names = names.select {|n| n.is_a?(Symbol) || !n.blank? } if names
246 246 names = names.collect {|n| n.is_a?(Symbol) ? n : n.to_sym } if names
247 247 write_attribute(:column_names, names)
248 248 end
249 249
250 250 def has_column?(column)
251 251 column_names && column_names.include?(column.name)
252 252 end
253 253
254 254 def has_default_columns?
255 255 column_names.nil? || column_names.empty?
256 256 end
257 257
258 258 def project_statement
259 259 project_clauses = []
260 260 if project && !@project.active_children.empty?
261 261 ids = [project.id]
262 262 if has_filter?("subproject_id")
263 263 case operator_for("subproject_id")
264 264 when '='
265 265 # include the selected subprojects
266 266 ids += values_for("subproject_id").each(&:to_i)
267 267 when '!*'
268 268 # main project only
269 269 else
270 270 # all subprojects
271 271 ids += project.child_ids
272 272 end
273 273 elsif Setting.display_subprojects_issues?
274 274 ids += project.child_ids
275 275 end
276 276 project_clauses << "#{Project.table_name}.id IN (%s)" % ids.join(',')
277 277 elsif project
278 278 project_clauses << "#{Project.table_name}.id = %d" % project.id
279 279 end
280 280 project_clauses << Project.allowed_to_condition(User.current, :view_issues)
281 281 project_clauses.join(' AND ')
282 282 end
283 283
284 284 def statement
285 285 # filters clauses
286 286 filters_clauses = []
287 287 filters.each_key do |field|
288 288 next if field == "subproject_id"
289 289 v = values_for(field).clone
290 290 next unless v and !v.empty?
291 291
292 292 sql = ''
293 293 is_custom_filter = false
294 294 if field =~ /^cf_(\d+)$/
295 295 # custom field
296 296 db_table = CustomValue.table_name
297 297 db_field = 'value'
298 298 is_custom_filter = true
299 299 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 "
300 300 else
301 301 # regular field
302 302 db_table = Issue.table_name
303 303 db_field = field
304 304 sql << '('
305 305 end
306 306
307 307 # "me" value subsitution
308 308 if %w(assigned_to_id author_id).include?(field)
309 309 v.push(User.current.logged? ? User.current.id.to_s : "0") if v.delete("me")
310 310 end
311 311
312 sql = sql + sql_for_field(field, v, db_table, db_field, is_custom_filter)
313
314 sql << ')'
315 filters_clauses << sql
316 end if filters and valid?
317
318 (filters_clauses << project_statement).join(' AND ')
319 end
320
321 private
322
323 # Helper method to generate the WHERE sql for a +field+ with a value (+v+)
324 def sql_for_field(field, v, db_table, db_field, is_custom_filter)
325 sql = ''
312 326 case operator_for field
313 327 when "="
314 sql = sql + "#{db_table}.#{db_field} IN (" + v.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + ")"
328 return "#{db_table}.#{db_field} IN (" + v.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + ")"
315 329 when "!"
316 sql = sql + "(#{db_table}.#{db_field} IS NULL OR #{db_table}.#{db_field} NOT IN (" + v.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + "))"
330 return "(#{db_table}.#{db_field} IS NULL OR #{db_table}.#{db_field} NOT IN (" + v.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + "))"
317 331 when "!*"
318 sql = sql + "#{db_table}.#{db_field} IS NULL"
332 sql = "#{db_table}.#{db_field} IS NULL"
319 333 sql << " OR #{db_table}.#{db_field} = ''" if is_custom_filter
334 return sql
320 335 when "*"
321 sql = sql + "#{db_table}.#{db_field} IS NOT NULL"
336 sql = "#{db_table}.#{db_field} IS NOT NULL"
322 337 sql << " AND #{db_table}.#{db_field} <> ''" if is_custom_filter
338 return sql
323 339 when ">="
324 sql = sql + "#{db_table}.#{db_field} >= #{v.first.to_i}"
340 return "#{db_table}.#{db_field} >= #{v.first.to_i}"
325 341 when "<="
326 sql = sql + "#{db_table}.#{db_field} <= #{v.first.to_i}"
342 return "#{db_table}.#{db_field} <= #{v.first.to_i}"
327 343 when "o"
328 sql = sql + "#{IssueStatus.table_name}.is_closed=#{connection.quoted_false}" if field == "status_id"
344 return "#{IssueStatus.table_name}.is_closed=#{connection.quoted_false}" if field == "status_id"
329 345 when "c"
330 sql = sql + "#{IssueStatus.table_name}.is_closed=#{connection.quoted_true}" if field == "status_id"
346 return "#{IssueStatus.table_name}.is_closed=#{connection.quoted_true}" if field == "status_id"
331 347 when ">t-"
332 sql = sql + date_range_clause(db_table, db_field, - v.first.to_i, 0)
348 return date_range_clause(db_table, db_field, - v.first.to_i, 0)
333 349 when "<t-"
334 sql = sql + date_range_clause(db_table, db_field, nil, - v.first.to_i)
350 return date_range_clause(db_table, db_field, nil, - v.first.to_i)
335 351 when "t-"
336 sql = sql + date_range_clause(db_table, db_field, - v.first.to_i, - v.first.to_i)
352 return date_range_clause(db_table, db_field, - v.first.to_i, - v.first.to_i)
337 353 when ">t+"
338 sql = sql + date_range_clause(db_table, db_field, v.first.to_i, nil)
354 return date_range_clause(db_table, db_field, v.first.to_i, nil)
339 355 when "<t+"
340 sql = sql + date_range_clause(db_table, db_field, 0, v.first.to_i)
356 return date_range_clause(db_table, db_field, 0, v.first.to_i)
341 357 when "t+"
342 sql = sql + date_range_clause(db_table, db_field, v.first.to_i, v.first.to_i)
358 return date_range_clause(db_table, db_field, v.first.to_i, v.first.to_i)
343 359 when "t"
344 sql = sql + date_range_clause(db_table, db_field, 0, 0)
360 return date_range_clause(db_table, db_field, 0, 0)
345 361 when "w"
346 362 from = l(:general_first_day_of_week) == '7' ?
347 363 # week starts on sunday
348 364 ((Date.today.cwday == 7) ? Time.now.at_beginning_of_day : Time.now.at_beginning_of_week - 1.day) :
349 365 # week starts on monday (Rails default)
350 366 Time.now.at_beginning_of_week
351 sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date(from), connection.quoted_date(from + 7.days)]
367 return "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date(from), connection.quoted_date(from + 7.days)]
352 368 when "~"
353 sql = sql + "#{db_table}.#{db_field} LIKE '%#{connection.quote_string(v.first)}%'"
369 return "#{db_table}.#{db_field} LIKE '%#{connection.quote_string(v.first)}%'"
354 370 when "!~"
355 sql = sql + "#{db_table}.#{db_field} NOT LIKE '%#{connection.quote_string(v.first)}%'"
371 return "#{db_table}.#{db_field} NOT LIKE '%#{connection.quote_string(v.first)}%'"
356 372 end
357 sql << ')'
358 filters_clauses << sql
359 end if filters and valid?
360
361 (filters_clauses << project_statement).join(' AND ')
362 373 end
363 374
364 private
365
366 375 def add_custom_fields_filters(custom_fields)
367 376 @available_filters ||= {}
368 377
369 378 custom_fields.select(&:is_filter?).each do |field|
370 379 case field.field_format
371 380 when "text"
372 381 options = { :type => :text, :order => 20 }
373 382 when "list"
374 383 options = { :type => :list_optional, :values => field.possible_values, :order => 20}
375 384 when "date"
376 385 options = { :type => :date, :order => 20 }
377 386 when "bool"
378 387 options = { :type => :list, :values => [[l(:general_text_yes), "1"], [l(:general_text_no), "0"]], :order => 20 }
379 388 else
380 389 options = { :type => :string, :order => 20 }
381 390 end
382 391 @available_filters["cf_#{field.id}"] = options.merge({ :name => field.name })
383 392 end
384 393 end
385 394
386 395 # Returns a SQL clause for a date or datetime field.
387 396 def date_range_clause(table, field, from, to)
388 397 s = []
389 398 if from
390 399 s << ("#{table}.#{field} > '%s'" % [connection.quoted_date((Date.yesterday + from).to_time.end_of_day)])
391 400 end
392 401 if to
393 402 s << ("#{table}.#{field} <= '%s'" % [connection.quoted_date((Date.today + to).to_time.end_of_day)])
394 403 end
395 404 s.join(' AND ')
396 405 end
397 406 end
General Comments 0
You need to be logged in to leave comments. Login now