Add fixme/note

[squirrelmail.git] / functions / prefs.php

diff --git a/functions/prefs.php b/functions/prefs.php
index fa502cf40143d3c8933cbabe3d2084c108862a66..5b618d5623d6d57fb933e4b3376b7a03756ddeda 100644 (file)
--- a/functions/prefs.php
+++ b/functions/prefs.php
@@ -3,39 +3,16 @@
 /**
  * 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-2007 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 */
 
@@ -44,19 +21,19 @@ if (isset($prefs_dsn) && !empty($prefs_dsn)) {
  * hashed location of that datafile.
  *
  * @param string username the username of the current user
- * @param string dir the squirrelmail datadir
+ * @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);
 
@@ -85,7 +62,7 @@ function getHashedFile($username, $dir, $datafile, $hash_search = true) {
             }
         }
     }
-     
+
     /* Return the full hashed datafile path. */
     return ($result);
 }
@@ -95,9 +72,10 @@ function getHashedFile($username, $dir, $datafile, $hash_search = true) {
  * dir for that username.
  *
  * @param string username the username of the current user
- * @param string dir the squirrelmail datadir
+ * @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;
@@ -106,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);
@@ -117,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;
             }
         }
@@ -135,6 +114,7 @@ function getHashedDir($username, $dir, $hash_dirs = '') {
  *
  * @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. */
@@ -147,5 +127,3 @@ function computeHashDirs($username) {
     /* Return our array of hash directories. */
     return ($hash_dirs);
 }
-
-?>