Factory.php 10.4 KB
Newer Older
1
2
<?php
/**
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
3
 * @author Bart Visscher <bartv@thisnet.nl>
4
 * @author Joas Schilling <nickvergessen@owncloud.com>
Lukas Reschke's avatar
Lukas Reschke committed
5
 * @author Lukas Reschke <lukas@owncloud.com>
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
6
7
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Robin Appelman <icewind@owncloud.com>
Thomas Müller's avatar
Thomas Müller committed
8
 * @author Robin McCorkell <robin@mccorkell.me.uk>
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
9
 *
Thomas Müller's avatar
Thomas Müller committed
10
 * @copyright Copyright (c) 2016, ownCloud, Inc.
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
11
12
13
14
15
16
17
18
19
20
21
22
23
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
24
25
 *
 */
26

27
28
namespace OC\L10N;

29
30
use OCP\IConfig;
use OCP\IRequest;
31
use OCP\IUserSession;
32
33
use OCP\L10N\IFactory;

34
/**
35
 * A factory that generates language instances
36
 */
37
class Factory implements IFactory {
38
39
40
41

	/** @var string */
	protected $requestLanguage = '';

42
43
	/**
	 * cached instances
44
	 * @var array Structure: Lang => App => \OCP\IL10N
45
	 */
46
47
	protected $instances = [];

48
49
50
	/**
	 * @var array Structure: App => string[]
	 */
51
	protected $availableLanguages = [];
52

53
54
55
56
57
	/**
	 * @var array Structure: string => callable
	 */
	protected $pluralFunctions = [];

58
59
60
61
62
63
	/** @var IConfig */
	protected $config;

	/** @var IRequest */
	protected $request;

64
65
66
	/** @var IUserSession */
	protected $userSession;

67
68
69
	/** @var string */
	protected $serverRoot;

70
71
72
	/**
	 * @param IConfig $config
	 * @param IRequest $request
73
	 * @param IUserSession $userSession
74
	 * @param string $serverRoot
75
	 */
76
77
	public function __construct(IConfig $config,
								IRequest $request,
78
79
								IUserSession $userSession,
								$serverRoot) {
80
81
		$this->config = $config;
		$this->request = $request;
82
		$this->userSession = $userSession;
83
		$this->serverRoot = $serverRoot;
84
85
	}

86
	/**
87
	 * Get a language instance
88
	 *
89
90
	 * @param string $app
	 * @param string|null $lang
91
	 * @return \OCP\IL10N
92
	 */
93
	public function get($app, $lang = null) {
94
95
96
97
		$app = \OC_App::cleanAppId($app);
		if ($lang !== null) {
			$lang = str_replace(array('\0', '/', '\\', '..'), '', (string) $lang);
		}
98
		if ($lang === null || !$this->languageExists($app, $lang)) {
99
			$lang = $this->findLanguage($app);
100
101
		}

102
103
		if (!isset($this->instances[$lang][$app])) {
			$this->instances[$lang][$app] = new L10N(
104
105
106
				$this, $app, $lang,
				$this->getL10nFilesForApp($app, $lang)
			);
107
		}
108

109
		return $this->instances[$lang][$app];
110
111
	}

112
113
114
115
116
117
118
119
120
121
122
	/**
	 * Find the best language
	 *
	 * @param string|null $app App id or null for core
	 * @return string language If nothing works it returns 'en'
	 */
	public function findLanguage($app = null) {
		if ($this->requestLanguage !== '' && $this->languageExists($app, $this->requestLanguage)) {
			return $this->requestLanguage;
		}

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
		/**
		 * At this point ownCloud might not yet be installed and thus the lookup
		 * in the preferences table might fail. For this reason we need to check
		 * whether the instance has already been installed
		 *
		 * @link https://github.com/owncloud/core/issues/21955
		 */
		if($this->config->getSystemValue('installed', false)) {
			$userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() :  null;
			if(!is_null($userId)) {
				$userLang = $this->config->getUserValue($userId, 'core', 'lang', null);
			} else {
				$userLang = null;
			}
		} else {
			$userId = null;
			$userLang = null;
		}
141

Joas Schilling's avatar
Joas Schilling committed
142
143
144
145
		if ($userLang) {
			$this->requestLanguage = $userLang;
			if ($this->languageExists($app, $userLang)) {
				return $userLang;
146
147
148
149
150
			}
		}

		$defaultLanguage = $this->config->getSystemValue('default_language', false);

Joas Schilling's avatar
Joas Schilling committed
151
		if ($defaultLanguage !== false && $this->languageExists($app, $defaultLanguage)) {
152
153
154
155
			return $defaultLanguage;
		}

		$lang = $this->setLanguageFromRequest($app);
156
		if ($userId !== null && $app === null && !$userLang) {
157
158
159
160
161
162
			$this->config->setUserValue($userId, 'core', 'lang', $lang);
		}

		return $lang;
	}

163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
	/**
	 * Find all available languages for an app
	 *
	 * @param string|null $app App id or null for core
	 * @return array an array of available languages
	 */
	public function findAvailableLanguages($app = null) {
		$key = $app;
		if ($key === null) {
			$key = 'null';
		}

		// also works with null as key
		if (!empty($this->availableLanguages[$key])) {
			return $this->availableLanguages[$key];
		}

		$available = ['en']; //english is always available
		$dir = $this->findL10nDir($app);
		if (is_dir($dir)) {
			$files = scandir($dir);
			if ($files !== false) {
				foreach ($files as $file) {
					if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
						$available[] = substr($file, 0, -5);
					}
				}
			}
		}

193
194
195
		// merge with translations from theme
		$theme = $this->config->getSystemValue('theme');
		if (!empty($theme)) {
196
			$themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot));
