admin_controller::list_ads() - Code Metrics - Inspection of "Ad CRUD in ACP" - phpbb-extensions/ad-management - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

by Jakub

created 2017-05-25 19:28 UTC

admin_controller::list_ads() B

↳ Parent: admin_controller

Complexity

Conditions	3
Paths	2

Size

Total Lines	26
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
c	3
b	0
f	1
dl	0
loc	26
ccs	0
cts	23
cp	0
rs	8.8571
cc	3
eloc	17
nc	2
nop	0
crap	12

<?php
/**
 *
 * Advertisement management. An extension for the phpBB Forum Software package.
 *
 * @copyright (c) 2017 phpBB Limited <https://www.phpbb.com>
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace phpbb\admanagement\controller;

/**
* Admin controller
*/
class admin_controller
{
	const MAX_NAME_LENGTH = 255;

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

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

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

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

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

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

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

	/** @var string Custom form action */
	protected $u_action;

	/**
	* Constructor
	*
	* @param \phpbb\db\driver\driver_interface	$db					DB driver interface
	* @param \phpbb\template\template			$template			Template object
	* @param \phpbb\user						$user				User object
	* @param \phpbb\request\request				$request			Request object
	* @param string								$ads_table			Ads table
	* @param string								$php_ext			PHP extension
	* @param string								$phpbb_admin_path	Path to admin
	*/
	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\template\template $template, \phpbb\user $user, \phpbb\request\request $request, $ads_table, $php_ext, $phpbb_admin_path)
	{
		$this->db = $db;
		$this->template = $template;
		$this->user = $user;
		$this->request = $request;
		$this->ads_table = $ads_table;
		$this->php_ext = $php_ext;
		$this->phpbb_admin_path = $phpbb_admin_path;
	}

	/**
	* Set page url
	*
	* @param string $u_action Custom form action
	* @return void
	*/
	public function set_page_url($u_action)
	{
		$this->u_action = $u_action;
	}

	/**
	* Load module-specific language
	*
	* @return void
	*/
	public function load_lang()
	{
		$this->user->add_lang_ext('phpbb/admanagement', 'acp');
	}

	/**
	* Get ACP page title for Ads module
	*
	* @return string	Language string for Ads ACP module
	*/
	public function get_page_title()
	{
		return $this->user->lang('ACP_ADMANAGEMENT_TITLE');
	}

	/**
	* Get action
	*
	* @return string	Ads module action
	*/
	public function get_action()
	{
		return $this->request->variable('action', '');
	}

	/**
	* Add an advertisement
	*
	* @return void
	*/
	public function action_add()
	{
		$errors = array();

		add_form_key('phpbb/admanagement/add');
		if ($this->request->is_set_post('submit'))
		{
			if (!check_form_key('phpbb/admanagement/add'))
			{
				$errors[] = $this->user->lang('FORM_INVALID');
			}

			$data = array(
				'ad_name'		=> $this->request->variable('ad_name', '', true),
				'ad_note'		=> $this->request->variable('ad_note', '', true),
				'ad_code'		=> $this->request->variable('ad_code', '', true),
				'ad_enabled'	=> $this->request->variable('ad_enabled', false),
			);

			// Validate data
			if ($data['ad_name'] === '')
			{
				$errors[] = $this->user->lang('AD_NAME_REQUIRED');
			}
			if (truncate_string($data['ad_name'], self::MAX_NAME_LENGTH) !== $data['ad_name'])

			{
				$errors[] = $this->user->lang('AD_NAME_TOO_LONG', self::MAX_NAME_LENGTH);
			}

			if (empty($errors))
			{
				// Insert the ad data to the database
				$sql = 'INSERT INTO ' . $this->ads_table . ' ' . $this->db->sql_build_array('INSERT', $data);
				$this->db->sql_query($sql);

				$this->success('ACP_AD_ADD_SUCCESS');
			}
			else
			{
				$this->template->assign_vars(array(
					'S_ERROR'			=> (bool) count($errors),
					'ERROR_MSG'			=> count($errors) ? implode('<br />', $errors) : '',

					'AD_NAME'		=> $data['ad_name'],
					'AD_NOTE'		=> $data['ad_note'],
					'AD_CODE'		=> $data['ad_code'],
					'AD_ENABLED'	=> $data['ad_enabled'],
				));
			}
		}

		// Set output vars for display in the template
		$this->template->assign_vars(array(
			'S_ADD_AD'	=> true,
			'U_BACK'	=> $this->u_action,
		));
	}

	/**
	* Edit an advertisement
	*
	* @return void
	*/
	public function action_edit()
	{
		$ad_id = $this->request->variable('id', 0);
		$errors = array();

		add_form_key('phpbb/admanagement/edit');
		if ($this->request->is_set_post('submit'))
		{
			if (!check_form_key('phpbb/admanagement/edit'))
			{
				$errors[] = $this->user->lang('FORM_INVALID');
			}

			$data = array(
				'ad_name'		=> $this->request->variable('ad_name', '', true),
				'ad_note'		=> $this->request->variable('ad_note', '', true),
				'ad_code'		=> $this->request->variable('ad_code', '', true),
				'ad_enabled'	=> $this->request->variable('ad_enabled', false),
			);

			// Validate data
			if ($data['ad_name'] === '')
			{
				$errors[] = $this->user->lang('AD_NAME_REQUIRED');
			}
			if (truncate_string($data['ad_name'], self::MAX_NAME_LENGTH) !== $data['ad_name'])

			{
				$errors[] = $this->user->lang('AD_NAME_TOO_LONG', self::MAX_NAME_LENGTH);
			}

			if (empty($errors))
			{
				// Insert the ad data to the database
				$sql = 'UPDATE ' . $this->ads_table . '
					SET ' . $this->db->sql_build_array('UPDATE', $data) . '
					WHERE ad_id = ' . (int) $ad_id;
				$this->db->sql_query($sql);

				$this->success('ACP_AD_EDIT_SUCCESS');
			}
			else
			{
				$this->template->assign_vars(array(
					'S_ERROR'			=> (bool) count($errors),
					'ERROR_MSG'			=> count($errors) ? implode('<br />', $errors) : '',
				));
			}
		}
		else
		{
			$sql = 'SELECT *
				FROM ' . $this->ads_table . '
				WHERE ad_id = ' . (int) $ad_id;
			$result = $this->db->sql_query($sql);
			$data = $this->db->sql_fetchrow($result);
			$this->db->sql_freeresult($result);

			if (empty($data))
			{
				$this->error('ACP_AD_DOES_NOT_EXIST');
			}
		}

		// Set output vars for display in the template
		$this->template->assign_vars(array(
			'S_EDIT_AD'	=> true,
			'EDIT_ID'	=> $ad_id,
			'U_BACK'	=> $this->u_action,

			'AD_NAME'		=> $data['ad_name'],
			'AD_NOTE'		=> $data['ad_note'],
			'AD_CODE'		=> $data['ad_code'],
			'AD_ENABLED'	=> $data['ad_enabled'],
		));
	}

	/**
	* Enable/disable an advertisement
	*
	* @param	bool	$enable	Enable or disable the advertisement?
	* @return void
	*/
	public function ad_enable($enable)
	{
		$sql = 'UPDATE ' . $this->ads_table . '
			SET ad_enabled = ' . (int) $enable . '
			WHERE ad_id = ' . (int) $this->request->variable('id', 0);
		$this->db->sql_query($sql);
		$success = (bool) $this->db->sql_affectedrows();

		// If AJAX was used, show user a result message
		if ($this->request->is_ajax())
		{
			$json_response = new \phpbb\json_response;
			$json_response->send(array(
				'text'	=> $this->user->lang($enable ? 'ENABLED' : 'DISABLED'),
				'title'	=> $this->user->lang('AD_ENABLE_TITLE', (int) $enable),
			));
		}

		// Otherwise, show traditional infobox
		if ($success)
		{
			$this->success($enable ? 'ACP_AD_ENABLE_SUCCESS' : 'ACP_AD_DISABLE_SUCCESS');
		}
		else
		{
			$this->error($enable ? 'ACP_AD_ENABLE_ERRORED' : 'ACP_AD_DISABLE_ERRORED');
		}
	}

	/**
	* Delete an advertisement
	*
	* @return void
	*/
	public function action_delete()
	{
		$ad_id = $this->request->variable('id', 0);
		if ($ad_id)
		{
			if (confirm_box(true))
			{
				$sql = 'DELETE FROM ' . $this->ads_table . '
					WHERE ad_id = ' . (int) $ad_id;
				$this->db->sql_query($sql);

				// Only notify user on error
				if (!$this->db->sql_affectedrows())
				{
					$this->error('ACP_AD_DELETE_ERRORED');
				}
			}
			else
			{
				confirm_box(false, $this->user->lang('CONFIRM_OPERATION'), build_hidden_fields(array(
					'id'		=> $ad_id,
					'i'			=> $this->request->variable('i', ''),
					'mode'		=> $this->request->variable('mode', ''),
					'action'	=> 'delete'))
				);
			}
		}
	}


	/**
	* Display the ads
	*
	* @return void
	*/
	public function list_ads()
	{
		$sql = 'SELECT ad_id, ad_name, ad_enabled
			FROM ' . $this->ads_table;
		$result = $this->db->sql_query($sql);
		while ($row = $this->db->sql_fetchrow($result))
		{
			$ad_enabled = (bool) $row['ad_enabled'];

			$this->template->assign_block_vars('ads', array(
				'NAME'		=> $row['ad_name'],
				'S_ENABLED'	=> (int) $ad_enabled,
				'U_ENABLE'	=> $this->u_action . '&amp;action=' . ($ad_enabled ? 'disable' : 'enable') . '&amp;id=' . $row['ad_id'],
				'U_PREVIEW'	=> append_sid(generate_board_url() . '/index.' . $this->php_ext, 'ad_preview=' . $row['ad_id']),
				'U_EDIT'	=> $this->u_action . '&amp;action=edit&amp;id=' . $row['ad_id'],
				'U_DELETE'	=> $this->u_action . '&amp;action=delete&amp;id=' . $row['ad_id'],
			));
		}
		$this->db->sql_freeresult($result);

		// Set output vars for display in the template
		$this->template->assign_vars(array(
			'U_ACTION_ADD'	=> $this->u_action . '&amp;action=add',
			'ICON_PREVIEW'	=> '<img src="' . htmlspecialchars($this->phpbb_admin_path) . 'images/file_up_to_date.gif" alt="' . $this->user->lang('AD_PREVIEW') . '" title="' . $this->user->lang('AD_PREVIEW') . '" />',
		));
	}

	/**
	* @param	mixed	...$lang	Input to $user->lang()
	*/
	protected function success()
	{
		trigger_error(call_user_func_array(array($this->user, 'lang'), func_get_args()) . adm_back_link($this->u_action));
	}

	/**
	* @param	mixed	...$lang	Input to $user->lang()
	*/
	protected function error()
	{
		trigger_error(call_user_func_array(array($this->user, 'lang'), func_get_args()) . adm_back_link($this->u_action), E_USER_WARNING);
	}
}


