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