[CLEANUP][CONF!!!] Remove forceCharset option and references
[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 htmlspecialchar() the input string and before that any charset conversion
204 * will also have taken place if needed (see init())
205 * Used to pipe language labels through just before they are returned.
206 *
207 * @param string $lStr The string to process
208 * @param boolean $hsc If set, then the string is htmlspecialchars()'ed
209 * @return string The processed string
210 * @deprecated since TYPO3 4.6, will be removed in TYPO3 4.8 - Use htmlspecialchars() instead.
211 * @see init()
212 * @access public
213 */
214 public function hscAndCharConv($lStr, $hsc) {
215 t3lib_div::logDeprecatedFunction();
216 // labels returned from a locallang file used to be in the language of the charset.
217 // Since TYPO3 4.1 they are always in the charset of the BE.
218 if ($hsc) {
219 return htmlspecialchars($lStr);
220 } else {
221 return $lStr;
222 }
223 }
224
225 /**
226 * Will convert the input strings special chars (all above 127) to entities.
227 * The string is expected to be encoded in UTF-8
228 * This function is used to create strings that can be used in the Click Menu
229 * (Context Sensitive Menus). The reason is that the values that are dynamically
230 * written into the <div> layer is decoded as iso-8859-1 no matter what charset
231 * is used in the document otherwise (only MSIE, Mozilla is OK).
232 * So by converting we by-pass this problem.
233 *
234 * @param string $str Input string
235 * @return string Output string
236 * @access public
237 */
238 public function makeEntities($str) {
239 // Convert string back again, but using the full entity conversion:
240 return $this->csConvObj->utf8_to_entities($str);
241 }
242
243 /**
244 * Converts the input string to a JavaScript function returning the same string, but charset-safe.
245 * Used for confirm and alert boxes where we must make sure that any string content
246 * does not break the script AND want to make sure the charset is preserved.
247 * Originally I used the JS function unescape() in combination with PHP function
248 * rawurlencode() in order to pass strings in a safe way. This could still be done
249 * for iso-8859-1 charsets but now I have applied the same method here for all charsets.
250 *
251 * @param string $str Input string, encoded with UTF-8
252 * @return string Output string, a JavaScript function: "String.fromCharCode(......)"
253 * @access public
254 */
255 public function JScharCode($str) {
256 // Convert the UTF-8 string into a array of char numbers:
257 $nArr = $this->csConvObj->utf8_to_numberarray($str);
258
259 return 'String.fromCharCode(' . implode(',', $nArr) . ')';
260 }
261
262 /**
263 * Debugs localization key.
264 *
265 * @param $value Value to debug
266 * @return string
267 */
268 public function debugLL($value) {
269 return ($this->debugKey ? '[' . $value . ']' : '');
270 }
271
272 /**
273 * Returns the label with key $index form the globally loaded $LOCAL_LANG array.
274 * Mostly used from modules with only one LOCAL_LANG file loaded into the global space.
275 *
276 * @param string $index Label key
277 * @param boolean $hsc If set, the return value is htmlspecialchar'ed
278 * @return string
279 * @access public
280 */
281 public function getLL($index, $hsc = FALSE) {
282 // Get Local Language
283 if (isset($GLOBALS['LOCAL_LANG'][$this->lang][$index][0]['target'])) {
284 $output = $GLOBALS['LOCAL_LANG'][$this->lang][$index][0]['target'];
285 } else {
286 $output = $GLOBALS['LOCAL_LANG']['default'][$index][0]['target'];
287 }
288 if ($hsc) {
289 $output = htmlspecialchars($output);
290 }
291 return $output . $this->debugLL($index);
292 }
293
294 /**
295 * Works like ->getLL() but takes the $LOCAL_LANG array
296 * used as the second argument instead of using the global array.
297 *
298 * @param string $index Label key
299 * @param array $localLanguage $LOCAL_LANG array to get label key from
300 * @param boolean $hsc If set, the return value is htmlspecialchar'ed
301 * @return string
302 * @access public
303 */
304 public function getLLL($index, $localLanguage, $hsc = FALSE) {
305 // Get Local Language. Special handling for all extensions that
306 // read PHP LL files and pass arrays here directly.
307 $value = is_string($localLanguage[$this->lang][$index]) ? $localLanguage[$this->lang][$index] : $localLanguage[$this->lang][$index][0]['target'];
308
309 // Fallback to default language
310 if (trim($value) === '') {
311 $value = is_string($localLanguage['default'][$index]) ? $localLanguage['default'][$index] : $localLanguage['default'][$index][0]['target'];
312 }
313
314 if ($hsc) {
315 $value = htmlspecialchars($value);
316 }
317 return $value . $this->debugLL($index);
318 }
319
320 /**
321 * splitLabel function
322 * Historically labels were exploded by '|' and each part would correspond
323 * to the translation of the language found at the same 'index' in the TYPO3_languages constant.
324 * Today all translations are based on $LOCAL_LANG variables.
325 * 'language-splitted' labels can therefore refer to a local-lang file + index instead!
326 * It's highly recommended to use the 'local_lang' method
327 * (and thereby it's highly deprecated to use 'language-splitted' label strings)
328 * Refer to 'Inside TYPO3' for more details
329 *
330 * @param string $input Label key/reference
331 * @param boolean $hsc If set, the return value is htmlspecialchar'ed
332 * @return string
333 * @access public
334 */
335 public function sL($input, $hsc = FALSE) {
336 // If cached label
337 if (!isset($this->LL_labels_cache[$this->lang][$input]) && substr($input, 0, 4) === 'LLL:') {
338 $restStr = trim(substr($input, 4));
339 $extPrfx = '';
340
341 // ll-file refered to is found in an extension.
342 if (!strcmp(substr($restStr, 0, 4), 'EXT:')) {
343 $restStr = trim(substr($restStr, 4));
344 $extPrfx = 'EXT:';
345 }
346 $parts = explode(':', $restStr);
347 $parts[0] = $extPrfx . $parts[0];
348
349 // Getting data if not cached
350 if (!isset($this->LL_files_cache[$parts[0]])) {
351 $this->LL_files_cache[$parts[0]] = $this->readLLfile($parts[0]);
352
353 // If the current language is found in another file, load that as well:
354 $lFileRef = $this->localizedFileRef($parts[0]);
355 if ($lFileRef && is_string($this->LL_files_cache[$parts[0]][$this->lang])
356 && $this->LL_files_cache[$parts[0]][$this->lang] == 'EXT') {
357 $tempLL = $this->readLLfile($lFileRef);
358 $this->LL_files_cache[$parts[0]][$this->lang] = $tempLL[$this->lang];
359 }
360 }
361 $this->LL_labels_cache[$this->lang][$input] = $this->getLLL($parts[1], $this->LL_files_cache[$parts[0]]);
362 }
363 // For the cached output charset conversion has already happened!
364 // So perform HSC right here.
365 if (isset($this->LL_labels_cache[$this->lang][$input])) {
366 $output = $this->LL_labels_cache[$this->lang][$input];
367 } else {
368 // Use a constant non-localizable label
369 $output = $input;
370 }
371
372 if ($hsc) {
373 $output = t3lib_div::deHSCentities(htmlspecialchars($output));
374 }
375 return $output . $this->debugLL($input);
376 }
377
378 /**
379 * Loading $TCA_DESCR[$table]['columns'] with content from locallang files
380 * as defined in $TCA_DESCR[$table]['refs']
381 * $TCA_DESCR is a global var
382 *
383 * @param string $table Table name found as key in global array $TCA_DESCR
384 * @return void
385 * @access public
386 */
387 public function loadSingleTableDescription($table) {
388
389 // First the 'table' cannot already be loaded in [columns]
390 // and secondly there must be a references to locallang files available in [refs]
391 if (is_array($GLOBALS['TCA_DESCR'][$table])
392 && !isset($GLOBALS['TCA_DESCR'][$table]['columns'])
393 && is_array($GLOBALS['TCA_DESCR'][$table]['refs'])) {
394
395 // Init $TCA_DESCR for $table-key
396 $GLOBALS['TCA_DESCR'][$table]['columns'] = array();
397
398 // Get local-lang for each file in $TCA_DESCR[$table]['refs'] as they are ordered.
399 foreach ($GLOBALS['TCA_DESCR'][$table]['refs'] as $llfile) {
400 $localLanguage = $this->includeLLFile($llfile, 0, 1);
401
402 // Traverse all keys
403 if (is_array($localLanguage['default'])) {
404 foreach ($localLanguage['default'] as $lkey => $lVal) {
405 $type = '';
406 $fieldName = '';
407
408 // Exploding by '.':
409 // 0-n => fieldname,
410 // n+1 => type from (alttitle, description, details, syntax, image_descr,image,seeAlso),
411 // n+2 => special instruction, if any
412 $keyParts = explode('.', $lkey);
413 $keyPartsCount = count($keyParts);
414 // Check if last part is special instruction
415 // Only "+" is currently supported
416 $specialInstruction = ($keyParts[$keyPartsCount - 1] == '+') ? TRUE : FALSE;
417 if ($specialInstruction) {
418 array_pop($keyParts);
419 }
420
421 // If there are more than 2 parts, get the type from the last part
422 // and merge back the other parts with a dot (.)
423 // Otherwise just get type and field name straightaway
424 if ($keyPartsCount > 2) {
425 $type = array_pop($keyParts);
426 $fieldName = implode('.', $keyParts);
427 } else {
428 $fieldName = $keyParts[0];
429 $type = $keyParts[1];
430 }
431
432 // Detecting 'hidden' labels, converting to normal fieldname
433 if ($fieldName == '_') {
434 $fieldName = '';
435 }
436 if (substr($fieldName, 0, 1) == '_') {
437 $fieldName = substr($fieldName, 1);
438 }
439
440 // Append label
441 $label = $lVal[0]['target'] ?: $lVal[0]['source'];
442 if ($specialInstruction) {
443 $GLOBALS['TCA_DESCR'][$table]['columns'][$fieldName][$type] .= LF . $label;
444 } else {
445 // Substitute label
446 $GLOBALS['TCA_DESCR'][$table]['columns'][$fieldName][$type] = $label;
447 }
448 }
449 }
450 }
451 }
452 }
453
454 /**
455 * Includes locallang file (and possibly additional localized version if configured for)
456 * Read language labels will be merged with $LOCAL_LANG (if $setGlobal = TRUE).
457 *
458 * @param string $fileRef $fileRef is a file-reference (see t3lib_div::getFileAbsFileName)
459 * @param boolean $setGlobal Setting in global variable $LOCAL_LANG (or returning the variable)
460 * @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.
461 * @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
462 * @access public
463 */
464 public function includeLLFile($fileRef, $setGlobal = TRUE, $mergeLocalOntoDefault = FALSE) {
465
466 $globalLanguage = array();
467
468 // Get default file
469 $localLanguage = $this->readLLfile($fileRef);
470
471 if (is_array($localLanguage) && count($localLanguage)) {
472
473 // it depends on, whether we should return the result or set it in the global $LOCAL_LANG array
474 if ($setGlobal) {
475 $globalLanguage = t3lib_div::array_merge_recursive_overrule((array)$GLOBALS['LOCAL_LANG'], $localLanguage);
476 } else {
477 $globalLanguage = $localLanguage;
478 }
479
480 // Localized addition?
481 $lFileRef = $this->localizedFileRef($fileRef);
482 if ($lFileRef && (string)$globalLanguage[$this->lang] == 'EXT') {
483 $localLanguage = $this->readLLfile($lFileRef);
484 $globalLanguage = t3lib_div::array_merge_recursive_overrule($globalLanguage, $localLanguage);
485 }
486
487 // Merge local onto default
488 if ($mergeLocalOntoDefault && $this->lang !== 'default'
489 && is_array($globalLanguage[$this->lang]) && is_array($globalLanguage['default'])) {
490 // array_merge can be used so far the keys are not
491 // numeric - which we assume they are not...
492 $globalLanguage['default'] = array_merge($globalLanguage['default'], $globalLanguage[$this->lang]);
493 unset($globalLanguage[$this->lang]);
494 }
495 }
496
497 // Return value if not global is set.
498 if (!$setGlobal) {
499 return $globalLanguage;
500 } else {
501 $GLOBALS['LOCAL_LANG'] = $globalLanguage;
502 }
503 }
504
505 /**
506 * Includes a locallang file and returns the $LOCAL_LANG array found inside.
507 *
508 * @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.
509 * @return array Value of $LOCAL_LANG found in the included file. If that array is found it's returned. Otherwise an empty array
510 * @access private
511 */
512 protected function readLLfile($fileRef) {
513 if ($this->lang !== 'default') {
514 $languages = array_reverse($this->languageDependencies);
515 } else {
516 $languages = array('default');
517 }
518
519 $localLanguage = array();
520 foreach ($languages as $language) {
521 $tempLL = t3lib_div::readLLfile($fileRef, $language, $this->charSet);
522 $localLanguage['default'] = $tempLL['default'];
523 if (!isset($localLanguage[$this->lang])) {
524 $localLanguage[$this->lang] = $localLanguage['default'];
525 }
526 if ($this->lang !== 'default' && isset($tempLL[$language])) {
527 // Merge current language labels onto labels from previous language
528 // This way we have a labels with fall back applied
529 $localLanguage[$this->lang] = t3lib_div::array_merge_recursive_overrule($localLanguage[$this->lang], $tempLL[$language], FALSE, FALSE);
530 }
531 }
532
533 return $localLanguage;
534 }
535
536 /**
537 * Returns localized fileRef (.[langkey].php)
538 *
539 * @param string $fileRef Filename/path of a 'locallang.php' file
540 * @return string Input filename with a '.[lang-key].php' ending added if $this->lang is not 'default'
541 * @access private
542 */
543 protected function localizedFileRef($fileRef) {
544 if ($this->lang != 'default' && substr($fileRef, -4) == '.php') {
545 return substr($fileRef, 0, -4) . '.' . $this->lang . '.php';
546 }
547 }
548
549 /**
550 * Overrides a label.
551 *
552 * @param string $index
553 * @param string $value
554 * @param boolean $overrideDefault Overrides default language
555 * @return void
556 */
557 public function overrideLL($index, $value, $overrideDefault = TRUE) {
558 if (isset($GLOBALS['LOCAL_LANG']) === FALSE) {
559 $GLOBALS['LOCAL_LANG'] = array();
560 }
561
562 $GLOBALS['LOCAL_LANG'][$this->lang][$index][0]['target'] = $value;
563
564 if ($overrideDefault) {
565 $GLOBALS['LOCAL_LANG']['default'][$index][0]['target'] = $value;
566 }
567 }
568 }
569
570
571 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/lang/lang.php'])) {
572 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/lang/lang.php']);
573 }
574
575 ?>