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