[TASK] Make TS content templates more flexible
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / TypoScript / TemplateService.php
1 <?php
2 namespace TYPO3\CMS\Core\TypoScript;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 1999-2013 Kasper Skårhøj (kasperYYYY@typo3.com)
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 * A copy is found in the text file GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
20 *
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
29
30 use TYPO3\CMS\Core\Utility\GeneralUtility;
31
32 /**
33 * Template object that is responsible for generating the TypoScript template based on template records.
34 *
35 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
36 * @see \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser
37 * @see \TYPO3\CMS\Core\Configuration\TypoScript\ConditionMatching\AbstractConditionMatcher
38 */
39 class TemplateService {
40
41 // Debugging, analysis:
42 // If set, the global tt-timeobject is used to log the performance.
43 /**
44 * @todo Define visibility
45 */
46 public $tt_track = 1;
47
48 // If set, the template is always rendered. Used from Admin Panel.
49 /**
50 * @todo Define visibility
51 */
52 public $forceTemplateParsing = 0;
53
54 // Backend Analysis modules settings:
55 // This array is passed on to matchObj by generateConfig(). If it holds elements, they are used for matching instead. See commment at the match-class. Used for backend modules only. Never frontend!
56 /**
57 * @todo Define visibility
58 */
59 public $matchAlternative = array();
60
61 // If set, the match-class matches everything! Used for backend modules only. Never frontend!
62 /**
63 * @todo Define visibility
64 */
65 public $matchAll = 0;
66
67 /**
68 * @todo Define visibility
69 */
70 public $backend_info = 0;
71
72 // Set from the backend - used to set an absolute path (PATH_site) so that relative resources are properly found with getFileName()
73 /**
74 * @todo Define visibility
75 */
76 public $getFileName_backPath = '';
77
78 // Externally set breakpoints (used by Backend Modules)
79 /**
80 * @todo Define visibility
81 */
82 public $ext_constants_BRP = 0;
83
84 /**
85 * @todo Define visibility
86 */
87 public $ext_config_BRP = 0;
88
89 /**
90 * @todo Define visibility
91 */
92 public $ext_regLinenumbers = FALSE;
93
94 /**
95 * @todo Define visibility
96 */
97 public $ext_regComments = FALSE;
98
99 // Constants:
100 /**
101 * @todo Define visibility
102 */
103 public $tempPath = 'typo3temp/';
104
105 // Set Internally:
106 // This MUST be initialized by the init() function
107 /**
108 * @todo Define visibility
109 */
110 public $whereClause = '';
111
112 /**
113 * @todo Define visibility
114 */
115 public $debug = 0;
116
117 // This is the only paths (relative!!) that are allowed for resources in TypoScript. Should all be appended with '/'. You can extend these by the global array TYPO3_CONF_VARS. See init() function.
118 /**
119 * @todo Define visibility
120 */
121 public $allowedPaths = array();
122
123 // See init(); Set if preview of some kind is enabled.
124 /**
125 * @todo Define visibility
126 */
127 public $simulationHiddenOrTime = 0;
128
129 // Set, if the TypoScript template structure is loaded and OK, see ->start()
130 /**
131 * @todo Define visibility
132 */
133 public $loaded = 0;
134
135 // Default TypoScript Setup code
136 /**
137 * @todo Define visibility
138 */
139 public $setup = array(
140 'styles.' => array(
141 'insertContent' => 'CONTENT',
142 'insertContent.' => array(
143 'table' => 'tt_content',
144 'select.' => array(
145 'orderBy' => 'sorting',
146 'where' => 'colPos=0',
147 'languageField' => 'sys_language_uid'
148 )
149 )
150 ),
151 'config.' => array(
152 'extTarget' => '_top',
153 'uniqueLinkVars' => 1
154 )
155 );
156
157 /**
158 * @todo Define visibility
159 */
160 public $flatSetup = array();
161
162 // Default TypoScript Constants code:
163 /**
164 * @todo Define visibility
165 */
166 public $const = array(
167 '_clear' => '<img src="clear.gif" width="1" height="1" alt="" />',
168 '_blackBorderWrap' => '<table border="0" bgcolor="black" cellspacing="0" cellpadding="1"><tr><td> | </td></tr></table>',
169 '_tableWrap' => '<table border="0" cellspacing="0" cellpadding="0"> | </table>',
170 '_tableWrap_DEBUG' => '<table border="1" cellspacing="0" cellpadding="0"> | </table>',
171 '_stdFrameParams' => 'frameborder="no" marginheight="0" marginwidth="0" noresize="noresize"',
172 '_stdFramesetParams' => 'border="0" framespacing="0" frameborder="no"'
173 );
174
175 // For fetching TypoScript code from template hierarchy before parsing it. Each array contains code field values from template records/files:
176 // Setup field
177 /**
178 * @todo Define visibility
179 */
180 public $config = array();
181
182 // Constant field
183 /**
184 * @todo Define visibility
185 */
186 public $constants = array();
187
188 // For Template Analyser in backend
189 /**
190 * @todo Define visibility
191 */
192 public $hierarchyInfo = array();
193
194 // For Template Analyser in backend (setup content only)
195 /**
196 * @todo Define visibility
197 */
198 public $hierarchyInfoToRoot = array();
199
200 // Next-level flag (see runThroughTemplates())
201 /**
202 * @todo Define visibility
203 */
204 public $nextLevel = 0;
205
206 // The Page UID of the root page
207 /**
208 * @todo Define visibility
209 */
210 public $rootId;
211
212 // The rootline from current page to the root page
213 /**
214 * @todo Define visibility
215 */
216 public $rootLine;
217
218 // Rootline all the way to the root. Set but runThroughTemplates
219 /**
220 * @todo Define visibility
221 */
222 public $absoluteRootLine;
223
224 // A pointer to the last entry in the rootline where a template was found.
225 /**
226 * @todo Define visibility
227 */
228 public $outermostRootlineIndexWithTemplate = 0;
229
230 // Array of arrays with title/uid of templates in hierarchy
231 /**
232 * @todo Define visibility
233 */
234 public $rowSum;
235
236 // The current site title field.
237 /**
238 * @todo Define visibility
239 */
240 public $sitetitle = '';
241
242 // Tracking all conditions found during parsing of TypoScript. Used for the "all" key in currentPageData
243 /**
244 * @todo Define visibility
245 */
246 public $sections;
247
248 // Tracking all matching conditions found
249 /**
250 * @todo Define visibility
251 */
252 public $sectionsMatch;
253
254 /**
255 * Used by Backend only (Typoscript Template Analyzer)
256 *
257 * @todo Define visibility
258 */
259 public $clearList_const = array();
260
261 /**
262 * Used by Backend only (Typoscript Template Analyzer)
263 *
264 * @todo Define visibility
265 */
266 public $clearList_setup = array();
267
268 /**
269 * @todo Define visibility
270 */
271 public $parserErrors = array();
272
273 /**
274 * @todo Define visibility
275 */
276 public $setup_constants = array();
277
278 // Other:
279 // Used by getFileName for caching of references to file resources
280 /**
281 * @todo Define visibility
282 */
283 public $fileCache = array();
284
285 // Keys are frame names and values are type-values, which must be used to refer correctly to the content of the frames.
286 /**
287 * @todo Define visibility
288 */
289 public $frames = array();
290
291 // Contains mapping of Page id numbers to MP variables.
292 /**
293 * @todo Define visibility
294 */
295 public $MPmap = '';
296
297 /**
298 * Indicator that extension statics are processed.
299 *
300 * These files are considered if either a root template
301 * has been processed or the $processExtensionStatics
302 * property has been set to TRUE.
303 *
304 * @var boolean
305 */
306 protected $extensionStaticsProcessed = FALSE;
307
308 /**
309 * Trigger value, to ensure that extension statics are processed.
310 *
311 * @var boolean
312 */
313 protected $processExtensionStatics = FALSE;
314
315 /**
316 * Set to TRUE after the default TypoScript was added during parsing.
317 * This prevents double inclusion of the same TypoScript code.
318 *
319 * @see addDefaultTypoScript()
320 * @var boolean
321 */
322 protected $isDefaultTypoScriptAdded = FALSE;
323
324 /**
325 * @return boolean
326 */
327 public function getProcessExtensionStatics() {
328 return $this->processExtensionStatics;
329 }
330
331 /**
332 * @param boolean $processExtensionStatics
333 */
334 public function setProcessExtensionStatics($processExtensionStatics) {
335 $this->processExtensionStatics = (bool) $processExtensionStatics;
336 }
337
338 /**
339 * Initialize
340 * MUST be called directly after creating a new template-object
341 *
342 * @return void
343 * @see \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::initTemplate()
344 * @todo Define visibility
345 */
346 public function init() {
347 // $this->whereClause is used only to select templates from sys_template.
348 // $GLOBALS['SIM_ACCESS_TIME'] is used so that we're able to simulate a later time as a test...
349 $this->whereClause = 'AND deleted=0 ';
350 if (!$GLOBALS['TSFE']->showHiddenRecords) {
351 $this->whereClause .= 'AND hidden=0 ';
352 }
353 if ($GLOBALS['TSFE']->showHiddenRecords || $GLOBALS['SIM_ACCESS_TIME'] != $GLOBALS['ACCESS_TIME']) {
354 // Set the simulation flag, if simulation is detected!
355 $this->simulationHiddenOrTime = 1;
356 }
357 $this->whereClause .= 'AND (starttime<=' . $GLOBALS['SIM_ACCESS_TIME'] . ') AND (endtime=0 OR endtime>' . $GLOBALS['SIM_ACCESS_TIME'] . ')';
358 // Sets the paths from where TypoScript resources are allowed to be used:
359 $this->allowedPaths = array(
360 'media/',
361 $GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'],
362 // fileadmin/ path
363 'uploads/',
364 'typo3temp/',
365 TYPO3_mainDir . 'ext/',
366 TYPO3_mainDir . 'sysext/',
367 TYPO3_mainDir . 'contrib/',
368 'typo3conf/ext/'
369 );
370 if ($GLOBALS['TYPO3_CONF_VARS']['FE']['addAllowedPaths']) {
371 $pathArr = GeneralUtility::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['FE']['addAllowedPaths'], TRUE);
372 foreach ($pathArr as $p) {
373 // Once checked for path, but as this may run from typo3/mod/web/ts/ dir, that'll not work!! So the paths ar uncritically included here.
374 $this->allowedPaths[] = $p;
375 }
376 }
377 }
378
379 /**
380 * Fetches the "currentPageData" array from cache
381 *
382 * NOTE about currentPageData:
383 * It holds information about the TypoScript conditions along with the list
384 * of template uid's which is used on the page. In the getFromCache function
385 * in TSFE, currentPageData is used to evaluate if there is a template and
386 * if the matching conditions are alright. Unfortunately this does not take
387 * into account if the templates in the rowSum of currentPageData has
388 * changed composition, eg. due to hidden fields or start/end time. So if a
389 * template is hidden or times out, it'll not be discovered unless the page
390 * is regenerated - at least the this->start function must be called,
391 * because this will make a new portion of data in currentPageData string.
392 *
393 * @return array Returns the unmatched array $currentPageData if found cached in "cache_pagesection". Otherwise FALSE is returned which means that the array must be generated and stored in the cache
394 */
395 public function getCurrentPageData() {
396 return $GLOBALS['typo3CacheManager']->getCache('cache_pagesection')->get((int)$GLOBALS['TSFE']->id . '_' . GeneralUtility::md5int($GLOBALS['TSFE']->MP));
397 }
398
399 /**
400 * Fetches data about which TypoScript-matches there are at this page. Then it performs a matchingtest.
401 *
402 * @param array $cc An array with three keys, "all", "rowSum" and "rootLine" - all coming from the "currentPageData" array
403 * @return array The input array but with a new key added, "match" which contains the items from the "all" key which when passed to tslib_matchCondition returned TRUE.
404 * @todo Define visibility
405 */
406 public function matching($cc) {
407 if (is_array($cc['all'])) {
408 /** @var $matchObj \TYPO3\CMS\Frontend\Configuration\TypoScript\ConditionMatching\ConditionMatcher */
409 $matchObj = GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\Configuration\\TypoScript\\ConditionMatching\\ConditionMatcher');
410 $matchObj->setRootline((array) $cc['rootLine']);
411 foreach ($cc['all'] as $key => $pre) {
412 if ($matchObj->match($pre)) {
413 $sectionsMatch[$key] = $pre;
414 }
415 }
416 $cc['match'] = $sectionsMatch;
417 }
418 return $cc;
419 }
420
421 /**
422 * This is all about fetching the right TypoScript template structure. If it's not cached then it must be generated and cached!
423 * The method traverses the rootline structure from out to in, fetches the hierarchy of template records and based on this either finds the cached TypoScript template structure or parses the template and caches it for next time.
424 * Sets $this->setup to the parsed TypoScript template array
425 *
426 * @param array $theRootLine The rootline of the current page (going ALL the way to tree root)
427 * @return void
428 * @see \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::getConfigArray()
429 * @todo Define visibility
430 */
431 public function start($theRootLine) {
432 if (is_array($theRootLine)) {
433 $setupData = '';
434 $hash = '';
435 // Flag that indicates that the existing data in cache_pagesection
436 // could be used (this is the case if $TSFE->all is set, and the
437 // rowSum still matches). Based on this we decide if cache_pagesection
438 // needs to be updated...
439 $isCached = FALSE;
440 $this->runThroughTemplates($theRootLine);
441 if ($GLOBALS['TSFE']->all) {
442 $cc = $GLOBALS['TSFE']->all;
443 // The two rowSums must NOT be different from each other - which they will be if start/endtime or hidden has changed!
444 if (serialize($this->rowSum) !== serialize($cc['rowSum'])) {
445 unset($cc);
446 } else {
447 // If $TSFE->all contains valid data, we don't need to update cache_pagesection (because this data was fetched from there already)
448 if (serialize($this->rootLine) === serialize($cc['rootLine'])) {
449 $isCached = TRUE;
450 }
451 // When the data is serialized below (ROWSUM hash), it must not contain the rootline by concept. So this must be removed (and added again later)...
452 unset($cc['rootLine']);
453 }
454 }
455 // This is about getting the hash string which is used to fetch the cached TypoScript template.
456 // If there was some cached currentPageData ($cc) then that's good (it gives us the hash).
457 if (is_array($cc)) {
458 // If currentPageData was actually there, we match the result (if this wasn't done already in $TSFE->getFromCache()...)
459 if (!$cc['match']) {
460 // TODO: check if this can ever be the case - otherwise remove
461 $cc = $this->matching($cc);
462 ksort($cc);
463 }
464 $hash = md5(serialize($cc));
465 } else {
466 // If currentPageData was not there, we first find $rowSum (freshly generated). After that we try to see, if it is stored with a list of all conditions. If so we match the result.
467 $rowSumHash = md5('ROWSUM:' . serialize($this->rowSum));
468 $result = \TYPO3\CMS\Frontend\Page\PageRepository::getHash($rowSumHash);
469 if (is_array($result)) {
470 $cc = array();
471 $cc['all'] = $result;
472 $cc['rowSum'] = $this->rowSum;
473 $cc = $this->matching($cc);
474 ksort($cc);
475 $hash = md5(serialize($cc));
476 }
477 }
478 if ($hash) {
479 // Get TypoScript setup array
480 $setupData = \TYPO3\CMS\Frontend\Page\PageRepository::getHash($hash);
481 }
482 if (is_array($setupData) && !$this->forceTemplateParsing) {
483 // If TypoScript setup structure was cached we unserialize it here:
484 $this->setup = $setupData;
485 if ($this->tt_track) {
486 $GLOBALS['TT']->setTSLogMessage('Using cached TS template data');
487 }
488 } else {
489 if ($this->tt_track) {
490 $GLOBALS['TT']->setTSLogMessage('Not using any cached TS data');
491 }
492
493 // Make configuration
494 $this->generateConfig();
495 // This stores the template hash thing
496 $cc = array();
497 // All sections in the template at this point is found
498 $cc['all'] = $this->sections;
499 // The line of templates is collected
500 $cc['rowSum'] = $this->rowSum;
501 $cc = $this->matching($cc);
502 ksort($cc);
503 $hash = md5(serialize($cc));
504 // This stores the data.
505 \TYPO3\CMS\Frontend\Page\PageRepository::storeHash($hash, $this->setup, 'TS_TEMPLATE');
506 if ($this->tt_track) {
507 $GLOBALS['TT']->setTSlogMessage('TS template size, serialized: ' . strlen(serialize($this->setup)) . ' bytes');
508 }
509 $rowSumHash = md5('ROWSUM:' . serialize($this->rowSum));
510 \TYPO3\CMS\Frontend\Page\PageRepository::storeHash($rowSumHash, $cc['all'], 'TMPL_CONDITIONS_ALL');
511 }
512 // Add rootLine
513 $cc['rootLine'] = $this->rootLine;
514 ksort($cc);
515 // Make global and save
516 $GLOBALS['TSFE']->all = $cc;
517 // Matching must be executed for every request, so this must never be part of the pagesection cache!
518 unset($cc['match']);
519 if (!$isCached && !$this->simulationHiddenOrTime && !$GLOBALS['TSFE']->no_cache) {
520 // Only save the data if we're not simulating by hidden/starttime/endtime
521 $mpvarHash = GeneralUtility::md5int($GLOBALS['TSFE']->MP);
522 /** @var $pageSectionCache \TYPO3\CMS\Core\Cache\Frontend\FrontendInterface */
523 $pageSectionCache = $GLOBALS['typo3CacheManager']->getCache('cache_pagesection');
524 $pageSectionCache->set((int)$GLOBALS['TSFE']->id . '_' . $mpvarHash, $cc, array(
525 'pageId_' . (int)$GLOBALS['TSFE']->id,
526 'mpvarHash_' . $mpvarHash
527 ));
528 }
529 // If everything OK.
530 if ($this->rootId && $this->rootLine && $this->setup) {
531 $this->loaded = 1;
532 }
533 }
534 }
535
536 /*******************************************************************
537 *
538 * Fetching TypoScript code text for the Template Hierarchy
539 *
540 *******************************************************************/
541 /**
542 * Traverses the rootLine from the root and out. For each page it checks if there is a template record. If there is a template record, $this->processTemplate() is called.
543 * Resets and affects internal variables like $this->constants, $this->config and $this->rowSum
544 * Also creates $this->rootLine which is a root line stopping at the root template (contrary to $GLOBALS['TSFE']->rootLine which goes all the way to the root of the tree
545 *
546 * @param array $theRootLine The rootline of the current page (going ALL the way to tree root)
547 * @param integer $start_template_uid Set specific template record UID to select; this is only for debugging/development/analysis use in backend modules like "Web > Template". For parsing TypoScript templates in the frontend it should be 0 (zero)
548 * @return void
549 * @see start()
550 * @todo Define visibility
551 */
552 public function runThroughTemplates($theRootLine, $start_template_uid = 0) {
553 $this->constants = array();
554 $this->config = array();
555 $this->rowSum = array();
556 $this->hierarchyInfoToRoot = array();
557 $this->absoluteRootLine = $theRootLine;
558 $this->isDefaultTyposcriptAdded = FALSE;
559
560 reset($this->absoluteRootLine);
561 $c = count($this->absoluteRootLine);
562 for ($a = 0; $a < $c; $a++) {
563 // If some template loaded before has set a template-id for the next level, then load this template first!
564 if ($this->nextLevel) {
565 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_template', 'uid=' . (int)$this->nextLevel . ' ' . $this->whereClause);
566 $this->nextLevel = 0;
567 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
568 $this->versionOL($row);
569 if (is_array($row)) {
570 $this->processTemplate($row, 'sys_' . $row['uid'], $this->absoluteRootLine[$a]['uid'], 'sys_' . $row['uid']);
571 $this->outermostRootlineIndexWithTemplate = $a;
572 }
573 }
574 $GLOBALS['TYPO3_DB']->sql_free_result($res);
575 }
576 $addC = '';
577 // If first loop AND there is set an alternative template uid, use that
578 if ($a == $c - 1 && $start_template_uid) {
579 $addC = ' AND uid=' . (int)$start_template_uid;
580 }
581 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_template', 'pid=' . (int)$this->absoluteRootLine[$a]['uid'] . $addC . ' ' . $this->whereClause, '', 'sorting', 1);
582 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
583 $this->versionOL($row);
584 if (is_array($row)) {
585 $this->processTemplate($row, 'sys_' . $row['uid'], $this->absoluteRootLine[$a]['uid'], 'sys_' . $row['uid']);
586 $this->outermostRootlineIndexWithTemplate = $a;
587 }
588 }
589 $GLOBALS['TYPO3_DB']->sql_free_result($res);
590 $this->rootLine[] = $this->absoluteRootLine[$a];
591 }
592
593 // Process extension static files if not done yet, but explicitly requested
594 if (!$this->extensionStaticsProcessed && $this->processExtensionStatics) {
595 $this->addExtensionStatics('sys_0', 'sys_0', 0, array());
596 }
597
598 // Add the global default TypoScript from the TYPO3_CONF_VARS
599 $this->addDefaultTypoScript();
600
601 $this->processIncludes();
602 }
603
604 /**
605 * Checks if the template ($row) has some included templates and after including them it fills the arrays with the setup
606 * Builds up $this->rowSum
607 *
608 * @param array $row A full TypoScript template record (sys_template/static_template/forged "dummy" record made from static template file)
609 * @param string $idList A list of already processed template ids including the current; The list is on the form "[prefix]_[uid]" where [prefix] is "sys" for "sys_template" records, "static" for "static_template" records and "ext_" for static include files (from extensions). The list is used to check that the recursive inclusion of templates does not go into circles: Simply it is used to NOT include a template record/file which has already BEEN included somewhere in the recursion.
610 * @param array $pid The PID of the input template record
611 * @param string $templateID The id of the current template. Same syntax as $idList ids, eg. "sys_123
612 * @param string $templateParent Parent template id (during recursive call); Same syntax as $idList ids, eg. "sys_123
613 * @return void
614 * @see runThroughTemplates()
615 * @todo Define visibility
616 */
617 public function processTemplate($row, $idList, $pid, $templateID = '', $templateParent = '') {
618 // Adding basic template record information to rowSum array
619 $this->rowSum[] = array($row['uid'], $row['title'], $row['tstamp']);
620 // Processing "Clear"-flags
621 if ($row['clear']) {
622 $clConst = $row['clear'] & 1;
623 $clConf = $row['clear'] & 2;
624 if ($clConst) {
625 $this->constants = array();
626 $this->clearList_const = array();
627 }
628 if ($clConf) {
629 $this->config = array();
630 $this->hierarchyInfoToRoot = array();
631 $this->clearList_setup = array();
632 }
633 }
634 // Include static records (static_template) or files (from extensions) (#1/2)
635 // NORMAL inclusion, The EXACT same code is found below the basedOn inclusion!!!
636 if (!$row['includeStaticAfterBasedOn']) {
637 $this->includeStaticTypoScriptSources($idList, $templateID, $pid, $row);
638 }
639 // Include "Based On" sys_templates:
640 // 'basedOn' is a list of templates to include
641 if (trim($row['basedOn'])) {
642 // Manually you can put this value in the field and then the based_on ID will be taken from the $_GET var defined by '=....'.
643 // Example: If $row['basedOn'] is 'EXTERNAL_BASED_ON_TEMPLATE_ID=based_on_uid', then the global var, based_on_uid - given by the URL like '&based_on_uid=999' - is included instead!
644 // This feature allows us a hack to test/demonstrate various included templates on the same set of content bearing pages. Used by the "freesite" extension.
645 $basedOn_hackFeature = explode('=', $row['basedOn']);
646 if ($basedOn_hackFeature[0] == 'EXTERNAL_BASED_ON_TEMPLATE_ID' && $basedOn_hackFeature[1]) {
647 $id = (int)GeneralUtility::_GET($basedOn_hackFeature[1]);
648 // If $id is not allready included ...
649 if ($id && !GeneralUtility::inList($idList, ('sys_' . $id))) {
650 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_template', 'uid=' . $id . ' ' . $this->whereClause);
651 // there was a template, then we fetch that
652 if ($subrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
653 $this->versionOL($subrow);
654 if (is_array($subrow)) {
655 $this->processTemplate($subrow, $idList . ',sys_' . $id, $pid, 'sys_' . $id, $templateID);
656 }
657 }
658 $GLOBALS['TYPO3_DB']->sql_free_result($res);
659 }
660 } else {
661 // Normal Operation, which is to include the "based-on" sys_templates,
662 // if they are not already included, and maintaining the sorting of the templates
663 $basedOnIds = GeneralUtility::intExplode(',', $row['basedOn']);
664 // skip template if it's already included
665 foreach ($basedOnIds as $key => $basedOnId) {
666 if (GeneralUtility::inList($idList, 'sys_' . $basedOnId)) {
667 unset($basedOnIds[$key]);
668 }
669 }
670 $subTemplates = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('*', 'sys_template', 'uid IN (' . implode(',', $basedOnIds) . ') ' . $this->whereClause, '', '', '', 'uid');
671 // Traversing list again to ensure the sorting of the templates
672 foreach ($basedOnIds as $id) {
673 if (is_array($subTemplates[$id])) {
674 $this->versionOL($subTemplates[$id]);
675 $this->processTemplate($subTemplates[$id], $idList . ',sys_' . $id, $pid, 'sys_' . $id, $templateID);
676 }
677 }
678 }
679 }
680 // Include static records (static_template) or files (from extensions) (#2/2)
681 if ($row['includeStaticAfterBasedOn']) {
682 $this->includeStaticTypoScriptSources($idList, $templateID, $pid, $row);
683 }
684 // Creating hierarchy information; Used by backend analysis tools
685 $this->hierarchyInfo[] = ($this->hierarchyInfoToRoot[] = array(
686 'root' => trim($row['root']),
687 'next' => $row['nextLevel'],
688 'clConst' => $clConst,
689 'clConf' => $clConf,
690 'templateID' => $templateID,
691 'templateParent' => $templateParent,
692 'title' => $row['title'],
693 'uid' => $row['uid'],
694 'pid' => $row['pid'],
695 'configLines' => substr_count($row['config'], LF) + 1
696 ));
697 // Adding the content of the fields constants (Constants) and config (Setup)
698 $this->constants[] = $row['constants'];
699 $this->config[] = $row['config'];
700 // For backend analysis (Template Analyser) provide the order of added constants/config template IDs
701 $this->clearList_const[] = $templateID;
702 $this->clearList_setup[] = $templateID;
703 if (trim($row['sitetitle'])) {
704 $this->sitetitle = $row['sitetitle'];
705 }
706 // If the template record is a Rootlevel record, set the flag and clear the template rootLine (so it starts over from this point)
707 if (trim($row['root'])) {
708 $this->rootId = $pid;
709 $this->rootLine = array();
710 }
711 // If a template is set to be active on the next level set this internal value to point to this UID. (See runThroughTemplates())
712 if ($row['nextLevel']) {
713 $this->nextLevel = $row['nextLevel'];
714 } else {
715 $this->nextLevel = 0;
716 }
717 }
718
719 /**
720 * This function can be used to update the data of the current rootLine
721 * e.g. when a different language is used.
722 *
723 * This function must not be used if there are different pages in the
724 * rootline as before!
725 *
726 * @param array $fullRootLine Array containing the FULL rootline (up to the TYPO3 root)
727 * @return void
728 * @throws \RuntimeException If the given $fullRootLine does not contain all pages that are in the current template rootline
729 */
730 public function updateRootlineData($fullRootLine) {
731 if (!is_array($this->rootLine) || count($this->rootLine) === 0) {
732 return;
733 }
734
735 $fullRootLineByUid = array();
736 foreach ($fullRootLine as $rootLineData) {
737 $fullRootLineByUid[$rootLineData['uid']] = $rootLineData;
738 }
739
740 foreach ($this->rootLine as $level => $dataArray) {
741 $currentUid = $dataArray['uid'];
742
743 if (!array_key_exists($currentUid, $fullRootLineByUid)) {
744 throw new \RuntimeException(sprintf('The full rootLine does not contain data for the page with the uid %d that is contained in the template rootline.', $currentUid), 1370419654);
745 }
746
747 $this->rootLine[$level] = $fullRootLineByUid[$currentUid];
748 }
749 }
750
751 /**
752 * Includes static template records (from static_template table, loaded through a hook) and static template files (from extensions) for the input template record row.
753 *
754 * @param string $idList A list of already processed template ids including the current; The list is on the form "[prefix]_[uid]" where [prefix] is "sys" for "sys_template" records, "static" for "static_template" records and "ext_" for static include files (from extensions). The list is used to check that the recursive inclusion of templates does not go into circles: Simply it is used to NOT include a template record/file which has already BEEN included somewhere in the recursion.
755 * @param string $templateID The id of the current template. Same syntax as $idList ids, eg. "sys_123
756 * @param array $pid The PID of the input template record
757 * @param array $row A full TypoScript template record
758 * @return void
759 * @see processTemplate()
760 * @todo Define visibility
761 */
762 public function includeStaticTypoScriptSources($idList, $templateID, $pid, $row) {
763 // Static Template Records (static_template): include_static is a list of static templates to include
764 // Call function for link rendering:
765 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tstemplate.php']['includeStaticTypoScriptSources'])) {
766 $_params = array(
767 'idList' => &$idList,
768 'templateId' => &$templateID,
769 'pid' => &$pid,
770 'row' => &$row
771 );
772 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tstemplate.php']['includeStaticTypoScriptSources'] as $_funcRef) {
773 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
774 }
775 }
776 // If "Include before all static templates if root-flag is set" is set:
777 if ($row['static_file_mode'] == 3 && substr($templateID, 0, 4) == 'sys_' && $row['root']) {
778 $this->addExtensionStatics($idList, $templateID, $pid, $row);
779 }
780 // Static Template Files (Text files from extensions): include_static_file is a list of static files to include (from extensions)
781 if (trim($row['include_static_file'])) {
782 $include_static_fileArr = GeneralUtility::trimExplode(',', $row['include_static_file'], TRUE);
783 // Traversing list
784 foreach ($include_static_fileArr as $ISF_file) {
785 if (substr($ISF_file, 0, 4) == 'EXT:') {
786 list($ISF_extKey, $ISF_localPath) = explode('/', substr($ISF_file, 4), 2);
787 if ((string)$ISF_extKey !== '' && \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded($ISF_extKey) && (string)$ISF_localPath !== '') {
788 $ISF_localPath = rtrim($ISF_localPath, '/') . '/';
789 $ISF_filePath = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($ISF_extKey) . $ISF_localPath;
790 if (@is_dir($ISF_filePath)) {
791 $mExtKey = str_replace('_', '', $ISF_extKey . '/' . $ISF_localPath);
792 $subrow = array(
793 'constants' => @file_exists(($ISF_filePath . 'constants.txt')) ? GeneralUtility::getUrl($ISF_filePath . 'constants.txt') : '',
794 'config' => @file_exists(($ISF_filePath . 'setup.txt')) ? GeneralUtility::getUrl($ISF_filePath . 'setup.txt') : '',
795 'include_static' => @file_exists(($ISF_filePath . 'include_static.txt')) ? implode(',', array_unique(GeneralUtility::intExplode(',', GeneralUtility::getUrl($ISF_filePath . 'include_static.txt')))) : '',
796 'include_static_file' => @file_exists(($ISF_filePath . 'include_static_file.txt')) ? implode(',', array_unique(explode(',', GeneralUtility::getUrl($ISF_filePath . 'include_static_file.txt')))) : '',
797 'title' => $ISF_file,
798 'uid' => $mExtKey
799 );
800 $subrow = $this->prependStaticExtra($subrow);
801 $this->processTemplate($subrow, $idList . ',ext_' . $mExtKey, $pid, 'ext_' . $mExtKey, $templateID);
802 }
803 }
804 }
805 }
806 }
807 // If "Default (include before if root flag is set)" is set OR
808 // "Always include before this template record" AND root-flag are set
809 if ($row['static_file_mode'] == 1 || $row['static_file_mode'] == 0 && substr($templateID, 0, 4) == 'sys_' && $row['root']) {
810 $this->addExtensionStatics($idList, $templateID, $pid, $row);
811 }
812 // Include Static Template Records after all other TypoScript has been included.
813 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tstemplate.php']['includeStaticTypoScriptSourcesAtEnd'])) {
814 $_params = array(
815 'idList' => &$idList,
816 'templateId' => &$templateID,
817 'pid' => &$pid,
818 'row' => &$row
819 );
820 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tstemplate.php']['includeStaticTypoScriptSourcesAtEnd'] as $_funcRef) {
821 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
822 }
823 }
824 }
825
826 /**
827 * Adds the default TypoScript files for extensions if any.
828 *
829 * @param string $idList A list of already processed template ids including the current; The list is on the form "[prefix]_[uid]" where [prefix] is "sys" for "sys_template" records, "static" for "static_template" records and "ext_" for static include files (from extensions). The list is used to check that the recursive inclusion of templates does not go into circles: Simply it is used to NOT include a template record/file which has already BEEN included somewhere in the recursion.
830 * @param string $templateID The id of the current template. Same syntax as $idList ids, eg. "sys_123
831 * @param array $pid The PID of the input template record
832 * @param array $row A full TypoScript template record
833 * @return void
834 * @access private
835 * @see includeStaticTypoScriptSources()
836 * @todo Define visibility
837 */
838 public function addExtensionStatics($idList, $templateID, $pid, $row) {
839 $this->extensionStaticsProcessed = TRUE;
840
841 // @TODO: Change to use new API
842 foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $extKey => $files) {
843 if ((is_array($files) || $files instanceof \ArrayAccess) && ($files['ext_typoscript_constants.txt'] || $files['ext_typoscript_setup.txt'])) {
844 $mExtKey = str_replace('_', '', $extKey);
845 $subrow = array(
846 'constants' => $files['ext_typoscript_constants.txt'] ? GeneralUtility::getUrl($files['ext_typoscript_constants.txt']) : '',
847 'config' => $files['ext_typoscript_setup.txt'] ? GeneralUtility::getUrl($files['ext_typoscript_setup.txt']) : '',
848 'title' => $extKey,
849 'uid' => $mExtKey
850 );
851 $subrow = $this->prependStaticExtra($subrow);
852 $this->processTemplate($subrow, $idList . ',ext_' . $mExtKey, $pid, 'ext_' . $mExtKey, $templateID);
853 }
854 }
855 }
856
857 /**
858 * Appends (not prepends) additional TypoScript code to static template records/files as set in TYPO3_CONF_VARS
859 * For DB records the "uid" value is the integer of the "static_template" record.
860 * For files the "uid" value is the extension key but with any underscores removed. Possibly with a path if its a static file selected in the template record
861 *
862 * @param array $subrow Static template record/file
863 * @return array Returns the input array where the values for keys "config" and "constants" may have been modified with prepended code.
864 * @access private
865 * @see addExtensionStatics(), includeStaticTypoScriptSources()
866 * @todo Define visibility
867 */
868 public function prependStaticExtra($subrow) {
869 // the identifier can be "43" if coming from "static template" extension or a path like "cssstyledcontent/static/"
870 $identifier = $subrow['uid'];
871 $subrow['config'] .= $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_setup.'][$identifier];
872 $subrow['constants'] .= $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_constants.'][$identifier];
873 // if this is a template of type "default content rendering", also see if other extensions have added their TypoScript that should be included after the content definitions
874 if (in_array($identifier, $GLOBALS['TYPO3_CONF_VARS']['FE']['contentRenderingTemplates'], TRUE)) {
875 $subrow['config'] .= $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_setup.']['defaultContentRendering'];
876 $subrow['constants'] .= $GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_constants.']['defaultContentRendering'];
877 }
878 return $subrow;
879 }
880
881 /**
882 * Creating versioning overlay of a sys_template record.
883 * This will use either frontend or backend overlay functionality depending on environment.
884 *
885 * @param array $row Row to overlay (passed by reference)
886 * @return void
887 * @todo Define visibility
888 */
889 public function versionOL(&$row) {
890 // Distinguish frontend and backend call:
891 // To do the fronted call a full frontend is required, just checking for
892 // TYPO3_MODE === 'FE' is not enough. This could otherwise lead to fatals in
893 // eId scripts that run in frontend scope, but do not have a full blown frontend.
894 if (is_object($GLOBALS['TSFE']) === TRUE && property_exists($GLOBALS['TSFE'], 'sys_page') === TRUE && method_exists($GLOBALS['TSFE']->sys_page, 'versionOL') === TRUE) {
895 // Frontend
896 $GLOBALS['TSFE']->sys_page->versionOL('sys_template', $row);
897 } else {
898 // Backend
899 \TYPO3\CMS\Backend\Utility\BackendUtility::workspaceOL('sys_template', $row);
900 }
901 }
902
903 /*******************************************************************
904 *
905 * Parsing TypoScript code text from Template Records into PHP array
906 *
907 *******************************************************************/
908 /**
909 * Generates the configuration array by replacing constants and parsing the whole thing.
910 * Depends on $this->config and $this->constants to be set prior to this! (done by processTemplate/runThroughTemplates)
911 *
912 * @return void
913 * @see \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser, start()
914 * @todo Define visibility
915 */
916 public function generateConfig() {
917 // Add default TS for all code types
918 $this->addDefaultTypoScript();
919
920 // Parse the TypoScript code text for include-instructions!
921 $this->processIncludes();
922 // These vars are also set lateron...
923 $this->setup['sitetitle'] = $this->sitetitle;
924 // ****************************
925 // Parse TypoScript Constants
926 // ****************************
927 // Initialize parser and match-condition classes:
928 /** @var $constants \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser */
929 $constants = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\TypoScript\\Parser\\TypoScriptParser');
930 $constants->breakPointLN = (int)$this->ext_constants_BRP;
931 $constants->setup = $this->const;
932 $constants->setup = $this->mergeConstantsFromPageTSconfig($constants->setup);
933 /** @var $matchObj \TYPO3\CMS\Frontend\Configuration\TypoScript\ConditionMatching\ConditionMatcher */
934 $matchObj = GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\Configuration\\TypoScript\\ConditionMatching\\ConditionMatcher');
935 $matchObj->setSimulateMatchConditions($this->matchAlternative);
936 $matchObj->setSimulateMatchResult((bool) $this->matchAll);
937 // Traverse constants text fields and parse them
938 foreach ($this->constants as $str) {
939 $constants->parse($str, $matchObj);
940 }
941 // Read out parse errors if any
942 $this->parserErrors['constants'] = $constants->errors;
943 // Then flatten the structure from a multi-dim array to a single dim array with all constants listed as key/value pairs (ready for substitution)
944 $this->flatSetup = array();
945 $this->flattenSetup($constants->setup, '', '');
946 // ***********************************************
947 // Parse TypoScript Setup (here called "config")
948 // ***********************************************
949 // Initialize parser and match-condition classes:
950 /** @var $config \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser */
951 $config = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\TypoScript\\Parser\\TypoScriptParser');
952 $config->breakPointLN = (int)$this->ext_config_BRP;
953 $config->regLinenumbers = $this->ext_regLinenumbers;
954 $config->regComments = $this->ext_regComments;
955 $config->setup = $this->setup;
956 // Transfer information about conditions found in "Constants" and which of them returned TRUE.
957 $config->sections = $constants->sections;
958 $config->sectionsMatch = $constants->sectionsMatch;
959 // Traverse setup text fields and concatenate them into one, single string separated by a [GLOBAL] condition
960 $all = '';
961 foreach ($this->config as $str) {
962 $all .= '
963 [GLOBAL]
964 ' . $str;
965 }
966 // Substitute constants in the Setup code:
967 if ($this->tt_track) {
968 $GLOBALS['TT']->push('Substitute Constants (' . count($this->flatSetup) . ')');
969 }
970 $all = $this->substituteConstants($all);
971 if ($this->tt_track) {
972 $GLOBALS['TT']->pull();
973 }
974 // Searching for possible unsubstituted constants left (only for information)
975 if (strstr($all, '{$')) {
976 $theConstList = array();
977 $findConst = explode('{$', $all);
978 array_shift($findConst);
979 foreach ($findConst as $constVal) {
980 $constLen = \TYPO3\CMS\Core\Utility\MathUtility::forceIntegerInRange(strcspn($constVal, '}'), 0, 50);
981 $theConstList[] = '{$' . substr($constVal, 0, ($constLen + 1));
982 }
983 if ($this->tt_track) {
984 $GLOBALS['TT']->setTSlogMessage(implode(', ', $theConstList) . ': Constants may remain un-substituted!!', 2);
985 }
986 }
987 // Logging the textual size of the TypoScript Setup field text with all constants substituted:
988 if ($this->tt_track) {
989 $GLOBALS['TT']->setTSlogMessage('TypoScript template size as textfile: ' . strlen($all) . ' bytes');
990 }
991 // Finally parse the Setup field TypoScript code (where constants are now substituted)
992 $config->parse($all, $matchObj);
993 // Read out parse errors if any
994 $this->parserErrors['config'] = $config->errors;
995 // Transfer the TypoScript array from the parser object to the internal $this->setup array:
996 $this->setup = $config->setup;
997 if ($this->backend_info) {
998 // Used for backend purposes only
999 $this->setup_constants = $constants->setup;
1000 }
1001 // ****************************************************************
1002 // Final processing of the $this->setup TypoScript Template array
1003 // Basically: This is unsetting/setting of certain reserved keys.
1004 // ****************************************************************
1005 // These vars are allready set after 'processTemplate', but because $config->setup overrides them (in the line above!), we set them again. They are not changed compared to the value they had in the top of the page!
1006 unset($this->setup['sitetitle']);
1007 unset($this->setup['sitetitle.']);
1008 $this->setup['sitetitle'] = $this->sitetitle;
1009 // Unsetting some vars...
1010 unset($this->setup['types.']);
1011 unset($this->setup['types']);
1012 if (is_array($this->setup)) {
1013 foreach ($this->setup as $key => $value) {
1014 if ($value == 'PAGE') {
1015 // Set the typeNum of the current page object:
1016 if (isset($this->setup[$key . '.']['typeNum'])) {
1017 $typeNum = $this->setup[$key . '.']['typeNum'];
1018 $this->setup['types.'][$typeNum] = $key;
1019 } elseif (!isset($this->setup['types.'][0]) || !$this->setup['types.'][0]) {
1020 $this->setup['types.'][0] = $key;
1021 }
1022 }
1023 }
1024 }
1025 unset($this->setup['styles.']);
1026 unset($this->setup['temp.']);
1027 unset($constants);
1028 // Storing the conditions found/matched information:
1029 $this->sections = $config->sections;
1030 $this->sectionsMatch = $config->sectionsMatch;
1031 }
1032
1033 /**
1034 * Searching TypoScript code text (for constants and config (Setup))
1035 * for include instructions and does the inclusion of external TypoScript files
1036 * if needed.
1037 *
1038 * @return void
1039 * @see \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser, generateConfig()
1040 */
1041 public function processIncludes() {
1042 $files = array();
1043 foreach ($this->constants as &$value) {
1044 $includeData = \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser::checkIncludeLines($value, 1, TRUE);
1045 $files = array_merge($files, $includeData['files']);
1046 $value = $includeData['typoscript'];
1047 }
1048 unset($value);
1049 foreach ($this->config as &$value) {
1050 $includeData = \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser::checkIncludeLines($value, 1, TRUE);
1051 $files = array_merge($files, $includeData['files']);
1052 $value = $includeData['typoscript'];
1053 }
1054 unset($value);
1055 if (count($files)) {
1056 $files = array_unique($files);
1057 foreach ($files as $file) {
1058 $this->rowSum[] = array($file, filemtime($file));
1059 }
1060 }
1061 }
1062
1063 /**
1064 * Loads Page TSconfig until the outermost template record and parses the configuration - if TSFE.constants object path is found it is merged with the default data in here!
1065 *
1066 * @param array $constArray Constants array, default input.
1067 * @return array Constants array, modified
1068 * @todo Apply caching to the parsed Page TSconfig. This is done in the other similar functions for both frontend and backend. However, since this functions works for BOTH frontend and backend we will have to either write our own local caching function or (more likely) detect if we are in FE or BE and use caching functions accordingly. Not having caching affects mostly the backend modules inside the "Template" module since the overhead in the frontend is only seen when TypoScript templates are parsed anyways (after which point they are cached anyways...)
1069 * @todo Define visibility
1070 */
1071 public function mergeConstantsFromPageTSconfig($constArray) {
1072 $TSdataArray = array();
1073 // Setting default configuration:
1074 $TSdataArray[] = $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig'];
1075 for ($a = 0; $a <= $this->outermostRootlineIndexWithTemplate; $a++) {
1076 $TSdataArray[] = $this->absoluteRootLine[$a]['TSconfig'];
1077 }
1078 // Parsing the user TS (or getting from cache)
1079 $TSdataArray = \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser::checkIncludeLines_array($TSdataArray);
1080 $userTS = implode(LF . '[GLOBAL]' . LF, $TSdataArray);
1081 /** @var $parseObj \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser */
1082 $parseObj = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\TypoScript\\Parser\\TypoScriptParser');
1083 $parseObj->parse($userTS);
1084 if (is_array($parseObj->setup['TSFE.']['constants.'])) {
1085 \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($constArray, $parseObj->setup['TSFE.']['constants.']);
1086 }
1087 return $constArray;
1088 }
1089
1090 /**
1091 * This flattens a hierarchical TypoScript array to $this->flatSetup
1092 *
1093 * @param array $setupArray TypoScript array
1094 * @param string $prefix Prefix to the object path. Used for recursive calls to this function.
1095 * @param boolean $resourceFlag If set, then the constant value will be resolved as a TypoScript "resource" data type. Also used internally during recursive calls so that all subproperties for properties named "file." will be resolved as resources.
1096 * @return void
1097 * @see generateConfig()
1098 * @todo Define visibility
1099 */
1100 public function flattenSetup($setupArray, $prefix, $resourceFlag) {
1101 if (is_array($setupArray)) {
1102 foreach ($setupArray as $key => $val) {
1103 if ($prefix || substr($key, 0, 16) != 'TSConstantEditor') {
1104 // We don't want 'TSConstantEditor' in the flattend setup on the first level (190201)
1105 if (is_array($val)) {
1106 $this->flattenSetup($val, $prefix . $key, $key == 'file.');
1107 } elseif ($resourceFlag) {
1108 $this->flatSetup[$prefix . $key] = $this->getFileName($val);
1109 } else {
1110 $this->flatSetup[$prefix . $key] = $val;
1111 }
1112 }
1113 }
1114 }
1115 }
1116
1117 /**
1118 * Substitutes the constants from $this->flatSetup in the text string $all
1119 *
1120 * @param string $all TypoScript code text string
1121 * @return string The processed string with all constants found in $this->flatSetup as key/value pairs substituted.
1122 * @see generateConfig(), flattenSetup()
1123 * @todo Define visibility
1124 */
1125 public function substituteConstants($all) {
1126 if ($this->tt_track) {
1127 $GLOBALS['TT']->setTSlogMessage('Constants to substitute: ' . count($this->flatSetup));
1128 }
1129 $noChange = FALSE;
1130 // Recursive substitution of constants (up to 10 nested levels)
1131 for ($i = 0; $i < 10 && !$noChange; $i++) {
1132 $old_all = $all;
1133 $all = preg_replace_callback('/\\{\\$(.[^}]*)\\}/', array($this, 'substituteConstantsCallBack'), $all);
1134 if ($old_all == $all) {
1135 $noChange = TRUE;
1136 }
1137 }
1138 return $all;
1139 }
1140
1141 /**
1142 * Call back method for preg_replace_callback in substituteConstants
1143 *
1144 * @param array $matches Regular expression matches
1145 * @return string Replacement
1146 * @see substituteConstants()
1147 * @todo Define visibility
1148 */
1149 public function substituteConstantsCallBack($matches) {
1150 // Replace {$CONST} if found in $this->flatSetup, else leave unchanged
1151 return isset($this->flatSetup[$matches[1]]) && !is_array($this->flatSetup[$matches[1]]) ? $this->flatSetup[$matches[1]] : $matches[0];
1152 }
1153
1154 /*******************************************************************
1155 *
1156 * Various API functions, used from elsewhere in the frontend classes
1157 *
1158 *******************************************************************/
1159 /**
1160 * Implementation of the "optionSplit" feature in TypoScript (used eg. for MENU objects)
1161 * What it does is to split the incoming TypoScript array so that the values are exploded by certain strings ("||" and "|*|") and each part distributed into individual TypoScript arrays with a similar structure, but individualized values.
1162 * The concept is known as "optionSplit" and is rather advanced to handle but quite powerful, in particular for creating menus in TYPO3.
1163 *
1164 * @param array $conf A TypoScript array
1165 * @param integer $splitCount The number of items for which to generated individual TypoScript arrays
1166 * @return array The individualized TypoScript array.
1167 * @see \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::IMGTEXT(), \TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject::procesItemStates()
1168 * @todo Define visibility
1169 */
1170 public function splitConfArray($conf, $splitCount) {
1171 // Initialize variables:
1172 $splitCount = (int)$splitCount;
1173 $conf2 = array();
1174 if ($splitCount && is_array($conf)) {
1175 // Initialize output to carry at least the keys:
1176 for ($aKey = 0; $aKey < $splitCount; $aKey++) {
1177 $conf2[$aKey] = array();
1178 }
1179 // Recursive processing of array keys:
1180 foreach ($conf as $cKey => $val) {
1181 if (is_array($val)) {
1182 $tempConf = $this->splitConfArray($val, $splitCount);
1183 foreach ($tempConf as $aKey => $val) {
1184 $conf2[$aKey][$cKey] = $val;
1185 }
1186 } else {
1187 // Splitting of all values on this level of the TypoScript object tree:
1188 if (!strstr($val, '|*|') && !strstr($val, '||')) {
1189 for ($aKey = 0; $aKey < $splitCount; $aKey++) {
1190 $conf2[$aKey][$cKey] = $val;
1191 }
1192 } else {
1193 $main = explode('|*|', $val);
1194 $mainCount = count($main);
1195 $lastC = 0;
1196 $middleC = 0;
1197 $firstC = 0;
1198 if ($main[0]) {
1199 $first = explode('||', $main[0]);
1200 $firstC = count($first);
1201 }
1202 if ($main[1]) {
1203 $middle = explode('||', $main[1]);
1204 $middleC = count($middle);
1205 }
1206 if ($main[2]) {
1207 $last = explode('||', $main[2]);
1208 $lastC = count($last);
1209 $value = $last[0];
1210 }
1211 for ($aKey = 0; $aKey < $splitCount; $aKey++) {
1212 if ($firstC && isset($first[$aKey])) {
1213 $value = $first[$aKey];
1214 } elseif ($middleC) {
1215 $value = $middle[($aKey - $firstC) % $middleC];
1216 }
1217 if ($lastC && $lastC >= $splitCount - $aKey) {
1218 $value = $last[$lastC - ($splitCount - $aKey)];
1219 }
1220 $conf2[$aKey][$cKey] = trim($value);
1221 }
1222 }
1223 }
1224 }
1225 }
1226 return $conf2;
1227 }
1228
1229 /**
1230 * Returns the reference to a 'resource' in TypoScript.
1231 * This could be from the filesystem if '/' is found in the value $fileFromSetup, else from the resource-list
1232 *
1233 * @param string $fileFromSetup TypoScript "resource" data type value.
1234 * @return string Resulting filename, if any.
1235 * @todo Define visibility
1236 */
1237 public function getFileName($fileFromSetup) {
1238 $file = trim($fileFromSetup);
1239 if (!$file) {
1240 return;
1241 } elseif (strstr($file, '../')) {
1242 if ($this->tt_track) {
1243 $GLOBALS['TT']->setTSlogMessage('File path "' . $file . '" contained illegal string "../"!', 3);
1244 }
1245 return;
1246 }
1247 // Cache
1248 $hash = md5($file);
1249 if (isset($this->fileCache[$hash])) {
1250 return $this->fileCache[$hash];
1251 }
1252 if (substr($file, 0, 4) === 'EXT:') {
1253 $newFile = '';
1254 list($extKey, $script) = explode('/', substr($file, 4), 2);
1255 if ($extKey && \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded($extKey)) {
1256 $extPath = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($extKey);
1257 $newFile = \TYPO3\CMS\Core\Utility\PathUtility::stripPathSitePrefix($extPath) . $script;
1258 }
1259 if (!@file_exists((PATH_site . $newFile))) {
1260 if ($this->tt_track) {
1261 $GLOBALS['TT']->setTSlogMessage('Extension media file "' . $newFile . '" was not found!', 3);
1262 }
1263 return;
1264 } else {
1265 $file = $newFile;
1266 }
1267 }
1268 if (parse_url($file) !== FALSE) {
1269 return $file;
1270 }
1271 // Find
1272 if (strpos($file, '/') !== FALSE) {
1273 // If the file is in the media/ folder but it doesn't exist,
1274 // it is assumed that it's in the tslib folder
1275 if (GeneralUtility::isFirstPartOfStr($file, 'media/') && !file_exists(($this->getFileName_backPath . $file))) {
1276 $file = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::siteRelPath('cms') . 'tslib/' . $file;
1277 }
1278 if (file_exists($this->getFileName_backPath . $file)) {
1279 $outFile = $file;
1280 $fileInfo = GeneralUtility::split_fileref($outFile);
1281 $OK = 0;
1282 foreach ($this->allowedPaths as $val) {
1283 if (substr($fileInfo['path'], 0, strlen($val)) == $val) {
1284 $OK = 1;
1285 break;
1286 }
1287 }
1288 if ($OK) {
1289 $this->fileCache[$hash] = $outFile;
1290 return $outFile;
1291 } elseif ($this->tt_track) {
1292 $GLOBALS['TT']->setTSlogMessage('"' . $file . '" was not located in the allowed paths: (' . implode(',', $this->allowedPaths) . ')', 3);
1293 }
1294 } elseif ($this->tt_track) {
1295 $GLOBALS['TT']->setTSlogMessage('"' . $this->getFileName_backPath . $file . '" is not a file (non-uploads/.. resource, did not exist).', 3);
1296 }
1297 }
1298 }
1299
1300 /**
1301 * Compiles the content for the page <title> tag.
1302 *
1303 * @param string $pageTitle The input title string, typically the "title" field of a page's record.
1304 * @param boolean $noTitle If set, then only the site title is outputted (from $this->setup['sitetitle'])
1305 * @param boolean $showTitleFirst If set, then "sitetitle" and $title is swapped
1306 * @return string The page title on the form "[sitetitle]: [input-title]". Not htmlspecialchar()'ed.
1307 * @see \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::tempPageCacheContent(), TSpagegen::renderContentWithHeader()
1308 * @todo Define visibility
1309 */
1310 public function printTitle($pageTitle, $noTitle = FALSE, $showTitleFirst = FALSE) {
1311 $siteTitle = trim($this->setup['sitetitle']);
1312 $pageTitle = $noTitle ? '' : $pageTitle;
1313 $pageTitleSeparator = '';
1314 if ($showTitleFirst) {
1315 $temp = $siteTitle;
1316 $siteTitle = $pageTitle;
1317 $pageTitle = $temp;
1318 }
1319 if ($pageTitle != '' && $siteTitle != '') {
1320 $pageTitleSeparator = ': ';
1321 if (isset($this->setup['config.']['pageTitleSeparator']) && $this->setup['config.']['pageTitleSeparator']) {
1322 $pageTitleSeparator = $this->setup['config.']['pageTitleSeparator'];
1323
1324 if (is_object($GLOBALS['TSFE']->cObj) && isset($this->setup['config.']['pageTitleSeparator.']) && is_array($this->setup['config.']['pageTitleSeparator.'])) {
1325 $pageTitleSeparator = $GLOBALS['TSFE']->cObj->stdWrap($pageTitleSeparator, $this->setup['config.']['pageTitleSeparator.']);
1326 } else {
1327 $pageTitleSeparator .= ' ';
1328 }
1329 }
1330 }
1331 return $siteTitle . $pageTitleSeparator . $pageTitle;
1332 }
1333
1334 /**
1335 * Reads the fileContent of $fName and returns it.
1336 * Similar to GeneralUtility::getUrl()
1337 *
1338 * @param string $fName Absolute filepath to record
1339 * @return string The content returned
1340 * @see \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::fileResource(), \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::MULTIMEDIA(), GeneralUtility::getUrl()
1341 * @todo Define visibility
1342 */
1343 public function fileContent($fName) {
1344 $incFile = $this->getFileName($fName);
1345 if ($incFile) {
1346 return @file_get_contents($incFile);
1347 }
1348 }
1349
1350 /**
1351 * Ordinary "wrapping" function. Used in the AbstractMenuContentObject class and extension classes instead of the similar function in ContentObjectRenderer
1352 *
1353 * @param string $content The content to wrap
1354 * @param string $wrap The wrap value, eg. "<strong> | </strong>
1355 * @return string Wrapped input string
1356 * @see \TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject, \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::wrap()
1357 * @todo Define visibility
1358 */
1359 public function wrap($content, $wrap) {
1360 if ($wrap) {
1361 $wrapArr = explode('|', $wrap);
1362 return trim($wrapArr[0]) . $content . trim($wrapArr[1]);
1363 } else {
1364 return $content;
1365 }
1366 }
1367
1368 /**
1369 * Removes the "?" of input string IF the "?" is the last character.
1370 *
1371 * @param string $url Input string
1372 * @return string Output string, free of "?" in the end, if any such character.
1373 * @see linkData(), \TYPO3\CMS\Frontend\Page\FramesetRenderer::frameParams()
1374 * @todo Define visibility
1375 */
1376 public function removeQueryString($url) {
1377 if (substr($url, -1) == '?') {
1378 return substr($url, 0, -1);
1379 } else {
1380 return $url;
1381 }
1382 }
1383
1384 /**
1385 * Takes a TypoScript array as input and returns an array which contains all integer properties found which had a value (not only properties). The output array will be sorted numerically.
1386 * Call it like \TYPO3\CMS\Core\TypoScript\TemplateService::sortedKeyList()
1387 *
1388 * @param array $setupArr TypoScript array with numerical array in
1389 * @param boolean $acceptOnlyProperties If set, then a value is not required - the properties alone will be enough.
1390 * @return array An array with all integer properties listed in numeric order.
1391 * @see \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::cObjGet(), \TYPO3\CMS\Frontend\Imaging\GifBuilder, \TYPO3\CMS\Frontend\ContentObject\Menu\ImageMenuContentObject::makeImageMap()
1392 */
1393 static public function sortedKeyList($setupArr, $acceptOnlyProperties = FALSE) {
1394 $keyArr = array();
1395 $setupArrKeys = array_keys($setupArr);
1396 foreach ($setupArrKeys as $key) {
1397 if ($acceptOnlyProperties || \TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($key)) {
1398 $keyArr[] = (int)$key;
1399 }
1400 }
1401 $keyArr = array_unique($keyArr);
1402 sort($keyArr);
1403 return $keyArr;
1404 }
1405
1406 /**
1407 * Returns the level of the given page in the rootline - Multiple pages can be given by separating the UIDs by comma.
1408 *
1409 * @param string $list A list of UIDs for which the rootline-level should get returned
1410 * @return integer The level in the rootline. If more than one page was given the lowest level will get returned.
1411 * @todo Define visibility
1412 */
1413 public function getRootlineLevel($list) {
1414 $idx = 0;
1415 foreach ($this->rootLine as $page) {
1416 if (GeneralUtility::inList($list, $page['uid'])) {
1417 return $idx;
1418 }
1419 $idx++;
1420 }
1421 return FALSE;
1422 }
1423
1424 /*******************************************************************
1425 *
1426 * Functions for creating links
1427 *
1428 *******************************************************************/
1429 /**
1430 * The mother of all functions creating links/URLs etc in a TypoScript environment.
1431 * See the references below.
1432 * Basically this function takes care of issues such as type,id,alias and Mount Points, URL rewriting (through hooks), M5/B6 encoded parameters etc.
1433 * It is important to pass all links created through this function since this is the guarantee that globally configured settings for link creating are observed and that your applications will conform to the various/many configuration options in TypoScript Templates regarding this.
1434 *
1435 * @param array $page The page record of the page to which we are creating a link. Needed due to fields like uid, alias, target, no_cache, title and sectionIndex_uid.
1436 * @param string $oTarget Default target string to use IF not $page['target'] is set.
1437 * @param boolean $no_cache If set, then the "&no_cache=1" parameter is included in the URL.
1438 * @param string $script Alternative script name if you don't want to use $GLOBALS['TSFE']->config['mainScript'] (normally set to "index.php")
1439 * @param array $overrideArray Array with overriding values for the $page array.
1440 * @param string $addParams Additional URL parameters to set in the URL. Syntax is "&foo=bar&foo2=bar2" etc. Also used internally to add parameters if needed.
1441 * @param string $typeOverride If you set this value to something else than a blank string, then the typeNumber used in the link will be forced to this value. Normally the typeNum is based on the target set OR on $GLOBALS['TSFE']->config['config']['forceTypeValue'] if found.
1442 * @param string $targetDomain The target Doamin, if any was detected in typolink
1443 * @return array Contains keys like "totalURL", "url", "sectionIndex", "linkVars", "no_cache", "type", "target" of which "totalURL" is normally the value you would use while the other keys contains various parts that was used to construct "totalURL
1444 * @see \TYPO3\CMS\Frontend\Page\FramesetRenderer::frameParams(), \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::typoLink(), \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::SEARCHRESULT(), TSpagegen::pagegenInit(), \TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject::link()
1445 * @todo Define visibility
1446 */
1447 public function linkData($page, $oTarget, $no_cache, $script, $overrideArray = NULL, $addParams = '', $typeOverride = '', $targetDomain = '') {
1448 $LD = array();
1449 // Overriding some fields in the page record and still preserves the values by adding them as parameters. Little strange function.
1450 if (is_array($overrideArray)) {
1451 foreach ($overrideArray as $theKey => $theNewVal) {
1452 $addParams .= '&real_' . $theKey . '=' . rawurlencode($page[$theKey]);
1453 $page[$theKey] = $theNewVal;
1454 }
1455 }
1456 // Adding Mount Points, "&MP=", parameter for the current page if any is set:
1457 if (!strstr($addParams, '&MP=')) {
1458 // Looking for hardcoded defaults:
1459 if (trim($GLOBALS['TSFE']->MP_defaults[$page['uid']])) {
1460 $addParams .= '&MP=' . rawurlencode(trim($GLOBALS['TSFE']->MP_defaults[$page['uid']]));
1461 } elseif ($GLOBALS['TSFE']->config['config']['MP_mapRootPoints']) {
1462 // Else look in automatically created map:
1463 $m = $this->getFromMPmap($page['uid']);
1464 if ($m) {
1465 $addParams .= '&MP=' . rawurlencode($m);
1466 }
1467 }
1468 }
1469 // Setting ID/alias:
1470 if (!$script) {
1471 $script = $GLOBALS['TSFE']->config['mainScript'];
1472 }
1473 if ($page['alias']) {
1474 $LD['url'] = $script . '?id=' . rawurlencode($page['alias']);
1475 } else {
1476 $LD['url'] = $script . '?id=' . $page['uid'];
1477 }
1478 // Setting target
1479 $LD['target'] = trim($page['target']) ?: $oTarget;
1480 // typeNum
1481 $typeNum = $this->setup[$LD['target'] . '.']['typeNum'];
1482 if (!\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($typeOverride) && (int)$GLOBALS['TSFE']->config['config']['forceTypeValue']) {
1483 $typeOverride = (int)$GLOBALS['TSFE']->config['config']['forceTypeValue'];
1484 }
1485 if ((string)$typeOverride !== '') {
1486 $typeNum = $typeOverride;
1487 }
1488 // Override...
1489 if ($typeNum) {
1490 $LD['type'] = '&type=' . (int)$typeNum;
1491 } else {
1492 $LD['type'] = '';
1493 }
1494 // Preserving the type number.
1495 $LD['orig_type'] = $LD['type'];
1496 // noCache
1497 $LD['no_cache'] = trim($page['no_cache']) || $no_cache ? '&no_cache=1' : '';
1498 // linkVars
1499 if ($GLOBALS['TSFE']->config['config']['uniqueLinkVars']) {
1500 if ($addParams) {
1501 $LD['linkVars'] = GeneralUtility::implodeArrayForUrl('', GeneralUtility::explodeUrl2Array($GLOBALS['TSFE']->linkVars . $addParams), '', FALSE, TRUE);
1502 } else {
1503 $LD['linkVars'] = $GLOBALS['TSFE']->linkVars;
1504 }
1505 } else {
1506 $LD['linkVars'] = $GLOBALS['TSFE']->linkVars . $addParams;
1507 }
1508 // Add absRefPrefix if exists.
1509 $LD['url'] = $GLOBALS['TSFE']->absRefPrefix . $LD['url'];
1510 // If the special key 'sectionIndex_uid' (added 'manually' in tslib/menu.php to the page-record) is set, then the link jumps directly to a section on the page.
1511 $LD['sectionIndex'] = $page['sectionIndex_uid'] ? '#c' . $page['sectionIndex_uid'] : '';
1512 // Compile the normal total url
1513 $LD['totalURL'] = $this->removeQueryString(($LD['url'] . $LD['type'] . $LD['no_cache'] . $LD['linkVars'] . $GLOBALS['TSFE']->getMethodUrlIdToken)) . $LD['sectionIndex'];
1514 // Call post processing function for link rendering:
1515 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tstemplate.php']['linkData-PostProc'])) {
1516 $_params = array(
1517 'LD' => &$LD,
1518 'args' => array('page' => $page, 'oTarget' => $oTarget, 'no_cache' => $no_cache, 'script' => $script, 'overrideArray' => $overrideArray, 'addParams' => $addParams, 'typeOverride' => $typeOverride, 'targetDomain' => $targetDomain),
1519 'typeNum' => $typeNum
1520 );
1521 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tstemplate.php']['linkData-PostProc'] as $_funcRef) {
1522 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
1523 }
1524 }
1525 // Return the LD-array
1526 return $LD;
1527 }
1528
1529 /**
1530 * Initializes the automatically created MPmap coming from the "config.MP_mapRootPoints" setting
1531 * Can be called many times with overhead only the first time since then the map is generated and cached in memory.
1532 *
1533 * @param integer $pageId Page id to return MPvar value for.
1534 * @return string
1535 * @see initMPmap_create()
1536 * @todo Implement some caching of the result between hits. (more than just the memory caching used here)
1537 * @todo Define visibility
1538 */
1539 public function getFromMPmap($pageId = 0) {
1540 // Create map if not found already:
1541 if (!is_array($this->MPmap)) {
1542 $this->MPmap = array();
1543 $rootPoints = GeneralUtility::trimExplode(',', strtolower($GLOBALS['TSFE']->config['config']['MP_mapRootPoints']), TRUE);
1544 // Traverse rootpoints:
1545 foreach ($rootPoints as $p) {
1546 if ($p == 'root') {
1547 $p = $this->rootLine[0]['uid'];
1548 $initMParray = array();
1549 if ($this->rootLine[0]['_MOUNT_OL'] && $this->rootLine[0]['_MP_PARAM']) {
1550 $initMParray[] = $this->rootLine[0]['_MP_PARAM'];
1551 }
1552 }
1553 $this->initMPmap_create($p, $initMParray);
1554 }
1555 }
1556 // Finding MP var for Page ID:
1557 if ($pageId) {
1558 if (is_array($this->MPmap[$pageId]) && count($this->MPmap[$pageId])) {
1559 return implode(',', $this->MPmap[$pageId]);
1560 }
1561 }
1562 }
1563
1564 /**
1565 * Creating MPmap for a certain ID root point.
1566 *
1567 * @param integer $id Root id from which to start map creation.
1568 * @param array $MP_array MP_array passed from root page.
1569 * @param integer $level Recursion brake. Incremented for each recursive call. 20 is the limit.
1570 * @return void
1571 * @see getFromMPvar()
1572 * @todo Define visibility
1573 */
1574 public function initMPmap_create($id, $MP_array = array(), $level = 0) {
1575 $id = (int)$id;
1576 if ($id <= 0) {
1577 return;
1578 }
1579 // First level, check id
1580 if (!$level) {
1581 // Find mount point if any:
1582 $mount_info = $GLOBALS['TSFE']->sys_page->getMountPointInfo($id);
1583 // Overlay mode:
1584 if (is_array($mount_info) && $mount_info['overlay']) {
1585 $MP_array[] = $mount_info['MPvar'];
1586 $id = $mount_info['mount_pid'];
1587 }
1588 // Set mapping information for this level:
1589 $this->MPmap[$id] = $MP_array;
1590 // Normal mode:
1591 if (is_array($mount_info) && !$mount_info['overlay']) {
1592 $MP_array[] = $mount_info['MPvar'];
1593 $id = $mount_info['mount_pid'];
1594 }
1595 }
1596 if ($id && $level < 20) {
1597 $nextLevelAcc = array();
1598 // Select and traverse current level pages:
1599 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid,pid,doktype,mount_pid,mount_pid_ol', 'pages', 'pid=' . (int)$id . ' AND deleted=0 AND doktype<>' . \TYPO3\CMS\Frontend\Page\PageRepository::DOKTYPE_RECYCLER . ' AND doktype<>' . \TYPO3\CMS\Frontend\Page\PageRepository::DOKTYPE_BE_USER_SECTION);
1600 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1601 // Find mount point if any:
1602 $next_id = $row['uid'];
1603 $next_MP_array = $MP_array;
1604 $mount_info = $GLOBALS['TSFE']->sys_page->getMountPointInfo($next_id, $row);
1605 // Overlay mode:
1606 if (is_array($mount_info) && $mount_info['overlay']) {
1607 $next_MP_array[] = $mount_info['MPvar'];
1608 $next_id = $mount_info['mount_pid'];
1609 }
1610 if (!isset($this->MPmap[$next_id])) {
1611 // Set mapping information for this level:
1612 $this->MPmap[$next_id] = $next_MP_array;
1613 // Normal mode:
1614 if (is_array($mount_info) && !$mount_info['overlay']) {
1615 $next_MP_array[] = $mount_info['MPvar'];
1616 $next_id = $mount_info['mount_pid'];
1617 }
1618 // Register recursive call
1619 // (have to do it this way since ALL of the current level should be registered BEFORE the sublevel at any time)
1620 $nextLevelAcc[] = array($next_id, $next_MP_array);
1621 }
1622 }
1623 $GLOBALS['TYPO3_DB']->sql_free_result($res);
1624 // Call recursively, if any:
1625 foreach ($nextLevelAcc as $pSet) {
1626 $this->initMPmap_create($pSet[0], $pSet[1], $level + 1);
1627 }
1628 }
1629 }
1630
1631 /**
1632 * Adds the TypoScript from the global array.
1633 * The class property isDefaultTypoScriptAdded ensures
1634 * that the adding only happens once.
1635 *
1636 * @return void
1637 * @see isDefaultTypoScriptAdded
1638 */
1639 protected function addDefaultTypoScript() {
1640 // Add default TS for all code types, if not done already
1641 if (!$this->isDefaultTypoScriptAdded) {
1642 // adding default setup and constants
1643 // defaultTypoScript_setup is *very* unlikely to be empty
1644 // the count of elements in ->constants and ->config have to be in sync so we always add *both*
1645 array_unshift($this->constants, (string)$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_constants']);
1646 array_unshift($this->config, (string)$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_setup']);
1647 // prepare a proper entry to hierachyInfo (used by TemplateAnalyzer in BE)
1648 $rootTemplateId = $this->hierarchyInfo[count($this->hierarchyInfo)-1]['templateID'];
1649 $defaultTemplateInfo = array(
1650 'root' => '',
1651 'next' => '',
1652 'clConst' => '',
1653 'clConf' => '',
1654 'templateID' => '_defaultTypoScript_',
1655 'templateParent' => $rootTemplateId,
1656 'title' => 'SYS:TYPO3_CONF_VARS:FE:defaultTypoScript',
1657 'uid' => '_defaultTypoScript_',
1658 'pid' => '',
1659 'configLines' => substr_count((string)$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_setup'], LF) + 1
1660 );
1661 // push info to information arrays used in BE by TemplateTools (Analyzer)
1662 array_unshift($this->clearList_const, $defaultTemplateInfo['uid']);
1663 array_unshift($this->clearList_setup, $defaultTemplateInfo['uid']);
1664 array_unshift($this->hierarchyInfo, $defaultTemplateInfo);
1665 $this->isDefaultTypoScriptAdded = TRUE;
1666 }
1667 }
1668
1669 }