Added what I've changed to devel CVS. (conf.pl rework, CRAM/DIGEST-MD5, config overri...
[squirrelmail.git] / functions / prefs.php
index a41121353c419915121a8a56083177dad65767e9..c37748bd98fb3e70cc00cc4d522a68b67fc1cacf 100644 (file)
@@ -3,7 +3,7 @@
 /**
  * prefs.php
  *
- * Copyright (c) 1999-2001 The SquirrelMail Development Team
+ * Copyright (c) 1999-2002 The SquirrelMail Project 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')) {
+require_once(SM_PATH . 'functions/global.php');
+
+if (isset($_SESSION['prefs_cache'])) {
+    $prefs_cache = $_SESSION['prefs_cache'];
+}
+if (isset($_SESSION['prefs_are_cached'])) {
+    $prefs_are_cached = $_SESSION['prefs_are_cached'];
+}
+
+$rg = ini_get('register_globals');
+
+if ( !sqsession_is_registered('prefs_are_cached') ||
+     !isset( $prefs_cache) ||
+     !is_array( $prefs_cache) ||
+     substr( phpversion(), 0, 3 ) == '4.1' ||
+     substr( phpversion(), 0, 3 ) == '4.2' ||
+     (substr( phpversion(), 0, 3 ) == '4.0' && empty($rg))) {
     $prefs_are_cached = false;
     $prefs_cache = array();
 }
 
-/**
- * Check the preferences into the session cache.
- */
-function cachePrefValues($data_dir, $username) {
-    global $prefs_are_cached, $prefs_cache;
-       
-    if ($prefs_are_cached) {
-        return;
-    }
-
-    $filename = $data_dir . $username . '.pref';
+if (isset($prefs_dsn) && !empty($prefs_dsn)) {
+    require_once(SM_PATH . 'functions/db_prefs.php');
+} else {
+    require_once(SM_PATH . 'functions/file_prefs.php');
+}
 
-    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;
-    }
+/* Hashing functions */
 
-    $file = fopen($filename, 'r');
-
-    /* Read in 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 ++;
-            }
+function getHashedFile($username, $dir, $datafile, $hash_search = true) {
+    global $dir_hash_level;
 
-            if ($value != '') {
-                $prefs_cache[$key] = $value;
+    /* Remove trailing slash from $dir if found */
+    if (substr($dir, -1) == '/') {
+        $dir = substr($dir, 0, strlen($dir) - 1);
+    }
+    
+    /* Compute the hash for this user and extract the hash directories. */
+    $hash_dirs = computeHashDirs($username);
+
+    /* First, get and make sure the full hash directory exists. */
+    $real_hash_dir = getHashedDir($username, $dir, $hash_dirs);
+
+    /* Set the value of our real data file. */
+    $result = "$real_hash_dir/$datafile";
+
+    /* Check for this file in the real hash directory. */
+    if ($hash_search && !@file_exists($result)) {
+        /* First check the base directory, the most common location. */
+        if (@file_exists("$dir/$datafile")) {
+            rename("$dir/$datafile", $result);
+
+        /* Then check the full range of possible hash directories. */
+        } else {
+            $check_hash_dir = $dir;
+            for ($h = 0; $h < 4; ++$h) {
+                $check_hash_dir .= '/' . $hash_dirs[$h];
+                if (@is_readable("$check_hash_dir/$datafile")) {
+                    rename("$check_hash_dir/$datafile", $result);
+                    break;
+                }
             }
         }
-     }
-     fclose($file);
-
-     session_unregister('prefs_cache');
-     session_register('prefs_cache');
-       
-     $prefs_are_cached = true;
-     session_unregister('prefs_are_cached');
-     session_register('prefs_are_cached');
-}
-   
-/**
- * Return the value for the prefernce 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;
     }
-
+     
+    /* Return the full hashed datafile path. */
     return ($result);
 }
 
-/**
- * Save the preferences for this user.
- */
-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);
-}
-
-/**
- * Remove a preference for the current user.
- */
-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);
-}
-
-/**
- * Set a there preference $string to $value.
- */
-function setPref($data_dir, $username, $string, $value) {
-    global $prefs_cache;
+function getHashedDir($username, $dir, $hash_dirs = '') {
+    global $dir_hash_level;
 
-    cachePrefValues($data_dir, $username);
-    if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $value)) {
-        return;
+    /* Remove trailing slash from $dir if found */
+    if (substr($dir, -1) == '/') {
+        $dir = substr($dir, 0, strlen($dir) - 1);
     }
-
-    if ($value === '') {
-        removePref($data_dir, $username, $string);
-        return;
+    
+    /* If necessary, populate the hash dir variable. */
+    if ($hash_dirs == '') {
+        $hash_dirs = computeHashDirs($username);
     }
 
-    $prefs_cache[$string] = $value;
-    savePrefValues($data_dir, $username);
-}
-
-/**
- * Check for a preferences file. If one can not be found, create it.
- */
-function checkForPrefs($data_dir, $username) {
-    $filename = $data_dir . $username . '.pref';
-    if (!file_exists($filename) ) {
-        if (!copy($data_dir . 'default_pref', $filename)) {
-            echo _("Error opening ") . $filename;
-            exit;
+    /* Make sure the full hash directory exists. */
+    $real_hash_dir = $dir;
+    for ($h = 0; $h < $dir_hash_level; ++$h) {
+        $real_hash_dir .= '/' . $hash_dirs[$h];
+        if (!@is_dir($real_hash_dir)) {
+            if (!@mkdir($real_hash_dir, 0770)) {
+                echo sprintf(_("Error creating directory %s."), $real_hash_dir) . '<br>' .
+                     _("Could not create hashed directory structure!") . "<br>\n" .
+                     _("Please contact your system administrator and report this error.") . "<br>\n";
+                exit;
+            }
         }
     }
-}
 
-/**
- * Write the User Signature.
- */
-function setSig($data_dir, $username, $value) {
-    $file = fopen($data_dir . $username . '.sig', 'w');
-    fwrite($file, $value);
-    fclose($file);
+    /* And return that directory. */
+    return ($real_hash_dir);
 }
 
-/**
- * Get the signature.
- */
-function getSig($data_dir, $username) {
-    $filename = $data_dir . $username . '.sig';
-    $sig = '';
-    if (file_exists($filename)) {
-        $file = fopen($filename, 'r');
-        while (!feof($file)) {
-            $sig .= fgets($file, 1024);
-        }
-        fclose($file);
+function computeHashDirs($username) {
+    /* Compute the hash for this user and extract the hash directories. */
+    $hash = base_convert(crc32($username), 10, 16);
+    $hash_dirs = array();
+    for ($h = 0; $h < 4; ++ $h) {
+        $hash_dirs[] = substr($hash, $h, 1);
     }
-    return $sig;
+
+    /* Return our array of hash directories. */
+    return ($hash_dirs);
 }
 
 ?>