TranslationService.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Lang\Service;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\SignalSlot\Dispatcher;
use TYPO3\CMS\Extensionmanager\Exception\ExtensionManagerException;
use TYPO3\CMS\Extensionmanager\Utility\Repository\Helper;

class TranslationService implements SingletonInterface
{
    const TRANSLATION_NOT_AVAILABLE = 0;
    const TRANSLATION_AVAILABLE = 1;
    const TRANSLATION_FAILED = 2;
    const TRANSLATION_OK = 3;
    const TRANSLATION_INVALID = 4;
    const TRANSLATION_UPDATED = 5;

    protected $terService;

    protected $signalSlotDispatcher;

    protected $mirrorUrl = '';

    public function injectTerService(TerService $terService)
    {
        $this->terService = $terService;
    }

    public function injectSignalSlotDispatcher(Dispatcher $signalSlotDispatcher)
    {
        $this->signalSlotDispatcher = $signalSlotDispatcher;
    }

    public function injectRepositoryHelper(Helper $helper)
    {
        try {
            $this->mirrorUrl = $helper->getMirrors(false)->getMirrorUrl();
        } catch (ExtensionManagerException $e) {
            $this->mirrorUrl = '';
        }
    }

    public function updateTranslation($extensionKey, $locales)
    {
        if (is_string($locales)) {
            $locales = GeneralUtility::trimExplode(',', $locales);
        }
        $locales = array_flip((array)$locales);
        foreach ($locales as $locale => $key) {
            $state = static::TRANSLATION_INVALID;
            $error = '';
            try {
                $state = $this->updateTranslationForExtension($extensionKey, $locale);
            } catch (\Exception $exception) {
                $error = $exception->getMessage();
            }
            $locales[$locale] = [
                'state'  => $state,
                'error'  => $error,
            ];
        }
        return $locales;
    }

    protected function updateTranslationForExtension($extensionKey, $locale)
    {
        if (empty($extensionKey) || empty($locale)) {
            return static::TRANSLATION_INVALID;
        }

        $mirrorUrl = $this->getMirrorUrl($extensionKey);
        if (empty($mirrorUrl)) {
            throw new \Exception('Not able to fetch languages files due to missing mirror url.', 1461248062);
        }

        $state = static::TRANSLATION_FAILED;

        $updateResult = $this->terService->updateTranslation($extensionKey, $locale, $mirrorUrl);
        if ($updateResult === true) {
            $state = static::TRANSLATION_UPDATED;
        }
        return $state;
    }

    protected function getMirrorUrl($extensionKey)
    {
        $this->signalSlotDispatcher->dispatch(
            __CLASS__,
            'postProcessMirrorUrl',
            [
                'extensionKey' => $extensionKey,
                'mirrorUrl' => &$this->mirrorUrl,
            ]
        );

        return $this->mirrorUrl;
    }
}