[TASK] Avoid unused xpath when parsing locallang.xml
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Localization / Parser / LocallangXmlParser.php
1 <?php
2 namespace TYPO3\CMS\Core\Localization\Parser;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Core\Localization\Exception\InvalidXmlFileException;
18 use TYPO3\CMS\Core\Utility\ArrayUtility;
19 use TYPO3\CMS\Core\Utility\GeneralUtility;
20 use TYPO3\CMS\Core\Utility\PathUtility;
21
22 /**
23 * Parser for XML locallang file.
24 */
25 class LocallangXmlParser extends AbstractXmlParser
26 {
27 /**
28 * Associative array of "filename => parsed data" pairs.
29 *
30 * @var array
31 */
32 protected $parsedTargetFiles;
33
34 /**
35 * Returns parsed representation of XML file.
36 *
37 * @param string $sourcePath Source file path
38 * @param string $languageKey Language key
39 * @param string $charset File charset, not in use anymore and deprecated since TYPO3 v8, will be removed in TYPO3 v9 as UTF-8 is expected for all language files
40 * @return array
41 */
42 public function getParsedData($sourcePath, $languageKey, $charset = '')
43 {
44 $this->sourcePath = $sourcePath;
45 $this->languageKey = $languageKey;
46 // Parse source
47 $parsedSource = $this->parseXmlFile();
48 // Parse target
49 $localizedTargetPath = GeneralUtility::getFileAbsFileName(GeneralUtility::llXmlAutoFileName($this->sourcePath, $this->languageKey));
50 $targetPath = $this->languageKey !== 'default' && @is_file($localizedTargetPath) ? $localizedTargetPath : $this->sourcePath;
51 try {
52 $parsedTarget = $this->getParsedTargetData($targetPath);
53 } catch (InvalidXmlFileException $e) {
54 $parsedTarget = $this->getParsedTargetData($this->sourcePath);
55 }
56 $LOCAL_LANG = [];
57 $LOCAL_LANG[$languageKey] = $parsedSource;
58 ArrayUtility::mergeRecursiveWithOverrule($LOCAL_LANG[$languageKey], $parsedTarget);
59 return $LOCAL_LANG;
60 }
61
62 /**
63 * Returns array representation of XLIFF data, starting from a root node.
64 *
65 * @param \SimpleXMLElement $root XML root element
66 * @param string $element Target or Source
67 * @return array
68 * @throws InvalidXmlFileException
69 */
70 protected function doParsingFromRootForElement(\SimpleXMLElement $root, $element)
71 {
72 $bodyOfFileTag = $root->data->languageKey;
73 if ($bodyOfFileTag === null) {
74 throw new InvalidXmlFileException('Invalid locallang.xml language file "' . PathUtility::stripPathSitePrefix($this->sourcePath) . '"', 1487944884);
75 }
76
77 if ($element === 'source' || $this->languageKey === 'default') {
78 $parsedData = $this->getParsedDataForElement($bodyOfFileTag, $element);
79 } else {
80 $parsedData = [];
81 }
82 if ($element === 'target') {
83 // Check if the source llxml file contains localized records
84 $localizedBodyOfFileTag = $root->data->xpath('languageKey[@index=\'' . $this->languageKey . '\']');
85 if (isset($localizedBodyOfFileTag[0]) && $localizedBodyOfFileTag[0] instanceof \SimpleXMLElement) {
86 $parsedDataTarget = $this->getParsedDataForElement($localizedBodyOfFileTag[0], $element);
87 $mergedData = $parsedDataTarget + $parsedData;
88 if ($this->languageKey === 'default') {
89 $parsedData = array_intersect_key($mergedData, $parsedData, $parsedDataTarget);
90 } else {
91 $parsedData = array_intersect_key($mergedData, $parsedDataTarget);
92 }
93 }
94 }
95 return $parsedData;
96 }
97
98 /**
99 * Parse the given language key tag
100 *
101 * @param \SimpleXMLElement $bodyOfFileTag
102 * @param string $element
103 * @return array
104 */
105 protected function getParsedDataForElement(\SimpleXMLElement $bodyOfFileTag, $element)
106 {
107 $parsedData = [];
108 $children = $bodyOfFileTag->children();
109 if ($children->count() === 0) {
110 // Check for externally-referenced resource:
111 // <languageKey index="fr">EXT:yourext/path/to/localized/locallang.xml</languageKey>
112 $reference = sprintf('%s', $bodyOfFileTag);
113 if (substr($reference, -4) === '.xml') {
114 return $this->getParsedTargetData(GeneralUtility::getFileAbsFileName($reference));
115 }
116 }
117 /** @var \SimpleXMLElement $translationElement */
118 foreach ($children as $translationElement) {
119 if ($translationElement->getName() === 'label') {
120 $parsedData[(string)$translationElement['index']][0] = [
121 $element => (string)$translationElement
122 ];
123 }
124 }
125 return $parsedData;
126 }
127
128 /**
129 * Returns array representation of XLIFF data, starting from a root node.
130 *
131 * @param \SimpleXMLElement $root A root node
132 * @return array An array representing parsed XLIFF
133 */
134 protected function doParsingFromRoot(\SimpleXMLElement $root)
135 {
136 return $this->doParsingFromRootForElement($root, 'source');
137 }
138
139 /**
140 * Returns array representation of XLIFF data, starting from a root node.
141 *
142 * @param \SimpleXMLElement $root A root node
143 * @return array An array representing parsed XLIFF
144 */
145 protected function doParsingTargetFromRoot(\SimpleXMLElement $root)
146 {
147 return $this->doParsingFromRootForElement($root, 'target');
148 }
149
150 /**
151 * Returns parsed representation of XML file.
152 *
153 * Parses XML if it wasn't done before. Caches parsed data.
154 *
155 * @param string $path An absolute path to XML file
156 * @return array Parsed XML file
157 */
158 public function getParsedTargetData($path)
159 {
160 if (!isset($this->parsedTargetFiles[$path])) {
161 $this->parsedTargetFiles[$path] = $this->parseXmlTargetFile($path);
162 }
163 return $this->parsedTargetFiles[$path];
164 }
165
166 /**
167 * Reads and parses XML file and returns internal representation of data.
168 *
169 * @param string $targetPath Path of the target file
170 * @return array
171 * @throws \TYPO3\CMS\Core\Localization\Exception\InvalidXmlFileException
172 */
173 protected function parseXmlTargetFile($targetPath)
174 {
175 $rootXmlNode = false;
176 if (file_exists($targetPath)) {
177 $xmlContent = file_get_contents($targetPath);
178 // Disables the functionality to allow external entities to be loaded when parsing the XML, must be kept
179 $previousValueOfEntityLoader = libxml_disable_entity_loader(true);
180 $rootXmlNode = simplexml_load_string($xmlContent, 'SimpleXMLElement', LIBXML_NOWARNING);
181 libxml_disable_entity_loader($previousValueOfEntityLoader);
182 }
183 if (!isset($rootXmlNode) || $rootXmlNode === false) {
184 $xmlError = libxml_get_last_error();
185 throw new InvalidXmlFileException(
186 'The path provided does not point to existing and accessible well-formed XML file. Reason: ' . $xmlError->message . ' in ' . $targetPath . ', line ' . $xmlError->line,
187 1278155987
188 );
189 }
190 return $this->doParsingTargetFromRoot($rootXmlNode);
191 }
192 }