issue.rb
1563 lines
| 52.9 KiB
| text/x-ruby
|
RubyLexer
|
r4834 | # Redmine - project management software | ||
|
r13490 | # Copyright (C) 2006-2015 Jean-Philippe Lang | ||
|
r330 | # | ||
# 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. | ||||
|
r5690 | # | ||
|
r330 | # 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. | ||||
|
r5690 | # | ||
|
r330 | # 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 | ||||
|
r4377 | include Redmine::SafeAttributes | ||
|
r10531 | include Redmine::Utils::DateCalculation | ||
|
r11696 | include Redmine::I18n | ||
|
r13459 | before_save :set_parent_id | ||
include Redmine::NestedSet::IssueNestedSet | ||||
|
r5690 | |||
|
r330 | belongs_to :project | ||
belongs_to :tracker | ||||
|
r13102 | belongs_to :status, :class_name => 'IssueStatus' | ||
belongs_to :author, :class_name => 'User' | ||||
belongs_to :assigned_to, :class_name => 'Principal' | ||||
belongs_to :fixed_version, :class_name => 'Version' | ||||
belongs_to :priority, :class_name => 'IssuePriority' | ||||
belongs_to :category, :class_name => 'IssueCategory' | ||||
|
r330 | |||
|
r13541 | has_many :journals, :as => :journalized, :dependent => :destroy, :inverse_of => :journalized | ||
|
r10336 | has_many :visible_journals, | ||
|
r13100 | lambda {where(["(#{Journal.table_name}.private_notes = ? OR (#{Project.allowed_to_condition(User.current, :view_private_notes)}))", false])}, | ||
|
r10336 | :class_name => 'Journal', | ||
|
r13100 | :as => :journalized | ||
|
r10336 | |||
|
r12146 | has_many :time_entries, :dependent => :destroy | ||
|
r13100 | has_and_belongs_to_many :changesets, lambda {order("#{Changeset.table_name}.committed_on ASC, #{Changeset.table_name}.id ASC")} | ||
|
r5690 | |||
|
r503 | 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 | ||||
|
r5690 | |||
|
r6192 | acts_as_attachable :after_add => :attachment_added, :after_remove => :attachment_removed | ||
|
r1578 | acts_as_customizable | ||
|
r450 | acts_as_watchable | ||
|
r13473 | acts_as_searchable :columns => ['subject', "#{table_name}.description"], | ||
|
r13476 | :preload => [:project, :status, :tracker], | ||
:scope => lambda {|options| options[:open_issues] ? self.open : self.all} | ||||
|
r13100 | |||
|
r2729 | acts_as_event :title => Proc.new {|o| "#{o.tracker.name} ##{o.id} (#{o.status}): #{o.subject}"}, | ||
|
r2254 | :url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.id}}, | ||
:type => Proc.new {|o| 'issue' + (o.closed? ? ' closed' : '') } | ||||
|
r5690 | |||
|
r13100 | acts_as_activity_provider :scope => preload(:project, :author, :tracker), | ||
|
r2064 | :author_key => :author_id | ||
|
r3037 | |||
DONE_RATIO_OPTIONS = %w(issue_field issue_status) | ||||
|
r3426 | |||
attr_reader :current_journal | ||||
|
r10336 | delegate :notes, :notes=, :private_notes, :private_notes=, :to => :current_journal, :allow_nil => true | ||
|
r3443 | |||
|
r13341 | validates_presence_of :subject, :project, :tracker | ||
validates_presence_of :priority, :if => Proc.new {|issue| issue.new_record? || issue.priority_id_changed?} | ||||
validates_presence_of :status, :if => Proc.new {|issue| issue.new_record? || issue.status_id_changed?} | ||||
validates_presence_of :author, :if => Proc.new {|issue| issue.new_record? || issue.author_id_changed?} | ||||
|
r3443 | |||
|
r590 | validates_length_of :subject, :maximum => 255 | ||
|
r330 | validates_inclusion_of :done_ratio, :in => 0..100 | ||
|
r10895 | validates :estimated_hours, :numericality => {:greater_than_or_equal_to => 0, :allow_nil => true, :message => :invalid} | ||
|
r10894 | validates :start_date, :date => true | ||
validates :due_date, :date => true | ||||
|
r9794 | validate :validate_issue, :validate_required_fields | ||
|
r13100 | attr_protected :id | ||
|
r330 | |||
|
r10723 | scope :visible, lambda {|*args| | ||
|
r13510 | joins(:project). | ||
|
r13100 | where(Issue.visible_condition(args.shift || User.current, *args)) | ||
|
r10723 | } | ||
|
r5690 | |||
|
r9355 | scope :open, lambda {|*args| | ||
|
r8165 | is_closed = args.size > 0 ? !args.first : false | ||
|
r13100 | joins(:status). | ||
where("#{IssueStatus.table_name}.is_closed = ?", is_closed) | ||||
|
r8165 | } | ||
|
r3037 | |||
|
r10723 | scope :recently_updated, lambda { order("#{Issue.table_name}.updated_on DESC") } | ||
scope :on_active_project, lambda { | ||||
|
r13100 | joins(:project). | ||
where("#{Project.table_name}.status = ?", Project::STATUS_ACTIVE) | ||||
|
r10723 | } | ||
|
r10905 | scope :fixed_version, lambda {|versions| | ||
ids = [versions].flatten.compact.map {|v| v.is_a?(Version) ? v.id : v} | ||||
ids.any? ? where(:fixed_version_id => ids) : where('1=0') | ||||
} | ||||
|
r3958 | |||
|
r3385 | before_create :default_assign | ||
|
r12000 | before_save :close_duplicates, :update_done_ratio_from_issue_status, | ||
|
r12144 | :force_updated_on_change, :update_closed_on, :set_assigned_to_was | ||
|
r12807 | after_save {|issue| issue.send :after_project_change if !issue.id_changed? && issue.project_id_changed?} | ||
|
r12000 | after_save :reschedule_following_issues, :update_nested_set_attributes, | ||
:update_parent_attributes, :create_journal | ||||
|
r10144 | # Should be after_create but would be called before previous after_save callbacks | ||
after_save :after_create_from_copy | ||||
|
r3459 | after_destroy :update_parent_attributes | ||
|
r11791 | after_create :send_notification | ||
|
r12144 | # Keep it at the end of after_save callbacks | ||
after_save :clear_assigned_to_was | ||||
|
r5690 | |||
|
r5021 | # Returns a SQL conditions string used to find all issues visible by the specified user | ||
def self.visible_condition(user, options={}) | ||||
|
r5296 | Project.allowed_to_condition(user, :view_issues, options) do |role, user| | ||
|
r13100 | if user.id && user.logged? | ||
|
r10254 | case role.issues_visibility | ||
when 'all' | ||||
nil | ||||
when 'default' | ||||
|
r11932 | user_ids = [user.id] + user.groups.map(&:id).compact | ||
|
r10250 | "(#{table_name}.is_private = #{connection.quoted_false} OR #{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id IN (#{user_ids.join(',')}))" | ||
|
r10254 | when 'own' | ||
|
r11932 | user_ids = [user.id] + user.groups.map(&:id).compact | ||
|
r10250 | "(#{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id IN (#{user_ids.join(',')}))" | ||
else | ||||
'1=0' | ||||
end | ||||
|
r5296 | else | ||
|
r10254 | "(#{table_name}.is_private = #{connection.quoted_false})" | ||
|
r5296 | end | ||
end | ||||
|
r5021 | end | ||
|
r2341 | # Returns true if usr or current user is allowed to view the issue | ||
def visible?(usr=nil) | ||||
|
r5296 | (usr || User.current).allowed_to?(:view_issues, self.project) do |role, user| | ||
|
r10254 | if user.logged? | ||
case role.issues_visibility | ||||
when 'all' | ||||
true | ||||
when 'default' | ||||
!self.is_private? || (self.author == user || user.is_or_belongs_to?(assigned_to)) | ||||
when 'own' | ||||
self.author == user || user.is_or_belongs_to?(assigned_to) | ||||
else | ||||
false | ||||
end | ||||
|
r5296 | else | ||
|
r10254 | !self.is_private? | ||
|
r5296 | end | ||
end | ||||
|
r2341 | end | ||
|
r5690 | |||
|
r10838 | # Returns true if user or current user is allowed to edit or add a note to the issue | ||
def editable?(user=User.current) | ||||
|
r13614 | attributes_editable?(user) || user.allowed_to?(:add_issue_notes, project) | ||
end | ||||
# Returns true if user or current user is allowed to edit the issue | ||||
def attributes_editable?(user=User.current) | ||||
user.allowed_to?(:edit_issues, project) | ||||
|
r10838 | end | ||
|
r8168 | def initialize(attributes=nil, *args) | ||
super | ||||
|
r792 | if new_record? | ||
# set default values for new records only | ||||
|
r2677 | self.priority ||= IssuePriority.default | ||
|
r8434 | self.watcher_user_ids = [] | ||
|
r792 | end | ||
end | ||||
|
r5690 | |||
|
r11182 | def create_or_update | ||
super | ||||
ensure | ||||
@status_was = nil | ||||
end | ||||
private :create_or_update | ||||
|
r9675 | # AR#Persistence#destroy would raise and RecordNotFound exception | ||
# if the issue was already deleted or updated (non matching lock_version). | ||||
# This is a problem when bulk deleting issues or deleting a project | ||||
# (because an issue may already be deleted if its parent was deleted | ||||
# first). | ||||
# The issue is reloaded by the nested_set before being deleted so | ||||
# the lock_version condition should not be an issue but we handle it. | ||||
def destroy | ||||
super | ||||
|
r13459 | rescue ActiveRecord::StaleObjectError, ActiveRecord::RecordNotFound | ||
|
r9675 | # Stale or already deleted | ||
begin | ||||
reload | ||||
rescue ActiveRecord::RecordNotFound | ||||
# The issue was actually already deleted | ||||
@destroyed = true | ||||
return freeze | ||||
end | ||||
# The issue was stale, retry to destroy | ||||
super | ||||
end | ||||
|
r11267 | alias :base_reload :reload | ||
|
r9794 | def reload(*args) | ||
@workflow_rule_by_attribute = nil | ||||
|
r9903 | @assignable_versions = nil | ||
|
r11231 | @relations = nil | ||
|
r13243 | @spent_hours = nil | ||
|
r11267 | base_reload(*args) | ||
|
r9794 | end | ||
|
r1578 | # Overrides Redmine::Acts::Customizable::InstanceMethods#available_custom_fields | ||
def available_custom_fields | ||||
|
r12638 | (project && tracker) ? (project.all_issue_custom_fields & tracker.custom_fields) : [] | ||
|
r1578 | end | ||
|
r5690 | |||
|
r11782 | def visible_custom_field_values(user=nil) | ||
user_real = user || User.current | ||||
custom_field_values.select do |value| | ||||
value.custom_field.visible_by?(project, user_real) | ||||
end | ||||
end | ||||
|
r8432 | # Copies attributes from another issue, arg can be an id or an Issue | ||
|
r8557 | def copy_from(arg, options={}) | ||
|
r3584 | issue = arg.is_a?(Issue) ? arg : Issue.visible.find(arg) | ||
|
r3459 | self.attributes = issue.attributes.dup.except("id", "root_id", "parent_id", "lft", "rgt", "created_on", "updated_on") | ||
self.custom_field_values = issue.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h} | ||||
|
r2961 | self.status = issue.status | ||
|
r8405 | self.author = User.current | ||
|
r8557 | unless options[:attachments] == false | ||
|
r12807 | self.attachments = issue.attachments.map do |attachement| | ||
|
r8557 | attachement.copy(:container => self) | ||
end | ||||
|
r8556 | end | ||
|
r8432 | @copied_from = issue | ||
|
r10144 | @copy_options = options | ||
|
r860 | self | ||
end | ||||
|
r5690 | |||
|
r8419 | # Returns an unsaved copy of the issue | ||
|
r9271 | def copy(attributes=nil, copy_options={}) | ||
copy = self.class.new.copy_from(self, copy_options) | ||||
|
r8419 | copy.attributes = attributes if attributes | ||
copy | ||||
end | ||||
|
r8432 | # Returns true if the issue is a copy | ||
def copy? | ||||
@copied_from.present? | ||||
end | ||||
|
r13153 | def status_id=(status_id) | ||
if status_id.to_s != self.status_id.to_s | ||||
self.status = (status_id.present? ? IssueStatus.find_by_id(status_id) : nil) | ||||
end | ||||
self.status_id | ||||
end | ||||
# Sets the status. | ||||
|
r13330 | def status=(status) | ||
|
r13153 | if status != self.status | ||
@workflow_rule_by_attribute = nil | ||||
end | ||||
association(:status).writer(status) | ||||
|
r3492 | end | ||
|
r5690 | |||
|
r792 | def priority_id=(pid) | ||
self.priority = nil | ||||
write_attribute(:priority_id, pid) | ||||
|
r330 | end | ||
|
r2994 | |||
|
r8411 | def category_id=(cid) | ||
self.category = nil | ||||
write_attribute(:category_id, cid) | ||||
end | ||||
def fixed_version_id=(vid) | ||||
self.fixed_version = nil | ||||
write_attribute(:fixed_version_id, vid) | ||||
end | ||||
|
r13131 | def tracker_id=(tracker_id) | ||
if tracker_id.to_s != self.tracker_id.to_s | ||||
self.tracker = (tracker_id.present? ? Tracker.find_by_id(tracker_id) : nil) | ||||
end | ||||
self.tracker_id | ||||
end | ||||
|
r13153 | # Sets the tracker. | ||
# This will set the status to the default status of the new tracker if: | ||||
# * the status was the default for the previous tracker | ||||
# * or if the status was not part of the new tracker statuses | ||||
# * or the status was nil | ||||
|
r13131 | def tracker=(tracker) | ||
if tracker != self.tracker | ||||
|
r13153 | if status == default_status | ||
self.status = nil | ||||
elsif status && tracker && !tracker.issue_status_ids.include?(status.id) | ||||
self.status = nil | ||||
end | ||||
|
r13131 | @custom_field_values = nil | ||
@workflow_rule_by_attribute = nil | ||||
end | ||||
association(:tracker).writer(tracker) | ||||
|
r13153 | self.status ||= default_status | ||
self.tracker | ||||
|
r2994 | end | ||
|
r6396 | |||
|
r8404 | def project_id=(project_id) | ||
if project_id.to_s != self.project_id.to_s | ||||
self.project = (project_id.present? ? Project.find_by_id(project_id) : nil) | ||||
end | ||||
|
r13131 | self.project_id | ||
|
r8404 | end | ||
|
r13153 | # Sets the project. | ||
# Unless keep_tracker argument is set to true, this will change the tracker | ||||
# to the first tracker of the new project if the previous tracker is not part | ||||
# of the new project trackers. | ||||
# This will clear the fixed_version is it's no longer valid for the new project. | ||||
# This will clear the parent issue if it's no longer valid for the new project. | ||||
# This will set the category to the category with the same name in the new | ||||
# project if it exists, or clear it if it doesn't. | ||||
|
r8411 | def project=(project, keep_tracker=false) | ||
|
r8404 | project_was = self.project | ||
|
r13131 | association(:project).writer(project) | ||
|
r8404 | if project_was && project && project_was != project | ||
|
r9903 | @assignable_versions = nil | ||
|
r8411 | unless keep_tracker || project.trackers.include?(tracker) | ||
self.tracker = project.trackers.first | ||||
end | ||||
|
r8404 | # Reassign to the category with same name if any | ||
if category | ||||
self.category = project.issue_categories.find_by_name(category.name) | ||||
end | ||||
# Keep the fixed_version if it's still valid in the new_project | ||||
if fixed_version && fixed_version.project != project && !project.shared_versions.include?(fixed_version) | ||||
self.fixed_version = nil | ||||
end | ||||
|
r10376 | # Clear the parent task if it's no longer valid | ||
unless valid_parent_project? | ||||
|
r8404 | self.parent_issue_id = nil | ||
end | ||||
@custom_field_values = nil | ||||
|
r13153 | @workflow_rule_by_attribute = nil | ||
|
r8404 | end | ||
|
r13153 | self.project | ||
|
r8404 | end | ||
|
r6029 | def description=(arg) | ||
if arg.is_a?(String) | ||||
arg = arg.gsub(/(\r\n|\n|\r)/, "\r\n") | ||||
end | ||||
write_attribute(:description, arg) | ||||
end | ||||
|
r5690 | |||
|
r9346 | # Overrides assign_attributes so that project and tracker get assigned first | ||
def assign_attributes_with_project_and_tracker_first(new_attributes, *args) | ||||
|
r3025 | return if new_attributes.nil? | ||
|
r8011 | attrs = new_attributes.dup | ||
attrs.stringify_keys! | ||||
%w(project project_id tracker tracker_id).each do |attr| | ||||
if attrs.has_key?(attr) | ||||
send "#{attr}=", attrs.delete(attr) | ||||
end | ||||
|
r3025 | end | ||
|
r9346 | send :assign_attributes_without_project_and_tracker_first, attrs, *args | ||
|
r3025 | end | ||
|
r3313 | # Do not redefine alias chain on reload (see #4838) | ||
|
r9346 | alias_method_chain(:assign_attributes, :project_and_tracker_first) unless method_defined?(:assign_attributes_without_project_and_tracker_first) | ||
|
r5690 | |||
|
r13100 | def attributes=(new_attributes) | ||
assign_attributes new_attributes | ||||
end | ||||
|
r1346 | def estimated_hours=(h) | ||
write_attribute :estimated_hours, (h.is_a?(String) ? h.to_hours : h) | ||||
end | ||||
|
r5690 | |||
|
r8411 | safe_attributes 'project_id', | ||
|
r13617 | 'tracker_id', | ||
|
r4377 | 'status_id', | ||
'category_id', | ||||
'assigned_to_id', | ||||
'priority_id', | ||||
'fixed_version_id', | ||||
'subject', | ||||
'description', | ||||
'start_date', | ||||
'due_date', | ||||
'done_ratio', | ||||
'estimated_hours', | ||||
'custom_field_values', | ||||
'custom_fields', | ||||
'lock_version', | ||||
|
r10336 | 'notes', | ||
|
r4377 | :if => lambda {|issue, user| issue.new_record? || user.allowed_to?(:edit_issues, issue.project) } | ||
|
r5690 | |||
|
r10336 | safe_attributes 'notes', | ||
:if => lambda {|issue, user| user.allowed_to?(:add_issue_notes, issue.project)} | ||||
safe_attributes 'private_notes', | ||||
|
r12807 | :if => lambda {|issue, user| !issue.new_record? && user.allowed_to?(:set_notes_private, issue.project)} | ||
|
r10336 | |||
|
r8077 | safe_attributes 'watcher_user_ids', | ||
|
r12807 | :if => lambda {|issue, user| issue.new_record? && user.allowed_to?(:add_issue_watchers, issue.project)} | ||
|
r8077 | |||
|
r5346 | safe_attributes 'is_private', | ||
:if => lambda {|issue, user| | ||||
user.allowed_to?(:set_issues_private, issue.project) || | ||||
|
r13194 | (issue.author_id == user.id && user.allowed_to?(:set_own_issues_private, issue.project)) | ||
|
r5346 | } | ||
|
r5690 | |||
|
r8078 | safe_attributes 'parent_issue_id', | ||
:if => lambda {|issue, user| (issue.new_record? || user.allowed_to?(:edit_issues, issue.project)) && | ||||
user.allowed_to?(:manage_subtasks, issue.project)} | ||||
|
r9794 | def safe_attribute_names(user=nil) | ||
names = super | ||||
|
r9729 | names -= disabled_core_fields | ||
|
r9794 | names -= read_only_attribute_names(user) | ||
|
r13617 | if new_record? | ||
# Make sure that project_id can always be set for new issues | ||||
|
r13603 | names |= %w(project_id) | ||
end | ||||
|
r9729 | names | ||
end | ||||
|
r3194 | # Safely sets attributes | ||
# Should be called from controllers instead of #attributes= | ||||
# attr_accessible is too rough because we still want things like | ||||
# Issue.new(:project => foo) to work | ||||
def safe_attributes=(attrs, user=User.current) | ||||
|
r4279 | return unless attrs.is_a?(Hash) | ||
|
r5690 | |||
|
r13100 | attrs = attrs.deep_dup | ||
|
r5690 | |||
|
r8411 | # Project and Tracker must be set before since new_statuses_allowed_to depends on it. | ||
|
r9729 | if (p = attrs.delete('project_id')) && safe_attribute?('project_id') | ||
|
r11726 | if allowed_target_projects(user).where(:id => p.to_i).exists? | ||
|
r8433 | self.project_id = p | ||
end | ||||
|
r8411 | end | ||
|
r8433 | |||
|
r9729 | if (t = attrs.delete('tracker_id')) && safe_attribute?('tracker_id') | ||
|
r4280 | self.tracker_id = t | ||
end | ||||
|
r5690 | |||
|
r9794 | if (s = attrs.delete('status_id')) && safe_attribute?('status_id') | ||
if new_statuses_allowed_to(user).collect(&:id).include?(s.to_i) | ||||
self.status_id = s | ||||
|
r3364 | end | ||
end | ||||
|
r5690 | |||
|
r9794 | attrs = delete_unsafe_attributes(attrs, user) | ||
return if attrs.empty? | ||||
|
r3459 | unless leaf? | ||
attrs.reject! {|k,v| %w(priority_id done_ratio start_date due_date estimated_hours).include?(k)} | ||||
end | ||||
|
r5690 | |||
|
r8078 | if attrs['parent_issue_id'].present? | ||
|
r10447 | s = attrs['parent_issue_id'].to_s | ||
|
r10998 | unless (m = s.match(%r{\A#?(\d+)\z})) && (m[1] == parent_id.to_s || Issue.visible(user).exists?(m[1])) | ||
|
r10404 | @invalid_parent_issue_id = attrs.delete('parent_issue_id') | ||
end | ||||
|
r3459 | end | ||
|
r5690 | |||
|
r9794 | if attrs['custom_field_values'].present? | ||
|
r11782 | editable_custom_field_ids = editable_custom_field_values(user).map {|v| v.custom_field_id.to_s} | ||
|
r13100 | attrs['custom_field_values'].select! {|k, v| editable_custom_field_ids.include?(k.to_s)} | ||
|
r9794 | end | ||
if attrs['custom_fields'].present? | ||||
|
r11782 | editable_custom_field_ids = editable_custom_field_values(user).map {|v| v.custom_field_id.to_s} | ||
|
r13100 | attrs['custom_fields'].select! {|c| editable_custom_field_ids.include?(c['id'].to_s)} | ||
|
r9794 | end | ||
|
r8077 | # mass-assignment security bypass | ||
|
r9346 | assign_attributes attrs, :without_protection => true | ||
|
r3194 | end | ||
|
r5690 | |||
|
r9729 | def disabled_core_fields | ||
tracker ? tracker.disabled_core_fields : [] | ||||
end | ||||
|
r9794 | # Returns the custom_field_values that can be edited by the given user | ||
def editable_custom_field_values(user=nil) | ||||
|
r11782 | visible_custom_field_values(user).reject do |value| | ||
|
r9794 | read_only_attribute_names(user).include?(value.custom_field_id.to_s) | ||
end | ||||
end | ||||
|
r12849 | # Returns the custom fields that can be edited by the given user | ||
def editable_custom_fields(user=nil) | ||||
editable_custom_field_values(user).map(&:custom_field).uniq | ||||
end | ||||
|
r9794 | # Returns the names of attributes that are read-only for user or the current user | ||
# For users with multiple roles, the read-only fields are the intersection of | ||||
# read-only fields of each role | ||||
# The result is an array of strings where sustom fields are represented with their ids | ||||
# | ||||
# Examples: | ||||
# issue.read_only_attribute_names # => ['due_date', '2'] | ||||
# issue.read_only_attribute_names(user) # => [] | ||||
def read_only_attribute_names(user=nil) | ||||
|
r9802 | workflow_rule_by_attribute(user).reject {|attr, rule| rule != 'readonly'}.keys | ||
|
r9794 | end | ||
# Returns the names of required attributes for user or the current user | ||||
# For users with multiple roles, the required fields are the intersection of | ||||
# required fields of each role | ||||
# The result is an array of strings where sustom fields are represented with their ids | ||||
# | ||||
# Examples: | ||||
# issue.required_attribute_names # => ['due_date', '2'] | ||||
# issue.required_attribute_names(user) # => [] | ||||
def required_attribute_names(user=nil) | ||||
|
r9802 | workflow_rule_by_attribute(user).reject {|attr, rule| rule != 'required'}.keys | ||
|
r9794 | end | ||
# Returns true if the attribute is required for user | ||||
def required_attribute?(name, user=nil) | ||||
required_attribute_names(user).include?(name.to_s) | ||||
end | ||||
# Returns a hash of the workflow rule by attribute for the given user | ||||
# | ||||
# Examples: | ||||
# issue.workflow_rule_by_attribute # => {'due_date' => 'required', 'start_date' => 'readonly'} | ||||
def workflow_rule_by_attribute(user=nil) | ||||
return @workflow_rule_by_attribute if @workflow_rule_by_attribute && user.nil? | ||||
user_real = user || User.current | ||||
|
r13132 | roles = user_real.admin ? Role.all.to_a : user_real.roles_for_project(project) | ||
|
r13365 | roles = roles.select(&:consider_workflow?) | ||
|
r9794 | return {} if roles.empty? | ||
result = {} | ||||
|
r13132 | workflow_permissions = WorkflowPermission.where(:tracker_id => tracker_id, :old_status_id => status_id, :role_id => roles.map(&:id)).to_a | ||
|
r9794 | if workflow_permissions.any? | ||
workflow_rules = workflow_permissions.inject({}) do |h, wp| | ||||
h[wp.field_name] ||= [] | ||||
h[wp.field_name] << wp.rule | ||||
h | ||||
end | ||||
workflow_rules.each do |attr, rules| | ||||
next if rules.size < roles.size | ||||
uniq_rules = rules.uniq | ||||
if uniq_rules.size == 1 | ||||
result[attr] = uniq_rules.first | ||||
else | ||||
result[attr] = 'required' | ||||
end | ||||
end | ||||
end | ||||
@workflow_rule_by_attribute = result if user.nil? | ||||
result | ||||
end | ||||
private :workflow_rule_by_attribute | ||||
|
r3037 | def done_ratio | ||
|
r4072 | if Issue.use_status_for_done_ratio? && status && status.default_done_ratio | ||
|
r3045 | status.default_done_ratio | ||
|
r3037 | else | ||
read_attribute(:done_ratio) | ||||
end | ||||
end | ||||
def self.use_status_for_done_ratio? | ||||
Setting.issue_done_ratio == 'issue_status' | ||||
end | ||||
def self.use_field_for_done_ratio? | ||||
Setting.issue_done_ratio == 'issue_field' | ||||
end | ||||
|
r5690 | |||
|
r7309 | def validate_issue | ||
|
r11701 | if due_date && start_date && (start_date_changed? || due_date_changed?) && due_date < start_date | ||
|
r2430 | errors.add :due_date, :greater_than_start_date | ||
|
r330 | end | ||
|
r5690 | |||
|
r11701 | if start_date && start_date_changed? && soonest_start && start_date < soonest_start | ||
|
r11696 | errors.add :start_date, :earlier_than_minimum_start_date, :date => format_date(soonest_start) | ||
|
r503 | end | ||
|
r5690 | |||
|
r2906 | if fixed_version | ||
if !assignable_versions.include?(fixed_version) | ||||
errors.add :fixed_version_id, :inclusion | ||||
|
r13126 | elsif reopening? && fixed_version.closed? | ||
|
r7470 | errors.add :base, I18n.t(:error_can_not_reopen_issue_on_closed_version) | ||
|
r2906 | end | ||
end | ||||
|
r5690 | |||
|
r2994 | # 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 | ||||
|
r5690 | |||
|
r3459 | # Checks parent issue assignment | ||
|
r10404 | if @invalid_parent_issue_id.present? | ||
errors.add :parent_issue_id, :invalid | ||||
elsif @parent_issue | ||||
|
r10376 | if !valid_parent_project?(@parent_issue) | ||
errors.add :parent_issue_id, :invalid | ||||
|
r11411 | elsif (@parent_issue != parent) && (all_dependent_issues.include?(@parent_issue) || @parent_issue.all_dependent_issues.include?(self)) | ||
errors.add :parent_issue_id, :invalid | ||||
|
r3459 | elsif !new_record? | ||
# moving an existing issue | ||||
|
r13459 | if move_possible?(@parent_issue) | ||
# move accepted | ||||
|
r3459 | else | ||
|
r10376 | errors.add :parent_issue_id, :invalid | ||
|
r3459 | end | ||
end | ||||
end | ||||
|
r330 | end | ||
|
r5690 | |||
|
r9794 | # Validates the issue against additional workflow requirements | ||
def validate_required_fields | ||||
user = new_record? ? author : current_journal.try(:user) | ||||
required_attribute_names(user).each do |attribute| | ||||
if attribute =~ /^\d+$/ | ||||
attribute = attribute.to_i | ||||
v = custom_field_values.detect {|v| v.custom_field_id == attribute } | ||||
if v && v.value.blank? | ||||
errors.add :base, v.custom_field.name + ' ' + l('activerecord.errors.messages.blank') | ||||
end | ||||
else | ||||
|
r13175 | if respond_to?(attribute) && send(attribute).blank? && !disabled_core_fields.include?(attribute) | ||
|
r9794 | errors.add attribute, :blank | ||
end | ||||
end | ||||
end | ||||
end | ||||
|
r3037 | # Set the done_ratio using the status if that setting is set. This will keep the done_ratios | ||
# even if the user turns off the setting later | ||||
def update_done_ratio_from_issue_status | ||||
|
r4072 | if Issue.use_status_for_done_ratio? && status && status.default_done_ratio | ||
|
r3043 | self.done_ratio = status.default_done_ratio | ||
|
r3037 | end | ||
end | ||||
|
r5690 | |||
|
r330 | def init_journal(user, notes = "") | ||
@current_journal ||= Journal.new(:journalized => self, :user => user, :notes => notes) | ||||
end | ||||
|
r5690 | |||
|
r13257 | # Returns the current journal or nil if it's not initialized | ||
|
r13152 | def current_journal | ||
@current_journal | ||||
end | ||||
|
r13321 | # Returns the names of attributes that are journalized when updating the issue | ||
def journalized_attribute_names | ||||
Issue.column_names - %w(id root_id lft rgt lock_version created_on updated_on closed_on) | ||||
end | ||||
|
r8654 | # Returns the id of the last journal or nil | ||
def last_journal_id | ||||
if new_record? | ||||
nil | ||||
else | ||||
|
r9994 | journals.maximum(:id) | ||
|
r8654 | end | ||
end | ||||
|
r9996 | # Returns a scope for journals that have an id greater than journal_id | ||
def journals_after(journal_id) | ||||
scope = journals.reorder("#{Journal.table_name}.id ASC") | ||||
if journal_id.present? | ||||
scope = scope.where("#{Journal.table_name}.id > ?", journal_id.to_i) | ||||
end | ||||
scope | ||||
end | ||||
|
r11182 | # Returns the initial status of the issue | ||
# Returns nil for a new issue | ||||
def status_was | ||||
|
r13195 | if status_id_changed? | ||
if status_id_was.to_i > 0 | ||||
@status_was ||= IssueStatus.find_by_id(status_id_was) | ||||
end | ||||
else | ||||
@status_was ||= status | ||||
|
r11182 | end | ||
end | ||||
|
r657 | # Return true if the issue is closed, otherwise false | ||
def closed? | ||||
|
r13123 | status.present? && status.is_closed? | ||
|
r657 | end | ||
|
r5690 | |||
|
r13126 | # Returns true if the issue was closed when loaded | ||
def was_closed? | ||||
status_was.present? && status_was.is_closed? | ||||
end | ||||
|
r2906 | # Return true if the issue is being reopened | ||
|
r13126 | def reopening? | ||
if new_record? | ||||
false | ||||
else | ||||
status_id_changed? && !closed? && was_closed? | ||||
|
r2906 | end | ||
end | ||||
|
r13126 | alias :reopened? :reopening? | ||
|
r3385 | |||
# Return true if the issue is being closed | ||||
def closing? | ||||
|
r13126 | if new_record? | ||
closed? | ||||
else | ||||
status_id_changed? && closed? && !was_closed? | ||||
|
r3385 | end | ||
end | ||||
|
r5690 | |||
|
r2138 | # Returns true if the issue is overdue | ||
def overdue? | ||||
|
r13126 | due_date.present? && (due_date < Date.today) && !closed? | ||
|
r2138 | end | ||
|
r3958 | |||
# Is the amount of work done less than it should for the due date | ||||
def behind_schedule? | ||||
return false if start_date.nil? || due_date.nil? | ||||
|
r11857 | done_date = start_date + ((due_date - start_date + 1) * done_ratio / 100).floor | ||
|
r3958 | return done_date <= Date.today | ||
end | ||||
|
r3991 | |||
# Does this issue have children? | ||||
def children? | ||||
!leaf? | ||||
end | ||||
|
r5690 | |||
|
r643 | # Users the issue can be assigned to | ||
def assignable_users | ||||
|
r13127 | users = project.assignable_users.to_a | ||
|
r4126 | users << author if author | ||
|
r6188 | users << assigned_to if assigned_to | ||
|
r4127 | users.uniq.sort | ||
|
r643 | end | ||
|
r5690 | |||
|
r2906 | # Versions that the issue can be assigned to | ||
def assignable_versions | ||||
|
r9903 | return @assignable_versions if @assignable_versions | ||
|
r13100 | versions = project.shared_versions.open.to_a | ||
|
r9903 | if fixed_version | ||
if fixed_version_id_changed? | ||||
# nothing to do | ||||
elsif project_id_changed? | ||||
if project.shared_versions.include?(fixed_version) | ||||
versions << fixed_version | ||||
end | ||||
else | ||||
versions << fixed_version | ||||
end | ||||
end | ||||
@assignable_versions = versions.uniq.sort | ||||
|
r2906 | end | ||
|
r5690 | |||
|
r2700 | # 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 | ||||
|
r5690 | |||
|
r13153 | # Returns the default status of the issue based on its tracker | ||
# Returns nil if tracker is nil | ||||
def default_status | ||||
tracker.try(:default_status) | ||||
end | ||||
|
r9244 | # Returns an array of statuses that user is able to apply | ||
|
r8706 | def new_statuses_allowed_to(user=User.current, include_default=false) | ||
|
r9270 | if new_record? && @copied_from | ||
|
r13153 | [default_status, @copied_from.status].compact.uniq.sort | ||
|
r9270 | else | ||
initial_status = nil | ||||
if new_record? | ||||
|
r13153 | initial_status = default_status | ||
elsif tracker_id_changed? | ||||
if Tracker.where(:id => tracker_id_was, :default_status_id => status_id_was).any? | ||||
initial_status = default_status | ||||
elsif tracker.issue_status_ids.include?(status_id_was) | ||||
initial_status = IssueStatus.find_by_id(status_id_was) | ||||
else | ||||
initial_status = default_status | ||||
end | ||||
|
r13133 | else | ||
initial_status = status_was | ||||
|
r9270 | end | ||
|
r11826 | |||
initial_assigned_to_id = assigned_to_id_changed? ? assigned_to_id_was : assigned_to_id | ||||
|
r12807 | assignee_transitions_allowed = initial_assigned_to_id.present? && | ||
|
r11826 | (user.id == initial_assigned_to_id || user.group_ids.include?(initial_assigned_to_id)) | ||
|
r13133 | statuses = [] | ||
if initial_status | ||||
statuses += initial_status.find_new_statuses_allowed_to( | ||||
user.admin ? Role.all.to_a : user.roles_for_project(project), | ||||
tracker, | ||||
author == user, | ||||
assignee_transitions_allowed | ||||
) | ||||
end | ||||
|
r9270 | statuses << initial_status unless statuses.empty? | ||
|
r13153 | statuses << default_status if include_default | ||
|
r9270 | statuses = statuses.compact.uniq.sort | ||
|
r13133 | if blocked? | ||
statuses.reject!(&:is_closed?) | ||||
end | ||||
statuses | ||||
|
r9270 | end | ||
|
r1030 | end | ||
|
r5690 | |||
|
r12144 | # Returns the previous assignee if changed | ||
|
r8575 | def assigned_to_was | ||
|
r12144 | # assigned_to_id_was is reset before after_save callbacks | ||
user_id = @previous_assigned_to_id || assigned_to_id_was | ||||
if user_id && user_id != assigned_to_id | ||||
@assigned_to_was ||= User.find_by_id(user_id) | ||||
|
r8575 | end | ||
end | ||||
|
r10336 | # Returns the users that should be notified | ||
def notified_users | ||||
|
r8575 | notified = [] | ||
|
r4104 | # Author and assignee are always notified unless they have been | ||
# locked or don't want to be notified | ||||
|
r8575 | notified << author if author | ||
|
r6186 | if assigned_to | ||
|
r8575 | notified += (assigned_to.is_a?(Group) ? assigned_to.users : [assigned_to]) | ||
end | ||||
if assigned_to_was | ||||
notified += (assigned_to_was.is_a?(Group) ? assigned_to_was.users : [assigned_to_was]) | ||||
|
r6186 | end | ||
|
r8575 | notified = notified.select {|u| u.active? && u.notify_about?(self)} | ||
notified += project.notified_users | ||||
|
r3007 | notified.uniq! | ||
# Remove users that can not view the issue | ||||
notified.reject! {|user| !visible?(user)} | ||||
|
r10336 | notified | ||
end | ||||
# Returns the email addresses that should be notified | ||||
def recipients | ||||
notified_users.collect(&:mail) | ||||
|
r3007 | end | ||
|
r5690 | |||
|
r11782 | def each_notification(users, &block) | ||
if users.any? | ||||
if custom_field_values.detect {|value| !value.custom_field.visible?} | ||||
users_by_custom_field_visibility = users.group_by do |user| | ||||
visible_custom_field_values(user).map(&:custom_field_id).sort | ||||
end | ||||
users_by_custom_field_visibility.values.each do |users| | ||||
yield(users) | ||||
end | ||||
else | ||||
yield(users) | ||||
end | ||||
end | ||||
end | ||||
|
r7953 | # Returns the number of hours spent on this issue | ||
def spent_hours | ||||
@spent_hours ||= time_entries.sum(:hours) || 0 | ||||
end | ||||
|
r3459 | # Returns the total number of hours spent on this issue and its descendants | ||
|
r2536 | # | ||
# Example: | ||||
|
r3459 | # spent_hours => 0.0 | ||
# spent_hours => 50.2 | ||||
|
r7953 | def total_spent_hours | ||
|
r12313 | @total_spent_hours ||= | ||
self_and_descendants. | ||||
joins("LEFT JOIN #{TimeEntry.table_name} ON #{TimeEntry.table_name}.issue_id = #{Issue.table_name}.id"). | ||||
sum("#{TimeEntry.table_name}.hours").to_f || 0.0 | ||||
|
r365 | end | ||
|
r5690 | |||
|
r503 | def relations | ||
|
r10750 | @relations ||= IssueRelation::Relations.new(self, (relations_from + relations_to).sort) | ||
|
r6193 | end | ||
|
r6396 | |||
|
r6193 | # Preloads relations for a collection of issues | ||
def self.load_relations(issues) | ||||
if issues.any? | ||||
|
r11733 | relations = IssueRelation.where("issue_from_id IN (:ids) OR issue_to_id IN (:ids)", :ids => issues.map(&:id)).all | ||
|
r6193 | issues.each do |issue| | ||
issue.instance_variable_set "@relations", relations.select {|r| r.issue_from_id == issue.id || r.issue_to_id == issue.id} | ||||
end | ||||
end | ||||
|
r503 | end | ||
|
r6396 | |||
|
r7953 | # Preloads visible spent time for a collection of issues | ||
def self.load_visible_spent_hours(issues, user=User.current) | ||||
if issues.any? | ||||
|
r11733 | hours_by_issue_id = TimeEntry.visible(user).group(:issue_id).sum(:hours) | ||
|
r7953 | issues.each do |issue| | ||
issue.instance_variable_set "@spent_hours", (hours_by_issue_id[issue.id] || 0) | ||||
end | ||||
end | ||||
end | ||||
|
r10303 | # Preloads visible relations for a collection of issues | ||
def self.load_visible_relations(issues, user=User.current) | ||||
if issues.any? | ||||
issue_ids = issues.map(&:id) | ||||
# Relations with issue_from in given issues and visible issue_to | ||||
|
r13100 | relations_from = IssueRelation.joins(:issue_to => :project). | ||
where(visible_condition(user)).where(:issue_from_id => issue_ids).to_a | ||||
|
r10303 | # Relations with issue_to in given issues and visible issue_from | ||
|
r13100 | relations_to = IssueRelation.joins(:issue_from => :project). | ||
where(visible_condition(user)). | ||||
where(:issue_to_id => issue_ids).to_a | ||||
|
r10303 | issues.each do |issue| | ||
relations = | ||||
relations_from.select {|relation| relation.issue_from_id == issue.id} + | ||||
relations_to.select {|relation| relation.issue_to_id == issue.id} | ||||
|
r10750 | issue.instance_variable_set "@relations", IssueRelation::Relations.new(issue, relations.sort) | ||
|
r10303 | end | ||
end | ||||
end | ||||
|
r6056 | # Finds an issue relation given its id. | ||
def find_relation(relation_id) | ||||
|
r11733 | IssueRelation.where("issue_to_id = ? OR issue_from_id = ?", id, id).find(relation_id) | ||
|
r6056 | end | ||
|
r5690 | |||
|
r11412 | # Returns all the other issues that depend on the issue | ||
|
r11598 | # The algorithm is a modified breadth first search (bfs) | ||
|
r4984 | def all_dependent_issues(except=[]) | ||
|
r11597 | # The found dependencies | ||
|
r503 | dependencies = [] | ||
|
r11597 | |||
# The visited flag for every node (issue) used by the breadth first search | ||||
eNOT_DISCOVERED = 0 # The issue is "new" to the algorithm, it has not seen it before. | ||||
ePROCESS_ALL = 1 # The issue is added to the queue. Process both children and relations of | ||||
# the issue when it is processed. | ||||
ePROCESS_RELATIONS_ONLY = 2 # The issue was added to the queue and will be output as dependent issue, | ||||
# but its children will not be added to the queue when it is processed. | ||||
eRELATIONS_PROCESSED = 3 # The related issues, the parent issue and the issue itself have been added to | ||||
# the queue, but its children have not been added. | ||||
ePROCESS_CHILDREN_ONLY = 4 # The relations and the parent of the issue have been added to the queue, but | ||||
# the children still need to be processed. | ||||
eALL_PROCESSED = 5 # The issue and all its children, its parent and its related issues have been | ||||
# added as dependent issues. It needs no further processing. | ||||
|
r11598 | issue_status = Hash.new(eNOT_DISCOVERED) | ||
|
r11597 | |||
# The queue | ||||
queue = [] | ||||
# Initialize the bfs, add start node (self) to the queue | ||||
queue << self | ||||
|
r11598 | issue_status[self] = ePROCESS_ALL | ||
|
r11597 | |||
while (!queue.empty?) do | ||||
|
r11598 | current_issue = queue.shift | ||
current_issue_status = issue_status[current_issue] | ||||
dependencies << current_issue | ||||
|
r11597 | |||
# Add parent to queue, if not already in it. | ||||
|
r11598 | parent = current_issue.parent | ||
|
r11601 | parent_status = issue_status[parent] | ||
|
r11597 | |||
|
r11601 | if parent && (parent_status == eNOT_DISCOVERED) && !except.include?(parent) | ||
|
r11597 | queue << parent | ||
|
r11598 | issue_status[parent] = ePROCESS_RELATIONS_ONLY | ||
|
r11597 | end | ||
# Add children to queue, but only if they are not already in it and | ||||
# the children of the current node need to be processed. | ||||
|
r11603 | if (current_issue_status == ePROCESS_CHILDREN_ONLY || current_issue_status == ePROCESS_ALL) | ||
|
r11598 | current_issue.children.each do |child| | ||
|
r11602 | next if except.include?(child) | ||
if (issue_status[child] == eNOT_DISCOVERED) | ||||
|
r11597 | queue << child | ||
|
r11598 | issue_status[child] = ePROCESS_ALL | ||
|
r11602 | elsif (issue_status[child] == eRELATIONS_PROCESSED) | ||
|
r11597 | queue << child | ||
|
r11598 | issue_status[child] = ePROCESS_CHILDREN_ONLY | ||
|
r11602 | elsif (issue_status[child] == ePROCESS_RELATIONS_ONLY) | ||
|
r11597 | queue << child | ||
|
r11598 | issue_status[child] = ePROCESS_ALL | ||
|
r11597 | end | ||
end | ||||
end | ||||
# Add related issues to the queue, if they are not already in it. | ||||
|
r11601 | current_issue.relations_from.map(&:issue_to).each do |related_issue| | ||
|
r11602 | next if except.include?(related_issue) | ||
if (issue_status[related_issue] == eNOT_DISCOVERED) | ||||
|
r11601 | queue << related_issue | ||
issue_status[related_issue] = ePROCESS_ALL | ||||
|
r11602 | elsif (issue_status[related_issue] == eRELATIONS_PROCESSED) | ||
|
r11601 | queue << related_issue | ||
issue_status[related_issue] = ePROCESS_CHILDREN_ONLY | ||||
|
r11602 | elsif (issue_status[related_issue] == ePROCESS_RELATIONS_ONLY) | ||
|
r11601 | queue << related_issue | ||
issue_status[related_issue] = ePROCESS_ALL | ||||
|
r11597 | end | ||
end | ||||
# Set new status for current issue | ||||
|
r11599 | if (current_issue_status == ePROCESS_ALL) || (current_issue_status == ePROCESS_CHILDREN_ONLY) | ||
|
r11598 | issue_status[current_issue] = eALL_PROCESSED | ||
|
r11599 | elsif (current_issue_status == ePROCESS_RELATIONS_ONLY) | ||
|
r11598 | issue_status[current_issue] = eRELATIONS_PROCESSED | ||
|
r11597 | end | ||
end # while | ||||
# Remove the issues from the "except" parameter from the result array | ||||
|
r11412 | dependencies -= except | ||
|
r11597 | dependencies.delete(self) | ||
|
r11462 | dependencies | ||
|
r503 | end | ||
|
r5690 | |||
|
r1474 | # Returns an array of issues that duplicate this one | ||
|
r657 | def duplicates | ||
|
r1474 | relations_to.select {|r| r.relation_type == IssueRelation::TYPE_DUPLICATES}.collect {|r| r.issue_from} | ||
|
r657 | end | ||
|
r5690 | |||
|
r1441 | # 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 | ||||
|
r5690 | |||
|
r2536 | # Returns the time scheduled for this issue. | ||
|
r5690 | # | ||
|
r2536 | # Example: | ||
# Start Date: 2/26/09, End Date: 3/04/09 | ||||
# duration => 6 | ||||
|
r503 | def duration | ||
(start_date && due_date) ? due_date - start_date : 0 | ||||
end | ||||
|
r5690 | |||
|
r10531 | # Returns the duration in working days | ||
def working_duration | ||||
(start_date && due_date) ? working_days(start_date, due_date) : 0 | ||||
end | ||||
|
r10651 | def soonest_start(reload=false) | ||
@soonest_start = nil if reload | ||||
|
r3460 | @soonest_start ||= ( | ||
|
r10651 | relations_to(reload).collect{|relation| relation.successor_soonest_start} + | ||
|
r11410 | [(@parent_issue || parent).try(:soonest_start)] | ||
|
r3460 | ).compact.max | ||
end | ||||
|
r5690 | |||
|
r10531 | # Sets start_date on the given date or the next working day | ||
# and changes due_date to keep the same working duration. | ||||
def reschedule_on(date) | ||||
wd = working_duration | ||||
date = next_working_date(date) | ||||
self.start_date = date | ||||
self.due_date = add_working_days(date, wd) | ||||
end | ||||
# Reschedules the issue on the given date or the next working day and saves the record. | ||||
# If the issue is a parent task, this is done by rescheduling its subtasks. | ||||
def reschedule_on!(date) | ||||
|
r3460 | return if date.nil? | ||
if leaf? | ||||
|
r10651 | if start_date.nil? || start_date != date | ||
if start_date && start_date > date | ||||
# Issue can not be moved earlier than its soonest start date | ||||
date = [soonest_start(true), date].compact.max | ||||
end | ||||
|
r10531 | reschedule_on(date) | ||
|
r8744 | begin | ||
save | ||||
rescue ActiveRecord::StaleObjectError | ||||
reload | ||||
|
r10531 | reschedule_on(date) | ||
|
r8744 | save | ||
end | ||||
|
r3460 | end | ||
else | ||||
leaves.each do |leaf| | ||||
|
r10653 | if leaf.start_date | ||
# Only move subtask if it starts at the same date as the parent | ||||
# or if it starts before the given date | ||||
|
r12807 | if start_date == leaf.start_date || date > leaf.start_date | ||
|
r10653 | leaf.reschedule_on!(date) | ||
end | ||||
else | ||||
leaf.reschedule_on!(date) | ||||
end | ||||
|
r3460 | end | ||
end | ||||
|
r503 | end | ||
|
r5690 | |||
|
r3459 | def <=>(issue) | ||
if issue.nil? | ||||
-1 | ||||
elsif root_id != issue.root_id | ||||
(root_id || 0) <=> (issue.root_id || 0) | ||||
else | ||||
(lft || 0) <=> (issue.lft || 0) | ||||
end | ||||
end | ||||
|
r5690 | |||
|
r1304 | def to_s | ||
"#{tracker} ##{id}: #{subject}" | ||||
end | ||||
|
r5690 | |||
|
r2602 | # Returns a string of css classes that apply to the issue | ||
|
r11776 | def css_classes(user=User.current) | ||
|
r11279 | s = "issue tracker-#{tracker_id} status-#{status_id} #{priority.try(:css_classes)}" | ||
|
r2602 | s << ' closed' if closed? | ||
s << ' overdue' if overdue? | ||||
|
r5101 | s << ' child' if child? | ||
s << ' parent' unless leaf? | ||||
|
r5346 | s << ' private' if is_private? | ||
|
r11776 | if user.logged? | ||
s << ' created-by-me' if author_id == user.id | ||||
s << ' assigned-to-me' if assigned_to_id == user.id | ||||
|
r12569 | s << ' assigned-to-my-group' if user.groups.any? {|g| g.id == assigned_to_id} | ||
|
r11776 | end | ||
|
r2602 | s | ||
end | ||||
|
r3009 | |||
|
r3023 | # Unassigns issues from +version+ if it's no longer shared with issue's project | ||
def self.update_versions_from_sharing_change(version) | ||||
# Update issues assigned to the version | ||||
update_versions(["#{Issue.table_name}.fixed_version_id = ?", version.id]) | ||||
end | ||||
|
r5690 | |||
|
r3023 | # Unassigns issues from versions that are no longer shared | ||
# after +project+ was moved | ||||
def self.update_versions_from_hierarchy_change(project) | ||||
moved_project_ids = project.self_and_descendants.reload.collect(&:id) | ||||
# Update issues of the moved projects and issues assigned to a version of a moved project | ||||
|
r12806 | Issue.update_versions( | ||
["#{Version.table_name}.project_id IN (?) OR #{Issue.table_name}.project_id IN (?)", | ||||
moved_project_ids, moved_project_ids] | ||||
) | ||||
|
r3023 | end | ||
|
r3459 | def parent_issue_id=(arg) | ||
|
r10404 | s = arg.to_s.strip.presence | ||
if s && (m = s.match(%r{\A#?(\d+)\z})) && (@parent_issue = Issue.find_by_id(m[1])) | ||||
|
r11996 | @invalid_parent_issue_id = nil | ||
elsif s.blank? | ||||
@parent_issue = nil | ||||
@invalid_parent_issue_id = nil | ||||
|
r3459 | else | ||
@parent_issue = nil | ||||
|
r10404 | @invalid_parent_issue_id = arg | ||
|
r3459 | end | ||
end | ||||
|
r5690 | |||
|
r3459 | def parent_issue_id | ||
|
r10404 | if @invalid_parent_issue_id | ||
@invalid_parent_issue_id | ||||
elsif instance_variable_defined? :@parent_issue | ||||
|
r3459 | @parent_issue.nil? ? nil : @parent_issue.id | ||
else | ||||
parent_id | ||||
end | ||||
end | ||||
|
r13459 | def set_parent_id | ||
self.parent_id = parent_issue_id | ||||
end | ||||
|
r11192 | # Returns true if issue's project is a valid | ||
# parent issue project | ||||
|
r10376 | def valid_parent_project?(issue=parent) | ||
return true if issue.nil? || issue.project_id == project_id | ||||
case Setting.cross_project_subtasks | ||||
when 'system' | ||||
true | ||||
when 'tree' | ||||
issue.project.root == project.root | ||||
when 'hierarchy' | ||||
issue.project.is_or_is_ancestor_of?(project) || issue.project.is_descendant_of?(project) | ||||
when 'descendants' | ||||
issue.project.is_or_is_ancestor_of?(project) | ||||
else | ||||
false | ||||
end | ||||
end | ||||
|
r13037 | # Returns an issue scope based on project and scope | ||
def self.cross_project_scope(project, scope=nil) | ||||
if project.nil? | ||||
return Issue | ||||
end | ||||
case scope | ||||
when 'all', 'system' | ||||
Issue | ||||
when 'tree' | ||||
Issue.joins(:project).where("(#{Project.table_name}.lft >= :lft AND #{Project.table_name}.rgt <= :rgt)", | ||||
:lft => project.root.lft, :rgt => project.root.rgt) | ||||
when 'hierarchy' | ||||
Issue.joins(:project).where("(#{Project.table_name}.lft >= :lft AND #{Project.table_name}.rgt <= :rgt) OR (#{Project.table_name}.lft < :lft AND #{Project.table_name}.rgt > :rgt)", | ||||
:lft => project.lft, :rgt => project.rgt) | ||||
when 'descendants' | ||||
Issue.joins(:project).where("(#{Project.table_name}.lft >= :lft AND #{Project.table_name}.rgt <= :rgt)", | ||||
:lft => project.lft, :rgt => project.rgt) | ||||
else | ||||
Issue.where(:project_id => project.id) | ||||
end | ||||
end | ||||
|
r3248 | def self.by_tracker(project) | ||
|
r13080 | count_and_group_by(:project => project, :association => :tracker) | ||
|
r3248 | end | ||
def self.by_version(project) | ||||
|
r13080 | count_and_group_by(:project => project, :association => :fixed_version) | ||
|
r3248 | end | ||
def self.by_priority(project) | ||||
|
r13080 | count_and_group_by(:project => project, :association => :priority) | ||
|
r3248 | end | ||
def self.by_category(project) | ||||
|
r13080 | count_and_group_by(:project => project, :association => :category) | ||
|
r3248 | end | ||
def self.by_assigned_to(project) | ||||
|
r13080 | count_and_group_by(:project => project, :association => :assigned_to) | ||
|
r3248 | end | ||
def self.by_author(project) | ||||
|
r13080 | count_and_group_by(:project => project, :association => :author) | ||
|
r3248 | end | ||
def self.by_subproject(project) | ||||
|
r13080 | r = count_and_group_by(:project => project, :with_subprojects => true, :association => :project) | ||
r.reject {|r| r["project_id"] == project.id.to_s} | ||||
end | ||||
# Query generator for selecting groups of issue counts for a project | ||||
# based on specific criteria | ||||
# | ||||
# Options | ||||
# * project - Project to search in. | ||||
# * with_subprojects - Includes subprojects issues if set to true. | ||||
# * association - Symbol. Association for grouping. | ||||
def self.count_and_group_by(options) | ||||
assoc = reflect_on_association(options[:association]) | ||||
select_field = assoc.foreign_key | ||||
Issue. | ||||
visible(User.current, :project => options[:project], :with_subprojects => options[:with_subprojects]). | ||||
|
r13085 | joins(:status, assoc.name). | ||
|
r13080 | group(:status_id, :is_closed, select_field). | ||
count. | ||||
map do |columns, total| | ||||
status_id, is_closed, field_value = columns | ||||
|
r13087 | is_closed = ['t', 'true', '1'].include?(is_closed.to_s) | ||
|
r13080 | { | ||
"status_id" => status_id.to_s, | ||||
|
r13086 | "closed" => is_closed, | ||
|
r13080 | select_field => field_value.to_s, | ||
"total" => total.to_s | ||||
} | ||||
end | ||||
end | ||||
|
r5690 | |||
|
r11726 | # Returns a scope of projects that user can assign the issue to | ||
|
r8433 | def allowed_target_projects(user=User.current) | ||
|
r13599 | current_project = new_record? ? nil : project | ||
self.class.allowed_target_projects(user, current_project) | ||||
|
r8433 | end | ||
|
r13599 | # Returns a scope of projects that user can assign issues to | ||
# If current_project is given, it will be included in the scope | ||||
def self.allowed_target_projects(user=User.current, current_project=nil) | ||||
condition = Project.allowed_to_condition(user, :add_issues) | ||||
if current_project | ||||
condition = ["(#{condition}) OR #{Project.table_name}.id = ?", current_project.id] | ||||
end | ||||
Project.where(condition) | ||||
|
r3569 | end | ||
|
r5690 | |||
|
r3023 | private | ||
|
r5690 | |||
|
r8404 | def after_project_change | ||
# Update project_id on related time entries | ||||
|
r12257 | TimeEntry.where({:issue_id => id}).update_all(["project_id = ?", project_id]) | ||
|
r8404 | |||
# Delete issue relations | ||||
unless Setting.cross_project_issue_relations? | ||||
relations_from.clear | ||||
relations_to.clear | ||||
end | ||||
|
r10376 | # Move subtasks that were in the same project | ||
|
r8404 | children.each do |child| | ||
|
r10376 | next unless child.project_id == project_id_was | ||
|
r8411 | # Change project and keep project | ||
child.send :project=, project, true | ||||
|
r8404 | unless child.save | ||
raise ActiveRecord::Rollback | ||||
end | ||||
end | ||||
end | ||||
|
r10282 | # Callback for after the creation of an issue by copy | ||
# * adds a "copied to" relation with the copied issue | ||||
# * copies subtasks from the copied issue | ||||
|
r10144 | def after_create_from_copy | ||
|
r10282 | return unless copy? && !@after_create_from_copy_handled | ||
|
r10144 | |||
|
r10286 | if (@copied_from.project_id == project_id || Setting.cross_project_issue_relations?) && @copy_options[:link] != false | ||
|
r13152 | if @current_journal | ||
@copied_from.init_journal(@current_journal.user) | ||||
end | ||||
|
r10282 | relation = IssueRelation.new(:issue_from => @copied_from, :issue_to => self, :relation_type => IssueRelation::TYPE_COPIED_TO) | ||
unless relation.save | ||||
logger.error "Could not create relation while copying ##{@copied_from.id} to ##{id} due to validation errors: #{relation.errors.full_messages.join(', ')}" if logger | ||||
end | ||||
end | ||||
unless @copied_from.leaf? || @copy_options[:subtasks] == false | ||||
|
r11283 | copy_options = (@copy_options || {}).merge(:subtasks => false) | ||
copied_issue_ids = {@copied_from.id => self.id} | ||||
@copied_from.reload.descendants.reorder("#{Issue.table_name}.lft").each do |child| | ||||
# Do not copy self when copying an issue as a descendant of the copied issue | ||||
next if child == self | ||||
# Do not copy subtasks of issues that were not copied | ||||
next unless copied_issue_ids[child.parent_id] | ||||
# Do not copy subtasks that are not visible to avoid potential disclosure of private data | ||||
|
r10144 | unless child.visible? | ||
logger.error "Subtask ##{child.id} was not copied during ##{@copied_from.id} copy because it is not visible to the current user" if logger | ||||
next | ||||
end | ||||
|
r11283 | copy = Issue.new.copy_from(child, copy_options) | ||
|
r13152 | if @current_journal | ||
copy.init_journal(@current_journal.user) | ||||
end | ||||
|
r10144 | copy.author = author | ||
copy.project = project | ||||
|
r11283 | copy.parent_issue_id = copied_issue_ids[child.parent_id] | ||
|
r10144 | unless copy.save | ||
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 | ||||
|
r11283 | next | ||
|
r10144 | end | ||
|
r11283 | copied_issue_ids[child.id] = copy.id | ||
|
r10144 | end | ||
end | ||||
|
r10282 | @after_create_from_copy_handled = true | ||
|
r10144 | end | ||
|
r3459 | def update_nested_set_attributes | ||
|
r13459 | if parent_id_changed? | ||
|
r11996 | update_nested_set_attributes_on_parent_change | ||
end | ||||
remove_instance_variable(:@parent_issue) if instance_variable_defined?(:@parent_issue) | ||||
end | ||||
# Updates the nested set for when an existing issue is moved | ||||
def update_nested_set_attributes_on_parent_change | ||||
|
r13459 | former_parent_id = parent_id_was | ||
|
r11996 | # delete invalid relations of all descendants | ||
self_and_descendants.each do |issue| | ||||
issue.relations.each do |relation| | ||||
relation.destroy unless relation.valid? | ||||
|
r3459 | end | ||
end | ||||
|
r11996 | # update former parent | ||
recalculate_attributes_for(former_parent_id) if former_parent_id | ||||
|
r3459 | end | ||
|
r5690 | |||
|
r3459 | def update_parent_attributes | ||
|
r13459 | if parent_id | ||
recalculate_attributes_for(parent_id) | ||||
association(:parent).reset | ||||
end | ||||
|
r3707 | end | ||
def recalculate_attributes_for(issue_id) | ||||
if issue_id && p = Issue.find_by_id(issue_id) | ||||
|
r3459 | # priority = highest priority of children | ||
|
r12262 | if priority_position = p.children.joins(:priority).maximum("#{IssuePriority.table_name}.position") | ||
|
r3459 | p.priority = IssuePriority.find_by_position(priority_position) | ||
end | ||||
|
r5690 | |||
|
r3459 | # start/due dates = lowest/highest dates of children | ||
p.start_date = p.children.minimum(:start_date) | ||||
p.due_date = p.children.maximum(:due_date) | ||||
if p.start_date && p.due_date && p.due_date < p.start_date | ||||
p.start_date, p.due_date = p.due_date, p.start_date | ||||
end | ||||
|
r5690 | |||
|
r3459 | # done ratio = weighted average ratio of leaves | ||
|
r4072 | unless Issue.use_status_for_done_ratio? && p.status && p.status.default_done_ratio | ||
|
r3459 | leaves_count = p.leaves.count | ||
if leaves_count > 0 | ||||
|
r12470 | average = p.leaves.where("estimated_hours > 0").average(:estimated_hours).to_f | ||
|
r3459 | if average == 0 | ||
average = 1 | ||||
end | ||||
|
r12262 | done = p.leaves.joins(:status). | ||
sum("COALESCE(CASE WHEN estimated_hours > 0 THEN estimated_hours ELSE NULL END, #{average}) " + | ||||
|
r13100 | "* (CASE WHEN is_closed = #{self.class.connection.quoted_true} THEN 100 ELSE COALESCE(done_ratio, 0) END)").to_f | ||
|
r3459 | progress = done / (average * leaves_count) | ||
p.done_ratio = progress.round | ||||
end | ||||
end | ||||
|
r5690 | |||
|
r3459 | # estimate = sum of leaves estimates | ||
p.estimated_hours = p.leaves.sum(:estimated_hours).to_f | ||||
p.estimated_hours = nil if p.estimated_hours == 0.0 | ||||
|
r5690 | |||
|
r3459 | # ancestors will be recursively updated | ||
|
r9346 | p.save(:validate => false) | ||
|
r3459 | end | ||
end | ||||
|
r5690 | |||
|
r3023 | # Update issues so their versions are not pointing to a | ||
# fixed_version that is not shared with the issue's project | ||||
def self.update_versions(conditions=nil) | ||||
# Only need to update issues with a fixed_version from | ||||
# a different project and that is not systemwide shared | ||||
|
r13100 | Issue.joins(:project, :fixed_version). | ||
|
r11733 | where("#{Issue.table_name}.fixed_version_id IS NOT NULL" + | ||
|
r8170 | " AND #{Issue.table_name}.project_id <> #{Version.table_name}.project_id" + | ||
|
r11733 | " AND #{Version.table_name}.sharing <> 'system'"). | ||
where(conditions).each do |issue| | ||||
|
r3009 | 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 | ||||
|
r6396 | |||
|
r10194 | # Callback on file attachment | ||
|
r13321 | def attachment_added(attachment) | ||
if current_journal && !attachment.new_record? | ||||
current_journal.journalize_attachment(attachment, :added) | ||||
|
r6192 | end | ||
end | ||||
|
r5690 | |||
|
r2114 | # Callback on attachment deletion | ||
|
r13321 | def attachment_removed(attachment) | ||
if current_journal && !attachment.new_record? | ||||
current_journal.journalize_attachment(attachment, :removed) | ||||
current_journal.save | ||||
|
r8953 | end | ||
|
r2114 | end | ||
|
r5690 | |||
|
r13152 | # Called after a relation is added | ||
def relation_added(relation) | ||||
|
r13321 | if current_journal | ||
current_journal.journalize_relation(relation, :added) | ||||
current_journal.save | ||||
|
r13152 | end | ||
end | ||||
# Called after a relation is removed | ||||
def relation_removed(relation) | ||||
|
r13321 | if current_journal | ||
current_journal.journalize_relation(relation, :removed) | ||||
current_journal.save | ||||
|
r13152 | end | ||
end | ||||
|
r3385 | # Default assignment based on category | ||
def default_assign | ||||
if assigned_to.nil? && category && category.assigned_to | ||||
self.assigned_to = category.assigned_to | ||||
end | ||||
end | ||||
# Updates start/due dates of following issues | ||||
def reschedule_following_issues | ||||
if start_date_changed? || due_date_changed? | ||||
relations_from.each do |relation| | ||||
relation.set_issue_to_dates | ||||
end | ||||
end | ||||
end | ||||
# Closes duplicates if the issue is being closed | ||||
def close_duplicates | ||||
if closing? | ||||
duplicates.each do |duplicate| | ||||
|
r12798 | # Reload is needed in case the duplicate was updated by a previous duplicate | ||
|
r3385 | duplicate.reload | ||
# Don't re-close it if it's already closed | ||||
next if duplicate.closed? | ||||
# Same user and notes | ||||
if @current_journal | ||||
duplicate.init_journal(@current_journal.user, @current_journal.notes) | ||||
end | ||||
duplicate.update_attribute :status, self.status | ||||
end | ||||
end | ||||
end | ||||
|
r5690 | |||
|
r11172 | # Make sure updated_on is updated when adding a note and set updated_on now | ||
# so we can set closed_on with the same value on closing | ||||
|
r9520 | def force_updated_on_change | ||
|
r11172 | if @current_journal || changed? | ||
|
r9520 | self.updated_on = current_time_from_proper_timezone | ||
|
r11172 | if new_record? | ||
self.created_on = updated_on | ||||
end | ||||
end | ||||
end | ||||
# Callback for setting closed_on when the issue is closed. | ||||
# The closed_on attribute stores the time of the last closing | ||||
# and is preserved when the issue is reopened. | ||||
def update_closed_on | ||||
|
r13126 | if closing? | ||
|
r11172 | self.closed_on = updated_on | ||
|
r9520 | end | ||
end | ||||
|
r2577 | # Saves the changes in a Journal | ||
# Called after_save | ||||
def create_journal | ||||
|
r13321 | if current_journal | ||
current_journal.save | ||||
|
r2577 | end | ||
end | ||||
|
r3251 | |||
|
r11791 | def send_notification | ||
if Setting.notified_events.include?('issue_added') | ||||
Mailer.deliver_issue_add(self) | ||||
end | ||||
end | ||||
|
r12144 | # Stores the previous assignee so we can still have access | ||
# to it during after_save callbacks (assigned_to_id_was is reset) | ||||
def set_assigned_to_was | ||||
@previous_assigned_to_id = assigned_to_id_was | ||||
end | ||||
# Clears the previous assignee at the end of after_save callbacks | ||||
def clear_assigned_to_was | ||||
@assigned_to_was = nil | ||||
@previous_assigned_to_id = nil | ||||
end | ||||
|
r2 | end | ||