Cutelyst  2.5.0
validatorconfirmed.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 "validatorconfirmed_p.h"
20 
21 using namespace Cutelyst;
22 
23 ValidatorConfirmed::ValidatorConfirmed(const QString &field, const ValidatorMessages &messages) :
24  ValidatorRule(*new ValidatorConfirmedPrivate(field, messages))
25 {
26 }
27 
29 {
30 }
31 
33 {
34  ValidatorReturnType result;
35 
36  const QString v = value(params);
37 
38  if (!v.isEmpty()) {
39  const QString ofn = field() + QLatin1String("_confirmation");
40  QString ofv = params.value(ofn);
41 
42  if (trimBefore()) {
43  ofv = ofv.trimmed();
44  }
45 
46  if (Q_UNLIKELY(v != ofv)) {
47  result.errorMessage = validationError(c);
48  qCDebug(C_VALIDATOR, "ValidatorConfirmed: Failed to confirm the value in the field %s in %s::%s.", qPrintable(field()), qPrintable(c->controllerName()), qPrintable(c->actionName()));
49  } else {
50  result.value.setValue<QString>(v);
51  }
52  }
53 
54  return result;
55 }
56 
57 QString ValidatorConfirmed::genericValidationError(Context *c, const QVariant &errorData) const
58 {
59  QString error;
60  Q_UNUSED(errorData);
61  const QString _label = label(c);
62  if (_label.isEmpty()) {
63  error = c->translate("Cutelyst::ValidatorConfirmed", "Confirmation failed.");
64  } else {
65  error = c->translate("Cutelyst::ValidatorConfirmed", "The value in the “%1“ field has not been confirmed.").arg(_label);
66  }
67  return error;
68 }
QMap< QString, QString > ParamsMultiMap
~ValidatorConfirmed()
Deconstructs the confirmed validator.
QString validationError(Context *c, const QVariant &errorData=QVariant()) const
Returns a descriptive error message if validation failed.
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Returns a generic error message if validation failed.
Stores custom error messages and the input field label.
The Cutelyst Context.
Definition: context.h:50
bool trimBefore() const
Returns true if the field value should be trimmed before validation.
ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override
Performs the validation and returns the result.
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.
QString value(const ParamsMultiMap &params) const
Returns the value of the field from the input params.
ValidatorConfirmed(const QString &field, const ValidatorMessages &messages=ValidatorMessages())
Constructs a new confirmed validator.
QString field() const
Returns the name of the field to validate.
Contains the result of a single input parameter validation.
Definition: validatorrule.h:62