diff --git a/setup/website_recaptcha_v2_form/odoo/addons/website_recaptcha_v2_form b/setup/website_recaptcha_v2_form/odoo/addons/website_recaptcha_v2_form new file mode 120000 index 0000000000..c5585f7f8b --- /dev/null +++ b/setup/website_recaptcha_v2_form/odoo/addons/website_recaptcha_v2_form @@ -0,0 +1 @@ +../../../../website_recaptcha_v2_form \ No newline at end of file diff --git a/setup/website_recaptcha_v2_form/setup.py b/setup/website_recaptcha_v2_form/setup.py new file mode 100644 index 0000000000..28c57bb640 --- /dev/null +++ b/setup/website_recaptcha_v2_form/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000000..b7f1dd1f36 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1 @@ +odoo-addon-website_recaptcha_v2 @ git+https://github.com/OCA/website.git@refs/pull/1032/head#subdirectory=setup/website_recaptcha_v2 diff --git a/website_recaptcha_v2_form/README.rst b/website_recaptcha_v2_form/README.rst new file mode 100644 index 0000000000..ac2d92592c --- /dev/null +++ b/website_recaptcha_v2_form/README.rst @@ -0,0 +1,83 @@ +==================== +Website reCAPTCHA v2 +==================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:55856dbbdf9c9efc1b9b1ebbb33638a0018eda0d91bd6c8c9e30805aa8f2e5b0 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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%2Fwebsite-lightgray.png?logo=github + :target: https://github.com/OCA/website/tree/16.0/website_recaptcha_v2 + :alt: OCA/website +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/website-16-0/website-16-0-website_recaptcha_v2 + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/website&target_branch=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows you to use reCAPTCHA v2 in the login form. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +reCAPTCHA is configured in Settings > Website. It can be enabled or disabled +using the checkbox, and the site and secret keys can be defined there when it +is enabled. + +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 to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Binhex + +Contributors +~~~~~~~~~~~~ + + * `Binhex `_: + +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/website `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/website_recaptcha_v2_form/__init__.py b/website_recaptcha_v2_form/__init__.py new file mode 100644 index 0000000000..f7209b1710 --- /dev/null +++ b/website_recaptcha_v2_form/__init__.py @@ -0,0 +1,2 @@ +from . import models +from . import controllers diff --git a/website_recaptcha_v2_form/__manifest__.py b/website_recaptcha_v2_form/__manifest__.py new file mode 100644 index 0000000000..59cc3172eb --- /dev/null +++ b/website_recaptcha_v2_form/__manifest__.py @@ -0,0 +1,28 @@ +{ + "name": "Website reCAPTCHA v2 form", + "version": "16.0.1.0.0", + "category": "Website", + "depends": ["web", "auth_signup", "website", "website_recaptcha_v2"], + "author": """ + Binhex, + Odoo Community Association (OCA) + """, + "license": "AGPL-3", + "website": "https://github.com/OCA/website", + "summary": "Module to add reCAPTCHA v2 to the login form on the website", + "data": [ + "views/webclient_templates.xml", + "views/auth_signup_login_templates.xml", + "views/s_website_form.xml", + ], + "assets": { + "website.assets_wysiwyg": [ + "website_recaptcha_v2_form/static/src/xml/website_form_editor.xml", + "website_recaptcha_v2_form/static/src/snippets/s_website_form/options.js", + ], + "web.assets_frontend": [ + "website_recaptcha_v2_form/static/src/css/recaptcha.css", + ], + }, + "installable": True, +} diff --git a/website_recaptcha_v2_form/controllers/__init__.py b/website_recaptcha_v2_form/controllers/__init__.py new file mode 100644 index 0000000000..12a7e529b6 --- /dev/null +++ b/website_recaptcha_v2_form/controllers/__init__.py @@ -0,0 +1 @@ +from . import main diff --git a/website_recaptcha_v2_form/controllers/main.py b/website_recaptcha_v2_form/controllers/main.py new file mode 100644 index 0000000000..23f6e7e9fd --- /dev/null +++ b/website_recaptcha_v2_form/controllers/main.py @@ -0,0 +1,81 @@ +import logging + +from odoo import _, http +from odoo.exceptions import AccessDenied +from odoo.http import request + +from odoo.addons.auth_signup.controllers.main import AuthSignupHome +from odoo.addons.web.controllers.home import SIGN_UP_REQUEST_PARAMS, Home + +logger = logging.getLogger(__name__) + +SIGN_UP_REQUEST_PARAMS.add("g-recaptcha-response") + + +class BinhexHome(Home): + def verify_recaptcha_v2(self, args=None, kw=None, template="", values=None): + Website = request.env["website"].sudo() + try: + request.env["ir.http"]._auth_method_public() + valid = Website.get_current_website().valid_recaptcha(values) + if valid: + if template == "web.login": + return super().web_login(values.get("redirect", ""), **kw) + if template in ("auth_signup.reset_password", "auth_signup.signup"): + return True + except AccessDenied as e: + values.update( + { + "error": str( + e.args[0] if len(e.args) > 0 else _("Recaptcha is not valid.") + ) + } + ) + response = request.render(template, values) + response.headers["X-Frame-Options"] = "SAMEORIGIN" + response.headers["Content-Security-Policy"] = "frame-ancestors 'self'" + return response + + @http.route("/web/login", type="http", auth="none") + def web_login(self, redirect=None, **kw): + if request.httprequest.method == "POST": + values = { + k: v for k, v in request.params.items() if k in SIGN_UP_REQUEST_PARAMS + } + # Checking that if the request comes from the creation of the account, + # that the recaptcha is not checked again to avoid errors. + + if ( + values.get("confirm_password", "") == "" + and request.httprequest.url.find("web/signup") == -1 + ): + return self.verify_recaptcha_v2( + kw=kw, template="web.login", values=values + ) + return super().web_login(redirect, **kw) + + +class BinhexAuthSignupHome(AuthSignupHome): + @http.route( + "/web/reset_password", type="http", auth="public", website=True, sitemap=False + ) + def web_auth_reset_password(self, *args, **kw): + qcontext = self.get_auth_signup_qcontext() + if request.httprequest.method == "POST": + valid = self.verify_recaptcha_v2( + kw=kw, template="auth_signup.reset_password", values=qcontext, args=args + ) + if not isinstance(valid, bool): + return valid + return super().web_auth_reset_password(*args, **kw) + + @http.route("/web/signup", type="http", auth="public", website=True, sitemap=False) + def web_auth_signup(self, *args, **kw): + qcontext = self.get_auth_signup_qcontext() + if request.httprequest.method == "POST": + valid = self.verify_recaptcha_v2( + kw=kw, template="auth_signup.signup", values=qcontext, args=args + ) + if not isinstance(valid, bool): + return valid + return super().web_auth_signup(*args, **kw) diff --git a/website_recaptcha_v2_form/i18n/es.po b/website_recaptcha_v2_form/i18n/es.po new file mode 100644 index 0000000000..ad619481ec --- /dev/null +++ b/website_recaptcha_v2_form/i18n/es.po @@ -0,0 +1,28 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * binhex_website_recaptcha_v2 +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2024-12-02 16:23+0000\n" +"PO-Revision-Date: 2024-12-02 16:23+0000\n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: binhex_website_recaptcha_v2 +#. odoo-python +#: code:addons/binhex_website_recaptcha_v2/controllers/main.py:0 +#, python-format +msgid "Recaptcha is not valid." +msgstr "Recaptcha no es válido." + +#. module: binhex_website_recaptcha_v2 +#: model:ir.model,name:binhex_website_recaptcha_v2.model_website +msgid "Website" +msgstr "Sitio web" diff --git a/website_recaptcha_v2_form/models/__init__.py b/website_recaptcha_v2_form/models/__init__.py new file mode 100644 index 0000000000..bd190fa80b --- /dev/null +++ b/website_recaptcha_v2_form/models/__init__.py @@ -0,0 +1 @@ +from . import website diff --git a/website_recaptcha_v2_form/models/website.py b/website_recaptcha_v2_form/models/website.py new file mode 100644 index 0000000000..3920285635 --- /dev/null +++ b/website_recaptcha_v2_form/models/website.py @@ -0,0 +1,25 @@ +from odoo import api, models +from odoo.exceptions import AccessDenied + + +class Website(models.Model): + _inherit = "website" + + # -------------------------------------------------- + # METHODS + # -------------------------------------------------- + """ + Validating that the recaptcha sent is correct + @params: + kw: Data sent from the form + """ + + def valid_recaptcha(self, values): + valid, message = self.is_recaptcha_v2_valid(values) + if not valid: + raise AccessDenied(message) + return True + + @api.model + def get_recaptcha_v2_site_key(self): + return self.sudo().get_current_website().recaptcha_v2_site_key diff --git a/website_recaptcha_v2_form/static/description/recaptcha_ico.png b/website_recaptcha_v2_form/static/description/recaptcha_ico.png new file mode 100644 index 0000000000..65f4e0147f Binary files /dev/null and b/website_recaptcha_v2_form/static/description/recaptcha_ico.png differ diff --git a/website_recaptcha_v2_form/static/src/css/recaptcha.css b/website_recaptcha_v2_form/static/src/css/recaptcha.css new file mode 100644 index 0000000000..8a6bfd26f2 --- /dev/null +++ b/website_recaptcha_v2_form/static/src/css/recaptcha.css @@ -0,0 +1,5 @@ +div.s_website_form_recaptcha_v2 > div.g-recaptcha { + margin-left: 18% !important; +} + +/*# sourceMappingURL=recaptcha.css.map */ diff --git a/website_recaptcha_v2_form/static/src/css/recaptcha.css.map b/website_recaptcha_v2_form/static/src/css/recaptcha.css.map new file mode 100644 index 0000000000..86d6983513 --- /dev/null +++ b/website_recaptcha_v2_form/static/src/css/recaptcha.css.map @@ -0,0 +1 @@ +{"version":3,"sourceRoot":"","sources":["../scss/recaptcha.scss"],"names":[],"mappings":"AACI;EACI","file":"recaptcha.css"} \ No newline at end of file diff --git a/website_recaptcha_v2_form/static/src/scss/recaptcha.scss b/website_recaptcha_v2_form/static/src/scss/recaptcha.scss new file mode 100644 index 0000000000..918be7fe04 --- /dev/null +++ b/website_recaptcha_v2_form/static/src/scss/recaptcha.scss @@ -0,0 +1,5 @@ +div.s_website_form_recaptcha_v2 { + > div.g-recaptcha { + margin-left: 18% !important; + } +} diff --git a/website_recaptcha_v2_form/static/src/snippets/s_website_form/options.js b/website_recaptcha_v2_form/static/src/snippets/s_website_form/options.js new file mode 100644 index 0000000000..045c59efeb --- /dev/null +++ b/website_recaptcha_v2_form/static/src/snippets/s_website_form/options.js @@ -0,0 +1,44 @@ +odoo.define("website_recaptcha_v2_form.form_editor", function (require) { + "use strict"; + + var options = require("web_editor.snippets.options"); + const core = require("web.core"); + const rpc = require("web.rpc"); + const qweb = core.qweb; + require("website.form_editor"); + + options.registry.WebsiteFormEditor.include({ + willStart: async function () { + var res = this._super(...arguments); + this.recaptcha_site_key = await rpc.query({ + model: "website", + method: "get_recaptcha_v2_site_key", + }); + return res; + }, + toggleRecaptchaV2: async function () { + const recaptchaV2 = this.$target[0].querySelector( + ".s_website_form_recaptcha_v2" + ); + if (recaptchaV2) { + recaptchaV2.remove(); + } else { + const legal = qweb.render("website_recaptcha_v2_form.recaptcha_v2", { + recaptcha_site_key: this.recaptcha_site_key, + }); + this.$target.find(".s_website_form_submit").before(legal); + } + }, + _computeWidgetState: function (methodName, params) { + switch (methodName) { + case "toggleRecaptchaV2": + return ( + !this.$target[0].querySelector( + ".s_website_form_recaptcha_v2" + ) || "" + ); + } + return this._super(...arguments); + }, + }); +}); diff --git a/website_recaptcha_v2_form/static/src/xml/website_form_editor.xml b/website_recaptcha_v2_form/static/src/xml/website_form_editor.xml new file mode 100644 index 0000000000..d8b1c7e86e --- /dev/null +++ b/website_recaptcha_v2_form/static/src/xml/website_form_editor.xml @@ -0,0 +1,11 @@ + + + + +
+
+