From 2e09b45144e922df727fafcf7ab27f0c15737d64 Mon Sep 17 00:00:00 2001 From: IanM Date: Sat, 19 Aug 2023 22:49:06 +0100 Subject: [PATCH 01/60] feat: notification unsubscribe links --- .../Notification/GroupMentionedBlueprint.php | 6 ++- .../Notification/PostMentionedBlueprint.php | 7 ++- .../Notification/UserMentionedBlueprint.php | 7 ++- .../{ => html}/groupMentioned.blade.php | 4 ++ .../emails/{ => html}/postMentioned.blade.php | 4 ++ .../emails/{ => html}/userMentioned.blade.php | 4 ++ .../emails/plain/groupMentioned.blade.php | 11 ++++ .../emails/plain/postMentioned.blade.php | 12 +++++ .../emails/plain/userMentioned.blade.php | 11 ++++ .../src/Notification/NewPostBlueprint.php | 6 ++- .../views/emails/{ => html}/newPost.blade.php | 4 ++ .../views/emails/plain/newPost.blade.php | 11 ++++ .../Notification/UserSuspendedBlueprint.php | 6 ++- .../Notification/UserUnsuspendedBlueprint.php | 6 ++- .../emails/{ => plain}/suspended.blade.php | 4 ++ .../emails/{ => plain}/unsuspended.blade.php | 4 ++ ...000000_create_unsubscribe_tokens_table.php | 30 +++++++++++ .../Controller/UnsubscribeController.php | 53 +++++++++++++++++++ framework/core/src/Forum/routes.php | 6 +++ .../src/Notification/MailableInterface.php | 17 +++++- .../src/Notification/NotificationMailer.php | 33 +++++++----- .../src/Notification/UnsubscribeToken.php | 42 +++++++++++++++ .../views/notification/html/base.blade.php | 43 +++++++++++++++ .../views/notification/plain/base.blade.php | 11 ++++ .../views/unsubscribe-confirmation.blade.php | 8 +++ 25 files changed, 325 insertions(+), 25 deletions(-) rename extensions/mentions/views/emails/{ => html}/groupMentioned.blade.php (83%) rename extensions/mentions/views/emails/{ => html}/postMentioned.blade.php (84%) rename extensions/mentions/views/emails/{ => html}/userMentioned.blade.php (83%) create mode 100644 extensions/mentions/views/emails/plain/groupMentioned.blade.php create mode 100644 extensions/mentions/views/emails/plain/postMentioned.blade.php create mode 100644 extensions/mentions/views/emails/plain/userMentioned.blade.php rename extensions/subscriptions/views/emails/{ => html}/newPost.blade.php (83%) create mode 100644 extensions/subscriptions/views/emails/plain/newPost.blade.php rename extensions/suspend/views/emails/{ => plain}/suspended.blade.php (74%) rename extensions/suspend/views/emails/{ => plain}/unsuspended.blade.php (66%) create mode 100644 framework/core/migrations/2023_08_19_000000_create_unsubscribe_tokens_table.php create mode 100644 framework/core/src/Forum/Controller/UnsubscribeController.php create mode 100644 framework/core/src/Notification/UnsubscribeToken.php create mode 100644 framework/core/views/notification/html/base.blade.php create mode 100644 framework/core/views/notification/plain/base.blade.php create mode 100644 framework/core/views/unsubscribe-confirmation.blade.php diff --git a/extensions/mentions/src/Notification/GroupMentionedBlueprint.php b/extensions/mentions/src/Notification/GroupMentionedBlueprint.php index 50d9b5824d..6bca6da476 100644 --- a/extensions/mentions/src/Notification/GroupMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/GroupMentionedBlueprint.php @@ -38,9 +38,11 @@ public function getData(): mixed return null; } - public function getEmailView(): string|array + public function getEmailView(): array { - return ['text' => 'flarum-mentions::emails.groupMentioned']; + return [ + 'text' => 'flarum-mentions::emails.plain.groupMentioned', + 'html' => 'flarum-mentions::emails.html.groupMentioned',]; } public function getEmailSubject(TranslatorInterface $translator): string diff --git a/extensions/mentions/src/Notification/PostMentionedBlueprint.php b/extensions/mentions/src/Notification/PostMentionedBlueprint.php index 465ee57ba9..4d594d2fbd 100644 --- a/extensions/mentions/src/Notification/PostMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/PostMentionedBlueprint.php @@ -39,9 +39,12 @@ public function getData(): array return ['replyNumber' => (int) $this->reply->number]; } - public function getEmailView(): string|array + public function getEmailView(): array { - return ['text' => 'flarum-mentions::emails.postMentioned']; + return [ + 'text' => 'flarum-mentions::emails.plain.postMentioned', + 'html' => 'flarum-mentions::emails.html.postMentioned', + ]; } public function getEmailSubject(TranslatorInterface $translator): string diff --git a/extensions/mentions/src/Notification/UserMentionedBlueprint.php b/extensions/mentions/src/Notification/UserMentionedBlueprint.php index 1555693384..39d50e8325 100644 --- a/extensions/mentions/src/Notification/UserMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/UserMentionedBlueprint.php @@ -38,9 +38,12 @@ public function getData(): mixed return null; } - public function getEmailView(): string|array + public function getEmailView(): array { - return ['text' => 'flarum-mentions::emails.userMentioned']; + return [ + 'text' => 'flarum-mentions::emails.plain.userMentioned', + 'html' => 'flarum-mentions::emails.html.userMentioned' + ]; } public function getEmailSubject(TranslatorInterface $translator): string diff --git a/extensions/mentions/views/emails/groupMentioned.blade.php b/extensions/mentions/views/emails/html/groupMentioned.blade.php similarity index 83% rename from extensions/mentions/views/emails/groupMentioned.blade.php rename to extensions/mentions/views/emails/html/groupMentioned.blade.php index 52b6f04582..42b8c82d49 100644 --- a/extensions/mentions/views/emails/groupMentioned.blade.php +++ b/extensions/mentions/views/emails/html/groupMentioned.blade.php @@ -1,3 +1,6 @@ +@extends('flarum.forum::notification.html.base') + +@section('content') {!! $translator->trans('flarum-mentions.email.group_mentioned.body', [ '{recipient_display_name}' => $user->display_name, '{mentioner_display_name}' => $blueprint->post->user->display_name, @@ -5,3 +8,4 @@ '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), '{content}' => $blueprint->post->content ]) !!} +@endsection diff --git a/extensions/mentions/views/emails/postMentioned.blade.php b/extensions/mentions/views/emails/html/postMentioned.blade.php similarity index 84% rename from extensions/mentions/views/emails/postMentioned.blade.php rename to extensions/mentions/views/emails/html/postMentioned.blade.php index 73ce3d7a63..2dea90da0b 100644 --- a/extensions/mentions/views/emails/postMentioned.blade.php +++ b/extensions/mentions/views/emails/html/postMentioned.blade.php @@ -1,3 +1,6 @@ +@extends('flarum.forum::notification.html.base') + +@section('content') {!! $translator->trans('flarum-mentions.email.post_mentioned.body', [ '{recipient_display_name}' => $user->display_name, '{replier_display_name}' => $blueprint->reply->user->display_name, @@ -6,3 +9,4 @@ '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->reply->discussion_id, 'near' => $blueprint->reply->number]), '{content}' => $blueprint->reply->content ]) !!} +@endsection diff --git a/extensions/mentions/views/emails/userMentioned.blade.php b/extensions/mentions/views/emails/html/userMentioned.blade.php similarity index 83% rename from extensions/mentions/views/emails/userMentioned.blade.php rename to extensions/mentions/views/emails/html/userMentioned.blade.php index 9d3881607a..586031c746 100644 --- a/extensions/mentions/views/emails/userMentioned.blade.php +++ b/extensions/mentions/views/emails/html/userMentioned.blade.php @@ -1,3 +1,6 @@ +@extends('flarum.forum::notification.html.base') + +@section('content') {!! $translator->trans('flarum-mentions.email.user_mentioned.body', [ '{recipient_display_name}' => $user->display_name, '{mentioner_display_name}' => $blueprint->post->user->display_name, @@ -5,3 +8,4 @@ '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), '{content}' => $blueprint->post->content ]) !!} +@endsection diff --git a/extensions/mentions/views/emails/plain/groupMentioned.blade.php b/extensions/mentions/views/emails/plain/groupMentioned.blade.php new file mode 100644 index 0000000000..fcee97cb77 --- /dev/null +++ b/extensions/mentions/views/emails/plain/groupMentioned.blade.php @@ -0,0 +1,11 @@ +@extends('flarum.forum::notification.plain.base') + +@section('content') +{!! $translator->trans('flarum-mentions.email.group_mentioned.body', [ +'{recipient_display_name}' => $user->display_name, +'{mentioner_display_name}' => $blueprint->post->user->display_name, +'{title}' => $blueprint->post->discussion->title, +'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), +'{content}' => $blueprint->post->content +]) !!} +@endsection diff --git a/extensions/mentions/views/emails/plain/postMentioned.blade.php b/extensions/mentions/views/emails/plain/postMentioned.blade.php new file mode 100644 index 0000000000..08ba96dc65 --- /dev/null +++ b/extensions/mentions/views/emails/plain/postMentioned.blade.php @@ -0,0 +1,12 @@ +@extends('flarum.forum::notification.plain.base') + +@section('content') +{!! $translator->trans('flarum-mentions.email.post_mentioned.body', [ +'{recipient_display_name}' => $user->display_name, +'{replier_display_name}' => $blueprint->reply->user->display_name, +'{post_number}' => $blueprint->post->number, +'{title}' => $blueprint->post->discussion->title, +'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->reply->discussion_id, 'near' => $blueprint->reply->number]), +'{content}' => $blueprint->reply->content +]) !!} +@endsection diff --git a/extensions/mentions/views/emails/plain/userMentioned.blade.php b/extensions/mentions/views/emails/plain/userMentioned.blade.php new file mode 100644 index 0000000000..cc0b797b43 --- /dev/null +++ b/extensions/mentions/views/emails/plain/userMentioned.blade.php @@ -0,0 +1,11 @@ +@extends('flarum.forum::notification.plain.base') + +@section('content') +{!! $translator->trans('flarum-mentions.email.user_mentioned.body', [ +'{recipient_display_name}' => $user->display_name, +'{mentioner_display_name}' => $blueprint->post->user->display_name, +'{title}' => $blueprint->post->discussion->title, +'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), +'{content}' => $blueprint->post->content +]) !!} +@endsection diff --git a/extensions/subscriptions/src/Notification/NewPostBlueprint.php b/extensions/subscriptions/src/Notification/NewPostBlueprint.php index 58664bc42c..043169aef8 100644 --- a/extensions/subscriptions/src/Notification/NewPostBlueprint.php +++ b/extensions/subscriptions/src/Notification/NewPostBlueprint.php @@ -39,9 +39,11 @@ public function getData(): array return ['postNumber' => (int) $this->post->number]; } - public function getEmailView(): string|array + public function getEmailView(): array { - return ['text' => 'flarum-subscriptions::emails.newPost']; + return [ + 'text' => 'flarum-subscriptions::emails.plain.newPost', + 'html' => 'flarum-subscriptions::emails.html.newPost',]; } public function getEmailSubject(TranslatorInterface $translator): string diff --git a/extensions/subscriptions/views/emails/newPost.blade.php b/extensions/subscriptions/views/emails/html/newPost.blade.php similarity index 83% rename from extensions/subscriptions/views/emails/newPost.blade.php rename to extensions/subscriptions/views/emails/html/newPost.blade.php index e1c11e7d4e..596b3da3ac 100644 --- a/extensions/subscriptions/views/emails/newPost.blade.php +++ b/extensions/subscriptions/views/emails/html/newPost.blade.php @@ -1,3 +1,6 @@ +@extends('flarum.forum::notification.html.base') + +@section('content') {!! $translator->trans('flarum-subscriptions.email.new_post.body', [ '{recipient_display_name}' => $user->display_name, '{poster_display_name}' => $blueprint->post->user->display_name, @@ -5,3 +8,4 @@ '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), '{content}' => $blueprint->post->content ]) !!} +@endsection diff --git a/extensions/subscriptions/views/emails/plain/newPost.blade.php b/extensions/subscriptions/views/emails/plain/newPost.blade.php new file mode 100644 index 0000000000..d14728196e --- /dev/null +++ b/extensions/subscriptions/views/emails/plain/newPost.blade.php @@ -0,0 +1,11 @@ +@extends('flarum.forum::notification.plain.base') + +@section('content') +{!! $translator->trans('flarum-subscriptions.email.new_post.body', [ +'{recipient_display_name}' => $user->display_name, +'{poster_display_name}' => $blueprint->post->user->display_name, +'{title}' => $blueprint->post->discussion->title, +'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), +'{content}' => $blueprint->post->content +]) !!} +@endsection diff --git a/extensions/suspend/src/Notification/UserSuspendedBlueprint.php b/extensions/suspend/src/Notification/UserSuspendedBlueprint.php index 53b1f3807d..819ff83d4c 100644 --- a/extensions/suspend/src/Notification/UserSuspendedBlueprint.php +++ b/extensions/suspend/src/Notification/UserSuspendedBlueprint.php @@ -48,9 +48,11 @@ public static function getSubjectModel(): string return User::class; } - public function getEmailView(): string|array + public function getEmailView(): array { - return ['text' => 'flarum-suspend::emails.suspended']; + return [ + 'text' => 'flarum-suspend::emails.plain.suspended', + 'html' => 'flarum-suspend::emails.html.suspended',]; } public function getEmailSubject(TranslatorInterface $translator): string diff --git a/extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php b/extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php index 8660b12d35..6cf4939086 100644 --- a/extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php +++ b/extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php @@ -49,9 +49,11 @@ public static function getSubjectModel(): string return User::class; } - public function getEmailView(): string|array + public function getEmailView(): array { - return ['text' => 'flarum-suspend::emails.unsuspended']; + return [ + 'text' => 'flarum-suspend::emails.plain.unsuspended', + 'html' => 'flarum-suspend::emails.html.unsuspended',]; } public function getEmailSubject(TranslatorInterface $translator): string diff --git a/extensions/suspend/views/emails/suspended.blade.php b/extensions/suspend/views/emails/plain/suspended.blade.php similarity index 74% rename from extensions/suspend/views/emails/suspended.blade.php rename to extensions/suspend/views/emails/plain/suspended.blade.php index 924733e838..de5a89bedb 100644 --- a/extensions/suspend/views/emails/suspended.blade.php +++ b/extensions/suspend/views/emails/plain/suspended.blade.php @@ -1,4 +1,8 @@ +@extends('flarum.forum::notification.plain.base') + +@section('content') {!! $translator->trans('flarum-suspend.email.suspended.body', [ '{recipient_display_name}' => $user->display_name, '{suspension_message}' => $blueprint->user->suspend_message ?? $translator->trans('flarum-suspend.email.no_reason_given'), ]) !!} +@endsection diff --git a/extensions/suspend/views/emails/unsuspended.blade.php b/extensions/suspend/views/emails/plain/unsuspended.blade.php similarity index 66% rename from extensions/suspend/views/emails/unsuspended.blade.php rename to extensions/suspend/views/emails/plain/unsuspended.blade.php index 1237e6c2cc..679f3e760a 100644 --- a/extensions/suspend/views/emails/unsuspended.blade.php +++ b/extensions/suspend/views/emails/plain/unsuspended.blade.php @@ -1,4 +1,8 @@ +@extends('flarum.forum::notification.plain.base') + +@section('content') {!! $translator->trans('flarum-suspend.email.unsuspended.body', [ '{recipient_display_name}' => $user->display_name, '{forum_url}' => $url->to('forum')->base(), ]) !!} +@endsection diff --git a/framework/core/migrations/2023_08_19_000000_create_unsubscribe_tokens_table.php b/framework/core/migrations/2023_08_19_000000_create_unsubscribe_tokens_table.php new file mode 100644 index 0000000000..2bf7e5d3b7 --- /dev/null +++ b/framework/core/migrations/2023_08_19_000000_create_unsubscribe_tokens_table.php @@ -0,0 +1,30 @@ +id(); + $table->unsignedInteger('user_id'); + $table->string('email_type'); + $table->string('token', 100)->unique(); + $table->timestamp('unsubscribed_at')->nullable(); + $table->timestamps(); + + $table->foreign('user_id')->references('id')->on('users')->onDelete('cascade'); + + $table->index('user_id'); + $table->index('email_type'); + $table->index('token'); + $table->index(['user_id', 'email_type']); + } +); diff --git a/framework/core/src/Forum/Controller/UnsubscribeController.php b/framework/core/src/Forum/Controller/UnsubscribeController.php new file mode 100644 index 0000000000..35561cbd0a --- /dev/null +++ b/framework/core/src/Forum/Controller/UnsubscribeController.php @@ -0,0 +1,53 @@ +getQueryParams(), 'userId'); + $token = Arr::get($request->getQueryParams(), 'token'); + + // Fetch the unsubscribe token record + $unsubscribeRecord = UnsubscribeToken::where('user_id', $userId) + ->where('token', $token) + ->first(); + + // If record exists and has not been used before + if ($unsubscribeRecord && !$unsubscribeRecord->unsubscribed_at) { + // Mark as unsubscribed + $unsubscribeRecord->unsubscribed_at = Carbon::now(); + $unsubscribeRecord->save(); + + // Update user preferences + /** @var User $user */ + $user = User::find($userId); + $user->setPreference('notify_' . $unsubscribeRecord->email_type . '_email', false); + $user->save(); + + $message = 'You have successfully unsubscribed from this type of email notification. If you wish to receive it again, please update your settings.'; + } else { + // If the token doesn't exist or has already been used + $message = 'This unsubscribe link is invalid or has already been used. Please check your settings if you wish to manage your email notifications.'; + } + + return $this->view->make('flarum.forum::unsubscribe-confirmation')->with('message', $message); + } +} diff --git a/framework/core/src/Forum/routes.php b/framework/core/src/Forum/routes.php index d0264cb8c1..2823ad7670 100644 --- a/framework/core/src/Forum/routes.php +++ b/framework/core/src/Forum/routes.php @@ -43,6 +43,12 @@ $route->toForum(Content\AssertRegistered::class) ); + $map->get( + '/notifications/unsubscribe/{userId}/{token}', + 'notifications.unsubscribe', + $route->toController(Controller\UnsubscribeController::class) + ); + $map->get( '/logout', 'logout', diff --git a/framework/core/src/Notification/MailableInterface.php b/framework/core/src/Notification/MailableInterface.php index a5cf4a7608..198b31395f 100644 --- a/framework/core/src/Notification/MailableInterface.php +++ b/framework/core/src/Notification/MailableInterface.php @@ -15,11 +15,26 @@ interface MailableInterface { /** * Get the name of the view to construct a notification email with. + * + * To provide the best experince for the user, provide both a `text` and `html` view. + * + * Example: + * ```php + * return [ + * 'text' => 'flarum-subscriptions::emails.plain.newPost', + * 'html' => 'flarum-subscriptions::emails.html.newPost' + * ]; + * ``` */ - public function getEmailView(): string|array; + public function getEmailView(): array; /** * Get the subject line for a notification email. */ public function getEmailSubject(TranslatorInterface $translator): string; + + /** + * Get the serialized type of this activity. + */ + public static function getType(): string; } diff --git a/framework/core/src/Notification/NotificationMailer.php b/framework/core/src/Notification/NotificationMailer.php index b847f9a4c9..24f187e856 100644 --- a/framework/core/src/Notification/NotificationMailer.php +++ b/framework/core/src/Notification/NotificationMailer.php @@ -1,41 +1,50 @@ translator->setLocale($user->getPreference('locale') ?? $this->settings->get('default_locale')); + // Generate and save the unsubscribe token: + $token = Str::random(60); + $unsubscribeRecord = new UnsubscribeToken([ + 'user_id' => $user->id, + 'email_type' => $blueprint::getType(), + 'token' => $token + ]); + $unsubscribeRecord->save(); + + $unsubscribeLink = $this->url->to('forum')->route('notifications.unsubscribe', ['userId' => $user->id, 'token' => $token]); + $settingsLink = $this->url->to('forum')->route('settings'); + $this->mailer->send( $blueprint->getEmailView(), - compact('blueprint', 'user'), - function (Message $message) use ($blueprint, $user) { + compact('blueprint', 'user', 'unsubscribeLink', 'settingsLink'), + function (Message $message) use ($blueprint, $user, $unsubscribeLink) { $message->to($user->email, $user->display_name) - ->subject($blueprint->getEmailSubject($this->translator)); + ->subject($blueprint->getEmailSubject($this->translator)) + ->getHeaders() + ->addTextHeader('List-Unsubscribe', '<' . $unsubscribeLink . '>'); } ); } diff --git a/framework/core/src/Notification/UnsubscribeToken.php b/framework/core/src/Notification/UnsubscribeToken.php new file mode 100644 index 0000000000..ff00f52eaf --- /dev/null +++ b/framework/core/src/Notification/UnsubscribeToken.php @@ -0,0 +1,42 @@ + 'int', + 'unsubscribed_at' => 'datetime' + ]; + + /** + * The attributes that are mass assignable. + * + * @var array + */ + protected $fillable = ['user_id', 'email_type', 'token']; + + /** + * Define a relation to the User model. + */ + public function user(): BelongsTo + { + return $this->belongsTo(User::class); + } +} diff --git a/framework/core/views/notification/html/base.blade.php b/framework/core/views/notification/html/base.blade.php new file mode 100644 index 0000000000..e45bc8f805 --- /dev/null +++ b/framework/core/views/notification/html/base.blade.php @@ -0,0 +1,43 @@ + + + + + + {{ $settings->get('forum_title') }} Notification + + + +
+

{{ $settings->get('forum_title') }} Notification

+
+ @yield('content') +
+
+ If you'd like to stop receiving this type of notification, unsubscribe here.
+ Manage your notification settings here. +
+
+ + diff --git a/framework/core/views/notification/plain/base.blade.php b/framework/core/views/notification/plain/base.blade.php new file mode 100644 index 0000000000..de2efc498c --- /dev/null +++ b/framework/core/views/notification/plain/base.blade.php @@ -0,0 +1,11 @@ +{{ $settings->get('forum_title') }} Notification + +--------------------------------------------------- + +@yield('content') + +--------------------------------------------------- + +If you'd like to stop receiving this type of notification, unsubscribe here: {{ $unsubscribeLink }} + +Manage your notification settings: {{ $settingsLink }} diff --git a/framework/core/views/unsubscribe-confirmation.blade.php b/framework/core/views/unsubscribe-confirmation.blade.php new file mode 100644 index 0000000000..af2b1ba81b --- /dev/null +++ b/framework/core/views/unsubscribe-confirmation.blade.php @@ -0,0 +1,8 @@ +@extends('flarum.forum::layouts.basic') + +@section('content') +
+

Unsubscribe Confirmation

+

{{ $message }}

