mirror of
https://github.com/discourse/discourse.git
synced 2024-11-22 12:57:29 +08:00
e9aa2c96e1
We have a dedicated admin page (`/admin/customize/email_templates`) that lets admins customize all emails that Discourse sends to users. The way this page works is that it lists all translations strings that are used for emails, and the list of translation strings is currently hardcoded and hasn't been updated in years. We've had a number of new emails that Discourse sends, so we should add those templates to the list to let admins easily customize those templates. Meta topic: https://meta.discourse.org/t/3-2-x-still-ignores-some-custom-email-templates/308203.
234 lines
8.2 KiB
Ruby
234 lines
8.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
class Admin::EmailTemplatesController < Admin::AdminController
|
|
# to update the list of keys below, run the `list_email_templates_strings`
|
|
# rake task and replace the list below with the output from the rake task
|
|
def self.email_keys
|
|
@email_keys ||= %w[
|
|
admin_confirmation_mailer
|
|
custom_invite_forum_mailer
|
|
custom_invite_mailer
|
|
download_backup_mailer
|
|
invite_forum_mailer
|
|
invite_mailer
|
|
invite_password_instructions
|
|
new_version_mailer
|
|
new_version_mailer_with_notes
|
|
system_messages.backup_failed
|
|
system_messages.backup_succeeded
|
|
system_messages.bulk_invite_failed
|
|
system_messages.bulk_invite_succeeded
|
|
system_messages.csv_export_failed
|
|
system_messages.csv_export_succeeded
|
|
system_messages.download_remote_images_disabled
|
|
system_messages.email_error_notification
|
|
system_messages.email_reject_attachment
|
|
system_messages.email_reject_auto_generated
|
|
system_messages.email_reject_bad_destination_address
|
|
system_messages.email_reject_empty
|
|
system_messages.email_reject_inactive_user
|
|
system_messages.email_reject_insufficient_trust_level
|
|
system_messages.email_reject_invalid_access
|
|
system_messages.email_reject_invalid_post
|
|
system_messages.email_reject_invalid_post_action
|
|
system_messages.email_reject_invalid_post_specified
|
|
system_messages.email_reject_not_allowed_email
|
|
system_messages.email_reject_old_destination
|
|
system_messages.email_reject_parsing
|
|
system_messages.email_reject_post_too_short
|
|
system_messages.email_reject_reply_key
|
|
system_messages.email_reject_reply_not_allowed
|
|
system_messages.email_reject_reply_to_digest
|
|
system_messages.email_reject_reply_user_not_matching
|
|
system_messages.email_reject_screened_email
|
|
system_messages.email_reject_silenced_user
|
|
system_messages.email_reject_strangers_not_allowed
|
|
system_messages.email_reject_too_many_recipients
|
|
system_messages.email_reject_topic_closed
|
|
system_messages.email_reject_topic_not_found
|
|
system_messages.email_reject_unrecognized_error
|
|
system_messages.email_reject_user_not_found
|
|
system_messages.email_revoked
|
|
system_messages.flags_agreed_and_post_deleted
|
|
system_messages.flags_agreed_and_post_deleted_for_responders
|
|
system_messages.flags_disagreed
|
|
system_messages.ignored_users_summary
|
|
system_messages.new_user_of_the_month
|
|
system_messages.pending_users_reminder
|
|
system_messages.post_hidden
|
|
system_messages.post_hidden_again
|
|
system_messages.queued_by_staff
|
|
system_messages.queued_posts_reminder
|
|
system_messages.restore_failed
|
|
system_messages.restore_succeeded
|
|
system_messages.reviewable_queued_post_revise_and_reject
|
|
system_messages.reviewable_queued_post_revise_and_reject_new_topic
|
|
system_messages.reviewables_reminder
|
|
system_messages.silenced_by_staff
|
|
system_messages.spam_post_blocked
|
|
system_messages.tl2_promotion_message
|
|
system_messages.too_many_spam_flags
|
|
system_messages.too_many_tl3_flags
|
|
system_messages.unsilenced
|
|
system_messages.user_added_to_group_as_member
|
|
system_messages.user_added_to_group_as_owner
|
|
system_messages.user_automatically_silenced
|
|
system_messages.welcome_invite
|
|
system_messages.welcome_staff
|
|
system_messages.welcome_tl1_user
|
|
system_messages.welcome_user
|
|
test_mailer
|
|
unsubscribe_mailer
|
|
user_notifications.account_created
|
|
user_notifications.account_exists
|
|
user_notifications.account_second_factor_disabled
|
|
user_notifications.account_silenced
|
|
user_notifications.account_silenced_forever
|
|
user_notifications.account_suspended
|
|
user_notifications.account_suspended_forever
|
|
user_notifications.activation_reminder
|
|
user_notifications.admin_login
|
|
user_notifications.confirm_new_email
|
|
user_notifications.confirm_new_email_via_admin
|
|
user_notifications.confirm_old_email
|
|
user_notifications.confirm_old_email_add
|
|
user_notifications.email_login
|
|
user_notifications.forgot_password
|
|
user_notifications.notify_old_email
|
|
user_notifications.notify_old_email_add
|
|
user_notifications.post_approved
|
|
user_notifications.set_password
|
|
user_notifications.signup
|
|
user_notifications.signup_after_approval
|
|
user_notifications.signup_after_reject
|
|
user_notifications.suspicious_login
|
|
user_notifications.user_group_mentioned
|
|
user_notifications.user_group_mentioned_pm
|
|
user_notifications.user_group_mentioned_pm_group
|
|
user_notifications.user_invited_to_private_message_pm
|
|
user_notifications.user_invited_to_private_message_pm_group
|
|
user_notifications.user_invited_to_private_message_pm_staged
|
|
user_notifications.user_invited_to_topic
|
|
user_notifications.user_linked
|
|
user_notifications.user_mentioned
|
|
user_notifications.user_mentioned_pm
|
|
user_notifications.user_posted
|
|
user_notifications.user_posted_pm
|
|
user_notifications.user_posted_pm_staged
|
|
user_notifications.user_quoted
|
|
user_notifications.user_replied
|
|
user_notifications.user_replied_pm
|
|
user_notifications.user_watching_category_or_tag
|
|
user_notifications.user_watching_first_post
|
|
]
|
|
end
|
|
|
|
def show
|
|
end
|
|
|
|
def update
|
|
et = params[:email_template]
|
|
key = params[:id]
|
|
raise Discourse::NotFound if self.class.email_keys.exclude?(params[:id])
|
|
|
|
subject_result = update_key("#{key}.subject_template", et[:subject])
|
|
body_result = update_key("#{key}.text_body_template", et[:body])
|
|
|
|
error_messages = []
|
|
if subject_result[:error_messages].present?
|
|
error_messages << format_error_message(subject_result, "subject")
|
|
end
|
|
if body_result[:error_messages].present?
|
|
error_messages << format_error_message(body_result, "body")
|
|
end
|
|
|
|
if error_messages.blank?
|
|
log_site_text_change(subject_result)
|
|
log_site_text_change(body_result)
|
|
|
|
render_serialized(
|
|
key,
|
|
AdminEmailTemplateSerializer,
|
|
root: "email_template",
|
|
rest_serializer: true,
|
|
)
|
|
else
|
|
TranslationOverride.upsert!(
|
|
I18n.locale,
|
|
"#{key}.subject_template",
|
|
subject_result[:old_value],
|
|
)
|
|
TranslationOverride.upsert!(I18n.locale, "#{key}.text_body_template", body_result[:old_value])
|
|
|
|
render_json_error(error_messages)
|
|
end
|
|
end
|
|
|
|
def revert
|
|
key = params[:id]
|
|
raise Discourse::NotFound if self.class.email_keys.exclude?(params[:id])
|
|
|
|
revert_and_log("#{key}.subject_template", "#{key}.text_body_template")
|
|
render_serialized(
|
|
key,
|
|
AdminEmailTemplateSerializer,
|
|
root: "email_template",
|
|
rest_serializer: true,
|
|
)
|
|
end
|
|
|
|
def index
|
|
render_serialized(
|
|
self.class.email_keys,
|
|
AdminEmailTemplateSerializer,
|
|
root: "email_templates",
|
|
rest_serializer: true,
|
|
overridden_keys: overridden_keys,
|
|
)
|
|
end
|
|
|
|
private
|
|
|
|
def update_key(key, value)
|
|
old_value = I18n.t(key)
|
|
|
|
unless old_value.is_a?(Hash)
|
|
translation_override = TranslationOverride.upsert!(I18n.locale, key, value)
|
|
end
|
|
|
|
{ key: key, old_value: old_value, error_messages: translation_override&.errors&.full_messages }
|
|
end
|
|
|
|
def revert_and_log(*keys)
|
|
old_values = {}
|
|
keys.each { |key| old_values[key] = I18n.t(key) }
|
|
|
|
TranslationOverride.revert!(I18n.locale, keys)
|
|
|
|
keys.each do |key|
|
|
old_value = old_values[key]
|
|
new_value = I18n.t(key)
|
|
StaffActionLogger.new(current_user).log_site_text_change(key, new_value, old_value)
|
|
end
|
|
end
|
|
|
|
def log_site_text_change(update_result)
|
|
new_value = I18n.t(update_result[:key])
|
|
StaffActionLogger.new(current_user).log_site_text_change(
|
|
update_result[:key],
|
|
new_value,
|
|
update_result[:old_value],
|
|
)
|
|
end
|
|
|
|
def format_error_message(update_result, attribute_key)
|
|
attribute = I18n.t("admin_js.admin.customize.email_templates.#{attribute_key}")
|
|
message = update_result[:error_messages].join("<br>")
|
|
I18n.t("errors.format_with_full_message", attribute: attribute, message: message)
|
|
end
|
|
|
|
def overridden_keys
|
|
TranslationOverride.where(locale: I18n.locale).pluck(:translation_key)
|
|
end
|
|
end
|