1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
|
<?php
/**
* file_prefs.php
*
* This contains functions for manipulating user preferences in files
*
* @copyright 1999-2015 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
* @subpackage prefs
* @since 1.2.5
*/
/**
* Check the preferences into the session cache.
*
* @param string $data_dir
* @param string $username
*
* @since 1.1.3
*
*/
function cachePrefValues($data_dir, $username) {
global $prefs_are_cached, $prefs_cache;
sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
if ( isset($prefs_are_cached) && $prefs_are_cached) {
sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
// sm_print_r($prefs_cache);
// exit;
return;
}
sqsession_unregister('prefs_cache');
sqsession_unregister('prefs_are_cached');
/* 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)) {
logout_error( sprintf( _("Preference file, %s, does not exist. Log out, and log back in to create a default preference file."), $filename) );
exit;
}
/* Open the file, or else display an error to the user. */
if(!$file = @fopen($filename, 'r'))
{
logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
exit;
}
/* Read in the preferences. */
$highlight_num = 0;
while (! feof($file)) {
$pref = '';
/* keep reading a pref until we reach an eol (\n (or \r for macs)) */
while($read = fgets($file, 1024))
{
$pref .= $read;
if(strpos($read,"\n") || strpos($read,"\r"))
break;
}
$pref = trim($pref);
$equalsAt = strpos($pref, '=');
if ($equalsAt > 0) {
$key = substr($pref, 0, $equalsAt);
$value = substr($pref, $equalsAt + 1);
//FIXME: this code is not in db_prefs.php that I can see
/* this is to 'rescue' old-style highlighting rules. */
if (substr($key, 0, 9) == 'highlight') {
$key = 'highlight' . $highlight_num;
$highlight_num ++;
}
//FIXME: this code is not in db_prefs.php that I can see
if ($value != '') {
$prefs_cache[$key] = $value;
}
}
}
fclose($file);
$prefs_are_cached = TRUE;
sqsession_register($prefs_cache, 'prefs_cache');
sqsession_register($prefs_are_cached, 'prefs_are_cached');
}
/**
* Return the value for the desired preference.
*
* @param string $data_dir data directory
* @param string $username user name
* @param string $pref_name preference name
* @param string $default (since 1.2.0) default preference value
*
* @return mixed
*
*/
function getPref($data_dir, $username, $pref_name, $default = '') {
global $prefs_cache;
$temp = array(&$username, &$pref_name);
$result = do_hook('get_pref_override', $temp);
if (is_null($result)) {
cachePrefValues($data_dir, $username);
if (isset($prefs_cache[$pref_name])) {
$result = $prefs_cache[$pref_name];
} else {
//FIXME: is there a justification for having two prefs hooks so close? who uses them?
$temp = array(&$username, &$pref_name);
$result = do_hook('get_pref', $temp);
if (is_null($result)) {
$result = $default;
}
}
}
return ($result);
}
/**
* Save the preferences for this user.
*
* @param string $data_dir data directory
* @param string $username user name
*
* @since 1.1.3
*
*/
function savePrefValues($data_dir, $username) {
global $prefs_cache;
$filename = getHashedFile($username, $data_dir, "$username.pref");
/* Open the file for writing, or else display an error to the user. */
if(!$file = @fopen($filename.'.tmp', 'w'))
{
logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename.'.tmp') );
exit;
}
foreach ($prefs_cache as $Key => $Value) {
if (isset($Value)) {
if ( sq_fwrite($file, $Key . '=' . $Value . "\n") === FALSE ) {
logout_error( sprintf( _("Preference file, %s, could not be written. Contact your system administrator to resolve this issue.") , $filename . '.tmp') );
exit;
}
}
}
fclose($file);
if (! @copy($filename . '.tmp',$filename) ) {
logout_error( sprintf( _("Preference file, %s, could not be copied from temporary file, %s. Contact your system administrator to resolve this issue."), $filename, $filename . '.tmp') );
exit;
}
@unlink($filename . '.tmp');
@chmod($filename, 0600);
sqsession_register($prefs_cache , 'prefs_cache');
}
/**
* Remove a preference for the current user.
*
* @param string $data_dir data directory
* @param string $username user name
* @param string $pref_name preference name
*
*/
function removePref($data_dir, $username, $pref_name) {
global $prefs_cache;
cachePrefValues($data_dir, $username);
if (isset($prefs_cache[$pref_name])) {
unset($prefs_cache[$pref_name]);
}
savePrefValues($data_dir, $username);
}
/**
* Set the desired preference setting ($pref_name)
* to whatever is in $value.
*
* @param string $data_dir data directory
* @param string $username user name
* @param string $pref_name preference name
* @param mixed $value preference value
*
*/
function setPref($data_dir, $username, $pref_name, $value) {
global $prefs_cache;
cachePrefValues($data_dir, $username);
if (isset($prefs_cache[$pref_name]) && ($prefs_cache[$pref_name] == $value)) {
return;
}
if ($value === '') {
removePref($data_dir, $username, $pref_name);
return;
}
$prefs_cache[$pref_name] = $value;
savePrefValues($data_dir, $username);
}
/**
* Check for a preferences file. If one can not be found, create it.
*
* @param string $data_dir data directory
* @param string $username user name
* @param string $filename (since 1.2.0) preference file name.
* (OPTIONAL; default is an empty string,
* in which case the file name is
* automatically detected)
*
*/
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 it does not exist, check for default_prefs */
/* First, check legacy locations: data dir */
if(substr($data_dir,-1) != '/') {
$data_dir .= '/';
}
$default_pref = $data_dir . 'default_pref';
/* or legacy location: internal data dir */
if (!@file_exists($default_pref)) {
$default_pref = SM_PATH . 'data/default_pref';
}
/* If no legacies, check where we'd expect it to be located:
* under config/ */
if (!@file_exists($default_pref)) {
$default_pref = SM_PATH . 'config/default_pref';
}
/* If a default_pref file found, try to copy it, if none found,
* try to create an empty one. If that fails, report an error.
*/
if (
( is_readable($default_pref) && !@copy($default_pref, $filename) ) ||
!@touch($filename)
) {
$uid = 'that the web server is running as';
if (function_exists('posix_getuid')){
$user_data = posix_getpwuid(posix_getuid());
$uid = $user_data['name'];
}
$errTitle = _("Could not create initial preference file!");
$errString = $errTitle . "\n" .
sprintf( _("%s should be writable by the user %s."), $data_dir, $uid ) . "\n" .
_("Please contact your system administrator and report this error.") ;
logout_error( $errString, $errTitle );
exit;
}
}
}
/**
* Write the User Signature.
*
* @param string $data_dir data directory
* @param string $username user name
* @param integer $number (since 1.2.5) identity number.
* (before 1.2.5., this parameter
* was used for the signature value)
* @param string $value (since 1.2.5) signature value
*
*/
function setSig($data_dir, $username, $number, $value) {
// Limit signature size to 64KB (database BLOB limit)
if (strlen($value)>65536) {
error_option_save(_("Signature is too big."));
return;
}
$filename = getHashedFile($username, $data_dir, "$username.si$number");
/* Open the file for writing, or else display an error to the user. */
if(!$file = @fopen("$filename.tmp", 'w')) {
logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename . '.tmp') );
exit;
}
if ( sq_fwrite($file, $value) === FALSE ) {
logout_error( sprintf( _("Signature file, %s, could not be written. Contact your system administrator to resolve this issue.") , $filename . '.tmp'));
exit;
}
fclose($file);
if (! @copy($filename . '.tmp',$filename) ) {
logout_error( sprintf( _("Signature file, %s, could not be copied from temporary file, %s. Contact your system administrator to resolve this issue."), $filename, $filename . '.tmp') );
exit;
}
@unlink($filename . '.tmp');
@chmod($filename, 0600);
}
/**
* Get the signature.
*
* @param string $data_dir data directory
* @param string $username user name
* @param integer $number (since 1.2.5) identity number
*
* @return string signature
*
*/
function getSig($data_dir, $username, $number) {
$filename = getHashedFile($username, $data_dir, "$username.si$number");
$sig = '';
if (file_exists($filename)) {
/* Open the file, or else display an error to the user. */
if(!$file = @fopen($filename, 'r'))
{
logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
exit;
}
while (!feof($file)) {
$sig .= fgets($file, 1024);
}
fclose($file);
}
return $sig;
}
// vim: et ts=4
|