jro_apps/redmine Commit - r2689:b3afde14fa60

Ability to accept incoming emails from unknown users (#2230, #3003)....

Jean-Philippe Lang -

r2689:b3afde14fa60

parent child

Context file:

r2689:b3afde14fa60

Collapse all files

test/fixtures/mail_handler/ticket_by_unknown_user.eml created 644 +18 0

@@ -0,0 +1,18
	1	Return-Path: <john.doe@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 Doe" <john.doe@somenet.foo>
	7	To: <redmine@somenet.foo>
	8	Subject: Ticket by unknown user
	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
	17	This is a ticket submitted by an unknown user.
	18

app/models/mail_handler.rb +43 -5

@@ -38,15 +38,34 class MailHandler < ActionMailer::Base
38	end	38	end
39		39
40	# Processes incoming emails	40	# Processes incoming emails
		41	# Returns the created object (eg. an issue, a message) or false
41	def receive(email)	42	def receive(email)
42	@email = email	43	@email = email
43	@user = User.~~active~~.find_by_mail(email.from.to_a.first.to_s.strip)	44	@user = User.find_by_mail(email.from.to_a.first.to_s.strip)
44	unless @user	45	if @user && !@user.active?
45	# Unknown user => the email is ignored	46	logger.info "MailHandler: ignoring email from non-active user [#{@user.login}]" if logger && logger.info
46	# TODO: ability to create the user's account
47	logger.info "MailHandler: email submitted by unknown user [#{email.from.first}]" if logger && logger.info
48	return false	47	return false
49	end	48	end
		49	if @user.nil?
		50	# Email was submitted by an unknown user
		51	case @@handler_options[:unknown_user]
		52	when 'accept'
		53	@user = User.anonymous
		54	when 'create'
		55	@user = MailHandler.create_user_from_email(email)
		56	if @user
		57	logger.info "MailHandler: [#{@user.login}] account created" if logger && logger.info
		58	Mailer.deliver_account_information(@user, @user.password)
		59	else
		60	logger.error "MailHandler: could not create account for [#{email.from.first}]" if logger && logger.error
		61	return false
		62	end
		63	else
		64	# Default behaviour, emails from unknown users are ignored
		65	logger.info "MailHandler: ignoring email from unknown user [#{email.from.first}]" if logger && logger.info
		66	return false
		67	end
		68	end
50	User.current = @user	69	User.current = @user
51	dispatch	70	dispatch
52	end	71	end
@@ -239,4 +258,23 class MailHandler < ActionMailer::Base
239	def self.full_sanitizer	258	def self.full_sanitizer
240	@full_sanitizer \|\|= HTML::FullSanitizer.new	259	@full_sanitizer \|\|= HTML::FullSanitizer.new
241	end	260	end
		261
		262	# Creates a user account for the +email+ sender
		263	def self.create_user_from_email(email)
		264	addr = email.from_addrs.to_a.first
		265	if addr && !addr.spec.blank?
		266	user = User.new
		267	user.mail = addr.spec
		268
		269	names = addr.name.blank? ? addr.spec.gsub(/@.*$/, '').split('.') : addr.name.split
		270	user.firstname = names.shift
		271	user.lastname = names.join(' ')
		272	user.lastname = '-' if user.lastname.blank?
		273
		274	user.login = user.mail
		275	user.password = ActiveSupport::SecureRandom.hex(5)
		276	user.language = Setting.default_language
		277	user.save ? user : nil
		278	end
		279	end
242	end	280	end

extra/mail_handler/rdm-mailhandler.rb +13 -3

             #   -k, --key                      Redmine API key
             #
             # General options:
+            #       --unknown-user=ACTION      how to handle emails from an unknown user
+            #                                  ACTION can be one of the following values:
+            #                                  ignore: email is ignored (default)
+            #                                  accept: accept as anonymous user
+            #                                  create: create a user account
             #   -h, --help                     show this help
             #   -v, --verbose                  show extra information
             #   -V, --version                  show version information and exit
             class RedmineMailHandler
               VERSION = '0.1'
-              attr_accessor :verbose, :issue_attributes, :allow_override, :url, :key
+              attr_accessor :verbose, :issue_attributes, :allow_override, :uknown_user, :url, :key
               def initialize
                 self.issue_attributes = {}
                   [ '--tracker',        '-t', GetoptLong::REQUIRED_ARGUMENT],
                   [ '--category',             GetoptLong::REQUIRED_ARGUMENT],
                   [ '--priority',             GetoptLong::REQUIRED_ARGUMENT],
-                  [ '--allow-override', '-o', GetoptLong::REQUIRED_ARGUMENT]
+                  [ '--allow-override', '-o', GetoptLong::REQUIRED_ARGUMENT],
+                  [ '--unknown-user',         GetoptLong::REQUIRED_ARGUMENT]
                 )
                 opts.each do |opt, arg|
                     self.issue_attributes[opt.gsub(%r{^\-\-}, '')] = arg.dup
                   when '--allow-override'
                     self.allow_override = arg.dup
