silverstripe / silverstripe-hybridsessions

src/Store/BaseStore.php

Indentation +52 added lines, -52 removed lines

@@ -8,56 +8,56 @@
 
 abstract class BaseStore implements SessionHandlerInterface
 {
-    use Configurable;
-
-    /**
-     * Session secret key
-     *
-     * @var string
-     */
-    protected $key = null;
-
-    /**
-     * Assign a new session secret key
-     *
-     * @param string $key
-     */
-    public function setKey($key)
-    {
-        $this->key = $key;
-    }
-
-    /**
-     * Get the session secret key
-     *
-     * @return string
-     */
-    protected function getKey()
-    {
-        return $this->key;
-    }
-
-    /**
-     * Get lifetime in number of seconds
-     *
-     * @return int
-     */
-    protected function getLifetime()
-    {
-        $params = session_get_cookie_params();
-        $cookieLifetime = (int)$params['lifetime'];
-        $gcLifetime = (int)ini_get('session.gc_maxlifetime');
-
-        return $cookieLifetime ? min($cookieLifetime, $gcLifetime) : $gcLifetime;
-    }
-
-    /**
-     * Gets the current unix timestamp
-     *
-     * @return int
-     */
-    protected function getNow()
-    {
-        return (int) DBDatetime::now()->getTimestamp();
-    }
+	use Configurable;
+
+	/**
+	 * Session secret key
+	 *
+	 * @var string
+	 */
+	protected $key = null;
+
+	/**
+	 * Assign a new session secret key
+	 *
+	 * @param string $key
+	 */
+	public function setKey($key)
+	{
+		$this->key = $key;
+	}
+
+	/**
+	 * Get the session secret key
+	 *
+	 * @return string
+	 */
+	protected function getKey()
+	{
+		return $this->key;
+	}
+
+	/**
+	 * Get lifetime in number of seconds
+	 *
+	 * @return int
+	 */
+	protected function getLifetime()
+	{
+		$params = session_get_cookie_params();
+		$cookieLifetime = (int)$params['lifetime'];
+		$gcLifetime = (int)ini_get('session.gc_maxlifetime');
+
+		return $cookieLifetime ? min($cookieLifetime, $gcLifetime) : $gcLifetime;
+	}
+
+	/**
+	 * Gets the current unix timestamp
+	 *
+	 * @return int
+	 */
+	protected function getNow()
+	{
+		return (int) DBDatetime::now()->getTimestamp();
+	}
 }

src/Model/HybridSessionDataObject.php

Indentation +12 added lines, -12 removed lines

@@ -6,18 +6,18 @@
 
 class HybridSessionDataObject extends DataObject
 {
-    private static $db = [
-        'SessionID' => 'Varchar(64)',
-        'Expiry' => 'Int',
-        'Data' => 'Text'
-    ];
+	private static $db = [
+		'SessionID' => 'Varchar(64)',
+		'Expiry' => 'Int',
+		'Data' => 'Text'
+	];
 
-    private static $indexes = [
-        'SessionID' => [
-            'type' => 'unique'
-        ],
-        'Expiry' => true
-    ];
+	private static $indexes = [
+		'SessionID' => [
+			'type' => 'unique'
+		],
+		'Expiry' => true
+	];
 
-    private static $table_name = 'HybridSessionDataObject';
+	private static $table_name = 'HybridSessionDataObject';
 }

src/Crypto/CryptoHandler.php

Indentation +20 added lines, -20 removed lines

@@ -5,27 +5,27 @@
 interface CryptoHandler
 {
 
-    /**
-     * @param string $data
-     *
-     * @return string
-     */
-    public function encrypt($data);
+	/**
+	 * @param string $data
+	 *
+	 * @return string
+	 */
+	public function encrypt($data);
 
-    /**
-     * @param string $data
-     *
-     * @return string
-     */
-    public function decrypt($data);
+	/**
+	 * @param string $data
+	 *
+	 * @return string
+	 */
+	public function decrypt($data);
 
-    /**
-     * @return string
-     */
-    public function getKey();
+	/**
+	 * @return string
+	 */
+	public function getKey();
 
-    /**
-     * @return string
-     */
-    public function getSalt();
+	/**
+	 * @return string
+	 */
+	public function getSalt();
 }

