issue.rb 14.4 KB
Newer Older
1
# redMine - project management software
2
# Copyright (C) 2006-2007  Jean-Philippe Lang
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

class Issue < ActiveRecord::Base
  belongs_to :project
  belongs_to :tracker
  belongs_to :status, :class_name => 'IssueStatus', :foreign_key => 'status_id'
  belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'
  belongs_to :assigned_to, :class_name => 'User', :foreign_key => 'assigned_to_id'
  belongs_to :fixed_version, :class_name => 'Version', :foreign_key => 'fixed_version_id'
25
  belongs_to :priority, :class_name => 'IssuePriority', :foreign_key => 'priority_id'
26 27 28
  belongs_to :category, :class_name => 'IssueCategory', :foreign_key => 'category_id'

  has_many :journals, :as => :journalized, :dependent => :destroy
29
  has_many :time_entries, :dependent => :delete_all
30
  has_and_belongs_to_many :changesets, :order => "#{Changeset.table_name}.committed_on ASC, #{Changeset.table_name}.id ASC"
31
  
32 33 34
  has_many :relations_from, :class_name => 'IssueRelation', :foreign_key => 'issue_from_id', :dependent => :delete_all
  has_many :relations_to, :class_name => 'IssueRelation', :foreign_key => 'issue_to_id', :dependent => :delete_all
  
35
  acts_as_attachable :after_remove => :attachment_removed
36
  acts_as_customizable
37
  acts_as_watchable
38 39 40 41
  acts_as_searchable :columns => ['subject', "#{table_name}.description", "#{Journal.table_name}.notes"],
                     :include => [:project, :journals],
                     # sort by id so that limited eager loading doesn't break with postgresql
                     :order_column => "#{table_name}.id"
42
  acts_as_event :title => Proc.new {|o| "#{o.tracker.name} ##{o.id} (#{o.status}): #{o.subject}"},
43 44
                :url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.id}},
                :type => Proc.new {|o| 'issue' + (o.closed? ? ' closed' : '') }
45
  
46 47
  acts_as_activity_provider :find_options => {:include => [:project, :author, :tracker]},
                            :author_key => :author_id
jplang's avatar
jplang committed
48
  
49
  validates_presence_of :subject, :priority, :project, :tracker, :author, :status
50
  validates_length_of :subject, :maximum => 255
51
  validates_inclusion_of :done_ratio, :in => 0..100
52
  validates_numericality_of :estimated_hours, :allow_nil => true
53

54 55 56
  named_scope :visible, lambda {|*args| { :include => :project,
                                          :conditions => Project.allowed_to_condition(args.first || User.current, :view_issues) } }
  
jplang's avatar
jplang committed
57 58
  named_scope :open, :conditions => ["#{IssueStatus.table_name}.is_closed = ?", false], :include => :status
  
59 60
  after_save :create_journal
  
61 62 63 64 65
  # Returns true if usr or current user is allowed to view the issue
  def visible?(usr=nil)
    (usr || User.current).allowed_to?(:view_issues, self.project)
  end
  
66 67 68 69
  def after_initialize
    if new_record?
      # set default values for new records only
      self.status ||= IssueStatus.default
70
      self.priority ||= IssuePriority.default
71 72 73
    end
  end
  
74 75 76 77 78
  # Overrides Redmine::Acts::Customizable::InstanceMethods#available_custom_fields
  def available_custom_fields
    (project && tracker) ? project.all_issue_custom_fields.select {|c| tracker.custom_fields.include? c } : []
  end
  
79 80
  def copy_from(arg)
    issue = arg.is_a?(Issue) ? arg : Issue.find(arg)
81
    self.attributes = issue.attributes.dup.except("id", "created_on", "updated_on")
82
    self.custom_values = issue.custom_values.collect {|v| v.clone}
83
    self.status = issue.status
84 85 86
    self
  end
  
87 88 89 90 91
  # Moves/copies an issue to a new project and tracker
  # Returns the moved/copied issue on success, false on failure
  def move_to(new_project, new_tracker = nil, options = {})
    options ||= {}
    issue = options[:copy] ? self.clone : self
92
    transaction do
93
      if new_project && issue.project_id != new_project.id
94
        # delete issue relations
95
        unless Setting.cross_project_issue_relations?
96 97
          issue.relations_from.clear
          issue.relations_to.clear
98
        end
99
        # issue is moved to another project
100
        # reassign to the category with same name if any
101 102
        new_category = issue.category.nil? ? nil : new_project.issue_categories.find_by_name(issue.category.name)
        issue.category = new_category
103 104 105 106
        # Keep the fixed_version if it's still valid in the new_project
        unless new_project.shared_versions.include?(issue.fixed_version)
          issue.fixed_version = nil
        end
107
        issue.project = new_project
108 109
      end
      if new_tracker
110
        issue.tracker = new_tracker
111
      end
112 113
      if options[:copy]
        issue.custom_field_values = self.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
