Cutelyst  2.13.0
validatoralphanum.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 "validatoralphanum_p.h"
20 #include <QRegularExpression>
21 
22 using namespace Cutelyst;
23 
24 ValidatorAlphaNum::ValidatorAlphaNum(const QString &field, bool asciiOnly, const ValidatorMessages &messages, const QString &defValKey) :
25  ValidatorRule(*new ValidatorAlphaNumPrivate(field, asciiOnly, messages, defValKey))
26 {
27 
28 }
29 
31 {
32 
33 }
34 
36 {
37  ValidatorReturnType result;
38 
39  Q_D(const ValidatorAlphaNum);
40 
41  const QString v = value(params);
42  if (!v.isEmpty()) {
43  if (Q_LIKELY(ValidatorAlphaNum::validate(v, d->asciiOnly))) {
44  result.value.setValue<QString>(v);
45  } else {
46  qCDebug(C_VALIDATOR, "ValidatorAlphaNum: 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 
50  } else {
51  defaultValue(c, &result, "ValidatorAlphaNum");
52  }
53 
54  return result;
55 }
56 
57 bool ValidatorAlphaNum::validate(const QString &value, bool asciiOnly)
58 {
59  bool valid = true;
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)) || ((uc > 47) && (uc < 58)))) {
64  valid = false;
65  break;
66  }
67  }
68  } else {
69  valid = value.contains(QRegularExpression(QStringLiteral("^[\\pL\\pM\\pN]+$")));
70  }
71  return valid;
72 }
73 
74 QString ValidatorAlphaNum::genericValidationError(Context *c, const QVariant &errorData) const
75 {
76  QString error;
77  Q_UNUSED(errorData)
78  Q_D(const ValidatorAlphaNum);
79  const QString _label = label(c);
80  if (_label.isEmpty()) {
81  if (d->asciiOnly) {
82  error = c->translate("Cutelyst::ValidatorAlphaNum", "Must only contain alpha-numeric latin characters.");
83  } else {
84  error = c->translate("Cutelyst::ValidatorAlphaNum", "Must only contain alpha-numeric characters.");
85  }
86  } else {
87  if (d->asciiOnly) {
88  //: %1 will be replaced by the field label
89  error = c->translate("Cutelyst::ValidatorAlphaNum", "The text in the “%1” field must only contain alpha-numeric latin characters.").arg(_label);
90  } else {
91  //: %1 will be replaced by the field label
92  error = c->translate("Cutelyst::ValidatorAlphaNum", "The text in the “%1” field must only contain alpha-numeric characters.").arg(_label);
93  }
94  }
95  return error;
96 }
Cutelyst::ValidatorAlphaNum
Checks a value for only alpha-numeric content.
Definition: validatoralphanum.h:53
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::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::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::ValidatorAlphaNum::~ValidatorAlphaNum
~ValidatorAlphaNum() override
Deconstructs the alpha num validator.
Definition: validatoralphanum.cpp:30
Cutelyst::ValidatorAlphaNum::genericValidationError
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Returns a generic error message.
Definition: validatoralphanum.cpp:74
Cutelyst::ValidatorAlphaNum::ValidatorAlphaNum
ValidatorAlphaNum(const QString &field, bool asciiOnly=false, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
Constructs a new alpha num validator.
Definition: validatoralphanum.cpp:24
Cutelyst
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
Cutelyst::ValidatorAlphaNum::validate
static bool validate(const QString &value, bool asciiOnly=false)
Returns true if value only contains alpha-numeric characters.
Definition: validatoralphanum.cpp:57
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