Unread

Complexity

Total Complexity

58

Size/Duplication

Total Lines	423
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	3
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getUnreads()	0	6	2
A	setEarliestMsg()	0	3	1
A	setSorting()	0	4	1
A	setAction()	0	4	2
A	bodyPreview()	0	6	2
A	setBoards()	0	6	2
A	isSortAsc()	0	3	1
A	__construct()	0	8	1
A	numUnreads()	0	8	2
B	_countRecentTopics()	0	22	7
A	_countUnreadReplies()	0	20	3
D	_getUnreadReplies()	0	105	19
C	_getUnreadTopics()	0	78	15

<?php

/**
 * Find and retrieve information about recently posted topics, messages, and the like.
 *
 * @name      ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause
 *
 * This file contains code covered by:
 * copyright:	2011 Simple Machines (http://www.simplemachines.org)
 * license:		BSD, See included LICENSE.TXT for terms and conditions.
 *
 * @version 1.1.7
 *
 */

/**
 * Unread posts and replies Controller
 */
class Unread
{
	const UNREAD = 0;
	const UNREADREPLIES = 1;

	/** @var bool */
	private $_ascending = false;
	/** @var string */
	private $_sort_query = '';
	/** @var int */
	private $_num_topics = 0;
	/** @var int */
	private $_min_message = 0;
	/** @var int */
	private $_action = self::UNREAD;
	/** @var int */
	private $_earliest_msg = 0;
	/** @var bool */
	private $_showing_all_topics = false;
	/** @var int */
	private $_user_id = 0;
	/** @var bool */
	private $_post_mod = false;
	/** @var bool */
	private $_unwatch = false;
	/** @var Database|null */
	private $_db = null;
	/** @var int|string */
	private $_preview_bodies = 0;

	/**
	 * Parameters for the main query.
	 */
	private $_query_parameters = array();

	/**
	 * Constructor
	 *
	 * @param int $user - ID of the user
	 * @param bool|int $post_mod - if post moderation is active or not
	 * @param bool|int $unwatch - if unwatch topics is active or not
	 * @param bool|int $showing_all_topics - Is the user looking at all the unread
	 *             replies, or the recent topics?
	 */
	public function __construct($user, $post_mod, $unwatch, $showing_all_topics = false)
	{
		$this->_user_id = (int) $user;
		$this->_post_mod = (bool) $post_mod;
		$this->_unwatch = (bool) $unwatch;
		$this->_showing_all_topics = (bool) $showing_all_topics;

		$this->_db = database();
	}

	/**
	 * Sets the boards the member is looking at
	 *
	 * @param int|int[] $boards - the id of the boards
	 */
	public function setBoards($boards)
	{
		if (is_array($boards))
			$this->_query_parameters['boards'] = $boards;
		else
			$this->_query_parameters['boards'] = array($boards);
	}

	/**
	 * The action the user is performing
	 *
	 * @param int $action - Unread::UNREAD, Unread::UNREADREPLIES
	 */
	public function setAction($action)
	{
		if (in_array($action, array(self::UNREAD, self::UNREADREPLIES)))
			$this->_action = $action;
	}

	/**
	 * Sets the lower message id to be taken in consideration
	 *
	 * @param int $msg_id - id of the earliest message to consider
	 */
	public function setEarliestMsg($msg_id)
	{
		$this->_earliest_msg = (int) $msg_id;
	}

	/**
	 * Sets the sorting query and the direction
	 *
	 * @param string $query - The query to be used in the ORDER clause
	 * @param bool|int $asc - If the sorting is ascending or not
	 */
	public function setSorting($query, $asc)
	{
		$this->_sort_query = $query;
		$this->_ascending = $asc;

It seems like $asc can also be of type integer. However, the property $_ascending is declared as type boolean. Maybe add an additional type check?

	}

	/**
	 * Return the sorting direction
	 *
	 * @return boolean
	 */
	public function isSortAsc()
	{
		return $this->_ascending;
	}

	/**
	 * Sets if the data returned by the class will include a shorted version
	 * of the body of the last message.
	 *
	 * @param bool|int $chars - The number of chars to retrieve.
	 *                 If true it will return the entire body,
	 *                 if 0 no preview will be generated.
	 */
	public function bodyPreview($chars)
	{
		if ($chars === true)
			$this->_preview_bodies = 'all';
		else
			$this->_preview_bodies = (int) $chars;
	}

