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 const MsgId &lastSeenMarkerMsgId() const { return _lastSeenMarkerMsgId; }
 114   void setLastSeenMsgId(const MsgId &msgId);
 115   inline BufferInfo::ActivityLevel activityLevel() const { return _activity; }
 116   void setActivityLevel(BufferInfo::ActivityLevel level);
 117   void clearActivityLevel();
 118   void updateActivityLevel(const Message &msg);
 119
 120   bool isCurrentBuffer() const;
 121   virtual QString toolTip(int column) const;
 122
 123 public slots:
 124   virtual inline void setTopic(const QString &) { emit dataChanged(1); }
 125
 126 private:
 127   BufferInfo _bufferInfo;
 128   BufferInfo::ActivityLevel _activity;
 129   MsgId _lastSeenMsgId;
 130   MsgId _lastSeenMarkerMsgId;
 131 };
 132
 133 /*****************************************
 134 *  StatusBufferItem
 135 *****************************************/
 136 class StatusBufferItem : public BufferItem {
 137   Q_OBJECT
 138
 139 public:
 140   StatusBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
 141
 142   virtual QString toolTip(int column) const;
 143   virtual inline QString bufferName() const { return tr("Status Buffer"); }
 144 };
 145
 146 /*****************************************
 147 *  QueryBufferItem
 148 *****************************************/
 149 class QueryBufferItem : public BufferItem {
 150   Q_OBJECT
 151
 152 public:
 153   QueryBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
 154
 155   virtual QVariant data(int column, int role) const;
 156   virtual inline bool isActive() const { return (bool)_ircUser; }
 157   virtual QString toolTip(int column) const;
 158
 159 public slots:
 160   void attachIrcUser(IrcUser *ircUser);
 161   void ircUserDestroyed();
 162
 163 private:
 164   IrcUser *_ircUser;
 165 };
 166
 167 /*****************************************
 168 *  ChannelBufferItem
 169 *****************************************/
 170 class UserCategoryItem;
 171
 172 class ChannelBufferItem : public BufferItem {
 173   Q_OBJECT
 174
 175 public:
 176   ChannelBufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent);
 177
 178   virtual inline bool isActive() const { return (bool)_ircChannel; }
 179   virtual QString toolTip(int column) const;
 180
 181   virtual inline QString topic() const { return (bool)_ircChannel ? _ircChannel->topic() : QString(); }
 182   virtual inline int nickCount() const { return (bool)_ircChannel ? _ircChannel->ircUsers().count() : 0; }
 183
 184   void attachIrcChannel(IrcChannel *ircChannel);
 185
 186 public slots:
 187   void join(const QList<IrcUser *> &ircUsers);
 188   void part(IrcUser *ircUser);
 189
 190   UserCategoryItem *findCategoryItem(int categoryId);
 191   void addUserToCategory(IrcUser *ircUser);
 192   void addUsersToCategory(const QList<IrcUser *> &ircUser);
 193   void removeUserFromCategory(IrcUser *ircUser);
 194   void userModeChanged(IrcUser *ircUser);
 195
 196 private slots:
 197   void ircChannelDestroyed();
 198
 199 private:
 200   IrcChannel *_ircChannel;
 201 };
 202
 203 /*****************************************
 204 *  User Category Items (like @vh etc.)
 205 *****************************************/
 206 class IrcUserItem;
 207 class UserCategoryItem : public PropertyMapItem {
 208   Q_OBJECT
 209   Q_PROPERTY(QString categoryName READ categoryName)
 210
 211 public:
 212   UserCategoryItem(int category, AbstractTreeItem *parent);
 213
 214   QString categoryName() const;
 215   inline int categoryId() const { return _category; }
 216   virtual QVariant data(int column, int role) const;
 217
 218   IrcUserItem *findIrcUser(IrcUser *ircUser);
 219   void addUsers(const QList<IrcUser *> &ircUser);
 220   bool removeUser(IrcUser *ircUser);
 221
 222   static int categoryFromModes(const QString &modes);
 223
 224 private:
 225   int _category;
 226
 227   static const QList<QChar> categories;
 228 };
 229
 230 /*****************************************
 231 *  Irc User Items
 232 *****************************************/
 233 class IrcUserItem : public PropertyMapItem {
 234   Q_OBJECT
 235   Q_PROPERTY(QString nickName READ nickName)
 236
 237 public:
 238   IrcUserItem(IrcUser *ircUser, AbstractTreeItem *parent);
 239
 240   inline QString nickName() const { return _ircUser ? _ircUser->nick() : QString(); }
 241   inline bool isActive() const { return _ircUser ? !_ircUser->isAway() : false; }
 242
 243   inline IrcUser *ircUser() { return _ircUser; }
 244   virtual QVariant data(int column, int role) const;
 245   virtual QString toolTip(int column) const;
 246
 247 private slots:
 248   inline void ircUserDestroyed() { parent()->removeChild(this); }
 249
 250 private:
 251   QPointer<IrcUser> _ircUser;
 252 };
 253
 254
 255 /*****************************************
 256  * NetworkModel
 257  *****************************************/
 258 class NetworkModel : public TreeModel {
 259   Q_OBJECT
 260
 261 public:
 262   enum myRoles {
 263     BufferTypeRole = TreeModel::UserRole,
 264     ItemActiveRole,
 265     BufferActivityRole,
 266     BufferIdRole,
 267     NetworkIdRole,
 268     BufferInfoRole,
 269     ItemTypeRole,
 270     UserAwayRole
 271   };
 272
 273   enum itemType {
 274     NetworkItemType = 0x01,
 275     BufferItemType = 0x02,
 276     UserCategoryItemType = 0x04,
 277     IrcUserItemType = 0x08
 278   };
 279   Q_DECLARE_FLAGS(itemTypes, itemType)
 280
 281   NetworkModel(QObject *parent = 0);
 282   static QList<QVariant> defaultHeader();
 283
 284   static bool mimeContainsBufferList(const QMimeData *mimeData);
 285   static QList< QPair<NetworkId, BufferId> > mimeDataToBufferList(const QMimeData *mimeData);
 286
 287   virtual QStringList mimeTypes() const;
 288   virtual QMimeData *mimeData(const QModelIndexList &) const;
 289   virtual bool dropMimeData(const QMimeData *, Qt::DropAction, int, int, const QModelIndex &);
 290
 291   void attachNetwork(Network *network);
 292
 293   bool isBufferIndex(const QModelIndex &) const;
 294   //Buffer *getBufferByIndex(const QModelIndex &) const;
 295   QModelIndex networkIndex(NetworkId networkId);
 296   QModelIndex bufferIndex(BufferId bufferId);
 297
 298   const Network *networkByIndex(const QModelIndex &index) const;
 299
 300   BufferInfo::ActivityLevel bufferActivity(const BufferInfo &buffer) const;
 301
 302   QString bufferName(BufferId bufferId);
 303   BufferInfo::Type bufferType(BufferId bufferId);
 304   BufferInfo bufferInfo(BufferId bufferId);
 305   MsgId lastSeenMsgId(BufferId bufferId);
 306   MsgId lastSeenMarkerMsgId(BufferId bufferId);
 307   NetworkId networkId(BufferId bufferId);
 308   QString networkName(BufferId bufferId);
 309
 310   inline QList<BufferId> allBufferIds() const { return _bufferItemCache.keys(); }
 311
 312 public slots:
 313   void bufferUpdated(BufferInfo bufferInfo);
 314   void removeBuffer(BufferId bufferId);
 315   void setLastSeenMsgId(const BufferId &bufferId, const MsgId &msgId);
 316   void setBufferActivity(const BufferId &bufferId, BufferInfo::ActivityLevel activity);
 317   void clearBufferActivity(const BufferId &bufferId);
 318   void updateBufferActivity(const Message &msg);
 319   void networkRemoved(const NetworkId &networkId);
 320
 321 signals:
 322   void setLastSeenMsg(BufferId bufferId, MsgId msgId);
 323
 324 private slots:
 325   void checkForRemovedBuffers(const QModelIndex &parent, int start, int end);
 326   void checkForNewBuffers(const QModelIndex &parent, int start, int end);
 327
 328 private:
 329   int networkRow(NetworkId networkId);
 330   NetworkItem *findNetworkItem(NetworkId networkId);
 331   NetworkItem *networkItem(NetworkId networkId);
 332   inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) { return findBufferItem(bufferInfo.bufferId()); }
 333   BufferItem *findBufferItem(BufferId bufferId);
 334   BufferItem *bufferItem(const BufferInfo &bufferInfo);
 335
 336   QHash<BufferId, BufferItem *> _bufferItemCache;
 337 };
 338 Q_DECLARE_OPERATORS_FOR_FLAGS(NetworkModel::itemTypes)
 339
 340 #endif // NETWORKMODEL_H