exportfilelist.php

<?php
namespace Bitrix\Translate\Controller\Export;
 
use Bitrix\Main;
use Bitrix\Main\Localization\Loc;
use Bitrix\Translate;
use Bitrix\Translate\Index;
 
class ExportFileList
    extends ExportAction
    implements Translate\Controller\ITimeLimit, Translate\Controller\IProcessParameters
{
    use Translate\Controller\Stepper;
    use Translate\Controller\ProcessParams;
 
    private int $seekPathLangId = 0;
 
    private string $seekLangFilePath = '';
    private string $seekPhraseCode = '';
 
    public function __construct($name, Main\Engine\Controller $controller, array $config = [])
    {
        $this->keepField('seekPathLangId', 'seekLangFilePath', 'seekPhraseCode');
 
        Loc::loadLanguageFile(__DIR__ . '/exportaction.php');
 
        parent::__construct($name, $controller, $config);
    }
 
 
    public function run(string $path = '', bool $runBefore = false): array
    {
        if (empty($path))
        {
            $path = Translate\Config::getDefaultPath();
        }
 
        // part of the path after /lang/
        $subPath = '';
        if (\preg_match("#(.+/lang)(/?\w*)#", $path, $matches))
        {
            if (\preg_match("#(.+/lang/[^/]+/?)(.*)$#", $path, $subMatches))
            {
                $subPath = $subMatches[2];
            }
            $path = $matches[1];
        }
        unset($matches, $subMatches);
 
 
        if ($runBefore)
        {
            $this->onBeforeRun();
        }
 
        if ($this->isNewProcess)
        {
            $this->totalItems = (int)Index\Internals\PathLangTable::getCount(['=%PATH' => $path.'%']);
            $this->processedItems = 0;
 
            if ($this->totalItems > 0)
            {
                $this->exportFileName = $this->generateExportFileName($path, $this->languages);
                $csvFile = $this->createExportTempFile($this->exportFileName);
                $this->exportFilePath = $csvFile->getPhysicalPath();
                $this->exportFileSize = $csvFile->getSize();
            }
            if ($this->appendSamples)
            {
                $this->samplesFileName = $this->generateExportFileName($path.'-samples', $this->languages);
                $sampleFile = $this->createExportTempFile($this->samplesFileName);
                $this->samplesFilePath = $sampleFile->getPhysicalPath();
                $this->samplesFileSize = $sampleFile->getSize();
            }
 
            $this->saveProgressParameters();
 
            return [
                'STATUS' => ($this->totalItems > 0 ? Translate\Controller\STATUS_PROGRESS : Translate\Controller\STATUS_COMPLETED),
                'PROCESSED_ITEMS' => 0,
                'TOTAL_ITEMS' => $this->totalItems,
                'TOTAL_PHRASES' => $this->exportedPhraseCount,
                'TOTAL_SAMPLES' => $this->exportedSamplesCount,
            ];
        }
 
        return $this->performStep('runExporting', ['path' => $path, 'subPath' => $subPath]);
    }
 
    private function runExporting(array $params): array
    {
        $path = \rtrim($params['path'], '/');
        $subPath = \trim($params['subPath'], '/');
 
        $csvFile = new Translate\IO\CsvFile($this->exportFilePath);
        $this->configureExportCsvFile($csvFile);
        $csvFile->openWrite( Main\IO\FileStreamOpenMode::APPEND);
 
        if ($this->appendSamples)
        {
            $samplesFile = new Translate\IO\CsvFile($this->samplesFilePath);
            $this->configureExportCsvFile($samplesFile);
            $samplesFile->openWrite( Main\IO\FileStreamOpenMode::APPEND);
        }
 
        $pathFilter = [];
        $pathFilter[] = [
            'LOGIC' => 'OR',
            '=PATH' => $path,
            '=%PATH' => $path.'/%',
        ];
        if (!empty($this->seekPathLangId))
        {
            $pathFilter['>ID'] = $this->seekPathLangId;
        }
 
        $currentLangId = Loc::getCurrentLang();
 
        $cachePathLangRes = Index\Internals\PathLangTable::getList([
            'filter' => $pathFilter,
            'order' => ['ID' => 'ASC'],
            'select' => ['ID', 'PATH'],
        ]);
        $processedItemCount = 0;
        while ($pathLang = $cachePathLangRes->fetch())
        {
            $lookThroughPath = $pathLang['PATH']. '/#LANG_ID#';
            if (!empty($subPath))
            {
                $lookThroughPath .= '/'. $subPath;
            }
            foreach ($this->lookThroughLangFolder($lookThroughPath) as $filePaths)
            {
                foreach ($filePaths as $langFilePath => $fullPaths)
                {
                    if (!empty($this->seekLangFilePath))
                    {
                        if ($langFilePath == $this->seekLangFilePath)
                        {
                            $this->seekLangFilePath = '';
                        }
                        else
                        {
                            continue;
                        }
                    }
 
                    $rows = $this->mergeLangFiles($langFilePath, $fullPaths, $this->collectUntranslated);
                    foreach ($rows as $code => $row)
                    {
                        if (!empty($this->seekPhraseCode))
                        {
                            if ($code == $this->seekPhraseCode)
                            {
                                $this->seekPhraseCode = '';
                            }
                            continue;
                        }
 
                        $csvFile->put(array_values($row));
 
                        if (
                            $this->appendSamples
                            && !empty($row[$currentLangId])
                            && mb_strlen($row[$currentLangId]) < $this->maxSampleSourceLength
                        )
                        {
                            $samples = $this->findSamples(
                                $row[$currentLangId],
                                $currentLangId,
                                $langFilePath,
                                $this->samplesCount,
                                $this->samplesRestriction
                            );
                            foreach ($samples as $sample)
                            {
                                $samplesFile->put(\array_values($sample));
                                $this->exportedSamplesCount ++;
                            }
                        }
 
                        $this->exportedPhraseCount ++;
 
                        if ($this->instanceTimer()->hasTimeLimitReached())
                        {
                            $this->seekPhraseCode = $code;
                        }
                        else
                        {
                            $this->seekPhraseCode = '';
                        }
                    }
 
                    if ($this->instanceTimer()->hasTimeLimitReached())
                    {
                        $this->seekLangFilePath = $langFilePath;
                        break;
                    }
                    else
                    {
                        $this->seekLangFilePath = '';
                    }
                }
            }
 
            $processedItemCount ++;
 
            if ($this->instanceTimer()->hasTimeLimitReached())
            {
                $this->seekPathLangId = (int)$pathLang['ID'];
                break;
            }
        }
 
        $this->exportFileSize = $csvFile->getSize();
        $csvFile->close();
 
        if ($this->appendSamples)
        {
            $this->samplesFileSize = $samplesFile->getSize();
            $samplesFile->close();
        }
 
        $this->processedItems += $processedItemCount;
 
        if ($this->instanceTimer()->hasTimeLimitReached() !== true)
        {
            $this->declareAccomplishment();
            $this->clearProgressParameters();
        }
 
        $result = [
            'PROCESSED_ITEMS' => $this->processedItems,
            'TOTAL_ITEMS' => $this->totalItems,
            'TOTAL_PHRASES' => $this->exportedPhraseCount,
            'TOTAL_SAMPLES' => $this->exportedSamplesCount,
        ];
 
        if ($csvFile->hasErrors())
        {
            $errors = $csvFile->getErrors();
            foreach ($errors as $err)
            {
                if ($err->getCode() == Translate\IO\CsvFile::ERROR_32K_FIELD_LENGTH)
                {
                    $result['WARNING'] = Loc::getMessage('TR_EXPORT_ERROR_32K_LENGTH');
                }
                else
                {
                    $this->addError($err);
                }
            }
        }
 
        return $result;
    }
}