Merge pull request #35 from iMattPro/avatars

Fix avatars in Notifications

Author: iMattPro

config/services.yml

@@ -28,6 +28,7 @@ services:
             - '@log'
             - '@user_loader'
             - '@user'
+            - '@path_helper'
             - '%core.root_path%'
             - '%core.php_ext%'
             - '%tables.phpbb.wpn.notification_push%'

notification/method/webpush.php

@@ -17,6 +17,7 @@
 use phpbb\log\log_interface;
 use phpbb\notification\method\messenger_base;
 use phpbb\notification\type\type_interface;
+use phpbb\path_helper;
 use phpbb\user;
 use phpbb\user_loader;
 use phpbb\webpushnotifications\form\form_helper;
@@ -41,6 +42,9 @@ class webpush extends messenger_base implements extended_method_interface
 	/** @var user */
 	protected $user;
 
+	/** @var path_helper */
+	protected $path_helper;
+
 	/** @var string Notification Web Push table */
 	protected $notification_webpush_table;
 
@@ -55,20 +59,22 @@ class webpush extends messenger_base implements extended_method_interface
 	 * @param log_interface $log
 	 * @param user_loader $user_loader
 	 * @param user $user
+	 * @param path_helper $path_helper
 	 * @param string $phpbb_root_path
 	 * @param string $php_ext
 	 * @param string $notification_webpush_table
 	 * @param string $push_subscriptions_table
 	 */
-	public function __construct(config $config, driver_interface $db, log_interface $log, user_loader $user_loader, user $user, string $phpbb_root_path,
-								string $php_ext, string $notification_webpush_table, string $push_subscriptions_table)
+	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->log = $log;
 		$this->user = $user;
+		$this->path_helper = $path_helper;
 		$this->notification_webpush_table = $notification_webpush_table;
 		$this->push_subscriptions_table = $push_subscriptions_table;
 	}
@@ -130,7 +136,7 @@ public function notify()
 					'title'		=> strip_tags($notification->get_title()),
 					'text'		=> strip_tags($notification->get_reference()),
 					'url'		=> htmlspecialchars_decode($notification->get_url()),
-					'avatar'	=> $notification->get_avatar(),
+					'avatar'	=> $this->prepare_avatar($notification->get_avatar()),
 				]),
 				'notification_time'		=> time(),
 			];
@@ -428,4 +434,44 @@ 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 string Absolute path to avatar image
+	 */
+	protected function prepare_avatar($avatar)
+	{
+		$pattern = '/src=["\']?([^"\'>]+)["\']?/';
+
+		preg_match_all($pattern, $avatar, $matches);
+
+		$path = !empty($matches[1]) ? end($matches[1]) : $avatar;
+
+		return 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;
+	}
 }

styles/all/template/push_worker.js.twig

@@ -36,7 +36,7 @@ self.addEventListener('push', event => {
 			const options = {
 				body: responseBody,
 				data: response,
-				icon: response.avatar.src,
+				icon: response.avatar,
 			};
 			self.registration.showNotification(response.heading, options);
 		});

tests/event/listener_test.php

@@ -76,12 +76,18 @@ protected function setUp(): void
 			$this->user
 		);
 
+		$path_helper = $this->getMockBuilder('\phpbb\path_helper')
+			->disableOriginalConstructor()
+			->setMethods(array())
+			->getMock();
+
 		$this->notification_method_webpush = new \phpbb\webpushnotifications\notification\method\webpush(
 			$this->config,
 			$db,
 			new \phpbb\log\dummy(),
 			$user_loader,
 			$this->user,
+			$path_helper,
 			$phpbb_root_path,
 			$phpEx,
 			'phpbb_wpn_notification_push',

tests/notification/notification_method_webpush_test.php

@@ -128,6 +128,19 @@ protected function setUp(): void
 			$phpEx
 		);
 
+		$request = new \phpbb_mock_request;
+		$symfony_request = new \phpbb\symfony_request(
+			$request
+		);
+		$filesystem = new \phpbb\filesystem\filesystem();
+		$phpbb_path_helper = new \phpbb\path_helper(
+			$symfony_request,
+			$filesystem,
+			$request,
+			$phpbb_root_path,
+			$phpEx
+		);
+
 		$log_table = 'phpbb_log';
 		$this->log = new \phpbb\log\log($this->db, $user, $auth, $this->phpbb_dispatcher, $phpbb_root_path, 'adm/', $phpEx, $log_table);
 
@@ -145,6 +158,7 @@ protected function setUp(): void
 		$phpbb_container->set('log', $this->log);
 		$phpbb_container->set('text_formatter.utils', new \phpbb\textformatter\s9e\utils());
 		$phpbb_container->set('dispatcher', $this->phpbb_dispatcher);
+		$phpbb_container->set('path_helper', $phpbb_path_helper);
 		$phpbb_container->setParameter('core.root_path', $phpbb_root_path);
 		$phpbb_container->setParameter('core.php_ext', $phpEx);
 		$phpbb_container->setParameter('tables.notifications', 'phpbb_notifications');
@@ -160,6 +174,7 @@ protected function setUp(): void
 			$phpbb_container->get('log'),
 			$phpbb_container->get('user_loader'),
 			$phpbb_container->get('user'),
+			$phpbb_container->get('path_helper'),
 			$phpbb_root_path,
 			$phpEx,
 			$phpbb_container->getParameter('tables.phpbb.wpn.notification_push'),