io.vertx.json.schema.impl.SchemaRepositoryImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-json-schema Show documentation
The newest version!
package io.vertx.json.schema.impl;

import io.vertx.core.file.FileSystem;
import io.vertx.core.json.JsonArray;
import io.vertx.core.json.JsonObject;
import io.vertx.json.schema.*;

import java.util.*;
import java.util.concurrent.ConcurrentHashMap;

public class SchemaRepositoryImpl implements SchemaRepository {

  private static final List IGNORE_KEYWORD = Arrays.asList(
    "id",
    "$id",
    "$ref",
    "$schema",
    "$anchor",
    "$vocabulary",
    "$comment",
    "default",
    "enum",
    "const",
    "required",
    "type",
    "maximum",
    "minimum",
    "exclusiveMaximum",
    "exclusiveMinimum",
    "multipleOf",
    "maxLength",
    "minLength",
    "pattern",
    "format",
    "maxItems",
    "minItems",
    "uniqueItems",
    "maxProperties",
    "minProperties");

  private static final List SCHEMA_ARRAY_KEYWORD = Arrays.asList(
    "prefixItems",
    "items",
    "allOf",
    "anyOf",
    "oneOf");

  private static final List SCHEMA_MAP_KEYWORD = Arrays.asList(
    "$defs",
    "definitions",
    "properties",
    "patternProperties",
    "dependentSchemas");

  private static final List SCHEMA_KEYWORD = Arrays.asList(
    "additionalItems",
    "unevaluatedItems",
    "items",
    "contains",
    "additionalProperties",
    "unevaluatedProperties",
    "propertyNames",
    "not",
    "if",
    "then",
    "else"
  );

  public static final List DRAFT_4_META_FILES = Collections.singletonList(
    "http://json-schema.org/draft-04/schema"
  );

  public static final List DRAFT_7_META_FILES = Collections.singletonList(
    "http://json-schema.org/draft-07/schema"
  );

  public static final List DRAFT_201909_META_FILES = Arrays.asList(
    "https://json-schema.org/draft/2019-09/schema",
    "https://json-schema.org/draft/2019-09/meta/core",
    "https://json-schema.org/draft/2019-09/meta/applicator",
    "https://json-schema.org/draft/2019-09/meta/validation",
    "https://json-schema.org/draft/2019-09/meta/meta-data",
    "https://json-schema.org/draft/2019-09/meta/format",
    "https://json-schema.org/draft/2019-09/meta/content"
    );

  public static final List DRAFT_202012_META_FILES = Arrays.asList(
    "https://json-schema.org/draft/2020-12/schema",
    "https://json-schema.org/draft/2020-12/meta/core",
    "https://json-schema.org/draft/2020-12/meta/applicator",
    "https://json-schema.org/draft/2020-12/meta/validation",
    "https://json-schema.org/draft/2020-12/meta/meta-data",
    "https://json-schema.org/draft/2020-12/meta/format-annotation",
    "https://json-schema.org/draft/2020-12/meta/content",
    "https://json-schema.org/draft/2020-12/meta/unevaluated"
  );

  private final Map lookup = new ConcurrentHashMap<>();

  private final JsonSchemaOptions options;
  private final URL baseUri;
  private final JsonFormatValidator formatValidator;

  public SchemaRepositoryImpl(JsonSchemaOptions options, JsonFormatValidator formatValidator) {
    Objects.requireNonNull(options, "'options' cannot be null");
    Objects.requireNonNull(options.getBaseUri(), "'options.baseUri' cannot be null");
    Objects.requireNonNull(formatValidator, "'formatValidator' cannot be null");
    this.options = options;
    this.formatValidator = formatValidator;
    this.baseUri = new URL(options.getBaseUri());
  }

  @Override
  public SchemaRepository dereference(JsonSchema schema) throws SchemaException {
    dereference(lookup, schema, baseUri, "", true);
    return this;
  }

  @Override
  public SchemaRepository dereference(String uri, JsonSchema schema) throws SchemaException {
    dereference(lookup, schema, new URL(uri, options.getBaseUri()), "", true);
    return this;
  }

  @Override
  public SchemaRepository preloadMetaSchema(FileSystem fs) {
    if (options.getDraft() == null) {
      throw new IllegalStateException("No draft version is defined in the options of the repository");
    }
    return preloadMetaSchema(fs, options.getDraft());
  }

