libraries/List_Database.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * holds the PMA_List_Database class
   5  *
   6  * @package phpMyAdmin
   7  */
   8
   9 /**
  10  * the list base class
  11  */
  12 require_once './libraries/List.class.php';
  13
  14 /**
  15  * handles database lists
  16  *
  17  * <code>
  18  * $PMA_List_Database = new PMA_List_Database($userlink, $controllink);
  19  * </code>
  20  *
  21  * @todo this object should be attached to the PMA_Server object
  22  * @todo ? make use of INFORMATION_SCHEMA
  23  * @todo ? support --skip-showdatabases and user has only global rights
  24  * @access public
  25  * @since phpMyAdmin 2.9.10
  26  * @package phpMyAdmin
  27  */
  28 /*public*/ class PMA_List_Database extends PMA_List
  29 {
  30     /**
  31      * @var mixed   database link resource|object to be used
  32      */
  33     protected $_db_link = null;
  34
  35     /**
  36      * @var mixed   user database link resource|object
  37      */
  38     protected $_db_link_user = null;
  39
  40     /**
  41      * @var mixed   controluser database link resource|object
  42      */
  43     protected $_db_link_control = null;
  44
  45     /**
  46      * @var boolean whether SHOW DATABASES is disabled or not
  47      * @access protected
  48      */
  49     protected $_show_databases_disabled = false;
  50
  51     /**
  52      * @var string command to retrieve databases from server
  53      */
  54     protected $_command = null;
  55
  56     /**
  57      * Constructor
  58      *
  59      * @param mixed   $db_link_user       user database link resource|object
  60      * @param mixed   $db_link_control    control database link resource|object
  61      */
  62     public function __construct($db_link_user = null, $db_link_control = null)
  63     {
  64         $this->_db_link = $db_link_user;
  65         $this->_db_link_user = $db_link_user;
  66         $this->_db_link_control = $db_link_control;
  67
  68         parent::__construct();
  69         $this->build();
  70     }
  71
  72     /**
  73      * checks if the configuration wants to hide some databases
  74      */
  75     protected function _checkHideDatabase()
  76     {
  77         if (empty($GLOBALS['cfg']['Server']['hide_db'])) {
  78             return;
  79         }
  80
  81         foreach ($this->getArrayCopy() as $key => $db) {
  82             if (preg_match('/' . $GLOBALS['cfg']['Server']['hide_db'] . '/', $db)) {
  83                 $this->offsetUnset($key);
  84             }
  85         }
  86     }
  87
  88     /**
  89      * retrieves database list from server
  90      *
  91      * @todo    we could also search mysql tables if all fail?
  92      * @param string  $like_db_name   usally a db_name containing wildcards
  93      * @return array
  94      */
  95     protected function _retrieve($like_db_name = null)
  96     {
  97         if ($this->_show_databases_disabled) {
  98             return array();
  99         }
 100
 101         if (null !== $like_db_name) {
 102             $command = "SHOW DATABASES LIKE '" . $like_db_name . "'";
 103         } elseif (null === $this->_command) {
 104             $command = str_replace('#user#', $GLOBALS['cfg']['Server']['user'],
 105                 $GLOBALS['cfg']['Server']['ShowDatabasesCommand']);
 106             $this->_command = $command;
 107         } else {
 108             $command = $this->_command;
 109         }
 110
 111         $database_list = PMA_DBI_fetch_result($command, null, null, $this->_db_link);
 112         PMA_DBI_getError();
 113
 114         if ($GLOBALS['errno'] !== 0) {
 115             // failed to get database list, try the control user
 116             // (hopefully there is one and he has SHOW DATABASES right)
 117             $this->_db_link = $this->_db_link_control;
 118             $database_list = PMA_DBI_fetch_result($command, null, null, $this->_db_link);
 119
 120             PMA_DBI_getError();
 121
 122             if ($GLOBALS['errno'] !== 0) {
 123                 // failed! we will display a warning that phpMyAdmin could not safely
 124                 // retrieve database list, the admin has to setup a control user or
 125                 // allow SHOW DATABASES
 126                 $GLOBALS['error_showdatabases'] = true;
 127                 $this->_show_databases_disabled = true;
 128             }
 129         }
 130
 131         if ($GLOBALS['cfg']['NaturalOrder']) {
 132             natsort($database_list);
 133         } else {
 134             // need to sort anyway, otherwise information_schema
 135             // goes at the top
 136             sort($database_list);
 137         }
 138
 139         return $database_list;
 140     }
 141
 142     /**
 143      * builds up the list
 144      *
 145      */
 146     public function build()
 147     {
 148         if (! $this->_checkOnlyDatabase()) {
 149             $items = $this->_retrieve();
 150             $this->exchangeArray($items);
 151         }
 152
 153         $this->_checkHideDatabase();
 154     }
 155
 156     /**
 157      * checks the only_db configuration
 158      *
 159      * @return  boolean false if there is no only_db, otherwise true
 160      */
 161     protected function _checkOnlyDatabase()
 162     {
 163         if (is_string($GLOBALS['cfg']['Server']['only_db'])
 164          && strlen($GLOBALS['cfg']['Server']['only_db'])) {
 165             $GLOBALS['cfg']['Server']['only_db'] = array(
 166                 $GLOBALS['cfg']['Server']['only_db']
 167             );
 168         }
 169
 170         if (! is_array($GLOBALS['cfg']['Server']['only_db'])) {
 171             return false;
 172         }
 173
 174         $items = array();
 175
 176         foreach ($GLOBALS['cfg']['Server']['only_db'] as $each_only_db) {
 177             if ($each_only_db === '*' && ! $this->_show_databases_disabled) {
 178                 // append all not already listed dbs to the list
 179                 $items = array_merge($items,
 180                     array_diff($this->_retrieve(), $items));
 181                 // there can only be one '*', and this can only be last
 182                 break;
 183             }
 184
 185             // check if the db name contains wildcard,
 186             // thus containing not escaped _ or %
 187             if (! preg_match('/(^|[^\\\\])(_|%)/', $each_only_db)) {
 188                 // ... not contains wildcard
 189                 $items[] = PMA_unescape_mysql_wildcards($each_only_db);
 190                 continue;
 191             }
 192
 193             if (! $this->_show_databases_disabled) {
 194                 $items = array_merge($items, $this->_retrieve($each_only_db));
 195                 continue;
 196             }
 197
 198             // @todo induce error, about not using wildcards with SHOW DATABASE disabled?
 199         }
 200
 201         $this->exchangeArray($items);
 202
 203         return true;
 204     }
 205
 206     /**
 207      * returns default item
 208      *
 209      * @return  string  default item
 210      */
 211     public function getDefault()
 212     {
 213         if (strlen($GLOBALS['db'])) {
 214             return $GLOBALS['db'];
 215         }
 216
 217         return $this->getEmpty();
 218     }
 219
 220     /**
 221      * returns array with dbs grouped with extended infos
 222      *
 223      * @param integer $offset
 224      * @param integer $count
 225      * @return  array   db list
 226      */
 227     public function getGroupedDetails($offset, $count)
 228     {
 229         $dbgroups   = array();
 230
 231         if ($GLOBALS['cfg']['ShowTooltip']
 232           && $GLOBALS['cfgRelation']['commwork']) {
 233             $db_tooltips = PMA_getDbComments();
 234         }
 235
 236         if (!$GLOBALS['cfg']['LeftFrameDBTree']) {
 237             $separators = array();
 238         } elseif (is_array($GLOBALS['cfg']['LeftFrameDBSeparator'])) {
 239             $separators = $GLOBALS['cfg']['LeftFrameDBSeparator'];
 240         } elseif (!empty($GLOBALS['cfg']['LeftFrameDBSeparator'])) {
 241             $separators = array($GLOBALS['cfg']['LeftFrameDBSeparator']);
 242         } else {
 243             $separators = array();
 244         }
 245
 246         foreach ($this->getLimitedItems($offset, $count) as $db) {
 247             // Get comments from PMA comments table
 248             $db_tooltip = '';
 249
 250             if (isset($db_tooltips[$db])) {
 251                 $db_tooltip = $db_tooltips[$db];
 252             }
 253
 254             $pos = false;
 255
 256             foreach ($separators as $separator) {
 257                 // use strpos instead of strrpos; it seems more common to
 258                 // have the db name, the separator, then the rest which
 259                 // might contain a separator
 260                 // like dbname_the_rest
 261                 $pos = strpos($db, $separator, 1);
 262
 263                 if ($pos !== false) {
 264                     break;
 265                 }
 266             }
 267
 268             if ($pos !== false) {
 269                 $group          = substr($db, 0, $pos);
 270                 $disp_name_cut  = substr($db, $pos);
 271             } else {
 272                 $group          = $db;
 273                 $disp_name_cut  = $db;
 274             }
 275
 276             $disp_name  = $db;
 277             if ($db_tooltip && $GLOBALS['cfg']['ShowTooltipAliasDB']) {
 278                 $disp_name      = $db_tooltip;
 279                 $disp_name_cut  = $db_tooltip;
 280                 $db_tooltip     = $db;
 281             }
 282
 283             $dbgroups[$group][$db] = array(
 284                 'name'          => $db,
 285                 'disp_name_cut' => $disp_name_cut,
 286                 'disp_name'     => $disp_name,
 287                 'comment'       => $db_tooltip,
 288             );
 289
 290             if ($GLOBALS['cfg']['Server']['CountTables']) {
 291                 $dbgroups[$group][$db]['num_tables'] = PMA_getTableCount($db);
 292             }
 293         } // end foreach ($GLOBALS['PMA_List_Database']->items as $db)
 294         return $dbgroups;
 295     }
 296
 297     /**
 298      * returns a part of the items
 299      *
 300      * @param integer $offset
 301      * @param integer $count
 302      * @return  array  some items
 303      */
 304     public function getLimitedItems($offset, $count)
 305     {
 306         return array_slice($this->getArrayCopy(), $offset, $count);
 307     }
 308
 309     /**
 310      * returns html code for list with dbs
 311      *
 312      * @return  string  html code list
 313      */
 314     public function getHtmlListGrouped($selected = '', $offset, $count)
 315     {
 316         if (true === $selected) {
 317             $selected = $this->getDefault();
 318         }
 319
 320         $return = '<ul id="databaseList" xml:lang="en" dir="ltr">' . "\n";
 321         foreach ($this->getGroupedDetails($offset, $count) as $group => $dbs) {
 322             if (count($dbs) > 1) {
 323                 $return .= '<li class="group"><span>' . htmlspecialchars($group) . '</span><ul>' . "\n";
 324                 // whether display db_name cut by the group part
 325                 $cut = true;
 326             } else {
 327                 // .. or full
 328                 $cut = false;
 329             }
 330             foreach ($dbs as $db) {
 331                 $return .= '<li';
 332                 if ($db['name'] == $selected) {
 333                     $return .= ' class="selected"';
 334                 }
 335                 $return .= '><a';
 336                 if (! empty($db['comment'])) {
 337                     $return .= ' title="' . htmlspecialchars($db['comment']) . '"';
 338                 }
 339                 $return .= ' href="index.php?' . PMA_generate_common_url($db['name'])
 340                     . '" target="_parent">';
 341                 if ($cut) {
 342                     $return .= htmlspecialchars($db['disp_name_cut']);
 343                 } else {
 344                     $return .= htmlspecialchars($db['disp_name']);
 345                 }
 346
 347                 if (! empty($db['num_tables'])) {
 348                     $return .= ' (' . $db['num_tables'] . ')';
 349                 }
 350                 $return .= '</a></li>' . "\n";
 351             }
 352             if (count($dbs) > 1) {
 353                 $return .= '</ul></li>' . "\n";
 354             }
 355         }
 356         $return .= '</ul>';
 357
 358         return $return;
 359     }
 360
 361     /**
 362      * returns html code for select form element with dbs
 363      *
 364      * @todo IE can not handle different text directions in select boxes so,
 365      * as mostly names will be in english, we set the whole selectbox to LTR
 366      * and EN
 367      *
 368      * @return  string  html code select
 369      */
 370     public function getHtmlSelectGrouped($selected = '', $offset, $count)
 371     {
 372         if (true === $selected) {
 373             $selected = $this->getDefault();
 374         }
 375
 376         $return = '<select name="db" id="lightm_db" xml:lang="en" dir="ltr"'
 377             . ' onchange="if (this.value != \'\') window.parent.openDb(this.value);">' . "\n"
 378             . '<option value="" dir="' . $GLOBALS['text_dir'] . '">'
 379             . '(' . __('Databases') . ') ...</option>' . "\n";
 380         foreach ($this->getGroupedDetails($offset, $count) as $group => $dbs) {
 381             if (count($dbs) > 1) {
 382                 $return .= '<optgroup label="' . htmlspecialchars($group)
 383                     . '">' . "\n";
 384                 // whether display db_name cuted by the group part
 385                 $cut = true;
 386             } else {
 387                 // .. or full
 388                 $cut = false;
 389             }
 390             foreach ($dbs as $db) {
 391                 $return .= '<option value="' . htmlspecialchars($db['name']) . '"'
 392                     .' title="' . htmlspecialchars($db['comment']) . '"';
 393                 if ($db['name'] == $selected) {
 394                     $return .= ' selected="selected"';
 395                 }
 396                 $return .= '>' . htmlspecialchars($cut ? $db['disp_name_cut'] : $db['disp_name']);
 397                 if (! empty($db['num_tables'])) {
 398                     $return .= ' (' . $db['num_tables'] . ')';
 399                 }
 400                 $return .= '</option>' . "\n";
 401             }
 402             if (count($dbs) > 1) {
 403                 $return .= '</optgroup>' . "\n";
 404             }
 405         }
 406         $return .= '</select>';
 407
 408         return $return;
 409     }
 410
 411     /**
 412      * this is just a backup, if all is fine this can be deleted later
 413      *
 414      * @deprecated
 415      */
 416     protected function _checkAgainstPrivTables()
 417     {
 418         // 1. get allowed dbs from the "mysql.db" table
 419         // User can be blank (anonymous user)
 420         $local_query = "
 421             SELECT DISTINCT `Db` FROM `mysql`.`db`
 422             WHERE `Select_priv` = 'Y'
 423             AND `User`
 424             IN ('" . PMA_sqlAddSlashes($GLOBALS['cfg']['Server']['user']) . "', '')";
 425         $tmp_mydbs = PMA_DBI_fetch_result($local_query, null, null,
 426             $GLOBALS['controllink']);
 427         if ($tmp_mydbs) {
 428             // Will use as associative array of the following 2 code
 429             // lines:
 430             //   the 1st is the only line intact from before
 431             //     correction,
 432             //   the 2nd replaces $dblist[] = $row['Db'];
 433
 434             // Code following those 2 lines in correction continues
 435             // populating $dblist[], as previous code did. But it is
 436             // now populated with actual database names instead of
 437             // with regular expressions.
 438             $tmp_alldbs = PMA_DBI_query('SHOW DATABASES;', $GLOBALS['controllink']);
 439             // all databases cases - part 2
 440             if (isset($tmp_mydbs['%'])) {
 441                 while ($tmp_row = PMA_DBI_fetch_row($tmp_alldbs)) {
 442                     $dblist[] = $tmp_row[0];
 443                 } // end while
 444             } else {
 445                 while ($tmp_row = PMA_DBI_fetch_row($tmp_alldbs)) {
 446                     $tmp_db = $tmp_row[0];
 447                     if (isset($tmp_mydbs[$tmp_db]) && $tmp_mydbs[$tmp_db] == 1) {
 448                         $dblist[]           = $tmp_db;
 449                         $tmp_mydbs[$tmp_db] = 0;
 450                     } elseif (! isset($dblist[$tmp_db])) {
 451                         foreach ($tmp_mydbs as $tmp_matchpattern => $tmp_value) {
 452                             // fixed bad regexp
 453                             // TODO: db names may contain characters
 454                             //       that are regexp instructions
 455                             $re        = '(^|(\\\\\\\\)+|[^\])';
 456                             $tmp_regex = preg_replace('/' . addcslashes($re,'/') . '%/', '\\1.*', preg_replace('/' . addcslashes($re,'/') . '_/', '\\1.{1}', $tmp_matchpattern));
 457                             // Fixed db name matching
 458                             // 2000-08-28 -- Benjamin Gandon
 459                             if (preg_match('/^' . addcslashes($tmp_regex,'/') . '$/', $tmp_db)) {
 460                                 $dblist[] = $tmp_db;
 461                                 break;
 462                             }
 463                         } // end while
 464                     } // end if ... elseif ...
 465                 } // end while
 466             } // end else
 467             PMA_DBI_free_result($tmp_alldbs);
 468             unset($tmp_mydbs);
 469         } // end if
 470
 471         // 2. get allowed dbs from the "mysql.tables_priv" table
 472         $local_query = 'SELECT DISTINCT Db FROM mysql.tables_priv WHERE Table_priv LIKE \'%Select%\' AND User = \'' . PMA_sqlAddSlashes($GLOBALS['cfg']['Server']['user']) . '\'';
 473         $rs          = PMA_DBI_try_query($local_query, $GLOBALS['controllink']);
 474         if ($rs && @PMA_DBI_num_rows($rs)) {
 475             while ($row = PMA_DBI_fetch_assoc($rs)) {
 476                 if (!in_array($row['Db'], $dblist)) {
 477                     $dblist[] = $row['Db'];
 478                 }
 479             } // end while
 480             PMA_DBI_free_result($rs);
 481         } // end if
 482     }
 483 }
 484 ?>