EC-CUBE /
ec-cube
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 PluginService 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 PluginService, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 30 | class PluginService |
||
| 31 | { |
||
| 32 | /** |
||
| 33 | * @var EccubeConfig |
||
| 34 | */ |
||
| 35 | protected $eccubeConfig; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * @var EntityManager |
||
| 39 | */ |
||
| 40 | protected $entityManager; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * @var PluginRepository |
||
| 44 | */ |
||
| 45 | protected $pluginRepository; |
||
| 46 | |||
| 47 | /** |
||
| 48 | * @var EntityProxyService |
||
| 49 | */ |
||
| 50 | protected $entityProxyService; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * @var SchemaService |
||
| 54 | */ |
||
| 55 | protected $schemaService; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * @var ComposerServiceInterface |
||
| 59 | */ |
||
| 60 | protected $composerService; |
||
| 61 | |||
| 62 | const VENDOR_NAME = 'ec-cube'; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * Plugin type/library of ec-cube |
||
| 66 | */ |
||
| 67 | const ECCUBE_LIBRARY = 1; |
||
| 68 | |||
| 69 | /** |
||
| 70 | * Plugin type/library of other (except ec-cube) |
||
| 71 | */ |
||
| 72 | const OTHER_LIBRARY = 2; |
||
| 73 | |||
| 74 | /** |
||
| 75 | * @var string %kernel.project_dir% |
||
| 76 | */ |
||
| 77 | private $projectRoot; |
||
| 78 | |||
| 79 | /** |
||
| 80 | * @var string %kernel.environment% |
||
| 81 | */ |
||
| 82 | private $environment; |
||
| 83 | |||
| 84 | /** |
||
| 85 | * @var ContainerInterface |
||
| 86 | */ |
||
| 87 | protected $container; |
||
| 88 | |||
| 89 | /** @var CacheUtil */ |
||
| 90 | protected $cacheUtil; |
||
| 91 | |||
| 92 | /** |
||
| 93 | * @var PluginApiService |
||
| 94 | */ |
||
| 95 | private $pluginApiService; |
||
| 96 | |||
| 97 | /** |
||
| 98 | * PluginService constructor. |
||
| 99 | * |
||
| 100 | * @param EntityManagerInterface $entityManager |
||
| 101 | * @param PluginRepository $pluginRepository |
||
| 102 | * @param EntityProxyService $entityProxyService |
||
| 103 | * @param SchemaService $schemaService |
||
| 104 | * @param EccubeConfig $eccubeConfig |
||
| 105 | * @param ContainerInterface $container |
||
| 106 | * @param CacheUtil $cacheUtil |
||
| 107 | * @param ComposerServiceInterface $composerService |
||
| 108 | * @param PluginApiService $pluginApiService |
||
| 109 | */ |
||
| 110 | public function __construct( |
||
| 111 | EntityManagerInterface $entityManager, |
||
| 112 | PluginRepository $pluginRepository, |
||
| 113 | EntityProxyService $entityProxyService, |
||
| 114 | SchemaService $schemaService, |
||
| 115 | EccubeConfig $eccubeConfig, |
||
| 116 | ContainerInterface $container, |
||
| 117 | CacheUtil $cacheUtil, |
||
| 118 | ComposerServiceInterface $composerService, |
||
| 119 | PluginApiService $pluginApiService |
||
| 120 | 1 | ) { |
|
| 121 | $this->entityManager = $entityManager; |
||
|
|
|||
| 122 | $this->pluginRepository = $pluginRepository; |
||
| 123 | $this->entityProxyService = $entityProxyService; |
||
| 124 | $this->schemaService = $schemaService; |
||
| 125 | $this->eccubeConfig = $eccubeConfig; |
||
| 126 | $this->projectRoot = $eccubeConfig->get('kernel.project_dir'); |
||
| 127 | $this->environment = $eccubeConfig->get('kernel.environment'); |
||
| 128 | $this->container = $container; |
||
| 129 | $this->cacheUtil = $cacheUtil; |
||
| 130 | 1 | $this->composerService = $composerService; |
|
| 131 | 1 | $this->pluginApiService = $pluginApiService; |
|
| 132 | 1 | } |
|
| 133 | 1 | ||
| 134 | 1 | /** |
|
| 135 | 1 | * ファイル指定してのプラグインインストール |
|
| 136 | 1 | * |
|
| 137 | 1 | * @param string $path path to tar.gz/zip plugin file |
|
| 138 | 1 | * @param int $source |
|
| 139 | 1 | * |
|
| 140 | * @return boolean |
||
| 141 | * |
||
| 142 | * @throws PluginException |
||
| 143 | * @throws \Exception |
||
| 144 | */ |
||
| 145 | public function install($path, $source = 0) |
||
| 146 | { |
||
| 147 | $pluginBaseDir = null; |
||
| 148 | $tmp = null; |
||
| 149 | try { |
||
| 150 | // プラグイン配置前に実施する処理 |
||
| 151 | $this->preInstall(); |
||
| 152 | $tmp = $this->createTempDir(); |
||
| 153 | 1 | ||
| 154 | // 一旦テンポラリに展開 |
||
| 155 | 1 | $this->unpackPluginArchive($path, $tmp); |
|
| 156 | 1 | $this->checkPluginArchiveContent($tmp); |
|
| 157 | |||
| 158 | $config = $this->readConfig($tmp); |
||
| 159 | 1 | // テンポラリのファイルを削除 |
|
| 160 | 1 | $this->deleteFile($tmp); |
|
| 161 | |||
| 162 | // 重複していないかチェック |
||
| 163 | 1 | $this->checkSamePlugin($config['code']); |
|
| 164 | 1 | ||
| 165 | $pluginBaseDir = $this->calcPluginDir($config['code']); |
||
| 166 | 1 | // 本来の置き場所を作成 |
|
| 167 | 1 | $this->createPluginDir($pluginBaseDir); |
|
| 168 | |||
| 169 | 1 | // 問題なければ本当のplugindirへ |
|
| 170 | $this->unpackPluginArchive($path, $pluginBaseDir); |
||
| 171 | |||
| 172 | 1 | // Check dependent plugin |
|
| 173 | // Don't install ec-cube library |
||
| 174 | 1 | // $dependents = $this->getDependentByCode($config['code'], self::OTHER_LIBRARY); |
|
| 175 | // if (!empty($dependents)) { |
||
| 176 | 1 | // $package = $this->parseToComposerCommand($dependents); |
|
| 177 | //FIXME: how to working with ComposerProcessService or ComposerApiService ? |
||
| 178 | // $this->composerService->execRequire($package); |
||
| 179 | 1 | // } |
|
| 180 | // リソースファイルをコピー |
||
| 181 | $this->copyAssets($config['code']); |
||
| 182 | // プラグイン配置後に実施する処理 |
||
| 183 | $this->postInstall($config, $source); |
||
| 184 | } catch (PluginException $e) { |
||
| 185 | $this->deleteDirs([$tmp, $pluginBaseDir]); |
||
| 186 | throw $e; |
||
| 187 | } catch (\Exception $e) { |
||
| 188 | // インストーラがどんなExceptionを上げるかわからないので |
||
| 189 | $this->deleteDirs([$tmp, $pluginBaseDir]); |
||
| 190 | throw $e; |
||
| 191 | 1 | } |
|
| 192 | |||
| 193 | return true; |
||
| 194 | 1 | } |
|
| 195 | 1 | ||
| 196 | 1 | /** |
|
| 197 | * @param $code string sプラグインコード |
||
| 198 | * |
||
| 199 | * @throws PluginException |
||
| 200 | */ |
||
| 201 | public function installWithCode($code) |
||
| 202 | { |
||
| 203 | $pluginDir = $this->calcPluginDir($code); |
||
| 204 | $this->checkPluginArchiveContent($pluginDir); |
||
| 205 | $config = $this->readConfig($pluginDir); |
||
| 206 | |||
| 207 | if (isset($config['source']) && $config['source']) { |
||
| 208 | // 依存プラグインが有効になっていない場合はエラー |
||
| 209 | $requires = $this->getPluginRequired($config); |
||
| 210 | View Code Duplication | $notInstalledOrDisabled = array_filter($requires, function ($req) { |
|
| 211 | $code = preg_replace('/^ec-cube\//', '', $req['name']); |
||
| 212 | /** @var Plugin $DependPlugin */ |
||
| 213 | $DependPlugin = $this->pluginRepository->findOneBy(['code' => $code]); |
||
| 214 | |||
| 215 | 1 | return $DependPlugin ? $DependPlugin->isEnabled() == false : true; |
|
| 216 | }); |
||
| 217 | |||
| 218 | if (!empty($notInstalledOrDisabled)) { |
||
| 219 | 1 | $names = array_map(function ($p) { return $p['name']; }, $notInstalledOrDisabled); |
|
| 220 | 1 | throw new PluginException(implode(', ', $names).'を有効化してください。'); |
|
| 221 | } |
||
| 222 | } |
||
| 223 | |||
| 224 | 1 | $this->checkSamePlugin($config['code']); |
|
| 225 | $this->copyAssets($config['code']); |
||
| 226 | $this->postInstall($config, $config['source']); |
||
| 227 | } |
||
| 228 | |||
| 229 | // インストール事前処理 |
||
| 230 | public function preInstall() |
||
| 231 | { |
||
| 232 | // キャッシュの削除 |
||
| 233 | // FIXME: Please fix clearCache function (because it's clear all cache and this file just upload) |
||
| 234 | // $this->cacheUtil->clearCache(); |
||
| 235 | } |
||
| 236 | |||
| 237 | // インストール事後処理 |
||
| 238 | public function postInstall($config, $source) |
||
| 239 | { |
||
| 240 | // dbにプラグイン登録 |
||
| 241 | 1 | ||
| 242 | $this->entityManager->getConnection()->beginTransaction(); |
||
| 243 | |||
| 244 | 1 | try { |
|
| 245 | $Plugin = $this->pluginRepository->findByCode($config['code']); |
||
| 246 | |||
| 247 | if (!$Plugin) { |
||
| 248 | $Plugin = new Plugin(); |
||
| 249 | // インストール直後はプラグインは有効にしない |
||
| 250 | 1 | $Plugin->setName($config['name']) |
|
| 251 | 1 | ->setEnabled(false) |
|
| 252 | 1 | ->setVersion($config['version']) |
|
| 253 | ->setSource($source) |
||
| 254 | 1 | ->setCode($config['code']); |
|
| 255 | $this->entityManager->persist($Plugin); |
||
| 256 | $this->entityManager->flush(); |
||
| 257 | } |
||
| 258 | 1 | ||
| 259 | $this->generateProxyAndUpdateSchema($Plugin, $config); |
||
| 260 | |||
| 261 | $this->callPluginManagerMethod($config, 'install'); |
||
| 262 | |||
| 263 | 1 | $Plugin->setInitialized(true); |
|
| 264 | 1 | $this->entityManager->persist($Plugin); |
|
| 265 | 1 | $this->entityManager->flush(); |
|
| 266 | 1 | ||
| 267 | $this->entityManager->flush(); |
||
| 268 | $this->entityManager->getConnection()->commit(); |
||
| 269 | } catch (\Exception $e) { |
||
| 270 | $this->entityManager->getConnection()->rollback(); |
||
| 271 | throw new PluginException($e->getMessage(), $e->getCode(), $e); |
||
| 272 | } |
||
| 273 | } |
||
| 274 | |||
| 275 | public function generateProxyAndUpdateSchema(Plugin $plugin, $config, $uninstall = false) |
||
| 276 | { |
||
| 277 | if ($plugin->isEnabled()) { |
||
| 278 | $generatedFiles = $this->regenerateProxy($plugin, false); |
||
| 279 | 1 | $this->schemaService->updateSchema($generatedFiles, $this->projectRoot.'/app/proxy/entity'); |
|
| 280 | } else { |
||
| 281 | 1 | // Proxyのクラスをロードせずにスキーマを更新するために、 |
|
| 282 | // インストール時には一時的なディレクトリにProxyを生成する |
||
| 283 | $tmpProxyOutputDir = sys_get_temp_dir().'/proxy_'.StringUtil::random(12); |
||
| 284 | @mkdir($tmpProxyOutputDir); |
||
| 285 | |||
| 286 | try { |
||
| 287 | 1 | if (!$uninstall) { |
|
| 288 | 1 | // プラグインmetadata定義を追加 |
|
| 289 | $entityDir = $this->eccubeConfig['plugin_realdir'].'/'.$plugin->getCode().'/Entity'; |
||
| 290 | if (file_exists($entityDir)) { |
||
| 291 | $ormConfig = $this->entityManager->getConfiguration(); |
||
| 292 | $chain = $ormConfig->getMetadataDriverImpl(); |
||
| 293 | $driver = $ormConfig->newDefaultAnnotationDriver([$entityDir], false); |
||
| 294 | $namespace = 'Plugin\\'.$config['code'].'\\Entity'; |
||
| 295 | $chain->addDriver($driver, $namespace); |
||
| 296 | $ormConfig->addEntityNamespace($plugin->getCode(), $namespace); |
||
| 297 | } |
||
| 298 | } |
||
| 299 | |||
| 300 | // 一時的に利用するProxyを生成してからスキーマを更新する |
||
| 301 | $generatedFiles = $this->regenerateProxy($plugin, true, $tmpProxyOutputDir, $uninstall); |
||
| 302 | $this->schemaService->updateSchema($generatedFiles, $tmpProxyOutputDir); |
||
| 303 | } finally { |
||
| 304 | 1 | foreach (glob("${tmpProxyOutputDir}/*") as $f) { |
|
| 305 | unlink($f); |
||
| 306 | } |
||
| 307 | 1 | rmdir($tmpProxyOutputDir); |
|
| 308 | } |
||
| 309 | } |
||
| 310 | } |
||
| 311 | |||
| 312 | public function createTempDir() |
||
| 324 | |||
| 325 | public function deleteDirs($arr) |
||
| 334 | |||
| 335 | 1 | /** |
|
| 336 | * @param string $archive |
||
| 337 | * @param string $dir |
||
| 338 | * |
||
| 339 | * @throws PluginException |
||
| 340 | */ |
||
| 341 | public function unpackPluginArchive($archive, $dir) |
||
| 358 | |||
| 359 | /** |
||
| 360 | * @param $dir |
||
| 361 | * @param array $config_cache |
||
| 362 | * |
||
| 363 | * @throws PluginException |
||
| 364 | */ |
||
| 365 | public function checkPluginArchiveContent($dir, array $config_cache = []) |
||
| 392 | 1 | ||
| 393 | /** |
||
| 394 | * @param $pluginDir |
||
| 395 | * |
||
| 396 | * @return array |
||
| 397 | * |
||
| 398 | * @throws PluginException |
||
| 399 | */ |
||
| 400 | public function readConfig($pluginDir) |
||
| 427 | |||
| 428 | public function checkSymbolName($string) |
||
| 435 | |||
| 436 | /** |
||
| 437 | * @param string $path |
||
| 438 | */ |
||
| 439 | public function deleteFile($path) |
||
| 444 | 1 | ||
| 445 | public function checkSamePlugin($code) |
||
| 453 | |||
| 454 | public function calcPluginDir($code) |
||
| 458 | |||
| 459 | /** |
||
| 460 | * @param string $d |
||
| 461 | * |
||
| 462 | * @throws PluginException |
||
| 463 | */ |
||
| 464 | 1 | public function createPluginDir($d) |
|
| 471 | |||
| 472 | /** |
||
| 473 | * @param $meta |
||
| 474 | * @param int $source |
||
| 475 | * |
||
| 476 | * @return Plugin |
||
| 477 | * |
||
| 478 | * @throws PluginException |
||
| 479 | */ |
||
| 480 | public function registerPlugin($meta, $source = 0) |
||
| 501 | |||
| 502 | /** |
||
| 503 | * @param $meta |
||
| 504 | * @param string $method |
||
| 505 | */ |
||
| 506 | public function callPluginManagerMethod($meta, $method) |
||
| 516 | |||
| 517 | /** |
||
| 518 | * @param Plugin $plugin |
||
| 519 | * @param bool $force |
||
| 520 | * |
||
| 521 | * @return bool |
||
| 522 | * |
||
| 523 | * @throws \Exception |
||
| 524 | */ |
||
| 525 | public function uninstall(Plugin $plugin, $force = true) |
||
| 557 | |||
| 558 | public function unregisterPlugin(Plugin $p) |
||
| 568 | |||
| 569 | public function disable(Plugin $plugin) |
||
| 573 | |||
| 574 | /** |
||
| 575 | * Proxyを再生成します. |
||
| 576 | * |
||
| 577 | * @param Plugin $plugin プラグイン |
||
| 578 | * @param boolean $temporary プラグインが無効状態でも一時的に生成するかどうか |
||
| 579 | * @param string|null $outputDir 出力先 |
||
| 580 | * @param bool $uninstall プラグイン削除の場合はtrue |
||
| 581 | * |
||
| 582 | * @return array 生成されたファイルのパス |
||
| 583 | */ |
||
| 584 | private function regenerateProxy(Plugin $plugin, $temporary, $outputDir = null, $uninstall = false) |
||
| 617 | |||
| 618 | public function enable(Plugin $plugin, $enable = true) |
||
| 648 | |||
| 649 | /** |
||
| 650 | * Update plugin |
||
| 651 | * |
||
| 652 | * @param Plugin $plugin |
||
| 653 | * @param string $path |
||
| 654 | * |
||
| 655 | * @return bool |
||
| 656 | * |
||
| 657 | * @throws PluginException |
||
| 658 | * @throws \Exception |
||
| 659 | */ |
||
| 660 | public function update(Plugin $plugin, $path) |
||
| 703 | |||
| 704 | /** |
||
| 705 | * Update plugin |
||
| 706 | * |
||
| 707 | * @param Plugin $plugin |
||
| 708 | * @param array $meta Config data |
||
| 709 | * |
||
| 710 | * @throws \Exception |
||
| 711 | */ |
||
| 712 | public function updatePlugin(Plugin $plugin, $meta) |
||
| 733 | |||
| 734 | /** |
||
| 735 | * Get array require by plugin |
||
| 736 | * Todo: need define dependency plugin mechanism |
||
| 737 | * |
||
| 738 | * @param array|Plugin $plugin format as plugin from api |
||
| 739 | * |
||
| 740 | * @return array|mixed |
||
| 741 | * |
||
| 742 | * @throws PluginException |
||
| 743 | */ |
||
| 744 | public function getPluginRequired($plugin) |
||
| 757 | |||
| 758 | /** |
||
| 759 | * Find the dependent plugins that need to be disabled |
||
| 760 | * |
||
| 761 | * @param string $pluginCode |
||
| 762 | * |
||
| 763 | * @return array plugin code |
||
| 764 | */ |
||
| 765 | public function findDependentPluginNeedDisable($pluginCode) |
||
| 769 | |||
| 770 | /** |
||
| 771 | * Find the other plugin that has requires on it. |
||
| 772 | * Check in both dtb_plugin table and <PluginCode>/composer.json |
||
| 773 | * |
||
| 774 | * @param string $pluginCode |
||
| 775 | * @param bool $enableOnly |
||
| 776 | * |
||
| 777 | * @return array plugin code |
||
| 778 | */ |
||
| 779 | public function findDependentPlugin($pluginCode, $enableOnly = false) |
||
| 811 | |||
| 812 | /** |
||
| 813 | * Get dependent plugin by code |
||
| 814 | * It's base on composer.json |
||
| 815 | * Return the plugin code and version in the format of the composer |
||
| 816 | * |
||
| 817 | * @param string $pluginCode |
||
| 818 | * @param int|null $libraryType |
||
| 819 | * self::ECCUBE_LIBRARY only return library/plugin of eccube |
||
| 820 | * self::OTHER_LIBRARY only return library/plugin of 3rd part ex: symfony, composer, ... |
||
| 821 | * default : return all library/plugin |
||
| 822 | * |
||
| 823 | * @return array format [packageName1 => version1, packageName2 => version2] |
||
| 824 | */ |
||
| 825 | public function getDependentByCode($pluginCode, $libraryType = null) |
||
| 854 | |||
| 855 | /** |
||
| 856 | * Format array dependent plugin to string |
||
| 857 | * It is used for commands. |
||
| 858 | * |
||
| 859 | * @param array $packages format [packageName1 => version1, packageName2 => version2] |
||
| 860 | * @param bool $getVersion |
||
| 861 | * |
||
| 862 | * @return string format if version=true: "packageName1:version1 packageName2:version2", if version=false: "packageName1 packageName2" |
||
| 863 | */ |
||
| 864 | public function parseToComposerCommand(array $packages, $getVersion = true) |
||
| 875 | |||
| 876 | /** |
||
| 877 | * リソースファイル等をコピー |
||
| 878 | * コピー元となるファイルの置き場所は固定であり、 |
||
| 879 | * [プラグインコード]/Resource/assets |
||
| 880 | * 配下に置かれているファイルが所定の位置へコピーされる |
||
| 881 | * |
||
| 882 | * @param $pluginCode |
||
| 883 | */ |
||
| 884 | public function copyAssets($pluginCode) |
||
| 894 | |||
| 895 | /** |
||
| 896 | * コピーしたリソースファイル等を削除 |
||
| 897 | * |
||
| 898 | * @param string $pluginCode |
||
| 899 | */ |
||
| 900 | public function removeAssets($pluginCode) |
||
| 910 | |||
| 911 | /** |
||
| 912 | * Plugin is exist check |
||
| 913 | * |
||
| 914 | * @param array $plugins get from api |
||
| 915 | * @param string $pluginCode |
||
| 916 | * |
||
| 917 | * @return false|int|string |
||
| 918 | */ |
||
| 919 | public function checkPluginExist($plugins, $pluginCode) |
||
| 929 | |||
| 930 | /** |
||
| 931 | * @param string $code |
||
| 932 | * |
||
| 933 | * @return bool |
||
| 934 | */ |
||
| 935 | private function isEnable($code) |
||
| 947 | } |
||
| 948 |
Loading history...
Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly.
Either this assignment is in error or an instanceof check should be added for that assignment.