diff --git a/website_seo_redirection/README.rst b/website_seo_redirection/README.rst new file mode 100644 index 0000000000..9824b871dd --- /dev/null +++ b/website_seo_redirection/README.rst @@ -0,0 +1,73 @@ +.. image:: https://img.shields.io/badge/licence-LGPL--3-blue.svg + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-3 + +======================= +Website SEO Redirection +======================= + +This module extends the functionality of the website to support using custom +URLs and allow you to improve the SEO. + +Usage +===== + +Let's assume you created a blog post entry that is absolutely amazing and you +want a fixed and beautiful URL for it. That entry is posted in +``https://example.com/blog/our-news-1/post/amazing-post-23``, but you want it +at ``https://example.com/amazing``. You need to: + +#. Go to *Settings > Configuration > SEO Redirections > Create*. +#. Set ``/blog/our-news-1/post/amazing-post-23`` as *Original URL*. +#. Set ``/amazing`` as *Redirected URL*. + +Now navigate to any of both URLs, and you will get to the blog post, but with +the URL you wanted. + +.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas + :alt: Try me on Runbot + :target: https://runbot.odoo-community.org/runbot/186/8.0 + +Known issues / Roadmap +====================== + +* The frontend *Promote* view should be extended to display and modify this + information more easily. +* Add ability to have several redirected URLs for a single original URL. +* Make it multiwebsite-compatible. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub 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. + +Credits +======= + +Images +------ + +* Odoo Community Association: `Icon `_. + +Contributors +------------ + +* Jairo Llopis + +Maintainer +---------- + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +This module is maintained by the OCA. + +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. + +To contribute to this module, please visit https://odoo-community.org. diff --git a/website_seo_redirection/__init__.py b/website_seo_redirection/__init__.py new file mode 100644 index 0000000000..a268e9cda2 --- /dev/null +++ b/website_seo_redirection/__init__.py @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- +# © 2016 Jairo Llopis +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from . import models diff --git a/website_seo_redirection/__openerp__.py b/website_seo_redirection/__openerp__.py new file mode 100644 index 0000000000..e6a5cd200a --- /dev/null +++ b/website_seo_redirection/__openerp__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- +# © 2016 Jairo Llopis +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). +{ + "name": "Website SEO Redirection", + "summary": "Redirect any controller to the URL of your dreams", + "version": "8.0.1.0.0", + "category": "Website", + "website": "https://tecnativa.com/", + "author": "Tecnativa, Odoo Community Association (OCA)", + "license": "LGPL-3", + "application": False, + "installable": True, + "depends": [ + "website", + ], + "data": [ + "security/ir.model.access.csv", + "views/assets.xml", + "views/website_seo_redirection_view.xml", + ], + "demo": [ + "demo/website_seo_redirection_demo.xml", + ], +} diff --git a/website_seo_redirection/demo/website_seo_redirection_demo.xml b/website_seo_redirection/demo/website_seo_redirection_demo.xml new file mode 100644 index 0000000000..c73cc2cf73 --- /dev/null +++ b/website_seo_redirection/demo/website_seo_redirection_demo.xml @@ -0,0 +1,52 @@ + + + + + + + + + + SEO Sample + + + + + Original URL + /page/website_seo_redirection.sample_page + + + + + Redirected URL + /seo/sample + + + + + /page/website_seo_redirection.sample_page + /seo/sample + + + + diff --git a/website_seo_redirection/exceptions.py b/website_seo_redirection/exceptions.py new file mode 100644 index 0000000000..5097ecd1ab --- /dev/null +++ b/website_seo_redirection/exceptions.py @@ -0,0 +1,13 @@ +# -*- coding: utf-8 -*- +# © 2016 Jairo Llopis +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from openerp import exceptions + + +class NoOriginError(exceptions.ValidationError): + pass + + +class NoRedirectionError(exceptions.ValidationError): + pass diff --git a/website_seo_redirection/l10n/es.po b/website_seo_redirection/l10n/es.po new file mode 100644 index 0000000000..0a68922729 --- /dev/null +++ b/website_seo_redirection/l10n/es.po @@ -0,0 +1,141 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * website_seo_redirection +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 8.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2016-05-23 12:19+0200\n" +"PO-Revision-Date: 2016-05-23 12:22+0200\n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" +"X-Generator: Poedit 1.8.7.1\n" +"Last-Translator: \n" +"Language: es_ES\n" + +#. module: website_seo_redirection +#: view:website:website_seo_redirection.sample_page +msgid ", but" +msgstr ", pero" + +#. module: website_seo_redirection +#: view:website:website_seo_redirection.sample_page +msgid "/page/website_seo_redirection.sample_page" +msgstr "/page/website_seo_redirection.sample_page" + +#. module: website_seo_redirection +#: view:website:website_seo_redirection.sample_page +msgid "/seo/sample" +msgstr "/seo/sample" + +#. module: website_seo_redirection +#: field:website.seo.redirection,create_uid:0 +msgid "Created by" +msgstr "Creado por" + +#. module: website_seo_redirection +#: field:website.seo.redirection,create_date:0 +msgid "Created on" +msgstr "Creado el" + +#. module: website_seo_redirection +#: field:website.seo.redirection,display_name:0 +msgid "Display Name" +msgstr "Nombre a mostrar" + +#. module: website_seo_redirection +#: sql_constraint:website.seo.redirection:0 +msgid "Duplicated new URL" +msgstr "Nueva URL duplicada" + +#. module: website_seo_redirection +#: sql_constraint:website.seo.redirection:0 +msgid "Duplicated original URL" +msgstr "URL original duplicada" + +#. module: website_seo_redirection +#: model:ir.model,name:website_seo_redirection.model_ir_http +msgid "HTTP routing" +msgstr "Enrutamiento HTTP" + +#. module: website_seo_redirection +#: field:website.seo.redirection,id:0 +msgid "ID" +msgstr "ID" + +#. module: website_seo_redirection +#: field:website.seo.redirection,__last_update:0 +msgid "Last Modified on" +msgstr "Última modificación el" + +#. module: website_seo_redirection +#: field:website.seo.redirection,write_uid:0 +msgid "Last Updated by" +msgstr "Última modificación por" + +#. module: website_seo_redirection +#: field:website.seo.redirection,write_date:0 +msgid "Last Updated on" +msgstr "Última actualización el" + +#. module: website_seo_redirection +#: model:ir.model,name:website_seo_redirection.model_ir_module_module +msgid "Module" +msgstr "Módulo" + +#. module: website_seo_redirection +#: model:website.menu,name:website_seo_redirection.sample_origin_menu +#: field:website.seo.redirection,origin:0 +msgid "Original URL" +msgstr "URL original" + +#. module: website_seo_redirection +#: help:website.seo.redirection,destination:0 +msgid "Path where the controller will be found now." +msgstr "Ruta donde el controlador se encontrará ahora." + +#. module: website_seo_redirection +#: help:website.seo.redirection,origin:0 +msgid "Path where the original controller was found." +msgstr "Ruta donde se encontraba el controlador original." + +#. module: website_seo_redirection +#: model:website.menu,name:website_seo_redirection.sample_destination_menu +#: field:website.seo.redirection,destination:0 +msgid "Redirected URL" +msgstr "URL redireccionada" + +#. module: website_seo_redirection +#: model:ir.actions.act_window,name:website_seo_redirection.website_seo_redirection_action_open +#: model:ir.ui.menu,name:website_seo_redirection.website_seo_redirection_menu +msgid "SEO Redirections" +msgstr "Redirecciones SEO" + +#. module: website_seo_redirection +#: model:website.menu,name:website_seo_redirection.sample_menu +msgid "SEO Sample" +msgstr "Muestra SEO" + +#. module: website_seo_redirection +#: model:ir.model,name:website_seo_redirection.model_website_seo_redirection +msgid "SEO controller redirections" +msgstr "Redirecciones de controladores SEO" + +#. module: website_seo_redirection +#: view:website:website_seo_redirection.sample_page +msgid "The original URL for this page is" +msgstr "La URL original para esta página es" + +#. module: website_seo_redirection +#: view:website:website_seo_redirection.sample_page +msgid "Welcome, this is SEO." +msgstr "Bienvenido, esto es SEO." + +#. module: website_seo_redirection +#: view:website:website_seo_redirection.sample_page +msgid "is beautier, right?" +msgstr "es más bonita, ¿verdad?" diff --git a/website_seo_redirection/models/__init__.py b/website_seo_redirection/models/__init__.py new file mode 100644 index 0000000000..581218c807 --- /dev/null +++ b/website_seo_redirection/models/__init__.py @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- +# © 2016 Jairo Llopis +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from . import ir_http, website_seo_redirection diff --git a/website_seo_redirection/models/ir_http.py b/website_seo_redirection/models/ir_http.py new file mode 100644 index 0000000000..13fc2ac0c3 --- /dev/null +++ b/website_seo_redirection/models/ir_http.py @@ -0,0 +1,29 @@ +# -*- coding: utf-8 -*- +# © 2016 Jairo Llopis +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from openerp import models +from openerp.http import request +from ..exceptions import NoOriginError, NoRedirectionError + + +class IrHttp(models.AbstractModel): + _inherit = "ir.http" + + def _dispatch(self): + """Handle SEO-redirected URLs.""" + # Only handle redirections for HTTP requests + if not hasattr(request, "jsonrequest"): + wsr = request.env["website.seo.redirection"] + + try: + # Redirect user to SEO version of this URL if possible + return wsr.redirect_auto() + except NoRedirectionError: + try: + # Make Odoo believe it is in the original controller + return self.reroute(wsr.find_origin()) + except NoOriginError: + pass + + return super(IrHttp, self)._dispatch() diff --git a/website_seo_redirection/models/website_seo_redirection.py b/website_seo_redirection/models/website_seo_redirection.py new file mode 100644 index 0000000000..64f38c5346 --- /dev/null +++ b/website_seo_redirection/models/website_seo_redirection.py @@ -0,0 +1,129 @@ +# -*- coding: utf-8 -*- +# © 2016 Jairo Llopis +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from openerp import _, api, fields, models +from openerp.http import request, local_redirect +from openerp.exceptions import ValidationError +from ..exceptions import NoOriginError, NoRedirectionError + + +class WebsiteSeoRedirection(models.Model): + _name = "website.seo.redirection" + _rec_name = "destination" + _order = "destination" + _description = "SEO controller redirections" + _sql_constraints = [ + ("origin_unique", "UNIQUE(origin)", "Duplicated original URL"), + ("destination_unique", "UNIQUE(destination)", "Duplicated new URL"), + ] + + origin = fields.Char( + string="Original URL", + required=True, + index=True, + help="Path where the original controller was found.", + ) + destination = fields.Char( + string="Redirected URL", + required=True, + index=True, + help="Path where the controller will be found now.", + ) + + @api.multi + @api.constrains("origin") + def _check_origin(self): + self._url_format_check("origin") + + @api.multi + @api.constrains("destination") + def _check_destination(self): + self._url_format_check("destination") + + @api.multi + def _url_format_check(self, field_name): + display = self._fields[field_name].string + for s in self: + value = s[field_name] + if not value.startswith("/"): + raise ValidationError(_("%s must start with `/`") % display) + for char in "?&=#": + if char in value: + raise ValidationError( + _("Invalid character found in %s: `%s`") % + (display, char)) + if s.origin == s.destination: + raise ValidationError( + _("You cannot redirect an URL to itself.")) + + @api.model + def find_origin(self, redirected_path=None): + """Finds the original path for :param:`redirected_path`. + + :param str redirected_path: + Destination path to get to a controller. + + :raise NoOriginError: + When no original URL is found. + + :return str: + Returns the original path (e.g. ``/page/example``) if + :attr:`redirected_path` (e.g. ``/example``) is found among the SEO + redirections, or :attr:`redirected_path` itself otherwise. + """ + path = redirected_path or request.httprequest.path + redirection = self.search([("destination", "=", path)]) + if not redirection.origin: + raise NoOriginError(_("No origin found for this redirection.")) + return redirection.origin + + @api.model + def redirect_auto(self, path=None, code=301, website=None, rerouting=None): + """Return a redirection for the SEO path or fail. + + :param str path: + Path that will be searched among the SEO redirections. + + :param int code: + HTTP redirection code. + + :param website openerp.models.Model: + Current website object. Default: ``request.website``. + + :param list rerouting: + List of reroutings performed. It defaults to ``request.rerouting``. + + :raise NoRedirectionError: + If no redirection target is found. This allows you to continue + the normal behavior in your controller. + + :return werkzeug.wrappers.Response: + Redirection to the SEO version of the URL. + """ + # Default values + path = path or request.httprequest.path + rerouting = rerouting or getattr(request, "rerouting", list()) + website = website or getattr( + request, "website", self.env["website"].get_current_website()) + + # Search for a SEO destination + match = self.search([("origin", "=", path)]) + destination = match.destination + + # Fail when needed + if not destination: + raise NoRedirectionError(_("No redirection target found.")) + if destination in rerouting: + raise NoRedirectionError(_("Duplicated redirection.")) + + # Add language prefix to URL + if website.default_lang_code != request.lang: + destination = u"/{}{}".format(request.lang, destination) + + # Redirect to the SEO URL + return local_redirect( + destination, + dict(request.httprequest.args), + True, + code=code) diff --git a/website_seo_redirection/security/ir.model.access.csv b/website_seo_redirection/security/ir.model.access.csv new file mode 100644 index 0000000000..da088a7029 --- /dev/null +++ b/website_seo_redirection/security/ir.model.access.csv @@ -0,0 +1,3 @@ +"id","name","model_id:id","group_id:id","perm_read","perm_write","perm_create","perm_unlink" +"read_everyone","Public users need to find redirections","model_website_seo_redirection",,1,0,0,0 +"write_website_designer","Website managers can set SEO redirections","model_website_seo_redirection","base.group_website_designer",1,1,1,1 diff --git a/website_seo_redirection/static/description/icon.png b/website_seo_redirection/static/description/icon.png new file mode 100644 index 0000000000..3a0328b516 Binary files /dev/null and b/website_seo_redirection/static/description/icon.png differ diff --git a/website_seo_redirection/static/src/js/website_seo_redirection.tour.js b/website_seo_redirection/static/src/js/website_seo_redirection.tour.js new file mode 100644 index 0000000000..43518486e8 --- /dev/null +++ b/website_seo_redirection/static/src/js/website_seo_redirection.tour.js @@ -0,0 +1,44 @@ +/* © 2016 Jairo Llopis + * License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). */ + + +"use strict"; +(function ($) { + openerp.Tour.register({ + id: "website_seo_redirection", + name: "Check SEO redirections functionality", + path: "/", + mode: "test", + steps: [ + { + title: "Open SEO menu", + waitFor: "a>span:contains('SEO Sample')", + element: "a>span:contains('SEO Sample')", + }, + { + title: "Go to SEO sample page in original URL", + waitFor: "a>span:contains('Original URL')", + element: "a>span:contains('Original URL')", + }, + { + title: "Page reached, back to home", + waitFor: "#origin,#destination", + element: "a>span:contains('Home')", + }, + { + title: "Open SEO menu", + waitFor: "html[data-view-xmlid='website.homepage']", + element: "a>span:contains('SEO Sample')", + }, + { + title: "Go to SEO sample page in destination URL", + waitFor: "a>span:contains('Redirected URL')", + element: "a>span:contains('Redirected URL')", + }, + { + title: "Page reached", + waitFor: "#origin,#destination", + }, + ], + }); +})(jQuery); diff --git a/website_seo_redirection/tests/__init__.py b/website_seo_redirection/tests/__init__.py new file mode 100644 index 0000000000..973d3466ff --- /dev/null +++ b/website_seo_redirection/tests/__init__.py @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- +# © 2016 Jairo Llopis +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from . import test_model_website_seo_redirection, test_ui diff --git a/website_seo_redirection/tests/test_model_website_seo_redirection.py b/website_seo_redirection/tests/test_model_website_seo_redirection.py new file mode 100644 index 0000000000..1b5e240672 --- /dev/null +++ b/website_seo_redirection/tests/test_model_website_seo_redirection.py @@ -0,0 +1,64 @@ +# -*- coding: utf-8 -*- +# © 2016 Jairo Llopis +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from openerp.exceptions import ValidationError +from openerp.tests.common import TransactionCase + + +class WebsiteSeoRedirectionCase(TransactionCase): + def setUp(self): + super(WebsiteSeoRedirectionCase, self).setUp() + self.wsr = self.env["website.seo.redirection"] + self.bad_inputs = { + "http://example.com/test", + "test", + "/test?db=test", + "/test&other", + "/test#anchor", + } + + def test_bad_origin(self): + """Cannot enter a malformed origin URL.""" + for sample in self.bad_inputs: + with self.assertRaises(ValidationError): + with self.env.cr.savepoint(): + self.wsr.create({ + "origin": sample, + "destination": "/good-url", + }) + + def test_bad_redirection(self): + """Cannot enter a malformed redirection URL.""" + for sample in self.bad_inputs: + with self.assertRaises(ValidationError): + with self.env.cr.savepoint(): + self.wsr.create({ + "origin": "/good-url", + "destination": sample, + }) + + def test_equal_origin_redirection(self): + """Cannot create a redirection to itself.""" + with self.assertRaises(ValidationError): + self.wsr.create({ + "origin": "/same-url", + "destination": "/same-url", + }) + + def test_find_origin(self): + """The right origin is found.""" + record = self.wsr.create({ + "origin": "/page/example-page", + "destination": "/example", + }) + # Search by redirection, return origin + self.assertEqual( + self.wsr.find_origin(record.destination), + record.origin) + + # Search by origin, return itself + self.assertEqual(record.origin, record.origin) + + # Search by whatever, return itself + self.assertEqual("/page/whatever", "/page/whatever") diff --git a/website_seo_redirection/tests/test_ui.py b/website_seo_redirection/tests/test_ui.py new file mode 100644 index 0000000000..ae2be87962 --- /dev/null +++ b/website_seo_redirection/tests/test_ui.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# © 2016 Jairo Llopis +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from openerp.tests.common import HttpCase + + +class UICase(HttpCase): + def test_admin_tour_en_US(self): + """Redirections work with default language.""" + self.phantom_js( + "/en_US", + "openerp.Tour.run('website_seo_redirection')", + "openerp.Tour.tours.website_seo_redirection", + "admin") diff --git a/website_seo_redirection/views/assets.xml b/website_seo_redirection/views/assets.xml new file mode 100644 index 0000000000..8844763bde --- /dev/null +++ b/website_seo_redirection/views/assets.xml @@ -0,0 +1,16 @@ + + + + + + +