emails: fixed newlines in email templates that can break email sending code.

rhodecode/model/notification.py

@@ -1,374 +1,379 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2011-2017 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # 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.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 
 """
 Model for notifications
 """
 
 
 import logging
 import traceback
 
 from pylons.i18n.translation import _, ungettext
 from sqlalchemy.sql.expression import false, true
 from mako import exceptions
 
 import rhodecode
 from rhodecode.lib import helpers as h
 from rhodecode.lib.utils import PartialRenderer
 from rhodecode.model import BaseModel
 from rhodecode.model.db import Notification, User, UserNotification
 from rhodecode.model.meta import Session
 from rhodecode.model.settings import SettingsModel
 from rhodecode.translation import TranslationString
 
 log = logging.getLogger(__name__)
 
 
 class NotificationModel(BaseModel):
 
     cls = Notification
 
     def __get_notification(self, notification):
         if isinstance(notification, Notification):
             return notification
         elif isinstance(notification, (int, long)):
             return Notification.get(notification)
         else:
             if notification:
                 raise Exception('notification must be int, long or Instance'
                                 ' of Notification got %s' % type(notification))
 
     def create(
             self, created_by, notification_subject, notification_body,
             notification_type=Notification.TYPE_MESSAGE, recipients=None,
             mention_recipients=None, with_email=True, email_kwargs=None):
         """
 
         Creates notification of given type
 
         :param created_by: int, str or User instance. User who created this
             notification
         :param notification_subject: subject of notification itself
         :param notification_body: body of notification text
         :param notification_type: type of notification, based on that we
             pick templates
 
         :param recipients: list of int, str or User objects, when None
             is given send to all admins
         :param mention_recipients: list of int, str or User objects,
             that were mentioned
         :param with_email: send email with this notification
         :param email_kwargs: dict with arguments to generate email
         """
 
         from rhodecode.lib.celerylib import tasks, run_task
 
         if recipients and not getattr(recipients, '__iter__', False):
             raise Exception('recipients must be an iterable object')
 
         created_by_obj = self._get_user(created_by)
         # default MAIN body if not given
         email_kwargs = email_kwargs or {'body': notification_body}
         mention_recipients = mention_recipients or set()
 
         if not created_by_obj:
             raise Exception('unknown user %s' % created_by)
 
         if recipients is None:
             # recipients is None means to all admins
             recipients_objs = User.query().filter(User.admin == true()).all()
             log.debug('sending notifications %s to admins: %s',
                       notification_type, recipients_objs)
         else:
             recipients_objs = []
             for u in recipients:
                 obj = self._get_user(u)
                 if obj:
                     recipients_objs.append(obj)
                 else:  # we didn't find this user, log the error and carry on
                     log.error('cannot notify unknown user %r', u)
 
             recipients_objs = set(recipients_objs)
             if not recipients_objs:
                 raise Exception('no valid recipients specified')
 
             log.debug('sending notifications %s to %s',
                       notification_type, recipients_objs)
 
         # add mentioned users into recipients
         final_recipients = set(recipients_objs).union(mention_recipients)
         notification = Notification.create(
             created_by=created_by_obj, subject=notification_subject,
             body=notification_body, recipients=final_recipients,
             type_=notification_type
         )
 
         if not with_email:  # skip sending email, and just create notification
             return notification
 
         # don't send email to person who created this comment
         rec_objs = set(recipients_objs).difference(set([created_by_obj]))
 
         # now notify all recipients in question
 
         for recipient in rec_objs.union(mention_recipients):
             # inject current recipient
             email_kwargs['recipient'] = recipient
             email_kwargs['mention'] = recipient in mention_recipients
             (subject, headers, email_body,
              email_body_plaintext) = EmailNotificationModel().render_email(
                 notification_type, **email_kwargs)
 
             log.debug(
                 'Creating notification email task for user:`%s`', recipient)
             task = run_task(
                 tasks.send_email, recipient.email, subject,
                 email_body_plaintext, email_body)
             log.debug('Created email task: %s', task)
 
         return notification
 
     def delete(self, user, notification):
         # we don't want to remove actual notification just the assignment
         try:
             notification = self.__get_notification(notification)
             user = self._get_user(user)
             if notification and user:
                 obj = UserNotification.query()\
                     .filter(UserNotification.user == user)\
                     .filter(UserNotification.notification == notification)\
                     .one()
                 Session().delete(obj)
                 return True
         except Exception:
             log.error(traceback.format_exc())
             raise
 
     def get_for_user(self, user, filter_=None):
         """
         Get mentions for given user, filter them if filter dict is given
 
         :param user:
         :param filter:
         """
         user = self._get_user(user)
 
         q = UserNotification.query()\
             .filter(UserNotification.user == user)\
             .join((
                 Notification, UserNotification.notification_id ==
                 Notification.notification_id))
 
         if filter_:
             q = q.filter(Notification.type_.in_(filter_))
 
         return q.all()
 
     def mark_read(self, user, notification):
         try:
             notification = self.__get_notification(notification)
             user = self._get_user(user)
             if notification and user:
                 obj = UserNotification.query()\
                     .filter(UserNotification.user == user)\
                     .filter(UserNotification.notification == notification)\
                     .one()
                 obj.read = True
                 Session().add(obj)
                 return True
         except Exception:
             log.error(traceback.format_exc())
             raise
 
     def mark_all_read_for_user(self, user, filter_=None):
         user = self._get_user(user)
         q = UserNotification.query()\
             .filter(UserNotification.user == user)\
             .filter(UserNotification.read == false())\
             .join((
                 Notification, UserNotification.notification_id ==
                 Notification.notification_id))
         if filter_:
             q = q.filter(Notification.type_.in_(filter_))
 
         # this is a little inefficient but sqlalchemy doesn't support
         # update on joined tables :(
         for obj in q.all():
             obj.read = True
             Session().add(obj)
 
     def get_unread_cnt_for_user(self, user):
         user = self._get_user(user)
         return UserNotification.query()\
             .filter(UserNotification.read == false())\
             .filter(UserNotification.user == user).count()
 
     def get_unread_for_user(self, user):
         user = self._get_user(user)
         return [x.notification for x in UserNotification.query()
                 .filter(UserNotification.read == false())
                 .filter(UserNotification.user == user).all()]
 
     def get_user_notification(self, user, notification):
         user = self._get_user(user)
         notification = self.__get_notification(notification)
 
         return UserNotification.query()\
             .filter(UserNotification.notification == notification)\
             .filter(UserNotification.user == user).scalar()
 
     def make_description(self, notification, show_age=True, translate=None):
         """
         Creates a human readable description based on properties
         of notification object
         """
 
         _map = {
             notification.TYPE_CHANGESET_COMMENT: [
                 _('%(user)s commented on commit %(date_or_age)s'),
                 _('%(user)s commented on commit at %(date_or_age)s'),
                 ],
             notification.TYPE_MESSAGE: [
                 _('%(user)s sent message %(date_or_age)s'),
                 _('%(user)s sent message at %(date_or_age)s'),
                 ],
             notification.TYPE_MENTION: [
                 _('%(user)s mentioned you %(date_or_age)s'),
                 _('%(user)s mentioned you at %(date_or_age)s'),
                 ],
             notification.TYPE_REGISTRATION: [
                 _('%(user)s registered in RhodeCode %(date_or_age)s'),
                 _('%(user)s registered in RhodeCode at %(date_or_age)s'),
                 ],
             notification.TYPE_PULL_REQUEST: [
                 _('%(user)s opened new pull request %(date_or_age)s'),
                 _('%(user)s opened new pull request at %(date_or_age)s'),
                 ],
             notification.TYPE_PULL_REQUEST_COMMENT: [
                 _('%(user)s commented on pull request %(date_or_age)s'),
                 _('%(user)s commented on pull request at %(date_or_age)s'),
                 ],
         }
 
         templates = _map[notification.type_]
 
         if show_age:
             template = templates[0]
             date_or_age = h.age(notification.created_on)
             if translate:
                 date_or_age = translate(date_or_age)
 
             if isinstance(date_or_age, TranslationString):
                 date_or_age = date_or_age.interpolate()
 
         else:
             template = templates[1]
             date_or_age = h.format_date(notification.created_on)
 
         return template % {
             'user': notification.created_by_user.username,
             'date_or_age': date_or_age,
         }
 
 
 class EmailNotificationModel(BaseModel):
     TYPE_COMMIT_COMMENT = Notification.TYPE_CHANGESET_COMMENT
     TYPE_REGISTRATION = Notification.TYPE_REGISTRATION
     TYPE_PULL_REQUEST = Notification.TYPE_PULL_REQUEST
     TYPE_PULL_REQUEST_COMMENT = Notification.TYPE_PULL_REQUEST_COMMENT
     TYPE_MAIN = Notification.TYPE_MESSAGE
 
     TYPE_PASSWORD_RESET = 'password_reset'
     TYPE_PASSWORD_RESET_CONFIRMATION = 'password_reset_confirmation'
     TYPE_EMAIL_TEST = 'email_test'
     TYPE_TEST = 'test'
 
     email_types = {
         TYPE_MAIN: 'email_templates/main.mako',
         TYPE_TEST: 'email_templates/test.mako',
         TYPE_EMAIL_TEST: 'email_templates/email_test.mako',
         TYPE_REGISTRATION: 'email_templates/user_registration.mako',
         TYPE_PASSWORD_RESET: 'email_templates/password_reset.mako',
         TYPE_PASSWORD_RESET_CONFIRMATION: 'email_templates/password_reset_confirmation.mako',
         TYPE_COMMIT_COMMENT: 'email_templates/commit_comment.mako',
         TYPE_PULL_REQUEST: 'email_templates/pull_request_review.mako',
         TYPE_PULL_REQUEST_COMMENT: 'email_templates/pull_request_comment.mako',
     }
 
     def __init__(self):
         """
         Example usage::
 
             (subject, headers, email_body,
              email_body_plaintext) = EmailNotificationModel().render_email(
                 EmailNotificationModel.TYPE_TEST, **email_kwargs)
 
         """
         super(EmailNotificationModel, self).__init__()
         self.rhodecode_instance_name = rhodecode.CONFIG.get('rhodecode_title')
 
     def _update_kwargs_for_render(self, kwargs):
         """
         Inject params required for Mako rendering
 
         :param kwargs:
         """
