Added feature #5613: Enable/integrate conditions in Page TSconfig
[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 }
514
515 /**
516 * Checks if the template ($row) has some included templates and after including them it fills the arrays with the setup
517 * Builds up $this->rowSum
518 *
519 * @param array A full TypoScript template record (sys_template/static_template/forged "dummy" record made from static template file)
520 * @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.
521 * @param array The PID of the input template record
522 * @param string The id of the current template. Same syntax as $idList ids, eg. "sys_123"
523 * @param string Parent template id (during recursive call); Same syntax as $idList ids, eg. "sys_123"
524 * @return void
525 * @see runThroughTemplates()
526 */
527 function processTemplate($row, $idList,$pid,$templateID='',$templateParent='') {
528 // Adding basic template record information to rowSum array
529 $this->rowSum[]=Array($row['uid'],$row['title'],$row['tstamp']);
530
531 // Processing "Clear"-flags
532 if ($row['clear']) {
533 $clConst = $row['clear']&1;
534 $clConf = $row['clear']&2;
535 if ($clConst) {
536 $this->constants = Array();
537 $this->clearList_const=array();
538 }
539 if ($clConf) {
540 $this->config = Array();
541 $this->hierarchyInfoToRoot = Array();
542 $this->clearList_setup=array();
543
544 $this->editorcfg = Array();
545 $this->clearList_editorcfg=array();
546 }
547 }
548
549 // Include static records (static_template) or files (from extensions) (#1/2)
550 if (!$row['includeStaticAfterBasedOn']) { // NORMAL inclusion, The EXACT same code is found below the basedOn inclusion!!!
551 $this->includeStaticTypoScriptSources($idList,$templateID,$pid,$row);
552 }
553
554 // Include "Based On" sys_templates:
555 if (trim($row['basedOn'])) { // 'basedOn' is a list of templates to include
556 // Manually you can put this value in the field and then the based_on ID will be taken from the $_GET var defined by '=....'.
557 // 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!
558 // 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.
559 $basedOn_hackFeature = explode('=',$row['basedOn']);
560 if ($basedOn_hackFeature[0]=='EXTERNAL_BASED_ON_TEMPLATE_ID' && $basedOn_hackFeature[1]) {
561 $id = intval(t3lib_div::_GET($basedOn_hackFeature[1]));
562 if ($id && !t3lib_div::inList($idList,'sys_'.$id)) { // if $id is not allready included ...
563 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_template', 'uid='.$id.' '.$this->whereClause);
564 if ($subrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { // there was a template, then we fetch that
565 $this->versionOL($subrow);
566 if (is_array($subrow)) {
567 $this->processTemplate($subrow,$idList.',sys_'.$id,$pid, 'sys_'.$id,$templateID);
568 }
569 }
570 $GLOBALS['TYPO3_DB']->sql_free_result($res);
571 }
572 } else { // NORMAL OPERATION:
573 $basedOnArr = t3lib_div::intExplode(',', $row['basedOn']);
574 foreach ($basedOnArr as $id) { // traversing list
575 if (!t3lib_div::inList($idList,'sys_'.$id)) { // if $id is not allready included ...
576 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_template', 'uid='.intval($id).' '.$this->whereClause);
577 if ($subrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { // there was a template, then we fetch that
578 $this->versionOL($subrow);
579 if (is_array($subrow)) {
580 $this->processTemplate($subrow,$idList.',sys_'.$id,$pid, 'sys_'.$id,$templateID);
581 }
582 }
583 $GLOBALS['TYPO3_DB']->sql_free_result($res);
584 }
585 }
586 }
587 }
588
589 // Include static records (static_template) or files (from extensions) (#2/2)
590 if ($row['includeStaticAfterBasedOn']) {
591 $this->includeStaticTypoScriptSources($idList,$templateID,$pid,$row);
592 }
593
594 // Creating hierarchy information; Used by backend analysis tools
595 $this->hierarchyInfo[] = $this->hierarchyInfoToRoot[] = array(
596 'root'=>trim($row['root']),
597 'next'=>$row['nextLevel'],
598 'clConst'=>$clConst,
599 'clConf'=>$clConf,
600 'templateID'=>$templateID,
601 'templateParent'=>$templateParent,
602 'title'=>$row['title'],
603 'uid'=>$row['uid'],
604 'pid'=>$row['pid'],
605 'configLines' => substr_count($row['config'], chr(10))+1
606 );
607
608 // Adding the content of the fields constants (Constants), config (Setup) and editorcfg (Backend Editor Configuration) to the internal arrays.
609 $this->constants[] = $row['constants'];
610 $this->config[] = $row['config'];
611 if ($this->parseEditorCfgField) $this->editorcfg[] = $row['editorcfg'];
612
613 // For backend analysis (Template Analyser) provide the order of added constants/config/editorcfg template IDs
614 $this->clearList_const[]=$templateID;
615 $this->clearList_setup[]=$templateID;
616 if ($this->parseEditorCfgField) $this->clearList_editorcfg[]=$templateID;
617
618 // Add resources and sitetitle if found:
619 if (trim($row['resources'])) {
620 $this->resources = $row['resources'].','.$this->resources;
621 }
622 if (trim($row['sitetitle'])) {
623 $this->sitetitle = $row['sitetitle'];
624 }
625 // If the template record is a Rootlevel record, set the flag and clear the template rootLine (so it starts over from this point)
626 if (trim($row['root'])) {
627 $this->rootId = $pid;
628 $this->rootLine = Array();
629 }
630 // If a template is set to be active on the next level set this internal value to point to this UID. (See runThroughTemplates())
631 if ($row['nextLevel']) {
632 $this->nextLevel = $row['nextLevel'];
633 } else {
634 $this->nextLevel = 0;
635 }
636 }
637
638 /**
639 * Includes static template records (from static_template table) and static template files (from extensions) for the input template record row.
640 *
641 * @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.
642 * @param string The id of the current template. Same syntax as $idList ids, eg. "sys_123"
643 * @param array The PID of the input template record
644 * @param array A full TypoScript template record
645 * @return void
646 * @see processTemplate()
647 */
648 function includeStaticTypoScriptSources($idList,$templateID,$pid,$row) {
649 // Static Template Records (static_template): include_static is a list of static templates to include
650 if (trim($row['include_static'])) {
651 $include_staticArr = t3lib_div::intExplode(',', $row['include_static']);
652 foreach ($include_staticArr as $id) { // traversing list
653 if (!t3lib_div::inList($idList,'static_'.$id)) { // if $id is not allready included ...
654 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'static_template', 'uid='.intval($id));
655 if ($subrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { // there was a template, then we fetch that
656 $subrow = $this->prependStaticExtra($subrow);
657 $this->processTemplate($subrow,$idList.',static_'.$id,$pid,'static_'.$id,$templateID);
658 }
659 $GLOBALS['TYPO3_DB']->sql_free_result($res);
660 }
661 }
662 }
663
664 // Static Template Files (Text files from extensions): include_static_file is a list of static files to include (from extensions)
665 if (trim($row['include_static_file'])) {
666 $include_static_fileArr = t3lib_div::trimExplode(',', $row['include_static_file'], true);
667 foreach ($include_static_fileArr as $ISF_file) { // traversing list
668 if (substr($ISF_file,0,4)=='EXT:') {
669 list($ISF_extKey,$ISF_localPath) = explode('/',substr($ISF_file,4),2);
670 if (strcmp($ISF_extKey,'') && t3lib_extMgm::isLoaded($ISF_extKey) && strcmp($ISF_localPath,'')) {
671 $ISF_localPath = rtrim($ISF_localPath, '/').'/';
672 $ISF_filePath = t3lib_extMgm::extPath($ISF_extKey).$ISF_localPath;
673 if (@is_dir($ISF_filePath)) {
674 $mExtKey = str_replace('_','',$ISF_extKey.'/'.$ISF_localPath);
675 $subrow=array(
676 'constants'=> @is_file($ISF_filePath.'constants.txt') ?t3lib_div::getUrl($ISF_filePath.'constants.txt'):'',
677 'config'=> @is_file($ISF_filePath.'setup.txt') ?t3lib_div::getUrl($ISF_filePath.'setup.txt'):'',
678 'editorcfg'=> @is_file($ISF_filePath.'editorcfg.txt') ?t3lib_div::getUrl($ISF_filePath.'editorcfg.txt'):'',
679 'include_static'=> @is_file($ISF_filePath.'include_static.txt')?implode(',',array_unique(t3lib_div::intExplode(',',t3lib_div::getUrl($ISF_filePath.'include_static.txt')))):'',
680 'include_static_file'=> @is_file($ISF_filePath.'include_static_file.txt')?implode(',',array_unique(explode(',',t3lib_div::getUrl($ISF_filePath.'include_static_file.txt')))):'',
681 'title' => $ISF_file,
682 'uid' => $mExtKey
683 );
684 $subrow = $this->prependStaticExtra($subrow);
685
686 $this->processTemplate($subrow,$idList.',ext_'.$mExtKey,$pid, 'ext_'.$mExtKey,$templateID);
687 }
688 }
689 }
690 }
691 }
692
693 $this->addExtensionStatics($idList,$templateID,$pid,$row);
694 }
695
696 /**
697 * Adds the default TypoScript files for extensions if any.
698 *
699 * @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.
700 * @param string The id of the current template. Same syntax as $idList ids, eg. "sys_123"
701 * @param array The PID of the input template record
702 * @param array A full TypoScript template record
703 * @return void
704 * @access private
705 * @see includeStaticTypoScriptSources()
706 */
707 function addExtensionStatics($idList,$templateID,$pid,$row) {
708 global $TYPO3_LOADED_EXT;
709
710 if ($row['static_file_mode']==1 || ($row['static_file_mode']==0 && substr($templateID,0,4)=='sys_' && $row['root'])) {
711 foreach ($TYPO3_LOADED_EXT as $extKey => $files) {
712 if (is_array($files) && ($files['ext_typoscript_constants.txt'] || $files['ext_typoscript_setup.txt'] || $files['ext_typoscript_editorcfg.txt'])) {
713 $mExtKey = str_replace('_','',$extKey);
714 $subrow=array(
715 'constants'=> $files['ext_typoscript_constants.txt']?t3lib_div::getUrl($files['ext_typoscript_constants.txt']):'',
716 'config'=> $files['ext_typoscript_setup.txt']?t3lib_div::getUrl($files['ext_typoscript_setup.txt']):'',
717 'editorcfg'=> $files['ext_typoscript_editorcfg.txt']?t3lib_div::getUrl($files['ext_typoscript_editorcfg.txt']):'',
718 'title' => $extKey,
719 'uid' => $mExtKey
720 );
721 $subrow = $this->prependStaticExtra($subrow);
722
723 $this->processTemplate($subrow,$idList.',ext_'.$mExtKey,$pid, 'ext_'.$mExtKey,$templateID);
724 }
725 }
726 }
727 }
728
729 /**
730 * Appends (not prepends) additional TypoScript code to static template records/files as set in TYPO3_CONF_VARS
731 * For records the "uid" value is the integer of the "static_template" record
732 * 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
733 *
734 * @param array Static template record/file
735 * @return array Returns the input array where the values for keys "config", "constants" and "editorcfg" may have been modified with prepended code.
736 * @access private
737 * @see addExtensionStatics(), includeStaticTypoScriptSources()
738 */
739 function prependStaticExtra($subrow) {
740 $subrow['config'].=$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_setup.'][$subrow['uid']];
741 $subrow['editorcfg'].=$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_editorcfg.'][$subrow['uid']];
742 $subrow['constants'].=$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_constants.'][$subrow['uid']];
743 return $subrow;
744 }
745
746 /**
747 * Creating versioning overlay of a sys_template record. This will use either frontend or backend overlay functionality depending on environment.
748 *
749 * @param array Row to overlay.
750 * @return void Row is passed by reference.
751 */
752 function versionOL(&$row) {
753 if (is_object($GLOBALS['TSFE'])) { // Frontend:
754 $GLOBALS['TSFE']->sys_page->versionOL('sys_template',$row);
755 } else { // Backend:
756 t3lib_BEfunc::workspaceOL('sys_template',$row);
757 }
758 }
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776 /*******************************************************************
777 *
778 * Parsing TypoScript code text from Template Records into PHP array
779 *
780 *******************************************************************/
781
782 /**
783 * Generates the configuration array by replacing constants and parsing the whole thing.
784 * Depends on $this->config and $this->constants to be set prior to this! (done by processTemplate/runThroughTemplates)
785 *
786 * @return void
787 * @see t3lib_TSparser, start()
788 */
789 function generateConfig() {
790 // Add default TS for all three code types:
791 array_unshift($this->constants,''.$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_constants']); // Adding default TS/constants
792 array_unshift($this->config,''.$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_setup']); // Adding default TS/setup
793 array_unshift($this->editorcfg,''.$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_editorcfg']); // Adding default TS/editorcfg
794
795 // Parse the TypoScript code text for include-instructions!
796 $this->procesIncludes();
797
798 // These vars are also set lateron...
799 $this->setup['resources']= $this->resources;
800 $this->setup['sitetitle']= $this->sitetitle;
801
802
803
804 // ****************************
805 // Parse TypoScript Constants
806 // ****************************
807
808 // Initialize parser and match-condition classes:
809 $constants = t3lib_div::makeInstance('t3lib_TSparser');
810 $constants->breakPointLN=intval($this->ext_constants_BRP);
811 $constants->setup = $this->const;
812 $constants->setup = $this->mergeConstantsFromPageTSconfig($constants->setup);
813
814 /* @var $matchObj t3lib_matchCondition_frontend */
815 $matchObj = t3lib_div::makeInstance('t3lib_matchCondition_frontend');
816 $matchObj->setSimulateMatchConditions($this->matchAlternative);
817 $matchObj->setSimulateMatchResult((bool)$this->matchAll);
818
819 // Traverse constants text fields and parse them
820 foreach($this->constants as $str) {
821 $constants->parse($str,$matchObj);
822 }
823
824 // Read out parse errors if any
825 $this->parserErrors['constants']=$constants->errors;
826
827 // 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)
828 $this->flatSetup = Array();
829 $this->flattenSetup($constants->setup,'','');
830
831
832
833 // ***********************************************
834 // Parse TypoScript Setup (here called "config")
835 // ***********************************************
836 // Initialize parser and match-condition classes:
837 $config = t3lib_div::makeInstance('t3lib_TSparser');
838 $config->breakPointLN = intval($this->ext_config_BRP);
839 $config->regLinenumbers = $this->ext_regLinenumbers;
840 $config->regComments = $this->ext_regComments;
841 $config->setup = $this->setup;
842
843 // Transfer information about conditions found in "Constants" and which of them returned true.
844 $config->sections = $constants->sections;
845 $config->sectionsMatch = $constants->sectionsMatch;
846
847 // Traverse setup text fields and concatenate them into one, single string separated by a [GLOBAL] condition
848 $all='';
849 foreach($this->config as $str) {
850 $all.="\n[GLOBAL]\n".$str;
851 }
852
853 // Substitute constants in the Setup code:
854 if ($this->tt_track) $GLOBALS['TT']->push('Substitute Constants ('.count($this->flatSetup).')');
855 $all = $this->substituteConstants($all);
856 if ($this->tt_track) $GLOBALS['TT']->pull();
857
858 // Searching for possible unsubstituted constants left (only for information)
859 if (strstr($all,'{$')) {
860 $theConstList = array();
861 $findConst = explode('{$', $all);
862 array_shift($findConst);
863 foreach ($findConst as $constVal) {
864 $constLen=t3lib_div::intInRange(strcspn($constVal,'}'),0,50);
865 $theConstList[]='{$'.substr($constVal,0,$constLen+1);
866 }
867 if ($this->tt_track) $GLOBALS['TT']->setTSlogMessage(implode(', ',$theConstList).': Constants may remain un-substituted!!',2);
868 }
869
870 // Logging the textual size of the TypoScript Setup field text with all constants substituted:
871 if ($this->tt_track) $GLOBALS['TT']->setTSlogMessage('TypoScript template size as textfile: '.strlen($all).' bytes');
872
873 // Finally parse the Setup field TypoScript code (where constants are now substituted)
874 $config->parse($all,$matchObj);
875
876 // Read out parse errors if any
877 $this->parserErrors['config']=$config->errors;
878
879 // Transfer the TypoScript array from the parser object to the internal $this->setup array:
880 $this->setup = $config->setup;
881 if ($this->backend_info) {
882 $this->setup_constants = $constants->setup; // Used for backend purposes only
883 }
884
885
886
887
888 // **************************************************
889 // Parse Backend Editor Configuration (backend only)
890 // **************************************************
891 if ($this->parseEditorCfgField) {
892 $editorcfg = t3lib_div::makeInstance('t3lib_TSparser');
893 $editorcfg->breakPointLN=intval($this->ext_editorcfg_BRP);
894 $editorcfg->setup = array(); // Empty as a start...
895
896 $all = implode("\n[GLOBAL]\n",$this->editorcfg);
897
898 // substitute constants in config
899 $all = $this->substituteConstants($all);
900
901 // parse Config
902 $matchObj->matchAll=1; // This should make sure that conditions are disabled. For now they are NOT active for the backend.
903 $editorcfg->parse($all,$matchObj);
904 $this->parserErrors['editorcfg']=$editorcfg->errors;
905 $this->setup_editorcfg = $editorcfg->setup;
906 }
907
908
909
910
911
912 // ****************************************************************
913 // Final processing of the $this->setup TypoScript Template array
914 // Basically: This is unsetting/setting of certain reserved keys.
915 // ****************************************************************
916
917 // 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!
918 unset($this->setup['resources']);
919 unset($this->setup['resources.']);
920 $this->setup['resources']= implode(',',t3lib_div::trimExplode(',',$this->resources,1));
921
922 unset($this->setup['sitetitle']);
923 unset($this->setup['sitetitle.']);
924 $this->setup['sitetitle']= $this->sitetitle;
925
926 // Unsetting some vars...
927 unset($this->setup['types.']);
928 unset($this->setup['types']);
929 if (is_array($this->setup)) {
930 foreach ($this->setup as $key => $value) {
931 if ($value=='PAGE') {
932 // Set the typeNum of the current page object:
933 if (isset($this->setup[$key.'.']['typeNum'])) {
934 $typeNum = $this->setup[$key.'.']['typeNum'];
935 $this->setup['types.'][$typeNum] = $key;
936 // If there is no type 0 yet and typeNum was not set, we use the current object as the default
937 } elseif(!isset($this->setup['types.'][0]) || !$this->setup['types.'][0]) {
938 $this->setup['types.'][0] = $key;
939 }
940 }
941 }
942 }
943 unset($this->setup['styles.']);
944 unset($this->setup['temp.']);
945 unset($constants);
946
947 // Storing the conditions found/matched information:
948 $this->sections = $config->sections;
949 $this->sectionsMatch = $config->sectionsMatch;
950 }
951
952 /**
953 * Searching TypoScript code text (for constants, config (Setup) and editorcfg) for include instructions and does the inclusion if needed.
954 * Modifies
955 *
956 * @return void
957 * @see t3lib_TSparser, generateConfig()
958 */
959 function procesIncludes() {
960 $files = array();
961 foreach ($this->constants as &$value) {
962 $includeData = t3lib_TSparser::checkIncludeLines($value, 1, true);
963 $files = array_merge($files, $includeData['files']);
964 $value = $includeData['typoscript'];
965 }
966
967 foreach ($this->config as &$value) {
968 $includeData = t3lib_TSparser::checkIncludeLines($value, 1, true);
969 $files = array_merge($files, $includeData['files']);
970 $value = $includeData['typoscript'];
971 }
972
973 foreach ($this->editorcfg as &$value) {
974 $includeData = t3lib_TSparser::checkIncludeLines($value, 1, true);
975 $files = array_merge($files, $includeData['files']);
976 $value = $includeData['typoscript'];
977 }
978 if (count($files)) {
979 $files = array_unique($files);
980 foreach ($files as $file) {
981 $this->rowSum[] = Array($file, filemtime($file));
982 }
983 }
984 }
985
986 /**
987 * 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!
988 *
989 * @param array Constants array, default input.
990 * @return array Constants array, modified
991 * @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...)
992 */
993 function mergeConstantsFromPageTSconfig($constArray) {
994 $TSdataArray = array();
995 $TSdataArray[]=$GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig']; // Setting default configuration:
996
997 for ($a=0;$a<=$this->outermostRootlineIndexWithTemplate;$a++) {
998 $TSdataArray[]=$this->absoluteRootLine[$a]['TSconfig'];
999 }
1000 // Parsing the user TS (or getting from cache)
1001 $TSdataArray = t3lib_TSparser::checkIncludeLines_array($TSdataArray);
1002 $userTS = implode(chr(10).'[GLOBAL]'.chr(10),$TSdataArray);
1003
1004 $parseObj = t3lib_div::makeInstance('t3lib_TSparser');
1005 $parseObj->parse($userTS);
1006
1007 if (is_array($parseObj->setup['TSFE.']['constants.'])) {
1008 $constArray = t3lib_div::array_merge_recursive_overrule($constArray,$parseObj->setup['TSFE.']['constants.']);
1009 }
1010 return $constArray;
1011 }
1012
1013 /**
1014 * This flattens a hierarchical TypoScript array to $this->flatSetup
1015 *
1016 * @param array TypoScript array
1017 * @param string Prefix to the object path. Used for recursive calls to this function.
1018 * @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.
1019 * @return void
1020 * @see generateConfig()
1021 */
1022 function flattenSetup($setupArray, $prefix, $resourceFlag) {
1023 if (is_array($setupArray)) {
1024 foreach ($setupArray as $key => $val) {
1025 if ($prefix || substr($key,0,16)!='TSConstantEditor') { // We don't want 'TSConstantEditor' in the flattend setup on the first level (190201)
1026 if (is_array($val)) {
1027 $this->flattenSetup($val,$prefix.$key, ($key=='file.'));
1028 } elseif ($resourceFlag) {
1029 $this->flatSetup[$prefix.$key] = $this->getFileName($val);
1030 } else {
1031 $this->flatSetup[$prefix.$key] = $val;
1032 }
1033 }
1034 }
1035 }
1036 }
1037
1038 /**
1039 * Substitutes the constants from $this->flatSetup in the text string $all
1040 *
1041 * @param string TypoScript code text string
1042 * @return string The processed string with all constants found in $this->flatSetup as key/value pairs substituted.
1043 * @see generateConfig(), flattenSetup()
1044 */
1045 function substituteConstants($all) {
1046 if ($this->tt_track) $GLOBALS['TT']->setTSlogMessage('Constants to substitute: '.count($this->flatSetup));
1047
1048 $noChange = false;
1049 // recursive substitution of constants (up to 10 nested levels)
1050 for ($i = 0; $i < 10 && !$noChange; $i++) {
1051 $old_all = $all;
1052 $all = preg_replace_callback('/\{\$(.[^}]*)\}/', array($this, 'substituteConstantsCallBack'), $all);
1053 if ($old_all == $all) {
1054 $noChange = true;
1055 }
1056 }
1057
1058 return $all;
1059 }
1060
1061 /**
1062 * Call back method for preg_replace_callback in substituteConstants
1063 *
1064 * @param array Regular expression matches
1065 * @return string Replacement
1066 * @see substituteConstants()
1067 */
1068 function substituteConstantsCallBack($matches) {
1069 // replace {$CONST} if found in $this->flatSetup, else leave unchanged
1070 return isset($this->flatSetup[$matches[1]]) && !is_array($this->flatSetup[$matches[1]]) ? $this->flatSetup[$matches[1]] : $matches[0];
1071 }
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082 /*******************************************************************
1083 *
1084 * Various API functions, used from elsewhere in the frontend classes
1085 *
1086 *******************************************************************/
1087
1088 /**
1089 * Implementation of the "optionSplit" feature in TypoScript (used eg. for MENU objects)
1090 * 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.
1091 * The concept is known as "optionSplit" and is rather advanced to handle but quite powerful, in particular for creating menus in TYPO3.
1092 *
1093 * @param array A TypoScript array
1094 * @param integer The number of items for which to generated individual TypoScript arrays
1095 * @return array The individualized TypoScript array.
1096 * @see tslib_cObj::IMGTEXT(), tslib_menu::procesItemStates()
1097 * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=289&cHash=6604390b37
1098 */
1099 function splitConfArray($conf,$splitCount) {
1100
1101 // Initialize variables:
1102 $splitCount = intval($splitCount);
1103 $conf2 = Array();
1104
1105 if ($splitCount && is_array($conf)) {
1106
1107 // Initialize output to carry at least the keys:
1108 for ($aKey=0;$aKey<$splitCount;$aKey++) {
1109 $conf2[$aKey] = array();
1110 }
1111
1112 // Recursive processing of array keys:
1113 foreach($conf as $cKey => $val) {
1114 if (is_array($val)) {
1115 $tempConf = $this->splitConfArray($val,$splitCount);
1116 foreach($tempConf as $aKey => $val) {
1117 $conf2[$aKey][$cKey] = $val;
1118 }
1119 } else {
1120 // Splitting of all values on this level of the TypoScript object tree:
1121 if (!strstr($val,'|*|') && !strstr($val,'||')) {
1122 for ($aKey=0;$aKey<$splitCount;$aKey++) {
1123 $conf2[$aKey][$cKey] = $val;
1124 }
1125 } else {
1126 $main = explode ('|*|',$val);
1127 $mainCount = count($main);
1128
1129 $lastC = 0;
1130 $middleC = 0;
1131 $firstC = 0;
1132
1133 if ($main[0]) {
1134 $first = explode('||',$main[0]);
1135 $firstC = count($first);
1136 }
1137 if ($main[1]) {
1138 $middle = explode('||',$main[1]);
1139 $middleC = count($middle);
1140 }
1141 if ($main[2]) {
1142 $last = explode('||',$main[2]);
1143 $lastC = count($last);
1144 $value = $last[0];
1145 }
1146
1147 for ($aKey=0;$aKey<$splitCount;$aKey++) {
1148 if ($firstC && isset($first[$aKey])) {
1149 $value = $first[$aKey];
1150 } elseif ($middleC) {
1151 $value = $middle[($aKey-$firstC)%$middleC];
1152 }
1153 if ($lastC && $lastC>=($splitCount-$aKey)) {
1154 $value = $last[$lastC-($splitCount-$aKey)];
1155 }
1156 $conf2[$aKey][$cKey] = trim($value);
1157 }
1158 }
1159 }
1160 }
1161 }
1162 return $conf2;
1163 }
1164
1165 /**
1166 * Returns the reference to a 'resource' in TypoScript.
1167 * This could be from the filesystem if '/' is found in the value $fileFromSetup, else from the resource-list
1168 *
1169 * @param string TypoScript "resource" data type value.
1170 * @return string Resulting filename, if any.
1171 */
1172 function getFileName($fileFromSetup) {
1173 $file = trim($fileFromSetup);
1174 if (!$file) {
1175 return;
1176 } elseif (strstr($file,'../')) {
1177 if ($this->tt_track) $GLOBALS['TT']->setTSlogMessage('File path "'.$file.'" contained illegal string "../"!',3);
1178 return;
1179 }
1180 // cache
1181 $hash = md5($file);
1182 if (isset($this->fileCache[$hash])) {
1183 return $this->fileCache[$hash];
1184 }
1185
1186 if (!strcmp(substr($file,0,4),'EXT:')) {
1187 $newFile='';
1188 list($extKey,$script)=explode('/',substr($file,4),2);
1189 if ($extKey && t3lib_extMgm::isLoaded($extKey)) {
1190 $extPath=t3lib_extMgm::extPath($extKey);
1191 $newFile=substr($extPath,strlen(PATH_site)).$script;
1192 }
1193 if (!@is_file(PATH_site.$newFile)) {
1194 if ($this->tt_track) $GLOBALS['TT']->setTSlogMessage('Extension media file "'.$newFile.'" was not found!',3);
1195 return;
1196 } else $file=$newFile;
1197 }
1198
1199 // find
1200 if (strstr($file,'/')) { // here it is manual media
1201 if(!strcmp(substr($file,0,6),'media/')) $file = 'typo3/sysext/cms/tslib/'.$file;
1202 if (@is_file($this->getFileName_backPath.$file)) {
1203 $outFile = $file;
1204 $fileInfo = t3lib_div::split_fileref($outFile);
1205 $OK=0;
1206 foreach ($this->allowedPaths as $val) {
1207 if (substr($fileInfo['path'], 0, strlen($val))==$val) {
1208 $OK=1;
1209 break;
1210 }
1211 }
1212 if ($OK) {
1213 $this->fileCache[$hash]=$outFile;
1214 return $outFile;
1215 } elseif ($this->tt_track) $GLOBALS['TT']->setTSlogMessage('"'.$file.'" was not located in the allowed paths: ('.implode(',',$this->allowedPaths).')',3);
1216 } elseif ($this->tt_track) $GLOBALS['TT']->setTSlogMessage('"'.$this->getFileName_backPath.$file.'" is not a file (non-uploads/.. resource, did not exist).',3);
1217 } else { // Here it is uploaded media:
1218 $outFile = $this->extractFromResources($this->setup['resources'],$file);
1219 if ($outFile) {
1220 if (@is_file($this->uplPath.$outFile)) {
1221 $this->fileCache[$hash] = $this->uplPath.$outFile;
1222 return $this->uplPath.$outFile;
1223 } elseif ($this->tt_track) $GLOBALS['TT']->setTSlogMessage('"'.$this->uplPath.$outFile.'" is not a file (did not exist).',3);
1224 } elseif ($this->tt_track) $GLOBALS['TT']->setTSlogMessage('"'.$file.'" is not a file (uploads/.. resource).',3);
1225 }
1226 }
1227
1228 /**
1229 * Searches for the TypoScript resource filename in the list of resource filenames.
1230 *
1231 * @param string The resource file name list (from $this->setup['resources'])
1232 * @param string The resource value to match
1233 * @return string If found, this will be the resource filename that matched. Typically this file is found in "uploads/tf/"
1234 * @access private
1235 * @see getFileName()
1236 */
1237 function extractFromResources($res,$file) {
1238 if (t3lib_div::inList($res,$file)) {
1239 $outFile = $file;
1240 } elseif (strstr($file,'*')) {
1241 $fileparts=explode('*',$file);
1242 $c=count($fileparts);
1243 $files = t3lib_div::trimExplode(',', $res);
1244 foreach ($files as $file) {
1245 if (preg_match('/^'.quotemeta($fileparts[0]).'.*'.quotemeta($fileparts[$c-1]).'$/', $file)) {
1246 $outFile = $file;
1247 break;
1248 }
1249 }
1250 }
1251 return $outFile;
1252 }
1253
1254 /**
1255 * CheckFile runs through the $menuArr and checks every file-reference in $name
1256 * (Not used anywhere)
1257 *
1258 * @param string Property name in the menu array
1259 * @param array Menu array to traverse
1260 * @return array Modified menu array
1261 * @deprecated since TYPO3 3.6
1262 * @internal
1263 */
1264 function checkFile($name,$menuArr) {
1265 reset ($menuArr);
1266 while (list($aKey,)=each($menuArr)) {
1267 $menuArr[$aKey][$name] = $this->getFileName($menuArr[$aKey][$name]);
1268 }
1269 return $menuArr;
1270 }
1271
1272 /**
1273 * Compiles the content for the page <title> tag.
1274 *
1275 * @param string The input title string, typically the "title" field of a page's record.
1276 * @param boolean If set, then only the site title is outputted (from $this->setup['sitetitle'])
1277 * @param boolean If set, then "sitetitle" and $title is swapped
1278 * @return string The page title on the form "[sitetitle]: [input-title]". Not htmlspecialchar()'ed.
1279 * @see tslib_fe::tempPageCacheContent(), TSpagegen::renderContentWithHeader()
1280 */
1281 function printTitle($title,$no_title=0,$titleFirst=0) {
1282 $st = trim($this->setup['sitetitle']) ? $this->setup['sitetitle']:'';
1283 $title = $no_title ? '' : $title;
1284 if ($titleFirst) {
1285 $temp=$st;
1286 $st=$title;
1287 $title=$temp;
1288 }
1289 if ($title && $st) {
1290 return $st.': '.$title;
1291 } else {
1292 return $st.$title;
1293 }
1294 }
1295
1296 /**
1297 * Reads the fileContent of $fName and returns it.
1298 * Similar to t3lib_div::getUrl()
1299 *
1300 * @param string Absolute filepath to record
1301 * @return string The content returned
1302 * @see tslib_cObj::fileResource(), tslib_cObj::MULTIMEDIA(), t3lib_div::getUrl()
1303 */
1304 function fileContent($fName) {
1305 $incFile = $this->getFileName($fName);
1306 if ($incFile) {
1307 return @file_get_contents($incFile);
1308 }
1309 }
1310
1311 /**
1312 * Ordinary "wrapping" function. Used in the tslib_menu class and extension classes instead of the similar function in tslib_cObj
1313 *
1314 * @param string The content to wrap
1315 * @param string The wrap value, eg. "<b> | </b>"
1316 * @return string Wrapped input string
1317 * @see tslib_menu, tslib_cObj::wrap()
1318 */
1319 function wrap($content,$wrap) {
1320 if ($wrap) {
1321 $wrapArr = explode('|', $wrap);
1322 return trim($wrapArr[0]).$content.trim($wrapArr[1]);
1323 } else return $content;
1324 }
1325
1326 /**
1327 * Removes the "?" of input string IF the "?" is the last character.
1328 *
1329 * @param string Input string
1330 * @return string Output string, free of "?" in the end, if any such character.
1331 * @see linkData(), tslib_frameset::frameParams()
1332 */
1333 function removeQueryString($url) {
1334 if (substr($url,-1)=='?') {
1335 return substr($url,0,-1);
1336 } else {
1337 return $url;
1338 }
1339 }
1340
1341 /**
1342 * 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.
1343 * Call it like t3lib_TStemplate::sortedKeyList()
1344 *
1345 * @param array TypoScript array with numerical array in
1346 * @param boolean If set, then a value is not required - the properties alone will be enough.
1347 * @return array An array with all integer properties listed in numeric order.
1348 * @see tslib_cObj::cObjGet(), tslib_gifBuilder, tslib_imgmenu::makeImageMap()
1349 */
1350 function sortedKeyList($setupArr, $acceptOnlyProperties=false) {
1351 $keyArr = array();
1352 $setupArrKeys = array_keys($setupArr);
1353 foreach ($setupArrKeys as $key) {
1354 if ($acceptOnlyProperties || t3lib_div::testInt($key)) {
1355 $keyArr[] = intval($key);
1356 }
1357 }
1358 $keyArr = array_unique($keyArr);
1359 sort($keyArr);
1360 return $keyArr;
1361 }
1362
1363
1364 /**
1365 * Returns the level of the given page in the rootline - Multiple pages can be given by separating the UIDs by comma.
1366 *
1367 * @param string A list of UIDs for which the rootline-level should get returned
1368 * @return integer The level in the rootline. If more than one page was given the lowest level will get returned.
1369 */
1370 function getRootlineLevel($list) {
1371 $idx = 0;
1372 foreach($this->rootLine as $page) {
1373 if (t3lib_div::inList($list, $page['uid'])) {
1374 return $idx;
1375 }
1376 $idx++;
1377 }
1378 return false;
1379 }
1380
1381
1382
1383
1384
1385
1386
1387
1388 /*******************************************************************
1389 *
1390 * Functions for creating links
1391 *
1392 *******************************************************************/
1393
1394 /**
1395 * The mother of all functions creating links/URLs etc in a TypoScript environment.
1396 * See the references below.
1397 * Basically this function takes care of issues such as type,id,alias and Mount Points, URL rewriting (through hooks), M5/B6 encoded parameters etc.
1398 * 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.
1399 *
1400 * @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.
1401 * @param string Default target string to use IF not $page['target'] is set.
1402 * @param boolean If set, then the "&no_cache=1" parameter is included in the URL.
1403 * @param string Alternative script name if you don't want to use $GLOBALS['TSFE']->config['mainScript'] (normally set to "index.php")
1404 * @param array Array with overriding values for the $page array.
1405 * @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.
1406 * @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.
1407 * @param string The target Doamin, if any was detected in typolink
1408 * @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"
1409 * @see tslib_frameset::frameParams(), tslib_cObj::typoLink(), tslib_cObj::SEARCHRESULT(), TSpagegen::pagegenInit(), tslib_menu::link()
1410 */
1411 function linkData($page, $oTarget, $no_cache, $script, $overrideArray='', $addParams='', $typeOverride='', $targetDomain='') {
1412 global $TYPO3_CONF_VARS;
1413
1414 $LD = Array();
1415
1416 // Overriding some fields in the page record and still preserves the values by adding them as parameters. Little strange function.
1417 if (is_array($overrideArray)) {
1418 foreach($overrideArray as $theKey => $theNewVal) {
1419 $addParams.= '&real_'.$theKey.'='.rawurlencode($page[$theKey]);
1420 $page[$theKey] = $theNewVal;
1421 }
1422 }
1423
1424 // Adding Mount Points, "&MP=", parameter for the current page if any is set:
1425 if (!strstr($addParams,'&MP=')) {
1426 if (trim($GLOBALS['TSFE']->MP_defaults[$page['uid']])) { // Looking for hardcoded defaults:
1427 $addParams.= '&MP='.rawurlencode(trim($GLOBALS['TSFE']->MP_defaults[$page['uid']]));
1428 } elseif ($GLOBALS['TSFE']->config['config']['MP_mapRootPoints']) { // Else look in automatically created map:
1429 $m = $this->getFromMPmap($page['uid']);
1430 if ($m) {
1431 $addParams.= '&MP='.rawurlencode($m);
1432 }
1433 }
1434 }
1435
1436 // Setting ID/alias:
1437 if (!$script) {$script = $GLOBALS['TSFE']->config['mainScript'];}
1438 if ($page['alias']) {
1439 $LD['url'] = $script.'?id='.rawurlencode($page['alias']);
1440 } else {
1441 $LD['url'] = $script.'?id='.$page['uid'];
1442 }
1443 // Setting target
1444 $LD['target'] = trim($page['target']) ? trim($page['target']) : $oTarget;
1445
1446 // typeNum
1447 $typeNum = $this->setup[$LD['target'].'.']['typeNum'];
1448 if (!t3lib_div::testInt($typeOverride) && intval($GLOBALS['TSFE']->config['config']['forceTypeValue'])) {
1449 $typeOverride = intval($GLOBALS['TSFE']->config['config']['forceTypeValue']);
1450 }
1451 if (strcmp($typeOverride,'')) { $typeNum = $typeOverride; } // Override...
1452 if ($typeNum) {
1453 $LD['type'] = '&type='.intval($typeNum);
1454 } else {
1455 $LD['type'] = '';
1456 }
1457 $LD['orig_type'] = $LD['type']; // Preserving the type number.
1458
1459 // noCache
1460 $LD['no_cache'] = (trim($page['no_cache']) || $no_cache) ? '&no_cache=1' : '';
1461
1462 // linkVars
1463 if ($GLOBALS['TSFE']->config['config']['uniqueLinkVars']) {
1464 if ($addParams) {
1465 $LD['linkVars'] = t3lib_div::implodeArrayForUrl('',t3lib_div::explodeUrl2Array($GLOBALS['TSFE']->linkVars.$addParams));
1466 } else {
1467 $LD['linkVars'] = $GLOBALS['TSFE']->linkVars;
1468 }
1469 } else {
1470 $LD['linkVars'] = $GLOBALS['TSFE']->linkVars.$addParams;
1471 }
1472
1473 // Add absRefPrefix if exists.
1474 $LD['url'] = $GLOBALS['TSFE']->absRefPrefix.$LD['url'];
1475
1476 // 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.
1477 $LD['sectionIndex'] = $page['sectionIndex_uid'] ? '#c'.$page['sectionIndex_uid'] : '';
1478
1479 // Compile the normal total url
1480 $LD['totalURL']= $this->removeQueryString($LD['url'].$LD['type'].$LD['no_cache'].$LD['linkVars'].$GLOBALS['TSFE']->getMethodUrlIdToken).$LD['sectionIndex'];
1481
1482 // Call post processing function for link rendering:
1483 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_tstemplate.php']['linkData-PostProc'])) {
1484 $_params = array(
1485 'LD' => &$LD,
1486 'args' => array('page'=>$page, 'oTarget'=>$oTarget, 'no_cache'=>$no_cache, 'script'=>$script, 'overrideArray'=>$overrideArray, 'addParams'=>$addParams, 'typeOverride'=>$typeOverride,'targetDomain'=>$targetDomain),
1487 'typeNum' => $typeNum
1488 );
1489 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_tstemplate.php']['linkData-PostProc'] as $_funcRef) {
1490 t3lib_div::callUserFunction($_funcRef,$_params,$this);
1491 }
1492 }
1493
1494 // Return the LD-array
1495 return $LD;
1496 }
1497
1498 /**
1499 * Initializes the automatically created MPmap coming from the "config.MP_mapRootPoints" setting
1500 * Can be called many times with overhead only the first time since then the map is generated and cached in memory.
1501 *
1502 * @param integer Page id to return MPvar value for.
1503 * @return void
1504 * @see initMPmap_create()
1505 * @todo Implement some caching of the result between hits. (more than just the memory caching used here)
1506 */
1507 function getFromMPmap($pageId=0) {
1508
1509 // Create map if not found already:
1510 if (!is_array($this->MPmap)) {
1511 $this->MPmap = array();
1512
1513 $rootPoints = t3lib_div::trimExplode(',', strtolower($GLOBALS['TSFE']->config['config']['MP_mapRootPoints']),1);
1514 foreach($rootPoints as $p) { // Traverse rootpoints:
1515 if ($p == 'root') {
1516 $p = $this->rootLine[0]['uid'];
1517 $initMParray = array();
1518 if ($this->rootLine[0]['_MOUNT_OL'] && $this->rootLine[0]['_MP_PARAM']) {
1519 $initMParray[] = $this->rootLine[0]['_MP_PARAM'];
1520 }
1521 }
1522 $this->initMPmap_create($p,$initMParray);
1523 }
1524 }
1525
1526 // Finding MP var for Page ID:
1527 if ($pageId) {
1528 if (is_array($this->MPmap[$pageId]) && count($this->MPmap[$pageId])) {
1529 return implode(',',$this->MPmap[$pageId]);
1530 }
1531 }
1532 }
1533
1534 /**
1535 * Creating MPmap for a certain ID root point.
1536 *
1537 * @param integer Root id from which to start map creation.
1538 * @param array MP_array passed from root page.
1539 * @param integer Recursion brake. Incremented for each recursive call. 20 is the limit.
1540 * @return void
1541 * @see getFromMPvar()
1542 */
1543 function initMPmap_create($id,$MP_array=array(),$level=0) {
1544
1545 $id = intval($id);
1546 if($id<=0) return;
1547
1548 // First level, check id
1549 if (!$level) {
1550
1551 // Find mount point if any:
1552 $mount_info = $GLOBALS['TSFE']->sys_page->getMountPointInfo($id);
1553
1554 // Overlay mode:
1555 if (is_array($mount_info) && $mount_info['overlay']) {
1556 $MP_array[] = $mount_info['MPvar'];
1557 $id = $mount_info['mount_pid'];
1558 }
1559
1560 // Set mapping information for this level:
1561 $this->MPmap[$id] = $MP_array;
1562
1563 // Normal mode:
1564 if (is_array($mount_info) && !$mount_info['overlay']) {
1565 $MP_array[] = $mount_info['MPvar'];
1566 $id = $mount_info['mount_pid'];
1567 }
1568 }
1569
1570 if ($id && $level<20) {
1571
1572 $nextLevelAcc = array();
1573
1574 // Select and traverse current level pages:
1575 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1576 'uid,pid,doktype,mount_pid,mount_pid_ol',
1577 'pages',
1578 'pid='.intval($id).' AND deleted=0 AND doktype!=255 AND doktype!=6' // 255 = Garbage bin, 6 = Backend User Section
1579 );
1580 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1581
1582 // Find mount point if any:
1583 $next_id = $row['uid'];
1584 $next_MP_array = $MP_array;
1585 $mount_info = $GLOBALS['TSFE']->sys_page->getMountPointInfo($next_id, $row);
1586
1587 // Overlay mode:
1588 if (is_array($mount_info) && $mount_info['overlay']) {
1589 $next_MP_array[] = $mount_info['MPvar'];
1590 $next_id = $mount_info['mount_pid'];
1591 }
1592
1593 if (!isset($this->MPmap[$next_id])) {
1594
1595 // Set mapping information for this level:
1596 $this->MPmap[$next_id] = $next_MP_array;
1597
1598 // Normal mode:
1599 if (is_array($mount_info) && !$mount_info['overlay']) {
1600 $next_MP_array[] = $mount_info['MPvar'];
1601 $next_id = $mount_info['mount_pid'];
1602 }
1603
1604 // Register recursive call
1605 // (have to do it this way since ALL of the current level should be registered BEFORE the sublevel at any time)
1606 $nextLevelAcc[] = array($next_id,$next_MP_array);
1607 }
1608 }
1609
1610 // Call recursively, if any:
1611 foreach($nextLevelAcc as $pSet) {
1612 $this->initMPmap_create($pSet[0],$pSet[1],$level+1);
1613 }
1614 }
1615 }
1616 }
1617
1618
1619 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tstemplate.php']) {
1620 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tstemplate.php']);
1621 }
1622
1623 ?>