Translate.php

Go to the documentation of this file.

<?php

namespace SimpleSAML\Locale;

class Translate
{

    private $configuration;

    private $langtext = array();

    private $dictionaries = array();

    private $defaultDictionary = null;

    private $language;


    public function __construct(\SimpleSAML_Configuration $configuration, $defaultDictionary = null)
    {
        $this->configuration = $configuration;
        $this->language = new Language($configuration);

        if ($defaultDictionary !== null && substr($defaultDictionary, -4) === '.php') {
            // TODO: drop this entire if clause for 2.0
            // for backwards compatibility - print warning
            $backtrace = debug_backtrace();
            $where = $backtrace[0]['file'].':'.$backtrace[0]['line'];
            \SimpleSAML\Logger::warning(
                'Deprecated use of new SimpleSAML\Locale\Translate(...) at '.$where.
                '. The last parameter is now a dictionary name, which should not end in ".php".'
            );

            $this->defaultDictionary = substr($defaultDictionary, 0, -4);
        } else {
            $this->defaultDictionary = $defaultDictionary;
        }
    }


    public function getLanguage()
    {
        return $this->language;
    }


    private function getDictionary($name)
    {
        assert(is_string($name));

        if (!array_key_exists($name, $this->dictionaries)) {
            $sepPos = strpos($name, ':');
            if ($sepPos !== false) {
                $module = substr($name, 0, $sepPos);
                $fileName = substr($name, $sepPos + 1);
                $dictDir = \SimpleSAML\Module::getModuleDir($module).'/dictionaries/';
            } else {
                $dictDir = $this->configuration->getPathValue('dictionarydir', 'dictionaries/');
                $fileName = $name;
            }

            $this->dictionaries[$name] = $this->readDictionaryFile($dictDir.$fileName);
        }

        return $this->dictionaries[$name];
    }


    public function getTag($tag)
    {
        assert(is_string($tag));

        // first check translations loaded by the includeInlineTranslation and includeLanguageFile methods
        if (array_key_exists($tag, $this->langtext)) {
            return $this->langtext[$tag];
        }

        // check whether we should use the default dictionary or a dictionary specified in the tag
        if (substr($tag, 0, 1) === '{' && preg_match('/^{((?:\w+:)?\w+?):(.*)}$/D', $tag, $matches)) {
            $dictionary = $matches[1];
            $tag = $matches[2];
        } else {
            $dictionary = $this->defaultDictionary;
            if ($dictionary === null) {
                // we don't have any dictionary to load the tag from
                return null;
            }
        }

        $dictionary = $this->getDictionary($dictionary);
        if (!array_key_exists($tag, $dictionary)) {
            return null;
        }

        return $dictionary[$tag];
    }


    public function getPreferredTranslation($translations)
    {
        assert(is_array($translations));

        // look up translation of tag in the selected language
        $selected_language = $this->language->getLanguage();
        if (array_key_exists($selected_language, $translations)) {
            return $translations[$selected_language];
        }

        // look up translation of tag in the default language
        $default_language = $this->language->getDefaultLanguage();
        if (array_key_exists($default_language, $translations)) {
            return $translations[$default_language];
        }

        // check for english translation
        if (array_key_exists('en', $translations)) {
            return $translations['en'];
        }

        // pick the first translation available
        if (count($translations) > 0) {
            $languages = array_keys($translations);
            return $translations[$languages[0]];
        }

        // we don't have anything to return
        throw new \Exception('Nothing to return from translation.');
    }


    public function getAttributeTranslation($name)
    {
        // normalize attribute name
        $normName = strtolower($name);
        $normName = str_replace(":", "_", $normName);

        // check for an extra dictionary
        $extraDict = $this->configuration->getString('attributes.extradictionary', null);
        if ($extraDict !== null) {
            $dict = $this->getDictionary($extraDict);
            if (array_key_exists($normName, $dict)) {
                return $this->getPreferredTranslation($dict[$normName]);
            }
        }

        // search the default attribute dictionary
        $dict = $this->getDictionary('attributes');
        if (array_key_exists('attribute_'.$normName, $dict)) {
            return $this->getPreferredTranslation($dict['attribute_'.$normName]);
        }

        // no translations found
        return $name;
    }


    public static function noop($tag)
    {
        return $tag;
    }


    public function t(
        $tag,
        $replacements = array(),
        // TODO: remove this for 2.0. Assume true
        $fallbackdefault = true,
        // TODO: remove this for 2.0
        $oldreplacements = array(),
        // TODO: remove this for 2.0
        $striptags = false
    ) {
        $backtrace = debug_backtrace();
        $where = $backtrace[0]['file'].':'.$backtrace[0]['line'];
        if (!$fallbackdefault) {
            \SimpleSAML\Logger::warning(
                'Deprecated use of new SimpleSAML\Locale\Translate::t(...) at '.$where.
                '. This parameter will go away, the fallback will become' .
                ' identical to the $tag in 2.0.'
            );
        }
        if (!is_array($replacements)) {
            // TODO: remove this entire if for 2.0

            // old style call to t(...). Print warning to log
            \SimpleSAML\Logger::warning(
                'Deprecated use of SimpleSAML\Locale\Translate::t(...) at '.$where.
                '. Please update the code to use the new style of parameters.'
            );

            // for backwards compatibility
            if (!$replacements && $this->getTag($tag) === null) {
                \SimpleSAML\Logger::warning(
                    'Code which uses $fallbackdefault === FALSE should be updated to use the getTag() method instead.'
                );
                return null;
            }

            $replacements = $oldreplacements;
        }

        if (is_array($tag)) {
            $tagData = $tag;
            \SimpleSAML\Logger::warning(
                'Deprecated use of new SimpleSAML\Locale\Translate::t(...) at '.$where.
                '. The $tag-parameter can only be a string in 2.0.'
            );
        } else {
            $tagData = $this->getTag($tag);
            if ($tagData === null) {
                // tag not found
                \SimpleSAML\Logger::info('Template: Looking up ['.$tag.']: not translated at all.');
                return $this->getStringNotTranslated($tag, $fallbackdefault);
            }
        }

        $translated = $this->getPreferredTranslation($tagData);

        foreach ($replacements as $k => $v) {
            // try to translate if no replacement is given
            if ($v == null) {
                $v = $this->t($k);
            }
            $translated = str_replace($k, $v, $translated);
        }
        return $translated;
    }