114 115 116 117 118 119 120 121 122
        issue.status = if options[:attributes] && options[:attributes][:status_id]
                         IssueStatus.find_by_id(options[:attributes][:status_id])
                       else
                         self.status
                       end
      end
      # Allow bulk setting of attributes on the issue
      if options[:attributes]
        issue.attributes = options[:attributes]
123 124 125 126 127 128
      end
      if issue.save
        unless options[:copy]
          # Manually update project_id on related time entries
          TimeEntry.update_all("project_id = #{new_project.id}", {:issue_id => id})
        end
129
      else
130
        Issue.connection.rollback_db_transaction
131 132 133
        return false
      end
    end
134
    return issue
135 136
  end
  
137 138 139
  def priority_id=(pid)
    self.priority = nil
    write_attribute(:priority_id, pid)
140
  end
141 142 143 144 145

  def tracker_id=(tid)
    self.tracker = nil
    write_attribute(:tracker_id, tid)
  end
146 147 148 149 150
  
  def estimated_hours=(h)
    write_attribute :estimated_hours, (h.is_a?(String) ? h.to_hours : h)
  end
  
151 152
  def validate
    if self.due_date.nil? && @attributes['due_date'] && !@attributes['due_date'].empty?
153
      errors.add :due_date, :not_a_date
154 155 156
    end
    
    if self.due_date and self.start_date and self.due_date < self.start_date
157
      errors.add :due_date, :greater_than_start_date
158
    end
159 160
    
    if start_date && soonest_start && start_date < soonest_start
161
      errors.add :start_date, :invalid
162
    end
163 164 165 166 167 168 169 170
    
    if fixed_version
      if !assignable_versions.include?(fixed_version)
        errors.add :fixed_version_id, :inclusion
      elsif reopened? && fixed_version.closed?
        errors.add_to_base I18n.t(:error_can_not_reopen_issue_on_closed_version)
      end
    end
171 172 173 174 175 176 177
    
    # Checks that the issue can not be added/moved to a disabled tracker
    if project && (tracker_id_changed? || project_id_changed?)
      unless project.trackers.include?(tracker)
        errors.add :tracker_id, :inclusion
      end
    end
178 179
  end
  
180 181 182 183 184 185 186
  def before_create
    # default assignment based on category
    if assigned_to.nil? && category && category.assigned_to
      self.assigned_to = category.assigned_to
    end
  end
  
187
  def after_save
188 189 190
    # Reload is needed in order to get the right status
    reload
    
191
    # Update start/due dates of following issues
192
    relations_from.each(&:set_issue_to_dates)
193 194 195 196
    
    # Close duplicates if the issue was closed
    if @issue_before_change && !@issue_before_change.closed? && self.closed?
      duplicates.each do |duplicate|
197 198
        # Reload is need in case the duplicate was updated by a previous duplicate
        duplicate.reload
199 200 201 202 203 204 205
        # Don't re-close it if it's already closed
        next if duplicate.closed?
        # Same user and notes
        duplicate.init_journal(@current_journal.user, @current_journal.notes)
        duplicate.update_attribute :status, self.status
      end
    end
206 207 208 209 210
  end
  
  def init_journal(user, notes = "")
    @current_journal ||= Journal.new(:journalized => self, :user => user, :notes => notes)
    @issue_before_change = self.clone
211
    @issue_before_change.status = self.status
212 213
    @custom_values_before_change = {}
    self.custom_values.each {|c| @custom_values_before_change.store c.custom_field_id, c.value }
214 215
    # Make sure updated_on is updated when adding a note.
    updated_on_will_change!
216 217
    @current_journal
  end
218
  
219 220 221 222 223
  # Return true if the issue is closed, otherwise false
  def closed?
    self.status.is_closed?
  end
  
224 225 226 227 228 229 230 231 232 233 234 235
  # Return true if the issue is being reopened
  def reopened?
    if !new_record? && status_id_changed?
      status_was = IssueStatus.find_by_id(status_id_was)
      status_new = IssueStatus.find_by_id(status_id)
      if status_was && status_new && status_was.is_closed? && !status_new.is_closed?
        return true
      end
    end
    false
  end
  
236 237
  # Returns true if the issue is overdue
  def overdue?
238
    !due_date.nil? && (due_date < Date.today) && !status.is_closed?
239 240
  end
  
241 242
  # Users the issue can be assigned to
  def assignable_users
243
    project.assignable_users
244 245
  end
  
246 247
  # Versions that the issue can be assigned to
  def assignable_versions
248
    @assignable_versions ||= (project.shared_versions.open + [Version.find_by_id(fixed_version_id_was)]).compact.uniq.sort
249 250
  end
  
251 252 253 254 255
  # Returns true if this issue is blocked by another issue that is still open
  def blocked?
    !relations_to.detect {|ir| ir.relation_type == 'blocks' && !ir.issue_from.closed?}.nil?
  end
  
256 257
  # Returns an array of status that user is able to apply
  def new_statuses_allowed_to(user)
