/***************************************************************************
-* 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-2022 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 "qtuimessageprocessor.h"
#include "messagemodel.h"
#include "network.h"
-const int progressUpdateDelay = 100; // ms between progress signal updates
-
-QtUiMessageProcessor::QtUiMessageProcessor(QObject *parent)
- : AbstractMessageProcessor(parent),
- _processing(false),
- _processMode(TimerBased),
- _msgsProcessed(0),
- _msgCount(0)
+QtUiMessageProcessor::QtUiMessageProcessor(QObject* parent)
+ : AbstractMessageProcessor(parent)
+ , _processing(false)
+ , _processMode(TimerBased)
{
- NotificationSettings notificationSettings;
- _nicksCaseSensitive = notificationSettings.nicksCaseSensitive();
- _highlightNick = notificationSettings.highlightNick();
- highlightListChanged(notificationSettings.highlightList());
- notificationSettings.notify("Highlights/NicksCaseSensitive", this, SLOT(nicksCaseSensitiveChanged(const QVariant &)));
- notificationSettings.notify("Highlights/CustomList", this, SLOT(highlightListChanged(const QVariant &)));
- notificationSettings.notify("Highlights/HighlightNick", this, SLOT(highlightNickChanged(const QVariant &)));
-
- _processTimer.setInterval(0);
- connect(&_processTimer, SIGNAL(timeout()), this, SLOT(processNextMessage()));
+ NotificationSettings notificationSettings;
+ _nicksCaseSensitive = notificationSettings.nicksCaseSensitive();
+ _nickMatcher.setCaseSensitive(_nicksCaseSensitive);
+ _highlightNick = notificationSettings.highlightNick();
+ _nickMatcher.setHighlightMode(static_cast<NickHighlightMatcher::HighlightNickType>(_highlightNick));
+ highlightListChanged(notificationSettings.highlightList());
+ notificationSettings.notify("Highlights/NicksCaseSensitive", this, &QtUiMessageProcessor::nicksCaseSensitiveChanged);
+ notificationSettings.notify("Highlights/CustomList", this, &QtUiMessageProcessor::highlightListChanged);
+ notificationSettings.notify("Highlights/HighlightNick", this, &QtUiMessageProcessor::highlightNickChanged);
+
+ _processTimer.setInterval(0);
+ connect(&_processTimer, &QTimer::timeout, this, &QtUiMessageProcessor::processNextMessage);
}
-void QtUiMessageProcessor::reset() {
- if(processMode() == TimerBased) {
- if(_processTimer.isActive()) _processTimer.stop();
- _processing = false;
- _currentBatch.clear();
- _processQueue.clear();
- }
+void QtUiMessageProcessor::reset()
+{
+ if (processMode() == TimerBased) {
+ if (_processTimer.isActive())
+ _processTimer.stop();
+ _processing = false;
+ _currentBatch.clear();
+ _processQueue.clear();
+ }
}
-void QtUiMessageProcessor::process(Message &msg) {
- checkForHighlight(msg);
- Client::messageModel()->insertMessage(msg);
- postProcess(msg);
+void QtUiMessageProcessor::process(Message& msg)
+{
+ checkForHighlight(msg);
+ preProcess(msg);
+ Client::messageModel()->insertMessage(msg);
}
-void QtUiMessageProcessor::process(QList<Message> &msgs) {
- QList<Message>::iterator msgIter = msgs.begin();
- QList<Message>::iterator msgIterEnd = msgs.end();
- while(msgIter != msgIterEnd) {
- checkForHighlight(*msgIter);
- postProcess(*msgIter);
- msgIter++;
- }
- Client::messageModel()->insertMessages(msgs);
- return;
-
-
- if(msgs.isEmpty()) return;
- _processQueue.append(msgs);
- _msgCount += msgs.count();
- if(!isProcessing()) startProcessing();
- else updateProgress();
-}
+void QtUiMessageProcessor::process(QList<Message>& msgs)
+{
+ QList<Message>::iterator msgIter = msgs.begin();
+ QList<Message>::iterator msgIterEnd = msgs.end();
+ while (msgIter != msgIterEnd) {
+ checkForHighlight(*msgIter);
+ preProcess(*msgIter);
+ ++msgIter;
+ }
+ Client::messageModel()->insertMessages(msgs);
+ return;
-void QtUiMessageProcessor::startProcessing() {
- if(processMode() == TimerBased) {
- if(_currentBatch.isEmpty() && _processQueue.isEmpty()) return;
- _processing = true;
- _msgsProcessed = 0;
- _msgCount = _currentBatch.count();
- foreach(QList<Message> msglist, _processQueue) _msgCount += msglist.count();
- updateProgress();
- if(!_processTimer.isActive()) _processTimer.start();
- }
+ if (msgs.isEmpty())
+ return;
+ _processQueue.append(msgs);
+ if (!isProcessing())
+ startProcessing();
}
-void QtUiMessageProcessor::processNextMessage() {
- if(_currentBatch.isEmpty()) {
- if(_processQueue.isEmpty()) {
- _processTimer.stop();
- _processing = false;
- _msgsProcessed = _msgCount = 0;
- updateProgress();
- return;
+void QtUiMessageProcessor::startProcessing()
+{
+ if (processMode() == TimerBased) {
+ if (_currentBatch.isEmpty() && _processQueue.isEmpty())
+ return;
+ _processing = true;
+ if (!_processTimer.isActive())
+ _processTimer.start();
}
- _currentBatch = _processQueue.takeFirst();
- }
- Message msg = _currentBatch.takeFirst();
- process(msg);
- _msgsProcessed++;
- updateProgress();
}
-void QtUiMessageProcessor::updateProgress(bool start) {
- if(start) {
- _progressTimer.start();
- emit progressUpdated(_msgsProcessed, _msgCount);
- } else {
- if(_msgCount == 0 || _progressTimer.elapsed() >= progressUpdateDelay) {
- _progressTimer.restart();
- emit progressUpdated(_msgsProcessed, _msgCount);
+void QtUiMessageProcessor::processNextMessage()
+{
+ if (_currentBatch.isEmpty()) {
+ if (_processQueue.isEmpty()) {
+ _processTimer.stop();
+ _processing = false;
+ return;
+ }
+ _currentBatch = _processQueue.takeFirst();
}
- }
+ Message msg = _currentBatch.takeFirst();
+ process(msg);
}
-void QtUiMessageProcessor::checkForHighlight(Message &msg) {
- if(!((msg.type() & (Message::Plain | Message::Notice | Message::Action)) && !(msg.flags() & Message::Self)))
- return;
-
- // TODO: Cache this (per network)
- const Network *net = Client::network(msg.bufferInfo().networkId());
- if(net && !net->myNick().isEmpty()) {
- QStringList nickList;
- if(_highlightNick == NotificationSettings::CurrentNick) {
- nickList << net->myNick();
- } else if(_highlightNick == NotificationSettings::AllNicks) {
- const Identity *myIdentity = Client::identity(net->identity());
- if(myIdentity)
- nickList = myIdentity->nicks();
- }
- foreach(QString nickname, nickList) {
- QRegExp nickRegExp("\\b" + QRegExp::escape(nickname) + "\\b",
- _nicksCaseSensitive ? Qt::CaseSensitive : Qt::CaseInsensitive);
- if(nickRegExp.indexIn(msg.contents()) >= 0) {
- msg.setFlags(msg.flags() | Message::Highlight);
+void QtUiMessageProcessor::checkForHighlight(Message& msg)
+{
+ if (!((msg.type() & (Message::Plain | Message::Notice | Message::Action)) && !(msg.flags() & Message::Self)))
return;
- }
+
+ // Cached per network
+ const NetworkId& netId = msg.bufferInfo().networkId();
+ const Network* net = Client::network(netId);
+
+ if (net && !net->myNick().isEmpty()) {
+ // Get current nick
+ QString currentNick = net->myNick();
+ // Get identity nicks
+ QStringList identityNicks = {};
+ const Identity* myIdentity = Client::identity(net->identity());
+ if (myIdentity) {
+ identityNicks = myIdentity->nicks();
+ }
+
+ // Get buffer name, message contents
+ QString bufferName = msg.bufferInfo().bufferName();
+ QString msgContents = msg.contents();
+ bool matches = false;
+
+ for (int i = 0; i < _highlightRuleList.count(); i++) {
+ auto& rule = _highlightRuleList.at(i);
+ if (!rule.isEnabled())
+ continue;
+
+ // Skip if channel name doesn't match and channel rule is not empty
+ //
+ // Match succeeds if...
+ // Channel name matches a defined rule
+ // Defined rule is empty
+ // And take the inverse of the above
+ if (!rule.chanNameMatcher().match(bufferName, true)) {
+ // A channel name rule is specified and does NOT match the current buffer name, skip
+ // this rule
+ continue;
+ }
+
+ // Check message according to specified rule, allowing empty rules to match
+ bool contentsMatch = rule.contentsMatcher().match(stripFormatCodes(msgContents), true);
+
+ // Support for sender matching can be added here
+
+ if (contentsMatch) {
+ // Support for inverse rules can be added here
+ matches = true;
+ }
+ }
+
+ if (matches) {
+ msg.setFlags(msg.flags() | Message::Highlight);
+ return;
+ }
+
+ // Check nicknames
+ if (_highlightNick != HighlightNickType::NoNick && !currentNick.isEmpty()) {
+ // Nickname matching allowed and current nickname is known
+ // Run the nickname matcher on the unformatted string
+ if (_nickMatcher.match(stripFormatCodes(msgContents), netId, currentNick, identityNicks)) {
+ msg.setFlags(msg.flags() | Message::Highlight);
+ return;
+ }
+ }
}
+}
- for(int i = 0; i < _highlightRules.count(); i++) {
- const HighlightRule &rule = _highlightRules.at(i);
- if(!rule.isEnabled)
- continue;
-
- bool match = false;
- if(rule.isRegExp) {
- QRegExp rx(rule.name, rule.caseSensitive? Qt::CaseSensitive : Qt::CaseInsensitive);
- match = rx.exactMatch(msg.contents());
- } else {
- QRegExp rx("\\b" + QRegExp::escape(rule.name) + "\\b", rule.caseSensitive? Qt::CaseSensitive : Qt::CaseInsensitive);
- match = (rx.indexIn(msg.contents()) >= 0);
- }
- if(match) {
- msg.setFlags(msg.flags() | Message::Highlight);
- return;
- }
+void QtUiMessageProcessor::nicksCaseSensitiveChanged(const QVariant& variant)
+{
+ _nicksCaseSensitive = variant.toBool();
+ // Update nickname matcher, too
+ _nickMatcher.setCaseSensitive(_nicksCaseSensitive);
+}
+
+void QtUiMessageProcessor::highlightListChanged(const QVariant& variant)
+{
+ QVariantList varList = variant.toList();
+
+ _highlightRuleList.clear();
+ QVariantList::const_iterator iter = varList.constBegin();
+ while (iter != varList.constEnd()) {
+ QVariantMap rule = iter->toMap();
+ _highlightRuleList << LegacyHighlightRule(rule["Name"].toString(),
+ rule["RegEx"].toBool(),
+ rule["CS"].toBool(),
+ rule["Enable"].toBool(),
+ rule["Channel"].toString());
+ ++iter;
}
- }
}
-void QtUiMessageProcessor::nicksCaseSensitiveChanged(const QVariant &variant) {
- _nicksCaseSensitive = variant.toBool();
+void QtUiMessageProcessor::highlightNickChanged(const QVariant& variant)
+{
+ _highlightNick = (HighlightNickType)variant.toInt();
+ // Convert from QtUiMessageProcessor::HighlightNickType (which is from NotificationSettings) to
+ // NickHighlightMatcher::HighlightNickType
+ _nickMatcher.setHighlightMode(static_cast<NickHighlightMatcher::HighlightNickType>(_highlightNick));
+}
+
+void QtUiMessageProcessor::networkRemoved(NetworkId id)
+{
+ // Clean up nickname matching cache
+ _nickMatcher.removeNetwork(id);
}
-void QtUiMessageProcessor::highlightListChanged(const QVariant &variant) {
- QVariantList varList = variant.toList();
-
- _highlightRules.clear();
- QVariantList::const_iterator iter = varList.constBegin();
- while(iter != varList.constEnd()) {
- QVariantMap rule = iter->toMap();
- _highlightRules << HighlightRule(rule["Name"].toString(),
- rule["Enable"].toBool(),
- rule["CS"].toBool() ? Qt::CaseSensitive : Qt::CaseInsensitive,
- rule["RegEx"].toBool());
- iter++;
- }
+/**************************************************************************
+ * LegacyHighlightRule
+ *************************************************************************/
+bool QtUiMessageProcessor::LegacyHighlightRule::operator!=(const LegacyHighlightRule& other) const
+{
+ return (_contents != other._contents || _isRegEx != other._isRegEx || _isCaseSensitive != other._isCaseSensitive
+ || _isEnabled != other._isEnabled || _chanName != other._chanName);
+ // Don't compare ExpressionMatch objects as they are created as needed from the above
}
-void QtUiMessageProcessor::highlightNickChanged(const QVariant &variant) {
- _highlightNick = (NotificationSettings::HighlightNickType)variant.toInt();
+void QtUiMessageProcessor::LegacyHighlightRule::determineExpressions() const
+{
+ // Don't update if not needed
+ if (!_cacheInvalid) {
+ return;
+ }
+
+ // Set up matching rules
+ // Message is either phrase or regex
+ ExpressionMatch::MatchMode contentsMode = _isRegEx ? ExpressionMatch::MatchMode::MatchRegEx : ExpressionMatch::MatchMode::MatchPhrase;
+ // Sender (when added) and channel are either multiple wildcard entries or regex
+ ExpressionMatch::MatchMode scopeMode = _isRegEx ? ExpressionMatch::MatchMode::MatchRegEx : ExpressionMatch::MatchMode::MatchMultiWildcard;
+
+ _contentsMatch = ExpressionMatch(_contents, contentsMode, _isCaseSensitive);
+ _chanNameMatch = ExpressionMatch(_chanName, scopeMode, _isCaseSensitive);
+
+ _cacheInvalid = false;
}
projects / quassel.git / blobdiff