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