data::_user_can_download_attachments() - Code Metrics - Inspection of "Exclude hidden forums from index" - blitze/phpBB-ext-sitemaker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (a182de)

by Daniel

created 2016-03-14 20:47 UTC

data::_user_can_download_attachments() A

↳ Parent: data

Complexity

Conditions	4
Paths	6

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	4

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	9.2
cc	4
eloc	2
nc	6
nop	1
crap	4

<?php
/**
 *
 * @package sitemaker
 * @copyright (c) 2013 Daniel A. (blitze)
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
 */

namespace blitze\sitemaker\services\forum;

use blitze\sitemaker\services\forum\query_builder;

class data extends query_builder
{
	/** @var \phpbb\auth\auth */
	protected $auth;

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

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

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

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

	/**
	 * Constructor
	 *
	 * @param \phpbb\auth\auth					$auth					Auth object
	 * @param \phpbb\config\config				$config					Config object
	 * @param \phpbb\content_visibility			$content_visibility		Content visibility
	 * @param \phpbb\db\driver\driver_interface	$db     				Database connection
	 * @param \phpbb\user						$user					User object
	 * @param integer							$cache_time				Cache results for 3 hours by default
	 */
	public function __construct(\phpbb\auth\auth $auth, \phpbb\config\config $config, \phpbb\content_visibility $content_visibility, \phpbb\db\driver\driver_interface $db, \phpbb\user $user, $cache_time = 10800)
	{
		parent::__construct($auth, $config, $content_visibility, $db, $user, $cache_time);

		$this->auth = $auth;
		$this->config = $config;
		$this->content_visibility = $content_visibility;
		$this->db = $db;
		$this->user = $user;
	}

	/**
	 * Get topic data
	 *
	 * @param mixed|false $limit
	 * @param int $start
	 * @return array
	 */
	public function get_topic_data($limit = false, $start = 0)
	{
		$sql = $this->db->sql_build_query('SELECT', $this->store['sql_array']);
		$result = $this->db->sql_query_limit($sql, $limit, $start, $this->cache_time);

		while ($row = $this->db->sql_fetchrow($result))
		{
			$this->store['topic'][$row['topic_id']] = $row;

			$this->store['tracking'][$row['forum_id']]['topic_list'][] = $row['topic_id'];
			$this->store['tracking'][$row['forum_id']]['mark_time'] =& $row['forum_mark_time'];
			$this->store['post_ids']['first'][] = $row['topic_first_post_id'];
			$this->store['post_ids']['last'][] = $row['topic_last_post_id'];
		}
		$this->db->sql_freeresult($result);

		return $this->store['topic'];
	}

	/**
	 * Get post data
	 *
	 * @param mixed|false $topic_first_or_last_post (first|last)
	 * @param array $post_ids
	 * @param bool|false $limit
	 * @param int $start
	 * @param array $sql_array
	 * @return array
	 */
	public function get_post_data($topic_first_or_last_post = false, $post_ids = array(), $limit = false, $start = 0, $sql_array = array())
	{
		$sql = $this->db->sql_build_query('SELECT_DISTINCT', $this->_get_posts_sql_array($topic_first_or_last_post, $post_ids, $sql_array));
		$result = $this->db->sql_query_limit($sql, $limit, $start, $this->cache_time);

		$post_data = array();
		while ($row = $this->db->sql_fetchrow($result))
		{
			$post_data[$row['topic_id']][$row['post_id']] = $row;
			$this->store['poster_ids'][] = $row['poster_id'];
			$this->store['poster_ids'][] = $row['post_edit_user'];
			$this->store['poster_ids'][] = $row['post_delete_user'];
			$this->store['attachments'][] = $row['post_id'];
		}
		$this->db->sql_freeresult($result);

		return $post_data;
	}