+
+@endsection From d247b408e212f9e9e69dcea2e87791538030b729 Mon Sep 17 00:00:00 2001 From: StyleCI Bot Date: Sat, 19 Aug 2023 21:49:44 +0000 Subject: [PATCH 02/60] Apply fixes from StyleCI --- .../src/Notification/GroupMentionedBlueprint.php | 2 +- .../src/Notification/NewPostBlueprint.php | 2 +- .../src/Notification/UserSuspendedBlueprint.php | 2 +- .../src/Notification/UserUnsuspendedBlueprint.php | 2 +- .../src/Forum/Controller/UnsubscribeController.php | 13 ++++++++++--- .../core/src/Notification/MailableInterface.php | 6 +++--- .../core/src/Notification/NotificationMailer.php | 11 +++++++++-- .../core/src/Notification/UnsubscribeToken.php | 7 +++++++ 8 files changed, 33 insertions(+), 12 deletions(-) diff --git a/extensions/mentions/src/Notification/GroupMentionedBlueprint.php b/extensions/mentions/src/Notification/GroupMentionedBlueprint.php index 6bca6da476..1598306f10 100644 --- a/extensions/mentions/src/Notification/GroupMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/GroupMentionedBlueprint.php @@ -42,7 +42,7 @@ public function getEmailView(): array { return [ 'text' => 'flarum-mentions::emails.plain.groupMentioned', - 'html' => 'flarum-mentions::emails.html.groupMentioned',]; + 'html' => 'flarum-mentions::emails.html.groupMentioned', ]; } public function getEmailSubject(TranslatorInterface $translator): string diff --git a/extensions/subscriptions/src/Notification/NewPostBlueprint.php b/extensions/subscriptions/src/Notification/NewPostBlueprint.php index 043169aef8..4fcf03f662 100644 --- a/extensions/subscriptions/src/Notification/NewPostBlueprint.php +++ b/extensions/subscriptions/src/Notification/NewPostBlueprint.php @@ -43,7 +43,7 @@ public function getEmailView(): array { return [ 'text' => 'flarum-subscriptions::emails.plain.newPost', - 'html' => 'flarum-subscriptions::emails.html.newPost',]; + 'html' => 'flarum-subscriptions::emails.html.newPost', ]; } public function getEmailSubject(TranslatorInterface $translator): string diff --git a/extensions/suspend/src/Notification/UserSuspendedBlueprint.php b/extensions/suspend/src/Notification/UserSuspendedBlueprint.php index 819ff83d4c..a40cf6c490 100644 --- a/extensions/suspend/src/Notification/UserSuspendedBlueprint.php +++ b/extensions/suspend/src/Notification/UserSuspendedBlueprint.php @@ -52,7 +52,7 @@ public function getEmailView(): array { return [ 'text' => 'flarum-suspend::emails.plain.suspended', - 'html' => 'flarum-suspend::emails.html.suspended',]; + 'html' => 'flarum-suspend::emails.html.suspended', ]; } public function getEmailSubject(TranslatorInterface $translator): string diff --git a/extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php b/extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php index 6cf4939086..0d90b49194 100644 --- a/extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php +++ b/extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php @@ -53,7 +53,7 @@ public function getEmailView(): array { return [ 'text' => 'flarum-suspend::emails.plain.unsuspended', - 'html' => 'flarum-suspend::emails.html.unsuspended',]; + 'html' => 'flarum-suspend::emails.html.unsuspended', ]; } public function getEmailSubject(TranslatorInterface $translator): string diff --git a/framework/core/src/Forum/Controller/UnsubscribeController.php b/framework/core/src/Forum/Controller/UnsubscribeController.php index 35561cbd0a..aaa5310483 100644 --- a/framework/core/src/Forum/Controller/UnsubscribeController.php +++ b/framework/core/src/Forum/Controller/UnsubscribeController.php @@ -1,11 +1,18 @@ first(); // If record exists and has not been used before - if ($unsubscribeRecord && !$unsubscribeRecord->unsubscribed_at) { + if ($unsubscribeRecord && ! $unsubscribeRecord->unsubscribed_at) { // Mark as unsubscribed $unsubscribeRecord->unsubscribed_at = Carbon::now(); $unsubscribeRecord->save(); @@ -39,7 +46,7 @@ public function render(Request $request): View // Update user preferences /** @var User $user */ $user = User::find($userId); - $user->setPreference('notify_' . $unsubscribeRecord->email_type . '_email', false); + $user->setPreference('notify_'.$unsubscribeRecord->email_type.'_email', false); $user->save(); $message = 'You have successfully unsubscribed from this type of email notification. If you wish to receive it again, please update your settings.'; diff --git a/framework/core/src/Notification/MailableInterface.php b/framework/core/src/Notification/MailableInterface.php index 198b31395f..a14ca18720 100644 --- a/framework/core/src/Notification/MailableInterface.php +++ b/framework/core/src/Notification/MailableInterface.php @@ -15,13 +15,13 @@ interface MailableInterface { /** * Get the name of the view to construct a notification email with. - * + * * To provide the best experince for the user, provide both a `text` and `html` view. - * + * * Example: * ```php * return [ - * 'text' => 'flarum-subscriptions::emails.plain.newPost', + * 'text' => 'flarum-subscriptions::emails.plain.newPost', * 'html' => 'flarum-subscriptions::emails.html.newPost' * ]; * ``` diff --git a/framework/core/src/Notification/NotificationMailer.php b/framework/core/src/Notification/NotificationMailer.php index 24f187e856..cf64f510d9 100644 --- a/framework/core/src/Notification/NotificationMailer.php +++ b/framework/core/src/Notification/NotificationMailer.php @@ -1,11 +1,18 @@ to($user->email, $user->display_name) ->subject($blueprint->getEmailSubject($this->translator)) ->getHeaders() - ->addTextHeader('List-Unsubscribe', '<' . $unsubscribeLink . '>'); + ->addTextHeader('List-Unsubscribe', '<'.$unsubscribeLink.'>'); } ); } diff --git a/framework/core/src/Notification/UnsubscribeToken.php b/framework/core/src/Notification/UnsubscribeToken.php index ff00f52eaf..93f0005923 100644 --- a/framework/core/src/Notification/UnsubscribeToken.php +++ b/framework/core/src/Notification/UnsubscribeToken.php @@ -1,5 +1,12 @@ Date: Sun, 20 Aug 2023 15:28:19 +0100 Subject: [PATCH 03/60] use PHPStan array shape --- .../core/src/Notification/MailableInterface.php | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/framework/core/src/Notification/MailableInterface.php b/framework/core/src/Notification/MailableInterface.php index a14ca18720..b4fe61df14 100644 --- a/framework/core/src/Notification/MailableInterface.php +++ b/framework/core/src/Notification/MailableInterface.php @@ -16,15 +16,12 @@ interface MailableInterface /** * Get the name of the view to construct a notification email with. * - * To provide the best experince for the user, provide both a `text` and `html` view. + * To provide the best experience for the user, Flarum expects both a `text` and `html` view. * - * Example: - * ```php - * return [ - * 'text' => 'flarum-subscriptions::emails.plain.newPost', - * 'html' => 'flarum-subscriptions::emails.html.newPost' - * ]; - * ``` + * @return array{ + * text: string, + * html: string + * } */ public function getEmailView(): array; From 76604bb3d431232a006cd2a0ff43e22079561b14 Mon Sep 17 00:00:00 2001 From: IanM Date: Sun, 20 Aug 2023 15:31:32 +0100 Subject: [PATCH 04/60] remove docblocks --- .../core/src/Notification/UnsubscribeToken.php | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/framework/core/src/Notification/UnsubscribeToken.php b/framework/core/src/Notification/UnsubscribeToken.php index 93f0005923..0ee77be0d1 100644 --- a/framework/core/src/Notification/UnsubscribeToken.php +++ b/framework/core/src/Notification/UnsubscribeToken.php @@ -15,33 +15,15 @@ class UnsubscribeToken extends AbstractModel { - /** - * The table associated with the model. - * - * @var string - */ protected $table = 'unsubscribe_tokens'; - /** - * The attributes that should be cast to native types. - * - * @var array - */ protected $casts = [ 'user_id' => 'int', 'unsubscribed_at' => 'datetime' ]; - /** - * The attributes that are mass assignable. - * - * @var array - */ protected $fillable = ['user_id', 'email_type', 'token']; - /** - * Define a relation to the User model. - */ public function user(): BelongsTo { return $this->belongsTo(User::class); From 79928b01c7726e6629a1249c2943f4ad05e3d391 Mon Sep 17 00:00:00 2001 From: IanM Date: Sun, 20 Aug 2023 15:43:28 +0100 Subject: [PATCH 05/60] docblock types for UnsubscibeToken model --- .../src/Forum/Controller/UnsubscribeController.php | 2 +- framework/core/src/Notification/UnsubscribeToken.php | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/framework/core/src/Forum/Controller/UnsubscribeController.php b/framework/core/src/Forum/Controller/UnsubscribeController.php index aaa5310483..5bb03f3a1e 100644 --- a/framework/core/src/Forum/Controller/UnsubscribeController.php +++ b/framework/core/src/Forum/Controller/UnsubscribeController.php @@ -9,6 +9,7 @@ namespace Flarum\Forum\Controller; +use Carbon\Carbon; use Flarum\Http\Controller\AbstractHtmlController; use Flarum\Http\UrlGenerator; use Flarum\Notification\UnsubscribeToken; @@ -16,7 +17,6 @@ use Illuminate\Contracts\View\Factory; use Illuminate\Contracts\View\View; use Illuminate\Support\Arr; -use Illuminate\Support\Carbon; use Psr\Http\Message\ServerRequestInterface as Request; class UnsubscribeController extends AbstractHtmlController diff --git a/framework/core/src/Notification/UnsubscribeToken.php b/framework/core/src/Notification/UnsubscribeToken.php index 0ee77be0d1..da3e6fd685 100644 --- a/framework/core/src/Notification/UnsubscribeToken.php +++ b/framework/core/src/Notification/UnsubscribeToken.php @@ -13,6 +13,16 @@ use Flarum\User\User; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * @property int $id + * @property int $user_id + * @property string $email_type + * @property string $token + * @property \Carbon\Carbon $$unsubscribed_at + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property-read \Flarum\User\User|null $user + */ class UnsubscribeToken extends AbstractModel { protected $table = 'unsubscribe_tokens'; From 5df71971031afd0f070666d1b6ea9a4d6d32f3ce Mon Sep 17 00:00:00 2001 From: IanM Date: Sun, 20 Aug 2023 15:45:32 +0100 Subject: [PATCH 06/60] typo --- framework/core/src/Notification/UnsubscribeToken.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/framework/core/src/Notification/UnsubscribeToken.php b/framework/core/src/Notification/UnsubscribeToken.php index da3e6fd685..db696314c1 100644 --- a/framework/core/src/Notification/UnsubscribeToken.php +++ b/framework/core/src/Notification/UnsubscribeToken.php @@ -18,7 +18,7 @@ * @property int $user_id * @property string $email_type * @property string $token - * @property \Carbon\Carbon $$unsubscribed_at + * @property \Carbon\Carbon $unsubscribed_at * @property \Carbon\Carbon $created_at * @property \Carbon\Carbon $updated_at * @property-read \Flarum\User\User|null $user From e1ab8e5c2c9ba8a6c31f54bd0205da6eff1f7fdc Mon Sep 17 00:00:00 2001 From: IanM Date: Sun, 20 Aug 2023 15:58:49 +0100 Subject: [PATCH 07/60] create setNotificationPreference on the User model --- .../src/Forum/Controller/UnsubscribeController.php | 3 ++- framework/core/src/User/User.php | 10 ++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/framework/core/src/Forum/Controller/UnsubscribeController.php b/framework/core/src/Forum/Controller/UnsubscribeController.php index 5bb03f3a1e..6a2f17c5ae 100644 --- a/framework/core/src/Forum/Controller/UnsubscribeController.php +++ b/framework/core/src/Forum/Controller/UnsubscribeController.php @@ -33,6 +33,7 @@ public function render(Request $request): View $token = Arr::get($request->getQueryParams(), 'token'); // Fetch the unsubscribe token record + /** @var UnsubscribeToken|null $unsubscribeRecord */ $unsubscribeRecord = UnsubscribeToken::where('user_id', $userId) ->where('token', $token) ->first(); @@ -46,7 +47,7 @@ public function render(Request $request): View // Update user preferences /** @var User $user */ $user = User::find($userId); - $user->setPreference('notify_'.$unsubscribeRecord->email_type.'_email', false); + $user->setNotificationPreference($unsubscribeRecord->email_type, 'email', false); $user->save(); $message = 'You have successfully unsubscribed from this type of email notification. If you wish to receive it again, please update your settings.'; diff --git a/framework/core/src/User/User.php b/framework/core/src/User/User.php index a96f63adb1..1c44496b12 100644 --- a/framework/core/src/User/User.php +++ b/framework/core/src/User/User.php @@ -687,4 +687,14 @@ public function refreshDiscussionCount(): static return $this; } + + /** + * Set the value of a notification preference. + */ + public function setNotificationPreference(string $type, string $method, bool $value): static + { + $this->setPreference(static::getNotificationPreferenceKey($type, $method), $value); + + return $this; + } } From ad4fc00d47a4f3ab4375a379d29f538ab817dc24 Mon Sep 17 00:00:00 2001 From: IanM Date: Sun, 20 Aug 2023 16:08:53 +0100 Subject: [PATCH 08/60] attempt to fix phpstan error --- framework/core/src/Forum/Controller/UnsubscribeController.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/framework/core/src/Forum/Controller/UnsubscribeController.php b/framework/core/src/Forum/Controller/UnsubscribeController.php index 6a2f17c5ae..11c91c0f7a 100644 --- a/framework/core/src/Forum/Controller/UnsubscribeController.php +++ b/framework/core/src/Forum/Controller/UnsubscribeController.php @@ -39,7 +39,7 @@ public function render(Request $request): View ->first(); // If record exists and has not been used before - if ($unsubscribeRecord && ! $unsubscribeRecord->unsubscribed_at) { + if ($unsubscribeRecord && empty($unsubscribeRecord->unsubscribed_at)) { // Mark as unsubscribed $unsubscribeRecord->unsubscribed_at = Carbon::now(); $unsubscribeRecord->save(); From c3ce914099631a35fd2a7008604c1861687c23e2 Mon Sep 17 00:00:00 2001 From: IanM Date: Sun, 20 Aug 2023 19:22:26 +0100 Subject: [PATCH 09/60] Rename getEmailView to getEmailViews to better reflect the function. Begin adding translations --- .../src/Notification/GroupMentionedBlueprint.php | 2 +- .../mentions/src/Notification/PostMentionedBlueprint.php | 2 +- .../mentions/src/Notification/UserMentionedBlueprint.php | 2 +- .../subscriptions/src/Notification/NewPostBlueprint.php | 2 +- .../suspend/src/Notification/UserSuspendedBlueprint.php | 2 +- .../src/Notification/UserUnsuspendedBlueprint.php | 2 +- framework/core/locale/core.yml | 5 +++++ framework/core/src/Notification/MailableInterface.php | 4 ++-- framework/core/src/Notification/NotificationMailer.php | 2 +- framework/core/views/notification/html/base.blade.php | 9 +++++++-- framework/core/views/unsubscribe-confirmation.blade.php | 8 +++++++- 11 files changed, 28 insertions(+), 12 deletions(-) diff --git a/extensions/mentions/src/Notification/GroupMentionedBlueprint.php b/extensions/mentions/src/Notification/GroupMentionedBlueprint.php index 1598306f10..f70c9f4851 100644 --- a/extensions/mentions/src/Notification/GroupMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/GroupMentionedBlueprint.php @@ -38,7 +38,7 @@ public function getData(): mixed return null; } - public function getEmailView(): array + public function getEmailViews(): array { return [ 'text' => 'flarum-mentions::emails.plain.groupMentioned', diff --git a/extensions/mentions/src/Notification/PostMentionedBlueprint.php b/extensions/mentions/src/Notification/PostMentionedBlueprint.php index 4d594d2fbd..81594d8d9a 100644 --- a/extensions/mentions/src/Notification/PostMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/PostMentionedBlueprint.php @@ -39,7 +39,7 @@ public function getData(): array return ['replyNumber' => (int) $this->reply->number]; } - public function getEmailView(): array + public function getEmailViews(): array { return [ 'text' => 'flarum-mentions::emails.plain.postMentioned', diff --git a/extensions/mentions/src/Notification/UserMentionedBlueprint.php b/extensions/mentions/src/Notification/UserMentionedBlueprint.php index 39d50e8325..acdf2ab6fe 100644 --- a/extensions/mentions/src/Notification/UserMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/UserMentionedBlueprint.php @@ -38,7 +38,7 @@ public function getData(): mixed return null; } - public function getEmailView(): array + public function getEmailViews(): array { return [ 'text' => 'flarum-mentions::emails.plain.userMentioned', diff --git a/extensions/subscriptions/src/Notification/NewPostBlueprint.php b/extensions/subscriptions/src/Notification/NewPostBlueprint.php index 4fcf03f662..e96c803ddb 100644 --- a/extensions/subscriptions/src/Notification/NewPostBlueprint.php +++ b/extensions/subscriptions/src/Notification/NewPostBlueprint.php @@ -39,7 +39,7 @@ public function getData(): array return ['postNumber' => (int) $this->post->number]; } - public function getEmailView(): array + public function getEmailViews(): array { return [ 'text' => 'flarum-subscriptions::emails.plain.newPost', diff --git a/extensions/suspend/src/Notification/UserSuspendedBlueprint.php b/extensions/suspend/src/Notification/UserSuspendedBlueprint.php index a40cf6c490..b54aa70f99 100644 --- a/extensions/suspend/src/Notification/UserSuspendedBlueprint.php +++ b/extensions/suspend/src/Notification/UserSuspendedBlueprint.php @@ -48,7 +48,7 @@ public static function getSubjectModel(): string return User::class; } - public function getEmailView(): array + public function getEmailViews(): array { return [ 'text' => 'flarum-suspend::emails.plain.suspended', diff --git a/extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php b/extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php index 0d90b49194..31745dbb85 100644 --- a/extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php +++ b/extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php @@ -49,7 +49,7 @@ public static function getSubjectModel(): string return User::class; } - public function getEmailView(): array + public function getEmailViews(): array { return [ 'text' => 'flarum-suspend::emails.plain.unsuspended', diff --git a/framework/core/locale/core.yml b/framework/core/locale/core.yml index 6c6de0b9c9..d492a62dd3 100644 --- a/framework/core/locale/core.yml +++ b/framework/core/locale/core.yml @@ -727,6 +727,11 @@ core: submit_button: => core.ref.save_changes title: => core.ref.reset_your_password + # Translations in this namespace are displayed by the email unsubscribe interface. + unsubscribe_email: + title: Unsubscribe Confirmation + return_to_forum: Back to {forumTitle} + # Translations in this namespace are used in messages output by the API. api: invalid_username_message: "The username may only contain letters, numbers, and dashes." diff --git a/framework/core/src/Notification/MailableInterface.php b/framework/core/src/Notification/MailableInterface.php index b4fe61df14..68ecb7ca25 100644 --- a/framework/core/src/Notification/MailableInterface.php +++ b/framework/core/src/Notification/MailableInterface.php @@ -14,7 +14,7 @@ interface MailableInterface { /** - * Get the name of the view to construct a notification email with. + * Get the names of the views to construct a notification email with. * * To provide the best experience for the user, Flarum expects both a `text` and `html` view. * @@ -23,7 +23,7 @@ interface MailableInterface * html: string * } */ - public function getEmailView(): array; + public function getEmailViews(): array; /** * Get the subject line for a notification email. diff --git a/framework/core/src/Notification/NotificationMailer.php b/framework/core/src/Notification/NotificationMailer.php index cf64f510d9..a7701a0da6 100644 --- a/framework/core/src/Notification/NotificationMailer.php +++ b/framework/core/src/Notification/NotificationMailer.php @@ -45,7 +45,7 @@ public function send(MailableInterface $blueprint, User $user): void $settingsLink = $this->url->to('forum')->route('settings'); $this->mailer->send( - $blueprint->getEmailView(), + $blueprint->getEmailViews(), compact('blueprint', 'user', 'unsubscribeLink', 'settingsLink'), function (Message $message) use ($blueprint, $user, $unsubscribeLink) { $message->to($user->email, $user->display_name) diff --git a/framework/core/views/notification/html/base.blade.php b/framework/core/views/notification/html/base.blade.php index e45bc8f805..234fd29eaf 100644 --- a/framework/core/views/notification/html/base.blade.php +++ b/framework/core/views/notification/html/base.blade.php @@ -1,12 +1,17 @@ +@php + $primaryColor = $settings->get('theme_primary_color'); + $secondaryColor = $settings->get('theme_secondary_color'); +@endphp + - + {{ $settings->get('forum_title') }} Notification -
-

{{ $settings->get('forum_title') }} Notification

-
- @yield('content') -
-
- If you'd like to stop receiving this type of notification, unsubscribe here.
- Manage your notification settings here. -
-
+ +
+ + @yield('header') +
+ +
+ + @yield('content') +
+ +
+ + @yield('footer') +
+ diff --git a/framework/core/views/email/html/information/base.blade.php b/framework/core/views/email/html/information/base.blade.php new file mode 100644 index 0000000000..7e9a695844 --- /dev/null +++ b/framework/core/views/email/html/information/base.blade.php @@ -0,0 +1,16 @@ +@extends('flarum.forum::email.html.base') + +@section('header') + +

{{ $title ?? 'Information' }}

+@endsection + +@section('content') + +

{{ $infoContent }}

+@endsection + +@section('footer') + +

This email was sent to {{ $userEmail}} as an informational service related to your account on {{ $forumTitle }}.

+@endsection diff --git a/framework/core/views/email/html/notification/base.blade.php b/framework/core/views/email/html/notification/base.blade.php new file mode 100644 index 0000000000..79fa2fb6c1 --- /dev/null +++ b/framework/core/views/email/html/notification/base.blade.php @@ -0,0 +1,18 @@ +@extends('flarum.forum::email.html.base') + +@section('header') + +

{{ $title ?? 'Notification' }}

+@endsection + +@section('content') + + @yield('notificationContent') +@endsection + +@section('footer') + +

This email was sent to {{ $user->email }} because you are subcribed to "{{ $type }}" notifications on {{ $forumTitle }}.

+

If you'd like to stop receiving this type of notification, unsubscribe here.

+

Manage your notification settings here.

