Cutelyst  2.13.0
validatoralpha.cpp
1 /*
2  * Copyright (C) 2017-2018 Matthias Fehring <kontakt@buschmann23.de>
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, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 #include "validatoralpha_p.h"
20 #include <QRegularExpression>
21 
22 using namespace Cutelyst;
23 
24 ValidatorAlpha::ValidatorAlpha(const QString &field, bool asciiOnly, const Cutelyst::ValidatorMessages &messages, const QString &defValKey) :
25  ValidatorRule(*new ValidatorAlphaPrivate(field, asciiOnly, messages, defValKey))
26 {
27 
28 }
29 
31 {
32 
33 }
34 
36 {
37  ValidatorReturnType result;
38 
39  Q_D(const ValidatorAlpha);
40 
41  const QString v = value(params);
42  if (!v.isEmpty()) {
43  if (Q_LIKELY(ValidatorAlpha::validate(v, d->asciiOnly))) {
44  result.value.setValue<QString>(v);
45  } else {
46  qCDebug(C_VALIDATOR, "ValidatorAlhpa: Validation failed for field %s at %s::%s: %s contains characters that are not allowed.", qPrintable(field()), qPrintable(c->controllerName()), qPrintable(c->actionName()), qPrintable(v));
47  result.errorMessage = validationError(c);
48  }
49  } else {
50  defaultValue(c, &result, "ValidatorAlpha");
51  }
52 
53  return result;
54 }
55 
56 bool ValidatorAlpha::validate(const QString &value, bool asciiOnly)
57 {
58  bool valid = true;
59 
60  if (asciiOnly) {
61  for (const QChar &ch : value) {
62  const ushort &uc = ch.unicode();
63  if (!(((uc > 64) && (uc < 91)) || ((uc > 96) && (uc < 123)))) {
64  valid = false;
65  break;
66  }
67  }
68  } else {
69  valid = value.contains(QRegularExpression(QStringLiteral("^[\\pL\\pM]+$")));
70  }
71 
72  return valid;
73 }
74 
75 QString ValidatorAlpha::genericValidationError(Context *c, const QVariant &errorData) const
76 {
77  QString error;
78  Q_UNUSED(errorData)
79  Q_D(const ValidatorAlpha);
80  const QString _label = label(c);
81  if (_label.isEmpty()) {
82  if (d->asciiOnly) {
83  error = c->translate("Cutelyst::ValidatorAlhpa", "Must only contain alphabetical latin characters.");
84  } else {
85  error = c->translate("Cutelyst::ValidatorAlhpa", "Must only contain alphabetical characters.");
86  }
87  } else {
88  if (d->asciiOnly) {
89  //: %1 will be replaced by the field label
90  error = c->translate("Cutelyst::ValidatorAlhpa", "The text in the “%1” field must only contain alphabetical latin characters.").arg(_label);
91  } else {
92  //: %1 will be replaced by the field label
93  error = c->translate("Cutelyst::ValidatorAlhpa", "The text in the “%1” field must only contain alphabetical characters.").arg(_label);
94  }
95  }
96  return error;
97 }
Cutelyst::ParamsMultiMap
QMap< QString, QString > ParamsMultiMap
Definition: paramsmultimap.h:36
Cutelyst::ValidatorMessages
Stores custom error messages and the input field label.
Definition: validatorrule.h:144
Cutelyst::ValidatorRule::value
QString value(const ParamsMultiMap &params) const
Returns the value of the field from the input params.
Definition: validatorrule.cpp:41
Cutelyst::ValidatorRule::label
QString label(Context *c) const
Returns the human readable field label used for generic error messages.
Definition: validatorrule.cpp:58
Cutelyst::ValidatorRule::validationError
QString validationError(Context *c, const QVariant &errorData=QVariant()) const
Returns a descriptive error message if validation failed.
Definition: validatorrule.cpp:72
Cutelyst::ValidatorAlpha::genericValidationError
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Returns a generic error message if validation failed.
Definition: validatoralpha.cpp:75
Cutelyst::ValidatorAlpha
Validates an input field for only alphabetic content.
Definition: validatoralpha.h:54
Cutelyst::Context
The Cutelyst Context.
Definition: context.h:50
Cutelyst::ValidatorRule
Base class for all validator rules.
Definition: validatorrule.h:292
Cutelyst::ValidatorRule::field
QString field() const
Returns the name of the field to validate.
Definition: validatorrule.cpp:39
Cutelyst::ValidatorAlpha::~ValidatorAlpha
~ValidatorAlpha() override
Deconstructs the alpha validator.
Definition: validatoralpha.cpp:30
Cutelyst::Context::translate
QString translate(const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const
Definition: context.cpp:473
Cutelyst::ValidatorReturnType
Contains the result of a single input parameter validation.
Definition: validatorrule.h:62
Cutelyst::ValidatorAlpha::ValidatorAlpha
ValidatorAlpha(const QString &field, bool asciiOnly=false, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
Constructs a new alpha validator.
Definition: validatoralpha.cpp:24
Cutelyst
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
Cutelyst::ValidatorReturnType::value
QVariant value
Definition: validatorrule.h:64
Cutelyst::ValidatorReturnType::errorMessage
QString errorMessage
Definition: validatorrule.h:63
Cutelyst::ValidatorRule::defaultValue
void defaultValue(Context *c, ValidatorReturnType *result, const char *validatorName) const
I a defValKey has been set in the constructor, this will try to get the default value from the stash ...
Definition: validatorrule.cpp:162
Cutelyst::ValidatorAlpha::validate
static bool validate(const QString &value, bool asciiOnly=false)
Returns true if value only contains alphabetic characters.
Definition: validatoralpha.cpp:56