Changeset 7287 for main/waeup.sirp

Timestamp:

6 Dec 2011, 16:07:02 (13 years ago)

Author:

uli

Message:

• Fix interface.
• Implement getCaptcha.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/browser/captcha.py (modified) (3 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/browser/captcha.py

@@ -24 +24 @@
 import urllib2
 from zope import schema
-from zope.component import getUtilitiesFor
+from zope.component import getUtilitiesFor, getUtility, queryUtility
 from zope.interface import Interface
 from zope.publisher.interfaces.http import IHTTPRequest
@@ -96 +96 @@
     """A chooser that collects available captchas.
     """
-    def getAvailCaptchas(self):
+    def getAvailCaptchas():
         """Return a dict of available captchas with registered names as keys.
         """
 
-    def getCaptcha(self):
+    def getCaptcha():
         """Get captcha chosen for a certain site or default.
         """
 
-    def getConfigData(self, captcha):
+    def getConfigData(captcha):
         """Get a dict of config data for a certain captcha.
         """
 
-    def setConfigData(self, captcha, key, value):
+    def setConfigData(captcha, key, value):
         """Set a certain configuration key for a certain captcha.
         """
@@ -130 +130 @@
         """
         result = getUtilitiesFor(ICaptcha)
-        return dict([x for x in result
-                       if x != u''])
+        return dict([(name,inst) for name,inst in result
+                       if name != u''])
 
     def getCaptcha(self):
+        """Get captcha chosen to be used.
+
+        Sites can activate a specific captcha by setting
+        ``site['configuration']['captcha']``. The value should be a
+        string under which the specific captcha is registered.
+
+        If this value cannot be found (or is not set at all) or we are
+        not 'in a site', the default captcha is returned.
+        """
         site = grok.getSite()
         name = ''
         if site is None:
-            # return the default captcha, registered without name
             return getUtility(ICaptcha)
         name = site.get('configuration', None).get('captcha', u'')
-        return getUtility(ICaptcha, name=name)
+        return queryUtility(ICaptcha, name=name,
+                            default=getUtility(ICaptcha))
 
 #