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>
29 #include "expressionmatch.h"
31 #include "syncableobject.h"
33 class COMMON_EXPORT IgnoreListManager : public SyncableObject
39 inline IgnoreListManager(QObject *parent = nullptr) : SyncableObject(parent) { setAllowClientUpdates(true); }
40 IgnoreListManager &operator=(const IgnoreListManager &other);
49 UnmatchedStrictness = 0,
61 * Individual ignore list rule
63 class COMMON_EXPORT IgnoreListItem {
66 * Construct an empty ignore rule
71 * Construct an ignore rule with the given parameters
73 * CAUTION: For legacy reasons, "contents" doubles as the identifier for the ignore rule.
74 * Duplicate entries are not allowed.
76 * @param type Type of ignore rule
77 * @param contents String representing a message contents expression to match
78 * @param isRegEx True if regular expression, otherwise false
79 * @param strictness Strictness of ignore rule
80 * @param scope What to match scope rule against
81 * @param scopeRule String representing a scope rule expression to match
82 * @param isEnabled True if enabled, otherwise false
84 IgnoreListItem(IgnoreType type, const QString &contents, bool isRegEx,
85 StrictnessType strictness, ScopeType scope, const QString &scopeRule,
87 : _contents(contents), _isRegEx(isRegEx), _strictness(strictness),
88 _scope(scope), _scopeRule(scopeRule), _isEnabled(isEnabled)
90 // Allow passing empty "contents" as they can happen when editing an ignore rule
92 // Handle CTCP ignores
96 // Cache expression matches on construction
98 // This provides immediate feedback on errors when loading the rule. If profiling shows
99 // this as a performance bottleneck, this can be removed in deference to caching on
102 // Inversely, if needed for validity checks, caching can be done on every update below
103 // instead of on first use.
104 determineExpressions();
108 * Gets the type of this ignore rule
110 * @return IgnoreType of the rule
112 inline IgnoreType type() const {
116 * Sets the type of this ignore rule
118 * @param type IgnoreType of the rule
120 inline void setType(IgnoreType type) {
121 // Handle CTCP ignores
122 if (type == CtcpIgnore) {
123 // This is not performance-intensive; sticking with QRegExp for Qt 4 is fine
124 // Split based on whitespace characters
125 QStringList split(contents().split(QRegExp("\\s+"), QString::SkipEmptyParts));
126 // Match on the first item, handling empty rules/matches
127 if (!split.isEmpty()) {
128 // Take the first item as the sender
129 _cacheCtcpSender = split.takeFirst();
130 // Track the rest as CTCP types to ignore
131 _cacheCtcpTypes = split;
134 // No match found - this can happen if a pure whitespace CTCP ignore rule is
135 // created. Fall back to matching all senders.
137 // RegEx match everything
138 _cacheCtcpSender = ".*";
141 // Wildcard match everything
142 _cacheCtcpSender = "*";
144 // Clear the types (split is already empty)
145 _cacheCtcpTypes = split;
152 * Gets the message contents this rule matches
154 * NOTE: Use IgnoreListItem::contentsMatcher() for performing matches
156 * CAUTION: For legacy reasons, "contents" doubles as the identifier for the ignore rule.
157 * Duplicate entries are not allowed.
159 * @return String representing a phrase or expression to match
161 inline QString contents() const {
165 * Sets the message contents this rule matches
167 * @param contents String representing a phrase or expression to match
169 inline void setContents(const QString &contents) {
170 // Allow passing empty "contents" as they can happen when editing an ignore rule
171 _contents = contents;
172 _cacheInvalid = true;
176 * Gets if this is a regular expression rule
178 * @return True if regular expression, otherwise false
180 inline bool isRegEx() const {
184 * Sets if this rule is a regular expression rule
186 * @param isRegEx True if regular expression, otherwise false
188 inline void setIsRegEx(bool isRegEx) {
190 _cacheInvalid = true;
194 * Gets the strictness of this ignore rule
196 * @return StrictnessType of the rule
198 inline StrictnessType strictness() const {
202 * Sets the strictness of this ignore rule
204 * @param strictness StrictnessType of the rule
206 inline void setStrictness(StrictnessType strictness) {
207 _strictness = strictness;
211 * Gets what to match scope rule against
213 * @return ScopeType of the rule
215 inline ScopeType scope() const {
219 * Sets what to match scope rule against
221 * @param type ScopeType of the rule
223 inline void setScope(ScopeType scope) {
228 * Gets the scope rule this rule matches
230 * NOTE: Use IgnoreListItem::scopeRuleMatcher() for performing matches
232 * @return String representing a phrase or expression to match
234 inline QString scopeRule() const {
238 * Sets the scope rule this rule matches
240 * @param scopeRule String representing a phrase or expression to match
242 inline void setScopeRule(const QString &scopeRule) {
243 _scopeRule = scopeRule;
244 _cacheInvalid = true;
248 * Gets if this rule is enabled and active
250 * @return True if enabled, otherwise false
252 inline bool isEnabled() const {
256 * Sets if this rule is enabled and active
258 * @param isEnabled True if enabled, otherwise false
260 inline void setIsEnabled(bool isEnabled) {
261 _isEnabled = isEnabled;
265 * Gets the ignored CTCP types for CTCP ignores
267 * @return List of CTCP types to ignore, or empty for all
269 inline QStringList ctcpTypes() const {
270 return _cacheCtcpTypes;
274 * Gets the expression matcher for the message contents, caching if needed
276 * @return Expression matcher to compare with message contents
278 inline ExpressionMatch contentsMatcher() const {
280 determineExpressions();
282 return _contentsMatch;
286 * Gets the expression matcher for the scope, caching if needed
288 * @return Expression matcher to compare with scope
290 inline ExpressionMatch scopeRuleMatcher() const {
292 determineExpressions();
294 return _scopeRuleMatch;
298 * Gets the expression matcher for the message contents, caching if needed
300 * @return Expression matcher to compare with message contents
302 inline ExpressionMatch senderCTCPMatcher() const {
304 determineExpressions();
306 return _ctcpSenderMatch;
309 bool operator!=(const IgnoreListItem &other) const;
313 * Update internal cache of expression matching if needed
315 void determineExpressions() const;
317 IgnoreType _type = {};
318 QString _contents = {};
319 bool _isRegEx = false;
320 StrictnessType _strictness = {};
321 ScopeType _scope = {};
322 QString _scopeRule = {};
323 bool _isEnabled = true;
325 QString _cacheCtcpSender = {}; ///< For CTCP rules, precalculate sender
326 QStringList _cacheCtcpTypes = {}; ///< For CTCP rules, precalculate types
328 // These represent internal cache and should be safe to mutate in 'const' functions
329 // See https://stackoverflow.com/questions/3141087/what-is-meant-with-const-at-end-of-function-declaration
330 mutable bool _cacheInvalid = true; ///< If true, match cache needs redone
331 mutable ExpressionMatch _contentsMatch = {}; ///< Expression match cache for message
332 mutable ExpressionMatch _scopeRuleMatch = {}; ///< Expression match cache for scope rule
333 mutable ExpressionMatch _ctcpSenderMatch = {}; ///< Expression match cache for CTCP nick
336 typedef QList<IgnoreListItem> IgnoreList;
338 int indexOf(const QString &ignore) const;
339 inline bool contains(const QString &ignore) const { return indexOf(ignore) != -1; }
340 inline bool isEmpty() const { return _ignoreList.isEmpty(); }
341 inline int count() const { return _ignoreList.count(); }
342 inline void removeAt(int index) { _ignoreList.removeAt(index); }
343 inline IgnoreListItem &operator[](int i) { return _ignoreList[i]; }
344 inline const IgnoreListItem &operator[](int i) const { return _ignoreList.at(i); }
345 inline const IgnoreList &ignoreList() const { return _ignoreList; }
347 //! Check if a message matches the IgnoreRule
348 /** This method checks if a message matches the users ignorelist.
349 * \param msg The Message that should be checked
350 * \param network The networkname the message belongs to
351 * \return UnmatchedStrictness, HardStrictness or SoftStrictness representing the match type
353 inline StrictnessType match(const Message &msg, const QString &network = QString()) { return _match(msg.contents(), msg.sender(), msg.type(), network, msg.bufferInfo().bufferName()); }
355 bool ctcpMatch(const QString sender, const QString &network, const QString &type = QString());
357 // virtual void addIgnoreListItem(const IgnoreListItem &item);
360 virtual QVariantMap initIgnoreList() const;
361 virtual void initSetIgnoreList(const QVariantMap &ignoreList);
363 //! Request removal of an ignore rule based on the rule itself.
364 /** Use this method if you want to remove a single ignore rule
365 * and get that synced with the core immediately.
366 * \param ignoreRule A valid ignore rule
368 virtual inline void requestRemoveIgnoreListItem(const QString &ignoreRule) { REQUEST(ARG(ignoreRule)) }
369 virtual void removeIgnoreListItem(const QString &ignoreRule);
371 //! Request toggling of "isActive" flag of a given ignore rule.
372 /** Use this method if you want to toggle the "isActive" flag of a single ignore rule
373 * and get that synced with the core immediately.
374 * \param ignoreRule A valid ignore rule
376 virtual inline void requestToggleIgnoreRule(const QString &ignoreRule) { REQUEST(ARG(ignoreRule)) }
377 virtual void toggleIgnoreRule(const QString &ignoreRule);
379 //! Request an IgnoreListItem to be added to the ignore list
380 /** Items added to the list with this method, get immediately synced with the core
381 * \param type The IgnoreType of the new rule
382 * \param ignoreRule The rule itself
383 * \param isRegEx Signals if the rule should be interpreted as a regular expression
384 * \param strictness Th StrictnessType that should be applied
385 * \param scope The ScopeType that should be set
386 * \param scopeRule A string of semi-colon separated network- or channelnames
387 * \param isActive Signals if the rule is enabled or not
389 virtual inline void requestAddIgnoreListItem(int type, const QString &ignoreRule, bool isRegEx, int strictness,
390 int scope, const QString &scopeRule, bool isActive)
392 REQUEST(ARG(type), ARG(ignoreRule), ARG(isRegEx), ARG(strictness), ARG(scope), ARG(scopeRule), ARG(isActive))
396 virtual void addIgnoreListItem(int type, const QString &ignoreRule, bool isRegEx, int strictness,
397 int scope, const QString &scopeRule, bool isActive);
400 void setIgnoreList(const QList<IgnoreListItem> &ignoreList) { _ignoreList = ignoreList; }
402 StrictnessType _match(const QString &msgContents, const QString &msgSender, Message::Type msgType, const QString &network, const QString &bufferName);
405 void ignoreAdded(IgnoreType type, const QString &ignoreRule, bool isRegex, StrictnessType strictness, ScopeType scope, const QVariant &scopeRule, bool isActive);
408 IgnoreList _ignoreList;