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