Happy New Year
[squirrelmail.git] / functions / prefs.php
index 6aab8d8d24b39f781c401c67e4e70a26f3ab390f..bc85e1a75ddd85aee7be53e90183e943b7cd216f 100644 (file)
@@ -3,41 +3,16 @@
 /**
  * prefs.php
  *
- * This contains functions for manipulating user preferences
+ * This contains functions for filebased user prefs locations
  *
- * @copyright © 1999-2005 The SquirrelMail Project Team
+ * @copyright 1999-2020 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
  * @subpackage prefs
  */
 
-/** @ignore */
-if (!defined('SM_PATH')) define('SM_PATH','../');
 
-/** Include global.php */
-require_once(SM_PATH . 'functions/global.php');
-require_once(SM_PATH . 'functions/plugin.php');
-
-sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
-sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
-
-if ( !sqsession_is_registered('prefs_are_cached') ||
-     !isset( $prefs_cache) ||
-     !is_array( $prefs_cache)
-   ) {
-    $prefs_are_cached = false;
-    $prefs_cache = array();
-}
-
-$prefs_backend = do_hook_function('prefs_backend');
-if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
-    require_once(SM_PATH . $prefs_backend);
-} elseif (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 */
 
@@ -120,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;
             }
         }
@@ -136,48 +112,69 @@ function getHashedDir($username, $dir, $hash_dirs = '') {
 /**
  * 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();
-    for ($h = 0; $h < 4; ++ $h) {
-        $hash_dirs[] = substr($hash, $h, 1);
-    }
 
-    /* Return our array of hash directories. */
-    return ($hash_dirs);
-}
+    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];
 
-/**
- * Javascript support detection function
- * @param boolean $reset recheck javascript support if set to true.
- * @return integer SMPREF_JS_ON or SMPREF_JS_OFF ({@see functions/constants.php})
- * @since 1.5.1
- */
-function checkForJavascript($reset = FALSE) {
-  global $data_dir, $username, $javascript_on, $javascript_setting;
 
-  if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION) )
-    return $javascript_on;
+    if ($hash_dirs_use_md5) {
 
-  if ( $reset || !isset($javascript_setting) )
-    $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
+        $hash = md5($user);
+        //$hash = md5bin($user);
 
-  if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
-       !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
-    $js_autodetect_results = SMPREF_JS_OFF;
+    } else {
 
-  if ( $javascript_setting == SMPREF_JS_AUTODETECT )
-    $javascript_on = $js_autodetect_results;
-  else
-    $javascript_on = $javascript_setting;
+        /* 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) {
+        $my_hash_dirs[] = substr($hash, $h, 1);
+    }
 
-  sqsession_register($javascript_on, 'javascript_on');
-  return $javascript_on;
+    // Return our array of hash directories
+    $hash_dirs[$user] = $my_hash_dirs;
+    return ($my_hash_dirs);
 }
 
-?>
\ No newline at end of file