Changeset 149

Timestamp:

Jun 5, 2006 2:34:47 AM (18 years ago)

Author:

scdev

Message:

Q - while we're changing interfaces I'm going to change ->clearAuth() to ->clear().

Location:

trunk

Files:

• lib/Auth_File.inc.php (modified) (2 diffs)
• lib/Auth_SQL.inc.php (modified) (6 diffs)
• lib/Lock.inc.php (modified) (5 diffs)
• lib/Prefs.inc.php (modified) (9 diffs)
• lib/Version.inc.php (modified) (3 diffs)
• services/logout.php (modified) (2 diffs)
• tests/Auth_FileTest.php (modified) (2 diffs)
• tests/Auth_SQLTest.php (modified) (5 diffs)
• tests/PrefsTest.php (modified) (1 diff)

trunk/lib/Auth_File.inc.php

@@ -112 +112 @@
      * @access public
      */
-    function clearAuth()
+    function clear()
     {
         $_SESSION[$this->_ns] = array('authenticated' => false);
@@ -202 +202 @@
         $username = strtolower(trim($username));
 
-        $this->clearAuth();
+        $this->clear();
 
         if (!$this->authenticate($username, $password)) {

trunk/lib/Auth_SQL.inc.php

@@ -252 +252 @@
      * @access public
      */
-    function clearAuth()
+    function clear()
     {
         $db =& DB::getInstance();
@@ -274 +274 @@
      * @param mixed $val      Value to set variable to.
      */
-    function setVal($key, $val)
+    function set($key, $val)
     {
         if (!isset($_SESSION[$this->_ns]['user_data'])) {
@@ -365 +365 @@
         $this->initDB();
 
-        $this->clearAuth();
+        $this->clear();
 
         if (!$user_data = $this->authenticate($username, $password)) {
@@ -402 +402 @@
 
                 // No login: user is blocked!
-                $this->clearAuth();
+                $this->clear();
                 return false;
             }
@@ -437 +437 @@
                 $db->query("DELETE FROM " . $this->_params['db_login_table'] . " WHERE " . $this->_params['db_primary_key'] . " = '" . $this->get('user_id') . "'");
                 // No login: reset password because of account abuse!
-                $this->clearAuth();
+                $this->clear();
                 return false;
             }
@@ -569 +569 @@
 
         // User is not authenticated.
-        $this->clearAuth();
+        $this->clear();
         return false;
     }

trunk/lib/Lock.inc.php

@@ -55 +55 @@
         $app =& App::getInstance();
 
-        if (!method_exists($auth_object, 'getVal') || !method_exists($auth_object, 'getUsername')) {
+        if (!method_exists($auth_object, 'get') || !method_exists($auth_object, 'getUsername')) {
             trigger_error('Constructor not provided a valid Auth_* object.', E_USER_ERROR);
         }
@@ -183 +183 @@
         }
         if ($this->data = mysql_fetch_assoc($qid)) {
-            $app->logMsg(sprintf('Selecting %slocked record: %s %s %s', ($this->data['set_by_admin_id'] == $this->_auth->getVal('user_id') ? 'self-' : ''), $record_table_or_lock_id, $record_key, $record_val), LOG_DEBUG, __FILE__, __LINE__);
+            $app->logMsg(sprintf('Selecting %slocked record: %s %s %s', ($this->data['set_by_admin_id'] == $this->_auth->get('user_id') ? 'self-' : ''), $record_table_or_lock_id, $record_key, $record_val), LOG_DEBUG, __FILE__, __LINE__);
             /// FIX ME: What if admin set lock, but public user is current lock user?
             $this->data['editor'] = $this->_auth->getUsername($this->data['set_by_admin_id']);
@@ -218 +218 @@
             $qid = $db->query("SELECT * FROM " . $db->escapeString($this->getParam('db_table')) . " WHERE lock_id = '" . $db->escapeString($this->data['lock_id']) . "'");
             if ($lock = mysql_fetch_assoc($qid)) {
-                return ($lock['set_by_admin_id'] == $this->_auth->getVal('user_id'));
+                return ($lock['set_by_admin_id'] == $this->_auth->get('user_id'));
             } else {
                 return false;
@@ -268 +268 @@
                 '" . $db->escapeString($record_val) . "',
                 '" . $db->escapeString($title) . "',
-                '" . $db->escapeString($this->_auth->getVal('user_id')) . "',
+                '" . $db->escapeString($this->_auth->get('user_id')) . "',
                 NOW()
             )
@@ -318 +318 @@
             // Delete specific user's locks.
             $db->query("DELETE FROM " . $db->escapeString($this->getParam('db_table')) . " WHERE set_by_admin_id = '" . $db->escapeString($user_id) . "'");
-            $app->logMsg(sprintf('Record locks owned by %s %s have been deleted', $this->_auth->getVal('auth_name'), $this->_auth->getUsername($user_id)), LOG_DEBUG, __FILE__, __LINE__);
+            $app->logMsg(sprintf('Record locks owned by %s %s have been deleted', $this->_auth->get('auth_name'), $this->_auth->getUsername($user_id)), LOG_DEBUG, __FILE__, __LINE__);
         } else {
             // Delete ALL locks.
             $db->query("DELETE FROM " . $db->escapeString($this->getParam('db_table')) . "");
-            $app->logMsg(sprintf('All record locks deleted by %s %s', $this->_auth->getVal('auth_name'), $this->_auth->getVal('username')), LOG_DEBUG, __FILE__, __LINE__);
+            $app->logMsg(sprintf('All record locks deleted by %s %s', $this->_auth->get('auth_name'), $this->_auth->get('username')), LOG_DEBUG, __FILE__, __LINE__);
         }
     }

trunk/lib/Prefs.inc.php

@@ -18 +18 @@
     var $_params = array(
         
+        // The current user_id for which to load/save preferences.
+        'user_id' => null,
+        
+        // How long before we force a reload of the prefs data? 3600 = once every hour.
+        'load_timeout' => 3600,
+        
         // Enable database storage.
         'enable_db' => true,
@@ -26 +32 @@
         // Automatically create table and verify columns. Better set to false after site launch.
         'create_table' => true,
-        
-        // The current user_id for which to load/save preferences.
-        'user_id' => null,
     );
 
@@ -132 +135 @@
     function setDefaults($defaults)
     {
+        $app =& App::getInstance();
         if (isset($defaults) && is_array($defaults)) {
             // Apply defaults to the session, setting only non-existing values.
+            $app->logMsg(sprintf('Pre-defaulting: %s', getDump($_SESSION[$this->_ns]['data'])), LOG_DEBUG, __FILE__, __LINE__);
             $_SESSION[$this->_ns]['data'] = array_merge($defaults, $_SESSION[$this->_ns]['data']);
+            $app->logMsg(sprintf('Post-defaulting: %s', getDump($_SESSION[$this->_ns]['data'])), LOG_DEBUG, __FILE__, __LINE__);
         }
     }
@@ -146 +152 @@
     function set($key, $val)
     {
-        $_SESSION[$this->_ns]['data'][$key] = $val;
+        if ('' != $key && '' != $val) {
+            $_SESSION[$this->_ns]['data'][$key] = $val;
+        }
     }
 
@@ -185 +193 @@
 
     /**
-     * Empty the $_SESSION cache.
+     * Empty the $_SESSION cache. This should be executed with the same consideration as $auth->clear()
      */
     function clear()
@@ -238 +246 @@
         // Data loaded only once per session.
         $_SESSION[$this->_ns]['loaded'] = true;
+        $_SESSION[$this->_ns]['load_datetime'] = date('Y-m-d H:i:s');
         
         return true;
@@ -243 +252 @@
     
     /*
-    *   Returns true if the prefs had been loaded from the database into the $_SESSION.
+    * Returns true if the prefs had been loaded from the database into the $_SESSION recently.
+    * This function is simply a check so the database isn't access every page load.
     * 
     * @access   private
@@ -253 +263 @@
     function _isLoaded()
     {
-        return isset($_SESSION[$this->_ns]['loaded']) && true === $_SESSION[$this->_ns]['loaded'];
+        if (isset($_SESSION[$this->_ns]['load_datetime'])
+        && strtotime($_SESSION[$this->_ns]['load_datetime']) > time() - $this->getParam('load_timeout')
+        && isset($_SESSION[$this->_ns]['loaded']) 
+        && true === $_SESSION[$this->_ns]['loaded']) {
+            return true;
+        } else {
+            return false;
+        }
     }
     
@@ -294 +311 @@
             $insert_values = array();
             foreach ($_SESSION[$this->_ns]['data'] as $key => $val) {
-                $insert_values[] = sprintf("('%s', '%s', '%s', '%s')", DB::escapeString($this->getParam('user_id')), DB::escapeString($this->_ns), DB::escapeString($key), DB::escapeString($val));
+                if ('' != trim($key) && '' != trim($val)) {
+                    $insert_values[] = sprintf("('%s', '%s', '%s', '%s')", $db->escapeString($this->getParam('user_id')), $db->escapeString($this->_ns), $db->escapeString($key), $db->escapeString($val));
+                }
             }
             $db->query("

trunk/lib/Version.inc.php

@@ -61 +61 @@
         $app =& App::getInstance();
 
-        if (!method_exists($auth_object, 'getVal') || !method_exists($auth_object, 'getUsername')) {
+        if (!method_exists($auth_object, 'get') || !method_exists($auth_object, 'getUsername')) {
             trigger_error('Constructor not provided a valid Auth_* object.', E_USER_ERROR);
         }
@@ -202 +202 @@
                 '" . $db->escapeString($title) . "',
                 '" . $db->escapeString($notes) . "',
-                '" . $db->escapeString($this->_auth->getVal('user_id')) . "',
+                '" . $db->escapeString($this->_auth->get('user_id')) . "',
                 NOW()
             )
@@ -363 +363 @@
         while ($row = mysql_fetch_assoc($qid)) {
             // Get admin usernames.
-            $row['editor'] = $this->_auth->getVal('auth_type') . ' ' . $this->_auth->getUsername($row['saved_by_user_id']);
+            $row['editor'] = $this->_auth->get('auth_type') . ' ' . $this->_auth->getUsername($row['saved_by_user_id']);
             $versions[] = $row;
         }

trunk/services/logout.php

@@ -5 +5 @@
  */
 
-if (isset($auth) && method_exists($auth, 'getVal')) {
+if (isset($auth) && method_exists($auth, 'get')) {
     // Delete the current user's record locks.
     require_once 'codebase/lib/Lock.inc.php';
@@ -13 +13 @@
 
 // Logout.
-$auth->clearAuth();
+$auth->clear();
 
 $app->raiseMsg(sprintf(_("Your session has been logged-out."), null), MSG_SUCCESS, __FILE__, __LINE__);

trunk/tests/Auth_FileTest.php

@@ -48 +48 @@
     }
 
-    function test_clearauth()
+    function test_clear()
     {
         $result = $this->Auth_File->login('testuser', 'testpass');
-        $this->Auth_File->clearauth();
+        $this->Auth_File->clear();
         $this->assertFalse($_SESSION[$this->Auth_File->_ns]['authenticated'], 'testuser authentication not false in session.');
     }
@@ -61 +61 @@
         $this->assertTrue($true, 'testuser not logged in but should be.');
 
-        $this->Auth_File->clearauth();
+        $this->Auth_File->clear();
         $false = $this->Auth_File->isloggedin();
         $this->assertFalse($false, 'testuser is logged in but shouldn\'t be.');

trunk/tests/Auth_SQLTest.php

@@ -67 +67 @@
     }
 
-    function test_setval()
-    {
-        $this->Auth_SQL->setval('testuserkey', 'testuserval');
+    function test_set()
+    {
+        $this->Auth_SQL->set('testuserkey', 'testuserval');
         $this->assertEquals('testuserval', $_SESSION[$this->Auth_SQL->_ns]['user_data']['testuserkey']);
     }
 
-    function test_getval()
+    function test_get()
     {
         $_SESSION[$this->Auth_SQL->_ns]['user_data']['testuserkey'] = 'testuserval';
-        $val = $this->Auth_SQL->getVal('testuserkey');
+        $val = $this->Auth_SQL->get('testuserkey');
         $this->assertEquals('testuserval', $val);
     }
@@ -95 +95 @@
     }
 
-    function test_clearauth()
+    function test_clear()
     {
         $login = $this->Auth_SQL->login('testuser', 'testpass');
@@ -101 +101 @@
         $before_logged_in = $this->Auth_SQL->isloggedin();
         $this->assertTrue($before_logged_in, 'User is not logged in, but should be.');
-        $this->Auth_SQL->clearauth();
+        $this->Auth_SQL->clear();
         $after_logged_in = $this->Auth_SQL->isloggedin();
         $this->assertFalse($after_logged_in, 'User is still logged in but should not be.');
@@ -123 +123 @@
         $before_logged_in = $this->Auth_SQL->isloggedin();
         $this->assertTrue($before_logged_in, '2. User is not logged in, but should be.');
-        $this->Auth_SQL->clearauth();
+        $this->Auth_SQL->clear();
         $after_logged_in = $this->Auth_SQL->isloggedin();
         $this->assertFalse($after_logged_in, '3. User is still logged in but should not be.');
@@ -132 +132 @@
         $before_logged_in2 = $this->Auth_SQL->isloggedin();
         $this->assertFalse($before_logged_in2, '5. User is logged in, but should not be.');
-        $this->Auth_SQL->clearauth();
+        $this->Auth_SQL->clear();
         $after_logged_in2 = $this->Auth_SQL->isloggedin();
         $this->assertFalse($after_logged_in2, '6. Wrong user is still logged in but should not be.');

trunk/tests/PrefsTest.php

@@ -48 +48 @@
     }
 
-    function test_getvalue()
+    function test_getue()
     {
-        $result = $this->Prefs->getvalue(PARAM);
+        $result = $this->Prefs->getue(PARAM);
         $expected = EXPECTED_VAL;
         $this->assertEquals($expected, $result);