Avoid using raw in html mailer views

Use the _html suffix to mark that we expect the translations to contain links.

Unfortunately, we can't use the _html keys for the plain text emails, since the input options (e.g. username, url) will be html-escaped,
before it is passed to the view. So we need to use non-html-suffix keys for the plaintext views, in most cases. Only when the translation
options (e.g. url) are guaranteed to not contain any escapable characters can the same translation key be shared.

diff --git a/app/views/user_mailer/changeset_comment_notification.html.erb b/app/views/user_mailer/changeset_comment_notification.html.erb
index 85cd87e5e093f1142647323922f10b3665a543ac..95c5cdc5bc3f718b6106f45f544b7bf23a998ab6 100644 (file)
--- a/app/views/user_mailer/changeset_comment_notification.html.erb
+++ b/app/views/user_mailer/changeset_comment_notification.html.erb
@@ -3,12 +3,12 @@
 </p>
 <p>
   <% if @owner %>
-    <%= raw t ".commented.your_changeset", :commenter => link_to_user(@commenter), :time => @time %>
+    <%= t ".commented.your_changeset_html", :commenter => link_to_user(@commenter), :time => @time %>
   <% else %>
-    <%= raw t ".commented.commented_changeset", :commenter => link_to_user(@commenter), :time => @time, :changeset_author => @changeset_author %>
+    <%= t ".commented.commented_changeset_html", :commenter => link_to_user(@commenter), :time => @time, :changeset_author => @changeset_author %>
   <% end %>
   <% if @changeset_comment %>
-    <%= raw t ".commented.partial_changeset_with_comment", :changeset_comment => tag.em(@changeset_comment) %>
+    <%= t ".commented.partial_changeset_with_comment_html", :changeset_comment => tag.em(@changeset_comment) %>
   <% else %>
     <%= t ".commented.partial_changeset_without_comment" %>
   <% end %>
@@ -19,11 +19,11 @@
 <% end %>
 
 <p>
-  <%= raw t ".details", :url => link_to(@changeset_url, @changeset_url) %>
+  <%= t ".details_html", :url => link_to(@changeset_url, @changeset_url) %>
 </p>
 
 <% content_for :footer do %>
   <p>
-    <%= raw t ".unsubscribe", :url => link_to(@changeset_url, @changeset_url, :style => "color: #222") %>
+    <%= t ".unsubscribe_html", :url => link_to(@changeset_url, @changeset_url, :style => "color: #222") %>
   </p>
 <% end %>

diff --git a/app/views/user_mailer/diary_comment_notification.html.erb b/app/views/user_mailer/diary_comment_notification.html.erb
index abf92509fbf59ff9015785337a845c650419da3a..b4efae83bd7aa15ed1cda0421fe68b85ff87e431 100644 (file)
--- a/app/views/user_mailer/diary_comment_notification.html.erb
+++ b/app/views/user_mailer/diary_comment_notification.html.erb
@@ -2,7 +2,7 @@
   <%= t ".hi", :to_user => @to_user %>
 </p>
 <p>
-  <%= raw t ".header", :from_user => link_to_user(@from_user), :subject => tag.em(@title) %>
+  <%= t ".header_html", :from_user => link_to_user(@from_user), :subject => tag.em(@title) %>
 </p>
 
 <%= message_body do %>
@@ -10,9 +10,9 @@
 <% end %>
 
 <% content_for :footer do %>
-  <p><%= raw t ".footer",
-               :readurl => link_to(@readurl, @readurl) + tag(:br),
-               :commenturl => link_to(@commenturl, @commenturl) + tag(:br),
-               :replyurl => link_to(@replyurl, @replyurl) %>
+  <p><%= t ".footer_html",
+           :readurl => link_to(@readurl, @readurl) + tag(:br),
+           :commenturl => link_to(@commenturl, @commenturl) + tag(:br),
+           :replyurl => link_to(@replyurl, @replyurl) %>
   </p>
 <% end %>

diff --git a/app/views/user_mailer/friendship_notification.html.erb b/app/views/user_mailer/friendship_notification.html.erb
index 24587a6e3a42c308a0472efaf9f1389c31b5031f..0f2353150b15d37ca0d6b0b47d806b339b0d9b09 100644 (file)
--- a/app/views/user_mailer/friendship_notification.html.erb
+++ b/app/views/user_mailer/friendship_notification.html.erb
@@ -1,9 +1,9 @@
 <p><%= t ".had_added_you", :user => @friendship.befriender.display_name %></p>
 
 <%= message_body do %>