	/**
	 * Counts the number of unread topics or messages
	 *
	 * @param bool $first_login - If this is the first login of the user
	 * @param int $id_msg_last_visit - highest id_msg found during the last visit
	 */
	public function numUnreads($first_login = false, $id_msg_last_visit = 0)
	{
		if ($this->_action === self::UNREAD)
			$this->_countRecentTopics($first_login, $id_msg_last_visit);
		else
			$this->_countUnreadReplies();

		return $this->_num_topics;
	}

	/**
	 * Retrieves unread topics or messages
	 *
	 * @param string $join - kind of "JOIN" to execute. If 'topic' JOINs boards on
	 *                       the topics table, otherwise ('message') the JOIN is on
	 *                       the messages table
	 * @param int $start - position to start the query
	 * @param int $limit - number of entries to grab
	 * @param bool $include_avatars - if avatars should be retrieved as well
	 * @return mixed[] - see Topic_Util::prepareContext
	 */
	public function getUnreads($join, $start, $limit, $include_avatars)
	{
		if ($this->_action === self::UNREAD)
			return $this->_getUnreadTopics($join, $start, $limit, $include_avatars);
		else
			return $this->_getUnreadReplies($start, $limit, $include_avatars);
	}

	/**
	 * Retrieves unread topics, used in *all* unread replies with temp table and
	 * new posts since last visit
	 *
	 * @param string $join - kind of "JOIN" to execute. If 'topic' JOINs boards on
	 *                       the topics table, otherwise ('message') the JOIN is on
	 *                       the messages table
	 * @param int $start - position to start the query
	 * @param int $limit - number of entries to grab
	 * @param bool|int $include_avatars - if avatars should be retrieved as well
	 * @return mixed[] - see Topic_Util::prepareContext
	 */
	private function _getUnreadTopics($join, $start, $limit, $include_avatars = false)
	{
		if ($this->_preview_bodies == 'all')
			$body_query = 'ml.body AS last_body, ms.body AS first_body,';
		else
		{
			// If empty, no preview at all
			if (empty($this->_preview_bodies))
				$body_query = '';
			// Default: a SUBSTRING
			else
				$body_query = 'SUBSTRING(ml.body, 1, ' . ($this->_preview_bodies + 256) . ') AS last_body, SUBSTRING(ms.body, 1, ' . ($this->_preview_bodies + 256) . ') AS first_body,';
		}

		if (!empty($include_avatars))
		{
			// Double equal comparison for 1 because it is backward compatible with 1.0 where the value was true/false
			if ($include_avatars == 1 || $include_avatars === 3)
			{
				$custom_selects = array('meml.avatar', 'COALESCE(a.id_attach, 0) AS id_attach', 'a.filename', 'a.attachment_type', 'meml.email_address');
				$custom_joins = array('LEFT JOIN {db_prefix}attachments AS a ON (a.id_member = ml.id_member AND a.id_member != 0)');
			}
			else
			{
				$custom_selects = array();
				$custom_joins = array();
			}

			if ($include_avatars === 2 || $include_avatars === 3)
			{
				$custom_selects = array_merge($custom_selects, array('memf.avatar AS avatar_first', 'COALESCE(af.id_attach, 0) AS id_attach_first', 'af.filename AS filename_first', 'af.attachment_type AS attachment_type_first', 'memf.email_address AS email_address_first'));
				$custom_joins = array_merge($custom_joins, array('LEFT JOIN {db_prefix}attachments AS af ON (af.id_member = mf.id_member AND af.id_member != 0)'));
			}
		}

		$request = $this->_db->query('substring', '

The method query() does not exist on null.

			SELECT
				ms.subject AS first_subject, ms.poster_time AS first_poster_time, ms.poster_name AS first_member_name,
				ms.id_topic, t.id_board, b.name AS bname, t.num_replies, t.num_views, t.num_likes, t.approved,
				ms.id_member AS first_id_member, ml.id_member AS last_id_member, ml.poster_name AS last_member_name,
				ml.poster_time AS last_poster_time, COALESCE(mems.real_name, ms.poster_name) AS first_display_name,
				COALESCE(meml.real_name, ml.poster_name) AS last_display_name, ml.subject AS last_subject,
				ml.icon AS last_icon, ms.icon AS first_icon, t.id_poll, t.is_sticky, t.locked, ml.modified_time AS last_modified_time,
				COALESCE(lt.id_msg, lmr.id_msg, -1) + 1 AS new_from,
				' . $body_query . '
				' . (!empty($custom_selects) ? implode(',', $custom_selects) . ', ' : '') . '
				ml.smileys_enabled AS last_smileys, ms.smileys_enabled AS first_smileys, t.id_first_msg, t.id_last_msg
			FROM {db_prefix}messages AS ms
				INNER JOIN {db_prefix}topics AS t ON (t.id_topic = ms.id_topic AND t.id_first_msg = ms.id_msg)
				INNER JOIN {db_prefix}messages AS ml ON (ml.id_msg = t.id_last_msg)' . ($join == 'topics' ? '
				LEFT JOIN {db_prefix}boards AS b ON (b.id_board = t.id_board)' : '
				LEFT JOIN {db_prefix}boards AS b ON (b.id_board = ms.id_board)') . '
				LEFT JOIN {db_prefix}members AS mems ON (mems.id_member = ms.id_member)
				LEFT JOIN {db_prefix}members AS meml ON (meml.id_member = ml.id_member)
				LEFT JOIN {db_prefix}log_topics AS lt ON (lt.id_topic = t.id_topic AND lt.id_member = {int:current_member})' . (!empty($custom_joins) ? implode("\n\t\t\t\t", $custom_joins) : '') . '
				LEFT JOIN {db_prefix}log_mark_read AS lmr ON (lmr.id_board = t.id_board AND lmr.id_member = {int:current_member})
			WHERE t.id_board IN ({array_int:boards})
				AND t.id_last_msg >= {int:min_message}
				AND COALESCE(lt.id_msg, lmr.id_msg, 0) < ml.id_msg' .
				($this->_post_mod ? ' AND ms.approved = {int:is_approved}' : '') .
				($this->_unwatch ? ' AND COALESCE(lt.unwatched, 0) != 1' : '') . '
			ORDER BY {raw:order}
			LIMIT {int:offset}, {int:limit}',
			array_merge($this->_query_parameters, array(
				'current_member' => $this->_user_id,
				'min_message' => $this->_min_message,
				'is_approved' => 1,
				'order' => $this->_sort_query . ($this->_ascending ? '' : ' DESC'),
				'offset' => $start,
				'limit' => $limit,
			))
		);
		$topics = array();
		while ($row = $this->_db->fetch_assoc($request))
			$topics[] = $row;
		$this->_db->free_result($request);

		return Topic_Util::prepareContext($topics, true, ((int) $this->_preview_bodies) + 128);
	}