+@endsection diff --git a/framework/core/views/email/plain/base.blade.php b/framework/core/views/email/plain/base.blade.php new file mode 100644 index 0000000000..d2d1511dce --- /dev/null +++ b/framework/core/views/email/plain/base.blade.php @@ -0,0 +1,11 @@ +{{ $title ?? 'Flarum Email' }} + +--------------------- +@yield('header') +--------------------- + +@yield('content') + +--------------------- +@yield('footer') +--------------------- diff --git a/framework/core/views/email/plain/information/base.blade.php b/framework/core/views/email/plain/information/base.blade.php new file mode 100644 index 0000000000..dfcbe9c73b --- /dev/null +++ b/framework/core/views/email/plain/information/base.blade.php @@ -0,0 +1,16 @@ +@extends('flarum.forum::email.plain.base') + +@section('header') + + {{ $title ?? 'Information' }} +@endsection + +@section('content') + + {{ $infoContent }} +@endsection + +@section('footer') + + This email was sent to {{ $userEmail}} as an informational service related to your account on {{ $forumTitle }}. +@endsection diff --git a/framework/core/views/email/plain/notification/base.blade.php b/framework/core/views/email/plain/notification/base.blade.php new file mode 100644 index 0000000000..6e05acf5d9 --- /dev/null +++ b/framework/core/views/email/plain/notification/base.blade.php @@ -0,0 +1,20 @@ +@extends('flarum.forum::email.plain.base') + +@section('header') + + {{ $title ?? 'Notification' }} +@endsection + +@section('content') + + @yield('notificationContent') +@endsection + +@section('footer') + + This email was sent to {{ $user->email }} because you are subcribed to "{{ $type }}" notifications on {{ $forumTitle }}. + + If you'd like to stop receiving this type of notification, unsubscribe here: {{ $unsubscribeLink }} + + Manage your notification settings: {{ $settingsLink }} +@endsection diff --git a/framework/core/views/notification/plain/base.blade.php b/framework/core/views/notification/plain/base.blade.php deleted file mode 100644 index de2efc498c..0000000000 --- a/framework/core/views/notification/plain/base.blade.php +++ /dev/null @@ -1,11 +0,0 @@ -{{ $settings->get('forum_title') }} Notification - ---------------------------------------------------- - -@yield('content') - ---------------------------------------------------- - -If you'd like to stop receiving this type of notification, unsubscribe here: {{ $unsubscribeLink }} - -Manage your notification settings: {{ $settingsLink }} From c4c86a24a01f2d26089786ed2b055bdc5f85a33d Mon Sep 17 00:00:00 2001 From: StyleCI Bot Date: Mon, 21 Aug 2023 09:54:54 +0000 Subject: [PATCH 20/60] Apply fixes from StyleCI --- framework/core/src/User/EmailConfirmationMailer.php | 1 - framework/core/src/User/Job/RequestPasswordResetJob.php | 1 - 2 files changed, 2 deletions(-) diff --git a/framework/core/src/User/EmailConfirmationMailer.php b/framework/core/src/User/EmailConfirmationMailer.php index e56a9d4acf..185171e53a 100644 --- a/framework/core/src/User/EmailConfirmationMailer.php +++ b/framework/core/src/User/EmailConfirmationMailer.php @@ -12,7 +12,6 @@ use Flarum\Http\UrlGenerator; use Flarum\Locale\TranslatorInterface; use Flarum\Mail\Job\SendInformationalEmailJob; -use Flarum\Mail\Job\SendRawEmailJob; use Flarum\Settings\SettingsRepositoryInterface; use Flarum\User\Event\EmailChangeRequested; use Illuminate\Contracts\Queue\Queue; diff --git a/framework/core/src/User/Job/RequestPasswordResetJob.php b/framework/core/src/User/Job/RequestPasswordResetJob.php index e93faca92a..1141fd82e2 100644 --- a/framework/core/src/User/Job/RequestPasswordResetJob.php +++ b/framework/core/src/User/Job/RequestPasswordResetJob.php @@ -12,7 +12,6 @@ use Flarum\Http\UrlGenerator; use Flarum\Locale\TranslatorInterface; use Flarum\Mail\Job\SendInformationalEmailJob; -use Flarum\Mail\Job\SendRawEmailJob; use Flarum\Queue\AbstractJob; use Flarum\Settings\SettingsRepositoryInterface; use Flarum\User\PasswordToken; From 670a323fe8dd404f1c8513b084ce5f17915025df Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 21 Aug 2023 11:04:13 +0100 Subject: [PATCH 21/60] update path --- framework/core/src/Api/Controller/SendTestMailController.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/framework/core/src/Api/Controller/SendTestMailController.php b/framework/core/src/Api/Controller/SendTestMailController.php index 0d004655a8..f591aeb850 100644 --- a/framework/core/src/Api/Controller/SendTestMailController.php +++ b/framework/core/src/Api/Controller/SendTestMailController.php @@ -41,8 +41,8 @@ public function handle(ServerRequestInterface $request): ResponseInterface $this->mailer->send( [ - 'plain' => 'flarum.forum::email.information.plain.base', - 'html' => 'flarum.forum::email.information.html.base' + 'plain' => 'flarum.forum::email.plain.information.base', + 'html' => 'flarum.forum::email.html.information.base' ], compact('infoContent', 'userEmail', 'forumTitle', 'title'), function (Message $message) use ($actor) { From 900cd73790ea3b61591d22811c09ff3581479195 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 21 Aug 2023 12:35:43 +0100 Subject: [PATCH 22/60] extract greeting and handle globally --- extensions/mentions/locale/en.yml | 6 ----- extensions/subscriptions/locale/en.yml | 2 -- extensions/suspend/locale/en.yml | 4 ---- framework/core/locale/core.yml | 22 ++++++++++++------- .../Api/Controller/SendTestMailController.php | 3 ++- .../src/Notification/NotificationMailer.php | 3 ++- .../src/User/AccountActivationMailerTrait.php | 3 ++- .../core/src/User/EmailConfirmationMailer.php | 3 ++- .../core/views/email/html/base.blade.php | 9 +++++++- .../email/html/information/base.blade.php | 4 ++-- .../email/html/notification/base.blade.php | 10 ++++----- .../core/views/email/plain/base.blade.php | 2 ++ 12 files changed, 39 insertions(+), 32 deletions(-) diff --git a/extensions/mentions/locale/en.yml b/extensions/mentions/locale/en.yml index 108af93797..4c8f11aa6f 100644 --- a/extensions/mentions/locale/en.yml +++ b/extensions/mentions/locale/en.yml @@ -71,8 +71,6 @@ flarum-mentions: post_mentioned: subject: "{replier_display_name} replied to your post in {title}" body: | - Hey {recipient_display_name}! - {replier_display_name} replied to your post (#{post_number}) in {title}. {url} @@ -85,8 +83,6 @@ flarum-mentions: user_mentioned: subject: "{mentioner_display_name} mentioned you in {title}" body: | - Hey {recipient_display_name}! - {mentioner_display_name} mentioned you in a post in {title}. {url} @@ -98,8 +94,6 @@ flarum-mentions: group_mentioned: subject: "{mentioner_display_name} mentioned a group you're a member of in {title}" body: | - Hey {recipient_display_name}! - {mentioner_display_name} mentioned a group you're a member of in {title}. {url} diff --git a/extensions/subscriptions/locale/en.yml b/extensions/subscriptions/locale/en.yml index e724708fcb..a08a231e70 100644 --- a/extensions/subscriptions/locale/en.yml +++ b/extensions/subscriptions/locale/en.yml @@ -52,8 +52,6 @@ flarum-subscriptions: new_post: subject: "[New Post] {title}" body: | - Hey {recipient_display_name}! - {poster_display_name} made a post in a discussion you're following: {title}. To view the new activity, check out the following link: diff --git a/extensions/suspend/locale/en.yml b/extensions/suspend/locale/en.yml index 495c28d5f3..d7ef375ddc 100644 --- a/extensions/suspend/locale/en.yml +++ b/extensions/suspend/locale/en.yml @@ -53,8 +53,6 @@ flarum-suspend: suspended: subject: Your account has been suspended body: | - Hey {recipient_display_name}, - You have been suspended for the following reason: --- @@ -64,8 +62,6 @@ flarum-suspend: unsuspended: subject: Your account has been unsuspended body: | - Hey {recipient_display_name}, - You have been unsuspended. You can head back to the forum by clicking on the following link: {forum_url} diff --git a/framework/core/locale/core.yml b/framework/core/locale/core.yml index 649a32f9d2..855f0d9159 100644 --- a/framework/core/locale/core.yml +++ b/framework/core/locale/core.yml @@ -747,13 +747,25 @@ core: # Translations in this namespace are used in emails sent by the forum. email: + greeting: "Hey {displayName}!" + + # These translations are used by the "informational" email template. + informational: + default_title: "Information" + footer: "This email was sent to {userEmail} as an informational service related to your account on {forumTitle}."# + + # These translations are used by the "notification" email template. + notification: + default_title: "Notification" + footer: + main_text: "This email was sent to {email} because you are subscribed to \"{type}\" notifications on {forumTitle}." + unsubscribe_text: "If you'd like to stop receiving this type of notification, unsubscribe here." + settings_text: "Manage your notification settings here." # These translations are used in emails sent when users register new accounts. activate_account: subject: Activate Your New Account body: | - Hey {username}! - Someone (hopefully you!) has signed up to {forum} with this email address. If this was you, simply click the following link and your account will be activated: @@ -765,8 +777,6 @@ core: confirm_email: subject: Confirm Your New Email Address body: | - Hey {username}! - Someone (hopefully you!) has changed their email address on {forum} to this one. If this was you, simply click the following link and your email will be confirmed: @@ -778,8 +788,6 @@ core: reset_password: subject: => core.ref.reset_your_password body: | - Hey {username}! - Someone (hopefully you!) has submitted a forgotten password request for your account on {forum}. If this was you, click the following link to reset your password: @@ -791,8 +799,6 @@ core: send_test: subject: Flarum Email Test body: | - Hey {username}! - This is a test email to confirm that your Flarum email configuration is working properly. If this was you, this email means that your configuration works! diff --git a/framework/core/src/Api/Controller/SendTestMailController.php b/framework/core/src/Api/Controller/SendTestMailController.php index f591aeb850..c9112271e4 100644 --- a/framework/core/src/Api/Controller/SendTestMailController.php +++ b/framework/core/src/Api/Controller/SendTestMailController.php @@ -38,13 +38,14 @@ public function handle(ServerRequestInterface $request): ResponseInterface $title = $this->translator->trans('core.email.send_test.subject'); $forumTitle = $this->settings->get('forum_title'); $userEmail = $actor->email; + $username = $actor->display_name; $this->mailer->send( [ 'plain' => 'flarum.forum::email.plain.information.base', 'html' => 'flarum.forum::email.html.information.base' ], - compact('infoContent', 'userEmail', 'forumTitle', 'title'), + compact('infoContent', 'userEmail', 'forumTitle', 'title', 'username'), function (Message $message) use ($actor) { $message->to($actor->email); $message->subject($this->translator->trans('core.email.send_test.subject')); diff --git a/framework/core/src/Notification/NotificationMailer.php b/framework/core/src/Notification/NotificationMailer.php index a05f3acbce..9288326ce5 100644 --- a/framework/core/src/Notification/NotificationMailer.php +++ b/framework/core/src/Notification/NotificationMailer.php @@ -40,10 +40,11 @@ public function send(MailableInterface $blueprint, User $user): void $settingsLink = $this->url->to('forum')->route('settings'); $type = $blueprint::getType(); $forumTitle = $this->settings->get('forum_title'); + $username = $user->display_name; $this->mailer->send( $this->getEmailViews($blueprint), - compact('blueprint', 'user', 'unsubscribeLink', 'settingsLink', 'type', 'forumTitle'), + compact('blueprint', 'user', 'unsubscribeLink', 'settingsLink', 'type', 'forumTitle', 'username'), function (Message $message) use ($blueprint, $user) { $message->to($user->email, $user->display_name) ->subject($blueprint->getEmailSubject($this->translator)); diff --git a/framework/core/src/User/AccountActivationMailerTrait.php b/framework/core/src/User/AccountActivationMailerTrait.php index c4b9cc7692..a43e4bf30e 100644 --- a/framework/core/src/User/AccountActivationMailerTrait.php +++ b/framework/core/src/User/AccountActivationMailerTrait.php @@ -10,6 +10,7 @@ namespace Flarum\User; use Flarum\Mail\Job\SendInformationalEmailJob; +use Illuminate\Support\Arr; trait AccountActivationMailerTrait { @@ -38,6 +39,6 @@ protected function sendConfirmationEmail(User $user, array $data): void $body = $this->translator->trans('core.email.activate_account.body', $data); $subject = $this->translator->trans('core.email.activate_account.subject'); - $this->queue->push(new SendInformationalEmailJob($user->email, $subject, $body, $this->settings->get('forum_title'))); + $this->queue->push(new SendInformationalEmailJob($user->email, $subject, $body, Arr::get($data, 'forum'))); } } diff --git a/framework/core/src/User/EmailConfirmationMailer.php b/framework/core/src/User/EmailConfirmationMailer.php index 185171e53a..28b6fc990a 100644 --- a/framework/core/src/User/EmailConfirmationMailer.php +++ b/framework/core/src/User/EmailConfirmationMailer.php @@ -15,6 +15,7 @@ use Flarum\Settings\SettingsRepositoryInterface; use Flarum\User\Event\EmailChangeRequested; use Illuminate\Contracts\Queue\Queue; +use Illuminate\Support\Arr; class EmailConfirmationMailer { @@ -34,7 +35,7 @@ public function handle(EmailChangeRequested $event): void $body = $this->translator->trans('core.email.confirm_email.body', $data); $subject = $this->translator->trans('core.email.confirm_email.subject'); - $this->queue->push(new SendInformationalEmailJob($email, $subject, $body, $this->settings->get('forum_title'))); + $this->queue->push(new SendInformationalEmailJob($email, $subject, $body, Arr::get($data, 'forum'))); } protected function generateToken(User $user, string $email): EmailToken diff --git a/framework/core/views/email/html/base.blade.php b/framework/core/views/email/html/base.blade.php index 407615734f..9cb2b31497 100644 --- a/framework/core/views/email/html/base.blade.php +++ b/framework/core/views/email/html/base.blade.php @@ -1,3 +1,5 @@ +@inject('url', 'Flarum\Http\UrlGenerator') + @php $primaryColor = $settings->get('theme_primary_color'); $secondaryColor = $settings->get('theme_secondary_color'); @@ -41,7 +43,12 @@
- @yield('content') +
+ {!! $translator->trans('core.email.greeting', ['displayName' => $username]) !!} +
+
+ @yield('content') +
diff --git a/framework/core/views/email/html/information/base.blade.php b/framework/core/views/email/html/information/base.blade.php index 7e9a695844..0b378839ce 100644 --- a/framework/core/views/email/html/information/base.blade.php +++ b/framework/core/views/email/html/information/base.blade.php @@ -2,7 +2,7 @@ @section('header') -

{{ $title ?? 'Information' }}

+

{{ $title ?? $translator->trans('core.email.informational.default_title') }}

@endsection @section('content') @@ -12,5 +12,5 @@ @section('footer') -

This email was sent to {{ $userEmail}} as an informational service related to your account on {{ $forumTitle }}.

+

{!! $translator->trans('core.email.informational.footer', ['userEmail' => $userEmail, 'forumTitle' => '' . $settings->get('forum_title') . '']) !!}

@endsection diff --git a/framework/core/views/email/html/notification/base.blade.php b/framework/core/views/email/html/notification/base.blade.php index 79fa2fb6c1..336c73c0d8 100644 --- a/framework/core/views/email/html/notification/base.blade.php +++ b/framework/core/views/email/html/notification/base.blade.php @@ -2,17 +2,17 @@ @section('header') -

{{ $title ?? 'Notification' }}

+

{{ $title ?? $translator->trans('core.email.notification.default_title') }}

@endsection @section('content') - @yield('notificationContent') +

@yield('notificationContent')

@endsection @section('footer') -

This email was sent to {{ $user->email }} because you are subcribed to "{{ $type }}" notifications on {{ $forumTitle }}.

-

If you'd like to stop receiving this type of notification, unsubscribe here.

-

Manage your notification settings here.

+

{!! $translator->trans('core.email.notification.footer.main_text', ['email' => $user->email, 'type' => $type, 'forumTitle' => '' . $settings->get('forum_title') . '']) !!}

+

{!! $translator->trans('core.email.notification.footer.unsubscribe_text', ['unsubscribeLink' => $unsubscribeLink]) !!}

+

{!! $translator->trans('core.email.notification.footer.settings_text', ['settingsLink' => $settingsLink]) !!}

@endsection diff --git a/framework/core/views/email/plain/base.blade.php b/framework/core/views/email/plain/base.blade.php index d2d1511dce..e5bd47ce93 100644 --- a/framework/core/views/email/plain/base.blade.php +++ b/framework/core/views/email/plain/base.blade.php @@ -4,6 +4,8 @@ @yield('header') --------------------- +{{ $translator->trans('core.email.greeting', ['displayName' => $username]) }} + @yield('content') --------------------- From b977caa2c5bad5b50abafaf7610b8e73965500f2 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 21 Aug 2023 12:55:48 +0100 Subject: [PATCH 23/60] no need to pass displayname to translation anymore --- framework/core/src/Api/Controller/SendTestMailController.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/framework/core/src/Api/Controller/SendTestMailController.php b/framework/core/src/Api/Controller/SendTestMailController.php index c9112271e4..3764025b1e 100644 --- a/framework/core/src/Api/Controller/SendTestMailController.php +++ b/framework/core/src/Api/Controller/SendTestMailController.php @@ -33,7 +33,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface $actor = RequestUtil::getActor($request); $actor->assertAdmin(); - $infoContent = $this->translator->trans('core.email.send_test.body', ['username' => $actor->username]); + $infoContent = $this->translator->trans('core.email.send_test.body'); $title = $this->translator->trans('core.email.send_test.subject'); $forumTitle = $this->settings->get('forum_title'); From c28100551b69bd57a70c6998c9a6084af5032817 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 21 Aug 2023 12:57:53 +0100 Subject: [PATCH 24/60] dont get the forum title twice! --- framework/core/src/User/Job/RequestPasswordResetJob.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/framework/core/src/User/Job/RequestPasswordResetJob.php b/framework/core/src/User/Job/RequestPasswordResetJob.php index 1141fd82e2..68abf8369e 100644 --- a/framework/core/src/User/Job/RequestPasswordResetJob.php +++ b/framework/core/src/User/Job/RequestPasswordResetJob.php @@ -17,6 +17,7 @@ use Flarum\User\PasswordToken; use Flarum\User\UserRepository; use Illuminate\Contracts\Queue\Queue; +use Illuminate\Support\Arr; class RequestPasswordResetJob extends AbstractJob { @@ -50,6 +51,6 @@ public function handle( $body = $translator->trans('core.email.reset_password.body', $data); $subject = $translator->trans('core.email.reset_password.subject'); - $queue->push(new SendInformationalEmailJob($user->email, $subject, $body, $settings->get('forum_title'))); + $queue->push(new SendInformationalEmailJob($user->email, $subject, $body, Arr::get($data, 'forum'))); } } From 989624a49708094237e1e37274408eedf2c95814 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 21 Aug 2023 13:09:30 +0100 Subject: [PATCH 25/60] make displayname available to informational emails --- .../core/src/Mail/Job/SendInformationalEmailJob.php | 8 +++++--- framework/core/src/User/AccountActivationMailerTrait.php | 2 +- framework/core/src/User/EmailConfirmationMailer.php | 2 +- framework/core/src/User/Job/RequestPasswordResetJob.php | 9 ++++++++- 4 files changed, 15 insertions(+), 6 deletions(-) diff --git a/framework/core/src/Mail/Job/SendInformationalEmailJob.php b/framework/core/src/Mail/Job/SendInformationalEmailJob.php index b1c9afb3d0..ea1996dffd 100644 --- a/framework/core/src/Mail/Job/SendInformationalEmailJob.php +++ b/framework/core/src/Mail/Job/SendInformationalEmailJob.php @@ -17,13 +17,14 @@ class SendInformationalEmailJob extends AbstractJob { public function __construct( private readonly string $email, + private readonly string $displayName, private readonly string $subject, private readonly string $body, private readonly string $forumTitle, private readonly ?string $bodyTitle = null, protected array $views = [ - 'plain' => 'flarum.forum::email.information.plain.base', - 'html' => 'flarum.forum::email.information.html.base' + 'plain' => 'flarum.forum::email.plain.information.base', + 'html' => 'flarum.forum::email.html.information.base' ] ) { } @@ -34,10 +35,11 @@ public function handle(Mailer $mailer): void $infoContent = $this->body; $userEmail = $this->email; $title = $this->bodyTitle; + $username = $this->displayName; $mailer->send( $this->views, - compact('forumTitle', 'infoContent', 'userEmail', 'title'), + compact('forumTitle', 'infoContent', 'userEmail', 'title', 'username'), function (Message $message) { $message->to($this->email); $message->subject($this->subject); diff --git a/framework/core/src/User/AccountActivationMailerTrait.php b/framework/core/src/User/AccountActivationMailerTrait.php index a43e4bf30e..dc0f9aa6b8 100644 --- a/framework/core/src/User/AccountActivationMailerTrait.php +++ b/framework/core/src/User/AccountActivationMailerTrait.php @@ -39,6 +39,6 @@ protected function sendConfirmationEmail(User $user, array $data): void $body = $this->translator->trans('core.email.activate_account.body', $data); $subject = $this->translator->trans('core.email.activate_account.subject'); - $this->queue->push(new SendInformationalEmailJob($user->email, $subject, $body, Arr::get($data, 'forum'))); + $this->queue->push(new SendInformationalEmailJob(email: $user->email, subject: $subject, body: $body, forumTitle: Arr::get($data, 'forum'), displayName: Arr::get($data, 'username'))); } } diff --git a/framework/core/src/User/EmailConfirmationMailer.php b/framework/core/src/User/EmailConfirmationMailer.php index 28b6fc990a..1cee65bea4 100644 --- a/framework/core/src/User/EmailConfirmationMailer.php +++ b/framework/core/src/User/EmailConfirmationMailer.php @@ -35,7 +35,7 @@ public function handle(EmailChangeRequested $event): void $body = $this->translator->trans('core.email.confirm_email.body', $data); $subject = $this->translator->trans('core.email.confirm_email.subject'); - $this->queue->push(new SendInformationalEmailJob($email, $subject, $body, Arr::get($data, 'forum'))); + $this->queue->push(new SendInformationalEmailJob(email: $email, subject:$subject, body: $body, forumTitle: Arr::get($data, 'forum'), displayName: Arr::get($data, 'username'))); } protected function generateToken(User $user, string $email): EmailToken diff --git a/framework/core/src/User/Job/RequestPasswordResetJob.php b/framework/core/src/User/Job/RequestPasswordResetJob.php index 68abf8369e..d58241b81c 100644 --- a/framework/core/src/User/Job/RequestPasswordResetJob.php +++ b/framework/core/src/User/Job/RequestPasswordResetJob.php @@ -51,6 +51,13 @@ public function handle( $body = $translator->trans('core.email.reset_password.body', $data); $subject = $translator->trans('core.email.reset_password.subject'); - $queue->push(new SendInformationalEmailJob($user->email, $subject, $body, Arr::get($data, 'forum'))); + $queue->push(new SendInformationalEmailJob( + email: $user->email, + subject: $subject, + body: $body, + forumTitle: Arr::get($data, 'forum'), + displayName: Arr::get($data, 'username'), + bodyTitle: $subject + )); } } From 1325e0f15e30ecaefc91d6206605a1dc9f69e150 Mon Sep 17 00:00:00 2001 From: StyleCI Bot Date: Mon, 21 Aug 2023 12:09:50 +0000 Subject: [PATCH 26/60] Apply fixes from StyleCI --- framework/core/src/User/Job/RequestPasswordResetJob.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/framework/core/src/User/Job/RequestPasswordResetJob.php b/framework/core/src/User/Job/RequestPasswordResetJob.php index d58241b81c..fb130765b8 100644 --- a/framework/core/src/User/Job/RequestPasswordResetJob.php +++ b/framework/core/src/User/Job/RequestPasswordResetJob.php @@ -52,10 +52,10 @@ public function handle( $subject = $translator->trans('core.email.reset_password.subject'); $queue->push(new SendInformationalEmailJob( - email: $user->email, - subject: $subject, - body: $body, - forumTitle: Arr::get($data, 'forum'), + email: $user->email, + subject: $subject, + body: $body, + forumTitle: Arr::get($data, 'forum'), displayName: Arr::get($data, 'username'), bodyTitle: $subject )); From ecd99ca3834b9ea6866cd8b70cd02c61b6f568a1 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 21 Aug 2023 13:12:36 +0100 Subject: [PATCH 27/60] format --- framework/core/src/User/AccountActivationMailerTrait.php | 8 +++++++- framework/core/src/User/EmailConfirmationMailer.php | 8 +++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/framework/core/src/User/AccountActivationMailerTrait.php b/framework/core/src/User/AccountActivationMailerTrait.php index dc0f9aa6b8..2038b04580 100644 --- a/framework/core/src/User/AccountActivationMailerTrait.php +++ b/framework/core/src/User/AccountActivationMailerTrait.php @@ -39,6 +39,12 @@ protected function sendConfirmationEmail(User $user, array $data): void $body = $this->translator->trans('core.email.activate_account.body', $data); $subject = $this->translator->trans('core.email.activate_account.subject'); - $this->queue->push(new SendInformationalEmailJob(email: $user->email, subject: $subject, body: $body, forumTitle: Arr::get($data, 'forum'), displayName: Arr::get($data, 'username'))); + $this->queue->push(new SendInformationalEmailJob( + email: $user->email, + subject: $subject, + body: $body, + forumTitle: Arr::get($data, 'forum'), + displayName: Arr::get($data, 'username') + )); } } diff --git a/framework/core/src/User/EmailConfirmationMailer.php b/framework/core/src/User/EmailConfirmationMailer.php index 1cee65bea4..593e743e2d 100644 --- a/framework/core/src/User/EmailConfirmationMailer.php +++ b/framework/core/src/User/EmailConfirmationMailer.php @@ -35,7 +35,13 @@ public function handle(EmailChangeRequested $event): void $body = $this->translator->trans('core.email.confirm_email.body', $data); $subject = $this->translator->trans('core.email.confirm_email.subject'); - $this->queue->push(new SendInformationalEmailJob(email: $email, subject:$subject, body: $body, forumTitle: Arr::get($data, 'forum'), displayName: Arr::get($data, 'username'))); + $this->queue->push(new SendInformationalEmailJob( + email: $email, + subject:$subject, + body: $body, + forumTitle: Arr::get($data, 'forum'), + displayName: Arr::get($data, 'username') + )); } protected function generateToken(User $user, string $email): EmailToken From aa55d109cf4b8c059f71414b2d48dee9db84fd9d Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 21 Aug 2023 13:36:06 +0100 Subject: [PATCH 28/60] introduce translations to the plain templates (wip) --- framework/core/views/email/html/notification/base.blade.php | 2 +- framework/core/views/email/plain/information/base.blade.php | 2 +- framework/core/views/email/plain/notification/base.blade.php | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/framework/core/views/email/html/notification/base.blade.php b/framework/core/views/email/html/notification/base.blade.php index 336c73c0d8..64b5b6aff3 100644 --- a/framework/core/views/email/html/notification/base.blade.php +++ b/framework/core/views/email/html/notification/base.blade.php @@ -7,7 +7,7 @@ @section('content') -

