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 const MsgId &lastSeenMsgId() const { return _lastSeenMsgId; }
109 inline const MsgId &lastSeenMarkerMsgId() const { return _lastSeenMarkerMsgId; }
110 void setLastSeenMsgId(const MsgId &msgId);
111 inline BufferInfo::ActivityLevel activityLevel() const { return _activity; }
112 void setActivityLevel(BufferInfo::ActivityLevel level);
113 void clearActivityLevel();
114 void updateActivityLevel(const Message &msg);
116 inline const MsgId &firstUnreadMsgId() const { return _firstUnreadMsgId; }
118 bool isCurrentBuffer() const;
119 virtual QString toolTip(int column) const;
122 virtual inline void setTopic(const QString &) { emit dataChanged(1); }
125 BufferInfo _bufferInfo;
126 BufferInfo::ActivityLevel _activity;
127 MsgId _lastSeenMsgId;
128 MsgId _lastSeenMarkerMsgId;
129 MsgId _firstUnreadMsgId;
132 /*****************************************
134 *****************************************/
135 class StatusBufferItem : public BufferItem {
139 StatusBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
141 virtual QString toolTip(int column) const;
142 virtual inline QString bufferName() const { return tr("Status Buffer"); }
145 /*****************************************
147 *****************************************/
148 class QueryBufferItem : public BufferItem {
152 QueryBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
154 virtual QVariant data(int column, int role) const;
155 virtual bool setData(int column, const QVariant &value, int role);
157 virtual inline bool isActive() const { return (bool)_ircUser; }
158 virtual QString toolTip(int column) const;
160 virtual void setBufferName(const QString &name);
163 void setIrcUser(IrcUser *ircUser);
164 void removeIrcUser();
170 /*****************************************
172 *****************************************/
173 class UserCategoryItem;
175 class ChannelBufferItem : public BufferItem {
179 ChannelBufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent);
181 virtual QVariant data(int column, int role) const;
182 virtual inline bool isActive() const { return (bool)_ircChannel; }
183 virtual QString toolTip(int column) const;
185 virtual inline QString topic() const { return (bool)_ircChannel ? _ircChannel->topic() : QString(); }
186 virtual inline int nickCount() const { return (bool)_ircChannel ? _ircChannel->ircUsers().count() : 0; }
188 void attachIrcChannel(IrcChannel *ircChannel);
191 void join(const QList<IrcUser *> &ircUsers);
192 void part(IrcUser *ircUser);
194 UserCategoryItem *findCategoryItem(int categoryId);
195 void addUserToCategory(IrcUser *ircUser);
196 void addUsersToCategory(const QList<IrcUser *> &ircUser);
197 void removeUserFromCategory(IrcUser *ircUser);
198 void userModeChanged(IrcUser *ircUser);
201 void ircChannelParted();
204 IrcChannel *_ircChannel;
207 /*****************************************
208 * User Category Items (like @vh etc.)
209 *****************************************/
211 class UserCategoryItem : public PropertyMapItem {
213 Q_PROPERTY(QString categoryName READ categoryName)
216 UserCategoryItem(int category, AbstractTreeItem *parent);
218 QString categoryName() const;
219 inline int categoryId() const { return _category; }
220 virtual QVariant data(int column, int role) const;
222 IrcUserItem *findIrcUser(IrcUser *ircUser);
223 void addUsers(const QList<IrcUser *> &ircUser);
224 bool removeUser(IrcUser *ircUser);
226 static int categoryFromModes(const QString &modes);
231 static const QList<QChar> categories;
234 /*****************************************
236 *****************************************/
237 class IrcUserItem : public PropertyMapItem {
239 Q_PROPERTY(QString nickName READ nickName)
242 IrcUserItem(IrcUser *ircUser, AbstractTreeItem *parent);
244 inline QString nickName() const { return _ircUser ? _ircUser->nick() : QString(); }
245 inline bool isActive() const { return _ircUser ? !_ircUser->isAway() : false; }
247 inline IrcUser *ircUser() { return _ircUser; }
248 virtual QVariant data(int column, int role) const;
249 virtual QString toolTip(int column) const;
252 inline void ircUserQuited() { parent()->removeChild(this); }
255 QPointer<IrcUser> _ircUser;
259 /*****************************************
261 *****************************************/
262 class NetworkModel : public TreeModel {
267 BufferTypeRole = TreeModel::UserRole,
277 BufferFirstUnreadMsgIdRole,
281 NetworkItemType = 0x01,
282 BufferItemType = 0x02,
283 UserCategoryItemType = 0x04,
284 IrcUserItemType = 0x08
286 Q_DECLARE_FLAGS(ItemTypes, ItemType)
288 NetworkModel(QObject *parent = 0);
289 static QList<QVariant> defaultHeader();
291 static bool mimeContainsBufferList(const QMimeData *mimeData);
292 static QList< QPair<NetworkId, BufferId> > mimeDataToBufferList(const QMimeData *mimeData);
294 virtual QStringList mimeTypes() const;
295 virtual QMimeData *mimeData(const QModelIndexList &) const;
297 void attachNetwork(Network *network);
299 bool isBufferIndex(const QModelIndex &) const;
300 //Buffer *getBufferByIndex(const QModelIndex &) const;
301 QModelIndex networkIndex(NetworkId networkId);
302 QModelIndex bufferIndex(BufferId bufferId);
304 const Network *networkByIndex(const QModelIndex &index) const;
306 BufferInfo::ActivityLevel bufferActivity(const BufferInfo &buffer) const;
308 //! Finds a buffer with a given name in a given network
309 /** This performs a linear search through all BufferItems, hence it is expensive.
310 * @param networkId The network which we search in
311 * @param bufferName The bufferName we look for
312 * @return The id of the buffer if found, an invalid one else
314 BufferId bufferId(NetworkId networkId, const QString &bufferName, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
316 QString bufferName(BufferId bufferId) const;
317 BufferInfo::Type bufferType(BufferId bufferId) const;
318 BufferInfo bufferInfo(BufferId bufferId) const;
319 MsgId lastSeenMsgId(BufferId bufferId) const;
320 MsgId lastSeenMarkerMsgId(BufferId bufferId) const;
321 NetworkId networkId(BufferId bufferId) const;
322 QString networkName(BufferId bufferId) const;
324 inline QList<BufferId> allBufferIds() const { return _bufferItemCache.keys(); }
325 QList<BufferId> allBufferIdsSorted() const;
326 void sortBufferIds(QList<BufferId> &bufferIds) const;
329 void bufferUpdated(BufferInfo bufferInfo);
330 void removeBuffer(BufferId bufferId);
331 MsgId lastSeenMsgId(const BufferId &bufferId);
332 void setLastSeenMsgId(const BufferId &bufferId, const MsgId &msgId);
333 void setBufferActivity(const BufferId &bufferId, BufferInfo::ActivityLevel activity);
334 void clearBufferActivity(const BufferId &bufferId);
335 void updateBufferActivity(Message &msg);
336 void networkRemoved(const NetworkId &networkId);
339 void setLastSeenMsg(BufferId bufferId, MsgId msgId);
342 void checkForRemovedBuffers(const QModelIndex &parent, int start, int end);
343 void checkForNewBuffers(const QModelIndex &parent, int start, int end);
344 void messageRedirectionSettingsChanged();
347 int networkRow(NetworkId networkId) const;
348 NetworkItem *findNetworkItem(NetworkId networkId) const;
349 NetworkItem *networkItem(NetworkId networkId);
350 inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) const { return findBufferItem(bufferInfo.bufferId()); }
351 BufferItem *findBufferItem(BufferId bufferId) const;
352 BufferItem *bufferItem(const BufferInfo &bufferInfo);
354 void updateBufferActivity(BufferItem *bufferItem, const Message &msg);
356 static bool bufferItemLessThan(const BufferItem *left, const BufferItem *right);
358 QHash<BufferId, BufferItem *> _bufferItemCache;
360 int _userNoticesTarget;
361 int _serverNoticesTarget;
362 int _errorMsgsTarget;
364 Q_DECLARE_OPERATORS_FOR_FLAGS(NetworkModel::ItemTypes)
366 #endif // NETWORKMODEL_H