initial commit; version 22.5.12042
This commit is contained in:
423
libs/Doctrine/SqlFormatter/SqlFormatter.php
Normal file
423
libs/Doctrine/SqlFormatter/SqlFormatter.php
Normal file
@ -0,0 +1,423 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* SQL Formatter is a collection of utilities for debugging SQL queries.
|
||||
* It includes methods for formatting, syntax highlighting, removing comments, etc.
|
||||
*
|
||||
* @link http://github.com/jdorn/sql-formatter
|
||||
*/
|
||||
|
||||
namespace Doctrine\SqlFormatter;
|
||||
|
||||
use function array_search;
|
||||
use function array_shift;
|
||||
use function array_unshift;
|
||||
use function assert;
|
||||
use function current;
|
||||
use function preg_replace;
|
||||
use function reset;
|
||||
use function rtrim;
|
||||
use function str_repeat;
|
||||
use function str_replace;
|
||||
use function strlen;
|
||||
use function trim;
|
||||
use const PHP_SAPI;
|
||||
|
||||
final class SqlFormatter
|
||||
{
|
||||
/** @var Highlighter */
|
||||
private $highlighter;
|
||||
|
||||
/** @var Tokenizer */
|
||||
private $tokenizer;
|
||||
|
||||
public function __construct(Highlighter $highlighter = null)
|
||||
{
|
||||
$this->tokenizer = new Tokenizer();
|
||||
$this->highlighter = $highlighter ?? (PHP_SAPI === 'cli' ? new CliHighlighter() : new HtmlHighlighter());
|
||||
}
|
||||
|
||||
/**
|
||||
* Format the whitespace in a SQL string to make it easier to read.
|
||||
*
|
||||
* @param string $string The SQL string
|
||||
*
|
||||
* @return string The SQL string with HTML styles and formatting wrapped in a <pre> tag
|
||||
*/
|
||||
public function format(string $string, string $indentString = ' ') : string
|
||||
{
|
||||
// This variable will be populated with formatted html
|
||||
$return = '';
|
||||
|
||||
// Use an actual tab while formatting and then switch out with $indentString at the end
|
||||
$tab = "\t";
|
||||
|
||||
$indentLevel = 0;
|
||||
$newline = false;
|
||||
$inlineParentheses = false;
|
||||
$increaseSpecialIndent = false;
|
||||
$increaseBlockIndent = false;
|
||||
$indentTypes = [];
|
||||
$addedNewline = false;
|
||||
$inlineCount = 0;
|
||||
$inlineIndented = false;
|
||||
$clauseLimit = false;
|
||||
|
||||
// Tokenize String
|
||||
$cursor = $this->tokenizer->tokenize($string);
|
||||
|
||||
// Format token by token
|
||||
while ($token = $cursor->next(Token::TOKEN_TYPE_WHITESPACE)) {
|
||||
$highlighted = $this->highlighter->highlightToken(
|
||||
$token->type(),
|
||||
$token->value()
|
||||
);
|
||||
|
||||
// If we are increasing the special indent level now
|
||||
if ($increaseSpecialIndent) {
|
||||
$indentLevel++;
|
||||
$increaseSpecialIndent = false;
|
||||
array_unshift($indentTypes, 'special');
|
||||
}
|
||||
|
||||
// If we are increasing the block indent level now
|
||||
if ($increaseBlockIndent) {
|
||||
$indentLevel++;
|
||||
$increaseBlockIndent = false;
|
||||
array_unshift($indentTypes, 'block');
|
||||
}
|
||||
|
||||
// If we need a new line before the token
|
||||
if ($newline) {
|
||||
$return = rtrim($return, ' ');
|
||||
$return .= "\n" . str_repeat($tab, $indentLevel);
|
||||
$newline = false;
|
||||
$addedNewline = true;
|
||||
} else {
|
||||
$addedNewline = false;
|
||||
}
|
||||
|
||||
// Display comments directly where they appear in the source
|
||||
if ($token->isOfType(Token::TOKEN_TYPE_COMMENT, Token::TOKEN_TYPE_BLOCK_COMMENT)) {
|
||||
if ($token->isOfType(Token::TOKEN_TYPE_BLOCK_COMMENT)) {
|
||||
$indent = str_repeat($tab, $indentLevel);
|
||||
$return = rtrim($return, " \t");
|
||||
$return .= "\n" . $indent;
|
||||
$highlighted = str_replace("\n", "\n" . $indent, $highlighted);
|
||||
}
|
||||
|
||||
$return .= $highlighted;
|
||||
$newline = true;
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($inlineParentheses) {
|
||||
// End of inline parentheses
|
||||
if ($token->value() === ')') {
|
||||
$return = rtrim($return, ' ');
|
||||
|
||||
if ($inlineIndented) {
|
||||
array_shift($indentTypes);
|
||||
$indentLevel--;
|
||||
$return = rtrim($return, ' ');
|
||||
$return .= "\n" . str_repeat($tab, $indentLevel);
|
||||
}
|
||||
|
||||
$inlineParentheses = false;
|
||||
|
||||
$return .= $highlighted . ' ';
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($token->value() === ',') {
|
||||
if ($inlineCount >= 30) {
|
||||
$inlineCount = 0;
|
||||
$newline = true;
|
||||
}
|
||||
}
|
||||
|
||||
$inlineCount += strlen($token->value());
|
||||
}
|
||||
|
||||
// Opening parentheses increase the block indent level and start a new line
|
||||
if ($token->value() === '(') {
|
||||
// First check if this should be an inline parentheses block
|
||||
// Examples are "NOW()", "COUNT(*)", "int(10)", key(`somecolumn`), DECIMAL(7,2)
|
||||
// Allow up to 3 non-whitespace tokens inside inline parentheses
|
||||
$length = 0;
|
||||
$subCursor = $cursor->subCursor();
|
||||
for ($j=1; $j<=250; $j++) {
|
||||
// Reached end of string
|
||||
$next = $subCursor->next(Token::TOKEN_TYPE_WHITESPACE);
|
||||
if (! $next) {
|
||||
break;
|
||||
}
|
||||
|
||||
// Reached closing parentheses, able to inline it
|
||||
if ($next->value() === ')') {
|
||||
$inlineParentheses = true;
|
||||
$inlineCount = 0;
|
||||
$inlineIndented = false;
|
||||
break;
|
||||
}
|
||||
|
||||
// Reached an invalid token for inline parentheses
|
||||
if ($next->value()===';' || $next->value()==='(') {
|
||||
break;
|
||||
}
|
||||
|
||||
// Reached an invalid token type for inline parentheses
|
||||
if ($next->isOfType(
|
||||
Token::TOKEN_TYPE_RESERVED_TOPLEVEL,
|
||||
Token::TOKEN_TYPE_RESERVED_NEWLINE,
|
||||
Token::TOKEN_TYPE_COMMENT,
|
||||
Token::TOKEN_TYPE_BLOCK_COMMENT
|
||||
)) {
|
||||
break;
|
||||
}
|
||||
|
||||
$length += strlen($next->value());
|
||||
}
|
||||
|
||||
if ($inlineParentheses && $length > 30) {
|
||||
$increaseBlockIndent = true;
|
||||
$inlineIndented = true;
|
||||
$newline = true;
|
||||
}
|
||||
|
||||
// Take out the preceding space unless there was whitespace there in the original query
|
||||
$prevToken = $cursor->subCursor()->previous();
|
||||
if ($prevToken && ! $prevToken->isOfType(Token::TOKEN_TYPE_WHITESPACE)) {
|
||||
$return = rtrim($return, ' ');
|
||||
}
|
||||
|
||||
if (! $inlineParentheses) {
|
||||
$increaseBlockIndent = true;
|
||||
// Add a newline after the parentheses
|
||||
$newline = true;
|
||||
}
|
||||
} elseif ($token->value() === ')') {
|
||||
// Closing parentheses decrease the block indent level
|
||||
// Remove whitespace before the closing parentheses
|
||||
$return = rtrim($return, ' ');
|
||||
|
||||
$indentLevel--;
|
||||
|
||||
// Reset indent level
|
||||
while ($j=array_shift($indentTypes)) {
|
||||
if ($j!=='special') {
|
||||
break;
|
||||
}
|
||||
|
||||
$indentLevel--;
|
||||
}
|
||||
|
||||
if ($indentLevel < 0) {
|
||||
// This is an error
|
||||
$indentLevel = 0;
|
||||
|
||||
$return .= $this->highlighter->highlightError($token->value());
|
||||
continue;
|
||||
}
|
||||
|
||||
// Add a newline before the closing parentheses (if not already added)
|
||||
if (! $addedNewline) {
|
||||
$return .= "\n" . str_repeat($tab, $indentLevel);
|
||||
}
|
||||
} elseif ($token->isOfType(Token::TOKEN_TYPE_RESERVED_TOPLEVEL)) {
|
||||
// Top level reserved words start a new line and increase the special indent level
|
||||
$increaseSpecialIndent = true;
|
||||
|
||||
// If the last indent type was 'special', decrease the special indent for this round
|
||||
reset($indentTypes);
|
||||
if (current($indentTypes)==='special') {
|
||||
$indentLevel--;
|
||||
array_shift($indentTypes);
|
||||
}
|
||||
|
||||
// Add a newline after the top level reserved word
|
||||
$newline = true;
|
||||
// Add a newline before the top level reserved word (if not already added)
|
||||
if (! $addedNewline) {
|
||||
$return = rtrim($return, ' ');
|
||||
$return .= "\n" . str_repeat($tab, $indentLevel);
|
||||
} else {
|
||||
// If we already added a newline, redo the indentation since it may be different now
|
||||
$return = rtrim($return, $tab) . str_repeat($tab, $indentLevel);
|
||||
}
|
||||
|
||||
if ($token->hasExtraWhitespace()) {
|
||||
$highlighted = preg_replace('/\s+/', ' ', $highlighted);
|
||||
}
|
||||
|
||||
//if SQL 'LIMIT' clause, start variable to reset newline
|
||||
if ($token->value() === 'LIMIT' && ! $inlineParentheses) {
|
||||
$clauseLimit = true;
|
||||
}
|
||||
} elseif ($clauseLimit &&
|
||||
$token->value() !== ',' &&
|
||||
! $token->isOfType(Token::TOKEN_TYPE_NUMBER, Token::TOKEN_TYPE_WHITESPACE)) {
|
||||
// Checks if we are out of the limit clause
|
||||
$clauseLimit = false;
|
||||
} elseif ($token->value() === ',' && ! $inlineParentheses) {
|
||||
// Commas start a new line (unless within inline parentheses or SQL 'LIMIT' clause)
|
||||
//If the previous TOKEN_VALUE is 'LIMIT', resets new line
|
||||
if ($clauseLimit === true) {
|
||||
$newline = false;
|
||||
$clauseLimit = false;
|
||||
} else {
|
||||
// All other cases of commas
|
||||
$newline = true;
|
||||
}
|
||||
} elseif ($token->isOfType(Token::TOKEN_TYPE_RESERVED_NEWLINE)) {
|
||||
// Newline reserved words start a new line
|
||||
// Add a newline before the reserved word (if not already added)
|
||||
if (! $addedNewline) {
|
||||
$return = rtrim($return, ' ');
|
||||
$return .= "\n" . str_repeat($tab, $indentLevel);
|
||||
}
|
||||
|
||||
if ($token->hasExtraWhitespace()) {
|
||||
$highlighted = preg_replace('/\s+/', ' ', $highlighted);
|
||||
}
|
||||
} elseif ($token->isOfType(Token::TOKEN_TYPE_BOUNDARY)) {
|
||||
// Multiple boundary characters in a row should not have spaces between them (not including parentheses)
|
||||
$prevNotWhitespaceToken = $cursor->subCursor()->previous(Token::TOKEN_TYPE_WHITESPACE);
|
||||
if ($prevNotWhitespaceToken && $prevNotWhitespaceToken->isOfType(Token::TOKEN_TYPE_BOUNDARY)) {
|
||||
$prevToken = $cursor->subCursor()->previous();
|
||||
if ($prevToken && ! $prevToken->isOfType(Token::TOKEN_TYPE_WHITESPACE)) {
|
||||
$return = rtrim($return, ' ');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If the token shouldn't have a space before it
|
||||
if ($token->value() === '.' ||
|
||||
$token->value() === ',' ||
|
||||
$token->value() === ';') {
|
||||
$return = rtrim($return, ' ');
|
||||
}
|
||||
|
||||
$return .= $highlighted . ' ';
|
||||
|
||||
// If the token shouldn't have a space after it
|
||||
if ($token->value() === '(' || $token->value() === '.') {
|
||||
$return = rtrim($return, ' ');
|
||||
}
|
||||
|
||||
// If this is the "-" of a negative number, it shouldn't have a space after it
|
||||
if ($token->value() !== '-') {
|
||||
continue;
|
||||
}
|
||||
|
||||
$nextNotWhitespace = $cursor->subCursor()->next(Token::TOKEN_TYPE_WHITESPACE);
|
||||
if (! $nextNotWhitespace || ! $nextNotWhitespace->isOfType(Token::TOKEN_TYPE_NUMBER)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$prev = $cursor->subCursor()->previous(Token::TOKEN_TYPE_WHITESPACE);
|
||||
if (! $prev) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($prev->isOfType(
|
||||
Token::TOKEN_TYPE_QUOTE,
|
||||
Token::TOKEN_TYPE_BACKTICK_QUOTE,
|
||||
Token::TOKEN_TYPE_WORD,
|
||||
Token::TOKEN_TYPE_NUMBER
|
||||
)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$return = rtrim($return, ' ');
|
||||
}
|
||||
|
||||
// If there are unmatched parentheses
|
||||
if (array_search('block', $indentTypes) !== false) {
|
||||
$return = rtrim($return, ' ');
|
||||
$return .= $this->highlighter->highlightErrorMessage(
|
||||
'WARNING: unclosed parentheses or section'
|
||||
);
|
||||
}
|
||||
|
||||
// Replace tab characters with the configuration tab character
|
||||
$return = trim(str_replace("\t", $indentString, $return));
|
||||
|
||||
return $this->highlighter->output($return);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add syntax highlighting to a SQL string
|
||||
*
|
||||
* @param string $string The SQL string
|
||||
*
|
||||
* @return string The SQL string with HTML styles applied
|
||||
*/
|
||||
public function highlight(string $string) : string
|
||||
{
|
||||
$cursor = $this->tokenizer->tokenize($string);
|
||||
|
||||
$return = '';
|
||||
|
||||
while ($token = $cursor->next()) {
|
||||
$return .= $this->highlighter->highlightToken(
|
||||
$token->type(),
|
||||
$token->value()
|
||||
);
|
||||
}
|
||||
|
||||
return $this->highlighter->output($return);
|
||||
}
|
||||
|
||||
/**
|
||||
* Compress a query by collapsing white space and removing comments
|
||||
*
|
||||
* @param string $string The SQL string
|
||||
*
|
||||
* @return string The SQL string without comments
|
||||
*/
|
||||
public function compress(string $string) : string
|
||||
{
|
||||
$result = '';
|
||||
$cursor = $this->tokenizer->tokenize($string);
|
||||
|
||||
$whitespace = true;
|
||||
while ($token = $cursor->next()) {
|
||||
// Skip comment tokens
|
||||
if ($token->isOfType(Token::TOKEN_TYPE_COMMENT, Token::TOKEN_TYPE_BLOCK_COMMENT)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Remove extra whitespace in reserved words (e.g "OUTER JOIN" becomes "OUTER JOIN")
|
||||
|
||||
if ($token->isOfType(
|
||||
Token::TOKEN_TYPE_RESERVED,
|
||||
Token::TOKEN_TYPE_RESERVED_NEWLINE,
|
||||
Token::TOKEN_TYPE_RESERVED_TOPLEVEL
|
||||
)) {
|
||||
$newValue = preg_replace('/\s+/', ' ', $token->value());
|
||||
assert($newValue !== null);
|
||||
$token = $token->withValue($newValue);
|
||||
}
|
||||
|
||||
if ($token->isOfType(Token::TOKEN_TYPE_WHITESPACE)) {
|
||||
// If the last token was whitespace, don't add another one
|
||||
if ($whitespace) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$whitespace = true;
|
||||
// Convert all whitespace to a single space
|
||||
$token = $token->withValue(' ');
|
||||
} else {
|
||||
$whitespace = false;
|
||||
}
|
||||
|
||||
$result .= $token->value();
|
||||
}
|
||||
|
||||
return rtrim($result);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user