Changeset 18083 for main/waeup.kofa/branches/uli-recaptcha/src/waeup/kofa/zcml.py

Timestamp:

7 Jun 2025, 02:06:59 (5 days ago)

Author:

uli

Message:

Support Google Recaptcha v3.

File:

• main/waeup.kofa/branches/uli-recaptcha/src/waeup/kofa/zcml.py (modified) (2 diffs)

main/waeup.kofa/branches/uli-recaptcha/src/waeup/kofa/zcml.py

@@ -17 +17 @@
 ##
 from zope.component.zcml import handler
-from waeup.kofa.interfaces import IDataCenterConfig
+from waeup.kofa.interfaces import IDataCenterConfig, IReCaptchaConfig
 
 def data_center_conf(context, path):
@@ -49 +49 @@
                 {'path':path}, IDataCenterConfig, '')
         )
+
+
+def recaptcha_conf(context, public_key, private_key, hostname, min_score):
+    """Handler for ZCML ``recaptcha`` directive.
+
+    Registers a global utility under IReCaptchaConfig and containing a
+    dictionary with entries: `enabled`, `public_key`, `private__key` and `url`.
+
+    The directive can be put into site.zcml like this:
+
+    - Add to the header:
+        ``xmlns:kofa="http://namespaces.waeup.org/kofa"``
+
+    - Then, after including waeup.kofa:
+        ``<kofa:recaptcha
+             public_key="<YOUR_PUBKEY_HERE>"
+             private_key="<YOUR_PRIVKEY_HERE>"
+             hostname="mysite.com"
+             min_score="0.7"
+             />``
+
+    In a running instance (where some directive like above was
+    processed during startup), one can then ask for the
+    IReCaptchaConfig utility:
+
+      >>> from waeup.kofa.interfaces import IReCaptchaConfig
+      >>> from zope.component import getUtility
+      >>> getUtility(IRecaptchaConfig)
+      {'enabled': False,
+              'public_key': '<GOOGLE_SITEKEY',
+              'private_key': 'GOOGLE_PRIVATE_SITE_KEY',
+              'hostname': 'mydomain.com'
+              'min_score': Decimal(0.7)}
+
+    """
+    context.action(
+        discriminator = ('utility', IReCaptchaConfig, ''),
+        callable = handler,
+        args = ('registerUtility',
+                {
+                    'public_key': public_key,
+                    'private_key': private_key,
+                    'hostname': hostname,
+                    'min_score': min_score
+                    }, IReCaptchaConfig, '')
+        )