Merge pull request #848 from OpenSPP/phone-validity

Phone Validation

Author: pithtech

spp_base_common/__manifest__.py

@@ -22,7 +22,12 @@
     ],
     "excludes": [],
     "external_dependencies": {},
-    "data": ["security/security_access.xml", "security/ir.model.access.csv", "views/main_view.xml"],
+    "data": [
+        "security/security_access.xml",
+        "security/ir.model.access.csv",
+        "views/main_view.xml",
+        "views/phone_validation_view.xml",
+    ],
     "assets": {
         "web.assets_backend": [
             "spp_base_common/static/src/scss/navbar.scss",

spp_base_common/models/__init__.py

@@ -1 +1,3 @@
 from . import ir_module_module
+from . import phone_validation
+from . import phone_number

spp_base_common/models/phone_number.py

@@ -0,0 +1,88 @@
+import logging
+import re
+
+from odoo import _, api, models
+from odoo.exceptions import ValidationError
+
+_logger = logging.getLogger(__name__)
+
+
+class G2PPhoneNumber(models.Model):
+    _inherit = "g2p.phone.number"
+
+    def write(self, vals):
+        res = super().write(vals)
+        if "phone_no" in vals or "country_id" in vals:
+            self._onchange_phone_validation()
+        return res
+
+    @api.model_create_multi
+    def create(self, vals):
+        record = super().create(vals)
+        record._onchange_phone_validation()
+        return record
+
+    @api.onchange("phone_no", "country_id")
+    def _onchange_phone_validation(self):
+        for rec in self:
+            phone_validation = rec.env["spp.phone.validation"].search([("state", "=", "active")])
+            if not rec.phone_no:
+                return
+
+            phone_no = rec.phone_no
+            # Remove spaces, parentheses, and dashes for validation purposes
+            phone_no = phone_no.replace(" ", "").replace("(", "").replace(")", "").replace("-", "")
+
+            error_msgs = []
+
+            # Check for letters
+            has_letter = bool(re.search(r"[A-Za-z]", phone_no))
+            if has_letter:
+                error_msgs.append(_("Phone number must not contain letters."))
+
+            # Check for invalid special characters (allow only digits, '-', and '+' at the start)
+            # Acceptable pattern: optional leading '+', digits and '-' only
+            # Only add special character error if there are non-letter invalid characters
+            if re.search(r"[^0-9A-Za-z\-+]", phone_no) or not re.match(r"^\+?[\d-]+$", phone_no):
+                # Only add if there is at least one invalid special character (not a letter)
+                # Find all invalid special characters
+                invalid_chars = re.findall(r"[^0-9A-Za-z\-+]", phone_no)
+                if invalid_chars:
+                    error_msgs.append(
+                        _(
+                            "Phone number contains invalid special characters. "
+                            "Only digits, '-', and an optional leading '+' are allowed."
+                        )
+                    )
+
+            # Format validation
+            if phone_validation:
+                format_msgs = []
+                validated_success_count = 0
+                for validation in phone_validation:
+                    if validation.with_prefix:
+                        pattern = (
+                            r"^\+?" + re.escape(validation.prefix) + r"\d{" + str(validation.number_of_digits) + r"}$"
+                        )
+                    else:
+                        pattern = r"^\d{" + str(validation.number_of_digits) + r"}$"
+                    if re.match(pattern, phone_no):
+                        validated_success_count += 1
+                    else:
+                        format_msgs.append(validation.name)
+
+                if validated_success_count == 0 and not error_msgs:
+                    error_msgs.append(
+                        _("Phone number must match one of the following formats: ") + ", ".join(format_msgs)
+                    )
+
+            if error_msgs:
+                raise ValidationError("\n".join(error_msgs))
+            return
+
+    @api.depends("phone_no", "country_id")
+    def _compute_phone_sanitized(self):
+        for rec in self:
+            phone_no = rec.phone_no
+            phone_no = phone_no.replace(" ", "").replace("(", "").replace(")", "").replace("-", "") if phone_no else ""
+            rec.phone_sanitized = phone_no

spp_base_common/models/phone_validation.py

@@ -0,0 +1,33 @@
+from odoo import api, fields, models
+
+
+class SPPPhoneValidation(models.Model):
+    _name = "spp.phone.validation"
+    _description = "SPP Phone Validation"
+
+    name = fields.Char(string="Sample Format", compute="_compute_name")
+    number_of_digits = fields.Integer(string="Number of Digits", required=True)
+    with_prefix = fields.Boolean(string="With Prefix")
+    prefix = fields.Char(string="Prefix")
+    state = fields.Selection(
+        [("active", "Active"), ("inactive", "Inactive")],
+        string="State",
+        default="active",
+    )
+    active = fields.Boolean(string="Active", default=True)
+
+    @api.depends("number_of_digits", "with_prefix", "prefix")
+    def _compute_name(self):
+        for record in self:
+            if record.with_prefix and record.prefix:
+                record.name = f"{record.prefix}{'X'*record.number_of_digits}"
+            else:
+                record.name = "X" * record.number_of_digits
+
+    def activate_phone_validation(self):
+        for record in self:
+            record.state = "active"
+
+    def deactivate_phone_validation(self):
+        for record in self:
+            record.state = "inactive"

spp_base_common/security/ir.model.access.csv

@@ -8,6 +8,7 @@ registrant_tag_read_registry_access,Registrant Tags Read Access,g2p_registry_bas
 id_type_read_registry_access,ID Type Read Access,g2p_registry_base.model_g2p_id_type,spp_base_common.read_registry,1,0,0,0
 spp_read_res_model_access,Res Model Read Access,base.model_ir_model,spp_base_common.read_registry,1,0,0,0
 spp_read_res_model_fields_access,Res Model Fields Read Access,base.model_ir_model_fields,spp_base_common.read_registry,1,0,0,0
+spp_phone_number_validation_read_access,Phone Number Validation Read Access,spp_base_common.model_spp_phone_validation,spp_base_common.read_registry,1,0,0,0
 
 res_partner_write_registry_access,Registry Write Access,base.model_res_partner,spp_base_common.write_registry,1,1,0,0
 phone_number_write_registry_access,Phone Number Write Access,g2p_registry_base.model_g2p_phone_number,spp_base_common.write_registry,1,1,0,0
@@ -17,6 +18,7 @@ registrant_tag_write_registry_access,Registrant Tags Write Access,g2p_registry_b
 id_type_write_registry_access,ID Type Write Access,g2p_registry_base.model_g2p_id_type,spp_base_common.write_registry,1,1,0,0
 spp_write_res_model_access,Res Model Write Access,base.model_ir_model,spp_base_common.write_registry,1,1,0,0
 spp_write_res_model_fields_access,Res Model Fields Write Access,base.model_ir_model_fields,spp_base_common.write_registry,1,1,0,0
+spp_phone_number_validation_write_access,Phone Number Validation Write Access,spp_base_common.model_spp_phone_validation,spp_base_common.write_registry,1,1,0,0
 
 res_partner_create_registry_access,Registry Create Access,base.model_res_partner,spp_base_common.create_registry,1,0,1,0
 phone_number_create_registry_access,Phone Number Create Access,g2p_registry_base.model_g2p_phone_number,spp_base_common.create_registry,1,0,1,0
@@ -26,3 +28,4 @@ registrant_tag_create_registry_access,Registrant Tags Create Access,g2p_registry
 id_type_create_registry_access,ID Type Create Access,g2p_registry_base.model_g2p_id_type,spp_base_common.create_registry,1,0,1,0
 spp_create_res_model_access,Res Model Create Access,base.model_ir_model,spp_base_common.create_registry,1,0,1,0
 spp_create_res_model_fields_access,Res Model Fields Create Access,base.model_ir_model_fields,spp_base_common.create_registry,1,0,1,0
+spp_phone_number_validation_create_access,Phone Number Validation Create Access,spp_base_common.model_spp_phone_validation,spp_base_common.create_registry,1,0,1,0

spp_base_common/tests/__init__.py

@@ -1 +1,2 @@
 from . import test_ir_module_module
+from . import test_phone_number_validation

spp_base_common/tests/test_phone_number_validation.py

@@ -0,0 +1,103 @@
+from odoo.exceptions import ValidationError
+from odoo.tests import TransactionCase
+
+
+class TestPhoneValidation(TransactionCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.partner_model = cls.env["res.partner"]
+        cls.phone_validation_model = cls.env["spp.phone.validation"]
+        cls.phone_model = cls.env["g2p.phone.number"]
+        cls.registrant = cls.partner_model.create(
+            {
+                "name": "Test Registrant",
+                "is_registrant": True,
+            }
+        )
+        cls.phone_validation_1 = cls.phone_validation_model.create(
+            {
+                "number_of_digits": 10,
+                "with_prefix": True,
+                "prefix": "+63",
+                "state": "active",
+            }
+        )
+        cls.phone_validation_2 = cls.phone_validation_model.create(
+            {
+                "number_of_digits": 11,
+                "with_prefix": False,
+                "state": "active",
+            }
+        )
+
+    def test_01_create_phone_with_invalid_number(self):
+        phone = self.phone_model.create(
+            {
+                "partner_id": self.registrant.id,
+                "phone_no": "+639123456789",
+                "country_id": self.env.ref("base.ph").id,
+            }
+        )
+
+        with self.assertRaises(ValidationError) as cm:
+            phone.phone_no = "12345"
+            phone._onchange_phone_validation()
+
+        self.assertIn("Phone number must match one of the following formats", str(cm.exception))
+
+    def test_02_create_phone_with_valid_number_with_prefix(self):
+        phone = self.phone_model.create(
+            {
+                "partner_id": self.registrant.id,
+                "phone_no": "+639123456789",
+                "country_id": self.env.ref("base.ph").id,
+            }
+        )
+        phone._onchange_phone_validation()
+        self.assertEqual(phone.phone_no, "+639123456789")
+
+        phone = self.phone_model.create(
+            {
+                "partner_id": self.registrant.id,
+                "phone_no": "+639-1234-56789",
+                "country_id": self.env.ref("base.ph").id,
+            }
+        )
+        phone._onchange_phone_validation()
+        self.assertEqual(phone.phone_no, "+639-1234-56789")
+        self.assertEqual(phone.phone_sanitized, "+639123456789")
+
+    def test_03_create_phone_with_valid_number_without_prefix(self):
+        phone = self.phone_model.create(
+            {
+                "partner_id": self.registrant.id,
+                "phone_no": "09123456789",
+                "country_id": self.env.ref("base.ph").id,
+            }
+        )
+        phone._onchange_phone_validation()
+        self.assertEqual(phone.phone_no, "09123456789")
+
+    def test_04_create_phone_with_letters_in_number(self):
+        phone_vals = {
+            "partner_id": self.registrant.id,
+            "phone_no": "09123A56789",
+            "country_id": self.env.ref("base.ph").id,
+        }
+        with self.assertRaises(ValidationError) as cm:
+            self.phone_model.create(phone_vals)
+
+        self.assertIn("Phone number must not contain letters", str(cm.exception))
+
+    def test_05_create_phone_with_invalid_special_characters(self):
+        phone_vals = {
+            "partner_id": self.registrant.id,
+            "phone_no": "09123@456789",
+            "country_id": self.env.ref("base.ph").id,
+        }
+
+        with self.assertRaises(ValidationError) as cm:
+            self.phone_model.create(phone_vals)
+
+        self.assertIn("Phone number contains invalid special characters", str(cm.exception))

spp_base_common/views/phone_validation_view.xml

@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+   Part of OpenSPP Registry. See LICENSE file for full copyright and licensing details.
+-->
+<odoo>
+    <record id="view_phone_validation_tree" model="ir.ui.view">
+        <field name="name">view_phone_validation_tree</field>
+        <field name="model">spp.phone.validation</field>
+        <field name="priority">1</field>
+        <field name="arch" type="xml">
+            <tree create="true" edit="true" delete="false" duplicate="false" editable="top">
+                <field name="number_of_digits" />
+                <field name="with_prefix" />
+                <field name="prefix" />
+                <field name="name" />
+                <field
+                    name="state"
+                    decoration-danger="state == 'inactive'"
+                    decoration-success="state == 'active'"
+                    readonly="1"
+                />
+                <button
+                    name="activate_phone_validation"
+                    title="Activate"
+                    type="object"
+                    icon="fa-check"
+                    class="btn-success"
+                    invisible="state == 'active'"
+                />
+                <button
+                    name="deactivate_phone_validation"
+                    title="Deactivate"
+                    type="object"
+                    icon="fa-times"
+                    class="btn-danger"
+                    invisible="state == 'inactive'"
+                />
+                <field name="active" invisible="1" />
+            </tree>
+        </field>
+    </record>
+
+    <record id="phone_validation_search_view" model="ir.ui.view">
+        <field name="name">phone.validation.search.view</field>
+        <field name="model">spp.phone.validation</field>
+        <field name="arch" type="xml">
+            <search>
+                <filter
+                    string="Active"
+                    name="active"
+                    domain="[('state', '=', 'active')]"
+                    help="Filter to show only active phone validations."
+                />
+                <filter
+                    string="Inactive"
+                    name="active"
+                    domain="[('state', '=', 'inactive')]"
+                    help="Filter to show only inactive phone validations."
+                />
+                <filter
+                    string="Archived"
+                    name="archived"
+                    domain="[('active', '=', False)]"
+                    help="Filter to show only archived phone validations."
+                />
+            </search>
+        </field>
+    </record>
+
+    <record id="action_phone_validation" model="ir.actions.act_window">
+        <field name="name">Phone Validation</field>
+        <field name="type">ir.actions.act_window</field>
+        <field name="res_model">spp.phone.validation</field>
+        <field name="view_mode">tree</field>
+        <field name="context">{}</field>
+        <field name="domain">[]</field>
+        <field name="search_view_id" ref="phone_validation_search_view" />
+        <field name="help" type="html">
+            <p class="o_view_nocontent_smiling_face">
+                Add a Phone Validation!
+            </p><p>
+                Click the create button to enter a phone validation.
+            </p>
+        </field>
+    </record>
+
+    <record id="action_phone_validation_tree_view" model="ir.actions.act_window.view">
+        <field name="sequence" eval="1" />
+        <field name="view_mode">tree</field>
+        <field name="view_id" ref="view_phone_validation_tree" />
+        <field name="act_window_id" ref="action_phone_validation" />
+    </record>
+
+    <menuitem
+        id="menu_phone_validation"
+        name="Phone Validation"
+        action="action_phone_validation"
+        parent="g2p_registry_base.g2p_configuration_menu_root"
+        sequence="10"
+        groups="g2p_registry_base.group_g2p_admin,g2p_registry_base.group_g2p_registrar"
+    />
+
+</odoo>