+
         kwargs['rhodecode_instance_name'] = self.rhodecode_instance_name
 
         _kwargs = {
             'instance_url': h.url('home', qualified=True),
+            'whitespace_filter': self.whitespace_filter
         }
         _kwargs.update(kwargs)
         return _kwargs
 
+    def whitespace_filter(self, text):
+        return text.replace('\n', '').replace('\t', '')
+
     def get_renderer(self, type_):
         template_name = self.email_types[type_]
         return PartialRenderer(template_name)
 
     def render_email(self, type_, **kwargs):
         """
         renders template for email, and returns a tuple of
         (subject, email_headers, email_html_body, email_plaintext_body)
         """
         # translator and helpers inject
         _kwargs = self._update_kwargs_for_render(kwargs)
 
         email_template = self.get_renderer(type_)
 
         subject = email_template.render('subject', **_kwargs)
 
         try:
             headers = email_template.render('headers', **_kwargs)
         except AttributeError:
             # it's not defined in template, ok we can skip it
             headers = ''
 
         try:
             body_plaintext = email_template.render('body_plaintext', **_kwargs)
         except AttributeError:
             # it's not defined in template, ok we can skip it
             body_plaintext = ''
 
         # render WHOLE template
         body = email_template.render(None, **_kwargs)
 
         return subject, headers, body, body_plaintext