+                  when '--unknown-user'
+                    self.unknown_user = arg.dup
                   end
                 end
               def submit(email)
                 uri = url.gsub(%r{/*$}, '') + '/mail_handler'
-                data = { 'key' => key, 'email' => email, 'allow_override' => allow_override }
+                data = { 'key' => key, 'email' => email,
+                                       'allow_override' => allow_override,
+                                       'unknown_user' => unknown_user }
                 issue_attributes.each { |attr, value| data["issue[#{attr}]"] = value }
                 debug "Posting to #{uri}..."

lib/tasks/email.rake +17 -1

                 desc <<-END_DESC
             Read an email from standard input.
+            General options:
+              unknown_user=ACTION      how to handle emails from an unknown user
+                                       ACTION can be one of the following values:
+                                       ignore: email is ignored (default)
+                                       accept: accept as anonymous user
+                                       create: create a user account
             Issue attributes control options:
               project=PROJECT          identifier of the target project
               status=STATUS            name of the target status
                   options = { :issue => {} }
                   %w(project status 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']
+                  options[:unknown_user] = ENV['unknown_user'] if ENV['unknown_user']
                   MailHandler.receive(STDIN.read, options)
                 end
                 desc <<-END_DESC
             Read emails from an IMAP server.
+            General options:
+              unknown_user=ACTION      how to handle emails from an unknown user
+                                       ACTION can be one of the following values:
+                                       ignore: email is ignored (default)
+                                       accept: accept as anonymous user
+                                       create: create a user account
             Available IMAP options:
               host=HOST                IMAP server host (default: 127.0.0.1)
               port=PORT                IMAP server port (default: 143)
               username=USERNAME        IMAP account
               password=PASSWORD        IMAP password
               folder=FOLDER            IMAP folder to read (default: INBOX)
             Issue attributes control options:
               project=PROJECT          identifier of the target project
               status=STATUS            name of the target status
                   options = { :issue => {} }
                   %w(project status 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']
+                  options[:unknown_user] = ENV['unknown_user'] if ENV['unknown_user']
                   Redmine::IMAP.check(imap_options, options)
                 end

test/unit/mail_handler_test.rb +37 -2

@@ -1,5 +1,5
1	# ~~redM~~ine - project management software	1	# Redmine - project management software
2	# Copyright (C) 2006-2007 Jean-Philippe Lang	2	# Copyright (C) 2006-2009 Jean-Philippe Lang
3	#	3	#
4	# This program is free software; you can redistribute it and/or	4	# This program is free software; you can redistribute it and/or
5	# modify it under the terms of the GNU General Public License	5	# modify it under the terms of the GNU General Public License
@@ -130,6 +130,41 class MailHandlerTest < Test::Unit::TestCase
130	assert_equal 1, issue.watchers.size	130	assert_equal 1, issue.watchers.size
131	end	131	end
132		132
		133	def test_add_issue_by_unknown_user
		134	assert_no_difference 'User.count' do
		135	assert_equal false, submit_email('ticket_by_unknown_user.eml', :issue => {:project => 'ecookbook'})
		136	end
		137	end
		138
		139	def test_add_issue_by_anonymous_user
		140	Role.anonymous.add_permission!(:add_issues)
		141	assert_no_difference 'User.count' do
		142	issue = submit_email('ticket_by_unknown_user.eml', :issue => {:project => 'ecookbook'}, :unknown_user => 'accept')
		143	assert issue.is_a?(Issue)
		144	assert issue.author.anonymous?
		145	end
		146	end
		147
		148	def test_add_issue_by_created_user
		149	Setting.default_language = 'en'
		150	assert_difference 'User.count' do
		151	issue = submit_email('ticket_by_unknown_user.eml', :issue => {:project => 'ecookbook'}, :unknown_user => 'create')
		152	assert issue.is_a?(Issue)
		153	assert issue.author.active?
		154	assert_equal 'john.doe@somenet.foo', issue.author.mail
		155	assert_equal 'John', issue.author.firstname
		156	assert_equal 'Doe', issue.author.lastname
		157
		158	# account information
		159	email = ActionMailer::Base.deliveries.first
		160	assert_not_nil email
		161	assert email.subject.include?('account activation')
		162	login = email.body.match(/\* Login: (.*)$/)[1]
		163	password = email.body.match(/\* Password: (.*)$/)[1]
		164	assert_equal issue.author, User.try_to_login(login, password)
		165	end
		166	end
		167
133	def test_add_issue_without_from_header	168	def test_add_issue_without_from_header
134	Role.anonymous.add_permission!(:add_issues)	169	Role.anonymous.add_permission!(:add_issues)
135	assert_equal false, submit_email('ticket_without_from_header.eml')	170	assert_equal false, submit_email('ticket_without_from_header.eml')

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