Filter joins/parts/quits instead of just hiding them

ListView has troubles handling lots of hidden/collapsed items, so let's
make it easier for ListView and filter out the events from the model.
Furthermore, MessageFilter implements a bit smarter filtering ie. only
join/part/quit message types are filtered out, unless they are our own.

Author: jpnurmi

src/main.cpp

@@ -41,6 +41,7 @@
 #include "networksession.h"
 #include "messagestorage.h"
 #include "messageformatter.h"
+#include "messagefilter.h"
 
 #include <IrcCore>
 #include <IrcModel>
@@ -87,6 +88,9 @@ Q_DECL_EXPORT int main(int argc, char* argv[])
     qmlRegisterType<QQmlSettings>("Qt.labs.settings", 1, 0, "Settings");
 #endif
 
+    qRegisterMetaType<QAbstractItemModel*>();
+    qmlRegisterType<MessageFilter>("Communi", 3, 1, "MessageFilter");
+
     NetworkSession* session = new NetworkSession(app.data());
     viewer->rootContext()->setContextProperty("NetworkSession", session);
 

src/messagefilter.cpp

@@ -0,0 +1,66 @@
+/*
+  Copyright (C) 2013-2014 The Communi Project
+
+  You may use this file under the terms of BSD license as follows:
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Communi Project nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR
+  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#include "messagefilter.h"
+#include "messagerole.h"
+#include <IrcMessage>
+
+MessageFilter::MessageFilter(QObject* parent) : QSortFilterProxyModel(parent), m_events(true)
+{
+    setDynamicSortFilter(true);
+}
+
+bool MessageFilter::showEvents() const
+{
+    return m_events;
+}
+
+void MessageFilter::setShowEvents(bool show)
+{
+    if (m_events != show) {
+        m_events = show;
+        emit showEventsChanged();
+        invalidateFilter();
+    }
+}
+
+bool MessageFilter::filterAcceptsRow(int sourceRow, const QModelIndex& sourceParent) const
+{
+    if (!m_events) {
+        const QModelIndex index = sourceModel()->index(sourceRow, 0, sourceParent);
+        switch (index.data(TypeRole).toInt()) {
+        case IrcMessage::Join:
+        case IrcMessage::Part:
+        case IrcMessage::Quit:
+            return index.data(OwnRole).toBool();
+        default:
+            return true;
+        }
+    }
+    return true;
+}

src/messagefilter.h

@@ -0,0 +1,55 @@
+/*
+  Copyright (C) 2013-2014 The Communi Project
+
+  You may use this file under the terms of BSD license as follows:
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Communi Project nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR
+  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#ifndef MESSAGEFILTER_H
+#define MESSAGEFILTER_H
+
+#include <QSortFilterProxyModel>
+
+class MessageFilter : public QSortFilterProxyModel
+{
+    Q_OBJECT
+    Q_PROPERTY(bool showEvents READ showEvents WRITE setShowEvents NOTIFY showEventsChanged)
+
+public:
+    MessageFilter(QObject* parent = 0);
+
+    bool showEvents() const;
+    void setShowEvents(bool show);
+
+signals:
+    void showEventsChanged();
+
+protected:
+    bool filterAcceptsRow(int sourceRow, const QModelIndex& sourceParent) const;
+
+private:
+    bool m_events;
+};
+
+#endif // MESSAGEFILTER_H

src/messagemodel.cpp

@@ -27,20 +27,14 @@
 */
 
 #include "messagemodel.h"
+#include "messagerole.h"
 #include "messageformatter.h"
 #include <QTextBoundaryFinder>
 #include <IrcConnection>
 #include <IrcMessage>
 #include <IrcBuffer>
 #include <QDateTime>
 
-enum DataRole {
-    SeenRole = Qt::UserRole,
-    HighlightRole,
-    TimestampRole,
-    EventRole
-};
-
 MessageModel::MessageModel(IrcBuffer* buffer) : QAbstractListModel(buffer),
     m_badge(0), m_current(false), m_visible(false), m_separator(-1),
     m_highlights(0), m_buffer(buffer), m_formatter(new MessageFormatter(this))
@@ -171,6 +165,8 @@ QHash<int, QByteArray> MessageModel::roleNames() const
     roles[TimestampRole] = "timestamp";
     roles[EventRole] = "event";
     roles[SeenRole] = "seen";
+    roles[TypeRole] = "type";
+    roles[OwnRole] = "own";
     return roles;
 }
 
