functions/file_prefs.php

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