1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
|
/*
* articlematcher.cpp
*
* SPDX-FileCopyrightText: 2004, 2005 Frerich Raabe <raabe@kde.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include "articlematcher.h"
#include "akregator_debug.h"
#include "article.h"
#include <KConfig>
#include <KConfigGroup>
#include <QUrl>
#include <TextUtils/ConvertText>
#include <QRegularExpression>
namespace Akregator
{
namespace Filters
{
AbstractMatcher::AbstractMatcher() = default;
AbstractMatcher::~AbstractMatcher() = default;
QString Criterion::subjectToString(Subject subj)
{
switch (subj) {
case Title:
return QStringLiteral("Title");
case Link:
return QStringLiteral("Link");
case Description:
return QStringLiteral("Description");
case Status:
return QStringLiteral("Status");
case KeepFlag:
return QStringLiteral("KeepFlag");
case Author:
return QStringLiteral("Author");
}
return {};
}
Criterion::Subject Criterion::stringToSubject(const QString &subjStr)
{
if (subjStr == QLatin1StringView("Title")) {
return Title;
} else if (subjStr == QLatin1StringView("Link")) {
return Link;
} else if (subjStr == QLatin1StringView("Description")) {
return Description;
} else if (subjStr == QLatin1StringView("Status")) {
return Status;
} else if (subjStr == QLatin1StringView("KeepFlag")) {
return KeepFlag;
} else if (subjStr == QLatin1StringView("Author")) {
return Author;
}
// hopefully never reached
return Description;
}
QString Criterion::predicateToString(Predicate pred)
{
switch (pred) {
case Contains:
return QStringLiteral("Contains");
case Equals:
return QStringLiteral("Equals");
case Matches:
return QStringLiteral("Matches");
case Negation:
return QStringLiteral("Negation");
}
return {};
}
Criterion::Predicate Criterion::stringToPredicate(const QString &predStr)
{
if (predStr == QLatin1StringView("Contains")) {
return Contains;
} else if (predStr == QLatin1StringView("Equals")) {
return Equals;
} else if (predStr == QLatin1StringView("Matches")) {
return Matches;
} else if (predStr == QLatin1StringView("Negation")) {
return Negation;
}
// hopefully never reached
return Contains;
}
Criterion::Criterion() = default;
Criterion::Criterion(Subject subject, Predicate predicate, const QVariant &object)
: m_subject(subject)
, m_predicate(predicate)
, m_object(object)
{
}
void Criterion::writeConfig(KConfigGroup *config) const
{
config->writeEntry(QStringLiteral("subject"), subjectToString(m_subject));
config->writeEntry(QStringLiteral("predicate"), predicateToString(m_predicate));
config->writeEntry(QStringLiteral("objectType"), QString::fromLatin1(m_object.typeName()));
config->writeEntry(QStringLiteral("objectValue"), m_object);
}
void Criterion::readConfig(KConfigGroup *config)
{
m_subject = stringToSubject(config->readEntry(QStringLiteral("subject"), QString()));
m_predicate = stringToPredicate(config->readEntry(QStringLiteral("predicate"), QString()));
QMetaType type = QMetaType::fromName(config->readEntry(QStringLiteral("objType"), QString()).toLatin1().constData());
if (QMetaType::Type(type.id()) != QMetaType::UnknownType) {
m_object = config->readEntry(QStringLiteral("objectValue"), QVariant(type));
}
}
bool Criterion::satisfiedBy(const Article &article) const
{
if (article.isNull()) {
return false;
}
QVariant concreteSubject;
switch (m_subject) {
case Title:
concreteSubject = QVariant(article.title());
break;
case Description:
concreteSubject = QVariant(article.description());
break;
case Link:
// ### Maybe use prettyUrl here?
concreteSubject = QVariant(article.link().url());
break;
case Status:
concreteSubject = QVariant(article.status());
break;
case KeepFlag:
concreteSubject = QVariant(article.keep());
break;
case Author:
concreteSubject = QVariant(article.authorName());
}
bool satisfied = false;
const auto predicateType = static_cast<Predicate>(m_predicate & ~Negation);
QString subjectType = QLatin1StringView(concreteSubject.typeName());
switch (predicateType) {
case Contains:
satisfied = TextUtils::ConvertText::normalize(concreteSubject.toString()).indexOf(m_object.toString(), 0, Qt::CaseInsensitive) != -1;
break;
case Equals:
if (subjectType == QLatin1StringView("int")) {
satisfied = concreteSubject.toInt() == m_object.toInt();
} else {
satisfied = TextUtils::ConvertText::normalize(concreteSubject.toString()) == m_object.toString();
}
break;
case Matches:
satisfied = TextUtils::ConvertText::normalize(concreteSubject.toString()).contains(QRegularExpression(m_object.toString()));
break;
default:
qCDebug(AKREGATOR_LOG) << "Internal inconsistency; predicateType should never be Negation";
break;
}
if (m_predicate & Negation) {
satisfied = !satisfied;
}
return satisfied;
}
Criterion::Subject Criterion::subject() const
{
return m_subject;
}
Criterion::Predicate Criterion::predicate() const
{
return m_predicate;
}
QVariant Criterion::object() const
{
return m_object;
}
ArticleMatcher::ArticleMatcher()
: m_association(None)
{
}
ArticleMatcher::~ArticleMatcher() = default;
ArticleMatcher::ArticleMatcher(const QList<Criterion> &criteria, Association assoc)
: m_criteria(criteria)
, m_association(assoc)
{
}
bool ArticleMatcher::matches(const Article &a) const
{
switch (m_association) {
case LogicalOr:
return anyCriterionMatches(a);
case LogicalAnd:
return allCriteriaMatch(a);
default:
break;
}
return true;
}
void ArticleMatcher::writeConfig(KConfigGroup *config) const
{
config->writeEntry(QStringLiteral("matcherAssociation"), associationToString(m_association));
config->writeEntry(QStringLiteral("matcherCriteriaCount"), m_criteria.count());
QString criterionGroupPrefix = config->name() + QLatin1StringView("_Criterion");
const int criteriaSize(m_criteria.size());
for (int index = 0; index < criteriaSize; ++index) {
*config = KConfigGroup(config->config(), criterionGroupPrefix + QString::number(index));
m_criteria.at(index).writeConfig(config);
}
}
void ArticleMatcher::readConfig(KConfigGroup *config)
{
m_criteria.clear();
m_association = stringToAssociation(config->readEntry(QStringLiteral("matcherAssociation"), QString()));
const int count = config->readEntry(QStringLiteral("matcherCriteriaCount"), 0);
const QString criterionGroupPrefix = config->name() + QLatin1StringView("_Criterion");
for (int i = 0; i < count; ++i) {
Criterion c;
*config = KConfigGroup(config->config(), criterionGroupPrefix + QString::number(i));
c.readConfig(config);
m_criteria.append(c);
}
}
bool ArticleMatcher::operator==(const AbstractMatcher &other) const
{
auto ptr = const_cast<AbstractMatcher *>(&other);
auto o = dynamic_cast<ArticleMatcher *>(ptr);
if (!o) {
return false;
} else {
return m_association == o->m_association && m_criteria == o->m_criteria;
}
}
bool ArticleMatcher::operator!=(const AbstractMatcher &other) const
{
return !(*this == other);
}
bool ArticleMatcher::anyCriterionMatches(const Article &a) const
{
if (m_criteria.isEmpty()) {
return true;
}
const int criteriaSize(m_criteria.size());
for (int index = 0; index < criteriaSize; ++index) {
if (m_criteria.at(index).satisfiedBy(a)) {
return true;
}
}
return false;
}
bool ArticleMatcher::allCriteriaMatch(const Article &a) const
{
if (m_criteria.isEmpty()) {
return true;
}
const int criteriaSize(m_criteria.size());
for (int index = 0; index < criteriaSize; ++index) {
if (!m_criteria.at(index).satisfiedBy(a)) {
return false;
}
}
return true;
}
ArticleMatcher::Association ArticleMatcher::stringToAssociation(const QString &assocStr)
{
if (assocStr == QLatin1StringView("LogicalAnd")) {
return LogicalAnd;
} else if (assocStr == QLatin1StringView("LogicalOr")) {
return LogicalOr;
} else {
return None;
}
}
QString ArticleMatcher::associationToString(Association association)
{
switch (association) {
case LogicalAnd:
return QStringLiteral("LogicalAnd");
case LogicalOr:
return QStringLiteral("LogicalOr");
default:
return QStringLiteral("None");
}
}
} // namespace Filters
} // namespace Akregator
|