Allow easy selection of database backed prefs
[squirrelmail.git] / functions / prefs.php
index 5d2b38fe52471ca8a38512d1ce48bca7a0bc131b..67dbd445152ad76475e266df0019d4db87dc27d6 100644 (file)
  * $Id$
  */
 
  * $Id$
  */
 
-/*
 global $prefs_are_cached, $prefs_cache;
 
 if ( !session_is_registered('prefs_are_cached') ||
      !isset( $prefs_cache) ||
 global $prefs_are_cached, $prefs_cache;
 
 if ( !session_is_registered('prefs_are_cached') ||
      !isset( $prefs_cache) ||
-     !is_array( $prefs_cache)     ||
+     !is_array( $prefs_cache) ||
      substr( phpversion(), 0, 3 ) == '4.1'  ) {
     $prefs_are_cached = false;
     $prefs_cache = array();
 }
      substr( phpversion(), 0, 3 ) == '4.1'  ) {
     $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 ( isset($prefs_are_cached) && $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('../functions/db_prefs.php');
+} else {
+    require_once('../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);
-}
-
-/**
- * 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.
- */
-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;
-}
+/* Hashing functions */
 
 function getHashedFile($username, $dir, $datafile, $hash_search = true) {
     global $dir_hash_level;
 
 function getHashedFile($username, $dir, $datafile, $hash_search = true) {
     global $dir_hash_level;