libraries/StorageEngine.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Library for extracting information about the available storage engines
   5  *
   6  * @version $Id$
   7  */
   8
   9 /**
  10  * defines
  11  */
  12 define('PMA_ENGINE_SUPPORT_NO', 0);
  13 define('PMA_ENGINE_SUPPORT_DISABLED', 1);
  14 define('PMA_ENGINE_SUPPORT_YES', 2);
  15 define('PMA_ENGINE_SUPPORT_DEFAULT', 3);
  16
  17 define('PMA_ENGINE_DETAILS_TYPE_PLAINTEXT', 0);
  18 define('PMA_ENGINE_DETAILS_TYPE_SIZE',      1);
  19 define('PMA_ENGINE_DETAILS_TYPE_NUMERIC',   2); //Has no effect yet...
  20 define('PMA_ENGINE_DETAILS_TYPE_BOOLEAN',   3); // 'ON' or 'OFF'
  21
  22 /**
  23  * base Storage Engine Class
  24  */
  25 class PMA_StorageEngine
  26 {
  27     /**
  28      * @var string engine name
  29      */
  30     var $engine  = 'dummy';
  31
  32     /**
  33      * @var string engine title/description
  34      */
  35     var $title   = 'PMA Dummy Engine Class';
  36
  37     /**
  38      * @var string engine lang description
  39      */
  40     var $comment = 'If you read this text inside phpMyAdmin, something went wrong...';
  41
  42     /**
  43      * @var integer engine supported by current server
  44      */
  45     var $support = PMA_ENGINE_SUPPORT_NO;
  46
  47     /**
  48      * returns array of storage engines
  49      *
  50      * @static
  51      * @staticvar array $storage_engines storage engines
  52      * @access  public
  53      * @uses    PMA_DBI_fetch_result()
  54      * @return  array    of storage engines
  55      */
  56     static public function getStorageEngines()
  57     {
  58         static $storage_engines = null;
  59
  60         if (null !== $storage_engines) {
  61             return $storage_engines;
  62         }
  63
  64         return PMA_DBI_fetch_result('SHOW STORAGE ENGINES', 'Engine');
  65     }
  66
  67     /**
  68      * returns HTML code for storage engine select box
  69      *
  70      * @author  rabus
  71      * @static
  72      * @uses    PMA_StorageEngine::getStorageEngines()
  73      * @uses    strtolower()
  74      * @uses    htmlspecialchars()
  75      * @param   string  $name       The name of the select form element
  76      * @param   string  $id         The ID of the form field
  77      * @param   string  $selected   The selected engine
  78      * @param   boolean $offerUnavailableEngines
  79      *                              Should unavailable storage engines be offered?
  80      * @return  string  html selectbox
  81      */
  82     static public function getHtmlSelect($name = 'engine', $id = null,
  83       $selected = null, $offerUnavailableEngines = false)
  84     {
  85         $selected   = strtolower($selected);
  86         $output     = '<select name="' . $name . '"'
  87             . (empty($id) ? '' : ' id="' . $id . '"') . '>' . "\n";
  88
  89         foreach (PMA_StorageEngine::getStorageEngines() as $key => $details) {
  90             if (!$offerUnavailableEngines
  91               && ($details['Support'] == 'NO' || $details['Support'] == 'DISABLED')) {
  92                 continue;
  93             }
  94             // currently (MySQL 5.1.26) there is no way we can be informed
  95             // that MyBS does not support normal table creation so
  96             // we use an exception here
  97             if ('MyBS' == $details['Engine']) {
  98                 continue;
  99             }
 100             $output .= '    <option value="' . htmlspecialchars($key). '"'
 101                 . (empty($details['Comment'])
 102                     ? '' : ' title="' . htmlspecialchars($details['Comment']) . '"')
 103                 . (strtolower($key) == $selected || (empty($selected) && $details['Support'] == 'DEFAULT')
 104                     ? ' selected="selected"' : '') . '>' . "\n"
 105                 . '        ' . htmlspecialchars($details['Engine']) . "\n"
 106                 . '    </option>' . "\n";
 107         }
 108         $output .= '</select>' . "\n";
 109         return $output;
 110     }
 111
 112     /**
 113      * public static final PMA_StorageEngine getEngine()
 114      *
 115      * Loads the corresponding engine plugin, if available.
 116      *
 117      * @uses    str_replace()
 118      * @uses    file_exists()
 119      * @uses    PMA_StorageEngine
 120      * @param   string  $engine   The engine ID
 121      * @return  object  The engine plugin
 122      */
 123     static public function getEngine($engine)
 124     {
 125         $engine = str_replace('/', '', str_replace('.', '', $engine));
 126         $engine_lowercase_filename = strtolower($engine);
 127         if (file_exists('./libraries/engines/' . $engine_lowercase_filename . '.lib.php')
 128           && include_once './libraries/engines/' . $engine_lowercase_filename . '.lib.php') {
 129             $class_name = 'PMA_StorageEngine_' . $engine;
 130             $engine_object = new $class_name($engine);
 131         } else {
 132             $engine_object = new PMA_StorageEngine($engine);
 133         }
 134         return $engine_object;
 135     }
 136
 137     /**
 138      * return true if given engine name is supported/valid, otherwise false
 139      *
 140      * @static
 141      * @uses    PMA_StorageEngine::getStorageEngines()
 142      * @param   string  $engine name of engine
 143      * @reutrn  boolean whether $engine is valid or not
 144      */
 145     static public function isValid($engine)
 146     {
 147         $storage_engines = PMA_StorageEngine::getStorageEngines();
 148         return isset($storage_engines[$engine]);
 149     }
 150
 151     /**
 152      * returns as HTML table of the engine's server variables
 153      *
 154      * @uses    PMA_ENGINE_DETAILS_TYPE_SIZE
 155      * @uses    PMA_ENGINE_DETAILS_TYPE_NUMERIC
 156      * @uses    PMA_StorageEngine::getVariablesStatus()
 157      * @uses    $GLOBALS['strNoDetailsForEngine']
 158      * @uses    PMA_showHint()
 159      * @uses    PMA_formatByteDown()
 160      * @uses    PMA_formatNumber()
 161      * @uses    htmlspecialchars()
 162      * @return  string  The table that was generated based on the retrieved information
 163      */
 164     function getHtmlVariables()
 165     {
 166         $odd_row    = false;
 167         $ret        = '';
 168
 169         foreach ($this->getVariablesStatus() as $details) {
 170             $ret .= '<tr class="' . ($odd_row ? 'odd' : 'even') . '">' . "\n"
 171                   . '    <td>' . "\n";
 172             if (!empty($details['desc'])) {
 173                 $ret .= '        ' . PMA_showHint($details['desc']) . "\n";
 174             }
 175             $ret .= '    </td>' . "\n"
 176                   . '    <th>' . htmlspecialchars($details['title']) . '</th>' . "\n"
 177                   . '    <td class="value">';
 178             switch ($details['type']) {
 179                 case PMA_ENGINE_DETAILS_TYPE_SIZE:
 180                     $parsed_size = PMA_formatByteDown($details['value']);
 181                     $ret .= $parsed_size[0] . '&nbsp;' . $parsed_size[1];
 182                     unset($parsed_size);
 183                 break;
 184                 case PMA_ENGINE_DETAILS_TYPE_NUMERIC:
 185                     $ret .= PMA_formatNumber($details['value']) . ' ';
 186                 break;
 187                 default:
 188                     $ret .= htmlspecialchars($details['value']) . '   ';
 189             }
 190             $ret .= '</td>' . "\n"
 191                   . '</tr>' . "\n";
 192             $odd_row = !$odd_row;
 193         }
 194
 195         if (! $ret) {
 196             $ret = '<p>' . "\n"
 197                  . '    ' . $GLOBALS['strNoDetailsForEngine'] . "\n"
 198                  . '</p>' . "\n";
 199         } else {
 200             $ret = '<table class="data">' . "\n" . $ret . '</table>' . "\n";
 201         }
 202
 203         return $ret;
 204     }
 205
 206     /**
 207      * returns array with detailed info about engine specific server variables
 208      *
 209      * @uses    PMA_ENGINE_DETAILS_TYPE_PLAINTEXT
 210      * @uses    PMA_StorageEngine::getVariables()
 211      * @uses    PMA_StorageEngine::getVariablesLikePattern()
 212      * @uses    PMA_DBI_query()
 213      * @uses    PMA_DBI_fetch_assoc()
 214      * @uses    PMA_DBI_free_result()
 215      * @return  array   with detailed info about specific engine server variables
 216      */
 217     function getVariablesStatus()
 218     {
 219         $variables = $this->getVariables();
 220         $like = $this->getVariablesLikePattern();
 221
 222         if ($like) {
 223             $like = " LIKE '" . $like . "' ";
 224         } else {
 225             $like = '';
 226         }
 227
 228         $mysql_vars = array();
 229
 230         $sql_query = 'SHOW GLOBAL VARIABLES ' . $like . ';';
 231         $res = PMA_DBI_query($sql_query);
 232         while ($row = PMA_DBI_fetch_assoc($res)) {
 233             if (isset($variables[$row['Variable_name']])) {
 234                 $mysql_vars[$row['Variable_name']] = $variables[$row['Variable_name']];
 235             } elseif (! $like
 236              && strpos(strtolower($row['Variable_name']), strtolower($this->engine)) !== 0) {
 237                 continue;
 238             }
 239             $mysql_vars[$row['Variable_name']]['value'] = $row['Value'];
 240
 241             if (empty($mysql_vars[$row['Variable_name']]['title'])) {
 242                 $mysql_vars[$row['Variable_name']]['title'] = $row['Variable_name'];
 243             }
 244
 245             if (! isset($mysql_vars[$row['Variable_name']]['type'])) {
 246                 $mysql_vars[$row['Variable_name']]['type'] = PMA_ENGINE_DETAILS_TYPE_PLAINTEXT;
 247             }
 248         }
 249         PMA_DBI_free_result($res);
 250
 251         return $mysql_vars;
 252     }
 253
 254     /**
 255      * Constructor
 256      *
 257      * @uses    PMA_StorageEngine::getStorageEngines()
 258      * @uses    PMA_ENGINE_SUPPORT_DEFAULT
 259      * @uses    PMA_ENGINE_SUPPORT_YES
 260      * @uses    PMA_ENGINE_SUPPORT_DISABLED
 261      * @uses    PMA_ENGINE_SUPPORT_NO
 262      * @uses    $this->engine
 263      * @uses    $this->title
 264      * @uses    $this->comment
 265      * @uses    $this->support
 266      * @param   string  $engine The engine ID
 267      */
 268     function __construct($engine)
 269     {
 270         $storage_engines = PMA_StorageEngine::getStorageEngines();
 271         if (!empty($storage_engines[$engine])) {
 272             $this->engine  = $engine;
 273             $this->title   = $storage_engines[$engine]['Engine'];
 274             $this->comment =
 275                 (isset($storage_engines[$engine]['Comment'])
 276                     ? $storage_engines[$engine]['Comment']
 277                     : '');
 278             switch ($storage_engines[$engine]['Support']) {
 279                 case 'DEFAULT':
 280                     $this->support = PMA_ENGINE_SUPPORT_DEFAULT;
 281                     break;
 282                 case 'YES':
 283                     $this->support = PMA_ENGINE_SUPPORT_YES;
 284                     break;
 285                 case 'DISABLED':
 286                     $this->support = PMA_ENGINE_SUPPORT_DISABLED;
 287                     break;
 288                 case 'NO':
 289                 default:
 290                     $this->support = PMA_ENGINE_SUPPORT_NO;
 291             }
 292         }
 293     }
 294
 295     /**
 296      * public String getTitle()
 297      *
 298      * Reveals the engine's title
 299      * @uses    $this->title
 300      * @return  string   The title
 301      */
 302     function getTitle()
 303     {
 304         return $this->title;
 305     }
 306
 307     /**
 308      * public String getComment()
 309      *
 310      * Fetches the server's comment about this engine
 311      * @uses    $this->comment
 312      * @return  string   The comment
 313      */
 314     function getComment()
 315     {
 316         return $this->comment;
 317     }
 318
 319     /**
 320      * public String getSupportInformationMessage()
 321      *
 322      * @uses    $GLOBALS['strDefaultEngine']
 323      * @uses    $GLOBALS['strEngineAvailable']
 324      * @uses    $GLOBALS['strEngineDisabled']
 325      * @uses    $GLOBALS['strEngineUnsupported']
 326      * @uses    $GLOBALS['strEngineUnsupported']
 327      * @uses    PMA_ENGINE_SUPPORT_DEFAULT
 328      * @uses    PMA_ENGINE_SUPPORT_YES
 329      * @uses    PMA_ENGINE_SUPPORT_DISABLED
 330      * @uses    PMA_ENGINE_SUPPORT_NO
 331      * @uses    $this->support
 332      * @uses    $this->title
 333      * @uses    sprintf
 334      * @return  string   The localized message.
 335      */
 336     function getSupportInformationMessage()
 337     {
 338         switch ($this->support) {
 339             case PMA_ENGINE_SUPPORT_DEFAULT:
 340                 $message = $GLOBALS['strDefaultEngine'];
 341                 break;
 342             case PMA_ENGINE_SUPPORT_YES:
 343                 $message = $GLOBALS['strEngineAvailable'];
 344                 break;
 345             case PMA_ENGINE_SUPPORT_DISABLED:
 346                 $message = $GLOBALS['strEngineDisabled'];
 347                 break;
 348             case PMA_ENGINE_SUPPORT_NO:
 349             default:
 350                 $message = $GLOBALS['strEngineUnsupported'];
 351         }
 352         return sprintf($message, htmlspecialchars($this->title));
 353     }
 354
 355     /**
 356      * public string[][] getVariables()
 357      *
 358      * Generates a list of MySQL variables that provide information about this
 359      * engine. This function should be overridden when extending this class
 360      * for a particular engine.
 361      *
 362      * @abstract
 363      * @return   Array   The list of variables.
 364      */
 365     function getVariables()
 366     {
 367         return array();
 368     }
 369
 370     /**
 371      * returns string with filename for the MySQL helppage
 372      * about this storage engne
 373      *
 374      * @return  string  mysql helppage filename
 375      */
 376     function getMysqlHelpPage()
 377     {
 378         return $this->engine . '-storage-engine';
 379     }
 380
 381     /**
 382      * public string getVariablesLikePattern()
 383      *
 384      * @abstract
 385      * @return  string  SQL query LIKE pattern
 386      */
 387     function getVariablesLikePattern()
 388     {
 389         return false;
 390     }
 391
 392     /**
 393      * public String[] getInfoPages()
 394      *
 395      * Returns a list of available information pages with labels
 396      *
 397      * @abstract
 398      * @return  array    The list
 399      */
 400     function getInfoPages()
 401     {
 402         return array();
 403     }
 404
 405     /**
 406      * public String getPage()
 407      *
 408      * Generates the requested information page
 409      *
 410      * @abstract
 411      * @param   string  $id The page ID
 412      *
 413      * @return  string      The page
 414      *          boolean     or false on error.
 415      */
 416     function getPage($id)
 417     {
 418         return false;
 419     }
 420 }
 421
 422 ?>