TYPO3 v15 dev-main snapshot ()
This commit is contained in:
@@ -0,0 +1,205 @@
|
||||
<?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\Command;
|
||||
|
||||
use Symfony\Component\Console\Attribute\AsCommand;
|
||||
use Symfony\Component\Console\Command\Command;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Symfony\Component\Console\Style\SymfonyStyle;
|
||||
use TYPO3\CMS\Core\Core\Bootstrap;
|
||||
use TYPO3\CMS\Core\Utility\PathUtility;
|
||||
use TYPO3\CMS\Impexp\Export;
|
||||
|
||||
/**
|
||||
* Command for exporting T3D/XML data files
|
||||
*/
|
||||
#[AsCommand('impexp:export', 'Exports a T3D / XML file with content of a page tree')]
|
||||
class ExportCommand extends Command
|
||||
{
|
||||
public function __construct(protected readonly Export $export)
|
||||
{
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
/**
|
||||
* Configure the command by defining the name, options and arguments
|
||||
*/
|
||||
protected function configure(): void
|
||||
{
|
||||
$this
|
||||
->addArgument(
|
||||
'filename',
|
||||
InputArgument::OPTIONAL,
|
||||
'The filename to export to (without file extension).'
|
||||
)
|
||||
->addOption(
|
||||
'type',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL,
|
||||
'The file type (xml, t3d, t3d_compressed).',
|
||||
$this->export->getExportFileType()
|
||||
)
|
||||
->addOption(
|
||||
'pid',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL,
|
||||
'The root page of the exported page tree.',
|
||||
$this->export->getPid()
|
||||
)
|
||||
->addOption(
|
||||
'levels',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL,
|
||||
sprintf(
|
||||
'The depth of the exported page tree. '
|
||||
. '"%d": "Records on this page", '
|
||||
. '"0": "This page", '
|
||||
. '"1": "1 level down", '
|
||||
. '.. '
|
||||
. '"%d": "Infinite levels".',
|
||||
Export::LEVELS_RECORDS_ON_THIS_PAGE,
|
||||
Export::LEVELS_INFINITE
|
||||
),
|
||||
$this->export->getLevels()
|
||||
)
|
||||
->addOption(
|
||||
'table',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
|
||||
'Include all records of this table. Examples: "_ALL", "tt_content", "sys_file_reference", etc.'
|
||||
)
|
||||
->addOption(
|
||||
'record',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
|
||||
'Include this specific record. Pattern is "{table}:{record}". Examples: "tt_content:12", etc.'
|
||||
)
|
||||
->addOption(
|
||||
'list',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
|
||||
'Include the records of this table and this page. Pattern is "{table}:{pid}". Examples: "be_users:0", etc.'
|
||||
)
|
||||
->addOption(
|
||||
'include-related',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
|
||||
'Include record relations to this table, including the related record. Examples: "_ALL", "sys_category", etc.'
|
||||
)
|
||||
->addOption(
|
||||
'include-static',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
|
||||
'Include record relations to this table, excluding the related record. Examples: "_ALL", "be_users", etc.'
|
||||
)
|
||||
->addOption(
|
||||
'exclude',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
|
||||
'Exclude this specific record. Pattern is "{table}:{record}". Examples: "fe_users:3", etc.'
|
||||
)
|
||||
->addOption(
|
||||
'exclude-disabled-records',
|
||||
null,
|
||||
InputOption::VALUE_NONE,
|
||||
'Exclude records which are handled as disabled by their TCA configuration, e.g. by fields "disabled", "starttime" or "endtime".'
|
||||
)
|
||||
->addOption(
|
||||
'title',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL,
|
||||
'The meta title of the export.'
|
||||
)
|
||||
->addOption(
|
||||
'description',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL,
|
||||
'The meta description of the export.'
|
||||
)
|
||||
->addOption(
|
||||
'notes',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL,
|
||||
'The meta notes of the export.'
|
||||
)
|
||||
->addOption(
|
||||
'dependency',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
|
||||
'This TYPO3 extension is required for the exported records. Examples: "news", "powermail", etc.'
|
||||
)
|
||||
->addOption(
|
||||
'save-files-outside-export-file',
|
||||
null,
|
||||
InputOption::VALUE_NONE,
|
||||
'Save files into separate folder instead of including them into the common export file. Folder name pattern is "{filename}.files".'
|
||||
)
|
||||
->addOption(
|
||||
'include-site-configurations',
|
||||
null,
|
||||
InputOption::VALUE_NONE,
|
||||
'Include site configurations for exported root pages.'
|
||||
)
|
||||
;
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes the command for exporting a t3d/xml file from the TYPO3 system
|
||||
*/
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int
|
||||
{
|
||||
// Ensure the _cli_ user is authenticated
|
||||
Bootstrap::initializeBackendAuthentication();
|
||||
|
||||
$io = new SymfonyStyle($input, $output);
|
||||
|
||||
try {
|
||||
$this->export->setExportFileName(PathUtility::basename((string)$input->getArgument('filename')));
|
||||
$this->export->setExportFileType((string)$input->getOption('type'));
|
||||
$this->export->setPid((int)$input->getOption('pid'));
|
||||
$this->export->setLevels((int)$input->getOption('levels'));
|
||||
$this->export->setTables($input->getOption('table'));
|
||||
$this->export->setRecord($input->getOption('record'));
|
||||
$this->export->setList($input->getOption('list'));
|
||||
$this->export->setRelOnlyTables($input->getOption('include-related'));
|
||||
$this->export->setRelStaticTables($input->getOption('include-static'));
|
||||
$this->export->setExcludeMap(array_fill_keys($input->getOption('exclude'), 1));
|
||||
$this->export->setExcludeDisabledRecords($input->getOption('exclude-disabled-records'));
|
||||
$this->export->setTitle((string)$input->getOption('title'));
|
||||
$this->export->setDescription((string)$input->getOption('description'));
|
||||
$this->export->setNotes((string)$input->getOption('notes'));
|
||||
$this->export->setExtensionDependencies($input->getOption('dependency'));
|
||||
$this->export->setSaveFilesOutsideExportFile($input->getOption('save-files-outside-export-file'));
|
||||
$this->export->setIncludeSiteConfigurations($input->getOption('include-site-configurations'));
|
||||
$this->export->process();
|
||||
$saveFile = $this->export->saveToFile();
|
||||
$io->success('Exporting to ' . $saveFile->getPublicUrl() . ' succeeded.');
|
||||
return Command::SUCCESS;
|
||||
} catch (\Exception $e) {
|
||||
$saveFolder = $this->export->getOrCreateDefaultImportExportFolder();
|
||||
$io->error('Exporting to ' . $saveFolder->getPublicUrl() . ' failed.');
|
||||
if ($io->isVerbose()) {
|
||||
$io->writeln($e->getMessage());
|
||||
}
|
||||
return Command::FAILURE;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,158 @@
|
||||
<?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\Command;
|
||||
|
||||
use Symfony\Component\Console\Attribute\AsCommand;
|
||||
use Symfony\Component\Console\Command\Command;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Symfony\Component\Console\Style\SymfonyStyle;
|
||||
use TYPO3\CMS\Core\Core\Bootstrap;
|
||||
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||||
use TYPO3\CMS\Impexp\Import;
|
||||
|
||||
/**
|
||||
* Command for importing T3D/XML data files
|
||||
*/
|
||||
#[AsCommand('impexp:import', 'Imports a T3D / XML file with content into a page tree')]
|
||||
class ImportCommand extends Command
|
||||
{
|
||||
public function __construct(protected readonly Import $import)
|
||||
{
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
/**
|
||||
* Configure the command by defining the name, options and arguments
|
||||
*/
|
||||
protected function configure(): void
|
||||
{
|
||||
$this
|
||||
->addArgument(
|
||||
'file',
|
||||
InputArgument::REQUIRED,
|
||||
'The file path to import from (.t3d or .xml).'
|
||||
)
|
||||
->addArgument(
|
||||
'pid',
|
||||
InputArgument::OPTIONAL,
|
||||
'The page to import to.',
|
||||
0
|
||||
)
|
||||
->addOption(
|
||||
'update-records',
|
||||
null,
|
||||
InputOption::VALUE_NONE,
|
||||
'If set, existing records with the same UID will be updated instead of inserted.'
|
||||
)
|
||||
->addOption(
|
||||
'ignore-pid',
|
||||
null,
|
||||
InputOption::VALUE_NONE,
|
||||
'If set, page IDs of updated records are not corrected (only works in conjunction with --update-records).'
|
||||
)
|
||||
->addOption(
|
||||
'force-uid',
|
||||
null,
|
||||
InputOption::VALUE_NONE,
|
||||
'If set, UIDs from file will be forced.'
|
||||
)
|
||||
->addOption(
|
||||
'import-mode',
|
||||
null,
|
||||
InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
|
||||
sprintf(
|
||||
'Set the import mode of this specific record. ' . PHP_EOL
|
||||
. 'Pattern is "{table}:{record}={mode}". ' . PHP_EOL
|
||||
. 'Available modes for new records are "%1$s" and "%3$s" '
|
||||
. 'and for existing records "%2$s", "%4$s", "%5$s" and "%3$s".' . PHP_EOL
|
||||
. 'Examples are "pages:987=%1$s", "tt_content:1=%2$s", etc.',
|
||||
Import::IMPORT_MODE_FORCE_UID,
|
||||
Import::IMPORT_MODE_AS_NEW,
|
||||
Import::IMPORT_MODE_EXCLUDE,
|
||||
Import::IMPORT_MODE_IGNORE_PID,
|
||||
Import::IMPORT_MODE_RESPECT_PID
|
||||
)
|
||||
)
|
||||
->addOption(
|
||||
'enable-log',
|
||||
null,
|
||||
InputOption::VALUE_NONE,
|
||||
'If set, all database actions are logged.'
|
||||
)
|
||||
;
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes the command for importing a t3d/xml file into the TYPO3 system
|
||||
*/
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int
|
||||
{
|
||||
// Ensure the _cli_ user is authenticated
|
||||
Bootstrap::initializeBackendAuthentication();
|
||||
|
||||
$io = new SymfonyStyle($input, $output);
|
||||
|
||||
try {
|
||||
$this->import->setPid((int)$input->getArgument('pid'));
|
||||
$this->import->setUpdate($input->getOption('update-records'));
|
||||
$this->import->setGlobalIgnorePid($input->getOption('ignore-pid'));
|
||||
$this->import->setForceAllUids($input->getOption('force-uid'));
|
||||
$this->import->setEnableLogging($input->getOption('enable-log'));
|
||||
$this->import->setImportMode($this->parseAssociativeArray($input, 'import-mode', '='));
|
||||
$this->import->loadFile((string)$input->getArgument('file'));
|
||||
$this->import->checkImportPrerequisites();
|
||||
$this->import->importData();
|
||||
$io->success('Importing ' . $input->getArgument('file') . ' to page ' . $input->getArgument('pid') . ' succeeded.');
|
||||
return Command::SUCCESS;
|
||||
} catch (\Exception $e) {
|
||||
// Since impexp triggers core and DataHandler with potential hooks, and exception could come from "everywhere".
|
||||
$io->error('Importing ' . $input->getArgument('file') . ' to page ' . $input->getArgument('pid') . ' failed.');
|
||||
if ($io->isVerbose()) {
|
||||
$io->writeln($e->getMessage());
|
||||
$io->writeln($this->import->getErrorLog());
|
||||
}
|
||||
return Command::FAILURE;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse a basic commandline option array into an associative array by splitting each entry into a key part and
|
||||
* a value part using a specific separator.
|
||||
*/
|
||||
protected function parseAssociativeArray(InputInterface &$input, string $optionName, string $separator): array
|
||||
{
|
||||
$array = [];
|
||||
|
||||
foreach ($input->getOption($optionName) as &$value) {
|
||||
$parts = GeneralUtility::trimExplode($separator, $value, true, 2);
|
||||
if (count($parts) === 2) {
|
||||
$array[$parts[0]] = $parts[1];
|
||||
} else {
|
||||
throw new \InvalidArgumentException(
|
||||
sprintf('Command line option "%s" has invalid entry "%s".', $optionName, $value),
|
||||
1610464090
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return $array;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user