rhodecode/templates/email_templates/commit_comment.mako

@@ -1,105 +1,105 b''
 ## -*- coding: utf-8 -*-
 <%inherit file="base.mako"/>
 <%namespace name="base" file="base.mako"/>
 
 ## EMAIL SUBJECT
-<%def name="subject()" filter="n,trim">
+<%def name="subject()" filter="n,trim,whitespace_filter">
 <%
 data = {
     'user': h.person(user),
     'repo_name': repo_name,
     'commit_id': h.show_id(commit),
     'status': status_change,
     'comment_file': comment_file,
     'comment_line': comment_line,
     'comment_type': comment_type,
 }
 %>
 ${_('[mention]') if mention else ''} \
 
 % if comment_file:
     ${_('%(user)s left %(comment_type)s on commit `%(commit_id)s` (file: `%(comment_file)s`)') % data} ${_('in the %(repo_name)s repository') % data |n}
 % else:
     % if status_change:
     ${_('%(user)s left %(comment_type)s on commit `%(commit_id)s` (status: %(status)s)') % data |n} ${_('in the %(repo_name)s repository') % data |n}
     % else:
     ${_('%(user)s left %(comment_type)s on commit `%(commit_id)s`') % data |n} ${_('in the %(repo_name)s repository') % data |n}
     % endif
 % endif
 
 </%def>
 
 ## PLAINTEXT VERSION OF BODY
 <%def name="body_plaintext()" filter="n,trim">
 <%
 data = {
     'user': h.person(user),
     'repo_name': repo_name,
     'commit_id': h.show_id(commit),
     'status': status_change,
     'comment_file': comment_file,
     'comment_line': comment_line,
     'comment_type': comment_type,
 }
 %>
 ${self.subject()}
 
 * ${_('Comment link')}: ${commit_comment_url}
 
 * ${_('Commit')}: ${h.show_id(commit)}
 
 %if comment_file:
 * ${_('File: %(comment_file)s on line %(comment_line)s') % data}
 %endif
 
 ---
 
 %if status_change:
     ${_('Commit status was changed to')}: *${status_change}*
 %endif
 
 ${comment_body|n}
 
 ${self.plaintext_footer()}
 </%def>
 
 
 <%
 data = {
     'user': h.person(user),
     'repo': commit_target_repo,
     'repo_name': repo_name,
     'commit_id': h.show_id(commit),
     'comment_file': comment_file,
     'comment_line': comment_line,
     'comment_type': comment_type,
 }
 %>
 <table style="text-align:left;vertical-align:middle;">
     <tr><td colspan="2" style="width:100%;padding-bottom:15px;border-bottom:1px solid #dbd9da;">
 
     % if comment_file:
         <h4><a href="${commit_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('%(user)s commented on commit `%(commit_id)s` (file:`%(comment_file)s`)') % data}</a> ${_('in the %(repo)s repository') % data |n}</h4>
     % else:
         <h4><a href="${commit_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('%(user)s commented on commit `%(commit_id)s`') % data |n}</a> ${_('in the %(repo)s repository') % data |n}</h4>
     % endif
     </td></tr>
 
     <tr><td style="padding-right:20px;padding-top:15px;">${_('Commit')}</td><td style="padding-top:15px;"><a href="${commit_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${h.show_id(commit)}</a></td></tr>
     <tr><td style="padding-right:20px;">${_('Description')}</td><td style="white-space:pre-wrap">${h.urlify_commit_message(commit.message, repo_name)}</td></tr>
 
     % if status_change:
         <tr><td style="padding-right:20px;">${_('Status')}</td>
             <td>${_('The commit status was changed to')}: ${base.status_text(status_change, tag_type=status_change_type)}</td>
         </tr>
     % endif
     <tr>
         <td style="padding-right:20px;">
             % if comment_type == 'todo':
                 ${(_('TODO comment on line: %(comment_line)s') if comment_file else _('TODO comment')) % data}
             % else:
                 ${(_('Note comment on line: %(comment_line)s') if comment_file else _('Note comment')) % data}
             % endif
         </td>
         <td style="line-height:1.2em;white-space:pre-wrap">${h.render(comment_body, renderer=renderer_type, mentions=True)}</td></tr>
 </table>

