similar_topics_module::enable_fulltext_support() - Code Metrics - Inspection of "PostgreSQL support" - iMattPro/similartopics - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#25)

by Matt

created 2018-03-08 18:14 UTC

similar_topics_module::enable_fulltext_support() A

↳ Parent: Project

Complexity

Conditions	3
Paths	4

Size

Total Lines	20
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	9
nc	4
nop	0

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

namespace vse\similartopics\acp;

/**
 * @package acp
 */
class similar_topics_module
{
	/** @var \phpbb\cache\driver\driver_interface */
	protected $cache;

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

	/** @var \phpbb\db\driver\driver_interface */
	protected $db;

	/** @var \vse\similartopics\driver\mysqli|\vse\similartopics\driver\postgres */
	protected $driver;

	/** @var \phpbb\log\log */
	protected $log;

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

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

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

	/** @var string */
	protected $root_path;

	/** @var string */
	protected $php_ext;

	/** @var array */
	protected $times;

	/** @var string */
	public $page_title;

	/** @var string */
	public $tpl_name;

	/** @var string */
	public $u_action;

	/**
	 * ACP module constructor
	 *
	 * @access public
	 */
	public function __construct()
	{
		global $phpbb_container;

		$this->cache     = $phpbb_container->get('cache');
		$this->config    = $phpbb_container->get('config');
		$this->db        = $phpbb_container->get('dbal.conn');
		$this->driver    = $phpbb_container->get('vse.similartopics.driver.manager')->get_driver($this->db->get_sql_layer());
		$this->log       = $phpbb_container->get('log');
		$this->request   = $phpbb_container->get('request');
		$this->template  = $phpbb_container->get('template');
		$this->user      = $phpbb_container->get('user');
		$this->root_path = $phpbb_container->getParameter('core.root_path');
		$this->php_ext   = $phpbb_container->getParameter('core.php_ext');
		$this->times     = array(
			'd' => 86400, // one day
			'w' => 604800, // one week
			'm' => 2626560, // one month
			'y' => 31536000, // one year
		);
	}

	/**
	 * Main ACP module
	 *
	 * @access public
	 */
	public function main()
	{
		$this->user->add_lang_ext('vse/similartopics', 'acp_similar_topics');

		$this->tpl_name = 'acp_similar_topics';
		$this->page_title = $this->user->lang('PST_TITLE_ACP');

		$form_key = 'acp_similar_topics';
		add_form_key($form_key);

		$action = $this->request->variable('action', '');

		switch ($action)
		{
			case 'advanced':
				$forum_id = $this->request->variable('f', 0);

				if ($this->request->is_set_post('submit'))
				{
					$this->check_form_key($form_key);

					$similar_topic_forums = $this->request->variable('similar_forums_id', array(0));
					$similar_topic_forums = !empty($similar_topic_forums) ? json_encode($similar_topic_forums) : '';

					$sql = 'UPDATE ' . FORUMS_TABLE . "
						SET similar_topic_forums = '" . $this->db->sql_escape($similar_topic_forums) . "'
						WHERE forum_id = $forum_id";
					$this->db->sql_query($sql);

					$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'PST_LOG_MSG');

					$this->end('PST_SAVED');
				}

				$forum_name = '';
				$selected = array();
				if ($forum_id > 0)
				{
					$sql = 'SELECT forum_name, similar_topic_forums
						FROM ' . FORUMS_TABLE . "
						WHERE forum_id = $forum_id";
					$result = $this->db->sql_query($sql);
					while ($fid = $this->db->sql_fetchrow($result))
					{
						$selected = json_decode($fid['similar_topic_forums'], true);
						$forum_name = $fid['forum_name'];
					}
					$this->db->sql_freeresult($result);
				}

				$this->template->assign_vars(array(
					'S_ADVANCED_SETTINGS'		=> true,
					'SIMILAR_FORUMS_OPTIONS'	=> make_forum_select($selected, false, false, true),
					'PST_FORUM_NAME'			=> $forum_name,
					'PST_ADVANCED_EXP'			=> $this->user->lang('PST_ADVANCED_EXP', $forum_name),
					'U_ACTION'					=> $this->u_action . '&amp;action=advanced&amp;f=' . $forum_id,
					'U_BACK'					=> $this->u_action,
				));
			break;

			default:
				if ($this->request->is_set_post('submit'))
				{
					$this->check_form_key($form_key);

					// Set basic config settings
					$this->config->set('similar_topics', $this->request->variable('pst_enable', 0));
					$this->config->set('similar_topics_limit', abs($this->request->variable('pst_limit', 0))); // use abs for positive values only
					$this->config->set('similar_topics_cache', abs($this->request->variable('pst_cache', 0))); // use abs for positive values only
					$this->config->set('similar_topics_words', $this->request->variable('pst_words', '', true));

					// Set sensitivity
					$pst_sense = min(abs($this->request->variable('pst_sense', 5)), 10); // use abs for positive values only
					$this->config->set('similar_topics_sense', $pst_sense);

					// Set date/time config settings
					$pst_time = abs($this->request->variable('pst_time', 0)); // use abs for positive values only
					$pst_time_type = $this->request->variable('pst_time_type', '');
					$this->config->set('similar_topics_type', $pst_time_type);
					$this->config->set('similar_topics_time', $this->set_pst_time($pst_time, $pst_time_type));

					// Set checkbox array form data
					$this->update_forum('similar_topics_hide', $this->request->variable('mark_noshow_forum', array(0), true));
					$this->update_forum('similar_topics_ignore', $this->request->variable('mark_ignore_forum', array(0), true));

					$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'PST_LOG_MSG');

					$this->cache->destroy('sql', TOPICS_TABLE);

					$this->end('PST_SAVED');
				}