@yield('notificationContent')

+

{!! $notificationContent !!}

@endsection @section('footer') diff --git a/framework/core/views/email/plain/information/base.blade.php b/framework/core/views/email/plain/information/base.blade.php index dfcbe9c73b..8106fdba1d 100644 --- a/framework/core/views/email/plain/information/base.blade.php +++ b/framework/core/views/email/plain/information/base.blade.php @@ -2,7 +2,7 @@ @section('header') - {{ $title ?? 'Information' }} + {{ $title ?? $translator->trans('core.email.informational.default_title') }} @endsection @section('content') diff --git a/framework/core/views/email/plain/notification/base.blade.php b/framework/core/views/email/plain/notification/base.blade.php index 6e05acf5d9..beb60ad25b 100644 --- a/framework/core/views/email/plain/notification/base.blade.php +++ b/framework/core/views/email/plain/notification/base.blade.php @@ -2,7 +2,7 @@ @section('header') - {{ $title ?? 'Notification' }} + {{ $title ?? $translator->trans('core.email.notification.default_title') }} @endsection @section('content') From f1e553ea1a4b145a278efdae3077fe23f4a1e068 Mon Sep 17 00:00:00 2001 From: StyleCI Bot Date: Mon, 21 Aug 2023 12:36:15 +0000 Subject: [PATCH 29/60] Apply fixes from StyleCI --- framework/core/src/User/EmailConfirmationMailer.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/framework/core/src/User/EmailConfirmationMailer.php b/framework/core/src/User/EmailConfirmationMailer.php index 593e743e2d..221d9e4c57 100644 --- a/framework/core/src/User/EmailConfirmationMailer.php +++ b/framework/core/src/User/EmailConfirmationMailer.php @@ -36,10 +36,10 @@ public function handle(EmailChangeRequested $event): void $subject = $this->translator->trans('core.email.confirm_email.subject'); $this->queue->push(new SendInformationalEmailJob( - email: $email, - subject:$subject, - body: $body, - forumTitle: Arr::get($data, 'forum'), + email: $email, + subject:$subject, + body: $body, + forumTitle: Arr::get($data, 'forum'), displayName: Arr::get($data, 'username') )); } From 0911f7aa3215493648a9818ffa98c4bdb9d3c1ab Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 21 Aug 2023 14:13:38 +0100 Subject: [PATCH 30/60] fix typo of plain email view --- framework/core/src/Api/Controller/SendTestMailController.php | 2 +- framework/core/src/Mail/Job/SendInformationalEmailJob.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/framework/core/src/Api/Controller/SendTestMailController.php b/framework/core/src/Api/Controller/SendTestMailController.php index 3764025b1e..8d94f837b6 100644 --- a/framework/core/src/Api/Controller/SendTestMailController.php +++ b/framework/core/src/Api/Controller/SendTestMailController.php @@ -42,7 +42,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface $this->mailer->send( [ - 'plain' => 'flarum.forum::email.plain.information.base', + 'text' => 'flarum.forum::email.plain.information.base', 'html' => 'flarum.forum::email.html.information.base' ], compact('infoContent', 'userEmail', 'forumTitle', 'title', 'username'), diff --git a/framework/core/src/Mail/Job/SendInformationalEmailJob.php b/framework/core/src/Mail/Job/SendInformationalEmailJob.php index ea1996dffd..88b3130a8d 100644 --- a/framework/core/src/Mail/Job/SendInformationalEmailJob.php +++ b/framework/core/src/Mail/Job/SendInformationalEmailJob.php @@ -23,7 +23,7 @@ public function __construct( private readonly string $forumTitle, private readonly ?string $bodyTitle = null, protected array $views = [ - 'plain' => 'flarum.forum::email.plain.information.base', + 'text' => 'flarum.forum::email.plain.information.base', 'html' => 'flarum.forum::email.html.information.base' ] ) { From 629eb9b35cded6419e3cbc75a9509d147df1cd24 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 21 Aug 2023 15:32:03 +0100 Subject: [PATCH 31/60] improve html email output readability --- .../views/emails/html/groupMentioned.blade.php | 6 +++--- .../views/emails/html/postMentioned.blade.php | 6 +++--- .../views/emails/html/userMentioned.blade.php | 6 +++--- .../views/emails/html/newPost.blade.php | 6 +++--- .../suspend/views/emails/html/suspended.blade.php | 4 ++-- .../suspend/views/emails/html/unsuspended.blade.php | 4 ++-- framework/core/views/email/html/base.blade.php | 2 +- .../views/email/html/information/base.blade.php | 2 +- .../views/email/html/notification/base.blade.php | 2 +- framework/core/views/email/plain/base.blade.php | 5 ++--- .../views/email/plain/information/base.blade.php | 9 +++------ .../views/email/plain/notification/base.blade.php | 13 +++++-------- 12 files changed, 29 insertions(+), 36 deletions(-) diff --git a/extensions/mentions/views/emails/html/groupMentioned.blade.php b/extensions/mentions/views/emails/html/groupMentioned.blade.php index 08d96aec77..7615e05fcf 100644 --- a/extensions/mentions/views/emails/html/groupMentioned.blade.php +++ b/extensions/mentions/views/emails/html/groupMentioned.blade.php @@ -1,11 +1,11 @@ @extends('flarum.forum::email.html.notification.base') -@section('content') -{!! $translator->trans('flarum-mentions.email.group_mentioned.body', [ +@section('notificationContent') +{!! nl2br(e($translator->trans('flarum-mentions.email.group_mentioned.body', [ '{recipient_display_name}' => $user->display_name, '{mentioner_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), '{content}' => $blueprint->post->content -]) !!} +]))) !!} @endsection diff --git a/extensions/mentions/views/emails/html/postMentioned.blade.php b/extensions/mentions/views/emails/html/postMentioned.blade.php index a39a35de6a..52bc78fd9c 100644 --- a/extensions/mentions/views/emails/html/postMentioned.blade.php +++ b/extensions/mentions/views/emails/html/postMentioned.blade.php @@ -1,12 +1,12 @@ @extends('flarum.forum::email.html.notification.base') -@section('content') -{!! $translator->trans('flarum-mentions.email.post_mentioned.body', [ +@section('notificationContent') +{!! nl2br(e($translator->trans('flarum-mentions.email.post_mentioned.body', [ '{recipient_display_name}' => $user->display_name, '{replier_display_name}' => $blueprint->reply->user->display_name, '{post_number}' => $blueprint->post->number, '{title}' => $blueprint->post->discussion->title, '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->reply->discussion_id, 'near' => $blueprint->reply->number]), '{content}' => $blueprint->reply->content -]) !!} +]))) !!} @endsection diff --git a/extensions/mentions/views/emails/html/userMentioned.blade.php b/extensions/mentions/views/emails/html/userMentioned.blade.php index 921824fe2e..a932f3cf24 100644 --- a/extensions/mentions/views/emails/html/userMentioned.blade.php +++ b/extensions/mentions/views/emails/html/userMentioned.blade.php @@ -1,11 +1,11 @@ @extends('flarum.forum::email.html.notification.base') -@section('content') -{!! $translator->trans('flarum-mentions.email.user_mentioned.body', [ +@section('notificationContent') +{!! nl2br(e($translator->trans('flarum-mentions.email.user_mentioned.body', [ '{recipient_display_name}' => $user->display_name, '{mentioner_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), '{content}' => $blueprint->post->content -]) !!} +]))) !!} @endsection diff --git a/extensions/subscriptions/views/emails/html/newPost.blade.php b/extensions/subscriptions/views/emails/html/newPost.blade.php index 50db4b921d..b8277998dd 100644 --- a/extensions/subscriptions/views/emails/html/newPost.blade.php +++ b/extensions/subscriptions/views/emails/html/newPost.blade.php @@ -1,11 +1,11 @@ @extends('flarum.forum::email.html.notification.base') -@section('content') -{!! $translator->trans('flarum-subscriptions.email.new_post.body', [ +@section('notificationContent') +{!! nl2br(e($translator->trans('flarum-subscriptions.email.new_post.body', [ '{recipient_display_name}' => $user->display_name, '{poster_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), '{content}' => $blueprint->post->content -]) !!} +]))) !!} @endsection diff --git a/extensions/suspend/views/emails/html/suspended.blade.php b/extensions/suspend/views/emails/html/suspended.blade.php index 832416a464..1a65dffafd 100644 --- a/extensions/suspend/views/emails/html/suspended.blade.php +++ b/extensions/suspend/views/emails/html/suspended.blade.php @@ -1,8 +1,8 @@ @extends('flarum.forum::email.html.information.base') @section('content') -{!! $translator->trans('flarum-suspend.email.suspended.body', [ +{!! nl2br(e($translator->trans('flarum-suspend.email.suspended.body', [ '{recipient_display_name}' => $user->display_name, '{suspension_message}' => $blueprint->user->suspend_message ?? $translator->trans('flarum-suspend.email.no_reason_given'), -]) !!} +]))) !!} @endsection diff --git a/extensions/suspend/views/emails/html/unsuspended.blade.php b/extensions/suspend/views/emails/html/unsuspended.blade.php index 41669ca7f2..e3ca47637a 100644 --- a/extensions/suspend/views/emails/html/unsuspended.blade.php +++ b/extensions/suspend/views/emails/html/unsuspended.blade.php @@ -1,8 +1,8 @@ @extends('flarum.forum::email.html.information.base') @section('content') -{!! $translator->trans('flarum-suspend.email.unsuspended.body', [ +{!! nl2br(e($translator->trans('flarum-suspend.email.unsuspended.body', [ '{recipient_display_name}' => $user->display_name, '{forum_url}' => $url->to('forum')->base(), -]) !!} +]))) !!} @endsection diff --git a/framework/core/views/email/html/base.blade.php b/framework/core/views/email/html/base.blade.php index 9cb2b31497..5924549126 100644 --- a/framework/core/views/email/html/base.blade.php +++ b/framework/core/views/email/html/base.blade.php @@ -44,7 +44,7 @@
- {!! $translator->trans('core.email.greeting', ['displayName' => $username]) !!} +

{!! $translator->trans('core.email.greeting', ['displayName' => $username]) !!}

@yield('content') diff --git a/framework/core/views/email/html/information/base.blade.php b/framework/core/views/email/html/information/base.blade.php index 0b378839ce..c1f999bc16 100644 --- a/framework/core/views/email/html/information/base.blade.php +++ b/framework/core/views/email/html/information/base.blade.php @@ -7,7 +7,7 @@ @section('content') -

{{ $infoContent }}

+

{!! nl2br(e($infoContent)) !!}

@endsection @section('footer') diff --git a/framework/core/views/email/html/notification/base.blade.php b/framework/core/views/email/html/notification/base.blade.php index 64b5b6aff3..b526bab7d6 100644 --- a/framework/core/views/email/html/notification/base.blade.php +++ b/framework/core/views/email/html/notification/base.blade.php @@ -7,7 +7,7 @@ @section('content') -

{!! $notificationContent !!}

