jro_apps/redmine Commit - r4280:e0e8c14c2aef

Makes MailHandler accept all issue attributes and custom fields that can be set/updated (#4071, #4807, #5622, #6110)....

Jean-Philippe Lang -

r4280:e0e8c14c2aef

parent child

Context file:

r4280:e0e8c14c2aef

Collapse all files

app/models/issue.rb +7 -4

              # redMine - project management software
              # Copyright (C) 2006-2007  Jean-Philippe Lang
              #
              # This program is free software; you can redistribute it and/or
              # modify it under the terms of the GNU General Public License
              # as published by the Free Software Foundation; either version 2
              # of the License, or (at your option) any later version.
              #
              # This program is distributed in the hope that it will be useful,
              # but WITHOUT ANY WARRANTY; without even the implied warranty of
              # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
              # GNU General Public License for more details.
              #
              # You should have received a copy of the GNU General Public License
              # along with this program; if not, write to the Free Software
              # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
              class Issue < ActiveRecord::Base
                belongs_to :project
                belongs_to :tracker
                belongs_to :status, :class_name => 'IssueStatus', :foreign_key => 'status_id'
                belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'
                belongs_to :assigned_to, :class_name => 'User', :foreign_key => 'assigned_to_id'
                belongs_to :fixed_version, :class_name => 'Version', :foreign_key => 'fixed_version_id'
                belongs_to :priority, :class_name => 'IssuePriority', :foreign_key => 'priority_id'
                belongs_to :category, :class_name => 'IssueCategory', :foreign_key => 'category_id'
                has_many :journals, :as => :journalized, :dependent => :destroy
                has_many :time_entries, :dependent => :delete_all
                has_and_belongs_to_many :changesets, :order => "#{Changeset.table_name}.committed_on ASC, #{Changeset.table_name}.id ASC"
                has_many :relations_from, :class_name => 'IssueRelation', :foreign_key => 'issue_from_id', :dependent => :delete_all
                has_many :relations_to, :class_name => 'IssueRelation', :foreign_key => 'issue_to_id', :dependent => :delete_all
                acts_as_nested_set :scope => 'root_id'
                acts_as_attachable :after_remove => :attachment_removed
                acts_as_customizable
                acts_as_watchable
                acts_as_searchable :columns => ['subject', "#{table_name}.description", "#{Journal.table_name}.notes"],
                                   :include => [:project, :journals],
                                   # sort by id so that limited eager loading doesn't break with postgresql
                                   :order_column => "#{table_name}.id"
                acts_as_event :title => Proc.new {|o| "#{o.tracker.name} ##{o.id} (#{o.status}): #{o.subject}"},
                              :url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.id}},
                              :type => Proc.new {|o| 'issue' + (o.closed? ? ' closed' : '') }
                acts_as_activity_provider :find_options => {:include => [:project, :author, :tracker]},
                                          :author_key => :author_id
                DONE_RATIO_OPTIONS = %w(issue_field issue_status)
                attr_reader :current_journal
                validates_presence_of :subject, :priority, :project, :tracker, :author, :status
                validates_length_of :subject, :maximum => 255
                validates_inclusion_of :done_ratio, :in => 0..100
                validates_numericality_of :estimated_hours, :allow_nil => true
                named_scope :visible, lambda {|*args| { :include => :project,
                                                        :conditions => Project.allowed_to_condition(args.first || User.current, :view_issues) } }
                named_scope :open, :conditions => ["#{IssueStatus.table_name}.is_closed = ?", false], :include => :status
                named_scope :recently_updated, :order => "#{Issue.table_name}.updated_on DESC"
                named_scope :with_limit, lambda { |limit| { :limit => limit} }
                named_scope :on_active_project, :include => [:status, :project, :tracker],
                                                :conditions => ["#{Project.table_name}.status=#{Project::STATUS_ACTIVE}"]
                named_scope :for_gantt, lambda {
                  {
                    :include => [:tracker, :status, :assigned_to, :priority, :project, :fixed_version],
                    :order => "#{Issue.table_name}.due_date ASC, #{Issue.table_name}.start_date ASC, #{Issue.table_name}.id ASC"
                  }
                }
                named_scope :without_version, lambda {
                  {
                    :conditions => { :fixed_version_id => nil}
                  }
                }
                named_scope :with_query, lambda {|query|
                  {
                    :conditions => Query.merge_conditions(query.statement)
                  }
                }
                before_create :default_assign
                before_save :close_duplicates, :update_done_ratio_from_issue_status
                after_save :reschedule_following_issues, :update_nested_set_attributes, :update_parent_attributes, :create_journal
                after_destroy :destroy_children
                after_destroy :update_parent_attributes
                # Returns true if usr or current user is allowed to view the issue
                def visible?(usr=nil)
                  (usr || User.current).allowed_to?(:view_issues, self.project)
                end
                def after_initialize
                  if new_record?
                    # set default values for new records only
                    self.status ||= IssueStatus.default
                    self.priority ||= IssuePriority.default
                  end
                end
                # Overrides Redmine::Acts::Customizable::InstanceMethods#available_custom_fields
                def available_custom_fields
                  (project && tracker) ? project.all_issue_custom_fields.select {|c| tracker.custom_fields.include? c } : []
                end
                def copy_from(arg)
                  issue = arg.is_a?(Issue) ? arg : Issue.visible.find(arg)
                  self.attributes = issue.attributes.dup.except("id", "root_id", "parent_id", "lft", "rgt", "created_on", "updated_on")
                  self.custom_field_values = issue.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
                  self.status = issue.status
                  self
                end
                # Moves/copies an issue to a new project and tracker
                # Returns the moved/copied issue on success, false on failure
                def move_to_project(*args)
                  ret = Issue.transaction do
                    move_to_project_without_transaction(*args) || raise(ActiveRecord::Rollback)
                  end || false
                end
                def move_to_project_without_transaction(new_project, new_tracker = nil, options = {})
                  options ||= {}
                  issue = options[:copy] ? self.class.new.copy_from(self) : self
                  if new_project && issue.project_id != new_project.id
                    # delete issue relations
                    unless Setting.cross_project_issue_relations?
                      issue.relations_from.clear
                      issue.relations_to.clear
                    end
                    # issue is moved to another project
                    # reassign to the category with same name if any
                    new_category = issue.category.nil? ? nil : new_project.issue_categories.find_by_name(issue.category.name)
                    issue.category = new_category
                    # Keep the fixed_version if it's still valid in the new_project
                    unless new_project.shared_versions.include?(issue.fixed_version)
                      issue.fixed_version = nil
                    end
                    issue.project = new_project
                    if issue.parent && issue.parent.project_id != issue.project_id
                      issue.parent_issue_id = nil
                    end
                  end
                  if new_tracker
                    issue.tracker = new_tracker
                    issue.reset_custom_values!
                  end
                  if options[:copy]
                    issue.custom_field_values = self.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
                    issue.status = if options[:attributes] && options[:attributes][:status_id]
                                     IssueStatus.find_by_id(options[:attributes][:status_id])
                                   else
                                     self.status
                                   end
                  end
                  # Allow bulk setting of attributes on the issue
                  if options[:attributes]
                    issue.attributes = options[:attributes]
                  end
                  if issue.save
                    unless options[:copy]
                      # Manually update project_id on related time entries
                      TimeEntry.update_all("project_id = #{new_project.id}", {:issue_id => id})
                      issue.children.each do |child|
                        unless child.move_to_project_without_transaction(new_project)
                          # Move failed and transaction was rollback'd
                          return false
                        end
                      end
                    end
                  else
                    return false
                  end
                  issue
                end
                def status_id=(sid)
                  self.status = nil
                  write_attribute(:status_id, sid)
                end
                def priority_id=(pid)
                  self.priority = nil
                  write_attribute(:priority_id, pid)
                end
                def tracker_id=(tid)
                  self.tracker = nil
                  result = write_attribute(:tracker_id, tid)
                  @custom_field_values = nil
                  result
                end
                # Overrides attributes= so that tracker_id gets assigned first
                def attributes_with_tracker_first=(new_attributes, *args)
                  return if new_attributes.nil?
                  new_tracker_id = new_attributes['tracker_id'] || new_attributes[:tracker_id]
                  if new_tracker_id
                    self.tracker_id = new_tracker_id
                  end
                  send :attributes_without_tracker_first=, new_attributes, *args
                end
                # Do not redefine alias chain on reload (see #4838)
                alias_method_chain(:attributes=, :tracker_first) unless method_defined?(:attributes_without_tracker_first=)
                def estimated_hours=(h)
                  write_attribute :estimated_hours, (h.is_a?(String) ? h.to_hours : h)
                end
                SAFE_ATTRIBUTES = %w(
                  tracker_id
                  status_id
                  parent_issue_id
                  category_id
                  assigned_to_id
                  priority_id
                  fixed_version_id
                  subject
                  description
                  start_date
                  due_date
                  done_ratio
                  estimated_hours
                  custom_field_values
                  lock_version
                ) unless const_defined?(:SAFE_ATTRIBUTES)
                SAFE_ATTRIBUTES_ON_TRANSITION = %w(
                  status_id
                  assigned_to_id
                  fixed_version_id
                  done_ratio
                ) unless const_defined?(:SAFE_ATTRIBUTES_ON_TRANSITION)
                # Safely sets attributes
                # Should be called from controllers instead of #attributes=
                # attr_accessible is too rough because we still want things like
                # Issue.new(:project => foo) to work
                # TODO: move workflow/permission checks from controllers to here
                def safe_attributes=(attrs, user=User.current)
                  return unless attrs.is_a?(Hash)