197
198
199
200
201
202
203
204
205
206
207
208
209

			if (is_dir($themeDir)) {
				$files = scandir($themeDir);
				if ($files !== false) {
					foreach ($files as $file) {
						if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
							$available[] = substr($file, 0, -5);
						}
					}
				}
			}
		}

210
211
212
213
		$this->availableLanguages[$key] = $available;
		return $available;
	}

214
215
216
217
218
219
220
221
222
223
224
	/**
	 * @param string|null $app App id or null for core
	 * @param string $lang
	 * @return bool
	 */
	public function languageExists($app, $lang) {
		if ($lang === 'en') {//english is always available
			return true;
		}

		$languages = $this->findAvailableLanguages($app);
Joas Schilling's avatar
Joas Schilling committed
225
		return array_search($lang, $languages) !== false;
226
227
	}

228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
	/**
	 * @param string|null $app App id or null for core
	 * @return string
	 */
	public function setLanguageFromRequest($app = null) {
		$header = $this->request->getHeader('ACCEPT_LANGUAGE');
		if ($header) {
			$available = $this->findAvailableLanguages($app);

			// E.g. make sure that 'de' is before 'de_DE'.
			sort($available);

			$preferences = preg_split('/,\s*/', strtolower($header));
			foreach ($preferences as $preference) {
				list($preferred_language) = explode(';', $preference);
				$preferred_language = str_replace('-', '_', $preferred_language);

				foreach ($available as $available_language) {
					if ($preferred_language === strtolower($available_language)) {
						if ($app === null && !$this->requestLanguage) {
							$this->requestLanguage = $available_language;
						}
						return $available_language;
					}
				}

				// Fallback from de_De to de
				foreach ($available as $available_language) {
					if (substr($preferred_language, 0, 2) === $available_language) {
						if ($app === null && !$this->requestLanguage) {
							$this->requestLanguage = $available_language;
						}
						return $available_language;
					}
				}
			}
		}

		if (!$this->requestLanguage) {
			$this->requestLanguage = 'en';
		}
		return 'en'; // Last try: English
	}

