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