Skip to content

Commit caa0c6c

Browse files
W0rmaW0rma
authored
fix: Succeed format validation if the type is not in the set of given instance types (#773) (#773)
See https://json-schema.org/draft-04/draft-fge-json-schema-validation-00#rfc.section.7.1: If the type of the instance to validate is not in this set, validation for this format attribute and instance SHOULD succeed.
1 parent d212eca commit caa0c6c

File tree

3 files changed

+50
-8
lines changed

3 files changed

+50
-8
lines changed

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1919
- Fix wrong combined paths when traversing upward, fixes #557 ([#652](https://github.com/jsonrainbow/json-schema/pull/652))
2020
- Correct PHPStan baseline ([#764](https://github.com/jsonrainbow/json-schema/pull/764))
2121
- Correct spacing issue in `README.md` ([#763](https://github.com/jsonrainbow/json-schema/pull/763))
22+
- Format attribute: do not validate data instances that aren't the instance type to validate ([#773](https://github.com/jsonrainbow/json-schema/pull/773))
2223

2324
### Changed
2425
- Bump to minimum PHP 7.2 ([#746](https://github.com/jsonrainbow/json-schema/pull/746))

‎src/JsonSchema/Constraints/FormatConstraint.php

+20-8
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public function check(&$element, $schema = null, ?JsonPointer $path = null, $i =
3535

3636
switch ($schema->format) {
3737
case 'date':
38-
if (!$date = $this->validateDateTime($element, 'Y-m-d')) {
38+
if (is_string($element) && !$date = $this->validateDateTime($element, 'Y-m-d')) {
3939
$this->addError(ConstraintError::FORMAT_DATE(), $path, [
4040
'date' => $element,
4141
'format' => $schema->format
@@ -45,7 +45,7 @@ public function check(&$element, $schema = null, ?JsonPointer $path = null, $i =
4545
break;
4646

4747
case 'time':
48-
if (!$this->validateDateTime($element, 'H:i:s')) {
48+
if (is_string($element) && !$this->validateDateTime($element, 'H:i:s')) {
4949
$this->addError(ConstraintError::FORMAT_TIME(), $path, [
5050
'time' => json_encode($element),
5151
'format' => $schema->format,
@@ -55,7 +55,7 @@ public function check(&$element, $schema = null, ?JsonPointer $path = null, $i =
5555
break;
5656

5757
case 'date-time':
58-
if (null === Rfc3339::createFromString($element)) {
58+
if (is_string($element) && null === Rfc3339::createFromString($element)) {
5959
$this->addError(ConstraintError::FORMAT_DATE_TIME(), $path, [
6060
'dateTime' => json_encode($element),
6161
'format' => $schema->format
@@ -101,14 +101,14 @@ public function check(&$element, $schema = null, ?JsonPointer $path = null, $i =
101101
break;
102102

103103
case 'uri':
104-
if (null === filter_var($element, FILTER_VALIDATE_URL, FILTER_NULL_ON_FAILURE)) {
104+
if (is_string($element) && null === filter_var($element, FILTER_VALIDATE_URL, FILTER_NULL_ON_FAILURE)) {
105105
$this->addError(ConstraintError::FORMAT_URL(), $path, ['format' => $schema->format]);
106106
}
107107
break;
108108

109109
case 'uriref':
110110
case 'uri-reference':
111-
if (null === filter_var($element, FILTER_VALIDATE_URL, FILTER_NULL_ON_FAILURE)) {
111+
if (is_string($element) && null === filter_var($element, FILTER_VALIDATE_URL, FILTER_NULL_ON_FAILURE)) {
112112
// FILTER_VALIDATE_URL does not conform to RFC-3986, and cannot handle relative URLs, but
113113
// the json-schema spec uses RFC-3986, so need a bit of hackery to properly validate them.
114114
// See https://tools.ietf.org/html/rfc3986#section-4.2 for additional information.
@@ -133,20 +133,20 @@ public function check(&$element, $schema = null, ?JsonPointer $path = null, $i =
133133
break;
134134

135135
case 'email':
136-
if (null === filter_var($element, FILTER_VALIDATE_EMAIL, FILTER_NULL_ON_FAILURE | FILTER_FLAG_EMAIL_UNICODE)) {
136+
if (is_string($element) && null === filter_var($element, FILTER_VALIDATE_EMAIL, FILTER_NULL_ON_FAILURE | FILTER_FLAG_EMAIL_UNICODE)) {
137137
$this->addError(ConstraintError::FORMAT_EMAIL(), $path, ['format' => $schema->format]);
138138
}
139139
break;
140140

141141
case 'ip-address':
142142
case 'ipv4':
143-
if (null === filter_var($element, FILTER_VALIDATE_IP, FILTER_NULL_ON_FAILURE | FILTER_FLAG_IPV4)) {
143+
if (is_string($element) && null === filter_var($element, FILTER_VALIDATE_IP, FILTER_NULL_ON_FAILURE | FILTER_FLAG_IPV4)) {
144144
$this->addError(ConstraintError::FORMAT_IP(), $path, ['format' => $schema->format]);
145145
}
146146
break;
147147

148148
case 'ipv6':
149-
if (null === filter_var($element, FILTER_VALIDATE_IP, FILTER_NULL_ON_FAILURE | FILTER_FLAG_IPV6)) {
149+
if (is_string($element) && null === filter_var($element, FILTER_VALIDATE_IP, FILTER_NULL_ON_FAILURE | FILTER_FLAG_IPV6)) {
150150
$this->addError(ConstraintError::FORMAT_IP(), $path, ['format' => $schema->format]);
151151
}
152152
break;
@@ -186,11 +186,19 @@ protected function validateDateTime($datetime, $format)
186186

187187
protected function validateRegex($regex)
188188
{
189+
if (!is_string($regex)) {
190+
return true;
191+
}
192+
189193
return false !== @preg_match(self::jsonPatternToPhpRegex($regex), '');
190194
}
191195

192196
protected function validateColor($color)
193197
{
198+
if (!is_string($color)) {
199+
return true;
200+
}
201+
194202
if (in_array(strtolower($color), ['aqua', 'black', 'blue', 'fuchsia',
195203
'gray', 'green', 'lime', 'maroon', 'navy', 'olive', 'orange', 'purple',
196204
'red', 'silver', 'teal', 'white', 'yellow'])) {
@@ -215,6 +223,10 @@ protected function validatePhone($phone)
215223

216224
protected function validateHostname($host)
217225
{
226+
if (!is_string($host)) {
227+
return true;
228+
}
229+
218230
$hostnameRegex = '/^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$/i';
219231

220232
return preg_match($hostnameRegex, $host);

‎tests/Constraints/FormatTest.php

+29
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,14 @@ public function getValidFormats(): array
100100
return [
101101
['2001-01-23', 'date'],
102102
['2000-02-29', 'date'],
103+
[42, 'date'],
104+
[4.2, 'date'],
103105

104106
['12:22:01', 'time'],
105107
['00:00:00', 'time'],
106108
['23:59:59', 'time'],
109+
[42, 'time'],
110+
[4.2, 'time'],
107111

108112
['2000-05-01T12:12:12Z', 'date-time'],
109113
['2000-05-01T12:12:12+0100', 'date-time'],
@@ -114,6 +118,8 @@ public function getValidFormats(): array
114118
['2000-05-01T12:12:12.0Z', 'date-time'],
115119
['2000-05-01T12:12:12.000Z', 'date-time'],
116120
['2000-05-01T12:12:12.000000Z', 'date-time'],
121+
[42, 'date-time'],
122+
[4.2, 'date-time'],
117123

118124
['0', 'utc-millisec'],
119125

@@ -136,6 +142,8 @@ public function getValidFormats(): array
136142
['yellow', 'color'],
137143
['#fff', 'color'],
138144
['#00cc00', 'color'],
145+
[42, 'color'],
146+
[4.2, 'color'],
139147

140148
['background: blue', 'style'],
141149
['color: #000;', 'style'],
@@ -149,18 +157,39 @@ public function getValidFormats(): array
149157
['./relative:PathReference/', 'uri-reference'],
150158
['relativePathReference/', 'uri-reference'],
151159
['relative/Path:Reference/', 'uri-reference'],
160+
[42, 'uri-reference'],
161+
[4.2, 'uri-reference'],
152162

153163
['info@something.edu', 'email'],
164+
[42, 'email'],
165+
[4.2, 'email'],
154166

155167
['10.10.10.10', 'ip-address'],
156168
['127.0.0.1', 'ip-address'],
169+
[42, 'ip-address'],
170+
[4.2, 'ip-address'],
171+
172+
['127.0.0.1', 'ipv4'],
173+
[42, 'ipv4'],
174+
[4.2, 'ipv4'],
157175

158176
['::ff', 'ipv6'],
177+
[42, 'ipv6'],
178+
[4.2, 'ipv6'],
159179

160180
['www.example.com', 'host-name'],
161181
['3v4l.org', 'host-name'],
162182
['a-valid-host.com', 'host-name'],
163183
['localhost', 'host-name'],
184+
[42, 'host-name'],
185+
[4.2, 'host-name'],
186+
187+
['www.example.com', 'hostname'],
188+
['3v4l.org', 'hostname'],
189+
['a-valid-host.com', 'hostname'],
190+
['localhost', 'hostname'],
191+
[42, 'hostname'],
192+
[4.2, 'hostname'],
164193

165194
['anything', '*'],
166195
['unknown', '*'],

0 commit comments

Comments
 (0)