Cutelyst  3.1.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 
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(v);
51  }
52  }
53 
54  return result;
55 }
56 
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  //: %1 will be replaced by the field label
66  error = c->translate("Cutelyst::ValidatorConfirmed", "The value in the “%1“ field has not been confirmed.").arg(_label);
67  }
68  return error;
69 }
The Cutelyst Context.
Definition: context.h:52
QString translate(const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const
Definition: context.cpp:480
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Returns a generic error message if validation failed.
~ValidatorConfirmed() override
Deconstructs the confirmed validator.
ValidatorConfirmed(const QString &field, const ValidatorMessages &messages=ValidatorMessages())
Constructs a new confirmed validator.
ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override
Performs the validation and returns the result.
Base class for all validator rules.
QString label(Context *c) const
Returns the human readable field label used for generic error messages.
QString field() const
Returns the name of the field to validate.
bool trimBefore() const
Returns true if the field value should be trimmed before validation.
QString value(const ParamsMultiMap &params) const
Returns the value of the field from the input params.
QString validationError(Context *c, const QVariant &errorData=QVariant()) const
Returns a descriptive error message if validation failed.
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:8
const T value(const Key &key, const T &defaultValue) const const
QString arg(qlonglong a, int fieldWidth, int base, QChar fillChar) const const
bool isEmpty() const const
QString trimmed() const const
void setValue(const T &value)
Stores custom error messages and the input field label.
Contains the result of a single input parameter validation.
Definition: validatorrule.h:62