tdesktop/Telegram/SourceFiles/history/history_item.h

512 lines
14 KiB
C++

/*
This file is part of Telegram Desktop,
the official desktop application for the Telegram messaging service.
For license and copyright information please follow this link:
https://github.com/telegramdesktop/tdesktop/blob/master/LEGAL
*/
#pragma once
#include "base/runtime_composer.h"
#include "base/flags.h"
#include "data/data_media_types.h"
#include "history/history_item_edition.h"
#include "history/history_item_reply_markup.h"
#include <any>
struct HistoryMessageReplyMarkup;
class ReplyKeyboard;
class HistoryMessage;
namespace base {
template <typename Enum>
class enum_mask;
} // namespace base
namespace Storage {
enum class SharedMediaType : signed char;
using SharedMediaTypesMask = base::enum_mask<SharedMediaType>;
} // namespace Storage
namespace Ui {
class RippleAnimation;
} // namespace Ui
namespace style {
struct BotKeyboardButton;
struct RippleAnimation;
} // namespace style
namespace Data {
struct MessagePosition;
struct RecentReaction;
struct ReactionId;
class Media;
struct MessageReaction;
class MessageReactions;
class ForumTopic;
class Thread;
} // namespace Data
namespace Main {
class Session;
} // namespace Main
namespace Window {
class SessionController;
} // namespace Window
namespace HistoryUnreadThings {
enum class AddType;
} // namespace HistoryUnreadThings
namespace HistoryView {
struct TextState;
struct StateRequest;
enum class CursorState : char;
enum class PointState : char;
enum class Context : char;
class ElementDelegate;
} // namespace HistoryView
class HiddenSenderInfo;
class History;
[[nodiscard]] MessageFlags FlagsFromMTP(
MsgId id,
MTPDmessage::Flags flags,
MessageFlags localFlags);
[[nodiscard]] MessageFlags FlagsFromMTP(
MsgId id,
MTPDmessageService::Flags flags,
MessageFlags localFlags);
class HistoryItem : public RuntimeComposer<HistoryItem> {
public:
static not_null<HistoryItem*> Create(
not_null<History*> history,
MsgId id,
const MTPMessage &message,
MessageFlags localFlags);
struct Destroyer {
void operator()(HistoryItem *value);
};
virtual void dependencyItemRemoved(HistoryItem *dependency) {
}
virtual bool updateDependencyItem() {
return true;
}
virtual MsgId dependencyMsgId() const {
return 0;
}
virtual void checkBuyButton() {
}
[[nodiscard]] virtual bool notificationReady() const {
return true;
}
[[nodiscard]] PeerData *specialNotificationPeer() const;
[[nodiscard]] UserData *viaBot() const;
[[nodiscard]] UserData *getMessageBot() const;
[[nodiscard]] bool isHistoryEntry() const;
[[nodiscard]] bool isAdminLogEntry() const;
[[nodiscard]] bool isFromScheduled() const;
[[nodiscard]] bool isScheduled() const;
[[nodiscard]] bool isSponsored() const;
[[nodiscard]] bool skipNotification() const;
void addLogEntryOriginal(
WebPageId localId,
const QString &label,
const TextWithEntities &content);
[[nodiscard]] not_null<Data::Thread*> notificationThread() const;
[[nodiscard]] not_null<History*> history() const {
return _history;
}
[[nodiscard]] Data::ForumTopic *topic() const;
[[nodiscard]] not_null<PeerData*> from() const {
return _from;
}
[[nodiscard]] HistoryView::Element *mainView() const {
return _mainView;
}
void setMainView(not_null<HistoryView::Element*> view) {
_mainView = view;
}
void refreshMainView();
void clearMainView();
void removeMainView();
void invalidateChatListEntry();
void destroy();
[[nodiscard]] bool out() const {
return _flags & MessageFlag::Outgoing;
}
[[nodiscard]] bool isPinned() const {
return _flags & MessageFlag::Pinned;
}
[[nodiscard]] bool unread(not_null<Data::Thread*> thread) const;
[[nodiscard]] bool showNotification() const;
void markClientSideAsRead();
[[nodiscard]] bool mentionsMe() const;
[[nodiscard]] bool isUnreadMention() const;
[[nodiscard]] bool hasUnreadReaction() const;
[[nodiscard]] bool isUnreadMedia() const;
[[nodiscard]] bool isIncomingUnreadMedia() const;
[[nodiscard]] bool hasUnreadMediaFlag() const;
void markReactionsRead();
void markMediaAndMentionRead();
bool markContentsRead(bool fromThisClient = false);
void setIsPinned(bool isPinned);
// For edit media in history_message.
virtual void returnSavedMedia();
void savePreviousMedia();
[[nodiscard]] bool isEditingMedia() const;
void clearSavedMedia();
// Zero result means this message is not self-destructing right now.
virtual crl::time getSelfDestructIn(crl::time now) {
return 0;
}
[[nodiscard]] bool definesReplyKeyboard() const;
[[nodiscard]] ReplyMarkupFlags replyKeyboardFlags() const;
[[nodiscard]] bool hasSwitchInlineButton() const {
return _flags & MessageFlag::HasSwitchInlineButton;
}
[[nodiscard]] bool hasTextLinks() const {
return _flags & MessageFlag::HasTextLinks;
}
[[nodiscard]] bool isGroupEssential() const {
return _flags & MessageFlag::IsGroupEssential;
}
[[nodiscard]] bool isLocalUpdateMedia() const {
return _flags & MessageFlag::IsLocalUpdateMedia;
}
void setIsLocalUpdateMedia(bool flag) {
if (flag) {
_flags |= MessageFlag::IsLocalUpdateMedia;
} else {
_flags &= ~MessageFlag::IsLocalUpdateMedia;
}
}
[[nodiscard]] bool isGroupMigrate() const {
return isGroupEssential() && isEmpty();
}
[[nodiscard]] bool hasViews() const {
return _flags & MessageFlag::HasViews;
}
[[nodiscard]] bool isPost() const {
return _flags & MessageFlag::Post;
}
[[nodiscard]] bool isSilent() const {
return _flags & MessageFlag::Silent;
}
[[nodiscard]] bool isSending() const {
return _flags & MessageFlag::BeingSent;
}
[[nodiscard]] bool hasFailed() const {
return _flags & MessageFlag::SendingFailed;
}
[[nodiscard]] bool hideEditedBadge() const {
return (_flags & MessageFlag::HideEdited);
}
[[nodiscard]] bool isLocal() const {
return _flags & MessageFlag::Local;
}
[[nodiscard]] bool isRegular() const;
[[nodiscard]] bool isUploading() const;
void sendFailed();
[[nodiscard]] virtual int viewsCount() const {
return hasViews() ? 1 : -1;
}
[[nodiscard]] virtual int repliesCount() const {
return 0;
}
[[nodiscard]] virtual bool repliesAreComments() const {
return false;
}
[[nodiscard]] virtual bool externalReply() const {
return false;
}
[[nodiscard]] bool hasExtendedMediaPreview() const;
virtual void setCommentsInboxReadTill(MsgId readTillId) {
}
virtual void setCommentsMaxId(MsgId maxId) {
}
virtual void setCommentsPossibleMaxId(MsgId possibleMaxId) {
}
[[nodiscard]] virtual bool areCommentsUnread() const {
return false;
}
[[nodiscard]] virtual FullMsgId commentsItemId() const {
return FullMsgId();
}
virtual void setCommentsItemId(FullMsgId id) {
}
[[nodiscard]] virtual bool needCheck() const;
[[nodiscard]] virtual bool isService() const {
return false;
}
virtual void applyEdition(HistoryMessageEdition &&edition) {
}
virtual void applyEdition(const MTPDmessageService &message) {
}
virtual void applyEdition(const MTPMessageExtendedMedia &media) {
}
void applyEditionToHistoryCleared();
virtual void updateSentContent(
const TextWithEntities &textWithEntities,
const MTPMessageMedia *media) {
}
virtual void updateReplyMarkup(HistoryMessageMarkupData &&markup) {
}
virtual void updateForwardedInfo(const MTPMessageFwdHeader *fwd) {
}
virtual void contributeToSlowmode(TimeId realDate = 0) {
}
virtual void addToUnreadThings(HistoryUnreadThings::AddType type);
virtual void destroyHistoryEntry() {
}
[[nodiscard]] virtual Storage::SharedMediaTypesMask sharedMediaTypes() const = 0;
virtual void applySentMessage(const MTPDmessage &data);
virtual void applySentMessage(
const QString &text,
const MTPDupdateShortSentMessage &data,
bool wasAlready);
void indexAsNewItem();
[[nodiscard]] virtual QString notificationHeader() const {
return QString();
}
[[nodiscard]] virtual TextWithEntities notificationText() const;
using ToPreviewOptions = HistoryView::ToPreviewOptions;
using ItemPreview = HistoryView::ItemPreview;
// Returns text with link-start and link-end commands for service-color highlighting.
// Example: "[link1-start]You:[link1-end] [link1-start]Photo,[link1-end] caption text"
[[nodiscard]] virtual ItemPreview toPreview(
ToPreviewOptions options) const;
[[nodiscard]] virtual TextWithEntities inReplyText() const;
[[nodiscard]] virtual TextWithEntities originalText() const {
return TextWithEntities();
}
[[nodiscard]] virtual auto originalTextWithLocalEntities() const
-> TextWithEntities {
return TextWithEntities();
}
[[nodiscard]] virtual auto customTextLinks() const
-> const std::vector<ClickHandlerPtr> &;
[[nodiscard]] virtual TextForMimeData clipboardText() const {
return TextForMimeData();
}
virtual bool changeViewsCount(int count) {
return false;
}
virtual void setForwardsCount(int count) {
}
virtual void setReplies(HistoryMessageRepliesData &&data) {
}
virtual void clearReplies() {
}
virtual void changeRepliesCount(int delta, PeerId replier) {
}
virtual void setReplyFields(
MsgId replyTo,
MsgId replyToTop,
bool isForumPost) = 0;
virtual void setPostAuthor(const QString &author) {
}
virtual void setRealId(MsgId newId);
virtual void incrementReplyToTopCounter() {
}
[[nodiscard]] bool emptyText() const {
return _text.empty();
}
[[nodiscard]] bool canPin() const;
[[nodiscard]] bool canBeEdited() const;
[[nodiscard]] bool canStopPoll() const;
[[nodiscard]] bool forbidsForward() const;
[[nodiscard]] virtual bool allowsSendNow() const;
[[nodiscard]] virtual bool allowsForward() const;
[[nodiscard]] virtual bool allowsEdit(TimeId now) const;
[[nodiscard]] bool canDelete() const;
[[nodiscard]] bool canDeleteForEveryone(TimeId now) const;
[[nodiscard]] bool suggestReport() const;
[[nodiscard]] bool suggestBanReport() const;
[[nodiscard]] bool suggestDeleteAllReport() const;
[[nodiscard]] bool canReact() const;
enum class ReactionSource {
Selector,
Quick,
Existing,
};
void toggleReaction(
const Data::ReactionId &reaction,
ReactionSource source);
void updateReactions(const MTPMessageReactions *reactions);
void updateReactionsUnknown();
[[nodiscard]] auto reactions() const
-> const std::vector<Data::MessageReaction> &;
[[nodiscard]] auto recentReactions() const
-> const base::flat_map<
Data::ReactionId,
std::vector<Data::RecentReaction>> &;
[[nodiscard]] bool canViewReactions() const;
[[nodiscard]] std::vector<Data::ReactionId> chosenReactions() const;
[[nodiscard]] Data::ReactionId lookupUnreadReaction(
not_null<UserData*> from) const;
[[nodiscard]] crl::time lastReactionsRefreshTime() const;
[[nodiscard]] bool hasDirectLink() const;
[[nodiscard]] FullMsgId fullId() const;
[[nodiscard]] GlobalMsgId globalId() const;
[[nodiscard]] Data::MessagePosition position() const;
[[nodiscard]] TimeId date() const;
[[nodiscard]] static TimeId NewMessageDate(TimeId scheduled);
[[nodiscard]] Data::Media *media() const {
return _media.get();
}
[[nodiscard]] bool computeDropForwardedInfo() const;
virtual void setText(const TextWithEntities &textWithEntities) {
}
[[nodiscard]] virtual MsgId replyToId() const = 0;
[[nodiscard]] virtual MsgId replyToTop() const = 0;
[[nodiscard]] virtual MsgId topicRootId() const = 0;
[[nodiscard]] bool inThread(MsgId rootId) const;
[[nodiscard]] not_null<PeerData*> author() const;
[[nodiscard]] TimeId dateOriginal() const;
[[nodiscard]] PeerData *senderOriginal() const;
[[nodiscard]] const HiddenSenderInfo *hiddenSenderInfo() const;
[[nodiscard]] not_null<PeerData*> fromOriginal() const;
[[nodiscard]] QString authorOriginal() const;
[[nodiscard]] MsgId idOriginal() const;
[[nodiscard]] bool isEmpty() const;
[[nodiscard]] MessageGroupId groupId() const;
[[nodiscard]] const HistoryMessageReplyMarkup *inlineReplyMarkup() const {
return const_cast<HistoryItem*>(this)->inlineReplyMarkup();
}
[[nodiscard]] const ReplyKeyboard *inlineReplyKeyboard() const {
return const_cast<HistoryItem*>(this)->inlineReplyKeyboard();
}
[[nodiscard]] HistoryMessageReplyMarkup *inlineReplyMarkup();
[[nodiscard]] ReplyKeyboard *inlineReplyKeyboard();
[[nodiscard]] ChannelData *discussionPostOriginalSender() const;
[[nodiscard]] bool isDiscussionPost() const;
[[nodiscard]] HistoryItem *lookupDiscussionPostOriginal() const;
[[nodiscard]] PeerData *displayFrom() const;
[[nodiscard]] virtual std::unique_ptr<HistoryView::Element> createView(
not_null<HistoryView::ElementDelegate*> delegate,
HistoryView::Element *replacing = nullptr) = 0;
void updateDate(TimeId newDate);
[[nodiscard]] bool canUpdateDate() const;
void customEmojiRepaint();
[[nodiscard]] TimeId ttlDestroyAt() const {
return _ttlDestroyAt;
}
virtual ~HistoryItem();
MsgId id;
protected:
HistoryItem(
not_null<History*> history,
MsgId id,
MessageFlags flags,
TimeId date,
PeerId from);
virtual void markMediaAsReadHook() {
}
void applyServiceDateEdition(const MTPDmessageService &data);
void finishEdition(int oldKeyboardTop);
void finishEditionToEmpty();
void setReactions(const MTPMessageReactions *reactions);
[[nodiscard]] bool changeReactions(const MTPMessageReactions *reactions);
const not_null<History*> _history;
const not_null<PeerData*> _from;
MessageFlags _flags = 0;
void setGroupId(MessageGroupId groupId);
void applyTTL(const MTPDmessage &data);
void applyTTL(const MTPDmessageService &data);
void applyTTL(TimeId destroyAt);
TextWithEntities _text;
struct SavedMediaData {
TextWithEntities text;
std::unique_ptr<Data::Media> media;
};
std::unique_ptr<SavedMediaData> _savedLocalEditMediaData;
std::unique_ptr<Data::Media> _media;
std::unique_ptr<Data::MessageReactions> _reactions;
crl::time _reactionsLastRefreshed = 0;
private:
TimeId _date = 0;
TimeId _ttlDestroyAt = 0;
HistoryView::Element *_mainView = nullptr;
friend class HistoryView::Element;
MessageGroupId _groupId = MessageGroupId();
};
[[nodiscard]] Main::Session *SessionByUniqueId(uint64 sessionUniqueId);
[[nodiscard]] HistoryItem *MessageByGlobalId(GlobalMsgId globalId);
[[nodiscard]] QDateTime ItemDateTime(not_null<const HistoryItem*> item);
[[nodiscard]] QString ItemDateText(
not_null<const HistoryItem*> item,
bool isUntilOnline);
[[nodiscard]] bool IsItemScheduledUntilOnline(
not_null<const HistoryItem*> item);
ClickHandlerPtr goToMessageClickHandler(
not_null<PeerData*> peer,
MsgId msgId,
FullMsgId returnToId = FullMsgId());
ClickHandlerPtr goToMessageClickHandler(
not_null<HistoryItem*> item,
FullMsgId returnToId = FullMsgId());