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