Cutelyst  2.13.0
validatorip.h
1 /*
2  * Copyright (C) 2017-2018 Matthias Fehring <kontakt@buschmann23.de>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 #ifndef CUTELYSTVALIDATORIP_H
19 #define CUTELYSTVALIDATORIP_H
20 
21 #include <Cutelyst/cutelyst_global.h>
22 #include "validatorrule.h"
23 
24 namespace Cutelyst {
25 
26 class ValidatorIpPrivate;
27 
44 class CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorIp : public ValidatorRule
45 {
46 public:
50  enum Constraint {
51  NoConstraint = 0,
52  IPv4Only = 1,
53  IPv6Only = 2,
54  NoPrivateRange = 4,
55  NoReservedRange = 8,
56  NoMultiCast = 16,
57  PublicOnly = 32
58  };
59  Q_DECLARE_FLAGS(Constraints, Constraint)
60 
61 
68  ValidatorIp(const QString &field, Constraints constraints = NoConstraint, const ValidatorMessages &messages = ValidatorMessages(), const QString &defValKey = QString());
69 
73  ~ValidatorIp() override;
74 
82  static bool validate(const QString &value, Constraints constraints = NoConstraint);
83 
84 protected:
91  ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override;
92 
96  QString genericValidationError(Context *c, const QVariant &errorData = QVariant()) const override;
97 
98 private:
99  Q_DECLARE_PRIVATE(ValidatorIp)
100  Q_DISABLE_COPY(ValidatorIp)
101 };
102 
103 }
104 
105 Q_DECLARE_OPERATORS_FOR_FLAGS(Cutelyst::ValidatorIp::Constraints)
106 
107 #endif //CUTELYSTVALIDATORIP_H
108 
Cutelyst::ParamsMultiMap
QMap< QString, QString > ParamsMultiMap
Definition: paramsmultimap.h:36
Cutelyst::ValidatorMessages
Stores custom error messages and the input field label.
Definition: validatorrule.h:144
Cutelyst::Context
The Cutelyst Context.
Definition: context.h:50
Cutelyst::ValidatorRule
Base class for all validator rules.
Definition: validatorrule.h:292
Cutelyst::ValidatorIp
Checks if the field value is a valid IP address.
Definition: validatorip.h:44
Cutelyst::ValidatorReturnType
Contains the result of a single input parameter validation.
Definition: validatorrule.h:62
Cutelyst::ValidatorIp::Constraint
Constraint
Acceptable address ranges.
Definition: validatorip.h:50
Cutelyst
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7