10e29f4aae41dbd7fe0bcd73b1e6b5626edd56f9
6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This contains functions for manipulating user preferences
14 global $prefs_are_cached, $prefs_cache;
15 if (!session_is_registered('prefs_are_cached')) {
16 $prefs_are_cached = false;
17 $prefs_cache = array();
21 * Check the preferences into the session cache.
23 function cachePrefValues($data_dir, $username) {
24 global $prefs_are_cached, $prefs_cache;
26 if ($prefs_are_cached) {
30 /* A call to checkForPrefs here should take eliminate the need for
31 /* this to be called throughout the rest of the SquirrelMail code.
32 checkForPrefs($data_dir, $username);
34 /* Calculate the filename for the user's preference file */
35 $filename = getHashedFile($username, $data_dir, "$username.pref");
37 checkForPrefs($data_dir, $username);ยบ
38 if (!file_exists($filename)) {
39 printf (_("Preference file, %s, does not exist. Log out, and log back in to create a default preference file."), $filename);
43 $file = fopen($filename, 'r');
45 /* Read in the preferences. */
47 while (! feof($file)) {
48 $pref = trim(fgets($file, 1024));
49 $equalsAt = strpos($pref, '=');
51 $key = substr($pref, 0, $equalsAt);
52 $value = substr($pref, $equalsAt +
1);
53 if (substr($key, 0, 9) == 'highlight') {
54 $key = 'highlight' . $highlight_num;
59 $prefs_cache[$key] = $value;
65 session_unregister('prefs_cache');
66 session_register('prefs_cache');
68 $prefs_are_cached = true;
69 session_unregister('prefs_are_cached');
70 session_register('prefs_are_cached');
74 * Return the value for the prefernce given by $string.
76 function getPref($data_dir, $username, $string, $default = '') {
80 cachePrefValues($data_dir, $username);
82 if (isset($prefs_cache[$string])) {
83 $result = $prefs_cache[$string];
92 * Save the preferences for this user.
94 function savePrefValues($data_dir, $username) {
97 $filename = getHashedFile($username, $data_dir, "$username.pref");
99 $file = fopen($filename, 'w');
100 foreach ($prefs_cache as $Key => $Value) {
102 fwrite($file, $Key . '=' . $Value . "\n");
109 * Remove a preference for the current user.
111 function removePref($data_dir, $username, $string) {
114 cachePrefValues($data_dir, $username);
116 if (isset($prefs_cache[$string])) {
117 unset($prefs_cache[$string]);
120 savePrefValues($data_dir, $username);
124 * Set a there preference $string to $value.
126 function setPref($data_dir, $username, $string, $value) {
129 cachePrefValues($data_dir, $username);
130 if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $value)) {
135 removePref($data_dir, $username, $string);
139 $prefs_cache[$string] = $value;
140 savePrefValues($data_dir, $username);
144 * Check for a preferences file. If one can not be found, create it.
146 function checkForPrefs($data_dir, $username) {
147 $filename = getHashedFile($username, $data_dir, "$username.pref");
148 if (!file_exists($filename) ) {
149 if (!copy($data_dir . 'default_pref', $filename)) {
150 echo _("Error opening ") . $filename;
157 * Write the User Signature.
159 function setSig($data_dir, $username, $value) {
160 $filename = getHashedFile($username, $data_dir, "$username.sig");
161 $file = fopen($filename, 'w');
162 fwrite($file, $value);
169 function getSig($data_dir, $username) {
170 #$filename = $data_dir . $username . '.sig';
171 $filename = getHashedFile($username, $data_dir, "$username.sig");
173 if (file_exists($filename)) {
174 $file = fopen($filename, 'r');
175 while (!feof($file)) {
176 $sig .= fgets($file, 1024);
183 function getHashedFile($username, $dir, $datafile, $hash_search = true) {
184 global $dir_hash_level;
186 /* Remove trailing slash from $dir if found */
187 if (substr($dir, -1) == '/') {
188 $dir = substr($dir, 0, strlen($dir) - 1);
191 /* Compute the hash for this user and extract the hash directories. */
192 $hash_dirs = computeHashDirs($username);
194 /* First, get and make sure the full hash directory exists. */
195 $real_hash_dir = getHashedDir($username, $dir, $hash_dirs);
197 /* Set the value of our real data file. */
198 $result = "$real_hash_dir/$datafile";
200 /* Check for this file in the real hash directory. */
201 if ($hash_search && !file_exists($result)) {
202 /* First check the base directory, the most common location. */
203 if (file_exists("$dir/$datafile")) {
204 rename("$dir/$datafile", $result);
206 /* Then check the full range of possible hash directories. */
208 $check_hash_dir = $dir;
209 for ($h = 0; $h < 4; ++
$h) {
210 $check_hash_dir .= '/' . $hash_dirs[$h];
211 if (@is_readable
("$check_hash_dir/$datafile")) {
212 rename("$check_hash_dir/$datafile", $result);
219 /* Return the full hashed datafile path. */
223 function getHashedDir($username, $dir, $hash_dirs = '') {
224 global $dir_hash_level;
226 /* If necessary, populate the hash dir variable. */
227 if ($hash_dirs == '') {
228 $hash_dirs = computeHashDirs($username);
231 /* Make sure the full hash directory exists. */
232 $real_hash_dir = $dir;
233 for ($h = 0; $h < $dir_hash_level; ++
$h) {
234 $real_hash_dir .= '/' . $hash_dirs[$h];
235 if (!is_dir($real_hash_dir)) {
236 mkdir($real_hash_dir, 0770);
240 /* And return that directory. */
241 return ($real_hash_dir);
244 function computeHashDirs($username) {
245 /* Compute the hash for this user and extract the hash directories. */
246 $hash = base_convert(crc32($username), 10, 16);
247 $hash_dirs = array();
248 for ($h = 0; $h < 4; ++
$h) {
249 $hash_dirs[] = substr($hash, $h, 1);
252 /* Return our array of hash directories. */