settings: Unify ChatMonitor defaults
[quassel.git] / src / qtui / chatmonitorfilter.cpp
index e51b2cd..45cc6c0 100644 (file)
@@ -1,22 +1,22 @@
 /***************************************************************************
-*   Copyright (C) 2005-08 by the Quassel Project                          *
-*   devel@quassel-irc.org                                                 *
-*                                                                         *
-*   This program is free software; you can redistribute it and/or modify  *
-*   it under the terms of the GNU General Public License as published by  *
-*   the Free Software Foundation; either version 2 of the License, or     *
-*   (at your option) version 3.                                           *
-*                                                                         *
-*   This program is distributed in the hope that it will be useful,       *
-*   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
-*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
-*   GNU General Public License for more details.                          *
-*                                                                         *
-*   You should have received a copy of the GNU General Public License     *
-*   along with this program; if not, write to the                         *
-*   Free Software Foundation, Inc.,                                       *
-*   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
-***************************************************************************/
+ *   Copyright (C) 2005-2018 by the Quassel Project                        *
+ *   devel@quassel-irc.org                                                 *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) version 3.                                           *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
+ ***************************************************************************/
 
 #include "chatmonitorfilter.h"
 
 #include "chatlinemodel.h"
 #include "networkmodel.h"
 #include "chatviewsettings.h"
+#include "clientignorelistmanager.h"
 
 ChatMonitorFilter::ChatMonitorFilter(MessageModel *model, QObject *parent)
-  : MessageFilter(model, parent)
+    : MessageFilter(model, parent)
 {
-  ChatViewSettings viewSettings(idString());
-  _showFields = viewSettings.value("showFields", AllFields).toInt();
-  _showOwnMessages = viewSettings.value("showOwnMsgs", true).toBool();
-  viewSettings.notify("showFields", this, SLOT(showFieldsSettingsChanged(const QVariant &)));
-  viewSettings.notify("showOwnMsgs", this, SLOT(showOwnMessagesSettingChanged(const QVariant &)));
-
-  // ChatMonitorSettingsPage
-  QString highlightAlwaysSettingsId = "HighlightAlways";
-  QString operationModeSettingsId = "OperationMode";
-  QString buffersSettingsId = "Buffers";
-
-  _highlightAlways = viewSettings.value(highlightAlwaysSettingsId, false).toBool();
-  _operationMode = viewSettings.value(operationModeSettingsId, 0).toInt();
-  // read configured list of buffers to monitor/ignore
-  foreach(QVariant v, viewSettings.value(buffersSettingsId, QVariant()).toList())
+    // Global configuration
+    ChatViewSettings defaultSettings;
+    _showSenderBrackets = defaultSettings.showSenderBrackets();
+    defaultSettings.notify("ShowSenderBrackets", this, SLOT(showSenderBracketsSettingChanged(const QVariant &)));
+
+    // NOTE: Whenever changing defaults here, also update ChatMonitorSettingsPage::loadSettings()
+    // and ChatMonitorSettingsPage::defaults() to match
+
+    // Chat Monitor specific configuration
+    ChatViewSettings viewSettings(idString());
+    _showFields = viewSettings.value("ShowFields", AllFields).toInt();
+    _showOwnMessages = viewSettings.value("ShowOwnMsgs", true).toBool();
+    viewSettings.notify("ShowFields", this, SLOT(showFieldsSettingChanged(const QVariant &)));
+    viewSettings.notify("ShowOwnMsgs", this, SLOT(showOwnMessagesSettingChanged(const QVariant &)));
+
+    // ChatMonitorSettingsPage
+    QString showHighlightsSettingsId = "ShowHighlights";
+    QString operationModeSettingsId = "OperationMode";
+    QString buffersSettingsId = "Buffers";
+    QString showBacklogSettingsId = "ShowBacklog";
+    QString includeReadSettingsId = "IncludeRead";
+    QString alwaysOwnSettingsId = "AlwaysOwn";
+
+    _showHighlights = viewSettings.value(showHighlightsSettingsId, false).toBool();
+    _operationMode =
+            viewSettings.value(operationModeSettingsId, ChatViewSettings::InvalidMode).toInt();
+    // read configured list of buffers to monitor/ignore
+    foreach(QVariant v, viewSettings.value(buffersSettingsId, QVariant()).toList())
     _bufferIds << v.value<BufferId>();
+    _showBacklog = viewSettings.value(showBacklogSettingsId, true).toBool();
+    _includeRead = viewSettings.value(includeReadSettingsId, false).toBool();
+    _alwaysOwn = viewSettings.value(alwaysOwnSettingsId, false).toBool();
+
+    viewSettings.notify(showHighlightsSettingsId, this, SLOT(showHighlightsSettingChanged(const QVariant &)));
+    viewSettings.notify(operationModeSettingsId, this, SLOT(operationModeSettingChanged(const QVariant &)));
+    viewSettings.notify(buffersSettingsId, this, SLOT(buffersSettingChanged(const QVariant &)));
+    viewSettings.notify(showBacklogSettingsId, this, SLOT(showBacklogSettingChanged(const QVariant &)));
+    viewSettings.notify(includeReadSettingsId, this, SLOT(includeReadSettingChanged(const QVariant &)));
+    viewSettings.notify(alwaysOwnSettingsId, this, SLOT(alwaysOwnSettingChanged(const QVariant &)));
+}
+
 
