Congegni/sintonia
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

CC-5555 : Implement simple caching for preferences

Browse source 
fixing up code so user id is never passed in manually to a preference getter.
This commit is contained in:
Naomi 2013-11-11 16:20:51 -05:00
parent f45708682f
commit 06323a40fd
2 changed files with 84 additions and 80 deletions
Download patch file Download diff file Expand all files Collapse all files

8
airtime_mvc/application/controllers/UserController.php
View file

@ -72,8 +72,8 @@ class UserController extends Zend_Controller_Action
// Language and timezone settings are saved on a per-user basis // Language and timezone settings are saved on a per-user basis
// By default, the default language, and timezone setting on // By default, the default language, and timezone setting on
// preferences page is what gets assigned. // preferences page is what gets assigned.
Application_Model_Preference::SetUserLocale($user->getId()); Application_Model_Preference::SetUserLocale();
Application_Model_Preference::SetUserTimezone($user->getId()); Application_Model_Preference::SetUserTimezone();
$form->reset(); $form->reset();
$this->view->form = $form; $this->view->form = $form;
@ -143,8 +143,8 @@ class UserController extends Zend_Controller_Action
$user->setJabber($formData['cu_jabber']); $user->setJabber($formData['cu_jabber']);
$user->save(); $user->save();
Application_Model_Preference::SetUserLocale($user->getId(), $formData['cu_locale']); Application_Model_Preference::SetUserLocale($formData['cu_locale']);
Application_Model_Preference::SetUserTimezone($user->getId(), $formData['cu_timezone']); Application_Model_Preference::SetUserTimezone($formData['cu_timezone']);
//configure localization with new locale setting //configure localization with new locale setting
Application_Model_Locale::configureLocalization($formData['cu_locale']); Application_Model_Locale::configureLocalization($formData['cu_locale']);

130
airtime_mvc/application/models/Preference.php
View file

