Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
42.11% |
24 / 57 |
|
0.00% |
0 / 7 |
CRAP | |
0.00% |
0 / 1 |
| common_legacy_LegacyAutoLoader | |
42.11% |
24 / 57 |
|
0.00% |
0 / 7 |
125.65 | |
0.00% |
0 / 1 |
| singleton | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
6 | |||
| __construct | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
| register | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| supportLegacyPrefix | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| autoload | |
67.74% |
21 / 31 |
|
0.00% |
0 / 1 |
13.36 | |||
| loadFromRootExtension | |
21.43% |
3 / 14 |
|
0.00% |
0 / 1 |
17.13 | |||
| wrapClass | |
0.00% |
0 / 5 |
|
0.00% |
0 / 1 |
12 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * This program is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of the GNU General Public License |
| 6 | * as published by the Free Software Foundation; under version 2 |
| 7 | * of the License (non-upgradable). |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 17 | * |
| 18 | * Copyright (c) 2014 (original work) Open Assessment Technologies SA; |
| 19 | * |
| 20 | * |
| 21 | */ |
| 22 | |
| 23 | use oat\oatbox\extension\Manifest; |
| 24 | |
| 25 | /** |
| 26 | * the generis autoloader |
| 27 | * |
| 28 | * @access public |
| 29 | * @author Joel Bout <joel@taotesting.com> |
| 30 | * @package generis |
| 31 | */ |
| 32 | class common_legacy_LegacyAutoLoader |
| 33 | { |
| 34 | private static $singleton = null; |
| 35 | |
| 36 | /** |
| 37 | * |
| 38 | * @return common_legacy_LegacyAutoLoader |
| 39 | */ |
| 40 | private static function singleton() |
| 41 | { |
| 42 | if (self::$singleton == null) { |
| 43 | self::$singleton = new self(); |
| 44 | } |
| 45 | return self::$singleton; |
| 46 | } |
| 47 | |
| 48 | /** @var string[] */ |
| 49 | private $legacyPrefixes = []; |
| 50 | |
| 51 | /** @var string */ |
| 52 | private $generisPath; |
| 53 | |
| 54 | /** @var string */ |
| 55 | private $rootPath; |
| 56 | |
| 57 | /** |
| 58 | * protect the cunstructer, singleton pattern |
| 59 | */ |
| 60 | private function __construct() |
| 61 | { |
| 62 | $this->generisPath = dirname(__DIR__, 2) . DIRECTORY_SEPARATOR; |
| 63 | $this->rootPath = $this->generisPath . '..' . DIRECTORY_SEPARATOR; |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * Register this instance of ClassLoader as a php autoloader |
| 68 | * |
| 69 | * @access public |
| 70 | * @author Joel Bout <joel@taotesting.com> |
| 71 | */ |
| 72 | public static function register() |
| 73 | { |
| 74 | // init the autloader for generis |
| 75 | spl_autoload_register([self::singleton(), 'autoload']); |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * add support for legacy prefix |
| 80 | */ |
| 81 | public static function supportLegacyPrefix($prefix, $namespace) |
| 82 | { |
| 83 | self::singleton()->legacyPrefixes[$prefix] = $namespace; |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Attempt to autload classes in tao |
| 88 | * |
| 89 | * @access public |
| 90 | * @author Joel Bout <joel@taotesting.com> |
| 91 | * @param string pClassName |
| 92 | * @return void |
| 93 | */ |
| 94 | public function autoload($pClassName): void |
| 95 | { |
| 96 | if (strpos($pClassName, '_') === false) { |
| 97 | return; |
| 98 | } |
| 99 | |
| 100 | $tokens = explode("_", $pClassName); |
| 101 | $size = count($tokens); |
| 102 | $path = ''; |
| 103 | for ($i = 0; $i < $size - 1; $i++) { |
| 104 | $path .= $tokens[$i] . '/'; |
| 105 | } |
| 106 | |
| 107 | // Search for class.X.php |
| 108 | $filePath = '/' . $path . 'class.' . $tokens[$size - 1] . '.php'; |
| 109 | if (file_exists($this->generisPath . $filePath)) { |
| 110 | require_once $this->generisPath . $filePath; |
| 111 | return; |
| 112 | } |
| 113 | |
| 114 | // Search for interface.X.php |
| 115 | $filePathInterface = '/' . $path . 'interface.' . $tokens[$size - 1] . '.php'; |
| 116 | if (file_exists($this->generisPath . $filePathInterface)) { |
| 117 | require_once $this->generisPath . $filePathInterface; |
| 118 | return; |
| 119 | } |
| 120 | |
| 121 | // Search for trait.X.php |
| 122 | $filePathTrait = '/' . $path . 'trait.' . $tokens[$size - 1] . '.php'; |
| 123 | if (file_exists($this->generisPath . $filePathTrait)) { |
| 124 | require_once $this->generisPath . $filePathTrait; |
| 125 | return; |
| 126 | } |
| 127 | |
| 128 | if (file_exists($this->rootPath . $filePath)) { |
| 129 | require_once $this->rootPath . $filePath; |
| 130 | return; |
| 131 | } |
| 132 | |
| 133 | if (file_exists($this->rootPath . $filePathInterface)) { |
| 134 | require_once $this->rootPath . $filePathInterface; |
| 135 | return; |
| 136 | } |
| 137 | |
| 138 | foreach ($this->legacyPrefixes as $key => $namespace) { |
| 139 | if (substr($pClassName, 0, strlen($key)) == $key) { |
| 140 | $newClass = $namespace . strtr(substr($pClassName, strlen($key)), '_', '\\'); |
| 141 | $this->wrapClass($pClassName, $newClass); |
| 142 | return; |
| 143 | } |
| 144 | } |
| 145 | |
| 146 | $this->loadFromRootExtension($tokens); |
| 147 | } |
| 148 | |
| 149 | private function loadFromRootExtension(array $classNameTokens): void |
| 150 | { |
| 151 | $manifestPath = $this->rootPath . 'manifest.php'; |
| 152 | |
| 153 | if (!file_exists($manifestPath)) { |
| 154 | return; |
| 155 | } |
| 156 | |
| 157 | $manifest = new Manifest($manifestPath); |
| 158 | if ($manifest->getName() !== reset($classNameTokens)) { |
| 159 | return; |
| 160 | } |
| 161 | |
| 162 | $path = implode(DIRECTORY_SEPARATOR, array_slice($classNameTokens, 1, -1)) . DIRECTORY_SEPARATOR; |
| 163 | |
| 164 | $classFilePath = $this->rootPath . $path . 'class.' . end($classNameTokens) . '.php'; |
| 165 | if (file_exists($classFilePath)) { |
| 166 | require_once $classFilePath; |
| 167 | |
| 168 | return; |
| 169 | } |
| 170 | |
| 171 | $interfaceFilePath = $this->rootPath . $path . 'interface.' . end($classNameTokens) . '.php'; |
| 172 | if (file_exists($interfaceFilePath)) { |
| 173 | require_once $interfaceFilePath; |
| 174 | } |
| 175 | } |
| 176 | |
| 177 | private function wrapClass($legacyClass, $realClass) |
| 178 | { |
| 179 | common_Logger::w('Legacy classname "' . $legacyClass . '" referenced, please use "' . $realClass . '" instead'); |
| 180 | if (preg_match('/[^A-Za-z0-9_\\\\]/', $legacyClass) || preg_match('/[^A-Za-z0-9_\\\\]/', $realClass)) { |
| 181 | throw new Exception('Unknown characters in class name'); |
| 182 | } |
| 183 | $classDefinition = 'class ' . $legacyClass . ' extends ' . $realClass . ' {}'; |
| 184 | eval($classDefinition); |
| 185 | } |
| 186 | } |
| 187 | |
| 188 | // phpcs:disable PSR1.Files.SideEffects |
| 189 | common_legacy_LegacyAutoLoader::register(); |
| 190 | // phpcs:enable PSR1.Files.SideEffects |