add redis support for sessions

2026-07-25 17:24:10 -04:00 · 2020-05-29 15:34:40 -07:00
parent 967d8387a8
commit 02800944cf
2 changed files with 139 additions and 1 deletions
@@ -0,0 +1,129 @@
+<?php defined('SYSPATH') OR die('No direct access allowed.');
+/**
+ * Session redis driver.
+ *
+ * $Id: Database.php 4729 2009-12-29 20:35:19Z isaiah $
+ *
+ * @package    Kohana
+ * @author     Kohana Team
+ * @copyright  (c) 2007-2009 Kohana Team
+ * @license    http://kohanaphp.com/license
+ */
+class Session_Redis_Driver implements Session_Driver {
+
+	// Encryption
+	protected $encrypt;
+
+	// Session settings
+	protected $session_id;
+	protected $written = FALSE;
+
+	public function __construct()
+	{
+		// Load configuration
+		$this->config = Kohana::config('session');
+
+		if ( ! empty($this->config['encryption']))
+		{
+			// Load encryption
+			$this->encrypt = Encrypt::instance();
+		}
+
+		if ( ! extension_loaded('redis'))
+			throw new Exception('The redis PHP extension must be loaded to use this driver.');
+
+		$this->backend = new Redis;
+
+		if (empty($this->config['server'])) throw new Cache_Exception('Define the "server" settings in your session config');
+
+		$server = $this->config['server'];
+
+		if (empty($server['host'])) throw new Cache_Exception('Missing Redis host');
+		$method = !empty($server['persistent']) ? 'pconnect' : 'connect';
+
+		if (empty($server['port']))
+		{
+			$this->backend->$method($server['host'], $server['port']);
+		}
+		else
+		{
+			$this->backend->$method($server['host']);
+		}
+
+		Kohana_Log::add('debug', 'Session Redis Driver Initialized');
+	}
+
+	public function open($path, $name)
+	{
+		return TRUE;
+	}
+
+	public function close()
+	{
+		if (empty($this->config['server']['persistent']))
+		{
+			$this->backend->close();
+		}
+
+		return TRUE;
+	}
+
+	public function read($id)
+	{
+		$data = $this->backend->get($id);
+
+		if (!strlen($data))
+		{
+			// No current session
+			$this->session_id = NULL;
+
+			return '';
+		}
+
+		// Set the current session id
+		$this->session_id = $id;
+
+		return ($this->encrypt === NULL) ? base64_decode($data) : $this->encrypt->decode($data);
+	}
+
+	public function write($id, $data)
+	{
+		if ( ! Session::$should_save)
+			return TRUE;
+
+		$data = $this->backend->set(
+			$id,
+			($this->encrypt === NULL) ? base64_encode($data) : $this->encrypt->encode($data),
+			ini_get('session.gc_maxlifetime')
+		);
+
+		return TRUE;
+	}
+
+	public function destroy($id)
+	{
+		$this->backend->del($id);
+
+		// Session id is no longer valid
+		$this->session_id = NULL;
+
+		return TRUE;
+	}
+
+	public function regenerate()
+	{
+		// Generate a new session id
+		session_regenerate_id();
+
+		// Return new session id
+		return session_id();
+	}
+
+	public function gc($maxlifetime)
+	{
+		// Delete all expired sessions
+
+		return TRUE;
+	}
+
+} // End Session Redis Driver