Rename config values to wpn-prefixed.

Author: rxu

acp/wpn_acp_module.php

@@ -101,9 +101,9 @@ public function main($id, $mode)
 	public function display_settings()
 	{
 		$this->template->assign_vars([
-			'S_WEBPUSH_ENABLE'		=> $this->config['webpush_enable'],
-			'WEBPUSH_VAPID_PUBLIC'	=> $this->config['webpush_vapid_public'],
-			'WEBPUSH_VAPID_PRIVATE'	=> $this->config['webpush_vapid_private'],
+			'S_WEBPUSH_ENABLE'		=> $this->config['wpn_webpush_enable'],
+			'WEBPUSH_VAPID_PUBLIC'	=> $this->config['wpn_webpush_vapid_public'],
+			'WEBPUSH_VAPID_PRIVATE'	=> $this->config['wpn_webpush_vapid_private'],
 			'U_ACTION'				=> $this->u_action,
 		]);
 	}
@@ -117,12 +117,12 @@ public function save_settings()
 	{
 		$config_array = $this->request->variable('config', ['' => ''], true);
 		$display_settings = [
-			'webpush_enable' => ['validate' => 'bool'],
-			'webpush_vapid_public' => ['validate' => 'string:25:255', 'lang' => 'WEBPUSH_VAPID_PUBLIC'],
-			'webpush_vapid_private'=> ['validate' => 'string:25:255', 'lang' => 'WEBPUSH_VAPID_PRIVATE'],
+			'wpn_webpush_enable' => ['validate' => 'bool'],
+			'wpn_webpush_vapid_public' => ['validate' => 'string:25:255', 'lang' => 'WEBPUSH_VAPID_PUBLIC'],
+			'wpn_webpush_vapid_private'=> ['validate' => 'string:25:255', 'lang' => 'WEBPUSH_VAPID_PRIVATE'],
 		];
 
-		if ($config_array['webpush_enable'])
+		if ($config_array['wpn_webpush_enable'])
 		{
 			// Validate config values
 			validate_config_vars($display_settings, $config_array, $this->errors);
@@ -140,9 +140,9 @@ public function save_settings()
 
 		$this->log->add('admin', $this->user->data['user_id'], $this->user->ip, 'LOG_CONFIG_WEBPUSH');
 
-		$this->config->set('webpush_enable', $config_array['webpush_enable']);
-		$this->config->set('webpush_vapid_public', $config_array['webpush_vapid_public']);
-		$this->config->set('webpush_vapid_private', $config_array['webpush_vapid_private']);
+		$this->config->set('webpush_enable', $config_array['wpn_webpush_enable']);
+		$this->config->set('webpush_vapid_public', $config_array['wpn_webpush_vapid_public']);
+		$this->config->set('webpush_vapid_private', $config_array['wpn_webpush_vapid_private']);
 
 		trigger_error($this->lang->lang('CONFIG_UPDATED') . adm_back_link($this->u_action), E_USER_NOTICE);
 	}

adm/style/wpn_acp_settings.html

@@ -17,17 +17,17 @@ <h3>{{ lang('WARNING') }}</h3>
 		<legend>{{ lang('GENERAL_SETTINGS') }}</legend>
 		<dl>
 			<dt><label>{{ lang('WEBPUSH_ENABLE') ~ lang('COLON') }}</label><br><span>{{ lang('WEBPUSH_ENABLE_EXPLAIN') }}</span></dt>
-			<dd><label><input type="radio" class="radio" name="config[webpush_enable]" value="1" {% if S_WEBPUSH_ENABLE %}checked="checked"{% endif %}> {{ lang('YES') }}</label>
-				<label><input type="radio" class="radio" name="config[webpush_enable]" value="0"{% if not S_WEBPUSH_ENABLE %} checked="checked"{% endif %}> {{ lang('NO') }}</label>
+			<dd><label><input type="radio" class="radio" name="config[wpn_webpush_enable]" value="1" {% if S_WEBPUSH_ENABLE %}checked="checked"{% endif %}> {{ lang('YES') }}</label>
+				<label><input type="radio" class="radio" name="config[wpn_webpush_enable]" value="0"{% if not S_WEBPUSH_ENABLE %} checked="checked"{% endif %}> {{ lang('NO') }}</label>
 				<input class="button2" data-ajax="generate_vapid_keys" type="button" name="config[webpush_enable]" value="{{ lang('WEBPUSH_GENERATE_VAPID_KEYS') }}"></dd>
 		</dl>
 		<dl>
 			<dt><label for="webpush_vapid_public">{{ lang('WEBPUSH_VAPID_PUBLIC') ~ lang('COLON') }}</label><br><span>{{ lang('WEBPUSH_VAPID_PUBLIC_EXPLAIN') }}</span></dt>
-			<dd><label><input id="webpush_vapid_public" type="text" name="config[webpush_vapid_public]" size="25" maxlength="255" value="{{ WEBPUSH_VAPID_PUBLIC }}"></label></dd>
+			<dd><label><input id="webpush_vapid_public" type="text" name="config[wpn_webpush_vapid_public]" size="25" maxlength="255" value="{{ WEBPUSH_VAPID_PUBLIC }}"></label></dd>
 		</dl>
 		<dl>
 			<dt><label for="webpush_vapid_private">{{ lang('WEBPUSH_VAPID_PRIVATE') ~ lang('COLON') }}</label><br><span>{{ lang('WEBPUSH_VAPID_PRIVATE_EXPLAIN') }}</span></dt>
-			<dd><label><input id="webpush_vapid_private" type="password" name="config[webpush_vapid_private]" size="25" maxlength="255" autocomplete="off" value="{{ WEBPUSH_VAPID_PRIVATE }}"></label></dd>
+			<dd><label><input id="webpush_vapid_private" type="password" name="config[wpn_webpush_vapid_private]" size="25" maxlength="255" autocomplete="off" value="{{ WEBPUSH_VAPID_PRIVATE }}"></label></dd>
 		</dl>
 	</fieldset>
 	<fieldset class="submit-buttons">

config/services.yml

@@ -38,7 +38,6 @@ services:
     phpbb.wpn.ucp.controller.webpush:
         class: phpbb\webpushnotifications\ucp\controller\webpush
         arguments:
-            - '@config'
             - '@controller.helper'
             - '@dbal.conn'
             - '@phpbb.wpn.form_helper'

migrations/add_webpush.php

@@ -67,9 +67,9 @@ public function revert_schema(): array
 	public function update_data(): array
 	{
 		return [
-			['config.add', ['webpush_enable', false]],
-			['config.add', ['webpush_vapid_public', '']],
-			['config.add', ['webpush_vapid_private', '']],
+			['config.add', ['wpn_webpush_enable', false]],
+			['config.add', ['wpn_webpush_vapid_public', '']],
+			['config.add', ['wpn_webpush_vapid_private', '']],
 			['module.add', ['acp', 'ACP_CLIENT_COMMUNICATION', [
 				'module_basename'	=> '\phpbb\webpushnotifications\acp\wpn_acp_module',
 				'module_langname'	=> 'ACP_WEBPUSH_SETTINGS',

notification/method/webpush.php

@@ -86,8 +86,8 @@ public function get_type(): string
 	*/
 	public function is_available(type_interface $notification_type = null): bool
 	{
-		return parent::is_available($notification_type) && $this->config['webpush_enable']
-			&& !empty($this->config['webpush_vapid_public']) && !empty($this->config['webpush_vapid_private']);
+		return parent::is_available($notification_type) && $this->config['wpn_webpush_enable']
+			&& !empty($this->config['wpn_webpush_vapid_public']) && !empty($this->config['wpn_webpush_vapid_private']);
 	}
 
 	/**
@@ -181,8 +181,8 @@ protected function notify_using_webpush(): void
 		$auth = [
 			'VAPID' => [
 				'subject' => generate_board_url(false),
-				'publicKey' => $this->config['webpush_vapid_public'],
-				'privateKey' => $this->config['webpush_vapid_private'],
+				'publicKey' => $this->config['wpn_webpush_vapid_public'],
+				'privateKey' => $this->config['wpn_webpush_vapid_private'],
 			],
 		];
 
@@ -341,7 +341,7 @@ public function get_ucp_template_data(helper $controller_helper, form_helper $fo
 			'NOTIFICATIONS_WEBPUSH_ENABLE'	=> true,
 			'U_WEBPUSH_SUBSCRIBE'			=> $controller_helper->route('phpbb_webpushnotifications_ucp_push_subscribe_controller'),
 			'U_WEBPUSH_UNSUBSCRIBE'			=> $controller_helper->route('phpbb_webpushnotifications_ucp_push_unsubscribe_controller'),
-			'VAPID_PUBLIC_KEY'				=> $this->config['webpush_vapid_public'],
+			'VAPID_PUBLIC_KEY'				=> $this->config['wpn_webpush_vapid_public'],
 			'U_WEBPUSH_WORKER_URL'			=> $controller_helper->route('phpbb_webpushnotifications_ucp_push_worker_controller'),
 			'SUBSCRIPTIONS'					=> $subscriptions,
 			'WEBPUSH_FORM_TOKENS'			=> $form_helper->get_form_tokens(\phpbb\webpushnotifications\ucp\controller\webpush::FORM_TOKEN_UCP),

tests/functional/functional_test.php

@@ -45,9 +45,9 @@ public function test_acp_module()
 		$this->assertContainsLang('WEBPUSH_GENERATE_VAPID_KEYS', $crawler->filter('input[type="button"]')->attr('value'));
 
 		$form_data = [
-			'config[webpush_enable]'	=> 1,
-			'config[webpush_vapid_public]'	=> 'BDnYSJHVZBxq834LqDGr893IfazEez7q-jYH2QBNlT0ji2C9UwGosiqz8Dp_ZN23lqAngBZyRjXVWF4ZLA8X2zI',
-			'config[webpush_vapid_private]'	=> 'IE5OYlmfWsMbBU1lzvr0bxrxVAXIteSkAnwGlZIhmRk',
+			'config[wpn_webpush_enable]'	=> 1,
+			'config[wpn_webpush_vapid_public]'	=> 'BDnYSJHVZBxq834LqDGr893IfazEez7q-jYH2QBNlT0ji2C9UwGosiqz8Dp_ZN23lqAngBZyRjXVWF4ZLA8X2zI',
+			'config[wpn_webpush_vapid_private]'	=> 'IE5OYlmfWsMbBU1lzvr0bxrxVAXIteSkAnwGlZIhmRk',
 		];
 		$form = $crawler->selectButton('submit')->form($form_data);
 		$crawler = self::submit($form);
@@ -72,5 +72,4 @@ public function test_ucp_module()
 		$this->assertContainsLang('NOTIFY_WEBPUSH_ENABLE', $crawler->filter('label[for="subscribe_webpush"]')->text());
 		$this->assertContainsLang('PHPBB_WPN_NOTIFICATION_METHOD_WEBPUSH', $crawler->filter('th.mark')->eq(2)->text());
 	}
-
 }

tests/notification/notification_method_webpush_test.php

@@ -101,8 +101,8 @@ protected function setUp(): void
 			'allow_topic_notify'	=> true,
 			'allow_forum_notify'	=> true,
 			'allow_board_notifications'	=> true,
-			'webpush_vapid_public'	=> self::VAPID_KEYS['publicKey'],
-			'webpush_vapid_private'	=> self::VAPID_KEYS['privateKey'],
+			'wpn_webpush_vapid_public'	=> self::VAPID_KEYS['publicKey'],
+			'wpn_webpush_vapid_private'	=> self::VAPID_KEYS['privateKey'],
 		]);
 		$lang_loader = new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx);
 		$lang = new \phpbb\language\language($lang_loader);
@@ -144,16 +144,6 @@ protected function setUp(): void
 		$phpbb_container->setParameter('tables.notification_emails', 'phpbb_notification_emails');
 		$phpbb_container->setParameter('tables.phpbb.wpn.notification_push', 'phpbb_wpn_notification_push');
 		$phpbb_container->setParameter('tables.phpbb.wpn.push_subscriptions', 'phpbb_wpn_push_subscriptions');
-//		$phpbb_container->set(
-//			'text_formatter.s9e.mention_helper',
-//			new \phpbb\textformatter\s9e\mention_helper(
-//				$this->db,
-//				$auth,
-//				$this->user,
-//				$phpbb_root_path,
-//				$phpEx
-//			)
-//		);
 
 		$this->notification_method_webpush = new webpush(
 			$phpbb_container->get('config'),
@@ -185,8 +175,6 @@ protected function setUp(): void
 
 		$phpbb_container->set('notification_manager', $this->notifications);
 
-//		$phpbb_container->addCompilerPass(new \phpbb\di\pass\markpublic_pass());
-
 		$phpbb_container->compile();
 
 		$this->notifications->setDependencies($this->auth, $this->config);

ucp/controller/webpush.php

@@ -10,7 +10,6 @@
 
 namespace phpbb\webpushnotifications\ucp\controller;
 
-use phpbb\config\config;
 use phpbb\controller\helper as controller_helper;
 use phpbb\db\driver\driver_interface;
 use phpbb\exception\http_exception;
@@ -32,9 +31,6 @@ class webpush
 	/** @var string UCP form token name */
 	public const FORM_TOKEN_UCP = 'ucp_webpush';
 
-	/** @var config */
-	protected $config;
-
 	/** @var controller_helper */
 	protected $controller_helper;
 
@@ -65,7 +61,6 @@ class webpush
 	/**
 	 * Constructor for webpush controller
 	 *
-	 * @param config $config
 	 * @param controller_helper $controller_helper
 	 * @param driver_interface $db
 	 * @param form_helper $form_helper
@@ -76,10 +71,9 @@ class webpush
 	 * @param string $notification_webpush_table
 	 * @param string $push_subscriptions_table
 	 */
-	public function __construct(config $config, controller_helper $controller_helper, driver_interface $db, form_helper $form_helper, path_helper $path_helper,
+	public function __construct(controller_helper $controller_helper, driver_interface $db, form_helper $form_helper, path_helper $path_helper,
 								request_interface $request, user $user, Environment $template, string $notification_webpush_table, string $push_subscriptions_table)
 	{
-		$this->config = $config;
 		$this->controller_helper = $controller_helper;
 		$this->db = $db;
 		$this->form_helper = $form_helper;