##// END OF EJS Templates
jro_apps » redmine
RSS
Code cleanup, use safer #closed?...
Jean-Philippe Lang -
r13123:d62574badb1d
parent child
Show More
Side by Side Unified
Context file:
r13123:d62574badb1d Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,1591 +1,1591
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2014 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 Issue < ActiveRecord::Base
19 19 include Redmine::SafeAttributes
20 20 include Redmine::Utils::DateCalculation
21 21 include Redmine::I18n
22 22
23 23 belongs_to :project
24 24 belongs_to :tracker
25 25 belongs_to :status, :class_name => 'IssueStatus'
26 26 belongs_to :author, :class_name => 'User'
27 27 belongs_to :assigned_to, :class_name => 'Principal'
28 28 belongs_to :fixed_version, :class_name => 'Version'
29 29 belongs_to :priority, :class_name => 'IssuePriority'
30 30 belongs_to :category, :class_name => 'IssueCategory'
31 31
32 32 has_many :journals, :as => :journalized, :dependent => :destroy
33 33 has_many :visible_journals,
34 34 lambda {where(["(#{Journal.table_name}.private_notes = ? OR (#{Project.allowed_to_condition(User.current, :view_private_notes)}))", false])},
35 35 :class_name => 'Journal',
36 36 :as => :journalized
37 37
38 38 has_many :time_entries, :dependent => :destroy
39 39 has_and_belongs_to_many :changesets, lambda {order("#{Changeset.table_name}.committed_on ASC, #{Changeset.table_name}.id ASC")}
40 40
41 41 has_many :relations_from, :class_name => 'IssueRelation', :foreign_key => 'issue_from_id', :dependent => :delete_all
42 42 has_many :relations_to, :class_name => 'IssueRelation', :foreign_key => 'issue_to_id', :dependent => :delete_all
43 43
44 44 acts_as_nested_set :scope => 'root_id', :dependent => :destroy
45 45 acts_as_attachable :after_add => :attachment_added, :after_remove => :attachment_removed
46 46 acts_as_customizable
47 47 acts_as_watchable
48 48 acts_as_searchable :columns => ['subject', "#{table_name}.description", "#{Journal.table_name}.notes"],
49 49 # sort by id so that limited eager loading doesn't break with postgresql
50 50 :order_column => "#{table_name}.id",
51 51 :scope => lambda { joins(:project).
52 52 joins("LEFT OUTER JOIN #{Journal.table_name} ON #{Journal.table_name}.journalized_type='Issue'" +
53 53 " AND #{Journal.table_name}.journalized_id = #{Issue.table_name}.id" +
54 54 " AND (#{Journal.table_name}.private_notes = #{connection.quoted_false}" +
55 55 " OR (#{Project.allowed_to_condition(User.current, :view_private_notes)}))") }
56 56
57 57 acts_as_event :title => Proc.new {|o| "#{o.tracker.name} ##{o.id} (#{o.status}): #{o.subject}"},
58 58 :url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.id}},
59 59 :type => Proc.new {|o| 'issue' + (o.closed? ? ' closed' : '') }
60 60
61 61 acts_as_activity_provider :scope => preload(:project, :author, :tracker),
62 62 :author_key => :author_id
63 63
64 64 DONE_RATIO_OPTIONS = %w(issue_field issue_status)
65 65
66 66 attr_reader :current_journal
67 67 delegate :notes, :notes=, :private_notes, :private_notes=, :to => :current_journal, :allow_nil => true
68 68
69 69 validates_presence_of :subject, :priority, :project, :tracker, :author, :status
70 70
71 71 validates_length_of :subject, :maximum => 255
72 72 validates_inclusion_of :done_ratio, :in => 0..100
73 73 validates :estimated_hours, :numericality => {:greater_than_or_equal_to => 0, :allow_nil => true, :message => :invalid}
74 74 validates :start_date, :date => true
75 75 validates :due_date, :date => true
76 76 validate :validate_issue, :validate_required_fields
77 77 attr_protected :id
78 78
79 79 scope :visible, lambda {|*args|
80 80 includes(:project).
81 81 references(:project).
82 82 where(Issue.visible_condition(args.shift || User.current, *args))
83 83 }
84 84
85 85 scope :open, lambda {|*args|
86 86 is_closed = args.size > 0 ? !args.first : false
87 87 joins(:status).
88 88 where("#{IssueStatus.table_name}.is_closed = ?", is_closed)
89 89 }
90 90
91 91 scope :recently_updated, lambda { order("#{Issue.table_name}.updated_on DESC") }
92 92 scope :on_active_project, lambda {
93 93 joins(:project).
94 94 where("#{Project.table_name}.status = ?", Project::STATUS_ACTIVE)
95 95 }
96 96 scope :fixed_version, lambda {|versions|
97 97 ids = [versions].flatten.compact.map {|v| v.is_a?(Version) ? v.id : v}
98 98 ids.any? ? where(:fixed_version_id => ids) : where('1=0')
99 99 }
100 100
101 101 before_create :default_assign
102 102 before_save :close_duplicates, :update_done_ratio_from_issue_status,
103 103 :force_updated_on_change, :update_closed_on, :set_assigned_to_was
104 104 after_save {|issue| issue.send :after_project_change if !issue.id_changed? && issue.project_id_changed?}
105 105 after_save :reschedule_following_issues, :update_nested_set_attributes,
106 106 :update_parent_attributes, :create_journal
107 107 # Should be after_create but would be called before previous after_save callbacks
108 108 after_save :after_create_from_copy
109 109 after_destroy :update_parent_attributes
110 110 after_create :send_notification
111 111 # Keep it at the end of after_save callbacks
112 112 after_save :clear_assigned_to_was
113 113
114 114 # Returns a SQL conditions string used to find all issues visible by the specified user
115 115 def self.visible_condition(user, options={})
116 116 Project.allowed_to_condition(user, :view_issues, options) do |role, user|
117 117 if user.id && user.logged?
118 118 case role.issues_visibility
119 119 when 'all'
120 120 nil
121 121 when 'default'
122 122 user_ids = [user.id] + user.groups.map(&:id).compact
123 123 "(#{table_name}.is_private = #{connection.quoted_false} OR #{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id IN (#{user_ids.join(',')}))"
124 124 when 'own'
125 125 user_ids = [user.id] + user.groups.map(&:id).compact
126 126 "(#{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id IN (#{user_ids.join(',')}))"
127 127 else
128 128 '1=0'
129 129 end
130 130 else
131 131 "(#{table_name}.is_private = #{connection.quoted_false})"
132 132 end
133 133 end
134 134 end
135 135
136 136 # Returns true if usr or current user is allowed to view the issue
137 137 def visible?(usr=nil)
138 138 (usr || User.current).allowed_to?(:view_issues, self.project) do |role, user|
139 139 if user.logged?
140 140 case role.issues_visibility
141 141 when 'all'
142 142 true
143 143 when 'default'
144 144 !self.is_private? || (self.author == user || user.is_or_belongs_to?(assigned_to))
145 145 when 'own'
146 146 self.author == user || user.is_or_belongs_to?(assigned_to)
147 147 else
148 148 false
149 149 end
150 150 else
151 151 !self.is_private?
152 152 end
153 153 end
154 154 end
155 155
156 156 # Returns true if user or current user is allowed to edit or add a note to the issue
157 157 def editable?(user=User.current)
158 158 user.allowed_to?(:edit_issues, project) || user.allowed_to?(:add_issue_notes, project)
159 159 end
160 160
161 161 def initialize(attributes=nil, *args)
162 162 super
163 163 if new_record?
164 164 # set default values for new records only
165 165 self.status ||= IssueStatus.default
166 166 self.priority ||= IssuePriority.default
167 167 self.watcher_user_ids = []
168 168 end
169 169 end
170 170
171 171 def create_or_update
172 172 super
173 173 ensure
174 174 @status_was = nil
175 175 end
176 176 private :create_or_update
177 177
178 178 # AR#Persistence#destroy would raise and RecordNotFound exception
179 179 # if the issue was already deleted or updated (non matching lock_version).
180 180 # This is a problem when bulk deleting issues or deleting a project
181 181 # (because an issue may already be deleted if its parent was deleted
182 182 # first).
183 183 # The issue is reloaded by the nested_set before being deleted so
184 184 # the lock_version condition should not be an issue but we handle it.
185 185 def destroy
186 186 super
187 187 rescue ActiveRecord::RecordNotFound
188 188 # Stale or already deleted
189 189 begin
190 190 reload
191 191 rescue ActiveRecord::RecordNotFound
192 192 # The issue was actually already deleted
193 193 @destroyed = true
194 194 return freeze
195 195 end
196 196 # The issue was stale, retry to destroy
197 197 super
198 198 end
199 199
200 200 alias :base_reload :reload
201 201 def reload(*args)
202 202 @workflow_rule_by_attribute = nil
203 203 @assignable_versions = nil
204 204 @relations = nil
205 205 base_reload(*args)
206 206 end
207 207
208 208 # Overrides Redmine::Acts::Customizable::InstanceMethods#available_custom_fields
209 209 def available_custom_fields
210 210 (project && tracker) ? (project.all_issue_custom_fields & tracker.custom_fields) : []
211 211 end
212 212
213 213 def visible_custom_field_values(user=nil)
214 214 user_real = user || User.current
215 215 custom_field_values.select do |value|
216 216 value.custom_field.visible_by?(project, user_real)
217 217 end
218 218 end
219 219
220 220 # Copies attributes from another issue, arg can be an id or an Issue
221 221 def copy_from(arg, options={})
222 222 issue = arg.is_a?(Issue) ? arg : Issue.visible.find(arg)
223 223 self.attributes = issue.attributes.dup.except("id", "root_id", "parent_id", "lft", "rgt", "created_on", "updated_on")
224 224 self.custom_field_values = issue.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
225 225 self.status = issue.status
226 226 self.author = User.current
227 227 unless options[:attachments] == false
228 228 self.attachments = issue.attachments.map do |attachement|
229 229 attachement.copy(:container => self)
230 230 end
231 231 end
232 232 @copied_from = issue
233 233 @copy_options = options
234 234 self
235 235 end
236 236
237 237 # Returns an unsaved copy of the issue
238 238 def copy(attributes=nil, copy_options={})
239 239 copy = self.class.new.copy_from(self, copy_options)
240 240 copy.attributes = attributes if attributes
241 241 copy
242 242 end
243 243
244 244 # Returns true if the issue is a copy
245 245 def copy?
246 246 @copied_from.present?
247 247 end
248 248
249 249 # Moves/copies an issue to a new project and tracker
250 250 # Returns the moved/copied issue on success, false on failure
251 251 def move_to_project(new_project, new_tracker=nil, options={})
252 252 ActiveSupport::Deprecation.warn "Issue#move_to_project is deprecated, use #project= instead."
253 253
254 254 if options[:copy]
255 255 issue = self.copy
256 256 else
257 257 issue = self
258 258 end
259 259
260 260 issue.init_journal(User.current, options[:notes])
261 261
262 262 # Preserve previous behaviour
263 263 # #move_to_project doesn't change tracker automatically
264 264 issue.send :project=, new_project, true
265 265 if new_tracker
266 266 issue.tracker = new_tracker
267 267 end
268 268 # Allow bulk setting of attributes on the issue
269 269 if options[:attributes]
270 270 issue.attributes = options[:attributes]
271 271 end
272 272
273 273 issue.save ? issue : false
274 274 end
275 275
276 276 def status_id=(sid)
277 277 self.status = nil
278 278 result = write_attribute(:status_id, sid)
279 279 @workflow_rule_by_attribute = nil
280 280 result
281 281 end
282 282
283 283 def priority_id=(pid)
284 284 self.priority = nil
285 285 write_attribute(:priority_id, pid)
286 286 end
287 287
288 288 def category_id=(cid)
289 289 self.category = nil
290 290 write_attribute(:category_id, cid)
291 291 end
292 292
293 293 def fixed_version_id=(vid)
294 294 self.fixed_version = nil
295 295 write_attribute(:fixed_version_id, vid)
296 296 end
297 297
298 298 def tracker_id=(tid)
299 299 self.tracker = nil
300 300 result = write_attribute(:tracker_id, tid)
301 301 @custom_field_values = nil
302 302 @workflow_rule_by_attribute = nil
303 303 result
304 304 end
305 305
306 306 def project_id=(project_id)
307 307 if project_id.to_s != self.project_id.to_s
308 308 self.project = (project_id.present? ? Project.find_by_id(project_id) : nil)
309 309 end
310 310 end
311 311
312 312 def project=(project, keep_tracker=false)
313 313 project_was = self.project
314 314 write_attribute(:project_id, project ? project.id : nil)
315 315 association_instance_set('project', project)
316 316 if project_was && project && project_was != project
317 317 @assignable_versions = nil
318 318
319 319 unless keep_tracker || project.trackers.include?(tracker)
320 320 self.tracker = project.trackers.first
321 321 end
322 322 # Reassign to the category with same name if any
323 323 if category
324 324 self.category = project.issue_categories.find_by_name(category.name)
325 325 end
326 326 # Keep the fixed_version if it's still valid in the new_project
327 327 if fixed_version && fixed_version.project != project && !project.shared_versions.include?(fixed_version)
328 328 self.fixed_version = nil
329 329 end
330 330 # Clear the parent task if it's no longer valid
331 331 unless valid_parent_project?
332 332 self.parent_issue_id = nil
333 333 end
334 334 @custom_field_values = nil
335 335 end
336 336 end
337 337
338 338 def description=(arg)
339 339 if arg.is_a?(String)
340 340 arg = arg.gsub(/(\r\n|\n|\r)/, "\r\n")
341 341 end
342 342 write_attribute(:description, arg)
343 343 end
344 344
345 345 # Overrides assign_attributes so that project and tracker get assigned first
346 346 def assign_attributes_with_project_and_tracker_first(new_attributes, *args)
347 347 return if new_attributes.nil?
348 348 attrs = new_attributes.dup
349 349 attrs.stringify_keys!
350 350
351 351 %w(project project_id tracker tracker_id).each do |attr|
352 352 if attrs.has_key?(attr)
353 353 send "#{attr}=", attrs.delete(attr)
354 354 end
355 355 end
356 356 send :assign_attributes_without_project_and_tracker_first, attrs, *args
357 357 end
358 358 # Do not redefine alias chain on reload (see #4838)
359 359 alias_method_chain(:assign_attributes, :project_and_tracker_first) unless method_defined?(:assign_attributes_without_project_and_tracker_first)
360 360
361 361 def attributes=(new_attributes)
362 362 assign_attributes new_attributes
363 363 end
364 364
365 365 def estimated_hours=(h)
366 366 write_attribute :estimated_hours, (h.is_a?(String) ? h.to_hours : h)
367 367 end
368 368
369 369 safe_attributes 'project_id',
370 370 :if => lambda {|issue, user|
371 371 if issue.new_record?
372 372 issue.copy?
373 373 elsif user.allowed_to?(:move_issues, issue.project)
374 374 Issue.allowed_target_projects_on_move.count > 1
375 375 end
376 376 }
377 377
378 378 safe_attributes 'tracker_id',
379 379 'status_id',
380 380 'category_id',
381 381 'assigned_to_id',
382 382 'priority_id',
383 383 'fixed_version_id',
384 384 'subject',
385 385 'description',
386 386 'start_date',
387 387 'due_date',
388 388 'done_ratio',
389 389 'estimated_hours',
390 390 'custom_field_values',
391 391 'custom_fields',
392 392 'lock_version',
393 393 'notes',
394 394 :if => lambda {|issue, user| issue.new_record? || user.allowed_to?(:edit_issues, issue.project) }
395 395
396 396 safe_attributes 'status_id',
397 397 'assigned_to_id',
398 398 'fixed_version_id',
399 399 'done_ratio',
400 400 'lock_version',
401 401 'notes',
402 402 :if => lambda {|issue, user| issue.new_statuses_allowed_to(user).any? }
403 403
404 404 safe_attributes 'notes',
405 405 :if => lambda {|issue, user| user.allowed_to?(:add_issue_notes, issue.project)}
406 406
407 407 safe_attributes 'private_notes',
408 408 :if => lambda {|issue, user| !issue.new_record? && user.allowed_to?(:set_notes_private, issue.project)}
409 409
410 410 safe_attributes 'watcher_user_ids',
411 411 :if => lambda {|issue, user| issue.new_record? && user.allowed_to?(:add_issue_watchers, issue.project)}
412 412
413 413 safe_attributes 'is_private',
414 414 :if => lambda {|issue, user|
415 415 user.allowed_to?(:set_issues_private, issue.project) ||
416 416 (issue.author == user && user.allowed_to?(:set_own_issues_private, issue.project))
417 417 }
418 418
419 419 safe_attributes 'parent_issue_id',
420 420 :if => lambda {|issue, user| (issue.new_record? || user.allowed_to?(:edit_issues, issue.project)) &&
421 421 user.allowed_to?(:manage_subtasks, issue.project)}
422 422
423 423 def safe_attribute_names(user=nil)
424 424 names = super
425 425 names -= disabled_core_fields
426 426 names -= read_only_attribute_names(user)
427 427 names
428 428 end
429 429
430 430 # Safely sets attributes
431 431 # Should be called from controllers instead of #attributes=
432 432 # attr_accessible is too rough because we still want things like
433 433 # Issue.new(:project => foo) to work
434 434 def safe_attributes=(attrs, user=User.current)
435 435 return unless attrs.is_a?(Hash)
436 436
437 437 attrs = attrs.deep_dup
438 438
439 439 # Project and Tracker must be set before since new_statuses_allowed_to depends on it.
440 440 if (p = attrs.delete('project_id')) && safe_attribute?('project_id')
441 441 if allowed_target_projects(user).where(:id => p.to_i).exists?
442 442 self.project_id = p
443 443 end
444 444 end
445 445
446 446 if (t = attrs.delete('tracker_id')) && safe_attribute?('tracker_id')
447 447 self.tracker_id = t
448 448 end
449 449
450 450 if (s = attrs.delete('status_id')) && safe_attribute?('status_id')
451 451 if new_statuses_allowed_to(user).collect(&:id).include?(s.to_i)
452 452 self.status_id = s
453 453 end
454 454 end
455 455
456 456 attrs = delete_unsafe_attributes(attrs, user)
457 457 return if attrs.empty?
458 458
459 459 unless leaf?
460 460 attrs.reject! {|k,v| %w(priority_id done_ratio start_date due_date estimated_hours).include?(k)}
461 461 end
462 462
463 463 if attrs['parent_issue_id'].present?
464 464 s = attrs['parent_issue_id'].to_s
465 465 unless (m = s.match(%r{\A#?(\d+)\z})) && (m[1] == parent_id.to_s || Issue.visible(user).exists?(m[1]))
466 466 @invalid_parent_issue_id = attrs.delete('parent_issue_id')
467 467 end
468 468 end
469 469
470 470 if attrs['custom_field_values'].present?
471 471 editable_custom_field_ids = editable_custom_field_values(user).map {|v| v.custom_field_id.to_s}
472 472 attrs['custom_field_values'].select! {|k, v| editable_custom_field_ids.include?(k.to_s)}
473 473 end
474 474
475 475 if attrs['custom_fields'].present?
476 476 editable_custom_field_ids = editable_custom_field_values(user).map {|v| v.custom_field_id.to_s}
477 477 attrs['custom_fields'].select! {|c| editable_custom_field_ids.include?(c['id'].to_s)}
478 478 end
479 479
480 480 # mass-assignment security bypass
481 481 assign_attributes attrs, :without_protection => true
482 482 end
483 483
484 484 def disabled_core_fields
485 485 tracker ? tracker.disabled_core_fields : []
486 486 end
487 487
488 488 # Returns the custom_field_values that can be edited by the given user
489 489 def editable_custom_field_values(user=nil)
490 490 visible_custom_field_values(user).reject do |value|
491 491 read_only_attribute_names(user).include?(value.custom_field_id.to_s)
492 492 end
493 493 end
494 494
495 495 # Returns the custom fields that can be edited by the given user
496 496 def editable_custom_fields(user=nil)
497 497 editable_custom_field_values(user).map(&:custom_field).uniq
498 498 end
499 499
500 500 # Returns the names of attributes that are read-only for user or the current user
501 501 # For users with multiple roles, the read-only fields are the intersection of
502 502 # read-only fields of each role
503 503 # The result is an array of strings where sustom fields are represented with their ids
504 504 #
505 505 # Examples:
506 506 # issue.read_only_attribute_names # => ['due_date', '2']
507 507 # issue.read_only_attribute_names(user) # => []
508 508 def read_only_attribute_names(user=nil)
509 509 workflow_rule_by_attribute(user).reject {|attr, rule| rule != 'readonly'}.keys
510 510 end
511 511
512 512 # Returns the names of required attributes for user or the current user
513 513 # For users with multiple roles, the required fields are the intersection of
514 514 # required fields of each role
515 515 # The result is an array of strings where sustom fields are represented with their ids
516 516 #
517 517 # Examples:
518 518 # issue.required_attribute_names # => ['due_date', '2']
519 519 # issue.required_attribute_names(user) # => []
520 520 def required_attribute_names(user=nil)
521 521 workflow_rule_by_attribute(user).reject {|attr, rule| rule != 'required'}.keys
522 522 end
523 523
524 524 # Returns true if the attribute is required for user
525 525 def required_attribute?(name, user=nil)
526 526 required_attribute_names(user).include?(name.to_s)
527 527 end
528 528
529 529 # Returns a hash of the workflow rule by attribute for the given user
530 530 #
531 531 # Examples:
532 532 # issue.workflow_rule_by_attribute # => {'due_date' => 'required', 'start_date' => 'readonly'}
533 533 def workflow_rule_by_attribute(user=nil)
534 534 return @workflow_rule_by_attribute if @workflow_rule_by_attribute && user.nil?
535 535
536 536 user_real = user || User.current
537 537 roles = user_real.admin ? Role.all : user_real.roles_for_project(project)
538 538 return {} if roles.empty?
539 539
540 540 result = {}
541 541 workflow_permissions = WorkflowPermission.where(:tracker_id => tracker_id, :old_status_id => status_id, :role_id => roles.map(&:id))
542 542 if workflow_permissions.any?
543 543 workflow_rules = workflow_permissions.inject({}) do |h, wp|
544 544 h[wp.field_name] ||= []
545 545 h[wp.field_name] << wp.rule
546 546 h
547 547 end
548 548 workflow_rules.each do |attr, rules|
549 549 next if rules.size < roles.size
550 550 uniq_rules = rules.uniq
551 551 if uniq_rules.size == 1
552 552 result[attr] = uniq_rules.first
553 553 else
554 554 result[attr] = 'required'
555 555 end
556 556 end
557 557 end
558 558 @workflow_rule_by_attribute = result if user.nil?
559 559 result
560 560 end
561 561 private :workflow_rule_by_attribute
562 562
563 563 def done_ratio
564 564 if Issue.use_status_for_done_ratio? && status && status.default_done_ratio
565 565 status.default_done_ratio
566 566 else
567 567 read_attribute(:done_ratio)
568 568 end
569 569 end
570 570
571 571 def self.use_status_for_done_ratio?
572 572 Setting.issue_done_ratio == 'issue_status'
573 573 end
574 574
575 575 def self.use_field_for_done_ratio?
576 576 Setting.issue_done_ratio == 'issue_field'
577 577 end
578 578
579 579 def validate_issue
580 580 if due_date && start_date && (start_date_changed? || due_date_changed?) && due_date < start_date
581 581 errors.add :due_date, :greater_than_start_date
582 582 end
583 583
584 584 if start_date && start_date_changed? && soonest_start && start_date < soonest_start
585 585 errors.add :start_date, :earlier_than_minimum_start_date, :date => format_date(soonest_start)
586 586 end
587 587
588 588 if fixed_version
589 589 if !assignable_versions.include?(fixed_version)
590 590 errors.add :fixed_version_id, :inclusion
591 591 elsif reopened? && fixed_version.closed?
592 592 errors.add :base, I18n.t(:error_can_not_reopen_issue_on_closed_version)
593 593 end
594 594 end
595 595
596 596 # Checks that the issue can not be added/moved to a disabled tracker
597 597 if project && (tracker_id_changed? || project_id_changed?)
598 598 unless project.trackers.include?(tracker)
599 599 errors.add :tracker_id, :inclusion
600 600 end
601 601 end
602 602
603 603 # Checks parent issue assignment
604 604 if @invalid_parent_issue_id.present?
605 605 errors.add :parent_issue_id, :invalid
606 606 elsif @parent_issue
607 607 if !valid_parent_project?(@parent_issue)
608 608 errors.add :parent_issue_id, :invalid
609 609 elsif (@parent_issue != parent) && (all_dependent_issues.include?(@parent_issue) || @parent_issue.all_dependent_issues.include?(self))
610 610 errors.add :parent_issue_id, :invalid
611 611 elsif !new_record?
612 612 # moving an existing issue
613 613 if @parent_issue.root_id != root_id
614 614 # we can always move to another tree
615 615 elsif move_possible?(@parent_issue)
616 616 # move accepted inside tree
617 617 else
618 618 errors.add :parent_issue_id, :invalid
619 619 end
620 620 end
621 621 end
622 622 end
623 623
624 624 # Validates the issue against additional workflow requirements
625 625 def validate_required_fields
626 626 user = new_record? ? author : current_journal.try(:user)
627 627
628 628 required_attribute_names(user).each do |attribute|
629 629 if attribute =~ /^\d+$/
630 630 attribute = attribute.to_i
631 631 v = custom_field_values.detect {|v| v.custom_field_id == attribute }
632 632 if v && v.value.blank?
633 633 errors.add :base, v.custom_field.name + ' ' + l('activerecord.errors.messages.blank')
634 634 end
635 635 else
636 636 if respond_to?(attribute) && send(attribute).blank?
637 637 errors.add attribute, :blank
638 638 end
639 639 end
640 640 end
641 641 end
642 642
643 643 # Set the done_ratio using the status if that setting is set. This will keep the done_ratios
644 644 # even if the user turns off the setting later
645 645 def update_done_ratio_from_issue_status
646 646 if Issue.use_status_for_done_ratio? && status && status.default_done_ratio
647 647 self.done_ratio = status.default_done_ratio
648 648 end
649 649 end
650 650
651 651 def init_journal(user, notes = "")
652 652 @current_journal ||= Journal.new(:journalized => self, :user => user, :notes => notes)
653 653 if new_record?
654 654 @current_journal.notify = false
655 655 else
656 656 @attributes_before_change = attributes.dup
657 657 @custom_values_before_change = {}
658 658 self.custom_field_values.each {|c| @custom_values_before_change.store c.custom_field_id, c.value }
659 659 end
660 660 @current_journal
661 661 end
662 662
663 663 # Returns the id of the last journal or nil
664 664 def last_journal_id
665 665 if new_record?
666 666 nil
667 667 else
668 668 journals.maximum(:id)
669 669 end
670 670 end
671 671
672 672 # Returns a scope for journals that have an id greater than journal_id
673 673 def journals_after(journal_id)
674 674 scope = journals.reorder("#{Journal.table_name}.id ASC")
675 675 if journal_id.present?
676 676 scope = scope.where("#{Journal.table_name}.id > ?", journal_id.to_i)
677 677 end
678 678 scope
679 679 end
680 680
681 681 # Returns the initial status of the issue
682 682 # Returns nil for a new issue
683 683 def status_was
684 684 if status_id_was && status_id_was.to_i > 0
685 685 @status_was ||= IssueStatus.find_by_id(status_id_was)
686 686 end
687 687 end
688 688
689 689 # Return true if the issue is closed, otherwise false
690 690 def closed?
691 self.status.is_closed?
691 status.present? && status.is_closed?
692 692 end
693 693
694 694 # Return true if the issue is being reopened
695 695 def reopened?
696 696 if !new_record? && status_id_changed?
697 697 status_was = IssueStatus.find_by_id(status_id_was)
698 698 status_new = IssueStatus.find_by_id(status_id)
699 699 if status_was && status_new && status_was.is_closed? && !status_new.is_closed?
700 700 return true
701 701 end
702 702 end
703 703 false
704 704 end
705 705
706 706 # Return true if the issue is being closed
707 707 def closing?
708 708 if !new_record? && status_id_changed?
709 if status_was && status && !status_was.is_closed? && status.is_closed?
709 if closed? && status_was && !status_was.is_closed?
710 710 return true
711 711 end
712 712 end
713 713 false
714 714 end
715 715
716 716 # Returns true if the issue is overdue
717 717 def overdue?
718 718 !due_date.nil? && (due_date < Date.today) && !status.is_closed?
719 719 end
720 720
721 721 # Is the amount of work done less than it should for the due date
722 722 def behind_schedule?
723 723 return false if start_date.nil? || due_date.nil?
724 724 done_date = start_date + ((due_date - start_date + 1) * done_ratio / 100).floor
725 725 return done_date <= Date.today
726 726 end
727 727
728 728 # Does this issue have children?
729 729 def children?
730 730 !leaf?
731 731 end
732 732
733 733 # Users the issue can be assigned to
734 734 def assignable_users
735 735 users = project.assignable_users
736 736 users << author if author
737 737 users << assigned_to if assigned_to
738 738 users.uniq.sort
739 739 end
740 740
741 741 # Versions that the issue can be assigned to
742 742 def assignable_versions
743 743 return @assignable_versions if @assignable_versions
744 744
745 745 versions = project.shared_versions.open.to_a
746 746 if fixed_version
747 747 if fixed_version_id_changed?
748 748 # nothing to do
749 749 elsif project_id_changed?
750 750 if project.shared_versions.include?(fixed_version)
751 751 versions << fixed_version
752 752 end
753 753 else
754 754 versions << fixed_version
755 755 end
756 756 end
757 757 @assignable_versions = versions.uniq.sort
758 758 end
759 759
760 760 # Returns true if this issue is blocked by another issue that is still open
761 761 def blocked?
762 762 !relations_to.detect {|ir| ir.relation_type == 'blocks' && !ir.issue_from.closed?}.nil?
763 763 end
764 764
765 765 # Returns an array of statuses that user is able to apply
766 766 def new_statuses_allowed_to(user=User.current, include_default=false)
767 767 if new_record? && @copied_from
768 768 [IssueStatus.default, @copied_from.status].compact.uniq.sort
769 769 else
770 770 initial_status = nil
771 771 if new_record?
772 772 initial_status = IssueStatus.default
773 773 elsif status_id_was
774 774 initial_status = IssueStatus.find_by_id(status_id_was)
775 775 end
776 776 initial_status ||= status
777 777
778 778 initial_assigned_to_id = assigned_to_id_changed? ? assigned_to_id_was : assigned_to_id
779 779 assignee_transitions_allowed = initial_assigned_to_id.present? &&
780 780 (user.id == initial_assigned_to_id || user.group_ids.include?(initial_assigned_to_id))
781 781
782 782 statuses = initial_status.find_new_statuses_allowed_to(
783 783 user.admin ? Role.all : user.roles_for_project(project),
784 784 tracker,
785 785 author == user,
786 786 assignee_transitions_allowed
787 787 )
788 788 statuses << initial_status unless statuses.empty?
789 789 statuses << IssueStatus.default if include_default
790 790 statuses = statuses.compact.uniq.sort
791 791 blocked? ? statuses.reject {|s| s.is_closed?} : statuses
792 792 end
793 793 end
794 794
795 795 # Returns the previous assignee if changed
796 796 def assigned_to_was
797 797 # assigned_to_id_was is reset before after_save callbacks
798 798 user_id = @previous_assigned_to_id || assigned_to_id_was
799 799 if user_id && user_id != assigned_to_id
800 800 @assigned_to_was ||= User.find_by_id(user_id)
801 801 end
802 802 end
803 803
804 804 # Returns the users that should be notified
805 805 def notified_users
806 806 notified = []
807 807 # Author and assignee are always notified unless they have been
808 808 # locked or don't want to be notified
809 809 notified << author if author
810 810 if assigned_to
811 811 notified += (assigned_to.is_a?(Group) ? assigned_to.users : [assigned_to])
812 812 end
813 813 if assigned_to_was
814 814 notified += (assigned_to_was.is_a?(Group) ? assigned_to_was.users : [assigned_to_was])
815 815 end
816 816 notified = notified.select {|u| u.active? && u.notify_about?(self)}
817 817
818 818 notified += project.notified_users
819 819 notified.uniq!
820 820 # Remove users that can not view the issue
821 821 notified.reject! {|user| !visible?(user)}
822 822 notified
823 823 end
824 824
825 825 # Returns the email addresses that should be notified
826 826 def recipients
827 827 notified_users.collect(&:mail)
828 828 end
829 829
830 830 def each_notification(users, &block)
831 831 if users.any?
832 832 if custom_field_values.detect {|value| !value.custom_field.visible?}
833 833 users_by_custom_field_visibility = users.group_by do |user|
834 834 visible_custom_field_values(user).map(&:custom_field_id).sort
835 835 end
836 836 users_by_custom_field_visibility.values.each do |users|
837 837 yield(users)
838 838 end
839 839 else
840 840 yield(users)
841 841 end
842 842 end
843 843 end
844 844
845 845 # Returns the number of hours spent on this issue
846 846 def spent_hours
847 847 @spent_hours ||= time_entries.sum(:hours) || 0
848 848 end
849 849
850 850 # Returns the total number of hours spent on this issue and its descendants
851 851 #
852 852 # Example:
853 853 # spent_hours => 0.0
854 854 # spent_hours => 50.2
855 855 def total_spent_hours
856 856 @total_spent_hours ||=
857 857 self_and_descendants.
858 858 joins("LEFT JOIN #{TimeEntry.table_name} ON #{TimeEntry.table_name}.issue_id = #{Issue.table_name}.id").
859 859 sum("#{TimeEntry.table_name}.hours").to_f || 0.0
860 860 end
861 861
862 862 def relations
863 863 @relations ||= IssueRelation::Relations.new(self, (relations_from + relations_to).sort)
864 864 end
865 865
866 866 # Preloads relations for a collection of issues
867 867 def self.load_relations(issues)
868 868 if issues.any?
869 869 relations = IssueRelation.where("issue_from_id IN (:ids) OR issue_to_id IN (:ids)", :ids => issues.map(&:id)).all
870 870 issues.each do |issue|
871 871 issue.instance_variable_set "@relations", relations.select {|r| r.issue_from_id == issue.id || r.issue_to_id == issue.id}
872 872 end
873 873 end
874 874 end
875 875
876 876 # Preloads visible spent time for a collection of issues
877 877 def self.load_visible_spent_hours(issues, user=User.current)
878 878 if issues.any?
879 879 hours_by_issue_id = TimeEntry.visible(user).group(:issue_id).sum(:hours)
880 880 issues.each do |issue|
881 881 issue.instance_variable_set "@spent_hours", (hours_by_issue_id[issue.id] || 0)
882 882 end
883 883 end
884 884 end
885 885
886 886 # Preloads visible relations for a collection of issues
887 887 def self.load_visible_relations(issues, user=User.current)
888 888 if issues.any?
889 889 issue_ids = issues.map(&:id)
890 890 # Relations with issue_from in given issues and visible issue_to
891 891 relations_from = IssueRelation.joins(:issue_to => :project).
892 892 where(visible_condition(user)).where(:issue_from_id => issue_ids).to_a
893 893 # Relations with issue_to in given issues and visible issue_from
894 894 relations_to = IssueRelation.joins(:issue_from => :project).
895 895 where(visible_condition(user)).
896 896 where(:issue_to_id => issue_ids).to_a
897 897 issues.each do |issue|
898 898 relations =
899 899 relations_from.select {|relation| relation.issue_from_id == issue.id} +
900 900 relations_to.select {|relation| relation.issue_to_id == issue.id}
901 901
902 902 issue.instance_variable_set "@relations", IssueRelation::Relations.new(issue, relations.sort)
903 903 end
904 904 end
905 905 end
906 906
907 907 # Finds an issue relation given its id.
908 908 def find_relation(relation_id)
909 909 IssueRelation.where("issue_to_id = ? OR issue_from_id = ?", id, id).find(relation_id)
910 910 end
911 911
912 912 # Returns all the other issues that depend on the issue
913 913 # The algorithm is a modified breadth first search (bfs)
914 914 def all_dependent_issues(except=[])
915 915 # The found dependencies
916 916 dependencies = []
917 917
918 918 # The visited flag for every node (issue) used by the breadth first search
919 919 eNOT_DISCOVERED = 0 # The issue is "new" to the algorithm, it has not seen it before.
920 920
921 921 ePROCESS_ALL = 1 # The issue is added to the queue. Process both children and relations of
922 922 # the issue when it is processed.
923 923
924 924 ePROCESS_RELATIONS_ONLY = 2 # The issue was added to the queue and will be output as dependent issue,
925 925 # but its children will not be added to the queue when it is processed.
926 926
927 927 eRELATIONS_PROCESSED = 3 # The related issues, the parent issue and the issue itself have been added to
928 928 # the queue, but its children have not been added.
929 929
930 930 ePROCESS_CHILDREN_ONLY = 4 # The relations and the parent of the issue have been added to the queue, but
931 931 # the children still need to be processed.
932 932
933 933 eALL_PROCESSED = 5 # The issue and all its children, its parent and its related issues have been
934 934 # added as dependent issues. It needs no further processing.
935 935
936 936 issue_status = Hash.new(eNOT_DISCOVERED)
937 937
938 938 # The queue
939 939 queue = []
940 940
941 941 # Initialize the bfs, add start node (self) to the queue
942 942 queue << self
943 943 issue_status[self] = ePROCESS_ALL
944 944
945 945 while (!queue.empty?) do
946 946 current_issue = queue.shift
947 947 current_issue_status = issue_status[current_issue]
948 948 dependencies << current_issue
949 949
950 950 # Add parent to queue, if not already in it.
951 951 parent = current_issue.parent
952 952 parent_status = issue_status[parent]
953 953
954 954 if parent && (parent_status == eNOT_DISCOVERED) && !except.include?(parent)
955 955 queue << parent
956 956 issue_status[parent] = ePROCESS_RELATIONS_ONLY
957 957 end
958 958
959 959 # Add children to queue, but only if they are not already in it and
960 960 # the children of the current node need to be processed.
961 961 if (current_issue_status == ePROCESS_CHILDREN_ONLY || current_issue_status == ePROCESS_ALL)
962 962 current_issue.children.each do |child|
963 963 next if except.include?(child)
964 964
965 965 if (issue_status[child] == eNOT_DISCOVERED)
966 966 queue << child
967 967 issue_status[child] = ePROCESS_ALL
968 968 elsif (issue_status[child] == eRELATIONS_PROCESSED)
969 969 queue << child
970 970 issue_status[child] = ePROCESS_CHILDREN_ONLY
971 971 elsif (issue_status[child] == ePROCESS_RELATIONS_ONLY)
972 972 queue << child
973 973 issue_status[child] = ePROCESS_ALL
974 974 end
975 975 end
976 976 end
977 977
978 978 # Add related issues to the queue, if they are not already in it.
979 979 current_issue.relations_from.map(&:issue_to).each do |related_issue|
980 980 next if except.include?(related_issue)
981 981
982 982 if (issue_status[related_issue] == eNOT_DISCOVERED)
983 983 queue << related_issue
984 984 issue_status[related_issue] = ePROCESS_ALL
985 985 elsif (issue_status[related_issue] == eRELATIONS_PROCESSED)
986 986 queue << related_issue
987 987 issue_status[related_issue] = ePROCESS_CHILDREN_ONLY
988 988 elsif (issue_status[related_issue] == ePROCESS_RELATIONS_ONLY)
989 989 queue << related_issue
990 990 issue_status[related_issue] = ePROCESS_ALL
991 991 end
992 992 end
993 993
994 994 # Set new status for current issue
995 995 if (current_issue_status == ePROCESS_ALL) || (current_issue_status == ePROCESS_CHILDREN_ONLY)
996 996 issue_status[current_issue] = eALL_PROCESSED
997 997 elsif (current_issue_status == ePROCESS_RELATIONS_ONLY)
998 998 issue_status[current_issue] = eRELATIONS_PROCESSED
999 999 end
1000 1000 end # while
1001 1001
1002 1002 # Remove the issues from the "except" parameter from the result array
1003 1003 dependencies -= except
1004 1004 dependencies.delete(self)
1005 1005
1006 1006 dependencies
1007 1007 end
1008 1008
1009 1009 # Returns an array of issues that duplicate this one
1010 1010 def duplicates
1011 1011 relations_to.select {|r| r.relation_type == IssueRelation::TYPE_DUPLICATES}.collect {|r| r.issue_from}
1012 1012 end
1013 1013
1014 1014 # Returns the due date or the target due date if any
1015 1015 # Used on gantt chart
1016 1016 def due_before
1017 1017 due_date || (fixed_version ? fixed_version.effective_date : nil)
1018 1018 end
1019 1019
1020 1020 # Returns the time scheduled for this issue.
1021 1021 #
1022 1022 # Example:
1023 1023 # Start Date: 2/26/09, End Date: 3/04/09
1024 1024 # duration => 6
1025 1025 def duration
1026 1026 (start_date && due_date) ? due_date - start_date : 0
1027 1027 end
1028 1028
1029 1029 # Returns the duration in working days
1030 1030 def working_duration
1031 1031 (start_date && due_date) ? working_days(start_date, due_date) : 0
1032 1032 end
1033 1033
1034 1034 def soonest_start(reload=false)
1035 1035 @soonest_start = nil if reload
1036 1036 @soonest_start ||= (
1037 1037 relations_to(reload).collect{|relation| relation.successor_soonest_start} +
1038 1038 [(@parent_issue || parent).try(:soonest_start)]
1039 1039 ).compact.max
1040 1040 end
1041 1041
1042 1042 # Sets start_date on the given date or the next working day
1043 1043 # and changes due_date to keep the same working duration.
1044 1044 def reschedule_on(date)
1045 1045 wd = working_duration
1046 1046 date = next_working_date(date)
1047 1047 self.start_date = date
1048 1048 self.due_date = add_working_days(date, wd)
1049 1049 end
1050 1050
1051 1051 # Reschedules the issue on the given date or the next working day and saves the record.
1052 1052 # If the issue is a parent task, this is done by rescheduling its subtasks.
1053 1053 def reschedule_on!(date)
1054 1054 return if date.nil?
1055 1055 if leaf?
1056 1056 if start_date.nil? || start_date != date
1057 1057 if start_date && start_date > date
1058 1058 # Issue can not be moved earlier than its soonest start date
1059 1059 date = [soonest_start(true), date].compact.max
1060 1060 end
1061 1061 reschedule_on(date)
1062 1062 begin
1063 1063 save
1064 1064 rescue ActiveRecord::StaleObjectError
1065 1065 reload
1066 1066 reschedule_on(date)
1067 1067 save
1068 1068 end
1069 1069 end
1070 1070 else
1071 1071 leaves.each do |leaf|
1072 1072 if leaf.start_date
1073 1073 # Only move subtask if it starts at the same date as the parent
1074 1074 # or if it starts before the given date
1075 1075 if start_date == leaf.start_date || date > leaf.start_date
1076 1076 leaf.reschedule_on!(date)
1077 1077 end
1078 1078 else
1079 1079 leaf.reschedule_on!(date)
1080 1080 end
1081 1081 end
1082 1082 end
1083 1083 end
1084 1084
1085 1085 def <=>(issue)
1086 1086 if issue.nil?
1087 1087 -1
1088 1088 elsif root_id != issue.root_id
1089 1089 (root_id || 0) <=> (issue.root_id || 0)
1090 1090 else
1091 1091 (lft || 0) <=> (issue.lft || 0)
1092 1092 end
1093 1093 end
1094 1094
1095 1095 def to_s
1096 1096 "#{tracker} ##{id}: #{subject}"
1097 1097 end
1098 1098
1099 1099 # Returns a string of css classes that apply to the issue
1100 1100 def css_classes(user=User.current)
1101 1101 s = "issue tracker-#{tracker_id} status-#{status_id} #{priority.try(:css_classes)}"
1102 1102 s << ' closed' if closed?
1103 1103 s << ' overdue' if overdue?
1104 1104 s << ' child' if child?
1105 1105 s << ' parent' unless leaf?
1106 1106 s << ' private' if is_private?
1107 1107 if user.logged?
1108 1108 s << ' created-by-me' if author_id == user.id
1109 1109 s << ' assigned-to-me' if assigned_to_id == user.id
1110 1110 s << ' assigned-to-my-group' if user.groups.any? {|g| g.id == assigned_to_id}
1111 1111 end
1112 1112 s
1113 1113 end
1114 1114
1115 1115 # Unassigns issues from +version+ if it's no longer shared with issue's project
1116 1116 def self.update_versions_from_sharing_change(version)
1117 1117 # Update issues assigned to the version
1118 1118 update_versions(["#{Issue.table_name}.fixed_version_id = ?", version.id])
1119 1119 end
1120 1120
1121 1121 # Unassigns issues from versions that are no longer shared
1122 1122 # after +project+ was moved
1123 1123 def self.update_versions_from_hierarchy_change(project)
1124 1124 moved_project_ids = project.self_and_descendants.reload.collect(&:id)
1125 1125 # Update issues of the moved projects and issues assigned to a version of a moved project
1126 1126 Issue.update_versions(
1127 1127 ["#{Version.table_name}.project_id IN (?) OR #{Issue.table_name}.project_id IN (?)",
1128 1128 moved_project_ids, moved_project_ids]
1129 1129 )
1130 1130 end
1131 1131
1132 1132 def parent_issue_id=(arg)
1133 1133 s = arg.to_s.strip.presence
1134 1134 if s && (m = s.match(%r{\A#?(\d+)\z})) && (@parent_issue = Issue.find_by_id(m[1]))
1135 1135 @invalid_parent_issue_id = nil
1136 1136 elsif s.blank?
1137 1137 @parent_issue = nil
1138 1138 @invalid_parent_issue_id = nil
1139 1139 else
1140 1140 @parent_issue = nil
1141 1141 @invalid_parent_issue_id = arg
1142 1142 end
1143 1143 end
1144 1144
1145 1145 def parent_issue_id
1146 1146 if @invalid_parent_issue_id
1147 1147 @invalid_parent_issue_id
1148 1148 elsif instance_variable_defined? :@parent_issue
1149 1149 @parent_issue.nil? ? nil : @parent_issue.id
1150 1150 else
1151 1151 parent_id
1152 1152 end
1153 1153 end
1154 1154
1155 1155 # Returns true if issue's project is a valid
1156 1156 # parent issue project
1157 1157 def valid_parent_project?(issue=parent)
1158 1158 return true if issue.nil? || issue.project_id == project_id
1159 1159
1160 1160 case Setting.cross_project_subtasks
1161 1161 when 'system'
1162 1162 true
1163 1163 when 'tree'
1164 1164 issue.project.root == project.root
1165 1165 when 'hierarchy'
1166 1166 issue.project.is_or_is_ancestor_of?(project) || issue.project.is_descendant_of?(project)
1167 1167 when 'descendants'
1168 1168 issue.project.is_or_is_ancestor_of?(project)
1169 1169 else
1170 1170 false
1171 1171 end
1172 1172 end
1173 1173
1174 1174 # Returns an issue scope based on project and scope
1175 1175 def self.cross_project_scope(project, scope=nil)
1176 1176 if project.nil?
1177 1177 return Issue
1178 1178 end
1179 1179 case scope
1180 1180 when 'all', 'system'
1181 1181 Issue
1182 1182 when 'tree'
1183 1183 Issue.joins(:project).where("(#{Project.table_name}.lft >= :lft AND #{Project.table_name}.rgt <= :rgt)",
1184 1184 :lft => project.root.lft, :rgt => project.root.rgt)
1185 1185 when 'hierarchy'
1186 1186 Issue.joins(:project).where("(#{Project.table_name}.lft >= :lft AND #{Project.table_name}.rgt <= :rgt) OR (#{Project.table_name}.lft < :lft AND #{Project.table_name}.rgt > :rgt)",
1187 1187 :lft => project.lft, :rgt => project.rgt)
1188 1188 when 'descendants'
1189 1189 Issue.joins(:project).where("(#{Project.table_name}.lft >= :lft AND #{Project.table_name}.rgt <= :rgt)",
1190 1190 :lft => project.lft, :rgt => project.rgt)
1191 1191 else
1192 1192 Issue.where(:project_id => project.id)
1193 1193 end
1194 1194 end
1195 1195
1196 1196 def self.by_tracker(project)
1197 1197 count_and_group_by(:project => project, :association => :tracker)
1198 1198 end
1199 1199
1200 1200 def self.by_version(project)
1201 1201 count_and_group_by(:project => project, :association => :fixed_version)
1202 1202 end
1203 1203
1204 1204 def self.by_priority(project)
1205 1205 count_and_group_by(:project => project, :association => :priority)
1206 1206 end
1207 1207
1208 1208 def self.by_category(project)
1209 1209 count_and_group_by(:project => project, :association => :category)
1210 1210 end
1211 1211
1212 1212 def self.by_assigned_to(project)
1213 1213 count_and_group_by(:project => project, :association => :assigned_to)
1214 1214 end
1215 1215
1216 1216 def self.by_author(project)
1217 1217 count_and_group_by(:project => project, :association => :author)
1218 1218 end
1219 1219
1220 1220 def self.by_subproject(project)
1221 1221 r = count_and_group_by(:project => project, :with_subprojects => true, :association => :project)
1222 1222 r.reject {|r| r["project_id"] == project.id.to_s}
1223 1223 end
1224 1224
1225 1225 # Query generator for selecting groups of issue counts for a project
1226 1226 # based on specific criteria
1227 1227 #
1228 1228 # Options
1229 1229 # * project - Project to search in.
1230 1230 # * with_subprojects - Includes subprojects issues if set to true.
1231 1231 # * association - Symbol. Association for grouping.
1232 1232 def self.count_and_group_by(options)
1233 1233 assoc = reflect_on_association(options[:association])
1234 1234 select_field = assoc.foreign_key
1235 1235
1236 1236 Issue.
1237 1237 visible(User.current, :project => options[:project], :with_subprojects => options[:with_subprojects]).
1238 1238 joins(:status, assoc.name).
1239 1239 group(:status_id, :is_closed, select_field).
1240 1240 count.
1241 1241 map do |columns, total|
1242 1242 status_id, is_closed, field_value = columns
1243 1243 is_closed = ['t', 'true', '1'].include?(is_closed.to_s)
1244 1244 {
1245 1245 "status_id" => status_id.to_s,
1246 1246 "closed" => is_closed,
1247 1247 select_field => field_value.to_s,
1248 1248 "total" => total.to_s
1249 1249 }
1250 1250 end
1251 1251 end
1252 1252
1253 1253 # Returns a scope of projects that user can assign the issue to
1254 1254 def allowed_target_projects(user=User.current)
1255 1255 if new_record?
1256 1256 Project.where(Project.allowed_to_condition(user, :add_issues))
1257 1257 else
1258 1258 self.class.allowed_target_projects_on_move(user)
1259 1259 end
1260 1260 end
1261 1261
1262 1262 # Returns a scope of projects that user can move issues to
1263 1263 def self.allowed_target_projects_on_move(user=User.current)
1264 1264 Project.where(Project.allowed_to_condition(user, :move_issues))
1265 1265 end
1266 1266
1267 1267 private
1268 1268
1269 1269 def after_project_change
1270 1270 # Update project_id on related time entries
1271 1271 TimeEntry.where({:issue_id => id}).update_all(["project_id = ?", project_id])
1272 1272
1273 1273 # Delete issue relations
1274 1274 unless Setting.cross_project_issue_relations?
1275 1275 relations_from.clear
1276 1276 relations_to.clear
1277 1277 end
1278 1278
1279 1279 # Move subtasks that were in the same project
1280 1280 children.each do |child|
1281 1281 next unless child.project_id == project_id_was
1282 1282 # Change project and keep project
1283 1283 child.send :project=, project, true
1284 1284 unless child.save
1285 1285 raise ActiveRecord::Rollback
1286 1286 end
1287 1287 end
1288 1288 end
1289 1289
1290 1290 # Callback for after the creation of an issue by copy
1291 1291 # * adds a "copied to" relation with the copied issue
1292 1292 # * copies subtasks from the copied issue
1293 1293 def after_create_from_copy
1294 1294 return unless copy? && !@after_create_from_copy_handled
1295 1295
1296 1296 if (@copied_from.project_id == project_id || Setting.cross_project_issue_relations?) && @copy_options[:link] != false
1297 1297 relation = IssueRelation.new(:issue_from => @copied_from, :issue_to => self, :relation_type => IssueRelation::TYPE_COPIED_TO)
1298 1298 unless relation.save
1299 1299 logger.error "Could not create relation while copying ##{@copied_from.id} to ##{id} due to validation errors: #{relation.errors.full_messages.join(', ')}" if logger
1300 1300 end
1301 1301 end
1302 1302
1303 1303 unless @copied_from.leaf? || @copy_options[:subtasks] == false
1304 1304 copy_options = (@copy_options || {}).merge(:subtasks => false)
1305 1305 copied_issue_ids = {@copied_from.id => self.id}
1306 1306 @copied_from.reload.descendants.reorder("#{Issue.table_name}.lft").each do |child|
1307 1307 # Do not copy self when copying an issue as a descendant of the copied issue
1308 1308 next if child == self
1309 1309 # Do not copy subtasks of issues that were not copied
1310 1310 next unless copied_issue_ids[child.parent_id]
1311 1311 # Do not copy subtasks that are not visible to avoid potential disclosure of private data
1312 1312 unless child.visible?
1313 1313 logger.error "Subtask ##{child.id} was not copied during ##{@copied_from.id} copy because it is not visible to the current user" if logger
1314 1314 next
1315 1315 end
1316 1316 copy = Issue.new.copy_from(child, copy_options)
1317 1317 copy.author = author
1318 1318 copy.project = project
1319 1319 copy.parent_issue_id = copied_issue_ids[child.parent_id]
1320 1320 unless copy.save
1321 1321 logger.error "Could not copy subtask ##{child.id} while copying ##{@copied_from.id} to ##{id} due to validation errors: #{copy.errors.full_messages.join(', ')}" if logger
1322 1322 next
1323 1323 end
1324 1324 copied_issue_ids[child.id] = copy.id
1325 1325 end
1326 1326 end
1327 1327 @after_create_from_copy_handled = true
1328 1328 end
1329 1329
1330 1330 def update_nested_set_attributes
1331 1331 if root_id.nil?
1332 1332 # issue was just created
1333 1333 self.root_id = (@parent_issue.nil? ? id : @parent_issue.root_id)
1334 1334 Issue.where(["id = ?", id]).update_all(["root_id = ?", root_id])
1335 1335 if @parent_issue
1336 1336 move_to_child_of(@parent_issue)
1337 1337 end
1338 1338 elsif parent_issue_id != parent_id
1339 1339 update_nested_set_attributes_on_parent_change
1340 1340 end
1341 1341 remove_instance_variable(:@parent_issue) if instance_variable_defined?(:@parent_issue)
1342 1342 end
1343 1343
1344 1344 # Updates the nested set for when an existing issue is moved
1345 1345 def update_nested_set_attributes_on_parent_change
1346 1346 former_parent_id = parent_id
1347 1347 # moving an existing issue
1348 1348 if @parent_issue && @parent_issue.root_id == root_id
1349 1349 # inside the same tree
1350 1350 move_to_child_of(@parent_issue)
1351 1351 else
1352 1352 # to another tree
1353 1353 unless root?
1354 1354 move_to_right_of(root)
1355 1355 end
1356 1356 old_root_id = root_id
1357 1357 in_tenacious_transaction do
1358 1358 @parent_issue.reload_nested_set if @parent_issue
1359 1359 self.reload_nested_set
1360 1360 self.root_id = (@parent_issue.nil? ? id : @parent_issue.root_id)
1361 1361 cond = ["root_id = ? AND lft >= ? AND rgt <= ? ", old_root_id, lft, rgt]
1362 1362 self.class.base_class.select('id').lock(true).where(cond)
1363 1363 offset = rdm_right_most_bound + 1 - lft
1364 1364 Issue.where(cond).
1365 1365 update_all(["root_id = ?, lft = lft + ?, rgt = rgt + ?", root_id, offset, offset])
1366 1366 end
1367 1367 if @parent_issue
1368 1368 move_to_child_of(@parent_issue)
1369 1369 end
1370 1370 end
1371 1371 # delete invalid relations of all descendants
1372 1372 self_and_descendants.each do |issue|
1373 1373 issue.relations.each do |relation|
1374 1374 relation.destroy unless relation.valid?
1375 1375 end
1376 1376 end
1377 1377 # update former parent
1378 1378 recalculate_attributes_for(former_parent_id) if former_parent_id
1379 1379 end
1380 1380
1381 1381 def rdm_right_most_bound
1382 1382 right_most_node =
1383 1383 self.class.base_class.unscoped.
1384 1384 order("#{quoted_right_column_full_name} desc").limit(1).lock(true).first
1385 1385 right_most_node ? (right_most_node[right_column_name] || 0 ) : 0
1386 1386 end
1387 1387 private :rdm_right_most_bound
1388 1388
1389 1389 def update_parent_attributes
1390 1390 recalculate_attributes_for(parent_id) if parent_id
1391 1391 end
1392 1392
1393 1393 def recalculate_attributes_for(issue_id)
1394 1394 if issue_id && p = Issue.find_by_id(issue_id)
1395 1395 # priority = highest priority of children
1396 1396 if priority_position = p.children.joins(:priority).maximum("#{IssuePriority.table_name}.position")
1397 1397 p.priority = IssuePriority.find_by_position(priority_position)
1398 1398 end
1399 1399
1400 1400 # start/due dates = lowest/highest dates of children
1401 1401 p.start_date = p.children.minimum(:start_date)
1402 1402 p.due_date = p.children.maximum(:due_date)
1403 1403 if p.start_date && p.due_date && p.due_date < p.start_date
1404 1404 p.start_date, p.due_date = p.due_date, p.start_date
1405 1405 end
1406 1406
1407 1407 # done ratio = weighted average ratio of leaves
1408 1408 unless Issue.use_status_for_done_ratio? && p.status && p.status.default_done_ratio
1409 1409 leaves_count = p.leaves.count
1410 1410 if leaves_count > 0
1411 1411 average = p.leaves.where("estimated_hours > 0").average(:estimated_hours).to_f
1412 1412 if average == 0
1413 1413 average = 1
1414 1414 end
1415 1415 done = p.leaves.joins(:status).
1416 1416 sum("COALESCE(CASE WHEN estimated_hours > 0 THEN estimated_hours ELSE NULL END, #{average}) " +
1417 1417 "* (CASE WHEN is_closed = #{self.class.connection.quoted_true} THEN 100 ELSE COALESCE(done_ratio, 0) END)").to_f
1418 1418 progress = done / (average * leaves_count)
1419 1419 p.done_ratio = progress.round
1420 1420 end
1421 1421 end
1422 1422
1423 1423 # estimate = sum of leaves estimates
1424 1424 p.estimated_hours = p.leaves.sum(:estimated_hours).to_f
1425 1425 p.estimated_hours = nil if p.estimated_hours == 0.0
1426 1426
1427 1427 # ancestors will be recursively updated
1428 1428 p.save(:validate => false)
1429 1429 end
1430 1430 end
1431 1431
1432 1432 # Update issues so their versions are not pointing to a
1433 1433 # fixed_version that is not shared with the issue's project
1434 1434 def self.update_versions(conditions=nil)
1435 1435 # Only need to update issues with a fixed_version from
1436 1436 # a different project and that is not systemwide shared
1437 1437 Issue.joins(:project, :fixed_version).
1438 1438 where("#{Issue.table_name}.fixed_version_id IS NOT NULL" +
1439 1439 " AND #{Issue.table_name}.project_id <> #{Version.table_name}.project_id" +
1440 1440 " AND #{Version.table_name}.sharing <> 'system'").
1441 1441 where(conditions).each do |issue|
1442 1442 next if issue.project.nil? || issue.fixed_version.nil?
1443 1443 unless issue.project.shared_versions.include?(issue.fixed_version)
1444 1444 issue.init_journal(User.current)
1445 1445 issue.fixed_version = nil
1446 1446 issue.save
1447 1447 end
1448 1448 end
1449 1449 end
1450 1450
1451 1451 # Callback on file attachment
1452 1452 def attachment_added(obj)
1453 1453 if @current_journal && !obj.new_record?
1454 1454 @current_journal.details << JournalDetail.new(:property => 'attachment', :prop_key => obj.id, :value => obj.filename)
1455 1455 end
1456 1456 end
1457 1457
1458 1458 # Callback on attachment deletion
1459 1459 def attachment_removed(obj)
1460 1460 if @current_journal && !obj.new_record?
1461 1461 @current_journal.details << JournalDetail.new(:property => 'attachment', :prop_key => obj.id, :old_value => obj.filename)
1462 1462 @current_journal.save
1463 1463 end
1464 1464 end
1465 1465
1466 1466 # Default assignment based on category
1467 1467 def default_assign
1468 1468 if assigned_to.nil? && category && category.assigned_to
1469 1469 self.assigned_to = category.assigned_to
1470 1470 end
1471 1471 end
1472 1472
1473 1473 # Updates start/due dates of following issues
1474 1474 def reschedule_following_issues
1475 1475 if start_date_changed? || due_date_changed?
1476 1476 relations_from.each do |relation|
1477 1477 relation.set_issue_to_dates
1478 1478 end
1479 1479 end
1480 1480 end
1481 1481
1482 1482 # Closes duplicates if the issue is being closed
1483 1483 def close_duplicates
1484 1484 if closing?
1485 1485 duplicates.each do |duplicate|
1486 1486 # Reload is needed in case the duplicate was updated by a previous duplicate
1487 1487 duplicate.reload
1488 1488 # Don't re-close it if it's already closed
1489 1489 next if duplicate.closed?
1490 1490 # Same user and notes
1491 1491 if @current_journal
1492 1492 duplicate.init_journal(@current_journal.user, @current_journal.notes)
1493 1493 end
1494 1494 duplicate.update_attribute :status, self.status
1495 1495 end
1496 1496 end
1497 1497 end
1498 1498
1499 1499 # Make sure updated_on is updated when adding a note and set updated_on now
1500 1500 # so we can set closed_on with the same value on closing
1501 1501 def force_updated_on_change
1502 1502 if @current_journal || changed?
1503 1503 self.updated_on = current_time_from_proper_timezone
1504 1504 if new_record?
1505 1505 self.created_on = updated_on
1506 1506 end
1507 1507 end
1508 1508 end
1509 1509
1510 1510 # Callback for setting closed_on when the issue is closed.
1511 1511 # The closed_on attribute stores the time of the last closing
1512 1512 # and is preserved when the issue is reopened.
1513 1513 def update_closed_on
1514 1514 if closing? || (new_record? && closed?)
1515 1515 self.closed_on = updated_on
1516 1516 end
1517 1517 end
1518 1518
1519 1519 # Saves the changes in a Journal
1520 1520 # Called after_save
1521 1521 def create_journal
1522 1522 if @current_journal
1523 1523 # attributes changes
1524 1524 if @attributes_before_change
1525 1525 (Issue.column_names - %w(id root_id lft rgt lock_version created_on updated_on closed_on)).each {|c|
1526 1526 before = @attributes_before_change[c]
1527 1527 after = send(c)
1528 1528 next if before == after || (before.blank? && after.blank?)
1529 1529 @current_journal.details << JournalDetail.new(:property => 'attr',
1530 1530 :prop_key => c,
1531 1531 :old_value => before,
1532 1532 :value => after)
1533 1533 }
1534 1534 end
1535 1535 if @custom_values_before_change
1536 1536 # custom fields changes
1537 1537 custom_field_values.each {|c|
1538 1538 before = @custom_values_before_change[c.custom_field_id]
1539 1539 after = c.value
1540 1540 next if before == after || (before.blank? && after.blank?)
1541 1541
1542 1542 if before.is_a?(Array) || after.is_a?(Array)
1543 1543 before = [before] unless before.is_a?(Array)
1544 1544 after = [after] unless after.is_a?(Array)
1545 1545
1546 1546 # values removed
1547 1547 (before - after).reject(&:blank?).each do |value|
1548 1548 @current_journal.details << JournalDetail.new(:property => 'cf',
1549 1549 :prop_key => c.custom_field_id,
1550 1550 :old_value => value,
1551 1551 :value => nil)
1552 1552 end
1553 1553 # values added
1554 1554 (after - before).reject(&:blank?).each do |value|
1555 1555 @current_journal.details << JournalDetail.new(:property => 'cf',
1556 1556 :prop_key => c.custom_field_id,
1557 1557 :old_value => nil,
1558 1558 :value => value)
1559 1559 end
1560 1560 else
1561 1561 @current_journal.details << JournalDetail.new(:property => 'cf',
1562 1562 :prop_key => c.custom_field_id,
1563 1563 :old_value => before,
1564 1564 :value => after)
1565 1565 end
1566 1566 }
1567 1567 end
1568 1568 @current_journal.save
1569 1569 # reset current journal
1570 1570 init_journal @current_journal.user, @current_journal.notes
1571 1571 end
1572 1572 end
1573 1573
1574 1574 def send_notification
1575 1575 if Setting.notified_events.include?('issue_added')
1576 1576 Mailer.deliver_issue_add(self)
1577 1577 end
1578 1578 end
1579 1579
1580 1580 # Stores the previous assignee so we can still have access
1581 1581 # to it during after_save callbacks (assigned_to_id_was is reset)
1582 1582 def set_assigned_to_was
1583 1583 @previous_assigned_to_id = assigned_to_id_was
1584 1584 end
1585 1585
1586 1586 # Clears the previous assignee at the end of after_save callbacks
1587 1587 def clear_assigned_to_was
1588 1588 @assigned_to_was = nil
1589 1589 @previous_assigned_to_id = nil
1590 1590 end
1591 1591 end
General Comments 0
You need to be logged in to leave comments. Login now