phpbb\ideas\event\listener

Complexity

Total Complexity

52

Size/Duplication

Total Lines	417
Duplicated Lines	0 %

Importance

Changes	9
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	submit_idea_before()	0	9	2
A	global_template_vars()	0	7	3
C	show_idea()	0	95	17
A	getSubscribedEvents()	0	12	1
A	is_post_idea()	0	13	3
A	edit_idea_title()	0	12	5
A	show_post_buttons()	0	11	3
A	viewonline_ideas()	0	7	5
A	is_ideas_forum()	0	3	1
A	submit_idea_template()	0	20	3
A	ideas_forum_redirect()	0	5	2
A	submit_idea_after()	0	16	3
A	adjust_quickmod_tools()	0	24	2
A	is_first_post()	0	3	1

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

namespace phpbb\ideas\event;

use phpbb\auth\auth;
use phpbb\config\config;
use phpbb\controller\helper;
use phpbb\ideas\ext;
use phpbb\ideas\factory\idea;
use phpbb\ideas\factory\linkhelper;
use phpbb\language\language;
use phpbb\template\template;
use phpbb\user;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class listener implements EventSubscriberInterface
{
	/** @var auth */
	protected $auth;

	/* @var config */
	protected $config;

	/* @var helper */
	protected $helper;

	/* @var idea */
	protected $idea;

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

	/* @var linkhelper */
	protected $link_helper;

	/* @var template */
	protected $template;

	/* @var user */
	protected $user;

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

	/**
	 * @param auth       $auth
	 * @param config     $config
	 * @param helper     $helper
	 * @param idea       $idea
	 * @param language   $language
	 * @param linkhelper $link_helper
	 * @param template   $template
	 * @param user       $user
	 * @param string     $php_ext
	 */
	public function __construct(auth $auth, config $config, helper $helper, idea $idea, language $language, linkhelper $link_helper, template $template, user $user, $php_ext)
	{
		$this->auth = $auth;
		$this->config = $config;
		$this->helper = $helper;
		$this->idea = $idea;
		$this->language = $language;
		$this->link_helper = $link_helper;
		$this->template = $template;
		$this->user = $user;
		$this->php_ext = $php_ext;

		$this->language->add_lang('common', 'phpbb/ideas');
	}

	/**
	 * @inheritDoc
	 */
	public static function getSubscribedEvents()
	{
		return array(
			'core.page_header'							=> 'global_template_vars',
			'core.viewforum_get_topic_data'				=> 'ideas_forum_redirect',
			'core.viewtopic_modify_post_row'			=> 'show_post_buttons',
			'core.viewtopic_modify_page_title'			=> 'show_idea',
			'core.viewtopic_add_quickmod_option_before'	=> 'adjust_quickmod_tools',
			'core.viewonline_overwrite_location'		=> 'viewonline_ideas',
			'core.posting_modify_template_vars'			=> 'submit_idea_template',
			'core.posting_modify_submit_post_before'	=> 'submit_idea_before',
			'core.posting_modify_submit_post_after'		=> [['submit_idea_after'], ['edit_idea_title']],
		);
	}

	/**
	 * Assign global template variables
	 *
	 * @return void
	 */
	public function global_template_vars()
	{
		if ($this->user->data['is_registered'] && !$this->user->data['is_bot'])
		{
			$this->template->assign_var(
				'U_SEARCH_MY_IDEAS',
				$this->helper->route('phpbb_ideas_list_controller', ['sort' => ext::SORT_MYIDEAS, 'status' => '-1'])
			);
		}
	}

	/**
	 * Redirect users from the forum to the Ideas centre
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 * @access public
	 */
	public function ideas_forum_redirect($event)
	{
		if ($this->is_ideas_forum($event['forum_id']))
		{
			redirect($this->helper->route('phpbb_ideas_index_controller'));
		}
	}

	/**
	 * Show post buttons (hide delete, quote or warn user buttons)
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 * @access public
	 */
	public function show_post_buttons($event)
	{
		if (!$this->is_ideas_forum($event['row']['forum_id']))
		{
			return;
		}

		if ($this->is_first_post($event['topic_data']['topic_first_post_id'], $event['row']['post_id']))
		{
			$event->update_subarray('post_row', 'U_DELETE', false);
			$event->update_subarray('post_row', 'U_WARN', false);
		}
	}

	/**
	 * Show the idea related to the current topic
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 * @access public
	 */
	public function show_idea($event)
	{
		if (!$this->is_ideas_forum($event['forum_id']))
		{
			return;
		}

		$idea = $this->idea->get_idea_by_topic_id($event['topic_data']['topic_id']);

		if (!$idea)
		{
			return;
		}

		$mod = $this->auth->acl_get('m_', (int) $this->config['ideas_forum_id']);
		$own = $idea['idea_author'] === $this->user->data['user_id'];

		if ($mod)
		{
			$this->template->assign_var('STATUS_ARY', ext::$statuses);

			// Add quick mod option for deleting an idea
			$this->template->alter_block_array('quickmod', array(
				'VALUE'		=> 'delete_topic', // delete topic is used here simply to enable ajax
				'TITLE'		=> $this->language->lang('DELETE_IDEA'),
				'LINK'		=> $this->link_helper->get_idea_link($idea['idea_id'], 'delete'),
			));
		}

		$points = $idea['idea_votes_up'] - $idea['idea_votes_down'];
		$can_vote = ($idea['idea_status'] != ext::$statuses['IMPLEMENTED'] &&
			$idea['idea_status'] != ext::$statuses['DUPLICATE'] &&
			$this->auth->acl_get('f_vote', (int) $this->config['ideas_forum_id']) &&
			$event['topic_data']['topic_status'] != ITEM_LOCKED);

		$s_voted_up = $s_voted_down = false;
		if ($idea['idea_votes_up'] || $idea['idea_votes_down'])
		{
			$votes = $this->idea->get_voters($idea['idea_id']);

			foreach ($votes as $vote)
			{
				$this->template->assign_block_vars('votes_' . ($vote['vote_value'] ? 'up' : 'down'), array(
					'USER' => $vote['user'],
				));

				if ($this->user->data['user_id'] == $vote['user_id'])
				{
					$s_voted_up = ((int) $vote['vote_value'] === 1);
					$s_voted_down = ((int) $vote['vote_value'] === 0);
				}
			}
		}

		$this->template->assign_vars(array(
			'IDEA_ID'			=> $idea['idea_id'],
			'IDEA_TITLE'		=> $idea['idea_title'],
			'IDEA_VOTES'		=> $idea['idea_votes_up'] + $idea['idea_votes_down'],
			'IDEA_VOTES_UP'		=> $idea['idea_votes_up'],
			'IDEA_VOTES_DOWN'	=> $idea['idea_votes_down'],
			'IDEA_POINTS'		=> $points,
			'IDEA_STATUS_ID'	=> $idea['idea_status'],
			'IDEA_STATUS_NAME'	=> $this->language->lang(ext::status_name($idea['idea_status'])),

			'IDEA_DUPLICATE'	=> $idea['duplicate_id'] ? $this->idea->get_title($idea['duplicate_id']) : '',
			'IDEA_RFC'			=> $idea['rfc_link'],
			'IDEA_TICKET'		=> $idea['ticket_id'],
			'IDEA_IMPLEMENTED'	=> $idea['implemented_version'],

			'S_IS_MOD'			=> $mod,
			'S_CAN_EDIT'		=> $mod || $own,
			'S_CAN_VOTE'		=> $can_vote,
			'S_CAN_VOTE_UP'		=> $can_vote && !$s_voted_up,
			'S_CAN_VOTE_DOWN'	=> $can_vote && !$s_voted_down,
			'S_VOTED'			=> $s_voted_up || $s_voted_down,
			'S_VOTED_UP'		=> $s_voted_up,
			'S_VOTED_DOWN'		=> $s_voted_down,

			'U_CHANGE_STATUS'	=> $this->link_helper->get_idea_link($idea['idea_id'], 'status', true),
			'U_EDIT_DUPLICATE'	=> $this->link_helper->get_idea_link($idea['idea_id'], 'duplicate', true),
			'U_EDIT_RFC'		=> $this->link_helper->get_idea_link($idea['idea_id'], 'rfc', true),
			'U_EDIT_IMPLEMENTED'=> $this->link_helper->get_idea_link($idea['idea_id'], 'implemented', true),
			'U_EDIT_TICKET'		=> $this->link_helper->get_idea_link($idea['idea_id'], 'ticket', true),
			'U_REMOVE_VOTE'		=> $this->link_helper->get_idea_link($idea['idea_id'], 'removevote', true),
			'U_IDEA_VOTE'		=> $this->link_helper->get_idea_link($idea['idea_id'], 'vote', true),
			'U_IDEA_DUPLICATE'	=> $this->link_helper->get_idea_link($idea['duplicate_id']),
			'U_IDEA_STATUS_LINK'=> $this->helper->route('phpbb_ideas_list_controller', ['status' => $idea['idea_status']]),
			'U_TITLE_LIVESEARCH'=> $this->helper->route('phpbb_ideas_livesearch_controller'),
		));

		// Use Ideas breadcrumbs
		$this->template->destroy_block_vars('navlinks');
		$this->template->assign_block_vars('navlinks', array(
			'U_VIEW_FORUM'		=> $this->helper->route('phpbb_ideas_index_controller'),
			'FORUM_NAME'		=> $this->language->lang('IDEAS'),
		));
	}

	/**
	 * Adjust the QuickMod tools displayed
	 * (hide options to delete, restore, make global, sticky or announcement)
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 * @access public
	 */
	public function adjust_quickmod_tools($event)
	{
		if (!$this->is_ideas_forum($event['forum_id']))
		{
			return;
		}

		$quickmod_array = $event['quickmod_array'];

		//$quickmod_array['lock'][1] = false;
		//$quickmod_array['unlock'][1] = false;
		$quickmod_array['delete_topic'][1] = false;
		$quickmod_array['restore_topic'][1] = false;
		//$quickmod_array['move'][1] = false;
		//$quickmod_array['split'][1] = false;
		//$quickmod_array['merge'][1] = false;
		//$quickmod_array['merge_topic'][1] = false;
		//$quickmod_array['fork'][1] = false;
		$quickmod_array['make_normal'][1] = false;
		$quickmod_array['make_sticky'][1] = false;
		$quickmod_array['make_announce'][1] = false;
		$quickmod_array['make_global'][1] = false;

		$event['quickmod_array'] = $quickmod_array;
	}

	/**
	 * Show users as viewing Ideas on Who Is Online page
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 * @access public
	 */
	public function viewonline_ideas($event)
	{
		if (($event['on_page'][1] === 'viewtopic' && $event['row']['session_forum_id'] == $this->config['ideas_forum_id']) ||
			($event['on_page'][1] === 'app' && strrpos($event['row']['session_page'], 'app.' . $this->php_ext . '/ideas') === 0))
		{
			$event['location'] = $this->language->lang('VIEWING_IDEAS');
			$event['location_url'] = $this->helper->route('phpbb_ideas_index_controller');
		}
	}

	/**
	 * Modify the Ideas forum's posting page
	 *
	 * @param \phpbb\event\data $event The event object
	 */
	public function submit_idea_template($event)
	{
		if (!$this->is_ideas_forum($event['forum_id']))
		{
			return;
		}

		// Alter some posting page template vars
		if ($event['mode'] === 'post')
		{
			$event['page_title'] = $this->language->lang('POST_IDEA');
			$event->update_subarray('page_data', 'L_POST_A', $this->language->lang('POST_IDEA'));
			$event->update_subarray('page_data', 'U_VIEW_FORUM', $this->helper->route('phpbb_ideas_index_controller'));
		}

		// Alter posting page breadcrumbs to link to the ideas controller
		$this->template->alter_block_array('navlinks', [
			'U_BREADCRUMB'		=> $this->helper->route('phpbb_ideas_index_controller'),
			'BREADCRUMB_NAME'	=> $this->language->lang('IDEAS'),
		], false, 'change');
	}

	/**
	 * Prepare post data vars before posting a new idea/topic.
	 *
	 * @param \phpbb\event\data $event The event object
	 */
	public function submit_idea_before($event)
	{
		if (!$this->is_post_idea($event['mode'], $event['data']['forum_id'], empty($event['data']['topic_id'])))
		{
			return;
		}

		// We need $post_time after submit_post(), but it's not available in the post $data, unless we set it now
		$event->update_subarray('data', 'post_time', time());
	}

	/**
	 * Submit the idea data after posting a new idea/topic.
	 *
	 * @param \phpbb\event\data $event The event object
	 */
	public function submit_idea_after($event)
	{
		if (!$this->is_post_idea($event['mode'], $event['data']['forum_id'], !empty($event['data']['topic_id'])))
		{
			return;
		}

		$this->idea->submit($event['data']);

		// Show users whose posts need approval a special message
		if (!$this->auth->acl_get('f_noapprove', $event['data']['forum_id']))
		{
			// Using refresh and trigger error because we can't throw http_exceptions from posting.php
			$url = $this->helper->route('phpbb_ideas_index_controller');
			meta_refresh(10, $url);
			trigger_error($this->language->lang('IDEA_STORED_MOD', $url));
		}
	}

	/**
	 * Update the idea's title when post title is edited.
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 * @access public
	 */
	public function edit_idea_title($event)
	{
		if ($event['mode'] !== 'edit' ||
			!$event['update_subject'] ||
			!$this->is_ideas_forum($event['forum_id']) ||
			!$this->is_first_post($event['post_data']['topic_first_post_id'], $event['post_id']))
		{
			return;
		}

		$idea = $this->idea->get_idea_by_topic_id($event['topic_id']);
		$this->idea->set_title($idea['idea_id'], $event['post_data']['post_subject']);
	}

	/**
	 * Test if we are on the posting page for a new idea
	 *
	 * @param string $mode       Mode should be post
	 * @param int    $forum_id   The forum posting is being made in
	 * @param bool   $topic_flag Flag for the state of the topic_id
	 *
	 * @return bool True if mode is post, forum is Ideas forum, and a topic id is
	 *              expected to exist yet, false if any of these tests failed.
	 */
	protected function is_post_idea($mode, $forum_id, $topic_flag = true)
	{
		if ($mode !== 'post')
		{
			return false;
		}

		if (!$this->is_ideas_forum($forum_id))
		{
			return false;
		}

		return $topic_flag;
	}

	/**
	 * Check if forum id is for the ideas the forum
	 *
	 * @param int $forum_id
	 * @return bool
	 * @access public
	 */
	protected function is_ideas_forum($forum_id)
	{
		return (int) $forum_id === (int) $this->config['ideas_forum_id'];
	}

	/**
	 * Check if a post is the first post in a topic
	 *
	 * @param int|string $topic_first_post_id
	 * @param int|string $post_id
	 * @return bool
	 * @access protected
	 */
	protected function is_first_post($topic_first_post_id, $post_id)
	{
		return (int) $topic_first_post_id === (int) $post_id;
	}
}