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   inline StatusBufferItem *statusBufferItem() const { return _statusBufferItem; }
  60
  61 public slots:
  62   void setNetworkName(const QString &networkName);
  63   void setCurrentServer(const QString &serverName);
  64
  65   void attachNetwork(Network *network);
  66   void attachIrcChannel(IrcChannel *channel);
  67   void attachIrcUser(IrcUser *ircUser);
  68
  69 signals:
  70   void networkDataChanged(int column = -1);
  71
  72 private slots:
  73   void onBeginRemoveChilds(int start, int end);
  74
  75 private:
  76   NetworkId _networkId;
  77   StatusBufferItem *_statusBufferItem;
  78
  79   QPointer<Network> _network;
  80 };
  81
  82 /*****************************************
  83  *  Fancy Buffer Items
  84  *****************************************/
  85 class BufferItem : public PropertyMapItem {
  86   Q_OBJECT
  87   Q_PROPERTY(QString bufferName READ bufferName WRITE setBufferName)
  88   Q_PROPERTY(QString topic READ topic)
  89   Q_PROPERTY(int nickCount READ nickCount)
  90
  91 public:
  92   BufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent = 0);
  93
  94   inline const BufferInfo &bufferInfo() const { return _bufferInfo; }
  95   virtual QVariant data(int column, int role) const;
  96   virtual bool setData(int column, const QVariant &value, int role);
  97
  98   inline BufferId bufferId() const { return _bufferInfo.bufferId(); }
  99   inline BufferInfo::Type bufferType() const { return _bufferInfo.type(); }
 100
 101   virtual void setBufferName(const QString &name);
 102   virtual inline QString bufferName() const { return _bufferInfo.bufferName(); }
 103   virtual inline QString topic() const { return QString(); }
 104   virtual inline int nickCount() const { return 0; }
 105
 106   virtual inline bool isActive() const { return qobject_cast<NetworkItem *>(parent())->isActive(); }
 107
 108   inline const MsgId &lastSeenMsgId() const { return _lastSeenMsgId; }
 109   inline const MsgId &lastSeenMarkerMsgId() const { return _lastSeenMarkerMsgId; }
 110   void setLastSeenMsgId(const MsgId &msgId);
 111   inline BufferInfo::ActivityLevel activityLevel() const { return _activity; }
 112   void setActivityLevel(BufferInfo::ActivityLevel level);
 113   void clearActivityLevel();
 114   void updateActivityLevel(const Message &msg);
 115
 116   bool isCurrentBuffer() const;
 117   virtual QString toolTip(int column) const;
 118
 119 public slots:
 120   virtual inline void setTopic(const QString &) { emit dataChanged(1); }
 121
 122 private:
 123   BufferInfo _bufferInfo;
 124   BufferInfo::ActivityLevel _activity;
 125   MsgId _lastSeenMsgId;
 126   MsgId _lastSeenMarkerMsgId;
 127 };
 128
 129 /*****************************************
 130 *  StatusBufferItem
 131 *****************************************/
 132 class StatusBufferItem : public BufferItem {
 133   Q_OBJECT
 134
 135 public:
 136   StatusBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
 137
 138   virtual QString toolTip(int column) const;
 139   virtual inline QString bufferName() const { return tr("Status Buffer"); }
 140 };
 141
 142 /*****************************************
 143 *  QueryBufferItem
 144 *****************************************/
 145 class QueryBufferItem : public BufferItem {
 146   Q_OBJECT
 147
 148 public:
 149   QueryBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
 150
 151   virtual QVariant data(int column, int role) const;
 152   virtual bool setData(int column, const QVariant &value, int role);
 153
 154   virtual inline bool isActive() const { return (bool)_ircUser; }
 155   virtual QString toolTip(int column) const;
 156
 157   virtual void setBufferName(const QString &name);
 158
 159 public slots:
 160   void setIrcUser(IrcUser *ircUser);
 161   void removeIrcUser();
 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
 293   void attachNetwork(Network *network);
 294
 295   bool isBufferIndex(const QModelIndex &) const;
 296   //Buffer *getBufferByIndex(const QModelIndex &) const;
 297   QModelIndex networkIndex(NetworkId networkId);
 298   QModelIndex bufferIndex(BufferId bufferId);
 299
 300   const Network *networkByIndex(const QModelIndex &index) const;
 301
 302   BufferInfo::ActivityLevel bufferActivity(const BufferInfo &buffer) const;
 303
 304   //! Finds a buffer with a given name in a given network
 305   /** This performs a linear search through all BufferItems, hence it is expensive.
 306    *  @param networkId  The network which we search in
 307    *  @param bufferName The bufferName we look for
 308    *  @return The id of the buffer if found, an invalid one else
 309    */
 310   BufferId bufferId(NetworkId networkId, const QString &bufferName, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
 311
 312   QString bufferName(BufferId bufferId) const;
 313   BufferInfo::Type bufferType(BufferId bufferId) const;
 314   BufferInfo bufferInfo(BufferId bufferId) const;
 315   MsgId lastSeenMsgId(BufferId bufferId) const;
 316   MsgId lastSeenMarkerMsgId(BufferId bufferId) const;
 317   NetworkId networkId(BufferId bufferId) const;
 318   QString networkName(BufferId bufferId) const;
 319
 320   inline QList<BufferId> allBufferIds() const { return _bufferItemCache.keys(); }
 321   QList<BufferId> allBufferIdsSorted() const;
 322   void sortBufferIds(QList<BufferId> &bufferIds) const;
 323
 324 public slots:
 325   void bufferUpdated(BufferInfo bufferInfo);
 326   void removeBuffer(BufferId bufferId);
 327   MsgId lastSeenMsgId(const BufferId &bufferId);
 328   void setLastSeenMsgId(const BufferId &bufferId, const MsgId &msgId);
 329   void setBufferActivity(const BufferId &bufferId, BufferInfo::ActivityLevel activity);
 330   void clearBufferActivity(const BufferId &bufferId);
 331   void updateBufferActivity(Message &msg);
 332   void networkRemoved(const NetworkId &networkId);
 333
 334 signals:
 335   void setLastSeenMsg(BufferId bufferId, MsgId msgId);
 336
 337 private slots:
 338   void checkForRemovedBuffers(const QModelIndex &parent, int start, int end);
 339   void checkForNewBuffers(const QModelIndex &parent, int start, int end);
 340   void messageRedirectionSettingsChanged();
 341
 342 private:
 343   int networkRow(NetworkId networkId) const;
 344   NetworkItem *findNetworkItem(NetworkId networkId) const;
 345   NetworkItem *networkItem(NetworkId networkId);
 346   inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) const { return findBufferItem(bufferInfo.bufferId()); }
 347   BufferItem *findBufferItem(BufferId bufferId) const;
 348   BufferItem *bufferItem(const BufferInfo &bufferInfo);
 349
 350   void updateBufferActivity(BufferItem *bufferItem, const Message &msg);
 351
 352   static bool bufferItemLessThan(const BufferItem *left, const BufferItem *right);
 353
 354   QHash<BufferId, BufferItem *> _bufferItemCache;
 355
 356   int _userNoticesTarget;
 357   int _serverNoticesTarget;
 358   int _errorMsgsTarget;
 359 };
 360 Q_DECLARE_OPERATORS_FOR_FLAGS(NetworkModel::ItemTypes)
 361
 362 #endif // NETWORKMODEL_H