Checks if the value of the input field contains a FQDN according to RFC 1035. More...

#include <Cutelyst/Plugins/Utils/validatordomain.h>

Inheritance diagram for Cutelyst::ValidatorDomain:

Public Types
enum	Diagnose : quint8 { Valid , MissingDNS , InvalidChars , LabelTooLong , TooLong , InvalidLabelCount , EmptyLabel , InvalidTLD , DashStart , DashEnd , DigitStart , DNSTimeout }
	Possible diagnose information for the checked domain. More...

Public Member Functions
	ValidatorDomain (const QString &field, bool checkDNS=false, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
	Constructs a new ValidatorDomain object with the given parameters.

	~ValidatorDomain () override

Public Member Functions inherited from Cutelyst::ValidatorRule
	ValidatorRule (const QString &field, const ValidatorMessages &messages={}, const QString &defValKey={}, QByteArrayView validatorName=nullptr)

virtual	~ValidatorRule ()
	Deconstructs the ValidatorRule.

Static Public Member Functions
static QString	diagnoseString (Context *c, Diagnose diagnose, const QString &label=QString())

static bool	validate (const QString &value, bool checkDNS, Diagnose diagnose=nullptr, QString extractedValue=nullptr)
	Returns `true` if value is a valid fully qualified domain name.

Protected Member Functions
QString	genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override
	Returns a generic error message if validation failed.

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

Protected Member Functions inherited from Cutelyst::ValidatorRule
	ValidatorRule (ValidatorRulePrivate &dd)

QString	debugString (Context *c) const

void	defaultValue (Context c, ValidatorReturnType result) const

QString	field () const noexcept

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

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

QString	label (Context *c) const

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

bool	trimBefore () const noexcept

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

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

QString	value (const ParamsMultiMap &params) const

Detailed Description

The field under validation must contain a fully qualified domain name according to RFC 1035. If checkDNS is set to false, there will be no check if the domain is known to the domain name system, the validator will only check conformance to RFC 1035. Internationalized domain names will first be converted into puny code according to IDNA.

Note: Unless validation is started with NoTrimming, whitespaces will be removed from the beginning and the end of the input value before validation. If the field's value is empty or if the field is missing in the input data, the validation will succeed without performing the validation itself. Use one of the required validators to require the field to be present and not empty.

Return type: On success, ValidatorReturnType::value will contain a QString with the ACE version of the domain name.

See also: Validator for general usage of validators.

Definition at line 41 of file validatordomain.h.

Member Enumeration Documentation

◆ Diagnose

enum Cutelyst::ValidatorDomain::Diagnose : quint8

Enumerator
Valid	The domain name is valid. If checkDNS has been set to `false`, this says nothing about the existence of the domain in the DNS.
MissingDNS	The domain name is valid according to RFC 1035, but there could be no DNS entry found for it.
InvalidChars	The domain name contains chars that are not allowed.
LabelTooLong	At least one of the domain name labels exceeds the maximum size of 63 chars.
TooLong	The whole domain name exceeds the maximum size of 253 chars.
InvalidLabelCount	Not a valid domain name because it has either no labels or only the TLD.
EmptyLabel	At least one of the domain name labels is empty.
InvalidTLD	The TLD label contains characters that are not allowed.
DashStart	At least one label starts with a dash.
DashEnd	At least one label ends with a dash.
DigitStart	At least one label starts with a digit.
DNSTimeout	The DNS lookup took too long.

Definition at line 48 of file validatordomain.h.

Constructor & Destructor Documentation

◆ ValidatorDomain()

ValidatorDomain::ValidatorDomain	(	const QString &	field,
		bool	checkDNS = `false`,
		const ValidatorMessages &	messages = `ValidatorMessages()`,
		const QString &	defValKey = `QString()`
	)

Parameters

field	Name of the input field to validate.
checkDNS	If `true`, a DNS lookup will be performed to check if the domain name exists in the domain name system.
messages	Custom error messages if validation fails.
defValKey	Stash key containing a default value if input field is empty. This value will NOT be validated.

Definition at line 16 of file validatordomain.cpp.

◆ ~ValidatorDomain()

ValidatorDomain::~ValidatorDomain ( )

overridedefault

Destroys the ValidatorDomain object.

Member Function Documentation

◆ diagnoseString()

QString ValidatorDomain::diagnoseString	(	Context *	c,
		Diagnose	diagnose,
		const QString &	label = `QString()`
	)

static

Returns a human readable description of a Diagnose.

Parameters

c	Current Context, used for translations.
diagnose	The Diagnose to get the description for.
label	Optinonal label that will be part of the diagnose string if not empty.