Mailer:

* added an application setting to specify the application protocol (http or https) used to generate urls
* added layouts for text and html emails
* no more language specific templates
* urls are now generated using UrlWriter
* the mailer now uses AdvAttrAccessor code style to set email parameters

git-svn-id: http://redmine.rubyforge.org/svn/trunk@877 e93f8b46-1217-0410-a6f0-8f06a7374b81

app/models/mailer.rb

@@ -20,99 +20,111 @@ class Mailer < ActionMailer::Base
   helper IssuesHelper
   helper CustomFieldsHelper
   
-  def account_information(user, password)
-    set_language_if_valid user.language
-    recipients user.mail
-    from Setting.mail_from
-    subject l(:mail_subject_register)
-    body :user => user, :password => password
-  end
-
-  def issue_add(issue)
-    set_language_if_valid(Setting.default_language)
-    @recipients     = issue.recipients
-    @from           = Setting.mail_from
-    @subject        = "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] #{issue.status.name} - #{issue.subject}"
-    @body['issue']  = issue
+  include ActionController::UrlWriter
+  
+  def issue_add(issue)    
+    recipients issue.recipients    
+    subject "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] #{issue.status.name} - #{issue.subject}"
+    body :issue => issue,
+         :issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue)
   end
 
   def issue_edit(journal)
-    set_language_if_valid(Setting.default_language)
     issue = journal.journalized
-    @recipients     = issue.recipients
+    recipients issue.recipients
     # Watchers in cc
-    @cc             = issue.watcher_recipients - @recipients
-    @from           = Setting.mail_from
-    @subject        = "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] #{issue.status.name} - #{issue.subject}"
-    @body['issue']  = issue
-    @body['journal']= journal
+    cc(issue.watcher_recipients - @recipients)
+    subject "[#{issue.project.name} - #{issue.tracker.name} ##{issue.id}] #{issue.status.name} - #{issue.subject}"
+    body :issue => issue,
+         :journal => journal,
+         :issue_url => url_for(:controller => 'issues', :action => 'show', :id => issue)
   end
   
   def document_added(document)
-    set_language_if_valid(Setting.default_language)
-    @recipients     = document.project.recipients
-    @from           = Setting.mail_from
-    @subject        = "[#{document.project.name}] #{l(:label_document_new)}: #{document.title}"
-    @body['document'] = document
+    recipients document.project.recipients
+    subject "[#{document.project.name}] #{l(:label_document_new)}: #{document.title}"
+    body :document => document,
+         :document_url => url_for(:controller => 'documents', :action => 'show', :id => document)
   end
   
   def attachments_added(attachments)
-    set_language_if_valid(Setting.default_language)
     container = attachments.first.container
-    url = ''
     added_to = ''
+    added_to_url = ''
     case container.class.name
     when 'Version'
-      url = {:only_path => false, :host => Setting.host_name, :controller => 'projects', :action => 'list_files', :id => container.project_id}
+      added_to_url = url_for(:controller => 'projects', :action => 'list_files', :id => container.project_id)
       added_to = "#{l(:label_version)}: #{container.name}"
     when 'Document'
-      url = {:only_path => false, :host => Setting.host_name, :controller => 'documents', :action => 'show', :id => container.id}
+      added_to_url = url_for(:controller => 'documents', :action => 'show', :id => container.id)
       added_to = "#{l(:label_document)}: #{container.title}"
     end
-    @recipients     = container.project.recipients
-    @from           = Setting.mail_from
-    @subject        = "[#{container.project.name}] #{l(:label_attachment_new)}"
-    @body['attachments'] = attachments
-    @body['url']    = url
-    @body['added_to'] = added_to
+    recipients container.project.recipients
+    subject "[#{container.project.name}] #{l(:label_attachment_new)}"
+    body :attachments => attachments,
+         :added_to => added_to,
+         :added_to_url => added_to_url
   end
 
   def news_added(news)
-    set_language_if_valid(Setting.default_language)
-    @recipients     = news.project.recipients
-    @from           = Setting.mail_from
-    @subject        = "[#{news.project.name}] #{l(:label_news)}: #{news.title}"
-    @body['news'] = news
+    recipients news.project.recipients
+    subject "[#{news.project.name}] #{l(:label_news)}: #{news.title}"
+    body :news => news,
+         :news_url => url_for(:controller => 'news', :action => 'show', :id => news)
   end
