' . "\n";
$context = $message->getContext();
$message->isDisplayed(true);
$retval .= '
' . "\n" . ' . "'; $queryBase = htmlspecialchars(addslashes($queryBase)); $queryBase = preg_replace('/((\015\012)|(\015)|(\012))/', $newLine, $queryBase); $queryBase = '
';
return $retval;
}
/**
* Displays a link to the PHP documentation
*
* @param string $target anchor in documentation
*
* @return string the html link
*/
public static function showPHPDocumentation(string $target): string
{
return self::showDocumentationLink(Core::getPHPDocLink($target));
}
/**
* Displays a link to the documentation as an icon
*
* @param string $link documentation link
* @param string $target optional link target
* @param bool $bbcode optional flag indicating whether to output bbcode
* @param bool $disableTabIndex optional flag indicating that a negative tabindex should be set on the link
*
* @return string the html link
*/
public static function showDocumentationLink(
string $link,
string $target = 'documentation',
bool $bbcode = false,
bool $disableTabIndex = false,
): string {
if ($bbcode) {
return '[a@' . $link . '@' . $target . '][dochelpicon][/a]';
}
return ''
. self::getImage('b_help', __('Documentation'))
. '';
}
/**
* Displays a MySQL error message in the main panel when $exit is true.
* Returns the error message otherwise.
*
* @param string $serverMessage Server's error message.
* @param string $sqlQuery The SQL query that failed.
* @param bool $isModifyLink Whether to show a "modify" link or not.
* @param string $backUrl URL for the "back" link (full path is not required).
* @param bool $exit Whether execution should be stopped or the error message should be returned.
*
* @global string $table The current table.
* @global string $db The current database.
*/
public static function mysqlDie(
string $serverMessage = '',
string $sqlQuery = '',
bool $isModifyLink = true,
string $backUrl = '',
bool $exit = true,
): string|null {
/**
* Error message to be built.
*/
$errorMessage = '';
// Checking for any server errors.
if ($serverMessage === '') {
$serverMessage = DatabaseInterface::getInstance()->getError();
}
// Finding the query that failed, if not specified.
if ($sqlQuery === '' && ! empty($GLOBALS['sql_query'])) {
$sqlQuery = $GLOBALS['sql_query'];
}
$sqlQuery = trim($sqlQuery);
/**
* The lexer used for analysis.
*/
$lexer = new Lexer($sqlQuery);
/**
* The parser used for analysis.
*/
$parser = new Parser($lexer->list);
/**
* The errors found by the lexer and the parser.
*/
$errors = ParserError::get(
[$lexer, $parser],
);
if ($sqlQuery === '') {
$formattedSql = '';
} elseif ($errors !== []) {
$formattedSql = htmlspecialchars($sqlQuery);
} else {
$formattedSql = self::formatSql($sqlQuery, true);
}
$errorMessage .= '' . "\n";
$retval .= ' ' . $message->getMessage() . "\n";
$retval .= '
' . "\n";
$queryTooBig = false;
$queryLength = mb_strlen($sqlQuery);
if ($queryLength > $config->settings['MaxCharactersInDisplayedSQL']) {
// when the query is large (for example an INSERT of binary
// data), the parser chokes; so avoid parsing the query
$queryTooBig = true;
$queryBase = mb_substr($sqlQuery, 0, $config->settings['MaxCharactersInDisplayedSQL']) . '[...]';
} else {
$queryBase = $sqlQuery;
}
// Html format the query to be displayed
// If we want to show some sql code it is easiest to create it here
/* SQL-Parser-Analyzer */
if (! empty($GLOBALS['show_as_php'])) {
$newLine = '\\n"' . "\n" . ' . "'; $queryBase = htmlspecialchars(addslashes($queryBase)); $queryBase = preg_replace('/((\015\012)|(\015)|(\012))/', $newLine, $queryBase); $queryBase = '
' . "\n"
. '$sql = "' . $queryBase . '";' . "\n"
. '' . "\n"
. htmlspecialchars($queryBase, ENT_COMPAT) . ''
. self::linkOrButton(
Url::getFromRoute('/import', $explainParams),
null,
__('Explain SQL'),
['class' => 'btn btn-link'],
) . '
' . "\n";
} elseif (preg_match('@^EXPLAIN[[:space:]]+SELECT[[:space:]]+@i', $sqlQuery)) {
$explainParams['sql_query'] = mb_substr($sqlQuery, 8);
$explainLink = ''
. self::linkOrButton(
Url::getFromRoute('/import', $explainParams),
null,
__('Skip Explain SQL'),
['class' => 'btn btn-link'],
) . '
' . "\n";
}
}
$urlParams['sql_query'] = $sqlQuery;
$urlParams['show_query'] = 1;
// even if the query is big and was truncated, offer the chance
// to edit it (unless it's enormous, see linkOrButton() )
if (! empty($config->settings['SQLQuery']['Edit']) && empty($GLOBALS['show_as_php'])) {
$editLink = ''
. self::linkOrButton(
Url::getFromRoute($editLinkRoute, $urlParams),
null,
__('Edit'),
['class' => 'btn btn-link'],
)
. '
' . "\n";
} else {
$editLink = '';
}
// Also we would like to get the SQL formed in some nice
// php-code
if (! empty($config->settings['SQLQuery']['ShowAsPHP']) && ! $queryTooBig) {
if (! empty($GLOBALS['show_as_php'])) {
$phpLink = ''
. self::linkOrButton(
Url::getFromRoute('/import', $urlParams),
null,
__('Without PHP code'),
['class' => 'btn btn-link'],
)
. '
' . "\n";
$phpLink .= ''
. self::linkOrButton(
Url::getFromRoute('/import', $urlParams),
null,
__('Submit query'),
['class' => 'btn btn-link'],
)
. '
' . "\n";
} else {
$phpParams = $urlParams;
$phpParams['show_as_php'] = 1;
$phpLink = ''
. self::linkOrButton(
Url::getFromRoute('/import', $phpParams),
null,
__('Create PHP code'),
['class' => 'btn btn-link'],
)
. '
' . "\n";
}
} else {
$phpLink = '';
}
// Refresh query
if (
! empty($config->settings['SQLQuery']['Refresh'])
&& ! isset($GLOBALS['show_as_php']) // 'Submit query' does the same
&& preg_match('@^(SELECT|SHOW)[[:space:]]+@i', $sqlQuery)
) {
$refreshLink = Url::getFromRoute('/sql', $urlParams);
$refreshLink = ''
. self::linkOrButton(
$refreshLink,
null,
__('Refresh'),
['class' => 'btn btn-link'],
) . '
' . "\n";
} else {
$refreshLink = '';
}
$retval .= '';
$retval .= $queryBase;
$retval .= '
' . "\n";
$retval .= '';
$retval .= '' . __('Error') . '
'; // For security reasons, if the MySQL refuses the connection, the query // is hidden so no details are revealed. if ($sqlQuery !== '' && ! mb_strstr($sqlQuery, 'connect')) { // Static analysis errors. if ($errors !== []) { $errorMessage .= '' . __('Static analysis:') . '
'; $errorMessage .= '' . sprintf( __('%d errors were found during analysis.'), count($errors), ) . '
'; $errorMessage .= '- ';
$errorMessage .= implode(
ParserError::format(
$errors,
'
- %2$s (near "%4$s" at position %5$d) ', ), ); $errorMessage .= '
' . __('SQL query:') . '' . self::showCopyToClipboard( $sqlQuery, ) . "\n"; $formattedSqlToLower = mb_strtolower($formattedSql); // TODO: Show documentation for all statement types. if (mb_strstr($formattedSqlToLower, 'select')) { // please show me help to the error on select $errorMessage .= MySQLDocumentation::show('SELECT'); } if ($isModifyLink) { $urlParams = ['sql_query' => $sqlQuery, 'show_query' => 1]; if (strlen($GLOBALS['table']) > 0) { $urlParams['db'] = $GLOBALS['db']; $urlParams['table'] = $GLOBALS['table']; $doEditGoto = ''; } elseif (strlen($GLOBALS['db']) > 0) { $urlParams['db'] = $GLOBALS['db']; $doEditGoto = ''; } else { $doEditGoto = ''; } $errorMessage .= $doEditGoto . self::getIcon('b_edit', __('Edit')) . ''; } $errorMessage .= '
' . "\n" . '' . "\n" . $formattedSql . "\n" . '
' . "\n"; } // Display server's error. if ($serverMessage !== '') { $serverMessage = (string) preg_replace("@((\015\012)|(\015)|(\012)){3,}@", "\n\n", $serverMessage); // Adds a link to MySQL documentation. $errorMessage .= '' . "\n" . ' ' . __('MySQL said: ') . '' . MySQLDocumentation::show('server-error-reference') . "\n" . '
' . "\n"; // The error message will be displayed within a CODE segment. // To preserve original formatting, but allow word-wrapping, // a couple of replacements are done. // All non-single blanks and TAB-characters are replaced with their // HTML-counterpart $serverMessage = str_replace( [' ', "\t"], [' ', ' '], $serverMessage, ); // Replace line breaks $serverMessage = nl2br($serverMessage); $errorMessage .= '' . $serverMessage . ''; } $errorMessage .= '
'
. '[ ' . __('Back') . ' ]'
. '
';
return sprintf($template, $title, $alt, $attributeString);
}
/**
* Displays a link, or a link with code to trigger POST request.
*
* POST is used in following cases:
*
* - URL is too long
* - URL components are over Suhosin limits
* - There is SQL query in the parameters
*
* @param string $urlPath the URL
* @param array' . "\n"
. htmlspecialchars($sqlQuery, ENT_COMPAT) . "\n"
. '