src/Control/HybridSessionMiddleware.php

Indentation +18 added lines, -18 removed lines

@@ -8,25 +8,25 @@
 
 class HybridSessionMiddleware implements HTTPMiddleware
 {
-    public function process(HTTPRequest $request, callable $delegate)
-    {
-        try {
-            // Start session and execute
-            $request->getSession()->init($request);
+	public function process(HTTPRequest $request, callable $delegate)
+	{
+		try {
+			// Start session and execute
+			$request->getSession()->init($request);
 
-            // Generate output
-            $response = $delegate($request);
-        } finally {
-            // Save session data, even if there was an exception
-            // Note that save() will start/resume the session if required.
-            $request->getSession()->save($request);
+			// Generate output
+			$response = $delegate($request);
+		} finally {
+			// Save session data, even if there was an exception
+			// Note that save() will start/resume the session if required.
+			$request->getSession()->save($request);
 
-            if (HybridSession::is_enabled()) {
-                // Close the session
-                session_write_close();
-            }
-        }
+			if (HybridSession::is_enabled()) {
+				// Close the session
+				session_write_close();
+			}
+		}
 
-        return $response;
-    }
+		return $response;
+	}
 }

tests/ConfigurationTest.php

Indentation +8 added lines, -8 removed lines

@@ -9,12 +9,12 @@
 
 class ConfigurationTest extends SapphireTest
 {
-    public function testHybridSessionsSessionMiddlewareReplacesCore()
-    {
-        $this->assertInstanceOf(
-            HybridSessionMiddleware::class,
-            Injector::inst()->get(SessionMiddleware::class),
-            'HybridSession\'s middleware should replace the default SessionMiddleware'
-        );
-    }
+	public function testHybridSessionsSessionMiddlewareReplacesCore()
+	{
+		$this->assertInstanceOf(
+			HybridSessionMiddleware::class,
+			Injector::inst()->get(SessionMiddleware::class),
+			'HybridSession\'s middleware should replace the default SessionMiddleware'
+		);
+	}
 }

tests/AbstractTest.php

Indentation +100 added lines, -100 removed lines