-  
+
+  def message_posted(message, recipients)
+    recipients(recipients)
+    subject "[#{message.board.project.name} - #{message.board.name}] #{message.subject}"
+    body :message => message,
+         :message_url => url_for(:controller => 'messages', :action => 'show', :board_id => message.board_id, :id => message.root)
+  end
+   
+  def account_information(user, password)
+    set_language_if_valid user.language
+    recipients user.mail
+    subject l(:mail_subject_register)
+    body :user => user,
+         :password => password,
+         :login_url => url_for(:controller => 'account', :action => 'login')
+  end
+
   def lost_password(token)
     set_language_if_valid(token.user.language)
-    @recipients     = token.user.mail
-    @from           = Setting.mail_from
-    @subject        = l(:mail_subject_lost_password)
-    @body['token']  = token
+    recipients token.user.mail
+    subject l(:mail_subject_lost_password)
+    body :token => token,
+         :url => url_for(:controller => 'account', :action => 'lost_password', :token => token.value)
   end  
 
   def register(token)
     set_language_if_valid(token.user.language)
-    @recipients     = token.user.mail
-    @from           = Setting.mail_from
-    @subject        = l(:mail_subject_register)
-    @body['token']  = token
-  end
-  
-  def message_posted(message, recipients)
-    set_language_if_valid(Setting.default_language)
-    @recipients     = recipients
-    @from           = Setting.mail_from
-    @subject        = "[#{message.board.project.name} - #{message.board.name}] #{message.subject}"
-    @body['message'] = message
+    recipients token.user.mail
+    subject l(:mail_subject_register)
+    body :token => token,
+         :url => url_for(:controller => 'account', :action => 'register', :token => token.value)
   end
   
   def test(user)
     set_language_if_valid(user.language)
-    @recipients     = user.mail
-    @from           = Setting.mail_from
-    @subject        = 'Redmine'
+    recipients user.mail
+    subject 'Redmine test'
+    body :url => url_for(:controller => 'welcome')
+  end
+  
+  private
+  def initialize_defaults(method_name)
+    super
+    set_language_if_valid Setting.default_language
+    from Setting.mail_from
+    default_url_options[:host] = Setting.host_name
+    default_url_options[:protocol] = Setting.protocol
+  end
+  
+  # Renders a message with the corresponding layout
+  def render_message(method_name, body)
+    layout = method_name.match(%r{text\.html\.(rhtml|rxml)}) ? 'layout.text.html.rhtml' : 'layout.text.plain.rhtml'
+    body[:content_for_layout] = render(:file => method_name, :body => body)
+    ActionView::Base.new(File.join(template_root, 'mailer'), body, self).render(:file => layout)
   end
 end

app/views/mailer/_issue_text_html.rhtml

@@ -1,5 +1,4 @@
-<%= link_to "#{issue.tracker.name} ##{issue.id}",  :only_path => false, :host => Setting.host_name, :controller => 'issues', :action => 'show', :id => issue %>:
-<%= issue.subject %>
+<h1><%= link_to "#{issue.tracker.name} ##{issue.id}: #{issue.subject}", issue_url %></h1>
 
 <ul>
 <li><%=l(:field_author)%>: <%= issue.author %></li>

app/views/mailer/_issue_text_plain.rhtml

@@ -1,5 +1,5 @@
 <%= "#{issue.tracker.name} ##{issue.id}: #{issue.subject}" %>
-<%= url_for :only_path => false, :host => Setting.host_name, :controller => 'issues', :action => 'show', :id => issue %>
+<%= issue_url %>
 
 <%=l(:field_author)%>: <%= issue.author %>
 <%=l(:field_status)%>: <%= issue.status %>

app/views/mailer/account_information.rhtml

@@ -1,12 +0,0 @@
-<% if @user.auth_source %>You can use your "<%= @user.auth_source.name %>" account to log into Redmine.
-<% else %>Your Redmine account information:
-* Login:    <%= @user.login %>
-* Password: <%= @password %>
-<% end %>
-Log in: <%= url_for :only_path => false, :host => Setting.host_name, :controller => 'account', :action => 'login' %>
-<% unless @user.auth_source %>
-You can change your password here: <%= url_for :only_path => false, :host => Setting.host_name, :controller => 'my', :action => 'account' %>
-<% end %>
-
-----------------------------------------
-<%= Setting.emails_footer %>