    private function getStringNotTranslated($tag, $fallbacktag)
    {
        if ($fallbacktag) {
            return 'not translated ('.$tag.')';
        } else {
            return $tag;
        }
    }


    public function includeInlineTranslation($tag, $translation)
    {
        if (is_string($translation)) {
            $translation = array('en' => $translation);
        } elseif (!is_array($translation)) {
            throw new \Exception("Inline translation should be string or array. Is ".gettype($translation)." now!");
        }

        \SimpleSAML\Logger::debug('Template: Adding inline language translation for tag ['.$tag.']');
        $this->langtext[$tag] = $translation;
    }


    public function includeLanguageFile($file, $otherConfig = null)
    {
        if (!empty($otherConfig)) {
            $filebase = $otherConfig->getPathValue('dictionarydir', 'dictionaries/');
        } else {
            $filebase = $this->configuration->getPathValue('dictionarydir', 'dictionaries/');
        }

        $lang = $this->readDictionaryFile($filebase.$file);
        \SimpleSAML\Logger::debug('Template: Merging language array. Loading ['.$file.']');
        $this->langtext = array_merge($this->langtext, $lang);
    }


    private function readDictionaryJSON($filename)
    {
        $definitionFile = $filename.'.definition.json';
        assert(file_exists($definitionFile));

        $fileContent = file_get_contents($definitionFile);
        $lang = json_decode($fileContent, true);

        if (empty($lang)) {
            \SimpleSAML\Logger::error('Invalid dictionary definition file ['.$definitionFile.']');
            return array();
        }

        $translationFile = $filename.'.translation.json';
        if (file_exists($translationFile)) {
            $fileContent = file_get_contents($translationFile);
            $moreTrans = json_decode($fileContent, true);
            if (!empty($moreTrans)) {
                $lang = array_merge_recursive($lang, $moreTrans);
            }
        }

        return $lang;
    }


    private function readDictionaryPHP($filename)
    {
        $phpFile = $filename.'.php';
        assert(file_exists($phpFile));

        $lang = null;
        include($phpFile);
        if (isset($lang)) {
            return $lang;
        }

        return array();
    }


    private function readDictionaryFile($filename)
    {
        assert(is_string($filename));

        \SimpleSAML\Logger::debug('Template: Reading ['.$filename.']');

        $jsonFile = $filename.'.definition.json';
        if (file_exists($jsonFile)) {
            return $this->readDictionaryJSON($filename);
        }

        $phpFile = $filename.'.php';
        if (file_exists($phpFile)) {
            return $this->readDictionaryPHP($filename);
        }

        \SimpleSAML\Logger::error(
            $_SERVER['PHP_SELF'].' - Template: Could not find dictionary file at ['.$filename.']'
        );
        return array();
    }


    public static function translateSingularGettext($original)
    {
        $text = \Gettext\BaseTranslator::$current->gettext($original);

        if (func_num_args() === 1) {
            return $text;
        }

        $args = array_slice(func_get_args(), 1);

        return strtr($text, is_array($args[0]) ? $args[0] : $args);
    }


    public static function translatePluralGettext($original, $plural, $value)
    {
        $text = \Gettext\BaseTranslator::$current->ngettext($original, $plural, $value);

        if (func_num_args() === 3) {
            return $text;
        }

        $args = array_slice(func_get_args(), 3);

        return strtr($text, is_array($args[0]) ? $args[0] : $args);
    }


    public static function translateFromArray($context, $translations)
    {
        if (!is_array($translations) || $translations === null) {
            return null;
        }

        if (!is_array($context) || !isset($context['currentLanguage'])) {
            return null;
        }

        if (isset($translations[$context['currentLanguage']])) {
            return $translations[$context['currentLanguage']];
        }

        // we don't have a translation for the current language, load alternative priorities
        $sspcfg = \SimpleSAML_Configuration::getInstance();
        $langcfg = $sspcfg->getConfigItem('language', null);
        $priorities = array();
        if ($langcfg instanceof \SimpleSAML_Configuration) {
            $priorities = $langcfg->getArray('priorities', array());
        }

        foreach ($priorities[$context['currentLanguage']] as $lang) {
            if (isset($translations[$lang])) {
                return $translations[$lang];
            }
        }

        // nothing we can use, return null so that we can set a default
        return null;
    }
}