Add settings for progressive web app options

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

Author: iMattPro

controller/manifest.php

@@ -64,25 +64,24 @@ public function handle(): JsonResponse
 
 		$manifest = [
 			'name'			=> $this->config['sitename'],
-			'short_name'	=> substr($this->config['sitename'], 0, 12), // TODO need an ACP option for short name
+			'short_name'	=> $this->config['pwa_short_name'] ?? substr($this->config['sitename'], 0, 12),
 			'display'		=> 'standalone',
 			'orientation'	=> 'portrait',
 			'dir'			=> $this->language->lang('DIRECTION'),
 			'start_url'		=> $board_url,
 			'scope'			=> $board_url,
 		];
 
-		// TODO add support for icons
-		if (isset($this->config['wpn_app_icon_small'], $this->config['wpn_app_icon_large']))
+		if (!empty($this->config['pwa_icon_small']) && !empty($this->config['pwa_icon_large']))
 		{
 			$manifest['icons'] = [
 				[
-					'src' => $this->config['icons_path'] . $this->config['wpn_app_icon_small'],
+					'src' => $this->config['icons_path'] . '/' . $this->config['pwa_icon_small'],
 					'sizes' => '192x192',
 					'type' => 'image/png'
 				],
 				[
-					'src' => $this->config['icons_path'] . $this->config['wpn_app_icon_large'],
+					'src' => $this->config['icons_path'] . '/' . $this->config['pwa_icon_large'],
 					'sizes' => '512x512',
 					'type' => 'image/png'
 				]

event/listener.php

@@ -31,6 +31,7 @@ public static function getSubscribedEvents()
 			'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',
 		];
 	}
 
@@ -102,4 +103,27 @@ public function compatibility_notice()
 	{
 		$this->template->assign_var('S_WPN_COMPATIBILITY_NOTICE', phpbb_version_compare(PHPBB_VERSION, '4.0.0-dev', '>='));
 	}
+
+	/**
+	 * Progressive web app options for the ACP
+	 *
+	 * @param \phpbb\event\data $event
+	 * @return void
+	 */
+	public function acp_pwa_options($event)
+	{
+		if ($event['mode'] === 'settings' && array_key_exists('legend4', $event['display_vars']['vars']))
+		{
+			$this->language->add_lang('webpushnotifications_common_acp', 'phpbb/webpushnotifications');
+
+			$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],
+			];
+
+			$event->update_subarray('display_vars', 'vars', phpbb_insert_config_array($event['display_vars']['vars'], $my_config_vars, ['before' => 'legend4']));
+		}
+	}
 }

language/en/webpushnotifications_common_acp.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ *
+ * phpBB Browser Push Notifications. An extension for the phpBB Forum Software package.
+ *
+ * @copyright (c) 2024, phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ */
+
+/**
+ * DO NOT CHANGE
+ */
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+if (empty($lang) || !is_array($lang))
+{
+	$lang = [];
+}
+
+// DEVELOPERS PLEASE NOTE
+//
+// All language files should use UTF-8 as their encoding and the files must not contain a BOM.
+//
+// Placeholders can now contain order information, e.g. instead of
+// 'Page %s of %s' you can (and should) write 'Page %1$s of %2$s', this allows
+// translators to re-order the output of data while ensuring it remains correct
+//
+// You do not need this where single placeholders are used, e.g. 'Message %d' is fine
+// equally where a string contains only two placeholders which are used to wrap text
+// in a url you again do not need to specify an order e.g., 'Click %sHERE%s' is fine
+//
+// Some characters you may want to copy&paste:
+// ’ » “ ” …
+//
+
+$lang = array_merge($lang, [
+	'PWA_SETTINGS'	=> 'Web application options',
+	'PWA_SHORT_NAME'	=> 'Short site name',
+	'PWA_SHORT_NAME_EXPLAIN'	=> 'Your site name in 12 characters or less, which may be used as a label for an icon on a mobile device’s home screen.',
+	'PWA_ICON_SMALL'	=> 'Small mobile device icon',
+	'PWA_ICON_SMALL_EXPLAIN'	=> 'File name of a 192x192 PNG image. This file must be uploaded to your <samp>icons</samp> directory, i.e.: <samp>./images/icons</samp>',
+	'PWA_ICON_LARGE'	=> 'Large mobile device icon',
+	'PWA_ICON_LARGE_EXPLAIN'	=> 'File name of a 512x512 PNG image. This file must be uploaded to your <samp>icons</samp> directory, i.e.: <samp>./images/icons</samp>',
+]);

migrations/add_acp_pwa_configs.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ *
+ * phpBB Browser Push Notifications. An extension for the phpBB Forum Software package.
+ *
+ * @copyright (c) 2024, phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ */
+
+namespace phpbb\webpushnotifications\migrations;
+
+use phpbb\db\migration\migration;
+
+class add_acp_pwa_configs extends migration
+{
+	public function effectively_installed(): bool
+	{
+		return $this->config->offsetExists('pwa_short_name');
+	}
+
+	public static function depends_on()
+	{
+		return ['\phpbb\webpushnotifications\migrations\add_webpush'];
+	}
+
+	public function update_data(): array
+	{
+		return [
+			['config.add', ['pwa_short_name', '']],
+			['config.add', ['pwa_icon_small', '']],
+			['config.add', ['pwa_icon_large', '']],
+		];
+	}
+
+	public function revert_data(): array
+	{
+		return [
+			['config.remove', ['pwa_short_name']],
+			['config.remove', ['pwa_icon_small']],
+			['config.remove', ['pwa_icon_large']],
+		];
+	}
+}

notification/method/webpush.php

@@ -387,7 +387,7 @@ public function get_ucp_template_data(helper $controller_helper, form_helper $fo
 			'SUBSCRIPTIONS'					=> $subscriptions,
 			'WEBPUSH_FORM_TOKENS'			=> $form_helper->get_form_tokens(\phpbb\webpushnotifications\ucp\controller\webpush::FORM_TOKEN_UCP),
 			'U_MANIFEST_URL'				=> $controller_helper->route('phpbb_webpushnotifications_manifest_controller'),
-			'U_TOUCH_ICON'					=> $this->config['wpn_app_icon_small'] ?? '',
+			'U_TOUCH_ICON'					=> $this->config['pwa_icon_small'],
 		];
 	}
 

tests/event/listener_test.php

@@ -126,6 +126,7 @@ public function test_getSubscribedEvents()
 			'core.ucp_display_module_before',
 			'core.acp_main_notice',
 			'core.page_header_after',
+			'core.acp_board_config_edit_add',
 		], array_keys(\phpbb\webpushnotifications\event\listener::getSubscribedEvents()));
 	}