libraries/common.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Misc functions used all over the scripts.
   5  *
   6  * @package phpMyAdmin
   7  */
   8
   9 /**
  10  * Exponential expression / raise number into power
  11  *
  12  * @uses    function_exists()
  13  * @uses    bcpow()
  14  * @uses    gmp_pow()
  15  * @uses    gmp_strval()
  16  * @uses    pow()
  17  * @param   number  $base
  18  * @param   number  $exp
  19  * @param   string  pow function use, or false for auto-detect
  20  * @return  mixed  string or float
  21  */
  22 function PMA_pow($base, $exp, $use_function = false)
  23 {
  24     static $pow_function = null;
  25
  26     if (null == $pow_function) {
  27         if (function_exists('bcpow')) {
  28             // BCMath Arbitrary Precision Mathematics Function
  29             $pow_function = 'bcpow';
  30         } elseif (function_exists('gmp_pow')) {
  31             // GMP Function
  32             $pow_function = 'gmp_pow';
  33         } else {
  34             // PHP function
  35             $pow_function = 'pow';
  36         }
  37     }
  38
  39     if (! $use_function) {
  40         $use_function = $pow_function;
  41     }
  42
  43     if ($exp < 0 && 'pow' != $use_function) {
  44         return false;
  45     }
  46     switch ($use_function) {
  47         case 'bcpow' :
  48             // bcscale() needed for testing PMA_pow() with base values < 1
  49             bcscale(10);
  50             $pow = bcpow($base, $exp);
  51             break;
  52         case 'gmp_pow' :
  53              $pow = gmp_strval(gmp_pow($base, $exp));
  54             break;
  55         case 'pow' :
  56             $base = (float) $base;
  57             $exp = (int) $exp;
  58             $pow = pow($base, $exp);
  59             break;
  60         default:
  61             $pow = $use_function($base, $exp);
  62     }
  63
  64     return $pow;
  65 }
  66
  67 /**
  68  * string PMA_getIcon(string $icon)
  69  *
  70  * @uses    $GLOBALS['pmaThemeImage']
  71  * @uses    $GLOBALS['cfg']['PropertiesIconic']
  72  * @uses    htmlspecialchars()
  73  * @param   string  $icon   name of icon file
  74  * @param   string  $alternate alternate text
  75  * @param   boolean $container include in container
  76  * @param   boolean $$force_text whether to force alternate text to be displayed
  77  * @return          html img tag
  78  */
  79 function PMA_getIcon($icon, $alternate = '', $container = false, $force_text = false)
  80 {
  81     $include_icon = false;
  82     $include_text = false;
  83     $include_box  = false;
  84     $alternate    = htmlspecialchars($alternate);
  85     $button       = '';
  86
  87     if ($GLOBALS['cfg']['PropertiesIconic']) {
  88          $include_icon = true;
  89     }
  90
  91     if ($force_text
  92      || ! (true === $GLOBALS['cfg']['PropertiesIconic'])
  93      || ! $include_icon) {
  94         // $cfg['PropertiesIconic'] is false or both
  95         // OR we have no $include_icon
  96         $include_text = true;
  97     }
  98
  99     if ($include_text && $include_icon && $container) {
 100         // we have icon, text and request for container
 101         $include_box = true;
 102     }
 103
 104     if ($include_box) {
 105         $button .= '<span class="nowrap">';
 106     }
 107
 108     if ($include_icon) {
 109         $button .= '<img src="' . $GLOBALS['pmaThemeImage'] . $icon . '"'
 110             . ' title="' . $alternate . '" alt="' . $alternate . '"'
 111             . ' class="icon" width="16" height="16" />';
 112     }
 113
 114     if ($include_icon && $include_text) {
 115         $button .= ' ';
 116     }
 117
 118     if ($include_text) {
 119         $button .= $alternate;
 120     }
 121
 122     if ($include_box) {
 123         $button .= '</span>';
 124     }
 125
 126     return $button;
 127 }
 128
 129 /**
 130  * Displays the maximum size for an upload
 131  *
 132  * @uses    PMA_formatByteDown()
 133  * @uses    sprintf()
 134  * @param   integer  the size
 135  *
 136  * @return  string   the message
 137  *
 138  * @access  public
 139  */
 140 function PMA_displayMaximumUploadSize($max_upload_size)
 141 {
 142     // I have to reduce the second parameter (sensitiveness) from 6 to 4
 143     // to avoid weird results like 512 kKib
 144     list($max_size, $max_unit) = PMA_formatByteDown($max_upload_size, 4);
 145     return '(' . sprintf(__('Max: %s%s'), $max_size, $max_unit) . ')';
 146 }
 147
 148 /**
 149  * Generates a hidden field which should indicate to the browser
 150  * the maximum size for upload
 151  *
 152  * @param   integer  the size
 153  *
 154  * @return  string   the INPUT field
 155  *
 156  * @access  public
 157  */
 158  function PMA_generateHiddenMaxFileSize($max_size)
 159  {
 160      return '<input type="hidden" name="MAX_FILE_SIZE" value="' .$max_size . '" />';
 161  }
 162
 163 /**
 164  * Add slashes before "'" and "\" characters so a value containing them can
 165  * be used in a sql comparison.
 166  *
 167  * @uses    str_replace()
 168  * @param   string   the string to slash
 169  * @param   boolean  whether the string will be used in a 'LIKE' clause
 170  *                   (it then requires two more escaped sequences) or not
 171  * @param   boolean  whether to treat cr/lfs as escape-worthy entities
 172  *                   (converts \n to \\n, \r to \\r)
 173  *
 174  * @param   boolean  whether this function is used as part of the
 175  *                   "Create PHP code" dialog
 176  *
 177  * @return  string   the slashed string
 178  *
 179  * @access  public
 180  */
 181 function PMA_sqlAddslashes($a_string = '', $is_like = false, $crlf = false, $php_code = false)
 182 {
 183     if ($is_like) {
 184         $a_string = str_replace('\\', '\\\\\\\\', $a_string);
 185     } else {
 186         $a_string = str_replace('\\', '\\\\', $a_string);
 187     }
 188
 189     if ($crlf) {
 190         $a_string = str_replace("\n", '\n', $a_string);
 191         $a_string = str_replace("\r", '\r', $a_string);
 192         $a_string = str_replace("\t", '\t', $a_string);
 193     }
 194
 195     if ($php_code) {
 196         $a_string = str_replace('\'', '\\\'', $a_string);
 197     } else {
 198         $a_string = str_replace('\'', '\'\'', $a_string);
 199     }
 200
 201     return $a_string;
 202 } // end of the 'PMA_sqlAddslashes()' function
 203
 204
 205 /**
 206  * Add slashes before "_" and "%" characters for using them in MySQL
 207  * database, table and field names.
 208  * Note: This function does not escape backslashes!
 209  *
 210  * @uses    str_replace()
 211  * @param   string   the string to escape
 212  *
 213  * @return  string   the escaped string
 214  *
 215  * @access  public
 216  */
 217 function PMA_escape_mysql_wildcards($name)
 218 {
 219     $name = str_replace('_', '\\_', $name);
 220     $name = str_replace('%', '\\%', $name);
 221
 222     return $name;
 223 } // end of the 'PMA_escape_mysql_wildcards()' function
 224
 225 /**
 226  * removes slashes before "_" and "%" characters
 227  * Note: This function does not unescape backslashes!
 228  *
 229  * @uses    str_replace()
 230  * @param   string   $name  the string to escape
 231  * @return  string   the escaped string
 232  * @access  public
 233  */
 234 function PMA_unescape_mysql_wildcards($name)
 235 {
 236     $name = str_replace('\\_', '_', $name);
 237     $name = str_replace('\\%', '%', $name);
 238
 239     return $name;
 240 } // end of the 'PMA_unescape_mysql_wildcards()' function
 241
 242 /**
 243  * removes quotes (',",`) from a quoted string
 244  *
 245  * checks if the sting is quoted and removes this quotes
 246  *
 247  * @uses    str_replace()
 248  * @uses    substr()
 249  * @param   string  $quoted_string  string to remove quotes from
 250  * @param   string  $quote          type of quote to remove
 251  * @return  string  unqoted string
 252  */
 253 function PMA_unQuote($quoted_string, $quote = null)
 254 {
 255     $quotes = array();
 256
 257     if (null === $quote) {
 258         $quotes[] = '`';
 259         $quotes[] = '"';
 260         $quotes[] = "'";
 261     } else {
 262         $quotes[] = $quote;
 263     }
 264
 265     foreach ($quotes as $quote) {
 266         if (substr($quoted_string, 0, 1) === $quote
 267          && substr($quoted_string, -1, 1) === $quote) {
 268              $unquoted_string = substr($quoted_string, 1, -1);
 269              // replace escaped quotes
 270              $unquoted_string = str_replace($quote . $quote, $quote, $unquoted_string);
 271              return $unquoted_string;
 272          }
 273     }
 274
 275     return $quoted_string;
 276 }
 277
 278 /**
 279  * format sql strings
 280  *
 281  * @todo    move into PMA_Sql
 282  * @uses    PMA_SQP_isError()
 283  * @uses    PMA_SQP_formatHtml()
 284  * @uses    PMA_SQP_formatNone()
 285  * @uses    is_array()
 286  * @param   mixed    pre-parsed SQL structure
 287  *
 288  * @return  string   the formatted sql
 289  *
 290  * @global  array    the configuration array
 291  * @global  boolean  whether the current statement is a multiple one or not
 292  *
 293  * @access  public
 294  *
 295  */
 296 function PMA_formatSql($parsed_sql, $unparsed_sql = '')
 297 {
 298     global $cfg;
 299
 300     // Check that we actually have a valid set of parsed data
 301     // well, not quite
 302     // first check for the SQL parser having hit an error
 303     if (PMA_SQP_isError()) {
 304         return htmlspecialchars($parsed_sql['raw']);
 305     }
 306     // then check for an array
 307     if (!is_array($parsed_sql)) {
 308         // We don't so just return the input directly
 309         // This is intended to be used for when the SQL Parser is turned off
 310         $formatted_sql = '<pre>' . "\n"
 311                         . (($cfg['SQP']['fmtType'] == 'none' && $unparsed_sql != '') ? $unparsed_sql : $parsed_sql) . "\n"
 312                         . '</pre>';
 313         return $formatted_sql;
 314     }
 315
 316     $formatted_sql        = '';
 317
 318     switch ($cfg['SQP']['fmtType']) {
 319         case 'none':
 320             if ($unparsed_sql != '') {
 321                 $formatted_sql = '<span class="inner_sql"><pre>' . "\n" . PMA_SQP_formatNone(array('raw' => $unparsed_sql)) . "\n" . '</pre></span>';
 322             } else {
 323                 $formatted_sql = PMA_SQP_formatNone($parsed_sql);
 324             }
 325             break;
 326         case 'html':
 327             $formatted_sql = PMA_SQP_formatHtml($parsed_sql, 'color');
 328             break;
 329         case 'text':
 330             $formatted_sql = PMA_SQP_formatHtml($parsed_sql, 'text');
 331             break;
 332         default:
 333             break;
 334     } // end switch
 335
 336     return $formatted_sql;
 337 } // end of the "PMA_formatSql()" function
 338
 339
 340 /**
 341  * Displays a link to the official MySQL documentation
 342  *
 343  * @uses    $cfg['MySQLManualType']
 344  * @uses    $cfg['MySQLManualBase']
 345  * @uses    $cfg['ReplaceHelpImg']
 346  * @uses    $GLOBALS['pmaThemeImage']
 347  * @uses    PMA_MYSQL_INT_VERSION
 348  * @uses    strtolower()
 349  * @uses    str_replace()
 350  * @param string  chapter of "HTML, one page per chapter" documentation
 351  * @param string  contains name of page/anchor that is being linked
 352  * @param bool    whether to use big icon (like in left frame)
 353  * @param string  anchor to page part
 354  *
 355  * @return  string  the html link
 356  *
 357  * @access  public
 358  */
 359 function PMA_showMySQLDocu($chapter, $link, $big_icon = false, $anchor = '', $just_open = false)
 360 {
 361     global $cfg;
 362
 363     if ($cfg['MySQLManualType'] == 'none' || empty($cfg['MySQLManualBase'])) {
 364         return '';
 365     }
 366
 367     // Fixup for newly used names:
 368     $chapter = str_replace('_', '-', strtolower($chapter));
 369     $link = str_replace('_', '-', strtolower($link));
 370
 371     switch ($cfg['MySQLManualType']) {
 372         case 'chapters':
 373             if (empty($chapter)) {
 374                 $chapter = 'index';
 375             }
 376             if (empty($anchor)) {
 377                 $anchor = $link;
 378             }
 379             $url = $cfg['MySQLManualBase'] . '/' . $chapter . '.html#' . $anchor;
 380             break;
 381         case 'big':
 382             if (empty($anchor)) {
 383                 $anchor = $link;
 384             }
 385             $url = $cfg['MySQLManualBase'] . '#' . $anchor;
 386             break;
 387         case 'searchable':
 388             if (empty($link)) {
 389                 $link = 'index';
 390             }
 391             $url = $cfg['MySQLManualBase'] . '/' . $link . '.html';
 392             if (!empty($anchor)) {
 393                 $url .= '#' . $anchor;
 394             }
 395             break;
 396         case 'viewable':
 397         default:
 398             if (empty($link)) {
 399                 $link = 'index';
 400             }
 401             $mysql = '5.0';
 402             $lang = 'en';
 403             if (defined('PMA_MYSQL_INT_VERSION')) {
 404                 if (PMA_MYSQL_INT_VERSION >= 50100) {
 405                     $mysql = '5.1';
 406                     /* l10n: Language to use for MySQL 5.1 documentation, please use only languages which do exist in official documentation.  */
 407                     $lang = _pgettext('$mysql_5_1_doc_lang', 'en');
 408                 } elseif (PMA_MYSQL_INT_VERSION >= 50000) {
 409                     $mysql = '5.0';
 410                     /* l10n: Language to use for MySQL 5.0 documentation, please use only languages which do exist in official documentation. */
 411                     $lang = _pgettext('$mysql_5_0_doc_lang', 'en');
 412                 }
 413             }
 414             $url = $cfg['MySQLManualBase'] . '/' . $mysql . '/' . $lang . '/' . $link . '.html';
 415             if (!empty($anchor)) {
 416                 $url .= '#' . $anchor;
 417             }
 418             break;
 419     }
 420
 421     if ($just_open) {
 422         return '<a href="' . $url . '" target="mysql_doc">';
 423     } elseif ($big_icon) {
 424         return '<a href="' . $url . '" target="mysql_doc"><img class="icon" src="' . $GLOBALS['pmaThemeImage'] . 'b_sqlhelp.png" width="16" height="16" alt="' . __('Documentation') . '" title="' . __('Documentation') . '" /></a>';
 425     } elseif ($GLOBALS['cfg']['ReplaceHelpImg']) {
 426         return '<a href="' . $url . '" target="mysql_doc"><img class="icon" src="' . $GLOBALS['pmaThemeImage'] . 'b_help.png" width="11" height="11" alt="' . __('Documentation') . '" title="' . __('Documentation') . '" /></a>';
 427     } else {
 428         return '[<a href="' . $url . '" target="mysql_doc">' . __('Documentation') . '</a>]';
 429     }
 430 } // end of the 'PMA_showMySQLDocu()' function
 431
 432
 433 /**
 434  * Displays a link to the phpMyAdmin documentation
 435  *
 436  * @param string  anchor in documentation
 437  *
 438  * @return  string  the html link
 439  *
 440  * @access  public
 441  */
 442 function PMA_showDocu($anchor) {
 443     if ($GLOBALS['cfg']['ReplaceHelpImg']) {
 444         return '<a href="Documentation.html#' . $anchor . '" target="documentation"><img class="icon" src="' . $GLOBALS['pmaThemeImage'] . 'b_help.png" width="11" height="11" alt="' . __('Documentation') . '" title="' . __('Documentation') . '" /></a>';
 445     } else {
 446         return '[<a href="Documentation.html#' . $anchor . '" target="documentation">' . __('Documentation') . '</a>]';
 447     }
 448 } // end of the 'PMA_showDocu()' function
 449
 450 /**
 451  * returns HTML for a footnote marker and add the messsage to the footnotes
 452  *
 453  * @uses    $GLOBALS['footnotes']
 454  * @param   string   the error message
 455  * @return  string html code for a footnote marker
 456  * @access  public
 457  */
 458 function PMA_showHint($message, $bbcode = false, $type = 'notice')
 459 {
 460     if ($message instanceof PMA_Message) {
 461         $key = $message->getHash();
 462         $type = $message->getLevel();
 463     } else {
 464         $key = md5($message);
 465     }
 466
 467     if (! isset($GLOBALS['footnotes'][$key])) {
 468         if (empty($GLOBALS['footnotes']) || ! is_array($GLOBALS['footnotes'])) {
 469             $GLOBALS['footnotes'] = array();
 470         }
 471         $nr = count($GLOBALS['footnotes']) + 1;
 472         // this is the first instance of this message
 473         $instance = 1;
 474         $GLOBALS['footnotes'][$key] = array(
 475             'note'      => $message,
 476             'type'      => $type,
 477             'nr'        => $nr,
 478             'instance'  => $instance
 479         );
 480     } else {
 481         $nr = $GLOBALS['footnotes'][$key]['nr'];
 482         // another instance of this message (to ensure ids are unique)
 483         $instance = ++$GLOBALS['footnotes'][$key]['instance'];
 484     }
 485
 486     if ($bbcode) {
 487         return '[sup]' . $nr . '[/sup]';
 488     }
 489
 490     // footnotemarker used in js/tooltip.js
 491     return '<sup class="footnotemarker">' . $nr . '</sup>' .
 492     '<img class="footnotemarker" id="footnote_' . $nr . '_' . $instance . '" src="' .
 493     $GLOBALS['pmaThemeImage'] . 'b_help.png" alt="" />';
 494 }
 495
 496 /**
 497  * Displays a MySQL error message in the right frame.
 498  *
 499  * @uses    footer.inc.php
 500  * @uses    header.inc.php
 501  * @uses    $GLOBALS['sql_query']
 502  * @uses    $GLOBALS['pmaThemeImage']
 503  * @uses    $GLOBALS['cfg']['PropertiesIconic']
 504  * @uses    $GLOBALS['cfg']['MaxCharactersInDisplayedSQL']
 505  * @uses    PMA_backquote()
 506  * @uses    PMA_DBI_getError()
 507  * @uses    PMA_formatSql()
 508  * @uses    PMA_generate_common_hidden_inputs()
 509  * @uses    PMA_generate_common_url()
 510  * @uses    PMA_showMySQLDocu()
 511  * @uses    PMA_sqlAddslashes()
 512  * @uses    PMA_SQP_isError()
 513  * @uses    PMA_SQP_parse()
 514  * @uses    PMA_SQP_getErrorString()
 515  * @uses    strtolower()
 516  * @uses    urlencode()
 517  * @uses    str_replace()
 518  * @uses    nl2br()
 519  * @uses    substr()
 520  * @uses    preg_replace()
 521  * @uses    preg_match()
 522  * @uses    explode()
 523  * @uses    implode()
 524  * @uses    is_array()
 525  * @uses    function_exists()
 526  * @uses    htmlspecialchars()
 527  * @uses    trim()
 528  * @uses    strstr()
 529  * @param   string   the error message
 530  * @param   string   the sql query that failed
 531  * @param   boolean  whether to show a "modify" link or not
 532  * @param   string   the "back" link url (full path is not required)
 533  * @param   boolean  EXIT the page?
 534  *
 535  * @global  string    the curent table
 536  * @global  string    the current db
 537  *
 538  * @access  public
 539  */
 540 function PMA_mysqlDie($error_message = '', $the_query = '',
 541                         $is_modify_link = true, $back_url = '', $exit = true)
 542 {
 543     global $table, $db;
 544
 545     /**
 546      * start http output, display html headers
 547      */
 548     require_once './libraries/header.inc.php';
 549
 550     $error_msg_output = '';
 551
 552     if (!$error_message) {
 553         $error_message = PMA_DBI_getError();
 554     }
 555     if (!$the_query && !empty($GLOBALS['sql_query'])) {
 556         $the_query = $GLOBALS['sql_query'];
 557     }
 558
 559     // --- Added to solve bug #641765
 560     // Robbat2 - 12 January 2003, 9:46PM
 561     // Revised, Robbat2 - 13 January 2003, 2:59PM
 562     if (!function_exists('PMA_SQP_isError') || PMA_SQP_isError()) {
 563         $formatted_sql = htmlspecialchars($the_query);
 564     } elseif (empty($the_query) || trim($the_query) == '') {
 565         $formatted_sql = '';
 566     } else {
 567         if (strlen($the_query) > $GLOBALS['cfg']['MaxCharactersInDisplayedSQL']) {
 568             $formatted_sql = htmlspecialchars(substr($the_query, 0, $GLOBALS['cfg']['MaxCharactersInDisplayedSQL'])) . '[...]';
 569         } else {
 570             $formatted_sql = PMA_formatSql(PMA_SQP_parse($the_query), $the_query);
 571         }
 572     }
 573     // ---
 574     $error_msg_output .= "\n" . '<!-- PMA-SQL-ERROR -->' . "\n";
 575     $error_msg_output .= '    <div class="error"><h1>' . __('Error') . '</h1>' . "\n";
 576     // if the config password is wrong, or the MySQL server does not
 577     // respond, do not show the query that would reveal the
 578     // username/password
 579     if (!empty($the_query) && !strstr($the_query, 'connect')) {
 580         // --- Added to solve bug #641765
 581         // Robbat2 - 12 January 2003, 9:46PM
 582         // Revised, Robbat2 - 13 January 2003, 2:59PM
 583         if (function_exists('PMA_SQP_isError') && PMA_SQP_isError()) {
 584             $error_msg_output .= PMA_SQP_getErrorString() . "\n";
 585             $error_msg_output .= '<br />' . "\n";
 586         }
 587         // ---
 588         // modified to show the help on sql errors
 589         $error_msg_output .= '    <p><strong>' . __('SQL query') . ':</strong>' . "\n";
 590         if (strstr(strtolower($formatted_sql), 'select')) { // please show me help to the error on select
 591             $error_msg_output .= PMA_showMySQLDocu('SQL-Syntax', 'SELECT');
 592         }
 593         if ($is_modify_link) {
 594             $_url_params = array(
 595                 'sql_query' => $the_query,
 596                 'show_query' => 1,
 597             );
 598             if (strlen($table)) {
 599                 $_url_params['db'] = $db;
 600                 $_url_params['table'] = $table;
 601                 $doedit_goto = '<a href="tbl_sql.php?' . PMA_generate_common_url($_url_params) . '">';
 602             } elseif (strlen($db)) {
 603                 $_url_params['db'] = $db;
 604                 $doedit_goto = '<a href="db_sql.php?' . PMA_generate_common_url($_url_params) . '">';
 605             } else {
 606                 $doedit_goto = '<a href="server_sql.php?' . PMA_generate_common_url($_url_params) . '">';
 607             }
 608
 609             $error_msg_output .= $doedit_goto
 610                . PMA_getIcon('b_edit.png', __('Edit'))
 611                . '</a>';
 612         } // end if
 613         $error_msg_output .= '    </p>' . "\n"
 614             .'    <p>' . "\n"
 615             .'        ' . $formatted_sql . "\n"
 616             .'    </p>' . "\n";
 617     } // end if
 618
 619     if (!empty($error_message)) {
 620         $error_message = preg_replace("@((\015\012)|(\015)|(\012)){3,}@", "\n\n", $error_message);
 621     }
 622     // modified to show the help on error-returns
 623     // (now error-messages-server)
 624     $error_msg_output .= '<p>' . "\n"
 625             . '    <strong>' . __('MySQL said: ') . '</strong>'
 626             . PMA_showMySQLDocu('Error-messages-server', 'Error-messages-server')
 627             . "\n"
 628             . '</p>' . "\n";
 629
 630     // The error message will be displayed within a CODE segment.
 631     // To preserve original formatting, but allow wordwrapping, we do a couple of replacements
 632
 633     // Replace all non-single blanks with their HTML-counterpart
 634     $error_message = str_replace('  ', '&nbsp;&nbsp;', $error_message);
 635     // Replace TAB-characters with their HTML-counterpart
 636     $error_message = str_replace("\t", '&nbsp;&nbsp;&nbsp;&nbsp;', $error_message);
 637     // Replace linebreaks
 638     $error_message = nl2br($error_message);
 639
 640     $error_msg_output .= '<code>' . "\n"
 641         . $error_message . "\n"
 642         . '</code><br />' . "\n";
 643     $error_msg_output .= '</div>';
 644
 645     $_SESSION['Import_message']['message'] = $error_msg_output;
 646
 647     if ($exit) {
 648         if (! empty($back_url)) {
 649             if (strstr($back_url, '?')) {
 650                 $back_url .= '&amp;no_history=true';
 651             } else {
 652                 $back_url .= '?no_history=true';
 653             }
 654
 655             $_SESSION['Import_message']['go_back_url'] = $back_url;
 656
 657             $error_msg_output .= '<fieldset class="tblFooters">';
 658             $error_msg_output .= '[ <a href="' . $back_url . '">' . __('Back') . '</a> ]';
 659             $error_msg_output .= '</fieldset>' . "\n\n";
 660        }
 661
 662         /**
 663          * If in an Ajax request, don't just echo and exit.  Use PMA_ajaxResponse()
 664          */
 665         if($GLOBALS['is_ajax_request'] == true) {
 666             PMA_ajaxResponse($error_msg_output, false);
 667         }
 668         echo $error_msg_output;
 669         /**
 670          * display footer and exit
 671          */
 672        require './libraries/footer.inc.php';
 673     } else {
 674         echo $error_msg_output;
 675     }
 676 } // end of the 'PMA_mysqlDie()' function
 677
 678 /**
 679  * returns array with tables of given db with extended information and grouped
 680  *
 681  * @uses    $cfg['LeftFrameTableSeparator']
 682  * @uses    $cfg['LeftFrameTableLevel']
 683  * @uses    $cfg['ShowTooltipAliasTB']
 684  * @uses    $cfg['NaturalOrder']
 685  * @uses    PMA_backquote()
 686  * @uses    count()
 687  * @uses    array_merge
 688  * @uses    uksort()
 689  * @uses    strstr()
 690  * @uses    explode()
 691  * @param   string  $db     name of db
 692  * @param   string  $tables name of tables
 693  * @param   integer $limit_offset   list offset
 694  * @param   integer $limit_count    max tables to return
 695  * return   array   (recursive) grouped table list
 696  */
 697 function PMA_getTableList($db, $tables = null, $limit_offset = 0, $limit_count = false)
 698 {
 699     $sep = $GLOBALS['cfg']['LeftFrameTableSeparator'];
 700
 701     if (null === $tables) {
 702         $tables = PMA_DBI_get_tables_full($db, false, false, null, $limit_offset, $limit_count);
 703         if ($GLOBALS['cfg']['NaturalOrder']) {
 704             uksort($tables, 'strnatcasecmp');
 705         }
 706     }
 707
 708     if (count($tables) < 1) {
 709         return $tables;
 710     }
 711
 712     $default = array(
 713         'Name'      => '',
 714         'Rows'      => 0,
 715         'Comment'   => '',
 716         'disp_name' => '',
 717     );
 718
 719     $table_groups = array();
 720
 721     // for blobstreaming - list of blobstreaming tables
 722
 723     // load PMA configuration
 724     $PMA_Config = $GLOBALS['PMA_Config'];
 725
 726     foreach ($tables as $table_name => $table) {
 727         // if BS tables exist
 728         if (PMA_BS_IsHiddenTable($table_name)) {
 729             continue;
 730         }
 731
 732         // check for correct row count
 733         if (null === $table['Rows']) {
 734             // Do not check exact row count here,
 735             // if row count is invalid possibly the table is defect
 736             // and this would break left frame;
 737             // but we can check row count if this is a view or the
 738             // information_schema database
 739             // since PMA_Table::countRecords() returns a limited row count
 740             // in this case.
 741
 742             // set this because PMA_Table::countRecords() can use it
 743             $tbl_is_view = PMA_Table::isView($db, $table['Name']);
 744
 745             if ($tbl_is_view || 'information_schema' == $db) {
 746                 $table['Rows'] = PMA_Table::countRecords($db, $table['Name']);
 747             }
 748         }
 749
 750         // in $group we save the reference to the place in $table_groups
 751         // where to store the table info
 752         if ($GLOBALS['cfg']['LeftFrameDBTree']
 753             && $sep && strstr($table_name, $sep))
 754         {
 755             $parts = explode($sep, $table_name);
 756
 757             $group =& $table_groups;
 758             $i = 0;
 759             $group_name_full = '';
 760             $parts_cnt = count($parts) - 1;
 761             while ($i < $parts_cnt
 762               && $i < $GLOBALS['cfg']['LeftFrameTableLevel']) {
 763                 $group_name = $parts[$i] . $sep;
 764                 $group_name_full .= $group_name;
 765
 766                 if (!isset($group[$group_name])) {
 767                     $group[$group_name] = array();
 768                     $group[$group_name]['is' . $sep . 'group'] = true;
 769                     $group[$group_name]['tab' . $sep . 'count'] = 1;
 770                     $group[$group_name]['tab' . $sep . 'group'] = $group_name_full;
 771                 } elseif (!isset($group[$group_name]['is' . $sep . 'group'])) {
 772                     $table = $group[$group_name];
 773                     $group[$group_name] = array();
 774                     $group[$group_name][$group_name] = $table;
 775                     unset($table);
 776                     $group[$group_name]['is' . $sep . 'group'] = true;
 777                     $group[$group_name]['tab' . $sep . 'count'] = 1;
 778                     $group[$group_name]['tab' . $sep . 'group'] = $group_name_full;
 779                 } else {
 780                     $group[$group_name]['tab' . $sep . 'count']++;
 781                 }
 782                 $group =& $group[$group_name];
 783                 $i++;
 784             }
 785         } else {
 786             if (!isset($table_groups[$table_name])) {
 787                 $table_groups[$table_name] = array();
 788             }
 789             $group =& $table_groups;
 790         }
 791
 792
 793         if ($GLOBALS['cfg']['ShowTooltipAliasTB']
 794           && $GLOBALS['cfg']['ShowTooltipAliasTB'] !== 'nested') {
 795             // switch tooltip and name
 796             $table['Comment'] = $table['Name'];
 797             $table['disp_name'] = $table['Comment'];
 798         } else {
 799             $table['disp_name'] = $table['Name'];
 800         }
 801
 802         $group[$table_name] = array_merge($default, $table);
 803     }
 804
 805     return $table_groups;
 806 }
 807
 808 /* ----------------------- Set of misc functions ----------------------- */
 809
 810
 811 /**
 812  * Adds backquotes on both sides of a database, table or field name.
 813  * and escapes backquotes inside the name with another backquote
 814  *
 815  * example:
 816  * <code>
 817  * echo PMA_backquote('owner`s db'); // `owner``s db`
 818  *
 819  * </code>
 820  *
 821  * @uses    PMA_backquote()
 822  * @uses    is_array()
 823  * @uses    strlen()
 824  * @uses    str_replace()
 825  * @param   mixed    $a_name    the database, table or field name to "backquote"
 826  *                              or array of it
 827  * @param   boolean  $do_it     a flag to bypass this function (used by dump
 828  *                              functions)
 829  * @return  mixed    the "backquoted" database, table or field name if the
 830  *                   current MySQL release is >= 3.23.6, the original one
 831  *                   else
 832  * @access  public
 833  */
 834 function PMA_backquote($a_name, $do_it = true)
 835 {
 836     if (is_array($a_name)) {
 837         foreach ($a_name as &$data) {
 838             $data = PMA_backquote($data, $do_it);
 839         }
 840         return $a_name;
 841     }
 842
 843     if (! $do_it) {
 844         global $PMA_SQPdata_forbidden_word;
 845         global $PMA_SQPdata_forbidden_word_cnt;
 846
 847         if(! PMA_STR_binarySearchInArr(strtoupper($a_name), $PMA_SQPdata_forbidden_word, $PMA_SQPdata_forbidden_word_cnt)) {
 848             return $a_name;
 849         }
 850     }
 851
 852     // '0' is also empty for php :-(
 853     if (strlen($a_name) && $a_name !== '*') {
 854         return '`' . str_replace('`', '``', $a_name) . '`';
 855     } else {
 856         return $a_name;
 857     }
 858 } // end of the 'PMA_backquote()' function
 859
 860
 861 /**
 862  * Defines the <CR><LF> value depending on the user OS.
 863  *
 864  * @uses    PMA_USR_OS
 865  * @return  string   the <CR><LF> value to use
 866  *
 867  * @access  public
 868  */
 869 function PMA_whichCrlf()
 870 {
 871     $the_crlf = "\n";
 872
 873     // The 'PMA_USR_OS' constant is defined in "./libraries/Config.class.php"
 874     // Win case
 875     if (PMA_USR_OS == 'Win') {
 876         $the_crlf = "\r\n";
 877     }
 878     // Others
 879     else {
 880         $the_crlf = "\n";
 881     }
 882
 883     return $the_crlf;
 884 } // end of the 'PMA_whichCrlf()' function
 885
 886 /**
 887  * Reloads navigation if needed.
 888  *
 889  * @param   $jsonly prints out pure JavaScript
 890  * @uses    $GLOBALS['reload']
 891  * @uses    $GLOBALS['db']
 892  * @uses    PMA_generate_common_url()
 893  * @global  array  configuration
 894  *
 895  * @access  public
 896  */
 897 function PMA_reloadNavigation($jsonly=false)
 898 {
 899     global $cfg;
 900
 901     // Reloads the navigation frame via JavaScript if required
 902     if (isset($GLOBALS['reload']) && $GLOBALS['reload']) {
 903         // one of the reasons for a reload is when a table is dropped
 904         // in this case, get rid of the table limit offset, otherwise
 905         // we have a problem when dropping a table on the last page
 906         // and the offset becomes greater than the total number of tables
 907         unset($_SESSION['tmp_user_values']['table_limit_offset']);
 908         echo "\n";
 909         $reload_url = './navigation.php?' . PMA_generate_common_url($GLOBALS['db'], '', '&');
 910         if (!$jsonly)
 911           echo '<script type="text/javascript">' . PHP_EOL;
 912         ?>
 913 //<![CDATA[
 914 if (typeof(window.parent) != 'undefined'
 915     && typeof(window.parent.frame_navigation) != 'undefined'
 916     && window.parent.goTo) {
 917     window.parent.goTo('<?php echo $reload_url; ?>');
 918 }
 919 //]]>
 920 <?php
 921 if (!$jsonly)
 922   echo '</script>' . PHP_EOL;
 923
 924         unset($GLOBALS['reload']);
 925     }
 926 }
 927
 928 /**
 929  * displays the message and the query
 930  * usually the message is the result of the query executed
 931  *
 932  * @param   string  $message    the message to display
 933  * @param   string  $sql_query  the query to display
 934  * @param   string  $type       the type (level) of the message
 935  * @param   boolean $is_view    is this a message after a VIEW operation?
 936  * @global  array   the configuration array
 937  * @uses    $cfg
 938  * @access  public
 939  */
 940 function PMA_showMessage($message, $sql_query = null, $type = 'notice', $is_view = false)
 941 {
 942     /*
 943      * PMA_ajaxResponse uses this function to collect the string of HTML generated
 944      * for showing the message.  Use output buffering to collect it and return it
 945      * in a string.  In some special cases on sql.php, buffering has to be disabled
 946      * and hence we check with $GLOBALS['buffer_message']
 947      */
 948     if( $GLOBALS['is_ajax_request'] == true && !isset($GLOBALS['buffer_message']) ) {
 949         ob_start();
 950     }
 951     global $cfg;
 952
 953     if (null === $sql_query) {
 954         if (! empty($GLOBALS['display_query'])) {
 955             $sql_query = $GLOBALS['display_query'];
 956         } elseif ($cfg['SQP']['fmtType'] == 'none' && ! empty($GLOBALS['unparsed_sql'])) {
 957             $sql_query = $GLOBALS['unparsed_sql'];
 958         } elseif (! empty($GLOBALS['sql_query'])) {
 959             $sql_query = $GLOBALS['sql_query'];
 960         } else {
 961             $sql_query = '';
 962         }
 963     }
 964
 965     // Corrects the tooltip text via JS if required
 966     // @todo this is REALLY the wrong place to do this - very unexpected here
 967     if (! $is_view && strlen($GLOBALS['table']) && $cfg['ShowTooltip']) {
 968         $tooltip = PMA_Table::sGetToolTip($GLOBALS['db'], $GLOBALS['table']);
 969         $uni_tbl = PMA_jsFormat($GLOBALS['db'] . '.' . $GLOBALS['table'], false);
 970         echo "\n";
 971         echo '<script type="text/javascript">' . "\n";
 972         echo '//<![CDATA[' . "\n";
 973         echo "if (window.parent.updateTableTitle) window.parent.updateTableTitle('" . $uni_tbl . "', '" . PMA_jsFormat($tooltip, false) . "');" . "\n";
 974         echo '//]]>' . "\n";
 975         echo '</script>' . "\n";
 976     } // end if ... elseif
 977
 978     // Checks if the table needs to be repaired after a TRUNCATE query.
 979     // @todo what about $GLOBALS['display_query']???
 980     // @todo this is REALLY the wrong place to do this - very unexpected here
 981     if (strlen($GLOBALS['table'])
 982      && $GLOBALS['sql_query'] == 'TRUNCATE TABLE ' . PMA_backquote($GLOBALS['table'])) {
 983         if (PMA_Table::sGetStatusInfo($GLOBALS['db'], $GLOBALS['table'], 'Index_length') > 1024) {
 984             PMA_DBI_try_query('REPAIR TABLE ' . PMA_backquote($GLOBALS['table']));
 985         }
 986     }
 987     unset($tbl_status);
 988
 989     // In an Ajax request, $GLOBALS['cell_align_left'] may not be defined. Hence,
 990     // check for it's presence before using it
 991     echo '<div align="' . ( isset($GLOBALS['cell_align_left']) ? $GLOBALS['cell_align_left'] : '' ) . '">' . "\n";
 992
 993     if ($message instanceof PMA_Message) {
 994         if (isset($GLOBALS['special_message'])) {
 995             $message->addMessage($GLOBALS['special_message']);
 996             unset($GLOBALS['special_message']);
 997         }
 998         $message->display();
 999         $type = $message->getLevel();
1000     } else {
1001         echo '<div class="' . $type . '">';
1002         echo PMA_sanitize($message);
1003         if (isset($GLOBALS['special_message'])) {
1004             echo PMA_sanitize($GLOBALS['special_message']);
1005             unset($GLOBALS['special_message']);
1006         }
1007         echo '</div>';
1008     }
1009
1010     if ($cfg['ShowSQL'] == true && ! empty($sql_query)) {
1011         // Html format the query to be displayed
1012         // If we want to show some sql code it is easiest to create it here
1013         /* SQL-Parser-Analyzer */
1014
1015         if (! empty($GLOBALS['show_as_php'])) {
1016             $new_line = '\\n"<br />' . "\n"
1017                 . '&nbsp;&nbsp;&nbsp;&nbsp;. "';
1018             $query_base = htmlspecialchars(addslashes($sql_query));
1019             $query_base = preg_replace('/((\015\012)|(\015)|(\012))/', $new_line, $query_base);
1020         } else {
1021             $query_base = $sql_query;
1022         }
1023
1024         $query_too_big = false;
1025
1026         if (strlen($query_base) > $cfg['MaxCharactersInDisplayedSQL']) {
1027             // when the query is large (for example an INSERT of binary
1028             // data), the parser chokes; so avoid parsing the query
1029             $query_too_big = true;
1030             $shortened_query_base = nl2br(htmlspecialchars(substr($sql_query, 0, $cfg['MaxCharactersInDisplayedSQL']) . '[...]'));
1031         } elseif (! empty($GLOBALS['parsed_sql'])
1032          && $query_base == $GLOBALS['parsed_sql']['raw']) {
1033             // (here, use "! empty" because when deleting a bookmark,
1034             // $GLOBALS['parsed_sql'] is set but empty
1035             $parsed_sql = $GLOBALS['parsed_sql'];
1036         } else {
1037             // Parse SQL if needed
1038             $parsed_sql = PMA_SQP_parse($query_base);
1039             if (PMA_SQP_isError()) {
1040                 unset($parsed_sql);
1041             }
1042         }
1043
1044         // Analyze it
1045         if (isset($parsed_sql)) {
1046             $analyzed_display_query = PMA_SQP_analyze($parsed_sql);
1047             // Here we append the LIMIT added for navigation, to
1048             // enable its display. Adding it higher in the code
1049             // to $sql_query would create a problem when
1050             // using the Refresh or Edit links.
1051
1052             // Only append it on SELECTs.
1053
1054             /**
1055              * @todo what would be the best to do when someone hits Refresh:
1056              * use the current LIMITs ?
1057              */
1058
1059             if (isset($analyzed_display_query[0]['queryflags']['select_from'])
1060              && isset($GLOBALS['sql_limit_to_append'])) {
1061                 $query_base = $analyzed_display_query[0]['section_before_limit']
1062                     . "\n" . $GLOBALS['sql_limit_to_append']
1063                     . $analyzed_display_query[0]['section_after_limit'];
1064                 // Need to reparse query
1065                 $parsed_sql = PMA_SQP_parse($query_base);
1066             }
1067         }
1068
1069         if (! empty($GLOBALS['show_as_php'])) {
1070             $query_base = '$sql  = "' . $query_base;
1071         } elseif (! empty($GLOBALS['validatequery'])) {
1072             try {
1073                 $query_base = PMA_validateSQL($query_base);
1074             } catch (Exception $e) {
1075                 PMA_Message::error(__('Failed to connect to SQL validator!'))->display();
1076             }
1077         } elseif (isset($parsed_sql)) {
1078             $query_base = PMA_formatSql($parsed_sql, $query_base);
1079         }
1080
1081         // Prepares links that may be displayed to edit/explain the query
1082         // (don't go to default pages, we must go to the page
1083         // where the query box is available)
1084
1085         // Basic url query part
1086         $url_params = array();
1087         if (! isset($GLOBALS['db'])) {
1088             $GLOBALS['db'] = '';
1089         }
1090         if (strlen($GLOBALS['db'])) {
1091             $url_params['db'] = $GLOBALS['db'];
1092             if (strlen($GLOBALS['table'])) {
1093                 $url_params['table'] = $GLOBALS['table'];
1094                 $edit_link = 'tbl_sql.php';
1095             } else {
1096                 $edit_link = 'db_sql.php';
1097             }
1098         } else {
1099             $edit_link = 'server_sql.php';
1100         }
1101
1102         // Want to have the query explained (Mike Beck 2002-05-22)
1103         // but only explain a SELECT (that has not been explained)
1104         /* SQL-Parser-Analyzer */
1105         $explain_link = '';
1106         if (! empty($cfg['SQLQuery']['Explain']) && ! $query_too_big) {
1107             $explain_params = $url_params;
1108             // Detect if we are validating as well
1109             // To preserve the validate uRL data
1110             if (! empty($GLOBALS['validatequery'])) {
1111                 $explain_params['validatequery'] = 1;
1112             }
1113
1114             if (preg_match('@^SELECT[[:space:]]+@i', $sql_query)) {
1115                 $explain_params['sql_query'] = 'EXPLAIN ' . $sql_query;
1116                 $_message = __('Explain SQL');
1117             } elseif (preg_match('@^EXPLAIN[[:space:]]+SELECT[[:space:]]+@i', $sql_query)) {
1118                 $explain_params['sql_query'] = substr($sql_query, 8);
1119                 $_message = __('Skip Explain SQL');
1120             }
1121             if (isset($explain_params['sql_query'])) {
1122                 $explain_link = 'import.php' . PMA_generate_common_url($explain_params);
1123                 $explain_link = ' [' . PMA_linkOrButton($explain_link, $_message) . ']';
1124             }
1125         } //show explain
1126
1127         $url_params['sql_query']  = $sql_query;
1128         $url_params['show_query'] = 1;
1129
1130         // even if the query is big and was truncated, offer the chance
1131         // to edit it (unless it's enormous, see PMA_linkOrButton() )
1132         if (! empty($cfg['SQLQuery']['Edit'])) {
1133             if ($cfg['EditInWindow'] == true) {
1134                 $onclick = 'window.parent.focus_querywindow(\'' . PMA_jsFormat($sql_query, false) . '\'); return false;';
1135             } else {
1136                 $onclick = '';
1137             }
1138
1139             $edit_link .= PMA_generate_common_url($url_params) . '#querybox';
1140             $edit_link = ' [' . PMA_linkOrButton($edit_link, __('Edit'), array('onclick' => $onclick)) . ']';
1141         } else {
1142             $edit_link = '';
1143         }
1144
1145         $url_qpart = PMA_generate_common_url($url_params);
1146
1147         // Also we would like to get the SQL formed in some nice
1148         // php-code (Mike Beck 2002-05-22)
1149         if (! empty($cfg['SQLQuery']['ShowAsPHP']) && ! $query_too_big) {
1150             $php_params = $url_params;
1151
1152             if (! empty($GLOBALS['show_as_php'])) {
1153                 $_message = __('Without PHP Code');
1154             } else {
1155                 $php_params['show_as_php'] = 1;
1156                 $_message = __('Create PHP Code');
1157             }
1158
1159             $php_link = 'import.php' . PMA_generate_common_url($php_params);
1160             $php_link = ' [' . PMA_linkOrButton($php_link, $_message) . ']';
1161
1162             if (isset($GLOBALS['show_as_php'])) {
1163                 $runquery_link = 'import.php' . PMA_generate_common_url($url_params);
1164                 $php_link .= ' [' . PMA_linkOrButton($runquery_link, __('Submit Query')) . ']';
1165             }
1166         } else {
1167             $php_link = '';
1168         } //show as php
1169
1170         // Refresh query
1171         if (! empty($cfg['SQLQuery']['Refresh'])
1172          && preg_match('@^(SELECT|SHOW)[[:space:]]+@i', $sql_query)) {
1173             $refresh_link = 'import.php' . PMA_generate_common_url($url_params);
1174             $refresh_link = ' [' . PMA_linkOrButton($refresh_link, __('Refresh')) . ']';
1175         } else {
1176             $refresh_link = '';
1177         } //show as php
1178
1179         if (! empty($cfg['SQLValidator']['use'])
1180          && ! empty($cfg['SQLQuery']['Validate'])) {
1181             $validate_params = $url_params;
1182             if (!empty($GLOBALS['validatequery'])) {
1183                 $validate_message = __('Skip Validate SQL') ;
1184             } else {
1185                 $validate_params['validatequery'] = 1;
1186                 $validate_message = __('Validate SQL') ;
1187             }
1188
1189             $validate_link = 'import.php' . PMA_generate_common_url($validate_params);
1190             $validate_link = ' [' . PMA_linkOrButton($validate_link, $validate_message) . ']';
1191         } else {
1192             $validate_link = '';
1193         } //validator
1194
1195         if (!empty($GLOBALS['validatequery'])) {
1196             echo '<div class="sqlvalidate">';
1197         } else {
1198             echo '<code class="sql">';
1199         }
1200         if ($query_too_big) {
1201             echo $shortened_query_base;
1202         } else {
1203             echo $query_base;
1204         }
1205
1206         //Clean up the end of the PHP
1207         if (! empty($GLOBALS['show_as_php'])) {
1208             echo '";';
1209         }
1210         if (!empty($GLOBALS['validatequery'])) {
1211             echo '</div>';
1212         } else {
1213             echo '</code>';
1214         }
1215
1216         echo '<div class="tools">';
1217         // avoid displaying a Profiling checkbox that could
1218         // be checked, which would reexecute an INSERT, for example
1219         if (! empty($refresh_link)) {
1220             PMA_profilingCheckbox($sql_query);
1221         }
1222         // if needed, generate an invisible form that contains controls for the
1223         // Inline link; this way, the behavior of the Inline link does not
1224         // depend on the profiling support or on the refresh link
1225         if (empty($refresh_link) || ! PMA_profilingSupported()) {
1226             echo '<form action="sql.php" method="post">';
1227             echo PMA_generate_common_hidden_inputs($GLOBALS['db'], $GLOBALS['table']);
1228             echo '<input type="hidden" name="sql_query" value="' . htmlspecialchars($sql_query) . '" />';
1229             echo '</form>';
1230         }
1231
1232         // in the tools div, only display the Inline link when not in ajax
1233         // mode because 1) it currently does not work and 2) we would
1234         // have two similar mechanisms on the page for the same goal
1235         if ($GLOBALS['is_ajax_request'] === false) {
1236         // see in js/functions.js the jQuery code attached to id inline_edit
1237         // document.write conflicts with jQuery, hence used $().append()
1238             echo "<script type=\"text/javascript\">\n" .
1239                 "//<![CDATA[\n" .
1240                 "$('.tools').append('[<a href=\"#\" title=\"" .
1241                 PMA_escapeJsString(__('Inline edit of this query')) .
1242                 "\" id=\"inline_edit\">" .
1243                 PMA_escapeJsString(__('Inline')) .
1244                 "</a>]');\n" .
1245                 "//]]>\n" .
1246                 "</script>";
1247         }
1248         echo $edit_link . $explain_link . $php_link . $refresh_link . $validate_link;
1249         echo '</div>';
1250     }
1251     echo '</div><br />' . "\n";
1252
1253     // If we are in an Ajax request, we have most probably been called in
1254     // PMA_ajaxResponse().  Hence, collect the buffer contents and return it
1255     // to PMA_ajaxResponse(), which will encode it for JSON.
1256     if( $GLOBALS['is_ajax_request'] == true && !isset($GLOBALS['buffer_message']) ) {
1257         $buffer_contents =  ob_get_contents();
1258         ob_end_clean();
1259         return $buffer_contents;
1260     }
1261 } // end of the 'PMA_showMessage()' function
1262
1263 /**
1264  * Verifies if current MySQL server supports profiling
1265  *
1266  * @uses    $_SESSION['profiling_supported'] for caching
1267  * @uses    $GLOBALS['server']
1268  * @uses    PMA_DBI_fetch_value()
1269  * @uses    PMA_MYSQL_INT_VERSION
1270  * @uses    defined()
1271  * @access  public
1272  * @return  boolean whether profiling is supported
1273  *
1274  */
1275 function PMA_profilingSupported()
1276 {
1277     if (! PMA_cacheExists('profiling_supported', true)) {
1278         // 5.0.37 has profiling but for example, 5.1.20 does not
1279         // (avoid a trip to the server for MySQL before 5.0.37)
1280         // and do not set a constant as we might be switching servers
1281         if (defined('PMA_MYSQL_INT_VERSION')
1282          && PMA_MYSQL_INT_VERSION >= 50037
1283          && PMA_DBI_fetch_value("SHOW VARIABLES LIKE 'profiling'")) {
1284             PMA_cacheSet('profiling_supported', true, true);
1285         } else {
1286             PMA_cacheSet('profiling_supported', false, true);
1287         }
1288     }
1289
1290     return PMA_cacheGet('profiling_supported', true);
1291 }
1292
1293 /**
1294  * Displays a form with the Profiling checkbox
1295  *
1296  * @param   string  $sql_query
1297  * @access  public
1298  *
1299  */
1300 function PMA_profilingCheckbox($sql_query)
1301 {
1302     if (PMA_profilingSupported()) {
1303         echo '<form action="sql.php" method="post">' . "\n";
1304         echo PMA_generate_common_hidden_inputs($GLOBALS['db'], $GLOBALS['table']);
1305         echo '<input type="hidden" name="sql_query" value="' . htmlspecialchars($sql_query) . '" />' . "\n";
1306         echo '<input type="hidden" name="profiling_form" value="1" />' . "\n";
1307         PMA_display_html_checkbox('profiling', __('Profiling'), isset($_SESSION['profiling']), true);
1308         echo '<noscript><input type="submit" value="' . __('Go') . '" /></noscript>' . "\n";
1309         echo '</form>' . "\n";
1310     }
1311 }
1312
1313 /**
1314  * Displays the results of SHOW PROFILE
1315  *
1316  * @param    array   the results
1317  * @param    boolean show chart
1318  * @access  public
1319  *
1320  */
1321 function PMA_profilingResults($profiling_results, $show_chart = false)
1322 {
1323     echo '<fieldset><legend>' . __('Profiling') . '</legend>' . "\n";
1324     echo '<div style="float: left;">';
1325     echo '<table>' . "\n";
1326     echo ' <tr>' .  "\n";
1327     echo '  <th>' . __('Status') . '</th>' . "\n";
1328     echo '  <th>' . __('Time') . '</th>' . "\n";
1329     echo ' </tr>' .  "\n";
1330
1331     foreach($profiling_results as $one_result) {
1332         echo ' <tr>' .  "\n";
1333         echo '<td>' . $one_result['Status'] . '</td>' .  "\n";
1334         echo '<td>' . $one_result['Duration'] . '</td>' .  "\n";
1335     }
1336
1337     echo '</table>' . "\n";
1338     echo '</div>';
1339
1340     if ($show_chart) {
1341         require_once './libraries/chart.lib.php';
1342         echo '<div style="float: left;">';
1343         PMA_chart_profiling($profiling_results);
1344         echo '</div>';
1345     }
1346
1347     echo '</fieldset>' . "\n";
1348 }
1349
1350 /**
1351  * Formats $value to byte view
1352  *
1353  * @param    double   the value to format
1354  * @param    integer  the sensitiveness
1355  * @param    integer  the number of decimals to retain
1356  *
1357  * @return   array    the formatted value and its unit
1358  *
1359  * @access  public
1360  *
1361  * @version  1.2 - 18 July 2002
1362  */
1363 function PMA_formatByteDown($value, $limes = 6, $comma = 0)
1364 {
1365     /* l10n: shortcuts for Byte, Kilo, Mega, Giga, Tera, Peta, Exa+ */
1366     $byteUnits = array(__('B'), __('KiB'), __('MiB'), __('GiB'), __('TiB'), __('PiB'), __('EiB'));
1367
1368     $dh           = PMA_pow(10, $comma);
1369     $li           = PMA_pow(10, $limes);
1370     $return_value = $value;
1371     $unit         = $byteUnits[0];
1372
1373     for ($d = 6, $ex = 15; $d >= 1; $d--, $ex-=3) {
1374         if (isset($byteUnits[$d]) && $value >= $li * PMA_pow(10, $ex)) {
1375             // use 1024.0 to avoid integer overflow on 64-bit machines
1376             $value = round($value / (PMA_pow(1024, $d) / $dh)) /$dh;
1377             $unit = $byteUnits[$d];
1378             break 1;
1379         } // end if
1380     } // end for
1381
1382     if ($unit != $byteUnits[0]) {
1383         // if the unit is not bytes (as represented in current language)
1384         // reformat with max length of 5
1385         // 4th parameter=true means do not reformat if value < 1
1386         $return_value = PMA_formatNumber($value, 5, $comma, true);
1387     } else {
1388         // do not reformat, just handle the locale
1389         $return_value = PMA_formatNumber($value, 0);
1390     }
1391
1392     return array(trim($return_value), $unit);
1393 } // end of the 'PMA_formatByteDown' function
1394
1395 /**
1396  * Changes thousands and decimal separators to locale specific values.
1397  */
1398 function PMA_localizeNumber($value)
1399 {
1400     return str_replace(
1401         array(',', '.'),
1402         array(
1403             /* l10n: Thousands separator */
1404             __(','),
1405             /* l10n: Decimal separator */
1406             __('.'),
1407             ),
1408         $value);
1409 }
1410
1411 /**
1412  * Formats $value to the given length and appends SI prefixes
1413  * $comma is not substracted from the length
1414  * with a $length of 0 no truncation occurs, number is only formated
1415  * to the current locale
1416  *
1417  * examples:
1418  * <code>
1419  * echo PMA_formatNumber(123456789, 6);     // 123,457 k
1420  * echo PMA_formatNumber(-123456789, 4, 2); //    -123.46 M
1421  * echo PMA_formatNumber(-0.003, 6);        //      -3 m
1422  * echo PMA_formatNumber(0.003, 3, 3);      //       0.003
1423  * echo PMA_formatNumber(0.00003, 3, 2);    //       0.03 m
1424  * echo PMA_formatNumber(0, 6);             //       0
1425  *
1426  * </code>
1427  * @param   double   $value     the value to format
1428  * @param   integer  $length    the max length
1429  * @param   integer  $comma     the number of decimals to retain
1430  * @param   boolean  $only_down do not reformat numbers below 1
1431  *
1432  * @return  string   the formatted value and its unit
1433  *
1434  * @access  public
1435  *
1436  * @version 1.1.0 - 2005-10-27
1437  */
1438 function PMA_formatNumber($value, $length = 3, $comma = 0, $only_down = false)
1439 {
1440     //number_format is not multibyte safe, str_replace is safe
1441     if ($length === 0) {
1442         return PMA_localizeNumber(number_format($value, $comma));
1443     }
1444
1445     // this units needs no translation, ISO
1446     $units = array(
1447         -8 => 'y',
1448         -7 => 'z',
1449         -6 => 'a',
1450         -5 => 'f',
1451         -4 => 'p',
1452         -3 => 'n',
1453         -2 => '&micro;',
1454         -1 => 'm',
1455         0 => ' ',
1456         1 => 'k',
1457         2 => 'M',
1458         3 => 'G',
1459         4 => 'T',
1460         5 => 'P',
1461         6 => 'E',
1462         7 => 'Z',
1463         8 => 'Y'
1464     );
1465
1466     // we need at least 3 digits to be displayed
1467     if (3 > $length + $comma) {
1468         $length = 3 - $comma;
1469     }
1470
1471     // check for negative value to retain sign
1472     if ($value < 0) {
1473         $sign = '-';
1474         $value = abs($value);
1475     } else {
1476         $sign = '';
1477     }
1478
1479     $dh = PMA_pow(10, $comma);
1480     $li = PMA_pow(10, $length);
1481     $unit = $units[0];
1482
1483     if ($value >= 1) {
1484         for ($d = 8; $d >= 0; $d--) {
1485             if (isset($units[$d]) && $value >= $li * PMA_pow(1000, $d-1)) {
1486                 $value = round($value / (PMA_pow(1000, $d) / $dh)) /$dh;
1487                 $unit = $units[$d];
1488                 break 1;
1489             } // end if
1490         } // end for
1491     } elseif (!$only_down && (float) $value !== 0.0) {
1492         for ($d = -8; $d <= 8; $d++) {
1493             // force using pow() because of the negative exponent
1494             if (isset($units[$d]) && $value <= $li * PMA_pow(1000, $d-1, 'pow')) {
1495                 $value = round($value / (PMA_pow(1000, $d, 'pow') / $dh)) /$dh;
1496                 $unit = $units[$d];
1497                 break 1;
1498             } // end if
1499         } // end for
1500     } // end if ($value >= 1) elseif (!$only_down && (float) $value !== 0.0)
1501
1502     //number_format is not multibyte safe, str_replace is safe
1503     $value = PMA_localizeNumber(number_format($value, $comma));
1504
1505     return $sign . $value . ' ' . $unit;
1506 } // end of the 'PMA_formatNumber' function
1507
1508 /**
1509  * Returns the number of bytes when a formatted size is given
1510  *
1511  * @param   string   $size     the size expression (for example 8MB)
1512  * @uses    PMA_pow()
1513  * @return  integer  The numerical part of the expression (for example 8)
1514  */
1515 function PMA_extractValueFromFormattedSize($formatted_size)
1516 {
1517     $return_value = -1;
1518
1519     if (preg_match('/^[0-9]+GB$/', $formatted_size)) {
1520         $return_value = substr($formatted_size, 0, -2) * PMA_pow(1024, 3);
1521     } elseif (preg_match('/^[0-9]+MB$/', $formatted_size)) {
1522         $return_value = substr($formatted_size, 0, -2) * PMA_pow(1024, 2);
1523     } elseif (preg_match('/^[0-9]+K$/', $formatted_size)) {
1524         $return_value = substr($formatted_size, 0, -1) * PMA_pow(1024, 1);
1525     }
1526     return $return_value;
1527 }// end of the 'PMA_extractValueFromFormattedSize' function
1528
1529 /**
1530  * Writes localised date
1531  *
1532  * @param   string   the current timestamp
1533  *
1534  * @return  string   the formatted date
1535  *
1536  * @access  public
1537  */
1538 function PMA_localisedDate($timestamp = -1, $format = '')
1539 {
1540     $month = array(
1541 /* l10n: Short month name */
1542         __('Jan'),
1543 /* l10n: Short month name */
1544         __('Feb'),
1545 /* l10n: Short month name */
1546         __('Mar'),
1547 /* l10n: Short month name */
1548         __('Apr'),
1549 /* l10n: Short month name */
1550         _pgettext('Short month name', 'May'),
1551 /* l10n: Short month name */
1552         __('Jun'),
1553 /* l10n: Short month name */
1554         __('Jul'),
1555 /* l10n: Short month name */
1556         __('Aug'),
1557 /* l10n: Short month name */
1558         __('Sep'),
1559 /* l10n: Short month name */
1560         __('Oct'),
1561 /* l10n: Short month name */
1562         __('Nov'),
1563 /* l10n: Short month name */
1564         __('Dec'));
1565     $day_of_week = array(
1566 /* l10n: Short week day name */
1567         __('Sun'),
1568 /* l10n: Short week day name */
1569         __('Mon'),
1570 /* l10n: Short week day name */
1571         __('Tue'),
1572 /* l10n: Short week day name */
1573         __('Wed'),
1574 /* l10n: Short week day name */
1575         __('Thu'),
1576 /* l10n: Short week day name */
1577         __('Fri'),
1578 /* l10n: Short week day name */
1579         __('Sat'));
1580
1581     if ($format == '') {
1582         /* l10n: See http://www.php.net/manual/en/function.strftime.php to define the format string */
1583         $format = __('%B %d, %Y at %I:%M %p');
1584     }
1585
1586     if ($timestamp == -1) {
1587         $timestamp = time();
1588     }
1589
1590     $date = preg_replace('@%[aA]@', $day_of_week[(int)strftime('%w', $timestamp)], $format);
1591     $date = preg_replace('@%[bB]@', $month[(int)strftime('%m', $timestamp)-1], $date);
1592
1593     return strftime($date, $timestamp);
1594 } // end of the 'PMA_localisedDate()' function
1595
1596
1597 /**
1598  * returns a tab for tabbed navigation.
1599  * If the variables $link and $args ar left empty, an inactive tab is created
1600  *
1601  * @uses    $GLOBALS['PMA_PHP_SELF']
1602  * @uses    $GLOBALS['active_page']
1603  * @uses    $GLOBALS['url_query']
1604  * @uses    $cfg['MainPageIconic']
1605  * @uses    $GLOBALS['pmaThemeImage']
1606  * @uses    PMA_generate_common_url()
1607  * @uses    E_USER_NOTICE
1608  * @uses    htmlentities()
1609  * @uses    urlencode()
1610  * @uses    sprintf()
1611  * @uses    trigger_error()
1612  * @uses    array_merge()
1613  * @uses    basename()
1614  * @param   array   $tab    array with all options
1615  * @param   array   $url_params
1616  * @return  string  html code for one tab, a link if valid otherwise a span
1617  * @access  public
1618  */
1619 function PMA_generate_html_tab($tab, $url_params = array())
1620 {
1621     // default values
1622     $defaults = array(
1623         'text'      => '',
1624         'class'     => '',
1625         'active'    => null,
1626         'link'      => '',
1627         'sep'       => '?',
1628         'attr'      => '',
1629         'args'      => '',
1630         'warning'   => '',
1631         'fragment'  => '',
1632         'id'        => '',
1633     );
1634
1635     $tab = array_merge($defaults, $tab);
1636
1637     // determine additionnal style-class
1638     if (empty($tab['class'])) {
1639         if ($tab['text'] == __('Empty')
1640             || $tab['text'] == __('Drop')) {
1641             $tab['class'] = 'caution';
1642         } elseif (! empty($tab['active'])
1643          || PMA_isValid($GLOBALS['active_page'], 'identical', $tab['link'])) {
1644             $tab['class'] = 'active';
1645         } elseif (is_null($tab['active']) && empty($GLOBALS['active_page'])
1646           && basename($GLOBALS['PMA_PHP_SELF']) == $tab['link']
1647           && empty($tab['warning'])) {
1648             $tab['class'] = 'active';
1649         }
1650     }
1651
1652     if (!empty($tab['warning'])) {
1653         $tab['class'] .= ' warning';
1654         $tab['attr'] .= ' title="' . htmlspecialchars($tab['warning']) . '"';
1655     }
1656
1657         // If there are any tab specific URL parameters, merge those with the general URL parameters
1658         if(! empty($tab['url_params']) && is_array($tab['url_params'])) {
1659                 $url_params = array_merge($url_params, $tab['url_params']);
1660         }
1661
1662     // build the link
1663     if (!empty($tab['link'])) {
1664         $tab['link'] = htmlentities($tab['link']);
1665         $tab['link'] = $tab['link'] . PMA_generate_common_url($url_params);
1666         if (! empty($tab['args'])) {
1667             foreach ($tab['args'] as $param => $value) {
1668                 $tab['link'] .= PMA_get_arg_separator('html') . urlencode($param) . '='
1669                     . urlencode($value);
1670             }
1671         }
1672     }
1673
1674     if (! empty($tab['fragment'])) {
1675         $tab['link'] .= $tab['fragment'];
1676     }
1677
1678     // display icon, even if iconic is disabled but the link-text is missing
1679     if (($GLOBALS['cfg']['MainPageIconic'] || empty($tab['text']))
1680         && isset($tab['icon'])) {
1681         // avoid generating an alt tag, because it only illustrates
1682         // the text that follows and if browser does not display
1683         // images, the text is duplicated
1684         $image = '<img class="icon" src="' . htmlentities($GLOBALS['pmaThemeImage'])
1685             .'%1$s" width="16" height="16" alt="" />%2$s';
1686         $tab['text'] = sprintf($image, htmlentities($tab['icon']), $tab['text']);
1687     }
1688     // check to not display an empty link-text
1689     elseif (empty($tab['text'])) {
1690         $tab['text'] = '?';
1691         trigger_error('empty linktext in function ' . __FUNCTION__ . '()',
1692             E_USER_NOTICE);
1693     }
1694
1695     //Set the id for the tab, if set in the params
1696     $id_string = ( empty($tab['id']) ? '' : ' id="'.$tab['id'].'" ' );
1697     $out = '<li' . ($tab['class'] == 'active' ? ' class="active"' : '') . '>';
1698
1699     if (!empty($tab['link'])) {
1700         $out .= '<a class="tab' . htmlentities($tab['class']) . '"'
1701             .$id_string
1702             .' href="' . $tab['link'] . '" ' . $tab['attr'] . '>'
1703             . $tab['text'] . '</a>';
1704     } else {
1705         $out .= '<span class="tab' . htmlentities($tab['class']) . '"'.$id_string.'>'
1706             . $tab['text'] . '</span>';
1707     }
1708
1709     $out .= '</li>';
1710     return $out;
1711 } // end of the 'PMA_generate_html_tab()' function
1712
1713 /**
1714  * returns html-code for a tab navigation
1715  *
1716  * @uses    PMA_generate_html_tab()
1717  * @uses    htmlentities()
1718  * @param   array   $tabs   one element per tab
1719  * @param   string  $url_params
1720  * @return  string  html-code for tab-navigation
1721  */
1722 function PMA_generate_html_tabs($tabs, $url_params)
1723 {
1724     $tag_id = 'topmenu';
1725     $tab_navigation =
1726          '<div id="' . htmlentities($tag_id) . 'container">' . "\n"
1727         .'<ul id="' . htmlentities($tag_id) . '">' . "\n";
1728
1729     foreach ($tabs as $tab) {
1730         $tab_navigation .= PMA_generate_html_tab($tab, $url_params) . "\n";
1731     }
1732
1733     $tab_navigation .=
1734          '</ul>' . "\n"
1735         .'<div class="clearfloat"></div>'
1736         .'</div>' . "\n";
1737
1738     return $tab_navigation;
1739 }
1740
1741
1742 /**
1743  * Displays a link, or a button if the link's URL is too large, to
1744  * accommodate some browsers' limitations
1745  *
1746  * @param  string  the URL
1747  * @param  string  the link message
1748  * @param  mixed   $tag_params  string: js confirmation
1749  *                              array: additional tag params (f.e. style="")
1750  * @param  boolean $new_form    we set this to false when we are already in
1751  *                              a  form, to avoid generating nested forms
1752  *
1753  * @return string  the results to be echoed or saved in an array
1754  */
1755 function PMA_linkOrButton($url, $message, $tag_params = array(),
1756     $new_form = true, $strip_img = false, $target = '')
1757 {
1758     $url_length = strlen($url);
1759     // with this we should be able to catch case of image upload
1760     // into a (MEDIUM) BLOB; not worth generating even a form for these
1761     if ($url_length > $GLOBALS['cfg']['LinkLengthLimit'] * 100) {
1762         return '';
1763     }
1764
1765     if (! is_array($tag_params)) {
1766         $tmp = $tag_params;
1767         $tag_params = array();
1768         if (!empty($tmp)) {
1769             $tag_params['onclick'] = 'return confirmLink(this, \'' . PMA_escapeJsString($tmp) . '\')';
1770         }
1771         unset($tmp);
1772     }
1773     if (! empty($target)) {
1774         $tag_params['target'] = htmlentities($target);
1775     }
1776
1777     $tag_params_strings = array();
1778     foreach ($tag_params as $par_name => $par_value) {
1779         // htmlspecialchars() only on non javascript
1780         $par_value = substr($par_name, 0, 2) == 'on'
1781             ? $par_value
1782             : htmlspecialchars($par_value);
1783         $tag_params_strings[] = $par_name . '="' . $par_value . '"';
1784     }
1785
1786     if ($url_length <= $GLOBALS['cfg']['LinkLengthLimit']) {
1787         // no whitespace within an <a> else Safari will make it part of the link
1788         $ret = "\n" . '<a href="' . $url . '" '
1789             . implode(' ', $tag_params_strings) . '>'
1790             . $message . '</a>' . "\n";
1791     } else {
1792         // no spaces (linebreaks) at all
1793         // or after the hidden fields
1794         // IE will display them all
1795
1796         // add class=link to submit button
1797         if (empty($tag_params['class'])) {
1798             $tag_params['class'] = 'link';
1799         }
1800
1801         // decode encoded url separators
1802         $separator   = PMA_get_arg_separator();
1803         // on most places separator is still hard coded ...
1804         if ($separator !== '&') {
1805             // ... so always replace & with $separator
1806             $url         = str_replace(htmlentities('&'), $separator, $url);
1807             $url         = str_replace('&', $separator, $url);
1808         }
1809         $url         = str_replace(htmlentities($separator), $separator, $url);
1810         // end decode
1811
1812         $url_parts   = parse_url($url);
1813         $query_parts = explode($separator, $url_parts['query']);
1814         if ($new_form) {
1815             $ret = '<form action="' . $url_parts['path'] . '" class="link"'
1816                  . ' method="post"' . $target . ' style="display: inline;">';
1817             $subname_open   = '';
1818             $subname_close  = '';
1819             $submit_name    = '';
1820         } else {
1821             $query_parts[] = 'redirect=' . $url_parts['path'];
1822             if (empty($GLOBALS['subform_counter'])) {
1823                 $GLOBALS['subform_counter'] = 0;
1824             }
1825             $GLOBALS['subform_counter']++;
1826             $ret            = '';
1827             $subname_open   = 'subform[' . $GLOBALS['subform_counter'] . '][';
1828             $subname_close  = ']';
1829             $submit_name    = ' name="usesubform[' . $GLOBALS['subform_counter'] . ']"';
1830         }
1831         foreach ($query_parts as $query_pair) {
1832             list($eachvar, $eachval) = explode('=', $query_pair);
1833             $ret .= '<input type="hidden" name="' . $subname_open . $eachvar
1834                 . $subname_close . '" value="'
1835                 . htmlspecialchars(urldecode($eachval)) . '" />';
1836         } // end while
1837
1838         if (stristr($message, '<img')) {
1839             if ($strip_img) {
1840                 $message = trim(strip_tags($message));
1841                 $ret .= '<input type="submit"' . $submit_name . ' '
1842                     . implode(' ', $tag_params_strings)
1843                     . ' value="' . htmlspecialchars($message) . '" />';
1844             } else {
1845                 $displayed_message = htmlspecialchars(
1846                         preg_replace('/^.*\salt="([^"]*)".*$/si', '\1',
1847                             $message));
1848                 $ret .= '<input type="image"' . $submit_name . ' '
1849                     . implode(' ', $tag_params_strings)
1850                     . ' src="' . preg_replace(
1851                         '/^.*\ssrc="([^"]*)".*$/si', '\1', $message) . '"'
1852                     . ' value="' . $displayed_message . '" title="' . $displayed_message . '" />';
1853             }
1854         } else {
1855             $message = trim(strip_tags($message));
1856             $ret .= '<input type="submit"' . $submit_name . ' '
1857                 . implode(' ', $tag_params_strings)
1858                 . ' value="' . htmlspecialchars($message) . '" />';
1859         }
1860         if ($new_form) {
1861             $ret .= '</form>';
1862         }
1863     } // end if... else...
1864
1865         return $ret;
1866 } // end of the 'PMA_linkOrButton()' function
1867
1868
1869 /**
1870  * Returns a given timespan value in a readable format.
1871  *
1872  * @uses    sprintf()
1873  * @uses    floor()
1874  * @param  int     the timespan
1875  *
1876  * @return string  the formatted value
1877  */
1878 function PMA_timespanFormat($seconds)
1879 {
1880     $return_string = '';
1881     $days = floor($seconds / 86400);
1882     if ($days > 0) {
1883         $seconds -= $days * 86400;
1884     }
1885     $hours = floor($seconds / 3600);
1886     if ($days > 0 || $hours > 0) {
1887         $seconds -= $hours * 3600;
1888     }
1889     $minutes = floor($seconds / 60);
1890     if ($days > 0 || $hours > 0 || $minutes > 0) {
1891         $seconds -= $minutes * 60;
1892     }
1893     return sprintf(__('%s days, %s hours, %s minutes and %s seconds'), (string)$days, (string)$hours, (string)$minutes, (string)$seconds);
1894 }
1895
1896 /**
1897  * Takes a string and outputs each character on a line for itself. Used
1898  * mainly for horizontalflipped display mode.
1899  * Takes care of special html-characters.
1900  * Fulfills todo-item
1901  * http://sf.net/tracker/?func=detail&aid=544361&group_id=23067&atid=377411
1902  *
1903  * @todo    add a multibyte safe function PMA_STR_split()
1904  * @uses    strlen
1905  * @param   string   The string
1906  * @param   string   The Separator (defaults to "<br />\n")
1907  *
1908  * @access  public
1909  * @return  string      The flipped string
1910  */
1911 function PMA_flipstring($string, $Separator = "<br />\n")
1912 {
1913     $format_string = '';
1914     $charbuff = false;
1915
1916     for ($i = 0, $str_len = strlen($string); $i < $str_len; $i++) {
1917         $char = $string{$i};
1918         $append = false;
1919
1920         if ($char == '&') {
1921             $format_string .= $charbuff;
1922             $charbuff = $char;
1923         } elseif ($char == ';' && !empty($charbuff)) {
1924             $format_string .= $charbuff . $char;
1925             $charbuff = false;
1926             $append = true;
1927         } elseif (! empty($charbuff)) {
1928             $charbuff .= $char;
1929         } else {
1930             $format_string .= $char;
1931             $append = true;
1932         }
1933
1934         // do not add separator after the last character
1935         if ($append && ($i != $str_len - 1)) {
1936             $format_string .= $Separator;
1937         }
1938     }
1939
1940     return $format_string;
1941 }
1942
1943
1944 /**
1945  * Function added to avoid path disclosures.
1946  * Called by each script that needs parameters, it displays
1947  * an error message and, by default, stops the execution.
1948  *
1949  * Not sure we could use a strMissingParameter message here,
1950  * would have to check if the error message file is always available
1951  *
1952  * @todo    localize error message
1953  * @todo    use PMA_fatalError() if $die === true?
1954  * @uses    PMA_getenv()
1955  * @uses    header_meta_style.inc.php
1956  * @uses    $GLOBALS['PMA_PHP_SELF']
1957  * basename
1958  * @param   array   The names of the parameters needed by the calling
1959  *                  script.
1960  * @param   boolean Stop the execution?
1961  *                  (Set this manually to false in the calling script
1962  *                   until you know all needed parameters to check).
1963  * @param   boolean Whether to include this list in checking for special params.
1964  * @global  string  path to current script
1965  * @global  boolean flag whether any special variable was required
1966  *
1967  * @access  public
1968  */
1969 function PMA_checkParameters($params, $die = true, $request = true)
1970 {
1971     global $checked_special;
1972
1973     if (!isset($checked_special)) {
1974         $checked_special = false;
1975     }
1976
1977     $reported_script_name = basename($GLOBALS['PMA_PHP_SELF']);
1978     $found_error = false;
1979     $error_message = '';
1980
1981     foreach ($params as $param) {
1982         if ($request && $param != 'db' && $param != 'table') {
1983             $checked_special = true;
1984         }
1985
1986         if (!isset($GLOBALS[$param])) {
1987             $error_message .= $reported_script_name
1988                 . ': Missing parameter: ' . $param
1989                 . PMA_showDocu('faqmissingparameters')
1990                 . '<br />';
1991             $found_error = true;
1992         }
1993     }
1994     if ($found_error) {
1995         /**
1996          * display html meta tags
1997          */
1998         require_once './libraries/header_meta_style.inc.php';
1999         echo '</head><body><p>' . $error_message . '</p></body></html>';
2000         if ($die) {
2001             exit();
2002         }
2003     }
2004 } // end function
2005
2006 /**
2007  * Function to generate unique condition for specified row.
2008  *
2009  * @uses    $GLOBALS['analyzed_sql'][0]
2010  * @uses    PMA_DBI_field_flags()
2011  * @uses    PMA_backquote()
2012  * @uses    PMA_sqlAddslashes()
2013  * @uses    PMA_printable_bit_value()
2014  * @uses    stristr()
2015  * @uses    bin2hex()
2016  * @uses    preg_replace()
2017  * @param   resource    $handle         current query result
2018  * @param   integer     $fields_cnt     number of fields
2019  * @param   array       $fields_meta    meta information about fields
2020  * @param   array       $row            current row
2021  * @param   boolean     $force_unique   generate condition only on pk or unique
2022  *
2023  * @access  public
2024  * @return  string     the calculated condition and whether condition is unique
2025  */
2026 function PMA_getUniqueCondition($handle, $fields_cnt, $fields_meta, $row, $force_unique=false)
2027 {
2028     $primary_key          = '';
2029     $unique_key           = '';
2030     $nonprimary_condition = '';
2031     $preferred_condition = '';
2032
2033     for ($i = 0; $i < $fields_cnt; ++$i) {
2034         $condition   = '';
2035         $field_flags = PMA_DBI_field_flags($handle, $i);
2036         $meta        = $fields_meta[$i];
2037
2038         // do not use a column alias in a condition
2039         if (! isset($meta->orgname) || ! strlen($meta->orgname)) {
2040             $meta->orgname = $meta->name;
2041
2042             if (isset($GLOBALS['analyzed_sql'][0]['select_expr'])
2043               && is_array($GLOBALS['analyzed_sql'][0]['select_expr'])) {
2044                 foreach ($GLOBALS['analyzed_sql'][0]['select_expr']
2045                   as $select_expr) {
2046                     // need (string) === (string)
2047                     // '' !== 0 but '' == 0
2048                     if ((string) $select_expr['alias'] === (string) $meta->name) {
2049                         $meta->orgname = $select_expr['column'];
2050                         break;
2051                     } // end if
2052                 } // end foreach
2053             }
2054         }
2055
2056         // Do not use a table alias in a condition.
2057         // Test case is:
2058         // select * from galerie x WHERE
2059         //(select count(*) from galerie y where y.datum=x.datum)>1
2060         //
2061         // But orgtable is present only with mysqli extension so the
2062         // fix is only for mysqli.
2063         // Also, do not use the original table name if we are dealing with
2064         // a view because this view might be updatable.
2065         // (The isView() verification should not be costly in most cases
2066         // because there is some caching in the function).
2067         if (isset($meta->orgtable) && $meta->table != $meta->orgtable && ! PMA_Table::isView($GLOBALS['db'], $meta->table)) {
2068             $meta->table = $meta->orgtable;
2069         }
2070
2071         // to fix the bug where float fields (primary or not)
2072         // can't be matched because of the imprecision of
2073         // floating comparison, use CONCAT
2074         // (also, the syntax "CONCAT(field) IS NULL"
2075         // that we need on the next "if" will work)
2076         if ($meta->type == 'real') {
2077             $condition = ' CONCAT(' . PMA_backquote($meta->table) . '.'
2078                 . PMA_backquote($meta->orgname) . ') ';
2079         } else {
2080             $condition = ' ' . PMA_backquote($meta->table) . '.'
2081                 . PMA_backquote($meta->orgname) . ' ';
2082         } // end if... else...
2083
2084         if (!isset($row[$i]) || is_null($row[$i])) {
2085             $condition .= 'IS NULL AND';
2086         } else {
2087             // timestamp is numeric on some MySQL 4.1
2088             // for real we use CONCAT above and it should compare to string
2089             if ($meta->numeric && $meta->type != 'timestamp' && $meta->type != 'real') {
2090                 $condition .= '= ' . $row[$i] . ' AND';
2091             } elseif (($meta->type == 'blob' || $meta->type == 'string')
2092                 // hexify only if this is a true not empty BLOB or a BINARY
2093                  && stristr($field_flags, 'BINARY')
2094                  && !empty($row[$i])) {
2095                     // do not waste memory building a too big condition
2096                     if (strlen($row[$i]) < 1000) {
2097                         // use a CAST if possible, to avoid problems
2098                         // if the field contains wildcard characters % or _
2099                         $condition .= '= CAST(0x' . bin2hex($row[$i])
2100                             . ' AS BINARY) AND';
2101                     } else {
2102                         // this blob won't be part of the final condition
2103                         $condition = '';
2104                     }
2105             } elseif ($meta->type == 'bit') {
2106                 $condition .= "= b'" . PMA_printable_bit_value($row[$i], $meta->length) . "' AND";
2107             } else {
2108                 $condition .= '= \''
2109                     . PMA_sqlAddslashes($row[$i], false, true) . '\' AND';
2110             }
2111         }
2112         if ($meta->primary_key > 0) {
2113             $primary_key .= $condition;
2114         } elseif ($meta->unique_key > 0) {
2115             $unique_key  .= $condition;
2116         }
2117         $nonprimary_condition .= $condition;
2118     } // end for
2119
2120     // Correction University of Virginia 19991216:
2121     // prefer primary or unique keys for condition,
2122     // but use conjunction of all values if no primary key
2123     $clause_is_unique = true;
2124     if ($primary_key) {
2125         $preferred_condition = $primary_key;
2126     } elseif ($unique_key) {
2127         $preferred_condition = $unique_key;
2128     } elseif (! $force_unique) {
2129         $preferred_condition = $nonprimary_condition;
2130         $clause_is_unique = false;
2131     }
2132
2133     $where_clause = trim(preg_replace('|\s?AND$|', '', $preferred_condition));
2134     return(array($where_clause, $clause_is_unique));
2135 } // end function
2136
2137 /**
2138  * Generate a button or image tag
2139  *
2140  * @uses    PMA_USR_BROWSER_AGENT
2141  * @uses    $GLOBALS['pmaThemeImage']
2142  * @uses    $GLOBALS['cfg']['PropertiesIconic']
2143  * @param   string      name of button element
2144  * @param   string      class of button element
2145  * @param   string      name of image element
2146  * @param   string      text to display
2147  * @param   string      image to display
2148  *
2149  * @access  public
2150  */
2151 function PMA_buttonOrImage($button_name, $button_class, $image_name, $text,
2152     $image)
2153 {
2154     if (false === $GLOBALS['cfg']['PropertiesIconic']) {
2155         echo ' <input type="submit" name="' . $button_name . '"'
2156                 .' value="' . htmlspecialchars($text) . '"'
2157                 .' title="' . htmlspecialchars($text) . '" />' . "\n";
2158         return;
2159     }
2160
2161     /* Opera has trouble with <input type="image"> */
2162     /* IE has trouble with <button> */
2163     if (PMA_USR_BROWSER_AGENT != 'IE') {
2164         echo '<button class="' . $button_class . '" type="submit"'
2165             .' name="' . $button_name . '" value="' . htmlspecialchars($text) . '"'
2166             .' title="' . htmlspecialchars($text) . '">' . "\n"
2167             . PMA_getIcon($image, $text)
2168             .'</button>' . "\n";
2169     } else {
2170         echo '<input type="image" name="' . $image_name . '" value="'
2171             . htmlspecialchars($text) . '" title="' . htmlspecialchars($text) . '" src="' . $GLOBALS['pmaThemeImage']
2172             . $image . '" />'
2173             . ($GLOBALS['cfg']['PropertiesIconic'] === 'both' ? '&nbsp;' . htmlspecialchars($text) : '') . "\n";
2174     }
2175 } // end function
2176
2177 /**
2178  * Generate a pagination selector for browsing resultsets
2179  *
2180  * @todo $url is not javascript escaped!?
2181  * @uses    range()
2182  * @param   string      URL for the JavaScript
2183  * @param   string      Number of rows in the pagination set
2184  * @param   string      current page number
2185  * @param   string      number of total pages
2186  * @param   string      If the number of pages is lower than this
2187  *                      variable, no pages will be omitted in
2188  *                      pagination
2189  * @param   string      How many rows at the beginning should always
2190  *                      be shown?
2191  * @param   string      How many rows at the end should always
2192  *                      be shown?
2193  * @param   string      Percentage of calculation page offsets to
2194  *                      hop to a next page
2195  * @param   string      Near the current page, how many pages should
2196  *                      be considered "nearby" and displayed as
2197  *                      well?
2198  * @param   string      The prompt to display (sometimes empty)
2199  *
2200  * @access  public
2201  */
2202 function PMA_pageselector($url, $rows, $pageNow = 1, $nbTotalPage = 1,
2203     $showAll = 200, $sliceStart = 5, $sliceEnd = 5, $percent = 20,
2204     $range = 10, $prompt = '')
2205 {
2206     $increment = floor($nbTotalPage / $percent);
2207     $pageNowMinusRange = ($pageNow - $range);
2208     $pageNowPlusRange = ($pageNow + $range);
2209
2210     $gotopage = $prompt
2211               . ' <select id="pageselector" name="pos" >' . "\n";
2212     if ($nbTotalPage < $showAll) {
2213         $pages = range(1, $nbTotalPage);
2214     } else {
2215         $pages = array();
2216
2217         // Always show first X pages
2218         for ($i = 1; $i <= $sliceStart; $i++) {
2219             $pages[] = $i;
2220         }
2221
2222         // Always show last X pages
2223         for ($i = $nbTotalPage - $sliceEnd; $i <= $nbTotalPage; $i++) {
2224             $pages[] = $i;
2225         }
2226
2227         // Based on the number of results we add the specified
2228         // $percent percentage to each page number,
2229         // so that we have a representing page number every now and then to
2230         // immediately jump to specific pages.
2231         // As soon as we get near our currently chosen page ($pageNow -
2232         // $range), every page number will be shown.
2233         $i = $sliceStart;
2234         $x = $nbTotalPage - $sliceEnd;
2235         $met_boundary = false;
2236         while ($i <= $x) {
2237             if ($i >= $pageNowMinusRange && $i <= $pageNowPlusRange) {
2238                 // If our pageselector comes near the current page, we use 1
2239                 // counter increments
2240                 $i++;
2241                 $met_boundary = true;
2242             } else {
2243                 // We add the percentage increment to our current page to
2244                 // hop to the next one in range
2245                 $i += $increment;
2246
2247                 // Make sure that we do not cross our boundaries.
2248                 if ($i > $pageNowMinusRange && ! $met_boundary) {
2249                     $i = $pageNowMinusRange;
2250                 }
2251             }
2252
2253             if ($i > 0 && $i <= $x) {
2254                 $pages[] = $i;
2255             }
2256         }
2257
2258         // Since because of ellipsing of the current page some numbers may be double,
2259         // we unify our array:
2260         sort($pages);
2261         $pages = array_unique($pages);
2262     }
2263
2264     foreach ($pages as $i) {
2265         if ($i == $pageNow) {
2266             $selected = 'selected="selected" style="font-weight: bold"';
2267         } else {
2268             $selected = '';
2269         }
2270         $gotopage .= '                <option ' . $selected . ' value="' . (($i - 1) * $rows) . '">' . $i . '</option>' . "\n";
2271     }
2272
2273     $gotopage .= ' </select><noscript><input type="submit" value="' . __('Go') . '" /></noscript>';
2274
2275     return $gotopage;
2276 } // end function
2277
2278
2279 /**
2280  * Generate navigation for a list
2281  *
2282  * @todo    use $pos from $_url_params
2283  * @uses    range()
2284  * @param   integer     number of elements in the list
2285  * @param   integer     current position in the list
2286  * @param   array       url parameters
2287  * @param   string      script name for form target
2288  * @param   string      target frame
2289  * @param   integer     maximum number of elements to display from the list
2290  *
2291  * @access  public
2292  */
2293 function PMA_listNavigator($count, $pos, $_url_params, $script, $frame, $max_count) {
2294
2295     if ($max_count < $count) {
2296         echo 'frame_navigation' == $frame ? '<div id="navidbpageselector">' . "\n" : '';
2297         echo __('Page number:');
2298         echo 'frame_navigation' == $frame ? '<br />' : ' ';
2299
2300         // Move to the beginning or to the previous page
2301         if ($pos > 0) {
2302             // patch #474210 - part 1
2303             if ($GLOBALS['cfg']['NavigationBarIconic']) {
2304                 $caption1 = '&lt;&lt;';
2305                 $caption2 = ' &lt; ';
2306                 $title1   = ' title="' . __('Begin') . '"';
2307                 $title2   = ' title="' . __('Previous') . '"';
2308             } else {
2309                 $caption1 = __('Begin') . ' &lt;&lt;';
2310                 $caption2 = __('Previous') . ' &lt;';
2311                 $title1   = '';
2312                 $title2   = '';
2313             } // end if... else...
2314             $_url_params['pos'] = 0;
2315             echo '<a' . $title1 . ' href="' . $script
2316                 . PMA_generate_common_url($_url_params) . '" target="' . $frame . '">'
2317                 . $caption1 . '</a>';
2318             $_url_params['pos'] = $pos - $max_count;
2319             echo '<a' . $title2 . ' href="' . $script
2320                 . PMA_generate_common_url($_url_params) . '" target="' . $frame . '">'
2321                 . $caption2 . '</a>';
2322         }
2323
2324         echo "\n", '<form action="./', basename($script), '" method="post" target="', $frame, '">', "\n";
2325         echo PMA_generate_common_hidden_inputs($_url_params);
2326         echo PMA_pageselector(
2327             $script . PMA_generate_common_url($_url_params) . '&amp;',
2328                 $max_count,
2329                 floor(($pos + 1) / $max_count) + 1,
2330                 ceil($count / $max_count));
2331         echo '</form>';
2332
2333         if ($pos + $max_count < $count) {
2334             if ($GLOBALS['cfg']['NavigationBarIconic']) {
2335                 $caption3 = ' &gt; ';
2336                 $caption4 = '&gt;&gt;';
2337                 $title3   = ' title="' . __('Next') . '"';
2338                 $title4   = ' title="' . __('End') . '"';
2339             } else {
2340                 $caption3 = '&gt; ' . __('Next');
2341                 $caption4 = '&gt;&gt; ' . __('End');
2342                 $title3   = '';
2343                 $title4   = '';
2344             } // end if... else...
2345             $_url_params['pos'] = $pos + $max_count;
2346             echo '<a' . $title3 . ' href="' . $script
2347                 . PMA_generate_common_url($_url_params) . '" target="' . $frame . '">'
2348                 . $caption3 . '</a>';
2349             $_url_params['pos'] = floor($count / $max_count) * $max_count;
2350             if ($_url_params['pos'] == $count) {
2351                 $_url_params['pos'] = $count - $max_count;
2352             }
2353             echo '<a' . $title4 . ' href="' . $script
2354                 . PMA_generate_common_url($_url_params) . '" target="' . $frame . '">'
2355                 . $caption4 . '</a>';
2356         }
2357         echo "\n";
2358         if ('frame_navigation' == $frame) {
2359             echo '</div>' . "\n";
2360         }
2361     }
2362 }
2363
2364 /**
2365  * replaces %u in given path with current user name
2366  *
2367  * example:
2368  * <code>
2369  * $user_dir = PMA_userDir('/var/pma_tmp/%u/'); // '/var/pma_tmp/root/'
2370  *
2371  * </code>
2372  * @uses    $cfg['Server']['user']
2373  * @uses    substr()
2374  * @uses    str_replace()
2375  * @param   string  $dir with wildcard for user
2376  * @return  string  per user directory
2377  */
2378 function PMA_userDir($dir)
2379 {
2380     // add trailing slash
2381     if (substr($dir, -1) != '/') {
2382         $dir .= '/';
2383     }
2384
2385     return str_replace('%u', $GLOBALS['cfg']['Server']['user'], $dir);
2386 }
2387
2388 /**
2389  * returns html code for db link to default db page
2390  *
2391  * @uses    $cfg['DefaultTabDatabase']
2392  * @uses    $GLOBALS['db']
2393  * @uses    PMA_generate_common_url()
2394  * @uses    PMA_unescape_mysql_wildcards()
2395  * @uses    strlen()
2396  * @uses    sprintf()
2397  * @uses    htmlspecialchars()
2398  * @param   string  $database
2399  * @return  string  html link to default db page
2400  */
2401 function PMA_getDbLink($database = null)
2402 {
2403     if (!strlen($database)) {
2404         if (!strlen($GLOBALS['db'])) {
2405             return '';
2406         }
2407         $database = $GLOBALS['db'];
2408     } else {
2409         $database = PMA_unescape_mysql_wildcards($database);
2410     }
2411
2412     return '<a href="' . $GLOBALS['cfg']['DefaultTabDatabase'] . '?' . PMA_generate_common_url($database) . '"'
2413         .' title="' . sprintf(__('Jump to database &quot;%s&quot;.'), htmlspecialchars($database)) . '">'
2414         .htmlspecialchars($database) . '</a>';
2415 }
2416
2417 /**
2418  * Displays a lightbulb hint explaining a known external bug
2419  * that affects a functionality
2420  *
2421  * @uses    PMA_MYSQL_INT_VERSION
2422  * @uses    PMA_showHint()
2423  * @uses    sprintf()
2424  * @param   string  $functionality localized message explaining the func.
2425  * @param   string  $component  'mysql' (eventually, 'php')
2426  * @param   string  $minimum_version of this component
2427  * @param   string  $bugref  bug reference for this component
2428  */
2429 function PMA_externalBug($functionality, $component, $minimum_version, $bugref)
2430 {
2431     if ($component == 'mysql' && PMA_MYSQL_INT_VERSION < $minimum_version) {
2432         echo PMA_showHint(sprintf(__('The %s functionality is affected by a known bug, see %s'), $functionality, 'http://bugs.mysql.com/' . $bugref));
2433     }
2434 }
2435
2436 /**
2437  * Generates and echoes an HTML checkbox
2438  *
2439  * @param   string  $html_field_name the checkbox HTML field
2440  * @param   string  $label
2441  * @param   boolean $checked is it initially checked?
2442  * @param   boolean $onclick should it submit the form on click?
2443  */
2444 function PMA_display_html_checkbox($html_field_name, $label, $checked, $onclick) {
2445
2446     echo '<input type="checkbox" name="' . $html_field_name . '" id="' . $html_field_name . '"' . ($checked ? ' checked="checked"' : '') . ($onclick ? ' onclick="this.form.submit();"' : '') . ' /><label for="' . $html_field_name . '">' . $label . '</label>';
2447 }
2448
2449 /**
2450  * Generates and echoes a set of radio HTML fields
2451  *
2452  * @uses    htmlspecialchars()
2453  * @param   string  $html_field_name the radio HTML field
2454  * @param   array   $choices the choices values and labels
2455  * @param   string  $checked_choice the choice to check by default
2456  * @param   boolean $line_break whether to add an HTML line break after a choice
2457  * @param   boolean $escape_label whether to use htmlspecialchars() on label
2458  * @param   string  $class enclose each choice with a div of this class
2459  */
2460 function PMA_display_html_radio($html_field_name, $choices, $checked_choice = '', $line_break = true, $escape_label = true, $class='') {
2461     foreach ($choices as $choice_value => $choice_label) {
2462         if (! empty($class)) {
2463             echo '<div class="' . $class . '">';
2464         }
2465         $html_field_id = $html_field_name . '_' . $choice_value;
2466         echo '<input type="radio" name="' . $html_field_name . '" id="' . $html_field_id . '" value="' . htmlspecialchars($choice_value) . '"';
2467         if ($choice_value == $checked_choice) {
2468             echo ' checked="checked"';
2469         }
2470         echo ' />' . "\n";
2471         echo '<label for="' . $html_field_id . '">' . ($escape_label ? htmlspecialchars($choice_label)  : $choice_label) . '</label>';
2472         if ($line_break) {
2473             echo '<br />';
2474         }
2475         if (! empty($class)) {
2476             echo '</div>';
2477         }
2478         echo "\n";
2479     }
2480 }
2481
2482 /**
2483  * Generates and returns an HTML dropdown
2484  *
2485  * @uses    htmlspecialchars()
2486  * @param   string  $select_name
2487  * @param   array   $choices the choices values
2488  * @param   string  $active_choice the choice to select by default
2489  * @param   string  $id the id of the select element; can be different in case
2490  *                  the dropdown is present more than once on the page
2491  * @todo    support titles
2492  */
2493 function PMA_generate_html_dropdown($select_name, $choices, $active_choice, $id)
2494 {
2495     $result = '<select name="' . htmlspecialchars($select_name) . '" id="' . htmlspecialchars($id) . '">';
2496     foreach ($choices as $one_choice_value => $one_choice_label) {
2497         $result .= '<option value="' . htmlspecialchars($one_choice_value) . '"';
2498         if ($one_choice_value == $active_choice) {
2499             $result .= ' selected="selected"';
2500         }
2501         $result .= '>' . htmlspecialchars($one_choice_label) . '</option>';
2502     }
2503     $result .= '</select>';
2504     return $result;
2505 }
2506
2507 /**
2508  * Generates a slider effect (jQjuery)
2509  * Takes care of generating the initial <div> and the link
2510  * controlling the slider; you have to generate the </div> yourself
2511  * after the sliding section.
2512  *
2513  * @uses    $GLOBALS['cfg']['InitialSlidersState']
2514  * @param   string  $id the id of the <div> on which to apply the effect
2515  * @param   string  $message the message to show as a link
2516  */
2517 function PMA_generate_slider_effect($id, $message)
2518 {
2519     if ($GLOBALS['cfg']['InitialSlidersState'] == 'disabled') {
2520         echo '<div id="' . $id . '">';
2521         return;
2522     }
2523     /**
2524      * Bad hack on the next line. document.write() conflicts with jQuery, hence,
2525      * opening the <div> with PHP itself instead of JavaScript.
2526      *
2527      * @todo find a better solution that uses $.append(), the recommended method
2528      * maybe by using an additional param, the id of the div to append to
2529      */
2530     ?>
2531 <div id="<?php echo $id; ?>" <?php echo $GLOBALS['cfg']['InitialSlidersState'] == 'closed' ? ' style="display: none; overflow:auto;"' : ''; ?>>
2532     <script type="text/javascript">
2533 // <![CDATA[
2534
2535     function PMA_set_status_label_<?php echo $id; ?>() {
2536         if ($('#<?php echo $id; ?>').css('display') == 'none') {
2537             $('#anchor_status_<?php echo $id; ?>').text('+ ');
2538         } else {
2539             $('#anchor_status_<?php echo $id; ?>').text('- ');
2540         }
2541     }
2542
2543     $(document).ready(function() {
2544
2545         $('<span id="anchor_status_<?php echo $id; ?>"><span>')
2546             .insertBefore('#<?php echo $id; ?>')
2547
2548         PMA_set_status_label_<?php echo $id; ?>();
2549
2550         $('<a href="#<?php echo $id; ?>" id="anchor_<?php echo $id; ?>"><?php echo htmlspecialchars($message); ?></a>')
2551             .insertBefore('#<?php echo $id; ?>')
2552             .click(function() {
2553                 // the callback should be the 4th parameter but
2554                 // it only works as the second parameter
2555                 $('#<?php echo $id; ?>').toggle('drop', function() {
2556                     PMA_set_status_label_<?php echo $id; ?>();
2557                 });
2558             });
2559     });
2560     //]]>
2561     </script>
2562     <noscript>
2563     <div id="<?php echo $id; ?>"></div>
2564     </noscript>
2565     <?php
2566 }
2567
2568 /**
2569  * Verifies if something is cached in the session
2570  *
2571  * @param string $var
2572  * @param scalar $server
2573  * @return boolean
2574  */
2575 function PMA_cacheExists($var, $server = 0)
2576 {
2577     if (true === $server) {
2578         $server = $GLOBALS['server'];
2579     }
2580     return isset($_SESSION['cache']['server_' . $server][$var]);
2581 }
2582
2583 /**
2584  * Gets cached information from the session
2585  *
2586  * @param string $var
2587  * @param scalar $server
2588  * @return mixed
2589  */
2590 function PMA_cacheGet($var, $server = 0)
2591 {
2592     if (true === $server) {
2593         $server = $GLOBALS['server'];
2594     }
2595     if (isset($_SESSION['cache']['server_' . $server][$var])) {
2596         return $_SESSION['cache']['server_' . $server][$var];
2597     } else {
2598         return null;
2599     }
2600 }
2601
2602 /**
2603  * Caches information in the session
2604  *
2605  * @param string $var
2606  * @param mixed $val
2607  * @param integer $server
2608  * @return mixed
2609  */
2610 function PMA_cacheSet($var, $val = null, $server = 0)
2611 {
2612     if (true === $server) {
2613         $server = $GLOBALS['server'];
2614     }
2615     $_SESSION['cache']['server_' . $server][$var] = $val;
2616 }
2617
2618 /**
2619  * Removes cached information from the session
2620  *
2621  * @param string $var
2622  * @param scalar $server
2623  */
2624 function PMA_cacheUnset($var, $server = 0)
2625 {
2626     if (true === $server) {
2627         $server = $GLOBALS['server'];
2628     }
2629     unset($_SESSION['cache']['server_' . $server][$var]);
2630 }
2631
2632 /**
2633  * Converts a bit value to printable format;
2634  * in MySQL a BIT field can be from 1 to 64 bits so we need this
2635  * function because in PHP, decbin() supports only 32 bits
2636  *
2637  * @uses    ceil()
2638  * @uses    decbin()
2639  * @uses    ord()
2640  * @uses    substr()
2641  * @uses    sprintf()
2642  * @param   numeric $value coming from a BIT field
2643  * @param   integer $length
2644  * @return  string  the printable value
2645  */
2646 function PMA_printable_bit_value($value, $length) {
2647     $printable = '';
2648     for ($i = 0, $len_ceiled = ceil($length / 8); $i < $len_ceiled; $i++) {
2649         $printable .= sprintf('%08d', decbin(ord(substr($value, $i, 1))));
2650     }
2651     $printable = substr($printable, -$length);
2652     return $printable;
2653 }
2654
2655 /**
2656  * Verifies whether the value contains a non-printable character
2657  *
2658  * @uses    preg_match()
2659  * @param   string $value
2660  * @return  boolean
2661  */
2662 function PMA_contains_nonprintable_ascii($value) {
2663     return preg_match('@[^[:print:]]@', $value);
2664 }
2665
2666 /**
2667  * Converts a BIT type default value
2668  * for example, b'010' becomes 010
2669  *
2670  * @uses    strtr()
2671  * @param   string $bit_default_value
2672  * @return  string the converted value
2673  */
2674 function PMA_convert_bit_default_value($bit_default_value) {
2675     return strtr($bit_default_value, array("b" => "", "'" => ""));
2676 }
2677
2678 /**
2679  * Extracts the various parts from a field type spec
2680  *
2681  * @uses    strpos()
2682  * @uses    chop()
2683  * @uses    substr()
2684  * @param   string $fieldspec
2685  * @return  array associative array containing type, spec_in_brackets
2686  *          and possibly enum_set_values (another array)
2687  */
2688 function PMA_extractFieldSpec($fieldspec) {
2689     $first_bracket_pos = strpos($fieldspec, '(');
2690     if ($first_bracket_pos) {
2691         $spec_in_brackets = chop(substr($fieldspec, $first_bracket_pos + 1, (strrpos($fieldspec, ')') - $first_bracket_pos - 1)));
2692         // convert to lowercase just to be sure
2693         $type = strtolower(chop(substr($fieldspec, 0, $first_bracket_pos)));
2694     } else {
2695         $type = $fieldspec;
2696         $spec_in_brackets = '';
2697     }
2698
2699     if ('enum' == $type || 'set' == $type) {
2700         // Define our working vars
2701         $enum_set_values = array();
2702         $working = "";
2703         $in_string = false;
2704         $index = 0;
2705
2706         // While there is another character to process
2707         while (isset($fieldspec[$index])) {
2708             // Grab the char to look at
2709             $char = $fieldspec[$index];
2710
2711             // If it is a single quote, needs to be handled specially
2712             if ($char == "'") {
2713                 // If we are not currently in a string, begin one
2714                 if (! $in_string) {
2715                     $in_string = true;
2716                     $working = "";
2717                 // Otherwise, it may be either an end of a string, or a 'double quote' which can be handled as-is
2718                 } else {
2719                 // Check out the next character (if possible)
2720                     $has_next = isset($fieldspec[$index + 1]);
2721                     $next = $has_next ? $fieldspec[$index + 1] : null;
2722
2723                 // If we have reached the end of our 'working' string (because there are no more chars, or the next char is not another quote)
2724                     if (! $has_next || $next != "'") {
2725                         $enum_set_values[] = $working;
2726                         $in_string = false;
2727
2728                     // Otherwise, this is a 'double quote', and can be added to the working string
2729                     } elseif ($next == "'") {
2730                         $working .= "'";
2731                         // Skip the next char; we already know what it is
2732                         $index++;
2733                     }
2734                 }
2735             // escaping of a quote?
2736             } elseif ('\\' == $char && isset($fieldspec[$index + 1]) && "'" == $fieldspec[$index + 1]) {
2737                 $working .= "'";
2738                 $index++;
2739             // Otherwise, add it to our working string like normal
2740             } else {
2741                 $working .= $char;
2742             }
2743             // Increment character index
2744             $index++;
2745         } // end while
2746     } else {
2747         $enum_set_values = array();
2748     }
2749
2750     return array(
2751         'type' => $type,
2752         'spec_in_brackets' => $spec_in_brackets,
2753         'enum_set_values'  => $enum_set_values
2754     );
2755 }
2756
2757 /**
2758  * Verifies if this table's engine supports foreign keys
2759  *
2760  * @uses    strtoupper()
2761  * @param   string $engine
2762  * @return  boolean
2763  */
2764 function PMA_foreignkey_supported($engine) {
2765     $engine = strtoupper($engine);
2766     if ('INNODB' == $engine || 'PBXT' == $engine) {
2767         return true;
2768     } else {
2769         return false;
2770     }
2771 }
2772
2773 /**
2774  * Replaces some characters by a displayable equivalent
2775  *
2776  * @uses    str_replace()
2777  * @param   string $content
2778  * @return  string the content with characters replaced
2779  */
2780 function PMA_replace_binary_contents($content) {
2781     $result = str_replace("\x00", '\0', $content);
2782     $result = str_replace("\x08", '\b', $result);
2783     $result = str_replace("\x0a", '\n', $result);
2784     $result = str_replace("\x0d", '\r', $result);
2785     $result = str_replace("\x1a", '\Z', $result);
2786     return $result;
2787 }
2788
2789 /**
2790  *
2791  * If the string starts with a \r\n pair (0x0d0a) add an extra \n
2792  *
2793  * @uses    strpos()
2794  * @return  string with the chars replaced
2795  */
2796
2797 function PMA_duplicateFirstNewline($string){
2798     $first_occurence = strpos($string, "\r\n");
2799     if ($first_occurence === 0){
2800         $string = "\n".$string;
2801     }
2802     return $string;
2803 }
2804
2805 /**
2806  * get the action word corresponding to a script name
2807  * in order to display it as a title in navigation panel
2808  *
2809  * @uses    $GLOBALS
2810  * @param   string  a valid value for $cfg['LeftDefaultTabTable']
2811  *                  or $cfg['DefaultTabTable']
2812  *                  or $cfg['DefaultTabDatabase']
2813  */
2814 function PMA_getTitleForTarget($target) {
2815
2816 $mapping = array(
2817         // Values for $cfg['DefaultTabTable']
2818         'tbl_structure.php' =>  __('Structure'),
2819         'tbl_sql.php' => __('SQL'),
2820         'tbl_select.php' =>__('Search'),
2821         'tbl_change.php' =>__('Insert'),
2822         'sql.php' => __('Browse'),
2823
2824         // Values for $cfg['DefaultTabDatabase']
2825         'db_structure.php' => __('Structure'),
2826         'db_sql.php' => __('SQL'),
2827         'db_search.php' => __('Search'),
2828         'db_operations.php' => __('Operations'),
2829 );
2830     return $mapping[$target];
2831 }
2832
2833 /**
2834  * Formats user string, expading @VARIABLES@, accepting strftime format string.
2835  *
2836  * @param string Text where to do expansion.
2837  * @param function Function to call for escaping variable values.
2838  * @param array Array with overrides for default parameters (obtained from GLOBALS).
2839  */
2840 function PMA_expandUserString($string, $escape = NULL, $updates = array()) {
2841     /* Content */
2842     $vars['http_host'] = PMA_getenv('HTTP_HOST') ? PMA_getenv('HTTP_HOST') : '';
2843     $vars['server_name'] = $GLOBALS['cfg']['Server']['host'];
2844     $vars['server_verbose'] = $GLOBALS['cfg']['Server']['verbose'];
2845     $vars['server_verbose_or_name'] = !empty($GLOBALS['cfg']['Server']['verbose']) ? $GLOBALS['cfg']['Server']['verbose'] : $GLOBALS['cfg']['Server']['host'];
2846     $vars['database'] = $GLOBALS['db'];
2847     $vars['table'] = $GLOBALS['table'];
2848     $vars['phpmyadmin_version'] = 'phpMyAdmin ' . PMA_VERSION;
2849
2850     /* Update forced variables */
2851     foreach($updates as $key => $val) {
2852         $vars[$key] = $val;
2853     }
2854
2855     /* Replacement mapping */
2856     /*
2857      * The __VAR__ ones are for backward compatibility, because user
2858      * might still have it in cookies.
2859      */
2860     $replace = array(
2861         '@HTTP_HOST@' => $vars['http_host'],
2862         '@SERVER@' => $vars['server_name'],
2863         '__SERVER__' => $vars['server_name'],
2864         '@VERBOSE@' => $vars['server_verbose'],
2865         '@VSERVER@' => $vars['server_verbose_or_name'],
2866         '@DATABASE@' => $vars['database'],
2867         '__DB__' => $vars['database'],
2868         '@TABLE@' => $vars['table'],
2869         '__TABLE__' => $vars['table'],
2870         '@PHPMYADMIN@' => $vars['phpmyadmin_version'],
2871         );
2872
2873     /* Optional escaping */
2874     if (!is_null($escape)) {
2875         foreach($replace as $key => $val) {
2876             $replace[$key] = $escape($val);
2877         }
2878     }
2879
2880     /* Fetch fields list if required */
2881     if (strpos($string, '@FIELDS@') !== FALSE) {
2882         $fields_list = PMA_DBI_fetch_result(
2883             'SHOW COLUMNS FROM ' . PMA_backquote($GLOBALS['db'])
2884             . '.' . PMA_backquote($GLOBALS['table']));
2885
2886         $field_names = array();
2887         foreach ($fields_list as $field) {
2888             if (!is_null($escape)) {
2889                 $field_names[] = $escape($field['Field']);
2890             } else {
2891                 $field_names[] = $field['Field'];
2892             }
2893         }
2894
2895         $replace['@FIELDS@'] = implode(',', $field_names);
2896     }
2897
2898     /* Do the replacement */
2899     return str_replace(array_keys($replace), array_values($replace), strftime($string));
2900 }
2901
2902 /**
2903  * function that generates a json output for an ajax request and ends script
2904  * execution
2905  *
2906  * @param   boolean success whether the ajax request was successfull
2907  * @param   string  message string containing the html of the message
2908  * @param   array   extra_data  optional - any other data as part of the json request
2909  *
2910  * @uses    header()
2911  * @uses    json_encode()
2912  */
2913 function PMA_ajaxResponse($message, $success = true, $extra_data = array())
2914 {
2915     $response = array();
2916     if( $success == true ) {
2917         $response['success'] = true;
2918         if ($message instanceof PMA_Message) {
2919             $response['message'] = $message->getDisplay();
2920         }
2921         else {
2922             $response['message'] = $message;
2923         }
2924     }
2925     else {
2926         $response['success'] = false;
2927         if($message instanceof PMA_Message) {
2928             $response['error'] = $message->getDisplay();
2929         }
2930         else {
2931             $response['error'] = $message;
2932         }
2933     }
2934
2935     // If extra_data has been provided, append it to the response array
2936     if( ! empty($extra_data) && count($extra_data) > 0 ) {
2937         $response = array_merge($response, $extra_data);
2938     }
2939
2940     // Set the Content-Type header to JSON so that jQuery parses the response correctly
2941     if(!isset($GLOBALS['is_header_sent'])) {
2942         header('Cache-Control: no-cache');
2943         header("Content-Type: application/json");
2944     }
2945     echo json_encode($response);
2946     exit;
2947 }
2948
2949 /**
2950  * Display the form used to browse anywhere on the local server for the file to import
2951  */
2952 function PMA_browseUploadFile($max_upload_size) {
2953     $uid = uniqid("");
2954     echo '<label for="radio_import_file">' . __("Browse your computer:") . '</label>';
2955     echo '<div id="upload_form_status" style="display: none;"></div>';
2956     echo '<div id="upload_form_status_info" style="display: none;"></div>';
2957     echo '<input type="file" name="import_file" id="input_import_file" />';
2958     echo PMA_displayMaximumUploadSize($max_upload_size) . "\n";
2959     // some browsers should respect this :)
2960     echo PMA_generateHiddenMaxFileSize($max_upload_size) . "\n";
2961 }
2962
2963 /**
2964  * Display the form used to select a file to import from the server upload directory
2965  */
2966 function PMA_selectUploadFile($import_list, $uploaddir) {
2967         echo '<label for="radio_local_import_file">' . sprintf(__("Select from the web server upload directory <b>%s</b>:"), htmlspecialchars(PMA_userDir($uploaddir))) . '</label>';
2968         $extensions = '';
2969     foreach ($import_list as $key => $val) {
2970         if (!empty($extensions)) {
2971             $extensions .= '|';
2972         }
2973         $extensions .= $val['extension'];
2974     }
2975     $matcher = '@\.(' . $extensions . ')(\.(' . PMA_supportedDecompressions() . '))?$@';
2976
2977     $files = PMA_getFileSelectOptions(PMA_userDir($uploaddir), $matcher, (isset($timeout_passed) && $timeout_passed && isset($local_import_file)) ? $local_import_file : '');
2978     if ($files === FALSE) {
2979         PMA_Message::error(__('The directory you set for upload work cannot be reached'))->display();
2980     } elseif (!empty($files)) {
2981         echo "\n";
2982         echo '    <select style="margin: 5px" size="1" name="local_import_file" id="select_local_import_file">' . "\n";
2983         echo '        <option value="">&nbsp;</option>' . "\n";
2984         echo $files;
2985         echo '    </select>' . "\n";
2986     } elseif (empty ($files)) {
2987         echo '<i>There are no files to upload</i>';
2988     }
2989 }
2990
2991 /**
2992  * Build titles and icons for action links
2993  *
2994  * @return   array   the action titles
2995  * @uses     PMA_getIcon()
2996  */
2997 function PMA_buildActionTitles() {
2998     $titles = array();
2999
3000     $titles['Browse']     = PMA_getIcon('b_browse.png', __('Browse'), true);
3001     $titles['NoBrowse']   = PMA_getIcon('bd_browse.png', __('Browse'), true);
3002     $titles['Search']     = PMA_getIcon('b_select.png', __('Search'), true);
3003     $titles['NoSearch']   = PMA_getIcon('bd_select.png', __('Search'), true);
3004     $titles['Insert']     = PMA_getIcon('b_insrow.png', __('Insert'), true);
3005     $titles['NoInsert']   = PMA_getIcon('bd_insrow.png', __('Insert'), true);
3006     $titles['Structure']  = PMA_getIcon('b_props.png', __('Structure'), true);
3007     $titles['Drop']       = PMA_getIcon('b_drop.png', __('Drop'), true);
3008     $titles['NoDrop']     = PMA_getIcon('bd_drop.png', __('Drop'), true);
3009     $titles['Empty']      = PMA_getIcon('b_empty.png', __('Empty'), true);
3010     $titles['NoEmpty']    = PMA_getIcon('bd_empty.png', __('Empty'), true);
3011     return $titles;
3012 }
3013 ?>