Small tweaks:
[squirrelmail.git] / functions / file_prefs.php
index 0ae47bac77a7f60b6ac99cc193efb0bfac52b604..ad596e662bcfe2ce5428701d03638025d38be8de 100644 (file)
@@ -3,7 +3,7 @@
 /**
  * file_prefs.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2003 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
@@ -11,7 +11,8 @@
  * $Id$
  */
 
-global $prefs_are_cached, $prefs_cache;
+/* include this for error messages */
+include_once(SM_PATH . 'functions/display_messages.php');
 
 /**
  * Check the preferences into the session cache.
@@ -23,8 +24,8 @@ function cachePrefValues($data_dir, $username) {
         return;
     }
     
-    session_unregister('prefs_cache');
-    session_unregister('prefs_are_cached');
+    sqsession_unregister('prefs_cache');
+    sqsession_unregister('prefs_are_cached');
     
     /* Calculate the filename for the user's preference file */
     $filename = getHashedFile($username, $data_dir, "$username.pref");
@@ -35,7 +36,6 @@ function cachePrefValues($data_dir, $username) {
 
     /* Make sure that the preference file now DOES exist. */
     if (!file_exists($filename)) {
-        include_once( '../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;
     }
@@ -43,7 +43,6 @@ function cachePrefValues($data_dir, $username) {
     /* Open the file, or else display an error to the user. */
     if(!$file = @fopen($filename, 'r'))
     {
-        include_once( '../functions/display_messages.php' );
         logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
         exit;
     }
@@ -51,11 +50,20 @@ 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);
             $value = substr($pref, $equalsAt + 1);
+            /* this is to 'rescue' old-style highlighting rules. */
             if (substr($key, 0, 9) == 'highlight') {
                 $key = 'highlight' . $highlight_num;
                 $highlight_num ++;
@@ -70,25 +78,28 @@ function cachePrefValues($data_dir, $username) {
 
     $prefs_are_cached = TRUE;
 
-    session_register('prefs_cache');
-    session_register('prefs_are_cached');
+    sqsession_register($prefs_cache, 'prefs_cache');
+    sqsession_register($prefs_are_cached, 'prefs_are_cached');
 }
    
 /**
- * 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;
-    $result = '';
-
-    cachePrefValues($data_dir, $username);
 
-    if (isset($prefs_cache[$string])) {
-        $result = $prefs_cache[$string];
-    } else {
-        $result = $default;
+    $result = do_hook_function('get_pref_override',array($username,$string));
+    if (!$result) {
+       cachePrefValues($data_dir, $username);
+       if (isset($prefs_cache[$string])) {
+           $result = $prefs_cache[$string];
+       } else {
+           $result = do_hook_function('get_pref', array($username,$string));
+           if (!$result) {         
+               $result = $default;
+           }
+       }
     }
-
     return ($result);
 }
 
@@ -101,19 +112,27 @@ function savePrefValues($data_dir, $username) {
     $filename = getHashedFile($username, $data_dir, "$username.pref");
 
     /* Open the file for writing, or else display an error to the user. */
-    if(!$file = @fopen($filename, 'w'))
+    if(!$file = @fopen($filename.'.tmp', 'w'))
     {
-        include_once( '../functions/display_messages.php' );
-        logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
+        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)) {
-            fwrite($file, $Key . '=' . $Value . "\n");
+            $tmpwrite = @fwrite($file, $Key . '=' . $Value . "\n");
+            if ($tmpwrite == -1) {
+               logout_error( sprintf( _("Preference file, %s, could not be written. Contact your system administrator to resolve this issue.") , $filename . '.tmp') );
+               exit;
+            }
         }
     }
     fclose($file);
+    $tmpcopy = @copy($filename . '.tmp',$filename);
+    if ($tmpcopy == -1) {
+        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);
 }
 
@@ -164,20 +183,19 @@ 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. */
-        $default_pref = $data_dir . 'default_pref';
+        $default_pref = $data_dir . '/default_pref';
 
         /* If it is not there, check the internal data directory. */
         if (!@file_exists($default_pref)) {
-            $default_pref = '../data/default_pref';
+            $default_pref = SM_PATH . 'data/default_pref';
         }
 
         /* Otherwise, report an error. */
         $errTitle = sprintf( _("Error opening %s"), $default_pref );
-        if (!file_exists($default_pref)) {
+        if (!is_readable($default_pref)) {
             $errString = $errTitle . "<br>\n" .
-                         _("Default preference file not found!") . "<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( '../functions/display_messages.php' );
             logout_error( $errString, $errTitle );
             exit;
         } else if (!@copy($default_pref, $filename)) {
@@ -190,7 +208,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( '../functions/display_messages.php' );
             logout_error( $errString, $errTitle );
             exit;
         }
@@ -203,14 +220,20 @@ function checkForPrefs($data_dir, $username, $filename = '') {
 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, '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) );
+    if(!$file = @fopen("$filename.tmp", 'w')) {
+        logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename . '.tmp') );
         exit;
     }
-    fwrite($file, $value);
+    $tmpwrite = @fwrite($file, $value);
+    if ($tmpwrite == -1) {
+       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);
+    @unlink($filename . '.tmp');
+    chmod($filename, 0600);
+
 }
 
 /**
@@ -223,7 +246,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( '../functions/display_messages.php' );
             logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
             exit;
         }