validatorbefore.cpp

/*
 * SPDX-FileCopyrightText: (C) 2017-2022 Matthias Fehring <mf@huessenbergnetz.de>
 * SPDX-License-Identifier: BSD-3-Clause
 */

#include "validatorbefore_p.h"

#include <QtCore/QLoggingCategory>

using namespace Cutelyst;

Q_LOGGING_CATEGORY(C_VALIDATORBEFORE, "cutelyst.utils.validator.before", QtWarningMsg)

ValidatorBefore::ValidatorBefore(const QString &field,
                                 const QVariant &comparison,
                                 const QString &timeZone,
                                 const char *inputFormat,
                                 const ValidatorMessages &messages,
                                 const QString &defValKey)
    : ValidatorRule(*new ValidatorBeforePrivate(field,
                                                comparison,
                                                timeZone,
                                                inputFormat,
                                                messages,
                                                defValKey))
{
}

ValidatorBefore::~ValidatorBefore()
{
}

ValidatorReturnType ValidatorBefore::validate(Context *c, const ParamsMultiMap &params) const
{
    ValidatorReturnType result;

    Q_D(const ValidatorBefore);

    const QString v = value(params);

    if (!v.isEmpty()) {

        const QTimeZone tz = d->extractTimeZone(c, params, d->timeZone);

        const QVariant _comp =
            (d->comparison.userType() == QMetaType::QString)
                ? d->extractOtherDateTime(c, params, d->comparison.toString(), tz, d->inputFormat)
                : d->comparison;

        if (_comp.userType() == QMetaType::QDate) {

            const QDate odate = _comp.toDate();
            if (Q_UNLIKELY(!odate.isValid())) {
                qCWarning(
                    C_VALIDATOR,
                    "ValidatorBefore: Invalid comparison date and time for field %s at %s::%s.",
                    qPrintable(field()),
                    qPrintable(c->controllerName()),
                    qPrintable(c->actionName()));
                result.errorMessage = validationDataError(c);
            } else {
                const QDate date = d->extractDate(c, v, d->inputFormat);
                if (Q_UNLIKELY(!date.isValid())) {
                    qCWarning(
                        C_VALIDATOR,
                        "ValidatorBefore: Can not parse input date \"%s\" for field %s at %s::%s.",
                        qPrintable(v),
                        qPrintable(field()),
                        qPrintable(c->controllerName()),
                        qPrintable(c->actionName()));
                    result.errorMessage = parsingError(c, odate);
                } else {
                    if (Q_UNLIKELY(date >= odate)) {
                        qCDebug(C_VALIDATOR,
                                "ValidatorBefore: Validation failed at %s::%s for field %s: Input "
                                "date \"%s\" is not before \"%s\".",
                                qPrintable(c->controllerName()),
                                qPrintable(c->actionName()),
                                qPrintable(field()),
                                qPrintable(date.toString()),
                                qPrintable(odate.toString()));
                        result.errorMessage = validationError(c, odate);
                    } else {
                        result.value.setValue(date);
                    }
                }
            }

        } else if (_comp.userType() == QMetaType::QDateTime) {

            const QDateTime odatetime = _comp.toDateTime();
            if (Q_UNLIKELY(!odatetime.isValid())) {
                qCWarning(
                    C_VALIDATOR,
                    "ValidatorBefore: Invalid comparison date and time for field %s at %s::%s.",
                    qPrintable(field()),
                    qPrintable(c->controllerName()),
                    qPrintable(c->actionName()));
                result.errorMessage = validationDataError(c);
            } else {
                const QDateTime datetime = d->extractDateTime(c, v, d->inputFormat, tz);
                if (Q_UNLIKELY(!datetime.isValid())) {
                    qCWarning(C_VALIDATOR,
                              "ValidatorBefore: Can not parse input date and time \"%s\" for field "
                              "%s at %s::%s.",
                              qPrintable(v),
                              qPrintable(field()),
                              qPrintable(c->controllerName()),
                              qPrintable(c->actionName()));
                    result.errorMessage = parsingError(c, odatetime);
                } else {
                    if (Q_UNLIKELY(datetime >= odatetime)) {
                        qCDebug(C_VALIDATOR,
                                "ValidatorBefore: Validation failed at %s::%s for field %s: Input "
                                "date and time \"%s\" is not before \"%s\".",
                                qPrintable(c->controllerName()),
                                qPrintable(c->actionName()),
                                qPrintable(field()),
                                qPrintable(datetime.toString()),
                                qPrintable(odatetime.toString()));
                        result.errorMessage = validationError(c, odatetime);
                    } else {
                        result.value.setValue(datetime);
                    }
                }
            }

        } else if (_comp.userType() == QMetaType::QTime) {

            const QTime otime = _comp.toTime();
            if (Q_UNLIKELY(!otime.isValid())) {
                qCWarning(C_VALIDATOR,
                          "ValidatorBefore: Invalid comparison time for field %s at %s::%s.",
                          qPrintable(field()),
                          qPrintable(c->controllerName()),
                          qPrintable(c->actionName()));
                result.errorMessage = validationDataError(c);
            } else {
                const QTime time = d->extractTime(c, v, d->inputFormat);
                if (Q_UNLIKELY(!time.isValid())) {
                    qCWarning(
                        C_VALIDATOR,
                        "ValidatorBefore: Can not parse input time \"%s\" for field %s at %s::%s.",
                        qPrintable(v),
                        qPrintable(field()),
                        qPrintable(c->controllerName()),
                        qPrintable(c->actionName()));
                    result.errorMessage = parsingError(c, otime);
                } else {
                    if (Q_UNLIKELY(time >= otime)) {
                        qCDebug(C_VALIDATOR,
                                "ValidatorBefore: Validation failed at %s::%s for field %s: Input "
                                "time \"%s\" is not before \"%s\".",
                                qPrintable(c->controllerName()),
                                qPrintable(c->actionName()),
                                qPrintable(field()),
                                qPrintable(time.toString()),
                                qPrintable(otime.toString()));
                        result.errorMessage = validationError(c, otime);
                    } else {
                        result.value.setValue(time);
                    }
                }
            }

        } else {
            qCWarning(C_VALIDATOR)
                << "ValidatorBefore: Invalid validation data for field" << field() << "at"
                << c->controllerName() << "::" << c->actionName() << ":" << d->comparison;
            result.errorMessage = validationDataError(c);
        }
    } else {
        defaultValue(c, &result, "ValidatorAfter");
    }

    return result;
}