	/**
	 * Counts unread replies
	 */
	private function _countUnreadReplies()
	{
		$request = $this->_db->query('unread_fetch_topic_count', '
			SELECT COUNT(DISTINCT t.id_topic), MIN(t.id_last_msg)
			FROM {db_prefix}topics AS t
				INNER JOIN {db_prefix}messages AS m ON (m.id_topic = t.id_topic)
				LEFT JOIN {db_prefix}log_topics AS lt ON (lt.id_topic = t.id_topic AND lt.id_member = {int:current_member})
				LEFT JOIN {db_prefix}log_mark_read AS lmr ON (lmr.id_board = t.id_board AND lmr.id_member = {int:current_member})
			WHERE t.id_board IN ({array_int:boards})
				AND m.id_member = {int:current_member}
				AND COALESCE(lt.id_msg, lmr.id_msg, 0) < t.id_last_msg' . ($this->_post_mod ? '
				AND t.approved = {int:is_approved}' : '') . ($this->_unwatch ? '
				AND COALESCE(lt.unwatched, 0) != 1' : ''),
			array_merge($this->_query_parameters, array(
				'current_member' => $this->_user_id,
				'is_approved' => 1,
			))
		);
		list ($this->_num_topics, $this->_min_message) = $this->_db->fetch_row($request);
		$this->_db->free_result($request);
	}