				// Build the time options select menu
				$time_options = array(
					'd' => $this->user->lang('PST_DAYS'),
					'w' => $this->user->lang('PST_WEEKS'),
					'm' => $this->user->lang('PST_MONTHS'),
					'y' => $this->user->lang('PST_YEARS')
				);
				foreach ($time_options as $value => $label)
				{
					$this->template->assign_block_vars('similar_time_options', array(
						'VALUE'			=> $value,
						'LABEL'			=> $label,
						'S_SELECTED'	=> $value === $this->config['similar_topics_type'],
					));
				}

				$this->template->assign_vars(array(
					'S_PST_ENABLE'		=> $this->isset_or_default($this->config['similar_topics'], false),
					'PST_LIMIT'			=> $this->isset_or_default($this->config['similar_topics_limit'], ''),
					'PST_CACHE'			=> $this->isset_or_default($this->config['similar_topics_cache'], ''),
					'PST_SENSE'			=> $this->isset_or_default($this->config['similar_topics_sense'], ''),
					'PST_WORDS'			=> $this->isset_or_default($this->config['similar_topics_words'], ''),
					'PST_TIME'			=> $this->get_pst_time($this->config['similar_topics_time'], $this->config['similar_topics_type']),
					'S_PST_NO_COMPAT'	=> $this->driver === null || !$this->fulltext_support_enabled(),
					'U_ACTION'			=> $this->u_action,
				));

