the html was horrible, and it nuked netscape in displaying it all well
[squirrelmail.git] / functions / file_prefs.php
CommitLineData
3499f99f 1<?php
2
3/**
4 * file_prefs.php
5 *
6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
9 * This contains functions for manipulating user preferences in files
10 *
11 * $Id$
12 */
13
3499f99f 14/**
15 * Check the preferences into the session cache.
16 */
17function cachePrefValues($data_dir, $username) {
18 global $prefs_are_cached, $prefs_cache;
19
20 if ( isset($prefs_are_cached) && $prefs_are_cached) {
21 return;
22 }
23
9eb0fbd4 24 sqsession_unregister('prefs_cache');
25 sqsession_unregister('prefs_are_cached');
3499f99f 26
27 /* Calculate the filename for the user's preference file */
28 $filename = getHashedFile($username, $data_dir, "$username.pref");
29
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, $filename);
33
34 /* Make sure that the preference file now DOES exist. */
35 if (!file_exists($filename)) {
bd9c880b 36 include_once(SM_PATH . 'functions/display_messages.php');
9be8198d 37 logout_error( sprintf( _("Preference file, %s, does not exist. Log out, and log back in to create a default preference file."), $filename) );
3499f99f 38 exit;
39 }
40
35b5fa13 41 /* Open the file, or else display an error to the user. */
42 if(!$file = @fopen($filename, 'r'))
43 {
bd9c880b 44 include_once(SM_PATH . 'functions/display_messages.php');
35b5fa13 45 logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
46 exit;
47 }
3499f99f 48
49 /* Read in the preferences. */
50 $highlight_num = 0;
51 while (! feof($file)) {
52 $pref = trim(fgets($file, 1024));
53 $equalsAt = strpos($pref, '=');
54 if ($equalsAt > 0) {
55 $key = substr($pref, 0, $equalsAt);
56 $value = substr($pref, $equalsAt + 1);
57 if (substr($key, 0, 9) == 'highlight') {
58 $key = 'highlight' . $highlight_num;
59 $highlight_num ++;
60 }
61
62 if ($value != '') {
63 $prefs_cache[$key] = $value;
64 }
65 }
66 }
67 fclose($file);
68
69 $prefs_are_cached = TRUE;
70
9eb0fbd4 71 sqsession_register($prefs_cache, 'prefs_cache');
72 sqsession_register($prefs_are_cached, 'prefs_are_cached');
3499f99f 73}
74
75/**
76 * Return the value for the prefernce given by $string.
77 */
78function getPref($data_dir, $username, $string, $default = '') {
79 global $prefs_cache;
80 $result = '';
81
397a9d7b 82 $result = do_hook_function('get_pref_override', array($username, $string));
3499f99f 83
397a9d7b 84 if ($result == '') {
85 cachePrefValues($data_dir, $username);
86
87 if (isset($prefs_cache[$string])) {
88 $result = $prefs_cache[$string];
89 } else {
90 $result = do_hook_function('get_pref', array($username, $string));
91 if ($result == '') {
92 $result = $default;
93 }
94 }
3499f99f 95 }
96
97 return ($result);
98}
99
100/**
101 * Save the preferences for this user.
102 */
103function savePrefValues($data_dir, $username) {
104 global $prefs_cache;
105
106 $filename = getHashedFile($username, $data_dir, "$username.pref");
107
35b5fa13 108 /* Open the file for writing, or else display an error to the user. */
45df3062 109 if(!$file = @fopen($filename.'.tmp', 'w'))
35b5fa13 110 {
bd9c880b 111 include_once(SM_PATH . 'functions/display_messages.php');
45df3062 112 logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename.'.tmp') );
35b5fa13 113 exit;
114 }
115
3499f99f 116 foreach ($prefs_cache as $Key => $Value) {
117 if (isset($Value)) {
118 fwrite($file, $Key . '=' . $Value . "\n");
119 }
120 }
121 fclose($file);
45df3062 122 copy($filename.'.tmp', $filename);
123 unlink($filename.'.tmp');
3499f99f 124 chmod($filename, 0600);
125}
126
127/**
128 * Remove a preference for the current user.
129 */
130function removePref($data_dir, $username, $string) {
131 global $prefs_cache;
132
133 cachePrefValues($data_dir, $username);
134
135 if (isset($prefs_cache[$string])) {
136 unset($prefs_cache[$string]);
137 }
138
139 savePrefValues($data_dir, $username);
140}
141
142/**
143 * Set a there preference $string to $value.
144 */
145function setPref($data_dir, $username, $string, $value) {
146 global $prefs_cache;
147
148 cachePrefValues($data_dir, $username);
149 if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $value)) {
150 return;
151 }
152
153 if ($value === '') {
154 removePref($data_dir, $username, $string);
155 return;
156 }
157
158 $prefs_cache[$string] = $value;
159 savePrefValues($data_dir, $username);
160}
161
162/**
163 * Check for a preferences file. If one can not be found, create it.
164 */
165function checkForPrefs($data_dir, $username, $filename = '') {
166 /* First, make sure we have the filename. */
167 if ($filename == '') {
bd1180c1 168 $filename = getHashedFile($username, $data_dir, "$username.pref");
3499f99f 169 }
170
171 /* Then, check if the file exists. */
172 if (!@file_exists($filename) ) {
173 /* First, check the $data_dir for the default preference file. */
174 $default_pref = $data_dir . 'default_pref';
175
176 /* If it is not there, check the internal data directory. */
177 if (!@file_exists($default_pref)) {
bd9c880b 178 $default_pref = SM_PATH . 'data/default_pref';
3499f99f 179 }
180
181 /* Otherwise, report an error. */
9be8198d 182 $errTitle = sprintf( _("Error opening %s"), $default_pref );
3499f99f 183 if (!file_exists($default_pref)) {
9be8198d 184 $errString = $errTitle . "<br>\n" .
185 _("Default preference file not found!") . "<br>\n" .
186 _("Please contact your system administrator and report this error.") . "<br>\n";
bd9c880b 187 include_once(SM_PATH . 'functions/display_messages.php' );
9be8198d 188 logout_error( $errString, $errTitle );
3499f99f 189 exit;
190 } else if (!@copy($default_pref, $filename)) {
305a1012 191 $uid = 'httpd';
192 if (function_exists('posix_getuid')){
193 $user_data = posix_getpwuid(posix_getuid());
194 $uid = $user_data['name'];
195 }
9be8198d 196 $errString = $errTitle . '<br>' .
197 _("Could not create initial preference file!") . "<br>\n" .
198 sprintf( _("%s should be writable by user %s"), $data_dir, $uid ) .
199 "<br>\n" . _("Please contact your system administrator and report this error.") . "<br>\n";
bd9c880b 200 include_once(SM_PATH . 'functions/display_messages.php' );
9be8198d 201 logout_error( $errString, $errTitle );
3499f99f 202 exit;
203 }
204 }
205}
206
207/**
208 * Write the User Signature.
209 */
01265fba 210function setSig($data_dir, $username, $number, $value) {
211 $filename = getHashedFile($username, $data_dir, "$username.si$number");
35b5fa13 212 /* Open the file for writing, or else display an error to the user. */
45df3062 213 if(!$file = @fopen($filename.'.tmp', 'w'))
35b5fa13 214 {
bd9c880b 215 include_once(SM_PATH . '/functions/display_messages.php' );
45df3062 216 logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename.'.tmp') );
35b5fa13 217 exit;
218 }
3499f99f 219 fwrite($file, $value);
220 fclose($file);
45df3062 221 copy($filename.'.tmp',$filename);
222 unlink($filename.'.tmp');
3499f99f 223}
224
225/**
226 * Get the signature.
227 */
01265fba 228function getSig($data_dir, $username, $number) {
01265fba 229 $filename = getHashedFile($username, $data_dir, "$username.si$number");
3499f99f 230 $sig = '';
231 if (file_exists($filename)) {
35b5fa13 232 /* Open the file, or else display an error to the user. */
233 if(!$file = @fopen($filename, 'r'))
234 {
bd9c880b 235 include_once(SM_PATH . 'functions/display_messages.php');
35b5fa13 236 logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
237 exit;
238 }
3499f99f 239 while (!feof($file)) {
240 $sig .= fgets($file, 1024);
241 }
242 fclose($file);
243 }
244 return $sig;
245}