Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add proper recursive handling for $ref resolution base #448

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 34 additions & 7 deletions src/JsonSchema/SchemaStorage.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
use JsonSchema\Constraints\BaseConstraint;
use JsonSchema\Entity\JsonPointer;
use JsonSchema\Exception\UnresolvableJsonPointerException;
use JsonSchema\Iterator\ObjectIterator;
use JsonSchema\Uri\UriResolver;
use JsonSchema\Uri\UriRetriever;

Expand Down Expand Up @@ -69,14 +68,42 @@ public function addSchema($id, $schema = null)
}
}

$objectIterator = new ObjectIterator($schema);
foreach ($objectIterator as $toResolveSchema) {
if (property_exists($toResolveSchema, '$ref') && is_string($toResolveSchema->{'$ref'})) {
$jsonPointer = new JsonPointer($this->uriResolver->resolve($toResolveSchema->{'$ref'}, $id));
$toResolveSchema->{'$ref'} = (string) $jsonPointer;
// resolve references
$this->expandRefs($schema, $id);

$this->schemas[$id] = $schema;
}

/**
* Recursively resolve all references against the provided base
*
* @param mixed $schema
* @param string $base
*/
private function expandRefs(&$schema, $base = null)
{
if (!is_object($schema)) {
if (is_array($schema)) {
foreach ($schema as &$member) {
$this->expandRefs($member, $base);
}
}

return;
}

if (property_exists($schema, 'id') && is_string($schema->id)) {
$base = $this->uriResolver->resolve($schema->id, $base);
}

if (property_exists($schema, '$ref') && is_string($schema->{'$ref'})) {
$refPointer = new JsonPointer($this->uriResolver->resolve($schema->{'$ref'}, $base));
$schema->{'$ref'} = (string) $refPointer;
}

foreach ($schema as &$member) {
$this->expandRefs($member, $base);
}
$this->schemas[$id] = $schema;
}

/**
Expand Down
11 changes: 11 additions & 0 deletions src/JsonSchema/Uri/UriResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,17 @@ public function generate(array $components)
*/
public function resolve($uri, $baseUri = null)
{
// treat non-uri base as local file path
if (!is_null($baseUri) && !filter_var($baseUri, \FILTER_VALIDATE_URL)) {
if (is_file($baseUri)) {
$baseUri = 'file://' . realpath($baseUri);
} elseif (is_dir($baseUri)) {
$baseUri = 'file://' . realpath($baseUri) . '/';
} else {
$baseUri = 'file://' . getcwd() . '/' . $baseUri;
}
}

if ($uri == '') {
return $baseUri;
}
Expand Down
9 changes: 7 additions & 2 deletions src/JsonSchema/Validator.php
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,17 @@ public function validate(&$value, $schema = null, $checkMode = null)
}

// add provided schema to SchemaStorage with internal URI to allow internal $ref resolution
$this->factory->getSchemaStorage()->addSchema(SchemaStorage::INTERNAL_PROVIDED_SCHEMA_URI, $schema);
if (is_object($schema) && property_exists($schema, 'id')) {
$schemaURI = $schema->id;
} else {
$schemaURI = SchemaStorage::INTERNAL_PROVIDED_SCHEMA_URI;
}
$this->factory->getSchemaStorage()->addSchema($schemaURI, $schema);

$validator = $this->factory->createInstanceFor('schema');
$validator->check(
$value,
$this->factory->getSchemaStorage()->getSchema(SchemaStorage::INTERNAL_PROVIDED_SCHEMA_URI)
$this->factory->getSchemaStorage()->getSchema($schemaURI)
);

$this->factory->setConfig($initialCheckMode);
Expand Down
33 changes: 33 additions & 0 deletions tests/Uri/UriResolverTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -190,4 +190,37 @@ public function testReversable()
// check that the recombined URI matches the original input
$this->assertEquals($uri, $this->resolver->generate($split));
}

public function testRelativeFileAsRoot()
{
$this->assertEquals(
'file://' . getcwd() . '/src/JsonSchema/Validator.php',
$this->resolver->resolve(
'Validator.php',
'src/JsonSchema/SchemaStorage.php'
)
);
}

public function testRelativeDirectoryAsRoot()
{
$this->assertEquals(
'file://' . getcwd() . '/src/JsonSchema/Validator.php',
$this->resolver->resolve(
'Validator.php',
'src/JsonSchema'
)
);
}

public function testRelativeNonExistentFileAsRoot()
{
$this->assertEquals(
'file://' . getcwd() . '/resolved.file',
$this->resolver->resolve(
'resolved.file',
'test.file'
)
);
}
}