phpbb\mediaembed\event\main_listener

Complexity

Total Complexity

44

Size/Duplication

Total Lines	370
Duplicated Lines	0 %

Importance

Changes	29
Bugs	1	Features	1

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	getSubscribedEvents()	0	13	1
A	append_agreement()	0	10	3
A	setup_media_configs()	0	5	1
A	enable_media_sites()	0	17	4
A	modify_tag_templates()	0	12	2
A	disable_media_embed()	0	14	3
A	configure_url_parsing()	0	7	2
A	set_permissions()	0	4	1
A	get_siteIds()	0	5	2
A	check_signature()	0	6	4
A	check_magic_urls()	0	5	3
A	check_forum_permission()	0	6	3
A	check_bbcode_enabled()	0	8	2
A	media_embed_help()	0	20	2
A	add_custom_sites()	0	18	4
A	setup_media_bbcode()	0	4	1
A	setup_cache_dir()	0	9	3
A	check_pm_permission()	0	6	2

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

namespace phpbb\mediaembed\event;

use phpbb\auth\auth;

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

use phpbb\config\config;

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

use phpbb\config\db_text;

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

use phpbb\language\language;

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

use phpbb\mediaembed\collection\customsitescollection;
use phpbb\mediaembed\ext;
use phpbb\template\template;

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

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?

use Symfony\Component\Yaml\Yaml;

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

/**
 * Event listener
 */
class main_listener implements EventSubscriberInterface
{
	/** @var string A link to a rich content media site for demo purposes */
	public const MEDIA_DEMO_URL = 'https://youtu.be/Ne18ZQ7LLI0';

	/** @var auth */
	protected $auth;

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

	/** @var db_text $config_text */
	protected $config_text;

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

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

	/** @var customsitescollection $custom_sites */
	protected $custom_sites;

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

	/** @var bool Disable the media embed plugin (plain url parsing) */
	protected $disable_plugin = false;

	/** @var bool Disable the media tag (bbcode parsing) */
	protected $disable_tag = false;

	/**
	 * {@inheritDoc}
	 */
	public static function getSubscribedEvents()
	{
		return [
			'core.text_formatter_s9e_configure_after'	=> [['add_custom_sites', 3], ['enable_media_sites', 2], ['configure_url_parsing', 1], ['modify_tag_templates', 0]],
			'core.display_custom_bbcodes'				=> 'setup_media_bbcode',
			'core.permissions'							=> 'set_permissions',
			'core.help_manager_add_block_before'		=> 'media_embed_help',
			'core.posting_modify_message_text'			=> 'check_forum_permission',
			'core.ucp_pm_compose_modify_parse_before'	=> 'check_pm_permission',
			'core.message_parser_check_message'			=> [['check_signature'], ['check_magic_urls'], ['check_bbcode_enabled']],
			'core.text_formatter_s9e_parser_setup'		=> [['disable_media_embed'], ['setup_cache_dir']],
			'core.page_header' 							=> 'setup_media_configs',
			'core.page_footer'							=> 'append_agreement',
		];
	}

	/**
	 * Constructor
	 *
	 * @param auth					$auth
	 * @param config				$config
	 * @param db_text				$config_text
	 * @param language				$language
	 * @param template				$template
	 * @param customsitescollection	$custom_sites
	 * @param string				$cache_dir
	 */
	public function __construct(auth $auth, config $config, db_text $config_text, language $language, template $template, customsitescollection $custom_sites, $cache_dir)
	{
		$this->auth = $auth;
		$this->config = $config;
		$this->language = $language;
		$this->template = $template;
		$this->config_text = $config_text;
		$this->custom_sites = $custom_sites;
		$this->cache_dir = $cache_dir;
	}

