Export.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Impexp;
 
use Doctrine\DBAL\Result;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Database\Query\QueryHelper;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\WorkspaceRestriction;
use ‪TYPO3\CMS\Core\Database\ReferenceIndex;
use ‪TYPO3\CMS\Core\Exception;
use ‪TYPO3\CMS\Core\Html\HtmlParser;
use ‪TYPO3\CMS\Core\Information\Typo3Version;
use ‪TYPO3\CMS\Core\Localization\DateFormatter;
use ‪TYPO3\CMS\Core\Localization\Locale;
use ‪TYPO3\CMS\Core\Localization\Locales;
use ‪TYPO3\CMS\Core\Resource\Exception\InsufficientFolderWritePermissionsException;
use ‪TYPO3\CMS\Core\Resource\File;
use ‪TYPO3\CMS\Core\Resource\Folder;
use ‪TYPO3\CMS\Core\Resource\ResourceFactory;
use ‪TYPO3\CMS\Core\Serializer\Typo3XmlParserOptions;
use ‪TYPO3\CMS\Core\Serializer\Typo3XmlSerializer;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
use ‪TYPO3\CMS\Impexp\View\ExportPageTreeView;
 
class ‪Export extends ‪ImportExport
{
    public const ‪LEVELS_RECORDS_ON_THIS_PAGE = -2;
    public const ‪LEVELS_EXPANDED_TREE = -1;
    public const ‪LEVELS_INFINITE = 999;
 
    public const ‪FILETYPE_XML = 'xml';
    public const ‪FILETYPE_T3D = 't3d';
    public const ‪FILETYPE_T3DZ = 't3d_compressed';
 
    protected ‪$mode = 'export';
 
    protected ‪$title = '';
 
    protected ‪$description = '';
 
    protected ‪$notes = '';
 
    protected ‪$record = [];
 
    protected ‪$list = [];
 
    protected ‪$levels = 0;
 
    protected ‪$tables = [];
 
    protected ‪$relOnlyTables = [];
 
    protected ‪$treeHTML = '';
 
    protected ‪$includeExtFileResources = true;
 
    protected ‪$extFileResourceExtensions = 'html,htm,css';
 
    protected ‪$recordTypesIncludeFields = [];
 
    protected ‪$defaultRecordIncludeFields = ['uid', 'pid'];
 
    protected ‪$saveFilesOutsideExportFile = false;
 
    protected ‪$exportFileName = '';
 
    protected ‪$exportFileType = ‪self::FILETYPE_XML;
 
    protected ‪$supportedFileTypes = [];
 
    protected ‪$compressionAvailable = false;
 
    protected ‪$pageInWebMountCache = [];
 
    public function ‪__construct()
    {
        parent::__construct();
        $this->compressionAvailable = function_exists('gzcompress');
    }
 
    /**************************
     * Export / Init + Meta Data
     *************************/
 
    public function ‪process(): void
    {
        $this->‪initializeExport();
        $this->‪setHeaderBasics();
        $this->‪setMetaData();
 
        // Configure which records to export
        foreach ($this->record as $ref) {
            $rParts = explode(':', $ref);
            $table = $rParts[0];
            ‪$record = BackendUtility::getRecord($rParts[0], (int)$rParts[1]);
            if (is_array(‪$record)) {
                $this->‪exportAddRecord($table, ‪$record);
            }
        }
 
        // Configure which tables to export
        foreach ($this->list as $ref) {
            $rParts = explode(':', $ref);
            $table = $rParts[0];
            ‪$pid = (int)$rParts[1];
            if ($this->‪getBackendUser()->check('tables_select', $table)) {
                $statement = $this->‪execListQueryPid(‪$pid, $table);
                while (‪$record = $statement->fetchAssociative()) {
                    if (is_array(‪$record)) {
                        $this->‪exportAddRecord($table, ‪$record);
                    }
                }
            }
        }
 
        // Configure which page tree to export
        if ($this->pid !== -1) {
            $pageTree = null;
            if ($this->levels === self::LEVELS_EXPANDED_TREE) {
                $pageTreeView = GeneralUtility::makeInstance(ExportPageTreeView::class);
                $initClause = $this->‪getExcludePagesClause();
                if ($this->excludeDisabledRecords) {
                    $initClause .= BackendUtility::BEenableFields('pages');
                }
                $pageTreeView->init($initClause);
                $pageTreeView->buildTreeByExpandedState($this->pid);
                $this->treeHTML = $pageTreeView->printTree();
                $pageTree = $pageTreeView->buffer_idH;
            } elseif ($this->levels === self::LEVELS_RECORDS_ON_THIS_PAGE) {
                $this->‪addRecordsForPid($this->pid, $this->tables);
            } else {
                $pageTreeView = GeneralUtility::makeInstance(ExportPageTreeView::class);
                $initClause = $this->‪getExcludePagesClause();
                if ($this->excludeDisabledRecords) {
                    $initClause .= BackendUtility::BEenableFields('pages');
                }
                $pageTreeView->init($initClause);
                $pageTreeView->buildTreeByLevels($this->pid, $this->levels);
                $this->treeHTML = $pageTreeView->printTree();
                $pageTree = $pageTreeView->buffer_idH;
            }
            // In most cases, we should have a multi-level array, $pageTree, with the page tree
            // structure here (and the HTML code loaded into memory for a nice display...)
            if (is_array($pageTree)) {
                $pageList = [];
                $this->‪removeExcludedPagesFromPageTree($pageTree);
                $this->‪setPageTree($pageTree);
                $this->‪flatInversePageTree($pageTree, $pageList);
                foreach ($pageList as $pageUid => $_) {
                    ‪$record = BackendUtility::getRecord('pages', $pageUid);
                    if (is_array(‪$record)) {
                        $this->‪exportAddRecord('pages', ‪$record);
                    }
                    $this->‪addRecordsForPid((int)$pageUid, $this->tables);
                }
            }
        }
 
        // After adding ALL records we add records from database relations
        for ($l = 0; $l < 10; $l++) {
            if ($this->‪exportAddRecordsFromRelations($l) === 0) {
                break;
            }
        }
 
        // Files must be added after the database relations are added,
        // so that files from ALL added records are included!
        $this->‪exportAddFilesFromRelations();
        $this->‪exportAddFilesFromSysFilesRecords();
    }
 
