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