From f68e2cb82f725f7cc3e0b2f9a8a4a021e968fc2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maur=C3=ADcio=20Meneghini=20Fauth?= Date: Tue, 5 Jul 2022 21:00:54 -0300 Subject: Refactor home.js file MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Extracts GitInfo and ThemesManager into modules. Signed-off-by: Maurício Meneghini Fauth --- js/src/home.js | 171 +++------------------------------------ js/src/modules/git-info.js | 146 +++++++++++++++++++++++++++++++++ js/src/modules/themes-manager.js | 12 +++ 3 files changed, 169 insertions(+), 160 deletions(-) create mode 100644 js/src/modules/git-info.js create mode 100644 js/src/modules/themes-manager.js diff --git a/js/src/home.js b/js/src/home.js index 08420da020..f7084dfc0e 100644 --- a/js/src/home.js +++ b/js/src/home.js @@ -1,167 +1,18 @@ -import $ from 'jquery'; - -const GitInfo = { - /** - * Version string to integer conversion. - * @param {string} str - * @return {number | false} - */ - parseVersionString: str => { - if (typeof(str) !== 'string') { - return false; - } - let add = 0; - // Parse possible alpha/beta/rc/ - const state = str.split('-'); - if (state.length >= 2) { - if (state[1].startsWith('rc')) { - add = - 20 - parseInt(state[1].substring(2), 10); - } else if (state[1].startsWith('beta')) { - add = - 40 - parseInt(state[1].substring(4), 10); - } else if (state[1].startsWith('alpha')) { - add = - 60 - parseInt(state[1].substring(5), 10); - } else if (state[1].startsWith('dev')) { - /* We don't handle dev, it's git snapshot */ - add = 0; - } - } - // Parse version - const x = str.split('.'); - // Use 0 for non existing parts - const maj = parseInt(x[0], 10) || 0; - const min = parseInt(x[1], 10) || 0; - const pat = parseInt(x[2], 10) || 0; - const hotfix = parseInt(x[3], 10) || 0; - return maj * 100000000 + min * 1000000 + pat * 10000 + hotfix * 100 + add; - }, - - /** - * Indicates current available version on main page. - * @param {object} data - */ - currentVersion: data => { - if (data && data.version && data.date) { - const current = GitInfo.parseVersionString($('span.version').text()); - const latest = GitInfo.parseVersionString(data.version); - const url = './url.php?url=https://www.phpmyadmin.net/files/' + Functions.escapeHtml(encodeURIComponent(data.version)) + '/'; - let versionInformationMessage = document.createElement('span'); - versionInformationMessage.className = 'latest'; - const versionInformationMessageLink = document.createElement('a'); - versionInformationMessageLink.href = url; - versionInformationMessageLink.className = 'disableAjax'; - versionInformationMessageLink.target = '_blank'; - versionInformationMessageLink.rel = 'noopener noreferrer'; - const versionInformationMessageLinkText = document.createTextNode(data.version); - versionInformationMessageLink.appendChild(versionInformationMessageLinkText); - const prefixMessage = document.createTextNode(window.Messages.strLatestAvailable + ' '); - versionInformationMessage.appendChild(prefixMessage); - versionInformationMessage.appendChild(versionInformationMessageLink); - if (latest > current) { - const message = Functions.sprintf( - window.Messages.strNewerVersion, - Functions.escapeHtml(data.version), - Functions.escapeHtml(data.date) - ); - let htmlClass = 'alert alert-primary'; - if (Math.floor(latest / 10000) === Math.floor(current / 10000)) { - /* Security update */ - htmlClass = 'alert alert-danger'; - } - $('#newer_version_notice').remove(); - const mainContainerDiv = document.createElement('div'); - mainContainerDiv.id = 'newer_version_notice'; - mainContainerDiv.className = htmlClass; - const mainContainerDivLink = document.createElement('a'); - mainContainerDivLink.href = url; - mainContainerDivLink.className = 'disableAjax'; - mainContainerDivLink.target = '_blank'; - mainContainerDivLink.rel = 'noopener noreferrer'; - const mainContainerDivLinkText = document.createTextNode(message); - mainContainerDivLink.appendChild(mainContainerDivLinkText); - mainContainerDiv.appendChild(mainContainerDivLink); - $('#maincontainer').append($(mainContainerDiv)); - } - if (latest === current) { - versionInformationMessage = document.createTextNode(' (' + window.Messages.strUpToDate + ')'); - } - /* Remove extra whitespace */ - const versionInfo = $('#li_pma_version').contents().get(2); - if (typeof versionInfo !== 'undefined') { - versionInfo.textContent = versionInfo.textContent.trim(); - } - const $liPmaVersion = $('#li_pma_version'); - $liPmaVersion.find('span.latest').remove(); - $liPmaVersion.append($(versionInformationMessage)); - } - }, - - /** - * Loads Git revision data from ajax for index.php - */ - displayGitRevision: () => { - $('#is_git_revision').remove(); - $('#li_pma_version_git').remove(); - $.get( - 'index.php?route=/git-revision', - { - 'server': window.CommonParams.get('server'), - 'ajax_request': true, - 'no_debug': true - }, - data => { - if (typeof data !== 'undefined' && data.success === true) { - $(data.message).insertAfter('#li_pma_version'); - } - } - ); - }, - - /** - * Load version information asynchronously. - */ - loadVersion: () => { - if ($('li.jsversioncheck').length === 0) { - return; - } - - $.ajax({ - dataType: 'json', - url: 'index.php?route=/version-check', - method: 'POST', - data: { - 'server': window.CommonParams.get('server') - }, - success: GitInfo.currentVersion - }); - }, - - showVersion: () => { - GitInfo.loadVersion(); - if ($('#is_git_revision').length === 0) { - return; - } - - setTimeout(GitInfo.displayGitRevision, 10); - } -}; - -/** - * @implements EventListener - */ -const ThemesManager = { - handleEvent: () => { - $.get('index.php?route=/themes', data => { - $('#themesModal .modal-body').html(data.themes); - }); - } -}; +import { showGitVersion } from './modules/git-info.js'; +import { ThemesManager } from './modules/themes-manager.js'; window.AJAX.registerTeardown('home.js', () => { - $('#themesModal').off('show.bs.modal'); + const themesModal = document.getElementById('themesModal'); + if (themesModal) { + themesModal.removeEventListener('show.bs.modal', ThemesManager.handleEvent); + } }); window.AJAX.registerOnload('home.js', () => { - $('#themesModal').on('show.bs.modal', ThemesManager.handleEvent); + const themesModal = document.getElementById('themesModal'); + if (themesModal) { + themesModal.addEventListener('show.bs.modal', ThemesManager.handleEvent); + } - GitInfo.showVersion(); + showGitVersion(); }); diff --git a/js/src/modules/git-info.js b/js/src/modules/git-info.js new file mode 100644 index 0000000000..792053a5e9 --- /dev/null +++ b/js/src/modules/git-info.js @@ -0,0 +1,146 @@ +import $ from 'jquery'; + +const GitInfo = { + /** + * Version string to integer conversion. + * @param {string} str + * @return {number | false} + */ + parseVersionString: str => { + if (typeof(str) !== 'string') { + return false; + } + let add = 0; + // Parse possible alpha/beta/rc/ + const state = str.split('-'); + if (state.length >= 2) { + if (state[1].startsWith('rc')) { + add = - 20 - parseInt(state[1].substring(2), 10); + } else if (state[1].startsWith('beta')) { + add = - 40 - parseInt(state[1].substring(4), 10); + } else if (state[1].startsWith('alpha')) { + add = - 60 - parseInt(state[1].substring(5), 10); + } else if (state[1].startsWith('dev')) { + /* We don't handle dev, it's git snapshot */ + add = 0; + } + } + // Parse version + const x = str.split('.'); + // Use 0 for non existing parts + const maj = parseInt(x[0], 10) || 0; + const min = parseInt(x[1], 10) || 0; + const pat = parseInt(x[2], 10) || 0; + const hotfix = parseInt(x[3], 10) || 0; + return maj * 100000000 + min * 1000000 + pat * 10000 + hotfix * 100 + add; + }, + + /** + * Indicates current available version on main page. + * @param {object} data + */ + currentVersion: data => { + if (data && data.version && data.date) { + const current = GitInfo.parseVersionString($('span.version').text()); + const latest = GitInfo.parseVersionString(data.version); + const url = './url.php?url=https://www.phpmyadmin.net/files/' + Functions.escapeHtml(encodeURIComponent(data.version)) + '/'; + let versionInformationMessage = document.createElement('span'); + versionInformationMessage.className = 'latest'; + const versionInformationMessageLink = document.createElement('a'); + versionInformationMessageLink.href = url; + versionInformationMessageLink.className = 'disableAjax'; + versionInformationMessageLink.target = '_blank'; + versionInformationMessageLink.rel = 'noopener noreferrer'; + const versionInformationMessageLinkText = document.createTextNode(data.version); + versionInformationMessageLink.appendChild(versionInformationMessageLinkText); + const prefixMessage = document.createTextNode(window.Messages.strLatestAvailable + ' '); + versionInformationMessage.appendChild(prefixMessage); + versionInformationMessage.appendChild(versionInformationMessageLink); + if (latest > current) { + const message = Functions.sprintf( + window.Messages.strNewerVersion, + Functions.escapeHtml(data.version), + Functions.escapeHtml(data.date) + ); + let htmlClass = 'alert alert-primary'; + if (Math.floor(latest / 10000) === Math.floor(current / 10000)) { + /* Security update */ + htmlClass = 'alert alert-danger'; + } + $('#newer_version_notice').remove(); + const mainContainerDiv = document.createElement('div'); + mainContainerDiv.id = 'newer_version_notice'; + mainContainerDiv.className = htmlClass; + const mainContainerDivLink = document.createElement('a'); + mainContainerDivLink.href = url; + mainContainerDivLink.className = 'disableAjax'; + mainContainerDivLink.target = '_blank'; + mainContainerDivLink.rel = 'noopener noreferrer'; + const mainContainerDivLinkText = document.createTextNode(message); + mainContainerDivLink.appendChild(mainContainerDivLinkText); + mainContainerDiv.appendChild(mainContainerDivLink); + $('#maincontainer').append($(mainContainerDiv)); + } + if (latest === current) { + versionInformationMessage = document.createTextNode(' (' + window.Messages.strUpToDate + ')'); + } + /* Remove extra whitespace */ + const versionInfo = $('#li_pma_version').contents().get(2); + if (typeof versionInfo !== 'undefined') { + versionInfo.textContent = versionInfo.textContent.trim(); + } + const $liPmaVersion = $('#li_pma_version'); + $liPmaVersion.find('span.latest').remove(); + $liPmaVersion.append($(versionInformationMessage)); + } + }, + + /** + * Loads Git revision data from ajax for index.php + */ + displayGitRevision: () => { + $('#is_git_revision').remove(); + $('#li_pma_version_git').remove(); + $.get( + 'index.php?route=/git-revision', + { + 'server': window.CommonParams.get('server'), + 'ajax_request': true, + 'no_debug': true + }, + data => { + if (typeof data !== 'undefined' && data.success === true) { + $(data.message).insertAfter('#li_pma_version'); + } + } + ); + }, + + /** + * Load version information asynchronously. + */ + loadVersion: () => { + if ($('li.jsversioncheck').length === 0) { + return; + } + + $.ajax({ + dataType: 'json', + url: 'index.php?route=/version-check', + method: 'POST', + data: { + 'server': window.CommonParams.get('server') + }, + success: GitInfo.currentVersion + }); + } +}; + +export function showGitVersion () { + GitInfo.loadVersion(); + if ($('#is_git_revision').length === 0) { + return; + } + + setTimeout(GitInfo.displayGitRevision, 10); +} diff --git a/js/src/modules/themes-manager.js b/js/src/modules/themes-manager.js new file mode 100644 index 0000000000..9807938473 --- /dev/null +++ b/js/src/modules/themes-manager.js @@ -0,0 +1,12 @@ +import $ from 'jquery'; + +/** + * @implements EventListener + */ +export const ThemesManager = { + handleEvent: () => { + $.get('index.php?route=/themes', data => { + $('#themesModal .modal-body').html(data.themes); + }); + } +}; -- cgit v1.2.3