<?php
-/*
+/**
* db_prefs.php
*
- * Copyright (c) 1999-2002 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
* stored in a database, accessed though the Pear DB layer.
*
- * To use this instead of the regular prefs.php, create a
- * database as described below, and replace prefs.php
- * with this file.
- *
* Database:
* ---------
*
- * The preferences table should have tree columns:
- * username char \ primary
+ * The preferences table should have three columns:
+ * user char \ primary
* prefkey char / key
* prefval blob
*
- * CREATE TABLE userprefs (user CHAR(32) NOT NULL DEFAULT '',
+ * CREATE TABLE userprefs (user CHAR(128) NOT NULL DEFAULT '',
* prefkey CHAR(64) NOT NULL DEFAULT '',
* prefval BLOB NOT NULL DEFAULT '',
* primary key (user,prefkey));
*
* Configuration of databasename, username and password is done
- * by changing $DSN below.
+ * by using conf.pl or the administrator plugin
*
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
*/
-require_once('DB.php');
+/** Unknown database */
+define('SMDB_UNKNOWN', 0);
+/** MySQL */
+define('SMDB_MYSQL', 1);
+/** PostgreSQL */
+define('SMDB_PGSQL', 2);
+
+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;
-if ( !session_is_registered('prefs_are_cached') ||
- !isset( $prefs_cache) ||
- !is_array( $prefs_cache) ||
- substr( phpversion(), 0, 3 ) == '4.1' ) {
- $prefs_are_cached = false;
- $prefs_cache = array();
-}
-
+/**
+ * @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;
}
- session_unregister('prefs_cache');
- session_unregister('prefs_are_cached');
+ sqsession_unregister('prefs_cache');
+ sqsession_unregister('prefs_are_cached');
$db = new dbPrefs;
if(isset($db->error)) {
$prefs_are_cached = true;
- session_register('prefs_cache');
- session_register('prefs_are_cached');
+ sqsession_register($prefs_cache, 'prefs_cache');
+ sqsession_register($prefs_are_cached, 'prefs_are_cached');
}
+/**
+ * Completely undocumented class - someone document it!
+ * @package squirrelmail
+ */
class dbPrefs {
- var $DSN = 'mysql://user:passwd@host/database';
var $table = 'userprefs';
+ var $user_field = 'user';
+ var $key_field = 'prefkey';
+ var $val_field = 'prefval';
var $dbh = NULL;
var $error = NULL;
+ var $db_type = SMDB_UNKNOWN;
- var $default = Array('chosen_theme' => '../themes/default_theme.php',
+ var $default = Array('theme_default' => 0,
'show_html_default' => '0');
function open() {
+ global $prefs_dsn, $prefs_table;
+ global $prefs_user_field, $prefs_key_field, $prefs_val_field;
+
if(isset($this->dbh)) {
return true;
}
- $dbh = DB::connect($this->DSN, true);
- if(DB::isError($dbh) || DB::isWarning($dbh)) {
+ if (preg_match('/^mysql/', $prefs_dsn)) {
+ $this->db_type = SMDB_MYSQL;
+ } elseif (preg_match('/^pgsql/', $prefs_dsn)) {
+ $this->db_type = SMDB_PGSQL;
+ }
+
+ if (!empty($prefs_table)) {
+ $this->table = $prefs_table;
+ }
+ if (!empty($prefs_user_field)) {
+ $this->user_field = $prefs_user_field;
+ }
+ if (!empty($prefs_key_field)) {
+ $this->key_field = $prefs_key_field;
+ }
+ if (!empty($prefs_val_field)) {
+ $this->val_field = $prefs_val_field;
+ }
+ $dbh = DB::connect($prefs_dsn, true);
+
+ if(DB::isError($dbh)) {
$this->error = DB::errorMessage($dbh);
return false;
}
if (isset($prefs_cache[$key])) {
return $prefs_cache[$key];
} else {
- return $default;
+ if (isset($this->default[$key])) {
+ return $this->default[$key];
+ } else {
+ return $default;
+ }
}
}
function deleteKey($user, $key) {
global $prefs_cache;
- $this->open();
- $query = sprintf("DELETE FROM %s WHERE user='%s' AND prefkey='%s'",
+ if (!$this->open()) {
+ return false;
+ }
+ $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
$this->table,
+ $this->user_field,
$this->dbh->quoteString($user),
+ $this->key_field,
$this->dbh->quoteString($key));
$res = $this->dbh->simpleQuery($query);
unset($prefs_cache[$key]);
- if(substr($key, 0, 9) == 'highlight') {
- $this->renumberHighlightList($user);
- }
-
return true;
}
function setKey($user, $key, $value) {
- $this->open();
- $query = sprintf("REPLACE INTO %s (user,prefkey,prefval) ".
- "VALUES('%s','%s','%s')",
- $this->table,
- $this->dbh->quoteString($user),
- $this->dbh->quoteString($key),
- $this->dbh->quoteString($value));
-
- $res = $this->dbh->simpleQuery($query);
- if(DB::isError($res)) {
- $this->failQuery($res);
+ if (!$this->open()) {
+ return false;
+ }
+ if ($this->db_type == SMDB_MYSQL) {
+ $query = sprintf("REPLACE INTO %s (%s, %s, %s) ".
+ "VALUES('%s','%s','%s')",
+ $this->table,
+ $this->user_field,
+ $this->key_field,
+ $this->val_field,
+ $this->dbh->quoteString($user),
+ $this->dbh->quoteString($key),
+ $this->dbh->quoteString($value));
+
+ $res = $this->dbh->simpleQuery($query);
+ if(DB::isError($res)) {
+ $this->failQuery($res);
+ }
+ } elseif ($this->db_type == SMDB_PGSQL) {
+ $this->dbh->simpleQuery("BEGIN TRANSACTION");
+ $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
+ $this->table,
+ $this->user_field,
+ $this->dbh->quoteString($user),
+ $this->key_field,
+ $this->dbh->quoteString($key));
+ $res = $this->dbh->simpleQuery($query);
+ if (DB::isError($res)) {
+ $this->dbh->simpleQuery("ROLLBACK TRANSACTION");
+ $this->failQuery($res);
+ }
+ $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')",
+ $this->table,
+ $this->user_field,
+ $this->key_field,
+ $this->val_field,
+ $this->dbh->quoteString($user),
+ $this->dbh->quoteString($key),
+ $this->dbh->quoteString($value));
+ $res = $this->dbh->simpleQuery($query);
+ if (DB::isError($res)) {
+ $this->dbh->simpleQuery("ROLLBACK TRANSACTION");
+ $this->failQuery($res);
+ }
+ $this->dbh->simpleQuery("COMMIT TRANSACTION");
+ } else {
+ $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
+ $this->table,
+ $this->user_field,
+ $this->dbh->quoteString($user),
+ $this->key_field,
+ $this->dbh->quoteString($key));
+ $res = $this->dbh->simpleQuery($query);
+ if (DB::isError($res)) {
+ $this->failQuery($res);
+ }
+ $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')",
+ $this->table,
+ $this->user_field,
+ $this->key_field,
+ $this->val_field,
+ $this->dbh->quoteString($user),
+ $this->dbh->quoteString($key),
+ $this->dbh->quoteString($value));
+ $res = $this->dbh->simpleQuery($query);
+ if (DB::isError($res)) {
+ $this->failQuery($res);
+ }
}
return true;
function fillPrefsCache($user) {
global $prefs_cache;
- $this->open();
+ if (!$this->open()) {
+ return;
+ }
$prefs_cache = array();
- $query = sprintf("SELECT prefkey, prefval FROM %s ".
- "WHERE user = '%s'",
+ $query = sprintf("SELECT %s as prefkey, %s as prefval FROM %s ".
+ "WHERE %s = '%s'",
+ $this->key_field,
+ $this->val_field,
$this->table,
+ $this->user_field,
$this->dbh->quoteString($user));
$res = $this->dbh->query($query);
if (DB::isError($res)) {
}
}
- /*
- * 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) {
- $this->open();
- $query = sprintf("SELECT * FROM %s WHERE user='%s' ".
- "AND prefkey LIKE 'highlight%%' ORDER BY prefkey",
- $this->table,
- $this->dbh->quoteString($user));
-
- $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 prefkey='%s' ".
- "WHERE user ='%s' AND prefkey='%s'",
- $this->table,
- $this->dbh->quoteString($newkey),
- $this->dbh->quoteString($user),
- $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;
- if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $value)) {
+ if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $set_to)) {
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 */
-function setSig($data_dir, $username, $string) {
- $db = new dbPrefs;
- if(isset($db->error)) {
- $db->failQuery();
+/**
+ * Writes the Signature
+ * @ignore
+ */
+function setSig($data_dir, $username, $number, $string) {
+ if ($number == "g") {
+ $key = '___signature___';
+ } else {
+ $key = sprintf('___sig%s___', $number);
}
-
- $db->setKey($username, '___signature___', $string);
+ setPref($data_dir, $username, $key, $string);
return;
}
-/* Gets the signature */
-function getSig($data_dir, $username) {
- $db = new dbPrefs;
- if(isset($db->error)) {
- $db->failQuery();
- }
-
- return $db->getKey($username, '___signature___');
-}
-
-/* Hashing functions */
-
-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. */
- $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;
- }
- }
- }
- }
-
- /* Return the full hashed datafile path. */
- return ($result);
-}
-
-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>';
- echo _("Could not create hashed directory structure!") . "<br>\n";
- echo _("Please contact your system administrator and report this error.") . "<br>\n";
- exit;
- }
- }
- }
-
- /* And return that directory. */
- return ($real_hash_dir);
-}
-
-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);
+/**
+ * Gets the signature
+ * @ignore
+ */
+function getSig($data_dir, $username, $number) {
+ if ($number == "g") {
+ $key = '___signature___';
+ } else {
+ $key = sprintf('___sig%d___', $number);
}
-
- /* Return our array of hash directories. */
- return ($hash_dirs);
+ return getPref($data_dir, $username, $key);
}
-?>
+// vim: et ts=4
+?>
\ No newline at end of file
projects / squirrelmail.git / blobdiff