2fe6ff4655
Set namespace on DbQbe. Set namespace to 'DbSearch'. Split Advisor.class.php file. Change Advisor namespace. Rename DbQbe class and file. Set namespace on DisplayResults. Set namespace on Error. Use namespace for ErrorHandler. Add class autoloader. Change ErrorHandler filename. Remove some require. Update Config namespace path. Update PMA_Util to PMA\libraries\Util. Rename Font and File classes files. Use namespace for Footer. Set namespace in all libraries classes. Namespace OutputBuffering. Export SubPartition. Rename Partition file. Namespace PDF. Namespace RecentFavoriteTable. Replace PMA_Response by Response and PMA_Message by Message. Update uses and calls. Fix unit tests. Fix SqlParser autoload. Signed-off-by: Hugues Peccatte <hugues.peccatte@gmail.com>
467 lines
14 KiB
PHP
467 lines
14 KiB
PHP
<?php
|
|
/* vim: set expandtab sw=4 ts=4 sts=4: */
|
|
/**
|
|
* Library for extracting information about the available storage engines
|
|
*
|
|
* @package PhpMyAdmin
|
|
*/
|
|
namespace PMA\libraries;
|
|
|
|
/**
|
|
* defines
|
|
*/
|
|
use PMA_StorageEngine_Bdb;
|
|
use PMA_StorageEngine_Berkeleydb;
|
|
use PMA_StorageEngine_Binlog;
|
|
use PMA_StorageEngine_Innobase;
|
|
use PMA_StorageEngine_Innodb;
|
|
use PMA_StorageEngine_Memory;
|
|
use PMA_StorageEngine_Merge;
|
|
use PMA_StorageEngine_MrgMyisam;
|
|
use PMA_StorageEngine_Myisam;
|
|
use PMA_StorageEngine_Ndbcluster;
|
|
use PMA_StorageEngine_Pbxt;
|
|
use PMA_StorageEngine_PerformanceSchema;
|
|
|
|
define('PMA_ENGINE_SUPPORT_NO', 0);
|
|
define('PMA_ENGINE_SUPPORT_DISABLED', 1);
|
|
define('PMA_ENGINE_SUPPORT_YES', 2);
|
|
define('PMA_ENGINE_SUPPORT_DEFAULT', 3);
|
|
|
|
define('PMA_ENGINE_DETAILS_TYPE_PLAINTEXT', 0);
|
|
define('PMA_ENGINE_DETAILS_TYPE_SIZE', 1);
|
|
define('PMA_ENGINE_DETAILS_TYPE_NUMERIC', 2); //Has no effect yet...
|
|
define('PMA_ENGINE_DETAILS_TYPE_BOOLEAN', 3); // 'ON' or 'OFF'
|
|
|
|
/**
|
|
* Base Storage Engine Class
|
|
*
|
|
* @package PhpMyAdmin
|
|
*/
|
|
class PMA_StorageEngine
|
|
{
|
|
/**
|
|
* @var string engine name
|
|
*/
|
|
var $engine = 'dummy';
|
|
|
|
/**
|
|
* @var string engine title/description
|
|
*/
|
|
var $title = 'PMA Dummy Engine Class';
|
|
|
|
/**
|
|
* @var string engine lang description
|
|
*/
|
|
var $comment
|
|
= 'If you read this text inside phpMyAdmin, something went wrong...';
|
|
|
|
/**
|
|
* @var integer engine supported by current server
|
|
*/
|
|
var $support = PMA_ENGINE_SUPPORT_NO;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param string $engine The engine ID
|
|
*/
|
|
public function __construct($engine)
|
|
{
|
|
$storage_engines = PMA_StorageEngine::getStorageEngines();
|
|
if (! empty($storage_engines[$engine])) {
|
|
$this->engine = $engine;
|
|
$this->title = $storage_engines[$engine]['Engine'];
|
|
$this->comment = (isset($storage_engines[$engine]['Comment'])
|
|
? $storage_engines[$engine]['Comment']
|
|
: '');
|
|
switch ($storage_engines[$engine]['Support']) {
|
|
case 'DEFAULT':
|
|
$this->support = PMA_ENGINE_SUPPORT_DEFAULT;
|
|
break;
|
|
case 'YES':
|
|
$this->support = PMA_ENGINE_SUPPORT_YES;
|
|
break;
|
|
case 'DISABLED':
|
|
$this->support = PMA_ENGINE_SUPPORT_DISABLED;
|
|
break;
|
|
case 'NO':
|
|
default:
|
|
$this->support = PMA_ENGINE_SUPPORT_NO;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns array of storage engines
|
|
*
|
|
* @static
|
|
* @staticvar array $storage_engines storage engines
|
|
* @access public
|
|
* @return string[] array of storage engines
|
|
*/
|
|
static public function getStorageEngines()
|
|
{
|
|
static $storage_engines = null;
|
|
|
|
if (null == $storage_engines) {
|
|
if (PMA_DRIZZLE) {
|
|
$sql = "SELECT
|
|
p.plugin_name AS Engine,
|
|
(CASE
|
|
WHEN p.plugin_name = @@storage_engine THEN 'DEFAULT'
|
|
WHEN p.is_active THEN 'YES'
|
|
ELSE 'DISABLED' END) AS Support,
|
|
m.module_description AS Comment
|
|
FROM data_dictionary.plugins p
|
|
JOIN data_dictionary.modules m USING (module_name)
|
|
WHERE p.plugin_type = 'StorageEngine'
|
|
AND p.plugin_name NOT IN ('FunctionEngine', 'schema')";
|
|
$storage_engines = $GLOBALS['dbi']->fetchResult($sql, 'Engine');
|
|
} else {
|
|
$storage_engines
|
|
= $GLOBALS['dbi']->fetchResult('SHOW STORAGE ENGINES', 'Engine');
|
|
}
|
|
}
|
|
|
|
return $storage_engines;
|
|
}
|
|
|
|
/**
|
|
* Returns HTML code for storage engine select box
|
|
*
|
|
* @param string $name The name of the select form element
|
|
* @param string $id The ID of the form field
|
|
* @param string $selected The selected engine
|
|
* @param boolean $offerUnavailableEngines Should unavailable storage
|
|
* engines be offered?
|
|
*
|
|
* @static
|
|
* @return string html selectbox
|
|
*/
|
|
static public function getHtmlSelect(
|
|
$name = 'engine', $id = null,
|
|
$selected = null, $offerUnavailableEngines = false
|
|
) {
|
|
$selected = /*overload*/mb_strtolower($selected);
|
|
$output = '<select name="' . $name . '"'
|
|
. (empty($id) ? '' : ' id="' . $id . '"') . '>' . "\n";
|
|
|
|
foreach (PMA_StorageEngine::getStorageEngines() as $key => $details) {
|
|
// Don't show PERFORMANCE_SCHEMA engine (MySQL 5.5)
|
|
// Don't show MyISAM for Drizzle (allowed only for temporary tables)
|
|
if (! $offerUnavailableEngines
|
|
&& ($details['Support'] == 'NO'
|
|
|| $details['Support'] == 'DISABLED'
|
|
|| $details['Engine'] == 'PERFORMANCE_SCHEMA')
|
|
|| (PMA_DRIZZLE && $details['Engine'] == 'MyISAM')
|
|
) {
|
|
continue;
|
|
}
|
|
|
|
$output .= ' <option value="' . htmlspecialchars($key) . '"'
|
|
. (empty($details['Comment'])
|
|
? '' : ' title="' . htmlspecialchars($details['Comment']) . '"')
|
|
. (/*overload*/mb_strtolower($key) == $selected
|
|
|| (empty($selected) && $details['Support'] == 'DEFAULT')
|
|
? ' selected="selected"' : '')
|
|
. '>' . "\n"
|
|
. ' ' . htmlspecialchars($details['Engine']) . "\n"
|
|
. ' </option>' . "\n";
|
|
}
|
|
$output .= '</select>' . "\n";
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Loads the corresponding engine plugin, if available.
|
|
*
|
|
* @param string $engine The engine ID
|
|
*
|
|
* @return PMA_StorageEngine|bool The engine plugin or false if not found
|
|
* @static
|
|
*/
|
|
static public function getEngine($engine)
|
|
{
|
|
$engine = str_replace('/', '', str_replace('.', '', $engine));
|
|
$filename = './libraries/engines/'
|
|
. /*overload*/mb_strtolower($engine) . '.lib.php';
|
|
if (file_exists($filename) && include_once $filename) {
|
|
switch(/*overload*/mb_strtolower($engine)) {
|
|
case 'bdb':
|
|
return new PMA_StorageEngine_Bdb($engine);
|
|
case 'berkeleydb':
|
|
return new PMA_StorageEngine_Berkeleydb($engine);
|
|
case 'binlog':
|
|
return new PMA_StorageEngine_Binlog($engine);
|
|
case 'innobase':
|
|
return new PMA_StorageEngine_Innobase($engine);
|
|
case 'innodb':
|
|
return new PMA_StorageEngine_Innodb($engine);
|
|
case 'memory':
|
|
return new PMA_StorageEngine_Memory($engine);
|
|
case 'merge':
|
|
return new PMA_StorageEngine_Merge($engine);
|
|
case 'mrg_myisam':
|
|
return new PMA_StorageEngine_MrgMyisam($engine);
|
|
case 'myisam':
|
|
return new PMA_StorageEngine_Myisam($engine);
|
|
case 'ndbcluster':
|
|
return new PMA_StorageEngine_Ndbcluster($engine);
|
|
case 'pbxt':
|
|
return new PMA_StorageEngine_Pbxt($engine);
|
|
case 'performance_schema':
|
|
return new PMA_StorageEngine_PerformanceSchema($engine);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
return new PMA_StorageEngine($engine);
|
|
}
|
|
|
|
/**
|
|
* Returns true if given engine name is supported/valid, otherwise false
|
|
*
|
|
* @param string $engine name of engine
|
|
*
|
|
* @static
|
|
* @return boolean whether $engine is valid or not
|
|
*/
|
|
static public function isValid($engine)
|
|
{
|
|
if ($engine == "PBMS") {
|
|
return true;
|
|
}
|
|
$storage_engines = PMA_StorageEngine::getStorageEngines();
|
|
return isset($storage_engines[$engine]);
|
|
}
|
|
|
|
/**
|
|
* Returns as HTML table of the engine's server variables
|
|
*
|
|
* @return string The table that was generated based on the retrieved
|
|
* information
|
|
*/
|
|
public function getHtmlVariables()
|
|
{
|
|
$odd_row = false;
|
|
$ret = '';
|
|
|
|
foreach ($this->getVariablesStatus() as $details) {
|
|
$ret .= '<tr class="' . ($odd_row ? 'odd' : 'even') . '">' . "\n"
|
|
. ' <td>' . "\n";
|
|
if (! empty($details['desc'])) {
|
|
$ret .= ' '
|
|
. Util::showHint($details['desc'])
|
|
. "\n";
|
|
}
|
|
$ret .= ' </td>' . "\n"
|
|
. ' <th>' . htmlspecialchars($details['title']) . '</th>'
|
|
. "\n"
|
|
. ' <td class="value">';
|
|
switch ($details['type']) {
|
|
case PMA_ENGINE_DETAILS_TYPE_SIZE:
|
|
$parsed_size = $this->resolveTypeSize($details['value']);
|
|
$ret .= $parsed_size[0] . ' ' . $parsed_size[1];
|
|
unset($parsed_size);
|
|
break;
|
|
case PMA_ENGINE_DETAILS_TYPE_NUMERIC:
|
|
$ret .= Util::formatNumber($details['value']) . ' ';
|
|
break;
|
|
default:
|
|
$ret .= htmlspecialchars($details['value']) . ' ';
|
|
}
|
|
$ret .= '</td>' . "\n"
|
|
. '</tr>' . "\n";
|
|
$odd_row = ! $odd_row;
|
|
}
|
|
|
|
if (! $ret) {
|
|
$ret = '<p>' . "\n"
|
|
. ' '
|
|
. __(
|
|
'There is no detailed status information available for this '
|
|
. 'storage engine.'
|
|
)
|
|
. "\n"
|
|
. '</p>' . "\n";
|
|
} else {
|
|
$ret = '<table class="data">' . "\n" . $ret . '</table>' . "\n";
|
|
}
|
|
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Returns the engine specific handling for
|
|
* PMA_ENGINE_DETAILS_TYPE_SIZE type variables.
|
|
*
|
|
* This function should be overridden when
|
|
* PMA_ENGINE_DETAILS_TYPE_SIZE type needs to be
|
|
* handled differently for a particular engine.
|
|
*
|
|
* @param integer $value Value to format
|
|
*
|
|
* @return string the formatted value and its unit
|
|
*/
|
|
public function resolveTypeSize($value)
|
|
{
|
|
return Util::formatByteDown($value);
|
|
}
|
|
|
|
/**
|
|
* Returns array with detailed info about engine specific server variables
|
|
*
|
|
* @return array array with detailed info about specific engine server variables
|
|
*/
|
|
public function getVariablesStatus()
|
|
{
|
|
$variables = $this->getVariables();
|
|
$like = $this->getVariablesLikePattern();
|
|
|
|
if ($like) {
|
|
$like = " LIKE '" . $like . "' ";
|
|
} else {
|
|
$like = '';
|
|
}
|
|
|
|
$mysql_vars = array();
|
|
|
|
$sql_query = 'SHOW GLOBAL VARIABLES ' . $like . ';';
|
|
$res = $GLOBALS['dbi']->query($sql_query);
|
|
while ($row = $GLOBALS['dbi']->fetchAssoc($res)) {
|
|
if (isset($variables[$row['Variable_name']])) {
|
|
$mysql_vars[$row['Variable_name']]
|
|
= $variables[$row['Variable_name']];
|
|
} elseif (! $like
|
|
&& /*overload*/mb_strpos(/*overload*/mb_strtolower($row['Variable_name']), /*overload*/mb_strtolower($this->engine)) !== 0
|
|
) {
|
|
continue;
|
|
}
|
|
$mysql_vars[$row['Variable_name']]['value'] = $row['Value'];
|
|
|
|
if (empty($mysql_vars[$row['Variable_name']]['title'])) {
|
|
$mysql_vars[$row['Variable_name']]['title'] = $row['Variable_name'];
|
|
}
|
|
|
|
if (! isset($mysql_vars[$row['Variable_name']]['type'])) {
|
|
$mysql_vars[$row['Variable_name']]['type']
|
|
= PMA_ENGINE_DETAILS_TYPE_PLAINTEXT;
|
|
}
|
|
}
|
|
$GLOBALS['dbi']->freeResult($res);
|
|
|
|
return $mysql_vars;
|
|
}
|
|
|
|
/**
|
|
* Reveals the engine's title
|
|
*
|
|
* @return string The title
|
|
*/
|
|
public function getTitle()
|
|
{
|
|
return $this->title;
|
|
}
|
|
|
|
/**
|
|
* Fetches the server's comment about this engine
|
|
*
|
|
* @return string The comment
|
|
*/
|
|
public function getComment()
|
|
{
|
|
return $this->comment;
|
|
}
|
|
|
|
/**
|
|
* Information message on whether this storage engine is supported
|
|
*
|
|
* @return string The localized message.
|
|
*/
|
|
public function getSupportInformationMessage()
|
|
{
|
|
switch ($this->support) {
|
|
case PMA_ENGINE_SUPPORT_DEFAULT:
|
|
$message = __('%s is the default storage engine on this MySQL server.');
|
|
break;
|
|
case PMA_ENGINE_SUPPORT_YES:
|
|
$message = __('%s is available on this MySQL server.');
|
|
break;
|
|
case PMA_ENGINE_SUPPORT_DISABLED:
|
|
$message = __('%s has been disabled for this MySQL server.');
|
|
break;
|
|
case PMA_ENGINE_SUPPORT_NO:
|
|
default:
|
|
$message = __(
|
|
'This MySQL server does not support the %s storage engine.'
|
|
);
|
|
}
|
|
return sprintf($message, htmlspecialchars($this->title));
|
|
}
|
|
|
|
/**
|
|
* Generates a list of MySQL variables that provide information about this
|
|
* engine. This function should be overridden when extending this class
|
|
* for a particular engine.
|
|
*
|
|
* @return array The list of variables.
|
|
*/
|
|
public function getVariables()
|
|
{
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Returns string with filename for the MySQL helppage
|
|
* about this storage engine
|
|
*
|
|
* @return string MySQL help page filename
|
|
*/
|
|
public function getMysqlHelpPage()
|
|
{
|
|
return $this->engine . '-storage-engine';
|
|
}
|
|
|
|
/**
|
|
* Returns the pattern to be used in the query for SQL variables
|
|
* related to the storage engine
|
|
*
|
|
* @return string SQL query LIKE pattern
|
|
*/
|
|
public function getVariablesLikePattern()
|
|
{
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Returns a list of available information pages with labels
|
|
*
|
|
* @return string[] The list
|
|
*/
|
|
public function getInfoPages()
|
|
{
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Generates the requested information page
|
|
*
|
|
* @param string $id page id
|
|
*
|
|
* @return string html output
|
|
*/
|
|
public function getPage($id)
|
|
{
|
|
if (! array_key_exists($id, $this->getInfoPages())) {
|
|
return '';
|
|
}
|
|
|
|
$id = 'getPage' . $id;
|
|
|
|
return $this->$id();
|
|
}
|
|
}
|
|
|