QString ValidatorBefore::genericValidationError(Cutelyst::Context *c,
                                                const QVariant &errorData) const
{
    QString error;

    const QString _label = label(c);
    if (_label.isEmpty()) {

        switch (errorData.userType()) {
        case QMetaType::QDate:
            error =
                QStringLiteral("Has to be before %1.")
                    .arg(errorData.toDate().toString(c->locale().dateFormat(QLocale::ShortFormat)));
            break;
        case QMetaType::QDateTime:
            error = QStringLiteral("Has to be before %1.")
                        .arg(errorData.toDateTime().toString(
                            c->locale().dateTimeFormat(QLocale::ShortFormat)));
            break;
        case QMetaType::QTime:
            error =
                QStringLiteral("Has to be before %1.")
                    .arg(errorData.toTime().toString(c->locale().timeFormat(QLocale::ShortFormat)));
            break;
        default:
            error = validationDataError(c);
            break;
        }

    } else {

        switch (errorData.userType()) {
        case QMetaType::QDate:
            error =
                c->translate("Cutelyst::ValidatorBefore",
                             "The date in the “%1” field must be before %2.")
                    .arg(_label,
                         errorData.toDate().toString(c->locale().dateFormat(QLocale::ShortFormat)));
            break;
        case QMetaType::QDateTime:
            error = c->translate("Cutelyst::ValidatorBefore",
                                 "The date and time in the “%1” field must be before %2.")
                        .arg(_label,
                             errorData.toDateTime().toString(
                                 c->locale().dateTimeFormat(QLocale::ShortFormat)));
            break;
        case QMetaType::QTime:
            error =
                c->translate("Cutelyst::ValidatorBefore",
                             "The time in the “%1” field must be before %2.")
                    .arg(_label,
                         errorData.toTime().toString(c->locale().timeFormat(QLocale::ShortFormat)));
            break;
        default:
            error = validationDataError(c);
            break;
        }
    }

    return error;
}

QString ValidatorBefore::genericValidationDataError(Context *c, const QVariant &errorData) const
{
    QString error;

    Q_UNUSED(errorData)
    error =
        c->translate("Cutelyst::ValidatorBefore",
                     "The comparison value is not a valid date and/or time, or cannot be found.");

    return error;
}

QString ValidatorBefore::genericParsingError(Context *c, const QVariant &errorData) const
{
    QString error;

    Q_D(const ValidatorBefore);

    const QString _label = label(c);
    if (d->inputFormat) {
        if (_label.isEmpty()) {
            //: %1 will be replaced by the datetime format
            error =
                c->translate(
                     "Cutelyst::ValidatorBefore",
                     "Could not be parsed according to the following date and/or time format: %1")
                    .arg(c->translate(d->translationContext.data(), d->inputFormat));
        } else {
            //: %1 will be replaced by the field label, %2 will be replaced by the datetime format
            error = c->translate("Cutelyst::ValidatorBefore",
                                 "The value of the “%1” field could not be parsed according to the "
                                 "following date and/or time format: %2")
                        .arg(_label, c->translate(d->translationContext.data(), d->inputFormat));
        }
    } else {

        if (_label.isEmpty()) {
            switch (errorData.userType()) {
            case QMetaType::QDateTime:
                error = c->translate("Cutelyst::ValidatorBefore",
                                     "Could not be parsed as date and time.");
                break;
            case QMetaType::QTime:
                error = c->translate("Cutelyst::ValidatorBefore", "Could not be parsed as time.");
                break;
            case QMetaType::QDate:
                error = c->translate("Cutelyst::ValidatorBefore", "Could not be parsed as date.");
                break;
            default:
                error = validationDataError(c);
                break;
            }
        } else {
            switch (errorData.userType()) {
            case QMetaType::QDateTime:
                //: %1 will be replaced by the field label
                error = c->translate(
                             "Cutelyst::ValidatorBefore",
                             "The value in the “%1” field could not be parsed as date and time.")
                            .arg(_label);
                break;
            case QMetaType::QTime:
                //: %1 will be replaced by the field label
                error = c->translate("Cutelyst::ValidatorBefore",
                                     "The value in the “%1” field could not be parsed as time.")
                            .arg(_label);
                break;
            case QMetaType::QDate:
                //: %1 will be replaced by the field label
                error = c->translate("Cutelyst::ValidatorBefore",
                                     "The value in the “%1” field could not be parsed as date.")
                            .arg(_label);
                break;
            default:
                error = validationDataError(c);
                break;
            }
        }
    }

    return error;
}