phpmyadmin / motranslator

src/Loader.php

<?php

declare(strict_types=1);

/*
    Copyright (c) 2005 Steven Armstrong <sa at c-area dot ch>
    Copyright (c) 2009 Danilo Segan <danilo@kvota.net>
    Copyright (c) 2016 Michal Čihař <michal@cihar.com>

    This file is part of MoTranslator.

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

namespace PhpMyAdmin\MoTranslator;

use PhpMyAdmin\MoTranslator\Cache\CacheFactoryInterface;
use PhpMyAdmin\MoTranslator\Cache\InMemoryCache;

use function file_exists;
use function getenv;
use function in_array;
use function preg_match;
use function sprintf;

class Loader
{
    /**
     * Loader instance.
     *
     * @static
     */
    private static Loader|null $instance = null;

    /**
     * Factory to return a factory responsible for returning a `CacheInterface`
     *
     * @static
     */
    private static CacheFactoryInterface|null $cacheFactory = null;

    /**
     * Default gettext domain to use.
     */
    private string $defaultDomain = '';

    /**
     * Configured locale.
     */
    private string $locale = '';

    /**
     * Loaded domains.
     *
     * @var array<string,array<string,Translator>>
     */
    private array $domains = [];

    /**
     * Bound paths for domains.
     *
     * @var array<string,string>
     */
    private array $paths = ['' => './'];

    /**
     * Returns the singleton Loader object.
     *
     * @return Loader object
     */
    public static function getInstance(): Loader
    {
        if (self::$instance === null) {
            self::$instance = new self();
        }

        return self::$instance;

The expression return self::instance could return the type null which is incompatible with the type-hinted return PhpMyAdmin\MoTranslator\Loader. Consider adding an additional type-check to rule them out.

    }

    /**
     * Loads global localization functions.
     */
    public static function loadFunctions(): void
    {
        require_once __DIR__ . '/functions.php';
    }

    /**
     * Figure out all possible locale names and start with the most
     * specific ones.  I.e. for sr_CS.UTF-8@latin, look through all of
     * sr_CS.UTF-8@latin, sr_CS@latin, sr@latin, sr_CS.UTF-8, sr_CS, sr.
     *
     * @param string $locale Locale code
     *
     * @return string[] list of locales to try for any POSIX-style locale specification
     * @psalm-return list<string>
     */
    public static function listLocales(string $locale): array
    {
        $localeNames = [];

        if ($locale !== '') {
            if (
                preg_match(
                    '/^(?P<lang>[a-z]{2,3})' // language code
                    . '(?:_(?P<country>[A-Z]{2}))?' // country code
                    . '(?:\\.(?P<charset>[-A-Za-z0-9_]+))?' // charset
                    . '(?:@(?P<modifier>[-A-Za-z0-9_]+))?$/', // @ modifier
                    $locale,
                    $matches,
                ) === 1
            ) {
                $lang = $matches['lang'] ?? '';
                $country = $matches['country'] ?? '';
                $charset = $matches['charset'] ?? '';
                $modifier = $matches['modifier'] ?? '';

                if ($modifier !== '') {
                    if ($country !== '') {
                        if ($charset !== '') {
                            $localeNames[] = sprintf('%s_%s.%s@%s', $lang, $country, $charset, $modifier);
                        }

                        $localeNames[] = sprintf('%s_%s@%s', $lang, $country, $modifier);
                    } elseif ($charset !== '') {
                        $localeNames[] = sprintf('%s.%s@%s', $lang, $charset, $modifier);
                    }

                    $localeNames[] = sprintf('%s@%s', $lang, $modifier);
                }

                if ($country !== '') {
                    if ($charset !== '') {
                        $localeNames[] = sprintf('%s_%s.%s', $lang, $country, $charset);
                    }

                    $localeNames[] = sprintf('%s_%s', $lang, $country);
                } elseif ($charset !== '') {
                    $localeNames[] = sprintf('%s.%s', $lang, $charset);
                }

                if ($lang !== '') {
                    $localeNames[] = $lang;
                }
            }

            // If the locale name doesn't match POSIX style, just include it as-is.
            if (! in_array($locale, $localeNames, true)) {
                $localeNames[] = $locale;
            }
        }

        return $localeNames;
    }

    /**
     * Sets factory responsible for composing a `CacheInterface`
     */
    public static function setCacheFactory(CacheFactoryInterface|null $cacheFactory): void
    {
        self::$cacheFactory = $cacheFactory;
    }

    /**
     * Returns Translator object for domain or for default domain.
     *
     * @param string $domain Translation domain
     */
    public function getTranslator(string $domain = ''): Translator
    {
        if ($domain === '') {
            $domain = $this->defaultDomain;
        }

        $this->domains[$this->locale] ??= [];

        if (! isset($this->domains[$this->locale][$domain])) {
            $base = $this->paths[$domain] ?? './';

            $localeNames = self::listLocales($this->locale);

            $filename = '';
            foreach ($localeNames as $locale) {
                $filename = $base . '/' . $locale . '/LC_MESSAGES/' . $domain . '.mo';
                if (file_exists($filename)) {
                    break;
                }
            }

            // We don't care about invalid path, we will get fallback
            // translator here
            $moParser = new MoParser($filename);
            if (self::$cacheFactory instanceof CacheFactoryInterface) {
                $cache = self::$cacheFactory->getInstance($moParser, $this->locale, $domain);
            } else {
                $cache = new InMemoryCache($moParser);
            }

            $this->domains[$this->locale][$domain] = new Translator($cache);
        }

        return $this->domains[$this->locale][$domain];
    }

    /**
     * Sets the path for a domain.
     *
     * @param string $domain Domain name
     * @param string $path   Path where to find locales
     */
    public function bindtextdomain(string $domain, string $path): void
    {
        $this->paths[$domain] = $path;
    }

    /**
     * Sets the default domain.
     *
     * @param string $domain Domain name
     */
    public function textdomain(string $domain): void
    {
        $this->defaultDomain = $domain;
    }

    /**
     * Sets a requested locale.
     *
     * @param string $locale Locale name
     *
     * @return string Set or current locale
     */
    public function setlocale(string $locale): string
    {
        if (! empty($locale)) {
            $this->locale = $locale;
        }

        return $this->locale;
    }

    /**
     * Detects currently configured locale.
     *
     * It checks:
     *
     * - global lang variable
     * - environment for LC_ALL, LC_MESSAGES and LANG
     *
     * @return string with locale name
     */
    public function detectlocale(): string
    {
        if (isset($GLOBALS['lang'])) {
            return $GLOBALS['lang'];
        }

        $locale = getenv('LC_ALL');
        if ($locale !== false) {
            return $locale;
        }

        $locale = getenv('LC_MESSAGES');
        if ($locale !== false) {
            return $locale;
        }

        $locale = getenv('LANG');
        if ($locale !== false) {
            return $locale;
        }

        return 'en';
    }
}