/**
* file_prefs.php
*
- * Copyright (c) 1999-2005 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
*
+ * @copyright © 1999-2009 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
+ * @subpackage prefs
+ * @since 1.2.5
*/
-/** include this for error messages */
-include_once(SM_PATH . 'functions/display_messages.php');
/**
* Check the preferences into the session cache.
+ *
+ * @param string $data_dir
+ * @param string $username
+ *
+ * @since 1.1.3
+ *
*/
function cachePrefValues($data_dir, $username) {
global $prefs_are_cached, $prefs_cache;
sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
if ( isset($prefs_are_cached) && $prefs_are_cached) {
sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
+// sm_print_r($prefs_cache);
+// exit;
return;
}
if ($equalsAt > 0) {
$key = substr($pref, 0, $equalsAt);
$value = substr($pref, $equalsAt + 1);
+
+//FIXME: this code is not in db_prefs.php that I can see
/* this is to 'rescue' old-style highlighting rules. */
if (substr($key, 0, 9) == 'highlight') {
$key = 'highlight' . $highlight_num;
$highlight_num ++;
}
+//FIXME: this code is not in db_prefs.php that I can see
if ($value != '') {
$prefs_cache[$key] = $value;
}
}
/**
- * Return the value for the preference given by $string.
+ * Return the value for the desired preference.
+ *
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @param string $pref_name preference name
+ * @param string $default (since 1.2.0) default preference value
+ *
+ * @return mixed
+ *
*/
-function getPref($data_dir, $username, $string, $default = '') {
+function getPref($data_dir, $username, $pref_name, $default = '') {
global $prefs_cache;
- $result = do_hook_function('get_pref_override',array($username,$string));
- if (!$result) {
+ $temp = array(&$username, &$pref_name);
+ $result = do_hook('get_pref_override', $temp);
+ if (is_null($result)) {
cachePrefValues($data_dir, $username);
- if (isset($prefs_cache[$string])) {
- $result = $prefs_cache[$string];
+ if (isset($prefs_cache[$pref_name])) {
+ $result = $prefs_cache[$pref_name];
} else {
- $result = do_hook_function('get_pref', array($username,$string));
- if (!$result) {
+//FIXME: is there a justification for having two prefs hooks so close? who uses them?
+ $temp = array(&$username, &$pref_name);
+ $result = do_hook('get_pref', $temp);
+ if (is_null($result)) {
$result = $default;
}
}
/**
* Save the preferences for this user.
+ *
+ * @param string $data_dir data directory
+ * @param string $username user name
+ *
+ * @since 1.1.3
+ *
*/
function savePrefValues($data_dir, $username) {
global $prefs_cache;
/**
* Remove a preference for the current user.
+ *
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @param string $pref_name preference name
+ *
*/
-function removePref($data_dir, $username, $string) {
+function removePref($data_dir, $username, $pref_name) {
global $prefs_cache;
cachePrefValues($data_dir, $username);
- if (isset($prefs_cache[$string])) {
- unset($prefs_cache[$string]);
+ if (isset($prefs_cache[$pref_name])) {
+ unset($prefs_cache[$pref_name]);
}
savePrefValues($data_dir, $username);
}
/**
- * Set a there preference $string to $value.
+ * Set the desired preference setting ($pref_name)
+ * to whatever is in $value.
+ *
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @param string $pref_name preference name
+ * @param mixed $value preference value
+ *
*/
-function setPref($data_dir, $username, $string, $value) {
+function setPref($data_dir, $username, $pref_name, $value) {
global $prefs_cache;
cachePrefValues($data_dir, $username);
- if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $value)) {
+ if (isset($prefs_cache[$pref_name]) && ($prefs_cache[$pref_name] == $value)) {
return;
}
if ($value === '') {
- removePref($data_dir, $username, $string);
+ removePref($data_dir, $username, $pref_name);
return;
}
- $prefs_cache[$string] = $value;
+ $prefs_cache[$pref_name] = $value;
savePrefValues($data_dir, $username);
}
/**
* Check for a preferences file. If one can not be found, create it.
+ *
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @param string $filename (since 1.2.0) preference file name.
+ * (OPTIONAL; default is an empty string,
+ * in which case the file name is
+ * automatically detected)
+ *
*/
function checkForPrefs($data_dir, $username, $filename = '') {
/* First, make sure we have the filename. */
( is_readable($default_pref) && !@copy($default_pref, $filename) ) ||
!@touch($filename)
) {
- $uid = 'httpd';
+ $uid = 'that the web server is running as';
if (function_exists('posix_getuid')){
$user_data = posix_getpwuid(posix_getuid());
$uid = $user_data['name'];
}
$errTitle = _("Could not create initial preference file!");
- $errString = $errTitle . "<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";
+ $errString = $errTitle . "\n" .
+ sprintf( _("%s should be writable by the user %s."), $data_dir, $uid ) . "\n" .
+ _("Please contact your system administrator and report this error.") ;
logout_error( $errString, $errTitle );
exit;
}
/**
* Write the User Signature.
+ *
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @param integer $number (since 1.2.5) identity number.
+ * (before 1.2.5., this parameter
+ * was used for the signature value)
+ * @param string $value (since 1.2.5) signature value
+ *
*/
function setSig($data_dir, $username, $number, $value) {
// Limit signature size to 64KB (database BLOB limit)
/**
* Get the signature.
+ *
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @param integer $number (since 1.2.5) identity number
+ *
+ * @return string signature
+ *
*/
function getSig($data_dir, $username, $number) {
$filename = getHashedFile($username, $data_dir, "$username.si$number");
}
// vim: et ts=4
-?>
\ No newline at end of file
projects / squirrelmail.git / blobdiff