rhodecode/templates/email_templates/email_test.mako

@@ -1,13 +1,13 b''
 ## -*- coding: utf-8 -*-
 <%inherit file="base.mako"/>
 
-<%def name="subject()" filter="n,trim">
+<%def name="subject()" filter="n,trim,whitespace_filter">
 RhodeCode test email: ${h.format_date(date)}
 </%def>
 
 ## plain text version of the email. Empty by default
 <%def name="body_plaintext()" filter="n,trim">
 Test Email from RhodeCode version: ${rhodecode_version}, sent by: ${user}
 </%def>
 
 ${body_plaintext()}
  No newline at end of file

rhodecode/templates/email_templates/main.mako

@@ -1,21 +1,21 b''
 ## -*- coding: utf-8 -*-
 <%inherit file="base.mako"/>
 
-<%def name="subject()" filter="n,trim">
+<%def name="subject()" filter="n,trim,whitespace_filter">
 </%def>
 
 
 ## plain text version of the email. Empty by default
 <%def name="body_plaintext()" filter="n,trim">
 ${body}
 
 ${self.plaintext_footer()}
 </%def>
 
 ## BODY GOES BELOW
 <table style="text-align:left;vertical-align:top;">
     <tr><td style="padding-right:20px;padding-top:15px;white-space:pre-wrap">${body}</td></tr>
 </table>
 <p><a style="margin-top:15px;margin-left:1%;font-family:sans-serif;font-weight:100;font-size:11px;display:block;color:#666666;text-decoration:none;" href="${instance_url}">
     ${self.plaintext_footer()}
 </a></p>
  No newline at end of file

rhodecode/templates/email_templates/password_reset.mako

@@ -1,33 +1,33 b''
 ## -*- coding: utf-8 -*-
 <%inherit file="base.mako"/>
 