-  <p><%= raw t ".see_their_profile", :userurl => link_to(@viewurl, @viewurl) %></p>
+  <p><%= t ".see_their_profile_html", :userurl => link_to(@viewurl, @viewurl) %></p>
 
   <% unless @friendship.befriendee.is_friends_with?(@friendship.befriender) -%>
-  <p><%= raw t ".befriend_them", :befriendurl => link_to(@friendurl, @friendurl) %></p>
+  <p><%= t ".befriend_them_html", :befriendurl => link_to(@friendurl, @friendurl) %></p>
   <% end -%>
 <% end %>

diff --git a/app/views/user_mailer/message_notification.html.erb b/app/views/user_mailer/message_notification.html.erb
index 74d10f599be967370ce81ea41afc9eb34edeb1f4..fd49c6723c410da3bae56a249eabe3261e8882a5 100644 (file)
--- a/app/views/user_mailer/message_notification.html.erb
+++ b/app/views/user_mailer/message_notification.html.erb
@@ -2,9 +2,9 @@
   <%= t ".hi", :to_user => @to_user %>
 </p>
 <p>
-  <%= raw t ".header",
-            :from_user => link_to_user(@from_user),
-            :subject => tag.em(@title) %>
+  <%= t ".header",
+        :from_user => link_to_user(@from_user),
+        :subject => tag.em(@title) %>
 </p>
 
 <%= message_body do %>

diff --git a/app/views/user_mailer/message_notification.text.erb b/app/views/user_mailer/message_notification.text.erb
index 6bd7393d7fd9f9a139719000c8958c5938d4321b..1d75e7e2a22c95932a3a6fd70427f51b2d6d53d4 100644 (file)
--- a/app/views/user_mailer/message_notification.text.erb
+++ b/app/views/user_mailer/message_notification.text.erb
@@ -6,4 +6,4 @@
 <%= @text.to_text %>
 ==
 
-<%= word_wrap(t '.footer_html', :readurl => @readurl, :replyurl => @replyurl) %>
+<%= word_wrap(t '.footer', :readurl => @readurl, :replyurl => @replyurl) %>

diff --git a/app/views/user_mailer/note_comment_notification.html.erb b/app/views/user_mailer/note_comment_notification.html.erb
index 3a828602865d17ad0bb8ce3aab0c4e085e3d3df1..8d779bc48564b2aa6b4c166f446aa07b6a1be660 100644 (file)
--- a/app/views/user_mailer/note_comment_notification.html.erb
+++ b/app/views/user_mailer/note_comment_notification.html.erb
@@ -1,9 +1,9 @@
 <p><%= t ".greeting" %></p>
 
 <% if @owner %>
-  <p><%= raw t ".#{@event}.your_note", :commenter => link_to_user(@commenter), :place => @place %></p>
+  <p><%= t ".#{@event}.your_note_html", :commenter => link_to_user(@commenter), :place => @place %></p>
 <% else %>
-  <p><%= raw t ".#{@event}.commented_note", :commenter => link_to_user(@commenter), :place => @place %></p>
+  <p><%= t ".#{@event}.commented_note_html", :commenter => link_to_user(@commenter), :place => @place %></p>
 <% end %>
 
 <% unless @comment.empty? %>
@@ -12,4 +12,4 @@
   <% end %>
 <% end %>
 
-<p><%= raw t ".details", :url => link_to(@noteurl, @noteurl) %></p>
+<p><%= t ".details_html", :url => link_to(@noteurl, @noteurl) %></p>

diff --git a/config/locales/en.yml b/config/locales/en.yml
index 50dabce261599ee3a6f59d7b6b17bbc2fb97fd24..8531800809f650901c96904acfe63863ef5160c3 100644 (file)
--- a/config/locales/en.yml
+++ b/config/locales/en.yml
@@ -1414,18 +1414,24 @@ en:
       subject: "[OpenStreetMap] %{user} commented on a diary entry"
       hi: "Hi %{to_user},"
       header: "%{from_user} has commented on the OpenStreetMap diary entry with the subject %{subject}:"
+      header_html: "%{from_user} has commented on the OpenStreetMap diary entry with the subject %{subject}:"
       footer: "You can also read the comment at %{readurl} and you can comment at %{commenturl} or send a message to the author at %{replyurl}"
