interface/modules/zend_modules/library/Zend/Captcha/AbstractWord.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 Zend\Math\Rand;
  13 use Zend\Session\Container;
  14
  15 /**
  16  * AbstractWord-based captcha adapter
  17  *
  18  * Generates random word which user should recognise
  19  */
  20 abstract class AbstractWord extends AbstractAdapter
  21 {
  22     /**#@+
  23      * @var array Character sets
  24      */
  25     public static $V  = array("a", "e", "i", "o", "u", "y");
  26     public static $VN = array("a", "e", "i", "o", "u", "y","2","3","4","5","6","7","8","9");
  27     public static $C  = array("b","c","d","f","g","h","j","k","m","n","p","q","r","s","t","u","v","w","x","z");
  28     public static $CN = array("b","c","d","f","g","h","j","k","m","n","p","q","r","s","t","u","v","w","x","z","2","3","4","5","6","7","8","9");
  29     /**#@-*/
  30
  31     /**
  32      * Random session ID
  33      *
  34      * @var string
  35      */
  36     protected $id;
  37
  38     /**
  39      * Generated word
  40      *
  41      * @var string
  42      */
  43     protected $word;
  44
  45     /**
  46      * Session
  47      *
  48      * @var Container
  49      */
  50     protected $session;
  51
  52     /**
  53      * Class name for sessions
  54      *
  55      * @var string
  56      */
  57     protected $sessionClass = 'Zend\Session\Container';
  58
  59     /**
  60      * Should the numbers be used or only letters
  61      *
  62      * @var bool
  63      */
  64     protected $useNumbers = true;
  65
  66     /**
  67      * Should both cases be used or only lowercase
  68      *
  69      * @var bool
  70      */
  71     // protected $useCase = false;
  72
  73     /**
  74      * Session lifetime for the captcha data
  75      *
  76      * @var int
  77      */
  78     protected $timeout = 300;
  79
  80     /**
  81      * Should generate() keep session or create a new one?
  82      *
  83      * @var bool
  84      */
  85     protected $keepSession = false;
  86
  87     /**#@+
  88      * Error codes
  89      */
  90     const MISSING_VALUE = 'missingValue';
  91     const MISSING_ID    = 'missingID';
  92     const BAD_CAPTCHA   = 'badCaptcha';
  93     /**#@-*/
  94
  95     /**
  96      * Error messages
  97      * @var array
  98      */
  99     protected $messageTemplates = array(
 100         self::MISSING_VALUE => 'Empty captcha value',
 101         self::MISSING_ID    => 'Captcha ID field is missing',
 102         self::BAD_CAPTCHA   => 'Captcha value is wrong',
 103     );
 104
 105     /**
 106      * Length of the word to generate
 107      *
 108      * @var int
 109      */
 110     protected $wordlen = 8;
 111
 112     /**
 113      * Retrieve session class to utilize
 114      *
 115      * @return string
 116      */
 117     public function getSessionClass()
 118     {
 119         return $this->sessionClass;
 120     }
 121
 122     /**
 123      * Set session class for persistence
 124      *
 125      * @param  string $sessionClass
 126      * @return AbstractWord
 127      */
 128     public function setSessionClass($sessionClass)
 129     {
 130         $this->sessionClass = $sessionClass;
 131         return $this;
 132     }
 133
 134     /**
 135      * Retrieve word length to use when generating captcha
 136      *
 137      * @return int
 138      */
 139     public function getWordlen()
 140     {
 141         return $this->wordlen;
 142     }
 143
 144     /**
 145      * Set word length of captcha
 146      *
 147      * @param int $wordlen
 148      * @return AbstractWord
 149      */
 150     public function setWordlen($wordlen)
 151     {
 152         $this->wordlen = $wordlen;
 153         return $this;
 154     }
 155
 156     /**
 157      * Retrieve captcha ID
 158      *
 159      * @return string
 160      */
 161     public function getId()
 162     {
 163         if (null === $this->id) {
 164             $this->setId($this->generateRandomId());
 165         }
 166         return $this->id;
 167     }
 168
 169     /**
 170      * Set captcha identifier
 171      *
 172      * @param string $id
 173      * @return AbstractWord
 174      */
 175     protected function setId($id)
 176     {
 177         $this->id = $id;
 178         return $this;
 179     }
 180
 181     /**
 182      * Set timeout for session token
 183      *
 184      * @param  int $ttl
 185      * @return AbstractWord
 186      */
 187     public function setTimeout($ttl)
 188     {
 189         $this->timeout = (int) $ttl;
 190         return $this;
 191     }
 192
 193     /**
 194      * Get session token timeout
 195      *
 196      * @return int
 197      */
 198     public function getTimeout()
 199     {
 200         return $this->timeout;
 201     }
 202
 203     /**
 204      * Sets if session should be preserved on generate()
 205      *
 206      * @param bool $keepSession Should session be kept on generate()?
 207      * @return AbstractWord
 208      */
 209     public function setKeepSession($keepSession)
 210     {
 211         $this->keepSession = $keepSession;
 212         return $this;
 213     }
 214
 215     /**
 216      * Numbers should be included in the pattern?
 217      *
 218      * @return bool
 219      */
 220     public function getUseNumbers()
 221     {
 222         return $this->useNumbers;
 223     }
 224
 225     /**
 226      * Set if numbers should be included in the pattern
 227      *
 228      * @param  bool $useNumbers numbers should be included in the pattern?
 229      * @return AbstractWord
 230      */
 231     public function setUseNumbers($useNumbers)
 232     {
 233         $this->useNumbers = $useNumbers;
 234         return $this;
 235     }
 236
 237     /**
 238      * Get session object
 239      *
 240      * @throws Exception\InvalidArgumentException
 241      * @return Container
 242      */
 243     public function getSession()
 244     {
 245         if (!isset($this->session) || (null === $this->session)) {
 246             $id = $this->getId();
 247             if (!class_exists($this->sessionClass)) {
 248                 throw new Exception\InvalidArgumentException("Session class $this->sessionClass not found");
 249             }
 250             $this->session = new $this->sessionClass('Zend_Form_Captcha_' . $id);
 251             $this->session->setExpirationHops(1, null);
 252             $this->session->setExpirationSeconds($this->getTimeout());
 253         }
 254         return $this->session;
 255     }
 256
 257     /**
 258      * Set session namespace object
 259      *
 260      * @param  Container $session
 261      * @return AbstractWord
 262      */
 263     public function setSession(Container $session)
 264     {
 265         $this->session = $session;
 266         if ($session) {
 267             $this->keepSession = true;
 268         }
 269         return $this;
 270     }
 271
 272     /**
 273      * Get captcha word
 274      *
 275      * @return string
 276      */
 277     public function getWord()
 278     {
 279         if (empty($this->word)) {
 280             $session     = $this->getSession();
 281             $this->word  = $session->word;
 282         }
 283         return $this->word;
 284     }
 285
 286     /**
 287      * Set captcha word
 288      *
 289      * @param  string $word
 290      * @return AbstractWord
 291      */
 292     protected function setWord($word)
 293     {
 294         $session       = $this->getSession();
 295         $session->word = $word;
 296         $this->word    = $word;
 297         return $this;
 298     }
 299
 300     /**
 301      * Generate new random word
 302      *
 303      * @return string
 304      */
 305     protected function generateWord()
 306     {
 307         $word       = '';
 308         $wordLen    = $this->getWordLen();
 309         $vowels     = $this->useNumbers ? static::$VN : static::$V;
 310         $consonants = $this->useNumbers ? static::$CN : static::$C;
 311
 312         for ($i=0; $i < $wordLen; $i = $i + 2) {
 313             // generate word with mix of vowels and consonants
 314             $consonant = $consonants[array_rand($consonants)];
 315             $vowel     = $vowels[array_rand($vowels)];
 316             $word     .= $consonant . $vowel;
 317         }
 318
 319         if (strlen($word) > $wordLen) {
 320             $word = substr($word, 0, $wordLen);
 321         }
 322
 323         return $word;
 324     }
 325
 326     /**
 327      * Generate new session ID and new word
 328      *
 329      * @return string session ID
 330      */
 331     public function generate()
 332     {
 333         if (!$this->keepSession) {
 334             $this->session = null;
 335         }
 336         $id = $this->generateRandomId();
 337         $this->setId($id);
 338         $word = $this->generateWord();
 339         $this->setWord($word);
 340         return $id;
 341     }
 342
 343     /**
 344      * Generate a random identifier
 345      *
 346      * @return string
 347      */
 348     protected function generateRandomId()
 349     {
 350         return md5(Rand::getBytes(32));
 351     }
 352
 353     /**
 354      * Validate the word
 355      *
 356      * @see    Zend\Validator\ValidatorInterface::isValid()
 357      * @param  mixed $value
 358      * @param  mixed $context
 359      * @return bool
 360      */
 361     public function isValid($value, $context = null)
 362     {
 363         if (!is_array($value)) {
 364             if (!is_array($context)) {
 365                 $this->error(self::MISSING_VALUE);
 366                 return false;
 367             }
 368             $value = $context;
 369         }
 370
 371         $name = $this->getName();
 372
 373         if (isset($value[$name])) {
 374             $value = $value[$name];
 375         }
 376
 377         if (!isset($value['input'])) {
 378             $this->error(self::MISSING_VALUE);
 379             return false;
 380         }
 381         $input = strtolower($value['input']);
 382         $this->setValue($input);
 383
 384         if (!isset($value['id'])) {
 385             $this->error(self::MISSING_ID);
 386             return false;
 387         }
 388
 389         $this->id = $value['id'];
 390         if ($input !== $this->getWord()) {
 391             $this->error(self::BAD_CAPTCHA);
 392             return false;
 393         }
 394
 395         return true;
 396     }
 397
 398     /**
 399      * Get helper name used to render captcha
 400      *
 401      * @return string
 402      */
 403     public function getHelperName()
 404     {
 405         return 'captcha/word';
 406     }
 407 }