1		<?php
2		/**
3		*
4		* Advertisement management. An extension for the phpBB Forum Software package.
5		*
6		* @copyright (c) 2017 phpBB Limited <https://www.phpbb.com>
7		* @license GNU General Public License, version 2 (GPL-2.0)
8		*
9		*/
10
11		namespace phpbb\admanagement\controller;
12
13		/**
14		* Admin controller
15		*/
16		class admin_controller
17		{
18		const MAX_NAME_LENGTH = 255;
19
20		/** @var \phpbb\db\driver\driver_interface */
21		protected $db;
22
23		/** @var \phpbb\template\template */
24		protected $template;
25
26		/** @var \phpbb\user */
27		protected $user;
28
29		/** @var \phpbb\request\request */
30		protected $request;
31
32		/** @var string ads_table */
33		protected $ads_table;
34
35		/** @var string php_ext */
36		protected $php_ext;
37
38		/** @var string phpbb_admin_path */
39		protected $phpbb_admin_path;
40
41		/** @var string Custom form action */
42		protected $u_action;
43
44		/**
45		* Constructor
46		*
47		* @param \phpbb\db\driver\driver_interface $db DB driver interface
48		* @param \phpbb\template\template $template Template object
49		* @param \phpbb\user $user User object
50		* @param \phpbb\request\request $request Request object
51		* @param string $ads_table Ads table
52		* @param string $php_ext PHP extension
53		* @param string $phpbb_admin_path Path to admin
54		*/
55		public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\template\template $template, \phpbb\user $user, \phpbb\request\request $request, $ads_table, $php_ext, $phpbb_admin_path)
56		{
57		$this->db = $db;
58		$this->template = $template;
59		$this->user = $user;
60		$this->request = $request;
61		$this->ads_table = $ads_table;
62		$this->php_ext = $php_ext;
63		$this->phpbb_admin_path = $phpbb_admin_path;
64		}
65
66		/**
67		* Set page url
68		*
69		* @param string $u_action Custom form action
70		* @return void
71		*/
72		public function set_page_url($u_action)
73		{
74		$this->u_action = $u_action;
75		}
76
77		/**
78		* Load module-specific language
79		*
80		* @return void
81		*/
82		public function load_lang()
83		{
84		$this->user->add_lang_ext('phpbb/admanagement', 'acp');
85		}
86
87		/**
88		* Get ACP page title for Ads module
89		*
90		* @return string Language string for Ads ACP module
91		*/
92		public function get_page_title()
93		{
94		return $this->user->lang('ACP_ADMANAGEMENT_TITLE');
95		}
96
97		/**
98		* Get action
99		*
100		* @return string Ads module action
101		*/
102		public function get_action()
103		{
104		return $this->request->variable('action', '');
105		}
106
107		/**
108		* Add an advertisement
109		*
110		* @return void
111		*/
112		public function action_add()
113		{
114		$errors = array();
115
116		add_form_key('phpbb/admanagement/add');
117		if ($this->request->is_set_post('submit'))
118		{
119		if (!check_form_key('phpbb/admanagement/add'))
120		{
121		$errors[] = $this->user->lang('FORM_INVALID');
122		}
123
124		$data = array(
125		'ad_name' => $this->request->variable('ad_name', '', true),
126		'ad_note' => $this->request->variable('ad_note', '', true),
127		'ad_code' => $this->request->variable('ad_code', '', true),
128		'ad_enabled' => $this->request->variable('ad_enabled', false),
129		);
130
131		// Validate data
132		if ($data['ad_name'] === '')
133		{
134		$errors[] = $this->user->lang('AD_NAME_REQUIRED');
135		}
136	View Code Duplication	if (truncate_string($data['ad_name'], self::MAX_NAME_LENGTH) !== $data['ad_name'])
		0 ignored issues – show Duplication introduced 2017-05-25 09:53 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
137		{
138		$errors[] = $this->user->lang('AD_NAME_TOO_LONG', self::MAX_NAME_LENGTH);
139		}
140
141		if (empty($errors))
142		{
143		// Insert the ad data to the database
144		$sql = 'INSERT INTO ' . $this->ads_table . ' ' . $this->db->sql_build_array('INSERT', $data);
145		$this->db->sql_query($sql);
146
147		$this->success('ACP_AD_ADD_SUCCESS');
148		}
149		else
150		{
151		$this->template->assign_vars(array(
152		'S_ERROR' => (bool) count($errors),
153		'ERROR_MSG' => count($errors) ? implode('<br />', $errors) : '',
154
155		'AD_NAME' => $data['ad_name'],
156		'AD_NOTE' => $data['ad_note'],
157		'AD_CODE' => $data['ad_code'],
158		'AD_ENABLED' => $data['ad_enabled'],
159		));
160		}
161		}
162
163		// Set output vars for display in the template
164		$this->template->assign_vars(array(
165		'S_ADD_AD' => true,
166		'U_BACK' => $this->u_action,
167		));
168		}
169
170		/**
171		* Edit an advertisement
172		*
173		* @return void
174		*/
175		public function action_edit()
176		{
177		$ad_id = $this->request->variable('id', 0);
178		$errors = array();
179
180		add_form_key('phpbb/admanagement/edit');
181		if ($this->request->is_set_post('submit'))
182		{
183		if (!check_form_key('phpbb/admanagement/edit'))
184		{
185		$errors[] = $this->user->lang('FORM_INVALID');
186		}
187
188		$data = array(
189		'ad_name' => $this->request->variable('ad_name', '', true),
190		'ad_note' => $this->request->variable('ad_note', '', true),
191		'ad_code' => $this->request->variable('ad_code', '', true),
192		'ad_enabled' => $this->request->variable('ad_enabled', false),
193		);
194
195		// Validate data
196		if ($data['ad_name'] === '')
197		{
198		$errors[] = $this->user->lang('AD_NAME_REQUIRED');
199		}
200	View Code Duplication	if (truncate_string($data['ad_name'], self::MAX_NAME_LENGTH) !== $data['ad_name'])
		0 ignored issues – show Duplication introduced 2017-05-25 09:53 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
201		{
202		$errors[] = $this->user->lang('AD_NAME_TOO_LONG', self::MAX_NAME_LENGTH);
203		}
204
205		if (empty($errors))
206		{
207		// Insert the ad data to the database
208		$sql = 'UPDATE ' . $this->ads_table . '
209		SET ' . $this->db->sql_build_array('UPDATE', $data) . '
210		WHERE ad_id = ' . (int) $ad_id;
211		$this->db->sql_query($sql);
212
213		$this->success('ACP_AD_EDIT_SUCCESS');
214		}
215		else
216		{
217		$this->template->assign_vars(array(
218		'S_ERROR' => (bool) count($errors),
219		'ERROR_MSG' => count($errors) ? implode('<br />', $errors) : '',
220		));
221		}
222		}
223		else
224		{
225		$sql = 'SELECT *
226		FROM ' . $this->ads_table . '
227		WHERE ad_id = ' . (int) $ad_id;
228		$result = $this->db->sql_query($sql);
229		$data = $this->db->sql_fetchrow($result);
230		$this->db->sql_freeresult($result);
231
232		if (empty($data))
233		{
234		$this->error('ACP_AD_DOES_NOT_EXIST');
235		}
236		}
237
238		// Set output vars for display in the template
239		$this->template->assign_vars(array(
240		'S_EDIT_AD' => true,
241		'EDIT_ID' => $ad_id,
242		'U_BACK' => $this->u_action,
243
244		'AD_NAME' => $data['ad_name'],
245		'AD_NOTE' => $data['ad_note'],
246		'AD_CODE' => $data['ad_code'],
247		'AD_ENABLED' => $data['ad_enabled'],
248		));
249		}
250
251		/**
252		* Enable/disable an advertisement
253		*
254		* @param bool $enable Enable or disable the advertisement?
255		* @return void
256		*/
257		public function ad_enable($enable)
258		{
259		$sql = 'UPDATE ' . $this->ads_table . '
260		SET ad_enabled = ' . (int) $enable . '
261		WHERE ad_id = ' . (int) $this->request->variable('id', 0);
262		$this->db->sql_query($sql);
263		$success = (bool) $this->db->sql_affectedrows();
264
265		// If AJAX was used, show user a result message
266		if ($this->request->is_ajax())
267		{
268		$json_response = new \phpbb\json_response;
269		$json_response->send(array(
270		'text' => $this->user->lang($enable ? 'ENABLED' : 'DISABLED'),
271		'title' => $this->user->lang('AD_ENABLE_TITLE', (int) $enable),
272		));
273		}
274
275		// Otherwise, show traditional infobox
276		if ($success)
277		{
278		$this->success($enable ? 'ACP_AD_ENABLE_SUCCESS' : 'ACP_AD_DISABLE_SUCCESS');
279		}
280		else
281		{
282		$this->error($enable ? 'ACP_AD_ENABLE_ERRORED' : 'ACP_AD_DISABLE_ERRORED');
283		}
284		}
285
286		/**
287		* Delete an advertisement
288		*
289		* @return void
290		*/
291		public function action_delete()
292		{
293		$ad_id = $this->request->variable('id', 0);
294		if ($ad_id)
295		{
296		if (confirm_box(true))
297		{
298		$sql = 'DELETE FROM ' . $this->ads_table . '
299		WHERE ad_id = ' . (int) $ad_id;
300		$this->db->sql_query($sql);
301
302		// Only notify user on error
303		if (!$this->db->sql_affectedrows())
304		{
305		$this->error('ACP_AD_DELETE_ERRORED');
306		}
307		}
308		else
309		{
310		confirm_box(false, $this->user->lang('CONFIRM_OPERATION'), build_hidden_fields(array(
311		'id' => $ad_id,
312		'i' => $this->request->variable('i', ''),
313		'mode' => $this->request->variable('mode', ''),
314		'action' => 'delete'))
315		);
316		}
317		}
318		}
319
320
321		/**
322		* Display the ads
323		*
324		* @return void
325		*/
326		public function list_ads()
327		{
328		$sql = 'SELECT ad_id, ad_name, ad_enabled
329		FROM ' . $this->ads_table;
330		$result = $this->db->sql_query($sql);
331		while ($row = $this->db->sql_fetchrow($result))
332		{
333		$ad_enabled = (bool) $row['ad_enabled'];
334
335		$this->template->assign_block_vars('ads', array(
336		'NAME' => $row['ad_name'],
337		'S_ENABLED' => (int) $ad_enabled,
338		'U_ENABLE' => $this->u_action . '&action=' . ($ad_enabled ? 'disable' : 'enable') . '&id=' . $row['ad_id'],
339		'U_PREVIEW' => append_sid(generate_board_url() . '/index.' . $this->php_ext, 'ad_preview=' . $row['ad_id']),
340		'U_EDIT' => $this->u_action . '&action=edit&id=' . $row['ad_id'],
341		'U_DELETE' => $this->u_action . '&action=delete&id=' . $row['ad_id'],
342		));
343		}
344		$this->db->sql_freeresult($result);
345
346		// Set output vars for display in the template
347		$this->template->assign_vars(array(
348		'U_ACTION_ADD' => $this->u_action . '&action=add',
349		'ICON_PREVIEW' => '<img src="' . htmlspecialchars($this->phpbb_admin_path) . 'images/file_up_to_date.gif" alt="' . $this->user->lang('AD_PREVIEW') . '" title="' . $this->user->lang('AD_PREVIEW') . '" />',
350		));
351		}
352
353		/**
354		* @param mixed ...$lang Input to $user->lang()
355		*/
356		protected function success()
357		{
358		trigger_error(call_user_func_array(array($this->user, 'lang'), func_get_args()) . adm_back_link($this->u_action));
359		}
360
361		/**
362		* @param mixed ...$lang Input to $user->lang()
363		*/
364		protected function error()
365		{
366		trigger_error(call_user_func_array(array($this->user, 'lang'), func_get_args()) . adm_back_link($this->u_action), E_USER_WARNING);
367		}
368		}
369

phpbb-extensions / ad-management

Pull Request — master (#2)

admin_controller::list_ads() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like