	/**
	 * Get attachments...
	 *
	 * @param int $forum_id
	 * @param array $allowed_extensions
	 * @param bool $exclude_in_message
	 * @param string $order_by
	 * @return array
	 */
	public function get_attachments($forum_id = 0, $allowed_extensions = array(), $exclude_in_message = true, $order_by = 'filetime DESC, post_msg_id ASC')
	{
		$this->store['attachments'] = array_filter($this->store['attachments']);

		$attachments = array();
		if ($this->_attachments_allowed($forum_id))
		{
			$sql = $this->_get_attachment_sql($allowed_extensions, $exclude_in_message, $order_by);
			$result = $this->db->sql_query($sql);

			while ($row = $this->db->sql_fetchrow($result))
			{
				$attachments[$row['post_msg_id']][] = $row;
			}
			$this->db->sql_freeresult($result);
		}
		$this->store['attachments'] = array();

		return $attachments;
	}

	/**
	 * Get topic tracking info
	 *
	 * @param int $forum_id
	 * @return array
	 */
	public function get_topic_tracking_info($forum_id = 0)
	{
		if (!sizeof($this->store['tracking']))
		{
			return array();
		}

		$tracking_info = $this->_get_tracking_info();

		return ($forum_id) ? (isset($tracking_info[$forum_id]) ? $tracking_info[$forum_id] : array()) : $tracking_info;
	}

	/**
	 * Returns an array of topic first post or last post ids
	 *
	 * @param string $first_or_last_post
	 * @return array
	 */
	public function get_topic_post_ids($first_or_last_post = 'first')
	{
		return (isset($this->store['post_ids'][$first_or_last_post])) ? $this->store['post_ids'][$first_or_last_post] : array();
	}

	/**
	 * @param mixed $topic_first_or_last_post
	 * @param array $post_ids
	 * @param array $sql_array
	 * @return array
	 */
	private function _get_posts_sql_array($topic_first_or_last_post, array $post_ids, array $sql_array)
	{
		$sql_array = array_merge_recursive(
			array(
				'SELECT'	=> array('p.*'),
				'FROM'		=> array(POSTS_TABLE => 'p'),
				'WHERE'		=> $this->_get_post_data_where($post_ids, $topic_first_or_last_post),
				'ORDER_BY'	=> 'p.topic_id, p.post_time ASC',
			),
			$sql_array
		);

		$sql_array['SELECT'] = join(', ', array_filter($sql_array['SELECT']));
		$sql_array['WHERE'] = join(' AND ', array_filter($sql_array['WHERE']));

		return $sql_array;
	}

	/**
	 * @param array $post_ids
	 * @param string $topic_first_or_last_post
	 * @return array
	 */
	private function _get_post_data_where(array $post_ids, $topic_first_or_last_post)
	{
		$sql_where = array();

		if (sizeof($post_ids))
		{
			$sql_where[] = $this->db->sql_in_set('p.post_id', $post_ids);
		}
		else if (sizeof($this->store['topic']))
		{
			$this->_limit_posts_by_topic($sql_where, $topic_first_or_last_post);
		}

		$sql_where[] = $this->content_visibility->get_global_visibility_sql('post', $this->ex_fid_ary, 'p.');

		return $sql_where;
	}

	/**
	 * @param array $sql_where
	 * @param string $topic_first_or_last_post
	 */
	private function _limit_posts_by_topic(array &$sql_where, $topic_first_or_last_post)
	{
		$sql_where[] = $this->db->sql_in_set('p.topic_id', array_keys($this->store['topic']));

		if ($topic_first_or_last_post)
		{
			$sql_where[] = $this->db->sql_in_set('p.post_id', $this->get_topic_post_ids($topic_first_or_last_post));
		}
	}

	/**
	 * @return array
	 */
	private function _get_tracking_info()
	{
		$info = array();
		if ($this->_can_track_by_lastread())
		{
			$info = $this->_build_tracking_info('get_topic_tracking');
		}
		else if ($this->_can_track_anonymous())
		{
			$info = $this->_build_tracking_info('get_complete_topic_tracking');
		}

		return $info;
	}

	/**
	 * @param string $function
	 * @return array
	 */
	private function _build_tracking_info($function)
	{
		$tracking_info = array();
		foreach ($this->store['tracking'] as $fid => $forum)
		{
			$tracking_info[$fid] = call_user_func_array($function, array($fid, $forum['topic_list'], &$this->store['topic'], array($fid => $forum['mark_time'])));
		}

		return $tracking_info;
	}

	/**
	 * @return bool
	 */
	private function _can_track_by_lastread()
	{
		return ($this->config['load_db_lastread'] && $this->user->data['is_registered']) ? true : false;
	}