-<%def name="subject()" filter="n,trim">
+<%def name="subject()" filter="n,trim,whitespace_filter">
 RhodeCode Password reset
 </%def>
 
 ## plain text version of the email. Empty by default
 <%def name="body_plaintext()" filter="n,trim">
 Hi ${user.username},
 
 There was a request to reset your password using the email address ${email} on ${h.format_date(date)}
 
 *If you didn't do this, please contact your RhodeCode administrator.*
 
 You can continue, and generate new password by clicking following URL:
 ${password_reset_url}
 
 This link will be active for 10 minutes.
 ${self.plaintext_footer()}
 </%def>
 
 ## BODY GOES BELOW
 <p>
 Hello ${user.username},
 </p><p>
 There was a request to reset your password using the email address ${email} on ${h.format_date(date)}
 <br/>
 <strong>If you did not request a password reset, please contact your RhodeCode administrator.</strong>
 </p><p>
 <a href="${password_reset_url}">${_('Generate new password here')}.</a>
 This link will be active for 10 minutes.
 </p>

rhodecode/templates/email_templates/password_reset_confirmation.mako

@@ -1,29 +1,29 b''
 ## -*- coding: utf-8 -*-
 <%inherit file="base.mako"/>
 
-<%def name="subject()" filter="n,trim">
+<%def name="subject()" filter="n,trim,whitespace_filter">
 Your new RhodeCode password
 </%def>
 
 ## plain text version of the email. Empty by default
 <%def name="body_plaintext()" filter="n,trim">
 Hi ${user.username},
 
 Below is your new access password for RhodeCode.
 
 *If you didn't do this, please contact your RhodeCode administrator.*
 
 password: ${new_password}
 
 ${self.plaintext_footer()}
 </%def>
 
 ## BODY GOES BELOW
 <p>
 Hello ${user.username},
 </p><p>
 Below is your new access password for RhodeCode.
 <br/>
 <strong>If you didn't request a new password, please contact your RhodeCode administrator.</strong>
 </p>
 <p>password: <pre>${new_password}</pre>

rhodecode/templates/email_templates/pull_request_comment.mako

@@ -1,114 +1,114 b''
 ## -*- coding: utf-8 -*-
 <%inherit file="base.mako"/>
 <%namespace name="base" file="base.mako"/>
 
 ## EMAIL SUBJECT
-<%def name="subject()" filter="n,trim">
+<%def name="subject()" filter="n,trim,whitespace_filter">
 <%
 data = {
     'user': h.person(user),
     'pr_title': pull_request.title,
     'pr_id': pull_request.pull_request_id,
     'status': status_change,
     'comment_file': comment_file,
     'comment_line': comment_line,
     'comment_type': comment_type,
 }
 %>
 
 ${_('[mention]') if mention else ''} \
 
 % if comment_file:
     ${_('%(user)s left %(comment_type)s on pull request #%(pr_id)s "%(pr_title)s" (file: `%(comment_file)s`)') % data |n}
 % else:
     % if status_change:
     ${_('%(user)s left %(comment_type)s on pull request #%(pr_id)s "%(pr_title)s" (status: %(status)s)') % data |n}
     % else:
     ${_('%(user)s left %(comment_type)s on pull request #%(pr_id)s "%(pr_title)s"') % data |n}
     % endif
 % endif
 </%def>
 
 ## PLAINTEXT VERSION OF BODY
 <%def name="body_plaintext()" filter="n,trim">
 <%
 data = {
     'user': h.person(user),
     'pr_title': pull_request.title,
     'pr_id': pull_request.pull_request_id,
     'status': status_change,
     'comment_file': comment_file,
     'comment_line': comment_line,
     'comment_type': comment_type,
 }
 %>
 ${self.subject()}
 
 * ${_('Comment link')}: ${pr_comment_url}
 
 * ${_('Source repository')}: ${pr_source_repo_url}
 
 %if comment_file:
 * ${_('File: %(comment_file)s on line %(comment_line)s') % {'comment_file': comment_file, 'comment_line': comment_line}}
 %endif
 
 ---
 
 %if status_change and not closing_pr:
    ${_('%(user)s submitted pull request #%(pr_id)s status: *%(status)s*') % data}
 %elif status_change and closing_pr:
    ${_('%(user)s submitted pull request #%(pr_id)s status: *%(status)s and closed*') % data}
 %endif
 
 ${comment_body|n}
 
 ${self.plaintext_footer()}
 </%def>
 
 
 <%
 data = {
     'user': h.person(user),
     'pr_title': pull_request.title,
     'pr_id': pull_request.pull_request_id,
     'status': status_change,
     'comment_file': comment_file,
     'comment_line': comment_line,
     'comment_type': comment_type,
 }
 %>
 <table style="text-align:left;vertical-align:middle;">
     <tr><td colspan="2" style="width:100%;padding-bottom:15px;border-bottom:1px solid #dbd9da;">
 
     % if comment_file:
         <h4><a href="${pr_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('%(user)s commented on pull request #%(pr_id)s "%(pr_title)s" (file:`%(comment_file)s`)') % data |n}</a></h4>
     % else:
         <h4><a href="${pr_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('%(user)s commented on pull request #%(pr_id)s "%(pr_title)s"') % data |n}</a></h4>
     % endif
 
     </td></tr>
     <tr><td style="padding-right:20px;padding-top:15px;">${_('Source')}</td><td style="padding-top:15px;"><a style="color:#427cc9;text-decoration:none;cursor:pointer" href="${pr_source_repo_url}">${pr_source_repo.repo_name}</a></td></tr>
 
     % if status_change:
         <tr>
             <td style="padding-right:20px;">${_('Status')}</td>
             <td>
                 % if closing_pr:
                    ${_('Closed pull request with status')}: ${base.status_text(status_change, tag_type=status_change_type)}
                 % else:
                    ${_('Submitted review status')}: ${base.status_text(status_change, tag_type=status_change_type)}
                 % endif
             </td>
         </tr>
     % endif
     <tr>
         <td style="padding-right:20px;">
             % if comment_type == 'todo':
                 ${(_('TODO comment on line: %(comment_line)s') if comment_file else _('TODO comment')) % data}
             % else:
                 ${(_('Note comment on line: %(comment_line)s') if comment_file else _('Note comment')) % data}
             % endif
         </td>
         <td style="line-height:1.2em;white-space:pre-wrap">${h.render(comment_body, renderer=renderer_type, mentions=True)}</td>
     </tr>
 </table>

