Make writing to prefs/abook/calendar files more reliable by handling it

[squirrelmail.git] / functions / file_prefs.php

diff --git a/functions/file_prefs.php b/functions/file_prefs.php
index c707d52f143988e8a269620aa772ddcebf4d509d..e4128326f0cac98a183061acd01421b56800cf90 100644 (file)
--- a/functions/file_prefs.php
+++ b/functions/file_prefs.php
@@ -3,14 +3,18 @@
 /**
  * file_prefs.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * This contains functions for manipulating user preferences in files
  *
  * $Id$
+ * @package squirrelmail
  */
 
+/** include this for error messages */
+include_once(SM_PATH . 'functions/display_messages.php');
+
 /**
  * Check the preferences into the session cache.
  */
@@ -33,7 +37,6 @@ function cachePrefValues($data_dir, $username) {
 
     /* Make sure that the preference file now DOES exist. */
     if (!file_exists($filename)) {
-        include_once(SM_PATH . 'functions/display_messages.php');
         logout_error( sprintf( _("Preference file, %s, does not exist. Log out, and log back in to create a default preference file."), $filename)  );
         exit;
     }
@@ -41,7 +44,6 @@ function cachePrefValues($data_dir, $username) {
     /* Open the file, or else display an error to the user. */
     if(!$file = @fopen($filename, 'r'))
     {
-        include_once(SM_PATH . 'functions/display_messages.php');
         logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
         exit;
     }
@@ -49,7 +51,15 @@ function cachePrefValues($data_dir, $username) {
     /* Read in the preferences. */
     $highlight_num = 0;
     while (! feof($file)) {
-        $pref = trim(fgets($file, 1024));
+        $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);
@@ -64,8 +74,8 @@ function cachePrefValues($data_dir, $username) {
                 $prefs_cache[$key] = $value;
             }
         }
-     }
-     fclose($file);
+    }
+    fclose($file);
 
     $prefs_are_cached = TRUE;
 
@@ -74,7 +84,7 @@ function cachePrefValues($data_dir, $username) {
 }
    
 /**
- * Return the value for the prefernce given by $string.
+ * Return the value for the preference given by $string.
  */
 function getPref($data_dir, $username, $string, $default = '') {
     global $prefs_cache;
@@ -105,23 +115,25 @@ function savePrefValues($data_dir, $username) {
     /* Open the file for writing, or else display an error to the user. */
     if(!$file = @fopen($filename.'.tmp', 'w'))
     {
-        include_once(SM_PATH . 'functions/display_messages.php');
         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)) {
-            $tmpwrite = @fwrite($file, $Key . '=' . $Value . "\n");
-            if ($tmpwrite == -1) {
+            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);
-    @copy($filename . '.tmp',$filename);
+    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);
+    @chmod($filename, 0600);
+    sqsession_register($prefs_cache , 'prefs_cache');
 }
 
 /**
@@ -171,6 +183,9 @@ function checkForPrefs($data_dir, $username, $filename = '') {
     /* Then, check if the file exists. */
     if (!@file_exists($filename) ) {
         /* First, check the $data_dir for the default preference file. */
+        if(substr($data_dir,-1) != '/') {
+            $data_dir .= '/';
+        }
         $default_pref = $data_dir . 'default_pref';
 
         /* If it is not there, check the internal data directory. */
@@ -184,7 +199,6 @@ function checkForPrefs($data_dir, $username, $filename = '') {
             $errString = $errTitle . "<br>\n" .
                          _("Default preference file not found or not readable!") . "<br>\n" .
                          _("Please contact your system administrator and report this error.") . "<br>\n";
-            include_once(SM_PATH . 'functions/display_messages.php' );
             logout_error( $errString, $errTitle );
             exit;
         } else if (!@copy($default_pref, $filename)) {
@@ -197,7 +211,6 @@ function checkForPrefs($data_dir, $username, $filename = '') {
                        _("Could not create initial preference file!") . "<br>\n" .
                        sprintf( _("%s should be writable by user %s"), $data_dir, $uid ) .
                        "<br>\n" . _("Please contact your system administrator and report this error.") . "<br>\n";
-            include_once(SM_PATH . 'functions/display_messages.php' );
             logout_error( $errString, $errTitle );
             exit;
         }
@@ -211,20 +224,20 @@ function setSig($data_dir, $username, $number, $value) {
     $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')) {
-        include_once( '../functions/display_messages.php' );
         logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename . '.tmp') );
         exit;
     }
-    $tmpwrite = @fwrite($file, $value);
-    if ($tmpwrite == -1) {
-       include_once( '../functions/display_messages.php' );
+    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);
-    @copy($filename . '.tmp',$filename);
+    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);
+    @chmod($filename, 0600);
 
 }
 
@@ -238,7 +251,6 @@ function getSig($data_dir, $username, $number) {
         /* Open the file, or else display an error to the user. */
         if(!$file = @fopen($filename, 'r'))
         {
-            include_once(SM_PATH . 'functions/display_messages.php');
             logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
             exit;
         }