+      footer_html: "You can also read the comment at %{readurl} and you can comment at %{commenturl} or send a message to the author at %{replyurl}"
     message_notification:
       subject: "[OpenStreetMap] %{message_title}"
       hi: "Hi %{to_user},"
       header: "%{from_user} has sent you a message through OpenStreetMap with the subject %{subject}:"
+      header_html: "%{from_user} has sent you a message through OpenStreetMap with the subject %{subject}:"
+      footer: "You can also read the message at %{readurl} and you can send a message to the author at %{replyurl}"
       footer_html: "You can also read the message at %{readurl} and you can send a message to the author at %{replyurl}"
     friendship_notification:
       hi: "Hi %{to_user},"
       subject: "[OpenStreetMap] %{user} added you as a friend"
       had_added_you: "%{user} has added you as a friend on OpenStreetMap."
       see_their_profile: "You can see their profile at %{userurl}."
+      see_their_profile_html: "You can see their profile at %{userurl}."
       befriend_them: "You can also add them as a friend at %{befriendurl}."
+      befriend_them_html: "You can also add them as a friend at %{befriendurl}."
     gpx_description:
       description_with_tags_html: "It looks like your GPX file %{trace_name} with the description %{trace_description} and the following tags: %{tags}"
       description_with_no_tags_html: "It looks like your GPX file %{trace_name} with the description %{trace_description} and no tags"
@@ -1464,18 +1470,25 @@ en:
         subject_own: "[OpenStreetMap] %{commenter} has commented on one of your notes"
         subject_other: "[OpenStreetMap] %{commenter} has commented on a note you are interested in"
         your_note: "%{commenter} has left a comment on one of your map notes near %{place}."
+        your_note_html: "%{commenter} has left a comment on one of your map notes near %{place}."
         commented_note: "%{commenter} has left a comment on a map note you have commented on. The note is near %{place}."
+        commented_note_html: "%{commenter} has left a comment on a map note you have commented on. The note is near %{place}."
       closed:
         subject_own: "[OpenStreetMap] %{commenter} has resolved one of your notes"
         subject_other: "[OpenStreetMap] %{commenter} has resolved a note you are interested in"
         your_note: "%{commenter} has resolved one of your map notes near %{place}."
+        your_note_html: "%{commenter} has resolved one of your map notes near %{place}."
         commented_note: "%{commenter} has resolved a map note you have commented on. The note is near %{place}."
+        commented_note_html: "%{commenter} has resolved a map note you have commented on. The note is near %{place}."
       reopened:
         subject_own: "[OpenStreetMap] %{commenter} has reactivated one of your notes"
         subject_other: "[OpenStreetMap] %{commenter} has reactivated a note you are interested in"
         your_note: "%{commenter} has reactivated one of your map notes near %{place}."
+        your_note_html: "%{commenter} has reactivated one of your map notes near %{place}."
         commented_note: "%{commenter} has reactivated a map note you have commented on. The note is near %{place}."
+        commented_note_html: "%{commenter} has reactivated a map note you have commented on. The note is near %{place}."
       details: "More details about the note can be found at %{url}."
+      details_html: "More details about the note can be found at %{url}."
     changeset_comment_notification:
       hi: "Hi %{to_user},"
       greeting: "Hi,"
@@ -1483,11 +1496,16 @@ en:
         subject_own: "[OpenStreetMap] %{commenter} has commented on one of your changesets"
         subject_other: "[OpenStreetMap] %{commenter} has commented on a changeset you are interested in"
         your_changeset: "%{commenter} left a comment at %{time} on one of your changesets"
+        your_changeset_html: "%{commenter} left a comment at %{time} on one of your changesets"
         commented_changeset: "%{commenter} left a comment at %{time} on a changeset you are watching created by %{changeset_author}"
+        commented_changeset_html: "%{commenter} left a comment at %{time} on a changeset you are watching created by %{changeset_author}"
         partial_changeset_with_comment: "with comment '%{changeset_comment}'"
+        partial_changeset_with_comment_html: "with comment '%{changeset_comment}'"
         partial_changeset_without_comment: "without comment"
       details: "More details about the changeset can be found at %{url}."
+      details_html: "More details about the changeset can be found at %{url}."
       unsubscribe: 'To unsubscribe from updates to this changeset, visit %{url} and click "Unsubscribe".'
+      unsubscribe_html: 'To unsubscribe from updates to this changeset, visit %{url} and click "Unsubscribe".'
   messages:
     inbox:
       title: "Inbox"