silverstripe / silverstripe-hybridsessions

src/HybridSession.php

Doc Comments +2 added lines

@@ -25,6 +25,7 @@ 
 
     /**
      * @param SessionHandlerInterface[]
+     * @param BaseStore[] $handlers
      *
      * @return $this
      */
@@ -38,6 +39,7 @@ 
 
     /**
      * @param string
+     * @param string $key
      *
      * @return $this
      */

Indentation +148 added lines, -148 removed lines

@@ -9,152 +9,152 @@
 class HybridSession extends BaseStore
 {
 
-    /**
-     * List of session handlers
-     *
-     * @var array
-     */
-    protected $handlers = [];
-
-    /**
-     * True if this session store has been initialised
-     *
-     * @var bool
-     */
-    protected static $enabled = false;
-
-    /**
-     * @param SessionHandlerInterface[]
-     *
-     * @return $this
-     */
-    public function setHandlers($handlers)
-    {
-        $this->handlers = $handlers;
-        $this->setKey($this->getKey());
-
-        return $this;
-    }
-
-    /**
-     * @param string
-     *
-     * @return $this
-     */
-    public function setKey($key)
-    {
-        parent::setKey($key);
-
-        foreach ($this->getHandlers() as $handler) {
-            $handler->setKey($key);
-        }
-
-        return $this;
-    }
-
-    /**
-     * @return SessionHandlerInterface[]
-     */
-    public function getHandlers()
-    {
-        return $this->handlers ?: [];
-    }
-
-    /**
-     * @param string $save_path
-     * @param string $name
-     *
-     * @return bool
-     */
-    public function open($save_path, $name)
-    {
-        foreach ($this->getHandlers() as $handler) {
-            $handler->open($save_path, $name);
-        }
-
-        return true;
-    }
-
-    /**
-     * @return bool
-     */
-    public function close()
-    {
-        foreach ($this->getHandlers() as $handler) {
-            $handler->close();
-        }
-
-        return true;
-    }
-
-    /**
-     * @param string $session_id
-     *
-     * @return string
-     */
-    public function read($session_id)
-    {
-        foreach ($this->getHandlers() as $handler) {
-            if ($data = $handler->read($session_id)) {
-                return $data;
-            }
-        }
-
-        return '';
-    }
-
-    public function write($session_id, $session_data)
-    {
-        foreach ($this->getHandlers() as $handler) {
-            if ($handler->write($session_id, $session_data)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    public function destroy($session_id)
-    {
-        foreach ($this->getHandlers() as $handler) {
-            $handler->destroy($session_id);
-        }
-
-        return true;
-    }
-
-    public function gc($maxlifetime)
-    {
-        foreach ($this->getHandlers() as $handler) {
-            $handler->gc($maxlifetime);
-        }
-    }
-
-    /**
-     * Register the session handler as the default
-     *
-     * @param string $key Desired session key
-     */
-    public static function init($key = null)
-    {
-        $instance = Injector::inst()->get(__CLASS__);
-
-        if (empty($key)) {
-            user_error(
-                'HybridSession::init() was not given a $key. Disabling cookie-based storage',
-                E_USER_WARNING
-            );
-        } else {
-            $instance->setKey($key);
-        }
-
-        session_set_save_handler($instance, true);
-
-        self::$enabled = true;
-    }
-
-    public static function is_enabled()
-    {
-        return self::$enabled;
-    }
+	/**
+	 * List of session handlers
+	 *
+	 * @var array
+	 */
+	protected $handlers = [];
+
+	/**
+	 * True if this session store has been initialised
+	 *
+	 * @var bool
+	 */
+	protected static $enabled = false;
+
+	/**
+	 * @param SessionHandlerInterface[]
+	 *
+	 * @return $this
+	 */
+	public function setHandlers($handlers)
+	{
+		$this->handlers = $handlers;
+		$this->setKey($this->getKey());
+
+		return $this;
+	}
+
+	/**
+	 * @param string
+	 *
+	 * @return $this
+	 */
+	public function setKey($key)
+	{
+		parent::setKey($key);
+
+		foreach ($this->getHandlers() as $handler) {
+			$handler->setKey($key);
+		}
+
+		return $this;
+	}
+
+	/**
+	 * @return SessionHandlerInterface[]
+	 */
+	public function getHandlers()
+	{
+		return $this->handlers ?: [];
+	}
+
+	/**
+	 * @param string $save_path
+	 * @param string $name
+	 *
+	 * @return bool
+	 */
+	public function open($save_path, $name)
+	{
+		foreach ($this->getHandlers() as $handler) {
+			$handler->open($save_path, $name);
+		}
+
+		return true;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function close()
+	{
+		foreach ($this->getHandlers() as $handler) {
+			$handler->close();
+		}
+
+		return true;
+	}
+
+	/**
+	 * @param string $session_id
+	 *
+	 * @return string
+	 */
+	public function read($session_id)
+	{
+		foreach ($this->getHandlers() as $handler) {
+			if ($data = $handler->read($session_id)) {
+				return $data;
+			}
+		}
+
+		return '';
+	}
+
+	public function write($session_id, $session_data)
+	{
+		foreach ($this->getHandlers() as $handler) {
+			if ($handler->write($session_id, $session_data)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	public function destroy($session_id)
+	{
+		foreach ($this->getHandlers() as $handler) {
+			$handler->destroy($session_id);
+		}
+
+		return true;
+	}
+
+	public function gc($maxlifetime)
+	{
+		foreach ($this->getHandlers() as $handler) {
+			$handler->gc($maxlifetime);
+		}
+	}
+
+	/**
+	 * Register the session handler as the default
+	 *
+	 * @param string $key Desired session key
+	 */
+	public static function init($key = null)
+	{
+		$instance = Injector::inst()->get(__CLASS__);
+
+		if (empty($key)) {
+			user_error(
+				'HybridSession::init() was not given a $key. Disabling cookie-based storage',
+				E_USER_WARNING
+			);
+		} else {
+			$instance->setKey($key);
+		}
+
+		session_set_save_handler($instance, true);
+
+		self::$enabled = true;
+	}
+
+	public static function is_enabled()
+	{
+		return self::$enabled;
+	}
 }

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();
+	}
 }

src/Store/DatabaseStore.php

Indentation +125 added lines, -125 removed lines

@@ -12,137 +12,137 @@
 class DatabaseStore extends BaseStore
 {
 
-    /**
-     * Determine if the DB is ready to use.
-     *
-     * @return bool
-     * @throws Exception
-     */
-    protected function isDatabaseReady()
-    {
-        // Such as during setup of testsession prior to DB connection.
-        if (!DB::is_active()) {
-            return false;
-        }
-
-        // If we have a DB of the wrong type then complain
-        if (!(DB::get_conn() instanceof MySQLDatabase)) {
-            throw new Exception('HybridSessions\Store\DatabaseStore currently only works with MySQL databases');
-        }
-
-        // Prevent freakout during dev/build
-        return ClassInfo::hasTable('HybridSessionDataObject');
-    }
-
-    public function open($save_path, $name)
-    {
-        // no-op
-    }
-
-    public function close()
-    {
-        // no-op
-    }
-
-    public function read($session_id)
-    {
-        if (!$this->isDatabaseReady()) {
-            return null;
-        }
-
-        $query = sprintf(
-            'SELECT "Data" FROM "HybridSessionDataObject"
+	/**
+	 * Determine if the DB is ready to use.
+	 *
+	 * @return bool
+	 * @throws Exception
+	 */
+	protected function isDatabaseReady()
+	{
+		// Such as during setup of testsession prior to DB connection.
+		if (!DB::is_active()) {
+			return false;
+		}
+
+		// If we have a DB of the wrong type then complain
+		if (!(DB::get_conn() instanceof MySQLDatabase)) {
+			throw new Exception('HybridSessions\Store\DatabaseStore currently only works with MySQL databases');
+		}
+
+		// Prevent freakout during dev/build
+		return ClassInfo::hasTable('HybridSessionDataObject');
+	}
+
+	public function open($save_path, $name)
+	{
+		// no-op
+	}
+
+	public function close()
+	{
+		// no-op
+	}
+
+	public function read($session_id)
+	{
+		if (!$this->isDatabaseReady()) {
+			return null;
+		}
+
+		$query = sprintf(
+			'SELECT "Data" FROM "HybridSessionDataObject"
             WHERE "SessionID" = \'%s\' AND "Expiry" >= %s',
-            Convert::raw2sql($session_id),
-            $this->getNow()
-        );
+			Convert::raw2sql($session_id),
+			$this->getNow()
+		);
 
-        $result = DB::query($query);
+		$result = DB::query($query);
 
-        if ($result && $result->numRecords()) {
-            $data = $result->first();
-            $decoded = $this->binaryDataJsonDecode($data['Data']);
-            return is_null($decoded) ? $data['Data'] : $decoded;
-        }
-    }
+		if ($result && $result->numRecords()) {
+			$data = $result->first();
+			$decoded = $this->binaryDataJsonDecode($data['Data']);
+			return is_null($decoded) ? $data['Data'] : $decoded;
+		}
+	}
 
-    public function write($session_id, $session_data)
-    {
-        if (!$this->isDatabaseReady()) {
-            return false;
-        }
+	public function write($session_id, $session_data)
+	{
+		if (!$this->isDatabaseReady()) {
+			return false;
+		}
 
-        $expiry = $this->getNow() + $this->getLifetime();
+		$expiry = $this->getNow() + $this->getLifetime();
 
-        DB::query($str = sprintf(
-            'INSERT INTO "HybridSessionDataObject" ("SessionID", "Expiry", "Data")
+		DB::query($str = sprintf(
+			'INSERT INTO "HybridSessionDataObject" ("SessionID", "Expiry", "Data")
             VALUES (\'%1$s\', %2$u, \'%3$s\')
             ON DUPLICATE KEY UPDATE "Expiry" = %2$u, "Data" = \'%3$s\'',
-            Convert::raw2sql($session_id),
-            $expiry,
-            Convert::raw2sql($this->binaryDataJsonEncode($session_data))
-        ));
-
-        return true;
-    }
-
-    public function destroy($session_id)
-    {
-        // NOP
-    }
-
-    public function gc($maxlifetime)
-    {
-        if (!$this->isDatabaseReady()) {
-            return;
-        }
-
-        DB::query(sprintf(
-            'DELETE FROM "HybridSessionDataObject" WHERE "Expiry" < %u',
-            $this->getNow()
-        ));
-    }
-
-    /**
-    * Encode binary data into ASCII string (a subset of UTF-8)
-    *
-    * Silverstripe <= 4.4 does not have a binary db field implementation, so we have to store
-    * binary data as text
-    *
-    * @param string $data This is a binary blob
-    *
-    * @return string
-    */
-    private function binaryDataJsonEncode($data)
-    {
-        return json_encode([
-            self::class,
-            base64_encode($data)
-        ]);
-    }
-
-    /**
-     * Decode ASCII string into original binary data (a php string)
-     *
-     * Silverstripe <= 4.4 does not have a binary db field implementation, so we have to store
-     * binary data as text
-     *
-     * @param string $text
-     *
-     * @param null|string
-     */
-    private function binaryDataJsonDecode($text)
-    {
-        $struct = json_decode($text, true, 2);
-
-        if (!is_array($struct) || count($struct) !== 2) {
-            return null;
-        }
-
-        if (!isset($struct[0]) || !isset($struct[1]) || $struct[0] !== self::class) {
-            return null;
-        }
-
-        return base64_decode($struct[1]);
-    }
+			Convert::raw2sql($session_id),
+			$expiry,
+			Convert::raw2sql($this->binaryDataJsonEncode($session_data))
+		));
+
+		return true;
+	}
+
+	public function destroy($session_id)
+	{
+		// NOP
+	}
+
+	public function gc($maxlifetime)
+	{
+		if (!$this->isDatabaseReady()) {
+			return;
+		}
+
+		DB::query(sprintf(
+			'DELETE FROM "HybridSessionDataObject" WHERE "Expiry" < %u',
+			$this->getNow()
+		));
+	}
+
+	/**
+	 * Encode binary data into ASCII string (a subset of UTF-8)
+	 *
+	 * Silverstripe <= 4.4 does not have a binary db field implementation, so we have to store
+	 * binary data as text
+	 *
+	 * @param string $data This is a binary blob
+	 *
+	 * @return string
+	 */
+	private function binaryDataJsonEncode($data)
+	{
+		return json_encode([
+			self::class,
+			base64_encode($data)
+		]);
+	}
+
+	/**
+	 * Decode ASCII string into original binary data (a php string)
+	 *
+	 * Silverstripe <= 4.4 does not have a binary db field implementation, so we have to store
+	 * binary data as text
+	 *
+	 * @param string $text
+	 *
+	 * @param null|string
+	 */
+	private function binaryDataJsonDecode($text)
+	{
+		$struct = json_decode($text, true, 2);
+
+		if (!is_array($struct) || count($struct) !== 2) {
+			return null;
+		}
+
+		if (!isset($struct[0]) || !isset($struct[1]) || $struct[0] !== self::class) {
+			return null;
+		}
+
+		return base64_decode($struct[1]);
+	}
 }

tests/CookieStoreTest.php

Indentation +55 added lines, -55 removed lines

@@ -9,69 +9,69 @@
 
 class CookieStoreTest extends AbstractTest
 {
-    protected function getStore()
-    {
-        $store = Injector::inst()->get(CookieStore::class);
-        $store->setKey(uniqid());
-        $store->open(TempFolder::getTempFolder(BASE_PATH) . '/' . __CLASS__, 'SESSIONCOOKIE');
+	protected function getStore()
+	{
+		$store = Injector::inst()->get(CookieStore::class);
+		$store->setKey(uniqid());
+		$store->open(TempFolder::getTempFolder(BASE_PATH) . '/' . __CLASS__, 'SESSIONCOOKIE');
 
-        return $store;
-    }
+		return $store;
+	}
 
-    public function testStoreLargeData()
-    {
-        $session = uniqid();
-        $store = $this->getStore();
+	public function testStoreLargeData()
+	{
+		$session = uniqid();
+		$store = $this->getStore();
 
-        // Test new session is blank
-        $result = $store->read($session);
-        $this->assertEmpty($result);
+		// 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);
+		// 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);
 
-        // Cookies should not try to store data that large
-        $this->assertEmpty($result);
-    }
+		// Cookies should not try to store data that large
+		$this->assertEmpty($result);
+	}
 
-    /**
-     * Ensure that subsequent reads without the necessary write do not report data
-     */
-    public function testReadInvalidatesData()
-    {
-        $session = uniqid();
-        $store = $this->getStore();
+	/**
+	 * Ensure that subsequent reads without the necessary write do not report data
+	 */
+	public function testReadInvalidatesData()
+	{
+		$session = uniqid();
+		$store = $this->getStore();
 
-        // Test new session is blank
-        $result = $store->read($session);
-        $this->assertEmpty($result);
+		// 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 data against session
+		$data1 = array(
+			'Color' => 'red',
+			'Animal' => 'elephant'
+		);
+		$store->write($session, serialize($data1));
+		$result = $store->read($session);
+		$this->assertEquals($data1, unserialize($result));
 
-        // Since we have read the data into the result, the application could modify this content
-        // and be unable to write it back due to headers being sent. We should thus assume
-        // that subsequent reads without a successful write do not purport to have valid data
-        $data1['Color'] = 'blue';
-        $result = $store->read($session);
-        $this->assertEmpty($result);
+		// Since we have read the data into the result, the application could modify this content
+		// and be unable to write it back due to headers being sent. We should thus assume
+		// that subsequent reads without a successful write do not purport to have valid data
+		$data1['Color'] = 'blue';
+		$result = $store->read($session);
+		$this->assertEmpty($result);
 
-        // Check that writing to cookie fails after headers are sent and these results remain
-        // invalidated
-        TestCookieStore::$override_headers_sent = true;
-        $store->write($session, serialize($data1));
-        $result = $store->read($session);
-        $this->assertEmpty($result);
-    }
+		// Check that writing to cookie fails after headers are sent and these results remain
+		// invalidated
+		TestCookieStore::$override_headers_sent = true;
+		$store->write($session, serialize($data1));
+		$result = $store->read($session);
+		$this->assertEmpty($result);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
     {
         $store = Injector::inst()->get(CookieStore::class);
         $store->setKey(uniqid());
-        $store->open(TempFolder::getTempFolder(BASE_PATH) . '/' . __CLASS__, 'SESSIONCOOKIE');
+        $store->open(TempFolder::getTempFolder(BASE_PATH).'/'.__CLASS__, 'SESSIONCOOKIE');
 
         return $store;
     }