All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.apache.solr.common.util.JsonSchemaValidator Maven / Gradle / Ivy

    There is a newer version: 9.7.0
    Show newest version
    /*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.solr.common.util;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;

/**
 * A very basic and lightweight json schema parsing and data validation tool. This custom tool is
 * created because 1) we need to support non json inputs 2) to avoiding double parsing (this accepts
 * an already parsed json as a map). It validates most aspects of json schema, but it is NOT A FULLY
 * COMPLIANT JSON schema parser or validator. This validator borrow some design's idea from
 * https://github.com/networknt/json-schema-validator
 */
public class JsonSchemaValidator {

  private List> validators;
  private static Set KNOWN_FNAMES =
      new HashSet<>(
          Arrays.asList("description", "documentation", "default", "additionalProperties"));

  public JsonSchemaValidator(String jsonString) {
    this((Map) Utils.fromJSONString(jsonString));
  }

  public JsonSchemaValidator(Map jsonSchema) {
    this.validators = new ArrayList<>();
    for (Map.Entry entry : jsonSchema.entrySet()) {
      Object fname = entry.getKey();
      if (KNOWN_FNAMES.contains(fname.toString())) continue;

      Function, ?>, Validator> initializeFunction =
          VALIDATORS.get(fname.toString());
      if (initializeFunction == null) throw new RuntimeException("Unknown key : " + fname);

      this.validators.add(initializeFunction.apply(new Pair<>(jsonSchema, entry.getValue())));
    }
  }

  // This is a heterogeneous type, there's probably improvements to be had by using some concrete
  // types instead
  static final Map, ?>, Validator>> VALIDATORS = new HashMap<>();

  static {
    loadValidators();
  }

  @SuppressWarnings("unchecked")
  private static void loadValidators() {
    VALIDATORS.put("items", pair -> new ItemsValidator(pair.first(), (Map) pair.second()));
    VALIDATORS.put("enum", pair -> new EnumValidator(pair.first(), (List) pair.second()));
    VALIDATORS.put(
        "properties",
        pair -> new PropertiesValidator(pair.first(), (Map>) pair.second()));
    VALIDATORS.put("type", pair -> new TypeValidator(pair.first(), pair.second()));
    VALIDATORS.put(
        "required", pair -> new RequiredValidator(pair.first(), (List) pair.second()));
    VALIDATORS.put("oneOf", pair -> new OneOfValidator(pair.first(), (List) pair.second()));
  }

  public List validateJson(Object data) {
    List errs = new ArrayList<>();
    validate(data, errs);
    return errs.isEmpty() ? null : errs;
  }

  boolean validate(Object data, List errs) {
    if (data == null) return true;
    for (Validator validator : validators) {
      if (!validator.validate(data, errs)) {
        return false;
      }
    }
    return true;
  }
}

abstract class Validator {
  Validator(Map schema, T properties) {}
  ;

  abstract boolean validate(Object o, List errs);
}

enum Type {
  STRING(String.class),
  ARRAY(List.class),
  NUMBER(Number.class),
  INTEGER(Long.class) {
    @Override
    boolean isValid(Object o) {
      if (super.isValid(o)) return true;
      try {
        Long.parseLong(String.valueOf(o));
        return true;
      } catch (NumberFormatException e) {
        return false;
      }
    }
  },
  LONG(Long.class) {
    @Override
    boolean isValid(Object o) {
      if (super.isValid(o)) return true;
      try {
        Long.parseLong(String.valueOf(o));
        return true;
      } catch (NumberFormatException e) {
        return false;
      }
    }
  },
  BOOLEAN(Boolean.class) {
    @Override
    boolean isValid(Object o) {
      if (super.isValid(o)) return true;
      try {
        Boolean.parseBoolean(String.valueOf(o));
        return true;
      } catch (NumberFormatException e) {
        return false;
      }
    }
  },
  ENUM(List.class),
  OBJECT(Map.class),
  NULL(null),
  UNKNOWN(Object.class);

  final Class type;

  Type(Class type) {
    this.type = type;
  }

  boolean isValid(Object o) {
    if (type == null) return o == null;
    return type.isInstance(o);
  }
}

class TypeValidator extends Validator {
  private Set types;

  TypeValidator(Map schema, Object type) {
    super(schema, type);
    types = CollectionUtil.newHashSet(1);
    if (type instanceof List) {
      for (Object t : (List) type) {
        types.add(getType(t.toString()));
      }
    } else {
      types.add(getType(type.toString()));
    }
  }

