Merge pull request #75 from iMattPro/re-do-multilang

Re-do Multi Lang Support
phpbb-extensions · Oct 3, 2024 · 1799091 · 1799091
2 parents 8960d27 + 127009f
commit 1799091
Show file tree

Hide file tree

Showing 5 changed files with 140 additions and 127 deletions.
diff --git a/config/services.yml b/config/services.yml
@@ -30,7 +30,6 @@ services:
         arguments:
             - '@config'
             - '@dbal.conn'
-            - '@language'
             - '@log'
             - '@user_loader'
             - '@user'
@@ -49,8 +48,11 @@ services:
             - '@controller.helper'
             - '@dbal.conn'
             - '@phpbb.wpn.form_helper'
+            - '@language'
+            - '@notification_manager'
             - '@path_helper'
             - '@request'
+            - '@user_loader'
             - '@user'
             - '@template.twig.environment'
             - '%tables.phpbb.wpn.notification_push%'

diff --git a/notification/method/webpush.php b/notification/method/webpush.php
@@ -14,7 +14,6 @@
 use phpbb\config\config;
 use phpbb\controller\helper;
 use phpbb\db\driver\driver_interface;
-use phpbb\language\language;
 use phpbb\log\log_interface;
 use phpbb\notification\method\messenger_base;
 use phpbb\notification\type\type_interface;
@@ -36,9 +35,6 @@ class webpush extends messenger_base implements extended_method_interface
 	/** @var driver_interface */
 	protected $db;
 
-	/** @var language */
-	protected $language;
-
 	/** @var log_interface */
 	protected $log;
 
@@ -65,7 +61,6 @@ class webpush extends messenger_base implements extended_method_interface
 	 *
 	 * @param config $config
 	 * @param driver_interface $db
-	 * @param language $language
 	 * @param log_interface $log
 	 * @param user_loader $user_loader
 	 * @param user $user
@@ -75,14 +70,13 @@ class webpush extends messenger_base implements extended_method_interface
 	 * @param string $notification_webpush_table
 	 * @param string $push_subscriptions_table
 	 */
