admin_controller - Code Metrics - Inspection of "ACP Ad Management Improvements" - phpbb-extensions/ad-management - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#74)

by Jakub

created 2017-08-09 16:29 UTC

admin_controller C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	494
Duplicated Lines	10.93 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

90.12%

Importance

Changes

Metric	Value
wmc	55
c	0
b	0
f	0
lcom	1
cbo	4
dl	54
loc	494
ccs	228
cts	253
cp	0.9012
rs	6.8

16 Methods

Rating	Name	Duplication	Size	Complexity
A	set_page_url()	0	4	1
A	get_page_title()	0	4	1
A	__construct()	0	15	1
A	mode_manage()	0	14	2
B	mode_settings()	8	39	4
C	action_add()	21	52	9
C	action_edit()	25	68	11
A	action_enable()	0	4	1
A	action_disable()	0	4	1
B	action_delete()	0	40	5
C	list_ads()	0	47	8
A	setup()	0	12	2
B	ad_enable()	0	28	6
A	ad_preview()	0	4	1
A	success()	0	4	1
A	error()	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;

use phpbb\ads\controller\admin_input as input;

/**
* Admin controller
*/
class admin_controller
{
	/** @var \phpbb\template\template */
	protected $template;

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

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

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

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

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

	/** @var \phpbb\group\helper */
	protected $group_helper;

	/** @var \phpbb\ads\controller\admin_input */
	protected $input;

	/** @var \phpbb\ads\controller\admin_helper */
	protected $helper;

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

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

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

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

	/**
	 * Constructor
	 *
	 * @param \phpbb\template\template				$template		Template object
	 * @param \phpbb\language\language				$language		Language object
	 * @param \phpbb\request\request				$request		Request object
	 * @param \phpbb\ads\ad\manager					$manager		Advertisement manager object
	 * @param \phpbb\config\db_text					$config_text 	Config text object
	 * @param \phpbb\config\config					$config			Config object
	 * @param \phpbb\group\helper					$group_helper	Group helper object
	 * @param \phpbb\ads\controller\admin_input 	$input			Admin input object
	 * @param \phpbb\ads\controller\admin_helper	$helper			Admin helper object
	 * @param \phpbb\ads\analyser\manager			$analyser		Ad code analyser object
	 * @param string								$root_path		phpBB root path
	 * @param string								$php_ext		PHP extension
	 */
	public function __construct(\phpbb\template\template $template, \phpbb\language\language $language, \phpbb\request\request $request, \phpbb\ads\ad\manager $manager, \phpbb\config\db_text $config_text, \phpbb\config\config $config, \phpbb\group\helper $group_helper, \phpbb\ads\controller\admin_input $input, \phpbb\ads\controller\admin_helper $helper, \phpbb\ads\analyser\manager $analyser, $root_path, $php_ext)
	{
		$this->template = $template;
		$this->language = $language;
		$this->request = $request;
		$this->manager = $manager;
		$this->config_text = $config_text;
		$this->config = $config;
		$this->group_helper = $group_helper;
		$this->input = $input;
		$this->helper = $helper;
		$this->analyser = $analyser;
		$this->root_path = $root_path;
		$this->php_ext = $php_ext;
	}

