Merge branch 'MDL-56823' of git://github.com/aolley/moodle
[moodle.git] / lib / classes / session / redis.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Redis based session handler.
19  *
20  * @package    core
21  * @copyright  2015 Russell Smith <mr-russ@smith2001.net>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core\session;
27 use RedisException;
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * Redis based session handler.
33  *
34  * The default Redis session handler does not handle locking in 2.2.7, so we have written a php session handler
35  * that uses locking.  The places where locking is used was modeled from the memcached code that is used in Moodle
36  * https://github.com/php-memcached-dev/php-memcached/blob/master/php_memcached_session.c
37  *
38  * @package    core
39  * @copyright  2016 Russell Smith
40  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 class redis extends handler {
43     /** @var string $host save_path string  */
44     protected $host = '';
45     /** @var int $port The port to connect to */
46     protected $port = 6379;
47     /** @var int $database the Redis database to store sesions in */
48     protected $database = 0;
49     /** @var array $servers list of servers parsed from save_path */
50     protected $prefix = '';
51     /** @var int $acquiretimeout how long to wait for session lock in seconds */
52     protected $acquiretimeout = 120;
53     /**
54      * @var int $lockexpire how long to wait in seconds before expiring the lock automatically
55      * so that other requests may continue execution, ignored if PECL redis is below version 2.2.0.
56      */
57     protected $lockexpire;
59     /** @var Redis Connection */
60     protected $connection = null;
62     /** @var array $locks List of currently held locks by this page. */
63     protected $locks = array();
65     /** @var int $timeout How long sessions live before expiring. */
66     protected $timeout;
68     /**
69      * Create new instance of handler.
70      */
71     public function __construct() {
72         global $CFG;
74         if (isset($CFG->session_redis_host)) {
75             $this->host = $CFG->session_redis_host;
76         }
78         if (isset($CFG->session_redis_port)) {
79             $this->port = (int)$CFG->session_redis_port;
80         }
82         if (isset($CFG->session_redis_database)) {
83             $this->database = (int)$CFG->session_redis_database;
84         }
86         if (isset($CFG->session_redis_prefix)) {
87             $this->prefix = $CFG->session_redis_prefix;
88         }
90         if (isset($CFG->session_redis_acquire_lock_timeout)) {
91             $this->acquiretimeout = (int)$CFG->session_redis_acquire_lock_timeout;
92         }
94         // The following configures the session lifetime in redis to allow some
95         // wriggle room in the user noticing they've been booted off and
96         // letting them log back in before they lose their session entirely.
97         $updatefreq = empty($CFG->session_update_timemodified_frequency) ? 20 : $CFG->session_update_timemodified_frequency;
98         $this->timeout = $CFG->sessiontimeout + $updatefreq + MINSECS;
100         $this->lockexpire = $CFG->sessiontimeout;
101         if (isset($CFG->session_redis_lock_expire)) {
102             $this->lockexpire = (int)$CFG->session_redis_lock_expire;
103         }
104     }
106     /**
107      * Start the session.
108      *
109      * @return bool success
110      */
111     public function start() {
112         $result = parent::start();
114         return $result;
115     }
117     /**
118      * Init session handler.
119      */
120     public function init() {
121         if (!extension_loaded('redis')) {
122             throw new exception('sessionhandlerproblem', 'error', '', null, 'redis extension is not loaded');
123         }
125         if (empty($this->host)) {
126             throw new exception('sessionhandlerproblem', 'error', '', null,
127                     '$CFG->session_redis_host must be specified in config.php');
128         }
130         // The session handler requires a version of Redis with the SETEX command (at least 2.0).
131         $version = phpversion('Redis');
132         if (!$version or version_compare($version, '2.0') <= 0) {
133             throw new exception('sessionhandlerproblem', 'error', '', null, 'redis extension version must be at least 2.0');
134         }
136         $this->connection = new \Redis();
138         $result = session_set_save_handler(array($this, 'handler_open'),
139             array($this, 'handler_close'),
140             array($this, 'handler_read'),
141             array($this, 'handler_write'),
142             array($this, 'handler_destroy'),
143             array($this, 'handler_gc'));
144         if (!$result) {
145             throw new exception('redissessionhandlerproblem', 'error');
146         }
148         try {
149             // One second timeout was chosen as it is long for connection, but short enough for a user to be patient.
150             if (!$this->connection->connect($this->host, $this->port, 1)) {
151                 throw new RedisException('Unable to connect to host.');
152             }
153             if (!$this->connection->setOption(\Redis::OPT_SERIALIZER, \Redis::SERIALIZER_PHP)) {
154                 throw new RedisException('Unable to set Redis PHP Serializer option.');
155             }
157             if ($this->prefix !== '') {
158                 // Use custom prefix on sessions.
159                 if (!$this->connection->setOption(\Redis::OPT_PREFIX, $this->prefix)) {
160                     throw new RedisException('Unable to set Redis Prefix option.');
161                 }
162             }
163             if ($this->database !== 0) {
164                 if (!$this->connection->select($this->database)) {
165                     throw new RedisException('Unable to select Redis database '.$this->database.'.');
166                 }
167             }
168             $this->connection->ping();
169             return true;
170         } catch (RedisException $e) {
171             error_log('Failed to connect to redis at '.$this->host.':'.$this->port.', error returned was: '.$e->getMessage());
172             return false;
173         }
174     }
176     /**
177      * Update our session search path to include session name when opened.
178      *
179      * @param string $savepath  unused session save path. (ignored)
180      * @param string $sessionname Session name for this session. (ignored)
181      * @return bool true always as we will succeed.
182      */
183     public function handler_open($savepath, $sessionname) {
184         return true;
185     }
187     /**
188      * Close the session completely. We also remove all locks we may have obtained that aren't expired.
189      *
190      * @return bool true on success.  false on unable to unlock sessions.
191      */
192     public function handler_close() {
193         try {
194             foreach ($this->locks as $id => $expirytime) {
195                 if ($expirytime > $this->time()) {
196                     $this->unlock_session($id);
197                 }
198                 unset($this->locks[$id]);
199             }
200         } catch (RedisException $e) {
201             error_log('Failed talking to redis: '.$e->getMessage());
202             return false;
203         }
205         return true;
206     }
207     /**
208      * Read the session data from storage
209      *
210      * @param string $id The session id to read from storage.
211      * @return string The session data for PHP to process.
212      *
213      * @throws RedisException when we are unable to talk to the Redis server.
214      */
215     public function handler_read($id) {
216         try {
217             $this->lock_session($id);
218             $sessiondata = $this->connection->get($id);
219             if ($sessiondata === false) {
220                 $this->unlock_session($id);
221                 return '';
222             }
223             $this->connection->expire($id, $this->timeout);
224         } catch (RedisException $e) {
225             error_log('Failed talking to redis: '.$e->getMessage());
226             throw $e;
227         }
228         return $sessiondata;
229     }
231     /**
232      * Write the serialized session data to our session store.
233      *
234      * @param string $id session id to write.
235      * @param string $data session data
236      * @return bool true on write success, false on failure
237      */
238     public function handler_write($id, $data) {
239         if (is_null($this->connection)) {
240             // The session has already been closed, don't attempt another write.
241             error_log('Tried to write session: '.$id.' before open or after close.');
242             return false;
243         }
245         // We do not do locking here because memcached doesn't.  Also
246         // PHP does open, read, destroy, write, close. When a session doesn't exist.
247         // There can be race conditions on new sessions racing each other but we can
248         // address that in the future.
249         try {
250             $this->connection->setex($id, $this->timeout, $data);
251         } catch (RedisException $e) {
252             error_log('Failed talking to redis: '.$e->getMessage());
253             return false;
254         }
255         return true;
256     }
258     /**
259      * Handle destroying a session.
260      *
261      * @param string $id the session id to destroy.
262      * @return bool true if the session was deleted, false otherwise.
263      */
264     public function handler_destroy($id) {
265         try {
266             $this->connection->del($id);
267             $this->unlock_session($id);
268         } catch (RedisException $e) {
269             error_log('Failed talking to redis: '.$e->getMessage());
270             return false;
271         }
273         return true;
274     }
276     /**
277      * Garbage collect sessions.  We don't we any as Redis does it for us.
278      *
279      * @param integer $maxlifetime All sessions older than this should be removed.
280      * @return bool true, as Redis handles expiry for us.
281      */
282     public function handler_gc($maxlifetime) {
283         return true;
284     }
286     /**
287      * Unlock a session.
288      *
289      * @param string $id Session id to be unlocked.
290      */
291     protected function unlock_session($id) {
292         if (isset($this->locks[$id])) {
293             $this->connection->del($id.".lock");
294             unset($this->locks[$id]);
295         }
296     }
298     /**
299      * Obtain a session lock so we are the only one using it at the moent.
300      *
301      * @param string $id The session id to lock.
302      * @return bool true when session was locked, exception otherwise.
303      * @throws exception When we are unable to obtain a session lock.
304      */
305     protected function lock_session($id) {
306         $lockkey = $id.".lock";
308         $haslock = isset($this->locks[$id]) && $this->time() < $this->locks[$id];
309         $startlocktime = $this->time();
311         /* To be able to ensure sessions don't write out of order we must obtain an exclusive lock
312          * on the session for the entire time it is open.  If another AJAX call, or page is using
313          * the session then we just wait until it finishes before we can open the session.
314          */
315         while (!$haslock) {
316             $haslock = $this->connection->setnx($lockkey, '1');
317             if (!$haslock) {
318                 usleep(rand(100000, 1000000));
319                 if ($this->time() > $startlocktime + $this->acquiretimeout) {
320                     // This is a fatal error, better inform users.
321                     // It should not happen very often - all pages that need long time to execute
322                     // should close session immediately after access control checks.
323                     error_log('Cannot obtain session lock for sid: '.$id.' within '.$this->acquiretimeout.
324                             '. It is likely another page has a long session lock, or the session lock was never released.');
325                     throw new exception("Unable to obtain session lock");
326                 }
327             } else {
328                 $this->locks[$id] = $this->time() + $this->lockexpire;
329                 $this->connection->expire($lockkey, $this->lockexpire);
330                 return true;
331             }
332         }
333     }
335     /**
336      * Return the current time.
337      *
338      * @return int the current time as a unixtimestamp.
339      */
340     protected function time() {
341         return time();
342     }
344     /**
345      * Check the backend contains data for this session id.
346      *
347      * Note: this is intended to be called from manager::session_exists() only.
348      *
349      * @param string $sid
350      * @return bool true if session found.
351      */
352     public function session_exists($sid) {
353         if (!$this->connection) {
354             return false;
355         }
357         try {
358             return $this->connection->exists($sid);
359         } catch (RedisException $e) {
360             return false;
361         }
362     }
364     /**
365      * Kill all active sessions, the core sessions table is purged afterwards.
366      */
367     public function kill_all_sessions() {
368         global $DB;
369         if (!$this->connection) {
370             return;
371         }
373         $rs = $DB->get_recordset('sessions', array(), 'id DESC', 'id, sid');
374         foreach ($rs as $record) {
375             $this->handler_destroy($record->sid);
376         }
377         $rs->close();
378     }
380     /**
381      * Kill one session, the session record is removed afterwards.
382      *
383      * @param string $sid
384      */
385     public function kill_session($sid) {
386         if (!$this->connection) {
387             return;
388         }
390         $this->handler_destroy($sid);
391     }