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     $temp = array(&$username, &$pref_name);
 113     $result = do_hook('get_pref_override', $temp);
 114     if (!$result) {
 115         cachePrefValues($data_dir, $username);
 116         if (isset($prefs_cache[$pref_name])) {
 117             $result = $prefs_cache[$pref_name];
 118         } else {
 119             $temp = array(&$username, &$pref_name);
 120             $result = do_hook('get_pref', $temp);
 121             if (!$result) {
 122                 $result = $default;
 123             }
 124         }
 125     }
 126     return ($result);
 127 }
 128
 129 /**
 130  * Save the preferences for this user.
 131  *
 132  * @param string $data_dir data directory
 133  * @param string $username user name
 134  *
 135  * @since 1.1.3
 136  *
 137  */
 138 function savePrefValues($data_dir, $username) {
 139     global $prefs_cache;
 140
 141     $filename = getHashedFile($username, $data_dir, "$username.pref");
 142
 143     /* Open the file for writing, or else display an error to the user. */
 144     if(!$file = @fopen($filename.'.tmp', 'w'))
 145     {
 146         logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename.'.tmp') );
 147         exit;
 148     }
 149     foreach ($prefs_cache as $Key => $Value) {
 150         if (isset($Value)) {
 151             if ( sq_fwrite($file, $Key . '=' . $Value . "\n") === FALSE ) {
 152                logout_error( sprintf( _("Preference file, %s, could not be written. Contact your system administrator to resolve this issue.") , $filename . '.tmp') );
 153                exit;
 154             }
 155         }
 156     }
 157     fclose($file);
 158     if (! @copy($filename . '.tmp',$filename) ) {
 159         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') );
 160         exit;
 161     }
 162     @unlink($filename . '.tmp');
 163     @chmod($filename, 0600);
 164     sqsession_register($prefs_cache , 'prefs_cache');
 165 }
 166
 167 /**
 168  * Remove a preference for the current user.
 169  *
 170  * @param string $data_dir  data directory
 171  * @param string $username  user name
 172  * @param string $pref_name preference name
 173  *
 174  */
 175 function removePref($data_dir, $username, $pref_name) {
 176     global $prefs_cache;
 177
 178     cachePrefValues($data_dir, $username);
 179
 180     if (isset($prefs_cache[$pref_name])) {
 181         unset($prefs_cache[$pref_name]);
 182     }
 183
 184     savePrefValues($data_dir, $username);
 185 }
 186
 187 /**
 188  * Set the desired preference setting ($pref_name)
 189  * to whatever is in $value.
 190  *
 191  * @param string $data_dir  data directory
 192  * @param string $username  user name
 193  * @param string $pref_name preference name
 194  * @param mixed  $value     preference value
 195  *
 196  */
 197 function setPref($data_dir, $username, $pref_name, $value) {
 198     global $prefs_cache;
 199
 200     cachePrefValues($data_dir, $username);
 201     if (isset($prefs_cache[$pref_name]) && ($prefs_cache[$pref_name] == $value)) {
 202         return;
 203     }
 204
 205     if ($value === '') {
 206         removePref($data_dir, $username, $pref_name);
 207         return;
 208     }
 209
 210     $prefs_cache[$pref_name] = $value;
 211     savePrefValues($data_dir, $username);
 212 }
 213
 214 /**
 215  * Check for a preferences file. If one can not be found, create it.
 216  *
 217  * @param string $data_dir data directory
 218  * @param string $username user name
 219  * @param string $filename (since 1.2.0) preference file name.
 220  *                         (OPTIONAL; default is an empty string,
 221  *                         in which case the file name is
 222  *                         automatically detected)
 223  *
 224  */
 225 function checkForPrefs($data_dir, $username, $filename = '') {
 226     /* First, make sure we have the filename. */
 227     if ($filename == '') {
 228         $filename = getHashedFile($username, $data_dir, "$username.pref");
 229     }
 230
 231     /* Then, check if the file exists. */
 232     if (!@file_exists($filename) ) {
 233
 234         /* If it does not exist, check for default_prefs */
 235
 236         /* First, check legacy locations: data dir */
 237         if(substr($data_dir,-1) != '/') {
 238             $data_dir .= '/';
 239         }
 240         $default_pref = $data_dir . 'default_pref';
 241
 242         /* or legacy location: internal data dir */
 243         if (!@file_exists($default_pref)) {
 244             $default_pref = SM_PATH . 'data/default_pref';
 245         }
 246
 247         /* If no legacies, check where we'd expect it to be located:
 248          * under config/ */
 249         if (!@file_exists($default_pref)) {
 250             $default_pref = SM_PATH . 'config/default_pref';
 251         }
 252
 253         /* If a default_pref file found, try to copy it, if none found,
 254          * try to create an empty one. If that fails, report an error.
 255          */
 256         if (
 257             ( is_readable($default_pref) && !@copy($default_pref, $filename) ) ||
 258             !@touch($filename)
 259         ) {
 260             $uid = 'httpd';
 261             if (function_exists('posix_getuid')){
 262                 $user_data = posix_getpwuid(posix_getuid());
 263                 $uid = $user_data['name'];
 264             }
 265             $errTitle = _("Could not create initial preference file!");
 266             $errString = $errTitle . "\n" .
 267                        sprintf( _("%s should be writable by user %s."), $data_dir, $uid ) . "\n" .
 268                        _("Please contact your system administrator and report this error.") ;
 269             logout_error( $errString, $errTitle );
 270             exit;
 271         }
 272     }
 273 }
 274
 275 /**
 276  * Write the User Signature.
 277  *
 278  * @param string $data_dir data directory
 279  * @param string $username user name
 280  * @param integer $number  (since 1.2.5) identity number.
 281  *                         (before 1.2.5., this parameter
 282  *                         was used for the signature value)
 283  * @param string $value    (since 1.2.5) signature value
 284  *
 285  */
 286 function setSig($data_dir, $username, $number, $value) {
 287     // Limit signature size to 64KB (database BLOB limit)
 288     if (strlen($value)>65536) {
 289         error_option_save(_("Signature is too big."));
 290         return;
 291     }
 292     $filename = getHashedFile($username, $data_dir, "$username.si$number");
 293     /* Open the file for writing, or else display an error to the user. */
 294     if(!$file = @fopen("$filename.tmp", 'w')) {
 295         logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename . '.tmp') );
 296         exit;
 297     }
 298     if ( sq_fwrite($file, $value) === FALSE ) {
 299        logout_error( sprintf( _("Signature file, %s, could not be written. Contact your system administrator to resolve this issue.") , $filename . '.tmp'));
 300        exit;
 301     }
 302     fclose($file);
 303     if (! @copy($filename . '.tmp',$filename) ) {
 304        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') );
 305        exit;
 306     }
 307     @unlink($filename . '.tmp');
 308     @chmod($filename, 0600);
 309
 310 }
 311
 312 /**
 313  * Get the signature.
 314  *
 315  * @param string  $data_dir data directory
 316  * @param string  $username user name
 317  * @param integer $number   (since 1.2.5) identity number
 318  *
 319  * @return string signature
 320  *
 321  */
 322 function getSig($data_dir, $username, $number) {
 323     $filename = getHashedFile($username, $data_dir, "$username.si$number");
 324     $sig = '';
 325     if (file_exists($filename)) {
 326         /* Open the file, or else display an error to the user. */
 327         if(!$file = @fopen($filename, 'r'))
 328         {
 329             logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
 330             exit;
 331         }
 332         while (!feof($file)) {
 333             $sig .= fgets($file, 1024);
 334         }
 335         fclose($file);
 336     }
 337     return $sig;
 338 }
 339
 340 // vim: et ts=4