gnu-social/src/Core/I18n/I18n.php

<?php

declare(strict_types = 1);

// {{{ License

// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social.  If not, see <http://www.gnu.org/licenses/>.

// }}}

/**
 * Utility functions for i18n
 *
 * @category  I18n
 * @package   GNU social
 *
 * @author    Matthew Gregg <matthew.gregg@gmail.com>
 * @author    Ciaran Gultnieks <ciaran@ciarang.com>
 * @author    Evan Prodromou <evan@status.net>
 * @author    Diogo Cordeiro <diogo@fc.up.pt>
 * @author    Hugo Sales <hugo@hsal.es>
 * @copyright 2010, 2018-2021 Free Software Foundation, Inc http://www.fsf.org
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */

namespace App\Core\I18n;

use App\Util\Common;
use App\Util\Exception\ServerException;
use App\Util\Formatting;
use InvalidArgumentException;
use Symfony\Contracts\Translation\TranslatorInterface;

// Locale category constants are usually predefined, but may not be
// on some systems such as Win32.
$LC_CATEGORIES = [
    'LC_CTYPE',
    'LC_NUMERIC',
    'LC_TIME',
    'LC_COLLATE',
    'LC_MONETARY',
    'LC_MESSAGES',
    'LC_ALL',
];
foreach ($LC_CATEGORIES as $key => $name) {
    if (!\defined($name)) {
        \define($name, $key);
    }
}

abstract class I18n
{
    public static ?TranslatorInterface $translator = null;

    public static function setTranslator($trans): void
    {
        self::$translator = $trans;
    }

    /**
     * Looks for which plugin we've been called from to get the gettext domain;
     * if not in a plugin subdirectory, we'll use the default 'core+intl-icu'.
     *
     * @throws ServerException
     */
    public static function _mdomain(string $path): string
    {
        /*
          0 =>
          array
          'file' => string '/var/www/mublog/plugins/FeedSub/FeedSubPlugin.php' (length=49)
          'line' => int 77
          'function' => string '_m' (length=2)
          'args' =>
          array
          0 => &string 'Feeds' (length=5)
        */
        static $cached;
        if (!isset($cached[$path])) {
            $path          = Formatting::normalizePath($path);
            $cached[$path] = Formatting::moduleFromPath($path);
        }
        return $cached[$path] ?? 'core+intl-icu';
    }

    /**
     * Content negotiation for language codes. Gets our highest rated translation language that the client accepts
     *
     * @param string $http_accept_lang_header HTTP Accept-Language header
     *
     * @return string language code for best language match, false otherwise
     */
    public static function clientPreferredLanguage(string $http_accept_lang_header): string|bool
    {
        $client_langs  = [];
        $all_languages = self::getAllLanguages();

        preg_match_all(
            '"(((\S\S)-?(\S\S)?)(;q=([0-9.]+))?)\s*(,\s*|$)"',
            mb_strtolower($http_accept_lang_header),
            $http_langs,
        );

        for ($i = 0; $i < \count($http_langs); ++$i) {
            if (!empty($http_langs[2][$i])) {
                // if no q default to 1.0
                $client_langs[$http_langs[2][$i]] = ($http_langs[6][$i] ? (float) $http_langs[6][$i] : 1.0 - ($i * 0.01));
            }
            if (!empty($http_langs[3][$i]) && empty($client_langs[$http_langs[3][$i]])) {
                // if a catchall default 0.01 lower
                $client_langs[$http_langs[3][$i]] = ($http_langs[6][$i] ? (float) $http_langs[6][$i] - 0.01 : 0.99);
            }
        }
        // sort in descending q
        arsort($client_langs);

        foreach ($client_langs as $lang => $q) {
            if (isset($all_languages[$lang])) {
                return $all_languages[$lang]['lang'];
            }
        }
        return false;
    }

    /**
     * returns a simple code -> name mapping for languages
     *
     * @return array map of available languages by code to language name
     */
    public static function getNiceLanguageList(): array
    {
        $nice_lang     = [];
        $all_languages = self::getAllLanguages();

        foreach ($all_languages as $lang) {
            $nice_lang[$lang['lang']] = $lang['name'];
        }
        return $nice_lang;
    }

