1 /* vim: set expandtab sw=4 ts=4 sts=4: */
3 * Functions used in configuration forms and on user preferences pages
7 * checks whether browser supports web storage
9 * @param type the type of storage i.e. localStorage or sessionStorage
13 function isStorageSupported (type, warn) {
15 window[type].setItem('PMATest', 'test');
16 // Check whether key-value pair was set successfully
17 if (window[type].getItem('PMATest') === 'test') {
18 // Supported, remove test variable from storage
19 window[type].removeItem('PMATest');
25 PMA_ajaxShowMessage(PMA_messages.strNoLocalStorage, false);
32 * Unbind all event handlers before tearing down a page
34 AJAX.registerTeardown('config.js', function () {
35 $('.optbox input[id], .optbox select[id], .optbox textarea[id]').off('change').off('keyup');
36 $('.optbox input[type=button][name=submit_reset]').off('click');
37 $('div.tabs_contents').off();
38 $('#import_local_storage, #export_local_storage').off('click');
39 $('form.prefs-form').off('change').off('submit');
40 $(document).off('click', 'div.click-hide-message');
41 $('#prefs_autoload').find('a').off('click');
44 AJAX.registerOnload('config.js', function () {
45 var $topmenu_upt = $('#topmenu2.user_prefs_tabs');
46 $topmenu_upt.find('li.active a').attr('rel', 'samepage');
47 $topmenu_upt.find('li:not(.active) a').attr('rel', 'newpage');
50 // default values for fields
51 var defaultValues = {};
56 * @param {Element} field
58 function getFieldType (field) {
59 var $field = $(field);
60 var tagName = $field.prop('tagName');
61 if (tagName === 'INPUT') {
62 return $field.attr('type');
63 } else if (tagName === 'SELECT') {
65 } else if (tagName === 'TEXTAREA') {
72 * Enables or disables the "restore default value" button
74 * @param {Element} field
75 * @param {boolean} display
77 function setRestoreDefaultBtn (field, display) {
78 var $el = $(field).closest('td').find('.restore-default img');
79 $el[display ? 'show' : 'hide']();
83 * Marks field depending on its value (system default or custom)
85 * @param {Element} field
87 function markField (field) {
88 var $field = $(field);
89 var type = getFieldType($field);
90 var isDefault = checkFieldDefault($field, type);
92 // checkboxes uses parent <span> for marking
93 var $fieldMarker = (type === 'checkbox') ? $field.parent() : $field;
94 setRestoreDefaultBtn($field, !isDefault);
95 $fieldMarker[isDefault ? 'removeClass' : 'addClass']('custom');
101 * value must be of type:
102 * o undefined (omitted) - restore default value (form default, not PMA default)
103 * o String - if field_type is 'text'
104 * o boolean - if field_type is 'checkbox'
105 * o Array of values - if field_type is 'select'
107 * @param {Element} field
108 * @param {String} field_type see {@link #getFieldType}
109 * @param {String|Boolean} value
111 function setFieldValue (field, field_type, value) {
112 var $field = $(field);
113 switch (field_type) {
119 $field.prop('checked', value);
122 var options = $field.prop('options');
124 var imax = options.length;
125 for (i = 0; i < imax; i++) {
126 options[i].selected = (value.indexOf(options[i].value) !== -1);
136 * Will return one of:
137 * o String - if type is 'text'
138 * o boolean - if type is 'checkbox'
139 * o Array of values - if type is 'select'
141 * @param {Element} field
142 * @param {String} field_type returned by {@link #getFieldType}
143 * @type Boolean|String|String[]
145 function getFieldValue (field, field_type) {
146 var $field = $(field);
147 switch (field_type) {
150 return $field.prop('value');
152 return $field.prop('checked');
154 var options = $field.prop('options');
156 var imax = options.length;
158 for (i = 0; i < imax; i++) {
159 if (options[i].selected) {
160 items.push(options[i].value);
169 * Returns values for all fields in fieldsets
171 function getAllValues () {
172 var $elements = $('fieldset input, fieldset select, fieldset textarea');
176 for (var i = 0; i < $elements.length; i++) {
177 type = getFieldType($elements[i]);
178 value = getFieldValue($elements[i], type);
179 if (typeof value !== 'undefined') {
180 // we only have single selects, fatten array
181 if (type === 'select') {
184 values[$elements[i].name] = value;
191 * Checks whether field has its default value
193 * @param {Element} field
194 * @param {String} type
197 function checkFieldDefault (field, type) {
198 var $field = $(field);
199 var field_id = $field.attr('id');
200 if (typeof defaultValues[field_id] === 'undefined') {
203 var isDefault = true;
204 var currentValue = getFieldValue($field, type);
205 if (type !== 'select') {
206 isDefault = currentValue === defaultValues[field_id];
208 // compare arrays, will work for our representation of select values
209 if (currentValue.length !== defaultValues[field_id].length) {
212 for (var i = 0; i < currentValue.length; i++) {
213 if (currentValue[i] !== defaultValues[field_id][i]) {
224 * Returns element's id prefix
225 * @param {Element} element
227 function getIdPrefix (element) {
228 return $(element).attr('id').replace(/[^-]+$/, '');
231 // ------------------------------------------------------------------
232 // Form validation and field operations
235 // form validator assignments
238 // form validator list
240 // regexp: numeric value
241 _regexp_numeric: /^[0-9]+$/,
242 // regexp: extract parts from PCRE expression
243 _regexp_pcre_extract: /(.)(.*)\1(.*)?/,
245 * Validates positive number
247 * @param {boolean} isKeyUp
249 PMA_validatePositiveNumber: function (isKeyUp) {
250 if (isKeyUp && this.value === '') {
253 var result = this.value !== '0' && validators._regexp_numeric.test(this.value);
254 return result ? true : PMA_messages.error_nan_p;
257 * Validates non-negative number
259 * @param {boolean} isKeyUp
261 PMA_validateNonNegativeNumber: function (isKeyUp) {
262 if (isKeyUp && this.value === '') {
265 var result = validators._regexp_numeric.test(this.value);
266 return result ? true : PMA_messages.error_nan_nneg;
269 * Validates port number
271 * @param {boolean} isKeyUp
273 PMA_validatePortNumber: function (isKeyUp) {
274 if (this.value === '') {
277 var result = validators._regexp_numeric.test(this.value) && this.value !== '0';
278 return result && this.value <= 65535 ? true : PMA_messages.error_incorrect_port;
281 * Validates value according to given regular expression
283 * @param {boolean} isKeyUp
284 * @param {string} regexp
286 PMA_validateByRegex: function (isKeyUp, regexp) {
287 if (isKeyUp && this.value === '') {
290 // convert PCRE regexp
291 var parts = regexp.match(validators._regexp_pcre_extract);
292 var valid = this.value.match(new RegExp(parts[2], parts[3])) !== null;
293 return valid ? true : PMA_messages.error_invalid_value;
296 * Validates upper bound for numeric inputs
298 * @param {boolean} isKeyUp
299 * @param {int} max_value
301 PMA_validateUpperBound: function (isKeyUp, max_value) {
302 var val = parseInt(this.value, 10);
306 return val <= max_value ? true : PMA_sprintf(PMA_messages.error_value_lte, max_value);
311 // fieldset validators
317 * Registers validator for given field
319 * @param {String} id field id
320 * @param {String} type validator (key in validators object)
321 * @param {boolean} onKeyUp whether fire on key up
322 * @param {Array} params validation function parameters
324 function validateField (id, type, onKeyUp, params) {
325 if (typeof validators[type] === 'undefined') {
328 if (typeof validate[id] === 'undefined') {
331 validate[id].push([type, params, onKeyUp]);
335 * Returns validation functions associated with form field
337 * @param {String} field_id form field id
338 * @param {boolean} onKeyUpOnly see validateField
340 * @return array of [function, parameters to be passed to function]
342 function getFieldValidators (field_id, onKeyUpOnly) {
343 // look for field bound validator
344 var name = field_id && field_id.match(/[^-]+$/)[0];
345 if (typeof validators._field[name] !== 'undefined') {
346 return [[validators._field[name], null]];
349 // look for registered validators
351 if (typeof validate[field_id] !== 'undefined') {
352 // validate[field_id]: array of [type, params, onKeyUp]
353 for (var i = 0, imax = validate[field_id].length; i < imax; i++) {
354 if (onKeyUpOnly && !validate[field_id][i][2]) {
357 functions.push([validators[validate[field_id][i][0]], validate[field_id][i][1]]);
365 * Displays errors for given form fields
367 * WARNING: created DOM elements must be identical with the ones made by
368 * PhpMyAdmin\Config\FormDisplayTemplate::displayInput()!
370 * @param {Object} error_list list of errors in the form {field id: error array}
372 function displayErrors (error_list) {
373 var tempIsEmpty = function (item) {
377 for (var field_id in error_list) {
378 var errors = error_list[field_id];
379 var $field = $('#' + field_id);
380 var isFieldset = $field.attr('tagName') === 'FIELDSET';
383 $errorCnt = $field.find('dl.errors');
385 $errorCnt = $field.siblings('.inline_errors');
388 // remove empty errors (used to clear error list)
389 errors = $.grep(errors, tempIsEmpty);
393 // checkboxes uses parent <span> for marking
394 var $fieldMarker = ($field.attr('type') === 'checkbox') ? $field.parent() : $field;
395 $fieldMarker[errors.length ? 'addClass' : 'removeClass']('field-error');
399 // if error container doesn't exist, create it
400 if ($errorCnt.length === 0) {
402 $errorCnt = $('<dl class="errors"></dl>');
403 $field.find('table').before($errorCnt);
405 $errorCnt = $('<dl class="inline_errors"></dl>');
406 $field.closest('td').append($errorCnt);
411 for (var i = 0, imax = errors.length; i < imax; i++) {
412 html += '<dd>' + errors[i] + '</dd>';
414 $errorCnt.html(html);
415 } else if ($errorCnt !== null) {
416 // remove useless error container
423 * Validates fieldset and puts errors in 'errors' object
425 * @param {Element} fieldset
426 * @param {boolean} isKeyUp
427 * @param {Object} errors
429 function validate_fieldset (fieldset, isKeyUp, errors) {
430 var $fieldset = $(fieldset);
431 if ($fieldset.length && typeof validators._fieldset[$fieldset.attr('id')] !== 'undefined') {
432 var fieldset_errors = validators._fieldset[$fieldset.attr('id')].apply($fieldset[0], [isKeyUp]);
433 for (var field_id in fieldset_errors) {
434 if (typeof errors[field_id] === 'undefined') {
435 errors[field_id] = [];
437 if (typeof fieldset_errors[field_id] === 'string') {
438 fieldset_errors[field_id] = [fieldset_errors[field_id]];
440 $.merge(errors[field_id], fieldset_errors[field_id]);
446 * Validates form field and puts errors in 'errors' object
448 * @param {Element} field
449 * @param {boolean} isKeyUp
450 * @param {Object} errors
452 function validate_field (field, isKeyUp, errors) {
455 var $field = $(field);
456 var field_id = $field.attr('id');
457 errors[field_id] = [];
458 var functions = getFieldValidators(field_id, isKeyUp);
459 for (var i = 0; i < functions.length; i++) {
460 if (typeof functions[i][1] !== 'undefined' && functions[i][1] !== null) {
461 args = functions[i][1].slice(0);
465 args.unshift(isKeyUp);
466 result = functions[i][0].apply($field[0], args);
467 if (result !== true) {
468 if (typeof result === 'string') {
471 $.merge(errors[field_id], result);
477 * Validates form field and parent fieldset
479 * @param {Element} field
480 * @param {boolean} isKeyUp
482 function validate_field_and_fieldset (field, isKeyUp) {
483 var $field = $(field);
485 validate_field($field, isKeyUp, errors);
486 validate_fieldset($field.closest('fieldset.optbox'), isKeyUp, errors);
487 displayErrors(errors);
490 function loadInlineConfig () {
491 if (!Array.isArray(configInlineParams)) {
494 for (var i = 0; i < configInlineParams.length; ++i) {
495 if (typeof configInlineParams[i] === 'function') {
496 configInlineParams[i]();
501 function setupValidation () {
503 configScriptLoaded = true;
504 if (configScriptLoaded && typeof configInlineParams !== 'undefined') {
507 // register validators and mark custom values
508 var $elements = $('.optbox input[id], .optbox select[id], .optbox textarea[id]');
509 $elements.each(function () {
512 $el.on('change', function () {
513 validate_field_and_fieldset(this, false);
516 var tagName = $el.attr('tagName');
517 // text fields can be validated after each change
518 if (tagName === 'INPUT' && $el.attr('type') === 'text') {
519 $el.on('keyup', function () {
520 validate_field_and_fieldset($el, true);
524 // disable textarea spellcheck
525 if (tagName === 'TEXTAREA') {
526 $el.attr('spellcheck', false);
530 // check whether we've refreshed a page and browser remembered modified
532 var $check_page_refresh = $('#check_page_refresh');
533 if ($check_page_refresh.length === 0 || $check_page_refresh.val() === '1') {
534 // run all field validators
536 for (var i = 0; i < $elements.length; i++) {
537 validate_field($elements[i], false, errors);
539 // run all fieldset validators
540 $('fieldset.optbox').each(function () {
541 validate_fieldset(this, false, errors);
544 displayErrors(errors);
545 } else if ($check_page_refresh) {
546 $check_page_refresh.val('1');
550 AJAX.registerOnload('config.js', function () {
555 // END: Form validation and field operations
556 // ------------------------------------------------------------------
558 // ------------------------------------------------------------------
565 * @param {String} tab_id
567 function setTab (tab_id) {
568 $('ul.tabs').each(function () {
570 if (!$this.find('li a[href="#' + tab_id + '"]').length) {
573 $this.find('li').removeClass('active').find('a[href="#' + tab_id + '"]').parent().addClass('active');
574 $this.parent().find('div.tabs_contents fieldset').hide().filter('#' + tab_id).show();
575 var hashValue = 'tab_' + tab_id;
576 location.hash = hashValue;
577 $this.parent().find('input[name=tab_hash]').val(hashValue);
581 function setupConfigTabs () {
582 var forms = $('form.config-form');
583 forms.each(function () {
585 var $tabs = $this.find('ul.tabs');
589 // add tabs events and activate one tab (the first one or indicated by location hash)
590 $tabs.find('li').removeClass('active');
592 .on('click', function (e) {
594 setTab($(this).attr('href').substr(1));
599 $this.find('div.tabs_contents fieldset').hide().filter(':first').show();
603 function adjustPrefsNotification () {
604 var $prefsAutoLoad = $('#prefs_autoload');
605 var $tableNameControl = $('#table_name_col_no');
606 var $prefsAutoShowing = ($prefsAutoLoad.css('display') !== 'none');
608 if ($prefsAutoShowing && $tableNameControl.length) {
609 $tableNameControl.css('top', '55px');
613 AJAX.registerOnload('config.js', function () {
615 adjustPrefsNotification();
617 // tab links handling, check each 200ms
618 // (works with history in FF, further browser support here would be an overkill)
620 var tab_check_fnc = function () {
621 if (location.hash !== prev_hash) {
622 prev_hash = location.hash;
623 if (prev_hash.match(/^#tab_[a-zA-Z0-9_]+$/)) {
624 // session ID is sometimes appended here
625 var hash = prev_hash.substr(5).split('&')[0];
626 if ($('#' + hash).length) {
633 setInterval(tab_check_fnc, 200);
638 // ------------------------------------------------------------------
640 // ------------------------------------------------------------------
641 // Form reset buttons
644 AJAX.registerOnload('config.js', function () {
645 $('.optbox input[type=button][name=submit_reset]').on('click', function () {
646 var fields = $(this).closest('fieldset').find('input, select, textarea');
647 for (var i = 0, imax = fields.length; i < imax; i++) {
648 setFieldValue(fields[i], getFieldType(fields[i]), defaultValues[fields[i].id]);
654 // END: Form reset buttons
655 // ------------------------------------------------------------------
657 // ------------------------------------------------------------------
658 // "Restore default" and "set value" buttons
662 * Restores field's default value
664 * @param {String} field_id
666 function restoreField (field_id) {
667 var $field = $('#' + field_id);
668 if ($field.length === 0 || defaultValues[field_id] === undefined) {
671 setFieldValue($field, getFieldType($field), defaultValues[field_id]);
674 function setupRestoreField () {
675 $('div.tabs_contents')
676 .on('mouseenter', '.restore-default, .set-value', function () {
677 $(this).css('opacity', 1);
679 .on('mouseleave', '.restore-default, .set-value', function () {
680 $(this).css('opacity', 0.25);
682 .on('click', '.restore-default, .set-value', function (e) {
684 var href = $(this).attr('href');
686 if ($(this).hasClass('restore-default')) {
688 restoreField(field_sel.substr(1));
690 field_sel = href.match(/^[^=]+/)[0];
691 var value = href.match(/\=(.+)$/)[1];
692 setFieldValue($(field_sel), 'text', value);
694 $(field_sel).trigger('change');
696 .find('.restore-default, .set-value')
697 // inline-block for IE so opacity inheritance works
698 .css({ display: 'inline-block', opacity: 0.25 });
701 AJAX.registerOnload('config.js', function () {
706 // END: "Restore default" and "set value" buttons
707 // ------------------------------------------------------------------
709 // ------------------------------------------------------------------
710 // User preferences import/export
713 AJAX.registerOnload('config.js', function () {
714 offerPrefsAutoimport();
715 var $radios = $('#import_local_storage, #export_local_storage');
716 if (!$radios.length) {
720 // enable JavaScript dependent fields
722 .prop('disabled', false)
723 .add('#export_text_file, #import_text_file')
724 .on('click', function () {
725 var enable_id = $(this).attr('id');
727 if (enable_id.match(/local_storage$/)) {
728 disable_id = enable_id.replace(/local_storage$/, 'text_file');
730 disable_id = enable_id.replace(/text_file$/, 'local_storage');
732 $('#opts_' + disable_id).addClass('disabled').find('input').prop('disabled', true);
733 $('#opts_' + enable_id).removeClass('disabled').find('input').prop('disabled', false);
736 // detect localStorage state
737 var ls_supported = isStorageSupported('localStorage', true);
738 var ls_exists = ls_supported ? (window.localStorage.config || false) : false;
739 $('div.localStorage-' + (ls_supported ? 'un' : '') + 'supported').hide();
740 $('div.localStorage-' + (ls_exists ? 'empty' : 'exists')).hide();
744 $('form.prefs-form').on('change', function () {
746 var disabled = false;
748 disabled = $form.find('input[type=radio][value$=local_storage]').prop('checked');
749 } else if (!ls_exists && $form.attr('name') === 'prefs_import' &&
750 $('#import_local_storage')[0].checked
754 $form.find('input[type=submit]').prop('disabled', disabled);
755 }).submit(function (e) {
757 if ($form.attr('name') === 'prefs_export' && $('#export_local_storage')[0].checked) {
759 // use AJAX to read JSON settings and save them
760 savePrefsToLocalStorage($form);
761 } else if ($form.attr('name') === 'prefs_import' && $('#import_local_storage')[0].checked) {
762 // set 'json' input and submit form
763 $form.find('input[name=json]').val(window.localStorage.config);
767 $(document).on('click', 'div.click-hide-message', function () {
778 * Saves user preferences to localStorage
780 * @param {Element} form
782 function savePrefsToLocalStorage (form) {
784 var submit = $form.find('input[type=submit]');
785 submit.prop('disabled', true);
787 url: 'prefs_manage.php',
792 server: PMA_commonParams.get('server'),
793 submit_get_json: true
795 success: function (data) {
796 if (typeof data !== 'undefined' && data.success === true) {
797 window.localStorage.config = data.prefs;
798 window.localStorage.config_mtime = data.mtime;
799 window.localStorage.config_mtime_local = (new Date()).toUTCString();
801 $('div.localStorage-empty').hide();
802 $('div.localStorage-exists').show();
803 var group = $form.parent('.group');
804 group.css('height', group.height() + 'px');
806 $form.prev('.click-hide-message').show('fast');
808 PMA_ajaxShowMessage(data.error);
811 complete: function () {
812 submit.prop('disabled', false);
818 * Updates preferences timestamp in Import form
820 function updatePrefsDate () {
821 var d = new Date(window.localStorage.config_mtime_local);
822 var msg = PMA_messages.strSavedOn.replace(
824 PMA_formatDateTime(d)
826 $('#opts_import_local_storage').find('div.localStorage-exists').html(msg);
830 * Prepares message which informs that localStorage preferences are available and can be imported or deleted
832 function offerPrefsAutoimport () {
833 var has_config = (isStorageSupported('localStorage')) && (window.localStorage.config || false);
834 var $cnt = $('#prefs_autoload');
835 if (!$cnt.length || !has_config) {
838 $cnt.find('a').on('click', function (e) {
841 if ($a.attr('href') === '#no') {
843 $.post('index.php', {
844 server: PMA_commonParams.get('server'),
845 prefs_autoload: 'hide'
848 } else if ($a.attr('href') === '#delete') {
850 localStorage.clear();
851 $.post('index.php', {
852 server: PMA_commonParams.get('server'),
853 prefs_autoload: 'hide'
857 $cnt.find('input[name=json]').val(window.localStorage.config);
858 $cnt.find('form').submit();
864 // END: User preferences import/export
865 // ------------------------------------------------------------------