Cutelyst  2.5.0
validatoralphadash.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 "validatoralphadash_p.h"
20 #include <QRegularExpression>
21 
22 using namespace Cutelyst;
23 
24 ValidatorAlphaDash::ValidatorAlphaDash(const QString &field, bool asciiOnly, const ValidatorMessages &messages, const QString &defValKey) :
25  ValidatorRule(*new ValidatorAlphaDashPrivate(field, asciiOnly, messages, defValKey))
26 {
27 
28 }
29 
31 {
32 
33 }
34 
36 {
37  ValidatorReturnType result;
38 
39  Q_D(const ValidatorAlphaDash);
40 
41  const QString v = value(params);
42  if (!v.isEmpty()) {
43  if (Q_LIKELY(ValidatorAlphaDash::validate(v, d->asciiOnly))) {
44  result.value.setValue<QString>(v);
45  } else {
46  qCDebug(C_VALIDATOR, "ValidatorAlphaDash: 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, "ValidatorAlphaDash");
51  }
52 
53  return result;
54 }
55 
56 bool ValidatorAlphaDash::validate(const QString &value, bool asciiOnly)
57 {
58  bool valid = true;
59  if (asciiOnly) {
60  for (const QChar &ch : value) {
61  const ushort &uc = ch.unicode();
62  if (!(((uc > 64) && (uc < 91)) || ((uc > 96) && (uc < 123)) || ((uc > 47) && (uc < 58)) || (uc == 45) || (uc == 95))) {
63  valid = false;
64  break;
65  }
66  }
67  } else {
68  valid = value.contains(QRegularExpression(QStringLiteral("^[\\pL\\pM\\pN_-]+$")));
69  }
70  return valid;
71 }
72 
73 QString ValidatorAlphaDash::genericValidationError(Cutelyst::Context *c, const QVariant &errorData) const
74 {
75  QString error;
76  Q_UNUSED(errorData)
77  const QString _label = label(c);
78  if (_label.isEmpty()) {
79  error = c->translate("Cutelyst::ValidatorAlphaDash", "Can only contain alpha-numeric characters, dashes and underscores.");
80  } else {
81  error = c->translate("Cutelyst::ValidatorAlphaDash", "The “%1” field can only contain alpha-numeric characters, as well as dashes and underscores, but nothing else.").arg(_label);
82  }
83  return error;
84 }
QMap< QString, QString > ParamsMultiMap
QString validationError(Context *c, const QVariant &errorData=QVariant()) const
Returns a descriptive error message if validation failed.
Stores custom error messages and the input field label.
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Returns a generic error message.
static bool validate(const QString &value, bool asciiOnly=false)
Returns true if the value only contains alpha-numeric characters, dashes and underscores.
The Cutelyst Context.
Definition: context.h:50
QString translate(const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const
Definition: context.cpp:414
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
Base class for all validator rules.
~ValidatorAlphaDash()
Deconstructs the alpha dash validator.
QString label(Context *c) const
Returns the human readable field label used for generic error messages.
QString value(const ParamsMultiMap &params) const
Returns the value of the field from the input params.
ValidatorAlphaDash(const QString &field, bool asciiOnly=false, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
Constructs a new alpha dash validator.
Checks a value for only alpha-numeric content and dashes and underscores.
QString field() const
Returns the name of the field to validate.
Contains the result of a single input parameter validation.
Definition: validatorrule.h:62
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 ...