mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
f7aa3ac61a
svn://svn.silverstripe.com/silverstripe/modules/sapphire/branches/2.2.0-mesq ........ r51249 | ischommer | 2008-03-18 11:58:39 +1300 (Tue, 18 Mar 2008) | 1 line added $titleConfirmField as fallback to localized default ........ git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@52413 467b73ca-7a2a-4603-9d3b-597d59a354a9
337 lines
9.3 KiB
PHP
337 lines
9.3 KiB
PHP
<?php
|
|
/**
|
|
* Shows two password-fields, and checks for matching passwords.
|
|
* Optionally hides the fields by default and shows
|
|
* a link to toggle their visibility.
|
|
*
|
|
* @package forms
|
|
* @subpackage fields-formattedinput
|
|
*/
|
|
class ConfirmedPasswordField extends FormField {
|
|
|
|
/**
|
|
* Minimum character length of the password.
|
|
*
|
|
* @var int
|
|
*/
|
|
public $minLength = 6;
|
|
|
|
/**
|
|
* Maximum character length of the password.
|
|
*
|
|
* @var int
|
|
*/
|
|
public $maxLength = 20;
|
|
|
|
/**
|
|
* Enforces at least one digit and one alphanumeric
|
|
* character (in addition to {$minLength} and {$maxLength}
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $requireStrongPassword = false;
|
|
|
|
/**
|
|
* Allow empty fields in serverside validation
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $canBeEmpty = false;
|
|
|
|
/**
|
|
* Hide the two password fields by default,
|
|
* and provide a link instead that toggles them.
|
|
*
|
|
* @var boolean
|
|
*/
|
|
protected $showOnClick = false;
|
|
|
|
/**
|
|
* Title for the link that triggers
|
|
* the visibility of password fields.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $showOnClickTitle = 'Change Password';
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param string $title
|
|
* @param mixed $value
|
|
* @param Form $form
|
|
* @param boolean $showOnClick
|
|
* @param string $titleConfirmField Alternate title (not localizeable)
|
|
*/
|
|
function __construct($name, $title = null, $value = "", $form = null, $showOnClick = false, $titleConfirmField = null) {
|
|
// naming with underscores to prevent values from actually being saved somewhere
|
|
$this->children = new FieldSet(
|
|
new PasswordField(
|
|
"{$name}[_Password]",
|
|
(isset($title)) ? $title : _t('Member.PASSWORD')),
|
|
new PasswordField(
|
|
"{$name}[_ConfirmPassword]",
|
|
(isset($titleConfirmField)) ? $titleConfirmField : _t('Member.CONFIRMPASSWORD', 'Confirm Password')
|
|
)
|
|
);
|
|
|
|
$this->showOnClick = $showOnClick;
|
|
if($this->showOnClick) {
|
|
$this->children->push(new HiddenField("{$name}[_PasswordFieldVisible]"));
|
|
}
|
|
|
|
// we have labels for the subfields
|
|
$title = false;
|
|
|
|
parent::__construct($name, $title, $value, $form);
|
|
}
|
|
|
|
function Field() {
|
|
Requirements::javascript('jsparty/prototype.js');
|
|
Requirements::javascript('jsparty/behaviour.js');
|
|
Requirements::javascript('sapphire/javascript/ConfirmedPasswordField.js');
|
|
|
|
$content = '';
|
|
|
|
if($this->showOnClick) {
|
|
|
|
$content .= "<div class=\"showOnClick\">\n";
|
|
$content .= "<a href=\"#\"" . $this->getTabIndexHTML() . ">{$this->showOnClickTitle}</a>\n";
|
|
$content .= "<div class=\"showOnClickContainer\">";
|
|
}
|
|
|
|
foreach($this->children as $field) {
|
|
$content .= $field->FieldHolder();
|
|
}
|
|
|
|
if($this->showOnClick) {
|
|
$content .= "</div>\n";
|
|
$content .= "</div>\n";
|
|
}
|
|
|
|
return $content;
|
|
}
|
|
|
|
/**
|
|
* Can be empty is a flag that turns on/off empty field checking.
|
|
* For example, set this to false (the default) when creating a user account,
|
|
* and true
|
|
*/
|
|
function setCanBeEmpty($value) {
|
|
$this->canBeEmpty = (bool)$value;
|
|
}
|
|
|
|
function setRightTitle($title) {
|
|
foreach($this->children as $field) {
|
|
$field->setRightTitle($title);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Value is sometimes an array, and sometimes a single value, so we need to handle both cases
|
|
*/
|
|
function setValue($value) {
|
|
if(is_array($value)) {
|
|
if($value['_Password'] || (!$value['_Password'] && !$this->canBeEmpty)) {
|
|
$this->value = $value['_Password'];
|
|
}
|
|
} else {
|
|
if($value || (!$value && !$this->canBeEmpty)) {
|
|
$this->value = $value;
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
function jsValidation() {
|
|
$formID = $this->form->FormName();
|
|
$jsTests = '';
|
|
|
|
$jsTests .= "
|
|
// if fields are hidden, reset values and don't validate
|
|
var containers = $$('.showOnClickContainer', $('#'+fieldName));
|
|
if(containers.length && !Element.visible(containers[0])) {
|
|
passEl.value = null;
|
|
confEl.value = null;
|
|
return true;
|
|
}
|
|
";
|
|
|
|
$error1 = _t('ConfirmedPasswordField.HAVETOMATCH', 'Passwords have to match.');
|
|
$jsTests .= "
|
|
if(passEl.value != confEl.value) {
|
|
validationError(confEl, \"$error1\", \"error\");
|
|
return false;
|
|
}
|
|
";
|
|
|
|
$error2 = _t('ConfirmedPasswordField.NOEMPTY', 'Passwords can\'t be empty.');
|
|
if(!$this->canBeEmpty) {
|
|
$jsTests .= "
|
|
if(!passEl.value || !confEl.value) {
|
|
validationError(confEl, \"$error2\", \"error\");
|
|
return false;
|
|
}
|
|
";
|
|
}
|
|
|
|
if(($this->minLength || $this->maxLength)) {
|
|
if($this->minLength && $this->maxLength) {
|
|
$limit = "{$this->minLength},{$this->maxLength}";
|
|
$errorMsg = sprintf(_t('ConfirmedPasswordField.BETWEEN', 'Passwords must be %s to %s characters long.'), $this->minLength, $this->maxLength);
|
|
} elseif($this->minLength) {
|
|
$limit = "{$this->minLength}";
|
|
$errorMsg = sprintf(_t('ConfirmedPasswordField.ATLEAST', 'Passwords must be at least %s characters long.'), $this->minLength);
|
|
} elseif($this->maxLength) {
|
|
$limit = "0,{$this->maxLength}";
|
|
$errorMsg = sprintf(_t('ConfirmedPasswordField.MAXIMUM', 'Passwords must be at most %s characters long.'), $this->maxLength);
|
|
}
|
|
$limitRegex = '/^.{' . $limit . '}$/';
|
|
$jsTests .= "
|
|
if(passEl.value && !passEl.value.match({$limitRegex})) {
|
|
validationError(confEl, \"{$errorMsg}\", \"error\");
|
|
return false;
|
|
}
|
|
";
|
|
}
|
|
|
|
$error3 = _t('ConfirmedPasswordField.LEASTONE', 'Passwords must have at least one digit and one alphanumeric character.');
|
|
if($this->requireStrongPassword) {
|
|
$jsTests .= "
|
|
if(!passEl.value.match(/^(([a-zA-Z]+\d+)|(\d+[a-zA-Z]+))[a-zA-Z0-9]*$/)) {
|
|
validationError(
|
|
confEl,
|
|
\"$error3\",
|
|
\"error\"
|
|
);
|
|
return false;
|
|
}
|
|
";
|
|
}
|
|
|
|
$jsFunc =<<<JS
|
|
Behaviour.register({
|
|
"#$formID": {
|
|
validateConfirmedPassword: function(fieldName) {
|
|
var passEl = _CURRENT_FORM.elements['Password[_Password]'];
|
|
var confEl = _CURRENT_FORM.elements['Password[_ConfirmPassword]'];
|
|
$jsTests
|
|
return true;
|
|
}
|
|
}
|
|
});
|
|
JS;
|
|
Requirements :: customScript($jsFunc, 'func_validateConfirmedPassword');
|
|
|
|
//return "\$('$formID').validateConfirmedPassword('$this->name');";
|
|
return <<<JS
|
|
if(typeof fromAnOnBlur != 'undefined'){
|
|
if(fromAnOnBlur.name == '$this->name')
|
|
$('$formID').validateConfirmedPassword('$this->name');
|
|
}else{
|
|
$('$formID').validateConfirmedPassword('$this->name');
|
|
}
|
|
JS;
|
|
}
|
|
|
|
/**
|
|
* Determines if the field was actually
|
|
* shown on the clientside - if not,
|
|
* we don't validate or save it.
|
|
*
|
|
* @return bool
|
|
*/
|
|
function isSaveable() {
|
|
$isVisible = $this->children->fieldByName($this->Name() . '[_PasswordFieldVisible]');
|
|
return (!$this->showOnClick || ($this->showOnClick && $isVisible && $isVisible->Value()));
|
|
}
|
|
|
|
function validate() {
|
|
$validator = $this->form->getValidator();
|
|
$name = $this->name;
|
|
|
|
// if field isn't visible, don't validate
|
|
if(!$this->isSaveable()) return true;
|
|
|
|
$passwordField = $this->children->fieldByName($name.'[_Password]');
|
|
$passwordConfirmField = $this->children->fieldByName($name.'[_ConfirmPassword]');
|
|
$passwordField->setValue($_POST[$name]['_Password']);
|
|
$passwordConfirmField->setValue($_POST[$name]['_ConfirmPassword']);
|
|
|
|
$value = $passwordField->Value();
|
|
|
|
// both password-fields should be the same
|
|
if($value != $passwordConfirmField->Value()) {
|
|
$validator->validationError($name, _t('Form.VALIDATIONPASSWORDSDONTMATCH',"Passwords don't match"), "validation", false);
|
|
return false;
|
|
}
|
|
|
|
if(!$this->canBeEmpty) {
|
|
// both password-fields shouldn't be empty
|
|
if(!$value || !$passwordConfirmField->Value()) {
|
|
$validator->validationError($name, _t('Form.VALIDATIONPASSWORDSNOTEMPTY', "Passwords can't be empty"), "validation", false);
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// lengths
|
|
if(($this->minLength || $this->maxLength)) {
|
|
if($this->minLength && $this->maxLength) {
|
|
$limit = "{$this->minLength},{$this->maxLength}";
|
|
$errorMsg = sprintf(_t('ConfirmedPasswordField.BETWEEN', 'Passwords must be %s to %s characters long.'), $this->minLength, $this->maxLength);
|
|
} elseif($this->minLength) {
|
|
$limit = "{$this->minLength}";
|
|
$errorMsg = sprintf(_t('ConfirmedPasswordField.ATLEAST', 'Passwords must be at least %s characters long.'), $this->minLength);
|
|
} elseif($this->maxLength) {
|
|
$limit = "0,{$this->maxLength}";
|
|
$errorMsg = sprintf(_t('ConfirmedPasswordField.MAXIMUM', 'Passwords must be at most %s characters long.'), $this->maxLength);
|
|
}
|
|
$limitRegex = '/^.{' . $limit . '}$/';
|
|
if(!empty($value) && !preg_match($limitRegex,$value)) {
|
|
$validator->validationError('Password', $errorMsg,
|
|
"validation",
|
|
false
|
|
);
|
|
}
|
|
}
|
|
|
|
if($this->requireStrongPassword) {
|
|
if(!preg_match('/^(([a-zA-Z]+\d+)|(\d+[a-zA-Z]+))[a-zA-Z0-9]*$/',$value)) {
|
|
$validator->validationError(
|
|
'Password',
|
|
_t('Form.VALIDATIONSTRONGPASSWORD', "Passwords must have at least one digit and one alphanumeric character."),
|
|
"validation",
|
|
false
|
|
);
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Only save if field was shown on the client,
|
|
* and is not empty.
|
|
*
|
|
* @param DataObject $record
|
|
* @return bool
|
|
*/
|
|
function saveInto(DataObject $record) {
|
|
if(!$this->isSaveable()) return false;
|
|
|
|
if(!($this->canBeEmpty && !$this->value)) {
|
|
parent::saveInto($record);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Makes a pretty readonly field with some stars in it
|
|
*/
|
|
function performReadonlyTransformation() {
|
|
$stars = '*****';
|
|
|
|
$field = new ReadonlyField($this->name, $this->title ? $this->title : _t('Member.PASSWORD'), $stars);
|
|
$field->setForm($this->form);
|
|
return $field;
|
|
}
|
|
}
|