Validate PWA options in ACP

Signed-off-by: Matt Friedman <maf675@gmail.com>

Author: iMattPro

config/services.yml

@@ -12,11 +12,14 @@ services:
     phpbb.wpn.listener:
         class: phpbb\webpushnotifications\event\listener
         arguments:
+            - '@config'
             - '@controller.helper'
+            - '@upload_imagesize'
             - '@phpbb.wpn.form_helper'
             - '@language'
             - '@template'
             - '@notification_manager'
+            - '%core.root_path%'
         tags:
             - { name: event.listener }
 

event/listener.php

@@ -13,34 +13,33 @@
 /**
  * @ignore
  */
-use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+use FastImageSize\FastImageSize;
+use phpbb\config\config;
 use phpbb\controller\helper as controller_helper;
-use phpbb\webpushnotifications\form\form_helper;
 use phpbb\language\language;
 use phpbb\notification\manager;
 use phpbb\template\template;
+use phpbb\webpushnotifications\form\form_helper;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 /**
  * Event listener
  */
 class listener implements EventSubscriberInterface
 {
-	public static function getSubscribedEvents()
-	{
-		return [
-			'core.ucp_display_module_before'	=> 'load_language',
-			'core.acp_main_notice'				=> 'compatibility_notice',
-			'core.page_header_after'			=> 'load_template_data',
-			'core.acp_board_config_edit_add'		=> 'acp_pwa_options',
-		];
-	}
+	/** @var config */
+	protected $config;
 
 	/* @var controller_helper */
 	protected $controller_helper;
 
 	/* @var form_helper */
 	protected $form_helper;
 
+	/** @var FastImageSize */
+	protected $imagesize;
+
 	/* @var language */
 	protected $language;
 
@@ -50,22 +49,42 @@ public static function getSubscribedEvents()
 	/* @var manager */
 	protected $phpbb_notifications;
 
+	/** @var string */
+	protected $root_path;
+
 	/**
 	 * Constructor
 	 *
+	 * @param config $config
 	 * @param controller_helper $controller_helper Controller helper object
+	 * @param FastImageSize $imagesize
 	 * @param form_helper $form_helper Form helper object
 	 * @param language $language Language object
 	 * @param template $template Template object
 	 * @param manager $phpbb_notifications Notifications manager object
+	 * @param $root_path
 	 */
-	public function __construct(controller_helper $controller_helper, form_helper $form_helper, language $language, template $template, manager $phpbb_notifications)
+	public function __construct(config $config, controller_helper $controller_helper, FastImageSize $imagesize, form_helper $form_helper, language $language, template $template, manager $phpbb_notifications, $root_path)
 	{
+		$this->config = $config;
 		$this->controller_helper = $controller_helper;
+		$this->imagesize = $imagesize;
 		$this->form_helper = $form_helper;
 		$this->language = $language;
 		$this->template = $template;
 		$this->phpbb_notifications = $phpbb_notifications;
+		$this->root_path = $root_path;
+	}
+
+	public static function getSubscribedEvents()
+	{
+		return [
+			'core.ucp_display_module_before'	=> 'load_language',
+			'core.acp_main_notice'				=> 'compatibility_notice',
+			'core.page_header_after'			=> 'load_template_data',
+			'core.acp_board_config_edit_add'		=> 'acp_pwa_options',
+			'core.validate_config_variable'		=> 'validate_pwa_options',
+		];
 	}
 
 	/**
@@ -119,11 +138,55 @@ public function acp_pwa_options($event)
 			$my_config_vars = [
 				'legend_pwa_settings'=> 'PWA_SETTINGS',
 				'pwa_short_name'	=> ['lang' => 'PWA_SHORT_NAME', 'validate' => 'string', 'type' => 'text:40:12', 'explain' => true],
-				'pwa_icon_small'	=> ['lang' => 'PWA_ICON_SMALL', 'validate' => 'string', 'type' => 'text:40:255', 'explain' => true],
-				'pwa_icon_large'	=> ['lang' => 'PWA_ICON_LARGE', 'validate' => 'string', 'type' => 'text:40:255', 'explain' => true],
+				'pwa_icon_small'	=> ['lang' => 'PWA_ICON_SMALL', 'validate' => 'pwa_options', 'type' => 'text:40:255', 'explain' => true],
+				'pwa_icon_large'	=> ['lang' => 'PWA_ICON_LARGE', 'validate' => 'pwa_options', 'type' => 'text:40:255', 'explain' => true],
 			];
 
 			$event->update_subarray('display_vars', 'vars', phpbb_insert_config_array($event['display_vars']['vars'], $my_config_vars, ['before' => 'legend4']));
 		}
 	}
+
+	/**
+	 * Validate PWA options
+	 *
+	 * @param \phpbb\event\data $event
+	 * @return void
+	 */
+	public function validate_pwa_options($event)
+	{
+		if ($event['config_definition']['validate'] !== 'pwa_options' || empty($event['cfg_array']['pwa_icon_small']) || empty($event['cfg_array']['pwa_icon_large']))
+		{
+			return;
+		}
+
+		$value = $event['cfg_array'][$event['config_name']];
+		$error = $event['error'];
+
+		$image = $this->root_path . $this->config['icons_path'] . '/' . $value;
+		if (!file_exists($image))
+		{
+			$error[] = $this->language->lang('PWA_IMAGE_NOT_FOUND', $value);
+		}
+
+		$image_info = $this->imagesize->getImageSize($image);
+		if ($image_info !== false)
+		{
+			if (($event['config_name'] === 'pwa_icon_small' && $image_info['width'] !== 192 && $image_info['height'] !== 192) ||
+				($event['config_name'] === 'pwa_icon_large' && $image_info['width'] !== 512 && $image_info['height'] !== 512))
+			{
+				$error[] = $this->language->lang('PWA_ICON_SIZE_INVALID', $value);
+			}
+
+			if ($image_info['type'] !== IMAGETYPE_PNG)
+			{
+				$error[] = $this->language->lang('PWA_ICON_MIME_INVALID', $value);
+			}
+		}
+		else
+		{
+			$error[] = $this->language->lang('PWA_IMAGE_INVALID', $value);
+		}
+
+		$event['error'] = $error;
+	}
 }