rhodecode/templates/email_templates/pull_request_review.mako

@@ -1,85 +1,85 b''
 ## -*- coding: utf-8 -*-
 <%inherit file="base.mako"/>
 <%namespace name="base" file="base.mako"/>
 
-<%def name="subject()" filter="n,trim">
+<%def name="subject()" filter="n,trim,whitespace_filter">
 <%
 data = {
     'user': h.person(user),
     'pr_id': pull_request.pull_request_id,
     'pr_title': pull_request.title,
 }
 %>
 
 ${_('%(user)s wants you to review pull request #%(pr_id)s: "%(pr_title)s"') % data |n}
 </%def>
 
 
 <%def name="body_plaintext()" filter="n,trim">
 <%
 data = {
     'user': h.person(user),
     'pr_id': pull_request.pull_request_id,
     'pr_title': pull_request.title,
     'source_ref_type': pull_request.source_ref_parts.type,
     'source_ref_name': pull_request.source_ref_parts.name,
     'target_ref_type': pull_request.target_ref_parts.type,
     'target_ref_name': pull_request.target_ref_parts.name,
     'repo_url': pull_request_source_repo_url
 }
 %>
 ${self.subject()}
 
 
 ${h.literal(_('Pull request from %(source_ref_type)s:%(source_ref_name)s of %(repo_url)s into %(target_ref_type)s:%(target_ref_name)s') % data)}
 
 
 * ${_('Link')}: ${pull_request_url}
 
 * ${_('Title')}: ${pull_request.title}
 
 * ${_('Description')}:
 
 ${pull_request.description}
 
 
 * ${ungettext('Commit (%(num)s)', 'Commits (%(num)s)', len(pull_request_commits) ) % {'num': len(pull_request_commits)}}:
 
 % for commit_id, message in pull_request_commits:
         - ${h.short_id(commit_id)}
           ${h.chop_at_smart(message, '\n', suffix_if_chopped='...')}
 
 % endfor
 
 ${self.plaintext_footer()}
 </%def>
 <%
 data = {
     'user': h.person(user),
     'pr_id': pull_request.pull_request_id,
     'pr_title': pull_request.title,
     'source_ref_type': pull_request.source_ref_parts.type,
     'source_ref_name': pull_request.source_ref_parts.name,
     'target_ref_type': pull_request.target_ref_parts.type,
     'target_ref_name': pull_request.target_ref_parts.name,
     'repo_url': pull_request_source_repo_url,
     'source_repo_url': h.link_to(pull_request_source_repo.repo_name, pull_request_source_repo_url),
     'target_repo_url': h.link_to(pull_request_target_repo.repo_name, pull_request_target_repo_url)
 }
 %>
 <table style="text-align:left;vertical-align:middle;">
     <tr><td colspan="2" style="width:100%;padding-bottom:15px;border-bottom:1px solid #dbd9da;"><h4><a href="${pull_request_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('%(user)s wants you to review pull request #%(pr_id)s: "%(pr_title)s".') % data }</a></h4></td></tr>
     <tr><td style="padding-right:20px;padding-top:15px;">${_('Title')}</td><td style="padding-top:15px;">${pull_request.title}</td></tr>
     <tr><td style="padding-right:20px;">${_('Source')}</td><td>${base.tag_button(pull_request.source_ref_parts.name)} ${h.literal(_('%(source_ref_type)s of %(source_repo_url)s') % data)}</td></tr>
     <tr><td style="padding-right:20px;">${_('Target')}</td><td>${base.tag_button(pull_request.target_ref_parts.name)} ${h.literal(_('%(target_ref_type)s of %(target_repo_url)s') % data)}</td></tr>
     <tr><td style="padding-right:20px;">${_('Description')}</td><td style="white-space:pre-wrap">${pull_request.description}</td></tr>
     <tr><td style="padding-right:20px;">${ungettext('%(num)s Commit', '%(num)s Commits', len(pull_request_commits)) % {'num': len(pull_request_commits)}}</td>
         <td><ol style="margin:0 0 0 1em;padding:0;text-align:left;">
             % for commit_id, message in pull_request_commits:
             <li style="margin:0 0 1em;"><pre style="margin:0 0 .5em">${h.short_id(commit_id)}</pre>
                 ${h.chop_at_smart(message, '\n', suffix_if_chopped='...')}
             </li>
             % endfor
         </ol></td>
     </tr>
 </table>