	/**
	 * Counts unread topics, used in *all* unread replies with temp table and
	 * new posts since last visit
	 *
	 * @param bool $is_first_login - if the member has already logged in at least
	 *             once, then there is an $id_msg_last_visit
	 * @param int $id_msg_last_visit - highest id_msg found during the last visit
	 */
	private function _countRecentTopics($is_first_login, $id_msg_last_visit = 0)
	{
		$request = $this->_db->query('', '
			SELECT COUNT(*), MIN(t.id_last_msg)
			FROM {db_prefix}topics AS t
				LEFT JOIN {db_prefix}log_topics AS lt ON (lt.id_topic = t.id_topic AND lt.id_member = {int:current_member})
				LEFT JOIN {db_prefix}log_mark_read AS lmr ON (lmr.id_board = t.id_board AND lmr.id_member = {int:current_member})
			WHERE t.id_board IN ({array_int:boards})' . ($this->_showing_all_topics && !empty($this->_earliest_msg) ? '
				AND t.id_last_msg > {int:earliest_msg}' : (!$this->_showing_all_topics && $is_first_login ? '
				AND t.id_last_msg > {int:id_msg_last_visit}' : '')) . '
				AND COALESCE(lt.id_msg, lmr.id_msg, 0) < t.id_last_msg' .
				($this->_post_mod ? ' AND t.approved = {int:is_approved}' : '') .
				($this->_unwatch ? ' AND COALESCE(lt.unwatched, 0) != 1' : ''),
			array_merge($this->_query_parameters, array(
				'current_member' => $this->_user_id,
				'earliest_msg' => $this->_earliest_msg,
				'id_msg_last_visit' => $id_msg_last_visit,
				'is_approved' => 1,
			))
		);
		list ($this->_num_topics, $this->_min_message) = $this->_db->fetch_row($request);
		$this->_db->free_result($request);
	}

