1 /***************************************************************************
2 * Copyright (C) 2005-09 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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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 {
38 Q_PROPERTY(QString networkName READ networkName)
39 Q_PROPERTY(QString currentServer READ currentServer)
40 Q_PROPERTY(int nickCount READ nickCount)
43 NetworkItem(const NetworkId &netid, AbstractTreeItem *parent = 0);
45 virtual QVariant data(int column, int row) const;
47 inline bool isActive() const { return (bool)_network ? _network->isConnected() : false; }
49 inline const NetworkId &networkId() const { return _networkId; }
50 inline QString networkName() const { return (bool)_network ? _network->networkName() : QString(); }
51 inline QString currentServer() const { return (bool)_network ? _network->currentServer() : QString(); }
52 inline int nickCount() const { return (bool)_network ? _network->ircUsers().count() : 0; }
54 virtual QString toolTip(int column) const;
56 BufferItem *findBufferItem(BufferId bufferId);
57 inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) { return findBufferItem(bufferInfo.bufferId()); }
58 BufferItem *bufferItem(const BufferInfo &bufferInfo);
59 inline StatusBufferItem *statusBufferItem() const { return _statusBufferItem; }
62 void setNetworkName(const QString &networkName);
63 void setCurrentServer(const QString &serverName);
65 void attachNetwork(Network *network);
66 void attachIrcChannel(IrcChannel *channel);
67 void attachIrcUser(IrcUser *ircUser);
70 void networkDataChanged(int column = -1);
73 void onBeginRemoveChilds(int start, int end);
77 StatusBufferItem *_statusBufferItem;
79 QPointer<Network> _network;
82 /*****************************************
84 *****************************************/
85 class BufferItem : public PropertyMapItem {
87 Q_PROPERTY(QString bufferName READ bufferName WRITE setBufferName)
88 Q_PROPERTY(QString topic READ topic)
89 Q_PROPERTY(int nickCount READ nickCount)
92 BufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent = 0);
94 inline const BufferInfo &bufferInfo() const { return _bufferInfo; }
95 virtual QVariant data(int column, int role) const;
96 virtual bool setData(int column, const QVariant &value, int role);
98 inline BufferId bufferId() const { return _bufferInfo.bufferId(); }
99 inline BufferInfo::Type bufferType() const { return _bufferInfo.type(); }
101 virtual void setBufferName(const QString &name);
102 virtual inline QString bufferName() const { return _bufferInfo.bufferName(); }
103 virtual inline QString topic() const { return QString(); }
104 virtual inline int nickCount() const { return 0; }
106 virtual inline bool isActive() const { return qobject_cast<NetworkItem *>(parent())->isActive(); }
108 inline MsgId lastSeenMsgId() const { return _lastSeenMsgId; }
109 inline MsgId markerLineMsgId() const { return _markerLineMsgId; }
110 void setLastSeenMsgId(MsgId msgId);
111 void setMarkerLineMsgId(MsgId msgId);
113 inline BufferInfo::ActivityLevel activityLevel() const { return _activity; }
114 void setActivityLevel(BufferInfo::ActivityLevel level);
115 void clearActivityLevel();
116 void updateActivityLevel(const Message &msg);
118 inline const MsgId &firstUnreadMsgId() const { return _firstUnreadMsgId; }
120 bool isCurrentBuffer() const;
121 virtual QString toolTip(int column) const;
124 virtual inline void setTopic(const QString &) { emit dataChanged(1); }
127 BufferInfo _bufferInfo;
128 BufferInfo::ActivityLevel _activity;
129 MsgId _lastSeenMsgId;
130 MsgId _markerLineMsgId;
131 MsgId _firstUnreadMsgId;
134 /*****************************************
136 *****************************************/
137 class StatusBufferItem : public BufferItem {
141 StatusBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
143 virtual QString toolTip(int column) const;
144 virtual inline QString bufferName() const { return tr("Status Buffer"); }
147 /*****************************************
149 *****************************************/
150 class QueryBufferItem : public BufferItem {
154 QueryBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
156 virtual QVariant data(int column, int role) const;
157 virtual bool setData(int column, const QVariant &value, int role);
159 virtual inline bool isActive() const { return (bool)_ircUser; }
160 virtual QString toolTip(int column) const;
162 virtual void setBufferName(const QString &name);
165 void setIrcUser(IrcUser *ircUser);
166 void removeIrcUser();
172 /*****************************************
174 *****************************************/
175 class UserCategoryItem;
177 class ChannelBufferItem : public BufferItem {
181 ChannelBufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent);
183 virtual QVariant data(int column, int role) const;
184 virtual inline bool isActive() const { return (bool)_ircChannel; }
185 virtual QString toolTip(int column) const;
187 virtual inline QString topic() const { return (bool)_ircChannel ? _ircChannel->topic() : QString(); }
188 virtual inline int nickCount() const { return (bool)_ircChannel ? _ircChannel->ircUsers().count() : 0; }
190 void attachIrcChannel(IrcChannel *ircChannel);
193 void join(const QList<IrcUser *> &ircUsers);
194 void part(IrcUser *ircUser);
196 UserCategoryItem *findCategoryItem(int categoryId);
197 void addUserToCategory(IrcUser *ircUser);
198 void addUsersToCategory(const QList<IrcUser *> &ircUser);
199 void removeUserFromCategory(IrcUser *ircUser);
200 void userModeChanged(IrcUser *ircUser);
203 void ircChannelParted();
206 IrcChannel *_ircChannel;
209 /*****************************************
210 * User Category Items (like @vh etc.)
211 *****************************************/
213 class UserCategoryItem : public PropertyMapItem {
215 Q_PROPERTY(QString categoryName READ categoryName)
218 UserCategoryItem(int category, AbstractTreeItem *parent);
220 QString categoryName() const;
221 inline int categoryId() const { return _category; }
222 virtual QVariant data(int column, int role) const;
224 IrcUserItem *findIrcUser(IrcUser *ircUser);
225 void addUsers(const QList<IrcUser *> &ircUser);
226 bool removeUser(IrcUser *ircUser);
228 static int categoryFromModes(const QString &modes);
233 static const QList<QChar> categories;
236 /*****************************************
238 *****************************************/
239 class IrcUserItem : public PropertyMapItem {
241 Q_PROPERTY(QString nickName READ nickName)
244 IrcUserItem(IrcUser *ircUser, AbstractTreeItem *parent);
246 inline QString nickName() const { return _ircUser ? _ircUser->nick() : QString(); }
247 inline bool isActive() const { return _ircUser ? !_ircUser->isAway() : false; }
249 inline IrcUser *ircUser() { return _ircUser; }
250 virtual QVariant data(int column, int role) const;
251 virtual QString toolTip(int column) const;
254 inline void ircUserQuited() { parent()->removeChild(this); }
257 QPointer<IrcUser> _ircUser;
261 /*****************************************
263 *****************************************/
264 class NetworkModel : public TreeModel {
269 BufferTypeRole = TreeModel::UserRole,
279 BufferFirstUnreadMsgIdRole,
284 NetworkItemType = 0x01,
285 BufferItemType = 0x02,
286 UserCategoryItemType = 0x04,
287 IrcUserItemType = 0x08
289 Q_DECLARE_FLAGS(ItemTypes, ItemType)
291 NetworkModel(QObject *parent = 0);
292 static QList<QVariant> defaultHeader();
294 static bool mimeContainsBufferList(const QMimeData *mimeData);
295 static QList< QPair<NetworkId, BufferId> > mimeDataToBufferList(const QMimeData *mimeData);
297 virtual QStringList mimeTypes() const;
298 virtual QMimeData *mimeData(const QModelIndexList &) const;
300 void attachNetwork(Network *network);
302 bool isBufferIndex(const QModelIndex &) const;
303 //Buffer *getBufferByIndex(const QModelIndex &) const;
304 QModelIndex networkIndex(NetworkId networkId);
305 QModelIndex bufferIndex(BufferId bufferId);
307 const Network *networkByIndex(const QModelIndex &index) const;
309 BufferInfo::ActivityLevel bufferActivity(const BufferInfo &buffer) const;
311 //! Finds a buffer with a given name in a given network
312 /** This performs a linear search through all BufferItems, hence it is expensive.
313 * @param networkId The network which we search in
314 * @param bufferName The bufferName we look for
315 * @return The id of the buffer if found, an invalid one else
317 BufferId bufferId(NetworkId networkId, const QString &bufferName, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
319 QString bufferName(BufferId bufferId) const;
320 BufferInfo::Type bufferType(BufferId bufferId) const;
321 BufferInfo bufferInfo(BufferId bufferId) const;
322 MsgId lastSeenMsgId(BufferId bufferId) const;
323 MsgId markerLineMsgId(BufferId bufferId) const;
324 NetworkId networkId(BufferId bufferId) const;
325 QString networkName(BufferId bufferId) const;
327 inline QList<BufferId> allBufferIds() const { return _bufferItemCache.keys(); }
328 QList<BufferId> allBufferIdsSorted() const;
329 void sortBufferIds(QList<BufferId> &bufferIds) const;
332 void bufferUpdated(BufferInfo bufferInfo);
333 void removeBuffer(BufferId bufferId);
334 MsgId lastSeenMsgId(const BufferId &bufferId);
335 void setLastSeenMsgId(const BufferId &bufferId, const MsgId &msgId);
336 void setMarkerLineMsgId(const BufferId &bufferId, const MsgId &msgId);
337 void setBufferActivity(const BufferId &bufferId, BufferInfo::ActivityLevel activity);
338 void clearBufferActivity(const BufferId &bufferId);
339 void updateBufferActivity(Message &msg);
340 void networkRemoved(const NetworkId &networkId);
343 void setLastSeenMsg(BufferId bufferId, MsgId msgId);
346 void checkForRemovedBuffers(const QModelIndex &parent, int start, int end);
347 void checkForNewBuffers(const QModelIndex &parent, int start, int end);
348 void messageRedirectionSettingsChanged();
351 int networkRow(NetworkId networkId) const;
352 NetworkItem *findNetworkItem(NetworkId networkId) const;
353 NetworkItem *networkItem(NetworkId networkId);
354 inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) const { return findBufferItem(bufferInfo.bufferId()); }
355 BufferItem *findBufferItem(BufferId bufferId) const;
356 BufferItem *bufferItem(const BufferInfo &bufferInfo);
358 void updateBufferActivity(BufferItem *bufferItem, const Message &msg);
360 static bool bufferItemLessThan(const BufferItem *left, const BufferItem *right);
362 QHash<BufferId, BufferItem *> _bufferItemCache;
364 int _userNoticesTarget;
365 int _serverNoticesTarget;
366 int _errorMsgsTarget;
368 Q_DECLARE_OPERATORS_FOR_FLAGS(NetworkModel::ItemTypes)
370 #endif // NETWORKMODEL_H