Checks if the field value is a valid IP address. More...

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

Inheritance diagram for Cutelyst::ValidatorIp:

Public Types
enum	Constraint { NoConstraint , IPv4Only , IPv6Only , NoPrivateRange , NoReservedRange , NoMultiCast , PublicOnly }
	Acceptable address ranges. More...

Public Member Functions
	ValidatorIp (const QString &field, Constraints constraints=NoConstraint, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())

	~ValidatorIp () 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 bool	validate (const QString &value, Constraints constraints=NoConstraint)
	Returns `true` if value is a valid IP address within the constraints.

Protected Member Functions
QString	genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override

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

This uses QHostAddress internally to check if the field contains a valid IP address. You can use the constraints flags to limit the validator to specific address ranges.

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.

See also: Validator for general usage of validators.

Definition at line 36 of file validatorip.h.

Member Enumeration Documentation

◆ Constraint

enum Cutelyst::ValidatorIp::Constraint

Enumerator
NoConstraint	No address range limit.
IPv4Only	Only IPv4 addresses are valid.
IPv6Only	Only IPv6 addresses are valid.
NoPrivateRange	Addresses from private networks like 192.168.0.0/12 and fe80::/10 are invalid.
NoReservedRange	Addresses from reserved networks like 192.88.99.0/24 and 2001:db8::/32 are invalid.
NoMultiCast	Multicast addresses are invalid.
PublicOnly	Combines NoPrivateRange, NoReservedRange and NoMultiCast.

Definition at line 42 of file validatorip.h.

Constructor & Destructor Documentation

◆ ValidatorIp()

ValidatorIp::ValidatorIp	(	const QString &	field,
		Constraints	constraints = `NoConstraint`,
		const ValidatorMessages &	messages = `ValidatorMessages()`,
		const QString &	defValKey = `QString()`
	)

Constructs a new ValidatorIp object with the given parameters.

Parameters

field	Name of the input field to validate.
constraints	Optional validation constraints.
messages	Custom error message if validation fails.
defValKey	Stash key containing a default value if input field is empty. This value will NOT be validated.

Definition at line 17 of file validatorip.cpp.

◆ ~ValidatorIp()

ValidatorIp::~ValidatorIp ( )

overridedefault

Destroys the ValidatorIp object.

Member Function Documentation

◆ genericValidationError()

QString ValidatorIp::genericValidationError	(	Context *	c,
		const QVariant &	errorData = `QVariant()`
	)		const

overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 256 of file validatorip.cpp.

References QString::arg(), QString::isEmpty(), Cutelyst::ValidatorRule::label(), and Cutelyst::Context::qtTrId().

◆ validate()

ValidatorReturnType ValidatorIp::validate	(	Cutelyst::Context *	c,
		const ParamsMultiMap &	params
	)		const

overrideprotectedvirtual

Performs the validation on the input params and returns the result.

If validation succeeded, ValidatorReturnType::value will contain the input paramter value as QString.

Implements Cutelyst::ValidatorRule.

Definition at line 27 of file validatorip.cpp.

References Cutelyst::ValidatorRule::defaultValue(), Cutelyst::ValidatorReturnType::errorMessage, QString::isEmpty(), QVariant::setValue(), validate(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions