Differential D6513 Diff 37047 src/core/tagsfilterchecker.cpp

Changeset View

Standalone View

View Options

src/core/tagsfilterchecker.cpp

  • This file was added.
1​/*
2​ Copyright (c) 2018 Dan Leinir Turthra Jensen <admin@leinir.dk>
3​
4​ This library is free software; you can redistribute it and/or
5​ modify it under the terms of the GNU Lesser General Public
6​ License as published by the Free Software Foundation; either
7​ version 2.1 of the License, or (at your option) any later version.
8​
9​ This library is distributed in the hope that it will be useful,
10​ but WITHOUT ANY WARRANTY; without even the implied warranty of
11​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12​ Lesser General Public License for more details.
13​
14​ You should have received a copy of the GNU Lesser General Public
15​ License along with this library. If not, see <http://www.gnu.org/licenses/>.
16​*/
17​
18​#include "tagsfilterchecker.h"
19​
20​#include <knewstuffcore_debug.h>
21​
22​#include <QMap>
23​
24​namespace KNSCore
25​{
26​
27​class TagsFilterChecker::Private
28​{
cfeckUnsubmitted
Done

This could be marked non-exported.

Please also check this and all other new files for coding style issues. If unsure, run it through the astyle-kdelibs or uncrustify-kf5 script from kde-dev-scripts.git.

cfeck: This could be marked non-exported. Please also check this and all other new files for coding…
29​public:
30​ Private() {}
31​ ~Private()
32​ {
33​ qDeleteAll(validators.values());
34​ }
dfaureUnsubmitted
Done

Unnecessarily slow. Remove the .values() call.

dfaure: Unnecessarily slow. Remove the .values() call.
35​ class Validator;
36​ // If people start using a LOT of validators (>20ish), we can always change it, but
37​ // for now it seems reasonable that QMap is better than QHash here...
38​ QMap<QString, Validator*> validators;
39​
40​ class Validator
41​ {
42​ public:
43​ Validator(const QString& tag, const QString value) {
ahiemstraUnsubmitted
Done

I think you mean const QString& value ?

ahiemstra: I think you mean `const QString& value` ?
44​ m_tag = tag;
45​ m_acceptedValues << value;
46​ }
47​ virtual ~Validator() {};
dfaureUnsubmitted
Done

!value.isEmpty()

Or isNull()?

dfaure: !value.isEmpty() Or isNull()?
48​ virtual bool filterAccepts(const QString& tag, const QString& value) = 0;
49​ protected:
50​ friend class TagsFilterChecker::Private;
51​ QString m_tag;
52​ QStringList m_acceptedValues;
53​ };
54​
55​ // Will only accept entries which have one of the accepted values set for the tag key
56​ class EqualityValidator : public Validator
57​ {
58​ public:
59​ EqualityValidator(const QString& tag, const QString value)
60​ : Validator(tag, value)
61​ {}
62​ ~EqualityValidator() override {}
63​ bool filterAccepts(const QString& tag, const QString& value) override
64​ {
65​ bool result = true;
66​ if(tag == m_tag && !m_acceptedValues.contains(value)) {
67​ result = false;
68​ }
69​ return result;
70​ }
71​ };
72​
73​ // Will only accept entries which have none of the values set for the tag key
74​ class InequalityValidator : public Validator
75​ {
76​ public:
77​ InequalityValidator(const QString& tag, const QString value)
78​ : Validator(tag, value)
79​ {}
80​ ~InequalityValidator() override {}
81​ bool filterAccepts(const QString& tag, const QString& value) override
82​ {
83​ bool result = true;
84​ if(tag == m_tag && m_acceptedValues.contains(value)) {
85​ result = false;
86​ }
87​ return result;
88​ }
89​ };
90​
91​ void addValidator(const QString& filter)
92​ {
93​ int pos = 0;
94​ if((pos = filter.indexOf(QStringLiteral("=="))) > -1)
95​ {
96​ QString tag = filter.left(pos);
97​ QString value = filter.mid(tag.length() + 2);
98​ Validator* val = validators.value(tag, nullptr);
ahiemstraUnsubmitted
Done

Wouldn't this be simpler?

if(!validators.contains(tag)) {
  validators[tag] = new EqualityValidator(tag, "");
}
validators.value(tag)->m_acceptedValues << value;
ahiemstra: Wouldn't this be simpler? ``` if(!validators.contains(tag)) { validators[tag] = new…
leinirAuthorUnsubmitted
Done

Hmm, not quite, that would create a ghost entry in the list... However, allowing the validator to be created without values to work on would simplify things, so yeah, just going to do that :)

leinir: Hmm, not quite, that would create a ghost entry in the list... However, allowing the validator…
99​ if(val)
100​ {
101​ val->m_acceptedValues << value;
102​ }
103​ else
dfaureUnsubmitted
Done

Consider QString::null deprecated. Use QString().

dfaure: Consider QString::null deprecated. Use QString().
104​ {
dfaureUnsubmitted
Done

.insert(tag, val) is raster, see Effective STL

dfaure: .insert(tag, val) is raster, see Effective STL
leinirAuthorUnsubmitted
Not Done

Scott Meyers' book? (might need to grab a copy of that, then :) )

leinir: Scott Meyers' book? (might need to grab a copy of that, then :) )
dfaureUnsubmitted
Not Done

Yes.

dfaure: Yes.
leinirAuthorUnsubmitted
Not Done

Great, thank you :) Yeah, going to have to nab a copy of that for a readthrough :)

leinir: Great, thank you :) Yeah, going to have to nab a copy of that for a readthrough :)
105​ val = new EqualityValidator(tag, value);
106​ validators[tag] = val;
107​ }
108​ qCDebug(KNEWSTUFFCORE) << "Created EqualityValidator for tag" << tag << "with value" << value;
109​ }
110​ else if((pos = filter.indexOf(QStringLiteral("!="))) > -1)
111​ {
112​ QString tag = filter.left(pos);
113​ QString value = filter.mid(tag.length() + 2);
114​ Validator* val = validators.value(tag, nullptr);
dfaureUnsubmitted
Done

Insert

dfaure: Insert
115​ if(val)
116​ {
117​ val->m_acceptedValues << value;
118​ }
119​ else
120​ {
121​ val = new InequalityValidator(tag, value);
122​ validators[tag] = val;
123​ }
124​ qCDebug(KNEWSTUFFCORE) << "Created InequalityValidator for tag" << tag << "with value" << value;
125​ }
126​ else
127​ {
128​ qCDebug(KNEWSTUFFCORE) << "Critical error attempting to create tag filter validators. The filter is defined as" << filter << "which is not in the accepted formats key==value or key!=value";
129​ }
130​ }
131​};
132​
133​TagsFilterChecker::TagsFilterChecker(const QStringList& tagFilter)
134​ : d(new TagsFilterChecker::Private)
135​{
136​ for(const QString& filter : tagFilter) {
137​ d->addValidator(filter);
138​ }
139​}
140​
141​TagsFilterChecker::~TagsFilterChecker()
142​{
143​ delete d;
144​}
145​
146​bool TagsFilterChecker::filterAccepts(const QStringList& tags)
147​{
148​ // if any tag in the content matches any of the tag filters, skip this entry
mlaurentUnsubmitted
Done

isEmpty() ?

mlaurent: isEmpty() ?
149​ qCDebug(KNEWSTUFFCORE) << "Checking tags list" << tags << "against validators with keys" << d->validators.keys();
150​ for(const QString &tag : tags) {
151​ if(tag.length() == 0) {
152​ // This happens when you do a split on an empty string (not an empty list, a list with one empty element... because reasons).
153​ // Also handy for other things, i guess, though, so let's just catch it here.
mlaurentUnsubmitted
Done

use QLatin1Char('=')

mlaurent: use QLatin1Char('=')
154​ continue;
155​ }
156​ QStringList current = tag.split(QStringLiteral("="));
157​ if(current.length() > 2) {
158​ qCDebug(KNEWSTUFFCORE) << "Critical error attempting to filter tags. Entry has tag defined as" << tag << "which is not in the format \"key=value\" or \"key\".";
159​ return false;
160​ }
161​ else if(current.length() == 1) {
162​ // If the tag is defined simply as a key, we give it the value "1", just to make our filtering work simpler
163​ current << QStringLiteral("1");
164​ }
165​ QMap<QString,TagsFilterChecker::Private::Validator*>::const_iterator i = d->validators.constBegin();
166​ while(i != d->validators.constEnd()) {
167​ if(!i.value()->filterAccepts(current.at(0), current.at(1))) {
168​ return false;
169​ }
170​ ++i;
171​ }
172​ }
173​ // If we have arrived here, nothing has filtered the entry
174​ // out (by being either incorrectly tagged or a filter rejecting
175​ // it), and consequently it is an acceptable entry.
176​ return true;
177​}
178​
179​}