Still updating changelog...
[squirrelmail.git] / functions / prefs.php
CommitLineData
59177427 1<?php
2ba13803 2
35586184 3/**
4 * prefs.php
5 *
15e6162e 6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
35586184 7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
9 * This contains functions for manipulating user preferences
10 *
11 * $Id$
12 */
13
35586184 14global $prefs_are_cached, $prefs_cache;
15if (!session_is_registered('prefs_are_cached')) {
16 $prefs_are_cached = false;
17 $prefs_cache = array();
18}
31ac7db8 19
7b294953 20/**
21 * Check the preferences into the session cache.
22 */
23function cachePrefValues($data_dir, $username) {
24 global $prefs_are_cached, $prefs_cache;
31ac7db8 25
7b294953 26 if ($prefs_are_cached) {
27 return;
28 }
29
165829a3 30 /* Calculate the filename for the user's preference file */
3392dc86 31 $filename = getHashedFile($username, $data_dir, "$username.pref");
7b294953 32
a15af05b 33 /* A call to checkForPrefs here should take eliminate the need for
34 /* this to be called throughout the rest of the SquirrelMail code.
35 checkForPrefs($data_dir, $username, $filename);
36
37 /* Make sure that the preference file now DOES exist. */
7b294953 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);
40 exit;
41 }
42
43 $file = fopen($filename, 'r');
44
45 /* Read in the preferences. */
46 $highlight_num = 0;
47 while (! feof($file)) {
48 $pref = trim(fgets($file, 1024));
49 $equalsAt = strpos($pref, '=');
50 if ($equalsAt > 0) {
51 $key = substr($pref, 0, $equalsAt);
52 $value = substr($pref, $equalsAt + 1);
53 if (substr($key, 0, 9) == 'highlight') {
54 $key = 'highlight' . $highlight_num;
55 $highlight_num ++;
56 }
57
58 if ($value != '') {
59 $prefs_cache[$key] = $value;
60 }
61 }
62 }
63 fclose($file);
64
65 session_unregister('prefs_cache');
66 session_register('prefs_cache');
31ac7db8 67
7b294953 68 $prefs_are_cached = true;
69 session_unregister('prefs_are_cached');
70 session_register('prefs_are_cached');
71}
31ac7db8 72
7b294953 73/**
74 * Return the value for the prefernce given by $string.
75 */
76function getPref($data_dir, $username, $string, $default = '') {
77 global $prefs_cache;
78 $result = '';
79
80 cachePrefValues($data_dir, $username);
81
82 if (isset($prefs_cache[$string])) {
83 $result = $prefs_cache[$string];
84 } else {
85 $result = $default;
86 }
87
88 return ($result);
89}
90
91/**
92 * Save the preferences for this user.
93 */
94function savePrefValues($data_dir, $username) {
95 global $prefs_cache;
31ac7db8 96
3392dc86 97 $filename = getHashedFile($username, $data_dir, "$username.pref");
98
99 $file = fopen($filename, 'w');
7b294953 100 foreach ($prefs_cache as $Key => $Value) {
101 if (isset($Value)) {
102 fwrite($file, $Key . '=' . $Value . "\n");
103 }
104 }
105 fclose($file);
106}
107
108/**
109 * Remove a preference for the current user.
110 */
111function removePref($data_dir, $username, $string) {
112 global $prefs_cache;
113
114 cachePrefValues($data_dir, $username);
115
116 if (isset($prefs_cache[$string])) {
117 unset($prefs_cache[$string]);
118 }
119
120 savePrefValues($data_dir, $username);
121}
f804972b 122
7b294953 123/**
124 * Set a there preference $string to $value.
125 */
126function setPref($data_dir, $username, $string, $value) {
127 global $prefs_cache;
f804972b 128
7b294953 129 cachePrefValues($data_dir, $username);
130 if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $value)) {
131 return;
132 }
f804972b 133
7b294953 134 if ($value === '') {
135 removePref($data_dir, $username, $string);
136 return;
137 }
f804972b 138
7b294953 139 $prefs_cache[$string] = $value;
140 savePrefValues($data_dir, $username);
141}
f804972b 142
7b294953 143/**
144 * Check for a preferences file. If one can not be found, create it.
145 */
a15af05b 146function checkForPrefs($data_dir, $username, $filename = '') {
147 /* First, make sure we have the filename. */
148 if ($filename == '') {
149 $filename = getHashedFile($username, $data_dir, "$username.pref");
150 }
151
152 /* Then, check if the file exists. */
7b294953 153 if (!file_exists($filename) ) {
154 if (!copy($data_dir . 'default_pref', $filename)) {
155 echo _("Error opening ") . $filename;
156 exit;
157 }
158 }
159}
160
161/**
162 * Write the User Signature.
163 */
164function setSig($data_dir, $username, $value) {
3392dc86 165 $filename = getHashedFile($username, $data_dir, "$username.sig");
166 $file = fopen($filename, 'w');
7b294953 167 fwrite($file, $value);
168 fclose($file);
169}
170
171/**
172 * Get the signature.
173 */
174function getSig($data_dir, $username) {
3392dc86 175 #$filename = $data_dir . $username . '.sig';
176 $filename = getHashedFile($username, $data_dir, "$username.sig");
7b294953 177 $sig = '';
178 if (file_exists($filename)) {
179 $file = fopen($filename, 'r');
180 while (!feof($file)) {
f804972b 181 $sig .= fgets($file, 1024);
7b294953 182 }
183 fclose($file);
184 }
185 return $sig;
186}
fb120846 187
3392dc86 188function getHashedFile($username, $dir, $datafile, $hash_search = true) {
189 global $dir_hash_level;
190
311339a0 191 /* Remove trailing slash from $dir if found */
192 if (substr($dir, -1) == '/') {
193 $dir = substr($dir, 0, strlen($dir) - 1);
194 }
195
3392dc86 196 /* Compute the hash for this user and extract the hash directories. */
197 $hash_dirs = computeHashDirs($username);
198
199 /* First, get and make sure the full hash directory exists. */
200 $real_hash_dir = getHashedDir($username, $dir, $hash_dirs);
201
202 /* Set the value of our real data file. */
203 $result = "$real_hash_dir/$datafile";
204
205 /* Check for this file in the real hash directory. */
206 if ($hash_search && !file_exists($result)) {
207 /* First check the base directory, the most common location. */
208 if (file_exists("$dir/$datafile")) {
209 rename("$dir/$datafile", $result);
210
211 /* Then check the full range of possible hash directories. */
212 } else {
213 $check_hash_dir = $dir;
214 for ($h = 0; $h < 4; ++$h) {
215 $check_hash_dir .= '/' . $hash_dirs[$h];
311339a0 216 if (@is_readable("$check_hash_dir/$datafile")) {
3392dc86 217 rename("$check_hash_dir/$datafile", $result);
218 break;
219 }
220 }
221 }
222 }
223
224 /* Return the full hashed datafile path. */
225 return ($result);
226}
227
228function getHashedDir($username, $dir, $hash_dirs = '') {
229 global $dir_hash_level;
230
231 /* If necessary, populate the hash dir variable. */
232 if ($hash_dirs == '') {
233 $hash_dirs = computeHashDirs($username);
234 }
235
236 /* Make sure the full hash directory exists. */
237 $real_hash_dir = $dir;
238 for ($h = 0; $h < $dir_hash_level; ++$h) {
239 $real_hash_dir .= '/' . $hash_dirs[$h];
240 if (!is_dir($real_hash_dir)) {
241 mkdir($real_hash_dir, 0770);
242 }
243 }
244
245 /* And return that directory. */
246 return ($real_hash_dir);
247}
248
249function computeHashDirs($username) {
250 /* Compute the hash for this user and extract the hash directories. */
251 $hash = base_convert(crc32($username), 10, 16);
252 $hash_dirs = array();
253 for ($h = 0; $h < 4; ++ $h) {
254 $hash_dirs[] = substr($hash, $h, 1);
255 }
256
257 /* Return our array of hash directories. */
258 return ($hash_dirs);
259}
260
35586184 261?>