CaptchaValidator.php 2.96 KB
Newer Older
w  
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8
namespace yii\captcha;
w  
Qiang Xue committed
9

Qiang Xue committed
10 11
use Yii;
use yii\base\InvalidConfigException;
Qiang Xue committed
12 13
use yii\validators\ValidationAsset;
use yii\validators\Validator;
Qiang Xue committed
14

w  
Qiang Xue committed
15
/**
w  
Qiang Xue committed
16
 * CaptchaValidator validates that the attribute value is the same as the verification code displayed in the CAPTCHA.
w  
Qiang Xue committed
17
 *
w  
Qiang Xue committed
18
 * CaptchaValidator should be used together with [[CaptchaAction]].
w  
Qiang Xue committed
19
 *
Qiang Xue committed
20 21 22 23
 * Note that once CAPTCHA validation succeeds, a new CAPTCHA will be generated automatically. As a result,
 * CAPTCHA validation should not be used in AJAX validation mode because it may fail the validation
 * even if a user enters the same code as shown in the CAPTCHA image which is actually different from the latest CAPTCHA code.
 *
w  
Qiang Xue committed
24
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
25
 * @since 2.0
w  
Qiang Xue committed
26
 */
w  
Qiang Xue committed
27
class CaptchaValidator extends Validator
w  
Qiang Xue committed
28
{
29 30 31
	/**
	 * @var boolean whether to skip this validator if the input is empty.
	 */
32
	public $skipOnEmpty = false;
w  
Qiang Xue committed
33 34 35 36 37
	/**
	 * @var boolean whether the comparison is case sensitive. Defaults to false.
	 */
	public $caseSensitive = false;
	/**
Qiang Xue committed
38
	 * @var string the route of the controller action that renders the CAPTCHA image.
w  
Qiang Xue committed
39
	 */
Qiang Xue committed
40 41
	public $captchaAction = 'site/captcha';

w  
Qiang Xue committed
42

Qiang Xue committed
43
	/**
Qiang Xue committed
44
	 * @inheritdoc
Qiang Xue committed
45 46 47 48 49
	 */
	public function init()
	{
		parent::init();
		if ($this->message === null) {
50
			$this->message = Yii::t('yii', 'The verification code is incorrect.');
Qiang Xue committed
51 52 53
		}
	}

w  
Qiang Xue committed
54
	/**
Qiang Xue committed
55
	 * @inheritdoc
w  
Qiang Xue committed
56
	 */
Qiang Xue committed
57
	protected function validateValue($value)
Qiang Xue committed
58
	{
59
		$captcha = $this->createCaptchaAction();
Qiang Xue committed
60 61
		$valid = !is_array($value) && $captcha->validate($value, $this->caseSensitive);
		return $valid ? null : [$this->message, []];
Qiang Xue committed
62 63
	}

w  
Qiang Xue committed
64
	/**
65
	 * Creates the CAPTCHA action object from the route specified by [[captchaAction]].
Qiang Xue committed
66
	 * @return \yii\captcha\CaptchaAction the action object
67
	 * @throws InvalidConfigException
w  
Qiang Xue committed
68
	 */
69
	public function createCaptchaAction()
w  
Qiang Xue committed
70
	{
Qiang Xue committed
71 72 73 74 75 76 77
		$ca = Yii::$app->createController($this->captchaAction);
		if ($ca !== false) {
			/** @var \yii\base\Controller $controller */
			list($controller, $actionID) = $ca;
			$action = $controller->createAction($actionID);
			if ($action !== null) {
				return $action;
w  
Qiang Xue committed
78
			}
w  
Qiang Xue committed
79
		}
Qiang Xue committed
80
		throw new InvalidConfigException('Invalid CAPTCHA action ID: ' . $this->captchaAction);
w  
Qiang Xue committed
81 82 83
	}

	/**
Qiang Xue committed
84
	 * @inheritdoc
w  
Qiang Xue committed
85
	 */
86
	public function clientValidateAttribute($object, $attribute, $view)
w  
Qiang Xue committed
87
	{
88
		$captcha = $this->createCaptchaAction();
w  
Qiang Xue committed
89 90
		$code = $captcha->getVerifyCode(false);
		$hash = $captcha->generateValidationHash($this->caseSensitive ? $code : strtolower($code));
Alexander Makarov committed
91
		$options = [
Qiang Xue committed
92 93 94
			'hash' => $hash,
			'hashKey' => 'yiiCaptcha/' . $this->captchaAction,
			'caseSensitive' => $this->caseSensitive,
95
			'message' => strtr($this->message, [
96
				'attribute' => $object->getAttributeLabel($attribute),
97
			]),
Alexander Makarov committed
98
		];
Qiang Xue committed
99
		if ($this->skipOnEmpty) {
Qiang Xue committed
100
			$options['skipOnEmpty'] = 1;
w  
Qiang Xue committed
101 102
		}

103
		ValidationAsset::register($view);
Qiang Xue committed
104
		return 'yii.validation.captcha(value, messages, ' . json_encode($options) . ');';
w  
Qiang Xue committed
105 106
	}
}