interface/modules/zend_modules/library/Zend/Captcha/ReCaptcha.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Captcha;
  11
  12 use Traversable;
  13 use ZendService\ReCaptcha\ReCaptcha as ReCaptchaService;
  14
  15 /**
  16  * ReCaptcha adapter
  17  *
  18  * Allows to insert captchas driven by ReCaptcha service
  19  *
  20  * @see http://recaptcha.net/apidocs/captcha/
  21  */
  22 class ReCaptcha extends AbstractAdapter
  23 {
  24     /**@+
  25      * ReCaptcha Field names
  26      * @var string
  27      */
  28     protected $CHALLENGE = 'recaptcha_challenge_field';
  29     protected $RESPONSE  = 'recaptcha_response_field';
  30     /**@-*/
  31
  32     /**
  33      * Recaptcha service object
  34      *
  35      * @var ReCaptchaService
  36      */
  37     protected $service;
  38
  39     /**
  40      * Parameters defined by the service
  41      *
  42      * @var array
  43      */
  44     protected $serviceParams = array();
  45
  46     /**
  47      * Options defined by the service
  48      *
  49      * @var array
  50      */
  51     protected $serviceOptions = array();
  52
  53     /**#@+
  54      * Error codes
  55      */
  56     const MISSING_VALUE = 'missingValue';
  57     const ERR_CAPTCHA   = 'errCaptcha';
  58     const BAD_CAPTCHA   = 'badCaptcha';
  59     /**#@-*/
  60
  61     /**
  62      * Error messages
  63      * @var array
  64      */
  65     protected $messageTemplates = array(
  66         self::MISSING_VALUE => 'Missing captcha fields',
  67         self::ERR_CAPTCHA   => 'Failed to validate captcha',
  68         self::BAD_CAPTCHA   => 'Captcha value is wrong: %value%',
  69     );
  70
  71     /**
  72      * Retrieve ReCaptcha Private key
  73      *
  74      * @return string
  75      */
  76     public function getPrivkey()
  77     {
  78         return $this->getService()->getPrivateKey();
  79     }
  80
  81     /**
  82      * Retrieve ReCaptcha Public key
  83      *
  84      * @return string
  85      */
  86     public function getPubkey()
  87     {
  88         return $this->getService()->getPublicKey();
  89     }
  90
  91     /**
  92      * Set ReCaptcha Private key
  93      *
  94      * @param  string $privkey
  95      * @return ReCaptcha
  96      */
  97     public function setPrivkey($privkey)
  98     {
  99         $this->getService()->setPrivateKey($privkey);
 100         return $this;
 101     }
 102
 103     /**
 104      * Set ReCaptcha public key
 105      *
 106      * @param  string $pubkey
 107      * @return ReCaptcha
 108      */
 109     public function setPubkey($pubkey)
 110     {
 111         $this->getService()->setPublicKey($pubkey);
 112         return $this;
 113     }
 114
 115     /**
 116      * Constructor
 117      *
 118      * @param  null|array|Traversable $options
 119      */
 120     public function __construct($options = null)
 121     {
 122         $this->setService(new ReCaptchaService());
 123         $this->serviceParams  = $this->getService()->getParams();
 124         $this->serviceOptions = $this->getService()->getOptions();
 125
 126         parent::__construct($options);
 127
 128         if (!empty($options)) {
 129             if (array_key_exists('private_key', $options)) {
 130                 $this->getService()->setPrivateKey($options['private_key']);
 131             }
 132             if (array_key_exists('public_key', $options)) {
 133                 $this->getService()->setPublicKey($options['public_key']);
 134             }
 135             $this->setOptions($options);
 136         }
 137     }
 138
 139     /**
 140      * Set service object
 141      *
 142      * @param  ReCaptchaService $service
 143      * @return ReCaptcha
 144      */
 145     public function setService(ReCaptchaService $service)
 146     {
 147         $this->service = $service;
 148         return $this;
 149     }
 150
 151     /**
 152      * Retrieve ReCaptcha service object
 153      *
 154      * @return ReCaptchaService
 155      */
 156     public function getService()
 157     {
 158         return $this->service;
 159     }
 160
 161     /**
 162      * Set option
 163      *
 164      * If option is a service parameter, proxies to the service. The same
 165      * goes for any service options (distinct from service params)
 166      *
 167      * @param  string $key
 168      * @param  mixed $value
 169      * @return ReCaptcha
 170      */
 171     public function setOption($key, $value)
 172     {
 173         $service = $this->getService();
 174         if (isset($this->serviceParams[$key])) {
 175             $service->setParam($key, $value);
 176             return $this;
 177         }
 178         if (isset($this->serviceOptions[$key])) {
 179             $service->setOption($key, $value);
 180             return $this;
 181         }
 182         return parent::setOption($key, $value);
 183     }
 184
 185     /**
 186      * Generate captcha
 187      *
 188      * @see AbstractAdapter::generate()
 189      * @return string
 190      */
 191     public function generate()
 192     {
 193         return "";
 194     }
 195
 196     /**
 197      * Validate captcha
 198      *
 199      * @see    \Zend\Validator\ValidatorInterface::isValid()
 200      * @param  mixed $value
 201      * @param  mixed $context
 202      * @return bool
 203      */
 204     public function isValid($value, $context = null)
 205     {
 206         if (!is_array($value) && !is_array($context)) {
 207             $this->error(self::MISSING_VALUE);
 208             return false;
 209         }
 210
 211         if (!is_array($value) && is_array($context)) {
 212             $value = $context;
 213         }
 214
 215         if (empty($value[$this->CHALLENGE]) || empty($value[$this->RESPONSE])) {
 216             $this->error(self::MISSING_VALUE);
 217             return false;
 218         }
 219
 220         $service = $this->getService();
 221
 222         $res = $service->verify($value[$this->CHALLENGE], $value[$this->RESPONSE]);
 223
 224         if (!$res) {
 225             $this->error(self::ERR_CAPTCHA);
 226             return false;
 227         }
 228
 229         if (!$res->isValid()) {
 230             $this->error(self::BAD_CAPTCHA, $res->getErrorCode());
 231             $service->setParam('error', $res->getErrorCode());
 232             return false;
 233         }
 234
 235         return true;
 236     }
 237
 238     /**
 239      * Get helper name used to render captcha
 240      *
 241      * @return string
 242      */
 243     public function getHelperName()
 244     {
 245         return "captcha/recaptcha";
 246     }
 247 }