Skip to content

Commit d5fed1e

Browse files
Merge pull request #17918 from MauricioFauth/import-common-js
Import CommonParams and CommonActions as modules
2 parents f421836 + 8c525ed commit d5fed1e

37 files changed

Lines changed: 415 additions & 376 deletions

js/src/ajax.js

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import $ from 'jquery';
2+
import { CommonParams } from './common.js';
23

34
/* global Navigation */
45

@@ -28,7 +29,7 @@ window.AJAX = {
2829
// eslint-disable-next-line valid-jsdoc
2930
/**
3031
* @var {Function} callback Callback to execute after a successful request
31-
* Used by window.CommonActions from common.js
32+
* Used by CommonActions from common.js
3233
*/
3334
callback: function () {},
3435
/**
@@ -300,7 +301,7 @@ window.AJAX = {
300301
$('html, body').animate({ scrollTop: 0 }, 'fast');
301302

302303
var url = isLink ? href : $(this).attr('action');
303-
var argsep = window.CommonParams.get('arg_separator');
304+
var argsep = CommonParams.get('arg_separator');
304305
var params = 'ajax_request=true' + argsep + 'ajax_page_request=true';
305306
var dataPost = window.AJAX.source.getPostData();
306307
if (! isLink) {
@@ -366,7 +367,7 @@ window.AJAX = {
366367
}
367368
Functions.ajaxRemoveMessage(window.AJAX.$msgbox);
368369

369-
window.CommonParams.set('token', data.new_token);
370+
CommonParams.set('token', data.new_token);
370371

371372
window.AJAX.scriptHandler.load([]);
372373

@@ -421,7 +422,7 @@ window.AJAX = {
421422

422423
if (typeof data.success !== 'undefined' && data.success) {
423424
// reload page if user trying to login has changed
424-
if (window.CommonParams.get('user') !== data.params.user) {
425+
if (CommonParams.get('user') !== data.params.user) {
425426
window.location = 'index.php';
426427
Functions.ajaxShowMessage(window.Messages.strLoading, false);
427428
window.AJAX.active = false;
@@ -548,7 +549,7 @@ window.AJAX = {
548549
$('#selflink').find('> a').attr('href', data.selflink);
549550
}
550551
if (data.params) {
551-
window.CommonParams.setAll(data.params);
552+
CommonParams.setAll(data.params);
552553
}
553554
if (data.scripts) {
554555
window.AJAX.scriptHandler.load(data.scripts);
@@ -681,10 +682,10 @@ window.AJAX = {
681682
// Clear loaded scripts if they are from another version of phpMyAdmin.
682683
// Depends on common params being set before loading scripts in responseHandler
683684
if (self.scriptsVersion === null) {
684-
self.scriptsVersion = window.CommonParams.get('version');
685-
} else if (self.scriptsVersion !== window.CommonParams.get('version')) {
685+
self.scriptsVersion = CommonParams.get('version');
686+
} else if (self.scriptsVersion !== CommonParams.get('version')) {
686687
self.scripts = [];
687-
self.scriptsVersion = window.CommonParams.get('version');
688+
self.scriptsVersion = CommonParams.get('version');
688689
}
689690
self.scriptsCompleted = false;
690691
self.scriptsToBeFired = [];
@@ -751,7 +752,7 @@ window.AJAX = {
751752

752753
script.type = 'text/javascript';
753754
var file = name.indexOf('vendor/') !== -1 ? name : 'dist/' + name;
754-
script.src = 'js/' + file + '?' + 'v=' + encodeURIComponent(window.CommonParams.get('version'));
755+
script.src = 'js/' + file + '?' + 'v=' + encodeURIComponent(CommonParams.get('version'));
755756
script.async = false;
756757
script.onload = function () {
757758
self.done(name, callback);
@@ -875,7 +876,7 @@ window.AJAX = {
875876
var state = event.originalEvent.state;
876877
if (state && state.menu) {
877878
window.AJAX.$msgbox = Functions.ajaxShowMessage();
878-
var params = 'ajax_request=true' + window.CommonParams.get('arg_separator') + 'ajax_page_request=true';
879+
var params = 'ajax_request=true' + CommonParams.get('arg_separator') + 'ajax_page_request=true';
879880
var url = state.url || location.href;
880881
$.get(url, params, window.AJAX.responseHandler);
881882
// TODO: Check if sometimes menu is not retrieved from server,

js/src/codemirror/addon/lint/sql-lint.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import $ from 'jquery';
2+
import { CommonParams } from '../../../common.js';
23

34
window.CodeMirror.sqlLint = function (text, updateLinting, options, cm) {
45
// Skipping check if text box is empty.
@@ -33,7 +34,7 @@ window.CodeMirror.sqlLint = function (text, updateLinting, options, cm) {
3334
dataType: 'json',
3435
data: {
3536
'sql_query': text,
36-
'server': window.CommonParams.get('server'),
37+
'server': CommonParams.get('server'),
3738
'options': options.lintOptions,
3839
'no_history': true,
3940
},

js/src/common.js

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import $ from 'jquery';
1010
*
1111
* @test-module CommonParams
1212
*/
13-
window.CommonParams = (function () {
13+
const CommonParams = (function () {
1414
/**
1515
* @var {Object} params An associative array of key value pairs
1616
* @access private
@@ -86,7 +86,7 @@ window.CommonParams = (function () {
8686
getUrlQuery: function (separator) {
8787
var sep = (typeof separator !== 'undefined') ? separator : '?';
8888
var common = this.get('common_query');
89-
var argsep = window.CommonParams.get('arg_separator');
89+
var argsep = CommonParams.get('arg_separator');
9090
if (typeof common === 'string' && common.length > 0) {
9191
// If the last char is the separator, do not add it
9292
// Else add it
@@ -111,7 +111,7 @@ window.CommonParams = (function () {
111111
* The content for this is normally loaded from Header.php or
112112
* Response.php and executed by ajax.js
113113
*/
114-
window.CommonActions = {
114+
const CommonActions = {
115115
/**
116116
* Saves the database name when it's changed
117117
* and reloads the query window, if necessary
@@ -121,8 +121,8 @@ window.CommonActions = {
121121
* @return {void}
122122
*/
123123
setDb: function (newDb) {
124-
if (newDb !== window.CommonParams.get('db')) {
125-
window.CommonParams.setAll({ 'db': newDb, 'table': '' });
124+
if (newDb !== CommonParams.get('db')) {
125+
CommonParams.setAll({ 'db': newDb, 'table': '' });
126126
}
127127
},
128128
/**
@@ -133,11 +133,11 @@ window.CommonActions = {
133133
* @return {void}
134134
*/
135135
openDb: function (newDb) {
136-
window.CommonParams
136+
CommonParams
137137
.set('db', newDb)
138138
.set('table', '');
139139
this.refreshMain(
140-
window.CommonParams.get('opendb_url')
140+
CommonParams.get('opendb_url')
141141
);
142142
},
143143
/**
@@ -156,9 +156,9 @@ window.CommonActions = {
156156
newUrl = newUrl.substring(0, newUrl.indexOf('?'));
157157
}
158158
if (newUrl.indexOf('?') !== -1) {
159-
newUrl += window.CommonParams.getUrlQuery(window.CommonParams.get('arg_separator'));
159+
newUrl += CommonParams.getUrlQuery(CommonParams.get('arg_separator'));
160160
} else {
161-
newUrl += window.CommonParams.getUrlQuery('?');
161+
newUrl += CommonParams.getUrlQuery('?');
162162
}
163163
$('<a></a>', { href: newUrl })
164164
.appendTo('body')
@@ -169,3 +169,7 @@ window.CommonActions = {
169169
}
170170
}
171171
};
172+
173+
window.CommonParams = CommonParams;
174+
175+
export { CommonActions, CommonParams };

js/src/config.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import $ from 'jquery';
2+
import { CommonParams } from './common.js';
23

34
/**
45
* Functions used in configuration forms and on user preferences pages
@@ -650,7 +651,7 @@ function savePrefsToLocalStorage (form) {
650651
type: 'POST',
651652
data: {
652653
'ajax_request': true,
653-
'server': window.CommonParams.get('server'),
654+
'server': CommonParams.get('server'),
654655
'submit_get_json': true
655656
},
656657
success: function (data) {
@@ -702,15 +703,15 @@ function offerPrefsAutoimport () {
702703
if ($a.attr('href') === '#no') {
703704
$cnt.remove();
704705
$.post('index.php', {
705-
'server': window.CommonParams.get('server'),
706+
'server': CommonParams.get('server'),
706707
'prefs_autoload': 'hide'
707708
}, null, 'html');
708709
return;
709710
} else if ($a.attr('href') === '#delete') {
710711
$cnt.remove();
711712
localStorage.clear();
712713
$.post('index.php', {
713-
'server': window.CommonParams.get('server'),
714+
'server': CommonParams.get('server'),
714715
'prefs_autoload': 'hide'
715716
}, null, 'html');
716717
return;

js/src/database/central_columns.js

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import $ from 'jquery';
2+
import { CommonParams } from '../common.js';
23

34
/**
45
* @fileoverview events handling from central columns page
@@ -65,17 +66,17 @@ window.AJAX.registerOnload('database/central_columns.js', function () {
6566
Functions.ajaxShowMessage(window.Messages.strRadioUnchecked);
6667
return false;
6768
}
68-
var argsep = window.CommonParams.get('arg_separator');
69-
var editColumnData = editColumnList + '' + argsep + 'edit_central_columns_page=true' + argsep + 'ajax_request=true' + argsep + 'ajax_page_request=true' + argsep + 'db=' + encodeURIComponent(window.CommonParams.get('db')) + argsep + 'server=' + window.CommonParams.get('server');
69+
var argsep = CommonParams.get('arg_separator');
70+
var editColumnData = editColumnList + '' + argsep + 'edit_central_columns_page=true' + argsep + 'ajax_request=true' + argsep + 'ajax_page_request=true' + argsep + 'db=' + encodeURIComponent(CommonParams.get('db')) + argsep + 'server=' + CommonParams.get('server');
7071
Functions.ajaxShowMessage();
7172
window.AJAX.source = $(this);
7273
$.post('index.php?route=/database/central-columns', editColumnData, window.AJAX.responseHandler);
7374
});
7475
$('#multi_edit_central_columns').on('submit', function (event) {
7576
event.preventDefault();
7677
event.stopPropagation();
77-
var argsep = window.CommonParams.get('arg_separator');
78-
var multiColumnEditData = $('#multi_edit_central_columns').serialize() + argsep + 'multi_edit_central_column_save=true' + argsep + 'ajax_request=true' + argsep + 'ajax_page_request=true' + argsep + 'db=' + encodeURIComponent(window.CommonParams.get('db')) + argsep + 'server=' + window.CommonParams.get('server');
78+
var argsep = CommonParams.get('arg_separator');
79+
var multiColumnEditData = $('#multi_edit_central_columns').serialize() + argsep + 'multi_edit_central_column_save=true' + argsep + 'ajax_request=true' + argsep + 'ajax_page_request=true' + argsep + 'db=' + encodeURIComponent(CommonParams.get('db')) + argsep + 'server=' + CommonParams.get('server');
7980
Functions.ajaxShowMessage();
8081
window.AJAX.source = $(this);
8182
$.post('index.php?route=/database/central-columns', multiColumnEditData, window.AJAX.responseHandler);
@@ -155,7 +156,7 @@ window.AJAX.registerOnload('database/central_columns.js', function () {
155156
$.ajax({
156157
type: 'POST',
157158
url: 'index.php?route=/database/central-columns',
158-
data: datastring + window.CommonParams.get('arg_separator') + 'ajax_request=true',
159+
data: datastring + CommonParams.get('arg_separator') + 'ajax_request=true',
159160
dataType: 'json',
160161
success: function (data) {
161162
if (data.message !== '1') {
@@ -198,8 +199,8 @@ window.AJAX.registerOnload('database/central_columns.js', function () {
198199
var href = 'index.php?route=/database/central-columns/populate';
199200
var params = {
200201
'ajax_request' : true,
201-
'server' : window.CommonParams.get('server'),
202-
'db' : window.CommonParams.get('db'),
202+
'server' : CommonParams.get('server'),
203+
'db' : CommonParams.get('db'),
203204
'selectedTable' : selectValue
204205
};
205206
$('#column-select').html('<option value="">' + window.Messages.strLoading + '</option>');

js/src/database/multi_table_query.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import $ from 'jquery';
2+
import { CommonParams } from '../common.js';
23

34
/**
45
* @fileoverview function used in QBE for DB
@@ -75,7 +76,7 @@ window.AJAX.registerOnload('database/multi_table_query.js', function () {
7576
'db': $('#db_name').val(),
7677
'tables': Object.keys(tableAliases),
7778
'ajax_request': '1',
78-
'token': window.CommonParams.get('token')
79+
'token': CommonParams.get('token')
7980
},
8081
success: function (response) {
8182
foreignKeys = response.foreignKeyConstrains;
@@ -127,8 +128,8 @@ window.AJAX.registerOnload('database/multi_table_query.js', function () {
127128
'db': $('#db_name').val(),
128129
'sql_query': query,
129130
'ajax_request': '1',
130-
'server': window.CommonParams.get('server'),
131-
'token': window.CommonParams.get('token')
131+
'server': CommonParams.get('server'),
132+
'token': CommonParams.get('token')
132133
};
133134
$.ajax({
134135
type: 'POST',

js/src/database/operations.js

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import $ from 'jquery';
2+
import { CommonActions, CommonParams } from '../common.js';
23

34
/* global Navigation */
45

@@ -44,7 +45,7 @@ window.AJAX.registerOnload('database/operations.js', function () {
4445
return false;
4546
}
4647

47-
var oldDbName = window.CommonParams.get('db');
48+
var oldDbName = CommonParams.get('db');
4849
var newDbName = $('#new_db_name').val();
4950

5051
if (newDbName === oldDbName) {
@@ -60,10 +61,10 @@ window.AJAX.registerOnload('database/operations.js', function () {
6061

6162
$form.confirm(question, $form.attr('action'), function (url) {
6263
Functions.ajaxShowMessage(window.Messages.strRenamingDatabases, false);
63-
$.post(url, $('#rename_db_form').serialize() + window.CommonParams.get('arg_separator') + 'is_js_confirmed=1', function (data) {
64+
$.post(url, $('#rename_db_form').serialize() + CommonParams.get('arg_separator') + 'is_js_confirmed=1', function (data) {
6465
if (typeof data !== 'undefined' && data.success === true) {
6566
Functions.ajaxShowMessage(data.message);
66-
window.CommonParams.set('db', data.newname);
67+
CommonParams.set('db', data.newname);
6768

6869
Navigation.reload(function () {
6970
$('#pma_navigation_tree')
@@ -103,12 +104,12 @@ window.AJAX.registerOnload('database/operations.js', function () {
103104
$('.alert-success, .alert-danger').fadeOut();
104105
if (typeof data !== 'undefined' && data.success === true) {
105106
if ($('#checkbox_switch').is(':checked')) {
106-
window.CommonParams.set('db', data.newname);
107-
window.CommonActions.refreshMain(false, function () {
107+
CommonParams.set('db', data.newname);
108+
CommonActions.refreshMain(false, function () {
108109
Functions.ajaxShowMessage(data.message);
109110
});
110111
} else {
111-
window.CommonParams.set('db', data.db);
112+
CommonParams.set('db', data.db);
112113
Functions.ajaxShowMessage(data.message);
113114
}
114115
Navigation.reload();
@@ -155,7 +156,7 @@ window.AJAX.registerOnload('database/operations.js', function () {
155156
var question = window.Messages.strDropDatabaseStrongWarning + ' ';
156157
question += Functions.sprintf(
157158
window.Messages.strDoYouReally,
158-
'DROP DATABASE `' + Functions.escapeHtml(window.CommonParams.get('db') + '`')
159+
'DROP DATABASE `' + Functions.escapeHtml(CommonParams.get('db') + '`')
159160
);
160161
var params = Functions.getJsConfirmCommonParam(this, $link.getPostData());
161162

@@ -165,8 +166,8 @@ window.AJAX.registerOnload('database/operations.js', function () {
165166
if (typeof data !== 'undefined' && data.success) {
166167
// Database deleted successfully, refresh both the frames
167168
Navigation.reload();
168-
window.CommonParams.set('db', '');
169-
window.CommonActions.refreshMain(
169+
CommonParams.set('db', '');
170+
CommonActions.refreshMain(
170171
'index.php?route=/server/databases',
171172
function () {
172173
Functions.ajaxShowMessage(data.message);

js/src/database/search.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import $ from 'jquery';
2+
import { CommonParams } from '../common.js';
23

34
/**
45
* JavaScript functions used on Database Search page
@@ -216,7 +217,7 @@ window.AJAX.registerOnload('database/search.js', function () {
216217

217218
Functions.prepareForAjaxRequest($form);
218219

219-
var url = $form.serialize() + window.CommonParams.get('arg_separator') + 'submit_search=' + $('#buttonGo').val();
220+
var url = $form.serialize() + CommonParams.get('arg_separator') + 'submit_search=' + $('#buttonGo').val();
220221
$.post($form.attr('action'), url, function (data) {
221222
if (typeof data !== 'undefined' && data.success === true) {
222223
// found results

js/src/database/structure.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import $ from 'jquery';
2+
import { CommonParams } from '../common.js';
23

34
/* global Navigation */
45

@@ -203,7 +204,7 @@ window.AJAX.registerOnload('database/structure.js', function () {
203204
$('#makeConsistentWithCentralListModal').modal('show').on('shown.bs.modal', function () {
204205
$('#makeConsistentWithCentralListContinue').on('click', function () {
205206
const $form = $('#tablesForm');
206-
const argSep = window.CommonParams.get('arg_separator');
207+
const argSep = CommonParams.get('arg_separator');
207208
const data = $form.serialize() + argSep + 'ajax_request=true' + argSep + 'ajax_page_request=true';
208209

209210
Functions.ajaxShowMessage();
@@ -298,7 +299,7 @@ window.AJAX.registerOnload('database/structure.js', function () {
298299
}
299300

300301
var $form = $(this).parents('form');
301-
var argsep = window.CommonParams.get('arg_separator');
302+
var argsep = CommonParams.get('arg_separator');
302303
var data = $form.serialize() + argsep + 'ajax_request=true' + argsep + 'ajax_page_request=true';
303304

304305
Functions.ajaxShowMessage();

0 commit comments

Comments
 (0)