Session::guest() - Code Metrics - Inspection of "System now knows which classes store state that ch..." - nazar-pc/CleverStyle-Framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b7b84b...78616b )

by Nazar

created 2016-03-23 01:56 UTC

Session::guest() A

↳ Parent: Session

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	3
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * @package   CleverStyle CMS
 * @author    Nazar Mokrynskyi <[email protected]>
 * @copyright Copyright (c) 2011-2016, Nazar Mokrynskyi
 * @license   MIT License, see license.txt
 */
/**
 * Provides next events:
 *
 *  System/Session/init/before
 *
 *  System/Session/init/after
 *
 *  System/Session/load
 *  ['session_data' => $session_data]
 *
 *  System/Session/add
 *  ['session_data' => $session_data]
 *
 *  System/Session/del/before
 *  ['id' => $session_id]
 *
 *  System/Session/del/after
 *  ['id' => $session_id]
 *
 *  System/Session/del_all
 *  ['id' => $user_id]
 */
namespace cs;
use
	cs\Language\Prefix as Language_prefix,
	cs\Cache\Prefix as Cache_prefix;

/**
 * Class responsible for current user session
 */
class Session {
	use
		CRUD,
		Singleton;
	const INIT_STATE_METHOD          = 'init';
	const INITIAL_SESSION_EXPIRATION = 300;
	/**
	 * Id of current session
	 *
	 * @var false|string
	 */
	protected $session_id;
	/**
	 * User id of current session
	 *
	 * @var int
	 */
	protected $user_id;
	/**
	 * @var bool
	 */
	protected $is_admin;
	/**
	 * @var bool
	 */
	protected $is_user;
	/**
	 * @var bool
	 */
	protected $is_bot;
	/**
	 * @var bool
	 */
	protected $is_guest;
	/**
	 * @var Cache_prefix
	 */
	protected $cache;
	/**
	 * @var Cache_prefix
	 */
	protected $users_cache;
	protected $data_model = [
		'id'          => 'text',
		'user'        => 'int:0',
		'created'     => 'int:0',
		'expire'      => 'int:0',
		'user_agent'  => 'text',
		'remote_addr' => 'text',
		'ip'          => 'text',
		'data'        => 'json'
	];
	protected $table      = '[prefix]sessions';
	/**
	 * Returns database index
	 *
	 * @return int
	 */
	protected function cdb () {
		return Config::instance()->module('System')->db('users');
	}
	/**
	 * Use cookie as source of session id, load session
	 *
	 * Bots detection is also done here
	 */
	protected function init () {
		if (!$this->cache) {
			$this->cache       = new Cache_prefix('sessions');
			$this->users_cache = new Cache_prefix('users');
		}
		$this->user_id    = User::GUEST_ID;
		$this->session_id = null;
		Event::instance()->fire('System/Session/init/before');
		$Request = Request::instance();
		/**
		 * If session exists
		 */
		if ($Request->cookie('session')) {
			$this->user_id = $this->load();
		} elseif (!$Request->api_path) {
			/**
			 * Try to detect bot, not necessary for API request
			 */
			$this->bots_detection();
		}
		$this->update_user_is();
		Event::instance()->fire('System/Session/init/after');
	}
	/**
	 * Try to determine whether visitor is a known bot, bots have no sessions
	 */
	protected function bots_detection () {
		$Cache   = $this->users_cache;
		$Request = Request::instance();
		/**
		 * For bots: login is user agent, email is IP
		 */
		$login    = $Request->header('user-agent');
		$email    = $Request->ip;
		$bot_hash = hash('sha224', $login.$email);
		/**
		 * If bot is cached
		 */
		$bot_id = $Cache->$bot_hash;
		/**
		 * If bot found in cache - exit from here
		 */
		if ($bot_id) {
			$this->user_id = $bot_id;
			return;
		}
		/**
		 * Try to find bot among known bots
		 */
		foreach ($this->all_bots() as $bot) {
			if ($this->is_this_bot($bot, $login, $email)) {
				/**
				 * If bot found - save it in cache
				 */
				$this->user_id    = $bot['id'];
				$Cache->$bot_hash = $bot['id'];
				return;
			}
		}
	}
	/**
	 * Get list of all bots
	 *
	 * @return array
	 */
	protected function all_bots () {
		return $this->users_cache->get(
			'bots',
			function () {
				return $this->db()->qfa(
					[
						"SELECT
							`u`.`id`,
							`u`.`login`,
							`u`.`email`
						FROM `[prefix]users` AS `u`
							INNER JOIN `[prefix]users_groups` AS `g`
						ON `u`.`id` = `g`.`id`
						WHERE
							`g`.`group`		= '%s' AND
							`u`.`status`	= '%s'",
						User::BOT_GROUP_ID,
						User::STATUS_ACTIVE
					]
				) ?: [];
			}
		) ?: [];
	}
	/**
	 * Check whether user agent and IP (login and email for bots) corresponds to passed bot data
	 *
	 * @param array  $bot
	 * @param string $login
	 * @param string $email
	 *
	 * @return bool
	 */
	protected function is_this_bot ($bot, $login, $email) {
		return
			(
				$bot['login'] &&
				(
					strpos($login, $bot['login']) !== false ||
					_preg_match($bot['login'], $login)
				)
			) ||
			(
				$bot['email'] &&
				(
					$email === $bot['email'] ||
					_preg_match($bot['email'], $email)
				)
			);
	}
	/**
	 * Updates information about who is user accessed by methods ::guest() ::bot() ::user() admin()
	 */
	protected function update_user_is () {
		$this->is_guest = false;
		$this->is_bot   = false;
		$this->is_user  = false;
		$this->is_admin = false;
		if ($this->user_id == User::GUEST_ID) {
			$this->is_guest = true;
			return;
		}
		/**
		 * Checking of user type
		 */
		$groups = User::instance()->get_groups($this->user_id) ?: [];
		if (in_array(User::ADMIN_GROUP_ID, $groups)) {
			$this->is_admin = true;
			$this->is_user  = true;
		} elseif (in_array(User::USER_GROUP_ID, $groups)) {
			$this->is_user = true;
		} elseif (in_array(User::BOT_GROUP_ID, $groups)) {
			$this->is_guest = true;
			$this->is_bot   = true;
		}
	}
	/**
	 * Is admin
	 *
	 * @return bool
	 */
	function admin () {
		return $this->is_admin;
	}
	/**
	 * Is user
	 *
	 * @return bool
	 */
	function user () {
		return $this->is_user;
	}
	/**
	 * Is guest
	 *
	 * @return bool
	 */
	function guest () {
		return $this->is_guest;
	}
	/**
	 * Is bot
	 *
	 * @return bool
	 */
	function bot () {
		return $this->is_bot;
	}
	/**
	 * Returns id of current session
	 *
	 * @return false|string
	 */
	function get_id () {
		if ($this->user_id == User::GUEST_ID && $this->bot()) {
			return false;
		}
		return $this->session_id ?: false;
	}
	/**
	 * Returns user id of current session
	 *
	 * @return int
	 */
	function get_user () {
		return $this->user_id;
	}
	/**
	 * Returns session details by session id
	 *
	 * @param false|null|string $session_id If `null` - loaded from `$this->session_id`, and if that also empty - from cookies
	 *
	 * @return false|array
	 */
	function get ($session_id) {
		$session_data = $this->get_internal($session_id);
		if ($session_data) {
			unset($session_data['data']);
		}
		return $session_data;
	}
	/**
	 * @param false|null|string $session_id
	 *
	 * @return false|array
	 */
	protected function get_internal ($session_id) {
		if (!$session_id) {
			if (!$this->session_id) {
				$this->session_id = Request::instance()->cookie('session');
			}
			$session_id = $this->session_id;
		}
		if (!is_md5($session_id)) {
			return false;
		}
		$data = $this->cache->get(
			$session_id,
			function () use ($session_id) {
				$data = $this->read($session_id);
				if (!$data || $data['expire'] <= time()) {
					return false;
				}
				$data['data'] = $data['data'] ?: [];
				return $data;
			}
		);
		return $this->is_good_session($data) ? $data : false;
	}
	/**
	 * Check whether session was not expired, user agent and IP corresponds to what is expected and user is actually active
	 *
	 * @param mixed $session_data
	 *
	 * @return bool
	 */
	protected function is_good_session ($session_data) {
		return
			isset($session_data['expire'], $session_data['user']) &&
			$session_data['expire'] > time() &&
			$this->is_user_active($session_data['user']);
	}
	/**
	 * Whether session data belongs to current visitor (user agent, remote addr and ip check)
	 *
	 * @param string $session_id
	 * @param string $user_agent
	 * @param string $remote_addr
	 * @param string $ip
	 *
	 * @return bool
	 */
	function is_session_owner ($session_id, $user_agent, $remote_addr, $ip) {
		$session_data = $this->get($session_id);
		return $session_data ? $this->is_session_owner_internal($session_data, $user_agent, $remote_addr, $ip) : false;
	}
	/**
	 * Whether session data belongs to current visitor (user agent, remote addr and ip check)
	 *
	 * @param array       $session_data
	 * @param string|null $user_agent
	 * @param string|null $remote_addr
	 * @param string|null $ip
	 *
	 * @return bool
	 */
	protected function is_session_owner_internal ($session_data, $user_agent = null, $remote_addr = null, $ip = null) {
		/**
		 * md5() as protection against timing attacks
		 */
		if ($user_agent === null && $remote_addr === null && $ip === null) {
			$Request     = Request::instance();
			$user_agent  = $Request->header('user-agent');
			$remote_addr = $Request->remote_addr;
			$ip          = $Request->ip;
		}
		return
			md5($session_data['user_agent']) == md5($user_agent) &&
			(
				!Config::instance()->core['remember_user_ip'] ||
				(
					md5($session_data['remote_addr']) == md5(ip2hex($remote_addr)) &&
					md5($session_data['ip']) == md5(ip2hex($ip))
				)
			);
	}
	/**
	 * Load session by id and return id of session owner (user), update session expiration
	 *
	 * @param false|null|string $session_id If not specified - loaded from `$this->session_id`, and if that also empty - from cookies
	 *
	 * @return int User id
	 */
	function load ($session_id = null) {
		if ($this->user_id == User::GUEST_ID && $this->bot()) {
			return User::GUEST_ID;
		}
		$session_data = $this->get_internal($session_id);
		if (!$session_data || !$this->is_session_owner_internal($session_data)) {
			$this->add(User::GUEST_ID);
			return User::GUEST_ID;
		}
		/**
		 * Updating last online time and ip
		 */
		$Config = Config::instance();
		$time   = time();
		if ($session_data['expire'] - $time < $Config->core['session_expire'] * $Config->core['update_ratio'] / 100) {
			$session_data['expire'] = $time + $Config->core['session_expire'];
			$this->update($session_data);
			$this->cache->set($session_data['id'], $session_data);
		}
		unset($session_data['data']);
		Event::instance()->fire(
			'System/Session/load',
			[
				'session_data' => $session_data
			]
		);
		return $this->load_initialization($session_data['id'], $session_data['user']);
	}
	/**
	 * Initialize session (set user id, session id and update who user is)
	 *
	 * @param string $session_id
	 * @param int    $user_id
	 *
	 * @return int User id
	 */
	protected function load_initialization ($session_id, $user_id) {
		$this->session_id = $session_id;
		$this->user_id    = $user_id;
		$this->update_user_is();
		return $user_id;
	}
	/**
	 * Whether profile is activated, not disabled and not blocked
	 *
	 * @param int $user
	 *
	 * @return bool
	 */
	protected function is_user_active ($user) {
		/**
		 * Optimization, more data requested than actually used here, because data will be requested later, and it would be nice to have that data cached
		 */
		$data = User::instance()->get(
			[
				'login',
				'username',
				'language',
				'timezone',
				'status',
				'block_until',
				'avatar'
			],
			$user
		);
		if (!$data) {
			return false;
		}
		$L    = new Language_prefix('system_profile_sign_in_');
		$Page = Page::instance();
		switch ($data['status']) {
			case User::STATUS_INACTIVE:
				/**
				 * If user is disabled
				 */
				$Page->warning($L->your_account_disabled);
				return false;
			case User::STATUS_NOT_ACTIVATED:
				/**
				 * If user is not active
				 */
				$Page->warning($L->your_account_is_not_active);
				return false;
		}
		if ($data['block_until'] > time()) {
			/**
			 * If user if blocked
			 */
			$Page->warning($L->your_account_blocked_until(date($L->_datetime, $data['block_until'])));
			return false;
		}
		return true;
	}
	/**
	 * Create the session for the user with specified id
	 *
	 * @param int  $user
	 * @param bool $delete_current_session
	 *
	 * @return false|string Session id on success, `false` otherwise
	 */
	function add ($user, $delete_current_session = true) {
		$user = (int)$user;
		if (!$user) {
			return false;
		}
		if ($delete_current_session && is_md5($this->session_id)) {
			$this->del_internal($this->session_id, false);
		}
		if (!$this->is_user_active($user)) {
			/**
			 * If data was not loaded or account is not active - create guest session
			 */
			return $this->add(User::GUEST_ID);
		}
		$session_data = $this->create_unique_session($user);
		Response::instance()->cookie('session', $session_data['id'], $session_data['expire'], true);
		$this->load_initialization($session_data['id'], $session_data['user']);
		/**
		 * Delete old sessions using probability and system configuration of inserts limits and update ratio
		 */
		$Config = Config::instance();
		if (mt_rand(0, $Config->core['inserts_limit']) < $Config->core['inserts_limit'] / 100 * (100 - $Config->core['update_ratio']) / 5) {
			$this->delete_old_sessions();
		}
		Event::instance()->fire(
			'System/Session/add',
			[
				'session_data' => $session_data
			]
		);
		return $session_data['id'];
	}
	/**
	 * @param int $user
	 *
	 * @return array Session data
	 */
	protected function create_unique_session ($user) {
		$Config      = Config::instance();
		$Request     = Request::instance();
		$remote_addr = ip2hex($Request->remote_addr);
		$ip          = ip2hex($Request->ip);
		/**
		 * Many guests open only one page (or do not store any cookies), so create guest session only for 5 minutes max initially
		 */
		$expire_in = $user == User::GUEST_ID ? min($Config->core['session_expire'], self::INITIAL_SESSION_EXPIRATION) : $Config->core['session_expire'];
		$expire    = time() + $expire_in;
		/**
		 * Create unique session
		 */
		$session_data = [
			'id'          => null,
			'user'        => $user,
			'created'     => time(),
			'expire'      => $expire,
			'user_agent'  => $Request->header('user-agent'),
			'remote_addr' => $remote_addr,
			'ip'          => $ip,
			'data'        => []
		];
		do {
			$session_data['id'] = md5(random_bytes(1000));
		} while (!$this->create($session_data));
		return $session_data;
	}
	/**
	 * Destroying of the session
	 *
	 * @param null|string $session_id
	 *
	 * @return bool
	 */
	function del ($session_id = null) {
		return (bool)$this->del_internal($session_id);
	}
	/**
	 * Deletion of the session
	 *
	 * @param string|null $session_id
	 * @param bool        $create_guest_session
	 *
	 * @return bool
	 */
	protected function del_internal ($session_id = null, $create_guest_session = true) {
		$session_id = $session_id ?: $this->session_id;
		if (!is_md5($session_id)) {
			return false;
		}
		Event::instance()->fire(
			'System/Session/del/before',
			[
				'id' => $session_id
			]
		);
		unset($this->cache->$session_id);
		$this->session_id = false;
		Response::instance()->cookie('session', '');
		$result = $this->delete($session_id);
		if ($result) {
			if ($create_guest_session) {
				return (bool)$this->add(User::GUEST_ID);
			}
			Event::instance()->fire(
				'System/Session/del/after',
				[
					'id' => $session_id
				]
			);
		}
		return (bool)$result;
	}
	/**
	 * Delete all old sessions from DB
	 */
	protected function delete_old_sessions () {
		$this->db_prime()->aq(
			"DELETE FROM `[prefix]sessions`
			WHERE `expire` < ".time()
		);
	}
	/**
	 * Deletion of all user sessions
	 *
	 * @param false|int $user If not specified - current user assumed
	 *
	 * @return bool
	 */
	function del_all ($user = false) {
		$user = $user ?: $this->user_id;
		Event::instance()->fire(
			'System/Session/del_all',
			[
				'id' => $user
			]
		);
		$sessions = $this->db_prime()->qfas(
			"SELECT `id`
			FROM `[prefix]sessions`
			WHERE `user` = '$user'"
		);
		if (is_array($sessions)) {
			if (!$this->delete($sessions)) {
				return false;
			}
			foreach ($sessions as $session) {
				unset($this->cache->$session);
			}
		}
		return true;
	}
	/**
	 * Get data, stored with session
	 *
	 * @param string      $item
	 * @param null|string $session_id
	 *
	 * @return false|mixed
	 *
	 */
	function get_data ($item, $session_id = null) {
		$session_data = $this->get_data_internal($session_id);
		return isset($session_data['data'][$item]) ? $session_data['data'][$item] : false;
	}
	/*
	 * @param null|string $session_id
	 *
	 * @return array|false
	 */
	protected function get_data_internal ($session_id) {
		$session_id = $session_id ?: $this->session_id;
		return is_md5($session_id) ? $this->get_internal($session_id) : false;
	}
	/**
	 * Store data with session
	 *
	 * @param string      $item
	 * @param mixed       $value
	 * @param null|string $session_id
	 *
	 * @return bool
	 *
	 */
	function set_data ($item, $value, $session_id = null) {
		$session_data = $this->get_data_internal($session_id);
		/**
		 * If there is no session yet - let's create one
		 */
		if (!$session_data) {
			$session_id   = $this->add(User::GUEST_ID);
			$session_data = $this->get_data_internal($session_id);
		}
		if (!isset($session_data['data'])) {
			return false;
		}
		$session_data['data'][$item] = $value;
		return $this->update($session_data) && $this->cache->del($session_id);
	}
	/**
	 * Delete data, stored with session
	 *
	 * @param string      $item
	 * @param null|string $session_id
	 *
	 * @return bool
	 *
	 */
	function del_data ($item, $session_id = null) {
		$session_data = $this->get_data_internal($session_id);
		if (!isset($session_data['data'][$item])) {
			return true;
		}
		return $this->update($session_data) && $this->cache->del($session_id);
	}
}


