To check out this repository please hg clone the following URL, or open the URL using EasyMercurial or your preferred Mercurial client.

Statistics Download as Zip
| Branch: | Tag: | Revision:

root / app / models / issue.rb @ 1298:4f746d8966dd

History | View | Annotate | Download (50.8 KB)

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