Cutelyst  2.13.0
validatordigits.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 "validatordigits_p.h"
20 
21 using namespace Cutelyst;
22 
23 ValidatorDigits::ValidatorDigits(const QString &field, const QVariant &length, const Cutelyst::ValidatorMessages &messages, const QString &defValKey) :
24  ValidatorRule(*new ValidatorDigitsPrivate(field, length, messages, defValKey))
25 {
26 }
27 
29 {
30 }
31 
33 {
34  ValidatorReturnType result;
35 
36  Q_D(const ValidatorDigits);
37 
38  const QString v = value(params);
39  bool ok = false;
40  int _length = d->extractInt(c, params, d->length, &ok);
41  if (!ok) {
43  return result;
44  }
45 
46  if (!v.isEmpty()) {
47 
48  if (Q_LIKELY(ValidatorDigits::validate(v, _length))) {
49  if ((_length > 0) && (v.length() != _length)) {
50  result.errorMessage = validationError(c, _length);
51  qCDebug(C_VALIDATOR, "ValidatorDigits: Validation failed for value \"%s\" in field %s at %s::%s: does not contain exactly %i digit(s).", qPrintable(v), qPrintable(field()), qPrintable(c->controllerName()), qPrintable(c->actionName()), _length);
52  } else {
53  result.value.setValue<QString>(v);
54  }
55  } else {
56  result.errorMessage = validationError(c, _length);
57  qCDebug(C_VALIDATOR, "ValidatorDigits: Validation failed for value \"%s\" in field %s at %s::%s: does not only contain digits.", qPrintable(v), qPrintable(field()), qPrintable(c->controllerName()), qPrintable(c->actionName()));
58  }
59 
60  } else {
61  defaultValue(c, &result, "ValidatorDigits");
62  }
63 
64  return result;
65 }
66 
67 bool ValidatorDigits::validate(const QString &value, int length)
68 {
69  bool valid = true;
70 
71  for (const QChar &ch : value) {
72  const ushort &uc = ch.unicode();
73  if (!((uc > 47) && (uc < 58))) {
74  valid = false;
75  break;
76  }
77  }
78 
79  if (valid && (length > 0) && (length != value.length())) {
80  valid = false;
81  }
82 
83  return valid;
84 }
85 
86 QString ValidatorDigits::genericValidationError(Context *c, const QVariant &errorData) const
87 {
88  QString error;
89 
90  const QString _label = label(c);
91  const int _length = errorData.toInt();
92 
93  if (_label.isEmpty()) {
94  if (_length > 0) {
95  error = c->translate("Cutelyst::ValidatorDigits", "Must contain exactly %n digit(s).", "", _length);
96  } else {
97  error = c->translate("Cutelyst::ValidatorDigits", "Must only contain digits.");
98  }
99  } else {
100  if (_length > 0) {
101  //: %1 will be replaced by the field label
102  error = c->translate("Cutelyst::ValidatorDigits", "The “%1” field must contain exactly %n digit(s).", "", _length).arg(_label);
103  } else {
104  //: %1 will be replaced by the field label
105  error = c->translate("Cutelyst::ValidatorDigits", "The “%1” field must only contain digits.").arg(_label);
106  }
107  }
108 
109  return error;
110 }
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::ValidatorDigits::~ValidatorDigits
~ValidatorDigits() override
Deconstructs the digits validator.
Definition: validatordigits.cpp:28
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::ValidatorDigits::genericValidationError
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Returns a generic error if validation failed.
Definition: validatordigits.cpp:86
Cutelyst::ValidatorDigits::validate
static bool validate(const QString &value, int length=-1)
Returns true if value only contains digits.
Definition: validatordigits.cpp:67
Cutelyst
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
Cutelyst::ValidatorReturnType::value
QVariant value
Definition: validatorrule.h:64
Cutelyst::ValidatorDigits::ValidatorDigits
ValidatorDigits(const QString &field, const QVariant &length=-1, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
Constructs a new digits validator.
Definition: validatordigits.cpp:23
Cutelyst::ValidatorReturnType::errorMessage
QString errorMessage
Definition: validatorrule.h:63
Cutelyst::ValidatorRule::validationDataError
QString validationDataError(Context *c, const QVariant &errorData=QVariant()) const
Returns an error message if any validation data is missing or invalid.
Definition: validatorrule.cpp:132
Cutelyst::ValidatorDigits
Checks for digits only with optional length check.
Definition: validatordigits.h:47
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