-	public function __construct(config $config, driver_interface $db, language $language, log_interface $log, user_loader $user_loader, user $user, path_helper $path_helper,
+	public function __construct(config $config, driver_interface $db, log_interface $log, user_loader $user_loader, user $user, path_helper $path_helper,
 								string $phpbb_root_path, string $php_ext, string $notification_webpush_table, string $push_subscriptions_table)
 	{
 		parent::__construct($user_loader, $phpbb_root_path, $php_ext);
 
 		$this->config = $config;
 		$this->db = $db;
-		$this->language = $language;
 		$this->log = $log;
 		$this->user = $user;
 		$this->path_helper = $path_helper;
@@ -145,29 +139,15 @@ public function notify()
 	{
 		$insert_buffer = new \phpbb\db\sql_insert_buffer($this->db, $this->notification_webpush_table);
 
-		// Load all users data we want to notify
-		$notify_users = $this->load_recipients_data();
-
 		/** @var type_interface $notification */
 		foreach ($this->queue as $notification)
 		{
 			$data = $notification->get_insert_array();
-
-			// Change notification language if needed only
-			$recipient_data = $this->user_loader->get_user($notification->user_id);
-			if ($this->language->get_used_language() !== $recipient_data['user_lang'])
-			{
-				$this->language->set_user_language($recipient_data['user_lang'], true);
-			}
-
 			$data += [
-				'push_data'		=> json_encode([
-					'heading'	=> $this->config['sitename'],
-					'title'		=> strip_tags($notification->get_title()),
-					'text'		=> strip_tags($notification->get_reference()),
-					'url'		=> htmlspecialchars_decode($notification->get_url()),
-					'avatar'	=> $this->prepare_avatar($notification->get_avatar()),
-				]),
+				'push_data'				=> json_encode(array_merge(
+					$data,
+					['notification_type_name' => $notification->get_type()]
+				)),
 				'notification_time'		=> time(),
 				'push_token'			=> hash('sha256', random_bytes(32))
 			];
@@ -178,30 +158,41 @@ public function notify()
 
 		$insert_buffer->flush();
 
-		// Restore current user's language if needed only
-		if ($this->language->get_used_language() !== $this->user->data['user_lang'])
-		{
-			$this->language->set_user_language($this->user->data['user_lang'], true);
-		}
-
-		$this->notify_using_webpush($notify_users);
+		$this->notify_using_webpush();
 
 		return false;
 	}
 
 	/**
 	 * Notify using Web Push
 	 *
-	 * @param array	$notify_users	Array of user ids to notify
 	 * @return void
 	 */
-	protected function notify_using_webpush($notify_users = []): void
+	protected function notify_using_webpush(): void
 	{
 		if (empty($this->queue))
 		{
 			return;
 		}
 
+		// Load all users we want to notify
+		$user_ids = [];
+		foreach ($this->queue as $notification)
+		{
+			$user_ids[] = $notification->user_id;
+		}
+
+		// Do not send push notifications to banned users
+		if (!function_exists('phpbb_get_banned_user_ids'))
+		{
+			include($this->phpbb_root_path . 'includes/functions_user.' . $this->php_ext);
+		}
+		$banned_users = phpbb_get_banned_user_ids($user_ids);
+
+		// Load all the users we need
+		$notify_users = array_diff($user_ids, $banned_users);
+		$this->user_loader->load_users($notify_users, [USER_IGNORE]);
+
 		// Get subscriptions for users
 		$user_subscription_map = $this->get_user_subscription_map($notify_users);
 
@@ -361,6 +352,14 @@ public static function clean_data(array $data): array
 		return array_intersect_key($data, $row);
 	}
 
+	/**
+	 * Get template data for the UCP
+	 *
+	 * @param helper $controller_helper
+	 * @param form_helper $form_helper
+	 *
+	 * @return array
+	 */
 	public function get_ucp_template_data(helper $controller_helper, form_helper $form_helper): array
 	{
 		$subscription_map = $this->get_user_subscription_map([$this->user->id()]);
@@ -461,46 +460,6 @@ protected function clean_expired_subscriptions(array $user_subscription_map, arr
 		$this->remove_subscriptions($remove_subscriptions);
 	}
 
-	/**
-	 * Takes an avatar string (usually in full html format already) and extracts the url.
-	 * If the avatar url is a relative path, it's converted to an absolute path.
-	 *
-	 * Converts:
-	 *    <img class="avatar" src="./path/to/avatar=123456789.gif" width="123" height="123" alt="User avatar" />
-	 * or <img class="avatar" src="./styles/prosilver/theme/images/no_avatar.gif" data-src="./path/to/avatar=123456789.gif" width="123" height="123" alt="User avatar" />
-	 * into https://myboard.url/path/to/avatar=123456789.gif
-	 *
-	 * @param string $avatar
-	 * @return array 'src' => Absolute path to avatar image
-	 */
-	protected function prepare_avatar($avatar): array
-	{
-		$pattern = '/src=["\']?([^"\'>]+)["\']?/';
-
-		preg_match_all($pattern, $avatar, $matches);
-
-		$path = !empty($matches[1]) ? end($matches[1]) : $avatar;
-
-		return ['src' => preg_replace('#^' . preg_quote($this->path_helper->get_web_root_path(), '#') . '#', $this->get_board_url(), $path, 1)];
-	}
-
-	/**
-	 * Returns the board url (and caches it in the function)
-	 *
-	 * @return string the generated board url
-	 */
-	protected function get_board_url()
-	{
-		static $board_url;
-
-		if (empty($board_url))
-		{
-			$board_url = generate_board_url() . '/';
-		}
-
-		return $board_url;
-	}
-
 	/**
 	 * Set web push padding for endpoint
 	 *
@@ -523,31 +482,4 @@ protected function set_endpoint_padding(\Minishlink\WebPush\WebPush $web_push, s
 			}
 		}
 	}
-
-	/**
-	 * Load all users data to send notifications
-	 *
-	 * @return array	Array of user ids to notify
-	 */
-	protected function load_recipients_data(): array
-	{
-		$notify_users = $user_ids = [];
-		foreach ($this->queue as $notification)
-		{
-			$user_ids[] = $notification->user_id;
-		}
-
-		// Do not send push notifications to banned users
-		if (!function_exists('phpbb_get_banned_user_ids'))
-		{
-			include($this->phpbb_root_path . 'includes/functions_user.' . $this->php_ext);
-		}
-		$banned_users = phpbb_get_banned_user_ids($user_ids);
-
-		// Load all the users we need
-		$notify_users = array_diff($user_ids, $banned_users);
-		$this->user_loader->load_users($notify_users, [USER_IGNORE]);
-
-		return $notify_users;
-	}
 }
diff --git a/tests/event/listener_test.php b/tests/event/listener_test.php
@@ -108,7 +108,6 @@ protected function setUp(): void
 		$this->notification_method_webpush = new \phpbb\webpushnotifications\notification\method\webpush(
 			$this->config,
 			$db,
-			$this->language,
 			new \phpbb\log\dummy(),
 			$user_loader,
 			$this->user,

diff --git a/tests/notification/notification_method_webpush_test.php b/tests/notification/notification_method_webpush_test.php
@@ -171,7 +171,6 @@ protected function setUp(): void
 		$this->notification_method_webpush = new webpush(
 			$phpbb_container->get('config'),
 			$phpbb_container->get('dbal.conn'),
-			$phpbb_container->get('language'),
 			$phpbb_container->get('log'),
 			$phpbb_container->get('user_loader'),
 			$phpbb_container->get('user'),