1 /***************************************************************************
2 * Copyright (C) 2005-2016 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 QVariant data(int column, int row) const;
49 * Escapes a string as HTML, ready for Qt markup.
51 * Implementation depends on Qt version - Qt4 uses Qt::escape, while Qt5 uses .toHtmlEscaped().
53 * @param[in] string QString to escape
54 * @param[in] useNonbreakingSpaces
56 * If true, replace spaces with non-breaking spaces (i.e. ' '), otherwise only HTML escape.
59 static QString escapeHTML(const QString &string, bool useNonbreakingSpaces = false);
61 inline bool isActive() const { return (bool)_network ? _network->isConnected() : false; }
63 inline const NetworkId &networkId() const { return _networkId; }
64 inline QString networkName() const { return (bool)_network ? _network->networkName() : QString(); }
65 inline QString currentServer() const { return (bool)_network ? _network->currentServer() : QString(); }
66 inline int nickCount() const { return (bool)_network ? _network->ircUsers().count() : 0; }
68 virtual QString toolTip(int column) const;
70 BufferItem *findBufferItem(BufferId bufferId);
71 inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) { return findBufferItem(bufferInfo.bufferId()); }
72 BufferItem *bufferItem(const BufferInfo &bufferInfo);
73 inline StatusBufferItem *statusBufferItem() const { return _statusBufferItem; }
76 void setNetworkName(const QString &networkName);
77 void setCurrentServer(const QString &serverName);
79 void attachNetwork(Network *network);
80 void attachIrcChannel(IrcChannel *channel);
81 void attachIrcUser(IrcUser *ircUser);
84 void networkDataChanged(int column = -1);
87 void onBeginRemoveChilds(int start, int end);
88 void onNetworkDestroyed();
92 StatusBufferItem *_statusBufferItem;
94 QPointer<Network> _network;
98 /*****************************************
100 *****************************************/
101 class BufferItem : public PropertyMapItem
104 Q_PROPERTY(QString bufferName READ bufferName WRITE setBufferName)
105 Q_PROPERTY(QString topic READ topic)
106 Q_PROPERTY(int nickCount READ nickCount)
109 BufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent = 0);
111 inline const BufferInfo &bufferInfo() const { return _bufferInfo; }
112 virtual QVariant data(int column, int role) const;
113 virtual bool setData(int column, const QVariant &value, int role);
115 inline BufferId bufferId() const { return _bufferInfo.bufferId(); }
116 inline BufferInfo::Type bufferType() const { return _bufferInfo.type(); }
118 virtual void setBufferName(const QString &name);
119 virtual inline QString bufferName() const { return _bufferInfo.bufferName(); }
120 virtual inline QString topic() const { return QString(); }
121 virtual inline int nickCount() const { return 0; }
123 virtual inline bool isActive() const { return qobject_cast<NetworkItem *>(parent())->isActive(); }
125 inline MsgId lastSeenMsgId() const { return _lastSeenMsgId; }
126 inline MsgId markerLineMsgId() const { return _markerLineMsgId; }
127 void setLastSeenMsgId(MsgId msgId);
128 void setMarkerLineMsgId(MsgId msgId);
130 inline BufferInfo::ActivityLevel activityLevel() const { return _activity; }
131 void setActivityLevel(BufferInfo::ActivityLevel level);
132 void clearActivityLevel();
133 void updateActivityLevel(const Message &msg);
135 inline const MsgId &firstUnreadMsgId() const { return _firstUnreadMsgId; }
137 bool isCurrentBuffer() const;
138 virtual QString toolTip(int column) const;
141 virtual inline void setTopic(const QString &) { emit dataChanged(1); }
142 virtual inline void setEncrypted(bool) { emit dataChanged(); }
145 BufferInfo _bufferInfo;
146 BufferInfo::ActivityLevel _activity;
147 MsgId _lastSeenMsgId;
148 MsgId _markerLineMsgId;
149 MsgId _firstUnreadMsgId;
153 /*****************************************
155 *****************************************/
156 class StatusBufferItem : public BufferItem
161 StatusBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
163 virtual QString toolTip(int column) const;
164 virtual inline QString bufferName() const { return tr("Status Buffer"); }
168 /*****************************************
170 *****************************************/
171 class QueryBufferItem : public BufferItem
176 QueryBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
178 virtual QVariant data(int column, int role) const;
179 virtual bool setData(int column, const QVariant &value, int role);
181 virtual inline bool isActive() const { return (bool)_ircUser; }
182 virtual QString toolTip(int column) const;
184 virtual void setBufferName(const QString &name);
187 void setIrcUser(IrcUser *ircUser);
188 void removeIrcUser();
195 /*****************************************
197 *****************************************/
198 class UserCategoryItem;
200 class ChannelBufferItem : public BufferItem
205 ChannelBufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent);
207 virtual QVariant data(int column, int role) const;
208 virtual inline bool isActive() const { return (bool)_ircChannel; }
209 virtual QString toolTip(int column) const;
211 virtual inline QString topic() const { return (bool)_ircChannel ? _ircChannel->topic() : QString(); }
212 virtual inline int nickCount() const { return (bool)_ircChannel ? _ircChannel->ircUsers().count() : 0; }
214 void attachIrcChannel(IrcChannel *ircChannel);
217 * Gets the list of channel modes for a given nick.
219 * @param[in] nick IrcUser nickname to check
220 * @returns Channel modes as a string if any, otherwise empty string
222 QString nickChannelModes(const QString &nick) const;
225 void join(const QList<IrcUser *> &ircUsers);
226 void part(IrcUser *ircUser);
228 UserCategoryItem *findCategoryItem(int categoryId);
229 void addUserToCategory(IrcUser *ircUser);
230 void addUsersToCategory(const QList<IrcUser *> &ircUser);
231 void removeUserFromCategory(IrcUser *ircUser);
232 void userModeChanged(IrcUser *ircUser);
235 void ircChannelParted();
236 void ircChannelDestroyed();
239 IrcChannel *_ircChannel;
243 /*****************************************
244 * User Category Items (like @vh etc.)
245 *****************************************/
247 class UserCategoryItem : public PropertyMapItem
250 Q_PROPERTY(QString categoryName READ categoryName)
253 UserCategoryItem(int category, AbstractTreeItem *parent);
255 QString categoryName() const;
256 inline int categoryId() const { return _category; }
257 virtual QVariant data(int column, int role) const;
259 IrcUserItem *findIrcUser(IrcUser *ircUser);
260 void addUsers(const QList<IrcUser *> &ircUser);
261 bool removeUser(IrcUser *ircUser);
263 static int categoryFromModes(const QString &modes);
268 static const QList<QChar> categories;
272 /*****************************************
274 *****************************************/
275 class IrcUserItem : public PropertyMapItem
278 Q_PROPERTY(QString nickName READ nickName)
281 IrcUserItem(IrcUser *ircUser, AbstractTreeItem *parent);
283 inline QString nickName() const { return _ircUser ? _ircUser->nick() : QString(); }
284 inline bool isActive() const { return _ircUser ? !_ircUser->isAway() : false; }
286 inline IrcUser *ircUser() { return _ircUser; }
287 virtual QVariant data(int column, int role) const;
288 virtual QString toolTip(int column) const;
291 * Gets the list of channel modes for this nick if parented to channel.
293 * @returns Channel modes as a string if any, otherwise empty string
295 QString channelModes() const;
298 inline void ircUserQuited() { parent()->removeChild(this); }
301 QPointer<IrcUser> _ircUser;
305 /*****************************************
307 *****************************************/
308 class NetworkModel : public TreeModel
314 BufferTypeRole = TreeModel::UserRole,
324 BufferFirstUnreadMsgIdRole,
329 NetworkItemType = 0x01,
330 BufferItemType = 0x02,
331 UserCategoryItemType = 0x04,
332 IrcUserItemType = 0x08
334 Q_DECLARE_FLAGS(ItemTypes, ItemType)
336 NetworkModel(QObject *parent = 0);
337 static QList<QVariant> defaultHeader();
339 static bool mimeContainsBufferList(const QMimeData *mimeData);
340 static QList<QPair<NetworkId, BufferId> > mimeDataToBufferList(const QMimeData *mimeData);
342 virtual QStringList mimeTypes() const;
343 virtual QMimeData *mimeData(const QModelIndexList &) const;
345 void attachNetwork(Network *network);
347 bool isBufferIndex(const QModelIndex &) const;
348 //Buffer *getBufferByIndex(const QModelIndex &) const;
349 QModelIndex networkIndex(NetworkId networkId);
350 QModelIndex bufferIndex(BufferId bufferId);
352 const Network *networkByIndex(const QModelIndex &index) const;
354 BufferInfo::ActivityLevel bufferActivity(const BufferInfo &buffer) const;
356 //! Finds a buffer with a given name in a given network
357 /** This performs a linear search through all BufferItems, hence it is expensive.
358 * @param networkId The network which we search in
359 * @param bufferName The bufferName we look for
360 * @return The id of the buffer if found, an invalid one else
362 BufferId bufferId(NetworkId networkId, const QString &bufferName, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
364 QString bufferName(BufferId bufferId) const;
365 BufferInfo::Type bufferType(BufferId bufferId) const;
366 BufferInfo bufferInfo(BufferId bufferId) const;
367 MsgId lastSeenMsgId(BufferId bufferId) const;
368 MsgId markerLineMsgId(BufferId bufferId) const;
369 NetworkId networkId(BufferId bufferId) const;
370 QString networkName(BufferId bufferId) const;
372 inline QList<BufferId> allBufferIds() const { return _bufferItemCache.keys(); }
373 QList<BufferId> allBufferIdsSorted() const;
374 void sortBufferIds(QList<BufferId> &bufferIds) const;
377 void bufferUpdated(BufferInfo bufferInfo);
378 void removeBuffer(BufferId bufferId);
379 MsgId lastSeenMsgId(const BufferId &bufferId);
380 void setLastSeenMsgId(const BufferId &bufferId, const MsgId &msgId);
381 void setMarkerLineMsgId(const BufferId &bufferId, const MsgId &msgId);
382 void setBufferActivity(const BufferId &bufferId, BufferInfo::ActivityLevel activity);
383 void clearBufferActivity(const BufferId &bufferId);
384 void updateBufferActivity(Message &msg);
385 void networkRemoved(const NetworkId &networkId);
388 void requestSetLastSeenMsg(BufferId buffer, MsgId msg);
389 void lastSeenMsgSet(BufferId buffer, MsgId msg);
390 void markerLineSet(BufferId buffer, MsgId msg);
393 void checkForRemovedBuffers(const QModelIndex &parent, int start, int end);
394 void checkForNewBuffers(const QModelIndex &parent, int start, int end);
395 void messageRedirectionSettingsChanged();
398 int networkRow(NetworkId networkId) const;
399 NetworkItem *findNetworkItem(NetworkId networkId) const;
400 NetworkItem *networkItem(NetworkId networkId);
401 inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) const { return findBufferItem(bufferInfo.bufferId()); }
402 BufferItem *findBufferItem(BufferId bufferId) const;
403 BufferItem *bufferItem(const BufferInfo &bufferInfo);
405 void updateBufferActivity(BufferItem *bufferItem, const Message &msg);
407 static bool bufferItemLessThan(const BufferItem *left, const BufferItem *right);
409 QHash<BufferId, BufferItem *> _bufferItemCache;
411 int _userNoticesTarget;
412 int _serverNoticesTarget;
413 int _errorMsgsTarget;
417 Q_DECLARE_OPERATORS_FOR_FLAGS(NetworkModel::ItemTypes)
419 #endif // NETWORKMODEL_H