app/views/mailer/account_information.text.html.rhtml

@@ -0,0 +1,11 @@
+<% if @user.auth_source %>
+<p><%= l(:mail_body_account_information_external, @user.auth_source.name) %></p>
+<% else %>
+<p><%= l(:mail_body_account_information) %>:</p>
+<ul>
+    <li><%= l(:field_login) %>: <%= @user.login %></li>
+    <li><%= l(:field_password) %>: <%= @password %></li>
+</ul>
+<% end %>
+
+<p><%= l(:label_login) %>: <%= auto_link(@login_url) %></p>

app/views/mailer/account_information.text.plain.rhtml

@@ -0,0 +1,6 @@
+<% if @user.auth_source %><%= l(:mail_body_account_information_external, @user.auth_source.name) %>
+<% else %><%= l(:mail_body_account_information) %>:
+* <%= l(:field_login) %>: <%= @user.login %>
+* <%= l(:field_password) %>: <%= @password %>
+<% end %>
+<%= l(:label_login) %>: <%= @login_url %>

app/views/mailer/account_information_fr.rhtml

@@ -1,12 +0,0 @@
-<% if @user.auth_source %>Vous pouvez utiliser votre compte "<%= @user.auth_source.name %>" pour vous connecter à Redmine.
-<% else %>Paramètres de connexion de votre compte Redmine:
-* Identifiant:  <%= @user.login %>
-* Mot de passe: <%= @password %>
-<% end %>
-Pour se connecter à l'application: <%= url_for :only_path => false, :host => Setting.host_name, :controller => 'account', :action => 'login' %>
-<% unless @user.auth_source %>
-Vous pouvez changer votre mot de passe à l'adresse: <%= url_for :only_path => false, :host => Setting.host_name, :controller => 'my', :action => 'account' %>
-<% end %>
-
-----------------------------------------
-<%= Setting.emails_footer %>

app/views/mailer/account_information_pl.rhtml

@@ -1,12 +0,0 @@
-<% if @user.auth_source %>Możesz użyć twojego "<%= @user.auth_source.name %>" konta do zalogowania do Redmine.
-<% else %>Twoje konto w Redmine:
-* Login:    <%= @user.login %>
-* Hasło: <%= @password %>
-<% end %>
-Zaloguj: <%= url_for :only_path => false, :host => Setting.host_name, :controller => 'account', :action => 'login' %>
-<% unless @user.auth_source %>
-Możesz zmienić swoje hasło tutaj: <%= url_for :only_path => false, :host => Setting.host_name, :controller => 'my', :action => 'account' %>
-<% end %>
-
-----------------------------------------
-<%= Setting.emails_footer %>

app/views/mailer/account_information_sr.rhtml

@@ -1,9 +0,0 @@
-<% if @user.auth_source %>Mozete koristiti vas "<%= @user.auth_source.name %>" nalog da bi ste se prikljucili na Redmine.
-<% else %>Informacije o vasem Redmine nalogu:
-* Login:    <%= @user.login %>
-* Password: <%= @password %>
-<% end %>
-Log in: <%= url_for :only_path => false, :host => Setting.host_name, :controller => 'account', :action => 'login' %>
-<% unless @user.auth_source %>
-Ovde mozete izmeniti svoju lozinku: <%= url_for :only_path => false, :host => Setting.host_name, :controller => 'my', :action => 'account' %>
-<% end %>

app/views/mailer/attachments_added.text.html.rhtml

@@ -1,7 +1,5 @@
-<%= link_to @added_to, @url %><br />
+<%= link_to @added_to, @added_to_url %><br />
 
 <ul><% @attachments.each do |attachment | %>
 <li><%= attachment.filename %></li>
 <% end %></ul>
-<hr />
-<small><em><%= textilizable Setting.emails_footer %></em></small>

app/views/mailer/attachments_added.text.plain.rhtml

@@ -1,6 +1,4 @@
 <%= @added_to %><% @attachments.each do |attachment | %>
 - <%= attachment.filename %><% end %>
 
-<%= url_for @url %>
-----------------------------------------
-<%= Setting.emails_footer %>
+<%= @added_to_url %>

app/views/mailer/document_added.text.html.rhtml

