Fixed bug #12295: Cleaning config_default, exclude values from being listed in instal...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_tsparser.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains the TypoScript parser class
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 * 80: class t3lib_TSparser
41 * 133: function parse($string,$matchObj='')
42 * 169: function nextDivider()
43 * 185: function parseSub(&$setup)
44 * 389: function rollParseSub($string,&$setup)
45 * 413: function getVal($string,$setup)
46 * 439: function setVal($string,&$setup,$value,$wipeOut=0)
47 * 485: function error($err,$num=2)
48 * 497: function checkIncludeLines($string, $cycle_counter=1, $returnFiles=false)
49 * 541: function checkIncludeLines_array($array)
50 *
51 * SECTION: Syntax highlighting
52 * 584: function doSyntaxHighlight($string,$lineNum='',$highlightBlockMode=0)
53 * 605: function regHighLight($code,$pointer,$strlen=-1)
54 * 623: function syntaxHighlight_print($lineNumDat,$highlightBlockMode)
55 *
56 * TOTAL FUNCTIONS: 12
57 * (This index is automatically created/updated by the extension "extdeveval")
58 *
59 */
60
61
62
63
64
65
66
67
68
69
70
71
72 /**
73 * The TypoScript parser
74 *
75 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
76 * @package TYPO3
77 * @subpackage t3lib
78 * @see t3lib_tstemplate, t3lib_matchcondition, t3lib_BEfunc::getPagesTSconfig(), t3lib_userAuthGroup::fetchGroupData(), t3lib_TStemplate::generateConfig()
79 */
80 class t3lib_TSparser {
81 var $strict = 1; // If set, then key names cannot contain characters other than [:alnum:]_\.-
82
83 // Internal
84 var $setup = Array(); // TypoScript hierarchy being build during parsing.
85 var $raw; // raw data, the input string exploded by chr(10)
86 var $rawP; // pointer to entry in raw data array
87 var $lastComment=''; // Holding the value of the last comment
88 var $commentSet=0; // Internally set, used as internal flag to create a multi-line comment (one of those like /*... */)
89 var $multiLineEnabled=0; // Internally set, when multiline value is accumulated
90 var $multiLineObject=''; // Internally set, when multiline value is accumulated
91 var $multiLineValue=array(); // Internally set, when multiline value is accumulated
92 var $inBrace = 0; // Internally set, when in brace. Counter.
93 var $lastConditionTrue = 1; // For each condition this flag is set, if the condition is true, else it's cleared. Then it's used by the [ELSE] condition to determine if the next part should be parsed.
94 var $sections=array(); // Tracking all conditions found
95 var $sectionsMatch=array(); // Tracking all matching conditions found
96 var $syntaxHighLight = 0; // If set, then syntax highlight mode is on; Call the function syntaxHighlight() to use this function
97 var $highLightData=array(); // Syntax highlight data is accumulated in this array. Used by syntaxHighlight_print() to construct the output.
98 var $highLightData_bracelevel = array(); // Syntax highlight data keeping track of the curly brace level for each line
99
100 // Debugging, analysis:
101 var $regComments = 0; // DO NOT register the comments. This is default for the ordinary sitetemplate!
102 var $regLinenumbers = 0; // DO NOT register the linenumbers. This is default for the ordinary sitetemplate!
103 var $errors=array(); // Error accumulation array.
104 var $lineNumberOffset=0; // Used for the error messages line number reporting. Set externally.
105 var $breakPointLN=0; // Line for break point.
106 var $highLightStyles=array(
107 'prespace' => array('<span class="ts-prespace">','</span>'), // Space before any content on a line
108 'objstr_postspace' => array('<span class="ts-objstr_postspace">','</span>'), // Space after the object string on a line
109 'operator_postspace' => array('<span class="ts-operator_postspace">','</span>'), // Space after the operator on a line
110 'operator' => array('<span class="ts-operator">','</span>'), // The operator char
111 'value' => array('<span class="ts-value">','</span>'), // The value of a line
112 'objstr' => array('<span class="ts-objstr">','</span>'), // The object string of a line
113 'value_copy' => array('<span class="ts-value_copy">','</span>'), // The value when the copy syntax (<) is used; that means the object reference
114 'value_unset' => array('<span class="ts-value_unset">','</span>'), // The value when an object is unset. Should not exist.
115 'ignored' => array('<span class="ts-ignored">','</span>'), // The "rest" of a line which will be ignored.
116 'default' => array('<span class="ts-default">','</span>'), // The default style if none other is applied.
117 'comment' => array('<span class="ts-comment">','</span>'), // Comment lines
118 'condition' => array('<span class="ts-condition">','</span>'), // Conditions
119 'error' => array('<span class="ts-error">','</span>'), // Error messages
120 'linenum' => array('<span class="ts-linenum">','</span>'), // Line numbers
121 );
122 var $highLightBlockStyles = ''; // Additional attributes for the <span> tags for a blockmode line
123 var $highLightBlockStyles_basecolor = '#cccccc'; // The hex-HTML color for the blockmode
124
125
126 /**
127 * Start parsing the input TypoScript text piece. The result is stored in $this->setup
128 *
129 * @param string The TypoScript text
130 * @param object If is object (instance of t3lib_matchcondition), then this is used to match conditions found in the TypoScript code. If matchObj not specified, then no conditions will work! (Except [GLOBAL])
131 * @return void
132 */
133 function parse($string,$matchObj='') {
134 $this->raw = explode(chr(10),$string);
135 $this->rawP = 0;
136 $pre = '[GLOBAL]';
137 while($pre) {
138 if ($this->breakPointLN && $pre=='[_BREAK]') {
139 $this->error('Breakpoint at '.($this->lineNumberOffset+$this->rawP-2).': Line content was "'.$this->raw[$this->rawP-2].'"',1);
140 break;
141 }
142
143 if (strtoupper($pre)=='[GLOBAL]' || strtoupper($pre)=='[END]' || (!$this->lastConditionTrue && strtoupper($pre)=='[ELSE]')) {
144 $pre = trim($this->parseSub($this->setup));
145 $this->lastConditionTrue=1;
146 } else {
147 if (strtoupper($pre)!='[ELSE]') {$this->sections[md5($pre)]=$pre;} // we're in a specific section. Therefore we log this section
148 if ((is_object($matchObj) && $matchObj->match($pre)) || $this->syntaxHighLight) {
149 if (strtoupper($pre)!='[ELSE]') {$this->sectionsMatch[md5($pre)]=$pre;}
150 $pre = trim($this->parseSub($this->setup));
151 $this->lastConditionTrue=1;
152 } else {
153 $pre = trim($this->nextDivider());
154 $this->lastConditionTrue=0;
155 }
156 }
157 }
158 if ($this->inBrace) {$this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': The script is short of '.$this->inBrace.' end brace(s)',1); }
159 if ($this->multiLineEnabled) {$this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': A multiline value section is not ended with a parenthesis!',1); }
160 $this->lineNumberOffset+=count($this->raw)+1;
161 }
162
163 /**
164 * Will search for the next condition. When found it will return the line content (the condition value) and have advanced the internal $this->rawP pointer to point to the next line after the condition.
165 *
166 * @return string The condition value
167 * @see parse()
168 */
169 function nextDivider() {
170 while (isset($this->raw[$this->rawP])) {
171 $line = ltrim($this->raw[$this->rawP]);
172 $this->rawP++;
173 if ($line && substr($line,0,1)=='[') {
174 return $line;
175 }
176 }
177 }
178
179 /**
180 * Parsing the $this->raw TypoScript lines from pointer, $this->rawP
181 *
182 * @param array Reference to the setup array in which to accumulate the values.
183 * @return string Returns the string of the condition found, the exit signal or possible nothing (if it completed parsing with no interruptions)
184 */
185 function parseSub(&$setup) {
186 global $TYPO3_CONF_VARS;
187
188 while (isset($this->raw[$this->rawP])) {
189 $line = ltrim($this->raw[$this->rawP]);
190 $lineP = $this->rawP;
191 $this->rawP++;
192 if ($this->syntaxHighLight) $this->regHighLight("prespace",$lineP,strlen($line));
193
194 // Breakpoint?
195 if ($this->breakPointLN && ($this->lineNumberOffset+$this->rawP-1)==($this->breakPointLN+1)) { // by adding 1 we get that line processed
196 return '[_BREAK]';
197 }
198
199 // Set comment flag?
200 if (!$this->multiLineEnabled && substr($line,0,2)=='/*') {
201 $this->commentSet=1;
202 }
203
204 if (!$this->commentSet && ($line || $this->multiLineEnabled)) { // If $this->multiLineEnabled we will go and get the line values here because we know, the first if() will be true.
205 if ($this->multiLineEnabled) { // If multiline is enabled. Escape by ')'
206 if (substr($line,0,1)==')') { // Multiline ends...
207 if ($this->syntaxHighLight) $this->regHighLight("operator",$lineP,strlen($line)-1);
208 $this->multiLineEnabled=0; // Disable multiline
209 $theValue = implode($this->multiLineValue,chr(10));
210 if (strstr($this->multiLineObject,'.')) {
211 $this->setVal($this->multiLineObject,$setup,array($theValue)); // Set the value deeper.
212 } else {
213 $setup[$this->multiLineObject] = $theValue; // Set value regularly
214 if ($this->lastComment && $this->regComments) {
215 $setup[$this->multiLineObject.'..'].=$this->lastComment;
216 }
217 if ($this->regLinenumbers) {
218 $setup[$this->multiLineObject.'.ln..'][]=($this->lineNumberOffset+$this->rawP-1);
219 }
220 }
221 } else {
222 if ($this->syntaxHighLight) $this->regHighLight("value",$lineP);
223 $this->multiLineValue[]=$this->raw[($this->rawP-1)];
224 }
225 } elseif ($this->inBrace==0 && substr($line,0,1)=='[') { // Beginning of condition (only on level zero compared to brace-levels
226 if ($this->syntaxHighLight) $this->regHighLight("condition",$lineP);
227 return $line;
228 } else {
229 if (substr($line,0,1)=='[' && strtoupper(trim($line))=='[GLOBAL]') { // Return if GLOBAL condition is set - no matter what.
230 if ($this->syntaxHighLight) $this->regHighLight("condition",$lineP);
231 $this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': On return to [GLOBAL] scope, the script was short of '.$this->inBrace.' end brace(s)',1);
232 $this->inBrace=0;
233 return $line;
234 } elseif (strcspn($line,'}#/')!=0) { // If not brace-end or comment
235 $varL = strcspn($line,' {=<>:('); // Find object name string until we meet an operator
236 $objStrName=trim(substr($line,0,$varL));
237 if ($this->syntaxHighLight) $this->regHighLight("objstr",$lineP,strlen(substr($line,$varL)));
238 if (strlen($objStrName)) {
239 $r = array();
240 if ($this->strict && preg_match('/[^[:alnum:]_\.-]/i',$objStrName,$r)) {
241 $this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': Object Name String, "'.htmlspecialchars($objStrName).'" contains invalid character "'.$r[0].'". Must be alphanumeric or one of: "_-."');
242 } else {
243 $line = ltrim(substr($line,$varL));
244 if ($this->syntaxHighLight) {
245 $this->regHighLight("objstr_postspace", $lineP, strlen($line));
246 if (strlen($line)>0) {
247 $this->regHighLight("operator", $lineP, strlen($line)-1);
248 $this->regHighLight("operator_postspace", $lineP, strlen(ltrim(substr($line,1))));
249 }
250 }
251
252 // Checking for special TSparser properties (to change TS values at parsetime)
253 $match = array();
254 if (preg_match('/^:=([^\(]+)\((.+)\).*/', $line, $match)) {
255 $tsFunc = trim($match[1]);
256 $tsFuncArg = $match[2];
257 list ($currentValue) = $this->getVal($objStrName,$setup);
258
259 $tsFuncArg = str_replace(
260 array('\\\\', '\n','\t'),
261 array('\\', chr(10),chr(9)),
262 $tsFuncArg
263 );
264
265 switch ($tsFunc) {
266 case 'prependString':
267 $newValue = $tsFuncArg . $currentValue;
268 break;
269 case 'appendString':
270 $newValue = $currentValue . $tsFuncArg;
271 break;
272 case 'removeString':
273 $newValue = str_replace($tsFuncArg, '', $currentValue);
274 break;
275 case 'replaceString':
276 list($fromStr,$toStr) = explode('|', $tsFuncArg, 2);
277 $newValue = str_replace($fromStr, $toStr, $currentValue);
278 break;
279 case 'addToList':
280 $newValue = (strcmp('',$currentValue) ? $currentValue.',' : '') . trim($tsFuncArg);
281 break;
282 case 'removeFromList':
283 $existingElements = t3lib_div::trimExplode(',',$currentValue);
284 $removeElements = t3lib_div::trimExplode(',',$tsFuncArg);
285 if (count($removeElements)) {
286 $newValue = implode(',', array_diff($existingElements, $removeElements));
287 }
288 break;
289 default:
290 if (isset($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_tsparser.php']['preParseFunc'][$tsFunc])) {
291 $hookMethod = $TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_tsparser.php']['preParseFunc'][$tsFunc];
292 $params = array('currentValue'=>$currentValue, 'functionArgument'=>$tsFuncArg);
293 $fakeThis = FALSE;
294 $newValue = t3lib_div::callUserFunction($hookMethod,$params,$fakeThis);
295 } else {
296 t3lib_div::sysLog('Missing function definition for '.$tsFunc.' on TypoScript line '.$lineP,'Core',2);
297 }
298 }
299
300 if (isset($newValue)) {
301 $line = '= '.$newValue;
302 }
303 }
304
305 switch(substr($line,0,1)) {
306 case '=':
307 if ($this->syntaxHighLight) $this->regHighLight('value', $lineP, strlen(ltrim(substr($line,1)))-strlen(trim(substr($line,1))));
308
309 if (strstr($objStrName,'.')) {
310 $value = Array();
311 $value[0] = trim(substr($line,1));
312 $this->setVal($objStrName,$setup,$value);
313 } else {
314 $setup[$objStrName] = trim(substr($line,1));
315 if ($this->lastComment && $this->regComments) { // Setting comment..
316 $setup[$objStrName.'..'].=$this->lastComment;
317 }
318 if ($this->regLinenumbers) {
319 $setup[$objStrName.'.ln..'][]=($this->lineNumberOffset+$this->rawP-1);
320 }
321 }
322 break;
323 case '{':
324 $this->inBrace++;
325 if (strstr($objStrName,'.')) {
326 $exitSig=$this->rollParseSub($objStrName,$setup);
327 if ($exitSig) return $exitSig;
328 } else {
329 if (!isset($setup[$objStrName.'.'])) {$setup[$objStrName.'.'] = Array();}
330 $exitSig=$this->parseSub($setup[$objStrName.'.']);
331 if ($exitSig) return $exitSig;
332 }
333 break;
334 case '(':
335 $this->multiLineObject = $objStrName;
336 $this->multiLineEnabled=1;
337 $this->multiLineValue=array();
338 break;
339 case '<':
340 if ($this->syntaxHighLight) $this->regHighLight("value_copy", $lineP, strlen(ltrim(substr($line,1)))-strlen(trim(substr($line,1))));
341 $theVal = trim(substr($line,1));
342 if (substr($theVal,0,1)=='.') {
343 $res = $this->getVal(substr($theVal,1),$setup);
344 } else {
345 $res = $this->getVal($theVal,$this->setup);
346 }
347 $this->setVal($objStrName,$setup,unserialize(serialize($res)),1); // unserialize(serialize(...)) may look stupid but is needed because of some reference issues. See Kaspers reply to "[TYPO3-core] good question" from December 15 2005.
348 break;
349 case '>':
350 if ($this->syntaxHighLight) $this->regHighLight("value_unset", $lineP, strlen(ltrim(substr($line,1)))-strlen(trim(substr($line,1))));
351 $this->setVal($objStrName,$setup,'UNSET');
352 break;
353 default:
354 $this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': Object Name String, "'.htmlspecialchars($objStrName).'" was not preceded by any operator, =<>({');
355 break;
356 }
357 }
358 $this->lastComment='';
359 }
360 } elseif (substr($line,0,1)=='}') {
361 $this->inBrace--;
362 $this->lastComment='';
363 if ($this->syntaxHighLight) $this->regHighLight("operator", $lineP, strlen($line)-1);
364 if ($this->inBrace<0) {
365 $this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': An end brace is in excess.',1);
366 $this->inBrace=0;
367 } else {
368 break;
369 }
370 } else {
371 if ($this->syntaxHighLight) $this->regHighLight("comment", $lineP);
372
373 // Comment. The comments are concatenated in this temporary string:
374 if ($this->regComments) $this->lastComment.= trim($line).chr(10);
375 }
376 }
377 }
378
379 // Unset comment
380 if ($this->commentSet) {
381 if ($this->syntaxHighLight) $this->regHighLight("comment", $lineP);
382 if (substr($line,0,2)=='*/') $this->commentSet=0;
383 }
384 }
385 }
386
387 /**
388 * Parsing of TypoScript keys inside a curly brace where the key is composite of at least two keys, thus having to recursively call itself to get the value
389 *
390 * @param string The object sub-path, eg "thisprop.another_prot"
391 * @param array The local setup array from the function calling this function
392 * @return string Returns the exitSignal
393 * @see parseSub()
394 */
395 function rollParseSub($string,&$setup) {
396 if ((string)$string!='') {
397 $keyLen = strcspn($string,'.');
398 if ($keyLen==strlen($string)) {
399 $key = $string.'.';
400 if (!isset($setup[$key])){$setup[$key]=Array();}
401 $exitSig=$this->parseSub($setup[$key]);
402 if ($exitSig) return $exitSig;
403 } else {
404 $key = substr($string,0,$keyLen).'.';
405 if (!isset($setup[$key])){$setup[$key]=Array();}
406 $exitSig=$this->rollParseSub(substr($string,$keyLen+1),$setup[$key]);
407 if ($exitSig) return $exitSig;
408 }
409 }
410 }
411
412 /**
413 * Get a value/property pair for an object path in TypoScript, eg. "myobject.myvalue.mysubproperty". Here: Used by the "copy" operator, <
414 *
415 * @param string Object path for which to get the value
416 * @param array Global setup code if $string points to a global object path. But if string is prefixed with "." then its the local setup array.
417 * @return array An array with keys 0/1 being value/property respectively
418 */
419 function getVal($string,$setup) {
420 if ((string)$string!='') {
421 $keyLen = strcspn($string,'.');
422 if ($keyLen==strlen($string)) {
423 $retArr=array(); // Added 6/6/03. Shouldn't hurt
424 if (isset($setup[$string])) {$retArr[0]=$setup[$string]; }
425 if (isset($setup[$string.'.'])) {$retArr[1]=$setup[$string.'.']; }
426 return $retArr;
427 } else {
428 $key = substr($string,0,$keyLen).'.';
429 if ($setup[$key]) {
430 return $this->getVal(substr($string,$keyLen+1),$setup[$key]);
431 }
432 }
433 }
434 }
435
436 /**
437 * Setting a value/property of an object string in the setup array.
438 *
439 * @param string The object sub-path, eg "thisprop.another_prot"
440 * @param array The local setup array from the function calling this function.
441 * @param array The value/property pair array to set. If only one of them is set, then the other is not touched (unless $wipeOut is set, which it is when copies are made which must include both value and property)
442 * @param boolean If set, then both value and property is wiped out when a copy is made of another value.
443 * @return void
444 */
445 function setVal($string,&$setup,$value,$wipeOut=0) {
446 if ((string)$string!='') {
447 $keyLen = strcspn($string,'.');
448 if ($keyLen==strlen($string)) {
449 if ($value=='UNSET') {
450 unset($setup[$string]);
451 unset($setup[$string.'.']);
452 if ($this->regLinenumbers) {
453 $setup[$string.'.ln..'][]=($this->lineNumberOffset+$this->rawP-1).'>';
454 }
455 } else {
456 $lnRegisDone=0;
457 if ($wipeOut && $this->strict) {
458 if ((isset($setup[$string]) && !isset($value[0])) || (isset($setup[$string.'.']) && !isset($value[1]))) {$this->error('Line '.($this->lineNumberOffset+$this->rawP-1).': Object copied in this line "'.trim($this->raw[($this->rawP-1)]).'" would leave either the value or properties untouched in TypoScript Version 1. Please check that this is not a problem for you.',1);}
459 unset($setup[$string]);
460 unset($setup[$string.'.']);
461 if ($this->regLinenumbers) {
462 $setup[$string.'.ln..'][]=($this->lineNumberOffset+$this->rawP-1).'<';
463 $lnRegisDone=1;
464 }
465 }
466 if (isset($value[0])) {$setup[$string] = $value[0];}
467 if (isset($value[1])) {$setup[$string.'.'] = $value[1];}
468 if ($this->lastComment && $this->regComments) {
469 $setup[$string.'..'].=$this->lastComment;
470 }
471 if ($this->regLinenumbers && !$lnRegisDone) {
472 $setup[$string.'.ln..'][]=($this->lineNumberOffset+$this->rawP-1);
473 }
474 }
475 } else {
476 $key = substr($string,0,$keyLen).'.';
477 if (!isset($setup[$key])){$setup[$key]=Array();}
478 $this->setVal(substr($string,$keyLen+1),$setup[$key],$value);
479 }
480 }
481 }
482
483 /**
484 * Stacks errors/messages from the TypoScript parser into an internal array, $this->error
485 * If "TT" is a global object (as it is in the frontend when backend users are logged in) the message will be registered here as well.
486 *
487 * @param string The error message string
488 * @param integer The error severity (in the scale of $GLOBALS['TT']->setTSlogMessage: Approx: 2=warning, 1=info, 0=nothing, 3=fatal.)
489 * @return void
490 */
491 function error($err,$num=2) {
492 if (is_object($GLOBALS['TT'])) $GLOBALS['TT']->setTSlogMessage($err,$num);
493 $this->errors[]=array($err,$num,$this->rawP-1,$this->lineNumberOffset);
494 }
495
496 /**
497 * Checks the input string (un-parsed TypoScript) for include-commands ("<INCLUDE_TYPOSCRIPT: ....")
498 * Use: t3lib_TSparser::checkIncludeLines()
499 *
500 * @param string Unparsed TypoScript
501 * @param integer Counter for detecting endless loops
502 * @param boolean When set an array containing the resulting typoscript and all included files will get returned
503 * @return string Complete TypoScript with includes added.
504 * @static
505 */
506 function checkIncludeLines($string, $cycle_counter=1, $returnFiles=false) {
507 $includedFiles = array();
508 if ($cycle_counter>100) {
509 t3lib_div::sysLog('It appears like TypoScript code is looping over itself. Check your templates for "&lt;INCLUDE_TYPOSCRIPT: ..." tags','Core',2);
510 if ($returnFiles) {
511 return array(
512 'typoscript' => '',
513 'files' => $includedFiles,
514 );
515 }
516 return '';
517 }
518 $splitStr='<INCLUDE_TYPOSCRIPT:';
519 if (strstr($string,$splitStr)) {
520 $newString='';
521 $allParts = explode($splitStr,chr(10).$string.chr(10)); // adds line break char before/after
522 foreach ($allParts as $c => $v) {
523 if (!$c) { // first goes through
524 $newString.=$v;
525 } elseif (preg_match('/\r?\n\s*$/',$allParts[$c-1])) { // There must be a line-break char before.
526 $subparts=explode('>',$v,2);
527 if (preg_match('/^\s*\r?\n/',$subparts[1])) { // There must be a line-break char after
528 // SO, the include was positively recognized:
529 $newString.='### '.$splitStr.$subparts[0].'> BEGIN:'.chr(10);
530 $params = t3lib_div::get_tag_attributes($subparts[0]);
531 if ($params['source']) {
532 $sourceParts = explode(':',$params['source'],2);
533 switch(strtolower(trim($sourceParts[0]))) {
534 case 'file':
535 $filename = t3lib_div::getFileAbsFileName(trim($sourceParts[1]));
536 if (strcmp($filename,'')) { // Must exist and must not contain '..' and must be relative
537 if (@is_file($filename) && filesize($filename)<100000) { // Max. 100 KB include files!
538 // check for includes in included text
539 $includedFiles[] = $filename;
540 $included_text = self::checkIncludeLines(t3lib_div::getUrl($filename),$cycle_counter+1, $returnFiles);
541 // If the method also has to return all included files, merge currently included
542 // files with files included by recursively calling itself
543 if ($returnFiles && is_array($included_text)) {
544 $includedFiles = array_merge($includedFiles, $included_text['files']);
545 $included_text = $included_text['typoscript'];
546 }
547 $newString.= $included_text.chr(10);
548 }
549 }
550 break;
551 }
552 }
553 $newString.='### '.$splitStr.$subparts[0].'> END:'.chr(10);
554 $newString.=$subparts[1];
555 } else $newString.=$splitStr.$v;
556 } else $newString.=$splitStr.$v;
557 }
558 $string=substr($newString,1,-1); // not the first/last linebreak char.
559 }
560 // When all included files should get returned, simply return an compound array containing
561 // the TypoScript with all "includes" processed and the files which got included
562 if ($returnFiles) {
563 return array(
564 'typoscript' => $string,
565 'files' => $includedFiles,
566 );
567 }
568 return $string;
569 }
570
571 /**
572 * Parses the string in each value of the input array for include-commands
573 *
574 * @param array Array with TypoScript in each value
575 * @return array Same array but where the values has been parsed for include-commands
576 */
577 function checkIncludeLines_array($array) {
578 foreach ($array as $k => $v) {
579 $array[$k]=t3lib_TSparser::checkIncludeLines($array[$k]);
580 }
581 return $array;
582 }
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604 /**********************************
605 *
606 * Syntax highlighting
607 *
608 *********************************/
609
610 /**
611 * Syntax highlight a TypoScript text
612 * Will parse the content. Remember, the internal setup array may contain invalid parsed content since conditions are ignored!
613 *
614 * @param string The TypoScript text
615 * @param mixed If blank, linenumbers are NOT printed. If array then the first key is the linenumber offset to add to the internal counter.
616 * @param boolean If set, then the highlighted output will be formatted in blocks based on the brace levels. prespace will be ignored and empty lines represented with a single no-break-space.
617 * @return string HTML code for the syntax highlighted string
618 */
619 function doSyntaxHighlight($string,$lineNum='',$highlightBlockMode=0) {
620 $this->syntaxHighLight=1;
621 $this->highLightData=array();
622 $this->error=array();
623 $string = str_replace(chr(13),'',$string); // This is done in order to prevent empty <span>..</span> sections around chr(13) content. Should not do anything but help lessen the amount of HTML code.
624
625 $this->parse($string);
626
627 return $this->syntaxHighlight_print($lineNum,$highlightBlockMode);
628 }
629
630 /**
631 * Registers a part of a TypoScript line for syntax highlighting.
632 *
633 * @param string Key from the internal array $this->highLightStyles
634 * @param integer Pointer to the line in $this->raw which this is about
635 * @param integer The number of chars LEFT on this line before the end is reached.
636 * @return void
637 * @access private
638 * @see parse()
639 */
640 function regHighLight($code,$pointer,$strlen=-1) {
641 if ($strlen==-1) {
642 $this->highLightData[$pointer] = array(array($code,0));
643 } else {
644 $this->highLightData[$pointer][] = array($code,$strlen);
645 }
646 $this->highLightData_bracelevel[$pointer] = $this->inBrace;
647 }
648
649 /**
650 * Formatting the TypoScript code in $this->raw based on the data collected by $this->regHighLight in $this->highLightData
651 *
652 * @param mixed If blank, linenumbers are NOT printed. If array then the first key is the linenumber offset to add to the internal counter.
653 * @param boolean If set, then the highlighted output will be formatted in blocks based on the brace levels. prespace will be ignored and empty lines represented with a single no-break-space.
654 * @return string HTML content
655 * @access private
656 * @see doSyntaxHighlight()
657 */
658 function syntaxHighlight_print($lineNumDat,$highlightBlockMode) {
659 // Registers all error messages in relation to their linenumber
660 $errA=array();
661 foreach($this->errors as $err) {
662 $errA[$err[2]][]=$err[0];
663 }
664 // Generates the syntax highlighted output:
665 $lines=array();
666 foreach($this->raw as $rawP => $value) {
667 $start=0;
668 $strlen=strlen($value);
669 $lineC='';
670
671 if (is_array($this->highLightData[$rawP])) {
672 foreach($this->highLightData[$rawP] as $set) {
673 $len = $strlen-$start-$set[1];
674 if ($len > 0) {
675 $part = substr($value,$start,$len);
676 $start+=$len;
677 $st = $this->highLightStyles[(isset($this->highLightStyles[$set[0]])?$set[0]:'default')];
678 if (!$highlightBlockMode || $set[0]!='prespace') $lineC.=$st[0].htmlspecialchars($part).$st[1];
679 }elseif ($len < 0) debug(array($len,$value,$rawP));
680 }
681 } else debug(array($value));
682
683 if (strlen(substr($value,$start))) $lineC.=$this->highLightStyles['ignored'][0].htmlspecialchars(substr($value,$start)).$this->highLightStyles['ignored'][1];
684
685 if ($errA[$rawP]) {
686 $lineC.=$this->highLightStyles['error'][0].'<strong> - ERROR:</strong> '.htmlspecialchars(implode(';',$errA[$rawP])).$this->highLightStyles['error'][1];
687 }
688
689 if ($highlightBlockMode && $this->highLightData_bracelevel[$rawP]) {
690 $lineC = str_pad('',$this->highLightData_bracelevel[$rawP]*2,' ',STR_PAD_LEFT).'<span style="'.$this->highLightBlockStyles.($this->highLightBlockStyles_basecolor?'background-color: '.t3lib_div::modifyHTMLColorAll($this->highLightBlockStyles_basecolor,-$this->highLightData_bracelevel[$rawP]*16):'').'">'.(strcmp($lineC,'')?$lineC:'&nbsp;').'</span>';
691 }
692
693 if (is_array($lineNumDat)) {
694 $lineNum = $rawP+$lineNumDat[0];
695 $lineC = $this->highLightStyles['linenum'][0].str_pad($lineNum,4,' ',STR_PAD_LEFT).':'.$this->highLightStyles['linenum'][1].' '.$lineC;
696 }
697
698
699 $lines[] = $lineC;
700 }
701
702 return '<pre class="ts-hl">'.implode(chr(10),$lines).'</pre>';
703 }
704 }
705
706
707 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tsparser.php']) {
708 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tsparser.php']);
709 }
710
711 ?>