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