Cutelyst  2.13.0
validatordatetime.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 "validatordatetime_p.h"
20 
21 #include <QDateTime>
22 
23 using namespace Cutelyst;
24 
25 ValidatorDateTime::ValidatorDateTime(const QString &field, const QString &timeZone, const char *inputFormat, const ValidatorMessages &messages, const QString &defValKey) :
26  ValidatorRule(*new ValidatorDateTimePrivate(field, timeZone, inputFormat, messages, defValKey))
27 {
28 }
29 
31 {
32 }
33 
35 {
36  ValidatorReturnType result;
37 
38  Q_D(const ValidatorDateTime);
39 
40  const QString v = value(params);
41 
42  if (!v.isEmpty()) {
43  const QTimeZone tz = d->extractTimeZone(c, params, d->timeZone);
44  const QDateTime dt = d->extractDateTime(c, v, d->inputFormat, tz);
45 
46  if (!dt.isValid()) {
47  result.errorMessage = validationError(c);
48  qCDebug(C_VALIDATOR, "ValidatorDateTime: Validation failed for value \"%s\" in field %s in %s::%s: not a valid date and time.", qPrintable(v), qPrintable(field()), qPrintable(c->controllerName()), qPrintable(c->actionName()));
49  } else {
50  result.value.setValue<QDateTime>(dt);
51  }
52 
53  } else {
54  defaultValue(c, &result, "ValidatorDateTime");
55  }
56 
57  return result;
58 }
59 
60 QString ValidatorDateTime::genericValidationError(Context *c, const QVariant &errorData) const
61 {
62  QString error;
63 
64  Q_D(const ValidatorDateTime);
65  Q_UNUSED(errorData)
66 
67  const QString _label = label(c);
68 
69  if (_label.isEmpty()) {
70 
71  if (d->inputFormat) {
72  //: %1 will be replaced by the datetime format
73  error = c->translate("Cutelyst::ValidatorDateTime", "Not a valid date and time according to the following format: %1").arg(c->translate(d->translationContext.data(), d->inputFormat));
74  } else {
75  error = c->translate("Cutelyst::ValidatorDateTime", "Not a valid date and time.");
76  }
77 
78  } else {
79 
80  if (d->inputFormat) {
81  //: %1 will be replaced by the field label, %2 will be replaced by the datetime format
82  error = c->translate("Cutelyst::ValidatorDateTime", "The value in the “%1” field can not be parsed as date and time according to the following date and time format: %2").arg(_label, c->translate(d->translationContext.data(), d->inputFormat));
83  } else {
84  //: %1 will be replaced by the field label
85  error = c->translate("Cutelyst::ValidatorDateTime", "The value in the “%1” field can not be parsed as date and time.").arg(_label);
86  }
87  }
88 
89  return error;
90 }
Cutelyst::ValidatorDateTime
Checks if the input data is a valid datetime.
Definition: validatordatetime.h:55
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::ValidatorDateTime::genericValidationError
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Returns a generic error if validation failed.
Definition: validatordatetime.cpp:60
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::Context
The Cutelyst Context.
Definition: context.h:50
Cutelyst::ValidatorDateTime::validate
ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override
Performs the validation and returns the result.
Definition: validatordatetime.cpp:34
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::ValidatorDateTime::ValidatorDateTime
ValidatorDateTime(const QString &field, const QString &timeZone, const char *inputFormat=nullptr, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
Constructs a new datetime validator.
Definition: validatordatetime.cpp:25
Cutelyst::ValidatorDateTime::~ValidatorDateTime
~ValidatorDateTime() override
Deconstructs the datetime validator.
Definition: validatordatetime.cpp:30
Cutelyst
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
Cutelyst::ValidatorReturnType::value
QVariant value
Definition: validatorrule.h:64
Cutelyst::ValidatorReturnType::errorMessage
QString errorMessage
Definition: validatorrule.h:63
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