    /**
     * Check whether a language is right-to-left
     *
     * @param string $lang_value language code of the language to check
     *
     * @return bool true if language is rtl
     */
    public static function isRTL(string $lang_value): bool
    {
        foreach (self::getAllLanguages() as $code => $info) {
            if ($lang_value == $info['lang']) {
                return $info['direction'] == 'rtl';
            }
        }
        throw new InvalidArgumentException('is_rtl function received an invalid lang to test. Lang was: ' . $lang_value);
    }

    /**
     * Get a list of all languages that are enabled in the default config
     *
     * @return array mapping of language codes to language info
     */
    public static function getAllLanguages(): array
    {
        return [
            'af'        => ['q' => 0.8, 'lang' => 'af', 'name' => 'Afrikaans', 'direction' => 'ltr'],
            'ar'        => ['q' => 0.8, 'lang' => 'ar', 'name' => 'Arabic', 'direction' => 'rtl'],
            'ast'       => ['q' => 1, 'lang' => 'ast', 'name' => 'Asturian', 'direction' => 'ltr'],
            'eu'        => ['q' => 1, 'lang' => 'eu', 'name' => 'Basque', 'direction' => 'ltr'],
            'be-tarask' => ['q' => 0.5, 'lang' => 'be-tarask', 'name' => 'Belarusian (Taraškievica orthography)', 'direction' => 'ltr'],
            'br'        => ['q' => 0.8, 'lang' => 'br', 'name' => 'Breton', 'direction' => 'ltr'],
            'bg'        => ['q' => 0.8, 'lang' => 'bg', 'name' => 'Bulgarian', 'direction' => 'ltr'],
            'my'        => ['q' => 1, 'lang' => 'my', 'name' => 'Burmese', 'direction' => 'ltr'],
            'ca'        => ['q' => 0.5, 'lang' => 'ca', 'name' => 'Catalan', 'direction' => 'ltr'],
            'zh-cn'     => ['q' => 0.9, 'lang' => 'zh_CN', 'name' => 'Chinese (Simplified)', 'direction' => 'ltr'],
            'zh-hant'   => ['q' => 0.2, 'lang' => 'zh_TW', 'name' => 'Chinese (Taiwanese)', 'direction' => 'ltr'],
            'ksh'       => ['q' => 1, 'lang' => 'ksh', 'name' => 'Colognian', 'direction' => 'ltr'],
            'cs'        => ['q' => 0.5, 'lang' => 'cs', 'name' => 'Czech', 'direction' => 'ltr'],
            'da'        => ['q' => 0.8, 'lang' => 'da', 'name' => 'Danish', 'direction' => 'ltr'],
            'nl'        => ['q' => 0.5, 'lang' => 'nl', 'name' => 'Dutch', 'direction' => 'ltr'],
            'arz'       => ['q' => 0.8, 'lang' => 'arz', 'name' => 'Egyptian Spoken Arabic', 'direction' => 'rtl'],
            'en'        => ['q' => 1, 'lang' => 'en', 'name' => 'English', 'direction' => 'ltr'],
            'en-us'     => ['q' => 1, 'lang' => 'en', 'name' => 'English (US)', 'direction' => 'ltr'],
            'en-gb'     => ['q' => 1, 'lang' => 'en_GB', 'name' => 'English (UK)', 'direction' => 'ltr'],
            'eo'        => ['q' => 0.8, 'lang' => 'eo', 'name' => 'Esperanto', 'direction' => 'ltr'],
            'fi'        => ['q' => 1, 'lang' => 'fi', 'name' => 'Finnish', 'direction' => 'ltr'],
            'fr'        => ['q' => 1, 'lang' => 'fr', 'name' => 'French', 'direction' => 'ltr'],
            'fr-fr'     => ['q' => 1, 'lang' => 'fr', 'name' => 'French (France)', 'direction' => 'ltr'],
            'fur'       => ['q' => 0.8, 'lang' => 'fur', 'name' => 'Friulian', 'direction' => 'ltr'],
            'gl'        => ['q' => 0.8, 'lang' => 'gl', 'name' => 'Galician', 'direction' => 'ltr'],
            'ka'        => ['q' => 0.8, 'lang' => 'ka', 'name' => 'Georgian', 'direction' => 'ltr'],
            'de'        => ['q' => 0.8, 'lang' => 'de', 'name' => 'German', 'direction' => 'ltr'],
            'el'        => ['q' => 0.1, 'lang' => 'el', 'name' => 'Greek', 'direction' => 'ltr'],
            'he'        => ['q' => 0.5, 'lang' => 'he', 'name' => 'Hebrew', 'direction' => 'rtl'],
            'hu'        => ['q' => 0.8, 'lang' => 'hu', 'name' => 'Hungarian', 'direction' => 'ltr'],
            'is'        => ['q' => 0.1, 'lang' => 'is', 'name' => 'Icelandic', 'direction' => 'ltr'],
            'id'        => ['q' => 1, 'lang' => 'id', 'name' => 'Indonesian', 'direction' => 'ltr'],
            'ia'        => ['q' => 0.8, 'lang' => 'ia', 'name' => 'Interlingua', 'direction' => 'ltr'],
            'ga'        => ['q' => 0.5, 'lang' => 'ga', 'name' => 'Irish', 'direction' => 'ltr'],
            'it'        => ['q' => 1, 'lang' => 'it', 'name' => 'Italian', 'direction' => 'ltr'],
            'ja'        => ['q' => 0.5, 'lang' => 'ja', 'name' => 'Japanese', 'direction' => 'ltr'],
            'ko'        => ['q' => 0.9, 'lang' => 'ko', 'name' => 'Korean', 'direction' => 'ltr'],
            'lv'        => ['q' => 1, 'lang' => 'lv', 'name' => 'Latvian', 'direction' => 'ltr'],
            'lt'        => ['q' => 1, 'lang' => 'lt', 'name' => 'Lithuanian', 'direction' => 'ltr'],
            'lb'        => ['q' => 1, 'lang' => 'lb', 'name' => 'Luxembourgish', 'direction' => 'ltr'],
            'mk'        => ['q' => 0.5, 'lang' => 'mk', 'name' => 'Macedonian', 'direction' => 'ltr'],
            'mg'        => ['q' => 1, 'lang' => 'mg', 'name' => 'Malagasy', 'direction' => 'ltr'],
            'ms'        => ['q' => 1, 'lang' => 'ms', 'name' => 'Malay', 'direction' => 'ltr'],
            'ml'        => ['q' => 0.5, 'lang' => 'ml', 'name' => 'Malayalam', 'direction' => 'ltr'],
            'ne'        => ['q' => 1, 'lang' => 'ne', 'name' => 'Nepali', 'direction' => 'ltr'],
            'nb'        => ['q' => 0.1, 'lang' => 'nb', 'name' => 'Norwegian (Bokmål)', 'direction' => 'ltr'],
            'no'        => ['q' => 0.1, 'lang' => 'nb', 'name' => 'Norwegian (Bokmål)', 'direction' => 'ltr'],
            'nn'        => ['q' => 1, 'lang' => 'nn', 'name' => 'Norwegian (Nynorsk)', 'direction' => 'ltr'],
            'fa'        => ['q' => 1, 'lang' => 'fa', 'name' => 'Persian', 'direction' => 'rtl'],
            'pl'        => ['q' => 0.5, 'lang' => 'pl', 'name' => 'Polish', 'direction' => 'ltr'],
            'pt'        => ['q' => 1, 'lang' => 'pt', 'name' => 'Portuguese', 'direction' => 'ltr'],
            'pt-br'     => ['q' => 0.9, 'lang' => 'pt_BR', 'name' => 'Brazilian Portuguese', 'direction' => 'ltr'],
            'ru'        => ['q' => 0.9, 'lang' => 'ru', 'name' => 'Russian', 'direction' => 'ltr'],
            'sr-ec'     => ['q' => 1, 'lang' => 'sr-ec', 'name' => 'Serbian', 'direction' => 'ltr'],
            'es'        => ['q' => 1, 'lang' => 'es', 'name' => 'Spanish', 'direction' => 'ltr'],
            'sv'        => ['q' => 0.8, 'lang' => 'sv', 'name' => 'Swedish', 'direction' => 'ltr'],
            'tl'        => ['q' => 0.8, 'lang' => 'tl', 'name' => 'Tagalog', 'direction' => 'ltr'],
            'ta'        => ['q' => 1, 'lang' => 'ta', 'name' => 'Tamil', 'direction' => 'ltr'],
            'te'        => ['q' => 0.3, 'lang' => 'te', 'name' => 'Telugu', 'direction' => 'ltr'],
            'tr'        => ['q' => 0.5, 'lang' => 'tr', 'name' => 'Turkish', 'direction' => 'ltr'],
            'uk'        => ['q' => 1, 'lang' => 'uk', 'name' => 'Ukrainian', 'direction' => 'ltr'],
            'hsb'       => ['q' => 0.8, 'lang' => 'hsb', 'name' => 'Upper Sorbian', 'direction' => 'ltr'],
            'ur'        => ['q' => 1, 'lang' => 'ur_PK', 'name' => 'Urdu (Pakistan)', 'direction' => 'rtl'],
            'vi'        => ['q' => 0.8, 'lang' => 'vi', 'name' => 'Vietnamese', 'direction' => 'ltr'],
        ];
    }

