phpbb\ads\event\main_listener

Complexity

Total Complexity

28

Size/Duplication

Total Lines	277
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	11
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	load_language_on_setup()	0	8	1
A	__construct()	0	12	1
A	getSubscribedEvents()	0	11	1
A	set_permissions()	0	5	1
A	remove_ad_owner()	0	3	1
A	destroy_user_group_cache()	0	3	1
A	disable_xss_protection()	0	6	3
A	clicks()	0	7	2
A	is_non_content_page()	0	10	1
A	views()	0	7	4
A	visual_demo()	0	16	3
A	setup_ads()	0	20	3
A	adblocker()	0	3	1
A	append_agreement()	0	13	5

<?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\event;

/**
 * @ignore
 */
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

The type Symfony\Component\EventDispatcher\EventSubscriberInterface was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Advertisement management Event listener.
 */
class main_listener implements EventSubscriberInterface
{
	/** @var \phpbb\language\language */

The type phpbb\language\language was not found. Maybe you did not declare it correctly or list all dependencies?

	protected $language;

	/** @var \phpbb\template\template */

The type phpbb\template\template was not found. Maybe you did not declare it correctly or list all dependencies?

	protected $template;

	/** @var \phpbb\user */

The type phpbb\user was not found. Maybe you did not declare it correctly or list all dependencies?

	protected $user;

	/** @var \phpbb\config\config */

The type phpbb\config\config was not found. Maybe you did not declare it correctly or list all dependencies?

	protected $config;

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

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

	/** @var \phpbb\controller\helper */

The type phpbb\controller\helper was not found. Maybe you did not declare it correctly or list all dependencies?

	protected $controller_helper;

	/** @var \phpbb\request\request */

The type phpbb\request\request was not found. Maybe you did not declare it correctly or list all dependencies?

	protected $request;

	/** @var \phpbb\cache\driver\driver_interface */

The type phpbb\cache\driver\driver_interface was not found. Maybe you did not declare it correctly or list all dependencies?

	protected $cache;

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

	/**
	 * {@inheritdoc}
	 */
	public static function getSubscribedEvents()
	{
		return array(
			'core.permissions'				=> 'set_permissions',
			'core.user_setup'				=> 'load_language_on_setup',
			'core.page_footer_after'		=> array(array('setup_ads'), array('visual_demo'), array('append_agreement')),
			'core.page_header_after'		=> array(array('adblocker'), array('clicks')),
			'core.delete_user_after'		=> 'remove_ad_owner',
			'core.adm_page_header_after'	=> 'disable_xss_protection',
			'core.group_add_user_after'		=> 'destroy_user_group_cache',
			'core.group_delete_user_after'	=> 'destroy_user_group_cache',
		);
	}

	/**
	 * Constructor
	 *
	 * @param \phpbb\language\language				$language			Language object
	 * @param \phpbb\template\template				$template			Template object
	 * @param \phpbb\user							$user				User object
	 * @param \phpbb\config\config					$config				Config object
	 * @param \phpbb\ads\ad\manager					$manager			Advertisement manager object
	 * @param \phpbb\ads\location\manager			$location_manager	Template location manager object
	 * @param \phpbb\controller\helper				$controller_helper	Controller helper object
	 * @param \phpbb\request\request				$request			Request object
	 * @param \phpbb\cache\driver\driver_interface	$cache				Cache driver object
	 * @param string								$php_ext			PHP extension
	 */
	public function __construct(\phpbb\language\language $language, \phpbb\template\template $template, \phpbb\user $user, \phpbb\config\config $config, \phpbb\ads\ad\manager $manager, \phpbb\ads\location\manager $location_manager, \phpbb\controller\helper $controller_helper, \phpbb\request\request $request, \phpbb\cache\driver\driver_interface $cache, $php_ext)
	{
		$this->language = $language;
		$this->template = $template;
		$this->user = $user;
		$this->config = $config;
		$this->manager = $manager;
		$this->location_manager = $location_manager;
		$this->controller_helper = $controller_helper;
		$this->request = $request;
		$this->cache = $cache;
		$this->php_ext = $php_ext;
	}

	/**
	 * Wire up u_phpbb_ads permission
	 *
	 * @param	\phpbb\event\data	$event	The event object

The type phpbb\event\data was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @return	void
	 */
	public function set_permissions($event)
	{
		$event->update_subarray('permissions', 'u_phpbb_ads', ['lang' => 'ACL_U_PHPBB_ADS', 'cat' => 'misc']);
		$event->update_subarray('permissions', 'a_phpbb_ads_m', ['lang' => 'ACL_A_PHPBB_ADS_M', 'cat' => 'misc']);
		$event->update_subarray('permissions', 'a_phpbb_ads_s', ['lang' => 'ACL_A_PHPBB_ADS_S', 'cat' => 'misc']);
	}

	/**
	 * Load common language file during user setup
	 *
	 * @param	\phpbb\event\data	$event	The event object
	 * @return	void
	 */
	public function load_language_on_setup($event)
	{
		$lang_set_ext = $event['lang_set_ext'];
		$lang_set_ext[] = array(
			'ext_name' => 'phpbb/ads',
			'lang_set' => 'common',
		);
		$event['lang_set_ext'] = $lang_set_ext;
	}