-  viewSettings.notify(highlightAlwaysSettingsId, this, SLOT(highlightAlwaysSettingsChanged(const QVariant &)));
-  viewSettings.notify(operationModeSettingsId, this, SLOT(operationModeSettingsChanged(const QVariant &)));
-  viewSettings.notify(buffersSettingsId, this, SLOT(buffersSettingsChanged(const QVariant &)));
+bool ChatMonitorFilter::filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const
+{
+    Q_UNUSED(sourceParent)
+
+    QModelIndex source_index = sourceModel()->index(sourceRow, 0);
+    BufferId bufferId = source_index.data(MessageModel::BufferIdRole).value<BufferId>();
+    Message::Flags flags = (Message::Flags)source_index.data(MessageModel::FlagsRole).toInt();
+
+    if (flags & Message::Backlog) {
+        if (!_showBacklog)
+            return false;
+
+        if (!_includeRead && Client::networkModel()->lastSeenMsgId(bufferId) >= sourceModel()->data(source_index, MessageModel::MsgIdRole).value<MsgId>())
+            return false;
+    }
+
+    if (!_showOwnMessages && flags & Message::Self)
+        return false;
+
+    Message::Type type = (Message::Type)source_index.data(MessageModel::TypeRole).toInt();
+    if (!(type & (Message::Plain | Message::Notice | Message::Action)))
+        return false;
+
+    // ChatMonitorSettingsPage
+    if (_showHighlights && flags & Message::Highlight)
+        ; // pass
+    else if (_alwaysOwn && flags & Message::Self)
+        ; // pass
+    else if (_operationMode == ChatViewSettings::OptOut && _bufferIds.contains(bufferId))
+        return false;
+    else if (_operationMode == ChatViewSettings::OptIn && !_bufferIds.contains(bufferId))
+        return false;
+
+    // ignorelist handling
+    // only match if message is not flagged as server msg
+    if (!(flags & Message::ServerMsg) && Client::ignoreListManager()
+        && Client::ignoreListManager()->match(source_index.data(MessageModel::MessageRole).value<Message>(), Client::networkModel()->networkName(bufferId)))
+        return false;
+
+    return true;
 }
 
