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