functions/global.php

   1 <?php
   2
   3 /**
   4  * global.php
   5  *
   6  * This includes code to update < 4.1.0 globals to the newer format
   7  * It also has some session register functions that work across various
   8  * php versions.
   9  *
  10  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
  11  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  12  * @version $Id$
  13  * @package squirrelmail
  14  */
  15
  16 /**
  17  */
  18 define('SQ_INORDER',0);
  19 define('SQ_GET',1);
  20 define('SQ_POST',2);
  21 define('SQ_SESSION',3);
  22 define('SQ_COOKIE',4);
  23 define('SQ_SERVER',5);
  24 define('SQ_FORM',6);
  25
  26
  27 /**
  28  * returns true if current php version is at mimimum a.b.c
  29  *
  30  * Called: check_php_version(4,1)
  31  * @param int a major version number
  32  * @param int b minor version number
  33  * @param int c release number
  34  * @return bool
  35  */
  36 function check_php_version ($a = '0', $b = '0', $c = '0')
  37 {
  38     return version_compare ( PHP_VERSION, "$a.$b.$c", 'ge' );
  39 }
  40
  41 /**
  42  * returns true if the current internal SM version is at minimum a.b.c
  43  * These are plain integer comparisons, as our internal version is
  44  * constructed by us, as an array of 3 ints.
  45  *
  46  * Called: check_sm_version(1,3,3)
  47  * @param int a major version number
  48  * @param int b minor version number
  49  * @param int c release number
  50  * @return bool
  51  */
  52 function check_sm_version($a = 0, $b = 0, $c = 0)
  53 {
  54     global $SQM_INTERNAL_VERSION;
  55     if ( !isset($SQM_INTERNAL_VERSION) ||
  56          $SQM_INTERNAL_VERSION[0] < $a ||
  57          ( $SQM_INTERNAL_VERSION[0] == $a &&
  58            $SQM_INTERNAL_VERSION[1] < $b) ||
  59          ( $SQM_INTERNAL_VERSION[0] == $a &&
  60            $SQM_INTERNAL_VERSION[1] == $b &&
  61            $SQM_INTERNAL_VERSION[2] < $c ) ) {
  62         return FALSE;
  63     }
  64     return TRUE;
  65 }
  66
  67
  68 /**
  69  * Recursively strip slashes from the values of an array.
  70  * @param array array the array to strip, passed by reference
  71  * @return void
  72  */
  73 function sqstripslashes(&$array) {
  74     if(count($array) > 0) {
  75         foreach ($array as $index=>$value) {
  76             if (is_array($array[$index])) {
  77                 sqstripslashes($array[$index]);
  78             }
  79             else {
  80                 $array[$index] = stripslashes($value);
  81             }
  82         }
  83     }
  84 }
  85
  86 /**
  87  * Add a variable to the session.
  88  * @param mixed $var the variable to register
  89  * @param string $name the name to refer to this variable
  90  * @return void
  91  */
  92 function sqsession_register ($var, $name) {
  93
  94     sqsession_is_active();
  95
  96     $_SESSION["$name"] = $var;
  97
  98     session_register("$name");
  99 }
 100
 101 /**
 102  * Delete a variable from the session.
 103  * @param string $name the name of the var to delete
 104  * @return void
 105  */
 106 function sqsession_unregister ($name) {
 107
 108     sqsession_is_active();
 109
 110     unset($_SESSION[$name]);
 111
 112     session_unregister("$name");
 113 }
 114
 115 /**
 116  * Checks to see if a variable has already been registered
 117  * in the session.
 118  * @param string $name the name of the var to check
 119  * @return bool whether the var has been registered
 120  */
 121 function sqsession_is_registered ($name) {
 122     $test_name = &$name;
 123     $result = false;
 124
 125     if (isset($_SESSION[$test_name])) {
 126         $result = true;
 127     }
 128
 129     return $result;
 130 }
 131
 132
 133 /**
 134   * Retrieves a form variable, from a set of possible similarly named
 135   * form variables, based on finding a different, single field.  This
 136   * is intended to allow more than one same-named inputs in a single
 137   * <form>, where the submit button that is clicked tells us which
 138   * input we should retrieve.  An example is if we have:
 139   *     <select name="startMessage_1">
 140   *     <select name="startMessage_2">
 141   *     <input type="submit" name="form_submit_1">
 142   *     <input type="submit" name="form_submit_2">
 143   * and we want to know which one of the select inputs should be
 144   * returned as $startMessage (without the suffix!), this function
 145   * decides by looking for either "form_submit_1" or "form_submit_2"
 146   * (both should not appear).  In this example, $name should be
 147   * "startMessage" and $indicator_field should be "form_submit".
 148   *
 149   * NOTE that form widgets must be named with the suffix "_1", "_2", "_3"
 150   *      and so on, or this function will not work.
 151   *
 152   * If more than one of the indicator fields is found, the first one
 153   * (numerically) will win.
 154   *
 155   * If an indicator field is found without a matching input ($name)
 156   * field, FALSE is returned.
 157   *
 158   * If no indicator fields are found, a field of $name *without* any
 159   * suffix is searched for (but only if $fallback_no_suffix is TRUE),
 160   * and if not found, FALSE is ultimately returned.
 161   *
 162   * It should also be possible to use the same string for both
 163   * $name and $indicator_field to look for the first possible
 164   * widget with a suffix that can be found (and possibly fallback
 165   * to a widget without a suffix).
 166   *
 167   * @param string name the name of the var to search
 168   * @param mixed value the variable to return
 169   * @param string indicator_field the name of the field upon which to base
 170   *                               our decision upon (see above)
 171   * @param int search constant defining where to look
 172   * @param bool fallback_no_suffix whether or not to look for $name with
 173   *                                no suffix when nothing else is found
 174   * @param mixed default the value to assign to $value when nothing is found
 175   * @param int typecast force variable to be cast to given type (please
 176   *                     use SQ_TYPE_XXX constants or set to FALSE (default)
 177   *                     to leave variable type unmolested)
 178   *
 179   * @return bool whether variable is found.
 180   */
 181 function sqGetGlobalVarMultiple($name, &$value, $indicator_field,
 182                                 $search = SQ_INORDER,
 183                                 $fallback_no_suffix=TRUE, $default=NULL,
 184                                 $typecast=FALSE) {
 185
 186     // Set arbitrary max limit -- should be much lower except on the
 187     // search results page, if there are many (50 or more?) mailboxes
 188     // shown, this may not be high enough.  Is there some way we should
 189     // automate this value?
 190     //
 191     $max_form_search = 100;
 192
 193     for ($i = 1; $i <= $max_form_search; $i++) {
 194         if (sqGetGlobalVar($indicator_field . '_' . $i, $temp, $search)) {
 195             return sqGetGlobalVar($name . '_' . $i, $value, $search, $default, $typecast);
 196         }
 197     }
 198
 199
 200     // no indicator field found; just try without suffix if allowed
 201     //
 202     if ($fallback_no_suffix) {
 203         return sqGetGlobalVar($name, $value, $search, $default, $typecast);
 204     }
 205
 206
 207     // no dice, set default and return FALSE
 208     //
 209     if (!is_null($default)) {
 210         $value = $default;
 211     }
 212     return FALSE;
 213
 214 }
 215
 216
 217 /**
 218  * Search for the var $name in $_SESSION, $_POST, $_GET, $_COOKIE, or $_SERVER
 219  * and set it in provided var.
 220  *
 221  * If $search is not provided, or if it is SQ_INORDER, it will search $_SESSION,
 222  * then $_POST, then $_GET. If $search is SQ_FORM it will search $_POST and
 223  * $_GET.  Otherwise, use one of the defined constants to look for a var in one
 224  * place specifically.
 225  *
 226  * Note: $search is an int value equal to one of the constants defined above.
 227  *
 228  * Example:
 229  * sqgetGlobalVar('username',$username,SQ_SESSION);
 230  * // No quotes around last param, it's a constant - not a string!
 231  *
 232  * @param string name the name of the var to search
 233  * @param mixed value the variable to return
 234  * @param int search constant defining where to look
 235  * @param mixed default the value to assign to $value when nothing is found
 236  * @param int typecast force variable to be cast to given type (please
 237  *                     use SQ_TYPE_XXX constants or set to FALSE (default)
 238  *                     to leave variable type unmolested)
 239  *
 240  * @return bool whether variable is found.
 241  */
 242 function sqgetGlobalVar($name, &$value, $search = SQ_INORDER, $default = NULL, $typecast = false) {
 243
 244     $result = false;
 245
 246     switch ($search) {
 247         /* we want the default case to be first here,
 248            so that if a valid value isn't specified,
 249            all three arrays will be searched. */
 250       default:
 251       case SQ_INORDER: // check session, post, get
 252       case SQ_SESSION:
 253         if( isset($_SESSION[$name]) ) {
 254             $value = $_SESSION[$name];
 255             $result = TRUE;
 256             break;
 257         } elseif ( $search == SQ_SESSION ) {
 258             break;
 259         }
 260       case SQ_FORM:   // check post, get
 261       case SQ_POST:
 262         if( isset($_POST[$name]) ) {
 263             $value = $_POST[$name];
 264             $result = TRUE;
 265             break;
 266         } elseif ( $search == SQ_POST ) {
 267           break;
 268         }
 269       case SQ_GET:
 270         if ( isset($_GET[$name]) ) {
 271             $value = $_GET[$name];
 272             $result = TRUE;
 273             break;
 274         }
 275         /* NO IF HERE. FOR SQ_INORDER CASE, EXIT after GET */
 276         break;
 277       case SQ_COOKIE:
 278         if ( isset($_COOKIE[$name]) ) {
 279             $value = $_COOKIE[$name];
 280             $result = TRUE;
 281             break;
 282         }
 283         break;
 284       case SQ_SERVER:
 285         if ( isset($_SERVER[$name]) ) {
 286             $value = $_SERVER[$name];
 287             $result = TRUE;
 288             break;
 289         }
 290         break;
 291     }
 292     if ($result && $typecast) {
 293         switch ($typecast) {
 294             case SQ_TYPE_INT: $value = (int) $value; break;
 295             case SQ_TYPE_STRING: $value = (string) $value; break;
 296             case SQ_TYPE_BOOL: $value = (bool) $value; break;
 297             default: break;
 298         }
 299     } else if (!$result && !is_null($default)) {
 300         $value = $default;
 301     }
 302     return $result;
 303 }
 304
 305 /**
 306  * Deletes an existing session, more advanced than the standard PHP
 307  * session_destroy(), it explicitly deletes the cookies and global vars.
 308  *
 309  * WARNING: Older PHP versions have some issues with session management.
 310  * See http://bugs.php.net/11643 (warning, spammed bug tracker) and
 311  * http://bugs.php.net/13834. SID constant is not destroyed in PHP 4.1.2,
 312  * 4.2.3 and maybe other versions. If you restart session after session
 313  * is destroyed, affected PHP versions produce PHP notice. Bug should
 314  * be fixed only in 4.3.0
 315  */
 316 function sqsession_destroy() {
 317
 318     /*
 319      * php.net says we can kill the cookie by setting just the name:
 320      * http://www.php.net/manual/en/function.setcookie.php
 321      * maybe this will help fix the session merging again.
 322      *
 323      * Changed the theory on this to kill the cookies first starting
 324      * a new session will provide a new session for all instances of
 325      * the browser, we don't want that, as that is what is causing the
 326      * merging of sessions.
 327      */
 328
 329     global $base_uri;
 330
 331     if (isset($_COOKIE[session_name()]) && session_name()) sqsetcookie(session_name(), '', 0, $base_uri);
 332     if (isset($_COOKIE['username']) && $_COOKIE['username']) sqsetcookie('username','',0,$base_uri);
 333     if (isset($_COOKIE['key']) && $_COOKIE['key']) sqsetcookie('key','',0,$base_uri);
 334
 335     $sessid = session_id();
 336     if (!empty( $sessid )) {
 337         $_SESSION = array();
 338         @session_destroy();
 339     }
 340 }
 341
 342 /**
 343  * Function to verify a session has been started.  If it hasn't
 344  * start a session up.  php.net doesn't tell you that $_SESSION
 345  * (even though autoglobal), is not created unless a session is
 346  * started, unlike $_POST, $_GET and such
 347  */
 348 function sqsession_is_active() {
 349     $sessid = session_id();
 350     if ( empty( $sessid ) ) {
 351         sqsession_start();
 352     }
 353 }
 354
 355 /**
 356  * Function to start the session and store the cookie with the session_id as
 357  * HttpOnly cookie which means that the cookie isn't accessible by javascript
 358  * (IE6 only)
 359  */
 360 function sqsession_start() {
 361     global $base_uri;
 362
 363     session_start();
 364     $session_id = session_id();
 365
 366     // session_starts sets the sessionid cookie buth without the httponly var
 367     // setting the cookie again sets the httponly cookie attribute
 368
 369     sqsetcookie(session_name(),session_id(),false,$base_uri);
 370 }
 371
 372
 373 /**
 374  * Set a cookie
 375  * @param string  $sName     The name of the cookie.
 376  * @param string  $sValue    The value of the cookie.
 377  * @param int     $iExpire   The time the cookie expires. This is a Unix timestamp so is in number of seconds since the epoch.
 378  * @param string  $sPath     The path on the server in which the cookie will be available on.
 379  * @param string  $sDomain   The domain that the cookie is available.
 380  * @param boolean $bSecure   Indicates that the cookie should only be transmitted over a secure HTTPS connection.
 381  * @param boolean $bHttpOnly Disallow JS to access the cookie (IE6 only)
 382  * @return void
 383  */
 384 function sqsetcookie($sName,$sValue="",$iExpire=0,$sPath="",$sDomain="",$bSecure=false,$bHttpOnly=true) {
 385     // if we have a secure connection then limit the cookies to https only.
 386     if ($sName && isset($_SERVER['HTTPS']) && $_SERVER['HTTPS']) {
 387         $bSecure = true;
 388     }
 389     if (false && check_php_version(5,2)) {
 390        // php 5 supports the httponly attribute in setcookie, but because setcookie seems a bit
 391        // broken we use the header function for php 5.2 as well. We might change that later.
 392        //setcookie($sName,$sValue,(int) $iExpire,$sPath,$sDomain,$bSecure,$bHttpOnly);
 393     } else {
 394         if (!empty($Domain)) {
 395             // Fix the domain to accept domains with and without 'www.'.
 396             if (strtolower(substr($Domain, 0, 4)) == 'www.')  $Domain = substr($Domain, 4);
 397             $Domain = '.' . $Domain;
 398
 399             // Remove port information.
 400             $Port = strpos($Domain, ':');
 401             if ($Port !== false)  $Domain = substr($Domain, 0, $Port);
 402         }
 403
 404         header('Set-Cookie: ' . rawurlencode($sName) . '=' . rawurlencode($sValue)
 405                             . (empty($iExpires) ? '' : '; expires=' . gmdate('D, d-M-Y H:i:s', $iExpires) . ' GMT')
 406                             . (empty($sPath) ? '' : '; path=' . $sPath)
 407                             . (empty($sDomain) ? '' : '; domain=' . $sDomain)
 408                             . (!$bSecure ? '' : '; secure')
 409                             . (!$bHttpOnly ? '' : '; HttpOnly'), false);
 410     }
 411 }
 412
 413 /**
 414  * session_regenerate_id replacement for PHP < 4.3.2
 415  *
 416  * This code is borrowed from Gallery, session.php version 1.53.2.1
 417  */
 418 if (!function_exists('session_regenerate_id')) {
 419     function make_seed() {
 420         list($usec, $sec) = explode(' ', microtime());
 421         return (float)$sec + ((float)$usec * 100000);
 422     }
 423
 424     function php_combined_lcg() {
 425         mt_srand(make_seed());
 426         $tv = gettimeofday();
 427         $lcg['s1'] = $tv['sec'] ^ (~$tv['usec']);
 428         $lcg['s2'] = mt_rand();
 429         $q = (int) ($lcg['s1'] / 53668);
 430         $lcg['s1'] = (int) (40014 * ($lcg['s1'] - 53668 * $q) - 12211 * $q);
 431         if ($lcg['s1'] < 0) {
 432             $lcg['s1'] += 2147483563;
 433         }
 434         $q = (int) ($lcg['s2'] / 52774);
 435         $lcg['s2'] = (int) (40692 * ($lcg['s2'] - 52774 * $q) - 3791 * $q);
 436         if ($lcg['s2'] < 0) {
 437             $lcg['s2'] += 2147483399;
 438         }
 439         $z = (int) ($lcg['s1'] - $lcg['s2']);
 440         if ($z < 1) {
 441             $z += 2147483562;
 442         }
 443         return $z * 4.656613e-10;
 444     }
 445
 446     function session_regenerate_id() {
 447         global $base_uri;
 448         $tv = gettimeofday();
 449         sqgetGlobalVar('REMOTE_ADDR',$remote_addr,SQ_SERVER);
 450         $buf = sprintf("%.15s%ld%ld%0.8f", $remote_addr, $tv['sec'], $tv['usec'], php_combined_lcg() * 10);
 451         session_id(md5($buf));
 452         if (ini_get('session.use_cookies')) {
 453             // at a later stage we use sqsetcookie. At this point just do
 454             // what session_regenerate_id would do
 455             setcookie(session_name(), session_id(), NULL, $base_uri);
 456         }
 457         return TRUE;
 458     }
 459 }
 460
 461
 462 /**
 463  * php_self
 464  *
 465  * Creates an URL for the page calling this function, using either the PHP global
 466  * REQUEST_URI, or the PHP global PHP_SELF with QUERY_STRING added. Before 1.5.1
 467  * function was stored in function/strings.php.
 468  *
 469  * @return string the complete url for this page
 470  * @since 1.2.3
 471  */
 472 function php_self () {
 473     if ( sqgetGlobalVar('REQUEST_URI', $req_uri, SQ_SERVER) && !empty($req_uri) ) {
 474       return $req_uri;
 475     }
 476
 477     if ( sqgetGlobalVar('PHP_SELF', $php_self, SQ_SERVER) && !empty($php_self) ) {
 478
 479       // need to add query string to end of PHP_SELF to match REQUEST_URI
 480       //
 481       if ( sqgetGlobalVar('QUERY_STRING', $query_string, SQ_SERVER) && !empty($query_string) ) {
 482          $php_self .= '?' . $query_string;
 483       }
 484
 485       return $php_self;
 486     }
 487
 488     return '';
 489 }
 490
 491
 492 /**
 493   * Find files and/or directories in a given directory optionally
 494   * limited to only those with the given file extension.  If the
 495   * directory is not found or cannot be opened, no error is generated;
 496   * only an empty file list is returned.
 497 FIXME: do we WANT to throw an error or a notice or... or return FALSE?
 498   *
 499   * @param string $directory_path         The path (relative or absolute)
 500   *                                       to the desired directory.
 501   * @param string $extension              The file extension filter (optional;
 502   *                                       default is to return all files (dirs).
 503   * @param boolean $return_filenames_only When TRUE, only file/dir names
 504   *                                       are returned, otherwise the
 505   *                                       $directory_path string is
 506   *                                       prepended to each file/dir in
 507   *                                       the returned list (optional;
 508   *                                       default is filename/dirname only)
 509   * @param boolean $include_directories   When TRUE, directories are
 510   *                                       included (optional; default
 511   *                                       DO include directories).
 512   * @param boolean $directories_only      When TRUE, ONLY directories
 513   *                                       are included (optional; default
 514   *                                       is to include files too).
 515   * @param boolean $separate_files_and_directories When TRUE, files and
 516   *                                                directories are returned
 517   *                                                in separate lists, so
 518   *                                                the return value is
 519   *                                                formatted as a two-element
 520   *                                                array with the two keys
 521   *                                                "FILES" and "DIRECTORIES",
 522   *                                                where corresponding values
 523   *                                                are lists of either all
 524   *                                                files or all directories
 525   *                                                (optional; default do not
 526   *                                                split up return array).
 527   *
 528   *
 529   * @return array The requested file/directory list(s).
 530   *
 531   * @since 1.5.2
 532   *
 533   */
 534 function list_files($directory_path, $extension='', $return_filenames_only=TRUE,
 535                     $include_directories=TRUE, $directories_only=FALSE,
 536                     $separate_files_and_directories=FALSE) {
 537
 538     $files = array();
 539     $directories = array();
 540
 541 //FIXME: do we want to place security restrictions here like only allowing
 542 //       directories under SM_PATH?
 543     // validate given directory
 544     //
 545     if (empty($directory_path)
 546      || !is_dir($directory_path)
 547      || !($DIR = opendir($directory_path))) {
 548         return $files;
 549     }
 550
 551
 552     if (!empty($extension)) $extension = '.' . trim($extension, '.');
 553     $directory_path = rtrim($directory_path, '/');
 554
 555
 556     // parse through the files
 557     //
 558     while (($file = readdir($DIR)) !== false) {
 559
 560         if ($file == '.' || $file == '..') continue;
 561
 562         if (!empty($extension)
 563          && strrpos($file, $extension) !== (strlen($file) - strlen($extension)))
 564             continue;
 565
 566         // only use is_dir() if we really need to (be as efficient as possible)
 567         //
 568         $is_dir = FALSE;
 569         if (!$include_directories || $directories_only
 570                                   || $separate_files_and_directories) {
 571             if (is_dir($directory_path . '/' . $file)) {
 572                 if (!$include_directories) continue;
 573                 $is_dir = TRUE;
 574                 $directories[] = ($return_filenames_only
 575                                ? $file
 576                                : $directory_path . '/' . $file);
 577             }
 578             if ($directories_only) continue;
 579         }
 580
 581         if (!$separate_files_and_directories
 582          || ($separate_files_and_directories && !$is_dir)) {
 583             $files[] = ($return_filenames_only
 584                      ? $file
 585                      : $directory_path . '/' . $file);
 586         }
 587
 588     }
 589     closedir($DIR);
 590
 591
 592     if ($directories_only) return $directories;
 593     if ($separate_files_and_directories) return array('FILES' => $files,
 594                                                       'DIRECTORIES' => $directories);
 595     return $files;
 596
 597 }
 598
 599
 600 /**
 601  * Print variable
 602  *
 603  * sm_print_r($some_variable, [$some_other_variable [, ...]]);
 604  *
 605  * Debugging function - does the same as print_r, but makes sure special
 606  * characters are converted to htmlentities first.  This will allow
 607  * values like <some@email.address> to be displayed.
 608  * The output is wrapped in <<pre>> and <</pre>> tags.
 609  * Since 1.4.2 accepts unlimited number of arguments.
 610  * @since 1.4.1
 611  * @return void
 612  */
 613 function sm_print_r() {
 614     ob_start();  // Buffer output
 615     foreach(func_get_args() as $var) {
 616         print_r($var);
 617         echo "\n";
 618         // php has get_class_methods function that can print class methods
 619         if (is_object($var)) {
 620             // get class methods if $var is object
 621             $aMethods=get_class_methods(get_class($var));
 622             // make sure that $aMethods is array and array is not empty
 623             if (is_array($aMethods) && $aMethods!=array()) {
 624                 echo "Object methods:\n";
 625                 foreach($aMethods as $method) {
 626                     echo '* ' . $method . "\n";
 627                 }
 628             }
 629             echo "\n";
 630         }
 631     }
 632     $buffer = ob_get_contents(); // Grab the print_r output
 633     ob_end_clean();  // Silently discard the output & stop buffering
 634     print '<div align="left"><pre>';
 635     print htmlentities($buffer);
 636     print '</pre></div>';
 637 }
 638
 639