  @Override
  public SchemaRepository preloadMetaSchema(FileSystem fs, Draft draft) {
    List metaSchemaIds;
    switch (draft) {
      case DRAFT4:
        metaSchemaIds = DRAFT_4_META_FILES;
        break;
      case DRAFT7:
        metaSchemaIds = DRAFT_7_META_FILES;
        break;
      case DRAFT201909:
        metaSchemaIds = DRAFT_201909_META_FILES;
        break;
      case DRAFT202012:
        metaSchemaIds = DRAFT_202012_META_FILES;
        break;
      default:
        throw new IllegalStateException();
    }

    for (String id : metaSchemaIds) {
      // read files from classpath
      JsonSchema schema = JsonSchema.of(fs.readFileBlocking(id.substring(id.indexOf("://") + 3)).toJsonObject());
      // try to extract the '$id' from the schema itself, fallback to old field 'id' and if not present to the given url
      dereference(schema.get("$id", schema.get("id", id)), schema);
    }
    return this;
  }

  @Override
  public Validator validator(JsonSchema schema) {
    Objects.requireNonNull(schema, "'schema' cannot be null");
    // this schema has been dereferenced, no need to redo it
    if (schema.containsKey("__absolute_uri__")) {
      // resolve the pointer to an absolute path
      final URL url = new URL(schema.get("__absolute_uri__"), baseUri);
      if ("".equals(url.fragment())) {
        url.anchor(""); // normalize hash https://url.spec.whatwg.org/#dom-url-hash
      }
      final String uri = url.href();
      if (lookup.containsKey(uri)) {
        Objects.requireNonNull(uri, "'ref' cannot be null");
        return new SchemaValidatorImpl(lookup.get(uri), options, Collections.unmodifiableMap(lookup), false,
          formatValidator);
      }
    }
    return new SchemaValidatorImpl(schema, options, Collections.unmodifiableMap(lookup), false, formatValidator);
  }

  @Override
  public Validator validator(String ref) {
    Objects.requireNonNull(ref, "'ref' cannot be null");
    // resolve the pointer to an absolute path
    final URL url = new URL(ref, baseUri);
    if ("".equals(url.fragment())) {
      url.anchor(""); // normalize hash https://url.spec.whatwg.org/#dom-url-hash
    }
    final String uri = url.href();
    if (lookup.containsKey(uri)) {
      return new SchemaValidatorImpl(lookup.get(uri), options, Collections.unmodifiableMap(lookup), false,
        formatValidator);
    }
    throw new IllegalArgumentException("Unknown $ref: " + ref);
  }

  @Override
  public Validator validator(JsonSchema schema, JsonSchemaOptions options, boolean dereference) {
    final JsonSchemaOptions config;
    if (options.getBaseUri() == null) {
      // add the default base if missing
      config = new JsonSchemaOptions(options)
        .setBaseUri(baseUri.href());
    } else {
      config = options;
    }

    return new SchemaValidatorImpl(schema, config, Collections.unmodifiableMap(lookup), dereference, formatValidator);
  }

  @Override
  public Validator validator(String ref, JsonSchemaOptions options) {
    final JsonSchemaOptions config;
    if (options.getBaseUri() == null) {
      // add the default base if missing
      config = new JsonSchemaOptions(options)
        .setBaseUri(baseUri.href());
    } else {
      config = options;
    }

    // resolve the pointer to an absolute path
    final URL url = new URL(ref, baseUri);
    final String uri = url.href();
    if ("".equals(url.fragment())) {
      url.anchor(""); // normalize hash https://url.spec.whatwg.org/#dom-url-hash
    }
    if (lookup.containsKey(uri)) {
      Objects.requireNonNull(uri, "'ref' cannot be null");
      return new SchemaValidatorImpl(lookup.get(uri), config, Collections.unmodifiableMap(lookup), false,
        formatValidator);
    }
    throw new IllegalArgumentException("Unknown $ref: " + ref);
  }

  @Override
  public JsonObject resolve(JsonObject schema) {
    // this will perform a dereference of the given schema
    final Map lookup = new HashMap<>(Collections.unmodifiableMap(this.lookup));
    return JsonRef.resolve(schema, lookup);
  }

  @Override
  public JsonSchema find(String pointer) {
    // resolve the pointer to an absolute path
    final URL url = new URL(pointer, baseUri);
    return lookup.get(url.href());
  }