1			<?php
2			/**
3			* @package CleverStyle CMS
4			* @author Nazar Mokrynskyi <[email protected]>
5			* @copyright Copyright (c) 2011-2016, Nazar Mokrynskyi
6			* @license MIT License, see license.txt
7			*/
8			/**
9			* Provides next events:
10			*
11			* System/Session/init/before
12			*
13			* System/Session/init/after
14			*
15			* System/Session/load
16			* ['session_data' => $session_data]
17			*
18			* System/Session/add
19			* ['session_data' => $session_data]
20			*
21			* System/Session/del/before
22			* ['id' => $session_id]
23			*
24			* System/Session/del/after
25			* ['id' => $session_id]
26			*
27			* System/Session/del_all
28			* ['id' => $user_id]
29			*/
30			namespace cs;
31			use
32			cs\Language\Prefix as Language_prefix,
33			cs\Cache\Prefix as Cache_prefix;
34
35			/**
36			* Class responsible for current user session
37			*/
38			class Session {
39			use
40			CRUD,
41			Singleton;
42			const INIT_STATE_METHOD = 'init';
43			const INITIAL_SESSION_EXPIRATION = 300;
44			/**
45			* Id of current session
46			*
47			* @var false\|string
48			*/
49			protected $session_id;
50			/**
51			* User id of current session
52			*
53			* @var int
54			*/
55			protected $user_id;
56			/**
57			* @var bool
58			*/
59			protected $is_admin;
60			/**
61			* @var bool
62			*/
63			protected $is_user;
64			/**
65			* @var bool
66			*/
67			protected $is_bot;
68			/**
69			* @var bool
70			*/
71			protected $is_guest;
72			/**
73			* @var Cache_prefix
74			*/
75			protected $cache;
76			/**
77			* @var Cache_prefix
78			*/
79			protected $users_cache;
80			protected $data_model = [
81			'id' => 'text',
82			'user' => 'int:0',
83			'created' => 'int:0',
84			'expire' => 'int:0',
85			'user_agent' => 'text',
86			'remote_addr' => 'text',
87			'ip' => 'text',
88			'data' => 'json'
89			];
90			protected $table = '[prefix]sessions';
91			/**
92			* Returns database index
93			*
94			* @return int
95			*/
96			protected function cdb () {
97			return Config::instance()->module('System')->db('users');
98			}
99			/**
100			* Use cookie as source of session id, load session
101			*
102			* Bots detection is also done here
103			*/
104			protected function init () {
105			if (!$this->cache) {
106			$this->cache = new Cache_prefix('sessions');
107			$this->users_cache = new Cache_prefix('users');
108			}
109			$this->user_id = User::GUEST_ID;
110			$this->session_id = null;
111			Event::instance()->fire('System/Session/init/before');
112			$Request = Request::instance();
113			/**
114			* If session exists
115			*/
116			if ($Request->cookie('session')) {
117			$this->user_id = $this->load();
118			} elseif (!$Request->api_path) {
119			/**
120			* Try to detect bot, not necessary for API request
121			*/
122			$this->bots_detection();
123			}
124			$this->update_user_is();
125			Event::instance()->fire('System/Session/init/after');
126			}
127			/**
128			* Try to determine whether visitor is a known bot, bots have no sessions
129			*/
130			protected function bots_detection () {
131			$Cache = $this->users_cache;
132			$Request = Request::instance();
133			/**
134			* For bots: login is user agent, email is IP
135			*/
136			$login = $Request->header('user-agent');
137			$email = $Request->ip;
138			$bot_hash = hash('sha224', $login.$email);
139			/**
140			* If bot is cached
141			*/
142			$bot_id = $Cache->$bot_hash;
143			/**
144			* If bot found in cache - exit from here
145			*/
146			if ($bot_id) {
147			$this->user_id = $bot_id;
148			return;
149			}
150			/**
151			* Try to find bot among known bots
152			*/
153			foreach ($this->all_bots() as $bot) {
154			if ($this->is_this_bot($bot, $login, $email)) {
155			/**
156			* If bot found - save it in cache
157			*/
158			$this->user_id = $bot['id'];
159			$Cache->$bot_hash = $bot['id'];
160			return;
161			}
162			}
163			}
164			/**
165			* Get list of all bots
166			*
167			* @return array
168			*/
169			protected function all_bots () {
170			return $this->users_cache->get(
171			'bots',
172			function () {
173			return $this->db()->qfa(
174			[
175			"SELECT
176			`u`.`id`,
177			`u`.`login`,
178			`u`.`email`
179			FROM `[prefix]users` AS `u`
180			INNER JOIN `[prefix]users_groups` AS `g`
181			ON `u`.`id` = `g`.`id`
182			WHERE
183			`g`.`group` = '%s' AND
184			`u`.`status` = '%s'",
185			User::BOT_GROUP_ID,
186			User::STATUS_ACTIVE
187			]
188			) ?: [];
189			}
190			) ?: [];
191			}
192			/**
193			* Check whether user agent and IP (login and email for bots) corresponds to passed bot data
194			*
195			* @param array $bot
196			* @param string $login
197			* @param string $email
198			*
199			* @return bool
200			*/
201			protected function is_this_bot ($bot, $login, $email) {
202			return
203			(
204			$bot['login'] &&
205			(
206			strpos($login, $bot['login']) !== false \|\|
207			_preg_match($bot['login'], $login)
208			)
209			) \|\|
210			(
211			$bot['email'] &&
212			(
213			$email === $bot['email'] \|\|
214			_preg_match($bot['email'], $email)
215			)
216			);
217			}
218			/**
219			* Updates information about who is user accessed by methods ::guest() ::bot() ::user() admin()
220			*/
221			protected function update_user_is () {
222			$this->is_guest = false;
223			$this->is_bot = false;
224			$this->is_user = false;
225			$this->is_admin = false;
226			if ($this->user_id == User::GUEST_ID) {
227			$this->is_guest = true;
228			return;
229			}
230			/**
231			* Checking of user type
232			*/
233			$groups = User::instance()->get_groups($this->user_id) ?: [];
234			if (in_array(User::ADMIN_GROUP_ID, $groups)) {
235			$this->is_admin = true;
236			$this->is_user = true;
237			} elseif (in_array(User::USER_GROUP_ID, $groups)) {
238			$this->is_user = true;
239			} elseif (in_array(User::BOT_GROUP_ID, $groups)) {
240			$this->is_guest = true;
241			$this->is_bot = true;
242			}
243			}
244			/**
245			* Is admin
246			*
247			* @return bool
248			*/
249			function admin () {
250			return $this->is_admin;
251			}
252			/**
253			* Is user
254			*
255			* @return bool
256			*/
257			function user () {
258			return $this->is_user;
259			}
260			/**
261			* Is guest
262			*
263			* @return bool
264			*/
265			function guest () {
266			return $this->is_guest;
267			}
268			/**
269			* Is bot
270			*
271			* @return bool
272			*/
273			function bot () {
274			return $this->is_bot;
275			}
276			/**
277			* Returns id of current session
278			*
279			* @return false\|string
280			*/
281			function get_id () {
282			if ($this->user_id == User::GUEST_ID && $this->bot()) {
283			return false;
284			}
285			return $this->session_id ?: false;
286			}
287			/**
288			* Returns user id of current session
289			*
290			* @return int
291			*/
292			function get_user () {
293			return $this->user_id;
294			}
295			/**
296			* Returns session details by session id
297			*
298			* @param false\|null\|string $session_id If `null` - loaded from `$this->session_id`, and if that also empty - from cookies
299			*
300			* @return false\|array
301			*/
302			function get ($session_id) {
303			$session_data = $this->get_internal($session_id);
304			if ($session_data) {
305			unset($session_data['data']);
306			}
307			return $session_data;
308			}
309			/**
310			* @param false\|null\|string $session_id
311			*
312			* @return false\|array
313			*/
314			protected function get_internal ($session_id) {
315			if (!$session_id) {
316			if (!$this->session_id) {
317			$this->session_id = Request::instance()->cookie('session');
318			}
319			$session_id = $this->session_id;
320			}
321			if (!is_md5($session_id)) {
322			return false;
323			}
324			$data = $this->cache->get(
325			$session_id,
326			function () use ($session_id) {
327			$data = $this->read($session_id);
328			if (!$data \|\| $data['expire'] <= time()) {
329			return false;
330			}
331			$data['data'] = $data['data'] ?: [];
332			return $data;
333			}
334			);
335			return $this->is_good_session($data) ? $data : false;
336			}
337			/**
338			* Check whether session was not expired, user agent and IP corresponds to what is expected and user is actually active
339			*
340			* @param mixed $session_data
341			*
342			* @return bool
343			*/
344			protected function is_good_session ($session_data) {
345			return
346			isset($session_data['expire'], $session_data['user']) &&
347			$session_data['expire'] > time() &&
348			$this->is_user_active($session_data['user']);
349			}
350			/**
351			* Whether session data belongs to current visitor (user agent, remote addr and ip check)
352			*
353			* @param string $session_id
354			* @param string $user_agent
355			* @param string $remote_addr
356			* @param string $ip
357			*
358			* @return bool
359			*/
360			function is_session_owner ($session_id, $user_agent, $remote_addr, $ip) {
361			$session_data = $this->get($session_id);
362			return $session_data ? $this->is_session_owner_internal($session_data, $user_agent, $remote_addr, $ip) : false;
363			}
364			/**
365			* Whether session data belongs to current visitor (user agent, remote addr and ip check)
366			*
367			* @param array $session_data
368			* @param string\|null $user_agent
369			* @param string\|null $remote_addr
370			* @param string\|null $ip
371			*
372			* @return bool
373			*/
374			protected function is_session_owner_internal ($session_data, $user_agent = null, $remote_addr = null, $ip = null) {
375			/**
376			* md5() as protection against timing attacks
377			*/
378			if ($user_agent === null && $remote_addr === null && $ip === null) {
379			$Request = Request::instance();
380			$user_agent = $Request->header('user-agent');
381			$remote_addr = $Request->remote_addr;
382			$ip = $Request->ip;
383			}
384			return
385			md5($session_data['user_agent']) == md5($user_agent) &&
386			(
387			!Config::instance()->core['remember_user_ip'] \|\|
388			(
389			md5($session_data['remote_addr']) == md5(ip2hex($remote_addr)) &&
390			md5($session_data['ip']) == md5(ip2hex($ip))
391			)
392			);
393			}
394			/**
395			* Load session by id and return id of session owner (user), update session expiration
396			*
397			* @param false\|null\|string $session_id If not specified - loaded from `$this->session_id`, and if that also empty - from cookies
398			*
399			* @return int User id
400			*/
401			function load ($session_id = null) {
402			if ($this->user_id == User::GUEST_ID && $this->bot()) {
403			return User::GUEST_ID;
404			}
405			$session_data = $this->get_internal($session_id);
406			if (!$session_data \|\| !$this->is_session_owner_internal($session_data)) {
407			$this->add(User::GUEST_ID);
408			return User::GUEST_ID;
409			}
410			/**
411			* Updating last online time and ip
412			*/
413			$Config = Config::instance();
414			$time = time();
415			if ($session_data['expire'] - $time < $Config->core['session_expire'] * $Config->core['update_ratio'] / 100) {
416			$session_data['expire'] = $time + $Config->core['session_expire'];
417			$this->update($session_data);
418			$this->cache->set($session_data['id'], $session_data);
419			}
420			unset($session_data['data']);
421			Event::instance()->fire(
422			'System/Session/load',
423			[
424			'session_data' => $session_data
425			]
426			);
427			return $this->load_initialization($session_data['id'], $session_data['user']);
428			}
429			/**
430			* Initialize session (set user id, session id and update who user is)
431			*
432			* @param string $session_id
433			* @param int $user_id
434			*
435			* @return int User id
436			*/
437			protected function load_initialization ($session_id, $user_id) {
438			$this->session_id = $session_id;
439			$this->user_id = $user_id;
440			$this->update_user_is();
441			return $user_id;
442			}
443			/**
444			* Whether profile is activated, not disabled and not blocked
445			*
446			* @param int $user
447			*
448			* @return bool
449			*/
450			protected function is_user_active ($user) {
451			/**
452			* Optimization, more data requested than actually used here, because data will be requested later, and it would be nice to have that data cached
453			*/
454			$data = User::instance()->get(
455			[
456			'login',
457			'username',
458			'language',
459			'timezone',
460			'status',
461			'block_until',
462			'avatar'
463			],
464			$user
465			);
466			if (!$data) {
467			return false;
468			}
469			$L = new Language_prefix('system_profile_sign_in_');
470			$Page = Page::instance();
471			switch ($data['status']) {
472			case User::STATUS_INACTIVE:
473			/**
474			* If user is disabled
475			*/
476			$Page->warning($L->your_account_disabled);
477			return false;
478			case User::STATUS_NOT_ACTIVATED:
479			/**
480			* If user is not active
481			*/
482			$Page->warning($L->your_account_is_not_active);
483			return false;
484			}
485			if ($data['block_until'] > time()) {
486			/**
487			* If user if blocked
488			*/
489			$Page->warning($L->your_account_blocked_until(date($L->_datetime, $data['block_until'])));
490			return false;
491			}
492			return true;
493			}
494			/**
495			* Create the session for the user with specified id
496			*
497			* @param int $user
498			* @param bool $delete_current_session
499			*
500			* @return false\|string Session id on success, `false` otherwise
501			*/
502			function add ($user, $delete_current_session = true) {
503			$user = (int)$user;
504			if (!$user) {
505			return false;
506			}
507			if ($delete_current_session && is_md5($this->session_id)) {
508			$this->del_internal($this->session_id, false);
509			}
510			if (!$this->is_user_active($user)) {
511			/**
512			* If data was not loaded or account is not active - create guest session
513			*/
514			return $this->add(User::GUEST_ID);
515			}
516			$session_data = $this->create_unique_session($user);
517			Response::instance()->cookie('session', $session_data['id'], $session_data['expire'], true);
518			$this->load_initialization($session_data['id'], $session_data['user']);
519			/**
520			* Delete old sessions using probability and system configuration of inserts limits and update ratio
521			*/
522			$Config = Config::instance();
523			if (mt_rand(0, $Config->core['inserts_limit']) < $Config->core['inserts_limit'] / 100 * (100 - $Config->core['update_ratio']) / 5) {
524			$this->delete_old_sessions();
525			}
526			Event::instance()->fire(
527			'System/Session/add',
528			[
529			'session_data' => $session_data
530			]
531			);
532			return $session_data['id'];
533			}
534			/**
535			* @param int $user
536			*
537			* @return array Session data
538			*/
539			protected function create_unique_session ($user) {
540			$Config = Config::instance();
541			$Request = Request::instance();
542			$remote_addr = ip2hex($Request->remote_addr);
543			$ip = ip2hex($Request->ip);
544			/**
545			* Many guests open only one page (or do not store any cookies), so create guest session only for 5 minutes max initially
546			*/
547			$expire_in = $user == User::GUEST_ID ? min($Config->core['session_expire'], self::INITIAL_SESSION_EXPIRATION) : $Config->core['session_expire'];
548			$expire = time() + $expire_in;
549			/**
550			* Create unique session
551			*/
552			$session_data = [
553			'id' => null,
554			'user' => $user,
555			'created' => time(),
556			'expire' => $expire,
557			'user_agent' => $Request->header('user-agent'),
558			'remote_addr' => $remote_addr,
559			'ip' => $ip,
560			'data' => []
561			];
562			do {
563			$session_data['id'] = md5(random_bytes(1000));
564			} while (!$this->create($session_data));
565			return $session_data;
566			}
567			/**
568			* Destroying of the session
569			*
570			* @param null\|string $session_id
571			*
572			* @return bool
573			*/
574			function del ($session_id = null) {
575			return (bool)$this->del_internal($session_id);
576			}
577			/**
578			* Deletion of the session
579			*
580			* @param string\|null $session_id
581			* @param bool $create_guest_session
582			*
583			* @return bool
584			*/
585			protected function del_internal ($session_id = null, $create_guest_session = true) {
586			$session_id = $session_id ?: $this->session_id;
587			if (!is_md5($session_id)) {
588			return false;
589			}
590			Event::instance()->fire(
591			'System/Session/del/before',
592			[
593			'id' => $session_id
594			]
595			);
596			unset($this->cache->$session_id);
597			$this->session_id = false;
598			Response::instance()->cookie('session', '');
599			$result = $this->delete($session_id);
600			if ($result) {
601			if ($create_guest_session) {
602			return (bool)$this->add(User::GUEST_ID);
603			}
604			Event::instance()->fire(
605			'System/Session/del/after',
606			[
607			'id' => $session_id
608			]
609			);
610			}
611			return (bool)$result;
612			}
613			/**
614			* Delete all old sessions from DB
615			*/
616			protected function delete_old_sessions () {
617			$this->db_prime()->aq(
618			"DELETE FROM `[prefix]sessions`
619			WHERE `expire` < ".time()
620			);
621			}
622			/**
623			* Deletion of all user sessions
624			*
625			* @param false\|int $user If not specified - current user assumed
626			*
627			* @return bool
628			*/
629			function del_all ($user = false) {
630			$user = $user ?: $this->user_id;
631			Event::instance()->fire(
632			'System/Session/del_all',
633			[
634			'id' => $user
635			]
636			);
637			$sessions = $this->db_prime()->qfas(
638			"SELECT `id`
639			FROM `[prefix]sessions`
640			WHERE `user` = '$user'"
641			);
642			if (is_array($sessions)) {
643			if (!$this->delete($sessions)) {
644			return false;
645			}
646			foreach ($sessions as $session) {
647			unset($this->cache->$session);
648			}
649			}
650			return true;
651			}
652			/**
653			* Get data, stored with session
654			*
655			* @param string $item
656			* @param null\|string $session_id
657			*
658			* @return false\|mixed
659			*
660			*/
661			function get_data ($item, $session_id = null) {
662			$session_data = $this->get_data_internal($session_id);
663			return isset($session_data['data'][$item]) ? $session_data['data'][$item] : false;
664			}
665			/*
666			* @param null\|string $session_id
667			*
668			* @return array\|false
669			*/
670			protected function get_data_internal ($session_id) {
671			$session_id = $session_id ?: $this->session_id;
672			return is_md5($session_id) ? $this->get_internal($session_id) : false;
673			}
674			/**
675			* Store data with session
676			*
677			* @param string $item
678			* @param mixed $value
679			* @param null\|string $session_id
680			*
681			* @return bool
682			*
683			*/
684			function set_data ($item, $value, $session_id = null) {
685			$session_data = $this->get_data_internal($session_id);
686			/**
687			* If there is no session yet - let's create one
688			*/
689			if (!$session_data) {
690			$session_id = $this->add(User::GUEST_ID);
691			$session_data = $this->get_data_internal($session_id);
692			}
693			if (!isset($session_data['data'])) {
694			return false;
695			}
696			$session_data['data'][$item] = $value;
697			return $this->update($session_data) && $this->cache->del($session_id);
698			}
699			/**
700			* Delete data, stored with session
701			*
702			* @param string $item
703			* @param null\|string $session_id
704			*
705			* @return bool
706			*
707			*/
708			function del_data ($item, $session_id = null) {
709			$session_data = $this->get_data_internal($session_id);
710			if (!isset($session_data['data'][$item])) {
711			return true;
712			}
713			return $this->update($session_data) && $this->cache->del($session_id);
714			}
715			}
716

nazar-pc / CleverStyle-Framework

Push — master ( b7b84b...78616b )

Session::guest() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like