functions/db_prefs.php

   1 <?php
   2
   3 /*
   4  * db_prefs.php
   5  *
   6  * Copyright (c) 1999-2002 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * This contains functions for manipulating user preferences
  10  * stored in a database, accessed though the Pear DB layer.
  11  *
  12  * To use this instead of the regular prefs.php, create a
  13  * database as described below, and replace prefs.php
  14  * with this file.
  15  *
  16  * Database:
  17  * ---------
  18  *
  19  * The preferences table should have three columns:
  20  *    user       char  \  primary
  21  *    prefkey    char  /  key
  22  *    prefval    blob
  23  *
  24  *   CREATE TABLE userprefs (user CHAR(128) NOT NULL DEFAULT '',
  25  *                           prefkey CHAR(64) NOT NULL DEFAULT '',
  26  *                           prefval BLOB NOT NULL DEFAULT '',
  27  *                           primary key (user,prefkey));
  28  *
  29  * Configuration of databasename, username and password is done
  30  * by using conf.pl or the administrator plugin
  31  *
  32  * $Id$
  33  */
  34
  35 require_once('DB.php');
  36 require_once('../config/config.php');
  37
  38 global $prefs_are_cached, $prefs_cache;
  39
  40 function cachePrefValues($username) {
  41     global $prefs_are_cached, $prefs_cache;
  42
  43     if ($prefs_are_cached) {
  44         return;
  45     }
  46
  47     session_unregister('prefs_cache');
  48     session_unregister('prefs_are_cached');
  49
  50     $db = new dbPrefs;
  51     if(isset($db->error)) {
  52         printf( _("Preference database error (%s). Exiting abnormally"),
  53               $db->error);
  54         exit;
  55     }
  56
  57     $db->fillPrefsCache($username);
  58     if (isset($db->error)) {
  59         printf( _("Preference database error (%s). Exiting abnormally"),
  60               $db->error);
  61         exit;
  62     }
  63
  64     $prefs_are_cached = true;
  65
  66     session_register('prefs_cache');
  67     session_register('prefs_are_cached');
  68 }
  69
  70 class dbPrefs {
  71     var $table = 'userprefs';
  72     var $user_field = 'user';
  73     var $key_field = 'prefkey';
  74     var $val_field = 'prefval';
  75
  76     var $dbh   = NULL;
  77     var $error = NULL;
  78
  79     var $default = Array('chosen_theme' => '../themes/default_theme.php',
  80                          'show_html_default' => '0');
  81
  82     function open() {
  83         global $prefs_dsn, $prefs_table;
  84
  85         if(isset($this->dbh)) {
  86             return true;
  87         }
  88
  89         if (!empty($prefs_table)) {
  90             $this->table = $prefs_table;
  91         }
  92         if (!empty($prefs_user_field)) {
  93             $this->user_field = $prefs_user_field;
  94         }
  95         if (!empty($prefs_key_field)) {
  96             $this->key_field = $prefs_key_field;
  97         }
  98         if (!empty($prefs_val_field)) {
  99             $this->val_field = $prefs_val_field;
 100         }
 101         $dbh = DB::connect($prefs_dsn, true);
 102
 103         if(DB::isError($dbh) || DB::isWarning($dbh)) {
 104             $this->error = DB::errorMessage($dbh);
 105             return false;
 106         }
 107
 108         $this->dbh = $dbh;
 109         return true;
 110     }
 111
 112     function failQuery($res = NULL) {
 113         if($res == NULL) {
 114             printf(_("Preference database error (%s). Exiting abnormally"),
 115                   $this->error);
 116         } else {
 117             printf(_("Preference database error (%s). Exiting abnormally"),
 118                   DB::errorMessage($res));
 119         }
 120         exit;
 121     }
 122
 123
 124     function getKey($user, $key, $default = '') {
 125         global $prefs_cache;
 126
 127         cachePrefValues($user);
 128
 129         if (isset($prefs_cache[$key])) {
 130             return $prefs_cache[$key];
 131         } else {
 132             if (isset($this->default[$key])) {
 133                 return $this->default[$key];
 134             } else {
 135                 return $default;
 136             }
 137         }
 138     }
 139
 140     function deleteKey($user, $key) {
 141         global $prefs_cache;
 142
 143         if (!$this->open()) {
 144             return false;
 145         }
 146         $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
 147                          $this->table,
 148                          $this->user_field,
 149                          $this->dbh->quoteString($user),
 150                          $this->key_field,
 151                          $this->dbh->quoteString($key));
 152
 153         $res = $this->dbh->simpleQuery($query);
 154         if(DB::isError($res)) {
 155             $this->failQuery($res);
 156         }
 157
 158         unset($prefs_cache[$key]);
 159
 160         if(substr($key, 0, 9) == 'highlight') {
 161             $this->renumberHighlightList($user);
 162         }
 163
 164         return true;
 165     }
 166
 167     function setKey($user, $key, $value) {
 168         if (!$this->open()) {
 169             return false;
 170         }
 171         $query = sprintf("REPLACE INTO %s (%s, %s, %s) ".
 172                          "VALUES('%s','%s','%s')",
 173                          $this->table,
 174                          $this->user_field,
 175                          $this->key_field,
 176                          $this->val_field,
 177                          $this->dbh->quoteString($user),
 178                          $this->dbh->quoteString($key),
 179                          $this->dbh->quoteString($value));
 180
 181         $res = $this->dbh->simpleQuery($query);
 182         if(DB::isError($res)) {
 183             $this->failQuery($res);
 184         }
 185
 186         return true;
 187     }
 188
 189     function fillPrefsCache($user) {
 190         global $prefs_cache;
 191
 192         if (!$this->open()) {
 193             return;
 194         }
 195
 196         $prefs_cache = array();
 197         $query = sprintf("SELECT %s as prefkey, %s as prefval FROM %s ".
 198                          "WHERE %s = '%s'",
 199                          $this->key_field,
 200                          $this->val_field,
 201                          $this->table,
 202                          $this->user_field,
 203                          $this->dbh->quoteString($user));
 204         $res = $this->dbh->query($query);
 205         if (DB::isError($res)) {
 206             $this->failQuery($res);
 207         }
 208
 209         while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
 210             $prefs_cache[$row['prefkey']] = $row['prefval'];
 211         }
 212     }
 213
 214     /*
 215      * When a highlight option is deleted the preferences module
 216      * must renumber the list.  This should be done somewhere else,
 217      * but it is not, so....
 218      */
 219     function renumberHighlightList($user) {
 220         if (!$this->open()) {
 221             return;
 222         }
 223         $query = sprintf("SELECT %s, %s as prefkey, %s as prefval FROM %s WHERE %s='%s' ".
 224                          "AND %s LIKE 'highlight%%' ORDER BY %s",
 225                          $this->user_field,
 226                          $this->key_field,
 227                          $this->val_field,
 228                          $this->table,
 229                          $this->user_field,
 230                          $this->dbh->quoteString($user),
 231                          $this->key_field,
 232                          $this->key_field);
 233
 234         $res = $this->dbh->query($query);
 235         if(DB::isError($res)) {
 236             $this->failQuery($res);
 237         }
 238
 239         /* Store old data in array */
 240         $rows = Array();
 241         while($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
 242             $rows[] = $row;
 243         }
 244
 245         /* Renumber keys of old data */
 246         $hilinum = 0;
 247         for($i = 0; $i < count($rows) ; $i++) {
 248             $oldkey = $rows[$i]['prefkey'];
 249             $newkey = substr($oldkey, 0, 9) . $hilinum;
 250             $hilinum++;
 251
 252             if($oldkey != $newkey) {
 253                 $query = sprintf("UPDATE %s SET %s='%s' ".
 254                                  "WHERE %s ='%s' AND %s='%s'",
 255                                  $this->table,
 256                                  $this->key_field,
 257                                  $this->dbh->quoteString($newkey),
 258                                  $this->user_field,
 259                                  $this->dbh->quoteString($user),
 260                                  $this->key_field,
 261                                  $this->dbh->quoteString($oldkey));
 262
 263                 $res = $this->dbh->simpleQuery($query);
 264                 if(DB::isError($res)) {
 265                     $this->failQuery($res);
 266                 }
 267             }
 268         }
 269
 270         return;
 271     }
 272
 273 } /* end class dbPrefs */
 274
 275
 276 /* returns the value for the pref $string */
 277 function getPref($data_dir, $username, $string, $default = '') {
 278     $db = new dbPrefs;
 279     if(isset($db->error)) {
 280         printf( _("Preference database error (%s). Exiting abnormally"),
 281               $db->error);
 282         exit;
 283     }
 284
 285     return $db->getKey($username, $string, $default);
 286 }
 287
 288 /* Remove the pref $string */
 289 function removePref($data_dir, $username, $string) {
 290     $db = new dbPrefs;
 291     if(isset($db->error)) {
 292         $db->failQuery();
 293     }
 294
 295     $db->deleteKey($username, $string);
 296     return;
 297 }
 298
 299 /* sets the pref, $string, to $set_to */
 300 function setPref($data_dir, $username, $string, $set_to) {
 301     global $prefs_cache;
 302
 303     if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $set_to)) {
 304         return;
 305     }
 306
 307     if ($set_to == '') {
 308         removePref($data_dir, $username, $string);
 309         return;
 310     }
 311
 312     $db = new dbPrefs;
 313     if(isset($db->error)) {
 314         $db->failQuery();
 315     }
 316
 317     $db->setKey($username, $string, $set_to);
 318     $prefs_cache[$string] = $set_to;
 319     assert_options(ASSERT_ACTIVE, 1);
 320     assert_options(ASSERT_BAIL, 1);
 321     assert ('$set_to == $prefs_cache[$string]');
 322
 323     return;
 324 }
 325
 326 /* This checks if the prefs are available */
 327 function checkForPrefs($data_dir, $username) {
 328     $db = new dbPrefs;
 329     if(isset($db->error)) {
 330         $db->failQuery();
 331     }
 332 }
 333
 334 /* Writes the Signature */
 335 function setSig($data_dir, $username, $number, $string) {
 336     $db = new dbPrefs;
 337     if(isset($db->error)) {
 338         $db->failQuery();
 339     }
 340
 341     if ($number == "g") {
 342         $key = '___signature___';
 343     } else {
 344         $key = sprintf('___sig%s___', $number);
 345     }
 346     $db->setKey($username, $key, $string);
 347     return;
 348 }
 349
 350 /* Gets the signature */
 351 function getSig($data_dir, $username, $number) {
 352     $db = new dbPrefs;
 353     if(isset($db->error)) {
 354         $db->failQuery();
 355     }
 356
 357     if ($number == "g") {
 358         $key = '___signature___';
 359     } else {
 360         $key = sprintf('___sig%d___', $number);
 361     }
 362     return $db->getKey($username, $key);
 363 }
 364
 365 ?>