-bool ChatMonitorFilter::filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const {
-  Q_UNUSED(sourceParent)
 
-  Message::Flags flags = (Message::Flags)sourceModel()->data(sourceModel()->index(sourceRow, 0), MessageModel::FlagsRole).toInt();
-  if(flags & Message::Backlog || (!_showOwnMessages && flags & Message::Self))
-    return false;
+// override this to inject display of network and channel
+QVariant ChatMonitorFilter::data(const QModelIndex &index, int role) const
+{
+    if (index.column() != ChatLineModel::SenderColumn || role != ChatLineModel::DisplayRole)
+        return MessageFilter::data(index, role);
+
+    BufferId bufid = data(index, ChatLineModel::BufferIdRole).value<BufferId>();
+    if (!bufid.isValid()) {
+        qDebug() << "ChatMonitorFilter::data(): chatline belongs to an invalid buffer!";
+        return QVariant();
+    }
+
+    QModelIndex source_index = mapToSource(index);
+
+    QStringList fields;
+    if (_showFields & NetworkField) {
+        fields << Client::networkModel()->networkName(bufid);
+    }
+    if (_showFields & BufferField) {
+        fields << Client::networkModel()->bufferName(bufid);
+    }
+
+    Message::Type messageType = (Message::Type)source_index.data(MessageModel::TypeRole).toInt();
+    if (messageType & (Message::Plain | Message::Notice)) {
+        QString sender = MessageFilter::data(index, ChatLineModel::EditRole).toString();
+        fields << sender;
+    }
+    if (_showSenderBrackets)
+        return QString("<%1>").arg(fields.join(":"));
+    else
+        return QString("%1").arg(fields.join(":"));
+}
 
-  Message::Type type = (Message::Type)sourceModel()->data(sourceModel()->index(sourceRow, 0), MessageModel::TypeRole).toInt();
-  if(!(type & (Message::Plain | Message::Notice | Message::Action)))
-    return false;
 
-  // ChatMonitorSettingsPage
-  if (_operationMode == ChatViewSettings::OptOut && !(_highlightAlways && flags & Message::Highlight) &&  _bufferIds.contains(sourceModel()->data(sourceModel()->index(sourceRow, 0), MessageModel::BufferIdRole).value<BufferId>()))
-    return false;
-  if (_operationMode == ChatViewSettings::OptIn && !(_highlightAlways && flags & Message::Highlight) && !_bufferIds.contains(sourceModel()->data(sourceModel()->index(sourceRow, 0), MessageModel::BufferIdRole).value<BufferId>()))
-    return false;
+void ChatMonitorFilter::addShowField(int field)
+{
+    if (_showFields & field)
+        return;
 
-  return true;
+    ChatViewSettings(idString()).setValue("ShowFields", _showFields | field);
 }
 
-// override this to inject display of network and channel
-QVariant ChatMonitorFilter::data(const QModelIndex &index, int role) const {
-  if(index.column() != ChatLineModel::SenderColumn || role != ChatLineModel::DisplayRole)
-    return MessageFilter::data(index, role);
-
-  BufferId bufid = data(index, ChatLineModel::BufferIdRole).value<BufferId>();
-  if(!bufid.isValid()) {
-    qDebug() << "ChatMonitorFilter::data(): chatline belongs to an invalid buffer!";
-    return QVariant();
-  }
-
-  QModelIndex source_index = mapToSource(index);
-
-  QStringList fields;
-  if(_showFields & NetworkField) {
-    fields << Client::networkModel()->networkName(bufid);
-  }
-  if(_showFields & BufferField) {
-    fields << Client::networkModel()->bufferName(bufid);
-  }
-
-  Message::Type messageType = (Message::Type)sourceModel()->data(source_index, MessageModel::TypeRole).toInt();
-  if(messageType & (Message::Plain | Message::Notice)) {
-    QString sender = MessageFilter::data(index, ChatLineModel::EditRole).toString();
-    fields << sender;
-  }
-  return QString("<%1>").arg(fields.join(":"));
+
+void ChatMonitorFilter::removeShowField(int field)
+{
+    if (!(_showFields & field))
+        return;
+
+    ChatViewSettings(idString()).setValue("ShowFields", _showFields ^ field);
 }
 
-void ChatMonitorFilter::addShowField(int field) {
-  if(_showFields & field)
-    return;
 
-  ChatViewSettings(idString()).setValue("showFields", _showFields | field); 
+void ChatMonitorFilter::setShowOwnMessages(bool show)
+{
+    if (_showOwnMessages == show)
+        return;
+
+    ChatViewSettings(idString()).setValue("ShowOwnMsgs", show);
 }
 
-void ChatMonitorFilter::removeShowField(int field) {
-  if(!(_showFields & field))
-    return;
 
-  ChatViewSettings(idString()).setValue("showFields", _showFields ^ field);
+void ChatMonitorFilter::showFieldsSettingChanged(const QVariant &newValue)
+{
+    int newFields = newValue.toInt();
+    if (_showFields == newFields)
+        return;
+
+    _showFields = newFields;
+
+    int rows = rowCount();
+    if (rows == 0)
+        return;
+
+    emit dataChanged(index(0, ChatLineModel::SenderColumn), index(rows - 1, ChatLineModel::SenderColumn));
 }
 
-void ChatMonitorFilter::setShowOwnMessages(bool show) {
-  if(_showOwnMessages == show)
-    return;
 
-  ChatViewSettings(idString()).setValue("showOwnMsgs", show);
+void ChatMonitorFilter::showOwnMessagesSettingChanged(const QVariant &newValue)
+{
+    _showOwnMessages = newValue.toBool();
 }
 
-void ChatMonitorFilter::showFieldsSettingsChanged(const QVariant &newValue) {
-  int newFields = newValue.toInt();
-  if(_showFields == newFields)
-    return;
+void ChatMonitorFilter::alwaysOwnSettingChanged(const QVariant &newValue) {
+    _alwaysOwn = newValue.toBool();
+}
 
-  _showFields = newFields;
-  
-  int rows = rowCount();
-  if(rows == 0)
-    return;
+void ChatMonitorFilter::showHighlightsSettingChanged(const QVariant &newValue)
+{
+    _showHighlights = newValue.toBool();
+}
 
-  emit dataChanged(index(0, ChatLineModel::SenderColumn), index(rows - 1, ChatLineModel::SenderColumn));
+
+void ChatMonitorFilter::operationModeSettingChanged(const QVariant &newValue)
+{
+    _operationMode = newValue.toInt();
 }
 
-void ChatMonitorFilter::showOwnMessagesSettingChanged(const QVariant &newValue) {
-  _showOwnMessages = newValue.toBool();
+
+void ChatMonitorFilter::buffersSettingChanged(const QVariant &newValue)
+{
+    _bufferIds.clear();
+    foreach(QVariant v, newValue.toList()) {
+        _bufferIds << v.value<BufferId>();
+    }
+    invalidateFilter();
 }
 
-void ChatMonitorFilter::highlightAlwaysSettingsChanged(const QVariant &newValue) {
-  _highlightAlways = newValue.toBool();
+void ChatMonitorFilter::showBacklogSettingChanged(const QVariant &newValue) {
+    _showBacklog = newValue.toBool();
 }
 
-void ChatMonitorFilter::operationModeSettingsChanged(const QVariant &newValue) {
-  _operationMode = newValue.toInt();
+void ChatMonitorFilter::includeReadSettingChanged(const QVariant &newValue) {
+    _includeRead = newValue.toBool();
 }
 
-void ChatMonitorFilter::buffersSettingsChanged(const QVariant &newValue) {
-  _bufferIds.clear();
-  foreach (QVariant v, newValue.toList()) {
-    _bufferIds << v.value<BufferId>();
-  }
+void ChatMonitorFilter::showSenderBracketsSettingChanged(const QVariant &newValue)
+{
+    _showSenderBrackets = newValue.toBool();
 }