HTMLCaptchaField.php

   1 <?php
   2 /**
   3  * HTMLFormField for inserting Captchas into a form.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @class
  21  */
  22 class HTMLCaptchaField extends HTMLFormField {
  23         /**
  24          * @var Captcha
  25          */
  26         private $captcha;
  27
  28         public $prefix = '';
  29
  30         /**
  31          * @var Bool|Array
  32          */
  33         private $validationResult;
  34
  35         public function __construct( $params ) {
  36                 parent::__construct( $params );
  37
  38                 // For differentiating the type of form, mainly
  39                 if ( isset( $params['prefix'] ) ) {
  40                         $this->prefix = $params['prefix'];
  41                 }
  42         }
  43
  44         /**
  45          * Get the captcha body.  Don't include any of the surrounding table cells/rows
  46          *
  47          * @param  $value String
  48          * @return String
  49          */
  50         public function getInputHTML( $value ) {
  51                 # TODO
  52         }
  53
  54         public function validate( $data, $alldata ) {
  55                 // We sent back the exists status of the captcha before.  If it *doesn't* exist
  56                 // we actually want to validate this as true, because we don't want an angry red
  57                 // error message, just for the user to put the captcha in again
  58                 if ( $data === false ) {
  59                         return true;
  60                 }
  61         }
  62
  63         /**
  64          * @param  $request WebRequest
  65          * @return void
  66          */
  67         public function loadDataFromRequest( $request ) {
  68                 $this->captcha = Captcha::factory();
  69                 $this->captcha->loadFromRequest( $request, $this );
  70                 if ( !$this->captcha->exists() ) {
  71                         // The captcha doesn't exist; probably because it's already been used and
  72                         // then deleted for security.  Load the field up with a new captcha which
  73                         // will be shown to the user when the validation of said new object fails
  74                         $this->captcha = Captcha::newRandom();
  75                 }
  76
  77                 // This will be useful as the difference between "the captcha doesn't exist" and
  78                 // "you answered the captcha wrongly"
  79                 return $this->captcha->exists();
  80         }
  81 }