272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
	/**
	 * Get a list of language files that should be loaded
	 *
	 * @param string $app
	 * @param string $lang
	 * @return string[]
	 */
	// FIXME This method is only public, until OC_L10N does not need it anymore,
	// FIXME This is also the reason, why it is not in the public interface
	public function getL10nFilesForApp($app, $lang) {
		$languageFiles = [];

		$i18nDir = $this->findL10nDir($app);
		$transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json';

287
288
289
		if ((\OC_Helper::isSubDirectory($transFile, $this->serverRoot . '/core/l10n/')
				|| \OC_Helper::isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/')
				|| \OC_Helper::isSubDirectory($transFile, $this->serverRoot . '/settings/l10n/')
290
291
292
293
294
				|| \OC_Helper::isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/')
			)
			&& file_exists($transFile)) {
			// load the translations file
			$languageFiles[] = $transFile;
295
		}
296

297
298
299
		// merge with translations from theme
		$theme = $this->config->getSystemValue('theme');
		if (!empty($theme)) {
300
			$transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot));
301
302
			if (file_exists($transFile)) {
				$languageFiles[] = $transFile;
303
304
305
306
307
308
			}
		}

		return $languageFiles;
	}

309
310
311
312
313
314
	/**
	 * find the l10n directory
	 *
	 * @param string $app App id or empty string for core
	 * @return string directory
	 */
315
	protected function findL10nDir($app = null) {
Joas Schilling's avatar
Joas Schilling committed
316
		if (in_array($app, ['core', 'lib', 'settings'])) {
317
318
			if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) {
				return $this->serverRoot . '/' . $app . '/l10n/';
319
			}
Joas Schilling's avatar
Joas Schilling committed
320
321
322
		} else if ($app && \OC_App::getAppPath($app) !== false) {
			// Check if the app is in the app folder
			return \OC_App::getAppPath($app) . '/l10n/';
323
		}
324
		return $this->serverRoot . '/core/l10n/';
325
	}
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389


	/**
	 * Creates a function from the plural string
	 *
	 * Parts of the code is copied from Habari:
	 * https://github.com/habari/system/blob/master/classes/locale.php
	 * @param string $string
	 * @return string
	 */
	public function createPluralFunction($string) {
		if (isset($this->pluralFunctions[$string])) {
			return $this->pluralFunctions[$string];
		}

		if (preg_match( '/^\s*nplurals\s*=\s*(\d+)\s*;\s*plural=(.*)$/u', $string, $matches)) {
			// sanitize
			$nplurals = preg_replace( '/[^0-9]/', '', $matches[1] );
			$plural = preg_replace( '#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2] );

			$body = str_replace(
				array( 'plural', 'n', '$n$plurals', ),
				array( '$plural', '$n', '$nplurals', ),
				'nplurals='. $nplurals . '; plural=' . $plural
			);

			// add parents
			// important since PHP's ternary evaluates from left to right
			$body .= ';';
			$res = '';
			$p = 0;
			for($i = 0; $i < strlen($body); $i++) {
				$ch = $body[$i];
				switch ( $ch ) {
					case '?':
						$res .= ' ? (';
						$p++;
						break;
					case ':':
						$res .= ') : (';
						break;
					case ';':
						$res .= str_repeat( ')', $p ) . ';';
						$p = 0;
						break;
					default:
						$res .= $ch;
				}
			}

			$body = $res . 'return ($plural>=$nplurals?$nplurals-1:$plural);';
			$function = create_function('$n', $body);
			$this->pluralFunctions[$string] = $function;
			return $function;
		} else {
			// default: one plural form for all cases but n==1 (english)
			$function = create_function(
				'$n',
				'$nplurals=2;$plural=($n==1?0:1);return ($plural>=$nplurals?$nplurals-1:$plural);'
			);
			$this->pluralFunctions[$string] = $function;
			return $function;
		}
	}
390
}