@@ -1,6 +1,3 @@
-<%= link_to @document.title, :only_path => false, :host => Setting.host_name, :controller => 'documents', :action => 'show', :id => @document %>
-(<%= @document.category.name %>)<br />
+<%= link_to @document.title, @document_url %> (<%= @document.category.name %>)<br />
 <br />
 <%= textilizable(@document.description) %>
-<hr />
-<small><em><%= textilizable Setting.emails_footer %></em></small>

app/views/mailer/document_added.text.plain.rhtml

@@ -1,6 +1,4 @@
 <%= @document.title %> (<%= @document.category.name %>)
-<%= url_for :only_path => false, :host => Setting.host_name, :controller => 'documents', :action => 'show', :id => @document %>
+<%= @document_url %>
 
 <%= @document.description %>
-----------------------------------------
-<%= Setting.emails_footer %>

app/views/mailer/issue_add.text.html.rhtml

@@ -1,5 +1,3 @@
 <%= l(:text_issue_added, "##{@issue.id}") %>
 <hr />
-<%= render :file => "_issue_text_html", :use_full_path => true, :locals => { :issue => @issue } %>
-<hr />
-<small><em><%= textilizable Setting.emails_footer %></em></small>
+<%= render :file => "_issue_text_html", :use_full_path => true, :locals => { :issue => @issue, :issue_url => @issue_url } %>

app/views/mailer/issue_add.text.plain.rhtml

@@ -1,5 +1,3 @@
 <%= l(:text_issue_added, "##{@issue.id}") %>
 ----------------------------------------
-<%= render :file => "_issue_text_plain", :use_full_path => true, :locals => { :issue => @issue } %>
-----------------------------------------
-<%= Setting.emails_footer %>
+<%= render :file => "_issue_text_plain", :use_full_path => true, :locals => { :issue => @issue, :issue_url => @issue_url } %>

app/views/mailer/issue_edit.text.html.rhtml

@@ -7,6 +7,4 @@
 </ul>
 <%= textilizable(@journal.notes) %>
 <hr />
-<%= render :file => "_issue_text_html", :use_full_path => true, :locals => { :issue => @issue } %>
-<hr />
-<small><em><%= textilizable Setting.emails_footer %></em></small>
+<%= render :file => "_issue_text_html", :use_full_path => true, :locals => { :issue => @issue, :issue_url => @issue_url } %>

app/views/mailer/issue_edit.text.plain.rhtml

@@ -5,6 +5,4 @@
 <% end %>
 <%= @journal.notes if @journal.notes? %>
 ----------------------------------------
-<%= render :file => "_issue_text_plain", :use_full_path => true, :locals => { :issue => @issue } %>
-----------------------------------------
-<%= Setting.emails_footer %>
+<%= render :file => "_issue_text_plain", :use_full_path => true, :locals => { :issue => @issue, :issue_url => @issue_url } %>

app/views/mailer/layout.text.html.rhtml

@@ -0,0 +1,17 @@
+<html>
+<head>
+<style>
+body { font-family: Verdana, sans-serif; font-size: 0.8em; color:#484848; }
+body h1 { font-family: "Trebuchet MS", Verdana, sans-serif; font-size: 1.2em; margin: 0;}
+a, a:link, a:visited{ color: #2A5685; }
+a:hover, a:active{ color: #c61a1a; }
+hr { width: 100%; height: 1px; background: #ccc; border: 0; }
+.footer { font-size: 0.8em; font-style: italic; }
+</style>
+</head>
+<body>
+<%= yield %>
+<hr />
+<span class="footer"><%= Redmine::WikiFormatting.to_html(Setting.emails_footer) %></span>
+</body>
+</html>

app/views/mailer/layout.text.plain.rhtml

@@ -0,0 +1,3 @@
+<%= yield %>
+----------------------------------------
+<%= Setting.emails_footer %>

app/views/mailer/lost_password.rhtml

@@ -1,5 +0,0 @@
-<%= l(:mail_body_lost_password) %>
-<%= url_for :only_path => false, :host => Setting.host_name, :controller => 'account', :action => 'lost_password', :token => @token.value %>
-
-----------------------------------------
-<%= Setting.emails_footer %>

app/views/mailer/lost_password.text.html.rhtml

@@ -0,0 +1,2 @@
+<p><%= l(:mail_body_lost_password) %><br />
+<%= auto_link(@url) %></p>

app/views/mailer/lost_password.text.plain.rhtml

@@ -0,0 +1,2 @@
+<%= l(:mail_body_lost_password) %>
+<%= @url %>

app/views/mailer/message_posted.text.html.rhtml

@@ -1,6 +1,4 @@
-<%=h @message.board.project.name %> - <%=h @message.board.name %>: <%= link_to @message.subject, :only_path => false, :host => Setting.host_name, :controller => 'messages', :action => 'show', :board_id => @message.board_id, :id => @message.root %><br />
+<h1><%=h @message.board.project.name %> - <%=h @message.board.name %>: <%= link_to @message.subject, @message_url %></h1>
 <em><%= @message.author.name %></em>
 
 <%= textilizable @message.content %>
-<hr />
-<small><em><%= textilizable Setting.emails_footer %></em></small>

app/views/mailer/message_posted.text.plain.rhtml

@@ -1,6 +1,4 @@
-<%= url_for :only_path => false, :host => Setting.host_name, :controller => 'messages', :action => 'show', :board_id => @message.board_id, :id => @message.root %>
+<%= @message_url %>
 <%= @message.author.name %>
 
 <%= @message.content %>
-----------------------------------------
-<%= Setting.emails_footer %>

app/views/mailer/news_added.text.html.rhtml

@@ -1,6 +1,4 @@
-<%= link_to @news.title, :only_path => false, :host => Setting.host_name, :controller => 'news', :action => 'show', :id => @news %><br />
+<h1><%= link_to @news.title, @news_url %></h1>
 <em><%= @news.author.name %></em>
 
 <%= textilizable(@news.description) %>
-<hr />
-<small><em><%= textilizable Setting.emails_footer %></em></small>

app/views/mailer/news_added.text.plain.rhtml

@@ -1,7 +1,5 @@
 <%= @news.title %>
-<%= url_for :only_path => false, :host => Setting.host_name, :controller => 'news', :action => 'show', :id => @news %>
+<%= @news_url %>
 <%= @news.author.name %>
 
 <%= @news.description %>
-----------------------------------------
-<%= Setting.emails_footer %>

app/views/mailer/register.rhtml

@@ -1,5 +0,0 @@
-<%= l(:mail_body_register) %>
-<%= url_for :only_path => false, :host => Setting.host_name, :controller => 'account', :action => 'register', :token => @token.value %>
-
-----------------------------------------
-<%= Setting.emails_footer %>

app/views/mailer/register.text.html.rhtml

@@ -0,0 +1,2 @@
+<p><%= l(:mail_body_register) %><br />
+<%= auto_link(@url) %></p>

app/views/mailer/register.text.plain.rhtml

@@ -0,0 +1,2 @@
+<%= l(:mail_body_register) %>
+<%= @url %>

app/views/mailer/test.text.html.rhtml

@@ -1,5 +1,2 @@
 <p>This is a test email sent by Redmine.<br />
-Redmine URL: <%= link_to url_for(:only_path => false, :host => Setting.host_name, :controller => 'welcome'),
-                         url_for(:only_path => false, :host => Setting.host_name, :controller => 'welcome') %></p>
-<hr />
-<small><em><%= textilizable Setting.emails_footer %></em></small>
+Redmine URL: <%= auto_link(@url) %></p>

app/views/mailer/test.text.plain.rhtml

@@ -1,5 +1,2 @@
 This is a test email sent by Redmine.
-Redmine URL: <%= url_for :only_path => false, :host => Setting.host_name, :controller => 'welcome' %>
-
-----------------------------------------
-<%= Setting.emails_footer %>
+Redmine URL: <%= @url %>

app/views/settings/edit.rhtml

@@ -37,6 +37,9 @@
 <p><label><%= l(:setting_host_name) %></label>
 <%= text_field_tag 'settings[host_name]', Setting.host_name, :size => 60 %></p>
 
+<p><label><%= l(:setting_protocol) %></label>
+<%= select_tag 'settings[protocol]', options_for_select(['http', 'https'], Setting.protocol) %></p>
+
 <p><label><%= l(:setting_text_formatting) %></label>
 <%= select_tag 'settings[text_formatting]', options_for_select([[l(:label_none), "0"], ["textile", "textile"]], Setting.text_formatting) %></p>
 
@@ -91,4 +94,4 @@
 
 <%= submit_tag l(:button_save) %>
 </div>
-<% end %>
+<% end %>