2 /* vim: set expandtab sw=4 ts=4 sts=4: */
4 * Misc functions used all over the scripts.
10 * Exponential expression / raise number into power
12 * @uses function_exists()
19 * @param string pow function use, or false for auto-detect
20 * @return mixed string or float
22 function PMA_pow($base, $exp, $use_function = false)
24 static $pow_function = null;
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')) {
32 $pow_function = 'gmp_pow';
35 $pow_function = 'pow';
39 if (! $use_function) {
40 $use_function = $pow_function;
43 if ($exp < 0 && 'pow' != $use_function) {
46 switch ($use_function) {
48 // bcscale() needed for testing PMA_pow() with base values < 1
50 $pow = bcpow($base, $exp);
53 $pow = gmp_strval(gmp_pow($base, $exp));
56 $base = (float) $base;
58 $pow = pow($base, $exp);
61 $pow = $use_function($base, $exp);
68 * string PMA_getIcon(string $icon)
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
79 function PMA_getIcon($icon, $alternate = '', $container = false, $force_text = false)
81 $include_icon = false;
82 $include_text = false;
84 $alternate = htmlspecialchars($alternate);
87 if ($GLOBALS['cfg']['PropertiesIconic']) {
92 ||
! (true === $GLOBALS['cfg']['PropertiesIconic'])
94 // $cfg['PropertiesIconic'] is false or both
95 // OR we have no $include_icon
99 if ($include_text && $include_icon && $container) {
100 // we have icon, text and request for container
105 $button .= '<span class="nowrap">';
109 $button .= '<img src="' . $GLOBALS['pmaThemeImage'] . $icon . '"'
110 . ' title="' . $alternate . '" alt="' . $alternate . '"'
111 . ' class="icon" width="16" height="16" />';
114 if ($include_icon && $include_text) {
119 $button .= $alternate;
123 $button .= '</span>';
130 * Displays the maximum size for an upload
132 * @uses PMA_formatByteDown()
134 * @param integer the size
136 * @return string the message
140 function PMA_displayMaximumUploadSize($max_upload_size)
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) . ')';
149 * Generates a hidden field which should indicate to the browser
150 * the maximum size for upload
152 * @param integer the size
154 * @return string the INPUT field
158 function PMA_generateHiddenMaxFileSize($max_size)
160 return '<input type="hidden" name="MAX_FILE_SIZE" value="' .$max_size . '" />';
164 * Add slashes before "'" and "\" characters so a value containing them can
165 * be used in a sql comparison.
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)
174 * @param boolean whether this function is used as part of the
175 * "Create PHP code" dialog
177 * @return string the slashed string
181 function PMA_sqlAddslashes($a_string = '', $is_like = false, $crlf = false, $php_code = false)
184 $a_string = str_replace('\\', '\\\\\\\\', $a_string);
186 $a_string = str_replace('\\', '\\\\', $a_string);
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);
196 $a_string = str_replace('\'', '\\\'', $a_string);
198 $a_string = str_replace('\'', '\'\'', $a_string);
202 } // end of the 'PMA_sqlAddslashes()' function
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!
210 * @uses str_replace()
211 * @param string the string to escape
213 * @return string the escaped string
217 function PMA_escape_mysql_wildcards($name)
219 $name = str_replace('_', '\\_', $name);
220 $name = str_replace('%', '\\%', $name);
223 } // end of the 'PMA_escape_mysql_wildcards()' function
226 * removes slashes before "_" and "%" characters
227 * Note: This function does not unescape backslashes!
229 * @uses str_replace()
230 * @param string $name the string to escape
231 * @return string the escaped string
234 function PMA_unescape_mysql_wildcards($name)
236 $name = str_replace('\\_', '_', $name);
237 $name = str_replace('\\%', '%', $name);
240 } // end of the 'PMA_unescape_mysql_wildcards()' function
243 * removes quotes (',",`) from a quoted string
245 * checks if the sting is quoted and removes this quotes
247 * @uses str_replace()
249 * @param string $quoted_string string to remove quotes from
250 * @param string $quote type of quote to remove
251 * @return string unqoted string
253 function PMA_unQuote($quoted_string, $quote = null)
257 if (null === $quote) {
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;
275 return $quoted_string;
281 * @todo move into PMA_Sql
282 * @uses PMA_SQP_isError()
283 * @uses PMA_SQP_formatHtml()
284 * @uses PMA_SQP_formatNone()
286 * @param mixed pre-parsed SQL structure
288 * @return string the formatted sql
290 * @global array the configuration array
291 * @global boolean whether the current statement is a multiple one or not
296 function PMA_formatSql($parsed_sql, $unparsed_sql = '')
300 // Check that we actually have a valid set of parsed data
302 // first check for the SQL parser having hit an error
303 if (PMA_SQP_isError()) {
304 return htmlspecialchars($parsed_sql['raw']);
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"
313 return $formatted_sql;
318 switch ($cfg['SQP']['fmtType']) {
320 if ($unparsed_sql != '') {
321 $formatted_sql = '<span class="inner_sql"><pre>' . "\n" . PMA_SQP_formatNone(array('raw' => $unparsed_sql)) . "\n" . '</pre></span>';
323 $formatted_sql = PMA_SQP_formatNone($parsed_sql);
327 $formatted_sql = PMA_SQP_formatHtml($parsed_sql, 'color');
330 $formatted_sql = PMA_SQP_formatHtml($parsed_sql, 'text');
336 return $formatted_sql;
337 } // end of the "PMA_formatSql()" function
341 * Displays a link to the official MySQL documentation
343 * @uses $cfg['MySQLManualType']
344 * @uses $cfg['MySQLManualBase']
345 * @uses $cfg['ReplaceHelpImg']
346 * @uses $GLOBALS['pmaThemeImage']
347 * @uses PMA_MYSQL_INT_VERSION
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
355 * @return string the html link
359 function PMA_showMySQLDocu($chapter, $link, $big_icon = false, $anchor = '', $just_open = false)
363 if ($cfg['MySQLManualType'] == 'none' ||
empty($cfg['MySQLManualBase'])) {
367 // Fixup for newly used names:
368 $chapter = str_replace('_', '-', strtolower($chapter));
369 $link = str_replace('_', '-', strtolower($link));
371 switch ($cfg['MySQLManualType']) {
373 if (empty($chapter)) {
376 if (empty($anchor)) {
379 $url = $cfg['MySQLManualBase'] . '/' . $chapter . '.html#' . $anchor;
382 if (empty($anchor)) {
385 $url = $cfg['MySQLManualBase'] . '#' . $anchor;
391 $url = $cfg['MySQLManualBase'] . '/' . $link . '.html';
392 if (!empty($anchor)) {
393 $url .= '#' . $anchor;
403 if (defined('PMA_MYSQL_INT_VERSION')) {
404 if (PMA_MYSQL_INT_VERSION
>= 50100) {
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) {
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');
414 $url = $cfg['MySQLManualBase'] . '/' . $mysql . '/' . $lang . '/' . $link . '.html';
415 if (!empty($anchor)) {
416 $url .= '#' . $anchor;
422 return '<a href="' . PMA_linkURL($url) . '" target="mysql_doc">';
423 } elseif ($big_icon) {
424 return '<a href="' . PMA_linkURL($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="' . PMA_linkURL($url) . '" target="mysql_doc"><img class="icon" src="' . $GLOBALS['pmaThemeImage'] . 'b_help.png" width="11" height="11" alt="' . __('Documentation') . '" title="' . __('Documentation') . '" /></a>';
428 return '[<a href="' . PMA_linkURL($url) . '" target="mysql_doc">' . __('Documentation') . '</a>]';
430 } // end of the 'PMA_showMySQLDocu()' function
434 * Displays a link to the phpMyAdmin documentation
436 * @param string anchor in documentation
438 * @return string the html link
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>';
446 return '[<a href="Documentation.html#' . $anchor . '" target="documentation">' . __('Documentation') . '</a>]';
448 } // end of the 'PMA_showDocu()' function
451 * returns HTML for a footnote marker and add the messsage to the footnotes
453 * @uses $GLOBALS['footnotes']
454 * @param string the error message
455 * @return string html code for a footnote marker
458 function PMA_showHint($message, $bbcode = false, $type = 'notice')
460 if ($message instanceof PMA_Message
) {
461 $key = $message->getHash();
462 $type = $message->getLevel();
464 $key = md5($message);
467 if (! isset($GLOBALS['footnotes'][$key])) {
468 if (empty($GLOBALS['footnotes']) ||
! is_array($GLOBALS['footnotes'])) {
469 $GLOBALS['footnotes'] = array();
471 $nr = count($GLOBALS['footnotes']) +
1;
472 // this is the first instance of this message
474 $GLOBALS['footnotes'][$key] = array(
478 'instance' => $instance
481 $nr = $GLOBALS['footnotes'][$key]['nr'];
482 // another instance of this message (to ensure ids are unique)
483 $instance = ++
$GLOBALS['footnotes'][$key]['instance'];
487 return '[sup]' . $nr . '[/sup]';
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="" />';
497 * Displays a MySQL error message in the right frame.
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()
517 * @uses str_replace()
520 * @uses preg_replace()
525 * @uses function_exists()
526 * @uses htmlspecialchars()
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?
535 * @global string the curent table
536 * @global string the current db
540 function PMA_mysqlDie($error_message = '', $the_query = '',
541 $is_modify_link = true, $back_url = '', $exit = true)
546 * start http output, display html headers
548 require_once './libraries/header.inc.php';
550 $error_msg_output = '';
552 if (!$error_message) {
553 $error_message = PMA_DBI_getError();
555 if (!$the_query && !empty($GLOBALS['sql_query'])) {
556 $the_query = $GLOBALS['sql_query'];
559 // --- Added to solve bug #641765
560 if (!function_exists('PMA_SQP_isError') ||
PMA_SQP_isError()) {
561 $formatted_sql = htmlspecialchars($the_query);
562 } elseif (empty($the_query) ||
trim($the_query) == '') {
565 if (strlen($the_query) > $GLOBALS['cfg']['MaxCharactersInDisplayedSQL']) {
566 $formatted_sql = htmlspecialchars(substr($the_query, 0, $GLOBALS['cfg']['MaxCharactersInDisplayedSQL'])) . '[...]';
568 $formatted_sql = PMA_formatSql(PMA_SQP_parse($the_query), $the_query);
572 $error_msg_output .= "\n" . '<!-- PMA-SQL-ERROR -->' . "\n";
573 $error_msg_output .= ' <div class="error"><h1>' . __('Error') . '</h1>' . "\n";
574 // if the config password is wrong, or the MySQL server does not
575 // respond, do not show the query that would reveal the
577 if (!empty($the_query) && !strstr($the_query, 'connect')) {
578 // --- Added to solve bug #641765
579 if (function_exists('PMA_SQP_isError') && PMA_SQP_isError()) {
580 $error_msg_output .= PMA_SQP_getErrorString() . "\n";
581 $error_msg_output .= '<br />' . "\n";
584 // modified to show the help on sql errors
585 $error_msg_output .= ' <p><strong>' . __('SQL query') . ':</strong>' . "\n";
586 if (strstr(strtolower($formatted_sql), 'select')) { // please show me help to the error on select
587 $error_msg_output .= PMA_showMySQLDocu('SQL-Syntax', 'SELECT');
589 if ($is_modify_link) {
590 $_url_params = array(
591 'sql_query' => $the_query,
594 if (strlen($table)) {
595 $_url_params['db'] = $db;
596 $_url_params['table'] = $table;
597 $doedit_goto = '<a href="tbl_sql.php?' . PMA_generate_common_url($_url_params) . '">';
598 } elseif (strlen($db)) {
599 $_url_params['db'] = $db;
600 $doedit_goto = '<a href="db_sql.php?' . PMA_generate_common_url($_url_params) . '">';
602 $doedit_goto = '<a href="server_sql.php?' . PMA_generate_common_url($_url_params) . '">';
605 $error_msg_output .= $doedit_goto
606 . PMA_getIcon('b_edit.png', __('Edit'))
609 $error_msg_output .= ' </p>' . "\n"
611 .' ' . $formatted_sql . "\n"
615 if (!empty($error_message)) {
616 $error_message = preg_replace("@((\015\012)|(\015)|(\012)){3,}@", "\n\n", $error_message);
618 // modified to show the help on error-returns
619 // (now error-messages-server)
620 $error_msg_output .= '<p>' . "\n"
621 . ' <strong>' . __('MySQL said: ') . '</strong>'
622 . PMA_showMySQLDocu('Error-messages-server', 'Error-messages-server')
626 // The error message will be displayed within a CODE segment.
627 // To preserve original formatting, but allow wordwrapping, we do a couple of replacements
629 // Replace all non-single blanks with their HTML-counterpart
630 $error_message = str_replace(' ', ' ', $error_message);
631 // Replace TAB-characters with their HTML-counterpart
632 $error_message = str_replace("\t", ' ', $error_message);
633 // Replace linebreaks
634 $error_message = nl2br($error_message);
636 $error_msg_output .= '<code>' . "\n"
637 . $error_message . "\n"
638 . '</code><br />' . "\n";
639 $error_msg_output .= '</div>';
641 $_SESSION['Import_message']['message'] = $error_msg_output;
644 if (! empty($back_url)) {
645 if (strstr($back_url, '?')) {
646 $back_url .= '&no_history=true';
648 $back_url .= '?no_history=true';
651 $_SESSION['Import_message']['go_back_url'] = $back_url;
653 $error_msg_output .= '<fieldset class="tblFooters">';
654 $error_msg_output .= '[ <a href="' . $back_url . '">' . __('Back') . '</a> ]';
655 $error_msg_output .= '</fieldset>' . "\n\n";
659 * If in an Ajax request, don't just echo and exit. Use PMA_ajaxResponse()
661 if($GLOBALS['is_ajax_request'] == true) {
662 PMA_ajaxResponse($error_msg_output, false);
664 echo $error_msg_output;
666 * display footer and exit
668 require './libraries/footer.inc.php';
670 echo $error_msg_output;
672 } // end of the 'PMA_mysqlDie()' function
675 * returns array with tables of given db with extended information and grouped
677 * @uses $cfg['LeftFrameTableSeparator']
678 * @uses $cfg['LeftFrameTableLevel']
679 * @uses $cfg['ShowTooltipAliasTB']
680 * @uses $cfg['NaturalOrder']
681 * @uses PMA_backquote()
687 * @param string $db name of db
688 * @param string $tables name of tables
689 * @param integer $limit_offset list offset
690 * @param integer $limit_count max tables to return
691 * return array (recursive) grouped table list
693 function PMA_getTableList($db, $tables = null, $limit_offset = 0, $limit_count = false)
695 $sep = $GLOBALS['cfg']['LeftFrameTableSeparator'];
697 if (null === $tables) {
698 $tables = PMA_DBI_get_tables_full($db, false, false, null, $limit_offset, $limit_count);
699 if ($GLOBALS['cfg']['NaturalOrder']) {
700 uksort($tables, 'strnatcasecmp');
704 if (count($tables) < 1) {
715 $table_groups = array();
717 // for blobstreaming - list of blobstreaming tables
719 // load PMA configuration
720 $PMA_Config = $GLOBALS['PMA_Config'];
722 foreach ($tables as $table_name => $table) {
723 // if BS tables exist
724 if (PMA_BS_IsHiddenTable($table_name)) {
728 // check for correct row count
729 if (null === $table['Rows']) {
730 // Do not check exact row count here,
731 // if row count is invalid possibly the table is defect
732 // and this would break left frame;
733 // but we can check row count if this is a view or the
734 // information_schema database
735 // since PMA_Table::countRecords() returns a limited row count
738 // set this because PMA_Table::countRecords() can use it
739 $tbl_is_view = PMA_Table
::isView($db, $table['Name']);
741 if ($tbl_is_view ||
'information_schema' == $db) {
742 $table['Rows'] = PMA_Table
::countRecords($db, $table['Name']);
746 // in $group we save the reference to the place in $table_groups
747 // where to store the table info
748 if ($GLOBALS['cfg']['LeftFrameDBTree']
749 && $sep && strstr($table_name, $sep))
751 $parts = explode($sep, $table_name);
753 $group =& $table_groups;
755 $group_name_full = '';
756 $parts_cnt = count($parts) - 1;
757 while ($i < $parts_cnt
758 && $i < $GLOBALS['cfg']['LeftFrameTableLevel']) {
759 $group_name = $parts[$i] . $sep;
760 $group_name_full .= $group_name;
762 if (!isset($group[$group_name])) {
763 $group[$group_name] = array();
764 $group[$group_name]['is' . $sep . 'group'] = true;
765 $group[$group_name]['tab' . $sep . 'count'] = 1;
766 $group[$group_name]['tab' . $sep . 'group'] = $group_name_full;
767 } elseif (!isset($group[$group_name]['is' . $sep . 'group'])) {
768 $table = $group[$group_name];
769 $group[$group_name] = array();
770 $group[$group_name][$group_name] = $table;
772 $group[$group_name]['is' . $sep . 'group'] = true;
773 $group[$group_name]['tab' . $sep . 'count'] = 1;
774 $group[$group_name]['tab' . $sep . 'group'] = $group_name_full;
776 $group[$group_name]['tab' . $sep . 'count']++
;
778 $group =& $group[$group_name];
782 if (!isset($table_groups[$table_name])) {
783 $table_groups[$table_name] = array();
785 $group =& $table_groups;
789 if ($GLOBALS['cfg']['ShowTooltipAliasTB']
790 && $GLOBALS['cfg']['ShowTooltipAliasTB'] !== 'nested') {
791 // switch tooltip and name
792 $table['Comment'] = $table['Name'];
793 $table['disp_name'] = $table['Comment'];
795 $table['disp_name'] = $table['Name'];
798 $group[$table_name] = array_merge($default, $table);
801 return $table_groups;
804 /* ----------------------- Set of misc functions ----------------------- */
808 * Adds backquotes on both sides of a database, table or field name.
809 * and escapes backquotes inside the name with another backquote
813 * echo PMA_backquote('owner`s db'); // `owner``s db`
817 * @uses PMA_backquote()
820 * @uses str_replace()
821 * @param mixed $a_name the database, table or field name to "backquote"
823 * @param boolean $do_it a flag to bypass this function (used by dump
825 * @return mixed the "backquoted" database, table or field name if the
826 * current MySQL release is >= 3.23.6, the original one
830 function PMA_backquote($a_name, $do_it = true)
832 if (is_array($a_name)) {
833 foreach ($a_name as &$data) {
834 $data = PMA_backquote($data, $do_it);
840 global $PMA_SQPdata_forbidden_word;
841 global $PMA_SQPdata_forbidden_word_cnt;
843 if(! PMA_STR_binarySearchInArr(strtoupper($a_name), $PMA_SQPdata_forbidden_word, $PMA_SQPdata_forbidden_word_cnt)) {
848 // '0' is also empty for php :-(
849 if (strlen($a_name) && $a_name !== '*') {
850 return '`' . str_replace('`', '``', $a_name) . '`';
854 } // end of the 'PMA_backquote()' function
858 * Defines the <CR><LF> value depending on the user OS.
861 * @return string the <CR><LF> value to use
865 function PMA_whichCrlf()
869 // The 'PMA_USR_OS' constant is defined in "./libraries/Config.class.php"
871 if (PMA_USR_OS
== 'Win') {
880 } // end of the 'PMA_whichCrlf()' function
883 * Reloads navigation if needed.
885 * @param $jsonly prints out pure JavaScript
886 * @uses $GLOBALS['reload']
887 * @uses $GLOBALS['db']
888 * @uses PMA_generate_common_url()
889 * @global array configuration
893 function PMA_reloadNavigation($jsonly=false)
897 // Reloads the navigation frame via JavaScript if required
898 if (isset($GLOBALS['reload']) && $GLOBALS['reload']) {
899 // one of the reasons for a reload is when a table is dropped
900 // in this case, get rid of the table limit offset, otherwise
901 // we have a problem when dropping a table on the last page
902 // and the offset becomes greater than the total number of tables
903 unset($_SESSION['tmp_user_values']['table_limit_offset']);
905 $reload_url = './navigation.php?' . PMA_generate_common_url($GLOBALS['db'], '', '&');
907 echo '<script type="text/javascript">' . PHP_EOL
;
910 if (typeof(window
.parent
) != 'undefined'
911 && typeof(window
.parent
.frame_navigation
) != 'undefined'
912 && window
.parent
.goTo) {
913 window
.parent
.goTo('<?php echo $reload_url; ?>');
918 echo '</script>' . PHP_EOL
;
920 unset($GLOBALS['reload']);
925 * displays the message and the query
926 * usually the message is the result of the query executed
928 * @param string $message the message to display
929 * @param string $sql_query the query to display
930 * @param string $type the type (level) of the message
931 * @param boolean $is_view is this a message after a VIEW operation?
932 * @global array the configuration array
936 function PMA_showMessage($message, $sql_query = null, $type = 'notice', $is_view = false)
939 * PMA_ajaxResponse uses this function to collect the string of HTML generated
940 * for showing the message. Use output buffering to collect it and return it
941 * in a string. In some special cases on sql.php, buffering has to be disabled
942 * and hence we check with $GLOBALS['buffer_message']
944 if( $GLOBALS['is_ajax_request'] == true && !isset($GLOBALS['buffer_message']) ) {
949 if (null === $sql_query) {
950 if (! empty($GLOBALS['display_query'])) {
951 $sql_query = $GLOBALS['display_query'];
952 } elseif ($cfg['SQP']['fmtType'] == 'none' && ! empty($GLOBALS['unparsed_sql'])) {
953 $sql_query = $GLOBALS['unparsed_sql'];
954 } elseif (! empty($GLOBALS['sql_query'])) {
955 $sql_query = $GLOBALS['sql_query'];
961 // Corrects the tooltip text via JS if required
962 // @todo this is REALLY the wrong place to do this - very unexpected here
963 if (! $is_view && strlen($GLOBALS['table']) && $cfg['ShowTooltip']) {
964 $tooltip = PMA_Table
::sGetToolTip($GLOBALS['db'], $GLOBALS['table']);
965 $uni_tbl = PMA_jsFormat($GLOBALS['db'] . '.' . $GLOBALS['table'], false);
967 echo '<script type="text/javascript">' . "\n";
968 echo '//<![CDATA[' . "\n";
969 echo "if (window.parent.updateTableTitle) window.parent.updateTableTitle('" . $uni_tbl . "', '" . PMA_jsFormat($tooltip, false) . "');" . "\n";
971 echo '</script>' . "\n";
972 } // end if ... elseif
974 // Checks if the table needs to be repaired after a TRUNCATE query.
975 // @todo what about $GLOBALS['display_query']???
976 // @todo this is REALLY the wrong place to do this - very unexpected here
977 if (strlen($GLOBALS['table'])
978 && $GLOBALS['sql_query'] == 'TRUNCATE TABLE ' . PMA_backquote($GLOBALS['table'])) {
979 if (PMA_Table
::sGetStatusInfo($GLOBALS['db'], $GLOBALS['table'], 'Index_length') > 1024) {
980 PMA_DBI_try_query('REPAIR TABLE ' . PMA_backquote($GLOBALS['table']));
985 // In an Ajax request, $GLOBALS['cell_align_left'] may not be defined. Hence,
986 // check for it's presence before using it
987 echo '<div align="' . ( isset($GLOBALS['cell_align_left']) ?
$GLOBALS['cell_align_left'] : '' ) . '">' . "\n";
989 if ($message instanceof PMA_Message
) {
990 if (isset($GLOBALS['special_message'])) {
991 $message->addMessage($GLOBALS['special_message']);
992 unset($GLOBALS['special_message']);
995 $type = $message->getLevel();
997 echo '<div class="' . $type . '">';
998 echo PMA_sanitize($message);
999 if (isset($GLOBALS['special_message'])) {
1000 echo PMA_sanitize($GLOBALS['special_message']);
1001 unset($GLOBALS['special_message']);
1006 if ($cfg['ShowSQL'] == true && ! empty($sql_query)) {
1007 // Html format the query to be displayed
1008 // If we want to show some sql code it is easiest to create it here
1009 /* SQL-Parser-Analyzer */
1011 if (! empty($GLOBALS['show_as_php'])) {
1012 $new_line = '\\n"<br />' . "\n"
1013 . ' . "';
1014 $query_base = htmlspecialchars(addslashes($sql_query));
1015 $query_base = preg_replace('/((\015\012)|(\015)|(\012))/', $new_line, $query_base);
1017 $query_base = $sql_query;
1020 $query_too_big = false;
1022 if (strlen($query_base) > $cfg['MaxCharactersInDisplayedSQL']) {
1023 // when the query is large (for example an INSERT of binary
1024 // data), the parser chokes; so avoid parsing the query
1025 $query_too_big = true;
1026 $shortened_query_base = nl2br(htmlspecialchars(substr($sql_query, 0, $cfg['MaxCharactersInDisplayedSQL']) . '[...]'));
1027 } elseif (! empty($GLOBALS['parsed_sql'])
1028 && $query_base == $GLOBALS['parsed_sql']['raw']) {
1029 // (here, use "! empty" because when deleting a bookmark,
1030 // $GLOBALS['parsed_sql'] is set but empty
1031 $parsed_sql = $GLOBALS['parsed_sql'];
1033 // Parse SQL if needed
1034 $parsed_sql = PMA_SQP_parse($query_base);
1035 if (PMA_SQP_isError()) {
1041 if (isset($parsed_sql)) {
1042 $analyzed_display_query = PMA_SQP_analyze($parsed_sql);
1043 // Here we append the LIMIT added for navigation, to
1044 // enable its display. Adding it higher in the code
1045 // to $sql_query would create a problem when
1046 // using the Refresh or Edit links.
1048 // Only append it on SELECTs.
1051 * @todo what would be the best to do when someone hits Refresh:
1052 * use the current LIMITs ?
1055 if (isset($analyzed_display_query[0]['queryflags']['select_from'])
1056 && isset($GLOBALS['sql_limit_to_append'])) {
1057 $query_base = $analyzed_display_query[0]['section_before_limit']
1058 . "\n" . $GLOBALS['sql_limit_to_append']
1059 . $analyzed_display_query[0]['section_after_limit'];
1060 // Need to reparse query
1061 $parsed_sql = PMA_SQP_parse($query_base);
1065 if (! empty($GLOBALS['show_as_php'])) {
1066 $query_base = '$sql = "' . $query_base;
1067 } elseif (! empty($GLOBALS['validatequery'])) {
1069 $query_base = PMA_validateSQL($query_base);
1070 } catch (Exception
$e) {
1071 PMA_Message
::error(__('Failed to connect to SQL validator!'))->display();
1073 } elseif (isset($parsed_sql)) {
1074 $query_base = PMA_formatSql($parsed_sql, $query_base);
1077 // Prepares links that may be displayed to edit/explain the query
1078 // (don't go to default pages, we must go to the page
1079 // where the query box is available)
1081 // Basic url query part
1082 $url_params = array();
1083 if (! isset($GLOBALS['db'])) {
1084 $GLOBALS['db'] = '';
1086 if (strlen($GLOBALS['db'])) {
1087 $url_params['db'] = $GLOBALS['db'];
1088 if (strlen($GLOBALS['table'])) {
1089 $url_params['table'] = $GLOBALS['table'];
1090 $edit_link = 'tbl_sql.php';
1092 $edit_link = 'db_sql.php';
1095 $edit_link = 'server_sql.php';
1098 // Want to have the query explained (Mike Beck 2002-05-22)
1099 // but only explain a SELECT (that has not been explained)
1100 /* SQL-Parser-Analyzer */
1102 if (! empty($cfg['SQLQuery']['Explain']) && ! $query_too_big) {
1103 $explain_params = $url_params;
1104 // Detect if we are validating as well
1105 // To preserve the validate uRL data
1106 if (! empty($GLOBALS['validatequery'])) {
1107 $explain_params['validatequery'] = 1;
1110 if (preg_match('@^SELECT[[:space:]]+@i', $sql_query)) {
1111 $explain_params['sql_query'] = 'EXPLAIN ' . $sql_query;
1112 $_message = __('Explain SQL');
1113 } elseif (preg_match('@^EXPLAIN[[:space:]]+SELECT[[:space:]]+@i', $sql_query)) {
1114 $explain_params['sql_query'] = substr($sql_query, 8);
1115 $_message = __('Skip Explain SQL');
1117 if (isset($explain_params['sql_query'])) {
1118 $explain_link = 'import.php' . PMA_generate_common_url($explain_params);
1119 $explain_link = ' [' . PMA_linkOrButton($explain_link, $_message) . ']';
1123 $url_params['sql_query'] = $sql_query;
1124 $url_params['show_query'] = 1;
1126 // even if the query is big and was truncated, offer the chance
1127 // to edit it (unless it's enormous, see PMA_linkOrButton() )
1128 if (! empty($cfg['SQLQuery']['Edit'])) {
1129 if ($cfg['EditInWindow'] == true) {
1130 $onclick = 'window.parent.focus_querywindow(\'' . PMA_jsFormat($sql_query, false) . '\'); return false;';
1135 $edit_link .= PMA_generate_common_url($url_params) . '#querybox';
1136 $edit_link = ' [' . PMA_linkOrButton($edit_link, __('Edit'), array('onclick' => $onclick)) . ']';
1141 $url_qpart = PMA_generate_common_url($url_params);
1143 // Also we would like to get the SQL formed in some nice
1144 // php-code (Mike Beck 2002-05-22)
1145 if (! empty($cfg['SQLQuery']['ShowAsPHP']) && ! $query_too_big) {
1146 $php_params = $url_params;
1148 if (! empty($GLOBALS['show_as_php'])) {
1149 $_message = __('Without PHP Code');
1151 $php_params['show_as_php'] = 1;
1152 $_message = __('Create PHP Code');
1155 $php_link = 'import.php' . PMA_generate_common_url($php_params);
1156 $php_link = ' [' . PMA_linkOrButton($php_link, $_message) . ']';
1158 if (isset($GLOBALS['show_as_php'])) {
1159 $runquery_link = 'import.php' . PMA_generate_common_url($url_params);
1160 $php_link .= ' [' . PMA_linkOrButton($runquery_link, __('Submit Query')) . ']';
1167 if (! empty($cfg['SQLQuery']['Refresh'])
1168 && preg_match('@^(SELECT|SHOW)[[:space:]]+@i', $sql_query)) {
1169 $refresh_link = 'import.php' . PMA_generate_common_url($url_params);
1170 $refresh_link = ' [' . PMA_linkOrButton($refresh_link, __('Refresh')) . ']';
1175 if (! empty($cfg['SQLValidator']['use'])
1176 && ! empty($cfg['SQLQuery']['Validate'])) {
1177 $validate_params = $url_params;
1178 if (!empty($GLOBALS['validatequery'])) {
1179 $validate_message = __('Skip Validate SQL') ;
1181 $validate_params['validatequery'] = 1;
1182 $validate_message = __('Validate SQL') ;
1185 $validate_link = 'import.php' . PMA_generate_common_url($validate_params);
1186 $validate_link = ' [' . PMA_linkOrButton($validate_link, $validate_message) . ']';
1188 $validate_link = '';
1191 if (!empty($GLOBALS['validatequery'])) {
1192 echo '<div class="sqlvalidate">';
1194 echo '<code class="sql">';
1196 if ($query_too_big) {
1197 echo $shortened_query_base;
1202 //Clean up the end of the PHP
1203 if (! empty($GLOBALS['show_as_php'])) {
1206 if (!empty($GLOBALS['validatequery'])) {
1212 echo '<div class="tools">';
1213 // avoid displaying a Profiling checkbox that could
1214 // be checked, which would reexecute an INSERT, for example
1215 if (! empty($refresh_link)) {
1216 PMA_profilingCheckbox($sql_query);
1218 // if needed, generate an invisible form that contains controls for the
1219 // Inline link; this way, the behavior of the Inline link does not
1220 // depend on the profiling support or on the refresh link
1221 if (empty($refresh_link) ||
! PMA_profilingSupported()) {
1222 echo '<form action="sql.php" method="post">';
1223 echo PMA_generate_common_hidden_inputs($GLOBALS['db'], $GLOBALS['table']);
1224 echo '<input type="hidden" name="sql_query" value="' . htmlspecialchars($sql_query) . '" />';
1228 // in the tools div, only display the Inline link when not in ajax
1229 // mode because 1) it currently does not work and 2) we would
1230 // have two similar mechanisms on the page for the same goal
1231 if ($GLOBALS['is_ajax_request'] === false) {
1232 // see in js/functions.js the jQuery code attached to id inline_edit
1233 // document.write conflicts with jQuery, hence used $().append()
1234 echo "<script type=\"text/javascript\">\n" .
1236 "$('.tools').append('[<a href=\"#\" title=\"" .
1237 PMA_escapeJsString(__('Inline edit of this query')) .
1238 "\" id=\"inline_edit\">" .
1239 PMA_escapeJsString(__('Inline')) .
1244 echo $edit_link . $explain_link . $php_link . $refresh_link . $validate_link;
1247 echo '</div><br class="clearfloat" />' . "\n";
1249 // If we are in an Ajax request, we have most probably been called in
1250 // PMA_ajaxResponse(). Hence, collect the buffer contents and return it
1251 // to PMA_ajaxResponse(), which will encode it for JSON.
1252 if( $GLOBALS['is_ajax_request'] == true && !isset($GLOBALS['buffer_message']) ) {
1253 $buffer_contents = ob_get_contents();
1255 return $buffer_contents;
1257 } // end of the 'PMA_showMessage()' function
1260 * Verifies if current MySQL server supports profiling
1262 * @uses $_SESSION['profiling_supported'] for caching
1263 * @uses $GLOBALS['server']
1264 * @uses PMA_DBI_fetch_value()
1265 * @uses PMA_MYSQL_INT_VERSION
1268 * @return boolean whether profiling is supported
1271 function PMA_profilingSupported()
1273 if (! PMA_cacheExists('profiling_supported', true)) {
1274 // 5.0.37 has profiling but for example, 5.1.20 does not
1275 // (avoid a trip to the server for MySQL before 5.0.37)
1276 // and do not set a constant as we might be switching servers
1277 if (defined('PMA_MYSQL_INT_VERSION')
1278 && PMA_MYSQL_INT_VERSION
>= 50037
1279 && PMA_DBI_fetch_value("SHOW VARIABLES LIKE 'profiling'")) {
1280 PMA_cacheSet('profiling_supported', true, true);
1282 PMA_cacheSet('profiling_supported', false, true);
1286 return PMA_cacheGet('profiling_supported', true);
1290 * Displays a form with the Profiling checkbox
1292 * @param string $sql_query
1296 function PMA_profilingCheckbox($sql_query)
1298 if (PMA_profilingSupported()) {
1299 echo '<form action="sql.php" method="post">' . "\n";
1300 echo PMA_generate_common_hidden_inputs($GLOBALS['db'], $GLOBALS['table']);
1301 echo '<input type="hidden" name="sql_query" value="' . htmlspecialchars($sql_query) . '" />' . "\n";
1302 echo '<input type="hidden" name="profiling_form" value="1" />' . "\n";
1303 PMA_display_html_checkbox('profiling', __('Profiling'), isset($_SESSION['profiling']), true);
1304 echo '<noscript><input type="submit" value="' . __('Go') . '" /></noscript>' . "\n";
1305 echo '</form>' . "\n";
1310 * Displays the results of SHOW PROFILE
1312 * @param array the results
1313 * @param boolean show chart
1317 function PMA_profilingResults($profiling_results, $show_chart = false)
1319 echo '<fieldset><legend>' . __('Profiling') . '</legend>' . "\n";
1320 echo '<div style="float: left;">';
1321 echo '<table>' . "\n";
1322 echo ' <tr>' . "\n";
1323 echo ' <th>' . __('Status') . '</th>' . "\n";
1324 echo ' <th>' . __('Time') . '</th>' . "\n";
1325 echo ' </tr>' . "\n";
1327 foreach($profiling_results as $one_result) {
1328 echo ' <tr>' . "\n";
1329 echo '<td>' . $one_result['Status'] . '</td>' . "\n";
1330 echo '<td>' . $one_result['Duration'] . '</td>' . "\n";
1333 echo '</table>' . "\n";
1337 require_once './libraries/chart.lib.php';
1338 echo '<div style="float: left;">';
1339 PMA_chart_profiling($profiling_results);
1343 echo '</fieldset>' . "\n";
1347 * Formats $value to byte view
1349 * @param double the value to format
1350 * @param integer the sensitiveness
1351 * @param integer the number of decimals to retain
1353 * @return array the formatted value and its unit
1357 * @version 1.2 - 18 July 2002
1359 function PMA_formatByteDown($value, $limes = 6, $comma = 0)
1361 /* l10n: shortcuts for Byte, Kilo, Mega, Giga, Tera, Peta, Exa+ */
1362 $byteUnits = array(__('B'), __('KiB'), __('MiB'), __('GiB'), __('TiB'), __('PiB'), __('EiB'));
1364 $dh = PMA_pow(10, $comma);
1365 $li = PMA_pow(10, $limes);
1366 $return_value = $value;
1367 $unit = $byteUnits[0];
1369 for ($d = 6, $ex = 15; $d >= 1; $d--, $ex-=3) {
1370 if (isset($byteUnits[$d]) && $value >= $li * PMA_pow(10, $ex)) {
1371 // use 1024.0 to avoid integer overflow on 64-bit machines
1372 $value = round($value / (PMA_pow(1024, $d) / $dh)) /$dh;
1373 $unit = $byteUnits[$d];
1378 if ($unit != $byteUnits[0]) {
1379 // if the unit is not bytes (as represented in current language)
1380 // reformat with max length of 5
1381 // 4th parameter=true means do not reformat if value < 1
1382 $return_value = PMA_formatNumber($value, 5, $comma, true);
1384 // do not reformat, just handle the locale
1385 $return_value = PMA_formatNumber($value, 0);
1388 return array(trim($return_value), $unit);
1389 } // end of the 'PMA_formatByteDown' function
1392 * Changes thousands and decimal separators to locale specific values.
1394 function PMA_localizeNumber($value)
1399 /* l10n: Thousands separator */
1401 /* l10n: Decimal separator */
1408 * Formats $value to the given length and appends SI prefixes
1409 * $comma is not substracted from the length
1410 * with a $length of 0 no truncation occurs, number is only formated
1411 * to the current locale
1415 * echo PMA_formatNumber(123456789, 6); // 123,457 k
1416 * echo PMA_formatNumber(-123456789, 4, 2); // -123.46 M
1417 * echo PMA_formatNumber(-0.003, 6); // -3 m
1418 * echo PMA_formatNumber(0.003, 3, 3); // 0.003
1419 * echo PMA_formatNumber(0.00003, 3, 2); // 0.03 m
1420 * echo PMA_formatNumber(0, 6); // 0
1423 * @param double $value the value to format
1424 * @param integer $length the max length
1425 * @param integer $comma the number of decimals to retain
1426 * @param boolean $only_down do not reformat numbers below 1
1428 * @return string the formatted value and its unit
1432 * @version 1.1.0 - 2005-10-27
1434 function PMA_formatNumber($value, $length = 3, $comma = 0, $only_down = false)
1436 //number_format is not multibyte safe, str_replace is safe
1437 if ($length === 0) {
1438 return PMA_localizeNumber(number_format($value, $comma));
1441 // this units needs no translation, ISO
1462 // we need at least 3 digits to be displayed
1463 if (3 > $length +
$comma) {
1464 $length = 3 - $comma;
1467 // check for negative value to retain sign
1470 $value = abs($value);
1475 $dh = PMA_pow(10, $comma);
1476 $li = PMA_pow(10, $length);
1480 for ($d = 8; $d >= 0; $d--) {
1481 if (isset($units[$d]) && $value >= $li * PMA_pow(1000, $d-1)) {
1482 $value = round($value / (PMA_pow(1000, $d) / $dh)) /$dh;
1487 } elseif (!$only_down && (float) $value !== 0.0) {
1488 for ($d = -8; $d <= 8; $d++
) {
1489 // force using pow() because of the negative exponent
1490 if (isset($units[$d]) && $value <= $li * PMA_pow(1000, $d-1, 'pow')) {
1491 $value = round($value / (PMA_pow(1000, $d, 'pow') / $dh)) /$dh;
1496 } // end if ($value >= 1) elseif (!$only_down && (float) $value !== 0.0)
1498 //number_format is not multibyte safe, str_replace is safe
1499 $value = PMA_localizeNumber(number_format($value, $comma));
1501 return $sign . $value . ' ' . $unit;
1502 } // end of the 'PMA_formatNumber' function
1505 * Returns the number of bytes when a formatted size is given
1507 * @param string $size the size expression (for example 8MB)
1509 * @return integer The numerical part of the expression (for example 8)
1511 function PMA_extractValueFromFormattedSize($formatted_size)
1515 if (preg_match('/^[0-9]+GB$/', $formatted_size)) {
1516 $return_value = substr($formatted_size, 0, -2) * PMA_pow(1024, 3);
1517 } elseif (preg_match('/^[0-9]+MB$/', $formatted_size)) {
1518 $return_value = substr($formatted_size, 0, -2) * PMA_pow(1024, 2);
1519 } elseif (preg_match('/^[0-9]+K$/', $formatted_size)) {
1520 $return_value = substr($formatted_size, 0, -1) * PMA_pow(1024, 1);
1522 return $return_value;
1523 }// end of the 'PMA_extractValueFromFormattedSize' function
1526 * Writes localised date
1528 * @param string the current timestamp
1530 * @return string the formatted date
1534 function PMA_localisedDate($timestamp = -1, $format = '')
1537 /* l10n: Short month name */
1539 /* l10n: Short month name */
1541 /* l10n: Short month name */
1543 /* l10n: Short month name */
1545 /* l10n: Short month name */
1546 _pgettext('Short month name', 'May'),
1547 /* l10n: Short month name */
1549 /* l10n: Short month name */
1551 /* l10n: Short month name */
1553 /* l10n: Short month name */
1555 /* l10n: Short month name */
1557 /* l10n: Short month name */
1559 /* l10n: Short month name */
1561 $day_of_week = array(
1562 /* l10n: Short week day name */
1564 /* l10n: Short week day name */
1566 /* l10n: Short week day name */
1568 /* l10n: Short week day name */
1570 /* l10n: Short week day name */
1572 /* l10n: Short week day name */
1574 /* l10n: Short week day name */
1577 if ($format == '') {
1578 /* l10n: See http://www.php.net/manual/en/function.strftime.php to define the format string */
1579 $format = __('%B %d, %Y at %I:%M %p');
1582 if ($timestamp == -1) {
1583 $timestamp = time();
1586 $date = preg_replace('@%[aA]@', $day_of_week[(int)strftime('%w', $timestamp)], $format);
1587 $date = preg_replace('@%[bB]@', $month[(int)strftime('%m', $timestamp)-1], $date);
1589 return strftime($date, $timestamp);
1590 } // end of the 'PMA_localisedDate()' function
1594 * returns a tab for tabbed navigation.
1595 * If the variables $link and $args ar left empty, an inactive tab is created
1597 * @uses $GLOBALS['PMA_PHP_SELF']
1598 * @uses $GLOBALS['active_page']
1599 * @uses $GLOBALS['url_query']
1600 * @uses $cfg['MainPageIconic']
1601 * @uses $GLOBALS['pmaThemeImage']
1602 * @uses PMA_generate_common_url()
1603 * @uses E_USER_NOTICE
1604 * @uses htmlentities()
1607 * @uses trigger_error()
1608 * @uses array_merge()
1610 * @param array $tab array with all options
1611 * @param array $url_params
1612 * @return string html code for one tab, a link if valid otherwise a span
1615 function PMA_generate_html_tab($tab, $url_params = array())
1631 $tab = array_merge($defaults, $tab);
1633 // determine additionnal style-class
1634 if (empty($tab['class'])) {
1635 if ($tab['text'] == __('Empty')
1636 ||
$tab['text'] == __('Drop')) {
1637 $tab['class'] = 'caution';
1638 } elseif (! empty($tab['active'])
1639 ||
PMA_isValid($GLOBALS['active_page'], 'identical', $tab['link'])) {
1640 $tab['class'] = 'active';
1641 } elseif (is_null($tab['active']) && empty($GLOBALS['active_page'])
1642 && basename($GLOBALS['PMA_PHP_SELF']) == $tab['link']
1643 && empty($tab['warning'])) {
1644 $tab['class'] = 'active';
1648 if (!empty($tab['warning'])) {
1649 $tab['class'] .= ' warning';
1650 $tab['attr'] .= ' title="' . htmlspecialchars($tab['warning']) . '"';
1653 // If there are any tab specific URL parameters, merge those with the general URL parameters
1654 if(! empty($tab['url_params']) && is_array($tab['url_params'])) {
1655 $url_params = array_merge($url_params, $tab['url_params']);
1659 if (!empty($tab['link'])) {
1660 $tab['link'] = htmlentities($tab['link']);
1661 $tab['link'] = $tab['link'] . PMA_generate_common_url($url_params);
1662 if (! empty($tab['args'])) {
1663 foreach ($tab['args'] as $param => $value) {
1664 $tab['link'] .= PMA_get_arg_separator('html') . urlencode($param) . '='
1665 . urlencode($value);
1670 if (! empty($tab['fragment'])) {
1671 $tab['link'] .= $tab['fragment'];
1674 // display icon, even if iconic is disabled but the link-text is missing
1675 if (($GLOBALS['cfg']['MainPageIconic'] ||
empty($tab['text']))
1676 && isset($tab['icon'])) {
1677 // avoid generating an alt tag, because it only illustrates
1678 // the text that follows and if browser does not display
1679 // images, the text is duplicated
1680 $image = '<img class="icon" src="' . htmlentities($GLOBALS['pmaThemeImage'])
1681 .'%1$s" width="16" height="16" alt="" />%2$s';
1682 $tab['text'] = sprintf($image, htmlentities($tab['icon']), $tab['text']);
1684 // check to not display an empty link-text
1685 elseif (empty($tab['text'])) {
1687 trigger_error('empty linktext in function ' . __FUNCTION__
. '()',
1691 //Set the id for the tab, if set in the params
1692 $id_string = ( empty($tab['id']) ?
'' : ' id="'.$tab['id'].'" ' );
1693 $out = '<li' . ($tab['class'] == 'active' ?
' class="active"' : '') . '>';
1695 if (!empty($tab['link'])) {
1696 $out .= '<a class="tab' . htmlentities($tab['class']) . '"'
1698 .' href="' . $tab['link'] . '" ' . $tab['attr'] . '>'
1699 . $tab['text'] . '</a>';
1701 $out .= '<span class="tab' . htmlentities($tab['class']) . '"'.$id_string.'>'
1702 . $tab['text'] . '</span>';
1707 } // end of the 'PMA_generate_html_tab()' function
1710 * returns html-code for a tab navigation
1712 * @uses PMA_generate_html_tab()
1713 * @uses htmlentities()
1714 * @param array $tabs one element per tab
1715 * @param string $url_params
1716 * @return string html-code for tab-navigation
1718 function PMA_generate_html_tabs($tabs, $url_params)
1720 $tag_id = 'topmenu';
1722 '<div id="' . htmlentities($tag_id) . 'container">' . "\n"
1723 .'<ul id="' . htmlentities($tag_id) . '">' . "\n";
1725 foreach ($tabs as $tab) {
1726 $tab_navigation .= PMA_generate_html_tab($tab, $url_params) . "\n";
1731 .'<div class="clearfloat"></div>'
1734 return $tab_navigation;
1739 * Displays a link, or a button if the link's URL is too large, to
1740 * accommodate some browsers' limitations
1742 * @param string the URL
1743 * @param string the link message
1744 * @param mixed $tag_params string: js confirmation
1745 * array: additional tag params (f.e. style="")
1746 * @param boolean $new_form we set this to false when we are already in
1747 * a form, to avoid generating nested forms
1749 * @return string the results to be echoed or saved in an array
1751 function PMA_linkOrButton($url, $message, $tag_params = array(),
1752 $new_form = true, $strip_img = false, $target = '')
1754 $url_length = strlen($url);
1755 // with this we should be able to catch case of image upload
1756 // into a (MEDIUM) BLOB; not worth generating even a form for these
1757 if ($url_length > $GLOBALS['cfg']['LinkLengthLimit'] * 100) {
1761 if (! is_array($tag_params)) {
1763 $tag_params = array();
1765 $tag_params['onclick'] = 'return confirmLink(this, \'' . PMA_escapeJsString($tmp) . '\')';
1769 if (! empty($target)) {
1770 $tag_params['target'] = htmlentities($target);
1773 $tag_params_strings = array();
1774 foreach ($tag_params as $par_name => $par_value) {
1775 // htmlspecialchars() only on non javascript
1776 $par_value = substr($par_name, 0, 2) == 'on'
1778 : htmlspecialchars($par_value);
1779 $tag_params_strings[] = $par_name . '="' . $par_value . '"';
1782 if ($url_length <= $GLOBALS['cfg']['LinkLengthLimit']) {
1783 // no whitespace within an <a> else Safari will make it part of the link
1784 $ret = "\n" . '<a href="' . $url . '" '
1785 . implode(' ', $tag_params_strings) . '>'
1786 . $message . '</a>' . "\n";
1788 // no spaces (linebreaks) at all
1789 // or after the hidden fields
1790 // IE will display them all
1792 // add class=link to submit button
1793 if (empty($tag_params['class'])) {
1794 $tag_params['class'] = 'link';
1797 // decode encoded url separators
1798 $separator = PMA_get_arg_separator();
1799 // on most places separator is still hard coded ...
1800 if ($separator !== '&') {
1801 // ... so always replace & with $separator
1802 $url = str_replace(htmlentities('&'), $separator, $url);
1803 $url = str_replace('&', $separator, $url);
1805 $url = str_replace(htmlentities($separator), $separator, $url);
1808 $url_parts = parse_url($url);
1809 $query_parts = explode($separator, $url_parts['query']);
1811 $ret = '<form action="' . $url_parts['path'] . '" class="link"'
1812 . ' method="post"' . $target . ' style="display: inline;">';
1814 $subname_close = '';
1817 $query_parts[] = 'redirect=' . $url_parts['path'];
1818 if (empty($GLOBALS['subform_counter'])) {
1819 $GLOBALS['subform_counter'] = 0;
1821 $GLOBALS['subform_counter']++
;
1823 $subname_open = 'subform[' . $GLOBALS['subform_counter'] . '][';
1824 $subname_close = ']';
1825 $submit_name = ' name="usesubform[' . $GLOBALS['subform_counter'] . ']"';
1827 foreach ($query_parts as $query_pair) {
1828 list($eachvar, $eachval) = explode('=', $query_pair);
1829 $ret .= '<input type="hidden" name="' . $subname_open . $eachvar
1830 . $subname_close . '" value="'
1831 . htmlspecialchars(urldecode($eachval)) . '" />';
1834 if (stristr($message, '<img')) {
1836 $message = trim(strip_tags($message));
1837 $ret .= '<input type="submit"' . $submit_name . ' '
1838 . implode(' ', $tag_params_strings)
1839 . ' value="' . htmlspecialchars($message) . '" />';
1841 $displayed_message = htmlspecialchars(
1842 preg_replace('/^.*\salt="([^"]*)".*$/si', '\1',
1844 $ret .= '<input type="image"' . $submit_name . ' '
1845 . implode(' ', $tag_params_strings)
1846 . ' src="' . preg_replace(
1847 '/^.*\ssrc="([^"]*)".*$/si', '\1', $message) . '"'
1848 . ' value="' . $displayed_message . '" title="' . $displayed_message . '" />';
1851 $message = trim(strip_tags($message));
1852 $ret .= '<input type="submit"' . $submit_name . ' '
1853 . implode(' ', $tag_params_strings)
1854 . ' value="' . htmlspecialchars($message) . '" />';
1859 } // end if... else...
1862 } // end of the 'PMA_linkOrButton()' function
1866 * Returns a given timespan value in a readable format.
1870 * @param int the timespan
1872 * @return string the formatted value
1874 function PMA_timespanFormat($seconds)
1876 $return_string = '';
1877 $days = floor($seconds / 86400);
1879 $seconds -= $days * 86400;
1881 $hours = floor($seconds / 3600);
1882 if ($days > 0 ||
$hours > 0) {
1883 $seconds -= $hours * 3600;
1885 $minutes = floor($seconds / 60);
1886 if ($days > 0 ||
$hours > 0 ||
$minutes > 0) {
1887 $seconds -= $minutes * 60;
1889 return sprintf(__('%s days, %s hours, %s minutes and %s seconds'), (string)$days, (string)$hours, (string)$minutes, (string)$seconds);
1893 * Takes a string and outputs each character on a line for itself. Used
1894 * mainly for horizontalflipped display mode.
1895 * Takes care of special html-characters.
1896 * Fulfills todo-item
1897 * http://sf.net/tracker/?func=detail&aid=544361&group_id=23067&atid=377411
1899 * @todo add a multibyte safe function PMA_STR_split()
1901 * @param string The string
1902 * @param string The Separator (defaults to "<br />\n")
1905 * @return string The flipped string
1907 function PMA_flipstring($string, $Separator = "<br />\n")
1909 $format_string = '';
1912 for ($i = 0, $str_len = strlen($string); $i < $str_len; $i++
) {
1913 $char = $string{$i};
1917 $format_string .= $charbuff;
1919 } elseif ($char == ';' && !empty($charbuff)) {
1920 $format_string .= $charbuff . $char;
1923 } elseif (! empty($charbuff)) {
1926 $format_string .= $char;
1930 // do not add separator after the last character
1931 if ($append && ($i != $str_len - 1)) {
1932 $format_string .= $Separator;
1936 return $format_string;
1941 * Function added to avoid path disclosures.
1942 * Called by each script that needs parameters, it displays
1943 * an error message and, by default, stops the execution.
1945 * Not sure we could use a strMissingParameter message here,
1946 * would have to check if the error message file is always available
1948 * @todo localize error message
1949 * @todo use PMA_fatalError() if $die === true?
1950 * @uses PMA_getenv()
1951 * @uses header_meta_style.inc.php
1952 * @uses $GLOBALS['PMA_PHP_SELF']
1954 * @param array The names of the parameters needed by the calling
1956 * @param boolean Stop the execution?
1957 * (Set this manually to false in the calling script
1958 * until you know all needed parameters to check).
1959 * @param boolean Whether to include this list in checking for special params.
1960 * @global string path to current script
1961 * @global boolean flag whether any special variable was required
1965 function PMA_checkParameters($params, $die = true, $request = true)
1967 global $checked_special;
1969 if (!isset($checked_special)) {
1970 $checked_special = false;
1973 $reported_script_name = basename($GLOBALS['PMA_PHP_SELF']);
1974 $found_error = false;
1975 $error_message = '';
1977 foreach ($params as $param) {
1978 if ($request && $param != 'db' && $param != 'table') {
1979 $checked_special = true;
1982 if (!isset($GLOBALS[$param])) {
1983 $error_message .= $reported_script_name
1984 . ': Missing parameter: ' . $param
1985 . PMA_showDocu('faqmissingparameters')
1987 $found_error = true;
1992 * display html meta tags
1994 require_once './libraries/header_meta_style.inc.php';
1995 echo '</head><body><p>' . $error_message . '</p></body></html>';
2003 * Function to generate unique condition for specified row.
2005 * @uses $GLOBALS['analyzed_sql'][0]
2006 * @uses PMA_DBI_field_flags()
2007 * @uses PMA_backquote()
2008 * @uses PMA_sqlAddslashes()
2009 * @uses PMA_printable_bit_value()
2012 * @uses preg_replace()
2013 * @param resource $handle current query result
2014 * @param integer $fields_cnt number of fields
2015 * @param array $fields_meta meta information about fields
2016 * @param array $row current row
2017 * @param boolean $force_unique generate condition only on pk or unique
2020 * @return string the calculated condition and whether condition is unique
2022 function PMA_getUniqueCondition($handle, $fields_cnt, $fields_meta, $row, $force_unique=false)
2026 $nonprimary_condition = '';
2027 $preferred_condition = '';
2029 for ($i = 0; $i < $fields_cnt; ++
$i) {
2031 $field_flags = PMA_DBI_field_flags($handle, $i);
2032 $meta = $fields_meta[$i];
2034 // do not use a column alias in a condition
2035 if (! isset($meta->orgname
) ||
! strlen($meta->orgname
)) {
2036 $meta->orgname
= $meta->name
;
2038 if (isset($GLOBALS['analyzed_sql'][0]['select_expr'])
2039 && is_array($GLOBALS['analyzed_sql'][0]['select_expr'])) {
2040 foreach ($GLOBALS['analyzed_sql'][0]['select_expr']
2042 // need (string) === (string)
2043 // '' !== 0 but '' == 0
2044 if ((string) $select_expr['alias'] === (string) $meta->name
) {
2045 $meta->orgname
= $select_expr['column'];
2052 // Do not use a table alias in a condition.
2054 // select * from galerie x WHERE
2055 //(select count(*) from galerie y where y.datum=x.datum)>1
2057 // But orgtable is present only with mysqli extension so the
2058 // fix is only for mysqli.
2059 // Also, do not use the original table name if we are dealing with
2060 // a view because this view might be updatable.
2061 // (The isView() verification should not be costly in most cases
2062 // because there is some caching in the function).
2063 if (isset($meta->orgtable
) && $meta->table
!= $meta->orgtable
&& ! PMA_Table
::isView($GLOBALS['db'], $meta->table
)) {
2064 $meta->table
= $meta->orgtable
;
2067 // to fix the bug where float fields (primary or not)
2068 // can't be matched because of the imprecision of
2069 // floating comparison, use CONCAT
2070 // (also, the syntax "CONCAT(field) IS NULL"
2071 // that we need on the next "if" will work)
2072 if ($meta->type
== 'real') {
2073 $condition = ' CONCAT(' . PMA_backquote($meta->table
) . '.'
2074 . PMA_backquote($meta->orgname
) . ') ';
2076 $condition = ' ' . PMA_backquote($meta->table
) . '.'
2077 . PMA_backquote($meta->orgname
) . ' ';
2078 } // end if... else...
2080 if (!isset($row[$i]) ||
is_null($row[$i])) {
2081 $condition .= 'IS NULL AND';
2083 // timestamp is numeric on some MySQL 4.1
2084 // for real we use CONCAT above and it should compare to string
2085 if ($meta->numeric && $meta->type
!= 'timestamp' && $meta->type
!= 'real') {
2086 $condition .= '= ' . $row[$i] . ' AND';
2087 } elseif (($meta->type
== 'blob' ||
$meta->type
== 'string')
2088 // hexify only if this is a true not empty BLOB or a BINARY
2089 && stristr($field_flags, 'BINARY')
2090 && !empty($row[$i])) {
2091 // do not waste memory building a too big condition
2092 if (strlen($row[$i]) < 1000) {
2093 // use a CAST if possible, to avoid problems
2094 // if the field contains wildcard characters % or _
2095 $condition .= '= CAST(0x' . bin2hex($row[$i])
2096 . ' AS BINARY) AND';
2098 // this blob won't be part of the final condition
2101 } elseif ($meta->type
== 'bit') {
2102 $condition .= "= b'" . PMA_printable_bit_value($row[$i], $meta->length
) . "' AND";
2104 $condition .= '= \''
2105 . PMA_sqlAddslashes($row[$i], false, true) . '\' AND';
2108 if ($meta->primary_key
> 0) {
2109 $primary_key .= $condition;
2110 } elseif ($meta->unique_key
> 0) {
2111 $unique_key .= $condition;
2113 $nonprimary_condition .= $condition;
2116 // Correction University of Virginia 19991216:
2117 // prefer primary or unique keys for condition,
2118 // but use conjunction of all values if no primary key
2119 $clause_is_unique = true;
2121 $preferred_condition = $primary_key;
2122 } elseif ($unique_key) {
2123 $preferred_condition = $unique_key;
2124 } elseif (! $force_unique) {
2125 $preferred_condition = $nonprimary_condition;
2126 $clause_is_unique = false;
2129 $where_clause = trim(preg_replace('|\s?AND$|', '', $preferred_condition));
2130 return(array($where_clause, $clause_is_unique));
2134 * Generate a button or image tag
2136 * @uses PMA_USR_BROWSER_AGENT
2137 * @uses $GLOBALS['pmaThemeImage']
2138 * @uses $GLOBALS['cfg']['PropertiesIconic']
2139 * @param string name of button element
2140 * @param string class of button element
2141 * @param string name of image element
2142 * @param string text to display
2143 * @param string image to display
2147 function PMA_buttonOrImage($button_name, $button_class, $image_name, $text,
2150 if (false === $GLOBALS['cfg']['PropertiesIconic']) {
2151 echo ' <input type="submit" name="' . $button_name . '"'
2152 .' value="' . htmlspecialchars($text) . '"'
2153 .' title="' . htmlspecialchars($text) . '" />' . "\n";
2157 /* Opera has trouble with <input type="image"> */
2158 /* IE has trouble with <button> */
2159 if (PMA_USR_BROWSER_AGENT
!= 'IE') {
2160 echo '<button class="' . $button_class . '" type="submit"'
2161 .' name="' . $button_name . '" value="' . htmlspecialchars($text) . '"'
2162 .' title="' . htmlspecialchars($text) . '">' . "\n"
2163 . PMA_getIcon($image, $text)
2164 .'</button>' . "\n";
2166 echo '<input type="image" name="' . $image_name . '" value="'
2167 . htmlspecialchars($text) . '" title="' . htmlspecialchars($text) . '" src="' . $GLOBALS['pmaThemeImage']
2169 . ($GLOBALS['cfg']['PropertiesIconic'] === 'both' ?
' ' . htmlspecialchars($text) : '') . "\n";
2174 * Generate a pagination selector for browsing resultsets
2177 * @param string Number of rows in the pagination set
2178 * @param string current page number
2179 * @param string number of total pages
2180 * @param string If the number of pages is lower than this
2181 * variable, no pages will be omitted in
2183 * @param string How many rows at the beginning should always
2185 * @param string How many rows at the end should always
2187 * @param string Percentage of calculation page offsets to
2188 * hop to a next page
2189 * @param string Near the current page, how many pages should
2190 * be considered "nearby" and displayed as
2192 * @param string The prompt to display (sometimes empty)
2196 function PMA_pageselector($rows, $pageNow = 1, $nbTotalPage = 1,
2197 $showAll = 200, $sliceStart = 5, $sliceEnd = 5, $percent = 20,
2198 $range = 10, $prompt = '')
2200 $increment = floor($nbTotalPage / $percent);
2201 $pageNowMinusRange = ($pageNow - $range);
2202 $pageNowPlusRange = ($pageNow +
$range);
2204 $gotopage = $prompt . ' <select id="pageselector" ';
2205 if ($GLOBALS['cfg']['AjaxEnable']) {
2206 $gotopage .= ' class="ajax"';
2208 $gotopage .= ' name="pos" >' . "\n";
2209 if ($nbTotalPage < $showAll) {
2210 $pages = range(1, $nbTotalPage);
2214 // Always show first X pages
2215 for ($i = 1; $i <= $sliceStart; $i++
) {
2219 // Always show last X pages
2220 for ($i = $nbTotalPage - $sliceEnd; $i <= $nbTotalPage; $i++
) {
2224 // Based on the number of results we add the specified
2225 // $percent percentage to each page number,
2226 // so that we have a representing page number every now and then to
2227 // immediately jump to specific pages.
2228 // As soon as we get near our currently chosen page ($pageNow -
2229 // $range), every page number will be shown.
2231 $x = $nbTotalPage - $sliceEnd;
2232 $met_boundary = false;
2234 if ($i >= $pageNowMinusRange && $i <= $pageNowPlusRange) {
2235 // If our pageselector comes near the current page, we use 1
2236 // counter increments
2238 $met_boundary = true;
2240 // We add the percentage increment to our current page to
2241 // hop to the next one in range
2244 // Make sure that we do not cross our boundaries.
2245 if ($i > $pageNowMinusRange && ! $met_boundary) {
2246 $i = $pageNowMinusRange;
2250 if ($i > 0 && $i <= $x) {
2255 // Since because of ellipsing of the current page some numbers may be double,
2256 // we unify our array:
2258 $pages = array_unique($pages);
2261 foreach ($pages as $i) {
2262 if ($i == $pageNow) {
2263 $selected = 'selected="selected" style="font-weight: bold"';
2267 $gotopage .= ' <option ' . $selected . ' value="' . (($i - 1) * $rows) . '">' . $i . '</option>' . "\n";
2270 $gotopage .= ' </select><noscript><input type="submit" value="' . __('Go') . '" /></noscript>';
2277 * Generate navigation for a list
2279 * @todo use $pos from $_url_params
2281 * @param integer number of elements in the list
2282 * @param integer current position in the list
2283 * @param array url parameters
2284 * @param string script name for form target
2285 * @param string target frame
2286 * @param integer maximum number of elements to display from the list
2290 function PMA_listNavigator($count, $pos, $_url_params, $script, $frame, $max_count) {
2292 if ($max_count < $count) {
2293 echo 'frame_navigation' == $frame ?
'<div id="navidbpageselector">' . "\n" : '';
2294 echo __('Page number:');
2295 echo 'frame_navigation' == $frame ?
'<br />' : ' ';
2297 // Move to the beginning or to the previous page
2299 // patch #474210 - part 1
2300 if ($GLOBALS['cfg']['NavigationBarIconic']) {
2301 $caption1 = '<<';
2302 $caption2 = ' < ';
2303 $title1 = ' title="' . __('Begin') . '"';
2304 $title2 = ' title="' . __('Previous') . '"';
2306 $caption1 = __('Begin') . ' <<';
2307 $caption2 = __('Previous') . ' <';
2310 } // end if... else...
2311 $_url_params['pos'] = 0;
2312 echo '<a' . $title1 . ' href="' . $script
2313 . PMA_generate_common_url($_url_params) . '" target="' . $frame . '">'
2314 . $caption1 . '</a>';
2315 $_url_params['pos'] = $pos - $max_count;
2316 echo '<a' . $title2 . ' href="' . $script
2317 . PMA_generate_common_url($_url_params) . '" target="' . $frame . '">'
2318 . $caption2 . '</a>';
2321 echo "\n", '<form action="./', basename($script), '" method="post" target="', $frame, '">', "\n";
2322 echo PMA_generate_common_hidden_inputs($_url_params);
2323 echo PMA_pageselector(
2325 floor(($pos +
1) / $max_count) +
1,
2326 ceil($count / $max_count));
2329 if ($pos +
$max_count < $count) {
2330 if ($GLOBALS['cfg']['NavigationBarIconic']) {
2331 $caption3 = ' > ';
2332 $caption4 = '>>';
2333 $title3 = ' title="' . __('Next') . '"';
2334 $title4 = ' title="' . __('End') . '"';
2336 $caption3 = '> ' . __('Next');
2337 $caption4 = '>> ' . __('End');
2340 } // end if... else...
2341 $_url_params['pos'] = $pos +
$max_count;
2342 echo '<a' . $title3 . ' href="' . $script
2343 . PMA_generate_common_url($_url_params) . '" target="' . $frame . '">'
2344 . $caption3 . '</a>';
2345 $_url_params['pos'] = floor($count / $max_count) * $max_count;
2346 if ($_url_params['pos'] == $count) {
2347 $_url_params['pos'] = $count - $max_count;
2349 echo '<a' . $title4 . ' href="' . $script
2350 . PMA_generate_common_url($_url_params) . '" target="' . $frame . '">'
2351 . $caption4 . '</a>';
2354 if ('frame_navigation' == $frame) {
2355 echo '</div>' . "\n";
2361 * replaces %u in given path with current user name
2365 * $user_dir = PMA_userDir('/var/pma_tmp/%u/'); // '/var/pma_tmp/root/'
2368 * @uses $cfg['Server']['user']
2370 * @uses str_replace()
2371 * @param string $dir with wildcard for user
2372 * @return string per user directory
2374 function PMA_userDir($dir)
2376 // add trailing slash
2377 if (substr($dir, -1) != '/') {
2381 return str_replace('%u', $GLOBALS['cfg']['Server']['user'], $dir);
2385 * returns html code for db link to default db page
2387 * @uses $cfg['DefaultTabDatabase']
2388 * @uses $GLOBALS['db']
2389 * @uses PMA_generate_common_url()
2390 * @uses PMA_unescape_mysql_wildcards()
2393 * @uses htmlspecialchars()
2394 * @param string $database
2395 * @return string html link to default db page
2397 function PMA_getDbLink($database = null)
2399 if (!strlen($database)) {
2400 if (!strlen($GLOBALS['db'])) {
2403 $database = $GLOBALS['db'];
2405 $database = PMA_unescape_mysql_wildcards($database);
2408 return '<a href="' . $GLOBALS['cfg']['DefaultTabDatabase'] . '?' . PMA_generate_common_url($database) . '"'
2409 .' title="' . sprintf(__('Jump to database "%s".'), htmlspecialchars($database)) . '">'
2410 .htmlspecialchars($database) . '</a>';
2414 * Displays a lightbulb hint explaining a known external bug
2415 * that affects a functionality
2417 * @uses PMA_MYSQL_INT_VERSION
2418 * @uses PMA_showHint()
2420 * @param string $functionality localized message explaining the func.
2421 * @param string $component 'mysql' (eventually, 'php')
2422 * @param string $minimum_version of this component
2423 * @param string $bugref bug reference for this component
2425 function PMA_externalBug($functionality, $component, $minimum_version, $bugref)
2427 if ($component == 'mysql' && PMA_MYSQL_INT_VERSION
< $minimum_version) {
2428 echo PMA_showHint(sprintf(__('The %s functionality is affected by a known bug, see %s'), $functionality, PMA_linkURL('http://bugs.mysql.com/') . $bugref));
2433 * Generates and echoes an HTML checkbox
2435 * @param string $html_field_name the checkbox HTML field
2436 * @param string $label
2437 * @param boolean $checked is it initially checked?
2438 * @param boolean $onclick should it submit the form on click?
2440 function PMA_display_html_checkbox($html_field_name, $label, $checked, $onclick) {
2442 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>';
2446 * Generates and echoes a set of radio HTML fields
2448 * @uses htmlspecialchars()
2449 * @param string $html_field_name the radio HTML field
2450 * @param array $choices the choices values and labels
2451 * @param string $checked_choice the choice to check by default
2452 * @param boolean $line_break whether to add an HTML line break after a choice
2453 * @param boolean $escape_label whether to use htmlspecialchars() on label
2454 * @param string $class enclose each choice with a div of this class
2456 function PMA_display_html_radio($html_field_name, $choices, $checked_choice = '', $line_break = true, $escape_label = true, $class='') {
2457 foreach ($choices as $choice_value => $choice_label) {
2458 if (! empty($class)) {
2459 echo '<div class="' . $class . '">';
2461 $html_field_id = $html_field_name . '_' . $choice_value;
2462 echo '<input type="radio" name="' . $html_field_name . '" id="' . $html_field_id . '" value="' . htmlspecialchars($choice_value) . '"';
2463 if ($choice_value == $checked_choice) {
2464 echo ' checked="checked"';
2467 echo '<label for="' . $html_field_id . '">' . ($escape_label ?
htmlspecialchars($choice_label) : $choice_label) . '</label>';
2471 if (! empty($class)) {
2479 * Generates and returns an HTML dropdown
2481 * @uses htmlspecialchars()
2482 * @param string $select_name
2483 * @param array $choices the choices values
2484 * @param string $active_choice the choice to select by default
2485 * @param string $id the id of the select element; can be different in case
2486 * the dropdown is present more than once on the page
2487 * @todo support titles
2489 function PMA_generate_html_dropdown($select_name, $choices, $active_choice, $id)
2491 $result = '<select name="' . htmlspecialchars($select_name) . '" id="' . htmlspecialchars($id) . '">';
2492 foreach ($choices as $one_choice_value => $one_choice_label) {
2493 $result .= '<option value="' . htmlspecialchars($one_choice_value) . '"';
2494 if ($one_choice_value == $active_choice) {
2495 $result .= ' selected="selected"';
2497 $result .= '>' . htmlspecialchars($one_choice_label) . '</option>';
2499 $result .= '</select>';
2504 * Generates a slider effect (jQjuery)
2505 * Takes care of generating the initial <div> and the link
2506 * controlling the slider; you have to generate the </div> yourself
2507 * after the sliding section.
2509 * @uses $GLOBALS['cfg']['InitialSlidersState']
2510 * @param string $id the id of the <div> on which to apply the effect
2511 * @param string $message the message to show as a link
2513 function PMA_generate_slider_effect($id, $message)
2515 if ($GLOBALS['cfg']['InitialSlidersState'] == 'disabled') {
2516 echo '<div id="' . $id . '">';
2520 * Bad hack on the next line. document.write() conflicts with jQuery, hence,
2521 * opening the <div> with PHP itself instead of JavaScript.
2523 * @todo find a better solution that uses $.append(), the recommended method
2524 * maybe by using an additional param, the id of the div to append to
2527 <div id
="<?php echo $id; ?>" <?php
echo $GLOBALS['cfg']['InitialSlidersState'] == 'closed' ?
' style="display: none; overflow:auto;"' : ''; ?
> class="pma_auto_slider" title
="<?php echo htmlspecialchars($message); ?>">
2532 * Verifies if something is cached in the session
2534 * @param string $var
2535 * @param scalar $server
2538 function PMA_cacheExists($var, $server = 0)
2540 if (true === $server) {
2541 $server = $GLOBALS['server'];
2543 return isset($_SESSION['cache']['server_' . $server][$var]);
2547 * Gets cached information from the session
2549 * @param string $var
2550 * @param scalar $server
2553 function PMA_cacheGet($var, $server = 0)
2555 if (true === $server) {
2556 $server = $GLOBALS['server'];
2558 if (isset($_SESSION['cache']['server_' . $server][$var])) {
2559 return $_SESSION['cache']['server_' . $server][$var];
2566 * Caches information in the session
2568 * @param string $var
2570 * @param integer $server
2573 function PMA_cacheSet($var, $val = null, $server = 0)
2575 if (true === $server) {
2576 $server = $GLOBALS['server'];
2578 $_SESSION['cache']['server_' . $server][$var] = $val;
2582 * Removes cached information from the session
2584 * @param string $var
2585 * @param scalar $server
2587 function PMA_cacheUnset($var, $server = 0)
2589 if (true === $server) {
2590 $server = $GLOBALS['server'];
2592 unset($_SESSION['cache']['server_' . $server][$var]);
2596 * Converts a bit value to printable format;
2597 * in MySQL a BIT field can be from 1 to 64 bits so we need this
2598 * function because in PHP, decbin() supports only 32 bits
2605 * @param numeric $value coming from a BIT field
2606 * @param integer $length
2607 * @return string the printable value
2609 function PMA_printable_bit_value($value, $length) {
2611 for ($i = 0, $len_ceiled = ceil($length / 8); $i < $len_ceiled; $i++
) {
2612 $printable .= sprintf('%08d', decbin(ord(substr($value, $i, 1))));
2614 $printable = substr($printable, -$length);
2619 * Verifies whether the value contains a non-printable character
2621 * @uses preg_match()
2622 * @param string $value
2625 function PMA_contains_nonprintable_ascii($value) {
2626 return preg_match('@[^[:print:]]@', $value);
2630 * Converts a BIT type default value
2631 * for example, b'010' becomes 010
2634 * @param string $bit_default_value
2635 * @return string the converted value
2637 function PMA_convert_bit_default_value($bit_default_value) {
2638 return strtr($bit_default_value, array("b" => "", "'" => ""));
2642 * Extracts the various parts from a field type spec
2647 * @param string $fieldspec
2648 * @return array associative array containing type, spec_in_brackets
2649 * and possibly enum_set_values (another array)
2651 function PMA_extractFieldSpec($fieldspec) {
2652 $first_bracket_pos = strpos($fieldspec, '(');
2653 if ($first_bracket_pos) {
2654 $spec_in_brackets = chop(substr($fieldspec, $first_bracket_pos +
1, (strrpos($fieldspec, ')') - $first_bracket_pos - 1)));
2655 // convert to lowercase just to be sure
2656 $type = strtolower(chop(substr($fieldspec, 0, $first_bracket_pos)));
2659 $spec_in_brackets = '';
2662 if ('enum' == $type ||
'set' == $type) {
2663 // Define our working vars
2664 $enum_set_values = array();
2669 // While there is another character to process
2670 while (isset($fieldspec[$index])) {
2671 // Grab the char to look at
2672 $char = $fieldspec[$index];
2674 // If it is a single quote, needs to be handled specially
2676 // If we are not currently in a string, begin one
2680 // Otherwise, it may be either an end of a string, or a 'double quote' which can be handled as-is
2682 // Check out the next character (if possible)
2683 $has_next = isset($fieldspec[$index +
1]);
2684 $next = $has_next ?
$fieldspec[$index +
1] : null;
2686 // If we have reached the end of our 'working' string (because there are no more chars, or the next char is not another quote)
2687 if (! $has_next ||
$next != "'") {
2688 $enum_set_values[] = $working;
2691 // Otherwise, this is a 'double quote', and can be added to the working string
2692 } elseif ($next == "'") {
2694 // Skip the next char; we already know what it is
2698 // escaping of a quote?
2699 } elseif ('\\' == $char && isset($fieldspec[$index +
1]) && "'" == $fieldspec[$index +
1]) {
2702 // Otherwise, add it to our working string like normal
2706 // Increment character index
2710 $enum_set_values = array();
2715 'spec_in_brackets' => $spec_in_brackets,
2716 'enum_set_values' => $enum_set_values
2721 * Verifies if this table's engine supports foreign keys
2723 * @uses strtoupper()
2724 * @param string $engine
2727 function PMA_foreignkey_supported($engine) {
2728 $engine = strtoupper($engine);
2729 if ('INNODB' == $engine ||
'PBXT' == $engine) {
2737 * Replaces some characters by a displayable equivalent
2739 * @uses str_replace()
2740 * @param string $content
2741 * @return string the content with characters replaced
2743 function PMA_replace_binary_contents($content) {
2744 $result = str_replace("\x00", '\0', $content);
2745 $result = str_replace("\x08", '\b', $result);
2746 $result = str_replace("\x0a", '\n', $result);
2747 $result = str_replace("\x0d", '\r', $result);
2748 $result = str_replace("\x1a", '\Z', $result);
2754 * If the string starts with a \r\n pair (0x0d0a) add an extra \n
2757 * @return string with the chars replaced
2760 function PMA_duplicateFirstNewline($string){
2761 $first_occurence = strpos($string, "\r\n");
2762 if ($first_occurence === 0){
2763 $string = "\n".$string;
2769 * get the action word corresponding to a script name
2770 * in order to display it as a title in navigation panel
2773 * @param string a valid value for $cfg['LeftDefaultTabTable']
2774 * or $cfg['DefaultTabTable']
2775 * or $cfg['DefaultTabDatabase']
2777 function PMA_getTitleForTarget($target) {
2780 // Values for $cfg['DefaultTabTable']
2781 'tbl_structure.php' => __('Structure'),
2782 'tbl_sql.php' => __('SQL'),
2783 'tbl_select.php' =>__('Search'),
2784 'tbl_change.php' =>__('Insert'),
2785 'sql.php' => __('Browse'),
2787 // Values for $cfg['DefaultTabDatabase']
2788 'db_structure.php' => __('Structure'),
2789 'db_sql.php' => __('SQL'),
2790 'db_search.php' => __('Search'),
2791 'db_operations.php' => __('Operations'),
2793 return $mapping[$target];
2797 * Formats user string, expading @VARIABLES@, accepting strftime format string.
2799 * @param string Text where to do expansion.
2800 * @param function Function to call for escaping variable values.
2801 * @param array Array with overrides for default parameters (obtained from GLOBALS).
2803 function PMA_expandUserString($string, $escape = NULL, $updates = array()) {
2805 $vars['http_host'] = PMA_getenv('HTTP_HOST') ?
PMA_getenv('HTTP_HOST') : '';
2806 $vars['server_name'] = $GLOBALS['cfg']['Server']['host'];
2807 $vars['server_verbose'] = $GLOBALS['cfg']['Server']['verbose'];
2808 $vars['server_verbose_or_name'] = !empty($GLOBALS['cfg']['Server']['verbose']) ?
$GLOBALS['cfg']['Server']['verbose'] : $GLOBALS['cfg']['Server']['host'];
2809 $vars['database'] = $GLOBALS['db'];
2810 $vars['table'] = $GLOBALS['table'];
2811 $vars['phpmyadmin_version'] = 'phpMyAdmin ' . PMA_VERSION
;
2813 /* Update forced variables */
2814 foreach($updates as $key => $val) {
2818 /* Replacement mapping */
2820 * The __VAR__ ones are for backward compatibility, because user
2821 * might still have it in cookies.
2824 '@HTTP_HOST@' => $vars['http_host'],
2825 '@SERVER@' => $vars['server_name'],
2826 '__SERVER__' => $vars['server_name'],
2827 '@VERBOSE@' => $vars['server_verbose'],
2828 '@VSERVER@' => $vars['server_verbose_or_name'],
2829 '@DATABASE@' => $vars['database'],
2830 '__DB__' => $vars['database'],
2831 '@TABLE@' => $vars['table'],
2832 '__TABLE__' => $vars['table'],
2833 '@PHPMYADMIN@' => $vars['phpmyadmin_version'],
2836 /* Optional escaping */
2837 if (!is_null($escape)) {
2838 foreach($replace as $key => $val) {
2839 $replace[$key] = $escape($val);
2843 /* Fetch fields list if required */
2844 if (strpos($string, '@FIELDS@') !== FALSE) {
2845 $fields_list = PMA_DBI_fetch_result(
2846 'SHOW COLUMNS FROM ' . PMA_backquote($GLOBALS['db'])
2847 . '.' . PMA_backquote($GLOBALS['table']));
2849 $field_names = array();
2850 foreach ($fields_list as $field) {
2851 if (!is_null($escape)) {
2852 $field_names[] = $escape($field['Field']);
2854 $field_names[] = $field['Field'];
2858 $replace['@FIELDS@'] = implode(',', $field_names);
2861 /* Do the replacement */
2862 return str_replace(array_keys($replace), array_values($replace), strftime($string));
2866 * function that generates a json output for an ajax request and ends script
2869 * @param boolean success whether the ajax request was successfull
2870 * @param string message string containing the html of the message
2871 * @param array extra_data optional - any other data as part of the json request
2874 * @uses json_encode()
2876 function PMA_ajaxResponse($message, $success = true, $extra_data = array())
2878 $response = array();
2879 if( $success == true ) {
2880 $response['success'] = true;
2881 if ($message instanceof PMA_Message
) {
2882 $response['message'] = $message->getDisplay();
2885 $response['message'] = $message;
2889 $response['success'] = false;
2890 if($message instanceof PMA_Message
) {
2891 $response['error'] = $message->getDisplay();
2894 $response['error'] = $message;
2898 // If extra_data has been provided, append it to the response array
2899 if( ! empty($extra_data) && count($extra_data) > 0 ) {
2900 $response = array_merge($response, $extra_data);
2903 // Set the Content-Type header to JSON so that jQuery parses the response correctly
2904 if(!isset($GLOBALS['is_header_sent'])) {
2905 header('Cache-Control: no-cache');
2906 header("Content-Type: application/json");
2908 echo json_encode($response);
2913 * Display the form used to browse anywhere on the local server for the file to import
2915 function PMA_browseUploadFile($max_upload_size) {
2917 echo '<label for="radio_import_file">' . __("Browse your computer:") . '</label>';
2918 echo '<div id="upload_form_status" style="display: none;"></div>';
2919 echo '<div id="upload_form_status_info" style="display: none;"></div>';
2920 echo '<input type="file" name="import_file" id="input_import_file" />';
2921 echo PMA_displayMaximumUploadSize($max_upload_size) . "\n";
2922 // some browsers should respect this :)
2923 echo PMA_generateHiddenMaxFileSize($max_upload_size) . "\n";
2927 * Display the form used to select a file to import from the server upload directory
2929 function PMA_selectUploadFile($import_list, $uploaddir) {
2930 echo '<label for="radio_local_import_file">' . sprintf(__("Select from the web server upload directory <b>%s</b>:"), htmlspecialchars(PMA_userDir($uploaddir))) . '</label>';
2932 foreach ($import_list as $key => $val) {
2933 if (!empty($extensions)) {
2936 $extensions .= $val['extension'];
2938 $matcher = '@\.(' . $extensions . ')(\.(' . PMA_supportedDecompressions() . '))?$@';
2940 $files = PMA_getFileSelectOptions(PMA_userDir($uploaddir), $matcher, (isset($timeout_passed) && $timeout_passed && isset($local_import_file)) ?
$local_import_file : '');
2941 if ($files === FALSE) {
2942 PMA_Message
::error(__('The directory you set for upload work cannot be reached'))->display();
2943 } elseif (!empty($files)) {
2945 echo ' <select style="margin: 5px" size="1" name="local_import_file" id="select_local_import_file">' . "\n";
2946 echo ' <option value=""> </option>' . "\n";
2948 echo ' </select>' . "\n";
2949 } elseif (empty ($files)) {
2950 echo '<i>' . __('There are no files to upload') . '</i>';
2955 * Build titles and icons for action links
2957 * @return array the action titles
2958 * @uses PMA_getIcon()
2960 function PMA_buildActionTitles() {
2963 $titles['Browse'] = PMA_getIcon('b_browse.png', __('Browse'), true);
2964 $titles['NoBrowse'] = PMA_getIcon('bd_browse.png', __('Browse'), true);
2965 $titles['Search'] = PMA_getIcon('b_select.png', __('Search'), true);
2966 $titles['NoSearch'] = PMA_getIcon('bd_select.png', __('Search'), true);
2967 $titles['Insert'] = PMA_getIcon('b_insrow.png', __('Insert'), true);
2968 $titles['NoInsert'] = PMA_getIcon('bd_insrow.png', __('Insert'), true);
2969 $titles['Structure'] = PMA_getIcon('b_props.png', __('Structure'), true);
2970 $titles['Drop'] = PMA_getIcon('b_drop.png', __('Drop'), true);
2971 $titles['NoDrop'] = PMA_getIcon('bd_drop.png', __('Drop'), true);
2972 $titles['Empty'] = PMA_getIcon('b_empty.png', __('Empty'), true);
2973 $titles['NoEmpty'] = PMA_getIcon('bd_empty.png', __('Empty'), true);