status_change=None, closing_pr=False):

        """

        :returns: tuple (subj,body,recipients,notification_type,email_kwargs)

        """

        # make notification

        body = comment_text  # text of the comment

        line = ''

        if line_no:

            line = _('on line %s') % line_no

        # changeset

        if revision:

            notification_type = NotificationModel.TYPE_CHANGESET_COMMENT

            cs = repo.scm_instance.get_changeset(revision)

            desc = cs.short_id

            threading = ['%s-rev-%s@%s' % (repo.repo_name, revision, h.canonical_hostname())]

            if line_no: # TODO: url to file _and_ line number

                threading.append('%s-rev-%s-line-%s@%s' % (repo.repo_name, revision, line_no,

                                                           h.canonical_hostname()))

            comment_url = h.canonical_url('changeset_home',

                repo_name=repo.repo_name,

                revision=revision,

                anchor='comment-%s' % comment.comment_id)

            subj = h.link_to(

                'Re changeset: %(desc)s %(line)s' %

                          {'desc': desc, 'line': line},

                 comment_url)

            # get the current participants of this changeset

            recipients = _list_changeset_commenters(revision)

            # add changeset author if it's known locally

            cs_author = User.get_from_cs_author(cs.author)

            if not cs_author:

                # use repo owner if we cannot extract the author correctly

                # FIXME: just use committer name even if not a user

                cs_author = repo.owner

            recipients.append(cs_author)

            email_kwargs = {

                'status_change': status_change,

                'cs_comment_user': author.full_name_and_username,

                'cs_target_repo': h.canonical_url('summary_home', repo_name=repo.repo_name),

                'cs_comment_url': comment_url,

                'cs_url': h.canonical_url('changeset_home', repo_name=repo.repo_name, revision=revision),

                'raw_id': revision,

                'message': cs.message,

                'message_short': h.shorter(cs.message, 50, firstline=True),

                'cs_author': cs_author,

                'repo_name': repo.repo_name,

                'short_id': h.short_id(revision),

                'branch': cs.branch,

                'comment_username': author.username,

                'threading': threading,

            }

        # pull request

        elif pull_request:

            notification_type = NotificationModel.TYPE_PULL_REQUEST_COMMENT

            desc = comment.pull_request.title

            _org_ref_type, org_ref_name, _org_rev = comment.pull_request.org_ref.split(':')

            _other_ref_type, other_ref_name, _other_rev = comment.pull_request.other_ref.split(':')

            threading = ['%s-pr-%s@%s' % (pull_request.other_repo.repo_name,

                                          pull_request.pull_request_id,

                                          h.canonical_hostname())]

            if line_no: # TODO: url to file _and_ line number

                threading.append('%s-pr-%s-line-%s@%s' % (pull_request.other_repo.repo_name,

                                                          pull_request.pull_request_id, line_no,

                                                          h.canonical_hostname()))

            comment_url = pull_request.url(canonical=True,

                anchor='comment-%s' % comment.comment_id)

            subj = h.link_to(

                'Re pull request %(pr_nice_id)s: %(desc)s %(line)s' %

                          {'desc': desc,

                           'pr_nice_id': comment.pull_request.nice_id(),

                           'line': line},

                comment_url)

            # get the current participants of this pull request

            recipients = _list_pull_request_commenters(pull_request)

            recipients.append(pull_request.owner)

            recipients += pull_request.get_reviewer_users()

            # set some variables for email notification

            email_kwargs = {

                'pr_title': pull_request.title,

                'pr_title_short': h.shorter(pull_request.title, 50),

                'pr_nice_id': pull_request.nice_id(),

                'status_change': status_change,

                'closing_pr': closing_pr,

                'pr_comment_url': comment_url,

                'pr_url': pull_request.url(canonical=True),

                'pr_comment_user': author.full_name_and_username,

                'pr_target_repo': h.canonical_url('summary_home',

                                   repo_name=pull_request.other_repo.repo_name),

                'pr_target_branch': other_ref_name,

                'pr_source_repo': h.canonical_url('summary_home',

                                   repo_name=pull_request.org_repo.repo_name),

                'pr_source_branch': org_ref_name,

        html_kwargs.update(email_kwargs)

        txt_kwargs.update(email_kwargs)

        email_subject = EmailNotificationModel() \

                            .get_email_description(type_, **txt_kwargs)

        email_txt_body = EmailNotificationModel() \

                            .get_email_tmpl(type_, 'txt', **txt_kwargs)

        email_html_body = EmailNotificationModel() \

                            .get_email_tmpl(type_, 'html', **html_kwargs)

        # don't send email to the person who caused the notification, except for

        # notifications about new pull requests where the author is explicitly

        # added.

        rec_mails = set(obj.email for obj in recipients_objs)

        if type_ == NotificationModel.TYPE_PULL_REQUEST:

            rec_mails.add(created_by_obj.email)

        else:

            rec_mails.discard(created_by_obj.email)

        # send email with notification to participants

        for rec_mail in sorted(rec_mails):

            tasks.send_email([rec_mail], email_subject, email_txt_body,

                     email_html_body, headers,

                     from_name=created_by_obj.full_name_or_username)

class EmailNotificationModel(object):

    TYPE_CHANGESET_COMMENT = NotificationModel.TYPE_CHANGESET_COMMENT

    TYPE_MESSAGE = NotificationModel.TYPE_MESSAGE # only used for testing

    # NotificationModel.TYPE_MENTION is not used

    TYPE_PASSWORD_RESET = 'password_link'

    TYPE_REGISTRATION = NotificationModel.TYPE_REGISTRATION

    TYPE_PULL_REQUEST = NotificationModel.TYPE_PULL_REQUEST

    TYPE_PULL_REQUEST_COMMENT = NotificationModel.TYPE_PULL_REQUEST_COMMENT

    TYPE_DEFAULT = 'default'

    def __init__(self):

        super(EmailNotificationModel, self).__init__()

        self._tmpl_lookup = app_globals.mako_lookup

        self.email_types = {

            self.TYPE_CHANGESET_COMMENT: 'changeset_comment',

            self.TYPE_PASSWORD_RESET: 'password_reset',

            self.TYPE_REGISTRATION: 'registration',

            self.TYPE_DEFAULT: 'default',

            self.TYPE_PULL_REQUEST: 'pull_request',

            self.TYPE_PULL_REQUEST_COMMENT: 'pull_request_comment',

        }

        self._subj_map = {

            self.TYPE_MESSAGE: 'Test Message',

            # self.TYPE_PASSWORD_RESET

            self.TYPE_REGISTRATION: _('New user %(new_username)s registered'),

            # self.TYPE_DEFAULT

            self.TYPE_PULL_REQUEST: _('[Review] %(repo_name)s PR %(pr_nice_id)s "%(pr_title_short)s" from %(pr_source_branch)s by %(pr_owner_username)s'),

            self.TYPE_PULL_REQUEST_COMMENT: _('[Comment] %(repo_name)s PR %(pr_nice_id)s "%(pr_title_short)s" from %(pr_source_branch)s by %(pr_owner_username)s'),

        }

    def get_email_description(self, type_, **kwargs):

        """

        return subject for email based on given type

        """

        tmpl = self._subj_map[type_]

        try:

            subj = tmpl % kwargs

        except KeyError as e:

            log.error('error generating email subject for %r from %s: %s', type_, ', '.join(self._subj_map), e)

            raise

        # gmail doesn't do proper threading but will ignore leading square

        # bracket content ... so that is where we put status info

        bracket_tags = []

        status_change = kwargs.get('status_change')

        if status_change:

            bracket_tags.append(str(status_change))  # apply str to evaluate LazyString before .join

        if kwargs.get('closing_pr'):

            bracket_tags.append(_('Closing'))

        if bracket_tags:

            if subj.startswith('['):

                subj = '[' + ', '.join(bracket_tags) + ': ' + subj[1:]

            else:

                subj = '[' + ', '.join(bracket_tags) + '] ' + subj

        return subj

    def get_email_tmpl(self, type_, content_type, **kwargs):

        """

        return generated template for email based on given type

        """

        base = 'email_templates/' + self.email_types.get(type_, self.email_types[self.TYPE_DEFAULT]) + '.' + content_type

        email_template = self._tmpl_lookup.get_template(base)

        # translator and helpers inject

        _kwargs = {'_': _,

                   'h': h,

                   'c': c}

        _kwargs.update(kwargs)

        if content_type == 'html':

            _kwargs.update({

                "color_text": "#202020",

<!doctype html>

<html lang="en">

<head><title>Notifications</title><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head>

<body>

<hr/>

<h1>cs_comment, is_mention=False, status_change=None</h1>

<pre>

From: u1 u1 <name@example.com>

To: u2@example.com

</pre>

<hr/>

<pre>http://comment.org

Comment on Changeset "This changeset did something clever which is hard to explain"

Opinionated User (jsmith):

This is the new 'comment'.

 - and here it ends indented.

Changeset on http://example.com/repo_target branch brunch:

"This changeset did something clever which is hard to explain" by u2 u3 (u2).

View Comment: http://comment.org

</pre>

<hr/>

<!--!doctype html-->

<!--html lang="en"-->

<!--head-->

    <!--title--><!--/title-->

    <!--meta name="viewport" content="width=device-width"-->

    <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"-->

<!--/head-->

<!--body-->

<table align="center" cellpadding="0" cellspacing="0" border="0" style="min-width:348px;max-width:800px;font-family:Helvetica,Arial,sans-serif;font-weight:200;font-size:14px;line-height:17px;color:#202020">

    <tr>

        <td width="30px" style="width:30px"></td>

        <td>

            <table width="100%" cellpadding="0" cellspacing="0" border="0"

                   style="table-layout:fixed;font-family:Helvetica,Arial,sans-serif;border:1px solid #ddd">

                <tr><td width="30px" style="width:30px"></td><td></td><td width="30px" style="width:30px"></td></tr>

                <tr>

                    <td colspan="3">

<table bgcolor="#f9f9f9" width="100%" cellpadding="0" cellspacing="0"

       style="border-bottom:1px solid #ddd">

    <tr>

        <td height="20px" style="height:20px" colspan="3"></td>

    </tr>

    <tr>

        <td width="30px" style="width:30px"></td>

        <td style="font-family:Helvetica,Arial,sans-serif;font-size:19px;line-height:24px">

            <a style="text-decoration:none;font-weight:600;color:#395fa0" href="http://comment.org"

               target="_blank">Comment on Changeset &#34;This changeset did something clever which is hard to explain&#34;</a>

                   href="http://changeset.com">This changeset did something clever which is hard to explain</a>"

                by

                <span style="border:#ddd 1px solid;background:#f9f9f9">u2 u3 (u2)</span>.

            </div>

        </td>

    </tr>

    <tr>

        <td>

<center>

    <table cellspacing="0" cellpadding="0" style="margin-left:auto;margin-right:auto">

        <tr>

            <td height="25px" style="height:25px"></td>

        </tr>

        <tr>

            <td style="border-collapse:collapse;border-radius:2px;text-align:center;display:block;border:solid 1px #395fa0;padding:11px 20px 11px 20px">

                <a href="http://comment.org" style="text-decoration:none;display:block" target="_blank">

                    <center>

                        <font size="3">

                            <span style="font-family:Helvetica,Arial,sans-serif;font-weight:700;font-size:15px;line-height:14px;color:#395fa0;white-space:nowrap;vertical-align:middle">View Comment</span>

                        </font>

                    </center>

                </a>

            </td>

        </tr>

    </table>

</center>

        </td>

    </tr>

</table>

                    </td>

                    <td></td>

                </tr>

                <tr>

                    <td height="30px" style="height:30px" colspan="3"></td>

                </tr>

            </table>

        </td>

        <td width="30px" style="width:30px"></td>

    </tr>

</table>

<!--/body-->

<!--/html-->

<hr/>

<hr/>

<h1>cs_comment, is_mention=True, status_change=None</h1>

<pre>

From: u1 u1 <name@example.com>

To: u2@example.com

</pre>

<hr/>

<pre>http://comment.org

Mention in Comment on Changeset "This changeset did something clever which is hard to explain"

Opinionated User (jsmith):

This is the new 'comment'.

 - and here it ends indented.

Changeset on http://example.com/repo_target branch brunch:

"This changeset did something clever which is hard to explain" by u2 u3 (u2).

View Comment: http://comment.org

</pre>

<hr/>

<!--!doctype html-->

<!--html lang="en"-->

<!--head-->

    <!--title--><!--/title-->

    <!--meta name="viewport" content="width=device-width"-->

    <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"-->

<!--/head-->

<!--body-->

<table align="center" cellpadding="0" cellspacing="0" border="0" style="min-width:348px;max-width:800px;font-family:Helvetica,Arial,sans-serif;font-weight:200;font-size:14px;line-height:17px;color:#202020">

    <tr>

        <td width="30px" style="width:30px"></td>

        <td>

            <table width="100%" cellpadding="0" cellspacing="0" border="0"

                   style="table-layout:fixed;font-family:Helvetica,Arial,sans-serif;border:1px solid #ddd">

                <tr><td width="30px" style="width:30px"></td><td></td><td width="30px" style="width:30px"></td></tr>

                <tr>

                    <td colspan="3">

<table bgcolor="#f9f9f9" width="100%" cellpadding="0" cellspacing="0"

       style="border-bottom:1px solid #ddd">

    <tr>

        <td height="20px" style="height:20px" colspan="3"></td>

    </tr>

    <tr>

        <td width="30px" style="width:30px"></td>

        <td style="font-family:Helvetica,Arial,sans-serif;font-size:19px;line-height:24px">

            <a style="text-decoration:none;font-weight:600;color:#395fa0" href="http://comment.org"

               target="_blank">Mention in Comment on Changeset &#34;This changeset did something clever which is hard to explain&#34;</a>

                   href="http://changeset.com">This changeset did something clever which is hard to explain</a>"

                by

                <span style="border:#ddd 1px solid;background:#f9f9f9">u2 u3 (u2)</span>.

            </div>

        </td>

    </tr>

    <tr>

        <td>

<center>

    <table cellspacing="0" cellpadding="0" style="margin-left:auto;margin-right:auto">

        <tr>

            <td height="25px" style="height:25px"></td>

        </tr>

        <tr>

            <td style="border-collapse:collapse;border-radius:2px;text-align:center;display:block;border:solid 1px #395fa0;padding:11px 20px 11px 20px">

                <a href="http://comment.org" style="text-decoration:none;display:block" target="_blank">

                    <center>

                        <font size="3">

                            <span style="font-family:Helvetica,Arial,sans-serif;font-weight:700;font-size:15px;line-height:14px;color:#395fa0;white-space:nowrap;vertical-align:middle">View Comment</span>

                        </font>

                    </center>

                </a>

            </td>

        </tr>

    </table>

</center>

        </td>

    </tr>

</table>

                    </td>

                    <td></td>

                </tr>

                <tr>

                    <td height="30px" style="height:30px" colspan="3"></td>

                </tr>

            </table>

        </td>

        <td width="30px" style="width:30px"></td>

    </tr>

</table>

<!--/body-->

<!--/html-->

<hr/>

<hr/>

<h1>cs_comment, is_mention=False, status_change='Approved'</h1>

<pre>

From: u1 u1 <name@example.com>

To: u2@example.com

</pre>

<hr/>

<pre>http://comment.org

Comment on Changeset "This changeset did something clever which is hard to explain"

Opinionated User (jsmith):

Status change: Approved

This is the new 'comment'.

 - and here it ends indented.

Changeset on http://example.com/repo_target branch brunch:

"This changeset did something clever which is hard to explain" by u2 u3 (u2).

View Comment: http://comment.org

</pre>

<hr/>

<!--!doctype html-->

<!--html lang="en"-->

<!--head-->

    <!--title--><!--/title-->

    <!--meta name="viewport" content="width=device-width"-->

    <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"-->

<!--/head-->

<!--body-->

<table align="center" cellpadding="0" cellspacing="0" border="0" style="min-width:348px;max-width:800px;font-family:Helvetica,Arial,sans-serif;font-weight:200;font-size:14px;line-height:17px;color:#202020">

    <tr>

        <td width="30px" style="width:30px"></td>

        <td>

            <table width="100%" cellpadding="0" cellspacing="0" border="0"

                   style="table-layout:fixed;font-family:Helvetica,Arial,sans-serif;border:1px solid #ddd">

                <tr><td width="30px" style="width:30px"></td><td></td><td width="30px" style="width:30px"></td></tr>

                <tr>

                    <td colspan="3">

<table bgcolor="#f9f9f9" width="100%" cellpadding="0" cellspacing="0"

       style="border-bottom:1px solid #ddd">

    <tr>

        <td height="20px" style="height:20px" colspan="3"></td>

    </tr>

    <tr>

        <td width="30px" style="width:30px"></td>

        <td style="font-family:Helvetica,Arial,sans-serif;font-size:19px;line-height:24px">

                   href="http://changeset.com">This changeset did something clever which is hard to explain</a>"

                by

                <span style="border:#ddd 1px solid;background:#f9f9f9">u2 u3 (u2)</span>.

            </div>

        </td>

    </tr>

    <tr>

        <td>

<center>

    <table cellspacing="0" cellpadding="0" style="margin-left:auto;margin-right:auto">

        <tr>

            <td height="25px" style="height:25px"></td>

        </tr>

        <tr>

            <td style="border-collapse:collapse;border-radius:2px;text-align:center;display:block;border:solid 1px #395fa0;padding:11px 20px 11px 20px">

                <a href="http://comment.org" style="text-decoration:none;display:block" target="_blank">

                    <center>

                        <font size="3">

                            <span style="font-family:Helvetica,Arial,sans-serif;font-weight:700;font-size:15px;line-height:14px;color:#395fa0;white-space:nowrap;vertical-align:middle">View Comment</span>

                        </font>

                    </center>

                </a>

            </td>

        </tr>

    </table>

</center>

        </td>

    </tr>

</table>

                    </td>

                    <td></td>

                </tr>

                <tr>

                    <td height="30px" style="height:30px" colspan="3"></td>

                </tr>

            </table>

        </td>

        <td width="30px" style="width:30px"></td>

    </tr>

</table>

<!--/body-->

<!--/html-->

<hr/>

<hr/>

<h1>cs_comment, is_mention=True, status_change='Approved'</h1>

<pre>

From: u1 u1 <name@example.com>

To: u2@example.com

</pre>

<hr/>

<pre>http://comment.org

Mention in Comment on Changeset "This changeset did something clever which is hard to explain"

Opinionated User (jsmith):

Status change: Approved

This is the new 'comment'.

 - and here it ends indented.

Changeset on http://example.com/repo_target branch brunch:

"This changeset did something clever which is hard to explain" by u2 u3 (u2).

View Comment: http://comment.org

</pre>

<hr/>

<!--!doctype html-->

<!--html lang="en"-->

<!--head-->

    <!--title--><!--/title-->

    <!--meta name="viewport" content="width=device-width"-->

    <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"-->

<!--/head-->

<!--body-->

<table align="center" cellpadding="0" cellspacing="0" border="0" style="min-width:348px;max-width:800px;font-family:Helvetica,Arial,sans-serif;font-weight:200;font-size:14px;line-height:17px;color:#202020">

    <tr>

        <td width="30px" style="width:30px"></td>

        <td>

            <table width="100%" cellpadding="0" cellspacing="0" border="0"

                   style="table-layout:fixed;font-family:Helvetica,Arial,sans-serif;border:1px solid #ddd">

                <tr><td width="30px" style="width:30px"></td><td></td><td width="30px" style="width:30px"></td></tr>

                <tr>

                    <td colspan="3">

<table bgcolor="#f9f9f9" width="100%" cellpadding="0" cellspacing="0"

       style="border-bottom:1px solid #ddd">

    <tr>

        <td height="20px" style="height:20px" colspan="3"></td>

    </tr>

    <tr>

        <td width="30px" style="width:30px"></td>

        <td style="font-family:Helvetica,Arial,sans-serif;font-size:19px;line-height:24px">

    def test_dump_html_mails(self):

        # Exercise all notification types and dump them to one big html file

        l = []

        def send_email(recipients, subject, body='', html_body='', headers=None, from_name=None):

            l.append('<hr/>\n')

            l.append('<h1>%s</h1>\n' % desc) # desc is from outer scope

            l.append('<pre>\n')

            l.append('From: %s <name@example.com>\n' % from_name)

            l.append('To: %s\n' % ' '.join(recipients))

            l.append('Subject: %s\n' % subject)

            l.append('</pre>\n')

            l.append('<hr/>\n')

            l.append('<pre>%s</pre>\n' % body)

            l.append('<hr/>\n')

            l.append(html_body)

            l.append('<hr/>\n')

        with test_context(self.app):

            with mock.patch.object(kallithea.lib.celerylib.tasks, 'send_email', send_email):

                pr_kwargs = dict(

                    pr_nice_id='#7',

                    pr_title='The Title',

                    pr_title_short='The Title',

                    pr_url='http://pr.org/7',

                    pr_target_repo='http://mainline.com/repo',

                    pr_target_branch='trunk',

                    pr_source_repo='https://dev.org/repo',

                    pr_source_branch='devbranch',

                    pr_owner=User.get(self.u2),

                    pr_owner_username='u2'

                    )

                for type_, body, kwargs in [

                        (NotificationModel.TYPE_CHANGESET_COMMENT,

                         'This is the new \'comment\'.\n\n - and here it ends indented.',

                         dict(

                            short_id='cafe1234',

                            raw_id='cafe1234c0ffeecafe',

                            branch='brunch',

                            cs_comment_user='Opinionated User (jsmith)',

                            cs_comment_url='http://comment.org',

                            is_mention=[False, True],

                            message='This changeset did something clever which is hard to explain',

                            message_short='This changeset did something cl...',

                            status_change=[None, 'Approved'],

                            cs_target_repo='http://example.com/repo_target',

                            cs_url='http://changeset.com',

                            cs_author=User.get(self.u2))),

                        (NotificationModel.TYPE_MESSAGE,

                         'This is the \'body\' of the "test" message\n - nothing interesting here except indentation.',

                         dict()),

                        #(NotificationModel.TYPE_MENTION, '$body', None), # not used

                        (NotificationModel.TYPE_REGISTRATION,

                         'Registration body',

                         dict(

                            new_username='newbie',

                            registered_user_url='http://newbie.org',

                            new_email='new@email.com',

                            new_full_name='New Full Name')),

                        (NotificationModel.TYPE_PULL_REQUEST,

                         'This PR is \'awesome\' because it does <stuff>\n - please approve indented!',

                         dict(

                            pr_user_created='Requesting User (root)', # pr_owner should perhaps be used for @mention in description ...

                            is_mention=[False, True],

                            pr_revisions=[('123abc'*7, "Introduce one and two\n\nand that's it"), ('567fed'*7, 'Make one plus two equal tree')],

                            org_repo_name='repo_org',

                            **pr_kwargs)),

                        (NotificationModel.TYPE_PULL_REQUEST_COMMENT,

                         'Me too!\n\n - and indented on second line',

                         dict(

                            closing_pr=[False, True],

                            is_mention=[False, True],

                            pr_comment_user='Opinionated User (jsmith)',

                            pr_comment_url='http://pr.org/comment',

                            status_change=[None, 'Under Review'],

                            **pr_kwargs)),

                        ]:

                    kwargs['repo_name'] = 'repo/name'

                    params = [(type_, type_, body, kwargs)]

                    for param_name in ['is_mention', 'status_change', 'closing_pr']: # TODO: inline/general

                        if not isinstance(kwargs.get(param_name), list):

                            continue

                        new_params = []

                        for v in kwargs[param_name]:

                            for desc, type_, body, kwargs in params:

                                kwargs = dict(kwargs)

                                kwargs[param_name] = v

                                new_params.append(('%s, %s=%r' % (desc, param_name, v), type_, body, kwargs))

                        params = new_params

                    for desc, type_, body, kwargs in params:

                        # desc is used as "global" variable

                        NotificationModel().create(created_by=self.u1,

                                                           subject='unused', body=body, email_kwargs=kwargs,

                                                           recipients=[self.u2], type_=type_)