	/**
	 * @return bool
	 */
	private function _can_track_anonymous()
	{
		return ($this->config['load_anon_lastread'] || $this->user->data['is_registered']) ? true : false;
	}

	/**
	 * @param int $forum_id
	 * @return bool
	 */
	private function _attachments_allowed($forum_id)
	{
		return ($this->store['attachments'] && $this->_user_can_download_attachments($forum_id)) ? true : false;
	}

	/**
	 * @param int $forum_id
	 * @return bool
	 */
	private function _user_can_download_attachments($forum_id)
	{
		return ($this->auth->acl_get('u_download') && (!$forum_id || $this->auth->acl_get('f_download', $forum_id))) ? true : false;
	}

	/**
	 * @param array $allowed_extensions
	 * @param bool $exclude_in_message
	 * @param string $order_by
	 * @return string
	 */
	private function _get_attachment_sql($allowed_extensions, $exclude_in_message, $order_by)
	{
		return 'SELECT *
			FROM ' . ATTACHMENTS_TABLE . '
			WHERE ' . $this->db->sql_in_set('post_msg_id', $this->store['attachments']) .
				(($exclude_in_message) ? ' AND in_message = 0' : '') .
				(sizeof($allowed_extensions) ? ' AND ' . $this->db->sql_in_set('extension', $allowed_extensions) : '') . '
			ORDER BY ' . $order_by;
	}
}


