TranslationsImportExportTask::getDataFromRows() - Code Metrics - Inspection of "fix null values" - lekoala/silverstripe-multilingual - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 04481a...738fe0 )

by Thomas

created 2025-04-07 09:34 UTC

TranslationsImportExportTask::getDataFromRows() A

↳ Parent: TranslationsImportExportTask

Complexity

Conditions	4
Paths	6

Size

Total Lines	18
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	13
nc	6
nop	1
dl	0
loc	18
rs	9.8333
c	0
b	0
f	0

<?php

namespace LeKoala\Multilingual;

use Exception;
use SilverStripe\Dev\Debug;
use SilverStripe\Dev\BuildTask;
use SilverStripe\Control\Director;
use SilverStripe\i18n\Messages\Writer;
use PhpOffice\PhpSpreadsheet\IOFactory;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\Core\Injector\Injector;
use SilverStripe\i18n\Messages\YamlReader;
use LeKoala\ExcelImportExport\ExcelImportExport;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\Core\Manifest\ModuleResourceLoader;
use SilverStripe\i18n\i18n;

/**
 * Helps exporting and importing labels from a csv or xls
 */
class TranslationsImportExportTask extends BuildTask
{
    use BuildTaskTools;

    /**
     * @var string
     */
    private static $segment = 'TranslationsImportExportTask';

    /**
     * @var string
     */
    protected $title = "Translations import export task";
    /**
     * @var string
     */
    protected $description = "Easily import and export translations";

    /**
     * @var bool
     */
    public $debug;

    /**
     * @param \SilverStripe\Control\HTTPRequest $request
     * @return void
     */
    public function run($request)
    {
        $this->request = $request;
        $modules = $this->getModulesAndThemes();
        $this->addOption("import", "Import translations", false);
        $this->addOption("export", "Export translations", false);
        $this->addOption("export_untranslated", "Export untranslated", false);
        $this->addOption("export_auto_translate", "Translate exported strings", false);
        $this->addOption("export_only", "Export only these lang (comma separated)");
        $this->addOption("debug", "Show debug output and do not write files", false);
        $this->addOption("excel", "Use excel if possible (require excel-import-export module)", true);
        $this->addOption("module", "Module", null, $modules);
        $options = $this->askOptions();

        $module = $options['module'];
        $import = $options['import'];
        $excel = $options['excel'];
        $export = $options['export'];
        $export_only = $options['export_only'];
        $export_untranslated = $options['export_untranslated'];
        $export_auto_translate = $options['export_auto_translate'];

        $this->debug = $options['debug'];

        if ($module) {
            if ($import) {
                $this->importTranslations($module);
            }
            if ($export) {
                $onlyLang = [];
                if ($export_only) {
                    $onlyLang = explode(",", $export_only);
                }
                $this->exportTranslations($module, $excel, $onlyLang, $export_untranslated, $export_auto_translate);
            }
        } else {
            $this->message("Please select a module");
        }
    }

    protected function getLangPath(string $module): string
    {
        $langPath = ModuleResourceLoader::resourcePath($module . ':lang');
        return Director::baseFolder() . '/' . str_replace([':', '\\'], '/', $langPath);
    }

