. * * The interactive user interfaces in modified source and object code versions * of this program must display Appropriate Legal Notices, as required under * Section 5 of the GNU Affero General Public License version 3. * * In accordance with Section 7(b) of the GNU Affero General Public License version 3, * these Appropriate Legal Notices must retain the display of the "EspoCRM" word. ************************************************************************/ namespace Espo\Core\Utils; use Espo\Core\Utils\File\Manager as FileManager; use Espo\Core\Utils\Resource\Reader as ResourceReader; use Espo\Core\Utils\Resource\Reader\Params as ResourceReaderParams; use Espo\Entities\Preferences; use RuntimeException; use stdClass; class Language { /** @var array> */ private $data = []; /** @var array> */ private $deletedData = []; /** @var array> */ private $changedData = []; private string $currentLanguage; protected string $defaultLanguage = 'en_US'; private string $customPath = 'custom/Espo/Custom/Resources/i18n/{language}'; private string $resourcePath = 'i18n/{language}'; /** * @param bool $noFallback As of v9.2. */ public function __construct( ?string $language, private FileManager $fileManager, private ResourceReader $resourceReader, private DataCache $dataCache, protected bool $useCache = false, protected bool $noCustom = false, private bool $noFallback = false, ) { $this->currentLanguage = $language ?? $this->defaultLanguage; } public function getLanguage(): string { return $this->currentLanguage; } public function getDefaultLanguage(): string { return $this->defaultLanguage; } public static function detectLanguage(Config $config, ?Preferences $preferences = null): ?string { $language = $preferences?->get('language'); if (!$language) { $language = $config->get('language'); } return $language; } /** * @deprecated As of v7.4. Not to be used. */ public function setLanguage(string $language): void { $this->currentLanguage = $language; } private function getCacheKey(?string $language = null): string { return 'languages/' . ($language ?? $this->currentLanguage); } /** * Translate a label. * * @param string $label * @param string $category * @param string $scope * @return string */ public function translateLabel(string $label, string $category = 'labels', string $scope = 'Global'): string { $translated = $this->translate($label, $category, $scope); if (is_array($translated)) { return implode(', ', $translated); } return $translated; } /** * Translate label or labels. * * @param string|string[] $label A name of label. * @param string $category A category. * @param string $scope A scope. * @param string[]|null $requiredOptions A list of required options. * Ex., $requiredOptions = ['en_US', 'de_DE'] * "language" option has only ['en_US' => 'English (United States)'] * Result will be ['en_US' => 'English (United States)', 'de_DE' => 'de_DE']. * @return string|string[]|array */ public function translate( $label, string $category = 'labels', string $scope = 'Global', ?array $requiredOptions = null ) { if (is_array($label)) { $translated = []; foreach ($label as $subLabel) { $translated[$subLabel] = $this->translate($subLabel, $category, $scope, $requiredOptions); } /** @var string[]|array */ return $translated; } $key = $scope . '.' . $category . '.' . $label; $translated = $this->get($key); if (!isset($translated)) { $key = 'Global.'.$category.'.' . $label; $translated = $this->get($key, $label); } if (is_array($translated) && isset($requiredOptions)) { $translated = array_intersect_key($translated, array_flip($requiredOptions)); $optionKeys = array_keys($translated); foreach ($requiredOptions as $option) { if (!in_array($option, $optionKeys)) { $translated[$option] = $option; } } } return $translated; } /** * @param int|string $value * @return string */ public function translateOption($value, string $field, string $scope = 'Global') { $options = $this->get($scope . '.options.' . $field); if (is_array($options) && array_key_exists($value, $options)) { return $options[$value]; } if ($scope !== 'Global') { $options = $this->get('Global.options.' . $field); if (is_array($options) && array_key_exists($value, $options)) { return $options[$value]; } } return (string) $value; } /** * * @param string|string[]|null $key * @param mixed $returns * @return mixed */ public function get($key = null, $returns = null) { $data = $this->getData(); if (!isset($data)) { throw new RuntimeException('Language: current language '.$this->currentLanguage.' not found'); } return Util::getValueByKey($data, $key, $returns); } /** * @return array> */ public function getAll(): array { return $this->get(); } /** * @since 9.2.0 */ public function getScopeCustom(string $scope): ?stdClass { $path = str_replace('{language}', $this->currentLanguage, $this->customPath) . "/$scope.json"; if (!$this->fileManager->isFile($path)) { return null; } $fileContent = $this->fileManager->getContents($path); return Json::decode($fileContent); } /** * @since 9.2.0 */ public function saveScopeCustom(string $scope, stdClass $data): void { $path = str_replace('{language}', $this->currentLanguage, $this->customPath) . "/$scope.json"; foreach (get_object_vars($data) as $key => $item) { if ( $item instanceof stdClass && count(get_object_vars($data)) === 0 ) { unset($data->$key); } } $changedData = Json::encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); $this->fileManager->putContents($path, $changedData); $this->init(true); } /** * Save changes. */ public function save(): bool { $path = str_replace('{language}', $this->currentLanguage, $this->customPath); $result = true; if (!empty($this->changedData)) { foreach ($this->changedData as $scope => $data) { if (empty($data)) { continue; } $result &= $this->fileManager->mergeJsonContents($path . "/$scope.json", $data); } } if (!empty($this->deletedData)) { foreach ($this->deletedData as $scope => $unsetData) { if (empty($unsetData)) { continue; } $result &= $this->fileManager->unsetJsonContents($path . "/$scope.json", $unsetData); } } $this->clearChanges(); return (bool) $result; } /** * Clear unsaved changes. */ public function clearChanges(): void { $this->changedData = []; $this->deletedData = []; $this->init(true); } /** * @return ?array */ private function getData(): ?array { $currentLanguage = $this->currentLanguage; if (!isset($this->data[$currentLanguage])) { $this->init(); } return $this->data[$currentLanguage] ?? null; } /** * Set/change a label. * * @param string|array $name * @param mixed $value */ public function set(string $scope, string $category, $name, $value): void { if (is_array($name)) { foreach ($name as $rowLabel => $rowValue) { $this->set($scope, $category, $rowLabel, $rowValue); } return; } $this->changedData[$scope][$category][$name] = $value; $currentLanguage = $this->currentLanguage; if (!isset($this->data[$currentLanguage])) { $this->init(); } $this->data[$currentLanguage][$scope][$category][$name] = $value; $this->undelete($scope, $category, $name); } /** * Remove a label. * * @param string $scope * @param string $category * @param string|string[] $name */ public function delete(string $scope, string $category, $name): void { if (is_array($name)) { foreach ($name as $rowLabel) { $this->delete($scope, $category, $rowLabel); } return; } $this->deletedData[$scope][$category][] = $name; $currentLanguage = $this->currentLanguage; if (!isset($this->data[$currentLanguage])) { $this->init(); } if (isset($this->data[$currentLanguage][$scope][$category][$name])) { unset($this->data[$currentLanguage][$scope][$category][$name]); } if (isset($this->changedData[$scope][$category][$name])) { unset($this->changedData[$scope][$category][$name]); } } private function undelete(string $scope, string $category, string $name): void { if (isset($this->deletedData[$scope][$category])) { foreach ($this->deletedData[$scope][$category] as $key => $labelName) { if ($name === $labelName) { unset($this->deletedData[$scope][$category][$key]); } } } } private function init(bool $reload = false): void { $this->data[$this->currentLanguage] = $this->getLanguageData($this->currentLanguage, $reload); } /** * @return array */ private function getDefaultLanguageData(bool $reload = false): array { return $this->getLanguageData($this->defaultLanguage, $reload); } /** * @return array */ private function getLanguageData(string $language, bool $reload = false): array { if (!$reload && isset($this->data[$language])) { return $this->data[$language]; } $cacheKey = $this->getCacheKey($language); if (!$this->useCache || !$this->dataCache->has($cacheKey) || $reload) { $readerParams = ResourceReaderParams ::create() ->withNoCustom($this->noCustom); $path = str_replace('{language}', $language, $this->resourcePath); $data = $this->resourceReader->readAsArray($path, $readerParams); if ($language !== $this->defaultLanguage && !$this->noFallback) { /** @var array> $data */ $data = Util::merge($this->getDefaultLanguageData($reload), $data); } $this->data[$language] = $data; if ($this->useCache) { $this->dataCache->store($cacheKey, $data); } } if ($this->useCache) { /** @var array $cachedData */ $cachedData = $this->dataCache->get($cacheKey); $this->data[$language] = $cachedData; } return $this->data[$language] ?? []; } }