@@ -10,104 +10,104 @@
 
 abstract class AbstractTest extends SapphireTest
 {
-    protected $usesDatabase = true;
-
-    protected function setUp()
-    {
-        parent::setUp();
-
-        TestCookieStore::$override_headers_sent = false;
-
-        Injector::inst()->registerService(
-            new TestCookieStore(),
-            CookieStore::class
-        );
-
-        DBDatetime::set_mock_now('2010-03-15 12:00:00');
-    }
-
-    protected function tearDown()
-    {
-        DBDatetime::clear_mock_now();
-
-        parent::tearDown();
-    }
-
-    abstract protected function getStore();
-
-    /**
-     * Test how this store handles large volumes of data (>1000 characters)
-     */
-    public function testStoreLargeData()
-    {
-        $session = uniqid();
-        $store = $this->getStore();
-
-        // Test new session is blank
-        $result = $store->read($session);
-        $this->assertEmpty($result);
-
-        // Save data against session
-        $data1 = array(
-            'Large' => str_repeat('A', 600),
-            'Content' => str_repeat('B', 600)
-        );
-        $store->write($session, serialize($data1));
-        $result = $store->read($session);
-        $this->assertEquals($data1, unserialize($result));
-    }
-
-    /**
-     * Test storage of data
-     */
-    public function testStoreData()
-    {
-        $session = uniqid();
-        $store = $this->getStore();
-
-        // Test new session is blank
-        $result = $store->read($session);
-        $this->assertEmpty($result);
-
-        // Save data against session
-        $data1 = array(
-            'Color' => 'red',
-            'Animal' => 'elephant'
-        );
-        $store->write($session, serialize($data1));
-        $result = $store->read($session);
-        $this->assertEquals($data1, unserialize($result));
-
-        // Save larger data
-        $data2 = array(
-            'Color' => 'blue',
-            'Animal' => str_repeat('bat', 100)
-        );
-        $store->write($session, serialize($data2));
-        $result = $store->read($session);
-        $this->assertEquals($data2, unserialize($result));
-    }
-
-    /**
-     * Test expiry of data
-     */
-    public function testExpiry()
-    {
-        $session1 = uniqid();
-        $store = $this->getStore();
-
-        // Store data now
-        $data1 = array(
-            'Food' => 'Pizza'
-        );
-        $store->write($session1, serialize($data1));
-        $result1 = $store->read($session1);
-        $this->assertEquals($data1, unserialize($result1));
-
-        // Go to the future and test that the expiry is accurate
-        DBDatetime::set_mock_now('2040-03-16 12:00:00');
-        $result2 = $store->read($session1);
-
-        $this->assertEmpty($result2);
-    }
+	protected $usesDatabase = true;
+
+	protected function setUp()
+	{
+		parent::setUp();
+
+		TestCookieStore::$override_headers_sent = false;
+
+		Injector::inst()->registerService(
+			new TestCookieStore(),
+			CookieStore::class
+		);
+
+		DBDatetime::set_mock_now('2010-03-15 12:00:00');
+	}
+
+	protected function tearDown()
+	{
+		DBDatetime::clear_mock_now();
+
+		parent::tearDown();
+	}
+
+	abstract protected function getStore();
+
+	/**
+	 * Test how this store handles large volumes of data (>1000 characters)
+	 */
+	public function testStoreLargeData()
+	{
+		$session = uniqid();
+		$store = $this->getStore();
+
+		// Test new session is blank
+		$result = $store->read($session);
+		$this->assertEmpty($result);
+
+		// Save data against session
+		$data1 = array(
+			'Large' => str_repeat('A', 600),
+			'Content' => str_repeat('B', 600)
+		);
+		$store->write($session, serialize($data1));
+		$result = $store->read($session);
+		$this->assertEquals($data1, unserialize($result));
+	}
+
+	/**
+	 * Test storage of data
+	 */
+	public function testStoreData()
+	{
+		$session = uniqid();
+		$store = $this->getStore();
+
+		// Test new session is blank
+		$result = $store->read($session);
+		$this->assertEmpty($result);
+
+		// Save data against session
+		$data1 = array(
+			'Color' => 'red',
+			'Animal' => 'elephant'
+		);
+		$store->write($session, serialize($data1));
+		$result = $store->read($session);
+		$this->assertEquals($data1, unserialize($result));
+
+		// Save larger data
+		$data2 = array(
+			'Color' => 'blue',
+			'Animal' => str_repeat('bat', 100)
+		);
+		$store->write($session, serialize($data2));
+		$result = $store->read($session);
+		$this->assertEquals($data2, unserialize($result));
+	}
+
+	/**
+	 * Test expiry of data
+	 */
+	public function testExpiry()
+	{
+		$session1 = uniqid();
+		$store = $this->getStore();
+
+		// Store data now
+		$data1 = array(
+			'Food' => 'Pizza'
+		);
+		$store->write($session1, serialize($data1));
+		$result1 = $store->read($session1);
+		$this->assertEquals($data1, unserialize($result1));
+
+		// Go to the future and test that the expiry is accurate
+		DBDatetime::set_mock_now('2040-03-16 12:00:00');
+		$result2 = $store->read($session1);
+
+		$this->assertEmpty($result2);
+	}
 }

tests/DatabaseStoreTest.php

