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  * @uses    PMA_isValid()
  33  * @see     PMA_isValid()
  34  * @param   mixed   $var        param to check
  35  * @param   mixed   $default    default value
  36  * @param   mixed   $type       var type or array of values to check against $var
  37  * @return  mixed   $var or $default
  38  */
  39 function PMA_ifSetOr(&$var, $default = null, $type = 'similar')
  40 {
  41     if (! PMA_isValid($var, $type, $default)) {
  42         return $default;
  43     }
  44
  45     return $var;
  46 }
  47
  48 /**
  49  * checks given $var against $type or $compare
  50  *
  51  * $type can be:
  52  * - false       : no type checking
  53  * - 'scalar'    : whether type of $var is integer, float, string or boolean
  54  * - 'numeric'   : whether type of $var is any number repesentation
  55  * - 'length'    : whether type of $var is scalar with a string length > 0
  56  * - 'similar'   : whether type of $var is similar to type of $compare
  57  * - 'equal'     : whether type of $var is identical to type of $compare
  58  * - 'identical' : whether $var is identical to $compare, not only the type!
  59  * - or any other valid PHP variable type
  60  *
  61  * <code>
  62  * // $_REQUEST['doit'] = true;
  63  * PMA_isValid($_REQUEST['doit'], 'identical', 'true'); // false
  64  * // $_REQUEST['doit'] = 'true';
  65  * PMA_isValid($_REQUEST['doit'], 'identical', 'true'); // true
  66  * </code>
  67  *
  68  * NOTE: call-by-reference is used to not get NOTICE on undefined vars,
  69  * but the var is not altered inside this function, also after checking a var
  70  * this var exists nut is not set, example:
  71  * <code>
  72  * // $var is not set
  73  * isset($var); // false
  74  * functionCallByReference($var); // false
  75  * isset($var); // true
  76  * functionCallByReference($var); // true
  77  * </code>
  78  *
  79  * to avoid this we set this var to null if not isset
  80  *
  81  * @todo create some testsuites
  82  * @todo add some more var types like hex, bin, ...?
  83  * @uses    is_scalar()
  84  * @uses    is_numeric()
  85  * @uses    is_array()
  86  * @uses    in_array()
  87  * @uses    gettype()
  88  * @uses    strtolower()
  89  * @see     http://php.net/gettype
  90  * @param   mixed   $var        variable to check
  91  * @param   mixed   $type       var type or array of valid values to check against $var
  92  * @param   mixed   $compare    var to compare with $var
  93  * @return  boolean whether valid or not
  94  */
  95 function PMA_isValid(&$var, $type = 'length', $compare = null)
  96 {
  97     if (! isset($var)) {
  98         // var is not even set
  99         return false;
 100     }
 101
 102     if ($type === false) {
 103         // no vartype requested
 104         return true;
 105     }
 106
 107     if (is_array($type)) {
 108         return in_array($var, $type);
 109     }
 110
 111     // allow some aliaes of var types
 112     $type = strtolower($type);
 113     switch ($type) {
 114         case 'identic' :
 115             $type = 'identical';
 116             break;
 117         case 'len' :
 118             $type = 'length';
 119             break;
 120         case 'bool' :
 121             $type = 'boolean';
 122             break;
 123         case 'float' :
 124             $type = 'double';
 125             break;
 126         case 'int' :
 127             $type = 'integer';
 128             break;
 129         case 'null' :
 130             $type = 'NULL';
 131             break;
 132     }
 133
 134     if ($type === 'identical') {
 135         return $var === $compare;
 136     }
 137
 138     // whether we should check against given $compare
 139     if ($type === 'similar') {
 140         switch (gettype($compare)) {
 141             case 'string':
 142             case 'boolean':
 143                 $type = 'scalar';
 144                 break;
 145             case 'integer':
 146             case 'double':
 147                 $type = 'numeric';
 148                 break;
 149             default:
 150                 $type = gettype($compare);
 151         }
 152     } elseif ($type === 'equal') {
 153         $type = gettype($compare);
 154     }
 155
 156     // do the check
 157     if ($type === 'length' || $type === 'scalar') {
 158         $is_scalar = is_scalar($var);
 159         if ($is_scalar && $type === 'length') {
 160             return (bool) strlen($var);
 161         }
 162         return $is_scalar;
 163     }
 164
 165     if ($type === 'numeric') {
 166         return is_numeric($var);
 167     }
 168
 169     if (gettype($var) === $type) {
 170         return true;
 171     }
 172
 173     return false;
 174 }
 175
 176 /**
 177  * Removes insecure parts in a path; used before include() or
 178  * require() when a part of the path comes from an insecure source
 179  * like a cookie or form.
 180  *
 181  * @param    string  The path to check
 182  *
 183  * @return   string  The secured path
 184  *
 185  * @access  public
 186  */
 187 function PMA_securePath($path)
 188 {
 189     // change .. to .
 190     $path = preg_replace('@\.\.*@', '.', $path);
 191
 192     return $path;
 193 } // end function
 194
 195 /**
 196  * displays the given error message on phpMyAdmin error page in foreign language,
 197  * ends script execution and closes session
 198  *
 199  * loads language file if not loaded already
 200  *
 201  * @todo    use detected argument separator (PMA_Config)
 202  * @uses    $GLOBALS['session_name']
 203  * @uses    $GLOBALS['text_dir']
 204  * @uses    $GLOBALS['available_languages']
 205  * @uses    $GLOBALS['lang']
 206  * @uses    $GLOBALS['PMA_Config']->removeCookie()
 207  * @uses    select_lang.lib.php
 208  * @uses    $_COOKIE
 209  * @uses    substr()
 210  * @uses    header()
 211  * @uses    http_build_query()
 212  * @uses    is_string()
 213  * @uses    sprintf()
 214  * @uses    vsprintf()
 215  * @uses    strtr()
 216  * @uses    defined()
 217  * @param   string $error_message the error message or named error message
 218  * @param   string|array $message_args arguments applied to $error_message
 219  * @return  exit
 220  */
 221 function PMA_fatalError($error_message, $message_args = null)
 222 {
 223     /* Use format string if applicable */
 224     if (is_string($message_args)) {
 225         $error_message = sprintf($error_message, $message_args);
 226     } elseif (is_array($message_args)) {
 227         $error_message = vsprintf($error_message, $message_args);
 228     }
 229     $error_message = strtr($error_message, array('<br />' => '[br]'));
 230
 231     // Displays the error message
 232     // (do not use &amp; for parameters sent by header)
 233     $query_params = array(
 234         'lang'  => $GLOBALS['available_languages'][$GLOBALS['lang']][1],
 235         'dir'   => $GLOBALS['text_dir'],
 236         'type'  => __('Error'),
 237         'error' => $error_message,
 238     );
 239     header('Location: ' . (defined('PMA_SETUP') ? '../' : '') . 'error.php?'
 240             . http_build_query($query_params, null, '&'));
 241
 242     // on fatal errors it cannot hurt to always delete the current session
 243     if (isset($GLOBALS['session_name']) && isset($_COOKIE[$GLOBALS['session_name']])) {
 244         $GLOBALS['PMA_Config']->removeCookie($GLOBALS['session_name']);
 245     }
 246
 247     exit;
 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     $message = sprintf(__('The %s extension is missing. Please check your PHP configuration.'),
 260         sprintf('[a@http://php.net/%1$s@Documentation][em]%1$s[/em][/a]', $extension));
 261     if ($extra != '') {
 262         $message .= ' ' . $extra;
 263     }
 264     if ($fatal) {
 265         PMA_fatalError($message);
 266     } else {
 267         trigger_error($message, E_USER_WARNING);
 268     }
 269 }
 270
 271 /**
 272  * returns count of tables in given db
 273  *
 274  * @uses    PMA_DBI_try_query()
 275  * @uses    PMA_backquote()
 276  * @uses    PMA_DBI_QUERY_STORE()
 277  * @uses    PMA_DBI_num_rows()
 278  * @uses    PMA_DBI_free_result()
 279  * @param   string  $db database to count tables for
 280  * @return  integer count of tables in $db
 281  */
 282 function PMA_getTableCount($db)
 283 {
 284     $tables = PMA_DBI_try_query(
 285         'SHOW TABLES FROM ' . PMA_backquote($db) . ';',
 286         null, PMA_DBI_QUERY_STORE);
 287     if ($tables) {
 288         $num_tables = PMA_DBI_num_rows($tables);
 289
 290         // do not count hidden blobstreaming tables
 291         while ((($num_tables > 0)) && $data = PMA_DBI_fetch_assoc($tables)) {
 292             if (PMA_BS_IsHiddenTable($data['Tables_in_' . $db])) {
 293                 $num_tables--;
 294             }
 295         }
 296
 297         PMA_DBI_free_result($tables);
 298     } else {
 299         $num_tables = 0;
 300     }
 301
 302     return $num_tables;
 303 }
 304
 305 /**
 306  * Converts numbers like 10M into bytes
 307  * Used with permission from Moodle (http://moodle.org) by Martin Dougiamas
 308  * (renamed with PMA prefix to avoid double definition when embedded
 309  * in Moodle)
 310  *
 311  * @uses    each()
 312  * @uses    strlen()
 313  * @uses    substr()
 314  * @param   string  $size
 315  * @return  integer $size
 316  */
 317 function PMA_get_real_size($size = 0)
 318 {
 319     if (! $size) {
 320         return 0;
 321     }
 322
 323     $scan['gb'] = 1073741824; //1024 * 1024 * 1024;
 324     $scan['g']  = 1073741824; //1024 * 1024 * 1024;
 325     $scan['mb'] = 1048576;
 326     $scan['m']  = 1048576;
 327     $scan['kb'] =    1024;
 328     $scan['k']  =    1024;
 329     $scan['b']  =       1;
 330
 331     foreach ($scan as $unit => $factor) {
 332         if (strlen($size) > strlen($unit)
 333          && strtolower(substr($size, strlen($size) - strlen($unit))) == $unit) {
 334             return substr($size, 0, strlen($size) - strlen($unit)) * $factor;
 335         }
 336     }
 337
 338     return $size;
 339 } // end function PMA_get_real_size()
 340
 341 /**
 342  * merges array recursive like array_merge_recursive() but keyed-values are
 343  * always overwritten.
 344  *
 345  * array PMA_array_merge_recursive(array $array1[, array $array2[, array ...]])
 346  *
 347  * @see     http://php.net/array_merge
 348  * @see     http://php.net/array_merge_recursive
 349  * @uses    func_num_args()
 350  * @uses    func_get_arg()
 351  * @uses    is_array()
 352  * @uses    call_user_func_array()
 353  * @param   array   array to merge
 354  * @param   array   array to merge
 355  * @param   array   ...
 356  * @return  array   merged array
 357  */
 358 function PMA_array_merge_recursive()
 359 {
 360     switch(func_num_args()) {
 361         case 0 :
 362             return false;
 363             break;
 364         case 1 :
 365             // when does that happen?
 366             return func_get_arg(0);
 367             break;
 368         case 2 :
 369             $args = func_get_args();
 370             if (!is_array($args[0]) || !is_array($args[1])) {
 371                 return $args[1];
 372             }
 373             foreach ($args[1] as $key2 => $value2) {
 374                 if (isset($args[0][$key2]) && !is_int($key2)) {
 375                     $args[0][$key2] = PMA_array_merge_recursive($args[0][$key2],
 376                         $value2);
 377                 } else {
 378                     // we erase the parent array, otherwise we cannot override a directive that
 379                     // contains array elements, like this:
 380                     // (in config.default.php) $cfg['ForeignKeyDropdownOrder'] = array('id-content','content-id');
 381                     // (in config.inc.php) $cfg['ForeignKeyDropdownOrder'] = array('content-id');
 382                     if (is_int($key2) && $key2 == 0) {
 383                         unset($args[0]);
 384                     }
 385                     $args[0][$key2] = $value2;
 386                 }
 387             }
 388             return $args[0];
 389             break;
 390         default :
 391             $args = func_get_args();
 392             $args[1] = PMA_array_merge_recursive($args[0], $args[1]);
 393             array_shift($args);
 394             return call_user_func_array('PMA_array_merge_recursive', $args);
 395             break;
 396     }
 397 }
 398
 399 /**
 400  * calls $function vor every element in $array recursively
 401  *
 402  * this function is protected against deep recursion attack CVE-2006-1549,
 403  * 1000 seems to be more than enough
 404  *
 405  * @see http://www.php-security.org/MOPB/MOPB-02-2007.html
 406  * @see http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2006-1549
 407  *
 408  * @uses    PMA_arrayWalkRecursive()
 409  * @uses    is_array()
 410  * @uses    is_string()
 411  * @param   array   $array      array to walk
 412  * @param   string  $function   function to call for every array element
 413  */
 414 function PMA_arrayWalkRecursive(&$array, $function, $apply_to_keys_also = false)
 415 {
 416     static $recursive_counter = 0;
 417     if (++$recursive_counter > 1000) {
 418         die('possible deep recursion attack');
 419     }
 420     foreach ($array as $key => $value) {
 421         if (is_array($value)) {
 422             PMA_arrayWalkRecursive($array[$key], $function, $apply_to_keys_also);
 423         } else {
 424             $array[$key] = $function($value);
 425         }
 426
 427         if ($apply_to_keys_also && is_string($key)) {
 428             $new_key = $function($key);
 429             if ($new_key != $key) {
 430                 $array[$new_key] = $array[$key];
 431                 unset($array[$key]);
 432             }
 433         }
 434     }
 435     $recursive_counter--;
 436 }
 437
 438 /**
 439  * boolean phpMyAdmin.PMA_checkPageValidity(string &$page, array $whitelist)
 440  *
 441  * checks given given $page against given $whitelist and returns true if valid
 442  * it ignores optionaly query paramters in $page (script.php?ignored)
 443  *
 444  * @uses    in_array()
 445  * @uses    urldecode()
 446  * @uses    substr()
 447  * @uses    strpos()
 448  * @param   string  &$page      page to check
 449  * @param   array   $whitelist  whitelist to check page against
 450  * @return  boolean whether $page is valid or not (in $whitelist or not)
 451  */
 452 function PMA_checkPageValidity(&$page, $whitelist)
 453 {
 454     if (! isset($page) || !is_string($page)) {
 455         return false;
 456     }
 457
 458     if (in_array($page, $whitelist)) {
 459         return true;
 460     } elseif (in_array(substr($page, 0, strpos($page . '?', '?')), $whitelist)) {
 461         return true;
 462     } else {
 463         $_page = urldecode($page);
 464         if (in_array(substr($_page, 0, strpos($_page . '?', '?')), $whitelist)) {
 465             return true;
 466         }
 467     }
 468     return false;
 469 }
 470
 471 /**
 472  * trys to find the value for the given environment vriable name
 473  *
 474  * searchs in $_SERVER, $_ENV than trys getenv() and apache_getenv()
 475  * in this order
 476  *
 477  * @uses    $_SERVER
 478  * @uses    $_ENV
 479  * @uses    getenv()
 480  * @uses    function_exists()
 481  * @uses    apache_getenv()
 482  * @param   string  $var_name   variable name
 483  * @return  string  value of $var or empty string
 484  */
 485 function PMA_getenv($var_name) {
 486     if (isset($_SERVER[$var_name])) {
 487         return $_SERVER[$var_name];
 488     } elseif (isset($_ENV[$var_name])) {
 489         return $_ENV[$var_name];
 490     } elseif (getenv($var_name)) {
 491         return getenv($var_name);
 492     } elseif (function_exists('apache_getenv')
 493      && apache_getenv($var_name, true)) {
 494         return apache_getenv($var_name, true);
 495     }
 496
 497     return '';
 498 }
 499
 500 /**
 501  * Returns value of an element in $array given by $path.
 502  * $path is a string describing position of an element in an associative array,
 503  * eg. Servers/1/host refers to $array[Servers][1][host]
 504  *
 505  * @param  string   $path
 506  * @param  array    $array
 507  * @param  mixed    $default
 508  * @return mixed    array element or $default
 509  */
 510 function PMA_array_read($path, $array, $default = null)
 511 {
 512     $keys = explode('/', $path);
 513     $value =& $array;
 514     foreach ($keys as $key) {
 515         if (!isset($value[$key])) {
 516             return $default;
 517         }
 518         $value =& $value[$key];
 519     }
 520     return $value;
 521 }
 522
 523 /**
 524  * Stores value in an array
 525  *
 526  * @param  string   $path
 527  * @param  array    &$array
 528  * @param  mixed    $value
 529  */
 530 function PMA_array_write($path, &$array, $value)
 531 {
 532     $keys = explode('/', $path);
 533     $last_key = array_pop($keys);
 534     $a =& $array;
 535     foreach ($keys as $key) {
 536         if (!isset($a[$key])) {
 537             $a[$key] = array();
 538         }
 539         $a =& $a[$key];
 540     }
 541     $a[$last_key] = $value;
 542 }
 543
 544 /**
 545  * Removes value from an array
 546  *
 547  * @param  string   $path
 548  * @param  array    &$array
 549  * @param  mixed    $value
 550  */
 551 function PMA_array_remove($path, &$array)
 552 {
 553     $keys = explode('/', $path);
 554     $keys_last = array_pop($keys);
 555     $path = array();
 556     $depth = 0;
 557
 558     $path[0] =& $array;
 559     $found = true;
 560     // go as deep as required or possible
 561     foreach ($keys as $key) {
 562         if (!isset($path[$depth][$key])) {
 563             $found = false;
 564             break;
 565         }
 566         $depth++;
 567         $path[$depth] =& $path[$depth-1][$key];
 568     }
 569     // if element found, remove it
 570     if ($found) {
 571         unset($path[$depth][$keys_last]);
 572         $depth--;
 573     }
 574
 575     // remove empty nested arrays
 576     for (; $depth >= 0; $depth--) {
 577         if (!isset($path[$depth+1]) || count($path[$depth+1]) == 0) {
 578             unset($path[$depth][$keys[$depth]]);
 579         } else {
 580             break;
 581         }
 582     }
 583 }
 584 ?>