	/**
	 * 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->config->set('phpbb_ads_adblocker_message', $this->request->variable('adblocker_message', 0));
				$this->config->set('phpbb_ads_enable_views', $this->request->variable('enable_views', 0));
				$this->config->set('phpbb_ads_enable_clicks', $this->request->variable('enable_clicks', 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->helper->assign_errors(array($this->language->lang('FORM_INVALID')));
		}

		$hide_groups = json_decode($this->config_text->get('phpbb_ads_hide_groups'), true);
		$groups = $this->manager->load_groups();
		foreach ($groups as $group)
		{
			$this->template->assign_block_vars('groups', array(
				'ID'         => $group['group_id'],
				'NAME'       => $this->group_helper->get_name($group['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'],
			'ENABLE_VIEWS'      => $this->config['phpbb_ads_enable_views'],
			'ENABLE_CLICKS'     => $this->config['phpbb_ads_enable_clicks'],
		));
	}

	/**
	 * 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->language->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');
		$upload_banner = $this->request->is_set_post('upload_banner');
		$analyse_ad_code = $this->request->is_set_post('analyse_ad_code');

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

			if ($preview)
			{
				$this->ad_preview($data['ad_code']);
			}
			else if ($upload_banner)
			{
				$data['ad_code'] = $this->input->banner_upload($data['ad_code']);
			}
			else if ($analyse_ad_code)
			{
				$this->analyser->run($data['ad_code']);
			}
			else if (!$this->input->has_errors())
			{
				$ad_id = $this->manager->insert_ad($data);
				$this->manager->insert_ad_locations($ad_id, $data['ad_locations']);

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

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

			$this->helper->assign_locations($data['ad_locations']);
			$this->helper->assign_form_data($data);
			$this->helper->assign_errors($this->input->get_errors());
		}
		else
		{
			$this->helper->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' => input::DATE_FORMAT,
			'U_FIND_USERNAME'    => $this->helper->get_find_username_link(),
		));
	}

	/**
	 * 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');
		$upload_banner = $this->request->is_set_post('upload_banner');
		$analyse_ad_code = $this->request->is_set_post('analyse_ad_code');

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

			if ($preview)
			{
				$this->ad_preview($data['ad_code']);
			}
			else if ($upload_banner)
			{
				$data['ad_code'] = $this->input->banner_upload($data['ad_code']);
			}
			else if ($analyse_ad_code)
			{
				$this->analyser->run($data['ad_code']);
			}
			else if (!$this->input->has_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->helper->log('EDIT', $data['ad_name']);

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

				$this->error('ACP_AD_DOES_NOT_EXIST');
			}
		}
		else
		{
			$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' => input::DATE_FORMAT,
			'U_FIND_USERNAME'    => $this->helper->get_find_username_link(),
		));
		$this->helper->assign_locations($data['ad_locations']);
		$this->helper->assign_form_data($data);
		$this->helper->assign_errors($this->input->get_errors());
	}

	/**
	 * 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->helper->log('DELETE', $ad_data['ad_name']);

					if (!$this->request->is_ajax())
					{
						$this->success('ACP_AD_DELETE_SUCCESS');
					}
				}
			}
			else
			{
				confirm_box(false, $this->language->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()
	{
		$ads_locations = $this->helper->prepare_ads_locations($this->manager->get_all_locations());
		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'],
				'PRIORITY'			 => $row['ad_priority'],
				'END_DATE'           => $this->helper->prepare_end_date($ad_end_date),
				'VIEWS'              => $row['ad_views'],
				'CLICKS'             => $row['ad_clicks'],
				'VIEWS_LIMIT'        => $row['ad_views_limit'],
				'CLICKS_LIMIT'       => $row['ad_clicks_limit'],
				'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'],
			));

			if (isset($ads_locations[$row['ad_id']]))
			{
				foreach ($ads_locations[$row['ad_id']] as $name)
				{
					$this->template->assign_block_vars('ads.locations', array(
						'NAME'	=> $name,
					));
				}
			}
		}

		// Set output vars for display in the template
		$this->template->assign_vars(array(
			'U_ACTION_ADD'     => $this->u_action . '&amp;action=add',
			'S_VIEWS_ENABLED'  => $this->config['phpbb_ads_enable_views'],
			'S_CLICKS_ENABLED' => $this->config['phpbb_ads_enable_clicks'],
		));
	}

	/**
	 * Perform general tasks
	 *
	 * @return void
	 */
	protected function setup()
	{
		if (!function_exists('user_get_id_name'))
		{
			include $this->root_path . 'includes/functions_user.' . $this->php_ext;
		}

		$this->language->add_lang('posting'); // Used by banner_upload() file errors
		$this->language->add_lang('acp', 'phpbb/ads');

		$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->language->lang($enable ? 'ENABLED' : 'DISABLED'),
				'title' => $this->language->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');
		}
	}

	/**
	 * 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->language, '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->language, '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\ads\controller;
12
13			use phpbb\ads\controller\admin_input as input;
14
15			/**
16			* Admin controller
17			*/
18			class admin_controller
19			{
20			/** @var \phpbb\template\template */
21			protected $template;
22
23			/** @var \phpbb\language\language */
24			protected $language;
25
26			/** @var \phpbb\request\request */
27			protected $request;
28
29			/** @var \phpbb\ads\ad\manager */
30			protected $manager;
31
32			/** @var \phpbb\config\db_text */
33			protected $config_text;
34
35			/** @var \phpbb\config\config */
36			protected $config;
37
38			/** @var \phpbb\group\helper */
39			protected $group_helper;
40
41			/** @var \phpbb\ads\controller\admin_input */
42			protected $input;
43
44			/** @var \phpbb\ads\controller\admin_helper */
45			protected $helper;
46
47			/** @var \phpbb\ads\analyser\manager */
48			protected $analyser;
49
50			/** @var string root_path */
51			protected $root_path;
52
53			/** @var string php_ext */
54			protected $php_ext;
55
56			/** @var string Custom form action */
57			protected $u_action;
58
59			/**
60			* Constructor
61			*
62			* @param \phpbb\template\template $template Template object
63			* @param \phpbb\language\language $language Language object
64			* @param \phpbb\request\request $request Request object
65			* @param \phpbb\ads\ad\manager $manager Advertisement manager object
66			* @param \phpbb\config\db_text $config_text Config text object
67			* @param \phpbb\config\config $config Config object
68			* @param \phpbb\group\helper $group_helper Group helper object
69			* @param \phpbb\ads\controller\admin_input $input Admin input object
70			* @param \phpbb\ads\controller\admin_helper $helper Admin helper object
71			* @param \phpbb\ads\analyser\manager $analyser Ad code analyser object
72			* @param string $root_path phpBB root path
73			* @param string $php_ext PHP extension
74			*/
75	33		public function __construct(\phpbb\template\template $template, \phpbb\language\language $language, \phpbb\request\request $request, \phpbb\ads\ad\manager $manager, \phpbb\config\db_text $config_text, \phpbb\config\config $config, \phpbb\group\helper $group_helper, \phpbb\ads\controller\admin_input $input, \phpbb\ads\controller\admin_helper $helper, \phpbb\ads\analyser\manager $analyser, $root_path, $php_ext)
76			{
77	33		$this->template = $template;
78	33		$this->language = $language;
79	33		$this->request = $request;
80	33		$this->manager = $manager;
81	33		$this->config_text = $config_text;
82	33		$this->config = $config;
83	33		$this->group_helper = $group_helper;
84	33		$this->input = $input;
85	33		$this->helper = $helper;
86	33		$this->analyser = $analyser;
87	33		$this->root_path = $root_path;
88	33		$this->php_ext = $php_ext;
89	33		}
90
91			/**
92			* Process user request for manage mode
93			*
94			* @return void
95			*/
96	6		public function mode_manage()
97			{
98	6		$this->setup();
99
100			// Trigger specific action
101	6		$action = $this->request->variable('action', '');
102	6		if (in_array($action, array('add', 'edit', 'enable', 'disable', 'delete')))
103	6		{
104	5		$this->{'action_' . $action}();
105	5		}
106
107			// Otherwise default to this
108	6		$this->list_ads();
109	6		}
110
111			/**
112			* Process user request for settings mode
113			*
114			* @return void
115			*/
116	3		public function mode_settings()
117			{
118	3		$this->setup();
119
120	3		add_form_key('phpbb/ads/settings');
121	3		if ($this->request->is_set_post('submit'))
122	3		{
123			// Validate form key
124	2		if (check_form_key('phpbb/ads/settings'))
125	2		{
126	1		$this->config->set('phpbb_ads_adblocker_message', $this->request->variable('adblocker_message', 0));
127	1		$this->config->set('phpbb_ads_enable_views', $this->request->variable('enable_views', 0));
128	1		$this->config->set('phpbb_ads_enable_clicks', $this->request->variable('enable_clicks', 0));
129	1		$this->config_text->set('phpbb_ads_hide_groups', json_encode($this->request->variable('hide_groups', array(0))));
130
131	1		$this->success('ACP_AD_SETTINGS_SAVED');
132			}
133
134	1		$this->helper->assign_errors(array($this->language->lang('FORM_INVALID')));
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	View Code Duplication	foreach ($groups as $group)
140			{
141	2		$this->template->assign_block_vars('groups', array(
142	2		'ID' => $group['group_id'],
143	2		'NAME' => $this->group_helper->get_name($group['group_name']),
144	2		'S_SELECTED' => in_array($group['group_id'], $hide_groups),
145	2		));
146	2		}
147
148	2		$this->template->assign_vars(array(
149	2		'U_ACTION' => $this->u_action,
150	2		'ADBLOCKER_MESSAGE' => $this->config['phpbb_ads_adblocker_message'],
151	2		'ENABLE_VIEWS' => $this->config['phpbb_ads_enable_views'],
152	2		'ENABLE_CLICKS' => $this->config['phpbb_ads_enable_clicks'],
153	2		));
154	2		}
155
156			/**
157			* Set page url
158			*
159			* @param string $u_action Custom form action
160			* @return void
161			*/
162	27		public function set_page_url($u_action)
163			{
164	27		$this->u_action = $u_action;
165	27		}
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->language->lang('ACP_PHPBB_ADS_TITLE');
175			}
176
177			/**
178			* Add an advertisement
179			*
180			* @return void
181			*/
182	12		public function action_add()
183			{
184	6		$preview = $this->request->is_set_post('preview');
185	6		$submit = $this->request->is_set_post('submit');
186	6		$upload_banner = $this->request->is_set_post('upload_banner');
187	6		$analyse_ad_code = $this->request->is_set_post('analyse_ad_code');
188
189	6		add_form_key('phpbb/ads/add');
190	6		if ($preview \|\| $submit \|\| $upload_banner \|\| $analyse_ad_code)
191	6		{
192	5		$data = $this->input->get_form_data('phpbb/ads/add');
193
194		View Code Duplication	if ($preview)
195	5		{
196	12		$this->ad_preview($data['ad_code']);
197	1		}
198			else if ($upload_banner)
199	4		{
200	1		$data['ad_code'] = $this->input->banner_upload($data['ad_code']);
201	1		}
202			else if ($analyse_ad_code)
203	3		{
204	1		$this->analyser->run($data['ad_code']);
205	1		}
206	2		else if (!$this->input->has_errors())
207	2		{
208	1		$ad_id = $this->manager->insert_ad($data);
209	1		$this->manager->insert_ad_locations($ad_id, $data['ad_locations']);
210
211	1		$this->helper->log('ADD', $data['ad_name']);
212
213	1		$this->success('ACP_AD_ADD_SUCCESS');
214			}
215
216	4		$this->helper->assign_locations($data['ad_locations']);
217	4		$this->helper->assign_form_data($data);
218	4		$this->helper->assign_errors($this->input->get_errors());
219	4		}
220			else
221			{
222	1		$this->helper->assign_locations();
223			}
224
225			// Set output vars for display in the template
226	5		$this->template->assign_vars(array(
227	5		'S_ADD_AD' => true,
228	5		'U_BACK' => $this->u_action,
229	5		'U_ACTION' => "{$this->u_action}&action=add",
230	5		'PICKER_DATE_FORMAT' => input::DATE_FORMAT,
231	5		'U_FIND_USERNAME' => $this->helper->get_find_username_link(),
232	5		));
233	5		}
234
235			/**
236			* Edit an advertisement
237			*
238			* @return void
239			*/
240	7		public function action_edit()
241			{
242	7		$ad_id = $this->request->variable('id', 0);
243	7		$preview = $this->request->is_set_post('preview');
244	7		$submit = $this->request->is_set_post('submit');
245	7		$upload_banner = $this->request->is_set_post('upload_banner');
246	7		$analyse_ad_code = $this->request->is_set_post('analyse_ad_code');
247
248	7		add_form_key('phpbb/ads/edit/' . $ad_id);
249	7		if ($preview \|\| $submit \|\| $upload_banner \|\| $analyse_ad_code)
250	7		{
251	5		$data = $this->input->get_form_data('phpbb/ads/edit/' . $ad_id);
252
253			if ($preview)
254	5		{
255	1		$this->ad_preview($data['ad_code']);
256	1		}
257		View Code Duplication	else if ($upload_banner)
258	4		{
259			$data['ad_code'] = $this->input->banner_upload($data['ad_code']);
260			}
261			else if ($analyse_ad_code)
262	4		{
263			$this->analyser->run($data['ad_code']);
264			}
265	4		else if (!$this->input->has_errors())
266	4		{
267	2		$success = $this->manager->update_ad($ad_id, $data);
268
269			if ($success)
270	2		{
271			// Only insert new ad locations to DB when ad exists
272	1		$this->manager->delete_ad_locations($ad_id);
273	1		$this->manager->insert_ad_locations($ad_id, $data['ad_locations']);
274
275	1		$this->helper->log('EDIT', $data['ad_name']);
276
277	1		$this->success('ACP_AD_EDIT_SUCCESS');
278			}
279
280	1		$this->error('ACP_AD_DOES_NOT_EXIST');
281			}
282	3		}
283			else
284			{
285	2		$data = $this->manager->get_ad($ad_id);
286	2		if (empty($data))
287	2		{
288	1		$this->error('ACP_AD_DOES_NOT_EXIST');
289			}
290
291			// Load ad template locations
292	1		$data['ad_locations'] = $this->manager->get_ad_locations($ad_id);
293			}
294
295			// Set output vars for display in the template
296	4		$this->template->assign_vars(array(
297	4		'S_EDIT_AD' => true,
298	4		'EDIT_ID' => $ad_id,
299	4		'U_BACK' => $this->u_action,
300	4		'U_ACTION' => "{$this->u_action}&action=edit&id=" . $ad_id,
301	4		'PICKER_DATE_FORMAT' => input::DATE_FORMAT,
302	4		'U_FIND_USERNAME' => $this->helper->get_find_username_link(),
303	4		));
304	4		$this->helper->assign_locations($data['ad_locations']);
305	4		$this->helper->assign_form_data($data);
306	4		$this->helper->assign_errors($this->input->get_errors());
307	4		}
308
309			/**
310			* Enable an advertisement
311			*
312			* @return void
313			*/
314	4		public function action_enable()
315			{
316	4		$this->ad_enable(true);
317	1		}
318
319			/**
320			* Disable an advertisement
321			*
322			* @return void
323			*/
324	4		public function action_disable()
325			{
326	4		$this->ad_enable(false);
327	1		}
328
329			/**
330			* Delete an advertisement
331			*
332			* @return void
333			*/
334	3		public function action_delete()
335			{
336	3		$ad_id = $this->request->variable('id', 0);
337			if ($ad_id)
338	3		{
339	3		if (confirm_box(true))
340	3		{
341			// Get ad data so that we can log ad name
342	2		$ad_data = $this->manager->get_ad($ad_id);
343
344			// Delete ad and it's template locations
345	2		$this->manager->delete_ad_locations($ad_id);
346	2		$success = $this->manager->delete_ad($ad_id);
347
348			// Only notify user on error or if not ajax
349	2		if (!$success)
350	2		{
351	1		$this->error('ACP_AD_DELETE_ERRORED');
352			}
353			else
354			{
355	1		$this->helper->log('DELETE', $ad_data['ad_name']);
356
357	1		if (!$this->request->is_ajax())
358	1		{
359	1		$this->success('ACP_AD_DELETE_SUCCESS');
360			}
361			}
362			}
363			else
364			{
365	1		confirm_box(false, $this->language->lang('CONFIRM_OPERATION'), build_hidden_fields(array(
366	1		'id' => $ad_id,
367	1		'i' => $this->request->variable('i', ''),
368	1		'mode' => $this->request->variable('mode', ''),
369			'action' => 'delete'
370	1		)));
371			}
372	1		}
373	1		}
374
375			/**
376			* Display the ads
377			*
378			* @return void
379			*/
380	1		public function list_ads()
381			{
382	1		$ads_locations = $this->helper->prepare_ads_locations($this->manager->get_all_locations());
383	1		foreach ($this->manager->get_all_ads() as $row)
384			{
385	1		$ad_enabled = (int) $row['ad_enabled'];
386	1		$ad_end_date = (int) $row['ad_end_date'];
387	1		$ad_expired = $ad_end_date > 0 && $ad_end_date < time();
388	1		if ($ad_expired && $ad_enabled)
389	1		{
390	1		$ad_enabled = 0;
391	1		$this->manager->update_ad($row['ad_id'], array('ad_enabled' => 0));
392	1		}
393
394	1		$this->template->assign_block_vars('ads', array(
395	1		'NAME' => $row['ad_name'],
396	1		'PRIORITY' => $row['ad_priority'],
397	1		'END_DATE' => $this->helper->prepare_end_date($ad_end_date),
398	1		'VIEWS' => $row['ad_views'],
399	1		'CLICKS' => $row['ad_clicks'],
400	1		'VIEWS_LIMIT' => $row['ad_views_limit'],
401	1		'CLICKS_LIMIT' => $row['ad_clicks_limit'],
402	1		'S_END_DATE_EXPIRED' => $ad_expired,
403	1		'S_ENABLED' => $ad_enabled,
404	1		'U_ENABLE' => $this->u_action . '&action=' . ($ad_enabled ? 'disable' : 'enable') . '&id=' . $row['ad_id'],
405	1		'U_EDIT' => $this->u_action . '&action=edit&id=' . $row['ad_id'],
406	1		'U_DELETE' => $this->u_action . '&action=delete&id=' . $row['ad_id'],
407	1		));
408
409	1		if (isset($ads_locations[$row['ad_id']]))
410	1		{
411			foreach ($ads_locations[$row['ad_id']] as $name)
412			{
413			$this->template->assign_block_vars('ads.locations', array(
414			'NAME' => $name,
415			));
416			}
417			}
418	1		}
419
420			// Set output vars for display in the template
421	1		$this->template->assign_vars(array(
422	1		'U_ACTION_ADD' => $this->u_action . '&action=add',
423	1		'S_VIEWS_ENABLED' => $this->config['phpbb_ads_enable_views'],
424	1		'S_CLICKS_ENABLED' => $this->config['phpbb_ads_enable_clicks'],
425	1		));
426	1		}
427
428			/**
429			* Perform general tasks
430			*
431			* @return void
432			*/
433	9		protected function setup()
434			{
435	9		if (!function_exists('user_get_id_name'))
436	9		{
437			include $this->root_path . 'includes/functions_user.' . $this->php_ext;
438			}
439
440	9		$this->language->add_lang('posting'); // Used by banner_upload() file errors
441	9		$this->language->add_lang('acp', 'phpbb/ads');
442
443	9		$this->template->assign_var('S_PHPBB_ADS', true);
444	9		}
445
446			/**
447			* Enable/disable an advertisement
448			*
449			* @param bool $enable Enable or disable the advertisement?
450			* @return void
451			*/
452	6		protected function ad_enable($enable)
453			{
454	6		$ad_id = $this->request->variable('id', 0);
455
456	6		$success = $this->manager->update_ad($ad_id, array(
457	6		'ad_enabled' => (int) $enable,
458	6		));
459
460			// If AJAX was used, show user a result message
461	6		if ($this->request->is_ajax())
462	6		{
463	2		$json_response = new \phpbb\json_response;
464	2		$json_response->send(array(
465	2		'text' => $this->language->lang($enable ? 'ENABLED' : 'DISABLED'),
466	2		'title' => $this->language->lang('AD_ENABLE_TITLE', (int) $enable),
467	2		));
468			}
469
470			// Otherwise, show traditional infobox
471			if ($success)
472	4		{
473	2		$this->success($enable ? 'ACP_AD_ENABLE_SUCCESS' : 'ACP_AD_DISABLE_SUCCESS');
474			}
475			else
476			{
477	2		$this->error($enable ? 'ACP_AD_ENABLE_ERRORED' : 'ACP_AD_DISABLE_ERRORED');
478			}
479			}
480
481			/**
482			* Prepare advertisement preview
483			*
484			* @param string $code Ad code to preview
485			* @return void
486			*/
487	2		protected function ad_preview($code)
488			{
489	2		$this->template->assign_var('PREVIEW', htmlspecialchars_decode($code));
490	2		}
491
492			/**
493			* Print success message.
494			*
495			* It takes arguments in the form of a language key, followed by language substitution values.
496			*/
497	6		protected function success()
498			{
499	6		trigger_error(call_user_func_array(array($this->language, 'lang'), func_get_args()) . adm_back_link($this->u_action));
500			}
501
502			/**
503			* Print error message.
504			*
505			* It takes arguments in the form of a language key, followed by language substitution values.
506			*/
507	5		protected function error()
508			{
509	5		trigger_error(call_user_func_array(array($this->language, 'lang'), func_get_args()) . adm_back_link($this->u_action), E_USER_WARNING);
510			}
511			}
512

phpbb-extensions / ad-management