cake_session.test.php

<?php
/**
 * SessionTest file
 *
 * PHP versions 4 and 5
 *
 * CakePHP(tm) Tests <http://book.cakephp.org/view/1196/Testing>
 * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
 *
 *  Licensed under The Open Group Test Suite License
 *  Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
 * @link          http://book.cakephp.org/view/1196/Testing CakePHP(tm) Tests
 * @package       cake
 * @subpackage    cake.tests.cases.libs
 * @since         CakePHP(tm) v 1.2.0.4206
 * @license       http://www.opensource.org/licenses/opengroup.php The Open Group Test Suite License
 */
if (!class_exists('CakeSession')) {
	App::import('Core', 'CakeSession');
}

class TestCakeSession extends CakeSession {
	public static function setUserAgent($value) {
		self::$_userAgent = $value;
	}
	
	public static function setHost($host) {
		self::_setHost($host);
	}
}

/**
 * CakeSessionTest class
 *
 * @package       cake
 * @subpackage    cake.tests.cases.libs
 */
class CakeSessionTest extends CakeTestCase {

	protected static $_gcDivisor;

/**
 * Fixtures used in the SessionTest
 *
 * @var array
 * @access public
 */
	public $fixtures = array('core.session');

/**
 * setup before class.
 *
 * @access public
 * @return void
 */
	public static function setupBeforeClass() {
		// Make sure garbage colector will be called
		self::$_gcDivisor = ini_get('session.gc_divisor');
		ini_set('session.gc_divisor', '1');
	}

/**
 * teardown after class
 *
 * @access public
 * @return void
 */
	public static function teardownAfterClass() {
		// Revert to the default setting
		ini_set('session.gc_divisor', self::$_gcDivisor);
	}

/**
 * setUp method
 *
 * @access public
 * @return void
 */
	function startTest() {
		Configure::write('Session', array(
			'defaults' => 'php',
			'cookie' => 'cakephp',
			'timeout' => 120,
			'cookieTimeout' => 120,
			'ini' => array(),
		));

		TestCakeSession::init();
		TestCakeSession::destroy();
		TestCakeSession::$watchKeys = array();
	}

/**
 * tearDown method
 *
 * @access public
 * @return void
 */
	function endTest() {
		unset($_SESSION);
		@session_destroy();
	}

/**
 * test setting ini properties with Session configuration.
 *
 * @return void
 */
	function testSessionConfigIniSetting() {
		$_SESSION = array();
		session_destroy();

		Configure::write('Session', array(
			'cookie' => 'test_suite',
			'timeout' => 86400,
			'ini' => array(
				'session.referer_check' => 'example.com',
				'session.use_trans_sid' => false
			)
		));
		TestCakeSession::start();
		$this->assertEquals('', ini_get('session.use_trans_sid'), 'Ini value is incorrect');
		$this->assertEquals('example.com', ini_get('session.referer_check'), 'Ini value is incorrect');
		$this->assertEquals('test_suite', ini_get('session.name'), 'Ini value is incorrect');
	}

/**
 * testSessionPath
 *
 * @access public
 * @return void
 */
	function testSessionPath() {
		TestCakeSession::init('/index.php');
		$this->assertEqual('/', TestCakeSession::$path);

		TestCakeSession::init('/sub_dir/index.php');
		$this->assertEqual('/sub_dir/', TestCakeSession::$path);
	}

/**
 * testCakeSessionPathEmpty
 *
 * @access public
 * @return void
 */	
	function testCakeSessionPathEmpty() {
		TestCakeSession::init('');
		$this->assertEqual('/', TestCakeSession::$path, 'Session path is empty, with "" as $base needs to be / %s');
	}

/**
 * testCakeSessionPathContainsParams
 *
 * @access public
 * @return void
 */
	function testCakeSessionPathContainsQuestion() {
		TestCakeSession::init('/index.php?');
		$this->assertEqual('/', TestCakeSession::$path);
	}

/**
 * testSetHost
 *
 * @access public
 * @return void
 */
	function testSetHost() {
		TestCakeSession::init();
		TestCakeSession::setHost('cakephp.org');
		$this->assertEqual('cakephp.org', TestCakeSession::$host);
	}

/**
 * testSetHostWithPort
 *
 * @access public
 * @return void
 */
	function testSetHostWithPort() {
		TestCakeSession::init();
		TestCakeSession::setHost('cakephp.org:443');
		$this->assertEqual('cakephp.org', TestCakeSession::$host);
	}

/**
 * testCheck method
 *
 * @access public
 * @return void
 */
	function testCheck() {
		TestCakeSession::write('SessionTestCase', 'value');
		$this->assertTrue(TestCakeSession::check('SessionTestCase'));

		$this->assertFalse(TestCakeSession::check('NotExistingSessionTestCase'), false);
	}

/**
 * testSimpleRead method
 *
 * @access public
 * @return void
 */
	function testSimpleRead() {
		TestCakeSession::write('testing', '1,2,3');
		$result = TestCakeSession::read('testing');
		$this->assertEqual($result, '1,2,3');

		TestCakeSession::write('testing', array('1' => 'one', '2' => 'two','3' => 'three'));
		$result = TestCakeSession::read('testing.1');
		$this->assertEqual($result, 'one');

		$result = TestCakeSession::read('testing');
		$this->assertEqual($result, array('1' => 'one', '2' => 'two', '3' => 'three'));

		$result = TestCakeSession::read();
		$this->assertTrue(isset($result['testing']));
		$this->assertTrue(isset($result['Config']));
		$this->assertTrue(isset($result['Config']['userAgent']));

		TestCakeSession::write('This.is.a.deep.array.my.friend', 'value');
		$result = TestCakeSession::read('This.is.a.deep.array.my.friend');
		$this->assertEqual('value', $result);
	}

/**
 * testReadyEmpty
 *
 * @return void
 * @access public
 */
	function testReadyEmpty() {
		$this->assertFalse(TestCakeSession::read(''));
	}

/**
 * test writing a hash of values/
 *
 * @return void
 * @access public
 */
	function testWriteArray() {
		$result = TestCakeSession::write(array(
			'one' => 1,
			'two' => 2,
			'three' => array('something'),
			'null' => null
		));
		$this->assertTrue($result);
		$this->assertEquals(1, TestCakeSession::read('one'));
		$this->assertEquals(array('something'), TestCakeSession::read('three'));
		$this->assertEquals(null, TestCakeSession::read('null'));
	}

/**
 * testWriteEmptyKey
 *
 * @return void
 * @access public
 */
	function testWriteEmptyKey() {
		$this->assertFalse(TestCakeSession::write('', 'graham'));
		$this->assertFalse(TestCakeSession::write('', ''));
		$this->assertFalse(TestCakeSession::write(''));
	}

/**
 * testId method
 *
 * @access public
 * @return void
 */
	function testId() {
		$expected = session_id();
		$result = TestCakeSession::id();
		$this->assertEqual($result, $expected);

		TestCakeSession::id('MySessionId');
		$result = TestCakeSession::id();
		$this->assertEqual($result, 'MySessionId');
	}

/**
 * testStarted method
 *
 * @access public
 * @return void
 */
	function testStarted() {
		$this->assertTrue(TestCakeSession::started());

		unset($_SESSION);
		$_SESSION = null;
		$this->assertFalse(TestCakeSession::started());
		$this->assertTrue(TestCakeSession::start());
	}

/**
 * testError method
 *
 * @access public
 * @return void
 */
	function testError() {
		TestCakeSession::read('Does.not.exist');
		$result = TestCakeSession::error();
		$this->assertEqual($result, "Does.not.exist doesn't exist");

		TestCakeSession::delete('Failing.delete');
		$result = TestCakeSession::error();
		$this->assertEqual($result, "Failing.delete doesn't exist");
	}

/**
 * testDel method
 *
 * @access public
 * @return void
 */
	function testDelete() {
		$this->assertTrue(TestCakeSession::write('Delete.me', 'Clearing out'));
		$this->assertTrue(TestCakeSession::delete('Delete.me'));
		$this->assertFalse(TestCakeSession::check('Delete.me'));
		$this->assertTrue(TestCakeSession::check('Delete'));

		$this->assertTrue(TestCakeSession::write('Clearing.sale', 'everything must go'));
		$this->assertTrue(TestCakeSession::delete('Clearing'));
		$this->assertFalse(TestCakeSession::check('Clearing.sale'));
		$this->assertFalse(TestCakeSession::check('Clearing'));
	}

/**
 * testWatchVar method
 *
 * @expectedException Exception
 * @access public
 * @return void
 */
	function testWatchVarWrite() {
		$this->assertFalse(TestCakeSession::watch(null));

		TestCakeSession::write('Watching', "I'm watching you");
		TestCakeSession::watch('Watching');
		TestCakeSession::write('Watching', 'They found us!');
	}

/**
 * undocumented function
 *
 * @expectedException Exception
 * @return void
 */
	function testWatchVarDelete() {
		TestCakeSession::watch('Watching');
		TestCakeSession::delete('Watching');

		$this->assertFalse(TestCakeSession::watch('Invalid.key'));
	}

/**
 * testIgnore method
 *
 * @access public
 * @return void
 */
	function testIgnore() {
		TestCakeSession::write('Watching', "I'm watching you");
		TestCakeSession::watch('Watching');
		TestCakeSession::ignore('Watching');
		$this->assertTrue(TestCakeSession::write('Watching', 'They found us!'));
	}

/**
 * testDestroy method
 *
 * @access public
 * @return void
 */
	function testDestroy() {
		TestCakeSession::write('bulletProof', 'invicible');
		$id = TestCakeSession::id();
		TestCakeSession::destroy();

		$this->assertFalse(TestCakeSession::check('bulletProof'));
		$this->assertNotEqual($id, TestCakeSession::id());
	}

/**
 * testCheckingSavedEmpty method
 *
 * @access public
 * @return void
 */
	function testCheckingSavedEmpty() {
		$this->assertTrue(TestCakeSession::write('SessionTestCase', 0));
		$this->assertTrue(TestCakeSession::check('SessionTestCase'));

		$this->assertTrue(TestCakeSession::write('SessionTestCase', '0'));
		$this->assertTrue(TestCakeSession::check('SessionTestCase'));

		$this->assertTrue(TestCakeSession::write('SessionTestCase', false));
		$this->assertTrue(TestCakeSession::check('SessionTestCase'));

		$this->assertTrue(TestCakeSession::write('SessionTestCase', null));
		$this->assertFalse(TestCakeSession::check('SessionTestCase'));
	}

/**
 * testCheckKeyWithSpaces method
 *
 * @access public
 * @return void
 */
	function testCheckKeyWithSpaces() {
		$this->assertTrue(TestCakeSession::write('Session Test', "test"));
		$this->assertEqual(TestCakeSession::check('Session Test'), 'test');
		TestCakeSession::delete('Session Test');

		$this->assertTrue(TestCakeSession::write('Session Test.Test Case', "test"));
		$this->assertTrue(TestCakeSession::check('Session Test.Test Case'));
	}

/**
 * testCheckEmpty
 *
 * @access public
 * @return void
 */
	function testCheckEmpty() {
		$this->assertFalse(TestCakeSession::check());
	}

/**
 * test key exploitation
 *
 * @return void
 */
	function testKeyExploit() {
		$key = "a'] = 1; phpinfo(); \$_SESSION['a";
		$result = TestCakeSession::write($key, 'haxored');
		$this->assertTrue($result);

		$result = TestCakeSession::read($key);
		$this->assertEqual($result, 'haxored');
	}

/**
 * testReadingSavedEmpty method
 *
 * @access public
 * @return void
 */
	function testReadingSavedEmpty() {
		TestCakeSession::write('SessionTestCase', 0);
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), 0);

		TestCakeSession::write('SessionTestCase', '0');
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), '0');
		$this->assertFalse(TestCakeSession::read('SessionTestCase') === 0);

		TestCakeSession::write('SessionTestCase', false);
		$this->assertFalse(TestCakeSession::read('SessionTestCase'));

		TestCakeSession::write('SessionTestCase', null);
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), null);
	}

