HDNET\Autoloader\Service\SmartObjectInformationService

Complexity

Total Complexity

35

Size/Duplication

Total Lines	360
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Test Coverage

Coverage

0%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getInstance()	0	4	1
A	getDatabaseInformation()	0	13	2
B	getCustomModelFieldTca()	0	42	5
C	getTcaInformation()	0	86	9
A	useTableNameFileBase()	0	6	2
A	getCustomDatabaseInformation()	0	19	4
A	getDatabaseMappingByVarType()	0	7	1
A	getCustomModelFields()	0	31	4
A	generateSqlQuery()	0	8	2
A	generateCompleteSqlQuery()	0	43	3
A	getDataSet()	0	4	1
A	getTcaTitle()	0	4	1

<?php

/**
 * SmartObjectInformationService.php.
 */
declare(strict_types = 1);

namespace HDNET\Autoloader\Service;

use Doctrine\Common\Annotations\AnnotationReader;
use HDNET\Autoloader\Annotation\DatabaseField;
use HDNET\Autoloader\Annotation\DatabaseKey;
use HDNET\Autoloader\Annotation\EnableRichText;
use HDNET\Autoloader\DataSet;
use HDNET\Autoloader\Mapper;
use HDNET\Autoloader\Utility\ArrayUtility;
use HDNET\Autoloader\Utility\ClassNamingUtility;
use HDNET\Autoloader\Utility\ExtendedUtility;
use HDNET\Autoloader\Utility\IconUtility;
use HDNET\Autoloader\Utility\ModelUtility;
use HDNET\Autoloader\Utility\TranslateUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * SmartObjectInformationService.
 */
class SmartObjectInformationService
{
    /**
     * Get a instance of this object.
     *
     * @return \HDNET\Autoloader\Service\SmartObjectInformationService
     */
    public static function getInstance()
    {
        return GeneralUtility::makeInstance(self::class);
    }

    /**
     * Get database information.
     *
     * @param $modelClassName
     *
     * @return string
     */
    public function getDatabaseInformation($modelClassName)
    {
        $tableName = ModelUtility::getTableName($modelClassName);
        $custom = $this->getCustomDatabaseInformation($modelClassName);

        // disable complete table generation
        // for extending existing tables
        if ('' !== ModelUtility::getTableNameByModelReflectionAnnotation($modelClassName)) {
            return $this->generateSqlQuery($tableName, $custom);
        }

        return $this->generateCompleteSqlQuery($modelClassName, $tableName, $custom);
    }

    /**
     * Get the custom Model field TCA structure.
     *
     * @param       $modelClassName
     * @param array $searchFields
     *
     * @return array
     */
    public function getCustomModelFieldTca($modelClassName, &$searchFields = [])
    {
        $modelInformation = ClassNamingUtility::explodeObjectModelName($modelClassName);
        $extensionName = GeneralUtility::camelCaseToLowerCaseUnderscored($modelInformation['extensionName']);
        $tableName = ModelUtility::getTableName($modelClassName);
        $customFieldInfo = $this->getCustomModelFields($modelClassName);
        $searchFields = [];
        $customFields = [];
        foreach ($customFieldInfo as $info) {
            $key = $tableName . '.' . $info['name'];

            if ($this->useTableNameFileBase()) {
                // Without prefix !
                $key = $info['name'];
            }

            try {
                TranslateUtility::assureLabel($key, $extensionName, $info['name'], null, $tableName);
                $label = TranslateUtility::getLllOrHelpMessage($key, $extensionName, $tableName);
            } catch (\Exception $ex) {
                $label = $info['name'];
            }

            /** @var Mapper $mapper */
            $mapper = ExtendedUtility::create(Mapper::class);
            $field = $mapper->getTcaConfiguration(trim($info['var'], '\\'), $info['name'], $label);

            // RTE
            if ($info['rte']) {
                $field['config']['type'] = 'text';
                $field['config']['enableRichtext'] = '1';
                $field['config']['richtextConfiguration'] = 'default';
                $field['config']['softref'] = 'typolink_tag,email[subst],url';
                $field['defaultExtras'] = 'richtext:rte_transform[flag=rte_enabled|mode=ts_css]';
            }

            $searchFields[] = $info['name'];
            $customFields[$info['name']] = $field;
        }

        return $customFields;
    }

