validatorrule.h

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

#include <Cutelyst/cutelyst_global.h>
#include <Cutelyst/paramsmultimap.h>

#include <QLoggingCategory>
#include <QScopedPointer>
#include <QVariant>

Q_DECLARE_LOGGING_CATEGORY(C_VALIDATOR)

namespace Cutelyst {

class Context;

struct CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorReturnType {
    QString errorMessage; 
    QVariant value;       
    QVariant extra; 
    explicit operator bool() const { return errorMessage.isNull(); }

    bool isValid() const { return errorMessage.isNull(); }
};

struct CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorMessages {
    ValidatorMessages() {}
    ValidatorMessages(const char *customLabel,
                      const char *customValidationError     = nullptr,
                      const char *customParsingError        = nullptr,
                      const char *customValidationDataError = nullptr)
        : label(customLabel)
        , validationError(customValidationError)
        , parsingError(customParsingError)
        , validationDataError(customValidationDataError)
    {
    }
    const char *label = nullptr; 
    const char *validationError     = nullptr; 
    const char *parsingError        = nullptr; 
    const char *validationDataError = nullptr; 
};

class ValidatorRulePrivate;

class CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorRule
{
public:
    ValidatorRule(const QString &field,
                  const ValidatorMessages &messages = ValidatorMessages(),
                  const QString &defValKey          = QString());

    virtual ~ValidatorRule();

protected:
    const QScopedPointer<ValidatorRulePrivate> d_ptr;
    ValidatorRule(ValidatorRulePrivate &dd);

    virtual ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const = 0;

    QString field() const;

    QString label(Context *c) const;

    QString value(const ParamsMultiMap &params) const;

    bool trimBefore() const;

    QString validationError(Context *c, const QVariant &errorData = QVariant()) const;

    virtual QString genericValidationError(Context *c,
                                           const QVariant &errorData = QVariant()) const;

    QString parsingError(Context *c, const QVariant &errorData = QVariant()) const;

    virtual QString genericParsingError(Context *c, const QVariant &errorData = QVariant()) const;

    QString validationDataError(Context *c, const QVariant &errorData = QVariant()) const;

    virtual QString genericValidationDataError(Context *c,
                                               const QVariant &errorData = QVariant()) const;

    void defaultValue(Context *c, ValidatorReturnType *result, const char *validatorName) const;

private:
    Q_DECLARE_PRIVATE(ValidatorRule)
    Q_DISABLE_COPY(ValidatorRule)

    
    void setTranslationContext(QLatin1String trContext);

    void setTrimBefore(bool trimBefore);

    friend class Validator;
    friend class ValidatorPrivate;
};

} // namespace Cutelyst

#endif // CUTELYSTVALIDATORRULE_H