Merge pull request #2225 from opensource-workshop/bug/fix-mail-subject-null-error

[プラグイン共通] 投稿通知の件名が未設定の場合に500エラーが発生する問題を修正しました

Author: masaton0216

app/Models/Common/BucketsMail.php

@@ -106,9 +106,20 @@ public static function stripTagsWysiwyg(?string $body): string
 
     /**
      * フォーマット済みの件名を取得
+     *
+     * @param string|null $subject
+     * @param array $notice_embedded_tags
+     * @return void
      */
-    public function getFormattedSubject(string $subject, array $notice_embedded_tags)
+    public function getFormattedSubject(string|null $subject, array $notice_embedded_tags)
     {
+        if ($subject === null || $subject === '') {
+            /**
+             * 件名が未設定の場合、Laravelのデフォルト値（「Post Notice」等）が設定されてわかりづらい為、【件名未設定】を設定する。
+             * ※別途、画面側でバリデーションを追加する為、件名が空の状態は今後、基本的にはありえないが、既存運用で件名が空のデータがある場合の対策として実装する。
+             */
+            return '【件名未設定】';
+        }
         return $this->replaceEmbeddedTags($subject, $notice_embedded_tags);
     }
 

app/Plugins/User/UserPluginBase.php

@@ -818,16 +818,43 @@ public function saveBucketsMails($request, $page_id, $frame_id, $block_id)
             $rules['approved_groups']      = [new CustomValiRequiredWithoutAllSupportsArrayInput([$request->approved_author, $request->approved_addresses], $name)];
         }
 
+        // 使用するメール送信メソッドを取得
+        $use_bucket_mail_methods = ['notice', 'relate', 'approval', 'approved']; // デフォルト値
+        if (method_exists($this, 'useBucketMailMethods')) {
+            $use_bucket_mail_methods = $this->useBucketMailMethods();
+        }
+
+        // 有効なメール機能に対してのみ件名フィールドのバリデーションを追加
+        if (in_array('notice', $use_bucket_mail_methods) && $request->notice_on) {
+            $rules['notice_subject'] = ['required', 'max:255'];
+        }
+
+        if (in_array('relate', $use_bucket_mail_methods) && $request->relate_on) {
+            $rules['relate_subject'] = ['required', 'max:255'];
+        }
+
+        if (in_array('approval', $use_bucket_mail_methods) && $request->approval_on) {
+            $rules['approval_subject'] = ['required', 'max:255'];
+        }
+
+        if (in_array('approved', $use_bucket_mail_methods) && $request->approved_on) {
+            $rules['approved_subject'] = ['required', 'max:255'];
+        }
+
         $validator = Validator::make($request->all(), $rules);
         $validator->setAttributeNames([
             'notice_addresses' => '送信先メールアドレス',
             'notice_groups' => '送信先グループ',
             'notice_everyone' => '全ユーザに通知',
+            'notice_subject' => '投稿通知の件名',
             'approval_addresses' => '送信先メールアドレス',
             'approval_groups' => '送信先グループ',
+            'approval_subject' => '承認通知の件名',
             'approved_author' => '投稿者へ通知する',
             'approved_addresses' => '送信先メールアドレス',
             'approved_groups' => '送信先グループ',
+            'approved_subject' => '承認済み通知の件名',
+            'relate_subject' => '関連記事通知の件名',
         ]);
 
         // エラーがあった場合は入力画面に戻る。

resources/views/plugins/common/frame_edit_mails.blade.php

@@ -136,6 +136,7 @@ function checkbox_notice_everyone() {
                     </small>
 
                     <span class="badge badge-secondary mt-3 mb-1">投稿通知の件名</span>
+                    <span class="badge badge-danger">必須</span>
                     <div class="pl-0">
                         <input type="text" name="notice_subject" value="{{old('notice_subject', $bucket_mail->notice_subject)}}" class="form-control @if ($errors && $errors->has('notice_subject')) border-danger @endif">
                         @include('plugins.common.errors_inline', ['name' => 'notice_subject'])
@@ -166,6 +167,7 @@ function checkbox_notice_everyone() {
                 </div>
                 <div class="collapse" id="collapse_relate">
                     <span class="badge badge-secondary mt-3 mb-1">関連記事通知の件名</span>
+                    <span class="badge badge-danger">必須</span>
                     <div class="pl-0">
                         <input type="text" name="relate_subject" value="{{old('relate_subject', $bucket_mail->relate_subject)}}" class="form-control @if ($errors && $errors->has('relate_subject')) border-danger @endif">
                         @include('plugins.common.errors_inline', ['name' => 'relate_subject'])
@@ -222,6 +224,7 @@ function checkbox_notice_everyone() {
                     </small>
 
                     <span class="badge badge-secondary mt-3 mb-1">承認通知の件名</span>
+                    <span class="badge badge-danger">必須</span>
                     <div class="pl-0">
                         <input type="text" name="approval_subject" value="{{old('approval_subject', $bucket_mail->approval_subject)}}" class="form-control @if ($errors && $errors->has('approval_subject')) border-danger @endif">
                         @include('plugins.common.errors_inline', ['name' => 'approval_subject'])
@@ -290,6 +293,7 @@ function checkbox_notice_everyone() {
                     </small>
 
                     <span class="badge badge-secondary mt-3 mb-1">承認済み通知の件名</span>
+                    <span class="badge badge-danger">必須</span>
                     <div class="pl-0">
                         <input type="text" name="approved_subject" value="{{old('approved_subject', $bucket_mail->approved_subject)}}" class="form-control @if ($errors && $errors->has('approved_subject')) border-danger @endif">
                         @include('plugins.common.errors_inline', ['name' => 'approved_subject'])

tests/Unit/Models/Common/BucketsMailTest.php

@@ -52,4 +52,40 @@ public function testGetFormattedSubject(): void
         // $this->assertStringContainsString('[[delete_comment]]', $subject, '件名の[[delete_comment]]は置換されない事');
         $this->assertStringContainsString('【サンプルサイト】', $subject, '件名の[[site_name]]は置換される事');
     }
+
+    /**
+     * getFormattedSubject()でnull値を渡した場合のテスト
+     */
+    public function testGetFormattedSubjectWithNull(): void
+    {
+        $notice_embedded_tags = [
+            NoticeEmbeddedTag::site_name => 'サンプルサイト',
+            NoticeEmbeddedTag::title => 'テストタイトル',
+            NoticeEmbeddedTag::body => 'HTMLを除いた本文',
+            NoticeEmbeddedTag::url => 'http://localhost/plugin/xxxx',
+        ];
+
+        $mail = new BucketsMail();
+        $result = $mail->getFormattedSubject(null, $notice_embedded_tags);
+
+        $this->assertEquals('【件名未設定】', $result, 'null値の場合はデフォルトメッセージが返される事');
+    }
+
+    /**
+     * getFormattedSubject()で空文字列を渡した場合のテスト
+     */
+    public function testGetFormattedSubjectWithEmptyString(): void
+    {
+        $notice_embedded_tags = [
+            NoticeEmbeddedTag::site_name => 'サンプルサイト',
+            NoticeEmbeddedTag::title => 'テストタイトル',
+            NoticeEmbeddedTag::body => 'HTMLを除いた本文',
+            NoticeEmbeddedTag::url => 'http://localhost/plugin/xxxx',
+        ];
+
+        $mail = new BucketsMail();
+        $result = $mail->getFormattedSubject('', $notice_embedded_tags);
+
+        $this->assertEquals('【件名未設定】', $result, '空文字列の場合はデフォルトメッセージが返される事');
+    }
 }