libraries/server_databases.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3
   4 /**
   5  * functions for displaying server databases
   6  *
   7  * @usedby  server_databases.php
   8  *
   9  * @package PhpMyAdmin
  10  */
  11 if (! defined('PHPMYADMIN')) {
  12     exit;
  13 }
  14
  15 /**
  16  * Returns the html for Database List
  17  *
  18  * @param Array  $databases         GBI return databases
  19  * @param int    $databases_count   database count
  20  * @param int    $pos               display pos
  21  * @param Array  $dbstats           database status
  22  * @param string $sort_by           sort by string
  23  * @param string $sort_order        sort order string
  24  * @param bool   $is_superuser      User status
  25  * @param Array  $cfg               configuration
  26  * @param string $replication_types replication types
  27  * @param string $replication_info  replication info
  28  * @param string $url_query         url query
  29  *
  30  * @return string
  31  */
  32 function PMA_getHtmlForDatabase(
  33     $databases, $databases_count, $pos, $dbstats,
  34     $sort_by, $sort_order, $is_superuser, $cfg,
  35     $replication_types, $replication_info, $url_query
  36 ) {
  37     $html = '<div id="tableslistcontainer">';
  38     reset($databases);
  39     $first_database = current($databases);
  40     // table col order
  41     $column_order = PMA_getColumnOrder();
  42
  43     $_url_params = array(
  44         'pos' => $pos,
  45         'dbstats' => $dbstats,
  46         'sort_by' => $sort_by,
  47         'sort_order' => $sort_order,
  48     );
  49
  50     $html .= PMA_Util::getListNavigator(
  51         $databases_count, $pos, $_url_params, 'server_databases.php',
  52         'frame_content', $GLOBALS['cfg']['MaxDbList']
  53     );
  54
  55     $_url_params['pos'] = $pos;
  56
  57     $html .= '<form class="ajax" action="server_databases.php" ';
  58     $html .= 'method="post" name="dbStatsForm" id="dbStatsForm">' . "\n";
  59     $html .= PMA_URL_getHiddenInputs($_url_params);
  60
  61     $_url_params['sort_by'] = 'SCHEMA_NAME';
  62     $_url_params['sort_order']
  63         = ($sort_by == 'SCHEMA_NAME' && $sort_order == 'asc') ? 'desc' : 'asc';
  64
  65     $html .= '<table id="tabledatabases" class="data">' . "\n"
  66         . '<thead>' . "\n"
  67         . '<tr>' . "\n";
  68
  69     $html .= PMA_getHtmlForColumnOrderWithSort(
  70         $is_superuser,
  71         $cfg['AllowUserDropDatabase'],
  72         $_url_params,
  73         $sort_by,
  74         $sort_order,
  75         $column_order,
  76         $first_database
  77     );
  78
  79     $html .= PMA_getHtmlForReplicationType(
  80         $is_superuser,
  81         $replication_types,
  82         $cfg['ActionLinksMode']
  83     );
  84
  85     $html .= '</tr>' . "\n"
  86         . '</thead>' . "\n";
  87
  88     list($output, $column_order) = PMA_getHtmlAndColumnOrderForDatabaseList(
  89         $databases,
  90         $is_superuser,
  91         $url_query,
  92         $column_order,
  93         $replication_types,
  94         $replication_info
  95     );
  96     $html .= $output;
  97     unset($output);
  98
  99     $html .= PMA_getHtmlForTableFooter(
 100         $cfg['AllowUserDropDatabase'],
 101         $is_superuser,
 102         $databases_count,
 103         $column_order,
 104         $replication_types,
 105         $first_database
 106     );
 107
 108     $html .= '</table>' . "\n";
 109
 110     $html .= PMA_getHtmlForTableFooterButtons(
 111         $cfg['AllowUserDropDatabase'],
 112         $is_superuser
 113     );
 114
 115     if (empty($dbstats)) {
 116         //we should put notice above database list
 117         $html = PMA_getHtmlForNoticeEnableStatistics($url_query, $html);
 118     }
 119     $html .= '</form>';
 120     $html .= '</div>';
 121
 122     return $html;
 123 }
 124
 125 /**
 126  * Returns the html for Table footer buttons
 127  *
 128  * @param bool $is_allowUserDropDb Allow user drop database
 129  * @param bool $is_superuser       User status
 130  *
 131  * @return string
 132  */
 133 function PMA_getHtmlForTableFooterButtons($is_allowUserDropDb, $is_superuser)
 134 {
 135     if (!$is_superuser && !$is_allowUserDropDb) {
 136         return '';
 137     }
 138
 139     $html = PMA_Util::getWithSelected(
 140         $GLOBALS['pmaThemeImage'], $GLOBALS['text_dir'], "dbStatsForm"
 141     );
 142     $html .= PMA_Util::getButtonOrImage(
 143         '',
 144         'mult_submit' . ' ajax',
 145         'drop_selected_dbs',
 146         __('Drop'), 'b_deltbl.png'
 147     );
 148
 149     return $html;
 150 }
 151
 152 /**
 153  * Returns the html for Table footer
 154  *
 155  * @param bool   $is_allowUserDropDb Allow user drop database
 156  * @param bool   $is_superuser       User status
 157  * @param int    $databases_count    Database count
 158  * @param string $column_order       column order
 159  * @param array  $replication_types  replication types
 160  * @param string $first_database     First database
 161  *
 162  * @return string
 163  */
 164 function PMA_getHtmlForTableFooter(
 165     $is_allowUserDropDb, $is_superuser,
 166     $databases_count, $column_order,
 167     $replication_types, $first_database
 168 ) {
 169     $html = '<tfoot><tr>' . "\n";
 170     if ($is_superuser || $is_allowUserDropDb) {
 171         $html .= '    <th></th>' . "\n";
 172     }
 173     $html .= '    <th>' . __('Total') . ': <span id="databases_count">'
 174         . $databases_count . '</span></th>' . "\n";
 175
 176     $html .= PMA_getHtmlForColumnOrder($column_order, $first_database);
 177
 178     foreach ($replication_types as $type) {
 179         if ($GLOBALS['replication_info'][$type]['status']) {
 180             $html .= '    <th></th>' . "\n";
 181         }
 182     }
 183
 184     if ($is_superuser) {
 185         $html .= '    <th></th>' . "\n";
 186     }
 187     $html .= '</tr>' . "\n";
 188     $html .= '</tfoot>' . "\n";
 189     return $html;
 190 }
 191
 192 /**
 193  * Returns the html for Database List and Column order
 194  *
 195  * @param array  $databases         GBI return databases
 196  * @param bool   $is_superuser      User status
 197  * @param Array  $url_query         Url query
 198  * @param string $column_order      column order
 199  * @param string $replication_types replication types
 200  * @param string $replication_info  replication info
 201  *
 202  * @return Array
 203  */
 204 function PMA_getHtmlAndColumnOrderForDatabaseList(
 205     $databases, $is_superuser, $url_query,
 206     $column_order, $replication_types, $replication_info
 207 ) {
 208     $odd_row = true;
 209     $html = '<tbody>' . "\n";
 210
 211     foreach ($databases as $current) {
 212         $tr_class = $odd_row ? 'odd' : 'even';
 213         if ($GLOBALS['dbi']->isSystemSchema($current['SCHEMA_NAME'], true)) {
 214             $tr_class .= ' noclick';
 215         }
 216         $html .= '<tr class="' . $tr_class . '">' . "\n";
 217         $odd_row = ! $odd_row;
 218
 219         list($column_order, $generated_html) = PMA_buildHtmlForDb(
 220             $current,
 221             $is_superuser,
 222             $url_query,
 223             $column_order,
 224             $replication_types,
 225             $replication_info
 226         );
 227
 228         $html .= $generated_html;
 229
 230         $html .= '</tr>' . "\n";
 231     } // end foreach ($databases as $key => $current)
 232     unset($current, $odd_row);
 233     $html .= '</tbody>';
 234     return array($html, $column_order);
 235 }
 236
 237 /**
 238  * Returns the html for Column Order
 239  *
 240  * @param array $column_order   Column order
 241  * @param array $first_database The first display database
 242  *
 243  * @return string
 244  */
 245 function PMA_getHtmlForColumnOrder($column_order, $first_database)
 246 {
 247     $html = "";
 248     // avoid execution path notice
 249     $unit = "";
 250     foreach ($column_order as $stat_name => $stat) {
 251         if (array_key_exists($stat_name, $first_database)) {
 252             if ($stat['format'] === 'byte') {
 253                 list($value, $unit)
 254                     = PMA_Util::formatByteDown($stat['footer'], 3, 1);
 255             } elseif ($stat['format'] === 'number') {
 256                 $value = PMA_Util::formatNumber($stat['footer'], 0);
 257             } else {
 258                 $value = htmlentities($stat['footer'], 0);
 259             }
 260             $html .= '    <th class="value">';
 261             if (isset($stat['description_function'])) {
 262                 $html .= '<dfn title="'
 263                     . $stat['description_function']($stat['footer']) . '">';
 264             }
 265             $html .= $value;
 266             if (isset($stat['description_function'])) {
 267                 $html .= '</dfn>';
 268             }
 269             $html .= '</th>' . "\n";
 270             if ($stat['format'] === 'byte') {
 271                 $html .= '    <th class="unit">' . $unit . '</th>' . "\n";
 272             }
 273         }
 274     }
 275
 276     return $html;
 277 }
 278
 279
 280 /**
 281  * Returns the html for Column Order with Sort
 282  *
 283  * @param bool   $is_superuser       User status
 284  * @param bool   $is_allowUserDropDb Allow user drop database
 285  * @param Array  $_url_params        Url params
 286  * @param string $sort_by            sort column name
 287  * @param string $sort_order         order
 288  * @param array  $column_order       column order
 289  * @param array  $first_database     database to show
 290  *
 291  * @return string
 292  */
 293 function PMA_getHtmlForColumnOrderWithSort(
 294     $is_superuser, $is_allowUserDropDb,
 295     $_url_params, $sort_by, $sort_order,
 296     $column_order, $first_database
 297 ) {
 298     $html = ($is_superuser || $is_allowUserDropDb
 299         ? '        <th></th>' . "\n"
 300         : '')
 301         . '    <th><a href="server_databases.php'
 302         . PMA_URL_getCommon($_url_params) . '">' . "\n"
 303         . '            ' . __('Database') . "\n"
 304         . ($sort_by == 'SCHEMA_NAME'
 305             ? '                ' . PMA_Util::getImage(
 306                 's_' . $sort_order . '.png',
 307                 ($sort_order == 'asc' ? __('Ascending') : __('Descending'))
 308             ) . "\n"
 309             : ''
 310           )
 311         . '        </a></th>' . "\n";
 312     $table_columns = 3;
 313     foreach ($column_order as $stat_name => $stat) {
 314         if (!array_key_exists($stat_name, $first_database)) {
 315             continue;
 316         }
 317
 318         if ($stat['format'] === 'byte') {
 319             $table_columns += 2;
 320             $colspan = ' colspan="2"';
 321         } else {
 322             $table_columns++;
 323             $colspan = '';
 324         }
 325         $_url_params['sort_by'] = $stat_name;
 326         $_url_params['sort_order']
 327             = ($sort_by == $stat_name && $sort_order == 'desc') ? 'asc' : 'desc';
 328         $html .= '    <th' . $colspan . '>'
 329             . '<a href="server_databases.php'
 330             . PMA_URL_getCommon($_url_params) . '">' . "\n"
 331             . '            ' . $stat['disp_name'] . "\n"
 332             . ($sort_by == $stat_name
 333                 ? '            ' . PMA_Util::getImage(
 334                     's_' . $sort_order . '.png',
 335                     ($sort_order == 'asc' ? __('Ascending') : __('Descending'))
 336                 ) . "\n"
 337                 : ''
 338               )
 339             . '        </a></th>' . "\n";
 340     }
 341     return $html;
 342 }
 343
 344
 345 /**
 346  * Returns the html for Enable Statistics
 347  *
 348  * @param bool   $url_query Url query
 349  * @param string $html      html for database list
 350  *
 351  * @return string
 352  */
 353 function PMA_getHtmlForNoticeEnableStatistics($url_query, $html)
 354 {
 355     $notice = PMA_Message::notice(
 356         __(
 357             'Note: Enabling the database statistics here might cause '
 358             . 'heavy traffic between the web server and the MySQL server.'
 359         )
 360     )->getDisplay();
 361     //we should put notice above database list
 362     $html  = $notice . $html;
 363     $html .= '<ul><li id="li_switch_dbstats"><strong>' . "\n";
 364     $html .= '<a href="server_databases.php' . $url_query . '&amp;dbstats=1"'
 365         . ' title="' . __('Enable Statistics') . '">' . "\n"
 366         . '            ' . __('Enable Statistics');
 367     $html .= '</a></strong><br />' . "\n";
 368     $html .= '</li>' . "\n" . '</ul>' . "\n";
 369
 370     return $html;
 371 }
 372
 373 /**
 374  * Returns the html for database replication types
 375  *
 376  * @param bool  $is_superuser      User status
 377  * @param Array $replication_types replication types
 378  * @param bool  $cfg_iconic        cfg about Properties Iconic
 379  *
 380  * @return string
 381  */
 382 function PMA_getHtmlForReplicationType(
 383     $is_superuser, $replication_types, $cfg_iconic
 384 ) {
 385     $html = '';
 386     foreach ($replication_types as $type) {
 387         if ($type == "master") {
 388             $name = __('Master replication');
 389         } elseif ($type == "slave") {
 390             $name = __('Slave replication');
 391         }
 392
 393         if ($GLOBALS['replication_info'][$type]['status']) {
 394             $html .= '    <th>' . $name . '</th>' . "\n";
 395         }
 396     }
 397
 398     if ($is_superuser && ! PMA_DRIZZLE) {
 399         $html .= '    <th>' . ($cfg_iconic ? '' : __('Action')) . "\n"
 400             . '    </th>' . "\n";
 401     }
 402     return $html;
 403 }
 404
 405 /**
 406  * Returns the array about $sort_order and $sort_by
 407  *
 408  * @return Array
 409  */
 410 function PMA_getListForSortDatabase()
 411 {
 412     if (empty($_REQUEST['sort_by'])) {
 413         $sort_by = 'SCHEMA_NAME';
 414     } else {
 415         $sort_by_whitelist = array(
 416             'SCHEMA_NAME',
 417             'DEFAULT_COLLATION_NAME',
 418             'SCHEMA_TABLES',
 419             'SCHEMA_TABLE_ROWS',
 420             'SCHEMA_DATA_LENGTH',
 421             'SCHEMA_INDEX_LENGTH',
 422             'SCHEMA_LENGTH',
 423             'SCHEMA_DATA_FREE'
 424         );
 425         if (in_array($_REQUEST['sort_by'], $sort_by_whitelist)) {
 426             $sort_by = $_REQUEST['sort_by'];
 427         } else {
 428             $sort_by = 'SCHEMA_NAME';
 429         }
 430     }
 431
 432     if (isset($_REQUEST['sort_order'])
 433         && /*overload*/mb_strtolower($_REQUEST['sort_order']) == 'desc'
 434     ) {
 435         $sort_order = 'desc';
 436     } else {
 437         $sort_order = 'asc';
 438     }
 439
 440     return array($sort_by, $sort_order);
 441 }
 442
 443 /**
 444  * Deal with Drops multiple databases
 445  *
 446  * @return null
 447  */
 448 function PMA_dropMultiDatabases()
 449 {
 450     if (! isset($_REQUEST['selected_dbs']) && ! isset($_REQUEST['query_type'])) {
 451         $message = PMA_Message::error(__('No databases selected.'));
 452     } else {
 453         $action = 'server_databases.php';
 454         $submit_mult = 'drop_db';
 455         $err_url = 'server_databases.php' . PMA_URL_getCommon();
 456         if (isset($_REQUEST['selected_dbs'])
 457             && !isset($_REQUEST['is_js_confirmed'])
 458         ) {
 459             $selected_db = $_REQUEST['selected_dbs'];
 460         }
 461         if (isset($_REQUEST['is_js_confirmed'])) {
 462             $_REQUEST = array(
 463                 'query_type' => $submit_mult,
 464                 'selected' => $_REQUEST['selected_dbs'],
 465                 'mult_btn' => __('Yes'),
 466                 'db' => $GLOBALS['db'],
 467                 'table' => $GLOBALS['table']);
 468         }
 469         //the following variables will be used on mult_submits.inc.php
 470         global $query_type, $selected, $mult_btn;
 471
 472         include 'libraries/mult_submits.inc.php';
 473         unset($action, $submit_mult, $err_url, $selected_db, $GLOBALS['db']);
 474         if (empty($message)) {
 475             if ($mult_btn == __('Yes')) {
 476                 $number_of_databases = count($selected);
 477             } else {
 478                 $number_of_databases = 0;
 479             }
 480             $message = PMA_Message::success(
 481                 _ngettext(
 482                     '%1$d database has been dropped successfully.',
 483                     '%1$d databases have been dropped successfully.',
 484                     $number_of_databases
 485                 )
 486             );
 487             $message->addParam($number_of_databases);
 488         }
 489     }
 490     if ($GLOBALS['is_ajax_request'] && $message instanceof PMA_Message) {
 491         $response = PMA_Response::getInstance();
 492         $response->isSuccess($message->isSuccess());
 493         $response->addJSON('message', $message);
 494         exit;
 495     }
 496 }
 497
 498 ?>