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