annotate app/models/issue.rb @ 853:969bb872d4bf feature_142

Close obsolete branch feature_142
author Chris Cannam
date Thu, 14 Jul 2011 14:26:44 +0100
parents 753f1380d6bc
children 851510f1b535
rev   line source
Chris@245 1 # Redmine - project management software
Chris@245 2 # Copyright (C) 2006-2011 Jean-Philippe Lang
Chris@0 3 #
Chris@0 4 # This program is free software; you can redistribute it and/or
Chris@0 5 # modify it under the terms of the GNU General Public License
Chris@0 6 # as published by the Free Software Foundation; either version 2
Chris@0 7 # of the License, or (at your option) any later version.
Chris@441 8 #
Chris@0 9 # This program is distributed in the hope that it will be useful,
Chris@0 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@0 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@0 12 # GNU General Public License for more details.
Chris@441 13 #
Chris@0 14 # You should have received a copy of the GNU General Public License
Chris@0 15 # along with this program; if not, write to the Free Software
Chris@0 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@0 17
Chris@0 18 class Issue < ActiveRecord::Base
Chris@117 19 include Redmine::SafeAttributes
Chris@441 20
Chris@0 21 belongs_to :project
Chris@0 22 belongs_to :tracker
Chris@0 23 belongs_to :status, :class_name => 'IssueStatus', :foreign_key => 'status_id'
Chris@0 24 belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'
Chris@0 25 belongs_to :assigned_to, :class_name => 'User', :foreign_key => 'assigned_to_id'
Chris@0 26 belongs_to :fixed_version, :class_name => 'Version', :foreign_key => 'fixed_version_id'
Chris@0 27 belongs_to :priority, :class_name => 'IssuePriority', :foreign_key => 'priority_id'
Chris@0 28 belongs_to :category, :class_name => 'IssueCategory', :foreign_key => 'category_id'
Chris@0 29
Chris@0 30 has_many :journals, :as => :journalized, :dependent => :destroy
Chris@0 31 has_many :time_entries, :dependent => :delete_all
Chris@0 32 has_and_belongs_to_many :changesets, :order => "#{Changeset.table_name}.committed_on ASC, #{Changeset.table_name}.id ASC"
Chris@441 33
Chris@0 34 has_many :relations_from, :class_name => 'IssueRelation', :foreign_key => 'issue_from_id', :dependent => :delete_all
Chris@0 35 has_many :relations_to, :class_name => 'IssueRelation', :foreign_key => 'issue_to_id', :dependent => :delete_all
Chris@441 36
Chris@210 37 acts_as_nested_set :scope => 'root_id', :dependent => :destroy
Chris@0 38 acts_as_attachable :after_remove => :attachment_removed
Chris@0 39 acts_as_customizable
Chris@0 40 acts_as_watchable
Chris@0 41 acts_as_searchable :columns => ['subject', "#{table_name}.description", "#{Journal.table_name}.notes"],
Chris@0 42 :include => [:project, :journals],
Chris@0 43 # sort by id so that limited eager loading doesn't break with postgresql
Chris@0 44 :order_column => "#{table_name}.id"
Chris@0 45 acts_as_event :title => Proc.new {|o| "#{o.tracker.name} ##{o.id} (#{o.status}): #{o.subject}"},
Chris@0 46 :url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.id}},
Chris@0 47 :type => Proc.new {|o| 'issue' + (o.closed? ? ' closed' : '') }
Chris@441 48
Chris@0 49 acts_as_activity_provider :find_options => {:include => [:project, :author, :tracker]},
Chris@0 50 :author_key => :author_id
Chris@0 51
Chris@0 52 DONE_RATIO_OPTIONS = %w(issue_field issue_status)
Chris@0 53
Chris@0 54 attr_reader :current_journal
Chris@0 55
Chris@0 56 validates_presence_of :subject, :priority, :project, :tracker, :author, :status
Chris@0 57
Chris@0 58 validates_length_of :subject, :maximum => 255
Chris@0 59 validates_inclusion_of :done_ratio, :in => 0..100
Chris@0 60 validates_numericality_of :estimated_hours, :allow_nil => true
Chris@0 61
Chris@0 62 named_scope :visible, lambda {|*args| { :include => :project,
Chris@441 63 :conditions => Issue.visible_condition(args.shift || User.current, *args) } }
Chris@441 64
Chris@0 65 named_scope :open, :conditions => ["#{IssueStatus.table_name}.is_closed = ?", false], :include => :status
Chris@0 66
chris@22 67 named_scope :recently_updated, :order => "#{Issue.table_name}.updated_on DESC"
Chris@0 68 named_scope :with_limit, lambda { |limit| { :limit => limit} }
Chris@0 69 named_scope :on_active_project, :include => [:status, :project, :tracker],
Chris@0 70 :conditions => ["#{Project.table_name}.status=#{Project::STATUS_ACTIVE}"]
chris@22 71
chris@22 72 named_scope :without_version, lambda {
chris@22 73 {
chris@22 74 :conditions => { :fixed_version_id => nil}
chris@22 75 }
chris@22 76 }
chris@22 77
chris@22 78 named_scope :with_query, lambda {|query|
chris@22 79 {
chris@22 80 :conditions => Query.merge_conditions(query.statement)
chris@22 81 }
chris@22 82 }
Chris@0 83
Chris@0 84 before_create :default_assign
chris@37 85 before_save :close_duplicates, :update_done_ratio_from_issue_status
chris@37 86 after_save :reschedule_following_issues, :update_nested_set_attributes, :update_parent_attributes, :create_journal
Chris@0 87 after_destroy :update_parent_attributes
Chris@441 88
Chris@441 89 # Returns a SQL conditions string used to find all issues visible by the specified user
Chris@441 90 def self.visible_condition(user, options={})
Chris@441 91 Project.allowed_to_condition(user, :view_issues, options) do |role, user|
Chris@441 92 case role.issues_visibility
Chris@441 93 when 'all'
Chris@441 94 nil
Chris@441 95 when 'default'
Chris@441 96 "(#{table_name}.is_private = #{connection.quoted_false} OR #{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id = #{user.id})"
Chris@441 97 when 'own'
Chris@441 98 "(#{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id = #{user.id})"
Chris@441 99 else
Chris@441 100 '1=0'
Chris@441 101 end
Chris@441 102 end
Chris@441 103 end
Chris@441 104
Chris@0 105 # Returns true if usr or current user is allowed to view the issue
Chris@0 106 def visible?(usr=nil)
Chris@441 107 (usr || User.current).allowed_to?(:view_issues, self.project) do |role, user|
Chris@441 108 case role.issues_visibility
Chris@441 109 when 'all'
Chris@441 110 true
Chris@441 111 when 'default'
Chris@441 112 !self.is_private? || self.author == user || self.assigned_to == user
Chris@441 113 when 'own'
Chris@441 114 self.author == user || self.assigned_to == user
Chris@441 115 else
Chris@441 116 false
Chris@441 117 end
Chris@441 118 end
Chris@0 119 end
Chris@441 120
Chris@0 121 def after_initialize
Chris@0 122 if new_record?
Chris@0 123 # set default values for new records only
Chris@0 124 self.status ||= IssueStatus.default
Chris@0 125 self.priority ||= IssuePriority.default
Chris@0 126 end
Chris@0 127 end
Chris@441 128
Chris@0 129 # Overrides Redmine::Acts::Customizable::InstanceMethods#available_custom_fields
Chris@0 130 def available_custom_fields
Chris@441 131 (project && tracker) ? (project.all_issue_custom_fields & tracker.custom_fields.all) : []
Chris@0 132 end
Chris@441 133
Chris@0 134 def copy_from(arg)
Chris@0 135 issue = arg.is_a?(Issue) ? arg : Issue.visible.find(arg)
Chris@0 136 self.attributes = issue.attributes.dup.except("id", "root_id", "parent_id", "lft", "rgt", "created_on", "updated_on")
Chris@0 137 self.custom_field_values = issue.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
Chris@0 138 self.status = issue.status
Chris@0 139 self
Chris@0 140 end
Chris@441 141
Chris@0 142 # Moves/copies an issue to a new project and tracker
Chris@0 143 # Returns the moved/copied issue on success, false on failure
Chris@0 144 def move_to_project(*args)
Chris@0 145 ret = Issue.transaction do
Chris@0 146 move_to_project_without_transaction(*args) || raise(ActiveRecord::Rollback)
Chris@0 147 end || false
Chris@0 148 end
Chris@441 149
Chris@0 150 def move_to_project_without_transaction(new_project, new_tracker = nil, options = {})
Chris@0 151 options ||= {}
Chris@0 152 issue = options[:copy] ? self.class.new.copy_from(self) : self
Chris@441 153
Chris@0 154 if new_project && issue.project_id != new_project.id
Chris@0 155 # delete issue relations
Chris@0 156 unless Setting.cross_project_issue_relations?
Chris@0 157 issue.relations_from.clear
Chris@0 158 issue.relations_to.clear
Chris@0 159 end
Chris@0 160 # issue is moved to another project
Chris@0 161 # reassign to the category with same name if any
Chris@0 162 new_category = issue.category.nil? ? nil : new_project.issue_categories.find_by_name(issue.category.name)
Chris@0 163 issue.category = new_category
Chris@0 164 # Keep the fixed_version if it's still valid in the new_project
Chris@0 165 unless new_project.shared_versions.include?(issue.fixed_version)
Chris@0 166 issue.fixed_version = nil
Chris@0 167 end
Chris@0 168 issue.project = new_project
Chris@0 169 if issue.parent && issue.parent.project_id != issue.project_id
Chris@0 170 issue.parent_issue_id = nil
Chris@0 171 end
Chris@0 172 end
Chris@0 173 if new_tracker
Chris@0 174 issue.tracker = new_tracker
Chris@0 175 issue.reset_custom_values!
Chris@0 176 end
Chris@0 177 if options[:copy]
Chris@441 178 issue.author = User.current
Chris@0 179 issue.custom_field_values = self.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
Chris@0 180 issue.status = if options[:attributes] && options[:attributes][:status_id]
Chris@0 181 IssueStatus.find_by_id(options[:attributes][:status_id])
Chris@0 182 else
Chris@0 183 self.status
Chris@0 184 end
Chris@0 185 end
Chris@0 186 # Allow bulk setting of attributes on the issue
Chris@0 187 if options[:attributes]
Chris@0 188 issue.attributes = options[:attributes]
Chris@0 189 end
Chris@0 190 if issue.save
Chris@441 191 if options[:copy]
Chris@441 192 if current_journal && current_journal.notes.present?
Chris@441 193 issue.init_journal(current_journal.user, current_journal.notes)
Chris@441 194 issue.current_journal.notify = false
Chris@441 195 issue.save
Chris@441 196 end
Chris@441 197 else
Chris@0 198 # Manually update project_id on related time entries
Chris@0 199 TimeEntry.update_all("project_id = #{new_project.id}", {:issue_id => id})
Chris@441 200
Chris@0 201 issue.children.each do |child|
Chris@0 202 unless child.move_to_project_without_transaction(new_project)
Chris@0 203 # Move failed and transaction was rollback'd
Chris@0 204 return false
Chris@0 205 end
Chris@0 206 end
Chris@0 207 end
Chris@0 208 else
Chris@0 209 return false
Chris@0 210 end
Chris@0 211 issue
Chris@0 212 end
Chris@0 213
Chris@0 214 def status_id=(sid)
Chris@0 215 self.status = nil
Chris@0 216 write_attribute(:status_id, sid)
Chris@0 217 end
Chris@441 218
Chris@0 219 def priority_id=(pid)
Chris@0 220 self.priority = nil
Chris@0 221 write_attribute(:priority_id, pid)
Chris@0 222 end
Chris@0 223
Chris@0 224 def tracker_id=(tid)
Chris@0 225 self.tracker = nil
Chris@0 226 result = write_attribute(:tracker_id, tid)
Chris@0 227 @custom_field_values = nil
Chris@0 228 result
Chris@0 229 end
Chris@441 230
Chris@0 231 # Overrides attributes= so that tracker_id gets assigned first
Chris@0 232 def attributes_with_tracker_first=(new_attributes, *args)
Chris@0 233 return if new_attributes.nil?
Chris@0 234 new_tracker_id = new_attributes['tracker_id'] || new_attributes[:tracker_id]
Chris@0 235 if new_tracker_id
Chris@0 236 self.tracker_id = new_tracker_id
Chris@0 237 end
Chris@0 238 send :attributes_without_tracker_first=, new_attributes, *args
Chris@0 239 end
Chris@0 240 # Do not redefine alias chain on reload (see #4838)
Chris@0 241 alias_method_chain(:attributes=, :tracker_first) unless method_defined?(:attributes_without_tracker_first=)
Chris@441 242
Chris@0 243 def estimated_hours=(h)
Chris@0 244 write_attribute :estimated_hours, (h.is_a?(String) ? h.to_hours : h)
Chris@0 245 end
Chris@441 246
Chris@117 247 safe_attributes 'tracker_id',
Chris@117 248 'status_id',
Chris@117 249 'parent_issue_id',
Chris@117 250 'category_id',
Chris@117 251 'assigned_to_id',
Chris@117 252 'priority_id',
Chris@117 253 'fixed_version_id',
Chris@117 254 'subject',
Chris@117 255 'description',
Chris@117 256 'start_date',
Chris@117 257 'due_date',
Chris@117 258 'done_ratio',
Chris@117 259 'estimated_hours',
Chris@117 260 'custom_field_values',
Chris@117 261 'custom_fields',
Chris@117 262 'lock_version',
Chris@117 263 :if => lambda {|issue, user| issue.new_record? || user.allowed_to?(:edit_issues, issue.project) }
Chris@441 264
Chris@117 265 safe_attributes 'status_id',
Chris@117 266 'assigned_to_id',
Chris@117 267 'fixed_version_id',
Chris@117 268 'done_ratio',
Chris@117 269 :if => lambda {|issue, user| issue.new_statuses_allowed_to(user).any? }
chris@37 270
Chris@441 271 safe_attributes 'is_private',
Chris@441 272 :if => lambda {|issue, user|
Chris@441 273 user.allowed_to?(:set_issues_private, issue.project) ||
Chris@441 274 (issue.author == user && user.allowed_to?(:set_own_issues_private, issue.project))
Chris@441 275 }
Chris@441 276
Chris@0 277 # Safely sets attributes
Chris@0 278 # Should be called from controllers instead of #attributes=
Chris@0 279 # attr_accessible is too rough because we still want things like
Chris@0 280 # Issue.new(:project => foo) to work
Chris@0 281 # TODO: move workflow/permission checks from controllers to here
Chris@0 282 def safe_attributes=(attrs, user=User.current)
chris@37 283 return unless attrs.is_a?(Hash)
Chris@441 284
chris@37 285 # User can change issue attributes only if he has :edit permission or if a workflow transition is allowed
Chris@117 286 attrs = delete_unsafe_attributes(attrs, user)
Chris@441 287 return if attrs.empty?
Chris@441 288
chris@37 289 # Tracker must be set before since new_statuses_allowed_to depends on it.
chris@37 290 if t = attrs.delete('tracker_id')
chris@37 291 self.tracker_id = t
chris@37 292 end
Chris@441 293
Chris@0 294 if attrs['status_id']
Chris@0 295 unless new_statuses_allowed_to(user).collect(&:id).include?(attrs['status_id'].to_i)
Chris@0 296 attrs.delete('status_id')
Chris@0 297 end
Chris@0 298 end
Chris@441 299
Chris@0 300 unless leaf?
Chris@0 301 attrs.reject! {|k,v| %w(priority_id done_ratio start_date due_date estimated_hours).include?(k)}
Chris@0 302 end
Chris@441 303
Chris@0 304 if attrs.has_key?('parent_issue_id')
Chris@0 305 if !user.allowed_to?(:manage_subtasks, project)
Chris@0 306 attrs.delete('parent_issue_id')
Chris@0 307 elsif !attrs['parent_issue_id'].blank?
Chris@117 308 attrs.delete('parent_issue_id') unless Issue.visible(user).exists?(attrs['parent_issue_id'].to_i)
Chris@0 309 end
Chris@0 310 end
Chris@441 311
Chris@0 312 self.attributes = attrs
Chris@0 313 end
Chris@441 314
Chris@0 315 def done_ratio
chris@37 316 if Issue.use_status_for_done_ratio? && status && status.default_done_ratio
Chris@0 317 status.default_done_ratio
Chris@0 318 else
Chris@0 319 read_attribute(:done_ratio)
Chris@0 320 end
Chris@0 321 end
Chris@0 322
Chris@0 323 def self.use_status_for_done_ratio?
Chris@0 324 Setting.issue_done_ratio == 'issue_status'
Chris@0 325 end
Chris@0 326
Chris@0 327 def self.use_field_for_done_ratio?
Chris@0 328 Setting.issue_done_ratio == 'issue_field'
Chris@0 329 end
Chris@441 330
Chris@0 331 def validate
Chris@0 332 if self.due_date.nil? && @attributes['due_date'] && !@attributes['due_date'].empty?
Chris@0 333 errors.add :due_date, :not_a_date
Chris@0 334 end
Chris@441 335
Chris@0 336 if self.due_date and self.start_date and self.due_date < self.start_date
Chris@0 337 errors.add :due_date, :greater_than_start_date
Chris@0 338 end
Chris@441 339
Chris@0 340 if start_date && soonest_start && start_date < soonest_start
Chris@0 341 errors.add :start_date, :invalid
Chris@0 342 end
Chris@441 343
Chris@0 344 if fixed_version
Chris@0 345 if !assignable_versions.include?(fixed_version)
Chris@0 346 errors.add :fixed_version_id, :inclusion
Chris@0 347 elsif reopened? && fixed_version.closed?
Chris@0 348 errors.add_to_base I18n.t(:error_can_not_reopen_issue_on_closed_version)
Chris@0 349 end
Chris@0 350 end
Chris@441 351
Chris@0 352 # Checks that the issue can not be added/moved to a disabled tracker
Chris@0 353 if project && (tracker_id_changed? || project_id_changed?)
Chris@0 354 unless project.trackers.include?(tracker)
Chris@0 355 errors.add :tracker_id, :inclusion
Chris@0 356 end
Chris@0 357 end
Chris@441 358
Chris@0 359 # Checks parent issue assignment
Chris@0 360 if @parent_issue
Chris@0 361 if @parent_issue.project_id != project_id
Chris@0 362 errors.add :parent_issue_id, :not_same_project
Chris@0 363 elsif !new_record?
Chris@0 364 # moving an existing issue
Chris@0 365 if @parent_issue.root_id != root_id
Chris@0 366 # we can always move to another tree
Chris@0 367 elsif move_possible?(@parent_issue)
Chris@0 368 # move accepted inside tree
Chris@0 369 else
Chris@0 370 errors.add :parent_issue_id, :not_a_valid_parent
Chris@0 371 end
Chris@0 372 end
Chris@0 373 end
Chris@0 374 end
Chris@441 375
Chris@0 376 # Set the done_ratio using the status if that setting is set. This will keep the done_ratios
Chris@0 377 # even if the user turns off the setting later
Chris@0 378 def update_done_ratio_from_issue_status
chris@37 379 if Issue.use_status_for_done_ratio? && status && status.default_done_ratio
Chris@0 380 self.done_ratio = status.default_done_ratio
Chris@0 381 end
Chris@0 382 end
Chris@441 383
Chris@0 384 def init_journal(user, notes = "")
Chris@0 385 @current_journal ||= Journal.new(:journalized => self, :user => user, :notes => notes)
Chris@0 386 @issue_before_change = self.clone
Chris@0 387 @issue_before_change.status = self.status
Chris@0 388 @custom_values_before_change = {}
Chris@0 389 self.custom_values.each {|c| @custom_values_before_change.store c.custom_field_id, c.value }
Chris@0 390 # Make sure updated_on is updated when adding a note.
Chris@0 391 updated_on_will_change!
Chris@0 392 @current_journal
Chris@0 393 end
Chris@441 394
Chris@0 395 # Return true if the issue is closed, otherwise false
Chris@0 396 def closed?
Chris@0 397 self.status.is_closed?
Chris@0 398 end
Chris@441 399
Chris@0 400 # Return true if the issue is being reopened
Chris@0 401 def reopened?
Chris@0 402 if !new_record? && status_id_changed?
Chris@0 403 status_was = IssueStatus.find_by_id(status_id_was)
Chris@0 404 status_new = IssueStatus.find_by_id(status_id)
Chris@0 405 if status_was && status_new && status_was.is_closed? && !status_new.is_closed?
Chris@0 406 return true
Chris@0 407 end
Chris@0 408 end
Chris@0 409 false
Chris@0 410 end
Chris@0 411
Chris@0 412 # Return true if the issue is being closed
Chris@0 413 def closing?
Chris@0 414 if !new_record? && status_id_changed?
Chris@0 415 status_was = IssueStatus.find_by_id(status_id_was)
Chris@0 416 status_new = IssueStatus.find_by_id(status_id)
Chris@0 417 if status_was && status_new && !status_was.is_closed? && status_new.is_closed?
Chris@0 418 return true
Chris@0 419 end
Chris@0 420 end
Chris@0 421 false
Chris@0 422 end
Chris@441 423
Chris@0 424 # Returns true if the issue is overdue
Chris@0 425 def overdue?
Chris@0 426 !due_date.nil? && (due_date < Date.today) && !status.is_closed?
Chris@0 427 end
chris@22 428
chris@22 429 # Is the amount of work done less than it should for the due date
chris@22 430 def behind_schedule?
chris@22 431 return false if start_date.nil? || due_date.nil?
chris@22 432 done_date = start_date + ((due_date - start_date+1)* done_ratio/100).floor
chris@22 433 return done_date <= Date.today
chris@22 434 end
chris@22 435
chris@22 436 # Does this issue have children?
chris@22 437 def children?
chris@22 438 !leaf?
chris@22 439 end
Chris@441 440
Chris@0 441 # Users the issue can be assigned to
Chris@0 442 def assignable_users
chris@37 443 users = project.assignable_users
chris@37 444 users << author if author
chris@37 445 users.uniq.sort
Chris@0 446 end
Chris@441 447
Chris@0 448 # Versions that the issue can be assigned to
Chris@0 449 def assignable_versions
Chris@0 450 @assignable_versions ||= (project.shared_versions.open + [Version.find_by_id(fixed_version_id_was)]).compact.uniq.sort
Chris@0 451 end
Chris@441 452
Chris@0 453 # Returns true if this issue is blocked by another issue that is still open
Chris@0 454 def blocked?
Chris@0 455 !relations_to.detect {|ir| ir.relation_type == 'blocks' && !ir.issue_from.closed?}.nil?
Chris@0 456 end
Chris@441 457
Chris@0 458 # Returns an array of status that user is able to apply
Chris@0 459 def new_statuses_allowed_to(user, include_default=false)
Chris@245 460 statuses = status.find_new_statuses_allowed_to(
Chris@245 461 user.roles_for_project(project),
Chris@245 462 tracker,
Chris@245 463 author == user,
Chris@245 464 assigned_to_id_changed? ? assigned_to_id_was == user.id : assigned_to_id == user.id
Chris@245 465 )
Chris@0 466 statuses << status unless statuses.empty?
Chris@0 467 statuses << IssueStatus.default if include_default
Chris@0 468 statuses = statuses.uniq.sort
Chris@0 469 blocked? ? statuses.reject {|s| s.is_closed?} : statuses
Chris@0 470 end
Chris@441 471
Chris@0 472 # Returns the mail adresses of users that should be notified
Chris@0 473 def recipients
Chris@0 474 notified = project.notified_users
chris@37 475 # Author and assignee are always notified unless they have been
chris@37 476 # locked or don't want to be notified
chris@37 477 notified << author if author && author.active? && author.notify_about?(self)
chris@37 478 notified << assigned_to if assigned_to && assigned_to.active? && assigned_to.notify_about?(self)
Chris@0 479 notified.uniq!
Chris@0 480 # Remove users that can not view the issue
Chris@0 481 notified.reject! {|user| !visible?(user)}
Chris@0 482 notified.collect(&:mail)
Chris@0 483 end
Chris@441 484
Chris@0 485 # Returns the total number of hours spent on this issue and its descendants
Chris@0 486 #
Chris@0 487 # Example:
Chris@0 488 # spent_hours => 0.0
Chris@0 489 # spent_hours => 50.2
Chris@0 490 def spent_hours
Chris@0 491 @spent_hours ||= self_and_descendants.sum("#{TimeEntry.table_name}.hours", :include => :time_entries).to_f || 0.0
Chris@0 492 end
Chris@441 493
Chris@0 494 def relations
Chris@0 495 (relations_from + relations_to).sort
Chris@0 496 end
Chris@441 497
Chris@441 498 def all_dependent_issues(except=[])
Chris@441 499 except << self
Chris@0 500 dependencies = []
Chris@0 501 relations_from.each do |relation|
Chris@441 502 if relation.issue_to && !except.include?(relation.issue_to)
Chris@128 503 dependencies << relation.issue_to
Chris@128 504 dependencies += relation.issue_to.all_dependent_issues(except)
Chris@128 505 end
Chris@0 506 end
Chris@0 507 dependencies
Chris@0 508 end
Chris@441 509
Chris@0 510 # Returns an array of issues that duplicate this one
Chris@0 511 def duplicates
Chris@0 512 relations_to.select {|r| r.relation_type == IssueRelation::TYPE_DUPLICATES}.collect {|r| r.issue_from}
Chris@0 513 end
Chris@441 514
Chris@0 515 # Returns the due date or the target due date if any
Chris@0 516 # Used on gantt chart
Chris@0 517 def due_before
Chris@0 518 due_date || (fixed_version ? fixed_version.effective_date : nil)
Chris@0 519 end
Chris@441 520
Chris@0 521 # Returns the time scheduled for this issue.
Chris@441 522 #
Chris@0 523 # Example:
Chris@0 524 # Start Date: 2/26/09, End Date: 3/04/09
Chris@0 525 # duration => 6
Chris@0 526 def duration
Chris@0 527 (start_date && due_date) ? due_date - start_date : 0
Chris@0 528 end
Chris@441 529
Chris@0 530 def soonest_start
Chris@0 531 @soonest_start ||= (
Chris@0 532 relations_to.collect{|relation| relation.successor_soonest_start} +
Chris@0 533 ancestors.collect(&:soonest_start)
Chris@0 534 ).compact.max
Chris@0 535 end
Chris@441 536
Chris@0 537 def reschedule_after(date)
Chris@0 538 return if date.nil?
Chris@0 539 if leaf?
Chris@0 540 if start_date.nil? || start_date < date
Chris@0 541 self.start_date, self.due_date = date, date + duration
Chris@0 542 save
Chris@0 543 end
Chris@0 544 else
Chris@0 545 leaves.each do |leaf|
Chris@0 546 leaf.reschedule_after(date)
Chris@0 547 end
Chris@0 548 end
Chris@0 549 end
Chris@441 550
Chris@0 551 def <=>(issue)
Chris@0 552 if issue.nil?
Chris@0 553 -1
Chris@0 554 elsif root_id != issue.root_id
Chris@0 555 (root_id || 0) <=> (issue.root_id || 0)
Chris@0 556 else
Chris@0 557 (lft || 0) <=> (issue.lft || 0)
Chris@0 558 end
Chris@0 559 end
Chris@441 560
Chris@0 561 def to_s
Chris@0 562 "#{tracker} ##{id}: #{subject}"
Chris@0 563 end
Chris@441 564
Chris@0 565 # Returns a string of css classes that apply to the issue
Chris@0 566 def css_classes
Chris@112 567 s = "issue status-#{status.position} "
Chris@112 568 s << "priority-#{priority.position}"
Chris@0 569 s << ' closed' if closed?
Chris@0 570 s << ' overdue' if overdue?
Chris@441 571 s << ' child' if child?
Chris@441 572 s << ' parent' unless leaf?
Chris@441 573 s << ' private' if is_private?
Chris@0 574 s << ' created-by-me' if User.current.logged? && author_id == User.current.id
Chris@0 575 s << ' assigned-to-me' if User.current.logged? && assigned_to_id == User.current.id
Chris@0 576 s
Chris@0 577 end
Chris@0 578
Chris@0 579 # Saves an issue, time_entry, attachments, and a journal from the parameters
Chris@0 580 # Returns false if save fails
Chris@0 581 def save_issue_with_child_records(params, existing_time_entry=nil)
Chris@0 582 Issue.transaction do
Chris@441 583 if params[:time_entry] && (params[:time_entry][:hours].present? || params[:time_entry][:comments].present?) && User.current.allowed_to?(:log_time, project)
Chris@0 584 @time_entry = existing_time_entry || TimeEntry.new
Chris@0 585 @time_entry.project = project
Chris@0 586 @time_entry.issue = self
Chris@0 587 @time_entry.user = User.current
Chris@0 588 @time_entry.spent_on = Date.today
Chris@0 589 @time_entry.attributes = params[:time_entry]
Chris@0 590 self.time_entries << @time_entry
Chris@0 591 end
Chris@441 592
Chris@0 593 if valid?
Chris@0 594 attachments = Attachment.attach_files(self, params[:attachments])
Chris@441 595
Chris@0 596 attachments[:files].each {|a| @current_journal.details << JournalDetail.new(:property => 'attachment', :prop_key => a.id, :value => a.filename)}
Chris@0 597 # TODO: Rename hook
Chris@0 598 Redmine::Hook.call_hook(:controller_issues_edit_before_save, { :params => params, :issue => self, :time_entry => @time_entry, :journal => @current_journal})
Chris@0 599 begin
Chris@0 600 if save
Chris@0 601 # TODO: Rename hook
Chris@0 602 Redmine::Hook.call_hook(:controller_issues_edit_after_save, { :params => params, :issue => self, :time_entry => @time_entry, :journal => @current_journal})
Chris@0 603 else
Chris@0 604 raise ActiveRecord::Rollback
Chris@0 605 end
Chris@0 606 rescue ActiveRecord::StaleObjectError
Chris@0 607 attachments[:files].each(&:destroy)
Chris@0 608 errors.add_to_base l(:notice_locking_conflict)
Chris@0 609 raise ActiveRecord::Rollback
Chris@0 610 end
Chris@0 611 end
Chris@0 612 end
Chris@0 613 end
Chris@0 614
Chris@0 615 # Unassigns issues from +version+ if it's no longer shared with issue's project
Chris@0 616 def self.update_versions_from_sharing_change(version)
Chris@0 617 # Update issues assigned to the version
Chris@0 618 update_versions(["#{Issue.table_name}.fixed_version_id = ?", version.id])
Chris@0 619 end
Chris@441 620
Chris@0 621 # Unassigns issues from versions that are no longer shared
Chris@0 622 # after +project+ was moved
Chris@0 623 def self.update_versions_from_hierarchy_change(project)
Chris@0 624 moved_project_ids = project.self_and_descendants.reload.collect(&:id)
Chris@0 625 # Update issues of the moved projects and issues assigned to a version of a moved project
Chris@0 626 Issue.update_versions(["#{Version.table_name}.project_id IN (?) OR #{Issue.table_name}.project_id IN (?)", moved_project_ids, moved_project_ids])
Chris@0 627 end
Chris@0 628
Chris@0 629 def parent_issue_id=(arg)
Chris@0 630 parent_issue_id = arg.blank? ? nil : arg.to_i
Chris@0 631 if parent_issue_id && @parent_issue = Issue.find_by_id(parent_issue_id)
Chris@0 632 @parent_issue.id
Chris@0 633 else
Chris@0 634 @parent_issue = nil
Chris@0 635 nil
Chris@0 636 end
Chris@0 637 end
Chris@441 638
Chris@0 639 def parent_issue_id
Chris@0 640 if instance_variable_defined? :@parent_issue
Chris@0 641 @parent_issue.nil? ? nil : @parent_issue.id
Chris@0 642 else
Chris@0 643 parent_id
Chris@0 644 end
Chris@0 645 end
Chris@0 646
Chris@0 647 # Extracted from the ReportsController.
Chris@0 648 def self.by_tracker(project)
Chris@0 649 count_and_group_by(:project => project,
Chris@0 650 :field => 'tracker_id',
Chris@0 651 :joins => Tracker.table_name)
Chris@0 652 end
Chris@0 653
Chris@0 654 def self.by_version(project)
Chris@0 655 count_and_group_by(:project => project,
Chris@0 656 :field => 'fixed_version_id',
Chris@0 657 :joins => Version.table_name)
Chris@0 658 end
Chris@0 659
Chris@0 660 def self.by_priority(project)
Chris@0 661 count_and_group_by(:project => project,
Chris@0 662 :field => 'priority_id',
Chris@0 663 :joins => IssuePriority.table_name)
Chris@0 664 end
Chris@0 665
Chris@0 666 def self.by_category(project)
Chris@0 667 count_and_group_by(:project => project,
Chris@0 668 :field => 'category_id',
Chris@0 669 :joins => IssueCategory.table_name)
Chris@0 670 end
Chris@0 671
Chris@0 672 def self.by_assigned_to(project)
Chris@0 673 count_and_group_by(:project => project,
Chris@0 674 :field => 'assigned_to_id',
Chris@0 675 :joins => User.table_name)
Chris@0 676 end
Chris@0 677
Chris@0 678 def self.by_author(project)
Chris@0 679 count_and_group_by(:project => project,
Chris@0 680 :field => 'author_id',
Chris@0 681 :joins => User.table_name)
Chris@0 682 end
Chris@0 683
Chris@0 684 def self.by_subproject(project)
Chris@0 685 ActiveRecord::Base.connection.select_all("select s.id as status_id,
Chris@0 686 s.is_closed as closed,
Chris@441 687 #{Issue.table_name}.project_id as project_id,
Chris@441 688 count(#{Issue.table_name}.id) as total
Chris@0 689 from
Chris@441 690 #{Issue.table_name}, #{Project.table_name}, #{IssueStatus.table_name} s
Chris@0 691 where
Chris@441 692 #{Issue.table_name}.status_id=s.id
Chris@441 693 and #{Issue.table_name}.project_id = #{Project.table_name}.id
Chris@441 694 and #{visible_condition(User.current, :project => project, :with_subprojects => true)}
Chris@441 695 and #{Issue.table_name}.project_id <> #{project.id}
Chris@441 696 group by s.id, s.is_closed, #{Issue.table_name}.project_id") if project.descendants.active.any?
Chris@0 697 end
Chris@0 698 # End ReportsController extraction
Chris@441 699
Chris@0 700 # Returns an array of projects that current user can move issues to
Chris@0 701 def self.allowed_target_projects_on_move
Chris@0 702 projects = []
Chris@0 703 if User.current.admin?
Chris@0 704 # admin is allowed to move issues to any active (visible) project
Chris@0 705 projects = Project.visible.all
Chris@0 706 elsif User.current.logged?
Chris@0 707 if Role.non_member.allowed_to?(:move_issues)
Chris@0 708 projects = Project.visible.all
Chris@0 709 else
Chris@0 710 User.current.memberships.each {|m| projects << m.project if m.roles.detect {|r| r.allowed_to?(:move_issues)}}
Chris@0 711 end
Chris@0 712 end
Chris@0 713 projects
Chris@0 714 end
Chris@441 715
Chris@0 716 private
Chris@441 717
Chris@0 718 def update_nested_set_attributes
Chris@0 719 if root_id.nil?
Chris@0 720 # issue was just created
Chris@0 721 self.root_id = (@parent_issue.nil? ? id : @parent_issue.root_id)
Chris@0 722 set_default_left_and_right
Chris@0 723 Issue.update_all("root_id = #{root_id}, lft = #{lft}, rgt = #{rgt}", ["id = ?", id])
Chris@0 724 if @parent_issue
Chris@0 725 move_to_child_of(@parent_issue)
Chris@0 726 end
Chris@0 727 reload
Chris@0 728 elsif parent_issue_id != parent_id
Chris@0 729 former_parent_id = parent_id
Chris@0 730 # moving an existing issue
Chris@0 731 if @parent_issue && @parent_issue.root_id == root_id
Chris@0 732 # inside the same tree
Chris@0 733 move_to_child_of(@parent_issue)
Chris@0 734 else
Chris@0 735 # to another tree
Chris@0 736 unless root?
Chris@0 737 move_to_right_of(root)
Chris@0 738 reload
Chris@0 739 end
Chris@0 740 old_root_id = root_id
Chris@0 741 self.root_id = (@parent_issue.nil? ? id : @parent_issue.root_id )
Chris@0 742 target_maxright = nested_set_scope.maximum(right_column_name) || 0
Chris@0 743 offset = target_maxright + 1 - lft
Chris@0 744 Issue.update_all("root_id = #{root_id}, lft = lft + #{offset}, rgt = rgt + #{offset}",
Chris@0 745 ["root_id = ? AND lft >= ? AND rgt <= ? ", old_root_id, lft, rgt])
Chris@0 746 self[left_column_name] = lft + offset
Chris@0 747 self[right_column_name] = rgt + offset
Chris@0 748 if @parent_issue
Chris@0 749 move_to_child_of(@parent_issue)
Chris@0 750 end
Chris@0 751 end
Chris@0 752 reload
Chris@0 753 # delete invalid relations of all descendants
Chris@0 754 self_and_descendants.each do |issue|
Chris@0 755 issue.relations.each do |relation|
Chris@0 756 relation.destroy unless relation.valid?
Chris@0 757 end
Chris@0 758 end
Chris@0 759 # update former parent
Chris@0 760 recalculate_attributes_for(former_parent_id) if former_parent_id
Chris@0 761 end
Chris@0 762 remove_instance_variable(:@parent_issue) if instance_variable_defined?(:@parent_issue)
Chris@0 763 end
Chris@441 764
Chris@0 765 def update_parent_attributes
Chris@0 766 recalculate_attributes_for(parent_id) if parent_id
Chris@0 767 end
Chris@0 768
Chris@0 769 def recalculate_attributes_for(issue_id)
Chris@0 770 if issue_id && p = Issue.find_by_id(issue_id)
Chris@0 771 # priority = highest priority of children
Chris@0 772 if priority_position = p.children.maximum("#{IssuePriority.table_name}.position", :include => :priority)
Chris@0 773 p.priority = IssuePriority.find_by_position(priority_position)
Chris@0 774 end
Chris@441 775
Chris@0 776 # start/due dates = lowest/highest dates of children
Chris@0 777 p.start_date = p.children.minimum(:start_date)
Chris@0 778 p.due_date = p.children.maximum(:due_date)
Chris@0 779 if p.start_date && p.due_date && p.due_date < p.start_date
Chris@0 780 p.start_date, p.due_date = p.due_date, p.start_date
Chris@0 781 end
Chris@441 782
Chris@0 783 # done ratio = weighted average ratio of leaves
chris@37 784 unless Issue.use_status_for_done_ratio? && p.status && p.status.default_done_ratio
Chris@0 785 leaves_count = p.leaves.count
Chris@0 786 if leaves_count > 0
Chris@0 787 average = p.leaves.average(:estimated_hours).to_f
Chris@0 788 if average == 0
Chris@0 789 average = 1
Chris@0 790 end
Chris@0 791 done = p.leaves.sum("COALESCE(estimated_hours, #{average}) * (CASE WHEN is_closed = #{connection.quoted_true} THEN 100 ELSE COALESCE(done_ratio, 0) END)", :include => :status).to_f
Chris@0 792 progress = done / (average * leaves_count)
Chris@0 793 p.done_ratio = progress.round
Chris@0 794 end
Chris@0 795 end
Chris@441 796
Chris@0 797 # estimate = sum of leaves estimates
Chris@0 798 p.estimated_hours = p.leaves.sum(:estimated_hours).to_f
Chris@0 799 p.estimated_hours = nil if p.estimated_hours == 0.0
Chris@441 800
Chris@0 801 # ancestors will be recursively updated
Chris@0 802 p.save(false)
Chris@0 803 end
Chris@0 804 end
Chris@441 805
Chris@0 806 # Update issues so their versions are not pointing to a
Chris@0 807 # fixed_version that is not shared with the issue's project
Chris@0 808 def self.update_versions(conditions=nil)
Chris@0 809 # Only need to update issues with a fixed_version from
Chris@0 810 # a different project and that is not systemwide shared
Chris@0 811 Issue.all(:conditions => merge_conditions("#{Issue.table_name}.fixed_version_id IS NOT NULL" +
Chris@0 812 " AND #{Issue.table_name}.project_id <> #{Version.table_name}.project_id" +
Chris@0 813 " AND #{Version.table_name}.sharing <> 'system'",
Chris@0 814 conditions),
Chris@0 815 :include => [:project, :fixed_version]
Chris@0 816 ).each do |issue|
Chris@0 817 next if issue.project.nil? || issue.fixed_version.nil?
Chris@0 818 unless issue.project.shared_versions.include?(issue.fixed_version)
Chris@0 819 issue.init_journal(User.current)
Chris@0 820 issue.fixed_version = nil
Chris@0 821 issue.save
Chris@0 822 end
Chris@0 823 end
Chris@0 824 end
Chris@441 825
Chris@0 826 # Callback on attachment deletion
Chris@0 827 def attachment_removed(obj)
Chris@0 828 journal = init_journal(User.current)
Chris@0 829 journal.details << JournalDetail.new(:property => 'attachment',
Chris@0 830 :prop_key => obj.id,
Chris@0 831 :old_value => obj.filename)
Chris@0 832 journal.save
Chris@0 833 end
Chris@441 834
Chris@0 835 # Default assignment based on category
Chris@0 836 def default_assign
Chris@0 837 if assigned_to.nil? && category && category.assigned_to
Chris@0 838 self.assigned_to = category.assigned_to
Chris@0 839 end
Chris@0 840 end
Chris@0 841
Chris@0 842 # Updates start/due dates of following issues
Chris@0 843 def reschedule_following_issues
Chris@0 844 if start_date_changed? || due_date_changed?
Chris@0 845 relations_from.each do |relation|
Chris@0 846 relation.set_issue_to_dates
Chris@0 847 end
Chris@0 848 end
Chris@0 849 end
Chris@0 850
Chris@0 851 # Closes duplicates if the issue is being closed
Chris@0 852 def close_duplicates
Chris@0 853 if closing?
Chris@0 854 duplicates.each do |duplicate|
Chris@0 855 # Reload is need in case the duplicate was updated by a previous duplicate
Chris@0 856 duplicate.reload
Chris@0 857 # Don't re-close it if it's already closed
Chris@0 858 next if duplicate.closed?
Chris@0 859 # Same user and notes
Chris@0 860 if @current_journal
Chris@0 861 duplicate.init_journal(@current_journal.user, @current_journal.notes)
Chris@0 862 end
Chris@0 863 duplicate.update_attribute :status, self.status
Chris@0 864 end
Chris@0 865 end
Chris@0 866 end
Chris@441 867
Chris@0 868 # Saves the changes in a Journal
Chris@0 869 # Called after_save
Chris@0 870 def create_journal
Chris@0 871 if @current_journal
Chris@0 872 # attributes changes
Chris@245 873 (Issue.column_names - %w(id root_id lft rgt lock_version created_on updated_on)).each {|c|
Chris@0 874 @current_journal.details << JournalDetail.new(:property => 'attr',
Chris@0 875 :prop_key => c,
Chris@0 876 :old_value => @issue_before_change.send(c),
Chris@0 877 :value => send(c)) unless send(c)==@issue_before_change.send(c)
Chris@0 878 }
Chris@0 879 # custom fields changes
Chris@0 880 custom_values.each {|c|
Chris@0 881 next if (@custom_values_before_change[c.custom_field_id]==c.value ||
Chris@0 882 (@custom_values_before_change[c.custom_field_id].blank? && c.value.blank?))
Chris@441 883 @current_journal.details << JournalDetail.new(:property => 'cf',
Chris@0 884 :prop_key => c.custom_field_id,
Chris@0 885 :old_value => @custom_values_before_change[c.custom_field_id],
Chris@0 886 :value => c.value)
Chris@441 887 }
Chris@0 888 @current_journal.save
Chris@0 889 # reset current journal
Chris@0 890 init_journal @current_journal.user, @current_journal.notes
Chris@0 891 end
Chris@0 892 end
Chris@0 893
Chris@0 894 # Query generator for selecting groups of issue counts for a project
Chris@0 895 # based on specific criteria
Chris@0 896 #
Chris@0 897 # Options
Chris@0 898 # * project - Project to search in.
Chris@0 899 # * field - String. Issue field to key off of in the grouping.
Chris@0 900 # * joins - String. The table name to join against.
Chris@0 901 def self.count_and_group_by(options)
Chris@0 902 project = options.delete(:project)
Chris@0 903 select_field = options.delete(:field)
Chris@0 904 joins = options.delete(:joins)
Chris@0 905
Chris@441 906 where = "#{Issue.table_name}.#{select_field}=j.id"
Chris@441 907
Chris@0 908 ActiveRecord::Base.connection.select_all("select s.id as status_id,
Chris@0 909 s.is_closed as closed,
Chris@0 910 j.id as #{select_field},
Chris@441 911 count(#{Issue.table_name}.id) as total
Chris@0 912 from
Chris@441 913 #{Issue.table_name}, #{Project.table_name}, #{IssueStatus.table_name} s, #{joins} j
Chris@0 914 where
Chris@441 915 #{Issue.table_name}.status_id=s.id
Chris@0 916 and #{where}
Chris@441 917 and #{Issue.table_name}.project_id=#{Project.table_name}.id
Chris@441 918 and #{visible_condition(User.current, :project => project)}
Chris@0 919 group by s.id, s.is_closed, j.id")
Chris@0 920 end
Chris@0 921 end