[11.0] Add module mail_browser_view

mail_browser_view/README.rst

@@ -0,0 +1,104 @@
+=================
+Mail Browser View
+=================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github
+    :target: https://github.com/OCA/social/tree/11.0/mail_browser_view
+    :alt: OCA/social
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/social-11-0/social-11-0-mail_browser_view
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/205/11.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+This module enables you to add a link in your mail templates,
+so the users can view the resulting email in the browser in case
+they are badly displayed in their clients.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+You can configure an expiration time (in hours) by going to
+*Settings > Technical > System Parameters*
+and changing the value for `mail_browser_view.token_expiration_hours`.
+
+Any zero or negative values will disable the token expiration.
+Default value is 720 hours (1 month).
+
+Usage
+=====
+
+Upon module installation, a secure token will be generated for each mail,
+allowing it to be reached *via* a constructed URL.
+You can then put the following placeholder::
+
+    <a href="#" class="view_in_browser_url">View this mail in browser</a>
+
+anywhere in your mail templates (of course, the link text can be changed).
+If you use templates not managed through Odoo editor, it is strongly advised
+to use the `mail_inline_style` module so the styles do not get messed up.
+
+Be aware that this feature will not work for templates
+having "Auto-Delete" value set to `True`.
+To avoid any unwanted 404 errors, all the placeholders within such templates
+will be removed automatically in the generated mails.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/social/issues/new?body=module:%20mail_browser_view%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Camptocamp
+
+Contributors
+~~~~~~~~~~~~
+
+* Simone Orsi <simone.orsi@camptocamp.com>
+* Patrick Tombez <patrick.tombez@camptocamp.com>
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/social <https://github.com/OCA/social/tree/11.0/mail_browser_view>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

mail_browser_view/__init__.py

@@ -0,0 +1,2 @@
+from . import controllers
+from . import models

mail_browser_view/__manifest__.py

@@ -0,0 +1,23 @@
+# Copyright 2018 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+{
+    "name": "Mail Browser View",
+    "summary": "Add 'View this email in browser' feature",
+    "version": "11.0.1.0.0",
+    "category": "Social Network",
+    "website": "https://github.com/OCA/social",
+    "author": "Camptocamp, Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "application": False,
+    "installable": True,
+    "depends": [
+        "mail",
+    ],
+    "data": [
+        "data/ir_config.xml",
+    ],
+    "demo": [
+        "demo/mail.xml",
+    ]
+}

mail_browser_view/controllers/__init__.py

@@ -0,0 +1 @@
+from . import browser_view

mail_browser_view/controllers/browser_view.py

@@ -0,0 +1,16 @@
+# Copyright 2018 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html)
+
+from odoo import http
+from odoo.http import request
+
+
+class EmailBrowserViewController(http.Controller):
+
+    @http.route(['/email/view/<string:token>'],
+                type='http', auth='public', website=True)
+    def email_view(self, token, **kwargs):
+        record = request.env['mail.mail'].get_record_for_token(token)
+        if not record:
+            return request.not_found()
+        return request.make_response(record.body_html)

mail_browser_view/data/ir_config.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo noupdate="1">
+  <record id="token_expiration_hours" model="ir.config_parameter">
+    <field name="key">mail_browser_view.token_expiration_hours</field>
+    <field name="value">720</field>
+  </record>
+</odoo>

mail_browser_view/demo/mail.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<odoo>
+  <data>
+    <record id="browser_view_demo" model="mail.mail">
+      <field name="body_html">
+<![CDATA[
+<html>
+  <body>
+    <p>Here is placeholder example:</p>
+    <a href="#" class="view_in_browser_url">View this mail in browser</a>
+    <p>For everything else, there is <a href="https://www.google.com">Google</a></p>
+  <body>
+</html>
+]]>
+      </field>
+    </record>
+  </data>
+</odoo>

mail_browser_view/models/__init__.py

@@ -0,0 +1 @@
+from . import mail_mail

mail_browser_view/models/mail_mail.py