-                 new_statuses_allowed = new_statuses_allowed_to(user)
                  # User can change issue attributes only if he has :edit permission or if a workflow transition is allowed
                  if new_record? || user.allowed_to?(:edit_issues, project)
                    attrs = attrs.reject {|k,v| !SAFE_ATTRIBUTES.include?(k)}
-                 elsif new_statuses_allowed.any?
+                 elsif new_statuses_allowed_to(user).any?
                    attrs = attrs.reject {|k,v| !SAFE_ATTRIBUTES_ON_TRANSITION.include?(k)}
                  else
                    return
                  end
+                 # Tracker must be set before since new_statuses_allowed_to depends on it.
+                 if t = attrs.delete('tracker_id')
+                   self.tracker_id = t
+                 end
                  if attrs['status_id']
-                   unless new_statuses_allowed.collect(&:id).include?(attrs['status_id'].to_i)
+                   unless new_statuses_allowed_to(user).collect(&:id).include?(attrs['status_id'].to_i)
                      attrs.delete('status_id')
                    end
                  end
                  unless leaf?
                    attrs.reject! {|k,v| %w(priority_id done_ratio start_date due_date estimated_hours).include?(k)}
                  end
                  if attrs.has_key?('parent_issue_id')
                    if !user.allowed_to?(:manage_subtasks, project)
                      attrs.delete('parent_issue_id')
                    elsif !attrs['parent_issue_id'].blank?
                      attrs.delete('parent_issue_id') unless Issue.visible(user).exists?(attrs['parent_issue_id'])
                    end
                  end
                  self.attributes = attrs
                end
                def done_ratio
                  if Issue.use_status_for_done_ratio? && status && status.default_done_ratio
                    status.default_done_ratio
                  else
                    read_attribute(:done_ratio)
                  end
                end
                def self.use_status_for_done_ratio?
                  Setting.issue_done_ratio == 'issue_status'
                end
                def self.use_field_for_done_ratio?
                  Setting.issue_done_ratio == 'issue_field'
                end
                def validate
                  if self.due_date.nil? && @attributes['due_date'] && !@attributes['due_date'].empty?
                    errors.add :due_date, :not_a_date
                  end
                  if self.due_date and self.start_date and self.due_date < self.start_date
                    errors.add :due_date, :greater_than_start_date
                  end
                  if start_date && soonest_start && start_date < soonest_start
                    errors.add :start_date, :invalid
                  end
                  if fixed_version
                    if !assignable_versions.include?(fixed_version)
                      errors.add :fixed_version_id, :inclusion
                    elsif reopened? && fixed_version.closed?
                      errors.add_to_base I18n.t(:error_can_not_reopen_issue_on_closed_version)
                    end
                  end
                  # Checks that the issue can not be added/moved to a disabled tracker
                  if project && (tracker_id_changed? || project_id_changed?)
                    unless project.trackers.include?(tracker)
                      errors.add :tracker_id, :inclusion
                    end
                  end
                  # Checks parent issue assignment
                  if @parent_issue
                    if @parent_issue.project_id != project_id
                      errors.add :parent_issue_id, :not_same_project
                    elsif !new_record?
                      # moving an existing issue
                      if @parent_issue.root_id != root_id
                        # we can always move to another tree
                      elsif move_possible?(@parent_issue)
                        # move accepted inside tree
                      else
                        errors.add :parent_issue_id, :not_a_valid_parent
                      end
                    end
                  end
                end
                # Set the done_ratio using the status if that setting is set.  This will keep the done_ratios
                # even if the user turns off the setting later
                def update_done_ratio_from_issue_status
                  if Issue.use_status_for_done_ratio? && status && status.default_done_ratio
                    self.done_ratio = status.default_done_ratio
                  end
                end
                def init_journal(user, notes = "")
                  @current_journal ||= Journal.new(:journalized => self, :user => user, :notes => notes)
                  @issue_before_change = self.clone
                  @issue_before_change.status = self.status
                  @custom_values_before_change = {}
                  self.custom_values.each {|c| @custom_values_before_change.store c.custom_field_id, c.value }
                  # Make sure updated_on is updated when adding a note.
                  updated_on_will_change!
                  @current_journal
                end
                # Return true if the issue is closed, otherwise false
                def closed?
                  self.status.is_closed?
                end
                # Return true if the issue is being reopened
                def reopened?
                  if !new_record? && status_id_changed?
                    status_was = IssueStatus.find_by_id(status_id_was)
                    status_new = IssueStatus.find_by_id(status_id)
                    if status_was && status_new && status_was.is_closed? && !status_new.is_closed?
                      return true
                    end
                  end
                  false
                end
                # Return true if the issue is being closed
                def closing?
                  if !new_record? && status_id_changed?
                    status_was = IssueStatus.find_by_id(status_id_was)
                    status_new = IssueStatus.find_by_id(status_id)
                    if status_was && status_new && !status_was.is_closed? && status_new.is_closed?
                      return true
                    end
                  end
                  false
                end
                # Returns true if the issue is overdue
                def overdue?
                  !due_date.nil? && (due_date < Date.today) && !status.is_closed?
                end
                # Is the amount of work done less than it should for the due date
                def behind_schedule?
                  return false if start_date.nil? || due_date.nil?
                  done_date = start_date + ((due_date - start_date+1)* done_ratio/100).floor
                  return done_date <= Date.today
                end
                # Does this issue have children?
                def children?
                  !leaf?
                end
                # Users the issue can be assigned to
                def assignable_users
                  users = project.assignable_users
                  users << author if author
                  users.uniq.sort
                end
                # Versions that the issue can be assigned to
                def assignable_versions
                  @assignable_versions ||= (project.shared_versions.open + [Version.find_by_id(fixed_version_id_was)]).compact.uniq.sort
                end
                # Returns true if this issue is blocked by another issue that is still open
                def blocked?
                  !relations_to.detect {|ir| ir.relation_type == 'blocks' && !ir.issue_from.closed?}.nil?
                end
                # Returns an array of status that user is able to apply
                def new_statuses_allowed_to(user, include_default=false)
                  statuses = status.find_new_statuses_allowed_to(user.roles_for_project(project), tracker)
                  statuses << status unless statuses.empty?
                  statuses << IssueStatus.default if include_default
                  statuses = statuses.uniq.sort
                  blocked? ? statuses.reject {|s| s.is_closed?} : statuses
                end
                # Returns the mail adresses of users that should be notified
                def recipients
                  notified = project.notified_users
                  # Author and assignee are always notified unless they have been
                  # locked or don't want to be notified
                  notified << author if author && author.active? && author.notify_about?(self)
                  notified << assigned_to if assigned_to && assigned_to.active? && assigned_to.notify_about?(self)
                  notified.uniq!
                  # Remove users that can not view the issue
                  notified.reject! {|user| !visible?(user)}
                  notified.collect(&:mail)
                end
                # Returns the total number of hours spent on this issue and its descendants
                #
                # Example:
                #   spent_hours => 0.0
                #   spent_hours => 50.2
                def spent_hours
                  @spent_hours ||= self_and_descendants.sum("#{TimeEntry.table_name}.hours", :include => :time_entries).to_f || 0.0
                end
                def relations
                  (relations_from + relations_to).sort
                end
                def all_dependent_issues
                  dependencies = []
                  relations_from.each do |relation|
                    dependencies << relation.issue_to
                    dependencies += relation.issue_to.all_dependent_issues
                  end
                  dependencies
                end
                # Returns an array of issues that duplicate this one
                def duplicates
                  relations_to.select {|r| r.relation_type == IssueRelation::TYPE_DUPLICATES}.collect {|r| r.issue_from}
                end
                # Returns the due date or the target due date if any
                # Used on gantt chart
                def due_before
                  due_date || (fixed_version ? fixed_version.effective_date : nil)
                end
                # Returns the time scheduled for this issue.
                #
                # Example:
                #   Start Date: 2/26/09, End Date: 3/04/09
                #   duration => 6
                def duration
                  (start_date && due_date) ? due_date - start_date : 0
                end
                def soonest_start
                  @soonest_start ||= (
                      relations_to.collect{|relation| relation.successor_soonest_start} +
                      ancestors.collect(&:soonest_start)
                    ).compact.max
                end
                def reschedule_after(date)
                  return if date.nil?
                  if leaf?
                    if start_date.nil? || start_date < date
                      self.start_date, self.due_date = date, date + duration
                      save
                    end
                  else
                    leaves.each do |leaf|
                      leaf.reschedule_after(date)
                    end
                  end
                end
                def <=>(issue)
                  if issue.nil?
                    -1
                  elsif root_id != issue.root_id
                    (root_id || 0) <=> (issue.root_id || 0)
                  else
                    (lft || 0) <=> (issue.lft || 0)
                  end
                end
                def to_s
                  "#{tracker} ##{id}: #{subject}"
                end
                # Returns a string of css classes that apply to the issue
                def css_classes
                  s = "issue status-#{status.position} priority-#{priority.position}"
                  s << ' closed' if closed?
                  s << ' overdue' if overdue?
                  s << ' created-by-me' if User.current.logged? && author_id == User.current.id
                  s << ' assigned-to-me' if User.current.logged? && assigned_to_id == User.current.id
                  s
                end
                # Saves an issue, time_entry, attachments, and a journal from the parameters
                # Returns false if save fails
                def save_issue_with_child_records(params, existing_time_entry=nil)
                  Issue.transaction do
                    if params[:time_entry] && params[:time_entry][:hours].present? && User.current.allowed_to?(:log_time, project)
                      @time_entry = existing_time_entry || TimeEntry.new
                      @time_entry.project = project
                      @time_entry.issue = self
                      @time_entry.user = User.current
                      @time_entry.spent_on = Date.today
                      @time_entry.attributes = params[:time_entry]
                      self.time_entries << @time_entry
                    end
                    if valid?
                      attachments = Attachment.attach_files(self, params[:attachments])
                      attachments[:files].each {|a| @current_journal.details << JournalDetail.new(:property => 'attachment', :prop_key => a.id, :value => a.filename)}
                      # TODO: Rename hook
                      Redmine::Hook.call_hook(:controller_issues_edit_before_save, { :params => params, :issue => self, :time_entry => @time_entry, :journal => @current_journal})
                      begin
                        if save
                          # TODO: Rename hook
                          Redmine::Hook.call_hook(:controller_issues_edit_after_save, { :params => params, :issue => self, :time_entry => @time_entry, :journal => @current_journal})
                        else
                          raise ActiveRecord::Rollback
                        end
                      rescue ActiveRecord::StaleObjectError
                        attachments[:files].each(&:destroy)
                        errors.add_to_base l(:notice_locking_conflict)
                        raise ActiveRecord::Rollback
                      end
                    end
                  end
                end
                # Unassigns issues from +version+ if it's no longer shared with issue's project
                def self.update_versions_from_sharing_change(version)
                  # Update issues assigned to the version
                  update_versions(["#{Issue.table_name}.fixed_version_id = ?", version.id])
                end
                # Unassigns issues from versions that are no longer shared
                # after +project+ was moved
                def self.update_versions_from_hierarchy_change(project)
                  moved_project_ids = project.self_and_descendants.reload.collect(&:id)
                  # Update issues of the moved projects and issues assigned to a version of a moved project
                  Issue.update_versions(["#{Version.table_name}.project_id IN (?) OR #{Issue.table_name}.project_id IN (?)", moved_project_ids, moved_project_ids])
                end
                def parent_issue_id=(arg)
                  parent_issue_id = arg.blank? ? nil : arg.to_i
                  if parent_issue_id && @parent_issue = Issue.find_by_id(parent_issue_id)
                    @parent_issue.id
                  else
                    @parent_issue = nil
                    nil
                  end
                end
                def parent_issue_id
                  if instance_variable_defined? :@parent_issue
                    @parent_issue.nil? ? nil : @parent_issue.id
                  else
                    parent_id
                  end
                end
                # Extracted from the ReportsController.
                def self.by_tracker(project)
                  count_and_group_by(:project => project,
                                     :field => 'tracker_id',
                                     :joins => Tracker.table_name)
                end
                def self.by_version(project)
                  count_and_group_by(:project => project,
                                     :field => 'fixed_version_id',
                                     :joins => Version.table_name)
                end
                def self.by_priority(project)
                  count_and_group_by(:project => project,
                                     :field => 'priority_id',
                                     :joins => IssuePriority.table_name)
                end
                def self.by_category(project)
                  count_and_group_by(:project => project,
                                     :field => 'category_id',
                                     :joins => IssueCategory.table_name)
                end
                def self.by_assigned_to(project)
                  count_and_group_by(:project => project,
                                     :field => 'assigned_to_id',
                                     :joins => User.table_name)
                end
                def self.by_author(project)
                  count_and_group_by(:project => project,
                                     :field => 'author_id',
                                     :joins => User.table_name)
                end
                def self.by_subproject(project)
                  ActiveRecord::Base.connection.select_all("select    s.id as status_id,
                                                              s.is_closed as closed,
                                                              i.project_id as project_id,
                                                              count(i.id) as total
                                                            from
                                                              #{Issue.table_name} i, #{IssueStatus.table_name} s
                                                            where
                                                              i.status_id=s.id
                                                              and i.project_id IN (#{project.descendants.active.collect{|p| p.id}.join(',')})
                                                            group by s.id, s.is_closed, i.project_id") if project.descendants.active.any?
                end
                # End ReportsController extraction
                # Returns an array of projects that current user can move issues to
                def self.allowed_target_projects_on_move
                  projects = []
                  if User.current.admin?
                    # admin is allowed to move issues to any active (visible) project
                    projects = Project.visible.all
                  elsif User.current.logged?
                    if Role.non_member.allowed_to?(:move_issues)
                      projects = Project.visible.all
                    else
                      User.current.memberships.each {|m| projects << m.project if m.roles.detect {|r| r.allowed_to?(:move_issues)}}
                    end
                  end
                  projects
                end
                private
                def update_nested_set_attributes
                  if root_id.nil?
                    # issue was just created
                    self.root_id = (@parent_issue.nil? ? id : @parent_issue.root_id)
                    set_default_left_and_right
                    Issue.update_all("root_id = #{root_id}, lft = #{lft}, rgt = #{rgt}", ["id = ?", id])
                    if @parent_issue
                      move_to_child_of(@parent_issue)
                    end
                    reload
                  elsif parent_issue_id != parent_id
                    former_parent_id = parent_id
                    # moving an existing issue
                    if @parent_issue && @parent_issue.root_id == root_id
                      # inside the same tree
                      move_to_child_of(@parent_issue)
                    else
                      # to another tree
                      unless root?
                        move_to_right_of(root)
                        reload
                      end
                      old_root_id = root_id
                      self.root_id = (@parent_issue.nil? ? id : @parent_issue.root_id )
                      target_maxright = nested_set_scope.maximum(right_column_name) || 0
                      offset = target_maxright + 1 - lft
                      Issue.update_all("root_id = #{root_id}, lft = lft + #{offset}, rgt = rgt + #{offset}",
                                        ["root_id = ? AND lft >= ? AND rgt <= ? ", old_root_id, lft, rgt])
                      self[left_column_name] = lft + offset
                      self[right_column_name] = rgt + offset
                      if @parent_issue
                        move_to_child_of(@parent_issue)
                      end
                    end
                    reload
                    # delete invalid relations of all descendants
                    self_and_descendants.each do |issue|
                      issue.relations.each do |relation|
                        relation.destroy unless relation.valid?
                      end
                    end
                    # update former parent
                    recalculate_attributes_for(former_parent_id) if former_parent_id
                  end
                  remove_instance_variable(:@parent_issue) if instance_variable_defined?(:@parent_issue)
                end
                def update_parent_attributes
                  recalculate_attributes_for(parent_id) if parent_id
                end
                def recalculate_attributes_for(issue_id)
                  if issue_id && p = Issue.find_by_id(issue_id)
                    # priority = highest priority of children
                    if priority_position = p.children.maximum("#{IssuePriority.table_name}.position", :include => :priority)
                      p.priority = IssuePriority.find_by_position(priority_position)
                    end
                    # start/due dates = lowest/highest dates of children
                    p.start_date = p.children.minimum(:start_date)
                    p.due_date = p.children.maximum(:due_date)
                    if p.start_date && p.due_date && p.due_date < p.start_date
                      p.start_date, p.due_date = p.due_date, p.start_date
                    end
                    # done ratio = weighted average ratio of leaves
                    unless Issue.use_status_for_done_ratio? && p.status && p.status.default_done_ratio
                      leaves_count = p.leaves.count
                      if leaves_count > 0
                        average = p.leaves.average(:estimated_hours).to_f
                        if average == 0
                          average = 1
                        end
                        done = p.leaves.sum("COALESCE(estimated_hours, #{average}) * (CASE WHEN is_closed = #{connection.quoted_true} THEN 100 ELSE COALESCE(done_ratio, 0) END)", :include => :status).to_f
                        progress = done / (average * leaves_count)
                        p.done_ratio = progress.round
                      end
                    end
                    # estimate = sum of leaves estimates
                    p.estimated_hours = p.leaves.sum(:estimated_hours).to_f
                    p.estimated_hours = nil if p.estimated_hours == 0.0
                    # ancestors will be recursively updated
                    p.save(false)
                  end
                end
                def destroy_children
                  unless leaf?
                    children.each do |child|
                      child.destroy
                    end
                  end
                end
                # Update issues so their versions are not pointing to a
                # fixed_version that is not shared with the issue's project
                def self.update_versions(conditions=nil)
                  # Only need to update issues with a fixed_version from
                  # a different project and that is not systemwide shared
                  Issue.all(:conditions => merge_conditions("#{Issue.table_name}.fixed_version_id IS NOT NULL" +
                                                              " AND #{Issue.table_name}.project_id <> #{Version.table_name}.project_id" +
                                                              " AND #{Version.table_name}.sharing <> 'system'",
                                                              conditions),
                            :include => [:project, :fixed_version]
                            ).each do |issue|
                    next if issue.project.nil? || issue.fixed_version.nil?
                    unless issue.project.shared_versions.include?(issue.fixed_version)
                      issue.init_journal(User.current)
                      issue.fixed_version = nil
                      issue.save
                    end
                  end
                end
                # Callback on attachment deletion
                def attachment_removed(obj)
                  journal = init_journal(User.current)
                  journal.details << JournalDetail.new(:property => 'attachment',
                                                       :prop_key => obj.id,
                                                       :old_value => obj.filename)
                  journal.save
                end
                # Default assignment based on category
                def default_assign
                  if assigned_to.nil? && category && category.assigned_to
                    self.assigned_to = category.assigned_to
                  end
                end
                # Updates start/due dates of following issues
                def reschedule_following_issues
                  if start_date_changed? || due_date_changed?
                    relations_from.each do |relation|
                      relation.set_issue_to_dates
                    end
                  end
                end
                # Closes duplicates if the issue is being closed
                def close_duplicates
                  if closing?
                    duplicates.each do |duplicate|
                      # Reload is need in case the duplicate was updated by a previous duplicate
                      duplicate.reload
                      # Don't re-close it if it's already closed
                      next if duplicate.closed?
                      # Same user and notes
                      if @current_journal
                        duplicate.init_journal(@current_journal.user, @current_journal.notes)
                      end
                      duplicate.update_attribute :status, self.status
                    end
                  end
                end
                # Saves the changes in a Journal
                # Called after_save
                def create_journal
                  if @current_journal
                    # attributes changes
                    (Issue.column_names - %w(id description root_id lft rgt lock_version created_on updated_on)).each {|c|
                      @current_journal.details << JournalDetail.new(:property => 'attr',
                                                                    :prop_key => c,
                                                                    :old_value => @issue_before_change.send(c),
                                                                    :value => send(c)) unless send(c)==@issue_before_change.send(c)
                    }
                    # custom fields changes
                    custom_values.each {|c|
                      next if (@custom_values_before_change[c.custom_field_id]==c.value ||
                                (@custom_values_before_change[c.custom_field_id].blank? && c.value.blank?))
                      @current_journal.details << JournalDetail.new(:property => 'cf',
                                                                    :prop_key => c.custom_field_id,
                                                                    :old_value => @custom_values_before_change[c.custom_field_id],
                                                                    :value => c.value)
                    }
                    @current_journal.save
                    # reset current journal
                    init_journal @current_journal.user, @current_journal.notes
                  end
                end
                # Query generator for selecting groups of issue counts for a project
                # based on specific criteria
                #
                # Options
                # * project - Project to search in.
                # * field - String. Issue field to key off of in the grouping.
                # * joins - String. The table name to join against.
                def self.count_and_group_by(options)
                  project = options.delete(:project)
                  select_field = options.delete(:field)
                  joins = options.delete(:joins)
                  where = "i.#{select_field}=j.id"
                  ActiveRecord::Base.connection.select_all("select    s.id as status_id,
                                                              s.is_closed as closed,
                                                              j.id as #{select_field},
                                                              count(i.id) as total
                                                            from
                                                                #{Issue.table_name} i, #{IssueStatus.table_name} s, #{joins} j
                                                            where
                                                              i.status_id=s.id
                                                              and #{where}
                                                              and i.project_id=#{project.id}
                                                            group by s.id, s.is_closed, j.id")
                end
              end

app/models/mail_handler.rb +43 -46

              # redMine - project management software
              # Copyright (C) 2006-2007  Jean-Philippe Lang
              #
              # This program is free software; you can redistribute it and/or
              # modify it under the terms of the GNU General Public License
              # as published by the Free Software Foundation; either version 2
              # of the License, or (at your option) any later version.
              #
              # This program is distributed in the hope that it will be useful,
              # but WITHOUT ANY WARRANTY; without even the implied warranty of
              # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
              # GNU General Public License for more details.
              #
              # You should have received a copy of the GNU General Public License
              # along with this program; if not, write to the Free Software
              # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
              class MailHandler < ActionMailer::Base
                include ActionView::Helpers::SanitizeHelper
                class UnauthorizedAction < StandardError; end
                class MissingInformation < StandardError; end
                attr_reader :email, :user
                def self.receive(email, options={})
                  @@handler_options = options.dup
                  @@handler_options[:issue] ||= {}
                  @@handler_options[:allow_override] = @@handler_options[:allow_override].split(',').collect(&:strip) if @@handler_options[:allow_override].is_a?(String)
                  @@handler_options[:allow_override] ||= []
                  # Project needs to be overridable if not specified
                  @@handler_options[:allow_override] << 'project' unless @@handler_options[:issue].has_key?(:project)
                  # Status overridable by default
                  @@handler_options[:allow_override] << 'status' unless @@handler_options[:issue].has_key?(:status)
                  @@handler_options[:no_permission_check] = (@@handler_options[:no_permission_check].to_s == '1' ? true : false)
                  super email
                end
                # Processes incoming emails
                # Returns the created object (eg. an issue, a message) or false
                def receive(email)
                  @email = email
                  sender_email = email.from.to_a.first.to_s.strip
                  # Ignore emails received from the application emission address to avoid hell cycles
                  if sender_email.downcase == Setting.mail_from.to_s.strip.downcase
                    logger.info  "MailHandler: ignoring email from Redmine emission address [#{sender_email}]" if logger && logger.info
                    return false
                  end
                  @user = User.find_by_mail(sender_email) if sender_email.present?
                  if @user && !@user.active?
                    logger.info  "MailHandler: ignoring email from non-active user [#{@user.login}]" if logger && logger.info
                    return false
                  end
                  if @user.nil?
                    # Email was submitted by an unknown user
                    case @@handler_options[:unknown_user]
                    when 'accept'
                      @user = User.anonymous
                    when 'create'
                      @user = MailHandler.create_user_from_email(email)
                      if @user
                        logger.info "MailHandler: [#{@user.login}] account created" if logger && logger.info
                        Mailer.deliver_account_information(@user, @user.password)
                      else
                        logger.error "MailHandler: could not create account for [#{sender_email}]" if logger && logger.error
                        return false
                      end
                    else
                      # Default behaviour, emails from unknown users are ignored
                      logger.info  "MailHandler: ignoring email from unknown user [#{sender_email}]" if logger && logger.info
                      return false
                    end
                  end
                  User.current = @user
                  dispatch
                end
                private
                MESSAGE_ID_RE = %r{^<redmine\.([a-z0-9_]+)\-(\d+)\.\d+@}
                ISSUE_REPLY_SUBJECT_RE = %r{\[[^\]]*#(\d+)\]}
                MESSAGE_REPLY_SUBJECT_RE = %r{\[[^\]]*msg(\d+)\]}
                def dispatch
                  headers = [email.in_reply_to, email.references].flatten.compact
                  if headers.detect {|h| h.to_s =~ MESSAGE_ID_RE}
                    klass, object_id = $1, $2.to_i
                    method_name = "receive_#{klass}_reply"
                    if self.class.private_instance_methods.collect(&:to_s).include?(method_name)
                      send method_name, object_id
                    else
                      # ignoring it
                    end
                  elsif m = email.subject.match(ISSUE_REPLY_SUBJECT_RE)
                    receive_issue_reply(m[1].to_i)
                  elsif m = email.subject.match(MESSAGE_REPLY_SUBJECT_RE)
                    receive_message_reply(m[1].to_i)
                  else
                    receive_issue
                  end
                rescue ActiveRecord::RecordInvalid => e
                  # TODO: send a email to the user
                  logger.error e.message if logger
                  false
                rescue MissingInformation => e
                  logger.error "MailHandler: missing information from #{user}: #{e.message}" if logger
                  false
                rescue UnauthorizedAction => e
                  logger.error "MailHandler: unauthorized attempt from #{user}" if logger
                  false
                end
                # Creates a new issue
                def receive_issue
                  project = target_project
-                 tracker = (get_keyword(:tracker) && project.trackers.find_by_name(get_keyword(:tracker))) || project.trackers.find(:first)
-                 category = (get_keyword(:category) && project.issue_categories.find_by_name(get_keyword(:category)))
-                 priority = (get_keyword(:priority) && IssuePriority.find_by_name(get_keyword(:priority)))
-                 status =  (get_keyword(:status) && IssueStatus.find_by_name(get_keyword(:status)))
-                 assigned_to = (get_keyword(:assigned_to, :override => true) && find_user_from_keyword(get_keyword(:assigned_to, :override => true)))
-                 due_date = get_keyword(:due_date, :override => true)
-                 start_date = get_keyword(:start_date, :override => true)
                  # check permission
                  unless @@handler_options[:no_permission_check]
                    raise UnauthorizedAction unless user.allowed_to?(:add_issues, project)
                  end
-                 issue = Issue.new(:author => user, :project => project, :tracker => tracker, :category => category, :priority => priority, :due_date => due_date, :start_date => start_date, :assigned_to => assigned_to)
-                 # check workflow
-                 if status && issue.new_statuses_allowed_to(user).include?(status)
-                   issue.status = status
-                 end
-                 issue.subject = email.subject.chomp[0,255]
+                 issue = Issue.new(:author => user, :project => project)
+                 issue.safe_attributes = issue_attributes_from_keywords(issue)
+                 issue.safe_attributes = {'custom_field_values' => custom_field_values_from_keywords(issue)}
+                 issue.subject = email.subject.to_s.chomp[0,255]
                  if issue.subject.blank?
                    issue.subject = '(no subject)'
                  end
-                 # custom fields
-                 issue.custom_field_values = issue.available_custom_fields.inject({}) do |h, c|
-                   if value = get_keyword(c.name, :override => true)
-                     h[c.id] = value
-                   end
+                   h
-                 end
                  issue.description = cleaned_up_text_body
                  # add To and Cc as watchers before saving so the watchers can reply to Redmine
                  add_watchers(issue)
                  issue.save!
                  add_attachments(issue)
                  logger.info "MailHandler: issue ##{issue.id} created by #{user}" if logger && logger.info
                  issue
                end
-               def target_project
-                 # TODO: other ways to specify project:
-                 # * parse the email To field
-                 # * specific project (eg. Setting.mail_handler_target_project)
-                 target = Project.find_by_identifier(get_keyword(:project))
-                 raise MissingInformation.new('Unable to determine target project') if target.nil?
-                 target
-               end
                # Adds a note to an existing issue
                def receive_issue_reply(issue_id)
-                 status =  (get_keyword(:status) && IssueStatus.find_by_name(get_keyword(:status)))
-                 due_date = get_keyword(:due_date, :override => true)
-                 start_date = get_keyword(:start_date, :override => true)
-                 assigned_to = (get_keyword(:assigned_to, :override => true) && find_user_from_keyword(get_keyword(:assigned_to, :override => true)))
                  issue = Issue.find_by_id(issue_id)
                  return unless issue
                  # check permission
                  unless @@handler_options[:no_permission_check]
                    raise UnauthorizedAction unless user.allowed_to?(:add_issue_notes, issue.project) || user.allowed_to?(:edit_issues, issue.project)
-                   raise UnauthorizedAction unless status.nil? || user.allowed_to?(:edit_issues, issue.project)
                  end
-                 # add the note
                  journal = issue.init_journal(user, cleaned_up_text_body)
+                 issue.safe_attributes = issue_attributes_from_keywords(issue)
+                 issue.safe_attributes = {'custom_field_values' => custom_field_values_from_keywords(issue)}
                  add_attachments(issue)
-                 # check workflow
-                 if status && issue.new_statuses_allowed_to(user).include?(status)
-                   issue.status = status
-                 end
-                 issue.start_date = start_date if start_date
-                 issue.due_date = due_date if due_date
-                 issue.assigned_to = assigned_to if assigned_to
                  issue.save!
                  logger.info "MailHandler: issue ##{issue.id} updated by #{user}" if logger && logger.info
                  journal
                end
                # Reply will be added to the issue
                def receive_journal_reply(journal_id)
                  journal = Journal.find_by_id(journal_id)
                  if journal && journal.journalized_type == 'Issue'
                    receive_issue_reply(journal.journalized_id)
                  end
                end
                # Receives a reply to a forum message
                def receive_message_reply(message_id)
                  message = Message.find_by_id(message_id)
                  if message
                    message = message.root
                    unless @@handler_options[:no_permission_check]
                      raise UnauthorizedAction unless user.allowed_to?(:add_messages, message.project)
                    end
                    if !message.locked?
                      reply = Message.new(:subject => email.subject.gsub(%r{^.*msg\d+\]}, '').strip,
                                          :content => cleaned_up_text_body)
                      reply.author = user
                      reply.board = message.board
                      message.children << reply
                      add_attachments(reply)
                      reply
                    else
                      logger.info "MailHandler: ignoring reply from [#{sender_email}] to a locked topic" if logger && logger.info
                    end
                  end
                end
                def add_attachments(obj)
                  if email.has_attachments?
                    email.attachments.each do |attachment|
                      Attachment.create(:container => obj,
                                        :file => attachment,
                                        :author => user,
                                        :content_type => attachment.content_type)
                    end
                  end
                end
                # Adds To and Cc as watchers of the given object if the sender has the
                # appropriate permission
                def add_watchers(obj)
                  if user.allowed_to?("add_#{obj.class.name.underscore}_watchers".to_sym, obj.project)
                    addresses = [email.to, email.cc].flatten.compact.uniq.collect {|a| a.strip.downcase}
                    unless addresses.empty?
                      watchers = User.active.find(:all, :conditions => ['LOWER(mail) IN (?)', addresses])
                      watchers.each {|w| obj.add_watcher(w)}
                    end
                  end
                end
                def get_keyword(attr, options={})
                  @keywords ||= {}
                  if @keywords.has_key?(attr)
                    @keywords[attr]
                  else
                    @keywords[attr] = begin
                      if (options[:override] || @@handler_options[:allow_override].include?(attr.to_s)) && plain_text_body.gsub!(/^#{attr.to_s.humanize}[ \t]*:[ \t]*(.+)\s*$/i, '')
                        $1.strip
                      elsif !@@handler_options[:issue][attr].blank?
                        @@handler_options[:issue][attr]
                      end
                    end
                  end
                end
+               def target_project
+                 # TODO: other ways to specify project:
+                 # * parse the email To field
+                 # * specific project (eg. Setting.mail_handler_target_project)
+                 target = Project.find_by_identifier(get_keyword(:project))
+                 raise MissingInformation.new('Unable to determine target project') if target.nil?
+                 target
+               end
+               # Returns a Hash of issue attributes extracted from keywords in the email body
+               def issue_attributes_from_keywords(issue)
+                 {
+                   'tracker_id' => ((k = get_keyword(:tracker)) && issue.project.trackers.find_by_name(k).try(:id)) || issue.project.trackers.find(:first).try(:id),
+                   'status_id' =>  (k = get_keyword(:status)) && IssueStatus.find_by_name(k).try(:id),
+                   'priority_id' => (k = get_keyword(:priority)) && IssuePriority.find_by_name(k).try(:id),
+                   'category_id' => (k = get_keyword(:category)) && issue.project.issue_categories.find_by_name(k).try(:id),
+                   'assigned_to_id' => (k = get_keyword(:assigned_to, :override => true)) && find_user_from_keyword(k).try(:id),
+                   'fixed_version_id' => (k = get_keyword(:fixed_version, :override => true)) && issue.project.shared_versions.find_by_name(k).try(:id),
+                   'start_date' => get_keyword(:start_date, :override => true),
+                   'due_date' => get_keyword(:due_date, :override => true),
+                   'estimated_hours' => get_keyword(:estimated_hours, :override => true),
+                   'done_ratio' => get_keyword(:done_ratio, :override => true),
+                 }.delete_if {|k, v| v.blank? }
+               end
+               # Returns a Hash of issue custom field values extracted from keywords in the email body
+               def custom_field_values_from_keywords(customized)
+                 customized.custom_field_values.inject({}) do |h, v|
+                   if value = get_keyword(v.custom_field.name, :override => true)
+                     h[v.custom_field.id.to_s] = value
+                   end
+                   h
+                 end
+               end
                # Returns the text/plain part of the email
                # If not found (eg. HTML-only email), returns the body with tags removed
                def plain_text_body
                  return @plain_text_body unless @plain_text_body.nil?
                  parts = @email.parts.collect {|c| (c.respond_to?(:parts) && !c.parts.empty?) ? c.parts : c}.flatten
                  if parts.empty?
                    parts << @email
                  end
                  plain_text_part = parts.detect {|p| p.content_type == 'text/plain'}
                  if plain_text_part.nil?
                    # no text/plain part found, assuming html-only email
                    # strip html tags and remove doctype directive
                    @plain_text_body = strip_tags(@email.body.to_s)
                    @plain_text_body.gsub! %r{^<!DOCTYPE .*$}, ''
                  else
                    @plain_text_body = plain_text_part.body.to_s
                  end
                  @plain_text_body.strip!
                  @plain_text_body
                end
                def cleaned_up_text_body
                  cleanup_body(plain_text_body)
                end
                def self.full_sanitizer
                  @full_sanitizer ||= HTML::FullSanitizer.new
                end
                # Creates a user account for the +email+ sender
                def self.create_user_from_email(email)
                  addr = email.from_addrs.to_a.first
                  if addr && !addr.spec.blank?
                    user = User.new
                    user.mail = addr.spec
                    names = addr.name.blank? ? addr.spec.gsub(/@.*$/, '').split('.') : addr.name.split
                    user.firstname = names.shift
                    user.lastname = names.join(' ')
                    user.lastname = '-' if user.lastname.blank?
                    user.login = user.mail
                    user.password = ActiveSupport::SecureRandom.hex(5)
                    user.language = Setting.default_language
                    user.save ? user : nil
                  end
                end
                private
                # Removes the email body of text after the truncation configurations.
                def cleanup_body(body)
                  delimiters = Setting.mail_handler_body_delimiters.to_s.split(/[\r\n]+/).reject(&:blank?).map {|s| Regexp.escape(s)}
                  unless delimiters.empty?
                    regex = Regexp.new("^[> ]*(#{ delimiters.join('|') })\s*[\r\n].*", Regexp::MULTILINE)
                    body = body.gsub(regex, '')
                  end
                  body.strip
                end
                def find_user_from_keyword(keyword)
                  user ||= User.find_by_mail(keyword)
                  user ||= User.find_by_login(keyword)
                  if user.nil? && keyword.match(/ /)
                    firstname, lastname = *(keyword.split) # "First Last Throwaway"
                    user ||= User.find_by_firstname_and_lastname(firstname, lastname)
                  end
                  user
                end
              end

test/fixtures/mail_handler/ticket_on_given_project.eml +3 0

              Return-Path: <JSmith@somenet.foo>
              Received: from osiris ([127.0.0.1])
              	by OSIRIS
              	with hMailServer ; Sun, 22 Jun 2008 12:28:07 +0200
              Message-ID: <000501c8d452$a95cd7e0$0a00a8c0@osiris>
              From: "John Smith" <JSmith@somenet.foo>
              To: <redmine@somenet.foo>
              Subject: New ticket on a given project
              Date: Sun, 22 Jun 2008 12:28:07 +0200
              MIME-Version: 1.0
              Content-Type: text/plain;
              	format=flowed;
              	charset="iso-8859-1";
              	reply-type=original
              Content-Transfer-Encoding: 7bit
              X-Priority: 3
              X-MSMail-Priority: Normal
              X-Mailer: Microsoft Outlook Express 6.00.2900.2869
              X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.2869
              Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas imperdiet
              turpis et odio. Integer eget pede vel dolor euismod varius. Phasellus
              blandit eleifend augue. Nulla facilisi. Duis id diam. Class aptent taciti
              sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. In
              in urna sed tellus aliquet lobortis. Morbi scelerisque tortor in dolor. Cras
              sagittis odio eu lacus. Aliquam sem tortor, consequat sit amet, vestibulum
              id, iaculis at, lectus. Fusce tortor libero, congue ut, euismod nec, luctus
              eget, eros. Pellentesque tortor enim, feugiat in, dignissim eget, tristique
              sed, mauris --- Pellentesque habitant morbi tristique senectus et netus et
              malesuada fames ac turpis egestas. Quisque sit amet libero. In hac habitasse
              platea dictumst.
              --- This line starts with a delimiter and should not be stripped
              This paragraph is before delimiters.
              BREAK
              This paragraph is between delimiters.
              ---
              This paragraph is after the delimiter so it shouldn't appear.
              Nulla et nunc. Duis pede. Donec et ipsum. Nam ut dui tincidunt neque
              sollicitudin iaculis. Duis vitae dolor. Vestibulum eget massa. Sed lorem.
              Nullam volutpat cursus erat. Cras felis dolor, lacinia quis, rutrum et,
              dictum et, ligula. Sed erat nibh, gravida in, accumsan non, placerat sed,
              massa. Sed sodales, ante fermentum ultricies sollicitudin, massa leo
              pulvinar dui, a gravida orci mi eget odio. Nunc a lacus.
              Project: onlinestore
              Status: Resolved
              due date: 2010-12-31
              Start Date:2010-01-01
              Assigned to: John Smith
+             fixed version: alpha
+             estimated hours: 2.5
+             done ratio: 30

test/fixtures/mail_handler/ticket_reply_with_status.eml +1 0

              Return-Path: <jsmith@somenet.foo>
              Received: from osiris ([127.0.0.1])
              	by OSIRIS
              	with hMailServer ; Sat, 21 Jun 2008 18:41:39 +0200
              Message-ID: <006a01c8d3bd$ad9baec0$0a00a8c0@osiris>
              From: "John Smith" <jsmith@somenet.foo>
              To: <redmine@somenet.foo>
              References: <485d0ad366c88_d7014663a025f@osiris.tmail>
              Subject: Re: [Cookbook - Feature #2] (New) Add ingredients categories
              Date: Sat, 21 Jun 2008 18:41:39 +0200
              MIME-Version: 1.0
              Content-Type: multipart/alternative;
              	boundary="----=_NextPart_000_0067_01C8D3CE.711F9CC0"
              X-Priority: 3
              X-MSMail-Priority: Normal
              X-Mailer: Microsoft Outlook Express 6.00.2900.2869
              X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.2869
              This is a multi-part message in MIME format.
              ------=_NextPart_000_0067_01C8D3CE.711F9CC0
              Content-Type: text/plain;
              	charset="utf-8"
              Content-Transfer-Encoding: quoted-printable
              This is reply
              Status: Resolved
              due date: 2010-12-31
              Start Date:2010-01-01
              Assigned to: jsmith@somenet.foo
+             searchable field: Updated custom value
              ------=_NextPart_000_0067_01C8D3CE.711F9CC0
              Content-Type: text/html;
              	charset="utf-8"
              Content-Transfer-Encoding: quoted-printable
              =EF=BB=BF<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
              <HTML><HEAD>
              <META http-equiv=3DContent-Type content=3D"text/html; charset=3Dutf-8">
              <STYLE>BODY {
              	FONT-SIZE: 0.8em; COLOR: #484848; FONT-FAMILY: Verdana, sans-serif
              }
              BODY H1 {
              	FONT-SIZE: 1.2em; MARGIN: 0px; FONT-FAMILY: "Trebuchet MS", Verdana, =
              sans-serif
              }
              A {
              	COLOR: #2a5685
              }
              A:link {
              	COLOR: #2a5685
              }
              A:visited {
              	COLOR: #2a5685
              }
              A:hover {
              	COLOR: #c61a1a
              }
              A:active {
              	COLOR: #c61a1a
              }
              HR {
              	BORDER-RIGHT: 0px; BORDER-TOP: 0px; BACKGROUND: #ccc; BORDER-LEFT: 0px; =
              WIDTH: 100%; BORDER-BOTTOM: 0px; HEIGHT: 1px
              }
              .footer {
              	FONT-SIZE: 0.8em; FONT-STYLE: italic
              }
              </STYLE>
              <META content=3D"MSHTML 6.00.2900.2883" name=3DGENERATOR></HEAD>
              <BODY bgColor=3D#ffffff>
              <DIV><SPAN class=3Dfooter><FONT face=3DArial color=3D#000000 =
              size=3D2>This is=20
              reply Status: Resolved</FONT></DIV></SPAN></BODY></HTML>
              ------=_NextPart_000_0067_01C8D3CE.711F9CC0--

test/unit/mail_handler_test.rb +5 0

              # encoding: utf-8
              #
              # Redmine - project management software
              # Copyright (C) 2006-2009  Jean-Philippe Lang
              #
              # This program is free software; you can redistribute it and/or
              # modify it under the terms of the GNU General Public License
              # as published by the Free Software Foundation; either version 2
              # of the License, or (at your option) any later version.
              #
              # This program is distributed in the hope that it will be useful,
              # but WITHOUT ANY WARRANTY; without even the implied warranty of
              # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
              # GNU General Public License for more details.
              #
              # You should have received a copy of the GNU General Public License
              # along with this program; if not, write to the Free Software
              # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
              require File.dirname(__FILE__) + '/../test_helper'
              class MailHandlerTest < ActiveSupport::TestCase
                fixtures :users, :projects,
                                 :enabled_modules,
                                 :roles,
                                 :members,
                                 :member_roles,
                                 :issues,
                                 :issue_statuses,
                                 :workflows,
                                 :trackers,
                                 :projects_trackers,
+                                :versions,
                                 :enumerations,
                                 :issue_categories,
                                 :custom_fields,
                                 :custom_fields_trackers,
                                 :boards,
                                 :messages
                FIXTURES_PATH = File.dirname(__FILE__) + '/../fixtures/mail_handler'
                def setup
                  ActionMailer::Base.deliveries.clear
                  Setting.notified_events = Redmine::Notifiable.all.collect(&:name)
                end
                def test_add_issue
                  ActionMailer::Base.deliveries.clear
                  # This email contains: 'Project: onlinestore'
                  issue = submit_email('ticket_on_given_project.eml')
                  assert issue.is_a?(Issue)
                  assert !issue.new_record?
                  issue.reload
                  assert_equal 'New ticket on a given project', issue.subject
                  assert_equal User.find_by_login('jsmith'), issue.author
                  assert_equal Project.find(2), issue.project
                  assert_equal IssueStatus.find_by_name('Resolved'), issue.status
                  assert issue.description.include?('Lorem ipsum dolor sit amet, consectetuer adipiscing elit.')
                  assert_equal '2010-01-01', issue.start_date.to_s
                  assert_equal '2010-12-31', issue.due_date.to_s
                  assert_equal User.find_by_login('jsmith'), issue.assigned_to
+                 assert_equal Version.find_by_name('alpha'), issue.fixed_version
+                 assert_equal 2.5, issue.estimated_hours
+                 assert_equal 30, issue.done_ratio
                  # keywords should be removed from the email body
                  assert !issue.description.match(/^Project:/i)
                  assert !issue.description.match(/^Status:/i)
                  # Email notification should be sent
                  mail = ActionMailer::Base.deliveries.last
                  assert_not_nil mail
                  assert mail.subject.include?('New ticket on a given project')
                end
                def test_add_issue_with_status
                  # This email contains: 'Project: onlinestore' and 'Status: Resolved'
                  issue = submit_email('ticket_on_given_project.eml')
                  assert issue.is_a?(Issue)
                  assert !issue.new_record?
                  issue.reload
                  assert_equal Project.find(2), issue.project
                  assert_equal IssueStatus.find_by_name("Resolved"), issue.status
                end
                def test_add_issue_with_attributes_override
                  issue = submit_email('ticket_with_attributes.eml', :allow_override => 'tracker,category,priority')
                  assert issue.is_a?(Issue)
                  assert !issue.new_record?
                  issue.reload
                  assert_equal 'New ticket on a given project', issue.subject
                  assert_equal User.find_by_login('jsmith'), issue.author
                  assert_equal Project.find(2), issue.project
                  assert_equal 'Feature request', issue.tracker.to_s
                  assert_equal 'Stock management', issue.category.to_s
                  assert_equal 'Urgent', issue.priority.to_s
                  assert issue.description.include?('Lorem ipsum dolor sit amet, consectetuer adipiscing elit.')
                end
                def test_add_issue_with_partial_attributes_override
                  issue = submit_email('ticket_with_attributes.eml', :issue => {:priority => 'High'}, :allow_override => ['tracker'])
                  assert issue.is_a?(Issue)
                  assert !issue.new_record?
                  issue.reload
                  assert_equal 'New ticket on a given project', issue.subject
                  assert_equal User.find_by_login('jsmith'), issue.author
                  assert_equal Project.find(2), issue.project
                  assert_equal 'Feature request', issue.tracker.to_s
                  assert_nil issue.category
                  assert_equal 'High', issue.priority.to_s
                  assert issue.description.include?('Lorem ipsum dolor sit amet, consectetuer adipiscing elit.')
                end
                def test_add_issue_with_spaces_between_attribute_and_separator
                  issue = submit_email('ticket_with_spaces_between_attribute_and_separator.eml', :allow_override => 'tracker,category,priority')
                  assert issue.is_a?(Issue)
                  assert !issue.new_record?
                  issue.reload
                  assert_equal 'New ticket on a given project', issue.subject
                  assert_equal User.find_by_login('jsmith'), issue.author
                  assert_equal Project.find(2), issue.project
                  assert_equal 'Feature request', issue.tracker.to_s
                  assert_equal 'Stock management', issue.category.to_s
                  assert_equal 'Urgent', issue.priority.to_s
                  assert issue.description.include?('Lorem ipsum dolor sit amet, consectetuer adipiscing elit.')
                end
                def test_add_issue_with_attachment_to_specific_project
                  issue = submit_email('ticket_with_attachment.eml', :issue => {:project => 'onlinestore'})
                  assert issue.is_a?(Issue)
                  assert !issue.new_record?
                  issue.reload
                  assert_equal 'Ticket created by email with attachment', issue.subject
                  assert_equal User.find_by_login('jsmith'), issue.author
                  assert_equal Project.find(2), issue.project
                  assert_equal 'This is  a new ticket with attachments', issue.description
                  # Attachment properties
                  assert_equal 1, issue.attachments.size
                  assert_equal 'Paella.jpg', issue.attachments.first.filename
                  assert_equal 'image/jpeg', issue.attachments.first.content_type
                  assert_equal 10790, issue.attachments.first.filesize
                end
                def test_add_issue_with_custom_fields
                  issue = submit_email('ticket_with_custom_fields.eml', :issue => {:project => 'onlinestore'})
                  assert issue.is_a?(Issue)
                  assert !issue.new_record?
                  issue.reload
                  assert_equal 'New ticket with custom field values', issue.subject
                  assert_equal 'Value for a custom field', issue.custom_value_for(CustomField.find_by_name('Searchable field')).value
                  assert !issue.description.match(/^searchable field:/i)
                end
                def test_add_issue_with_cc
                  issue = submit_email('ticket_with_cc.eml', :issue => {:project => 'ecookbook'})
                  assert issue.is_a?(Issue)
                  assert !issue.new_record?
                  issue.reload
                  assert issue.watched_by?(User.find_by_mail('dlopper@somenet.foo'))
                  assert_equal 1, issue.watcher_user_ids.size
                end
                def test_add_issue_by_unknown_user
                  assert_no_difference 'User.count' do
                    assert_equal false, submit_email('ticket_by_unknown_user.eml', :issue => {:project => 'ecookbook'})
                  end
                end
                def test_add_issue_by_anonymous_user
                  Role.anonymous.add_permission!(:add_issues)
                  assert_no_difference 'User.count' do
                    issue = submit_email('ticket_by_unknown_user.eml', :issue => {:project => 'ecookbook'}, :unknown_user => 'accept')
                    assert issue.is_a?(Issue)
                    assert issue.author.anonymous?
                  end
                end
                def test_add_issue_by_anonymous_user_with_no_from_address
                  Role.anonymous.add_permission!(:add_issues)
                  assert_no_difference 'User.count' do
                    issue = submit_email('ticket_by_empty_user.eml', :issue => {:project => 'ecookbook'}, :unknown_user => 'accept')
                    assert issue.is_a?(Issue)
                    assert issue.author.anonymous?
                  end
                end
                def test_add_issue_by_anonymous_user_on_private_project
                  Role.anonymous.add_permission!(:add_issues)
                  assert_no_difference 'User.count' do
                    assert_no_difference 'Issue.count' do
                      assert_equal false, submit_email('ticket_by_unknown_user.eml', :issue => {:project => 'onlinestore'}, :unknown_user => 'accept')
                    end
                  end
                end
                def test_add_issue_by_anonymous_user_on_private_project_without_permission_check
                  assert_no_difference 'User.count' do
                    assert_difference 'Issue.count' do
                      issue = submit_email('ticket_by_unknown_user.eml', :issue => {:project => 'onlinestore'}, :no_permission_check => '1', :unknown_user => 'accept')
                      assert issue.is_a?(Issue)
                      assert issue.author.anonymous?
                      assert !issue.project.is_public?
                    end
                  end
                end
                def test_add_issue_by_created_user
                  Setting.default_language = 'en'
                  assert_difference 'User.count' do
                    issue = submit_email('ticket_by_unknown_user.eml', :issue => {:project => 'ecookbook'}, :unknown_user => 'create')
                    assert issue.is_a?(Issue)
                    assert issue.author.active?
                    assert_equal 'john.doe@somenet.foo', issue.author.mail
                    assert_equal 'John', issue.author.firstname
                    assert_equal 'Doe', issue.author.lastname
                    # account information
                    email = ActionMailer::Base.deliveries.first
                    assert_not_nil email
                    assert email.subject.include?('account activation')
                    login = email.body.match(/\* Login: (.*)$/)[1]
                    password = email.body.match(/\* Password: (.*)$/)[1]
                    assert_equal issue.author, User.try_to_login(login, password)
                  end
                end
                def test_add_issue_without_from_header
                  Role.anonymous.add_permission!(:add_issues)
                  assert_equal false, submit_email('ticket_without_from_header.eml')
                end
                def test_add_issue_with_japanese_keywords
                  tracker = Tracker.create!(:name => '開発')
                  Project.find(1).trackers << tracker
                  issue = submit_email('japanese_keywords_iso_2022_jp.eml', :issue => {:project => 'ecookbook'}, :allow_override => 'tracker')
                  assert_kind_of Issue, issue
                  assert_equal tracker, issue.tracker
                end
                def test_should_ignore_emails_from_emission_address
                  Role.anonymous.add_permission!(:add_issues)
                  assert_no_difference 'User.count' do
                    assert_equal false, submit_email('ticket_from_emission_address.eml', :issue => {:project => 'ecookbook'}, :unknown_user => 'create')
                  end
                end
                def test_add_issue_should_send_email_notification
                  Setting.notified_events = ['issue_added']
                  ActionMailer::Base.deliveries.clear
                  # This email contains: 'Project: onlinestore'
                  issue = submit_email('ticket_on_given_project.eml')
                  assert issue.is_a?(Issue)
                  assert_equal 1, ActionMailer::Base.deliveries.size
                end
                def test_add_issue_note
                  journal = submit_email('ticket_reply.eml')
                  assert journal.is_a?(Journal)
                  assert_equal User.find_by_login('jsmith'), journal.user
                  assert_equal Issue.find(2), journal.journalized
                  assert_match /This is reply/, journal.notes
                end
                def test_add_issue_note_with_attribute_changes
                  # This email contains: 'Status: Resolved'
                  journal = submit_email('ticket_reply_with_status.eml')
                  assert journal.is_a?(Journal)
                  issue = Issue.find(journal.issue.id)
                  assert_equal User.find_by_login('jsmith'), journal.user
                  assert_equal Issue.find(2), journal.journalized
                  assert_match /This is reply/, journal.notes
                  assert_equal IssueStatus.find_by_name("Resolved"), issue.status
                  assert_equal '2010-01-01', issue.start_date.to_s
                  assert_equal '2010-12-31', issue.due_date.to_s
                  assert_equal User.find_by_login('jsmith'), issue.assigned_to
+                 assert_equal 'Updated custom value', issue.custom_value_for(CustomField.find_by_name('Searchable field')).value
                end
                def test_add_issue_note_should_send_email_notification
                  ActionMailer::Base.deliveries.clear
                  journal = submit_email('ticket_reply.eml')
                  assert journal.is_a?(Journal)
                  assert_equal 1, ActionMailer::Base.deliveries.size
                end
                def test_reply_to_a_message
                  m = submit_email('message_reply.eml')
                  assert m.is_a?(Message)
                  assert !m.new_record?
                  m.reload
                  assert_equal 'Reply via email', m.subject
                  # The email replies to message #2 which is part of the thread of message #1
                  assert_equal Message.find(1), m.parent
                end
                def test_reply_to_a_message_by_subject
                  m = submit_email('message_reply_by_subject.eml')
                  assert m.is_a?(Message)
                  assert !m.new_record?
                  m.reload
                  assert_equal 'Reply to the first post', m.subject
                  assert_equal Message.find(1), m.parent
                end
                def test_should_strip_tags_of_html_only_emails
                  issue = submit_email('ticket_html_only.eml', :issue => {:project => 'ecookbook'})
                  assert issue.is_a?(Issue)
                  assert !issue.new_record?
                  issue.reload
                  assert_equal 'HTML email', issue.subject
                  assert_equal 'This is a html-only email.', issue.description
                end
                context "truncate emails based on the Setting" do
                  context "with no setting" do
                    setup do
                      Setting.mail_handler_body_delimiters = ''
                    end
                    should "add the entire email into the issue" do
                      issue = submit_email('ticket_on_given_project.eml')
                      assert_issue_created(issue)
                      assert issue.description.include?('---')
                      assert issue.description.include?('This paragraph is after the delimiter')
                    end
                  end
                  context "with a single string" do
                    setup do
                      Setting.mail_handler_body_delimiters = '---'
                    end
                    should "truncate the email at the delimiter for the issue" do
                      issue = submit_email('ticket_on_given_project.eml')
                      assert_issue_created(issue)
                      assert issue.description.include?('This paragraph is before delimiters')
                      assert issue.description.include?('--- This line starts with a delimiter')
                      assert !issue.description.match(/^---$/)
                      assert !issue.description.include?('This paragraph is after the delimiter')
                    end
                  end
                  context "with a single quoted reply (e.g. reply to a Redmine email notification)" do
                    setup do
                      Setting.mail_handler_body_delimiters = '--- Reply above. Do not remove this line. ---'
                    end
                    should "truncate the email at the delimiter with the quoted reply symbols (>)" do
                      journal = submit_email('issue_update_with_quoted_reply_above.eml')
                      assert journal.is_a?(Journal)
                      assert journal.notes.include?('An update to the issue by the sender.')
                      assert !journal.notes.match(Regexp.escape("--- Reply above. Do not remove this line. ---"))
                      assert !journal.notes.include?('Looks like the JSON api for projects was missed.')
                    end
                  end
                  context "with multiple quoted replies (e.g. reply to a reply of a Redmine email notification)" do
                    setup do
                      Setting.mail_handler_body_delimiters = '--- Reply above. Do not remove this line. ---'
                    end
                    should "truncate the email at the delimiter with the quoted reply symbols (>)" do
                      journal = submit_email('issue_update_with_multiple_quoted_reply_above.eml')
                      assert journal.is_a?(Journal)
                      assert journal.notes.include?('An update to the issue by the sender.')
                      assert !journal.notes.match(Regexp.escape("--- Reply above. Do not remove this line. ---"))
                      assert !journal.notes.include?('Looks like the JSON api for projects was missed.')
                    end
                  end
                  context "with multiple strings" do
                    setup do
                      Setting.mail_handler_body_delimiters = "---\nBREAK"
                    end
                    should "truncate the email at the first delimiter found (BREAK)" do
                      issue = submit_email('ticket_on_given_project.eml')
                      assert_issue_created(issue)
                      assert issue.description.include?('This paragraph is before delimiters')
                      assert !issue.description.include?('BREAK')
                      assert !issue.description.include?('This paragraph is between delimiters')
                      assert !issue.description.match(/^---$/)
                      assert !issue.description.include?('This paragraph is after the delimiter')
                    end
                  end
                end
                def test_email_with_long_subject_line
                  issue = submit_email('ticket_with_long_subject.eml')
                  assert issue.is_a?(Issue)
                  assert_equal issue.subject, 'New ticket on a given project with a very long subject line which exceeds 255 chars and should not be ignored but chopped off. And if the subject line is still not long enough, we just add more text. And more text. Wow, this is really annoying. Especially, if you have nothing to say...'[0,255]
                end
                private
                def submit_email(filename, options={})
                  raw = IO.read(File.join(FIXTURES_PATH, filename))
                  MailHandler.receive(raw, options)
                end
                def assert_issue_created(issue)
                  assert issue.is_a?(Issue)
                  assert !issue.new_record?
                  issue.reload
                end
              end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages