library/Zend/Captcha/ReCaptcha.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Captcha
  17  * @subpackage Adapter
  18  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  20  */
  21
  22 /** Zend_Captcha_Base */
  23 require_once 'Zend/Captcha/Base.php';
  24
  25 /** Zend_Service_ReCaptcha */
  26 require_once 'Zend/Service/ReCaptcha.php';
  27
  28 /**
  29  * ReCaptcha adapter
  30  *
  31  * Allows to insert captchas driven by ReCaptcha service
  32  *
  33  * @see http://recaptcha.net/apidocs/captcha/
  34  *
  35  * @category   Zend
  36  * @package    Zend_Captcha
  37  * @subpackage Adapter
  38  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  39  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  40  * @version    $Id: ReCaptcha.php 16201 2009-06-21 18:51:15Z thomas $
  41  */
  42 class Zend_Captcha_ReCaptcha extends Zend_Captcha_Base
  43 {
  44     /**@+
  45      * ReCaptcha Field names
  46      * @var string
  47      */
  48     protected $_CHALLENGE = 'recaptcha_challenge_field';
  49     protected $_RESPONSE  = 'recaptcha_response_field';
  50     /**@-*/
  51
  52     /**
  53      * Recaptcha service object
  54      *
  55      * @var Zend_Service_Recaptcha
  56      */
  57     protected $_service;
  58
  59     /**
  60      * Parameters defined by the service
  61      *
  62      * @var array
  63      */
  64     protected $_serviceParams = array();
  65
  66     /**#@+
  67      * Error codes
  68      * @const string
  69      */
  70     const MISSING_VALUE = 'missingValue';
  71     const ERR_CAPTCHA   = 'errCaptcha';
  72     const BAD_CAPTCHA   = 'badCaptcha';
  73     /**#@-*/
  74
  75     /**
  76      * Error messages
  77      * @var array
  78      */
  79     protected $_messageTemplates = array(
  80         self::MISSING_VALUE => 'Missing captcha fields',
  81         self::ERR_CAPTCHA   => 'Failed to validate captcha',
  82         self::BAD_CAPTCHA   => 'Captcha value is wrong: %value%',
  83     );
  84
  85     /**
  86      * Retrieve ReCaptcha Private key
  87      *
  88      * @return string
  89      */
  90     public function getPrivkey()
  91     {
  92         return $this->getService()->getPrivateKey();
  93     }
  94
  95     /**
  96      * Retrieve ReCaptcha Public key
  97      *
  98      * @return string
  99      */
 100     public function getPubkey()
 101     {
 102         return $this->getService()->getPublicKey();
 103     }
 104
 105     /**
 106      * Set ReCaptcha Private key
 107      *
 108      * @param string $privkey
 109      * @return Zend_Captcha_ReCaptcha
 110      */
 111     public function setPrivkey($privkey)
 112     {
 113         $this->getService()->setPrivateKey($privkey);
 114         return $this;
 115     }
 116
 117     /**
 118      * Set ReCaptcha public key
 119      *
 120      * @param string $pubkey
 121      * @return Zend_Captcha_ReCaptcha
 122      */
 123     public function setPubkey($pubkey)
 124     {
 125         $this->getService()->setPublicKey($pubkey);
 126         return $this;
 127     }
 128
 129     /**
 130      * Constructor
 131      *
 132      * @param  array|Zend_Config $options
 133      * @return void
 134      */
 135     public function __construct($options = null)
 136     {
 137         $this->setService(new Zend_Service_ReCaptcha());
 138         $this->_serviceParams = $this->getService()->getParams();
 139
 140         parent::__construct($options);
 141
 142         if ($options instanceof Zend_Config) {
 143             $options = $options->toArray();
 144         }
 145         if (!empty($options)) {
 146             $this->setOptions($options);
 147         }
 148     }
 149
 150     /**
 151      * Set service object
 152      *
 153      * @param  Zend_Service_ReCaptcha $service
 154      * @return Zend_Captcha_ReCaptcha
 155      */
 156     public function setService(Zend_Service_ReCaptcha $service)
 157     {
 158         $this->_service = $service;
 159         return $this;
 160     }
 161
 162     /**
 163      * Retrieve ReCaptcha service object
 164      *
 165      * @return Zend_Service_ReCaptcha
 166      */
 167     public function getService()
 168     {
 169         return $this->_service;
 170     }
 171
 172     /**
 173      * Set option
 174      *
 175      * If option is a service parameter, proxies to the service.
 176      *
 177      * @param  string $key
 178      * @param  mixed $value
 179      * @return Zend_Captcha_ReCaptcha
 180      */
 181     public function setOption($key, $value)
 182     {
 183         $service = $this->getService();
 184         if (isset($this->_serviceParams[$key])) {
 185             $service->setParam($key, $value);
 186             return $this;
 187         }
 188         return parent::setOption($key, $value);
 189     }
 190
 191     /**
 192      * Generate captcha
 193      *
 194      * @see Zend_Form_Captcha_Adapter::generate()
 195      * @return string
 196      */
 197     public function generate()
 198     {
 199         return "";
 200     }
 201
 202     /**
 203      * Validate captcha
 204      *
 205      * @see    Zend_Validate_Interface::isValid()
 206      * @param  mixed $value
 207      * @return boolean
 208      */
 209     public function isValid($value, $context = null)
 210     {
 211         if (!is_array($value) && !is_array($context)) {
 212             $this->_error(self::MISSING_VALUE);
 213             return false;
 214         }
 215
 216         if (!is_array($value) && is_array($context)) {
 217             $value = $context;
 218         }
 219
 220         if (empty($value[$this->_CHALLENGE]) || empty($value[$this->_RESPONSE])) {
 221             $this->_error(self::MISSING_VALUE);
 222             return false;
 223         }
 224
 225         $service = $this->getService();
 226
 227         $res = $service->verify($value[$this->_CHALLENGE], $value[$this->_RESPONSE]);
 228
 229         if (!$res) {
 230             $this->_error(self::ERR_CAPTCHA);
 231             return false;
 232         }
 233
 234         if (!$res->isValid()) {
 235             $this->_error(self::BAD_CAPTCHA, $res->getErrorCode());
 236             $service->setParam('error', $res->getErrorCode());
 237             return false;
 238         }
 239
 240         return true;
 241     }
 242
 243     /**
 244      * Render captcha
 245      *
 246      * @param  Zend_View_Interface $view
 247      * @param  mixed $element
 248      * @return string
 249      */
 250     public function render(Zend_View_Interface $view = null, $element = null)
 251     {
 252         return $this->getService()->getHTML();
 253     }
 254 }