Minor cleanups

[squirrelmail.git] / functions / db_prefs.php

diff --git a/functions/db_prefs.php b/functions/db_prefs.php
index 71f372a8fe3a9c997bada49cae8e8d5cb0938ea1..91805d21611dfc16c572d13e6e81040157d41eb2 100644 (file)
--- a/functions/db_prefs.php
+++ b/functions/db_prefs.php
@@ -3,7 +3,7 @@
 /**
  * db_prefs.php
  *
- * Copyright (c) 1999-2003 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
@@ -25,7 +25,7 @@
  * Configuration of databasename, username and password is done
  * by using conf.pl or the administrator plugin
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
@@ -36,15 +36,29 @@ define('SMDB_MYSQL', 1);
 /** PostgreSQL */
 define('SMDB_PGSQL', 2);
 
-require_once('DB.php');
 require_once(SM_PATH . 'config/config.php');
+if (!include_once('DB.php')) {
+    // same error also in abook_database.php
+    require_once(SM_PATH . 'functions/display_messages.php');
+    $error  = _("Could not include PEAR database functions required for the database backend.") . "<br />\n";
+    $error .= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"),
+                        '<tt>DB.php</tt>') . "<br />\n";
+    $error .= _("Please contact your system administrator and report this error.");
+    error_box($error, $color);
+    exit;
+}
 
 global $prefs_are_cached, $prefs_cache;
 
+/**
+ * @ignore
+ */
 function cachePrefValues($username) {
     global $prefs_are_cached, $prefs_cache;
 
+    sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
     if ($prefs_are_cached) {
+        sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
         return;
     }
 
@@ -278,7 +292,10 @@ class dbPrefs {
 } /* end class dbPrefs */
 
 
-/* returns the value for the pref $string */
+/**
+ * returns the value for the pref $string
+ * @ignore
+ */
 function getPref($data_dir, $username, $string, $default = '') {
     $db = new dbPrefs;
     if(isset($db->error)) {
@@ -290,7 +307,10 @@ function getPref($data_dir, $username, $string, $default = '') {
     return $db->getKey($username, $string, $default);
 }
 
-/* Remove the pref $string */
+/**
+ * Remove the pref $string
+ * @ignore
+ */
 function removePref($data_dir, $username, $string) {
     global $prefs_cache;
     $db = new dbPrefs;
@@ -308,7 +328,10 @@ function removePref($data_dir, $username, $string) {
     return;
 }
 
-/* sets the pref, $string, to $set_to */
+/**
+ * sets the pref, $string, to $set_to
+ * @ignore
+ */
 function setPref($data_dir, $username, $string, $set_to) {
     global $prefs_cache;
 
@@ -335,7 +358,10 @@ function setPref($data_dir, $username, $string, $set_to) {
     return;
 }
 
-/* This checks if the prefs are available */
+/**
+ * This checks if the prefs are available
+ * @ignore
+ */
 function checkForPrefs($data_dir, $username) {
     $db = new dbPrefs;
     if(isset($db->error)) {
@@ -343,7 +369,10 @@ function checkForPrefs($data_dir, $username) {
     }
 }
 
-/* Writes the Signature */
+/**
+ * Writes the Signature
+ * @ignore
+ */
 function setSig($data_dir, $username, $number, $string) {
     if ($number == "g") {
         $key = '___signature___';
@@ -354,7 +383,10 @@ function setSig($data_dir, $username, $number, $string) {
     return;
 }
 
-/* Gets the signature */
+/**
+ * Gets the signature
+ * @ignore
+ */
 function getSig($data_dir, $username, $number) {
     if ($number == "g") {
         $key = '___signature___';
@@ -364,4 +396,5 @@ function getSig($data_dir, $username, $number) {
     return getPref($data_dir, $username, $key);
 }
 
-?>
+// vim: et ts=4
+?>
\ No newline at end of file