[TASK] Replace Space Indent into Tab indent (CGL Cleanup)
[Packages/TYPO3.CMS.git] / typo3 / sysext / lang / lang.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2011 Kasper Skårhøj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains the TYPO3 Backend Language class
29 *
30 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
31 */
32
33 /**
34 * Contains the TYPO3 Backend Language class
35 *
36 * For detailed information about how localization is handled,
37 * please refer to the 'Inside TYPO3' document which descibes this.
38 *
39 * This class is normally instantiated as the global variable $LANG in typo3/template.php
40 * It's only available in the backend and under certain circumstances in the frontend
41 *
42 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
43 * @package TYPO3
44 * @subpackage core
45 * @see typo3/template.php, template
46 */
47 class language {
48
49 /**
50 * This is set to the language that is currently running for the user
51 *
52 * @var string
53 */
54 public $lang = 'default';
55
56 /**
57 * Default charset in backend
58 *
59 * @var string
60 */
61 public $charSet = 'utf-8';
62
63 /**
64 * Array with alternative charsets for other languages.
65 * Moved to t3lib_cs, set internally from csConvObj!
66 *
67 * @var array
68 */
69 public $charSetArray = array();
70
71 /**
72 * This is the url to the TYPO3 manual
73 *
74 * @var string
75 */
76 public $typo3_help_url= 'http://typo3.org/documentation/document-library/';
77
78 /**
79 * If TRUE, will show the key/location of labels in the backend.
80 * @var bool
81 */
82 public $debugKey = FALSE;
83
84 /**
85 * Can contain labels and image references from the backend modules.
86 * Relies on t3lib_loadmodules to initialize modules after a global instance of $LANG has been created.
87 *
88 * @var array
89 */
90 public $moduleLabels = array();
91
92 /**
93 * Internal cache for read LL-files
94 *
95 * @var array
96 */
97 public $LL_files_cache = array();
98
99 /**
100 * Internal cache for ll-labels (filled as labels are requested)
101 *
102 * @var array
103 */
104 public $LL_labels_cache = array();
105
106 /**
107 * instance of the "t3lib_cs" class. May be used by any application.
108 *
109 * @var t3lib_cs
110 */
111 public $csConvObj;
112
113 /**
114 * instance of the parser factory
115 * @var t3lib_l10n_Factory
116 */
117 public $parserFactory;
118
119 /**
120 * List of language dependencies for actual language. This is used for local variants of a language
121 * that depend on their "main" language, like Brazilian Portugese or Canadian French.
122 *
123 * @var array
124 */
125 protected $languageDependencies = array();
126
127 /**
128 * Initializes the backend language.
129 * This is for example done in typo3/template.php with lines like these:
130 *
131 * require (PATH_typo3 . 'sysext/lang/lang.php');
132 * $LANG = t3lib_div::makeInstance('language');
133 * $LANG->init($GLOBALS['BE_USER']->uc['lang']);
134 *
135 * @throws RuntimeException
136 * @param string $lang The language key (two character string from backend users profile)
137 * @return void
138 */
139 public function init($lang) {
140
141 // Initialize the conversion object:
142 $this->csConvObj = t3lib_div::makeInstance('t3lib_cs');
143 $this->charSetArray = $this->csConvObj->charSetArray;
144
145 // Initialize the parser factory object
146 $this->parserFactory = t3lib_div::makeInstance('t3lib_l10n_Factory');
147
148 // Finding the requested language in this list based
149 // on the $lang key being inputted to this function.
150 /** @var $locales t3lib_l10n_Locales */
151 $locales = t3lib_div::makeInstance('t3lib_l10n_Locales');
152
153 // Language is found. Configure it:
154 if (in_array($lang, $locales->getLocales())) {
155 // The current language key
156 $this->lang = $lang;
157
158 $this->languageDependencies[] = $this->lang;
159 foreach ($locales->getLocaleDependencies($this->lang) as $language) {
160 $this->languageDependencies[] = $language;
161 }
162 }
163
164 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['lang']['debug']) {
165 $this->debugKey = TRUE;
166 }
167 }
168
169 /**
170 * Gets the parser factory.
171 *
172 * @return t3lib_l10n_Factory
173 */
174 public function getParserFactory() {
175 return $this->parserFactory;
176 }
177
178 /**
179 * Adds labels and image references from the backend modules to the internal moduleLabels array
180 *
181 * @param array $arr Array with references to module labels, keys: ['labels']['tablabel'],
182 * ['labels']['tabdescr'], ['tabs']['tab']
183 * @param string $prefix Module name prefix
184 * @return void
185 * @see t3lib_loadModules
186 */
187 public function addModuleLabels($arr, $prefix) {
188 if (is_array($arr)) {
189 foreach ($arr as $k => $larr) {
190 if (!isset($this->moduleLabels[$k])) {
191 $this->moduleLabels[$k] = array();
192 }
193 if (is_array($larr)) {
194 foreach ($larr as $l => $v) {
195 $this->moduleLabels[$k][$prefix . $l] = $v;
196 }
197 }
198 }
199 }
200 }
201
202 /**
203 * Will convert the input strings special chars (all above 127) to entities.
204 * The string is expected to be encoded in UTF-8
205 * This function is used to create strings that can be used in the Click Menu
206 * (Context Sensitive Menus). The reason is that the values that are dynamically
207 * written into the <div> layer is decoded as iso-8859-1 no matter what charset
208 * is used in the document otherwise (only MSIE, Mozilla is OK).
209 * So by converting we by-pass this problem.
210 *
211 * @param string $str Input string
212 * @return string Output string
213 * @access public
214 */
215 public function makeEntities($str) {
216 // Convert string back again, but using the full entity conversion:
217 return $this->csConvObj->utf8_to_entities($str);
218 }
219
220 /**
221 * Converts the input string to a JavaScript function returning the same string, but charset-safe.
222 * Used for confirm and alert boxes where we must make sure that any string content
223 * does not break the script AND want to make sure the charset is preserved.
224 * Originally I used the JS function unescape() in combination with PHP function
225 * rawurlencode() in order to pass strings in a safe way. This could still be done
226 * for iso-8859-1 charsets but now I have applied the same method here for all charsets.
227 *
228 * @param string $str Input string, encoded with UTF-8
229 * @return string Output string, a JavaScript function: "String.fromCharCode(......)"
230 * @access public
231 */
232 public function JScharCode($str) {
233 // Convert the UTF-8 string into a array of char numbers:
234 $nArr = $this->csConvObj->utf8_to_numberarray($str);
235
236 return 'String.fromCharCode(' . implode(',', $nArr) . ')';
237 }
238
239 /**
240 * Debugs localization key.
241 *
242 * @param $value Value to debug
243 * @return string
244 */
245 public function debugLL($value) {
246 return ($this->debugKey ? '[' . $value . ']' : '');
247 }
248
249 /**
250 * Returns the label with key $index form the globally loaded $LOCAL_LANG array.
251 * Mostly used from modules with only one LOCAL_LANG file loaded into the global space.
252 *
253 * @param string $index Label key
254 * @param boolean $hsc If set, the return value is htmlspecialchar'ed
255 * @return string
256 * @access public
257 */
258 public function getLL($index, $hsc = FALSE) {
259 // Get Local Language
260 if (isset($GLOBALS['LOCAL_LANG'][$this->lang][$index][0]['target'])) {
261 $output = $GLOBALS['LOCAL_LANG'][$this->lang][$index][0]['target'];
262 } else {
263 $output = $GLOBALS['LOCAL_LANG']['default'][$index][0]['target'];
264 }
265 if ($hsc) {
266 $output = htmlspecialchars($output);
267 }
268 return $output . $this->debugLL($index);
269 }
270
271 /**
272 * Works like ->getLL() but takes the $LOCAL_LANG array
273 * used as the second argument instead of using the global array.
274 *
275 * @param string $index Label key
276 * @param array $localLanguage $LOCAL_LANG array to get label key from
277 * @param boolean $hsc If set, the return value is htmlspecialchar'ed
278 * @return string
279 * @access public
280 */
281 public function getLLL($index, $localLanguage, $hsc = FALSE) {
282 // Get Local Language. Special handling for all extensions that
283 // read PHP LL files and pass arrays here directly.
284 $value = is_string($localLanguage[$this->lang][$index]) ? $localLanguage[$this->lang][$index] : $localLanguage[$this->lang][$index][0]['target'];
285
286 // Fallback to default language
287 if (trim($value) === '') {
288 $value = is_string($localLanguage['default'][$index]) ? $localLanguage['default'][$index] : $localLanguage['default'][$index][0]['target'];
289 }
290
291 if ($hsc) {
292 $value = htmlspecialchars($value);
293 }
294 return $value . $this->debugLL($index);
295 }
296
297 /**
298 * splitLabel function
299 * Historically labels were exploded by '|' and each part would correspond
300 * to the translation of the language found at the same 'index' in the TYPO3_languages constant.
301 * Today all translations are based on $LOCAL_LANG variables.
302 * 'language-splitted' labels can therefore refer to a local-lang file + index instead!
303 * It's highly recommended to use the 'local_lang' method
304 * (and thereby it's highly deprecated to use 'language-splitted' label strings)
305 * Refer to 'Inside TYPO3' for more details
306 *
307 * @param string $input Label key/reference
308 * @param boolean $hsc If set, the return value is htmlspecialchar'ed
309 * @return string
310 * @access public
311 */
312 public function sL($input, $hsc = FALSE) {
313 // If cached label
314 if (!isset($this->LL_labels_cache[$this->lang][$input]) && substr($input, 0, 4) === 'LLL:') {
315 $restStr = trim(substr($input, 4));
316 $extPrfx = '';
317
318 // ll-file refered to is found in an extension.
319 if (!strcmp(substr($restStr, 0, 4), 'EXT:')) {
320 $restStr = trim(substr($restStr, 4));
321 $extPrfx = 'EXT:';
322 }
323 $parts = explode(':', $restStr);
324 $parts[0] = $extPrfx . $parts[0];
325
326 // Getting data if not cached
327 if (!isset($this->LL_files_cache[$parts[0]])) {
328 $this->LL_files_cache[$parts[0]] = $this->readLLfile($parts[0]);
329
330 // If the current language is found in another file, load that as well:
331 $lFileRef = $this->localizedFileRef($parts[0]);
332 if ($lFileRef && is_string($this->LL_files_cache[$parts[0]][$this->lang])
333 && $this->LL_files_cache[$parts[0]][$this->lang] == 'EXT') {
334 $tempLL = $this->readLLfile($lFileRef);
335 $this->LL_files_cache[$parts[0]][$this->lang] = $tempLL[$this->lang];
336 }
337 }
338 $this->LL_labels_cache[$this->lang][$input] = $this->getLLL($parts[1], $this->LL_files_cache[$parts[0]]);
339 }
340 // For the cached output charset conversion has already happened!
341 // So perform HSC right here.
342 if (isset($this->LL_labels_cache[$this->lang][$input])) {
343 $output = $this->LL_labels_cache[$this->lang][$input];
344 } else {
345 // Use a constant non-localizable label
346 $output = $input;
347 }
348
349 if ($hsc) {
350 $output = t3lib_div::deHSCentities(htmlspecialchars($output));
351 }
352 return $output . $this->debugLL($input);
353 }
354
355 /**
356 * Loading $TCA_DESCR[$table]['columns'] with content from locallang files
357 * as defined in $TCA_DESCR[$table]['refs']
358 * $TCA_DESCR is a global var
359 *
360 * @param string $table Table name found as key in global array $TCA_DESCR
361 * @return void
362 * @access public
363 */
364 public function loadSingleTableDescription($table) {
365
366 // First the 'table' cannot already be loaded in [columns]
367 // and secondly there must be a references to locallang files available in [refs]
368 if (is_array($GLOBALS['TCA_DESCR'][$table])
369 && !isset($GLOBALS['TCA_DESCR'][$table]['columns'])
370 && is_array($GLOBALS['TCA_DESCR'][$table]['refs'])) {
371
372 // Init $TCA_DESCR for $table-key
373 $GLOBALS['TCA_DESCR'][$table]['columns'] = array();
374
375 // Get local-lang for each file in $TCA_DESCR[$table]['refs'] as they are ordered.
376 foreach ($GLOBALS['TCA_DESCR'][$table]['refs'] as $llfile) {
377 $localLanguage = $this->includeLLFile($llfile, 0, 1);
378
379 // Traverse all keys
380 if (is_array($localLanguage['default'])) {
381 foreach ($localLanguage['default'] as $lkey => $lVal) {
382 $type = '';
383 $fieldName = '';
384
385 // Exploding by '.':
386 // 0-n => fieldname,
387 // n+1 => type from (alttitle, description, details, syntax, image_descr,image,seeAlso),
388 // n+2 => special instruction, if any
389 $keyParts = explode('.', $lkey);
390 $keyPartsCount = count($keyParts);
391 // Check if last part is special instruction
392 // Only "+" is currently supported
393 $specialInstruction = ($keyParts[$keyPartsCount - 1] == '+') ? TRUE : FALSE;
394 if ($specialInstruction) {
395 array_pop($keyParts);
396 }
397
398 // If there are more than 2 parts, get the type from the last part
399 // and merge back the other parts with a dot (.)
400 // Otherwise just get type and field name straightaway
401 if ($keyPartsCount > 2) {
402 $type = array_pop($keyParts);
403 $fieldName = implode('.', $keyParts);
404 } else {
405 $fieldName = $keyParts[0];
406 $type = $keyParts[1];
407 }
408
409 // Detecting 'hidden' labels, converting to normal fieldname
410 if ($fieldName == '_') {
411 $fieldName = '';
412 }
413 if (substr($fieldName, 0, 1) == '_') {
414 $fieldName = substr($fieldName, 1);
415 }
416
417 // Append label
418 $label = $lVal[0]['target'] ?: $lVal[0]['source'];
419 if ($specialInstruction) {
420 $GLOBALS['TCA_DESCR'][$table]['columns'][$fieldName][$type] .= LF . $label;
421 } else {
422 // Substitute label
423 $GLOBALS['TCA_DESCR'][$table]['columns'][$fieldName][$type] = $label;
424 }
425 }
426 }
427 }
428 }
429 }
430
431 /**
432 * Includes locallang file (and possibly additional localized version if configured for)
433 * Read language labels will be merged with $LOCAL_LANG (if $setGlobal = TRUE).
434 *
435 * @param string $fileRef $fileRef is a file-reference (see t3lib_div::getFileAbsFileName)
436 * @param boolean $setGlobal Setting in global variable $LOCAL_LANG (or returning the variable)
437 * @param boolean $mergeLocalOntoDefault 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.
438 * @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
439 * @access public
440 */
441 public function includeLLFile($fileRef, $setGlobal = TRUE, $mergeLocalOntoDefault = FALSE) {
442
443 $globalLanguage = array();
444
445 // Get default file
446 $localLanguage = $this->readLLfile($fileRef);
447
448 if (is_array($localLanguage) && count($localLanguage)) {
449
450 // it depends on, whether we should return the result or set it in the global $LOCAL_LANG array
451 if ($setGlobal) {
452 $globalLanguage = t3lib_div::array_merge_recursive_overrule((array)$GLOBALS['LOCAL_LANG'], $localLanguage);
453 } else {
454 $globalLanguage = $localLanguage;
455 }
456
457 // Localized addition?
458 $lFileRef = $this->localizedFileRef($fileRef);
459 if ($lFileRef && (string)$globalLanguage[$this->lang] == 'EXT') {
460 $localLanguage = $this->readLLfile($lFileRef);
461 $globalLanguage = t3lib_div::array_merge_recursive_overrule($globalLanguage, $localLanguage);
462 }
463
464 // Merge local onto default
465 if ($mergeLocalOntoDefault && $this->lang !== 'default'
466 && is_array($globalLanguage[$this->lang]) && is_array($globalLanguage['default'])) {
467 // array_merge can be used so far the keys are not
468 // numeric - which we assume they are not...
469 $globalLanguage['default'] = array_merge($globalLanguage['default'], $globalLanguage[$this->lang]);
470 unset($globalLanguage[$this->lang]);
471 }
472 }
473
474 // Return value if not global is set.
475 if (!$setGlobal) {
476 return $globalLanguage;
477 } else {
478 $GLOBALS['LOCAL_LANG'] = $globalLanguage;
479 }
480 }
481
482 /**
483 * Includes a locallang file and returns the $LOCAL_LANG array found inside.
484 *
485 * @param string $fileRef 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.
486 * @return array Value of $LOCAL_LANG found in the included file. If that array is found it's returned. Otherwise an empty array
487 * @access private
488 */
489 protected function readLLfile($fileRef) {
490 if ($this->lang !== 'default') {
491 $languages = array_reverse($this->languageDependencies);
492 } else {
493 $languages = array('default');
494 }
495
496 $localLanguage = array();
497 foreach ($languages as $language) {
498 $tempLL = t3lib_div::readLLfile($fileRef, $language, $this->charSet);
499 $localLanguage['default'] = $tempLL['default'];
500 if (!isset($localLanguage[$this->lang])) {
501 $localLanguage[$this->lang] = $localLanguage['default'];
502 }
503 if ($this->lang !== 'default' && isset($tempLL[$language])) {
504 // Merge current language labels onto labels from previous language
505 // This way we have a labels with fall back applied
506 $localLanguage[$this->lang] = t3lib_div::array_merge_recursive_overrule($localLanguage[$this->lang], $tempLL[$language], FALSE, FALSE);
507 }
508 }
509
510 return $localLanguage;
511 }
512
513 /**
514 * Returns localized fileRef (.[langkey].php)
515 *
516 * @param string $fileRef Filename/path of a 'locallang.php' file
517 * @return string Input filename with a '.[lang-key].php' ending added if $this->lang is not 'default'
518 * @access private
519 */
520 protected function localizedFileRef($fileRef) {
521 if ($this->lang != 'default' && substr($fileRef, -4) == '.php') {
522 return substr($fileRef, 0, -4) . '.' . $this->lang . '.php';
523 }
524 }
525
526 /**
527 * Overrides a label.
528 *
529 * @param string $index
530 * @param string $value
531 * @param boolean $overrideDefault Overrides default language
532 * @return void
533 */
534 public function overrideLL($index, $value, $overrideDefault = TRUE) {
535 if (isset($GLOBALS['LOCAL_LANG']) === FALSE) {
536 $GLOBALS['LOCAL_LANG'] = array();
537 }
538
539 $GLOBALS['LOCAL_LANG'][$this->lang][$index][0]['target'] = $value;
540
541 if ($overrideDefault) {
542 $GLOBALS['LOCAL_LANG']['default'][$index][0]['target'] = $value;
543 }
544 }
545 }
546 ?>