libraries/core.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Core functions used all over the scripts.
   5  * This script is distinct from libraries/common.inc.php because this
   6  * script is called from /test.
   7  *
   8  * @package phpMyAdmin
   9  */
  10
  11 /**
  12  * checks given $var and returns it if valid, or $default of not valid
  13  * given $var is also checked for type being 'similar' as $default
  14  * or against any other type if $type is provided
  15  *
  16  * <code>
  17  * // $_REQUEST['db'] not set
  18  * echo PMA_ifSetOr($_REQUEST['db'], ''); // ''
  19  * // $_REQUEST['sql_query'] not set
  20  * echo PMA_ifSetOr($_REQUEST['sql_query']); // null
  21  * // $cfg['ForceSSL'] not set
  22  * echo PMA_ifSetOr($cfg['ForceSSL'], false, 'boolean'); // false
  23  * echo PMA_ifSetOr($cfg['ForceSSL']); // null
  24  * // $cfg['ForceSSL'] set to 1
  25  * echo PMA_ifSetOr($cfg['ForceSSL'], false, 'boolean'); // false
  26  * echo PMA_ifSetOr($cfg['ForceSSL'], false, 'similar'); // 1
  27  * echo PMA_ifSetOr($cfg['ForceSSL'], false); // 1
  28  * // $cfg['ForceSSL'] set to true
  29  * echo PMA_ifSetOr($cfg['ForceSSL'], false, 'boolean'); // true
  30  * </code>
  31  *
  32  * @see     PMA_isValid()
  33  * @param mixed   $var        param to check
  34  * @param mixed   $default    default value
  35  * @param mixed   $type       var type or array of values to check against $var
  36  * @return  mixed   $var or $default
  37  */
  38 function PMA_ifSetOr(&$var, $default = null, $type = 'similar')
  39 {
  40     if (! PMA_isValid($var, $type, $default)) {
  41         return $default;
  42     }
  43
  44     return $var;
  45 }
  46
  47 /**
  48  * checks given $var against $type or $compare
  49  *
  50  * $type can be:
  51  * - false       : no type checking
  52  * - 'scalar'    : whether type of $var is integer, float, string or boolean
  53  * - 'numeric'   : whether type of $var is any number repesentation
  54  * - 'length'    : whether type of $var is scalar with a string length > 0
  55  * - 'similar'   : whether type of $var is similar to type of $compare
  56  * - 'equal'     : whether type of $var is identical to type of $compare
  57  * - 'identical' : whether $var is identical to $compare, not only the type!
  58  * - or any other valid PHP variable type
  59  *
  60  * <code>
  61  * // $_REQUEST['doit'] = true;
  62  * PMA_isValid($_REQUEST['doit'], 'identical', 'true'); // false
  63  * // $_REQUEST['doit'] = 'true';
  64  * PMA_isValid($_REQUEST['doit'], 'identical', 'true'); // true
  65  * </code>
  66  *
  67  * NOTE: call-by-reference is used to not get NOTICE on undefined vars,
  68  * but the var is not altered inside this function, also after checking a var
  69  * this var exists nut is not set, example:
  70  * <code>
  71  * // $var is not set
  72  * isset($var); // false
  73  * functionCallByReference($var); // false
  74  * isset($var); // true
  75  * functionCallByReference($var); // true
  76  * </code>
  77  *
  78  * to avoid this we set this var to null if not isset
  79  *
  80  * @todo create some testsuites
  81  * @todo add some more var types like hex, bin, ...?
  82  * @see     http://php.net/gettype
  83  * @param mixed   $var        variable to check
  84  * @param mixed   $type       var type or array of valid values to check against $var
  85  * @param mixed   $compare    var to compare with $var
  86  * @return  boolean whether valid or not
  87  */
  88 function PMA_isValid(&$var, $type = 'length', $compare = null)
  89 {
  90     if (! isset($var)) {
  91         // var is not even set
  92         return false;
  93     }
  94
  95     if ($type === false) {
  96         // no vartype requested
  97         return true;
  98     }
  99
 100     if (is_array($type)) {
 101         return in_array($var, $type);
 102     }
 103
 104     // allow some aliaes of var types
 105     $type = strtolower($type);
 106     switch ($type) {
 107         case 'identic' :
 108             $type = 'identical';
 109             break;
 110         case 'len' :
 111             $type = 'length';
 112             break;
 113         case 'bool' :
 114             $type = 'boolean';
 115             break;
 116         case 'float' :
 117             $type = 'double';
 118             break;
 119         case 'int' :
 120             $type = 'integer';
 121             break;
 122         case 'null' :
 123             $type = 'NULL';
 124             break;
 125     }
 126
 127     if ($type === 'identical') {
 128         return $var === $compare;
 129     }
 130
 131     // whether we should check against given $compare
 132     if ($type === 'similar') {
 133         switch (gettype($compare)) {
 134             case 'string':
 135             case 'boolean':
 136                 $type = 'scalar';
 137                 break;
 138             case 'integer':
 139             case 'double':
 140                 $type = 'numeric';
 141                 break;
 142             default:
 143                 $type = gettype($compare);
 144         }
 145     } elseif ($type === 'equal') {
 146         $type = gettype($compare);
 147     }
 148
 149     // do the check
 150     if ($type === 'length' || $type === 'scalar') {
 151         $is_scalar = is_scalar($var);
 152         if ($is_scalar && $type === 'length') {
 153             return (bool) strlen($var);
 154         }
 155         return $is_scalar;
 156     }
 157
 158     if ($type === 'numeric') {
 159         return is_numeric($var);
 160     }
 161
 162     if (gettype($var) === $type) {
 163         return true;
 164     }
 165
 166     return false;
 167 }
 168
 169 /**
 170  * Removes insecure parts in a path; used before include() or
 171  * require() when a part of the path comes from an insecure source
 172  * like a cookie or form.
 173  *
 174  * @param string  The path to check
 175  *
 176  * @return   string  The secured path
 177  *
 178  * @access  public
 179  */
 180 function PMA_securePath($path)
 181 {
 182     // change .. to .
 183     $path = preg_replace('@\.\.*@', '.', $path);
 184
 185     return $path;
 186 } // end function
 187
 188 /**
 189  * displays the given error message on phpMyAdmin error page in foreign language,
 190  * ends script execution and closes session
 191  *
 192  * loads language file if not loaded already
 193  *
 194  * @todo    use detected argument separator (PMA_Config)
 195  * @param string $error_message the error message or named error message
 196  * @param string|array $message_args arguments applied to $error_message
 197  * @return  exit
 198  */
 199 function PMA_fatalError($error_message, $message_args = null)
 200 {
 201     /* Use format string if applicable */
 202     if (is_string($message_args)) {
 203         $error_message = sprintf($error_message, $message_args);
 204     } elseif (is_array($message_args)) {
 205         $error_message = vsprintf($error_message, $message_args);
 206     }
 207     $error_message = strtr($error_message, array('<br />' => '[br]'));
 208
 209     if (function_exists('__')) {
 210         $error_header = __('Error');
 211     } else {
 212         $error_header = 'Error';
 213     }
 214
 215     // Displays the error message
 216     $lang = $GLOBALS['available_languages'][$GLOBALS['lang']][1];
 217     $dir = $GLOBALS['text_dir'];
 218     $type = $error_header;
 219     $error = $error_message;
 220
 221     // on fatal errors it cannot hurt to always delete the current session
 222     if (isset($GLOBALS['session_name']) && isset($_COOKIE[$GLOBALS['session_name']])) {
 223         $GLOBALS['PMA_Config']->removeCookie($GLOBALS['session_name']);
 224     }
 225
 226     require('./libraries/error.inc.php');
 227
 228     if (!defined('TESTSUITE')) {
 229         exit;
 230     }
 231 }
 232
 233 /**
 234  * Returns a link to the PHP documentation
 235  *
 236  * @param string  anchor in documentation
 237  *
 238  * @return  string  the URL
 239  *
 240  * @access  public
 241  */
 242 function PMA_getPHPDocLink($target)
 243 {
 244     /* l10n: Language to use for PHP documentation, please use only languages which do exist in official documentation. */
 245     $lang = _pgettext('PHP documentation language', 'en');
 246
 247     return 'http://php.net/manual/' . $lang . '/' . $target;
 248 }
 249
 250 /**
 251  * Warn or fail on missing extension.
 252  *
 253  * @param string $extension Extension name
 254  * @param bool $fatal Whether the error is fatal.
 255  / @param string $extra Extra string to append to messsage.
 256  */
 257 function PMA_warnMissingExtension($extension, $fatal = false, $extra = '')
 258 {
 259     /* Gettext does not have to be loaded yet here */
 260     if (function_exists('__')) {
 261         $message = __('The %s extension is missing. Please check your PHP configuration.');
 262     } else {
 263         $message = 'The %s extension is missing. Please check your PHP configuration.';
 264     }
 265     $message = sprintf($message,
 266         '[a@' . PMA_getPHPDocLink('book.' . $extension . '.php') . '@Documentation][em]' . $extension . '[/em][/a]');
 267     if ($extra != '') {
 268         $message .= ' ' . $extra;
 269     }
 270     if ($fatal) {
 271         PMA_fatalError($message);
 272     } else {
 273         trigger_error($message, E_USER_WARNING);
 274     }
 275 }
 276
 277 /**
 278  * returns count of tables in given db
 279  *
 280  * @param string  $db database to count tables for
 281  * @return  integer count of tables in $db
 282  */
 283 function PMA_getTableCount($db)
 284 {
 285     $tables = PMA_DBI_try_query(
 286         'SHOW TABLES FROM ' . PMA_backquote($db) . ';',
 287         null, PMA_DBI_QUERY_STORE);
 288     if ($tables) {
 289         $num_tables = PMA_DBI_num_rows($tables);
 290
 291         // do not count hidden blobstreaming tables
 292         while ((($num_tables > 0)) && $data = PMA_DBI_fetch_assoc($tables)) {
 293             if (PMA_BS_IsHiddenTable($data['Tables_in_' . $db])) {
 294                 $num_tables--;
 295             }
 296         }
 297
 298         PMA_DBI_free_result($tables);
 299     } else {
 300         $num_tables = 0;
 301     }
 302
 303     return $num_tables;
 304 }
 305
 306 /**
 307  * Converts numbers like 10M into bytes
 308  * Used with permission from Moodle (http://moodle.org) by Martin Dougiamas
 309  * (renamed with PMA prefix to avoid double definition when embedded
 310  * in Moodle)
 311  *
 312  * @param string  $size
 313  * @return  integer $size
 314  */
 315 function PMA_get_real_size($size = 0)
 316 {
 317     if (! $size) {
 318         return 0;
 319     }
 320
 321     $scan['gb'] = 1073741824; //1024 * 1024 * 1024;
 322     $scan['g']  = 1073741824; //1024 * 1024 * 1024;
 323     $scan['mb'] = 1048576;
 324     $scan['m']  = 1048576;
 325     $scan['kb'] =    1024;
 326     $scan['k']  =    1024;
 327     $scan['b']  =       1;
 328
 329     foreach ($scan as $unit => $factor) {
 330         if (strlen($size) > strlen($unit)
 331          && strtolower(substr($size, strlen($size) - strlen($unit))) == $unit) {
 332             return substr($size, 0, strlen($size) - strlen($unit)) * $factor;
 333         }
 334     }
 335
 336     return $size;
 337 } // end function PMA_get_real_size()
 338
 339 /**
 340  * merges array recursive like array_merge_recursive() but keyed-values are
 341  * always overwritten.
 342  *
 343  * array PMA_array_merge_recursive(array $array1[, array $array2[, array ...]])
 344  *
 345  * @see     http://php.net/array_merge
 346  * @see     http://php.net/array_merge_recursive
 347  * @param array   array to merge
 348  * @param array   array to merge
 349  * @param array   ...
 350  * @return  array   merged array
 351  */
 352 function PMA_array_merge_recursive()
 353 {
 354     switch(func_num_args()) {
 355         case 0 :
 356             return false;
 357             break;
 358         case 1 :
 359             // when does that happen?
 360             return func_get_arg(0);
 361             break;
 362         case 2 :
 363             $args = func_get_args();
 364             if (! is_array($args[0]) || ! is_array($args[1])) {
 365                 return $args[1];
 366             }
 367             foreach ($args[1] as $key2 => $value2) {
 368                 if (isset($args[0][$key2]) && !is_int($key2)) {
 369                     $args[0][$key2] = PMA_array_merge_recursive($args[0][$key2],
 370                         $value2);
 371                 } else {
 372                     // we erase the parent array, otherwise we cannot override a directive that
 373                     // contains array elements, like this:
 374                     // (in config.default.php) $cfg['ForeignKeyDropdownOrder'] = array('id-content','content-id');
 375                     // (in config.inc.php) $cfg['ForeignKeyDropdownOrder'] = array('content-id');
 376                     if (is_int($key2) && $key2 == 0) {
 377                         unset($args[0]);
 378                     }
 379                     $args[0][$key2] = $value2;
 380                 }
 381             }
 382             return $args[0];
 383             break;
 384         default :
 385             $args = func_get_args();
 386             $args[1] = PMA_array_merge_recursive($args[0], $args[1]);
 387             array_shift($args);
 388             return call_user_func_array('PMA_array_merge_recursive', $args);
 389             break;
 390     }
 391 }
 392
 393 /**
 394  * calls $function vor every element in $array recursively
 395  *
 396  * this function is protected against deep recursion attack CVE-2006-1549,
 397  * 1000 seems to be more than enough
 398  *
 399  * @see http://www.php-security.org/MOPB/MOPB-02-2007.html
 400  * @see http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2006-1549
 401  *
 402  * @param array   $array      array to walk
 403  * @param string  $function   function to call for every array element
 404  */
 405 function PMA_arrayWalkRecursive(&$array, $function, $apply_to_keys_also = false)
 406 {
 407     static $recursive_counter = 0;
 408     if (++$recursive_counter > 1000) {
 409         die('possible deep recursion attack');
 410     }
 411     foreach ($array as $key => $value) {
 412         if (is_array($value)) {
 413             PMA_arrayWalkRecursive($array[$key], $function, $apply_to_keys_also);
 414         } else {
 415             $array[$key] = $function($value);
 416         }
 417
 418         if ($apply_to_keys_also && is_string($key)) {
 419             $new_key = $function($key);
 420             if ($new_key != $key) {
 421                 $array[$new_key] = $array[$key];
 422                 unset($array[$key]);
 423             }
 424         }
 425     }
 426     $recursive_counter--;
 427 }
 428
 429 /**
 430  * boolean phpMyAdmin.PMA_checkPageValidity(string &$page, array $whitelist)
 431  *
 432  * checks given given $page against given $whitelist and returns true if valid
 433  * it ignores optionaly query paramters in $page (script.php?ignored)
 434  *
 435  * @param string  &$page      page to check
 436  * @param array   $whitelist  whitelist to check page against
 437  * @return  boolean whether $page is valid or not (in $whitelist or not)
 438  */
 439 function PMA_checkPageValidity(&$page, $whitelist)
 440 {
 441     if (! isset($page) || !is_string($page)) {
 442         return false;
 443     }
 444
 445     if (in_array($page, $whitelist)) {
 446         return true;
 447     } elseif (in_array(substr($page, 0, strpos($page . '?', '?')), $whitelist)) {
 448         return true;
 449     } else {
 450         $_page = urldecode($page);
 451         if (in_array(substr($_page, 0, strpos($_page . '?', '?')), $whitelist)) {
 452             return true;
 453         }
 454     }
 455     return false;
 456 }
 457
 458 /**
 459  * trys to find the value for the given environment vriable name
 460  *
 461  * searchs in $_SERVER, $_ENV than trys getenv() and apache_getenv()
 462  * in this order
 463  *
 464  * @param string  $var_name   variable name
 465  * @return  string  value of $var or empty string
 466  */
 467 function PMA_getenv($var_name)
 468 {
 469     if (isset($_SERVER[$var_name])) {
 470         return $_SERVER[$var_name];
 471     } elseif (isset($_ENV[$var_name])) {
 472         return $_ENV[$var_name];
 473     } elseif (getenv($var_name)) {
 474         return getenv($var_name);
 475     } elseif (function_exists('apache_getenv')
 476      && apache_getenv($var_name, true)) {
 477         return apache_getenv($var_name, true);
 478     }
 479
 480     return '';
 481 }
 482
 483 /**
 484  * Send HTTP header, taking IIS limits into account (600 seems ok)
 485  *
 486  * @param string   $uri the header to send
 487  * @return  boolean  always true
 488  */
 489 function PMA_sendHeaderLocation($uri)
 490 {
 491     if (PMA_IS_IIS && strlen($uri) > 600) {
 492         require_once './libraries/js_escape.lib.php';
 493
 494         echo '<html><head><title>- - -</title>' . "\n";
 495         echo '<meta http-equiv="expires" content="0">' . "\n";
 496         echo '<meta http-equiv="Pragma" content="no-cache">' . "\n";
 497         echo '<meta http-equiv="Cache-Control" content="no-cache">' . "\n";
 498         echo '<meta http-equiv="Refresh" content="0;url=' .  htmlspecialchars($uri) . '">' . "\n";
 499         echo '<script type="text/javascript">' . "\n";
 500         echo '//<![CDATA[' . "\n";
 501         echo 'setTimeout("window.location = unescape(\'"' . PMA_escapeJsString($uri) . '"\')", 2000);' . "\n";
 502         echo '//]]>' . "\n";
 503         echo '</script>' . "\n";
 504         echo '</head>' . "\n";
 505         echo '<body>' . "\n";
 506         echo '<script type="text/javascript">' . "\n";
 507         echo '//<![CDATA[' . "\n";
 508         echo 'document.write(\'<p><a href="' . htmlspecialchars($uri) . '">' . __('Go') . '</a></p>\');' . "\n";
 509         echo '//]]>' . "\n";
 510         echo '</script></body></html>' . "\n";
 511
 512     } else {
 513         if (SID) {
 514             if (strpos($uri, '?') === false) {
 515                 header('Location: ' . $uri . '?' . SID);
 516             } else {
 517                 $separator = PMA_get_arg_separator();
 518                 header('Location: ' . $uri . $separator . SID);
 519             }
 520         } else {
 521             session_write_close();
 522             if (headers_sent()) {
 523                 if (function_exists('debug_print_backtrace')) {
 524                     echo '<pre>';
 525                     debug_print_backtrace();
 526                     echo '</pre>';
 527                 }
 528                 trigger_error('PMA_sendHeaderLocation called when headers are already sent!', E_USER_ERROR);
 529             }
 530             // bug #1523784: IE6 does not like 'Refresh: 0', it
 531             // results in a blank page
 532             // but we need it when coming from the cookie login panel)
 533             if (PMA_IS_IIS && defined('PMA_COMING_FROM_COOKIE_LOGIN')) {
 534                 header('Refresh: 0; ' . $uri);
 535             } else {
 536                 header('Location: ' . $uri);
 537             }
 538         }
 539     }
 540 }
 541
 542 /**
 543  * Outputs headers to prevent caching in browser (and on the way).
 544  *
 545  * @return nothing
 546  */
 547 function PMA_no_cache_header()
 548 {
 549     header('Expires: ' . date(DATE_RFC1123)); // rfc2616 - Section 14.21
 550     header('Cache-Control: no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0'); // HTTP/1.1
 551     if (PMA_USR_BROWSER_AGENT == 'IE') {
 552         /* FIXME: Why is this speecial case for IE needed? */
 553         header('Pragma: public');
 554     } else {
 555         header('Pragma: no-cache'); // HTTP/1.0
 556         // test case: exporting a database into a .gz file with Safari
 557         // would produce files not having the current time
 558         // (added this header for Safari but should not harm other browsers)
 559         header('Last-Modified: ' . date(DATE_RFC1123));
 560     }
 561 }
 562
 563
 564 /**
 565  * Sends header indicating file download.
 566  *
 567  * @param string $filename Filename to include in headers.
 568  * @param string $mimetype MIME type to include in headers.
 569  * @param int    $length   Length of content (optional)
 570  * @param bool   $no_cache Whether to include no-caching headers.
 571  *
 572  * @return nothing
 573  */
 574 function PMA_download_header($filename, $mimetype, $length = 0, $no_cache = true)
 575 {
 576     if ($no_cache) {
 577         PMA_no_cache_header();
 578     }
 579     /* Replace all possibly dangerous chars in filename */
 580     $filename = str_replace(array(';', '"', "\n", "\r"), '-', $filename);
 581     header('Content-Description: File Transfer');
 582     header('Content-Disposition: attachment; filename="' . $filename . '"');
 583     header('Content-Type: ' . $mimetype);
 584     header('Content-Transfer-Encoding: binary');
 585     if ($length > 0) {
 586         header('Content-Length: ' . $length);
 587     }
 588 }
 589
 590
 591 /**
 592  * Returns value of an element in $array given by $path.
 593  * $path is a string describing position of an element in an associative array,
 594  * eg. Servers/1/host refers to $array[Servers][1][host]
 595  *
 596  * @param string   $path
 597  * @param array    $array
 598  * @param mixed    $default
 599  * @return mixed    array element or $default
 600  */
 601 function PMA_array_read($path, $array, $default = null)
 602 {
 603     $keys = explode('/', $path);
 604     $value =& $array;
 605     foreach ($keys as $key) {
 606         if (! isset($value[$key])) {
 607             return $default;
 608         }
 609         $value =& $value[$key];
 610     }
 611     return $value;
 612 }
 613
 614 /**
 615  * Stores value in an array
 616  *
 617  * @param string   $path
 618  * @param array    &$array
 619  * @param mixed    $value
 620  */
 621 function PMA_array_write($path, &$array, $value)
 622 {
 623     $keys = explode('/', $path);
 624     $last_key = array_pop($keys);
 625     $a =& $array;
 626     foreach ($keys as $key) {
 627         if (! isset($a[$key])) {
 628             $a[$key] = array();
 629         }
 630         $a =& $a[$key];
 631     }
 632     $a[$last_key] = $value;
 633 }
 634
 635 /**
 636  * Removes value from an array
 637  *
 638  * @param string   $path
 639  * @param array    &$array
 640  * @param mixed    $value
 641  */
 642 function PMA_array_remove($path, &$array)
 643 {
 644     $keys = explode('/', $path);
 645     $keys_last = array_pop($keys);
 646     $path = array();
 647     $depth = 0;
 648
 649     $path[0] =& $array;
 650     $found = true;
 651     // go as deep as required or possible
 652     foreach ($keys as $key) {
 653         if (! isset($path[$depth][$key])) {
 654             $found = false;
 655             break;
 656         }
 657         $depth++;
 658         $path[$depth] =& $path[$depth-1][$key];
 659     }
 660     // if element found, remove it
 661     if ($found) {
 662         unset($path[$depth][$keys_last]);
 663         $depth--;
 664     }
 665
 666     // remove empty nested arrays
 667     for (; $depth >= 0; $depth--) {
 668         if (! isset($path[$depth+1]) || count($path[$depth+1]) == 0) {
 669             unset($path[$depth][$keys[$depth]]);
 670         } else {
 671             break;
 672         }
 673     }
 674 }
 675
 676 /**
 677  * Returns link to (possibly) external site using defined redirector.
 678  *
 679  * @param string $url  URL where to go.
 680  *
 681  * @return string URL for a link.
 682  */
 683 function PMA_linkURL($url)
 684 {
 685     if (!preg_match('#^https?://#', $url) || defined('PMA_SETUP')) {
 686         return $url;
 687     } else {
 688         $params = array();
 689         $params['url'] = $url;
 690         return './url.php' . PMA_generate_common_url($params);
 691     }
 692 }
 693
 694 /**
 695  * Returns HTML code to include javascript file.
 696  *
 697  * @param string $url Location of javascript, relative to js/ folder.
 698  *
 699  * @return string HTML code for javascript inclusion.
 700  */
 701 function PMA_includeJS($url)
 702 {
 703     if (strpos($url, '?') === false) {
 704         return '<script src="./js/' . $url . '?ts=' . filemtime('./js/' . $url) . '" type="text/javascript"></script>' . "\n";
 705     } else {
 706         return '<script src="./js/' . $url . '" type="text/javascript"></script>' . "\n";
 707     }
 708 }
 709
 710 /**
 711  * Adds JS code snippets to be displayed by header.inc.php. Adds a newline to each snippet.
 712  *
 713  * @param string $str Js code to be added (e.g. "token=1234;")
 714  *
 715  */
 716 function PMA_AddJSCode($str) {
 717     $GLOBALS['js_script'][] = $str;
 718 }
 719
 720 ?>