				$forum_list = $this->get_forum_list();
				foreach ($forum_list as $row)
				{
					$this->template->assign_block_vars('forums', array(
						'FORUM_NAME'			=> $row['forum_name'],
						'FORUM_ID'				=> $row['forum_id'],
						'CHECKED_IGNORE_FORUM'	=> $row['similar_topics_ignore'] ? 'checked="checked"' : '',
						'CHECKED_NOSHOW_FORUM'	=> $row['similar_topics_hide'] ? 'checked="checked"' : '',
						'S_IS_ADVANCED'			=> (bool) $row['similar_topic_forums'],
						'U_ADVANCED'			=> "{$this->u_action}&amp;action=advanced&amp;f=" . $row['forum_id'],
						'U_FORUM'				=> append_sid("{$this->root_path}viewforum.{$this->php_ext}", 'f=' . $row['forum_id']),
					));
				}
			break;
		}
	}

	/**
	 * Check form key, trigger error if invalid
	 *
	 * @access protected
	 * @param string $form_key The form key value
	 */
	protected function check_form_key($form_key)
	{
		if (!check_form_key($form_key))
		{
			$this->end('FORM_INVALID', E_USER_WARNING);
		}
	}

	/**
	 * Get forums list
	 *
	 * @access protected
	 * @return array forum data rows
	 */
	protected function get_forum_list()
	{
		$sql = 'SELECT forum_id, forum_name, similar_topic_forums, similar_topics_hide, similar_topics_ignore
			FROM ' . FORUMS_TABLE . '
			WHERE forum_type = ' . FORUM_POST . '
			ORDER BY left_id ASC';
		$result = $this->db->sql_query($sql);
		$forum_list = $this->db->sql_fetchrowset($result);
		$this->db->sql_freeresult($result);

		return $forum_list;
	}

	/**
	 * Update the similar topics columns in the forums table
	 *
	 * @param string $column    The name of the column to update
	 * @param array  $forum_ids An array of forum_ids
	 */
	protected function update_forum($column, $forum_ids)
	{
		$this->db->sql_transaction('begin');

		// Set marked forums (in set) to 1
		$sql = 'UPDATE ' . FORUMS_TABLE . "
			SET $column = 1
			WHERE " . $this->db->sql_in_set('forum_id', $forum_ids, false, true);
		$this->db->sql_query($sql);

		// Set unmarked forums (not in set) to 0
		$sql = 'UPDATE ' . FORUMS_TABLE . "
			SET $column = 0
			WHERE " . $this->db->sql_in_set('forum_id', $forum_ids, true, true);
		$this->db->sql_query($sql);

		$this->db->sql_transaction('commit');
	}

	/**
	 * Calculate the time in seconds based on requested time period length
	 *
	 * @access protected
	 * @param int    $length user entered value
	 * @param string $type   years, months, weeks, days (y|m|w|d)
	 * @return int time in seconds
	 */
	protected function set_pst_time($length, $type = 'y')
	{
		$type = isset($this->times[$type]) ? $type : 'y';

		return (int) ($length * $this->times[$type]);
	}

	/**
	 * Get the correct time period length value for the form
	 *
	 * @access protected
	 * @param int    $time as a timestamp
	 * @param string $type years, months, weeks, days (y|m|w|d)
	 * @return int time converted to the given $type
	 */
	protected function get_pst_time($time, $type = '')
	{
		return isset($this->times[$type]) ? (int) round($time / $this->times[$type]) : 0;
	}

	/**
	 * Check for FULLTEXT index support
	 *
	 * @access protected
	 * @return bool True if FULLTEXT is fully supported, false otherwise
	 */
	protected function fulltext_support_enabled()
	{
		if ($this->driver->is_supported())
		{
			return $this->driver->is_index('topic_title');
		}

		return false;
	}

	/**
	 * Return a variable if it is set, otherwise default
	 *
	 * @access protected
	 * @param mixed $var     The variable to test
	 * @param mixed $default The default value to use
	 * @return mixed The value of the variable if set, otherwise default value
	 */
	protected function isset_or_default($var, $default)
	{
		return null !== $var ? $var : $default;
	}

	/**
	 * End script execution with a trigger_error message
	 *
	 * @access protected
	 * @param string $message Language key string
	 * @param int    $code    E_USER_NOTICE|E_USER_WARNING
	 * @return void
	 */
	protected function end($message, $code = E_USER_NOTICE)
	{
		trigger_error($this->user->lang($message) . adm_back_link($this->u_action), $code);
	}
}


