phpbbgallery\core\user

Complexity

Total Complexity

98

Size/Duplication

Total Lines	714
Duplicated Lines	0 %

Test Coverage

Coverage

64.65%

Importance

Changes	5
Bugs	1	Features	0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	sql_build_where()	0	16	4
A	update_images()	0	18	5
A	destroy()	0	5	1
A	load_data()	0	13	2
A	delete_users()	0	8	1
A	get_default_value()	0	10	2
A	__construct()	0	13	1
A	insert()	0	20	2
A	set_permissions_changed()	0	5	2
A	update()	0	15	2
A	is_user()	0	3	1
A	update_data()	0	16	4
A	get_data()	0	12	4
A	update_users()	0	15	2
A	set_user_id()	0	6	2
A	force_load()	0	5	2
A	get_default_values()	0	22	2
A	set_personal_albums()	0	35	6
A	get_own_root_album()	0	10	2
A	delete()	0	5	1
C	validate_data()	0	57	15
A	update_image_count()	0	19	5
F	add_user_to_cache()	0	107	30

<?php
/**
 * phpBB Gallery - Core Extension
 *
 * @package   phpbbgallery/core
 * @author    nickvergessen
 * @author    satanasov
 * @author    Leinad4Mind
 * @copyright 2014 nickvergessen, 2014- satanasov, 2018- Leinad4Mind
 * @license   GPL-2.0-only
 */

namespace phpbbgallery\core;

class user
{
	/**
	 * phpBB-user_id
	 *
	 * @var int
	 */
	public $user_id;

	/**
	 * phpBB user object
	 *
	 * @var \phpbb\user

The type phpbb\user was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	protected $user;

	/**
	 * Custom profile fields manager
	 *
	 * @var \phpbb\profilefields\manager

The type phpbb\profilefields\manager was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	protected $user_cpf;

	/**
	 * Config object
	 *
	 * @var \phpbb\config\config

The type phpbb\config\config was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	protected $config;

	/**
	 * Auth object
	 *
	 * @var \phpbb\auth\auth

The type phpbb\auth\auth was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	protected $auth;

	/**
	 * phpBB root path
	 *
	 * @var string
	 */
	protected $root_path;

	/**
	 * PHP file extension
	 *
	 * @var string
	 */
	protected $php_ext;

	/**
	 * Database object
	 *
	 * @var \phpbb\db\driver\driver

The type phpbb\db\driver\driver was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	protected $db;

	/**
	 * Event dispatcher object
	 *
	 * @var \phpbb\event\dispatcher

The type phpbb\event\dispatcher was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	protected $dispatcher;

	/**
	 * Gallery users table
	 *
	 * @var string
	 */
	protected $gallery_users_table;

	/**
	 * Do we have an entry for the user in the table?
	 */
	public $entry_exists = null;

	/**
	 * Users data in the table
	 */
	protected $data = array();

	/**
	 * Constructor
	 *
	 * @param \phpbb\db\driver\driver|\phpbb\db\driver\driver_interface $db         Database object
	 * @param \phpbb\event\dispatcher                                   $dispatcher Event dispatcher object
	 * @param \phpbb\user                                               $user
	 * @param \phpbb\profilefields\manager                              $user_cpf
	 * @param \phpbb\config\config                                      $config
	 * @param \phpbb\auth\auth                                          $auth
	 * @param string                                                    $table_name Gallery users table
	 * @param                                                           $root_path
	 * @param                                                           $php_ext
	 */
	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\event\dispatcher $dispatcher, \phpbb\user $user,

The type phpbb\db\driver\driver_interface was not found. Maybe you did not declare it correctly or list all dependencies?

