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