/**
 * testCheckUserAgentFalse method
 *
 * @access public
 * @return void
 */
	function testCheckUserAgentFalse() {
		Configure::write('Session.checkAgent', false);
		TestCakeSession::setUserAgent(md5('http://randomdomainname.com' . Configure::read('Security.salt')));
		$this->assertTrue(TestCakeSession::valid());
	}

/**
 * testCheckUserAgentTrue method
 *
 * @access public
 * @return void
 */
	function testCheckUserAgentTrue() {
		Configure::write('Session.checkAgent', true);
		TestCakeSession::$error = false;
		$agent = md5('http://randomdomainname.com' . Configure::read('Security.salt'));

		TestCakeSession::write('Config.userAgent', md5('Hacking you!'));
		TestCakeSession::setUserAgent($agent);
		$this->assertFalse(TestCakeSession::valid());
	}

/**
 * testReadAndWriteWithDatabaseStorage method
 *
 * @access public
 * @return void
 */
	function testReadAndWriteWithCakeStorage() {
		session_write_close();
		Configure::write('Session.defaults', 'cake');

		TestCakeSession::init();
		TestCakeSession::destroy();

		TestCakeSession::write('SessionTestCase', 0);
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), 0);

		TestCakeSession::write('SessionTestCase', '0');
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), '0');
		$this->assertFalse(TestCakeSession::read('SessionTestCase') === 0);

		TestCakeSession::write('SessionTestCase', false);
		$this->assertFalse(TestCakeSession::read('SessionTestCase'));

		TestCakeSession::write('SessionTestCase', null);
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), null);

		TestCakeSession::write('SessionTestCase', 'This is a Test');
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), 'This is a Test');

		TestCakeSession::write('SessionTestCase', 'This is a Test');
		TestCakeSession::write('SessionTestCase', 'This was updated');
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), 'This was updated');

		TestCakeSession::destroy();
		$this->assertNull(TestCakeSession::read('SessionTestCase'));
	}