+ @yield('notificationContent') @endsection @section('footer') diff --git a/framework/core/views/email/plain/base.blade.php b/framework/core/views/email/plain/base.blade.php index e5bd47ce93..3cc6ba9b17 100644 --- a/framework/core/views/email/plain/base.blade.php +++ b/framework/core/views/email/plain/base.blade.php @@ -1,6 +1,3 @@ -{{ $title ?? 'Flarum Email' }} - ---------------------- @yield('header') --------------------- @@ -9,5 +6,7 @@ @yield('content') --------------------- + @yield('footer') + --------------------- diff --git a/framework/core/views/email/plain/information/base.blade.php b/framework/core/views/email/plain/information/base.blade.php index 8106fdba1d..b3f2d53b24 100644 --- a/framework/core/views/email/plain/information/base.blade.php +++ b/framework/core/views/email/plain/information/base.blade.php @@ -1,16 +1,13 @@ @extends('flarum.forum::email.plain.base') @section('header') - - {{ $title ?? $translator->trans('core.email.informational.default_title') }} +{{ $title ?? $translator->trans('core.email.informational.default_title') }} @endsection @section('content') - - {{ $infoContent }} +{{ $infoContent }} @endsection @section('footer') - - This email was sent to {{ $userEmail}} as an informational service related to your account on {{ $forumTitle }}. +This email was sent to {{ $userEmail}} as an informational service related to your account on {{ $forumTitle }}. @endsection diff --git a/framework/core/views/email/plain/notification/base.blade.php b/framework/core/views/email/plain/notification/base.blade.php index beb60ad25b..1aeea526cd 100644 --- a/framework/core/views/email/plain/notification/base.blade.php +++ b/framework/core/views/email/plain/notification/base.blade.php @@ -1,20 +1,17 @@ @extends('flarum.forum::email.plain.base') @section('header') - - {{ $title ?? $translator->trans('core.email.notification.default_title') }} +{{ $title ?? $translator->trans('core.email.notification.default_title') }} @endsection @section('content') - - @yield('notificationContent') +@yield('notificationContent') @endsection @section('footer') - - This email was sent to {{ $user->email }} because you are subcribed to "{{ $type }}" notifications on {{ $forumTitle }}. +This email was sent to {{ $user->email }} because you are subcribed to "{{ $type }}" notifications on {{ $forumTitle }}. - If you'd like to stop receiving this type of notification, unsubscribe here: {{ $unsubscribeLink }} +If you'd like to stop receiving this type of notification, unsubscribe here: {{ $unsubscribeLink }} - Manage your notification settings: {{ $settingsLink }} +Manage your notification settings: {{ $settingsLink }} @endsection From 98242c68d7adc3947d8328045c97dc4109893a8a Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 21 Aug 2023 16:45:30 +0100 Subject: [PATCH 32/60] Begin breaking down html templates to allow for better control of the content --- .../src/Notification/GroupMentionedBlueprint.php | 3 +++ .../src/Notification/PostMentionedBlueprint.php | 3 +++ .../src/Notification/UserMentionedBlueprint.php | 3 +++ .../views/emails/html/groupMentioned.blade.php | 4 ++++ .../views/emails/html/postMentioned.blade.php | 4 ++++ .../views/emails/html/userMentioned.blade.php | 5 ++++- .../views/emails/plain/userMentioned.blade.php | 1 - .../src/Notification/NewPostBlueprint.php | 3 +++ .../views/emails/html/newPost.blade.php | 4 ++++ .../core/src/Notification/ContentRenderer.php | 13 +++++++++++++ .../core/src/Notification/NotificationMailer.php | 1 + .../core/src/Notification/RendersContent.php | 15 +++++++++++++++ framework/core/views/email/html/base.blade.php | 7 +++++++ .../views/email/html/notification/base.blade.php | 3 +++ 14 files changed, 67 insertions(+), 2 deletions(-) create mode 100644 framework/core/src/Notification/ContentRenderer.php create mode 100644 framework/core/src/Notification/RendersContent.php diff --git a/extensions/mentions/src/Notification/GroupMentionedBlueprint.php b/extensions/mentions/src/Notification/GroupMentionedBlueprint.php index f70c9f4851..4a6f90aded 100644 --- a/extensions/mentions/src/Notification/GroupMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/GroupMentionedBlueprint.php @@ -13,11 +13,14 @@ use Flarum\Locale\TranslatorInterface; use Flarum\Notification\Blueprint\BlueprintInterface; use Flarum\Notification\MailableInterface; +use Flarum\Notification\RendersContent; use Flarum\Post\Post; use Flarum\User\User; class GroupMentionedBlueprint implements BlueprintInterface, MailableInterface { + use RendersContent; + public function __construct( public Post $post ) { diff --git a/extensions/mentions/src/Notification/PostMentionedBlueprint.php b/extensions/mentions/src/Notification/PostMentionedBlueprint.php index 81594d8d9a..915dcfc119 100644 --- a/extensions/mentions/src/Notification/PostMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/PostMentionedBlueprint.php @@ -13,11 +13,14 @@ use Flarum\Locale\TranslatorInterface; use Flarum\Notification\Blueprint\BlueprintInterface; use Flarum\Notification\MailableInterface; +use Flarum\Notification\RendersContent; use Flarum\Post\Post; use Flarum\User\User; class PostMentionedBlueprint implements BlueprintInterface, MailableInterface { + use RendersContent; + public function __construct( public Post $post, public Post $reply diff --git a/extensions/mentions/src/Notification/UserMentionedBlueprint.php b/extensions/mentions/src/Notification/UserMentionedBlueprint.php index acdf2ab6fe..08314604e0 100644 --- a/extensions/mentions/src/Notification/UserMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/UserMentionedBlueprint.php @@ -13,11 +13,14 @@ use Flarum\Locale\TranslatorInterface; use Flarum\Notification\Blueprint\BlueprintInterface; use Flarum\Notification\MailableInterface; +use Flarum\Notification\RendersContent; use Flarum\Post\Post; use Flarum\User\User; class UserMentionedBlueprint implements BlueprintInterface, MailableInterface { + use RendersContent; + public function __construct( public Post $post ) { diff --git a/extensions/mentions/views/emails/html/groupMentioned.blade.php b/extensions/mentions/views/emails/html/groupMentioned.blade.php index 7615e05fcf..78f34bf3e2 100644 --- a/extensions/mentions/views/emails/html/groupMentioned.blade.php +++ b/extensions/mentions/views/emails/html/groupMentioned.blade.php @@ -9,3 +9,7 @@ '{content}' => $blueprint->post->content ]))) !!} @endsection + +@section('contentPreview') + {!! $blueprint->renderContent($blueprint->post->content) !!} +@endsection diff --git a/extensions/mentions/views/emails/html/postMentioned.blade.php b/extensions/mentions/views/emails/html/postMentioned.blade.php index 52bc78fd9c..eceafbbf05 100644 --- a/extensions/mentions/views/emails/html/postMentioned.blade.php +++ b/extensions/mentions/views/emails/html/postMentioned.blade.php @@ -10,3 +10,7 @@ '{content}' => $blueprint->reply->content ]))) !!} @endsection + +@section('contentPreview') + {!! $blueprint->renderContent($blueprint->reply->content) !!} +@endsection diff --git a/extensions/mentions/views/emails/html/userMentioned.blade.php b/extensions/mentions/views/emails/html/userMentioned.blade.php index a932f3cf24..bf7665b8b5 100644 --- a/extensions/mentions/views/emails/html/userMentioned.blade.php +++ b/extensions/mentions/views/emails/html/userMentioned.blade.php @@ -2,10 +2,13 @@ @section('notificationContent') {!! nl2br(e($translator->trans('flarum-mentions.email.user_mentioned.body', [ -'{recipient_display_name}' => $user->display_name, '{mentioner_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), '{content}' => $blueprint->post->content ]))) !!} @endsection + +@section('contentPreview') + {!! $blueprint->renderContent($blueprint->post->content) !!} +@endsection diff --git a/extensions/mentions/views/emails/plain/userMentioned.blade.php b/extensions/mentions/views/emails/plain/userMentioned.blade.php index e03aef5b50..0842928a1c 100644 --- a/extensions/mentions/views/emails/plain/userMentioned.blade.php +++ b/extensions/mentions/views/emails/plain/userMentioned.blade.php @@ -2,7 +2,6 @@ @section('content') {!! $translator->trans('flarum-mentions.email.user_mentioned.body', [ -'{recipient_display_name}' => $user->display_name, '{mentioner_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), diff --git a/extensions/subscriptions/src/Notification/NewPostBlueprint.php b/extensions/subscriptions/src/Notification/NewPostBlueprint.php index e96c803ddb..4066bf3401 100644 --- a/extensions/subscriptions/src/Notification/NewPostBlueprint.php +++ b/extensions/subscriptions/src/Notification/NewPostBlueprint.php @@ -14,11 +14,14 @@ use Flarum\Locale\TranslatorInterface; use Flarum\Notification\Blueprint\BlueprintInterface; use Flarum\Notification\MailableInterface; +use Flarum\Notification\RendersContent; use Flarum\Post\Post; use Flarum\User\User; class NewPostBlueprint implements BlueprintInterface, MailableInterface { + use RendersContent; + public function __construct( public Post $post ) { diff --git a/extensions/subscriptions/views/emails/html/newPost.blade.php b/extensions/subscriptions/views/emails/html/newPost.blade.php index b8277998dd..2475864f79 100644 --- a/extensions/subscriptions/views/emails/html/newPost.blade.php +++ b/extensions/subscriptions/views/emails/html/newPost.blade.php @@ -9,3 +9,7 @@ '{content}' => $blueprint->post->content ]))) !!} @endsection + +@section('contentPreview') + {!! $blueprint->renderContent($blueprint->post->content) !!} +@endsection diff --git a/framework/core/src/Notification/ContentRenderer.php b/framework/core/src/Notification/ContentRenderer.php new file mode 100644 index 0000000000..31c5f5d220 --- /dev/null +++ b/framework/core/src/Notification/ContentRenderer.php @@ -0,0 +1,13 @@ +renderer->render($content); + } +} diff --git a/framework/core/views/email/html/base.blade.php b/framework/core/views/email/html/base.blade.php index 5924549126..3c0919491b 100644 --- a/framework/core/views/email/html/base.blade.php +++ b/framework/core/views/email/html/base.blade.php @@ -32,6 +32,13 @@ font-size: 12px; color: #777; } + .content-preview { + background-color: #f7f7f7; /* Light gray background */ + padding: 15px; + margin: 15px 0; + border: 1px solid #e1e1e1; + border-radius: 5px; +} diff --git a/framework/core/views/email/html/notification/base.blade.php b/framework/core/views/email/html/notification/base.blade.php index b526bab7d6..d5e1e2d969 100644 --- a/framework/core/views/email/html/notification/base.blade.php +++ b/framework/core/views/email/html/notification/base.blade.php @@ -8,6 +8,9 @@ @section('content') @yield('notificationContent') +
+ @yield('contentPreview') +
@endsection @section('footer') From 0ea64f7e7fc4c47255ec361e5c4c80f1f95fa78a Mon Sep 17 00:00:00 2001 From: StyleCI Bot Date: Mon, 21 Aug 2023 15:45:42 +0000 Subject: [PATCH 33/60] Apply fixes from StyleCI --- .../mentions/src/Notification/GroupMentionedBlueprint.php | 2 +- .../mentions/src/Notification/PostMentionedBlueprint.php | 2 +- .../mentions/src/Notification/UserMentionedBlueprint.php | 2 +- .../subscriptions/src/Notification/NewPostBlueprint.php | 2 +- framework/core/src/Notification/ContentRenderer.php | 7 +++++++ framework/core/src/Notification/NotificationMailer.php | 1 - framework/core/src/Notification/RendersContent.php | 7 +++++++ 7 files changed, 18 insertions(+), 5 deletions(-) diff --git a/extensions/mentions/src/Notification/GroupMentionedBlueprint.php b/extensions/mentions/src/Notification/GroupMentionedBlueprint.php index 4a6f90aded..9323ae6cd9 100644 --- a/extensions/mentions/src/Notification/GroupMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/GroupMentionedBlueprint.php @@ -20,7 +20,7 @@ class GroupMentionedBlueprint implements BlueprintInterface, MailableInterface { use RendersContent; - + public function __construct( public Post $post ) { diff --git a/extensions/mentions/src/Notification/PostMentionedBlueprint.php b/extensions/mentions/src/Notification/PostMentionedBlueprint.php index 915dcfc119..4f16bd10cb 100644 --- a/extensions/mentions/src/Notification/PostMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/PostMentionedBlueprint.php @@ -20,7 +20,7 @@ class PostMentionedBlueprint implements BlueprintInterface, MailableInterface { use RendersContent; - + public function __construct( public Post $post, public Post $reply diff --git a/extensions/mentions/src/Notification/UserMentionedBlueprint.php b/extensions/mentions/src/Notification/UserMentionedBlueprint.php index 08314604e0..5f2f6bb72c 100644 --- a/extensions/mentions/src/Notification/UserMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/UserMentionedBlueprint.php @@ -20,7 +20,7 @@ class UserMentionedBlueprint implements BlueprintInterface, MailableInterface { use RendersContent; - + public function __construct( public Post $post ) { diff --git a/extensions/subscriptions/src/Notification/NewPostBlueprint.php b/extensions/subscriptions/src/Notification/NewPostBlueprint.php index 4066bf3401..001249e99f 100644 --- a/extensions/subscriptions/src/Notification/NewPostBlueprint.php +++ b/extensions/subscriptions/src/Notification/NewPostBlueprint.php @@ -21,7 +21,7 @@ class NewPostBlueprint implements BlueprintInterface, MailableInterface { use RendersContent; - + public function __construct( public Post $post ) { diff --git a/framework/core/src/Notification/ContentRenderer.php b/framework/core/src/Notification/ContentRenderer.php index 31c5f5d220..a8ca387d80 100644 --- a/framework/core/src/Notification/ContentRenderer.php +++ b/framework/core/src/Notification/ContentRenderer.php @@ -1,5 +1,12 @@ Date: Mon, 21 Aug 2023 21:47:11 +0100 Subject: [PATCH 34/60] allow config.php to specify outgoing mail format --- framework/core/src/Foundation/Mailer.php | 39 +++++++++++++++++++ .../core/src/Mail/MailServiceProvider.php | 6 ++- 2 files changed, 43 insertions(+), 2 deletions(-) create mode 100644 framework/core/src/Foundation/Mailer.php diff --git a/framework/core/src/Foundation/Mailer.php b/framework/core/src/Foundation/Mailer.php new file mode 100644 index 0000000000..987a8c80d6 --- /dev/null +++ b/framework/core/src/Foundation/Mailer.php @@ -0,0 +1,39 @@ +config['email_format'] ?? 'multipart'; + + switch ($emailType) { + case 'html': + unset($view['text']); + break; + case 'text': + unset($view['html']); + break; + // case 'multipart' is the default, where Flarum will send both HTML and text versions of emails, so that the recipient's email client can choose which one to display. + } + + parent::send($view, $data, $callback); + } +} diff --git a/framework/core/src/Mail/MailServiceProvider.php b/framework/core/src/Mail/MailServiceProvider.php index 3244a06856..4a47e012dd 100644 --- a/framework/core/src/Mail/MailServiceProvider.php +++ b/framework/core/src/Mail/MailServiceProvider.php @@ -10,11 +10,12 @@ namespace Flarum\Mail; use Flarum\Foundation\AbstractServiceProvider; +use Flarum\Foundation\Config; +use Flarum\Foundation\Mailer; use Flarum\Settings\SettingsRepositoryInterface; use Illuminate\Contracts\Container\Container; use Illuminate\Contracts\Mail\Mailer as MailerContract; use Illuminate\Contracts\Validation\Factory; -use Illuminate\Mail\Mailer; use Illuminate\Support\Arr; use Symfony\Component\Mailer\Transport\TransportInterface; @@ -66,7 +67,8 @@ public function register(): void 'flarum', $container['view'], $container['symfony.mailer.transport'], - $container['events'] + $container['events'], + $container->make(Config::class) ); if ($container->bound('queue')) { From 2971e01a1bdb776f8c4e27ff2d08eae945059e0a Mon Sep 17 00:00:00 2001 From: StyleCI Bot Date: Mon, 21 Aug 2023 20:47:30 +0000 Subject: [PATCH 35/60] Apply fixes from StyleCI --- framework/core/src/Foundation/Mailer.php | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/framework/core/src/Foundation/Mailer.php b/framework/core/src/Foundation/Mailer.php index 987a8c80d6..9e1420ff8c 100644 --- a/framework/core/src/Foundation/Mailer.php +++ b/framework/core/src/Foundation/Mailer.php @@ -1,5 +1,12 @@ Date: Mon, 21 Aug 2023 22:14:11 +0100 Subject: [PATCH 36/60] add email signoff translation --- framework/core/locale/core.yml | 1 + framework/core/views/email/html/base.blade.php | 9 ++++++++- framework/core/views/email/plain/base.blade.php | 8 ++++---- 3 files changed, 13 insertions(+), 5 deletions(-) diff --git a/framework/core/locale/core.yml b/framework/core/locale/core.yml index 855f0d9159..1b619f8e97 100644 --- a/framework/core/locale/core.yml +++ b/framework/core/locale/core.yml @@ -748,6 +748,7 @@ core: # Translations in this namespace are used in emails sent by the forum. email: greeting: "Hey {displayName}!" + signoff: "{forumTitle} team" # These translations are used by the "informational" email template. informational: diff --git a/framework/core/views/email/html/base.blade.php b/framework/core/views/email/html/base.blade.php index 3c0919491b..bf99b0faee 100644 --- a/framework/core/views/email/html/base.blade.php +++ b/framework/core/views/email/html/base.blade.php @@ -38,7 +38,11 @@ margin: 15px 0; border: 1px solid #e1e1e1; border-radius: 5px; -} + } + .signoff { + margin-top: 20px; + font-style: italic; + } @@ -56,6 +60,9 @@
@yield('content')
+
+

{!! $translator->trans('core.email.signoff', ['forumTitle' => $settings->get('forum_title')]) !!}

+
diff --git a/framework/core/views/email/plain/base.blade.php b/framework/core/views/email/plain/base.blade.php index 3cc6ba9b17..1bc040a72f 100644 --- a/framework/core/views/email/plain/base.blade.php +++ b/framework/core/views/email/plain/base.blade.php @@ -1,12 +1,12 @@ @yield('header') ---------------------- + {{ $translator->trans('core.email.greeting', ['displayName' => $username]) }} @yield('content') ---------------------- +- {{ $translator->trans('core.email.signoff', ['forumTitle' => $settings->get('forum_title')]) }} - -@yield('footer') ---------------------- + +@yield('footer') From d2f3977afbf67d787aa122a8c6c4befbb76bd15f Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 21 Aug 2023 22:32:25 +0100 Subject: [PATCH 37/60] fix renderer issues --- .../core/src/Notification/ContentRenderer.php | 20 ------------------- .../core/src/Notification/RendersContent.php | 8 +++----- 2 files changed, 3 insertions(+), 25 deletions(-) delete mode 100644 framework/core/src/Notification/ContentRenderer.php diff --git a/framework/core/src/Notification/ContentRenderer.php b/framework/core/src/Notification/ContentRenderer.php deleted file mode 100644 index a8ca387d80..0000000000 --- a/framework/core/src/Notification/ContentRenderer.php +++ /dev/null @@ -1,20 +0,0 @@ -renderer->render($content); + return Fatdown::render(Fatdown::parse($content)); } } From 87d41112ee031d152a310c211c55203223c8117b Mon Sep 17 00:00:00 2001 From: IanM Date: Wed, 13 Sep 2023 09:46:31 +0100 Subject: [PATCH 38/60] Include forum logo in html base template, if it's available --- framework/core/views/email/html/base.blade.php | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/framework/core/views/email/html/base.blade.php b/framework/core/views/email/html/base.blade.php index bf99b0faee..cab4e964ae 100644 --- a/framework/core/views/email/html/base.blade.php +++ b/framework/core/views/email/html/base.blade.php @@ -48,12 +48,19 @@
- +
+ + @if ($settings->get('logo_path')) + + @else + {{ $settings->get('forum_title') }} + @endif + +
@yield('header')
-

{!! $translator->trans('core.email.greeting', ['displayName' => $username]) !!}

@@ -66,7 +73,6 @@
- @yield('footer')
From feff34c7b11abe581f48625c226e096ee338d4c8 Mon Sep 17 00:00:00 2001 From: IanM Date: Wed, 13 Sep 2023 14:20:52 +0100 Subject: [PATCH 39/60] Update html notification templates --- extensions/mentions/locale/en.yml | 39 ++++++++++++------- .../Notification/GroupMentionedBlueprint.php | 3 -- .../Notification/PostMentionedBlueprint.php | 3 -- .../Notification/UserMentionedBlueprint.php | 3 -- .../emails/html/groupMentioned.blade.php | 9 ++--- .../views/emails/html/postMentioned.blade.php | 9 ++--- .../views/emails/html/userMentioned.blade.php | 9 ++--- .../emails/plain/groupMentioned.blade.php | 2 +- .../emails/plain/postMentioned.blade.php | 2 +- .../emails/plain/userMentioned.blade.php | 2 +- extensions/subscriptions/locale/en.yml | 22 +++++++---- .../src/Notification/NewPostBlueprint.php | 3 -- .../views/emails/html/newPost.blade.php | 9 ++--- .../views/emails/plain/newPost.blade.php | 2 +- extensions/suspend/locale/en.yml | 22 +++++++---- .../views/emails/html/suspended.blade.php | 10 +++-- .../views/emails/html/unsuspended.blade.php | 5 ++- .../views/emails/plain/suspended.blade.php | 2 +- .../views/emails/plain/unsuspended.blade.php | 2 +- framework/core/locale/core.yml | 6 ++- framework/core/src/Formatter/HtmlRenderer.php | 18 +++++++++ .../core/src/Forum/ForumServiceProvider.php | 4 +- .../src/Notification/NotificationMailer.php | 3 +- .../core/src/Notification/RendersContent.php | 20 ---------- .../email/html/information/base.blade.php | 8 ++-- .../email/html/notification/base.blade.php | 3 -- .../email/plain/information/base.blade.php | 2 +- .../email/plain/notification/base.blade.php | 6 +-- 28 files changed, 119 insertions(+), 109 deletions(-) create mode 100644 framework/core/src/Formatter/HtmlRenderer.php delete mode 100644 framework/core/src/Notification/RendersContent.php diff --git a/extensions/mentions/locale/en.yml b/extensions/mentions/locale/en.yml index 4c8f11aa6f..1de7ed530b 100644 --- a/extensions/mentions/locale/en.yml +++ b/extensions/mentions/locale/en.yml @@ -70,34 +70,43 @@ flarum-mentions: # These translations are used in emails sent when a post is replied to post_mentioned: subject: "{replier_display_name} replied to your post in {title}" - body: | - {replier_display_name} replied to your post (#{post_number}) in {title}. + plain: + body: | + {replier_display_name} replied to your post (#{post_number}) in {title}. - {url} + {url} - --- + --- - {content} + {content} + html: + body: "{replier_display_name} replied to your post (#{post_number}) in [{title}]({url})." # These translations are used in emails sent when a user is mentioned user_mentioned: subject: "{mentioner_display_name} mentioned you in {title}" - body: | - {mentioner_display_name} mentioned you in a post in {title}. + plain: + body: | + {mentioner_display_name} mentioned you in a post in {title}. - {url} + {url} - --- + --- - {content} + {content} + html: + body: "{mentioner_display_name} mentioned you in a post in [{title}]({url})." # These translations are used in emails sent when a group is mentioned group_mentioned: subject: "{mentioner_display_name} mentioned a group you're a member of in {title}" - body: | - {mentioner_display_name} mentioned a group you're a member of in {title}. + plain: + body: | + {mentioner_display_name} mentioned a group you're a member of in {title}. - {url} + {url} - --- + --- - {content} + {content} + html: + body: "{mentioner_display_name} mentioned a group you're a member of in [{title}]({url})." diff --git a/extensions/mentions/src/Notification/GroupMentionedBlueprint.php b/extensions/mentions/src/Notification/GroupMentionedBlueprint.php index 9323ae6cd9..f70c9f4851 100644 --- a/extensions/mentions/src/Notification/GroupMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/GroupMentionedBlueprint.php @@ -13,14 +13,11 @@ use Flarum\Locale\TranslatorInterface; use Flarum\Notification\Blueprint\BlueprintInterface; use Flarum\Notification\MailableInterface; -use Flarum\Notification\RendersContent; use Flarum\Post\Post; use Flarum\User\User; class GroupMentionedBlueprint implements BlueprintInterface, MailableInterface { - use RendersContent; - public function __construct( public Post $post ) { diff --git a/extensions/mentions/src/Notification/PostMentionedBlueprint.php b/extensions/mentions/src/Notification/PostMentionedBlueprint.php index 4f16bd10cb..81594d8d9a 100644 --- a/extensions/mentions/src/Notification/PostMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/PostMentionedBlueprint.php @@ -13,14 +13,11 @@ use Flarum\Locale\TranslatorInterface; use Flarum\Notification\Blueprint\BlueprintInterface; use Flarum\Notification\MailableInterface; -use Flarum\Notification\RendersContent; use Flarum\Post\Post; use Flarum\User\User; class PostMentionedBlueprint implements BlueprintInterface, MailableInterface { - use RendersContent; - public function __construct( public Post $post, public Post $reply diff --git a/extensions/mentions/src/Notification/UserMentionedBlueprint.php b/extensions/mentions/src/Notification/UserMentionedBlueprint.php index 5f2f6bb72c..acdf2ab6fe 100644 --- a/extensions/mentions/src/Notification/UserMentionedBlueprint.php +++ b/extensions/mentions/src/Notification/UserMentionedBlueprint.php @@ -13,14 +13,11 @@ use Flarum\Locale\TranslatorInterface; use Flarum\Notification\Blueprint\BlueprintInterface; use Flarum\Notification\MailableInterface; -use Flarum\Notification\RendersContent; use Flarum\Post\Post; use Flarum\User\User; class UserMentionedBlueprint implements BlueprintInterface, MailableInterface { - use RendersContent; - public function __construct( public Post $post ) { diff --git a/extensions/mentions/views/emails/html/groupMentioned.blade.php b/extensions/mentions/views/emails/html/groupMentioned.blade.php index 78f34bf3e2..f8328f0724 100644 --- a/extensions/mentions/views/emails/html/groupMentioned.blade.php +++ b/extensions/mentions/views/emails/html/groupMentioned.blade.php @@ -1,15 +1,14 @@ @extends('flarum.forum::email.html.notification.base') @section('notificationContent') -{!! nl2br(e($translator->trans('flarum-mentions.email.group_mentioned.body', [ +{!! $html->render($translator->trans('flarum-mentions.email.group_mentioned.html.body', [ '{recipient_display_name}' => $user->display_name, '{mentioner_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, -'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), -'{content}' => $blueprint->post->content -]))) !!} +'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]) +])) !!} @endsection @section('contentPreview') - {!! $blueprint->renderContent($blueprint->post->content) !!} + {!! $html->render($blueprint->post->content) !!} @endsection diff --git a/extensions/mentions/views/emails/html/postMentioned.blade.php b/extensions/mentions/views/emails/html/postMentioned.blade.php index eceafbbf05..2d5d13c476 100644 --- a/extensions/mentions/views/emails/html/postMentioned.blade.php +++ b/extensions/mentions/views/emails/html/postMentioned.blade.php @@ -1,16 +1,15 @@ @extends('flarum.forum::email.html.notification.base') @section('notificationContent') -{!! nl2br(e($translator->trans('flarum-mentions.email.post_mentioned.body', [ +{!! $html->render($translator->trans('flarum-mentions.email.post_mentioned.html.body', [ '{recipient_display_name}' => $user->display_name, '{replier_display_name}' => $blueprint->reply->user->display_name, '{post_number}' => $blueprint->post->number, '{title}' => $blueprint->post->discussion->title, -'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->reply->discussion_id, 'near' => $blueprint->reply->number]), -'{content}' => $blueprint->reply->content -]))) !!} +'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->reply->discussion_id, 'near' => $blueprint->reply->number]) +])) !!} @endsection @section('contentPreview') - {!! $blueprint->renderContent($blueprint->reply->content) !!} + {!! $html->render($blueprint->reply->content) !!} @endsection diff --git a/extensions/mentions/views/emails/html/userMentioned.blade.php b/extensions/mentions/views/emails/html/userMentioned.blade.php index bf7665b8b5..5d0614680b 100644 --- a/extensions/mentions/views/emails/html/userMentioned.blade.php +++ b/extensions/mentions/views/emails/html/userMentioned.blade.php @@ -1,14 +1,13 @@ @extends('flarum.forum::email.html.notification.base') @section('notificationContent') -{!! nl2br(e($translator->trans('flarum-mentions.email.user_mentioned.body', [ +{!! $html->render($translator->trans('flarum-mentions.email.user_mentioned.html.body', [ '{mentioner_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, -'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), -'{content}' => $blueprint->post->content -]))) !!} +'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]) +])) !!} @endsection @section('contentPreview') - {!! $blueprint->renderContent($blueprint->post->content) !!} + {!! $html->render($blueprint->post->content) !!} @endsection diff --git a/extensions/mentions/views/emails/plain/groupMentioned.blade.php b/extensions/mentions/views/emails/plain/groupMentioned.blade.php index 61b2d3c8d6..c6e1d600ed 100644 --- a/extensions/mentions/views/emails/plain/groupMentioned.blade.php +++ b/extensions/mentions/views/emails/plain/groupMentioned.blade.php @@ -1,7 +1,7 @@ @extends('flarum.forum::email.plain.notification.base') @section('content') -{!! $translator->trans('flarum-mentions.email.group_mentioned.body', [ +{!! $translator->trans('flarum-mentions.email.group_mentioned.plain.body', [ '{recipient_display_name}' => $user->display_name, '{mentioner_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, diff --git a/extensions/mentions/views/emails/plain/postMentioned.blade.php b/extensions/mentions/views/emails/plain/postMentioned.blade.php index 9a97eee097..08ef263040 100644 --- a/extensions/mentions/views/emails/plain/postMentioned.blade.php +++ b/extensions/mentions/views/emails/plain/postMentioned.blade.php @@ -1,7 +1,7 @@ @extends('flarum.forum::email.plain.notification.base') @section('content') -{!! $translator->trans('flarum-mentions.email.post_mentioned.body', [ +{!! $translator->trans('flarum-mentions.email.post_mentioned.plain.body', [ '{recipient_display_name}' => $user->display_name, '{replier_display_name}' => $blueprint->reply->user->display_name, '{post_number}' => $blueprint->post->number, diff --git a/extensions/mentions/views/emails/plain/userMentioned.blade.php b/extensions/mentions/views/emails/plain/userMentioned.blade.php index 0842928a1c..e642aaf2a0 100644 --- a/extensions/mentions/views/emails/plain/userMentioned.blade.php +++ b/extensions/mentions/views/emails/plain/userMentioned.blade.php @@ -1,7 +1,7 @@ @extends('flarum.forum::email.plain.notification.base') @section('content') -{!! $translator->trans('flarum-mentions.email.user_mentioned.body', [ +{!! $translator->trans('flarum-mentions.email.user_mentioned.plain.body', [ '{mentioner_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), diff --git a/extensions/subscriptions/locale/en.yml b/extensions/subscriptions/locale/en.yml index a08a231e70..135e30e970 100644 --- a/extensions/subscriptions/locale/en.yml +++ b/extensions/subscriptions/locale/en.yml @@ -51,19 +51,25 @@ flarum-subscriptions: # These translations are used in emails sent when a post is made in a subscribed discussion new_post: subject: "[New Post] {title}" - body: | - {poster_display_name} made a post in a discussion you're following: {title}. + plain: + body: | + {poster_display_name} just posted in a discussion you're following: {title}. - To view the new activity, check out the following link: - {url} + To view the new activity, check out the following link: + {url} - --- + --- - {content} + {content} - --- + --- - You won't receive any more notifications about this discussion until you're up-to-date. + You won't receive any more notifications about this discussion until you're up-to-date. + html: + body: | + {poster_display_name} just posted in a discussion you're following: [{title}]({url}). + + You won't recieve any more notifications about this discussion until you're up-to-date. ## # REUSED TRANSLATIONS - These keys should not be used directly in code! diff --git a/extensions/subscriptions/src/Notification/NewPostBlueprint.php b/extensions/subscriptions/src/Notification/NewPostBlueprint.php index 001249e99f..e96c803ddb 100644 --- a/extensions/subscriptions/src/Notification/NewPostBlueprint.php +++ b/extensions/subscriptions/src/Notification/NewPostBlueprint.php @@ -14,14 +14,11 @@ use Flarum\Locale\TranslatorInterface; use Flarum\Notification\Blueprint\BlueprintInterface; use Flarum\Notification\MailableInterface; -use Flarum\Notification\RendersContent; use Flarum\Post\Post; use Flarum\User\User; class NewPostBlueprint implements BlueprintInterface, MailableInterface { - use RendersContent; - public function __construct( public Post $post ) { diff --git a/extensions/subscriptions/views/emails/html/newPost.blade.php b/extensions/subscriptions/views/emails/html/newPost.blade.php index 2475864f79..b528d742b6 100644 --- a/extensions/subscriptions/views/emails/html/newPost.blade.php +++ b/extensions/subscriptions/views/emails/html/newPost.blade.php @@ -1,15 +1,14 @@ @extends('flarum.forum::email.html.notification.base') @section('notificationContent') -{!! nl2br(e($translator->trans('flarum-subscriptions.email.new_post.body', [ +{!! $html->render($translator->trans('flarum-subscriptions.email.new_post.html.body', [ '{recipient_display_name}' => $user->display_name, '{poster_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, -'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), -'{content}' => $blueprint->post->content -]))) !!} +'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]) +])) !!} @endsection @section('contentPreview') - {!! $blueprint->renderContent($blueprint->post->content) !!} + {!! $html->render($blueprint->post->content) !!} @endsection diff --git a/extensions/subscriptions/views/emails/plain/newPost.blade.php b/extensions/subscriptions/views/emails/plain/newPost.blade.php index 15855a818d..f01a84a53c 100644 --- a/extensions/subscriptions/views/emails/plain/newPost.blade.php +++ b/extensions/subscriptions/views/emails/plain/newPost.blade.php @@ -1,7 +1,7 @@ @extends('flarum.forum::email.plain.notification.base') @section('content') -{!! $translator->trans('flarum-subscriptions.email.new_post.body', [ +{!! $translator->trans('flarum-subscriptions.email.new_post.plain.body', [ '{recipient_display_name}' => $user->display_name, '{poster_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, diff --git a/extensions/suspend/locale/en.yml b/extensions/suspend/locale/en.yml index d7ef375ddc..0e4d81d538 100644 --- a/extensions/suspend/locale/en.yml +++ b/extensions/suspend/locale/en.yml @@ -52,16 +52,22 @@ flarum-suspend: no_reason_given: No reason was given for this suspension. suspended: subject: Your account has been suspended - body: | - You have been suspended for the following reason: + plain: + body: | + You have been suspended for the following reason: - --- - {suspension_message} - --- + --- + {suspension_message} + --- + html: + body: "You have been suspended from {forumTitle} for the following reason:" unsuspended: subject: Your account has been unsuspended - body: | - You have been unsuspended. You can head back to the forum by clicking on the following link: + plain: + body: | + You have been unsuspended. You can head back to the forum by clicking on the following link: - {forum_url} + {forum_url} + html: + body: "You have been unsuspended. You can head back to [{forumTitle}]({forum_url}) when you are ready." diff --git a/extensions/suspend/views/emails/html/suspended.blade.php b/extensions/suspend/views/emails/html/suspended.blade.php index 1a65dffafd..ffc9a474d2 100644 --- a/extensions/suspend/views/emails/html/suspended.blade.php +++ b/extensions/suspend/views/emails/html/suspended.blade.php @@ -1,8 +1,12 @@ @extends('flarum.forum::email.html.information.base') @section('content') -{!! nl2br(e($translator->trans('flarum-suspend.email.suspended.body', [ +{!! $html->render($translator->trans('flarum-suspend.email.suspended.html.body', [ '{recipient_display_name}' => $user->display_name, -'{suspension_message}' => $blueprint->user->suspend_message ?? $translator->trans('flarum-suspend.email.no_reason_given'), -]))) !!} +'{forumTitle}' => $settings->get('forum_title') +])) !!} +@endsection + +@section('contentPreview') + {!! $html->render(($blueprint->user->suspend_message ?? $translator->trans('flarum-suspend.email.no_reason_given'))) !!} @endsection diff --git a/extensions/suspend/views/emails/html/unsuspended.blade.php b/extensions/suspend/views/emails/html/unsuspended.blade.php index e3ca47637a..6bb7656572 100644 --- a/extensions/suspend/views/emails/html/unsuspended.blade.php +++ b/extensions/suspend/views/emails/html/unsuspended.blade.php @@ -1,8 +1,9 @@ @extends('flarum.forum::email.html.information.base') @section('content') -{!! nl2br(e($translator->trans('flarum-suspend.email.unsuspended.body', [ +{!! $html->render($translator->trans('flarum-suspend.email.unsuspended.html.body', [ '{recipient_display_name}' => $user->display_name, +'{forumTitle}' => $settings->get('forum_title'), '{forum_url}' => $url->to('forum')->base(), -]))) !!} +])) !!} @endsection diff --git a/extensions/suspend/views/emails/plain/suspended.blade.php b/extensions/suspend/views/emails/plain/suspended.blade.php index 7e489444fb..85eedf3da6 100644 --- a/extensions/suspend/views/emails/plain/suspended.blade.php +++ b/extensions/suspend/views/emails/plain/suspended.blade.php @@ -1,7 +1,7 @@ @extends('flarum.forum::email.plain.information.base') @section('content') -{!! $translator->trans('flarum-suspend.email.suspended.body', [ +{!! $translator->trans('flarum-suspend.email.suspended.plain.body', [ '{recipient_display_name}' => $user->display_name, '{suspension_message}' => $blueprint->user->suspend_message ?? $translator->trans('flarum-suspend.email.no_reason_given'), ]) !!} diff --git a/extensions/suspend/views/emails/plain/unsuspended.blade.php b/extensions/suspend/views/emails/plain/unsuspended.blade.php index 1040683902..04c3d7169d 100644 --- a/extensions/suspend/views/emails/plain/unsuspended.blade.php +++ b/extensions/suspend/views/emails/plain/unsuspended.blade.php @@ -1,7 +1,7 @@ @extends('flarum.forum::email.plain.information.base') @section('content') -{!! $translator->trans('flarum-suspend.email.unsuspended.body', [ +{!! $translator->trans('flarum-suspend.email.unsuspended.plain.body', [ '{recipient_display_name}' => $user->display_name, '{forum_url}' => $url->to('forum')->base(), ]) !!} diff --git a/framework/core/locale/core.yml b/framework/core/locale/core.yml index 1b619f8e97..1ab71e06f5 100644 --- a/framework/core/locale/core.yml +++ b/framework/core/locale/core.yml @@ -747,8 +747,8 @@ core: # Translations in this namespace are used in emails sent by the forum. email: - greeting: "Hey {displayName}!" - signoff: "{forumTitle} team" + greeting: "Hey {displayName}," + signoff: "The {forumTitle} team" # These translations are used by the "informational" email template. informational: @@ -761,7 +761,9 @@ core: footer: main_text: "This email was sent to {email} because you are subscribed to \"{type}\" notifications on {forumTitle}." unsubscribe_text: "If you'd like to stop receiving this type of notification, unsubscribe here." + unsubscribe_text_plain: "If you'd like to stop receiving this type of notification, unsubscribe here: {unsubscribeLink}" settings_text: "Manage your notification settings here." + settings_text_plain: "Manage your notification settings here." # These translations are used in emails sent when users register new accounts. activate_account: diff --git a/framework/core/src/Formatter/HtmlRenderer.php b/framework/core/src/Formatter/HtmlRenderer.php new file mode 100644 index 0000000000..8b6b6154d9 --- /dev/null +++ b/framework/core/src/Formatter/HtmlRenderer.php @@ -0,0 +1,18 @@ +formatter->render($this->formatter->parse($content)); + } +} diff --git a/framework/core/src/Forum/ForumServiceProvider.php b/framework/core/src/Forum/ForumServiceProvider.php index 65eb75c21c..4514f324ac 100644 --- a/framework/core/src/Forum/ForumServiceProvider.php +++ b/framework/core/src/Forum/ForumServiceProvider.php @@ -12,6 +12,7 @@ use Flarum\Extension\Event\Disabled; use Flarum\Extension\Event\Enabled; use Flarum\Formatter\Formatter; +use Flarum\Formatter\HtmlRenderer; use Flarum\Foundation\AbstractServiceProvider; use Flarum\Foundation\ErrorHandling\Registry; use Flarum\Foundation\ErrorHandling\Reporter; @@ -147,7 +148,8 @@ public function boot(Container $container, Dispatcher $events, Factory $view): v $view->share([ 'translator' => $container->make(TranslatorInterface::class), - 'settings' => $container->make(SettingsRepositoryInterface::class) + 'settings' => $container->make(SettingsRepositoryInterface::class), + 'html' => $container->make(HtmlRenderer::class) ]); $events->listen( diff --git a/framework/core/src/Notification/NotificationMailer.php b/framework/core/src/Notification/NotificationMailer.php index 9288326ce5..68dbf20e54 100644 --- a/framework/core/src/Notification/NotificationMailer.php +++ b/framework/core/src/Notification/NotificationMailer.php @@ -41,10 +41,11 @@ public function send(MailableInterface $blueprint, User $user): void $type = $blueprint::getType(); $forumTitle = $this->settings->get('forum_title'); $username = $user->display_name; + $userEmail = $user->email; $this->mailer->send( $this->getEmailViews($blueprint), - compact('blueprint', 'user', 'unsubscribeLink', 'settingsLink', 'type', 'forumTitle', 'username'), + compact('blueprint', 'user', 'unsubscribeLink', 'settingsLink', 'type', 'forumTitle', 'username', 'userEmail'), function (Message $message) use ($blueprint, $user) { $message->to($user->email, $user->display_name) ->subject($blueprint->getEmailSubject($this->translator)); diff --git a/framework/core/src/Notification/RendersContent.php b/framework/core/src/Notification/RendersContent.php deleted file mode 100644 index 97904454fe..0000000000 --- a/framework/core/src/Notification/RendersContent.php +++ /dev/null @@ -1,20 +0,0 @@ -

{{ $title ?? $translator->trans('core.email.informational.default_title') }}

@endsection @section('content') - -

{!! nl2br(e($infoContent)) !!}

+

{!! $html->render($infoContent) !!}

+

+ @yield('contentPreview') +
@endsection @section('footer') -

{!! $translator->trans('core.email.informational.footer', ['userEmail' => $userEmail, 'forumTitle' => '' . $settings->get('forum_title') . '']) !!}

@endsection diff --git a/framework/core/views/email/html/notification/base.blade.php b/framework/core/views/email/html/notification/base.blade.php index d5e1e2d969..72c28acfed 100644 --- a/framework/core/views/email/html/notification/base.blade.php +++ b/framework/core/views/email/html/notification/base.blade.php @@ -1,12 +1,10 @@ @extends('flarum.forum::email.html.base') @section('header') -

{{ $title ?? $translator->trans('core.email.notification.default_title') }}

@endsection @section('content') - @yield('notificationContent')
@yield('contentPreview') @@ -14,7 +12,6 @@ @endsection @section('footer') -

{!! $translator->trans('core.email.notification.footer.main_text', ['email' => $user->email, 'type' => $type, 'forumTitle' => '' . $settings->get('forum_title') . '']) !!}

{!! $translator->trans('core.email.notification.footer.unsubscribe_text', ['unsubscribeLink' => $unsubscribeLink]) !!}

{!! $translator->trans('core.email.notification.footer.settings_text', ['settingsLink' => $settingsLink]) !!}

diff --git a/framework/core/views/email/plain/information/base.blade.php b/framework/core/views/email/plain/information/base.blade.php index b3f2d53b24..dc703f7e54 100644 --- a/framework/core/views/email/plain/information/base.blade.php +++ b/framework/core/views/email/plain/information/base.blade.php @@ -9,5 +9,5 @@ @endsection @section('footer') -This email was sent to {{ $userEmail}} as an informational service related to your account on {{ $forumTitle }}. +{!! $translator->trans('core.email.informational.footer', ['userEmail' => $userEmail, 'forumTitle' => $forumTitle]) !!} @endsection diff --git a/framework/core/views/email/plain/notification/base.blade.php b/framework/core/views/email/plain/notification/base.blade.php index 1aeea526cd..9f86bfab3e 100644 --- a/framework/core/views/email/plain/notification/base.blade.php +++ b/framework/core/views/email/plain/notification/base.blade.php @@ -9,9 +9,9 @@ @endsection @section('footer') -This email was sent to {{ $user->email }} because you are subcribed to "{{ $type }}" notifications on {{ $forumTitle }}. +{!! $translator->trans('core.email.notification.footer.main_text', ['email' => $user->email, 'type' => $type, 'forumTitle' => $forumTitle]) !!} -If you'd like to stop receiving this type of notification, unsubscribe here: {{ $unsubscribeLink }} +{!! $translator->trans('core.email.notification.footer.unsubscribe_text_plain', ['unsubscribeLink' => $unsubscribeLink]) !!} -Manage your notification settings: {{ $settingsLink }} +{!! $translator->trans('core.email.notification.footer.settings_text_plain', ['settingsLink' => $settingsLink]) !!} @endsection From bac74a746d5613a37733f4212806246d432ea661 Mon Sep 17 00:00:00 2001 From: StyleCI Bot Date: Wed, 13 Sep 2023 13:21:28 +0000 Subject: [PATCH 40/60] Apply fixes from StyleCI --- framework/core/src/Formatter/HtmlRenderer.php | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/framework/core/src/Formatter/HtmlRenderer.php b/framework/core/src/Formatter/HtmlRenderer.php index 8b6b6154d9..1e7e038153 100644 --- a/framework/core/src/Formatter/HtmlRenderer.php +++ b/framework/core/src/Formatter/HtmlRenderer.php @@ -1,5 +1,12 @@ formatter->render($this->formatter->parse($content)); From 3eac530325be6e0c341ffd0eb25dad228444f85b Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 13:39:29 +0100 Subject: [PATCH 41/60] feedback: use formatter in blade templates, use post content renderer --- .../emails/html/groupMentioned.blade.php | 4 +-- .../views/emails/html/postMentioned.blade.php | 4 +-- .../views/emails/html/userMentioned.blade.php | 4 +-- .../views/emails/html/newPost.blade.php | 4 +-- .../views/emails/html/suspended.blade.php | 4 +-- .../views/emails/html/unsuspended.blade.php | 2 +- framework/core/src/Formatter/Formatter.php | 15 +++++++++++ framework/core/src/Formatter/HtmlRenderer.php | 25 ------------------- .../core/src/Forum/ForumServiceProvider.php | 3 +-- .../email/html/information/base.blade.php | 2 +- 10 files changed, 28 insertions(+), 39 deletions(-) delete mode 100644 framework/core/src/Formatter/HtmlRenderer.php diff --git a/extensions/mentions/views/emails/html/groupMentioned.blade.php b/extensions/mentions/views/emails/html/groupMentioned.blade.php index f8328f0724..9687a88ae9 100644 --- a/extensions/mentions/views/emails/html/groupMentioned.blade.php +++ b/extensions/mentions/views/emails/html/groupMentioned.blade.php @@ -1,7 +1,7 @@ @extends('flarum.forum::email.html.notification.base') @section('notificationContent') -{!! $html->render($translator->trans('flarum-mentions.email.group_mentioned.html.body', [ +{!! $formatter->convert($translator->trans('flarum-mentions.email.group_mentioned.html.body', [ '{recipient_display_name}' => $user->display_name, '{mentioner_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, @@ -10,5 +10,5 @@ @endsection @section('contentPreview') - {!! $html->render($blueprint->post->content) !!} + {!! $blueprint->post->formatContent() !!} @endsection diff --git a/extensions/mentions/views/emails/html/postMentioned.blade.php b/extensions/mentions/views/emails/html/postMentioned.blade.php index 2d5d13c476..2a6ef80721 100644 --- a/extensions/mentions/views/emails/html/postMentioned.blade.php +++ b/extensions/mentions/views/emails/html/postMentioned.blade.php @@ -1,7 +1,7 @@ @extends('flarum.forum::email.html.notification.base') @section('notificationContent') -{!! $html->render($translator->trans('flarum-mentions.email.post_mentioned.html.body', [ +{!! $formatter->convert($translator->trans('flarum-mentions.email.post_mentioned.html.body', [ '{recipient_display_name}' => $user->display_name, '{replier_display_name}' => $blueprint->reply->user->display_name, '{post_number}' => $blueprint->post->number, @@ -11,5 +11,5 @@ @endsection @section('contentPreview') - {!! $html->render($blueprint->reply->content) !!} + {!! $blueprint->reply->formatContent() !!} @endsection diff --git a/extensions/mentions/views/emails/html/userMentioned.blade.php b/extensions/mentions/views/emails/html/userMentioned.blade.php index 5d0614680b..aa085e0b16 100644 --- a/extensions/mentions/views/emails/html/userMentioned.blade.php +++ b/extensions/mentions/views/emails/html/userMentioned.blade.php @@ -1,7 +1,7 @@ @extends('flarum.forum::email.html.notification.base') @section('notificationContent') -{!! $html->render($translator->trans('flarum-mentions.email.user_mentioned.html.body', [ +{!! $formatter->convert($translator->trans('flarum-mentions.email.user_mentioned.html.body', [ '{mentioner_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]) @@ -9,5 +9,5 @@ @endsection @section('contentPreview') - {!! $html->render($blueprint->post->content) !!} + {!! $blueprint->post->formatContent() !!} @endsection diff --git a/extensions/subscriptions/views/emails/html/newPost.blade.php b/extensions/subscriptions/views/emails/html/newPost.blade.php index b528d742b6..57cf27ca8a 100644 --- a/extensions/subscriptions/views/emails/html/newPost.blade.php +++ b/extensions/subscriptions/views/emails/html/newPost.blade.php @@ -1,7 +1,7 @@ @extends('flarum.forum::email.html.notification.base') @section('notificationContent') -{!! $html->render($translator->trans('flarum-subscriptions.email.new_post.html.body', [ +{!! $formatter->convert($translator->trans('flarum-subscriptions.email.new_post.html.body', [ '{recipient_display_name}' => $user->display_name, '{poster_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, @@ -10,5 +10,5 @@ @endsection @section('contentPreview') - {!! $html->render($blueprint->post->content) !!} + {!! $blueprint->post->formatContent() !!} @endsection diff --git a/extensions/suspend/views/emails/html/suspended.blade.php b/extensions/suspend/views/emails/html/suspended.blade.php index ffc9a474d2..13d85e37d2 100644 --- a/extensions/suspend/views/emails/html/suspended.blade.php +++ b/extensions/suspend/views/emails/html/suspended.blade.php @@ -1,12 +1,12 @@ @extends('flarum.forum::email.html.information.base') @section('content') -{!! $html->render($translator->trans('flarum-suspend.email.suspended.html.body', [ +{!! $formatter->convert($translator->trans('flarum-suspend.email.suspended.html.body', [ '{recipient_display_name}' => $user->display_name, '{forumTitle}' => $settings->get('forum_title') ])) !!} @endsection @section('contentPreview') - {!! $html->render(($blueprint->user->suspend_message ?? $translator->trans('flarum-suspend.email.no_reason_given'))) !!} + {!! $formatter->convert(($blueprint->user->suspend_message ?? $translator->trans('flarum-suspend.email.no_reason_given'))) !!} @endsection diff --git a/extensions/suspend/views/emails/html/unsuspended.blade.php b/extensions/suspend/views/emails/html/unsuspended.blade.php index 6bb7656572..8751890f0f 100644 --- a/extensions/suspend/views/emails/html/unsuspended.blade.php +++ b/extensions/suspend/views/emails/html/unsuspended.blade.php @@ -1,7 +1,7 @@ @extends('flarum.forum::email.html.information.base') @section('content') -{!! $html->render($translator->trans('flarum-suspend.email.unsuspended.html.body', [ +{!! $formatter->convert($translator->trans('flarum-suspend.email.unsuspended.html.body', [ '{recipient_display_name}' => $user->display_name, '{forumTitle}' => $settings->get('forum_title'), '{forum_url}' => $url->to('forum')->base(), diff --git a/framework/core/src/Formatter/Formatter.php b/framework/core/src/Formatter/Formatter.php index fb71c954a6..2dbc97c5cd 100644 --- a/framework/core/src/Formatter/Formatter.php +++ b/framework/core/src/Formatter/Formatter.php @@ -204,4 +204,19 @@ protected function configureDefaultsOnLinks(string $xml): string return $attributes; }); } + + /** + * Converts a plain text string (with or without Markdown) to it's HTML equivalent. + * + * @param ?string $content + * @return string + */ + public function convert(?string $content): string + { + if (! $content) { + return ''; + } + + return $this->getRenderer()->render($this->getParser()->parse($content)); + } } diff --git a/framework/core/src/Formatter/HtmlRenderer.php b/framework/core/src/Formatter/HtmlRenderer.php deleted file mode 100644 index 1e7e038153..0000000000 --- a/framework/core/src/Formatter/HtmlRenderer.php +++ /dev/null @@ -1,25 +0,0 @@ -formatter->render($this->formatter->parse($content)); - } -} diff --git a/framework/core/src/Forum/ForumServiceProvider.php b/framework/core/src/Forum/ForumServiceProvider.php index 4514f324ac..57af25e609 100644 --- a/framework/core/src/Forum/ForumServiceProvider.php +++ b/framework/core/src/Forum/ForumServiceProvider.php @@ -12,7 +12,6 @@ use Flarum\Extension\Event\Disabled; use Flarum\Extension\Event\Enabled; use Flarum\Formatter\Formatter; -use Flarum\Formatter\HtmlRenderer; use Flarum\Foundation\AbstractServiceProvider; use Flarum\Foundation\ErrorHandling\Registry; use Flarum\Foundation\ErrorHandling\Reporter; @@ -149,7 +148,7 @@ public function boot(Container $container, Dispatcher $events, Factory $view): v $view->share([ 'translator' => $container->make(TranslatorInterface::class), 'settings' => $container->make(SettingsRepositoryInterface::class), - 'html' => $container->make(HtmlRenderer::class) + 'formatter' => $container->make(Formatter::class) ]); $events->listen( diff --git a/framework/core/views/email/html/information/base.blade.php b/framework/core/views/email/html/information/base.blade.php index 6943eea9e5..a143b6b440 100644 --- a/framework/core/views/email/html/information/base.blade.php +++ b/framework/core/views/email/html/information/base.blade.php @@ -5,7 +5,7 @@ @endsection @section('content') -

{!! $html->render($infoContent) !!}

+

{!! $formatter->convert($infoContent) !!}

@yield('contentPreview')
From 48224ff668b8acd60b0b6c5dd216d2442a6438c7 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 13:41:14 +0100 Subject: [PATCH 42/60] chore: remove wip code --- .../src/Forum/Controller/UnsubscribeActionController.php | 5 ----- 1 file changed, 5 deletions(-) diff --git a/framework/core/src/Forum/Controller/UnsubscribeActionController.php b/framework/core/src/Forum/Controller/UnsubscribeActionController.php index 5e4ab74edf..0220384c33 100644 --- a/framework/core/src/Forum/Controller/UnsubscribeActionController.php +++ b/framework/core/src/Forum/Controller/UnsubscribeActionController.php @@ -35,11 +35,6 @@ public function handle(Request $request): ResponseInterface $token = Arr::get($parsedBody, 'token'); $userId = Arr::get($parsedBody, 'userId'); - // Perhaps we should use a command instead of all the logic being here. WIP... - // $this->bus->dispatch( - // new UnsubscribeEmail($user, $token) - // ); - // Fetch the unsubscribe token record /** @var UnsubscribeToken|null $unsubscribeRecord */ $unsubscribeRecord = UnsubscribeToken::where('user_id', $userId) From c20540dc26bd4a7dc069511dcf9bc304cab8a267 Mon Sep 17 00:00:00 2001 From: StyleCI Bot Date: Mon, 18 Sep 2023 12:41:39 +0000 Subject: [PATCH 43/60] Apply fixes from StyleCI --- .../core/src/Forum/Controller/UnsubscribeActionController.php | 1 - 1 file changed, 1 deletion(-) diff --git a/framework/core/src/Forum/Controller/UnsubscribeActionController.php b/framework/core/src/Forum/Controller/UnsubscribeActionController.php index 0220384c33..0f4c65775b 100644 --- a/framework/core/src/Forum/Controller/UnsubscribeActionController.php +++ b/framework/core/src/Forum/Controller/UnsubscribeActionController.php @@ -11,7 +11,6 @@ use Carbon\Carbon; use Flarum\Http\UrlGenerator; -use Flarum\Notification\Command\UnsubscribeEmail; use Flarum\Notification\UnsubscribeToken; use Flarum\User\User; use Illuminate\Contracts\Bus\Dispatcher; From b0d688e3db424981edc3b2e517891c0785cea814 Mon Sep 17 00:00:00 2001 From: IanM <16573496+imorland@users.noreply.github.com> Date: Mon, 18 Sep 2023 13:42:13 +0100 Subject: [PATCH 44/60] Update framework/core/src/Forum/Controller/UnsubscribeActionController.php Co-authored-by: Sami Mazouz --- .../src/Forum/Controller/UnsubscribeActionController.php | 5 ----- 1 file changed, 5 deletions(-) diff --git a/framework/core/src/Forum/Controller/UnsubscribeActionController.php b/framework/core/src/Forum/Controller/UnsubscribeActionController.php index 0f4c65775b..e33c9dac27 100644 --- a/framework/core/src/Forum/Controller/UnsubscribeActionController.php +++ b/framework/core/src/Forum/Controller/UnsubscribeActionController.php @@ -34,26 +34,21 @@ public function handle(Request $request): ResponseInterface $token = Arr::get($parsedBody, 'token'); $userId = Arr::get($parsedBody, 'userId'); - // Fetch the unsubscribe token record /** @var UnsubscribeToken|null $unsubscribeRecord */ $unsubscribeRecord = UnsubscribeToken::where('user_id', $userId) ->where('token', $token) ->first(); - // If record exists and has not been used before if ($unsubscribeRecord && empty($unsubscribeRecord->unsubscribed_at)) { - // Mark as unsubscribed $unsubscribeRecord->unsubscribed_at = Carbon::now(); $unsubscribeRecord->save(); - // Update user preferences /** @var User $user */ $user = User::find($userId); $user->setNotificationPreference($unsubscribeRecord->email_type, 'email', false); $user->save(); } - // Redirect back to the forum's home page after unsubscribing return new RedirectResponse($this->url->to('forum')->base()); } } From d3f4b5fe9491fd3650e94a65b737ff136f031e11 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 14:01:40 +0100 Subject: [PATCH 45/60] use markdown in email footer translations --- framework/core/locale/core.yml | 12 +++++++----- .../core/views/email/html/information/base.blade.php | 2 +- .../views/email/html/notification/base.blade.php | 6 +++--- .../views/email/plain/information/base.blade.php | 2 +- .../views/email/plain/notification/base.blade.php | 2 +- 5 files changed, 13 insertions(+), 11 deletions(-) diff --git a/framework/core/locale/core.yml b/framework/core/locale/core.yml index 1ab71e06f5..dae82cbfa7 100644 --- a/framework/core/locale/core.yml +++ b/framework/core/locale/core.yml @@ -753,17 +753,19 @@ core: # These translations are used by the "informational" email template. informational: default_title: "Information" - footer: "This email was sent to {userEmail} as an informational service related to your account on {forumTitle}."# + footer: "This email was sent to {userEmail} as an informational service related to your account on [{forumTitle}]({forumUrl})." + footer_plain: "This email was sent to {userEmail} as an informational service related to your account on {forumTitle}." # These translations are used by the "notification" email template. notification: default_title: "Notification" footer: - main_text: "This email was sent to {email} because you are subscribed to \"{type}\" notifications on {forumTitle}." - unsubscribe_text: "If you'd like to stop receiving this type of notification, unsubscribe here." + main_text: "This email was sent to {email} because you are subscribed to \"{type}\" notifications on [{forumTitle}]({forumUrl})." + main_text_plain: "This email was sent to {email} because you are subscribed to \"{type}\" notifications on {forumTitle}." + unsubscribe_text: "If you'd like to stop receiving this type of notification, [unsubscribe here]({unsubscribeLink})." unsubscribe_text_plain: "If you'd like to stop receiving this type of notification, unsubscribe here: {unsubscribeLink}" - settings_text: "Manage your notification settings here." - settings_text_plain: "Manage your notification settings here." + settings_text: "Manage your notification settings [here]({settingsLink})." + settings_text_plain: "Manage your notification settings here: {settingsLink}" # These translations are used in emails sent when users register new accounts. activate_account: diff --git a/framework/core/views/email/html/information/base.blade.php b/framework/core/views/email/html/information/base.blade.php index a143b6b440..0ed9902c16 100644 --- a/framework/core/views/email/html/information/base.blade.php +++ b/framework/core/views/email/html/information/base.blade.php @@ -12,5 +12,5 @@ @endsection @section('footer') -

{!! $translator->trans('core.email.informational.footer', ['userEmail' => $userEmail, 'forumTitle' => '' . $settings->get('forum_title') . '']) !!}

+

{!! $formatter->convert($translator->trans('core.email.informational.footer', ['userEmail' => $userEmail, 'forumUrl' => $url->to('forum')->base(), 'forumTitle' => $settings->get('forum_title')])) !!}

@endsection diff --git a/framework/core/views/email/html/notification/base.blade.php b/framework/core/views/email/html/notification/base.blade.php index 72c28acfed..0d7bc3d0f0 100644 --- a/framework/core/views/email/html/notification/base.blade.php +++ b/framework/core/views/email/html/notification/base.blade.php @@ -12,7 +12,7 @@ @endsection @section('footer') -

{!! $translator->trans('core.email.notification.footer.main_text', ['email' => $user->email, 'type' => $type, 'forumTitle' => '' . $settings->get('forum_title') . '']) !!}

-

{!! $translator->trans('core.email.notification.footer.unsubscribe_text', ['unsubscribeLink' => $unsubscribeLink]) !!}

-

{!! $translator->trans('core.email.notification.footer.settings_text', ['settingsLink' => $settingsLink]) !!}

+

{!! $formatter->convert($translator->trans('core.email.notification.footer.main_text', ['email' => $user->email, 'type' => $type, 'forumUrl' => $url->to('forum')->base(), 'forumTitle' => $settings->get('forum_title')])) !!}

+

{!! $formatter->convert($translator->trans('core.email.notification.footer.unsubscribe_text', ['unsubscribeLink' => $unsubscribeLink])) !!}

+

{!! $formatter->convert($translator->trans('core.email.notification.footer.settings_text', ['settingsLink' => $settingsLink])) !!}

@endsection diff --git a/framework/core/views/email/plain/information/base.blade.php b/framework/core/views/email/plain/information/base.blade.php index dc703f7e54..bec65b6e8f 100644 --- a/framework/core/views/email/plain/information/base.blade.php +++ b/framework/core/views/email/plain/information/base.blade.php @@ -9,5 +9,5 @@ @endsection @section('footer') -{!! $translator->trans('core.email.informational.footer', ['userEmail' => $userEmail, 'forumTitle' => $forumTitle]) !!} +{!! $translator->trans('core.email.informational.footer_plain', ['userEmail' => $userEmail, 'forumTitle' => $forumTitle]) !!} @endsection diff --git a/framework/core/views/email/plain/notification/base.blade.php b/framework/core/views/email/plain/notification/base.blade.php index 9f86bfab3e..b048784cf1 100644 --- a/framework/core/views/email/plain/notification/base.blade.php +++ b/framework/core/views/email/plain/notification/base.blade.php @@ -9,7 +9,7 @@ @endsection @section('footer') -{!! $translator->trans('core.email.notification.footer.main_text', ['email' => $user->email, 'type' => $type, 'forumTitle' => $forumTitle]) !!} +{!! $translator->trans('core.email.notification.footer.main_text_plain', ['email' => $user->email, 'type' => $type, 'forumTitle' => $forumTitle]) !!} {!! $translator->trans('core.email.notification.footer.unsubscribe_text_plain', ['unsubscribeLink' => $unsubscribeLink]) !!} From a3d612782e3b1f030d9858051e68f11078c8234d Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 14:22:54 +0100 Subject: [PATCH 46/60] use markdown --- framework/core/locale/core.yml | 4 ++-- framework/core/views/unsubscribe-confirmation.blade.php | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/framework/core/locale/core.yml b/framework/core/locale/core.yml index dae82cbfa7..955e27bfa7 100644 --- a/framework/core/locale/core.yml +++ b/framework/core/locale/core.yml @@ -734,8 +734,8 @@ core: confirm_button: Confirm immediate_helptext: You will be immediately unsubscribed once you confirm. confirm_message: "You have requested to unsubscribe from \"{type}\" email notifications from {forumTitle}." - success_message: "You have successfully unsubscribed from \"{type}\" notification from {forumTitle}. If you wish to receive them again, please update your settings." - invalid_message: "This unsubscribe link is invalid or has already been used. For any changes in your email notifications from {forumTitle}, please check your settings." + success_message: "You have successfully unsubscribed from \"{type}\" notification from {forumTitle}. If you wish to receive them again, please [update your settings]({settingsLink})." + invalid_message: "This unsubscribe link is invalid or has already been used. For any changes in your email notifications from {forumTitle}, please [check your settings]({settingsLink})." # Translations in this namespace are used in messages output by the API. api: diff --git a/framework/core/views/unsubscribe-confirmation.blade.php b/framework/core/views/unsubscribe-confirmation.blade.php index 226ec33c95..997d864d0a 100644 --- a/framework/core/views/unsubscribe-confirmation.blade.php +++ b/framework/core/views/unsubscribe-confirmation.blade.php @@ -4,7 +4,7 @@ @section('content')

{{ $translator->trans('core.views.unsubscribe_email.title') }}

-

{!! $message !!}

+

{!! $formatter->convert($message) !!}

{{ $translator->trans('core.views.unsubscribe_email.immediate_helptext') }}

From 8356497e3c95679013457163e03042cbf60f4621 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 14:30:30 +0100 Subject: [PATCH 47/60] move mailer to mail namespace --- framework/core/src/Mail/MailServiceProvider.php | 1 - framework/core/src/{Foundation => Mail}/Mailer.php | 3 ++- 2 files changed, 2 insertions(+), 2 deletions(-) rename framework/core/src/{Foundation => Mail}/Mailer.php (95%) diff --git a/framework/core/src/Mail/MailServiceProvider.php b/framework/core/src/Mail/MailServiceProvider.php index 4a47e012dd..a15b6a29f3 100644 --- a/framework/core/src/Mail/MailServiceProvider.php +++ b/framework/core/src/Mail/MailServiceProvider.php @@ -11,7 +11,6 @@ use Flarum\Foundation\AbstractServiceProvider; use Flarum\Foundation\Config; -use Flarum\Foundation\Mailer; use Flarum\Settings\SettingsRepositoryInterface; use Illuminate\Contracts\Container\Container; use Illuminate\Contracts\Mail\Mailer as MailerContract; diff --git a/framework/core/src/Foundation/Mailer.php b/framework/core/src/Mail/Mailer.php similarity index 95% rename from framework/core/src/Foundation/Mailer.php rename to framework/core/src/Mail/Mailer.php index 9e1420ff8c..739d1d63a9 100644 --- a/framework/core/src/Foundation/Mailer.php +++ b/framework/core/src/Mail/Mailer.php @@ -7,8 +7,9 @@ * LICENSE file that was distributed with this source code. */ -namespace Flarum\Foundation; +namespace Flarum\Mail; +use Flarum\Foundation\Config; use Illuminate\Contracts\Events\Dispatcher; use Illuminate\Contracts\View\Factory; use Illuminate\Mail\Mailer as SymfonyMailer; From a60410b7cbf9baf557db8a529a3265329ab04d51 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 14:39:59 +0100 Subject: [PATCH 48/60] Use combined type MailableInterface&BlueprintInterface --- .../core/src/Notification/Job/SendEmailNotificationJob.php | 3 ++- framework/core/src/Notification/MailableInterface.php | 5 ----- framework/core/src/Notification/NotificationMailer.php | 3 ++- 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/framework/core/src/Notification/Job/SendEmailNotificationJob.php b/framework/core/src/Notification/Job/SendEmailNotificationJob.php index f01617d64e..137fe15cac 100644 --- a/framework/core/src/Notification/Job/SendEmailNotificationJob.php +++ b/framework/core/src/Notification/Job/SendEmailNotificationJob.php @@ -9,6 +9,7 @@ namespace Flarum\Notification\Job; +use Flarum\Notification\Blueprint\BlueprintInterface; use Flarum\Notification\MailableInterface; use Flarum\Notification\NotificationMailer; use Flarum\Queue\AbstractJob; @@ -17,7 +18,7 @@ class SendEmailNotificationJob extends AbstractJob { public function __construct( - private readonly MailableInterface $blueprint, + private readonly MailableInterface&BlueprintInterface $blueprint, private readonly User $recipient ) { } diff --git a/framework/core/src/Notification/MailableInterface.php b/framework/core/src/Notification/MailableInterface.php index 68ecb7ca25..631d1dbe44 100644 --- a/framework/core/src/Notification/MailableInterface.php +++ b/framework/core/src/Notification/MailableInterface.php @@ -29,9 +29,4 @@ public function getEmailViews(): array; * Get the subject line for a notification email. */ public function getEmailSubject(TranslatorInterface $translator): string; - - /** - * Get the serialized type of this activity. - */ - public static function getType(): string; } diff --git a/framework/core/src/Notification/NotificationMailer.php b/framework/core/src/Notification/NotificationMailer.php index 68dbf20e54..02ac747dce 100644 --- a/framework/core/src/Notification/NotificationMailer.php +++ b/framework/core/src/Notification/NotificationMailer.php @@ -11,6 +11,7 @@ use Flarum\Http\UrlGenerator; use Flarum\Locale\TranslatorInterface; +use Flarum\Notification\Blueprint\BlueprintInterface; use Flarum\Settings\SettingsRepositoryInterface; use Flarum\User\User; use Illuminate\Contracts\Mail\Mailer; @@ -27,7 +28,7 @@ public function __construct( ) { } - public function send(MailableInterface $blueprint, User $user): void + public function send(MailableInterface&BlueprintInterface $blueprint, User $user): void { // Ensure that notifications are delivered to the user in their default language, if they've selected one. $this->translator->setLocale($user->getPreference('locale') ?? $this->settings->get('default_locale')); From 6a1786f05bd38b3749ca0fd06588723eb77e3e26 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 15:39:09 +0100 Subject: [PATCH 49/60] Mail format config --- framework/core/js/src/admin/components/MailPage.tsx | 11 +++++++++++ framework/core/locale/core.yml | 6 ++++++ framework/core/src/Mail/MailServiceProvider.php | 6 +++--- framework/core/src/Mail/Mailer.php | 8 ++++---- .../core/src/Settings/SettingsServiceProvider.php | 1 + 5 files changed, 25 insertions(+), 7 deletions(-) diff --git a/framework/core/js/src/admin/components/MailPage.tsx b/framework/core/js/src/admin/components/MailPage.tsx index 3d31f263d6..74af53af42 100644 --- a/framework/core/js/src/admin/components/MailPage.tsx +++ b/framework/core/js/src/admin/components/MailPage.tsx @@ -75,6 +75,17 @@ export default class MailPage exten setting: 'mail_from', label: app.translator.trans('core.admin.email.addresses_heading'), })} + {this.buildSettingComponent({ + type: 'select', + setting: 'mail_format', + options: { + multipart: app.translator.trans('core.admin.email.format.multipart_option'), + plain: app.translator.trans('core.admin.email.format.plain_option'), + html: app.translator.trans('core.admin.email.format.html_option'), + }, + label: app.translator.trans('core.admin.email.format_heading'), + help: app.translator.trans('core.admin.email.format_help'), + })} {this.buildSettingComponent({ type: 'select', setting: 'mail_driver', diff --git a/framework/core/locale/core.yml b/framework/core/locale/core.yml index 955e27bfa7..f11703c49a 100644 --- a/framework/core/locale/core.yml +++ b/framework/core/locale/core.yml @@ -126,6 +126,12 @@ core: description: "Configure the driver, settings and addresses your forum will use to send email." driver_heading: Choose a Driver driver_label: Driver + format: + multipart_option: Multipart (recommended) + plain_option: Plain Text + html_option: HTML + format_heading: Outgoing Email Format + format_help: "Choose the format that outgoing emails will be sent in. The recommended option is multipart, as this will allow your user's email client to display the most appropriate format." from_label: Sender mail_encryption_label: Encryption mail_host_label: Host diff --git a/framework/core/src/Mail/MailServiceProvider.php b/framework/core/src/Mail/MailServiceProvider.php index a15b6a29f3..9a1d338b5c 100644 --- a/framework/core/src/Mail/MailServiceProvider.php +++ b/framework/core/src/Mail/MailServiceProvider.php @@ -10,7 +10,6 @@ namespace Flarum\Mail; use Flarum\Foundation\AbstractServiceProvider; -use Flarum\Foundation\Config; use Flarum\Settings\SettingsRepositoryInterface; use Illuminate\Contracts\Container\Container; use Illuminate\Contracts\Mail\Mailer as MailerContract; @@ -62,19 +61,20 @@ public function register(): void }); $this->container->singleton('mailer', function (Container $container): MailerContract { + $settings = $container->make(SettingsRepositoryInterface::class); + $mailer = new Mailer( 'flarum', $container['view'], $container['symfony.mailer.transport'], $container['events'], - $container->make(Config::class) + $settings, ); if ($container->bound('queue')) { $mailer->setQueue($container->make('queue')); } - $settings = $container->make(SettingsRepositoryInterface::class); $mailer->alwaysFrom($settings->get('mail_from'), $settings->get('forum_title')); return $mailer; diff --git a/framework/core/src/Mail/Mailer.php b/framework/core/src/Mail/Mailer.php index 739d1d63a9..32edaca223 100644 --- a/framework/core/src/Mail/Mailer.php +++ b/framework/core/src/Mail/Mailer.php @@ -9,7 +9,7 @@ namespace Flarum\Mail; -use Flarum\Foundation\Config; +use Flarum\Settings\SettingsRepositoryInterface; use Illuminate\Contracts\Events\Dispatcher; use Illuminate\Contracts\View\Factory; use Illuminate\Mail\Mailer as SymfonyMailer; @@ -22,20 +22,20 @@ public function __construct( Factory $views, TransportInterface $transport, Dispatcher $events = null, - protected Config $config + protected SettingsRepositoryInterface $settings ) { parent::__construct($name, $views, $transport, $events); } public function send($view, array $data = [], $callback = null) { - $emailType = $this->config['email_format'] ?? 'multipart'; + $emailType = $this->settings->get('mail_format'); switch ($emailType) { case 'html': unset($view['text']); break; - case 'text': + case 'plain': unset($view['html']); break; // case 'multipart' is the default, where Flarum will send both HTML and text versions of emails, so that the recipient's email client can choose which one to display. diff --git a/framework/core/src/Settings/SettingsServiceProvider.php b/framework/core/src/Settings/SettingsServiceProvider.php index ff8fd02cb8..0fd38d2d02 100644 --- a/framework/core/src/Settings/SettingsServiceProvider.php +++ b/framework/core/src/Settings/SettingsServiceProvider.php @@ -24,6 +24,7 @@ public function register(): void return new Collection([ 'theme_primary_color' => '#4D698E', 'theme_secondary_color' => '#4D698E', + 'mail_format' => 'multipart', ]); }); From 2b0352ac4030e64c98105938912d1687ea53dd84 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 15:51:39 +0100 Subject: [PATCH 50/60] extract mail settings to ItemList --- .../core/js/src/admin/components/MailPage.tsx | 81 ++++++++++++------- 1 file changed, 54 insertions(+), 27 deletions(-) diff --git a/framework/core/js/src/admin/components/MailPage.tsx b/framework/core/js/src/admin/components/MailPage.tsx index 74af53af42..c3e40c8820 100644 --- a/framework/core/js/src/admin/components/MailPage.tsx +++ b/framework/core/js/src/admin/components/MailPage.tsx @@ -8,6 +8,7 @@ import type { IPageAttrs } from '../../common/components/Page'; import type { AlertIdentifier } from '../../common/states/AlertManagerState'; import type Mithril from 'mithril'; import type { SaveSubmitEvent } from './AdminPage'; +import ItemList from '../../common/utils/ItemList'; export interface MailSettings { data: { @@ -65,27 +66,58 @@ export default class MailPage exten return ; } - const fields = this.driverFields![this.setting('mail_driver')()]; - const fieldKeys = Object.keys(fields); + const mailSettings = this.mailSettingItems().toArray(); return (
- {this.buildSettingComponent({ - type: 'text', - setting: 'mail_from', - label: app.translator.trans('core.admin.email.addresses_heading'), - })} - {this.buildSettingComponent({ - type: 'select', - setting: 'mail_format', - options: { - multipart: app.translator.trans('core.admin.email.format.multipart_option'), - plain: app.translator.trans('core.admin.email.format.plain_option'), - html: app.translator.trans('core.admin.email.format.html_option'), - }, - label: app.translator.trans('core.admin.email.format_heading'), - help: app.translator.trans('core.admin.email.format_help'), - })} + {mailSettings.map((settingComponent) => settingComponent)} + {this.submitButton()} + +
+
{app.translator.trans('core.admin.email.send_test_mail_text', { email: app.session.user!.email() })}
+ +
+
+ ); + } + + mailSettingItems(): ItemList { + const items = new ItemList(); + + const fields = this.driverFields![this.setting('mail_driver')()]; + const fieldKeys = Object.keys(fields); + + items.add( + 'mail_from', + this.buildSettingComponent({ + type: 'text', + setting: 'mail_from', + label: app.translator.trans('core.admin.email.addresses_heading'), + }), + 80 + ); + + items.add( + 'mail_format', + this.buildSettingComponent({ + type: 'select', + setting: 'mail_format', + options: { + multipart: app.translator.trans('core.admin.email.format.multipart_option'), + plain: app.translator.trans('core.admin.email.format.plain_option'), + html: app.translator.trans('core.admin.email.format.html_option'), + }, + label: app.translator.trans('core.admin.email.format_heading'), + help: app.translator.trans('core.admin.email.format_help'), + }), + 70 + ); + + items.add( + 'mail_driver', +
{this.buildSettingComponent({ type: 'select', setting: 'mail_driver', @@ -115,16 +147,11 @@ export default class MailPage exten
)} - {this.submitButton()} - -
-
{app.translator.trans('core.admin.email.send_test_mail_text', { email: app.session.user!.email() })}
- -
-
+
, + 60 ); + + return items; } sendTestEmail() { From 9350518967e6f6bc3136bb4d3d2afa32634457bd Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 16:00:37 +0100 Subject: [PATCH 51/60] use hasSection --- .../core/views/email/html/information/base.blade.php | 10 ++++++---- .../core/views/email/html/notification/base.blade.php | 8 +++++--- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/framework/core/views/email/html/information/base.blade.php b/framework/core/views/email/html/information/base.blade.php index 0ed9902c16..df71fd2883 100644 --- a/framework/core/views/email/html/information/base.blade.php +++ b/framework/core/views/email/html/information/base.blade.php @@ -5,10 +5,12 @@ @endsection @section('content') -

{!! $formatter->convert($infoContent) !!}

-

- @yield('contentPreview') -
+

{!! $formatter->convert($infoContent) !!}

+ @hasSection('contentPreview') +
+ @yield('contentPreview') +
+ @endif @endsection @section('footer') diff --git a/framework/core/views/email/html/notification/base.blade.php b/framework/core/views/email/html/notification/base.blade.php index 0d7bc3d0f0..a62fed0891 100644 --- a/framework/core/views/email/html/notification/base.blade.php +++ b/framework/core/views/email/html/notification/base.blade.php @@ -6,9 +6,11 @@ @section('content') @yield('notificationContent') -
- @yield('contentPreview') -
+ @hasSection('contentPreview') +
+ @yield('contentPreview') +
+ @endif @endsection @section('footer') From 86b60892b13c27bf6cf1ff7bdbe3b4c46df49e0b Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 16:05:15 +0100 Subject: [PATCH 52/60] phpstan error --- framework/core/src/Notification/NotificationMailer.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/framework/core/src/Notification/NotificationMailer.php b/framework/core/src/Notification/NotificationMailer.php index 02ac747dce..33722945a7 100644 --- a/framework/core/src/Notification/NotificationMailer.php +++ b/framework/core/src/Notification/NotificationMailer.php @@ -64,7 +64,7 @@ function (Message $message) use ($blueprint, $user) { * html: string * } */ - protected function getEmailViews(MailableInterface $blueprint): array + protected function getEmailViews(MailableInterface&BlueprintInterface $blueprint): array { $views = $blueprint->getEmailViews(); From b31780b987c5bd5de92205d936a224a0cec9c39d Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 16:08:16 +0100 Subject: [PATCH 53/60] stan, again --- framework/core/src/Notification/NotificationMailer.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/framework/core/src/Notification/NotificationMailer.php b/framework/core/src/Notification/NotificationMailer.php index 33722945a7..f320e98509 100644 --- a/framework/core/src/Notification/NotificationMailer.php +++ b/framework/core/src/Notification/NotificationMailer.php @@ -58,7 +58,7 @@ function (Message $message) use ($blueprint, $user) { * Retrives the email views from the blueprint, and enforces that both a * plain text and HTML view are provided. * - * @param MailableInterface $blueprint + * @param MailableInterface&BlueprintInterface $blueprint * @return array{ * text: string, * html: string From 6197de31849018c5d0ce207a7963c41108966360 Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 17:51:27 +0100 Subject: [PATCH 54/60] fix suspension not rendering the reason in html view --- .../suspend/src/Notification/UserSuspendedBlueprint.php | 3 ++- extensions/suspend/views/emails/html/suspended.blade.php | 5 ++--- extensions/suspend/views/emails/plain/suspended.blade.php | 1 - framework/core/views/email/html/information/base.blade.php | 6 +++++- 4 files changed, 9 insertions(+), 6 deletions(-) diff --git a/extensions/suspend/src/Notification/UserSuspendedBlueprint.php b/extensions/suspend/src/Notification/UserSuspendedBlueprint.php index b54aa70f99..ea9c6a0424 100644 --- a/extensions/suspend/src/Notification/UserSuspendedBlueprint.php +++ b/extensions/suspend/src/Notification/UserSuspendedBlueprint.php @@ -9,6 +9,7 @@ namespace Flarum\Suspend\Notification; +use Carbon\Carbon; use Carbon\CarbonInterface; use Flarum\Database\AbstractModel; use Flarum\Locale\TranslatorInterface; @@ -35,7 +36,7 @@ public function getFromUser(): ?User public function getData(): CarbonInterface { - return $this->user->suspended_until; + return Carbon::now(); } public static function getType(): string diff --git a/extensions/suspend/views/emails/html/suspended.blade.php b/extensions/suspend/views/emails/html/suspended.blade.php index 13d85e37d2..0cdfffddf2 100644 --- a/extensions/suspend/views/emails/html/suspended.blade.php +++ b/extensions/suspend/views/emails/html/suspended.blade.php @@ -1,12 +1,11 @@ @extends('flarum.forum::email.html.information.base') -@section('content') +@section('informationContent') {!! $formatter->convert($translator->trans('flarum-suspend.email.suspended.html.body', [ -'{recipient_display_name}' => $user->display_name, '{forumTitle}' => $settings->get('forum_title') ])) !!} @endsection @section('contentPreview') - {!! $formatter->convert(($blueprint->user->suspend_message ?? $translator->trans('flarum-suspend.email.no_reason_given'))) !!} + {!! $formatter->convert($blueprint->user->suspend_message ?? $translator->trans('flarum-suspend.email.no_reason_given')) !!} @endsection diff --git a/extensions/suspend/views/emails/plain/suspended.blade.php b/extensions/suspend/views/emails/plain/suspended.blade.php index 85eedf3da6..b752be9cd5 100644 --- a/extensions/suspend/views/emails/plain/suspended.blade.php +++ b/extensions/suspend/views/emails/plain/suspended.blade.php @@ -2,7 +2,6 @@ @section('content') {!! $translator->trans('flarum-suspend.email.suspended.plain.body', [ -'{recipient_display_name}' => $user->display_name, '{suspension_message}' => $blueprint->user->suspend_message ?? $translator->trans('flarum-suspend.email.no_reason_given'), ]) !!} @endsection diff --git a/framework/core/views/email/html/information/base.blade.php b/framework/core/views/email/html/information/base.blade.php index df71fd2883..8267c93482 100644 --- a/framework/core/views/email/html/information/base.blade.php +++ b/framework/core/views/email/html/information/base.blade.php @@ -5,7 +5,11 @@ @endsection @section('content') -

{!! $formatter->convert($infoContent) !!}

+ @if(isset($infoContent)) +

{!! $formatter->convert($infoContent) !!}

+ @else + @yield('informationContent') + @endif @hasSection('contentPreview')
@yield('contentPreview') From b77e0a8e86ce404c278ba24e617160d2c9cb23dd Mon Sep 17 00:00:00 2001 From: IanM Date: Mon, 18 Sep 2023 18:00:28 +0100 Subject: [PATCH 55/60] remove recipient_display_name --- extensions/mentions/views/emails/html/groupMentioned.blade.php | 1 - extensions/mentions/views/emails/html/postMentioned.blade.php | 1 - extensions/mentions/views/emails/plain/groupMentioned.blade.php | 1 - extensions/mentions/views/emails/plain/postMentioned.blade.php | 1 - extensions/subscriptions/views/emails/html/newPost.blade.php | 1 - extensions/subscriptions/views/emails/plain/newPost.blade.php | 1 - extensions/suspend/views/emails/html/unsuspended.blade.php | 1 - extensions/suspend/views/emails/plain/unsuspended.blade.php | 1 - 8 files changed, 8 deletions(-) diff --git a/extensions/mentions/views/emails/html/groupMentioned.blade.php b/extensions/mentions/views/emails/html/groupMentioned.blade.php index 9687a88ae9..d6aff59247 100644 --- a/extensions/mentions/views/emails/html/groupMentioned.blade.php +++ b/extensions/mentions/views/emails/html/groupMentioned.blade.php @@ -2,7 +2,6 @@ @section('notificationContent') {!! $formatter->convert($translator->trans('flarum-mentions.email.group_mentioned.html.body', [ -'{recipient_display_name}' => $user->display_name, '{mentioner_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]) diff --git a/extensions/mentions/views/emails/html/postMentioned.blade.php b/extensions/mentions/views/emails/html/postMentioned.blade.php index 2a6ef80721..02a1462bc7 100644 --- a/extensions/mentions/views/emails/html/postMentioned.blade.php +++ b/extensions/mentions/views/emails/html/postMentioned.blade.php @@ -2,7 +2,6 @@ @section('notificationContent') {!! $formatter->convert($translator->trans('flarum-mentions.email.post_mentioned.html.body', [ -'{recipient_display_name}' => $user->display_name, '{replier_display_name}' => $blueprint->reply->user->display_name, '{post_number}' => $blueprint->post->number, '{title}' => $blueprint->post->discussion->title, diff --git a/extensions/mentions/views/emails/plain/groupMentioned.blade.php b/extensions/mentions/views/emails/plain/groupMentioned.blade.php index c6e1d600ed..569f74238a 100644 --- a/extensions/mentions/views/emails/plain/groupMentioned.blade.php +++ b/extensions/mentions/views/emails/plain/groupMentioned.blade.php @@ -2,7 +2,6 @@ @section('content') {!! $translator->trans('flarum-mentions.email.group_mentioned.plain.body', [ -'{recipient_display_name}' => $user->display_name, '{mentioner_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), diff --git a/extensions/mentions/views/emails/plain/postMentioned.blade.php b/extensions/mentions/views/emails/plain/postMentioned.blade.php index 08ef263040..daae1a4d27 100644 --- a/extensions/mentions/views/emails/plain/postMentioned.blade.php +++ b/extensions/mentions/views/emails/plain/postMentioned.blade.php @@ -2,7 +2,6 @@ @section('content') {!! $translator->trans('flarum-mentions.email.post_mentioned.plain.body', [ -'{recipient_display_name}' => $user->display_name, '{replier_display_name}' => $blueprint->reply->user->display_name, '{post_number}' => $blueprint->post->number, '{title}' => $blueprint->post->discussion->title, diff --git a/extensions/subscriptions/views/emails/html/newPost.blade.php b/extensions/subscriptions/views/emails/html/newPost.blade.php index 57cf27ca8a..8b1d15620d 100644 --- a/extensions/subscriptions/views/emails/html/newPost.blade.php +++ b/extensions/subscriptions/views/emails/html/newPost.blade.php @@ -2,7 +2,6 @@ @section('notificationContent') {!! $formatter->convert($translator->trans('flarum-subscriptions.email.new_post.html.body', [ -'{recipient_display_name}' => $user->display_name, '{poster_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]) diff --git a/extensions/subscriptions/views/emails/plain/newPost.blade.php b/extensions/subscriptions/views/emails/plain/newPost.blade.php index f01a84a53c..09bc166ca5 100644 --- a/extensions/subscriptions/views/emails/plain/newPost.blade.php +++ b/extensions/subscriptions/views/emails/plain/newPost.blade.php @@ -2,7 +2,6 @@ @section('content') {!! $translator->trans('flarum-subscriptions.email.new_post.plain.body', [ -'{recipient_display_name}' => $user->display_name, '{poster_display_name}' => $blueprint->post->user->display_name, '{title}' => $blueprint->post->discussion->title, '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]), diff --git a/extensions/suspend/views/emails/html/unsuspended.blade.php b/extensions/suspend/views/emails/html/unsuspended.blade.php index 8751890f0f..34ba25374b 100644 --- a/extensions/suspend/views/emails/html/unsuspended.blade.php +++ b/extensions/suspend/views/emails/html/unsuspended.blade.php @@ -2,7 +2,6 @@ @section('content') {!! $formatter->convert($translator->trans('flarum-suspend.email.unsuspended.html.body', [ -'{recipient_display_name}' => $user->display_name, '{forumTitle}' => $settings->get('forum_title'), '{forum_url}' => $url->to('forum')->base(), ])) !!} diff --git a/extensions/suspend/views/emails/plain/unsuspended.blade.php b/extensions/suspend/views/emails/plain/unsuspended.blade.php index 04c3d7169d..8b7cfa2482 100644 --- a/extensions/suspend/views/emails/plain/unsuspended.blade.php +++ b/extensions/suspend/views/emails/plain/unsuspended.blade.php @@ -2,7 +2,6 @@ @section('content') {!! $translator->trans('flarum-suspend.email.unsuspended.plain.body', [ -'{recipient_display_name}' => $user->display_name, '{forum_url}' => $url->to('forum')->base(), ]) !!} @endsection From 55680c457342652bd3536797e1bab5837eeb8a8c Mon Sep 17 00:00:00 2001 From: IanM Date: Tue, 26 Sep 2023 08:54:10 +0100 Subject: [PATCH 56/60] add mail_format to install step --- framework/core/src/Install/Steps/WriteSettings.php | 1 + 1 file changed, 1 insertion(+) diff --git a/framework/core/src/Install/Steps/WriteSettings.php b/framework/core/src/Install/Steps/WriteSettings.php index 28dd0c70e1..b62c535157 100644 --- a/framework/core/src/Install/Steps/WriteSettings.php +++ b/framework/core/src/Install/Steps/WriteSettings.php @@ -58,6 +58,7 @@ private function getDefaults(): array 'forum_title' => 'A new Flarum forum', 'forum_description' => '', 'mail_driver' => 'mail', + 'mail_format' => 'multipart', 'mail_from' => 'noreply@localhost', 'slug_driver_Flarum\User\User' => 'default', 'theme_colored_header' => '0', From 412a207fc29406a9539e2f41aed84f0b1481dea4 Mon Sep 17 00:00:00 2001 From: IanM Date: Thu, 28 Sep 2023 16:40:22 +0100 Subject: [PATCH 57/60] allow greeting or signoff to be disabled per template, or globally --- framework/core/src/Forum/ForumServiceProvider.php | 4 +++- framework/core/views/email/html/base.blade.php | 4 ++++ framework/core/views/email/plain/base.blade.php | 6 ++++-- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/framework/core/src/Forum/ForumServiceProvider.php b/framework/core/src/Forum/ForumServiceProvider.php index 57af25e609..a87dcbbb45 100644 --- a/framework/core/src/Forum/ForumServiceProvider.php +++ b/framework/core/src/Forum/ForumServiceProvider.php @@ -148,7 +148,9 @@ public function boot(Container $container, Dispatcher $events, Factory $view): v $view->share([ 'translator' => $container->make(TranslatorInterface::class), 'settings' => $container->make(SettingsRepositoryInterface::class), - 'formatter' => $container->make(Formatter::class) + 'formatter' => $container->make(Formatter::class), + 'greeting' => true, + 'signofff' => true ]); $events->listen( diff --git a/framework/core/views/email/html/base.blade.php b/framework/core/views/email/html/base.blade.php index cab4e964ae..b9c7900b9f 100644 --- a/framework/core/views/email/html/base.blade.php +++ b/framework/core/views/email/html/base.blade.php @@ -61,15 +61,19 @@
+ @if(isset($greeting) && $greeting !== false)

{!! $translator->trans('core.email.greeting', ['displayName' => $username]) !!}

+ @endif
@yield('content')
+ @if(isset($signoff) && $signoff !== false)

{!! $translator->trans('core.email.signoff', ['forumTitle' => $settings->get('forum_title')]) !!}

+ @endif
diff --git a/framework/core/views/email/plain/base.blade.php b/framework/core/views/email/plain/base.blade.php index 1bc040a72f..ec2fbf1378 100644 --- a/framework/core/views/email/plain/base.blade.php +++ b/framework/core/views/email/plain/base.blade.php @@ -1,12 +1,14 @@ @yield('header') - +@if(isset($greeting) && $greeting !== false) {{ $translator->trans('core.email.greeting', ['displayName' => $username]) }} +@endif @yield('content') +@if(isset($signoff) && $signoff !== false) - {{ $translator->trans('core.email.signoff', ['forumTitle' => $settings->get('forum_title')]) }} - - +@endif @yield('footer') From c4901f73b8543d5e7144d8823ef42a34d0af30df Mon Sep 17 00:00:00 2001 From: Sami Mazouz Date: Fri, 29 Sep 2023 15:54:40 +0100 Subject: [PATCH 58/60] chore: re-use the existing information email job --- .../Api/Controller/SendTestMailController.php | 32 ++++++++----------- framework/core/src/Queue/QueueFactory.php | 2 +- .../src/User/Job/RequestPasswordResetJob.php | 2 +- 3 files changed, 15 insertions(+), 21 deletions(-) diff --git a/framework/core/src/Api/Controller/SendTestMailController.php b/framework/core/src/Api/Controller/SendTestMailController.php index 8d94f837b6..bd67d4693d 100644 --- a/framework/core/src/Api/Controller/SendTestMailController.php +++ b/framework/core/src/Api/Controller/SendTestMailController.php @@ -11,9 +11,10 @@ use Flarum\Http\RequestUtil; use Flarum\Locale\TranslatorInterface; +use Flarum\Mail\Job\SendInformationalEmailJob; use Flarum\Settings\SettingsRepositoryInterface; use Illuminate\Contracts\Mail\Mailer; -use Illuminate\Mail\Message; +use Illuminate\Contracts\Queue\Factory; use Laminas\Diactoros\Response\EmptyResponse; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -24,7 +25,8 @@ class SendTestMailController implements RequestHandlerInterface public function __construct( protected Mailer $mailer, protected TranslatorInterface $translator, - protected SettingsRepositoryInterface $settings + protected SettingsRepositoryInterface $settings, + protected Factory $queue ) { } @@ -33,23 +35,15 @@ public function handle(ServerRequestInterface $request): ResponseInterface $actor = RequestUtil::getActor($request); $actor->assertAdmin(); - $infoContent = $this->translator->trans('core.email.send_test.body'); - - $title = $this->translator->trans('core.email.send_test.subject'); - $forumTitle = $this->settings->get('forum_title'); - $userEmail = $actor->email; - $username = $actor->display_name; - - $this->mailer->send( - [ - 'text' => 'flarum.forum::email.plain.information.base', - 'html' => 'flarum.forum::email.html.information.base' - ], - compact('infoContent', 'userEmail', 'forumTitle', 'title', 'username'), - function (Message $message) use ($actor) { - $message->to($actor->email); - $message->subject($this->translator->trans('core.email.send_test.subject')); - } + $this->queue->connection('sync')->push( + new SendInformationalEmailJob( + email: $actor->email, + displayName: $actor->display_name, + subject: $this->translator->trans('core.email.send_test.subject'), + body: $this->translator->trans('core.email.send_test.body'), + forumTitle: $this->settings->get('forum_title'), + bodyTitle: $this->translator->trans('core.email.send_test.subject') + ) ); return new EmptyResponse(); diff --git a/framework/core/src/Queue/QueueFactory.php b/framework/core/src/Queue/QueueFactory.php index 9701189be3..f4118875fd 100644 --- a/framework/core/src/Queue/QueueFactory.php +++ b/framework/core/src/Queue/QueueFactory.php @@ -18,7 +18,7 @@ class QueueFactory implements Factory /** * The cached queue instance. */ - private ?Queue $queue; + private ?Queue $queue = null; /** * Expects a callback that will be called to instantiate the queue adapter, diff --git a/framework/core/src/User/Job/RequestPasswordResetJob.php b/framework/core/src/User/Job/RequestPasswordResetJob.php index fb130765b8..de9eb8c4de 100644 --- a/framework/core/src/User/Job/RequestPasswordResetJob.php +++ b/framework/core/src/User/Job/RequestPasswordResetJob.php @@ -53,10 +53,10 @@ public function handle( $queue->push(new SendInformationalEmailJob( email: $user->email, + displayName: Arr::get($data, 'username'), subject: $subject, body: $body, forumTitle: Arr::get($data, 'forum'), - displayName: Arr::get($data, 'username'), bodyTitle: $subject )); } From 499f203d011f50588fb07b1e98aa422defee9228 Mon Sep 17 00:00:00 2001 From: Sami Mazouz Date: Fri, 29 Sep 2023 16:17:32 +0100 Subject: [PATCH 59/60] fix: allow disabling greeting from email blade template --- .../core/src/Forum/ForumServiceProvider.php | 2 -- framework/core/views/email/html/base.blade.php | 16 ++++++++-------- framework/core/views/email/plain/base.blade.php | 4 ++-- 3 files changed, 10 insertions(+), 12 deletions(-) diff --git a/framework/core/src/Forum/ForumServiceProvider.php b/framework/core/src/Forum/ForumServiceProvider.php index a87dcbbb45..a4db2dad6c 100644 --- a/framework/core/src/Forum/ForumServiceProvider.php +++ b/framework/core/src/Forum/ForumServiceProvider.php @@ -149,8 +149,6 @@ public function boot(Container $container, Dispatcher $events, Factory $view): v 'translator' => $container->make(TranslatorInterface::class), 'settings' => $container->make(SettingsRepositoryInterface::class), 'formatter' => $container->make(Formatter::class), - 'greeting' => true, - 'signofff' => true ]); $events->listen( diff --git a/framework/core/views/email/html/base.blade.php b/framework/core/views/email/html/base.blade.php index b9c7900b9f..b847fd67b1 100644 --- a/framework/core/views/email/html/base.blade.php +++ b/framework/core/views/email/html/base.blade.php @@ -61,18 +61,18 @@
- @if(isset($greeting) && $greeting !== false) -
-

{!! $translator->trans('core.email.greeting', ['displayName' => $username]) !!}

-
+ @if(!isset($greeting) || $greeting !== false) +
+

{!! $translator->trans('core.email.greeting', ['displayName' => $username]) !!}

+
@endif
@yield('content')
- @if(isset($signoff) && $signoff !== false) -
-

{!! $translator->trans('core.email.signoff', ['forumTitle' => $settings->get('forum_title')]) !!}

-
+ @if(!isset($signoff) || $signoff !== false) +
+

{!! $translator->trans('core.email.signoff', ['forumTitle' => $settings->get('forum_title')]) !!}

+
@endif
diff --git a/framework/core/views/email/plain/base.blade.php b/framework/core/views/email/plain/base.blade.php index ec2fbf1378..6d7180d569 100644 --- a/framework/core/views/email/plain/base.blade.php +++ b/framework/core/views/email/plain/base.blade.php @@ -1,12 +1,12 @@ @yield('header') -@if(isset($greeting) && $greeting !== false) +@if(!isset($greeting) || $greeting !== false) {{ $translator->trans('core.email.greeting', ['displayName' => $username]) }} @endif @yield('content') -@if(isset($signoff) && $signoff !== false) +@if(!isset($signoff) || $signoff !== false) - {{ $translator->trans('core.email.signoff', ['forumTitle' => $settings->get('forum_title')]) }} - @endif From 91da30807e75a58154696d6653158e7ed404fce1 Mon Sep 17 00:00:00 2001 From: Sami Mazouz Date: Fri, 29 Sep 2023 16:24:16 +0100 Subject: [PATCH 60/60] fix: error --- .../suspend/tests/integration/api/users/SuspendUserTest.php | 2 +- framework/core/views/email/plain/information/base.blade.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/extensions/suspend/tests/integration/api/users/SuspendUserTest.php b/extensions/suspend/tests/integration/api/users/SuspendUserTest.php index 86fd8f16d0..3cf84a05a2 100644 --- a/extensions/suspend/tests/integration/api/users/SuspendUserTest.php +++ b/extensions/suspend/tests/integration/api/users/SuspendUserTest.php @@ -50,7 +50,7 @@ public function can_suspend_user_if_allowed(?int $authenticatedAs, int $targetUs { $response = $this->sendSuspensionRequest($authenticatedAs, $targetUserId); - $this->assertEquals(200, $response->getStatusCode()); + $this->assertEquals(200, $response->getStatusCode(), $response->getBody()->getContents()); } /** diff --git a/framework/core/views/email/plain/information/base.blade.php b/framework/core/views/email/plain/information/base.blade.php index bec65b6e8f..794995f269 100644 --- a/framework/core/views/email/plain/information/base.blade.php +++ b/framework/core/views/email/plain/information/base.blade.php @@ -5,7 +5,7 @@ @endsection @section('content') -{{ $infoContent }} +{{ $infoContent ?? '' }} @endsection @section('footer')