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 in files
15 * Check the preferences into the session cache.
17 function cachePrefValues($data_dir, $username) {
18 global $prefs_are_cached, $prefs_cache;
20 if ( isset($prefs_are_cached) && $prefs_are_cached) {
24 sqsession_unregister('prefs_cache');
25 sqsession_unregister('prefs_are_cached');
27 /* Calculate the filename for the user's preference file */
28 $filename = getHashedFile($username, $data_dir, "$username.pref");
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);
34 /* Make sure that the preference file now DOES exist. */
35 if (!file_exists($filename)) {
36 include_once(SM_PATH
. 'functions/display_messages.php');
37 logout_error( sprintf( _("Preference file, %s, does not exist. Log out, and log back in to create a default preference file."), $filename) );
41 /* Open the file, or else display an error to the user. */
42 if(!$file = @fopen
($filename, 'r'))
44 include_once(SM_PATH
. 'functions/display_messages.php');
45 logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
49 /* Read in the preferences. */
51 while (! feof($file)) {
52 $pref = trim(fgets($file, 1024));
53 $equalsAt = strpos($pref, '=');
55 $key = substr($pref, 0, $equalsAt);
56 $value = substr($pref, $equalsAt +
1);
57 if (substr($key, 0, 9) == 'highlight') {
58 $key = 'highlight' . $highlight_num;
63 $prefs_cache[$key] = $value;
69 $prefs_are_cached = TRUE;
71 sqsession_register($prefs_cache, 'prefs_cache');
72 sqsession_register($prefs_are_cached, 'prefs_are_cached');
76 * Return the value for the prefernce given by $string.
78 function getPref($data_dir, $username, $string, $default = '') {
82 cachePrefValues($data_dir, $username);
84 if (isset($prefs_cache[$string])) {
85 $result = $prefs_cache[$string];
94 * Save the preferences for this user.
96 function savePrefValues($data_dir, $username) {
99 $filename = getHashedFile($username, $data_dir, "$username.pref");
101 /* Open the file for writing, or else display an error to the user. */
102 if(!$file = @fopen
($filename, 'w'))
104 include_once(SM_PATH
. 'functions/display_messages.php');
105 logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
109 foreach ($prefs_cache as $Key => $Value) {
111 fwrite($file, $Key . '=' . $Value . "\n");
115 chmod($filename, 0600);
119 * Remove a preference for the current user.
121 function removePref($data_dir, $username, $string) {
124 cachePrefValues($data_dir, $username);
126 if (isset($prefs_cache[$string])) {
127 unset($prefs_cache[$string]);
130 savePrefValues($data_dir, $username);
134 * Set a there preference $string to $value.
136 function setPref($data_dir, $username, $string, $value) {
139 cachePrefValues($data_dir, $username);
140 if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $value)) {
145 removePref($data_dir, $username, $string);
149 $prefs_cache[$string] = $value;
150 savePrefValues($data_dir, $username);
154 * Check for a preferences file. If one can not be found, create it.
156 function checkForPrefs($data_dir, $username, $filename = '') {
157 /* First, make sure we have the filename. */
158 if ($filename == '') {
159 $filename = getHashedFile($username, $data_dir, "$username.pref");
162 /* Then, check if the file exists. */
163 if (!@file_exists
($filename) ) {
164 /* First, check the $data_dir for the default preference file. */
165 $default_pref = $data_dir . 'default_pref';
167 /* If it is not there, check the internal data directory. */
168 if (!@file_exists
($default_pref)) {
169 $default_pref = SM_PATH
. 'data/default_pref';
172 /* Otherwise, report an error. */
173 $errTitle = sprintf( _("Error opening %s"), $default_pref );
174 if (!file_exists($default_pref)) {
175 $errString = $errTitle . "<br>\n" .
176 _("Default preference file not found!") . "<br>\n" .
177 _("Please contact your system administrator and report this error.") . "<br>\n";
178 include_once(SM_PATH
. 'functions/display_messages.php' );
179 logout_error( $errString, $errTitle );
181 } else if (!@copy
($default_pref, $filename)) {
183 if (function_exists('posix_getuid')){
184 $user_data = posix_getpwuid(posix_getuid());
185 $uid = $user_data['name'];
187 $errString = $errTitle . '<br>' .
188 _("Could not create initial preference file!") . "<br>\n" .
189 sprintf( _("%s should be writable by user %s"), $data_dir, $uid ) .
190 "<br>\n" . _("Please contact your system administrator and report this error.") . "<br>\n";
191 include_once(SM_PATH
. 'functions/display_messages.php' );
192 logout_error( $errString, $errTitle );
199 * Write the User Signature.
201 function setSig($data_dir, $username, $number, $value) {
202 $filename = getHashedFile($username, $data_dir, "$username.si$number");
203 /* Open the file for writing, or else display an error to the user. */
204 if(!$file = @fopen
($filename, 'w'))
206 include_once(SM_PATH
. '/functions/display_messages.php' );
207 logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
210 fwrite($file, $value);
217 function getSig($data_dir, $username, $number) {
218 $filename = getHashedFile($username, $data_dir, "$username.si$number");
220 if (file_exists($filename)) {
221 /* Open the file, or else display an error to the user. */
222 if(!$file = @fopen
($filename, 'r'))
224 include_once(SM_PATH
. 'functions/display_messages.php');
225 logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
228 while (!feof($file)) {
229 $sig .= fgets($file, 1024);