258
    statuses = status.find_new_statuses_allowed_to(user.roles_for_project(project), tracker)
259
    statuses << status unless statuses.empty?
260 261
    statuses = statuses.uniq.sort
    blocked? ? statuses.reject {|s| s.is_closed?} : statuses
262 263
  end
  
264
  # Returns the mail adresses of users that should be notified
265
  def recipients
266
    notified = project.notified_users
267
    # Author and assignee are always notified unless they have been locked
268 269 270 271 272 273 274 275 276 277 278 279 280
    notified << author if author && author.active?
    notified << assigned_to if assigned_to && assigned_to.active?
    notified.uniq!
    # Remove users that can not view the issue
    notified.reject! {|user| !visible?(user)}
    notified.collect(&:mail)
  end
  
  # Returns the mail adresses of watchers that should be notified
  def watcher_recipients
    notified = watcher_users
    notified.reject! {|user| !user.active? || !visible?(user)}
    notified.collect(&:mail)
281 282
  end
  
283 284 285 286 287
  # Returns the total number of hours spent on this issue.
  #
  # Example:
  #   spent_hours => 0
  #   spent_hours => 50
288 289 290
  def spent_hours
    @spent_hours ||= time_entries.sum(:hours) || 0
  end
291 292 293 294 295 296 297 298 299 300 301 302 303 304
  
  def relations
    (relations_from + relations_to).sort
  end
  
  def all_dependent_issues
    dependencies = []
    relations_from.each do |relation|
      dependencies << relation.issue_to
      dependencies += relation.issue_to.all_dependent_issues
    end
    dependencies
  end
  
305
  # Returns an array of issues that duplicate this one
306
  def duplicates
307
    relations_to.select {|r| r.relation_type == IssueRelation::TYPE_DUPLICATES}.collect {|r| r.issue_from}
308 309
  end
  
310 311 312 313 314 315
  # Returns the due date or the target due date if any
  # Used on gantt chart
  def due_before
    due_date || (fixed_version ? fixed_version.effective_date : nil)
  end
  
316 317 318 319 320
  # Returns the time scheduled for this issue.
  # 
  # Example:
  #   Start Date: 2/26/09, End Date: 3/04/09
  #   duration => 6
321 322 323 324 325 326 327
  def duration
    (start_date && due_date) ? due_date - start_date : 0
  end
  
  def soonest_start
    @soonest_start ||= relations_to.collect{|relation| relation.successor_soonest_start}.compact.min
  end
328
  
329 330 331
  def to_s
    "#{tracker} ##{id}: #{subject}"
  end
332
  
333 334 335 336 337 338 339 340 341
  # Returns a string of css classes that apply to the issue
  def css_classes
    s = "issue status-#{status.position} priority-#{priority.position}"
    s << ' closed' if closed?
    s << ' overdue' if overdue?
    s << ' created-by-me' if User.current.logged? && author_id == User.current.id
    s << ' assigned-to-me' if User.current.logged? && assigned_to_id == User.current.id
    s
  end
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358

  # Update all issues so their versions are not pointing to a
  # fixed_version that is outside of the issue's project hierarchy.
  #
  # OPTIMIZE: does a full table scan of Issues with a fixed_version.
  def self.update_fixed_versions_from_project_hierarchy_change
    Issue.all(:conditions => ['fixed_version_id IS NOT NULL'],
              :include => [:project, :fixed_version]
              ).each do |issue|
      next if issue.project.nil? || issue.fixed_version.nil?
      unless issue.project.shared_versions.include?(issue.fixed_version)
        issue.init_journal(User.current)
        issue.fixed_version = nil
        issue.save
      end
    end
  end
359
  
360 361 362 363 364 365 366 367 368 369
  private
  
  # Callback on attachment deletion
  def attachment_removed(obj)
    journal = init_journal(User.current)
    journal.details << JournalDetail.new(:property => 'attachment',
                                         :prop_key => obj.id,
                                         :old_value => obj.filename)
    journal.save
  end
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
  
  # Saves the changes in a Journal
  # Called after_save
  def create_journal
    if @current_journal
      # attributes changes
      (Issue.column_names - %w(id description lock_version created_on updated_on)).each {|c|
        @current_journal.details << JournalDetail.new(:property => 'attr',
                                                      :prop_key => c,
                                                      :old_value => @issue_before_change.send(c),
                                                      :value => send(c)) unless send(c)==@issue_before_change.send(c)
      }
      # custom fields changes
      custom_values.each {|c|
        next if (@custom_values_before_change[c.custom_field_id]==c.value ||
                  (@custom_values_before_change[c.custom_field_id].blank? && c.value.blank?))
        @current_journal.details << JournalDetail.new(:property => 'cf', 
                                                      :prop_key => c.custom_field_id,
                                                      :old_value => @custom_values_before_change[c.custom_field_id],
                                                      :value => c.value)
      }      
      @current_journal.save
    end
  end
jplang's avatar
jplang committed
394
end