	/**
	 * Add any custom site definitions to the default MediaEmbed sites object
	 *
	 * @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 add_custom_sites($event)
	{
		$is_phpbb4 = phpbb_version_compare($this->config['version'], '4.0.0-a1', '>=');

The function phpbb_version_compare was not found. Maybe you did not declare it correctly or list all dependencies?

		$phpbb4_builtins = array_flip([
			'applepodcasts', 'bluesky', 'bunny', 'mastodon', 'pastebin', 'threads', 'twitter',
		]);

		foreach ($this->custom_sites->get_collection() as $site)
		{
			$name = basename($site, ext::YML);

			// Skip built-in sites when running phpBB 4
			if ($is_phpbb4 && isset($phpbb4_builtins[$name]))
			{
				continue;
			}

			$event['configurator']->MediaEmbed->defaultSites->add($name, Yaml::parseFile($site));
		}
	}

	/**
	 * Enable media sites
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 */
	public function enable_media_sites($event)
	{
		foreach ($this->get_siteIds() as $siteId)
		{
			// skip media sites that already exist as a BBCode
			if (isset($event['configurator']->BBCodes[$siteId]))
			{
				continue;
			}

			try
			{
				$event['configurator']->MediaEmbed->add($siteId);
			}
			catch (\RuntimeException $e)
			{
				continue;
			}
		}
	}

	/**
	 * Configure plain URL parsing
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 */
	public function configure_url_parsing($event)
	{
		// Disable plain url parsing?
		if (!$this->config->offsetGet('media_embed_parse_urls'))
		{
			$event['configurator']->MediaEmbed->finalize();
			unset($event['configurator']->MediaEmbed);
		}
	}

	/**
	 * Modify bbcode tag templates
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 */
	public function modify_tag_templates($event)
	{
		try
		{
			// force YouTube to use the no cookies until the user starts video playback, and fix referrer policy issues
			$tag = $event['configurator']->tags['YOUTUBE'];
			$tag->template = str_replace(['www.youtube.com', ' allowfullscreen'], ['www.youtube-nocookie.com', ' referrerpolicy="origin" allowfullscreen'], $tag->template);

			$event['configurator']->finalize();
		}
		catch (\RuntimeException $e)
		{
			// do nothing
		}
	}

	/**
	 * Set template switch for displaying the [media] BBCode button
	 *
	 * @return void
	 */
	public function setup_media_bbcode()
	{
		$this->language->add_lang('common', 'phpbb/mediaembed');
		$this->template->assign_var('S_BBCODE_MEDIA', $this->config->offsetGet('media_embed_bbcode'));
	}

	/**
	 * Set media embed forum and user PM permission
	 *
	 * @param	\phpbb\event\data	$event	The event object
	 * @return	void
	 */
	public function set_permissions($event)
	{
		$event->update_subarray('permissions', 'f_mediaembed', ['lang' => 'ACL_F_MEDIAEMBED', 'cat' => 'content']);
		$event->update_subarray('permissions', 'u_pm_mediaembed', ['lang' => 'ACL_U_PM_MEDIAEMBED', 'cat' => 'pm']);
	}

	/**
	 * Add Media Embed help to the BBCode Guide
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 */
	public function media_embed_help($event)
	{
		if ($event['block_name'] === 'HELP_BBCODE_BLOCK_OTHERS')
		{
			$this->language->add_lang('help', 'phpbb/mediaembed');

			$this->template->assign_block_vars('faq_block', [
				'BLOCK_TITLE'	=> $this->language->lang('HELP_EMBEDDING_MEDIA'),
				'SWITCH_COLUMN'	=> false,
			]);

			$uid = $bitfield = $flags = '';
			$demo_text = self::MEDIA_DEMO_URL;
			generate_text_for_storage($demo_text, $uid, $bitfield, $flags, true, true);

The function generate_text_for_storage was not found. Maybe you did not declare it correctly or list all dependencies?

			$demo_display = generate_text_for_display($demo_text, $uid, $bitfield, $flags);

The function generate_text_for_display was not found. Maybe you did not declare it correctly or list all dependencies?

			$list_sites = implode(', ', $this->get_siteIds());

			$this->template->assign_block_vars('faq_block.faq_row', [
				'FAQ_QUESTION'	=> $this->language->lang('HELP_EMBEDDING_MEDIA_QUESTION'),
				'FAQ_ANSWER'	=> $this->language->lang('HELP_EMBEDDING_MEDIA_ANSWER', self::MEDIA_DEMO_URL, $demo_display, $list_sites),
			]);
		}
	}

