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