From f4c9ed3d24f10983a4712232620abdbdc6c1d3c6 Mon Sep 17 00:00:00 2001 From: gsinghpal Date: Thu, 14 May 2026 01:09:27 -0400 Subject: [PATCH] feat(fusion_clock): NFC tap photo capture + photo-required gate - Add _strip_data_url_prefix() helper to clean data-URL prefix from base64 photo payloads - Gate nfc_tap on fusion_clock.nfc_photo_required ICP param (default True): rejects with error='photo_required' when photo absent - Write x_fclk_check_in_photo / x_fclk_check_out_photo on clock-in/out attendance records - Add TestTapPhotoHandling (3 tests): photo saved, required-rejects-missing, optional-succeeds-without Co-Authored-By: Claude Sonnet 4.6 --- fusion_clock/controllers/clock_nfc_kiosk.py | 18 ++++++ fusion_clock/tests/test_clock_nfc_kiosk.py | 71 +++++++++++++++++++++ 2 files changed, 89 insertions(+) diff --git a/fusion_clock/controllers/clock_nfc_kiosk.py b/fusion_clock/controllers/clock_nfc_kiosk.py index 2f312a25..67e5da2f 100644 --- a/fusion_clock/controllers/clock_nfc_kiosk.py +++ b/fusion_clock/controllers/clock_nfc_kiosk.py @@ -32,6 +32,17 @@ def _is_debounced(uid): return False +def _strip_data_url_prefix(b64): + """Strip 'data:image/...;base64,' prefix from a data URL, returning raw base64.""" + if not b64: + return b'' + if isinstance(b64, str) and b64.startswith('data:'): + comma = b64.find(',') + if comma >= 0: + return b64[comma + 1:].encode('ascii', errors='ignore') + return b64.encode('ascii', errors='ignore') if isinstance(b64, str) else b64 + + class FusionClockNfcKiosk(http.Controller): """NFC tap-to-clock kiosk controller. Reuses FusionClockAPI helpers.""" @@ -144,6 +155,11 @@ class FusionClockNfcKiosk(http.Controller): if _is_debounced(normalized): return {'error': 'debounce'} + photo_required = ICP.get_param('fusion_clock.nfc_photo_required', 'True') == 'True' + if photo_required and not photo_b64: + return {'error': 'photo_required', 'message': 'Camera unavailable. Ask IT to check the kiosk.'} + photo_bytes = _strip_data_url_prefix(photo_b64) if photo_b64 else b'' + company = request.env.company location = company.x_fclk_nfc_kiosk_location_id if not location: @@ -179,6 +195,7 @@ class FusionClockNfcKiosk(http.Controller): 'x_fclk_location_id': location.id, 'x_fclk_in_distance': 0.0, 'x_fclk_clock_source': 'nfc_kiosk', + 'x_fclk_check_in_photo': photo_bytes if photo_bytes else False, }) api._log_activity( employee, 'clock_in', @@ -200,6 +217,7 @@ class FusionClockNfcKiosk(http.Controller): else: attendance.sudo().write({ 'x_fclk_out_distance': 0.0, + 'x_fclk_check_out_photo': photo_bytes if photo_bytes else False, }) api._apply_break_deduction(attendance, employee) _, scheduled_out = api._get_scheduled_times(employee, today) diff --git a/fusion_clock/tests/test_clock_nfc_kiosk.py b/fusion_clock/tests/test_clock_nfc_kiosk.py index 0624d5f7..ab04cfe9 100644 --- a/fusion_clock/tests/test_clock_nfc_kiosk.py +++ b/fusion_clock/tests/test_clock_nfc_kiosk.py @@ -308,3 +308,74 @@ class TestTapEndpointErrors(HttpCase): self.assertTrue(first.get('success')) second = self._tap('04:A2:B5:62:AC:01') self.assertEqual(second.get('error'), 'debounce') + + +@tagged('-at_install', 'post_install', 'fusion_clock') +class TestTapPhotoHandling(HttpCase): + + SAMPLE_PNG_DATAURL = ( + 'data:image/png;base64,' + 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAA' + 'C0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=' + ) + + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.ICP = cls.env['ir.config_parameter'].sudo() + cls.ICP.set_param('fusion_clock.enable_nfc_kiosk', 'True') + cls.location = cls.env['fusion.clock.location'].create({ + 'name': 'Photo Plant', + 'latitude': 43.65, + 'longitude': -79.38, + 'radius': 100, + }) + cls.env.company.x_fclk_nfc_kiosk_location_id = cls.location.id + cls.kiosk_user = cls.env['res.users'].create({ + 'name': 'Photo Kiosk User', + 'login': 'nfc-kiosk-photo', + 'password': 'kioskpass123', + 'group_ids': [(4, cls.env.ref('fusion_clock.group_fusion_clock_manager').id)], + }) + cls.emp = cls.env['hr.employee'].create({ + 'name': 'Photo Emp', + 'x_fclk_enable_clock': True, + 'x_fclk_nfc_card_uid': '04:A2:B5:62:F0:01', + }) + + def setUp(self): + super().setUp() + # Avoid debounce contamination from other test classes + from odoo.addons.fusion_clock.controllers import clock_nfc_kiosk as nfc_kiosk_module + nfc_kiosk_module._recent_taps.clear() + + def _tap(self, photo_b64=''): + self.authenticate('nfc-kiosk-photo', 'kioskpass123') + response = self.url_open( + '/fusion_clock/kiosk/nfc/tap', + data=json.dumps({ + 'jsonrpc': '2.0', 'method': 'call', + 'params': {'card_uid': '04:A2:B5:62:F0:01', 'photo_b64': photo_b64}, + }), + headers={'Content-Type': 'application/json'}, + ) + return response.json().get('result', {}) + + def test_photo_saved_on_clock_in(self): + self.ICP.set_param('fusion_clock.nfc_photo_required', 'True') + result = self._tap(self.SAMPLE_PNG_DATAURL) + self.assertTrue(result.get('success')) + attendance = self.env['hr.attendance'].search([ + ('employee_id', '=', self.emp.id), + ], order='check_in desc', limit=1) + self.assertTrue(attendance.x_fclk_check_in_photo) + + def test_photo_required_rejects_when_missing(self): + self.ICP.set_param('fusion_clock.nfc_photo_required', 'True') + result = self._tap(photo_b64='') + self.assertEqual(result.get('error'), 'photo_required') + + def test_photo_optional_succeeds_without_photo(self): + self.ICP.set_param('fusion_clock.nfc_photo_required', 'False') + result = self._tap(photo_b64='') + self.assertTrue(result.get('success'))