Changeset 3080

Timestamp:

07/11/2008 01:30:46 PM (5 months ago)

Author:

Geert

Message:

Added a promote config setting for Captcha which basically means after how many valid responses you want to promote a user to human. As soon as a user has been promoted Captcha responses will automatically validate. The only thing you should add in your controller or view is a check that hides the Captcha field if the user has been promoted. I updated the examples controller as well.

Location:

trunk

Files:

• application/controllers/examples.php (modified) (3 diffs)
• system/config/captcha.php (modified) (2 diffs)
• system/libraries/Captcha.php (modified) (3 diffs)

trunk/application/controllers/examples.php

@@ -175 +175 @@
         public function captcha()
         {
-                // Look at the counters in the Session Profiler
+                // Look at the counters for valid and invalid
+                // responses in the Session Profiler.
                 new Profiler;
 
-                // Load Captcha library
+                // Load Captcha library, you can supply the name
+                // of the config group you would like to use.
                 $captcha = new Captcha;
 
-                // Ban bots (that accept session cookies) after 50 invalid responses
+                // Ban bots (that accept session cookies) after 50 invalid responses.
                 // Be careful not to ban real people though! Set the threshold high enough.
                 if ($captcha->invalid_count() > 49)
@@ -189 +191 @@
                 if ($_POST)
                 {
-                        // User has not given three valid responses yet
-                        if ($captcha->valid_count() < 3)
+                        // Captcha::valid() is a static method that can be used as a Validation rule also.
+                        if (Captcha::valid($this->input->post('captcha_response')))
                         {
-                                // Captcha::valid() is a static method that can be used as a Validation rule also
-                                if (Captcha::valid($this->input->post('captcha_response')))
-                                {
-                                        echo '<p style="color:green">Good answer!</p>';
-                                }
-                                else
-                                {
-                                        echo '<p style="color:red">Wrong answer!</p>';
-                                }
+                                echo '<p style="color:green">Good answer!</p>';
                         }
+                        else
+                        {
+                                echo '<p style="color:red">Wrong answer!</p>';
+                        }
 
                         // Validate other fields here
                 }
 
-                // Open form
+                // Show form
                 echo form::open();
                 echo '<p>Other form fields here...</p>';
 
-                // Don't show Captcha anymore after three or more valid responses
-                if ($captcha->valid_count() < 3)
+                // Don't show Captcha anymore after the user has given enough valid
+                // responses. The "enough" count is set in the captcha config.
+                if ( ! $captcha->promoted())
                 {
                         echo '<p>';
@@ -217 +216 @@
                         echo '</p>';
                         echo form::input('captcha_response');
+                }
+                else
+                {
+                        echo '<p>You have been promoted to human.</p>';
                 }
 

trunk/system/config/captcha.php

@@ -14 +14 @@
  *  background - Path to background image file
  *  font       - Path to font file
+ *  promote    - Valid response count threshold to promote user (FALSE to disable)
  */
 $config['default'] = array
@@ -23 +24 @@
         'background' => '',
         'font'       => SYSPATH.'fonts/DejaVuSerif.ttf',
+        'promote'    => FALSE,
 );

trunk/system/libraries/Captcha.php

@@ -27 +27 @@
                 'background' => '',
                 'font'       => '',
+                'promote'    => FALSE,
         );
 
@@ -171 +172 @@
                 static $counted;
 
+                // User has been promoted, always TRUE and don't count anymore
+                if (self::instance()->promoted())
+                        return TRUE;
+
                 // Challenge result
                 $result = (sha1(strtoupper($response)) === Session::instance()->get('captcha_response'));
@@ -253 +258 @@
 
         /**
+         * Checks whether user has been promoted after having given enough valid responses.
+         *
+         * @return  boolean
+         */
+        public function promoted()
+        {
+                // Promotion has been disabled
+                if (self::$config['promote'] === FALSE)
+                        return FALSE;
+
+                // Compare the valid response count to the threshold
+                return ($this->valid_count() >= self::$config['promote']);
+        }
+
+        /**
          * Output the Captcha challenge.
          *