SYSTEM_KDです。
久々のブログ更新です。
今回は、誰向けなのか不明な、EC-CUBE４系でオーナーズストアからインストールしたプラグインを独自アップデートを行う方法です。
オーナーズストアからインストールしたプラグインのアップデートは簡単には行えない
オーナーズストアからプラグインのインストールを行うと、基本的にはプラグインのアップデートはオーナーズストア経由でしか行なえません。
特に問題はないのですが、バグってて今すぐ修正できるパッチを用意しておきたい場合や、独自のカスタマイズを適用したいと言う場合には、差分ファイルを手動適用するということでしか対応できません。
（もしや、ec-cube.coは手動適用もできないんじゃないかな・・）
EC-CUBE3系までのプラグインは、オーナーズストアのマイページからダウンロードできるので、独自プラグインとしてインストールすれば、そっち側でアップデートが可能。 ってそんな使い方はやらないですかね。
まぁ、そんなこんなで４系はアップデートしたいときの回避策がないという不安を解消するために、アップデートする策を考えました。
その策とは・・・
独自プラグインをインストールし、そのプラグインでオーナーズストアからインストールしたプラグインをアップデート
ドン！（大した策じゃない
４系でも、独自プラグインのインストールできるので、そっち側から「オーナーズストアのプラグイン」の方を更新してしまうという作戦です。
と言っても、既にオーナーズストアでインストールされているものを、独自プラグインでインストールしようとしても、それは行えません。
流れとしては、アップデートしたいプラグインの、アップデート後のプラグイン（tar.gz）を含めたプラグインを、独自プラグインとして用意。
そのプラグインをインストールし、有効化する際の処理で、（保持しているプラグインファイルを用いて）独自アップデートしてしまうというものです。
（説明下手くそ）
まぁ、こんなイメージ。
で、コードの方は、
namespace Plugin\PlgPatch; // 環境に合わせて変更
use Eccube\Entity\Plugin;
use Eccube\Exception\PluginException;
use Eccube\Plugin\AbstractPluginManager;
use Eccube\Repository\PluginRepository;
use Eccube\Service\PluginService;
use Eccube\Util\CacheUtil;
use Eccube\Util\StringUtil;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Finder\Finder;
class PluginManager extends AbstractPluginManager
{
/** @var PluginRepository */
protected $pluginRepository;
/** @var CacheUtil */
protected $cacheUtil;
/** @var PluginService */
protected $pluginService;
private $upFileName;
private $plgCode;
private const PLG_PATH = __DIR__ . '/Resource/upfile/';
/**
* @param array $meta
* @param ContainerInterface $container
* @throws PluginException
*/
public function enable(array $meta, ContainerInterface $container)
{
log_info('[PlgPatch]パッチ適用開始');
$this->initialize($container);
log_info('[PlgPatch]更新対象プラグインの存在チェック開始');
$Plugin = $this->getPlugin();
log_info('[PlgPatch]更新対象プラグインの存在チェック終了');
// プラグインの手動アップデート
$this->plgManualUpdate($Plugin);
log_info('[PlgPatch]パッチ適用完了');
}
/**
* @param ContainerInterface $container
*/
private function initialize(ContainerInterface $container)
{
$this->pluginRepository = $container->get(PluginRepository::class);
$this->cacheUtil = $container->get(CacheUtil::class);
$this->pluginService = $container->get(PluginService::class);
$finder = Finder::create()
->in(self::PLG_PATH)
->files();
/** @var \SplFileInfo $item */
foreach ($finder as $item) {
$this->upFileName = $item->getFilename();
$fileName = explode(".", $item->getFilename());
$this->plgCode = $fileName[0];
}
}
/**
* @param string $plgCode
* @return Plugin
* @throws PluginException
*/
private function getPlugin($plgCode = "")
{
if (empty($plgCode)) {
$plgCode = $this->plgCode;
}
/** @var Plugin $Plugin */
$Plugin = $this->pluginRepository->findOneBy(['code' => $plgCode]);
if (!$Plugin) {
log_error("[PlgPatch]更新対象プラグインがインストールされていません。");
throw new PluginException("[PlgPatch]更新対象プラグインがインストールされていません。");
}
return $Plugin;
}
/**
* @param Plugin $Plugin
* @param string $upFileName
* @throws PluginException
*/
private function plgManualUpdate(Plugin $Plugin, $upFileName = "")
{
$fs = new Filesystem();
if ($upFileName == "") {
$upFileName = $this->upFileName;
}
$upFilePath = self::PLG_PATH . $upFileName;
/** @var CacheUtil $cacheUtil */
$cacheUtil = $this->cacheUtil;
/** @var PluginService $pluginService */
$pluginService = $this->pluginService;
// ファイル配置
$tmpDir = null;
try {
$cacheUtil->clearCache();
$tmpDir = $pluginService->createTempDir();
$tmpFile = sha1(StringUtil::random(32)) . '.tar.gz';
log_info('[PlgPatch]プラグインファイルコピー開始', [
'origin' => $upFilePath,
'target' => $tmpDir . '/' . $tmpFile,
]);
$fs->copy($upFilePath, $tmpDir . '/' . $tmpFile, true);
log_info('[PlgPatch]プラグインファイルコピー完了');
log_info('[PlgPatch]Update', [$Plugin]);
$pluginService->update($Plugin, $tmpDir . '/' . $tmpFile);
log_info('[PlgPatch]一時ディレクトリから削除', [$tmpDir]);
$fs->remove($tmpDir);
log_info('[PlgPatch]一時ディレクトリから削除完了');
return;
} catch (PluginException $e) {
if (!empty($tmpDir) && file_exists($tmpDir)) {
$fs = new Filesystem();
$fs->remove($tmpDir);
}
$message = $e->getMessage();
log_error('[PlgPatch]' . $message);
throw $e;
} catch (\Exception $er) {
// Catch composer install error | Other error
if (!empty($tmpDir) && file_exists($tmpDir)) {
$fs = new Filesystem();
$fs->remove($tmpDir);
}
log_error('plugin install failed.', ['original-message' => $er->getMessage()]);
throw $er;
}
}
}
主要部分を全部はっつけてみた。
（わりと多かった・・・githubにするべきだったか）
普通にプラグインを作成する要領で、composer.json を用意して、上記コードをPluginManager.phpとして配置。
Resource/upfile にアップデートを行いたいプラグインを[プラグインコード].tar.tz のファイル名で配置すればOK.
独自プラグインとして、インストールした後、有効化を行うと Resource/upfile に格納したプラグインでアップデートされます。
（※複数は未対応）
注意点
上記で、そこそこ上手く更新できると思いますが、注意点がいくつかあります。
1. ファイルは上書きで配置される
もとのプラグインファイルに対して、更新用プラグインが上書きされます。
ファイルの置き換えのみであれば、問題ないのですがファイルを削除している場合は消えてくれないので注意。
2. スキーマがアップデートされない
次期バージョン(4.0.4）で解決されるはずですが、4.0.3までは独自プラグインのアップデートでは、スキーマ更新されないので、テーブルに変更を行った場合このアップデートだけでは反映されません。
残念・・・
といいつつ、これは対応策があります。
更新用に独自プラグインとしてインストールしたプラグインをアンインストールするだけです。
プラグインのアンインストールを実施すると、スキーマアップデートが流れてくれるので、その処理の巻き添え（良い意味で）でアップデートされます。
更新用プラグインは、アップデートが終わると必要ないですし、アンインストールまでが一連の更新処理ということで。
３．バージョンは変えない方が良い
アップデート対象のプラグインのバージョンを変えてしまうと、次のアップデートできちんとアップデートされない可能性があるので、アップデート対象プラグインのバージョン番号は変えずに、プラグイン名に、変更版である旨を追記するのが良いです。
以上。
