src/client/networkmodel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2013 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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 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 {
  38     Q_OBJECT
  39     Q_PROPERTY(QString networkName READ networkName)
  40     Q_PROPERTY(QString currentServer READ currentServer)
  41     Q_PROPERTY(int nickCount READ nickCount)
  42
  43 public :
  44         NetworkItem(const NetworkId &netid, AbstractTreeItem *parent = 0);
  45
  46     virtual QVariant data(int column, int row) const;
  47
  48     inline bool isActive() const { return (bool)_network ? _network->isConnected() : false; }
  49
  50     inline const NetworkId &networkId() const { return _networkId; }
  51     inline QString networkName() const { return (bool)_network ? _network->networkName() : QString(); }
  52     inline QString currentServer() const { return (bool)_network ? _network->currentServer() : QString(); }
  53     inline int nickCount() const { return (bool)_network ? _network->ircUsers().count() : 0; }
  54
  55     virtual QString toolTip(int column) const;
  56
  57     BufferItem *findBufferItem(BufferId bufferId);
  58     inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) { return findBufferItem(bufferInfo.bufferId()); }
  59     BufferItem *bufferItem(const BufferInfo &bufferInfo);
  60     inline StatusBufferItem *statusBufferItem() const { return _statusBufferItem; }
  61
  62 public slots:
  63     void setNetworkName(const QString &networkName);
  64     void setCurrentServer(const QString &serverName);
  65
  66     void attachNetwork(Network *network);
  67     void attachIrcChannel(IrcChannel *channel);
  68     void attachIrcUser(IrcUser *ircUser);
  69
  70 signals:
  71     void networkDataChanged(int column = -1);
  72
  73 private slots:
  74     void onBeginRemoveChilds(int start, int end);
  75
  76 private:
  77     NetworkId _networkId;
  78     StatusBufferItem *_statusBufferItem;
  79
  80     QPointer<Network> _network;
  81 };
  82
  83
  84 /*****************************************
  85  *  Fancy Buffer Items
  86  *****************************************/
  87 class BufferItem : public PropertyMapItem
  88 {
  89     Q_OBJECT
  90     Q_PROPERTY(QString bufferName READ bufferName WRITE setBufferName)
  91     Q_PROPERTY(QString topic READ topic)
  92     Q_PROPERTY(int nickCount READ nickCount)
  93
  94 public :
  95         BufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent = 0);
  96
  97     inline const BufferInfo &bufferInfo() const { return _bufferInfo; }
  98     virtual QVariant data(int column, int role) const;
  99     virtual bool setData(int column, const QVariant &value, int role);
 100
 101     inline BufferId bufferId() const { return _bufferInfo.bufferId(); }
 102     inline BufferInfo::Type bufferType() const { return _bufferInfo.type(); }
 103
 104     virtual void setBufferName(const QString &name);
 105     virtual inline QString bufferName() const { return _bufferInfo.bufferName(); }
 106     virtual inline QString topic() const { return QString(); }
 107     virtual inline int nickCount() const { return 0; }
 108
 109     virtual inline bool isActive() const { return qobject_cast<NetworkItem *>(parent())->isActive(); }
 110
 111     inline MsgId lastSeenMsgId() const { return _lastSeenMsgId; }
 112     inline MsgId markerLineMsgId() const { return _markerLineMsgId; }
 113     void setLastSeenMsgId(MsgId msgId);
 114     void setMarkerLineMsgId(MsgId msgId);
 115
 116     inline BufferInfo::ActivityLevel activityLevel() const { return _activity; }
 117     void setActivityLevel(BufferInfo::ActivityLevel level);
 118     void clearActivityLevel();
 119     void updateActivityLevel(const Message &msg);
 120
 121     inline const MsgId &firstUnreadMsgId() const { return _firstUnreadMsgId; }
 122
 123     bool isCurrentBuffer() const;
 124     virtual QString toolTip(int column) const;
 125
 126 public slots:
 127     virtual inline void setTopic(const QString &) { emit dataChanged(1); }
 128     virtual inline void setEncrypted(bool) { emit dataChanged(); }
 129
 130 private:
 131     BufferInfo _bufferInfo;
 132     BufferInfo::ActivityLevel _activity;
 133     MsgId _lastSeenMsgId;
 134     MsgId _markerLineMsgId;
 135     MsgId _firstUnreadMsgId;
 136 };
 137
 138
 139 /*****************************************
 140 *  StatusBufferItem
 141 *****************************************/
 142 class StatusBufferItem : public BufferItem
 143 {
 144     Q_OBJECT
 145
 146 public:
 147     StatusBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
 148
 149     virtual QString toolTip(int column) const;
 150     virtual inline QString bufferName() const { return tr("Status Buffer"); }
 151 };
 152
 153
 154 /*****************************************
 155 *  QueryBufferItem
 156 *****************************************/
 157 class QueryBufferItem : public BufferItem
 158 {
 159     Q_OBJECT
 160
 161 public:
 162     QueryBufferItem(const BufferInfo &bufferInfo, NetworkItem *parent);
 163
 164     virtual QVariant data(int column, int role) const;
 165     virtual bool setData(int column, const QVariant &value, int role);
 166
 167     virtual inline bool isActive() const { return (bool)_ircUser; }
 168     virtual QString toolTip(int column) const;
 169
 170     virtual void setBufferName(const QString &name);
 171
 172 public slots:
 173     void setIrcUser(IrcUser *ircUser);
 174     void removeIrcUser();
 175
 176 private:
 177     IrcUser *_ircUser;
 178 };
 179
 180
 181 /*****************************************
 182 *  ChannelBufferItem
 183 *****************************************/
 184 class UserCategoryItem;
 185
 186 class ChannelBufferItem : public BufferItem
 187 {
 188     Q_OBJECT
 189
 190 public:
 191     ChannelBufferItem(const BufferInfo &bufferInfo, AbstractTreeItem *parent);
 192
 193     virtual QVariant data(int column, int role) const;
 194     virtual inline bool isActive() const { return (bool)_ircChannel; }
 195     virtual QString toolTip(int column) const;
 196
 197     virtual inline QString topic() const { return (bool)_ircChannel ? _ircChannel->topic() : QString(); }
 198     virtual inline int nickCount() const { return (bool)_ircChannel ? _ircChannel->ircUsers().count() : 0; }
 199
 200     void attachIrcChannel(IrcChannel *ircChannel);
 201
 202 public slots:
 203     void join(const QList<IrcUser *> &ircUsers);
 204     void part(IrcUser *ircUser);
 205
 206     UserCategoryItem *findCategoryItem(int categoryId);
 207     void addUserToCategory(IrcUser *ircUser);
 208     void addUsersToCategory(const QList<IrcUser *> &ircUser);
 209     void removeUserFromCategory(IrcUser *ircUser);
 210     void userModeChanged(IrcUser *ircUser);
 211
 212 private slots:
 213     void ircChannelParted();
 214
 215 private:
 216     IrcChannel *_ircChannel;
 217 };
 218
 219
 220 /*****************************************
 221 *  User Category Items (like @vh etc.)
 222 *****************************************/
 223 class IrcUserItem;
 224 class UserCategoryItem : public PropertyMapItem
 225 {
 226     Q_OBJECT
 227     Q_PROPERTY(QString categoryName READ categoryName)
 228
 229 public :
 230         UserCategoryItem(int category, AbstractTreeItem *parent);
 231
 232     QString categoryName() const;
 233     inline int categoryId() const { return _category; }
 234     virtual QVariant data(int column, int role) const;
 235
 236     IrcUserItem *findIrcUser(IrcUser *ircUser);
 237     void addUsers(const QList<IrcUser *> &ircUser);
 238     bool removeUser(IrcUser *ircUser);
 239
 240     static int categoryFromModes(const QString &modes);
 241
 242 private:
 243     int _category;
 244
 245     static const QList<QChar> categories;
 246 };
 247
 248
 249 /*****************************************
 250 *  Irc User Items
 251 *****************************************/
 252 class IrcUserItem : public PropertyMapItem
 253 {
 254     Q_OBJECT
 255     Q_PROPERTY(QString nickName READ nickName)
 256
 257 public :
 258         IrcUserItem(IrcUser *ircUser, AbstractTreeItem *parent);
 259
 260     inline QString nickName() const { return _ircUser ? _ircUser->nick() : QString(); }
 261     inline bool isActive() const { return _ircUser ? !_ircUser->isAway() : false; }
 262
 263     inline IrcUser *ircUser() { return _ircUser; }
 264     virtual QVariant data(int column, int role) const;
 265     virtual QString toolTip(int column) const;
 266
 267 private slots:
 268     inline void ircUserQuited() { parent()->removeChild(this); }
 269
 270 private:
 271     QPointer<IrcUser> _ircUser;
 272 };
 273
 274
 275 /*****************************************
 276  * NetworkModel
 277  *****************************************/
 278 class NetworkModel : public TreeModel
 279 {
 280     Q_OBJECT
 281
 282 public:
 283     enum Role {
 284         BufferTypeRole = TreeModel::UserRole,
 285         ItemActiveRole,
 286         BufferActivityRole,
 287         BufferIdRole,
 288         NetworkIdRole,
 289         BufferInfoRole,
 290         ItemTypeRole,
 291         UserAwayRole,
 292         IrcUserRole,
 293         IrcChannelRole,
 294         BufferFirstUnreadMsgIdRole,
 295         MarkerLineMsgIdRole,
 296     };
 297
 298     enum ItemType {
 299         NetworkItemType = 0x01,
 300         BufferItemType = 0x02,
 301         UserCategoryItemType = 0x04,
 302         IrcUserItemType = 0x08
 303     };
 304     Q_DECLARE_FLAGS(ItemTypes, ItemType)
 305
 306     NetworkModel(QObject *parent = 0);
 307     static QList<QVariant> defaultHeader();
 308
 309     static bool mimeContainsBufferList(const QMimeData *mimeData);
 310     static QList<QPair<NetworkId, BufferId> > mimeDataToBufferList(const QMimeData *mimeData);
 311
 312     virtual QStringList mimeTypes() const;
 313     virtual QMimeData *mimeData(const QModelIndexList &) const;
 314
 315     void attachNetwork(Network *network);
 316
 317     bool isBufferIndex(const QModelIndex &) const;
 318     //Buffer *getBufferByIndex(const QModelIndex &) const;
 319     QModelIndex networkIndex(NetworkId networkId);
 320     QModelIndex bufferIndex(BufferId bufferId);
 321
 322     const Network *networkByIndex(const QModelIndex &index) const;
 323
 324     BufferInfo::ActivityLevel bufferActivity(const BufferInfo &buffer) const;
 325
 326     //! Finds a buffer with a given name in a given network
 327     /** This performs a linear search through all BufferItems, hence it is expensive.
 328      *  @param networkId  The network which we search in
 329      *  @param bufferName The bufferName we look for
 330      *  @return The id of the buffer if found, an invalid one else
 331      */
 332     BufferId bufferId(NetworkId networkId, const QString &bufferName, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
 333
 334     QString bufferName(BufferId bufferId) const;
 335     BufferInfo::Type bufferType(BufferId bufferId) const;
 336     BufferInfo bufferInfo(BufferId bufferId) const;
 337     MsgId lastSeenMsgId(BufferId bufferId) const;
 338     MsgId markerLineMsgId(BufferId bufferId) const;
 339     NetworkId networkId(BufferId bufferId) const;
 340     QString networkName(BufferId bufferId) const;
 341
 342     inline QList<BufferId> allBufferIds() const { return _bufferItemCache.keys(); }
 343     QList<BufferId> allBufferIdsSorted() const;
 344     void sortBufferIds(QList<BufferId> &bufferIds) const;
 345
 346 public slots:
 347     void bufferUpdated(BufferInfo bufferInfo);
 348     void removeBuffer(BufferId bufferId);
 349     MsgId lastSeenMsgId(const BufferId &bufferId);
 350     void setLastSeenMsgId(const BufferId &bufferId, const MsgId &msgId);
 351     void setMarkerLineMsgId(const BufferId &bufferId, const MsgId &msgId);
 352     void setBufferActivity(const BufferId &bufferId, BufferInfo::ActivityLevel activity);
 353     void clearBufferActivity(const BufferId &bufferId);
 354     void updateBufferActivity(Message &msg);
 355     void networkRemoved(const NetworkId &networkId);
 356
 357 signals:
 358     void requestSetLastSeenMsg(BufferId buffer, MsgId msg);
 359     void lastSeenMsgSet(BufferId buffer, MsgId msg);
 360     void markerLineSet(BufferId buffer, MsgId msg);
 361
 362 private slots:
 363     void checkForRemovedBuffers(const QModelIndex &parent, int start, int end);
 364     void checkForNewBuffers(const QModelIndex &parent, int start, int end);
 365     void messageRedirectionSettingsChanged();
 366
 367 private:
 368     int networkRow(NetworkId networkId) const;
 369     NetworkItem *findNetworkItem(NetworkId networkId) const;
 370     NetworkItem *networkItem(NetworkId networkId);
 371     inline BufferItem *findBufferItem(const BufferInfo &bufferInfo) const { return findBufferItem(bufferInfo.bufferId()); }
 372     BufferItem *findBufferItem(BufferId bufferId) const;
 373     BufferItem *bufferItem(const BufferInfo &bufferInfo);
 374
 375     void updateBufferActivity(BufferItem *bufferItem, const Message &msg);
 376
 377     static bool bufferItemLessThan(const BufferItem *left, const BufferItem *right);
 378
 379     QHash<BufferId, BufferItem *> _bufferItemCache;
 380
 381     int _userNoticesTarget;
 382     int _serverNoticesTarget;
 383     int _errorMsgsTarget;
 384 };
 385
 386
 387 Q_DECLARE_OPERATORS_FOR_FLAGS(NetworkModel::ItemTypes)
 388
 389 #endif // NETWORKMODEL_H