<?php
-/*
+/**
* db_prefs.php
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* This contains functions for manipulating user preferences
* Configuration of databasename, username and password is done
* by using conf.pl or the administrator plugin
*
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage prefs
+ * @since 1.1.3
*/
+/** @ignore */
+if (!defined('SM_PATH')) define('SM_PATH','../');
+
+/** Unknown database */
define('SMDB_UNKNOWN', 0);
+/** MySQL */
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;
}
sqsession_register($prefs_are_cached, 'prefs_are_cached');
}
+/**
+ * Class used to handle connections to prefs database and operations with preferences
+ * @package squirrelmail
+ * @subpackage prefs
+ * @since 1.1.3
+ */
class dbPrefs {
+ /**
+ * Table used to store preferences
+ * @var string
+ */
var $table = 'userprefs';
+ /**
+ * Field used to store owner of preference
+ * @var string
+ */
var $user_field = 'user';
+ /**
+ * Field used to store preference name
+ * @var string
+ */
var $key_field = 'prefkey';
+ /**
+ * Field used to store preference value
+ * @var string
+ */
var $val_field = 'prefval';
+ /**
+ * Database connection object
+ * @var object
+ */
var $dbh = NULL;
+ /**
+ * Error messages
+ * @var string
+ */
var $error = NULL;
+ /**
+ * Database type (SMDB_* constants)
+ * Is used in setKey().
+ * @var integer
+ */
var $db_type = SMDB_UNKNOWN;
+ /**
+ * Default preferences
+ * @var array
+ */
var $default = Array('theme_default' => 0,
'show_html_default' => '0');
+ /**
+ * initialize DB connection object
+ * @return boolean true, if object is initialized
+ */
function open() {
global $prefs_dsn, $prefs_table;
global $prefs_user_field, $prefs_key_field, $prefs_val_field;
return true;
}
+ /**
+ * Function used to handle database connection errors
+ * @param object PEAR Error object
+ */
function failQuery($res = NULL) {
if($res == NULL) {
printf(_("Preference database error (%s). Exiting abnormally"),
exit;
}
-
+ /**
+ * Get user's prefs setting
+ * @param string $user user name
+ * @param string $key preference name
+ * @param mixed $default (since 1.2.5) default value
+ * @return mixed preference value
+ */
function getKey($user, $key, $default = '') {
global $prefs_cache;
}
}
+ /**
+ * Delete user's prefs setting
+ * @param string $user user name
+ * @param string $key preference name
+ * @return boolean
+ */
function deleteKey($user, $key) {
global $prefs_cache;
unset($prefs_cache[$key]);
- if(substr($key, 0, 9) == 'highlight') {
- $this->renumberHighlightList($user);
- }
-
return true;
}
+ /**
+ * Set user's preference
+ * @param string $user user name
+ * @param string $key preference name
+ * @param mixed $value preference value
+ * @return boolean
+ */
function setKey($user, $key, $value) {
if (!$this->open()) {
return false;
return true;
}
+ /**
+ * Fill preference cache array
+ * @param string $user user name
+ * @since 1.2.3
+ */
function fillPrefsCache($user) {
global $prefs_cache;
}
}
- /*
- * When a highlight option is deleted the preferences module
- * must renumber the list. This should be done somewhere else,
- * but it is not, so....
- */
- function renumberHighlightList($user) {
- if (!$this->open()) {
- return;
- }
- $query = sprintf("SELECT %s, %s as prefkey, %s as prefval FROM %s WHERE %s='%s' ".
- "AND %s LIKE 'highlight%%' ORDER BY %s",
- $this->user_field,
- $this->key_field,
- $this->val_field,
- $this->table,
- $this->user_field,
- $this->dbh->quoteString($user),
- $this->key_field,
- $this->key_field);
-
- $res = $this->dbh->query($query);
- if(DB::isError($res)) {
- $this->failQuery($res);
- }
-
- /* Store old data in array */
- $rows = Array();
- while($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
- $rows[] = $row;
- }
-
- /* Renumber keys of old data */
- $hilinum = 0;
- for($i = 0; $i < count($rows) ; $i++) {
- $oldkey = $rows[$i]['prefkey'];
- $newkey = substr($oldkey, 0, 9) . $hilinum;
- $hilinum++;
-
- if($oldkey != $newkey) {
- $query = sprintf("UPDATE %s SET %s='%s' ".
- "WHERE %s ='%s' AND %s='%s'",
- $this->table,
- $this->key_field,
- $this->dbh->quoteString($newkey),
- $this->user_field,
- $this->dbh->quoteString($user),
- $this->key_field,
- $this->dbh->quoteString($oldkey));
-
- $res = $this->dbh->simpleQuery($query);
- if(DB::isError($res)) {
- $this->failQuery($res);
- }
- }
- }
-
- return;
- }
-
} /* 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)) {
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;
if(isset($db->error)) {
$db->failQuery();
}
$db->deleteKey($username, $string);
+
+ if (isset($prefs_cache[$string])) {
+ unset($prefs_cache[$string]);
+ }
+
+ sqsession_register($prefs_cache , 'prefs_cache');
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;
return;
}
- if ($set_to == '') {
+ if ($set_to === '') {
removePref($data_dir, $username, $string);
return;
}
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_BAIL, 1);
assert ('$set_to == $prefs_cache[$string]');
-
+ sqsession_register($prefs_cache , 'prefs_cache');
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)) {
}
}
-/* Writes the Signature */
+/**
+ * Writes the Signature
+ * @ignore
+ */
function setSig($data_dir, $username, $number, $string) {
if ($number == "g") {
$key = '___signature___';
return;
}
-/* Gets the signature */
+/**
+ * Gets the signature
+ * @ignore
+ */
function getSig($data_dir, $username, $number) {
if ($number == "g") {
$key = '___signature___';
return getPref($data_dir, $username, $key);
}
-?>
+// vim: et ts=4
+?>
\ No newline at end of file
projects / squirrelmail.git / blobdiff