admin_controller - Code Metrics - Inspection of "Merge pull request #31 from senky/adblock" - phpbb-extensions/ad-management - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b1273e...07a024 )

by Matt

created 2017-06-19 17:22 UTC

admin_controller C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	573
Duplicated Lines	5.06 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

92.09%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	64
c	1
b	0
f	0
lcom	1
cbo	2
dl	29
loc	573
ccs	256
cts	278
cp	0.9209
rs	5.8364

21 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	mode_manage()	0	14	2
C	mode_settings()	0	45	7
A	set_page_url()	0	4	1
A	get_page_title()	0	4	1
B	action_add()	13	40	5
B	action_edit()	16	56	7
A	action_enable()	0	4	1
A	action_disable()	0	4	1
B	action_delete()	0	40	5
C	list_ads()	0	27	7
A	setup()	0	6	1
B	ad_enable()	0	28	6
C	get_form_data()	0	48	7
A	assign_form_data()	0	13	2
A	prepare_end_date()	0	14	3
A	assign_locations()	0	12	3
A	ad_preview()	0	4	1
A	success()	0	4	1
A	error()	0	4	1
A	log()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like admin_controller often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use admin_controller, and based on these observations, apply Extract Interface, too.

<?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\ads\controller;

/**
* Admin controller
*/
class admin_controller
{
	const MAX_NAME_LENGTH = 255;
	const DATE_FORMAT = 'Y-m-d';

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

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

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

	/** @var \phpbb\ads\ad\manager */
	protected $manager;

	/** @var \phpbb\ads\location\manager */
	protected $location_manager;

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

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

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

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

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

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

	/** @var array Form validation errors */
	protected $errors = array();

