290 lines
11 KiB
PHP
290 lines
11 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/*
|
|
* 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!
|
|
*/
|
|
|
|
namespace TYPO3\CMS\Core\Localization;
|
|
|
|
use Psr\EventDispatcher\EventDispatcherInterface;
|
|
use Psr\Log\LoggerInterface;
|
|
use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
|
|
use Symfony\Component\Finder\Finder;
|
|
use TYPO3\CMS\Core\Core\Environment;
|
|
use TYPO3\CMS\Core\Http\RequestFactory;
|
|
use TYPO3\CMS\Core\Http\Uri;
|
|
use TYPO3\CMS\Core\Information\Typo3Version;
|
|
use TYPO3\CMS\Core\Localization\Event\ModifyLanguagePackRemoteBaseUrlEvent;
|
|
use TYPO3\CMS\Core\Localization\Event\ModifyLanguagePacksEvent;
|
|
use TYPO3\CMS\Core\Package\PackageManager;
|
|
use TYPO3\CMS\Core\Registry;
|
|
use TYPO3\CMS\Core\Service\Archive\ZipService;
|
|
use TYPO3\CMS\Core\SystemResource\Publishing\SystemResourcePublisherInterface;
|
|
use TYPO3\CMS\Core\SystemResource\SystemResourceFactory;
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
|
|
|
/**
|
|
* Service class handling language pack details
|
|
* Used by 'manage language packs' module and 'language packs command'
|
|
*
|
|
* @internal This class is only meant to be used within EXT:core and is not part of the TYPO3 Core API.
|
|
*/
|
|
#[Autoconfigure(public: true)]
|
|
readonly class LanguagePackService
|
|
{
|
|
private const string LANGUAGE_PACK_URL = 'https://localize.typo3.org/xliff/';
|
|
|
|
public function __construct(
|
|
private EventDispatcherInterface $eventDispatcher,
|
|
private RequestFactory $requestFactory,
|
|
private LoggerInterface $logger,
|
|
private SystemResourceFactory $resourceFactory,
|
|
private SystemResourcePublisherInterface $resourcePublisher,
|
|
private Locales $locales,
|
|
private Registry $registry,
|
|
) {}
|
|
|
|
/**
|
|
* Get list of available languages
|
|
*
|
|
* @return array iso=>name
|
|
*/
|
|
public function getAvailableLanguages(): array
|
|
{
|
|
return $this->locales->getLanguages();
|
|
}
|
|
|
|
/**
|
|
* List of languages active in this instance
|
|
* @return list<non-empty-string>
|
|
*/
|
|
public function getActiveLanguages(): array
|
|
{
|
|
$availableLanguages = $GLOBALS['TYPO3_CONF_VARS']['LANG']['availableLocales'] ?? [];
|
|
return array_values(array_filter($availableLanguages));
|
|
}
|
|
|
|
/**
|
|
* Create an array with language details: active or not, iso codes, last update, ...
|
|
*/
|
|
public function getLanguageDetails(): array
|
|
{
|
|
$availableLanguages = $this->getAvailableLanguages();
|
|
$activeLanguages = $this->getActiveLanguages();
|
|
$languages = [];
|
|
foreach ($availableLanguages as $iso => $name) {
|
|
if ($iso === 'en') {
|
|
continue;
|
|
}
|
|
$lastUpdate = $this->registry->get('languagePacks', $iso);
|
|
$languages[] = [
|
|
'iso' => $iso,
|
|
'name' => $name,
|
|
'active' => in_array($iso, $activeLanguages, true),
|
|
'lastUpdate' => $this->getFormattedDate($lastUpdate),
|
|
'dependencies' => $this->locales->getLocaleDependencies($iso),
|
|
];
|
|
}
|
|
usort($languages, static function ($a, $b) {
|
|
// Sort languages by name
|
|
if ($a['name'] === $b['name']) {
|
|
return 0;
|
|
}
|
|
return $a['name'] < $b['name'] ? -1 : 1;
|
|
});
|
|
return $languages;
|
|
}
|
|
|
|
/**
|
|
* Create a list of loaded extensions and their language packs details
|
|
*/
|
|
public function getExtensionLanguagePackDetails(): array
|
|
{
|
|
$activeLanguages = $this->getActiveLanguages();
|
|
$packageManager = GeneralUtility::makeInstance(PackageManager::class);
|
|
$activePackages = $packageManager->getActivePackages();
|
|
$extensions = [];
|
|
foreach ($activePackages as $package) {
|
|
$path = $package->getPackagePath();
|
|
$finder = new Finder();
|
|
try {
|
|
$files = $finder->files()->ignoreUnreadableDirs()->in($path . 'Resources/Private/Language/')->name('*.xlf');
|
|
if (!$files->hasResults()) {
|
|
continue;
|
|
}
|
|
} catch (\InvalidArgumentException $e) {
|
|
// Dir does not exist
|
|
continue;
|
|
}
|
|
$key = $package->getPackageKey();
|
|
|
|
$metaData = $package->getPackageMetaData();
|
|
if ($metaData->isExcludedFromUpdates()) {
|
|
continue;
|
|
}
|
|
$extension = [
|
|
'key' => $key,
|
|
'title' => $metaData->getTitle(),
|
|
'type' => $metaData->getPackageType(),
|
|
];
|
|
$packageIcon = $package->getResources()->getPackageIcon();
|
|
if ($packageIcon !== null) {
|
|
$iconResource = $this->resourceFactory->createPublicResource($packageIcon);
|
|
$extension['icon'] = (string)$this->resourcePublisher->generateUri($iconResource, null);
|
|
}
|
|
$extension['packs'] = [];
|
|
foreach ($activeLanguages as $iso) {
|
|
$isLanguagePackDownloaded = is_dir(Environment::getLabelsPath() . '/' . $iso . '/' . $key . '/');
|
|
$lastUpdate = $this->registry->get('languagePacks', $iso . '-' . $key);
|
|
$extension['packs'][$iso] = [
|
|
'iso' => $iso,
|
|
'exists' => $isLanguagePackDownloaded,
|
|
'lastUpdate' => $this->getFormattedDate($lastUpdate),
|
|
];
|
|
}
|
|
$extensions[$key] = $extension;
|
|
}
|
|
ksort($extensions);
|
|
$event = $this->eventDispatcher->dispatch(new ModifyLanguagePacksEvent($extensions));
|
|
return $event->getExtensions();
|
|
}
|
|
|
|
/**
|
|
* Download and unpack a single language pack of one extension.
|
|
*
|
|
* @param string $key Extension key
|
|
* @param string $iso Language iso code
|
|
* @return string One of 'update', 'new', 'skipped' or 'failed'
|
|
* @throws \RuntimeException
|
|
*/
|
|
public function languagePackDownload(string $key, string $iso): string
|
|
{
|
|
// Sanitize extension and iso code
|
|
$availableLanguages = $this->getAvailableLanguages();
|
|
$activeLanguages = $this->getActiveLanguages();
|
|
if (!array_key_exists($iso, $availableLanguages) || !in_array($iso, $activeLanguages, true)) {
|
|
throw new \RuntimeException('Language iso code ' . (string)$iso . ' not available or active', 1520117054);
|
|
}
|
|
$packageManager = GeneralUtility::makeInstance(PackageManager::class);
|
|
$package = $packageManager->getActivePackages()[$key] ?? null;
|
|
if (!$package) {
|
|
throw new \RuntimeException('Extension ' . (string)$key . ' not loaded', 1520117245);
|
|
}
|
|
|
|
$languagePackBaseUrl = self::LANGUAGE_PACK_URL;
|
|
|
|
// Allow to modify the base url on the fly
|
|
$event = $this->eventDispatcher->dispatch(new ModifyLanguagePackRemoteBaseUrlEvent(new Uri($languagePackBaseUrl), $key));
|
|
$languagePackBaseUrl = $event->getBaseUrl();
|
|
$majorVersion = GeneralUtility::makeInstance(Typo3Version::class)->getMajorVersion();
|
|
if ($package->getPackageMetaData()->isFrameworkType()) {
|
|
// This is a system extension and the package URL should be adapted to have different packs per core major version
|
|
// https://localize.typo3.org/xliff/b/a/backend-l10n/backend-l10n-fr.v9.zip
|
|
$packageUrl = $key[0] . '/' . $key[1] . '/' . $key . '-l10n/' . $key . '-l10n-' . $iso . '.v' . $majorVersion . '.zip';
|
|
} else {
|
|
// Typical non sysext path, Hungarian:
|
|
// https://localize.typo3.org/xliff/a/n/anextension-l10n/anextension-l10n-hu.zip
|
|
$packageUrl = $key[0] . '/' . $key[1] . '/' . $key . '-l10n/' . $key . '-l10n-' . $iso . '.zip';
|
|
}
|
|
|
|
$absoluteLanguagePath = Environment::getLabelsPath() . '/' . $iso . '/';
|
|
$absoluteExtractionPath = $absoluteLanguagePath . $key . '/';
|
|
$absolutePathToZipFile = Environment::getVarPath() . '/transient/' . $key . '-l10n-' . $iso . '.zip';
|
|
|
|
$packExists = is_dir($absoluteExtractionPath);
|
|
|
|
$packResult = $packExists ? 'update' : 'new';
|
|
|
|
$operationResult = false;
|
|
|
|
$response = $this->requestFactory->request($languagePackBaseUrl . $packageUrl, 'GET', ['http_errors' => false]);
|
|
if ($response->getStatusCode() === 200) {
|
|
$languagePackContent = $response->getBody()->getContents();
|
|
if (!empty($languagePackContent)) {
|
|
$operationResult = true;
|
|
if ($packExists) {
|
|
$operationResult = GeneralUtility::rmdir($absoluteExtractionPath, true);
|
|
}
|
|
if ($operationResult) {
|
|
GeneralUtility::mkdir_deep(Environment::getVarPath() . '/transient/');
|
|
$operationResult = GeneralUtility::writeFileToTypo3tempDir($absolutePathToZipFile, $languagePackContent) === null;
|
|
}
|
|
$this->unzipTranslationFile($absolutePathToZipFile, $absoluteLanguagePath);
|
|
if ($operationResult) {
|
|
$operationResult = unlink($absolutePathToZipFile);
|
|
}
|
|
}
|
|
} else {
|
|
$this->logger->warning('Requesting {request} was not successful, got status code {status} ({reason})', [
|
|
'request' => $languagePackBaseUrl . $packageUrl,
|
|
'status' => $response->getStatusCode(),
|
|
'reason' => $response->getReasonPhrase(),
|
|
]);
|
|
}
|
|
if (!$operationResult) {
|
|
$packResult = 'failed';
|
|
$this->registry->set('languagePacks', $iso . '-' . $key, time());
|
|
}
|
|
return $packResult;
|
|
}
|
|
|
|
/**
|
|
* Set 'last update' timestamp in registry for a series of iso codes.
|
|
*
|
|
* @param string[] $isos List of iso code timestamps to set
|
|
* @throws \RuntimeException
|
|
*/
|
|
public function setLastUpdatedIsoCode(array $isos): void
|
|
{
|
|
$activeLanguages = $GLOBALS['TYPO3_CONF_VARS']['LANG']['availableLocales'] ?? [];
|
|
foreach ($isos as $iso) {
|
|
if (!in_array($iso, $activeLanguages, true)) {
|
|
throw new \RuntimeException('Language iso code ' . (string)$iso . ' not available or active', 1520176318);
|
|
}
|
|
$this->registry->set('languagePacks', $iso, time());
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Format a timestamp to a formatted date string
|
|
*/
|
|
private function getFormattedDate(?int $timestamp): ?string
|
|
{
|
|
if (is_int($timestamp)) {
|
|
$date = (new \DateTime())->setTimestamp($timestamp);
|
|
$format = $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] . ' ' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'];
|
|
$timestamp = $date->format($format);
|
|
}
|
|
return $timestamp;
|
|
}
|
|
|
|
/**
|
|
* Unzip a language zip file
|
|
*
|
|
* @param string $file path to zip file
|
|
* @param string $path path to extract to
|
|
*/
|
|
private function unzipTranslationFile(string $file, string $path): void
|
|
{
|
|
if (!is_dir($path)) {
|
|
GeneralUtility::mkdir_deep($path);
|
|
}
|
|
|
|
$zipService = GeneralUtility::makeInstance(ZipService::class);
|
|
if ($zipService->verify($file)) {
|
|
$zipService->extract($file, $path);
|
|
}
|
|
}
|
|
}
|