diff options
Diffstat (limited to 'srcs/phpmyadmin/js/console.js')
| -rw-r--r-- | srcs/phpmyadmin/js/console.js | 1509 |
1 files changed, 1509 insertions, 0 deletions
diff --git a/srcs/phpmyadmin/js/console.js b/srcs/phpmyadmin/js/console.js new file mode 100644 index 0000000..2ec580e --- /dev/null +++ b/srcs/phpmyadmin/js/console.js @@ -0,0 +1,1509 @@ +/* vim: set expandtab sw=4 ts=4 sts=4: */ +/** + * Used in or for console + * + * @package phpMyAdmin-Console + */ + +/* global debugSQLInfo */ // libraries/classes/Footer.php + +/** + * Console object + */ +var Console = { + /** + * @var object, jQuery object, selector is '#pma_console>.content' + * @access private + */ + $consoleContent: null, + /** + * @var object, jQuery object, selector is '#pma_console .content', + * used for resizer + * @access private + */ + $consoleAllContents: null, + /** + * @var object, jQuery object, selector is '#pma_console .toolbar' + * @access private + */ + $consoleToolbar: null, + /** + * @var object, jQuery object, selector is '#pma_console .template' + * @access private + */ + $consoleTemplates: null, + /** + * @var object, jQuery object, form for submit + * @access private + */ + $requestForm: null, + /** + * @var object, contain console config + * @access private + */ + config: null, + /** + * @var bool, if console element exist, it'll be true + * @access public + */ + isEnabled: false, + /** + * @var bool, make sure console events bind only once + * @access private + */ + isInitialized: false, + /** + * Used for console initialize, reinit is ok, just some variable assignment + * + * @return void + */ + initialize: function () { + if ($('#pma_console').length === 0) { + return; + } + + Console.config = Functions.configGet('Console', false); + + Console.isEnabled = true; + + // Vars init + Console.$consoleToolbar = $('#pma_console').find('>.toolbar'); + Console.$consoleContent = $('#pma_console').find('>.content'); + Console.$consoleAllContents = $('#pma_console').find('.content'); + Console.$consoleTemplates = $('#pma_console').find('>.templates'); + + // Generate a from for post + Console.$requestForm = $('<form method="post" action="import.php">' + + '<input name="is_js_confirmed" value="0">' + + '<textarea name="sql_query"></textarea>' + + '<input name="console_message_id" value="0">' + + '<input name="server" value="">' + + '<input name="db" value="">' + + '<input name="table" value="">' + + '<input name="token" value="">' + + '</form>' + ); + Console.$requestForm.children('[name=token]').val(CommonParams.get('token')); + Console.$requestForm.on('submit', AJAX.requestHandler); + + // Event binds shouldn't run again + if (Console.isInitialized === false) { + // Load config first + if (Console.config.AlwaysExpand === true) { + $('#pma_console_options input[name=always_expand]').prop('checked', true); + } + if (Console.config.StartHistory === true) { + $('#pma_console_options').find('input[name=start_history]').prop('checked', true); + } + if (Console.config.CurrentQuery === true) { + $('#pma_console_options').find('input[name=current_query]').prop('checked', true); + } + if (Console.config.EnterExecutes === true) { + $('#pma_console_options').find('input[name=enter_executes]').prop('checked', true); + } + if (Console.config.DarkTheme === true) { + $('#pma_console_options').find('input[name=dark_theme]').prop('checked', true); + $('#pma_console').find('>.content').addClass('console_dark_theme'); + } + + ConsoleResizer.initialize(); + ConsoleInput.initialize(); + ConsoleMessages.initialize(); + ConsoleBookmarks.initialize(); + ConsoleDebug.initialize(); + + Console.$consoleToolbar.children('.console_switch').on('click', Console.toggle); + + $('#pma_console').find('.toolbar').children().on('mousedown', function (event) { + event.preventDefault(); + event.stopImmediatePropagation(); + }); + + $('#pma_console').find('.button.clear').on('click', function () { + ConsoleMessages.clear(); + }); + + $('#pma_console').find('.button.history').on('click', function () { + ConsoleMessages.showHistory(); + }); + + $('#pma_console').find('.button.options').on('click', function () { + Console.showCard('#pma_console_options'); + }); + + $('#pma_console').find('.button.debug').on('click', function () { + Console.showCard('#debug_console'); + }); + + Console.$consoleContent.on('click', function (event) { + if (event.target === this) { + ConsoleInput.focus(); + } + }); + + $('#pma_console').find('.mid_layer').on('click', function () { + Console.hideCard($(this).parent().children('.card')); + }); + $('#debug_console').find('.switch_button').on('click', function () { + Console.hideCard($(this).closest('.card')); + }); + $('#pma_bookmarks').find('.switch_button').on('click', function () { + Console.hideCard($(this).closest('.card')); + }); + $('#pma_console_options').find('.switch_button').on('click', function () { + Console.hideCard($(this).closest('.card')); + }); + + $('#pma_console_options').find('input[type=checkbox]').on('change', function () { + Console.updateConfig(); + }); + + $('#pma_console_options').find('.button.default').on('click', function () { + $('#pma_console_options input[name=always_expand]').prop('checked', false); + $('#pma_console_options').find('input[name=start_history]').prop('checked', false); + $('#pma_console_options').find('input[name=current_query]').prop('checked', true); + $('#pma_console_options').find('input[name=enter_executes]').prop('checked', false); + $('#pma_console_options').find('input[name=dark_theme]').prop('checked', false); + Console.updateConfig(); + }); + + $('#pma_console_options').find('input[name=enter_executes]').on('change', function () { + ConsoleMessages.showInstructions(Console.config.EnterExecutes); + }); + + $(document).ajaxComplete(function (event, xhr, ajaxOptions) { + if (ajaxOptions.dataType && ajaxOptions.dataType.indexOf('json') !== -1) { + return; + } + if (xhr.status !== 200) { + return; + } + try { + var data = JSON.parse(xhr.responseText); + Console.ajaxCallback(data); + } catch (e) { + // eslint-disable-next-line no-console + console.trace(); + // eslint-disable-next-line no-console + console.log('Failed to parse JSON: ' + e.message); + } + }); + + Console.isInitialized = true; + } + + // Change console mode from cookie + switch (Console.config.Mode) { + case 'collapse': + Console.collapse(); + break; + case 'info': + Console.info(); + break; + case 'show': + Console.show(true); + Console.scrollBottom(); + break; + default: + Console.setConfig('Mode', 'info'); + Console.info(); + } + }, + /** + * Execute query and show results in console + * + * @return void + */ + execute: function (queryString, options) { + if (typeof(queryString) !== 'string' || ! /[a-z]|[A-Z]/.test(queryString)) { + return; + } + Console.$requestForm.children('textarea').val(queryString); + Console.$requestForm.children('[name=server]').attr('value', CommonParams.get('server')); + if (options && options.db) { + Console.$requestForm.children('[name=db]').val(options.db); + if (options.table) { + Console.$requestForm.children('[name=table]').val(options.table); + } else { + Console.$requestForm.children('[name=table]').val(''); + } + } else { + Console.$requestForm.children('[name=db]').val( + (CommonParams.get('db').length > 0 ? CommonParams.get('db') : '')); + } + Console.$requestForm.find('[name=profiling]').remove(); + if (options && options.profiling === true) { + Console.$requestForm.append('<input name="profiling" value="on">'); + } + if (! Functions.confirmQuery(Console.$requestForm[0], Console.$requestForm.children('textarea')[0].value)) { + return; + } + Console.$requestForm.children('[name=console_message_id]') + .val(ConsoleMessages.appendQuery({ 'sql_query': queryString }).message_id); + Console.$requestForm.trigger('submit'); + ConsoleInput.clear(); + Navigation.reload(); + }, + ajaxCallback: function (data) { + if (data && data.console_message_id) { + ConsoleMessages.updateQuery(data.console_message_id, data.success, + (data.reloadQuerywindow ? data.reloadQuerywindow : false)); + } else if (data && data.reloadQuerywindow) { + if (data.reloadQuerywindow.sql_query.length > 0) { + ConsoleMessages.appendQuery(data.reloadQuerywindow, 'successed') + .$message.addClass(Console.config.CurrentQuery ? '' : 'hide'); + } + } + }, + /** + * Change console to collapse mode + * + * @return void + */ + collapse: function () { + Console.setConfig('Mode', 'collapse'); + var pmaConsoleHeight = Math.max(92, Console.config.Height); + + Console.$consoleToolbar.addClass('collapsed'); + Console.$consoleAllContents.height(pmaConsoleHeight); + Console.$consoleContent.stop(); + Console.$consoleContent.animate({ 'margin-bottom': -1 * Console.$consoleContent.outerHeight() + 'px' }, + 'fast', 'easeOutQuart', function () { + Console.$consoleContent.css({ display:'none' }); + $(window).trigger('resize'); + }); + Console.hideCard(); + }, + /** + * Show console + * + * @param bool inputFocus If true, focus the input line after show() + * @return void + */ + show: function (inputFocus) { + Console.setConfig('Mode', 'show'); + + var pmaConsoleHeight = Math.max(92, Console.config.Height); + pmaConsoleHeight = Math.min(Console.config.Height, (window.innerHeight || document.documentElement.clientHeight || document.body.clientHeight) - 25); + Console.$consoleContent.css({ display:'block' }); + if (Console.$consoleToolbar.hasClass('collapsed')) { + Console.$consoleToolbar.removeClass('collapsed'); + } + Console.$consoleAllContents.height(pmaConsoleHeight); + Console.$consoleContent.stop(); + Console.$consoleContent.animate({ 'margin-bottom': 0 }, + 'fast', 'easeOutQuart', function () { + $(window).trigger('resize'); + if (inputFocus) { + ConsoleInput.focus(); + } + }); + }, + /** + * Change console to SQL information mode + * this mode shows current SQL query + * This mode is the default mode + * + * @return void + */ + info: function () { + // Under construction + Console.collapse(); + }, + /** + * Toggle console mode between collapse/show + * Used for toggle buttons and shortcuts + * + * @return void + */ + toggle: function () { + switch (Console.config.Mode) { + case 'collapse': + case 'info': + Console.show(true); + break; + case 'show': + Console.collapse(); + break; + } + }, + /** + * Scroll console to bottom + * + * @return void + */ + scrollBottom: function () { + Console.$consoleContent.scrollTop(Console.$consoleContent.prop('scrollHeight')); + }, + /** + * Show card + * + * @param string cardSelector Selector, select string will be "#pma_console " + cardSelector + * this param also can be JQuery object, if you need. + * + * @return void + */ + showCard: function (cardSelector) { + var $card = null; + if (typeof(cardSelector) !== 'string') { + if (cardSelector.length > 0) { + $card = cardSelector; + } else { + return; + } + } else { + $card = $('#pma_console ' + cardSelector); + } + if ($card.length === 0) { + return; + } + $card.parent().children('.mid_layer').show().fadeTo(0, 0.15); + $card.addClass('show'); + ConsoleInput.blur(); + if ($card.parents('.card').length > 0) { + Console.showCard($card.parents('.card')); + } + }, + /** + * Scroll console to bottom + * + * @param object $targetCard Target card JQuery object, if it's empty, function will hide all cards + * @return void + */ + hideCard: function ($targetCard) { + if (! $targetCard) { + $('#pma_console').find('.mid_layer').fadeOut(140); + $('#pma_console').find('.card').removeClass('show'); + } else if ($targetCard.length > 0) { + $targetCard.parent().find('.mid_layer').fadeOut(140); + $targetCard.find('.card').removeClass('show'); + $targetCard.removeClass('show'); + } + }, + /** + * Used for update console config + * + * @return void + */ + updateConfig: function () { + Console.setConfig('AlwaysExpand', $('#pma_console_options input[name=always_expand]').prop('checked')); + Console.setConfig('StartHistory', $('#pma_console_options').find('input[name=start_history]').prop('checked')); + Console.setConfig('CurrentQuery', $('#pma_console_options').find('input[name=current_query]').prop('checked')); + Console.setConfig('EnterExecutes', $('#pma_console_options').find('input[name=enter_executes]').prop('checked')); + Console.setConfig('DarkTheme', $('#pma_console_options').find('input[name=dark_theme]').prop('checked')); + /* Setting the dark theme of the console*/ + if (Console.config.DarkTheme) { + $('#pma_console').find('>.content').addClass('console_dark_theme'); + } else { + $('#pma_console').find('>.content').removeClass('console_dark_theme'); + } + }, + setConfig: function (key, value) { + Console.config[key] = value; + Functions.configSet('Console/' + key, value); + }, + isSelect: function (queryString) { + var regExp = /^SELECT\s+/i; + return regExp.test(queryString); + } +}; + +/** + * Resizer object + * Careful: this object UI logics highly related with functions under Console + * Resizing min-height is 32, if small than it, console will collapse + */ +var ConsoleResizer = { + posY: 0, + height: 0, + resultHeight: 0, + /** + * Mousedown event handler for bind to resizer + * + * @return void + */ + mouseDown: function (event) { + if (Console.config.Mode !== 'show') { + return; + } + ConsoleResizer.posY = event.pageY; + ConsoleResizer.height = Console.$consoleContent.height(); + $(document).on('mousemove', ConsoleResizer.mouseMove); + $(document).on('mouseup', ConsoleResizer.mouseUp); + // Disable text selection while resizing + $(document).on('selectstart', function () { + return false; + }); + }, + /** + * Mousemove event handler for bind to resizer + * + * @return void + */ + mouseMove: function (event) { + if (event.pageY < 35) { + event.pageY = 35; + } + ConsoleResizer.resultHeight = ConsoleResizer.height + (ConsoleResizer.posY - event.pageY); + // Content min-height is 32, if adjusting height small than it we'll move it out of the page + if (ConsoleResizer.resultHeight <= 32) { + Console.$consoleAllContents.height(32); + Console.$consoleContent.css('margin-bottom', ConsoleResizer.resultHeight - 32); + } else { + // Logic below makes viewable area always at bottom when adjusting height and content already at bottom + if (Console.$consoleContent.scrollTop() + Console.$consoleContent.innerHeight() + 16 + >= Console.$consoleContent.prop('scrollHeight')) { + Console.$consoleAllContents.height(ConsoleResizer.resultHeight); + Console.scrollBottom(); + } else { + Console.$consoleAllContents.height(ConsoleResizer.resultHeight); + } + } + }, + /** + * Mouseup event handler for bind to resizer + * + * @return void + */ + mouseUp: function () { + Console.setConfig('Height', ConsoleResizer.resultHeight); + Console.show(); + $(document).off('mousemove'); + $(document).off('mouseup'); + $(document).off('selectstart'); + }, + /** + * Used for console resizer initialize + * + * @return void + */ + initialize: function () { + $('#pma_console').find('.toolbar').off('mousedown'); + $('#pma_console').find('.toolbar').on('mousedown', ConsoleResizer.mouseDown); + } +}; + +/** + * Console input object + */ +var ConsoleInput = { + /** + * @var array, contains Codemirror objects or input jQuery objects + * @access private + */ + inputs: null, + /** + * @var bool, if codemirror enabled + * @access private + */ + codeMirror: false, + /** + * @var int, count for history navigation, 0 for current input + * @access private + */ + historyCount: 0, + /** + * @var string, current input when navigating through history + * @access private + */ + historyPreserveCurrent: null, + /** + * Used for console input initialize + * + * @return void + */ + initialize: function () { + // _cm object can't be reinitialize + if (ConsoleInput.inputs !== null) { + return; + } + if (typeof CodeMirror !== 'undefined') { + ConsoleInput.codeMirror = true; + } + ConsoleInput.inputs = []; + if (ConsoleInput.codeMirror) { + // eslint-disable-next-line new-cap + ConsoleInput.inputs.console = CodeMirror($('#pma_console').find('.console_query_input')[0], { + theme: 'pma', + mode: 'text/x-sql', + lineWrapping: true, + extraKeys: { 'Ctrl-Space': 'autocomplete' }, + hintOptions: { 'completeSingle': false, 'completeOnSingleClick': true }, + gutters: ['CodeMirror-lint-markers'], + lint: { + 'getAnnotations': CodeMirror.sqlLint, + 'async': true, + } + }); + ConsoleInput.inputs.console.on('inputRead', Functions.codeMirrorAutoCompleteOnInputRead); + ConsoleInput.inputs.console.on('keydown', function (instance, event) { + ConsoleInput.historyNavigate(event); + }); + if ($('#pma_bookmarks').length !== 0) { + // eslint-disable-next-line new-cap + ConsoleInput.inputs.bookmark = CodeMirror($('#pma_console').find('.bookmark_add_input')[0], { + theme: 'pma', + mode: 'text/x-sql', + lineWrapping: true, + extraKeys: { 'Ctrl-Space': 'autocomplete' }, + hintOptions: { 'completeSingle': false, 'completeOnSingleClick': true }, + gutters: ['CodeMirror-lint-markers'], + lint: { + 'getAnnotations': CodeMirror.sqlLint, + 'async': true, + } + }); + ConsoleInput.inputs.bookmark.on('inputRead', Functions.codeMirrorAutoCompleteOnInputRead); + } + } else { + ConsoleInput.inputs.console = + $('<textarea>').appendTo('#pma_console .console_query_input') + .on('keydown', ConsoleInput.historyNavigate); + if ($('#pma_bookmarks').length !== 0) { + ConsoleInput.inputs.bookmark = + $('<textarea>').appendTo('#pma_console .bookmark_add_input'); + } + } + $('#pma_console').find('.console_query_input').on('keydown', ConsoleInput.keyDown); + }, + historyNavigate: function (event) { + if (event.keyCode === 38 || event.keyCode === 40) { + var upPermitted = false; + var downPermitted = false; + var editor = ConsoleInput.inputs.console; + var cursorLine; + var totalLine; + if (ConsoleInput.codeMirror) { + cursorLine = editor.getCursor().line; + totalLine = editor.lineCount(); + } else { + // Get cursor position from textarea + var text = ConsoleInput.getText(); + cursorLine = text.substr(0, editor.prop('selectionStart')).split('\n').length - 1; + totalLine = text.split(/\r*\n/).length; + } + if (cursorLine === 0) { + upPermitted = true; + } + if (cursorLine === totalLine - 1) { + downPermitted = true; + } + var nextCount; + var queryString = false; + if (upPermitted && event.keyCode === 38) { + // Navigate up in history + if (ConsoleInput.historyCount === 0) { + ConsoleInput.historyPreserveCurrent = ConsoleInput.getText(); + } + nextCount = ConsoleInput.historyCount + 1; + queryString = ConsoleMessages.getHistory(nextCount); + } else if (downPermitted && event.keyCode === 40) { + // Navigate down in history + if (ConsoleInput.historyCount === 0) { + return; + } + nextCount = ConsoleInput.historyCount - 1; + if (nextCount === 0) { + queryString = ConsoleInput.historyPreserveCurrent; + } else { + queryString = ConsoleMessages.getHistory(nextCount); + } + } + if (queryString !== false) { + ConsoleInput.historyCount = nextCount; + ConsoleInput.setText(queryString, 'console'); + if (ConsoleInput.codeMirror) { + editor.setCursor(editor.lineCount(), 0); + } + event.preventDefault(); + } + } + }, + /** + * Mousedown event handler for bind to input + * Shortcut is Ctrl+Enter key or just ENTER, depending on console's + * configuration. + * + * @return void + */ + keyDown: function (event) { + // Execute command + if (Console.config.EnterExecutes) { + // Enter, but not in combination with Shift (which writes a new line). + if (!event.shiftKey && event.keyCode === 13) { + ConsoleInput.execute(); + } + } else { + // Ctrl+Enter + if (event.ctrlKey && event.keyCode === 13) { + ConsoleInput.execute(); + } + } + // Clear line + if (event.ctrlKey && event.keyCode === 76) { + ConsoleInput.clear(); + } + // Clear console + if (event.ctrlKey && event.keyCode === 85) { + ConsoleMessages.clear(); + } + }, + /** + * Used for send text to Console.execute() + * + * @return void + */ + execute: function () { + if (ConsoleInput.codeMirror) { + Console.execute(ConsoleInput.inputs.console.getValue()); + } else { + Console.execute(ConsoleInput.inputs.console.val()); + } + }, + /** + * Used for clear the input + * + * @param string target, default target is console input + * @return void + */ + clear: function (target) { + ConsoleInput.setText('', target); + }, + /** + * Used for set focus to input + * + * @return void + */ + focus: function () { + ConsoleInput.inputs.console.focus(); + }, + /** + * Used for blur input + * + * @return void + */ + blur: function () { + if (ConsoleInput.codeMirror) { + ConsoleInput.inputs.console.getInputField().blur(); + } else { + ConsoleInput.inputs.console.blur(); + } + }, + /** + * Used for set text in input + * + * @param string text + * @param string target + * @return void + */ + setText: function (text, target) { + if (ConsoleInput.codeMirror) { + switch (target) { + case 'bookmark': + Console.execute(ConsoleInput.inputs.bookmark.setValue(text)); + break; + default: + case 'console': + Console.execute(ConsoleInput.inputs.console.setValue(text)); + } + } else { + switch (target) { + case 'bookmark': + Console.execute(ConsoleInput.inputs.bookmark.val(text)); + break; + default: + case 'console': + Console.execute(ConsoleInput.inputs.console.val(text)); + } + } + }, + getText: function (target) { + if (ConsoleInput.codeMirror) { + switch (target) { + case 'bookmark': + return ConsoleInput.inputs.bookmark.getValue(); + default: + case 'console': + return ConsoleInput.inputs.console.getValue(); + } + } else { + switch (target) { + case 'bookmark': + return ConsoleInput.inputs.bookmark.val(); + default: + case 'console': + return ConsoleInput.inputs.console.val(); + } + } + } + +}; + +/** + * Console messages, and message items management object + */ +var ConsoleMessages = { + /** + * Used for clear the messages + * + * @return void + */ + clear: function () { + $('#pma_console').find('.content .console_message_container .message:not(.welcome)').addClass('hide'); + $('#pma_console').find('.content .console_message_container .message.failed').remove(); + $('#pma_console').find('.content .console_message_container .message.expanded').find('.action.collapse').trigger('click'); + }, + /** + * Used for show history messages + * + * @return void + */ + showHistory: function () { + $('#pma_console').find('.content .console_message_container .message.hide').removeClass('hide'); + }, + /** + * Used for getting a perticular history query + * + * @param int nthLast get nth query message from latest, i.e 1st is last + * @return string message + */ + getHistory: function (nthLast) { + var $queries = $('#pma_console').find('.content .console_message_container .query'); + var length = $queries.length; + var $query = $queries.eq(length - nthLast); + if (!$query || (length - nthLast) < 0) { + return false; + } else { + return $query.text(); + } + }, + /** + * Used to show the correct message depending on which key + * combination executes the query (Ctrl+Enter or Enter). + * + * @param bool enterExecutes Only Enter has to be pressed to execute query. + * @return void + */ + showInstructions: function (enterExecutes) { + var enter = +enterExecutes || 0; // conversion to int + var $welcomeMsg = $('#pma_console').find('.content .console_message_container .message.welcome span'); + $welcomeMsg.children('[id^=instructions]').hide(); + $welcomeMsg.children('#instructions-' + enter).show(); + }, + /** + * Used for log new message + * + * @param string msgString Message to show + * @param string msgType Message type + * @return object, {message_id, $message} + */ + append: function (msgString, msgType) { + if (typeof(msgString) !== 'string') { + return false; + } + // Generate an ID for each message, we can find them later + var msgId = Math.round(Math.random() * (899999999999) + 100000000000); + var now = new Date(); + var $newMessage = + $('<div class="message ' + + (Console.config.AlwaysExpand ? 'expanded' : 'collapsed') + + '" msgid="' + msgId + '"><div class="action_content"></div></div>'); + switch (msgType) { + case 'query': + $newMessage.append('<div class="query highlighted"></div>'); + if (ConsoleInput.codeMirror) { + CodeMirror.runMode(msgString, + 'text/x-sql', $newMessage.children('.query')[0]); + } else { + $newMessage.children('.query').text(msgString); + } + $newMessage.children('.action_content') + .append(Console.$consoleTemplates.children('.query_actions').html()); + break; + default: + case 'normal': + $newMessage.append('<div>' + msgString + '</div>'); + } + ConsoleMessages.messageEventBinds($newMessage); + $newMessage.find('span.text.query_time span') + .text(now.getHours() + ':' + now.getMinutes() + ':' + now.getSeconds()) + .parent().attr('title', now); + return { + 'message_id': msgId, + $message: $newMessage.appendTo('#pma_console .content .console_message_container') + }; + }, + /** + * Used for log new query + * + * @param string queryData Struct should be + * {sql_query: "Query string", db: "Target DB", table: "Target Table"} + * @param string state Message state + * @return object, {message_id: string message id, $message: JQuery object} + */ + appendQuery: function (queryData, state) { + var targetMessage = ConsoleMessages.append(queryData.sql_query, 'query'); + if (! targetMessage) { + return false; + } + if (queryData.db && queryData.table) { + targetMessage.$message.attr('targetdb', queryData.db); + targetMessage.$message.attr('targettable', queryData.table); + targetMessage.$message.find('.text.targetdb span').text(queryData.db); + } + if (Console.isSelect(queryData.sql_query)) { + targetMessage.$message.addClass('select'); + } + switch (state) { + case 'failed': + targetMessage.$message.addClass('failed'); + break; + case 'successed': + targetMessage.$message.addClass('successed'); + break; + default: + case 'pending': + targetMessage.$message.addClass('pending'); + } + return targetMessage; + }, + messageEventBinds: function ($target) { + // Leave unbinded elements, remove binded. + var $targetMessage = $target.filter(':not(.binded)'); + if ($targetMessage.length === 0) { + return; + } + $targetMessage.addClass('binded'); + + $targetMessage.find('.action.expand').on('click', function () { + $(this).closest('.message').removeClass('collapsed'); + $(this).closest('.message').addClass('expanded'); + }); + $targetMessage.find('.action.collapse').on('click', function () { + $(this).closest('.message').addClass('collapsed'); + $(this).closest('.message').removeClass('expanded'); + }); + $targetMessage.find('.action.edit').on('click', function () { + ConsoleInput.setText($(this).parent().siblings('.query').text()); + ConsoleInput.focus(); + }); + $targetMessage.find('.action.requery').on('click', function () { + var query = $(this).parent().siblings('.query').text(); + var $message = $(this).closest('.message'); + if (confirm(Messages.strConsoleRequeryConfirm + '\n' + + (query.length < 100 ? query : query.slice(0, 100) + '...')) + ) { + Console.execute(query, { db: $message.attr('targetdb'), table: $message.attr('targettable') }); + } + }); + $targetMessage.find('.action.bookmark').on('click', function () { + var query = $(this).parent().siblings('.query').text(); + var $message = $(this).closest('.message'); + ConsoleBookmarks.addBookmark(query, $message.attr('targetdb')); + Console.showCard('#pma_bookmarks .card.add'); + }); + $targetMessage.find('.action.edit_bookmark').on('click', function () { + var query = $(this).parent().siblings('.query').text(); + var $message = $(this).closest('.message'); + var isShared = $message.find('span.bookmark_label').hasClass('shared'); + var label = $message.find('span.bookmark_label').text(); + ConsoleBookmarks.addBookmark(query, $message.attr('targetdb'), label, isShared); + Console.showCard('#pma_bookmarks .card.add'); + }); + $targetMessage.find('.action.delete_bookmark').on('click', function () { + var $message = $(this).closest('.message'); + if (confirm(Messages.strConsoleDeleteBookmarkConfirm + '\n' + $message.find('.bookmark_label').text())) { + $.post('import.php', + { + 'server': CommonParams.get('server'), + 'action_bookmark': 2, + 'ajax_request': true, + 'id_bookmark': $message.attr('bookmarkid') + }, + function () { + ConsoleBookmarks.refresh(); + }); + } + }); + $targetMessage.find('.action.profiling').on('click', function () { + var $message = $(this).closest('.message'); + Console.execute($(this).parent().siblings('.query').text(), + { db: $message.attr('targetdb'), + table: $message.attr('targettable'), + profiling: true }); + }); + $targetMessage.find('.action.explain').on('click', function () { + var $message = $(this).closest('.message'); + Console.execute('EXPLAIN ' + $(this).parent().siblings('.query').text(), + { db: $message.attr('targetdb'), + table: $message.attr('targettable') }); + }); + $targetMessage.find('.action.dbg_show_trace').on('click', function () { + var $message = $(this).closest('.message'); + if (!$message.find('.trace').length) { + ConsoleDebug.getQueryDetails( + $message.data('queryInfo'), + $message.data('totalTime'), + $message + ); + ConsoleMessages.messageEventBinds($message.find('.message:not(.binded)')); + } + $message.addClass('show_trace'); + $message.removeClass('hide_trace'); + }); + $targetMessage.find('.action.dbg_hide_trace').on('click', function () { + var $message = $(this).closest('.message'); + $message.addClass('hide_trace'); + $message.removeClass('show_trace'); + }); + $targetMessage.find('.action.dbg_show_args').on('click', function () { + var $message = $(this).closest('.message'); + $message.addClass('show_args expanded'); + $message.removeClass('hide_args collapsed'); + }); + $targetMessage.find('.action.dbg_hide_args').on('click', function () { + var $message = $(this).closest('.message'); + $message.addClass('hide_args collapsed'); + $message.removeClass('show_args expanded'); + }); + if (ConsoleInput.codeMirror) { + $targetMessage.find('.query:not(.highlighted)').each(function (index, elem) { + CodeMirror.runMode($(elem).text(), + 'text/x-sql', elem); + $(this).addClass('highlighted'); + }); + } + }, + msgAppend: function (msgId, msgString) { + var $targetMessage = $('#pma_console').find('.content .console_message_container .message[msgid=' + msgId + ']'); + if ($targetMessage.length === 0 || isNaN(parseInt(msgId)) || typeof(msgString) !== 'string') { + return false; + } + $targetMessage.append('<div>' + msgString + '</div>'); + }, + updateQuery: function (msgId, isSuccessed, queryData) { + var $targetMessage = $('#pma_console').find('.console_message_container .message[msgid=' + parseInt(msgId) + ']'); + if ($targetMessage.length === 0 || isNaN(parseInt(msgId))) { + return false; + } + $targetMessage.removeClass('pending failed successed'); + if (isSuccessed) { + $targetMessage.addClass('successed'); + if (queryData) { + $targetMessage.children('.query').text(''); + $targetMessage.removeClass('select'); + if (Console.isSelect(queryData.sql_query)) { + $targetMessage.addClass('select'); + } + if (ConsoleInput.codeMirror) { + CodeMirror.runMode(queryData.sql_query, 'text/x-sql', $targetMessage.children('.query')[0]); + } else { + $targetMessage.children('.query').text(queryData.sql_query); + } + $targetMessage.attr('targetdb', queryData.db); + $targetMessage.attr('targettable', queryData.table); + $targetMessage.find('.text.targetdb span').text(queryData.db); + } + } else { + $targetMessage.addClass('failed'); + } + }, + /** + * Used for console messages initialize + * + * @return void + */ + initialize: function () { + ConsoleMessages.messageEventBinds($('#pma_console').find('.message:not(.binded)')); + if (Console.config.StartHistory) { + ConsoleMessages.showHistory(); + } + ConsoleMessages.showInstructions(Console.config.EnterExecutes); + } +}; + +/** + * Console bookmarks card, and bookmarks items management object + */ +var ConsoleBookmarks = { + bookmarks: [], + addBookmark: function (queryString, targetDb, label, isShared) { + $('#pma_bookmarks').find('.add [name=shared]').prop('checked', false); + $('#pma_bookmarks').find('.add [name=label]').val(''); + $('#pma_bookmarks').find('.add [name=targetdb]').val(''); + $('#pma_bookmarks').find('.add [name=id_bookmark]').val(''); + ConsoleInput.setText('', 'bookmark'); + + if (typeof queryString !== 'undefined') { + ConsoleInput.setText(queryString, 'bookmark'); + } + if (typeof targetDb !== 'undefined') { + $('#pma_bookmarks').find('.add [name=targetdb]').val(targetDb); + } + if (typeof label !== 'undefined') { + $('#pma_bookmarks').find('.add [name=label]').val(label); + } + if (typeof isShared !== 'undefined') { + $('#pma_bookmarks').find('.add [name=shared]').prop('checked', isShared); + } + }, + refresh: function () { + $.get('import.php', + { + 'ajax_request': true, + 'server': CommonParams.get('server'), + 'console_bookmark_refresh': 'refresh' + }, + function (data) { + if (data.console_message_bookmark) { + $('#pma_bookmarks').find('.content.bookmark').html(data.console_message_bookmark); + ConsoleMessages.messageEventBinds($('#pma_bookmarks').find('.message:not(.binded)')); + } + }); + }, + /** + * Used for console bookmarks initialize + * message events are already binded by ConsoleMsg.messageEventBinds + * + * @return void + */ + initialize: function () { + if ($('#pma_bookmarks').length === 0) { + return; + } + $('#pma_console').find('.button.bookmarks').on('click', function () { + Console.showCard('#pma_bookmarks'); + }); + $('#pma_bookmarks').find('.button.add').on('click', function () { + Console.showCard('#pma_bookmarks .card.add'); + }); + $('#pma_bookmarks').find('.card.add [name=submit]').on('click', function () { + if ($('#pma_bookmarks').find('.card.add [name=label]').val().length === 0 + || ConsoleInput.getText('bookmark').length === 0) { + alert(Messages.strFormEmpty); + return; + } + $(this).prop('disabled', true); + $.post('import.php', + { + 'ajax_request': true, + 'console_bookmark_add': 'true', + 'label': $('#pma_bookmarks').find('.card.add [name=label]').val(), + 'server': CommonParams.get('server'), + 'db': $('#pma_bookmarks').find('.card.add [name=targetdb]').val(), + 'bookmark_query': ConsoleInput.getText('bookmark'), + 'shared': $('#pma_bookmarks').find('.card.add [name=shared]').prop('checked') + }, + function () { + ConsoleBookmarks.refresh(); + $('#pma_bookmarks').find('.card.add [name=submit]').prop('disabled', false); + Console.hideCard($('#pma_bookmarks').find('.card.add')); + }); + }); + $('#pma_console').find('.button.refresh').on('click', function () { + ConsoleBookmarks.refresh(); + }); + } +}; + +var ConsoleDebug = { + config: { + groupQueries: false, + orderBy: 'exec', // Possible 'exec' => Execution order, 'time' => Time taken, 'count' + order: 'asc' // Possible 'asc', 'desc' + }, + lastDebugInfo: { + debugInfo: null, + url: null + }, + initialize: function () { + // Try to get debug info after every AJAX request + $(document).ajaxSuccess(function (event, xhr, settings, data) { + if (data.debug) { + ConsoleDebug.showLog(data.debug, settings.url); + } + }); + + if (Console.config.GroupQueries) { + $('#debug_console').addClass('grouped'); + } else { + $('#debug_console').addClass('ungrouped'); + if (Console.config.OrderBy === 'count') { + $('#debug_console').find('.button.order_by.sort_exec').addClass('active'); + } + } + var orderBy = Console.config.OrderBy; + var order = Console.config.Order; + $('#debug_console').find('.button.order_by.sort_' + orderBy).addClass('active'); + $('#debug_console').find('.button.order.order_' + order).addClass('active'); + + // Initialize actions in toolbar + $('#debug_console').find('.button.group_queries').on('click', function () { + $('#debug_console').addClass('grouped'); + $('#debug_console').removeClass('ungrouped'); + Console.setConfig('GroupQueries', true); + ConsoleDebug.refresh(); + if (Console.config.OrderBy === 'count') { + $('#debug_console').find('.button.order_by.sort_exec').removeClass('active'); + } + }); + $('#debug_console').find('.button.ungroup_queries').on('click', function () { + $('#debug_console').addClass('ungrouped'); + $('#debug_console').removeClass('grouped'); + Console.setConfig('GroupQueries', false); + ConsoleDebug.refresh(); + if (Console.config.OrderBy === 'count') { + $('#debug_console').find('.button.order_by.sort_exec').addClass('active'); + } + }); + $('#debug_console').find('.button.order_by').on('click', function () { + var $this = $(this); + $('#debug_console').find('.button.order_by').removeClass('active'); + $this.addClass('active'); + if ($this.hasClass('sort_time')) { + Console.setConfig('OrderBy', 'time'); + } else if ($this.hasClass('sort_exec')) { + Console.setConfig('OrderBy', 'exec'); + } else if ($this.hasClass('sort_count')) { + Console.setConfig('OrderBy', 'count'); + } + ConsoleDebug.refresh(); + }); + $('#debug_console').find('.button.order').on('click', function () { + var $this = $(this); + $('#debug_console').find('.button.order').removeClass('active'); + $this.addClass('active'); + if ($this.hasClass('order_asc')) { + Console.setConfig('Order', 'asc'); + } else if ($this.hasClass('order_desc')) { + Console.setConfig('Order', 'desc'); + } + ConsoleDebug.refresh(); + }); + + // Show SQL debug info for first page load + if (typeof debugSQLInfo !== 'undefined' && debugSQLInfo !== 'null') { + $('#pma_console').find('.button.debug').removeClass('hide'); + } else { + return; + } + ConsoleDebug.showLog(debugSQLInfo); + }, + formatFunctionCall: function (dbgStep) { + var functionName = ''; + if ('class' in dbgStep) { + functionName += dbgStep.class; + functionName += dbgStep.type; + } + functionName += dbgStep.function; + if (dbgStep.args && dbgStep.args.length) { + functionName += '(...)'; + } else { + functionName += '()'; + } + return functionName; + }, + formatFunctionArgs: function (dbgStep) { + var $args = $('<div>'); + if (dbgStep.args.length) { + $args.append('<div class="message welcome">') + .append( + $('<div class="message welcome">') + .text( + Functions.sprintf( + Messages.strConsoleDebugArgsSummary, + dbgStep.args.length + ) + ) + ); + for (var i = 0; i < dbgStep.args.length; i++) { + $args.append( + $('<div class="message">') + .html( + '<pre>' + + Functions.escapeHtml(JSON.stringify(dbgStep.args[i], null, ' ')) + + '</pre>' + ) + ); + } + } + return $args; + }, + formatFileName: function (dbgStep) { + var fileName = ''; + if ('file' in dbgStep) { + fileName += dbgStep.file; + fileName += '#' + dbgStep.line; + } + return fileName; + }, + formatBackTrace: function (dbgTrace) { + var $traceElem = $('<div class="trace">'); + $traceElem.append( + $('<div class="message welcome">') + ); + var step; + var $stepElem; + for (var stepId in dbgTrace) { + if (dbgTrace.hasOwnProperty(stepId)) { + step = dbgTrace[stepId]; + if (!Array.isArray(step) && typeof step !== 'object') { + $stepElem = + $('<div class="message traceStep collapsed hide_args">') + .append( + $('<span>').text(step) + ); + } else { + if (typeof step.args === 'string' && step.args) { + step.args = [step.args]; + } + $stepElem = + $('<div class="message traceStep collapsed hide_args">') + .append( + $('<span class="function">').text(this.formatFunctionCall(step)) + ) + .append( + $('<span class="file">').text(this.formatFileName(step)) + ); + if (step.args && step.args.length) { + $stepElem + .append( + $('<span class="args">').html(this.formatFunctionArgs(step)) + ) + .prepend( + $('<div class="action_content">') + .append( + '<span class="action dbg_show_args">' + + Messages.strConsoleDebugShowArgs + + '</span> ' + ) + .append( + '<span class="action dbg_hide_args">' + + Messages.strConsoleDebugHideArgs + + '</span> ' + ) + ); + } + } + $traceElem.append($stepElem); + } + } + return $traceElem; + }, + formatQueryOrGroup: function (queryInfo, totalTime) { + var grouped; + var queryText; + var queryTime; + var count; + var i; + if (Array.isArray(queryInfo)) { + // It is grouped + grouped = true; + + queryText = queryInfo[0].query; + + queryTime = 0; + for (i in queryInfo) { + queryTime += queryInfo[i].time; + } + + count = queryInfo.length; + } else { + queryText = queryInfo.query; + queryTime = queryInfo.time; + } + + var $query = $('<div class="message collapsed hide_trace">') + .append( + $('#debug_console').find('.templates .debug_query').clone() + ) + .append( + $('<div class="query">') + .text(queryText) + ) + .data('queryInfo', queryInfo) + .data('totalTime', totalTime); + if (grouped) { + $query.find('.text.count').removeClass('hide'); + $query.find('.text.count span').text(count); + } + $query.find('.text.time span').text(queryTime + 's (' + ((queryTime * 100) / totalTime).toFixed(3) + '%)'); + + return $query; + }, + appendQueryExtraInfo: function (query, $elem) { + if ('error' in query) { + $elem.append( + $('<div>').html(query.error) + ); + } + $elem.append(this.formatBackTrace(query.trace)); + }, + getQueryDetails: function (queryInfo, totalTime, $query) { + if (Array.isArray(queryInfo)) { + var $singleQuery; + for (var i in queryInfo) { + $singleQuery = $('<div class="message welcome trace">') + .text((parseInt(i) + 1) + '.') + .append( + $('<span class="time">').text( + Messages.strConsoleDebugTimeTaken + + ' ' + queryInfo[i].time + 's' + + ' (' + ((queryInfo[i].time * 100) / totalTime).toFixed(3) + '%)' + ) + ); + this.appendQueryExtraInfo(queryInfo[i], $singleQuery); + $query + .append('<div class="message welcome trace">') + .append($singleQuery); + } + } else { + this.appendQueryExtraInfo(queryInfo, $query); + } + }, + showLog: function (debugInfo, url) { + this.lastDebugInfo.debugInfo = debugInfo; + this.lastDebugInfo.url = url; + + $('#debug_console').find('.debugLog').empty(); + $('#debug_console').find('.debug>.welcome').empty(); + + var debugJson = false; + var i; + if (typeof debugInfo === 'object' && 'queries' in debugInfo) { + // Copy it to debugJson, so that it doesn't get changed + if (!('queries' in debugInfo)) { + debugJson = false; + } else { + debugJson = { queries: [] }; + for (i in debugInfo.queries) { + debugJson.queries[i] = debugInfo.queries[i]; + } + } + } else if (typeof debugInfo === 'string') { + try { + debugJson = JSON.parse(debugInfo); + } catch (e) { + debugJson = false; + } + if (debugJson && !('queries' in debugJson)) { + debugJson = false; + } + } + if (debugJson === false) { + $('#debug_console').find('.debug>.welcome').text( + Messages.strConsoleDebugError + ); + return; + } + var allQueries = debugJson.queries; + var uniqueQueries = {}; + + var totalExec = allQueries.length; + + // Calculate total time and make unique query array + var totalTime = 0; + for (i = 0; i < totalExec; ++i) { + totalTime += allQueries[i].time; + if (!(allQueries[i].hash in uniqueQueries)) { + uniqueQueries[allQueries[i].hash] = []; + } + uniqueQueries[allQueries[i].hash].push(allQueries[i]); + } + // Count total unique queries, convert uniqueQueries to Array + var totalUnique = 0; + var uniqueArray = []; + for (var hash in uniqueQueries) { + if (uniqueQueries.hasOwnProperty(hash)) { + ++totalUnique; + uniqueArray.push(uniqueQueries[hash]); + } + } + uniqueQueries = uniqueArray; + // Show summary + $('#debug_console').find('.debug>.welcome').append( + $('<span class="debug_summary">').text( + Functions.sprintf( + Messages.strConsoleDebugSummary, + totalUnique, + totalExec, + totalTime + ) + ) + ); + if (url) { + $('#debug_console').find('.debug>.welcome').append( + $('<span class="script_name">').text(url.split('?')[0]) + ); + } + + // For sorting queries + function sortByTime (a, b) { + var order = ((Console.config.Order === 'asc') ? 1 : -1); + if (Array.isArray(a) && Array.isArray(b)) { + // It is grouped + var timeA = 0; + var timeB = 0; + var i; + for (i in a) { + timeA += a[i].time; + } + for (i in b) { + timeB += b[i].time; + } + return (timeA - timeB) * order; + } else { + return (a.time - b.time) * order; + } + } + + function sortByCount (a, b) { + var order = ((Console.config.Oorder === 'asc') ? 1 : -1); + return (a.length - b.length) * order; + } + + var orderBy = Console.config.OrderBy; + var order = Console.config.Order; + + if (Console.config.GroupQueries) { + // Sort queries + if (orderBy === 'time') { + uniqueQueries.sort(sortByTime); + } else if (orderBy === 'count') { + uniqueQueries.sort(sortByCount); + } else if (orderBy === 'exec' && order === 'desc') { + uniqueQueries.reverse(); + } + for (i in uniqueQueries) { + if (orderBy === 'time') { + uniqueQueries[i].sort(sortByTime); + } else if (orderBy === 'exec' && order === 'desc') { + uniqueQueries[i].reverse(); + } + $('#debug_console').find('.debugLog').append(this.formatQueryOrGroup(uniqueQueries[i], totalTime)); + } + } else { + if (orderBy === 'time') { + allQueries.sort(sortByTime); + } else if (order === 'desc') { + allQueries.reverse(); + } + for (i = 0; i < totalExec; ++i) { + $('#debug_console').find('.debugLog').append(this.formatQueryOrGroup(allQueries[i], totalTime)); + } + } + + ConsoleMessages.messageEventBinds($('#debug_console').find('.message:not(.binded)')); + }, + refresh: function () { + var last = this.lastDebugInfo; + ConsoleDebug.showLog(last.debugInfo, last.url); + } +}; + +/** s + * Executed on page load + */ +$(function () { + Console.initialize(); +}); |