@@ -0,0 +1,136 @@
+# Copyright 2018 Camptocamp
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+from odoo import api, models, fields
+from odoo.exceptions import MissingError
+from uuid import uuid4
+from base64 import urlsafe_b64encode, urlsafe_b64decode
+import binascii
+import lxml
+from werkzeug.urls import url_parse
+from datetime import date
+from dateutil.relativedelta import relativedelta
+
+
+class Mail(models.Model):
+    _inherit = 'mail.mail'
+
+    access_token = fields.Char(
+        'Security Token',
+        compute="_compute_access_token",
+        store=True, readonly=True
+    )
+    view_in_browser_url = fields.Char(
+        'View URL',
+        compute="_compute_browser_url"
+    )
+    is_token_alive = fields.Boolean(
+        "Is Token alive",
+        compute="_compute_token_alive"
+    )
+
+    @api.model
+    def create(self, vals):
+        rec = super(Mail, self).create(vals)
+        rec._replace_view_url()
+        return rec
+
+    @api.model
+    def get_record_for_token(self, token):
+        """Parse the URL token to get the matching record.
+
+        The token is a base 64 encoded string containing:
+            * 32 positions access token
+            * Record ID
+        Returns a record matching the token or empty recordset if not found
+        """
+        try:
+            token = urlsafe_b64decode(token).decode()
+            access_token, rec_id = token[:32], token[32:]
+            rec = self.sudo().search([
+                ('id', '=', int(rec_id)),
+                ('access_token', '=', access_token)
+            ])
+            res = rec.is_token_alive and rec
+        except (ValueError, MissingError, binascii.Error):
+            res = False
+        finally:
+            return res or self.browse()
+
+    @api.multi
+    def _get_full_url(self):
+        self.ensure_one()
+        base_url = self.env['ir.config_parameter'].sudo().get_param(
+            'web.base.url')
+        base = url_parse(base_url)
+
+        return url_parse(
+            self.view_in_browser_url or '#'
+        ).replace(
+            scheme=base.scheme, netloc=base.netloc
+        ).to_url()
+
+    @api.multi
+    def _replace_view_url(self):
+        """Replace placeholders with record URL.
+
+        Replace the 'href' attribute of all `<a></a>` tags
+        having the 'class' attribute equal to 'view_in_browser_url'
+        with the URL generated for this mail.mail record
+        inside the rendered 'body_html' from the template.
+        In case the value `auto_delete` for the record is `True`,
+        the placeholders will be removed.
+        """
+        self.ensure_one()
+
+        root_html = lxml.html.fromstring(self.body_html)
+        link_nodes = root_html.xpath("//a[hasclass('view_in_browser_url')]")
+
+        if link_nodes:
+            if self.auto_delete:
+                for node in link_nodes:
+                    node.drop_tree()
+            else:
+                full_url = self._get_full_url()
+                for node in link_nodes:
+                    node.set('href', full_url)
+
+            self.body_html = lxml.html.tostring(
+                root_html,
+                pretty_print=False,
+                method='html',
+                encoding='unicode'
+            )
+
+    @api.depends('create_date')
+    def _compute_access_token(self):
+        for rec in self:
+            rec.access_token = uuid4().hex
+
+    @api.depends('access_token')
+    def _compute_browser_url(self):
+        for rec in self:
+            url_token = urlsafe_b64encode(
+                (rec.access_token + str(rec.id)).encode()
+            ).decode()
+            rec.view_in_browser_url = '/email/view/{}'.format(url_token)
+
+    @api.depends('mail_message_id',
+                 'mail_message_id.date')
+    def _compute_token_alive(self):
+        expiration_time = int(
+            self.env['ir.config_parameter'].sudo().get_param(
+                'mail_browser_view.token_expiration_hours'
+            ) or '0'
+        )
+        if expiration_time > 0:
+            max_delta = relativedelta(hours=expiration_time)
+            for rec in self:
+                mail_date = fields.Datetime.from_string(
+                    rec.mail_message_id.date
+                )
+                rec.is_token_alive = (
+                    (mail_date + max_delta).date() >= date.today()
+                )
+        else:
+            self.update({'is_token_alive': True})

mail_browser_view/readme/CONFIGURE.rst

@@ -0,0 +1,6 @@
+You can configure an expiration time (in hours) by going to
+*Settings > Technical > System Parameters*
+and changing the value for `mail_browser_view.token_expiration_hours`.
+
+Any zero or negative values will disable the token expiration.
+Default value is 720 hours (1 month).

mail_browser_view/readme/CONTRIBUTORS.rst