    protected function ‪initializeExport(): void
    {
        $this->dat = [
            'header' => [],
            'records' => [],
        ];
    }
 
    protected function ‪setHeaderBasics(): void
    {
        // Initializing:
        foreach ($this->softrefCfg as $key => $value) {
            if (!($value['mode'] ?? false)) {
                unset($this->softrefCfg[$key]);
            }
        }
        // Setting in header memory:
        // Version of file format
        $this->dat['header']['XMLversion'] = '1.0';
        // Initialize meta data array (to put it in top of file)
        $this->dat['header']['meta'] = [];
        // Add list of tables to consider static
        $this->dat['header']['relStaticTables'] = ‪$this->relStaticTables;
        // The list of excluded records
        $this->dat['header']['excludeMap'] = ‪$this->excludeMap;
        // Soft reference mode for elements
        $this->dat['header']['softrefCfg'] = ‪$this->softrefCfg;
        // List of extensions the import depends on.
        $this->dat['header']['extensionDependencies'] = ‪$this->extensionDependencies;
        $this->dat['header']['charset'] = 'utf-8';
    }
 
    protected function ‪setMetaData(): void
    {
        $user = $this->‪getBackendUser();
        if ($user->user['lang'] ?? false) {
            $locale = GeneralUtility::makeInstance(Locales::class)->createLocale($user->user['lang']);
        } else {
            $locale = new Locale();
        }
        $this->dat['header']['meta'] = [
            'title' => ‪$this->title,
            'description' => ‪$this->description,
            'notes' => ‪$this->notes,
            'packager_username' => $this->‪getBackendUser()->user['username'],
            'packager_name' => $this->‪getBackendUser()->user['realName'],
            'packager_email' => $this->‪getBackendUser()->user['email'],
            'TYPO3_version' => (string)GeneralUtility::makeInstance(Typo3Version::class),
            'created' => (new ‪DateFormatter())->format(‪$GLOBALS['EXEC_TIME'], 'EEE d. MMMM y', $locale),
        ];
    }
 
    /**************************
     * Export / Init Page tree
     *************************/
 
    public function ‪setPageTree(array $pageTree): void
    {
        $this->dat['header']['pagetree'] = $pageTree;
    }
 
    protected function ‪removeExcludedPagesFromPageTree(array &$pageTree): void
    {
        foreach ($pageTree as ‪$pid => $value) {
            if ($this->‪isRecordExcluded('pages', (int)($pageTree[‪$pid]['uid'] ?? 0))) {
                unset($pageTree[‪$pid]);
            } elseif (is_array($pageTree[‪$pid]['subrow'] ?? null)) {
                $this->‪removeExcludedPagesFromPageTree($pageTree[‪$pid]['subrow']);
            }
        }
    }
 
    /**************************
     * Export
     *************************/
 
    public function ‪setRecordTypesIncludeFields(array ‪$recordTypesIncludeFields): void
    {
        foreach (‪$recordTypesIncludeFields as $table => ‪$fields) {
            if (!is_array(‪$fields)) {
                throw new Exception('The include fields for record type ' . htmlspecialchars($table) . ' are not defined by an array.', 1391440658);
            }
            $this->‪setRecordTypeIncludeFields($table, ‪$fields);
        }
    }
 
    protected function ‪setRecordTypeIncludeFields(string $table, array ‪$fields): void
    {
        $this->recordTypesIncludeFields[$table] = ‪$fields;
    }
 
    protected function ‪getExcludePagesClause(): string
    {
        $pageIds = [];
 
        foreach ($this->excludeMap as $tableAndUid => $isExcluded) {
            [$table, ‪$uid] = explode(':', $tableAndUid);
            if ($table === 'pages') {
                $pageIds[] = (int)‪$uid;
            }
        }
        if (!empty($pageIds)) {
            return ' AND uid NOT IN (' . implode(',', $pageIds) . ')';
        }
        return '';
    }
 
    protected function ‪addRecordsForPid(int ‪$pid, array ‪$tables): void
    {
        foreach (‪$GLOBALS['TCA'] as $table => $value) {
            if ($table !== 'pages'
                && (in_array($table, ‪$tables, true) || in_array('_ALL', ‪$tables, true))
                && $this->‪getBackendUser()->check('tables_select', $table)
                && !(‪$GLOBALS['TCA'][$table]['ctrl']['is_static'] ?? false)
            ) {
                $statement = $this->‪execListQueryPid($pid, $table);
                while (‪$record = $statement->fetchAssociative()) {
                    if (is_array(‪$record)) {
                        $this->‪exportAddRecord($table, ‪$record);
                    }
                }
            }
        }
    }
 
    protected function ‪execListQueryPid(int ‪$pid, string $table): Result
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($table);
 
        $orderBy = ‪$GLOBALS['TCA'][$table]['ctrl']['sortby'] ?? ‪$GLOBALS['TCA'][$table]['ctrl']['default_sortby'] ?? '';
 
