jro_apps/redmine Commit - r2134:3bb2fccaf11d

Mail handler: strip tags when receiving a html-only email (#2312)....

Jean-Philippe Lang -

r2134:3bb2fccaf11d

parent child

Context file:

r2134:3bb2fccaf11d

Collapse all files

test/fixtures/mail_handler/ticket_html_only.eml created 644 +22 0

@@ -0,0 +1,22
	1	x-sender: <jsmith@somenet.foo>
	2	x-receiver: <redmine@somenet.foo>
	3	Received: from [127.0.0.1] ([127.0.0.1]) by somenet.foo with Quick 'n Easy Mail Server SMTP (1.0.0.0);
	4	Sun, 14 Dec 2008 16:18:06 GMT
	5	Message-ID: <494531B9.1070709@somenet.foo>
	6	Date: Sun, 14 Dec 2008 17:18:01 +0100
	7	From: "John Smith" <jsmith@somenet.foo>
	8	User-Agent: Thunderbird 2.0.0.18 (Windows/20081105)
	9	MIME-Version: 1.0
	10	To: redmine@somenet.foo
	11	Subject: HTML email
	12	Content-Type: text/html; charset=ISO-8859-1
	13	Content-Transfer-Encoding: 7bit
	14
	15	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
	16	<html>
	17	<head>
	18	</head>
	19	<body bgcolor="#ffffff" text="#000000">
	20	This is a <b>html-only</b> email.<br>
	21	</body>
	22	</html>

app/models/mail_handler.rb +21 -11

             # 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
                   issue.status = status
                 end
                 issue.subject = email.subject.chomp.toutf8
-                issue.description = email.plain_text_body.chomp
+                issue.description = plain_text_body
                 issue.save!
                 add_attachments(issue)
                 logger.info "MailHandler: issue ##{issue.id} created by #{user}" if logger && logger.info
                 raise UnauthorizedAction unless status.nil? || user.allowed_to?(:edit_issues, issue.project)
                 # add the note
-                journal = issue.init_journal(user, email.plain_text_body.chomp)
+                journal = issue.init_journal(user, plain_text_body)
                 add_attachments(issue)
                 # check workflow
                 if status && issue.new_statuses_allowed_to(user).include?(status)
               end
               def get_keyword(attr)
-                if @@handler_options[:allow_override].include?(attr.to_s) && email.plain_text_body =~ /^#{attr}:[ \t]*(.+)$/i
+                if @@handler_options[:allow_override].include?(attr.to_s) && plain_text_body =~ /^#{attr}:[ \t]*(.+)$/i
                   $1.strip
                 elsif !@@handler_options[:issue][attr].blank?
                   @@handler_options[:issue][attr]
                 end
               end
-            end
+              # Returns the text/plain part of the email
-            class TMail::Mail
+              # If not found (eg. HTML-only email), returns the body with tags removed
-              # 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
+                parts = @email.parts.collect {|c| (c.respond_to?(:parts) && !c.parts.empty?) ? c.parts : c}.flatten
-                plain = p.detect {|c| c.content_type == 'text/plain'}
+                if parts.empty?
-                @plain_text_body = plain.nil? ? self.body : plain.body
+                  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!
               end
             end

test/unit/mail_handler_test.rb +9 0

@@ -129,6 +129,15 class MailHandlerTest < Test::Unit::TestCase
129	assert_match /This is reply/, journal.notes	129	assert_match /This is reply/, journal.notes
130	assert_equal IssueStatus.find_by_name("Resolved"), issue.status	130	assert_equal IssueStatus.find_by_name("Resolved"), issue.status
131	end	131	end
		132
		133	def test_should_strip_tags_of_html_only_emails
		134	issue = submit_email('ticket_html_only.eml', :issue => {:project => 'ecookbook'})
		135	assert issue.is_a?(Issue)
		136	assert !issue.new_record?
		137	issue.reload
		138	assert_equal 'HTML email', issue.subject
		139	assert_equal 'This is a html-only email.', issue.description
		140	end
132		141
133	private	142	private
134		143

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