abbc3_module::validate_google_fonts() - Code Metrics - Inspection of "Validate google font names" - iMattPro/abbc3 - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( ef56ac...a0448a )

by Matt
created 2023-05-09 03:38 UTC
abbc3_module::validate_google_fonts() A

↳ Parent: abbc3_module
Complexity

Conditions	4
Paths	3
Size

Total Lines	11
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	4
eloc	5
c	0
b	0
f	0
nc	3
nop	1
dl	0
loc	11
rs	10
<?php
/**
 *
 * Advanced BBCode Box
 *
 * @copyright (c) 2020 Matt Friedman
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace vse\abbc3\acp;

class abbc3_module
{
	/** @var \phpbb\cache\driver\driver_interface */
filter:
    dependency_paths: ["lib/*"]
	protected $cache;

	/** @var \phpbb\config\config */
filter:
    dependency_paths: ["lib/*"]
	protected $config;

	/** @var \phpbb\config\db_text */
filter:
    dependency_paths: ["lib/*"]
	protected $config_text;

	/** @var \Symfony\Component\DependencyInjection\ContainerInterface */
filter:
    dependency_paths: ["lib/*"]
	protected $container;

	/** @var \phpbb\db\driver\driver_interface */
filter:
    dependency_paths: ["lib/*"]
	protected $db;

	/** @var \phpbb\extension\manager */
filter:
    dependency_paths: ["lib/*"]
	protected $ext_manager;

	/** @var \phpbb\language\language */
filter:
    dependency_paths: ["lib/*"]
	protected $language;

	/** @var \phpbb\request\request */
filter:
    dependency_paths: ["lib/*"]
	protected $request;

	/** @var \phpbb\template\template */
