tas2580\seourls\event\listener

Complexity

Total Complexity

26

Size/Duplication

Total Lines	343
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes	26
Bugs	4	Features	4

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	getSubscribedEvents()	0	19	1
A	append_sid()	0	8	2
A	display_forums_modify_sql()	0	10	1
A	display_forums_modify_forum_rows()	0	11	2
B	display_forums_modify_template_vars()	0	27	2
B	pagination_generate_page_link()	0	20	6
A	search_modify_tpl_ary()	0	12	1
A	viewforum_modify_topicrow()	0	15	1
A	viewforum_get_topic_data()	0	8	1
A	viewtopic_get_post_data()	0	8	1
A	viewtopic_assign_template_vars_before()	0	7	1
A	viewtopic_modify_page_title()	0	8	1
A	viewtopic_modify_post_row()	0	8	1
A	generate_forum_nav()	0	15	2
A	make_jumpbox_modify_tpl_ary()	0	11	2

<?php
/**
 *
 * @package phpBB Extension - tas2580 SEO URLs
 * @copyright (c) 2016 tas2580 (https://tas2580.net)
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
 */

namespace tas2580\seourls\event;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Event listener
 */
class listener implements EventSubscriberInterface
{
	/** @var \tas2580\seourls\event\base */
	protected $base;

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

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

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

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

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

	/**
	 * Constructor
	 *
	 * @param \tas2580\seourls\event\base		$base
	 * @param \phpbb\template\template		$template				Template object
	 * @param \phpbb\request\request			$request				Request object
	 * @param \phpbb\path_helper			$path_helper			Controller helper object
	 * @param string						$phpbb_root_path		phpbb_root_path
	 * @param string						$php_ext				php_ext
	 * @access public
	 */
	public function __construct(\tas2580\seourls\event\base $base, \phpbb\template\template $template, \phpbb\request\request $request, \phpbb\path_helper $path_helper, $phpbb_root_path, $php_ext)
	{
		$this->base = $base;
		$this->template = $template;
		$this->request = $request;
		$this->path_helper = $path_helper;
		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext = $php_ext;
	}

	/**
	 * Assign functions defined in this class to event listeners in the core
	 *
	 * @return array
	 * @static
	 * @access public
	 */
	public static function getSubscribedEvents()
	{
		return array(
			'core.append_sid'						=> 'append_sid',
			'core.display_forums_modify_sql'			=> 'display_forums_modify_sql',
			'core.display_forums_modify_template_vars'	=> 'display_forums_modify_template_vars',
			'core.display_forums_modify_forum_rows'		=> 'display_forums_modify_forum_rows',
			'core.generate_forum_nav'				=> 'generate_forum_nav',
			'core.make_jumpbox_modify_tpl_ary'			=> 'make_jumpbox_modify_tpl_ary',				// Not in phpBB
			'core.pagination_generate_page_link'		=> 'pagination_generate_page_link',
			'core.search_modify_tpl_ary'				=> 'search_modify_tpl_ary',
			'core.viewforum_modify_topicrow'			=> 'viewforum_modify_topicrow',
			'core.viewforum_get_topic_data'			=> 'viewforum_get_topic_data',
			'core.viewtopic_assign_template_vars_before'	=> 'viewtopic_assign_template_vars_before',
			'core.viewtopic_modify_page_title'			=> 'viewtopic_modify_page_title',
			'core.viewtopic_modify_post_row'			=> 'viewtopic_modify_post_row',
			'core.viewtopic_get_post_data'				=> 'viewtopic_get_post_data',
		);
	}

