1 /***************************************************************************
2 * Copyright (C) 2005-09 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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
21 #ifndef IGNORELISTMANAGER_H
22 #define IGNORELISTMANAGER_H
26 #include "syncableobject.h"
30 class IgnoreListManager : public SyncableObject
35 inline IgnoreListManager(QObject *parent = 0) : SyncableObject(parent) { setAllowClientUpdates(true); }
36 IgnoreListManager &operator=(const IgnoreListManager &other);
44 UnmatchedStrictness = 0,
55 struct IgnoreListItem {
59 StrictnessType strictness;
64 IgnoreListItem(IgnoreType type_, const QString &ignoreRule_, bool isRegEx_, StrictnessType strictness_,
65 ScopeType scope_, const QString &scopeRule_, bool isActive_)
66 : type(type_), ignoreRule(ignoreRule_), isRegEx(isRegEx_), strictness(strictness_), scope(scope_), scopeRule(scopeRule_), isActive(isActive_) {}
67 bool operator!=(const IgnoreListItem &other) {
68 return (type != other.type ||
69 ignoreRule != other.ignoreRule ||
70 isRegEx != other.isRegEx ||
71 strictness != other.strictness ||
72 scope != other.scope ||
73 scopeRule != other.scopeRule ||
74 isActive != other.isActive);
77 typedef QList<IgnoreListItem> IgnoreList;
79 int indexOf(const QString &ignore) const;
80 inline bool contains(const QString &ignore) const { return indexOf(ignore) != -1; }
81 inline bool isEmpty() const { return _ignoreList.isEmpty(); }
82 inline int count() const { return _ignoreList.count(); }
83 inline void removeAt(int index) { _ignoreList.removeAt(index); }
84 inline IgnoreListItem &operator[](int i) { return _ignoreList[i]; }
85 inline const IgnoreListItem &operator[](int i) const { return _ignoreList.at(i); }
86 inline const IgnoreList &ignoreList() const { return _ignoreList; }
88 //! Check if a message matches the IgnoreRule
89 /** This method checks if a message matches the users ignorelist.
90 * \param msg The Message that should be checked
91 * \param network The networkname the message belongs to
92 * \return UnmatchedStrictness, HardStrictness or SoftStrictness representing the match type
94 StrictnessType match(const Message &msg, const QString &network = QString());
97 // virtual void addIgnoreListItem(const IgnoreListItem &item);
100 virtual QVariantMap initIgnoreList() const;
101 virtual void initSetIgnoreList(const QVariantMap &ignoreList);
103 //! Request removal of an ignore rule based on the rule itself.
104 /** Use this method if you want to remove a single ignore rule
105 * and get that synced with the core immediately.
106 * \param ignoreRule A valid ignore rule
108 virtual inline void requestRemoveIgnoreListItem(const QString &ignoreRule) { REQUEST(ARG(ignoreRule)) }
109 virtual void removeIgnoreListItem(const QString &ignoreRule);
111 //! Request toggling of "isActive" flag of a given ignore rule.
112 /** Use this method if you want to toggle the "isActive" flag of a single ignore rule
113 * and get that synced with the core immediately.
114 * \param ignoreRule A valid ignore rule
116 virtual inline void requestToggleIgnoreRule(const QString &ignoreRule) { REQUEST(ARG(ignoreRule)) }
117 virtual void toggleIgnoreRule(const QString &ignoreRule);
119 //! Request an IgnoreListItem to be added to the ignore list
120 /** Items added to the list with this method, get immediately synced with the core
121 * \param type The IgnoreType of the new rule
122 * \param ignoreRule The rule itself
123 * \param isRegEx Signals if the rule should be interpreted as a regular expression
124 * \param strictness Th StrictnessType that should be applied
125 * \param scope The ScopeType that should be set
126 * \param scopeRule A string of semi-colon separated network- or channelnames
127 * \param isActive Signals if the rule is enabled or not
129 virtual inline void requestAddIgnoreListItem(int type, const QString &ignoreRule, bool isRegEx, int strictness,
130 int scope, const QString &scopeRule, bool isActive) {
131 REQUEST(ARG(type), ARG(ignoreRule), ARG(isRegEx), ARG(strictness), ARG(scope), ARG(scopeRule), ARG(isActive))
133 virtual void addIgnoreListItem(int type, const QString &ignoreRule, bool isRegEx, int strictness,
134 int scope, const QString &scopeRule, bool isActive);
137 void setIgnoreList(const QList<IgnoreListItem> &ignoreList) { _ignoreList = ignoreList; }
138 // scopeRule is a ; separated list, string is a network/channel-name
139 bool scopeMatch(const QString &scopeRule, const QString &string) const;
142 void ignoreAdded(IgnoreType type, const QString &ignoreRule, bool isRegex, StrictnessType strictness, ScopeType scope, const QVariant &scopeRule, bool isActive);
145 IgnoreList _ignoreList;
148 #endif // IGNORELISTMANAGER_H