fixed comp_in_new handling
[squirrelmail.git] / functions / db_prefs.php
index 7bc0800a6e956525d21fbc879c3a7e9c2e78e24c..fb81c3d31d3a6305832ca73809f04b408c6228e5 100644 (file)
@@ -16,8 +16,8 @@
  * 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
  *
  *                           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$
  */
 
+define('SMDB_UNKNOWN', 0);
+define('SMDB_MYSQL', 1);
+define('SMDB_PGSQL', 2);
+
 require_once('DB.php');
+require_once('../config/config.php');
 
 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();
-}
-
 function cachePrefValues($username) {
     global $prefs_are_cached, $prefs_cache;
 
@@ -75,20 +72,45 @@ function cachePrefValues($username) {
 }
 
 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',
                          '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 (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) || DB::isWarning($dbh)) {
             $this->error = DB::errorMessage($dbh);
@@ -130,10 +152,14 @@ class dbPrefs {
     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);
@@ -151,17 +177,74 @@ class dbPrefs {
     }
 
     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;
@@ -170,12 +253,17 @@ class dbPrefs {
     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)) {
@@ -193,11 +281,19 @@ class dbPrefs {
      * 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",
+        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->dbh->quoteString($user));
+                         $this->user_field,
+                         $this->dbh->quoteString($user),
+                         $this->key_field,
+                         $this->key_field);
 
         $res = $this->dbh->query($query);
         if(DB::isError($res)) {
@@ -218,11 +314,14 @@ class dbPrefs {
             $hilinum++;
 
             if($oldkey != $newkey) {
-                $query = sprintf("UPDATE %s SET prefkey='%s' ".
-                                 "WHERE user ='%s' AND prefkey='%s'",
+                $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);
@@ -297,109 +396,24 @@ function checkForPrefs($data_dir, $username) {
 }
 
 /* Writes the Signature */
-function setSig($data_dir, $username, $string) {
-    $db = new dbPrefs;
-    if(isset($db->error)) {
-        $db->failQuery();
+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);
+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);
 }
 
 ?>