/**
 * testReadAndWriteWithDatabaseStorage method
 *
 * @access public
 * @return void
 */
	function testReadAndWriteWithCacheStorage() {
		session_write_close();
		Configure::write('Session.defaults', 'cache');

		TestCakeSession::init();
		TestCakeSession::destroy();

		TestCakeSession::write('SessionTestCase', 0);
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), 0);

		TestCakeSession::write('SessionTestCase', '0');
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), '0');
		$this->assertFalse(TestCakeSession::read('SessionTestCase') === 0);

		TestCakeSession::write('SessionTestCase', false);
		$this->assertFalse(TestCakeSession::read('SessionTestCase'));

		TestCakeSession::write('SessionTestCase', null);
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), null);

		TestCakeSession::write('SessionTestCase', 'This is a Test');
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), 'This is a Test');

		TestCakeSession::write('SessionTestCase', 'This is a Test');
		TestCakeSession::write('SessionTestCase', 'This was updated');
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), 'This was updated');

		TestCakeSession::destroy();
		$this->assertNull(TestCakeSession::read('SessionTestCase'));
	}

/**
 * test that changing the config name of the cache config works.
 *
 * @return void
 */
	function testReadAndWriteWithCustomCacheConfig() {
		session_write_close();
		Configure::write('Session.defaults', 'cache');
		Configure::write('Session.handler.config', 'session_test');
		
		Cache::config('session_test', array(
			'engine' => 'File',
			'prefix' => 'session_test_',
		));

		TestCakeSession::init();
		TestCakeSession::destroy();

		TestCakeSession::write('SessionTestCase', 'Some value');
		$this->assertEquals('Some value', TestCakeSession::read('SessionTestCase'));

		session_write_close();

		$this->assertContains('Some value', Cache::read(TestCakeSession::id(), 'session_test'));
		$this->assertFalse(Cache::read(TestCakeSession::id(), 'default'));

		TestCakeSession::destroy();
		Cache::delete(TestCakeSession::id(), 'session_test');
		Cache::drop('session_test');
	}

