typo3/sysext/extbase/Classes/Configuration/BackendConfigurationManager.php

   1 <?php
   2 namespace TYPO3\CMS\Extbase\Configuration;
   3
   4 /***************************************************************
   5  *  Copyright notice
   6  *
   7  *  (c) 2010-2013 Extbase Team (http://forge.typo3.org/projects/typo3v4-mvc)
   8  *  Extbase is a backport of TYPO3 Flow. All credits go to the TYPO3 Flow team.
   9  *  All rights reserved
  10  *
  11  *  This script is part of the TYPO3 project. The TYPO3 project is
  12  *  free software; you can redistribute it and/or modify
  13  *  it under the terms of the GNU General Public License as published by
  14  *  the Free Software Foundation; either version 2 of the License, or
  15  *  (at your option) any later version.
  16  *
  17  *  The GNU General Public License can be found at
  18  *  http://www.gnu.org/copyleft/gpl.html.
  19  *  A copy is found in the textfile GPL.txt and important notices to the license
  20  *  from the author is found in LICENSE.txt distributed with these scripts.
  21  *
  22  *
  23  *  This script is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  This copyright notice MUST APPEAR in all copies of the script!
  29  ***************************************************************/
  30 /**
  31  * A general purpose configuration manager used in backend mode.
  32  */
  33 class BackendConfigurationManager extends \TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager {
  34
  35         /**
  36          * @var \TYPO3\CMS\Core\Database\QueryGenerator Needed to recursively fetch a page tree
  37          */
  38         protected $queryGenerator;
  39
  40         /**
  41          * Inject query generator
  42          *
  43          * @param \TYPO3\CMS\Core\Database\QueryGenerator $queryGenerator
  44          */
  45         public function injectQueryGenerator(\TYPO3\CMS\Core\Database\QueryGenerator $queryGenerator) {
  46                 $this->queryGenerator = $queryGenerator;
  47         }
  48
  49         /**
  50          * @var array
  51          */
  52         protected $typoScriptSetupCache = array();
  53
  54         /**
  55          * Returns TypoScript Setup array from current Environment.
  56          *
  57          * @return array the raw TypoScript setup
  58          */
  59         public function getTypoScriptSetup() {
  60                 $pageId = $this->getCurrentPageId();
  61
  62                 if (!array_key_exists($pageId, $this->typoScriptSetupCache)) {
  63                         /** @var $template \TYPO3\CMS\Core\TypoScript\TemplateService */
  64                         $template = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\TypoScript\\TemplateService');
  65                         // do not log time-performance information
  66                         $template->tt_track = 0;
  67                         // Explicitly trigger processing of extension static files
  68                         $template->setProcessExtensionStatics(TRUE);
  69                         $template->init();
  70                         // Get the root line
  71                         $rootline = array();
  72                         if ($pageId > 0) {
  73                                 /** @var $sysPage \TYPO3\CMS\Frontend\Page\PageRepository */
  74                                 $sysPage = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\Page\\PageRepository');
  75                                 // Get the rootline for the current page
  76                                 $rootline = $sysPage->getRootLine($pageId, '', TRUE);
  77                         }
  78                         // This generates the constants/config + hierarchy info for the template.
  79                         $template->runThroughTemplates($rootline, 0);
  80                         $template->generateConfig();
  81                         $this->typoScriptSetupCache[$pageId] = $template->setup;
  82                 }
  83                 return $this->typoScriptSetupCache[$pageId];
  84         }
  85
  86         /**
  87          * Returns the TypoScript configuration found in module.tx_yourextension_yourmodule
  88          * merged with the global configuration of your extension from module.tx_yourextension
  89          *
  90          * @param string $extensionName
  91          * @param string $pluginName in BE mode this is actually the module signature. But we're using it just like the plugin name in FE
  92          * @return array
  93          */
  94         protected function getPluginConfiguration($extensionName, $pluginName = NULL) {
  95                 $setup = $this->getTypoScriptSetup();
  96                 $pluginConfiguration = array();
  97                 if (is_array($setup['module.']['tx_' . strtolower($extensionName) . '.'])) {
  98                         $pluginConfiguration = $this->typoScriptService->convertTypoScriptArrayToPlainArray($setup['module.']['tx_' . strtolower($extensionName) . '.']);
  99                 }
 100                 if ($pluginName !== NULL) {
 101                         $pluginSignature = strtolower($extensionName . '_' . $pluginName);
 102                         if (is_array($setup['module.']['tx_' . $pluginSignature . '.'])) {
 103                                 $pluginConfiguration = \TYPO3\CMS\Core\Utility\GeneralUtility::array_merge_recursive_overrule($pluginConfiguration, $this->typoScriptService->convertTypoScriptArrayToPlainArray($setup['module.']['tx_' . $pluginSignature . '.']));
 104                         }
 105                 }
 106                 return $pluginConfiguration;
 107         }
 108
 109         /**
 110          * Returns the configured controller/action pairs of the specified module in the format
 111          * array(
 112          * 'Controller1' => array('action1', 'action2'),
 113          * 'Controller2' => array('action3', 'action4')
 114          * )
 115          *
 116          * @param string $extensionName
 117          * @param string $pluginName in BE mode this is actually the module signature. But we're using it just like the plugin name in FE
 118          * @return array
 119          */
 120         protected function getSwitchableControllerActions($extensionName, $pluginName) {
 121                 $switchableControllerActions = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['extbase']['extensions'][$extensionName]['modules'][$pluginName]['controllers'];
 122                 if (!is_array($switchableControllerActions)) {
 123                         $switchableControllerActions = array();
 124                 }
 125                 return $switchableControllerActions;
 126         }
 127
 128         /**
 129          * Returns the page uid of the current page.
 130          * If no page is selected, we'll return the uid of the first root page.
 131          *
 132          * @return integer current page id. If no page is selected current root page id is returned
 133          */
 134         protected function getCurrentPageId() {
 135                 $pageId = (integer) \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('id');
 136                 if ($pageId > 0) {
 137                         return $pageId;
 138                 }
 139                 // get current site root
 140                 $rootPages = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('uid', 'pages', 'deleted=0 AND hidden=0 AND is_siteroot=1', '', '', '1');
 141                 if (count($rootPages) > 0) {
 142                         return $rootPages[0]['uid'];
 143                 }
 144                 // get root template
 145                 $rootTemplates = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('pid', 'sys_template', 'deleted=0 AND hidden=0 AND root=1', '', '', '1');
 146                 if (count($rootTemplates) > 0) {
 147                         return $rootTemplates[0]['pid'];
 148                 }
 149                 // fallback
 150                 return self::DEFAULT_BACKEND_STORAGE_PID;
 151         }
 152
 153         /**
 154          * Returns the default backend storage pid
 155          *
 156          * @return string
 157          */
 158         public function getDefaultBackendStoragePid() {
 159                 return $this->getCurrentPageId();
 160         }
 161
 162         /**
 163          * We need to set some default request handler if the framework configuration
 164          * could not be loaded; to make sure Extbase also works in Backend modules
 165          * in all contexts.
 166          *
 167          * @param array $frameworkConfiguration
 168          * @return array
 169          */
 170         protected function getContextSpecificFrameworkConfiguration(array $frameworkConfiguration) {
 171                 if (!isset($frameworkConfiguration['mvc']['requestHandlers'])) {
 172                         $frameworkConfiguration['mvc']['requestHandlers'] = array(
 173                                 'TYPO3\\CMS\\Extbase\\Mvc\\Web\\FrontendRequestHandler' => 'TYPO3\\CMS\\Extbase\\Mvc\\Web\\FrontendRequestHandler',
 174                                 'TYPO3\\CMS\\Extbase\\Mvc\\Web\\BackendRequestHandler' => 'TYPO3\\CMS\\Extbase\\Mvc\\Web\\BackendRequestHandler'
 175                         );
 176                 }
 177                 return $frameworkConfiguration;
 178         }
 179
 180
 181         /**
 182          * Returns a comma separated list of storagePid that are below a certain storage pid.
 183          *
 184          *
 185          * @param string $storagePid Storage PID to start at; multiple PIDs possible as comma-separated list
 186          * @param integer $recursionDepth Maximum number of levels to search, 0 to disable recursive lookup
 187          * @return string storage PIDs
 188          */
 189         protected function getRecursiveStoragePids($storagePid, $recursionDepth = 0) {
 190                 if ($recursionDepth <= 0) {
 191                         return $storagePid;
 192                 }
 193
 194                 $recursiveStoragePids = '';
 195                 $storagePids = \TYPO3\CMS\Core\Utility\GeneralUtility::intExplode(',', $storagePid);
 196                 foreach ($storagePids as $startPid) {
 197                         $pids = $this->queryGenerator->getTreeList($startPid, $recursionDepth, 0, 1);
 198                         if (strlen($pids) > 0) {
 199                                 $recursiveStoragePids .= $pids . ',';
 200                         }
 201                 }
 202
 203                 return rtrim($recursiveStoragePids, ',');
 204         }
 205
 206 }
 207
 208 ?>