}
}
+/**
+ * Squelch error output to screen (only) for the given function.
+ * If the SquirrelMail debug mode SM_DEBUG_MODE_ADVANCED is not
+ * enabled, error output will not go to the log, either.
+ *
+ * This provides an alternative to the @ error-suppression
+ * operator where errors will not be shown in the interface
+ * but will show up in the server log file (assuming the
+ * administrator has configured PHP logging).
+ *
+ * @since 1.4.12 and 1.5.2
+ *
+ * @param string $function The function to be executed
+ * @param array $args The arguments to be passed to the function
+ * (OPTIONAL; default no arguments)
+ * NOTE: The caller must take extra action if
+ * the function being called is supposed
+ * to use any of the parameters by
+ * reference. In the following example,
+ * $x is passed by reference and $y is
+ * passed by value to the "my_func"
+ * function.
+ * sq_call_function_suppress_errors('my_func', array(&$x, $y));
+ *
+ * @return mixed The return value, if any, of the function being
+ * executed will be returned.
+ *
+ */
+function sq_call_function_suppress_errors($function, $args=NULL) {
+ global $sm_debug_mode;
+
+ $display_errors = ini_get('display_errors');
+ ini_set('display_errors', '0');
+
+ // if advanced debug mode isn't enabled, don't log the error, either
+ //
+ if (!($sm_debug_mode & SM_DEBUG_MODE_ADVANCED))
+ $error_reporting = error_reporting(0);
+
+ $ret = call_user_func_array($function, $args);
+
+ if (!($sm_debug_mode & SM_DEBUG_MODE_ADVANCED))
+ error_reporting($error_reporting);
+
+ ini_set('display_errors', $display_errors);
+ return $ret;
+}
+
/**
* Add a variable to the session.
* @param mixed $var the variable to register
return $result;
}
+/**
+ * Get an immutable copy of a configuration variable if SquirrelMail
+ * is in "secured configuration" mode. This guarantees the caller
+ * gets a copy of the requested value as it is set in the main
+ * application configuration (including config_local overrides), and
+ * not what it might be after possibly having been modified by some
+ * other code (usually a plugin overriding configuration values for
+ * one reason or another).
+ *
+ * WARNING: Please use this function as little as possible, because
+ * every time it is called, it forcibly reloads the main configuration
+ * file(s).
+ *
+ * Caller beware that this function will do nothing if SquirrelMail
+ * is not in "secured configuration" mode per the $secured_config
+ * setting.
+ *
+ * @param string $var_name The name of the desired variable
+ *
+ * @return mixed The desired value
+ *
+ * @since 1.5.2
+ *
+ */
+function get_secured_config_value($var_name) {
+
+ static $return_values = array();
+
+ // if we can avoid it, return values that have
+ // already been retrieved (so we don't have to
+ // include the config file yet again)
+ //
+ if (isset($return_values[$var_name])) {
+ return $return_values[$var_name];
+ }
+
+
+ // load site configuration
+ //
+ require(SM_PATH . 'config/config.php');
+
+ // load local configuration overrides
+ //
+ if (file_exists(SM_PATH . 'config/config_local.php')) {
+ require(SM_PATH . 'config/config_local.php');
+ }
+
+ // if SM isn't in "secured configuration" mode,
+ // just return the desired value from the global scope
+ //
+ if (!$secured_config) {
+ global $$var_name;
+ $return_values[$var_name] = $$var_name;
+ return $$var_name;
+ }
+
+ // else we return what we got from the config file
+ //
+ $return_values[$var_name] = $$var_name;
+ return $$var_name;
+
+}
+
/**
* Deletes an existing session, more advanced than the standard PHP
* session_destroy(), it explicitly deletes the cookies and global vars.
global $base_uri, $_COOKIE, $_SESSION;
- if (isset($_COOKIE[session_name()]) && session_name()) sqsetcookie(session_name(), '', 0, $base_uri);
- if (isset($_COOKIE['username']) && $_COOKIE['username']) sqsetcookie('username','',0,$base_uri);
- if (isset($_COOKIE['key']) && $_COOKIE['key']) sqsetcookie('key','',0,$base_uri);
+ if (isset($_COOKIE[session_name()]) && session_name()) sqsetcookie(session_name(), $_COOKIE[session_name()], 1, $base_uri);
+ if (isset($_COOKIE['key']) && $_COOKIE['key']) sqsetcookie('key','SQMTRASH',1,$base_uri);
$sessid = session_id();
if (!empty( $sessid )) {
function sqsession_start() {
global $base_uri;
- @session_start();
+ sq_call_function_suppress_errors('session_start');
+ // was: @session_start();
$session_id = session_id();
- // session_starts sets the sessionid cookie buth without the httponly var
+ // session_starts sets the sessionid cookie but without the httponly var
// setting the cookie again sets the httponly cookie attribute
- sqsetcookie(session_name(),$session_id,false,$base_uri);
+ //
+ // need to check if headers have been sent, since sqsession_is_active()
+ // has become just a passthru to this function, so the sqsetcookie()
+ // below is called every time, even after headers have already been sent
+ //
+ if (!headers_sent())
+ sqsetcookie(session_name(),$session_id,false,$base_uri);
}
+
/**
* Set a cookie
+ *
* @param string $sName The name of the cookie.
* @param string $sValue The value of the cookie.
- * @param int $iExpire The time the cookie expires. This is a Unix timestamp so is in number of seconds since the epoch.
- * @param string $sPath The path on the server in which the cookie will be available on.
+ * @param int $iExpire The time the cookie expires. This is a Unix
+ * timestamp so is in number of seconds since
+ * the epoch.
+ * @param string $sPath The path on the server in which the cookie
+ * will be available on.
* @param string $sDomain The domain that the cookie is available.
- * @param boolean $bSecure Indicates that the cookie should only be transmitted over a secure HTTPS connection.
+ * @param boolean $bSecure Indicates that the cookie should only be
+ * transmitted over a secure HTTPS connection.
* @param boolean $bHttpOnly Disallow JS to access the cookie (IE6 only)
+ * @param boolean $bReplace Replace previous cookies with same name?
+ *
* @return void
+ *
*/
-function sqsetcookie($sName,$sValue='deleted',$iExpire=0,$sPath="",$sDomain="",$bSecure=false,$bHttpOnly=true) {
+function sqsetcookie($sName, $sValue='deleted', $iExpire=0, $sPath="", $sDomain="",
+ $bSecure=false, $bHttpOnly=true, $bReplace=false) {
+
// if we have a secure connection then limit the cookies to https only.
if ($sName && isset($_SERVER['HTTPS']) && $_SERVER['HTTPS']) {
$bSecure = true;
// broken we use the header function for php 5.2 as well. We might change that later.
//setcookie($sName,$sValue,(int) $iExpire,$sPath,$sDomain,$bSecure,$bHttpOnly);
} else {
- if (!empty($Domain)) {
+ if (!empty($sDomain)) {
// Fix the domain to accept domains with and without 'www.'.
- if (strtolower(substr($Domain, 0, 4)) == 'www.') $Domain = substr($Domain, 4);
- $Domain = '.' . $Domain;
+ if (strtolower(substr($sDomain, 0, 4)) == 'www.') $sDomain = substr($sDomain, 4);
+ $sDomain = '.' . $sDomain;
// Remove port information.
- $Port = strpos($Domain, ':');
- if ($Port !== false) $Domain = substr($Domain, 0, $Port);
+ $Port = strpos($sDomain, ':');
+ if ($Port !== false) $sDomain = substr($sDomain, 0, $Port);
}
if (!$sValue) $sValue = 'deleted';
header('Set-Cookie: ' . rawurlencode($sName) . '=' . rawurlencode($sValue)
- . (empty($iExpires) ? '' : '; expires=' . gmdate('D, d-M-Y H:i:s', $iExpires) . ' GMT')
+ . (empty($iExpire) ? '' : '; expires=' . gmdate('D, d-M-Y H:i:s', $iExpire) . ' GMT')
. (empty($sPath) ? '' : '; path=' . $sPath)
. (empty($sDomain) ? '' : '; domain=' . $sDomain)
. (!$bSecure ? '' : '; secure')
- . (!$bHttpOnly ? '' : '; HttpOnly'), false);
+ . (!$bHttpOnly ? '' : '; HttpOnly'), $bReplace);
}
}
+
/**
* session_regenerate_id replacement for PHP < 4.3.2
*
* This code is borrowed from Gallery, session.php version 1.53.2.1
*/
if (!function_exists('session_regenerate_id')) {
- function make_seed() {
- list($usec, $sec) = explode(' ', microtime());
- return (float)$sec + ((float)$usec * 100000);
- }
function php_combined_lcg() {
- mt_srand(make_seed());
$tv = gettimeofday();
$lcg['s1'] = $tv['sec'] ^ (~$tv['usec']);
$lcg['s2'] = mt_rand();
$buf = sprintf("%.15s%ld%ld%0.8f", $remote_addr, $tv['sec'], $tv['usec'], php_combined_lcg() * 10);
session_id(md5($buf));
if (ini_get('session.use_cookies')) {
- // at a later stage we use sqsetcookie. At this point just do
- // what session_regenerate_id would do
- setcookie(session_name(), session_id(), NULL, $base_uri);
+ sqsetcookie(session_name(), session_id(), 0, $base_uri);
}
return TRUE;
}
}
-/**
- * SquirrelMail wrapper for popen()/proc_open()
- *
- * This emulates popen() by using proc_open() if at all
- * possible (reverts seamlessly to popen() if proc_open()
- * is not supported in current PHP installation).
- *
- * This is intended for use with the related sq_pclose(),
- * sq_get_pipe_stdout() and sq_get_pipe_stderr() functions,
- * the latter of which add an easy interface for retrieving
- * output from a child process that was opened with traditional
- * popen() syntax (in write mode), while not breaking under
- * earlier versions of PHP.
- *
- * @param string $command The command identifying what to
- * execute in the child process.
- * @param string $mode The desired mode for the
- * unidirectional pipe that is returned;
- * either 'r' for read or 'w' for write.
- *
- * @return resource A handle on the desired read or write pipe
- * to the child process, or FALSE if the
- * process cannot be created.
- *
- * @since 1.5.2
- *
- */
-function sq_popen($command, $mode) {
-
- $mode = strtolower($mode{0});
-
-
- if (!function_exists('proc_open'))
- return popen($command, $mode);
-
-
- // set up our process store if not done already
- //
- global $processes;
- if (empty($processes))
- $processes = array();
-
-
- // define read, write and error pipes
- //
- $descriptors = array(0 => array('pipe', 'r'),
- 1 => array('pipe', 'w'),
- 2 => array('pipe', 'w'));
-
-
- // start the child process
- //
- $proc = proc_open($command, $descriptors, $pipes);
- if (!is_resource($proc))
- return FALSE;
-
-
- // when in read mode, we'll return a handle to the child's write pipe
- //
- if ($mode == 'r')
- $return_value = $pipes[1];
- else if ($mode == 'w')
- $return_value = $pipes[0];
- else
- die('sq_popen() expects $mode to be "r" or "w"');
-
-
- // store the handle to the process and its pipes
- // internally, keyed by whatever handle we'll be
- // returning
- //
- $processes[$return_value] = array($proc, $pipes);
-
-
- return $return_value;
-
-}
-
-
-/**
- * Get STDERR output from a child process
- *
- * This is designed to be used with processes that were
- * opened with sq_popen(), and will return any output
- * that may be available from STDERR of the child process
- * at the current time.
- *
- * If a value is given for $timeout_seconds, this function
- * will wait that long for output in case there is none
- * right now.
- *
- * In PHP environments that do not support proc_open(),
- * an empty string will always be returned.
- *
- * @param resource $handle The handle to the child process,
- * as returned from sq_popen().
- * @param int $timeout_seconds The number of seconds to wait
- * for output if there is none
- * available immediately (OPTIONAL;
- * default is not to wait)
- * @param boolean $quiet When TRUE, errors are silently
- * ignored (OPTIONAL; default is TRUE).
- *
- * @return string Any STDERR output that may have been found.
- *
- * @since 1.5.2
- *
- */
-function sq_get_pipe_stderr($handle, $timeout_seconds=0, $quiet=TRUE) {
-
- // yes, we are testing for proc_OPEN
- // because we need to know how the
- // handle was actually OPENED
- //
- if (!function_exists('proc_open'))
- return '';
-
-
- // get our process out of the process store
- //
- global $processes;
- if (!is_array($processes) || !isset($processes[$handle])) {
- if (!quiet) {
- plain_error_message(_("Failed to find corresponding open process handle"));
- }
- return '';
- }
- $proc = $processes[$handle];
-
-
- // get all we can from stderr, don't wait longer
- // than our timeout for input
- //
- $contents = '';
- $read = array($proc[1][2]);
- $write = NULL;
- $except = NULL;
- if (stream_select($read, $write, $except, $timeout_seconds))
- while (!feof($proc[1][2])) $contents .= fread($proc[1][2], 8192);
- return $contents;
-
-}
-
-
-/**
- * Get STDOUT output from a child process
- *
- * This is designed to be used with processes that were
- * opened with sq_popen(), and will return any output
- * that may be available from STDOUT of the child process
- * at the current time.
- *
- * If a value is given for $timeout_seconds, this function
- * will wait that long for output in case there is none
- * right now.
- *
- * In PHP environments that do not support proc_open(),
- * an empty string will always be returned.
- *
- * @param resource $handle The handle to the child process,
- * as returned from sq_popen().
- * @param int $timeout_seconds The number of seconds to wait
- * for output if there is none
- * available immediately (OPTIONAL;
- * default is not to wait)
- * @param boolean $quiet When TRUE, errors are silently
- * ignored (OPTIONAL; default is TRUE).
- *
- * @return string Any STDOUT output that may have been found.
- *
- * @since 1.5.2
- *
- */
-function sq_get_pipe_stdout($handle, $timeout_seconds=0, $quiet=TRUE) {
-
- // yes, we are testing for proc_OPEN
- // because we need to know how the
- // handle was actually OPENED
- //
- if (!function_exists('proc_open'))
- return '';
-
-
- // get our process out of the process store
- //
- global $processes;
- if (!is_array($processes) || !isset($processes[$handle])) {
- if (!quiet) {
- plain_error_message(_("Failed to find corresponding open process handle"));
- }
- return '';
- }
- $proc = $processes[$handle];
-
-
- // get all we can from stdout, don't wait longer
- // than our timeout for input
- //
- $contents = '';
- $read = array($proc[1][1]);
- $write = NULL;
- $except = NULL;
- if (stream_select($read, $write, $except, $timeout_seconds))
- while (!feof($proc[1][1])) $contents .= fread($proc[1][1], 8192);
- return $contents;
-
-}
-
-
-/**
- * SquirrelMail wrapper for pclose()/proc_close()
- *
- * This is designed to be used with processes that were
- * opened with sq_popen(), and will correctly close
- * all pipes/handles that were opened as well as the
- * child process itself.
- *
- * @param resource $handle The handle to the child process,
- * as returned from sq_popen().
- * @param boolean $quiet When TRUE, errors are silently
- * ignored (OPTIONAL; default is TRUE).
- *
- * @return int The termination status of the child process.
- *
- * @since 1.5.2
- *
- */
-function sq_pclose($handle, $quiet=TRUE) {
-
- // yes, we are testing for proc_OPEN
- // because we need to know how the
- // handle was actually OPENED
- //
- if (!function_exists('proc_open'))
- return pclose($handle);
-
-
- // get our process out of the process store
- //
- global $processes;
- if (!is_array($processes) || !isset($processes[$handle])) {
- if (!quiet) {
- plain_error_message(_("Failed to find corresponding open process handle"));
- }
- return 127;
- }
- $proc = $processes[$handle];
- unset($processes[$handle]);
-
-
- // close all pipes
- //
- fclose($proc[1][0]);
- fclose($proc[1][1]);
- fclose($proc[1][2]);
-
-
- // close process
- //
- return proc_close($proc[0]);
-
-}
-
-
/**
* Sanitize a value using htmlspecialchars() or similar, but also
* recursively run htmlspecialchars() (or similar) on array keys
projects / squirrelmail.git / blobdiff