[IMP] mass_mailing: remove depends to website. Create a website_mass_mailing bridge to add subscribe snippet into website builder. Split website_links to have link_tracker to create short and trackable URLs, and website_links to have a website layout for link_tracker and add button to share page.

8 files changed, 477 insertions, 0 deletions

diff --git a/addons/link_tracker/__init__.py b/addons/link_tracker/__init__.py
new file mode 100644
index 00000000000..12ce74572a7
--- /dev/null
+++ b/addons/link_tracker/__init__.py
@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+import models
+import controller
\ No newline at end of file
diff --git a/addons/link_tracker/__openerp__.py b/addons/link_tracker/__openerp__.py
new file mode 100644
index 00000000000..46b10b27942
--- /dev/null
+++ b/addons/link_tracker/__openerp__.py
@@ -0,0 +1,15 @@
+{
+    'name': 'Link Tracker',
+    'category': 'Hidden',
+    'description': """
+Create short and trackable URLs.
+=====================================================
+
+        """,
+    'version': '1.0',
+    'depends': ['marketing', 'utm'],
+    'data': [
+        'views/link_tracker.xml',
+        'security/ir.model.access.csv',
+    ],
+}
diff --git a/addons/link_tracker/controller/__init__.py b/addons/link_tracker/controller/__init__.py
new file mode 100644
index 00000000000..a84d81a791b
--- /dev/null
+++ b/addons/link_tracker/controller/__init__.py
@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+import main
diff --git a/addons/link_tracker/controller/main.py b/addons/link_tracker/controller/main.py
new file mode 100644
index 00000000000..1d7707fb65a
--- /dev/null
+++ b/addons/link_tracker/controller/main.py
@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+import werkzeug
+
+from openerp.addons.web import http
+from openerp.http import request
+
+
+class link_tracker(http.Controller):
+    @http.route('/r/<string:code>', type='http', auth='none', website=True)
+    def full_url_redirect(self, code, **post):
+        request.env['link.tracker.click'].add_click(code, request.httprequest.remote_addr, request.session['geoip'].get('country_code'), stat_id=False)
+        redirect_url = request.env['link.tracker'].get_url_from_code(code)
+        return werkzeug.utils.redirect(redirect_url or '', 301)
diff --git a/addons/link_tracker/models/__init__.py b/addons/link_tracker/models/__init__.py
new file mode 100644
index 00000000000..32330efefd5
--- /dev/null
+++ b/addons/link_tracker/models/__init__.py
@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+import link_tracker
diff --git a/addons/link_tracker/models/link_tracker.py b/addons/link_tracker/models/link_tracker.py
new file mode 100644
index 00000000000..591804304b9
--- /dev/null
+++ b/addons/link_tracker/models/link_tracker.py
@@ -0,0 +1,263 @@
+# -*- coding: utf-8 -*-
+import datetime
+import random
+import re
+import string
+
+from lxml.html import parse
+from urllib import urlencode
+from urllib2 import urlopen
+from urlparse import urljoin
+from urlparse import urlparse
+
+from openerp import models, fields, api, _
+
+URL_REGEX = r'(\bhref=[\'"]([^\'"]+)[\'"])'
+
+def VALIDATE_URL(url):
+    if urlparse(url).scheme not in ('http', 'https', 'ftp', 'ftps'):
+        return 'http://' + url
+
+    return url
+
+
+class link_tracker(models.Model):
+    """link_tracker allow users to wrap any URL into a short and trackable URL.
+    link_tracker counts clicks on each tracked link.
+    This module is also used by mass_mailing, where each link in mail_mail html_body are converted into
+    a trackable link to get the click-through rate of each mass_mailing."""
+
+    _name = "link.tracker"
+    _rec_name = "short_url"
+
+    _inherit = ['utm.mixin']
+
+    url = fields.Char(string='Target URL', required=True)
+    count = fields.Integer(string='Number of Clicks', compute='_compute_count', store=True)
+    short_url = fields.Char(string='Tracked URL', compute='_compute_short_url')
+    link_click_ids = fields.One2many('link.tracker.click', 'link_id', string='Clicks')
+    title = fields.Char(string='Page Title', store=True)
+    favicon = fields.Char(string='Favicon', compute='_compute_favicon', store=True)
+    link_code_ids = fields.One2many('link.tracker.code', 'link_id', string='Codes')
+    code = fields.Char(string='Short URL code', compute='_compute_code')
+    redirected_url = fields.Char(string='Redirected URL', compute='_compute_redirected_url')
+    short_url_host = fields.Char(string='Host of the short URL', compute='_compute_short_url_host')
+    icon_src = fields.Char(string='Favicon Source', compute='_compute_icon_src')
+
+    @api.model
+    def convert_links(self, html, vals, blacklist=None):
+        for match in re.findall(URL_REGEX, html):
+
+            short_schema = self.env['ir.config_parameter'].get_param('web.base.url') + '/r/'
+
+            href = match[0]
+            long_url = match[1]
+
+            vals['url'] = long_url
+
+            if not blacklist or not [s for s in blacklist if s in long_url] and not long_url.startswith(short_schema):
+                link = self.create(vals)
+                shorten_url = self.browse(link.id)[0].short_url
+
+                if shorten_url:
+                    new_href = href.replace(long_url, shorten_url)
+                    html = html.replace(href, new_href)
+
+        return html
+
+    @api.one
+    @api.depends('link_click_ids.link_id')
+    def _compute_count(self):
+        self.count = len(self.link_click_ids)
+
+    @api.one
+    @api.depends('code')
+    def _compute_short_url(self):
+        base_url = self.env['ir.config_parameter'].get_param('web.base.url')
+        self.short_url = urljoin(base_url, '/r/%(code)s' % {'code': self.code})
+
+    @api.one
+    def _compute_short_url_host(self):
+        self.short_url_host = self.env['ir.config_parameter'].get_param('web.base.url') + '/r/'
+
+    @api.one
+    def _compute_code(self):
+        record = self.env['link.tracker.code'].search([('link_id', '=', self.id)], limit=1, order='id DESC')
+        self.code = record.code
+
+    @api.one
+    @api.depends('favicon')
+    def _compute_icon_src(self):
+        self.icon_src = 'data:image/png;base64,' + self.favicon
+
+    @api.one
+    @api.depends('url')
+    def _compute_redirected_url(self):
+        parsed = urlparse(self.url)
+
+        utms = {}
+        for key, field, cook in self.env['utm.mixin'].tracking_fields():
+            attr = getattr(self, field).name
+            if attr:
+                utms[key] = attr
+
+        self.redirected_url = '%s://%s%s?%s&%s#%s' % (parsed.scheme, parsed.netloc, parsed.path, urlencode(utms), parsed.query, parsed.fragment)
+
+    @api.model
+    @api.depends('url')
+    def _get_title_from_url(self, url):
+        try:
+            page = urlopen(url, timeout=5)
+            p = parse(page)
+            title = p.find('.//title').text
+        except:
+            title = url
+
+        return title
+
+    @api.one
+    @api.depends('url')
+    def _compute_favicon(self):
+        try:
+            icon = urlopen('http://www.google.com/s2/favicons?domain=' + self.url, timeout=5).read()
+            icon_base64 = icon.encode('base64').replace("\n", "")
+        except:
+            icon_base64 = 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsSAAALEgHS3X78AAACiElEQVQ4EaVTzU8TURCf2tJuS7tQtlRb6UKBIkQwkRRSEzkQgyEc6lkOKgcOph78Y+CgjXjDs2i44FXY9AMTlQRUELZapVlouy3d7kKtb0Zr0MSLTvL2zb75eL838xtTvV6H/xELBptMJojeXLCXyobnyog4YhzXYvmCFi6qVSfaeRdXdrfaU1areV5KykmX06rcvzumjY/1ggkR3Jh+bNf1mr8v1D5bLuvR3qDgFbvbBJYIrE1mCIoCrKxsHuzK+Rzvsi29+6DEbTZz9unijEYI8ObBgXOzlcrx9OAlXyDYKUCzwwrDQx1wVDGg089Dt+gR3mxmhcUnaWeoxwMbm/vzDFzmDEKMMNhquRqduT1KwXiGt0vre6iSeAUHNDE0d26NBtAXY9BACQyjFusKuL2Ry+IPb/Y9ZglwuVscdHaknUChqLF/O4jn3V5dP4mhgRJgwSYm+gV0Oi3XrvYB30yvhGa7BS70eGFHPoTJyQHhMK+F0ZesRVVznvXw5Ixv7/C10moEo6OZXbWvlFAF9FVZDOqEABUMRIkMd8GnLwVWg9/RkJF9sA4oDfYQAuzzjqzwvnaRUFxn/X2ZlmGLXAE7AL52B4xHgqAUqrC1nSNuoJkQtLkdqReszz/9aRvq90NOKdOS1nch8TpL555WDp49f3uAMXhACRjD5j4ykuCtf5PP7Fm1b0DIsl/VHGezzP1KwOiZQobFF9YyjSRYQETRENSlVzI8iK9mWlzckpSSCQHVALmN9Az1euDho9Xo8vKGd2rqooA8yBcrwHgCqYR0kMkWci08t/R+W4ljDCanWTg9TJGwGNaNk3vYZ7VUdeKsYJGFNkfSzjXNrSX20s4/h6kB81/271ghG17l+rPTAAAAAElFTkSuQmCC'
+
+        self.favicon = icon_base64
+
+    @api.multi
+    def action_view_statistics(self):
+        action = self.env['ir.actions.act_window'].for_xml_id('link_tracker', 'action_view_click_statistics')
+        action['domain'] = [('link_id', '=', self.id)]
+        return action
+
+    @api.multi
+    def action_visit_page(self):
+        return {
+            'name': _("Visit Webpage"),
+            'type': 'ir.actions.act_url',
+            'url': self.url,
+            'target': 'new',
+        }
+
+    @api.model
+    def recent_links(self, filter, limit):
+        if filter == 'newest':
+            return self.search_read([], order='create_date DESC', limit=limit)
+        elif filter == 'most-clicked':
+            return self.search_read([('count', '!=', 0)], order='count DESC', limit=limit)
+        elif filter == 'recently-used':
+            return self.search_read([('count', '!=', 0)], order='write_date DESC', limit=limit)
+        else:
+            return {'Error': "This filter doesn't exist."}
+
+    @api.model
+    def create(self, vals):
+        create_vals = vals.copy()
+
+        if 'url' not in create_vals:
+            raise ValueError('URL field required')
+        else:
+            create_vals['url'] = VALIDATE_URL(vals['url'])
+
+        search_domain = []
+        for fname, value in create_vals.iteritems():
+            search_domain.append((fname, '=', value))
+
+        result = self.search(search_domain, limit=1)
+
+        if result:
+            return result
+
+        if not create_vals.get('title'):
+            create_vals['title'] = self._get_title_from_url(create_vals['url'])
+
+        # Prevent the UTMs to be set by the values of UTM cookies
+        for (key, fname, cook) in self.env['utm.mixin'].tracking_fields():
+            if fname not in create_vals:
+                create_vals[fname] = False
+
+        link = super(link_tracker, self).create(create_vals)
+
+        code = self.env['link.tracker.code'].get_random_code_string()
+        self.env['link.tracker.code'].create({'code': code, 'link_id': link.id})
+
+        return link
+
+    @api.model
+    def get_url_from_code(self, code, context=None):
+        code_rec = self.env['link.tracker.code'].sudo().search([('code', '=', code)])
+
+        if not code_rec:
+            return None
+
+        return code_rec.link_id.redirected_url
+
+    sql_constraints = [
+        ('url_utms_uniq', 'unique (url, campaign_id, medium_id, source_id)', 'The URL and the UTM combination must be unique')
+    ]
+
+
+class link_tracker_code(models.Model):
+    _name = "link.tracker.code"
+
+    code = fields.Char(string='Short URL Code', store=True)
+    link_id = fields.Many2one('link.tracker', 'Link', required=True, ondelete='cascade')
+
+    @api.model
+    def get_random_code_string(self):
+        size = 3
+        while True:
+            code_proposition = ''.join(random.choice(string.letters + string.digits) for _ in range(size))
+
+            if self.search([('code', '=', code_proposition)]):
+                size += 1
+            else:
+                return code_proposition
+
+    _sql_constraints = [
+        ('code', 'unique( code )', 'Code must be unique.')
+    ]
+
+
+class link_tracker_click(models.Model):
+    _name = "link.tracker.click"
+    _rec_name = "link_id"
+
+    click_date = fields.Date(string='Create Date')
+    link_id = fields.Many2one('link.tracker', 'Link', required=True, ondelete='cascade')
+    ip = fields.Char(string='Internet Protocol')
+    country_id = fields.Many2one('res.country', 'Country')
+
+    @api.model
+    def add_click(self, code, ip, country_code, stat_id=False):
+        self = self.sudo()
+        code_rec = self.env['link.tracker.code'].search([('code', '=', code)])
+
+        if not code_rec:
+            return None
+
+        again = self.search_count([('link_id', '=', code_rec.link_id.id), ('ip', '=', ip)])
+
+        if not again:
+            country_record = self.env['res.country'].search([('code', '=', country_code)], limit=1)
+
+            vals = {
+                'link_id': code_rec.link_id.id,
+                'create_date': datetime.date.today(),
+                'ip': ip,
+                'country_id': country_record.id,
+                'mail_stat_id': stat_id
+            }
+
+            if stat_id:
+                mail_stat = self.env['mail.mail.statistics'].search([('id', '=', stat_id)])
+
+                if mail_stat.mass_mailing_campaign_id:
+                    vals['mass_mailing_campaign_id'] = mail_stat.mass_mailing_campaign_id.id
+
+                if mail_stat.mass_mailing_id:
+                    vals['mass_mailing_id'] = mail_stat.mass_mailing_id.id
+
+            self.create(vals)
diff --git a/addons/link_tracker/security/ir.model.access.csv b/addons/link_tracker/security/ir.model.access.csv
new file mode 100644
index 00000000000..847be6ce162
--- /dev/null
+++ b/addons/link_tracker/security/ir.model.access.csv
@@ -0,0 +1,10 @@
+id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
+access_link_tracker_user,link.tracker,model_link_tracker,base.group_user,1,0,0,0
+access_link_tracker_manager,link.tracker,model_link_tracker,marketing.group_marketing_user,1,1,1,1
+access_link_tracker_public,link.tracker,model_link_tracker,base.group_public,1,0,0,0
+access_link_tracker_code_user,link.tracker.code,model_link_tracker_code,base.group_user,1,0,0,0
+access_link_tracker_code_manager,link.tracker.code,model_link_tracker_code,marketing.group_marketing_user,1,1,1,1
+access_link_tracker_code_public,link.tracker.code,model_link_tracker_code,base.group_public,1,0,0,0
+access_link_tracker_click_user,link.tracker.click,model_link_tracker_click,base.group_user,1,0,0,0
+access_link_tracker_click_manager,link.tracker.click,model_link_tracker_click,marketing.group_marketing_user,1,1,1,1
+access_link_tracker_click_public,link.tracker.click,model_link_tracker_click,base.group_public,1,0,0,0
diff --git a/addons/link_tracker/views/link_tracker.xml b/addons/link_tracker/views/link_tracker.xml
new file mode 100644
index 00000000000..ec78e86a1b8
--- /dev/null
+++ b/addons/link_tracker/views/link_tracker.xml
@@ -0,0 +1,169 @@
+<?xml version="1.0" encoding="utf-8"?>
+<openerp>
+    <data>
+        <record model="ir.actions.act_window" id="action_view_click_statistics">
+            <field name="name">Statistics of Clicks</field>
+            <field name="res_model">link.tracker.click</field>
+            <field name="view_mode">graph</field>
+            <field name="domain">[('link_id', 'IN', ids)]</field>
+        </record>
+
+        <!-- Search -->
+        <record id="view_link_tracker_filter" model="ir.ui.view">
+            <field name="name">Links</field>
+            <field name="model">link.tracker</field>
+            <field name="arch" type="xml">
+                <search string="Tracked Link">
+                    <field name="title"/>
+                    <field name="url" string="Title and URL" filter_domain="['|', ('title', 'ilike', self), ('url', 'ilike', self)]"/>
+                </search>
+            </field>
+        </record>
+
+        <!-- Website links views -->
+        <record id="view_link_tracker_form" model="ir.ui.view">
+            <field name="name">link.tracker.form</field>
+            <field name="model">link.tracker</field>
+            <field name="arch" type="xml">
+                <form string="Website Link">
+                    <sheet>
+                        <div class="oe_button_box" name="button_box">
+                            <button type="object" icon="fa-sign-out" name="action_visit_page"
+                                string="Visit Page" class="oe_stat_button"/>
+
+                            <button type="object" class="oe_stat_button" name="action_view_statistics" icon="fa-bar-chart-o">
+                                <field name="count" string="Clicks" widget="statinfo"/>
+                            </button>
+
+                        </div>
+                        <group>
+                            <field name="title"/>
+                            <field name="url"/>
+                            <field name="short_url"/>
+                        </group>
+
+                        <group>
+                            <field name="campaign_id"/>
+                            <field name="medium_id"/>
+                            <field name="source_id"/>
+                        </group>
+                    </sheet>
+                </form>
+            </field>
+        </record>
+
+
+        <record id="view_link_tracker_form_stats" model="ir.ui.view">
+            <field name="name">link.tracker.my.form</field>
+            <field name="model">link.tracker</field>
+            <field name="arch" type="xml">
+                <form string="Website Link Graph">
+                    <sheet>
+                        <field name="link_click_ids">
+                            <graph>
+                                <field name="link_id"/>
+                                <field name="ip"/>
+                                <field name="country_id"/>
+                            </graph>
+                        </field>
+                    </sheet>
+                </form>
+            </field>
+        </record>
+
+        <record model="ir.actions.act_window" id="action_link_tracker_stats">
+            <field name="name">link.tracker.form.graph.action</field>
+            <field name="res_model">link.tracker</field>
+            <field name="view_type">form</field>
+            <field name="view_mode">form</field>
+            <field name="view_id" ref="view_link_tracker_form_stats"/>
+        </record>
+
+        <record id="view_link_tracker_tree" model="ir.ui.view">
+            <field name="name">link.tracker.tree</field>
+            <field name="model">link.tracker</field>
+            <field name="arch" type="xml">
+                <tree string="Website Links">
+                    <field name="create_date"/>
+                    <field name="title"/>
+                    <field name="url"/>
+                    <field name="short_url"/>
+                    <field name="count"/>
+                </tree>
+            </field>
+        </record>
+
+        <record id="view_link_tracker_graph" model="ir.ui.view" >
+            <field name="name">link.tracker.graph</field>
+            <field name="model">link.tracker</field>
+            <field name="arch" type="xml">
+                <graph string="Website Links"  type="bar">
+                    <field name="url" type="row"/>
+                    <field name="count" type="measure"/>
+                </graph>
+            </field>
+        </record>
+
+        <!-- Action for website links-->
+        <record model="ir.actions.act_window" id="action_link_tracker">
+            <field name="name">Link Tracker</field>
+            <field name="res_model">link.tracker</field>
+            <field name="view_type">form</field>
+            <field name="view_mode">tree,form,graph</field>
+        </record>
+
+        <!-- Website links click views -->
+        <record id="view_link_tracker_click_form" model="ir.ui.view">
+            <field name="name">link.tracker.click.form</field>
+            <field name="model">link.tracker.click</field>
+            <field name="arch" type="xml">
+                <form string="Website Link Clicks">
+                    <header>
+                    </header>
+                    <sheet>
+                        <group>
+                            <field name="link_id"/>
+                            <field name="ip"/>
+                            <field name="country_id"/>
+                        </group>
+                    </sheet>
+                </form>
+            </field>
+        </record>
+
+        <record id="view_link_tracker_click_tree" model="ir.ui.view">
+            <field name="name">link.tracker.click.tree</field>
+            <field name="model">link.tracker.click</field>
+            <field name="arch" type="xml">
+                <tree string="Website Links Clicks">
+                    <field name="link_id"/>
+                    <field name="ip"/>
+                    <field name="country_id"/>
+                </tree>
+            </field>
+        </record>
+
+        <record id="view_link_tracker_click_graph" model="ir.ui.view" >
+            <field name="name">link.tracker.click.graph</field>
+            <field name="model">link.tracker.click</field>
+            <field name="arch" type="xml">
+                <graph string="Website Link Clicks">
+                    <field name="link_id"/>
+                    <field name="ip"/>
+                    <field name="country_id"/>
+                </graph>
+            </field>
+        </record>
+
+        <!-- Action for website links click-->
+        <record model="ir.actions.act_window" id="action_link_tracker_click">
+            <field name="name">Tracked Links</field>
+            <field name="res_model">link.tracker.click</field>
+            <field name="view_type">form</field>
+            <field name="view_mode">graph,tree,form</field>
+        </record>
+
+        <menuitem id="menu_url_shortener_main" name="Link Tracker" parent="utm.menu_link_tracker_root" groups="base.group_no_one"/>
+        <menuitem id="menu_url_shortener_links" name="Tracked Links" parent="menu_url_shortener_main" action="action_link_tracker"/>
+    </data>
+</openerp>