Happy New Year
[squirrelmail.git] / functions / prefs.php
index 8521f39b01e043b3017cfd3836723f62d32db4f5..bc85e1a75ddd85aee7be53e90183e943b7cd216f 100644 (file)
@@ -3,50 +3,37 @@
 /**
  * prefs.php
  *
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+ * This contains functions for filebased user prefs locations
  *
- * This contains functions for manipulating user preferences
- *
- * $Id$
+ * @copyright 1999-2020 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
  * @package squirrelmail
+ * @subpackage prefs
  */
 
-/** Include global.php */
-require_once(SM_PATH . 'functions/global.php');
-
-sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
-sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
-
-$rg = ini_get('register_globals');
-
-/* if php version >= 4.1 OR (4.0 AND $rg = off) */
-if ( !sqsession_is_registered('prefs_are_cached') ||
-     !isset( $prefs_cache) ||
-     !is_array( $prefs_cache) ||
-     check_php_version(4,1) ||
-     empty($rg)
-   ) {
-    $prefs_are_cached = false;
-    $prefs_cache = array();
-}
 
-if (isset($prefs_dsn) && !empty($prefs_dsn)) {
-    require_once(SM_PATH . 'functions/db_prefs.php');
-} else {
-    require_once(SM_PATH . 'functions/file_prefs.php');
-}
 
 /* Hashing functions */
 
+/**
+ * Given a username and datafilename, this will return the path to the
+ * hashed location of that datafile.
+ *
+ * @param string username the username of the current user
+ * @param string dir the SquirrelMail datadir
+ * @param string datafile the name of the file to open
+ * @param bool hash_seach default true
+ * @return string the hashed location of datafile
+ * @since 1.2.0
+ */
 function getHashedFile($username, $dir, $datafile, $hash_search = true) {
-    global $dir_hash_level;
 
     /* 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);
 
@@ -75,11 +62,21 @@ function getHashedFile($username, $dir, $datafile, $hash_search = true) {
             }
         }
     }
-     
+
     /* Return the full hashed datafile path. */
     return ($result);
 }
 
+/**
+ * Helper function for getHashedFile, given a username returns the hashed
+ * dir for that username.
+ *
+ * @param string username the username of the current user
+ * @param string dir the SquirrelMail datadir
+ * @param string hash_dirs default ''
+ * @return the path to the hash dir for username
+ * @since 1.2.0
+ */
 function getHashedDir($username, $dir, $hash_dirs = '') {
     global $dir_hash_level;
 
@@ -87,7 +84,7 @@ function getHashedDir($username, $dir, $hash_dirs = '') {
     if (substr($dir, -1) == '/') {
         $dir = substr($dir, 0, strlen($dir) - 1);
     }
-    
+
     /* If necessary, populate the hash dir variable. */
     if ($hash_dirs == '') {
         $hash_dirs = computeHashDirs($username);
@@ -98,10 +95,11 @@ function getHashedDir($username, $dir, $hash_dirs = '') {
     for ($h = 0; $h < $dir_hash_level; ++$h) {
         $real_hash_dir .= '/' . $hash_dirs[$h];
         if (!@is_dir($real_hash_dir)) {
+//FIXME: When safe_mode is turned on, the error suppression below makes debugging safe_mode UID/GID restrictions tricky... for now, I will add a check in configtest
             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";
+                error_box ( sprintf(_("Error creating directory %s."), $real_hash_dir) . "\n" .
+                     _("Could not create hashed directory structure!") . "\n" .
+                     _("Please contact your system administrator and report this error.") );
                 exit;
             }
         }
@@ -111,16 +109,72 @@ function getHashedDir($username, $dir, $hash_dirs = '') {
     return ($real_hash_dir);
 }
 
+/**
+ * Helper function for getHashDir which does the actual hash calculation.
+ *
+ * Uses a crc32 algorithm by default, but if you put
+ * the following in config/config_local.php, you can
+ * force md5 instead:
+ *    $hash_dirs_use_md5 = TRUE;
+ *
+ * You may also specify that if usernames are in full
+ * email address format, the domain part (beginning
+ * with "@") be stripped before calculating the crc
+ * or md5.  Do that by putting the following in
+ * config/config_local.php:
+ *    $hash_dirs_strip_domain = TRUE;
+ *
+ * @param string username the username to calculate the hash dir for
+ *
+ * @return array a list of hash dirs for this username
+ *
+ * @since 1.2.0
+ *
+ */
 function computeHashDirs($username) {
-    /* Compute the hash for this user and extract the hash directories. */
-    $hash = base_convert(crc32($username), 10, 16);
-    $hash_dirs = array();
+
+    global $hash_dirs_use_md5, $hash_dirs_strip_domain;
+    static $hash_dirs = array();
+
+
+    // strip domain from username
+    if ($hash_dirs_strip_domain)
+        $user = substr($username, 0, strpos($username, '@'));
+    else
+        $user = $username;
+
+
+    // have we already calculated it?
+    if (!empty($hash_dirs[$user]))
+        return $hash_dirs[$user];
+
+
+    if ($hash_dirs_use_md5) {
+
+        $hash = md5($user);
+        //$hash = md5bin($user);
+
+    } else {
+
+        /* Compute the hash for this user and extract the hash directories.  */
+        /* Note that the crc32() function result will be different on 32 and */
+        /* 64 bit systems, thus the hack below.                              */
+        $crc = crc32($user);
+        if ($crc & 0x80000000) {
+            $crc ^= 0xffffffff;
+            $crc += 1;
+        }
+        $hash = base_convert($crc, 10, 16);
+    }
+
+
+    $my_hash_dirs = array();
     for ($h = 0; $h < 4; ++ $h) {
-        $hash_dirs[] = substr($hash, $h, 1);
+        $my_hash_dirs[] = substr($hash, $h, 1);
     }
 
-    /* Return our array of hash directories. */
-    return ($hash_dirs);
+    // Return our array of hash directories
+    $hash_dirs[$user] = $my_hash_dirs;
+    return ($my_hash_dirs);
 }
 
-?>