mirror of
https://github.com/pgadmin-org/pgadmin4.git
synced 2024-11-30 12:33:52 -06:00
492 lines
15 KiB
JavaScript
492 lines
15 KiB
JavaScript
/////////////////////////////////////////////////////////////
|
|
//
|
|
// pgAdmin 4 - PostgreSQL Tools
|
|
//
|
|
// Copyright (C) 2013 - 2019, The pgAdmin Development Team
|
|
// This software is released under the PostgreSQL Licence
|
|
//
|
|
//////////////////////////////////////////////////////////////
|
|
|
|
define('pgadmin.preferences', [
|
|
'sources/gettext', 'sources/url_for', 'jquery', 'underscore', 'backbone',
|
|
'pgadmin.alertifyjs', 'sources/pgadmin', 'pgadmin.backform',
|
|
'pgadmin.browser', 'sources/modify_animation',
|
|
'sources/tree/pgadmin_tree_save_state',
|
|
], function(
|
|
gettext, url_for, $, _, Backbone, Alertify, pgAdmin, Backform, pgBrowser,
|
|
modifyAnimation
|
|
) {
|
|
// This defines the Preference/Options Dialog for pgAdmin IV.
|
|
|
|
/*
|
|
* Hmm... this module is already been initialized, we can refer to the old
|
|
* object from here.
|
|
*/
|
|
if (pgAdmin.Preferences)
|
|
return pgAdmin.Preferences;
|
|
|
|
pgAdmin.Preferences = {
|
|
init: function() {
|
|
if (this.initialized)
|
|
return;
|
|
|
|
this.initialized = true;
|
|
|
|
// Declare the Preferences dialog
|
|
Alertify.dialog('preferencesDlg', function() {
|
|
|
|
var jTree, // Variable to create the aci-tree
|
|
controls = [], // Keep tracking of all the backform controls
|
|
// created by the dialog.
|
|
// Dialog containter
|
|
$container = $('<div class=\'preferences_dialog d-flex flex-row\'></div>');
|
|
|
|
|
|
/*
|
|
* Preference Model
|
|
*
|
|
* This model will be used to keep tracking of the changes done for
|
|
* an individual option.
|
|
*/
|
|
var PreferenceModel = Backbone.Model.extend({
|
|
idAttribute: 'id',
|
|
defaults: {
|
|
id: undefined,
|
|
value: undefined,
|
|
},
|
|
});
|
|
|
|
/*
|
|
* Preferences Collection object.
|
|
*
|
|
* We will use only one collection object to keep track of all the
|
|
* preferences.
|
|
*/
|
|
var changed = {},
|
|
preferences = this.preferences = new(Backbone.Collection.extend({
|
|
model: PreferenceModel,
|
|
url: url_for('preferences.index'),
|
|
updateAll: function() {
|
|
// We will send only the modified data to the server.
|
|
for (var key in changed) {
|
|
this.get(key).save();
|
|
}
|
|
|
|
return true;
|
|
},
|
|
}))(null);
|
|
|
|
preferences.on('reset', function() {
|
|
// Reset the changed variables
|
|
changed = {};
|
|
});
|
|
|
|
preferences.on('change', function(m) {
|
|
var id = m.get('id');
|
|
if (!(id in changed)) {
|
|
// Keep track of the original value
|
|
changed[id] = m._previousAttributes.value;
|
|
} else if (_.isEqual(m.get('value'), changed[id])) {
|
|
// Remove unchanged models.
|
|
delete changed[id];
|
|
}
|
|
});
|
|
|
|
/*
|
|
* Function: renderPreferencePanel
|
|
*
|
|
* Renders the preference panel in the content div based on the given
|
|
* preferences.
|
|
*/
|
|
var renderPreferencePanel = function(prefs) {
|
|
/*
|
|
* Clear the existing html in the preferences content
|
|
*/
|
|
var content = $container.find('.preferences_content');
|
|
|
|
/*
|
|
* We should clean up the existing controls.
|
|
*/
|
|
if (controls) {
|
|
_.each(controls, function(c) {
|
|
if ('$sel' in c) {
|
|
if (c.$sel.data('select2').isOpen()) c.$sel.data('select2').close();
|
|
}
|
|
c.remove();
|
|
});
|
|
}
|
|
content.empty();
|
|
controls = [];
|
|
|
|
/*
|
|
* We will create new set of controls and render it based on the
|
|
* list of preferences using the Backform Field, Control.
|
|
*/
|
|
_.each(prefs, function(p) {
|
|
|
|
var m = preferences.get(p.id);
|
|
m.errorModel = new Backbone.Model();
|
|
var f = new Backform.Field(
|
|
_.extend({}, p, {
|
|
id: 'value',
|
|
name: 'value',
|
|
})
|
|
),
|
|
cntr = new(f.get('control'))({
|
|
field: f,
|
|
model: m,
|
|
});
|
|
content.append(cntr.render().$el);
|
|
|
|
// We will keep track of all the controls rendered at the
|
|
// moment.
|
|
controls.push(cntr);
|
|
});
|
|
|
|
};
|
|
|
|
/*
|
|
* Function: dialogContentCleanup
|
|
*
|
|
* Do the dialog container cleanup on openning.
|
|
*/
|
|
|
|
var dialogContentCleanup = function() {
|
|
// Remove the existing preferences
|
|
if (!jTree)
|
|
return;
|
|
|
|
/*
|
|
* Remove the aci-tree (mainly to remove the jquery object of
|
|
* aciTree from the system for this container).
|
|
*/
|
|
try {
|
|
jTree.aciTree('destroy');
|
|
} catch (ex) {
|
|
// Sometimes - it fails to destroy the tree properly and throws
|
|
// exception.
|
|
console.warn(ex.stack || ex);
|
|
}
|
|
jTree.off('acitree', treeEventHandler);
|
|
|
|
// We need to reset the data from the preferences too
|
|
preferences.reset();
|
|
|
|
/*
|
|
* Clean up the existing controls.
|
|
*/
|
|
if (controls) {
|
|
_.each(controls, function(c) {
|
|
c.remove();
|
|
});
|
|
}
|
|
controls = [];
|
|
|
|
// Remove all the objects now.
|
|
$container.empty();
|
|
},
|
|
/*
|
|
* Function: selectFirstCategory
|
|
*
|
|
* Whenever a user select a module instead of a category, we should
|
|
* select the first categroy of it.
|
|
*/
|
|
selectFirstCategory = function(api, item) {
|
|
var data = item ? api.itemData(item) : null;
|
|
|
|
if (data && data.preferences) {
|
|
api.select(item);
|
|
return;
|
|
}
|
|
item = api.first(item);
|
|
selectFirstCategory(api, item);
|
|
},
|
|
/*
|
|
* A map on how to create controls for each datatype in preferences
|
|
* dialog.
|
|
*/
|
|
getControlMappedForType = function(p) {
|
|
switch (p.type) {
|
|
case 'text':
|
|
return 'input';
|
|
case 'boolean':
|
|
p.options = {
|
|
onText: gettext('True'),
|
|
offText: gettext('False'),
|
|
onColor: 'success',
|
|
offColor: 'primary',
|
|
size: 'mini',
|
|
};
|
|
return 'switch';
|
|
case 'node':
|
|
p.options = {
|
|
onText: gettext('Show'),
|
|
offText: gettext('Hide'),
|
|
onColor: 'success',
|
|
offColor: 'primary',
|
|
size: 'mini',
|
|
width: '56',
|
|
};
|
|
return 'switch';
|
|
case 'integer':
|
|
return 'numeric';
|
|
case 'numeric':
|
|
return 'numeric';
|
|
case 'date':
|
|
return 'datepicker';
|
|
case 'datetime':
|
|
return 'datetimepicker';
|
|
case 'options':
|
|
var opts = [],
|
|
has_value = false;
|
|
// Convert the array to SelectControl understandable options.
|
|
_.each(p.options, function(o) {
|
|
if ('label' in o && 'value' in o) {
|
|
opts.push({
|
|
'label': o.label,
|
|
'value': o.value,
|
|
});
|
|
if (o.value == p.value)
|
|
has_value = true;
|
|
} else {
|
|
opts.push({
|
|
'label': o,
|
|
'value': o,
|
|
});
|
|
if (o == p.value)
|
|
has_value = true;
|
|
}
|
|
});
|
|
if (p.select2 && p.select2.tags == true && p.value && has_value == false) {
|
|
opts.push({
|
|
'label': p.value,
|
|
'value': p.value,
|
|
});
|
|
}
|
|
p.options = opts;
|
|
return 'select2';
|
|
case 'multiline':
|
|
return 'textarea';
|
|
case 'switch':
|
|
return 'switch';
|
|
case 'keyboardshortcut':
|
|
return 'keyboardShortcut';
|
|
case 'radioModern':
|
|
return 'radioModern';
|
|
default:
|
|
if (console && console.warn) {
|
|
// Warning for developer only.
|
|
console.warn(
|
|
'Hmm.. We don\'t know how to render this type - \'\'' + p.type + '\' of control.'
|
|
);
|
|
}
|
|
return 'input';
|
|
}
|
|
},
|
|
/*
|
|
* function: treeEventHandler
|
|
*
|
|
* It is basically a callback, which listens to aci-tree events,
|
|
* and act accordingly.
|
|
*
|
|
* + Selection of the node will existance of the preferences for
|
|
* the selected tree-node, if not pass on to select the first
|
|
* category under a module, else pass on to the render function.
|
|
*
|
|
* + When a new node is added in the tree, it will add the relavent
|
|
* preferences in the preferences model collection, which will be
|
|
* called during initialization itself.
|
|
*
|
|
*
|
|
*/
|
|
treeEventHandler = function(event, api, item, eventName) {
|
|
// Look for selected item (if none supplied)!
|
|
item = item || api.selected();
|
|
|
|
// Event tree item has itemData
|
|
var d = item ? api.itemData(item) : null;
|
|
|
|
/*
|
|
* boolean (switch/checkbox), string, enum (combobox - enumvals),
|
|
* integer (min-max), font, color
|
|
*/
|
|
switch (eventName) {
|
|
case 'selected':
|
|
if (!d)
|
|
return true;
|
|
|
|
if (d.preferences) {
|
|
/*
|
|
* Clear the existing html in the preferences content
|
|
*/
|
|
$container.find('.preferences_content');
|
|
|
|
renderPreferencePanel(d.preferences);
|
|
|
|
return true;
|
|
} else {
|
|
selectFirstCategory(api, item);
|
|
}
|
|
break;
|
|
case 'added':
|
|
if (!d)
|
|
return true;
|
|
|
|
// We will add the preferences in to the preferences data
|
|
// collection.
|
|
if (d.preferences && _.isArray(d.preferences)) {
|
|
_.each(d.preferences, function(p) {
|
|
preferences.add({
|
|
'id': p.id,
|
|
'value': p.value,
|
|
'category_id': d.id,
|
|
'mid': d.mid,
|
|
'name': p.name,
|
|
});
|
|
/*
|
|
* We don't know until now, how to render the control for
|
|
* this preference.
|
|
*/
|
|
if (!p.control) {
|
|
p.control = getControlMappedForType(p);
|
|
}
|
|
if (p.help_str) {
|
|
p.helpMessage = p.help_str;
|
|
}
|
|
});
|
|
}
|
|
d.sortable = false;
|
|
break;
|
|
case 'loaded':
|
|
// Let's select the first category from the prefrences.
|
|
// We need to wait for sometime before all item gets loaded
|
|
// properly.
|
|
setTimeout(
|
|
function() {
|
|
selectFirstCategory(api, null);
|
|
}, 300);
|
|
break;
|
|
}
|
|
return true;
|
|
};
|
|
|
|
// Dialog property
|
|
return {
|
|
main: function() {
|
|
|
|
// Remove the existing content first.
|
|
dialogContentCleanup();
|
|
|
|
$container.append(
|
|
'<div class=\'pg-el-sm-3 preferences_tree aciTree\'></div>'
|
|
).append(
|
|
'<div class=\'pg-el-sm-9 preferences_content\'>' +
|
|
gettext('Category is not selected.') +
|
|
'</div>'
|
|
);
|
|
|
|
// Create the aci-tree for listing the modules and categories of
|
|
// it.
|
|
jTree = $container.find('.preferences_tree');
|
|
jTree.on('acitree', treeEventHandler);
|
|
|
|
jTree.aciTree({
|
|
selectable: true,
|
|
expand: true,
|
|
ajax: {
|
|
url: url_for('preferences.index'),
|
|
},
|
|
animateRoot: true,
|
|
unanimated: false,
|
|
show: {duration: 75},
|
|
hide: {duration: 75},
|
|
view: {duration: 75},
|
|
});
|
|
|
|
modifyAnimation.modifyAcitreeAnimation(pgBrowser, jTree.aciTree('api'));
|
|
|
|
this.show();
|
|
},
|
|
setup: function() {
|
|
return {
|
|
buttons: [{
|
|
text: '',
|
|
key: 112,
|
|
className: 'btn btn-secondary pull-left fa fa-question pg-alertify-icon-button',
|
|
attrs: {
|
|
name: 'dialog_help',
|
|
type: 'button',
|
|
label: gettext('Preferences'),
|
|
url: url_for(
|
|
'help.static', {
|
|
'filename': 'preferences.html',
|
|
}
|
|
),
|
|
},
|
|
}, {
|
|
text: gettext('Cancel'),
|
|
key: 27,
|
|
className: 'btn btn-secondary fa fa-lg fa-times pg-alertify-button',
|
|
}, {
|
|
text: gettext('Save'),
|
|
key: 13,
|
|
className: 'btn btn-primary fa fa-lg fa-save pg-alertify-button',
|
|
}],
|
|
focus: {
|
|
element: 0,
|
|
},
|
|
options: {
|
|
padding: !1,
|
|
overflow: !1,
|
|
title: gettext('Preferences'),
|
|
closableByDimmer: false,
|
|
modal: false,
|
|
pinnable: false,
|
|
},
|
|
};
|
|
},
|
|
callback: function(e) {
|
|
if (e.button.element.name == 'dialog_help') {
|
|
e.cancel = true;
|
|
pgBrowser.showHelp(e.button.element.name, e.button.element.getAttribute('url'),
|
|
null, null);
|
|
return;
|
|
}
|
|
|
|
if (e.button.text == gettext('Save')) {
|
|
preferences.updateAll();
|
|
|
|
/* Find the modules changed */
|
|
let modulesChanged = {};
|
|
_.each(changed, (val, key)=> {
|
|
let pref = pgBrowser.get_preference_for_id(Number(key));
|
|
if(!modulesChanged[pref.module]) {
|
|
modulesChanged[pref.module] = true;
|
|
}
|
|
});
|
|
|
|
// Refresh preferences cache
|
|
pgBrowser.cache_preferences(modulesChanged);
|
|
}
|
|
},
|
|
build: function() {
|
|
this.elements.content.appendChild($container.get(0));
|
|
Alertify.pgDialogBuild.apply(this);
|
|
},
|
|
hooks: {
|
|
onshow: function() {
|
|
// $(this.elements.body).addClass('pgadmin-preference-body');
|
|
},
|
|
},
|
|
};
|
|
});
|
|
|
|
},
|
|
show: function() {
|
|
Alertify.preferencesDlg(true).resizeTo(pgAdmin.Browser.stdW.lg,pgAdmin.Browser.stdH.lg);
|
|
},
|
|
};
|
|
|
|
return pgAdmin.Preferences;
|
|
});
|