Skip to content

Commit

Permalink
[TASK] Migrate switchableControllerActions
Browse files Browse the repository at this point in the history
* Add UpdateWizard for migration
* Add and update Flexforms.
* Use tab for formatting in XLIFF files.
* Add breakingChange note

Fixes: #204
  • Loading branch information
rintisch committed Oct 9, 2024
1 parent 692f566 commit e3fb1ae
Show file tree
Hide file tree
Showing 19 changed files with 1,033 additions and 741 deletions.
8 changes: 2 additions & 6 deletions Classes/Controller/ProductController.php
Original file line number Diff line number Diff line change
Expand Up @@ -155,15 +155,11 @@ public function listAction(int $currentPage = 1): ResponseInterface
return $this->htmlResponse();
}

#[IgnoreValidation(['value' => 'product'])]
public function showAction(Product $product = null): ResponseInterface
{
if (!$product) {
$product = $this->getProduct();
}
if (!$product) {
return new ForwardResponse('list');
}

$this->view->assign('user', $GLOBALS['TSFE']->fe_user->user);
$this->view->assign('product', $product);
Expand Down Expand Up @@ -254,11 +250,11 @@ public function getProductUid(): mixed
$configurationManager->setConfiguration([
'vendorName' => 'Extcode',
'extensionName' => 'CartProducts',
'pluginName' => 'Products',
'pluginName' => 'DetailProduct',
]);
$requestBuilder = GeneralUtility::makeInstance(
RequestBuilder::class,
$this->configurationManager,
$configurationManager,
$this->extensionService
);

Expand Down
235 changes: 235 additions & 0 deletions Classes/Updates/SwitchableControllerActionsPluginUpdater.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,235 @@
<?php

declare(strict_types=1);

/*
* This file is part of the package extcode/cart-products.
*
* For the full copyright and license information, please read the
* LICENSE file that was distributed with this source code.
*/

namespace Extcode\CartProducts\Updates;

use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use TYPO3\CMS\Core\Service\FlexFormService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Install\Attribute\UpgradeWizard;
use TYPO3\CMS\Install\Updates\DatabaseUpdatedPrerequisite;
use TYPO3\CMS\Install\Updates\UpgradeWizardInterface;

#[UpgradeWizard('switchableControllerActionsPluginUpdater')]
class SwitchableControllerActionsPluginUpdater implements UpgradeWizardInterface
{
private const MIGRATION_SETTINGS = [
[
'sourceListType' => 'cartproducts_products',
'switchableControllerActions' => 'Product->show;Product->list',
'targetListType' => 'cartproducts_listproducts',
],
[
'sourceListType' => 'cartproducts_products',
'switchableControllerActions' => 'Product->show',
'targetListType' => 'cartproducts_detailproduct',
],
];

protected FlexFormService $flexFormService;

public function __construct()
{
$this->flexFormService = GeneralUtility::makeInstance(FlexFormService::class);
}

public function getIdentifier(): string
{
return 'switchableControllerActionsPluginUpdater';
}

public function getTitle(): string
{
return 'Migrates plugins of existing cart_produts plugins using switchableControllerActions';
}

public function getDescription(): string
{
$description = 'The old Cart: Products plugin using switchableControllerActions has been split into 2 separate plugins. ';
$description .= 'This update wizard migrates all existing plugin settings and changes the Plugin (list_type) ';
$description .= 'to use the new plugins available.';
return $description;
}

public function getPrerequisites(): array
{
return [
DatabaseUpdatedPrerequisite::class,
];
}

public function updateNecessary(): bool
{
return $this->checkIfWizardIsRequired();
}

public function executeUpdate(): bool
{
return $this->performMigration();
}

public function checkIfWizardIsRequired(): bool
{
return count($this->getMigrationRecords()) > 0;
}

public function performMigration(): bool
{
$records = $this->getMigrationRecords();

foreach ($records as $record) {
$flexFormData = GeneralUtility::xml2array($record['pi_flexform']);
if (!is_array($flexFormData)) {
continue;
}

$flexForm = $this->flexFormService->convertFlexFormContentToArray($record['pi_flexform']);
if (empty($flexForm)) {
continue;
}

$targetListType = $this->getTargetListType(
$record['list_type'],
$flexForm['switchableControllerActions']
);
$allowedSettings = $this->getAllowedSettingsFromFlexForm($targetListType);

// Remove flexform data which do not exist in flexform of new plugin
foreach ($flexFormData['data'] as $sheetKey => $sheetData) {
foreach ($sheetData['lDEF'] as $settingName => $setting) {
if (!in_array($settingName, $allowedSettings, true)) {
unset($flexFormData['data'][$sheetKey]['lDEF'][$settingName]);
}
}

// Remove empty sheets
if (count($flexFormData['data'][$sheetKey]['lDEF']) === 0) {
unset($flexFormData['data'][$sheetKey]);
}
}

if (count($flexFormData['data']) > 0) {
$newFlexform = $this->array2xml($flexFormData);
} else {
$newFlexform = '';
}

$this->updateContentElement($record['uid'], $targetListType, $newFlexform);
}

return true;
}

protected function getMigrationRecords(): array
{
$checkListTypes = array_unique(array_column(self::MIGRATION_SETTINGS, 'sourceListType'));

$connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
$queryBuilder = $connectionPool->getQueryBuilderForTable('tt_content');
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));

return $queryBuilder
->select('uid', 'list_type', 'pi_flexform')
->from('tt_content')
->where(
$queryBuilder->expr()->in(
'list_type',
$queryBuilder->createNamedParameter($checkListTypes, Connection::PARAM_STR_ARRAY)
)
)
->executeQuery()
->fetchAllAssociative();
}

