jro_apps/redmine Commit - r1629:40efaae6d5a2

Mail handler: more control over issue attributes (#1110)....

Jean-Philippe Lang -

r1629:40efaae6d5a2

parent child

Context file:

r1629:40efaae6d5a2

Collapse all files

test/fixtures/mail_handler/ticket_with_attributes.eml created 644 +43 0

@@ -0,0 +1,43
	1	Return-Path: <jsmith@somenet.foo>
	2	Received: from osiris ([127.0.0.1])
	3	by OSIRIS
	4	with hMailServer ; Sun, 22 Jun 2008 12:28:07 +0200
	5	Message-ID: <000501c8d452$a95cd7e0$0a00a8c0@osiris>
	6	From: "John Smith" <jsmith@somenet.foo>
	7	To: <redmine@somenet.foo>
	8	Subject: New ticket on a given project
	9	Date: Sun, 22 Jun 2008 12:28:07 +0200
	10	MIME-Version: 1.0
	11	Content-Type: text/plain;
	12	format=flowed;
	13	charset="iso-8859-1";
	14	reply-type=original
	15	Content-Transfer-Encoding: 7bit
	16	X-Priority: 3
	17	X-MSMail-Priority: Normal
	18	X-Mailer: Microsoft Outlook Express 6.00.2900.2869
	19	X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.2869
	20
	21	Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas imperdiet
	22	turpis et odio. Integer eget pede vel dolor euismod varius. Phasellus
	23	blandit eleifend augue. Nulla facilisi. Duis id diam. Class aptent taciti
	24	sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. In
	25	in urna sed tellus aliquet lobortis. Morbi scelerisque tortor in dolor. Cras
	26	sagittis odio eu lacus. Aliquam sem tortor, consequat sit amet, vestibulum
	27	id, iaculis at, lectus. Fusce tortor libero, congue ut, euismod nec, luctus
	28	eget, eros. Pellentesque tortor enim, feugiat in, dignissim eget, tristique
	29	sed, mauris. Pellentesque habitant morbi tristique senectus et netus et
	30	malesuada fames ac turpis egestas. Quisque sit amet libero. In hac habitasse
	31	platea dictumst.
	32
	33	Nulla et nunc. Duis pede. Donec et ipsum. Nam ut dui tincidunt neque
	34	sollicitudin iaculis. Duis vitae dolor. Vestibulum eget massa. Sed lorem.
	35	Nullam volutpat cursus erat. Cras felis dolor, lacinia quis, rutrum et,
	36	dictum et, ligula. Sed erat nibh, gravida in, accumsan non, placerat sed,
	37	massa. Sed sodales, ante fermentum ultricies sollicitudin, massa leo
	38	pulvinar dui, a gravida orci mi eget odio. Nunc a lacus.
	39
	40	Project: onlinestore
	41	Tracker: Feature request
	42	category: Stock management
	43	priority: Urgent

app/models/mail_handler.rb +22 -11

             # 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
               class UnauthorizedAction < StandardError; end
               class MissingInformation < StandardError; end
               attr_reader :email, :user
               def self.receive(email, options={})
-                @@handler_options = 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)
                 super email
               end
               # Processes incoming emails
               def receive(email)
                 @email = email
                 @user = User.find_active(:first, :conditions => {:mail => email.from.first})
                 unless @user
                   # Unknown user => the email is ignored
                   # TODO: ability to create the user's account
                   logger.info "MailHandler: email submitted by unknown user [#{email.from.first}]" if logger && logger.info
                   return false
                 end
                 User.current = @user
                 dispatch
               end
               private
               ISSUE_REPLY_SUBJECT_RE = %r{\[[^\]]+#(\d+)\]}
               def dispatch
                 if m = email.subject.match(ISSUE_REPLY_SUBJECT_RE)
                   receive_issue_update(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
-                # TODO: make the tracker configurable
+                tracker = (get_keyword(:tracker) && project.trackers.find_by_name(get_keyword(:tracker))) || project.trackers.find(:first)
-                tracker = project.trackers.find(:first)
+                category = (get_keyword(:category) && project.issue_categories.find_by_name(get_keyword(:category)))
+                priority = (get_keyword(:priority) && Enumeration.find_by_opt_and_name('IPRI', get_keyword(:priority)))
                 # check permission
                 raise UnauthorizedAction unless user.allowed_to?(:add_issues, project)
-                issue = Issue.new(:author => user, :project => project, :tracker => tracker)
+                issue = Issue.new(:author => user, :project => project, :tracker => tracker, :category => category, :priority => priority)
                 issue.subject = email.subject.chomp
                 issue.description = email.plain_text_body.chomp
                 issue.save!
                 add_attachments(issue)
                 logger.info "MailHandler: issue ##{issue.id} created by #{user}" if logger && logger.info
                 Mailer.deliver_issue_add(issue) if Setting.notified_events.include?('issue_added')
                 issue
               end
               def target_project
                 # TODO: other ways to specify project:
                 # * parse the email To field
                 # * specific project (eg. Setting.mail_handler_target_project)
-                identifier = if !@@handler_options[:project].blank?
+                target = Project.find_by_identifier(get_keyword(:project))
-                               @@handler_options[:project]
-                             elsif email.plain_text_body =~ %r{^Project:[ \t]*(.+)$}i
-                                $1
-                             end
-                target = Project.find_by_identifier(identifier.to_s)
                 raise MissingInformation.new('Unable to determine target project') if target.nil?
                 target
               end
               # Adds a note to an existing issue
               def receive_issue_update(issue_id)
                 issue = Issue.find_by_id(issue_id)
                 return unless issue
                 # check permission
                 raise UnauthorizedAction unless user.allowed_to?(:add_issue_notes, issue.project) || user.allowed_to?(:edit_issues, issue.project)
                 # add the note
                 journal = issue.init_journal(user, email.plain_text_body.chomp)
                 add_attachments(issue)
                 issue.save!
                 logger.info "MailHandler: issue ##{issue.id} updated by #{user}" if logger && logger.info
                 Mailer.deliver_issue_edit(journal) if Setting.notified_events.include?('issue_updated')
                 journal
               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
+              def get_keyword(attr)
+                if @@handler_options[:allow_override].include?(attr.to_s) && email.plain_text_body =~ /^#{attr}:[ \t]*(.+)$/i
+                  $1.strip
+                elsif !@@handler_options[:issue][attr].blank?
+                  @@handler_options[:issue][attr]
+                end
+              end
             end
             class TMail::Mail
               # Returns body of the first plain text part found if any
               def plain_text_body
                 return @plain_text_body unless @plain_text_body.nil?
                 p = self.parts.collect {|c| (c.respond_to?(:parts) && !c.parts.empty?) ? c.parts : c}.flatten
                 plain = p.detect {|c| c.content_type == 'text/plain'}
                 @plain_text_body = plain.nil? ? self.body : plain.body
               end
             end

extra/mail_handler/rdm-mailhandler.rb +49 -16

             #!/usr/bin/ruby
             # rdm-mailhandler
             # Reads an email from standard input and forward it to a Redmine server
             # Can be used from a remote mail server
             require 'net/http'
             require 'net/https'
             require 'uri'
             require 'getoptlong'
             class RedmineMailHandler
               VERSION = '0.1'
-              attr_accessor :verbose, :project, :url, :key
+              attr_accessor :verbose, :issue_attributes, :allow_override, :url, :key
               def initialize
+                self.issue_attributes = {}
                 opts = GetoptLong.new(
                   [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
                   [ '--version', '-V', GetoptLong::NO_ARGUMENT ],
                   [ '--verbose', '-v', GetoptLong::NO_ARGUMENT ],
                   [ '--url', '-u', GetoptLong::REQUIRED_ARGUMENT ],
                   [ '--key', '-k', GetoptLong::REQUIRED_ARGUMENT],
-                  [ '--project', '-p', GetoptLong::REQUIRED_ARGUMENT ]
+                  [ '--project', '-p', GetoptLong::REQUIRED_ARGUMENT ],
+                  [ '--tracker', '-t', GetoptLong::REQUIRED_ARGUMENT],
+                  [ '--category', GetoptLong::REQUIRED_ARGUMENT],
+                  [ '--priority', GetoptLong::REQUIRED_ARGUMENT],
+                  [ '--allow-override', '-o', GetoptLong::REQUIRED_ARGUMENT]
                 )
                 opts.each do |opt, arg|
                   case opt
                   when '--url'
                     self.url = arg.dup
                   when '--key'
                     self.key = arg.dup
                   when '--help'
                     usage
                   when '--verbose'
                     self.verbose = true
                   when '--version'
                     puts VERSION; exit
-                  when '--project'
+                  when '--project', '--tracker', '--category', '--priority'
-                    self.project = arg.dup
+                    self.issue_attributes[opt.gsub(%r{^\-\-}, '')] = arg.dup
+                  when '--allow-override'
+                    self.allow_override = arg.dup
                   end
                 end
                 usage if url.nil?
               end
               def submit(email)
                 uri = url.gsub(%r{/*$}, '') + '/mail_handler'
+                data = { 'key' => key, 'email' => email, 'allow_override' => allow_override }
+                issue_attributes.each { |attr, value| data["issue[#{attr}]"] = value }
                 debug "Posting to #{uri}..."
-                data = { 'key' => key, 'project' => project, 'email' => email }
                 response = Net::HTTP.post_form(URI.parse(uri), data)
                 debug "Response received: #{response.code}"
                 response.code == 201 ? 0 : 1
               end
               private
               def usage
-                puts "Usage: rdm-mailhandler [options] --url=<Redmine URL> --key=<API key>"
+                puts  <<-USAGE
-                puts "Reads an email from standard input and forward it to a Redmine server"
+            Usage: rdm-mailhandler [options] --url=<Redmine URL> --key=<API key>
-                puts
+            Reads an email from standard input and forward it to a Redmine server
-                puts "Options:"
-                puts "  --help             show this help"
+            Required:
-                puts "  --verbose          show extra information"
+              -u, --url                      URL of the Redmine server
-                puts "  --project          identifier of the target project"
+              -k, --key                      Redmine API key
-                puts
-                puts "Examples:"
+            General options:
-                puts "  rdm-mailhandler --url http://redmine.domain.foo --key secret"
+              -h, --help                     show this help
-                puts "  rdm-mailhandler --url https://redmine.domain.foo --key secret --project foo"
+              -v, --verbose                  show extra information
+              -V, --version                  show version information and exit
+            Issue attributes control options:
+              -p, --project=PROJECT          identifier of the target project
+              -t, --tracker=TRACKER          name of the target tracker
+                  --category=CATEGORY        name of the target category
+                  --priority=PRIORITY        name of the target priority
+              -o, --allow-override=ATTRS     allow email content to override attributes
+                                             specified by previous options
+                                             ATTRS is a comma separated list of attributes
+            Examples:
+              # No project specified. Emails MUST contain the 'Project' keyword:
+              rdm-mailhandler --url http://redmine.domain.foo --key secret
+              # Fixed project and default tracker specified, but emails can override
+              # both tracker and priority attributes:
+              rdm-mailhandler --url https://domain.foo/redmine --key secret \\
+                              --project foo \\
+                              --tracker bug \\
+                              --allow-override tracker,priority
+            USAGE
                 exit
               end
               def debug(msg)
                 puts msg if verbose
               end
             end
             handler = RedmineMailHandler.new
             handler.submit(STDIN.read)

lib/tasks/email.rake +56 -20

             # redMine - project management software
             # Copyright (C) 2006-2008  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.
             namespace :redmine do
               namespace :email do
                 desc <<-END_DESC
             Read an email from standard input.
-            Available options:
+            Issue attributes control options:
-              * project => identifier of the project the issue should be added to
+              project=PROJECT          identifier of the target project
+              tracker=TRACKER          name of the target tracker
-            Example:
+              category=CATEGORY        name of the target category
-              rake redmine:email:receive project=foo RAILS_ENV="production"
+              priority=PRIORITY        name of the target priority
+              allow_override=ATTRS     allow email content to override attributes
+                                       specified by previous options
+                                       ATTRS is a comma separated list of attributes
+            Examples:
+              # No project specified. Emails MUST contain the 'Project' keyword:
+              rake redmine:email:read RAILS_ENV="production" < raw_email
+              # Fixed project and default tracker specified, but emails can override
+              # both tracker and priority attributes:
+              rake redmine:email:read RAILS_ENV="production" \\
+                              project=foo \\
+                              tracker=bug \\
+                              allow_override=tracker,priority < raw_email
             END_DESC
-                task :receive => :environment do
+                task :read => :environment do
-                  options = {}
+                  options = { :issue => {} }
-                  options[:project] = ENV['project'] if ENV['project']
+                  %w(project tracker category priority).each { |a| options[:issue][a.to_sym] = ENV[a] if ENV[a] }
+                  options[:allow_override] = ENV['allow_override'] if ENV['allow_override']
                   MailHandler.receive(STDIN.read, options)
                 end
                 desc <<-END_DESC
             Read emails from an IMAP server.
             Available IMAP options:
-              * host      => IMAP server host (default: 127.0.0.1)
+              host=HOST                IMAP server host (default: 127.0.0.1)
-              * port      => IMAP server port (default: 143)
+              port=PORT                IMAP server port (default: 143)
-              * ssl       => Use SSL? (default: false)
+              ssl=SSL                  Use SSL? (default: false)
-              * username  => IMAP account
+              username=USERNAME        IMAP account
-              * password  => IMAP password
+              password=PASSWORD        IMAP password
-              * folder    => IMAP folder to read (default: INBOX)
+              folder=FOLDER            IMAP folder to read (default: INBOX)
-            Other options:
-              * project   => identifier of the project the issue should be added to
+            Issue attributes control options:
+              project=PROJECT          identifier of the target project
+              tracker=TRACKER          name of the target tracker
+              category=CATEGORY        name of the target category
+              priority=PRIORITY        name of the target priority
+              allow_override=ATTRS     allow email content to override attributes
+                                       specified by previous options
+                                       ATTRS is a comma separated list of attributes
+            Examples:
+              # No project specified. Emails MUST contain the 'Project' keyword:
+              rake redmine:email:receive_iamp RAILS_ENV="production" \\
+                host=imap.foo.bar username=redmine@somenet.foo password=xxx
+              # Fixed project and default tracker specified, but emails can override
+              # both tracker and priority attributes:
-            Example:
+              rake redmine:email:receive_iamp RAILS_ENV="production" \\
-              rake redmine:email:receive_iamp host=imap.foo.bar username=redmine@somenet.foo password=xxx project=foo RAILS_ENV="production"
+                host=imap.foo.bar username=redmine@somenet.foo password=xxx ssl=1 \\
+                project=foo \\
+                tracker=bug \\
+                allow_override=tracker,priority
             END_DESC
                 task :receive_imap => :environment do
                   imap_options = {:host => ENV['host'],
                                   :port => ENV['port'],
                                   :ssl => ENV['ssl'],
                                   :username => ENV['username'],
                                   :password => ENV['password'],
                                   :folder => ENV['folder']}
-                  options = {}
+                  options = { :issue => {} }
-                  options[:project] = ENV['project'] if ENV['project']
+                  %w(project tracker category priority).each { |a| options[:issue][a.to_sym] = ENV[a] if ENV[a] }
+                  options[:allow_override] = ENV['allow_override'] if ENV['allow_override']
                   Redmine::IMAP.check(imap_options, options)
                 end
               end
             end

test/fixtures/issue_categories.yml +6 0

             ---
             issue_categories_001:
               name: Printing
               project_id: 1
               assigned_to_id: 2
               id: 1
             issue_categories_002:
               name: Recipes
               project_id: 1
               assigned_to_id:
               id: 2
+            issue_categories_003:
+              name: Stock management
+              project_id: 2
+              assigned_to_id:
+              id: 3
+  No newline at end of file

test/unit/mail_handler_test.rb +38 -2

             # 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.
             require File.dirname(__FILE__) + '/../test_helper'
             class MailHandlerTest < Test::Unit::TestCase
-              fixtures :users, :projects, :enabled_modules, :roles, :members, :issues, :trackers, :enumerations
+              fixtures :users, :projects,
+                               :enabled_modules,
+                               :roles,
+                               :members,
+                               :issues,
+                               :trackers,
+                               :projects_trackers,
+                               :enumerations,
+                               :issue_categories
               FIXTURES_PATH = File.dirname(__FILE__) + '/../fixtures/mail_handler'
               def setup
                 ActionMailer::Base.deliveries.clear
               end
               def test_add_issue
                 # 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 issue.description.include?('Lorem ipsum dolor sit amet, consectetuer adipiscing elit.')
               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_attachment_to_specific_project
-                issue = submit_email('ticket_with_attachment.eml', :project => 'onlinestore')
+                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_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_equal 'This is reply', journal.notes
               end
               private
               def submit_email(filename, options={})
                 raw = IO.read(File.join(FIXTURES_PATH, filename))
                 MailHandler.receive(raw, options)
               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