rhodecode/templates/email_templates/test.mako

@@ -1,21 +1,21 b''
 ## -*- coding: utf-8 -*-
 <%inherit file="base.mako"/>
 
-<%def name="subject()" filter="n,trim">
+<%def name="subject()" filter="n,trim,whitespace_filter">
 Test "Subject" ${_('hello "world"')|n}
 </%def>
 
 <%def name="headers()" filter="n,trim">
 X=Y
 </%def>
 
 ## plain text version of the email. Empty by default
 <%def name="body_plaintext()" filter="n,trim">
 Email Plaintext Body
 </%def>
 
 ## BODY GOES BELOW
 <b>Email Body</b>
 
 ${h.short_id('0' * 40)}
 ${_('Translation')}
  No newline at end of file

rhodecode/templates/email_templates/user_registration.mako

@@ -1,27 +1,27 b''
 ## -*- coding: utf-8 -*-
 <%inherit file="base.mako"/>
 
-<%def name="subject()" filter="n,trim">
+<%def name="subject()" filter="n,trim,whitespace_filter">
 RhodeCode new user registration: ${user.username}
 </%def>
 
 <%def name="body_plaintext()" filter="n,trim">
 
 A new user `${user.username}` has registered on ${h.format_date(date)}
 
 - Username: ${user.username}
 - Full Name: ${user.firstname} ${user.lastname}
 - Email: ${user.email}
 - Profile link: ${h.route_path('user_profile', username=user.username, qualified=True)}
 
 ${self.plaintext_footer()}
 </%def>
 
 ## BODY GOES BELOW
 <table style="text-align:left;vertical-align:middle;">
     <tr><td colspan="2" style="width:100%;padding-bottom:15px;border-bottom:1px solid #dbd9da;"><h4><a href="${h.route_url('user_profile', username=user.username)}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('New user %(user)s has registered on %(date)s') % {'user': user.username, 'date': h.format_date(date)}}</a></h4></td></tr>
     <tr><td style="padding-right:20px;padding-top:20px;">${_('Username')}</td><td style="line-height:1;padding-top:20px;"><img style="margin-bottom:-5px;text-align:left;border:1px solid #dbd9da" src="${h.gravatar_url(user.email, 16)}" height="16" width="16">&nbsp;${user.username}</td></tr>
     <tr><td style="padding-right:20px;">${_('Full Name')}</td><td>${user.firstname} ${user.lastname}</td></tr>
     <tr><td style="padding-right:20px;">${_('Email')}</td><td>${user.email}</td></tr>
     <tr><td style="padding-right:20px;">${_('Profile')}</td><td><a href="${h.route_url('user_profile', username=user.username)}">${h.route_url('user_profile', username=user.username)}</a></td></tr>
 </table>
  No newline at end of file

