BackendConfigurationManager.php 7.81 KB
Newer Older
1
<?php
Thomas Maroschik's avatar
Thomas Maroschik committed
2
3
namespace TYPO3\CMS\Extbase\Configuration;

4
/*
5
 * This file is part of the TYPO3 CMS project.
6
 *
7
8
9
 * 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.
10
 *
11
12
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
13
 *
14
15
 * The TYPO3 project - inspiring people to share!
 */
16

17
18
19
/**
 * A general purpose configuration manager used in backend mode.
 */
Thomas Maroschik's avatar
Thomas Maroschik committed
20
class BackendConfigurationManager extends \TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager {
21

22
	/**
23
	 * Needed to recursively fetch a page tree
24
	 *
25
	 * @var \TYPO3\CMS\Core\Database\QueryGenerator
26
	 */
27
	protected $queryGenerator;
28

29
30
31
	/**
	 * @var array
	 */
32
	protected $typoScriptSetupCache = array();
33

34
35
	/**
	 * stores the current page ID
36
	 * @var int
37
38
39
	 */
	protected $currentPageId;

40
41
42
43
44
45
46
	/**
	 * @param \TYPO3\CMS\Core\Database\QueryGenerator $queryGenerator
	 */
	public function injectQueryGenerator(\TYPO3\CMS\Core\Database\QueryGenerator $queryGenerator) {
		$this->queryGenerator = $queryGenerator;
	}

47
48
49
	/**
	 * Returns TypoScript Setup array from current Environment.
	 *
50
	 * @return array the raw TypoScript setup
51
	 */
52
	public function getTypoScriptSetup() {
53
54
55
		$pageId = $this->getCurrentPageId();

		if (!array_key_exists($pageId, $this->typoScriptSetupCache)) {
56
			/** @var $template \TYPO3\CMS\Core\TypoScript\TemplateService */
57
			$template = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\TypoScript\TemplateService::class);
58
			// do not log time-performance information
59
			$template->tt_track = 0;
60
61
			// Explicitly trigger processing of extension static files
			$template->setProcessExtensionStatics(TRUE);
62
			$template->init();
63
			// Get the root line
64
65
			$rootline = array();
			if ($pageId > 0) {
Thomas Maroschik's avatar
Thomas Maroschik committed
66
				/** @var $sysPage \TYPO3\CMS\Frontend\Page\PageRepository */
67
				$sysPage = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Frontend\Page\PageRepository::class);
68
				// Get the rootline for the current page
69
				$rootline = $sysPage->getRootLine($pageId, '', TRUE);
70
			}
71
			// This generates the constants/config + hierarchy info for the template.
72
73
			$template->runThroughTemplates($rootline, 0);
			$template->generateConfig();
74
			$this->typoScriptSetupCache[$pageId] = $template->setup;
75
		}
76
		return $this->typoScriptSetupCache[$pageId];
77
78
	}

79
80
81
82
83
84
85
86
	/**
	 * Returns the TypoScript configuration found in module.tx_yourextension_yourmodule
	 * merged with the global configuration of your extension from module.tx_yourextension
	 *
	 * @param string $extensionName
	 * @param string $pluginName in BE mode this is actually the module signature. But we're using it just like the plugin name in FE
	 * @return array
	 */
87
	protected function getPluginConfiguration($extensionName, $pluginName = NULL) {
88
89
		$setup = $this->getTypoScriptSetup();
		$pluginConfiguration = array();
90
91
		if (is_array($setup['module.']['tx_' . strtolower($extensionName) . '.'])) {
			$pluginConfiguration = $this->typoScriptService->convertTypoScriptArrayToPlainArray($setup['module.']['tx_' . strtolower($extensionName) . '.']);
92
		}
93
		if ($pluginName !== NULL) {
94
95
			$pluginSignature = strtolower($extensionName . '_' . $pluginName);
			if (is_array($setup['module.']['tx_' . $pluginSignature . '.'])) {
96
97
				$overruleConfiguration = $this->typoScriptService->convertTypoScriptArrayToPlainArray($setup['module.']['tx_' . $pluginSignature . '.']);
				\TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($pluginConfiguration, $overruleConfiguration);
98
			}
99
100
101
102
103
104
105
		}
		return $pluginConfiguration;
	}

	/**
	 * Returns the configured controller/action pairs of the specified module in the format
	 * array(
106
107
	 * 'Controller1' => array('action1', 'action2'),
	 * 'Controller2' => array('action3', 'action4')
108
109
110
111
112
113
114
115
116
117
118
119
120
121
	 * )
	 *
	 * @param string $extensionName
	 * @param string $pluginName in BE mode this is actually the module signature. But we're using it just like the plugin name in FE
	 * @return array
	 */
	protected function getSwitchableControllerActions($extensionName, $pluginName) {
		$switchableControllerActions = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['extbase']['extensions'][$extensionName]['modules'][$pluginName]['controllers'];
		if (!is_array($switchableControllerActions)) {
			$switchableControllerActions = array();
		}
		return $switchableControllerActions;
	}