/**
 * testReadAndWriteWithDatabaseStorage method
 *
 * @access public
 * @return void
 */
	function testReadAndWriteWithDatabaseStorage() {
		Configure::write('Session.defaults', 'database');
		Configure::write('Session.handler.table', 'sessions');
		Configure::write('Session.handler.model', 'Session');
		Configure::write('Session.handler.database', 'test_suite');
		

		TestCakeSession::init();
		TestCakeSession::destroy();

		TestCakeSession::write('SessionTestCase', 0);
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), 0);

		TestCakeSession::write('SessionTestCase', '0');
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), '0');
		$this->assertFalse(TestCakeSession::read('SessionTestCase') === 0);

		TestCakeSession::write('SessionTestCase', false);
		$this->assertFalse(TestCakeSession::read('SessionTestCase'));

		TestCakeSession::write('SessionTestCase', null);
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), null);

		TestCakeSession::write('SessionTestCase', 'This is a Test');
		$this->assertEqual(TestCakeSession::read('SessionTestCase'), 'This is a Test');

        TestCakeSession::write('SessionTestCase', 'Some additional data');
        $this->assertEqual(TestCakeSession::read('SessionTestCase'), 'Some additional data');

		TestCakeSession::destroy();
		$this->assertNull(TestCakeSession::read('SessionTestCase'));
		session_write_close();
	}

}