/***************************************************************************
- * Copyright (C) 2005-08 by the Quassel Project *
+ * Copyright (C) 2005-2018 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
-#ifndef NETWORKMODEL_H
-#define NETWORKMODEL_H
+#pragma once
-#include <QtCore>
+#include "client-export.h"
+#include "bufferinfo.h"
+#include "clientsettings.h"
+#include "message.h"
+#include "network.h"
#include "treemodel.h"
-#include "buffer.h"
-#include <QPointer>
+class BufferItem;
+class StatusBufferItem;
-class BufferInfo;
+/*****************************************
+ * Network Items
+ *****************************************/
+class NetworkItem : public PropertyMapItem
+{
+ Q_OBJECT
+ Q_PROPERTY(QString networkName READ networkName)
+ Q_PROPERTY(QString currentServer READ currentServer)
+ Q_PROPERTY(int nickCount READ nickCount)
-#include "selectionmodelsynchronizer.h"
-#include "modelpropertymapper.h"
-#include "clientsettings.h"
+public:
+ NetworkItem(const NetworkId& netid, AbstractTreeItem* parent = nullptr);
+
+ QStringList propertyOrder() const override;
+
+ QVariant data(int column, int row) const override;
+
+ /**
+ * Escapes a string as HTML, ready for Qt markup.
+ *
+ * Implementation depends on Qt version - Qt4 uses Qt::escape, while Qt5 uses .toHtmlEscaped().
+ *
+ * @param[in] string QString to escape
+ * @param[in] useNonbreakingSpaces
+ * @parblock
+ * If true, replace spaces with non-breaking spaces (i.e. ' '), otherwise only HTML escape.
+ * @endparblock
+ */
+ static QString escapeHTML(const QString& string, bool useNonbreakingSpaces = false);
-class MappedSelectionModel;
-class QAbstractItemView;
-class Network;
-class IrcChannel;
-class IrcUser;
+ inline bool isActive() const { return (bool)_network ? _network->isConnected() : false; }
+
+ inline const NetworkId& networkId() const { return _networkId; }
+ inline QString networkName() const { return (bool)_network ? _network->networkName() : QString(); }
+ inline QString currentServer() const { return (bool)_network ? _network->currentServer() : QString(); }
+ inline int nickCount() const { return (bool)_network ? _network->ircUsers().count() : 0; }
+
+ QString toolTip(int column) const override;
+
+ BufferItem* findBufferItem(BufferId bufferId);
+ inline BufferItem* findBufferItem(const BufferInfo& bufferInfo) { return findBufferItem(bufferInfo.bufferId()); }
+ BufferItem* bufferItem(const BufferInfo& bufferInfo);
+ inline StatusBufferItem* statusBufferItem() const { return _statusBufferItem; }
+
+public slots:
+ void setNetworkName(const QString& networkName);
+ void setCurrentServer(const QString& serverName);
+
+ void attachNetwork(Network* network);
+ void attachIrcChannel(IrcChannel* channel);
+ void attachIrcUser(IrcUser* ircUser);
+
+signals:
+ void networkDataChanged(int column = -1);
+
+private slots:
+ void onBeginRemoveChilds(int start, int end);
+ void onNetworkDestroyed();
+
+private:
+ NetworkId _networkId;
+ StatusBufferItem* _statusBufferItem;
+
+ QPointer<Network> _network;
+};
/*****************************************
* Fancy Buffer Items
*****************************************/
-class BufferItem : public PropertyMapItem {
- Q_OBJECT
- Q_PROPERTY(QString bufferName READ bufferName WRITE setBufferName)
- Q_PROPERTY(QString topic READ topic)
- Q_PROPERTY(int nickCount READ nickCount)
+class BufferItem : public PropertyMapItem
+{
+ Q_OBJECT
+ Q_PROPERTY(QString bufferName READ bufferName WRITE setBufferName)
+ Q_PROPERTY(QString topic READ topic)
+ Q_PROPERTY(int nickCount READ nickCount)
public:
- BufferItem(BufferInfo bufferInfo, AbstractTreeItem *parent = 0);
+ BufferItem(BufferInfo bufferInfo, AbstractTreeItem* parent = nullptr);
- inline const BufferInfo &bufferInfo() const { return _bufferInfo; }
- virtual quint64 id() const;
- virtual QVariant data(int column, int role) const;
- virtual bool setData(int column, const QVariant &value, int role);
+ QStringList propertyOrder() const override;
- void attachIrcChannel(IrcChannel *ircChannel);
+ inline const BufferInfo& bufferInfo() const { return _bufferInfo; }
+ QVariant data(int column, int role) const override;
+ bool setData(int column, const QVariant& value, int role) override;
- QString bufferName() const;
- inline BufferId bufferId() const { return _bufferInfo.bufferId(); }
- inline BufferInfo::Type bufferType() const { return _bufferInfo.type(); }
+ inline BufferId bufferId() const { return _bufferInfo.bufferId(); }
+ inline BufferInfo::Type bufferType() const { return _bufferInfo.type(); }
- void setBufferName(const QString &name);
- QString topic() const;
- int nickCount() const;
+ virtual void setBufferName(const QString& name);
+ virtual inline QString bufferName() const { return _bufferInfo.bufferName(); }
+ virtual inline QString topic() const { return QString(); }
+ virtual inline int nickCount() const { return 0; }
- // bool isStatusBuffer() const;
+ virtual inline bool isActive() const { return qobject_cast<NetworkItem*>(parent())->isActive(); }
- bool isActive() const;
+ inline MsgId lastSeenMsgId() const { return _lastSeenMsgId; }
+ inline MsgId markerLineMsgId() const { return _markerLineMsgId; }
+ void setLastSeenMsgId(MsgId msgId);
+ void setMarkerLineMsgId(MsgId msgId);
- inline Buffer::ActivityLevel activityLevel() const { return _activity; }
- bool setActivityLevel(Buffer::ActivityLevel level);
- void updateActivityLevel(Buffer::ActivityLevel level);
+ inline BufferInfo::ActivityLevel activityLevel() const { return _activity; }
+ void setActivityLevel(BufferInfo::ActivityLevel level);
+ void clearActivityLevel();
+ void updateActivityLevel(const Message& msg);
+ void setActivity(Message::Types msg, bool highlight);
+ bool addActivity(Message::Types msg, bool highlight);
- void setLastMsgInsert(QDateTime msgDate);
- bool setLastSeen();
- QDateTime lastSeen();
+ inline const MsgId& firstUnreadMsgId() const { return _firstUnreadMsgId; }
- virtual QString toolTip(int column) const;
+ bool isCurrentBuffer() const;
+ QString toolTip(int column) const override;
public slots:
- void setTopic(const QString &topic);
- void join(const QList<IrcUser *> &ircUsers);
- void part(IrcUser *ircUser);
+ virtual inline void setTopic(const QString&) { emit dataChanged(1); }
+ virtual inline void setEncrypted(bool) { emit dataChanged(); }
- void addUserToCategory(IrcUser *ircUser);
- void addUsersToCategory(const QList<IrcUser *> &ircUser);
- void removeUserFromCategory(IrcUser *ircUser);
- void userModeChanged(IrcUser *ircUser);
+private:
+ BufferInfo _bufferInfo;
+ BufferInfo::ActivityLevel _activity;
+ MsgId _lastSeenMsgId;
+ MsgId _markerLineMsgId;
+ MsgId _firstUnreadMsgId;
+};
-private slots:
- void ircChannelDestroyed();
- void ircUserDestroyed();
+/*****************************************
+ * StatusBufferItem
+ *****************************************/
+class StatusBufferItem : public BufferItem
+{
+ Q_OBJECT
-private:
- BufferInfo _bufferInfo;
- QString _bufferName;
- Buffer::ActivityLevel _activity;
+public:
+ StatusBufferItem(const BufferInfo& bufferInfo, NetworkItem* parent);
- QPointer<IrcChannel> _ircChannel;
+ QString toolTip(int column) const override;
+ inline QString bufferName() const override { return tr("Status Buffer"); }
};
+/*****************************************
+ * QueryBufferItem
+ *****************************************/
+class QueryBufferItem : public BufferItem
+{
+ Q_OBJECT
+
+public:
+ QueryBufferItem(const BufferInfo& bufferInfo, NetworkItem* parent);
+
+ QVariant data(int column, int role) const override;
+ bool setData(int column, const QVariant& value, int role) override;
+
+ inline bool isActive() const override { return (bool)_ircUser; }
+ QString toolTip(int column) const override;
+
+ void setBufferName(const QString& name) override;
+
+public slots:
+ void setIrcUser(IrcUser* ircUser);
+ void removeIrcUser();
+
+private:
+ IrcUser* _ircUser;
+};
/*****************************************
- * Network Items
+ * ChannelBufferItem
*****************************************/
-class NetworkItem : public PropertyMapItem {
- Q_OBJECT
- Q_PROPERTY(QString networkName READ networkName)
- Q_PROPERTY(QString currentServer READ currentServer)
- Q_PROPERTY(int nickCount READ nickCount)
-
+class UserCategoryItem;
+
+class ChannelBufferItem : public BufferItem
+{
+ Q_OBJECT
+
public:
- NetworkItem(const NetworkId &netid, AbstractTreeItem *parent = 0);
+ ChannelBufferItem(const BufferInfo& bufferInfo, AbstractTreeItem* parent);
- virtual quint64 id() const;
- virtual QVariant data(int column, int row) const;
+ QVariant data(int column, int role) const override;
+ inline bool isActive() const override { return (bool)_ircChannel; }
+ QString toolTip(int column) const override;
- bool isActive() const;
+ inline QString topic() const override { return (bool)_ircChannel ? _ircChannel->topic() : QString(); }
+ inline int nickCount() const override { return (bool)_ircChannel ? _ircChannel->ircUsers().count() : 0; }
- inline const NetworkId &networkId() const { return _networkId; }
- QString networkName() const;
- QString currentServer() const;
- int nickCount() const;
+ void attachIrcChannel(IrcChannel* ircChannel);
- virtual QString toolTip(int column) const;
+ /**
+ * Gets the list of channel modes for a given nick.
+ *
+ * @param[in] nick IrcUser nickname to check
+ * @returns Channel modes as a string if any, otherwise empty string
+ */
+ QString nickChannelModes(const QString& nick) const;
public slots:
- void setNetworkName(const QString &networkName);
- void setCurrentServer(const QString &serverName);
+ void join(const QList<IrcUser*>& ircUsers);
+ void part(IrcUser* ircUser);
- void attachNetwork(Network *network);
- void attachIrcChannel(const QString &channelName);
+ UserCategoryItem* findCategoryItem(int categoryId);
+ void addUserToCategory(IrcUser* ircUser);
+ void addUsersToCategory(const QList<IrcUser*>& ircUser);
+ void removeUserFromCategory(IrcUser* ircUser);
+ void userModeChanged(IrcUser* ircUser);
-private:
- NetworkId _networkId;
+private slots:
+ void ircChannelParted();
+ void ircChannelDestroyed();
- QPointer<Network> _network;
+private:
+ IrcChannel* _ircChannel;
};
/*****************************************
-* User Category Items (like @vh etc.)
-*****************************************/
-class UserCategoryItem : public PropertyMapItem {
- Q_OBJECT
- Q_PROPERTY(QString categoryName READ categoryName)
-
+ * User Category Items (like @vh etc.)
+ *****************************************/
+class IrcUserItem;
+
+class CLIENT_EXPORT UserCategoryItem : public PropertyMapItem
+{
+ Q_OBJECT
+ Q_PROPERTY(QString categoryName READ categoryName)
+
public:
- UserCategoryItem(int category, AbstractTreeItem *parent);
+ UserCategoryItem(int category, AbstractTreeItem* parent);
+
+ QStringList propertyOrder() const override;
- QString categoryName() const;
- virtual quint64 id() const;
- virtual QVariant data(int column, int role) const;
-
- void addUsers(const QList<IrcUser *> &ircUser);
- bool removeUser(IrcUser *ircUser);
+ QString categoryName() const;
+ inline int categoryId() const { return _category; }
+ QVariant data(int column, int role) const override;
- static int categoryFromModes(const QString &modes);
+ IrcUserItem* findIrcUser(IrcUser* ircUser);
+ void addUsers(const QList<IrcUser*>& ircUser);
+ bool removeUser(IrcUser* ircUser);
+
+ static int categoryFromModes(const QString& modes);
private:
- int _category;
+ int _category;
- static const QList<QChar> categories;
+ static const QList<QChar> categories;
};
/*****************************************
-* Irc User Items
-*****************************************/
-class IrcUserItem : public PropertyMapItem {
- Q_OBJECT
- Q_PROPERTY(QString nickName READ nickName)
-
+ * Irc User Items
+ *****************************************/
+class IrcUserItem : public PropertyMapItem
+{
+ Q_OBJECT
+ Q_PROPERTY(QString nickName READ nickName)
+
public:
- IrcUserItem(IrcUser *ircUser, AbstractTreeItem *parent);
+ IrcUserItem(IrcUser* ircUser, AbstractTreeItem* parent);
+
+ QStringList propertyOrder() const override;
- QString nickName() const;
- bool isActive() const;
+ inline QString nickName() const { return _ircUser ? _ircUser->nick() : QString(); }
+ inline bool isActive() const { return _ircUser ? !_ircUser->isAway() : false; }
- IrcUser *ircUser();
- virtual quint64 id() const;
- virtual QVariant data(int column, int role) const;
- virtual QString toolTip(int column) const;
+ inline IrcUser* ircUser() { return _ircUser; }
+ QVariant data(int column, int role) const override;
+ QString toolTip(int column) const override;
+
+ /**
+ * Gets the list of channel modes for this nick if parented to channel.
+ *
+ * @returns Channel modes as a string if any, otherwise empty string
+ */
+ QString channelModes() const;
private slots:
- void setNick(QString newNick);
- void setAway(bool);
+ inline void ircUserQuited() { parent()->removeChild(this); }
private:
- QPointer<IrcUser> _ircUser;
- quint64 _id;
+ QPointer<IrcUser> _ircUser;
};
-
/*****************************************
* NetworkModel
*****************************************/
-class NetworkModel : public TreeModel {
- Q_OBJECT
+class CLIENT_EXPORT NetworkModel : public TreeModel
+{
+ Q_OBJECT
public:
- enum myRoles {
- BufferTypeRole = TreeModel::UserRole,
- ItemActiveRole,
- BufferActivityRole,
- BufferIdRole,
- NetworkIdRole,
- BufferInfoRole,
- ItemTypeRole
- };
+ enum Role
+ {
+ BufferTypeRole = TreeModel::UserRole,
+ ItemActiveRole,
+ BufferActivityRole,
+ BufferIdRole,
+ NetworkIdRole,
+ BufferInfoRole,
+ ItemTypeRole,
+ UserAwayRole,
+ IrcUserRole,
+ IrcChannelRole,
+ BufferFirstUnreadMsgIdRole,
+ MarkerLineMsgIdRole,
+ };
+
+ enum ItemType
+ {
+ NetworkItemType = 0x01,
+ BufferItemType = 0x02,
+ UserCategoryItemType = 0x04,
+ IrcUserItemType = 0x08
+ };
+ Q_DECLARE_FLAGS(ItemTypes, ItemType)
+
+ NetworkModel(QObject* parent = nullptr);
+ static QList<QVariant> defaultHeader();
+
+ static bool mimeContainsBufferList(const QMimeData* mimeData);
+ static QList<QPair<NetworkId, BufferId>> mimeDataToBufferList(const QMimeData* mimeData);
+
+ QStringList mimeTypes() const override;
+ QMimeData* mimeData(const QModelIndexList&) const override;
+
+ void attachNetwork(Network* network);
+
+ bool isBufferIndex(const QModelIndex&) const;
+ // Buffer *getBufferByIndex(const QModelIndex &) const;
+ QModelIndex networkIndex(NetworkId networkId);
+ QModelIndex bufferIndex(BufferId bufferId);
+
+ const Network* networkByIndex(const QModelIndex& index) const;
+
+ BufferInfo::ActivityLevel bufferActivity(const BufferInfo& buffer) const;
+
+ //! Finds a buffer with a given name in a given network
+ /** This performs a linear search through all BufferItems, hence it is expensive.
+ * @param networkId The network which we search in
+ * @param bufferName The bufferName we look for
+ * @return The id of the buffer if found, an invalid one else
+ */
+ BufferId bufferId(NetworkId networkId, const QString& bufferName, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
+
+ QString bufferName(BufferId bufferId) const;
+ BufferInfo::Type bufferType(BufferId bufferId) const;
+ BufferInfo bufferInfo(BufferId bufferId) const;
+ MsgId lastSeenMsgId(BufferId bufferId) const;
+ MsgId markerLineMsgId(BufferId bufferId) const;
+ NetworkId networkId(BufferId bufferId) const;
+ QString networkName(BufferId bufferId) const;
+
+ inline QList<BufferId> allBufferIds() const { return _bufferItemCache.keys(); }
+ QList<BufferId> allBufferIdsSorted() const;
+ void sortBufferIds(QList<BufferId>& bufferIds) const;
- enum itemTypes {
- NetworkItemType,
- BufferItemType,
- UserCategoryItemType,
- IrcUserItemType
- };
-
- NetworkModel(QObject *parent = 0);
- static QList<QVariant> defaultHeader();
-
- static bool mimeContainsBufferList(const QMimeData *mimeData);
- static QList< QPair<NetworkId, BufferId> > mimeDataToBufferList(const QMimeData *mimeData);
-
- virtual QStringList mimeTypes() const;
- virtual QMimeData *mimeData(const QModelIndexList &) const;
- virtual bool dropMimeData(const QMimeData *, Qt::DropAction, int, int, const QModelIndex &);
+public slots:
+ void bufferUpdated(BufferInfo bufferInfo);
+ void removeBuffer(BufferId bufferId);
+ MsgId lastSeenMsgId(const BufferId& bufferId);
+ void setLastSeenMsgId(const BufferId& bufferId, const MsgId& msgId);
+ void setMarkerLineMsgId(const BufferId& bufferId, const MsgId& msgId);
+ void setBufferActivity(const BufferId& bufferId, BufferInfo::ActivityLevel activity);
+ void clearBufferActivity(const BufferId& bufferId);
+ void updateBufferActivity(Message& msg);
+ void networkRemoved(const NetworkId& networkId);
+ void bufferActivityChanged(BufferId, Message::Types);
+ void highlightCountChanged(BufferId, int);
+
+signals:
+ void requestSetLastSeenMsg(BufferId buffer, MsgId msg);
+ void lastSeenMsgSet(BufferId buffer, MsgId msg);
+ void markerLineSet(BufferId buffer, MsgId msg);
- void attachNetwork(Network *network);
+private slots:
+ void checkForRemovedBuffers(const QModelIndex& parent, int start, int end);
+ void checkForNewBuffers(const QModelIndex& parent, int start, int end);
+ void messageRedirectionSettingsChanged();
- bool isBufferIndex(const QModelIndex &) const;
- //Buffer *getBufferByIndex(const QModelIndex &) const;
- QModelIndex bufferIndex(BufferId bufferId);
+private:
+ int networkRow(NetworkId networkId) const;
+ NetworkItem* findNetworkItem(NetworkId networkId) const;
+ NetworkItem* networkItem(NetworkId networkId);
+ inline BufferItem* findBufferItem(const BufferInfo& bufferInfo) const { return findBufferItem(bufferInfo.bufferId()); }
+ BufferItem* findBufferItem(BufferId bufferId) const;
+ BufferItem* bufferItem(const BufferInfo& bufferInfo);
- const Network *networkByIndex(const QModelIndex &index) const;
+ void updateBufferActivity(BufferItem* bufferItem, const Message& msg);
- Buffer::ActivityLevel bufferActivity(const BufferInfo &buffer) const;
+ static bool bufferItemLessThan(const BufferItem* left, const BufferItem* right);
-public slots:
- void bufferUpdated(BufferInfo bufferInfo);
- void removeBuffer(BufferId bufferId);
- void setBufferActivity(const BufferInfo &buffer, Buffer::ActivityLevel activity);
- void networkRemoved(const NetworkId &networkId);
-
-private:
- QModelIndex networkIndex(NetworkId networkId);
- NetworkItem *networkItem(NetworkId networkId);
- NetworkItem *existsNetworkItem(NetworkId networkId);
- BufferItem *bufferItem(const BufferInfo &bufferInfo);
- BufferItem *existsBufferItem(const BufferInfo &bufferInfo);
+ QHash<BufferId, BufferItem*> _bufferItemCache;
+ int _userNoticesTarget;
+ int _serverNoticesTarget;
+ int _errorMsgsTarget;
};
-#endif // NETWORKMODEL_H
+Q_DECLARE_OPERATORS_FOR_FLAGS(NetworkModel::ItemTypes)