Julien De Coster
e6d4a88950
1. website_links UTMs are not set by the UTMs cookies values anymore 2. New UTM created by the select2 fields are directly added in the options of the field 3. Hide UTM selects when the link is generated
238 lines
8.9 KiB
Python
238 lines
8.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
import datetime
|
|
import random
|
|
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, _
|
|
|
|
|
|
def VALIDATE_URL(url):
|
|
if urlparse(url).scheme not in ('http', 'https', 'ftp', 'ftps'):
|
|
return 'http://' + url
|
|
|
|
return url
|
|
|
|
|
|
class website_links(models.Model):
|
|
"""website_links allow users to wrap any URL into a short and trackable URL
|
|
via a frontend and backend interface. website_links 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 = "website.links"
|
|
_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('website.links.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('website.links.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.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['website.links.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 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('website_links', '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):
|
|
if 'url' not in vals:
|
|
raise ValueError('URL field required')
|
|
else:
|
|
vals['url'] = VALIDATE_URL(vals['url'])
|
|
|
|
search_domain = []
|
|
for fname, value in vals.iteritems():
|
|
search_domain.append((fname, '=', value))
|
|
|
|
result = self.search(search_domain, limit=1)
|
|
|
|
if result:
|
|
return result
|
|
|
|
if not vals.get('title'):
|
|
vals['title'] = self._get_title_from_url(vals['url'])
|
|
|
|
# Prevent the UTMs to be set by the values of UTM cookies
|
|
for (key, fname) in self.env['utm.mixin'].tracking_fields():
|
|
if fname not in vals:
|
|
vals[fname] = False
|
|
|
|
link = super(website_links, self).create(vals)
|
|
|
|
code = self.env['website.links.code'].get_random_code_string()
|
|
self.env['website.links.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['website.links.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 website_links_code(models.Model):
|
|
_name = "website.links.code"
|
|
|
|
code = fields.Char(string='Short URL Code', store=True)
|
|
link_id = fields.Many2one('website.links', '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 website_links_click(models.Model):
|
|
_name = "website.links.click"
|
|
_rec_name = "link_id"
|
|
|
|
click_date = fields.Date(string='Create Date')
|
|
link_id = fields.Many2one('website.links', '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['website.links.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)
|