blob: 01989d2d71b09b8c48c0191686e0cd2401f07ee2 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Darren Hillc4e266b2011-08-30 15:40:27 -04002/**
3 * CodeIgniter
4 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02005 * An open source application development framework for PHP
Andrey Andreev9ffcee62012-09-05 16:25:16 +03006 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +02007 * This content is released under the MIT License (MIT)
Andrey Andreev9ffcee62012-09-05 16:25:16 +03008 *
Andrey Andreev125ef472016-01-11 12:33:00 +02009 * Copyright (c) 2014 - 2016, British Columbia Institute of Technology
Andrey Andreev9ffcee62012-09-05 16:25:16 +030010 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020011 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
Darren Hillc4e266b2011-08-30 15:40:27 -040017 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020018 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 * THE SOFTWARE.
28 *
29 * @package CodeIgniter
30 * @author EllisLab Dev Team
Andrey Andreev1924e872016-01-11 12:55:34 +020031 * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
Andrey Andreev125ef472016-01-11 12:33:00 +020032 * @copyright Copyright (c) 2014 - 2016, British Columbia Institute of Technology (http://bcit.ca/)
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020033 * @license http://opensource.org/licenses/MIT MIT License
Andrey Andreevbd202c92016-01-11 12:50:18 +020034 * @link https://codeigniter.com
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020035 * @since Version 2.0.0
Darren Hillc4e266b2011-08-30 15:40:27 -040036 * @filesource
37 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020038defined('BASEPATH') OR exit('No direct script access allowed');
Darren Hillc4e266b2011-08-30 15:40:27 -040039
Darren Hillc4e266b2011-08-30 15:40:27 -040040/**
Andrey Andreev9ffcee62012-09-05 16:25:16 +030041 * CodeIgniter Session Class
Darren Hillc4e266b2011-08-30 15:40:27 -040042 *
Darren Hillc4e266b2011-08-30 15:40:27 -040043 * @package CodeIgniter
44 * @subpackage Libraries
45 * @category Sessions
Andrey Andreev47a47fb2014-05-31 16:08:30 +030046 * @author Andrey Andreev
Andrey Andreevbd202c92016-01-11 12:50:18 +020047 * @link https://codeigniter.com/user_guide/libraries/sessions.html
Darren Hillc4e266b2011-08-30 15:40:27 -040048 */
Andrey Andreev47a47fb2014-05-31 16:08:30 +030049class CI_Session {
Andrey Andreev9ffcee62012-09-05 16:25:16 +030050
Andrey Andreevb4b215e2015-01-19 11:59:11 +020051 /**
52 * Userdata array
53 *
54 * Just a reference to $_SESSION, for BC purposes.
55 */
56 public $userdata;
57
Andrey Andreev47a47fb2014-05-31 16:08:30 +030058 protected $_driver = 'files';
Andrey Andreevdfb39be2014-10-06 01:50:14 +030059 protected $_config;
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +030060 protected $_sid_regexp;
Darren Hillc4e266b2011-08-30 15:40:27 -040061
Andrey Andreev0fa95bd2012-11-01 23:33:14 +020062 // ------------------------------------------------------------------------
63
Darren Hillc4e266b2011-08-30 15:40:27 -040064 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +030065 * Class constructor
Darren Hillc4e266b2011-08-30 15:40:27 -040066 *
Andrey Andreev47a47fb2014-05-31 16:08:30 +030067 * @param array $params Configuration parameters
Andrey Andreev2e3e2302012-10-09 15:52:34 +030068 * @return void
Darren Hillc4e266b2011-08-30 15:40:27 -040069 */
70 public function __construct(array $params = array())
71 {
Andrey Andreev2e3e2302012-10-09 15:52:34 +030072 // No sessions under CLI
Andrey Andreevf964b162013-11-12 17:04:55 +020073 if (is_cli())
Andrey Andreev2e3e2302012-10-09 15:52:34 +030074 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +030075 log_message('debug', 'Session: Initialization under CLI aborted.');
76 return;
77 }
78 elseif ((bool) ini_get('session.auto_start'))
79 {
80 log_message('error', 'Session: session.auto_start is enabled in php.ini. Aborting.');
81 return;
82 }
83 elseif ( ! empty($params['driver']))
84 {
85 $this->_driver = $params['driver'];
86 unset($params['driver']);
87 }
Andrey Andreevdfb39be2014-10-06 01:50:14 +030088 elseif ($driver = config_item('sess_driver'))
Andrey Andreev34b1ef52014-05-31 21:23:41 +030089 {
90 $this->_driver = $driver;
91 }
Andrey Andreevac4f4722014-06-02 11:16:32 +030092 // Note: BC workaround
93 elseif (config_item('sess_use_database'))
94 {
Andrey Andreev85dfc2a2016-04-01 22:54:15 +030095 log_message('debug', 'Session: "sess_driver" is empty; using BC fallback to "sess_use_database".');
Andrey Andreevac4f4722014-06-02 11:16:32 +030096 $this->_driver = 'database';
97 }
Andrey Andreev47a47fb2014-05-31 16:08:30 +030098
Andrey Andreev34b92c62015-03-12 12:42:00 +020099 $class = $this->_ci_load_classes($this->_driver);
Andrey Andreev2e3e2302012-10-09 15:52:34 +0300100
Andrey Andreevdfb39be2014-10-06 01:50:14 +0300101 // Configuration ...
102 $this->_configure($params);
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300103 $this->_config['_sid_regexp'] = $this->_sid_regexp;
Andrey Andreevdfb39be2014-10-06 01:50:14 +0300104
105 $class = new $class($this->_config);
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300106 if ($class instanceof SessionHandlerInterface)
Darren Hillc4e266b2011-08-30 15:40:27 -0400107 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300108 if (is_php('5.4'))
Darren Hillc4e266b2011-08-30 15:40:27 -0400109 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300110 session_set_save_handler($class, TRUE);
Darren Hillc4e266b2011-08-30 15:40:27 -0400111 }
112 else
113 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300114 session_set_save_handler(
115 array($class, 'open'),
116 array($class, 'close'),
117 array($class, 'read'),
118 array($class, 'write'),
119 array($class, 'destroy'),
120 array($class, 'gc')
121 );
122
123 register_shutdown_function('session_write_close');
124 }
125 }
126 else
127 {
128 log_message('error', "Session: Driver '".$this->_driver."' doesn't implement SessionHandlerInterface. Aborting.");
129 return;
130 }
131
Andrey Andreev562e39b2014-11-12 15:38:58 +0200132 // Sanitize the cookie, because apparently PHP doesn't do that for userspace handlers
133 if (isset($_COOKIE[$this->_config['cookie_name']])
134 && (
135 ! is_string($_COOKIE[$this->_config['cookie_name']])
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300136 OR ! preg_match('#\A'.$this->_sid_regexp.'\z#', $_COOKIE[$this->_config['cookie_name']])
Andrey Andreev562e39b2014-11-12 15:38:58 +0200137 )
138 )
Andrey Andreevdfb39be2014-10-06 01:50:14 +0300139 {
Andrey Andreev562e39b2014-11-12 15:38:58 +0200140 unset($_COOKIE[$this->_config['cookie_name']]);
Andrey Andreevdfb39be2014-10-06 01:50:14 +0300141 }
142
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300143 session_start();
Andrey Andreevdfb39be2014-10-06 01:50:14 +0300144
Andrey Andreevff37ffe2014-11-04 12:28:57 +0200145 // Is session ID auto-regeneration configured? (ignoring ajax requests)
Andrey Andreev395f9282015-02-05 13:29:56 +0200146 if ((empty($_SERVER['HTTP_X_REQUESTED_WITH']) OR strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) !== 'xmlhttprequest')
Andrey Andreevde5c2462014-11-04 12:31:03 +0200147 && ($regenerate_time = config_item('sess_time_to_update')) > 0
Andrey Andreevff37ffe2014-11-04 12:28:57 +0200148 )
Andrey Andreev8e60b9a2014-11-04 11:08:06 +0200149 {
150 if ( ! isset($_SESSION['__ci_last_regenerate']))
151 {
152 $_SESSION['__ci_last_regenerate'] = time();
153 }
154 elseif ($_SESSION['__ci_last_regenerate'] < (time() - $regenerate_time))
155 {
Andrey Andreev789b1fe2015-02-07 19:30:30 +0200156 $this->sess_regenerate((bool) config_item('sess_regenerate_destroy'));
Andrey Andreev8e60b9a2014-11-04 11:08:06 +0200157 }
158 }
Andrey Andreevdfb39be2014-10-06 01:50:14 +0300159 // Another work-around ... PHP doesn't seem to send the session cookie
160 // unless it is being currently created or regenerated
Andrey Andreev8e60b9a2014-11-04 11:08:06 +0200161 elseif (isset($_COOKIE[$this->_config['cookie_name']]) && $_COOKIE[$this->_config['cookie_name']] === session_id())
Andrey Andreevdfb39be2014-10-06 01:50:14 +0300162 {
163 setcookie(
164 $this->_config['cookie_name'],
165 session_id(),
166 (empty($this->_config['cookie_lifetime']) ? 0 : time() + $this->_config['cookie_lifetime']),
167 $this->_config['cookie_path'],
168 $this->_config['cookie_domain'],
169 $this->_config['cookie_secure'],
170 TRUE
171 );
172 }
173
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300174 $this->_ci_init_vars();
Andrey Andreevdfb39be2014-10-06 01:50:14 +0300175
Andrey Andreev90726b82015-01-20 12:39:22 +0200176 log_message('info', "Session: Class initialized using '".$this->_driver."' driver.");
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300177 }
178
179 // ------------------------------------------------------------------------
180
Andrey Andreev10411fc2015-01-19 13:54:53 +0200181 /**
182 * CI Load Classes
183 *
184 * An internal method to load all possible dependency and extension
185 * classes. It kind of emulates the CI_Driver library, but is
186 * self-sufficient.
187 *
188 * @param string $driver Driver name
189 * @return string Driver class name
190 */
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300191 protected function _ci_load_classes($driver)
192 {
193 // PHP 5.4 compatibility
194 interface_exists('SessionHandlerInterface', FALSE) OR require_once(BASEPATH.'libraries/Session/SessionHandlerInterface.php');
195
196 $prefix = config_item('subclass_prefix');
197
198 if ( ! class_exists('CI_Session_driver', FALSE))
199 {
Andrey Andreeve86603f2014-06-11 14:03:36 +0300200 require_once(
201 file_exists(APPPATH.'libraries/Session/Session_driver.php')
202 ? APPPATH.'libraries/Session/Session_driver.php'
203 : BASEPATH.'libraries/Session/Session_driver.php'
204 );
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300205
206 if (file_exists($file_path = APPPATH.'libraries/Session/'.$prefix.'Session_driver.php'))
207 {
208 require_once($file_path);
209 }
210 }
211
212 $class = 'Session_'.$driver.'_driver';
Andrey Andreevcd94dd72014-12-09 17:38:56 +0200213
214 // Allow custom drivers without the CI_ or MY_ prefix
215 if ( ! class_exists($class, FALSE) && file_exists($file_path = APPPATH.'libraries/Session/drivers/'.$class.'.php'))
216 {
217 require_once($file_path);
218 if (class_exists($class, FALSE))
219 {
220 return $class;
221 }
222 }
223
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300224 if ( ! class_exists('CI_'.$class, FALSE))
225 {
226 if (file_exists($file_path = APPPATH.'libraries/Session/drivers/'.$class.'.php') OR file_exists($file_path = BASEPATH.'libraries/Session/drivers/'.$class.'.php'))
227 {
228 require_once($file_path);
229 }
230
Andrey Andreevcd94dd72014-12-09 17:38:56 +0200231 if ( ! class_exists('CI_'.$class, FALSE) && ! class_exists($class, FALSE))
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300232 {
Andrey Andreev1d195202015-03-13 11:25:29 +0200233 throw new UnexpectedValueException("Session: Configured driver '".$driver."' was not found. Aborting.");
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300234 }
235 }
236
Andrey Andreev738b9e32016-02-24 12:14:10 +0200237 if ( ! class_exists($prefix.$class, FALSE) && file_exists($file_path = APPPATH.'libraries/Session/drivers/'.$prefix.$class.'.php'))
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300238 {
239 require_once($file_path);
240 if (class_exists($prefix.$class, FALSE))
241 {
242 return $prefix.$class;
243 }
244 else
245 {
246 log_message('debug', 'Session: '.$prefix.$class.".php found but it doesn't declare class ".$prefix.$class.'.');
247 }
248 }
249
250 return 'CI_'.$class;
251 }
252
253 // ------------------------------------------------------------------------
254
255 /**
Andrey Andreevdfb39be2014-10-06 01:50:14 +0300256 * Configuration
257 *
258 * Handle input parameters and configuration defaults
259 *
260 * @param array &$params Input parameters
261 * @return void
262 */
263 protected function _configure(&$params)
264 {
265 $expiration = config_item('sess_expiration');
266
267 if (isset($params['cookie_lifetime']))
268 {
269 $params['cookie_lifetime'] = (int) $params['cookie_lifetime'];
270 }
271 else
272 {
273 $params['cookie_lifetime'] = ( ! isset($expiration) && config_item('sess_expire_on_close'))
274 ? 0 : (int) $expiration;
275 }
276
277 isset($params['cookie_name']) OR $params['cookie_name'] = config_item('sess_cookie_name');
278 if (empty($params['cookie_name']))
279 {
280 $params['cookie_name'] = ini_get('session.name');
281 }
282 else
283 {
284 ini_set('session.name', $params['cookie_name']);
285 }
286
287 isset($params['cookie_path']) OR $params['cookie_path'] = config_item('cookie_path');
Andrey Andreev41b546d2014-10-06 03:01:22 +0300288 isset($params['cookie_domain']) OR $params['cookie_domain'] = config_item('cookie_domain');
Andrey Andreevdfb39be2014-10-06 01:50:14 +0300289 isset($params['cookie_secure']) OR $params['cookie_secure'] = (bool) config_item('cookie_secure');
290
291 session_set_cookie_params(
292 $params['cookie_lifetime'],
293 $params['cookie_path'],
294 $params['cookie_domain'],
295 $params['cookie_secure'],
296 TRUE // HttpOnly; Yes, this is intentional and not configurable for security reasons
297 );
298
299 if (empty($expiration))
300 {
301 $params['expiration'] = (int) ini_get('session.gc_maxlifetime');
302 }
303 else
304 {
305 $params['expiration'] = (int) $expiration;
306 ini_set('session.gc_maxlifetime', $expiration);
307 }
308
309 $params['match_ip'] = (bool) (isset($params['match_ip']) ? $params['match_ip'] : config_item('sess_match_ip'));
310
311 isset($params['save_path']) OR $params['save_path'] = config_item('sess_save_path');
312
313 $this->_config = $params;
314
315 // Security is king
Andrey Andreevc02952d2015-02-13 13:04:38 +0200316 ini_set('session.use_trans_sid', 0);
Andrey Andreevdfb39be2014-10-06 01:50:14 +0300317 ini_set('session.use_strict_mode', 1);
318 ini_set('session.use_cookies', 1);
319 ini_set('session.use_only_cookies', 1);
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300320
Andrey Andreev2f760872016-10-27 16:39:12 +0300321 $this->_configure_sid_length();
322 }
323
324 // ------------------------------------------------------------------------
325
326 /**
327 * Configure session ID length
328 *
329 * To make life easier, we used to force SHA-1 and 4 bits per
330 * character on everyone. And of course, someone was unhappy.
331 *
332 * Then PHP 7.1 broke backwards-compatibility because ext/session
333 * is such a mess that nobody wants to touch it with a pole stick,
334 * and the one guy who does, nobody has the energy to argue with.
335 *
336 * So we were forced to make changes, and OF COURSE something was
337 * going to break and now we have this pile of shit. -- Narf
338 *
339 * @return void
340 */
341 protected function _configure_sid_length()
342 {
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300343 if (PHP_VERSION_ID < 70100)
344 {
Andrey Andreev2f760872016-10-27 16:39:12 +0300345 $hash_function = ini_get('session.hash_function');
346 if (ctype_digit($hash_function))
347 {
348 if ($hash_function !== '1')
349 {
350 ini_set('session.hash_function', 1);
Andrey Andreev2f760872016-10-27 16:39:12 +0300351 }
Andrey Andreevdbc025b2016-10-27 17:37:25 +0300352
353 $bits = 160;
Andrey Andreev2f760872016-10-27 16:39:12 +0300354 }
355 elseif ( ! in_array($hash_function, hash_algos(), TRUE))
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300356 {
357 ini_set('session.hash_function', 1);
Andrey Andreev2f760872016-10-27 16:39:12 +0300358 $bits = 160;
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300359 }
Andrey Andreev2f760872016-10-27 16:39:12 +0300360 elseif (($bits = strlen(hash($hash_function, 'dummy', false)) * 4) < 160)
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300361 {
Andrey Andreev2f760872016-10-27 16:39:12 +0300362 ini_set('session.hash_function', 1);
363 $bits = 160;
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300364 }
Andrey Andreev2f760872016-10-27 16:39:12 +0300365
366 $bits_per_character = (int) ini_get('session.hash_bits_per_character');
Andrey Andreevdbc025b2016-10-27 17:37:25 +0300367 $sid_length = (int) ceil($bits / $bits_per_character);
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300368 }
Andrey Andreev2f760872016-10-27 16:39:12 +0300369 else
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300370 {
Andrey Andreev2f760872016-10-27 16:39:12 +0300371 $bits_per_character = (int) ini_get('session.sid_bits_per_character');
372 $sid_length = (int) ini_get('session.sid_length');
373 if (($bits = $sid_length * $bits_per_character) < 160)
374 {
375 // Add as many more characters as necessary to reach at least 160 bits
376 $sid_length += (int) ceil((160 % $bits) / $bits_per_character);
377 ini_set('session.sid_length', $sid_length);
378 }
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300379 }
380
Andrey Andreev2f760872016-10-27 16:39:12 +0300381 // Yes, 4,5,6 are the only known possible values as of 2016-10-27
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300382 switch ($bits_per_character)
383 {
384 case 4:
Andrey Andreev2f760872016-10-27 16:39:12 +0300385 $this->_sid_regexp = '[0-9a-f]';
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300386 break;
387 case 5:
Andrey Andreev2f760872016-10-27 16:39:12 +0300388 $this->_sid_regexp = '[0-9a-v]';
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300389 break;
390 case 6:
Andrey Andreev2f760872016-10-27 16:39:12 +0300391 $this->_sid_regexp = '[0-9a-zA-Z,-]';
Andrey Andreev6c6ee1a2016-10-22 16:33:06 +0300392 break;
393 }
Andrey Andreev2f760872016-10-27 16:39:12 +0300394
395 $this->_sid_regexp .= '{'.$sid_length.'}';
Andrey Andreevdfb39be2014-10-06 01:50:14 +0300396 }
397
398 // ------------------------------------------------------------------------
399
400 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300401 * Handle temporary variables
402 *
403 * Clears old "flash" data, marks the new one for deletion and handles
404 * "temp" data deletion.
405 *
406 * @return void
407 */
408 protected function _ci_init_vars()
409 {
410 if ( ! empty($_SESSION['__ci_vars']))
411 {
412 $current_time = time();
413
414 foreach ($_SESSION['__ci_vars'] as $key => &$value)
415 {
416 if ($value === 'new')
417 {
418 $_SESSION['__ci_vars'][$key] = 'old';
419 }
420 // Hacky, but 'old' will (implicitly) always be less than time() ;)
421 // DO NOT move this above the 'new' check!
422 elseif ($value < $current_time)
423 {
424 unset($_SESSION[$key], $_SESSION['__ci_vars'][$key]);
425 }
426 }
427
428 if (empty($_SESSION['__ci_vars']))
429 {
430 unset($_SESSION['__ci_vars']);
Darren Hillc4e266b2011-08-30 15:40:27 -0400431 }
432 }
Andrey Andreevb4b215e2015-01-19 11:59:11 +0200433
434 $this->userdata =& $_SESSION;
Darren Hillc4e266b2011-08-30 15:40:27 -0400435 }
436
Andrey Andreev9ffcee62012-09-05 16:25:16 +0300437 // ------------------------------------------------------------------------
438
Darren Hillc4e266b2011-08-30 15:40:27 -0400439 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300440 * Mark as flash
441 *
442 * @param mixed $key Session data key(s)
443 * @return bool
444 */
445 public function mark_as_flash($key)
446 {
447 if (is_array($key))
448 {
449 for ($i = 0, $c = count($key); $i < $c; $i++)
450 {
451 if ( ! isset($_SESSION[$key[$i]]))
452 {
453 return FALSE;
454 }
455 }
456
457 $new = array_fill_keys($key, 'new');
458
459 $_SESSION['__ci_vars'] = isset($_SESSION['__ci_vars'])
460 ? array_merge($_SESSION['__ci_vars'], $new)
461 : $new;
462
463 return TRUE;
464 }
465
466 if ( ! isset($_SESSION[$key]))
467 {
468 return FALSE;
469 }
470
471 $_SESSION['__ci_vars'][$key] = 'new';
472 return TRUE;
473 }
474
475 // ------------------------------------------------------------------------
476
477 /**
478 * Get flash keys
479 *
480 * @return array
481 */
482 public function get_flash_keys()
483 {
484 if ( ! isset($_SESSION['__ci_vars']))
485 {
486 return array();
487 }
488
489 $keys = array();
490 foreach (array_keys($_SESSION['__ci_vars']) as $key)
491 {
492 is_int($_SESSION['__ci_vars'][$key]) OR $keys[] = $key;
493 }
494
495 return $keys;
496 }
497
498 // ------------------------------------------------------------------------
499
500 /**
501 * Unmark flash
502 *
503 * @param mixed $key Session data key(s)
504 * @return void
505 */
506 public function unmark_flash($key)
507 {
508 if (empty($_SESSION['__ci_vars']))
509 {
510 return;
511 }
512
513 is_array($key) OR $key = array($key);
514
515 foreach ($key as $k)
516 {
517 if (isset($_SESSION['__ci_vars'][$k]) && ! is_int($_SESSION['__ci_vars'][$k]))
518 {
519 unset($_SESSION['__ci_vars'][$k]);
520 }
521 }
522
523 if (empty($_SESSION['__ci_vars']))
524 {
525 unset($_SESSION['__ci_vars']);
526 }
527 }
528
529 // ------------------------------------------------------------------------
530
531 /**
532 * Mark as temp
533 *
534 * @param mixed $key Session data key(s)
535 * @param int $ttl Time-to-live in seconds
536 * @return bool
537 */
538 public function mark_as_temp($key, $ttl = 300)
539 {
540 $ttl += time();
541
542 if (is_array($key))
543 {
544 $temp = array();
545
546 foreach ($key as $k => $v)
547 {
548 // Do we have a key => ttl pair, or just a key?
549 if (is_int($k))
550 {
551 $k = $v;
552 $v = $ttl;
553 }
554 else
555 {
556 $v += time();
557 }
558
559 if ( ! isset($_SESSION[$k]))
560 {
561 return FALSE;
562 }
563
Andrey Andreev43df7bd2015-02-02 23:22:29 +0200564 $temp[$k] = $v;
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300565 }
566
567 $_SESSION['__ci_vars'] = isset($_SESSION['__ci_vars'])
568 ? array_merge($_SESSION['__ci_vars'], $temp)
569 : $temp;
570
571 return TRUE;
572 }
573
574 if ( ! isset($_SESSION[$key]))
575 {
576 return FALSE;
577 }
578
579 $_SESSION['__ci_vars'][$key] = $ttl;
580 return TRUE;
581 }
582
583 // ------------------------------------------------------------------------
584
585 /**
586 * Get temp keys
587 *
588 * @return array
589 */
590 public function get_temp_keys()
591 {
592 if ( ! isset($_SESSION['__ci_vars']))
593 {
594 return array();
595 }
596
597 $keys = array();
598 foreach (array_keys($_SESSION['__ci_vars']) as $key)
599 {
600 is_int($_SESSION['__ci_vars'][$key]) && $keys[] = $key;
601 }
602
603 return $keys;
604 }
605
606 // ------------------------------------------------------------------------
607
608 /**
609 * Unmark flash
610 *
611 * @param mixed $key Session data key(s)
612 * @return void
613 */
614 public function unmark_temp($key)
615 {
616 if (empty($_SESSION['__ci_vars']))
617 {
618 return;
619 }
620
621 is_array($key) OR $key = array($key);
622
623 foreach ($key as $k)
624 {
625 if (isset($_SESSION['__ci_vars'][$k]) && is_int($_SESSION['__ci_vars'][$k]))
626 {
627 unset($_SESSION['__ci_vars'][$k]);
628 }
629 }
630
631 if (empty($_SESSION['__ci_vars']))
632 {
633 unset($_SESSION['__ci_vars']);
634 }
635 }
636
637 // ------------------------------------------------------------------------
638
639 /**
640 * __get()
641 *
642 * @param string $key 'session_id' or a session data key
643 * @return mixed
644 */
645 public function __get($key)
646 {
647 // Note: Keep this order the same, just in case somebody wants to
648 // use 'session_id' as a session data key, for whatever reason
649 if (isset($_SESSION[$key]))
650 {
651 return $_SESSION[$key];
652 }
653 elseif ($key === 'session_id')
654 {
655 return session_id();
656 }
657
658 return NULL;
659 }
660
661 // ------------------------------------------------------------------------
662
663 /**
Andrey Andreev2c10f602016-03-15 14:39:02 +0200664 * __isset()
665 *
666 * @param string $key 'session_id' or a session data key
667 * @return bool
668 */
669 public function __isset($key)
670 {
671 if ($key === 'session_id')
672 {
673 return (session_status() === PHP_SESSION_ACTIVE);
674 }
675
676 return isset($_SESSION[$key]);
677 }
678
679 // ------------------------------------------------------------------------
680
681 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300682 * __set()
683 *
684 * @param string $key Session data key
685 * @param mixed $value Session data value
686 * @return void
687 */
688 public function __set($key, $value)
689 {
690 $_SESSION[$key] = $value;
691 }
692
693 // ------------------------------------------------------------------------
694
695 /**
696 * Session destroy
697 *
698 * Legacy CI_Session compatibility method
Darren Hillc4e266b2011-08-30 15:40:27 -0400699 *
Darren Hill5073a372011-08-31 13:54:19 -0400700 * @return void
Darren Hillc4e266b2011-08-30 15:40:27 -0400701 */
702 public function sess_destroy()
703 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300704 session_destroy();
Darren Hillc4e266b2011-08-30 15:40:27 -0400705 }
706
Andrey Andreev9ffcee62012-09-05 16:25:16 +0300707 // ------------------------------------------------------------------------
708
Darren Hillc4e266b2011-08-30 15:40:27 -0400709 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300710 * Session regenerate
Darren Hillc4e266b2011-08-30 15:40:27 -0400711 *
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300712 * Legacy CI_Session compatibility method
713 *
714 * @param bool $destroy Destroy old session data flag
Darren Hill5073a372011-08-31 13:54:19 -0400715 * @return void
Darren Hillc4e266b2011-08-30 15:40:27 -0400716 */
Andrey Andreev9ffcee62012-09-05 16:25:16 +0300717 public function sess_regenerate($destroy = FALSE)
Darren Hillc4e266b2011-08-30 15:40:27 -0400718 {
Andrey Andreev8e60b9a2014-11-04 11:08:06 +0200719 $_SESSION['__ci_last_regenerate'] = time();
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300720 session_regenerate_id($destroy);
Darren Hillc4e266b2011-08-30 15:40:27 -0400721 }
722
Andrey Andreev9ffcee62012-09-05 16:25:16 +0300723 // ------------------------------------------------------------------------
724
Darren Hillc4e266b2011-08-30 15:40:27 -0400725 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300726 * Get userdata reference
Darren Hillc4e266b2011-08-30 15:40:27 -0400727 *
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300728 * Legacy CI_Session compatibility method
729 *
730 * @returns array
Darren Hillc4e266b2011-08-30 15:40:27 -0400731 */
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300732 public function &get_userdata()
Darren Hillc4e266b2011-08-30 15:40:27 -0400733 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300734 return $_SESSION;
735 }
736
737 // ------------------------------------------------------------------------
738
739 /**
740 * Userdata (fetch)
741 *
742 * Legacy CI_Session compatibility method
743 *
744 * @param string $key Session data key
745 * @return mixed Session data value or NULL if not found
746 */
747 public function userdata($key = NULL)
748 {
749 if (isset($key))
Andrey Andreevecc260e2014-01-24 14:20:13 +0200750 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300751 return isset($_SESSION[$key]) ? $_SESSION[$key] : NULL;
752 }
753 elseif (empty($_SESSION))
754 {
755 return array();
Andrey Andreevecc260e2014-01-24 14:20:13 +0200756 }
757
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300758 $userdata = array();
759 $_exclude = array_merge(
Andrey Andreevef417862014-06-04 21:28:13 +0300760 array('__ci_vars'),
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300761 $this->get_flash_keys(),
762 $this->get_temp_keys()
763 );
Darren Hillc4e266b2011-08-30 15:40:27 -0400764
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300765 foreach (array_keys($_SESSION) as $key)
Darren Hillc4e266b2011-08-30 15:40:27 -0400766 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300767 if ( ! in_array($key, $_exclude, TRUE))
Darren Hillc4e266b2011-08-30 15:40:27 -0400768 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300769 $userdata[$key] = $_SESSION[$key];
Darren Hillc4e266b2011-08-30 15:40:27 -0400770 }
771 }
772
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300773 return $userdata;
Darren Hillc4e266b2011-08-30 15:40:27 -0400774 }
775
Andrey Andreev9ffcee62012-09-05 16:25:16 +0300776 // ------------------------------------------------------------------------
777
Darren Hillc4e266b2011-08-30 15:40:27 -0400778 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300779 * Set userdata
Darren Hillc4e266b2011-08-30 15:40:27 -0400780 *
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300781 * Legacy CI_Session compatibility method
782 *
783 * @param mixed $data Session data key or an associative array
784 * @param mixed $value Value to store
Darren Hill5073a372011-08-31 13:54:19 -0400785 * @return void
Darren Hillc4e266b2011-08-30 15:40:27 -0400786 */
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300787 public function set_userdata($data, $value = NULL)
Darren Hillc4e266b2011-08-30 15:40:27 -0400788 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300789 if (is_array($data))
Darren Hillc4e266b2011-08-30 15:40:27 -0400790 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300791 foreach ($data as $key => &$value)
Darren Hillc4e266b2011-08-30 15:40:27 -0400792 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300793 $_SESSION[$key] = $value;
Johnathan Croom8d8543d2012-11-25 10:36:57 -0700794 }
795
796 return;
Johnathan Croom4beca5c2012-11-23 18:32:46 -0700797 }
Darren Hillc4e266b2011-08-30 15:40:27 -0400798
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300799 $_SESSION[$data] = $value;
Darren Hillc4e266b2011-08-30 15:40:27 -0400800 }
801
Andrey Andreev9ffcee62012-09-05 16:25:16 +0300802 // ------------------------------------------------------------------------
803
Darren Hillc4e266b2011-08-30 15:40:27 -0400804 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300805 * Unset userdata
Darren Hillc4e266b2011-08-30 15:40:27 -0400806 *
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300807 * Legacy CI_Session compatibility method
808 *
Andrey Andreeve13fa9f2016-05-20 17:30:07 +0300809 * @param mixed $key Session data key(s)
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300810 * @return void
811 */
812 public function unset_userdata($key)
813 {
814 if (is_array($key))
815 {
816 foreach ($key as $k)
817 {
Andrey Andreevd069b9b2014-09-16 10:18:16 +0300818 unset($_SESSION[$k]);
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300819 }
820
821 return;
822 }
823
824 unset($_SESSION[$key]);
825 }
826
827 // ------------------------------------------------------------------------
828
829 /**
830 * All userdata (fetch)
831 *
832 * Legacy CI_Session compatibility method
833 *
834 * @return array $_SESSION, excluding flash data items
835 */
836 public function all_userdata()
837 {
838 return $this->userdata();
839 }
840
841 // ------------------------------------------------------------------------
842
843 /**
844 * Has userdata
845 *
846 * Legacy CI_Session compatibility method
847 *
848 * @param string $key Session data key
849 * @return bool
850 */
851 public function has_userdata($key)
852 {
853 return isset($_SESSION[$key]);
854 }
855
856 // ------------------------------------------------------------------------
857
858 /**
859 * Flashdata (fetch)
860 *
861 * Legacy CI_Session compatibility method
862 *
863 * @param string $key Session data key
864 * @return mixed Session data value or NULL if not found
Darren Hillc4e266b2011-08-30 15:40:27 -0400865 */
Andrey Andreevecc260e2014-01-24 14:20:13 +0200866 public function flashdata($key = NULL)
Darren Hillc4e266b2011-08-30 15:40:27 -0400867 {
Andrey Andreevecc260e2014-01-24 14:20:13 +0200868 if (isset($key))
869 {
Andrey Andreevef417862014-06-04 21:28:13 +0300870 return (isset($_SESSION['__ci_vars'], $_SESSION['__ci_vars'][$key], $_SESSION[$key]) && ! is_int($_SESSION['__ci_vars'][$key]))
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300871 ? $_SESSION[$key]
872 : NULL;
Andrey Andreevecc260e2014-01-24 14:20:13 +0200873 }
874
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300875 $flashdata = array();
876
Andrey Andreevef417862014-06-04 21:28:13 +0300877 if ( ! empty($_SESSION['__ci_vars']))
Andrey Andreevecc260e2014-01-24 14:20:13 +0200878 {
Andrey Andreevef417862014-06-04 21:28:13 +0300879 foreach ($_SESSION['__ci_vars'] as $key => &$value)
Andrey Andreevecc260e2014-01-24 14:20:13 +0200880 {
Andrey Andreevef417862014-06-04 21:28:13 +0300881 is_int($value) OR $flashdata[$key] = $_SESSION[$key];
Andrey Andreevecc260e2014-01-24 14:20:13 +0200882 }
883 }
884
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300885 return $flashdata;
Darren Hillc4e266b2011-08-30 15:40:27 -0400886 }
887
Andrey Andreev9ffcee62012-09-05 16:25:16 +0300888 // ------------------------------------------------------------------------
889
Darren Hillc4e266b2011-08-30 15:40:27 -0400890 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300891 * Set flashdata
Darren Hillc4e266b2011-08-30 15:40:27 -0400892 *
Calvin Tam55bc5052015-07-24 02:27:24 -0700893 * Legacy CI_Session compatibility method
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300894 *
895 * @param mixed $data Session data key or an associative array
896 * @param mixed $value Value to store
Darren Hill5073a372011-08-31 13:54:19 -0400897 * @return void
Darren Hillc4e266b2011-08-30 15:40:27 -0400898 */
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300899 public function set_flashdata($data, $value = NULL)
Darren Hillc4e266b2011-08-30 15:40:27 -0400900 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300901 $this->set_userdata($data, $value);
Andrey Andreevc6e50982014-10-26 21:27:28 +0200902 $this->mark_as_flash(is_array($data) ? array_keys($data) : $data);
Darren Hillc4e266b2011-08-30 15:40:27 -0400903 }
904
Andrey Andreev9ffcee62012-09-05 16:25:16 +0300905 // ------------------------------------------------------------------------
906
Darren Hillc4e266b2011-08-30 15:40:27 -0400907 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300908 * Keep flashdata
Darren Hillc4e266b2011-08-30 15:40:27 -0400909 *
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300910 * Legacy CI_Session compatibility method
911 *
912 * @param mixed $key Session data key(s)
Darren Hill5073a372011-08-31 13:54:19 -0400913 * @return void
Darren Hillc4e266b2011-08-30 15:40:27 -0400914 */
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300915 public function keep_flashdata($key)
Darren Hillc4e266b2011-08-30 15:40:27 -0400916 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300917 $this->mark_as_flash($key);
Darren Hillc4e266b2011-08-30 15:40:27 -0400918 }
919
Andrey Andreev9ffcee62012-09-05 16:25:16 +0300920 // ------------------------------------------------------------------------
921
Darren Hillc4e266b2011-08-30 15:40:27 -0400922 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300923 * Temp data (fetch)
Darren Hillc4e266b2011-08-30 15:40:27 -0400924 *
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300925 * Legacy CI_Session compatibility method
926 *
927 * @param string $key Session data key
928 * @return mixed Session data value or NULL if not found
Darren Hillc4e266b2011-08-30 15:40:27 -0400929 */
Andrey Andreevecc260e2014-01-24 14:20:13 +0200930 public function tempdata($key = NULL)
Darren Hillc4e266b2011-08-30 15:40:27 -0400931 {
Andrey Andreevecc260e2014-01-24 14:20:13 +0200932 if (isset($key))
933 {
Andrey Andreevef417862014-06-04 21:28:13 +0300934 return (isset($_SESSION['__ci_vars'], $_SESSION['__ci_vars'][$key], $_SESSION[$key]) && is_int($_SESSION['__ci_vars'][$key]))
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300935 ? $_SESSION[$key]
936 : NULL;
Andrey Andreevecc260e2014-01-24 14:20:13 +0200937 }
938
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300939 $tempdata = array();
940
Andrey Andreevef417862014-06-04 21:28:13 +0300941 if ( ! empty($_SESSION['__ci_vars']))
Andrey Andreevecc260e2014-01-24 14:20:13 +0200942 {
Andrey Andreevef417862014-06-04 21:28:13 +0300943 foreach ($_SESSION['__ci_vars'] as $key => &$value)
Andrey Andreevecc260e2014-01-24 14:20:13 +0200944 {
Andrey Andreevef417862014-06-04 21:28:13 +0300945 is_int($value) && $tempdata[$key] = $_SESSION[$key];
Andrey Andreevecc260e2014-01-24 14:20:13 +0200946 }
947 }
948
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300949 return $tempdata;
Darren Hillc4e266b2011-08-30 15:40:27 -0400950 }
951
Andrey Andreev9ffcee62012-09-05 16:25:16 +0300952 // ------------------------------------------------------------------------
953
Darren Hillc4e266b2011-08-30 15:40:27 -0400954 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300955 * Set tempdata
Darren Hillc4e266b2011-08-30 15:40:27 -0400956 *
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300957 * Legacy CI_Session compatibility method
958 *
959 * @param mixed $data Session data key or an associative array of items
960 * @param mixed $value Value to store
961 * @param int $ttl Time-to-live in seconds
Darren Hillc4e266b2011-08-30 15:40:27 -0400962 * @return void
963 */
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300964 public function set_tempdata($data, $value = NULL, $ttl = 300)
Darren Hillc4e266b2011-08-30 15:40:27 -0400965 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300966 $this->set_userdata($data, $value);
Andrey Andreevfd310572015-03-30 17:19:26 +0300967 $this->mark_as_temp(is_array($data) ? array_keys($data) : $data, $ttl);
Darren Hillc4e266b2011-08-30 15:40:27 -0400968 }
969
Andrey Andreev9ffcee62012-09-05 16:25:16 +0300970 // ------------------------------------------------------------------------
971
Darren Hillc4e266b2011-08-30 15:40:27 -0400972 /**
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300973 * Unset tempdata
Darren Hillc4e266b2011-08-30 15:40:27 -0400974 *
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300975 * Legacy CI_Session compatibility method
976 *
977 * @param mixed $data Session data key(s)
Darren Hillc4e266b2011-08-30 15:40:27 -0400978 * @return void
979 */
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300980 public function unset_tempdata($key)
Darren Hillc4e266b2011-08-30 15:40:27 -0400981 {
Andrey Andreev47a47fb2014-05-31 16:08:30 +0300982 $this->unmark_temp($key);
Darren Hillc4e266b2011-08-30 15:40:27 -0400983 }
984
Andrey Andreev9ffcee62012-09-05 16:25:16 +0300985}