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