		\phpbb\profilefields\manager $user_cpf, \phpbb\config\config $config, \phpbb\auth\auth $auth,
		$table_name, $root_path, $php_ext)
	{
		$this->db = $db;
		$this->dispatcher = $dispatcher;
		$this->user = $user;
		$this->user_cpf = $user_cpf;
		$this->config = $config;
		$this->auth = $auth;
		$this->gallery_users_table = $table_name;
		$this->root_path = $root_path;
		$this->php_ext = $php_ext;
	}

	/**
	 * Set the user ID
	 *
	 * @param int  $user_id
	 * @param bool $load Shall we automatically load the users data from the database?
	 */
	public function set_user_id($user_id, $load = true)
	{
		$this->user_id = (int) $user_id;
		if ($load)
		{
			$this->load_data();
		}
	}

	/**
	 * Is it the same user?
	 *
	 * @param int $user_id
	 * @return    bool
	 */
	public function is_user($user_id)
	{
		return $this->user_id == $user_id;
	}

	/**
	 * Load the users data from the database and cast it...
	 */
	public function load_data()
	{
		$this->entry_exists = false;
		$sql = 'SELECT *
			FROM ' . $this->gallery_users_table . '
			WHERE user_id = ' . (int) $this->user_id;
		$result = $this->db->sql_query($sql, 30);
		if ($row = $this->db->sql_fetchrow($result))
		{
			$this->data = $this->validate_data($row);
			$this->entry_exists = true;
		}
		$this->db->sql_freeresult($result);

	}

	/**
	 * Load the users data from the database and cast it...
	 *
	 * @param $time
	 */
	public function set_permissions_changed($time)
	{
		if ($this->data)

The expression $this->data of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

		{
			$this->data['user_permissions_changed'] = $time;
		}
	}

	/**
	 * Some functions need the data to be loaded or at least checked.
	 * So here we loaded if it is not loaded yet and we need it ;)
	 */
	public function force_load()
	{
		if (is_null($this->entry_exists))
		{
			$this->load_data();
		}
	}

	/**
	 * Get user-setting, if the user does not have his own settings we fall back to default.
	 *
	 * @param string $key     Column name from the users-table
	 * @param bool   $default Load default value, if user has no entry
	 * @return    mixed            Returns the value of the column, it it does not exist it returns false.
	 */
	public function get_data($key, $default = true)
	{
		if (isset($this->data[$key]))
		{
			return $this->data[$key];
		}
		else if ($default && $this->get_default_value($key) !== null)
		{
			return $this->get_default_value($key);
		}

		return false;
	}

	/**
	 * Updates/Inserts the data, depending on whether the user already exists or not.
	 *    Example: 'SET key = x'
	 *
	 * @param $data
	 * @return bool
	 */
	public function update_data($data)
	{
		$this->force_load();

		$suc = false;
		if ($this->entry_exists)
		{
			$suc = $this->update($data);
		}

		if (($suc === false) || !$this->entry_exists)
		{
			$suc = $this->insert($data);
		}

		return $suc;
	}

	/**
	 * Increase/Inserts the data, depending on whether the user already exists or not.
	 *    Example: 'SET key = key + x'
	 *
	 * @param $num
	 * @return bool
	 */
	public function update_images($num)
	{
		$suc = false;
		if ($this->entry_exists || is_null($this->entry_exists))
		{
			$suc = $this->update_image_count($num);
			if ($suc === false)
			{
				$suc = $this->update(array('user_images' => max(0, $num)));
			}
		}

		if ($suc === false)
		{
			$suc = $this->insert(array('user_images' => max(0, $num)));
		}

		return $suc;
	}

	/**
	 * Updates the users table with the new data.
	 *
	 * @param array $data Array of data we want to add/update.
	 * @return    bool            Returns true if the columns were updated successfully
	 */
	private function update($data)
	{
		$sql_ary = array_merge($this->validate_data($data), array(
			'user_last_update' => time(),
		));
		unset($sql_ary['user_id']);

		$sql = 'UPDATE ' . $this->gallery_users_table . '
			SET ' . $this->db->sql_build_array('UPDATE', $sql_ary) . '
			WHERE user_id = ' . (int) $this->user_id;
		$this->db->sql_query($sql);

		$this->data = array_merge($this->data, $sql_ary);

		return ($this->db->sql_affectedrows() == 1) ? true : false;
	}

	/**
	 * Updates the users table by increasing the values.
	 *
	 * @param int $num Number of images to add to the counter
	 * @return    bool            Returns true if the columns were updated successfully, else false
	 */
	protected function update_image_count($num)
	{
		$sql = 'UPDATE ' . $this->gallery_users_table . '
			SET user_images = user_images ' . (($num > 0) ? (' + ' . $num) : (' - ' . abs($num))) . ',
				user_last_update = ' . time() . '
			WHERE ' . (($num < 0) ? ' user_images > ' . abs($num) . ' AND ' : '') . '
				user_id = ' . $this->user_id;
		$this->db->sql_query($sql);

		if ($this->db->sql_affectedrows() == 1)
		{
			if (!empty($this->data))
			{
				$this->data['user_last_update'] = time();
				$this->data['user_images'] += $num;
			}
			return true;
		}
		return false;
	}

	/**
	 * Updates the users table with the new data.
	 *
	 * @param array $data Array of data we want to insert
	 * @return    bool            Returns true if the data was inserted successfully
	 */
	private function insert($data)
	{
		$sql_ary = array_merge(self::get_default_values(), $this->validate_data($data), array(

The method phpbbgallery\core\user::get_default_values() is not static, but was called statically.

			'user_id'          => $this->user_id,
			'user_last_update' => time(),
		));

		$this->db->sql_return_on_error(true);

		$sql = 'INSERT INTO ' . $this->gallery_users_table . '
			' . $this->db->sql_build_array('INSERT', $sql_ary);
		$this->db->sql_query($sql);
		$error = $this->db->get_sql_error_triggered();

		$this->db->sql_return_on_error(false);

		$this->data = $sql_ary;
		$this->entry_exists = true;

		return ($error) ? false : true;
	}

	/**
	 * Delete the user from the table.
	 */
	public function delete()
	{
		$sql = 'DELETE FROM ' . $this->gallery_users_table . '
			WHERE user_id = ' . (int) $this->user_id;
		$this->db->sql_query($sql);
	}

	/**
	 * Delete the user from the table.
	 *
	 * @param mixed $user_ids Can either be an array of IDs, one ID or the string 'all' to delete all users.
	 */
	public function delete_users($user_ids)
	{

		$sql_where = $this->sql_build_where($user_ids);

		$sql = 'DELETE FROM ' . $this->gallery_users_table . '
			' . $sql_where;
		$this->db->sql_query($sql);
	}

	/**
	 * Updates the users table with new data.
	 *
	 * @param mixed $user_ids Can either be an array of IDs, one ID or the string 'all' to update all users.
	 * @param array $data     Array of data we want to add/update.
	 * @return    bool                Returns true if the columns were updated successfully
	 */
	public function update_users($user_ids, $data)
	{
		$sql_ary = array_merge($this->validate_data($data), array(
			'user_last_update' => time(),
		));
		unset($sql_ary['user_id']);

		$sql_where = $this->sql_build_where($user_ids);

		$sql = 'UPDATE ' . $this->gallery_users_table . '
			SET ' . $this->db->sql_build_array('UPDATE', $sql_ary) . '
			' . $sql_where;
		$this->db->sql_query($sql);

		return ($this->db->sql_affectedrows() != 0) ? true : false;
	}

	/**
	 * Builds a valid WHERE-sql-statement, with casted integers, or empty to allow handling all users.
	 *
	 * @param mixed $user_ids Can either be an array of IDs, one ID or the string 'all' to update all users.
	 * @return    string                The WHERE statement with "WHERE " if needed.
	 */
	public function sql_build_where($user_ids)
	{
		if (is_array($user_ids) && !empty($user_ids))
		{
			$sql_where = 'WHERE ' . $this->db->sql_in_set('user_id', array_map('intval', $user_ids));
		}
		else if ($user_ids == 'all')
		{
			$sql_where = '';
		}
		else
		{
			$sql_where = 'WHERE user_id = ' . (int) $user_ids;
		}

		return $sql_where;
	}

	/**
	 * Validate user data.
	 *
	 * @param array $data Array of data we need to validate
	 * @param bool  $inc  Are we incrementing the value
	 * @return    array            Array with all allowed keys and their casted and selected values
	 */
	public function validate_data($data, $inc = false)
	{
		$validated_data = array();
		foreach ($data as $name => $value)
		{
			switch ($name)
			{
				case 'user_id':
				case 'user_images':
				case 'personal_album_id':
				case 'user_lastmark':
				case 'user_last_update':
					if ($inc && ($name == 'user_images'))
					{
						// While incrementing, the images might be lower than 0.
						$validated_data[$name] = (int) $value;
					}
					else
					{
						$validated_data[$name] = max(0, (int) $value);
					}
				break;

				case 'watch_own':
				case 'watch_com':
				case 'subscribe_pegas':
				case 'rrc_zebra':
					$validated_data[$name] = (bool) $value;
				break;

				case 'user_permissions':
					$validated_data[$name] = $value;
				break;

				default:
					$is_validated = false;

					/**
					 * Event user validate data
					 *
					 * @event phpbbgallery.core.user.validate_data
					 * @var    bool    is_validated    is value validated
					 * @var    string    name            value name
					 * @var    mixed    value            value of the value
					 * @since 1.2.0
					 */
					$vars = array('is_validated', 'name', 'value');
					extract($this->dispatcher->trigger_event('phpbbgallery.core.user.validate_data', compact($vars)));

					if ($is_validated)
					{
						$validated_data[$name] = $value;
					}
				break;
			}
		}
		return $validated_data;
	}

	private function get_default_value($key)
	{
		$default_values = $this->get_default_values();

		if (isset($default_values[$key]))
		{
			return $default_values[$key];
		}

		return null;
	}

	private function get_default_values()
	{
		static $default_values;

		if ($default_values)
		{
			return $default_values;
		}

		$default_values = self::$default_values;

		/**
		 * Event user validate data
		 *
		 * @event phpbbgallery.core.user.get_default_values
		 * @var    array    default_values    the default values array
		 * @since 1.2.0
		 */
		$vars = array('default_values');
		extract($this->dispatcher->trigger_event('phpbbgallery.core.user.get_default_values', compact($vars)));

		return $default_values;
	}

	/**
	 * Default values for new users.
	 */
	static protected $default_values = array(
		'user_images'              => 0,
		'personal_album_id'        => 0,
		'user_lastmark'            => 0,
		'user_last_update'         => 0,
		'user_permissions_changed' => 0,

		'user_permissions'    => '',

		// Shall other users be allowed to comment on this users images by default?
		'user_allow_comments' => true,
		// Shall the user be subscribed to his own images?
		'watch_own'           => true,
		// Shall the user be subscribed if he comments on an images?
		'watch_com'           => false,
		// Automatically subscribe user to new personal galleries?
		'subscribe_pegas'     => false,
		// Should we hide Foes from RRC
		'rrc_zebra'           => false,
	);

	/**
	 * @param $user_cache
	 * @param $row
	 */
	public function add_user_to_cache(&$user_cache, $row)
	{
		$user_id = $row['user_id'];
		if (!function_exists('phpbb_get_user_rank'))
		{
			include($this->root_path . 'includes/functions_display.' . $this->php_ext);
		}

		$now = $this->user->create_datetime();
		$now = phpbb_gmgetdate($now->getTimestamp() + $now->getOffset());

The function phpbb_gmgetdate was not found. Maybe you did not declare it correctly or list all dependencies?

		// Cache various user specific data ... so we don't have to recompute
		// this each time the same user appears on this page
		if (!isset($user_cache[$user_id]))
		{
			if ($user_id == ANONYMOUS)

The constant phpbbgallery\core\ANONYMOUS was not found. Maybe you did not declare it correctly or list all dependencies?

			{
				$user_cache_data = array(

The assignment to $user_cache_data is dead and can be removed.

					'user_type'           => USER_IGNORE,

The constant phpbbgallery\core\USER_IGNORE was not found. Maybe you did not declare it correctly or list all dependencies?

					'joined'              => '',
					'posts'               => '',
					'sig'                 => '',
					'sig_bbcode_uid'      => '',
					'sig_bbcode_bitfield' => '',
					'online'              => false,
					'avatar'              => ($this->user->optionget('viewavatars')) ? phpbb_get_user_avatar($row) : '',

The function phpbb_get_user_avatar was not found. Maybe you did not declare it correctly or list all dependencies?

					'rank_title'          => '',
					'rank_image'          => '',
					'rank_image_src'      => '',
					'pm'                  => '',
					'email'               => '',
					'jabber'              => '',
					'search'              => '',
					'age'                 => '',
					'username'            => $row['username'],
					'user_colour'         => $row['user_colour'],
					'contact_user'        => '',
					'warnings'            => 0,
					'allow_pm'            => 0,
				);
			}
			else
			{
				$user_sig = '';
				// We add the signature to every posters entry because enable_sig is post dependent
				if ($row['user_sig'] && $this->config['allow_sig'] && $this->user->optionget('viewsigs'))
				{
					$user_sig = $row['user_sig'];
				}
				$user_cache_data = array(
					'user_type'            => $row['user_type'],
					'user_inactive_reason' => $row['user_inactive_reason'],
					'joined'               => $this->user->format_date($row['user_regdate']),
					'posts'                => $row['user_posts'],
					'warnings'             => (isset($row['user_warnings'])) ? $row['user_warnings'] : 0,
					'sig'                  => $user_sig,
					'sig_bbcode_uid'       => (!empty($row['user_sig_bbcode_uid'])) ? $row['user_sig_bbcode_uid'] : '',
					'sig_bbcode_bitfield'  => (!empty($row['user_sig_bbcode_bitfield'])) ? $row['user_sig_bbcode_bitfield'] : '',
					'viewonline'           => $row['user_allow_viewonline'],
					'allow_pm'             => $row['user_allow_pm'],
					'avatar'               => ($this->user->optionget('viewavatars')) ? phpbb_get_user_avatar($row) : '',
					'age'                  => '',
					'rank_title'           => '',
					'rank_image'           => '',
					'rank_image_src'       => '',
					'username'             => $row['username'],
					'user_colour'          => $row['user_colour'],
					'contact_user'         => $this->user->lang('CONTACT_USER', get_username_string('username', $user_id, $row['username'], $row['user_colour'], $row['username'])),

The function get_username_string was not found. Maybe you did not declare it correctly or list all dependencies?

					'online'               => false,
					'jabber'               => ($this->config['jab_enable'] && $row['user_jabber'] && $this->auth->acl_get('u_sendim')) ? append_sid("{$this->root_path}memberlist.$this->php_ext", "mode=contact&action=jabber&u=$user_id") : '',

The function append_sid was not found. Maybe you did not declare it correctly or list all dependencies?

					'search'               => ($this->config['load_search'] && $this->auth->acl_get('u_search')) ? append_sid("{$this->root_path}search.$this->php_ext", "author_id=$user_id&sr=posts") : '',
					'author_full'          => get_username_string('full', $user_id, $row['username'], $row['user_colour']),
					'author_colour'        => get_username_string('colour', $user_id, $row['username'], $row['user_colour']),
					'author_username'      => get_username_string('username', $user_id, $row['username'], $row['user_colour']),
					'author_profile'       => get_username_string('profile', $user_id, $row['username'], $row['user_colour']),
				);

				$user_cache[$user_id] = $user_cache_data;

				$user_rank_data = phpbb_get_user_rank($row, $row['user_posts']);
				$user_cache[$user_id]['rank_title'] = $user_rank_data['title'];
				$user_cache[$user_id]['rank_image'] = $user_rank_data['img'];
				$user_cache[$user_id]['rank_image_src'] = $user_rank_data['img_src'];

				if ((!empty($row['user_allow_viewemail']) && $this->auth->acl_get('u_sendemail')) || $this->auth->acl_get('a_email'))
				{
					$user_cache[$user_id]['email'] = ($this->config['board_email_form'] && $this->config['email_enable']) ? append_sid("{$this->root_path}memberlist.$this->php_ext", "mode=email&u=$user_id") : (($this->config['board_hide_emails'] && !$this->auth->acl_get('a_email')) ? '' : 'mailto:' . $row['user_email']);
				}
				else
				{
					$user_cache[$user_id]['email'] = '';
				}
				if ($this->config['allow_birthdays'] && !empty($row['user_birthday']))
				{
					list($bday_day, $bday_month, $bday_year) = array_map('intval', explode('-', $row['user_birthday']));
					if ($bday_year)
					{
						$diff = $now['mon'] - $bday_month;
						if ($diff == 0)
						{
							$diff = ($now['mday'] - $bday_day < 0) ? 1 : 0;
						}
						else
						{
							$diff = ($diff < 0) ? 1 : 0;
						}
						$user_cache[$user_id]['age'] = (int) ($now['year'] - $bday_year - $diff);
					}
				}
			}
		}
	}

	/**
	 * Get user personal album
	 * Checks and returns users personal album
	 * returns (int) $album_id or 0
	 */
	public function get_own_root_album()
	{
		$sql = 'SELECT personal_album_id FROM ' . $this->gallery_users_table . ' WHERE user_id = ' . (int) $this->user_id;
		$result = $this->db->sql_query($sql);
		$row = $this->db->sql_fetchrow($result);
		if ($row)
		{
			return (int) $row['personal_album_id'];
		}
		return false;
	}

	/**
	 * Destroy user data and set this class to empty
	 */
	public function destroy()
	{
		$this->user_id = null;
		$this->entry_exists = null;
		$this->data = array();
	}

	/**
	 * @param array $user_ids Array of user IDs
	 * @return int                    Count of updated Users
	 */

	public function set_personal_albums($user_ids)
	{
		if (!is_array($user_ids))

The condition is_array($user_ids) is always true.

		{
			$user_ids = array($user_ids);
		}
		$sql = 'SELECT user_id, personal_album_id FROM ' . $this->gallery_users_table . ' WHERE ' . $this->db->sql_in_set('user_id', $user_ids);
		//var_dump($sql);
		$result = $this->db->sql_query($sql);
		$set_array = array();
		while ($row = $this->db->sql_fetchrow($result))
		{
			//var_dump($row);
			if ($row['personal_album_id'] > 0)
			{
				$set_array[$row['user_id']] = $row['personal_album_id'];
			}
		}
		$this->db->sql_freeresult($result);
		$updated_rows = 0;
		if (count($set_array) > 0)
		{
			foreach ($set_array as $uid => $album_id)
			{
				// Fill album CPF.
				$cpf_vars = array(
					'pf_gallery_palbum' => (int) $album_id,
				);
				$this->user_cpf->update_profile_field_data((int) $uid, $cpf_vars);

				$updated_rows++;
			}
		}

		return $updated_rows;
	}
}