    /**
     * Format the given associative array $messages in the ICU
     * translation format, with the given $params. Allows for a
     * declarative use of the translation engine, for example
     * `formatICU(['she' => ['She has one foo', 'She has many foo'],
     *             'he'  => ['He has one foo', 'He has many foo']], ['she' => 1])`
     *
     * @see http://userguide.icu-project.org/formatparse/messages
     */
    public static function formatICU(array $messages, array $params): string
    {
        $res = '';
        foreach (\array_slice($params, 0, 1, true) as $var => $type) {
            if (\is_int($type)) {
                $pref = '=';
                $op   = 'plural';
            } elseif (\is_string($type)) {
                $pref = '';
                $op   = 'select';
            } else {
                throw new InvalidArgumentException('Invalid variable type. (int|string) only');
            }

            $res = "{$var}, {$op}, ";
            $i   = 0;
            $cnt = \count($messages) - 1;
            foreach ($messages as $val => $m) {
                if ($i !== $cnt) {
                    $res .= "{$pref}{$val}";
                } else {
                    $res .= 'other';
                }

                if (\is_array($m)) {
                    $res .= ' {' . self::formatICU($m, \array_slice($params, 1, null, true)) . '} ';
                } elseif (\is_string($m)) {
                    $res .= " {{$m}} ";
                } else {
                    throw new InvalidArgumentException('Invalid message array');
                }
                ++$i;
            }
        }
        return "{{$res}}";
    }
}

