vse\similartopics\core\similar_topics

Complexity

Total Complexity

63

Size/Duplication

Total Lines	456
Duplicated Lines	0 %

Importance

Changes	34
Bugs	2	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	is_available()	0	3	3
A	is_viewable()	0	3	2
A	__construct()	0	19	1
A	is_enabled()	0	3	2
A	english_lang()	0	3	2
A	get_ignore_words()	0	14	3
A	clean_topic_title()	0	11	3
F	display_similar_topics()	0	196	40
A	strip_stop_words()	0	33	4
A	make_word_array()	0	16	3

<?php
/**
 *
 * Precise Similar Topics
 *
 * @copyright (c) 2013 Matt Friedman
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace vse\similartopics\core;

use phpbb\auth\auth;

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

use phpbb\cache\service as cache;

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

use phpbb\config\config;

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

use phpbb\config\db_text;

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

use phpbb\content_visibility;

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

use phpbb\db\driver\driver_interface as db;

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

use phpbb\event\dispatcher_interface as dispatcher;

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

use phpbb\extension\manager as ext_manager;

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

use phpbb\language\language;

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

use phpbb\pagination;

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

use phpbb\request\request;

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

use phpbb\template\template;

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

use phpbb\user;

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

use vse\similartopics\driver\driver_interface as similartopics_driver;
use vse\similartopics\driver\manager as similartopics_manager;

class similar_topics
{
	/** @var auth */
	protected $auth;

	/** @var cache */
	protected $cache;

	/** @var config */
	protected $config;

	/** @var db_text */
	protected $config_text;

	/** @var db */
	protected $db;

	/** @var dispatcher */
	protected $dispatcher;

	/** @var ext_manager */
	protected $extension_manager;

	/** @var language */
	protected $language;

	/** @var pagination */
	protected $pagination;

	/** @var request */
	protected $request;

	/** @var template */
	protected $template;

	/** @var user */
	protected $user;

	/** @var content_visibility */
	protected $content_visibility;

	/** @var similartopics_driver */
	protected $similartopics;

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

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

	/** @var string String of custom ignore words */
	protected $ignore_words;

	/**
	 * Constructor
	 *
	 * @access public
	 * @param auth                  $auth
	 * @param cache                 $cache
	 * @param config                $config
	 * @param db_text               $config_text
	 * @param db                    $db
	 * @param dispatcher            $dispatcher
	 * @param ext_manager           $extension_manager
	 * @param language              $language
	 * @param pagination            $pagination
	 * @param request               $request
	 * @param template              $template
	 * @param user                  $user
	 * @param content_visibility    $content_visibility
	 * @param similartopics_manager $similartopics_manager
	 * @param string                $root_path
	 * @param string                $php_ext
	 */
	public function __construct(auth $auth, cache $cache, config $config, db_text $config_text, db $db, dispatcher $dispatcher, ext_manager $extension_manager, language $language, pagination $pagination, request $request, template $template, user $user, content_visibility $content_visibility, similartopics_manager $similartopics_manager, $root_path, $php_ext)
	{
		$this->auth = $auth;
		$this->cache = $cache;
		$this->config = $config;
		$this->config_text = $config_text;
		$this->db = $db;
		$this->dispatcher = $dispatcher;
		$this->extension_manager = $extension_manager;
		$this->language = $language;
		$this->pagination = $pagination;
		$this->request = $request;
		$this->template = $template;
		$this->user = $user;
		$this->content_visibility = $content_visibility;
		$this->root_path = $root_path;
		$this->php_ext = $php_ext;

		$this->similartopics = $similartopics_manager->get_driver($db->get_sql_layer());
	}

	/**
	 * Is similar topics available?
	 *
	 * @access public
	 * @return bool True if available, false otherwise
	 */
	public function is_available()
	{
		return $this->is_enabled() && $this->is_viewable() && $this->similartopics !== null;
	}

	/**
	 * Is similar topics configured?
	 *
	 * @access public
	 * @return bool True if configured, false otherwise
	 */
	public function is_enabled()
	{
		return !empty($this->config['similar_topics']) && !empty($this->config['similar_topics_limit']);
	}

	/**
	 * Is similar topics viewable by the user?
	 *
	 * @access public
	 * @return bool True if viewable, false otherwise
	 */
	public function is_viewable()
	{
		return !empty($this->user->data['user_similar_topics']) && $this->auth->acl_get('u_similar_topics');
	}

	/**
	 * Get similar topics by matching topic titles
	 * Loosely based on viewforum.php lines 840-1040
	 *
	 * NOTE: FULLTEXT has built-in English ignore words. We use phpBB's
	 * ignore words for non-English languages. We also remove any
	 * admin-defined special ignore words.
	 *
	 * @access public
	 * @param array $topic_data Array with topic data
	 */
	public function display_similar_topics($topic_data)
	{
		// If the forum should not display similar topics, no need to continue
		if ($topic_data['similar_topics_hide'])
		{
			return;
		}

		$topic_title = $this->clean_topic_title($topic_data['topic_title']);

		// If the cleaned up topic_title is empty, no need to continue
		if (empty($topic_title))
		{
			return;
		}

		// Get stored sensitivity value and divide by 10. In query, it should be a number between 0.0 to 1.0.
		$sensitivity = $this->config->offsetExists('similar_topics_sense') ? number_format($this->config['similar_topics_sense'] / 10, 1, '.', '') : '0.5';

		// Similar Topics SQL query is generated in similar topics driver
		$sql_array = $this->similartopics->get_query($topic_data['topic_id'], $topic_title, $this->config['similar_topics_time'], $sensitivity);

$sensitivity of type string is incompatible with the type double expected by parameter $sensitivity of vse\similartopics\driver\driver_interface::get_query().

		// Add topic tracking data to the query (only if query caching is off)
		if ($this->user->data['is_registered'] && $this->config['load_db_lastread'] && !$this->config['similar_topics_cache'])
		{
			$sql_array['LEFT_JOIN'][] = array('FROM' => array(TOPICS_TRACK_TABLE => 'tt'), 'ON' => 'tt.topic_id = t.topic_id AND tt.user_id = ' . $this->user->data['user_id']);

The constant vse\similartopics\core\TOPICS_TRACK_TABLE was not found. Maybe you did not declare it correctly or list all dependencies?

			$sql_array['LEFT_JOIN'][] = array('FROM' => array(FORUMS_TRACK_TABLE => 'ft'), 'ON' => 'ft.forum_id = f.forum_id AND ft.user_id = ' . $this->user->data['user_id']);

The constant vse\similartopics\core\FORUMS_TRACK_TABLE was not found. Maybe you did not declare it correctly or list all dependencies?

			$sql_array['SELECT'] .= ', tt.mark_time, ft.mark_time as f_mark_time';
		}
		else if ($this->config['load_anon_lastread'] || $this->user->data['is_registered'])
		{
			// Cookie based tracking copied from search.php
			$tracking_topics = $this->request->variable($this->config['cookie_name'] . '_track', '', true, \phpbb\request\request_interface::COOKIE);

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

			$tracking_topics = $tracking_topics ? tracking_unserialize($tracking_topics) : array();

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

		}

		// We need to exclude passworded forums, so we do not leak the topic title
		$passworded_forums = $this->user->get_passworded_forums();

		// See if the admin set this forum to only search a specific group of other forums, and include them
		if (!empty($topic_data['similar_topic_forums']))
		{
			// Remove any passworded forums from this group of forums we will be searching
			$included_forums = array_diff(json_decode($topic_data['similar_topic_forums'], true), $passworded_forums);
			// if there's nothing left to display (user has no access to the forums we want to search)
			if (empty($included_forums))
			{
				return;
			}

			$sql_array['WHERE'] .= ' AND ' . $this->db->sql_in_set('f.forum_id', $included_forums);
		}
		// Otherwise, exclude any ignored forums
		else
		{
			// Remove any passworded forums
			if (count($passworded_forums))
			{
				$sql_array['WHERE'] .= ' AND ' . $this->db->sql_in_set('f.forum_id', $passworded_forums, true);
			}

			$sql_array['WHERE'] .= ' AND f.similar_topics_ignore = 0';
		}

		/**
		 * Event to modify the sql_array for similar topics
		 *
		 * @event vse.similartopics.get_topic_data
		 * @var array sql_array SQL array to get similar topics data
		 * @since 1.3.0
		 */
		$vars = array('sql_array');
		extract($this->dispatcher->trigger_event('vse.similartopics.get_topic_data', compact($vars)));

		$rowset = array();

		$sql = $this->db->sql_build_query('SELECT', $sql_array);
		$result = $this->db->sql_query_limit($sql, $this->config['similar_topics_limit'], 0, $this->config['similar_topics_cache']);
		while ($row = $this->db->sql_fetchrow($result))
		{
			$rowset[(int) $row['topic_id']] = $row;
		}
		$this->db->sql_freeresult($result);

		// Grab icons
		$icons = $this->cache->obtain_icons();

		/**
		 * Modify the rowset data for similar topics
		 *
		 * @event vse.similartopics.modify_rowset
		 * @var	array rowset Array with the search results data
		 * @since 1.4.2
		 */
		$vars = array('rowset');
		extract($this->dispatcher->trigger_event('vse.similartopics.modify_rowset', compact($vars)));

		foreach ($rowset as $row)
		{
			$similar_forum_id = (int) $row['forum_id'];
			$similar_topic_id = (int) $row['topic_id'];

			if ($this->auth->acl_get('f_read', $similar_forum_id))
			{
				// Get topic tracking info
				if ($this->user->data['is_registered'] && $this->config['load_db_lastread'] && !$this->config['similar_topics_cache'])
				{
					$topic_tracking_info = get_topic_tracking($similar_forum_id, $similar_topic_id, $rowset, array($similar_forum_id => $row['f_mark_time']));

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

				}
				else if ($this->config['load_anon_lastread'] || $this->user->data['is_registered'])
				{
					$topic_tracking_info = get_complete_topic_tracking($similar_forum_id, $similar_topic_id);

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

					if (!$this->user->data['is_registered'])
					{
						$this->user->data['user_lastmark'] = isset($tracking_topics['l']) ? ((int) base_convert($tracking_topics['l'], 36, 10) + (int) $this->config['board_startdate']) : 0;
					}
				}

				// Replies
				$replies = $this->content_visibility->get_count('topic_posts', $row, $similar_forum_id) - 1;

				// Get folder img, topic status/type related information
				$folder_img = $folder_alt = $topic_type = '';
				$unread_topic = isset($topic_tracking_info[$similar_topic_id]) && $row['topic_last_post_time'] > $topic_tracking_info[$similar_topic_id];
				topic_status($row, $replies, $unread_topic, $folder_img, $folder_alt, $topic_type);

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

				$view_topic_url_params = 't=' . $similar_topic_id;

				$topic_unapproved = $row['topic_visibility'] == ITEM_UNAPPROVED && $this->auth->acl_get('m_approve', $similar_forum_id);

The constant vse\similartopics\core\ITEM_UNAPPROVED was not found. Maybe you did not declare it correctly or list all dependencies?

				$posts_unapproved = $row['topic_visibility'] == ITEM_APPROVED && $row['topic_posts_unapproved'] && $this->auth->acl_get('m_approve', $similar_forum_id);

The constant vse\similartopics\core\ITEM_APPROVED was not found. Maybe you did not declare it correctly or list all dependencies?

				$u_mcp_queue = ($topic_unapproved || $posts_unapproved) ? append_sid("{$this->root_path}mcp.$this->php_ext", 'i=queue&mode=' . ($topic_unapproved ? 'approve_details' : 'unapproved_posts') . "&t=$similar_topic_id", true, $this->user->session_id) : '';

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

				$base_url = append_sid("{$this->root_path}viewtopic.$this->php_ext", $view_topic_url_params);

				$topic_row = array(
					'TOPIC_AUTHOR_FULL'			=> get_username_string('full', $row['topic_poster'], $row['topic_first_poster_name'], $row['topic_first_poster_colour']),

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

					'FIRST_POST_TIME'			=> $this->user->format_date($row['topic_time']),
					'FIRST_POST_TIME_RFC3339'	=> gmdate(DATE_RFC3339, $row['topic_time']),
					'LAST_POST_TIME'			=> $this->user->format_date($row['topic_last_post_time']),
					'LAST_POST_TIME_RFC3339'	=> gmdate(DATE_RFC3339, $row['topic_last_post_time']),
					'LAST_POST_AUTHOR_FULL'		=> get_username_string('full', $row['topic_last_poster_id'], $row['topic_last_poster_name'], $row['topic_last_poster_colour']),

					'TOPIC_REPLIES'			=> $replies,
					'TOPIC_VIEWS'			=> $row['topic_views'],
					'TOPIC_TITLE'			=> censor_text($row['topic_title']),

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

					'FORUM_TITLE'			=> $row['forum_name'],

					'TOPIC_IMG_STYLE'		=> $folder_img,
					'TOPIC_FOLDER_IMG'		=> $this->user->img($folder_img, $folder_alt),
					'TOPIC_FOLDER_IMG_ALT'	=> $this->language->lang($folder_alt),

					'TOPIC_ICON_IMG'		=> !empty($icons[$row['icon_id']]) ? $icons[$row['icon_id']]['img'] : '',
					'TOPIC_ICON_IMG_WIDTH'	=> !empty($icons[$row['icon_id']]) ? $icons[$row['icon_id']]['width'] : '',
					'TOPIC_ICON_IMG_HEIGHT'	=> !empty($icons[$row['icon_id']]) ? $icons[$row['icon_id']]['height'] : '',
					'ATTACH_ICON_IMG'		=> ($this->auth->acl_get('u_download') && $this->auth->acl_get('f_download', $similar_forum_id) && $row['topic_attachment']) ? $this->user->img('icon_topic_attach', $this->language->lang('TOTAL_ATTACHMENTS')) : '',
					'UNAPPROVED_IMG'		=> ($topic_unapproved || $posts_unapproved) ? $this->user->img('icon_topic_unapproved', $topic_unapproved ? 'TOPIC_UNAPPROVED' : 'POSTS_UNAPPROVED') : '',

					'S_UNREAD_TOPIC'		=> $unread_topic,
					'S_TOPIC_REPORTED'		=> !empty($row['topic_reported']) && $this->auth->acl_get('m_report', $similar_forum_id),
					'S_TOPIC_UNAPPROVED'	=> $topic_unapproved,
					'S_POSTS_UNAPPROVED'	=> $posts_unapproved,
					'S_HAS_POLL'			=> (bool) $row['poll_start'],

					'U_NEWEST_POST'			=> append_sid("{$this->root_path}viewtopic.$this->php_ext", $view_topic_url_params . '&view=unread') . '#unread',
					'U_LAST_POST'			=> append_sid("{$this->root_path}viewtopic.$this->php_ext", $view_topic_url_params . '&p=' . $row['topic_last_post_id']) . '#p' . $row['topic_last_post_id'],
					'U_VIEW_TOPIC'			=> $base_url,
					'U_VIEW_FORUM'			=> append_sid("{$this->root_path}viewforum.$this->php_ext", 'f=' . $similar_forum_id),
					'U_MCP_REPORT'			=> append_sid("{$this->root_path}mcp.$this->php_ext", 'i=reports&mode=reports&' . $view_topic_url_params, true, $this->user->session_id),
					'U_MCP_QUEUE'			=> $u_mcp_queue,
				);

				/**
				 * Event to modify the similar topics template block
				 *
				 * @event vse.similartopics.modify_topicrow
				 * @var array row       Array with similar topic data
				 * @var array topic_row Template block array
				 * @since 1.3.0
				 */
				$vars = array('row', 'topic_row');
				extract($this->dispatcher->trigger_event('vse.similartopics.modify_topicrow', compact($vars)));

				$this->template->assign_block_vars('similar', $topic_row);

				$this->pagination->generate_template_pagination($base_url, 'similar.pagination', 'start', $replies + 1, $this->config['posts_per_page'], 1, true, true);
			}
		}

		$this->language->add_lang('similar_topics', 'vse/similartopics');

		$this->template->assign_vars(array(
			'NEWEST_POST_IMG'	=> $this->user->img('icon_topic_newest', 'VIEW_NEWEST_POST'),
			'LAST_POST_IMG'		=> $this->user->img('icon_topic_latest', 'VIEW_LATEST_POST'),
			'REPORTED_IMG'		=> $this->user->img('icon_topic_reported', 'TOPIC_REPORTED'),
			'POLL_IMG'			=> $this->user->img('icon_topic_poll', 'TOPIC_POLL'),
		));
	}

	/**
	 * Clean topic title (and if needed, ignore-words)
	 *
	 * @access public
	 * @param string $text The topic title
	 * @return string The topic title
	 */
	public function clean_topic_title($text)
	{
		// Strip quotes, ampersands
		$text = str_replace(array('"', '&'), '', $text);

		if (!$this->english_lang() || $this->get_ignore_words())
		{
			$text = $this->strip_stop_words($text);
		}

		return $text;
	}

	/**
	 * Remove any non-english and/or custom defined ignore-words
	 *
	 * @access protected
	 * @param string $text The topic title
	 * @return string The topic title
	 */
	protected function strip_stop_words($text)
	{
		$words = array();

		// If non-English, look for a list of stop-words to be ignored
		// in either the core or the extension (deprecated from core)
		if (!$this->english_lang())
		{
			$finder = $this->extension_manager->get_finder();
			$search_ignore_words = $finder
				->set_extensions(array('vse/similartopics'))
				->prefix('search_ignore_words')
				->suffix(".$this->php_ext")
				->extension_directory("/language/{$this->user->lang_name}")
				->core_path("language/{$this->user->lang_name}/")
				->get_files();
			if (current($search_ignore_words))
			{
				include current($search_ignore_words);
			}
		}

		if ($this->get_ignore_words())
		{
			// Merge any custom defined ignore words from the ACP to the stop-words array
			$words = array_merge($this->make_word_array($this->get_ignore_words()), $words);
		}

		// Remove stop-words from the topic title text
		$words = array_diff($this->make_word_array($text), $words);

		// Convert our words array back to a string
		return implode(' ', $words);
	}

	/**
	 * Helper function to split string into an array of words
	 *
	 * @access protected
	 * @param string $text String of plain text words
	 * @return array Array of plaintext words
	 */
	protected function make_word_array($text)
	{
		// Strip out any non-alpha-numeric characters using PCRE regex syntax
		$text = trim(preg_replace('#[^\p{L}\p{N}]+#u', ' ', $text));

		$words = explode(' ', utf8_strtolower($text));

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

		foreach ($words as $key => $word)
		{
			// Strip words of 2 characters or fewer
			if (utf8_strlen(trim($word)) < 3)

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

			{
				unset($words[$key]);
			}
		}

		return $words;
	}

	/**
	 * Check if English is the current user's language
	 *
	 * @access protected
	 * @return bool True if lang is 'en' or 'en_us', false otherwise
	 */
	protected function english_lang()
	{
		return ($this->user->lang_name === 'en' || $this->user->lang_name === 'en_us');
	}

	/**
	 * Get custom ignore words if any were defined for similar topics
	 *
	 * @access protected
	 * @return string|null String of ignore words or null if there are none defined
	 */
	protected function get_ignore_words()
	{
		$key = 'similar_topics_words';

		$cache = $this->cache->get_driver();

		if ($this->ignore_words === null && (($this->ignore_words = $cache->get("_$key")) === false))
		{
			$this->ignore_words = $this->config_text->get($key);

			$cache->put("_$key", $this->ignore_words);
		}

		return $this->ignore_words;
	}
}