1		<?php
2		/**
3		*
4		* @package sitemaker
5		* @copyright (c) 2013 Daniel A. (blitze)
6		* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
7		*
8		*/
9
10		namespace blitze\sitemaker\services\forum;
11
12		use blitze\sitemaker\services\forum\query_builder;
13
14		class data extends query_builder
15		{
16		/** @var \phpbb\auth\auth */
17		protected $auth;
18
19		/** @var \phpbb\config\config */
20		protected $config;
21
22		/** @var \phpbb\content_visibility */
23		protected $content_visibility;
24
25		/** @var \phpbb\db\driver\driver_interface */
26		protected $db;
27
28		/** @var \phpbb\user */
29		protected $user;
30
31		/**
32		* Constructor
33		*
34		* @param \phpbb\auth\auth $auth Auth object
35		* @param \phpbb\config\config $config Config object
36		* @param \phpbb\content_visibility $content_visibility Content visibility
37		* @param \phpbb\db\driver\driver_interface $db Database connection
38		* @param \phpbb\user $user User object
39		* @param integer $cache_time Cache results for 3 hours by default
40		*/
41	26	public function __construct(\phpbb\auth\auth $auth, \phpbb\config\config $config, \phpbb\content_visibility $content_visibility, \phpbb\db\driver\driver_interface $db, \phpbb\user $user, $cache_time = 10800)
42		{
43	26	parent::__construct($auth, $config, $content_visibility, $db, $user, $cache_time);
44
45	26	$this->auth = $auth;
46	26	$this->config = $config;
47	26	$this->content_visibility = $content_visibility;
48	26	$this->db = $db;
49	26	$this->user = $user;
50	26	}
51
52		/**
53		* Get topic data
54		*
55		* @param mixed\|false $limit
56		* @param int $start
57		* @return array
58		*/
59	12	public function get_topic_data($limit = false, $start = 0)
60		{
61	12	$sql = $this->db->sql_build_query('SELECT', $this->store['sql_array']);
62	12	$result = $this->db->sql_query_limit($sql, $limit, $start, $this->cache_time);
63
64	12	while ($row = $this->db->sql_fetchrow($result))
65		{
66	10	$this->store['topic'][$row['topic_id']] = $row;
67
68	10	$this->store['tracking'][$row['forum_id']]['topic_list'][] = $row['topic_id'];
69	10	$this->store['tracking'][$row['forum_id']]['mark_time'] =& $row['forum_mark_time'];
70	10	$this->store['post_ids']['first'][] = $row['topic_first_post_id'];
71	10	$this->store['post_ids']['last'][] = $row['topic_last_post_id'];
72	10	}
73	12	$this->db->sql_freeresult($result);
74
75	12	return $this->store['topic'];
76		}
77
78		/**
79		* Get post data
80		*
81		* @param mixed\|false $topic_first_or_last_post (first\|last)
82		* @param array $post_ids
83		* @param bool\|false $limit
84		* @param int $start
85		* @param array $sql_array
86		* @return array
87		*/
88	10	public function get_post_data($topic_first_or_last_post = false, $post_ids = array(), $limit = false, $start = 0, $sql_array = array())
89		{
90	10	$sql = $this->db->sql_build_query('SELECT_DISTINCT', $this->_get_posts_sql_array($topic_first_or_last_post, $post_ids, $sql_array));
91	10	$result = $this->db->sql_query_limit($sql, $limit, $start, $this->cache_time);
92
93	10	$post_data = array();
94	10	while ($row = $this->db->sql_fetchrow($result))
95		{
96	9	$post_data[$row['topic_id']][$row['post_id']] = $row;
97	9	$this->store['poster_ids'][] = $row['poster_id'];
98	9	$this->store['poster_ids'][] = $row['post_edit_user'];
99	9	$this->store['poster_ids'][] = $row['post_delete_user'];
100	9	$this->store['attachments'][] = $row['post_id'];
101	9	}
102	10	$this->db->sql_freeresult($result);
103
104	10	return $post_data;
105		}
106
107		/**
108		* Get attachments...
109		*
110		* @param int $forum_id
111		* @param array $allowed_extensions
112		* @param bool $exclude_in_message
113		* @param string $order_by
114		* @return array
115		*/
116	7	public function get_attachments($forum_id = 0, $allowed_extensions = array(), $exclude_in_message = true, $order_by = 'filetime DESC, post_msg_id ASC')
117		{
118	7	$this->store['attachments'] = array_filter($this->store['attachments']);
119
120	7	$attachments = array();
121	7	if ($this->_attachments_allowed($forum_id))
122	7	{
123	6	$sql = $this->_get_attachment_sql($allowed_extensions, $exclude_in_message, $order_by);
124	6	$result = $this->db->sql_query($sql);
125
126	6	while ($row = $this->db->sql_fetchrow($result))
127		{
128	6	$attachments[$row['post_msg_id']][] = $row;
129	6	}
130	6	$this->db->sql_freeresult($result);
131	6	}
132	7	$this->store['attachments'] = array();
133
134	7	return $attachments;
135		}
136
137		/**
138		* Get topic tracking info
139		*
140		* @param int $forum_id
141		* @return array
142		*/
143	5	public function get_topic_tracking_info($forum_id = 0)
144		{
145	5	if (!sizeof($this->store['tracking']))
146	5	{
147		return array();
148		}
149
150	5	$tracking_info = $this->_get_tracking_info();
151
152	5	return ($forum_id) ? (isset($tracking_info[$forum_id]) ? $tracking_info[$forum_id] : array()) : $tracking_info;
153		}
154
155		/**
156		* Returns an array of topic first post or last post ids
157		*
158		* @param string $first_or_last_post
159		* @return array
160		*/
161	3	public function get_topic_post_ids($first_or_last_post = 'first')
162		{
163	3	return (isset($this->store['post_ids'][$first_or_last_post])) ? $this->store['post_ids'][$first_or_last_post] : array();
164		}
165
166		/**
167		* @param mixed $topic_first_or_last_post
168		* @param array $post_ids
169		* @param array $sql_array
170		* @return array
171		*/
172	10	private function _get_posts_sql_array($topic_first_or_last_post, array $post_ids, array $sql_array)
173		{
174	10	$sql_array = array_merge_recursive(
175		array(
176	10	'SELECT' => array('p.*'),
177	10	'FROM' => array(POSTS_TABLE => 'p'),
178	10	'WHERE' => $this->_get_post_data_where($post_ids, $topic_first_or_last_post),
179	10	'ORDER_BY' => 'p.topic_id, p.post_time ASC',
180	10	),
181		$sql_array
182	10	);
183
184	10	$sql_array['SELECT'] = join(', ', array_filter($sql_array['SELECT']));
185	10	$sql_array['WHERE'] = join(' AND ', array_filter($sql_array['WHERE']));
186
187	10	return $sql_array;
188		}
189
190		/**
191		* @param array $post_ids
192		* @param string $topic_first_or_last_post
193		* @return array
194		*/
195	10	private function _get_post_data_where(array $post_ids, $topic_first_or_last_post)
196		{
197	10	$sql_where = array();
198
199	10	if (sizeof($post_ids))
200	10	{
201	2	$sql_where[] = $this->db->sql_in_set('p.post_id', $post_ids);
202	2	}
203	8	else if (sizeof($this->store['topic']))
204	8	{
205	3	$this->_limit_posts_by_topic($sql_where, $topic_first_or_last_post);
206	3	}
207
208	10	$sql_where[] = $this->content_visibility->get_global_visibility_sql('post', $this->ex_fid_ary, 'p.');
209
210	10	return $sql_where;
211		}
212
213		/**
214		* @param array $sql_where
215		* @param string $topic_first_or_last_post
216		*/
217	3	private function _limit_posts_by_topic(array &$sql_where, $topic_first_or_last_post)
218		{
219	3	$sql_where[] = $this->db->sql_in_set('p.topic_id', array_keys($this->store['topic']));
220
221		if ($topic_first_or_last_post)
222	3	{
223	3	$sql_where[] = $this->db->sql_in_set('p.post_id', $this->get_topic_post_ids($topic_first_or_last_post));
224	3	}
225	3	}
226
227		/**
228		* @return array
229		*/
230	5	private function _get_tracking_info()
231		{
232	5	$info = array();
233	5	if ($this->_can_track_by_lastread())
234	5	{
235	4	$info = $this->_build_tracking_info('get_topic_tracking');
236	4	}
237	1	else if ($this->_can_track_anonymous())
238	1	{
239	1	$info = $this->_build_tracking_info('get_complete_topic_tracking');
240	1	}
241
242	5	return $info;
243		}
244
245		/**
246		* @param string $function
247		* @return array
248		*/
249	5	private function _build_tracking_info($function)
250		{
251	5	$tracking_info = array();
252	5	foreach ($this->store['tracking'] as $fid => $forum)
253		{
254	5	$tracking_info[$fid] = call_user_func_array($function, array($fid, $forum['topic_list'], &$this->store['topic'], array($fid => $forum['mark_time'])));
255	5	}
256
257	5	return $tracking_info;
258		}
259
260		/**
261		* @return bool
262		*/
263	5	private function _can_track_by_lastread()
264		{
265	5	return ($this->config['load_db_lastread'] && $this->user->data['is_registered']) ? true : false;
266		}
267
268		/**
269		* @return bool
270		*/
271	1	private function _can_track_anonymous()
272		{
273	1	return ($this->config['load_anon_lastread'] \|\| $this->user->data['is_registered']) ? true : false;
274		}
275
276		/**
277		* @param int $forum_id
278		* @return bool
279		*/
280	7	private function _attachments_allowed($forum_id)
281		{
282	7	return ($this->store['attachments'] && $this->_user_can_download_attachments($forum_id)) ? true : false;
283		}
284
285		/**
286		* @param int $forum_id
287		* @return bool
288		*/
289	6	private function _user_can_download_attachments($forum_id)
290		{
291	6	return ($this->auth->acl_get('u_download') && (!$forum_id \|\| $this->auth->acl_get('f_download', $forum_id))) ? true : false;
292		}
293
294		/**
295		* @param array $allowed_extensions
296		* @param bool $exclude_in_message
297		* @param string $order_by
298		* @return string
299		*/
300	6	private function _get_attachment_sql($allowed_extensions, $exclude_in_message, $order_by)
301		{
302		return 'SELECT *
303	6	FROM ' . ATTACHMENTS_TABLE . '
304	6	WHERE ' . $this->db->sql_in_set('post_msg_id', $this->store['attachments']) .
305	6	(($exclude_in_message) ? ' AND in_message = 0' : '') .
306	6	(sizeof($allowed_extensions) ? ' AND ' . $this->db->sql_in_set('extension', $allowed_extensions) : '') . '
307	6	ORDER BY ' . $order_by;
308		}
309		}
310

blitze / phpBB-ext-sitemaker

Branch — master (a182de)

data::_user_can_download_attachments() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like