    /**
     * @param string $module
     * @return void
     */
    protected function importTranslations($module)
    {
        $fullLangPath = $this->getLangPath($module);
        $modulePath = dirname($fullLangPath);

        $excelFile = $modulePath . "/lang.xlsx";
        $csvFile = $modulePath . "/lang.csv";

        $data = null;
        if (is_file($excelFile)) {
            $this->message("Importing $excelFile");
            $data = $this->importFromExcel($excelFile);
        } elseif (is_file($csvFile)) {
            $this->message("Importing $csvFile");
            $data = $this->importFromCsv($csvFile);
        }

        if (!$data) {
            $this->message("No data to import");
            return;
        }

        if ($this->debug) {
            Debug::dump($data);
        }

        $header = array_keys($data[0]);
        $count = count($header);
        $writer = Injector::inst()->create(Writer::class);
        $langs = array_slice($header, 1, $count);
        $new = 0;
        foreach ($langs as $lang) {
            // $entities = [];

            // keep original
            $reader = new YamlReader;
            $entities = $reader->read($lang, $fullLangPath . '/' . $lang . '.yml');
            foreach ($data as $row) {
                $key = trim($row['\ufeffkey'] ?? $row['key'] ?? '');
                if (!$key) {
                    $this->message("invalid row " . json_encode($row));
                    continue;
                }
                $value = $row[$lang];
                if (is_string($value)) {
                    $value = trim($value);
                }
                $new++;
                $entities[$key] = $value;
            }
            if (!$this->debug) {
                $writer->write(
                    $entities,
                    $lang,
                    dirname($fullLangPath)
                );
                $this->message("Imported $new messages in $lang");
            } else {
                Debug::show($lang);
                Debug::dump($entities);
            }
        }
    }

    /**
     * @param string $file
     * @return array<int,array<mixed>>
     */
    public function importFromExcel($file)
    {
        $spreadsheet = IOFactory::load($file);
        $worksheet = $spreadsheet->getActiveSheet();
        $rows = [];
        foreach ($worksheet->getRowIterator() as $row) {
            $cellIterator = $row->getCellIterator();
            // $cellIterator->setIterateOnlyExistingCells(true);
            $cells = [];
            foreach ($cellIterator as $cell) {
                $cells[] = $cell->getValue();
            }
            if (empty($cells)) {
                break;
            }
            $rows[] = $cells;
        }
        return $this->getDataFromRows($rows);
    }

    /**
     * @param array<array<mixed>> $rows
     * @return array<int,array<mixed>>
     */
    protected function getDataFromRows($rows)
    {
        $header = array_shift($rows);
        $firstKey = $header[0];
        if ($firstKey == 'key') {
            $header[0] = 'key'; // Fix some weird stuff
        }
        $count = count($header);
        $data = [];
        foreach ($rows as $row) {
            while (count($row) < $count) {
                $row[] = '';
            }
            $row = array_slice($row, 0, $count);
            $row = $this->normalizeRow($row);
            $data[] = array_combine($header, $row);
        }
        return $data;
    }

    /**
     * @return array<int,array<mixed>>
     */
    protected function importFromCsv(string $file)
    {
        $arr = file($file);
        if (!$arr) {

            return [];
        }
        $rows = array_map('str_getcsv', $arr);
        return $this->getDataFromRows($rows);
    }

    /**
     * @param array<int,mixed> $row
     * @return array<int,mixed>
     */
    protected function normalizeRow($row)
    {
        foreach ($row as $idx => $value) {
            if ($idx == 0 || $value === null) {
                continue;
            }
            if (strpos($value, '{"') === 0) {
                $row[$idx] = json_decode($value, true);
            }
        }
        return $row;
    }

