X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fprefs.php;h=517beddad66f254c914870fcfb1899c5935eb06e;hb=b73988490e98f127157d787b66317c15857af9a8;hp=4430a191cd6e8912d5f8684184994831d0cfbccc;hpb=355861846a51d35efe50848869d680fd3b4a5316;p=squirrelmail.git diff --git a/functions/prefs.php b/functions/prefs.php index 4430a191..517bedda 100644 --- a/functions/prefs.php +++ b/functions/prefs.php @@ -3,168 +3,134 @@ /** * 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 + * @copyright © 1999-2009 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @version $Id$ + * @package squirrelmail + * @subpackage prefs + */ + + + +/* Hashing functions */ + +/** + * Given a username and datafilename, this will return the path to the + * hashed location of that datafile. * - * $Id$ + * @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 getHashedFile($username, $dir, $datafile, $hash_search = true) { + + /* 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, 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; + } + } + } + } + + /* Return the full hashed datafile path. */ + return ($result); +} -/*****************************************************************/ -/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!! ***/ -/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION. ***/ -/*** + Base level indent should begin at left margin, as ***/ -/*** the $prefs_are_cached and $prefs_cache stuff below. ***/ -/*** + All identation should consist of four space blocks ***/ -/*** + Tab characters are evil. ***/ -/*** + all comments should use "slash-star ... star-slash" ***/ -/*** style -- no pound characters, no slash-slash style ***/ -/*** + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD ***/ -/*** ALWAYS USE { AND } CHARACTERS!!! ***/ -/*** + Please use ' instead of ", when possible. Note " ***/ -/*** should always be used in _( ) function calls. ***/ -/*** Thank you for your help making the SM code more readable. ***/ -/*****************************************************************/ - -global $prefs_are_cached, $prefs_cache; -if (!session_is_registered('prefs_are_cached')) { - $prefs_are_cached = false; - $prefs_cache = array(); +/** + * 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); + } + + /* 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)) { +//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; + } + } + } + + /* And return that directory. */ + return ($real_hash_dir); } - 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 all 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'); - } - - - /** returns the value for $string **/ - function getPref($data_dir, $username, $string, $default = '') { - global $prefs_cache; - - cachePrefValues($data_dir, $username); - - if (isset($prefs_cache[$string])) - return $prefs_cache[$string]; - else - return $default; - } - - - 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"); - } - } - fclose($file); - } - - - 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); - } - - /** sets the pref, $string, to $set_to **/ - function setPref($data_dir, $username, $string, $set_to) { - global $prefs_cache; - - cachePrefValues($data_dir, $username); - if (isset($prefs_cache[$string]) && $prefs_cache[$string] == $set_to) - return; - if ($set_to === '') { - removePref($data_dir, $username, $string); - return; - } - $prefs_cache[$string] = $set_to; - savePrefValues($data_dir, $username); - } - - - /** This checks if there is a pref file, if there isn't, it will - 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; - } - } - } - - - /** Writes the Signature **/ - function setSig($data_dir, $username, $string) { - $file = fopen($data_dir . $username . '.sig', 'w'); - fwrite($file, $string); - fclose($file); - } - - - - /** Gets the signature **/ - 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); - } - return $sig; - } - -?> +/** + * 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. */ + /* 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); +}