cs\User\Data

Complexity

Total Complexity

106

Size/Duplication

Total Lines	540
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	5
Bugs	1	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	initialize_data()	0	8	1
A	get()	0	6	3
C	get_internal()	0	62	14
B	get_internal_one_item()	0	26	5
A	set()	0	5	1
C	set_internal()	0	56	19
C	set_internal_allowed()	0	24	9
C	get_data()	0	71	16
C	set_data()	0	46	7
B	del_data()	0	18	5
B	get_id()	0	23	5
B	avatar()	0	14	6
B	username()	0	14	5
A	disable_memory_cache()	0	3	1
A	get_users_columns()	0	3	1
C	persist_data()	0	26	8

<?php
/**
 * @package   CleverStyle CMS
 * @author    Nazar Mokrynskyi <nazar@mokrynskyi.com>
 * @copyright Copyright (c) 2011-2016, Nazar Mokrynskyi
 * @license   MIT License, see license.txt
 */
namespace cs\User;
use
	cs\Config,
	cs\Event,
	cs\Language,
	cs\Session,
	cs\User,
	h;

/**
 * Trait that contains all methods from <i>>cs\User</i> for working with user data
 *
 * @property \cs\Cache\Prefix $cache
 * @property int              $id
 *
 * @method \cs\DB\_Abstract db()
 * @method \cs\DB\_Abstract db_prime()
 * @method false|int[]        get_groups(false|int $user)
 */
