mail_handler.rb
437 lines
| 15.5 KiB
| text/x-ruby
|
RubyLexer
|
r5590 | # Redmine - project management software | ||
# Copyright (C) 2006-2011 Jean-Philippe Lang | ||||
|
r520 | # | ||
# 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. | ||||
|
r5695 | # | ||
|
r520 | # 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. | ||||
|
r5695 | # | ||
|
r520 | # 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 | ||||
|
r2134 | include ActionView::Helpers::SanitizeHelper | ||
|
r4281 | include Redmine::I18n | ||
|
r1554 | |||
class UnauthorizedAction < StandardError; end | ||||
class MissingInformation < StandardError; end | ||||
|
r5590 | |||
|
r1554 | attr_reader :email, :user | ||
def self.receive(email, options={}) | ||||
|
r1629 | @@handler_options = options.dup | ||
|
r5590 | |||
|
r1629 | @@handler_options[:issue] ||= {} | ||
|
r5590 | |||
|
r8625 | if @@handler_options[:allow_override].is_a?(String) | ||
@@handler_options[:allow_override] = @@handler_options[:allow_override].split(',').collect(&:strip) | ||||
end | ||||
|
r1629 | @@handler_options[:allow_override] ||= [] | ||
# Project needs to be overridable if not specified | ||||
@@handler_options[:allow_override] << 'project' unless @@handler_options[:issue].has_key?(:project) | ||||
|
r2072 | # Status overridable by default | ||
|
r5590 | @@handler_options[:allow_override] << 'status' unless @@handler_options[:issue].has_key?(:status) | ||
|
r3081 | @@handler_options[:no_permission_check] = (@@handler_options[:no_permission_check].to_s == '1' ? true : false) | ||
|
r1554 | super email | ||
end | ||||
|
r5590 | |||
|
r520 | # Processes incoming emails | ||
|
r2689 | # Returns the created object (eg. an issue, a message) or false | ||
|
r520 | def receive(email) | ||
|
r1554 | @email = email | ||
|
r2908 | 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 | ||||
|
r8625 | if logger && logger.info | ||
logger.info "MailHandler: ignoring email from Redmine emission address [#{sender_email}]" | ||||
end | ||||
|
r2908 | return false | ||
end | ||||
|
r9224 | # Ignore out-of-office emails | ||
if email.header_string("X-Auto-Response-Suppress") == 'OOF' | ||||
if logger && logger.info | ||||
logger.info "MailHandler: ignoring out-of-office email" | ||||
end | ||||
return false | ||||
end | ||||
|
r3669 | @user = User.find_by_mail(sender_email) if sender_email.present? | ||
|
r2689 | if @user && !@user.active? | ||
|
r8625 | if logger && logger.info | ||
logger.info "MailHandler: ignoring email from non-active user [#{@user.login}]" | ||||
end | ||||
|
r1554 | return false | ||
end | ||||
|
r2689 | if @user.nil? | ||
# Email was submitted by an unknown user | ||||
case @@handler_options[:unknown_user] | ||||
when 'accept' | ||||
@user = User.anonymous | ||||
when 'create' | ||||
|
r8401 | @user = create_user_from_email | ||
|
r2689 | if @user | ||
|
r8625 | if logger && logger.info | ||
logger.info "MailHandler: [#{@user.login}] account created" | ||||
end | ||||
|
r2689 | Mailer.deliver_account_information(@user, @user.password) | ||
else | ||||
|
r8625 | if logger && logger.error | ||
logger.error "MailHandler: could not create account for [#{sender_email}]" | ||||
end | ||||
|
r2689 | return false | ||
end | ||||
else | ||||
# Default behaviour, emails from unknown users are ignored | ||||
|
r8625 | if logger && logger.info | ||
logger.info "MailHandler: ignoring email from unknown user [#{sender_email}]" | ||||
end | ||||
|
r2689 | return false | ||
end | ||||
end | ||||
|
r1554 | User.current = @user | ||
dispatch | ||||
end | ||||
|
r5590 | |||
|
r1554 | private | ||
|
r2286 | MESSAGE_ID_RE = %r{^<redmine\.([a-z0-9_]+)\-(\d+)\.\d+@} | ||
|
r2917 | ISSUE_REPLY_SUBJECT_RE = %r{\[[^\]]*#(\d+)\]} | ||
MESSAGE_REPLY_SUBJECT_RE = %r{\[[^\]]*msg(\d+)\]} | ||||
|
r5590 | |||
|
r1554 | def dispatch | ||
|
r2286 | 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" | ||||
|
r2801 | if self.class.private_instance_methods.collect(&:to_s).include?(method_name) | ||
|
r2286 | 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) | ||||
|
r2292 | elsif m = email.subject.match(MESSAGE_REPLY_SUBJECT_RE) | ||
receive_message_reply(m[1].to_i) | ||||
|
r1554 | else | ||
|
r4700 | dispatch_to_default | ||
|
r1554 | 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 | ||||
|
r4700 | |||
def dispatch_to_default | ||||
receive_issue | ||||
end | ||||
|
r5590 | |||
|
r1554 | # Creates a new issue | ||
def receive_issue | ||||
project = target_project | ||||
# check permission | ||||
|
r3081 | unless @@handler_options[:no_permission_check] | ||
raise UnauthorizedAction unless user.allowed_to?(:add_issues, project) | ||||
end | ||||
|
r3649 | |||
|
r4280 | 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] | ||||
|
r2759 | if issue.subject.blank? | ||
issue.subject = '(no subject)' | ||||
end | ||||
|
r3112 | issue.description = cleaned_up_text_body | ||
|
r5590 | |||
|
r2548 | # add To and Cc as watchers before saving so the watchers can reply to Redmine | ||
add_watchers(issue) | ||||
|
r1554 | issue.save! | ||
add_attachments(issue) | ||||
logger.info "MailHandler: issue ##{issue.id} created by #{user}" if logger && logger.info | ||||
issue | ||||
end | ||||
|
r5590 | |||
|
r1554 | # Adds a note to an existing issue | ||
|
r2286 | def receive_issue_reply(issue_id) | ||
|
r1554 | issue = Issue.find_by_id(issue_id) | ||
|
r520 | return unless issue | ||
# check permission | ||||
|
r3081 | unless @@handler_options[:no_permission_check] | ||
|
r8625 | unless user.allowed_to?(:add_issue_notes, issue.project) || | ||
user.allowed_to?(:edit_issues, issue.project) | ||||
raise UnauthorizedAction | ||||
end | ||||
|
r3081 | end | ||
|
r5590 | |||
|
r4462 | # ignore CLI-supplied defaults for new issues | ||
@@handler_options[:issue].clear | ||||
|
r5590 | |||
|
r4985 | journal = issue.init_journal(user) | ||
|
r4280 | issue.safe_attributes = issue_attributes_from_keywords(issue) | ||
issue.safe_attributes = {'custom_field_values' => custom_field_values_from_keywords(issue)} | ||||
|
r4985 | journal.notes = cleaned_up_text_body | ||
|
r1556 | add_attachments(issue) | ||
|
r1554 | issue.save! | ||
|
r8625 | if logger && logger.info | ||
logger.info "MailHandler: issue ##{issue.id} updated by #{user}" | ||||
end | ||||
|
r1554 | journal | ||
end | ||||
|
r5590 | |||
|
r2286 | # 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 | ||||
|
r5590 | |||
|
r2287 | # 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 | ||||
|
r5590 | |||
|
r3081 | unless @@handler_options[:no_permission_check] | ||
raise UnauthorizedAction unless user.allowed_to?(:add_messages, message.project) | ||||
end | ||||
|
r5590 | |||
|
r3081 | if !message.locked? | ||
|
r2292 | reply = Message.new(:subject => email.subject.gsub(%r{^.*msg\d+\]}, '').strip, | ||
|
r3112 | :content => cleaned_up_text_body) | ||
|
r2287 | reply.author = user | ||
reply.board = message.board | ||||
message.children << reply | ||||
add_attachments(reply) | ||||
reply | ||||
else | ||||
|
r8625 | if logger && logger.info | ||
logger.info "MailHandler: ignoring reply from [#{sender_email}] to a locked topic" | ||||
end | ||||
|
r2287 | end | ||
end | ||||
end | ||||
|
r5590 | |||
|
r1554 | def add_attachments(obj) | ||
|
r6205 | if email.attachments && email.attachments.any? | ||
|
r1554 | email.attachments.each do |attachment| | ||
|
r6192 | obj.attachments << Attachment.create(:container => obj, | ||
|
r1554 | :file => attachment, | ||
:author => user, | ||||
:content_type => attachment.content_type) | ||||
end | ||||
end | ||||
|
r520 | end | ||
|
r5590 | |||
|
r2075 | # 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? | ||||
|
r2077 | watchers = User.active.find(:all, :conditions => ['LOWER(mail) IN (?)', addresses]) | ||
|
r2075 | watchers.each {|w| obj.add_watcher(w)} | ||
end | ||||
end | ||||
end | ||||
|
r5590 | |||
|
r2209 | def get_keyword(attr, options={}) | ||
|
r2365 | @keywords ||= {} | ||
if @keywords.has_key?(attr) | ||||
@keywords[attr] | ||||
else | ||||
@keywords[attr] = begin | ||||
|
r8624 | if (options[:override] || @@handler_options[:allow_override].include?(attr.to_s)) && | ||
(v = extract_keyword!(plain_text_body, attr, options[:format])) | ||||
|
r4281 | v | ||
|
r2365 | elsif !@@handler_options[:issue][attr].blank? | ||
@@handler_options[:issue][attr] | ||||
end | ||||
end | ||||
|
r1629 | end | ||
end | ||||
|
r5590 | |||
|
r4281 | # Destructively extracts the value for +attr+ in +text+ | ||
# Returns nil if no matching keyword found | ||||
|
r4282 | def extract_keyword!(text, attr, format=nil) | ||
|
r4281 | keys = [attr.to_s.humanize] | ||
if attr.is_a?(Symbol) | ||||
|
r8625 | if user && user.language.present? | ||
keys << l("field_#{attr}", :default => '', :locale => user.language) | ||||
end | ||||
if Setting.default_language.present? | ||||
keys << l("field_#{attr}", :default => '', :locale => Setting.default_language) | ||||
end | ||||
|
r4281 | end | ||
keys.reject! {|k| k.blank?} | ||||
keys.collect! {|k| Regexp.escape(k)} | ||||
|
r4282 | format ||= '.+' | ||
text.gsub!(/^(#{keys.join('|')})[ \t]*:[ \t]*(#{format})\s*$/i, '') | ||||
|
r4281 | $2 && $2.strip | ||
end | ||||
|
r4280 | |||
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 | ||||
|
r5590 | |||
|
r4280 | # Returns a Hash of issue attributes extracted from keywords in the email body | ||
def issue_attributes_from_keywords(issue) | ||||
|
r6186 | assigned_to = (k = get_keyword(:assigned_to, :override => true)) && find_assignee_from_keyword(k, issue) | ||
|
r5590 | |||
|
r4461 | attrs = { | ||
|
r6079 | 'tracker_id' => (k = get_keyword(:tracker)) && issue.project.trackers.named(k).first.try(:id), | ||
'status_id' => (k = get_keyword(:status)) && IssueStatus.named(k).first.try(:id), | ||||
'priority_id' => (k = get_keyword(:priority)) && IssuePriority.named(k).first.try(:id), | ||||
'category_id' => (k = get_keyword(:category)) && issue.project.issue_categories.named(k).first.try(:id), | ||||
|
r4290 | 'assigned_to_id' => assigned_to.try(:id), | ||
|
r8624 | 'fixed_version_id' => (k = get_keyword(:fixed_version, :override => true)) && | ||
issue.project.shared_versions.named(k).first.try(:id), | ||||
|
r4282 | 'start_date' => get_keyword(:start_date, :override => true, :format => '\d{4}-\d{2}-\d{2}'), | ||
'due_date' => get_keyword(:due_date, :override => true, :format => '\d{4}-\d{2}-\d{2}'), | ||||
|
r4280 | 'estimated_hours' => get_keyword(:estimated_hours, :override => true), | ||
|
r4282 | 'done_ratio' => get_keyword(:done_ratio, :override => true, :format => '(\d|10)?0') | ||
|
r4280 | }.delete_if {|k, v| v.blank? } | ||
|
r5590 | |||
|
r4461 | if issue.new_record? && attrs['tracker_id'].nil? | ||
attrs['tracker_id'] = issue.project.trackers.find(:first).try(:id) | ||||
end | ||||
|
r5590 | |||
|
r4461 | attrs | ||
|
r4280 | end | ||
|
r5590 | |||
|
r4280 | # Returns a Hash of issue custom field values extracted from keywords in the email body | ||
|
r5590 | def custom_field_values_from_keywords(customized) | ||
|
r4280 | 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 | ||||
|
r5590 | |||
|
r2134 | # Returns the text/plain part of the email | ||
# If not found (eg. HTML-only email), returns the body with tags removed | ||||
|
r1554 | def plain_text_body | ||
return @plain_text_body unless @plain_text_body.nil? | ||||
|
r2134 | 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! | ||||
|
r2456 | @plain_text_body | ||
|
r1554 | end | ||
|
r5590 | |||
|
r3112 | def cleaned_up_text_body | ||
cleanup_body(plain_text_body) | ||||
end | ||||
|
r2430 | |||
def self.full_sanitizer | ||||
@full_sanitizer ||= HTML::FullSanitizer.new | ||||
end | ||||
|
r5590 | |||
|
r8658 | def self.assign_string_attribute_with_limit(object, attribute, value, limit=nil) | ||
limit ||= object.class.columns_hash[attribute.to_s].limit || 255 | ||||
|
r7832 | value = value.to_s.slice(0, limit) | ||
object.send("#{attribute}=", value) | ||||
end | ||||
# Returns a User from an email address and a full name | ||||
def self.new_user_from_attributes(email_address, fullname=nil) | ||||
user = User.new | ||||
# Truncating the email address would result in an invalid format | ||||
user.mail = email_address | ||||
|
r8658 | assign_string_attribute_with_limit(user, 'login', email_address, User::LOGIN_LENGTH_LIMIT) | ||
|
r7832 | |||
names = fullname.blank? ? email_address.gsub(/@.*$/, '').split('.') : fullname.split | ||||
assign_string_attribute_with_limit(user, 'firstname', names.shift) | ||||
assign_string_attribute_with_limit(user, 'lastname', names.join(' ')) | ||||
user.lastname = '-' if user.lastname.blank? | ||||
password_length = [Setting.password_min_length.to_i, 10].max | ||||
|
r8951 | user.password = Redmine::Utils.random_hex(password_length / 2 + 1) | ||
|
r7832 | user.language = Setting.default_language | ||
unless user.valid? | ||||
|
r8951 | user.login = "user#{Redmine::Utils.random_hex(6)}" unless user.errors[:login].blank? | ||
|
r8400 | user.firstname = "-" unless user.errors[:firstname].blank? | ||
user.lastname = "-" unless user.errors[:lastname].blank? | ||||
|
r7832 | end | ||
user | ||||
end | ||||
# Creates a User for the +email+ sender | ||||
# Returns the user or nil if it could not be created | ||||
|
r8401 | def create_user_from_email | ||
|
r2689 | addr = email.from_addrs.to_a.first | ||
if addr && !addr.spec.blank? | ||||
|
r8923 | user = self.class.new_user_from_attributes(addr.spec, TMail::Unquoter.unquote_and_convert_to(addr.name, 'utf-8')) | ||
|
r7832 | if user.save | ||
user | ||||
else | ||||
logger.error "MailHandler: failed to create User: #{user.errors.full_messages}" if logger | ||||
nil | ||||
end | ||||
else | ||||
logger.error "MailHandler: failed to create User: no FROM address found" if logger | ||||
nil | ||||
|
r2689 | end | ||
end | ||||
|
r3112 | |||
# 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? | ||||
|
r4247 | regex = Regexp.new("^[> ]*(#{ delimiters.join('|') })\s*[\r\n].*", Regexp::MULTILINE) | ||
|
r3112 | body = body.gsub(regex, '') | ||
end | ||||
body.strip | ||||
end | ||||
|
r6757 | |||
|
r6186 | def find_assignee_from_keyword(keyword, issue) | ||
keyword = keyword.to_s.downcase | ||||
assignable = issue.assignable_users | ||||
assignee = nil | ||||
|
r8625 | assignee ||= assignable.detect {|a| | ||
a.mail.to_s.downcase == keyword || | ||||
a.login.to_s.downcase == keyword | ||||
} | ||||
|
r6186 | if assignee.nil? && keyword.match(/ /) | ||
|
r3650 | firstname, lastname = *(keyword.split) # "First Last Throwaway" | ||
|
r8625 | assignee ||= assignable.detect {|a| | ||
a.is_a?(User) && a.firstname.to_s.downcase == firstname && | ||||
a.lastname.to_s.downcase == lastname | ||||
} | ||||
|
r6186 | end | ||
if assignee.nil? | ||||
assignee ||= assignable.detect {|a| a.is_a?(Group) && a.name.downcase == keyword} | ||||
|
r3650 | end | ||
|
r6186 | assignee | ||
|
r3650 | end | ||
|
r1554 | end | ||