    /**
     * @param string $module
     * @param boolean $excel
     * @param array<string> $onlyLang
     * @param bool $untranslated
     * @param bool $translate
     * @return void
     */
    public function exportTranslations($module, $excel = true, $onlyLang = [], $untranslated = false, $translate = false)
    {
        $fullLangPath = $this->getLangPath($module);

        $translationFiles = glob($fullLangPath . '/*.yml');
        if ($translationFiles === false) {
            $this->message("No yml");
            return;
        }

        // Collect messages in all lang
        $allMessages = [];
        $headers = ['key'];
        $default = [];
        $defaultFile = null;
        $defaultLang = substr(i18n::get_locale(), 0, 2);
        foreach ($translationFiles as $translationFile) {
            $lang = pathinfo($translationFile, PATHINFO_FILENAME);
            if ($lang == $defaultLang) {
                $defaultFile = $translationFile;
            }
            if (!empty($onlyLang) && !in_array($lang, $onlyLang)) {
                continue;
            }
            $headers[] = $lang;
            $default[] = '';
        }


        $masterMessages = [];
        if ($untranslated) {
            $reader = new YamlReader;
            $masterMessages = $reader->read($defaultLang, $defaultFile);
        }

        $i = 0;
        foreach ($translationFiles as $translationFile) {
            $lang = pathinfo($translationFile, PATHINFO_FILENAME);
            if (!empty($onlyLang) && !in_array($lang, $onlyLang)) {
                continue;
            }
            $reader = new YamlReader;
            $messages = $reader->read($lang, $translationFile);

            foreach ($messages as $entityKey => $v) {
                if ($untranslated) {
                    if (isset($masterMessages[$entityKey]) && $masterMessages[$entityKey] != $v) {
                        continue;
                    }
                }

                if (!isset($allMessages[$entityKey])) {
                    $allMessages[$entityKey] = $default;
                }
                // Plurals can be arrays and need to be converted
                if (is_array($v)) {
                    $v = json_encode($v);
                }

                // Attempt auto translation / 200
                if ($translate && count($allMessages) < 200) {
                    $v = EasyNmtHelper::translate($v, $lang, $defaultLang);
filter:
    dependency_paths: ["lib/*"]
                }

                $allMessages[$entityKey][$i] = $v;
            }
            $i++;
        }
        // don't sort this will be mess up git when merging later
        // ksort($allMessages);
        if ($this->debug) {
            Debug::show($allMessages);
        }

        // Write them to a file
        if ($excel && class_exists(ExcelImportExport::class)) {
            $ext = 'xlsx';
            $destinationFilename = str_replace('/lang', '/lang.' . $ext, $fullLangPath);
            if ($this->debug) {
                Debug::show("Debug mode enabled : no output will be sent to $destinationFilename");
                return;
            }
            if (is_file($destinationFilename)) {
                unlink($destinationFilename);
            }
            // First row contains headers
            $data = [$headers];
            // Add a row per lang
            foreach ($allMessages as $key => $translations) {
                array_unshift($translations, $key);
                $data[] = $translations;
            }
            ExcelImportExport::arrayToFile($data, $destinationFilename);
        } else {
            $ext = 'csv';
            $destinationFilename = str_replace('/lang', '/lang.' . $ext, $fullLangPath);
            if ($this->debug) {
                Debug::show("Debug mode enabled : no output will be sent to $destinationFilename");
                return;
            }
            if (is_file($destinationFilename)) {
                unlink($destinationFilename);
            }
            $fp = fopen($destinationFilename, 'w');
            if ($fp === false) {
                throw new Exception("Failed to open stream");
            }
            // UTF 8 fix
            fprintf($fp, "\xEF\xBB\xBF");
            fputcsv($fp, $headers);
            foreach ($allMessages as $key => $translations) {
                array_unshift($translations, $key);
                fputcsv($fp, $translations);
            }
            fclose($fp);
        }

        $this->message("Translations written to $destinationFilename");
    }

    public function isEnabled(): bool
    {
        return Director::isDev();
    }
}


1			<?php
2
3			namespace LeKoala\Multilingual;
4
5			use Exception;
6			use SilverStripe\Dev\Debug;
7			use SilverStripe\Dev\BuildTask;
8			use SilverStripe\Control\Director;
9			use SilverStripe\i18n\Messages\Writer;
10			use PhpOffice\PhpSpreadsheet\IOFactory;
			0 ignored issues – show Bug introduced 2021-01-06 15:16 UTC by Report Bug Copy Issue Report The type `PhpOffice\PhpSpreadsheet\IOFactory` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
11			use SilverStripe\Core\Injector\Injector;
12			use SilverStripe\i18n\Messages\YamlReader;
13			use LeKoala\ExcelImportExport\ExcelImportExport;
			0 ignored issues – show Bug introduced 2021-01-06 15:16 UTC by Report Bug Copy Issue Report The type `LeKoala\ExcelImportExport\ExcelImportExport` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