trait Data {
	/**
	 * Copy of columns list of users table for internal needs without Cache usage
	 * @var array
	 */
	protected $users_columns = [];
	/**
	 * Local cache of users data
	 * @var array
	 */
	protected $data = [];
	/**
	 * Changed users data, at the finish, data in db must be replaced by this data
	 * @var array
	 */
	protected $data_set = [];
	/**
	 * Whether to use memory cache (locally, inside object, may require a lot of memory if working with many users together)
	 * @var bool
	 */
	protected $memory_cache = true;
	protected function initialize_data () {
		$this->users_columns = $this->cache->get(
			'columns',
			function () {
				return $this->db()->columns('[prefix]users');
			}
		);
	}
	/**
	 * Get data item of specified user
	 *
	 * @param string|string[] $item
	 * @param false|int       $user If not specified - current user assumed
	 *
	 * @return false|int|mixed[]|string|Properties If <i>$item</i> is integer - cs\User\Properties object will be returned

Should the return type not be Properties|false|array|integer|string? Also, consider making the array more specific, something like array<String>, or String[].

	 */
	function get ($item, $user = false) {
		if (is_scalar($item) && ctype_digit((string)$item)) {
			return new Properties($item);
		}
		return $this->get_internal($item, $user);
	}
	/**
	 * Get data item of specified user
	 *
	 * @todo Refactor this to select all or nothing; this selection of only necessary stuff is tricky and should be simplified
	 *
	 * @param string|string[] $item
	 * @param false|int       $user If not specified - current user assumed
	 *
	 * @return false|int|string|mixed[]

Should the return type not be false|array|integer|string? Also, consider making the array more specific, something like array<String>, or String[].

	 */
	protected function get_internal ($item, $user = false) {
		$user = (int)$user ?: $this->id;
		if (!$user) {
			return false;
		}
		/** @noinspection NestedTernaryOperatorInspection */
		$data = isset($this->data[$user]) ? $this->data[$user] : ($this->cache->$user ?: ['id' => $user]);
		/**
		 * If get an array of values
		 */
		if (is_array($item)) {
			$result = $new_items = [];
			/**
			 * Trying to get value from the local cache, or make up an array of missing values
			 */
			foreach ($item as $i) {
				if (in_array($i, $this->users_columns)) {
					if (isset($data[$i])) {
						$result[$i] = $data[$i];
					} else {
						$new_items[] = $i;
					}
				}
			}
			if (!$new_items) {
				return $result;
			}
			/**
			 * If there are missing values - get them from the database
			 */
			$new_items = '`'.implode('`, `', $new_items).'`';
			$res       = $this->db()->qf(
				"SELECT $new_items
				FROM `[prefix]users`
				WHERE `id` = '$user'
				LIMIT 1"
			);
			unset($new_items);
			if (is_array($res)) {
				$data               = array_merge($res, $data ?: []);
				$this->cache->$user = $data;
				if ($this->memory_cache) {
					$this->data[$user] = $data;
				}
				$result = array_merge($result, $res);
				/**
				 * Sorting the resulting array in the same manner as the input array
				 */
				$res = [];
				foreach ($item as $i) {
					$res[$i] = &$result[$i];
				}
				return $res;
			} else {
				return false;
			}
		}
		/**
		 * If get one value
		 */
		return $this->get_internal_one_item($item, $user, $data);
	}
	/**
	 * @param string  $item
	 * @param int     $user
	 * @param mixed[] $data
	 *
	 * @return false|int|string
	 */
	protected function get_internal_one_item ($item, $user, &$data) {
		if (!in_array($item, $this->users_columns)) {
			return false;
		}
		/**
		 * If data in local cache - return them
		 */
		if (isset($data[$item])) {
			return $data[$item];
		}
		$data_from_db = $this->db()->qfs(
			"SELECT `$item`
			FROM `[prefix]users`
			WHERE `id` = '$user'
			LIMIT 1"
		);
		if ($data_from_db !== false) {
			$data[$item]        = $data_from_db;
			$this->cache->$user = $data;
			if ($this->memory_cache) {
				$this->data[$user] = $data;
			}
			return $data_from_db;
		}
		return false;
	}
	/**
	 * Set data item of specified user
	 *
	 * @param array|string    $item Item-value array may be specified for setting several items at once
	 * @param int|null|string $value
	 * @param false|int       $user If not specified - current user assumed
	 *
	 * @return bool
	 */
	function set ($item, $value = null, $user = false) {
		$result = $this->set_internal($item, $value, $user);
		$this->persist_data();
		return $result;
	}
	/**
	 * Set data item of specified user
	 *
	 * @param array|string    $item Item-value array may be specified for setting several items at once
	 * @param int|null|string $value
	 * @param false|int       $user If not specified - current user assumed
	 *
	 * @return bool
	 */
	protected function set_internal ($item, $value = null, $user = false) {
		$user = (int)$user ?: $this->id;
		if (!$user) {
			return false;
		}
		if (is_array($item)) {
			$result = true;
			foreach ($item as $i => $v) {
				$result = $result && $this->set($i, $v, $user);
			}
			return $result;
		}
		if (!$this->set_internal_allowed($user, $item, $value)) {
			return false;
		}
		if ($item === 'language') {
			$value = $value ? Language::instance()->get('clanguage', $value) : '';
		} elseif ($item === 'timezone') {
			$value = in_array($value, get_timezones_list(), true) ? $value : '';
		} elseif ($item == 'avatar') {
			if (
				strpos($value, 'http://') !== 0 &&
				strpos($value, 'https://') !== 0
			) {
				$value = '';
			} else {
				$old_value = $this->get($item, $user);
				if ($value !== $old_value) {
					$Event = Event::instance();
					$Event->fire(
						'System/upload_files/del_tag',
						[
							'url' => $old_value,
							'tag' => "users/$user/avatar"
						]
					);
					$Event->fire(
						'System/upload_files/add_tag',
						[
							'url' => $value,
							'tag' => "users/$user/avatar"
						]
					);
				}
			}
		}
		$this->data_set[$user][$item] = $value;
		if (in_array($item, ['login', 'email'], true)) {
			$old_value                            = $this->get($item.'_hash', $user);
			$this->data_set[$user][$item.'_hash'] = hash('sha224', $value);
			unset($this->cache->$old_value);
		} elseif ($item === 'password_hash' || ($item === 'status' && $value == 0)) {
			Session::instance()->del_all($user);
		}
		return true;
	}
	/**
	 * Check whether setting specified item to specified value for specified user is allowed
	 *
	 * @param int    $user
	 * @param string $item
	 * @param string $value
	 *
	 * @return bool
	 */
	protected function set_internal_allowed ($user, $item, $value) {
		if (
			$user === User::GUEST_ID ||
			$item === 'id' ||
			!in_array($item, $this->users_columns, true)
		) {
			return false;
		}
		if (in_array($item, ['login', 'email'], true)) {
			$value = mb_strtolower($value);
			if (
				$item === 'email' &&
				!filter_var($value, FILTER_VALIDATE_EMAIL) &&
				!in_array(User::BOT_GROUP_ID, $this->get_groups($user))
			) {
				return false;
			}
			if ($value === $this->get($item, $user)) {
				return true;
			}
			return !$this->get_id(hash('sha224', $value));
		}
		return true;
	}
	/**
	 * Getting additional data item(s) of specified user
	 *
	 * @param string|string[] $item
	 * @param false|int       $user If not specified - current user assumed
	 *
	 * @return false|string|mixed[]
	 */
	function get_data ($item, $user = false) {
		$user = (int)$user ?: $this->id;
		if (!$user || !$item || $user == User::GUEST_ID) {
			return false;
		}
		$Cache = $this->cache;
		$data  = $Cache->{"data/$user"} ?: [];
		if (is_array($item)) {
			$result = [];
			$absent = [];
			foreach ($item as $i) {
				if (isset($data[$i])) {
					$result[$i] = $data[$i];
				} else {
					$absent[] = $i;
				}
			}
			if ($absent) {
				$absent = implode(
					',',
					$this->db()->s($absent)
				);
				$absent = array_column(
					$this->db()->qfa(
						[
							"SELECT `item`, `value`
							FROM `[prefix]users_data`
							WHERE
								`id`	= '$user' AND
								`item`	IN($absent)"
						]
					),
					'value',
					'item'
				);
				foreach ($absent as &$a) {
					$a = _json_decode($a);
					if ($a === null) {
						$a = false;
					}
				}
				unset($a);
				$result += $absent;
				$data += $absent;
				$Cache->{"data/$user"} = $data;
			}
			return $result;
		}
		if ($data === false || !isset($data[$item])) {
			if (!is_array($data)) {
				$data = [];
			}
			$data[$item] = _json_decode(
				$this->db()->qfs(
					[
						"SELECT `value`
						FROM `[prefix]users_data`
						WHERE
							`id`	= '$user' AND
							`item`	= '%s'",
						$item
					]
				)
			);
			if ($data[$item] === null) {
				$data[$item] = false;
			}
			$Cache->{"data/$user"} = $data;
		}
		return $data[$item];
	}
	/**
	 * Setting additional data item(s) of specified user
	 *
	 * @param array|string $item Item-value array may be specified for setting several items at once
	 * @param mixed|null   $value
	 * @param false|int    $user If not specified - current user assumed
	 *
	 * @return bool
	 */
	function set_data ($item, $value = null, $user = false) {
		$user = (int)$user ?: $this->id;
		if (!$user || !$item || $user == User::GUEST_ID) {
			return false;
		}
		if (is_array($item)) {
			$params = [];
			foreach ($item as $i => $v) {
				$params[] = [
					$i,
					_json_encode($v)
				];
			}
			unset($i, $v);
			$result = $this->db_prime()->insert(
				"REPLACE INTO `[prefix]users_data`
					(
						`id`,
						`item`,
						`value`
					) VALUES (
						$user,
						'%s',
						'%s'
					)",
				$params
			);
		} else {
			$result = $this->db_prime()->q(
				"REPLACE INTO `[prefix]users_data`
					(
						`id`,
						`item`,
						`value`
					) VALUES (
						'$user',
						'%s',
						'%s'
					)",
				$item,
				_json_encode($value)
			);
		}
		unset($this->cache->{"data/$user"});
		return (bool)$result;
	}
	/**
	 * Deletion of additional data item(s) of specified user
	 *
	 * @param string|string[] $item
	 * @param false|int       $user If not specified - current user assumed
	 *
	 * @return bool
	 */
	function del_data ($item, $user = false) {
		$user = (int)$user ?: $this->id;
		if (!$user || !$item || $user == User::GUEST_ID) {
			return false;
		}
		$item   = implode(
			',',
			$this->db_prime()->s((array)$item)
		);
		$result = $this->db_prime()->q(
			"DELETE FROM `[prefix]users_data`
			WHERE
				`id`	= '$user' AND
				`item`	IN($item)"
		);
		unset($this->cache->{"data/$user"});
		return (bool)$result;
	}
	/**
	 * Get user id by login or email hash (sha224) (hash from lowercase string)
	 *
	 * @param  string $login_hash Login or email hash
	 *
	 * @return false|int User id if found and not guest, otherwise - boolean <i>false</i>
	 */
	function get_id ($login_hash) {
		if (!preg_match('/^[0-9a-z]{56}$/', $login_hash)) {
			return false;
		}
		$id = $this->cache->get(
			$login_hash,
			function () use ($login_hash) {
				return $this->db()->qfs(
					[
						"SELECT `id`
						FROM `[prefix]users`
						WHERE
							`login_hash`	= '%s' OR
							`email_hash`	= '%s'
						LIMIT 1",
						$login_hash,
						$login_hash
					]
				) ?: false;
			}
		);
		return $id && $id != User::GUEST_ID ? $id : false;
	}
	/**
	 * Get user avatar, if no one present - uses Gravatar
	 *
	 * @param int|null  $size Avatar size, if not specified or resizing is not possible - original image is used
	 * @param false|int $user If not specified - current user assumed
	 *
	 * @return string
	 */
	function avatar ($size = null, $user = false) {
		$user   = (int)$user ?: $this->id;
		$avatar = $this->get('avatar', $user);
		$Config = Config::instance();
		if (!$avatar && $this->id != User::GUEST_ID && $Config->core['gravatar_support']) {
			$email_hash     = md5($this->get('email', $user));
			$default_avatar = urlencode($Config->core_url().'/includes/img/guest.svg');
			$avatar         = "https://www.gravatar.com/avatar/$email_hash?d=mm&s=$size&d=$default_avatar";
		}
		if (!$avatar) {
			$avatar = '/includes/img/guest.svg';
		}
		return h::prepare_url($avatar, true);
	}
	/**
	 * Get user name or login or email, depending on existing information
	 *
	 * @param false|int $user If not specified - current user assumed
	 *
	 * @return string
	 */
	function username ($user = false) {
		$user = (int)$user ?: $this->id;
		if ($user === User::GUEST_ID) {
			return Language::instance()->system_profile_guest;
		}
		$username = $this->get('username', $user);
		if (!$username) {
			$username = $this->get('login', $user);
		}
		if (!$username) {
			$username = $this->get('email', $user);
		}
		return $username;
	}
	/**
	 * Disable memory cache
	 *
	 * Memory cache stores users data inside User class in order to get data faster next time.
	 * But in case of working with large amount of users this cache can be too large. Disabling will cause some performance drop, but save a lot of RAM.
	 */
	function disable_memory_cache () {
		$this->memory_cache = false;
	}
	/**
	 * Returns array of users columns, available for getting of data
	 *
	 * @return array
	 */
	function get_users_columns () {
		return $this->users_columns;
	}
	/**
	 * Saving changes of cache and users data
	 */
	protected function persist_data () {
		foreach ($this->data_set as $user => $data_set) {
			$update = [];
			foreach ($data_set as $item => $value) {
				if ($item != 'id' && in_array($item, $this->users_columns)) {
					$value = xap($value, false);
					if (isset($this->data[$user])) {
						$this->data[$user][$item] = $value;
					}
					$update[] = "`$item` = ".$this->db_prime()->s($value);
				}
			}
			if (isset($this->data[$user])) {
				$this->cache->$user = $this->data[$user];
			}
			if (!$update) {
				$update = implode(', ', $update);
				$this->db_prime()->q(
					"UPDATE `[prefix]users`
					SET $update
					WHERE `id` = '$user'"
				);
			}
		}
		$this->data_set = [];
	}
}