@@ -0,0 +1,2 @@
+* Simone Orsi <simone.orsi@camptocamp.com>
+* Patrick Tombez <patrick.tombez@camptocamp.com>

mail_browser_view/readme/DESCRIPTION.rst

@@ -0,0 +1,3 @@
+This module enables you to add a link in your mail templates,
+so the users can view the resulting email in the browser in case
+they are badly displayed in their clients.

mail_browser_view/readme/USAGE.rst

@@ -0,0 +1,14 @@
+Upon module installation, a secure token will be generated for each mail,
+allowing it to be reached *via* a constructed URL.
+You can then put the following placeholder::
+
+    <a href="#" class="view_in_browser_url">View this mail in browser</a>
+
+anywhere in your mail templates (of course, the link text can be changed).
+If you use templates not managed through Odoo editor, it is strongly advised
+to use the `mail_inline_style` module so the styles do not get messed up.
+
+Be aware that this feature will not work for templates
+having "Auto-Delete" value set to `True`.
+To avoid any unwanted 404 errors, all the placeholders within such templates
+will be removed automatically in the generated mails.

mail_browser_view/static/description/index.html

@@ -0,0 +1,448 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
+<title>Mail Browser View</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+  text-align: left }
+
+.align-center {
+  clear: both ;
+  text-align: center }
+
+.align-right {
+  text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+
+/* div.align-center * { */
+/*   text-align: left } */
+
+.align-top    {
+  vertical-align: top }
+
+.align-middle {
+  vertical-align: middle }
+
+.align-bottom {
+  vertical-align: bottom }
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+  border: 0px;
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+  border-collapse: collapse;
+}
+table.docutils.booktabs * {
+  border: 0px;
+}
+table.docutils.booktabs th {
+  border-bottom: thin solid;
+  text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+ul.auto-toc {
+  list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="mail-browser-view">
+<h1 class="title">Mail Browser View</h1>
+
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! This file is generated by oca-gen-addon-readme !!
+!! changes will be overwritten.                   !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/social/tree/11.0/mail_browser_view"><img alt="OCA/social" src="https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/social-11-0/social-11-0-mail_browser_view"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/205/11.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
+<p>This module enables you to add a link in your mail templates,
+so the users can view the resulting email in the browser in case
+they are badly displayed in their clients.</p>
+<p><strong>Table of contents</strong></p>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
+<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="section" id="configuration">
+<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
+<p>You can configure an expiration time (in hours) by going to
+<em>Settings &gt; Technical &gt; System Parameters</em>
+and changing the value for <cite>mail_browser_view.token_expiration_hours</cite>.</p>
+<p>Any zero or negative values will disable the token expiration.
+Default value is 720 hours (1 month).</p>
+</div>
+<div class="section" id="usage">
+<h1><a class="toc-backref" href="#id2">Usage</a></h1>
+<p>Upon module installation, a secure token will be generated for each mail,
+allowing it to be reached <em>via</em> a constructed URL.
+You can then put the following placeholder:</p>
+<pre class="literal-block">
+&lt;a href=&quot;#&quot; class=&quot;view_in_browser_url&quot;&gt;View this mail in browser&lt;/a&gt;
+</pre>
+<p>anywhere in your mail templates (of course, the link text can be changed).
+If you use templates not managed through Odoo editor, it is strongly advised
+to use the <cite>mail_inline_style</cite> module so the styles do not get messed up.</p>
+<p>Be aware that this feature will not work for templates
+having “Auto-Delete” value set to <cite>True</cite>.
+To avoid any unwanted 404 errors, all the placeholders within such templates
+will be removed automatically in the generated mails.</p>
+</div>
+<div class="section" id="bug-tracker">
+<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
+<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/social/issues">GitHub Issues</a>.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+<a class="reference external" href="https://github.com/OCA/social/issues/new?body=module:%20mail_browser_view%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<p>Do not contact contributors directly about support or help with technical issues.</p>
+</div>
+<div class="section" id="credits">
+<h1><a class="toc-backref" href="#id4">Credits</a></h1>
+<div class="section" id="authors">
+<h2><a class="toc-backref" href="#id5">Authors</a></h2>
+<ul class="simple">
+<li>Camptocamp</li>
+</ul>
+</div>
+<div class="section" id="contributors">
+<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
+<ul class="simple">
+<li>Simone Orsi &lt;<a class="reference external" href="mailto:simone.orsi&#64;camptocamp.com">simone.orsi&#64;camptocamp.com</a>&gt;</li>
+<li>Patrick Tombez &lt;<a class="reference external" href="mailto:patrick.tombez&#64;camptocamp.com">patrick.tombez&#64;camptocamp.com</a>&gt;</li>
+</ul>
+</div>
+<div class="section" id="maintainers">
+<h2><a class="toc-backref" href="#id7">Maintainers</a></h2>
+<p>This module is maintained by the OCA.</p>
+<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
+<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/social/tree/11.0/mail_browser_view">OCA/social</a> project on GitHub.</p>
+<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
+</div>
+</div>
+</div>
+</body>
+</html>

mail_browser_view/tests/__init__.py

@@ -0,0 +1 @@
+from . import test_mail_browser_view

mail_browser_view/tests/test_mail_browser_view.py

@@ -0,0 +1,95 @@
+# Copyright 2018 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html)
+
+from odoo.tests.common import SavepointCase
+from odoo import fields
+from base64 import urlsafe_b64encode
+from datetime import datetime
+from lxml import html
+from werkzeug.urls import url_parse
+from ..controllers.browser_view import EmailBrowserViewController
+from mock import patch
+
+
+class MailBrowserView(SavepointCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super(MailBrowserView, cls).setUpClass()
+        cls.mail = cls.env['mail.mail']
+        cls.mail0 = cls.env.ref('mail_browser_view.browser_view_demo')
+        cls.valid_token = cls.mail0.view_in_browser_url.split('/')[-1]
+
+    def _forge_token(self, access_token, rec_id):
+        return urlsafe_b64encode(
+            (access_token + str(rec_id)).encode()
+        ).decode()
+
+    def _test_token(self, token, expected_result):
+        rec = self.mail.get_record_for_token(token)
+        self.assertEqual(rec, expected_result)
+
+    def test_mail_browser_view(self):
+        self._test_token(self.valid_token, self.mail0)
+
+    def test_invalid_b64(self):
+        self._test_token(self.valid_token[::2], self.mail)
+
+    def test_invalid_access_token(self):
+        bad_token = self._forge_token('0000000', self.mail0.id)
+        self._test_token(bad_token, self.mail)
+
+    def test_nonexistent_id(self):
+        bad_token = self._forge_token(self.mail0.access_token, 999999)
+        self._test_token(bad_token, self.mail)
+
+    def test_token_expiration(self):
+        self.mail0.mail_message_id.date = fields.Datetime.to_string(
+            datetime.fromtimestamp(0)
+        )
+        self._test_token(self.valid_token, self.mail)
+
+        self.env.ref('mail_browser_view.token_expiration_hours').value = '0'
+        self.mail0.refresh()
+        self._test_token(self.valid_token, self.mail0)
+
+    def test_html_render(self):
+        html_node = html.fromstring(self.mail0.body_html)
+        link_node = html_node.xpath("//a[hasclass('view_in_browser_url')]")
+        self.assertEqual(
+            url_parse(link_node[0].get('href')).path,
+            self.mail0.view_in_browser_url
+        )
+
+        self.mail0.auto_delete = True
+        self.mail0._replace_view_url()
+        self.mail0.refresh()
+        html_node = html.fromstring(self.mail0.body_html)
+
+        link_node = html_node.xpath("//a[hasclass('view_in_browser_url')]")
+        self.assertEqual(link_node, [])
+
+        link_node = html_node.xpath(
+            "//a[not(hasclass('view_in_browser_url'))]"
+        )
+        self.assertEqual(len(link_node), 1)
+        self.assertEqual(link_node[0].get('href'), 'https://www.google.com')
+
+        p_node = html_node.xpath("//p")
+        self.assertEqual(len(p_node), 2)
+
+    @patch('odoo.addons.mail_browser_view.'
+           'controllers.browser_view.request')
+    def test_controller(self, req):
+        # Mock
+        req.env = self.env
+        controller = EmailBrowserViewController()
+
+        controller.email_view(self.valid_token[::2])
+        req.not_found.assert_called_once_with()
+        req.make_response.assert_not_called()
+        req.reset_mock()
+
+        controller.email_view(self.valid_token)
+        req.not_found.assert_not_called()
+        req.make_response.assert_called_with(self.mail0.body_html)