*** empty log message ***
[Packages/TYPO3.CMS.git] / typo3 / sysext / lang / lang.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2005 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 TYPO3 Backend Language class
29 *
30 * $Id$
31 * Revised for TYPO3 3.6.0
32 *
33 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
34 */
35 /**
36 * [CLASS/FUNCTION INDEX of SCRIPT]
37 *
38 *
39 *
40 * 89: class language
41 * 137: function init($lang,$altPath='')
42 * 182: function addModuleLabels($arr,$prefix)
43 * 208: function hscAndCharConv($lStr,$hsc)
44 * 223: function makeEntities($str)
45 * 240: function JScharCode($str)
46 * 259: function getLL($index,$hsc=0)
47 * 276: function getLLL($index,$LOCAL_LANG,$hsc=0)
48 * 296: function sL($input,$hsc=0)
49 * 340: function loadSingleTableDescription($table)
50 * 392: function includeLLFile($fileRef,$setGlobal=1,$mergeLocalOntoDefault=0)
51 * 437: function readLLfile($fileRef)
52 * 458: function readLLXMLfile($fileRef,$langKey)
53 * 559: function localizedFileRef($fileRef)
54 *
55 * TOTAL FUNCTIONS: 13
56 * (This index is automatically created/updated by the extension "extdeveval")
57 *
58 */
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75 /**
76 * Contains the TYPO3 Backend Language class
77 *
78 * For detailed information about how localization is handled,
79 * please refer to the 'Inside TYPO3' document which descibes this.
80 *
81 * This class is normally instantiated as the global variable $LANG in typo3/template.php
82 * It's only available in the backend and under certain circumstances in the frontend
83 *
84 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
85 * @package TYPO3
86 * @subpackage core
87 * @see typo3/template.php, template
88 */
89 class language {
90 var $lang='default'; // This is set to the language that is currently running for the user
91 var $langSplit='default'; // Values like the labels in the tables.php-document are split by '|'. This values defines which language is represented by which position in the resulting array after splitting a value. (NOTICE: Obsolete concept!)
92
93 // Default charset in backend
94 var $charSet = 'iso-8859-1';
95
96 // Array with alternative charsets for other languages. (Moved to t3lib_cs, Set from csConvObj!)
97 var $charSetArray = array();
98
99 // This is the url to the TYPO3 manual
100 var $typo3_help_url= 'http://www.typo3.com/man_uk/';
101 // Array with alternative URLs based on language.
102 var $helpUrlArray = array(
103 'dk' => 'http://www.typo3.com/man_dk/',
104 );
105
106
107 var $moduleLabels = Array(); // Can contain labels and image references from the backend modules. Relies on t3lib_loadmodules to initialize modules after a global instance of $LANG has been created.
108
109 // Internal
110 var $langSplitIndex=0; // Points to the position of the current language key as found in constant TYPO3_languages
111 var $LL_files_cache=array(); // Internal cache for read LL-files
112 var $LL_labels_cache=array(); // Internal cache for ll-labels (filled as labels are requested)
113
114 // Internal charset conversion:
115 var $origCharSet=''; // If set, then it means that the this->charSet is set to a forced, common value for the WHOLE backend regardless of user language. And THIS variable will contain the original charset for the language labels. With ->csConvObj we must then convert the original charset to the charset used in the backend from now on.
116 var $csConvObj; // An instance of the "t3lib_cs" class. May be used by any application.
117
118
119
120
121
122
123
124
125 /**
126 * Initializes the backend language.
127 * This is for example done in typo3/template.php with lines like these:
128 *
129 * require (PATH_typo3.'sysext/lang/lang.php');
130 * $LANG = t3lib_div::makeInstance('language');
131 * $LANG->init($BE_USER->uc['lang']);
132 *
133 * @param string The language key (two character string from backend users profile)
134 * @param string IGNORE. Not used.
135 * @return void
136 */
137 function init($lang,$altPath='') {
138
139 // Initialize the conversion object:
140 $this->csConvObj = t3lib_div::makeInstance('t3lib_cs');
141 $this->charSetArray = $this->csConvObj->charSetArray;
142
143 // Internally setting the list of TYPO3 backend languages.
144 $this->langSplit=TYPO3_languages;
145
146 // Finding the requested language in this list based on the $lang key being inputted to this function.
147 $ls = explode('|',$this->langSplit);
148 while(list($i,$v)=each($ls)) {
149 if ($v==$lang) { // Language is found. Configure it:
150 $this->langSplitIndex=$i; // The index of the language as found in the TYPO3_languages list
151 $this->lang = $lang; // The current language key
152 if ($this->helpUrlArray[$this->lang]) $this->typo3_help_url=$this->helpUrlArray[$this->lang]; // The help URL if different from the default.
153 if ($this->charSetArray[$this->lang]) $this->charSet=$this->charSetArray[$this->lang]; // The charset if different from the default.
154 }
155 }
156
157 // If a forced charset is used and different from the charset otherwise used:
158 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'] && $GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset']!=$this->charSet) {
159 // Set the forced charset:
160 $this->origCharSet = $this->charSet;
161 $this->charSet = $GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'];
162
163 if ($this->charSet!='utf-8' && !$this->csConvObj->initCharset($this->charSet)) {
164 t3lib_BEfunc::typo3PrintError ('The forced character set "'.$this->charSet.'" was not found in t3lib/csconvtbl/','Forced charset not found');
165 exit;
166 }
167 if ($this->origCharSet!='utf-8' && !$this->csConvObj->initCharset($this->origCharSet)) {
168 t3lib_BEfunc::typo3PrintError ('The original character set "'.$this->origCharSet.'" was not found in t3lib/csconvtbl/','Forced charset not found');
169 exit;
170 }
171 }
172 }
173
174 /**
175 * Adds labels and image references from the backend modules to the internal moduleLabels array
176 *
177 * @param array Array with references to module labels, keys: ['labels']['tablabel'], ['labels']['tabdescr'], ['tabs']['tab']
178 * @param string Module name prefix
179 * @return void
180 * @see t3lib_loadModules
181 */
182 function addModuleLabels($arr,$prefix) {
183 if (is_array($arr)) {
184 reset($arr);
185 while(list($k,$larr)=each($arr)) {
186 if (!isset($this->moduleLabels[$k])) {
187 $this->moduleLabels[$k]=array();
188 }
189 if (is_array($larr)) {
190 reset($larr);
191 while(list($l,$v)=each($larr)) {
192 $this->moduleLabels[$k][$prefix.$l]=$v;
193 }
194 }
195 }
196 }
197 }
198
199 /**
200 * Will htmlspecialchar() the input string and before that any charset conversion will also have taken place if needed (see init())
201 * Used to pipe language labels through just before they are returned.
202 *
203 * @param string The string to process
204 * @param boolean If set, then the string is htmlspecialchars()'ed
205 * @return string The processed string
206 * @see init()
207 */
208 function hscAndCharConv($lStr,$hsc) {
209 $lStr = $hsc ? htmlspecialchars($lStr) : $lStr;
210 if ($this->origCharSet) {
211 $lStr = $this->csConvObj->conv($lStr,$this->origCharSet,$this->charSet,1);
212 }
213 return $lStr;
214 }
215
216 /**
217 * Will convert the input strings special chars (all above 127) to entities. The string is expected to be encoded in the charset, $this->charSet
218 * This function is used to create strings that can be used in the Click Menu (Context Sensitive Menus). The reason is that the values that are dynamically written into the <div> layer is decoded as iso-8859-1 no matter what charset is used in the document otherwise (only MSIE, Mozilla is OK). So by converting we by-pass this problem.
219 *
220 * @param string Input string
221 * @return string Output string
222 */
223 function makeEntities($str) {
224 // Convert string to UTF-8:
225 if ($this->charSet!='utf-8') $str = $this->csConvObj->utf8_encode($str,$this->charSet);
226
227 // Convert string back again, but using the full entity conversion:
228 $str = $this->csConvObj->utf8_to_entities($str);
229 return $str;
230 }
231
232 /**
233 * Converts the input string to a JavaScript function returning the same string, but charset-safe.
234 * Used for confirm and alert boxes where we must make sure that any string content does not break the script AND want to make sure the charset is preserved.
235 * Originally I used the JS function unescape() in combination with PHP function rawurlencode() in order to pass strings in a safe way. This could still be done for iso-8859-1 charsets but now I have applied the same method here for all charsets.
236 *
237 * @param string Input string, encoded with $this->charSet
238 * @return string Output string, a JavaScript function: "String.fromCharCode(......)"
239 */
240 function JScharCode($str) {
241
242 // Convert string to UTF-8:
243 if ($this->charSet!='utf-8') $str = $this->csConvObj->utf8_encode($str,$this->charSet);
244
245 // Convert the UTF-8 string into a array of char numbers:
246 $nArr = $this->csConvObj->utf8_to_numberarray($str);
247
248 return 'String.fromCharCode('.implode(',',$nArr).')';
249 }
250
251 /**
252 * Returns the label with key $index form the globally loaded $LOCAL_LANG array.
253 * Mostly used from modules with only one LOCAL_LANG file loaded into the global space.
254 *
255 * @param string Label key
256 * @param boolean If set, the return value is htmlspecialchar'ed
257 * @return string
258 */
259 function getLL($index,$hsc=0) {
260 // Get Local Language
261 if (strcmp($GLOBALS['LOCAL_LANG'][$this->lang][$index],'')) {
262 return $this->hscAndCharConv($GLOBALS['LOCAL_LANG'][$this->lang][$index], $hsc); // Returns local label if not blank.
263 } else {
264 return $this->hscAndCharConv($GLOBALS['LOCAL_LANG']['default'][$index], $hsc); // Returns default label
265 }
266 }
267
268 /**
269 * Works like ->getLL() but takes the $LOCAL_LANG array used as the second argument instead of using the global array.
270 *
271 * @param string Label key
272 * @param array $LOCAL_LANG array to get label key from
273 * @param boolean If set, the return value is htmlspecialchar'ed
274 * @return string
275 */
276 function getLLL($index,$LOCAL_LANG,$hsc=0) {
277 // Get Local Language
278 if (strcmp($LOCAL_LANG[$this->lang][$index],'')) {
279 return $this->hscAndCharConv($LOCAL_LANG[$this->lang][$index], $hsc); // Returns local label if not blank.
280 } else {
281 return $this->hscAndCharConv($LOCAL_LANG['default'][$index], $hsc); // Returns default label
282 }
283 }
284
285 /**
286 * splitLabel function
287 * Historically labels were exploded by '|' and each part would correspond to the translation of the language found at the same 'index' in the TYPO3_languages constant.
288 * Today all translations are based on $LOCAL_LANG variables. 'language-splitted' labels can therefore refer to a local-lang file + index instead!
289 * It's highly recommended to use the 'local_lang' method (and thereby it's highly depreciated to use 'language-splitted' label strings)
290 * Refer to 'Inside TYPO3' for more details
291 *
292 * @param string Label key/reference
293 * @param boolean If set, the return value is htmlspecialchar'ed
294 * @return string
295 */
296 function sL($input,$hsc=0) {
297 if (strcmp(substr($input,0,4),'LLL:')) { // Using obsolete 'language-splitted' labels:
298 $t = explode('|',$input);
299 $out = $t[$this->langSplitIndex] ? $t[$this->langSplitIndex] : $t[0];
300 return $this->hscAndCharConv($out, $hsc);
301 } else { // LOCAL_LANG:
302 if (!isset($this->LL_labels_cache[$this->lang][$input])) { // If cached label
303 $restStr = trim(substr($input,4));
304 $extPrfx='';
305 if (!strcmp(substr($restStr,0,4),'EXT:')) { // ll-file refered to is found in an extension.
306 $restStr = trim(substr($restStr,4));
307 $extPrfx='EXT:';
308 }
309 $parts = explode(':',$restStr);
310 $parts[0]=$extPrfx.$parts[0];
311 if (!isset($this->LL_files_cache[$parts[0]])) { // Getting data if not cached
312 $this->LL_files_cache[$parts[0]] = $this->readLLfile($parts[0]);
313
314 // If the current language is found in another file, load that as well:
315 $lFileRef = $this->localizedFileRef($parts[0]);
316 if ($lFileRef && is_string($this->LL_files_cache[$parts[0]][$this->lang]) && $this->LL_files_cache[$parts[0]][$this->lang]=='EXT') {
317 $tempLL = $this->readLLfile($lFileRef);
318 $this->LL_files_cache[$parts[0]][$this->lang] = $tempLL[$this->lang];
319 }
320
321 // Overriding file?
322 if (isset($GLOBALS['TYPO3_CONF_VARS']['BE']['XLLfile'][$parts[0]])) {
323 $ORarray = $this->readLLfile($GLOBALS['TYPO3_CONF_VARS']['BE']['XLLfile'][$parts[0]]);
324 $this->LL_files_cache[$parts[0]] = t3lib_div::array_merge_recursive_overrule($this->LL_files_cache[$parts[0]],$ORarray);
325 }
326 }
327 $this->LL_labels_cache[$this->lang][$input] = $this->getLLL($parts[1],$this->LL_files_cache[$parts[0]]);
328 }
329 return $hsc ? t3lib_div::deHSCentities(htmlspecialchars($this->LL_labels_cache[$this->lang][$input])) : $this->LL_labels_cache[$this->lang][$input]; // For the cached output charset conversion has already happend! So perform HSC right here.
330 }
331 }
332
333 /**
334 * Loading $TCA_DESCR[$table]['columns'] with content from locallang files as defined in $TCA_DESCR[$table]['refs']
335 * $TCA_DESCR is a global var
336 *
337 * @param string Table name found as key in global array $TCA_DESCR
338 * @return void
339 */
340 function loadSingleTableDescription($table) {
341 global $TCA_DESCR;
342
343 if (is_array($TCA_DESCR[$table])
344 && !isset($TCA_DESCR[$table]['columns'])
345 && is_array($TCA_DESCR[$table]['refs'])) { // First the 'table' cannot already be loaded in [columns] and secondly there must be a references to locallang files available in [refs]
346
347 // Init $TCA_DESCR for $table-key
348 $TCA_DESCR[$table]['columns']=array();
349
350 // Get local-lang for each file in $TCA_DESCR[$table]['refs'] as they are ordered.
351 foreach ($TCA_DESCR[$table]['refs'] as $llfile) {
352 $LOCAL_LANG = $this->includeLLFile($llfile,0,1);
353
354 // Traverse all keys
355 if (is_array($LOCAL_LANG['default'])) {
356 foreach($LOCAL_LANG['default'] as $lkey => $lVal) {
357
358 // exploding by '.':
359 // 0 => fieldname,
360 // 1 => type from (alttitle,description,details,syntax,image_descr,image,seeAlso),
361 // 2 => special instruction, see switch construct
362 $kParts = explode('.',$lkey);
363
364 // Detecting 'hidden' labels, converting to normal fieldname
365 if ($kParts[0]=='_') $kParts[0]='';
366 if (substr($kParts[0],0,1)=='_') { $kParts[0] = substr($kParts[0],1); }
367
368 // Add label:
369 switch((string)$kParts[2]) {
370 case '+': // adding
371 $TCA_DESCR[$table]['columns'][$kParts[0]][$kParts[1]].= chr(10).$lVal;
372 break;
373 default: // Substituting:
374 $TCA_DESCR[$table]['columns'][$kParts[0]][$kParts[1]] = $lVal;
375 break;
376 }
377 }
378 }
379 }
380 }
381 }
382
383 /**
384 * Includes locallang file (and possibly additional localized version if configured for)
385 * Read language labels will be merged with $LOCAL_LANG (if $setGlobal=1).
386 *
387 * @param string $fileRef is a file-reference (see t3lib_div::getFileAbsFileName)
388 * @param boolean Setting in global variable $LOCAL_LANG (or returning the variable)
389 * @param boolean If $mergeLocalOntoDefault is set the local part of the $LOCAL_LANG array is merged onto the default part (if the local part exists) and the local part is unset.
390 * @return mixed If $setGlobal is true the LL-files will set the $LOCAL_LANG in the global scope. Otherwise the $LOCAL_LANG array is returned from function
391 */
392 function includeLLFile($fileRef,$setGlobal=1,$mergeLocalOntoDefault=0) {
393 // Configure for global flag:
394 if ($setGlobal) {
395 global $LOCAL_LANG;
396 }
397
398 // Get default file:
399 $llang = $this->readLLfile($fileRef);
400
401 if (count($llang)) {
402
403 $LOCAL_LANG = t3lib_div::array_merge_recursive_overrule($LOCAL_LANG,$llang);
404
405 // Localized addition?
406 $lFileRef = $this->localizedFileRef($fileRef);
407 if ($lFileRef && (string)$LOCAL_LANG[$this->lang]=='EXT') {
408 $llang = $this->readLLfile($lFileRef);
409 $LOCAL_LANG = t3lib_div::array_merge_recursive_overrule($LOCAL_LANG,$llang);
410 }
411
412 // Overriding file?
413 if (isset($GLOBALS['TYPO3_CONF_VARS']['BE']['XLLfile'][$fileRef])) {
414 $ORarray = $this->readLLfile($GLOBALS['TYPO3_CONF_VARS']['BE']['XLLfile'][$fileRef]);
415 $LOCAL_LANG = t3lib_div::array_merge_recursive_overrule($LOCAL_LANG,$ORarray);
416 }
417
418 // Merge local onto default:
419 if ($mergeLocalOntoDefault && strcmp($this->lang,'default') && is_array($LOCAL_LANG[$this->lang]) && is_array($LOCAL_LANG['default'])) {
420 $LOCAL_LANG['default'] = array_merge($LOCAL_LANG['default'],$LOCAL_LANG[$this->lang]); // array_merge can be used so far the keys are not numeric - which we assume they are not...
421 unset($LOCAL_LANG[$this->lang]);
422 }
423 }
424
425 // Return value if not global is set.
426 if (!$setGlobal) {
427 return $LOCAL_LANG;
428 }
429 }
430
431 /**
432 * Includes a locallang file and returns the $LOCAL_LANG array found inside.
433 *
434 * @param string Input is a file-reference (see t3lib_div::getFileAbsFileName) which, if exists, is included. That file is expected to be a 'local_lang' file containing a $LOCAL_LANG array.
435 * @return array Value of $LOCAL_LANG found in the included file. If that array is found it's returned. Otherwise an empty array
436 */
437 function readLLfile($fileRef) {
438 return t3lib_div::readLLfile($fileRef,$this->lang);
439 }
440
441 /**
442 * Returns localized fileRef (.[langkey].php)
443 *
444 * @param string Filename/path of a 'locallang.php' file
445 * @return string Input filename with a '.[lang-key].php' ending added if $this->lang is not 'default'
446 */
447 function localizedFileRef($fileRef) {
448 if ($this->lang!='default' && substr($fileRef,-4)=='.php') {
449 return substr($fileRef,0,-4).'.'.$this->lang.'.php';
450 }
451 }
452 }
453
454 // Include extension to the template class?
455 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/lang/lang.php']) {
456 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/lang/lang.php']);
457 }
458 ?>