1 /***************************************************************************
2 * Copyright (C) 2005-2018 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
23 #include "common-export.h"
26 #include <QStringList>
30 #include "expressionmatch.h"
32 #include "syncableobject.h"
34 class COMMON_EXPORT IgnoreListManager : public SyncableObject
40 inline IgnoreListManager(QObject *parent = nullptr) : SyncableObject(parent) { setAllowClientUpdates(true); }
41 IgnoreListManager &operator=(const IgnoreListManager &other);
50 UnmatchedStrictness = 0,
62 * Individual ignore list rule
64 class COMMON_EXPORT IgnoreListItem {
67 * Construct an empty ignore rule
69 IgnoreListItem() = default;
72 * Construct an ignore rule with the given parameters
74 * CAUTION: For legacy reasons, "contents" doubles as the identifier for the ignore rule.
75 * Duplicate entries are not allowed.
77 * @param type Type of ignore rule
78 * @param contents String representing a message contents expression to match
79 * @param isRegEx True if regular expression, otherwise false
80 * @param strictness Strictness of ignore rule
81 * @param scope What to match scope rule against
82 * @param scopeRule String representing a scope rule expression to match
83 * @param isEnabled True if enabled, otherwise false
85 IgnoreListItem(IgnoreType type, QString contents, bool isRegEx,
86 StrictnessType strictness, ScopeType scope, QString scopeRule,
88 : _contents(std::move(contents)), _isRegEx(isRegEx), _strictness(strictness),
89 _scope(scope), _scopeRule(std::move(scopeRule)), _isEnabled(isEnabled)
91 // Allow passing empty "contents" as they can happen when editing an ignore rule
93 // Handle CTCP ignores
97 // Cache expression matches on construction
99 // This provides immediate feedback on errors when loading the rule. If profiling shows
100 // this as a performance bottleneck, this can be removed in deference to caching on
103 // Inversely, if needed for validity checks, caching can be done on every update below
104 // instead of on first use.
105 determineExpressions();
109 * Gets the type of this ignore rule
111 * @return IgnoreType of the rule
113 inline IgnoreType type() const {
117 * Sets the type of this ignore rule
119 * @param type IgnoreType of the rule
121 inline void setType(IgnoreType type) {
122 // Handle CTCP ignores
123 if (type == CtcpIgnore) {
124 // This is not performance-intensive; sticking with QRegExp for Qt 4 is fine
125 // Split based on whitespace characters
126 QStringList split(contents().split(QRegExp("\\s+"), QString::SkipEmptyParts));
127 // Match on the first item, handling empty rules/matches
128 if (!split.isEmpty()) {
129 // Take the first item as the sender
130 _cacheCtcpSender = split.takeFirst();
131 // Track the rest as CTCP types to ignore
132 _cacheCtcpTypes = split;
135 // No match found - this can happen if a pure whitespace CTCP ignore rule is
136 // created. Fall back to matching all senders.
138 // RegEx match everything
139 _cacheCtcpSender = ".*";
142 // Wildcard match everything
143 _cacheCtcpSender = "*";
145 // Clear the types (split is already empty)
146 _cacheCtcpTypes = split;
153 * Gets the message contents this rule matches
155 * NOTE: Use IgnoreListItem::contentsMatcher() for performing matches
157 * CAUTION: For legacy reasons, "contents" doubles as the identifier for the ignore rule.
158 * Duplicate entries are not allowed.
160 * @return String representing a phrase or expression to match
162 inline QString contents() const {
166 * Sets the message contents this rule matches
168 * @param contents String representing a phrase or expression to match
170 inline void setContents(const QString &contents) {
171 // Allow passing empty "contents" as they can happen when editing an ignore rule
172 _contents = contents;
173 _cacheInvalid = true;
177 * Gets if this is a regular expression rule
179 * @return True if regular expression, otherwise false
181 inline bool isRegEx() const {
185 * Sets if this rule is a regular expression rule
187 * @param isRegEx True if regular expression, otherwise false
189 inline void setIsRegEx(bool isRegEx) {
191 _cacheInvalid = true;
195 * Gets the strictness of this ignore rule
197 * @return StrictnessType of the rule
199 inline StrictnessType strictness() const {
203 * Sets the strictness of this ignore rule
205 * @param strictness StrictnessType of the rule
207 inline void setStrictness(StrictnessType strictness) {
208 _strictness = strictness;
212 * Gets what to match scope rule against
214 * @return ScopeType of the rule
216 inline ScopeType scope() const {
220 * Sets what to match scope rule against
222 * @param type ScopeType of the rule
224 inline void setScope(ScopeType scope) {
229 * Gets the scope rule this rule matches
231 * NOTE: Use IgnoreListItem::scopeRuleMatcher() for performing matches
233 * @return String representing a phrase or expression to match
235 inline QString scopeRule() const {
239 * Sets the scope rule this rule matches
241 * @param scopeRule String representing a phrase or expression to match
243 inline void setScopeRule(const QString &scopeRule) {
244 _scopeRule = scopeRule;
245 _cacheInvalid = true;
249 * Gets if this rule is enabled and active
251 * @return True if enabled, otherwise false
253 inline bool isEnabled() const {
257 * Sets if this rule is enabled and active
259 * @param isEnabled True if enabled, otherwise false
261 inline void setIsEnabled(bool isEnabled) {
262 _isEnabled = isEnabled;
266 * Gets the ignored CTCP types for CTCP ignores
268 * @return List of CTCP types to ignore, or empty for all
270 inline QStringList ctcpTypes() const {
271 return _cacheCtcpTypes;
275 * Gets the expression matcher for the message contents, caching if needed
277 * @return Expression matcher to compare with message contents
279 inline ExpressionMatch contentsMatcher() const {
281 determineExpressions();
283 return _contentsMatch;
287 * Gets the expression matcher for the scope, caching if needed
289 * @return Expression matcher to compare with scope
291 inline ExpressionMatch scopeRuleMatcher() const {
293 determineExpressions();
295 return _scopeRuleMatch;
299 * Gets the expression matcher for the message contents, caching if needed
301 * @return Expression matcher to compare with message contents
303 inline ExpressionMatch senderCTCPMatcher() const {
305 determineExpressions();
307 return _ctcpSenderMatch;
310 bool operator!=(const IgnoreListItem &other) const;
314 * Update internal cache of expression matching if needed
316 void determineExpressions() const;
318 IgnoreType _type = {};
319 QString _contents = {};
320 bool _isRegEx = false;
321 StrictnessType _strictness = {};
322 ScopeType _scope = {};
323 QString _scopeRule = {};
324 bool _isEnabled = true;
326 QString _cacheCtcpSender = {}; ///< For CTCP rules, precalculate sender
327 QStringList _cacheCtcpTypes = {}; ///< For CTCP rules, precalculate types
329 // These represent internal cache and should be safe to mutate in 'const' functions
330 // See https://stackoverflow.com/questions/3141087/what-is-meant-with-const-at-end-of-function-declaration
331 mutable bool _cacheInvalid = true; ///< If true, match cache needs redone
332 mutable ExpressionMatch _contentsMatch = {}; ///< Expression match cache for message
333 mutable ExpressionMatch _scopeRuleMatch = {}; ///< Expression match cache for scope rule
334 mutable ExpressionMatch _ctcpSenderMatch = {}; ///< Expression match cache for CTCP nick
337 using IgnoreList = QList<IgnoreListItem>;
339 int indexOf(const QString &ignore) const;
340 inline bool contains(const QString &ignore) const { return indexOf(ignore) != -1; }
341 inline bool isEmpty() const { return _ignoreList.isEmpty(); }
342 inline int count() const { return _ignoreList.count(); }
343 inline void removeAt(int index) { _ignoreList.removeAt(index); }
344 inline IgnoreListItem &operator[](int i) { return _ignoreList[i]; }
345 inline const IgnoreListItem &operator[](int i) const { return _ignoreList.at(i); }
346 inline const IgnoreList &ignoreList() const { return _ignoreList; }
348 //! Check if a message matches the IgnoreRule
349 /** This method checks if a message matches the users ignorelist.
350 * \param msg The Message that should be checked
351 * \param network The networkname the message belongs to
352 * \return UnmatchedStrictness, HardStrictness or SoftStrictness representing the match type
354 inline StrictnessType match(const Message &msg, const QString &network = QString()) { return _match(msg.contents(), msg.sender(), msg.type(), network, msg.bufferInfo().bufferName()); }
356 bool ctcpMatch(const QString sender, const QString &network, const QString &type = QString());
358 // virtual void addIgnoreListItem(const IgnoreListItem &item);
361 virtual QVariantMap initIgnoreList() const;
362 virtual void initSetIgnoreList(const QVariantMap &ignoreList);
364 //! Request removal of an ignore rule based on the rule itself.
365 /** Use this method if you want to remove a single ignore rule
366 * and get that synced with the core immediately.
367 * \param ignoreRule A valid ignore rule
369 virtual inline void requestRemoveIgnoreListItem(const QString &ignoreRule) { REQUEST(ARG(ignoreRule)) }
370 virtual void removeIgnoreListItem(const QString &ignoreRule);
372 //! Request toggling of "isActive" flag of a given ignore rule.
373 /** Use this method if you want to toggle the "isActive" flag of a single ignore rule
374 * and get that synced with the core immediately.
375 * \param ignoreRule A valid ignore rule
377 virtual inline void requestToggleIgnoreRule(const QString &ignoreRule) { REQUEST(ARG(ignoreRule)) }
378 virtual void toggleIgnoreRule(const QString &ignoreRule);
380 //! Request an IgnoreListItem to be added to the ignore list
381 /** Items added to the list with this method, get immediately synced with the core
382 * \param type The IgnoreType of the new rule
383 * \param ignoreRule The rule itself
384 * \param isRegEx Signals if the rule should be interpreted as a regular expression
385 * \param strictness Th StrictnessType that should be applied
386 * \param scope The ScopeType that should be set
387 * \param scopeRule A string of semi-colon separated network- or channelnames
388 * \param isActive Signals if the rule is enabled or not
390 virtual inline void requestAddIgnoreListItem(int type, const QString &ignoreRule, bool isRegEx, int strictness,
391 int scope, const QString &scopeRule, bool isActive)
393 REQUEST(ARG(type), ARG(ignoreRule), ARG(isRegEx), ARG(strictness), ARG(scope), ARG(scopeRule), ARG(isActive))
397 virtual void addIgnoreListItem(int type, const QString &ignoreRule, bool isRegEx, int strictness,
398 int scope, const QString &scopeRule, bool isActive);
401 void setIgnoreList(const QList<IgnoreListItem> &ignoreList) { _ignoreList = ignoreList; }
403 StrictnessType _match(const QString &msgContents, const QString &msgSender, Message::Type msgType, const QString &network, const QString &bufferName);
406 void ignoreAdded(IgnoreType type, const QString &ignoreRule, bool isRegex, StrictnessType strictness, ScopeType scope, const QVariant &scopeRule, bool isActive);
409 IgnoreList _ignoreList;