1 /***************************************************************************
2 * Copyright (C) 2005-2018 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
21 #ifndef NETWORKMODEL_H
22 #define NETWORKMODEL_H
24 #include "bufferinfo.h"
25 #include "clientsettings.h"
28 #include "treemodel.h"
31 class StatusBufferItem;
33 /*****************************************
35 *****************************************/
36 class NetworkItem : public PropertyMapItem
39 Q_PROPERTY(QString networkName READ networkName)
40 Q_PROPERTY(QString currentServer READ currentServer)
41 Q_PROPERTY(int nickCount READ nickCount)
44 NetworkItem(const NetworkId &netid, AbstractTreeItem *parent = 0);
46 virtual QStringList propertyOrder() const;
48 virtual QVariant data(int column, int row) const;
51 * Escapes a string as HTML, ready for Qt markup.
53 * Implementation depends on Qt version - Qt4 uses Qt::escape, while Qt5 uses .toHtmlEscaped().
55 * @param[in] string QString to escape
56 * @param[in] useNonbreakingSpaces
58 * If true, replace spaces with non-breaking spaces (i.e. ' '), otherwise only HTML escape.
61 static QString escapeHTML(const QString &string, bool useNonbreakingSpaces = false);
63 inline bool isActive() const { return (bool)_network ? _network->isConnected() : false; }
65 inline const NetworkId &networkId() const { return _networkId; }
66 inline QString networkName() const { return (bool)_network ? _network->networkName() : QString(); }
67 inline QString currentServer() const { return (bool)_network ? _network->currentServer() : QString(); }
68 inline int nickCount() const { return (bool)_network ? _network->ircUsers().count() : 0; }
70 virtual QString toolTip(int column) const;
72 BufferItem *findBufferItem(BufferId bufferId);
73 inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) { return findBufferItem(bufferInfo.bufferId()); }
74 BufferItem *bufferItem(const BufferInfo &bufferInfo);
75 inline StatusBufferItem *statusBufferItem() const { return _statusBufferItem; }
78 void setNetworkName(const QString &networkName);
79 void setCurrentServer(const QString &serverName);
81 void attachNetwork(Network *network);
82 void attachIrcChannel(IrcChannel *channel);
83 void attachIrcUser(IrcUser *ircUser);
86 void networkDataChanged(int column = -1);
89 void onBeginRemoveChilds(int start, int end);
90 void onNetworkDestroyed();
94 StatusBufferItem *_statusBufferItem;
96 QPointer<Network> _network;
100 /*****************************************
102 *****************************************/
103 class BufferItem : public PropertyMapItem
106 Q_PROPERTY(QString bufferName READ bufferName WRITE setBufferName)
107 Q_PROPERTY(QString topic READ topic)
108 Q_PROPERTY(int nickCount READ nickCount)
111 BufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent = 0);
113 virtual QStringList propertyOrder() const;
115 inline const BufferInfo &bufferInfo() const { return _bufferInfo; }
116 virtual QVariant data(int column, int role) const;
117 virtual bool setData(int column, const QVariant &value, int role);
119 inline BufferId bufferId() const { return _bufferInfo.bufferId(); }
120 inline BufferInfo::Type bufferType() const { return _bufferInfo.type(); }
122 virtual void setBufferName(const QString &name);
123 virtual inline QString bufferName() const { return _bufferInfo.bufferName(); }
124 virtual inline QString topic() const { return QString(); }
125 virtual inline int nickCount() const { return 0; }
127 virtual inline bool isActive() const { return qobject_cast<NetworkItem *>(parent())->isActive(); }
129 inline MsgId lastSeenMsgId() const { return _lastSeenMsgId; }
130 inline MsgId markerLineMsgId() const { return _markerLineMsgId; }
131 void setLastSeenMsgId(MsgId msgId);
132 void setMarkerLineMsgId(MsgId msgId);
134 inline BufferInfo::ActivityLevel activityLevel() const { return _activity; }
135 void setActivityLevel(BufferInfo::ActivityLevel level);
136 void clearActivityLevel();
137 void updateActivityLevel(const Message &msg);
138 void setActivity(Message::Types msg, bool highlight);
139 bool addActivity(Message::Types msg, bool highlight);
141 inline const MsgId &firstUnreadMsgId() const { return _firstUnreadMsgId; }
143 bool isCurrentBuffer() const;
144 virtual QString toolTip(int column) const;
147 virtual inline void setTopic(const QString &) { emit dataChanged(1); }
148 virtual inline void setEncrypted(bool) { emit dataChanged(); }
151 BufferInfo _bufferInfo;
152 BufferInfo::ActivityLevel _activity;
153 MsgId _lastSeenMsgId;
154 MsgId _markerLineMsgId;
155 MsgId _firstUnreadMsgId;
159 /*****************************************
161 *****************************************/
162 class StatusBufferItem : public BufferItem
167 StatusBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
169 virtual QString toolTip(int column) const;
170 virtual inline QString bufferName() const { return tr("Status Buffer"); }
174 /*****************************************
176 *****************************************/
177 class QueryBufferItem : public BufferItem
182 QueryBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
184 virtual QVariant data(int column, int role) const;
185 virtual bool setData(int column, const QVariant &value, int role);
187 virtual inline bool isActive() const { return (bool)_ircUser; }
188 virtual QString toolTip(int column) const;
190 virtual void setBufferName(const QString &name);
193 void setIrcUser(IrcUser *ircUser);
194 void removeIrcUser();
201 /*****************************************
203 *****************************************/
204 class UserCategoryItem;
206 class ChannelBufferItem : public BufferItem
211 ChannelBufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent);
213 virtual QVariant data(int column, int role) const;
214 virtual inline bool isActive() const { return (bool)_ircChannel; }
215 virtual QString toolTip(int column) const;
217 virtual inline QString topic() const { return (bool)_ircChannel ? _ircChannel->topic() : QString(); }
218 virtual inline int nickCount() const { return (bool)_ircChannel ? _ircChannel->ircUsers().count() : 0; }
220 void attachIrcChannel(IrcChannel *ircChannel);
223 * Gets the list of channel modes for a given nick.
225 * @param[in] nick IrcUser nickname to check
226 * @returns Channel modes as a string if any, otherwise empty string
228 QString nickChannelModes(const QString &nick) const;
231 void join(const QList<IrcUser *> &ircUsers);
232 void part(IrcUser *ircUser);
234 UserCategoryItem *findCategoryItem(int categoryId);
235 void addUserToCategory(IrcUser *ircUser);
236 void addUsersToCategory(const QList<IrcUser *> &ircUser);
237 void removeUserFromCategory(IrcUser *ircUser);
238 void userModeChanged(IrcUser *ircUser);
241 void ircChannelParted();
242 void ircChannelDestroyed();
245 IrcChannel *_ircChannel;
249 /*****************************************
250 * User Category Items (like @vh etc.)
251 *****************************************/
253 class UserCategoryItem : public PropertyMapItem
256 Q_PROPERTY(QString categoryName READ categoryName)
259 UserCategoryItem(int category, AbstractTreeItem *parent);
261 virtual QStringList propertyOrder() const;
263 QString categoryName() const;
264 inline int categoryId() const { return _category; }
265 virtual QVariant data(int column, int role) const;
267 IrcUserItem *findIrcUser(IrcUser *ircUser);
268 void addUsers(const QList<IrcUser *> &ircUser);
269 bool removeUser(IrcUser *ircUser);
271 static int categoryFromModes(const QString &modes);
276 static const QList<QChar> categories;
280 /*****************************************
282 *****************************************/
283 class IrcUserItem : public PropertyMapItem
286 Q_PROPERTY(QString nickName READ nickName)
289 IrcUserItem(IrcUser *ircUser, AbstractTreeItem *parent);
291 virtual QStringList propertyOrder() const;
293 inline QString nickName() const { return _ircUser ? _ircUser->nick() : QString(); }
294 inline bool isActive() const { return _ircUser ? !_ircUser->isAway() : false; }
296 inline IrcUser *ircUser() { return _ircUser; }
297 virtual QVariant data(int column, int role) const;
298 virtual QString toolTip(int column) const;
301 * Gets the list of channel modes for this nick if parented to channel.
303 * @returns Channel modes as a string if any, otherwise empty string
305 QString channelModes() const;
308 inline void ircUserQuited() { parent()->removeChild(this); }
311 QPointer<IrcUser> _ircUser;
315 /*****************************************
317 *****************************************/
318 class NetworkModel : public TreeModel
324 BufferTypeRole = TreeModel::UserRole,
334 BufferFirstUnreadMsgIdRole,
339 NetworkItemType = 0x01,
340 BufferItemType = 0x02,
341 UserCategoryItemType = 0x04,
342 IrcUserItemType = 0x08
344 Q_DECLARE_FLAGS(ItemTypes, ItemType)
346 NetworkModel(QObject *parent = 0);
347 static QList<QVariant> defaultHeader();
349 static bool mimeContainsBufferList(const QMimeData *mimeData);
350 static QList<QPair<NetworkId, BufferId> > mimeDataToBufferList(const QMimeData *mimeData);
352 virtual QStringList mimeTypes() const;
353 virtual QMimeData *mimeData(const QModelIndexList &) const;
355 void attachNetwork(Network *network);
357 bool isBufferIndex(const QModelIndex &) const;
358 //Buffer *getBufferByIndex(const QModelIndex &) const;
359 QModelIndex networkIndex(NetworkId networkId);
360 QModelIndex bufferIndex(BufferId bufferId);
362 const Network *networkByIndex(const QModelIndex &index) const;
364 BufferInfo::ActivityLevel bufferActivity(const BufferInfo &buffer) const;
366 //! Finds a buffer with a given name in a given network
367 /** This performs a linear search through all BufferItems, hence it is expensive.
368 * @param networkId The network which we search in
369 * @param bufferName The bufferName we look for
370 * @return The id of the buffer if found, an invalid one else
372 BufferId bufferId(NetworkId networkId, const QString &bufferName, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
374 QString bufferName(BufferId bufferId) const;
375 BufferInfo::Type bufferType(BufferId bufferId) const;
376 BufferInfo bufferInfo(BufferId bufferId) const;
377 MsgId lastSeenMsgId(BufferId bufferId) const;
378 MsgId markerLineMsgId(BufferId bufferId) const;
379 NetworkId networkId(BufferId bufferId) const;
380 QString networkName(BufferId bufferId) const;
382 inline QList<BufferId> allBufferIds() const { return _bufferItemCache.keys(); }
383 QList<BufferId> allBufferIdsSorted() const;
384 void sortBufferIds(QList<BufferId> &bufferIds) const;
387 void bufferUpdated(BufferInfo bufferInfo);
388 void removeBuffer(BufferId bufferId);
389 MsgId lastSeenMsgId(const BufferId &bufferId);
390 void setLastSeenMsgId(const BufferId &bufferId, const MsgId &msgId);
391 void setMarkerLineMsgId(const BufferId &bufferId, const MsgId &msgId);
392 void setBufferActivity(const BufferId &bufferId, BufferInfo::ActivityLevel activity);
393 void clearBufferActivity(const BufferId &bufferId);
394 void updateBufferActivity(Message &msg);
395 void networkRemoved(const NetworkId &networkId);
396 void bufferActivityChanged(BufferId, Message::Types);
397 void highlightCountChanged(BufferId, int);
400 void requestSetLastSeenMsg(BufferId buffer, MsgId msg);
401 void lastSeenMsgSet(BufferId buffer, MsgId msg);
402 void markerLineSet(BufferId buffer, MsgId msg);
405 void checkForRemovedBuffers(const QModelIndex &parent, int start, int end);
406 void checkForNewBuffers(const QModelIndex &parent, int start, int end);
407 void messageRedirectionSettingsChanged();
410 int networkRow(NetworkId networkId) const;
411 NetworkItem *findNetworkItem(NetworkId networkId) const;
412 NetworkItem *networkItem(NetworkId networkId);
413 inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) const { return findBufferItem(bufferInfo.bufferId()); }
414 BufferItem *findBufferItem(BufferId bufferId) const;
415 BufferItem *bufferItem(const BufferInfo &bufferInfo);
417 void updateBufferActivity(BufferItem *bufferItem, const Message &msg);
419 static bool bufferItemLessThan(const BufferItem *left, const BufferItem *right);
421 QHash<BufferId, BufferItem *> _bufferItemCache;
423 int _userNoticesTarget;
424 int _serverNoticesTarget;
425 int _errorMsgsTarget;
429 Q_DECLARE_OPERATORS_FOR_FLAGS(NetworkModel::ItemTypes)
431 #endif // NETWORKMODEL_H