common: Empty highlight name matches all messages
[quassel.git] / src / common / highlightrulemanager.cpp
index 9f780f5..ff60df6 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2016 by the Quassel Project                        *
+ *   Copyright (C) 2005-2018 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  ***************************************************************************/
 
 #include "highlightrulemanager.h"
-#include "util.h"
 
-#include <QtCore>
 #include <QDebug>
-#include <QStringList>
+
+#include "util.h"
 
 INIT_SYNCABLE_OBJECT(HighlightRuleManager)
+
 HighlightRuleManager &HighlightRuleManager::operator=(const HighlightRuleManager &other)
 {
     if (this == &other)
@@ -33,41 +33,65 @@ HighlightRuleManager &HighlightRuleManager::operator=(const HighlightRuleManager
 
     SyncableObject::operator=(other);
     _highlightRuleList = other._highlightRuleList;
+    _nicksCaseSensitive = other._nicksCaseSensitive;
+    _highlightNick = other._highlightNick;
     return *this;
 }
 
 
-int HighlightRuleManager::indexOf(const QString &name) const
+int HighlightRuleManager::indexOf(int id) const
 {
     for (int i = 0; i < _highlightRuleList.count(); i++) {
-        if (_highlightRuleList[i].name == name)
+        if (_highlightRuleList[i].id == id)
             return i;
     }
     return -1;
 }
 
 
+int HighlightRuleManager::nextId()
+{
+    int max = 0;
+    for (int i = 0; i < _highlightRuleList.count(); i++) {
+        int id = _highlightRuleList[i].id;
+        if (id > max) {
+            max = id;
+        }
+    }
+    return max + 1;
+}
+
+
 QVariantMap HighlightRuleManager::initHighlightRuleList() const
 {
+    QVariantList id;
     QVariantMap highlightRuleListMap;
     QStringList name;
     QVariantList isRegEx;
     QVariantList isCaseSensitive;
     QVariantList isActive;
+    QVariantList isInverse;
+    QStringList sender;
     QStringList channel;
 
     for (int i = 0; i < _highlightRuleList.count(); i++) {
+        id << _highlightRuleList[i].id;
         name << _highlightRuleList[i].name;
         isRegEx << _highlightRuleList[i].isRegEx;
         isCaseSensitive << _highlightRuleList[i].isCaseSensitive;
         isActive << _highlightRuleList[i].isEnabled;
+        isInverse << _highlightRuleList[i].isInverse;
+        sender << _highlightRuleList[i].sender;
         channel << _highlightRuleList[i].chanName;
     }
 
+    highlightRuleListMap["id"] = id;
     highlightRuleListMap["name"] = name;
     highlightRuleListMap["isRegEx"] = isRegEx;
     highlightRuleListMap["isCaseSensitive"] = isCaseSensitive;
     highlightRuleListMap["isEnabled"] = isActive;
+    highlightRuleListMap["isInverse"] = isInverse;
+    highlightRuleListMap["sender"] = sender;
     highlightRuleListMap["channel"] = channel;
     return highlightRuleListMap;
 }
@@ -75,46 +99,111 @@ QVariantMap HighlightRuleManager::initHighlightRuleList() const
 
 void HighlightRuleManager::initSetHighlightRuleList(const QVariantMap &highlightRuleList)
 {
+    QVariantList id = highlightRuleList["id"].toList();
     QStringList name = highlightRuleList["name"].toStringList();
     QVariantList isRegEx = highlightRuleList["isRegEx"].toList();
     QVariantList isCaseSensitive = highlightRuleList["isCaseSensitive"].toList();
     QVariantList isActive = highlightRuleList["isEnabled"].toList();
+    QVariantList isInverse = highlightRuleList["isInverse"].toList();
+    QStringList sender = highlightRuleList["sender"].toStringList();
     QStringList channel = highlightRuleList["channel"].toStringList();
 
-    int count = name.count();
-    if (count != isRegEx.count() || count != isCaseSensitive.count() ||
-        count != isActive.count() || count != channel.count()) {
+    int count = id.count();
+    if (count != name.count() || count != isRegEx.count() || count != isCaseSensitive.count() ||
+        count != isActive.count() || count != isInverse.count() || count != sender.count() ||
+        count != channel.count()) {
         qWarning() << "Corrupted HighlightRuleList settings! (Count mismatch)";
         return;
     }
 
     _highlightRuleList.clear();
     for (int i = 0; i < name.count(); i++) {
-        _highlightRuleList << HighlightRule(name[i], isRegEx[i].toBool(), isCaseSensitive[i].toBool(),
-                                            isActive[i].toBool(), channel[i]);
+        _highlightRuleList << HighlightRule(id[i].toInt(), name[i], isRegEx[i].toBool(), isCaseSensitive[i].toBool(),
+                                            isActive[i].toBool(), isInverse[i].toBool(), sender[i], channel[i]);
     }
 }
 
-void HighlightRuleManager::addHighlightRule(const QString &name, bool isRegEx, bool isCaseSensitive, bool isActive,
+
+void HighlightRuleManager::addHighlightRule(int id, const QString &name, bool isRegEx, bool isCaseSensitive,
+                                            bool isActive, bool isInverse, const QString &sender,
                                             const QString &channel)
 {
-    if (contains(name)) {
+    if (contains(id)) {
         return;
     }
 
-    HighlightRule newItem = HighlightRule(name, isRegEx, isCaseSensitive, isActive, channel);
+    HighlightRule newItem = HighlightRule(id, name, isRegEx, isCaseSensitive, isActive, isInverse, sender, channel);
     _highlightRuleList << newItem;
 
-    SYNC(ARG(name), ARG(isRegEx), ARG(isCaseSensitive), ARG(isActive), ARG(channel))
+    SYNC(ARG(id), ARG(name), ARG(isRegEx), ARG(isCaseSensitive), ARG(isActive), ARG(isInverse), ARG(sender),
+         ARG(channel))
 }
 
 
-bool HighlightRuleManager::_match(const QString &msgContents, const QString &msgSender, Message::Type msgType, Message::Flags msgFlags, const QString &bufferName, const QString &currentNick, const QStringList identityNicks)
+bool HighlightRuleManager::match(const QString &msgContents,
+                                 const QString &msgSender,
+                                 Message::Type msgType,
+                                 Message::Flags msgFlags,
+                                 const QString &bufferName,
+                                 const QString &currentNick,
+                                 const QStringList identityNicks)
 {
     if (!((msgType & (Message::Plain | Message::Notice | Message::Action)) && !(msgFlags & Message::Self))) {
        return false;
     }
 
+    bool matches = false;
+
+    for (int i = 0; i < _highlightRuleList.count(); i++) {
+        const HighlightRule &rule = _highlightRuleList.at(i);
+        if (!rule.isEnabled)
+            continue;
+
+        if (!rule.chanName.isEmpty()
+                && !scopeMatch(bufferName, rule.chanName, rule.isRegEx, rule.isCaseSensitive)) {
+            // A channel name rule is specified and does NOT match the current buffer name, skip
+            // this rule
+            continue;
+        }
+
+        bool nameMatch = false;
+        if (rule.name.isEmpty()) {
+            // Empty rule, matches any message
+            nameMatch = true;
+        } else {
+            // Check according to specified rule
+            QRegExp rx;
+            if (rule.isRegEx) {
+                rx = QRegExp(rule.name,
+                             rule.isCaseSensitive ? Qt::CaseSensitive : Qt::CaseInsensitive);
+            } else {
+                rx = QRegExp("(^|\\W)" + QRegExp::escape(rule.name) + "(\\W|$)",
+                             rule.isCaseSensitive ? Qt::CaseSensitive : Qt::CaseInsensitive);
+            }
+            nameMatch = (rx.indexIn(stripFormatCodes(msgContents)) >= 0);
+        }
+
+        bool senderMatch;
+        if (rule.sender.isEmpty()) {
+            senderMatch = true;
+        } else {
+            // A sender name rule is specified, match according to scope rules.
+            senderMatch = scopeMatch(msgSender, rule.sender, rule.isRegEx, rule.isCaseSensitive);
+        }
+
+        if (nameMatch && senderMatch) {
+            // If an inverse rule matches, then we know that we never want to return a highlight.
+            if (rule.isInverse) {
+                return false;
+            } else {
+                matches = true;
+            }
+        }
+    }
+
+    if (matches)
+        return true;
+
     if (!currentNick.isEmpty()) {
         QStringList nickList;
         if (_highlightNick == CurrentNick) {
@@ -125,40 +214,10 @@ bool HighlightRuleManager::_match(const QString &msgContents, const QString &msg
             if (!nickList.contains(currentNick))
                 nickList.prepend(currentNick);
         }
-            foreach(QString nickname, nickList) {
-                QRegExp nickRegExp("(^|\\W)" + QRegExp::escape(nickname) + "(\\W|$)", _nicksCaseSensitive ? Qt::CaseSensitive : Qt::CaseInsensitive);
-                if (nickRegExp.indexIn(stripFormatCodes(msgContents)) >= 0) {
-                    return true;
-                }
-            }
-
-        for (int i = 0; i < _highlightRuleList.count(); i++) {
-            const HighlightRule &rule = _highlightRuleList.at(i);
-            if (!rule.isEnabled)
-                continue;
-
-            if (rule.chanName.size() > 0 && rule.chanName.compare(".*") != 0) {
-                if (rule.chanName.startsWith("!")) {
-                    QRegExp rx(rule.chanName.mid(1), Qt::CaseInsensitive);
-                    if (rx.exactMatch(bufferName))
-                        continue;
-                }
-                else {
-                    QRegExp rx(rule.chanName, Qt::CaseInsensitive);
-                    if (!rx.exactMatch(bufferName))
-                        continue;
-                }
-            }
 
-            QRegExp rx;
-            if (rule.isRegEx) {
-                rx = QRegExp(rule.name, rule.isCaseSensitive ? Qt::CaseSensitive : Qt::CaseInsensitive);
-            }
-            else {
-                rx = QRegExp("(^|\\W)" + QRegExp::escape(rule.name) + "(\\W|$)", rule.isCaseSensitive ? Qt::CaseSensitive : Qt::CaseInsensitive);
-            }
-            bool match = (rx.indexIn(stripFormatCodes(msgContents)) >= 0);
-            if (match) {
+        for(const QString &nickname : nickList) {
+            QRegExp nickRegExp("(^|\\W)" + QRegExp::escape(nickname) + "(\\W|$)", _nicksCaseSensitive ? Qt::CaseSensitive : Qt::CaseInsensitive);
+            if (nickRegExp.indexIn(stripFormatCodes(msgContents)) >= 0) {
                 return true;
             }
         }
@@ -167,14 +226,15 @@ bool HighlightRuleManager::_match(const QString &msgContents, const QString &msg
     return false;
 }
 
-void HighlightRuleManager::removeHighlightRule(const QString &highlightRule)
+
+void HighlightRuleManager::removeHighlightRule(int highlightRule)
 {
     removeAt(indexOf(highlightRule));
     SYNC(ARG(highlightRule))
 }
 
 
-void HighlightRuleManager::toggleHighlightRule(const QString &highlightRule)
+void HighlightRuleManager::toggleHighlightRule(int highlightRule)
 {
     int idx = indexOf(highlightRule);
     if (idx == -1)
@@ -182,3 +242,9 @@ void HighlightRuleManager::toggleHighlightRule(const QString &highlightRule)
     _highlightRuleList[idx].isEnabled = !_highlightRuleList[idx].isEnabled;
     SYNC(ARG(highlightRule))
 }
+
+
+bool HighlightRuleManager::match(const Message &msg, const QString &currentNick, const QStringList &identityNicks)
+{
+    return match(msg.contents(), msg.sender(), msg.type(), msg.flags(), msg.bufferInfo().bufferName(), currentNick, identityNicks);
+}