src/client/networkmodel.h

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