language/en/webpushnotifications_common_acp.php

@@ -45,4 +45,8 @@
 	'PWA_ICON_SMALL_EXPLAIN'	=> 'File name of a 192px x 192px PNG image. This file must be uploaded to your <samp>icons</samp> directory, e.g. <samp>./images/icons</samp>',
 	'PWA_ICON_LARGE'			=> 'Large mobile device icon',
 	'PWA_ICON_LARGE_EXPLAIN'	=> 'File name of a 512px x 512px PNG image. This file must be uploaded to your <samp>icons</samp> directory, e.g. <samp>./images/icons</samp>',
+	'PWA_ICON_SIZE_INVALID'		=> '%s does not have the correct image dimensions.',
+	'PWA_ICON_MIME_INVALID'		=> '%s must be a PNG image file.',
+	'PWA_IMAGE_INVALID'			=> '%s does not appear to be a valid image file.',
+	'PWA_IMAGE_NOT_FOUND'		=> '%s could not be found.',
 ]);

tests/event/listener_test.php

@@ -33,6 +33,9 @@ class listener_test extends \phpbb_database_test_case
 	/* @var \PHPUnit\Framework\MockObject\MockObject|\phpbb\notification\manager */
 	protected $phpbb_notifications;
 
+	/** @var string */
+	protected $root_path;
+
 	protected static function setup_extensions()
 	{
 		return ['phpbb/webpushnotifications'];
@@ -101,16 +104,21 @@ protected function setUp(): void
 			'phpbb_wpn_notification_push',
 			'phpbb_wpn_push_subscriptions'
 		);
+
+		$this->root_path = $phpbb_root_path;
 	}
 
 	protected function set_listener()
 	{
 		$this->listener = new \phpbb\webpushnotifications\event\listener(
+			$this->config,
 			$this->controller_helper,
+			new \FastImageSize\FastImageSize(),
 			$this->form_helper,
 			$this->language,
 			$this->template,
-			$this->notifications
+			$this->notifications,
+			$this->root_path
 		);
 	}
 
@@ -127,6 +135,7 @@ public function test_getSubscribedEvents()
 			'core.acp_main_notice',
 			'core.page_header_after',
 			'core.acp_board_config_edit_add',
+			'core.validate_config_variable',
 		], array_keys(\phpbb\webpushnotifications\event\listener::getSubscribedEvents()));
 	}