mirror of
https://github.com/discourse/discourse.git
synced 2026-08-11 02:59:07 +08:00
af5329588eAllow staff to pin important messages in chat channels. Pinned messages appear in a dedicated panel accessible from the channel navbar. Members of allowed groups (admins/moderators by default) can pin and unpin messages via the message actions menu. Pinned messages show "pinned by" attribution, track unread state per user, and auto-unpin when the original message is trashed. Real-time updates via MessageBus keep the pinned list in sync. Gated behind the chat_pinned_messages upcoming change (experimental).
107 lines
2.9 KiB
Ruby
Vendored
107 lines
2.9 KiB
Ruby
Vendored
# frozen_string_literal: true
|
|
|
|
module Chat
|
|
# Service responsible for trashing a chat message
|
|
# for a channel and ensuring that the client and read state is
|
|
# updated.
|
|
#
|
|
# @example
|
|
# Chat::TrashMessage.call(params: { message_id: 2, channel_id: 1 }, guardian: guardian)
|
|
#
|
|
class TrashMessage
|
|
include Service::Base
|
|
|
|
# @!method self.call(guardian:, params:)
|
|
# @param [Guardian] guardian
|
|
# @param [Hash] params
|
|
# @option params [Integer] :message_id
|
|
# @option params [Integer] :channel_id
|
|
# @return [Service::Base::Context]
|
|
|
|
params do
|
|
attribute :message_id, :integer
|
|
attribute :channel_id, :integer
|
|
|
|
validates :message_id, presence: true
|
|
validates :channel_id, presence: true
|
|
end
|
|
|
|
model :message
|
|
policy :invalid_access
|
|
|
|
model :pinned_message, optional: true
|
|
|
|
transaction do
|
|
step :trash_message
|
|
step :destroy_pin
|
|
step :destroy_notifications
|
|
step :update_last_message_ids
|
|
step :update_tracking_state
|
|
step :update_thread_reply_cache
|
|
end
|
|
|
|
step :publish_events
|
|
|
|
private
|
|
|
|
def fetch_message(params:)
|
|
Chat::Message.includes(chat_channel: :chatable).find_by(
|
|
id: params.message_id,
|
|
chat_channel_id: params.channel_id,
|
|
)
|
|
end
|
|
|
|
def invalid_access(guardian:, message:)
|
|
guardian.can_delete_chat?(message, message.chat_channel.chatable)
|
|
end
|
|
|
|
def trash_message(message:, guardian:)
|
|
message.trash!(guardian.user)
|
|
end
|
|
|
|
def fetch_pinned_message(message:)
|
|
message.pinned_message
|
|
end
|
|
|
|
def destroy_pin(pinned_message:)
|
|
pinned_message&.destroy!
|
|
end
|
|
|
|
def destroy_notifications(message:)
|
|
Notification.where(
|
|
id:
|
|
Chat::Mention
|
|
.where(chat_message: message)
|
|
.joins(:notifications)
|
|
.select("notifications.id"),
|
|
).destroy_all
|
|
end
|
|
|
|
def update_tracking_state(message:)
|
|
::Chat::Action::ResetUserLastReadChannelMessage.call([message.id], [message.chat_channel_id])
|
|
if message.thread_id.present?
|
|
::Chat::Action::ResetUserLastReadThreadMessage.call([message.id], [message.thread_id])
|
|
end
|
|
end
|
|
|
|
def update_thread_reply_cache(message:)
|
|
message.thread&.decrement_replies_count_cache
|
|
end
|
|
|
|
def update_last_message_ids(message:)
|
|
message.thread&.update_last_message_id!
|
|
message.chat_channel.update_last_message_id!
|
|
end
|
|
|
|
def publish_events(guardian:, message:, pinned_message:)
|
|
DiscourseEvent.trigger(:chat_message_trashed, message, message.chat_channel, guardian.user)
|
|
Chat::Publisher.publish_delete!(message.chat_channel, message)
|
|
|
|
Chat::Publisher.publish_unpin!(message.chat_channel, message, guardian.user) if pinned_message
|
|
|
|
if message.thread.present?
|
|
Chat::Publisher.publish_thread_original_message_metadata!(message.thread)
|
|
end
|
|
end
|
|
end
|
|
end
|
