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