Ensure that hash directory computation is the same on both 32 and 64 bit architecture...

[squirrelmail.git] / functions / prefs.php

diff --git a/functions/prefs.php b/functions/prefs.php
index bc534c346e55e33e1200c48d8e34e879e0ee63fe..8d02042d62914fde1edabc2b8545d12ab3dbb196 100644 (file)
--- a/functions/prefs.php
+++ b/functions/prefs.php
@@ -3,48 +3,45 @@
 /**
  * prefs.php
  *
- * Copyright (c) 1999-2002 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-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage prefs
  */
 
-global $prefs_are_cached, $prefs_cache;
 
-if ( !session_is_registered('prefs_are_cached') ||
-     !isset( $prefs_cache) ||
-     !is_array( $prefs_cache) ||
-     substr( phpversion(), 0, 3 ) == '4.1' ||
-     substr( phpversion(), 0, 3 ) == '4.2' ) {
-    $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);
 
     /* 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. */
+    /* Set the value of our real data file, after we've removed unwanted characters. */
+    $datafile = str_replace('/', '_', $datafile);
     $result = "$real_hash_dir/$datafile";
 
     /* Check for this file in the real hash directory. */
@@ -65,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;
 
@@ -77,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);
@@ -88,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;
             }
         }
@@ -101,9 +109,23 @@ function getHashedDir($username, $dir, $hash_dirs = '') {
     return ($real_hash_dir);
 }
 
+/**
+ * Helper function for getHashDir which does the actual hash calculation.
+ *
+ * @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);
+    /* 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($username);
+    if ($crc & 0x80000000) {
+        $crc ^= 0xffffffff;
+        $crc += 1;
+    }
+    $hash = base_convert($crc, 10, 16);
     $hash_dirs = array();
     for ($h = 0; $h < 4; ++ $h) {
         $hash_dirs[] = substr($hash, $h, 1);
@@ -112,5 +134,3 @@ function computeHashDirs($username) {
     /* Return our array of hash directories. */
     return ($hash_dirs);
 }
-
-?>