X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fprefs.php;h=4924441981f98b36b7f289b165ab8bb7784e3ab7;hb=c3806a9dc07e4bf45491e7120a1c931332f2e555;hp=a41121353c419915121a8a56083177dad65767e9;hpb=7b2949532ae7903671660d4c8cbf922d4c92478e;p=squirrelmail.git diff --git a/functions/prefs.php b/functions/prefs.php index a4112135..49244419 100644 --- a/functions/prefs.php +++ b/functions/prefs.php @@ -3,171 +3,127 @@ /** * prefs.php * - * Copyright (c) 1999-2001 The SquirrelMail Development 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. + * @copyright © 1999-2006 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @version $Id$ + * @package squirrelmail + * @subpackage prefs */ -function cachePrefValues($data_dir, $username) { - global $prefs_are_cached, $prefs_cache; - - if ($prefs_are_cached) { - return; - } - $filename = $data_dir . $username . '.pref'; - 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 ++; - } +/* Hashing functions */ - 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. + * 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 getPref($data_dir, $username, $string, $default = '') { - global $prefs_cache; - $result = ''; +function getHashedFile($username, $dir, $datafile, $hash_search = true) { - cachePrefValues($data_dir, $username); - - if (isset($prefs_cache[$string])) { - $result = $prefs_cache[$string]; - } else { - $result = $default; + /* Remove trailing slash from $dir if found */ + if (substr($dir, -1) == '/') { + $dir = substr($dir, 0, strlen($dir) - 1); } - return ($result); -} - -/** - * Save the preferences for this user. - */ -function savePrefValues($data_dir, $username) { - global $prefs_cache; - - $file = fopen($data_dir . $username . '.pref', 'w'); - foreach ($prefs_cache as $Key => $Value) { - if (isset($Value)) { - fwrite($file, $Key . '=' . $Value . "\n"); + /* 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, 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)) { + /* First check the base directory, the most common location. */ + if (@file_exists("$dir/$datafile")) { + rename("$dir/$datafile", $result); + + /* Then check the full range of possible hash directories. */ + } else { + $check_hash_dir = $dir; + for ($h = 0; $h < 4; ++$h) { + $check_hash_dir .= '/' . $hash_dirs[$h]; + if (@is_readable("$check_hash_dir/$datafile")) { + rename("$check_hash_dir/$datafile", $result); + break; + } + } } } - 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); + /* Return the full hashed datafile path. */ + return ($result); } /** - * Set a there preference $string to $value. + * 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 setPref($data_dir, $username, $string, $value) { - global $prefs_cache; +function getHashedDir($username, $dir, $hash_dirs = '') { + global $dir_hash_level; - cachePrefValues($data_dir, $username); - if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $value)) { - return; + /* Remove trailing slash from $dir if found */ + if (substr($dir, -1) == '/') { + $dir = substr($dir, 0, strlen($dir) - 1); } - if ($value === '') { - removePref($data_dir, $username, $string); - return; + /* If necessary, populate the hash dir variable. */ + if ($hash_dirs == '') { + $hash_dirs = computeHashDirs($username); } - $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 = $data_dir . $username . '.pref'; - if (!file_exists($filename) ) { - if (!copy($data_dir . 'default_pref', $filename)) { - echo _("Error opening ") . $filename; - exit; + /* Make sure the full hash directory exists. */ + $real_hash_dir = $dir; + for ($h = 0; $h < $dir_hash_level; ++$h) { + $real_hash_dir .= '/' . $hash_dirs[$h]; + if (!@is_dir($real_hash_dir)) { + if (!@mkdir($real_hash_dir, 0770)) { + echo sprintf(_("Error creating directory %s."), $real_hash_dir) . '
' . + _("Could not create hashed directory structure!") . "
\n" . + _("Please contact your system administrator and report this error.") . "
\n"; + exit; + } } } -} -/** - * Write the User Signature. - */ -function setSig($data_dir, $username, $value) { - $file = fopen($data_dir . $username . '.sig', 'w'); - fwrite($file, $value); - fclose($file); + /* And return that directory. */ + return ($real_hash_dir); } /** - * Get the signature. + * 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 getSig($data_dir, $username) { - $filename = $data_dir . $username . '.sig'; - $sig = ''; - if (file_exists($filename)) { - $file = fopen($filename, 'r'); - while (!feof($file)) { - $sig .= fgets($file, 1024); - } - fclose($file); +function computeHashDirs($username) { + /* Compute the hash for this user and extract the hash directories. */ + $hash = base_convert(crc32($username), 10, 16); + $hash_dirs = array(); + for ($h = 0; $h < 4; ++ $h) { + $hash_dirs[] = substr($hash, $h, 1); } - return $sig; -} -?> + /* Return our array of hash directories. */ + return ($hash_dirs); +} +?> \ No newline at end of file