Merge pull request #19240 from MauricioFauth/Functions.sqlPrettyPrint-removal

MauricioFauth · web-flow · commit f12b453ef358 · 2024-07-27T15:22:18.000-03:00
Remove Functions.sqlPrettyPrint() function
diff --git a/resources/js/src/modules/functions.ts b/resources/js/src/modules/functions.ts
@@ -1614,155 +1614,6 @@ function prettyProfilingNum (number, accuracy) {
     return num + 's';
 }
 
-/**
- * Formats a SQL Query nicely with newlines and indentation. Depends on Codemirror and MySQL Mode!
- *
- * @param {string} string Query to be formatted
- * @return {string}      The formatted query
- */
-function sqlPrettyPrint (string) {
-    if (typeof window.CodeMirror === 'undefined') {
-        return string;
-    }
-
-    var mode = window.CodeMirror.getMode({}, 'text/x-mysql');
-    var stream = new window.CodeMirror.StringStream(string);
-    var state = mode.startState();
-    var token;
-    var tokens = [];
-    var output = '';
-    var tabs = function (cnt) {
-        var ret = '';
-        for (var i = 0; i < 4 * cnt; i++) {
-            ret += ' ';
-        }
-
-        return ret;
-    };
-
-    // "root-level" statements
-    var statements = {
-        'select': ['select', 'from', 'on', 'where', 'having', 'limit', 'order by', 'group by'],
-        'update': ['update', 'set', 'where'],
-        'insert into': ['insert into', 'values']
-    };
-    // don't put spaces before these tokens
-    var spaceExceptionsBefore = { ';': true, ',': true, '.': true, '(': true };
-    // don't put spaces after these tokens
-    var spaceExceptionsAfter = { '.': true };
-
-    // Populate tokens array
-    while (! stream.eol()) {
-        stream.start = stream.pos;
-        token = mode.token(stream, state);
-        if (token !== null) {
-            tokens.push([token, stream.current().toLowerCase()]);
-        }
-    }
-
-    var currentStatement = tokens[0][1];
-
-    if (! statements[currentStatement]) {
-        return string;
-    }
-
-    // Holds all currently opened code blocks (statement, function or generic)
-    var blockStack = [];
-    // If a new code block is found, newBlock contains its type for one iteration and vice versa for endBlock
-    var newBlock;
-    var endBlock;
-    // How much to indent in the current line
-    var indentLevel = 0;
-    // Holds the "root-level" statements
-    var statementPart;
-    var lastStatementPart = statements[currentStatement][0];
-
-    blockStack.unshift('statement');
-
-    // Iterate through every token and format accordingly
-    for (var i = 0; i < tokens.length; i++) {
-        // New block => push to stack
-        if (tokens[i][1] === '(') {
-            if (i < tokens.length - 1 && tokens[i + 1][0] === 'statement-verb') {
-                blockStack.unshift(newBlock = 'statement');
-            } else if (i > 0 && tokens[i - 1][0] === 'builtin') {
-                blockStack.unshift(newBlock = 'function');
-            } else {
-                blockStack.unshift(newBlock = 'generic');
-            }
-        } else {
-            newBlock = null;
-        }
-
-        // Block end => pop from stack
-        if (tokens[i][1] === ')') {
-            endBlock = blockStack[0];
-            blockStack.shift();
-        } else {
-            endBlock = null;
-        }
-
-        // A subquery is starting
-        if (i > 0 && newBlock === 'statement') {
-            indentLevel++;
-            output += '\n' + tabs(indentLevel) + tokens[i][1] + ' ' + tokens[i + 1][1].toUpperCase() + '\n' + tabs(indentLevel + 1);
-            currentStatement = tokens[i + 1][1];
-            i++;
-            continue;
-        }
-
-        // A subquery is ending
-        if (endBlock === 'statement' && indentLevel > 0) {
-            output += '\n' + tabs(indentLevel);
-            indentLevel--;
-        }
-
-        // One less indentation for statement parts (from, where, order by, etc.) and a newline
-        statementPart = statements[currentStatement].indexOf(tokens[i][1]);
-        if (statementPart !== -1) {
-            if (i > 0) {
-                output += '\n';
-            }
-
-            output += tabs(indentLevel) + tokens[i][1].toUpperCase();
-            output += '\n' + tabs(indentLevel + 1);
-            lastStatementPart = tokens[i][1];
-            // Normal indentation and spaces for everything else
-        } else {
-            if (! spaceExceptionsBefore[tokens[i][1]] &&
-                ! (i > 0 && spaceExceptionsAfter[tokens[i - 1][1]]) &&
-                output.charAt(output.length - 1) !== ' ') {
-                output += ' ';
-            }
-
-            if (tokens[i][0] === 'keyword') {
-                output += tokens[i][1].toUpperCase();
-            } else {
-                output += tokens[i][1];
-            }
-        }
-
-        // split columns in select and 'update set' clauses, but only inside statements blocks
-        if ((lastStatementPart === 'select' || lastStatementPart === 'where' || lastStatementPart === 'set') &&
-            tokens[i][1] === ',' && blockStack[0] === 'statement') {
-            output += '\n' + tabs(indentLevel + 1);
-        }
-
-        // split conditions in where clauses, but only inside statements blocks
-        if (lastStatementPart === 'where' &&
-            (tokens[i][1] === 'and' || tokens[i][1] === 'or' || tokens[i][1] === 'xor')) {
-            if (blockStack[0] === 'statement') {
-                output += '\n' + tabs(indentLevel + 1);
-            }
-            // Todo: Also split and or blocks in newlines & indentation++
-            // if (blockStack[0] === 'generic')
-            //   output += ...
-        }
-    }
-
-    return output;
-}
-
 function createFunctionConfirmModal (): void {
     if ($('#functionConfirmModal').length > 0) {
         return;
@@ -3843,7 +3694,6 @@ const Functions = {
     showNoticeForEnum: showNoticeForEnum,
     showWarningForIntTypes: showWarningForIntTypes,
     prettyProfilingNum: prettyProfilingNum,
-    sqlPrettyPrint: sqlPrettyPrint,
     confirm: confirmDialog,
     sortTable: sortTable,
     teardownCreateTableEvents: teardownCreateTableEvents,
diff --git a/resources/js/src/server/status/monitor.ts b/resources/js/src/server/status/monitor.ts
@@ -2170,8 +2170,6 @@ AJAX.registerOnload('server/status/monitor.js', function () {
         var query = rowData.argument || rowData.sql_text;
 
         if (window.codeMirrorEditor) {
-            // TODO: somehow Functions.sqlPrettyPrint messes up the query, needs be fixed
-            // query = Functions.sqlPrettyPrint(query);
             window.codeMirrorEditor.setValue(query);
             // Codemirror is bugged, it doesn't refresh properly sometimes.
             // Following lines seem to fix that
