internal stuff only: AbstractTreeItems can now commit suicide if they are childless
[quassel.git] / src / client / networkmodel.h
1 /***************************************************************************
2  *   Copyright (C) 2005-08 by the Quassel Project                          *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
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.                                           *
9  *                                                                         *
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.                          *
14  *                                                                         *
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  ***************************************************************************/
20
21 #ifndef NETWORKMODEL_H
22 #define NETWORKMODEL_H
23
24 #include <QtCore>
25
26 #include "treemodel.h"
27 #include "buffer.h"
28
29 #include <QPointer>
30
31 class BufferInfo;
32
33 #include "selectionmodelsynchronizer.h"
34 #include "modelpropertymapper.h"
35 #include "clientsettings.h"
36 #include "ircchannel.h"
37 #include "ircuser.h"
38 #include "network.h"
39
40 class MappedSelectionModel;
41 class QAbstractItemView;
42 class BufferItem;
43
44 /*****************************************
45  *  Network Items
46  *****************************************/
47 class NetworkItem : public PropertyMapItem {
48   Q_OBJECT
49   Q_PROPERTY(QString networkName READ networkName)
50   Q_PROPERTY(QString currentServer READ currentServer)
51   Q_PROPERTY(int nickCount READ nickCount)
52     
53 public:
54   NetworkItem(const NetworkId &netid, AbstractTreeItem *parent = 0);
55
56   virtual QVariant data(int column, int row) const;
57
58   inline bool isActive() const { return (bool)_network ? _network->isConnected() : false; }
59
60   inline const NetworkId &networkId() const { return _networkId; }
61   inline QString networkName() const { return (bool)_network ? _network->networkName() : QString(); }
62   inline QString currentServer() const { return (bool)_network ? _network->currentServer() : QString(); }
63   inline int nickCount() const { return (bool)_network ? _network->ircUsers().count() : 0; }
64
65   virtual QString toolTip(int column) const;
66
67   BufferItem *findBufferItem(BufferId bufferId);
68   inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) { return findBufferItem(bufferInfo.bufferId()); }
69   BufferItem *bufferItem(const BufferInfo &bufferInfo);
70
71 public slots:
72   void setNetworkName(const QString &networkName);
73   void setCurrentServer(const QString &serverName);
74
75   void attachNetwork(Network *network);
76   void attachIrcChannel(IrcChannel *channel);
77   void attachIrcUser(IrcUser *ircUser);
78
79 private:
80   NetworkId _networkId;
81
82   QPointer<Network> _network;
83 };
84
85 /*****************************************
86  *  Fancy Buffer Items
87  *****************************************/
88 class BufferItem : public PropertyMapItem {
89   Q_OBJECT
90   Q_PROPERTY(QString bufferName READ bufferName WRITE setBufferName)
91   Q_PROPERTY(QString topic READ topic)
92   Q_PROPERTY(int nickCount READ nickCount)
93
94 public:
95   BufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent = 0);
96
97   inline const BufferInfo &bufferInfo() const { return _bufferInfo; }
98   virtual QVariant data(int column, int role) const;
99   virtual bool setData(int column, const QVariant &value, int role);
100
101   inline BufferId bufferId() const { return _bufferInfo.bufferId(); }
102   inline BufferInfo::Type bufferType() const { return _bufferInfo.type(); }
103
104   void setBufferName(const QString &name);
105   virtual inline QString bufferName() const { return _bufferInfo.bufferName(); }
106   virtual inline QString topic() const { return QString(); }
107   virtual inline int nickCount() const { return 0; }
108
109   virtual inline bool isActive() const { return qobject_cast<NetworkItem *>(parent())->isActive(); }
110
111   inline Buffer::ActivityLevel activityLevel() const { return _activity; }
112   void setActivityLevel(Buffer::ActivityLevel level);
113   void updateActivityLevel(Buffer::ActivityLevel level);
114
115   void setLastMsgInsert(QDateTime msgDate);
116   bool setLastSeen();
117   QDateTime lastSeen();
118
119   virtual QString toolTip(int column) const;
120
121 public slots:
122   virtual inline void setTopic(const QString &) { emit dataChanged(1); }
123
124 private:
125   BufferInfo _bufferInfo;
126   Buffer::ActivityLevel _activity;
127 };
128
129 /*****************************************
130 *  StatusBufferItem
131 *****************************************/
132 class StatusBufferItem : public BufferItem {
133   Q_OBJECT
134
135 public:
136   StatusBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
137
138   virtual QString toolTip(int column) const;
139   virtual inline QString bufferName() const { return tr("Status Buffer"); }
140 };
141
142 /*****************************************
143 *  QueryBufferItem
144 *****************************************/
145 class QueryBufferItem : public BufferItem {
146   Q_OBJECT
147
148 public:
149   QueryBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
150
151   virtual bool isActive() const;
152   virtual QString toolTip(int column) const;
153
154 public slots:
155   void attachIrcUser(IrcUser *ircUser);
156   void ircUserDestroyed();
157
158 private:
159   IrcUser *_ircUser;
160 };
161
162 /*****************************************
163 *  ChannelBufferItem
164 *****************************************/
165 class UserCategoryItem;
166
167 class ChannelBufferItem : public BufferItem {
168   Q_OBJECT
169
170 public:
171   ChannelBufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent);
172
173   virtual inline bool isActive() const { return (bool)_ircChannel; }
174   virtual QString toolTip(int column) const;
175
176   virtual inline QString topic() const { return (bool)_ircChannel ? _ircChannel->topic() : QString(); }
177   virtual inline int nickCount() const { return (bool)_ircChannel ? _ircChannel->ircUsers().count() : 0; }
178   
179   void attachIrcChannel(IrcChannel *ircChannel);
180
181 public slots:
182   void join(const QList<IrcUser *> &ircUsers);
183   void part(IrcUser *ircUser);
184
185   UserCategoryItem *findCategoryItem(int categoryId);
186   void addUserToCategory(IrcUser *ircUser);
187   void addUsersToCategory(const QList<IrcUser *> &ircUser);
188   void removeUserFromCategory(IrcUser *ircUser);
189   void userModeChanged(IrcUser *ircUser);
190
191 private slots:
192   void ircChannelDestroyed();
193
194 private:
195   IrcChannel *_ircChannel;
196 };
197
198 /*****************************************
199 *  User Category Items (like @vh etc.)
200 *****************************************/
201 class IrcUserItem;
202 class UserCategoryItem : public PropertyMapItem {
203   Q_OBJECT
204   Q_PROPERTY(QString categoryName READ categoryName)
205     
206 public:
207   UserCategoryItem(int category, AbstractTreeItem *parent);
208
209   QString categoryName() const;
210   inline int categoryId() const { return _category; }
211   virtual QVariant data(int column, int role) const;
212
213   IrcUserItem *findIrcUser(IrcUser *ircUser);
214   void addUsers(const QList<IrcUser *> &ircUser);
215   bool removeUser(IrcUser *ircUser);
216
217   static int categoryFromModes(const QString &modes);
218
219 private:
220   int _category;
221
222   static const QList<QChar> categories;
223 };
224
225 /*****************************************
226 *  Irc User Items
227 *****************************************/
228 class IrcUserItem : public PropertyMapItem {
229   Q_OBJECT
230   Q_PROPERTY(QString nickName READ nickName)
231     
232 public:
233   IrcUserItem(IrcUser *ircUser, AbstractTreeItem *parent);
234
235   inline QString nickName() const { return _ircUser ? _ircUser->nick() : QString(); }
236   inline bool isActive() const { return _ircUser ? !_ircUser->isAway() : false; }
237
238   inline IrcUser *ircUser() { return _ircUser; }
239   virtual QVariant data(int column, int role) const;
240   virtual QString toolTip(int column) const;
241
242 private slots:
243   inline void ircUserDestroyed() { parent()->removeChild(this); }
244
245 private:
246   QPointer<IrcUser> _ircUser;
247 };
248
249
250 /*****************************************
251  * NetworkModel
252  *****************************************/
253 class NetworkModel : public TreeModel {
254   Q_OBJECT
255
256 public:
257   enum myRoles {
258     BufferTypeRole = TreeModel::UserRole,
259     ItemActiveRole,
260     BufferActivityRole,
261     BufferIdRole,
262     NetworkIdRole,
263     BufferInfoRole,
264     ItemTypeRole
265   };
266
267   enum itemType {
268     NetworkItemType = 0x01,
269     BufferItemType = 0x02,
270     UserCategoryItemType = 0x04,
271     IrcUserItemType = 0x08
272   };
273   Q_DECLARE_FLAGS(itemTypes, itemType);
274
275   NetworkModel(QObject *parent = 0);
276   static QList<QVariant> defaultHeader();
277
278   static bool mimeContainsBufferList(const QMimeData *mimeData);
279   static QList< QPair<NetworkId, BufferId> > mimeDataToBufferList(const QMimeData *mimeData);
280
281   virtual QStringList mimeTypes() const;
282   virtual QMimeData *mimeData(const QModelIndexList &) const;
283   virtual bool dropMimeData(const QMimeData *, Qt::DropAction, int, int, const QModelIndex &);
284
285   void attachNetwork(Network *network);
286
287   bool isBufferIndex(const QModelIndex &) const;
288   //Buffer *getBufferByIndex(const QModelIndex &) const;
289   QModelIndex networkIndex(NetworkId networkId);
290   QModelIndex bufferIndex(BufferId bufferId);
291
292   const Network *networkByIndex(const QModelIndex &index) const;
293
294   Buffer::ActivityLevel bufferActivity(const BufferInfo &buffer) const;
295
296 public slots:
297   void bufferUpdated(BufferInfo bufferInfo);
298   void removeBuffer(BufferId bufferId);
299   void setBufferActivity(const BufferInfo &buffer, Buffer::ActivityLevel activity);
300   void networkRemoved(const NetworkId &networkId);
301   
302 private:
303   int networkRow(NetworkId networkId);
304   NetworkItem *findNetworkItem(NetworkId networkId);
305   NetworkItem *networkItem(NetworkId networkId);
306   BufferItem *findBufferItem(const BufferInfo &bufferInfo);
307   BufferItem *findBufferItem(BufferId bufferId);
308   BufferItem *bufferItem(const BufferInfo &bufferInfo);
309
310 };
311 Q_DECLARE_OPERATORS_FOR_FLAGS(NetworkModel::itemTypes);
312
313 #endif // NETWORKMODEL_H