Added a counter pref and a fix for the imapid
[squirrelmail.git] / functions / prefs.php
index c23d3cb88dc2f7c0471d27e20e52a1d8dc287645..1d5fb68fb67cec349c5010213daf20b11082957e 100644 (file)
 <?php
-   /**
-    **  prefs.php
-    **
-    **  This contains functions for manipulating user preferences
-    **
-    **  $Id$
-    **/
 
-   $prefs_php = true;
+   /**
+    *   prefs.php
+    *
+    *   Copyright (c) 1999-2001 The Squirrelmail Development Team
+    *   Licensed under the GNU GPL. For full terms see the file COPYING.
+    *
+    *   This contains functions for manipulating user preferences
+    *
+    *   $Id$
+    */
+
+   global $prefs_are_cached, $prefs_cache;
+   if (!session_is_registered('prefs_are_cached')) {
+      $prefs_are_cached = false;
+      $prefs_cache = array();
+   }
 
+   function cachePrefValues($data_dir, $username) {
+       global $prefs_are_cached, $prefs_cache;
+       
+       if ($prefs_are_cached)
+           return;
+       
+       $filename = $data_dir . $username . '.pref';
+       
+       if (!file_exists($filename)) {
+           printf (_("Preference file, %s, does not exist. Log out, and log back in to create a default preference file."), $filename);
+           exit;
+       }
+
+       $file = fopen($filename, 'r');
+
+       /** read in all the preferences **/
+       $highlight_num = 0;
+       while (! feof($file)) {
+          $pref = trim(fgets($file, 1024));
+          $equalsAt = strpos($pref, '=');
+          if ($equalsAt > 0) {
+              $Key = substr($pref, 0, $equalsAt);
+              $Value = substr($pref, $equalsAt + 1);
+              if (substr($Key, 0, 9) == 'highlight') {
+                  $Key = 'highlight' . $highlight_num;
+                  $highlight_num ++;
+              }
+
+              if ($Value != '') {
+                  $prefs_cache[$Key] = $Value;
+              }
+          }
+       }
+       fclose($file);
+
+       session_unregister('prefs_cache');
+       session_register('prefs_cache');
+       
+       $prefs_are_cached = true;
+       session_unregister('prefs_are_cached');
+       session_register('prefs_are_cached');
+   }
+   
+   
    /** returns the value for $string **/