  private Type getType(String typeStr) {
    try {
      return Type.valueOf(typeStr.toUpperCase(Locale.ROOT));
    } catch (IllegalArgumentException e) {
      throw new IllegalArgumentException("Unknown type " + typeStr);
    }
  }

  @Override
  boolean validate(Object o, List errs) {
    for (Type type : types) {
      if (type.isValid(o)) return true;
    }
    errs.add(
        "Value is not valid, expected one of: "
            + types
            + ", found: "
            + o.getClass().getSimpleName());
    return false;
  }
}

class ItemsValidator extends Validator> {
  private JsonSchemaValidator validator;

  ItemsValidator(Map schema, Map properties) {
    super(schema, properties);
    validator = new JsonSchemaValidator(properties);
  }

  @Override
  boolean validate(Object o, List errs) {
    if (o instanceof List) {
      for (Object o2 : (List) o) {
        if (!validator.validate(o2, errs)) {
          errs.add("Items not valid");
          return false;
        }
      }
      return true;
    }
    return false;
  }
}

class EnumValidator extends Validator> {

  private Set enumVals;

  EnumValidator(Map schema, List properties) {
    super(schema, properties);
    enumVals = new HashSet<>(properties);
  }

  @Override
  boolean validate(Object o, List errs) {
    if (o instanceof String) {
      if (!enumVals.contains(o)) {
        errs.add("Value of enum must be one of " + enumVals);
        return false;
      }
      return true;
    }
    return false;
  }
}

class RequiredValidator extends Validator> {

  private Set requiredProps;

  RequiredValidator(Map schema, List requiredProps) {
    super(schema, requiredProps);
    this.requiredProps = new HashSet<>(requiredProps);
  }

  @Override
  boolean validate(Object o, List errs) {
    return validate(o, errs, requiredProps);
  }

  boolean validate(Object o, List errs, Set requiredProps) {
    if (o instanceof Map) {
      Set fnames = ((Map) o).keySet();
      for (String requiredProp : requiredProps) {
        if (requiredProp.contains(".")) {
          if (requiredProp.endsWith(".")) {
            errs.add(
                "Illegal required attribute name (ends with '.': "
                    + requiredProp
                    + ").  This is a bug.");
            return false;
          }
          String subprop = requiredProp.substring(requiredProp.indexOf('.') + 1);
          if (!validate(((Map) o).get(requiredProp), errs, Collections.singleton(subprop))) {
            return false;
          }
        } else {
          if (!fnames.contains(requiredProp)) {
            errs.add(
                "Missing required attribute '"
                    + requiredProp
                    + "' in object "
                    + Utils.toJSONString(o));
            return false;
          }
        }
      }
      return true;
    }
    return false;
  }
}

class PropertiesValidator extends Validator>> {
  private Map jsonSchemas;
  private boolean additionalProperties;

  PropertiesValidator(Map schema, Map> properties) {
    super(schema, properties);
    jsonSchemas = new HashMap<>();
    Object additionalProperties =
        schema.get("additionalProperties"); // If not set, will return null
    this.additionalProperties =
        Boolean.TRUE.equals(additionalProperties) ? true : false; // Implicit null -> false
    for (Map.Entry> entry : properties.entrySet()) {
      jsonSchemas.put(entry.getKey(), new JsonSchemaValidator(entry.getValue()));
    }
  }

  @Override
  boolean validate(Object o, List errs) {
    if (o instanceof Map) {
      Map map = (Map) o;
      for (Map.Entry entry : map.entrySet()) {
        Object key = entry.getKey();
        JsonSchemaValidator jsonSchema = jsonSchemas.get(key.toString());
        if (jsonSchema == null && !additionalProperties) {
          errs.add("Unknown field '" + key + "' in object : " + Utils.toJSONString(o));
          return false;
        }
        if (jsonSchema != null && !jsonSchema.validate(entry.getValue(), errs)) {
          return false;
        }
      }
      return true;
    }
    return false;
  }
}

class OneOfValidator extends Validator> {

  private Set oneOfProps;

  OneOfValidator(Map schema, List oneOfProps) {
    super(schema, oneOfProps);
    this.oneOfProps = new HashSet<>(oneOfProps);
  }

  @Override
  boolean validate(Object o, List errs) {
    if (o instanceof Map) {
      Map map = (Map) o;
      for (Object key : map.keySet()) {
        if (oneOfProps.contains(key.toString())) return true;
      }
      errs.add(
          "One of fields :"
              + oneOfProps
              + " is not presented in object : "
              + Utils.toJSONString(o));
      return false;
    }

    return false;
  }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy