Removing phpDocumentator tag which shouldn't be used here

[squirrelmail.git] / functions / prefs.php

diff --git a/functions/prefs.php b/functions/prefs.php
index bc534c346e55e33e1200c48d8e34e879e0ee63fe..ed4c8de066d96271bfc76cd52cd6d39e4bd1b4e5 100644 (file)
--- a/functions/prefs.php
+++ b/functions/prefs.php
@@ -3,26 +3,32 @@
 /**
  * prefs.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * This contains functions for manipulating user preferences
  *
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
  */
 
-global $prefs_are_cached, $prefs_cache;
+/** Include global.php */
+require_once(SM_PATH . 'functions/global.php');
 
-if ( !session_is_registered('prefs_are_cached') ||
+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) ||
-     substr( phpversion(), 0, 3 ) == '4.1' ||
-     substr( phpversion(), 0, 3 ) == '4.2' ) {
+     !is_array( $prefs_cache) 
+   ) {
     $prefs_are_cached = false;
     $prefs_cache = array();
 }
 
-if (isset($prefs_dsn) && !empty($prefs_dsn)) {
+if (isset($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');
@@ -30,6 +36,16 @@ if (isset($prefs_dsn) && !empty($prefs_dsn)) {
 
 /* 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
+ */
 function getHashedFile($username, $dir, $datafile, $hash_search = true) {
     global $dir_hash_level;
 
@@ -44,7 +60,8 @@ function getHashedFile($username, $dir, $datafile, $hash_search = true) {
     /* 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. */
@@ -70,6 +87,15 @@ function getHashedFile($username, $dir, $datafile, $hash_search = true) {
     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
+ */
 function getHashedDir($username, $dir, $hash_dirs = '') {
     global $dir_hash_level;
 
@@ -101,6 +127,12 @@ 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
+ */
 function computeHashDirs($username) {
     /* Compute the hash for this user and extract the hash directories. */
     $hash = base_convert(crc32($username), 10, 16);
@@ -113,4 +145,30 @@ function computeHashDirs($username) {
     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