├── Build ├── php-cs-fixer.php ├── phpstan.neon ├── phpstan11.neon └── phpstan12.neon ├── Classes ├── Configuration │ └── PackageHelper.php ├── TsConfig │ └── Loader.php └── TypoScript │ ├── AddTypoScriptFromSiteExtensionEvent.php │ └── Loader.php ├── Configuration ├── Services.yaml ├── SiteConfiguration │ └── Overrides │ │ └── sites.php └── user.tsconfig ├── LICENSE ├── README.md ├── Resources └── Public │ └── Icons │ └── Extension.svg ├── composer.json ├── ext_emconf.php ├── ext_localconf.php └── ext_tables.php /Build/php-cs-fixer.php: -------------------------------------------------------------------------------- 1 | getFinder()->in(__DIR__); 5 | return $config; 6 | -------------------------------------------------------------------------------- /Build/phpstan.neon: -------------------------------------------------------------------------------- 1 | includes: 2 | - ../vendor/saschaegerer/phpstan-typo3/extension.neon 3 | parameters: 4 | level: 5 5 | paths: 6 | - %currentWorkingDirectory%/Classes 7 | excludePaths: 8 | - %currentWorkingDirectory%/Classes/TypoScript/Loader.php 9 | ignoreErrors: 10 | - '#.*unknown class TYPO3\\CMS\\Core\\Configuration\\Event\\ModifyLoadedPageTsConfigEvent.#' 11 | - '#.*invalid type TYPO3\\CMS\\Core\\Configuration\\Event\\ModifyLoadedPageTsConfigEvent.#' 12 | -------------------------------------------------------------------------------- /Build/phpstan11.neon: -------------------------------------------------------------------------------- 1 | includes: 2 | - ../vendor/saschaegerer/phpstan-typo3/extension.neon 3 | parameters: 4 | level: 5 5 | paths: 6 | - %currentWorkingDirectory%/Classes 7 | 8 | ignoreErrors: 9 | - '#.*unknown class TYPO3\\CMS\\Core\\TypoScript\\IncludeTree\\Event\\ModifyLoadedPageTsConfigEvent.#' 10 | - '#.*invalid type TYPO3\\CMS\\Core\\TypoScript\\IncludeTree\\Event\\ModifyLoadedPageTsConfigEvent.#' 11 | - '#.*unknown class TYPO3\\CMS\\Core\\TypoScript\\IncludeTree\\Event\\AfterTemplatesHaveBeenDeterminedEvent.#' 12 | - '#.*invalid type TYPO3\\CMS\\Core\\TypoScript\\IncludeTree\\Event\\AfterTemplatesHaveBeenDeterminedEvent.#' 13 | -------------------------------------------------------------------------------- /Build/phpstan12.neon: -------------------------------------------------------------------------------- 1 | includes: 2 | - ../vendor/saschaegerer/phpstan-typo3/extension.neon 3 | parameters: 4 | level: 5 5 | paths: 6 | - %currentWorkingDirectory%/Classes 7 | -------------------------------------------------------------------------------- /Classes/Configuration/PackageHelper.php: -------------------------------------------------------------------------------- 1 | packageManager = $packageManager; 41 | $this->siteFinder = $siteFinder; 42 | } 43 | 44 | public function getSitePackage(int $rootPageId): ?PackageInterface 45 | { 46 | try { 47 | return $this->getSitePackageFromSite( 48 | $this->siteFinder->getSiteByRootPageId($rootPageId) 49 | ); 50 | } catch (SiteNotFoundException $e) { 51 | return null; 52 | } 53 | } 54 | 55 | public function getSitePackageFromSite(Site $site): ?PackageInterface 56 | { 57 | $configuration = $site->getConfiguration(); 58 | if (!isset($configuration['sitePackage'])) { 59 | return null; 60 | } 61 | $packageKey = (string)$configuration['sitePackage']; 62 | try { 63 | return $this->packageManager->getPackage($packageKey); 64 | } catch (UnknownPackageException $_) { 65 | return null; 66 | } 67 | } 68 | 69 | /** 70 | * "itemsProcFunc" method adding a list of available "site_*" extension 71 | * keys as select drop down items. Used in Site backend module. 72 | */ 73 | public function getSiteListForSiteModule(array &$fieldDefinition): void 74 | { 75 | $fieldDefinition['items'][] = [ 76 | '-- None --', 77 | '', 78 | ]; 79 | $currentValue = $fieldDefinition['row']['sitePackage'] ?? ''; 80 | $gotCurrentValue = false; 81 | foreach ($this->packageManager->getActivePackages() as $package) { 82 | $packageKey = $package->getPackageKey(); 83 | if (substr($packageKey, 0, 5) === 'site_') { 84 | $fieldDefinition['items'][] = [ 85 | 0 => $packageKey, 86 | 1 => $packageKey, 87 | ]; 88 | if ($currentValue === $packageKey) { 89 | $gotCurrentValue = true; 90 | } 91 | } 92 | } 93 | if (!$gotCurrentValue && $currentValue !== '') { 94 | $fieldDefinition['items'][] = [ 95 | 0 => $currentValue, 96 | 1 => $currentValue, 97 | ]; 98 | } 99 | } 100 | } 101 | -------------------------------------------------------------------------------- /Classes/TsConfig/Loader.php: -------------------------------------------------------------------------------- 1 | packageHelper = $packageHelper; 35 | } 36 | 37 | public function addSiteConfigurationCore11(LegacyModifyLoadedPageTsConfigEvent $event): void 38 | { 39 | if (class_exists(ModifyLoadedPageTsConfigEvent::class)) { 40 | // TYPO3 v12 calls both old and new event. Check for class existence of new event to 41 | // skip handling of old event in v12, but continue to work with < v12. 42 | // Simplify this construct when v11 compat is dropped, clean up Services.yaml. 43 | return; 44 | } 45 | $event->setTsConfig( 46 | $this->findAndAddConfiguration( 47 | $event->getRootLine(), 48 | $event->getTsConfig() 49 | ) 50 | ); 51 | } 52 | 53 | public function addSiteConfiguration(ModifyLoadedPageTsConfigEvent $event): void 54 | { 55 | $event->setTsConfig( 56 | $this->findAndAddConfiguration( 57 | $event->getRootLine(), 58 | $event->getTsConfig() 59 | ) 60 | ); 61 | } 62 | 63 | protected function findAndAddConfiguration(array $rootLine, array $tsConfig): array 64 | { 65 | foreach ($rootLine as $pageRecord) { 66 | $package = $this->packageHelper->getSitePackage((int)$pageRecord['uid']); 67 | if ($package === null && ($pageRecord['is_siteroot'] ?? false)) { 68 | // Translations of site roots will yield no $package when looking by root page or pageId 69 | $fullPageRecord = BackendUtility::getRecord('pages', (int)$pageRecord['uid']); 70 | $transOrigPointerField = $GLOBALS['TCA']['pages']['ctrl']['transOrigPointerField'] ?? 'l10n_parent'; 71 | if ($fullPageRecord[$transOrigPointerField] ?? false) { 72 | $package = $this->packageHelper->getSitePackage((int)$fullPageRecord[$transOrigPointerField]); 73 | } 74 | } 75 | if ($package !== null) { 76 | $tsConfigFile = $package->getPackagePath() . 'Configuration/PageTs/main.tsconfig'; 77 | if (!file_exists($tsConfigFile)) { 78 | $tsConfigFile = $package->getPackagePath() . 'Configuration/PageTsConfig/main.tsconfig'; 79 | } 80 | if (file_exists($tsConfigFile)) { 81 | $fileContents = @file_get_contents($tsConfigFile); 82 | if (!isset($tsConfig['uid_' . $pageRecord['uid']])) { 83 | $tsConfig['uid_' . $pageRecord['uid']] = ''; 84 | } 85 | $tsConfig['uid_' . $pageRecord['uid']] .= LF . $fileContents; 86 | } 87 | } 88 | } 89 | return $tsConfig; 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /Classes/TypoScript/AddTypoScriptFromSiteExtensionEvent.php: -------------------------------------------------------------------------------- 1 | = v12 25 | */ 26 | final class AddTypoScriptFromSiteExtensionEvent 27 | { 28 | protected PackageHelper $packageHelper; 29 | 30 | public function __construct(PackageHelper $packageHelper) 31 | { 32 | $this->packageHelper = $packageHelper; 33 | } 34 | 35 | public function __invoke(AfterTemplatesHaveBeenDeterminedEvent $event): void 36 | { 37 | $site = $event->getSite(); 38 | if (!$site instanceof Site) { 39 | return; 40 | } 41 | $package = $this->packageHelper->getSitePackageFromSite($site); 42 | if ($package === null) { 43 | return; 44 | } 45 | 46 | $constantsFile = $package->getPackagePath() . 'Configuration/TypoScript/constants.typoscript'; 47 | $setupFile = $package->getPackagePath() . 'Configuration/TypoScript/setup.typoscript'; 48 | if (!file_exists($constantsFile)) { 49 | $constantsFile = $package->getPackagePath() . 'Configuration/TypoScript/constants.txt'; 50 | } 51 | if (!file_exists($setupFile)) { 52 | $setupFile = $package->getPackagePath() . 'Configuration/TypoScript/setup.txt'; 53 | } 54 | 55 | $constants = null; 56 | if (file_exists($constantsFile)) { 57 | $constants = (string)@file_get_contents($constantsFile); 58 | } 59 | $setup = null; 60 | if (file_exists($setupFile)) { 61 | $setup = (string)@file_get_contents($setupFile); 62 | } 63 | 64 | if (empty($constants) && empty($setup)) { 65 | return; 66 | } 67 | 68 | $siteRootPageId = $site->getRootPageId(); 69 | $rootline = $event->getRootline(); 70 | $sysTemplateRows = $event->getTemplateRows(); 71 | 72 | $highestUid = 1; 73 | foreach ($sysTemplateRows as $sysTemplateRow) { 74 | if ((int)($sysTemplateRow['uid'] ?? 0) > $highestUid) { 75 | $highestUid = (int)$sysTemplateRow['uid']; 76 | } 77 | } 78 | 79 | $fakeRow = [ 80 | 'uid' => $highestUid + 1, 81 | 'pid' => $siteRootPageId, 82 | 'title' => 'Site extension include EXT:' . $package->getPackageKey() . ' by EXT:bolt', 83 | 'root' => 1, 84 | 'clear' => 3, 85 | 'include_static_file' => null, 86 | 'constants' => (string)$constants, 87 | 'config' => (string)$setup, 88 | // Add a flag. This might be useful for other event listeners that may want to manipulate again. 89 | 'isExtBoltFakeRow' => true, 90 | ]; 91 | // Set various "db" fields conditionally to be as robust as possible in case 92 | // core or some other loaded extension fiddles with them. 93 | $deleteField = $GLOBALS['TCA']['sys_template']['ctrl']['delete'] ?? null; 94 | if ($deleteField) { 95 | $fakeRow[$deleteField] = 0; 96 | } 97 | $disableField = $GLOBALS['TCA']['sys_template']['ctrl']['enablecolumns']['disabled'] ?? null; 98 | if ($disableField) { 99 | $fakeRow[$disableField] = 0; 100 | } 101 | $endtimeField = $GLOBALS['TCA']['sys_template']['ctrl']['enablecolumns']['endtime'] ?? null; 102 | if ($endtimeField) { 103 | $fakeRow[$endtimeField] = 0; 104 | } 105 | $starttimeField = $GLOBALS['TCA']['sys_template']['ctrl']['enablecolumns']['starttime'] ?? null; 106 | if ($starttimeField) { 107 | $fakeRow[$starttimeField] = 0; 108 | } 109 | $sortbyField = $GLOBALS['TCA']['sys_template']['ctrl']['sortby'] ?? null; 110 | if ($sortbyField) { 111 | $fakeRow[$sortbyField] = 0; 112 | } 113 | $tstampField = $GLOBALS['TCA']['sys_template']['ctrl']['tstamp'] ?? null; 114 | if ($tstampField) { 115 | $fakeRow[$tstampField] = ($setup ? filemtime($setupFile) : null) ?? ($constants ? filemtime($constantsFile) : null) ?? time(); 116 | } 117 | if ($GLOBALS['TCA']['sys_template']['columns']['basedOn'] ?? false) { 118 | $fakeRow['basedOn'] = null; 119 | } 120 | if ($GLOBALS['TCA']['sys_template']['columns']['includeStaticAfterBasedOn'] ?? false) { 121 | $fakeRow['includeStaticAfterBasedOn'] = 0; 122 | } 123 | if ($GLOBALS['TCA']['sys_template']['columns']['static_file_mode'] ?? false) { 124 | $fakeRow['static_file_mode'] = 0; 125 | } 126 | 127 | if (empty($sysTemplateRows)) { 128 | // Simple things first: If there are no sys_template records yet, add our fake row and done. 129 | $sysTemplateRows[] = $fakeRow; 130 | $event->setTemplateRows($sysTemplateRows); 131 | return; 132 | } 133 | 134 | // When there are existing sys_template rows, we try to add our fake row at the most useful position. 135 | $newSysTemplateRows = []; 136 | $pidsBeforeSite = [0]; 137 | $reversedRootline = array_reverse($rootline); 138 | foreach ($reversedRootline as $page) { 139 | if (($page['uid'] ?? 0) !== $siteRootPageId) { 140 | $pidsBeforeSite[] = (int)($page['uid'] ?? 0); 141 | } else { 142 | break; 143 | } 144 | } 145 | $pidsBeforeSite = array_unique($pidsBeforeSite); 146 | 147 | $fakeRowAdded = false; 148 | foreach ($sysTemplateRows as $sysTemplateRow) { 149 | if ($fakeRowAdded) { 150 | // We added the fake row already. Just add all other templates below this. 151 | $newSysTemplateRows[] = $sysTemplateRow; 152 | continue; 153 | } 154 | if (in_array((int)($sysTemplateRow['pid'] ?? 0), $pidsBeforeSite)) { 155 | $newSysTemplateRows[] = $sysTemplateRow; 156 | // If there is a sys_template row *before* our site, we assume settings from above 157 | // templates should "fall through", so we unset the clear flags. If this is not 158 | // wanted, an instance may need to register another event listener after this one 159 | // to set the clear flag again. 160 | $fakeRow['clear'] = 0; 161 | } elseif ((int)($sysTemplateRow['pid'] ?? 0) === $siteRootPageId) { 162 | // There is a sys_template on the site root page already. We add our fake row before 163 | // this one, then force the root and the clear flag of the sys_template row to 0. 164 | $newSysTemplateRows[] = $fakeRow; 165 | $fakeRowAdded = true; 166 | $sysTemplateRow['root'] = 0; 167 | $sysTemplateRow['clear'] = 0; 168 | $newSysTemplateRows[] = $sysTemplateRow; 169 | } else { 170 | // Not a sys_template row before, not an sys_template record on same page. Add our 171 | // fake row and mark we added it. 172 | $newSysTemplateRows[] = $fakeRow; 173 | $newSysTemplateRows[] = $sysTemplateRow; 174 | $fakeRowAdded = true; 175 | } 176 | } 177 | $event->setTemplateRows($newSysTemplateRows); 178 | } 179 | } 180 | -------------------------------------------------------------------------------- /Classes/TypoScript/Loader.php: -------------------------------------------------------------------------------- 1 | = 8.6.0 and <= 11, with TYPO3 v12 event kicks in. 23 | */ 24 | class Loader 25 | { 26 | /** 27 | * @var PackageHelper 28 | */ 29 | protected $packageHelper; 30 | 31 | public function __construct(PackageHelper $packageHelper) 32 | { 33 | $this->packageHelper = $packageHelper; 34 | } 35 | 36 | /** 37 | * $hookParameters = [ 38 | * 'extensionStaticsProcessed' => &$this->extensionStaticsProcessed, 39 | * 'isDefaultTypoScriptAdded' => &$this->isDefaultTypoScriptAdded, 40 | * 'absoluteRootLine' => &$this->absoluteRootLine, 41 | * 'rootLine' => &$this->rootLine, 42 | * 'startTemplateUid' => $start_template_uid, 43 | * ]; 44 | * @param array $hookParameters 45 | * @param TemplateService $templateService 46 | */ 47 | public function addSiteConfiguration(&$hookParameters, TemplateService $templateService): void 48 | { 49 | // let's copy the rootline value, as $templateService->processTemplate() might reset it 50 | $rootLine = $hookParameters['rootLine'] ?? null; 51 | if (!is_array($rootLine) || empty($rootLine)) { 52 | return; 53 | } 54 | 55 | if (GeneralUtility::makeInstance(Typo3Version::class)->getMajorVersion() >= 12) { 56 | // TYPO3 12.0 still has hook 'runThroughTemplatesPostProcessing', but we use the 57 | // event already. This if can be removed when TYPO3 12.1 has been released and 58 | // the hook is removed in the core. 59 | return; 60 | } 61 | 62 | foreach ($rootLine as $level => $pageRecord) { 63 | $package = $this->packageHelper->getSitePackage((int)$pageRecord['uid']); 64 | if ($package !== null) { 65 | $constantsFile = $package->getPackagePath() . 'Configuration/TypoScript/constants.typoscript'; 66 | $setupFile = $package->getPackagePath() . 'Configuration/TypoScript/setup.typoscript'; 67 | if (!file_exists($constantsFile)) { 68 | $constantsFile = $package->getPackagePath() . 'Configuration/TypoScript/constants.txt'; 69 | } 70 | if (!file_exists($setupFile)) { 71 | $setupFile = $package->getPackagePath() . 'Configuration/TypoScript/setup.txt'; 72 | } 73 | 74 | if (file_exists($constantsFile)) { 75 | $constants = (string)@file_get_contents($constantsFile); 76 | } else { 77 | $constants = ''; 78 | } 79 | if (file_exists($setupFile)) { 80 | $setup = (string)@file_get_contents($setupFile); 81 | } else { 82 | $setup = ''; 83 | } 84 | 85 | $hasRootTemplate = (bool)$templateService->getRootId(); 86 | $fakeRow = [ 87 | 'config' => $setup, 88 | 'constants' => $constants, 89 | 'nextLevel' => 0, 90 | 'static_file_mode' => 1, 91 | 'tstamp' => $setup ? filemtime($setupFile) : time(), 92 | 'uid' => 'sys_bolt_' . (int)$pageRecord['uid'] . $package->getPackageKey(), 93 | 'title' => $package->getPackageKey(), 94 | // make this the root template 95 | 'root' => !$hasRootTemplate, 96 | ]; 97 | $templateService->processTemplate($fakeRow, 'sys_bolt_' . $package->getPackageKey(), (int)$pageRecord['uid'], 'sys_bolt_' . $package->getPackageKey()); 98 | 99 | if (!$hasRootTemplate) { 100 | // $templateService->processTemplate() adds the constants and setup info 101 | // to the very end however, we like to add ours add root template 102 | array_pop($templateService->constants); 103 | array_unshift($templateService->constants, $constants); 104 | array_pop($templateService->config); 105 | array_unshift($templateService->config, $setup); 106 | // when having the 'root' flag, set $processTemplate resets the rootline -> we don't want that. 107 | $hookParameters['rootLine'] = $rootLine; 108 | } 109 | } 110 | } 111 | } 112 | } 113 | -------------------------------------------------------------------------------- /Configuration/Services.yaml: -------------------------------------------------------------------------------- 1 | services: 2 | _defaults: 3 | autowire: true 4 | autoconfigure: true 5 | public: false 6 | 7 | B13\Bolt\: 8 | resource: '../Classes/*' 9 | 10 | B13\Bolt\Configuration\PackageHelper: 11 | public: true 12 | 13 | B13\Bolt\TsConfig\Loader: 14 | public: true 15 | tags: 16 | # Remove when TYPO3 v11 compat is dropped 17 | - name: event.listener 18 | identifier: 'add-site-configuration-v11' 19 | event: TYPO3\CMS\Core\Configuration\Event\ModifyLoadedPageTsConfigEvent 20 | method: 'addSiteConfigurationCore11' 21 | # TYPO3 v12 and above 22 | - name: event.listener 23 | identifier: 'add-site-configuration' 24 | event: TYPO3\CMS\Core\TypoScript\IncludeTree\Event\ModifyLoadedPageTsConfigEvent 25 | method: 'addSiteConfiguration' 26 | 27 | B13\Bolt\TypoScript\Loader: 28 | public: true 29 | 30 | B13\Bolt\TypoScript\AddTypoScriptFromSiteExtensionEvent: 31 | public: true 32 | tags: 33 | - name: event.listener 34 | identifier: 'b13-bolt/add-typoscript-from-site-extension' 35 | -------------------------------------------------------------------------------- /Configuration/SiteConfiguration/Overrides/sites.php: -------------------------------------------------------------------------------- 1 | 'Site package of this site', 13 | 'description' => '[EXT:bolt] Attached site extension with TypoScript and TsConfig entry points', 14 | 'config' => [ 15 | 'type' => 'select', 16 | 'renderType' => 'selectSingle', 17 | 'itemsProcFunc' => \B13\Bolt\Configuration\PackageHelper::class . '->getSiteListForSiteModule', 18 | ], 19 | ]; 20 | $GLOBALS['SiteConfiguration']['site']['palettes']['default']['showitem'] .= ', 21 | sitePackage, 22 | '; 23 | -------------------------------------------------------------------------------- /Configuration/user.tsconfig: -------------------------------------------------------------------------------- 1 | # default user ts config for v13 2 | # Hide tstemplate "Edit TypoScript record" and "Constant Editor" in core v12 3 | options.hideModules := addToList(web_typoscript_infomodify, web_typoscript_constanteditor) 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Easier Integrations for TYPO3 sites 2 | 3 | 4 | ## Introduction 5 | 6 | This package is a TYPO3 extension that makes integration work easier. 7 | 8 | Simply put, the extension allows running a TYPO3 instance without any 9 | database driven TypoScript template (sys_template) records and without 10 | PageTsConfig page record entries, enabling file-driven (as in: not database-driven) 11 | deployment of TypoScript and PageTsConfig. This is done by connecting a Site configuration 12 | (those `.yaml` site configuration files) with a "Site extension" and using some simple 13 | events or hooks of the TYPO3 core. 14 | 15 | 16 | ## Background 17 | 18 | We consider it best practice to run a site and all custom Backend Layouts, TypoScript, PageTS, 19 | Fluid templates and similar in one place: In a "site extension". We prefix them with "site_", something 20 | like `site_myproject`. This site extension is the general entry point for configuration of a 21 | single Site page tree. 22 | 23 | The "bolt" extension provides a Site configuration setting called "sitePackage" that connects a 24 | Site with this site package / extension. This is simply an entry in the Site's .yaml 25 | file, and can be manually added to the file, or clicked in the TYPO3 "Sites" Backend module. 26 | 27 | Providing "everything" as files without database records is in general possible for nearly 28 | everything in current TYPO3, except for sys_template records and PageTsConfig settings. The 29 | extension thus provides some hooks that look up the connected "site extension" of a site, 30 | to TypoScript "constants" and "setup", as well as PageTsConfig, from files, provided 31 | by the site extension. This avoids these database entries. 32 | 33 | 34 | ## Installation 35 | 36 | * Require the extension via composer (`composer require b13/bolt`) or load it from 37 | [TER](https://extensions.typo3.org/extension/bolt/) (extension name "bolt") using the 38 | extension manager. 39 | 40 | * Create a site extension, having at least a composer.json and an ext_emconf.php file, 41 | prefixed with `site_`. Have this extension loaded. 42 | 43 | * Either manually edit the Site Configuration `.yaml` file and add `sitePackage: ''` 44 | as top-level key, or edit the Site Configuration in the Backend "Sites" module, select 45 | the site package / extension in the drop and save it. 46 | 47 | * Add extension file `Configuration/TypoScript/constants.typoscript`. This is the main 48 | TypoScript "constants / settings" entry point for this Site in the page tree. It should 49 | typically contain `@import` lines to load further "static includes" from other extensions 50 | as well as own TypoScript provided by the site extension itself. This file is automatically 51 | loaded by convention using a hook or event of the bolt extension. Since TYPO3 v12, the Backend 52 | "Template Analyzer" reflects such includes. 53 | 54 | * Add extension file `Configuration/TypoScript/setup.typoscript`. This is the main TypoScript "setup" 55 | entry point for this Site in the page tree. It should typically contain `@import` lines to load further 56 | "static includes" from other extensions as well as own TypoScript provided by the site extension itself. 57 | This file is automatically loaded by convention using a hook or event of the bolt extension. Since 58 | TYPO3 v12, the Backend "Template Analyzer" reflects such includes. 59 | 60 | * Add extension file `Configuration/PageTs/main.tsconfig` (if needed). This is the main PageTsConfig entry 61 | point for this Site in the page tree. It should typically contain further `@import` lines. This file is 62 | automatically loaded by convention using a hook or event of the bolt extension. 63 | 64 | * Add further files like Frontend rendering Templates, ViewHelper classes or TCA overrides as needed: Make 65 | the site extension the single entry point of your Site configuration that provides all site specific 66 | settings! 67 | 68 | 69 | ## Disabled Backend settings 70 | 71 | Extension `bolt` adds default PageTsConfig that disallows adding new `sys_template` records in the 72 | backend, and it hides the `PageTsConfig` related fields when editing page records. Those defaults are 73 | added in `ext_tables.php`, they follow our best practices, but can be rewritten again if really needed. 74 | 75 | 76 | ## License 77 | 78 | The extension is licensed under GPL v2+, same as the TYPO3 Core. See the LICENSE file. 79 | 80 | 81 | ## Sharing our expertise 82 | 83 | [Find more TYPO3 extensions we have developed](https://b13.com/useful-typo3-extensions-from-b13-to-you) that help 84 | us deliver value in client projects. As part of the way we work, we focus on testing and best practices to ensure 85 | long-term performance, reliability, and results in all our code. 86 | -------------------------------------------------------------------------------- /Resources/Public/Icons/Extension.svg: -------------------------------------------------------------------------------- 1 | 2 | 4 | 10 | 11 | EXT:bolt 12 | 13 | 20 | 22 | 24 | 26 | 27 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "b13/bolt", 3 | "type": "typo3-cms-extension", 4 | "description": "Bolt - An easy TYPO3 integration basis", 5 | "homepage": "https://github.com/b13/bolt", 6 | "license": "GPL-2.0-or-later", 7 | "keywords": ["TYPO3 CMS", "Integrators", "Site Extension", "Site Package", "TypoScript"], 8 | "require": { 9 | "php": "^7.4 || ^8.0", 10 | "typo3/cms-core": "^11.0 || ^12.0 || ^13.1", 11 | "typo3/cms-backend": "^11.0 || ^12.0 || ^13.1" 12 | }, 13 | "replace": { 14 | "cmsexperts/bolt": "*", 15 | "typo3-ter/bolt": "*" 16 | }, 17 | "extra": { 18 | "typo3/cms": { 19 | "extension-key": "bolt" 20 | } 21 | }, 22 | "autoload": { 23 | "psr-4": { 24 | "B13\\Bolt\\": "Classes" 25 | } 26 | }, 27 | "require-dev": { 28 | "saschaegerer/phpstan-typo3": "^1.8", 29 | "typo3/coding-standards": "^0.5.5", 30 | "typo3/tailor": "^1.1" 31 | }, 32 | "config": { 33 | "sort-packages": true, 34 | "allow-plugins": { 35 | "typo3/cms-composer-installers": true, 36 | "typo3/class-alias-loader": true 37 | } 38 | }, 39 | "scripts": { 40 | "php:cs": "@composer exec 'php-cs-fixer fix --config=Build/php-cs-fixer.php'" 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /ext_emconf.php: -------------------------------------------------------------------------------- 1 | 'Bolt - An easy TYPO3 integration basis', 5 | 'description' => 'Connect a Site configuration to a Site package / extension', 6 | 'category' => 'fe', 7 | 'version' => '2.3.1', 8 | 'state' => 'stable', 9 | 'clearcacheonload' => true, 10 | 'author' => 'Benni Mack', 11 | 'author_email' => 'typo3@b13.com', 12 | 'author_company' => 'b13 GmbH', 13 | 'constraints' => [ 14 | 'depends' => [ 15 | 'typo3' => '11.5.0-13.99.99', 16 | ], 17 | ], 18 | ]; 19 | -------------------------------------------------------------------------------- /ext_localconf.php: -------------------------------------------------------------------------------- 1 | addSiteConfiguration'; 8 | 9 | // v13 Page TS 10 | $pageTs = ' 11 | # Disable adding new sys_template records in list module 12 | mod.web_list.deniedNewTables := addToList(sys_template) 13 | 14 | # Hide TSconfig and tsconfig_includes fields when editing pages 15 | TCEFORM.pages.TSconfig.disabled=1 16 | TCEFORM.pages.tsconfig_includes.disabled=1 17 | '; 18 | 19 | if (isset($GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig'])) { 20 | $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig'] .= $pageTs; 21 | } else { 22 | $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig'] = $pageTs; 23 | } 24 | })(); 25 | -------------------------------------------------------------------------------- /ext_tables.php: -------------------------------------------------------------------------------- 1 | getMajorVersion() < 12) { 6 | // $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig'] is used for v13 7 | \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addPageTSConfig(' 8 | # Disable adding new sys_template records in list module 9 | mod.web_list.deniedNewTables := addToList(sys_template) 10 | 11 | # Hide tstemplate "Info/Modify" and "Constant Editor" in core v11 12 | mod.web_ts.menu.function.TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateConstantEditorModuleFunctionController = 0 13 | mod.web_ts.menu.function.TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController = 0 14 | 15 | # Hide TSconfig and tsconfig_includes fields when editing pages 16 | TCEFORM.pages.TSconfig.disabled=1 17 | TCEFORM.pages.tsconfig_includes.disabled=1 18 | '); 19 | 20 | // Configuration/user.tsconfig is used for v13 21 | \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addUserTSConfig(' 22 | # Hide tstemplate "Edit TypoScript record" and "Constant Editor" in core v12 23 | options.hideModules := addToList(web_typoscript_infomodify, web_typoscript_constanteditor) 24 | '); 25 | }; 26 | --------------------------------------------------------------------------------