protected function getTargetListType(string $sourceListType, string $switchableControllerActions): string
{
foreach (self::MIGRATION_SETTINGS as $setting) {
if ($setting['sourceListType'] === $sourceListType &&
$setting['switchableControllerActions'] === $switchableControllerActions
) {
return $setting['targetListType'];
}
}

return '';
}

protected function getAllowedSettingsFromFlexForm(string $listType): array
{
$flexFormFile = $GLOBALS['TCA']['tt_content']['columns']['pi_flexform']['config']['ds'][$listType . ',list'];

if(!$flexFormFile) return [];

$flexFormContent = file_get_contents(GeneralUtility::getFileAbsFileName(substr(trim($flexFormFile), 5)));
$flexFormData = GeneralUtility::xml2array($flexFormContent);

// Iterate each sheet and extract all settings
$settings = [];
foreach ($flexFormData['sheets'] as $sheet) {
foreach ($sheet['ROOT']['el'] as $setting => $tceForms) {
$settings[] = $setting;
}
}

return $settings;
}

/**
* Updates list_type and pi_flexform of the given content element UID
*
* @param int $uid
* @param string $newListType
* @param string $flexform
*/
protected function updateContentElement(int $uid, string $newListType, string $flexform): void
{
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('tt_content');
$queryBuilder->update('tt_content')
->set('list_type', $newListType)
->set('pi_flexform', $flexform)
->where(
$queryBuilder->expr()->in(
'uid',
$queryBuilder->createNamedParameter($uid, Connection::PARAM_INT)
)
)
->executeStatement();
}

/**
* Transforms the given array to FlexForm XML
*
* @param array $input
* @return string
*/
protected function array2xml(array $input = []): string
{
$options = [
'parentTagMap' => [
'data' => 'sheet',
'sheet' => 'language',
'language' => 'field',
'el' => 'field',
'field' => 'value',
'field:el' => 'el',
'el:_IS_NUM' => 'section',
'section' => 'itemType',
],
'disableTypeAttrib' => 2,
];
$spaceInd = 4;
$output = GeneralUtility::array2xml($input, '', 0, 'T3FlexForms', $spaceInd, $options);
$output = '<?xml version="1.0" encoding="utf-8" standalone="yes" ?>' . LF . $output;

Check failure on line 232 in Classes/Updates/SwitchableControllerActionsPluginUpdater.php

View workflow job for this annotation

GitHub Actions / code-quality (8.1, ^12.4)

Constant LF not found.

Check failure on line 232 in Classes/Updates/SwitchableControllerActionsPluginUpdater.php

View workflow job for this annotation

GitHub Actions / code-quality (8.2, ^12.4)

Constant LF not found.

Check failure on line 232 in Classes/Updates/SwitchableControllerActionsPluginUpdater.php

View workflow job for this annotation

GitHub Actions / code-quality (8.3, ^12.4)

Constant LF not found.
return $output;
}
}
2 changes: 1 addition & 1 deletion Classes/ViewHelpers/Link/ProductViewHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public function render(): string
if ($page) {
$this->arguments['pageUid'] = $page['uid'];
} else {
$pluginName = 'Products';
$pluginName = 'DetailProduct';

if ($product->getCategory() && $product->getCategory()->getCartProductShowPid()) {
$pageUid = $product->getCategory()->getCartProductShowPid();
Expand Down
Loading

0 comments on commit e3fb1ae

Please sign in to comment.