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