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