Skip to content

GitLab

Commit 991bd08d authored by daspeter's avatar daspeter Committed by Jelle Sebreghts
Browse files

Issue #2413877 by das-peter: Enhance Field Validation integration using remote validation

parent 76e1ce40
Hide whitespace changes
Inline Side-by-side
Showing with 426 additions and 2 deletions
clientside_validation.js
View file @ 991bd08d
......@@ -288,6 +288,12 @@
errorElement: self.forms[f].general.errorElement,
unhighlight: function(element, errorClass, validClass) {
var tab;
// If this is a pending element skip handling.
if (typeof this.pending[element.name] != 'undefined') {
return;
}
// Default behavior
$(element).removeClass(errorClass).addClass(validClass);
......@@ -309,6 +315,15 @@
tab.removeClass(errorClass).addClass(validClass);
}
}
/**
* Let other modules know this / which / an element is valid.
* @event clientsideValidationValid
* @name clientsideValidationValid
* @memberof Drupal.clientsideValidation
*/
$(element).trigger('clientsideValidationValid');
jQuery.event.trigger('clientsideValidationValid', [element]);
},
highlight: function(element, errorClass, validClass) {
// Default behavior
......@@ -323,6 +338,15 @@
if (tab) {
tab.addClass(errorClass).removeClass(validClass);
}
/**
* Let other modules know this / which / an element is invalid.
* @event clientsideValidationInvalid
* @name clientsideValidationInvalid
* @memberof Drupal.clientsideValidation
*/
$(element).trigger('clientsideValidationInvalid');
jQuery.event.trigger('clientsideValidationInvalid', [element]);
},
invalidHandler: function(form, validator) {
var tab;
......@@ -1438,6 +1462,116 @@
return isValid;
}, jQuery.validator.format("Please fill at least {0} of these fields."));
// Enhances the provided "remote" method by adding our own success and
// progress handling.
jQuery.validator.methods.original_remote = jQuery.validator.methods.remote;
jQuery.validator.methods.remote = function(value, element, param) {
if ( this.optional(element) ) {
return "dependency-mismatch";
}
var previous = this.previousValue(element);
if (!this.settings.messages[element.name] ) {
this.settings.messages[element.name] = {};
}
previous.originalMessage = this.settings.messages[element.name].remote;
this.settings.messages[element.name].remote = previous.message;
param = typeof param === "string" && {url:param} || param;
if ( previous.old === value ) {
return previous.valid;
}
previous.old = value;
var validator = this;
this.startRequest(element);
var data = {};
data[element.name] = value;
$.ajax($.extend(true, {
url: param,
mode: "abort",
port: "validate" + element.name,
dataType: "json",
progress: {
type: 'throbber',
message: Drupal.t('Please wait...')
},
data: data,
// We provide our own success handling to ensure the pending array is
// cleaned before executing showErrors(). That way handling highlight
// unhighlight is easier for pending elements (avoid) flickering.
// However we still need the original success handler of Drupal.ajax to
// do the progress handling.
success: function(response) {
// Remove element from pending list as we now know what state it has.
delete validator.pending[element.name];
validator.settings.messages[element.name].remote = previous.originalMessage;
var valid = response === true || response === "true";
if ( valid ) {
var submitted = validator.formSubmitted;
// Don't invoke this because this will avoid that the highlight /
// unhighlight handlers are called.
// validator.prepareElement(element);
validator.formSubmitted = submitted;
validator.successList.push(element);
delete validator.invalid[element.name];
validator.showErrors();
} else {
var errors = {};
var message = response || validator.defaultMessage( element, "remote" );
errors[element.name] = previous.message = $.isFunction(message) ? message(value) : message;
validator.invalid[element.name] = true;
validator.showErrors(errors);
}
previous.valid = valid;
validator.stopRequest(element, valid);
},
beforeSend: function () {
// Disable the element that received the change to prevent user interface
// interaction while the Ajax request is in progress. ajax.ajaxing prevents
// the element from triggering a new request, but does not prevent the user
// from changing its value.
$(element).addClass('progress-disabled').attr('disabled', true);
// Insert progressbar or throbber.
if (this.progress.type == 'bar') {
var progressBar = new Drupal.progressBar('ajax-progress-' + element.id, eval(this.progress.update_callback), this.progress.method, eval(this.progress.error_callback));
if (this.progress.message) {
progressBar.setProgress(-1, this.progress.message);
}
if (this.progress.url) {
progressBar.startMonitoring(this.progress.url, this.progress.interval || 1500);
}
this.progress.element = $(progressBar.element).addClass('ajax-progress ajax-progress-bar');
this.progress.object = progressBar;
$(element).after(this.progress.element);
}
else if (this.progress.type == 'throbber') {
this.progress.element = $('<div class="ajax-progress ajax-progress-throbber"><div class="throbber">&nbsp;</div></div>');
if (this.progress.message) {
$('.throbber', this.progress.element).after('<div class="message">' + this.progress.message + '</div>');
}
$(element).after(this.progress.element);
}
},
complete: function() {
// Remove the progress element.
if (this.progress.element) {
$(this.progress.element).remove();
}
if (this.progress.object) {
this.progress.object.stopMonitoring();
}
$(element).removeClass('progress-disabled').removeAttr('disabled');
}
}, param));
return "pending";
};
/**
* Allow other modules to add more rules.
* @event clientsideValidationAddCustomRules
......@@ -1500,4 +1634,33 @@
}
}
};
/**
* Integrate with the states handling.
*
* Prvides the condtions:
* * clientside_validation: Value is valid.
* * clientside_validated: Value was validated actually.
*/
if (typeof Drupal.states != 'undefined') {
Drupal.states.Trigger.states.clientside_validation = function (element) {
element
.bind('clientsideValidationValid', function () {
element.trigger({type: 'state:clientside_validation', value: true});
element.trigger({type: 'state:clientside_validated', value: true});
})
.bind('clientsideValidationInvalid', function () {
element.trigger({type: 'state:clientside_validation', value: false});
element.trigger({type: 'state:clientside_validated', value: true});
})
.bind('change keyup', function () {
element.trigger({type: 'state:clientside_validated', value: false});
});
Drupal.states.postponed.push($.proxy(function () {
element.trigger({type: 'state:clientside_validation', value: true});
element.trigger({type: 'state:clientside_validated', value: false});
}, window));
};
}
})(jQuery);
clientside_validation_field_validation/clientside_validation_field_validation.js
View file @ 991bd08d
......@@ -40,6 +40,36 @@
}
}
});
// Add the ajax field validation handling.
$(document).bind('clientsideValidationAddCustomRules', function(event){
// Support for server side field validation.
jQuery.validator.addMethod("fieldValidationAjax", function(value, element, params) {
// Don't execute on every keyup!
if (this.settings['name_event'] == 'onkeyup') {
// Keep the current state until the next validation is run.
return !(typeof this.invalid[element.name] != 'undefined');
}
// Use the built in remote function for validation - does the whole
// async handling. Overwrite the data property to send the value and
// rules. Don't adjust the value variable to keep the "previous"
// handling working.
var remote_param = {
url: Drupal.settings.basePath + Drupal.settings.pathPrefix + 'js/clientside_validation_field_validation/validate',
type: 'post',
data: {
fieldValidationAjax: {
value: value,
rules: params,
},
js_module: 'clientside_validation_field_validation',
js_callback: 'validate',
js_token: Drupal.settings.js && Drupal.settings.js.tokens && Drupal.settings.js.tokens['clientside_validation_field_validation-validate'] || ''
}
};
return $.validator.methods.remote.call( this, value, element, remote_param);
}, jQuery.format('Please fill in a valid value.'));
});
}
};
})(jQuery);
clientside_validation_field_validation/clientside_validation_field_validation.module
View file @ 991bd08d
......@@ -3,6 +3,7 @@
* @file
* Add clientside validation support for Field Validation
*/
/**
* Implements hook_clientside_validation_form_alter().
*/
......@@ -11,6 +12,10 @@ function clientside_validation_field_validation_clientside_validation_form_alter
clientside_validation_field_validation_find_rules($form, $field_rules);
if (!empty($field_rules)) {
$form['#attached']['js'][] = drupal_get_path('module', 'clientside_validation_field_validation') . '/clientside_validation_field_validation.js';
if (module_exists('js')) {
// If JS module is enabled ensure the token for our module is available.
js_get_token('clientside_validation_field_validation', 'validate');
}
foreach ($field_rules as $rule) {
$element = &$form;
// Field validation 1.x
......@@ -129,10 +134,16 @@ function clientside_validation_field_validation_after_build_recurse($form_id, &$
}
function clientside_validation_field_validation_regular($form_id, $element, $rule, &$js_rules) {
if (!empty($rule['disabled'])) {
return;
}
if (isset($rule['col']) && $rule['col'] !== '') {
$parent_last = end($element['#parents']);
reset($element['#parents']);
if (($parent_last !== FALSE) && ($parent_last !== $rule['col'])) {
if ($element['#type'] !== 'select' && $parent_last !== FALSE && $parent_last !== $rule['col']) {
return;
}
elseif ($element['#type'] == 'select' && isset($element['#value_key']) && $element['#value_key'] !== $rule['col']) {
return;
}
}
......@@ -316,8 +327,228 @@ function clientside_validation_field_validation_regular($form_id, $element, $rul
break;
default:
$message = (isset($rule['error_message']) && !empty($rule['error_message'])) ? $rule['error_message'] : t('Invalid value for !name', array('!name' => _clientside_validation_set_title($el_title)));
$context = array('type' => 'field_validation', 'rule' => $rule, 'message' => $message);
$context = array(
'type' => 'field_validation',
'rule' => $rule,
'message' => $message,
);
if (isset($element['#entity_type'])) {
// Add an ajax based validation by default - but allow modules to alter
// it using hook_clientside_validation_rule_alter().
list($entity_id, $revision_id, $bundle) = entity_extract_ids($element['#entity_type'], $element['#entity']);
$js_rules[$el_name]['fieldValidationAjax'][$rule['name']] = array(
'language' => $element['#language'],
'delta' => $element['#delta'],
'entity_id' => $entity_id,
'revision_id' => $revision_id,
);
$variables = array(
'message' => $message,
'error_type' => 'fieldValidationAjax',
'element_name' => $el_name,
);
$js_rules[$el_name]['messages']['fieldValidationAjax'] = theme('clientside_error', $variables);
}
drupal_alter('clientside_validation_rule', $js_rules, $element, $context);
break;
}
}
/**
* Implements hook_menu().
*/
function clientside_validation_field_validation_menu() {
$items['js/clientside_validation_field_validation/validate'] = array(
'title' => 'Clientside validation ajax callback to run a field_validation',
'page callback' => '_clientside_validation_field_validation_ajax',
'access arguments' => array('access content'),
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Implements hook_js_info().
*/
function clientside_validation_field_validation_js_info() {
// Build dependency list.
ctools_include('plugins');
$plugins = ctools_get_plugins('field_validation', 'validator');
$module_data = system_rebuild_module_data();
$dependencies = array(
'field' => 'field',
'ctools' => 'ctools',
'clientside_validation' => 'clientside_validation',
);
foreach ($plugins as $plugin) {
if (!isset($dependencies[$plugin['module']])) {
$dependencies[$plugin['module']] = $plugin['module'];
if (isset($module_data[$plugin['module']]->requires)) {
$dependencies += array_combine(array_keys($module_data[$plugin['module']]->requires), array_keys($module_data[$plugin['module']]->requires));
}
}
}
return array(
'validate' => array(
'callback function' => '_clientside_validation_field_validation_ajax',
'includes' => array('unicode', 'theme', 'path', 'menu'),
'dependencies' => $dependencies,
'skip init' => TRUE,
'delivery callback' => 'drupal_json_output',
'bootstrap' => DRUPAL_BOOTSTRAP_PAGE_HEADER,
),
);
}
/**
* Validates a field using a field validation rule.
*/
function _clientside_validation_field_validation_ajax() {
$data = _clientside_validation_field_validation_ajax_get_value();
if (isset($data['value']) && isset($data['rules']) && is_array($data['rules'])) {
// Fetch the rules to use and ensure the names are save.
$rule_names = array_map('check_plain', array_keys($data['rules']));
// Use ctools export API to fetch the rules.
ctools_include('export');
ctools_include('plugins');
$rules = ctools_export_load_object('field_validation_rule', 'names', $rule_names);
$errors = array();
$value = filter_xss($data['value']);
foreach ($rules as $rule_name => $rule) {
if (isset($data['rules'][$rule_name])) {
$settings = $data['rules'][$rule_name];
_clientside_validation_field_validation($rule, $errors, $value, $settings['entity_id'], $settings['revision_id'], $settings['language'], $settings['delta']);
}
}
if (!empty($errors)) {
drupal_json_output(implode("\n", $errors));
return;
}
}
drupal_json_output(TRUE);
}
/**
* Fetches the data for the validation from the POST data.
*
* @return array
* The data to validate.
*/
function _clientside_validation_field_validation_ajax_get_value($data = NULL) {
if (is_null($data)) {
$data = $_POST;
}
if (isset($data['fieldValidationAjax'])) {
return $data['fieldValidationAjax'];
}
foreach ($data as $key => $sub_data) {
if (isset($data['fieldValidationAjax'])) {
return $data['fieldValidationAjax'];
}
if (is_array($sub_data)) {
if (($return = _clientside_validation_field_validation_ajax_get_value($sub_data)) && !is_null($return)) {
return $return;
}
}
}
return NULL;
}
/**
* Run validation rule on value.
*
* Similar to field_validation_field_attach_validate().
*
* @param object $rule
* The rule to handle.
* @param array $errors
* The array to fill with errors.
* @param mixed $value
* The value to validate.
* @param string $entity_id
* The entity id of the related entity.
* @param string $revision_id
* The revision id of the related entity.
* @param string $langcode
* The langcode to use.
* @param int $delta
* The delta to use.
*
* @see field_validation_field_attach_validate()
*/
function _clientside_validation_field_validation($rule, array &$errors, $value, $entity_id, $revision_id = NULL, $langcode = 'und', $delta = 0) {
$plugin = ctools_get_plugins('field_validation', 'validator', $rule->validator);
$class = ctools_plugin_get_class($plugin, 'handler');
if (empty($class)) {
$errors[] = t("Plugin '@validator' doesn't define a validator class.", array('@validator' => $rule->validator));
return;
}
if (!is_subclass_of($rule->validator, 'field_validation_validator')) {
$errors[] = t("Plugin '@validator' should extends 'field_validation_validator'.", array('@validator' => $rule->validator));
return;
}
$entity_type = $rule->entity_type;
$bundle = $rule->bundle;
$field_name = $rule->field_name;
$entity_info = entity_get_info($entity_type);
$field = field_info_field($field_name);
$instance = field_info_instance($entity_type, $field_name, $bundle);
// Build dummy entity to handle.
// @TODO Load full entity if entity_id / revision id is available?.
$entity = array();
if (isset($entity_info['entity keys']['id'])) {
$entity[$entity_info['entity keys']['id']] = $entity_id;
}
if (isset($entity_info['entity keys']['bundle'])) {
$entity[$entity_info['entity keys']['bundle']] = $bundle;
}
if (isset($info['entity keys']['revision'])) {
$entity[$entity_info['entity keys']['revision']] = $revision_id;
}
// Build default item for this field.
$entity[$field_name][$langcode][$delta] = field_get_default_value($entity_type, $entity, $field, $instance, $langcode);
// Now set the value to validate.
$entity[$field_name][$langcode][$delta][$rule->col] = $value;
$items = $entity[$field_name][$langcode];
$item = $entity[$field_name][$langcode][$delta];
// Ensure the entity is an object.
$entity = (object) $entity;
// Make sure the error is set into the errors array and not into the form.
$rule->settings['errors'] = TRUE;
// Run the validation.
$validator_errors = array();
$validator = new $class($entity_type, $entity, $field, $instance, $langcode, $items, $delta, $item, $value, $rule, $validator_errors);
if ($validator->bypass_validation()) {
return;
}
$validator->validate();
// Check for errors created by the validation and store it in the errors.
if (!empty($validator_errors[$field_name][$langcode][$delta])) {
foreach ($validator_errors[$field_name][$langcode][$delta] as $error) {
if (!empty($error['message'])) {
$errors[] = $error['message'];
}
}
}
}
/**
* Implements hook_conditional_fields_conditions_alter().
*/
function clientside_validation_field_validation_conditional_fields_conditions_alter(&$conditions) {
$conditions['clientside_validation'] = t('Valid');
$conditions['!clientside_validation'] = t('Invalid');
$conditions['clientside_validated'] = t('Validated');
$conditions['!clientside_validated'] = t('Not validated');
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment