-
-
Notifications
You must be signed in to change notification settings - Fork 369
Expand file tree
/
Copy pathSchemaStorage.php
More file actions
245 lines (207 loc) · 8.23 KB
/
SchemaStorage.php
File metadata and controls
245 lines (207 loc) · 8.23 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
<?php
declare(strict_types=1);
namespace JsonSchema;
use JsonSchema\Constraints\BaseConstraint;
use JsonSchema\Entity\JsonPointer;
use JsonSchema\Exception\UnresolvableJsonPointerException;
use JsonSchema\Uri\UriResolver;
use JsonSchema\Uri\UriRetriever;
class SchemaStorage implements SchemaStorageInterface
{
public const INTERNAL_PROVIDED_SCHEMA_URI = 'internal://provided-schema/';
protected $uriRetriever;
protected $uriResolver;
protected $schemas = [];
public function __construct(
?UriRetrieverInterface $uriRetriever = null,
?UriResolverInterface $uriResolver = null
) {
$this->uriRetriever = $uriRetriever ?: new UriRetriever();
$this->uriResolver = $uriResolver ?: new UriResolver();
}
/**
* @return UriRetrieverInterface
*/
public function getUriRetriever()
{
return $this->uriRetriever;
}
/**
* @return UriResolverInterface
*/
public function getUriResolver()
{
return $this->uriResolver;
}
/**
* {@inheritdoc}
*/
public function addSchema(string $id, $schema = null): void
{
if (is_null($schema) && $id !== self::INTERNAL_PROVIDED_SCHEMA_URI) {
// if the schema was user-provided to Validator and is still null, then assume this is
// what the user intended, as there's no way for us to retrieve anything else. User-supplied
// schemas do not have an associated URI when passed via Validator::validate().
$schema = $this->uriRetriever->retrieve($id);
}
// cast array schemas to object
if (is_array($schema)) {
$schema = BaseConstraint::arrayToObjectRecursive($schema);
}
// workaround for bug in draft-03 & draft-04 meta-schemas (id & $ref defined with incorrect format)
// see https://github.com/json-schema-org/JSON-Schema-Test-Suite/issues/177#issuecomment-293051367
if (is_object($schema) && property_exists($schema, 'id')) {
if ($schema->id === DraftIdentifiers::DRAFT_4) {
$schema->properties->id->format = 'uri-reference';
} elseif ($schema->id === DraftIdentifiers::DRAFT_3) {
$schema->properties->id->format = 'uri-reference';
$schema->properties->{'$ref'}->format = 'uri-reference';
}
}
$this->scanForSubschemas($schema, $id);
// resolve references
$this->expandRefs($schema, $id);
$this->schemas[$id] = $schema;
}
/**
* Recursively resolve all references against the provided base
*
* @param mixed $schema
* @param list<string> $propertyStack
*/
private function expandRefs(&$schema, ?string $parentId = null, array $propertyStack = []): void
{
if (!is_object($schema)) {
if (is_array($schema)) {
foreach ($schema as &$member) {
$this->expandRefs($member, $parentId);
}
}
return;
}
if (property_exists($schema, '$ref') && is_string($schema->{'$ref'})) {
$refPointer = new JsonPointer($this->uriResolver->resolve($schema->{'$ref'}, $parentId));
$schema->{'$ref'} = (string) $refPointer;
}
$parentProperty = array_slice($propertyStack, -1)[0] ?? '';
foreach ($schema as $propertyName => &$member) {
if ($parentProperty !== 'properties' && in_array($propertyName, ['enum', 'const'])) {
// Enum and const don't allow $ref as a keyword, see https://github.com/json-schema-org/JSON-Schema-Test-Suite/pull/445
continue;
}
$schemaId = $this->findSchemaIdInObject($schema);
$childId = $parentId;
if (is_string($schemaId) && $childId !== $schemaId) {
$childId = $this->uriResolver->resolve($schemaId, $childId);
}
$clonedPropertyStack = $propertyStack;
$clonedPropertyStack[] = $propertyName;
$this->expandRefs($member, $childId, $clonedPropertyStack);
}
}
/**
* {@inheritdoc}
*/
public function getSchema(string $id)
{
if (!array_key_exists($id, $this->schemas)) {
$this->addSchema($id);
}
return $this->schemas[$id];
}
/**
* {@inheritdoc}
*/
public function resolveRef(string $ref, $resolveStack = [])
{
$jsonPointer = new JsonPointer($ref);
// resolve filename for pointer
$fileName = $jsonPointer->getFilename();
if (!strlen($fileName)) {
throw new UnresolvableJsonPointerException(sprintf(
"Could not resolve fragment '%s': no file is defined",
$jsonPointer->getPropertyPathAsString()
));
}
// get & process the schema
$refSchema = $this->getSchema($fileName);
foreach ($jsonPointer->getPropertyPaths() as $path) {
$path = urldecode($path);
if (is_object($refSchema) && property_exists($refSchema, $path)) {
$refSchema = $this->resolveRefSchema($refSchema->{$path}, $resolveStack);
} elseif (is_array($refSchema) && array_key_exists($path, $refSchema)) {
$refSchema = $this->resolveRefSchema($refSchema[$path], $resolveStack);
} else {
throw new UnresolvableJsonPointerException(sprintf(
'File: %s is found, but could not resolve fragment: %s',
$jsonPointer->getFilename(),
$jsonPointer->getPropertyPathAsString()
));
}
}
return $refSchema;
}
/**
* {@inheritdoc}
*/
public function resolveRefSchema($refSchema, $resolveStack = [])
{
if (is_object($refSchema) && property_exists($refSchema, '$ref') && is_string($refSchema->{'$ref'})) {
if (in_array($refSchema, $resolveStack, true)) {
throw new UnresolvableJsonPointerException(sprintf(
'Dereferencing a pointer to %s results in an infinite loop',
$refSchema->{'$ref'}
));
}
$resolveStack[] = $refSchema;
return $this->resolveRef($refSchema->{'$ref'}, $resolveStack);
}
if (is_object($refSchema) && array_keys(get_object_vars($refSchema)) === ['']) {
$refSchema = get_object_vars($refSchema)[''];
}
return $refSchema;
}
/**
* @param mixed $schema
*/
private function scanForSubschemas($schema, string $parentId): void
{
if (!$schema instanceof \stdClass && !is_array($schema)) {
return;
}
foreach ($schema as $propertyName => $potentialSubSchema) {
if (!is_object($potentialSubSchema)) {
if (is_array($potentialSubSchema)) {
foreach ($potentialSubSchema as $potentialSubSchemaItem) {
$this->scanForSubschemas($potentialSubSchemaItem, $parentId);
}
}
continue;
}
$potentialSubSchemaId = $this->findSchemaIdInObject($potentialSubSchema);
if (is_string($potentialSubSchemaId) && property_exists($potentialSubSchema, 'type')) {
// Enum and const don't allow id as a keyword, see https://github.com/json-schema-org/JSON-Schema-Test-Suite/pull/471
if (in_array($propertyName, ['enum', 'const'])) {
continue;
}
// $id in unknow keywords is not valid
if (in_array($propertyName, [])) {
continue;
}
// Found sub schema
$this->addSchema($this->uriResolver->resolve($potentialSubSchemaId, $parentId), $potentialSubSchema);
}
$this->scanForSubschemas($potentialSubSchema, $parentId);
}
}
private function findSchemaIdInObject(object $schema): ?string
{
if (property_exists($schema, 'id') && is_string($schema->id)) {
return $schema->id;
}
if (property_exists($schema, '$id') && is_string($schema->{'$id'})) {
return $schema->{'$id'};
}
return null;
}
}