X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fdb_prefs.php;h=de256e4c413f22df629554dd3abe739d2e14fd7a;hp=1bc2a12229fc1c32a90660a0fac832aae32e3e47;hb=f2785d1147920588b40e8a34e3c980697e08748f;hpb=099fea113efd975234865a517d2747d3ad0f6008
diff --git a/functions/db_prefs.php b/functions/db_prefs.php
index 1bc2a122..de256e4c 100644
--- a/functions/db_prefs.php
+++ b/functions/db_prefs.php
@@ -4,7 +4,8 @@
* db_prefs.php
*
* This contains functions for manipulating user preferences
- * stored in a database, accessed though the Pear DB layer.
+ * stored in a database, accessed through the Pear DB layer
+ * or PDO, the latter taking precedence if available.
*
* Database:
*
@@ -21,7 +22,32 @@
* Configuration of databasename, username and password is done
* by using conf.pl or the administrator plugin
*
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * Three settings that control PDO behavior can be specified in
+ * config/config_local.php if needed:
+ * boolean $disable_pdo SquirrelMail uses PDO by default to access the
+ * user preferences and address book databases, but
+ * setting this to TRUE will cause SquirrelMail to
+ * fall back to using Pear DB instead.
+ * boolean $pdo_show_sql_errors When database errors are encountered,
+ * setting this to TRUE causes the actual
+ * database error to be displayed, otherwise
+ * generic errors are displayed, preventing
+ * internal database information from being
+ * exposed. This should be enabled only for
+ * debugging purposes.
+ * string $pdo_identifier_quote_char By default, SquirrelMail will quote
+ * table and field names in database
+ * queries with what it thinks is the
+ * appropriate quote character for the
+ * database type being used (backtick
+ * for MySQL (and thus MariaDB), double
+ * quotes for all others), but you can
+ * override the character used by
+ * putting it here, or tell SquirrelMail
+ * NOT to quote identifiers by setting
+ * this to "none"
+ *
+ * @copyright 1999-2015 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
@@ -40,10 +66,18 @@ define('SMDB_MYSQL', 1);
define('SMDB_PGSQL', 2);
/**
- * don't display errors (no code execution in functions/*.php).
+ * Needs either PDO or the DB functions
+ * Don't display errors here. (no code execution in functions/*.php).
* will handle error in dbPrefs class.
*/
-@include_once('DB.php');
+global $use_pdo, $disable_pdo;
+if (empty($disable_pdo) && class_exists('PDO'))
+ $use_pdo = TRUE;
+else
+ $use_pdo = FALSE;
+
+if (!$use_pdo)
+ @include_once('DB.php');
global $prefs_are_cached, $prefs_cache;
@@ -84,9 +118,11 @@ function cachePrefValues($username) {
/**
* Class used to handle connections to prefs database and operations with preferences
+ *
* @package squirrelmail
* @subpackage prefs
* @since 1.1.3
+ *
*/
class dbPrefs {
/**
@@ -94,16 +130,19 @@ class dbPrefs {
* @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
@@ -115,11 +154,13 @@ class dbPrefs {
* @var object
*/
var $dbh = NULL;
+
/**
* Error messages
* @var string
*/
var $error = NULL;
+
/**
* Database type (SMDB_* constants)
* Is used in setKey().
@@ -127,11 +168,20 @@ class dbPrefs {
*/
var $db_type = SMDB_UNKNOWN;
+ /**
+ * Character used to quote database table
+ * and field names
+ * @var string
+ */
+ var $identifier_quote_char = '';
+
/**
* Default preferences
* @var array
*/
var $default = Array('theme_default' => 0,
+ 'include_self_reply_all' => '0',
+ 'do_not_reply_to_self' => '1',
'show_html_default' => '0');
/**
@@ -140,12 +190,14 @@ class dbPrefs {
* @since 1.5.1
*/
var $user_size = 128;
+
/**
* Preference key field size
* @var integer
* @since 1.5.1
*/
var $key_size = 64;
+
/**
* Preference value field size
* @var integer
@@ -153,22 +205,46 @@ class dbPrefs {
*/
var $val_size = 65536;
+
+
+ /**
+ * initialize the default preferences array.
+ *
+ */
+ function dbPrefs() {
+ // Try and read the default preferences file.
+ $default_pref = SM_PATH . 'config/default_pref';
+ if (@file_exists($default_pref)) {
+ if ($file = @fopen($default_pref, 'r')) {
+ while (!feof($file)) {
+ $pref = fgets($file, 1024);
+ $i = strpos($pref, '=');
+ if ($i > 0) {
+ $this->default[trim(substr($pref, 0, $i))] = trim(substr($pref, $i + 1));
+ }
+ }
+ fclose($file);
+ }
+ }
+ }
+
/**
* initialize DB connection object
+ *
* @return boolean true, if object is initialized
+ *
*/
function open() {
- global $prefs_dsn, $prefs_table;
+ global $prefs_dsn, $prefs_table, $use_pdo, $pdo_identifier_quote_char;
global $prefs_user_field, $prefs_key_field, $prefs_val_field;
global $prefs_user_size, $prefs_key_size, $prefs_val_size;
- /* test if Pear DB class is available and freak out if it is not */
- if (! class_exists('DB')) {
+ /* test if PDO or Pear DB classes are available and freak out if necessary */
+ if (!$use_pdo && !class_exists('DB')) {
// same error also in abook_database.php
- $this->error = _("Could not include PEAR database functions required for the database backend.") . "
\n";
- $this->error .= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"),
- 'DB.php') . "
\n";
- $this->error .= _("Please contact your system administrator and report this error.");
+ $error = _("Could not find or include PHP PDO or PEAR database functions required for the database backend.") . "\n";
+ $error .= sprintf(_("PDO should come preinstalled with PHP version 5.1 or higher. Otherwise, is PEAR installed, and is the include path set correctly to find %s?"), 'DB.php') . "\n";
+ $error .= _("Please contact your system administrator and report this error.");
return false;
}
@@ -176,18 +252,37 @@ class dbPrefs {
return true;
}
- if (preg_match('/^mysql/', $prefs_dsn)) {
+ if (strpos($prefs_dsn, 'mysql') === 0) {
$this->db_type = SMDB_MYSQL;
- } elseif (preg_match('/^pgsql/', $prefs_dsn)) {
+ } else if (strpos($prefs_dsn, 'pgsql') === 0) {
$this->db_type = SMDB_PGSQL;
}
+ // figure out identifier quoting (only used for PDO, though we could change that)
+ if (empty($pdo_identifier_quote_char)) {
+ if ($this->db_type == SMDB_MYSQL)
+ $this->identifier_quote_char = '`';
+ else
+ $this->identifier_quote_char = '"';
+ } else if ($pdo_identifier_quote_char === 'none')
+ $this->identifier_quote_char = '';
+ else
+ $this->identifier_quote_char = $pdo_identifier_quote_char;
+
if (!empty($prefs_table)) {
$this->table = $prefs_table;
}
if (!empty($prefs_user_field)) {
$this->user_field = $prefs_user_field;
}
+
+ // the default user field is "user", which in PostgreSQL
+ // is an identifier and causes errors if not escaped
+ //
+ if ($this->db_type == SMDB_PGSQL) {
+ $this->user_field = '"' . $this->user_field . '"';
+ }
+
if (!empty($prefs_key_field)) {
$this->key_field = $prefs_key_field;
}
@@ -203,11 +298,66 @@ class dbPrefs {
if (!empty($prefs_val_size)) {
$this->val_size = (int) $prefs_val_size;
}
- $dbh = DB::connect($prefs_dsn, true);
- if(DB::isError($dbh)) {
- $this->error = DB::errorMessage($dbh);
- return false;
+ // connect, create database connection object
+ //
+ if ($use_pdo) {
+ // parse and convert DSN to PDO style
+ // Pear's full DSN syntax is one of the following:
+ // phptype(dbsyntax)://username:password@protocol+hostspec/database?option=value
+ // phptype(syntax)://user:pass@protocol(proto_opts)/database
+ //
+ // $matches will contain:
+ // 1: database type
+ // 2: username
+ // 3: password
+ // 4: hostname (and possible port number) OR protocol (and possible protocol options)
+ // 5: database name (and possible options)
+ // 6: port number (moved from match number 4)
+ // 7: options (moved from match number 5)
+ // 8: protocol (instead of hostname)
+ // 9: protocol options (moved from match number 4/8)
+//TODO: do we care about supporting cases where no password is given? (this is a legal DSN, but causes an error below)
+ if (!preg_match('|^(.+)://(.+):(.+)@(.+)/(.+)$|i', $prefs_dsn, $matches)) {
+ $this->error = _("Could not parse prefs DSN");
+ return false;
+ }
+ $matches[6] = NULL;
+ $matches[7] = NULL;
+ $matches[8] = NULL;
+ $matches[9] = NULL;
+ if (preg_match('|^(.+):(\d+)$|', $matches[4], $host_port_matches)) {
+ $matches[4] = $host_port_matches[1];
+ $matches[6] = $host_port_matches[2];
+ }
+ if (preg_match('|^(.+?)\((.+)\)$|', $matches[4], $protocol_matches)) {
+ $matches[8] = $protocol_matches[1];
+ $matches[9] = $protocol_matches[2];
+ $matches[4] = NULL;
+ $matches[6] = NULL;
+ }
+//TODO: currently we just ignore options specified on the end of the DSN
+ if (preg_match('|^(.+?)\?(.+)$|', $matches[5], $database_name_options_matches)) {
+ $matches[5] = $database_name_options_matches[1];
+ $matches[7] = $database_name_options_matches[2];
+ }
+ if ($matches[8] === 'unix' && !empty($matches[9]))
+ $pdo_prefs_dsn = $matches[1] . ':unix_socket=' . $matches[9] . ';dbname=' . $matches[5];
+ else
+ $pdo_prefs_dsn = $matches[1] . ':host=' . $matches[4] . (!empty($matches[6]) ? ';port=' . $matches[6] : '') . ';dbname=' . $matches[5];
+ try {
+ $dbh = new PDO($pdo_prefs_dsn, $matches[2], $matches[3]);
+ } catch (Exception $e) {
+ $this->error = $e->getMessage();
+ return false;
+ }
+ } else {
+ $dbh = DB::connect($prefs_dsn, true);
+
+ if(DB::isError($dbh)) {
+ $this->error = DB::errorMessage($dbh);
+ return false;
+ }
}
$this->dbh = $dbh;
@@ -216,64 +366,100 @@ class dbPrefs {
/**
* Function used to handle database connection errors
+ *
* @param object PEAR Error object
+ *
*/
function failQuery($res = NULL) {
+ global $use_pdo;
if($res == NULL) {
printf(_("Preference database error (%s). Exiting abnormally"),
$this->error);
} else {
printf(_("Preference database error (%s). Exiting abnormally"),
- DB::errorMessage($res));
+ ($use_pdo ? implode(' - ', $res->errorInfo()) : DB::errorMessage($res)));
}
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;
- cachePrefValues($user);
+ $temp = array(&$user, &$key);
+ $result = do_hook('get_pref_override', $temp);
+ if (is_null($result)) {
+ cachePrefValues($user);
- if (isset($prefs_cache[$key])) {
- return $prefs_cache[$key];
- } else {
- if (isset($this->default[$key])) {
- return $this->default[$key];
+ if (isset($prefs_cache[$key])) {
+ $result = $prefs_cache[$key];
} else {
- return $default;
+//FIXME: is there a justification for having two prefs hooks so close? who uses them?
+ $temp = array(&$user, &$key);
+ $result = do_hook('get_pref', $temp);
+ if (is_null($result)) {
+ if (isset($this->default[$key])) {
+ $result = $this->default[$key];
+ } else {
+ $result = $default;
+ }
+ }
}
}
+ return $result;
}
/**
* Delete user's prefs setting
+ *
* @param string $user user name
- * @param string $key preference name
+ * @param string $key preference name
+ *
* @return boolean
+ *
*/
function deleteKey($user, $key) {
- global $prefs_cache;
+ global $prefs_cache, $use_pdo, $pdo_show_sql_errors;
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);
- if(DB::isError($res)) {
- $this->failQuery($res);
+ if ($use_pdo) {
+ if (!($sth = $this->dbh->prepare('DELETE FROM ' . $this->identifier_quote_char . $this->table . $this->identifier_quote_char . ' WHERE ' . $this->identifier_quote_char . $this->user_field . $this->identifier_quote_char . ' = ? AND ' . $this->identifier_quote_char . $this->key_field . $this->identifier_quote_char . ' = ?'))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $this->dbh->errorInfo());
+ else
+ $this->error = _("Could not prepare query");
+ $this->failQuery();
+ }
+ if (!($res = $sth->execute(array($user, $key)))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $sth->errorInfo());
+ else
+ $this->error = _("Could not execute query");
+ $this->failQuery();
+ }
+ } 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);
+ }
}
unset($prefs_cache[$key]);
@@ -283,12 +469,16 @@ class dbPrefs {
/**
* Set user's preference
- * @param string $user user name
- * @param string $key preference name
- * @param mixed $value preference value
+ *
+ * @param string $user user name
+ * @param string $key preference name
+ * @param mixed $value preference value
+ *
* @return boolean
+ *
*/
function setKey($user, $key, $value) {
+ global $use_pdo, $pdo_show_sql_errors;
if (!$this->open()) {
return false;
}
@@ -299,7 +489,7 @@ class dbPrefs {
if (strlen($user) > $this->user_size) {
$this->error = "Oversized username value."
." Your preferences can't be saved."
- ." See doc/db-backend.txt or contact your system administrator.";
+ ." See the administrator's manual or contact your system administrator.";
/**
* Debugging function. Can be used to log all issues that trigger
@@ -317,7 +507,7 @@ class dbPrefs {
if (strlen($key) > $this->key_size) {
$err_msg = "Oversized user's preference key."
." Some preferences were not saved."
- ." See doc/db-backend.txt or contact your system administrator.";
+ ." See the administrator's manual or contact your system administrator.";
// error is not fatal. Only some preference is not saved.
trigger_error($err_msg,E_USER_WARNING);
return false;
@@ -328,7 +518,7 @@ class dbPrefs {
if (strlen($value) > $this->val_size) {
$err_msg = "Oversized user's preference value."
." Some preferences were not saved."
- ." See doc/db-backend.txt or contact your system administrator.";
+ ." See the administrator's manual or contact your system administrator.";
// error is not fatal. Only some preference is not saved.
trigger_error($err_msg,E_USER_WARNING);
return false;
@@ -336,69 +526,164 @@ class dbPrefs {
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);
+ if ($use_pdo) {
+ if (!($sth = $this->dbh->prepare('REPLACE INTO ' . $this->identifier_quote_char . $this->table . $this->identifier_quote_char . ' (' . $this->identifier_quote_char . $this->user_field . $this->identifier_quote_char . ', ' . $this->identifier_quote_char . $this->key_field . $this->identifier_quote_char . ', ' . $this->identifier_quote_char . $this->val_field . $this->identifier_quote_char . ') VALUES (?, ?, ?)'))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $this->dbh->errorInfo());
+ else
+ $this->error = _("Could not prepare query");
+ $this->failQuery();
+ }
+ if (!($res = $sth->execute(array($user, $key, $value)))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $sth->errorInfo());
+ else
+ $this->error = _("Could not execute query");
+ $this->failQuery();
+ }
+ } else {
+ $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);
+ if ($use_pdo) {
+ if ($this->dbh->exec('BEGIN TRANSACTION') === FALSE) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $this->dbh->errorInfo());
+ else
+ $this->error = _("Could not execute query");
+ $this->failQuery();
+ }
+ if (!($sth = $this->dbh->prepare('DELETE FROM ' . $this->identifier_quote_char . $this->table . $this->identifier_quote_char . ' WHERE ' . $this->identifier_quote_char . $this->user_field . $this->identifier_quote_char . ' = ? AND ' . $this->identifier_quote_char . $this->key_field . $this->identifier_quote_char . ' = ?'))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $this->dbh->errorInfo());
+ else
+ $this->error = _("Could not prepare query");
+ $this->failQuery();
+ }
+ if (!($res = $sth->execute(array($user, $key)))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $sth->errorInfo());
+ else
+ $this->error = _("Could not execute query");
+ $this->dbh->exec('ROLLBACK TRANSACTION');
+ $this->failQuery();
+ }
+ if (!($sth = $this->dbh->prepare('INSERT INTO ' . $this->identifier_quote_char . $this->table . $this->identifier_quote_char . ' (' . $this->identifier_quote_char . $this->user_field . $this->identifier_quote_char . ', ' . $this->identifier_quote_char . $this->key_field . $this->identifier_quote_char . ', ' . $this->identifier_quote_char . $this->val_field . $this->identifier_quote_char . ') VALUES (?, ?, ?)'))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $this->dbh->errorInfo());
+ else
+ $this->error = _("Could not prepare query");
+ $this->failQuery();
+ }
+ if (!($res = $sth->execute(array($user, $key, $value)))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $sth->errorInfo());
+ else
+ $this->error = _("Could not execute query");
+ $this->dbh->exec('ROLLBACK TRANSACTION');
+ $this->failQuery();
+ }
+ if ($this->dbh->exec('COMMIT TRANSACTION') === FALSE) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $this->dbh->errorInfo());
+ else
+ $this->error = _("Could not execute query");
+ $this->failQuery();
+ }
+ } else {
+ $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");
}
- $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);
+ if ($use_pdo) {
+ if (!($sth = $this->dbh->prepare('DELETE FROM ' . $this->identifier_quote_char . $this->table . $this->identifier_quote_char . ' WHERE ' . $this->identifier_quote_char . $this->user_field . $this->identifier_quote_char . ' = ? AND ' . $this->identifier_quote_char . $this->key_field . $this->identifier_quote_char . ' = ?'))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $this->dbh->errorInfo());
+ else
+ $this->error = _("Could not prepare query");
+ $this->failQuery();
+ }
+ if (!($res = $sth->execute(array($user, $key)))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $sth->errorInfo());
+ else
+ $this->error = _("Could not execute query");
+ $this->failQuery();
+ }
+ if (!($sth = $this->dbh->prepare('INSERT INTO ' . $this->identifier_quote_char . $this->table . $this->identifier_quote_char . ' (' . $this->identifier_quote_char . $this->user_field . $this->identifier_quote_char . ', ' . $this->identifier_quote_char . $this->key_field . $this->identifier_quote_char . ', ' . $this->identifier_quote_char . $this->val_field . $this->identifier_quote_char . ') VALUES (?, ?, ?)'))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $this->dbh->errorInfo());
+ else
+ $this->error = _("Could not prepare query");
+ $this->failQuery();
+ }
+ if (!($res = $sth->execute(array($user, $key, $value)))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $sth->errorInfo());
+ else
+ $this->error = _("Could not execute query");
+ $this->failQuery();
+ }
+ } 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);
+ }
}
}
@@ -407,31 +692,55 @@ class dbPrefs {
/**
* Fill preference cache array
+ *
* @param string $user user name
+ *
* @since 1.2.3
+ *
*/
function fillPrefsCache($user) {
- global $prefs_cache;
+ global $prefs_cache, $use_pdo, $pdo_show_sql_errors;
if (!$this->open()) {
return;
}
$prefs_cache = array();
- $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)) {
- $this->failQuery($res);
- }
+ if ($use_pdo) {
+ if (!($sth = $this->dbh->prepare('SELECT ' . $this->identifier_quote_char . $this->key_field . $this->identifier_quote_char . ' AS prefkey, ' . $this->identifier_quote_char . $this->val_field . $this->identifier_quote_char . ' AS prefval FROM ' . $this->identifier_quote_char . $this->table . $this->identifier_quote_char . ' WHERE ' . $this->identifier_quote_char . $this->user_field . $this->identifier_quote_char . ' = ?'))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $this->dbh->errorInfo());
+ else
+ $this->error = _("Could not prepare query");
+ $this->failQuery();
+ }
+ if (!($res = $sth->execute(array($user)))) {
+ if ($pdo_show_sql_errors)
+ $this->error = implode(' - ', $sth->errorInfo());
+ else
+ $this->error = _("Could not execute query");
+ $this->failQuery();
+ }
+
+ while ($row = $sth->fetch(PDO::FETCH_ASSOC)) {
+ $prefs_cache[$row['prefkey']] = $row['prefval'];
+ }
+ } else {
+ $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)) {
+ $this->failQuery($res);
+ }
- while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
- $prefs_cache[$row['prefkey']] = $row['prefval'];
+ while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
+ $prefs_cache[$row['prefkey']] = $row['prefval'];
+ }
}
}
@@ -439,10 +748,10 @@ class dbPrefs {
/**
- * returns the value for the pref $string
+ * Returns the value for the requested preference
* @ignore
*/
-function getPref($data_dir, $username, $string, $default = '') {
+function getPref($data_dir, $username, $pref_name, $default = '') {
$db = new dbPrefs;
if(isset($db->error)) {
printf( _("Preference database error (%s). Exiting abnormally"),
@@ -450,24 +759,24 @@ function getPref($data_dir, $username, $string, $default = '') {
exit;
}
- return $db->getKey($username, $string, $default);
+ return $db->getKey($username, $pref_name, $default);
}
/**
- * Remove the pref $string
+ * Remove the desired preference setting ($pref_name)
* @ignore
*/
-function removePref($data_dir, $username, $string) {
+function removePref($data_dir, $username, $pref_name) {
global $prefs_cache;
$db = new dbPrefs;
if(isset($db->error)) {
$db->failQuery();
}
- $db->deleteKey($username, $string);
+ $db->deleteKey($username, $pref_name);
- if (isset($prefs_cache[$string])) {
- unset($prefs_cache[$string]);
+ if (isset($prefs_cache[$pref_name])) {
+ unset($prefs_cache[$pref_name]);
}
sqsession_register($prefs_cache , 'prefs_cache');
@@ -475,18 +784,18 @@ function removePref($data_dir, $username, $string) {
}
/**
- * sets the pref, $string, to $set_to
+ * Sets the desired preference setting ($pref_name) to whatever is in $value
* @ignore
*/
-function setPref($data_dir, $username, $string, $set_to) {
+function setPref($data_dir, $username, $pref_name, $value) {
global $prefs_cache;
- if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $set_to)) {
+ if (isset($prefs_cache[$pref_name]) && ($prefs_cache[$pref_name] == $value)) {
return;
}
- if ($set_to === '') {
- removePref($data_dir, $username, $string);
+ if ($value === '') {
+ removePref($data_dir, $username, $pref_name);
return;
}
@@ -495,11 +804,11 @@ function setPref($data_dir, $username, $string, $set_to) {
$db->failQuery();
}
- $db->setKey($username, $string, $set_to);
- $prefs_cache[$string] = $set_to;
+ $db->setKey($username, $pref_name, $value);
+ $prefs_cache[$pref_name] = $value;
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_BAIL, 1);
- assert ('$set_to == $prefs_cache[$string]');
+ assert ('$value == $prefs_cache[$pref_name]');
sqsession_register($prefs_cache , 'prefs_cache');
return;
}
@@ -519,13 +828,13 @@ function checkForPrefs($data_dir, $username) {
* Writes the Signature
* @ignore
*/
-function setSig($data_dir, $username, $number, $string) {
+function setSig($data_dir, $username, $number, $value) {
if ($number == "g") {
$key = '___signature___';
} else {
$key = sprintf('___sig%s___', $number);
}
- setPref($data_dir, $username, $key, $string);
+ setPref($data_dir, $username, $key, $value);
return;
}
@@ -541,6 +850,3 @@ function getSig($data_dir, $username, $number) {
}
return getPref($data_dir, $username, $key);
}
-
-// vim: et ts=4
-?>
\ No newline at end of file