filter:
    dependency_paths: ["lib/*"]
	protected $template;

	/** @var string */
	public $page_title;

	/** @var string */
	public $tpl_name;

	/** @var string */
	public $u_action;

	/** @var array */
	protected $errors = [];

	/**
	 * Constructor
	 *
	 * @throws \Exception
	 */
	public function __construct()
	{
		global $phpbb_container;

		$this->container   = $phpbb_container;
		$this->cache       = $this->container->get('cache');
		$this->config      = $this->container->get('config');
		$this->config_text = $this->container->get('config_text');
		$this->db          = $this->container->get('dbal.conn');
		$this->ext_manager = $this->container->get('ext.manager');
		$this->language    = $this->container->get('language');
		$this->request     = $this->container->get('request');
		$this->template    = $this->container->get('template');
	}

	/**
	 * Main ACP module
	 */
	public function main()
	{
		$this->language->add_lang('abbc3', 'vse/abbc3');

		$this->tpl_name   = 'acp_abbc3_settings';
		$this->page_title = $this->language->lang('ACP_ABBC3_SETTINGS');

		$form_key = 'vse/abbc3';
		add_form_key($form_key);
  add_form_key($form_key);

		if ($this->request->is_set_post('submit'))
		{
			if (!check_form_key($form_key))
			if (!/** @scrutinizer ignore-call */ check_form_key($form_key))
			{
				trigger_error('FORM_INVALID', E_USER_WARNING);
			}

			$this->save_settings();
		}

		$this->display_settings();
	}

	/**
	 * Add settings template vars to the form
	 */
	protected function display_settings()
	{
		$this->template->assign_vars([
			'S_ABBC3_PIPES'			=> $this->config['abbc3_pipes'],
			'S_ABBC3_BBCODE_BAR'	=> $this->config['abbc3_bbcode_bar'],
			'S_ABBC3_QR_BBCODES'	=> $this->config['abbc3_qr_bbcodes'],
			'S_ABBC3_AUTO_VIDEO'	=> $this->config['abbc3_auto_video'],
			'S_ABBC3_ICONS_TYPE'	=> build_select(['png' => 'PNG', 'svg' => 'SVG'], $this->config['abbc3_icons_type']),
			'S_ABBC3_ICONS_TYPE'	=> /** @scrutinizer ignore-call */ build_select(['png' => 'PNG', 'svg' => 'SVG'], $this->config['abbc3_icons_type']),
			'S_ABBC3_GOOGLE_FONTS'	=> $this->show_google_fonts(),
			'S_ABBC3_MEDIA_EMBED'	=> (int) $this->ext_manager->is_enabled('phpbb/mediaembed'),
			'U_ACTION'				=> $this->u_action,
		]);
	}

	/**
	 * Save settings data to the database
	 */
	protected function save_settings()
	{
		$this->config->set('abbc3_bbcode_bar', $this->request->variable('abbc3_bbcode_bar', 0));
		$this->config->set('abbc3_qr_bbcodes', $this->request->variable('abbc3_qr_bbcodes', 0));
		$this->config->set('abbc3_auto_video', $this->request->variable('abbc3_auto_video', 0));
		$this->config->set('abbc3_icons_type', $this->request->variable('abbc3_icons_type', 'png'));
		$this->save_pipes();
		$this->save_google_fonts();

		$this->cache->destroy($this->container->getParameter('text_formatter.cache.parser.key'));
		$this->cache->destroy($this->container->getParameter('text_formatter.cache.renderer.key'));

		if ($this->errors)

		{
			trigger_error(implode('<br>', $this->errors) . adm_back_link($this->u_action), E_USER_WARNING);
			trigger_error(implode('<br>', $this->errors) . /** @scrutinizer ignore-call */ adm_back_link($this->u_action), E_USER_WARNING);
		}

		trigger_error($this->language->lang('CONFIG_UPDATED') . adm_back_link($this->u_action));
	}

	/**
	 * Save the Pipes Table setting.
	 * - Set the config
	 * - Show or hide the Pipes BBCode button
	 * - Purge BBCode caches.
	 */
	protected function save_pipes()
	{
		$enable_pipes = $this->request->variable('abbc3_pipes', 0);

		$this->config->set('abbc3_pipes', $enable_pipes);

		$sql = 'UPDATE ' . BBCODES_TABLE . '

			SET display_on_posting = ' . (int) $enable_pipes . "
			WHERE bbcode_tag = 'pipes'";
		$this->db->sql_query($sql);
	}

	/**
	 * Get the Google font setting data and format it for the form.
	 *
	 * @return string
	 */
	protected function show_google_fonts()
	{
		$fonts = json_decode($this->config_text->get('abbc3_google_fonts'), true);
		return $fonts ? implode("\n", $fonts) : '';
	}

	/**
	 * Save the Google fonts setting.
	 * - If field has data, explode it to an array and save as JSON data.
	 * - If field is empty, store just an empty string.
	 */
	protected function save_google_fonts()
	{
		$fonts = $this->request->variable('abbc3_google_fonts', '');
		$fonts = explode("\n", $fonts);
		$this->validate_google_fonts($fonts);
		$this->config_text->set('abbc3_google_fonts', json_encode($fonts));
	}

	/**
	 * Validate Google Font exists.
	 *
	 * @param array $fonts
	 * @return void
	 */
	protected function validate_google_fonts(&$fonts)
	{
		foreach ($fonts as $key => $font)
		{
			if (empty($font) || $this->valid_url('https://fonts.googleapis.com/css?family=' . urlencode($font)))
			{
				continue;
			}

			$this->errors[] = $this->language->lang('ABBC3_INVALID_FONT', $font);
			unset($fonts[$key]);
		}
	}

	/**
	 * Check for valid URL headers
	 *
	 * @param string $url
	 * @return bool Return true if URL is valid, false if not. Return true if unable to check URL.
	 */
	private function valid_url($url)
	{
		$file_headers = @get_headers($url);
		return !$file_headers || $file_headers[0] === 'HTTP/1.1 200 OK';
	}
}

iMattPro / abbc3

Push — master ( ef56ac...a0448a )

abbc3_module::validate_google_fonts() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
