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