LeKoala\SsPwa\ManifestController

Complexity

Total Complexity

12

Size/Duplication

Total Lines	172
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	get_template_global_variables()	0	4	1
A	listIcons()	0	19	3
A	index()	0	71	4
A	getServiceWorkerCachedPaths()	0	6	1
A	getIconsPath()	0	16	3

<?php

namespace LeKoala\SsPwa;

use SilverStripe\Control\Director;
use SilverStripe\Control\Controller;
use SilverStripe\SiteConfig\SiteConfig;

The type SilverStripe\SiteConfig\SiteConfig was not found. Maybe you did not declare it correctly or list all dependencies?

use SilverStripe\View\TemplateGlobalProvider;

/**
 * @link https://developer.mozilla.org/en-US/docs/Web/Manifest
 * @link https://web.dev/learn/pwa/web-app-manifest/
 */
class ManifestController extends Controller implements TemplateGlobalProvider, ServiceWorkerCacheProvider
{
    /**
     * @config
     * @var string
     */
    private static $gcm_sender_id = null;

The private property $gcm_sender_id is not used, and could be removed.

    /**
     * @link https://developer.mozilla.org/en-US/docs/Web/Manifest/background_color
     * @config
     * @var string
     */
    private static $background_color = '#ffffff';

The private property $background_color is not used, and could be removed.

    /**
     * @link https://developer.mozilla.org/en-US/docs/Web/Manifest/orientation
     * @config
     * @var string
     */
    private static $orientation = 'portrait-primary';

The private property $orientation is not used, and could be removed.

    /**
     * @config
     * @var string
     */
    private static $custom_icon_path = '';

    /**
     * @var array<string>
     */
    private static $allowed_actions = [

The private property $allowed_actions is not used, and could be removed.

        'index',
    ];

    /**
     * @return mixed
     */
    public function index()
    {
        $config = $this->config();
        $sc = SiteConfig::current_site_config();

        $title = $sc->Title;
        //@phpstan-ignore-next-line
        $desc = $sc->Tagline;
        $desc = $desc ?: $title;

        $icons = self::listIcons();

        $theme_color = $background_color = $config->get('background_color');
        //@phpstan-ignore-next-line
        if ($sc->ThemeColor) {
            $theme_color = $sc->ThemeColor;
        }

        $manifestContent = [
            // Full name of your PWA. It will appear along with the icon in the operating system's home screen, launcher, dock, or menu
            'name' => $title,
            // Optional, a shorter name of your PWA, used when there is not enough room to display the full value of the name field. Keep it under 12 characters to minimize the possibility of truncation.
            'short_name' => $title,
            // Array of icon objects with src, type, sizes, and optional purpose fields, describing what images should represent the PWA.
            'icons' => $icons,
            // The URL the PWA should load when the user starts it from the installed icon.
            // An absolute path is recommended, so if your PWA's home page is the root of your site,
            // you could set this to ‘/' to open it when your app starts.
            // If you don't provide a start URL, the browser can use the URL the PWA was installed from as a start.
            // It can be a deep link, such as the details of a product instead of your home screen.
            'start_url' => Director::baseURL(),
            // One of fullscreen, standalone, minimal-ui, or browser, describing how the OS should draw the PWA window.
            // You can read more about the different display modes in the App Design chapter.
            // Most use cases implement standalone.
            'display' => 'standalone',
            // A string that uniquely identifies this PWA against others that may be hosted on the same origin. If it's not set, the start_url will be used as a fallback value.
            // Keep in mind that by changing the start_url in the future (such as when changing a query string value) you may be removing the browser's ability to detect that a PWA is already installed.
            // @link https://developer.chrome.com/blog/pwa-manifest-id/
            'id' => Director::baseURL(),
            // The description member is a string in which developers can explain what the application does.
            // description is directionality-capable, which means it can be displayed left to right or right to left based on the values of the dir and lang manifest members.
            'description' => $desc,
            'lang' => 'en',
            'dir' => 'ltr',
            // The scope member is a string that defines the navigation scope of this web application's application context.
            // It restricts what web pages can be viewed while the manifest is applied.
            // If the user navigates outside the scope, it reverts to a normal web page inside a browser tab or window.
            'scope' => Director::baseURL(),
            // https://developer.chrome.com/docs/extensions/mv3/declare_permissions/
            'permissions' => [
                // https://developer.chrome.com/docs/extensions/reference/gcm/
                'gcm',
            ],
            // The background_color member defines a placeholder background color for the application page to display before its stylesheet is loaded.
            // This value is used by the user agent to draw the background color of a shortcut when the manifest is available before the stylesheet has loaded.
            'background_color' => $background_color,
            // The theme_color member is a string that defines the default theme color for the application.
            // This sometimes affects how the OS displays the site (e.g., on Android's task switcher, the theme color surrounds the site).
            'theme_color' => $theme_color,
            // The orientation member defines the default orientation for all the website's top-level browsing contexts.
            'orientation' => $config->get('orientation'),
        ];

        $gcm_sender_id = $config->get('gcm_sender_id');
        if ($gcm_sender_id) {
            $manifestContent['gcm_sender_id'] = $gcm_sender_id;
            $manifestContent['gcm_user_visible_only'] = true;
        }

        $this->getResponse()->addHeader('Content-Type', 'application/manifest+json; charset="utf-8"');
        return json_encode($manifestContent);
    }

    /**
     * @return array<array{'src':string,'sizes':string,'type':string,'purpose':string}>
     */
    public static function listIcons(): array
    {
        $iconsPath = self::getIconsPath();
        $sizes = [192, 512];
        $purposes = ['any', 'maskable'];
        $version = ServiceWorkerController::config()->get('version');

        $icons = [];
        foreach ($sizes as $size) {
            foreach ($purposes as $purpose) {
                $icons[] = [
                    'src' => self::join_links($iconsPath, 'manifest-icon-' . $size . '.maskable.png?' . $version),
                    'sizes' => $size . 'x' . $size,
                    'type' => 'image/png',
                    'purpose' => $purpose,
                ];
            }
        }
        return $icons;
    }

    public static function getIconsPath(): string
    {
        // can be dynamically configured through site config
        $sc = SiteConfig::current_site_config();
        if ($sc->hasMethod("PwaIconsPath")) {
            //@phpstan-ignore-next-line
            return $sc->PwaIconsPath();
        }
        // can use custom override
        if (self::config()->custom_icon_path) {
            return self::config()->custom_icon_path;
        }
        // defaults to _resources/app/images/icons
        $baseURL = '/';
        $iconsPath = self::join_links($baseURL, RESOURCES_DIR, 'app', 'images', 'icons');
        return $iconsPath;
    }

    /**
     * @return array<string,string>
     */
    public static function get_template_global_variables()
    {
        return [
            'PwaIconsPath' => 'getIconsPath',
        ];
    }

    /**
     * @return array<string>
     */
    public static function getServiceWorkerCachedPaths(): array
    {
        $icons = self::listIcons();
        return array_map(function ($v) {
            return $v['src'];
        }, $icons);
    }
}