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