Minor cleanups
[squirrelmail.git] / functions / prefs.php
index 5a2a89d45059eab6ceb4f92632484ca36994ba72..aaa12f0378b4ead34dcb38d4b72033c8c3d3c96f 100644 (file)
-<?
-   /**
-    **  prefs.php
-    **
-    **  This contains functions for manipulating user preferences
-    **/
-
-   /** returns the value for $string **/
-   function getPref($username, $string) {
-      $filename = "../data/$username.pref";
-      $file = fopen($filename, "r");
-
-      /** read in all the preferences **/
-      for ($i=0; !feof($file); $i++) {
-         $pref = fgets($file, 1024);
-         if (substr($pref, 0, strpos($pref, "=")) == $string) {
-            fclose($file);
-            return trim(substr($pref, strpos($pref, "=")+1));
-         }
-      }
-      fclose($file);
-      return "";
-   }
-
-   /** sets the pref, $string, to $set_to **/
-   function setPref($username, $string, $set_to) {
-      $filename = "../data/$username.pref";
-      $found = false;
-      if (!file_exists($filename)) {
-         echo "Preference file, $filename, does not exist.  Log out, and log back in to create a default preference file.<BR>";
-         exit;
-      }
-      $file = fopen($filename, "r");
-
-      /** read in all the preferences **/
-      for ($i=0; !feof($file); $i++) {
-         $pref[$i] = fgets($file, 1024);
-         if (substr($pref[$i], 0, strpos($pref[$i], "=")) == $string) {
-            $found = true;
-            $pos = $i;
-         }
-      }
-      fclose($file);
-
-      $file = fopen($filename, "w");
-      if ($found == true) {
-         for ($i=0; $i < count($pref); $i++) {
-            if ($i == $pos) {
-               fwrite($file, "$string=$set_to\n", 1024);
-            } else {
-               fwrite($file, "$pref[$i]", 1024);
+<?php
+
+/**
+ * prefs.php
+ *
+ * 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
+ *
+ * @version $Id$
+ * @package squirrelmail
+ */
+
+/** 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 );
+
+if ( !sqsession_is_registered('prefs_are_cached') ||
+     !isset( $prefs_cache) ||
+     !is_array( $prefs_cache)
+   ) {
+    $prefs_are_cached = false;
+    $prefs_cache = array();
+}
+
+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');
+}
+
+/* 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;
+
+    /* 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, after we've removed unwanted characters. */
+    $datafile = str_replace('/', '_', $datafile);
+    $result = "$real_hash_dir/$datafile";
+
+    /* Check for this file in the real hash directory. */
+    if ($hash_search && !@file_exists($result)) {
+        /* First check the base directory, the most common location. */
+        if (@file_exists("$dir/$datafile")) {
+            rename("$dir/$datafile", $result);
+
+        /* Then check the full range of possible hash directories. */
+        } else {
+            $check_hash_dir = $dir;
+            for ($h = 0; $h < 4; ++$h) {
+                $check_hash_dir .= '/' . $hash_dirs[$h];
+                if (@is_readable("$check_hash_dir/$datafile")) {
+                    rename("$check_hash_dir/$datafile", $result);
+                    break;
+                }
             }
-         }
-      } else {
-         for ($i=0; $i < count($pref); $i++) {
-            fwrite($file, "$pref[$i]", 1024);
-         }
-         fwrite($file, "$string=$set_to\n", 1024);
-      }
-
-      fclose($file);
-   }
-
-   /** This checks if there is a pref file, if there isn't, it will create it. **/
-   function checkForPrefs($username) {
-      $filename = "../data/$username.pref";
-      if (!file_exists($filename)) {
-         if (!copy("../data/default_pref", $filename)) {
-            echo "Error opening $filename";
-            exit;
-         }
-      }
-      return;
-   }
+        }
+    }
+
+    /* 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
+ */
+function getHashedDir($username, $dir, $hash_dirs = '') {
+    global $dir_hash_level;
+
+    /* Remove trailing slash from $dir if found */
+    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);
+    }
+
+    /* Make sure the full hash directory exists. */
+    $real_hash_dir = $dir;
+    for ($h = 0; $h < $dir_hash_level; ++$h) {
+        $real_hash_dir .= '/' . $hash_dirs[$h];
+        if (!@is_dir($real_hash_dir)) {
+            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";
+                exit;
+            }
+        }
+    }
+
+    /* And return that directory. */
+    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);
+    $hash_dirs = array();
+    for ($h = 0; $h < 4; ++ $h) {
+        $hash_dirs[] = substr($hash, $h, 1);
+    }
+
+    /* 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