    /**
     * Pre build TCA information for the given model.
     *
     * @param string $modelClassName
     *
     * @return array
     */
    public function getTcaInformation($modelClassName)
    {
        $modelInformation = ClassNamingUtility::explodeObjectModelName($modelClassName);
        $extensionName = GeneralUtility::camelCaseToLowerCaseUnderscored($modelInformation['extensionName']);
        $reflectionTableName = ModelUtility::getTableNameByModelReflectionAnnotation($modelClassName);
        $tableName = ModelUtility::getTableNameByModelName($modelClassName);

        $searchFields = [];
        $customFields = $this->getCustomModelFieldTca($modelClassName, $searchFields);

        if ('' !== $reflectionTableName) {
            $customConfiguration = [
                'columns' => $customFields,
            ];
            $base = \is_array($GLOBALS['TCA'][$reflectionTableName]) ? $GLOBALS['TCA'][$reflectionTableName] : [];

            return ArrayUtility::mergeRecursiveDistinct($base, $customConfiguration);
        }

        $excludes = ModelUtility::getSmartExcludesByModelName($modelClassName);

        $dataSet = $this->getDataSet();
        $dataImplementations = $dataSet->getAllAndExcludeList($excludes);
        $baseTca = $dataSet->getTcaInformation($dataImplementations, $tableName);

        // title
        $fields = array_keys($customFields);
        $labelField = 'title';
        if (!\in_array($labelField, $fields, true)) {
            $labelField = $fields[0];
        }

        try {
            TranslateUtility::assureLabel($tableName, $extensionName, null, null, $tableName);
        } catch (\Exception $ex) {
            // Do not handle the error of the assureLabel method
        }
        if (!\is_array($baseTca['columns'])) {
            $baseTca['columns'] = [];
        }
        $baseTca['columns'] = ArrayUtility::mergeRecursiveDistinct($baseTca['columns'], $customFields);

        // items
        $showitem = $fields;
        if (!\in_array('language', $excludes, true)) {
            $showitem[] = '--div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:language,--palette--;;language';
        }

        if (!\in_array('workspaces', $excludes, true)) {
            $baseTca['ctrl']['shadowColumnsForNewPlaceholders'] .= ',' . $labelField;
        }

        $languagePrefix = 'LLL:EXT:frontend/Resources/Private/Language/';
        $languagePrefixCore = 'LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf';
        if (!\in_array('enableFields', $excludes, true)) {
            $showitem[] = '--div--;' . $languagePrefixCore . ':access';
            $showitem[] = '--palette--;' . $languagePrefix . 'locallang_tca.xlf:pages.palettes.access;access';
        }
        $showitem[] = '--div--;' . $languagePrefix . 'locallang_ttc.xlf:tabs.extended';

        $overrideTca = [
            'ctrl' => [
                'title' => $this->getTcaTitle($tableName, $extensionName),
                'label' => $labelField,
                'tstamp' => 'tstamp',
                'crdate' => 'crdate',
                'cruser_id' => 'cruser_id',
                'dividers2tabs' => true,
                'sortby' => 'sorting',
                'delete' => 'deleted',
                'searchFields' => implode(',', $searchFields),
                'iconfile' => IconUtility::getByModelName($modelClassName, true),
            ],
            'interface' => [
                'showRecordFieldList' => implode(',', array_keys($baseTca['columns'])),
            ],
            'types' => [
                '1' => ['showitem' => implode(',', $showitem)],
            ],
            'palettes' => [
                'access' => ['showitem' => 'starttime, endtime, --linebreak--, hidden, editlock, --linebreak--, fe_group'],
            ],
        ];

        return ArrayUtility::mergeRecursiveDistinct($baseTca, $overrideTca);
    }

    /**
     * Check if table name file base is used.
     *
     * @return bool
     */
    protected function useTableNameFileBase()
    {
        $configuration = unserialize((string)$GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['autoloader']);

        return isset($configuration['enableLanguageFileOnTableBase']) ? (bool)$configuration['enableLanguageFileOnTableBase'] : false;
    }

    /**
     * Get custom database information for the given model.
     *
     * @param string $modelClassName
     *
     * @return array
     */
    protected function getCustomDatabaseInformation($modelClassName)
    {
        $fieldInformation = $this->getCustomModelFields($modelClassName);
        $fields = [];
        foreach ($fieldInformation as $info) {
            if ('' === $info['db']) {
                $info['db'] = $this->getDatabaseMappingByVarType($info['var']);
            } else {
                try {
                    $info['db'] = $this->getDatabaseMappingByVarType($info['db']);
                } catch (\Exception $ex) {
                    // Do not handle the getDatabaseMappingByVarType by db, Fallback is the var call
                }
            }
            $fields[] = '`' . $info['name'] . '` ' . $info['db'];
        }

        return $fields;
    }

