@@ -1,369 +1,371 | |||
|
1 | 1 | # redMine - project management software |
|
2 | 2 | # Copyright (C) 2006-2007 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 | "done_ratio" => { :type => :integer, :order => 13 }} |
|
156 | 156 | |
|
157 | 157 | user_values = [] |
|
158 | 158 | user_values << ["<< #{l(:label_me)} >>", "me"] if User.current.logged? |
|
159 | 159 | if project |
|
160 | 160 | user_values += project.users.sort.collect{|s| [s.name, s.id.to_s] } |
|
161 | 161 | else |
|
162 | 162 | # members of the user's projects |
|
163 | 163 | user_values += User.current.projects.collect(&:users).flatten.uniq.sort.collect{|s| [s.name, s.id.to_s] } |
|
164 | 164 | end |
|
165 | 165 | @available_filters["assigned_to_id"] = { :type => :list_optional, :order => 4, :values => user_values } unless user_values.empty? |
|
166 | 166 | @available_filters["author_id"] = { :type => :list, :order => 5, :values => user_values } unless user_values.empty? |
|
167 | 167 | |
|
168 | 168 | if project |
|
169 | 169 | # project specific filters |
|
170 | 170 | @available_filters["category_id"] = { :type => :list_optional, :order => 6, :values => @project.issue_categories.collect{|s| [s.name, s.id.to_s] } } |
|
171 | @available_filters["fixed_version_id"] = { :type => :list_optional, :order => 7, :values => @project.versions.sort.collect{|s| [s.name, s.id.to_s] } } | |
|
171 | unless @project.versions.empty? | |
|
172 | @available_filters["fixed_version_id"] = { :type => :list_optional, :order => 7, :values => @project.versions.sort.collect{|s| [s.name, s.id.to_s] } } | |
|
173 | end | |
|
172 | 174 | unless @project.active_children.empty? |
|
173 | 175 | @available_filters["subproject_id"] = { :type => :list_subprojects, :order => 13, :values => @project.active_children.collect{|s| [s.name, s.id.to_s] } } |
|
174 | 176 | end |
|
175 | 177 | @project.all_custom_fields.select(&:is_filter?).each do |field| |
|
176 | 178 | case field.field_format |
|
177 | 179 | when "text" |
|
178 | 180 | options = { :type => :text, :order => 20 } |
|
179 | 181 | when "list" |
|
180 | 182 | options = { :type => :list_optional, :values => field.possible_values, :order => 20} |
|
181 | 183 | when "date" |
|
182 | 184 | options = { :type => :date, :order => 20 } |
|
183 | 185 | when "bool" |
|
184 | 186 | options = { :type => :list, :values => [[l(:general_text_yes), "1"], [l(:general_text_no), "0"]], :order => 20 } |
|
185 | 187 | else |
|
186 | 188 | options = { :type => :string, :order => 20 } |
|
187 | 189 | end |
|
188 | 190 | @available_filters["cf_#{field.id}"] = options.merge({ :name => field.name }) |
|
189 | 191 | end |
|
190 | 192 | # remove category filter if no category defined |
|
191 | 193 | @available_filters.delete "category_id" if @available_filters["category_id"][:values].empty? |
|
192 | 194 | end |
|
193 | 195 | @available_filters |
|
194 | 196 | end |
|
195 | 197 | |
|
196 | 198 | def add_filter(field, operator, values) |
|
197 | 199 | # values must be an array |
|
198 | 200 | return unless values and values.is_a? Array # and !values.first.empty? |
|
199 | 201 | # check if field is defined as an available filter |
|
200 | 202 | if available_filters.has_key? field |
|
201 | 203 | filter_options = available_filters[field] |
|
202 | 204 | # check if operator is allowed for that filter |
|
203 | 205 | #if @@operators_by_filter_type[filter_options[:type]].include? operator |
|
204 | 206 | # allowed_values = values & ([""] + (filter_options[:values] || []).collect {|val| val[1]}) |
|
205 | 207 | # filters[field] = {:operator => operator, :values => allowed_values } if (allowed_values.first and !allowed_values.first.empty?) or ["o", "c", "!*", "*", "t"].include? operator |
|
206 | 208 | #end |
|
207 | 209 | filters[field] = {:operator => operator, :values => values } |
|
208 | 210 | end |
|
209 | 211 | end |
|
210 | 212 | |
|
211 | 213 | def add_short_filter(field, expression) |
|
212 | 214 | return unless expression |
|
213 | 215 | parms = expression.scan(/^(o|c|\!|\*)?(.*)$/).first |
|
214 | 216 | add_filter field, (parms[0] || "="), [parms[1] || ""] |
|
215 | 217 | end |
|
216 | 218 | |
|
217 | 219 | def has_filter?(field) |
|
218 | 220 | filters and filters[field] |
|
219 | 221 | end |
|
220 | 222 | |
|
221 | 223 | def operator_for(field) |
|
222 | 224 | has_filter?(field) ? filters[field][:operator] : nil |
|
223 | 225 | end |
|
224 | 226 | |
|
225 | 227 | def values_for(field) |
|
226 | 228 | has_filter?(field) ? filters[field][:values] : nil |
|
227 | 229 | end |
|
228 | 230 | |
|
229 | 231 | def label_for(field) |
|
230 | 232 | label = available_filters[field][:name] if available_filters.has_key?(field) |
|
231 | 233 | label ||= field.gsub(/\_id$/, "") |
|
232 | 234 | end |
|
233 | 235 | |
|
234 | 236 | def available_columns |
|
235 | 237 | return @available_columns if @available_columns |
|
236 | 238 | @available_columns = Query.available_columns |
|
237 | 239 | @available_columns += (project ? |
|
238 | 240 | project.all_custom_fields : |
|
239 | 241 | IssueCustomField.find(:all, :conditions => {:is_for_all => true}) |
|
240 | 242 | ).collect {|cf| QueryCustomFieldColumn.new(cf) } |
|
241 | 243 | end |
|
242 | 244 | |
|
243 | 245 | def columns |
|
244 | 246 | if has_default_columns? |
|
245 | 247 | available_columns.select {|c| Setting.issue_list_default_columns.include?(c.name.to_s) } |
|
246 | 248 | else |
|
247 | 249 | # preserve the column_names order |
|
248 | 250 | column_names.collect {|name| available_columns.find {|col| col.name == name}}.compact |
|
249 | 251 | end |
|
250 | 252 | end |
|
251 | 253 | |
|
252 | 254 | def column_names=(names) |
|
253 | 255 | names = names.select {|n| n.is_a?(Symbol) || !n.blank? } if names |
|
254 | 256 | names = names.collect {|n| n.is_a?(Symbol) ? n : n.to_sym } if names |
|
255 | 257 | write_attribute(:column_names, names) |
|
256 | 258 | end |
|
257 | 259 | |
|
258 | 260 | def has_column?(column) |
|
259 | 261 | column_names && column_names.include?(column.name) |
|
260 | 262 | end |
|
261 | 263 | |
|
262 | 264 | def has_default_columns? |
|
263 | 265 | column_names.nil? || column_names.empty? |
|
264 | 266 | end |
|
265 | 267 | |
|
266 | 268 | def statement |
|
267 | 269 | # project/subprojects clause |
|
268 | 270 | project_clauses = [] |
|
269 | 271 | if project && !@project.active_children.empty? |
|
270 | 272 | ids = [project.id] |
|
271 | 273 | if has_filter?("subproject_id") |
|
272 | 274 | case operator_for("subproject_id") |
|
273 | 275 | when '=' |
|
274 | 276 | # include the selected subprojects |
|
275 | 277 | ids += values_for("subproject_id").each(&:to_i) |
|
276 | 278 | when '!*' |
|
277 | 279 | # main project only |
|
278 | 280 | else |
|
279 | 281 | # all subprojects |
|
280 | 282 | ids += project.child_ids |
|
281 | 283 | end |
|
282 | 284 | elsif Setting.display_subprojects_issues? |
|
283 | 285 | ids += project.child_ids |
|
284 | 286 | end |
|
285 | 287 | project_clauses << "#{Issue.table_name}.project_id IN (%s)" % ids.join(',') |
|
286 | 288 | elsif project |
|
287 | 289 | project_clauses << "#{Issue.table_name}.project_id = %d" % project.id |
|
288 | 290 | end |
|
289 | 291 | project_clauses << Project.visible_by(User.current) |
|
290 | 292 | |
|
291 | 293 | # filters clauses |
|
292 | 294 | filters_clauses = [] |
|
293 | 295 | filters.each_key do |field| |
|
294 | 296 | next if field == "subproject_id" |
|
295 | 297 | v = values_for(field).clone |
|
296 | 298 | next unless v and !v.empty? |
|
297 | 299 | |
|
298 | 300 | sql = '' |
|
299 | 301 | is_custom_filter = false |
|
300 | 302 | if field =~ /^cf_(\d+)$/ |
|
301 | 303 | # custom field |
|
302 | 304 | db_table = CustomValue.table_name |
|
303 | 305 | db_field = 'value' |
|
304 | 306 | is_custom_filter = true |
|
305 | 307 | 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 " |
|
306 | 308 | else |
|
307 | 309 | # regular field |
|
308 | 310 | db_table = Issue.table_name |
|
309 | 311 | db_field = field |
|
310 | 312 | sql << '(' |
|
311 | 313 | end |
|
312 | 314 | |
|
313 | 315 | # "me" value subsitution |
|
314 | 316 | if %w(assigned_to_id author_id).include?(field) |
|
315 | 317 | v.push(User.current.logged? ? User.current.id.to_s : "0") if v.delete("me") |
|
316 | 318 | end |
|
317 | 319 | |
|
318 | 320 | case operator_for field |
|
319 | 321 | when "=" |
|
320 | 322 | sql = sql + "#{db_table}.#{db_field} IN (" + v.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + ")" |
|
321 | 323 | when "!" |
|
322 | 324 | sql = sql + "(#{db_table}.#{db_field} IS NULL OR #{db_table}.#{db_field} NOT IN (" + v.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + "))" |
|
323 | 325 | when "!*" |
|
324 | 326 | sql = sql + "#{db_table}.#{db_field} IS NULL" |
|
325 | 327 | sql << " OR #{db_table}.#{db_field} = ''" if is_custom_filter |
|
326 | 328 | when "*" |
|
327 | 329 | sql = sql + "#{db_table}.#{db_field} IS NOT NULL" |
|
328 | 330 | sql << " AND #{db_table}.#{db_field} <> ''" if is_custom_filter |
|
329 | 331 | when ">=" |
|
330 | 332 | sql = sql + "#{db_table}.#{db_field} >= #{v.first.to_i}" |
|
331 | 333 | when "<=" |
|
332 | 334 | sql = sql + "#{db_table}.#{db_field} <= #{v.first.to_i}" |
|
333 | 335 | when "o" |
|
334 | 336 | sql = sql + "#{IssueStatus.table_name}.is_closed=#{connection.quoted_false}" if field == "status_id" |
|
335 | 337 | when "c" |
|
336 | 338 | sql = sql + "#{IssueStatus.table_name}.is_closed=#{connection.quoted_true}" if field == "status_id" |
|
337 | 339 | when ">t-" |
|
338 | 340 | sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date((Date.today - v.first.to_i).to_time), connection.quoted_date((Date.today + 1).to_time)] |
|
339 | 341 | when "<t-" |
|
340 | 342 | sql = sql + "#{db_table}.#{db_field} <= '%s'" % connection.quoted_date((Date.today - v.first.to_i).to_time) |
|
341 | 343 | when "t-" |
|
342 | 344 | sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date((Date.today - v.first.to_i).to_time), connection.quoted_date((Date.today - v.first.to_i + 1).to_time)] |
|
343 | 345 | when ">t+" |
|
344 | 346 | sql = sql + "#{db_table}.#{db_field} >= '%s'" % connection.quoted_date((Date.today + v.first.to_i).to_time) |
|
345 | 347 | when "<t+" |
|
346 | 348 | sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date(Date.today.to_time), connection.quoted_date((Date.today + v.first.to_i + 1).to_time)] |
|
347 | 349 | when "t+" |
|
348 | 350 | sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date((Date.today + v.first.to_i).to_time), connection.quoted_date((Date.today + v.first.to_i + 1).to_time)] |
|
349 | 351 | when "t" |
|
350 | 352 | sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date(Date.today.to_time), connection.quoted_date((Date.today+1).to_time)] |
|
351 | 353 | when "w" |
|
352 | 354 | from = l(:general_first_day_of_week) == '7' ? |
|
353 | 355 | # week starts on sunday |
|
354 | 356 | ((Date.today.cwday == 7) ? Time.now.at_beginning_of_day : Time.now.at_beginning_of_week - 1.day) : |
|
355 | 357 | # week starts on monday (Rails default) |
|
356 | 358 | Time.now.at_beginning_of_week |
|
357 | 359 | sql = sql + "#{db_table}.#{db_field} BETWEEN '%s' AND '%s'" % [connection.quoted_date(from), connection.quoted_date(from + 7.days)] |
|
358 | 360 | when "~" |
|
359 | 361 | sql = sql + "#{db_table}.#{db_field} LIKE '%#{connection.quote_string(v.first)}%'" |
|
360 | 362 | when "!~" |
|
361 | 363 | sql = sql + "#{db_table}.#{db_field} NOT LIKE '%#{connection.quote_string(v.first)}%'" |
|
362 | 364 | end |
|
363 | 365 | sql << ')' |
|
364 | 366 | filters_clauses << sql |
|
365 | 367 | end if filters and valid? |
|
366 | 368 | |
|
367 | 369 | (project_clauses + filters_clauses).join(' AND ') |
|
368 | 370 | end |
|
369 | 371 | end |
General Comments 0
You need to be logged in to leave comments.
Login now