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