resources/js/src/database/structure.ts
import $ from 'jquery';
import { AJAX } from '../modules/ajax.ts';
import { Functions } from '../modules/functions.ts';
import { Navigation } from '../modules/navigation.ts';
import { CommonParams } from '../modules/common.ts';
import tooltip from '../modules/tooltip.ts';
import { ajaxRemoveMessage, ajaxShowMessage } from '../modules/ajax-message.ts';
import getJsConfirmCommonParam from '../modules/functions/getJsConfirmCommonParam.ts';
import { escapeHtml } from '../modules/functions/escape.ts';
/**
* @fileoverview functions used on the database structure page
* @name Database Structure
*
* @requires jQueryUI
*/
/**
* AJAX scripts for /database/structure
*
* Actions ajaxified here:
* Drop Database
* Truncate Table
* Drop Table
*
*/
/**
* Unbind all event handlers before tearing down a page
*/
AJAX.registerTeardown('database/structure.js', function () {
$(document).off('click', 'a.truncate_table_anchor.ajax');
$(document).off('click', 'a.drop_table_anchor.ajax');
$(document).off('click', 'a.favorite_table_anchor.ajax');
$('a.real_row_count').off('click');
$('a.row_count_sum').off('click');
$('select[name=submit_mult]').off('change');
});
/**
* Adjust number of rows and total size in the summary
* when truncating, creating, dropping or inserting into a table
*/
const adjustTotals = function () {
var byteUnits = [
window.Messages.strB,
window.Messages.strKiB,
window.Messages.strMiB,
window.Messages.strGiB,
window.Messages.strTiB,
window.Messages.strPiB,
window.Messages.strEiB
];
/**
* @var $allTr jQuery object that references all the rows in the list of tables
*/
var $allTr = $('#tablesForm').find('table.data tbody').first().find('tr');
// New summary values for the table
var tableSum = $allTr.length;
var rowsSum = 0;
var sizeSum = 0;
var overheadSum = 0;
var rowSumApproximated = false;
$allTr.each(function () {
var $this = $(this);
var i;
var tmpVal;
// Get the number of rows for this SQL table
var strRows = $this.find('.tbl_rows').text();
// If the value is approximated
if (strRows.indexOf('~') === 0) {
rowSumApproximated = true;
// The approximated value contains a preceding ~ (Eg 100 --> ~100)
strRows = strRows.substring(1, strRows.length);
}
strRows = strRows.replace(/[,.\s]/g, '');
var intRow = parseInt(strRows, 10);
if (! isNaN(intRow)) {
rowsSum += intRow;
}
// Extract the size and overhead
var valSize = 0;
var valOverhead = 0;
var strSize = $this.find('.tbl_size span:not(.unit)').text().trim();
var strSizeUnit = $this.find('.tbl_size span.unit').text().trim();
var strOverhead = $this.find('.tbl_overhead span:not(.unit)').text().trim();
var strOverheadUnit = $this.find('.tbl_overhead span.unit').text().trim();
// Given a value and a unit, such as 100 and KiB, for the table size
// and overhead calculate their numeric values in bytes, such as 102400
for (i = 0; i < byteUnits.length; i++) {
if (strSizeUnit === byteUnits[i]) {
tmpVal = parseFloat(strSize);
valSize = tmpVal * Math.pow(1024, i);
break;
}
}
for (i = 0; i < byteUnits.length; i++) {
if (strOverheadUnit === byteUnits[i]) {
tmpVal = parseFloat(strOverhead);
valOverhead = tmpVal * Math.pow(1024, i);
break;
}
}
sizeSum += valSize;
overheadSum += valOverhead;
});
// Add some commas for readability:
// 1000000 becomes 1,000,000
var strRowSum = rowsSum + '';
var regex = /(\d+)(\d{3})/;
while (regex.test(strRowSum)) {
strRowSum = strRowSum.replace(regex, '$1' + ',' + '$2');
}
// If approximated total value add ~ in front
if (rowSumApproximated) {
strRowSum = '~' + strRowSum;
}
// Calculate the magnitude for the size and overhead values
var sizeMagnitude = 0;
var overheadMagnitude = 0;
while (sizeSum >= 1024) {
sizeSum /= 1024;
sizeMagnitude++;
}
while (overheadSum >= 1024) {
overheadSum /= 1024;
overheadMagnitude++;
}
sizeSum = Math.round(sizeSum * 10) / 10;
overheadSum = Math.round(overheadSum * 10) / 10;
// Update summary with new data
var $summary = $('#tbl_summary_row');
$summary.find('.tbl_num').text(window.sprintf(window.Messages.strNTables, tableSum));
if (rowSumApproximated) {
$summary.find('.row_count_sum').text(strRowSum);
} else {
$summary.find('.tbl_rows').text(strRowSum);
}
$summary.find('.tbl_size').text(sizeSum + ' ' + byteUnits[sizeMagnitude]);
$summary.find('.tbl_overhead').text(overheadSum + ' ' + byteUnits[overheadMagnitude]);
};
/**
* Gets the real row count for a table or DB.
* @param {object} $target Target for appending the real count value.
*/
const fetchRealRowCount = function ($target) {
var $throbber = $('#pma_navigation').find('.throbber')
.first()
.clone()
.css({ visibility: 'visible', display: 'inline-block' })
.on('click', false);
$target.html($throbber);
$.ajax({
type: 'GET',
url: $target.attr('href'),
cache: false,
dataType: 'json',
success: function (response) {
if (response.success) {
// If to update all row counts for a DB.
if (response.real_row_count_all) {
$.each(response.real_row_count_all,
function (index, table) {
// Update each table row count.
$('table.data td[data-table*="' + table.table + '"]')
.text(table.row_count);
}
);
}
// If to update a particular table's row count.
if (response.real_row_count) {
// Append the parent cell with real row count.
$target.parent().text(response.real_row_count);
}
// Adjust the 'Sum' displayed at the bottom.
DatabaseStructure.adjustTotals();
} else {
ajaxShowMessage(window.Messages.strErrorRealRowCount);
}
},
error: function () {
ajaxShowMessage(window.Messages.strErrorRealRowCount);
}
});
};
AJAX.registerOnload('database/structure.js', function () {
/**
* Event handler on select of "Make consistent with central list"
*/
$('select[name=submit_mult]').on('change', function (event) {
var url = 'index.php?route=/database/structure';
var action = $(this).val();
if (action === 'make_consistent_with_central_list') {
event.preventDefault();
event.stopPropagation();
$('#makeConsistentWithCentralListModal').modal('show').on('shown.bs.modal', function () {
$('#makeConsistentWithCentralListContinue').on('click', function () {
const $form = $('#tablesForm');
const argSep = CommonParams.get('arg_separator');
const data = $form.serialize() + argSep + 'ajax_request=true' + argSep + 'ajax_page_request=true';
ajaxShowMessage();
AJAX.source = $form;
$.post(
'index.php?route=/database/structure/central-columns/make-consistent',
data,
AJAX.responseHandler
);
$('#makeConsistentWithCentralListModal').modal('hide');
});
});
return;
}
if (action === 'copy_tbl' ||
action === 'add_prefix_tbl' ||
action === 'replace_prefix_tbl' ||
action === 'copy_tbl_change_prefix'
) {
event.preventDefault();
event.stopPropagation();
if ($('input[name="selected_tbl[]"]:checked').length === 0) {
return false;
}
var formData = $('#tablesForm').serialize();
var modalTitle = '';
if (action === 'copy_tbl') {
url = 'index.php?route=/database/structure/copy-form';
modalTitle = window.Messages.strCopyTablesTo;
} else if (action === 'add_prefix_tbl') {
url = 'index.php?route=/database/structure/add-prefix';
modalTitle = window.Messages.strAddPrefix;
} else if (action === 'replace_prefix_tbl') {
url = 'index.php?route=/database/structure/change-prefix-form';
modalTitle = window.Messages.strReplacePrefix;
} else if (action === 'copy_tbl_change_prefix') {
url = 'index.php?route=/database/structure/change-prefix-form';
modalTitle = window.Messages.strCopyPrefix;
}
$.ajax({
type: 'POST',
url: url,
dataType: 'html',
data: formData
}).done(function (modalBody) {
const bulkActionModal = $('#bulkActionModal');
bulkActionModal.on('show.bs.modal', function () {
(this.querySelector('.modal-title') as HTMLHeadingElement).innerText = modalTitle;
this.querySelector('.modal-body').innerHTML = modalBody;
});
bulkActionModal.modal('show').on('shown.bs.modal', function () {
$('#bulkActionContinue').on('click', function () {
$('#ajax_form').trigger('submit');
$('#bulkActionModal').modal('hide');
});
});
});
return;
}
if (action === 'analyze_tbl') {
url = 'index.php?route=/table/maintenance/analyze';
} else if (action === 'sync_unique_columns_central_list') {
url = 'index.php?route=/database/structure/central-columns/add';
} else if (action === 'delete_unique_columns_central_list') {
url = 'index.php?route=/database/structure/central-columns/remove';
} else if (action === 'check_tbl') {
url = 'index.php?route=/table/maintenance/check';
} else if (action === 'checksum_tbl') {
url = 'index.php?route=/table/maintenance/checksum';
} else if (action === 'drop_tbl') {
url = 'index.php?route=/database/structure/drop-form';
} else if (action === 'empty_tbl') {
url = 'index.php?route=/database/structure/empty-form';
} else if (action === 'export') {
url = 'index.php?route=/export/tables';
} else if (action === 'optimize_tbl') {
url = 'index.php?route=/table/maintenance/optimize';
} else if (action === 'repair_tbl') {
url = 'index.php?route=/table/maintenance/repair';
} else if (action === 'show_create') {
url = 'index.php?route=/database/structure/show-create';
} else {
$('#tablesForm').trigger('submit');
return;
}
var $form = $(this).parents('form');
var argsep = CommonParams.get('arg_separator');
var data = $form.serialize() + argsep + 'ajax_request=true' + argsep + 'ajax_page_request=true';
ajaxShowMessage();
AJAX.source = $form;
$.post(url, data, AJAX.responseHandler);
});
/**
* Ajax Event handler for 'Truncate Table'
*/
$(document).on('click', 'a.truncate_table_anchor.ajax', function (event) {
event.preventDefault();
/**
* @var $this_anchor Object referring to the anchor clicked
*/
var $thisAnchor = $(this);
// extract current table name and build the question string
/**
* @var curr_table_name String containing the name of the table to be truncated
*/
var currTableName = $thisAnchor.parents('tr').children('th').children('a').text();
/**
* @var question String containing the question to be asked for confirmation
*/
var question = window.Messages.strTruncateTableStrongWarning + ' ' +
window.sprintf(window.Messages.strDoYouReally, 'TRUNCATE `' + escapeHtml(currTableName) + '`') +
Functions.getForeignKeyCheckboxLoader();
$thisAnchor.confirm(question, $thisAnchor.attr('href'), function (url) {
ajaxShowMessage(window.Messages.strProcessingRequest);
var params = getJsConfirmCommonParam(this, $thisAnchor.getPostData());
$.post(url, params, function (data) {
if (typeof data !== 'undefined' && data.success === true) {
ajaxShowMessage(data.message);
// Adjust table statistics
var $tr = $thisAnchor.closest('tr');
$tr.find('.tbl_rows').text('0');
$tr.find('.tbl_size, .tbl_overhead').text('-');
DatabaseStructure.adjustTotals();
} else {
ajaxShowMessage(window.Messages.strErrorProcessingRequest + ' : ' + data.error, false);
}
}); // end $.post()
}, Functions.loadForeignKeyCheckbox);
}); // end of Truncate Table Ajax action
/**
* Ajax Event handler for 'Drop Table' or 'Drop View'
*/
$(document).on('click', 'a.drop_table_anchor.ajax', function (event) {
event.preventDefault();
var $thisAnchor = $(this);
// extract current table name and build the question string
/**
* @var $curr_row Object containing reference to the current row
*/
var $currRow = $thisAnchor.parents('tr');
/**
* @var curr_table_name String containing the name of the table to be truncated
*/
var currTableName = $currRow.children('th').children('a').text();
/**
* @var is_view Boolean telling if we have a view
*/
var isView = $currRow.hasClass('is_view') || $thisAnchor.hasClass('view');
/**
* @var question String containing the question to be asked for confirmation
*/
var question;
if (! isView) {
question = window.Messages.strDropTableStrongWarning + ' ' +
window.sprintf(window.Messages.strDoYouReally, 'DROP TABLE `' + escapeHtml(currTableName) + '`');
} else {
question =
window.sprintf(window.Messages.strDoYouReally, 'DROP VIEW `' + escapeHtml(currTableName) + '`');
}
question += Functions.getForeignKeyCheckboxLoader();
$thisAnchor.confirm(question, $thisAnchor.attr('href'), function (url) {
var $msg = ajaxShowMessage(window.Messages.strProcessingRequest);
var params = getJsConfirmCommonParam(this, $thisAnchor.getPostData());
$.post(url, params, function (data) {
if (typeof data !== 'undefined' && data.success === true) {
ajaxShowMessage(data.message);
$currRow.hide('medium').remove();
DatabaseStructure.adjustTotals();
Navigation.reload();
ajaxRemoveMessage($msg);
} else {
ajaxShowMessage(window.Messages.strErrorProcessingRequest + ' : ' + data.error, false);
}
}); // end $.post()
}, Functions.loadForeignKeyCheckbox);
}); // end of Drop Table Ajax action
// Add tooltip to favorite icons.
$('.favorite_table_anchor').each(function () {
tooltip($(this), 'a', $(this).attr('title'));
});
// Get real row count via Ajax.
$('a.real_row_count').on('click', function (event) {
event.preventDefault();
DatabaseStructure.fetchRealRowCount($(this));
});
// Get all real row count.
$('a.row_count_sum').on('click', function (event) {
event.preventDefault();
DatabaseStructure.fetchRealRowCount($(this));
});
});
const DatabaseStructure = {
adjustTotals: adjustTotals,
fetchRealRowCount: fetchRealRowCount,
};
declare global {
interface Window {
DatabaseStructure: typeof DatabaseStructure;
}
}
window.DatabaseStructure = DatabaseStructure;