@@ -187,6 +183,10 @@ QVariant MessageModel::data(const QModelIndex& index, int role) const
         return m_messages.at(row).timestamp;
     case EventRole:
         return m_messages.at(row).event;
+    case TypeRole:
+        return m_messages.at(row).type;
+    case OwnRole:
+        return m_messages.at(row).own;
     case SeenRole:
         return m_seen.at(row);
     case Qt::DisplayRole:
@@ -204,8 +204,10 @@ void MessageModel::receive(IrcMessage* message)
     data.plaintext = m_formatter->formatMessage(message, Qt::PlainText);
     if (!data.plaintext.isEmpty()) {
         data.timestamp = message->timeStamp().toString("hh:mm");
+        data.type = message->type();
+        data.own = message->flags() & IrcMessage::Own;
         data.event = (message->type() != IrcMessage::Private && message->type() != IrcMessage::Notice);
-        if (!data.event && !(message->flags() & IrcMessage::Own)) {
+        if (!data.event && !data.own) {
             int pos = 0;
             QString nick = message->connection()->nickName();
             QString content = message->property("content").toString();

src/messagemodel.h

@@ -30,11 +30,11 @@
 #define MESSAGEMODEL_H
 
 #include <QAbstractListModel>
+#include <IrcMessage>
 #include <QBitArray>
 #include <QVector>
 
 class IrcBuffer;
-class IrcMessage;
 class MessageFormatter;
 
 class MessageModel : public QAbstractListModel
@@ -96,7 +96,9 @@ private slots:
 
 private:
     struct MessageData {
-        MessageData() : event(false), hilite(false) { }
+        MessageData() : type(IrcMessage::Unknown), own(false), event(false), hilite(false) { }
+        int type;
+        bool own;
         bool event;
         bool hilite;
         QString richtext;

src/messagerole.h

@@ -0,0 +1,43 @@
+/*
+  Copyright (C) 2013-2014 The Communi Project
+
+  You may use this file under the terms of BSD license as follows:
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Communi Project nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR
+  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#ifndef MESSAGEROLE_H
+#define MESSAGEROLE_H
+
+#include <Qt>
+
+enum MessageRole {
+    SeenRole = Qt::UserRole,
+    HighlightRole,
+    TimestampRole,
+    EventRole,
+    TypeRole,
+    OwnRole
+};
+
+#endif // MESSAGEROLE_H

src/src.pri

@@ -3,14 +3,17 @@ INCLUDEPATH += $$PWD $$PWD/3rdparty
 
 HEADERS += $$PWD/activitymodel.h
 HEADERS += $$PWD/bufferproxymodel.h
+HEADERS += $$PWD/messagefilter.h
 HEADERS += $$PWD/messagemodel.h
+HEADERS += $$PWD/messagerole.h
 HEADERS += $$PWD/messagestorage.h
 HEADERS += $$PWD/networksession.h
 HEADERS += $$PWD/3rdparty/RowsJoinerProxy.h
 HEADERS += $$PWD/3rdparty/simplecrypt.h
 
 SOURCES += $$PWD/activitymodel.cpp
 SOURCES += $$PWD/bufferproxymodel.cpp
+SOURCES += $$PWD/messagefilter.cpp
 SOURCES += $$PWD/messagemodel.cpp
 SOURCES += $$PWD/messagestorage.cpp
 SOURCES += $$PWD/networksession.cpp

ui/settings/settings.qml

@@ -77,7 +77,7 @@ Page {
             TextSwitch {
                 width: parent.width
                 text: qsTrId("Show events")
-                description: qsTr("Specifies whether joins/parts/quits etc. are shown")
+                description: qsTr("Specifies whether joins/parts/quits are shown")
                 checked: eventsConfig.value
                 onCheckedChanged: eventsConfig.value = checked
             }

ui/view/BufferPage.qml

@@ -123,12 +123,13 @@ Page {
                 }
             }
 
-            model: storage
+            model: MessageFilter {
+                sourceModel: storage
+                showEvents: !!eventsConfig.value
+            }
 
             delegate: ListItem {
-                readonly property bool hidden: event && !eventsConfig.value
-                contentHeight: hidden ? 0 : label.height + (index > 0 && index < view.count - 1 && ListView.isCurrentItem ? Theme.paddingMedium : 0)
-                visible: !hidden
+                contentHeight: label.height + (index > 0 && index < view.count - 1 && ListView.isCurrentItem ? Theme.paddingMedium : 0)
                 Label {
                     id: stamp
                     text: timestamp