libraries/Util.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Hold the PMA\libraries\Util class
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 namespace PMA\libraries;
   9
  10 use PMA\libraries\plugins\ImportPlugin;
  11 use SqlParser\Context;
  12 use SqlParser\Lexer;
  13 use SqlParser\Parser;
  14 use SqlParser\Token;
  15 use stdClass;
  16 use SqlParser\Utils\Error as ParserError;
  17 use PMA\libraries\URL;
  18 use PMA\libraries\Sanitize;
  19 use PMA\libraries\Template;
  20
  21 if (! defined('PHPMYADMIN')) {
  22     exit;
  23 }
  24
  25 /**
  26  * Misc functions used all over the scripts.
  27  *
  28  * @package PhpMyAdmin
  29  */
  30 class Util
  31 {
  32     /**
  33      * Checks whether configuration value tells to show icons.
  34      *
  35      * @param string $value Configuration option name
  36      *
  37      * @return boolean Whether to show icons.
  38      */
  39     public static function showIcons($value)
  40     {
  41         return in_array($GLOBALS['cfg'][$value], array('icons', 'both'));
  42     }
  43
  44     /**
  45      * Checks whether configuration value tells to show text.
  46      *
  47      * @param string $value Configuration option name
  48      *
  49      * @return boolean Whether to show text.
  50      */
  51     public static function showText($value)
  52     {
  53         return in_array($GLOBALS['cfg'][$value], array('text', 'both'));
  54     }
  55
  56     /**
  57      * Returns an HTML IMG tag for a particular icon from a theme,
  58      * which may be an actual file or an icon from a sprite.
  59      * This function takes into account the ActionLinksMode
  60      * configuration setting and wraps the image tag in a span tag.
  61      *
  62      * @param string  $icon          name of icon file
  63      * @param string  $alternate     alternate text
  64      * @param boolean $force_text    whether to force alternate text to be displayed
  65      * @param boolean $menu_icon     whether this icon is for the menu bar or not
  66      * @param string  $control_param which directive controls the display
  67      *
  68      * @return string an html snippet
  69      */
  70     public static function getIcon(
  71         $icon,
  72         $alternate = '',
  73         $force_text = false,
  74         $menu_icon = false,
  75         $control_param = 'ActionLinksMode'
  76     ) {
  77         $include_icon = $include_text = false;
  78         if (self::showIcons($control_param)) {
  79             $include_icon = true;
  80         }
  81         if ($force_text
  82             || self::showText($control_param)
  83         ) {
  84             $include_text = true;
  85         }
  86         // Sometimes use a span (we rely on this in js/sql.js). But for menu bar
  87         // we don't need a span
  88         $button = $menu_icon ? '' : '<span class="nowrap">';
  89         if ($include_icon) {
  90             $button .= self::getImage($icon, $alternate);
  91         }
  92         if ($include_icon && $include_text) {
  93             $button .= '&nbsp;';
  94         }
  95         if ($include_text) {
  96             $button .= $alternate;
  97         }
  98         $button .= $menu_icon ? '' : '</span>';
  99
 100         return $button;
 101     }
 102
 103     /**
 104      * Returns an HTML IMG tag for a particular image from a theme,
 105      * which may be an actual file or an icon from a sprite
 106      *
 107      * @param string $image      The name of the file to get
 108      * @param string $alternate  Used to set 'alt' and 'title' attributes
 109      *                           of the image
 110      * @param array  $attributes An associative array of other attributes
 111      *
 112      * @return string an html IMG tag
 113      */
 114     public static function getImage($image, $alternate = '', $attributes = array())
 115     {
 116         static $sprites; // cached list of available sprites (if any)
 117         if (defined('TESTSUITE')) {
 118             // prevent caching in testsuite
 119             unset($sprites);
 120         }
 121
 122         $is_sprite = false;
 123         $alternate = htmlspecialchars($alternate);
 124
 125         // If it's the first time this function is called
 126         if (! isset($sprites)) {
 127             $sprites = array();
 128             // Try to load the list of sprites
 129             if (isset($_SESSION['PMA_Theme'])) {
 130                 $sprites = $_SESSION['PMA_Theme']->getSpriteData();
 131             }
 132         }
 133
 134         // Check if we have the requested image as a sprite
 135         //  and set $url accordingly
 136         $class = str_replace(array('.gif','.png'), '', $image);
 137         if (array_key_exists($class, $sprites)) {
 138             $is_sprite = true;
 139             $url = (defined('PMA_TEST_THEME') ? '../' : '') . 'themes/dot.gif';
 140         } elseif (isset($GLOBALS['pmaThemeImage'])) {
 141             $url = $GLOBALS['pmaThemeImage'] . $image;
 142         } else {
 143             $url = './themes/pmahomme/' . $image;
 144         }
 145
 146         // set class attribute
 147         if ($is_sprite) {
 148             if (isset($attributes['class'])) {
 149                 $attributes['class'] = "icon ic_$class " . $attributes['class'];
 150             } else {
 151                 $attributes['class'] = "icon ic_$class";
 152             }
 153         }
 154
 155         // set all other attributes
 156         $attr_str = '';
 157         foreach ($attributes as $key => $value) {
 158             if (! in_array($key, array('alt', 'title'))) {
 159                 $attr_str .= " $key=\"$value\"";
 160             }
 161         }
 162
 163         // override the alt attribute
 164         if (isset($attributes['alt'])) {
 165             $alt = $attributes['alt'];
 166         } else {
 167             $alt = $alternate;
 168         }
 169
 170         // override the title attribute
 171         if (isset($attributes['title'])) {
 172             $title = $attributes['title'];
 173         } else {
 174             $title = $alternate;
 175         }
 176
 177         // generate the IMG tag
 178         $template = '<img src="%s" title="%s" alt="%s"%s />';
 179         $retval = sprintf($template, $url, $title, $alt, $attr_str);
 180
 181         return $retval;
 182     }
 183
 184     /**
 185      * Returns the formatted maximum size for an upload
 186      *
 187      * @param integer $max_upload_size the size
 188      *
 189      * @return string the message
 190      *
 191      * @access  public
 192      */
 193     public static function getFormattedMaximumUploadSize($max_upload_size)
 194     {
 195         // I have to reduce the second parameter (sensitiveness) from 6 to 4
 196         // to avoid weird results like 512 kKib
 197         list($max_size, $max_unit) = self::formatByteDown($max_upload_size, 4);
 198         return '(' . sprintf(__('Max: %s%s'), $max_size, $max_unit) . ')';
 199     }
 200
 201     /**
 202      * Generates a hidden field which should indicate to the browser
 203      * the maximum size for upload
 204      *
 205      * @param integer $max_size the size
 206      *
 207      * @return string the INPUT field
 208      *
 209      * @access  public
 210      */
 211     public static function generateHiddenMaxFileSize($max_size)
 212     {
 213         return '<input type="hidden" name="MAX_FILE_SIZE" value="'
 214             . $max_size . '" />';
 215     }
 216
 217     /**
 218      * Add slashes before "_" and "%" characters for using them in MySQL
 219      * database, table and field names.
 220      * Note: This function does not escape backslashes!
 221      *
 222      * @param string $name the string to escape
 223      *
 224      * @return string the escaped string
 225      *
 226      * @access  public
 227      */
 228     public static function escapeMysqlWildcards($name)
 229     {
 230         return strtr($name, array('_' => '\\_', '%' => '\\%'));
 231     } // end of the 'escapeMysqlWildcards()' function
 232
 233     /**
 234      * removes slashes before "_" and "%" characters
 235      * Note: This function does not unescape backslashes!
 236      *
 237      * @param string $name the string to escape
 238      *
 239      * @return string   the escaped string
 240      *
 241      * @access  public
 242      */
 243     public static function unescapeMysqlWildcards($name)
 244     {
 245         return strtr($name, array('\\_' => '_', '\\%' => '%'));
 246     } // end of the 'unescapeMysqlWildcards()' function
 247
 248     /**
 249      * removes quotes (',",`) from a quoted string
 250      *
 251      * checks if the string is quoted and removes this quotes
 252      *
 253      * @param string $quoted_string string to remove quotes from
 254      * @param string $quote         type of quote to remove
 255      *
 256      * @return string unqoted string
 257      */
 258     public static function unQuote($quoted_string, $quote = null)
 259     {
 260         $quotes = array();
 261
 262         if ($quote === null) {
 263             $quotes[] = '`';
 264             $quotes[] = '"';
 265             $quotes[] = "'";
 266         } else {
 267             $quotes[] = $quote;
 268         }
 269
 270         foreach ($quotes as $quote) {
 271             if (mb_substr($quoted_string, 0, 1) === $quote
 272                 && mb_substr($quoted_string, -1, 1) === $quote
 273             ) {
 274                 $unquoted_string = mb_substr($quoted_string, 1, -1);
 275                 // replace escaped quotes
 276                 $unquoted_string = str_replace(
 277                     $quote . $quote,
 278                     $quote,
 279                     $unquoted_string
 280                 );
 281                 return $unquoted_string;
 282             }
 283         }
 284
 285         return $quoted_string;
 286     }
 287
 288     /**
 289      * format sql strings
 290      *
 291      * @param string  $sqlQuery raw SQL string
 292      * @param boolean $truncate truncate the query if it is too long
 293      *
 294      * @return string the formatted sql
 295      *
 296      * @global array  $cfg the configuration array
 297      *
 298      * @access  public
 299      * @todo    move into PMA_Sql
 300      */
 301     public static function formatSql($sqlQuery, $truncate = false)
 302     {
 303         global $cfg;
 304
 305         if ($truncate
 306             && mb_strlen($sqlQuery) > $cfg['MaxCharactersInDisplayedSQL']
 307         ) {
 308             $sqlQuery = mb_substr(
 309                 $sqlQuery,
 310                 0,
 311                 $cfg['MaxCharactersInDisplayedSQL']
 312             ) . '[...]';
 313         }
 314         return '<code class="sql"><pre>' . "\n"
 315             . htmlspecialchars($sqlQuery) . "\n"
 316             . '</pre></code>';
 317     } // end of the "formatSql()" function
 318
 319     /**
 320      * Displays a link to the documentation as an icon
 321      *
 322      * @param string  $link   documentation link
 323      * @param string  $target optional link target
 324      * @param boolean $bbcode optional flag indicating whether to output bbcode
 325      *
 326      * @return string the html link
 327      *
 328      * @access public
 329      */
 330     public static function showDocLink($link, $target = 'documentation', $bbcode = false)
 331     {
 332         if($bbcode){
 333             return "[a@$link@$target][dochelpicon][/a]";
 334         }else{
 335             return '<a href="' . $link . '" target="' . $target . '">'
 336                 . self::getImage('b_help.png', __('Documentation'))
 337                 . '</a>';
 338         }
 339     } // end of the 'showDocLink()' function
 340
 341     /**
 342      * Get a URL link to the official MySQL documentation
 343      *
 344      * @param string $link   contains name of page/anchor that is being linked
 345      * @param string $anchor anchor to page part
 346      *
 347      * @return string  the URL link
 348      *
 349      * @access  public
 350      */
 351     public static function getMySQLDocuURL($link, $anchor = '')
 352     {
 353         // Fixup for newly used names:
 354         $link = str_replace('_', '-', mb_strtolower($link));
 355
 356         if (empty($link)) {
 357             $link = 'index';
 358         }
 359         $mysql = '5.5';
 360         $lang = 'en';
 361         if (defined('PMA_MYSQL_INT_VERSION')) {
 362             if (PMA_MYSQL_INT_VERSION >= 50700) {
 363                 $mysql = '5.7';
 364             } elseif (PMA_MYSQL_INT_VERSION >= 50600) {
 365                 $mysql = '5.6';
 366             } elseif (PMA_MYSQL_INT_VERSION >= 50500) {
 367                 $mysql = '5.5';
 368             }
 369         }
 370         $url = 'https://dev.mysql.com/doc/refman/'
 371             . $mysql . '/' . $lang . '/' . $link . '.html';
 372         if (! empty($anchor)) {
 373             $url .= '#' . $anchor;
 374         }
 375
 376         return PMA_linkURL($url);
 377     }
 378
 379     /**
 380      * Displays a link to the official MySQL documentation
 381      *
 382      * @param string $link      contains name of page/anchor that is being linked
 383      * @param bool   $big_icon  whether to use big icon (like in left frame)
 384      * @param string $anchor    anchor to page part
 385      * @param bool   $just_open whether only the opening <a> tag should be returned
 386      *
 387      * @return string  the html link
 388      *
 389      * @access  public
 390      */
 391     public static function showMySQLDocu(
 392         $link,
 393         $big_icon = false,
 394         $anchor = '',
 395         $just_open = false
 396     ) {
 397         $url = self::getMySQLDocuURL($link, $anchor);
 398         $open_link = '<a href="' . $url . '" target="mysql_doc">';
 399         if ($just_open) {
 400             return $open_link;
 401         } elseif ($big_icon) {
 402             return $open_link
 403                 . self::getImage('b_sqlhelp.png', __('Documentation')) . '</a>';
 404         } else {
 405             return self::showDocLink($url, 'mysql_doc');
 406         }
 407     } // end of the 'showMySQLDocu()' function
 408
 409     /**
 410      * Returns link to documentation.
 411      *
 412      * @param string $page   Page in documentation
 413      * @param string $anchor Optional anchor in page
 414      *
 415      * @return string URL
 416      */
 417     public static function getDocuLink($page, $anchor = '')
 418     {
 419         /* Construct base URL */
 420         $url =  $page . '.html';
 421         if (!empty($anchor)) {
 422             $url .= '#' . $anchor;
 423         }
 424
 425         /* Check if we have built local documentation */
 426         if (defined('TESTSUITE')) {
 427             /* Provide consistent URL for testsuite */
 428             return PMA_linkURL('https://docs.phpmyadmin.net/en/latest/' . $url);
 429         } elseif (@file_exists('doc/html/index.html')) {
 430             if (defined('PMA_SETUP')) {
 431                 return '../doc/html/' . $url;
 432             } else {
 433                 return './doc/html/' . $url;
 434             }
 435         } else {
 436             /* TODO: Should link to correct branch for released versions */
 437             return PMA_linkURL('https://docs.phpmyadmin.net/en/latest/' . $url);
 438         }
 439     }
 440
 441     /**
 442      * Displays a link to the phpMyAdmin documentation
 443      *
 444      * @param string  $page   Page in documentation
 445      * @param string  $anchor Optional anchor in page
 446      * @param boolean $bbcode Optional flag indicating whether to output bbcode
 447      *
 448      * @return string  the html link
 449      *
 450      * @access  public
 451      */
 452     public static function showDocu($page, $anchor = '', $bbcode = false)
 453     {
 454         return self::showDocLink(self::getDocuLink($page, $anchor), 'documentation', $bbcode);
 455     } // end of the 'showDocu()' function
 456
 457     /**
 458      * Displays a link to the PHP documentation
 459      *
 460      * @param string $target anchor in documentation
 461      *
 462      * @return string  the html link
 463      *
 464      * @access  public
 465      */
 466     public static function showPHPDocu($target)
 467     {
 468         $url = PMA_getPHPDocLink($target);
 469
 470         return self::showDocLink($url);
 471     } // end of the 'showPHPDocu()' function
 472
 473     /**
 474      * Returns HTML code for a tooltip
 475      *
 476      * @param string $message the message for the tooltip
 477      *
 478      * @return string
 479      *
 480      * @access  public
 481      */
 482     public static function showHint($message)
 483     {
 484         if ($GLOBALS['cfg']['ShowHint']) {
 485             $classClause = ' class="pma_hint"';
 486         } else {
 487             $classClause = '';
 488         }
 489         return '<span' . $classClause . '>'
 490             . self::getImage('b_help.png')
 491             . '<span class="hide">' . $message . '</span>'
 492             . '</span>';
 493     }
 494
 495     /**
 496      * Displays a MySQL error message in the main panel when $exit is true.
 497      * Returns the error message otherwise.
 498      *
 499      * @param string|bool $server_msg     Server's error message.
 500      * @param string      $sql_query      The SQL query that failed.
 501      * @param bool        $is_modify_link Whether to show a "modify" link or not.
 502      * @param string      $back_url       URL for the "back" link (full path is
 503      *                                    not required).
 504      * @param bool        $exit           Whether execution should be stopped or
 505      *                                    the error message should be returned.
 506      *
 507      * @return string
 508      *
 509      * @global string $table The current table.
 510      * @global string $db    The current database.
 511      *
 512      * @access public
 513      */
 514     public static function mysqlDie(
 515         $server_msg = '',
 516         $sql_query = '',
 517         $is_modify_link = true,
 518         $back_url = '',
 519         $exit = true
 520     ) {
 521         global $table, $db;
 522
 523         /**
 524          * Error message to be built.
 525          * @var string $error_msg
 526          */
 527         $error_msg = '';
 528
 529         // Checking for any server errors.
 530         if (empty($server_msg)) {
 531             $server_msg = $GLOBALS['dbi']->getError();
 532         }
 533
 534         // Finding the query that failed, if not specified.
 535         if ((empty($sql_query) && (!empty($GLOBALS['sql_query'])))) {
 536             $sql_query = $GLOBALS['sql_query'];
 537         }
 538         $sql_query = trim($sql_query);
 539
 540         /**
 541          * The lexer used for analysis.
 542          * @var Lexer $lexer
 543          */
 544         $lexer = new Lexer($sql_query);
 545
 546         /**
 547          * The parser used for analysis.
 548          * @var Parser $parser
 549          */
 550         $parser = new Parser($lexer->list);
 551
 552         /**
 553          * The errors found by the lexer and the parser.
 554          * @var array $errors
 555          */
 556         $errors = ParserError::get(array($lexer, $parser));
 557
 558         if (empty($sql_query)) {
 559             $formatted_sql = '';
 560         } elseif (count($errors)) {
 561             $formatted_sql = htmlspecialchars($sql_query);
 562         } else {
 563             $formatted_sql = self::formatSql($sql_query, true);
 564         }
 565
 566         $error_msg .= '<div class="error"><h1>' . __('Error') . '</h1>';
 567
 568         // For security reasons, if the MySQL refuses the connection, the query
 569         // is hidden so no details are revealed.
 570         if ((!empty($sql_query)) && (!(mb_strstr($sql_query, 'connect')))) {
 571             // Static analysis errors.
 572             if (!empty($errors)) {
 573                 $error_msg .= '<p><strong>' . __('Static analysis:')
 574                     . '</strong></p>';
 575                 $error_msg .= '<p>' . sprintf(
 576                     __('%d errors were found during analysis.'),
 577                     count($errors)
 578                 ) . '</p>';
 579                 $error_msg .= '<p><ol>';
 580                 $error_msg .= implode(
 581                     ParserError::format(
 582                         $errors,
 583                         '<li>%2$s (near "%4$s" at position %5$d)</li>'
 584                     )
 585                 );
 586                 $error_msg .= '</ol></p>';
 587             }
 588
 589             // Display the SQL query and link to MySQL documentation.
 590             $error_msg .= '<p><strong>' . __('SQL query:') . '</strong>' . "\n";
 591             $formattedSqlToLower = mb_strtolower($formatted_sql);
 592
 593             // TODO: Show documentation for all statement types.
 594             if (mb_strstr($formattedSqlToLower, 'select')) {
 595                 // please show me help to the error on select
 596                 $error_msg .= self::showMySQLDocu('SELECT');
 597             }
 598
 599             if ($is_modify_link) {
 600                 $_url_params = array(
 601                     'sql_query' => $sql_query,
 602                     'show_query' => 1,
 603                 );
 604                 if (strlen($table) > 0) {
 605                     $_url_params['db'] = $db;
 606                     $_url_params['table'] = $table;
 607                     $doedit_goto = '<a href="tbl_sql.php'
 608                         . URL::getCommon($_url_params) . '">';
 609                 } elseif (strlen($db) > 0) {
 610                     $_url_params['db'] = $db;
 611                     $doedit_goto = '<a href="db_sql.php'
 612                         . URL::getCommon($_url_params) . '">';
 613                 } else {
 614                     $doedit_goto = '<a href="server_sql.php'
 615                         . URL::getCommon($_url_params) . '">';
 616                 }
 617
 618                 $error_msg .= $doedit_goto
 619                    . self::getIcon('b_edit.png', __('Edit'))
 620                    . '</a>';
 621             }
 622
 623             $error_msg .= '    </p>' . "\n"
 624                 . '<p>' . "\n"
 625                 . $formatted_sql . "\n"
 626                 . '</p>' . "\n";
 627         }
 628
 629         // Display server's error.
 630         if (!empty($server_msg)) {
 631             $server_msg = preg_replace(
 632                 "@((\015\012)|(\015)|(\012)){3,}@",
 633                 "\n\n",
 634                 $server_msg
 635             );
 636
 637             // Adds a link to MySQL documentation.
 638             $error_msg .= '<p>' . "\n"
 639                 . '    <strong>' . __('MySQL said: ') . '</strong>'
 640                 . self::showMySQLDocu('Error-messages-server')
 641                 . "\n"
 642                 . '</p>' . "\n";
 643
 644             // The error message will be displayed within a CODE segment.
 645             // To preserve original formatting, but allow word-wrapping,
 646             // a couple of replacements are done.
 647             // All non-single blanks and  TAB-characters are replaced with their
 648             // HTML-counterpart
 649             $server_msg = str_replace(
 650                 array('  ', "\t"),
 651                 array('&nbsp;&nbsp;', '&nbsp;&nbsp;&nbsp;&nbsp;'),
 652                 $server_msg
 653             );
 654
 655             // Replace line breaks
 656             $server_msg = nl2br($server_msg);
 657
 658             $error_msg .= '<code>' . $server_msg . '</code><br/>';
 659         }
 660
 661         $error_msg .= '</div>';
 662         $_SESSION['Import_message']['message'] = $error_msg;
 663
 664         if (!$exit) {
 665             return $error_msg;
 666         }
 667
 668         /**
 669          * If this is an AJAX request, there is no "Back" link and
 670          * `Response()` is used to send the response.
 671          */
 672         $response = Response::getInstance();
 673         if ($response->isAjax()) {
 674             $response->setRequestStatus(false);
 675             $response->addJSON('message', $error_msg);
 676             exit;
 677         }
 678
 679         if (!empty($back_url)) {
 680             if (mb_strstr($back_url, '?')) {
 681                 $back_url .= '&amp;no_history=true';
 682             } else {
 683                 $back_url .= '?no_history=true';
 684             }
 685
 686             $_SESSION['Import_message']['go_back_url'] = $back_url;
 687
 688             $error_msg .= '<fieldset class="tblFooters">'
 689                 . '[ <a href="' . $back_url . '">' . __('Back') . '</a> ]'
 690                 . '</fieldset>' . "\n\n";
 691         }
 692
 693         exit($error_msg);
 694     }
 695
 696     /**
 697      * Check the correct row count
 698      *
 699      * @param string $db    the db name
 700      * @param array  $table the table infos
 701      *
 702      * @return int $rowCount the possibly modified row count
 703      *
 704      */
 705     private static function _checkRowCount($db, $table)
 706     {
 707         $rowCount = 0;
 708
 709         if ($table['Rows'] === null) {
 710             // Do not check exact row count here,
 711             // if row count is invalid possibly the table is defect
 712             // and this would break the navigation panel;
 713             // but we can check row count if this is a view or the
 714             // information_schema database
 715             // since Table::countRecords() returns a limited row count
 716             // in this case.
 717
 718             // set this because Table::countRecords() can use it
 719             $tbl_is_view = $table['TABLE_TYPE'] == 'VIEW';
 720
 721             if ($tbl_is_view || $GLOBALS['dbi']->isSystemSchema($db)) {
 722                 $rowCount = $GLOBALS['dbi']
 723                     ->getTable($db, $table['Name'])
 724                     ->countRecords();
 725             }
 726         }
 727         return $rowCount;
 728     }
 729
 730     /**
 731      * returns array with tables of given db with extended information and grouped
 732      *
 733      * @param string   $db           name of db
 734      * @param string   $tables       name of tables
 735      * @param integer  $limit_offset list offset
 736      * @param int|bool $limit_count  max tables to return
 737      *
 738      * @return array    (recursive) grouped table list
 739      */
 740     public static function getTableList(
 741         $db,
 742         $tables = null,
 743         $limit_offset = 0,
 744         $limit_count = false
 745     ) {
 746         $sep = $GLOBALS['cfg']['NavigationTreeTableSeparator'];
 747
 748         if ($tables === null) {
 749             $tables = $GLOBALS['dbi']->getTablesFull(
 750                 $db,
 751                 '',
 752                 false,
 753                 null,
 754                 $limit_offset,
 755                 $limit_count
 756             );
 757             if ($GLOBALS['cfg']['NaturalOrder']) {
 758                 uksort($tables, 'strnatcasecmp');
 759             }
 760         }
 761
 762         if (count($tables) < 1) {
 763             return $tables;
 764         }
 765
 766         $default = array(
 767             'Name'      => '',
 768             'Rows'      => 0,
 769             'Comment'   => '',
 770             'disp_name' => '',
 771         );
 772
 773         $table_groups = array();
 774
 775         foreach ($tables as $table_name => $table) {
 776             $table['Rows'] = self::_checkRowCount($db, $table);
 777
 778             // in $group we save the reference to the place in $table_groups
 779             // where to store the table info
 780             if ($GLOBALS['cfg']['NavigationTreeEnableGrouping']
 781                 && $sep && mb_strstr($table_name, $sep)
 782             ) {
 783                 $parts = explode($sep, $table_name);
 784
 785                 $group =& $table_groups;
 786                 $i = 0;
 787                 $group_name_full = '';
 788                 $parts_cnt = count($parts) - 1;
 789
 790                 while (($i < $parts_cnt)
 791                     && ($i < $GLOBALS['cfg']['NavigationTreeTableLevel'])
 792                 ) {
 793                     $group_name = $parts[$i] . $sep;
 794                     $group_name_full .= $group_name;
 795
 796                     if (! isset($group[$group_name])) {
 797                         $group[$group_name] = array();
 798                         $group[$group_name]['is' . $sep . 'group'] = true;
 799                         $group[$group_name]['tab' . $sep . 'count'] = 1;
 800                         $group[$group_name]['tab' . $sep . 'group']
 801                             = $group_name_full;
 802
 803                     } elseif (! isset($group[$group_name]['is' . $sep . 'group'])) {
 804                         $table = $group[$group_name];
 805                         $group[$group_name] = array();
 806                         $group[$group_name][$group_name] = $table;
 807                         $group[$group_name]['is' . $sep . 'group'] = true;
 808                         $group[$group_name]['tab' . $sep . 'count'] = 1;
 809                         $group[$group_name]['tab' . $sep . 'group']
 810                             = $group_name_full;
 811
 812                     } else {
 813                         $group[$group_name]['tab' . $sep . 'count']++;
 814                     }
 815
 816                     $group =& $group[$group_name];
 817                     $i++;
 818                 }
 819
 820             } else {
 821                 if (! isset($table_groups[$table_name])) {
 822                     $table_groups[$table_name] = array();
 823                 }
 824                 $group =& $table_groups;
 825             }
 826
 827             $table['disp_name'] = $table['Name'];
 828             $group[$table_name] = array_merge($default, $table);
 829         }
 830
 831         return $table_groups;
 832     }
 833
 834     /* ----------------------- Set of misc functions ----------------------- */
 835
 836     /**
 837      * Adds backquotes on both sides of a database, table or field name.
 838      * and escapes backquotes inside the name with another backquote
 839      *
 840      * example:
 841      * <code>
 842      * echo backquote('owner`s db'); // `owner``s db`
 843      *
 844      * </code>
 845      *
 846      * @param mixed   $a_name the database, table or field name to "backquote"
 847      *                        or array of it
 848      * @param boolean $do_it  a flag to bypass this function (used by dump
 849      *                        functions)
 850      *
 851      * @return mixed    the "backquoted" database, table or field name
 852      *
 853      * @access  public
 854      */
 855     public static function backquote($a_name, $do_it = true)
 856     {
 857         if (is_array($a_name)) {
 858             foreach ($a_name as &$data) {
 859                 $data = self::backquote($data, $do_it);
 860             }
 861             return $a_name;
 862         }
 863
 864         if (! $do_it) {
 865             if (!(Context::isKeyword($a_name) & Token::FLAG_KEYWORD_RESERVED)
 866             ) {
 867                 return $a_name;
 868             }
 869         }
 870
 871         // '0' is also empty for php :-(
 872         if (strlen($a_name) > 0 && $a_name !== '*') {
 873             return '`' . str_replace('`', '``', $a_name) . '`';
 874         } else {
 875             return $a_name;
 876         }
 877     } // end of the 'backquote()' function
 878
 879     /**
 880      * Adds backquotes on both sides of a database, table or field name.
 881      * in compatibility mode
 882      *
 883      * example:
 884      * <code>
 885      * echo backquoteCompat('owner`s db'); // `owner``s db`
 886      *
 887      * </code>
 888      *
 889      * @param mixed   $a_name        the database, table or field name to
 890      *                               "backquote" or array of it
 891      * @param string  $compatibility string compatibility mode (used by dump
 892      *                               functions)
 893      * @param boolean $do_it         a flag to bypass this function (used by dump
 894      *                               functions)
 895      *
 896      * @return mixed the "backquoted" database, table or field name
 897      *
 898      * @access  public
 899      */
 900     public static function backquoteCompat(
 901         $a_name,
 902         $compatibility = 'MSSQL',
 903         $do_it = true
 904     ) {
 905         if (is_array($a_name)) {
 906             foreach ($a_name as &$data) {
 907                 $data = self::backquoteCompat($data, $compatibility, $do_it);
 908             }
 909             return $a_name;
 910         }
 911
 912         if (! $do_it) {
 913             if (!Context::isKeyword($a_name)) {
 914                 return $a_name;
 915             }
 916         }
 917
 918         // @todo add more compatibility cases (ORACLE for example)
 919         switch ($compatibility) {
 920         case 'MSSQL':
 921             $quote = '"';
 922             break;
 923         default:
 924             $quote = "`";
 925             break;
 926         }
 927
 928         // '0' is also empty for php :-(
 929         if (strlen($a_name) > 0 && $a_name !== '*') {
 930             return $quote . $a_name . $quote;
 931         } else {
 932             return $a_name;
 933         }
 934     } // end of the 'backquoteCompat()' function
 935
 936     /**
 937      * Defines the <CR><LF> value depending on the user OS.
 938      *
 939      * @return string   the <CR><LF> value to use
 940      *
 941      * @access  public
 942      */
 943     public static function whichCrlf()
 944     {
 945         // The 'PMA_USR_OS' constant is defined in "libraries/Config.php"
 946         // Win case
 947         if (PMA_USR_OS == 'Win') {
 948             $the_crlf = "\r\n";
 949         } else {
 950             // Others
 951             $the_crlf = "\n";
 952         }
 953
 954         return $the_crlf;
 955     } // end of the 'whichCrlf()' function
 956
 957     /**
 958      * Prepare the message and the query
 959      * usually the message is the result of the query executed
 960      *
 961      * @param Message|string $message   the message to display
 962      * @param string         $sql_query the query to display
 963      * @param string         $type      the type (level) of the message
 964      *
 965      * @return string
 966      *
 967      * @access  public
 968      */
 969     public static function getMessage(
 970         $message,
 971         $sql_query = null,
 972         $type = 'notice'
 973     ) {
 974         global $cfg;
 975         $retval = '';
 976
 977         if (null === $sql_query) {
 978             if (! empty($GLOBALS['display_query'])) {
 979                 $sql_query = $GLOBALS['display_query'];
 980             } elseif (! empty($GLOBALS['unparsed_sql'])) {
 981                 $sql_query = $GLOBALS['unparsed_sql'];
 982             } elseif (! empty($GLOBALS['sql_query'])) {
 983                 $sql_query = $GLOBALS['sql_query'];
 984             } else {
 985                 $sql_query = '';
 986             }
 987         }
 988
 989         $render_sql = $cfg['ShowSQL'] == true && ! empty($sql_query) && $sql_query !== ';';
 990
 991         if (isset($GLOBALS['using_bookmark_message'])) {
 992             $retval .= $GLOBALS['using_bookmark_message']->getDisplay();
 993             unset($GLOBALS['using_bookmark_message']);
 994         }
 995
 996         if ($render_sql) {
 997             $retval .= '<div class="result_query"'
 998                 . ' style="text-align: ' . $GLOBALS['cell_align_left'] . '"'
 999                 . '>' . "\n";
1000         }
1001
1002         if ($message instanceof Message) {
1003             if (isset($GLOBALS['special_message'])) {
1004                 $message->addText($GLOBALS['special_message']);
1005                 unset($GLOBALS['special_message']);
1006             }
1007             $retval .= $message->getDisplay();
1008         } else {
1009             $retval .= '<div class="' . $type . '">';
1010             $retval .= Sanitize::sanitize($message);
1011             if (isset($GLOBALS['special_message'])) {
1012                 $retval .= Sanitize::sanitize($GLOBALS['special_message']);
1013                 unset($GLOBALS['special_message']);
1014             }
1015             $retval .= '</div>';
1016         }
1017
1018         if ($render_sql) {
1019             $query_too_big = false;
1020
1021             $queryLength = mb_strlen($sql_query);
1022             if ($queryLength > $cfg['MaxCharactersInDisplayedSQL']) {
1023                 // when the query is large (for example an INSERT of binary
1024                 // data), the parser chokes; so avoid parsing the query
1025                 $query_too_big = true;
1026                 $query_base = mb_substr(
1027                     $sql_query,
1028                     0,
1029                     $cfg['MaxCharactersInDisplayedSQL']
1030                 ) . '[...]';
1031             } else {
1032                 $query_base = $sql_query;
1033             }
1034
1035             // Html format the query to be displayed
1036             // If we want to show some sql code it is easiest to create it here
1037             /* SQL-Parser-Analyzer */
1038
1039             if (! empty($GLOBALS['show_as_php'])) {
1040                 $new_line = '\\n"<br />' . "\n" . '&nbsp;&nbsp;&nbsp;&nbsp;. "';
1041                 $query_base = '$sql  = \'' . $query_base;
1042                 $query_base = '<code class="php"><pre>' . "\n"
1043                     . htmlspecialchars(addslashes($query_base));
1044                 $query_base = preg_replace(
1045                     '/((\015\012)|(\015)|(\012))/',
1046                     $new_line,
1047                     $query_base
1048                 );
1049                 $query_base = '$sql  = \'' . $query_base . '"';
1050             } elseif ($query_too_big) {
1051                 $query_base = htmlspecialchars($query_base);
1052             } else {
1053                 $query_base = self::formatSql($query_base);
1054             }
1055
1056             // Prepares links that may be displayed to edit/explain the query
1057             // (don't go to default pages, we must go to the page
1058             // where the query box is available)
1059
1060             // Basic url query part
1061             $url_params = array();
1062             if (! isset($GLOBALS['db'])) {
1063                 $GLOBALS['db'] = '';
1064             }
1065             if (strlen($GLOBALS['db']) > 0) {
1066                 $url_params['db'] = $GLOBALS['db'];
1067                 if (strlen($GLOBALS['table']) > 0) {
1068                     $url_params['table'] = $GLOBALS['table'];
1069                     $edit_link = 'tbl_sql.php';
1070                 } else {
1071                     $edit_link = 'db_sql.php';
1072                 }
1073             } else {
1074                 $edit_link = 'server_sql.php';
1075             }
1076
1077             // Want to have the query explained
1078             // but only explain a SELECT (that has not been explained)
1079             /* SQL-Parser-Analyzer */
1080             $explain_link = '';
1081             $is_select = preg_match('@^SELECT[[:space:]]+@i', $sql_query);
1082             if (! empty($cfg['SQLQuery']['Explain']) && ! $query_too_big) {
1083                 $explain_params = $url_params;
1084                 if ($is_select) {
1085                     $explain_params['sql_query'] = 'EXPLAIN ' . $sql_query;
1086                     $explain_link = ' ['
1087                         . self::linkOrButton(
1088                             'import.php' . URL::getCommon($explain_params),
1089                             __('Explain SQL')
1090                         ) . ']';
1091                 } elseif (preg_match(
1092                     '@^EXPLAIN[[:space:]]+SELECT[[:space:]]+@i',
1093                     $sql_query
1094                 )) {
1095                     $explain_params['sql_query']
1096                         = mb_substr($sql_query, 8);
1097                     $explain_link = ' ['
1098                         . self::linkOrButton(
1099                             'import.php' . URL::getCommon($explain_params),
1100                             __('Skip Explain SQL')
1101                         ) . ']';
1102                     $url = 'https://mariadb.org/explain_analyzer/analyze/'
1103                         . '?client=phpMyAdmin&raw_explain='
1104                         . urlencode(self::_generateRowQueryOutput($sql_query));
1105                     $explain_link .= ' ['
1106                         . self::linkOrButton(
1107                             htmlspecialchars('url.php?url=' . urlencode($url)),
1108                             sprintf(__('Analyze Explain at %s'), 'mariadb.org'),
1109                             array(),
1110                             true,
1111                             false,
1112                             '_blank'
1113                         ) . ']';
1114                 }
1115             } //show explain
1116
1117             $url_params['sql_query']  = $sql_query;
1118             $url_params['show_query'] = 1;
1119
1120             // even if the query is big and was truncated, offer the chance
1121             // to edit it (unless it's enormous, see linkOrButton() )
1122             if (! empty($cfg['SQLQuery']['Edit'])
1123                 && empty($GLOBALS['show_as_php'])
1124             ) {
1125                 $edit_link .= URL::getCommon($url_params) . '#querybox';
1126                 $edit_link = ' ['
1127                     . self::linkOrButton($edit_link, __('Edit'))
1128                     . ']';
1129             } else {
1130                 $edit_link = '';
1131             }
1132
1133             // Also we would like to get the SQL formed in some nice
1134             // php-code
1135             if (! empty($cfg['SQLQuery']['ShowAsPHP']) && ! $query_too_big) {
1136
1137                 if (! empty($GLOBALS['show_as_php'])) {
1138                     $php_link = ' ['
1139                         . self::linkOrButton(
1140                             'import.php' . URL::getCommon($url_params),
1141                             __('Without PHP code'),
1142                             array(),
1143                             true,
1144                             false,
1145                             '',
1146                             true
1147                         )
1148                         . ']';
1149
1150                     $php_link .= ' ['
1151                         . self::linkOrButton(
1152                             'import.php' . URL::getCommon($url_params),
1153                             __('Submit query'),
1154                             array(),
1155                             true,
1156                             false,
1157                             '',
1158                             true
1159                         )
1160                         . ']';
1161                 } else {
1162                     $php_params = $url_params;
1163                     $php_params['show_as_php'] = 1;
1164                     $_message = __('Create PHP code');
1165                     $php_link = ' ['
1166                         . self::linkOrButton(
1167                             'import.php' . URL::getCommon($php_params),
1168                             $_message
1169                         )
1170                         . ']';
1171                 }
1172             } else {
1173                 $php_link = '';
1174             } //show as php
1175
1176             // Refresh query
1177             if (! empty($cfg['SQLQuery']['Refresh'])
1178                 && ! isset($GLOBALS['show_as_php']) // 'Submit query' does the same
1179                 && preg_match('@^(SELECT|SHOW)[[:space:]]+@i', $sql_query)
1180             ) {
1181                 $refresh_link = 'import.php' . URL::getCommon($url_params);
1182                 $refresh_link = ' ['
1183                     . self::linkOrButton($refresh_link, __('Refresh')) . ']';
1184             } else {
1185                 $refresh_link = '';
1186             } //refresh
1187
1188             $retval .= '<div class="sqlOuter">';
1189             $retval .= $query_base;
1190
1191             //Clean up the end of the PHP
1192             if (! empty($GLOBALS['show_as_php'])) {
1193                 $retval .= '\';' . "\n"
1194                     . '</pre></code>';
1195             }
1196             $retval .= '</div>';
1197
1198             $retval .= '<div class="tools print_ignore">';
1199             $retval .= '<form action="sql.php" method="post">';
1200             $retval .= URL::getHiddenInputs($GLOBALS['db'], $GLOBALS['table']);
1201             $retval .= '<input type="hidden" name="sql_query" value="'
1202                 . htmlspecialchars($sql_query) . '" />';
1203
1204             // avoid displaying a Profiling checkbox that could
1205             // be checked, which would reexecute an INSERT, for example
1206             if (! empty($refresh_link) && self::profilingSupported()) {
1207                 $retval .= '<input type="hidden" name="profiling_form" value="1" />';
1208                 $retval .= Template::get('checkbox')
1209                     ->render(
1210                         array(
1211                             'html_field_name'   => 'profiling',
1212                             'label'             => __('Profiling'),
1213                             'checked'           => isset($_SESSION['profiling']),
1214                             'onclick'           => true,
1215                             'html_field_id'     => '',
1216                         )
1217                     );
1218             }
1219             $retval .= '</form>';
1220
1221             /**
1222              * TODO: Should we have $cfg['SQLQuery']['InlineEdit']?
1223              */
1224             if (! empty($cfg['SQLQuery']['Edit'])
1225                 && ! $query_too_big
1226                 && empty($GLOBALS['show_as_php'])
1227             ) {
1228                 $inline_edit_link = ' ['
1229                     . self::linkOrButton(
1230                         '#',
1231                         _pgettext('Inline edit query', 'Edit inline'),
1232                         array('class' => 'inline_edit_sql')
1233                     )
1234                     . ']';
1235             } else {
1236                 $inline_edit_link = '';
1237             }
1238             $retval .= $inline_edit_link . $edit_link . $explain_link . $php_link
1239                 . $refresh_link;
1240             $retval .= '</div>';
1241
1242             $retval .= '</div>';
1243         }
1244
1245         return $retval;
1246     } // end of the 'getMessage()' function
1247
1248     /**
1249      * Execute an EXPLAIN query and formats results similar to MySQL command line
1250      * utility.
1251      *
1252      * @param string $sqlQuery EXPLAIN query
1253      *
1254      * @return string query resuls
1255      */
1256     private static function _generateRowQueryOutput($sqlQuery)
1257     {
1258         $ret = '';
1259         $result = $GLOBALS['dbi']->query($sqlQuery);
1260         if ($result) {
1261             $devider = '+';
1262             $columnNames = '|';
1263             $fieldsMeta = $GLOBALS['dbi']->getFieldsMeta($result);
1264             foreach ($fieldsMeta as $meta) {
1265                 $devider .= '---+';
1266                 $columnNames .= ' ' . $meta->name . ' |';
1267             }
1268             $devider .= "\n";
1269
1270             $ret .= $devider . $columnNames . "\n" . $devider;
1271             while ($row = $GLOBALS['dbi']->fetchRow($result)) {
1272                 $values = '|';
1273                 foreach ($row as $value) {
1274                     if (is_null($value)) {
1275                         $value = 'NULL';
1276                     }
1277                     $values .= ' ' . $value . ' |';
1278                 }
1279                 $ret .= $values . "\n";
1280             }
1281             $ret .= $devider;
1282         }
1283         return $ret;
1284     }
1285
1286     /**
1287      * Verifies if current MySQL server supports profiling
1288      *
1289      * @access  public
1290      *
1291      * @return boolean whether profiling is supported
1292      */
1293     public static function profilingSupported()
1294     {
1295         if (!self::cacheExists('profiling_supported')) {
1296             // 5.0.37 has profiling but for example, 5.1.20 does not
1297             // (avoid a trip to the server for MySQL before 5.0.37)
1298             // and do not set a constant as we might be switching servers
1299             if (defined('PMA_MYSQL_INT_VERSION')
1300                 && $GLOBALS['dbi']->fetchValue("SELECT @@have_profiling")
1301             ) {
1302                 self::cacheSet('profiling_supported', true);
1303             } else {
1304                 self::cacheSet('profiling_supported', false);
1305             }
1306         }
1307
1308         return self::cacheGet('profiling_supported');
1309     }
1310
1311     /**
1312      * Formats $value to byte view
1313      *
1314      * @param double|int $value the value to format
1315      * @param int        $limes the sensitiveness
1316      * @param int        $comma the number of decimals to retain
1317      *
1318      * @return array    the formatted value and its unit
1319      *
1320      * @access  public
1321      */
1322     public static function formatByteDown($value, $limes = 6, $comma = 0)
1323     {
1324         if ($value === null) {
1325             return null;
1326         }
1327
1328         $byteUnits = array(
1329             /* l10n: shortcuts for Byte */
1330             __('B'),
1331             /* l10n: shortcuts for Kilobyte */
1332             __('KiB'),
1333             /* l10n: shortcuts for Megabyte */
1334             __('MiB'),
1335             /* l10n: shortcuts for Gigabyte */
1336             __('GiB'),
1337             /* l10n: shortcuts for Terabyte */
1338             __('TiB'),
1339             /* l10n: shortcuts for Petabyte */
1340             __('PiB'),
1341             /* l10n: shortcuts for Exabyte */
1342             __('EiB')
1343         );
1344
1345         $dh   = pow(10, $comma);
1346         $li   = pow(10, $limes);
1347         $unit = $byteUnits[0];
1348
1349         for ($d = 6, $ex = 15; $d >= 1; $d--, $ex-=3) {
1350             $unitSize = $li * pow(10, $ex);
1351             if (isset($byteUnits[$d]) && $value >= $unitSize) {
1352                 // use 1024.0 to avoid integer overflow on 64-bit machines
1353                 $value = round($value / (pow(1024, $d) / $dh)) /$dh;
1354                 $unit = $byteUnits[$d];
1355                 break 1;
1356             } // end if
1357         } // end for
1358
1359         if ($unit != $byteUnits[0]) {
1360             // if the unit is not bytes (as represented in current language)
1361             // reformat with max length of 5
1362             // 4th parameter=true means do not reformat if value < 1
1363             $return_value = self::formatNumber($value, 5, $comma, true);
1364         } else {
1365             // do not reformat, just handle the locale
1366             $return_value = self::formatNumber($value, 0);
1367         }
1368
1369         return array(trim($return_value), $unit);
1370     } // end of the 'formatByteDown' function
1371
1372
1373     /**
1374      * Formats $value to the given length and appends SI prefixes
1375      * with a $length of 0 no truncation occurs, number is only formatted
1376      * to the current locale
1377      *
1378      * examples:
1379      * <code>
1380      * echo formatNumber(123456789, 6);     // 123,457 k
1381      * echo formatNumber(-123456789, 4, 2); //    -123.46 M
1382      * echo formatNumber(-0.003, 6);        //      -3 m
1383      * echo formatNumber(0.003, 3, 3);      //       0.003
1384      * echo formatNumber(0.00003, 3, 2);    //       0.03 m
1385      * echo formatNumber(0, 6);             //       0
1386      * </code>
1387      *
1388      * @param double  $value          the value to format
1389      * @param integer $digits_left    number of digits left of the comma
1390      * @param integer $digits_right   number of digits right of the comma
1391      * @param boolean $only_down      do not reformat numbers below 1
1392      * @param boolean $noTrailingZero removes trailing zeros right of the comma
1393      *                                (default: true)
1394      *
1395      * @return string   the formatted value and its unit
1396      *
1397      * @access  public
1398      */
1399     public static function formatNumber(
1400         $value,
1401         $digits_left = 3,
1402         $digits_right = 0,
1403         $only_down = false,
1404         $noTrailingZero = true
1405     ) {
1406         if ($value == 0) {
1407             return '0';
1408         }
1409
1410         $originalValue = $value;
1411         //number_format is not multibyte safe, str_replace is safe
1412         if ($digits_left === 0) {
1413             $value = number_format(
1414                 $value,
1415                 $digits_right,
1416                 /* l10n: Decimal separator */
1417                 __('.'),
1418                 /* l10n: Thousands separator */
1419                 __(',')
1420             );
1421             if (($originalValue != 0) && (floatval($value) == 0)) {
1422                 $value = ' <' . (1 / pow(10, $digits_right));
1423             }
1424             return $value;
1425         }
1426
1427         // this units needs no translation, ISO
1428         $units = array(
1429             -8 => 'y',
1430             -7 => 'z',
1431             -6 => 'a',
1432             -5 => 'f',
1433             -4 => 'p',
1434             -3 => 'n',
1435             -2 => '&micro;',
1436             -1 => 'm',
1437             0 => ' ',
1438             1 => 'k',
1439             2 => 'M',
1440             3 => 'G',
1441             4 => 'T',
1442             5 => 'P',
1443             6 => 'E',
1444             7 => 'Z',
1445             8 => 'Y'
1446         );
1447
1448         // check for negative value to retain sign
1449         if ($value < 0) {
1450             $sign = '-';
1451             $value = abs($value);
1452         } else {
1453             $sign = '';
1454         }
1455
1456         $dh = pow(10, $digits_right);
1457
1458         /*
1459          * This gives us the right SI prefix already,
1460          * but $digits_left parameter not incorporated
1461          */
1462         $d = floor(log10($value) / 3);
1463         /*
1464          * Lowering the SI prefix by 1 gives us an additional 3 zeros
1465          * So if we have 3,6,9,12.. free digits ($digits_left - $cur_digits)
1466          * to use, then lower the SI prefix
1467          */
1468         $cur_digits = floor(log10($value / pow(1000, $d))+1);
1469         if ($digits_left > $cur_digits) {
1470             $d -= floor(($digits_left - $cur_digits)/3);
1471         }
1472
1473         if ($d < 0 && $only_down) {
1474             $d = 0;
1475         }
1476
1477         $value = round($value / (pow(1000, $d) / $dh)) /$dh;
1478         $unit = $units[$d];
1479
1480         // number_format is not multibyte safe, str_replace is safe
1481         $formattedValue = number_format(
1482             $value,
1483             $digits_right,
1484             /* l10n: Decimal separator */
1485             __('.'),
1486             /* l10n: Thousands separator */
1487             __(',')
1488         );
1489         // If we don't want any zeros, remove them now
1490         if ($noTrailingZero && strpos($formattedValue, '.') !== false) {
1491             $formattedValue = preg_replace('/\.?0+$/', '', $formattedValue);
1492         }
1493
1494         if ($originalValue != 0 && floatval($value) == 0) {
1495             return ' <' . number_format(
1496                 (1 / pow(10, $digits_right)),
1497                 $digits_right,
1498                 /* l10n: Decimal separator */
1499                 __('.'),
1500                 /* l10n: Thousands separator */
1501                 __(',')
1502             )
1503             . ' ' . $unit;
1504         }
1505
1506         return $sign . $formattedValue . ' ' . $unit;
1507     } // end of the 'formatNumber' function
1508
1509     /**
1510      * Returns the number of bytes when a formatted size is given
1511      *
1512      * @param string $formatted_size the size expression (for example 8MB)
1513      *
1514      * @return integer  The numerical part of the expression (for example 8)
1515      */
1516     public static function extractValueFromFormattedSize($formatted_size)
1517     {
1518         $return_value = -1;
1519
1520         if (preg_match('/^[0-9]+GB$/', $formatted_size)) {
1521             $return_value = mb_substr($formatted_size, 0, -2)
1522                 * pow(1024, 3);
1523         } elseif (preg_match('/^[0-9]+MB$/', $formatted_size)) {
1524             $return_value = mb_substr($formatted_size, 0, -2)
1525                 * pow(1024, 2);
1526         } elseif (preg_match('/^[0-9]+K$/', $formatted_size)) {
1527             $return_value = mb_substr($formatted_size, 0, -1)
1528                 * pow(1024, 1);
1529         }
1530         return $return_value;
1531     }// end of the 'extractValueFromFormattedSize' function
1532
1533     /**
1534      * Writes localised date
1535      *
1536      * @param integer $timestamp the current timestamp
1537      * @param string  $format    format
1538      *
1539      * @return string   the formatted date
1540      *
1541      * @access  public
1542      */
1543     public static function localisedDate($timestamp = -1, $format = '')
1544     {
1545         $month = array(
1546             /* l10n: Short month name */
1547             __('Jan'),
1548             /* l10n: Short month name */
1549             __('Feb'),
1550             /* l10n: Short month name */
1551             __('Mar'),
1552             /* l10n: Short month name */
1553             __('Apr'),
1554             /* l10n: Short month name */
1555             _pgettext('Short month name', 'May'),
1556             /* l10n: Short month name */
1557             __('Jun'),
1558             /* l10n: Short month name */
1559             __('Jul'),
1560             /* l10n: Short month name */
1561             __('Aug'),
1562             /* l10n: Short month name */
1563             __('Sep'),
1564             /* l10n: Short month name */
1565             __('Oct'),
1566             /* l10n: Short month name */
1567             __('Nov'),
1568             /* l10n: Short month name */
1569             __('Dec'));
1570         $day_of_week = array(
1571             /* l10n: Short week day name */
1572             _pgettext('Short week day name', 'Sun'),
1573             /* l10n: Short week day name */
1574             __('Mon'),
1575             /* l10n: Short week day name */
1576             __('Tue'),
1577             /* l10n: Short week day name */
1578             __('Wed'),
1579             /* l10n: Short week day name */
1580             __('Thu'),
1581             /* l10n: Short week day name */
1582             __('Fri'),
1583             /* l10n: Short week day name */
1584             __('Sat'));
1585
1586         if ($format == '') {
1587             /* l10n: See https://secure.php.net/manual/en/function.strftime.php */
1588             $format = __('%B %d, %Y at %I:%M %p');
1589         }
1590
1591         if ($timestamp == -1) {
1592             $timestamp = time();
1593         }
1594
1595         $date = preg_replace(
1596             '@%[aA]@',
1597             $day_of_week[(int)strftime('%w', $timestamp)],
1598             $format
1599         );
1600         $date = preg_replace(
1601             '@%[bB]@',
1602             $month[(int)strftime('%m', $timestamp)-1],
1603             $date
1604         );
1605
1606         $ret = strftime($date, $timestamp);
1607         // Some OSes such as Win8.1 Traditional Chinese version did not produce UTF-8
1608         // output here. See https://sourceforge.net/p/phpmyadmin/bugs/4207/
1609         if (mb_detect_encoding($ret, 'UTF-8', true) != 'UTF-8') {
1610             $ret = date('Y-m-d H:i:s', $timestamp);
1611         }
1612
1613         return $ret;
1614     } // end of the 'localisedDate()' function
1615
1616     /**
1617      * returns a tab for tabbed navigation.
1618      * If the variables $link and $args ar left empty, an inactive tab is created
1619      *
1620      * @param array $tab        array with all options
1621      * @param array $url_params tab specific URL parameters
1622      *
1623      * @return string  html code for one tab, a link if valid otherwise a span
1624      *
1625      * @access  public
1626      */
1627     public static function getHtmlTab($tab, $url_params = array())
1628     {
1629         // default values
1630         $defaults = array(
1631             'text'      => '',
1632             'class'     => '',
1633             'active'    => null,
1634             'link'      => '',
1635             'sep'       => '?',
1636             'attr'      => '',
1637             'args'      => '',
1638             'warning'   => '',
1639             'fragment'  => '',
1640             'id'        => '',
1641         );
1642
1643         $tab = array_merge($defaults, $tab);
1644
1645         // determine additional style-class
1646         if (empty($tab['class'])) {
1647             if (! empty($tab['active'])
1648                 || PMA_isValid($GLOBALS['active_page'], 'identical', $tab['link'])
1649             ) {
1650                 $tab['class'] = 'active';
1651             } elseif (is_null($tab['active']) && empty($GLOBALS['active_page'])
1652                 && (basename($GLOBALS['PMA_PHP_SELF']) == $tab['link'])
1653             ) {
1654                 $tab['class'] = 'active';
1655             }
1656         }
1657
1658         // If there are any tab specific URL parameters, merge those with
1659         // the general URL parameters
1660         if (! empty($tab['url_params']) && is_array($tab['url_params'])) {
1661             $url_params = array_merge($url_params, $tab['url_params']);
1662         }
1663
1664         // build the link
1665         if (! empty($tab['link'])) {
1666             $tab['link'] = htmlentities($tab['link']);
1667             $tab['link'] = $tab['link'] . URL::getCommon($url_params);
1668             if (! empty($tab['args'])) {
1669                 foreach ($tab['args'] as $param => $value) {
1670                     $tab['link'] .= URL::getArgSeparator('html')
1671                         . urlencode($param) . '=' . urlencode($value);
1672                 }
1673             }
1674         }
1675
1676         if (! empty($tab['fragment'])) {
1677             $tab['link'] .= $tab['fragment'];
1678         }
1679
1680         // display icon
1681         if (isset($tab['icon'])) {
1682             // avoid generating an alt tag, because it only illustrates
1683             // the text that follows and if browser does not display
1684             // images, the text is duplicated
1685             $tab['text'] = self::getIcon(
1686                 $tab['icon'],
1687                 $tab['text'],
1688                 false,
1689                 true,
1690                 'TabsMode'
1691             );
1692
1693         } elseif (empty($tab['text'])) {
1694             // check to not display an empty link-text
1695             $tab['text'] = '?';
1696             trigger_error(
1697                 'empty linktext in function ' . __FUNCTION__ . '()',
1698                 E_USER_NOTICE
1699             );
1700         }
1701
1702         //Set the id for the tab, if set in the params
1703         $tabId = (empty($tab['id']) ? null : $tab['id']);
1704
1705         $item = array();
1706         if (!empty($tab['link'])) {
1707             $item = array(
1708                 'content' => $tab['text'],
1709                 'url' => array(
1710                     'href' => empty($tab['link']) ? null : $tab['link'],
1711                     'id' => $tabId,
1712                     'class' => 'tab' . htmlentities($tab['class']),
1713                 ),
1714             );
1715         } else {
1716             $item['content'] = '<span class="tab' . htmlentities($tab['class']) . '"'
1717                 . $tabId . '>' . $tab['text'] . '</span>';
1718         }
1719
1720         $item['class'] = $tab['class'] == 'active' ? 'active' : '';
1721
1722         return Template::get('list/item')
1723             ->render($item);
1724     } // end of the 'getHtmlTab()' function
1725
1726     /**
1727      * returns html-code for a tab navigation
1728      *
1729      * @param array  $tabs       one element per tab
1730      * @param array  $url_params additional URL parameters
1731      * @param string $menu_id    HTML id attribute for the menu container
1732      * @param bool   $resizable  whether to add a "resizable" class
1733      *
1734      * @return string  html-code for tab-navigation
1735      */
1736     public static function getHtmlTabs(
1737         $tabs,
1738         $url_params,
1739         $menu_id,
1740         $resizable = false
1741     ) {
1742         $class = '';
1743         if ($resizable) {
1744             $class = ' class="resizable-menu"';
1745         }
1746
1747         $tab_navigation = '<div id="' . htmlentities($menu_id)
1748             . 'container" class="menucontainer">'
1749             . '<ul id="' . htmlentities($menu_id) . '" ' . $class . '>';
1750
1751         foreach ($tabs as $tab) {
1752             $tab_navigation .= self::getHtmlTab($tab, $url_params);
1753         }
1754
1755         $tab_navigation .=
1756               '<div class="clearfloat"></div>'
1757             . '</ul>' . "\n"
1758             . '</div>' . "\n";
1759
1760         return $tab_navigation;
1761     }
1762
1763     /**
1764      * Displays a link, or a button if the link's URL is too large, to
1765      * accommodate some browsers' limitations
1766      *
1767      * @param string  $url          the URL
1768      * @param string  $message      the link message
1769      * @param mixed   $tag_params   string: js confirmation
1770      *                              array: additional tag params (f.e. style="")
1771      * @param boolean $new_form     we set this to false when we are already in
1772      *                              a  form, to avoid generating nested forms
1773      * @param boolean $strip_img    whether to strip the image
1774      * @param string  $target       target
1775      * @param boolean $force_button use a button even when the URL is not too long
1776      *
1777      * @return string  the results to be echoed or saved in an array
1778      */
1779     public static function linkOrButton(
1780         $url, $message, $tag_params = array(),
1781         $new_form = true, $strip_img = false, $target = '', $force_button = false
1782     ) {
1783         $url_length = mb_strlen($url);
1784         // with this we should be able to catch case of image upload
1785         // into a (MEDIUM) BLOB; not worth generating even a form for these
1786         if ($url_length > $GLOBALS['cfg']['LinkLengthLimit'] * 100) {
1787             return '';
1788         }
1789
1790         if (! is_array($tag_params)) {
1791             $tmp = $tag_params;
1792             $tag_params = array();
1793             if (! empty($tmp)) {
1794                 $tag_params['onclick'] = 'return confirmLink(this, \''
1795                     . Sanitize::escapeJsString($tmp) . '\')';
1796             }
1797             unset($tmp);
1798         }
1799         if (! empty($target)) {
1800             $tag_params['target'] = htmlentities($target);
1801             if ($target === '_blank' && strncmp($url, 'url.php?', 8) == 0) {
1802                 $tag_params['rel'] = 'noopener noreferrer';
1803             }
1804         }
1805
1806         $displayed_message = '';
1807         // Add text if not already added
1808         if (stristr($message, '<img')
1809             && (! $strip_img || ($GLOBALS['cfg']['ActionLinksMode'] == 'icons'))
1810             && (strip_tags($message) == $message)
1811         ) {
1812             $displayed_message = '<span>'
1813                 . htmlspecialchars(
1814                     preg_replace('/^.*\salt="([^"]*)".*$/si', '\1', $message)
1815                 )
1816                 . '</span>';
1817         }
1818
1819         // Suhosin: Check that each query parameter is not above maximum
1820         $in_suhosin_limits = true;
1821         if ($url_length <= $GLOBALS['cfg']['LinkLengthLimit']) {
1822             $suhosin_get_MaxValueLength = ini_get('suhosin.get.max_value_length');
1823             if ($suhosin_get_MaxValueLength) {
1824                 $query_parts = self::splitURLQuery($url);
1825                 foreach ($query_parts as $query_pair) {
1826                     if (strpos($query_pair, '=') === false) {
1827                         continue;
1828                     }
1829
1830                     list(, $eachval) = explode('=', $query_pair);
1831                     if (mb_strlen($eachval) > $suhosin_get_MaxValueLength
1832                     ) {
1833                         $in_suhosin_limits = false;
1834                         break;
1835                     }
1836                 }
1837             }
1838         }
1839
1840         if (($url_length <= $GLOBALS['cfg']['LinkLengthLimit'])
1841             && $in_suhosin_limits
1842             && ! $force_button
1843         ) {
1844             $tag_params_strings = array();
1845             foreach ($tag_params as $par_name => $par_value) {
1846                 // htmlspecialchars() only on non javascript
1847                 $par_value = mb_substr($par_name, 0, 2) == 'on'
1848                     ? $par_value
1849                     : htmlspecialchars($par_value);
1850                 $tag_params_strings[] = $par_name . '="' . $par_value . '"';
1851             }
1852
1853             // no whitespace within an <a> else Safari will make it part of the link
1854             $ret = "\n" . '<a href="' . $url . '" '
1855                 . implode(' ', $tag_params_strings) . '>'
1856                 . $message . $displayed_message . '</a>' . "\n";
1857         } else {
1858             // no spaces (line breaks) at all
1859             // or after the hidden fields
1860             // IE will display them all
1861
1862             if (! isset($query_parts)) {
1863                 $query_parts = self::splitURLQuery($url);
1864             }
1865             $url_parts   = parse_url($url);
1866
1867             if ($new_form) {
1868                 if ($target) {
1869                     $target = ' target="' . $target . '"';
1870                 }
1871                 $ret = '<form action="' . $url_parts['path'] . '" class="link"'
1872                      . ' method="post"' . $target . ' style="display: inline;">';
1873                 $subname_open   = '';
1874                 $subname_close  = '';
1875                 $submit_link    = '#';
1876             } else {
1877                 $query_parts[] = 'redirect=' . $url_parts['path'];
1878                 if (empty($GLOBALS['subform_counter'])) {
1879                     $GLOBALS['subform_counter'] = 0;
1880                 }
1881                 $GLOBALS['subform_counter']++;
1882                 $ret            = '';
1883                 $subname_open   = 'subform[' . $GLOBALS['subform_counter'] . '][';
1884                 $subname_close  = ']';
1885                 $submit_link    = '#usesubform[' . $GLOBALS['subform_counter']
1886                     . ']=1';
1887             }
1888
1889             foreach ($query_parts as $query_pair) {
1890                 list($eachvar, $eachval) = explode('=', $query_pair);
1891                 $ret .= '<input type="hidden" name="' . $subname_open . $eachvar
1892                     . $subname_close . '" value="'
1893                     . htmlspecialchars(urldecode($eachval)) . '" />';
1894             } // end while
1895
1896             if (empty($tag_params['class'])) {
1897                 $tag_params['class'] = 'formLinkSubmit';
1898             } else {
1899                 $tag_params['class'] .= ' formLinkSubmit';
1900             }
1901
1902             $tag_params_strings = array();
1903             foreach ($tag_params as $par_name => $par_value) {
1904                 // htmlspecialchars() only on non javascript
1905                 $par_value = mb_substr($par_name, 0, 2) == 'on'
1906                     ? $par_value
1907                     : htmlspecialchars($par_value);
1908                 $tag_params_strings[] = $par_name . '="' . $par_value . '"';
1909             }
1910
1911             $ret .= "\n" . '<a href="' . $submit_link . '" '
1912                 . implode(' ', $tag_params_strings) . '>'
1913                 . $message . ' ' . $displayed_message . '</a>' . "\n";
1914
1915             if ($new_form) {
1916                 $ret .= '</form>';
1917             }
1918         } // end if... else...
1919
1920         return $ret;
1921     } // end of the 'linkOrButton()' function
1922
1923     /**
1924      * Splits a URL string by parameter
1925      *
1926      * @param string $url the URL
1927      *
1928      * @return array  the parameter/value pairs, for example [0] db=sakila
1929      */
1930     public static function splitURLQuery($url)
1931     {
1932         // decode encoded url separators
1933         $separator = URL::getArgSeparator();
1934         // on most places separator is still hard coded ...
1935         if ($separator !== '&') {
1936             // ... so always replace & with $separator
1937             $url = str_replace(htmlentities('&'), $separator, $url);
1938             $url = str_replace('&', $separator, $url);
1939         }
1940
1941         $url = str_replace(htmlentities($separator), $separator, $url);
1942         // end decode
1943
1944         $url_parts = parse_url($url);
1945
1946         if (! empty($url_parts['query'])) {
1947             return explode($separator, $url_parts['query']);
1948         } else {
1949             return array();
1950         }
1951     }
1952
1953     /**
1954      * Returns a given timespan value in a readable format.
1955      *
1956      * @param int $seconds the timespan
1957      *
1958      * @return string  the formatted value
1959      */
1960     public static function timespanFormat($seconds)
1961     {
1962         $days = floor($seconds / 86400);
1963         if ($days > 0) {
1964             $seconds -= $days * 86400;
1965         }
1966
1967         $hours = floor($seconds / 3600);
1968         if ($days > 0 || $hours > 0) {
1969             $seconds -= $hours * 3600;
1970         }
1971
1972         $minutes = floor($seconds / 60);
1973         if ($days > 0 || $hours > 0 || $minutes > 0) {
1974             $seconds -= $minutes * 60;
1975         }
1976
1977         return sprintf(
1978             __('%s days, %s hours, %s minutes and %s seconds'),
1979             (string)$days,
1980             (string)$hours,
1981             (string)$minutes,
1982             (string)$seconds
1983         );
1984     }
1985
1986     /**
1987      * Function added to avoid path disclosures.
1988      * Called by each script that needs parameters, it displays
1989      * an error message and, by default, stops the execution.
1990      *
1991      * Not sure we could use a strMissingParameter message here,
1992      * would have to check if the error message file is always available
1993      *
1994      * @param string[] $params  The names of the parameters needed by the calling
1995      *                          script
1996      * @param bool     $request Whether to include this list in checking for
1997      *                          special params
1998      *
1999      * @return void
2000      *
2001      * @global boolean $checked_special flag whether any special variable
2002      *                                       was required
2003      *
2004      * @access public
2005      */
2006     public static function checkParameters($params, $request = true)
2007     {
2008         global $checked_special;
2009
2010         if (! isset($checked_special)) {
2011             $checked_special = false;
2012         }
2013
2014         $reported_script_name = basename($GLOBALS['PMA_PHP_SELF']);
2015         $found_error = false;
2016         $error_message = '';
2017
2018         foreach ($params as $param) {
2019             if ($request && ($param != 'db') && ($param != 'table')) {
2020                 $checked_special = true;
2021             }
2022
2023             if (! isset($GLOBALS[$param])) {
2024                 $error_message .= $reported_script_name
2025                     . ': ' . __('Missing parameter:') . ' '
2026                     . $param
2027                     . self::showDocu('faq', 'faqmissingparameters',true)
2028                     . '[br]';
2029                 $found_error = true;
2030             }
2031         }
2032         if ($found_error) {
2033             PMA_fatalError($error_message);
2034         }
2035     } // end function
2036
2037     /**
2038      * Function to generate unique condition for specified row.
2039      *
2040      * @param resource       $handle               current query result
2041      * @param integer        $fields_cnt           number of fields
2042      * @param array          $fields_meta          meta information about fields
2043      * @param array          $row                  current row
2044      * @param boolean        $force_unique         generate condition only on pk
2045      *                                             or unique
2046      * @param string|boolean $restrict_to_table    restrict the unique condition
2047      *                                             to this table or false if
2048      *                                             none
2049      * @param array          $analyzed_sql_results the analyzed query
2050      *
2051      * @access public
2052      *
2053      * @return array the calculated condition and whether condition is unique
2054      */
2055     public static function getUniqueCondition(
2056         $handle, $fields_cnt, $fields_meta, $row, $force_unique = false,
2057         $restrict_to_table = false, $analyzed_sql_results = null
2058     ) {
2059         $primary_key          = '';
2060         $unique_key           = '';
2061         $nonprimary_condition = '';
2062         $preferred_condition = '';
2063         $primary_key_array    = array();
2064         $unique_key_array     = array();
2065         $nonprimary_condition_array = array();
2066         $condition_array = array();
2067
2068         for ($i = 0; $i < $fields_cnt; ++$i) {
2069
2070             $con_val     = '';
2071             $field_flags = $GLOBALS['dbi']->fieldFlags($handle, $i);
2072             $meta        = $fields_meta[$i];
2073
2074             // do not use a column alias in a condition
2075             if (! isset($meta->orgname) || strlen($meta->orgname) === 0) {
2076                 $meta->orgname = $meta->name;
2077
2078                 if (!empty($analyzed_sql_results['statement']->expr)) {
2079                     foreach ($analyzed_sql_results['statement']->expr as $expr) {
2080                         if ((empty($expr->alias)) || (empty($expr->column))) {
2081                             continue;
2082                         }
2083                         if (strcasecmp($meta->name, $expr->alias) == 0) {
2084                             $meta->orgname = $expr->column;
2085                             break;
2086                         }
2087                     }
2088                 }
2089             }
2090
2091             // Do not use a table alias in a condition.
2092             // Test case is:
2093             // select * from galerie x WHERE
2094             //(select count(*) from galerie y where y.datum=x.datum)>1
2095             //
2096             // But orgtable is present only with mysqli extension so the
2097             // fix is only for mysqli.
2098             // Also, do not use the original table name if we are dealing with
2099             // a view because this view might be updatable.
2100             // (The isView() verification should not be costly in most cases
2101             // because there is some caching in the function).
2102             if (isset($meta->orgtable)
2103                 && ($meta->table != $meta->orgtable)
2104                 && ! $GLOBALS['dbi']->getTable($GLOBALS['db'], $meta->table)->isView()
2105             ) {
2106                 $meta->table = $meta->orgtable;
2107             }
2108
2109             // If this field is not from the table which the unique clause needs
2110             // to be restricted to.
2111             if ($restrict_to_table && $restrict_to_table != $meta->table) {
2112                 continue;
2113             }
2114
2115             // to fix the bug where float fields (primary or not)
2116             // can't be matched because of the imprecision of
2117             // floating comparison, use CONCAT
2118             // (also, the syntax "CONCAT(field) IS NULL"
2119             // that we need on the next "if" will work)
2120             if ($meta->type == 'real') {
2121                 $con_key = 'CONCAT(' . self::backquote($meta->table) . '.'
2122                     . self::backquote($meta->orgname) . ')';
2123             } else {
2124                 $con_key = self::backquote($meta->table) . '.'
2125                     . self::backquote($meta->orgname);
2126             } // end if... else...
2127             $condition = ' ' . $con_key . ' ';
2128
2129             if (! isset($row[$i]) || is_null($row[$i])) {
2130                 $con_val = 'IS NULL';
2131             } else {
2132                 // timestamp is numeric on some MySQL 4.1
2133                 // for real we use CONCAT above and it should compare to string
2134                 if ($meta->numeric
2135                     && ($meta->type != 'timestamp')
2136                     && ($meta->type != 'real')
2137                 ) {
2138                     $con_val = '= ' . $row[$i];
2139                 } elseif ((($meta->type == 'blob') || ($meta->type == 'string'))
2140                     && stristr($field_flags, 'BINARY')
2141                     && ! empty($row[$i])
2142                 ) {
2143                     // hexify only if this is a true not empty BLOB or a BINARY
2144
2145                     // do not waste memory building a too big condition
2146                     if (mb_strlen($row[$i]) < 1000) {
2147                         // use a CAST if possible, to avoid problems
2148                         // if the field contains wildcard characters % or _
2149                         $con_val = '= CAST(0x' . bin2hex($row[$i]) . ' AS BINARY)';
2150                     } elseif ($fields_cnt == 1) {
2151                         // when this blob is the only field present
2152                         // try settling with length comparison
2153                         $condition = ' CHAR_LENGTH(' . $con_key . ') ';
2154                         $con_val = ' = ' .  mb_strlen($row[$i]);
2155                     } else {
2156                         // this blob won't be part of the final condition
2157                         $con_val = null;
2158                     }
2159                 } elseif (in_array($meta->type, self::getGISDatatypes())
2160                     && ! empty($row[$i])
2161                 ) {
2162                     // do not build a too big condition
2163                     if (mb_strlen($row[$i]) < 5000) {
2164                         $condition .= '=0x' . bin2hex($row[$i]) . ' AND';
2165                     } else {
2166                         $condition = '';
2167                     }
2168                 } elseif ($meta->type == 'bit') {
2169                     $con_val = "= b'"
2170                         . self::printableBitValue($row[$i], $meta->length) . "'";
2171                 } else {
2172                     $con_val = '= \''
2173                         . $GLOBALS['dbi']->escapeString($row[$i]) . '\'';
2174                 }
2175             }
2176
2177             if ($con_val != null) {
2178
2179                 $condition .= $con_val . ' AND';
2180
2181                 if ($meta->primary_key > 0) {
2182                     $primary_key .= $condition;
2183                     $primary_key_array[$con_key] = $con_val;
2184                 } elseif ($meta->unique_key > 0) {
2185                     $unique_key  .= $condition;
2186                     $unique_key_array[$con_key] = $con_val;
2187                 }
2188
2189                 $nonprimary_condition .= $condition;
2190                 $nonprimary_condition_array[$con_key] = $con_val;
2191             }
2192         } // end for
2193
2194         // Correction University of Virginia 19991216:
2195         // prefer primary or unique keys for condition,
2196         // but use conjunction of all values if no primary key
2197         $clause_is_unique = true;
2198
2199         if ($primary_key) {
2200             $preferred_condition = $primary_key;
2201             $condition_array = $primary_key_array;
2202
2203         } elseif ($unique_key) {
2204             $preferred_condition = $unique_key;
2205             $condition_array = $unique_key_array;
2206
2207         } elseif (! $force_unique) {
2208             $preferred_condition = $nonprimary_condition;
2209             $condition_array = $nonprimary_condition_array;
2210             $clause_is_unique = false;
2211         }
2212
2213         $where_clause = trim(preg_replace('|\s?AND$|', '', $preferred_condition));
2214         return(array($where_clause, $clause_is_unique, $condition_array));
2215     } // end function
2216
2217     /**
2218      * Generate the charset query part
2219      *
2220      * @param string           $collation Collation
2221      * @param boolean optional $override  force 'CHARACTER SET' keyword
2222      *
2223      * @return string
2224      */
2225     static function getCharsetQueryPart($collation, $override = false)
2226     {
2227         list($charset) = explode('_', $collation);
2228         $keyword = ' CHARSET=';
2229
2230         if ($override) {
2231             $keyword = ' CHARACTER SET ';
2232         }
2233         return $keyword . $charset
2234             . ($charset == $collation ? '' : ' COLLATE ' . $collation);
2235     }
2236
2237     /**
2238      * Generate a button or image tag
2239      *
2240      * @param string $button_name  name of button element
2241      * @param string $button_class class of button or image element
2242      * @param string $text         text to display
2243      * @param string $image        image to display
2244      * @param string $value        value
2245      *
2246      * @return string              html content
2247      *
2248      * @access  public
2249      */
2250     public static function getButtonOrImage(
2251         $button_name, $button_class, $text, $image, $value = ''
2252     ) {
2253         if ($value == '') {
2254             $value = $text;
2255         }
2256         if ($GLOBALS['cfg']['ActionLinksMode'] == 'text') {
2257             return ' <input type="submit" name="' . $button_name . '"'
2258                 . ' value="' . htmlspecialchars($value) . '"'
2259                 . ' title="' . htmlspecialchars($text) . '" />' . "\n";
2260         }
2261         return '<button class="' . $button_class . '" type="submit"'
2262             . ' name="' . $button_name . '" value="' . htmlspecialchars($value)
2263             . '" title="' . htmlspecialchars($text) . '">' . "\n"
2264             . self::getIcon($image, $text)
2265             . '</button>' . "\n";
2266     } // end function
2267
2268     /**
2269      * Generate a pagination selector for browsing resultsets
2270      *
2271      * @param string $name        The name for the request parameter
2272      * @param int    $rows        Number of rows in the pagination set
2273      * @param int    $pageNow     current page number
2274      * @param int    $nbTotalPage number of total pages
2275      * @param int    $showAll     If the number of pages is lower than this
2276      *                            variable, no pages will be omitted in pagination
2277      * @param int    $sliceStart  How many rows at the beginning should always
2278      *                            be shown?
2279      * @param int    $sliceEnd    How many rows at the end should always be shown?
2280      * @param int    $percent     Percentage of calculation page offsets to hop to a
2281      *                            next page
2282      * @param int    $range       Near the current page, how many pages should
2283      *                            be considered "nearby" and displayed as well?
2284      * @param string $prompt      The prompt to display (sometimes empty)
2285      *
2286      * @return string
2287      *
2288      * @access  public
2289      */
2290     public static function pageselector(
2291         $name, $rows, $pageNow = 1, $nbTotalPage = 1, $showAll = 200,
2292         $sliceStart = 5,
2293         $sliceEnd = 5, $percent = 20, $range = 10, $prompt = ''
2294     ) {
2295         $increment = floor($nbTotalPage / $percent);
2296         $pageNowMinusRange = ($pageNow - $range);
2297         $pageNowPlusRange = ($pageNow + $range);
2298
2299         $gotopage = $prompt . ' <select class="pageselector ajax"';
2300
2301         $gotopage .= ' name="' . $name . '" >';
2302         if ($nbTotalPage < $showAll) {
2303             $pages = range(1, $nbTotalPage);
2304         } else {
2305             $pages = array();
2306
2307             // Always show first X pages
2308             for ($i = 1; $i <= $sliceStart; $i++) {
2309                 $pages[] = $i;
2310             }
2311
2312             // Always show last X pages
2313             for ($i = $nbTotalPage - $sliceEnd; $i <= $nbTotalPage; $i++) {
2314                 $pages[] = $i;
2315             }
2316
2317             // Based on the number of results we add the specified
2318             // $percent percentage to each page number,
2319             // so that we have a representing page number every now and then to
2320             // immediately jump to specific pages.
2321             // As soon as we get near our currently chosen page ($pageNow -
2322             // $range), every page number will be shown.
2323             $i = $sliceStart;
2324             $x = $nbTotalPage - $sliceEnd;
2325             $met_boundary = false;
2326
2327             while ($i <= $x) {
2328                 if ($i >= $pageNowMinusRange && $i <= $pageNowPlusRange) {
2329                     // If our pageselector comes near the current page, we use 1
2330                     // counter increments
2331                     $i++;
2332                     $met_boundary = true;
2333                 } else {
2334                     // We add the percentage increment to our current page to
2335                     // hop to the next one in range
2336                     $i += $increment;
2337
2338                     // Make sure that we do not cross our boundaries.
2339                     if ($i > $pageNowMinusRange && ! $met_boundary) {
2340                         $i = $pageNowMinusRange;
2341                     }
2342                 }
2343
2344                 if ($i > 0 && $i <= $x) {
2345                     $pages[] = $i;
2346                 }
2347             }
2348
2349             /*
2350             Add page numbers with "geometrically increasing" distances.
2351
2352             This helps me a lot when navigating through giant tables.
2353
2354             Test case: table with 2.28 million sets, 76190 pages. Page of interest
2355             is between 72376 and 76190.
2356             Selecting page 72376.
2357             Now, old version enumerated only +/- 10 pages around 72376 and the
2358             percentage increment produced steps of about 3000.
2359
2360             The following code adds page numbers +/- 2,4,8,16,32,64,128,256 etc.
2361             around the current page.
2362             */
2363             $i = $pageNow;
2364             $dist = 1;
2365             while ($i < $x) {
2366                 $dist = 2 * $dist;
2367                 $i = $pageNow + $dist;
2368                 if ($i > 0 && $i <= $x) {
2369                     $pages[] = $i;
2370                 }
2371             }
2372
2373             $i = $pageNow;
2374             $dist = 1;
2375             while ($i > 0) {
2376                 $dist = 2 * $dist;
2377                 $i = $pageNow - $dist;
2378                 if ($i > 0 && $i <= $x) {
2379                     $pages[] = $i;
2380                 }
2381             }
2382
2383             // Since because of ellipsing of the current page some numbers may be
2384             // double, we unify our array:
2385             sort($pages);
2386             $pages = array_unique($pages);
2387         }
2388
2389         foreach ($pages as $i) {
2390             if ($i == $pageNow) {
2391                 $selected = 'selected="selected" style="font-weight: bold"';
2392             } else {
2393                 $selected = '';
2394             }
2395             $gotopage .= '                <option ' . $selected
2396                 . ' value="' . (($i - 1) * $rows) . '">' . $i . '</option>' . "\n";
2397         }
2398
2399         $gotopage .= ' </select>';
2400
2401         return $gotopage;
2402     } // end function
2403
2404     /**
2405      * Prepare navigation for a list
2406      *
2407      * @param int      $count       number of elements in the list
2408      * @param int      $pos         current position in the list
2409      * @param array    $_url_params url parameters
2410      * @param string   $script      script name for form target
2411      * @param string   $frame       target frame
2412      * @param int      $max_count   maximum number of elements to display from
2413      *                              the list
2414      * @param string   $name        the name for the request parameter
2415      * @param string[] $classes     additional classes for the container
2416      *
2417      * @return string $list_navigator_html the  html content
2418      *
2419      * @access  public
2420      *
2421      * @todo    use $pos from $_url_params
2422      */
2423     public static function getListNavigator(
2424         $count, $pos, $_url_params, $script, $frame, $max_count, $name = 'pos',
2425         $classes = array()
2426     ) {
2427
2428         $class = $frame == 'frame_navigation' ? ' class="ajax"' : '';
2429
2430         $list_navigator_html = '';
2431
2432         if ($max_count < $count) {
2433
2434             $classes[] = 'pageselector';
2435             $list_navigator_html .= '<div class="' . implode(' ', $classes) . '">';
2436
2437             if ($frame != 'frame_navigation') {
2438                 $list_navigator_html .= __('Page number:');
2439             }
2440
2441             // Move to the beginning or to the previous page
2442             if ($pos > 0) {
2443                 $caption1 = ''; $caption2 = '';
2444                 if (self::showIcons('TableNavigationLinksMode')) {
2445                     $caption1 .= '&lt;&lt; ';
2446                     $caption2 .= '&lt; ';
2447                 }
2448                 if (self::showText('TableNavigationLinksMode')) {
2449                     $caption1 .= _pgettext('First page', 'Begin');
2450                     $caption2 .= _pgettext('Previous page', 'Previous');
2451                 }
2452                 $title1 = ' title="' . _pgettext('First page', 'Begin') . '"';
2453                 $title2 = ' title="' . _pgettext('Previous page', 'Previous') . '"';
2454
2455                 $_url_params[$name] = 0;
2456                 $list_navigator_html .= '<a' . $class . $title1 . ' href="' . $script
2457                     . URL::getCommon($_url_params) . '">' . $caption1
2458                     . '</a>';
2459
2460                 $_url_params[$name] = $pos - $max_count;
2461                 $list_navigator_html .= ' <a' . $class . $title2
2462                     . ' href="' . $script . URL::getCommon($_url_params) . '">'
2463                     . $caption2 . '</a>';
2464             }
2465
2466             $list_navigator_html .= '<form action="' . basename($script)
2467                 . '" method="post">';
2468
2469             $list_navigator_html .= URL::getHiddenInputs($_url_params);
2470             $list_navigator_html .= self::pageselector(
2471                 $name,
2472                 $max_count,
2473                 floor(($pos + 1) / $max_count) + 1,
2474                 ceil($count / $max_count)
2475             );
2476             $list_navigator_html .= '</form>';
2477
2478             if ($pos + $max_count < $count) {
2479                 $caption3 = ''; $caption4 = '';
2480                 if (self::showText('TableNavigationLinksMode')) {
2481                     $caption3 .= _pgettext('Next page', 'Next');
2482                     $caption4 .= _pgettext('Last page', 'End');
2483                 }
2484                 if (self::showIcons('TableNavigationLinksMode')) {
2485                     $caption3 .= ' &gt;';
2486                     $caption4 .= ' &gt;&gt;';
2487                     if (! self::showText('TableNavigationLinksMode')) {
2488
2489                     }
2490                 }
2491                 $title3 = ' title="' . _pgettext('Next page', 'Next') . '"';
2492                 $title4 = ' title="' . _pgettext('Last page', 'End') . '"';
2493
2494                 $_url_params[$name] = $pos + $max_count;
2495                 $list_navigator_html .= '<a' . $class . $title3 . ' href="' . $script
2496                     . URL::getCommon($_url_params) . '" >' . $caption3
2497                     . '</a>';
2498
2499                 $_url_params[$name] = floor($count / $max_count) * $max_count;
2500                 if ($_url_params[$name] == $count) {
2501                     $_url_params[$name] = $count - $max_count;
2502                 }
2503
2504                 $list_navigator_html .= ' <a' . $class . $title4
2505                     . ' href="' . $script . URL::getCommon($_url_params) . '" >'
2506                     . $caption4 . '</a>';
2507             }
2508             $list_navigator_html .= '</div>' . "\n";
2509         }
2510
2511         return $list_navigator_html;
2512     }
2513
2514     /**
2515      * replaces %u in given path with current user name
2516      *
2517      * example:
2518      * <code>
2519      * $user_dir = userDir('/var/pma_tmp/%u/'); // '/var/pma_tmp/root/'
2520      *
2521      * </code>
2522      *
2523      * @param string $dir with wildcard for user
2524      *
2525      * @return string  per user directory
2526      */
2527     public static function userDir($dir)
2528     {
2529         // add trailing slash
2530         if (mb_substr($dir, -1) != '/') {
2531             $dir .= '/';
2532         }
2533
2534         return str_replace('%u', PMA_securePath($GLOBALS['cfg']['Server']['user']), $dir);
2535     }
2536
2537     /**
2538      * returns html code for db link to default db page
2539      *
2540      * @param string $database database
2541      *
2542      * @return string  html link to default db page
2543      */
2544     public static function getDbLink($database = null)
2545     {
2546         if (strlen($database) === 0) {
2547             if (strlen($GLOBALS['db']) === 0) {
2548                 return '';
2549             }
2550             $database = $GLOBALS['db'];
2551         } else {
2552             $database = self::unescapeMysqlWildcards($database);
2553         }
2554
2555         return '<a href="'
2556             . Util::getScriptNameForOption(
2557                 $GLOBALS['cfg']['DefaultTabDatabase'], 'database'
2558             )
2559             . URL::getCommon(array('db' => $database)) . '" title="'
2560             . htmlspecialchars(
2561                 sprintf(
2562                     __('Jump to database "%s".'),
2563                     $database
2564                 )
2565             )
2566             . '">' . htmlspecialchars($database) . '</a>';
2567     }
2568
2569     /**
2570      * Prepare a lightbulb hint explaining a known external bug
2571      * that affects a functionality
2572      *
2573      * @param string $functionality   localized message explaining the func.
2574      * @param string $component       'mysql' (eventually, 'php')
2575      * @param string $minimum_version of this component
2576      * @param string $bugref          bug reference for this component
2577      *
2578      * @return String
2579      */
2580     public static function getExternalBug(
2581         $functionality, $component, $minimum_version, $bugref
2582     ) {
2583         $ext_but_html = '';
2584         if (($component == 'mysql') && (PMA_MYSQL_INT_VERSION < $minimum_version)) {
2585             $ext_but_html .= self::showHint(
2586                 sprintf(
2587                     __('The %s functionality is affected by a known bug, see %s'),
2588                     $functionality,
2589                     PMA_linkURL('https://bugs.mysql.com/') . $bugref
2590                 )
2591             );
2592         }
2593         return $ext_but_html;
2594     }
2595
2596     /**
2597      * Generates a set of radio HTML fields
2598      *
2599      * @param string  $html_field_name the radio HTML field
2600      * @param array   $choices         the choices values and labels
2601      * @param string  $checked_choice  the choice to check by default
2602      * @param boolean $line_break      whether to add HTML line break after a choice
2603      * @param boolean $escape_label    whether to use htmlspecialchars() on label
2604      * @param string  $class           enclose each choice with a div of this class
2605      * @param string  $id_prefix       prefix for the id attribute, name will be
2606      *                                 used if this is not supplied
2607      *
2608      * @return string                  set of html radio fiels
2609      */
2610     public static function getRadioFields(
2611         $html_field_name, $choices, $checked_choice = '',
2612         $line_break = true, $escape_label = true, $class = '',
2613         $id_prefix = ''
2614     ) {
2615         $radio_html = '';
2616
2617         foreach ($choices as $choice_value => $choice_label) {
2618
2619             if (! empty($class)) {
2620                 $radio_html .= '<div class="' . $class . '">';
2621             }
2622
2623             if (! $id_prefix) {
2624                 $id_prefix = $html_field_name;
2625             }
2626             $html_field_id = $id_prefix . '_' . $choice_value;
2627             $radio_html .= '<input type="radio" name="' . $html_field_name . '" id="'
2628                         . $html_field_id . '" value="'
2629                         . htmlspecialchars($choice_value) . '"';
2630
2631             if ($choice_value == $checked_choice) {
2632                 $radio_html .= ' checked="checked"';
2633             }
2634
2635             $radio_html .= ' />' . "\n"
2636                         . '<label for="' . $html_field_id . '">'
2637                         . ($escape_label
2638                         ? htmlspecialchars($choice_label)
2639                         : $choice_label)
2640                         . '</label>';
2641
2642             if ($line_break) {
2643                 $radio_html .= '<br />';
2644             }
2645
2646             if (! empty($class)) {
2647                 $radio_html .= '</div>';
2648             }
2649             $radio_html .= "\n";
2650         }
2651
2652         return $radio_html;
2653     }
2654
2655     /**
2656      * Generates and returns an HTML dropdown
2657      *
2658      * @param string $select_name   name for the select element
2659      * @param array  $choices       choices values
2660      * @param string $active_choice the choice to select by default
2661      * @param string $id            id of the select element; can be different in
2662      *                              case the dropdown is present more than once
2663      *                              on the page
2664      * @param string $class         class for the select element
2665      * @param string $placeholder   Placeholder for dropdown if nothing else
2666      *                              is selected
2667      *
2668      * @return string               html content
2669      *
2670      * @todo    support titles
2671      */
2672     public static function getDropdown(
2673         $select_name, $choices, $active_choice, $id, $class = '', $placeholder = null
2674     ) {
2675         $result = '<select'
2676             . ' name="' . htmlspecialchars($select_name) . '"'
2677             . ' id="' . htmlspecialchars($id) . '"'
2678             . (! empty($class) ? ' class="' . htmlspecialchars($class) . '"' : '')
2679             . '>';
2680
2681         $resultOptions = '';
2682         $selected = false;
2683
2684         foreach ($choices as $one_choice_value => $one_choice_label) {
2685             $resultOptions .= '<option value="'
2686                 . htmlspecialchars($one_choice_value) . '"';
2687
2688             if ($one_choice_value == $active_choice) {
2689                 $resultOptions .= ' selected="selected"';
2690                 $selected = true;
2691             }
2692             $resultOptions .= '>' . htmlspecialchars($one_choice_label)
2693                 . '</option>';
2694         }
2695
2696         if (!empty($placeholder)) {
2697             $resultOptions = '<option value="" disabled="disabled"'
2698                 . ( !$selected ? ' selected="selected"' : '' )
2699                 . '>' . $placeholder . '</option>'
2700                 . $resultOptions;
2701         }
2702
2703         $result .= $resultOptions
2704             . '</select>';
2705
2706         return $result;
2707     }
2708
2709     /**
2710      * Generates a slider effect (jQjuery)
2711      * Takes care of generating the initial <div> and the link
2712      * controlling the slider; you have to generate the </div> yourself
2713      * after the sliding section.
2714      *
2715      * @param string $id      the id of the <div> on which to apply the effect
2716      * @param string $message the message to show as a link
2717      *
2718      * @return string         html div element
2719      *
2720      */
2721     public static function getDivForSliderEffect($id = '', $message = '')
2722     {
2723         return Template::get('div_for_slider_effect')->render([
2724             'id'                   => $id,
2725             'InitialSlidersState'  => $GLOBALS['cfg']['InitialSlidersState'],
2726             'message'              => $message,
2727         ]);
2728     }
2729
2730     /**
2731      * Creates an AJAX sliding toggle button
2732      * (or and equivalent form when AJAX is disabled)
2733      *
2734      * @param string $action      The URL for the request to be executed
2735      * @param string $select_name The name for the dropdown box
2736      * @param array  $options     An array of options (see rte_footer.lib.php)
2737      * @param string $callback    A JS snippet to execute when the request is
2738      *                            successfully processed
2739      *
2740      * @return string   HTML code for the toggle button
2741      */
2742     public static function toggleButton($action, $select_name, $options, $callback)
2743     {
2744         // Do the logic first
2745         $link = "$action&amp;" . urlencode($select_name) . "=";
2746         $link_on = $link . urlencode($options[1]['value']);
2747         $link_off = $link . urlencode($options[0]['value']);
2748
2749         if ($options[1]['selected'] == true) {
2750             $state = 'on';
2751         } else if ($options[0]['selected'] == true) {
2752             $state = 'off';
2753         } else {
2754             $state = 'on';
2755         }
2756
2757         return Template::get('toggle_button')->render(
2758             [
2759                 'pmaThemeImage'     => $GLOBALS['pmaThemeImage'],
2760                 'text_dir'          => $GLOBALS['text_dir'],
2761                 'link_on'           => $link_on,
2762                 'toggleOn'          => str_replace(' ', '&nbsp;', htmlspecialchars(
2763                                         $options[1]['label'])),
2764                 'toggleOff'         => str_replace(' ', '&nbsp;', htmlspecialchars(
2765                                         $options[0]['label'])),
2766                 'link_off'          => $link_off,
2767                 'callback'          => $callback,
2768                 'state'             => $state
2769             ]);
2770     } // end toggleButton()
2771
2772     /**
2773      * Clears cache content which needs to be refreshed on user change.
2774      *
2775      * @return void
2776      */
2777     public static function clearUserCache()
2778     {
2779         self::cacheUnset('is_superuser');
2780         self::cacheUnset('is_createuser');
2781         self::cacheUnset('is_grantuser');
2782     }
2783
2784     /**
2785      * Calculates session cache key
2786      *
2787      * @return string
2788      */
2789     public static function cacheKey()
2790     {
2791         if (isset($GLOBALS['cfg']['Server']['user'])) {
2792             return 'server_' . $GLOBALS['server'] . '_' . $GLOBALS['cfg']['Server']['user'];
2793         } else {
2794             return 'server_' . $GLOBALS['server'];
2795         }
2796     }
2797
2798     /**
2799      * Verifies if something is cached in the session
2800      *
2801      * @param string $var variable name
2802      *
2803      * @return boolean
2804      */
2805     public static function cacheExists($var)
2806     {
2807         return isset($_SESSION['cache'][self::cacheKey()][$var]);
2808     }
2809
2810     /**
2811      * Gets cached information from the session
2812      *
2813      * @param string   $var      variable name
2814      * @param \Closure $callback callback to fetch the value
2815      *
2816      * @return mixed
2817      */
2818     public static function cacheGet($var, $callback = null)
2819     {
2820         if (self::cacheExists($var)) {
2821             return $_SESSION['cache'][self::cacheKey()][$var];
2822         } else {
2823             if ($callback) {
2824                 $val = $callback();
2825                 self::cacheSet($var, $val);
2826                 return $val;
2827             }
2828             return null;
2829         }
2830     }
2831
2832     /**
2833      * Caches information in the session
2834      *
2835      * @param string $var variable name
2836      * @param mixed  $val value
2837      *
2838      * @return mixed
2839      */
2840     public static function cacheSet($var, $val = null)
2841     {
2842         $_SESSION['cache'][self::cacheKey()][$var] = $val;
2843     }
2844
2845     /**
2846      * Removes cached information from the session
2847      *
2848      * @param string $var variable name
2849      *
2850      * @return void
2851      */
2852     public static function cacheUnset($var)
2853     {
2854         unset($_SESSION['cache'][self::cacheKey()][$var]);
2855     }
2856
2857     /**
2858      * Converts a bit value to printable format;
2859      * in MySQL a BIT field can be from 1 to 64 bits so we need this
2860      * function because in PHP, decbin() supports only 32 bits
2861      * on 32-bit servers
2862      *
2863      * @param integer $value  coming from a BIT field
2864      * @param integer $length length
2865      *
2866      * @return string  the printable value
2867      */
2868     public static function printableBitValue($value, $length)
2869     {
2870         // if running on a 64-bit server or the length is safe for decbin()
2871         if (PHP_INT_SIZE == 8 || $length < 33) {
2872             $printable = decbin($value);
2873         } else {
2874             // FIXME: does not work for the leftmost bit of a 64-bit value
2875             $i = 0;
2876             $printable = '';
2877             while ($value >= pow(2, $i)) {
2878                 ++$i;
2879             }
2880             if ($i != 0) {
2881                 --$i;
2882             }
2883
2884             while ($i >= 0) {
2885                 if ($value - pow(2, $i) < 0) {
2886                     $printable = '0' . $printable;
2887                 } else {
2888                     $printable = '1' . $printable;
2889                     $value = $value - pow(2, $i);
2890                 }
2891                 --$i;
2892             }
2893             $printable = strrev($printable);
2894         }
2895         $printable = str_pad($printable, $length, '0', STR_PAD_LEFT);
2896         return $printable;
2897     }
2898
2899     /**
2900      * Verifies whether the value contains a non-printable character
2901      *
2902      * @param string $value value
2903      *
2904      * @return integer
2905      */
2906     public static function containsNonPrintableAscii($value)
2907     {
2908         return preg_match('@[^[:print:]]@', $value);
2909     }
2910
2911     /**
2912      * Converts a BIT type default value
2913      * for example, b'010' becomes 010
2914      *
2915      * @param string $bit_default_value value
2916      *
2917      * @return string the converted value
2918      */
2919     public static function convertBitDefaultValue($bit_default_value)
2920     {
2921         return rtrim(ltrim($bit_default_value, "b'"), "'");
2922     }
2923
2924     /**
2925      * Extracts the various parts from a column spec
2926      *
2927      * @param string $columnspec Column specification
2928      *
2929      * @return array associative array containing type, spec_in_brackets
2930      *          and possibly enum_set_values (another array)
2931      */
2932     public static function extractColumnSpec($columnspec)
2933     {
2934         $first_bracket_pos = mb_strpos($columnspec, '(');
2935         if ($first_bracket_pos) {
2936             $spec_in_brackets = chop(
2937                 mb_substr(
2938                     $columnspec,
2939                     $first_bracket_pos + 1,
2940                     mb_strrpos($columnspec, ')') - $first_bracket_pos - 1
2941                 )
2942             );
2943             // convert to lowercase just to be sure
2944             $type = mb_strtolower(
2945                 chop(mb_substr($columnspec, 0, $first_bracket_pos))
2946             );
2947         } else {
2948             // Split trailing attributes such as unsigned,
2949             // binary, zerofill and get data type name
2950             $type_parts = explode(' ', $columnspec);
2951             $type = mb_strtolower($type_parts[0]);
2952             $spec_in_brackets = '';
2953         }
2954
2955         if ('enum' == $type || 'set' == $type) {
2956             // Define our working vars
2957             $enum_set_values = self::parseEnumSetValues($columnspec, false);
2958             $printtype = $type
2959                 . '(' .  str_replace("','", "', '", $spec_in_brackets) . ')';
2960             $binary = false;
2961             $unsigned = false;
2962             $zerofill = false;
2963         } else {
2964             $enum_set_values = array();
2965
2966             /* Create printable type name */
2967             $printtype = mb_strtolower($columnspec);
2968
2969             // Strip the "BINARY" attribute, except if we find "BINARY(" because
2970             // this would be a BINARY or VARBINARY column type;
2971             // by the way, a BLOB should not show the BINARY attribute
2972             // because this is not accepted in MySQL syntax.
2973             if (preg_match('@binary@', $printtype)
2974                 && ! preg_match('@binary[\(]@', $printtype)
2975             ) {
2976                 $printtype = preg_replace('@binary@', '', $printtype);
2977                 $binary = true;
2978             } else {
2979                 $binary = false;
2980             }
2981
2982             $printtype = preg_replace(
2983                 '@zerofill@', '', $printtype, -1, $zerofill_cnt
2984             );
2985             $zerofill = ($zerofill_cnt > 0);
2986             $printtype = preg_replace(
2987                 '@unsigned@', '', $printtype, -1, $unsigned_cnt
2988             );
2989             $unsigned = ($unsigned_cnt > 0);
2990             $printtype = trim($printtype);
2991         }
2992
2993         $attribute     = ' ';
2994         if ($binary) {
2995             $attribute = 'BINARY';
2996         }
2997         if ($unsigned) {
2998             $attribute = 'UNSIGNED';
2999         }
3000         if ($zerofill) {
3001             $attribute = 'UNSIGNED ZEROFILL';
3002         }
3003
3004         $can_contain_collation = false;
3005         if (! $binary
3006             && preg_match(
3007                 "@^(char|varchar|text|tinytext|mediumtext|longtext|set|enum)@", $type
3008             )
3009         ) {
3010             $can_contain_collation = true;
3011         }
3012
3013         // for the case ENUM('&#8211;','&ldquo;')
3014         $displayed_type = htmlspecialchars($printtype);
3015         if (mb_strlen($printtype) > $GLOBALS['cfg']['LimitChars']) {
3016             $displayed_type  = '<abbr title="' . htmlspecialchars($printtype) . '">';
3017             $displayed_type .= htmlspecialchars(
3018                 mb_substr(
3019                     $printtype, 0, $GLOBALS['cfg']['LimitChars']
3020                 ) . '...'
3021             );
3022             $displayed_type .= '</abbr>';
3023         }
3024
3025         return array(
3026             'type' => $type,
3027             'spec_in_brackets' => $spec_in_brackets,
3028             'enum_set_values'  => $enum_set_values,
3029             'print_type' => $printtype,
3030             'binary' => $binary,
3031             'unsigned' => $unsigned,
3032             'zerofill' => $zerofill,
3033             'attribute' => $attribute,
3034             'can_contain_collation' => $can_contain_collation,
3035             'displayed_type' => $displayed_type
3036         );
3037     }
3038
3039     /**
3040      * Verifies if this table's engine supports foreign keys
3041      *
3042      * @param string $engine engine
3043      *
3044      * @return boolean
3045      */
3046     public static function isForeignKeySupported($engine)
3047     {
3048         $engine = strtoupper($engine);
3049         if (($engine == 'INNODB') || ($engine == 'PBXT')) {
3050             return true;
3051         } elseif ($engine == 'NDBCLUSTER' || $engine == 'NDB') {
3052             $ndbver = strtolower(
3053                 $GLOBALS['dbi']->fetchValue("SELECT @@ndb_version_string")
3054             );
3055             if (substr($ndbver, 0, 4) == 'ndb-') {
3056                 $ndbver = substr($ndbver, 4);
3057             }
3058             return version_compare($ndbver, 7.3, '>=');
3059         } else {
3060             return false;
3061         }
3062     }
3063
3064     /**
3065      * Is Foreign key check enabled?
3066      *
3067      * @return bool
3068      */
3069     public static function isForeignKeyCheck()
3070     {
3071         if ($GLOBALS['cfg']['DefaultForeignKeyChecks'] === 'enable') {
3072             return true;
3073         } else if ($GLOBALS['cfg']['DefaultForeignKeyChecks'] === 'disable') {
3074             return false;
3075         }
3076         return ($GLOBALS['dbi']->getVariable('FOREIGN_KEY_CHECKS') == 'ON');
3077     }
3078
3079     /**
3080     * Get HTML for Foreign key check checkbox
3081     *
3082     * @return string HTML for checkbox
3083     */
3084     public static function getFKCheckbox()
3085     {
3086         $checked = self::isForeignKeyCheck();
3087         $html = '<input type="hidden" name="fk_checks" value="0" />';
3088         $html .= '<input type="checkbox" name="fk_checks"'
3089             . ' id="fk_checks" value="1"'
3090             . ($checked ? ' checked="checked"' : '') . '/>';
3091         $html .= '<label for="fk_checks">' . __('Enable foreign key checks')
3092             . '</label>';
3093         return $html;
3094     }
3095
3096     /**
3097      * Handle foreign key check request
3098      *
3099      * @return bool Default foreign key checks value
3100      */
3101     public static function handleDisableFKCheckInit()
3102     {
3103         $default_fk_check_value
3104             = $GLOBALS['dbi']->getVariable('FOREIGN_KEY_CHECKS') == 'ON';
3105         if (isset($_REQUEST['fk_checks'])) {
3106             if (empty($_REQUEST['fk_checks'])) {
3107                 // Disable foreign key checks
3108                 $GLOBALS['dbi']->setVariable('FOREIGN_KEY_CHECKS', 'OFF');
3109             } else {
3110                 // Enable foreign key checks
3111                 $GLOBALS['dbi']->setVariable('FOREIGN_KEY_CHECKS', 'ON');
3112             }
3113         } // else do nothing, go with default
3114         return $default_fk_check_value;
3115     }
3116
3117     /**
3118      * Cleanup changes done for foreign key check
3119      *
3120      * @param bool $default_fk_check_value original value for 'FOREIGN_KEY_CHECKS'
3121      *
3122      * @return void
3123      */
3124     public static function handleDisableFKCheckCleanup($default_fk_check_value)
3125     {
3126         $GLOBALS['dbi']->setVariable(
3127             'FOREIGN_KEY_CHECKS', $default_fk_check_value ? 'ON' : 'OFF'
3128         );
3129     }
3130
3131     /**
3132      * Converts GIS data to Well Known Text format
3133      *
3134      * @param string $data        GIS data
3135      * @param bool   $includeSRID Add SRID to the WKT
3136      *
3137      * @return string GIS data in Well Know Text format
3138      */
3139     public static function asWKT($data, $includeSRID = false)
3140     {
3141         // Convert to WKT format
3142         $hex = bin2hex($data);
3143         $wktsql     = "SELECT ASTEXT(x'" . $hex . "')";
3144         if ($includeSRID) {
3145             $wktsql .= ", SRID(x'" . $hex . "')";
3146         }
3147
3148         $wktresult  = $GLOBALS['dbi']->tryQuery(
3149             $wktsql, null, DatabaseInterface::QUERY_STORE
3150         );
3151         $wktarr     = $GLOBALS['dbi']->fetchRow($wktresult, 0);
3152         $wktval     = $wktarr[0];
3153
3154         if ($includeSRID) {
3155             $srid = $wktarr[1];
3156             $wktval = "'" . $wktval . "'," . $srid;
3157         }
3158         @$GLOBALS['dbi']->freeResult($wktresult);
3159
3160         return $wktval;
3161     }
3162
3163     /**
3164      * If the string starts with a \r\n pair (0x0d0a) add an extra \n
3165      *
3166      * @param string $string string
3167      *
3168      * @return string with the chars replaced
3169      */
3170     public static function duplicateFirstNewline($string)
3171     {
3172         $first_occurence = mb_strpos($string, "\r\n");
3173         if ($first_occurence === 0) {
3174             $string = "\n" . $string;
3175         }
3176         return $string;
3177     }
3178
3179     /**
3180      * Get the action word corresponding to a script name
3181      * in order to display it as a title in navigation panel
3182      *
3183      * @param string $target a valid value for $cfg['NavigationTreeDefaultTabTable'],
3184      *                       $cfg['NavigationTreeDefaultTabTable2'],
3185      *                       $cfg['DefaultTabTable'] or $cfg['DefaultTabDatabase']
3186      *
3187      * @return string Title for the $cfg value
3188      */
3189     public static function getTitleForTarget($target)
3190     {
3191         $mapping = array(
3192             'structure' =>  __('Structure'),
3193             'sql' => __('SQL'),
3194             'search' =>__('Search'),
3195             'insert' =>__('Insert'),
3196             'browse' => __('Browse'),
3197             'operations' => __('Operations'),
3198
3199             // For backward compatiblity
3200
3201             // Values for $cfg['DefaultTabTable']
3202             'tbl_structure.php' =>  __('Structure'),
3203             'tbl_sql.php' => __('SQL'),
3204             'tbl_select.php' =>__('Search'),
3205             'tbl_change.php' =>__('Insert'),
3206             'sql.php' => __('Browse'),
3207             // Values for $cfg['DefaultTabDatabase']
3208             'db_structure.php' => __('Structure'),
3209             'db_sql.php' => __('SQL'),
3210             'db_search.php' => __('Search'),
3211             'db_operations.php' => __('Operations'),
3212         );
3213         return isset($mapping[$target]) ? $mapping[$target] : false;
3214     }
3215
3216     /**
3217      * Get the script name corresponding to a plain English config word
3218      * in order to append in links on navigation and main panel
3219      *
3220      * @param string $target   a valid value for
3221      *                         $cfg['NavigationTreeDefaultTabTable'],
3222      *                         $cfg['NavigationTreeDefaultTabTable2'],
3223      *                         $cfg['DefaultTabTable'], $cfg['DefaultTabDatabase'] or
3224      *                         $cfg['DefaultTabServer']
3225      * @param string $location one out of 'server', 'table', 'database'
3226      *
3227      * @return string script name corresponding to the config word
3228      */
3229     public static function getScriptNameForOption($target, $location)
3230     {
3231         if ($location == 'server') {
3232             // Values for $cfg['DefaultTabServer']
3233             switch ($target) {
3234             case 'welcome':
3235                 return 'index.php';
3236             case 'databases':
3237                 return 'server_databases.php';
3238             case 'status':
3239                 return 'server_status.php';
3240             case 'variables':
3241                 return 'server_variables.php';
3242             case 'privileges':
3243                 return 'server_privileges.php';
3244             }
3245         } elseif ($location == 'database') {
3246             // Values for $cfg['DefaultTabDatabase']
3247             switch ($target) {
3248             case 'structure':
3249                 return 'db_structure.php';
3250             case 'sql':
3251                 return 'db_sql.php';
3252             case 'search':
3253                 return 'db_search.php';
3254             case 'operations':
3255                 return 'db_operations.php';
3256             }
3257         } elseif ($location == 'table') {
3258             // Values for $cfg['DefaultTabTable'],
3259             // $cfg['NavigationTreeDefaultTabTable'] and
3260             // $cfg['NavigationTreeDefaultTabTable2']
3261             switch ($target) {
3262             case 'structure':
3263                 return 'tbl_structure.php';
3264             case 'sql':
3265                 return 'tbl_sql.php';
3266             case 'search':
3267                 return 'tbl_select.php';
3268             case 'insert':
3269                 return 'tbl_change.php';
3270             case 'browse':
3271                 return 'sql.php';
3272             }
3273         }
3274
3275         return $target;
3276     }
3277
3278     /**
3279      * Formats user string, expanding @VARIABLES@, accepting strftime format
3280      * string.
3281      *
3282      * @param string       $string  Text where to do expansion.
3283      * @param array|string $escape  Function to call for escaping variable values.
3284      *                          Can also be an array of:
3285      *                          - the escape method name
3286      *                          - the class that contains the method
3287      *                          - location of the class (for inclusion)
3288      * @param array        $updates Array with overrides for default parameters
3289      *                     (obtained from GLOBALS).
3290      *
3291      * @return string
3292      */
3293     public static function expandUserString(
3294         $string, $escape = null, $updates = array()
3295     ) {
3296         /* Content */
3297         $vars = array();
3298         $vars['http_host'] = PMA_getenv('HTTP_HOST');
3299         $vars['server_name'] = $GLOBALS['cfg']['Server']['host'];
3300         $vars['server_verbose'] = $GLOBALS['cfg']['Server']['verbose'];
3301
3302         if (empty($GLOBALS['cfg']['Server']['verbose'])) {
3303             $vars['server_verbose_or_name'] = $GLOBALS['cfg']['Server']['host'];
3304         } else {
3305             $vars['server_verbose_or_name'] = $GLOBALS['cfg']['Server']['verbose'];
3306         }
3307
3308         $vars['database'] = $GLOBALS['db'];
3309         $vars['table'] = $GLOBALS['table'];
3310         $vars['phpmyadmin_version'] = 'phpMyAdmin ' . PMA_VERSION;
3311
3312         /* Update forced variables */
3313         foreach ($updates as $key => $val) {
3314             $vars[$key] = $val;
3315         }
3316
3317         /* Replacement mapping */
3318         /*
3319          * The __VAR__ ones are for backward compatibility, because user
3320          * might still have it in cookies.
3321          */
3322         $replace = array(
3323             '@HTTP_HOST@' => $vars['http_host'],
3324             '@SERVER@' => $vars['server_name'],
3325             '__SERVER__' => $vars['server_name'],
3326             '@VERBOSE@' => $vars['server_verbose'],
3327             '@VSERVER@' => $vars['server_verbose_or_name'],
3328             '@DATABASE@' => $vars['database'],
3329             '__DB__' => $vars['database'],
3330             '@TABLE@' => $vars['table'],
3331             '__TABLE__' => $vars['table'],
3332             '@PHPMYADMIN@' => $vars['phpmyadmin_version'],
3333             );
3334
3335         /* Optional escaping */
3336         if (! is_null($escape)) {
3337             if (is_array($escape)) {
3338                 $escape_class = new $escape[1];
3339                 $escape_method = $escape[0];
3340             }
3341             foreach ($replace as $key => $val) {
3342                 if (is_array($escape)) {
3343                     $replace[$key] = $escape_class->$escape_method($val);
3344                 } else {
3345                     $replace[$key] = ($escape == 'backquote')
3346                         ? self::$escape($val)
3347                         : $escape($val);
3348                 }
3349             }
3350         }
3351
3352         /* Backward compatibility in 3.5.x */
3353         if (mb_strpos($string, '@FIELDS@') !== false) {
3354             $string = strtr($string, array('@FIELDS@' => '@COLUMNS@'));
3355         }
3356
3357         /* Fetch columns list if required */
3358         if (mb_strpos($string, '@COLUMNS@') !== false) {
3359             $columns_list = $GLOBALS['dbi']->getColumns(
3360                 $GLOBALS['db'], $GLOBALS['table']
3361             );
3362
3363             // sometimes the table no longer exists at this point
3364             if (! is_null($columns_list)) {
3365                 $column_names = array();
3366                 foreach ($columns_list as $column) {
3367                     if (! is_null($escape)) {
3368                         $column_names[] = self::$escape($column['Field']);
3369                     } else {
3370                         $column_names[] = $column['Field'];
3371                     }
3372                 }
3373                 $replace['@COLUMNS@'] = implode(',', $column_names);
3374             } else {
3375                 $replace['@COLUMNS@'] = '*';
3376             }
3377         }
3378
3379         /* Do the replacement */
3380         return strtr(strftime($string), $replace);
3381     }
3382
3383     /**
3384      * Prepare the form used to browse anywhere on the local server for a file to
3385      * import
3386      *
3387      * @param string $max_upload_size maximum upload size
3388      *
3389      * @return String
3390      */
3391     public static function getBrowseUploadFileBlock($max_upload_size)
3392     {
3393         $block_html = '';
3394
3395         if ($GLOBALS['is_upload'] && ! empty($GLOBALS['cfg']['UploadDir'])) {
3396             $block_html .= '<label for="radio_import_file">';
3397         } else {
3398             $block_html .= '<label for="input_import_file">';
3399         }
3400
3401         $block_html .= __("Browse your computer:") . '</label>'
3402             . '<div id="upload_form_status" style="display: none;"></div>'
3403             . '<div id="upload_form_status_info" style="display: none;"></div>'
3404             . '<input type="file" name="import_file" id="input_import_file" />'
3405             . self::getFormattedMaximumUploadSize($max_upload_size) . "\n"
3406             // some browsers should respect this :)
3407             . self::generateHiddenMaxFileSize($max_upload_size) . "\n";
3408
3409         return $block_html;
3410     }
3411
3412     /**
3413      * Prepare the form used to select a file to import from the server upload
3414      * directory
3415      *
3416      * @param ImportPlugin[] $import_list array of import plugins
3417      * @param string         $uploaddir   upload directory
3418      *
3419      * @return String
3420      */
3421     public static function getSelectUploadFileBlock($import_list, $uploaddir)
3422     {
3423         $block_html = '';
3424         $block_html .= '<label for="radio_local_import_file">'
3425             . sprintf(
3426                 __("Select from the web server upload directory <b>%s</b>:"),
3427                 htmlspecialchars(self::userDir($uploaddir))
3428             )
3429             . '</label>';
3430
3431         $extensions = '';
3432         foreach ($import_list as $import_plugin) {
3433             if (! empty($extensions)) {
3434                 $extensions .= '|';
3435             }
3436             $extensions .= $import_plugin->getProperties()->getExtension();
3437         }
3438
3439         $matcher = '@\.(' . $extensions . ')(\.('
3440             . PMA_supportedDecompressions() . '))?$@';
3441
3442         $active = (isset($GLOBALS['timeout_passed']) && $GLOBALS['timeout_passed']
3443             && isset($GLOBALS['local_import_file']))
3444             ? $GLOBALS['local_import_file']
3445             : '';
3446
3447         $files = PMA_getFileSelectOptions(
3448             self::userDir($uploaddir),
3449             $matcher,
3450             $active
3451         );
3452
3453         if ($files === false) {
3454             Message::error(
3455                 __('The directory you set for upload work cannot be reached.')
3456             )->display();
3457         } elseif (! empty($files)) {
3458             $block_html .= "\n"
3459                 . '    <select style="margin: 5px" size="1" '
3460                 . 'name="local_import_file" '
3461                 . 'id="select_local_import_file">' . "\n"
3462                 . '        <option value="">&nbsp;</option>' . "\n"
3463                 . $files
3464                 . '    </select>' . "\n";
3465         } elseif (empty($files)) {
3466             $block_html .= '<i>' . __('There are no files to upload!') . '</i>';
3467         }
3468
3469         return $block_html;
3470
3471     }
3472
3473     /**
3474      * Build titles and icons for action links
3475      *
3476      * @return array   the action titles
3477      */
3478     public static function buildActionTitles()
3479     {
3480         $titles = array();
3481
3482         $titles['Browse']     = self::getIcon('b_browse.png', __('Browse'));
3483         $titles['NoBrowse']   = self::getIcon('bd_browse.png', __('Browse'));
3484         $titles['Search']     = self::getIcon('b_select.png', __('Search'));
3485         $titles['NoSearch']   = self::getIcon('bd_select.png', __('Search'));
3486         $titles['Insert']     = self::getIcon('b_insrow.png', __('Insert'));
3487         $titles['NoInsert']   = self::getIcon('bd_insrow.png', __('Insert'));
3488         $titles['Structure']  = self::getIcon('b_props.png', __('Structure'));
3489         $titles['Drop']       = self::getIcon('b_drop.png', __('Drop'));
3490         $titles['NoDrop']     = self::getIcon('bd_drop.png', __('Drop'));
3491         $titles['Empty']      = self::getIcon('b_empty.png', __('Empty'));
3492         $titles['NoEmpty']    = self::getIcon('bd_empty.png', __('Empty'));
3493         $titles['Edit']       = self::getIcon('b_edit.png', __('Edit'));
3494         $titles['NoEdit']     = self::getIcon('bd_edit.png', __('Edit'));
3495         $titles['Export']     = self::getIcon('b_export.png', __('Export'));
3496         $titles['NoExport']   = self::getIcon('bd_export.png', __('Export'));
3497         $titles['Execute']    = self::getIcon('b_nextpage.png', __('Execute'));
3498         $titles['NoExecute']  = self::getIcon('bd_nextpage.png', __('Execute'));
3499         // For Favorite/NoFavorite, we need icon only.
3500         $titles['Favorite']  = self::getIcon('b_favorite.png', '');
3501         $titles['NoFavorite']= self::getIcon('b_no_favorite.png', '');
3502
3503         return $titles;
3504     }
3505
3506     /**
3507      * This function processes the datatypes supported by the DB,
3508      * as specified in Types->getColumns() and either returns an array
3509      * (useful for quickly checking if a datatype is supported)
3510      * or an HTML snippet that creates a drop-down list.
3511      *
3512      * @param bool   $html     Whether to generate an html snippet or an array
3513      * @param string $selected The value to mark as selected in HTML mode
3514      *
3515      * @return mixed   An HTML snippet or an array of datatypes.
3516      *
3517      */
3518     public static function getSupportedDatatypes($html = false, $selected = '')
3519     {
3520         if ($html) {
3521
3522             // NOTE: the SELECT tag in not included in this snippet.
3523             $retval = '';
3524
3525             foreach ($GLOBALS['PMA_Types']->getColumns() as $key => $value) {
3526                 if (is_array($value)) {
3527                     $retval .= "<optgroup label='" . htmlspecialchars($key) . "'>";
3528                     foreach ($value as $subvalue) {
3529                         if ($subvalue == $selected) {
3530                             $retval .= sprintf(
3531                                 '<option selected="selected" title="%s">%s</option>',
3532                                 $GLOBALS['PMA_Types']->getTypeDescription($subvalue),
3533                                 $subvalue
3534                             );
3535                         } else if ($subvalue === '-') {
3536                             $retval .= '<option disabled="disabled">';
3537                             $retval .= $subvalue;
3538                             $retval .= '</option>';
3539                         } else {
3540                             $retval .= sprintf(
3541                                 '<option title="%s">%s</option>',
3542                                 $GLOBALS['PMA_Types']->getTypeDescription($subvalue),
3543                                 $subvalue
3544                             );
3545                         }
3546                     }
3547                     $retval .= '</optgroup>';
3548                 } else {
3549                     if ($selected == $value) {
3550                         $retval .= sprintf(
3551                             '<option selected="selected" title="%s">%s</option>',
3552                             $GLOBALS['PMA_Types']->getTypeDescription($value),
3553                             $value
3554                         );
3555                     } else {
3556                         $retval .= sprintf(
3557                             '<option title="%s">%s</option>',
3558                             $GLOBALS['PMA_Types']->getTypeDescription($value),
3559                             $value
3560                         );
3561                     }
3562                 }
3563             }
3564         } else {
3565             $retval = array();
3566             foreach ($GLOBALS['PMA_Types']->getColumns() as $value) {
3567                 if (is_array($value)) {
3568                     foreach ($value as $subvalue) {
3569                         if ($subvalue !== '-') {
3570                             $retval[] = $subvalue;
3571                         }
3572                     }
3573                 } else {
3574                     if ($value !== '-') {
3575                         $retval[] = $value;
3576                     }
3577                 }
3578             }
3579         }
3580
3581         return $retval;
3582     } // end getSupportedDatatypes()
3583
3584     /**
3585      * Returns a list of datatypes that are not (yet) handled by PMA.
3586      * Used by: tbl_change.php and libraries/db_routines.inc.php
3587      *
3588      * @return array   list of datatypes
3589      */
3590     public static function unsupportedDatatypes()
3591     {
3592         $no_support_types = array();
3593         return $no_support_types;
3594     }
3595
3596     /**
3597      * Return GIS data types
3598      *
3599      * @param bool $upper_case whether to return values in upper case
3600      *
3601      * @return string[] GIS data types
3602      */
3603     public static function getGISDatatypes($upper_case = false)
3604     {
3605         $gis_data_types = array(
3606             'geometry',
3607             'point',
3608             'linestring',
3609             'polygon',
3610             'multipoint',
3611             'multilinestring',
3612             'multipolygon',
3613             'geometrycollection'
3614         );
3615         if ($upper_case) {
3616             for ($i = 0, $nb = count($gis_data_types); $i < $nb; $i++) {
3617                 $gis_data_types[$i]
3618                     = mb_strtoupper($gis_data_types[$i]);
3619             }
3620         }
3621         return $gis_data_types;
3622     }
3623
3624     /**
3625      * Generates GIS data based on the string passed.
3626      *
3627      * @param string $gis_string GIS string
3628      *
3629      * @return string GIS data enclosed in 'GeomFromText' function
3630      */
3631     public static function createGISData($gis_string)
3632     {
3633         $gis_string = trim($gis_string);
3634         $geom_types = '(POINT|MULTIPOINT|LINESTRING|MULTILINESTRING|'
3635             . 'POLYGON|MULTIPOLYGON|GEOMETRYCOLLECTION)';
3636         if (preg_match("/^'" . $geom_types . "\(.*\)',[0-9]*$/i", $gis_string)) {
3637             return 'GeomFromText(' . $gis_string . ')';
3638         } elseif (preg_match("/^" . $geom_types . "\(.*\)$/i", $gis_string)) {
3639             return "GeomFromText('" . $gis_string . "')";
3640         } else {
3641             return $gis_string;
3642         }
3643     }
3644
3645     /**
3646      * Returns the names and details of the functions
3647      * that can be applied on geometry data types.
3648      *
3649      * @param string $geom_type if provided the output is limited to the functions
3650      *                          that are applicable to the provided geometry type.
3651      * @param bool   $binary    if set to false functions that take two geometries
3652      *                          as arguments will not be included.
3653      * @param bool   $display   if set to true separators will be added to the
3654      *                          output array.
3655      *
3656      * @return array names and details of the functions that can be applied on
3657      *               geometry data types.
3658      */
3659     public static function getGISFunctions(
3660         $geom_type = null, $binary = true, $display = false
3661     ) {
3662         $funcs = array();
3663         if ($display) {
3664             $funcs[] = array('display' => ' ');
3665         }
3666
3667         // Unary functions common to all geometry types
3668         $funcs['Dimension']    = array('params' => 1, 'type' => 'int');
3669         $funcs['Envelope']     = array('params' => 1, 'type' => 'Polygon');
3670         $funcs['GeometryType'] = array('params' => 1, 'type' => 'text');
3671         $funcs['SRID']         = array('params' => 1, 'type' => 'int');
3672         $funcs['IsEmpty']      = array('params' => 1, 'type' => 'int');
3673         $funcs['IsSimple']     = array('params' => 1, 'type' => 'int');
3674
3675         $geom_type = trim(mb_strtolower($geom_type));
3676         if ($display && $geom_type != 'geometry' && $geom_type != 'multipoint') {
3677             $funcs[] = array('display' => '--------');
3678         }
3679
3680         // Unary functions that are specific to each geometry type
3681         if ($geom_type == 'point') {
3682             $funcs['X'] = array('params' => 1, 'type' => 'float');
3683             $funcs['Y'] = array('params' => 1, 'type' => 'float');
3684
3685         } elseif ($geom_type == 'multipoint') {
3686             // no functions here
3687         } elseif ($geom_type == 'linestring') {
3688             $funcs['EndPoint']   = array('params' => 1, 'type' => 'point');
3689             $funcs['GLength']    = array('params' => 1, 'type' => 'float');
3690             $funcs['NumPoints']  = array('params' => 1, 'type' => 'int');
3691             $funcs['StartPoint'] = array('params' => 1, 'type' => 'point');
3692             $funcs['IsRing']     = array('params' => 1, 'type' => 'int');
3693
3694         } elseif ($geom_type == 'multilinestring') {
3695             $funcs['GLength']  = array('params' => 1, 'type' => 'float');
3696             $funcs['IsClosed'] = array('params' => 1, 'type' => 'int');
3697
3698         } elseif ($geom_type == 'polygon') {
3699             $funcs['Area']         = array('params' => 1, 'type' => 'float');
3700             $funcs['ExteriorRing'] = array('params' => 1, 'type' => 'linestring');
3701             $funcs['NumInteriorRings'] = array('params' => 1, 'type' => 'int');
3702
3703         } elseif ($geom_type == 'multipolygon') {
3704             $funcs['Area']     = array('params' => 1, 'type' => 'float');
3705             $funcs['Centroid'] = array('params' => 1, 'type' => 'point');
3706             // Not yet implemented in MySQL
3707             //$funcs['PointOnSurface'] = array('params' => 1, 'type' => 'point');
3708
3709         } elseif ($geom_type == 'geometrycollection') {
3710             $funcs['NumGeometries'] = array('params' => 1, 'type' => 'int');
3711         }
3712
3713         // If we are asked for binary functions as well
3714         if ($binary) {
3715             // section separator
3716             if ($display) {
3717                 $funcs[] = array('display' => '--------');
3718             }
3719
3720             if (PMA_MYSQL_INT_VERSION < 50601) {
3721                 $funcs['Crosses']    = array('params' => 2, 'type' => 'int');
3722                 $funcs['Contains']   = array('params' => 2, 'type' => 'int');
3723                 $funcs['Disjoint']   = array('params' => 2, 'type' => 'int');
3724                 $funcs['Equals']     = array('params' => 2, 'type' => 'int');
3725                 $funcs['Intersects'] = array('params' => 2, 'type' => 'int');
3726                 $funcs['Overlaps']   = array('params' => 2, 'type' => 'int');
3727                 $funcs['Touches']    = array('params' => 2, 'type' => 'int');
3728                 $funcs['Within']     = array('params' => 2, 'type' => 'int');
3729             } else {
3730                 // If MySQl version is greater than or equal 5.6.1,
3731                 // use the ST_ prefix.
3732                 $funcs['ST_Crosses']    = array('params' => 2, 'type' => 'int');
3733                 $funcs['ST_Contains']   = array('params' => 2, 'type' => 'int');
3734                 $funcs['ST_Disjoint']   = array('params' => 2, 'type' => 'int');
3735                 $funcs['ST_Equals']     = array('params' => 2, 'type' => 'int');
3736                 $funcs['ST_Intersects'] = array('params' => 2, 'type' => 'int');
3737                 $funcs['ST_Overlaps']   = array('params' => 2, 'type' => 'int');
3738                 $funcs['ST_Touches']    = array('params' => 2, 'type' => 'int');
3739                 $funcs['ST_Within']     = array('params' => 2, 'type' => 'int');
3740             }
3741
3742             if ($display) {
3743                 $funcs[] = array('display' => '--------');
3744             }
3745             // Minimum bounding rectangle functions
3746             $funcs['MBRContains']   = array('params' => 2, 'type' => 'int');
3747             $funcs['MBRDisjoint']   = array('params' => 2, 'type' => 'int');
3748             $funcs['MBREquals']     = array('params' => 2, 'type' => 'int');
3749             $funcs['MBRIntersects'] = array('params' => 2, 'type' => 'int');
3750             $funcs['MBROverlaps']   = array('params' => 2, 'type' => 'int');
3751             $funcs['MBRTouches']    = array('params' => 2, 'type' => 'int');
3752             $funcs['MBRWithin']     = array('params' => 2, 'type' => 'int');
3753         }
3754         return $funcs;
3755     }
3756
3757     /**
3758      * Returns default function for a particular column.
3759      *
3760      * @param array $field       Data about the column for which
3761      *                           to generate the dropdown
3762      * @param bool  $insert_mode Whether the operation is 'insert'
3763      *
3764      * @global   array    $cfg            PMA configuration
3765      * @global   mixed    $data           data of currently edited row
3766      *                                    (used to detect whether to choose defaults)
3767      *
3768      * @return string   An HTML snippet of a dropdown list with function
3769      *                    names appropriate for the requested column.
3770      */
3771     public static function getDefaultFunctionForField($field, $insert_mode)
3772     {
3773         /*
3774          * @todo Except for $cfg, no longer use globals but pass as parameters
3775          *       from higher levels
3776          */
3777         global $cfg, $data;
3778
3779         $default_function   = '';
3780
3781         // Can we get field class based values?
3782         $current_class = $GLOBALS['PMA_Types']->getTypeClass($field['True_Type']);
3783         if (! empty($current_class)) {
3784             if (isset($cfg['DefaultFunctions']['FUNC_' . $current_class])) {
3785                 $default_function
3786                     = $cfg['DefaultFunctions']['FUNC_' . $current_class];
3787             }
3788         }
3789
3790         // what function defined as default?
3791         // for the first timestamp we don't set the default function
3792         // if there is a default value for the timestamp
3793         // (not including CURRENT_TIMESTAMP)
3794         // and the column does not have the
3795         // ON UPDATE DEFAULT TIMESTAMP attribute.
3796         if (($field['True_Type'] == 'timestamp')
3797             && $field['first_timestamp']
3798             && empty($field['Default'])
3799             && empty($data)
3800             && $field['Extra'] != 'on update CURRENT_TIMESTAMP'
3801             && $field['Null'] == 'NO'
3802         ) {
3803             $default_function = $cfg['DefaultFunctions']['first_timestamp'];
3804         }
3805
3806         // For primary keys of type char(36) or varchar(36) UUID if the default
3807         // function
3808         // Only applies to insert mode, as it would silently trash data on updates.
3809         if ($insert_mode
3810             && $field['Key'] == 'PRI'
3811             && ($field['Type'] == 'char(36)' || $field['Type'] == 'varchar(36)')
3812         ) {
3813              $default_function = $cfg['DefaultFunctions']['FUNC_UUID'];
3814         }
3815
3816         return $default_function;
3817     }
3818
3819     /**
3820      * Creates a dropdown box with MySQL functions for a particular column.
3821      *
3822      * @param array $field       Data about the column for which
3823      *                           to generate the dropdown
3824      * @param bool  $insert_mode Whether the operation is 'insert'
3825      *
3826      * @return string   An HTML snippet of a dropdown list with function
3827      *                    names appropriate for the requested column.
3828      */
3829     public static function getFunctionsForField($field, $insert_mode, $foreignData)
3830     {
3831         $default_function = self::getDefaultFunctionForField($field, $insert_mode);
3832         $dropdown_built = array();
3833
3834         // Create the output
3835         $retval = '<option></option>' . "\n";
3836         // loop on the dropdown array and print all available options for that
3837         // field.
3838         $functions = $GLOBALS['PMA_Types']->getFunctions($field['True_Type']);
3839         foreach ($functions as $function) {
3840             $retval .= '<option';
3841             if (isset($foreignData['foreign_link']) && $foreignData['foreign_link'] !== false && $default_function === $function) {
3842                 $retval .= ' selected="selected"';
3843             }
3844             $retval .= '>' . $function . '</option>' . "\n";
3845             $dropdown_built[$function] = true;
3846         }
3847
3848         // Create separator before all functions list
3849         if (count($functions) > 0) {
3850             $retval .= '<option value="" disabled="disabled">--------</option>'
3851                 . "\n";
3852         }
3853
3854         // For compatibility's sake, do not let out all other functions. Instead
3855         // print a separator (blank) and then show ALL functions which weren't
3856         // shown yet.
3857         $functions = $GLOBALS['PMA_Types']->getAllFunctions();
3858         foreach ($functions as $function) {
3859             // Skip already included functions
3860             if (isset($dropdown_built[$function])) {
3861                 continue;
3862             }
3863             $retval .= '<option';
3864             if ($default_function === $function) {
3865                 $retval .= ' selected="selected"';
3866             }
3867             $retval .= '>' . $function . '</option>' . "\n";
3868         } // end for
3869
3870         return $retval;
3871     } // end getFunctionsForField()
3872
3873     /**
3874      * Checks if the current user has a specific privilege and returns true if the
3875      * user indeed has that privilege or false if (s)he doesn't. This function must
3876      * only be used for features that are available since MySQL 5, because it
3877      * relies on the INFORMATION_SCHEMA database to be present.
3878      *
3879      * Example:   currentUserHasPrivilege('CREATE ROUTINE', 'mydb');
3880      *            // Checks if the currently logged in user has the global
3881      *            // 'CREATE ROUTINE' privilege or, if not, checks if the
3882      *            // user has this privilege on database 'mydb'.
3883      *
3884      * @param string $priv The privilege to check
3885      * @param mixed  $db   null, to only check global privileges
3886      *                     string, db name where to also check for privileges
3887      * @param mixed  $tbl  null, to only check global/db privileges
3888      *                     string, table name where to also check for privileges
3889      *
3890      * @return bool
3891      */
3892     public static function currentUserHasPrivilege($priv, $db = null, $tbl = null)
3893     {
3894         // Get the username for the current user in the format
3895         // required to use in the information schema database.
3896         list($user, $host) = $GLOBALS['dbi']->getCurrentUserAndHost();
3897
3898         if ($user === '') { // MySQL is started with --skip-grant-tables
3899             return true;
3900         }
3901
3902         $username  = "''";
3903         $username .= str_replace("'", "''", $user);
3904         $username .= "''@''";
3905         $username .= str_replace("'", "''", $host);
3906         $username .= "''";
3907
3908         // Prepare the query
3909         $query = "SELECT `PRIVILEGE_TYPE` FROM `INFORMATION_SCHEMA`.`%s` "
3910                . "WHERE GRANTEE='%s' AND PRIVILEGE_TYPE='%s'";
3911
3912         // Check global privileges first.
3913         $user_privileges = $GLOBALS['dbi']->fetchValue(
3914             sprintf(
3915                 $query,
3916                 'USER_PRIVILEGES',
3917                 $username,
3918                 $priv
3919             )
3920         );
3921         if ($user_privileges) {
3922             return true;
3923         }
3924         // If a database name was provided and user does not have the
3925         // required global privilege, try database-wise permissions.
3926         if ($db !== null) {
3927             $query .= " AND '%s' LIKE `TABLE_SCHEMA`";
3928             $schema_privileges = $GLOBALS['dbi']->fetchValue(
3929                 sprintf(
3930                     $query,
3931                     'SCHEMA_PRIVILEGES',
3932                     $username,
3933                     $priv,
3934                     $GLOBALS['dbi']->escapeString($db)
3935                 )
3936             );
3937             if ($schema_privileges) {
3938                 return true;
3939             }
3940         } else {
3941             // There was no database name provided and the user
3942             // does not have the correct global privilege.
3943             return false;
3944         }
3945         // If a table name was also provided and we still didn't
3946         // find any valid privileges, try table-wise privileges.
3947         if ($tbl !== null) {
3948             // need to escape wildcards in db and table names, see bug #3518484
3949             $tbl = str_replace(array('%', '_'), array('\%', '\_'), $tbl);
3950             $query .= " AND TABLE_NAME='%s'";
3951             $table_privileges = $GLOBALS['dbi']->fetchValue(
3952                 sprintf(
3953                     $query,
3954                     'TABLE_PRIVILEGES',
3955                     $username,
3956                     $priv,
3957                     $GLOBALS['dbi']->escapeString($db),
3958                     $GLOBALS['dbi']->escapeString($tbl)
3959                 )
3960             );
3961             if ($table_privileges) {
3962                 return true;
3963             }
3964         }
3965         // If we reached this point, the user does not
3966         // have even valid table-wise privileges.
3967         return false;
3968     }
3969
3970     /**
3971      * Returns server type for current connection
3972      *
3973      * Known types are: MariaDB and MySQL (default)
3974      *
3975      * @return string
3976      */
3977     public static function getServerType()
3978     {
3979         $server_type = 'MySQL';
3980
3981         if (mb_stripos(PMA_MYSQL_STR_VERSION, 'mariadb') !== false) {
3982             $server_type = 'MariaDB';
3983             return $server_type;
3984         }
3985
3986         if (mb_stripos(PMA_MYSQL_VERSION_COMMENT, 'percona') !== false) {
3987             $server_type = 'Percona Server';
3988             return $server_type;
3989         }
3990
3991         return $server_type;
3992     }
3993
3994     /**
3995      * Prepare HTML code for display button.
3996      *
3997      * @return String
3998      */
3999     public static function getButton()
4000     {
4001         return '<p class="print_ignore">'
4002             . '<input type="button" class="button" id="print" value="'
4003             . __('Print') . '" />'
4004             . '</p>';
4005     }
4006
4007     /**
4008      * Parses ENUM/SET values
4009      *
4010      * @param string $definition The definition of the column
4011      *                           for which to parse the values
4012      * @param bool   $escapeHtml Whether to escape html entities
4013      *
4014      * @return array
4015      */
4016     public static function parseEnumSetValues($definition, $escapeHtml = true)
4017     {
4018         $values_string = htmlentities($definition, ENT_COMPAT, "UTF-8");
4019         // There is a JS port of the below parser in functions.js
4020         // If you are fixing something here,
4021         // you need to also update the JS port.
4022         $values = array();
4023         $in_string = false;
4024         $buffer = '';
4025
4026         for ($i = 0, $length = mb_strlen($values_string);
4027              $i < $length;
4028              $i++
4029         ) {
4030             $curr = mb_substr($values_string, $i, 1);
4031             $next = ($i == mb_strlen($values_string) - 1)
4032                 ? ''
4033                 : mb_substr($values_string, $i + 1, 1);
4034
4035             if (! $in_string && $curr == "'") {
4036                 $in_string = true;
4037             } else if (($in_string && $curr == "\\") && $next == "\\") {
4038                 $buffer .= "&#92;";
4039                 $i++;
4040             } else if (($in_string && $next == "'")
4041                 && ($curr == "'" || $curr == "\\")
4042             ) {
4043                 $buffer .= "&#39;";
4044                 $i++;
4045             } else if ($in_string && $curr == "'") {
4046                 $in_string = false;
4047                 $values[] = $buffer;
4048                 $buffer = '';
4049             } else if ($in_string) {
4050                  $buffer .= $curr;
4051             }
4052
4053         }
4054
4055         if (strlen($buffer) > 0) {
4056             // The leftovers in the buffer are the last value (if any)
4057             $values[] = $buffer;
4058         }
4059
4060         if (! $escapeHtml) {
4061             foreach ($values as $key => $value) {
4062                 $values[$key] = html_entity_decode($value, ENT_QUOTES, 'UTF-8');
4063             }
4064         }
4065
4066         return $values;
4067     }
4068
4069     /**
4070      * Get regular expression which occur first inside the given sql query.
4071      *
4072      * @param array  $regex_array Comparing regular expressions.
4073      * @param String $query       SQL query to be checked.
4074      *
4075      * @return String Matching regular expression.
4076      */
4077     public static function getFirstOccurringRegularExpression($regex_array, $query)
4078     {
4079         $minimum_first_occurence_index = null;
4080         $regex = null;
4081
4082         foreach ($regex_array as $test_regex) {
4083             if (preg_match($test_regex, $query, $matches, PREG_OFFSET_CAPTURE)) {
4084                 if (is_null($minimum_first_occurence_index)
4085                     || ($matches[0][1] < $minimum_first_occurence_index)
4086                 ) {
4087                     $regex = $test_regex;
4088                     $minimum_first_occurence_index = $matches[0][1];
4089                 }
4090             }
4091         }
4092         return $regex;
4093     }
4094
4095     /**
4096      * Return the list of tabs for the menu with corresponding names
4097      *
4098      * @param string $level 'server', 'db' or 'table' level
4099      *
4100      * @return array list of tabs for the menu
4101      */
4102     public static function getMenuTabList($level = null)
4103     {
4104         $tabList = array(
4105             'server' => array(
4106                 'databases'   => __('Databases'),
4107                 'sql'         => __('SQL'),
4108                 'status'      => __('Status'),
4109                 'rights'      => __('Users'),
4110                 'export'      => __('Export'),
4111                 'import'      => __('Import'),
4112                 'settings'    => __('Settings'),
4113                 'binlog'      => __('Binary log'),
4114                 'replication' => __('Replication'),
4115                 'vars'        => __('Variables'),
4116                 'charset'     => __('Charsets'),
4117                 'plugins'     => __('Plugins'),
4118                 'engine'      => __('Engines')
4119             ),
4120             'db'     => array(
4121                 'structure'   => __('Structure'),
4122                 'sql'         => __('SQL'),
4123                 'search'      => __('Search'),
4124                 'qbe'         => __('Query'),
4125                 'export'      => __('Export'),
4126                 'import'      => __('Import'),
4127                 'operation'   => __('Operations'),
4128                 'privileges'  => __('Privileges'),
4129                 'routines'    => __('Routines'),
4130                 'events'      => __('Events'),
4131                 'triggers'    => __('Triggers'),
4132                 'tracking'    => __('Tracking'),
4133                 'designer'    => __('Designer'),
4134                 'central_columns' => __('Central columns')
4135             ),
4136             'table'  => array(
4137                 'browse'      => __('Browse'),
4138                 'structure'   => __('Structure'),
4139                 'sql'         => __('SQL'),
4140                 'search'      => __('Search'),
4141                 'insert'      => __('Insert'),
4142                 'export'      => __('Export'),
4143                 'import'      => __('Import'),
4144                 'privileges'  => __('Privileges'),
4145                 'operation'   => __('Operations'),
4146                 'tracking'    => __('Tracking'),
4147                 'triggers'    => __('Triggers'),
4148             )
4149         );
4150
4151         if ($level == null) {
4152             return $tabList;
4153         } else if (array_key_exists($level, $tabList)) {
4154             return $tabList[$level];
4155         } else {
4156             return null;
4157         }
4158     }
4159
4160     /**
4161      * Returns information with regards to handling the http request
4162      *
4163      * @param array $context Data about the context for which
4164      *                       to http request is sent
4165      *
4166      * @return array of updated context information
4167      */
4168     public static function handleContext(array $context)
4169     {
4170         if (strlen($GLOBALS['cfg']['ProxyUrl']) > 0) {
4171             $context['http'] = array(
4172                 'proxy' => $GLOBALS['cfg']['ProxyUrl'],
4173                 'request_fulluri' => true
4174             );
4175             if (strlen($GLOBALS['cfg']['ProxyUser']) > 0) {
4176                 $auth = base64_encode(
4177                     $GLOBALS['cfg']['ProxyUser'] . ':' . $GLOBALS['cfg']['ProxyPass']
4178                 );
4179                 $context['http']['header'] .= 'Proxy-Authorization: Basic '
4180                     . $auth . "\r\n";
4181             }
4182         }
4183         return $context;
4184     }
4185     /**
4186      * Updates an existing curl as necessary
4187      *
4188      * @param resource $curl_handle A curl_handle resource
4189      *                              created by curl_init which should
4190      *                              have several options set
4191      *
4192      * @return resource curl_handle with updated options
4193      */
4194     public static function configureCurl($curl_handle)
4195     {
4196         if (strlen($GLOBALS['cfg']['ProxyUrl']) > 0) {
4197             curl_setopt($curl_handle, CURLOPT_PROXY, $GLOBALS['cfg']['ProxyUrl']);
4198             if (strlen($GLOBALS['cfg']['ProxyUser']) > 0) {
4199                 curl_setopt(
4200                     $curl_handle,
4201                     CURLOPT_PROXYUSERPWD,
4202                     $GLOBALS['cfg']['ProxyUser'] . ':' . $GLOBALS['cfg']['ProxyPass']
4203                 );
4204             }
4205         }
4206         curl_setopt($curl_handle, CURLOPT_USERAGENT, 'phpMyAdmin/' . PMA_VERSION);
4207         return $curl_handle;
4208     }
4209
4210     /**
4211      * Add fractional seconds to time, datetime and timestamp strings.
4212      * If the string contains fractional seconds,
4213      * pads it with 0s up to 6 decimal places.
4214      *
4215      * @param string $value time, datetime or timestamp strings
4216      *
4217      * @return string time, datetime or timestamp strings with fractional seconds
4218      */
4219     public static function addMicroseconds($value)
4220     {
4221         if (empty($value) || $value == 'CURRENT_TIMESTAMP') {
4222             return $value;
4223         }
4224
4225         if (mb_strpos($value, '.') === false) {
4226             return $value . '.000000';
4227         }
4228
4229         $value .= '000000';
4230         return mb_substr(
4231             $value,
4232             0,
4233             mb_strpos($value, '.') + 7
4234         );
4235     }
4236
4237     /**
4238      * Reads the file, detects the compression MIME type, closes the file
4239      * and returns the MIME type
4240      *
4241      * @param resource $file the file handle
4242      *
4243      * @return string the MIME type for compression, or 'none'
4244      */
4245     public static function getCompressionMimeType($file)
4246     {
4247         $test = fread($file, 4);
4248         $len = strlen($test);
4249         fclose($file);
4250         if ($len >= 2 && $test[0] == chr(31) && $test[1] == chr(139)) {
4251             return 'application/gzip';
4252         }
4253         if ($len >= 3 && substr($test, 0, 3) == 'BZh') {
4254             return 'application/bzip2';
4255         }
4256         if ($len >= 4 && $test == "PK\003\004") {
4257             return 'application/zip';
4258         }
4259         return 'none';
4260     }
4261
4262     /**
4263      * Renders a single link for the top of the navigation panel
4264      *
4265      * @param string  $link        The url for the link
4266      * @param bool    $showText    Whether to show the text or to
4267      *                             only use it for title attributes
4268      * @param string  $text        The text to display and use for title attributes
4269      * @param bool    $showIcon    Whether to show the icon
4270      * @param string  $icon        The filename of the icon to show
4271      * @param string  $linkId      Value to use for the ID attribute
4272      * @param boolean $disableAjax Whether to disable ajax page loading for this link
4273      * @param string  $linkTarget  The name of the target frame for the link
4274      * @param array   $classes     HTML classes to apply
4275      *
4276      * @return string HTML code for one link
4277      */
4278     public static function getNavigationLink(
4279         $link,
4280         $showText,
4281         $text,
4282         $showIcon,
4283         $icon,
4284         $linkId = '',
4285         $disableAjax = false,
4286         $linkTarget = '',
4287         $classes = array()
4288     ) {
4289         $retval = '<a href="' . $link . '"';
4290         if (! empty($linkId)) {
4291             $retval .= ' id="' . $linkId . '"';
4292         }
4293         if (! empty($linkTarget)) {
4294             $retval .= ' target="' . $linkTarget . '"';
4295         }
4296         if ($disableAjax) {
4297             $classes[] = 'disableAjax';
4298         }
4299         if (!empty($classes)) {
4300             $retval .= ' class="' . join(" ", $classes) . '"';
4301         }
4302         $retval .= ' title="' . $text . '">';
4303         if ($showIcon) {
4304             $retval .= Util::getImage(
4305                 $icon,
4306                 $text
4307             );
4308         }
4309         if ($showText) {
4310             $retval .= $text;
4311         }
4312         $retval .= '</a>';
4313         if ($showText) {
4314             $retval .= '<br />';
4315         }
4316         return $retval;
4317     }
4318
4319     /**
4320      * Provide COLLATE clause, if required, to perform case sensitive comparisons
4321      * for queries on information_schema.
4322      *
4323      * @return string COLLATE clause if needed or empty string.
4324      */
4325     public static function getCollateForIS()
4326     {
4327         $names = $GLOBALS['dbi']->getLowerCaseNames();
4328         if ($names === '0') {
4329             return "COLLATE utf8_bin";
4330         } elseif ($names === '2') {
4331             return "COLLATE utf8_general_ci";
4332         }
4333         return "";
4334     }
4335
4336     /**
4337      * Process the index data.
4338      *
4339      * @param array $indexes index data
4340      *
4341      * @return array processes index data
4342      */
4343     public static function processIndexData($indexes)
4344     {
4345         $lastIndex    = '';
4346
4347         $primary      = '';
4348         $pk_array     = array(); // will be use to emphasis prim. keys in the table
4349         $indexes_info = array();
4350         $indexes_data = array();
4351
4352         // view
4353         foreach ($indexes as $row) {
4354             // Backups the list of primary keys
4355             if ($row['Key_name'] == 'PRIMARY') {
4356                 $primary   .= $row['Column_name'] . ', ';
4357                 $pk_array[$row['Column_name']] = 1;
4358             }
4359             // Retains keys informations
4360             if ($row['Key_name'] != $lastIndex) {
4361                 $indexes[] = $row['Key_name'];
4362                 $lastIndex = $row['Key_name'];
4363             }
4364             $indexes_info[$row['Key_name']]['Sequences'][] = $row['Seq_in_index'];
4365             $indexes_info[$row['Key_name']]['Non_unique'] = $row['Non_unique'];
4366             if (isset($row['Cardinality'])) {
4367                 $indexes_info[$row['Key_name']]['Cardinality'] = $row['Cardinality'];
4368             }
4369             // I don't know what does following column mean....
4370             // $indexes_info[$row['Key_name']]['Packed']          = $row['Packed'];
4371
4372             $indexes_info[$row['Key_name']]['Comment'] = $row['Comment'];
4373
4374             $indexes_data[$row['Key_name']][$row['Seq_in_index']]['Column_name']
4375                 = $row['Column_name'];
4376             if (isset($row['Sub_part'])) {
4377                 $indexes_data[$row['Key_name']][$row['Seq_in_index']]['Sub_part']
4378                     = $row['Sub_part'];
4379             }
4380
4381         } // end while
4382
4383         return array($primary, $pk_array, $indexes_info, $indexes_data);
4384     }
4385
4386     /**
4387      * Function to get html for the start row and number of rows panel
4388      *
4389      * @param string $sql_query sql query
4390      *
4391      * @return string html
4392      */
4393     public static function getStartAndNumberOfRowsPanel($sql_query)
4394     {
4395         $pos = isset($_REQUEST['pos'])
4396             ? $_REQUEST['pos']
4397             : $_SESSION['tmpval']['pos'];
4398         if (isset($_REQUEST['session_max_rows'])) {
4399             $rows = $_REQUEST['session_max_rows'];
4400         } else {
4401             if ($_SESSION['tmpval']['max_rows'] != 'all') {
4402                 $rows = $_SESSION['tmpval']['max_rows'];
4403             } else {
4404                 $rows = $GLOBALS['cfg']['MaxRows'];
4405             }
4406         }
4407
4408         return Template::get('startAndNumberOfRowsPanel')
4409             ->render(
4410                 array(
4411                     'pos' => $pos,
4412                     'unlim_num_rows' => intval($_REQUEST['unlim_num_rows']),
4413                     'rows' => $rows,
4414                     'sql_query' => $sql_query,
4415                 )
4416             );
4417     }
4418
4419     /**
4420      * Returns whether the database server supports virtual columns
4421      *
4422      * @return bool
4423      */
4424     public static function isVirtualColumnsSupported()
4425     {
4426         $serverType = self::getServerType();
4427         return $serverType == 'MySQL' && PMA_MYSQL_INT_VERSION >= 50705
4428              || ($serverType == 'MariaDB' && PMA_MYSQL_INT_VERSION >= 50200);
4429     }
4430
4431     /**
4432      * Returns the proper class clause according to the column type
4433      *
4434      * @param string $type the column type
4435      *
4436      * @return string $class_clause the HTML class clause
4437      */
4438     public static function getClassForType($type)
4439     {
4440         if ('set' == $type
4441             || 'enum' == $type
4442         ) {
4443             $class_clause = '';
4444         } else {
4445             $class_clause = ' class="nowrap"';
4446         }
4447         return $class_clause;
4448     }
4449
4450     /**
4451      * Gets the list of tables in the current db and information about these
4452      * tables if possible
4453      *
4454      * @param string $db       database name
4455      * @param string $sub_part part of script name
4456      *
4457      * @return array
4458      *
4459      */
4460     public static function getDbInfo($db, $sub_part)
4461     {
4462         global $cfg;
4463
4464         /**
4465          * limits for table list
4466          */
4467         if (! isset($_SESSION['tmpval']['table_limit_offset'])
4468             || $_SESSION['tmpval']['table_limit_offset_db'] != $db
4469         ) {
4470             $_SESSION['tmpval']['table_limit_offset'] = 0;
4471             $_SESSION['tmpval']['table_limit_offset_db'] = $db;
4472         }
4473         if (isset($_REQUEST['pos'])) {
4474             $_SESSION['tmpval']['table_limit_offset'] = (int) $_REQUEST['pos'];
4475         }
4476         $pos = $_SESSION['tmpval']['table_limit_offset'];
4477
4478         /**
4479          * whether to display extended stats
4480          */
4481         $is_show_stats = $cfg['ShowStats'];
4482
4483         /**
4484          * whether selected db is information_schema
4485          */
4486         $db_is_system_schema = false;
4487
4488         if ($GLOBALS['dbi']->isSystemSchema($db)) {
4489             $is_show_stats = false;
4490             $db_is_system_schema = true;
4491         }
4492
4493         /**
4494          * information about tables in db
4495          */
4496         $tables = array();
4497
4498         $tooltip_truename = array();
4499         $tooltip_aliasname = array();
4500
4501         // Special speedup for newer MySQL Versions (in 4.0 format changed)
4502         if (true === $cfg['SkipLockedTables']) {
4503             $db_info_result = $GLOBALS['dbi']->query(
4504                 'SHOW OPEN TABLES FROM ' . Util::backquote($db) . ' WHERE In_use > 0;'
4505             );
4506
4507             // Blending out tables in use
4508             if ($db_info_result && $GLOBALS['dbi']->numRows($db_info_result) > 0) {
4509                 $tables = self::getTablesWhenOpen($db, $db_info_result);
4510
4511             } elseif ($db_info_result) {
4512                 $GLOBALS['dbi']->freeResult($db_info_result);
4513             }
4514         }
4515
4516         if (empty($tables)) {
4517             // Set some sorting defaults
4518             $sort = 'Name';
4519             $sort_order = 'ASC';
4520
4521             if (isset($_REQUEST['sort'])) {
4522                 $sortable_name_mappings = array(
4523                     'table'       => 'Name',
4524                     'records'     => 'Rows',
4525                     'type'        => 'Engine',
4526                     'collation'   => 'Collation',
4527                     'size'        => 'Data_length',
4528                     'overhead'    => 'Data_free',
4529                     'creation'    => 'Create_time',
4530                     'last_update' => 'Update_time',
4531                     'last_check'  => 'Check_time',
4532                     'comment'     => 'Comment',
4533                 );
4534
4535                 // Make sure the sort type is implemented
4536                 if (isset($sortable_name_mappings[$_REQUEST['sort']])) {
4537                     $sort = $sortable_name_mappings[$_REQUEST['sort']];
4538                     if ($_REQUEST['sort_order'] == 'DESC') {
4539                         $sort_order = 'DESC';
4540                     }
4541                 }
4542             }
4543
4544             $groupWithSeparator = false;
4545             $tbl_type = null;
4546             $limit_offset = 0;
4547             $limit_count = false;
4548             $groupTable = array();
4549
4550             if (! empty($_REQUEST['tbl_group']) || ! empty($_REQUEST['tbl_type'])) {
4551                 if (! empty($_REQUEST['tbl_type'])) {
4552                     // only tables for selected type
4553                     $tbl_type = $_REQUEST['tbl_type'];
4554                 }
4555                 if (! empty($_REQUEST['tbl_group'])) {
4556                     // only tables for selected group
4557                     $tbl_group = $_REQUEST['tbl_group'];
4558                     // include the table with the exact name of the group if such
4559                     // exists
4560                     $groupTable = $GLOBALS['dbi']->getTablesFull(
4561                         $db, $tbl_group, false, null, $limit_offset,
4562                         $limit_count, $sort, $sort_order, $tbl_type
4563                     );
4564                     $groupWithSeparator = $tbl_group
4565                         . $GLOBALS['cfg']['NavigationTreeTableSeparator'];
4566                 }
4567             } else {
4568                 // all tables in db
4569                 // - get the total number of tables
4570                 //  (needed for proper working of the MaxTableList feature)
4571                 $tables = $GLOBALS['dbi']->getTables($db);
4572                 $total_num_tables = count($tables);
4573                 if (isset($sub_part) && $sub_part == '_export') {
4574                     // (don't fetch only a subset if we are coming from
4575                     // db_export.php, because I think it's too risky to display only
4576                     // a subset of the table names when exporting a db)
4577                     /**
4578                      *
4579                      * @todo Page selector for table names?
4580                      */
4581                 } else {
4582                     // fetch the details for a possible limited subset
4583                     $limit_offset = $pos;
4584                     $limit_count = true;
4585                 }
4586             }
4587             $tables = array_merge(
4588                 $groupTable,
4589                 $GLOBALS['dbi']->getTablesFull(
4590                     $db, $groupWithSeparator, ($groupWithSeparator !== false), null,
4591                     $limit_offset, $limit_count, $sort, $sort_order, $tbl_type
4592                 )
4593             );
4594         }
4595
4596         $num_tables = count($tables);
4597         //  (needed for proper working of the MaxTableList feature)
4598         if (! isset($total_num_tables)) {
4599             $total_num_tables = $num_tables;
4600         }
4601
4602         /**
4603          * If coming from a Show MySQL link on the home page,
4604          * put something in $sub_part
4605          */
4606         if (empty($sub_part)) {
4607             $sub_part = '_structure';
4608         }
4609
4610         return array(
4611             $tables,
4612             $num_tables,
4613             $total_num_tables,
4614             $sub_part,
4615             $is_show_stats,
4616             $db_is_system_schema,
4617             $tooltip_truename,
4618             $tooltip_aliasname,
4619             $pos
4620         );
4621     }
4622
4623     /**
4624      * Gets the list of tables in the current db, taking into account
4625      * that they might be "in use"
4626      *
4627      * @param string $db             database name
4628      * @param object $db_info_result result set
4629      *
4630      * @return array $tables list of tables
4631      *
4632      */
4633     public static function getTablesWhenOpen($db, $db_info_result)
4634     {
4635         $sot_cache = $tables = array();
4636
4637         while ($tmp = $GLOBALS['dbi']->fetchAssoc($db_info_result)) {
4638             $sot_cache[$tmp['Table']] = true;
4639         }
4640         $GLOBALS['dbi']->freeResult($db_info_result);
4641
4642         // is there at least one "in use" table?
4643         if (isset($sot_cache)) {
4644             $tblGroupSql = "";
4645             $whereAdded = false;
4646             if (PMA_isValid($_REQUEST['tbl_group'])) {
4647                 $group = Util::escapeMysqlWildcards($_REQUEST['tbl_group']);
4648                 $groupWithSeparator = Util::escapeMysqlWildcards(
4649                     $_REQUEST['tbl_group']
4650                     . $GLOBALS['cfg']['NavigationTreeTableSeparator']
4651                 );
4652                 $tblGroupSql .= " WHERE ("
4653                     . Util::backquote('Tables_in_' . $db)
4654                     . " LIKE '" . $groupWithSeparator . "%'"
4655                     . " OR "
4656                     . Util::backquote('Tables_in_' . $db)
4657                     . " LIKE '" . $group . "')";
4658                 $whereAdded = true;
4659             }
4660             if (PMA_isValid($_REQUEST['tbl_type'], array('table', 'view'))) {
4661                 $tblGroupSql .= $whereAdded ? " AND" : " WHERE";
4662                 if ($_REQUEST['tbl_type'] == 'view') {
4663                     $tblGroupSql .= " `Table_type` != 'BASE TABLE'";
4664                 } else {
4665                     $tblGroupSql .= " `Table_type` = 'BASE TABLE'";
4666                 }
4667             }
4668             $db_info_result = $GLOBALS['dbi']->query(
4669                 'SHOW FULL TABLES FROM ' . Util::backquote($db) . $tblGroupSql,
4670                 null, DatabaseInterface::QUERY_STORE
4671             );
4672             unset($tblGroupSql, $whereAdded);
4673
4674             if ($db_info_result && $GLOBALS['dbi']->numRows($db_info_result) > 0) {
4675                 $names = array();
4676                 while ($tmp = $GLOBALS['dbi']->fetchRow($db_info_result)) {
4677                     if (! isset($sot_cache[$tmp[0]])) {
4678                         $names[] = $tmp[0];
4679                     } else { // table in use
4680                         $tables[$tmp[0]] = array(
4681                             'TABLE_NAME' => $tmp[0],
4682                             'ENGINE' => '',
4683                             'TABLE_TYPE' => '',
4684                             'TABLE_ROWS' => 0,
4685                             'TABLE_COMMENT' => '',
4686                         );
4687                     }
4688                 } // end while
4689                 if (count($names) > 0) {
4690                     $tables = array_merge(
4691                         $tables,
4692                         $GLOBALS['dbi']->getTablesFull($db, $names)
4693                     );
4694                 }
4695                 if ($GLOBALS['cfg']['NaturalOrder']) {
4696                     uksort($tables, 'strnatcasecmp');
4697                 }
4698
4699             } elseif ($db_info_result) {
4700                 $GLOBALS['dbi']->freeResult($db_info_result);
4701             }
4702             unset($sot_cache);
4703         }
4704         return $tables;
4705     }
4706
4707     /**
4708      * Returs list of used PHP extensions.
4709      *
4710      * @return array of strings
4711      */
4712     public static function listPHPExtensions()
4713     {
4714         $result = array();
4715         if (DatabaseInterface::checkDbExtension('mysqli')) {
4716             $result[] = 'mysqli';
4717         } else {
4718             $result[] = 'mysql';
4719         }
4720
4721         if (extension_loaded('curl')) {
4722             $result[] = 'curl';
4723         }
4724
4725         if (extension_loaded('mbstring')) {
4726             $result[] = 'mbstring';
4727         }
4728
4729         return $result;
4730     }
4731
4732     /**
4733      * Converts given (request) paramter to string
4734      *
4735      * @param mixed $value Value to convert
4736      *
4737      * @return string
4738      */
4739     public static function requestString($value)
4740     {
4741         while (is_array($value) || is_object($value)) {
4742             $value = reset($value);
4743         }
4744         return trim((string)$value);
4745     }
4746
4747     /**
4748      * Creates HTTP request using curl
4749      *
4750      * @param mixed    $response           HTTP response
4751      * @param interger $http_status        HTTP response status code
4752      * @param bool     $return_only_status If set to true, the method would only return response status
4753      *
4754      * @return mixed
4755      */
4756     public static function httpRequestReturn($response, $http_status, $return_only_status)
4757     {
4758         if ($http_status == 404) {
4759             return false;
4760         }
4761         if ($http_status != 200) {
4762             return null;
4763         }
4764         if ($return_only_status) {
4765             return true;
4766         }
4767         return $response;
4768     }
4769
4770     /**
4771      * Creates HTTP request using curl
4772      *
4773      * @param string $url                Url to send the request
4774      * @param string $method             HTTP request method (GET, POST, PUT, DELETE, etc)
4775      * @param bool   $return_only_status If set to true, the method would only return response status
4776      * @param mixed  $content            Content to be sent with HTTP request
4777      * @param string $header             Header to be set for the HTTP request
4778      *
4779      * @return mixed
4780      */
4781     public static function httpRequestCurl($url, $method, $return_only_status = false, $content = null, $header = "")
4782     {
4783         $curl_handle = curl_init($url);
4784         if ($curl_handle === false) {
4785             return null;
4786         }
4787         $curl_handle = Util::configureCurl($curl_handle);
4788
4789         if ($method != "GET") {
4790             curl_setopt($curl_handle, CURLOPT_CUSTOMREQUEST, $method);
4791         }
4792         if ($header) {
4793             curl_setopt($curl_handle, CURLOPT_HTTPHEADER, array($header));
4794             curl_setopt($curl_handle, CURLOPT_HEADER, true);
4795         }
4796
4797         if ($method == "POST") {
4798             curl_setopt($curl_handle, CURLOPT_POSTFIELDS, $content);
4799         }
4800
4801         curl_setopt($curl_handle, CURLOPT_SSL_VERIFYHOST, '2');
4802         curl_setopt($curl_handle, CURLOPT_SSL_VERIFYPEER, '1');
4803
4804         curl_setopt($curl_handle, CURLOPT_RETURNTRANSFER,true);
4805         curl_setopt($curl_handle, CURLOPT_FOLLOWLOCATION, 0);
4806         curl_setopt($curl_handle, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
4807         curl_setopt($curl_handle, CURLOPT_TIMEOUT, 10);
4808         curl_setopt($curl_handle, CURLOPT_CONNECTTIMEOUT, 10);
4809         $response = @curl_exec($curl_handle);
4810         if ($response === false) {
4811             return null;
4812         }
4813         $http_status = curl_getinfo($curl_handle, CURLINFO_HTTP_CODE);
4814         return Util::httpRequestReturn($response, $http_status, $return_only_status);
4815     }
4816
4817     /**
4818      * Creates HTTP request using file_get_contents
4819      *
4820      * @param string $url                Url to send the request
4821      * @param string $method             HTTP request method (GET, POST, PUT, DELETE, etc)
4822      * @param bool   $return_only_status If set to true, the method would only return response status
4823      * @param mixed  $content            Content to be sent with HTTP request
4824      * @param string $header             Header to be set for the HTTP request
4825      *
4826      * @return mixed
4827      */
4828     public static function httpRequestFopen($url, $method, $return_only_status = false, $content = null, $header = "")
4829     {
4830         $context = array(
4831             'http' => array(
4832                 'method'  => $method,
4833                 'request_fulluri' => true,
4834                 'timeout' => 10,
4835                 'user_agent' => 'phpMyAdmin',
4836                 'header' => "Accept: */*",
4837             )
4838         );
4839         if ($header) {
4840             $context['http']['header'] .= "\n" . $header;
4841         }
4842         if ($method == "POST") {
4843             $context['http']['content'] = $content;
4844         }
4845
4846         $context = Util::handleContext($context);
4847         $response = @file_get_contents(
4848             $url,
4849             false,
4850             stream_context_create($context)
4851         );
4852         if (! isset($http_response_header)) {
4853             return null;
4854         }
4855         preg_match("#HTTP/[0-9\.]+\s+([0-9]+)#", $http_response_header[0], $out );
4856         $http_status = intval($out[1]);
4857         return Util::httpRequestReturn($response, $http_status, $return_only_status);
4858     }
4859
4860     /**
4861      * Creates HTTP request
4862      *
4863      * @param string $url                Url to send the request
4864      * @param string $method             HTTP request method (GET, POST, PUT, DELETE, etc)
4865      * @param bool   $return_only_status If set to true, the method would only return response status
4866      * @param mixed  $content            Content to be sent with HTTP request
4867      * @param string $header             Header to be set for the HTTP request
4868      *
4869      * @return mixed
4870      */
4871     public static function httpRequest($url, $method, $return_only_status = false, $content = null, $header = "")
4872     {
4873         if (function_exists('curl_init')) {
4874             return Util::httpRequestCurl($url, $method, $return_only_status, $content, $header);
4875         } else if (ini_get('allow_url_fopen')) {
4876             return Util::httpRequestFopen($url, $method, $return_only_status, $content, $header);
4877         }
4878         return null;
4879     }
4880 }