X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fprefs.php;h=fa502cf40143d3c8933cbabe3d2084c108862a66;hp=74c7848f237f7601d0cd7e6d4597d29ff07abe43;hb=8b096f0a2427cf0019f4dc4433a3e02b9f6f5951;hpb=8b080a33fcfbe80215ad17fa759a28274eb8708e

diff --git a/functions/prefs.php b/functions/prefs.php
index 74c7848f..fa502cf4 100644
--- a/functions/prefs.php
+++ b/functions/prefs.php
@@ -3,210 +3,52 @@
 /**
  * prefs.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * This contains functions for manipulating user preferences
  *
  * $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 );
+
+$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) ||
-     substr( phpversion(), 0, 3 ) == '4.1'  ) {
+     check_php_version(4,1) ||
+     empty($rg)
+   ) {
     $prefs_are_cached = false;
     $prefs_cache = array();
 }
 
-/**
- * Check the preferences into the session cache.
- */
-function cachePrefValues($data_dir, $username) {
-    global $prefs_are_cached, $prefs_cache;
-       
-    if ($prefs_are_cached) {
-        return;
-    }
-    
-    session_unregister('prefs_cache');
-    session_unregister('prefs_are_cached');
-    
-    /* Calculate the filename for the user's preference file */
-    $filename = getHashedFile($username, $data_dir, "$username.pref");
-
-    /* A call to checkForPrefs here should take eliminate the need for */
-    /* this to be called throughout the rest of the SquirrelMail code. */
-    checkForPrefs($data_dir, $username, $filename);
-
-    /* Make sure that the preference file now DOES exist. */
-    if (!file_exists($filename)) {
-        echo sprintf (_("Preference file, %s, does not exist. Log out, and log back in to create a default preference file."), $filename) . "<br>\n";
-        exit;
-    }
-
-    $file = fopen($filename, 'r');
-
-    /* Read in the preferences. */
-    $highlight_num = 0;
-    while (! feof($file)) {
-        $pref = trim(fgets($file, 1024));
-        $equalsAt = strpos($pref, '=');
-        if ($equalsAt > 0) {
-            $key = substr($pref, 0, $equalsAt);
-            $value = substr($pref, $equalsAt + 1);
-            if (substr($key, 0, 9) == 'highlight') {
-                $key = 'highlight' . $highlight_num;
-                $highlight_num ++;
-            }
-
-            if ($value != '') {
-                $prefs_cache[$key] = $value;
-            }
-        }
-     }
-     fclose($file);
-
-    $prefs_are_cached = true;
-
-     session_register('prefs_cache');
-     session_register('prefs_are_cached');
+if (isset($prefs_dsn) && !empty($prefs_dsn)) {
+    require_once(SM_PATH . 'functions/db_prefs.php');
+} else {
+    require_once(SM_PATH . 'functions/file_prefs.php');
 }
-   
-/**
- * Return the value for the prefernce given by $string.
- */
-function getPref($data_dir, $username, $string, $default = '') {
-    global $prefs_cache;
-    $result = '';
-
-    cachePrefValues($data_dir, $username);
-
-    if (isset($prefs_cache[$string])) {
-        $result = $prefs_cache[$string];
-    } else {
-        $result = $default;
-    }
-
-    return ($result);
-}
-
-/**
- * Save the preferences for this user.
- */
-function savePrefValues($data_dir, $username) {
-    global $prefs_cache;
-   
-    $filename = getHashedFile($username, $data_dir, "$username.pref");
 
-    $file = fopen($filename, 'w');
-    foreach ($prefs_cache as $Key => $Value) {
-        if (isset($Value)) {
-            fwrite($file, $Key . '=' . $Value . "\n");
-        }
-    }
-    fclose($file);
-    chmod($filename, 0600);
-}
+/* Hashing functions */
 
 /**
- * Remove a preference for the current user.
- */
-function removePref($data_dir, $username, $string) {
-    global $prefs_cache;
-
-    cachePrefValues($data_dir, $username);
- 
-    if (isset($prefs_cache[$string])) {
-        unset($prefs_cache[$string]);
-    }
- 
-    savePrefValues($data_dir, $username);
-}
-
-/**
- * Set a there preference $string to $value.
- */
-function setPref($data_dir, $username, $string, $value) {
-    global $prefs_cache;
-
-    cachePrefValues($data_dir, $username);
-    if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $value)) {
-        return;
-    }
-
-    if ($value === '') {
-        removePref($data_dir, $username, $string);
-        return;
-    }
-
-    $prefs_cache[$string] = $value;
-    savePrefValues($data_dir, $username);
-}
-
-/**
- * Check for a preferences file. If one can not be found, create it.
- */
-function checkForPrefs($data_dir, $username, $filename = '') {
-    /* First, make sure we have the filename. */
-    if ($filename == '') {
-        $filename = getHashedFile($username, $data_dir, '$username.pref');
-    }
-
-    /* Then, check if the file exists. */
-    if (!@file_exists($filename) ) {
-        /* First, check the $data_dir for the default preference file. */
-        $default_pref = $data_dir . 'default_pref';
-
-        /* If it is not there, check the internal data directory. */
-        if (!@file_exists($default_pref)) {
-            $default_pref = '../data/default_pref';
-        }
-
-        /* Otherwise, report an error. */
-        if (!file_exists($default_pref)) {
-            echo _("Error opening ") . $default_pref . "<br>\n";
-            echo _("Default preference file not found!") . "<br>\n";
-            echo _("Please contact your system administrator and report this error.") . "<br>\n";
-            exit;
-        } else if (!@copy($default_pref, $filename)) {
-            echo _("Error opening ") . $default_pref . '<br>';
-            echo _("Could not create initial preference file!") . "<br>\n";
-            echo _("Please contact your system administrator and report this error.") . "<br>\n";
-            exit;
-        }
-    }
-}
-
-/**
- * Write the User Signature.
- */
-function setSig($data_dir, $username, $value) {
-    $filename = getHashedFile($username, $data_dir, "$username.sig");
-    $file = fopen($filename, 'w');
-    fwrite($file, $value);
-    fclose($file);
-}
-
-/**
- * Get the signature.
+ * 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 getSig($data_dir, $username) {
-    #$filename = $data_dir . $username . '.sig';
-    $filename = getHashedFile($username, $data_dir, "$username.sig");
-    $sig = '';
-    if (file_exists($filename)) {
-        $file = fopen($filename, 'r');
-        while (!feof($file)) {
-            $sig .= fgets($file, 1024);
-        }
-        fclose($file);
-    }
-    return $sig;
-}
-
 function getHashedFile($username, $dir, $datafile, $hash_search = true) {
     global $dir_hash_level;
 
@@ -221,7 +63,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. */
@@ -247,6 +90,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;
 
@@ -278,6 +130,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);