Indentation fixes
[squirrelmail.git] / functions / file_prefs.php
index a4bfeace80d83102d2c94d999c9231970878ab1b..418f05acf2023474d2fd10dbafb3c8cdbd6e63ac 100644 (file)
@@ -3,29 +3,33 @@
 /**
  * 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$
+ * @version $Id$
+ * @package squirrelmail
  */
 
-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.
  */
 function cachePrefValues($data_dir, $username) {
     global $prefs_are_cached, $prefs_cache;
-       
+
+    sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
     if ( isset($prefs_are_cached) && $prefs_are_cached) {
+        sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
         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,21 +39,34 @@ 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;
     }
 
-    $file = fopen($filename, 'r');
+    /* Open the file, or else display an error to the user. */
+    if(!$file = @fopen($filename, 'r'))
+    {
+        logout_error( sprintf( _("Preference file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
+        exit;
+    }
 
     /* 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 ++;
@@ -59,30 +76,33 @@ function cachePrefValues($data_dir, $username) {
                 $prefs_cache[$key] = $value;
             }
         }
-     }
-     fclose($file);
+    }
+    fclose($file);
 
     $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);
 }
 
@@ -91,17 +111,31 @@ function getPref($data_dir, $username, $string, $default = '') {
  */
 function savePrefValues($data_dir, $username) {
     global $prefs_cache;
-   
+
     $filename = getHashedFile($username, $data_dir, "$username.pref");
 
-    $file = fopen($filename, 'w');
+    /* Open the file for writing, or else display an error to the user. */
+    if(!$file = @fopen($filename.'.tmp', 'w'))
+    {
+        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");
+            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);
-    chmod($filename, 0600);
+    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);
+    sqsession_register($prefs_cache , 'prefs_cache');
 }
 
 /**
@@ -111,11 +145,11 @@ function removePref($data_dir, $username, $string) {
     global $prefs_cache;
 
     cachePrefValues($data_dir, $username);
+
     if (isset($prefs_cache[$string])) {
         unset($prefs_cache[$string]);
     }
+
     savePrefValues($data_dir, $username);
 }
 
@@ -151,30 +185,34 @@ 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. */
         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)) {
-            $errString = $errTitle . "<br>\n" .
-                         _("Default preference file not found!") . "<br>\n" .
-                         _("Please contact your system administrator and report this error.") . "<br>\n";
-            include_once( '../functions/display_messages.php' );
+        if (!is_readable($default_pref)) {
+            $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";
             logout_error( $errString, $errTitle );
             exit;
         } else if (!@copy($default_pref, $filename)) {
-            $user_data = posix_getpwuid(posix_getuid());
-            $uid = $user_data['name'];
-            $errString = $errTitle . '<br>' .
-                       _("Could not create initial preference file!") . "<br>\n" .
+            $uid = 'httpd';
+            if (function_exists('posix_getuid')){
+                $user_data = posix_getpwuid(posix_getuid());
+                $uid = $user_data['name'];
+            }
+            $errString = $errTitle . '<br />' .
+                       _("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' );
+                       "<br />\n" . _("Please contact your system administrator and report this error.") . "<br />\n";
             logout_error( $errString, $errTitle );
             exit;
         }
@@ -185,21 +223,44 @@ function checkForPrefs($data_dir, $username, $filename = '') {
  * Write the User Signature.
  */
 function setSig($data_dir, $username, $number, $value) {
+    // Limit signature size to 64KB (database BLOB limit)
+    if (strlen($value)>65536) {
+        error_option_save(_("Signature is too big."));
+        return;
+    }
     $filename = getHashedFile($username, $data_dir, "$username.si$number");
-    $file = fopen($filename, 'w');
-    fwrite($file, $value);
+    /* Open the file for writing, or else display an error to the user. */
+    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;
+    }
+    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);
+    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);
+
 }
 
 /**
  * Get the signature.
  */
 function getSig($data_dir, $username, $number) {
-    #$filename = $data_dir . $username . '.si$number';
     $filename = getHashedFile($username, $data_dir, "$username.si$number");
     $sig = '';
     if (file_exists($filename)) {
-        $file = fopen($filename, 'r');
+        /* Open the file, or else display an error to the user. */
+        if(!$file = @fopen($filename, 'r'))
+        {
+            logout_error( sprintf( _("Signature file, %s, could not be opened. Contact your system administrator to resolve this issue."), $filename) );
+            exit;
+        }
         while (!feof($file)) {
             $sig .= fgets($file, 1024);
         }
@@ -207,3 +268,6 @@ function getSig($data_dir, $username, $number) {
     }
     return $sig;
 }
+
+// vim: et ts=4
+?>
\ No newline at end of file