    /**
     * Get the right mapping.
     *
     * @param $var
     *
     * @throws \HDNET\Autoloader\Exception
     *
     * @return string
     */
    protected function getDatabaseMappingByVarType($var)
    {
        /** @var Mapper $mapper */
        $mapper = ExtendedUtility::create(Mapper::class);

        return $mapper->getDatabaseDefinition($var);
    }

    /**
     * Get custom database information for the given model.
     */
    protected function getCustomModelFields(string $modelClassName): array
    {
        /** @var AnnotationReader $annotationReader */
        $annotationReader = GeneralUtility::makeInstance(AnnotationReader::class);

        $reflectionClass = new \ReflectionClass($modelClassName);
        $properties = [];
        foreach ($reflectionClass->getProperties() as $property) {
            $propertiesCheck = $annotationReader->getPropertyAnnotation($property, DatabaseField::class);
            if (null !== $propertiesCheck) {
                $properties[$property->getName()] = $propertiesCheck;
            }
        }

        $tableName = ModelUtility::getTableName($modelClassName);
        $nameMapperService = GeneralUtility::makeInstance(NameMapperService::class);
        $fields = [];

        foreach ($properties as $name => $annotation) {
            $var = (string)$annotation->type;
            $fields[] = [
                'property' => $name,
                'name' => $nameMapperService->getDatabaseFieldName($tableName, $name),
                'db' => trim((string)$annotation->sql),
                'var' => trim((string)$var),
                'rte' => null !== $annotationReader->getPropertyAnnotation($reflectionClass->getProperty($name), EnableRichText::class),
            ];
        }

        return $fields;
    }

    /**
     * Generate SQL Query.
     *
     * @param string $tableName
     *
     * @return string
     */
    protected function generateSqlQuery($tableName, array $fields)
    {
        if (empty($fields)) {
            return '';
        }

        return LF . 'CREATE TABLE ' . $tableName . ' (' . LF . implode(',' . LF, $fields) . LF . ');' . LF;
    }

    /**
     * Generate complete SQL Query.
     *
     * @param string $modelClassName
     * @param string $tableName
     *
     * @return string
     */
    protected function generateCompleteSqlQuery($modelClassName, $tableName, array $custom)
    {
        $fields = [];
        $fields[] = 'uid int(11) NOT NULL auto_increment';
        $fields[] = 'pid int(11) DEFAULT \'0\' NOT NULL';
        $fields[] = 'tstamp int(11) unsigned DEFAULT \'0\' NOT NULL';
        $fields[] = 'crdate int(11) unsigned DEFAULT \'0\' NOT NULL';
        $fields[] = 'cruser_id int(11) unsigned DEFAULT \'0\' NOT NULL';
        $fields[] = 'deleted tinyint(4) unsigned DEFAULT \'0\' NOT NULL';
        $fields[] = 'sorting int(11) DEFAULT \'0\' NOT NULL';

        foreach ($custom as $field) {
            $fields[] = $field;
        }

        $excludes = ModelUtility::getSmartExcludesByModelName($modelClassName);
        $dataSet = $this->getDataSet();
        $dataImplementations = $dataSet->getAllAndExcludeList($excludes);

        // add data set fields
        $fields = array_merge($fields, $dataSet->getDatabaseSqlInformation($dataImplementations, $tableName));

        // default keys
        $fields[] = 'PRIMARY KEY (uid)';
        $fields[] = 'KEY parent (pid)';

        // add custom keys set by @key annotations

        $annotationReader = GeneralUtility::makeInstance(AnnotationReader::class);
        $key = $annotationReader->getClassAnnotation(new \ReflectionClass($modelClassName), DatabaseKey::class);
        if (null !== $key) {
            $additionalKeys = [(string)$key];
            array_walk($additionalKeys, function (&$item): void {
                $item = 'KEY ' . $item;
            });
            $fields = array_merge($fields, $additionalKeys);
        }

        // add data set keys
        $fields = array_merge($fields, $dataSet->getDatabaseSqlKeyInformation($dataImplementations, $tableName));

        return $this->generateSqlQuery($tableName, $fields);
    }

    /**
     * Get the data set object.
     *
     * @return \HDNET\Autoloader\DataSet
     */
    protected function getDataSet()
    {
        return GeneralUtility::makeInstance(DataSet::class);
    }

    /**
     * Get TCA title.
     *
     * @param string $tableName
     * @param string $extensionName
     *
     * @return string
     */
    protected function getTcaTitle($tableName, $extensionName)
    {
        return TranslateUtility::getLllOrHelpMessage($tableName, $extensionName, $tableName);
    }
}