	/**
	* Constructor
	*
	* @param \phpbb\template\template				$template			Template object
	* @param \phpbb\user							$user				User object
	* @param \phpbb\request\request					$request			Request object
	* @param \phpbb\ads\ad\manager					$manager			Advertisement manager object
	* @param \phpbb\ads\location\manager			$location_manager	Template location manager object
	* @param \phpbb\log\log							$log				The phpBB log system
	* @param \phpbb\config\db_text					$config_text		Config text object
	* @param \phpbb\config\config					$config				Config object
	* @param string									$php_ext			PHP extension
	* @param string									$ext_path			Path to this extension
	*/
	public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\request\request $request, \phpbb\ads\ad\manager $manager, \phpbb\ads\location\manager $location_manager, \phpbb\log\log $log, \phpbb\config\db_text $config_text, \phpbb\config\config $config, $php_ext, $ext_path)
	{
		$this->template = $template;
		$this->user = $user;
		$this->request = $request;
		$this->manager = $manager;
		$this->location_manager = $location_manager;
		$this->log = $log;
		$this->config_text = $config_text;
		$this->config = $config;
		$this->php_ext = $php_ext;
		$this->ext_path = $ext_path;
	}

	/**
	* Process user request for manage mode
	*
	* @return void
	*/
	public function mode_manage()
	{
		$this->setup();

		// Trigger specific action
		$action = $this->request->variable('action', '');
		if (in_array($action, array('add', 'edit', 'enable', 'disable', 'delete')))
		{
			$this->{'action_' . $action}();
		}

		// Otherwise default to this
		$this->list_ads();
	}

	/**
	* Process user request for settings mode
	*
	* @return void
	*/
	public function mode_settings()
	{
		$this->setup();

		add_form_key('phpbb/ads/settings');
		if ($this->request->is_set_post('submit'))
		{
			// Validate form key
			if (!check_form_key('phpbb/ads/settings'))
			{
				$this->errors[] = $this->user->lang('FORM_INVALID');
			}

			if (empty($this->errors))
			{
				$this->config->set('phpbb_ads_adblocker_message', $this->request->variable('adblocker_message', 0));
				$this->config_text->set('phpbb_ads_hide_groups', json_encode($this->request->variable('hide_groups', array(0))));

				$this->success('ACP_AD_SETTINGS_SAVED');
			}

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

		$hide_groups = json_decode($this->config_text->get('phpbb_ads_hide_groups'), true);
		$groups = $this->manager->load_groups();
		foreach ($groups as $group)
		{
			$group_name = ($group['group_type'] == GROUP_SPECIAL) ? $this->user->lang('G_' . $group['group_name']) : $group['group_name'];

			$this->template->assign_block_vars('groups', array(
				'ID'			=> $group['group_id'],
				'NAME'			=> $group_name,
				'S_SELECTED'	=> in_array($group['group_id'], $hide_groups),
			));
		}

		$this->template->assign_vars(array(
			'U_ACTION'			=> $this->u_action,
			'ADBLOCKER_MESSAGE'	=> $this->config['phpbb_ads_adblocker_message'],
		));
	}

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

	/**
	* 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_PHPBB_ADS_TITLE');
	}

	/**
	* Add an advertisement
	*
	* @return void
	*/
	public function action_add()
	{
		$preview = $this->request->is_set_post('preview');
		$submit = $this->request->is_set_post('submit');

		add_form_key('phpbb/ads/add');
		if ($preview || $submit)
		{
			$data = $this->get_form_data('phpbb/ads/add');

			if ($preview)
			{
				$this->ad_preview($data['ad_code']);
			}
			else if (empty($this->errors))
			{
				$ad_id = $this->manager->insert_ad($data);
				$this->manager->insert_ad_locations($ad_id, $data['ad_locations']);

				$this->log('ADD', $data['ad_name']);

				$this->success('ACP_AD_ADD_SUCCESS');
			}

			$this->assign_locations($data);
			$this->assign_form_data($data);
		}
		else
		{
			$this->assign_locations();
		}

		// Set output vars for display in the template
		$this->template->assign_vars(array(
			'S_ADD_AD'				=> true,
			'U_BACK'				=> $this->u_action,
			'U_ACTION'				=> "{$this->u_action}&amp;action=add",
			'PICKER_DATE_FORMAT'	=> self::DATE_FORMAT,
		));
	}

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

		add_form_key('phpbb/ads/edit/' . $ad_id);
		if ($preview || $submit)
		{
			$data = $this->get_form_data('phpbb/ads/edit/' . $ad_id);

			if ($preview)
			{
				$this->ad_preview($data['ad_code']);
			}
			else if (empty($this->errors))
			{
				$success = $this->manager->update_ad($ad_id, $data);

				if ($success)
				{
					// Only insert new ad locations to DB when ad exists
					$this->manager->delete_ad_locations($ad_id);
					$this->manager->insert_ad_locations($ad_id, $data['ad_locations']);

					$this->log('EDIT', $data['ad_name']);

					$this->success('ACP_AD_EDIT_SUCCESS');
				}
				$this->error('ACP_AD_DOES_NOT_EXIST');
			}
		}
		else
		{
			// Load ad data
			$data = $this->manager->get_ad($ad_id);
			if (empty($data))
			{
				$this->error('ACP_AD_DOES_NOT_EXIST');
			}

			// Load ad template locations
			$data['ad_locations'] = $this->manager->get_ad_locations($ad_id);
		}

		// 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,
			'U_ACTION'				=> "{$this->u_action}&amp;action=edit&amp;id=" . $ad_id,
			'PICKER_DATE_FORMAT'	=> self::DATE_FORMAT,
		));
		$this->assign_locations($data);
		$this->assign_form_data($data);
	}

	/**
	* Enable an advertisement
	*
	* @return void
	*/
	public function action_enable()
	{
		$this->ad_enable(true);
	}

	/**
	* Disable an advertisement
	*
	* @return void
	*/
	public function action_disable()
	{
		$this->ad_enable(false);
	}

	/**
	* Delete an advertisement
	*
	* @return void
	*/
	public function action_delete()
	{
		$ad_id = $this->request->variable('id', 0);
		if ($ad_id)
		{
			if (confirm_box(true))
			{
				// Get ad data so that we can log ad name
				$ad_data = $this->manager->get_ad($ad_id);

				// Delete ad and it's template locations
				$this->manager->delete_ad_locations($ad_id);
				$success = $this->manager->delete_ad($ad_id);

				// Only notify user on error or if not ajax
				if (!$success)
				{
					$this->error('ACP_AD_DELETE_ERRORED');
				}
				else
				{
					$this->log('DELETE', $ad_data['ad_name']);

					if (!$this->request->is_ajax())
					{
						$this->success('ACP_AD_DELETE_SUCCESS');
					}
				}
			}
			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()
	{
		foreach ($this->manager->get_all_ads() as $row)
		{
			$ad_enabled = (int) $row['ad_enabled'];
			$ad_end_date = (int) $row['ad_end_date'];
			$ad_expired = $ad_end_date > 0 && $ad_end_date < time();
			if ($ad_expired && $ad_enabled)
			{
				$ad_enabled = 0;
				$this->manager->update_ad($row['ad_id'], array('ad_enabled' => 0));
			}

			$this->template->assign_block_vars('ads', array(
				'NAME'					=> $row['ad_name'],
				'END_DATE'				=> $ad_end_date ? $this->user->format_date($ad_end_date, self::DATE_FORMAT) : '',
				'S_END_DATE_EXPIRED'	=> $ad_expired,
				'S_ENABLED'				=> $ad_enabled,
				'U_ENABLE'				=> $this->u_action . '&amp;action=' . ($ad_enabled ? 'disable' : 'enable') . '&amp;id=' . $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'],
			));
		}

		// Set output vars for display in the template
		$this->template->assign_var('U_ACTION_ADD', $this->u_action . '&amp;action=add');
	}

	/**
	* Perform general tasks
	*
	* @return void
	*/
	protected function setup()
	{
		$this->user->add_lang_ext('phpbb/ads', 'acp');

		$this->template->assign_var('S_PHPBB_ADS', true);
	}

	/**
	* Enable/disable an advertisement
	*
	* @param	bool	$enable	Enable or disable the advertisement?
	* @return void
	*/
	protected function ad_enable($enable)
	{
		$ad_id = $this->request->variable('id', 0);

		$success = $this->manager->update_ad($ad_id, array(
			'ad_enabled'	=> (int) $enable,
		));

		// 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');
		}
	}

	/**
	* Get admin form data.
	*
	* @param	string	$form_name	The form name.
	* @return	array	Form data
	*/
	protected function get_form_data($form_name)
	{
		$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', 0),
			'ad_locations'	=> $this->request->variable('ad_locations', array('')),
			'ad_end_date'	=> $this->request->variable('ad_end_date', ''),
		);

		// Validate form key
		if (!check_form_key($form_name))
		{
			$this->errors[] = $this->user->lang('FORM_INVALID');
		}

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

		// Validate ad end date
		if (preg_match('#^\d{4}\-\d{2}\-\d{2}$#', $data['ad_end_date']))
		{
			$data['ad_end_date'] = (int) $this->user->get_timestamp_from_format(self::DATE_FORMAT, $data['ad_end_date']);

			if ($data['ad_end_date'] < time())
			{
				$this->errors[] = $this->user->lang('AD_END_DATE_INVALID');
			}
		}
		else if ($data['ad_end_date'] !== '')
		{
			$this->errors[] = $this->user->lang('AD_END_DATE_INVALID');
		}
		else
		{
			$data['ad_end_date'] = 0;
		}

		return $data;
	}

	/**
	* Assign form data to the template.
	*
	* @param	array	$data	The form data.
	* @return void
	*/
	protected function assign_form_data($data)
	{
		$this->template->assign_vars(array(
			'S_ERROR'		=> (bool) count($this->errors),
			'ERROR_MSG'		=> count($this->errors) ? implode('<br />', $this->errors) : '',

			'AD_NAME'		=> $data['ad_name'],
			'AD_NOTE'		=> $data['ad_note'],
			'AD_CODE'		=> $data['ad_code'],
			'AD_ENABLED'	=> $data['ad_enabled'],
			'AD_END_DATE'	=> $this->prepare_end_date($data['ad_end_date']),
		));
	}

	/**
	* Prepare end date for display
	*
	* @param	mixed	$end_date	End date.
	* @return	string	End date prepared for display.
	*/
	protected function prepare_end_date($end_date)
	{
		if (empty($end_date))
		{
			return '';
		}

		if (is_numeric($end_date))
		{
			return $this->user->format_date($end_date, self::DATE_FORMAT);
		}

		return (string) $end_date;
	}

	/**
	* Assign template locations data to the template.
	*
	* @param	mixed	$data	The form data or nothing.
	* @return	void
	*/
	protected function assign_locations($data = false)
	{
		foreach ($this->location_manager->get_all_locations() as $location_id => $location_data)
		{
			$this->template->assign_block_vars('ad_locations', array(
				'LOCATION_ID'	=> $location_id,
				'LOCATION_DESC'	=> $location_data['desc'],
				'LOCATION_NAME'	=> $location_data['name'],
				'S_SELECTED'	=> $data ? in_array($location_id, $data['ad_locations']) : false,
			));
		}
	}

	/**
	* Prepare advertisement preview
	*
	* @param	string	$code	Ad code to preview
	* @return	void
	*/
	protected function ad_preview($code)
	{
		$this->template->assign_var('PREVIEW', htmlspecialchars_decode($code));
	}

	/**
	* Print success message.
	*
	* It takes arguments in the form of a language key, followed by language substitution values.
	*/
	protected function success()
	{
		trigger_error(call_user_func_array(array($this->user, 'lang'), func_get_args()) . adm_back_link($this->u_action));
	}

	/**
	* Print error message.
	*
	* It takes arguments in the form of a language key, followed by language substitution values.
	*/
	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);
	}

	/**
	* Log action
	*
	* @param	string	$action		Performed action in uppercase
	* @param	string	$ad_name	Advertisement name
	* @return	void
	*/
	protected function log($action, $ad_name)
	{
		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'ACP_PHPBB_ADS_' . $action . '_LOG', time(), array($ad_name));
	}
}


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\ads\controller;
12
13			/**
14			* Admin controller
15			*/
16			class admin_controller
17			{
18			const MAX_NAME_LENGTH = 255;
19			const DATE_FORMAT = 'Y-m-d';
20
21			/** @var \phpbb\template\template */
22			protected $template;
23
24			/** @var \phpbb\user */
25			protected $user;
26
27			/** @var \phpbb\request\request */
28			protected $request;
29
30			/** @var \phpbb\ads\ad\manager */
31			protected $manager;
32
33			/** @var \phpbb\ads\location\manager */
34			protected $location_manager;
35
36			/** @var \phpbb\log\log */
37			protected $log;
38
39			/** @var \phpbb\config\db_text */
40			protected $config_text;
41
42			/** @var \phpbb\config\config */
43			protected $config;
44
45			/** @var string php_ext */
46			protected $php_ext;
47
48			/** @var string ext_path */
49			protected $ext_path;
50
51			/** @var string Custom form action */
52			protected $u_action;
53
54			/** @var array Form validation errors */
55			protected $errors = array();
56
57			/**
58			* Constructor
59			*
60			* @param \phpbb\template\template $template Template object
61			* @param \phpbb\user $user User object
62			* @param \phpbb\request\request $request Request object
63			* @param \phpbb\ads\ad\manager $manager Advertisement manager object
64			* @param \phpbb\ads\location\manager $location_manager Template location manager object
65			* @param \phpbb\log\log $log The phpBB log system
66			* @param \phpbb\config\db_text $config_text Config text object
67			* @param \phpbb\config\config $config Config object
68			* @param string $php_ext PHP extension
69			* @param string $ext_path Path to this extension
70			*/
71	34		public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\request\request $request, \phpbb\ads\ad\manager $manager, \phpbb\ads\location\manager $location_manager, \phpbb\log\log $log, \phpbb\config\db_text $config_text, \phpbb\config\config $config, $php_ext, $ext_path)
72			{
73	34		$this->template = $template;
74	34		$this->user = $user;
75	34		$this->request = $request;
76	34		$this->manager = $manager;
77	34		$this->location_manager = $location_manager;
78	34		$this->log = $log;
79	34		$this->config_text = $config_text;
80	34		$this->config = $config;
81	34		$this->php_ext = $php_ext;
82	34		$this->ext_path = $ext_path;
83	34		}
84
85			/**
86			* Process user request for manage mode
87			*
88			* @return void
89			*/
90	6		public function mode_manage()
91			{
92	6		$this->setup();
93
94			// Trigger specific action
95	6		$action = $this->request->variable('action', '');
96	6		if (in_array($action, array('add', 'edit', 'enable', 'disable', 'delete')))
97	6		{
98	5		$this->{'action_' . $action}();
99	5		}
100
101			// Otherwise default to this
102	6		$this->list_ads();
103	6		}
104
105			/**
106			* Process user request for settings mode
107			*
108			* @return void
109			*/
110	3		public function mode_settings()
111			{
112	3		$this->setup();
113
114	3		add_form_key('phpbb/ads/settings');
115	3		if ($this->request->is_set_post('submit'))
116	3		{
117			// Validate form key
118	2		if (!check_form_key('phpbb/ads/settings'))
119	2		{
120	1		$this->errors[] = $this->user->lang('FORM_INVALID');
121	1		}
122
123	2		if (empty($this->errors))
124	2		{
125	1		$this->config->set('phpbb_ads_adblocker_message', $this->request->variable('adblocker_message', 0));
126	1		$this->config_text->set('phpbb_ads_hide_groups', json_encode($this->request->variable('hide_groups', array(0))));
127
128	1		$this->success('ACP_AD_SETTINGS_SAVED');
129			}
130
131	1		$this->template->assign_vars(array(
132	1		'S_ERROR' => (bool) count($this->errors),
133	1		'ERROR_MSG' => count($this->errors) ? implode('<br />', $this->errors) : '',
134	1		));
135	1		}
136
137	2		$hide_groups = json_decode($this->config_text->get('phpbb_ads_hide_groups'), true);
138	2		$groups = $this->manager->load_groups();
139	2		foreach ($groups as $group)
140			{
141	2		$group_name = ($group['group_type'] == GROUP_SPECIAL) ? $this->user->lang('G_' . $group['group_name']) : $group['group_name'];
142
143	2		$this->template->assign_block_vars('groups', array(
144	2		'ID' => $group['group_id'],
145	2		'NAME' => $group_name,
146	2		'S_SELECTED' => in_array($group['group_id'], $hide_groups),
147	2		));
148	2		}
149
150	2		$this->template->assign_vars(array(
151	2		'U_ACTION' => $this->u_action,
152	2		'ADBLOCKER_MESSAGE' => $this->config['phpbb_ads_adblocker_message'],
153	2		));
154	2		}
155
156			/**
157			* Set page url
158			*
159			* @param string $u_action Custom form action
160			* @return void
161			*/
162	28		public function set_page_url($u_action)
163			{
164	28		$this->u_action = $u_action;
165	28		}
166
167			/**
168			* Get ACP page title for Ads module
169			*
170			* @return string Language string for Ads ACP module
171			*/
172	1		public function get_page_title()
173			{
174	1		return $this->user->lang('ACP_PHPBB_ADS_TITLE');
175			}
176
177			/**
178			* Add an advertisement
179			*
180			* @return void
181			*/
182	11		public function action_add()
183			{
184	7		$preview = $this->request->is_set_post('preview');
185	7		$submit = $this->request->is_set_post('submit');
186
187	7		add_form_key('phpbb/ads/add');
188	7		if ($preview \|\| $submit)
189	7		{
190	6		$data = $this->get_form_data('phpbb/ads/add');
191
192		View Code Duplication	if ($preview)
193	6		{
194	1		$this->ad_preview($data['ad_code']);
195	1		}
196	11		else if (empty($this->errors))
197	5		{
198	1		$ad_id = $this->manager->insert_ad($data);
199	1		$this->manager->insert_ad_locations($ad_id, $data['ad_locations']);
200
201	1		$this->log('ADD', $data['ad_name']);
202
203	1		$this->success('ACP_AD_ADD_SUCCESS');
204			}
205
206	5		$this->assign_locations($data);
207	5		$this->assign_form_data($data);
208	5		}
209			else
210			{
211	1		$this->assign_locations();
212			}
213
214			// Set output vars for display in the template
215	6		$this->template->assign_vars(array(
216	6		'S_ADD_AD' => true,
217	6		'U_BACK' => $this->u_action,
218	6		'U_ACTION' => "{$this->u_action}&action=add",
219	6		'PICKER_DATE_FORMAT' => self::DATE_FORMAT,
220	6		));
221	6		}
222
223			/**
224			* Edit an advertisement
225			*
226			* @return void
227			*/
228	9		public function action_edit()
229			{
230	9		$ad_id = $this->request->variable('id', 0);
231	9		$preview = $this->request->is_set_post('preview');
232	9		$submit = $this->request->is_set_post('submit');
233
234	9		add_form_key('phpbb/ads/edit/' . $ad_id);
235	9		if ($preview \|\| $submit)
236	9		{
237	7		$data = $this->get_form_data('phpbb/ads/edit/' . $ad_id);
238
239			if ($preview)
240	7		{
241	1		$this->ad_preview($data['ad_code']);
242	1		}
243		View Code Duplication	else if (empty($this->errors))
244	6		{
245	2		$success = $this->manager->update_ad($ad_id, $data);
246
247			if ($success)
248	2		{
249			// Only insert new ad locations to DB when ad exists
250	1		$this->manager->delete_ad_locations($ad_id);
251	1		$this->manager->insert_ad_locations($ad_id, $data['ad_locations']);
252
253	1		$this->log('EDIT', $data['ad_name']);
254
255	1		$this->success('ACP_AD_EDIT_SUCCESS');
256			}
257	1		$this->error('ACP_AD_DOES_NOT_EXIST');
258			}
259	5		}
260			else
261			{
262			// Load ad data
263	2		$data = $this->manager->get_ad($ad_id);
264	2		if (empty($data))
265	2		{
266	1		$this->error('ACP_AD_DOES_NOT_EXIST');
267			}
268
269			// Load ad template locations
270	1		$data['ad_locations'] = $this->manager->get_ad_locations($ad_id);
271			}
272
273			// Set output vars for display in the template
274	6		$this->template->assign_vars(array(
275	6		'S_EDIT_AD' => true,
276	6		'EDIT_ID' => $ad_id,
277	6		'U_BACK' => $this->u_action,
278	6		'U_ACTION' => "{$this->u_action}&action=edit&id=" . $ad_id,
279	6		'PICKER_DATE_FORMAT' => self::DATE_FORMAT,
280	6		));
281	6		$this->assign_locations($data);
282	6		$this->assign_form_data($data);
283	6		}
284
285			/**
286			* Enable an advertisement
287			*
288			* @return void
289			*/
290	3		public function action_enable()
291			{
292	3		$this->ad_enable(true);
293	1		}
294
295			/**
296			* Disable an advertisement
297			*
298			* @return void
299			*/
300	3		public function action_disable()
301			{
302	3		$this->ad_enable(false);
303	1		}
304
305			/**
306			* Delete an advertisement
307			*
308			* @return void
309			*/
310	3		public function action_delete()
311			{
312	3		$ad_id = $this->request->variable('id', 0);
313			if ($ad_id)
314	3		{
315	3		if (confirm_box(true))
316	3		{
317			// Get ad data so that we can log ad name
318	2		$ad_data = $this->manager->get_ad($ad_id);
319
320			// Delete ad and it's template locations
321	2		$this->manager->delete_ad_locations($ad_id);
322	2		$success = $this->manager->delete_ad($ad_id);
323
324			// Only notify user on error or if not ajax
325	2		if (!$success)
326	2		{
327	1		$this->error('ACP_AD_DELETE_ERRORED');
328			}
329			else
330			{
331	1		$this->log('DELETE', $ad_data['ad_name']);
332
333	1		if (!$this->request->is_ajax())
334	1		{
335	1		$this->success('ACP_AD_DELETE_SUCCESS');
336			}
337			}
338			}
339			else
340			{
341	1		confirm_box(false, $this->user->lang('CONFIRM_OPERATION'), build_hidden_fields(array(
342	1		'id' => $ad_id,
343	1		'i' => $this->request->variable('i', ''),
344	1		'mode' => $this->request->variable('mode', ''),
345			'action' => 'delete'
346	1		)));
347			}
348	1		}
349	1		}
350
351			/**
352			* Display the ads
353			*
354			* @return void
355			*/
356	1		public function list_ads()
357			{
358	1		foreach ($this->manager->get_all_ads() as $row)
359			{
360	1		$ad_enabled = (int) $row['ad_enabled'];
361	1		$ad_end_date = (int) $row['ad_end_date'];
362	1		$ad_expired = $ad_end_date > 0 && $ad_end_date < time();
363	1		if ($ad_expired && $ad_enabled)
364	1		{
365	1		$ad_enabled = 0;
366	1		$this->manager->update_ad($row['ad_id'], array('ad_enabled' => 0));
367	1		}
368
369	1		$this->template->assign_block_vars('ads', array(
370	1		'NAME' => $row['ad_name'],
371	1		'END_DATE' => $ad_end_date ? $this->user->format_date($ad_end_date, self::DATE_FORMAT) : '',
372	1		'S_END_DATE_EXPIRED' => $ad_expired,
373	1		'S_ENABLED' => $ad_enabled,
374	1		'U_ENABLE' => $this->u_action . '&action=' . ($ad_enabled ? 'disable' : 'enable') . '&id=' . $row['ad_id'],
375	1		'U_EDIT' => $this->u_action . '&action=edit&id=' . $row['ad_id'],
376	1		'U_DELETE' => $this->u_action . '&action=delete&id=' . $row['ad_id'],
377	1		));
378	1		}
379
380			// Set output vars for display in the template
381	1		$this->template->assign_var('U_ACTION_ADD', $this->u_action . '&action=add');
382	1		}
383
384			/**
385			* Perform general tasks
386			*
387			* @return void
388			*/
389	9		protected function setup()
390			{
391	9		$this->user->add_lang_ext('phpbb/ads', 'acp');
392
393	9		$this->template->assign_var('S_PHPBB_ADS', true);
394	9		}
395
396			/**
397			* Enable/disable an advertisement
398			*
399			* @param bool $enable Enable or disable the advertisement?
400			* @return void
401			*/
402	4		protected function ad_enable($enable)
403			{
404	4		$ad_id = $this->request->variable('id', 0);
405
406	4		$success = $this->manager->update_ad($ad_id, array(
407	4		'ad_enabled' => (int) $enable,
408	4		));
409
410			// If AJAX was used, show user a result message
411	4		if ($this->request->is_ajax())
412	4		{
413			$json_response = new \phpbb\json_response;
414			$json_response->send(array(
415			'text' => $this->user->lang($enable ? 'ENABLED' : 'DISABLED'),
416			'title' => $this->user->lang('AD_ENABLE_TITLE', (int) $enable),
417			));
418			}
419
420			// Otherwise, show traditional infobox
421			if ($success)
422	4		{
423	2		$this->success($enable ? 'ACP_AD_ENABLE_SUCCESS' : 'ACP_AD_DISABLE_SUCCESS');
424			}
425			else
426			{
427	2		$this->error($enable ? 'ACP_AD_ENABLE_ERRORED' : 'ACP_AD_DISABLE_ERRORED');
428			}
429			}
430
431			/**
432			* Get admin form data.
433			*
434			* @param string $form_name The form name.
435			* @return array Form data
436			*/
437	13		protected function get_form_data($form_name)
438			{
439			$data = array(
440	13		'ad_name' => $this->request->variable('ad_name', '', true),
441	13		'ad_note' => $this->request->variable('ad_note', '', true),
442	13		'ad_code' => $this->request->variable('ad_code', '', true),
443	13		'ad_enabled' => $this->request->variable('ad_enabled', 0),
444	13		'ad_locations' => $this->request->variable('ad_locations', array('')),
445	13		'ad_end_date' => $this->request->variable('ad_end_date', ''),
446	13		);
447
448			// Validate form key
449	13		if (!check_form_key($form_name))
450	13		{
451	2		$this->errors[] = $this->user->lang('FORM_INVALID');
452	2		}
453
454			// Validate ad name
455	13		if ($data['ad_name'] === '')
456	13		{
457	2		$this->errors[] = $this->user->lang('AD_NAME_REQUIRED');
458	2		}
459	13		if (truncate_string($data['ad_name'], self::MAX_NAME_LENGTH) !== $data['ad_name'])
460	13		{
461	2		$this->errors[] = $this->user->lang('AD_NAME_TOO_LONG', self::MAX_NAME_LENGTH);
462	2		}
463
464			// Validate ad end date
465	13		if (preg_match('#^\d{4}\-\d{2}\-\d{2}$#', $data['ad_end_date']))
466	13		{
467	4		$data['ad_end_date'] = (int) $this->user->get_timestamp_from_format(self::DATE_FORMAT, $data['ad_end_date']);
468
469	4		if ($data['ad_end_date'] < time())
470	4		{
471	2		$this->errors[] = $this->user->lang('AD_END_DATE_INVALID');
472	2		}
473	4		}
474	9		else if ($data['ad_end_date'] !== '')
475	9		{
476			$this->errors[] = $this->user->lang('AD_END_DATE_INVALID');
477			}
478			else
479			{
480	9		$data['ad_end_date'] = 0;
481			}
482
483	13		return $data;
484			}
485
486			/**
487			* Assign form data to the template.
488			*
489			* @param array $data The form data.
490			* @return void
491			*/
492	11		protected function assign_form_data($data)
493			{
494	11		$this->template->assign_vars(array(
495	11		'S_ERROR' => (bool) count($this->errors),
496	11		'ERROR_MSG' => count($this->errors) ? implode('<br />', $this->errors) : '',
497
498	11		'AD_NAME' => $data['ad_name'],
499	11		'AD_NOTE' => $data['ad_note'],
500	11		'AD_CODE' => $data['ad_code'],
501	11		'AD_ENABLED' => $data['ad_enabled'],
502	11		'AD_END_DATE' => $this->prepare_end_date($data['ad_end_date']),
503	11		));
504	11		}
505
506			/**
507			* Prepare end date for display
508			*
509			* @param mixed $end_date End date.
510			* @return string End date prepared for display.
511			*/
512	11		protected function prepare_end_date($end_date)
513			{
514	11		if (empty($end_date))
515	11		{
516	8		return '';
517			}
518
519	3		if (is_numeric($end_date))
520	3		{
521	3		return $this->user->format_date($end_date, self::DATE_FORMAT);
522			}
523
524			return (string) $end_date;
525			}
526
527			/**
528			* Assign template locations data to the template.
529			*
530			* @param mixed $data The form data or nothing.
531			* @return void
532			*/
533	12		protected function assign_locations($data = false)
534			{
535	12		foreach ($this->location_manager->get_all_locations() as $location_id => $location_data)
536			{
537	12		$this->template->assign_block_vars('ad_locations', array(
538	12		'LOCATION_ID' => $location_id,
539	12		'LOCATION_DESC' => $location_data['desc'],
540	12		'LOCATION_NAME' => $location_data['name'],
541	12		'S_SELECTED' => $data ? in_array($location_id, $data['ad_locations']) : false,
542	12		));
543	12		}
544	12		}
545
546			/**
547			* Prepare advertisement preview
548			*
549			* @param string $code Ad code to preview
550			* @return void
551			*/
552	2		protected function ad_preview($code)
553			{
554	2		$this->template->assign_var('PREVIEW', htmlspecialchars_decode($code));
555	2		}
556
557			/**
558			* Print success message.
559			*
560			* It takes arguments in the form of a language key, followed by language substitution values.
561			*/
562	6		protected function success()
563			{
564	6		trigger_error(call_user_func_array(array($this->user, 'lang'), func_get_args()) . adm_back_link($this->u_action));
565			}
566
567			/**
568			* Print error message.
569			*
570			* It takes arguments in the form of a language key, followed by language substitution values.
571			*/
572	5		protected function error()
573			{
574	5		trigger_error(call_user_func_array(array($this->user, 'lang'), func_get_args()) . adm_back_link($this->u_action), E_USER_WARNING);
575			}
576
577			/**
578			* Log action
579			*
580			* @param string $action Performed action in uppercase
581			* @param string $ad_name Advertisement name
582			* @return void
583			*/
584	3		protected function log($action, $ad_name)
585			{
586	3		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'ACP_PHPBB_ADS_' . $action . '_LOG', time(), array($ad_name));
587	3		}
588			}
589

phpbb-extensions / ad-management