2 /***************************************************************
5 * (c) 1999-2004 Kasper Skaarhoj (kasperYYYY@typo3.com)
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.
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.
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.
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
28 * Class with template object that is responsible for generating the template
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
33 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
36 * [CLASS/FUNCTION INDEX of SCRIPT]
40 * 107: class t3lib_TStemplate
41 * 209: function init()
42 * 247: function getCurrentPageData()
43 * 264: function matching($cc)
44 * 288: function start($theRootLine)
46 * SECTION: Fetching TypoScript code text for the Template Hierarchy
47 * 403: function runThroughTemplates($theRootLine,$start_template_uid=0)
48 * 450: function processTemplate($row, $idList,$pid,$templateID='',$templateParent='')
49 * 565: function includeStaticTypoScriptSources($idList,$templateID,$pid,$row)
50 * 626: function addExtensionStatics($idList,$templateID,$pid,$row)
51 * 659: function prependStaticExtra($subrow)
53 * SECTION: Parsing TypoScript code text from Template Records into PHP array
54 * 695: function generateConfig()
55 * 859: function procesIncludes()
56 * 883: function mergeConstantsFromPageTSconfig($constArray)
57 * 912: function flattenSetup($setupArray, $prefix, $resourceFlag)
58 * 936: function substituteConstants($all)
60 * SECTION: Various API functions, used from elsewhere in the frontend classes
61 * 974: function splitConfArray($conf,$splitCount)
62 * 1051: function getFileName($fileFromSetup)
63 * 1108: function extractFromResources($res,$file)
64 * 1136: function checkFile($name,$menuArr)
65 * 1153: function printTitle($title,$no_title=0,$titleFirst=0)
66 * 1176: function fileContent($fName)
67 * 1196: function wrap($content,$wrap)
68 * 1210: function removeQueryString($url)
69 * 1227: function sortedKeyList($setupArr, $acceptOnlyProperties=FALSE)
71 * SECTION: Functions for creating links
72 * 1274: function linkData($page,$oTarget,$no_cache,$script,$overrideArray='',$addParams='',$typeOverride='')
73 * 1393: function getFromMPmap($pageId=0)
74 * 1429: function initMPmap_create($id,$MP_array=array(),$level=0)
77 * (This index is automatically created/updated by the extension "extdeveval")
81 require_once (PATH_t3lib
.'class.t3lib_tsparser.php');
82 require_once (PATH_t3lib
.'class.t3lib_matchcondition.php');
100 * Template object that is responsible for generating the TypoScript template based on template records.
102 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
105 * @see t3lib_tsparser.php, t3lib_matchcondition.php
107 class t3lib_TStemplate
{
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.
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()
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;
127 var $uplPath = 'uploads/tf/';
128 var $tempPath = 'typo3temp/';
129 var $menuclasses = 'gmenu,tmenu,imgmenu,jsmenu';
132 var $whereClause = ''; // This MUST be initialized by the init() function
134 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.
135 var $currentPageData = ''; // Contains "currentPageData" when rendered/fetched from cache. See getCurrentPageData()
136 var $simulationHiddenOrTime=0; // See init(); Set if preview of some kind is enabled.
138 var $loaded = 0; // Set, if the TypoScript template structure is loaded and OK, see ->start()
139 var $setup = Array( // Default TypoScript Setup code
141 'insertContent' => 'CONTENT',
142 'insertContent.' => Array (
143 'table' => 'tt_content',
145 'orderBy' => 'sorting',
146 'where' => 'colPos=0',
147 'languageField' => 'sys_language_uid'
152 'extTarget' => '_top',
154 'stat_typeNumList' => '0,1'
157 var $flatSetup = Array (
159 var $const = Array ( // Default TypoScript Constants code:
160 '_clear' => '<img src="clear.gif" width="1" height="1" alt="" />',
161 '_blackBorderWrap' => '<table border="0" bgcolor="black" cellspacing="0" cellpadding="1"><tr><td> | </td></tr></table>',
162 '_tableWrap' => '<table border="0" cellspacing="0" cellpadding="0"> | </table>',
163 '_tableWrap_DEBUG' => '<table border="1" cellspacing="0" cellpadding="0"> | </table>',
164 '_stdFrameParams' => 'frameborder="no" marginheight="0" marginwidth="0" noresize="noresize"',
165 '_stdFramesetParams' => 'border="0" framespacing="0" frameborder="no"'
169 // For fetching TypoScript code from template hierarchy before parsing it. Each array contains code field values from template records/files:
170 var $config = array(); // Setup field
171 var $constants = array(); // Constant field
172 var $editorcfg = array(); // Backend Editor Configuration field
174 var $hierarchyInfo = array(); // For Template Analyser in backend
175 var $hierarchyInfoToRoot = array(); // For Template Analyser in backend (setup content only)
176 var $nextLevel=0; // Next-level flag (see runThroughTemplates())
177 var $rootId; // The Page UID of the root page
178 var $rootLine; // The rootline from current page to the root page
179 var $absoluteRootLine; // Rootline all the way to the root. Set but runThroughTemplates
180 var $outermostRootlineIndexWithTemplate=0; // A pointer to the last entry in the rootline where a template was found.
181 var $rowSum; // Array of arrays with title/uid of templates in hierarchy
182 var $resources=''; // Resources for the template hierarchy in a comma list
183 var $sitetitle=''; // The current site title field.
184 var $sections; // Tracking all conditions found during parsing of TypoScript. Used for the "all" key in currentPageData
185 var $sectionsMatch; // Tracking all matching conditions found
187 // Backend: ts_analyzer
188 var $clearList_const=array();
189 var $clearList_setup=array();
190 var $clearList_editorcfg=array();
191 var $parserErrors=array();
192 var $setup_constants = array();
195 var $fileCache = Array(); // Used by getFileName for caching of references to file resources
196 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.
197 var $MPmap = ''; // Contains mapping of Page id numbers to MP variables.
204 * MUST be called directly after creating a new template-object
207 * @see tslib_fe::initTemplate()
210 // $this->whereClause is used only to select templates from sys_template.
211 // $GLOBALS['SIM_EXEC_TIME'] is used so that we're able to simulate a later time as a test...
212 $this->whereClause
='AND deleted=0 ';
213 if (!$GLOBALS['TSFE']->showHiddenRecords
) {
214 $this->whereClause
.='AND hidden=0 ';
216 if ($GLOBALS['TSFE']->showHiddenRecords ||
$GLOBALS['SIM_EXEC_TIME']!=$GLOBALS['EXEC_TIME']) { // Set the simulation flag, if simulation is detected!
217 $this->simulationHiddenOrTime
=1;
219 $this->whereClause
.= 'AND (starttime<='.$GLOBALS['SIM_EXEC_TIME'].') AND (endtime=0 OR endtime>'.$GLOBALS['SIM_EXEC_TIME'].')';
220 if (!$GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib']) {
221 $this->menuclasses
='tmenu,jsmenu,gmenu';
224 // Sets the paths from where TypoScript resources are allowed to be used:
225 $this->allowedPaths
= Array ('media/','fileadmin/','uploads/','typo3temp/','t3lib/fonts/',TYPO3_mainDir
.'ext/',TYPO3_mainDir
.'sysext/','typo3conf/ext/');
226 if ($GLOBALS['TYPO3_CONF_VARS']['FE']['addAllowedPaths']) {
227 $pathArr = t3lib_div
::trimExplode(',',$GLOBALS['TYPO3_CONF_VARS']['FE']['addAllowedPaths'],1);
228 while(list(,$p)=each($pathArr)) {
229 // 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.
230 $this->allowedPaths
[] = $p;
236 * Fetches the "currentPageData" array from cache
238 * NOTE about currentPageData:
239 * It holds information about the TypoScript conditions along with the list of template uid's which is used on the page.
240 * In the getFromCache function in TSFE, currentPageData is used to evaluate if there is a template and if the matching conditions are alright
241 * Unfortunately this does not take into account if the templates in the rowSum of currentPageData has changed composition, eg. due to hidden fields or start/end time.
242 * So if a template is hidden or times out, it'll not be discovered unless the page is regenerated - at least the this->start function must be called, because this will make a new portion of data in currentPageData string
244 * @return mixed The array $this->currentPageData if found cached in "cache_pagesection". If the string "none" was returned it means the array must be generated and stored in the cache-table
245 * @see start(), t3lib_fe::getFromCache()
247 function getCurrentPageData() {
248 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('content', 'cache_pagesection', 'page_id='.intval($GLOBALS['TSFE']->id
).' AND mpvar_hash='.t3lib_div
::md5int($GLOBALS['TSFE']->MP
));
249 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
250 $this->currentPageData
= unserialize($row['content']);
252 $this->currentPageData
= 'none';
254 return $this->currentPageData
;
258 * Fetches data about which TypoScript-matches there are at this page. Then it performs a matchingtest.
260 * @param array An array with three keys, "all", "rowSum" and "rootLine" - all coming from the $this->currentPageData array
261 * @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.
262 * @see t3lib_matchCondition, t3lib_fe::getFromCache()
264 function matching($cc) {
265 if (is_array($cc['all'])) {
267 $matchObj = t3lib_div
::makeInstance('t3lib_matchCondition');
268 $matchObj->altRootLine
=$cc['rootLine'];
269 while(list($key,$pre)=each($cc['all'])) {
270 if ($matchObj->match($pre)) {
271 $sectionsMatch[$key]=$pre;
274 $cc['match']=$sectionsMatch;
280 * This is all about fetching the right TypoScript template structure. If it's not cached then it must be generated and cached!
281 * The method traverse the rootline structure from out to in, fetches the hierarchy of template records and based on this either finds the cached TypoScript template structure or parses the template and caches it for next time.
282 * Sets $this->setup to the parsed TypoScript Template array
284 * @param array The rootline of the current page (going ALL the way to tree root)
286 * @see tslib_fe::getConfigArray()
288 function start($theRootLine) {
289 if (is_array($theRootLine)) {
293 $this->runThroughTemplates($theRootLine);
295 // Getting the currentPageData if not already found
296 if (!$this->currentPageData
) {
297 $this->getCurrentPageData();
300 // This is about getting the hash string which is used to fetch the cached TypoScript template.
301 // If there was some cached currentPageData that's good (it gives us the hash),
302 // However if the actual rowSum and the rowSum of currentPageData is different from each other, thats a problem, and we should re-make the current page data.
303 if (is_array($this->currentPageData
) &&
304 !strcmp(serialize($this->rowSum
), serialize($this->currentPageData
['rowSum'])) // The two ROWsums must NOT be different from each other - which they will be if start/endtime or hidden has changed!
306 // If currentPageData was actually there, we match the result...
307 $cc['all'] = $this->currentPageData
['all'];
308 $cc['rowSum'] = $this->currentPageData
['rowSum'];
309 $cc = $this->matching($cc);
310 $hash = md5(serialize($cc));
312 // If currentPageData was not there, we first find $rowSum (freshly generated). After that we try to see, if rowSum is stored with a list of all matching-parameters. If so we match the result
313 $rowSumHash = md5('ROWSUM:'.serialize($this->rowSum
));
314 $result = t3lib_pageSelect
::getHash($rowSumHash, 0);
316 $cc['all'] = unserialize($result);
317 $cc['rowSum'] = $this->rowSum
;
318 $cc = $this->matching($cc);
319 $hash = md5(serialize($cc));
324 // Get TypoScript setup array
325 $setupData = t3lib_pageSelect
::getHash($hash, 0);
328 if ($hash && $setupData && !$this->forceTemplateParsing
) {
329 // If TypoScript setup structure was cached we unserialize it here:
330 $this->setup
= unserialize($setupData);
332 // Make configuration
333 $this->generateConfig();
335 // This stores the template hash thing
337 $cc['all']=$this->sections
; // All sections in the template at this point is found
338 $cc['rowSum']=$this->rowSum
; // The line of templates is collected
339 $cc = $this->matching($cc);
341 $hash = md5(serialize($cc));
343 // This stores the data.
344 t3lib_pageSelect
::storeHash($hash, serialize($this->setup
), 'TS TEMPLATE');
346 if ($this->tt_track
) $GLOBALS['TT']->setTSlogMessage('TS template size, serialized: '.strlen(serialize($this->setup
)).' bytes');
348 $rowSumHash = md5('ROWSUM:'.serialize($this->rowSum
));
349 t3lib_pageSelect
::storeHash($rowSumHash, serialize($cc['all']), 'TMPL CONDITIONS - AL');
352 $cc['rootLine'] = $this->rootLine
;
353 // Make global and save.
354 $GLOBALS['TSFE']->all
=$cc;
356 if (!$this->simulationHiddenOrTime
) { // Only save currentPageData, if we're not simulating by hidden/starttime/endtime
357 $insertFields = array(
358 'page_id' => intval($GLOBALS['TSFE']->id
),
359 'mpvar_hash' => t3lib_div
::md5int($GLOBALS['TSFE']->MP
),
360 'content' => serialize($cc),
361 'tstamp' => $GLOBALS['EXEC_TIME']
363 $GLOBALS['TYPO3_DB']->exec_DELETEquery('cache_pagesection', 'page_id='.intval($GLOBALS['TSFE']->id
).' AND mpvar_hash='.t3lib_div
::md5int($GLOBALS['TSFE']->MP
));
365 $GLOBALS['TYPO3_DB']->exec_INSERTquery('cache_pagesection', $insertFields);
368 if ($this->rootId
&& $this->rootLine
&& $this->setup
) {
388 /*******************************************************************
390 * Fetching TypoScript code text for the Template Hierarchy
392 *******************************************************************/
395 * 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.
396 * Resets and affects internal variables like $this->constants, $this->config, $this->editorcfg and $this->rowSum
397 * 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
399 * @param array The rootline of the current page (going ALL the way to tree root)
400 * @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)
404 function runThroughTemplates($theRootLine,$start_template_uid=0) {
405 $this->constants
= Array();
406 $this->config
= Array();
407 $this->editorcfg
= Array();
408 $this->rowSum
= Array();
409 $this->hierarchyInfoToRoot
= Array();
410 $this->absoluteRootLine
=$theRootLine; // Is the TOTAL rootline
412 reset ($this->absoluteRootLine
);
413 $c=count($this->absoluteRootLine
);
414 for ($a=0;$a<$c;$a++
) {
415 if ($this->nextLevel
) { // If some template loaded before has set a template-id for the next level, then load this template first!
416 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_template', 'uid='.intval($this->nextLevel
).' '.$this->whereClause
);
417 $this->nextLevel
= 0;
418 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
419 $this->processTemplate($row,'sys_'.$row['uid'],$this->absoluteRootLine
[$a]['uid'],'sys_'.$row['uid']);
420 $this->outermostRootlineIndexWithTemplate
=$a;
422 $GLOBALS['TYPO3_DB']->sql_free_result($res);
425 if ($a==($c-1) && $start_template_uid) { // If first loop AND there is set an alternative template uid, use that
426 $addC=' AND uid='.intval($start_template_uid);
429 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_template', 'pid='.intval($this->absoluteRootLine
[$a]['uid']).$addC.' '.$this->whereClause
,'','sorting',1);
430 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
431 $this->processTemplate($row,'sys_'.$row['uid'],$this->absoluteRootLine
[$a]['uid'],'sys_'.$row['uid']);
432 $this->outermostRootlineIndexWithTemplate
=$a;
434 $GLOBALS['TYPO3_DB']->sql_free_result($res);
435 $this->rootLine
[] = $this->absoluteRootLine
[$a];
440 * Checks if the template ($row) has some included templates and after including them it fills the arrays with the setup
441 * Builds up $this->rowSum
443 * @param array A full TypoScript template record (sys_template/static_template/forged "dummy" record made from static template file)
444 * @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.
445 * @param array The PID of the input template record
446 * @param string The id of the current template. Same syntax as $idList ids, eg. "sys_123"
447 * @param string Parent template id (during recursive call); Same syntax as $idList ids, eg. "sys_123"
449 * @see runThroughTemplates()
451 function processTemplate($row, $idList,$pid,$templateID='',$templateParent='') {
452 // Adding basic template record information to rowSum array
453 $this->rowSum
[]=Array($row['uid'],$row['title'],$row['tstamp']);
455 // Processing "Clear"-flags
457 $clConst = $row['clear']&1;
458 $clConf = $row['clear']&2;
460 $this->constants
= Array();
461 $this->clearList_const
=array();
464 $this->config
= Array();
465 $this->hierarchyInfoToRoot
= Array();
466 $this->clearList_setup
=array();
468 $this->editorcfg
= Array();
469 $this->clearList_editorcfg
=array();
473 // Include static records (static_template) or files (from extensions) (#1/2)
474 if (!$row['includeStaticAfterBasedOn']) { // NORMAL inclusion, The EXACT same code is found below the basedOn inclusion!!!
475 $this->includeStaticTypoScriptSources($idList,$templateID,$pid,$row);
478 // Include "Based On" sys_templates:
479 if (trim($row['basedOn'])) { // 'basedOn' is a list of templates to include
480 // Manually you can put this value in the field and then the based_on ID will be taken from the $_GET var defined by '=....'.
481 // 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!
482 // 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.
483 $basedOn_hackFeature = explode('=',$row['basedOn']);
484 if ($basedOn_hackFeature[0]=='EXTERNAL_BASED_ON_TEMPLATE_ID' && $basedOn_hackFeature[1]) {
485 $id = intval(t3lib_div
::_GET($basedOn_hackFeature[1]));
486 if ($id && !t3lib_div
::inList($idList,'sys_'.$id)) { // if $id is not allready included ...
487 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_template', 'uid='.$id.' '.$this->whereClause
);
488 if ($subrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { // there was a template, then we fetch that
489 $this->processTemplate($subrow,$idList.',sys_'.$id,$pid, 'sys_'.$id,$templateID);
491 $GLOBALS['TYPO3_DB']->sql_free_result($res);
493 } else { // NORMAL OPERATION:
494 $basedOnArr = t3lib_div
::intExplode(',',$row['basedOn']);
495 while(list(,$id)=each($basedOnArr)) { // traversing list
496 if (!t3lib_div
::inList($idList,'sys_'.$id)) { // if $id is not allready included ...
497 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_template', 'uid='.intval($id).' '.$this->whereClause
);
498 if ($subrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { // there was a template, then we fetch that
499 $this->processTemplate($subrow,$idList.',sys_'.$id,$pid, 'sys_'.$id,$templateID);
501 $GLOBALS['TYPO3_DB']->sql_free_result($res);
507 // Include static records (static_template) or files (from extensions) (#2/2)
508 if ($row['includeStaticAfterBasedOn']) {
509 $this->includeStaticTypoScriptSources($idList,$templateID,$pid,$row);
512 // Creating hierarchy information; Used by backend analysis tools
513 $this->hierarchyInfo
[] = $this->hierarchyInfoToRoot
[] = array(
514 'root'=>trim($row['root']),
515 'next'=>$row['nextLevel'],
518 'templateID'=>$templateID,
519 'templateParent'=>$templateParent,
520 'title'=>$row['title'],
523 'configLines' => substr_count($row['config'], chr(10))+
1
526 // Adding the content of the fields constants (Constants), config (Setup) and editorcfg (Backend Editor Configuration) to the internal arrays.
527 $this->constants
[] = $row['constants'];
528 $this->config
[] = $row['config'];
529 if ($this->parseEditorCfgField
) $this->editorcfg
[] = $row['editorcfg'];
531 // For backend analysis (Template Analyser) provide the order of added constants/config/editorcfg template IDs
532 $this->clearList_const
[]=$templateID;
533 $this->clearList_setup
[]=$templateID;
534 if ($this->parseEditorCfgField
) $this->clearList_editorcfg
[]=$templateID;
536 // Add resources and sitetitle if found:
537 if (trim($row['resources'])) {
538 $this->resources
= $row['resources'].','.$this->resources
;
540 if (trim($row['sitetitle'])) {
541 $this->sitetitle
= $row['sitetitle'];
543 // If the template record is a Rootlevel record, set the flag and clear the template rootLine (so it starts over from this point)
544 if (trim($row['root'])) {
545 $this->rootId
= $pid;
546 $this->rootLine
= Array();
548 // If a template is set to be active on the next level set this internal value to point to this UID. (See runThroughTemplates())
549 if ($row['nextLevel']) {
550 $this->nextLevel
= $row['nextLevel'];
552 $this->nextLevel
= 0;
557 * Includes static template records (from static_template table) and static template files (from extensions) for the input template record row.
559 * @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.
560 * @param string The id of the current template. Same syntax as $idList ids, eg. "sys_123"
561 * @param array The PID of the input template record
562 * @param array A full TypoScript template record
564 * @see processTemplate()
566 function includeStaticTypoScriptSources($idList,$templateID,$pid,$row) {
567 // Static Template Records (static_template): include_static is a list of static templates to include
568 if (trim($row['include_static'])) {
569 $include_staticArr = t3lib_div
::intExplode(',',$row['include_static']);
570 reset($include_staticArr);
571 while(list(,$id)=each($include_staticArr)) { // traversing list
572 if (!t3lib_div
::inList($idList,'static_'.$id)) { // if $id is not allready included ...
573 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'static_template', 'uid='.intval($id));
574 if ($subrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { // there was a template, then we fetch that
575 $subrow = $this->prependStaticExtra($subrow);
576 $this->processTemplate($subrow,$idList.',static_'.$id,$pid,'static_'.$id,$templateID);
578 $GLOBALS['TYPO3_DB']->sql_free_result($res);
583 // Static Template Files (Text files from extensions): include_static_file is a list of static files to include (from extensions)
584 if (trim($row['include_static_file'])) {
585 $include_static_fileArr = t3lib_div
::trimExplode(',',$row['include_static_file'],1);
586 reset($include_static_fileArr);
587 while(list(,$ISF_file)=each($include_static_fileArr)) { // traversing list
588 $ISF_file = trim($ISF_file);
589 if (substr($ISF_file,0,4)=='EXT:') {
590 list($ISF_extKey,$ISF_localPath) = explode('/',substr($ISF_file,4),2);
591 if (strcmp($ISF_extKey,'') && t3lib_extMgm
::isLoaded($ISF_extKey) && strcmp($ISF_localPath,'')) {
592 $ISF_localPath = ereg_replace('\/$','',$ISF_localPath).'/';
593 $ISF_filePath = t3lib_extMgm
::extPath($ISF_extKey).$ISF_localPath;
594 if (@is_dir
($ISF_filePath)) {
595 $mExtKey = str_replace('_','',$ISF_extKey.'/'.$ISF_localPath);
597 'constants'=> @is_file
($ISF_filePath.'constants.txt') ?t3lib_div
::getUrl($ISF_filePath.'constants.txt'):'',
598 'config'=> @is_file
($ISF_filePath.'setup.txt') ?t3lib_div
::getUrl($ISF_filePath.'setup.txt'):'',
599 'editorcfg'=> @is_file
($ISF_filePath.'editorcfg.txt') ?t3lib_div
::getUrl($ISF_filePath.'editorcfg.txt'):'',
600 'include_static'=> @is_file
($ISF_filePath.'include_static.txt')?
implode(',',array_unique(t3lib_div
::intExplode(',',t3lib_div
::getUrl($ISF_filePath.'include_static.txt')))):'',
601 'title' => $ISF_file,
604 $subrow = $this->prependStaticExtra($subrow);
606 $this->processTemplate($subrow,$idList.',ext_'.$mExtKey,$pid, 'ext_'.$mExtKey,$templateID);
613 $this->addExtensionStatics($idList,$templateID,$pid,$row);
617 * Adds the default TypoScript files for extensions if any.
619 * @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.
620 * @param string The id of the current template. Same syntax as $idList ids, eg. "sys_123"
621 * @param array The PID of the input template record
622 * @param array A full TypoScript template record
625 * @see includeStaticTypoScriptSources()
627 function addExtensionStatics($idList,$templateID,$pid,$row) {
628 global $TYPO3_LOADED_EXT;
630 if ($row['static_file_mode']==1 ||
($row['static_file_mode']==0 && substr($templateID,0,4)=='sys_' && $row['root'])) {
631 reset($TYPO3_LOADED_EXT);
632 while(list($extKey,$files)=each($TYPO3_LOADED_EXT)) {
633 if (is_array($files) && ($files['ext_typoscript_constants.txt'] ||
$files['ext_typoscript_setup.txt'] ||
$files['ext_typoscript_editorcfg.txt'])) {
634 $mExtKey = str_replace('_','',$extKey);
636 'constants'=> $files['ext_typoscript_constants.txt']?t3lib_div
::getUrl($files['ext_typoscript_constants.txt']):'',
637 'config'=> $files['ext_typoscript_setup.txt']?t3lib_div
::getUrl($files['ext_typoscript_setup.txt']):'',
638 'editorcfg'=> $files['ext_typoscript_editorcfg.txt']?t3lib_div
::getUrl($files['ext_typoscript_editorcfg.txt']):'',
642 $subrow = $this->prependStaticExtra($subrow);
644 $this->processTemplate($subrow,$idList.',ext_'.$mExtKey,$pid, 'ext_'.$mExtKey,$templateID);
651 * Appends (not prepends) additional TypoScript code to static template records/files as set in TYPO3_CONF_VARS
652 * For records the "uid" value is the integer of the "static_template" record
653 * 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
655 * @param array Static template record/file
656 * @return array Returns the input array where the values for keys "config", "constants" and "editorcfg" may have been modified with prepended code.
658 * @see addExtensionStatics(), includeStaticTypoScriptSources()
660 function prependStaticExtra($subrow) {
661 $subrow['config'].=$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_setup.'][$subrow['uid']];
662 $subrow['editorcfg'].=$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_editorcfg.'][$subrow['uid']];
663 $subrow['constants'].=$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_constants.'][$subrow['uid']];
683 /*******************************************************************
685 * Parsing TypoScript code text from Template Records into PHP array
687 *******************************************************************/
690 * Generates the configuration array by replacing constants and parsing the whole thing.
691 * Depends on $this->config and $this->constants to be set prior to this! (done by processTemplate/runThroughTemplates)
694 * @see t3lib_TSparser, start()
696 function generateConfig() {
697 // Add default TS for all three code types:
698 array_unshift($this->constants
,''.$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_constants']); // Adding default TS/constants
699 array_unshift($this->config
,''.$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_setup']); // Adding default TS/setup
700 array_unshift($this->editorcfg
,''.$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_editorcfg']); // Adding default TS/editorcfg
702 // Parse the TypoScript code text for include-instructions!
703 $this->procesIncludes();
705 // These vars are also set lateron...
706 $this->setup
['resources']= $this->resources
;
707 $this->setup
['sitetitle']= $this->sitetitle
;
711 // ****************************
712 // Parse TypoScript Constants
713 // ****************************
715 // Initialize parser and match-condition classes:
716 $constants = t3lib_div
::makeInstance('t3lib_TSparser');
717 $constants->breakPointLN
=intval($this->ext_constants_BRP
);
718 $constants->setup
= $this->const;
719 $constants->setup
= $this->mergeConstantsFromPageTSconfig($constants->setup
);
720 $matchObj = t3lib_div
::makeInstance('t3lib_matchCondition');
721 $matchObj->matchAlternative
= $this->matchAlternative
;
722 $matchObj->matchAll
= $this->matchAll
; // Matches ALL conditions in TypoScript
724 // Traverse constants text fields and parse them
725 foreach($this->constants
as $str) {
726 $constants->parse($str,$matchObj);
729 // Read out parse errors if any
730 $this->parserErrors
['constants']=$constants->errors
;
732 // 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)
733 $this->flatSetup
= Array();
734 $this->flattenSetup($constants->setup
,'','');
738 // ***********************************************
739 // Parse TypoScript Setup (here called "config")
740 // ***********************************************
741 // Initialize parser and match-condition classes:
742 $config = t3lib_div
::makeInstance('t3lib_TSparser');
743 $config->breakPointLN
= intval($this->ext_config_BRP
);
744 $config->regLinenumbers
= $this->ext_regLinenumbers
;
745 $config->setup
= $this->setup
;
747 // Transfer information about conditions found in "Constants" and which of them returned true.
748 $config->sections
= $constants->sections
;
749 $config->sectionsMatch
= $constants->sectionsMatch
;
751 // Traverse setup text fields and concatenate them into one, single string separated by a [GLOBAL] condition
753 foreach($this->config
as $str) {
754 $all.="\n[GLOBAL]\n".$str;
757 // Substitute constants in the Setup code:
758 if ($this->tt_track
) $GLOBALS['TT']->push('Substitute Constants ('.count($this->flatSetup
).')');
759 $all = $this->substituteConstants($all);
760 if ($this->tt_track
) $GLOBALS['TT']->pull();
762 // Searching for possible unsubstituted constants left (only for information)
763 if (strstr($all,'{$')) {
764 $findConst = explode('{$',$all);
765 $theConstList=Array();
767 while(list(,$constVal)=each($findConst)) {
768 $constLen=t3lib_div
::intInRange(strcspn($constVal,'}'),0,50);
769 $theConstList[]='{$'.substr($constVal,0,$constLen+
1);
771 if ($this->tt_track
) $GLOBALS['TT']->setTSlogMessage(implode(',',$theConstList).': Constants may remain un-substituted!!',2);
774 // Logging the textual size of the TypoScript Setup field text with all constants substituted:
775 if ($this->tt_track
) $GLOBALS['TT']->setTSlogMessage('TypoScript template size as textfile: '.strlen($all).' bytes');
777 // Finally parse the Setup field TypoScript code (where constants are now substituted)
778 $config->parse($all,$matchObj);
780 // Read out parse errors if any
781 $this->parserErrors
['config']=$config->errors
;
783 // Transfer the TypoScript array from the parser object to the internal $this->setup array:
784 $this->setup
= $config->setup
;
785 if ($this->backend_info
) {
786 $this->setup_constants
= $constants->setup
; // Used for backend purposes only
792 // **************************************************
793 // Parse Backend Editor Configuration (backend only)
794 // **************************************************
795 if ($this->parseEditorCfgField
) {
796 $editorcfg = t3lib_div
::makeInstance('t3lib_TSparser');
797 $editorcfg->breakPointLN
=intval($this->ext_editorcfg_BRP
);
798 $editorcfg->setup
= array(); // Empty as a start...
800 $all = implode("\n[GLOBAL]\n",$this->editorcfg
);
802 // substitute constants in config
803 $all = $this->substituteConstants($all);
806 $matchObj->matchAll
=1; // This should make sure that conditions are disabled. For now they are NOT active for the backend.
807 $editorcfg->parse($all,$matchObj);
808 $this->parserErrors
['editorcfg']=$editorcfg->errors
;
809 $this->setup_editorcfg
= $editorcfg->setup
;
816 // ****************************************************************
817 // Final processing of the $this->setup TypoScript Template array
818 // Basically: This is unsetting/setting of certain reserved keys.
819 // ****************************************************************
821 // 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!
822 unset($this->setup
['resources']);
823 unset($this->setup
['resources.']);
824 $this->setup
['resources']= implode(',',t3lib_div
::trimExplode(',',$this->resources
,1));
826 unset($this->setup
['sitetitle']);
827 unset($this->setup
['sitetitle.']);
828 $this->setup
['sitetitle']= $this->sitetitle
;
830 // Unsetting some vars...
831 unset($this->setup
['types.']);
832 unset($this->setup
['types']);
833 if (is_array($this->setup
)) {
834 reset ($this->setup
);
835 while(list($theKey,)=each($this->setup
)) {
836 if ($this->setup
[$theKey]=='PAGE') {
837 $tN = $this->setup
[$theKey.'.']['typeNum'];
839 $this->setup
['types.'][$tN] = $theKey;
840 } elseif(!$this->setup
['types.'][0]) { // If there is no type 0 yet and typeNum was not set, we use the current object as the default
841 $this->setup
['types.'][0] = $theKey;
846 unset($this->setup
['styles.']);
847 unset($this->setup
['temp.']);
850 // Storing the conditions found/matched information:
851 $this->sections
= $config->sections
;
852 $this->sectionsMatch
= $config->sectionsMatch
;
856 * Searching TypoScript code text (for constants, config (Setup) and editorcfg) for include instructions and does the inclusion if needed.
860 * @see t3lib_TSparser, generateConfig()
862 function procesIncludes() {
863 reset($this->constants
);
864 while(list($k)=each($this->constants
)) {
865 $this->constants
[$k]=t3lib_TSparser
::checkIncludeLines($this->constants
[$k]);
868 reset($this->config
);
869 while(list($k)=each($this->config
)) {
870 $this->config
[$k]=t3lib_TSparser
::checkIncludeLines($this->config
[$k]);
873 reset($this->editorcfg
);
874 while(list($k)=each($this->editorcfg
)) {
875 $this->editorcfg
[$k]=t3lib_TSparser
::checkIncludeLines($this->editorcfg
[$k]);
880 * 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!
882 * @param array Constants array, default input.
883 * @return array Constants array, modified
884 * @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...)
886 function mergeConstantsFromPageTSconfig($constArray) {
887 $TSdataArray = array();
888 $TSdataArray[]=$GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig']; // Setting default configuration:
890 for ($a=0;$a<=$this->outermostRootlineIndexWithTemplate
;$a++
) {
891 $TSdataArray[]=$this->absoluteRootLine
[$a]['TSconfig'];
893 // Parsing the user TS (or getting from cache)
894 $TSdataArray = t3lib_TSparser
::checkIncludeLines_array($TSdataArray);
895 $userTS = implode(chr(10).'[GLOBAL]'.chr(10),$TSdataArray);
897 $parseObj = t3lib_div
::makeInstance('t3lib_TSparser');
898 $parseObj->parse($userTS);
900 if (is_array($parseObj->setup
['TSFE.']['constants.'])) {
901 $constArray = t3lib_div
::array_merge_recursive_overrule($constArray,$parseObj->setup
['TSFE.']['constants.']);
907 * This flattens a hierarchical TypoScript array to $this->flatSetup
909 * @param array TypoScript array
910 * @param string Prefix to the object path. Used for recursive calls to this function.
911 * @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.
913 * @see generateConfig()
915 function flattenSetup($setupArray, $prefix, $resourceFlag) {
916 if (is_array($setupArray)) {
918 while(list($key,$val)=each($setupArray)) {
919 if ($prefix ||
substr($key,0,16)!='TSConstantEditor') { // We don't want 'TSConstantEditor' in the flattend setup on the first level (190201)
920 if (is_array($val)) {
921 $this->flattenSetup($val,$prefix.$key, ($key=='file.'));
922 } elseif ($resourceFlag) {
923 $this->flatSetup
[$prefix.$key] = $this->getFileName($val);
925 $this->flatSetup
[$prefix.$key] = $val;
933 * Substitutes the constants from $this->flatSetup in the text string $all
935 * @param string TypoScript code text string
936 * @return string The processed string with all constants found in $this->flatSetup as key/value pairs substituted.
937 * @see generateConfig(), flattenSetup()
939 function substituteConstants($all) {
940 if ($this->tt_track
) $GLOBALS['TT']->setTSlogMessage('Constants to substitute: '.count($this->flatSetup
));
941 reset($this->flatSetup
);
942 while (list($const,$val)=each($this->flatSetup
)) {
943 if (!is_array($val)) {
944 $all = str_replace('{$'.$const.'}',$val,$all);
960 /*******************************************************************
962 * Various API functions, used from elsewhere in the frontend classes
964 *******************************************************************/
967 * Implementation of the "optionSplit" feature in TypoScript (used eg. for MENU objects)
968 * 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.
969 * The concept is known as "optionSplit" and is rather advanced to handle but quite powerful, in particular for creating menus in TYPO3.
971 * @param array A TypoScript array
972 * @param integer The number of items for which to generated individual TypoScript arrays
973 * @return array The individualized TypoScript array.
974 * @see tslib_cObj::IMGTEXT(), tslib_menu::procesItemStates()
975 * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=289&cHash=6604390b37
977 function splitConfArray($conf,$splitCount) {
979 // Initialize variables:
980 $splitCount = intval($splitCount);
983 if ($splitCount && is_array($conf)) {
985 // Initialize output to carry at least the keys:
986 for ($aKey=0;$aKey<$splitCount;$aKey++
) {
987 $conf2[$aKey] = array();
990 // Recursive processing of array keys:
991 foreach($conf as $cKey => $val) {
992 if (is_array($val)) {
993 $tempConf = $this->splitConfArray($val,$splitCount);
994 foreach($tempConf as $aKey => $val) {
995 $conf2[$aKey][$cKey] = $val;
1000 // Splitting of all values on this level of the TypoScript object tree:
1001 foreach($conf as $cKey => $val) {
1002 if (!is_array($val)) {
1003 if (!strstr($val,'|*|') && !strstr($val,'||')) {
1004 for ($aKey=0;$aKey<$splitCount;$aKey++
) {
1005 $conf2[$aKey][$cKey] = $val;
1008 $main = explode ('|*|',$val);
1009 $mainCount = count($main);
1016 $first = explode('||',$main[0]);
1017 $firstC = count($first);
1020 $middle = explode('||',$main[1]);
1021 $middleC = count($middle);
1024 $last = explode('||',$main[2]);
1025 $lastC = count($last);
1029 for ($aKey=0;$aKey<$splitCount;$aKey++
) {
1030 if ($firstC && isset($first[$aKey])) {
1031 $value = $first[$aKey];
1032 } elseif ($middleC) {
1033 $value = $middle[($aKey-$firstC)%
$middleC];
1035 if ($lastC && $lastC>=($splitCount-$aKey)) {
1036 $value = $last[$lastC-($splitCount-$aKey)];
1038 $conf2[$aKey][$cKey] = trim($value);
1048 * Returns the reference to a 'resource' in TypoScript.
1049 * This could be from the filesystem if '/' is found in the value $fileFromSetup, else from the resource-list
1051 * @param string TypoScript "resource" data type value.
1052 * @return string Resulting filename, if any.
1054 function getFileName($fileFromSetup) {
1055 $file = trim($fileFromSetup);
1059 if (isset($this->fileCache
[$hash])) {
1060 return $this->fileCache
[$hash];
1063 if (!strcmp(substr($file,0,4),'EXT:')) {
1065 list($extKey,$script)=explode('/',substr($file,4),2);
1066 if ($extKey && t3lib_extMgm
::isLoaded($extKey)) {
1067 $extPath=t3lib_extMgm
::extPath($extKey);
1068 $newFile=substr($extPath,strlen(PATH_site
)).$script;
1070 if (!@is_file
(PATH_site
.$newFile)) {
1071 if ($this->tt_track
) $GLOBALS['TT']->setTSlogMessage('Extension media file "'.$newFile.'" was not found!',3);
1073 } else $file=$newFile;
1077 if (strstr($file,'/')) { // here it is manual media
1078 if (@is_file
($this->getFileName_backPath
.$file)) {
1080 $fileInfo = t3lib_div
::split_fileref($outFile);
1081 reset($this->allowedPaths
);
1083 while(list(,$val)=each($this->allowedPaths
)) {
1084 if (substr($fileInfo['path'],0,strlen($val))==$val){$OK=1; break;}
1087 $this->fileCache
[$hash]=$outFile;
1089 } elseif ($this->tt_track
) $GLOBALS['TT']->setTSlogMessage('"'.$file.'" was not located in the allowed paths: ('.implode(',',$this->allowedPaths
).')',3);
1090 } elseif ($this->tt_track
) $GLOBALS['TT']->setTSlogMessage('"'.$this->getFileName_backPath
.$file.'" is not a file (non-uploads/.. resource, did not exist).',3);
1091 } else { // Here it is uploaded media:
1092 $outFile = $this->extractFromResources($this->setup
['resources'],$file);
1094 if (@is_file
($this->uplPath
.$outFile)) {
1095 $this->fileCache
[$hash] = $this->uplPath
.$outFile;
1096 return $this->uplPath
.$outFile;
1097 } elseif ($this->tt_track
) $GLOBALS['TT']->setTSlogMessage('"'.$this->uplPath
.$outFile.'" is not a file (did not exist).',3);
1098 } elseif ($this->tt_track
) $GLOBALS['TT']->setTSlogMessage('"'.$file.'" is not a file (uploads/.. resource).',3);
1103 * Searches for the TypoScript resource filename in the list of resource filenames.
1105 * @param string The resource file name list (from $this->setup['resources'])
1106 * @param string The resource value to match
1107 * @return string If found, this will be the resource filename that matched. Typically this file is found in "uploads/tf/"
1109 * @see getFileName()
1111 function extractFromResources($res,$file) {
1112 if (t3lib_div
::inList($res,$file)) {
1114 } elseif (strstr($file,'*')) {
1115 $fileparts=explode('*',$file);
1116 $c=count($fileparts);
1117 $files = explode(',',$res);
1118 while(list(,$val)=each($files)) {
1120 if (ereg('^'.quotemeta($fileparts[0]).'.*'.quotemeta($fileparts[$c-1]).'$', $test)) {
1130 * CheckFile runs through the $menuArr and checks every file-reference in $name
1131 * (Not used anywhere)
1133 * @param string Property name in the menu array
1134 * @param array Menu array to traverse
1135 * @return array Modified menu array
1139 function checkFile($name,$menuArr) {
1141 while (list($aKey,)=each($menuArr)) {
1142 $menuArr[$aKey][$name] = $this->getFileName($menuArr[$aKey][$name]);
1148 * Compiles the content for the page <title> tag.
1150 * @param string The input title string, typically the "title" field of a page's record.
1151 * @param boolean If set, then only the site title is outputted (from $this->setup['sitetitle'])
1152 * @param boolean If set, then "sitetitle" and $title is swapped
1153 * @return string The page title on the form "[sitetitle]: [input-title]". Not htmlspecialchar()'ed.
1154 * @see tslib_fe::tempPageCacheContent(), TSpagegen::renderContentWithHeader()
1156 function printTitle($title,$no_title=0,$titleFirst=0) {
1157 $st = trim($this->setup
['sitetitle']) ?
$this->setup
['sitetitle']:'';
1158 $title = $no_title ?
'' : $title;
1164 if ($title && $st) {
1165 return $st.': '.$title;
1172 * Reads the fileContent of $fName and returns it.
1173 * The same as t3lib_div::getUrl()
1175 * @param string Absolute filepath to record
1176 * @return string The content returned
1177 * @see tslib_cObj::fileResource(), tslib_cObj::MULTIMEDIA(), t3lib_div::getUrl()
1179 function fileContent($fName) {
1180 $incFile = $this->getFileName($fName);
1181 if ($incFile && $fd=fopen($incFile,'rb')) {
1183 while (!feof($fd)) {
1184 $content.=fread($fd, 5000);
1192 * Ordinary "wrapping" function. Used in the tslib_menu class and extension classes instead of the similar function in tslib_cObj
1194 * @param string The content to wrap
1195 * @param string The wrap value, eg. "<b> | </b>"
1196 * @return string Wrapped input string
1197 * @see tslib_menu, tslib_cObj::wrap()
1199 function wrap($content,$wrap) {
1201 $wrapArr = explode('|', $wrap);
1202 return trim($wrapArr[0]).$content.trim($wrapArr[1]);
1203 } else return $content;
1207 * Removes the "?" of input string IF the "?" is the last character.
1209 * @param string Input string
1210 * @return string Output string, free of "?" in the end, if any such character.
1211 * @see linkData(), tslib_frameset::frameParams()
1213 function removeQueryString($url) {
1214 if (substr($url,-1)=='?') {
1215 return substr($url,0,-1);
1222 * 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.
1223 * Call it like t3lib_TStemplate::sortedKeyList()
1225 * @param array TypoScript array with numerical array in
1226 * @param boolean If set, then a value is not required - the properties alone will be enough.
1227 * @return array An array with all integer properties listed in numeric order.
1228 * @see tslib_cObj::cObjGet(), tslib_gifBuilder, tslib_imgmenu::makeImageMap()
1230 function sortedKeyList($setupArr, $acceptOnlyProperties=FALSE) {
1234 while(list($key,)=each($setupArr)) {
1235 $ikey = intval($key);
1236 if (!strcmp($ikey,$key) ||
$acceptOnlyProperties) {
1241 $keyArr = array_unique($keyArr);
1255 /*******************************************************************
1257 * Functions for creating links
1259 *******************************************************************/
1262 * The mother of all functions creating links/URLs etc in a TypoScript environment.
1263 * See the references below.
1264 * Basically this function takes care of issues such as type,id,alias and Mount Points, simulate static documents, M5/B6 encoded parameters etc.
1265 * 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.
1267 * @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.
1268 * @param string Default target string to use IF not $page['target'] is set.
1269 * @param boolean If set, then the "&no_cache=1" parameter is included in the URL.
1270 * @param string Alternative script name if you don't want to use $GLOBALS['TSFE']->config['mainScript'] (normally set to "index.php")
1271 * @param array Array with overriding values for the $page array.
1272 * @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.
1273 * @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.
1274 * @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"
1275 * @see tslib_frameset::frameParams(), tslib_cObj::typoLink(), tslib_cObj::SEARCHRESULT(), TSpagegen::pagegenInit(), tslib_menu::link()
1277 function linkData($page,$oTarget,$no_cache,$script,$overrideArray='',$addParams='',$typeOverride='') {
1278 global $TYPO3_CONF_VARS;
1282 // Overriding some fields in the page record and still preserves the values by adding them as parameters. Little strange function.
1283 if (is_array($overrideArray)) {
1284 foreach($overrideArray as $theKey => $theNewVal) {
1285 $addParams.= '&real_'.$theKey.'='.rawurlencode($page[$theKey]);
1286 $page[$theKey] = $theNewVal;
1290 // Adding Mount Points, "&MP=", parameter for the current page if any is set:
1291 if (!strstr($addParams,'&MP=')) {
1292 if (trim($GLOBALS['TSFE']->MP_defaults
[$page['uid']])) { // Looking for hardcoded defaults:
1293 $addParams.= '&MP='.rawurlencode(trim($GLOBALS['TSFE']->MP_defaults
[$page['uid']]));
1294 } elseif ($GLOBALS['TSFE']->config
['config']['MP_mapRootPoints']) { // Else look in automatically created map:
1295 $m = $this->getFromMPmap($page['uid']);
1297 $addParams.= '&MP='.rawurlencode($m);
1302 // Setting ID/alias:
1303 if (!$script) {$script = $GLOBALS['TSFE']->config
['mainScript'];}
1304 if ($page['alias']) {
1305 $LD['url'] = $script.'?id='.rawurlencode($page['alias']);
1307 $LD['url'] = $script.'?id='.$page['uid'];
1310 $LD['target'] = trim($page['target']) ?
trim($page['target']) : $oTarget;
1313 $typeNum = $this->setup
[$LD['target'].'.']['typeNum'];
1314 if (!$typeOverride && intval($GLOBALS['TSFE']->config
['config']['forceTypeValue'])) {
1315 $typeOverride = intval($GLOBALS['TSFE']->config
['config']['forceTypeValue']);
1317 if (strcmp($typeOverride,'')) { $typeNum = $typeOverride; } // Override...
1319 $LD['type'] = '&type='.intval($typeNum);
1323 $LD['orig_type'] = $LD['type']; // Preserving the type number. Will not be cleared if simulateStaticDocuments.
1326 $LD['no_cache'] = (trim($page['no_cache']) ||
$no_cache) ?
'&no_cache=1' : '';
1329 $LD['linkVars'] = $GLOBALS['TSFE']->linkVars
.$addParams;
1331 // If simulateStaticDocuments is enabled:
1332 if ($GLOBALS['TSFE']->config
['config']['simulateStaticDocuments']) {
1336 // MD5/base64 method limitation:
1338 $flag_simulateStaticDocuments_pEnc = t3lib_div
::inList('md5,base64',$GLOBALS['TSFE']->config
['config']['simulateStaticDocuments_pEnc']) && !$LD['no_cache'];
1339 if ($flag_simulateStaticDocuments_pEnc) {
1340 list($LD['linkVars'], $remainLinkVars) = $GLOBALS['TSFE']->simulateStaticDocuments_pEnc_onlyP_proc($LD['linkVars']);
1343 $LD['url'].=$GLOBALS['TSFE']->makeSimulFileName(
1345 $page['alias'] ?
$page['alias'] : $page['uid'],
1351 if ($flag_simulateStaticDocuments_pEnc) {
1352 $LD['linkVars']=$remainLinkVars;
1354 if ($GLOBALS['TSFE']->config
['config']['simulateStaticDocuments']=='PATH_INFO') {
1355 $LD['url'] = str_replace('.','/',$LD['url']);
1356 $LD['url'] = 'index.php/'.$LD['url'].'/?';
1358 $LD['url'].= '.html?';
1362 // Add absRefPrefix if exists.
1363 $LD['url'] = $GLOBALS['TSFE']->absRefPrefix
.$LD['url'];
1365 // 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.
1366 $LD['sectionIndex'] = $page['sectionIndex_uid'] ?
'#'.$page['sectionIndex_uid'] : '';
1368 // Compile the normal total url
1369 $LD['totalURL']= $this->removeQueryString($LD['url'].$LD['type'].$LD['no_cache'].$LD['linkVars'].$GLOBALS['TSFE']->getMethodUrlIdToken
).$LD['sectionIndex'];
1371 // Call post processing function for link rendering:
1372 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_tstemplate.php']['linkData-PostProc'])) {
1375 'args' => array('page'=>$page, 'oTarget'=>$oTarget, 'no_cache'=>$no_cache, 'script'=>$script, 'overrideArray'=>$overrideArray, 'addParams'=>$addParams, 'typeOverride'=>$typeOverride),
1376 'typeNum' => $typeNum
1378 foreach($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_tstemplate.php']['linkData-PostProc'] as $_funcRef) {
1379 t3lib_div
::callUserFunction($_funcRef,$_params,$this);
1383 // Return the LD-array
1388 * Initializes the automatically created MPmap coming from the "config.MP_mapRootPoints" setting
1389 * Can be called many times with overhead only the first time since then the map is generated and cached in memory.
1391 * @param integer Page id to return MPvar value for.
1393 * @see initMPmap_create()
1394 * @todo Implement some caching of the result between hits. (more than just the memory caching used here)
1396 function getFromMPmap($pageId=0) {
1398 // Create map if not found already:
1399 if (!is_array($this->MPmap
)) {
1400 $this->MPmap
= array();
1402 $rootPoints = t3lib_div
::trimExplode(',', strtolower($GLOBALS['TSFE']->config
['config']['MP_mapRootPoints']),1);
1403 foreach($rootPoints as $p) { // Traverse rootpoints:
1405 $p = $this->rootLine
[0]['uid'];
1406 $initMParray = array();
1407 if ($this->rootLine
[0]['_MOUNT_OL'] && $this->rootLine
[0]['_MP_PARAM']) {
1408 $initMParray[] = $this->rootLine
[0]['_MP_PARAM'];
1411 $this->initMPmap_create($p,$initMParray);
1415 // Finding MP var for Page ID:
1417 if (is_array($this->MPmap
[$pageId]) && count($this->MPmap
[$pageId])) {
1418 return implode(',',$this->MPmap
[$pageId]);
1424 * Creating MPmap for a certain ID root point.
1426 * @param integer Root id from which to start map creation.
1427 * @param array MP_array passed from root page.
1428 * @param integer Recursion brake. Incremented for each recursive call. 20 is the limit.
1430 * @see getFromMPvar()
1432 function initMPmap_create($id,$MP_array=array(),$level=0) {
1437 // First level, check id
1440 // Find mount point if any:
1441 $mount_info = $GLOBALS['TSFE']->sys_page
->getMountPointInfo($id);
1444 if (is_array($mount_info) && $mount_info['overlay']) {
1445 $MP_array[] = $mount_info['MPvar'];
1446 $id = $mount_info['mount_pid'];
1449 // Set mapping information for this level:
1450 $this->MPmap
[$id] = $MP_array;
1453 if (is_array($mount_info) && !$mount_info['overlay']) {
1454 $MP_array[] = $mount_info['MPvar'];
1455 $id = $mount_info['mount_pid'];
1459 if ($id && $level<20) {
1461 $nextLevelAcc = array();
1463 // Select and traverse current level pages:
1464 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1465 'uid,pid,doktype,mount_pid,mount_pid_ol',
1467 'pid='.intval($id).' AND deleted=0 AND doktype!=255 AND doktype!=6' // 255 = Garbage bin, 6 = Backend User Section
1469 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1471 // Find mount point if any:
1472 $next_id = $row['uid'];
1473 $next_MP_array = $MP_array;
1474 $mount_info = $GLOBALS['TSFE']->sys_page
->getMountPointInfo($next_id, $row);
1477 if (is_array($mount_info) && $mount_info['overlay']) {
1478 $next_MP_array[] = $mount_info['MPvar'];
1479 $next_id = $mount_info['mount_pid'];
1482 if (!isset($this->MPmap
[$next_id])) {
1484 // Set mapping information for this level:
1485 $this->MPmap
[$next_id] = $next_MP_array;
1488 if (is_array($mount_info) && !$mount_info['overlay']) {
1489 $next_MP_array[] = $mount_info['MPvar'];
1490 $next_id = $mount_info['mount_pid'];
1493 // Register recursive call
1494 // (have to do it this way since ALL of the current level should be registered BEFORE the sublevel at any time)
1495 $nextLevelAcc[] = array($next_id,$next_MP_array);
1499 // Call recursively, if any:
1500 foreach($nextLevelAcc as $pSet) {
1501 $this->initMPmap_create($pSet[0],$pSet[1],$level+
1);
1508 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE
]['XCLASS']['t3lib/class.t3lib_tstemplate.php']) {
1509 include_once($TYPO3_CONF_VARS[TYPO3_MODE
]['XCLASS']['t3lib/class.t3lib_tstemplate.php']);