        if ($this->excludeDisabledRecords === false) {
            $queryBuilder->getRestrictions()
                ->removeAll()
                ->add(GeneralUtility::makeInstance(DeletedRestriction::class))
                ->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, 0));
        } else {
            $queryBuilder->getRestrictions()
                ->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, 0));
        }
 
        $queryBuilder->select('*')
            ->from($table)
            ->where(
                $queryBuilder->expr()->eq(
                    'pid',
                    $queryBuilder->createNamedParameter(‪$pid, ‪Connection::PARAM_INT)
                )
            );
 
        $orderBys = ‪QueryHelper::parseOrderBy((string)$orderBy);
        foreach ($orderBys as $orderPair) {
            [$field, $order] = $orderPair;
            $queryBuilder->addOrderBy($field, $order);
        }
        // Ensure deterministic sorting
        if (!in_array('uid', array_column($orderBys, 0))) {
            $queryBuilder->addOrderBy('uid', 'ASC');
        }
 
        return $queryBuilder->executeQuery();
    }
 
    public function ‪exportAddRecord(string $table, array $row, int $relationLevel = 0): void
    {
        BackendUtility::workspaceOL($table, $row);
 
        if ($table === '' || (int)$row['uid'] === 0
            || $this->‪isRecordExcluded($table, (int)$row['uid'])
            || $this->excludeDisabledRecords && $this->‪isRecordDisabled($table, (int)$row['uid'])) {
            return;
        }
 
        if ($this->‪isPageInWebMount($table === 'pages' ? (int)$row['uid'] : (int)$row['pid'])) {
            if (!isset($this->dat['records'][$table . ':' . $row['uid']])) {
                // Prepare header info:
                $row = $this->‪filterRecordFields($table, $row);
                $headerInfo = [];
                $headerInfo['uid'] = $row['uid'];
                $headerInfo['pid'] = $row['pid'];
                $headerInfo['title'] = ‪GeneralUtility::fixed_lgd_cs(BackendUtility::getRecordTitle($table, $row), 40);
                if ($relationLevel) {
                    $headerInfo['relationLevel'] = $relationLevel;
                }
                // Set the header summary:
                $this->dat['header']['records'][$table][$row['uid']] = $headerInfo;
                // Create entry in the PID lookup:
                $this->dat['header']['pid_lookup'][$row['pid']][$table][$row['uid']] = 1;
                // Initialize reference index object:
                $refIndexObj = GeneralUtility::makeInstance(ReferenceIndex::class);
                $relations = $refIndexObj->getRelations($table, $row);
                $this->‪fixFileIdInRelations($relations);
                $this->‪removeRedundantSoftRefsInRelations($relations);
                // Data:
                $this->dat['records'][$table . ':' . $row['uid']] = [];
                $this->dat['records'][$table . ':' . $row['uid']]['data'] = $row;
                $this->dat['records'][$table . ':' . $row['uid']]['rels'] = $relations;
                // Add information about the relations in the record in the header:
                $this->dat['header']['records'][$table][$row['uid']]['rels'] = $this->‪flatDbRelations($this->dat['records'][$table . ':' . $row['uid']]['rels']);
                // Add information about the softrefs to header:
                $this->dat['header']['records'][$table][$row['uid']]['softrefs'] = $this->‪flatSoftRefs($this->dat['records'][$table . ':' . $row['uid']]['rels']);
            } else {
                $this->‪addError('Record ' . $table . ':' . $row['uid'] . ' already added.');
            }
        } else {
            $this->‪addError('Record ' . $table . ':' . $row['uid'] . ' was outside your database mounts!');
        }
    }
 
    protected function ‪isPageInWebMount(int ‪$pid): bool
    {
        if (!isset($this->pageInWebMountCache[‪$pid])) {
            $this->pageInWebMountCache[‪$pid] = (bool)$this->‪getBackendUser()->isInWebMount($pid);
        }
        return $this->pageInWebMountCache[‪$pid];
    }
 
    protected function ‪filterRecordFields(string $table, array $row): array
    {
        if (isset($this->recordTypesIncludeFields[$table])) {
            $includeFields = array_unique(array_merge(
                $this->recordTypesIncludeFields[$table],
                $this->defaultRecordIncludeFields
            ));
            $newRow = [];
            foreach ($row as $key => $value) {
                if (in_array($key, $includeFields, true)) {
                    $newRow[$key] = $value;
                }
            }
        } else {
            $newRow = $row;
        }
        return $newRow;
    }
 
    public function ‪fixFileIdInRelations(array &$relations): void
    {
        // @todo: Remove by-reference and return final array
        foreach ($relations as &$relation) {
            if (isset($relation['type']) && $relation['type'] === 'file') {
                foreach ($relation['newValueFiles'] as &$fileRelationData) {
                    $absoluteFilePath = (string)$fileRelationData['ID_absFile'];
                    if (str_starts_with($absoluteFilePath, ‪Environment::getPublicPath())) {
                        $relatedFilePath = ‪PathUtility::stripPathSitePrefix($absoluteFilePath);
                        $fileRelationData['ID'] = md5($relatedFilePath);
                    }
                }
                unset($fileRelationData);
            }
            if (isset($relation['type']) && $relation['type'] === 'flex') {
                if (is_array($relation['flexFormRels']['file'] ?? null)) {
                    foreach ($relation['flexFormRels']['file'] as &$subList) {
                        foreach ($subList as &$fileRelationData) {
                            $absoluteFilePath = (string)$fileRelationData['ID_absFile'];
                            if (str_starts_with($absoluteFilePath, ‪Environment::getPublicPath())) {
                                $relatedFilePath = ‪PathUtility::stripPathSitePrefix($absoluteFilePath);
                                $fileRelationData['ID'] = md5($relatedFilePath);
                            }
                        }
                    }
                }
            }
        }
    }
 
    public function ‪removeRedundantSoftRefsInRelations(array &$relations): void
    {
        // @todo: Remove by-reference and return final array
        foreach ($relations as &$relation) {
            if (isset($relation['type']) && $relation['type'] === 'db') {
                foreach ($relation['itemArray'] as $dbRelationData) {
                    if ($dbRelationData['table'] === 'sys_file') {
                        if (isset($relation['softrefs']['keys']['typolink'])) {
                            foreach ($relation['softrefs']['keys']['typolink'] as $tokenID => &$softref) {
                                if ($softref['subst']['type'] === 'file') {
                                    $file = GeneralUtility::makeInstance(ResourceFactory::class)->retrieveFileOrFolderObject($softref['subst']['relFileName']);
                                    if ($file instanceof File) {
                                        if ($file->getUid() == $dbRelationData['id']) {
                                            unset($relation['softrefs']['keys']['typolink'][$tokenID]);
                                        }
                                    }
                                }
                            }
                            if (empty($relation['softrefs']['keys']['typolink'])) {
                                unset($relation['softrefs']);
                            }
                        }
                    }
                }
            }
        }
    }
 
    protected function ‪flatDbRelations(array $relations): array
    {
        ‪$list = [];
        foreach ($relations as $relation) {
            if (isset($relation['type'])) {
                if ($relation['type'] === 'db') {
                    foreach ($relation['itemArray'] as $dbRelationData) {
                        ‪$list[$dbRelationData['table'] . ':' . $dbRelationData['id']] = $dbRelationData;
                    }
                } elseif ($relation['type'] === 'flex' && is_array($relation['flexFormRels']['db'] ?? null)) {
                    foreach ($relation['flexFormRels']['db'] as $subList) {
                        foreach ($subList as $dbRelationData) {
                            ‪$list[$dbRelationData['table'] . ':' . $dbRelationData['id']] = $dbRelationData;
                        }
                    }
                }
            }
        }
        return ‪$list;
    }
 
    protected function ‪flatSoftRefs(array $relations): array
    {
        ‪$list = [];
        foreach ($relations as $field => $relation) {
            if (is_array($relation['softrefs']['keys'] ?? null)) {
                foreach ($relation['softrefs']['keys'] as $spKey => $elements) {
                    foreach ($elements as $subKey => $el) {
                        $lKey = $field . ':' . $spKey . ':' . $subKey;
                        ‪$list[$lKey] = array_merge(['field' => $field, 'spKey' => $spKey], $el);
                        // Add file_ID key to header - slightly "risky" way of doing this because if the calculation
                        // changes for the same value in $this->records[...] this will not work anymore!
                        if ($el['subst']['relFileName'] ?? false) {
                            ‪$list[$lKey]['file_ID'] = md5(‪Environment::getPublicPath() . '/' . $el['subst']['relFileName']);
                        }
                    }
                }
            }
            if (isset($relation['type'])) {
                if ($relation['type'] === 'flex' && is_array($relation['flexFormRels']['softrefs'] ?? null)) {
                    foreach ($relation['flexFormRels']['softrefs'] as $structurePath => &$subList) {
                        if (isset($subList['keys'])) {
                            foreach ($subList['keys'] as $spKey => $elements) {
                                foreach ($elements as $subKey => $el) {
                                    $lKey = $field . ':' . $structurePath . ':' . $spKey . ':' . $subKey;
                                    ‪$list[$lKey] = array_merge([
                                        'field' => $field,
                                        'spKey' => $spKey,
                                        'structurePath' => $structurePath,
                                    ], $el);
                                    // Add file_ID key to header - slightly "risky" way of doing this because if the calculation
                                    // changes for the same value in $this->records[...] this will not work anymore!
                                    if ($el['subst']['relFileName'] ?? false) {
                                        ‪$list[$lKey]['file_ID'] = md5(‪Environment::getPublicPath() . '/' . $el['subst']['relFileName']);
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
        return ‪$list;
    }
 
    protected function ‪exportAddRecordsFromRelations(int $relationLevel = 0): int
    {
        if (!isset($this->dat['records'])) {
            $this->‪addError('There were no records available.');
            return 0;
        }
 
        $addRecords = [];
 
        foreach ($this->dat['records'] as ‪$record) {
            if (!is_array(‪$record)) {
                continue;
            }
            foreach (‪$record['rels'] as $relation) {
                if (isset($relation['type'])) {
                    if ($relation['type'] === 'db') {
                        foreach ($relation['itemArray'] as $dbRelationData) {
                            $this->‪exportAddRecordsFromRelationsPushRelation($dbRelationData, $addRecords);
                        }
                    }
                    if ($relation['type'] === 'flex') {
                        // Database relations in flex form fields:
                        if (is_array($relation['flexFormRels']['db'] ?? null)) {
                            foreach ($relation['flexFormRels']['db'] as $subList) {
                                foreach ($subList as $dbRelationData) {
                                    $this->‪exportAddRecordsFromRelationsPushRelation($dbRelationData, $addRecords);
                                }
                            }
                        }
 
                        // Database oriented soft references in flex form fields:
                        if (is_array($relation['flexFormRels']['softrefs'] ?? null)) {
                            foreach ($relation['flexFormRels']['softrefs'] as $subList) {
                                foreach ($subList['keys'] as $elements) {
                                    foreach ($elements as $el) {
                                        if ($el['subst']['type'] === 'db' && $this->‪isSoftRefIncluded($el['subst']['tokenID'])) {
                                            [$referencedTable, $referencedUid] = explode(':', $el['subst']['recordRef']);
                                            $dbRelationData = [
                                                'table' => $referencedTable,
                                                'id' => $referencedUid,
                                            ];
                                            $this->‪exportAddRecordsFromRelationsPushRelation($dbRelationData, $addRecords, $el['subst']['tokenID']);
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
                // In any case, if there are soft refs:
                if (is_array($relation['softrefs']['keys'] ?? null)) {
                    foreach ($relation['softrefs']['keys'] as $elements) {
                        foreach ($elements as $el) {
                            if (($el['subst']['type'] ?? '') === 'db' && $this->‪isSoftRefIncluded($el['subst']['tokenID'])) {
                                [$referencedTable, $referencedUid] = explode(':', $el['subst']['recordRef']);
                                $dbRelationData = [
                                    'table' => $referencedTable,
                                    'id' => $referencedUid,
                                ];
                                $this->‪exportAddRecordsFromRelationsPushRelation($dbRelationData, $addRecords, $el['subst']['tokenID']);
                            }
                        }
                    }
                }
            }
        }
 
        if (!empty($addRecords)) {
            foreach ($addRecords as $recordData) {
                ‪$record = BackendUtility::getRecord($recordData['table'], $recordData['id']);
 
                if (is_array(‪$record)) {
                    // Depending on db driver, int fields may or may not be returned as integer or as string. The
                    // loop aligns that detail and forces strings for everything to have exports more db agnostic.
                    foreach (‪$record as $fieldName => $fieldValue) {
                        ‪$record[$fieldName] = $fieldValue === null ? $fieldValue : (string)$fieldValue;
                    }
                    $this->‪exportAddRecord($recordData['table'], ‪$record, $relationLevel + 1);
                }
                // Set status message
                // Relation pointers always larger than zero except certain "select" types with
                // negative values pointing to uids - but that is not supported here.
                if ($recordData['id'] > 0) {
                    $recordRef = $recordData['table'] . ':' . $recordData['id'];
                    if (!isset($this->dat['records'][$recordRef])) {
                        $this->dat['records'][$recordRef] = 'NOT_FOUND';
                        $this->‪addError('Relation record ' . $recordRef . ' was not found!');
                    }
                }
            }
        }
 
        return count($addRecords);
    }
 
    protected function ‪exportAddRecordsFromRelationsPushRelation(array $recordData, array &$addRecords, string $tokenID = ''): void
    {
        // @todo: Remove by-reference and return final array
        $recordRef = $recordData['table'] . ':' . $recordData['id'];
        if (
            isset(‪$GLOBALS['TCA'][$recordData['table']]) && !$this->‪isTableStatic($recordData['table'])
            && !$this->‪isRecordExcluded($recordData['table'], (int)$recordData['id'])
            && (!$tokenID || $this->‪isSoftRefIncluded($tokenID)) && $this->‪inclRelation($recordData['table'])
            && !isset($this->dat['records'][$recordRef])
        ) {
            $addRecords[$recordRef] = $recordData;
        }
    }
 
    protected function ‪inclRelation(string $table): bool
    {
        return is_array(‪$GLOBALS['TCA'][$table] ?? null)
            && (in_array($table, $this->relOnlyTables, true) || in_array('_ALL', $this->relOnlyTables, true))
            && $this->‪getBackendUser()->check('tables_select', $table);
    }
 
    protected function ‪exportAddFilesFromRelations(): void
    {
        // @todo: Consider NOT using by-reference but writing final $this->dat at end of method.
        if (!isset($this->dat['records'])) {
            $this->‪addError('There were no records available.');
            return;
        }
 
        foreach ($this->dat['records'] as $recordRef => &‪$record) {
            if (!is_array(‪$record)) {
                continue;
            }
            foreach (‪$record['rels'] as $field => &$relation) {
                // For all file type relations:
                if (isset($relation['type']) && $relation['type'] === 'file') {
                    foreach ($relation['newValueFiles'] as &$fileRelationData) {
                        $this->‪exportAddFile($fileRelationData, $recordRef, $field);
                        // Remove the absolute reference to the file so it doesn't expose absolute paths from source server:
                        unset($fileRelationData['ID_absFile']);
                    }
                    unset($fileRelationData);
                }
                // For all flex type relations:
                if (isset($relation['type']) && $relation['type'] === 'flex') {
                    if (isset($relation['flexFormRels']['file'])) {
                        foreach ($relation['flexFormRels']['file'] as &$subList) {
                            foreach ($subList as $subKey => &$fileRelationData) {
                                $this->‪exportAddFile($fileRelationData, $recordRef, $field);
                                // Remove the absolute reference to the file so it doesn't expose absolute paths from source server:
                                unset($fileRelationData['ID_absFile']);
                            }
                        }
                        unset($subList, $fileRelationData);
                    }
                    // Database oriented soft references in flex form fields:
                    if (isset($relation['flexFormRels']['softrefs'])) {
                        foreach ($relation['flexFormRels']['softrefs'] as &$subList) {
                            foreach ($subList['keys'] as &$elements) {
                                foreach ($elements as &$el) {
                                    if ($el['subst']['type'] === 'file' && $this->‪isSoftRefIncluded($el['subst']['tokenID'])) {
                                        // Create abs path and ID for file:
                                        $ID_absFile = GeneralUtility::getFileAbsFileName(‪Environment::getPublicPath() . '/' . $el['subst']['relFileName']);
                                        $ID = md5($el['subst']['relFileName']);
                                        if ($ID_absFile) {
                                            if (!$this->dat['files'][$ID]) {
                                                $fileRelationData = [
                                                    'filename' => ‪PathUtility::basename($ID_absFile),
                                                    'ID_absFile' => $ID_absFile,
                                                    'ID' => $ID,
                                                    'relFileName' => $el['subst']['relFileName'],
                                                ];
                                                $this->‪exportAddFile($fileRelationData, '_SOFTREF_');
                                            }
                                            $el['file_ID'] = $ID;
                                        }
                                    }
                                }
                            }
                        }
                        unset($subList, $elements, $el);
                    }
                }
                // In any case, if there are soft refs:
                if (is_array($relation['softrefs']['keys'] ?? null)) {
                    foreach ($relation['softrefs']['keys'] as &$elements) {
                        foreach ($elements as &$el) {
                            if (($el['subst']['type'] ?? '') === 'file' && $this->‪isSoftRefIncluded($el['subst']['tokenID'])) {
                                // Create abs path and ID for file:
                                $ID_absFile = GeneralUtility::getFileAbsFileName(‪Environment::getPublicPath() . '/' . $el['subst']['relFileName']);
                                $ID = md5($el['subst']['relFileName']);
                                if ($ID_absFile) {
                                    if (!$this->dat['files'][$ID]) {
                                        $fileRelationData = [
                                            'filename' => ‪PathUtility::basename($ID_absFile),
                                            'ID_absFile' => $ID_absFile,
                                            'ID' => $ID,
                                            'relFileName' => $el['subst']['relFileName'],
                                        ];
                                        $this->‪exportAddFile($fileRelationData, '_SOFTREF_');
                                    }
                                    $el['file_ID'] = $ID;
                                }
                            }
                        }
                    }
                }
            }
        }
    }
 
    protected function ‪exportAddFile(array $fileData, string $recordRef = '', string $field = ''): void
    {
        if (!@is_file($fileData['ID_absFile'])) {
            $this->‪addError($fileData['ID_absFile'] . ' was not a file! Skipping.');
            return;
        }
 
        $fileStat = stat($fileData['ID_absFile']);
        $fileMd5 = md5_file($fileData['ID_absFile']);
        $pathInfo = pathinfo(‪PathUtility::basename($fileData['ID_absFile']));
 
        $fileInfo = [];
        $fileInfo['filename'] = ‪PathUtility::basename($fileData['ID_absFile']);
        $fileInfo['filemtime'] = $fileStat['mtime'];
        $fileInfo['relFileRef'] = ‪PathUtility::stripPathSitePrefix($fileData['ID_absFile']);
        if ($recordRef) {
            $fileInfo['record_ref'] = $recordRef . '/' . $field;
        }
        if ($fileData['relFileName']) {
            $fileInfo['relFileName'] = $fileData['relFileName'];
        }
 
        // Setting this data in the header
        $this->dat['header']['files'][$fileData['ID']] = $fileInfo;
 
        if (!$this->saveFilesOutsideExportFile) {
            $fileInfo['content'] = (string)file_get_contents($fileData['ID_absFile']);
        } else {
            GeneralUtility::upload_copy_move(
                $fileData['ID_absFile'],
                $this->‪getOrCreateTemporaryFolderName() . '/' . $fileMd5
            );
        }
        $fileInfo['content_md5'] = $fileMd5;
        $this->dat['files'][$fileData['ID']] = $fileInfo;
 
        // ... and for the recordlisting, why not let us know WHICH relations there was...
        if ($recordRef !== '' && $recordRef !== '_SOFTREF_') {
            [$referencedTable, $referencedUid] = explode(':', $recordRef, 2);
            if (!is_array($this->dat['header']['records'][$referencedTable][$referencedUid]['filerefs'] ?? null)) {
                $this->dat['header']['records'][$referencedTable][$referencedUid]['filerefs'] = [];
            }
            $this->dat['header']['records'][$referencedTable][$referencedUid]['filerefs'][] = $fileData['ID'];
        }
 
        // For soft references, do further processing:
        if ($recordRef === '_SOFTREF_') {
            // Files with external media?
            // This is only done with files grabbed by a soft reference parser since it is deemed improbable
            // that hard-referenced files should undergo this treatment.
            if ($this->includeExtFileResources
                && ‪GeneralUtility::inList($this->extFileResourceExtensions, strtolower($pathInfo['extension']))
            ) {
                $uniqueDelimiter = '###' . md5(‪$GLOBALS['EXEC_TIME']) . '###';
                if (strtolower($pathInfo['extension']) === 'css') {
                    $fileContentParts = explode(
                        $uniqueDelimiter,
                        (string)preg_replace(
                            '/(url[[:space:]]*\\([[:space:]]*["\']?)([^"\')]*)(["\']?[[:space:]]*\\))/i',
                            '\\1' . $uniqueDelimiter . '\\2' . $uniqueDelimiter . '\\3',
                            $fileInfo['content']
                        )
                    );
                } else {
                    // html, htm:
                    $htmlParser = GeneralUtility::makeInstance(HtmlParser::class);
                    $fileContentParts = explode(
                        $uniqueDelimiter,
                        $htmlParser->prefixResourcePath(
                            $uniqueDelimiter,
                            $fileInfo['content'],
                            [],
                            $uniqueDelimiter
                        )
                    );
                }
                $resourceCaptured = false;
                // @todo: drop this by-reference handling
                foreach ($fileContentParts as $index => &$fileContentPart) {
                    if ($index % 2) {
                        $resRelativePath = &$fileContentPart;
                        $resAbsolutePath = GeneralUtility::resolveBackPath(‪PathUtility::dirname($fileData['ID_absFile']) . '/' . $resRelativePath);
                        $resAbsolutePath = GeneralUtility::getFileAbsFileName($resAbsolutePath);
                        if ($resAbsolutePath !== ''
                            && str_starts_with($resAbsolutePath, ‪Environment::getPublicPath() . '/' . $this->‪getFileadminFolderName() . '/')
                            && @is_file($resAbsolutePath)
                        ) {
                            $resourceCaptured = true;
                            $resourceId = md5($resAbsolutePath);
                            $this->dat['header']['files'][$fileData['ID']]['EXT_RES_ID'][] = $resourceId;
                            $fileContentParts[$index] = '{EXT_RES_ID:' . $resourceId . '}';
                            // Add file to memory if it is not set already:
                            if (!isset($this->dat['header']['files'][$resourceId])) {
                                $fileStat = stat($resAbsolutePath);
                                $fileInfo = [];
                                $fileInfo['filename'] = ‪PathUtility::basename($resAbsolutePath);
                                $fileInfo['filemtime'] = $fileStat['mtime'];
                                $fileInfo['record_ref'] = '_EXT_PARENT_:' . $fileData['ID'];
                                $fileInfo['parentRelFileName'] = $resRelativePath;
                                // Setting this data in the header
                                $this->dat['header']['files'][$resourceId] = $fileInfo;
                                $fileInfo['content'] = (string)file_get_contents($resAbsolutePath);
                                $fileInfo['content_md5'] = md5($fileInfo['content']);
                                $this->dat['files'][$resourceId] = $fileInfo;
                            }
                        }
                    }
                }
                if ($resourceCaptured) {
                    $this->dat['files'][$fileData['ID']]['tokenizedContent'] = implode('', $fileContentParts);
                }
            }
        }
    }
 
    protected function ‪exportAddFilesFromSysFilesRecords(): void
    {
        if (!isset($this->dat['header']['records']['sys_file']) || !is_array($this->dat['header']['records']['sys_file'] ?? null)) {
            return;
        }
        foreach ($this->dat['header']['records']['sys_file'] as $sysFileUid => $_) {
            $fileData = $this->dat['records']['sys_file:' . $sysFileUid]['data'];
            $this->‪exportAddSysFile($fileData);
        }
    }
 
    protected function ‪exportAddSysFile(array $fileData): void
    {
        try {
            $file = GeneralUtility::makeInstance(ResourceFactory::class)->createFileObject($fileData);
            $file->checkActionPermission('read');
        } catch (\Exception $e) {
            $this->‪addError('Error when trying to add file ' . $fileData['title'] . ': ' . $e->getMessage());
            return;
        }
 
        $fileUid = $file->getUid();
        $fileSha1 = $file->getStorage()->hashFile($file, 'sha1');
        if ($fileSha1 !== $file->getProperty('sha1')) {
            $this->dat['records']['sys_file:' . $fileUid]['data']['sha1'] = $fileSha1;
            $this->‪addError(
                'The SHA-1 file hash of ' . $file->getCombinedIdentifier() . ' is not up-to-date in the index! ' .
                'The file was added based on the current file hash.'
            );
        }
        // Build unique id based on the storage and the file identifier
        $fileId = md5($file->getStorage()->getUid() . ':' . $file->getProperty('identifier_hash'));
 
        $fileInfo = [];
        $fileInfo['filename'] = $file->getProperty('name');
        $fileInfo['filemtime'] = $file->getProperty('modification_date');
 
        // Setting this data in the header
        $this->dat['header']['files_fal'][$fileId] = $fileInfo;
 
        if (!$this->saveFilesOutsideExportFile) {
            $fileInfo['content'] = $file->getContents();
        } else {
            GeneralUtility::upload_copy_move(
                $file->getForLocalProcessing(false),
                $this->getOrCreateTemporaryFolderName() . '/' . $fileSha1
            );
        }
        $fileInfo['content_sha1'] = $fileSha1;
        $this->dat['files_fal'][$fileId] = $fileInfo;
    }
 
    /**************************
     * File Output
     *************************/
 
    public function ‪render(): string
    {
        if ($this->exportFileType === self::FILETYPE_XML) {
            $out = $this->‪createXML();
        } else {
            $out = '';
            // adding header:
            $out .= $this->‪addFilePart(serialize($this->dat['header']));
            // adding records:
            $out .= $this->‪addFilePart(serialize($this->dat['records']));
            // adding files:
            $out .= $this->‪addFilePart(serialize($this->dat['files'] ?? null));
            // adding files_fal:
            $out .= $this->‪addFilePart(serialize($this->dat['files_fal'] ?? null));
        }
        return $out;
    }
 
    protected function ‪createXML(): string
    {
        // Options:
        $options = [
            'alt_options' => [
                '/header' => [
                    'disableTypeAttrib' => true,
                    'clearStackPath' => true,
                    'parentTagMap' => [
                        'files' => 'file',
                        'files_fal' => 'file',
                        'records' => 'table',
                        'table' => 'rec',
                        'rec:rels' => 'relations',
                        'relations' => 'element',
                        'filerefs' => 'file',
                        'pid_lookup' => 'page_contents',
                        'header:relStaticTables' => 'static_tables',
                        'static_tables' => 'tablename',
                        'excludeMap' => 'item',
                        'softrefCfg' => 'softrefExportMode',
                        'extensionDependencies' => 'extkey',
                        'softrefs' => 'softref_element',
                    ],
                    'alt_options' => [
                        '/pagetree' => [
                            'disableTypeAttrib' => true,
                            'useIndexTagForNum' => 'node',
                            'parentTagMap' => [
                                'node:subrow' => 'node',
                            ],
                        ],
                        '/pid_lookup/page_contents' => [
                            'disableTypeAttrib' => true,
                            'parentTagMap' => [
                                'page_contents' => 'table',
                            ],
                            'grandParentTagMap' => [
                                'page_contents/table' => 'item',
                            ],
                        ],
                    ],
                ],
                '/records' => [
                    'disableTypeAttrib' => true,
                    'parentTagMap' => [
                        'records' => 'tablerow',
                        'tablerow:data' => 'fieldlist',
                        'tablerow:rels' => 'related',
                        'related' => 'field',
                        'field:itemArray' => 'relations',
                        'field:newValueFiles' => 'filerefs',
                        'field:flexFormRels' => 'flexform',
                        'relations' => 'element',
                        'filerefs' => 'file',
                        'flexform:db' => 'db_relations',
                        'flexform:softrefs' => 'softref_relations',
                        'softref_relations' => 'structurePath',
                        'db_relations' => 'path',
                        'path' => 'element',
                        'keys' => 'softref_key',
                        'softref_key' => 'softref_element',
                    ],
                    'alt_options' => [
                        '/records/tablerow/fieldlist' => [
                            'useIndexTagForAssoc' => 'field',
                        ],
                    ],
                ],
                '/files' => [
                    'disableTypeAttrib' => true,
                    'parentTagMap' => [
                        'files' => 'file',
                    ],
                ],
                '/files_fal' => [
                    'disableTypeAttrib' => true,
                    'parentTagMap' => [
                        'files_fal' => 'file',
                    ],
                ],
            ],
        ];
        // Creating XML file from $outputArray:
        $charset = $this->dat['header']['charset'] ?: 'utf-8';
        $XML = '<?xml version="1.0" encoding="' . $charset . '" standalone="yes" ?>' . LF;
        $XML .= (new ‪Typo3XmlSerializer())->encodeWithReturningExceptionAsString(
            $this->dat,
            new ‪Typo3XmlParserOptions([‪Typo3XmlParserOptions::ROOT_NODE_NAME => 'T3RecordDocument']),
            $options
        );
        return $XML;
    }
 
    protected function ‪addFilePart(string $data): string
    {
        $compress = $this->exportFileType === ‪self::FILETYPE_T3DZ;
        if ($compress) {
            $data = (string)gzcompress($data);
        }
        return md5($data) . ':' . ($compress ? '1' : '0') . ':' . str_pad((string)strlen($data), 10, '0', STR_PAD_LEFT) . ':' . $data . ':';
    }
 
    public function ‪saveToFile(): File
    {
        $saveFolder = $this->‪getOrCreateDefaultImportExportFolder();
        $fileName = $this->‪getOrGenerateExportFileNameWithFileExtension();
        $filesFolderName = $fileName . '.files';
        $fileContent = $this->‪render();
 
        if (!($saveFolder instanceof Folder && $saveFolder->checkActionPermission('write'))) {
            throw new InsufficientFolderWritePermissionsException(
                'You are not allowed to write to the target folder "' . $saveFolder->getPublicUrl() . '"',
                1602432207
            );
        }
 
        if ($saveFolder->hasFolder($filesFolderName)) {
            $saveFolder->getSubfolder($filesFolderName)->delete(true);
        }
 
        $temporaryFileName = GeneralUtility::tempnam('export');
        ‪GeneralUtility::writeFile($temporaryFileName, $fileContent);
        $file = $saveFolder->addFile($temporaryFileName, $fileName, 'replace');
 
        if ($this->saveFilesOutsideExportFile) {
            $filesFolder = $saveFolder->createFolder($filesFolderName);
            $temporaryFilesForExport = GeneralUtility::getFilesInDir($this->‪getOrCreateTemporaryFolderName(), '', true);
            foreach ($temporaryFilesForExport as $temporaryFileForExport) {
                $filesFolder->addFile($temporaryFileForExport);
            }
            $this->‪removeTemporaryFolderName();
        }
 
        return $file;
    }
 
    public function ‪getExportFileName(): string
    {
        return ‪$this->exportFileName;
    }
 
    public function ‪setExportFileName(string ‪$exportFileName): void
    {
        ‪$exportFileName = trim((string)preg_replace('/[^[:alnum:]._-]*/', '', ‪$exportFileName));
        $this->exportFileName = ‪$exportFileName;
    }
 
    public function ‪getOrGenerateExportFileNameWithFileExtension(): string
    {
        if (!empty($this->exportFileName)) {
            ‪$exportFileName = ‪$this->exportFileName;
        } else {
            ‪$exportFileName = $this->‪generateExportFileName();
        }
        ‪$exportFileName .= $this->‪getFileExtensionByFileType();
 
        return ‪$exportFileName;
    }
 
    protected function ‪generateExportFileName(): string
    {
        if ($this->pid !== -1) {
            ‪$exportFileName = 'tree_PID' . $this->pid . '_L' . ‪$this->levels;
        } elseif (!empty($this->‪getRecord())) {
            ‪$exportFileName = 'recs_' . implode('-', $this->‪getRecord());
            ‪$exportFileName = str_replace(':', '_', ‪$exportFileName);
        } elseif (!empty($this->‪getList())) {
            ‪$exportFileName = 'list_' . implode('-', $this->‪getList());
            ‪$exportFileName = str_replace(':', '_', ‪$exportFileName);
        } else {
            ‪$exportFileName = 'export';
        }
 
        ‪$exportFileName = substr(trim((string)preg_replace('/[^[:alnum:]_-]/', '-', ‪$exportFileName)), 0, 20);
 
        return 'T3D_' . ‪$exportFileName . '_' . date('Y-m-d_H-i');
    }
 
    public function ‪getExportFileType(): string
    {
        return ‪$this->exportFileType;
    }
 
    public function ‪setExportFileType(string ‪$exportFileType): void
    {
        ‪$supportedFileTypes = $this->‪getSupportedFileTypes();
        if (!in_array(‪$exportFileType, ‪$supportedFileTypes, true)) {
            throw new \InvalidArgumentException(
                sprintf(
                    'File type "%s" is not valid. Supported file types are %s.',
                    ‪$exportFileType,
                    implode(', ', array_map(static function ($fileType) {
                        return '"' . $fileType . '"';
                    }, ‪$supportedFileTypes))
                ),
                1602505264
            );
        }
        $this->exportFileType = ‪$exportFileType;
    }
 
    public function ‪getSupportedFileTypes(): array
    {
        if (empty($this->supportedFileTypes)) {
            ‪$supportedFileTypes = [];
            ‪$supportedFileTypes[] = ‪self::FILETYPE_XML;
            ‪$supportedFileTypes[] = ‪self::FILETYPE_T3D;
            if ($this->compressionAvailable) {
                ‪$supportedFileTypes[] = ‪self::FILETYPE_T3DZ;
            }
            $this->supportedFileTypes = ‪$supportedFileTypes;
        }
        return ‪$this->supportedFileTypes;
    }
 
    protected function ‪getFileExtensionByFileType(): string
    {
        switch ($this->exportFileType) {
            case ‪self::FILETYPE_XML:
                return '.xml';
            case ‪self::FILETYPE_T3D:
                return '.t3d';
            case ‪self::FILETYPE_T3DZ:
            default:
                return '-z.t3d';
        }
    }
 
    public function ‪getTitle(): string
    {
        return ‪$this->title;
    }
 
    public function ‪setTitle(string ‪$title): void
    {
        $this->title = ‪$title;
    }
 
    public function ‪getDescription(): string
    {
        return ‪$this->description;
    }
 
    public function ‪setDescription(string ‪$description): void
    {
        $this->‪description = ‪$description;
    }
 
    public function ‪getNotes(): string
    {
        return ‪$this->notes;
    }
 
    public function ‪setNotes(string ‪$notes): void
    {
        $this->notes = ‪$notes;
    }
 
    public function ‪getRecord(): array
    {
        return ‪$this->record;
    }
 
    public function ‪setRecord(array ‪$record): void
    {
        $this->record = ‪$record;
    }
 
    public function ‪getList(): array
    {
        return ‪$this->list;
    }
 
    public function ‪setList(array ‪$list): void
    {
        $this->list = ‪$list;
    }
 
    public function ‪getLevels(): int
    {
        return ‪$this->levels;
    }
 
    public function ‪setLevels(int ‪$levels): void
    {
        $this->levels = ‪$levels;
    }
 
    public function ‪getTables(): array
    {
        return ‪$this->tables;
    }
 
    public function ‪setTables(array ‪$tables): void
    {
        $this->tables = ‪$tables;
    }
 
    public function ‪getRelOnlyTables(): array
    {
        return ‪$this->relOnlyTables;
    }
 
    public function ‪setRelOnlyTables(array ‪$relOnlyTables): void
    {
        $this->relOnlyTables = ‪$relOnlyTables;
    }
 
    public function ‪getTreeHTML(): string
    {
        return ‪$this->treeHTML;
    }
 
    public function ‪isIncludeExtFileResources(): bool
    {
        return ‪$this->includeExtFileResources;
    }
 
    public function ‪setIncludeExtFileResources(bool ‪$includeExtFileResources): void
    {
        $this->includeExtFileResources = ‪$includeExtFileResources;
    }
 
    public function ‪setSaveFilesOutsideExportFile(bool ‪$saveFilesOutsideExportFile)
    {
        $this->saveFilesOutsideExportFile = ‪$saveFilesOutsideExportFile;
    }
 
    public function ‪isSaveFilesOutsideExportFile(): bool
    {
        return ‪$this->saveFilesOutsideExportFile;
    }
}