validatoremail.h

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

#include <Cutelyst/cutelyst_global.h>
#include "validatorrule.h"

namespace Cutelyst {

class ValidatorEmailPrivate;

class CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorEmail : public ValidatorRule
{
    Q_GADGET
public:
    enum Category : quint8 {
        Valid           = 1,    
        DNSWarn         = 7,    
        RFC5321         = 15,   
        CFWS            = 31,   
        Deprecated      = 63,   
        RFC5322         = 127,  
        Error           = 255   
    };
    Q_ENUM(Category)

    
    enum Diagnose : quint8 {
        // Address is valid
        ValidAddress            = 0,    
        // Address is valid but a DNS check was not successful
        DnsWarnNoMxRecord       = 5,    
        DnsWarnNoRecord         = 6,    
        // Address is valid for SMTP but has unusual Elements
        RFC5321TLD              = 9,    
        RFC5321TLDNumberic      = 10,   
        RFC5321QuotedString     = 11,   
        RFC5321AddressLiteral   = 12,   
        RFC5321IPv6Deprecated   = 13,   
        // Address is valid within the message but cannot be used unmodified for the envelope
        CFWSComment             = 17,   
        CFWSFWS                 = 18,   
        // Address contains deprecated elements but may still be valid in restricted contexts
        DeprecatedLocalpart     = 33,   
        DeprecatedFWS           = 34,   
        DeprecatedQText         = 35,   
        DeprecatedQP            = 36,   
        DeprecatedComment       = 37,   
        DeprecatedCText         = 38,   
        DeprecatedCFWSNearAt    = 49,   
        // The address in only valid according to the broad definition of RFC 5322. It is otherwise invalid
        RFC5322Domain           = 65,   
        RFC5322TooLong          = 66,   
        RFC5322LocalTooLong     = 67,   
        RFC5322DomainTooLong    = 68,   
        RFC5322LabelTooLong     = 69,   
        RFC5322DomainLiteral    = 70,   
        RFC5322DomLitOBSDText   = 71,   
        RFC5322IPv6GroupCount   = 72,   
        RFC5322IPv62x2xColon    = 73,   
        RFC5322IPv6BadChar      = 74,   
        RFC5322IPv6MaxGroups    = 75,   
        RFC5322IPv6ColonStart   = 76,   
        RFC5322IPv6ColonEnd     = 77,   
        // Address is invalid for any purpose
        ErrorExpectingDText     = 129,  
        ErrorNoLocalPart        = 130,  
        ErrorNoDomain           = 131,  
        ErrorConsecutiveDots    = 132,  
        ErrorATextAfterCFWS     = 133,  
        ErrorATextAfterQS       = 134,  
        ErrorATextAfterDomLit   = 135,  
        ErrorExpectingQpair     = 136,  
        ErrorExpectingAText     = 137,  
        ErrorExpectingQText     = 138,  
        ErrorExpectingCText     = 139,  
        ErrorBackslashEnd       = 140,  
        ErrorDotStart           = 141,  
        ErrorDotEnd             = 142,  
        ErrorDomainHyphenStart  = 143,  
        ErrorDomainHyphenEnd    = 144,  
        ErrorUnclosedQuotedStr  = 145,  
        ErrorUnclosedComment    = 146,  
        ErrorUnclosedDomLiteral = 147,  
        ErrorFWSCRLFx2          = 148,  
        ErrorFWSCRLFEnd         = 149,  
        ErrorCRnoLF             = 150,  
        ErrorFatal              = 254   
    };
    Q_ENUM(Diagnose)

    enum Option : quint8 {
        NoOption    = 0,                    
        CheckDNS    = 1,                    
        UTF8Local   = 2,                    
        AllowIDN    = 4,                    
        AllowUTF8   = UTF8Local|AllowIDN    
    };
    Q_DECLARE_FLAGS(Options, Option)

    
    ValidatorEmail(const QString &field, Category threshold = RFC5321, Options options = NoOption, const ValidatorMessages &messages = ValidatorMessages(), const QString &defValKey = QString());

    ~ValidatorEmail() override;

    static QString diagnoseString(Context *c, Diagnose diagnose, const QString &label = QString());

    static QString categoryString(Context *c, Category category, const QString &label = QString());

    static Category category(Diagnose diagnose);

    static QString categoryString(Context *c, Diagnose diagnose, const QString &label = QString());

    static bool validate(const QString &email, Category threshold = RFC5321, Options options = NoOption, QList<Diagnose> *diagnoses = nullptr);

protected:
    ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override;

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

private:
    Q_DECLARE_PRIVATE(ValidatorEmail)
    Q_DISABLE_COPY(ValidatorEmail)
};

}

Q_DECLARE_OPERATORS_FOR_FLAGS(Cutelyst::ValidatorEmail::Options)

#endif //CUTELYSTVALIDATOREMAIL_H