/**
* file_prefs.php
*
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* This contains functions for manipulating user preferences in files
*
* $Id$
+ * @package squirrelmail
*/
+/** include this for error messages */
+include_once(SM_PATH . 'functions/display_messages.php');
+
/**
* Check the preferences into the session cache.
*/
global $prefs_are_cached, $prefs_cache;
if ( isset($prefs_are_cached) && $prefs_are_cached) {
- return $prefs_cache;
+ return;
}
sqsession_unregister('prefs_cache');
/* Make sure that the preference file now DOES exist. */
if (!file_exists($filename)) {
- include_once(SM_PATH . 'functions/display_messages.php');
logout_error( sprintf( _("Preference file, %s, does not exist. Log out, and log back in to create a default preference file."), $filename) );
exit;
}
/* Open the file, or else display an error to the user. */
if(!$file = @fopen($filename, 'r'))
{
- include_once(SM_PATH . 'functions/display_messages.php');
logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
exit;
}
$prefs_cache[$key] = $value;
}
}
- }
- fclose($file);
+ }
+ fclose($file);
$prefs_are_cached = TRUE;
sqsession_register($prefs_cache, 'prefs_cache');
sqsession_register($prefs_are_cached, 'prefs_are_cached');
- return $prefs_cache;
}
/**
- * Return the value for the prefernce given by $string.
+ * Return the value for the preference given by $string.
*/
function getPref($data_dir, $username, $string, $default = '') {
global $prefs_cache;
$result = do_hook_function('get_pref_override',array($username,$string));
if (!$result) {
- $prefs_cache = cachePrefValues($data_dir, $username);
+ cachePrefValues($data_dir, $username);
if (isset($prefs_cache[$string])) {
$result = $prefs_cache[$string];
} else {
/**
* Save the preferences for this user.
*/
-function savePrefValues($data_dir, $username, $prefs_cache) {
+function savePrefValues($data_dir, $username) {
+ global $prefs_cache;
$filename = getHashedFile($username, $data_dir, "$username.pref");
- if (!is_array($prefs_cache) || count($prefs_cache) == 0) {
- include_once(SM_PATH . 'functions/display_messages.php');
- logout_error( _("Houston we have a problem, the preference cache is lost!!!."));
- exit;
- }
-
/* Open the file for writing, or else display an error to the user. */
if(!$file = @fopen($filename.'.tmp', 'w'))
{
- include_once(SM_PATH . 'functions/display_messages.php');
logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename.'.tmp') );
exit;
}
foreach ($prefs_cache as $Key => $Value) {
if (isset($Value)) {
- $tmpwrite = @fwrite($file, $Key . '=' . $Value . "\n");
- if ($tmpwrite == -1) {
+ if ( sq_fwrite($file, $Key . '=' . $Value . "\n") === FALSE ) {
logout_error( sprintf( _("Preference file, %s, could not be written. Contact your system administrator to resolve this issue.") , $filename . '.tmp') );
exit;
}
}
}
fclose($file);
- @copy($filename . '.tmp',$filename);
+ if (! @copy($filename . '.tmp',$filename) ) {
+ logout_error( sprintf( _("Preference file, %s, could not be copied from temporary file, %s. Contact your system administrator to resolve this issue."), $filename, $filename . '.tmp') );
+ exit;
+ }
@unlink($filename . '.tmp');
- chmod($filename, 0600);
+ @chmod($filename, 0600);
+ sqsession_register($prefs_cache , 'prefs_cache');
}
/**
function removePref($data_dir, $username, $string) {
global $prefs_cache;
+ cachePrefValues($data_dir, $username);
+
if (isset($prefs_cache[$string])) {
unset($prefs_cache[$string]);
}
- savePrefValues($data_dir, $username,$prefs_cache);
+ savePrefValues($data_dir, $username);
}
/**
function setPref($data_dir, $username, $string, $value) {
global $prefs_cache;
+ cachePrefValues($data_dir, $username);
if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $value)) {
return;
}
if ($value === '') {
- unset($prefs_cache[$string]);
- } else {
- $prefs_cache[$string] = $value;
+ removePref($data_dir, $username, $string);
+ return;
}
- savePrefValues($data_dir, $username, $prefs_cache);
+
+ $prefs_cache[$string] = $value;
+ savePrefValues($data_dir, $username);
}
/**
/* Then, check if the file exists. */
if (!@file_exists($filename) ) {
/* First, check the $data_dir for the default preference file. */
- $default_pref = $data_dir . '/default_pref';
+ if(substr($data_dir,-1) != '/') {
+ $data_dir .= '/';
+ }
+ $default_pref = $data_dir . 'default_pref';
/* If it is not there, check the internal data directory. */
if (!@file_exists($default_pref)) {
$errString = $errTitle . "<br>\n" .
_("Default preference file not found or not readable!") . "<br>\n" .
_("Please contact your system administrator and report this error.") . "<br>\n";
- include_once(SM_PATH . 'functions/display_messages.php' );
logout_error( $errString, $errTitle );
exit;
} else if (!@copy($default_pref, $filename)) {
_("Could not create initial preference file!") . "<br>\n" .
sprintf( _("%s should be writable by user %s"), $data_dir, $uid ) .
"<br>\n" . _("Please contact your system administrator and report this error.") . "<br>\n";
- include_once(SM_PATH . 'functions/display_messages.php' );
logout_error( $errString, $errTitle );
exit;
}
$filename = getHashedFile($username, $data_dir, "$username.si$number");
/* Open the file for writing, or else display an error to the user. */
if(!$file = @fopen("$filename.tmp", 'w')) {
- include_once( '../functions/display_messages.php' );
logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename . '.tmp') );
exit;
}
- $tmpwrite = @fwrite($file, $value);
- if ($tmpwrite == -1) {
- include_once( '../functions/display_messages.php' );
+ if ( sq_fwrite($file, $value) === FALSE ) {
logout_error( sprintf( _("Signature file, %s, could not be written. Contact your system administrator to resolve this issue.") , $filename . '.tmp'));
exit;
}
fclose($file);
- @copy($filename . '.tmp',$filename);
+ if (! @copy($filename . '.tmp',$filename) ) {
+ logout_error( sprintf( _("Signature file, %s, could not be copied from temporary file, %s. Contact your system administrator to resolve this issue."), $filename, $filename . '.tmp') );
+ exit;
+ }
@unlink($filename . '.tmp');
- chmod($filename, 0600);
+ @chmod($filename, 0600);
}
/* Open the file, or else display an error to the user. */
if(!$file = @fopen($filename, 'r'))
{
- include_once(SM_PATH . 'functions/display_messages.php');
logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
exit;
}