rhodecode/tests/lib/test_mako_emails.py

@@ -1,68 +1,123 b''
 import collections
 
 import pytest
 
 from rhodecode.lib.utils import PartialRenderer
+from rhodecode.lib.utils2 import AttributeDict
 from rhodecode.model.notification import EmailNotificationModel
 
 
 def test_get_template_obj(pylonsapp):
     template = EmailNotificationModel().get_renderer(
         EmailNotificationModel.TYPE_TEST)
     assert isinstance(template, PartialRenderer)
 
 
 def test_render_email(pylonsapp):
     kwargs = {}
     subject, headers, body, body_plaintext = EmailNotificationModel().render_email(
         EmailNotificationModel.TYPE_TEST, **kwargs)
 
     # subject
     assert subject == 'Test "Subject" hello "world"'
 
     # headers
     assert headers == 'X=Y'
 
     # body plaintext
     assert body_plaintext == 'Email Plaintext Body'
 
     # body
     assert 'This is a notification ' \
            'from RhodeCode. http://test.example.com:80/' in body
     assert 'Email Body' in body
 
 
 def test_render_pr_email(pylonsapp, user_admin):
 
     ref = collections.namedtuple('Ref',
         'name, type')(
         'fxies123', 'book'
         )
 
     pr = collections.namedtuple('PullRequest',
         'pull_request_id, title, description, source_ref_parts, source_ref_name, target_ref_parts, target_ref_name')(
         200, 'Example Pull Request', 'Desc of PR', ref, 'bookmark', ref, 'Branch')
 
     source_repo = target_repo = collections.namedtuple('Repo',
         'type, repo_name')(
         'hg', 'pull_request_1')
 
     kwargs = {
         'user': '<[e-mail]> Marcin Kuzminski',
         'pull_request': pr,
         'pull_request_commits': [],
 
         'pull_request_target_repo': target_repo,
         'pull_request_target_repo_url': 'x',
 
         'pull_request_source_repo': source_repo,
         'pull_request_source_repo_url': 'x',
 
         'pull_request_url': 'http://localhost/pr1',
     }
 
     subject, headers, body, body_plaintext = EmailNotificationModel().render_email(
         EmailNotificationModel.TYPE_PULL_REQUEST, **kwargs)
 
     # subject
     assert subject == 'Marcin Kuzminski wants you to review pull request #200: "Example Pull Request"'
+
+
[e-mail]('mention', [
+    True,
+    False
+])
[e-mail]('email_type', [
+    EmailNotificationModel.TYPE_COMMIT_COMMENT,
+    EmailNotificationModel.TYPE_PULL_REQUEST_COMMENT
+])
+def test_render_comment_subject_no_newlines(pylonsapp, mention, email_type):
+    ref = collections.namedtuple('Ref',
+        'name, type')(
+        'fxies123', 'book'
+        )
+
+    pr = collections.namedtuple('PullRequest',
+        'pull_request_id, title, description, source_ref_parts, source_ref_name, target_ref_parts, target_ref_name')(
+        200, 'Example Pull Request', 'Desc of PR', ref, 'bookmark', ref, 'Branch')
+
+    source_repo = target_repo = collections.namedtuple('Repo',
+        'type, repo_name')(
+        'hg', 'pull_request_1')
+
+    kwargs = {
+        'user': '<[e-mail]> Marcin Kuzminski',
+        'commit': AttributeDict(raw_id='a'*40, message='Commit message'),
+        'status_change': 'approved',
+        'commit_target_repo': AttributeDict(),
+        'repo_name': 'test-repo',
+        'comment_file': 'test-file.py',
+        'comment_line': 'n100',
+        'comment_type': 'note',
+        'commit_comment_url': 'http://comment-url',
+        'instance_url': 'http://rc-instance',
+        'comment_body': 'hello world',
+        'mention': mention,
+
+        'pr_comment_url': 'http://comment-url',
+        'pr_source_repo': AttributeDict(repo_name='foobar'),
+        'pr_source_repo_url': 'http://soirce-repo/url',
+        'pull_request': pr,
+        'pull_request_commits': [],
+
+        'pull_request_target_repo': target_repo,
+        'pull_request_target_repo_url': 'x',
+
+        'pull_request_source_repo': source_repo,
+        'pull_request_source_repo_url': 'x',
+    }
+    subject, headers, body, body_plaintext = EmailNotificationModel().render_email(
+        email_type, **kwargs)
+
+    assert '\n' not in subject