1			<?php
2			/**
3			*
4			* Precise Similar Topics
5			*
6			* @copyright (c) 2013 Matt Friedman
7			* @license GNU General Public License, version 2 (GPL-2.0)
8			*
9			*/
10
11			namespace vse\similartopics\acp;
12
13			/**
14			* @package acp
15			*/
16			class similar_topics_module
17			{
18			/** @var \phpbb\cache\driver\driver_interface */
19			protected $cache;
20
21			/** @var \phpbb\config\config */
22			protected $config;
23
24			/** @var \phpbb\db\driver\driver_interface */
25			protected $db;
26
27			/** @var \vse\similartopics\driver\mysqli\|\vse\similartopics\driver\postgres */
28			protected $driver;
29
30			/** @var \phpbb\log\log */
31			protected $log;
32
33			/** @var \phpbb\request\request */
34			protected $request;
35
36			/** @var \phpbb\template\template */
37			protected $template;
38
39			/** @var \phpbb\user */
40			protected $user;
41
42			/** @var string */
43			protected $root_path;
44
45			/** @var string */
46			protected $php_ext;
47
48			/** @var array */
49			protected $times;
50
51			/** @var string */
52			public $page_title;
53
54			/** @var string */
55			public $tpl_name;
56
57			/** @var string */
58			public $u_action;
59
60			/**
61			* ACP module constructor
62			*
63			* @access public
64			*/
65			public function __construct()
66			{
67			global $phpbb_container;
68
69			$this->cache = $phpbb_container->get('cache');
70			$this->config = $phpbb_container->get('config');
71			$this->db = $phpbb_container->get('dbal.conn');
72			$this->driver = $phpbb_container->get('vse.similartopics.driver.manager')->get_driver($this->db->get_sql_layer());
73			$this->log = $phpbb_container->get('log');
74			$this->request = $phpbb_container->get('request');
75			$this->template = $phpbb_container->get('template');
76			$this->user = $phpbb_container->get('user');
77			$this->root_path = $phpbb_container->getParameter('core.root_path');
78			$this->php_ext = $phpbb_container->getParameter('core.php_ext');
79			$this->times = array(
80			'd' => 86400, // one day
81			'w' => 604800, // one week
82			'm' => 2626560, // one month
83			'y' => 31536000, // one year
84			);
85			}
86
87			/**
88			* Main ACP module
89			*
90			* @access public
91			*/
92			public function main()
93			{
94			$this->user->add_lang_ext('vse/similartopics', 'acp_similar_topics');
95
96			$this->tpl_name = 'acp_similar_topics';
97			$this->page_title = $this->user->lang('PST_TITLE_ACP');
98
99			$form_key = 'acp_similar_topics';
100			add_form_key($form_key);
101
102			$action = $this->request->variable('action', '');
103
104			switch ($action)
105			{
106			case 'advanced':
107			$forum_id = $this->request->variable('f', 0);
108
109			if ($this->request->is_set_post('submit'))
110			{
111			$this->check_form_key($form_key);
112
113			$similar_topic_forums = $this->request->variable('similar_forums_id', array(0));
114			$similar_topic_forums = !empty($similar_topic_forums) ? json_encode($similar_topic_forums) : '';
115
116			$sql = 'UPDATE ' . FORUMS_TABLE . "
117			SET similar_topic_forums = '" . $this->db->sql_escape($similar_topic_forums) . "'
118			WHERE forum_id = $forum_id";
119			$this->db->sql_query($sql);
120
121			$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'PST_LOG_MSG');
122
123			$this->end('PST_SAVED');
124			}
125
126			$forum_name = '';
127			$selected = array();
128			if ($forum_id > 0)
129			{
130			$sql = 'SELECT forum_name, similar_topic_forums
131			FROM ' . FORUMS_TABLE . "
132			WHERE forum_id = $forum_id";
133			$result = $this->db->sql_query($sql);
134			while ($fid = $this->db->sql_fetchrow($result))
135			{
136			$selected = json_decode($fid['similar_topic_forums'], true);
137			$forum_name = $fid['forum_name'];
138			}
139			$this->db->sql_freeresult($result);
140			}
141
142			$this->template->assign_vars(array(
143			'S_ADVANCED_SETTINGS' => true,
144			'SIMILAR_FORUMS_OPTIONS' => make_forum_select($selected, false, false, true),
145			'PST_FORUM_NAME' => $forum_name,
146			'PST_ADVANCED_EXP' => $this->user->lang('PST_ADVANCED_EXP', $forum_name),
147			'U_ACTION' => $this->u_action . '&action=advanced&f=' . $forum_id,
148			'U_BACK' => $this->u_action,
149			));
150			break;
151
152			default:
153			if ($this->request->is_set_post('submit'))
154			{
155			$this->check_form_key($form_key);
156
157			// Set basic config settings
158			$this->config->set('similar_topics', $this->request->variable('pst_enable', 0));
159			$this->config->set('similar_topics_limit', abs($this->request->variable('pst_limit', 0))); // use abs for positive values only
160			$this->config->set('similar_topics_cache', abs($this->request->variable('pst_cache', 0))); // use abs for positive values only
161			$this->config->set('similar_topics_words', $this->request->variable('pst_words', '', true));
162
163			// Set sensitivity
164			$pst_sense = min(abs($this->request->variable('pst_sense', 5)), 10); // use abs for positive values only
165			$this->config->set('similar_topics_sense', $pst_sense);
166
167			// Set date/time config settings
168			$pst_time = abs($this->request->variable('pst_time', 0)); // use abs for positive values only
169			$pst_time_type = $this->request->variable('pst_time_type', '');
170			$this->config->set('similar_topics_type', $pst_time_type);
171			$this->config->set('similar_topics_time', $this->set_pst_time($pst_time, $pst_time_type));
172
173			// Set checkbox array form data
174			$this->update_forum('similar_topics_hide', $this->request->variable('mark_noshow_forum', array(0), true));
175			$this->update_forum('similar_topics_ignore', $this->request->variable('mark_ignore_forum', array(0), true));
176
177			$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'PST_LOG_MSG');
178
179			$this->cache->destroy('sql', TOPICS_TABLE);
180
181			$this->end('PST_SAVED');
182			}
183
184			// Build the time options select menu
185			$time_options = array(
186			'd' => $this->user->lang('PST_DAYS'),
187			'w' => $this->user->lang('PST_WEEKS'),
188			'm' => $this->user->lang('PST_MONTHS'),
189			'y' => $this->user->lang('PST_YEARS')
190			);
191			foreach ($time_options as $value => $label)
192			{
193			$this->template->assign_block_vars('similar_time_options', array(
194			'VALUE' => $value,
195			'LABEL' => $label,
196			'S_SELECTED' => $value === $this->config['similar_topics_type'],
197			));
198			}
199
200			$this->template->assign_vars(array(
201			'S_PST_ENABLE' => $this->isset_or_default($this->config['similar_topics'], false),
202			'PST_LIMIT' => $this->isset_or_default($this->config['similar_topics_limit'], ''),
203			'PST_CACHE' => $this->isset_or_default($this->config['similar_topics_cache'], ''),
204			'PST_SENSE' => $this->isset_or_default($this->config['similar_topics_sense'], ''),
205			'PST_WORDS' => $this->isset_or_default($this->config['similar_topics_words'], ''),
206			'PST_TIME' => $this->get_pst_time($this->config['similar_topics_time'], $this->config['similar_topics_type']),
207			'S_PST_NO_COMPAT' => $this->driver === null \|\| !$this->fulltext_support_enabled(),
208			'U_ACTION' => $this->u_action,
209			));
210
211			$forum_list = $this->get_forum_list();
212			foreach ($forum_list as $row)
213			{
214			$this->template->assign_block_vars('forums', array(
215			'FORUM_NAME' => $row['forum_name'],
216			'FORUM_ID' => $row['forum_id'],
217			'CHECKED_IGNORE_FORUM' => $row['similar_topics_ignore'] ? 'checked="checked"' : '',
218			'CHECKED_NOSHOW_FORUM' => $row['similar_topics_hide'] ? 'checked="checked"' : '',
219			'S_IS_ADVANCED' => (bool) $row['similar_topic_forums'],
220			'U_ADVANCED' => "{$this->u_action}&action=advanced&f=" . $row['forum_id'],
221			'U_FORUM' => append_sid("{$this->root_path}viewforum.{$this->php_ext}", 'f=' . $row['forum_id']),
222			));
223			}
224			break;
225			}
226			}
227
228			/**
229			* Check form key, trigger error if invalid
230			*
231			* @access protected
232			* @param string $form_key The form key value
233			*/
234			protected function check_form_key($form_key)
235			{
236			if (!check_form_key($form_key))
237			{
238			$this->end('FORM_INVALID', E_USER_WARNING);
239			}
240			}
241
242			/**
243			* Get forums list
244			*
245			* @access protected
246			* @return array forum data rows
247			*/
248			protected function get_forum_list()
249			{
250			$sql = 'SELECT forum_id, forum_name, similar_topic_forums, similar_topics_hide, similar_topics_ignore
251			FROM ' . FORUMS_TABLE . '
252			WHERE forum_type = ' . FORUM_POST . '
253			ORDER BY left_id ASC';
254			$result = $this->db->sql_query($sql);
255			$forum_list = $this->db->sql_fetchrowset($result);
256			$this->db->sql_freeresult($result);
257
258			return $forum_list;
259			}
260
261			/**
262			* Update the similar topics columns in the forums table
263			*
264			* @param string $column The name of the column to update
265			* @param array $forum_ids An array of forum_ids
266			*/
267			protected function update_forum($column, $forum_ids)
268			{
269			$this->db->sql_transaction('begin');
270
271			// Set marked forums (in set) to 1
272			$sql = 'UPDATE ' . FORUMS_TABLE . "
273			SET $column = 1
274			WHERE " . $this->db->sql_in_set('forum_id', $forum_ids, false, true);
275			$this->db->sql_query($sql);
276
277			// Set unmarked forums (not in set) to 0
278			$sql = 'UPDATE ' . FORUMS_TABLE . "
279			SET $column = 0
280			WHERE " . $this->db->sql_in_set('forum_id', $forum_ids, true, true);
281			$this->db->sql_query($sql);
282
283			$this->db->sql_transaction('commit');
284			}
285
286			/**
287			* Calculate the time in seconds based on requested time period length
288			*
289			* @access protected
290			* @param int $length user entered value
291			* @param string $type years, months, weeks, days (y\|m\|w\|d)
292			* @return int time in seconds
293			*/
294			protected function set_pst_time($length, $type = 'y')
295			{
296			$type = isset($this->times[$type]) ? $type : 'y';
297
298			return (int) ($length * $this->times[$type]);
299			}
300
301			/**
302			* Get the correct time period length value for the form
303			*
304			* @access protected
305			* @param int $time as a timestamp
306			* @param string $type years, months, weeks, days (y\|m\|w\|d)
307			* @return int time converted to the given $type
308			*/
309			protected function get_pst_time($time, $type = '')
310			{
311			return isset($this->times[$type]) ? (int) round($time / $this->times[$type]) : 0;
312			}
313
314			/**
315			* Check for FULLTEXT index support
316			*
317			* @access protected
318			* @return bool True if FULLTEXT is fully supported, false otherwise
319			*/
320			protected function fulltext_support_enabled()
321			{
322			if ($this->driver->is_supported())
323			{
324			return $this->driver->is_index('topic_title');
325			}
326
327			return false;
328			}
329
330			/**
331			* Return a variable if it is set, otherwise default
332			*
333			* @access protected
334			* @param mixed $var The variable to test
335			* @param mixed $default The default value to use
336			* @return mixed The value of the variable if set, otherwise default value
337			*/
338			protected function isset_or_default($var, $default)
339			{
340			return null !== $var ? $var : $default;
341			}
342
343			/**
344			* End script execution with a trigger_error message
345			*
346			* @access protected
347			* @param string $message Language key string
348			* @param int $code E_USER_NOTICE\|E_USER_WARNING
349			* @return void
350			*/
351			protected function end($message, $code = E_USER_NOTICE)
352			{
353			trigger_error($this->user->lang($message) . adm_back_link($this->u_action), $code);
354			}
355			}
356

iMattPro / similartopics

Pull Request — master (#25)

similar_topics_module::enable_fulltext_support() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like