feat(admin): .env が反映されない環境で設定変更を警告・抑止する (#6130)

app/config/eccube/services.yaml

@@ -58,6 +58,10 @@ services:
         lazy: true
         public: true
 
+    Eccube\Service\EnvFileService:
+        arguments:
+            $projectDir: '%kernel.project_dir%'
+
     Eccube\Service\Composer\ComposerProcessService:
         lazy: true
 

src/Eccube/Controller/Admin/Setting/System/SecurityController.php

@@ -15,6 +15,7 @@
 
 use Eccube\Controller\AbstractController;
 use Eccube\Form\Type\Admin\SecurityType;
+use Eccube\Service\EnvFileService;
 use Eccube\Util\CacheUtil;
 use Eccube\Util\StringUtil;
 use Symfony\Bridge\Twig\Attribute\Template;
@@ -25,11 +26,27 @@
 
 class SecurityController extends AbstractController
 {
+    /**
+     * この画面が .env へ書き込む環境変数キー（OS 環境変数によるオーバーライド判定に使用）.
+     */
+    private const ENV_KEYS = [
+        'ECCUBE_FRONT_ALLOW_HOSTS',
+        'ECCUBE_FRONT_DENY_HOSTS',
+        'ECCUBE_ADMIN_ALLOW_HOSTS',
+        'ECCUBE_ADMIN_DENY_HOSTS',
+        'ECCUBE_FORCE_SSL',
+        'TRUSTED_HOSTS',
+        'ECCUBE_ADMIN_ROUTE',
+    ];
+
     /**
      * SecurityController constructor.
      */
-    public function __construct(protected TokenStorageInterface $tokenStorage, private readonly CacheUtil $cacheUtil)
-    {
+    public function __construct(
+        protected TokenStorageInterface $tokenStorage,
+        private readonly CacheUtil $cacheUtil,
+        private readonly EnvFileService $envFileService,
+    ) {
     }
 
     /**
@@ -44,8 +61,8 @@ public function index(Request $request): RedirectResponse|array
         $form->handleRequest($request);
 
         if ($form->isSubmitted() && $form->isValid()) {
-            // .envファイルが存在しないときに設定は失敗する
-            if (file_exists($this->getParameter('kernel.project_dir').'/.env') === false) {
+            // .env への書き込みが反映されない状況では保存を拒否する
+            if (!$this->envFileService->isEffective(self::ENV_KEYS)) {
                 $this->addError('admin.common.save_error', 'admin');
 
                 return $this->redirectToRoute('admin_setting_system_security');
@@ -115,13 +132,15 @@ public function index(Request $request): RedirectResponse|array
             $this->addWarning('admin.setting.system.security.admin_url_warning', 'admin');
         }
 
-        // .envファイルが存在しない場合警告を出す。
-        if (file_exists($this->getParameter('kernel.project_dir').'/.env') === false) {
-            $this->addWarning('admin.setting.system.security.not_found_env_file', 'admin');
+        // .env への書き込みが反映されない状況では警告を出し、登録ボタンを無効化する。
+        $ineffectiveReasons = $this->envFileService->getIneffectiveReasons(self::ENV_KEYS);
+        foreach ($ineffectiveReasons as $reason) {
+            $this->addWarning('admin.system.env.ineffective.'.$reason, 'admin');
         }
 
         return [
             'form' => $form->createView(),
+            'envWritable' => [] === $ineffectiveReasons,
         ];
     }
 }

src/Eccube/Controller/Admin/Store/TemplateController.php

@@ -18,6 +18,7 @@
 use Eccube\Form\Type\Admin\TemplateType;
 use Eccube\Repository\Master\DeviceTypeRepository;
 use Eccube\Repository\TemplateRepository;
+use Eccube\Service\EnvFileService;
 use Eccube\Util\CacheUtil;
 use Eccube\Util\StringUtil;
 use Symfony\Bridge\Twig\Attribute\Template;
@@ -33,10 +34,15 @@
 
 class TemplateController extends AbstractController
 {
+    /**
+     * この画面が .env へ書き込む環境変数キー（OS 環境変数によるオーバーライド判定に使用）.
+     */
+    private const ENV_KEYS = ['ECCUBE_TEMPLATE_CODE'];
+
     /**
      * TemplateController constructor.
      */
-    public function __construct(protected TemplateRepository $templateRepository, protected DeviceTypeRepository $deviceTypeRepository, private readonly CacheUtil $cacheUtil)
+    public function __construct(protected TemplateRepository $templateRepository, protected DeviceTypeRepository $deviceTypeRepository, private readonly CacheUtil $cacheUtil, private readonly EnvFileService $envFileService)
     {
     }
 
@@ -59,10 +65,20 @@ public function index(Request $request): array|RedirectResponse
         $form->handleRequest($request);
 
         if ($form->isSubmitted() && $form->isValid()) {
+            // .env への書き込みが反映されない状況では保存を拒否する
+            //   - .env が存在しない / 書き込み不可
+            //   - .env.local.php（dump-env の最適化済みスナップショット）が .env より優先される
+            //   - ECCUBE_TEMPLATE_CODE が OS のプロセス環境変数として設定され .env を上書きしている
+            if (!$this->envFileService->isEffective(self::ENV_KEYS)) {
+                $this->addError('admin.common.save_error', 'admin');
+
+                return $this->redirectToRoute('admin_store_template');
+            }
+
             $Template = $this->templateRepository->find($form['selected']->getData());
 
             $envFile = $this->getParameter('kernel.project_dir').'/.env';
-            $env = file_exists($envFile) ? file_get_contents($envFile) : '';
+            $env = file_get_contents($envFile);
 
             $env = StringUtil::replaceOrAddEnv($env, [
                 'ECCUBE_TEMPLATE_CODE' => $Template->getCode(),
@@ -72,33 +88,29 @@ public function index(Request $request): array|RedirectResponse
 
             $this->addSuccess('admin.common.save_complete', 'admin');
 
-            // 次のいずれかの場合、.env への書き込みが起動時のロードで反映されない:
-            //   1. ECCUBE_TEMPLATE_CODE がプロセス環境変数として設定されている（Docker などで明示的に設定した場合）。
-            //      bootEnv は OS 環境変数を上書きしないため .env の値が使われない。
-            //   2. .env.local.php（dump-env の最適化済みスナップショット）が存在する。
-            //      bootEnv は .env より .env.local.php を優先するため、再度 `composer symfony:dump-env` を
-            //      実行するまで .env の変更が反映されない。
-            $envLocalPhp = $this->getParameter('kernel.project_dir').'/.env.local.php';
-            if (false !== getenv('ECCUBE_TEMPLATE_CODE') || file_exists($envLocalPhp)) {
-                $this->addWarning('admin.store.template.env_override_warning', 'admin');
-            }
-
             $this->cacheUtil->clearCache();
 
             return $this->redirectToRoute('admin_store_template');
         }
 
+        // .env への書き込みが反映されない状況では警告を出し、登録ボタンを無効化する。
+        $ineffectiveReasons = $this->envFileService->getIneffectiveReasons(self::ENV_KEYS);
+        foreach ($ineffectiveReasons as $reason) {
+            $this->addWarning('admin.system.env.ineffective.'.$reason, 'admin');
+        }
+
         return [
             'form' => $form->createView(),
             'Templates' => $Templates,
+            'envWritable' => [] === $ineffectiveReasons,
         ];
     }
 
     /**
      * テンプレート一覧からのダウンロード
      */
     #[Route(path: '/%eccube_admin_route%/store/template/{id}/download', name: 'admin_store_template_download', requirements: ['id' => '\d+'], methods: ['GET'])]
-    public function download(Request $request, \Eccube\Entity\Template $Template): BinaryFileResponse
+    public function download(\Eccube\Entity\Template $Template): BinaryFileResponse
     {
         // 該当テンプレートのディレクトリ
         $templateCode = $Template->getCode();
@@ -155,7 +167,7 @@ public function download(Request $request, \Eccube\Entity\Template $Template): B
     }
 
     #[Route(path: '/%eccube_admin_route%/store/template/{id}/delete', name: 'admin_store_template_delete', requirements: ['id' => '\d+'], methods: ['DELETE'])]
-    public function delete(Request $request, \Eccube\Entity\Template $Template): RedirectResponse
+    public function delete(\Eccube\Entity\Template $Template): RedirectResponse
     {
         $this->isTokenValid();
 

src/Eccube/Resource/locale/messages.en.yaml

@@ -1429,6 +1429,10 @@ admin.setting.system.security.ip_limit_invalid_ipv4: "%ip% is not an IPv4 addres
 admin.setting.system.security.ip_limit_invalid_https: "http is not allowed to do this setting."
 admin.setting.system.security.admin_url_warning: Please set the Admin Console URL that is hard to guess for security.
 admin.setting.system.security.not_found_env_file: .env file not found. If you do not use the .env file you can not change security config in Admin Console.
+admin.system.env.ineffective.not_found: 'The .env file does not exist, so this setting cannot be changed from the admin screen. Please set the environment variables on the server directly.'
+admin.system.env.ineffective.not_writable: 'The .env file is not writable, so this setting cannot be changed from the admin screen. Please check the write permission of the .env file.'
+admin.system.env.ineffective.local_php: 'Because .env.local.php exists, changes to .env are not applied and cannot be made from the admin screen. Update .env on the server and re-run composer dump-env, or remove .env.local.php to re-enable changes from the admin screen.'
+admin.system.env.ineffective.overridden: 'The environment variable for this setting is set as an OS process environment variable, so changes to .env are not applied. Please change the environment variable on the server directly.'
 admin.setting.system.security.trusted_hosts: Trusted hosts
 admin.setting.system.security.trusted_hosts_sample: ^example\.com$,^example\.org$
 admin.setting.system.security.trusted_hosts_description: |

src/Eccube/Resource/locale/messages.ja.yaml

@@ -1429,6 +1429,10 @@ admin.setting.system.security.ip_limit_invalid_ip_and_submask: "%ip%はIPv4/ビ
 admin.setting.system.security.ip_limit_invalid_https: "httpの場合には設定できません。"
 admin.setting.system.security.admin_url_warning: 管理画面URLは、セキュリティのため推測されにくいものを設定してください。
 admin.setting.system.security.not_found_env_file: .envファイルが見つかりません。.envを利用していない場合はセキュリティ設定を管理画面から変更できません。
+admin.system.env.ineffective.not_found: '.env ファイルが存在しないため、この設定は管理画面から変更できません。サーバーの環境変数を直接設定してください。'
+admin.system.env.ineffective.not_writable: '.env ファイルに書き込み権限がないため、この設定は管理画面から変更できません。.env ファイルの書き込み権限を確認してください。'
+admin.system.env.ineffective.local_php: '.env.local.php が存在するため、.env への変更は反映されず、管理画面からは変更できません。サーバー側で .env を更新してから composer dump-env を再実行するか、.env.local.php を削除して管理画面からの変更を再開してください。'
+admin.system.env.ineffective.overridden: 'この設定の環境変数が OS のプロセス環境変数として設定されているため、.env への変更は反映されません。サーバーの環境変数を直接変更してください。'
 admin.setting.system.security.trusted_hosts: 信頼できるホスト名
 admin.setting.system.security.trusted_hosts_sample: ^example\.com$,^example\.org$
 admin.setting.system.security.trusted_hosts_description: |

src/Eccube/Resource/template/admin/Setting/System/security.twig

@@ -219,7 +219,7 @@ file that was distributed with this source code.
                         <div class="col-6">
                             <div id="ex-conversion-action" class="row align-items-center justify-content-end">
                                 <div class="col-auto">
-                                    <button type="submit" class="btn btn-ec-conversion px-5">{{ 'admin.common.registration'|trans }}</button>
+                                    <button type="submit" class="btn btn-ec-conversion px-5"{% if envWritable is defined and not envWritable %} disabled{% endif %}>{{ 'admin.common.registration'|trans }}</button>
                                 </div>
                             </div>
                         </div>

src/Eccube/Resource/template/admin/Store/template.twig

@@ -120,7 +120,7 @@ file that was distributed with this source code.
                     <div class="col-6">
                         <div id="ex-conversion-action" class="row align-items-center justify-content-end">
                             <div class="col-auto">
-                                <button class="btn btn-ec-conversion px-5" type="submit">{{ 'admin.common.registration'|trans }}</button>
+                                <button class="btn btn-ec-conversion px-5" type="submit"{% if envWritable is defined and not envWritable %} disabled{% endif %}>{{ 'admin.common.registration'|trans }}</button>
                             </div>
                         </div>
                     </div>

src/Eccube/Service/EnvFileService.php

@@ -0,0 +1,88 @@
+<?php
+
+/*
+ * This file is part of EC-CUBE
+ *
+ * Copyright(c) EC-CUBE CO.,LTD. All Rights Reserved.
+ *
+ * http://www.ec-cube.co.jp/
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Eccube\Service;
+
+/**
+ * .env ファイルへの書き込みが実行時に反映されるかを判定するサービス.
+ *
+ * セキュリティ設定・テンプレート設定などは .env を書き換えて機能を実現するが,
+ * docker-compose の環境変数や本番環境では .env が使われず, 書き換えても反映されない.
+ * ユーザーが変更できないことに気付けるよう, 反映されない理由を検出する.
+ *
+ * @see https://github.com/EC-CUBE/ec-cube/issues/6130
+ */
+class EnvFileService
+{
+    /** .env ファイルが存在しない（.env を利用していない） */
+    public const REASON_NOT_FOUND = 'not_found';
+
+    /** .env ファイルに書き込み権限がない */
+    public const REASON_NOT_WRITABLE = 'not_writable';
+
+    /** .env.local.php（dump-env の最適化済みスナップショット）が存在し, .env より優先される */
+    public const REASON_LOCAL_PHP = 'local_php';
+
+    /** 対象の環境変数が OS のプロセス環境変数として設定されており, .env の値を上書きしている */
+    public const REASON_OVERRIDDEN = 'overridden';
+
+    public function __construct(private readonly string $projectDir)
+    {
+    }
+
+    /**
+     * .env への書き込みが実行時のロードに反映されない理由を返す.
+     *
+     * 空配列であれば .env への書き込みが有効に反映される.
+     *
+     * @param string[] $keys 対象の環境変数キー（OS 環境変数によるオーバーライド判定に使用）
+     *
+     * @return string[] REASON_* 定数の配列
+     */
+    public function getIneffectiveReasons(array $keys = []): array
+    {
+        $reasons = [];
+
+        $envFile = $this->projectDir.'/.env';
+        if (!file_exists($envFile)) {
+            $reasons[] = self::REASON_NOT_FOUND;
+        } elseif (!is_writable($envFile)) {
+            $reasons[] = self::REASON_NOT_WRITABLE;
+        }
+
+        // .env.local.php があると bootEnv は .env より優先するため, .env の変更は反映されない
+        if (file_exists($this->projectDir.'/.env.local.php')) {
+            $reasons[] = self::REASON_LOCAL_PHP;
+        }
+
+        // bootEnv は OS のプロセス環境変数を上書きしないため, getenv が値を返すキーは .env の変更が反映されない
+        foreach ($keys as $key) {
+            if (false !== getenv($key)) {
+                $reasons[] = self::REASON_OVERRIDDEN;
+                break;
+            }
+        }
+
+        return $reasons;
+    }
+
+    /**
+     * 対象の環境変数について, .env への書き込みが有効に反映されるか.
+     *
+     * @param string[] $keys 対象の環境変数キー
+     */
+    public function isEffective(array $keys = []): bool
+    {
+        return [] === $this->getIneffectiveReasons($keys);
+    }
+}