Language.php

<?php
 
/*
 *
 *  ____            _        _   __  __ _                  __  __ ____
 * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
 * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
 * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
 * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * @author PocketMine Team
 * @link http://www.pocketmine.net/
 *
 *
 */
 
declare(strict_types=1);
 
namespace pocketmine\lang;
 
use pocketmine\utils\Utils;
use Symfony\Component\Filesystem\Path;
use function array_filter;
use function array_map;
use function count;
use function explode;
use function file_exists;
use function is_dir;
use function max;
use function ord;
use function parse_ini_file;
use function scandir;
use function str_contains;
use function str_ends_with;
use function str_replace;
use function str_starts_with;
use function strlen;
use function strpos;
use function strtolower;
use function substr;
use const INI_SCANNER_RAW;
use const SCANDIR_SORT_NONE;
 
class Language{
 
    public const FALLBACK_LANGUAGE = "eng";
 
    public static function getLanguageList(string $path = "") : array{
        if($path === ""){
            $path = \pocketmine\LOCALE_DATA_PATH;
        }
 
        if(is_dir($path)){
            $allFiles = scandir($path, SCANDIR_SORT_NONE);
 
            if($allFiles !== false){
                $files = array_filter($allFiles, function(string $filename) : bool{
                    return str_ends_with($filename, ".ini");
                });
 
                $result = [];
 
                foreach($files as $file){
                    try{
                        $code = explode(".", $file, limit: 2)[0];
                        $strings = self::loadLang($path, $code);
                        if(isset($strings[KnownTranslationKeys::LANGUAGE_NAME])){
                            $result[$code] = $strings[KnownTranslationKeys::LANGUAGE_NAME];
                        }
                    }catch(LanguageNotFoundException $e){
                        // no-op
                    }
                }
 
                return $result;
            }
        }
 
        throw new LanguageNotFoundException("Language directory $path does not exist or is not a directory");
    }
 
    protected string $langName;
    protected array $lang = [];
    protected array $fallbackLang = [];
 
    public function __construct(string $lang, ?string $path = null, string $fallback = self::FALLBACK_LANGUAGE){
        $this->langName = strtolower($lang);
 
        if($path === null){
            $path = \pocketmine\LOCALE_DATA_PATH;
        }
 
        $this->lang = self::loadLang($path, $this->langName);
        $this->fallbackLang = self::loadLang($path, $fallback);
    }
 
    public function getName() : string{
        return $this->get(KnownTranslationKeys::LANGUAGE_NAME);
    }
 
    public function getLang() : string{
        return $this->langName;
    }
 
    protected static function loadLang(string $path, string $languageCode) : array{
        $file = Path::join($path, $languageCode . ".ini");
        if(file_exists($file)){
            $strings = array_map('stripcslashes', Utils::assumeNotFalse(parse_ini_file($file, false, INI_SCANNER_RAW), "Missing or inaccessible required resource files"));
            if(count($strings) > 0){
                return $strings;
            }
        }
 
        throw new LanguageNotFoundException("Language \"$languageCode\" not found");
    }
 
    private function getUsedParameterCount(string $rawString, int $given) : int{
        $highestIndex = -1;
        for($i = 0; $i < $given; $i++){
            if(str_contains($rawString, "{%$i}")){
                $highestIndex = $i;
            }
        }
        return $highestIndex + 1;
    }
 
    public function translateString(string $str, array $params = [], ?string $onlyPrefix = null, int &$untranslatedParameterCount = 0) : string{
        $baseText = $this->internalGet($str);
        $parameterCount = count($params);
        if($baseText !== null){
            if($onlyPrefix !== null && !str_starts_with($str, $onlyPrefix)){ //client side translation
                $untranslatedParameterCount = $this->getUsedParameterCount($baseText, $parameterCount);
                return $str;
            }
        }else{ //key not found or embedded inside format string
            $baseText = $this->parseTranslation($str, $onlyPrefix, $parameterCount);
            $untranslatedParameterCount = $parameterCount;
        }
 
        foreach(Utils::promoteKeys($params) as $i => $p){
            $replacement = $p instanceof Translatable ? $this->translate($p) : (string) $p;
            $baseText = str_replace("{%$i}", $replacement, $baseText);
        }
 
        return $baseText;
    }
 
    public function translate(Translatable $c) : string{
        $baseText = $this->internalGet($c->getText());
        if($baseText === null){ //key not found or embedded inside format string
            $baseText = $this->parseTranslation($c->getText());
        }
 
        foreach(Utils::promoteKeys($c->getParameters()) as $i => $p){
            $replacement = $p instanceof Translatable ? $this->translate($p) : $p;
            $baseText = str_replace("{%$i}", $replacement, $baseText);
        }
 
        return $baseText;
    }
 
    protected function internalGet(string $id) : ?string{
        return $this->lang[$id] ?? $this->fallbackLang[$id] ?? null;
    }
 
    public function get(string $id) : string{
        return $this->internalGet($id) ?? $id;
    }
 
    public function getAll() : array{
        return $this->lang;
    }
 
    private function replaceTranslationKey(string $replaceString, ?string $onlyPrefix, int &$untranslatedParameterCount, int $givenParameterCount) : string{
        if(($t = $this->internalGet(substr($replaceString, 1))) !== null){
            if($onlyPrefix !== null && strpos($replaceString, $onlyPrefix) !== 1){ //client side translation
                $newString = $replaceString;
                $untranslatedParameterCount = max($untranslatedParameterCount, $this->getUsedParameterCount($t, $givenParameterCount));
            }else{
                $newString = $t;
            }
        }else{
            $newString = $replaceString;
            $untranslatedParameterCount = $givenParameterCount;
        }
        return $newString;
    }
 
    protected function parseTranslation(string $text, ?string $onlyPrefix = null, int &$parameterCount = 0) : string{
        $givenParameterCount = $parameterCount;
        $untranslatedParameterCount = 0;
        $newString = "";
 
        $replaceString = null;
 
        $len = strlen($text);
        for($i = 0; $i < $len; ++$i){
            $c = $text[$i];
            if($replaceString !== null){
                $ord = ord($c);
                if(
                    ($ord >= 0x30 && $ord <= 0x39) // 0-9
                    || ($ord >= 0x41 && $ord <= 0x5a) // A-Z
                    || ($ord >= 0x61 && $ord <= 0x7a) || // a-z
                    $c === "." || $c === "-"
                ){
                    $replaceString .= $c;
                }else{
                    $newString .= $this->replaceTranslationKey($replaceString, $onlyPrefix, $untranslatedParameterCount, $givenParameterCount);
                    $replaceString = null;
 
                    if($c === "%"){
                        $replaceString = $c;
                    }else{
                        $newString .= $c;
                    }
                }
            }elseif($c === "%"){
                $replaceString = $c;
            }else{
                $newString .= $c;
            }
        }
 
        if($replaceString !== null){
            $newString .= $this->replaceTranslationKey($replaceString, $onlyPrefix, $untranslatedParameterCount, $givenParameterCount);
        }
 
        $parameterCount = $untranslatedParameterCount;
        return $newString;
    }
}