@ -5,12 +5,25 @@ require_once 'Cache.php';
class Application_Model_Preference class Application_Model_Preference
{ {
private static function getUserId()
{
//called from a daemon process
if (!class_exists("Zend_Auth", false) || !Zend_Auth::getInstance()->hasIdentity()) {
$userId = null;
}
else {
$auth = Zend_Auth::getInstance();
$userId = $auth->getIdentity()->id;
}
return $userId;
}
/** /**
* *
* @param integer $userId is not null when we are setting a locale for a specific user
* @param boolean $isUserValue is true when we are setting a value for the current user * @param boolean $isUserValue is true when we are setting a value for the current user
*/ */
private static function setValue($key, $value, $isUserValue = false, $userId = null) private static function setValue($key, $value, $isUserValue = false)
{ {
$cache = new Cache(); $cache = new Cache();
@ -18,14 +31,14 @@ class Application_Model_Preference
$con = Propel::getConnection(CcPrefPeer::DATABASE_NAME); $con = Propel::getConnection(CcPrefPeer::DATABASE_NAME);
$con->beginTransaction(); $con->beginTransaction();
//called from a daemon process $userId = self::getUserId();
if (!class_exists("Zend_Auth", false) || !Zend_Auth::getInstance()->hasIdentity()) {
$id = NULL; if ($isUserValue && is_null($userId)) {
} else { throw new Exception("User id can't be null for a user preference.");
$auth = Zend_Auth::getInstance();
$id = $auth->getIdentity()->id;
} }
Application_Common_Database::prepareAndExecute("LOCK TABLE cc_pref");
//Check if key already exists //Check if key already exists
$sql = "SELECT COUNT(*) FROM cc_pref" $sql = "SELECT COUNT(*) FROM cc_pref"
." WHERE keystr = :key"; ." WHERE keystr = :key";
@ -34,16 +47,11 @@ class Application_Model_Preference
$paramMap[':key'] = $key; $paramMap[':key'] = $key;
//For user specific preference, check if id matches as well //For user specific preference, check if id matches as well
if ($isUserValue && is_null($userId)) { if ($isUserValue) {
$sql .= " AND subjid = :id";
$paramMap[':id'] = $id;
} else if (!is_null($userId)) {
$sql .= " AND subjid = :id"; $sql .= " AND subjid = :id";
$paramMap[':id'] = $userId; $paramMap[':id'] = $userId;
} }
Application_Common_Database::prepareAndExecute("LOCK TABLE cc_pref");
$result = Application_Common_Database::prepareAndExecute($sql, $result = Application_Common_Database::prepareAndExecute($sql,
$paramMap, $paramMap,
Application_Common_Database::COLUMN, Application_Common_Database::COLUMN,
@ -55,41 +63,41 @@ class Application_Model_Preference
//this case should not happen. //this case should not happen.
throw new Exception("Invalid number of results returned. Should be ". throw new Exception("Invalid number of results returned. Should be ".
"0 or 1, but is '$result' instead"); "0 or 1, but is '$result' instead");
} elseif ($result == 1) { }
elseif ($result == 1) {
// result found // result found
if (is_null($id) || !$isUserValue) { if (is_null($userId)) {
// system pref // system pref
$sql = "UPDATE cc_pref" $sql = "UPDATE cc_pref"
." SET subjid = NULL, valstr = :value" ." SET subjid = NULL, valstr = :value"
." WHERE keystr = :key"; ." WHERE keystr = :key";
} else { }
else {
// user pref // user pref
$sql = "UPDATE cc_pref" $sql = "UPDATE cc_pref"
. " SET valstr = :value" . " SET valstr = :value"
. " WHERE keystr = :key AND subjid = :id"; . " WHERE keystr = :key AND subjid = :id";
if (is_null($userId)) {
$paramMap[':id'] = $id;
} else {
$paramMap[':id'] = $userId; $paramMap[':id'] = $userId;
} }
} }
} else { else {
// result not found // result not found
if (is_null($id) || !$isUserValue) { if (is_null($userId)) {
// system pref // system pref
$sql = "INSERT INTO cc_pref (keystr, valstr)" $sql = "INSERT INTO cc_pref (keystr, valstr)"
." VALUES (:key, :value)"; ." VALUES (:key, :value)";
} else { }
else {
// user pref // user pref
$sql = "INSERT INTO cc_pref (subjid, keystr, valstr)" $sql = "INSERT INTO cc_pref (subjid, keystr, valstr)"
." VALUES (:id, :key, :value)"; ." VALUES (:id, :key, :value)";
if (is_null($userId)) {
$paramMap[':id'] = $id;
} else {
$paramMap[':id'] = $userId; $paramMap[':id'] = $userId;
} }
} }
}
$paramMap[':key'] = $key; $paramMap[':key'] = $key;
$paramMap[':value'] = $value; $paramMap[':value'] = $value;
@ -100,7 +108,8 @@ class Application_Model_Preference
$con); $con);
$con->commit(); $con->commit();
} catch (Exception $e) { }
catch (Exception $e) {
$con->rollback(); $con->rollback();
header('HTTP/1.0 503 Service Unavailable'); header('HTTP/1.0 503 Service Unavailable');
Logging::info("Database error: ".$e->getMessage()); Logging::info("Database error: ".$e->getMessage());
@ -115,13 +124,12 @@ class Application_Model_Preference
{ {
$cache = new Cache(); $cache = new Cache();
//For user specific preference, check if id matches as well try {
$userId = null;
if ($isUserValue) { $userId = self::getUserId();
$auth = Zend_Auth::getInstance();
if ($auth->hasIdentity()) { if ($isUserValue && is_null($userId)) {
$userId = $auth->getIdentity()->id; throw new Exception("User id can't be null for a user preference.");
}
} }
$res = $cache->fetch($key, $userId); $res = $cache->fetch($key, $userId);
@ -130,8 +138,6 @@ class Application_Model_Preference
return $res; return $res;
} }
try {
//Check if key already exists //Check if key already exists
$sql = "SELECT COUNT(*) FROM cc_pref" $sql = "SELECT COUNT(*) FROM cc_pref"
." WHERE keystr = :key"; ." WHERE keystr = :key";
@ -148,8 +154,9 @@ class Application_Model_Preference
$result = Application_Common_Database::prepareAndExecute($sql, $paramMap, Application_Common_Database::COLUMN); $result = Application_Common_Database::prepareAndExecute($sql, $paramMap, Application_Common_Database::COLUMN);
//return an empty string if the result doesn't exist.
if ($result == 0) { if ($result == 0) {
return ""; $res = "";
} }
else { else {
$sql = "SELECT valstr FROM cc_pref" $sql = "SELECT valstr FROM cc_pref"
@ -167,11 +174,12 @@ class Application_Model_Preference
$result = Application_Common_Database::prepareAndExecute($sql, $paramMap, Application_Common_Database::COLUMN); $result = Application_Common_Database::prepareAndExecute($sql, $paramMap, Application_Common_Database::COLUMN);
$res = ($result !== false) ? $result : ""; $res = ($result !== false) ? $result : "";
$cache->store($key, $res, $userId); }
$cache->store($key, $res, $userId);
return $res; return $res;
} }
} catch (Exception $e) { catch (Exception $e) {
header('HTTP/1.0 503 Service Unavailable'); header('HTTP/1.0 503 Service Unavailable');
Logging::info("Could not connect to database: ".$e->getMessage()); Logging::info("Could not connect to database: ".$e->getMessage());
exit; exit;
@ -531,6 +539,7 @@ class Application_Model_Preference
public static function SetDefaultTimezone($timezone) public static function SetDefaultTimezone($timezone)
{ {
self::setValue("timezone", $timezone); self::setValue("timezone", $timezone);
//TODO check this if setting value failes.
date_default_timezone_set($timezone); date_default_timezone_set($timezone);
} }
@ -540,14 +549,14 @@ class Application_Model_Preference
return self::getValue("timezone"); return self::getValue("timezone");
} }
public static function SetUserTimezone($userId, $timezone = null) public static function SetUserTimezone($timezone = null)
{ {
// When a new user is created they will get the default timezone // When a new user is created they will get the default timezone
// setting which the admin sets on preferences page // setting which the admin sets on preferences page
if (is_null($timezone)) { if (is_null($timezone)) {
$timezone = self::GetDefaultTimezone(); $timezone = self::GetDefaultTimezone();
} }
self::setValue("user_timezone", $timezone, true, $userId); self::setValue("user_timezone", $timezone, true);
} }
public static function GetUserTimezone($id) public static function GetUserTimezone($id)
@ -563,11 +572,12 @@ class Application_Model_Preference
// Always attempts to returns the current user's personal timezone setting // Always attempts to returns the current user's personal timezone setting
public static function GetTimezone() public static function GetTimezone()
{ {
$auth = Zend_Auth::getInstance(); $userId = self::getUserId();
if ($auth->hasIdentity()) {
$id = $auth->getIdentity()->id; if (!is_null($userId)) {
return self::GetUserTimezone($id); return self::GetUserTimezone();
} else { }
else {
return self::GetDefaultTimezone(); return self::GetDefaultTimezone();
} }
} }
@ -583,7 +593,7 @@ class Application_Model_Preference
return self::getValue("locale"); return self::getValue("locale");
} }
public static function GetUserLocale($id) public static function GetUserLocale()
{ {
$locale = self::getValue("user_locale", true); $locale = self::getValue("user_locale", true);
if (!$locale) { if (!$locale) {
@ -593,23 +603,24 @@ class Application_Model_Preference
} }
} }
public static function SetUserLocale($userId, $locale = null) public static function SetUserLocale($locale = null)
{ {
// When a new user is created they will get the default locale // When a new user is created they will get the default locale
// setting which the admin sets on preferences page // setting which the admin sets on preferences page
if (is_null($locale)) { if (is_null($locale)) {
$locale = self::GetDefaultLocale(); $locale = self::GetDefaultLocale();
} }
self::setValue("user_locale", $locale, true, $userId); self::setValue("user_locale", $locale, true);
} }
public static function GetLocale() public static function GetLocale()
{ {
$auth = Zend_Auth::getInstance(); $userId = self::getUserId();
if ($auth->hasIdentity()) {
$id = $auth->getIdentity()->id; if (!is_null($userId)) {
return self::GetUserLocale($id); return self::GetUserLocale($userId);
} else { }
else {
return self::GetDefaultLocale(); return self::GetDefaultLocale();
} }
} }
@ -1317,15 +1328,8 @@ class Application_Model_Preference
public static function setCurrentLibraryTableSetting($settings) public static function setCurrentLibraryTableSetting($settings)
{ {
$num_columns = count(Application_Model_StoredFile::getLibraryColumns());
$new_columns_num = count($settings['abVisCols']);
/*if ($num_columns != $new_columns_num) {
throw new Exception("Trying to write a user column preference with incorrect number of columns!");
}*/
$data = serialize($settings); $data = serialize($settings);
$v = self::setValue("library_datatable", $data, true); self::setValue("library_datatable", $data, true);
} }
public static function getCurrentLibraryTableSetting() public static function getCurrentLibraryTableSetting()