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