[1] | 1 | <?php |
---|
| 2 | /** |
---|
[136] | 3 | * Prefs.inc.php |
---|
| 4 | * code by strangecode :: www.strangecode.com :: this document contains copyrighted information |
---|
[1] | 5 | * |
---|
[146] | 6 | * Prefs provides an API for saving arbitrary values in a user's session. |
---|
| 7 | * Session prefs can be stored into a database with the optional save() and load() methods. |
---|
[136] | 8 | * |
---|
[1] | 9 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
[136] | 10 | * @version 2.1 |
---|
[150] | 11 | * |
---|
| 12 | * Example of use: |
---|
| 13 | --------------------------------------------------------------------- |
---|
[151] | 14 | // Load preferences for the user's session. |
---|
[150] | 15 | require_once 'codebase/lib/Prefs.inc.php'; |
---|
[153] | 16 | $prefs = new Prefs('my-namespace'); |
---|
[150] | 17 | $prefs->setParam(array( |
---|
[152] | 18 | 'persistent' => $auth->isLoggedIn(), |
---|
[150] | 19 | 'user_id' => $auth->get('user_id'), |
---|
| 20 | )); |
---|
| 21 | $prefs->setDefaults(array( |
---|
| 22 | 'search_num_results' => 25, |
---|
| 23 | 'datalog_num_entries' => 25, |
---|
| 24 | )); |
---|
| 25 | $prefs->load(); |
---|
[151] | 26 | |
---|
| 27 | // Update preferences. Make sure to validate this input first! |
---|
| 28 | $prefs->set('search_num_results', getFormData('search_num_results')); |
---|
| 29 | $prefs->set('datalog_num_entries', getFormData('datalog_num_entries')); |
---|
| 30 | $prefs->save(); |
---|
| 31 | |
---|
[150] | 32 | --------------------------------------------------------------------- |
---|
[1] | 33 | */ |
---|
| 34 | class Prefs { |
---|
| 35 | |
---|
[136] | 36 | // Namespace of this instance of Prefs. |
---|
| 37 | var $_ns; |
---|
[1] | 38 | |
---|
[152] | 39 | // Configuration parameters for this object. |
---|
[146] | 40 | var $_params = array( |
---|
| 41 | |
---|
[152] | 42 | // Enable database storage. If this is false, all prefs will live only as long as the session. |
---|
| 43 | 'persistent' => false, |
---|
| 44 | |
---|
| 45 | // The current user_id for which to load/save persistent preferences. |
---|
[149] | 46 | 'user_id' => null, |
---|
| 47 | |
---|
[152] | 48 | // How long before we force a reload of the persistent prefs data? 3600 = once every hour. |
---|
[149] | 49 | 'load_timeout' => 3600, |
---|
| 50 | |
---|
[152] | 51 | // Name of database table to store persistent prefs. |
---|
[147] | 52 | 'db_table' => 'pref_tbl', |
---|
[146] | 53 | |
---|
| 54 | // Automatically create table and verify columns. Better set to false after site launch. |
---|
| 55 | 'create_table' => true, |
---|
| 56 | ); |
---|
| 57 | |
---|
[1] | 58 | /** |
---|
| 59 | * Prefs constructor. |
---|
| 60 | */ |
---|
[136] | 61 | function Prefs($namespace='') |
---|
[1] | 62 | { |
---|
[146] | 63 | $app =& App::getInstance(); |
---|
| 64 | |
---|
[154] | 65 | $this->_ns = $namespace; |
---|
[136] | 66 | |
---|
| 67 | // Initialized the prefs array. |
---|
[154] | 68 | if (!isset($_SESSION['_prefs'][$this->_ns])) { |
---|
[150] | 69 | $this->clear(); |
---|
[136] | 70 | } |
---|
[146] | 71 | |
---|
| 72 | // Get create tables config from global context. |
---|
| 73 | if (!is_null($app->getParam('db_create_tables'))) { |
---|
| 74 | $this->setParam(array('create_table' => $app->getParam('db_create_tables'))); |
---|
| 75 | } |
---|
[1] | 76 | } |
---|
| 77 | |
---|
| 78 | /** |
---|
[146] | 79 | * Setup the database table for this class. |
---|
| 80 | * |
---|
| 81 | * @access public |
---|
| 82 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 83 | * @since 04 Jun 2006 16:41:42 |
---|
| 84 | */ |
---|
| 85 | function initDB($recreate_db=false) |
---|
| 86 | { |
---|
| 87 | $app =& App::getInstance(); |
---|
| 88 | $db =& DB::getInstance(); |
---|
| 89 | |
---|
| 90 | static $_db_tested = false; |
---|
| 91 | |
---|
| 92 | if ($recreate_db || !$_db_tested && $this->getParam('create_table')) { |
---|
| 93 | if ($recreate_db) { |
---|
| 94 | $db->query("DROP TABLE IF EXISTS " . $this->getParam('db_table')); |
---|
| 95 | $app->logMsg(sprintf('Dropping and recreating table %s.', $this->getParam('db_table')), LOG_DEBUG, __FILE__, __LINE__); |
---|
| 96 | } |
---|
| 97 | $db->query("CREATE TABLE IF NOT EXISTS " . $db->escapeString($this->getParam('db_table')) . " ( |
---|
| 98 | user_id VARCHAR(32) NOT NULL DEFAULT '', |
---|
| 99 | pref_namespace VARCHAR(32) NOT NULL DEFAULT '', |
---|
| 100 | pref_key VARCHAR(64) NOT NULL DEFAULT '', |
---|
| 101 | pref_value TEXT, |
---|
| 102 | PRIMARY KEY (user_id, pref_namespace, pref_key) |
---|
| 103 | )"); |
---|
| 104 | |
---|
| 105 | if (!$db->columnExists($this->getParam('db_table'), array( |
---|
| 106 | 'user_id', |
---|
| 107 | 'pref_namespace', |
---|
| 108 | 'pref_key', |
---|
| 109 | 'pref_value', |
---|
| 110 | ), false, false)) { |
---|
| 111 | $app->logMsg(sprintf('Database table %s has invalid columns. Please update this table manually.', $this->getParam('db_table')), LOG_ALERT, __FILE__, __LINE__); |
---|
| 112 | trigger_error(sprintf('Database table %s has invalid columns. Please update this table manually.', $this->getParam('db_table')), E_USER_ERROR); |
---|
| 113 | } |
---|
| 114 | } |
---|
| 115 | $_db_tested = true; |
---|
| 116 | } |
---|
| 117 | |
---|
| 118 | /** |
---|
| 119 | * Set the params of this object. |
---|
| 120 | * |
---|
| 121 | * @param array $params Array of param keys and values to set. |
---|
| 122 | */ |
---|
| 123 | function setParam($params=null) |
---|
| 124 | { |
---|
| 125 | if (isset($params) && is_array($params)) { |
---|
| 126 | // Merge new parameters with old overriding only those passed. |
---|
| 127 | $this->_params = array_merge($this->_params, $params); |
---|
| 128 | } |
---|
| 129 | } |
---|
| 130 | |
---|
| 131 | /** |
---|
| 132 | * Return the value of a parameter, if it exists. |
---|
| 133 | * |
---|
| 134 | * @access public |
---|
| 135 | * @param string $param Which parameter to return. |
---|
| 136 | * @return mixed Configured parameter value. |
---|
| 137 | */ |
---|
| 138 | function getParam($param) |
---|
| 139 | { |
---|
| 140 | $app =& App::getInstance(); |
---|
| 141 | |
---|
| 142 | if (isset($this->_params[$param])) { |
---|
| 143 | return $this->_params[$param]; |
---|
| 144 | } else { |
---|
| 145 | $app->logMsg(sprintf('Parameter is not set: %s', $param), LOG_DEBUG, __FILE__, __LINE__); |
---|
| 146 | return null; |
---|
| 147 | } |
---|
| 148 | } |
---|
| 149 | |
---|
| 150 | /** |
---|
[151] | 151 | * Sets the default values for preferences. If a preference is not explicitly |
---|
| 152 | * set, the value set here will be used. Can be called multiple times to merge additional |
---|
| 153 | * defaults together. |
---|
[1] | 154 | * |
---|
[151] | 155 | * @param array $defaults Array of key-value pairs |
---|
[1] | 156 | */ |
---|
[146] | 157 | function setDefaults($defaults) |
---|
[1] | 158 | { |
---|
[146] | 159 | if (isset($defaults) && is_array($defaults)) { |
---|
[154] | 160 | $_SESSION['_prefs'][$this->_ns]['defaults'] = array_merge($_SESSION['_prefs'][$this->_ns]['defaults'], $defaults); |
---|
[1] | 161 | } |
---|
| 162 | } |
---|
| 163 | |
---|
| 164 | /** |
---|
[151] | 165 | * Store a key-value pair in the session. If the value is different than what is set by setDefaults |
---|
| 166 | * the value will be scheduled to be saved in the database. |
---|
| 167 | * This function determins what data is saved to the database. Ensure clean values! |
---|
[1] | 168 | * |
---|
[152] | 169 | * @param string $key The name of the preference to modify. |
---|
| 170 | * @param string $val The new value for this preference. |
---|
| 171 | * @param bool $persistent Save this value forever? Set to false and value will exist as long as the session is in use. |
---|
[1] | 172 | */ |
---|
[136] | 173 | function set($key, $val) |
---|
[1] | 174 | { |
---|
[151] | 175 | $app =& App::getInstance(); |
---|
[152] | 176 | |
---|
[151] | 177 | if ('' == $key) { |
---|
| 178 | $app->logMsg(sprintf('Key is empty (provided with value: %s)', $val), LOG_NOTICE, __FILE__, __LINE__); |
---|
| 179 | return false; |
---|
[149] | 180 | } |
---|
[152] | 181 | |
---|
[154] | 182 | if (!isset($_SESSION['_prefs'][$this->_ns]['defaults'][$key]) || $_SESSION['_prefs'][$this->_ns]['defaults'][$key] != $val || isset($_SESSION['_prefs'][$this->_ns]['persistent'][$key])) { |
---|
| 183 | $_SESSION['_prefs'][$this->_ns]['persistent'][$key] = $val; |
---|
[151] | 184 | } |
---|
[1] | 185 | } |
---|
[42] | 186 | |
---|
[1] | 187 | /** |
---|
[151] | 188 | * Returns the value of the requested preference. Persistent values take precedence, but if none is set |
---|
| 189 | * a default value is returned, or if not that, null. |
---|
[1] | 190 | * |
---|
[136] | 191 | * @param string $key The name of the preference to retrieve. |
---|
[1] | 192 | * |
---|
| 193 | * @return string The value of the preference. |
---|
| 194 | */ |
---|
[136] | 195 | function get($key) |
---|
[1] | 196 | { |
---|
[151] | 197 | $app =& App::getInstance(); |
---|
[154] | 198 | if (array_key_exists($key, $_SESSION['_prefs'][$this->_ns]['persistent'])) { |
---|
| 199 | return $_SESSION['_prefs'][$this->_ns]['persistent'][$key]; |
---|
| 200 | } else if (array_key_exists($key, $_SESSION['_prefs'][$this->_ns]['defaults'])) { |
---|
| 201 | return $_SESSION['_prefs'][$this->_ns]['defaults'][$key]; |
---|
[151] | 202 | } else { |
---|
[154] | 203 | $app->logMsg(sprintf('Key not found in prefs cache: %s', $key), LOG_DEBUG, __FILE__, __LINE__); |
---|
[151] | 204 | return null; |
---|
| 205 | } |
---|
[1] | 206 | } |
---|
[42] | 207 | |
---|
[1] | 208 | /** |
---|
[152] | 209 | * To see if a preference has been set. |
---|
[1] | 210 | * |
---|
[136] | 211 | * @param string $key The name of the preference to check. |
---|
[151] | 212 | * @return boolean True if the preference isset and not empty false otherwise. |
---|
[1] | 213 | */ |
---|
[136] | 214 | function exists($key) |
---|
[1] | 215 | { |
---|
[154] | 216 | return array_key_exists($key, $_SESSION['_prefs'][$this->_ns]['persistent']); |
---|
[1] | 217 | } |
---|
[42] | 218 | |
---|
[1] | 219 | /** |
---|
[151] | 220 | * Clear a set preference value. This will also remove the value from the database. |
---|
[1] | 221 | * |
---|
[146] | 222 | * @param string $key The name of the preference to delete. |
---|
[1] | 223 | */ |
---|
[136] | 224 | function delete($key) |
---|
[1] | 225 | { |
---|
[154] | 226 | unset($_SESSION['_prefs'][$this->_ns]['persistent'][$key]); |
---|
[1] | 227 | } |
---|
| 228 | |
---|
| 229 | /** |
---|
[151] | 230 | * Resets the $_SESSION cache. This should be executed with the same consideration |
---|
| 231 | * as $auth->clear(), such as when logging out. |
---|
[1] | 232 | */ |
---|
[136] | 233 | function clear() |
---|
[1] | 234 | { |
---|
[154] | 235 | $_SESSION['_prefs'][$this->_ns] = array( |
---|
[150] | 236 | 'loaded' => false, |
---|
| 237 | 'load_datetime' => '1970-01-01', |
---|
[151] | 238 | 'defaults' => array(), |
---|
| 239 | 'persistent' => array(), |
---|
[150] | 240 | ); |
---|
[1] | 241 | } |
---|
[146] | 242 | |
---|
| 243 | /* |
---|
[151] | 244 | * Retrieves all prefs from the database and stores them in the $_SESSION. |
---|
[146] | 245 | * |
---|
| 246 | * @access public |
---|
[150] | 247 | * @param bool $force Set to always load from database, regardless if _isLoaded() or not. |
---|
[146] | 248 | * @return bool True if loading succeeded. |
---|
| 249 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 250 | * @version 1.0 |
---|
| 251 | * @since 04 Jun 2006 16:56:53 |
---|
| 252 | */ |
---|
[150] | 253 | function load($force=false) |
---|
[146] | 254 | { |
---|
| 255 | $app =& App::getInstance(); |
---|
| 256 | $db =& DB::getInstance(); |
---|
| 257 | |
---|
| 258 | // Skip this method if not using the db. |
---|
[152] | 259 | if (true !== $this->getParam('persistent')) { |
---|
[146] | 260 | return true; |
---|
| 261 | } |
---|
| 262 | |
---|
[150] | 263 | $this->initDB(); |
---|
| 264 | |
---|
[146] | 265 | // Prefs already loaded for this session. |
---|
[150] | 266 | if (!$force && $this->_isLoaded()) { |
---|
[146] | 267 | return true; |
---|
| 268 | } |
---|
| 269 | |
---|
| 270 | // User_id must not be empty. |
---|
| 271 | if ('' == $this->getParam('user_id')) { |
---|
[151] | 272 | $app->logMsg(sprintf('Cannot save prefs because user_id not set.', null), LOG_WARNING, __FILE__, __LINE__); |
---|
[146] | 273 | return false; |
---|
| 274 | } |
---|
| 275 | |
---|
[150] | 276 | // Clear existing cache. |
---|
| 277 | $this->clear(); |
---|
| 278 | |
---|
[151] | 279 | // Retrieve all prefs for this user and namespace. |
---|
[146] | 280 | $qid = $db->query(" |
---|
| 281 | SELECT pref_key, pref_value |
---|
| 282 | FROM " . $db->escapeString($this->getParam('db_table')) . " |
---|
| 283 | WHERE user_id = '" . $db->escapeString($this->getParam('user_id')) . "' |
---|
| 284 | AND pref_namespace = '" . $db->escapeString($this->_ns) . "' |
---|
| 285 | LIMIT 10000 |
---|
| 286 | "); |
---|
| 287 | while (list($key, $val) = mysql_fetch_row($qid)) { |
---|
[158] | 288 | $_SESSION['_prefs'][$this->_ns]['persistent'][$key] = unserialize($val); |
---|
[146] | 289 | } |
---|
| 290 | |
---|
[154] | 291 | $app->logMsg(sprintf('Loaded %s prefs from database.', sizeof($_SESSION['_prefs'][$this->_ns]['persistent'])), LOG_DEBUG, __FILE__, __LINE__); |
---|
[150] | 292 | |
---|
[146] | 293 | // Data loaded only once per session. |
---|
[154] | 294 | $_SESSION['_prefs'][$this->_ns]['loaded'] = true; |
---|
| 295 | $_SESSION['_prefs'][$this->_ns]['load_datetime'] = date('Y-m-d H:i:s'); |
---|
[146] | 296 | |
---|
| 297 | return true; |
---|
| 298 | } |
---|
| 299 | |
---|
| 300 | /* |
---|
[149] | 301 | * Returns true if the prefs had been loaded from the database into the $_SESSION recently. |
---|
| 302 | * This function is simply a check so the database isn't access every page load. |
---|
[146] | 303 | * |
---|
| 304 | * @access private |
---|
| 305 | * @return bool True if prefs are loaded. |
---|
| 306 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 307 | * @version 1.0 |
---|
| 308 | * @since 04 Jun 2006 17:12:44 |
---|
| 309 | */ |
---|
| 310 | function _isLoaded() |
---|
| 311 | { |
---|
[154] | 312 | if (isset($_SESSION['_prefs'][$this->_ns]['load_datetime']) |
---|
| 313 | && strtotime($_SESSION['_prefs'][$this->_ns]['load_datetime']) > time() - $this->getParam('load_timeout') |
---|
| 314 | && isset($_SESSION['_prefs'][$this->_ns]['loaded']) |
---|
| 315 | && true === $_SESSION['_prefs'][$this->_ns]['loaded']) { |
---|
[149] | 316 | return true; |
---|
| 317 | } else { |
---|
| 318 | return false; |
---|
| 319 | } |
---|
[146] | 320 | } |
---|
| 321 | |
---|
| 322 | /* |
---|
| 323 | * Saves all prefs stored in the $_SESSION into the database. |
---|
| 324 | * |
---|
| 325 | * @access public |
---|
| 326 | * @return bool True if prefs exist and were saved. |
---|
| 327 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 328 | * @version 1.0 |
---|
| 329 | * @since 04 Jun 2006 17:19:56 |
---|
| 330 | */ |
---|
| 331 | function save() |
---|
| 332 | { |
---|
| 333 | $app =& App::getInstance(); |
---|
| 334 | $db =& DB::getInstance(); |
---|
| 335 | |
---|
| 336 | // Skip this method if not using the db. |
---|
[152] | 337 | if (true !== $this->getParam('persistent')) { |
---|
[146] | 338 | return true; |
---|
| 339 | } |
---|
| 340 | |
---|
| 341 | // User_id must not be empty. |
---|
| 342 | if ('' == $this->getParam('user_id')) { |
---|
[151] | 343 | $app->logMsg(sprintf('Cannot save prefs because user_id not set.', null), LOG_WARNING, __FILE__, __LINE__); |
---|
[146] | 344 | return false; |
---|
| 345 | } |
---|
| 346 | |
---|
| 347 | $this->initDB(); |
---|
| 348 | |
---|
[154] | 349 | if (isset($_SESSION['_prefs'][$this->_ns]['persistent']) && is_array($_SESSION['_prefs'][$this->_ns]['persistent'])) { |
---|
[146] | 350 | // Delete old prefs from database. |
---|
| 351 | $db->query(" |
---|
| 352 | DELETE FROM " . $db->escapeString($this->getParam('db_table')) . " |
---|
| 353 | WHERE user_id = '" . $db->escapeString($this->getParam('user_id')) . "' |
---|
| 354 | AND pref_namespace = '" . $db->escapeString($this->_ns) . "' |
---|
| 355 | "); |
---|
| 356 | |
---|
| 357 | // Insert new prefs. |
---|
| 358 | $insert_values = array(); |
---|
[154] | 359 | foreach ($_SESSION['_prefs'][$this->_ns]['persistent'] as $key => $val) { |
---|
[158] | 360 | $insert_values[] = sprintf("('%s', '%s', '%s', '%s')", |
---|
| 361 | $db->escapeString($this->getParam('user_id')), |
---|
| 362 | $db->escapeString($this->_ns), |
---|
| 363 | $db->escapeString($key), |
---|
| 364 | $db->escapeString(serialize($val)) |
---|
| 365 | ); |
---|
[146] | 366 | } |
---|
| 367 | $db->query(" |
---|
| 368 | INSERT LOW_PRIORITY INTO " . $db->escapeString($this->getParam('db_table')) . " |
---|
| 369 | (user_id, pref_namespace, pref_key, pref_value) |
---|
| 370 | VALUES " . join(', ', $insert_values) . " |
---|
| 371 | "); |
---|
| 372 | |
---|
[151] | 373 | $app->logMsg(sprintf('Saved %s prefs to database.', sizeof($insert_values)), LOG_DEBUG, __FILE__, __LINE__); |
---|
[146] | 374 | return true; |
---|
| 375 | } |
---|
| 376 | |
---|
| 377 | return false; |
---|
| 378 | } |
---|
[1] | 379 | } |
---|
| 380 | |
---|
| 381 | |
---|
| 382 | ?> |
---|