Cutelyst  2.3.0
validatorsame.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 "validatorsame_p.h"
20 
21 using namespace Cutelyst;
22 
23 ValidatorSame::ValidatorSame(const QString &field, const QString &otherField, const char *otherLabel, const Cutelyst::ValidatorMessages &messages, const QString &defValKey) :
24  ValidatorRule(*new ValidatorSamePrivate(field, otherField, otherLabel, messages, defValKey))
25 {
26 }
27 
29 {
30 }
31 
33 {
34  ValidatorReturnType result;
35 
36  Q_D(const ValidatorSame);
37 
38  const QString v = value(params);
39 
40  if (!v.isEmpty()) {
41  const QString ov = trimBefore() ? params.value(d->otherField).trimmed() : params.value(d->otherField);
42  if (v != ov) {
43  result.errorMessage = validationError(c);
44  qCDebug(C_VALIDATOR, "ValidatorSame: Validation failed for field %s at %s::%s: value is not the same as in the field %s", qPrintable(field()), qPrintable(c->controllerName()), qPrintable(c->actionName()), qPrintable(d->otherField));
45  } else {
46  result.value.setValue<QString>(v);
47  }
48  } else {
49  defaultValue(c, &result, "ValidatorSame");
50  }
51 
52  return result;
53 }
54 
55 QString ValidatorSame::genericValidationError(Context *c, const QVariant &errorData) const
56 {
57  QString error;
58 
59  Q_D(const ValidatorSame);
60  Q_UNUSED(errorData);
61  const QString _label = label(c);
62  QString _olabel;
63  if (d->otherLabel) {
64  _olabel = d->translationContext.size() ? c->translate(d->translationContext.data(), d->otherLabel) : QString::fromUtf8(d->otherLabel);
65  } else {
66  _olabel = d->otherField;
67  }
68 
69  if (_label.isEmpty()) {
70  error = QStringLiteral("Must be the same as in the “%1” field.").arg(_olabel);
71  } else {
72  error = QStringLiteral("The “%1” field must have the same value as the “%2” field.").arg(_label, _olabel);
73  }
74 
75  return error;
76 }
QMap< QString, QString > ParamsMultiMap
~ValidatorSame()
Deconstructs the same validator.
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 if validation failed.
The Cutelyst Context.
Definition: context.h:50
bool trimBefore() const
Returns true if the field value should be trimmed before validation.
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.
QString label(Context *c) const
Returns the human readable field label used for generic error messages.
ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override
Performs the validation and returns the result.
ValidatorSame(const QString &field, const QString &otherField, const char *otherLabel=nullptr, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
Constructs a new same validator.
QString value(const ParamsMultiMap &params) const
Returns the value of the field from the input params.
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 ...
The given field must match the field under validation.
Definition: validatorsame.h:55