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