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 ircUserQuited();
 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 QVariant data(int column, int role) const;
 179   virtual inline bool isActive() const { return (bool)_ircChannel; }
 180   virtual QString toolTip(int column) const;
 181
 182   virtual inline QString topic() const { return (bool)_ircChannel ? _ircChannel->topic() : QString(); }
 183   virtual inline int nickCount() const { return (bool)_ircChannel ? _ircChannel->ircUsers().count() : 0; }
 184
 185   void attachIrcChannel(IrcChannel *ircChannel);
 186
 187 public slots:
 188   void join(const QList<IrcUser *> &ircUsers);
 189   void part(IrcUser *ircUser);
 190
 191   UserCategoryItem *findCategoryItem(int categoryId);
 192   void addUserToCategory(IrcUser *ircUser);
 193   void addUsersToCategory(const QList<IrcUser *> &ircUser);
 194   void removeUserFromCategory(IrcUser *ircUser);
 195   void userModeChanged(IrcUser *ircUser);
 196
 197 private slots:
 198   void ircChannelParted();
 199
 200 private:
 201   IrcChannel *_ircChannel;
 202 };
 203
 204 /*****************************************
 205 *  User Category Items (like @vh etc.)
 206 *****************************************/
 207 class IrcUserItem;
 208 class UserCategoryItem : public PropertyMapItem {
 209   Q_OBJECT
 210   Q_PROPERTY(QString categoryName READ categoryName)
 211
 212 public:
 213   UserCategoryItem(int category, AbstractTreeItem *parent);
 214
 215   QString categoryName() const;
 216   inline int categoryId() const { return _category; }
 217   virtual QVariant data(int column, int role) const;
 218
 219   IrcUserItem *findIrcUser(IrcUser *ircUser);
 220   void addUsers(const QList<IrcUser *> &ircUser);
 221   bool removeUser(IrcUser *ircUser);
 222
 223   static int categoryFromModes(const QString &modes);
 224
 225 private:
 226   int _category;
 227
 228   static const QList<QChar> categories;
 229 };
 230
 231 /*****************************************
 232 *  Irc User Items
 233 *****************************************/
 234 class IrcUserItem : public PropertyMapItem {
 235   Q_OBJECT
 236   Q_PROPERTY(QString nickName READ nickName)
 237
 238 public:
 239   IrcUserItem(IrcUser *ircUser, AbstractTreeItem *parent);
 240
 241   inline QString nickName() const { return _ircUser ? _ircUser->nick() : QString(); }
 242   inline bool isActive() const { return _ircUser ? !_ircUser->isAway() : false; }
 243
 244   inline IrcUser *ircUser() { return _ircUser; }
 245   virtual QVariant data(int column, int role) const;
 246   virtual QString toolTip(int column) const;
 247
 248 private slots:
 249   inline void ircUserQuited() { parent()->removeChild(this); }
 250
 251 private:
 252   QPointer<IrcUser> _ircUser;
 253 };
 254
 255
 256 /*****************************************
 257  * NetworkModel
 258  *****************************************/
 259 class NetworkModel : public TreeModel {
 260   Q_OBJECT
 261
 262 public:
 263   enum Role {
 264     BufferTypeRole = TreeModel::UserRole,
 265     ItemActiveRole,
 266     BufferActivityRole,
 267     BufferIdRole,
 268     NetworkIdRole,
 269     BufferInfoRole,
 270     ItemTypeRole,
 271     UserAwayRole,
 272     IrcUserRole,
 273     IrcChannelRole
 274   };
 275
 276   enum ItemType {
 277     NetworkItemType = 0x01,
 278     BufferItemType = 0x02,
 279     UserCategoryItemType = 0x04,
 280     IrcUserItemType = 0x08
 281   };
 282   Q_DECLARE_FLAGS(ItemTypes, ItemType)
 283
 284   NetworkModel(QObject *parent = 0);
 285   static QList<QVariant> defaultHeader();
 286
 287   static bool mimeContainsBufferList(const QMimeData *mimeData);
 288   static QList< QPair<NetworkId, BufferId> > mimeDataToBufferList(const QMimeData *mimeData);
 289
 290   virtual QStringList mimeTypes() const;
 291   virtual QMimeData *mimeData(const QModelIndexList &) const;
 292   virtual bool dropMimeData(const QMimeData *, Qt::DropAction, int, int, const QModelIndex &);
 293
 294   void attachNetwork(Network *network);
 295
 296   bool isBufferIndex(const QModelIndex &) const;
 297   //Buffer *getBufferByIndex(const QModelIndex &) const;
 298   QModelIndex networkIndex(NetworkId networkId);
 299   QModelIndex bufferIndex(BufferId bufferId);
 300
 301   const Network *networkByIndex(const QModelIndex &index) const;
 302
 303   BufferInfo::ActivityLevel bufferActivity(const BufferInfo &buffer) const;
 304
 305   //! Finds a buffer with a given name in a given network
 306   /** This performs a linear search through all BufferItems, hence it is expensive.
 307    *  @param networkId  The network which we search in
 308    *  @param bufferName The bufferName we look for
 309    *  @return The id of the buffer if found, an invalid one else
 310    */
 311   BufferId bufferId(NetworkId networkId, const QString &bufferName, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
 312
 313   QString bufferName(BufferId bufferId) const;
 314   BufferInfo::Type bufferType(BufferId bufferId) const;
 315   BufferInfo bufferInfo(BufferId bufferId) const;
 316   MsgId lastSeenMsgId(BufferId bufferId) const;
 317   MsgId lastSeenMarkerMsgId(BufferId bufferId) const;
 318   NetworkId networkId(BufferId bufferId) const;
 319   QString networkName(BufferId bufferId) const;
 320
 321   inline QList<BufferId> allBufferIds() const { return _bufferItemCache.keys(); }
 322
 323 public slots:
 324   void bufferUpdated(BufferInfo bufferInfo);
 325   void removeBuffer(BufferId bufferId);
 326   void setLastSeenMsgId(const BufferId &bufferId, const MsgId &msgId);
 327   void setBufferActivity(const BufferId &bufferId, BufferInfo::ActivityLevel activity);
 328   void clearBufferActivity(const BufferId &bufferId);
 329   void updateBufferActivity(const Message &msg);
 330   void networkRemoved(const NetworkId &networkId);
 331
 332 signals:
 333   void setLastSeenMsg(BufferId bufferId, MsgId msgId);
 334
 335 private slots:
 336   void checkForRemovedBuffers(const QModelIndex &parent, int start, int end);
 337   void checkForNewBuffers(const QModelIndex &parent, int start, int end);
 338
 339 private:
 340   int networkRow(NetworkId networkId) const;
 341   NetworkItem *findNetworkItem(NetworkId networkId) const;
 342   NetworkItem *networkItem(NetworkId networkId);
 343   inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) const { return findBufferItem(bufferInfo.bufferId()); }
 344   BufferItem *findBufferItem(BufferId bufferId) const;
 345   BufferItem *bufferItem(const BufferInfo &bufferInfo);
 346
 347   QHash<BufferId, BufferItem *> _bufferItemCache;
 348 };
 349 Q_DECLARE_OPERATORS_FOR_FLAGS(NetworkModel::ItemTypes)
 350
 351 #endif // NETWORKMODEL_H