You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

140 lines
4.1 KiB

14 years ago
<?php
/**
14 years ago
* UrlValidator class file.
14 years ago
*
* @link http://www.yiiframework.com/
14 years ago
* @copyright Copyright &copy; 2008-2012 Yii Software LLC
14 years ago
* @license http://www.yiiframework.com/license/
*/
14 years ago
namespace yii\validators;
14 years ago
/**
14 years ago
* UrlValidator validates that the attribute value is a valid http or https URL.
14 years ago
*
* @author Qiang Xue <qiang.xue@gmail.com>
14 years ago
* @since 2.0
14 years ago
*/
14 years ago
class UrlValidator extends Validator
14 years ago
{
/**
* @var string the regular expression used to validate the attribute value.
14 years ago
* The pattern may contain a `{schemes}` token that will be replaced
* by a regular expression which represents the [[validSchemes]].
14 years ago
*/
public $pattern = '/^{schemes}:\/\/(([A-Z0-9][A-Z0-9_-]*)(\.[A-Z0-9][A-Z0-9_-]*)+)/i';
/**
* @var array list of URI schemes which should be considered valid. By default, http and https
* are considered to be valid schemes.
**/
public $validSchemes = array('http', 'https');
/**
* @var string the default URI scheme. If the input doesn't contain the scheme part, the default
* scheme will be prepended to it (thus changing the input). Defaults to null, meaning a URL must
* contain the scheme part.
**/
public $defaultScheme;
/**
* @var boolean whether the attribute value can be null or empty. Defaults to true,
* meaning that if the attribute is empty, it is considered valid.
*/
public $allowEmpty = true;
/**
* Validates the attribute of the object.
* If there is any error, the error message is added to the object.
14 years ago
* @param \yii\base\Model $object the object being validated
14 years ago
* @param string $attribute the attribute being validated
*/
14 years ago
public function validateAttribute($object, $attribute)
14 years ago
{
$value = $object->$attribute;
14 years ago
if ($this->allowEmpty && $this->isEmpty($value)) {
14 years ago
return;
14 years ago
}
if (($value = $this->validateValue($value)) !== false) {
14 years ago
$object->$attribute = $value;
14 years ago
}
else {
14 years ago
$message = $this->message !== null ? $this->message : Yii::t('yii', '{attribute} is not a valid URL.');
$this->addError($object, $attribute, $message);
}
}
/**
* Validates a static value to see if it is a valid URL.
14 years ago
* Note that this method does not respect [[allowEmpty]] property.
14 years ago
* This method is provided so that you can call it directly without going through the model validation rule mechanism.
* @param mixed $value the value to be validated
* @return mixed false if the the value is not a valid URL, otherwise the possibly modified value ({@see defaultScheme})
*/
public function validateValue($value)
{
14 years ago
// make sure the length is limited to avoid DOS attacks
if (is_string($value) && strlen($value) < 2000) {
if ($this->defaultScheme !== null && strpos($value, '://') === false) {
14 years ago
$value = $this->defaultScheme . '://' . $value;
14 years ago
}
14 years ago
14 years ago
if (strpos($this->pattern, '{schemes}') !== false) {
14 years ago
$pattern = str_replace('{schemes}', '(' . implode('|', $this->validSchemes) . ')', $this->pattern);
14 years ago
}
else {
14 years ago
$pattern = $this->pattern;
14 years ago
}
14 years ago
14 years ago
if (preg_match($pattern, $value)) {
14 years ago
return $value;
14 years ago
}
14 years ago
}
return false;
}
/**
* Returns the JavaScript needed for performing client-side validation.
14 years ago
* @param \yii\base\Model $object the data object being validated
14 years ago
* @param string $attribute the name of the attribute to be validated.
* @return string the client-side validation script.
* @see CActiveForm::enableClientValidation
*/
public function clientValidateAttribute($object, $attribute)
{
$message = $this->message !== null ? $this->message : Yii::t('yii', '{attribute} is not a valid URL.');
$message = strtr($message, array(
'{attribute}' => $object->getAttributeLabel($attribute),
));
if (strpos($this->pattern, '{schemes}') !== false)
$pattern = str_replace('{schemes}', '(' . implode('|', $this->validSchemes) . ')', $this->pattern);
else
$pattern = $this->pattern;
$js = "
if(!value.match($pattern)) {
14 years ago
messages.push(" . json_encode($message) . ");
14 years ago
}
";
if ($this->defaultScheme !== null)
{
$js = "
if(!value.match(/:\\/\\//)) {
14 years ago
value=" . json_encode($this->defaultScheme) . "+'://'+value;
14 years ago
}
$js
";
}
if ($this->allowEmpty)
{
$js = "
if($.trim(value)!='') {
$js
}
";
}
return $js;
}
}