UpdateTranslationService.php

Go to the documentation of this file.

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

class UpdateTranslationService {

    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 $languageRepository;

    protected $repositoryHelper;

    protected $terConnection;

    protected $signalSlotDispatcher;

    protected $translationStates = array();

    public function updateTranslation($extension, $locales) {
        if (is_string($locales)) {
            $locales = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $locales);
        }
        $locales = array_flip((array) $locales);

        foreach ($locales as $locale => $key) {
            $state = static::TRANSLATION_INVALID;
            try {
                $state = $this->getTranslationStateForExtension($extension, $locale);
                if ($state === static::TRANSLATION_AVAILABLE) {
                    $state = $this->updateTranslationForExtension($extension, $locale);
                }
            } catch (\Exception $exception) {
                $error = $exception->getMessage();
            }
            $locales[$locale] = array(
                'state'  => $state,
                'error'  => $error,
            );
        }
        return $locales;
    }

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

        $identifier = $extensionKey . '-' . $locale;
        if (isset($this->translationStates[$identifier])) {
            return $this->translationStates[$identifier];
        }

        $selectedLanguages = $this->languageRepository->findSelected();
        if (empty($selectedLanguages) || !is_array($selectedLanguages)) {
            return static::TRANSLATION_INVALID;
        }

        $mirrorUrl = $this->getMirrorUrl($extensionKey);
        $status = $this->terConnection->fetchTranslationStatus($extensionKey, $mirrorUrl);

        foreach ($selectedLanguages as $language) {
            $stateLocale = $language->getLocale();
            $stateIdentifier = $extensionKey . '-' . $stateLocale;
            $this->translationStates[$stateIdentifier] = static::TRANSLATION_INVALID;

            if (empty($status[$stateLocale]) || !is_array($status[$stateLocale])) {
                $this->translationStates[$stateIdentifier] = static::TRANSLATION_NOT_AVAILABLE;
                continue;
            }

            $md5 = $this->getTranslationFileMd5($extensionKey, $stateLocale);
            if ($md5 !== $status[$stateLocale]['md5']) {
                $this->translationStates[$stateIdentifier] = static::TRANSLATION_AVAILABLE;
                continue;
            }

            $this->translationStates[$stateIdentifier] = static::TRANSLATION_OK;
        }

        return $this->translationStates[$identifier];
    }

    protected function getTranslationFileMd5($extensionKey, $locale) {
        if (empty($extensionKey) || empty($locale)) {
            return '';
        }
        $fileName = PATH_site . 'typo3temp' . DIRECTORY_SEPARATOR . $extensionKey . '-l10n-' . $locale . '.zip';
        if (is_file($fileName)) {
            return md5_file($fileName);
        }
        return '';
    }

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

        $state = static::TRANSLATION_FAILED;
        $mirrorUrl = $this->getMirrorUrl($extensionKey);
        $updateResult = $this->terConnection->updateTranslation($extensionKey, $locale, $mirrorUrl);
        if ($updateResult === TRUE) {
            $state = static::TRANSLATION_UPDATED;
        }

        return $state;
    }

    protected function getMirrorUrl($extensionKey) {
        $mirrorUrl = $this->repositoryHelper->getMirrors(FALSE)->getMirrorUrl();

        $mirrorUrl = $this->emitPostProcessMirrorUrlSignal($extensionKey, $mirrorUrl);

        return $mirrorUrl;
    }

    protected function emitPostProcessMirrorUrlSignal($extensionKey, $mirrorUrl) {
        $this->signalSlotDispatcher->dispatch(
            __CLASS__,
            'postProcessMirrorUrl',
            array(
                $extensionKey,
                &$mirrorUrl,
            )
        );
        return $mirrorUrl;
    }

}