HealthSciencesThemePlugin.inc.php

<?php

/**
 * @file plugins/themes/healthSciences/HealthSciencesThemePlugin.inc.php
 *
 * Copyright (c) 2014-2025 Simon Fraser University
 * Copyright (c) 2003-2025 John Willinsky
 * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
 *
 * @class HealthSciencesThemePlugin
 * @ingroup plugins_themes_healthSciences
 *
 * @brief Health Sciences theme
 */

use APP\core\Application;
use PKP\config\Config;
use PKP\facades\Locale;
use PKP\plugins\ThemePlugin;

class HealthSciencesThemePlugin extends ThemePlugin
{
    /**
     * Load the custom styles for our theme
     * @return null
     */
    public function init()
    {

        // Add theme options
        $this->addOption('baseColour', 'colour', [
            'label' => 'plugins.themes.healthSciences.option.colour.label',
            'description' => 'plugins.themes.healthSciences.option.colour.description',
            'default' => '#10BECA',
        ]);

        // Add usage stats display options
        $this->addOption('displayStats', 'FieldOptions', [
            'type' => 'radio',
            'label' => __('plugins.themes.healthSciences.option.displayStats.label'),
            'options' => [
                [
                    'value' => 'none',
                    'label' => __('plugins.themes.healthSciences.option.displayStats.none'),
                ],
                [
                    'value' => 'bar',
                    'label' => __('plugins.themes.healthSciences.option.displayStats.bar'),
                ],
                [
                    'value' => 'line',
                    'label' => __('plugins.themes.healthSciences.option.displayStats.line'),
                ],
            ],
            'default' => 'none',
        ]);

        // Update colour based on theme option
        $additionalLessVariables = [];
        if ($this->getOption('baseColour') !== '#10BECA') {
            $additionalLessVariables[] = '@primary:' . $this->getOption('baseColour') . ';';
            $additionalLessVariables[] = '
				@primary-light: desaturate(lighten(@primary, 41%), 15%);
				@primary-text: darken(@primary, 15%);
				@primary-link: darken(@primary, 50%);
			';
        }

        // Update contrast colour based on primary colour
        $checkMarkColour = '000';
        if ($this->isColourDark($this->getOption('baseColour'))) {
            $checkMarkColour = 'FFF';
            $additionalLessVariables[] = '
				@contrast: rgba(255, 255, 255, 0.85);
				@primary-text: lighten(@primary, 15%);
				@primary-link: lighten(@primary, 50%);
				@btn-border-colour: @primary;
			';
        }

        /**
         * Change the check mark image colour for better contrast,
         * the URL is from bootstrap5/scss/_variables.scss => $form-check-input-checked-bg-image
         */
        $checkImageUrl = 'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20"> ' .
            '<path fill="none" stroke="#' . $checkMarkColour . '" stroke-linecap="round" stroke-linejoin="round" ' .
            'stroke-width="3" d="M6 10l3 3l6-6"/></svg>';

        $additionalLessVariables[] = '
			@check-image-url: url(\'' . str_replace(['<', '>', '#'], ['%3c', '%3e', '%23'], $checkImageUrl) . '\');
		';

        $this->addScript('app-js', 'libs/app.min.js');

        // Load theme stylesheet and script
        $this->addStyle('app-css', 'libs/app.min.css');
        $this->addStyle('stylesheet', 'styles/index.less');
        $this->modifyStyle('stylesheet', ['addLessVariables' => join("\n", $additionalLessVariables)]);

        // Styles for HTML galleys
        $this->addStyle('htmlFont', 'styles/htmlGalley.less', ['contexts' => 'htmlGalley']);
        $this->addStyle('htmlGalley', 'templates/plugins/generic/htmlArticleGalley/css/default.css', ['contexts' => 'htmlGalley']);

        // Styles for right to left scripts
        $locale = Locale::getLocale();
        if (Locale::getMetadata($locale)->isRightToLeft()) {
            $this->addStyle('rtl', 'styles/rtl.less');
        }

        // Add navigation menu areas for this theme
        $this->addMenuArea(['primary', 'user']);

        // Get extra data for templates
        HookRegistry::add('TemplateManager::display', [$this, 'loadTemplateData']);
    }

    /**
     * Get the display name of this theme
     */
    public function getDisplayName(): string
    {
        return __('plugins.themes.healthSciences.name');
    }

    /**
     * Get the description of this plugin
     */
    public function getDescription(): string
    {
        return __('plugins.themes.healthSciences.description');
    }

    /**
     * Load custom data for templates
     *
     * @param string $hookName
     * @param array $args [
     *      @option TemplateManager
     *      @option string Template file requested
     *      @option string
     *      @option string
     *      @option string output HTML
     * ]
     */
    public function loadTemplateData($hookName, $args)
    {
        $templateMgr = $args[0];
        $request = Application::get()->getRequest();
        $context = $request->getContext();

        if (!defined('SESSION_DISABLE_INIT')) {
            // Get possible locales
            if ($context) {
                $locales = $context->getSupportedLocaleNames();
            } else {
                $locales = $request->getSite()->getSupportedLocaleNames();
            }

            // Load login form
            $loginUrl = $request->url(null, 'login', 'signIn');
            if (Config::getVar('security', 'force_login_ssl')) {
                $loginUrl = preg_replace('/^http:/u', 'https:', $loginUrl);
            }

            $templateMgr->assign([
                'languageToggleLocales' => $locales,
                'loginUrl' => $loginUrl,
                'brandImage' => 'templates/images/ojs_brand_white.png',
            ]);
        }
    }
}