mytinytodo/src/includes/class.lang.php

<?php

/*
    This file is a part of myTinyTodo.
    (C) Copyright 2020-2022 Max Pozdeev <maxpozdeev@gmail.com>
    Licensed under the GNU GPL version 2 or any later. See file COPYRIGHT for details.
*/

/*
    myTinyTodo language class
*/

class Lang
{
    protected static $instance;
    protected static $langDir = MTTINC . 'lang/';
    protected $code = 'en';
    protected $default = 'en';
    protected $strings;

    public static function instance(): Lang
    {
        if (!isset(self::$instance)) {
            $c = __CLASS__;
            self::$instance = new $c;
        }
        return self::$instance;
    }

    public static function loadLangOrDie($code, $die = 1)
    {
        $lang = self::instance();

        //check if json file exists
        if ( self::langExists($code) ) {
            $jsonString = file_get_contents( self::$langDir. "{$code}.json" );
            $lang->loadJsonString($code, $jsonString);
        }
        else if ( $die == 0 ) {
            //notice?
            $lang->code = $lang->default; //sure?
            $lang->loadDefaultStrings();
        }
        else if ( $die == 1 ) {
            die("Language file not found (". htmlspecialchars($code). ".json)");
        }
    }

    public static function loadLang($code)
    {
        self::loadLangOrDie($code, 0);
    }

    public static function langExists($code)
    {
        return file_exists(self::$langDir. $code. '.json');
    }

    function loadJsonString($code, $jsonString)
    {
        $this->code = $code;
        $json = json_decode($jsonString, true);
        if ($json === null) {
            error_log("Failed to decode translation JSON, language '$code': ". json_last_error_msg());
            $json = array();
        }

        //load default language
        if ( $code != $this->default ) {
            $this->loadDefaultStrings();
            $this->strings = array_replace($this->strings, $json);
        }
        else {
            $this->strings = $json;
        }
    }

    function loadDefaultStrings()
    {
        if ( ! self::langExists($this->default) ) {
            die("Default language file not found (". htmlspecialchars($this->default). ".json)");
        }
        $defStr = file_get_contents($this->langDir(). "{$this->default}.json");
        $this->strings = json_decode($defStr, true);
        if ($this->strings === null) {
            die("Invalid JSON in default language file (". htmlspecialchars($this->default). ".json): ". json_last_error_msg());
        }
    }

    function get($key)
    {
        if ( isset($this->strings[$key]) ) {
            return $this->strings[$key];
        }
        return $key;
    }

    function hasKey(string $key): bool
    {
        return isset($this->strings[$key]);
    }

    function rtl()
    {
        if ( isset($this->strings['_header']['rtl']) ) {
            return intval($this->strings['_header']['rtl']);
        }
        return 0;
    }

    /* minimal number of translated strings to use in js front-end */
    function jsStrings(bool $escape = true)
    {
        $a = array();
        $a['daysMin'] = $this->get('days_min');
        $a['daysLong'] = $this->get('days_long');
        $a['monthsShort'] = $this->get('months_short');
        $a['monthsLong'] = $this->get('months_calendar');

        $this->fillWithValues($a, [
            'confirmDelete',
            'confirmLeave',
            'actionNoteSave',
            'actionNoteCancel',
            'error',
            'denied',
            'listNotFound',
            'noPublicLists',
            'noTags',
            'invalidpass',
            'addList',
            'addListDefault',
            'renameList',
            'deleteList',
            'clearCompleted',
            'settingsSaved',
            'tags',
            'tasks',
            'f_past',
            'f_today',
            'f_soon',
            'alltasks',
            'set_header'
        ]);
        $a['_rtl'] = $this->rtl() ? 1 : 0;

        return ($escape ? htmlarray($a) : $a);
    }

    protected function fillWithValues(array &$a, array $keys)
    {
        foreach ( $keys as $key ) {
            $a[$key] = $this->get($key);
        }
    }

    function langDir()
    {
        return self::$langDir;
    }

    function langCode()
    {
        return $this->code;
    }

    public function getExtensionLang(string $ext): ?array
    {
        $langDir = MTT_EXT. $ext. '/lang/';
        if (!is_dir($langDir)) {
            return null;
        }
        $def = [];
        if (file_exists($langDir. 'en.json')) {
            $defStr = file_get_contents($langDir. 'en.json');
            $def = json_decode($defStr, true);
            if ($def === null) {
                error_log("Failed to decode translation JSON of extension '$ext', language 'en': ". json_last_error_msg());
                $def = [];
            }
        }
        else {
            #error_log("Default translation file 'en.json' not found in extension '$ext'");
        }
        $lang = [];
        $langFile = $langDir. $this->code. '.json';
        if ($this->code != 'en' && file_exists($langFile)) {
            $langStr = file_get_contents($langFile);
            $lang = json_decode($langStr, true);
            if ($lang === null) {
                error_log("Failed to decode translation JSON of extension '$ext', language '{$this->code}': ". json_last_error_msg());
                $lang = [];
            }
        }
        $lang = array_replace($def, $lang);
        return $lang;
    }

    public function loadExtensionLang(string $ext)
    {
        $lang = $this->getExtensionLang($ext);
        if (!$lang) {
            return;
        }
        if (isset($lang['_header'])) {
            unset($lang['_header']);
        }
        $this->strings = array_replace($this->strings, $lang);
    }

}