	/**
	 * Disable Media Embed plugin and tag if necessary
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 */
	public function disable_media_embed($event)
	{
		/** @var \phpbb\textformatter\s9e\parser $service  */
		$service = $event['parser'];
		$parser = $service->get_parser();

		if ($this->disable_plugin)
		{
			$parser->disablePlugin('MediaEmbed');
		}

		if ($this->disable_tag)
		{
			$parser->disableTag('MEDIA');
		}
	}

	/**
	 * Set up a cache directory to improve scraping performance
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 */
	public function setup_cache_dir($event)
	{
		if ($this->cache_dir && $this->config->offsetGet('media_embed_enable_cache'))
		{
			/** @var \phpbb\textformatter\s9e\parser $service  */
			$service = $event['parser'];
			$parser = $service->get_parser();

			$parser->registeredVars['cacheDir'] = $this->cache_dir;
		}
	}

	/**
	 * Check if forum permission allows Media Embed
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 */
	public function check_forum_permission($event)
	{
		if (!$this->auth->acl_get('f_mediaembed', $event['forum_id']) || !$this->auth->acl_get('f_bbcode', $event['forum_id']))
		{
			$this->disable_plugin = true;
			$this->disable_tag = true;
		}
	}

	/**
	 * Check if user permission allows Media Embed in private messages
	 *
	 * @return void
	 */
	public function check_pm_permission()
	{
		if (!$this->auth->acl_get('u_pm_mediaembed'))
		{
			$this->disable_plugin = true;
			$this->disable_tag = true;
		}
	}

	/**
	 * Check if signature posting is allowed.
	 * Posting signatures is 'sig', reparsing signatures is 'user_signature'.
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 */
	public function check_signature($event)
	{
		if (($event['mode'] === 'sig' || $event['mode'] === 'text_reparser.user_signature') && !$this->config->offsetGet('media_embed_allow_sig'))
		{
			$this->disable_plugin = true;
			$this->disable_tag = true;
		}
	}

	/**
	 * Check if magic urls is allowed.
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 */
	public function check_magic_urls($event)
	{
		if (!$event['allow_magic_url'] || !$this->config->offsetGet('media_embed_parse_urls'))
		{
			$this->disable_plugin = true;
		}
	}

	/**
	 * Check if bbcodes are allowed.
	 *
	 * @param \phpbb\event\data $event The event object
	 * @return void
	 */
	public function check_bbcode_enabled($event)
	{
		if (!$event['allow_bbcode'])
		{
			// Want to leave plugin enabled, but it seems plugin won't work
			// when tag is disabled, so we have to disable both it seems.
			$this->disable_plugin = true;
			$this->disable_tag = true;
		}
	}

	public function setup_media_configs()
	{
		$this->template->assign_vars([
			'S_MEDIA_EMBED_FULL_WIDTH' => $this->config->offsetGet('media_embed_full_width'),
			'S_MEDIA_EMBED_MAX_WIDTHS' => json_decode($this->config_text->get('media_embed_max_width'), true),
		]);
	}

	/**
	 * Get allowed sites for media embedding
	 *
	 * @return array An array of sites
	 */
	protected function get_siteIds()
	{
		$siteIds = $this->config_text->get('media_embed_sites');

		return $siteIds ? json_decode($siteIds, true) : [];
	}

	/**
	 * Appends additional language to the privacy policy agreement text.
	 *
	 * @return void
	 */
	public function append_agreement()
	{
		if (!$this->template->retrieve_var('S_AGREEMENT') || ($this->template->retrieve_var('AGREEMENT_TITLE') !== $this->language->lang('PRIVACY')))
		{
			return;
		}

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

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