/**
* prefs.php
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+ * This contains functions for filebased user prefs locations
*
- * This contains functions for manipulating user preferences
- *
- * $Id$
- */
-
-global $prefs_are_cached, $prefs_cache;
-if (!session_is_registered('prefs_are_cached')) {
- $prefs_are_cached = false;
- $prefs_cache = array();
-}
-
-/**
- * Check the preferences into the session cache.
- */
-function cachePrefValues($data_dir, $username) {
- global $prefs_are_cached, $prefs_cache;
-
- if ($prefs_are_cached) {
- return;
- }
-
- /* Calculate the filename for the user's preference file */
- $filename = getHashedFile($username, $data_dir, "$username.pref");
-
- /* A call to checkForPrefs here should take eliminate the need for
- /* this to be called throughout the rest of the SquirrelMail code.
- checkForPrefs($data_dir, $username, $filename);
-
- /* Make sure that the preference file now DOES exist. */
- if (!file_exists($filename)) {
- printf (_("Preference file, %s, does not exist. Log out, and log back in to create a default preference file."), $filename);
- exit;
- }
-
- $file = fopen($filename, 'r');
-
- /* Read in the preferences. */
- $highlight_num = 0;
- while (! feof($file)) {
- $pref = trim(fgets($file, 1024));
- $equalsAt = strpos($pref, '=');
- if ($equalsAt > 0) {
- $key = substr($pref, 0, $equalsAt);
- $value = substr($pref, $equalsAt + 1);
- if (substr($key, 0, 9) == 'highlight') {
- $key = 'highlight' . $highlight_num;
- $highlight_num ++;
- }
-
- if ($value != '') {
- $prefs_cache[$key] = $value;
- }
- }
- }
- fclose($file);
-
- session_unregister('prefs_cache');
- session_register('prefs_cache');
-
- $prefs_are_cached = true;
- session_unregister('prefs_are_cached');
- session_register('prefs_are_cached');
-}
-
-/**
- * Return the value for the prefernce given by $string.
- */
-function getPref($data_dir, $username, $string, $default = '') {
- global $prefs_cache;
- $result = '';
-
- cachePrefValues($data_dir, $username);
-
- if (isset($prefs_cache[$string])) {
- $result = $prefs_cache[$string];
- } else {
- $result = $default;
- }
-
- return ($result);
-}
-
-/**
- * Save the preferences for this user.
- */
-function savePrefValues($data_dir, $username) {
- global $prefs_cache;
-
- $filename = getHashedFile($username, $data_dir, "$username.pref");
-
- $file = fopen($filename, 'w');
- foreach ($prefs_cache as $Key => $Value) {
- if (isset($Value)) {
- fwrite($file, $Key . '=' . $Value . "\n");
- }
- }
- fclose($file);
-}
-
-/**
- * Remove a preference for the current user.
- */
-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);
-}
-
-/**
- * Set a there preference $string to $value.
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage prefs
*/
-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 === '') {
- removePref($data_dir, $username, $string);
- return;
- }
-
- $prefs_cache[$string] = $value;
- savePrefValues($data_dir, $username);
-}
-/**
- * Check for a preferences file. If one can not be found, create it.
- */
-function checkForPrefs($data_dir, $username, $filename = '') {
- /* First, make sure we have the filename. */
- if ($filename == '') {
- $filename = getHashedFile($username, $data_dir, "$username.pref");
- }
-
- /* Then, check if the file exists. */
- if (!file_exists($filename) ) {
- if (!copy($data_dir . 'default_pref', $filename)) {
- echo _("Error opening ") . $filename;
- exit;
- }
- }
-}
-/**
- * Write the User Signature.
- */
-function setSig($data_dir, $username, $value) {
- $filename = getHashedFile($username, $data_dir, "$username.sig");
- $file = fopen($filename, 'w');
- fwrite($file, $value);
- fclose($file);
-}
+/* Hashing functions */
/**
- * Get the signature.
+ * Given a username and datafilename, this will return the path to the
+ * hashed location of that datafile.
+ *
+ * @param string username the username of the current user
+ * @param string dir the SquirrelMail datadir
+ * @param string datafile the name of the file to open
+ * @param bool hash_seach default true
+ * @return string the hashed location of datafile
+ * @since 1.2.0
*/
-function getSig($data_dir, $username) {
- #$filename = $data_dir . $username . '.sig';
- $filename = getHashedFile($username, $data_dir, "$username.sig");
- $sig = '';
- if (file_exists($filename)) {
- $file = fopen($filename, 'r');
- while (!feof($file)) {
- $sig .= fgets($file, 1024);
- }
- fclose($file);
- }
- return $sig;
-}
-
function getHashedFile($username, $dir, $datafile, $hash_search = true) {
- global $dir_hash_level;
/* Remove trailing slash from $dir if found */
if (substr($dir, -1) == '/') {
$dir = substr($dir, 0, strlen($dir) - 1);
}
-
+
/* Compute the hash for this user and extract the hash directories. */
$hash_dirs = computeHashDirs($username);
/* First, get and make sure the full hash directory exists. */
$real_hash_dir = getHashedDir($username, $dir, $hash_dirs);
- /* Set the value of our real data file. */
+ /* Set the value of our real data file, after we've removed unwanted characters. */
+ $datafile = str_replace('/', '_', $datafile);
$result = "$real_hash_dir/$datafile";
/* Check for this file in the real hash directory. */
- if ($hash_search && !file_exists($result)) {
+ if ($hash_search && !@file_exists($result)) {
/* First check the base directory, the most common location. */
- if (file_exists("$dir/$datafile")) {
+ if (@file_exists("$dir/$datafile")) {
rename("$dir/$datafile", $result);
/* Then check the full range of possible hash directories. */
}
}
}
-
+
/* Return the full hashed datafile path. */
return ($result);
}
+/**
+ * Helper function for getHashedFile, given a username returns the hashed
+ * dir for that username.
+ *
+ * @param string username the username of the current user
+ * @param string dir the SquirrelMail datadir
+ * @param string hash_dirs default ''
+ * @return the path to the hash dir for username
+ * @since 1.2.0
+ */
function getHashedDir($username, $dir, $hash_dirs = '') {
global $dir_hash_level;
+ /* Remove trailing slash from $dir if found */
+ if (substr($dir, -1) == '/') {
+ $dir = substr($dir, 0, strlen($dir) - 1);
+ }
+
/* If necessary, populate the hash dir variable. */
if ($hash_dirs == '') {
$hash_dirs = computeHashDirs($username);
$real_hash_dir = $dir;
for ($h = 0; $h < $dir_hash_level; ++$h) {
$real_hash_dir .= '/' . $hash_dirs[$h];
- if (!is_dir($real_hash_dir)) {
- mkdir($real_hash_dir, 0770);
+ if (!@is_dir($real_hash_dir)) {
+//FIXME: When safe_mode is turned on, the error suppression below makes debugging safe_mode UID/GID restrictions tricky... for now, I will add a check in configtest
+ if (!@mkdir($real_hash_dir, 0770)) {
+ error_box ( sprintf(_("Error creating directory %s."), $real_hash_dir) . "\n" .
+ _("Could not create hashed directory structure!") . "\n" .
+ _("Please contact your system administrator and report this error.") );
+ exit;
+ }
}
}
return ($real_hash_dir);
}
+/**
+ * Helper function for getHashDir which does the actual hash calculation.
+ *
+ * @param string username the username to calculate the hash dir for
+ * @return array a list of hash dirs for this username
+ * @since 1.2.0
+ */
function computeHashDirs($username) {
- /* Compute the hash for this user and extract the hash directories. */
- $hash = base_convert(crc32($username), 10, 16);
+ /* Compute the hash for this user and extract the hash directories. */
+ /* Note that the crc32() function result will be different on 32 and */
+ /* 64 bit systems, thus the hack below. */
+ $crc = crc32($username);
+ if ($crc & 0x80000000) {
+ $crc ^= 0xffffffff;
+ $crc += 1;
+ }
+ $hash = base_convert($crc, 10, 16);
$hash_dirs = array();
for ($h = 0; $h < 4; ++ $h) {
$hash_dirs[] = substr($hash, $h, 1);
/* Return our array of hash directories. */
return ($hash_dirs);
}
-
-?>
projects / squirrelmail.git / blobdiff