	/**
	 * Displays advertisements
	 *
	 * @return	void
	 */
	public function setup_ads()
	{
		// check for the existence of 'MESSAGE_TEXT', which signals it's an error page.
		$non_content_page = $this->template->retrieve_var('MESSAGE_TEXT') || $this->is_non_content_page();
		$location_ids = $this->location_manager->get_all_location_ids();
		$user_groups = $this->manager->load_memberships($this->user->data['user_id']);
		$ad_ids = array();

		foreach ($this->manager->get_ads($location_ids, $user_groups, $non_content_page) as $row)
		{
			$ad_ids[] = $row['ad_id'];

			$this->template->assign_vars(array(
				'AD_' . strtoupper($row['location_id']) => htmlspecialchars_decode($row['ad_code'], ENT_COMPAT),
				'AD_' . strtoupper($row['location_id']) . '_ID' => (int) $row['ad_id'],
				'AD_' . strtoupper($row['location_id']) . '_CENTER' => (bool) $row['ad_centering'],
			));
		}

		$this->views($ad_ids);
	}

	/**
	 * Display Ad blocker friendly message if allowed
	 *
	 * @return	void
	 */
	public function adblocker()
	{
		$this->template->assign_var('S_DISPLAY_ADBLOCKER', (int) $this->config['phpbb_ads_adblocker_message']);
	}

	/**
	 * Add click tracking template variables
	 *
	 * @return	void
	 */
	public function clicks()
	{
		if ($this->config['phpbb_ads_enable_clicks'])
		{
			$this->template->assign_vars(array(
				'U_PHPBB_ADS_CLICK'		=> $this->controller_helper->route('phpbb_ads_click', array('data' => 0), true, ''),
				'S_PHPBB_ADS_ENABLE_CLICKS'	=> true,
			));
		}
	}

	/**
	 * Generate visual demo templates
	 *
	 * @return	void
	 */
	public function visual_demo()
	{
		if ($this->request->is_set($this->config['cookie_name'] . '_phpbb_ads_visual_demo', \phpbb\request\request_interface::COOKIE))

The type phpbb\request\request_interface was not found. Maybe you did not declare it correctly or list all dependencies?

		{
			$all_locations = $this->location_manager->get_all_locations(false);
			foreach ($this->location_manager->get_all_location_ids() as $location_id)
			{
				$this->template->assign_vars(array(
					'AD_' . strtoupper($location_id) . '_ID'	=> $location_id,
					'AD_' . strtoupper($location_id)			=> '<div class="phpbb-ads-visual-demo" title="' . $all_locations[$location_id]['desc'] . '">' . $all_locations[$location_id]['name'] . '</div>',
				));
			}

			$this->template->assign_vars(array(
				'S_PHPBB_ADS_VISUAL_DEMO'	=> true,
				'U_DISABLE_VISUAL_DEMO'		=> $this->controller_helper->route('phpbb_ads_visual_demo', array('action' => 'disable')),
			));
		}
	}

	/**
	 * Prepare views counter template
	 *
	 * @param	array	$ad_ids	List of ads that will be displayed on current request's page
	 * @return	void
	 */
	protected function views($ad_ids)
	{
		if ($this->config['phpbb_ads_enable_views'] && empty($this->user->data['is_bot']) && count($ad_ids))
		{
			$this->template->assign_vars(array(
				'S_INCREMENT_VIEWS'	=> true,
				'U_PHPBB_ADS_VIEWS'	=> $this->controller_helper->route('phpbb_ads_view', array('data' => implode('-', $ad_ids)), true, ''),
			));
		}
	}

	/**
	 * Disable XSS Protection
	 * In Chrome browsers, previewing an Ad Code with javascript can
	 * be blocked, due to a false positive where Chrome thinks the
	 * javascript is an XSS injection. This will temporarily disable
	 * XSS protection in chrome while managing ads in the ACP.
	 *
	 * @param	\phpbb\event\data	$event	The event object
	 */
	public function disable_xss_protection($event)
	{
		if (stripos($this->user->browser, 'chrome') !== false &&
			stripos($this->user->page['page'], 'phpbb-ads') !== false)
		{
			$event['http_headers'] = array_merge($event['http_headers'], ['X-XSS-Protection' => '0']);
		}
	}

	/**
	 * Remove ad owner when deleting user(s)
	 *
	 * @param	\phpbb\event\data	$event	The event object
	 * @return	void
	 */
	public function remove_ad_owner($event)
	{
		$this->manager->remove_ad_owner($event['user_ids']);
	}

	/**
	 * Destroy user_group cache after user was removed from the group.
	 *
	 * @return	void
	 */
	public function destroy_user_group_cache()
	{
		$this->cache->destroy('sql', USER_GROUP_TABLE);

The constant phpbb\ads\event\USER_GROUP_TABLE was not found. Maybe you did not declare it correctly or list all dependencies?

	}

	/**
	 * Check if the page user is currently on is a non-content page.
	 * This should include member list and details pages, posting and
	 * replying pages, anything inside the UCP, MCP and ACP.
	 *
	 * @return bool True or false
	 */
	protected function is_non_content_page()
	{
		return count(array_intersect([$this->user->page['page_name'], $this->user->page['page_dir']], [
			'memberlist.' . $this->php_ext,
			'viewonline.' . $this->php_ext,
			'posting.' . $this->php_ext,
			'ucp.' . $this->php_ext,
			'mcp.' . $this->php_ext,
			'adm',
		])) > 0;
	}

	/**
	 * Append additional agreement details to the privacy agreement.
	 *
	 * @return void
	 */
	public function append_agreement()
	{
		if (!$this->config['phpbb_ads_show_agreement']
			|| (strpos($this->user->page['page_name'], 'ucp') !== 0)
			|| !$this->template->retrieve_var('S_AGREEMENT')
			|| ($this->template->retrieve_var('AGREEMENT_TITLE') !== $this->language->lang('PRIVACY')))
		{
			return;
		}

		$this->language->add_lang('ucp', 'phpbb/ads');

		$this->template->append_var('AGREEMENT_TEXT', $this->language->lang('PHPBB_ADS_PRIVACY_POLICY', $this->config['sitename']));
	}
}