LeKoala\Multilingual\TranslationsImportExportTask

Complexity

Total Complexity

52

Size/Duplication

Total Lines	311
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	isEnabled()	0	3	1
A	run()	0	33	5
A	importFromExcel()	0	18	4
A	normalizeRow()	0	11	4
A	getDataFromRows()	0	18	4
B	importTranslations()	0	53	10
F	exportTranslations()	0	93	21
A	getLangPath()	0	4	1
A	importFromCsv()	0	8	2

<?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;

The type PhpOffice\PhpSpreadsheet\IOFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use SilverStripe\Core\Injector\Injector;
use SilverStripe\i18n\Messages\YamlReader;
use LeKoala\ExcelImportExport\ExcelImportExport;

The type LeKoala\ExcelImportExport\ExcelImportExport was not found. Maybe you did not declare it correctly or list all dependencies?

use SilverStripe\Core\Manifest\ModuleResourceLoader;

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

The type LeKoala\Multilingual\BuildTaskTools was not found. Maybe you did not declare it correctly or list all dependencies?

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

The private property $segment is not used, and could be removed.

    /**
     * @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;

The property request does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $modules = $this->getModules();
        $this->addOption("import", "Import translations", false);
        $this->addOption("export", "Export translations", 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'];

        $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);
            }
        } 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);
        foreach ($langs as $lang) {
            $entities = [];
            foreach ($data as $row) {
                $key = trim($row['key']);
                if (!$key) {
                    continue;
                }
                $value = $row[$lang];
                if (is_string($value)) {
                    $value = trim($value);
                }
                $entities[$key] = $value;
            }
            if (!$this->debug) {
                $writer->write(
                    $entities,
                    $lang,
                    dirname($fullLangPath)
                );
                $this->message("Imported " . count($entities) . " 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) {

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.

            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) {
                continue;
            }
            if (strpos($value, '{"') === 0) {
                $row[$idx] = json_decode($value, true);
            }
        }
        return $row;
    }

    /**
     * @param string $module
     * @param boolean $excel
     * @param array<string> $onlyLang
     * @return void
     */
    public function exportTranslations($module, $excel = true, $onlyLang = [])
    {
        $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 = [];
        foreach ($translationFiles as $translationFile) {
            $lang = pathinfo($translationFile, PATHINFO_FILENAME);
            if (!empty($onlyLang) && !in_array($lang, $onlyLang)) {
                continue;
            }
            $headers[] = $lang;
            $default[] = '';
        }

        $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 (!isset($allMessages[$entityKey])) {
                    $allMessages[$entityKey] = $default;
                }
                // Plurals can be arrays and need to be converted
                if (is_array($v)) {
                    $v = json_encode($v);
                }
                $allMessages[$entityKey][$i] = $v;
            }
            $i++;
        }
        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();
    }
}