| Total Complexity | 56 |
| Total Lines | 384 |
| Duplicated Lines | 0 % |
| Changes | 15 | ||
| Bugs | 6 | Features | 2 |
Complex classes like PluginInstaller 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.
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 PluginInstaller, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 28 | class PluginInstaller { |
||
| 29 | |||
| 30 | //plugin to install / deinstall |
||
| 31 | protected $plugin = null; |
||
| 32 | |||
| 33 | public function __construct(Plugin $plugin) { |
||
| 35 | } |
||
| 36 | |||
| 37 | /** |
||
| 38 | * check php version, php extensions and so on |
||
| 39 | * |
||
| 40 | * @return mixed true, if all required plugins are available, or an array with missing |
||
| 41 | */ |
||
| 42 | public function checkRequirements (bool $dontCheckPlugins = false) { |
||
| 43 | //get require |
||
| 44 | $require_array = $this->plugin->getRequiredPlugins(); |
||
| 45 | |||
| 46 | //get package list |
||
| 47 | require(STORE_PATH . "package_list.php"); |
||
| 48 | |||
| 49 | $missing_plugins = array(); |
||
| 50 | |||
| 51 | $installed_plugins = Plugins::listInstalledPlugins(); |
||
|
|
|||
| 52 | |||
| 53 | //iterate through all requirements |
||
| 54 | foreach ($require_array as $requirement=>$version) { |
||
| 55 | if ($requirement === "php") { |
||
| 56 | //check php version |
||
| 57 | if (!$this->checkVersion($version, phpversion())) { |
||
| 58 | $missing_plugins[] = $requirement; |
||
| 59 | |||
| 60 | continue; |
||
| 61 | } |
||
| 62 | } else if (PHPUtils::startsWith($requirement, "ext-")) { |
||
| 63 | //check php extension |
||
| 64 | |||
| 65 | $extension = str_replace("ext-", "", $requirement); |
||
| 66 | |||
| 67 | //check, if php extension is loaded |
||
| 68 | if (!extension_loaded($extension)) { |
||
| 69 | $missing_plugins[] = $requirement; |
||
| 70 | |||
| 71 | continue; |
||
| 72 | } |
||
| 73 | |||
| 74 | //get extension version |
||
| 75 | $current_version = phpversion($extension); |
||
| 76 | |||
| 77 | //check version |
||
| 78 | if (!$this->checkVersion($version, $current_version)) { |
||
| 79 | $missing_plugins[] = $requirement; |
||
| 80 | } |
||
| 81 | } else if (PHPUtils::startsWith($requirement, "apache-")) { |
||
| 82 | //check for apache module, but no version check is supported |
||
| 83 | |||
| 84 | $module = str_replace("apache-", "", $requirement); |
||
| 85 | |||
| 86 | if (!function_exists('apache_get_modules')) { |
||
| 87 | $missing_plugins[] = "apache"; |
||
| 88 | |||
| 89 | continue; |
||
| 90 | } |
||
| 91 | |||
| 92 | if (!in_array($module, apache_get_modules())) { |
||
| 93 | $missing_plugins[] = $requirement; |
||
| 94 | } |
||
| 95 | } else if (PHPUtils::startsWith($requirement, "package-")) { |
||
| 96 | //check if package is installed |
||
| 97 | $package = str_replace("package-", "", $requirement); |
||
| 98 | |||
| 99 | //packages doesnt supports specific version |
||
| 100 | |||
| 101 | if (!isset($package_list[$package])) { |
||
| 102 | $missing_plugins[] = $requirement; |
||
| 103 | } |
||
| 104 | } else if ($requirement === "core") { |
||
| 105 | //check core version |
||
| 106 | if ($version === "*") { |
||
| 107 | //we dont have to check version |
||
| 108 | } else { |
||
| 109 | //get current version |
||
| 110 | $array = explode(" ", Version::current()->getVersion()); |
||
| 111 | $current_core_version = $array[0]; |
||
| 112 | |||
| 113 | //check version |
||
| 114 | if (!$this->checkVersion($version, $current_core_version)) { |
||
| 115 | $missing_plugins[] = "core"; |
||
| 116 | } |
||
| 117 | } |
||
| 118 | } else { |
||
| 119 | throw new Exception("plugin requirement check isnt supported yet."); |
||
| 120 | |||
| 121 | if (!$dontCheckPlugins) { |
||
| 122 | continue; |
||
| 123 | } |
||
| 124 | |||
| 125 | //check, if plugin is installed |
||
| 126 | if (!self::isPluginInstalled($requirement, $installed_plugins)) { |
||
| 127 | $missing_plugins[] = $requirement; |
||
| 128 | continue; |
||
| 129 | } |
||
| 130 | |||
| 131 | //check plugin version |
||
| 132 | $current_version = self::getPluginVersion($requirement, $installed_plugins); |
||
| 133 | |||
| 134 | //check version |
||
| 135 | if (!$this->checkVersion($version, $current_version)) { |
||
| 136 | $missing_plugins[] = $requirement . ":version"; |
||
| 137 | } |
||
| 138 | } |
||
| 139 | } |
||
| 140 | |||
| 141 | if (empty($missing_plugins)) { |
||
| 142 | return true; |
||
| 143 | } else { |
||
| 144 | return $missing_plugins; |
||
| 145 | } |
||
| 146 | } |
||
| 147 | |||
| 148 | public static function isPluginInstalled (string $plugin_name, array $installed_plugins = array()) : bool { |
||
| 149 | if (empty($installed_plugins)) { |
||
| 150 | $installed_plugins = Plugins::listInstalledPlugins(); |
||
| 151 | } |
||
| 152 | |||
| 153 | if (!isset($installed_plugins[$plugin_name])) { |
||
| 154 | //plugin is not installed |
||
| 155 | return false; |
||
| 156 | } else { |
||
| 157 | //plugin is installed |
||
| 158 | return true; |
||
| 159 | } |
||
| 160 | } |
||
| 161 | |||
| 162 | public static function getPluginVersion (string $plugin_name, array $installed_plugins = array()) { |
||
| 163 | if (empty($installed_plugins)) { |
||
| 164 | $installed_plugins = Plugins::listInstalledPlugins(); |
||
| 165 | } |
||
| 166 | |||
| 167 | if (!isset($installed_plugins[$plugin_name])) { |
||
| 168 | //plugin is not installed |
||
| 169 | return false; |
||
| 170 | } else { |
||
| 171 | //plugin is installed, return installed version |
||
| 172 | $plugin = Plugin::castPlugin($installed_plugins[$plugin_name]); |
||
| 173 | return $plugin->getInstalledVersion(); |
||
| 174 | } |
||
| 175 | } |
||
| 176 | |||
| 177 | protected function checkVersion (string $expected_version, $current_version) : bool { |
||
| 223 | } |
||
| 224 | } |
||
| 225 | } |
||
| 226 | |||
| 227 | public function install () : bool { |
||
| 228 | //first, check compatibility |
||
| 229 | if (!$this->checkRequirements()) { |
||
| 230 | return false; |
||
| 231 | } |
||
| 232 | |||
| 233 | //check, if plugin is already installed |
||
| 234 | if ($this->plugin->isInstalled()) { |
||
| 235 | return false; |
||
| 236 | } |
||
| 237 | |||
| 238 | //check, if install.json is used |
||
| 239 | if ($this->plugin->hasInstallJson()) { |
||
| 240 | //check, if install.json exists |
||
| 241 | if (!file_exists($this->plugin->getPath() . "install.json")) { |
||
| 242 | throw new IllegalStateException("plugin '" . $this->plugin->getName() . "' requires a install.json, but plugin directory doesnt contains a install.json file."); |
||
| 243 | } |
||
| 244 | |||
| 245 | //get content |
||
| 246 | $install_json = json_decode(file_get_contents($this->plugin->getPath() . "install.json"), true); |
||
| 247 | |||
| 248 | $installer_plugins = self::listInstallerPlugins(); |
||
| 249 | |||
| 250 | foreach ($installer_plugins as $i_plugin) { |
||
| 251 | //cast plugin |
||
| 252 | $i_plugin = PluginInstaller_Plugin::cast($i_plugin); |
||
| 253 | |||
| 254 | //execute installer plugin |
||
| 255 | $i_plugin->install($this->plugin, $install_json); |
||
| 256 | } |
||
| 257 | |||
| 258 | if (isset($install_json['install_script'])) { |
||
| 259 | $script_filename = $install_json['install_script']; |
||
| 260 | $script_path = $this->plugin->getPath() . $script_filename; |
||
| 261 | |||
| 262 | //execute script, if exists |
||
| 263 | if (file_exists($script_path)) { |
||
| 264 | require($script_path); |
||
| 265 | } else { |
||
| 266 | throw new IllegalStateException("a install script '" . $script_filename . "' is set for plugin '" . $this->plugin->getName() . "', but file doesnt exists (path: " . $script_path . ")."); |
||
| 267 | } |
||
| 268 | } |
||
| 269 | } |
||
| 270 | |||
| 271 | //set plugin as installed |
||
| 272 | $this->setInstalled(); |
||
| 273 | |||
| 274 | //clear cache |
||
| 275 | Cache::clear(); |
||
| 276 | |||
| 277 | return true; |
||
| 278 | } |
||
| 279 | |||
| 280 | public function uninstall () : bool { |
||
| 281 | //check, if install.json is used |
||
| 282 | if ($this->plugin->hasInstallJson()) { |
||
| 283 | //check, if install.json exists |
||
| 284 | if (!file_exists($this->plugin->getPath() . "install.json")) { |
||
| 285 | throw new IllegalStateException("plugin '" . $this->plugin->getName() . "' requires a install.json, but plugin directory doesnt contains a install.json file."); |
||
| 286 | } |
||
| 287 | |||
| 288 | //get content |
||
| 289 | $install_json = json_decode(file_get_contents($this->plugin->getPath() . "install.json"), true); |
||
| 290 | |||
| 291 | $installer_plugins = self::listInstallerPlugins(); |
||
| 292 | |||
| 293 | foreach ($installer_plugins as $i_plugin) { |
||
| 294 | //cast plugin |
||
| 295 | $i_plugin = PluginInstaller_Plugin::cast($i_plugin); |
||
| 296 | |||
| 297 | //execute installer plugin |
||
| 298 | $i_plugin->uninstall($this->plugin, $install_json); |
||
| 299 | } |
||
| 300 | |||
| 301 | if (isset($install_json['uninstall_script'])) { |
||
| 302 | $script_filename = $install_json['uninstall_script']; |
||
| 303 | $script_path = $this->plugin->getPath() . $script_filename; |
||
| 304 | |||
| 305 | //execute script, if exists |
||
| 306 | if (file_exists($script_path)) { |
||
| 307 | require($script_path); |
||
| 308 | } else { |
||
| 309 | throw new IllegalStateException("a uninstall script '" . $script_filename . "' is set for plugin '" . $this->plugin->getName() . "', but file doesnt exists (path: " . $script_path . ")."); |
||
| 310 | } |
||
| 311 | } |
||
| 312 | } |
||
| 313 | |||
| 314 | //set plugin as uninstalled |
||
| 315 | $this->setUnInstalled(); |
||
| 316 | |||
| 317 | //clear cache |
||
| 318 | Cache::clear(); |
||
| 319 | |||
| 320 | return true; |
||
| 321 | } |
||
| 322 | |||
| 323 | public function upgrade () { |
||
| 324 | throw new Exception("UnuspportedOperationException: method PluginInstaller::upgrade() isnt implemented yet."); |
||
| 325 | } |
||
| 326 | |||
| 327 | public function setInstalled () { |
||
| 328 | Database::getInstance()->execute("INSERT INTO `{praefix}plugins` ( |
||
| 329 | `name`, `version`, `installed`, `activated` |
||
| 330 | ) VALUES ( |
||
| 331 | :name, :version, :installed, :activated |
||
| 332 | ) ON DUPLICATE KEY UPDATE `installed` = '1', `version` = :version; ", array( |
||
| 333 | 'name' => $this->plugin->getName(), |
||
| 334 | 'version' => $this->plugin->getVersion(), |
||
| 335 | 'installed' => 1, |
||
| 336 | 'activated' => 0 |
||
| 337 | )); |
||
| 338 | |||
| 339 | //clear cache |
||
| 340 | Plugins::clearCache(); |
||
| 341 | } |
||
| 342 | |||
| 343 | public function setUnInstalled () { |
||
| 344 | Database::getInstance()->execute("DELETE FROM `{praefix}plugins` WHERE `name` = :name; ", array( |
||
| 345 | 'name' => $this->plugin->getName() |
||
| 346 | )); |
||
| 347 | |||
| 348 | //clear cache |
||
| 349 | Plugins::clearCache(); |
||
| 350 | } |
||
| 351 | |||
| 352 | public static function listInstallerPlugins () : array { |
||
| 353 | $rows = array(); |
||
| 354 | |||
| 355 | if (Cache::contains("plugins", "installer_plugins")) { |
||
| 356 | $rows = Cache::get("plugins", "installer_plugins"); |
||
| 357 | } else { |
||
| 358 | $rows = Database::getInstance()->listRows("SELECT * FROM `{praefix}plugin_installer_plugins`; "); |
||
| 359 | |||
| 360 | //put into cache |
||
| 361 | Cache::put("plugins", "installer_plugins", $rows); |
||
| 362 | } |
||
| 363 | |||
| 364 | $plugins = array(); |
||
| 365 | |||
| 366 | foreach ($rows as $row) { |
||
| 367 | $class_name = $row['class_name']; |
||
| 368 | $path = $row['path']; |
||
| 369 | |||
| 370 | //first, include path |
||
| 371 | require_once(ROOT_PATH . $path); |
||
| 372 | |||
| 373 | //create object |
||
| 374 | $obj = new $class_name(); |
||
| 375 | |||
| 376 | //check, if object extends PluginInstaller_Plugin |
||
| 377 | if ($obj instanceof PluginInstaller_Plugin) { |
||
| 378 | //add plugin to list |
||
| 379 | $plugins[] = $obj; |
||
| 380 | } |
||
| 381 | } |
||
| 382 | |||
| 383 | //sort list |
||
| 384 | usort($plugins, function(PluginInstaller_Plugin $a, PluginInstaller_Plugin $b) { |
||
| 385 | return $a->getPriority() <=> $b->getPriority(); |
||
| 386 | }); |
||
| 387 | |||
| 388 | return $plugins; |
||
| 389 | } |
||
| 390 | |||
| 391 | public static function addInstallerPluginIfAbsent (string $class_name, string $path) { |
||
| 392 | Database::getInstance()->execute("INSERT INTO `{praefix}plugin_installer_plugins` ( |
||
| 393 | `class_name`, `path` |
||
| 394 | ) VALUES ( |
||
| 395 | :class_name, :path |
||
| 396 | ) ON DUPLICATE KEY UPDATE `path` = :path; ", array( |
||
| 397 | 'class_name' => $class_name, |
||
| 398 | 'path' => $path |
||
| 399 | )); |
||
| 400 | |||
| 401 | //clear cache |
||
| 402 | Cache::clear("plugins", "installer_plugins"); |
||
| 403 | } |
||
| 404 | |||
| 405 | public static function removeInstallerPlugin (string $class_name) { |
||
| 412 | } |
||
| 413 | |||
| 414 | } |
||
| 415 | |||
| 416 | ?> |
||
| 417 |