/**
 * Wrapper for symfony translation with smart domain detection.
 *
 * If calling from a plugin, this function checks which plugin it was
 * being called from and uses that as text domain, which will have
 * been set up during plugin initialization.
 *
 * Also handles plurals and contexts depending on what parameters
 * are passed to it:
 *
 *    _m(string $msg)                                      -- simple message
 *    _m(string $ctx, string $msg)                         -- message with context
 *    _m(string|string[] $msg, array $params)              -- message
 *    _m(string $ctx, string|string[] $msg, array $params) -- combination of the previous two
 *
 * @throws ServerException
 *
 * @todo add parameters
 */
function _m(...$args): string
{
    // Get the file where this function was called from, reducing the
    // memory and performance impact by not returning the arguments,
    // and only 2 frames (this and previous)
    $domain = I18n::_mdomain(debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 2)[0]['file']);
    switch (\count($args)) {
    case 1:
        // Empty parameters, simple message
        return I18n::$translator->trans($args[0], [], $domain, Common::currentLanguage()->getLocale());
    case 3:
        // @codeCoverageIgnoreStart
        if (\is_int($args[2])) {
            throw new InvalidArgumentException('Calling `_m()` with a number for pluralization is deprecated, '
                                                . 'use an explicit parameter', );
        }
        // @codeCoverageIgnoreEnd
        // Falthrough
        // no break
        case 2:
            if (\is_array($args[0])) {
                $args[0] = I18n::formatICU($args[0], $args[1]);
            }

            if (\is_string($args[0])) {
                $msg    = $args[0];
                $params = $args[1] ?? [];
                return I18n::$translator->trans($msg, $params, $domain, Common::currentLanguage()->getLocale());
            }
        // Fallthrough
        // no break
    default:
        // @codeCoverageIgnoreStart
        throw new InvalidArgumentException("Bad parameters to `_m()` for domain {$domain}");
        // @codeCoverageIgnoreEnd
    }
}