diff --git a/app/App/HomeController.php b/app/App/HomeController.php index 24b7c3ed8..8188ad010 100644 --- a/app/App/HomeController.php +++ b/app/App/HomeController.php @@ -140,4 +140,12 @@ class HomeController extends Controller $exists = $favicons->restoreOriginalIfNotExists(); return response()->file($exists ? $favicons->getPath() : $favicons->getOriginalPath()); } + + /** + * Serve a PWA application manifest. + */ + public function pwaManifest(PwaManifestBuilder $manifestBuilder) + { + return response()->json($manifestBuilder->build()); + } } diff --git a/app/App/PwaManifestBuilder.php b/app/App/PwaManifestBuilder.php new file mode 100644 index 000000000..4902d354d --- /dev/null +++ b/app/App/PwaManifestBuilder.php @@ -0,0 +1,59 @@ +getForCurrentUser('dark-mode-enabled'); + $appName = setting('app-name'); + + return [ + "name" => $appName, + "short_name" => $appName, + "start_url" => "./", + "scope" => "/", + "display" => "standalone", + "background_color" => $darkMode ? '#111111' : '#F2F2F2', + "description" => $appName, + "theme_color" => ($darkMode ? setting('app-color-dark') : setting('app-color')), + "launch_handler" => [ + "client_mode" => "focus-existing" + ], + "orientation" => "portrait", + "icons" => [ + [ + "src" => setting('app-icon-32') ?: url('/icon-32.png'), + "sizes" => "32x32", + "type" => "image/png" + ], + [ + "src" => setting('app-icon-64') ?: url('/icon-64.png'), + "sizes" => "64x64", + "type" => "image/png" + ], + [ + "src" => setting('app-icon-128') ?: url('/icon-128.png'), + "sizes" => "128x128", + "type" => "image/png" + ], + [ + "src" => setting('app-icon-180') ?: url('/icon-180.png'), + "sizes" => "180x180", + "type" => "image/png" + ], + [ + "src" => setting('app-icon') ?: url('/icon.png'), + "sizes" => "256x256", + "type" => "image/png" + ], + [ + "src" => url('favicon.ico'), + "sizes" => "48x48", + "type" => "image/vnd.microsoft.icon" + ], + ], + ]; + } +} diff --git a/resources/views/layouts/base.blade.php b/resources/views/layouts/base.blade.php index f9dbc68b4..67b074905 100644 --- a/resources/views/layouts/base.blade.php +++ b/resources/views/layouts/base.blade.php @@ -10,7 +10,7 @@ - + @@ -29,6 +29,10 @@ + + + + @yield('head') diff --git a/routes/web.php b/routes/web.php index 9f5e84c62..06dffa636 100644 --- a/routes/web.php +++ b/routes/web.php @@ -20,6 +20,7 @@ use Illuminate\View\Middleware\ShareErrorsFromSession; Route::get('/status', [SettingControllers\StatusController::class, 'show']); Route::get('/robots.txt', [HomeController::class, 'robots']); Route::get('/favicon.ico', [HomeController::class, 'favicon']); +Route::get('/manifest.json', [HomeController::class, 'pwaManifest']); // Authenticated routes... Route::middleware('auth')->group(function () { diff --git a/tests/PwaManifestTest.php b/tests/PwaManifestTest.php new file mode 100644 index 000000000..b8317321d --- /dev/null +++ b/tests/PwaManifestTest.php @@ -0,0 +1,72 @@ +setSettings(['app-color' => '#00ACED']); + + $resp = $this->get('/manifest.json'); + $resp->assertOk(); + + $resp->assertJson([ + 'name' => setting('app-name'), + 'launch_handler' => [ + 'client_mode' => 'focus-existing' + ], + 'theme_color' => '#00ACED', + ]); + } + + public function test_pwa_meta_tags_in_head() + { + $html = $this->asViewer()->withHtml($this->get('/')); + + // crossorigin attribute is required to send cookies with the manifest, + // so it can react correctly to user preferences (dark/light mode). + $html->assertElementExists('head link[rel="manifest"][href$="manifest.json"][crossorigin="use-credentials"]'); + $html->assertElementExists('head meta[name="mobile-web-app-capable"][content="yes"]'); + } + + public function test_manifest_uses_configured_icons_if_existing() + { + $resp = $this->get('/manifest.json'); + $resp->assertJson([ + 'icons' => [[ + "src" => 'http://localhost/icon-32.png', + "sizes" => "32x32", + "type" => "image/png" + ]] + ]); + + $galleryFile = $this->files->uploadedImage('my-app-icon.png'); + $this->asAdmin()->call('POST', '/settings/customization', [], [], ['app_icon' => $galleryFile], []); + + $customIconUrl = setting()->get('app-icon-32'); + $this->assertStringContainsString('my-app-icon', $customIconUrl); + + $resp = $this->get('/manifest.json'); + $resp->assertJson([ + 'icons' => [[ + "src" => $customIconUrl, + "sizes" => "32x32", + "type" => "image/png" + ]] + ]); + } + + public function test_manifest_changes_to_user_preferences() + { + $lightUser = $this->users->viewer(); + $darkUser = $this->users->editor(); + setting()->putUser($darkUser, 'dark-mode-enabled', 'true'); + + $resp = $this->actingAs($lightUser)->get('/manifest.json'); + $resp->assertJson(['background_color' => '#F2F2F2']); + + $resp = $this->actingAs($darkUser)->get('/manifest.json'); + $resp->assertJson(['background_color' => '#111111']); + } +}