Chris@1517: # Redmine - project management software Chris@1517: # Copyright (C) 2006-2014 Jean-Philippe Lang Chris@1517: # Chris@1517: # This program is free software; you can redistribute it and/or Chris@1517: # modify it under the terms of the GNU General Public License Chris@1517: # as published by the Free Software Foundation; either version 2 Chris@1517: # of the License, or (at your option) any later version. Chris@1517: # Chris@1517: # This program is distributed in the hope that it will be useful, Chris@1517: # but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@1517: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@1517: # GNU General Public License for more details. Chris@1517: # Chris@1517: # You should have received a copy of the GNU General Public License Chris@1517: # along with this program; if not, write to the Free Software Chris@1517: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Chris@1517: Chris@1517: class Issue < ActiveRecord::Base Chris@1517: include Redmine::SafeAttributes Chris@1517: include Redmine::Utils::DateCalculation Chris@1517: include Redmine::I18n Chris@1517: Chris@1517: belongs_to :project Chris@1517: belongs_to :tracker Chris@1517: belongs_to :status, :class_name => 'IssueStatus', :foreign_key => 'status_id' Chris@1517: belongs_to :author, :class_name => 'User', :foreign_key => 'author_id' Chris@1517: belongs_to :assigned_to, :class_name => 'Principal', :foreign_key => 'assigned_to_id' Chris@1517: belongs_to :fixed_version, :class_name => 'Version', :foreign_key => 'fixed_version_id' Chris@1517: belongs_to :priority, :class_name => 'IssuePriority', :foreign_key => 'priority_id' Chris@1517: belongs_to :category, :class_name => 'IssueCategory', :foreign_key => 'category_id' Chris@1517: Chris@1517: has_many :journals, :as => :journalized, :dependent => :destroy Chris@1517: has_many :visible_journals, Chris@1517: :class_name => 'Journal', Chris@1517: :as => :journalized, Chris@1517: :conditions => Proc.new { Chris@1517: ["(#{Journal.table_name}.private_notes = ? OR (#{Project.allowed_to_condition(User.current, :view_private_notes)}))", false] Chris@1517: }, Chris@1517: :readonly => true Chris@1517: Chris@1517: has_many :time_entries, :dependent => :destroy Chris@1517: has_and_belongs_to_many :changesets, :order => "#{Changeset.table_name}.committed_on ASC, #{Changeset.table_name}.id ASC" Chris@1517: Chris@1517: has_many :relations_from, :class_name => 'IssueRelation', :foreign_key => 'issue_from_id', :dependent => :delete_all Chris@1517: has_many :relations_to, :class_name => 'IssueRelation', :foreign_key => 'issue_to_id', :dependent => :delete_all Chris@1517: Chris@1517: acts_as_nested_set :scope => 'root_id', :dependent => :destroy Chris@1517: acts_as_attachable :after_add => :attachment_added, :after_remove => :attachment_removed Chris@1517: acts_as_customizable Chris@1517: acts_as_watchable Chris@1517: acts_as_searchable :columns => ['subject', "#{table_name}.description", "#{Journal.table_name}.notes"], Chris@1517: :include => [:project, :visible_journals], Chris@1517: # sort by id so that limited eager loading doesn't break with postgresql Chris@1517: :order_column => "#{table_name}.id" Chris@1517: acts_as_event :title => Proc.new {|o| "#{o.tracker.name} ##{o.id} (#{o.status}): #{o.subject}"}, Chris@1517: :url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.id}}, Chris@1517: :type => Proc.new {|o| 'issue' + (o.closed? ? ' closed' : '') } Chris@1517: Chris@1517: acts_as_activity_provider :find_options => {:include => [:project, :author, :tracker]}, Chris@1517: :author_key => :author_id Chris@1517: Chris@1517: DONE_RATIO_OPTIONS = %w(issue_field issue_status) Chris@1517: Chris@1517: attr_reader :current_journal Chris@1517: delegate :notes, :notes=, :private_notes, :private_notes=, :to => :current_journal, :allow_nil => true Chris@1517: Chris@1517: validates_presence_of :subject, :priority, :project, :tracker, :author, :status Chris@1517: Chris@1517: validates_length_of :subject, :maximum => 255 Chris@1517: validates_inclusion_of :done_ratio, :in => 0..100 Chris@1517: validates :estimated_hours, :numericality => {:greater_than_or_equal_to => 0, :allow_nil => true, :message => :invalid} Chris@1517: validates :start_date, :date => true Chris@1517: validates :due_date, :date => true Chris@1517: validate :validate_issue, :validate_required_fields Chris@1517: Chris@1517: scope :visible, lambda {|*args| Chris@1517: includes(:project).where(Issue.visible_condition(args.shift || User.current, *args)) Chris@1517: } Chris@1517: Chris@1517: scope :open, lambda {|*args| Chris@1517: is_closed = args.size > 0 ? !args.first : false Chris@1517: includes(:status).where("#{IssueStatus.table_name}.is_closed = ?", is_closed) Chris@1517: } Chris@1517: Chris@1517: scope :recently_updated, lambda { order("#{Issue.table_name}.updated_on DESC") } Chris@1517: scope :on_active_project, lambda { Chris@1517: includes(:status, :project, :tracker).where("#{Project.table_name}.status = ?", Project::STATUS_ACTIVE) Chris@1517: } Chris@1517: scope :fixed_version, lambda {|versions| Chris@1517: ids = [versions].flatten.compact.map {|v| v.is_a?(Version) ? v.id : v} Chris@1517: ids.any? ? where(:fixed_version_id => ids) : where('1=0') Chris@1517: } Chris@1517: Chris@1517: before_create :default_assign Chris@1517: before_save :close_duplicates, :update_done_ratio_from_issue_status, Chris@1517: :force_updated_on_change, :update_closed_on, :set_assigned_to_was Chris@1517: after_save {|issue| issue.send :after_project_change if !issue.id_changed? && issue.project_id_changed?} Chris@1517: after_save :reschedule_following_issues, :update_nested_set_attributes, Chris@1517: :update_parent_attributes, :create_journal Chris@1517: # Should be after_create but would be called before previous after_save callbacks Chris@1517: after_save :after_create_from_copy Chris@1517: after_destroy :update_parent_attributes Chris@1517: after_create :send_notification Chris@1517: # Keep it at the end of after_save callbacks Chris@1517: after_save :clear_assigned_to_was Chris@1517: Chris@1517: # Returns a SQL conditions string used to find all issues visible by the specified user Chris@1517: def self.visible_condition(user, options={}) Chris@1517: Project.allowed_to_condition(user, :view_issues, options) do |role, user| Chris@1517: if user.logged? Chris@1517: case role.issues_visibility Chris@1517: when 'all' Chris@1517: nil Chris@1517: when 'default' Chris@1517: user_ids = [user.id] + user.groups.map(&:id).compact Chris@1517: "(#{table_name}.is_private = #{connection.quoted_false} OR #{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id IN (#{user_ids.join(',')}))" Chris@1517: when 'own' Chris@1517: user_ids = [user.id] + user.groups.map(&:id).compact Chris@1517: "(#{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id IN (#{user_ids.join(',')}))" Chris@1517: else Chris@1517: '1=0' Chris@1517: end Chris@1517: else Chris@1517: "(#{table_name}.is_private = #{connection.quoted_false})" Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Returns true if usr or current user is allowed to view the issue Chris@1517: def visible?(usr=nil) Chris@1517: (usr || User.current).allowed_to?(:view_issues, self.project) do |role, user| Chris@1517: if user.logged? Chris@1517: case role.issues_visibility Chris@1517: when 'all' Chris@1517: true Chris@1517: when 'default' Chris@1517: !self.is_private? || (self.author == user || user.is_or_belongs_to?(assigned_to)) Chris@1517: when 'own' Chris@1517: self.author == user || user.is_or_belongs_to?(assigned_to) Chris@1517: else Chris@1517: false Chris@1517: end Chris@1517: else Chris@1517: !self.is_private? Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Returns true if user or current user is allowed to edit or add a note to the issue Chris@1517: def editable?(user=User.current) Chris@1517: user.allowed_to?(:edit_issues, project) || user.allowed_to?(:add_issue_notes, project) Chris@1517: end Chris@1517: Chris@1517: def initialize(attributes=nil, *args) Chris@1517: super Chris@1517: if new_record? Chris@1517: # set default values for new records only Chris@1517: self.status ||= IssueStatus.default Chris@1517: self.priority ||= IssuePriority.default Chris@1517: self.watcher_user_ids = [] Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: def create_or_update Chris@1517: super Chris@1517: ensure Chris@1517: @status_was = nil Chris@1517: end Chris@1517: private :create_or_update Chris@1517: Chris@1517: # AR#Persistence#destroy would raise and RecordNotFound exception Chris@1517: # if the issue was already deleted or updated (non matching lock_version). Chris@1517: # This is a problem when bulk deleting issues or deleting a project Chris@1517: # (because an issue may already be deleted if its parent was deleted Chris@1517: # first). Chris@1517: # The issue is reloaded by the nested_set before being deleted so Chris@1517: # the lock_version condition should not be an issue but we handle it. Chris@1517: def destroy Chris@1517: super Chris@1517: rescue ActiveRecord::RecordNotFound Chris@1517: # Stale or already deleted Chris@1517: begin Chris@1517: reload Chris@1517: rescue ActiveRecord::RecordNotFound Chris@1517: # The issue was actually already deleted Chris@1517: @destroyed = true Chris@1517: return freeze Chris@1517: end Chris@1517: # The issue was stale, retry to destroy Chris@1517: super Chris@1517: end Chris@1517: Chris@1517: alias :base_reload :reload Chris@1517: def reload(*args) Chris@1517: @workflow_rule_by_attribute = nil Chris@1517: @assignable_versions = nil Chris@1517: @relations = nil Chris@1517: base_reload(*args) Chris@1517: end Chris@1517: Chris@1517: # Overrides Redmine::Acts::Customizable::InstanceMethods#available_custom_fields Chris@1517: def available_custom_fields Chris@1517: (project && tracker) ? (project.all_issue_custom_fields & tracker.custom_fields) : [] Chris@1517: end Chris@1517: Chris@1517: def visible_custom_field_values(user=nil) Chris@1517: user_real = user || User.current Chris@1517: custom_field_values.select do |value| Chris@1517: value.custom_field.visible_by?(project, user_real) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Copies attributes from another issue, arg can be an id or an Issue Chris@1517: def copy_from(arg, options={}) Chris@1517: issue = arg.is_a?(Issue) ? arg : Issue.visible.find(arg) Chris@1517: self.attributes = issue.attributes.dup.except("id", "root_id", "parent_id", "lft", "rgt", "created_on", "updated_on") Chris@1517: self.custom_field_values = issue.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h} Chris@1517: self.status = issue.status Chris@1517: self.author = User.current Chris@1517: unless options[:attachments] == false Chris@1517: self.attachments = issue.attachments.map do |attachement| Chris@1517: attachement.copy(:container => self) Chris@1517: end Chris@1517: end Chris@1517: @copied_from = issue Chris@1517: @copy_options = options Chris@1517: self Chris@1517: end Chris@1517: Chris@1517: # Returns an unsaved copy of the issue Chris@1517: def copy(attributes=nil, copy_options={}) Chris@1517: copy = self.class.new.copy_from(self, copy_options) Chris@1517: copy.attributes = attributes if attributes Chris@1517: copy Chris@1517: end Chris@1517: Chris@1517: # Returns true if the issue is a copy Chris@1517: def copy? Chris@1517: @copied_from.present? Chris@1517: end Chris@1517: Chris@1517: # Moves/copies an issue to a new project and tracker Chris@1517: # Returns the moved/copied issue on success, false on failure Chris@1517: def move_to_project(new_project, new_tracker=nil, options={}) Chris@1517: ActiveSupport::Deprecation.warn "Issue#move_to_project is deprecated, use #project= instead." Chris@1517: Chris@1517: if options[:copy] Chris@1517: issue = self.copy Chris@1517: else Chris@1517: issue = self Chris@1517: end Chris@1517: Chris@1517: issue.init_journal(User.current, options[:notes]) Chris@1517: Chris@1517: # Preserve previous behaviour Chris@1517: # #move_to_project doesn't change tracker automatically Chris@1517: issue.send :project=, new_project, true Chris@1517: if new_tracker Chris@1517: issue.tracker = new_tracker Chris@1517: end Chris@1517: # Allow bulk setting of attributes on the issue Chris@1517: if options[:attributes] Chris@1517: issue.attributes = options[:attributes] Chris@1517: end Chris@1517: Chris@1517: issue.save ? issue : false Chris@1517: end Chris@1517: Chris@1517: def status_id=(sid) Chris@1517: self.status = nil Chris@1517: result = write_attribute(:status_id, sid) Chris@1517: @workflow_rule_by_attribute = nil Chris@1517: result Chris@1517: end Chris@1517: Chris@1517: def priority_id=(pid) Chris@1517: self.priority = nil Chris@1517: write_attribute(:priority_id, pid) Chris@1517: end Chris@1517: Chris@1517: def category_id=(cid) Chris@1517: self.category = nil Chris@1517: write_attribute(:category_id, cid) Chris@1517: end Chris@1517: Chris@1517: def fixed_version_id=(vid) Chris@1517: self.fixed_version = nil Chris@1517: write_attribute(:fixed_version_id, vid) Chris@1517: end Chris@1517: Chris@1517: def tracker_id=(tid) Chris@1517: self.tracker = nil Chris@1517: result = write_attribute(:tracker_id, tid) Chris@1517: @custom_field_values = nil Chris@1517: @workflow_rule_by_attribute = nil Chris@1517: result Chris@1517: end Chris@1517: Chris@1517: def project_id=(project_id) Chris@1517: if project_id.to_s != self.project_id.to_s Chris@1517: self.project = (project_id.present? ? Project.find_by_id(project_id) : nil) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: def project=(project, keep_tracker=false) Chris@1517: project_was = self.project Chris@1517: write_attribute(:project_id, project ? project.id : nil) Chris@1517: association_instance_set('project', project) Chris@1517: if project_was && project && project_was != project Chris@1517: @assignable_versions = nil Chris@1517: Chris@1517: unless keep_tracker || project.trackers.include?(tracker) Chris@1517: self.tracker = project.trackers.first Chris@1517: end Chris@1517: # Reassign to the category with same name if any Chris@1517: if category Chris@1517: self.category = project.issue_categories.find_by_name(category.name) Chris@1517: end Chris@1517: # Keep the fixed_version if it's still valid in the new_project Chris@1517: if fixed_version && fixed_version.project != project && !project.shared_versions.include?(fixed_version) Chris@1517: self.fixed_version = nil Chris@1517: end Chris@1517: # Clear the parent task if it's no longer valid Chris@1517: unless valid_parent_project? Chris@1517: self.parent_issue_id = nil Chris@1517: end Chris@1517: @custom_field_values = nil Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: def description=(arg) Chris@1517: if arg.is_a?(String) Chris@1517: arg = arg.gsub(/(\r\n|\n|\r)/, "\r\n") Chris@1517: end Chris@1517: write_attribute(:description, arg) Chris@1517: end Chris@1517: Chris@1517: # Overrides assign_attributes so that project and tracker get assigned first Chris@1517: def assign_attributes_with_project_and_tracker_first(new_attributes, *args) Chris@1517: return if new_attributes.nil? Chris@1517: attrs = new_attributes.dup Chris@1517: attrs.stringify_keys! Chris@1517: Chris@1517: %w(project project_id tracker tracker_id).each do |attr| Chris@1517: if attrs.has_key?(attr) Chris@1517: send "#{attr}=", attrs.delete(attr) Chris@1517: end Chris@1517: end Chris@1517: send :assign_attributes_without_project_and_tracker_first, attrs, *args Chris@1517: end Chris@1517: # Do not redefine alias chain on reload (see #4838) Chris@1517: alias_method_chain(:assign_attributes, :project_and_tracker_first) unless method_defined?(:assign_attributes_without_project_and_tracker_first) Chris@1517: Chris@1517: def estimated_hours=(h) Chris@1517: write_attribute :estimated_hours, (h.is_a?(String) ? h.to_hours : h) Chris@1517: end Chris@1517: Chris@1517: safe_attributes 'project_id', Chris@1517: :if => lambda {|issue, user| Chris@1517: if issue.new_record? Chris@1517: issue.copy? Chris@1517: elsif user.allowed_to?(:move_issues, issue.project) Chris@1517: Issue.allowed_target_projects_on_move.count > 1 Chris@1517: end Chris@1517: } Chris@1517: Chris@1517: safe_attributes 'tracker_id', Chris@1517: 'status_id', Chris@1517: 'category_id', Chris@1517: 'assigned_to_id', Chris@1517: 'priority_id', Chris@1517: 'fixed_version_id', Chris@1517: 'subject', Chris@1517: 'description', Chris@1517: 'start_date', Chris@1517: 'due_date', Chris@1517: 'done_ratio', Chris@1517: 'estimated_hours', Chris@1517: 'custom_field_values', Chris@1517: 'custom_fields', Chris@1517: 'lock_version', Chris@1517: 'notes', Chris@1517: :if => lambda {|issue, user| issue.new_record? || user.allowed_to?(:edit_issues, issue.project) } Chris@1517: Chris@1517: safe_attributes 'status_id', Chris@1517: 'assigned_to_id', Chris@1517: 'fixed_version_id', Chris@1517: 'done_ratio', Chris@1517: 'lock_version', Chris@1517: 'notes', Chris@1517: :if => lambda {|issue, user| issue.new_statuses_allowed_to(user).any? } Chris@1517: Chris@1517: safe_attributes 'notes', Chris@1517: :if => lambda {|issue, user| user.allowed_to?(:add_issue_notes, issue.project)} Chris@1517: Chris@1517: safe_attributes 'private_notes', Chris@1517: :if => lambda {|issue, user| !issue.new_record? && user.allowed_to?(:set_notes_private, issue.project)} Chris@1517: Chris@1517: safe_attributes 'watcher_user_ids', Chris@1517: :if => lambda {|issue, user| issue.new_record? && user.allowed_to?(:add_issue_watchers, issue.project)} Chris@1517: Chris@1517: safe_attributes 'is_private', Chris@1517: :if => lambda {|issue, user| Chris@1517: user.allowed_to?(:set_issues_private, issue.project) || Chris@1517: (issue.author == user && user.allowed_to?(:set_own_issues_private, issue.project)) Chris@1517: } Chris@1517: Chris@1517: safe_attributes 'parent_issue_id', Chris@1517: :if => lambda {|issue, user| (issue.new_record? || user.allowed_to?(:edit_issues, issue.project)) && Chris@1517: user.allowed_to?(:manage_subtasks, issue.project)} Chris@1517: Chris@1517: def safe_attribute_names(user=nil) Chris@1517: names = super Chris@1517: names -= disabled_core_fields Chris@1517: names -= read_only_attribute_names(user) Chris@1517: names Chris@1517: end Chris@1517: Chris@1517: # Safely sets attributes Chris@1517: # Should be called from controllers instead of #attributes= Chris@1517: # attr_accessible is too rough because we still want things like Chris@1517: # Issue.new(:project => foo) to work Chris@1517: def safe_attributes=(attrs, user=User.current) Chris@1517: return unless attrs.is_a?(Hash) Chris@1517: Chris@1517: attrs = attrs.dup Chris@1517: Chris@1517: # Project and Tracker must be set before since new_statuses_allowed_to depends on it. Chris@1517: if (p = attrs.delete('project_id')) && safe_attribute?('project_id') Chris@1517: if allowed_target_projects(user).where(:id => p.to_i).exists? Chris@1517: self.project_id = p Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: if (t = attrs.delete('tracker_id')) && safe_attribute?('tracker_id') Chris@1517: self.tracker_id = t Chris@1517: end Chris@1517: Chris@1517: if (s = attrs.delete('status_id')) && safe_attribute?('status_id') Chris@1517: if new_statuses_allowed_to(user).collect(&:id).include?(s.to_i) Chris@1517: self.status_id = s Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: attrs = delete_unsafe_attributes(attrs, user) Chris@1517: return if attrs.empty? Chris@1517: Chris@1517: unless leaf? Chris@1517: attrs.reject! {|k,v| %w(priority_id done_ratio start_date due_date estimated_hours).include?(k)} Chris@1517: end Chris@1517: Chris@1517: if attrs['parent_issue_id'].present? Chris@1517: s = attrs['parent_issue_id'].to_s Chris@1517: unless (m = s.match(%r{\A#?(\d+)\z})) && (m[1] == parent_id.to_s || Issue.visible(user).exists?(m[1])) Chris@1517: @invalid_parent_issue_id = attrs.delete('parent_issue_id') Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: if attrs['custom_field_values'].present? Chris@1517: editable_custom_field_ids = editable_custom_field_values(user).map {|v| v.custom_field_id.to_s} Chris@1517: # TODO: use #select when ruby1.8 support is dropped Chris@1517: attrs['custom_field_values'] = attrs['custom_field_values'].reject {|k, v| !editable_custom_field_ids.include?(k.to_s)} Chris@1517: end Chris@1517: Chris@1517: if attrs['custom_fields'].present? Chris@1517: editable_custom_field_ids = editable_custom_field_values(user).map {|v| v.custom_field_id.to_s} Chris@1517: # TODO: use #select when ruby1.8 support is dropped Chris@1517: attrs['custom_fields'] = attrs['custom_fields'].reject {|c| !editable_custom_field_ids.include?(c['id'].to_s)} Chris@1517: end Chris@1517: Chris@1517: # mass-assignment security bypass Chris@1517: assign_attributes attrs, :without_protection => true Chris@1517: end Chris@1517: Chris@1517: def disabled_core_fields Chris@1517: tracker ? tracker.disabled_core_fields : [] Chris@1517: end Chris@1517: Chris@1517: # Returns the custom_field_values that can be edited by the given user Chris@1517: def editable_custom_field_values(user=nil) Chris@1517: visible_custom_field_values(user).reject do |value| Chris@1517: read_only_attribute_names(user).include?(value.custom_field_id.to_s) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Returns the custom fields that can be edited by the given user Chris@1517: def editable_custom_fields(user=nil) Chris@1517: editable_custom_field_values(user).map(&:custom_field).uniq Chris@1517: end Chris@1517: Chris@1517: # Returns the names of attributes that are read-only for user or the current user Chris@1517: # For users with multiple roles, the read-only fields are the intersection of Chris@1517: # read-only fields of each role Chris@1517: # The result is an array of strings where sustom fields are represented with their ids Chris@1517: # Chris@1517: # Examples: Chris@1517: # issue.read_only_attribute_names # => ['due_date', '2'] Chris@1517: # issue.read_only_attribute_names(user) # => [] Chris@1517: def read_only_attribute_names(user=nil) Chris@1517: workflow_rule_by_attribute(user).reject {|attr, rule| rule != 'readonly'}.keys Chris@1517: end Chris@1517: Chris@1517: # Returns the names of required attributes for user or the current user Chris@1517: # For users with multiple roles, the required fields are the intersection of Chris@1517: # required fields of each role Chris@1517: # The result is an array of strings where sustom fields are represented with their ids Chris@1517: # Chris@1517: # Examples: Chris@1517: # issue.required_attribute_names # => ['due_date', '2'] Chris@1517: # issue.required_attribute_names(user) # => [] Chris@1517: def required_attribute_names(user=nil) Chris@1517: workflow_rule_by_attribute(user).reject {|attr, rule| rule != 'required'}.keys Chris@1517: end Chris@1517: Chris@1517: # Returns true if the attribute is required for user Chris@1517: def required_attribute?(name, user=nil) Chris@1517: required_attribute_names(user).include?(name.to_s) Chris@1517: end Chris@1517: Chris@1517: # Returns a hash of the workflow rule by attribute for the given user Chris@1517: # Chris@1517: # Examples: Chris@1517: # issue.workflow_rule_by_attribute # => {'due_date' => 'required', 'start_date' => 'readonly'} Chris@1517: def workflow_rule_by_attribute(user=nil) Chris@1517: return @workflow_rule_by_attribute if @workflow_rule_by_attribute && user.nil? Chris@1517: Chris@1517: user_real = user || User.current Chris@1517: roles = user_real.admin ? Role.all : user_real.roles_for_project(project) Chris@1517: return {} if roles.empty? Chris@1517: Chris@1517: result = {} Chris@1517: workflow_permissions = WorkflowPermission.where(:tracker_id => tracker_id, :old_status_id => status_id, :role_id => roles.map(&:id)).all Chris@1517: if workflow_permissions.any? Chris@1517: workflow_rules = workflow_permissions.inject({}) do |h, wp| Chris@1517: h[wp.field_name] ||= [] Chris@1517: h[wp.field_name] << wp.rule Chris@1517: h Chris@1517: end Chris@1517: workflow_rules.each do |attr, rules| Chris@1517: next if rules.size < roles.size Chris@1517: uniq_rules = rules.uniq Chris@1517: if uniq_rules.size == 1 Chris@1517: result[attr] = uniq_rules.first Chris@1517: else Chris@1517: result[attr] = 'required' Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: @workflow_rule_by_attribute = result if user.nil? Chris@1517: result Chris@1517: end Chris@1517: private :workflow_rule_by_attribute Chris@1517: Chris@1517: def done_ratio Chris@1517: if Issue.use_status_for_done_ratio? && status && status.default_done_ratio Chris@1517: status.default_done_ratio Chris@1517: else Chris@1517: read_attribute(:done_ratio) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: def self.use_status_for_done_ratio? Chris@1517: Setting.issue_done_ratio == 'issue_status' Chris@1517: end Chris@1517: Chris@1517: def self.use_field_for_done_ratio? Chris@1517: Setting.issue_done_ratio == 'issue_field' Chris@1517: end Chris@1517: Chris@1517: def validate_issue Chris@1517: if due_date && start_date && (start_date_changed? || due_date_changed?) && due_date < start_date Chris@1517: errors.add :due_date, :greater_than_start_date Chris@1517: end Chris@1517: Chris@1517: if start_date && start_date_changed? && soonest_start && start_date < soonest_start Chris@1517: errors.add :start_date, :earlier_than_minimum_start_date, :date => format_date(soonest_start) Chris@1517: end Chris@1517: Chris@1517: if fixed_version Chris@1517: if !assignable_versions.include?(fixed_version) Chris@1517: errors.add :fixed_version_id, :inclusion Chris@1517: elsif reopened? && fixed_version.closed? Chris@1517: errors.add :base, I18n.t(:error_can_not_reopen_issue_on_closed_version) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Checks that the issue can not be added/moved to a disabled tracker Chris@1517: if project && (tracker_id_changed? || project_id_changed?) Chris@1517: unless project.trackers.include?(tracker) Chris@1517: errors.add :tracker_id, :inclusion Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Checks parent issue assignment Chris@1517: if @invalid_parent_issue_id.present? Chris@1517: errors.add :parent_issue_id, :invalid Chris@1517: elsif @parent_issue Chris@1517: if !valid_parent_project?(@parent_issue) Chris@1517: errors.add :parent_issue_id, :invalid Chris@1517: elsif (@parent_issue != parent) && (all_dependent_issues.include?(@parent_issue) || @parent_issue.all_dependent_issues.include?(self)) Chris@1517: errors.add :parent_issue_id, :invalid Chris@1517: elsif !new_record? Chris@1517: # moving an existing issue Chris@1517: if @parent_issue.root_id != root_id Chris@1517: # we can always move to another tree Chris@1517: elsif move_possible?(@parent_issue) Chris@1517: # move accepted inside tree Chris@1517: else Chris@1517: errors.add :parent_issue_id, :invalid Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Validates the issue against additional workflow requirements Chris@1517: def validate_required_fields Chris@1517: user = new_record? ? author : current_journal.try(:user) Chris@1517: Chris@1517: required_attribute_names(user).each do |attribute| Chris@1517: if attribute =~ /^\d+$/ Chris@1517: attribute = attribute.to_i Chris@1517: v = custom_field_values.detect {|v| v.custom_field_id == attribute } Chris@1517: if v && v.value.blank? Chris@1517: errors.add :base, v.custom_field.name + ' ' + l('activerecord.errors.messages.blank') Chris@1517: end Chris@1517: else Chris@1517: if respond_to?(attribute) && send(attribute).blank? Chris@1517: errors.add attribute, :blank Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Set the done_ratio using the status if that setting is set. This will keep the done_ratios Chris@1517: # even if the user turns off the setting later Chris@1517: def update_done_ratio_from_issue_status Chris@1517: if Issue.use_status_for_done_ratio? && status && status.default_done_ratio Chris@1517: self.done_ratio = status.default_done_ratio Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: def init_journal(user, notes = "") Chris@1517: @current_journal ||= Journal.new(:journalized => self, :user => user, :notes => notes) Chris@1517: if new_record? Chris@1517: @current_journal.notify = false Chris@1517: else Chris@1517: @attributes_before_change = attributes.dup Chris@1517: @custom_values_before_change = {} Chris@1517: self.custom_field_values.each {|c| @custom_values_before_change.store c.custom_field_id, c.value } Chris@1517: end Chris@1517: @current_journal Chris@1517: end Chris@1517: Chris@1517: # Returns the id of the last journal or nil Chris@1517: def last_journal_id Chris@1517: if new_record? Chris@1517: nil Chris@1517: else Chris@1517: journals.maximum(:id) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Returns a scope for journals that have an id greater than journal_id Chris@1517: def journals_after(journal_id) Chris@1517: scope = journals.reorder("#{Journal.table_name}.id ASC") Chris@1517: if journal_id.present? Chris@1517: scope = scope.where("#{Journal.table_name}.id > ?", journal_id.to_i) Chris@1517: end Chris@1517: scope Chris@1517: end Chris@1517: Chris@1517: # Returns the initial status of the issue Chris@1517: # Returns nil for a new issue Chris@1517: def status_was Chris@1517: if status_id_was && status_id_was.to_i > 0 Chris@1517: @status_was ||= IssueStatus.find_by_id(status_id_was) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Return true if the issue is closed, otherwise false Chris@1517: def closed? Chris@1517: self.status.is_closed? Chris@1517: end Chris@1517: Chris@1517: # Return true if the issue is being reopened Chris@1517: def reopened? Chris@1517: if !new_record? && status_id_changed? Chris@1517: status_was = IssueStatus.find_by_id(status_id_was) Chris@1517: status_new = IssueStatus.find_by_id(status_id) Chris@1517: if status_was && status_new && status_was.is_closed? && !status_new.is_closed? Chris@1517: return true Chris@1517: end Chris@1517: end Chris@1517: false Chris@1517: end Chris@1517: Chris@1517: # Return true if the issue is being closed Chris@1517: def closing? Chris@1517: if !new_record? && status_id_changed? Chris@1517: if status_was && status && !status_was.is_closed? && status.is_closed? Chris@1517: return true Chris@1517: end Chris@1517: end Chris@1517: false Chris@1517: end Chris@1517: Chris@1517: # Returns true if the issue is overdue Chris@1517: def overdue? Chris@1517: !due_date.nil? && (due_date < Date.today) && !status.is_closed? Chris@1517: end Chris@1517: Chris@1517: # Is the amount of work done less than it should for the due date Chris@1517: def behind_schedule? Chris@1517: return false if start_date.nil? || due_date.nil? Chris@1517: done_date = start_date + ((due_date - start_date + 1) * done_ratio / 100).floor Chris@1517: return done_date <= Date.today Chris@1517: end Chris@1517: Chris@1517: # Does this issue have children? Chris@1517: def children? Chris@1517: !leaf? Chris@1517: end Chris@1517: Chris@1517: # Users the issue can be assigned to Chris@1517: def assignable_users Chris@1517: users = project.assignable_users Chris@1517: users << author if author Chris@1517: users << assigned_to if assigned_to Chris@1517: users.uniq.sort Chris@1517: end Chris@1517: Chris@1517: # Versions that the issue can be assigned to Chris@1517: def assignable_versions Chris@1517: return @assignable_versions if @assignable_versions Chris@1517: Chris@1517: versions = project.shared_versions.open.all Chris@1517: if fixed_version Chris@1517: if fixed_version_id_changed? Chris@1517: # nothing to do Chris@1517: elsif project_id_changed? Chris@1517: if project.shared_versions.include?(fixed_version) Chris@1517: versions << fixed_version Chris@1517: end Chris@1517: else Chris@1517: versions << fixed_version Chris@1517: end Chris@1517: end Chris@1517: @assignable_versions = versions.uniq.sort Chris@1517: end Chris@1517: Chris@1517: # Returns true if this issue is blocked by another issue that is still open Chris@1517: def blocked? Chris@1517: !relations_to.detect {|ir| ir.relation_type == 'blocks' && !ir.issue_from.closed?}.nil? Chris@1517: end Chris@1517: Chris@1517: # Returns an array of statuses that user is able to apply Chris@1517: def new_statuses_allowed_to(user=User.current, include_default=false) Chris@1517: if new_record? && @copied_from Chris@1517: [IssueStatus.default, @copied_from.status].compact.uniq.sort Chris@1517: else Chris@1517: initial_status = nil Chris@1517: if new_record? Chris@1517: initial_status = IssueStatus.default Chris@1517: elsif status_id_was Chris@1517: initial_status = IssueStatus.find_by_id(status_id_was) Chris@1517: end Chris@1517: initial_status ||= status Chris@1517: Chris@1517: initial_assigned_to_id = assigned_to_id_changed? ? assigned_to_id_was : assigned_to_id Chris@1517: assignee_transitions_allowed = initial_assigned_to_id.present? && Chris@1517: (user.id == initial_assigned_to_id || user.group_ids.include?(initial_assigned_to_id)) Chris@1517: Chris@1517: statuses = initial_status.find_new_statuses_allowed_to( Chris@1517: user.admin ? Role.all : user.roles_for_project(project), Chris@1517: tracker, Chris@1517: author == user, Chris@1517: assignee_transitions_allowed Chris@1517: ) Chris@1517: statuses << initial_status unless statuses.empty? Chris@1517: statuses << IssueStatus.default if include_default Chris@1517: statuses = statuses.compact.uniq.sort Chris@1517: blocked? ? statuses.reject {|s| s.is_closed?} : statuses Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Returns the previous assignee if changed Chris@1517: def assigned_to_was Chris@1517: # assigned_to_id_was is reset before after_save callbacks Chris@1517: user_id = @previous_assigned_to_id || assigned_to_id_was Chris@1517: if user_id && user_id != assigned_to_id Chris@1517: @assigned_to_was ||= User.find_by_id(user_id) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Returns the users that should be notified Chris@1517: def notified_users Chris@1517: notified = [] Chris@1517: # Author and assignee are always notified unless they have been Chris@1517: # locked or don't want to be notified Chris@1517: notified << author if author Chris@1517: if assigned_to Chris@1517: notified += (assigned_to.is_a?(Group) ? assigned_to.users : [assigned_to]) Chris@1517: end Chris@1517: if assigned_to_was Chris@1517: notified += (assigned_to_was.is_a?(Group) ? assigned_to_was.users : [assigned_to_was]) Chris@1517: end Chris@1517: notified = notified.select {|u| u.active? && u.notify_about?(self)} Chris@1517: Chris@1517: notified += project.notified_users Chris@1517: notified.uniq! Chris@1517: # Remove users that can not view the issue Chris@1517: notified.reject! {|user| !visible?(user)} Chris@1517: notified Chris@1517: end Chris@1517: Chris@1517: # Returns the email addresses that should be notified Chris@1517: def recipients Chris@1517: notified_users.collect(&:mail) Chris@1517: end Chris@1517: Chris@1517: def each_notification(users, &block) Chris@1517: if users.any? Chris@1517: if custom_field_values.detect {|value| !value.custom_field.visible?} Chris@1517: users_by_custom_field_visibility = users.group_by do |user| Chris@1517: visible_custom_field_values(user).map(&:custom_field_id).sort Chris@1517: end Chris@1517: users_by_custom_field_visibility.values.each do |users| Chris@1517: yield(users) Chris@1517: end Chris@1517: else Chris@1517: yield(users) Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Returns the number of hours spent on this issue Chris@1517: def spent_hours Chris@1517: @spent_hours ||= time_entries.sum(:hours) || 0 Chris@1517: end Chris@1517: Chris@1517: # Returns the total number of hours spent on this issue and its descendants Chris@1517: # Chris@1517: # Example: Chris@1517: # spent_hours => 0.0 Chris@1517: # spent_hours => 50.2 Chris@1517: def total_spent_hours Chris@1517: @total_spent_hours ||= Chris@1517: self_and_descendants. Chris@1517: joins("LEFT JOIN #{TimeEntry.table_name} ON #{TimeEntry.table_name}.issue_id = #{Issue.table_name}.id"). Chris@1517: sum("#{TimeEntry.table_name}.hours").to_f || 0.0 Chris@1517: end Chris@1517: Chris@1517: def relations Chris@1517: @relations ||= IssueRelation::Relations.new(self, (relations_from + relations_to).sort) Chris@1517: end Chris@1517: Chris@1517: # Preloads relations for a collection of issues Chris@1517: def self.load_relations(issues) Chris@1517: if issues.any? Chris@1517: relations = IssueRelation.where("issue_from_id IN (:ids) OR issue_to_id IN (:ids)", :ids => issues.map(&:id)).all Chris@1517: issues.each do |issue| Chris@1517: issue.instance_variable_set "@relations", relations.select {|r| r.issue_from_id == issue.id || r.issue_to_id == issue.id} Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Preloads visible spent time for a collection of issues Chris@1517: def self.load_visible_spent_hours(issues, user=User.current) Chris@1517: if issues.any? Chris@1517: hours_by_issue_id = TimeEntry.visible(user).group(:issue_id).sum(:hours) Chris@1517: issues.each do |issue| Chris@1517: issue.instance_variable_set "@spent_hours", (hours_by_issue_id[issue.id] || 0) Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Preloads visible relations for a collection of issues Chris@1517: def self.load_visible_relations(issues, user=User.current) Chris@1517: if issues.any? Chris@1517: issue_ids = issues.map(&:id) Chris@1517: # Relations with issue_from in given issues and visible issue_to Chris@1517: relations_from = IssueRelation.includes(:issue_to => [:status, :project]).where(visible_condition(user)).where(:issue_from_id => issue_ids).all Chris@1517: # Relations with issue_to in given issues and visible issue_from Chris@1517: relations_to = IssueRelation.includes(:issue_from => [:status, :project]).where(visible_condition(user)).where(:issue_to_id => issue_ids).all Chris@1517: Chris@1517: issues.each do |issue| Chris@1517: relations = Chris@1517: relations_from.select {|relation| relation.issue_from_id == issue.id} + Chris@1517: relations_to.select {|relation| relation.issue_to_id == issue.id} Chris@1517: Chris@1517: issue.instance_variable_set "@relations", IssueRelation::Relations.new(issue, relations.sort) Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Finds an issue relation given its id. Chris@1517: def find_relation(relation_id) Chris@1517: IssueRelation.where("issue_to_id = ? OR issue_from_id = ?", id, id).find(relation_id) Chris@1517: end Chris@1517: Chris@1517: # Returns all the other issues that depend on the issue Chris@1517: # The algorithm is a modified breadth first search (bfs) Chris@1517: def all_dependent_issues(except=[]) Chris@1517: # The found dependencies Chris@1517: dependencies = [] Chris@1517: Chris@1517: # The visited flag for every node (issue) used by the breadth first search Chris@1517: eNOT_DISCOVERED = 0 # The issue is "new" to the algorithm, it has not seen it before. Chris@1517: Chris@1517: ePROCESS_ALL = 1 # The issue is added to the queue. Process both children and relations of Chris@1517: # the issue when it is processed. Chris@1517: Chris@1517: ePROCESS_RELATIONS_ONLY = 2 # The issue was added to the queue and will be output as dependent issue, Chris@1517: # but its children will not be added to the queue when it is processed. Chris@1517: Chris@1517: eRELATIONS_PROCESSED = 3 # The related issues, the parent issue and the issue itself have been added to Chris@1517: # the queue, but its children have not been added. Chris@1517: Chris@1517: ePROCESS_CHILDREN_ONLY = 4 # The relations and the parent of the issue have been added to the queue, but Chris@1517: # the children still need to be processed. Chris@1517: Chris@1517: eALL_PROCESSED = 5 # The issue and all its children, its parent and its related issues have been Chris@1517: # added as dependent issues. It needs no further processing. Chris@1517: Chris@1517: issue_status = Hash.new(eNOT_DISCOVERED) Chris@1517: Chris@1517: # The queue Chris@1517: queue = [] Chris@1517: Chris@1517: # Initialize the bfs, add start node (self) to the queue Chris@1517: queue << self Chris@1517: issue_status[self] = ePROCESS_ALL Chris@1517: Chris@1517: while (!queue.empty?) do Chris@1517: current_issue = queue.shift Chris@1517: current_issue_status = issue_status[current_issue] Chris@1517: dependencies << current_issue Chris@1517: Chris@1517: # Add parent to queue, if not already in it. Chris@1517: parent = current_issue.parent Chris@1517: parent_status = issue_status[parent] Chris@1517: Chris@1517: if parent && (parent_status == eNOT_DISCOVERED) && !except.include?(parent) Chris@1517: queue << parent Chris@1517: issue_status[parent] = ePROCESS_RELATIONS_ONLY Chris@1517: end Chris@1517: Chris@1517: # Add children to queue, but only if they are not already in it and Chris@1517: # the children of the current node need to be processed. Chris@1517: if (current_issue_status == ePROCESS_CHILDREN_ONLY || current_issue_status == ePROCESS_ALL) Chris@1517: current_issue.children.each do |child| Chris@1517: next if except.include?(child) Chris@1517: Chris@1517: if (issue_status[child] == eNOT_DISCOVERED) Chris@1517: queue << child Chris@1517: issue_status[child] = ePROCESS_ALL Chris@1517: elsif (issue_status[child] == eRELATIONS_PROCESSED) Chris@1517: queue << child Chris@1517: issue_status[child] = ePROCESS_CHILDREN_ONLY Chris@1517: elsif (issue_status[child] == ePROCESS_RELATIONS_ONLY) Chris@1517: queue << child Chris@1517: issue_status[child] = ePROCESS_ALL Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Add related issues to the queue, if they are not already in it. Chris@1517: current_issue.relations_from.map(&:issue_to).each do |related_issue| Chris@1517: next if except.include?(related_issue) Chris@1517: Chris@1517: if (issue_status[related_issue] == eNOT_DISCOVERED) Chris@1517: queue << related_issue Chris@1517: issue_status[related_issue] = ePROCESS_ALL Chris@1517: elsif (issue_status[related_issue] == eRELATIONS_PROCESSED) Chris@1517: queue << related_issue Chris@1517: issue_status[related_issue] = ePROCESS_CHILDREN_ONLY Chris@1517: elsif (issue_status[related_issue] == ePROCESS_RELATIONS_ONLY) Chris@1517: queue << related_issue Chris@1517: issue_status[related_issue] = ePROCESS_ALL Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Set new status for current issue Chris@1517: if (current_issue_status == ePROCESS_ALL) || (current_issue_status == ePROCESS_CHILDREN_ONLY) Chris@1517: issue_status[current_issue] = eALL_PROCESSED Chris@1517: elsif (current_issue_status == ePROCESS_RELATIONS_ONLY) Chris@1517: issue_status[current_issue] = eRELATIONS_PROCESSED Chris@1517: end Chris@1517: end # while Chris@1517: Chris@1517: # Remove the issues from the "except" parameter from the result array Chris@1517: dependencies -= except Chris@1517: dependencies.delete(self) Chris@1517: Chris@1517: dependencies Chris@1517: end Chris@1517: Chris@1517: # Returns an array of issues that duplicate this one Chris@1517: def duplicates Chris@1517: relations_to.select {|r| r.relation_type == IssueRelation::TYPE_DUPLICATES}.collect {|r| r.issue_from} Chris@1517: end Chris@1517: Chris@1517: # Returns the due date or the target due date if any Chris@1517: # Used on gantt chart Chris@1517: def due_before Chris@1517: due_date || (fixed_version ? fixed_version.effective_date : nil) Chris@1517: end Chris@1517: Chris@1517: # Returns the time scheduled for this issue. Chris@1517: # Chris@1517: # Example: Chris@1517: # Start Date: 2/26/09, End Date: 3/04/09 Chris@1517: # duration => 6 Chris@1517: def duration Chris@1517: (start_date && due_date) ? due_date - start_date : 0 Chris@1517: end Chris@1517: Chris@1517: # Returns the duration in working days Chris@1517: def working_duration Chris@1517: (start_date && due_date) ? working_days(start_date, due_date) : 0 Chris@1517: end Chris@1517: Chris@1517: def soonest_start(reload=false) Chris@1517: @soonest_start = nil if reload Chris@1517: @soonest_start ||= ( Chris@1517: relations_to(reload).collect{|relation| relation.successor_soonest_start} + Chris@1517: [(@parent_issue || parent).try(:soonest_start)] Chris@1517: ).compact.max Chris@1517: end Chris@1517: Chris@1517: # Sets start_date on the given date or the next working day Chris@1517: # and changes due_date to keep the same working duration. Chris@1517: def reschedule_on(date) Chris@1517: wd = working_duration Chris@1517: date = next_working_date(date) Chris@1517: self.start_date = date Chris@1517: self.due_date = add_working_days(date, wd) Chris@1517: end Chris@1517: Chris@1517: # Reschedules the issue on the given date or the next working day and saves the record. Chris@1517: # If the issue is a parent task, this is done by rescheduling its subtasks. Chris@1517: def reschedule_on!(date) Chris@1517: return if date.nil? Chris@1517: if leaf? Chris@1517: if start_date.nil? || start_date != date Chris@1517: if start_date && start_date > date Chris@1517: # Issue can not be moved earlier than its soonest start date Chris@1517: date = [soonest_start(true), date].compact.max Chris@1517: end Chris@1517: reschedule_on(date) Chris@1517: begin Chris@1517: save Chris@1517: rescue ActiveRecord::StaleObjectError Chris@1517: reload Chris@1517: reschedule_on(date) Chris@1517: save Chris@1517: end Chris@1517: end Chris@1517: else Chris@1517: leaves.each do |leaf| Chris@1517: if leaf.start_date Chris@1517: # Only move subtask if it starts at the same date as the parent Chris@1517: # or if it starts before the given date Chris@1517: if start_date == leaf.start_date || date > leaf.start_date Chris@1517: leaf.reschedule_on!(date) Chris@1517: end Chris@1517: else Chris@1517: leaf.reschedule_on!(date) Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: def <=>(issue) Chris@1517: if issue.nil? Chris@1517: -1 Chris@1517: elsif root_id != issue.root_id Chris@1517: (root_id || 0) <=> (issue.root_id || 0) Chris@1517: else Chris@1517: (lft || 0) <=> (issue.lft || 0) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: def to_s Chris@1517: "#{tracker} ##{id}: #{subject}" Chris@1517: end Chris@1517: Chris@1517: # Returns a string of css classes that apply to the issue Chris@1517: def css_classes(user=User.current) Chris@1517: s = "issue tracker-#{tracker_id} status-#{status_id} #{priority.try(:css_classes)}" Chris@1517: s << ' closed' if closed? Chris@1517: s << ' overdue' if overdue? Chris@1517: s << ' child' if child? Chris@1517: s << ' parent' unless leaf? Chris@1517: s << ' private' if is_private? Chris@1517: if user.logged? Chris@1517: s << ' created-by-me' if author_id == user.id Chris@1517: s << ' assigned-to-me' if assigned_to_id == user.id Chris@1517: s << ' assigned-to-my-group' if user.groups.any? {|g| g.id == assigned_to_id} Chris@1517: end Chris@1517: s Chris@1517: end Chris@1517: Chris@1517: # Unassigns issues from +version+ if it's no longer shared with issue's project Chris@1517: def self.update_versions_from_sharing_change(version) Chris@1517: # Update issues assigned to the version Chris@1517: update_versions(["#{Issue.table_name}.fixed_version_id = ?", version.id]) Chris@1517: end Chris@1517: Chris@1517: # Unassigns issues from versions that are no longer shared Chris@1517: # after +project+ was moved Chris@1517: def self.update_versions_from_hierarchy_change(project) Chris@1517: moved_project_ids = project.self_and_descendants.reload.collect(&:id) Chris@1517: # Update issues of the moved projects and issues assigned to a version of a moved project Chris@1517: Issue.update_versions(["#{Version.table_name}.project_id IN (?) OR #{Issue.table_name}.project_id IN (?)", moved_project_ids, moved_project_ids]) Chris@1517: end Chris@1517: Chris@1517: def parent_issue_id=(arg) Chris@1517: s = arg.to_s.strip.presence Chris@1517: if s && (m = s.match(%r{\A#?(\d+)\z})) && (@parent_issue = Issue.find_by_id(m[1])) Chris@1517: @parent_issue.id Chris@1517: @invalid_parent_issue_id = nil Chris@1517: elsif s.blank? Chris@1517: @parent_issue = nil Chris@1517: @invalid_parent_issue_id = nil Chris@1517: else Chris@1517: @parent_issue = nil Chris@1517: @invalid_parent_issue_id = arg Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: def parent_issue_id Chris@1517: if @invalid_parent_issue_id Chris@1517: @invalid_parent_issue_id Chris@1517: elsif instance_variable_defined? :@parent_issue Chris@1517: @parent_issue.nil? ? nil : @parent_issue.id Chris@1517: else Chris@1517: parent_id Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Returns true if issue's project is a valid Chris@1517: # parent issue project Chris@1517: def valid_parent_project?(issue=parent) Chris@1517: return true if issue.nil? || issue.project_id == project_id Chris@1517: Chris@1517: case Setting.cross_project_subtasks Chris@1517: when 'system' Chris@1517: true Chris@1517: when 'tree' Chris@1517: issue.project.root == project.root Chris@1517: when 'hierarchy' Chris@1517: issue.project.is_or_is_ancestor_of?(project) || issue.project.is_descendant_of?(project) Chris@1517: when 'descendants' Chris@1517: issue.project.is_or_is_ancestor_of?(project) Chris@1517: else Chris@1517: false Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Extracted from the ReportsController. Chris@1517: def self.by_tracker(project) Chris@1517: count_and_group_by(:project => project, Chris@1517: :field => 'tracker_id', Chris@1517: :joins => Tracker.table_name) Chris@1517: end Chris@1517: Chris@1517: def self.by_version(project) Chris@1517: count_and_group_by(:project => project, Chris@1517: :field => 'fixed_version_id', Chris@1517: :joins => Version.table_name) Chris@1517: end Chris@1517: Chris@1517: def self.by_priority(project) Chris@1517: count_and_group_by(:project => project, Chris@1517: :field => 'priority_id', Chris@1517: :joins => IssuePriority.table_name) Chris@1517: end Chris@1517: Chris@1517: def self.by_category(project) Chris@1517: count_and_group_by(:project => project, Chris@1517: :field => 'category_id', Chris@1517: :joins => IssueCategory.table_name) Chris@1517: end Chris@1517: Chris@1517: def self.by_assigned_to(project) Chris@1517: count_and_group_by(:project => project, Chris@1517: :field => 'assigned_to_id', Chris@1517: :joins => User.table_name) Chris@1517: end Chris@1517: Chris@1517: def self.by_author(project) Chris@1517: count_and_group_by(:project => project, Chris@1517: :field => 'author_id', Chris@1517: :joins => User.table_name) Chris@1517: end Chris@1517: Chris@1517: def self.by_subproject(project) Chris@1517: ActiveRecord::Base.connection.select_all("select s.id as status_id, Chris@1517: s.is_closed as closed, Chris@1517: #{Issue.table_name}.project_id as project_id, Chris@1517: count(#{Issue.table_name}.id) as total Chris@1517: from Chris@1517: #{Issue.table_name}, #{Project.table_name}, #{IssueStatus.table_name} s Chris@1517: where Chris@1517: #{Issue.table_name}.status_id=s.id Chris@1517: and #{Issue.table_name}.project_id = #{Project.table_name}.id Chris@1517: and #{visible_condition(User.current, :project => project, :with_subprojects => true)} Chris@1517: and #{Issue.table_name}.project_id <> #{project.id} Chris@1517: group by s.id, s.is_closed, #{Issue.table_name}.project_id") if project.descendants.active.any? Chris@1517: end Chris@1517: # End ReportsController extraction Chris@1517: Chris@1517: # Returns a scope of projects that user can assign the issue to Chris@1517: def allowed_target_projects(user=User.current) Chris@1517: if new_record? Chris@1517: Project.where(Project.allowed_to_condition(user, :add_issues)) Chris@1517: else Chris@1517: self.class.allowed_target_projects_on_move(user) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Returns a scope of projects that user can move issues to Chris@1517: def self.allowed_target_projects_on_move(user=User.current) Chris@1517: Project.where(Project.allowed_to_condition(user, :move_issues)) Chris@1517: end Chris@1517: Chris@1517: private Chris@1517: Chris@1517: def after_project_change Chris@1517: # Update project_id on related time entries Chris@1517: TimeEntry.where({:issue_id => id}).update_all(["project_id = ?", project_id]) Chris@1517: Chris@1517: # Delete issue relations Chris@1517: unless Setting.cross_project_issue_relations? Chris@1517: relations_from.clear Chris@1517: relations_to.clear Chris@1517: end Chris@1517: Chris@1517: # Move subtasks that were in the same project Chris@1517: children.each do |child| Chris@1517: next unless child.project_id == project_id_was Chris@1517: # Change project and keep project Chris@1517: child.send :project=, project, true Chris@1517: unless child.save Chris@1517: raise ActiveRecord::Rollback Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Callback for after the creation of an issue by copy Chris@1517: # * adds a "copied to" relation with the copied issue Chris@1517: # * copies subtasks from the copied issue Chris@1517: def after_create_from_copy Chris@1517: return unless copy? && !@after_create_from_copy_handled Chris@1517: Chris@1517: if (@copied_from.project_id == project_id || Setting.cross_project_issue_relations?) && @copy_options[:link] != false Chris@1517: relation = IssueRelation.new(:issue_from => @copied_from, :issue_to => self, :relation_type => IssueRelation::TYPE_COPIED_TO) Chris@1517: unless relation.save Chris@1517: logger.error "Could not create relation while copying ##{@copied_from.id} to ##{id} due to validation errors: #{relation.errors.full_messages.join(', ')}" if logger Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: unless @copied_from.leaf? || @copy_options[:subtasks] == false Chris@1517: copy_options = (@copy_options || {}).merge(:subtasks => false) Chris@1517: copied_issue_ids = {@copied_from.id => self.id} Chris@1517: @copied_from.reload.descendants.reorder("#{Issue.table_name}.lft").each do |child| Chris@1517: # Do not copy self when copying an issue as a descendant of the copied issue Chris@1517: next if child == self Chris@1517: # Do not copy subtasks of issues that were not copied Chris@1517: next unless copied_issue_ids[child.parent_id] Chris@1517: # Do not copy subtasks that are not visible to avoid potential disclosure of private data Chris@1517: unless child.visible? Chris@1517: logger.error "Subtask ##{child.id} was not copied during ##{@copied_from.id} copy because it is not visible to the current user" if logger Chris@1517: next Chris@1517: end Chris@1517: copy = Issue.new.copy_from(child, copy_options) Chris@1517: copy.author = author Chris@1517: copy.project = project Chris@1517: copy.parent_issue_id = copied_issue_ids[child.parent_id] Chris@1517: unless copy.save Chris@1517: 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 Chris@1517: next Chris@1517: end Chris@1517: copied_issue_ids[child.id] = copy.id Chris@1517: end Chris@1517: end Chris@1517: @after_create_from_copy_handled = true Chris@1517: end Chris@1517: Chris@1517: def update_nested_set_attributes Chris@1517: if root_id.nil? Chris@1517: # issue was just created Chris@1517: self.root_id = (@parent_issue.nil? ? id : @parent_issue.root_id) Chris@1517: set_default_left_and_right Chris@1517: Issue.where(["id = ?", id]). Chris@1517: update_all(["root_id = ?, lft = ?, rgt = ?", root_id, lft, rgt]) Chris@1517: if @parent_issue Chris@1517: move_to_child_of(@parent_issue) Chris@1517: end Chris@1517: elsif parent_issue_id != parent_id Chris@1517: update_nested_set_attributes_on_parent_change Chris@1517: end Chris@1517: remove_instance_variable(:@parent_issue) if instance_variable_defined?(:@parent_issue) Chris@1517: end Chris@1517: Chris@1517: # Updates the nested set for when an existing issue is moved Chris@1517: def update_nested_set_attributes_on_parent_change Chris@1517: former_parent_id = parent_id Chris@1517: # moving an existing issue Chris@1517: if @parent_issue && @parent_issue.root_id == root_id Chris@1517: # inside the same tree Chris@1517: move_to_child_of(@parent_issue) Chris@1517: else Chris@1517: # to another tree Chris@1517: unless root? Chris@1517: move_to_right_of(root) Chris@1517: end Chris@1517: old_root_id = root_id Chris@1517: self.root_id = (@parent_issue.nil? ? id : @parent_issue.root_id ) Chris@1517: target_maxright = nested_set_scope.maximum(right_column_name) || 0 Chris@1517: offset = target_maxright + 1 - lft Chris@1517: Issue.where(["root_id = ? AND lft >= ? AND rgt <= ? ", old_root_id, lft, rgt]). Chris@1517: update_all(["root_id = ?, lft = lft + ?, rgt = rgt + ?", root_id, offset, offset]) Chris@1517: self[left_column_name] = lft + offset Chris@1517: self[right_column_name] = rgt + offset Chris@1517: if @parent_issue Chris@1517: move_to_child_of(@parent_issue) Chris@1517: end Chris@1517: end Chris@1517: # delete invalid relations of all descendants Chris@1517: self_and_descendants.each do |issue| Chris@1517: issue.relations.each do |relation| Chris@1517: relation.destroy unless relation.valid? Chris@1517: end Chris@1517: end Chris@1517: # update former parent Chris@1517: recalculate_attributes_for(former_parent_id) if former_parent_id Chris@1517: end Chris@1517: Chris@1517: def update_parent_attributes Chris@1517: recalculate_attributes_for(parent_id) if parent_id Chris@1517: end Chris@1517: Chris@1517: def recalculate_attributes_for(issue_id) Chris@1517: if issue_id && p = Issue.find_by_id(issue_id) Chris@1517: # priority = highest priority of children Chris@1517: if priority_position = p.children.joins(:priority).maximum("#{IssuePriority.table_name}.position") Chris@1517: p.priority = IssuePriority.find_by_position(priority_position) Chris@1517: end Chris@1517: Chris@1517: # start/due dates = lowest/highest dates of children Chris@1517: p.start_date = p.children.minimum(:start_date) Chris@1517: p.due_date = p.children.maximum(:due_date) Chris@1517: if p.start_date && p.due_date && p.due_date < p.start_date Chris@1517: p.start_date, p.due_date = p.due_date, p.start_date Chris@1517: end Chris@1517: Chris@1517: # done ratio = weighted average ratio of leaves Chris@1517: unless Issue.use_status_for_done_ratio? && p.status && p.status.default_done_ratio Chris@1517: leaves_count = p.leaves.count Chris@1517: if leaves_count > 0 Chris@1517: average = p.leaves.where("estimated_hours > 0").average(:estimated_hours).to_f Chris@1517: if average == 0 Chris@1517: average = 1 Chris@1517: end Chris@1517: done = p.leaves.joins(:status). Chris@1517: sum("COALESCE(CASE WHEN estimated_hours > 0 THEN estimated_hours ELSE NULL END, #{average}) " + Chris@1517: "* (CASE WHEN is_closed = #{connection.quoted_true} THEN 100 ELSE COALESCE(done_ratio, 0) END)").to_f Chris@1517: progress = done / (average * leaves_count) Chris@1517: p.done_ratio = progress.round Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # estimate = sum of leaves estimates Chris@1517: p.estimated_hours = p.leaves.sum(:estimated_hours).to_f Chris@1517: p.estimated_hours = nil if p.estimated_hours == 0.0 Chris@1517: Chris@1517: # ancestors will be recursively updated Chris@1517: p.save(:validate => false) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Update issues so their versions are not pointing to a Chris@1517: # fixed_version that is not shared with the issue's project Chris@1517: def self.update_versions(conditions=nil) Chris@1517: # Only need to update issues with a fixed_version from Chris@1517: # a different project and that is not systemwide shared Chris@1517: Issue.includes(:project, :fixed_version). Chris@1517: where("#{Issue.table_name}.fixed_version_id IS NOT NULL" + Chris@1517: " AND #{Issue.table_name}.project_id <> #{Version.table_name}.project_id" + Chris@1517: " AND #{Version.table_name}.sharing <> 'system'"). Chris@1517: where(conditions).each do |issue| Chris@1517: next if issue.project.nil? || issue.fixed_version.nil? Chris@1517: unless issue.project.shared_versions.include?(issue.fixed_version) Chris@1517: issue.init_journal(User.current) Chris@1517: issue.fixed_version = nil Chris@1517: issue.save Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Callback on file attachment Chris@1517: def attachment_added(obj) Chris@1517: if @current_journal && !obj.new_record? Chris@1517: @current_journal.details << JournalDetail.new(:property => 'attachment', :prop_key => obj.id, :value => obj.filename) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Callback on attachment deletion Chris@1517: def attachment_removed(obj) Chris@1517: if @current_journal && !obj.new_record? Chris@1517: @current_journal.details << JournalDetail.new(:property => 'attachment', :prop_key => obj.id, :old_value => obj.filename) Chris@1517: @current_journal.save Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Default assignment based on category Chris@1517: def default_assign Chris@1517: if assigned_to.nil? && category && category.assigned_to Chris@1517: self.assigned_to = category.assigned_to Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Updates start/due dates of following issues Chris@1517: def reschedule_following_issues Chris@1517: if start_date_changed? || due_date_changed? Chris@1517: relations_from.each do |relation| Chris@1517: relation.set_issue_to_dates Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Closes duplicates if the issue is being closed Chris@1517: def close_duplicates Chris@1517: if closing? Chris@1517: duplicates.each do |duplicate| Chris@1517: # Reload is need in case the duplicate was updated by a previous duplicate Chris@1517: duplicate.reload Chris@1517: # Don't re-close it if it's already closed Chris@1517: next if duplicate.closed? Chris@1517: # Same user and notes Chris@1517: if @current_journal Chris@1517: duplicate.init_journal(@current_journal.user, @current_journal.notes) Chris@1517: end Chris@1517: duplicate.update_attribute :status, self.status Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Make sure updated_on is updated when adding a note and set updated_on now Chris@1517: # so we can set closed_on with the same value on closing Chris@1517: def force_updated_on_change Chris@1517: if @current_journal || changed? Chris@1517: self.updated_on = current_time_from_proper_timezone Chris@1517: if new_record? Chris@1517: self.created_on = updated_on Chris@1517: end Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Callback for setting closed_on when the issue is closed. Chris@1517: # The closed_on attribute stores the time of the last closing Chris@1517: # and is preserved when the issue is reopened. Chris@1517: def update_closed_on Chris@1517: if closing? || (new_record? && closed?) Chris@1517: self.closed_on = updated_on Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Saves the changes in a Journal Chris@1517: # Called after_save Chris@1517: def create_journal Chris@1517: if @current_journal Chris@1517: # attributes changes Chris@1517: if @attributes_before_change Chris@1517: (Issue.column_names - %w(id root_id lft rgt lock_version created_on updated_on closed_on)).each {|c| Chris@1517: before = @attributes_before_change[c] Chris@1517: after = send(c) Chris@1517: next if before == after || (before.blank? && after.blank?) Chris@1517: @current_journal.details << JournalDetail.new(:property => 'attr', Chris@1517: :prop_key => c, Chris@1517: :old_value => before, Chris@1517: :value => after) Chris@1517: } Chris@1517: end Chris@1517: if @custom_values_before_change Chris@1517: # custom fields changes Chris@1517: custom_field_values.each {|c| Chris@1517: before = @custom_values_before_change[c.custom_field_id] Chris@1517: after = c.value Chris@1517: next if before == after || (before.blank? && after.blank?) Chris@1517: Chris@1517: if before.is_a?(Array) || after.is_a?(Array) Chris@1517: before = [before] unless before.is_a?(Array) Chris@1517: after = [after] unless after.is_a?(Array) Chris@1517: Chris@1517: # values removed Chris@1517: (before - after).reject(&:blank?).each do |value| Chris@1517: @current_journal.details << JournalDetail.new(:property => 'cf', Chris@1517: :prop_key => c.custom_field_id, Chris@1517: :old_value => value, Chris@1517: :value => nil) Chris@1517: end Chris@1517: # values added Chris@1517: (after - before).reject(&:blank?).each do |value| Chris@1517: @current_journal.details << JournalDetail.new(:property => 'cf', Chris@1517: :prop_key => c.custom_field_id, Chris@1517: :old_value => nil, Chris@1517: :value => value) Chris@1517: end Chris@1517: else Chris@1517: @current_journal.details << JournalDetail.new(:property => 'cf', Chris@1517: :prop_key => c.custom_field_id, Chris@1517: :old_value => before, Chris@1517: :value => after) Chris@1517: end Chris@1517: } Chris@1517: end Chris@1517: @current_journal.save Chris@1517: # reset current journal Chris@1517: init_journal @current_journal.user, @current_journal.notes Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: def send_notification Chris@1517: if Setting.notified_events.include?('issue_added') Chris@1517: Mailer.deliver_issue_add(self) Chris@1517: end Chris@1517: end Chris@1517: Chris@1517: # Stores the previous assignee so we can still have access Chris@1517: # to it during after_save callbacks (assigned_to_id_was is reset) Chris@1517: def set_assigned_to_was Chris@1517: @previous_assigned_to_id = assigned_to_id_was Chris@1517: end Chris@1517: Chris@1517: # Clears the previous assignee at the end of after_save callbacks Chris@1517: def clear_assigned_to_was Chris@1517: @assigned_to_was = nil Chris@1517: @previous_assigned_to_id = nil Chris@1517: end Chris@1517: Chris@1517: # Query generator for selecting groups of issue counts for a project Chris@1517: # based on specific criteria Chris@1517: # Chris@1517: # Options Chris@1517: # * project - Project to search in. Chris@1517: # * field - String. Issue field to key off of in the grouping. Chris@1517: # * joins - String. The table name to join against. Chris@1517: def self.count_and_group_by(options) Chris@1517: project = options.delete(:project) Chris@1517: select_field = options.delete(:field) Chris@1517: joins = options.delete(:joins) Chris@1517: Chris@1517: where = "#{Issue.table_name}.#{select_field}=j.id" Chris@1517: Chris@1517: ActiveRecord::Base.connection.select_all("select s.id as status_id, Chris@1517: s.is_closed as closed, Chris@1517: j.id as #{select_field}, Chris@1517: count(#{Issue.table_name}.id) as total Chris@1517: from Chris@1517: #{Issue.table_name}, #{Project.table_name}, #{IssueStatus.table_name} s, #{joins} j Chris@1517: where Chris@1517: #{Issue.table_name}.status_id=s.id Chris@1517: and #{where} Chris@1517: and #{Issue.table_name}.project_id=#{Project.table_name}.id Chris@1517: and #{visible_condition(User.current, :project => project)} Chris@1517: group by s.id, s.is_closed, j.id") Chris@1517: end Chris@1517: end