14			use SilverStripe\Core\Manifest\ModuleResourceLoader;
15			use SilverStripe\i18n\i18n;
16
17			/**
18			* Helps exporting and importing labels from a csv or xls
19			*/
20			class TranslationsImportExportTask extends BuildTask
21			{
22			use BuildTaskTools;
23
24			/**
25			* @var string
26			*/
27			private static $segment = 'TranslationsImportExportTask';
			0 ignored issues – show introduced 2021-01-06 15:16 UTC by Report Bug Copy Issue Report The private property `$segment` is not used, and could be removed. Loading history...
28			/**
29			* @var string
30			*/
31			protected $title = "Translations import export task";
32			/**
33			* @var string
34			*/
35			protected $description = "Easily import and export translations";
36
37			/**
38			* @var bool
39			*/
40			public $debug;
41
42			/**
43			* @param \SilverStripe\Control\HTTPRequest $request
44			* @return void
45			*/
46			public function run($request)
47			{
48			$this->request = $request;
49			$modules = $this->getModulesAndThemes();
50			$this->addOption("import", "Import translations", false);
51			$this->addOption("export", "Export translations", false);
52			$this->addOption("export_untranslated", "Export untranslated", false);
53			$this->addOption("export_auto_translate", "Translate exported strings", false);
54			$this->addOption("export_only", "Export only these lang (comma separated)");
55			$this->addOption("debug", "Show debug output and do not write files", false);
56			$this->addOption("excel", "Use excel if possible (require excel-import-export module)", true);
57			$this->addOption("module", "Module", null, $modules);
58			$options = $this->askOptions();
59
60			$module = $options['module'];
61			$import = $options['import'];
62			$excel = $options['excel'];
63			$export = $options['export'];
64			$export_only = $options['export_only'];
65			$export_untranslated = $options['export_untranslated'];
66			$export_auto_translate = $options['export_auto_translate'];
67
68			$this->debug = $options['debug'];
69
70			if ($module) {
71			if ($import) {
72			$this->importTranslations($module);
73			}
74			if ($export) {
75			$onlyLang = [];
76			if ($export_only) {
77			$onlyLang = explode(",", $export_only);
78			}
79			$this->exportTranslations($module, $excel, $onlyLang, $export_untranslated, $export_auto_translate);
80			}
81			} else {
82			$this->message("Please select a module");
83			}
84			}
85
86			protected function getLangPath(string $module): string
87			{
88			$langPath = ModuleResourceLoader::resourcePath($module . ':lang');
89			return Director::baseFolder() . '/' . str_replace([':', '\\'], '/', $langPath);
90			}
91
92			/**
93			* @param string $module
94			* @return void
95			*/
96			protected function importTranslations($module)
97			{
98			$fullLangPath = $this->getLangPath($module);
99			$modulePath = dirname($fullLangPath);
100
101			$excelFile = $modulePath . "/lang.xlsx";
102			$csvFile = $modulePath . "/lang.csv";
103
104			$data = null;
105			if (is_file($excelFile)) {
106			$this->message("Importing $excelFile");
107			$data = $this->importFromExcel($excelFile);
108			} elseif (is_file($csvFile)) {
109			$this->message("Importing $csvFile");
110			$data = $this->importFromCsv($csvFile);
111			}
112
113			if (!$data) {
114			$this->message("No data to import");
115			return;
116			}
117
118			if ($this->debug) {
119			Debug::dump($data);
120			}
121
122			$header = array_keys($data[0]);
123			$count = count($header);
124			$writer = Injector::inst()->create(Writer::class);
125			$langs = array_slice($header, 1, $count);
126			$new = 0;
127			foreach ($langs as $lang) {
128			// $entities = [];
129
130			// keep original
131			$reader = new YamlReader;
132			$entities = $reader->read($lang, $fullLangPath . '/' . $lang . '.yml');
133			foreach ($data as $row) {
134			$key = trim($row['\ufeffkey'] ?? $row['key'] ?? '');
135			if (!$key) {
136			$this->message("invalid row " . json_encode($row));
137			continue;
138			}
139			$value = $row[$lang];
140			if (is_string($value)) {
141			$value = trim($value);
142			}
143			$new++;
144			$entities[$key] = $value;
145			}
146			if (!$this->debug) {
147			$writer->write(
148			$entities,
149			$lang,
150			dirname($fullLangPath)
151			);
152			$this->message("Imported $new messages in $lang");
153			} else {
154			Debug::show($lang);
155			Debug::dump($entities);
156			}
157			}
158			}
159
160			/**
161			* @param string $file
162			* @return array<int,array<mixed>>
163			*/
164			public function importFromExcel($file)
165			{
166			$spreadsheet = IOFactory::load($file);
167			$worksheet = $spreadsheet->getActiveSheet();
168			$rows = [];
169			foreach ($worksheet->getRowIterator() as $row) {
170			$cellIterator = $row->getCellIterator();
171			// $cellIterator->setIterateOnlyExistingCells(true);
172			$cells = [];
173			foreach ($cellIterator as $cell) {
174			$cells[] = $cell->getValue();
175			}
176			if (empty($cells)) {
177			break;
178			}
179			$rows[] = $cells;
180			}
181			return $this->getDataFromRows($rows);
182			}
183
184			/**
185			* @param array<array<mixed>> $rows
186			* @return array<int,array<mixed>>
187			*/
188			protected function getDataFromRows($rows)
189			{
190			$header = array_shift($rows);
191			$firstKey = $header[0];
192			if ($firstKey == 'key') {
193			$header[0] = 'key'; // Fix some weird stuff
194			}
195			$count = count($header);
196			$data = [];
197			foreach ($rows as $row) {
198			while (count($row) < $count) {
199			$row[] = '';
200			}
201			$row = array_slice($row, 0, $count);
202			$row = $this->normalizeRow($row);
203			$data[] = array_combine($header, $row);
204			}
205			return $data;
206			}
207
208			/**
209			* @return array<int,array<mixed>>
210			*/
211			protected function importFromCsv(string $file)
212			{
213			$arr = file($file);
214			if (!$arr) {
			0 ignored issues – show Bug Best Practice introduced 2024-01-29 12:49 UTC by Report Bug Copy Issue Report The expression `$arr` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
215			return [];
216			}
217			$rows = array_map('str_getcsv', $arr);
218			return $this->getDataFromRows($rows);
219			}
220
221			/**
222			* @param array<int,mixed> $row
223			* @return array<int,mixed>
224			*/
225			protected function normalizeRow($row)
226			{
227			foreach ($row as $idx => $value) {
228			if ($idx == 0 \|\| $value === null) {
229			continue;
230			}
231			if (strpos($value, '{"') === 0) {
232			$row[$idx] = json_decode($value, true);
233			}
234			}
235			return $row;
236			}
237
238			/**
239			* @param string $module
240			* @param boolean $excel
241			* @param array<string> $onlyLang
242			* @param bool $untranslated
243			* @param bool $translate
244			* @return void
245			*/
246			public function exportTranslations($module, $excel = true, $onlyLang = [], $untranslated = false, $translate = false)
247			{
248			$fullLangPath = $this->getLangPath($module);
249
250			$translationFiles = glob($fullLangPath . '/*.yml');
251			if ($translationFiles === false) {
252			$this->message("No yml");
253			return;
254			}
255
256			// Collect messages in all lang
257			$allMessages = [];
258			$headers = ['key'];
259			$default = [];
260			$defaultFile = null;
261			$defaultLang = substr(i18n::get_locale(), 0, 2);
262			foreach ($translationFiles as $translationFile) {
263			$lang = pathinfo($translationFile, PATHINFO_FILENAME);
264			if ($lang == $defaultLang) {
265			$defaultFile = $translationFile;
266			}
267			if (!empty($onlyLang) && !in_array($lang, $onlyLang)) {
268			continue;
269			}
270			$headers[] = $lang;
271			$default[] = '';
272			}
273
274
275			$masterMessages = [];
276			if ($untranslated) {
277			$reader = new YamlReader;
278			$masterMessages = $reader->read($defaultLang, $defaultFile);
279			}
280
281			$i = 0;
282			foreach ($translationFiles as $translationFile) {
283			$lang = pathinfo($translationFile, PATHINFO_FILENAME);
284			if (!empty($onlyLang) && !in_array($lang, $onlyLang)) {
285			continue;
286			}
287			$reader = new YamlReader;
288			$messages = $reader->read($lang, $translationFile);
289
290			foreach ($messages as $entityKey => $v) {
291			if ($untranslated) {
292			if (isset($masterMessages[$entityKey]) && $masterMessages[$entityKey] != $v) {
293			continue;
294			}
295			}
296
297			if (!isset($allMessages[$entityKey])) {
298			$allMessages[$entityKey] = $default;
299			}
300			// Plurals can be arrays and need to be converted
301			if (is_array($v)) {
302			$v = json_encode($v);
303			}
304
305			// Attempt auto translation / 200
306			if ($translate && count($allMessages) < 200) {
307			$v = EasyNmtHelper::translate($v, $lang, $defaultLang);
			0 ignored issues – show Bug introduced 2025-01-21 17:04 UTC by Report Bug Copy Issue Report The type `LeKoala\Multilingual\EasyNmtHelper` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
308			}
309
310			$allMessages[$entityKey][$i] = $v;
311			}
312			$i++;
313			}
314			// don't sort this will be mess up git when merging later
315			// ksort($allMessages);
316			if ($this->debug) {
317			Debug::show($allMessages);
318			}
319
320			// Write them to a file
321			if ($excel && class_exists(ExcelImportExport::class)) {
322			$ext = 'xlsx';
323			$destinationFilename = str_replace('/lang', '/lang.' . $ext, $fullLangPath);
324			if ($this->debug) {
325			Debug::show("Debug mode enabled : no output will be sent to $destinationFilename");
326			return;
327			}
328			if (is_file($destinationFilename)) {
329			unlink($destinationFilename);
330			}
331			// First row contains headers
332			$data = [$headers];
333			// Add a row per lang
334			foreach ($allMessages as $key => $translations) {
335			array_unshift($translations, $key);
336			$data[] = $translations;
337			}
338			ExcelImportExport::arrayToFile($data, $destinationFilename);
339			} else {
340			$ext = 'csv';
341			$destinationFilename = str_replace('/lang', '/lang.' . $ext, $fullLangPath);
342			if ($this->debug) {
343			Debug::show("Debug mode enabled : no output will be sent to $destinationFilename");
344			return;
345			}
346			if (is_file($destinationFilename)) {
347			unlink($destinationFilename);
348			}
349			$fp = fopen($destinationFilename, 'w');
350			if ($fp === false) {
351			throw new Exception("Failed to open stream");
352			}
353			// UTF 8 fix
354			fprintf($fp, "\xEF\xBB\xBF");
355			fputcsv($fp, $headers);
356			foreach ($allMessages as $key => $translations) {
357			array_unshift($translations, $key);
358			fputcsv($fp, $translations);
359			}
360			fclose($fp);
361			}
362
363			$this->message("Translations written to $destinationFilename");
364			}
365
366			public function isEnabled(): bool
367			{
368			return Director::isDev();
369			}
370			}
371

lekoala / silverstripe-multilingual

Push — master ( 04481a...738fe0 )

TranslationsImportExportTask::getDataFromRows() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like