diff options
Diffstat (limited to 'framework/validators/CCaptchaValidator.php')
| -rw-r--r-- | framework/validators/CCaptchaValidator.php | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/framework/validators/CCaptchaValidator.php b/framework/validators/CCaptchaValidator.php new file mode 100644 index 0000000..87f844c --- /dev/null +++ b/framework/validators/CCaptchaValidator.php @@ -0,0 +1,123 @@ +<?php +/** + * CCaptchaValidator class file. + * + * @author Qiang Xue <qiang.xue@gmail.com> + * @link http://www.yiiframework.com/ + * @copyright Copyright © 2008-2011 Yii Software LLC + * @license http://www.yiiframework.com/license/ + */ + +/** + * CCaptchaValidator validates that the attribute value is the same as the verification code displayed in the CAPTCHA. + * + * CCaptchaValidator should be used together with {@link CCaptchaAction}. + * + * @author Qiang Xue <qiang.xue@gmail.com> + * @version $Id: CCaptchaValidator.php 3124 2011-03-25 15:48:05Z qiang.xue $ + * @package system.validators + * @since 1.0 + */ +class CCaptchaValidator extends CValidator +{ + /** + * @var boolean whether the comparison is case sensitive. Defaults to false. + */ + public $caseSensitive=false; + /** + * @var string ID of the action that renders the CAPTCHA image. Defaults to 'captcha', + * meaning the 'captcha' action declared in the current controller. + * This can also be a route consisting of controller ID and action ID. + */ + public $captchaAction='captcha'; + /** + * @var boolean whether the attribute value can be null or empty. + * Defaults to false, meaning the attribute is invalid if it is empty. + */ + public $allowEmpty=false; + + /** + * Validates the attribute of the object. + * If there is any error, the error message is added to the object. + * @param CModel $object the object being validated + * @param string $attribute the attribute being validated + */ + protected function validateAttribute($object,$attribute) + { + $value=$object->$attribute; + if($this->allowEmpty && $this->isEmpty($value)) + return; + $captcha=$this->getCaptchaAction(); + if(!$captcha->validate($value,$this->caseSensitive)) + { + $message=$this->message!==null?$this->message:Yii::t('yii','The verification code is incorrect.'); + $this->addError($object,$attribute,$message); + } + } + + /** + * Returns the CAPTCHA action object. + * @return CCaptchaAction the action object + * @since 1.1.7 + */ + protected function getCaptchaAction() + { + if(($captcha=Yii::app()->getController()->createAction($this->captchaAction))===null) + { + if(strpos($this->captchaAction,'/')!==false) // contains controller or module + { + if(($ca=Yii::app()->createController($this->captchaAction))!==null) + { + list($controller,$actionID)=$ca; + $captcha=$controller->createAction($actionID); + } + } + if($captcha===null) + throw new CException(Yii::t('yii','CCaptchaValidator.action "{id}" is invalid. Unable to find such an action in the current controller.', + array('{id}'=>$this->captchaAction))); + } + return $captcha; + } + + /** + * Returns the JavaScript needed for performing client-side validation. + * @param CModel $object the data object being validated + * @param string $attribute the name of the attribute to be validated. + * @return string the client-side validation script. + * @see CActiveForm::enableClientValidation + * @since 1.1.7 + */ + public function clientValidateAttribute($object,$attribute) + { + $captcha=$this->getCaptchaAction(); + $message=$this->message!==null ? $this->message : Yii::t('yii','The verification code is incorrect.'); + $message=strtr($message, array( + '{attribute}'=>$object->getAttributeLabel($attribute), + )); + $code=$captcha->getVerifyCode(false); + $hash=$captcha->generateValidationHash($this->caseSensitive ? $code : strtolower($code)); + $js=" +var hash = $('body').data('{$this->captchaAction}.hash'); +if (hash == null) + hash = $hash; +else + hash = hash[".($this->caseSensitive ? 0 : 1)."]; +for(var i=value.length-1, h=0; i >= 0; --i) h+=value.".($this->caseSensitive ? '' : 'toLowerCase().')."charCodeAt(i); +if(h != hash) { + messages.push(".CJSON::encode($message)."); +} +"; + + if($this->allowEmpty) + { + $js=" +if($.trim(value)!='') { + $js +} +"; + } + + return $js; + } +} + |