  static void dereference(Map lookup, JsonSchema schema, URL baseURI, String basePointer, boolean schemaRoot) {
    if (schema == null) {
      return;
    }

    if (!(schema instanceof BooleanSchema)) {
      // This addresses the Unknown Keyword requirements, non sub-schema's with $id are to ignore the
      // given $id as it could collide with existing resolved schemas
      final String id = schemaRoot ? schema.get("$id", schema.get("id")) : null;
      if (Utils.Objects.truthy(id)) {
        final URL url = new URL(id, baseURI.href());
        if (url.fragment().length() > 1) {
          assert !lookup.containsKey(url.href());
          lookup.put(url.href(), schema);
        } else {
          url.anchor(""); // normalize hash https://url.spec.whatwg.org/#dom-url-hash
          if ("".equals(basePointer)) {
            baseURI = url;
          } else {
            dereference(lookup, schema, baseURI, "", schemaRoot);
          }
        }
      }
    }

    // compute the schema's URI and add it to the mapping.
    final String schemaURI = baseURI.href() + (Utils.Objects.truthy(basePointer) ? '#' + basePointer : "");
    if (lookup.containsKey(schemaURI)) {
      JsonSchema existing = lookup.get(schemaURI);
      // this schema has been processed already, skip, this is the same behavior of ajv the most complete
      // validator to my knowledge. This addresses the case where extra $id's are added and would be double
      // referenced, yet, it would be ok as they are the same sub schema
      if (existing.equals(schema)) {
        return;
      }
      throw new SchemaException(schema, "Duplicate schema URI \"" + schemaURI + "\".");
    }
    lookup.put(schemaURI, schema);

    // exit early if this is a boolean schema.
    if (schema instanceof BooleanSchema) {
      return;
    }

    // set the schema's absolute URI.
    if (!schema.containsKey("__absolute_uri__")) {
      schema.annotate("__absolute_uri__", schemaURI);
    }

    // if a $ref is found, resolve it's absolute URI.
    if (schema.containsKey("$ref") && !schema.containsKey("__absolute_ref__")) {
      final URL url = new URL(schema.get("$ref"), baseURI.href());
      url.anchor(url.fragment()); // normalize hash https://url.spec.whatwg.org/#dom-url-hash
      schema.annotate("__absolute_ref__", url.href());
    }

    // if a $recursiveRef is found, resolve it's absolute URI.
    if (schema.containsKey("$recursiveRef") && !schema.containsKey("__absolute_recursive_ref__")) {
      final URL url = new URL(schema.get("$recursiveRef"), baseURI.href());
      url.anchor(url.fragment()); // normalize hash https://url.spec.whatwg.org/#dom-url-hash
      schema.annotate("__absolute_recursive_ref__", url.href());
    }

    // if an $dynamicAnchor is found, compute it's URI and add it to the mapping.
    if (schema.containsKey("$dynamicAnchor")) {
      final URL url = new URL("#" + schema.get("$dynamicAnchor"), baseURI.href());
      if (lookup.containsKey(url.href())) {
        assert !lookup.get(url.href()).equals(schema);
      } else {
        lookup.put(url.href(), schema);
      }
    }

    // if an $anchor is found, compute it's URI and add it to the mapping.
    if (schema.containsKey("$anchor")) {
      final URL url = new URL("#" + schema.get("$anchor"), baseURI);
      if (lookup.containsKey(url.href())) {
        assert !lookup.get(url.href()).equals(schema);
      } else {
        lookup.put(url.href(), schema);
      }
    }

    // process subschemas.
    for (String key : schema.fieldNames()) {
      if (IGNORE_KEYWORD.contains(key)) {
        continue;
      }

      final String keyBase = basePointer + "/" + Utils.Pointers.encode(key);
      final Object subSchema = schema.get(key);

      if (subSchema instanceof JsonArray) {
        if (SCHEMA_ARRAY_KEYWORD.contains(key)) {
          for (int i = 0; i < ((JsonArray) subSchema).size(); i++) {
            dereference(
              lookup,
              Utils.Schemas.wrap((JsonArray) subSchema, i),
              baseURI,
              keyBase + "/" + i,
              false);
          }
        }
      } else if (SCHEMA_MAP_KEYWORD.contains(key)) {
        for (String subKey : ((JsonObject) subSchema).fieldNames()) {
          dereference(
            lookup,
            Utils.Schemas.wrap((JsonObject) subSchema, subKey),
            baseURI,
            keyBase + "/" + Utils.Pointers.encode(subKey),
            true);
        }
      } else if (subSchema instanceof Boolean) {
        dereference(
          lookup,
          JsonSchema.of((Boolean) subSchema),
          baseURI,
          keyBase,
          SCHEMA_KEYWORD.contains(key));
      } else if (subSchema instanceof JsonObject) {
        dereference(
          lookup,
          JsonSchema.of((JsonObject) subSchema),
          baseURI,
          keyBase,
          SCHEMA_KEYWORD.contains(key));
      }
    }
  }
}