'; } return $retval; } /** * @return array
' . "\n";
}
if ($message instanceof Message) {
if (isset($GLOBALS['special_message'])) {
$message->addText($GLOBALS['special_message']);
unset($GLOBALS['special_message']);
}
$retval .= $message->getDisplay();
} else {
$context = 'primary';
if ($type === 'error') {
$context = 'danger';
} elseif ($type === 'success') {
$context = 'success';
}
$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
*
* @access public
*/
public static function showPHPDocumentation($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
*
* @return string the html link
*
* @access public
*/
public static function showDocumentationLink($link, $target = 'documentation', $bbcode = 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|bool $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.
*
* @access public
*/
public static function mysqlDie(
$serverMessage = '',
$sqlQuery = '',
$isModifyLink = true,
$backUrl = '',
$exit = true
): ?string {
global $table, $db, $dbi;
/**
* Error message to be built.
*
* @var string $errorMessage
*/
$errorMessage = '';
// Checking for any server errors.
if (empty($serverMessage)) {
$serverMessage = (string) $dbi->getError();
}
// Finding the query that failed, if not specified.
if (empty($sqlQuery) && ! empty($GLOBALS['sql_query'])) {
$sqlQuery = $GLOBALS['sql_query'];
}
$sqlQuery = trim($sqlQuery);
/**
* The lexer used for analysis.
*
* @var Lexer $lexer
*/
$lexer = new Lexer($sqlQuery);
/**
* The parser used for analysis.
*
* @var Parser $parser
*/
$parser = new Parser($lexer->list);
/**
* The errors found by the lexer and the parser.
*
* @var array $errors
*/
$errors = ParserError::get(
[
$lexer,
$parser,
]
);
if (empty($sqlQuery)) {
$formattedSql = '';
} elseif (count($errors)) {
$formattedSql = htmlspecialchars($sqlQuery);
} else {
$formattedSql = self::formatSql($sqlQuery, true);
}
$errorMessage .= '';
$retval .= Sanitize::sanitizeMessage($message);
if (isset($GLOBALS['special_message'])) {
$retval .= Sanitize::sanitizeMessage($GLOBALS['special_message']);
unset($GLOBALS['special_message']);
}
$retval .= '
';
}
if ($renderSql) {
$queryTooBig = false;
$queryLength = mb_strlen($sqlQuery);
if ($queryLength > $cfg['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,
$cfg['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) .
'';
$retval .= $queryBase;
$retval .= '
';
$retval .= '';
$retval .= '';
/**
* TODO: Should we have $cfg['SQLQuery']['InlineEdit']?
*/
if (
! empty($cfg['SQLQuery']['Edit'])
&& ! $queryTooBig
&& empty($GLOBALS['show_as_php'])
) {
$inlineEditLink = ' [ '
. self::linkOrButton(
'#',
_pgettext('Inline edit query', 'Edit inline'),
['class' => 'inline_edit_sql']
)
. ' ]';
} else {
$inlineEditLink = '';
}
$retval .= $inlineEditLink . $editLink . $explainLink . $phpLink
. $refreshLink;
$retval .= '
';
$retval .= '' . __('Error') . '
'; // For security reasons, if the MySQL refuses the connection, the query // is hidden so no details are revealed. if (! empty($sqlQuery) && ! mb_strstr($sqlQuery, 'connect')) { // Static analysis errors. if (! empty($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($table) > 0) { $urlParams['db'] = $db; $urlParams['table'] = $table; $doEditGoto = ''; } elseif (strlen($db) > 0) { $urlParams['db'] = $db; $doEditGoto = ''; } else { $doEditGoto = ''; } $errorMessage .= $doEditGoto . self::getIcon('b_edit', __('Edit')) . ''; } $errorMessage .= '
' . "\n" . '' . "\n" . $formattedSql . "\n" . '
' . "\n"; } // Display server's error. if (! empty($serverMessage)) { $serverMessage = (string) preg_replace( "@((\015\012)|(\015)|(\012)){3,}@", "\n\n", (string) $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 .= '
';
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 $url the URL
* @param string $message the link message
* @param mixed $tagParams string: js confirmation; array: additional tag
* params (f.e. style="")
* @param string $target target
*
* @return string the results to be echoed or saved in an array
*/
public static function linkOrButton(
$url,
$message,
$tagParams = [],
$target = ''
): string {
$urlLength = strlen($url);
if (! is_array($tagParams)) {
$tmp = $tagParams;
$tagParams = [];
if (! empty($tmp)) {
$tagParams['onclick'] = 'return Functions.confirmLink(this, \''
. Sanitize::escapeJsString($tmp) . '\')';
}
unset($tmp);
}
if (! empty($target)) {
$tagParams['target'] = $target;
if ($target === '_blank' && strncmp($url, 'url.php?', 8) == 0) {
$tagParams['rel'] = 'noopener noreferrer';
}
}
// Suhosin: Check that each query parameter is not above maximum
$inSuhosinLimits = true;
if ($urlLength <= $GLOBALS['cfg']['LinkLengthLimit']) {
$suhosinGetMaxValueLength = ini_get('suhosin.get.max_value_length');
if ($suhosinGetMaxValueLength) {
$queryParts = Util::splitURLQuery($url);
foreach ($queryParts as $queryPair) {
if (strpos($queryPair, '=') === false) {
continue;
}
[, $eachValue] = explode('=', $queryPair);
if (strlen($eachValue) > $suhosinGetMaxValueLength) {
$inSuhosinLimits = false;
break;
}
}
}
}
$tagParamsStrings = [];
if (
($urlLength > $GLOBALS['cfg']['LinkLengthLimit'])
|| ! $inSuhosinLimits
// Has as sql_query without a signature
|| (strpos($url, 'sql_query=') !== false && strpos($url, 'sql_signature=') === false)
|| strpos($url, 'view[as]=') !== false
) {
$parts = explode('?', $url, 2);
/*
* The data-post indicates that client should do POST
* this is handled in js/ajax.js
*/
$tagParamsStrings[] = 'data-post="' . ($parts[1] ?? '') . '"';
$url = $parts[0];
if (
array_key_exists('class', $tagParams)
&& strpos($tagParams['class'], 'create_view') !== false
) {
$url .= '?' . explode('&', $parts[1], 2)[0];
}
}
foreach ($tagParams as $paramName => $paramValue) {
$tagParamsStrings[] = $paramName . '="' . htmlspecialchars($paramValue) . '"';
}
// no whitespace within an else Safari will make it part of the link
return ''
. $message . '';
}
/**
* Prepare navigation for a list
*
* @param int $count number of elements in the list
* @param int $pos current position in the list
* @param array $urlParams url parameters
* @param string $script script name for form target
* @param string $frame target frame
* @param int $maxCount maximum number of elements to display from
* the list
* @param string $name the name for the request parameter
* @param string[] $classes additional classes for the container
*
* @return string the html content
*
* @access public
*
* @todo use $pos from $_url_params
*/
public static function getListNavigator(
$count,
$pos,
array $urlParams,
$script,
$frame,
$maxCount,
$name = 'pos',
$classes = []
): string {
// This is often coming from $cfg['MaxTableList'] and
// people sometimes set it to empty string
$maxCount = intval($maxCount);
if ($maxCount <= 0) {
$maxCount = 250;
}
$class = $frame === 'frame_navigation' ? ' class="ajax"' : '';
$listNavigatorHtml = '';
if ($maxCount < $count) {
$classes[] = 'pageselector';
$listNavigatorHtml .= '';
if ($frame !== 'frame_navigation') {
$listNavigatorHtml .= __('Page number:');
}
// Move to the beginning or to the previous page
if ($pos > 0) {
$caption1 = '';
$caption2 = '';
if (Util::showIcons('TableNavigationLinksMode')) {
$caption1 .= '<< ';
$caption2 .= '< ';
}
if (Util::showText('TableNavigationLinksMode')) {
$caption1 .= _pgettext('First page', 'Begin');
$caption2 .= _pgettext('Previous page', 'Previous');
}
$title1 = ' title="' . _pgettext('First page', 'Begin') . '"';
$title2 = ' title="' . _pgettext('Previous page', 'Previous') . '"';
$urlParams[$name] = 0;
$listNavigatorHtml .= '' . $caption1
. '';
$urlParams[$name] = $pos - $maxCount;
$listNavigatorHtml .= ' '
. $caption2 . '';
}
$listNavigatorHtml .= '';
if ($pos + $maxCount < $count) {
$caption3 = '';
$caption4 = '';
if (Util::showText('TableNavigationLinksMode')) {
$caption3 .= _pgettext('Next page', 'Next');
$caption4 .= _pgettext('Last page', 'End');
}
if (Util::showIcons('TableNavigationLinksMode')) {
$caption3 .= ' >';
$caption4 .= ' >>';
}
$title3 = ' title="' . _pgettext('Next page', 'Next') . '"';
$title4 = ' title="' . _pgettext('Last page', 'End') . '"';
$urlParams[$name] = $pos + $maxCount;
$listNavigatorHtml .= '' . $caption3
. '';
$urlParams[$name] = floor($count / $maxCount) * $maxCount;
if ($urlParams[$name] == $count) {
$urlParams[$name] = $count - $maxCount;
}
$listNavigatorHtml .= ' '
. $caption4 . '';
}
$listNavigatorHtml .= '
' . "\n";
}
return $listNavigatorHtml;
}
/**
* format sql strings
*
* @param string $sqlQuery raw SQL string
* @param bool $truncate truncate the query if it is too long
*
* @return string the formatted sql
*
* @global array $cfg the configuration array
*
* @access public
*/
public static function formatSql($sqlQuery, $truncate = false): string
{
global $cfg;
if (
$truncate
&& mb_strlen($sqlQuery) > $cfg['MaxCharactersInDisplayedSQL']
) {
$sqlQuery = mb_substr(
$sqlQuery,
0,
$cfg['MaxCharactersInDisplayedSQL']
) . '[...]';
}
return '' . "\n"
. htmlspecialchars($sqlQuery, ENT_COMPAT) . "\n"
. '