src/client/networkmodel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 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 "bufferinfo.h"
  25 #include "clientsettings.h"
  26 #include "message.h"
  27 #include "network.h"
  28 #include "treemodel.h"
  29
  30 class BufferItem;
  31 class StatusBufferItem;
  32
  33 /*****************************************
  34  *  Network Items
  35  *****************************************/
  36 class NetworkItem : public PropertyMapItem {
  37   Q_OBJECT
  38   Q_PROPERTY(QString networkName READ networkName)
  39   Q_PROPERTY(QString currentServer READ currentServer)
  40   Q_PROPERTY(int nickCount READ nickCount)
  41
  42 public:
  43   NetworkItem(const NetworkId &netid, AbstractTreeItem *parent = 0);
  44
  45   virtual QVariant data(int column, int row) const;
  46
  47   inline bool isActive() const { return (bool)_network ? _network->isConnected() : false; }
  48
  49   inline const NetworkId &networkId() const { return _networkId; }
  50   inline QString networkName() const { return (bool)_network ? _network->networkName() : QString(); }
  51   inline QString currentServer() const { return (bool)_network ? _network->currentServer() : QString(); }
  52   inline int nickCount() const { return (bool)_network ? _network->ircUsers().count() : 0; }
  53
  54   virtual QString toolTip(int column) const;
  55
  56   BufferItem *findBufferItem(BufferId bufferId);
  57   inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) { return findBufferItem(bufferInfo.bufferId()); }
  58   BufferItem *bufferItem(const BufferInfo &bufferInfo);
  59
  60 public slots:
  61   void setNetworkName(const QString &networkName);
  62   void setCurrentServer(const QString &serverName);
  63
  64   void attachNetwork(Network *network);
  65   void attachIrcChannel(IrcChannel *channel);
  66   void attachIrcUser(IrcUser *ircUser);
  67
  68 signals:
  69   void networkDataChanged(int column = -1);
  70
  71 private slots:
  72   void onBeginRemoveChilds(int start, int end);
  73
  74 private:
  75   NetworkId _networkId;
  76   StatusBufferItem *_statusBufferItem;
  77
  78   QPointer<Network> _network;
  79 };
  80
  81 /*****************************************
  82  *  Fancy Buffer Items
  83  *****************************************/
  84 class BufferItem : public PropertyMapItem {
  85   Q_OBJECT
  86   Q_PROPERTY(QString bufferName READ bufferName WRITE setBufferName)
  87   Q_PROPERTY(QString topic READ topic)
  88   Q_PROPERTY(int nickCount READ nickCount)
  89
  90 public:
  91   BufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent = 0);
  92
  93   inline const BufferInfo &bufferInfo() const { return _bufferInfo; }
  94   virtual QVariant data(int column, int role) const;
  95   virtual bool setData(int column, const QVariant &value, int role);
  96
  97   inline BufferId bufferId() const { return _bufferInfo.bufferId(); }
  98   inline BufferInfo::Type bufferType() const { return _bufferInfo.type(); }
  99
 100   virtual void setBufferName(const QString &name);
 101   virtual inline QString bufferName() const { return _bufferInfo.bufferName(); }
 102   virtual inline QString topic() const { return QString(); }
 103   virtual inline int nickCount() const { return 0; }
 104
 105   virtual inline bool isActive() const { return qobject_cast<NetworkItem *>(parent())->isActive(); }
 106
 107   inline const MsgId &lastSeenMsgId() const { return _lastSeenMsgId; }
 108   inline const MsgId &lastSeenMarkerMsgId() const { return _lastSeenMarkerMsgId; }
 109   void setLastSeenMsgId(const MsgId &msgId);
 110   inline BufferInfo::ActivityLevel activityLevel() const { return _activity; }
 111   void setActivityLevel(BufferInfo::ActivityLevel level);
 112   void clearActivityLevel();
 113   void updateActivityLevel(const Message &msg);
 114
 115   bool isCurrentBuffer() const;
 116   virtual QString toolTip(int column) const;
 117
 118 public slots:
 119   virtual inline void setTopic(const QString &) { emit dataChanged(1); }
 120
 121 private:
 122   BufferInfo _bufferInfo;
 123   BufferInfo::ActivityLevel _activity;
 124   MsgId _lastSeenMsgId;
 125   MsgId _lastSeenMarkerMsgId;
 126 };
 127
 128 /*****************************************
 129 *  StatusBufferItem
 130 *****************************************/
 131 class StatusBufferItem : public BufferItem {
 132   Q_OBJECT
 133
 134 public:
 135   StatusBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
 136
 137   virtual QString toolTip(int column) const;
 138   virtual inline QString bufferName() const { return tr("Status Buffer"); }
 139 };
 140
 141 /*****************************************
 142 *  QueryBufferItem
 143 *****************************************/
 144 class QueryBufferItem : public BufferItem {
 145   Q_OBJECT
 146
 147 public:
 148   QueryBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
 149
 150   virtual QVariant data(int column, int role) const;
 151   virtual bool setData(int column, const QVariant &value, int role);
 152
 153   virtual inline bool isActive() const { return (bool)_ircUser; }
 154   virtual QString toolTip(int column) const;
 155
 156   virtual void setBufferName(const QString &name);
 157
 158 public slots:
 159   void setIrcUser(IrcUser *ircUser);
 160   void removeIrcUser();
 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 QVariant data(int column, int role) const;
 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 ircChannelParted();
 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 ircUserQuited() { 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 Role {
 263     BufferTypeRole = TreeModel::UserRole,
 264     ItemActiveRole,
 265     BufferActivityRole,
 266     BufferIdRole,
 267     NetworkIdRole,
 268     BufferInfoRole,
 269     ItemTypeRole,
 270     UserAwayRole,
 271     IrcUserRole,
 272     IrcChannelRole
 273   };
 274
 275   enum ItemType {
 276     NetworkItemType = 0x01,
 277     BufferItemType = 0x02,
 278     UserCategoryItemType = 0x04,
 279     IrcUserItemType = 0x08
 280   };
 281   Q_DECLARE_FLAGS(ItemTypes, ItemType)
 282
 283   NetworkModel(QObject *parent = 0);
 284   static QList<QVariant> defaultHeader();
 285
 286   static bool mimeContainsBufferList(const QMimeData *mimeData);
 287   static QList< QPair<NetworkId, BufferId> > mimeDataToBufferList(const QMimeData *mimeData);
 288
 289   virtual QStringList mimeTypes() const;
 290   virtual QMimeData *mimeData(const QModelIndexList &) const;
 291
 292   void attachNetwork(Network *network);
 293
 294   bool isBufferIndex(const QModelIndex &) const;
 295   //Buffer *getBufferByIndex(const QModelIndex &) const;
 296   QModelIndex networkIndex(NetworkId networkId);
 297   QModelIndex bufferIndex(BufferId bufferId);
 298
 299   const Network *networkByIndex(const QModelIndex &index) const;
 300
 301   BufferInfo::ActivityLevel bufferActivity(const BufferInfo &buffer) const;
 302
 303   //! Finds a buffer with a given name in a given network
 304   /** This performs a linear search through all BufferItems, hence it is expensive.
 305    *  @param networkId  The network which we search in
 306    *  @param bufferName The bufferName we look for
 307    *  @return The id of the buffer if found, an invalid one else
 308    */
 309   BufferId bufferId(NetworkId networkId, const QString &bufferName, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
 310
 311   QString bufferName(BufferId bufferId) const;
 312   BufferInfo::Type bufferType(BufferId bufferId) const;
 313   BufferInfo bufferInfo(BufferId bufferId) const;
 314   MsgId lastSeenMsgId(BufferId bufferId) const;
 315   MsgId lastSeenMarkerMsgId(BufferId bufferId) const;
 316   NetworkId networkId(BufferId bufferId) const;
 317   QString networkName(BufferId bufferId) const;
 318
 319   inline QList<BufferId> allBufferIds() const { return _bufferItemCache.keys(); }
 320   QList<BufferId> allBufferIdsSorted() const;
 321   void sortBufferIds(QList<BufferId> &bufferIds) const;
 322
 323 public slots:
 324   void bufferUpdated(BufferInfo bufferInfo);
 325   void removeBuffer(BufferId bufferId);
 326   MsgId lastSeenMsgId(const BufferId &bufferId);
 327   void setLastSeenMsgId(const BufferId &bufferId, const MsgId &msgId);
 328   void setBufferActivity(const BufferId &bufferId, BufferInfo::ActivityLevel activity);
 329   void clearBufferActivity(const BufferId &bufferId);
 330   void updateBufferActivity(const Message &msg);
 331   void networkRemoved(const NetworkId &networkId);
 332
 333 signals:
 334   void setLastSeenMsg(BufferId bufferId, MsgId msgId);
 335
 336 private slots:
 337   void checkForRemovedBuffers(const QModelIndex &parent, int start, int end);
 338   void checkForNewBuffers(const QModelIndex &parent, int start, int end);
 339
 340 private:
 341   int networkRow(NetworkId networkId) const;
 342   NetworkItem *findNetworkItem(NetworkId networkId) const;
 343   NetworkItem *networkItem(NetworkId networkId);
 344   inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) const { return findBufferItem(bufferInfo.bufferId()); }
 345   BufferItem *findBufferItem(BufferId bufferId) const;
 346   BufferItem *bufferItem(const BufferInfo &bufferInfo);
 347
 348   static bool bufferItemLessThan(const BufferItem *left, const BufferItem *right);
 349
 350   QHash<BufferId, BufferItem *> _bufferItemCache;
 351 };
 352 Q_DECLARE_OPERATORS_FOR_FLAGS(NetworkModel::ItemTypes)
 353
 354 #endif // NETWORKMODEL_H