253 lines
13 KiB
PHP
253 lines
13 KiB
PHP
<?php
|
|
namespace TYPO3\CMS\Extbase\Service;
|
|
|
|
/*
|
|
* 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!
|
|
*/
|
|
|
|
use TYPO3\CMS\Core\Context\Context;
|
|
use TYPO3\CMS\Core\Database\ConnectionPool;
|
|
use TYPO3\CMS\Core\Database\Query\Restriction\FrontendRestrictionContainer;
|
|
use TYPO3\CMS\Core\Utility\ArrayUtility;
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
|
use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
|
|
|
|
/**
|
|
* Service for determining basic extension params
|
|
* @internal only to be used within Extbase, not part of TYPO3 Core API.
|
|
*/
|
|
class ExtensionService implements \TYPO3\CMS\Core\SingletonInterface
|
|
{
|
|
const PLUGIN_TYPE_PLUGIN = 'list_type';
|
|
const PLUGIN_TYPE_CONTENT_ELEMENT = 'CType';
|
|
|
|
/**
|
|
* @var \TYPO3\CMS\Extbase\Object\ObjectManagerInterface
|
|
*/
|
|
protected $objectManager;
|
|
|
|
/**
|
|
* @var ConfigurationManagerInterface
|
|
*/
|
|
protected $configurationManager;
|
|
|
|
/**
|
|
* Cache of result for getTargetPidByPlugin()
|
|
* @var array
|
|
*/
|
|
protected $targetPidPluginCache = [];
|
|
|
|
/**
|
|
* @param \TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager
|
|
*/
|
|
public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
|
|
{
|
|
$this->objectManager = $objectManager;
|
|
}
|
|
|
|
/**
|
|
* @param ConfigurationManagerInterface $configurationManager
|
|
*/
|
|
public function injectConfigurationManager(ConfigurationManagerInterface $configurationManager)
|
|
{
|
|
$this->configurationManager = $configurationManager;
|
|
}
|
|
|
|
/**
|
|
* Determines the plugin namespace of the specified plugin (defaults to "tx_[extensionname]_[pluginname]")
|
|
* If plugin.tx_$pluginSignature.view.pluginNamespace is set, this value is returned
|
|
* If pluginNamespace is not specified "tx_[extensionname]_[pluginname]" is returned.
|
|
*
|
|
* @param string $extensionName name of the extension to retrieve the namespace for
|
|
* @param string $pluginName name of the plugin to retrieve the namespace for
|
|
* @return string plugin namespace
|
|
*/
|
|
public function getPluginNamespace($extensionName, $pluginName)
|
|
{
|
|
$pluginSignature = strtolower($extensionName . '_' . $pluginName);
|
|
$defaultPluginNamespace = 'tx_' . $pluginSignature;
|
|
$frameworkConfiguration = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK, $extensionName, $pluginName);
|
|
if (!isset($frameworkConfiguration['view']['pluginNamespace']) || empty($frameworkConfiguration['view']['pluginNamespace'])) {
|
|
return $defaultPluginNamespace;
|
|
}
|
|
return $frameworkConfiguration['view']['pluginNamespace'];
|
|
}
|
|
|
|
/**
|
|
* Iterates through the global TypoScript configuration and returns the name of the plugin
|
|
* that matches specified extensionName, controllerName and actionName.
|
|
* If no matching plugin was found, NULL is returned.
|
|
* If more than one plugin matches and the current plugin is not configured to handle the action,
|
|
* an Exception will be thrown
|
|
*
|
|
* @param string $extensionName name of the target extension (UpperCamelCase)
|
|
* @param string $controllerName name of the target controller (UpperCamelCase)
|
|
* @param string $actionName name of the target action (lowerCamelCase)
|
|
* @throws \TYPO3\CMS\Extbase\Exception
|
|
* @return string name of the target plugin (UpperCamelCase) or NULL if no matching plugin configuration was found
|
|
*/
|
|
public function getPluginNameByAction($extensionName, $controllerName, $actionName)
|
|
{
|
|
$frameworkConfiguration = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
|
|
// check, whether the current plugin is configured to handle the action
|
|
if (!empty($frameworkConfiguration['extensionName']) && $extensionName === $frameworkConfiguration['extensionName']) {
|
|
if (isset($frameworkConfiguration['controllerConfiguration'][$controllerName]) && in_array($actionName, $frameworkConfiguration['controllerConfiguration'][$controllerName]['actions'])) {
|
|
return $frameworkConfiguration['pluginName'];
|
|
}
|
|
}
|
|
$plugins = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['extbase']['extensions'][$extensionName]['plugins'] ?? false;
|
|
if (!$plugins) {
|
|
return null;
|
|
}
|
|
$pluginNames = [];
|
|
foreach ($plugins as $pluginName => $pluginConfiguration) {
|
|
foreach ($pluginConfiguration['controllers'] ?? [] as $pluginControllerName => $pluginControllerActions) {
|
|
if (strtolower($pluginControllerName) !== strtolower($controllerName)) {
|
|
continue;
|
|
}
|
|
if (in_array($actionName, $pluginControllerActions['actions'])) {
|
|
$pluginNames[] = $pluginName;
|
|
}
|
|
}
|
|
}
|
|
if (count($pluginNames) > 1) {
|
|
throw new \TYPO3\CMS\Extbase\Exception('There is more than one plugin that can handle this request (Extension: "' . $extensionName . '", Controller: "' . $controllerName . '", action: "' . $actionName . '"). Please specify "pluginName" argument', 1280825466);
|
|
}
|
|
return !empty($pluginNames) ? $pluginNames[0] : null;
|
|
}
|
|
|
|
/**
|
|
* Checks if the given action is cacheable or not.
|
|
*
|
|
* @param string $extensionName Name of the target extension, without underscores
|
|
* @param string $pluginName Name of the target plugin
|
|
* @param string $controllerName Name of the target controller
|
|
* @param string $actionName Name of the action to be called
|
|
* @return bool TRUE if the specified plugin action is cacheable, otherwise FALSE
|
|
*/
|
|
public function isActionCacheable($extensionName, $pluginName, $controllerName, $actionName)
|
|
{
|
|
$frameworkConfiguration = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK, $extensionName, $pluginName);
|
|
if (isset($frameworkConfiguration['controllerConfiguration'][$controllerName]) && is_array($frameworkConfiguration['controllerConfiguration'][$controllerName]) && is_array($frameworkConfiguration['controllerConfiguration'][$controllerName]['nonCacheableActions']) && in_array($actionName, $frameworkConfiguration['controllerConfiguration'][$controllerName]['nonCacheableActions'])) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Determines the target page of the specified plugin.
|
|
* If plugin.tx_$pluginSignature.view.defaultPid is set, this value is used as target page id
|
|
* If defaultPid is set to "auto", a the target pid is determined by loading the tt_content record that contains this plugin
|
|
* If the page could not be determined, NULL is returned
|
|
* If defaultPid is "auto" and more than one page contains the specified plugin, an Exception is thrown
|
|
*
|
|
* @param string $extensionName name of the extension to retrieve the target PID for
|
|
* @param string $pluginName name of the plugin to retrieve the target PID for
|
|
* @throws \TYPO3\CMS\Extbase\Exception
|
|
* @return int uid of the target page or NULL if target page could not be determined
|
|
*/
|
|
public function getTargetPidByPlugin($extensionName, $pluginName)
|
|
{
|
|
$frameworkConfiguration = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK, $extensionName, $pluginName);
|
|
if (!isset($frameworkConfiguration['view']['defaultPid']) || empty($frameworkConfiguration['view']['defaultPid'])) {
|
|
return null;
|
|
}
|
|
$pluginSignature = strtolower($extensionName . '_' . $pluginName);
|
|
if ($frameworkConfiguration['view']['defaultPid'] === 'auto') {
|
|
if (!array_key_exists($pluginSignature, $this->targetPidPluginCache)) {
|
|
$languageId = GeneralUtility::makeInstance(Context::class)->getPropertyFromAspect('language', 'id', 0);
|
|
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
|
|
->getQueryBuilderForTable('tt_content');
|
|
$queryBuilder->setRestrictions(GeneralUtility::makeInstance(FrontendRestrictionContainer::class));
|
|
|
|
$pages = $queryBuilder
|
|
->select('pid')
|
|
->from('tt_content')
|
|
->where(
|
|
$queryBuilder->expr()->eq(
|
|
'list_type',
|
|
$queryBuilder->createNamedParameter($pluginSignature, \PDO::PARAM_STR)
|
|
),
|
|
$queryBuilder->expr()->eq(
|
|
'CType',
|
|
$queryBuilder->createNamedParameter('list', \PDO::PARAM_STR)
|
|
),
|
|
$queryBuilder->expr()->eq(
|
|
'sys_language_uid',
|
|
$queryBuilder->createNamedParameter($languageId, \PDO::PARAM_INT)
|
|
)
|
|
)
|
|
->setMaxResults(2)
|
|
->execute()
|
|
->fetchAll();
|
|
|
|
if (count($pages) > 1) {
|
|
throw new \TYPO3\CMS\Extbase\Exception('There is more than one "' . $pluginSignature . '" plugin in the current page tree. Please remove one plugin or set the TypoScript configuration "plugin.tx_' . $pluginSignature . '.view.defaultPid" to a fixed page id', 1280773643);
|
|
}
|
|
$this->targetPidPluginCache[$pluginSignature] = !empty($pages) ? $pages[0]['pid'] : null;
|
|
}
|
|
return $this->targetPidPluginCache[$pluginSignature];
|
|
}
|
|
return (int)$frameworkConfiguration['view']['defaultPid'];
|
|
}
|
|
|
|
/**
|
|
* This returns the name of the first controller of the given plugin.
|
|
*
|
|
* @param string $extensionName name of the extension to retrieve the target PID for
|
|
* @param string $pluginName name of the plugin to retrieve the target PID for
|
|
* @return string|null
|
|
*/
|
|
public function getDefaultControllerNameByPlugin($extensionName, $pluginName)
|
|
{
|
|
$controllers = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['extbase']['extensions'][$extensionName]['plugins'][$pluginName]['controllers'] ?? false;
|
|
return $controllers ? key($controllers) : null;
|
|
}
|
|
|
|
/**
|
|
* This returns the name of the first action of the given plugin controller.
|
|
*
|
|
* @param string $extensionName name of the extension to retrieve the target PID for
|
|
* @param string $pluginName name of the plugin to retrieve the target PID for
|
|
* @param string $controllerName name of the controller to retrieve default action for
|
|
* @return string|null
|
|
*/
|
|
public function getDefaultActionNameByPluginAndController($extensionName, $pluginName, $controllerName)
|
|
{
|
|
$actions = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['extbase']['extensions'][$extensionName]['plugins'][$pluginName]['controllers'][$controllerName]['actions'] ?? false;
|
|
return $actions ? current($actions) : null;
|
|
}
|
|
|
|
/**
|
|
* Resolve the page type number to use for building a link for a specific format
|
|
*
|
|
* @param string $extensionName name of the extension that has defined the target page type
|
|
* @param string $format The format for which to look up the page type
|
|
* @return int Page type number for target page
|
|
*/
|
|
public function getTargetPageTypeByFormat($extensionName, $format)
|
|
{
|
|
// Legacy location
|
|
$settings = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_SETTINGS, $extensionName);
|
|
if (isset($settings['view']['formatToPageTypeMapping']) && is_array($settings['view']['formatToPageTypeMapping'])) {
|
|
trigger_error('Extension "' . $extensionName . '": Defining settings.view.formatToPageTypeMapping will be removed in TYPO3 10. Move definition to view.formatToPageTypeMapping.', E_USER_DEPRECATED);
|
|
$formatToPageTypeMapping = $settings['view']['formatToPageTypeMapping'];
|
|
}
|
|
// Default behaviour
|
|
$settings = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK, $extensionName);
|
|
if (isset($settings['view']['formatToPageTypeMapping']) && is_array($settings['view']['formatToPageTypeMapping'])) {
|
|
ArrayUtility::mergeRecursiveWithOverrule($formatToPageTypeMapping, $settings['view']['formatToPageTypeMapping']);
|
|
}
|
|
return $formatToPageTypeMapping[$format] ?? 0;
|
|
}
|
|
}
|