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