	/**
	 * Retrieves unread replies since last visit
	 *
	 * @param int $start - position to start the query
	 * @param int $limit - number of entries to grab
	 * @param bool|int $include_avatars - if avatars should be retrieved as well
	 * @return mixed[] - see Topic_Util::prepareContext
	 */
	private function _getUnreadReplies($start, $limit, $include_avatars = false)
	{
        $request = $this->_db->query('unread_replies', '
				SELECT DISTINCT t.id_topic
				FROM {db_prefix}topics AS t
					INNER JOIN {db_prefix}messages AS m ON (m.id_topic = t.id_topic AND m.id_member = {int:current_member})' . (strpos($this->_sort_query, 'ms.') === false ? '' : '
					INNER JOIN {db_prefix}messages AS ms ON (ms.id_msg = t.id_first_msg)') . (strpos($this->_sort_query, 'mems.') === false ? '' : '
					LEFT JOIN {db_prefix}members AS mems ON (mems.id_member = ms.id_member)') . '
					LEFT JOIN {db_prefix}log_topics AS lt ON (lt.id_topic = t.id_topic AND lt.id_member = {int:current_member})
					LEFT JOIN {db_prefix}log_mark_read AS lmr ON (lmr.id_board = t.id_board AND lmr.id_member = {int:current_member})
				WHERE t.id_board IN ({array_int:boards})
					AND t.id_last_msg >= {int:min_message}
					AND COALESCE(lt.id_msg, lmr.id_msg, 0) < t.id_last_msg' .
            ($this->_post_mod ? ' AND t.approved = {int:is_approved}' : '') .
            ($this->_unwatch ? ' AND COALESCE(lt.unwatched, 0) != 1' : '') . '
				ORDER BY {raw:order}
				LIMIT {int:offset}, {int:limit}',
            array_merge($this->_query_parameters, array(
                'current_member' => $this->_user_id,
                'min_message' => $this->_min_message,
                'is_approved' => 1,
                'order' => $this->_sort_query . ($this->_ascending ? '' : ' DESC'),
                'offset' => $start,
                'limit' => $limit,
            ))
        );

		$topics = array();
		while ($row = $this->_db->fetch_assoc($request))
			$topics[] = $row['id_topic'];
		$this->_db->free_result($request);

		// Sanity... where have you gone?
		if (empty($topics))
			return false;

The expression return false returns the type false which is incompatible with the documented return type array<mixed,mixed>.

		if ($this->_preview_bodies == 'all')
			$body_query = 'ml.body AS last_body, ms.body AS first_body,';
		else
		{
			// If empty, no preview at all
			if (empty($this->_preview_bodies))
				$body_query = '';
			// Default: a SUBSTRING
			else
				$body_query = 'SUBSTRING(ml.body, 1, ' . ($this->_preview_bodies + 256) . ') AS last_body, SUBSTRING(ms.body, 1, ' . ($this->_preview_bodies + 256) . ') AS first_body,';
		}

		if (!empty($include_avatars))
		{
			// Double equal comparison for 1 because it is backward compatible with 1.0 where the value was true/false
			if ($include_avatars == 1 || $include_avatars === 3)
			{
				$custom_selects = array('meml.avatar', 'COALESCE(a.id_attach, 0) AS id_attach', 'a.filename', 'a.attachment_type', 'meml.email_address');
				$custom_joins = array('LEFT JOIN {db_prefix}attachments AS a ON (a.id_member = ml.id_member AND a.id_member != 0)');
			}
			else
			{
				$custom_selects = array();
				$custom_joins = array();
			}

			if ($include_avatars === 2 || $include_avatars === 3)
			{
				$custom_selects = array_merge($custom_selects, array('memf.avatar AS avatar_first', 'COALESCE(af.id_attach, 0) AS id_attach_first', 'af.filename AS filename_first', 'af.attachment_type AS attachment_type_first', 'memf.email_address AS email_address_first'));
				$custom_joins = array_merge($custom_joins, array('LEFT JOIN {db_prefix}attachments AS af ON (af.id_member = ms.id_member AND af.id_member != 0)'));
			}
		}

		$request = $this->_db->query('substring', '
			SELECT
				ms.subject AS first_subject, ms.poster_time AS first_poster_time, ms.id_topic, t.id_board, b.name AS bname,
				ms.poster_name AS first_member_name, ml.poster_name AS last_member_name, t.approved,
				t.num_replies, t.num_views, t.num_likes, ms.id_member AS first_id_member, ml.id_member AS last_id_member,
				ml.poster_time AS last_poster_time, COALESCE(mems.real_name, ms.poster_name) AS first_display_name,
				COALESCE(meml.real_name, ml.poster_name) AS last_display_name, ml.subject AS last_subject,
				ml.icon AS last_icon, ms.icon AS first_icon, t.id_poll, t.is_sticky, t.locked, ml.modified_time AS last_modified_time,
				COALESCE(lt.id_msg, lmr.id_msg, -1) + 1 AS new_from,
				' . $body_query . '
				' . (!empty($custom_selects) ? implode(',', $custom_selects) . ', ' : '') . '
				ml.smileys_enabled AS last_smileys, ms.smileys_enabled AS first_smileys, t.id_first_msg, t.id_last_msg
			FROM {db_prefix}topics AS t
				INNER JOIN {db_prefix}messages AS ms ON (ms.id_topic = t.id_topic AND ms.id_msg = t.id_first_msg)
				INNER JOIN {db_prefix}messages AS ml ON (ml.id_msg = t.id_last_msg)
				INNER JOIN {db_prefix}boards AS b ON (b.id_board = t.id_board)
				LEFT JOIN {db_prefix}members AS mems ON (mems.id_member = ms.id_member)
				LEFT JOIN {db_prefix}members AS meml ON (meml.id_member = ml.id_member)
				LEFT JOIN {db_prefix}log_topics AS lt ON (lt.id_topic = t.id_topic AND lt.id_member = {int:current_member})
				LEFT JOIN {db_prefix}log_mark_read AS lmr ON (lmr.id_board = t.id_board AND lmr.id_member = {int:current_member})' . (!empty($custom_joins) ? implode("\n\t\t\t\t", $custom_joins) : '') . '
			WHERE t.id_topic IN ({array_int:topic_list})
			ORDER BY {raw:order}
			LIMIT {int:limit}',
			array(
				'current_member' => $this->_user_id,
				'order' => $this->_sort_query . ($this->_ascending ? '' : ' DESC'),
				'topic_list' => $topics,
				'limit' => count($topics),
			)
		);
		$return = array();
		while ($row = $this->_db->fetch_assoc($request))
			$return[] = $row;
		$this->_db->free_result($request);

		return Topic_Util::prepareContext($return, true, ((int) $this->_preview_bodies) + 128);
	}
}