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