Progressive Web App compatibility

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

Author: iMattPro

config/routing.yml

@@ -1,3 +1,7 @@
 phpbb_webpushnotifications_ucp_routing:
     resource: wpn_ucp.yml
     prefix: /user
+
+phpbb_webpushnotifications_manifest_controller:
+    path: /manifest
+    defaults: { _controller: phpbb.wpn.controller.manifest:handle }

config/services.yml

@@ -52,3 +52,10 @@ services:
             - '%tables.phpbb.wpn.notification_push%'
             - '%tables.phpbb.wpn.push_subscriptions%'
 
+    phpbb.wpn.controller.manifest:
+        class: phpbb\webpushnotifications\controller\manifest
+        arguments:
+            - '@config'
+            - '@language'
+            - '@path_helper'
+            - '@user'

controller/manifest.php

@@ -0,0 +1,94 @@
+<?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\controller;
+
+use phpbb\config\config;
+use phpbb\exception\http_exception;
+use phpbb\language\language;
+use phpbb\path_helper;
+use phpbb\user;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+
+class manifest
+{
+	/** @var config */
+	protected $config;
+
+	/** @var language */
+	protected $language;
+
+	/** @var path_helper */
+	protected $path_helper;
+
+	/** @var user */
+	protected $user;
+
+	/**
+	 * Constructor for webpush controller
+	 *
+	 * @param config $config
+	 * @param path_helper $path_helper
+	 * @param language $language
+	 * @param user $user
+	 */
+	public function __construct(config $config, language $language, path_helper $path_helper, user $user)
+	{
+		$this->config = $config;
+		$this->path_helper = $path_helper;
+		$this->language = $language;
+		$this->user = $user;
+	}
+
+	/**
+	 * Handle creation of a manifest json file for progressive web-app support
+	 *
+	 * @return JsonResponse
+	 */
+	public function handle(): JsonResponse
+	{
+		if ($this->user->data['is_bot'] || $this->user->data['user_type'] == USER_INACTIVE)
+		{
+			throw new http_exception(Response::HTTP_FORBIDDEN, 'Forbidden');
+		}
+
+		$root_path = $this->path_helper->get_web_root_path();
+
+		$manifest = [
+			'name'			=> $this->config['sitename'],
+			'short_name'	=> substr($this->config['sitename'], 0, 12), // TODO need an ACP option for short name
+			'display'		=> 'standalone',
+			'orientation'	=> 'portrait',
+			'dir'			=> $this->language->lang('DIRECTION'),
+			'start_url'		=> $root_path,
+			'scope'			=> $root_path
+		];
+
+		// TODO add support for icons
+		if (isset($this->config['wpn_app_icon_small'], $this->config['wpn_app_icon_large']))
+		{
+			$manifest['icons'] = [
+				[
+					'src' => $root_path . 'images/icons/' . $this->config['wpn_app_icon_small'],
+					'sizes' => '192x192',
+					'type' => 'image/png'
+				],
+				[
+					'src' => $root_path . 'images/icons/' . $this->config['wpn_app_icon_large'],
+					'sizes' => '512x512',
+					'type' => 'image/png'
+				]
+			];
+		}
+
+		return new JsonResponse($manifest);
+	}
+}

notification/method/webpush.php

@@ -386,6 +386,7 @@ public function get_ucp_template_data(helper $controller_helper, form_helper $fo
 			'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),
+			'U_MANIFEST_URL'				=> $controller_helper->route('phpbb_webpushnotifications_manifest_controller'),
 		];
 	}
 

styles/all/template/ucp_notifications_webpush.html

@@ -1,3 +1,8 @@
+<meta name="apple-mobile-web-app-capable" content="yes">
+<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
+<meta name="apple-mobile-web-app-title" content="{{ SITENAME }}">
+<link rel="manifest" href="{{ U_MANIFEST_URL }}">
+
 <script>
 	phpbbWebpushOptions = {
 		serviceWorkerUrl: '{{ U_WEBPUSH_WORKER_URL }}',

tests/event/listener_test.php

@@ -218,6 +218,7 @@ public function test_get_ucp_template_data($user_id, $method_data, $subscription
 				'U_WEBPUSH_WORKER_URL'			=> $this->controller_helper->route('phpbb_webpushnotifications_ucp_push_worker_controller'),
 				'SUBSCRIPTIONS'					=> $subscriptions,
 				'WEBPUSH_FORM_TOKENS'			=> $this->form_helper->get_form_tokens(\phpbb\webpushnotifications\ucp\controller\webpush::FORM_TOKEN_UCP),
+				'U_MANIFEST_URL'				=> $this->controller_helper->route('phpbb_webpushnotifications_manifest_controller'),
 			]
 		);