Indentation +13 added lines, -13 removed lines

@@ -9,20 +9,20 @@
 
 class DatabaseStoreTest extends AbstractTest
 {
-    protected function setUp()
-    {
-        parent::setUp();
+	protected function setUp()
+	{
+		parent::setUp();
 
-        if (!DB::get_conn() instanceof MySQLDatabase) {
-            $this->markTestSkipped('Only MySQL databases are supported');
-        }
-    }
+		if (!DB::get_conn() instanceof MySQLDatabase) {
+			$this->markTestSkipped('Only MySQL databases are supported');
+		}
+	}
 
-    protected function getStore()
-    {
-        $store = Injector::inst()->get(DatabaseStore::class);
-        $store->setKey(uniqid());
+	protected function getStore()
+	{
+		$store = Injector::inst()->get(DatabaseStore::class);
+		$store->setKey(uniqid());
 
-        return $store;
-    }
+		return $store;
+	}
 }

tests/HybridSessionTest.php

Indentation +79 added lines, -79 removed lines

@@ -9,83 +9,83 @@
 
 class HybridSessionTest extends SapphireTest
 {
-    /**
-     * @var BaseStore
-     */
-    protected $handler;
-
-    /**
-     * @var HybridSession
-     */
-    protected $instance;
-
-    protected function setUp()
-    {
-        parent::setUp();
-
-        $this->handler = $this->createMock(TestCookieStore::class);
-
-        $this->instance = new HybridSession();
-    }
-
-    public function testSetHandlersAlsoSetsKeyToEachHandler()
-    {
-        $this->instance->setKey('foobar');
-        $this->handler->expects($this->once())->method('setKey')->with('foobar');
-        $this->instance->setHandlers([$this->handler]);
-    }
-
-    public function testOpenDelegatesToAllHandlers()
-    {
-        $this->handler->expects($this->once())->method('open')->with('foo', 'bar');
-        $this->instance->setHandlers([$this->handler]);
-        $this->assertTrue($this->instance->open('foo', 'bar'), 'Method returns true after delegation');
-    }
-
-    public function testCloseDelegatesToAllHandlers()
-    {
-        $this->handler->expects($this->once())->method('close');
-        $this->instance->setHandlers([$this->handler]);
-        $this->assertTrue($this->instance->close(), 'Method returns true after delegation');
-    }
-
-    public function testReadReturnsEmptyStringWithNoHandlers()
-    {
-        $this->handler->expects($this->once())->method('read')->with('foosession')->willReturn(false);
-        $this->instance->setHandlers([$this->handler]);
-        $this->assertSame('', $this->instance->read('foosession'));
-    }
-
-    public function testReadReturnsHandlerDelegateResult()
-    {
-        $this->handler->expects($this->once())->method('read')->with('foo.session')->willReturn('success!');
-        $this->instance->setHandlers([$this->handler]);
-        $this->assertSame('success!', $this->instance->read('foo.session'));
-    }
-
-    public function testWriteDelegatesToHandlerAndReturnsTrue()
-    {
-        $this->handler->expects($this->once())->method('write')->with('foo', 'bar')->willReturn(true);
-        $this->instance->setHandlers([$this->handler]);
-        $this->assertTrue($this->instance->write('foo', 'bar'));
-    }
-
-    public function testWriteReturnsFalseWithNoHandlers()
-    {
-        $this->assertFalse($this->instance->write('no', 'handlers'));
-    }
-
-    public function testDestroyDelegatesToHandler()
-    {
-        $this->handler->expects($this->once())->method('destroy')->with('sessid1234');
-        $this->instance->setHandlers([$this->handler]);
-        $this->assertTrue($this->instance->destroy('sessid1234'), 'Method returns true after delegation');
-    }
-
-    public function testGcDelegatesToHandlers()
-    {
-        $this->handler->expects($this->once())->method('gc')->with(12345);
-        $this->instance->setHandlers([$this->handler]);
-        $this->instance->gc(12345);
-    }
+	/**
+	 * @var BaseStore
+	 */
+	protected $handler;
+
+	/**
+	 * @var HybridSession
+	 */
+	protected $instance;
+
+	protected function setUp()
+	{
+		parent::setUp();
+
+		$this->handler = $this->createMock(TestCookieStore::class);
+
+		$this->instance = new HybridSession();
+	}
+
+	public function testSetHandlersAlsoSetsKeyToEachHandler()
+	{
+		$this->instance->setKey('foobar');
+		$this->handler->expects($this->once())->method('setKey')->with('foobar');
+		$this->instance->setHandlers([$this->handler]);
+	}
+
+	public function testOpenDelegatesToAllHandlers()
+	{
+		$this->handler->expects($this->once())->method('open')->with('foo', 'bar');
+		$this->instance->setHandlers([$this->handler]);
+		$this->assertTrue($this->instance->open('foo', 'bar'), 'Method returns true after delegation');
+	}
+
+	public function testCloseDelegatesToAllHandlers()
+	{
+		$this->handler->expects($this->once())->method('close');
+		$this->instance->setHandlers([$this->handler]);
+		$this->assertTrue($this->instance->close(), 'Method returns true after delegation');
+	}
+
+	public function testReadReturnsEmptyStringWithNoHandlers()
+	{
+		$this->handler->expects($this->once())->method('read')->with('foosession')->willReturn(false);
+		$this->instance->setHandlers([$this->handler]);
+		$this->assertSame('', $this->instance->read('foosession'));
+	}
+
+	public function testReadReturnsHandlerDelegateResult()
+	{
+		$this->handler->expects($this->once())->method('read')->with('foo.session')->willReturn('success!');
+		$this->instance->setHandlers([$this->handler]);
+		$this->assertSame('success!', $this->instance->read('foo.session'));
+	}
+
+	public function testWriteDelegatesToHandlerAndReturnsTrue()
+	{
+		$this->handler->expects($this->once())->method('write')->with('foo', 'bar')->willReturn(true);
+		$this->instance->setHandlers([$this->handler]);
+		$this->assertTrue($this->instance->write('foo', 'bar'));
+	}
+
+	public function testWriteReturnsFalseWithNoHandlers()
+	{
+		$this->assertFalse($this->instance->write('no', 'handlers'));
+	}
+
+	public function testDestroyDelegatesToHandler()
+	{
+		$this->handler->expects($this->once())->method('destroy')->with('sessid1234');
+		$this->instance->setHandlers([$this->handler]);
+		$this->assertTrue($this->instance->destroy('sessid1234'), 'Method returns true after delegation');
+	}
+
+	public function testGcDelegatesToHandlers()
+	{
+		$this->handler->expects($this->once())->method('gc')->with(12345);
+		$this->instance->setHandlers([$this->handler]);
+		$this->instance->gc(12345);
+	}
 }

tests/Store/TestCookieStore.php

Indentation +15 added lines, -15 removed lines

@@ -7,21 +7,21 @@
 
 class TestCookieStore extends CookieStore implements TestOnly
 {
-    /**
-     * Override value of 'headers_sent' but only if running tests.
-     *
-     * Set to true or false, or null to not override
-     *
-     * @var string
-     */
-    public static $override_headers_sent = null;
+	/**
+	 * Override value of 'headers_sent' but only if running tests.
+	 *
+	 * Set to true or false, or null to not override
+	 *
+	 * @var string
+	 */
+	public static $override_headers_sent = null;
 
-    protected function canWrite()
-    {
-        if (self::$override_headers_sent !== null) {
-            return !self::$override_headers_sent;
-        }
+	protected function canWrite()
+	{
+		if (self::$override_headers_sent !== null) {
+			return !self::$override_headers_sent;
+		}
 
-        parent::canWrite();
-    }
+		parent::canWrite();
+	}
 }