-   function getPref($data_dir, $username, $string) {
-      $filename = "$data_dir$username.pref";
-      if (!file_exists($filename)) {
-        printf (_("Preference file %s not found. Exiting abnormally"), $filename);
-         exit;
-      }
+   function getPref($data_dir, $username, $string, $default = '') {
+      global $prefs_cache;
 
-      $file = fopen($filename, "r");
+      cachePrefValues($data_dir, $username);
 
-      /** read in all the preferences **/
-      for ($i=0; !feof($file); $i++) {
-         $pref = fgets($file, 1024);
-         if (substr($pref, 0, strpos($pref, "=")) == $string) {
-            fclose($file);
-            return trim(substr($pref, strpos($pref, "=")+1));
-         }
-      }
-      fclose($file);
-      return "";
+      if (isset($prefs_cache[$string]))
+          return $prefs_cache[$string];
+      else
+          return $default;
    }
 
-   function removePref($data_dir, $username, $string) {
-      $filename = "$data_dir$username.pref";
-      $found = false;
-      if (!file_exists($filename)) {
-        printf (_("Preference file, %s, does not exist. Log out, and log back in to create a default preference file."), $filename);
-        echo "<br>\n";
-         exit;
-      }
-      $file = fopen($filename, "r");
 
-      for ($i=0; !feof($file); $i++) {
-         $pref[$i] = fgets($file, 1024);
-         if (substr($pref[$i], 0, strpos($pref[$i], "=")) == $string) {
-            $i--;
-         }
+   function savePrefValues($data_dir, $username) {
+      global $prefs_cache;
+      
+      $file = fopen($data_dir . $username . '.pref', 'w');
+      foreach ($prefs_cache as $Key => $Value) {
+          if (isset($Value)) {
+              fwrite($file, $Key . '=' . $Value . "\n");
+          }
       }
       fclose($file);
+   }
 
-      for ($i=0,$j=0; $i < count($pref); $i++) {
-         if (substr($pref[$i], 0, 9) == "highlight") {
-            $hlt[$j] = substr($pref[$i], strpos($pref[$i], "=")+1);
-            $j++;
-         }
-      }
 
-      $file = fopen($filename, "w");
-      for ($i=0; $i < count($pref); $i++) {
-         if (substr($pref[$i], 0, 9) != "highlight") {
-            fwrite($file, "$pref[$i]", 1024);
-         }   
-      }
-      if (isset($htl)) {
-         for ($i=0; $i < count($hlt); $i++) {
-            fwrite($file, "highlight$i=$hlt[$i]");
-         }
+   function removePref($data_dir, $username, $string) {
+      global $prefs_cache;
+      
+      cachePrefValues($data_dir, $username);
+      
+      if (isset($prefs_cache[$string])) {
+          unset($prefs_cache[$string]);
       }
-      fclose($file);
+          
+      savePrefValues($data_dir, $username);
    }
    
    /** sets the pref, $string, to $set_to **/
    function setPref($data_dir, $username, $string, $set_to) {
-      $filename = "$data_dir$username.pref";
-      $found = false;
-      if (!file_exists($filename)) {
-        printf (_("Preference file, %s, does not exist. Log out, and log back in to create a default preference file."), $filename);
-        echo "\n<br>\n";
-         exit;
+      global $prefs_cache;
+      
+      cachePrefValues($data_dir, $username);
+      if (isset($prefs_cache[$string]) && $prefs_cache[$string] == $set_to)
+         return;
+      if ($set_to === '') {
+         removePref($data_dir, $username, $string);
+        return;
       }
-      $file = fopen($filename, "r");
-
-      /** read in all the preferences **/
-      for ($i=0; !feof($file); $i++) {
-         $pref[$i] = fgets($file, 1024);
-         if (substr($pref[$i], 0, strpos($pref[$i], "=")) == $string) {
-            $found = true;
-            $pos = $i;
-         }
-      }
-      fclose($file);
-
-      $file = fopen($filename, "w");
-      if ($found == true) {
-         for ($i=0; $i < count($pref); $i++) {
-            if ($i == $pos) {
-               fwrite($file, "$string=$set_to\n", 1024);
-            } else {
-               fwrite($file, "$pref[$i]", 1024);
-            }
-         }
-      } else {
-         for ($i=0; $i < count($pref); $i++) {
-            fwrite($file, "$pref[$i]", 1024);
-         }
-         fwrite($file, "$string=$set_to\n", 1024);
-      }
-
-      fclose($file);
+      $prefs_cache[$string] = $set_to;
+      savePrefValues($data_dir, $username);
    }
 
 
-
-
    /** This checks if there is a pref file, if there isn't, it will
        create it. **/
    function checkForPrefs($data_dir, $username) {
-      $filename = "$data_dir$username.pref";
+      $filename = $data_dir . $username . '.pref';
       if (!file_exists($filename)) {
-         if (!copy("$data_dir" . "default_pref", $filename)) {
-            echo _("Error opening ") ."$filename";
+         if (!copy($data_dir . 'default_pref', $filename)) {
+            echo _("Error opening ") . $filename;
             exit;
          }
       }
    }
 
 
-
    /** Writes the Signature **/
    function setSig($data_dir, $username, $string) {
-      $filename = "$data_dir$username.sig";
-      $file = fopen($filename, "w");
+      $file = fopen($data_dir . $username . '.sig', 'w');
       fwrite($file, $string);
       fclose($file);
    }
 
    /** Gets the signature **/
    function getSig($data_dir, $username) {
-      $filename = "$data_dir$username.sig";
+      $filename = $data_dir . $username . '.sig';
+      $sig = '';
       if (file_exists($filename)) {
-         $file = fopen($filename, "r");
-         $sig = "";
+         $file = fopen($filename, 'r');
          while (!feof($file)) {
             $sig .= fgets($file, 1024);
          }