[18.0][MIG] auth_user_case_insensitive: Migration to 18.0

auth_user_case_insensitive/README.rst

@@ -17,13 +17,13 @@ Case Insensitive Logins
     :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
     :alt: License: AGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github
-    :target: https://github.com/OCA/server-auth/tree/17.0/auth_user_case_insensitive
+    :target: https://github.com/OCA/server-auth/tree/18.0/auth_user_case_insensitive
     :alt: OCA/server-auth
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/server-auth-17-0/server-auth-17-0-auth_user_case_insensitive
+    :target: https://translation.odoo-community.org/projects/server-auth-18-0/server-auth-18-0-auth_user_case_insensitive
     :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/server-auth&target_branch=17.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-auth&target_branch=18.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
@@ -60,7 +60,7 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-auth/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 <https://github.com/OCA/server-auth/issues/new?body=module:%20auth_user_case_insensitive%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/server-auth/issues/new?body=module:%20auth_user_case_insensitive%0Aversion:%2018.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.
 
@@ -75,10 +75,10 @@ Authors
 Contributors
 ------------
 
--  Dave Lasley <[email protected]>
--  Ted Salmon <[email protected]>
--  Mayank Gosai <[email protected]>
--  Chandresh Thakkar <[email protected]>
+- Dave Lasley <[email protected]>
+- Ted Salmon <[email protected]>
+- Mayank Gosai <[email protected]>
+- Chandresh Thakkar <[email protected]>
 
 Maintainers
 -----------
@@ -93,6 +93,6 @@ 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/server-auth <https://github.com/OCA/server-auth/tree/17.0/auth_user_case_insensitive>`_ project on GitHub.
+This module is part of the `OCA/server-auth <https://github.com/OCA/server-auth/tree/18.0/auth_user_case_insensitive>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

auth_user_case_insensitive/__init__.py

@@ -2,6 +2,36 @@
 # Copyright 2021 Open Source Integrators
 # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
 
+from odoo import _
+from odoo.exceptions import ValidationError
 from . import models
-from .hooks import pre_init_hook_login_check
-from .hooks import post_init_hook_login_convert
+
+
+def pre_init_hook_login_check(env):
+    """This hook will look to see if any conflicting logins exist before
+    the module is installed
+    :param openerp.sql_db.Cursor cr:
+        Database cursor.
+    """
+    with env.cr.savepoint():
+        users = []
+        env.cr.execute("SELECT login FROM res_users")
+        for user in env.cr.fetchall():
+            login = user[0].lower()
+            if login not in users:
+                users.append(login)
+            else:
+                raise ValidationError(
+                    _("Conflicting user logins exist for `%s`", login)
+                )
+
+
+def post_init_hook_login_convert(env):
+    """After the module is installed, set all logins to lowercase
+    :param openerp.sql_db.Cursor cr:
+        Database cursor.
+    :param openerp.modules.registry.RegistryManager registry:
+        Database registry, using v7 api.
+    """
+    with env.cr.savepoint():
+        env.cr.execute("UPDATE res_users SET login=lower(login)")

auth_user_case_insensitive/__manifest__.py

@@ -4,7 +4,7 @@
 {
     "name": "Case Insensitive Logins",
     "summary": "Makes the user login field case insensitive",
-    "version": "17.0.1.0.0",
+    "version": "18.0.1.0.0",
     "category": "Authentication",
     "website": "https://github.com/OCA/server-auth",
     "author": "LasLabs, Odoo Community Association (OCA)",

auth_user_case_insensitive/models/res_users.py

@@ -11,11 +11,13 @@ class ResUsers(models.Model):
     login = fields.Char(help="Used to log into the system. Case insensitive.")
 
     @classmethod
-    def _login(cls, db, login, password, user_agent_env):
+    def _login(cls, db, credential, user_agent_env):
         """Overload _login to lowercase the `login` before passing to the
         super."""
-        login = login.lower()
-        return super()._login(db, login, password, user_agent_env=user_agent_env)
+        if credential.get("type") and credential["type"] == "password":
+            credential["login"] = credential["login"].lower()
+
+        return super()._login(db, credential, user_agent_env)
 
     @api.model_create_multi
     def create(self, vals_list):

auth_user_case_insensitive/static/description/index.html

@@ -8,10 +8,11 @@
 
 /*
 :Author: David Goodger ([email protected])
-:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
+:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 
 Default cascading style sheet for the HTML output of Docutils.
+Despite the name, some widely supported CSS2 features are used.
 
 See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
@@ -274,7 +275,7 @@
   margin-left: 2em ;
   margin-right: 2em }
 
-pre.code .ln { color: grey; } /* line numbers */
+pre.code .ln { color: gray; } /* 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 }
@@ -300,7 +301,7 @@
 span.pre {
   white-space: pre }
 
-span.problematic {
+span.problematic, pre.problematic {
   color: red }
 
 span.section-subtitle {
@@ -368,7 +369,7 @@ <h1 class="title">Case Insensitive Logins</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:191e82e2a345b4dab163f77be2535319c23f64fb605fdba6bb24f8b4d0948c4e
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" 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 image-reference" 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 image-reference" href="https://github.com/OCA/server-auth/tree/17.0/auth_user_case_insensitive"><img alt="OCA/server-auth" src="https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-auth-17-0/server-auth-17-0-auth_user_case_insensitive"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-auth&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p><a class="reference external image-reference" 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 image-reference" 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 image-reference" href="https://github.com/OCA/server-auth/tree/18.0/auth_user_case_insensitive"><img alt="OCA/server-auth" src="https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-auth-18-0/server-auth-18-0-auth_user_case_insensitive"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-auth&amp;target_branch=18.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module makes user logins case insensitive. It also overwrites the
 search method to allow these case insensitive logins to work on a
 database that previously had case sensitive logins.</p>
@@ -402,7 +403,7 @@ <h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-auth/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 to smash it by providing a detailed and welcomed
-<a class="reference external" href="https://github.com/OCA/server-auth/issues/new?body=module:%20auth_user_case_insensitive%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/server-auth/issues/new?body=module:%20auth_user_case_insensitive%0Aversion:%2018.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">
@@ -425,11 +426,13 @@ <h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 <div class="section" id="maintainers">
 <h2><a class="toc-backref" href="#toc-entry-7">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>
+<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/server-auth/tree/17.0/auth_user_case_insensitive">OCA/server-auth</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-auth/tree/18.0/auth_user_case_insensitive">OCA/server-auth</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>

auth_user_case_insensitive/tests/test_res_users.py

@@ -45,15 +45,15 @@ def test_login_is_lowercased_on_write(self):
     def test_login_login_is_lowercased(self):
         """verify the login is set to lowercase on login."""
         rec_id = self.model_obj.search([("login", "=", "admin")])
-        res_id = self.model_obj._login(
+        credential = {"login": "AdMiN", "password": "admin", "type": "password"}
+        auth_info = self.model_obj._login(
             self.env.registry.db_name,
-            "AdMiN",
-            "admin",
+            credential,
             {"interactive": True},
         )
         self.assertEqual(
             rec_id.id,
-            res_id,
+            auth_info["uid"],
             "Login with with uppercase chars was not \
             successful",
         )