Add fixme/note

[squirrelmail.git] / functions / prefs.php

diff --git a/functions/prefs.php b/functions/prefs.php
index fb1c0c38c03c302ad9a572e0b028bb15b274401f..5b618d5623d6d57fb933e4b3376b7a03756ddeda 100644 (file)
--- a/functions/prefs.php
+++ b/functions/prefs.php
@@ -3,38 +3,16 @@
 /**
  * prefs.php
  *
- * Copyright (c) 1999-2005 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
- * This contains functions for manipulating user preferences
+ * This contains functions for filebased user prefs locations
  *
+ * @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');
-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 */
 
@@ -47,6 +25,7 @@ if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $pr
  * @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) {
 
@@ -96,6 +75,7 @@ function getHashedFile($username, $dir, $datafile, $hash_search = true) {
  * @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;
@@ -115,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;
             }
         }
@@ -133,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. */
@@ -145,31 +127,3 @@ function computeHashDirs($username) {
     /* Return our array of hash directories. */
     return ($hash_dirs);
 }
-
-/**
- * FIXME: Undocumented function
- */
-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 ( $reset || !isset($javascript_setting) )
-    $javascript_setting = getPref($data_dir, $username, 'javascript_setting', SMPREF_JS_AUTODETECT);
-
-  if ( !sqGetGlobalVar('new_js_autodetect_results', $js_autodetect_results) &&
-       !sqGetGlobalVar('js_autodetect_results', $js_autodetect_results) )
-    $js_autodetect_results = SMPREF_JS_OFF;
-
-  if ( $javascript_setting == SMPREF_JS_AUTODETECT )
-    $javascript_on = $js_autodetect_results;
-  else
-    $javascript_on = $javascript_setting;
-
-  sqsession_register($javascript_on, 'javascript_on');
-  return $javascript_on;
-}
-
-?>
\ No newline at end of file