122
123
124
125
	/**
	 * Returns the page uid of the current page.
	 * If no page is selected, we'll return the uid of the first root page.
	 *
126
	 * @return int current page id. If no page is selected current root page id is returned
127
128
	 */
	protected function getCurrentPageId() {
129
130
		if ($this->currentPageId !== NULL) {
			return $this->currentPageId;
131
		}
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

		$this->currentPageId = $this->getCurrentPageIdFromGetPostData() ?: $this->getCurrentPageIdFromCurrentSiteRoot();
		$this->currentPageId = $this->currentPageId ?: $this->getCurrentPageIdFromRootTemplate();
		$this->currentPageId = $this->currentPageId ?: self::DEFAULT_BACKEND_STORAGE_PID;

		return $this->currentPageId;
	}

	/**
	 * Gets the current page ID from the GET/POST data.
	 *
	 * @return int the page UID, will be 0 if none has been set
	 */
	protected function getCurrentPageIdFromGetPostData() {
		return (int)\TYPO3\CMS\Core\Utility\GeneralUtility::_GP('id');
	}

	/**
	 * Gets the current page ID from the first site root in tree.
	 *
	 * @return int the page UID, will be 0 if none has been set
	 */
	protected function getCurrentPageIdFromCurrentSiteRoot() {
		$rootPage = $GLOBALS['TYPO3_DB']->exec_SELECTgetSingleRow(
			'uid', 'pages', 'deleted=0 AND hidden=0 AND is_siteroot=1', '', 'sorting'
		);
		if (empty($rootPage)) {
			return 0;
160
		}
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

		return (int)$rootPage['uid'];
	}

	/**
	 * Gets the current page ID from the first created root template.
	 *
	 * @return int the page UID, will be 0 if none has been set
	 */
	protected function getCurrentPageIdFromRootTemplate() {
		$rootTemplate = $GLOBALS['TYPO3_DB']->exec_SELECTgetSingleRow(
			'pid', 'sys_template', 'deleted=0 AND hidden=0 AND root=1', '', 'crdate'
		);
		if (empty($rootTemplate)) {
			return 0;
176
		}
177
178

		return (int)$rootTemplate['pid'];
179
	}
180

181
182
183
184
185
186
187
188
189
	/**
	 * Returns the default backend storage pid
	 *
	 * @return string
	 */
	public function getDefaultBackendStoragePid() {
		return $this->getCurrentPageId();
	}

190
	/**
191
192
193
194
	 * We need to set some default request handler if the framework configuration
	 * could not be loaded; to make sure Extbase also works in Backend modules
	 * in all contexts.
	 *
195
	 * @param array $frameworkConfiguration
196
197
198
	 * @return array
	 */
	protected function getContextSpecificFrameworkConfiguration(array $frameworkConfiguration) {
199
200
		if (!isset($frameworkConfiguration['mvc']['requestHandlers'])) {
			$frameworkConfiguration['mvc']['requestHandlers'] = array(
201
202
				\TYPO3\CMS\Extbase\Mvc\Web\FrontendRequestHandler::class => \TYPO3\CMS\Extbase\Mvc\Web\FrontendRequestHandler::class,
				\TYPO3\CMS\Extbase\Mvc\Web\BackendRequestHandler::class => \TYPO3\CMS\Extbase\Mvc\Web\BackendRequestHandler::class
203
204
			);
		}
205
206
		return $frameworkConfiguration;
	}
207
208
209
210
211
212


	/**
	 * Returns a comma separated list of storagePid that are below a certain storage pid.
	 *
	 * @param string $storagePid Storage PID to start at; multiple PIDs possible as comma-separated list
213
	 * @param int $recursionDepth Maximum number of levels to search, 0 to disable recursive lookup
214
215
216
217
218
219
220
221
222
223
224
	 * @return string storage PIDs
	 */
	protected function getRecursiveStoragePids($storagePid, $recursionDepth = 0) {
		if ($recursionDepth <= 0) {
			return $storagePid;
		}

		$recursiveStoragePids = '';
		$storagePids = \TYPO3\CMS\Core\Utility\GeneralUtility::intExplode(',', $storagePid);
		foreach ($storagePids as $startPid) {
			$pids = $this->queryGenerator->getTreeList($startPid, $recursionDepth, 0, 1);
225
			if ((string)$pids !== '') {
226
227
228
229
230
231
232
				$recursiveStoragePids .= $pids . ',';
			}
		}

		return rtrim($recursiveStoragePids, ',');
	}

233
}