Remove obsolete comments
[squirrelmail.git] / functions / global.php
CommitLineData
61d9ec71 1<?php
2
3/**
0c701a88 4 * global.php
61d9ec71 5 *
62f7daa5 6 * This includes code to update < 4.1.0 globals to the newer format
242342d0 7 * It also has some session register functions that work across various
62f7daa5 8 * php versions.
61d9ec71 9 *
4b5049de 10 * @copyright &copy; 1999-2007 The SquirrelMail Project Team
4b4abf93 11 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
31841a9e 12 * @version $Id$
d6c32258 13 * @package squirrelmail
61d9ec71 14 */
15
051f6245 16/**
2ca4c65a 17 */
7f62aaef 18define('SQ_INORDER',0);
19define('SQ_GET',1);
20define('SQ_POST',2);
21define('SQ_SESSION',3);
22define('SQ_COOKIE',4);
23define('SQ_SERVER',5);
24define('SQ_FORM',6);
a32985a5 25
202bcbcc 26
62f7daa5 27/**
28 * returns true if current php version is at mimimum a.b.c
29 *
97bdc607 30 * Called: check_php_version(4,1)
8b096f0a 31 * @param int a major version number
32 * @param int b minor version number
33 * @param int c release number
34 * @return bool
97bdc607 35 */
62f7daa5 36function check_php_version ($a = '0', $b = '0', $c = '0')
9697c5ab 37{
5673cabe 38 return version_compare ( PHP_VERSION, "$a.$b.$c", 'ge' );
9697c5ab 39}
40
97bdc607 41/**
62f7daa5 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
97bdc607 44 * constructed by us, as an array of 3 ints.
45 *
46 * Called: check_sm_version(1,3,3)
8b096f0a 47 * @param int a major version number
48 * @param int b minor version number
49 * @param int c release number
50 * @return bool
97bdc607 51 */
52function 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 ||
150c28d6 57 ( $SQM_INTERNAL_VERSION[0] == $a &&
58 $SQM_INTERNAL_VERSION[1] < $b) ||
59 ( $SQM_INTERNAL_VERSION[0] == $a &&
60 $SQM_INTERNAL_VERSION[1] == $b &&
97bdc607 61 $SQM_INTERNAL_VERSION[2] < $c ) ) {
62 return FALSE;
62f7daa5 63 }
64 return TRUE;
97bdc607 65}
66
67
8b096f0a 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 */
a32985a5 73function sqstripslashes(&$array) {
3aa17cf9 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 }
a32985a5 82 }
83 }
84}
85
8b096f0a 86/**
8442ecb9 87 * Squelch error output to screen (only) for the given function.
1888b1bf 88 * If the SquirrelMail debug mode SM_DEBUG_MODE_ADVANCED is not
89 * enabled, error output will not go to the log, either.
8442ecb9 90 *
91 * This provides an alternative to the @ error-suppression
92 * operator where errors will not be shown in the interface
93 * but will show up in the server log file (assuming the
94 * administrator has configured PHP logging).
95 *
96 * @since 1.4.12 and 1.5.2
97 *
98 * @param string $function The function to be executed
99 * @param array $args The arguments to be passed to the function
100 * (OPTIONAL; default no arguments)
101 * NOTE: The caller must take extra action if
102 * the function being called is supposed
103 * to use any of the parameters by
104 * reference. In the following example,
105 * $x is passed by reference and $y is
106 * passed by value to the "my_func"
107 * function.
108 * sq_call_function_suppress_errors('my_func', array(&$x, $y));
109 *
110 * @return mixed The return value, if any, of the function being
111 * executed will be returned.
112 *
113 */
114function sq_call_function_suppress_errors($function, $args=NULL) {
1888b1bf 115 global $sm_debug_mode;
116
8442ecb9 117 $display_errors = ini_get('display_errors');
118 ini_set('display_errors', '0');
1888b1bf 119
120 // if advanced debug mode isn't enabled, don't log the error, either
121 //
122 if (!($sm_debug_mode & SM_DEBUG_MODE_ADVANCED))
123 $error_reporting = error_reporting(0);
124
8442ecb9 125 $ret = call_user_func_array($function, $args);
1888b1bf 126
127 if (!($sm_debug_mode & SM_DEBUG_MODE_ADVANCED))
128 error_reporting($error_reporting);
129
8442ecb9 130 ini_set('display_errors', $display_errors);
131 return $ret;
132}
133
134/**
8b096f0a 135 * Add a variable to the session.
136 * @param mixed $var the variable to register
137 * @param string $name the name to refer to this variable
138 * @return void
139 */
61d9ec71 140function sqsession_register ($var, $name) {
281c3d5b 141
142 sqsession_is_active();
143
04ce2477 144 $_SESSION[$name] = $var;
61d9ec71 145}
3aa17cf9 146
8b096f0a 147/**
148 * Delete a variable from the session.
149 * @param string $name the name of the var to delete
150 * @return void
151 */
61d9ec71 152function sqsession_unregister ($name) {
281c3d5b 153
154 sqsession_is_active();
155
abd74f7d 156 unset($_SESSION[$name]);
62f7daa5 157
dcc1cc82 158 session_unregister("$name");
61d9ec71 159}
3aa17cf9 160
8b096f0a 161/**
162 * Checks to see if a variable has already been registered
163 * in the session.
164 * @param string $name the name of the var to check
165 * @return bool whether the var has been registered
166 */
d7c82551 167function sqsession_is_registered ($name) {
168 $test_name = &$name;
169 $result = false;
62f7daa5 170
abd74f7d 171 if (isset($_SESSION[$test_name])) {
172 $result = true;
d7c82551 173 }
62f7daa5 174
d7c82551 175 return $result;
176}
177
54ce41dd 178
179/**
180 * Retrieves a form variable, from a set of possible similarly named
181 * form variables, based on finding a different, single field. This
68a7e1d6 182 * is intended to allow more than one same-named inputs in a single
183 * <form>, where the submit button that is clicked tells us which
54ce41dd 184 * input we should retrieve. An example is if we have:
185 * <select name="startMessage_1">
186 * <select name="startMessage_2">
b116fd78 187 * <input type="submit" name="form_submit_1" />
188 * <input type="submit" name="form_submit_2" />
68a7e1d6 189 * and we want to know which one of the select inputs should be
54ce41dd 190 * returned as $startMessage (without the suffix!), this function
191 * decides by looking for either "form_submit_1" or "form_submit_2"
192 * (both should not appear). In this example, $name should be
193 * "startMessage" and $indicator_field should be "form_submit".
194 *
195 * NOTE that form widgets must be named with the suffix "_1", "_2", "_3"
196 * and so on, or this function will not work.
197 *
198 * If more than one of the indicator fields is found, the first one
199 * (numerically) will win.
200 *
68a7e1d6 201 * If an indicator field is found without a matching input ($name)
139a4b99 202 * field, FALSE is returned.
203 *
68a7e1d6 204 * If no indicator fields are found, a field of $name *without* any
205 * suffix is searched for (but only if $fallback_no_suffix is TRUE),
139a4b99 206 * and if not found, FALSE is ultimately returned.
54ce41dd 207 *
208 * It should also be possible to use the same string for both
209 * $name and $indicator_field to look for the first possible
210 * widget with a suffix that can be found (and possibly fallback
211 * to a widget without a suffix).
212 *
213 * @param string name the name of the var to search
214 * @param mixed value the variable to return
215 * @param string indicator_field the name of the field upon which to base
216 * our decision upon (see above)
217 * @param int search constant defining where to look
218 * @param bool fallback_no_suffix whether or not to look for $name with
219 * no suffix when nothing else is found
220 * @param mixed default the value to assign to $value when nothing is found
221 * @param int typecast force variable to be cast to given type (please
222 * use SQ_TYPE_XXX constants or set to FALSE (default)
223 * to leave variable type unmolested)
224 *
225 * @return bool whether variable is found.
226 */
68a7e1d6 227function sqGetGlobalVarMultiple($name, &$value, $indicator_field,
228 $search = SQ_INORDER,
229 $fallback_no_suffix=TRUE, $default=NULL,
54ce41dd 230 $typecast=FALSE) {
231
1793f985 232 // Set arbitrary max limit -- should be much lower except on the
233 // search results page, if there are many (50 or more?) mailboxes
234 // shown, this may not be high enough. Is there some way we should
235 // automate this value?
236 //
237 $max_form_search = 100;
54ce41dd 238
239 for ($i = 1; $i <= $max_form_search; $i++) {
240 if (sqGetGlobalVar($indicator_field . '_' . $i, $temp, $search)) {
241 return sqGetGlobalVar($name . '_' . $i, $value, $search, $default, $typecast);
242 }
243 }
244
245
246 // no indicator field found; just try without suffix if allowed
247 //
248 if ($fallback_no_suffix) {
249 return sqGetGlobalVar($name, $value, $search, $default, $typecast);
250 }
251
252
253 // no dice, set default and return FALSE
254 //
255 if (!is_null($default)) {
256 $value = $default;
257 }
258 return FALSE;
259
260}
261
262
4cd8ae7d 263/**
2d055f0a 264 * Search for the var $name in $_SESSION, $_POST, $_GET, $_COOKIE, or $_SERVER
265 * and set it in provided var.
d1975c5b 266 *
2d055f0a 267 * If $search is not provided, or if it is SQ_INORDER, it will search $_SESSION,
268 * then $_POST, then $_GET. If $search is SQ_FORM it will search $_POST and
269 * $_GET. Otherwise, use one of the defined constants to look for a var in one
270 * place specifically.
d1975c5b 271 *
2d055f0a 272 * Note: $search is an int value equal to one of the constants defined above.
d1975c5b 273 *
2d055f0a 274 * Example:
275 * sqgetGlobalVar('username',$username,SQ_SESSION);
276 * // No quotes around last param, it's a constant - not a string!
d1975c5b 277 *
8b096f0a 278 * @param string name the name of the var to search
279 * @param mixed value the variable to return
280 * @param int search constant defining where to look
54ce41dd 281 * @param mixed default the value to assign to $value when nothing is found
c2b585c5 282 * @param int typecast force variable to be cast to given type (please
283 * use SQ_TYPE_XXX constants or set to FALSE (default)
284 * to leave variable type unmolested)
54ce41dd 285 *
8b096f0a 286 * @return bool whether variable is found.
4cd8ae7d 287 */
202bcbcc 288function sqgetGlobalVar($name, &$value, $search = SQ_INORDER, $default = NULL, $typecast = false) {
289
290 $result = false;
f79c19a4 291
4cd8ae7d 292 switch ($search) {
62f7daa5 293 /* we want the default case to be first here,
051f6245 294 so that if a valid value isn't specified,
295 all three arrays will be searched. */
d1975c5b 296 default:
d9ad2525 297 case SQ_INORDER: // check session, post, get
d1975c5b 298 case SQ_SESSION:
299 if( isset($_SESSION[$name]) ) {
4cd8ae7d 300 $value = $_SESSION[$name];
202bcbcc 301 $result = TRUE;
302 break;
d1975c5b 303 } elseif ( $search == SQ_SESSION ) {
304 break;
305 }
d9ad2525 306 case SQ_FORM: // check post, get
d1975c5b 307 case SQ_POST:
308 if( isset($_POST[$name]) ) {
4cd8ae7d 309 $value = $_POST[$name];
202bcbcc 310 $result = TRUE;
311 break;
d1975c5b 312 } elseif ( $search == SQ_POST ) {
27d0841c 313 break;
d1975c5b 314 }
315 case SQ_GET:
316 if ( isset($_GET[$name]) ) {
317 $value = $_GET[$name];
202bcbcc 318 $result = TRUE;
319 break;
62f7daa5 320 }
d1975c5b 321 /* NO IF HERE. FOR SQ_INORDER CASE, EXIT after GET */
322 break;
323 case SQ_COOKIE:
324 if ( isset($_COOKIE[$name]) ) {
325 $value = $_COOKIE[$name];
202bcbcc 326 $result = TRUE;
327 break;
d1975c5b 328 }
329 break;
330 case SQ_SERVER:
d1975c5b 331 if ( isset($_SERVER[$name]) ) {
332 $value = $_SERVER[$name];
202bcbcc 333 $result = TRUE;
334 break;
d1975c5b 335 }
336 break;
4cd8ae7d 337 }
202bcbcc 338 if ($result && $typecast) {
339 switch ($typecast) {
c2b585c5 340 case SQ_TYPE_INT: $value = (int) $value; break;
341 case SQ_TYPE_STRING: $value = (string) $value; break;
342 case SQ_TYPE_BOOL: $value = (bool) $value; break;
202bcbcc 343 default: break;
344 }
ced8272a 345 } else if (!$result && !is_null($default)) {
202bcbcc 346 $value = $default;
347 }
348 return $result;
4cd8ae7d 349}
350
8b096f0a 351/**
061108dc 352 * Get an immutable copy of a configuration variable if SquirrelMail
353 * is in "secured configuration" mode. This guarantees the caller
354 * gets a copy of the requested value as it is set in the main
355 * application configuration (including config_local overrides), and
356 * not what it might be after possibly having been modified by some
357 * other code (usually a plugin overriding configuration values for
358 * one reason or another).
359 *
360 * WARNING: Please use this function as little as possible, because
361 * every time it is called, it forcibly reloads the main configuration
362 * file(s).
363 *
364 * Caller beware that this function will do nothing if SquirrelMail
365 * is not in "secured configuration" mode per the $secured_config
366 * setting.
367 *
368 * @param string $var_name The name of the desired variable
369 *
370 * @return mixed The desired value
371 *
372 * @since 1.5.2
373 *
374 */
375function get_secured_config_value($var_name) {
376
377 static $return_values = array();
378
379 // if we can avoid it, return values that have
380 // already been retrieved (so we don't have to
381 // include the config file yet again)
382 //
383 if (isset($return_values[$var_name])) {
384 return $return_values[$var_name];
385 }
386
387
388 // load site configuration
389 //
390 require(SM_PATH . 'config/config.php');
391
392 // load local configuration overrides
393 //
394 if (file_exists(SM_PATH . 'config/config_local.php')) {
395 require(SM_PATH . 'config/config_local.php');
396 }
397
398 // if SM isn't in "secured configuration" mode,
399 // just return the desired value from the global scope
400 //
401 if (!$secured_config) {
402 global $$var_name;
403 $return_values[$var_name] = $$var_name;
404 return $$var_name;
405 }
406
407 // else we return what we got from the config file
408 //
409 $return_values[$var_name] = $$var_name;
410 return $$var_name;
411
412}
413
414/**
8b096f0a 415 * Deletes an existing session, more advanced than the standard PHP
416 * session_destroy(), it explicitly deletes the cookies and global vars.
66c7cd3f 417 *
418 * WARNING: Older PHP versions have some issues with session management.
68a7e1d6 419 * See http://bugs.php.net/11643 (warning, spammed bug tracker) and
66c7cd3f 420 * http://bugs.php.net/13834. SID constant is not destroyed in PHP 4.1.2,
68a7e1d6 421 * 4.2.3 and maybe other versions. If you restart session after session
422 * is destroyed, affected PHP versions produce PHP notice. Bug should
66c7cd3f 423 * be fixed only in 4.3.0
8b096f0a 424 */
513db22c 425function sqsession_destroy() {
242342d0 426
281c3d5b 427 /*
428 * php.net says we can kill the cookie by setting just the name:
429 * http://www.php.net/manual/en/function.setcookie.php
430 * maybe this will help fix the session merging again.
431 *
432 * Changed the theory on this to kill the cookies first starting
433 * a new session will provide a new session for all instances of
434 * the browser, we don't want that, as that is what is causing the
435 * merging of sessions.
436 */
242342d0 437
716cc530 438 global $base_uri, $_COOKIE, $_SESSION;
f31687f6 439
f6cd95a1 440 if (isset($_COOKIE[session_name()]) && session_name()) sqsetcookie(session_name(), $_COOKIE[session_name()], 1, $base_uri);
441 if (isset($_COOKIE['key']) && $_COOKIE['key']) sqsetcookie('key','SQMTRASH',1,$base_uri);
281c3d5b 442
443 $sessid = session_id();
444 if (!empty( $sessid )) {
abd74f7d 445 $_SESSION = array();
21e18f59 446 @session_destroy();
242342d0 447 }
281c3d5b 448}
242342d0 449
8b096f0a 450/**
281c3d5b 451 * Function to verify a session has been started. If it hasn't
452 * start a session up. php.net doesn't tell you that $_SESSION
453 * (even though autoglobal), is not created unless a session is
454 * started, unlike $_POST, $_GET and such
253ca97e 455 * Update: (see #1685031) the session ID is left over after the
456 * session is closed in some PHP setups; this function just becomes
457 * a passthru to sqsession_start(), but leaving old code in for
458 * edification.
281c3d5b 459 */
281c3d5b 460function sqsession_is_active() {
253ca97e 461 //$sessid = session_id();
462 //if ( empty( $sessid ) ) {
3a1de9f1 463 sqsession_start();
253ca97e 464 //}
513db22c 465}
466
3a1de9f1 467/**
468 * Function to start the session and store the cookie with the session_id as
469 * HttpOnly cookie which means that the cookie isn't accessible by javascript
470 * (IE6 only)
253ca97e 471 * Note that as sqsession_is_active() no longer discriminates as to when
472 * it calls this function, session_start() has to have E_NOTICE suppression
473 * (thus the @ sign).
3a1de9f1 474 */
475function sqsession_start() {
202bcbcc 476 global $base_uri;
7f62aaef 477
8442ecb9 478 sq_call_function_suppress_errors('session_start');
479 // was: @session_start();
202bcbcc 480 $session_id = session_id();
481
79a7fdf5 482 // session_starts sets the sessionid cookie but without the httponly var
3a1de9f1 483 // setting the cookie again sets the httponly cookie attribute
79a7fdf5 484 //
485 // need to check if headers have been sent, since sqsession_is_active()
486 // has become just a passthru to this function, so the sqsetcookie()
487 // below is called every time, even after headers have already been sent
488 //
489 if (!headers_sent())
490 sqsetcookie(session_name(),$session_id,false,$base_uri);
3a1de9f1 491}
492
493
79a7fdf5 494
3a1de9f1 495/**
496 * Set a cookie
945c733e 497 *
3a1de9f1 498 * @param string $sName The name of the cookie.
499 * @param string $sValue The value of the cookie.
945c733e 500 * @param int $iExpire The time the cookie expires. This is a Unix
501 * timestamp so is in number of seconds since
502 * the epoch.
503 * @param string $sPath The path on the server in which the cookie
504 * will be available on.
3a1de9f1 505 * @param string $sDomain The domain that the cookie is available.
945c733e 506 * @param boolean $bSecure Indicates that the cookie should only be
507 * transmitted over a secure HTTPS connection.
3a1de9f1 508 * @param boolean $bHttpOnly Disallow JS to access the cookie (IE6 only)
945c733e 509 * @param boolean $bReplace Replace previous cookies with same name?
510 *
3a1de9f1 511 * @return void
945c733e 512 *
3a1de9f1 513 */
945c733e 514function sqsetcookie($sName, $sValue='deleted', $iExpire=0, $sPath="", $sDomain="",
515 $bSecure=false, $bHttpOnly=true, $bReplace=false) {
516
68a7e1d6 517 // if we have a secure connection then limit the cookies to https only.
518 if ($sName && isset($_SERVER['HTTPS']) && $_SERVER['HTTPS']) {
519 $bSecure = true;
202bcbcc 520 }
9c0f1780 521
522 // admin config can override the restriction of secure-only cookies
523 global $only_secure_cookies;
524 if (!$only_secure_cookies)
525 $bSecure = false;
526
68a7e1d6 527 if (false && check_php_version(5,2)) {
528 // php 5 supports the httponly attribute in setcookie, but because setcookie seems a bit
529 // broken we use the header function for php 5.2 as well. We might change that later.
530 //setcookie($sName,$sValue,(int) $iExpire,$sPath,$sDomain,$bSecure,$bHttpOnly);
531 } else {
a14da8d6 532 if (!empty($sDomain)) {
68a7e1d6 533 // Fix the domain to accept domains with and without 'www.'.
a14da8d6 534 if (strtolower(substr($sDomain, 0, 4)) == 'www.') $sDomain = substr($sDomain, 4);
535 $sDomain = '.' . $sDomain;
68a7e1d6 536
537 // Remove port information.
a14da8d6 538 $Port = strpos($sDomain, ':');
539 if ($Port !== false) $sDomain = substr($sDomain, 0, $Port);
68a7e1d6 540 }
716cc530 541 if (!$sValue) $sValue = 'deleted';
68a7e1d6 542 header('Set-Cookie: ' . rawurlencode($sName) . '=' . rawurlencode($sValue)
a14da8d6 543 . (empty($iExpire) ? '' : '; expires=' . gmdate('D, d-M-Y H:i:s', $iExpire) . ' GMT')
68a7e1d6 544 . (empty($sPath) ? '' : '; path=' . $sPath)
545 . (empty($sDomain) ? '' : '; domain=' . $sDomain)
546 . (!$bSecure ? '' : '; secure')
945c733e 547 . (!$bHttpOnly ? '' : '; HttpOnly'), $bReplace);
68a7e1d6 548 }
202bcbcc 549}
550
945c733e 551
202bcbcc 552/**
553 * session_regenerate_id replacement for PHP < 4.3.2
554 *
555 * This code is borrowed from Gallery, session.php version 1.53.2.1
556 */
557if (!function_exists('session_regenerate_id')) {
202bcbcc 558
559 function php_combined_lcg() {
202bcbcc 560 $tv = gettimeofday();
561 $lcg['s1'] = $tv['sec'] ^ (~$tv['usec']);
562 $lcg['s2'] = mt_rand();
563 $q = (int) ($lcg['s1'] / 53668);
564 $lcg['s1'] = (int) (40014 * ($lcg['s1'] - 53668 * $q) - 12211 * $q);
565 if ($lcg['s1'] < 0) {
566 $lcg['s1'] += 2147483563;
567 }
568 $q = (int) ($lcg['s2'] / 52774);
569 $lcg['s2'] = (int) (40692 * ($lcg['s2'] - 52774 * $q) - 3791 * $q);
570 if ($lcg['s2'] < 0) {
571 $lcg['s2'] += 2147483399;
572 }
573 $z = (int) ($lcg['s1'] - $lcg['s2']);
574 if ($z < 1) {
575 $z += 2147483562;
576 }
577 return $z * 4.656613e-10;
578 }
3a1de9f1 579
202bcbcc 580 function session_regenerate_id() {
581 global $base_uri;
582 $tv = gettimeofday();
583 sqgetGlobalVar('REMOTE_ADDR',$remote_addr,SQ_SERVER);
584 $buf = sprintf("%.15s%ld%ld%0.8f", $remote_addr, $tv['sec'], $tv['usec'], php_combined_lcg() * 10);
585 session_id(md5($buf));
586 if (ini_get('session.use_cookies')) {
73ee0267 587 sqsetcookie(session_name(), session_id(), 0, $base_uri);
202bcbcc 588 }
589 return TRUE;
590 }
3a1de9f1 591}
7f62aaef 592
202bcbcc 593
7f62aaef 594/**
595 * php_self
596 *
597 * Creates an URL for the page calling this function, using either the PHP global
598 * REQUEST_URI, or the PHP global PHP_SELF with QUERY_STRING added. Before 1.5.1
599 * function was stored in function/strings.php.
600 *
601 * @return string the complete url for this page
602 * @since 1.2.3
603 */
604function php_self () {
605 if ( sqgetGlobalVar('REQUEST_URI', $req_uri, SQ_SERVER) && !empty($req_uri) ) {
606 return $req_uri;
607 }
608
609 if ( sqgetGlobalVar('PHP_SELF', $php_self, SQ_SERVER) && !empty($php_self) ) {
610
611 // need to add query string to end of PHP_SELF to match REQUEST_URI
612 //
613 if ( sqgetGlobalVar('QUERY_STRING', $query_string, SQ_SERVER) && !empty($query_string) ) {
614 $php_self .= '?' . $query_string;
615 }
616
617 return $php_self;
618 }
619
620 return '';
621}
aa201211 622
623
624/**
68a7e1d6 625 * Find files and/or directories in a given directory optionally
626 * limited to only those with the given file extension. If the
627 * directory is not found or cannot be opened, no error is generated;
8f32a0a3 628 * only an empty file list is returned.
aa201211 629FIXME: do we WANT to throw an error or a notice or... or return FALSE?
630 *
68a7e1d6 631 * @param string $directory_path The path (relative or absolute)
8f32a0a3 632 * to the desired directory.
45ca6962 633 * @param mixed $extension The file extension filter - either
634 * an array of desired extension(s),
635 * or a comma-separated list of same
636 * (optional; default is to return
637 * all files (dirs).
8f32a0a3 638 * @param boolean $return_filenames_only When TRUE, only file/dir names
aa201211 639 * are returned, otherwise the
640 * $directory_path string is
8f32a0a3 641 * prepended to each file/dir in
aa201211 642 * the returned list (optional;
8f32a0a3 643 * default is filename/dirname only)
644 * @param boolean $include_directories When TRUE, directories are
68a7e1d6 645 * included (optional; default
8f32a0a3 646 * DO include directories).
68a7e1d6 647 * @param boolean $directories_only When TRUE, ONLY directories
648 * are included (optional; default
8f32a0a3 649 * is to include files too).
650 * @param boolean $separate_files_and_directories When TRUE, files and
651 * directories are returned
652 * in separate lists, so
653 * the return value is
654 * formatted as a two-element
655 * array with the two keys
656 * "FILES" and "DIRECTORIES",
657 * where corresponding values
658 * are lists of either all
659 * files or all directories
660 * (optional; default do not
661 * split up return array).
45ca6962 662 * @param boolean $only_sm When TRUE, a security check will
663 * limit directory access to only
664 * paths within the SquirrelMail
665 * installation currently being used
666 * (optional; default TRUE)
aa201211 667 *
8f32a0a3 668 * @return array The requested file/directory list(s).
aa201211 669 *
670 * @since 1.5.2
671 *
672 */
45ca6962 673function list_files($directory_path, $extensions='', $return_filenames_only=TRUE,
68a7e1d6 674 $include_directories=TRUE, $directories_only=FALSE,
45ca6962 675 $separate_files_and_directories=FALSE, $only_sm=TRUE) {
aa201211 676
677 $files = array();
8f32a0a3 678 $directories = array();
aa201211 679
45ca6962 680
681 // make sure requested path is under SM_PATH if needed
682 //
683 if ($only_sm) {
684 if (strpos(realpath($directory_path), realpath(SM_PATH)) !== 0) {
685 //plain_error_message(_("Illegal filesystem access was requested"));
686 echo _("Illegal filesystem access was requested");
687 exit;
688 }
689 }
690
691
aa201211 692 // validate given directory
68a7e1d6 693 //
694 if (empty($directory_path)
695 || !is_dir($directory_path)
aa201211 696 || !($DIR = opendir($directory_path))) {
697 return $files;
698 }
699
8f32a0a3 700
45ca6962 701 // ensure extensions is an array and is properly formatted
702 //
703 if (!empty($extensions)) {
704 if (!is_array($extensions))
705 $extensions = explode(',', $extensions);
706 $temp_extensions = array();
707 foreach ($extensions as $ext)
708 $temp_extensions[] = '.' . trim(trim($ext), '.');
709 $extensions = $temp_extensions;
710 } else $extensions = array();
711
712
8f32a0a3 713 $directory_path = rtrim($directory_path, '/');
714
715
aa201211 716 // parse through the files
717 //
aa201211 718 while (($file = readdir($DIR)) !== false) {
719
720 if ($file == '.' || $file == '..') continue;
721
45ca6962 722 if (!empty($extensions))
723 foreach ($extensions as $ext)
724 if (strrpos($file, $ext) !== (strlen($file) - strlen($ext)))
725 continue 2;
8f32a0a3 726
727 // only use is_dir() if we really need to (be as efficient as possible)
728 //
729 $is_dir = FALSE;
68a7e1d6 730 if (!$include_directories || $directories_only
8f32a0a3 731 || $separate_files_and_directories) {
732 if (is_dir($directory_path . '/' . $file)) {
733 if (!$include_directories) continue;
734 $is_dir = TRUE;
68a7e1d6 735 $directories[] = ($return_filenames_only
8f32a0a3 736 ? $file
737 : $directory_path . '/' . $file);
68a7e1d6 738 }
8f32a0a3 739 if ($directories_only) continue;
740 }
741
68a7e1d6 742 if (!$separate_files_and_directories
8f32a0a3 743 || ($separate_files_and_directories && !$is_dir)) {
68a7e1d6 744 $files[] = ($return_filenames_only
8f32a0a3 745 ? $file
746 : $directory_path . '/' . $file);
aa201211 747 }
748
749 }
750 closedir($DIR);
751
8f32a0a3 752
753 if ($directories_only) return $directories;
754 if ($separate_files_and_directories) return array('FILES' => $files,
755 'DIRECTORIES' => $directories);
aa201211 756 return $files;
757
758}
759
760
761/**
762 * Print variable
763 *
764 * sm_print_r($some_variable, [$some_other_variable [, ...]]);
765 *
766 * Debugging function - does the same as print_r, but makes sure special
767 * characters are converted to htmlentities first. This will allow
768 * values like <some@email.address> to be displayed.
769 * The output is wrapped in <<pre>> and <</pre>> tags.
770 * Since 1.4.2 accepts unlimited number of arguments.
771 * @since 1.4.1
772 * @return void
773 */
774function sm_print_r() {
775 ob_start(); // Buffer output
776 foreach(func_get_args() as $var) {
777 print_r($var);
778 echo "\n";
779 // php has get_class_methods function that can print class methods
780 if (is_object($var)) {
781 // get class methods if $var is object
782 $aMethods=get_class_methods(get_class($var));
783 // make sure that $aMethods is array and array is not empty
784 if (is_array($aMethods) && $aMethods!=array()) {
785 echo "Object methods:\n";
786 foreach($aMethods as $method) {
787 echo '* ' . $method . "\n";
788 }
789 }
790 echo "\n";
791 }
792 }
793 $buffer = ob_get_contents(); // Grab the print_r output
794 ob_end_clean(); // Silently discard the output & stop buffering
795 print '<div align="left"><pre>';
796 print htmlentities($buffer);
797 print '</pre></div>';
798}
45ca6962 799
800
253ca97e 801/**
802 * Sanitize a value using htmlspecialchars() or similar, but also
803 * recursively run htmlspecialchars() (or similar) on array keys
804 * and values.
805 *
806 * If $value is not a string or an array with strings in it,
807 * the value is returned as is.
808 *
809 * @param mixed $value The value to be sanitized.
810 * @param mixed $quote_style Either boolean or an integer. If it
811 * is an integer, it must be the PHP
812 * constant indicating if/how to escape
813 * quotes: ENT_QUOTES, ENT_COMPAT, or
814 * ENT_NOQUOTES. If it is a boolean value,
815 * it must be TRUE and thus indicates
816 * that the only sanitizing to be done
817 * herein is to replace single and double
818 * quotes with &#039; and &quot;, no other
819 * changes are made to $value. If it is
820 * boolean and FALSE, behavior reverts
821 * to same as if the value was ENT_QUOTES
822 * (OPTIONAL; default is ENT_QUOTES).
823 *
824 * @return mixed The sanitized value.
825 *
826 * @since 1.5.2
827 *
828 **/
829function sq_htmlspecialchars($value, $quote_style=ENT_QUOTES) {
830
831 if ($quote_style === FALSE) $quote_style = ENT_QUOTES;
832
833 // array? go recursive...
834 //
835 if (is_array($value)) {
836 $return_array = array();
837 foreach ($value as $key => $val) {
838 $return_array[sq_htmlspecialchars($key, $quote_style)]
839 = sq_htmlspecialchars($val, $quote_style);
840 }
841 return $return_array;
842
843 // sanitize strings only
844 //
845 } else if (is_string($value)) {
846 if ($quote_style === TRUE)
847 return str_replace(array('\'', '"'), array('&#039;', '&quot;'), $value);
848 else
849 return htmlspecialchars($value, $quote_style);
850 }
851
852 // anything else gets returned with no changes
853 //
854 return $value;
855
856}