	/**
	 * Correct the path of $viewtopic_url
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function append_sid($event)
	{
		if (preg_match('#./../viewtopic.' . $this->php_ext  . '#', $event['url']))
		{
			$url = $this->phpbb_root_path . 'viewtopic.' . $this->php_ext ;
			$event['url'] = $url;
		}
	}

	/**
	 * Get informations for the last post from Database
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function display_forums_modify_sql($event)
	{
		$sql_array = $event['sql_ary'];
		$sql_array['LEFT_JOIN'][] = array(
			'FROM' => array(TOPICS_TABLE => 't'),
			'ON' => "f.forum_last_post_id = t.topic_last_post_id"
		);
		$sql_array['SELECT'] .= ', t.topic_title, t.topic_id, t.topic_posts_approved, t.topic_posts_unapproved, t.topic_posts_softdeleted';
		$event['sql_ary'] = $sql_array;
	}

	/**
	 * Store informations for the last post in forum_rows array
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function display_forums_modify_forum_rows($event)
	{
		$forum_rows = $event['forum_rows'];
		if ($event['row']['forum_last_post_time'] == $forum_rows[$event['parent_id']]['forum_last_post_time'])
		{
			$forum_rows[$event['parent_id']]['forum_name_last_post'] =$event['row']['forum_name'];
			$forum_rows[$event['parent_id']]['topic_id_last_post'] =$event['row']['topic_id'];
			$forum_rows[$event['parent_id']]['topic_title_last_post'] =$event['row']['topic_title'];
			$event['forum_rows'] = $forum_rows;
		}
	}

	/**
	 * Rewrite links to forums and subforums in forum index
	 * also correct the path of the forum images if we are in a forum
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function display_forums_modify_template_vars($event)
	{
		$subforums_row = $event['subforums_row'];
		$forum_row = $event['forum_row'];

		// Rewrite URLs of sub forums
		foreach ($subforums_row as $i => $subforum)
		{
			// A little bit a dirty way, but there is no better solution
			$query = str_replace('&amp;', '&', parse_url($subforum['U_SUBFORUM'], PHP_URL_QUERY));
			parse_str($query, $id);
			$subforums_row[$i]['U_SUBFORUM'] = append_sid($this->base->generate_forum_link($id['f'], $subforum['SUBFORUM_NAME']));
		}

		// Update the image source in forums
		$img = $this->path_helper->update_web_root_path($forum_row['FORUM_IMAGE_SRC']);
		$forum_row['FORUM_IMAGE'] = preg_replace('#img src=\"(.*)\" alt#', 'img src="' . $img . '" alt', $forum_row['FORUM_IMAGE']);

		// Rewrite links to topics, posts and forums
		$replies = $this->base->get_count('topic_posts', $event['row'], $event['row']['forum_id']) - 1;
		$url = $this->base->generate_topic_link($event['row']['forum_id_last_post'], $event['row']['forum_name_last_post'], $event['row']['topic_id_last_post'], $event['row']['topic_title_last_post']);
		$forum_row['U_LAST_POST'] = append_sid($this->base->generate_lastpost_link($replies, $url) . '#p' . $event['row']['forum_last_post_id']);
		$forum_row['U_VIEWFORUM'] = append_sid($this->base->generate_forum_link($forum_row['FORUM_ID'], $forum_row['FORUM_NAME']));

		$event['subforums_row'] = $subforums_row;
		$event['forum_row'] = $forum_row;
	}

	/**
	 * Rewrite links in breadcrumbs
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function generate_forum_nav($event)
	{
		$forum_data = $event['forum_data'];
		$navlinks = $event['navlinks'];
		$navlinks_parents = $event['navlinks_parents'];

		foreach ($navlinks_parents as $id => $data)

This code seems to be duplicated across your project.

		{
			$navlinks_parents[$id]['U_VIEW_FORUM'] = append_sid($this->base->generate_forum_link($data['FORUM_ID'] , $data['FORUM_NAME']));
		}

		$navlinks['U_VIEW_FORUM'] = append_sid($this->base->generate_forum_link($forum_data['forum_id'], $forum_data['forum_name']));
		$event['navlinks'] = $navlinks;
		$event['navlinks_parents'] = $navlinks_parents;
	}

	// Not in phpBB
	public function make_jumpbox_modify_tpl_ary($event)
	{
		$tpl_ary = $event['tpl_ary'];
		$row = $event['row'];
		foreach ($tpl_ary as $id => $data)

This code seems to be duplicated across your project.

		{
			$tpl_ary[$id]['LINK']	 = append_sid($this->base->generate_forum_link($row['forum_id'], $row['forum_name']));
		}

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

	/**
	 * Rewrite pagination links
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function pagination_generate_page_link($event)
	{
		// If we have a sort key we do not rewrite the URL
		$query = str_replace('&', '&', parse_url($event['base_url'], PHP_URL_QUERY));
		parse_str($query, $param);
		if (isset($param['sd']) || isset($param['sk']) || isset($param['st']))
		{
			return;
		}

		$start = (($event['on_page'] - 1) * $event['per_page']);
		if (!empty($this->topic_title))
		{
			$event['generate_page_link_override'] = append_sid($this->base->generate_topic_link($this->forum_id, $this->forum_title, $this->topic_id, $this->topic_title, $start));
		}
		else if (!empty($this->forum_title))
		{
			$event['generate_page_link_override'] = append_sid($this->base->generate_forum_link($this->forum_id, $this->forum_title, $start));
		}
	}

	/**
	 * Rewrite links in the search result
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function search_modify_tpl_ary($event)
	{
		$replies = $this->base->get_count('topic_posts', $event['row'], $event['row']['forum_id']) - 1;
		$u_view_topic = $this->base->generate_topic_link($event['row']['forum_id'], $event['row']['forum_name'], $event['row']['topic_id'], $event['row']['topic_title']);

		$tpl_ary = $event['tpl_ary'];
		$tpl_ary['U_LAST_POST'] = append_sid($this->base->generate_lastpost_link($replies, $u_view_topic) . '#p' . $event['row']['topic_last_post_id']);
		$tpl_ary['U_VIEW_TOPIC'] = append_sid($u_view_topic);
		$tpl_ary['U_VIEW_FORUM'] = append_sid($this->base->generate_forum_link($event['row']['forum_id'], $event['row']['forum_name']));

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

	/**
	 * Rewrite links to topics in forum view
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function viewforum_modify_topicrow($event)
	{
		$topic_row = $event['topic_row'];
		$this->forum_title = $topic_row['FORUM_NAME'];
		$this->forum_id = $topic_row['FORUM_ID'];
		$this->topic_title = $topic_row['TOPIC_TITLE'];
		$this->topic_id = $topic_row['TOPIC_ID'];

		$u_view_topic = $this->base->generate_topic_link($this->forum_id, $this->forum_title, $this->topic_id, $this->topic_title);
		$topic_row['U_VIEW_TOPIC'] = append_sid($u_view_topic);
		$topic_row['U_VIEW_FORUM'] = append_sid($this->base->generate_forum_link($this->forum_id, $this->forum_title));
		$topic_row['U_LAST_POST'] = append_sid($this->base->generate_lastpost_link($event['topic_row']['REPLIES'], $u_view_topic) . '#p' . $event['row']['topic_last_post_id']);

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

	/**
	 * Rewrite the canonical URL on viewforum.php
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function viewforum_get_topic_data($event)
	{
		$start = $this->request->variable('start', 0);
		$this->template->assign_vars(array(
			'U_VIEW_FORUM'	=> append_sid($this->base->generate_forum_link($event['forum_data']['forum_id'], $event['forum_data']['forum_name'], $start)),
			'U_CANONICAL'		=> $this->base->generate_forum_link($event['forum_data']['forum_id'], $event['forum_data']['forum_name'], $start, true),
		));
	}

	/**
	 * Rewrite the topic URL for the headline of the topic page and the link back to forum
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function viewtopic_get_post_data($event)
	{
		$data = $event['topic_data'];
		$this->template->assign_vars(array(
			'U_VIEW_TOPIC'		=> append_sid($this->base->generate_topic_link($event['forum_id'] , $data['forum_name'], $event['topic_id'], $data['topic_title'], $event['start'])),
			'U_VIEW_FORUM'	=> append_sid($this->base->generate_forum_link($event['forum_id'] , $data['forum_name'])),
		));
	}

	/**
	 * Assign topic data to global variables for pagination
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function viewtopic_assign_template_vars_before($event)
	{
		$this->forum_title = $event['topic_data']['forum_name'];
		$this->forum_id = $event['topic_data']['forum_id'];
		$this->topic_title = $event['topic_data']['topic_title'];
		$this->topic_id = $event['topic_data']['topic_id'];
	}

	/**
	 * Rewrite the canonical URL on viewtopic.php
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function viewtopic_modify_page_title($event)
	{
		$start = $this->request->variable('start', 0);
		$data = $event['topic_data'];
		$this->template->assign_vars(array(
			'U_CANONICAL'		=> $this->base->generate_topic_link($data['forum_id'], $data['forum_name'], $data['topic_id'], $data['topic_title'], $start, true),
		));
	}

	/**
	 * Rewrite mini post img link
	 *
	 * @param	object	$event	The event object
	 * @return	null
	 * @access	public
	 */
	public function viewtopic_modify_post_row($event)
	{
		$row = $event['post_row'];
		$start = $this->request->variable('start', 0);
		$data = $event['topic_data'];
		$row['U_MINI_POST'] = append_sid($this->base->generate_topic_link($data['forum_id'], $data['forum_name'], $data['topic_id'], $data['topic_title'], $start) . '#p' . $event['row']['post_id']);
		$event['post_row'] = $row;
	}
}