Differential D6513 Diff 41034 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());
dfaureUnsubmitted
Done

Unnecessarily slow. Remove the .values() call.

dfaure: Unnecessarily slow. Remove the .values() call.
34​ }
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)
44​ {
ahiemstraUnsubmitted
Done

I think you mean const QString& value ?

ahiemstra: I think you mean `const QString& value` ?
45​ m_tag = tag;
46​ if (value != QString::null) {
dfaureUnsubmitted
Done

!value.isEmpty()

Or isNull()?

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

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

dfaure: Consider QString::null deprecated. Use QString().
103​ validators[tag] = val;
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 :)
104​ }
105​ val->m_acceptedValues << value;
106​ qCDebug(KNEWSTUFFCORE) << "Created EqualityValidator for tag" << tag << "with value" << value;
107​ } else if ((pos = filter.indexOf(QStringLiteral("!="))) > -1) {
108​ QString tag = filter.left(pos);
109​ QString value = filter.mid(tag.length() + 2);
110​ Validator *val = validators.value(tag, nullptr);
111​ if (!val) {
112​ val = new InequalityValidator(tag, QString::null);
113​ validators[tag] = val;
dfaureUnsubmitted
Done

Insert

dfaure: Insert
114​ }
115​ val->m_acceptedValues << value;
116​ qCDebug(KNEWSTUFFCORE) << "Created InequalityValidator for tag" << tag << "with value" << value;
117​ } else {
118​ 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";
119​ }
120​ }
121​};
122​
123​TagsFilterChecker::TagsFilterChecker(const QStringList &tagFilter)
124​ : d(new TagsFilterChecker::Private)
125​{
126​ for (const QString &filter : tagFilter) {
127​ d->addValidator(filter);
128​ }
129​}
130​
131​TagsFilterChecker::~TagsFilterChecker()
132​{
133​ delete d;
134​}
135​
136​bool TagsFilterChecker::filterAccepts(const QStringList &tags)
137​{
138​ // if any tag in the content matches any of the tag filters, skip this entry
139​ qCDebug(KNEWSTUFFCORE) << "Checking tags list" << tags << "against validators with keys" << d->validators.keys();
140​ for (const QString &tag : tags) {
141​ if (tag.isEmpty()) {
142​ // This happens when you do a split on an empty string (not an empty list, a list with one empty element... because reasons).
143​ // Also handy for other things, i guess, though, so let's just catch it here.
144​ continue;
145​ }
146​ QStringList current = tag.split(QLatin1Char('='));
147​ if (current.length() > 2) {
148​ qCDebug(KNEWSTUFFCORE) << "Critical error attempting to filter tags. Entry has tag defined as" << tag << "which is not in the format \"key=value\" or \"key\".";
mlaurentUnsubmitted
Done

isEmpty() ?

mlaurent: isEmpty() ?
149​ return false;
150​ } else if (current.length() == 1) {
151​ // If the tag is defined simply as a key, we give it the value "1", just to make our filtering work simpler
152​ current << QStringLiteral("1");
153​ }
mlaurentUnsubmitted
Done

use QLatin1Char('=')

mlaurent: use QLatin1Char('=')
154​ QMap<QString,TagsFilterChecker::Private::Validator*>::const_iterator i = d->validators.constBegin();
155​ while (i != d->validators.constEnd()) {
156​ if (!i.value()->filterAccepts(current.at(0), current.at(1))) {
157​ return false;
158​ }
159​ ++i;
160​ }
161​ }
162​ // If we have arrived here, nothing has filtered the entry
163​ // out (by being either incorrectly tagged or a filter rejecting
164​ // it), and consequently it is an acceptable entry.
165​ return true;
166​}
167​
168​}