nextcloud /
server
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Factory often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Factory, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 41 | class Factory implements IFactory { |
||
| 42 | |||
| 43 | /** @var string */ |
||
| 44 | protected $requestLanguage = ''; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * cached instances |
||
| 48 | * @var array Structure: Lang => App => \OCP\IL10N |
||
| 49 | */ |
||
| 50 | protected $instances = []; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * @var array Structure: App => string[] |
||
| 54 | */ |
||
| 55 | protected $availableLanguages = []; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * @var array Structure: string => callable |
||
| 59 | */ |
||
| 60 | protected $pluralFunctions = []; |
||
| 61 | |||
| 62 | const COMMON_LANGUAGE_CODES = [ |
||
| 63 | 'en', 'es', 'fr', 'de', 'de_DE', 'ja', 'ar', 'ru', 'nl', 'it', |
||
| 64 | 'pt_BR', 'pt_PT', 'da', 'fi_FI', 'nb_NO', 'sv', 'tr', 'zh_CN', 'ko' |
||
| 65 | ]; |
||
| 66 | |||
| 67 | /** @var IConfig */ |
||
| 68 | protected $config; |
||
| 69 | |||
| 70 | /** @var IRequest */ |
||
| 71 | protected $request; |
||
| 72 | |||
| 73 | /** @var IUserSession */ |
||
| 74 | protected $userSession; |
||
| 75 | |||
| 76 | /** @var string */ |
||
| 77 | protected $serverRoot; |
||
| 78 | |||
| 79 | /** |
||
| 80 | * @param IConfig $config |
||
| 81 | * @param IRequest $request |
||
| 82 | * @param IUserSession $userSession |
||
| 83 | * @param string $serverRoot |
||
| 84 | */ |
||
| 85 | public function __construct(IConfig $config, |
||
| 86 | IRequest $request, |
||
| 87 | IUserSession $userSession, |
||
| 88 | $serverRoot) { |
||
| 89 | $this->config = $config; |
||
| 90 | $this->request = $request; |
||
| 91 | $this->userSession = $userSession; |
||
| 92 | $this->serverRoot = $serverRoot; |
||
| 93 | } |
||
| 94 | |||
| 95 | /** |
||
| 96 | * Get a language instance |
||
| 97 | * |
||
| 98 | * @param string $app |
||
| 99 | * @param string|null $lang |
||
| 100 | * @return \OCP\IL10N |
||
| 101 | */ |
||
| 102 | public function get($app, $lang = null) { |
||
| 103 | $app = \OC_App::cleanAppId($app); |
||
| 104 | if ($lang !== null) { |
||
| 105 | $lang = str_replace(array('\0', '/', '\\', '..'), '', (string) $lang); |
||
| 106 | } |
||
| 107 | |||
| 108 | $forceLang = $this->config->getSystemValue('force_language', false); |
||
| 109 | if (is_string($forceLang)) { |
||
| 110 | $lang = $forceLang; |
||
| 111 | } |
||
| 112 | |||
| 113 | if ($lang === null || !$this->languageExists($app, $lang)) { |
||
| 114 | $lang = $this->findLanguage($app); |
||
| 115 | } |
||
| 116 | |||
| 117 | if (!isset($this->instances[$lang][$app])) { |
||
| 118 | $this->instances[$lang][$app] = new L10N( |
||
| 119 | $this, $app, $lang, |
||
| 120 | $this->getL10nFilesForApp($app, $lang) |
||
| 121 | ); |
||
| 122 | } |
||
| 123 | |||
| 124 | return $this->instances[$lang][$app]; |
||
| 125 | } |
||
| 126 | |||
| 127 | /** |
||
| 128 | * Find the best language |
||
| 129 | * |
||
| 130 | * @param string|null $app App id or null for core |
||
| 131 | * @return string language If nothing works it returns 'en' |
||
| 132 | */ |
||
| 133 | public function findLanguage($app = null) { |
||
| 182 | |||
| 183 | /** |
||
| 184 | * Find all available languages for an app |
||
| 185 | * |
||
| 186 | * @param string|null $app App id or null for core |
||
| 187 | * @return array an array of available languages |
||
| 188 | */ |
||
| 189 | public function findAvailableLanguages($app = null) { |
||
| 233 | |||
| 234 | /** |
||
| 235 | * @param string|null $app App id or null for core |
||
| 236 | * @param string $lang |
||
| 237 | * @return bool |
||
| 238 | */ |
||
| 239 | public function languageExists($app, $lang) { |
||
| 247 | |||
| 248 | /** |
||
| 249 | * @param string|null $app |
||
| 250 | * @return string |
||
| 251 | * @throws LanguageNotFoundException |
||
| 252 | */ |
||
| 253 | private function getLanguageFromRequest($app) { |
||
| 283 | |||
| 284 | /** |
||
| 285 | * if default language is set to de_DE (formal German) this should be |
||
| 286 | * preferred to 'de' (non-formal German) if possible |
||
| 287 | * |
||
| 288 | * @param string|null $app |
||
| 289 | * @param string $lang |
||
| 290 | * @return string |
||
| 291 | */ |
||
| 292 | protected function respectDefaultLanguage($app, $lang) { |
||
| 308 | |||
| 309 | /** |
||
| 310 | * Checks if $sub is a subdirectory of $parent |
||
| 311 | * |
||
| 312 | * @param string $sub |
||
| 313 | * @param string $parent |
||
| 314 | * @return bool |
||
| 315 | */ |
||
| 316 | private function isSubDirectory($sub, $parent) { |
||
| 329 | |||
| 330 | /** |
||
| 331 | * Get a list of language files that should be loaded |
||
| 332 | * |
||
| 333 | * @param string $app |
||
| 334 | * @param string $lang |
||
| 335 | * @return string[] |
||
| 336 | */ |
||
| 337 | // FIXME This method is only public, until OC_L10N does not need it anymore, |
||
| 338 | // FIXME This is also the reason, why it is not in the public interface |
||
| 339 | public function getL10nFilesForApp($app, $lang) { |
||
| 366 | |||
| 367 | /** |
||
| 368 | * find the l10n directory |
||
| 369 | * |
||
| 370 | * @param string $app App id or empty string for core |
||
| 371 | * @return string directory |
||
| 372 | */ |
||
| 373 | protected function findL10nDir($app = null) { |
||
| 384 | |||
| 385 | |||
| 386 | /** |
||
| 387 | * Creates a function from the plural string |
||
| 388 | * |
||
| 389 | * Parts of the code is copied from Habari: |
||
| 390 | * https://github.com/habari/system/blob/master/classes/locale.php |
||
| 391 | * @param string $string |
||
| 392 | * @return string |
||
| 393 | */ |
||
| 394 | public function createPluralFunction($string) { |
||
| 449 | |||
| 450 | /** |
||
| 451 | * returns the common language and other languages in an |
||
| 452 | * associative array |
||
| 453 | * |
||
| 454 | * @return array |
||
| 455 | */ |
||
| 456 | public function getLanguages() { |
||
| 519 | } |
||
| 520 |
Loading history...
In PHP, under loose comparison (like
==, or!=, orswitchconditions), values of different types might be equal.For
stringvalues, the empty string''is a special case, in particular the following results might be unexpected: